@opendoor/partner-sdk-client-js-core 1.0.6-beta.55.1 → 1.0.7-beta.56.1

package/dist/internal/questionnaire/engine.d.ts

@@ -0,0 +1,95 @@
+/**
+ * DtcOnboardingEngine — framework-agnostic state machine for the
+ * DTC onboarding questionnaire flow.
+ *
+ * The engine manages answers, navigation (with page skipping for conditional
+ * pages), validation, and event emission. Framework wrappers (React, Vue)
+ * subscribe to events and mirror state into their reactive systems.
+ *
+ * Navigation is tracked by **page ID**, not index. This ensures correct
+ * behavior when answers change page visibility mid-flow.
+ */
+import type { AnswerValue, EngineEvent, PageConfig, QuestionConfig, ValidationResult } from './types.js';
+export interface DtcOnboardingOptions {
+    /** Market identifier for market-dependent questions (e.g., eligibility criteria). */
+    market?: string;
+    /** Pre-filled answers (e.g., from address lookup or prior session). */
+    initialAnswers?: Record<string, AnswerValue>;
+}
+export declare class DtcOnboardingEngine {
+    private _allPages;
+    private _answers;
+    private _currentPageId;
+    private _validationErrors;
+    private _submitted;
+    private _listeners;
+    private _market;
+    constructor(pages: PageConfig[], options?: DtcOnboardingOptions);
+    /** Pages visible given current answers (filtered by showWhen conditions). */
+    get visiblePages(): PageConfig[];
+    /** The current page, or undefined if no pages are visible. */
+    get currentPage(): PageConfig | undefined;
+    /** Index of the current page within visible pages. */
+    get currentPageIndex(): number;
+    /** Progress as a fraction (0 to 1). 0 on first page, 1 on last page. */
+    get progress(): number;
+    get isFirstPage(): boolean;
+    get isLastPage(): boolean;
+    /** Whether the engine has already emitted a submit event. */
+    get submitted(): boolean;
+    get answers(): Readonly<Record<string, AnswerValue>>;
+    get validationErrors(): Readonly<Record<string, string>>;
+    get market(): string | undefined;
+    /**
+     * Get a single answer value. Arrow function so it can be passed directly
+     * to evaluateCondition without binding.
+     */
+    getAnswer: (key: string) => AnswerValue;
+    /**
+     * Set an answer value. Clears any validation error for that field.
+     */
+    setAnswer(key: string, value: AnswerValue): void;
+    /**
+     * Set multiple answers at once (e.g., for initial data prefill).
+     * Emits a single answerChange event for the last key.
+     */
+    setAnswers(answers: Record<string, AnswerValue>): void;
+    /**
+     * Validate current page and advance to the next visible page.
+     * If on the last page, emits 'submit' instead of advancing.
+     * No-ops if the engine has already submitted.
+     * Returns validation result (callers can check errors).
+     */
+    goToNext(): ValidationResult;
+    /**
+     * Navigate to the previous visible page. No validation on backward navigation.
+     */
+    goToPrev(): void;
+    /**
+     * Jump to a specific page index (within visible pages).
+     */
+    goToPage(index: number): void;
+    /**
+     * Validate the current page without advancing.
+     */
+    validate(): ValidationResult;
+    /**
+     * Get visible questions on the current page (filtered by showWhen).
+     */
+    getVisibleQuestionsForCurrentPage(): QuestionConfig[];
+    /**
+     * Subscribe to an engine event. Returns an unsubscribe function.
+     */
+    on(eventType: EngineEvent['type'], handler: (event: EngineEvent) => void): () => void;
+    /**
+     * Remove all listeners and clean up. Call on component unmount.
+     */
+    destroy(): void;
+    private emit;
+    /**
+     * If the current page became hidden (answer change removed it from visible pages),
+     * auto-correct to the nearest visible page. Emits pageChange if corrected.
+     */
+    private recoverIfCurrentPageHidden;
+}
+//# sourceMappingURL=engine.d.ts.map

