@rocapine/rocalytics-sdk 0.0.0-stage → 0.2.0

package/dist/onboarding/contract.d.ts

@@ -0,0 +1,138 @@
+/**
+ * RFC 3339 timestamp in UTC with exactly three fractional digits and a `Z`
+ * suffix, e.g. `2026-01-10T09:00:00.000Z`.
+ */
+export type Timestamp = string;
+/**
+ * An identifier chosen by the app: 1 to 128 characters from `A-Z a-z 0-9 _ . : -`,
+ * starting with a letter or digit. Case-sensitive. Used for onboarding, step,
+ * question, option, slot and variant keys.
+ */
+export type Key = string;
+export interface OnboardingIdentity {
+    /**
+     * Stable key for one flow. Never reused for a different flow. Each
+     * Studio-served A/B arm is its own onboarding, so it has its own key.
+     */
+    key: Key;
+    /**
+     * Revision of the flow. 1 to 64 characters from `A-Z a-z 0-9 _ . : + -`,
+     * starting with a letter or digit. Must change whenever the manifest changes,
+     * except for the reserved version `draft`, which a Studio-served draft or
+     * preview must send because it has no deployment id.
+     */
+    version: string;
+    /**
+     * In-flow variant, for an app that runs one flow (one key) with its own
+     * variants. Not set for a Studio-served run. Absent or null otherwise.
+     */
+    variant_key?: Key | null;
+}
+/** Optional links to Studio records. Opaque strings of 1 to 128 characters; numeric ids are sent in decimal. */
+export interface StudioLinks {
+    onboarding_id?: string | null;
+    deployment_id?: string | null;
+    audience_id?: string | null;
+}
+/** Captured once, at run start, and repeated unchanged in every snapshot. */
+export interface RunContext {
+    /** Marketing version, e.g. `2.4.0`. 1 to 32 characters. */
+    app_version: string;
+    /** Build number, 1 to 32 characters, or null on a platform with no such concept. */
+    build: string | null;
+    platform: "ios" | "android" | "web";
+    /** OS version, 1 to 32 characters, or null when the platform cannot report one. */
+    os_version: string | null;
+    /** BCP 47 language tag the onboarding is shown in, e.g. `fr-FR`. */
+    locale: string;
+    /** IANA time zone, e.g. `Europe/Paris`. At most 64 characters. */
+    timezone: string;
+    /** Version of the tracking library that produced the payload. 1 to 32 characters. */
+    library_version?: string;
+}
+export interface ManifestStep {
+    step_key: Key;
+    /** Steps sharing a slot are alternatives shown at one position. Must be contiguous. */
+    slot?: Key;
+}
+/** Declared once, at run start, and repeated unchanged in every snapshot. */
+export interface Manifest {
+    /** Every step the flow can show, in flow order. 1 to 200 entries. */
+    steps: ManifestStep[];
+}
+/** Run-level custom property value. Strings are at most 256 characters; numbers are finite. */
+export type PropertyValue = string | number | boolean | null;
+/** At most 20 keys, each matching `^[a-z][a-z0-9_]{0,39}$`. */
+export type Properties = Record<string, PropertyValue>;
+export type Answer = {
+    question_key: Key;
+    kind: "single";
+    value: Key;
+}
+/** At most 50 option keys, unique. */
+ | {
+    question_key: Key;
+    kind: "multi";
+    value: Key[];
+} | {
+    question_key: Key;
+    kind: "numeric";
+    value: number;
+    unit?: Key;
+}
+/** At most 1,000 characters. Never aggregated. */
+ | {
+    question_key: Key;
+    kind: "text";
+    value: string;
+};
+/**
+ * One visit to a screen the user was shown. A step that was not shown has no
+ * entry; whether the run passed over it is derived from the manifest.
+ */
+export interface StepEntry {
+    step_key: Key;
+    entered_at: Timestamp;
+    /**
+     * Null only on the last entry of an in_progress run. In a truncated run the
+     * last kept entry may already be closed, and keeps its own exit on completion.
+     */
+    exited_at: Timestamp | null;
+    /** At most 50. `question_key` is unique within an entry. */
+    answers: Answer[];
+}
+interface RunSnapshotBase {
+    schema_version: 1;
+    /** Client-minted, lowercase UUID. One per run. */
+    run_id: string;
+    /** Starts at 1 and increases with every send of this run. A retry reuses it. */
+    seq: number;
+    started_at: Timestamp;
+    /** Client clock when this snapshot was sent. Advisory only. */
+    sent_at: Timestamp;
+    onboarding: OnboardingIdentity;
+    studio?: StudioLinks;
+    context: RunContext;
+    manifest: Manifest;
+    properties?: Properties;
+    /**
+     * Present once the tracker has stopped recording (no new entries, answers or
+     * property changes) because recording more would break the 500-entry or
+     * 256 KiB limit. What was recorded is kept.
+     */
+    truncated?: true;
+    /** Every entry so far, in the order they happened. 1 to 500 entries. */
+    steps: StepEntry[];
+}
+export interface InProgressRunSnapshot extends RunSnapshotBase {
+    status: "in_progress";
+    completed_at: null;
+}
+export interface CompletedRunSnapshot extends RunSnapshotBase {
+    status: "completed";
+    completed_at: Timestamp;
+}
+/** One send. Each send replaces the run's previous snapshot. */
+export type OnboardingRunSnapshot = InProgressRunSnapshot | CompletedRunSnapshot;
+export {};
+//# sourceMappingURL=contract.d.ts.map

