@nodii/onboarding 0.0.1 → 0.1.0

package/dist/model-ESLSEbi0.d.ts

@@ -0,0 +1,640 @@
+import { z } from 'zod/v3';
+
+/**
+ * D540 §1 onboarding-spec model — mirrors the LOCKED hub REST contract:
+ *   GET /api/v1/public/onboarding/spec (PublicOnboardingSpecResponse)
+ *
+ * Response shape (hub JSON Schema, both tiers identical):
+ *   {
+ *     specVersion:   string (monotonic; echo on submit; stale ⇒ 409),
+ *     onboarderTier: "platform" | "tenant",
+ *     botChallenge:  { provider: "recaptcha", siteKey: string },
+ *     forms: {
+ *       contact: { fields: SpecField[] },
+ *       signup:  { steps: [{ stage: "lead"|"prospect"|"activation",
+ *                            fields: SpecField[] }] }
+ *     }
+ *   }
+ *
+ * SpecField (required: key, type, label, required):
+ *   { key, type, label, required, validation?, options?, serviceSelection?,
+ *     piiClass?: "none"|"context"|"always"|"reference" }
+ *
+ * The Zod schema below validates a fetched spec BEFORE the SDK renders
+ * anything from it — a malformed spec throws OnboardingSpecInvalidError
+ * (a half-parsed spec could silently drop required fields).
+ */
+
+type OnboarderTier = "platform" | "tenant";
+type PiiClass = "none" | "context" | "always" | "reference";
+type SpecStage = "lead" | "prospect" | "activation";
+type TerminalStage = "prospect" | "inactive" | "active";
+/**
+ * Field keys are interpolated into DOM element ids and (historically) CSS
+ * selectors by the widget layer. Constrain them to a strict identifier
+ * alphabet so a MALICIOUS or compromised onboarder spec cannot smuggle CSS
+ * metacharacters or selector-breakout payloads (e.g. `evil], [onclick=…`)
+ * through the fetched spec. A spec with an out-of-alphabet key is REJECTED
+ * at parse time → OnboardingSpecInvalidError (fail-closed; never rendered).
+ * This is layer 1; the widget also CSS.escapes ids as defense-in-depth.
+ */
+declare const FIELD_KEY_PATTERN: RegExp;
+declare const specFieldSchema: z.ZodObject<{
+    key: z.ZodString;
+    type: z.ZodString;
+    label: z.ZodString;
+    required: z.ZodBoolean;
+    validation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    options: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    serviceSelection: z.ZodOptional<z.ZodBoolean>;
+    piiClass: z.ZodOptional<z.ZodEnum<["none", "context", "always", "reference"]>>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    required: boolean;
+    key: string;
+    label: string;
+    options?: unknown[] | undefined;
+    validation?: Record<string, unknown> | undefined;
+    serviceSelection?: boolean | undefined;
+    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+}, {
+    type: string;
+    required: boolean;
+    key: string;
+    label: string;
+    options?: unknown[] | undefined;
+    validation?: Record<string, unknown> | undefined;
+    serviceSelection?: boolean | undefined;
+    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+}>;
+type SpecField = z.infer<typeof specFieldSchema>;
+declare const specStepSchema: z.ZodObject<{
+    stage: z.ZodEnum<["lead", "prospect", "activation"]>;
+    fields: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        type: z.ZodString;
+        label: z.ZodString;
+        required: z.ZodBoolean;
+        validation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        options: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+        serviceSelection: z.ZodOptional<z.ZodBoolean>;
+        piiClass: z.ZodOptional<z.ZodEnum<["none", "context", "always", "reference"]>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        required: boolean;
+        key: string;
+        label: string;
+        options?: unknown[] | undefined;
+        validation?: Record<string, unknown> | undefined;
+        serviceSelection?: boolean | undefined;
+        piiClass?: "none" | "context" | "always" | "reference" | undefined;
+    }, {
+        type: string;
+        required: boolean;
+        key: string;
+        label: string;
+        options?: unknown[] | undefined;
+        validation?: Record<string, unknown> | undefined;
+        serviceSelection?: boolean | undefined;
+        piiClass?: "none" | "context" | "always" | "reference" | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    stage: "lead" | "prospect" | "activation";
+    fields: {
+        type: string;
+        required: boolean;
+        key: string;
+        label: string;
+        options?: unknown[] | undefined;
+        validation?: Record<string, unknown> | undefined;
+        serviceSelection?: boolean | undefined;
+        piiClass?: "none" | "context" | "always" | "reference" | undefined;
+    }[];
+}, {
+    stage: "lead" | "prospect" | "activation";
+    fields: {
+        type: string;
+        required: boolean;
+        key: string;
+        label: string;
+        options?: unknown[] | undefined;
+        validation?: Record<string, unknown> | undefined;
+        serviceSelection?: boolean | undefined;
+        piiClass?: "none" | "context" | "always" | "reference" | undefined;
+    }[];
+}>;
+type SpecStep = z.infer<typeof specStepSchema>;
+declare const onboardingSpecSchema: z.ZodObject<{
+    specVersion: z.ZodString;
+    onboarderTier: z.ZodEnum<["platform", "tenant"]>;
+    botChallenge: z.ZodOptional<z.ZodObject<{
+        provider: z.ZodLiteral<"recaptcha">;
+        siteKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        provider: "recaptcha";
+        siteKey: string;
+    }, {
+        provider: "recaptcha";
+        siteKey: string;
+    }>>;
+    forms: z.ZodObject<{
+        contact: z.ZodObject<{
+            fields: z.ZodArray<z.ZodObject<{
+                key: z.ZodString;
+                type: z.ZodString;
+                label: z.ZodString;
+                required: z.ZodBoolean;
+                validation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                options: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+                serviceSelection: z.ZodOptional<z.ZodBoolean>;
+                piiClass: z.ZodOptional<z.ZodEnum<["none", "context", "always", "reference"]>>;
+            }, "strip", z.ZodTypeAny, {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }, {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        }, {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        }>;
+        signup: z.ZodObject<{
+            steps: z.ZodArray<z.ZodObject<{
+                stage: z.ZodEnum<["lead", "prospect", "activation"]>;
+                fields: z.ZodArray<z.ZodObject<{
+                    key: z.ZodString;
+                    type: z.ZodString;
+                    label: z.ZodString;
+                    required: z.ZodBoolean;
+                    validation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    options: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+                    serviceSelection: z.ZodOptional<z.ZodBoolean>;
+                    piiClass: z.ZodOptional<z.ZodEnum<["none", "context", "always", "reference"]>>;
+                }, "strip", z.ZodTypeAny, {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }, {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }, {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        }, {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        contact: {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        };
+        signup: {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        };
+    }, {
+        contact: {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        };
+        signup: {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        };
+    }>;
+    consentPack: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        documents: z.ZodArray<z.ZodEffects<z.ZodObject<{
+            legalDocumentId: z.ZodString;
+            docType: z.ZodEnum<["tos", "privacy", "dpa", "custom"]>;
+            customKey: z.ZodNullable<z.ZodString>;
+            title: z.ZodString;
+            versionNo: z.ZodNumber;
+            contentHash: z.ZodString;
+            downloadUrl: z.ZodString;
+            acceptanceLevel: z.ZodEnum<["checkbox", "scroll_then_accept", "open_then_accept"]>;
+            required: z.ZodBoolean;
+        }, "strict", z.ZodTypeAny, {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }, {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }>, {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }, {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    }, {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    }>, {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    }, {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    specVersion: string;
+    onboarderTier: "platform" | "tenant";
+    forms: {
+        contact: {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        };
+        signup: {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        };
+    };
+    botChallenge?: {
+        provider: "recaptcha";
+        siteKey: string;
+    } | undefined;
+    consentPack?: {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    } | undefined;
+}, {
+    specVersion: string;
+    onboarderTier: "platform" | "tenant";
+    forms: {
+        contact: {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        };
+        signup: {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        };
+    };
+    botChallenge?: {
+        provider: "recaptcha";
+        siteKey: string;
+    } | undefined;
+    consentPack?: {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    } | undefined;
+}>;
+type OnboardingSpec = z.infer<typeof onboardingSpecSchema>;
+/**
+ * Parse an unknown value as an OnboardingSpec.
+ * Returns a SafeParseReturnType (inferred).
+ */
+declare function validateOnboardingSpec(value: unknown): z.SafeParseReturnType<{
+    specVersion: string;
+    onboarderTier: "platform" | "tenant";
+    forms: {
+        contact: {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        };
+        signup: {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        };
+    };
+    botChallenge?: {
+        provider: "recaptcha";
+        siteKey: string;
+    } | undefined;
+    consentPack?: {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    } | undefined;
+}, {
+    specVersion: string;
+    onboarderTier: "platform" | "tenant";
+    forms: {
+        contact: {
+            fields: {
+                type: string;
+                required: boolean;
+                key: string;
+                label: string;
+                options?: unknown[] | undefined;
+                validation?: Record<string, unknown> | undefined;
+                serviceSelection?: boolean | undefined;
+                piiClass?: "none" | "context" | "always" | "reference" | undefined;
+            }[];
+        };
+        signup: {
+            steps: {
+                stage: "lead" | "prospect" | "activation";
+                fields: {
+                    type: string;
+                    required: boolean;
+                    key: string;
+                    label: string;
+                    options?: unknown[] | undefined;
+                    validation?: Record<string, unknown> | undefined;
+                    serviceSelection?: boolean | undefined;
+                    piiClass?: "none" | "context" | "always" | "reference" | undefined;
+                }[];
+            }[];
+        };
+    };
+    botChallenge?: {
+        provider: "recaptcha";
+        siteKey: string;
+    } | undefined;
+    consentPack?: {
+        documents: {
+            legalDocumentId: string;
+            docType: "custom" | "tos" | "privacy" | "dpa";
+            customKey: string | null;
+            title: string;
+            versionNo: number;
+            contentHash: string;
+            downloadUrl: string;
+            acceptanceLevel: "checkbox" | "scroll_then_accept" | "open_then_accept";
+            required: boolean;
+        }[];
+    } | undefined;
+}>;
+
+export { FIELD_KEY_PATTERN as F, type OnboarderTier as O, type PiiClass as P, type SpecField as S, type TerminalStage as T, type OnboardingSpec as a, type SpecStage as b, type SpecStep as c, specStepSchema as d, onboardingSpecSchema as o, specFieldSchema as s, validateOnboardingSpec as v };