@worthai/onboarding-sdk 2.0.16 → 3.0.0-beta.0

package/dist-sdk/sdk3/runtimeAdapter.d.ts

@@ -0,0 +1,7 @@
+import { ComponentRegistry } from '../lib/flowComposer/componentRegistry/componentRegistry.types';
+import { WorthOnboardingComponentRegistry, WorthOnboardingOptions } from './worthOnboarding.types';
+export interface WorthOnboardingRuntimeHandle {
+    unmount(): void;
+}
+export declare function mountWorthOnboardingRuntime(target: HTMLElement, options: WorthOnboardingOptions): WorthOnboardingRuntimeHandle;
+export declare function adaptWorthOnboardingComponentRegistry(registry: WorthOnboardingComponentRegistry | undefined): ComponentRegistry | undefined;

package/dist-sdk/sdk3/runtimeAdapterHydration.d.ts

@@ -0,0 +1,8 @@
+import { RegisterRendererArgs } from '../lib/flowComposer/componentRegistry/componentRegistry.types';
+import { StepHydrationContract } from '../lib/flowComposer/form/stepHydration.types';
+import { WorthOnboardingRegisterRendererArgs, WorthOnboardingStepHydrationContract } from './worthOnboarding.types';
+/** Bridges a customer SDK hydration contract into the internal platform contract shape. */
+export declare function adaptSdkHydrationContractToInternal(contract: WorthOnboardingStepHydrationContract): StepHydrationContract;
+/** Bridges an internal hydration contract into the SDK registry shape. */
+export declare function adaptInternalHydrationContractToSdk(contract: StepHydrationContract): WorthOnboardingStepHydrationContract;
+export declare function adaptRegisterRendererArgsToSdk(args: RegisterRendererArgs): WorthOnboardingRegisterRendererArgs;

package/dist-sdk/sdk3/styleManager.d.ts

@@ -0,0 +1 @@
+export declare function ensureWorthOnboardingStyles(styleNonce?: string, ownerDocument?: Document): void;

package/dist-sdk/sdk3/worthOnboarding.d.ts

@@ -0,0 +1,27 @@
+import { WorthOnboarding, WorthOnboardingMountTarget, WorthOnboardingOptions } from './worthOnboarding.types';
+export declare class WorthOnboardingInstance implements WorthOnboarding {
+    private static _activeInstance;
+    private readonly _options;
+    private _host;
+    private _element;
+    private _mountGeneration;
+    private _runtimeHandle;
+    private _state;
+    constructor(options: WorthOnboardingOptions);
+    mount(target: WorthOnboardingMountTarget): Promise<HTMLElement>;
+    unmount(): void;
+    private _beginMount;
+    private _assertInviteToken;
+    private _resolveMountTarget;
+    private _claimHost;
+    private _isHTMLElement;
+    private _normalizeMountError;
+    private _createError;
+    private _notifyAndReturnError;
+    private _notifyError;
+    private _cleanupAfterFailedMount;
+    private _safelyUnmountRuntime;
+    private _removeElement;
+    private _releaseHost;
+    private _releaseActiveInstance;
+}

package/dist-sdk/sdk3/worthOnboarding.types.d.ts