package/dist/onboarding/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../src/onboarding/contract.ts"],"names":[],"mappings":"AASA;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AAEzB,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAC;IACT;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,WAAW,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC1B;AAED,gHAAgH;AAChH,MAAM,WAAW,WAAW;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,6EAA6E;AAC7E,MAAM,WAAW,UAAU;IACzB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,oFAAoF;IACpF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC;IACpC,mFAAmF;IACnF,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,qFAAqF;IACrF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,GAAG,CAAC;IACd,uFAAuF;IACvF,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,6EAA6E;AAC7E,MAAM,WAAW,QAAQ;IACvB,qEAAqE;IACrE,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,+FAA+F;AAC/F,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE7D,+DAA+D;AAC/D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAEvD,MAAM,MAAM,MAAM,GACd;IAAE,YAAY,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,GAAG,CAAA;CAAE;AACnD,sCAAsC;GACpC;IAAE,YAAY,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,GAAG,EAAE,CAAA;CAAE,GAClD;IAAE,YAAY,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,GAAG,CAAA;CAAE;AACnE,kDAAkD;GAChD;IAAE,YAAY,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,EAAE,SAAS,CAAC;IACtB;;;OAGG;IACH,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,4DAA4D;IAC5D,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,UAAU,eAAe;IACvB,cAAc,EAAE,CAAC,CAAC;IAClB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,SAAS,CAAC;IACtB,+DAA+D;IAC/D,OAAO,EAAE,SAAS,CAAC;IACnB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,wEAAwE;IACxE,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,MAAM,EAAE,WAAW,CAAC;IACpB,YAAY,EAAE,SAAS,CAAC;CACzB;AAED,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,oBAAoB,CAAC"}

package/dist/onboarding/contract.js

@@ -0,0 +1,11 @@
+"use strict";
+// Onboarding run contract, schema_version 1: TypeScript types.
+//
+// The normative text is onboarding-run-contract.md; the machine-checkable shape
+// is onboarding-run.schema.json. These types mirror the schema. Where a rule is
+// a pattern or a limit (key characters, list lengths), the type says `string`
+// or `T[]` and the comment names the rule; the schema enforces it.
+//
+// This file has no imports, so it can be copied into any TypeScript project.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contract.js.map

package/dist/onboarding/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../src/onboarding/contract.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,EAAE;AACF,gFAAgF;AAChF,gFAAgF;AAChF,8EAA8E;AAC9E,mEAAmE;AACnE,EAAE;AACF,6EAA6E"}

package/dist/onboarding/index.d.ts

@@ -0,0 +1,15 @@
+export { createOnboardingRunTracker, onboardingRun } from "./tracker";
+export type { ExitOptions, OnboardingRun, OnboardingRunTracker, TrackerConfig } from "./tracker";
+export type { AnswerInput, ManifestInput, OnboardingInput, StartOptions, StudioInput } from "./input";
+export { MAX_ENTRIES, RECORDING_BUDGET } from "./state";
+export { LIBRARY_VERSION } from "../version";
+export { createHttpSink } from "../core/httpSink";
+export type { HttpSinkOptions } from "../core/httpSink";
+export { memoryStorage } from "../core/storage";
+export type { KeyValueStorage } from "../core/storage";
+export type { Sink, SinkOutcome, SinkResult } from "../core/sink";
+export type { Clock, Timers } from "../core/time";
+export type { RunContextInput } from "../core/context";
+export type { Diagnostic, DiagnosticHandler } from "../core/diagnostics";
+export type { Answer, CompletedRunSnapshot, InProgressRunSnapshot, Key, Manifest, ManifestStep, OnboardingIdentity, OnboardingRunSnapshot, Properties, PropertyValue, RunContext, StepEntry, StudioLinks, Timestamp, } from "./contract";
+//# sourceMappingURL=index.d.ts.map

package/dist/onboarding/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/onboarding/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,0BAA0B,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACtE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACjG,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtG,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAG7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAClE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,YAAY,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGzE,YAAY,EACV,MAAM,EACN,oBAAoB,EACpB,qBAAqB,EACrB,GAAG,EACH,QAAQ,EACR,YAAY,EACZ,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,GACV,MAAM,YAAY,CAAC"}

package/dist/onboarding/index.js

