@encorekit/web-sdk 2.2.1 → 2.4.0

package/types/triggers/giftsButton/GiftsButton.d.ts

@@ -0,0 +1,60 @@
+/**
+ * GiftsButton, trigger plug-in #2: a button the app shows at a reward moment instead
+ * of popping the Encore sheet itself. A tap opens the sheet for the mount's use case and
+ * placement.
+ *
+ * Opening by itself is the served look's (`behavior.autoOpen: on`, an experiment arm
+ * only), on a mount that may (`mayOpenByItself`: it neither said `autoOpen: 'off'` nor
+ * pinned a layout). Such a look draws nothing until it pops the sheet, once per mount and
+ * at most once per placement per local day across mounts, then draws itself, its events
+ * keeping its own layout and ids. Every look is its served SDUI tree (host/sduiView.ts).
+ * Everything every trigger shares is the host's.
+ */
+import type { UseCase } from '../../types';
+import type { SduiHostListItem } from '../../sdui/context';
+import type { TriggerMountState, SheetCheck, TriggerPlugin } from '../host/types';
+import { type TriggerRequest } from '../request';
+import { type TriggerSduiModel } from '../host/sduiView';
+import { type GiftsButtonConfig } from './config';
+export declare const GIFTS_BUTTON_ID: "giftsButton";
+export { AUTO_POP_STORAGE_KEY, forgetAutoPops } from '../host/autoPops';
+/**
+ * A spot drew another look (the reminder, a thanks look) on a mount that may open the
+ * sheet by itself: it never pops after that, so its one decision is spent as given up and
+ * it draws its own look when it is the gifts button again.
+ */
+export declare function giveUpAutoOpen(mountState: TriggerMountState, request: TriggerRequest): void;
+export interface GiftsButtonDeps {
+    /**
+     * Whether the sheet for `useCase` at `placement` would open with offers, by the SDK's
+     * own path: the sheet's config (`sheet_unavailable` when it has nothing to serve),
+     * then an offer search sent with the sheet's variant and `purpose: 'prefetch'`, held
+     * for the tap. `fresh` skips the held search (after a claim). `none` for no offers or
+     * any failure.
+     */
+    checkSheet(useCase: UseCase, placement: string | undefined, fresh: boolean): Promise<SheetCheck>;
+    storage(): Storage | null;
+    /** The thanks look was tapped: it ends for the user's latest completion. */
+    thanksTapped?(): void;
+}
+interface GiftsButtonContent {
+    useCase: UseCase;
+    /** The held offers' logos, for `offerLogos`. */
+    offerLogos: readonly SduiHostListItem[];
+    /**
+     * A completion today, not yet thanked (the request's `completed` state): its claim's id.
+     * The thanks look, when Encore serves it for this state, is keyed by it, so each
+     * completion counts its own view.
+     */
+    thanks?: string;
+}
+/** One render: a served look and what it binds, or nothing (`template` null). */
+export interface GiftsButtonModel extends Omit<TriggerSduiModel, 'template'> {
+    useCase: UseCase;
+    placement: string | undefined;
+    template: Record<string, unknown> | null;
+    /** The thanks look is drawn: a tap on it ends the thanks state. */
+    thanks?: true;
+}
+export declare function giftsButtonPlugin(deps: GiftsButtonDeps): TriggerPlugin<GiftsButtonContent, GiftsButtonConfig, GiftsButtonModel>;
+//# sourceMappingURL=GiftsButton.d.ts.map

package/types/triggers/giftsButton/GiftsButton.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GiftsButton.d.ts","sourceRoot":"","sources":["../../../src/triggers/giftsButton/GiftsButton.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAG3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,KAAK,EACV,iBAAiB,EACjB,UAAU,EACV,aAAa,EAGd,MAAM,eAAe,CAAC;AAIvB,OAAO,EAAuC,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAEtF,OAAO,EAAqB,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE5E,OAAO,EAA8C,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE9F,eAAO,MAAM,eAAe,eAAyB,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAYxE;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAI3F;AAKD,MAAM,WAAW,eAAe;IAC9B;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjG,OAAO,IAAI,OAAO,GAAG,IAAI,CAAC;IAC1B,4EAA4E;IAC5E,YAAY,CAAC,IAAI,IAAI,CAAC;CACvB;AAED,UAAU,kBAAkB;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,gDAAgD;IAChD,UAAU,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACxC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAmBD,iFAAiF;AACjF,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC;IAC1E,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACzC,mEAAmE;IACnE,MAAM,CAAC,EAAE,IAAI,CAAC;CACf;AAgBD,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,eAAe,GACpB,aAAa,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAmMxE"}

