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

package/dist/internal/questionnaire/flows/dtcOnboarding.js

@@ -0,0 +1,648 @@
+/**
+ * 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.
+ */
+const EMAIL_REGEX = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+function validateEmail(value) {
+    if (typeof value !== 'string')
+        return undefined;
+    if (!EMAIL_REGEX.test(value))
+        return 'Please enter a valid email address';
+    return undefined;
+}
+function validatePhone(value) {
+    if (typeof value !== 'string')
+        return undefined;
+    const digits = value.replace(/\D/g, '');
+    if (digits.length < 10)
+        return 'Please enter a valid 10-digit phone number';
+    return undefined;
+}
+// ── Page 1: Confirm Home Details ──────────────────────────────────────────────
+const confirmHomeDetailsPage = {
+    id: 'confirm-home-details',
+    title: 'Confirm your home details',
+    subtitle: "This info is available to the public. You can edit these details if you've made any updates to your home.",
+    questions: [
+        {
+            key: 'home.dwelling_type',
+            label: 'Home type',
+            type: 'string',
+            style: 'dropdown',
+            required: true,
+            options: [
+                { label: 'Single family home', value: 'single_family' },
+                { label: 'Townhouse', value: 'townhouse' },
+                { label: 'Apartment / Condo', value: 'apartment' },
+                { label: 'Mobile home', value: 'mobile_home' },
+                { label: 'Multi-family', value: 'multi_family' },
+                { label: 'Commercial', value: 'commercial' },
+                { label: 'Vacant land', value: 'vacant' },
+            ],
+        },
+        {
+            key: 'home.bedrooms',
+            label: 'Bedrooms',
+            description: 'Must have a closet and a window/vent',
+            type: 'number',
+            style: 'dropdown',
+            required: true,
+            options: Array.from({ length: 12 }, (_, i) => ({
+                label: String(i + 1),
+                value: i + 1,
+            })),
+        },
+        {
+            key: 'home.bathrooms.full',
+            label: 'Full bathrooms',
+            description: 'Must have a toilet and a shower/tub',
+            type: 'number',
+            style: 'dropdown',
+            required: true,
+            options: Array.from({ length: 10 }, (_, i) => ({
+                label: String(i + 1),
+                value: i + 1,
+            })),
+        },
+        {
+            key: 'home.bathrooms.half',
+            label: 'Partial bathrooms',
+            description: 'No shower or tub required',
+            type: 'number',
+            style: 'dropdown',
+            required: false,
+            options: Array.from({ length: 11 }, (_, i) => ({
+                label: String(i),
+                value: i,
+            })),
+        },
+        {
+            key: 'home.exterior_stories',
+            label: 'Floors (above ground)',
+            description: 'Only count full & liveable floors',
+            type: 'number',
+            style: 'dropdown',
+            required: true,
+            options: [
+                { label: '1', value: 1 },
+                { label: '2', value: 2 },
+                { label: '3', value: 3 },
+            ],
+        },
+        {
+            key: 'home.above_grade_sq_ft',
+            label: 'Square footage (above ground)',
+            description: "Don't include the basement, any porches or additions, or non-liveable space/footage.",
+            type: 'number',
+            style: 'input',
+            required: true,
+            min: 1,
+            suffix: 'sq. ft.',
+        },
+        {
+            key: 'home.has_basement',
+            label: 'Basement',
+            type: 'string',
+            style: 'dropdown',
+            required: true,
+            options: [
+                { label: 'Yes', value: 'yes' },
+                { label: 'No', value: 'no' },
+            ],
+            showWhen: {
+                and: [
+                    { field: 'home.dwelling_type', op: 'exists' },
+                    {
+                        field: 'home.dwelling_type',
+                        op: 'notIn',
+                        value: ['apartment', 'mobile_home'],
+                    },
+                ],
+            },
+        },
+        {
+            key: 'home.basement_finished_sq_ft',
+            label: 'Finished basement sq. ft.',
+            description: 'Finished liveable area that is completely below ground.',
+            type: 'number',
+            style: 'input',
+            required: false,
+            min: 0,
+            max: 10000,
+            suffix: 'sq. ft.',
+            showWhen: { field: 'home.has_basement', op: 'eq', value: 'yes' },
+        },
+        {
+            key: 'home.basement_unfinished_sq_ft',
+            label: 'Unfinished basement sq. ft.',
+            description: 'Unfinished area that is completely below ground.',
+            type: 'number',
+            style: 'input',
+            required: false,
+            min: 0,
+            max: 10000,
+            suffix: 'sq. ft.',
+            showWhen: { field: 'home.has_basement', op: 'eq', value: 'yes' },
+        },
+        {
+            key: 'home.year_built',
+            label: 'Year built',
+            type: 'number',
+            style: 'dropdown',
+            required: true,
+            options: Array.from({ length: 150 }, (_, i) => {
+                const year = new Date().getFullYear() - i;
+                return { label: String(year), value: year };
+            }),
+        },
+        {
+            key: 'home.pool_type',
+            label: 'Pool',
+            type: 'string',
+            style: 'dropdown',
+            required: true,
+            options: [
+                { label: 'In-ground pool', value: 'in_ground' },
+                { label: 'Above-ground pool', value: 'above_ground' },
+                { label: 'Community pool', value: 'community' },
+                { label: 'No pool', value: 'none' },
+            ],
+        },
+        {
+            key: 'home.covered_parking_type',
+            label: 'Covered parking',
+            type: 'string',
+            style: 'dropdown',
+            required: false,
+            options: [
+                { label: 'Garage', value: 'garage' },
+                { label: 'Carport', value: 'carport' },
+                { label: 'None', value: 'none' },
+            ],
+        },
+        {
+            key: 'home.garage_spaces',
+            label: 'Parking spaces',
+            type: 'number',
+            style: 'dropdown',
+            required: false,
+            options: Array.from({ length: 6 }, (_, i) => ({
+                label: String(i),
+                value: i,
+            })),
+            showWhen: {
+                and: [
+                    { field: 'home.covered_parking_type', op: 'exists' },
+                    { field: 'home.covered_parking_type', op: 'neq', value: 'none' },
+                ],
+            },
+        },
+        {
+            key: 'home.entry_type',
+            label: 'Entry type',
+            type: 'string',
+            style: 'dropdown',
+            required: true,
+            options: [
+                { label: 'Direct entry', value: 'direct_entry' },
+                { label: 'Shared entrance', value: 'shared_entrance_condo' },
+            ],
+            showWhen: {
+                field: 'home.dwelling_type',
+                op: 'in',
+                value: ['apartment', 'townhouse'],
+            },
+        },
+    ],
+};
+// ── Page 2: Ownership ─────────────────────────────────────────────────────────
+const ownershipPage = {
+    id: 'ownership',
+    title: 'Are you the owner of this home?',
+    subtitle: "We have additional questions if you're an agent.",
+    questions: [
+        {
+            key: 'seller.relation_to_owner',
+            label: 'Relationship to owner',
+            type: 'string',
+            style: 'radio-card',
+            required: true,
+            // No autoAdvance — "Other" option reveals a followup text input on this page
+            options: [
+                { label: 'Yes, I own this home', value: 'Self' },
+                { label: "No, I'm an agent", value: 'Agent' },
+                { label: "I'm an agent, and own this home", value: 'AgentAndOwner' },
+                { label: 'Other', value: 'other' },
+            ],
+        },
+        {
+            key: 'seller.relation_to_owner.other',
+            label: 'Please specify',
+            type: 'string',
+            style: 'input',
+            required: true,
+            placeholder: 'Your relationship to the owner',
+            showWhen: { field: 'seller.relation_to_owner', op: 'eq', value: 'other' },
+        },
+    ],
+};
+// ── Page 3: Sale Timeline ─────────────────────────────────────────────────────
+const saleTimelinePage = {
+    id: 'sale-timeline',
+    title: 'When do you need to sell your home?',
+    subtitle: "This won't affect your offer. We're here to help with any timeline.",
+    questions: [
+        {
+            key: 'seller.sale_timeline',
+            label: 'Sale timeline',
+            type: 'string',
+            style: 'radio-card',
+            required: true,
+            autoAdvance: true,
+            options: [
+                { label: 'ASAP', value: 'ASAP' },
+                { label: '2-4 weeks', value: '2 - 4 Weeks' },
+                { label: '4-6 weeks', value: '4 - 6 Weeks' },
+                { label: '6+ weeks', value: '6+ Weeks' },
+                { label: 'Just browsing', value: 'Just Browsing' },
+            ],
+        },
+    ],
+};
+// ── Pages 4-7: Room Condition ─────────────────────────────────────────────────
+const CONDITION_LEVELS = [
+    'fixer_upper',
+    'dated',
+    'standard',
+    'high_end',
+    'luxury',
+];
+const CONDITION_DESCRIPTIONS = {
+    kitchen: {
+        fixer_upper: 'Kitchen needs significant repairs',
+        dated: "Kitchen hasn't been updated recently",
+        standard: 'Kitchen is updated with common finishes',
+        high_end: 'Kitchen has high-quality upgrades',
+        luxury: 'Kitchen has elegant, top-tier finishes',
+    },
+    bathroom: {
+        fixer_upper: 'Bathroom needs significant repairs',
+        dated: "Bathroom hasn't been updated recently",
+        standard: 'Bathroom is updated with common finishes',
+        high_end: 'Bathroom has high-quality upgrades',
+        luxury: 'Bathroom has elegant, top-tier finishes',
+    },
+    'living-room': {
+        fixer_upper: 'Living room needs significant repairs',
+        dated: "Living room hasn't been updated recently",
+        standard: 'Living room is updated with common finishes',
+        high_end: 'Living room has high-quality upgrades',
+        luxury: 'Living room has elegant, top-tier finishes',
+    },
+    exterior: {
+        fixer_upper: 'Exterior needs significant repairs',
+        dated: "Exterior hasn't been updated recently",
+        standard: 'Exterior is updated with common finishes',
+        high_end: 'Exterior has high-quality upgrades',
+        luxury: 'Exterior has elegant, top-tier finishes',
+    },
+};
+const CONDITION_LABELS = {
+    fixer_upper: 'Fixer upper',
+    dated: 'Dated',
+    standard: 'Standard',
+    high_end: 'High-end',
+    luxury: 'Luxury',
+};
+function createConditionPage(room, answerKey, title) {
+    return {
+        id: `${room}-condition`,
+        title,
+        subtitle: 'For these questions, just select the closest match.',
+        questions: [
+            {
+                key: answerKey,
+                label: title,
+                type: 'string',
+                style: 'image-card',
+                required: true,
+                autoAdvance: true,
+                options: CONDITION_LEVELS.map((level) => ({
+                    label: CONDITION_LABELS[level],
+                    value: level,
+                    description: CONDITION_DESCRIPTIONS[room][level],
+                    imageId: `${room}-${level}`,
+                })),
+            },
+        ],
+    };
+}
+const kitchenConditionPage = createConditionPage('kitchen', 'home.kitchen_seller_score', 'How would you describe your kitchen?');
+const bathroomConditionPage = createConditionPage('bathroom', 'home.bathroom_seller_score', 'How would you describe your main bathroom?');
+const livingRoomConditionPage = createConditionPage('living-room', 'home.living_room_seller_score', 'How would you describe your living room?');
+const exteriorConditionPage = createConditionPage('exterior', 'home.exterior_seller_score', "How would you describe your home's exterior?");
+// ── Page 8: HOA ───────────────────────────────────────────────────────────────
+const hoaPage = {
+    id: 'hoa',
+    title: 'Is your home part of a homeowners association?',
+    subtitle: "This is often called an HOA. It's a group that helps maintain your community for a fee.",
+    questions: [
+        {
+            key: 'home.hoa',
+            label: 'HOA',
+            type: 'string',
+            style: 'radio-card',
+            required: true,
+            autoAdvance: true,
+            options: [
+                { label: 'Yes', value: 'yes' },
+                { label: 'No', value: 'no' },
+            ],
+        },
+    ],
+};
+// ── Page 9: HOA Type ──────────────────────────────────────────────────────────
+const hoaTypePage = {
+    id: 'hoa-type',
+    title: 'Does your home belong to any of these types of communities?',
+    showWhen: { field: 'home.hoa', op: 'eq', value: 'yes' },
+    questions: [
+        {
+            key: 'home.hoa_type',
+            label: 'Community type',
+            type: 'string[]',
+            style: 'checkbox-card',
+            required: true,
+            options: [
+                {
+                    label: 'Age restricted community',
+                    value: 'age_restricted_community',
+                },
+                { label: 'Gated community', value: 'gated_community' },
+                { label: 'None of the above', value: 'none', exclusive: true },
+            ],
+        },
+    ],
+};
+// ── Page 10: HOA Guard ────────────────────────────────────────────────────────
+const hoaGuardPage = {
+    id: 'hoa-guard',
+    title: 'Is there a guard at the entrance?',
+    showWhen: {
+        and: [
+            { field: 'home.hoa', op: 'eq', value: 'yes' },
+            { field: 'home.hoa_type', op: 'contains', value: 'gated_community' },
+        ],
+    },
+    questions: [
+        {
+            key: 'home.hoa_type.guarded_gated_community',
+            label: 'Guard at entrance',
+            type: 'string',
+            style: 'radio-card',
+            required: true,
+            autoAdvance: true,
+            options: [
+                { label: 'Yes', value: 'has_guard' },
+                { label: 'No', value: 'no_guard' },
+            ],
+        },
+    ],
+};
+// ── Page 11: HOA Fees ─────────────────────────────────────────────────────────
+const hoaFeesPage = {
+    id: 'hoa-fees',
+    title: 'What are your monthly HOA fees?',
+    subtitle: "(Optional) This helps us better understand your property's monthly expenses.",
+    showWhen: { field: 'home.hoa', op: 'eq', value: 'yes' },
+    questions: [
+        {
+            key: 'home.hoa_fees',
+            label: 'Monthly HOA fees',
+            type: 'number',
+            style: 'currency',
+            required: false,
+            min: 0,
+        },
+    ],
+};
+// ── Page 12: Eligibility Criteria ─────────────────────────────────────────────
+const eligibilityCriteriaPage = {
+    id: 'eligibility-criteria',
+    title: 'Do any of these apply to your home?',
+    subtitle: 'Select all that apply. We keep an eye out for these things when making an offer.',
+    questions: [
+        {
+            key: 'home.eligibility_criteria',
+            label: 'Eligibility criteria',
+            type: 'string[]',
+            style: 'checkbox-card',
+            required: false,
+            options: [
+                {
+                    label: 'Leased or financed solar panels',
+                    value: 'leased_solar_panels',
+                    helperText: 'You may need to buy out the lease or remove the panels to sell to us.',
+                },
+                {
+                    label: 'Known foundation issues',
+                    value: 'known_foundation_issues',
+                    helperText: 'Concrete cracking, uneven floors.',
+                },
+                { label: 'Fire damage', value: 'fire_damage' },
+                {
+                    label: 'Well water',
+                    value: 'well_water',
+                    helperText: 'You maintain a well to supply water.',
+                },
+                {
+                    label: 'Septic system',
+                    value: 'septic',
+                    helperText: 'Separate from municipal sewage.',
+                },
+                {
+                    label: 'Unique ownership structure',
+                    value: 'unique_ownership_structure',
+                    helperText: 'Tenants in Common, Co-Ops, etc.',
+                },
+                {
+                    label: 'Part of a Below Market Rate (BMR) Ownership Program',
+                    value: 'below_market_rate_ownership',
+                },
+                {
+                    label: 'Rent controlled and has a tenant today',
+                    value: 'rent_controlled_tenant_occupied',
+                },
+                {
+                    label: 'Mobile or manufactured home',
+                    value: 'mobile_manufactured_home',
+                    helperText: 'Includes homes on a permanent foundation.',
+                },
+                { label: 'None of the above', value: 'none', exclusive: true },
+            ],
+        },
+    ],
+};
+// ── Page 13: Upgrades ─────────────────────────────────────────────────────────
+const upgradesPage = {
+    id: 'upgrades',
+    title: 'Has your home had any upgrades?',
+    subtitle: 'This includes renovations, remodels, or major improvements.',
+    questions: [
+        {
+            key: 'home.has_upgrades',
+            label: 'Home upgrades',
+            type: 'string',
+            style: 'radio-card',
+            required: true,
+            autoAdvance: true,
+            options: [
+                { label: 'Yes', value: 'yes' },
+                { label: 'No', value: 'no' },
+            ],
+        },
+    ],
+};
+// ── Page 14: Homebuilder ──────────────────────────────────────────────────────
+const homebuilderPage = {
+    id: 'homebuilder',
+    title: 'Are you working with a homebuilder?',
+    subtitle: 'We can work with them to line up your close dates.',
+    questions: [
+        {
+            key: 'seller.working_with_home_builder',
+            label: 'Working with homebuilder',
+            type: 'string',
+            style: 'radio-card',
+            required: true,
+            autoAdvance: true,
+            options: [
+                { label: 'Yes', value: 'true' },
+                { label: 'No', value: 'false' },
+            ],
+        },
+    ],
+};
+// ── Page 15: Homebuilder Name ─────────────────────────────────────────────────
+const homebuilderNamePage = {
+    id: 'homebuilder-name',
+    title: 'Which homebuilder are you working with?',
+    showWhen: {
+        field: 'seller.working_with_home_builder',
+        op: 'eq',
+        value: 'true',
+    },
+    questions: [
+        {
+            key: 'seller.home_builder',
+            label: 'Homebuilder',
+            type: 'string',
+            style: 'searchable-dropdown',
+            required: false,
+            dataSource: 'homebuilders',
+            placeholder: 'Select or search...',
+        },
+    ],
+};
+// ── Page 16: Homebuilder Details ──────────────────────────────────────────────
+const homebuilderDetailsPage = {
+    id: 'homebuilder-details',
+    title: 'Please tell us more about your homebuilder',
+    showWhen: {
+        field: 'seller.working_with_home_builder',
+        op: 'eq',
+        value: 'true',
+    },
+    questions: [
+        {
+            key: 'seller.home_builder_email',
+            label: 'Sales associate email (Optional)',
+            type: 'string',
+            style: 'email',
+            required: false,
+            placeholder: 'you@example.com',
+            validate: validateEmail,
+        },
+        {
+            key: 'seller.home_builder_community',
+            label: "Homebuilder's community name (Optional)",
+            type: 'string',
+            style: 'input',
+            required: false,
+            placeholder: 'Community name',
+        },
+    ],
+};
+// ── Page 17: Entry Type (standalone page for non-SFH) ─────────────────────────
+// Note: Entry type is also on confirm-home-details as a conditional field.
+// This standalone page exists for flows where dwelling type is set after
+// confirm-home-details (e.g., from address data). Normally the inline field
+// on confirm-home-details handles this. Kept here for completeness — can be
+// conditionally included based on partner flow configuration.
+// ── Page 18: Contact Info ─────────────────────────────────────────────────────
+const contactInfoPage = {
+    id: 'contact-info',
+    title: "You're one step from your offer.",
+    subtitle: 'Create a free account to see your offer. No commitment to sell — just your number, email, and name.',
+    submitLabel: 'See my offer',
+    questions: [
+        {
+            key: 'seller.full_name',
+            label: 'Full name',
+            type: 'string',
+            style: 'input',
+            required: true,
+            placeholder: 'Full name',
+        },
+        {
+            key: 'seller.email',
+            label: 'Email address',
+            type: 'string',
+            style: 'email',
+            required: true,
+            placeholder: 'you@example.com',
+            validate: validateEmail,
+        },
+        {
+            key: 'seller.phone_number',
+            label: 'Phone number',
+            type: 'string',
+            style: 'phone',
+            required: true,
+            placeholder: '(555) 555-5555',
+            validate: validatePhone,
+        },
+        {
+            key: 'seller.sms_opt_in',
+            label: 'I consent to receive marketing calls and texts from Opendoor and its affiliates to the number provided. I understand that I may opt out at any time and consent is not a condition of purchase.',
+            type: 'boolean',
+            style: 'toggle',
+            required: false,
+        },
+    ],
+};
+// ── Complete DTC Onboarding Flow ──────────────────────────────────────────────
+export const dtcOnboardingPages = [
+    confirmHomeDetailsPage,
+    ownershipPage,
+    saleTimelinePage,
+    kitchenConditionPage,
+    bathroomConditionPage,
+    livingRoomConditionPage,
+    exteriorConditionPage,
+    hoaPage,
+    hoaTypePage,
+    hoaGuardPage,
+    hoaFeesPage,
+    eligibilityCriteriaPage,
+    upgradesPage,
+    homebuilderPage,
+    homebuilderNamePage,
+    homebuilderDetailsPage,
+    contactInfoPage,
+];

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

