@encorekit/web-sdk 2.3.0 → 2.4.0

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"}

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

@@ -0,0 +1,35 @@
+/**
+ * The app's own words on a trigger (`headline`, `subheadline`, `cta`): a look names, in
+ * its root `textSlots`, which of its OWN strings each slot replaces, so that string is
+ * the slot's default (translated, per variant). App text is cleaned the same way on every
+ * platform, never translated, and never leaves the device.
+ */
+/** The text slots a mount can set, in wire order. */
+export declare const TEXT_SLOTS: readonly ["headline", "subheadline", "cta"];
+export type TextSlot = (typeof TEXT_SLOTS)[number];
+/** The longest slot text kept, in UTF-16 code units (JavaScript `.length`). */
+export declare const MAX_SLOT_TEXT_LENGTH = 120;
+/**
+ * An app's slot text as it may be drawn, or null for the look's own default: not a
+ * string, nothing visible after cleaning, or text still holding `${` (the fill pass would
+ * expand it). The order is shared by every SDK.
+ */
+export declare function sanitizeSlotText(raw: unknown): string | null;
+/** A mount's slot text, cleaned once: only the slots it set with text that survives. */
+export declare function mountSlotText(options: Partial<Record<TextSlot, unknown>> | null | undefined): Partial<Record<TextSlot, string>>;
+/**
+ * `template` with the app's text in place of the strings its `textSlots` name, and the
+ * slots drawn with app text (sorted; empty when none). Lenient, as a device is with a newer
+ * server: an unknown slot, a slot naming a string the look lacks, or a `textSlots` that is
+ * not an object is skipped. A state look keeps its own words. The template is never
+ * changed in place, so a shared cached answer stays as served.
+ */
+export declare function withSlotText(template: unknown, text: Partial<Record<TextSlot, string>>): {
+    template: unknown;
+    drawn: TextSlot[];
+};
+/** The string a look's headline slot names, for the reminder's spoken title; null when none. */
+export declare function headlineKeyOf(template: unknown): string | null;
+/** Each slot a look declares in the string form, with the string it replaces. */
+export declare function slotKeysOf(template: unknown): Partial<Record<TextSlot, string>>;
+//# sourceMappingURL=textSlots.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"textSlots.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/textSlots.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,qDAAqD;AACrD,eAAO,MAAM,UAAU,6CAA8C,CAAC;AACtE,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnD,+EAA+E;AAC/E,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAkCxC;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAc5D;AAED,wFAAwF;AACxF,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAO/H;AAMD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,OAAO,EACjB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,GACtC;IAAE,QAAQ,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,QAAQ,EAAE,CAAA;CAAE,CAe1C;AAED,gGAAgG;AAChG,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAI9D;AAED,iFAAiF;AACjF,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAQ/E"}

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