@@ -0,0 +1,22 @@
+"use strict";
+// @rocapine/rocalytics-sdk/onboarding: the onboarding run tracker.
+//
+// Reports one run of an onboarding as snapshots in the shape of the onboarding
+// run contract v1 (docs/onboarding-run-contract.md). Headless: no renderer,
+// router or UI dependency, so a hand-coded onboarding uses it as is.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.memoryStorage = exports.createHttpSink = exports.LIBRARY_VERSION = exports.RECORDING_BUDGET = exports.MAX_ENTRIES = exports.onboardingRun = exports.createOnboardingRunTracker = void 0;
+var tracker_1 = require("./tracker");
+Object.defineProperty(exports, "createOnboardingRunTracker", { enumerable: true, get: function () { return tracker_1.createOnboardingRunTracker; } });
+Object.defineProperty(exports, "onboardingRun", { enumerable: true, get: function () { return tracker_1.onboardingRun; } });
+var state_1 = require("./state");
+Object.defineProperty(exports, "MAX_ENTRIES", { enumerable: true, get: function () { return state_1.MAX_ENTRIES; } });
+Object.defineProperty(exports, "RECORDING_BUDGET", { enumerable: true, get: function () { return state_1.RECORDING_BUDGET; } });
+var version_1 = require("../version");
+Object.defineProperty(exports, "LIBRARY_VERSION", { enumerable: true, get: function () { return version_1.LIBRARY_VERSION; } });
+// Transport and environment pieces a host needs to configure the tracker.
+var httpSink_1 = require("../core/httpSink");
+Object.defineProperty(exports, "createHttpSink", { enumerable: true, get: function () { return httpSink_1.createHttpSink; } });
+var storage_1 = require("../core/storage");
+Object.defineProperty(exports, "memoryStorage", { enumerable: true, get: function () { return storage_1.memoryStorage; } });
+//# sourceMappingURL=index.js.map

package/dist/onboarding/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/onboarding/index.ts"],"names":[],"mappings":";AAAA,mEAAmE;AACnE,EAAE;AACF,+EAA+E;AAC/E,4EAA4E;AAC5E,qEAAqE;;;AAErE,qCAAsE;AAA7D,qHAAA,0BAA0B,OAAA;AAAE,wGAAA,aAAa,OAAA;AAGlD,iCAAwD;AAA/C,oGAAA,WAAW,OAAA;AAAE,yGAAA,gBAAgB,OAAA;AACtC,sCAA6C;AAApC,0GAAA,eAAe,OAAA;AAExB,0EAA0E;AAC1E,6CAAkD;AAAzC,0GAAA,cAAc,OAAA;AAEvB,2CAAgD;AAAvC,wGAAA,aAAa,OAAA"}

package/dist/onboarding/input.d.ts

@@ -0,0 +1,102 @@
+import type { Answer, Manifest, OnboardingIdentity, Properties, StudioLinks } from "./contract";
+export interface OnboardingInput {
+    /** A stable key for this flow. Never reused for a different flow. */
+    key: string;
+    /** The flow's revision. Must change whenever the manifest or a question's keys change. */
+    version: string;
+    /** An in-flow variant, for an app running one flow under one key with its own variants. */
+    variantKey?: string | null;
+}
+export interface ManifestInput {
+    /** Every step the flow can show, in flow order. Steps sharing a `slot` are alternatives at one position. */
+    steps: {
+        stepKey: string;
+        slot?: string;
+    }[];
+}
+/**
+ * Studio ids are strings. A number passed at run time (from untyped JSON, for
+ * example) is sent in decimal when it is a safe non-negative integer; any
+ * other number makes the start invalid.
+ */
+export interface StudioInput {
+    /** Null and undefined both mean absent. */
+    onboardingId?: string | null;
+    /** Null and undefined both mean absent; a Studio-served run with none is a draft. */
+    deploymentId?: string | null;
+    audienceId?: string | null;
+    /** A Studio draft or preview: always sent as version `draft`. */
+    draft?: boolean;
+}
+interface StartBase {
+    manifest: ManifestInput;
+    /** Run-level scalar properties for slicing runs. No personal data. */
+    properties?: Properties;
+}
+/**
+ * Starts a run. Either the app declares `onboarding`, or a Studio-served flow
+ * passes `studio.onboardingId` and the identity defaults to the Studio
+ * onboarding id (key) and deployment id (version, `draft` without one).
+ */
+export type StartOptions = (StartBase & {
+    onboarding: OnboardingInput;
+    studio?: StudioInput;
+}) | (StartBase & {
+    onboarding?: undefined;
+    studio: StudioInput & {
+        onboardingId: string;
+    };
+});
+export type AnswerInput = {
+    questionKey: string;
+    kind: "single";
+    value: string;
+} | {
+    questionKey: string;
+    kind: "multi";
+    value: string[];
+} | {
+    questionKey: string;
+    kind: "numeric";
+    value: number;
+    unit?: string;
+} | {
+    questionKey: string;
+    kind: "text";
+    value: string;
+};
+export declare const MAX_MANIFEST_STEPS = 200;
+export declare const MAX_ANSWERS = 50;
+export declare const MAX_PROPERTIES = 20;
+export declare const isKey: (v: unknown) => v is string;
+export interface ValidStart {
+    onboarding: OnboardingIdentity;
+    studio?: StudioLinks;
+    manifest: Manifest;
+    properties?: Properties;
+    /** Problems that were corrected rather than fatal: [code, message]. */
+    warnings: [string, string][];
+}
+export declare function validateStart(options: StartOptions): {
+    ok: true;
+    value: ValidStart;
+} | {
+    ok: false;
+    errors: string[];
+};
+export declare function propertyProblem(key: string, value: unknown): string | null;
+/** `base` with `patch` applied, keeping only valid entries and at most 20 keys. */
+export declare function mergeProperties(base: Properties, patch: unknown): {
+    value: Properties;
+    problems: [string, string][];
+};
+/** One answer in wire form, or the reason it cannot be sent. */
+export declare function toAnswer(input: unknown): {
+    ok: true;
+    answer: Answer;
+} | {
+    ok: false;
+    error: string;
+};
+export {};
+//# sourceMappingURL=input.d.ts.map