@@ -0,0 +1,307 @@
+import { JSX } from 'solid-js';
+import { WorthOnboardingError } from './errors';
+export type WorthOnboardingMountTarget = HTMLElement | string;
+export type WorthOnboardingCallbackResult = void | Promise<void>;
+export type WorthOnboardingAuthMode = 'auto-passwordless' | 'passwordless' | 'login' | 'signup' | 'verification';
+export type WorthOnboardingFormPrimitiveValue = string | boolean | number | null | undefined;
+export interface WorthOnboardingFormObjectValue {
+    [key: string]: WorthOnboardingFormValue;
+}
+export type WorthOnboardingFormValue = WorthOnboardingFormPrimitiveValue | string[] | boolean[] | number[] | File[] | WorthOnboardingFormObjectValue | WorthOnboardingFormObjectValue[];
+export type WorthOnboardingFormValues = Record<string, WorthOnboardingFormValue>;
+export interface WorthOnboardingEmailCheckResult {
+    readonly data: {
+        readonly email_exists: boolean;
+        readonly is_email_verified: boolean;
+        readonly role?: number;
+        readonly role_id?: number;
+        readonly status: string;
+        readonly subrole: string;
+    };
+    readonly message: string;
+    readonly status: string;
+}
+export interface WorthOnboardingInviteResult {
+    readonly data: {
+        readonly business_id?: string;
+        readonly customer_id?: string;
+        readonly email?: string;
+        readonly invitation_id?: string;
+        readonly is_guest_owner?: boolean;
+        readonly is_lightning_verification?: string;
+        readonly is_no_login?: boolean;
+        readonly onboarding_instance_id?: string;
+    };
+    readonly message: string;
+    readonly status: string;
+}
+export interface WorthOnboardingBusiness {
+    readonly customer_id: string;
+    readonly id: string;
+    readonly name: string;
+    readonly status?: string;
+}
+export interface WorthOnboardingUserDetails {
+    readonly email: string;
+    readonly first_name: string;
+    readonly id: string;
+    readonly is_email_verified: boolean;
+    readonly last_name: string;
+}
+export interface WorthOnboardingCustomerDetails {
+    readonly customer_id?: string;
+    readonly customer_type?: 'PRODUCTION' | 'SANDBOX';
+    readonly name?: string;
+}
+export interface WorthOnboardingSubrole {
+    readonly code?: string;
+    readonly id: string;
+    readonly label: string;
+}
+export interface WorthOnboardingAuthResponse {
+    readonly data: {
+        readonly access_token: string;
+        readonly businesses: WorthOnboardingBusiness[];
+        readonly customer_details?: WorthOnboardingCustomerDetails;
+        readonly id_token: string;
+        readonly invitation_id?: string;
+        readonly login_token?: string;
+        readonly permissions: Array<Record<string, unknown>>;
+        readonly refresh_token: string;
+        readonly session_token?: string;
+        readonly subrole: WorthOnboardingSubrole;
+        readonly user_details: WorthOnboardingUserDetails;
+    };
+    readonly message: string;
+    readonly status: string;
+}
+export interface WorthOnboardingInviteContext {
+    readonly email: string;
+    readonly emailCheck: WorthOnboardingEmailCheckResult;
+    readonly invite: WorthOnboardingInviteResult;
+    readonly inviteToken: string;
+}
+export interface WorthOnboardingAuthenticatedResult extends WorthOnboardingInviteContext {
+    readonly authMode: WorthOnboardingAuthMode;
+    readonly authResponse: WorthOnboardingAuthResponse;
+    readonly status: 'authenticated';
+}
+export interface WorthOnboardingAuthUnsupportedResult extends WorthOnboardingInviteContext {
+    readonly authMode: WorthOnboardingAuthMode;
+    readonly message: string;
+    readonly redirectPath?: string;
+    readonly status: 'unsupported';
+}
+export type WorthOnboardingComponentRegistryType = 'field' | 'layout' | 'widget' | 'step';
+export type WorthOnboardingFieldType = 'text' | 'obscuredText' | 'email' | 'textarea' | 'checkbox' | 'file' | 'select' | 'multiSelect' | 'industrySelect' | 'countrySelect' | 'radio' | 'ownerTitleSelect' | 'googleAutocomplete' | 'date' | 'phone' | 'money' | 'number' | 'depositAccountSelect';
+export type WorthOnboardingLayoutType = 'heading' | 'paragraph' | 'divider' | 'infoAlert' | 'widgetContent';
+export type WorthOnboardingWidgetType = 'navigationOptions' | 'plaidLink' | 'bankingConnectedAccounts' | 'manualBankAccount';
+export type WorthOnboardingStepRendererKey = `${string}:${string}`;
+export interface WorthOnboardingFormField {
+    readonly hidden?: boolean;
+    readonly id: string;
+    readonly label?: string;
+    readonly required?: boolean;
+    readonly type: WorthOnboardingFieldType;
+}
+export interface WorthOnboardingLayoutItem {
+    readonly hidden?: boolean;
+    readonly id: string;
+    readonly type: WorthOnboardingLayoutType;
+}
+export interface WorthOnboardingWidget {
+    readonly enabled?: boolean;
+    readonly id?: string;
+    readonly type: WorthOnboardingWidgetType;
+}
+export interface WorthOnboardingFormStep {
+    readonly formId: string;
+    readonly stepId: string;
+    readonly title: string;
+}
+export interface WorthOnboardingRendererBaseProps {
+    readonly formStore: object;
+    readonly persistDraftField: (fieldId: string, value: WorthOnboardingFormValue) => Promise<void>;
+    readonly persistStepState: (key: string, value: WorthOnboardingFormValue) => Promise<void>;
+}
+export interface WorthOnboardingFieldRendererProps extends WorthOnboardingRendererBaseProps {
+    readonly field: WorthOnboardingFormField;
+    readonly fieldProps: {
+        readonly autofocus?: boolean;
+        readonly disabled?: boolean;
+        readonly name: string;
+        readonly onChange?: JSX.EventHandlerUnion<HTMLInputElement | HTMLSelectElement, Event>;
+        readonly onInput?: JSX.EventHandlerUnion<HTMLInputElement | HTMLTextAreaElement, InputEvent>;
+    };
+    readonly fieldState: {
+        readonly error: string | undefined;
+        readonly value: unknown;
+    };
+    readonly onNavigateToStep?: (stepId: string) => void;
+}
+export interface WorthOnboardingLayoutRendererProps extends WorthOnboardingRendererBaseProps {
+    readonly draftValues: () => WorthOnboardingFormValues;
+    readonly layout: WorthOnboardingLayoutItem;
+    readonly onNavigateToStep?: (stepId: string) => void;
+}
+export interface WorthOnboardingWidgetRendererProps extends WorthOnboardingRendererBaseProps {
+    readonly formValues: () => WorthOnboardingFormValues;
+    readonly onNavigateToStep?: (stepId: string) => void;
+    readonly stepAuxKey: (rawKey: string) => string;
+    readonly widget: WorthOnboardingWidget;
+}
+export interface WorthOnboardingStepRendererProps extends WorthOnboardingRendererBaseProps {
+    readonly formValues: () => WorthOnboardingFormValues;
+    readonly onNavigateToStep?: (stepId: string) => void;
+    readonly schema: WorthOnboardingFormStep;
+}
+export type WorthOnboardingFieldRenderer = (props: WorthOnboardingFieldRendererProps) => JSX.Element;
+export type WorthOnboardingLayoutRenderer = (props: WorthOnboardingLayoutRendererProps) => JSX.Element;
+export type WorthOnboardingWidgetRenderer = (props: WorthOnboardingWidgetRendererProps) => JSX.Element | null;
+export type WorthOnboardingStepRenderer = (props: WorthOnboardingStepRendererProps) => JSX.Element | null;
+export type WorthOnboardingRegisterRendererArgs = {
+    readonly key: WorthOnboardingFieldType;
+    readonly renderer: WorthOnboardingFieldRenderer;
+    readonly type: 'field';
+} | {
+    readonly key: WorthOnboardingLayoutType;
+    readonly renderer: WorthOnboardingLayoutRenderer;
+    readonly type: 'layout';
+} | {
+    readonly key: WorthOnboardingWidgetType;
+    readonly renderer: WorthOnboardingWidgetRenderer;
+    readonly type: 'widget';
+} | {
+    readonly key: WorthOnboardingStepRendererKey;
+    readonly renderer: WorthOnboardingStepRenderer;
+    readonly type: 'step';
+    /**
+     * Optional step hydration contract for selection→detail flows. Co-located with the renderer
+     * so a feature ships its hub renderer + detail-step hydration as a unit. Only valid on
+     * `type: 'step'` registrations.
+     */
+    readonly hydrationContract?: WorthOnboardingStepHydrationContract;
+};
+export type WorthOnboardingHasRendererArgs = {
+    readonly key: WorthOnboardingFieldType;
+    readonly type: 'field';
+} | {
+    readonly key: WorthOnboardingLayoutType;
+    readonly type: 'layout';
+} | {
+    readonly key: WorthOnboardingWidgetType;
+    readonly type: 'widget';
+} | {
+    readonly key: WorthOnboardingStepRendererKey;
+    readonly type: 'step';
+};
+export type WorthOnboardingListRegisteredComponentKeysArgs = {
+    readonly type: WorthOnboardingComponentRegistryType;
+};
+export type WorthOnboardingListRegisteredComponentKeysResult = WorthOnboardingFieldType[] | WorthOnboardingLayoutType[] | WorthOnboardingWidgetType[] | WorthOnboardingStepRendererKey[];
+export type WorthOnboardingRenderArgs = {
+    readonly field: WorthOnboardingFormField;
+    readonly props: Omit<WorthOnboardingFieldRendererProps, 'field'>;
+    readonly type: 'field';
+} | {
+    readonly layout: WorthOnboardingLayoutItem;
+    readonly props: Omit<WorthOnboardingLayoutRendererProps, 'layout'>;
+    readonly type: 'layout';
+} | {
+    readonly props: WorthOnboardingWidgetRendererProps;
+    readonly type: 'widget';
+} | {
+    readonly props: WorthOnboardingStepRendererProps;
+    readonly type: 'step';
+};
+/** Inputs to every {@link WorthOnboardingStepHydrationContract} method. */
+export interface WorthOnboardingStepHydrationContractArgs {
+    readonly schema: WorthOnboardingFormStep;
+    readonly stateValues: WorthOnboardingFormValues | null | undefined;
+}
+/** Inputs to the optional cross-step transfer hook for hydration contracts. */
+export interface WorthOnboardingStepHydrationCrossStepArgs {
+    readonly targetFormId: string;
+    readonly targetStepId: string;
+    readonly targetSchema: WorthOnboardingFormStep;
+    readonly sourceSchema: WorthOnboardingFormStep;
+    readonly sourceDraftValues: WorthOnboardingFormValues;
+    /** Source-step field values pre-filtered to schema-known fields (excludes aux/widget state). */
+    readonly sourceFieldValues: WorthOnboardingFormValues;
+    /** Cross-step / flow-level aux state available at the time of the navigation. */
+    readonly flowValues: WorthOnboardingFormValues;
+}
+/**
+ * Public mirror of the internal `StepHydrationContract`. An SDK consumer that ships its own
+ * "hub → detail" rendering registers a contract here so the flow composer drives selection
+ * hydration, add-mode detection, and clear-on-entry behavior for its step. See
+ * `src/lib/flowComposer/form/stepHydration.README.md` for the full pattern.
+ */
+export interface WorthOnboardingStepHydrationContract {
+    readonly id: string;
+    matches(schema: WorthOnboardingFormStep): boolean;
+    resolveStateValues(args: WorthOnboardingStepHydrationContractArgs): WorthOnboardingFormValues;
+    isAddMode(args: WorthOnboardingStepHydrationContractArgs): boolean;
+    getOwnedAuxKeys(schema: WorthOnboardingFormStep): readonly string[];
+    buildCrossStepPatch?(args: WorthOnboardingStepHydrationCrossStepArgs): WorthOnboardingFormValues;
+}
+export interface WorthOnboardingComponentRegistry {
+    registerRenderer(args: WorthOnboardingRegisterRendererArgs): this;
+    hasRenderer(args: WorthOnboardingHasRendererArgs): boolean;
+    listRegisteredComponentKeys(args: WorthOnboardingListRegisteredComponentKeysArgs): WorthOnboardingListRegisteredComponentKeysResult;
+    render(args: WorthOnboardingRenderArgs): JSX.Element | null;
+    /**
+     * Returns hydration contracts attached during step renderer registration. Contracts are passed
+     * as the optional `hydrationContract` field on `type: 'step'` renderer args.
+     */
+    getHydrationContracts(): readonly WorthOnboardingStepHydrationContract[];
+}
+export type WorthOnboardingJsonValue = null | string | number | boolean | readonly WorthOnboardingJsonValue[] | {
+    readonly [key: string]: WorthOnboardingJsonValue | undefined;
+};
+export interface WorthOnboardingFlowInput {
+    readonly id: string;
+    readonly schema: string;
+    readonly version: number;
+    readonly meta: {
+        readonly title: string;
+        readonly slug: string;
+        readonly description?: string;
+        readonly customerLogo?: string;
+        readonly applicantLogo?: string;
+        readonly [key: string]: WorthOnboardingJsonValue | undefined;
+    };
+    readonly configs?: Readonly<Record<string, WorthOnboardingJsonValue>>;
+    readonly flowRules?: readonly WorthOnboardingJsonValue[];
+    readonly forms: readonly WorthOnboardingJsonValue[];
+    readonly [key: string]: WorthOnboardingJsonValue | undefined;
+}
+export interface WorthOnboardingStepSubmitEvent {
+    readonly inviteToken: string;
+    readonly stepId: string;
+    readonly values: WorthOnboardingFormValues;
+}
+export interface WorthOnboardingCompleteEvent {
+    readonly inviteToken: string;
+    readonly values: WorthOnboardingFormValues;
+}
+export interface WorthOnboarding {
+    mount(target: WorthOnboardingMountTarget): Promise<HTMLElement>;
+    unmount(): void;
+}
+export interface WorthOnboardingOptions {
+    readonly apiBaseUrl?: string;
+    readonly componentRegistry?: WorthOnboardingComponentRegistry;
+    readonly flowInput?: WorthOnboardingFlowInput;
+    readonly inviteToken: string;
+    readonly loadingFallback?: JSX.Element;
+    readonly onAuthenticated?: (result: WorthOnboardingAuthenticatedResult) => void;
+    readonly onAuthUnsupported?: (result: WorthOnboardingAuthUnsupportedResult) => void;
+    readonly onComplete?: (event: WorthOnboardingCompleteEvent) => WorthOnboardingCallbackResult;
+    readonly onError?: (error: WorthOnboardingError) => void;
+    readonly onStepSubmit?: (event: WorthOnboardingStepSubmitEvent) => WorthOnboardingCallbackResult;
+    readonly renderError?: (message: string) => JSX.Element;
+    readonly routeBasePath?: string;
+    readonly storageNamespace?: string;
+    readonly styleNonce?: string;
+}