package/types/triggers/giftsButton/config.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Reading GiftsButton's served template. The host has already checked the envelope
+ * (`template.trigger == 'giftsButton'`), run the strict pre-check, and owns the variant
+ * ids and the served locale.
+ *
+ *   { trigger: 'giftsButton', version, layout, colors, strings: { title, subtitle, cta }, root }
+ *
+ * `root` is drawn by the SDUI engine; `layout` is a label (events, `${layout}`). Whether
+ * the look opens the sheet by itself is its `behavior.autoOpen` (§2.8), never its layout.
+ */
+import type { TriggerColors } from '../host/theme';
+export interface GiftsButtonStrings {
+    title?: string;
+    subtitle?: string;
+    cta?: string;
+    offersTitle?: string;
+}
+export interface GiftsButtonConfig {
+    /** The served template, drawn by the SDUI engine. */
+    template: Record<string, unknown>;
+    /** The served layout name: a label, never a code path. */
+    layout: string;
+    /** The look's dark colours (`colors`). */
+    colors: TriggerColors;
+    /** The look's light colours (`lightColors`), used in the light scheme. */
+    lightColors: TriggerColors;
+    /** Only the served, non-blank strings; the look's own English fills the rest. */
+    strings: GiftsButtonStrings;
+    /**
+     * The look's `behavior.autoOpen` is `on`: it opens the sheet once by itself, then draws
+     * itself. Applied only on a mount that may (`mayOpenByItself`), within the device's bounds.
+     */
+    autoOpen: boolean;
+}
+export declare function decodeGiftsButtonTemplate(template: Record<string, unknown>): GiftsButtonConfig;
+/** The copy one look binds. */
+export interface GiftsButtonCopy {
+    title: string;
+    subtitle: string;
+    cta: string;
+    /** The title over the held offers' logos (offerMarquee). */
+    offersTitle: string;
+}
+/** The built-in English for `offersTitle`, on every look. */
+export declare const DEFAULT_OFFERS_TITLE = "Pick a gift, on us";
+/**
+ * Built-in English per look, used per key when the variant has none. Never names a
+ * reward, an amount, "free" or an expiry; no dash punctuation. A look this table does
+ * not name takes the card's.
+ */
+export declare const GIFTS_BUTTON_COPY: Readonly<Record<string, Omit<GiftsButtonCopy, 'offersTitle'>>>;
+export declare function giftsButtonCopy(layout: string, strings: GiftsButtonStrings): GiftsButtonCopy;
+//# sourceMappingURL=config.d.ts.map

package/types/triggers/giftsButton/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/triggers/giftsButton/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAInD,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,MAAM,EAAE,aAAa,CAAC;IACtB,0EAA0E;IAC1E,WAAW,EAAE,aAAa,CAAC;IAC3B,iFAAiF;IACjF,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAe9F;AAED,+BAA+B;AAC/B,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,4DAA4D;IAC5D,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,6DAA6D;AAC7D,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC,CAM3F,CAAC;AAEH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,eAAe,CAU5F"}

package/types/triggers/giftsButton/spot.d.ts

@@ -0,0 +1,54 @@
+/**
+ * A GiftsButton spot: one mount, one `/config` request, and whatever look Encore answers
+ * it with (§2.8). The spot tells Encore what happened on the device (`state`): a claim
+ * the reminder could show (`claimOpen`) or an offer finished today and not yet thanked
+ * (`completed`). The served look's behavior decides the step, so the answer may be the
+ * gifts button, its thanks look, nothing, or the claim reminder's look
+ * (`ui.template.trigger` claimReminder). This plug-in draws whichever arrives with the
+ * GiftsButton or ClaimReminder plug-in, so the two are one spot with one request.
+ */
+import type { ReminderConfig } from '../claimReminder/config';
+import type { ReminderContent, ReminderModel } from '../claimReminder/ClaimReminder';
+import type { TriggerPlugin } from '../host/types';
+type Plugin<C, F, M> = TriggerPlugin<C, F, M>;
+export interface GiftsSpotDeps {
+    /**
+     * Ask the server whether the claims the reminder would draw ended (bounded, cached),
+     * before the spot says what happened. `dismissed`: the reminder's dismissed claims,
+     * never asked about. Absent: the claim log alone decides.
+     */
+    checkClaims?(dismissed: (transactionId: string) => boolean): Promise<void>;
+    /** An offer finished today, none claimed since, not thanked yet: its claim's id. */
+    thanksFor?(): string | null;
+}
+export interface GiftsSpotContent<G> {
+    /** The gifts button's content (its offers), with the completion when there is one. */
+    gifts: G;
+    /** The reminder's content, when the user has a claim it could show. */
+    reminder: ReminderContent | null;
+    /** The completion the `completed` state is about, when there is no claim to show. */
+    completion: string | null;
+}
+export type GiftsSpotConfig<F> = {
+    of: 'gifts';
+    config: F;
+} | {
+    of: 'reminder';
+    config: ReminderConfig;
+};
+export type GiftsSpotModel<M> = {
+    of: 'gifts';
+    model: M;
+} | {
+    of: 'reminder';
+    model: ReminderModel;
+};
+/**
+ * The spot over the two plug-ins. `gifts` is the GiftsButton plug-in (its content takes
+ * an optional `thanks` completion), `reminder` the ClaimReminder plug-in.
+ */
+export declare function giftsSpotPlugin<G extends {
+    thanks?: string;
+}, F, M>(gifts: Plugin<G, F, M>, reminder: Plugin<ReminderContent, ReminderConfig, ReminderModel>, deps: GiftsSpotDeps): Plugin<GiftsSpotContent<G>, GiftsSpotConfig<F>, GiftsSpotModel<M>>;
+export {};
+//# sourceMappingURL=spot.d.ts.map