package/dist/onboarding/input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/onboarding/input.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,UAAU,EAAiB,WAAW,EAAE,MAAM,YAAY,CAAC;AAE/G,MAAM,WAAW,eAAe;IAC9B,qEAAqE;IACrE,GAAG,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,OAAO,EAAE,MAAM,CAAC;IAChB,2FAA2F;IAC3F,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,4GAA4G;IAC5G,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,qFAAqF;IACrF,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iEAAiE;IACjE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,UAAU,SAAS;IACjB,QAAQ,EAAE,aAAa,CAAC;IACxB,sEAAsE;IACtE,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,CAAC,SAAS,GAAG;IAAE,UAAU,EAAE,eAAe,CAAC;IAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,CAAC,GACnE,CAAC,SAAS,GAAG;IAAE,UAAU,CAAC,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,WAAW,GAAG;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC,CAAC;AAE7F,MAAM,MAAM,WAAW,GACnB;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACtD;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,GACvD;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAMzD,eAAO,MAAM,kBAAkB,MAAM,CAAC;AACtC,eAAO,MAAM,WAAW,KAAK,CAAC;AAC9B,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC,eAAO,MAAM,KAAK,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,MAA8C,CAAC;AAGvF,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,uEAAuE;IACvE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CAC9B;AAKD,wBAAgB,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAoGtH;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAM1E;AAED,mFAAmF;AACnF,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAA;CAAE,CAmBrH;AAED,gEAAgE;AAChE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAiCpG"}

package/dist/onboarding/input.js

