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

package/dist/internal/questionnaire/formLogic.js

@@ -0,0 +1,122 @@
+/**
+ * Framework-agnostic form logic for the questionnaire engine.
+ *
+ * Handles condition evaluation, field validation, and page visibility.
+ */
+import { isFieldCondition, isAndCondition, isOrCondition } from './types.js';
+// ── Condition evaluation ──────────────────────────────────────────────────────
+/**
+ * Recursively evaluates a Condition tree against the current answers.
+ */
+export function evaluateCondition(condition, getAnswer) {
+    if (isAndCondition(condition)) {
+        return condition.and.every((c) => evaluateCondition(c, getAnswer));
+    }
+    if (isOrCondition(condition)) {
+        return condition.or.some((c) => evaluateCondition(c, getAnswer));
+    }
+    if (isFieldCondition(condition)) {
+        const answer = getAnswer(condition.field);
+        switch (condition.op) {
+            case 'eq':
+                return answer === condition.value;
+            case 'neq':
+                return answer !== condition.value;
+            case 'exists':
+                return answer !== undefined && answer !== null && answer !== '';
+            case 'notExists':
+                return answer === undefined || answer === null || answer === '';
+            case 'in': {
+                if (!Array.isArray(condition.value))
+                    return false;
+                return condition.value.includes(answer);
+            }
+            case 'notIn': {
+                if (!Array.isArray(condition.value))
+                    return true;
+                return !condition.value.includes(answer);
+            }
+            case 'contains': {
+                if (!Array.isArray(answer))
+                    return false;
+                return answer.includes(condition.value);
+            }
+            default:
+                return false;
+        }
+    }
+    return false;
+}
+// ── Question visibility ───────────────────────────────────────────────────────
+/**
+ * Returns the visible questions on a page, filtering out those whose
+ * showWhen condition evaluates to false.
+ */
+export function getVisibleQuestions(page, getAnswer) {
+    return page.questions.filter((q) => !q.showWhen || evaluateCondition(q.showWhen, getAnswer));
+}
+// ── Page visibility ───────────────────────────────────────────────────────────
+/**
+ * Returns the visible pages, filtering out those whose showWhen condition
+ * evaluates to false given current answers.
+ */
+export function getVisiblePages(pages, getAnswer) {
+    return pages.filter((page) => !page.showWhen || evaluateCondition(page.showWhen, getAnswer));
+}
+// ── Field validation ──────────────────────────────────────────────────────────
+/**
+ * Validates a single field. Returns an error message or undefined.
+ */
+export function validateField(question, value) {
+    const isBlankString = typeof value === 'string' && value.trim() === '';
+    // Required check
+    if (question.required) {
+        if (value === undefined ||
+            value === null ||
+            value === '' ||
+            isBlankString) {
+            return 'This field is required';
+        }
+        if (Array.isArray(value) && value.length === 0) {
+            return 'Please select at least one option';
+        }
+    }
+    // Skip further validation if empty and not required
+    if (value === undefined || value === null || value === '' || isBlankString) {
+        return undefined;
+    }
+    // Number range checks
+    if (question.type === 'number' && typeof value === 'number') {
+        if (question.min !== undefined && value < question.min) {
+            return `Must be at least ${question.min}`;
+        }
+        if (question.max !== undefined && value > question.max) {
+            return `Must be at most ${question.max}`;
+        }
+    }
+    // Custom validator
+    if (question.validate) {
+        return question.validate(value);
+    }
+    return undefined;
+}
+// ── Page validation ───────────────────────────────────────────────────────────
+/**
+ * Validates all visible questions on a page.
+ * Returns a ValidationResult with field-level errors.
+ */
+export function validatePage(page, getAnswer) {
+    const errors = {};
+    const visible = getVisibleQuestions(page, getAnswer);
+    for (const question of visible) {
+        const value = getAnswer(question.key);
+        const error = validateField(question, value);
+        if (error) {
+            errors[question.key] = error;
+        }
+    }
+    return {
+        valid: Object.keys(errors).length === 0,
+        errors,
+    };
+}

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