package/types/triggers/giftsButton/spot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spot.d.ts","sourceRoot":"","sources":["../../../src/triggers/giftsButton/spot.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACrF,OAAO,KAAK,EAAE,aAAa,EAAe,MAAM,eAAe,CAAC;AAMhE,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAE9C,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,WAAW,CAAC,CAAC,SAAS,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E,oFAAoF;IACpF,SAAS,CAAC,IAAI,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,sFAAsF;IACtF,KAAK,EAAE,CAAC,CAAC;IACT,uEAAuE;IACvE,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;IACjC,qFAAqF;IACrF,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,CAAC;AAEzG,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,UAAU,CAAC;IAAC,KAAK,EAAE,aAAa,CAAA;CAAE,CAAC;AAErG;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,EAAE,CAAC,EACjE,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,eAAe,EAAE,cAAc,EAAE,aAAa,CAAC,EAChE,IAAI,EAAE,aAAa,GAClB,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAyHpE"}

package/types/triggers/host/TriggerHost.d.ts

@@ -0,0 +1,127 @@
+/**
+ * The one trigger host: mounts any registered trigger plug-in into an element.
+ *
+ * Owns everything triggers share (generic-contract.md, "Host responsibilities"):
+ * the pre-config gate (`prepare`), `/config?trigger=<id>&useCase=<real>` once per
+ * identity, the envelope check, decode, present, the served locale, visibility and the
+ * `sdk_trigger_*` events with their common fields, one tap at a time, the
+ * per-trigger dismiss store, foreground re-prepare, and a full re-run on identity
+ * or language change (`reload()`).
+ *
+ * It never throws into the host page and renders nothing (no element, so zero height)
+ * whenever there is nothing to show.
+ */
+import type { AnalyticsEvent } from '../../analytics/models';
+import type { EncoreAlignment, TriggerHandle, TriggerMountOptions, ShowResult } from '../../types';
+import { type TriggerRequest } from '../request';
+import type { TriggerPortalTheme } from './theme';
+import type { AnyTriggerPlugin, TriggerEntry, HostSheetRequest } from './types';
+/** What the host needs from the SDK. Encore builds one per mount. */
+export interface TriggerHostDeps {
+    /** `GET /config?trigger=<id>&useCase=…` for this placement and request. Rejects on failure. */
+    fetchConfig(triggerId: string, placementId: string | undefined, request: TriggerRequest): Promise<unknown>;
+    track(build: (distinctId: string) => AnalyticsEvent): void;
+    /** Where dismissals persist. May throw (blocked storage) or return null. */
+    storage(): Storage | null;
+    /** The SDK's sheet, for a plug-in whose tap presents it. Absent: resolves unavailable. */
+    presentSheet?(request: HostSheetRequest): Promise<ShowResult>;
+    /** Whether a sheet the app opened itself is up now. An automatic tap waits while it is. */
+    sheetBusy?(): boolean;
+}
+/** What a reload starts over for: another person, or the same person in another language. */
+export type ReloadScope = 'identity' | 'language';
+/** The public handle, plus the SDK's own hook for an identity or language change. */
+export interface HostHandle extends TriggerHandle {
+    /** The mounted trigger's id. */
+    readonly triggerId: string;
+    /**
+     * INTERNAL: start over (fresh prepare and /config). Encore calls it from reset() and
+     * identify() (`identity`), and from setLanguage() and clearLanguage() (`language`).
+     */
+    reload(scope?: ReloadScope): void;
+    /** INTERNAL: read the content again, keeping the variant (targeting attributes changed). */
+    refresh(): void;
+}
+export declare const NOOP_HANDLE: HostHandle;
+/** A handle that does nothing, for a mount that never started. */
+export declare function noopHandle(): TriggerHandle;
+/** The alignment a mount asked for; anything else is the default, centre. */
+export declare function triggerAlignmentOf(value: unknown): EncoreAlignment;
+/** What the served response says, once checked. */
+interface Served {
+    config: unknown;
+    variantId?: string;
+    experimentId?: string;
+    /** The step a look's behavior chose this for (`ui.step`), with the experiment that decided it. */
+    step?: 'afterClaim' | 'afterComplete';
+    stepExperimentId?: string | null;
+    locale?: string;
+    /** The app's theme from the portal (`ui.values`). */
+    portal?: TriggerPortalTheme;
+    /** The text slots this mount's text replaced in the served look, sorted. */
+    textSlots?: readonly string[];
+}
+/**
+ * A sheet the app opened itself ended in a claim: a pop held behind it is dropped, as
+ * after a trigger's own sheet. Encore calls it, once the host is loaded.
+ */
+export declare function appSheetClaimed(): void;
+/**
+ * A custom claim handle's tap (`Encore.claim`) takes the same page-wide lock as a
+ * trigger's: one sheet at a time. Null when another tap is in flight.
+ */
+export declare function takePageTap(): symbol | null;
+/**
+ * The sheet a custom handle's tap opened closed: release the lock as a trigger's tap
+ * does (a held pop is dropped after a claim, else the first one runs), and every
+ * mounted trigger reads again, afresh after a claim.
+ */
+export declare function settlePageTap(token: symbol, claimed: boolean): void;
+/** Hear every dismiss in a trigger mount. Returns an unsubscribe. */
+export declare function onTriggerDismissed(listener: (triggerId: string) => void): () => void;
+/**
+ * A custom handle dismissed `triggerId`'s content: every mount that draws it (its own, or a
+ * spot drawing its look) catches up, and every other custom handle hears it. `source`, the
+ * handle's own listener, is not told again.
+ */
+export declare function dismissedByCustom(triggerId: string, source?: (triggerId: string) => void): void;
+/** Test hook: forget a tap a previous test left in flight. */
+export declare function forgetPageTap(): void;
+type Dict = Record<string, unknown>;
+/**
+ * The served config for `triggerId`, or null to render nothing: no template (the
+ * holdout, or no experiment), or a template for another trigger (a server that does
+ * not know `trigger` answers with the sheet's own config, which names none).
+ */
+export declare function readTriggerResponse(response: unknown, 
+/** The triggers whose looks may answer: the mounted one first, then those it may render. */
+drawable: string | readonly string[], decode: (template: Dict) => unknown): Served | null;
+/** The fade when the spot switches between its components (the gifts button and its reminder). */
+export declare const SWITCH_FADE_MS = 200;
+/**
+ * Whether `key` (placement and reason) was already reported today for this trigger,
+ * marking it reported if not. localStorage when it works, a page-wide record always.
+ * Only today's entries are kept.
+ */
+export declare function claimNotShownToday(storage: Storage | null, triggerId: string, key: string): boolean;
+/**
+ * Mount a trigger (a plug-in, or a registry entry that loads it) into `element`.
+ * `deps` is null when the SDK is not configured, which renders nothing. Never throws.
+ */
+export declare function mountTrigger(trigger: AnyTriggerPlugin | TriggerEntry, element: HTMLElement | null | undefined, options: TriggerMountOptions, deps: TriggerHostDeps | null, 
+/** Called once when the mount is torn down by any path, including the host removing it. */
+onReleased?: () => void): HostHandle;
+/**
+ * reset(): forget what this page holds for the previous person beside storage: the
+ * dismissals and the day's not-shown reports kept while storage could not take them.
+ */
+export declare function forgetTriggerMemory(): void;
+/**
+ * The user's claims changed (a claim just happened, a completion landed, or the claims
+ * API was bound): every mount reads again, afresh. Its device state may have changed
+ * (a GiftsButton spot now has a claim to remind about, or a completed one to thank for),
+ * and a held set may still list the claimed offer. Encore calls it.
+ */
+export declare function claimsChanged(): void;
+export {};
+//# sourceMappingURL=TriggerHost.d.ts.map