@@ -0,0 +1,216 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isKey = exports.MAX_PROPERTIES = exports.MAX_ANSWERS = exports.MAX_MANIFEST_STEPS = void 0;
+exports.validateStart = validateStart;
+exports.propertyProblem = propertyProblem;
+exports.mergeProperties = mergeProperties;
+exports.toAnswer = toAnswer;
+// The tracker's public input types (camelCase, as an app writes them) and their
+// validation against the contract. Anything that would make the ingest reject a
+// snapshot is caught here, so the tracker never sends it.
+const text_1 = require("../core/text");
+const KEY = /^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$/;
+const VERSION = /^[A-Za-z0-9][A-Za-z0-9_.:+-]{0,63}$/;
+const PROPERTY_KEY = /^[a-z][a-z0-9_]{0,39}$/;
+exports.MAX_MANIFEST_STEPS = 200;
+exports.MAX_ANSWERS = 50;
+exports.MAX_PROPERTIES = 20;
+const isKey = (v) => typeof v === "string" && KEY.test(v);
+exports.isKey = isKey;
+const isLink = (v) => typeof v === "string" && (0, text_1.codePointLength)(v) >= 1 && (0, text_1.codePointLength)(v) <= 128;
+/** A Studio id that is a safe non-negative integer, in decimal (contract 3.1); anything else as it is. */
+const decimalId = (v) => (typeof v === "number" && Number.isSafeInteger(v) && v >= 0 ? String(v) : v);
+function validateStart(options) {
+    var _a;
+    const errors = [];
+    const warnings = [];
+    if (!options || typeof options !== "object")
+        return { ok: false, errors: ["start options are not an object"] };
+    // Studio links. Read once, with numeric ids converted, by both the links and the identity below.
+    const studioIn = options.studio && typeof options.studio === "object"
+        ? {
+            ...options.studio,
+            onboardingId: decimalId(options.studio.onboardingId),
+            deploymentId: decimalId(options.studio.deploymentId),
+            audienceId: decimalId(options.studio.audienceId),
+        }
+        : options.studio;
+    let studio;
+    if (studioIn !== undefined) {
+        if (!studioIn || typeof studioIn !== "object")
+            errors.push("studio is not an object");
+        else {
+            studio = {};
+            const links = [
+                ["onboarding_id", studioIn.onboardingId],
+                ["deployment_id", studioIn.deploymentId],
+                ["audience_id", studioIn.audienceId],
+            ];
+            for (const [field, value] of links) {
+                if (value === undefined || value === null)
+                    continue;
+                if (!isLink(value))
+                    errors.push(`studio.${field} must be 1 to 128 characters`);
+                else
+                    studio[field] = value;
+            }
+            if (Object.keys(studio).length === 0)
+                studio = undefined;
+        }
+    }
+    const draft = !!(studioIn === null || studioIn === void 0 ? void 0 : studioIn.draft);
+    // Identity.
+    let onboarding;
+    if (options.onboarding) {
+        const { key, version, variantKey } = options.onboarding;
+        if (!(0, exports.isKey)(key))
+            errors.push("onboarding.key must be 1 to 128 characters from A-Z a-z 0-9 _ . : -");
+        if (!draft && (typeof version !== "string" || !VERSION.test(version))) {
+            errors.push("onboarding.version must be 1 to 64 characters from A-Z a-z 0-9 _ . : + -");
+        }
+        if (draft && version !== "draft")
+            warnings.push(["draft-version", `a Studio draft sends version "draft", not "${version}"`]);
+        onboarding = { key, version: draft ? "draft" : version };
+        if (variantKey !== undefined && variantKey !== null) {
+            // Studio-served means it carries a Studio link (or is a Studio draft), not that a `studio` object was passed.
+            if (studio || draft) {
+                warnings.push(["studio-variant-dropped", "a Studio-served run does not carry variant_key: each Studio arm is its own onboarding key"]);
+            }
+            else if (!(0, exports.isKey)(variantKey))
+                errors.push("onboarding.variantKey must be a key");
+            else
+                onboarding.variant_key = variantKey;
+        }
+    }
+    else if (studioIn && (0, exports.isKey)(studioIn.onboardingId)) {
+        // A null deployment id is absent, as it is for the links above: a Studio-served run with none is a draft (3.1).
+        const deployment = studioIn.deploymentId;
+        const version = draft || deployment === undefined || deployment === null ? "draft" : deployment;
+        if (typeof version !== "string" || !VERSION.test(version)) {
+            errors.push("studio.deploymentId cannot be used as onboarding.version");
+        }
+        else {
+            onboarding = { key: studioIn.onboardingId, version };
+        }
+    }
+    else {
+        errors.push("either onboarding { key, version } or studio.onboardingId is required");
+    }
+    // Manifest.
+    const manifest = { steps: [] };
+    const stepsIn = (_a = options.manifest) === null || _a === void 0 ? void 0 : _a.steps;
+    if (!Array.isArray(stepsIn) || stepsIn.length < 1 || stepsIn.length > exports.MAX_MANIFEST_STEPS) {
+        errors.push(`manifest.steps must hold 1 to ${exports.MAX_MANIFEST_STEPS} steps`);
+    }
+    else {
+        const seen = new Set();
+        const closedSlots = new Set();
+        stepsIn.forEach((s, i) => {
+            var _a;
+            const stepKey = s === null || s === void 0 ? void 0 : s.stepKey;
+            if (!(0, exports.isKey)(stepKey))
+                return void errors.push(`manifest.steps[${i}].stepKey is not a valid key`);
+            if (seen.has(stepKey))
+                errors.push(`manifest step "${stepKey}" is declared twice`);
+            seen.add(stepKey);
+            const slot = s.slot;
+            if (slot !== undefined) {
+                if (!(0, exports.isKey)(slot))
+                    errors.push(`manifest.steps[${i}].slot is not a valid key`);
+                if (closedSlots.has(slot))
+                    errors.push(`slot "${slot}" is not contiguous`);
+                if (((_a = stepsIn[i + 1]) === null || _a === void 0 ? void 0 : _a.slot) !== slot)
+                    closedSlots.add(slot);
+                manifest.steps.push({ step_key: stepKey, slot });
+            }
+            else {
+                manifest.steps.push({ step_key: stepKey });
+            }
+        });
+    }
+    // Properties: invalid ones are dropped, not fatal.
+    let properties;
+    if (options.properties !== undefined) {
+        const { value, problems } = mergeProperties({}, options.properties);
+        problems.forEach((p) => warnings.push(p));
+        if (Object.keys(value).length)
+            properties = value;
+    }
+    if (errors.length || !onboarding)
+        return { ok: false, errors };
+    return { ok: true, value: { onboarding, studio, manifest, properties, warnings } };
+}
+function propertyProblem(key, value) {
+    if (!PROPERTY_KEY.test(key))
+        return `property key "${key}" must match ^[a-z][a-z0-9_]{0,39}$`;
+    if (value === null || typeof value === "boolean")
+        return null;
+    if (typeof value === "number")
+        return Number.isFinite(value) ? null : `property "${key}" is not a finite number`;
+    if (typeof value === "string")
+        return (0, text_1.codePointLength)(value) <= 256 ? null : `property "${key}" is longer than 256 characters`;
+    return `property "${key}" must be a string, number, boolean or null`;
+}
+/** `base` with `patch` applied, keeping only valid entries and at most 20 keys. */
+function mergeProperties(base, patch) {
+    const value = { ...base };
+    const problems = [];
+    if (!patch || typeof patch !== "object" || Array.isArray(patch)) {
+        return { value, problems: [["invalid-property", "properties must be an object"]] };
+    }
+    for (const [k, v] of Object.entries(patch)) {
+        const problem = propertyProblem(k, v);
+        if (problem) {
+            problems.push(["invalid-property", problem]);
+            continue;
+        }
+        if (!Object.prototype.hasOwnProperty.call(value, k) && Object.keys(value).length >= exports.MAX_PROPERTIES) {
+            problems.push(["too-many-properties", `property "${k}" dropped: at most ${exports.MAX_PROPERTIES}`]);
+            continue;
+        }
+        value[k] = v;
+    }
+    return { value, problems };
+}
+/** One answer in wire form, or the reason it cannot be sent. */
+function toAnswer(input) {
+    if (!input || typeof input !== "object")
+        return { ok: false, error: "an answer must be an object" };
+    const a = input;
+    const q = a.questionKey;
+    if (!(0, exports.isKey)(q))
+        return { ok: false, error: "questionKey is not a valid key" };
+    switch (a.kind) {
+        case "single":
+            return (0, exports.isKey)(a.value)
+                ? { ok: true, answer: { question_key: q, kind: "single", value: a.value } }
+                : { ok: false, error: `${q}: a single answer's value must be an option key` };
+        case "multi": {
+            if (!Array.isArray(a.value) || !a.value.every(exports.isKey))
+                return { ok: false, error: `${q}: a multi answer's value must be option keys` };
+            const unique = [...new Set(a.value)];
+            if (unique.length > exports.MAX_ANSWERS)
+                return { ok: false, error: `${q}: at most ${exports.MAX_ANSWERS} options` };
+            return { ok: true, answer: { question_key: q, kind: "multi", value: unique } };
+        }
+        case "numeric": {
+            if (typeof a.value !== "number" || !Number.isFinite(a.value))
+                return { ok: false, error: `${q}: a numeric answer must be a finite number` };
+            if (a.unit !== undefined && !(0, exports.isKey)(a.unit))
+                return { ok: false, error: `${q}: unit must be a key` };
+            return {
+                ok: true,
+                answer: a.unit === undefined
+                    ? { question_key: q, kind: "numeric", value: a.value }
+                    : { question_key: q, kind: "numeric", value: a.value, unit: a.unit },
+            };
+        }
+        case "text":
+            return typeof a.value === "string" && (0, text_1.codePointLength)(a.value) <= 1000
+                ? { ok: true, answer: { question_key: q, kind: "text", value: a.value } }
+                : { ok: false, error: `${q}: a text answer is at most 1,000 characters` };
+        default:
+            return { ok: false, error: `${q}: unknown answer kind ${JSON.stringify(a.kind)}` };
+    }
+}
+//# sourceMappingURL=input.js.map