@@ -0,0 +1,21 @@
+/**
+ * Internal questionnaire engine for DTC Onboarding Flow.
+ *
+ * This module is NOT part of the public API. It is consumed by
+ * client-react and client-vue framework wrappers.
+ *
+ * Import via: '@opendoor/partner-sdk-client-js-core/internal/questionnaire'
+ */
+export type { AnswerValue, Condition, FieldCondition, AndCondition, OrCondition, OptionConfig, QuestionConfig, QuestionStyle, PageConfig, EngineEvent, ValidationResult, } from './types.js';
+export { isFieldCondition, isAndCondition, isOrCondition } from './types.js';
+export { evaluateCondition, getVisibleQuestions, getVisiblePages, validateField, validatePage, } from './formLogic.js';
+export { DtcOnboardingEngine } from './engine.js';
+export type { DtcOnboardingOptions } from './engine.js';
+export { dtcOnboardingPages } from './flows/dtcOnboarding.js';
+import { DtcOnboardingEngine } from './engine.js';
+import type { DtcOnboardingOptions } from './engine.js';
+/**
+ * Create a DTC Onboarding engine instance with the default 17-page flow.
+ */
+export declare function createDtcOnboardingFlow(options?: DtcOnboardingOptions): DtcOnboardingEngine;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/internal/questionnaire/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,YAAY,EACV,WAAW,EACX,SAAS,EACT,cAAc,EACd,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,aAAa,EACb,UAAU,EACV,WAAW,EACX,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG7E,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,YAAY,GACb,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,YAAY,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAI9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGxD;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,CAAC,EAAE,oBAAoB,GAC7B,mBAAmB,CAErB"}

package/dist/internal/questionnaire/index.js

@@ -0,0 +1,24 @@
+/**
+ * Internal questionnaire engine for DTC Onboarding Flow.
+ *
+ * This module is NOT part of the public API. It is consumed by
+ * client-react and client-vue framework wrappers.
+ *
+ * Import via: '@opendoor/partner-sdk-client-js-core/internal/questionnaire'
+ */
+export { isFieldCondition, isAndCondition, isOrCondition } from './types.js';
+// Form logic
+export { evaluateCondition, getVisibleQuestions, getVisiblePages, validateField, validatePage, } from './formLogic.js';
+// Engine
+export { DtcOnboardingEngine } from './engine.js';
+// Flow definitions
+export { dtcOnboardingPages } from './flows/dtcOnboarding.js';
+// ── Factory function ──────────────────────────────────────────────────────────
+import { DtcOnboardingEngine } from './engine.js';
+import { dtcOnboardingPages } from './flows/dtcOnboarding.js';
+/**
+ * Create a DTC Onboarding engine instance with the default 17-page flow.
+ */
+export function createDtcOnboardingFlow(options) {
+    return new DtcOnboardingEngine(dtcOnboardingPages, options);
+}

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