package/dist/internal/questionnaire/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../../src/internal/questionnaire/engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,UAAU,EACV,cAAc,EACd,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAOpB,MAAM,WAAW,oBAAoB;IACnC,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CAC9C;AAED,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,iBAAiB,CAA8B;IACvD,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,UAAU,CAGd;IACJ,OAAO,CAAC,OAAO,CAAqB;gBAExB,KAAK,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,oBAAoB;IAa/D,6EAA6E;IAC7E,IAAI,YAAY,IAAI,UAAU,EAAE,CAE/B;IAED,8DAA8D;IAC9D,IAAI,WAAW,IAAI,UAAU,GAAG,SAAS,CAExC;IAED,sDAAsD;IACtD,IAAI,gBAAgB,IAAI,MAAM,CAK7B;IAED,wEAAwE;IACxE,IAAI,QAAQ,IAAI,MAAM,CAKrB;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,UAAU,IAAI,OAAO,CAGxB;IAED,6DAA6D;IAC7D,IAAI,SAAS,IAAI,OAAO,CAEvB;IAID,IAAI,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAEnD;IAED,IAAI,gBAAgB,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAEvD;IAED,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;;OAGG;IACH,SAAS,GAAI,KAAK,MAAM,KAAG,WAAW,CAEpC;IAIF;;OAEG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,IAAI;IAahD;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,IAAI;IAsBtD;;;;;OAKG;IACH,QAAQ,IAAI,gBAAgB;IA0C5B;;OAEG;IACH,QAAQ,IAAI,IAAI;IAehB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAc7B;;OAEG;IACH,QAAQ,IAAI,gBAAgB;IAQ5B;;OAEG;IACH,iCAAiC,IAAI,cAAc,EAAE;IAQrD;;OAEG;IACH,EAAE,CACA,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,EAC9B,OAAO,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GACpC,MAAM,IAAI;IAWb;;OAEG;IACH,OAAO,IAAI,IAAI;IAMf,OAAO,CAAC,IAAI;IASZ;;;OAGG;IACH,OAAO,CAAC,0BAA0B;CAwBnC"}

package/dist/internal/questionnaire/engine.js