package/dist/onboarding/input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"input.js","sourceRoot":"","sources":["../../src/onboarding/input.ts"],"names":[],"mappings":";;;AA+EA,sCAoGC;AAED,0CAMC;AAGD,0CAmBC;AAGD,4BAiCC;AArPD,gFAAgF;AAChF,gFAAgF;AAChF,0DAA0D;AAC1D,uCAA+C;AAqD/C,MAAM,GAAG,GAAG,qCAAqC,CAAC;AAClD,MAAM,OAAO,GAAG,qCAAqC,CAAC;AACtD,MAAM,YAAY,GAAG,wBAAwB,CAAC;AAEjC,QAAA,kBAAkB,GAAG,GAAG,CAAC;AACzB,QAAA,WAAW,GAAG,EAAE,CAAC;AACjB,QAAA,cAAc,GAAG,EAAE,CAAC;AAE1B,MAAM,KAAK,GAAG,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAA1E,QAAA,KAAK,SAAqE;AACvF,MAAM,MAAM,GAAG,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAA,sBAAe,EAAC,CAAC,CAAC,IAAI,CAAC,IAAI,IAAA,sBAAe,EAAC,CAAC,CAAC,IAAI,GAAG,CAAC;AAW1H,0GAA0G;AAC1G,MAAM,SAAS,GAAG,CAAC,CAAU,EAAW,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAExH,SAAgB,aAAa,CAAC,OAAqB;;IACjD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAuB,EAAE,CAAC;IACxC,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,iCAAiC,CAAC,EAAE,CAAC;IAE/G,iGAAiG;IACjG,MAAM,QAAQ,GACZ,OAAO,CAAC,MAAM,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ;QAClD,CAAC,CAAC;YACE,GAAG,OAAO,CAAC,MAAM;YACjB,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAA8B;YACjF,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAA8B;YACjF,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAA8B;SAC9E;QACH,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACrB,IAAI,MAA+B,CAAC;IACpC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;aACjF,CAAC;YACJ,MAAM,GAAG,EAAE,CAAC;YACZ,MAAM,KAAK,GAAmC;gBAC5C,CAAC,eAAe,EAAE,QAAQ,CAAC,YAAY,CAAC;gBACxC,CAAC,eAAe,EAAE,QAAQ,CAAC,YAAY,CAAC;gBACxC,CAAC,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC;aACrC,CAAC;YACF,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;gBACnC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;oBAAE,SAAS;gBACpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;oBAAE,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,8BAA8B,CAAC,CAAC;;oBAC1E,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YAC7B,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM,GAAG,SAAS,CAAC;QAC3D,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,CAAA,CAAC;IAEhC,YAAY;IACZ,IAAI,UAA0C,CAAC;IAC/C,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;QACxD,IAAI,CAAC,IAAA,aAAK,EAAC,GAAG,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,qEAAqE,CAAC,CAAC;QACpG,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YACtE,MAAM,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,KAAK,IAAI,OAAO,KAAK,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,8CAA8C,OAAO,GAAG,CAAC,CAAC,CAAC;QAC7H,UAAU,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACzD,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACpD,8GAA8G;YAC9G,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,CAAC,wBAAwB,EAAE,2FAA2F,CAAC,CAAC,CAAC;YACzI,CAAC;iBAAM,IAAI,CAAC,IAAA,aAAK,EAAC,UAAU,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;;gBAC7E,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC;QAC3C,CAAC;IACH,CAAC;SAAM,IAAI,QAAQ,IAAI,IAAA,aAAK,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QACpD,gHAAgH;QAChH,MAAM,UAAU,GAAY,QAAQ,CAAC,YAAY,CAAC;QAClD,MAAM,OAAO,GAAG,KAAK,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC;QAChG,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1D,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC;QACvD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,IAAI,CAAC,uEAAuE,CAAC,CAAC;IACvF,CAAC;IAED,YAAY;IACZ,MAAM,QAAQ,GAAa,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACzC,MAAM,OAAO,GAAG,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,CAAC;IACxC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,0BAAkB,EAAE,CAAC;QACzF,MAAM,CAAC,IAAI,CAAC,iCAAiC,0BAAkB,QAAQ,CAAC,CAAC;IAC3E,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;QACtC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;;YACvB,MAAM,OAAO,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,CAAC;YAC3B,IAAI,CAAC,IAAA,aAAK,EAAC,OAAO,CAAC;gBAAE,OAAO,KAAK,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,8BAA8B,CAAC,CAAC;YAChG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,kBAAkB,OAAO,qBAAqB,CAAC,CAAC;YACnF,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAClB,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;YACpB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC;oBAAE,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;gBAC9E,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC;oBAAE,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,qBAAqB,CAAC,CAAC;gBAC3E,IAAI,CAAA,MAAA,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,0CAAE,IAAI,MAAK,IAAI;oBAAE,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACzD,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mDAAmD;IACnD,IAAI,UAAkC,CAAC;IACvC,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACpE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM;YAAE,UAAU,GAAG,KAAK,CAAC;IACpD,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,UAAU;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC/D,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,CAAC;AACrF,CAAC;AAED,SAAgB,eAAe,CAAC,GAAW,EAAE,KAAc;IACzD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,iBAAiB,GAAG,qCAAqC,CAAC;IAC9F,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC9D,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,GAAG,0BAA0B,CAAC;IACjH,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAA,sBAAe,EAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,GAAG,iCAAiC,CAAC;IAC/H,OAAO,aAAa,GAAG,6CAA6C,CAAC;AACvE,CAAC;AAED,mFAAmF;AACnF,SAAgB,eAAe,CAAC,IAAgB,EAAE,KAAc;IAC9D,MAAM,KAAK,GAAe,EAAE,GAAG,IAAI,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAuB,EAAE,CAAC;IACxC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,kBAAkB,EAAE,8BAA8B,CAAC,CAAC,EAAE,CAAC;IACrF,CAAC;IACD,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;QACtE,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACtC,IAAI,OAAO,EAAE,CAAC;YACZ,QAAQ,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC,CAAC;YAC7C,SAAS;QACX,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,sBAAc,EAAE,CAAC;YACnG,QAAQ,CAAC,IAAI,CAAC,CAAC,qBAAqB,EAAE,aAAa,CAAC,sBAAsB,sBAAc,EAAE,CAAC,CAAC,CAAC;YAC7F,SAAS;QACX,CAAC;QACD,KAAK,CAAC,CAAC,CAAC,GAAG,CAAkB,CAAC;IAChC,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC7B,CAAC;AAED,gEAAgE;AAChE,SAAgB,QAAQ,CAAC,KAAc;IACrC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,6BAA6B,EAAE,CAAC;IACpG,MAAM,CAAC,GAAG,KAAgC,CAAC;IAC3C,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC;IACxB,IAAI,CAAC,IAAA,aAAK,EAAC,CAAC,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,gCAAgC,EAAE,CAAC;IAC7E,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAA,aAAK,EAAC,CAAC,CAAC,KAAK,CAAC;gBACnB,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC3E,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,iDAAiD,EAAE,CAAC;QAClF,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,aAAK,CAAC;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,8CAA8C,EAAE,CAAC;YACtI,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,KAAiB,CAAC,CAAC,CAAC;YACjD,IAAI,MAAM,CAAC,MAAM,GAAG,mBAAW;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,aAAa,mBAAW,UAAU,EAAE,CAAC;YACrG,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC;QACjF,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,4CAA4C,EAAE,CAAC;YAC5I,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,IAAA,aAAK,EAAC,CAAC,CAAC,IAAI,CAAC;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,sBAAsB,EAAE,CAAC;YACpG,OAAO;gBACL,EAAE,EAAE,IAAI;gBACR,MAAM,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS;oBAC1B,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE;oBACtD,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAc,EAAE;aACjF,CAAC;QACJ,CAAC;QACD,KAAK,MAAM;YACT,OAAO,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAA,sBAAe,EAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI;gBACpE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,6CAA6C,EAAE,CAAC;QAC9E;YACE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,yBAAyB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IACvF,CAAC;AACH,CAAC"}