package/types/triggers/host/TriggerHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TriggerHost.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/TriggerHost.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAG7D,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMnG,OAAO,EAA0C,KAAK,cAAc,EAAqB,MAAM,YAAY,CAAC;AAK5G,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EAGZ,gBAAgB,EAMjB,MAAM,SAAS,CAAC;AAEjB,qEAAqE;AACrE,MAAM,WAAW,eAAe;IAC9B,+FAA+F;IAC/F,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,KAAK,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,cAAc,GAAG,IAAI,CAAC;IAC3D,4EAA4E;IAC5E,OAAO,IAAI,OAAO,GAAG,IAAI,CAAC;IAC1B,0FAA0F;IAC1F,YAAY,CAAC,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9D,2FAA2F;IAC3F,SAAS,CAAC,IAAI,OAAO,CAAC;CACvB;AAED,6FAA6F;AAC7F,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;AAElD,qFAAqF;AACrF,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C,gCAAgC;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAClC,4FAA4F;IAC5F,OAAO,IAAI,IAAI,CAAC;CACjB;AAID,eAAO,MAAM,WAAW,EAAE,UAOxB,CAAC;AAEH,kEAAkE;AAClE,wBAAgB,UAAU,IAAI,aAAa,CAE1C;AAED,6EAA6E;AAC7E,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,eAAe,CAElE;AA0DD,mDAAmD;AACnD,UAAU,MAAM;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kGAAkG;IAClG,IAAI,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC;IACtC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,4EAA4E;IAC5E,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B;AAmDD;;;GAGG;AACH,wBAAgB,eAAe,IAAI,IAAI,CAEtC;AAOD;;;GAGG;AACH,wBAAgB,WAAW,IAAI,MAAM,GAAG,IAAI,CAI3C;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAMnE;AAKD,qEAAqE;AACrE,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI,CAKpF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAU/F;AAED,8DAA8D;AAC9D,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAUpC;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,OAAO;AACjB,4FAA4F;AAC5F,QAAQ,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,EACpC,MAAM,EAAE,CAAC,QAAQ,EAAE,IAAI,KAAK,OAAO,GAClC,MAAM,GAAG,IAAI,CA+Bf;AAiED,kGAAkG;AAClG,eAAO,MAAM,cAAc,MAAM,CAAC;AA6ClC;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CA2BnG;AAs5CD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,gBAAgB,GAAG,YAAY,EACxC,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,EACvC,OAAO,EAAE,mBAAmB,EAC5B,IAAI,EAAE,eAAe,GAAG,IAAI;AAC5B,2FAA2F;AAC3F,UAAU,CAAC,EAAE,MAAM,IAAI,GACtB,UAAU,CA4BZ;AAgBD;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAEpC"}