@@ -0,0 +1,260 @@
+/**
+ * DtcOnboardingEngine — framework-agnostic state machine for the
+ * DTC onboarding questionnaire flow.
+ *
+ * The engine manages answers, navigation (with page skipping for conditional
+ * pages), validation, and event emission. Framework wrappers (React, Vue)
+ * subscribe to events and mirror state into their reactive systems.
+ *
+ * Navigation is tracked by **page ID**, not index. This ensures correct
+ * behavior when answers change page visibility mid-flow.
+ */
+import { getVisiblePages, getVisibleQuestions, validatePage, } from './formLogic.js';
+export class DtcOnboardingEngine {
+    constructor(pages, options) {
+        this._validationErrors = {};
+        this._submitted = false;
+        this._listeners = new Map();
+        /**
+         * Get a single answer value. Arrow function so it can be passed directly
+         * to evaluateCondition without binding.
+         */
+        this.getAnswer = (key) => {
+            return this._answers[key];
+        };
+        this._allPages = pages;
+        this._answers = options?.initialAnswers
+            ? { ...options.initialAnswers }
+            : {};
+        this._market = options?.market;
+        // Initialize to first visible page
+        const visible = this.visiblePages;
+        this._currentPageId = visible.length > 0 ? visible[0].id : '';
+    }
+    // ── Derived state (recomputed on access) ──────────────────────────────────
+    /** Pages visible given current answers (filtered by showWhen conditions). */
+    get visiblePages() {
+        return getVisiblePages(this._allPages, this.getAnswer);
+    }
+    /** The current page, or undefined if no pages are visible. */
+    get currentPage() {
+        return this.visiblePages.find((p) => p.id === this._currentPageId);
+    }
+    /** Index of the current page within visible pages. */
+    get currentPageIndex() {
+        const idx = this.visiblePages.findIndex((p) => p.id === this._currentPageId);
+        return idx >= 0 ? idx : 0;
+    }
+    /** Progress as a fraction (0 to 1). 0 on first page, 1 on last page. */
+    get progress() {
+        const pages = this.visiblePages;
+        if (pages.length <= 1)
+            return 0;
+        const idx = this.currentPageIndex;
+        return Math.min(1, Math.max(0, idx / (pages.length - 1)));
+    }
+    get isFirstPage() {
+        return this.currentPageIndex === 0;
+    }
+    get isLastPage() {
+        const pages = this.visiblePages;
+        return pages.length > 0 && this.currentPageIndex === pages.length - 1;
+    }
+    /** Whether the engine has already emitted a submit event. */
+    get submitted() {
+        return this._submitted;
+    }
+    // ── State accessors ───────────────────────────────────────────────────────
+    get answers() {
+        return { ...this._answers };
+    }
+    get validationErrors() {
+        return { ...this._validationErrors };
+    }
+    get market() {
+        return this._market;
+    }
+    // ── Actions ───────────────────────────────────────────────────────────────
+    /**
+     * Set an answer value. Clears any validation error for that field.
+     */
+    setAnswer(key, value) {
+        this._answers = { ...this._answers, [key]: value };
+        // Clear validation error for this field
+        if (this._validationErrors[key]) {
+            const { [key]: _, ...rest } = this._validationErrors;
+            this._validationErrors = rest;
+        }
+        this.emit({ type: 'answerChange', key, value });
+        this.recoverIfCurrentPageHidden();
+    }
+    /**
+     * Set multiple answers at once (e.g., for initial data prefill).
+     * Emits a single answerChange event for the last key.
+     */
+    setAnswers(answers) {
+        this._answers = { ...this._answers, ...answers };
+        // Clear validation errors for all set keys
+        for (const key of Object.keys(answers)) {
+            if (this._validationErrors[key]) {
+                const { [key]: _, ...rest } = this._validationErrors;
+                this._validationErrors = rest;
+            }
+        }
+        // Emit for the batch — listeners should read engine.answers for full state
+        const keys = Object.keys(answers);
+        if (keys.length > 0) {
+            const lastKey = keys[keys.length - 1];
+            this.emit({
+                type: 'answerChange',
+                key: lastKey,
+                value: answers[lastKey],
+            });
+        }
+        this.recoverIfCurrentPageHidden();
+    }
+    /**
+     * Validate current page and advance to the next visible page.
+     * If on the last page, emits 'submit' instead of advancing.
+     * No-ops if the engine has already submitted.
+     * Returns validation result (callers can check errors).
+     */
+    goToNext() {
+        if (this._submitted) {
+            return { valid: true, errors: {} };
+        }
+        const page = this.currentPage;
+        if (!page) {
+            return { valid: false, errors: { _page: 'No current page' } };
+        }
+        const result = validatePage(page, this.getAnswer);
+        if (!result.valid) {
+            this._validationErrors = result.errors;
+            this.emit({ type: 'validationError', errors: result.errors });
+            return result;
+        }
+        // Clear errors on successful validation
+        this._validationErrors = {};
+        if (this.isLastPage) {
+            this._submitted = true;
+            this.emit({ type: 'submit', answers: { ...this._answers } });
+            return result;
+        }
+        // Advance to next visible page by finding current position and moving forward
+        const visible = this.visiblePages;
+        const currentIdx = visible.findIndex((p) => p.id === this._currentPageId);
+        if (currentIdx >= 0 && currentIdx < visible.length - 1) {
+            this._currentPageId = visible[currentIdx + 1].id;
+        }
+        this.emit({
+            type: 'pageChange',
+            pageIndex: this.currentPageIndex,
+            pageId: this._currentPageId,
+        });
+        return result;
+    }
+    /**
+     * Navigate to the previous visible page. No validation on backward navigation.
+     */
+    goToPrev() {
+        const visible = this.visiblePages;
+        const currentIdx = visible.findIndex((p) => p.id === this._currentPageId);
+        if (currentIdx > 0) {
+            this._currentPageId = visible[currentIdx - 1].id;
+            this._validationErrors = {};
+            this.emit({
+                type: 'pageChange',
+                pageIndex: this.currentPageIndex,
+                pageId: this._currentPageId,
+            });
+        }
+    }
+    /**
+     * Jump to a specific page index (within visible pages).
+     */
+    goToPage(index) {
+        const visible = this.visiblePages;
+        if (index >= 0 && index < visible.length) {
+            this._currentPageId = visible[index].id;
+            this._validationErrors = {};
+            this.emit({
+                type: 'pageChange',
+                pageIndex: index,
+                pageId: this._currentPageId,
+            });
+        }
+    }
+    /**
+     * Validate the current page without advancing.
+     */
+    validate() {
+        const page = this.currentPage;
+        if (!page) {
+            return { valid: false, errors: { _page: 'No current page' } };
+        }
+        return validatePage(page, this.getAnswer);
+    }
+    /**
+     * Get visible questions on the current page (filtered by showWhen).
+     */
+    getVisibleQuestionsForCurrentPage() {
+        const page = this.currentPage;
+        if (!page)
+            return [];
+        return getVisibleQuestions(page, this.getAnswer);
+    }
+    // ── Events ────────────────────────────────────────────────────────────────
+    /**
+     * Subscribe to an engine event. Returns an unsubscribe function.
+     */
+    on(eventType, handler) {
+        if (!this._listeners.has(eventType)) {
+            this._listeners.set(eventType, new Set());
+        }
+        this._listeners.get(eventType).add(handler);
+        return () => {
+            this._listeners.get(eventType)?.delete(handler);
+        };
+    }
+    /**
+     * Remove all listeners and clean up. Call on component unmount.
+     */
+    destroy() {
+        this._listeners.clear();
+    }
+    // ── Private ───────────────────────────────────────────────────────────────
+    emit(event) {
+        const handlers = this._listeners.get(event.type);
+        if (handlers) {
+            for (const handler of handlers) {
+                handler(event);
+            }
+        }
+    }
+    /**
+     * If the current page became hidden (answer change removed it from visible pages),
+     * auto-correct to the nearest visible page. Emits pageChange if corrected.
+     */
+    recoverIfCurrentPageHidden() {
+        const visible = this.visiblePages;
+        if (visible.length === 0)
+            return;
+        // If current page is still visible, nothing to do
+        if (visible.some((p) => p.id === this._currentPageId))
+            return;
+        // Find the closest visible page (prefer staying near the same position)
+        const oldIdx = this._allPages.findIndex((p) => p.id === this._currentPageId);
+        let bestPage = visible[0];
+        for (const page of visible) {
+            const pageIdx = this._allPages.findIndex((p) => p.id === page.id);
+            if (pageIdx <= oldIdx)
+                bestPage = page;
+        }
+        this._currentPageId = bestPage.id;
+        this.emit({
+            type: 'pageChange',
+            pageIndex: this.currentPageIndex,
+            pageId: this._currentPageId,
+        });
+    }
+}

package/dist/internal/questionnaire/flows/dtcOnboarding.d.ts

@@ -0,0 +1,12 @@
+/**
+ * DTC Onboarding Flow — 17-page questionnaire definition.
+ *
+ * Page order matches the Figma design with additions from the DTC production flow.
+ * Answer keys follow reception-fe conventions (dot-notation matching answerKeyMapping.ts).
+ *
+ * Images are referenced by imageId strings. The framework layer (React/Vue) provides
+ * an image manifest that resolves imageIds to bundler-resolved URLs.
+ */
+import type { PageConfig } from '../types.js';
+export declare const dtcOnboardingPages: PageConfig[];
+//# sourceMappingURL=dtcOnboarding.d.ts.map

package/dist/internal/questionnaire/flows/dtcOnboarding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dtcOnboarding.d.ts","sourceRoot":"","sources":["../../../../src/internal/questionnaire/flows/dtcOnboarding.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AA+qB9C,eAAO,MAAM,kBAAkB,EAAE,UAAU,EAkB1C,CAAC"}