index

@fungi.computer/sprite

@fungi.computer/sprite / index

index

Type Aliases

AssetPolicy

AssetPolicy = object

Host-owned admission and resource limits for published avatar artwork.

Properties

baseURL

readonly baseURL: string

allowedOrigins

readonly allowedOrigins: readonly string[]

maxBytes

readonly maxBytes: number

Maximum bytes admitted for one response.

maxTotalBytes

readonly maxTotalBytes: number

Cumulative bytes admitted across one character selection.

maxRequests

readonly maxRequests: number

Number of requests admitted for one character selection.

fetch?

readonly optional fetch?: typeof fetch

Asset

Asset = object

Decoded transport bytes; adapters use these instead of opening their own URLs.

Properties

url

readonly url: string

bytes

readonly bytes: Uint8Array<ArrayBuffer>>

contentType

readonly contentType: string

Control

Control = z.infer<typeof controlSchema>>

A validated, character-owned customization control.

Appearance

Appearance = Readonly<Record<string, string | number | boolean>>>>

Values saved by the shell; no renderer objects or transient activity.

CharacterDocument

CharacterDocument = z.infer<typeof characterSchema>>

A portable character, with renderer data still awaiting its native decoder.

CharacterSource

CharacterSource = string | { local: string; }

A served document URL or a host-installed character key.

AvatarPresentation

AvatarPresentation = object

One complete request. Omitted customization resets to character defaults.

Properties

src

readonly src: CharacterSource

activity?

readonly optional activity?: string

expression?

readonly optional expression?: string

appearance?

readonly optional appearance?: Appearance

NativePresentation

NativePresentation = object

The resolved activity and appearance passed to a native renderer.

Properties

activity

readonly activity: string

expression

readonly expression: string | null

appearance

readonly appearance: Appearance

NativePlayer

NativePlayer = object

The adapter registers native destruction in the selection scope.

Properties

activities

readonly activities: readonly string[]

expressions

readonly expressions: readonly string[]

Methods

set()

set(presentation): void

Update the existing native instance.

Parameters

presentation

NativePresentation

Returns

void

pause()

pause(paused): void

Pause or resume animation without losing the current frame.

Parameters

paused

boolean

Returns

void

RendererContext

RendererContext = object

Native renderer access to the selected document and its admitted assets.

Properties

target

readonly target: HTMLElement

document

readonly document: CharacterDocument

signal

readonly signal: AbortSignal

maxPixels

readonly maxPixels: number

reportError

readonly reportError: (error) => void

Report a native failure that occurs after the renderer has become ready.

Parameters

error

Error

Returns

void

assetURL

readonly assetURL: (reference) => Effect.Effect<string, Error, Scope.Scope>>

Admit an asset and revoke its object URL when the selection closes.

Parameters

reference

string

Returns

Effect.Effect<string, Error, Scope.Scope>

Renderer

Renderer = (context) => Effect.Effect<NativePlayer, Error, Scope.Scope>>

A native renderer whose resources live in the character selection scope.

Parameters

context

RendererContext

Returns

Effect.Effect<NativePlayer, Error, Scope.Scope>

EffectivePresentation

EffectivePresentation = NativePresentation & object

A request after native fallback and appearance validation.

Type Declaration

requestedActivity

readonly requestedActivity: string

requestedExpression

readonly requestedExpression: string | null

fallback

readonly fallback: boolean

PlayerState

PlayerState = { status: "empty" | "loading" | "destroyed"; } | { status: "error"; error: Error; } | { status: "ready"; document: CharacterDocument; presentation: EffectivePresentation; updateError?: Error; }

Observable loading, ready, error, and disposal states.

LocalCharacter

LocalCharacter = object

An installed document and its renderer, loaded together by the shell.

Properties

document

readonly document: CharacterDocument

render

readonly render: Renderer

SpriteOptions

SpriteOptions = object

Host-owned character registry and resource policy.

Properties

assets?

readonly optional assets?: AssetPolicy

Omit for local-only characters; network access is denied by default.

maxPixels?

readonly optional maxPixels?: number

renderers?

readonly optional renderers?: Readonly<Record<string, () => Promise<{ default: Renderer; }>>>

Native adapters allowed for served character documents.

characters?

readonly optional characters?: Readonly<Record<string, () => Promise<LocalCharacter>>>>>>

Lazy local characters installed by this shell.

AvatarPlayer

AvatarPlayer = object

One mounted avatar; dispose releases its native and browser resources.

Properties

state

readonly state: PlayerState

Current public state.

Methods

subscribe(listener): () => void

Observe state changes until the returned unsubscribe function is called.

Parameters

listener

(next) => void

Returns

() => void

set()

set(next): void

Select a source or update its activity and appearance.

Parameters

AvatarPresentation

Returns

void

pause()

pause(value): void

Pause or resume the current native animation.

Parameters

value

boolean

Returns

void

dispose()

dispose(): Promise<void>>

Cancel loading and release the current native selection.

Returns

Promise<void>

SpriteService

SpriteService = object

Stable shell configuration that creates independent mounted players.

Methods

mount()

mount(target): AvatarPlayer

Claim one DOM host for a new avatar instance.

Parameters

target

HTMLElement

Returns

AvatarPlayer

Variables

controlSchema

const controlSchema: ZodDiscriminatedUnion<[ZodObject<{ type: ZodLiteral<"number">>; label: ZodString; default: ZodNumber; min: ZodNumber; max: ZodNumber; step: ZodOptional<ZodNumber>>; }, $strict>>, ZodObject<{ type: ZodLiteral<"choice">>; label: ZodString; default: ZodString; options: ZodArray<ZodObject<{ value: ZodString; label: ZodString; }, $strict>>>>; }, $strict>>, ZodObject<{ type: ZodLiteral<"color">>; label: ZodString; default: ZodString; }, $strict>>, ZodObject<{ type: ZodLiteral<"boolean">>; label: ZodString; default: ZodBoolean; }, $strict>>], "type">>

Portable editor descriptors; native input bindings belong to each renderer.

characterSchema

const characterSchema: ZodObject<{ version: ZodLiteral<1>>; name: ZodString; renderer: ZodString; controls: ZodDefault<ZodRecord<ZodString, ZodDiscriminatedUnion<[ZodObject<{ type: ZodLiteral<"number">>; label: ZodString; default: ZodNumber; min: ZodNumber; max: ZodNumber; step: ZodOptional<ZodNumber>>; }, $strict>>, ZodObject<{ type: ZodLiteral<"choice">>; label: ZodString; default: ZodString; options: ZodArray<ZodObject<{ value: …; label: …; }, $strict>>>>; }, $strict>>, ZodObject<{ type: ZodLiteral<"color">>; label: ZodString; default: ZodString; }, $strict>>, ZodObject<{ type: ZodLiteral<"boolean">>; label: ZodString; default: ZodBoolean; }, $strict>>], "type">>>>>>; poster: ZodOptional<ZodString>>; data: ZodJSONSchema; }, $strict>>