CopyChoreographer

Defined in: state.ts:342

Owns one island’s copy for one page view. Fed wire events; emits states.

Pure with respect to the DOM: it decides WHAT should be on screen and when, and never touches how. That is what lets the same choreography drive React, the iframe shell, and anything else without several copies of these rules.

Constructors

Constructor

new CopyChoreographer(options?): CopyChoreographer

Defined in: state.ts:382

Parameters

options?

ChoreographerOptions = {}

Returns

CopyChoreographer

Methods

backgroundReady()

backgroundReady(bgImage): void

Defined in: state.ts:816

Absence of this event means KEEP THE BAKED THEME WASH. It does not mean clear the art layer — the server omits it when there is no creative image.

The patch waits for the browser to DECODE the image first, so a new background never paints before its pixels exist. On failure the patch still lands; outside a browser it is immediate.

Parameters

bgImage

string

Returns

void

---

checkDeadline()

checkDeadline(): void

Defined in: state.ts:581

Apply a hold expiry whose time has already passed but whose timer has not run: a background tab throttles timers, and a page restored from the back/forward cache resumes with them overdue. Copy events call this first, so text arriving after the deadline is never shown in place of the fallback. Renderers call it when the page is shown again. Idempotent.

Returns

void

---

copyChunk()

copyChunk(field, text): void

Defined in: state.ts:706

A delta landed. While holding (and in view) the first text takes the canvas; on a live field it extends the text. Dropped for a final field.

Parameters

field

CopyField

text

string

Returns

void

---

copyDone()

copyDone(field, text): void

Defined in: state.ts:733

A field closed. Its text completes what the field shows: it lands whole on a blank field and finishes a typed one. It never replaces different visible text — if it does not extend what was typed, the typed text stands (and development builds warn). For a final field this only marks it settled.

Parameters

field

CopyField

text

string

Returns

void

---

copyStart()

copyStart(field, mode, source): void

Defined in: state.ts:686

A field opened: proof of life, and provenance. Restarts the hold budget once if it is running. Dropped for a final field.

Parameters

field

CopyField

mode

"generate" | "replay" | null

source

"generated" | "cached" | "static"

Returns

void

---

ctaReady()

ctaReady(text, style, action?): void

Defined in: state.ts:850

Parameters

text

string

style

unknown

action?

string

Returns

void

---

ctaStyleReady()

ctaStyleReady(style): void

Defined in: state.ts:845

Parameters

style

unknown

Returns

void

---

dispose()

dispose(): void

Defined in: state.ts:961

Release timers. Safe to call twice.

Returns

void

---

done()

done(meta): void

Defined in: state.ts:904

Terminal, success.

Parameters

meta

Record<string, unknown>

Returns

void

---

failed()

failed(message): void

Defined in: state.ts:951

Terminal, failure. No failure blanks the canvas: copy that closed stays, a blank field gets its fallback, and a field the stream was still writing goes through the UnfinishedCopyPolicy.

Parameters

message

string

Returns

void

---

getState()

getState(): CreativeState

Defined in: state.ts:428

Returns

CreativeState

---

keepFallback()

keepFallback(field): void

Defined in: state.ts:772

The renderer will not show this field’s copy: it does not fit the slot its fallback reserved. The fallback lands instead and is final for the view; later copy for the field is dropped. Call it before the copy is painted (a renderer measures before the browser paints), never for text the visitor has seen.

Parameters

field

CopyField

Returns

void

---

layoutReady()

layoutReady(layout, manifest?): void

Defined in: state.ts:800

Parameters

layout

string

manifest?

unknown

Returns

void

---

sequenceReady()

sequenceReady(frames, heroIndex, fps): void

Defined in: state.ts:835

Parameters

frames

string[]

heroIndex

number

fps

number

Returns

void

---

slotInView()

slotInView(): void

Defined in: state.ts:532

Call when the slot is in view (already in view at mount counts). Only meaningful with holdStartsInView; otherwise the slot is in view from the start and this is a no-op.

At that moment copy the stream already delivered takes the canvas — finished fields land whole, unfinished ones type from the buffer — and with nothing delivered the hold budget starts.

Returns

void

---

streamOpened()

streamOpened(): void

Defined in: state.ts:486

Call when live copy is coming: when the stream request opens, or earlier when a renderer already knows it will (a stream waiting on a shared variant). Idempotent.

Arms the hold when there is fallback copy the visitor has not seen. Copy the visitor can already see (initialIsOnScreen) or finished creative (serverRendered) is final instead: nothing to hold, nothing to replace.

Returns

void

---

subscribe()

subscribe(listener): () => void

Defined in: state.ts:432

Parameters

listener

Listener

Returns

() => void

---

themeReady()

themeReady(colors, sources): void

Defined in: state.ts:795

Parameters

colors

Record<string, string>

sources

Record<string, string>

Returns

void

---

videoReady()

videoReady(videoUrl): void

Defined in: state.ts:840

Parameters

videoUrl

string

Returns

void