@@ -0,0 +1,32 @@
+/**
+ * Framework-agnostic form logic for the questionnaire engine.
+ *
+ * Handles condition evaluation, field validation, and page visibility.
+ */
+import type { AnswerValue, Condition, PageConfig, QuestionConfig, ValidationResult } from './types.js';
+type GetAnswer = (key: string) => AnswerValue;
+/**
+ * Recursively evaluates a Condition tree against the current answers.
+ */
+export declare function evaluateCondition(condition: Condition, getAnswer: GetAnswer): boolean;
+/**
+ * Returns the visible questions on a page, filtering out those whose
+ * showWhen condition evaluates to false.
+ */
+export declare function getVisibleQuestions(page: PageConfig, getAnswer: GetAnswer): QuestionConfig[];
+/**
+ * Returns the visible pages, filtering out those whose showWhen condition
+ * evaluates to false given current answers.
+ */
+export declare function getVisiblePages(pages: PageConfig[], getAnswer: GetAnswer): PageConfig[];
+/**
+ * Validates a single field. Returns an error message or undefined.
+ */
+export declare function validateField(question: QuestionConfig, value: AnswerValue): string | undefined;
+/**
+ * Validates all visible questions on a page.
+ * Returns a ValidationResult with field-level errors.
+ */
+export declare function validatePage(page: PageConfig, getAnswer: GetAnswer): ValidationResult;
+export {};
+//# sourceMappingURL=formLogic.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"formLogic.d.ts","sourceRoot":"","sources":["../../../src/internal/questionnaire/formLogic.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,UAAU,EACV,cAAc,EACd,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAGpB,KAAK,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,WAAW,CAAC;AAI9C;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,GACnB,OAAO,CA8CT;AAID;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,UAAU,EAChB,SAAS,EAAE,SAAS,GACnB,cAAc,EAAE,CAIlB;AAID;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,UAAU,EAAE,EACnB,SAAS,EAAE,SAAS,GACnB,UAAU,EAAE,CAId;AAID;;GAEG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,WAAW,GACjB,MAAM,GAAG,SAAS,CAuCpB;AAID;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,UAAU,EAChB,SAAS,EAAE,SAAS,GACnB,gBAAgB,CAgBlB"}