package/types/triggers/host/autoPops.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The device's one pop a day per placement: a GiftsButton look and an `Encore.claim`
+ * view whose rules open the sheet by themselves share it, so a placement opens by itself
+ * at most once per local day whichever drew it.
+ */
+/** Where the pops are remembered: `{ [placement]: 'YYYY-MM-DD' }`, local days. */
+export declare const AUTO_POP_STORAGE_KEY = "encore.trigger.giftsButton.autoPopped";
+/** Forget the page-wide pops: reset(), and tests. */
+export declare function forgetAutoPops(): void;
+export declare function localDay(ms: number): string;
+/** The pop store over `storage` (read at each call; null or throwing falls back to the page). */
+export declare function autoPops(storage: () => Storage | null): {
+    reservePop: (placement: string | undefined, now: number) => boolean;
+    releasePop: (placement: string | undefined, day: string) => void;
+};
+//# sourceMappingURL=autoPops.d.ts.map

package/types/triggers/host/autoPops.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoPops.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/autoPops.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,kFAAkF;AAClF,eAAO,MAAM,oBAAoB,0CAA0C,CAAC;AAU5E,qDAAqD;AACrD,wBAAgB,cAAc,IAAI,IAAI,CAGrC;AAED,wBAAgB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAI3C;AAuBD,iGAAiG;AACjG,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,OAAO,GAAG,IAAI,GAAG;IACvD,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IACpE,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAClE,CA2DA"}

package/types/triggers/host/configCache.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Trigger /config answers, kept in memory for the page and shared by every mount on
+ * every platform. Keyed by trigger, use case, placement, identity, language, pinned
+ * layout, the mount's `autoOpen=off` and the device state (§2.8), so an off mount never
+ * reuses an allowed mount's answer (a look that opens the sheet by itself). A null template
+ * (holdout, no experiment, version-gated) is an answer and is kept: re-asking would
+ * record the assignment again for nothing. So is a template this build cannot read. A
+ * failed request, or a malformed answer (no success envelope with a `ui` object), is
+ * never kept. The SDK clears the whole cache on identify, reset and
+ * setLanguage / clearLanguage; a page reload starts empty.
+ */
+export declare class TriggerConfigCache {
+    #private;
+    static key(parts: {
+        triggerId: string;
+        useCase: string;
+        placementId: string | undefined;
+        userId: string;
+        language: string | undefined;
+        layout: string | undefined;
+        /** The mount's opt-out as sent: `'off'`, or absent. */
+        autoOpen: 'off' | undefined;
+        state?: string;
+    }): string;
+    /** The kept answer for `key`, or `load()`'s, kept unless it rejects. Concurrent asks share one request. */
+    get(key: string, load: () => Promise<unknown>): Promise<unknown>;
+    clear(): void;
+}
+//# sourceMappingURL=configCache.d.ts.map

package/types/triggers/host/configCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configCache.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/configCache.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,qBAAa,kBAAkB;;IAG7B,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;QAChC,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3B,uDAAuD;QACvD,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,MAAM;IAaV,2GAA2G;IAC3G,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAWhE,KAAK,IAAI,IAAI;CAGd"}

package/types/triggers/host/customClaim.d.ts