@@ -0,0 +1,87 @@
+/**
+ * Colour precedence, per token: the publisher's `appearance`, then the app's theme
+ * set in the portal (served as `ui.values.appearance`), then the look's colours,
+ * then the built-in default. A publisher colour is never overridden. Text follows the background: a
+ * background set without a text colour at the same level gets black or white
+ * ink for that background, never a text colour picked for another one.
+ *
+ * Only hex is accepted (`#RGB`, `#RRGGBB`, `#RRGGBBAA`): the formats every platform's
+ * AppearanceConfig parses, so one value is one colour everywhere. Anything else is
+ * skipped and the next source answers. Values reach the page through
+ * `style.setProperty`, never through markup.
+ */
+import type { AppearanceConfig } from '../../types';
+/** A template's `colors` block, as every trigger variant serves it. */
+export interface TriggerColors {
+    background?: string;
+    accent?: string;
+    text?: string;
+}
+/** What a trigger reads from `appearance`: its seven colours and `colorScheme`; the sheet's slots do not apply. */
+export type TriggerAppearance = Pick<AppearanceConfig, 'accentColor' | 'backgroundColor' | 'textColor' | 'secondaryTextColor' | 'trackColor' | 'onAccentColor' | 'backgroundEndColor' | 'colorScheme'>;
+/**
+ * The app's theme as the portal stores it and `/config` serves it in `ui.values`:
+ * hex as the server writes it (8 digits are alpha first, as the sheet reads them).
+ */
+export interface TriggerPortalTheme {
+    accentColor?: string;
+    /** The app's saved appearance mode (`light`, `dark` or `auto`). */
+    mode?: string;
+    /** The app's store icon (`media.appstoreIcon`). */
+    appIconUrl?: string;
+}
+export interface TriggerTheme {
+    background: string;
+    accent: string;
+    text: string;
+    /** Set only by the publisher; unset falls back to the text colour at the look's opacity. */
+    secondary?: string;
+    /** Set only by the publisher; unset falls back to the text colour at the look's opacity. */
+    track?: string;
+    /** Set only by the publisher; unset is black or white for the accent. */
+    onAccent?: string;
+    /** Set only by the publisher: a gradient's second stop. Unset is `background` (a solid card). */
+    backgroundEnd?: string;
+}
+/** The Figma palette every trigger shares. */
+export declare const DEFAULT_TRIGGER_THEME: Readonly<TriggerTheme>;
+/** Encore's light palette, used in the light scheme when nothing above it sets a colour. */
+export declare const DEFAULT_LIGHT_TRIGGER_THEME: Readonly<TriggerTheme>;
+export type TriggerScheme = 'light' | 'dark';
+/**
+ * Light or dark for a trigger: the publisher's `colorScheme`, then the app's saved
+ * mode from the portal (`auto` follows the device, as `system` does), then dark. A
+ * value it does not know is skipped. Dark stays the default unless someone opts in.
+ */
+export declare function resolveTriggerScheme(appearance: Pick<AppearanceConfig, 'colorScheme'> | undefined, portal: TriggerPortalTheme, prefersDark?: () => boolean): TriggerScheme;
+/**
+ * `variant` is the look's dark colours (`colors`); `lightVariant` its light ones
+ * (`lightColors`). In the light scheme the look's dark colours never apply: the order
+ * is publisher, portal, the look's light colours, then Encore's light default.
+ */
+export declare function resolveTriggerTheme(appearance: TriggerAppearance | undefined, darkVariant: TriggerColors, portal?: TriggerPortalTheme, scheme?: TriggerScheme, lightVariant?: TriggerColors): TriggerTheme;
+/**
+ * The appearance tokens a trigger tree names (trigger SDUI contract §2.1), from the
+ * resolved palette. The accent is read as drawn: a translucent accent composited
+ * over the surface. `onAccent` is black or white, whichever reads on it;
+ * `inkOnAccent` is the surface itself when it is opaque and reaches 3:1 on the
+ * accent, as designed, else `onAccent`.
+ */
+export declare function triggerTokens(theme: TriggerTheme): Readonly<Record<string, string>>;
+/**
+ * The tokens that fell back to the text colour because the publisher left them
+ * unset. Only on these does a look's `opacity` apply: a colour the publisher chose is
+ * drawn exactly as chosen, never faded.
+ */
+export declare function triggerFallbackTokens(theme: TriggerTheme): ReadonlySet<string>;
+export interface TriggerIconValues {
+    icon: 'gift' | 'appIcon' | 'none';
+    appIconUrl?: string;
+}
+/**
+ * The icon a look draws, as host values: `icon` is `gift`, `appIcon` or `none`, and
+ * `appIconUrl` is the app's store icon when it is a safe image. `appIcon` without a
+ * usable icon draws the gift, and an icon this SDK does not know is the gift too.
+ */
+export declare function triggerIconValues(asked: unknown, portal: TriggerPortalTheme): TriggerIconValues;
+//# sourceMappingURL=theme.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/theme.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD,uEAAuE;AACvE,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,mHAAmH;AACnH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,gBAAgB,EACd,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,oBAAoB,GACpB,YAAY,GACZ,eAAe,GACf,oBAAoB,GACpB,aAAa,CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4FAA4F;IAC5F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iGAAiG;IACjG,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,8CAA8C;AAC9C,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,YAAY,CAIvD,CAAC;AAEH,4FAA4F;AAC5F,eAAO,MAAM,2BAA2B,EAAE,QAAQ,CAAC,YAAY,CAI7D,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,CAAC;AAU7C;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,GAAG,SAAS,EAC7D,MAAM,EAAE,kBAAkB,EAC1B,WAAW,GAAE,MAAM,OAA2B,GAC7C,aAAa,CAQf;AAyBD;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,iBAAiB,GAAG,SAAS,EACzC,WAAW,EAAE,aAAa,EAC1B,MAAM,CAAC,EAAE,kBAAkB,EAC3B,MAAM,GAAE,aAAsB,EAC9B,YAAY,GAAE,aAAkB,GAC/B,YAAY,CA6Bd;AA4BD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAoBnF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,CAK9E;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,kBAAkB,GACzB,iBAAiB,CAInB"}

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

@@ -0,0 +1,11 @@
+/**
+ * The longest any trigger waits before presenting or reading again: a deadline, a
+ * local midnight, a plug-in's `readAgainAt`. Further than this, it presents (or reads)
+ * at the cap, which works the time out afresh. The same cap on every platform.
+ */
+export declare const MAX_REPRESENT_MS: number;
+/** How long to wait for `at` from `now`: never negative, never past the cap. */
+export declare function representDelay(at: number, now: number): number;
+/** Epoch ms of the local midnight after `now`. */
+export declare function nextLocalMidnight(now?: number): number;
+//# sourceMappingURL=timers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"timers.d.ts","sourceRoot":"","sources":["../../../src/triggers/host/timers.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAA0B,CAAC;AAExD,gFAAgF;AAChF,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9D;AAED,kDAAkD;AAClD,wBAAgB,iBAAiB,CAAC,GAAG,GAAE,MAAmB,GAAG,MAAM,CAIlE"}