@@ -0,0 +1,106 @@
+/**
+ * Type system for the DTC Onboarding questionnaire engine.
+ *
+ * These types define the declarative configuration for questionnaire flows.
+ * They are framework-agnostic — consumed by both React and Vue wrappers.
+ */
+export type AnswerValue = string | number | boolean | string[] | undefined;
+export interface FieldCondition {
+    field: string;
+    op: 'eq' | 'neq' | 'in' | 'notIn' | 'exists' | 'notExists' | 'contains';
+    value?: AnswerValue;
+}
+export interface AndCondition {
+    and: Condition[];
+}
+export interface OrCondition {
+    or: Condition[];
+}
+export type Condition = FieldCondition | AndCondition | OrCondition;
+export declare function isFieldCondition(c: Condition): c is FieldCondition;
+export declare function isAndCondition(c: Condition): c is AndCondition;
+export declare function isOrCondition(c: Condition): c is OrCondition;
+export interface OptionConfig {
+    label: string;
+    value: string | number;
+    description?: string;
+    /** Image identifier resolved to a URL by the framework layer. */
+    imageId?: string;
+    /** When true, selecting this option deselects all others ("None of the above"). */
+    exclusive?: boolean;
+    /** Sub-text shown below the description. */
+    helperText?: string;
+}
+export type QuestionStyle = 'radio-card' | 'checkbox-card' | 'image-card' | 'dropdown' | 'input' | 'currency' | 'phone' | 'searchable-dropdown' | 'toggle' | 'email';
+export interface QuestionConfig {
+    /** Dot-notation answer key (e.g., 'home.above_grade_sq_ft'). */
+    key: string;
+    /** Display label for the question. */
+    label: string;
+    /** Additional description shown below the label. */
+    description?: string;
+    /** Placeholder text for input fields. */
+    placeholder?: string;
+    /** Data type of the answer value. */
+    type: 'string' | 'number' | 'boolean' | 'string[]';
+    /** UI presentation style. */
+    style: QuestionStyle;
+    /** Available options for select-type questions. */
+    options?: OptionConfig[];
+    /** Whether the field is required for page validation. */
+    required?: boolean;
+    /** Minimum value for number inputs. */
+    min?: number;
+    /** Maximum value for number inputs. */
+    max?: number;
+    /** Suffix text displayed inside the input (e.g., 'sq. ft.'). */
+    suffix?: string;
+    /** Hide this question when condition evaluates to false. */
+    showWhen?: Condition;
+    /** Custom validation function. Returns error message or undefined. */
+    validate?: (value: AnswerValue) => string | undefined;
+    /** Auto-advance to next page on selection (for radio-card pages). */
+    autoAdvance?: boolean;
+    /**
+     * Data source identifier for dynamic options.
+     * The framework layer is responsible for fetching data.
+     * E.g., 'homebuilders' triggers a call to getHomebuilders().
+     */
+    dataSource?: string;
+    /** Default value to pre-populate. */
+    defaultValue?: AnswerValue;
+}
+export interface PageConfig {
+    /** Unique page identifier used for navigation and tracking. */
+    id: string;
+    /** Page title displayed as the heading. */
+    title: string;
+    /** Optional subtitle displayed below the title. */
+    subtitle?: string;
+    /** Questions on this page (usually 1 for DTC flow, multiple for confirm-home-details). */
+    questions: QuestionConfig[];
+    /** Skip this page when condition evaluates to false. */
+    showWhen?: Condition;
+    /** Override the "Next" button label (e.g., "See my offer" on contact page). */
+    submitLabel?: string;
+}
+export type EngineEvent = {
+    type: 'answerChange';
+    key: string;
+    value: AnswerValue;
+} | {
+    type: 'pageChange';
+    pageIndex: number;
+    pageId: string;
+} | {
+    type: 'validationError';
+    errors: Record<string, string>;
+} | {
+    type: 'submit';
+    answers: Record<string, AnswerValue>;
+};
+export interface ValidationResult {
+    valid: boolean;
+    errors: Record<string, string>;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/internal/questionnaire/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;AAI3E,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;IACxE,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,SAAS,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,SAAS,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,YAAY,GAAG,WAAW,CAAC;AAIpE,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,IAAI,cAAc,CAElE;AAED,wBAAgB,cAAc,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,IAAI,YAAY,CAE9D;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,IAAI,WAAW,CAE5D;AAID,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,eAAe,GACf,YAAY,GACZ,UAAU,GACV,OAAO,GACP,UAAU,GACV,OAAO,GACP,qBAAqB,GACrB,QAAQ,GACR,OAAO,CAAC;AAIZ,MAAM,WAAW,cAAc;IAC7B,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qCAAqC;IACrC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;IACnD,6BAA6B;IAC7B,KAAK,EAAE,aAAa,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,MAAM,GAAG,SAAS,CAAC;IACtD,qEAAqE;IACrE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,YAAY,CAAC,EAAE,WAAW,CAAC;CAC5B;AAID,MAAM,WAAW,UAAU;IACzB,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0FAA0F;IAC1F,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,wDAAwD;IACxD,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;CAAE,CAAC;AAI7D,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC"}

package/dist/internal/questionnaire/types.js

@@ -0,0 +1,16 @@
+/**
+ * Type system for the DTC Onboarding questionnaire engine.
+ *
+ * These types define the declarative configuration for questionnaire flows.
+ * They are framework-agnostic — consumed by both React and Vue wrappers.
+ */
+// ── Type guards ───────────────────────────────────────────────────────────────
+export function isFieldCondition(c) {
+    return 'field' in c;
+}
+export function isAndCondition(c) {
+    return 'and' in c;
+}
+export function isOrCondition(c) {
+    return 'or' in c;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opendoor/partner-sdk-client-js-core",
-  "version": "1.0.6",
+  "version": "1.0.7-beta.56.1",
   "description": "Framework-agnostic client SDK for Opendoor partner integrations",
   "type": "module",
   "main": "./dist/index.js",
@@ -13,6 +13,10 @@
     "./internal/tracking": {
       "import": "./dist/tracking.js",
       "types": "./dist/tracking.d.ts"
+    },
+    "./internal/questionnaire": {
+      "import": "./dist/internal/questionnaire/index.js",
+      "types": "./dist/internal/questionnaire/index.d.ts"
     }
   },
   "files": [