@@ -0,0 +1,85 @@
+/**
+ * The controller behind `Encore.claim()`: a publisher's own gifts button or claim
+ * reminder, counted and driven by Encore. INTERNAL; loaded on the first `claim()`.
+ *
+ * It never asks for a look to draw. Once the app's view is first on screen it asks for
+ * its rules, once per person: `GET /config?trigger=customClaim`, a behavior-only look
+ * (`afterClaim`, `afterComplete`, `autoOpen`) that Encore can test. Until they arrive,
+ * and whenever they cannot be read, it behaves as the default rules do (the reminder
+ * after a claim, gifts after a completion, never opening by itself), so a failure never
+ * hides the app's view. What it shows is decided locally, from the same sources a
+ * GiftsButton spot uses: the sheet's gate (its config and held offer search; the sheet's
+ * own holdout makes it `hidden`) and the claim log. Its `sdk_trigger_*` events go out as
+ * `trigger: "customClaim"`, `layout: "custom"`, with the rules' `variant_id` and
+ * `experiment_id` (none when no rules were read).
+ */
+import type { ClaimController } from '../../core/claimHandle';
+import type { EncoreClaimOptions, EncoreClaimState, UseCase } from '../../types';
+import type { ReminderClaim } from '../claimReminder/source';
+import { type TriggerHostDeps } from './TriggerHost';
+import type { SheetCheck } from './types';
+/** The layout every custom event reports. */
+export declare const CUSTOM_LAYOUT = "custom";
+/** The reminder's window for a custom view: the one every served look ships with. */
+export declare const CUSTOM_WINDOW_HOURS = 24;
+export interface CustomClaimDeps {
+    /** The sheet's gate, as a GiftsButton's: offers held for the tap, or none. */
+    checkSheet(useCase: UseCase, placement: string | undefined, fresh: boolean): Promise<SheetCheck>;
+    /** The user's claims (the claim log, merged with the claims API). */
+    claims(): Promise<ReminderClaim[]>;
+    /**
+     * Ask the server whether the user's open claims ended (bounded, cached; the claim log
+     * is updated and every handle told). Run at start and when the page is visible again.
+     */
+    checkClaims?(dismissed?: (transactionId: string) => boolean): Promise<void>;
+    /** Whether the user completed a claim today and made none since, for `afterComplete: 'hide'`. */
+    completedToday?(): boolean;
+    /**
+     * For `afterComplete: 'thanks'`: the completion (as `completedToday`) whose thanks is not
+     * yet tapped, by its claim's id, else null. Each completion counts its own view.
+     */
+    thanksFor?(): string | null;
+    /** The thanks state was tapped: it ends for that completion. */
+    thanksTapped?(): void;
+    /**
+     * A reminder tap about to open the sheet: false when the claim is known to have ended
+     * (synchronous: the sheet opens inside the click). Absent: always open.
+     */
+    claimTapped?(transactionId: string): boolean;
+    /** The rules request, analytics, storage, the sheet, and whether a sheet is up. */
+    host: Pick<TriggerHostDeps, 'track' | 'storage' | 'presentSheet' | 'sheetBusy'> & Partial<Pick<TriggerHostDeps, 'fetchConfig'>>;
+}
+/** The user's claims changed: every custom handle reads again, afresh. */
+export declare function claimsChangedForCustom(): void;
+/**
+ * Another person (`identity`): every custom handle starts over. The same person in
+ * another language: each reads again, keeping what it already counted.
+ */
+export declare function reloadCustom(scope?: 'identity' | 'language'): void;
+/** The targeting changed: every custom handle checks its sheet's offers again, at most once per 30 s. */
+export declare function refreshCustom(): void;
+/** The rules arm a read named: its look id and experiment (null on the default). */
+interface RulesArm {
+    variantId?: string;
+    experimentId: string | null;
+}
+/** The steps the handle follows: the default rules until a read says otherwise. */
+interface ClaimRules {
+    showReminder: boolean;
+    hide: boolean;
+    thanks: boolean;
+    autoOpen: boolean;
+}
+/**
+ * A customClaim `/config` answer's rules, or null to keep the default rules: no template
+ * (not configured, switched off), or one for another trigger. An unknown step or value
+ * keeps that step's default.
+ */
+export declare function readClaimRules(ui: unknown): {
+    rules: ClaimRules;
+    arm: RulesArm;
+} | null;
+/** Start the controller for a handle. Never throws. */
+export declare function startCustomClaim(options: EncoreClaimOptions, deps: CustomClaimDeps, setState: (state: EncoreClaimState) => void): ClaimController;
+export {};
+//# sourceMappingURL=customClaim.d.ts.map

package/types/triggers/host/customClaim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customClaim.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/customClaim.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAe,kBAAkB,EAAE,gBAAgB,EAAc,OAAO,EAAE,MAAM,aAAa,CAAC;AAM1G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAQ7D,OAAO,EAML,KAAK,eAAe,EACrB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,6CAA6C;AAC7C,eAAO,MAAM,aAAa,WAAW,CAAC;AACtC,qFAAqF;AACrF,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAMtC,MAAM,WAAW,eAAe;IAC9B,8EAA8E;IAC9E,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjG,qEAAqE;IACrE,MAAM,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IACnC;;;OAGG;IACH,WAAW,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,iGAAiG;IACjG,cAAc,CAAC,IAAI,OAAO,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,IAAI,MAAM,GAAG,IAAI,CAAC;IAC5B,gEAAgE;IAChE,YAAY,CAAC,IAAI,IAAI,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7C,mFAAmF;IACnF,IAAI,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,GAAG,SAAS,GAAG,cAAc,GAAG,WAAW,CAAC,GAC7E,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC,CAAC;CACjD;AAKD,0EAA0E;AAC1E,wBAAgB,sBAAsB,IAAI,IAAI,CAE7C;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,GAAE,UAAU,GAAG,UAAuB,GAAG,IAAI,CAE9E;AAED,yGAAyG;AACzG,wBAAgB,aAAa,IAAI,IAAI,CAEpC;AAED,oFAAoF;AACpF,UAAU,QAAQ;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,mFAAmF;AACnF,UAAU,UAAU;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAID;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,OAAO,GAAG;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,QAAQ,CAAA;CAAE,GAAG,IAAI,CAmBvF;AA0lBD,uDAAuD;AACvD,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,kBAAkB,EAC3B,IAAI,EAAE,eAAe,EACrB,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,GAC1C,eAAe,CAQjB"}