package/dist/onboarding/persisted.d.ts

@@ -0,0 +1,20 @@
+import type { Outbound } from "../core/delivery";
+import type { OnboardingRunSnapshot } from "./contract";
+import type { RunState } from "./state";
+export interface Persisted {
+    format: 1;
+    /** The destination of the sink of the tracker that wrote it; absent when that sink had none. */
+    destination?: string;
+    current: RunState | null;
+    outboxes: Record<string, Outbound<OnboardingRunSnapshot>>;
+}
+export declare function isRunState(v: unknown): v is RunState;
+/** An unsent snapshot of run `runId`: a positive seq and a body that is that run's snapshot at that seq. */
+export declare function isOutbound(runId: string, v: unknown): v is Outbound<OnboardingRunSnapshot>;
+/** The usable parts of a stored value, and what was dropped. */
+export declare function parsePersisted(raw: unknown): {
+    current: RunState | null;
+    outboxes: [string, Outbound<OnboardingRunSnapshot>][];
+    problems: string[];
+};
+//# sourceMappingURL=persisted.d.ts.map

package/dist/onboarding/persisted.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persisted.d.ts","sourceRoot":"","sources":["../../src/onboarding/persisted.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,CAAC,CAAC;IACV,gGAAgG;IAChG,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC;CAC3D;AAkBD,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,QAAQ,CAoBpD;AAED,4GAA4G;AAC5G,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,QAAQ,CAAC,qBAAqB,CAAC,CAU1F;AAED,gEAAgE;AAChE,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG;IAC5C,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;IACtD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAoBA"}