package/types/triggers/host/dismissStore.d.ts

@@ -0,0 +1,37 @@
+/**
+ * A trigger's dismissed content keys on this device. No server write. Each
+ * trigger has its own list; the plug-in chooses the key (ClaimReminder: the
+ * transaction id) through its presentation's `contentKey`.
+ *
+ * Stored as `[key, dismissedAtMs]` pairs, oldest first, at most {@link MAX_DISMISSED},
+ * each forgotten {@link DISMISS_RETENTION_MS} after it was dismissed (the same
+ * retention on every platform; expired entries go on the next write). localStorage is
+ * the record whenever it can be read, so every mount and tab agrees on one ordered
+ * list and a stale copy can never bring an aged-out key back. When it cannot be read
+ * (private mode, a blocked frame), a page-wide list stands in, so the mounts on one
+ * page still agree. A key whose write failed while reads still work (quota) is held
+ * for the page too, so the dismiss sticks until the page closes.
+ */
+/** The storage key for one trigger's list, the same on every platform. */
+export declare function dismissStorageKey(triggerId: string): string;
+/** Bound on stored keys. Oldest go first. */
+export declare const MAX_DISMISSED = 100;
+/** How long a dismissal lasts: 720 hours, the longest window any trigger serves. */
+export declare const DISMISS_RETENTION_MS: number;
+/** Test hook: how many failed-write keys are held, over every trigger. */
+export declare function heldCount(): number;
+/** Forget the page-wide state: reset(), and tests. */
+export declare function forgetDismissalMemory(): void;
+export declare class DismissStore {
+    #private;
+    constructor(storage: Storage | null, triggerId: string);
+    /** How many keys are held. */
+    get size(): number;
+    has(key: string): boolean;
+    /** The dismissed keys as of the last sync() or add(). */
+    keys(): ReadonlySet<string>;
+    /** Re-read the record: another mount on this page, or another tab, may have dismissed since. */
+    sync(): void;
+    add(key: string): void;
+}
+//# sourceMappingURL=dismissStore.d.ts.map

package/types/triggers/host/dismissStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dismissStore.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/dismissStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,0EAA0E;AAC1E,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,6CAA6C;AAC7C,eAAO,MAAM,aAAa,MAAM,CAAC;AAEjC,oFAAoF;AACpF,eAAO,MAAM,oBAAoB,QAAuB,CAAC;AAkBzD,0EAA0E;AAC1E,wBAAgB,SAAS,IAAI,MAAM,CAIlC;AAED,sDAAsD;AACtD,wBAAgB,qBAAqB,IAAI,IAAI,CAG5C;AAkCD,qBAAa,YAAY;;gBAKX,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,SAAS,EAAE,MAAM;IAMtD,8BAA8B;IAC9B,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzB,yDAAyD;IACzD,IAAI,IAAI,WAAW,CAAC,MAAM,CAAC;IAI3B,gGAAgG;IAChG,IAAI,IAAI,IAAI;IAIZ,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CA0DvB"}

package/types/triggers/host/readThrottle.d.ts

@@ -0,0 +1,15 @@
+/**
+ * At most one gate re-read per {@link READ_THROTTLE_MS} from the page becoming visible
+ * again or the targeting attributes changing, per mount. A trigger inside the window
+ * is not dropped: one read runs when the window ends (on a visible page), so the last
+ * change always lands. A claim, a dismissal or a new person reads at once, outside this.
+ */
+export declare const READ_THROTTLE_MS = 30000;
+export declare class ReadThrottle {
+    #private;
+    constructor(read: () => void, now?: () => number);
+    /** Read now, or once the window ends. */
+    request(): void;
+    cancel(): void;
+}
+//# sourceMappingURL=readThrottle.d.ts.map

package/types/triggers/host/readThrottle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readThrottle.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/readThrottle.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,gBAAgB,QAAS,CAAC;AAEvC,qBAAa,YAAY;;gBAMX,IAAI,EAAE,MAAM,IAAI,EAAE,GAAG,GAAE,MAAM,MAAyB;IAKlE,yCAAyC;IACzC,OAAO,IAAI,IAAI;IAmBf,MAAM,IAAI,IAAI;CAQf"}

package/types/triggers/host/registry.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The triggers this SDK build ships, by id. INTERNAL: a host app names an id, it
+ * cannot register one (generic-contract.md, v1).
+ */
+import type { TriggerEntry } from './types';
+export declare class TriggerRegistry {
+    #private;
+    /** `entries` load their plug-in on first use; each loads once, however many mounts ask. */
+    constructor(entries: readonly TriggerEntry[]);
+    /**
+     * The entry for `id`, or null for an id this build does not ship. An unknown id
+     * renders nothing and sends nothing; it is logged once per id, so a typo is
+     * findable without a log line per render.
+     */
+    get(id: unknown): TriggerEntry | null;
+}
+//# sourceMappingURL=registry.d.ts.map

package/types/triggers/host/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/registry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAoB,YAAY,EAAE,MAAM,SAAS,CAAC;AAE9D,qBAAa,eAAe;;IAI1B,2FAA2F;gBAC/E,OAAO,EAAE,SAAS,YAAY,EAAE;IAiB5C;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,OAAO,GAAG,YAAY,GAAG,IAAI;CAUtC"}

package/types/triggers/host/sduiView.d.ts

@@ -0,0 +1,31 @@
+/**
+ * How every trigger draws: the served `ui.template.root`, through the SDUI engine,
+ * inline in the host's element (trigger SDUI vocabulary contract v1). The plug-in
+ * supplies the bindings (values, time keys, lists) and the resolved palette; the
+ * tree decides the look, including the height (§3.7).
+ *
+ * The engine owns drawing and the countdown and loop timing; this view owns what the
+ * host feeds it: the clock on each present, the palette as appearance tokens, the
+ * busy state, and the motion flags (§2.4, §2.6).
+ */
+import type { SduiHostListItem } from '../../sdui/context';
+import { type TriggerTheme } from './theme';
+import type { TriggerRenderScope, TriggerView } from './types';
+/** What a trigger hands the engine for one render. */
+export interface TriggerSduiModel {
+    /** `ui.template` as served, already through the host's pre-check. */
+    template: Record<string, unknown>;
+    theme: TriggerTheme;
+    /** `${key}` values (§2.2). They win over the template's own values. */
+    values: Readonly<Record<string, string>>;
+    /** Time keys in ms since the epoch (§2.3). */
+    times?: Readonly<Record<string, number>>;
+    /** Host lists (§2.5). */
+    lists?: Readonly<Record<string, readonly SduiHostListItem[]>>;
+}
+/**
+ * Mount `model` and return the host's view of it. Throws when the engine cannot
+ * mount the tree; the host reports that as `unrenderable`.
+ */
+export declare function renderTriggerSdui(model: TriggerSduiModel, scope: TriggerRenderScope): TriggerView<TriggerSduiModel>;
+//# sourceMappingURL=sduiView.d.ts.map

package/types/triggers/host/sduiView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sduiView.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/sduiView.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAAwC,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAClF,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE/D,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAC/B,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,KAAK,EAAE,YAAY,CAAC;IACpB,uEAAuE;IACvE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACzC,8CAA8C;IAC9C,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACzC,yBAAyB;IACzB,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,gBAAgB,EAAE,CAAC,CAAC,CAAC;CAC/D;AAqBD;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,gBAAgB,EACvB,KAAK,EAAE,kBAAkB,GACxB,WAAW,CAAC,gBAAgB,CAAC,CA+H/B"}

package/types/triggers/host/template.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Reading the parts of a served template every trigger shares: `colors` and
+ * `strings`. Tolerant: a missing or malformed field is skipped, and the caller's
+ * default answers.
+ */
+import type { TriggerColors } from './theme';
+import type { SduiHostListItem } from '../../sdui/context';
+import type { HeldOffer } from './types';
+type Dict = Record<string, unknown>;
+export declare function isDict(value: unknown): value is Dict;
+/** The first character, uppercased; a whole code point, so an astral letter is not split. */
+export declare function initialOf(name: string): string;
+/** A non-blank string, or undefined. */
+export declare function text(value: unknown): string | undefined;
+/** `template.colors`: the three colours, each kept only when it is a non-blank string. */
+export declare function readColors(value: unknown): TriggerColors;
+/**
+ * `template.strings`, already localized by the server, then `defaults` per key: a
+ * blank or missing key takes the built-in English.
+ */
+export declare function readStrings<K extends string>(value: unknown, defaults: Readonly<Record<K, string>>): Record<K, string>;
+/**
+ * The held offers' logos: one per advertiser with a safe image, in sheet order, at
+ * most eight. Items carry `logoUrl`, `advertiserName` and `advertiserInitial`.
+ */
+export declare function offerLogosOf(offers: readonly HeldOffer[]): SduiHostListItem[];
+export {};
+//# sourceMappingURL=template.d.ts.map

package/types/triggers/host/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/template.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAGzC,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpC,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEpD;AAED,6FAA6F;AAC7F,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG9C;AAED,wCAAwC;AACxC,wBAAgB,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAEvD;AAED,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,CAQxD;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAC1C,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GACpC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAKnB;AAKD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,GAAG,gBAAgB,EAAE,CAgB7E"}