package/dist/onboarding/persisted.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRunState = isRunState;
+exports.isOutbound = isOutbound;
+exports.parsePersisted = parsePersisted;
+const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
+const TIMESTAMP = /^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$/;
+const isObj = (v) => !!v && typeof v === "object" && !Array.isArray(v);
+const isTimestamp = (v) => typeof v === "string" && TIMESTAMP.test(v);
+const isSeq = (v) => typeof v === "number" && Number.isInteger(v) && v >= 1;
+const isEntry = (e) => isObj(e) &&
+    typeof e.step_key === "string" &&
+    isTimestamp(e.entered_at) &&
+    (e.exited_at === null || isTimestamp(e.exited_at)) &&
+    Array.isArray(e.answers) &&
+    e.answers.every(isObj);
+function isRunState(v) {
+    if (!isObj(v))
+        return false;
+    const { onboarding, context, manifest } = v;
+    return (typeof v.runId === "string" && UUID.test(v.runId) &&
+        typeof v.lastSeq === "number" && Number.isInteger(v.lastSeq) && v.lastSeq >= 0 &&
+        isObj(onboarding) && typeof onboarding.key === "string" && typeof onboarding.version === "string" &&
+        isObj(context) &&
+        isObj(manifest) && Array.isArray(manifest.steps) && manifest.steps.length > 0 &&
+        manifest.steps.every((s) => isObj(s) && typeof s.step_key === "string") &&
+        Array.isArray(v.steps) && v.steps.every(isEntry) &&
+        (v.studio === undefined || isObj(v.studio)) &&
+        (v.properties === undefined || isObj(v.properties)) &&
+        typeof v.provisionalExit === "boolean" &&
+        typeof v.truncated === "boolean" &&
+        (v.status === "in_progress" || v.status === "completed") &&
+        (v.completedAt === null || isTimestamp(v.completedAt)) &&
+        typeof v.lastActiveAt === "number" && Number.isFinite(v.lastActiveAt) &&
+        (v.dirty === undefined || typeof v.dirty === "boolean"));
+}
+/** An unsent snapshot of run `runId`: a positive seq and a body that is that run's snapshot at that seq. */
+function isOutbound(runId, v) {
+    if (!isObj(v) || !isSeq(v.seq) || !isObj(v.body))
+        return false;
+    const b = v.body;
+    return (b.run_id === runId &&
+        b.seq === v.seq &&
+        (b.status === "in_progress" || b.status === "completed") &&
+        Array.isArray(b.steps) && b.steps.length > 0 &&
+        isObj(b.manifest) && isObj(b.onboarding) && isObj(b.context));
+}
+/** The usable parts of a stored value, and what was dropped. */
+function parsePersisted(raw) {
+    const problems = [];
+    if (!isObj(raw) || raw.format !== 1) {
+        return { current: null, outboxes: [], problems: ["unrecognised stored state"] };
+    }
+    let current = null;
+    if (raw.current !== null && raw.current !== undefined) {
+        if (isRunState(raw.current))
+            current = raw.current;
+        else
+            problems.push("the stored run is malformed");
+    }
+    const outboxes = [];
+    if (isObj(raw.outboxes)) {
+        for (const [runId, item] of Object.entries(raw.outboxes)) {
+            if (isOutbound(runId, item))
+                outboxes.push([runId, item]);
+            else
+                problems.push(`the stored snapshot of run "${runId}" is malformed`);
+        }
+    }
+    else if (raw.outboxes !== undefined) {
+        problems.push("the stored snapshots are malformed");
+    }
+    return { current, outboxes, problems };
+}
+//# sourceMappingURL=persisted.js.map