jsfe 1.6.0 → 1.7.1

package/dist/forms/flows.d.ts

@@ -0,0 +1,611 @@
+/**
+ * The form shell: declare inputs, run the loop, hand the result on. `after` = the form's own steps once complete.
+ * `confirm` ({ question, question_es } — SAY-style templates that may read cargo.forms[<id>].values; build them in
+ * `before_confirm` SET steps when they need computing): the exact confirmation, asked every time after the loop and
+ * never an input. YES runs `after`; NO runs `declined`; a correction given there goes through the form's own matching
+ * and the form runs again (so whatever the correction made missing is asked).
+ */
+export function formFlow({ id, name, version, description, inputs, after, extraVars, parameters, confirm, before_confirm, declined, stop, close_on_stop, resume_on_parent_change, before, done, primary, scope, validator, confirmation_condition, prompt, prompt_es, incomplete_outcome, on_exhausted }: {
+    id: any;
+    name: any;
+    version: any;
+    description: any;
+    inputs: any;
+    after?: never[] | undefined;
+    extraVars?: {} | undefined;
+    parameters?: never[] | undefined;
+    confirm?: null | undefined;
+    before_confirm?: never[] | undefined;
+    declined?: never[] | undefined;
+    stop?: string | undefined;
+    close_on_stop?: boolean | undefined;
+    resume_on_parent_change?: boolean | undefined;
+    before?: never[] | undefined;
+    done?: boolean | undefined;
+    primary?: boolean | undefined;
+    scope?: string | undefined;
+    validator?: string | undefined;
+    confirmation_condition?: string | undefined;
+    prompt?: undefined;
+    prompt_es?: undefined;
+    incomplete_outcome?: null | undefined;
+    on_exhausted?: null | undefined;
+}): {
+    variables: {
+        [k: string]: {
+            type: string;
+            value: any;
+        };
+    };
+    steps: any[];
+    prompt?: undefined;
+    prompt_es?: undefined;
+    primary?: boolean | undefined;
+    id: any;
+    name: any;
+    version: any;
+    description: any;
+    scope: string;
+    metadata: {
+        formProtocol: number;
+    };
+    parameters: any[];
+};
+/**
+ * A form's NO branch as its own flow, `${id}-declined`: it replaces the form, says and does `steps`, then clears the
+ * form's sensitive values (a card number, a security code). The rest is kept, so a caller who asks again resumes.
+ */
+export function declinedFlow(id: any, steps: any): {
+    id: string;
+    name: string;
+    version: string;
+    description: string;
+    steps: any[];
+};
+/** Schedule deferred catalogs once authorized or once the existing task gate ends; each still enforces its own gate. */
+export function takeReadyProviderRequests(cargo: any, form: any): any[];
+/** Register private questions on their owning task while one provider gate is suspended. */
+export function beginProviderRequest(cargo: any, form: any, provides: any, keys: any, gateParams: any): {
+    owner: any;
+    queued: boolean;
+};
+/** Consume once after the active gate returns; every deferred catalog still enforces its own gate. */
+export function finishProviderRequest(cargo: any, owner: any, provides: any, keys: any): {
+    keys: any;
+    remaining: any;
+};
+export function textValue(text: any): string;
+export namespace FIELD_PRESETS {
+    namespace phone {
+        let label: string;
+        let label_es: string;
+        namespace profile {
+            let kind: string;
+        }
+        namespace digits {
+            let min: number;
+            let max: number;
+        }
+        let question: string;
+        let question_es: string;
+        let retry: string;
+        let retry_es: string;
+    }
+    namespace email {
+        let label_1: string;
+        export { label_1 as label };
+        let label_es_1: string;
+        export { label_es_1 as label_es };
+        export namespace profile_1 {
+            let kind_1: string;
+            export { kind_1 as kind };
+        }
+        export { profile_1 as profile };
+        let question_1: string;
+        export { question_1 as question };
+        let question_es_1: string;
+        export { question_es_1 as question_es };
+        let retry_1: string;
+        export { retry_1 as retry };
+        let retry_es_1: string;
+        export { retry_es_1 as retry_es };
+    }
+    namespace zip {
+        let label_2: string;
+        export { label_2 as label };
+        let label_es_2: string;
+        export { label_es_2 as label_es };
+        export namespace profile_2 {
+            let kind_2: string;
+            export { kind_2 as kind };
+            let min_1: number;
+            export { min_1 as min };
+            let max_1: number;
+            export { max_1 as max };
+        }
+        export { profile_2 as profile };
+        export namespace digits_1 {
+            let min_2: number;
+            export { min_2 as min };
+            let max_2: number;
+            export { max_2 as max };
+        }
+        export { digits_1 as digits };
+        let question_2: string;
+        export { question_2 as question };
+        let question_es_2: string;
+        export { question_es_2 as question_es };
+        let retry_2: string;
+        export { retry_2 as retry };
+        let retry_es_2: string;
+        export { retry_es_2 as retry_es };
+    }
+    namespace account_number {
+        let label_3: string;
+        export { label_3 as label };
+        let label_es_3: string;
+        export { label_es_3 as label_es };
+        export namespace profile_3 {
+            let kind_3: string;
+            export { kind_3 as kind };
+            export let pattern: string;
+        }
+        export { profile_3 as profile };
+        export namespace digits_2 {
+            let min_3: number;
+            export { min_3 as min };
+            let max_3: number;
+            export { max_3 as max };
+        }
+        export { digits_2 as digits };
+        let question_3: string;
+        export { question_3 as question };
+        let question_es_3: string;
+        export { question_es_3 as question_es };
+        let retry_3: string;
+        export { retry_3 as retry };
+        let retry_es_3: string;
+        export { retry_es_3 as retry_es };
+    }
+    namespace ssn_last4 {
+        let label_4: string;
+        export { label_4 as label };
+        let label_es_4: string;
+        export { label_es_4 as label_es };
+        export namespace profile_4 {
+            let kind_4: string;
+            export { kind_4 as kind };
+            let min_4: number;
+            export { min_4 as min };
+            let max_4: number;
+            export { max_4 as max };
+        }
+        export { profile_4 as profile };
+        export namespace digits_3 {
+            let min_5: number;
+            export { min_5 as min };
+            let max_5: number;
+            export { max_5 as max };
+        }
+        export { digits_3 as digits };
+        export let pii: boolean;
+        let question_4: string;
+        export { question_4 as question };
+        let question_es_4: string;
+        export { question_es_4 as question_es };
+    }
+    namespace amount {
+        let label_5: string;
+        export { label_5 as label };
+        let label_es_5: string;
+        export { label_es_5 as label_es };
+        export namespace profile_5 {
+            let kind_5: string;
+            export { kind_5 as kind };
+            let min_6: number;
+            export { min_6 as min };
+        }
+        export { profile_5 as profile };
+        let amount_1: boolean;
+        export { amount_1 as amount };
+        let question_5: string;
+        export { question_5 as question };
+        let question_es_5: string;
+        export { question_es_5 as question_es };
+    }
+    namespace street_address {
+        let label_6: string;
+        export { label_6 as label };
+        let label_es_6: string;
+        export { label_es_6 as label_es };
+        export namespace profile_6 {
+            let kind_6: string;
+            export { kind_6 as kind };
+        }
+        export { profile_6 as profile };
+        let question_6: string;
+        export { question_6 as question };
+        let question_es_6: string;
+        export { question_es_6 as question_es };
+    }
+    namespace city {
+        let label_7: string;
+        export { label_7 as label };
+        let label_es_7: string;
+        export { label_es_7 as label_es };
+        export namespace profile_7 {
+            let kind_7: string;
+            export { kind_7 as kind };
+        }
+        export { profile_7 as profile };
+        let question_7: string;
+        export { question_7 as question };
+        let question_es_7: string;
+        export { question_es_7 as question_es };
+    }
+    namespace state {
+        let label_8: string;
+        export { label_8 as label };
+        let label_es_8: string;
+        export { label_es_8 as label_es };
+        export namespace profile_8 {
+            let kind_8: string;
+            export { kind_8 as kind };
+            export let regex: string;
+        }
+        export { profile_8 as profile };
+        let question_8: string;
+        export { question_8 as question };
+        let question_es_8: string;
+        export { question_es_8 as question_es };
+    }
+    namespace card_number {
+        let label_9: string;
+        export { label_9 as label };
+        let label_es_9: string;
+        export { label_es_9 as label_es };
+        export namespace profile_9 {
+            let kind_9: string;
+            export { kind_9 as kind };
+            let min_7: number;
+            export { min_7 as min };
+            let max_6: number;
+            export { max_6 as max };
+        }
+        export { profile_9 as profile };
+        export namespace digits_4 {
+            let min_8: number;
+            export { min_8 as min };
+            let max_7: number;
+            export { max_7 as max };
+            export let complete: {
+                first: string;
+                lengths: number[];
+            }[];
+        }
+        export { digits_4 as digits };
+        let pii_1: boolean;
+        export { pii_1 as pii };
+        export let validator: string;
+        let question_9: string;
+        export { question_9 as question };
+        let question_es_9: string;
+        export { question_es_9 as question_es };
+        let retry_4: string;
+        export { retry_4 as retry };
+        let retry_es_4: string;
+        export { retry_es_4 as retry_es };
+    }
+    namespace card_expiration {
+        let label_10: string;
+        export { label_10 as label };
+        let label_es_10: string;
+        export { label_es_10 as label_es };
+        export namespace profile_10 {
+            let kind_10: string;
+            export { kind_10 as kind };
+            let regex_1: string;
+            export { regex_1 as regex };
+        }
+        export { profile_10 as profile };
+        export namespace digits_5 {
+            let min_9: number;
+            export { min_9 as min };
+            let max_8: number;
+            export { max_8 as max };
+        }
+        export { digits_5 as digits };
+        let validator_1: string;
+        export { validator_1 as validator };
+        let question_10: string;
+        export { question_10 as question };
+        let question_es_10: string;
+        export { question_es_10 as question_es };
+        let retry_5: string;
+        export { retry_5 as retry };
+        let retry_es_5: string;
+        export { retry_es_5 as retry_es };
+    }
+    namespace card_cvv {
+        let label_11: string;
+        export { label_11 as label };
+        let label_es_11: string;
+        export { label_es_11 as label_es };
+        export namespace profile_11 {
+            let kind_11: string;
+            export { kind_11 as kind };
+            let min_10: number;
+            export { min_10 as min };
+            let max_9: number;
+            export { max_9 as max };
+        }
+        export { profile_11 as profile };
+        export namespace digits_6 {
+            let min_11: number;
+            export { min_11 as min };
+            let max_10: number;
+            export { max_10 as max };
+        }
+        export { digits_6 as digits };
+        let pii_2: boolean;
+        export { pii_2 as pii };
+        let question_11: string;
+        export { question_11 as question };
+        let question_es_11: string;
+        export { question_es_11 as question_es };
+    }
+    namespace card_zip {
+        let label_12: string;
+        export { label_12 as label };
+        let label_es_12: string;
+        export { label_es_12 as label_es };
+        export namespace profile_12 {
+            let kind_12: string;
+            export { kind_12 as kind };
+            let min_12: number;
+            export { min_12 as min };
+            let max_11: number;
+            export { max_11 as max };
+        }
+        export { profile_12 as profile };
+        export namespace digits_7 {
+            let min_13: number;
+            export { min_13 as min };
+            let max_12: number;
+            export { max_12 as max };
+        }
+        export { digits_7 as digits };
+        let question_12: string;
+        export { question_12 as question };
+        let question_es_12: string;
+        export { question_es_12 as question_es };
+    }
+}
+export const FLOWS: ({
+    id: string;
+    name: string;
+    version: string;
+    scope: string;
+    description: string;
+    parameters: {
+        name: string;
+        type: string;
+    }[];
+    steps: ({
+        id: any;
+        type: string;
+        variable: any;
+        value: any;
+    } | {
+        parameters?: any;
+        initializeDefaults?: boolean | undefined;
+        id: any;
+        type: string;
+        value: any;
+        callType: string;
+    } | {
+        id: any;
+        type: string;
+        branches: {
+            [x: string]: any;
+            default: {
+                id: any;
+                type: string;
+                variable: any;
+                value: any;
+            };
+        };
+    })[];
+} | {
+    variables: any;
+    steps: any[];
+    prompt?: undefined;
+    prompt_es?: undefined;
+    primary?: boolean | undefined;
+    id: any;
+    name: any;
+    version: any;
+    description: any;
+    scope: string;
+    metadata: {
+        formProtocol: number;
+    };
+    parameters: any[];
+} | {
+    variables: any;
+    id: string;
+    name: string;
+    version: string;
+    description: string;
+    parameters: {
+        name: string;
+        type: string;
+        description: string;
+    }[];
+    steps: ({
+        id: any;
+        type: string;
+        variable: any;
+        value: any;
+    } | {
+        parameters?: any;
+        initializeDefaults?: boolean | undefined;
+        id: any;
+        type: string;
+        value: any;
+        callType: string;
+    } | {
+        id: any;
+        type: string;
+        branches: {
+            [x: string]: any;
+            default: {
+                id: any;
+                type: string;
+                variable: any;
+                value: any;
+            };
+        };
+    } | {
+        id: string;
+        type: string;
+        branches: {
+            'condition: rf_next_form': {
+                parameters?: any;
+                initializeDefaults?: boolean | undefined;
+                id: any;
+                type: string;
+                value: any;
+                callType: string;
+            };
+            default: {
+                parameters?: any;
+                initializeDefaults?: boolean | undefined;
+                id: any;
+                type: string;
+                value: any;
+                callType: string;
+            };
+        };
+    })[];
+} | {
+    variables: any;
+    id: string;
+    name: string;
+    version: string;
+    scope: string;
+    description: string;
+    parameters: {
+        name: string;
+        type: string;
+        description: string;
+    }[];
+    steps: ({
+        id: any;
+        type: string;
+        variable: any;
+        value: any;
+    } | {
+        parameters?: any;
+        initializeDefaults?: boolean | undefined;
+        id: any;
+        type: string;
+        value: any;
+        callType: string;
+    } | {
+        id: any;
+        type: string;
+        branches: {
+            [x: string]: any;
+            default: {
+                id: any;
+                type: string;
+                variable: any;
+                value: any;
+            };
+        };
+    } | {
+        id: string;
+        type: string;
+        branches: {
+            'condition: pm_keys.length > 0': {
+                parameters?: any;
+                initializeDefaults?: boolean | undefined;
+                id: any;
+                type: string;
+                value: any;
+                callType: string;
+            };
+            'condition: pm_flow': {
+                parameters?: any;
+                initializeDefaults?: boolean | undefined;
+                id: any;
+                type: string;
+                value: any;
+                callType: string;
+            };
+            "condition: pm_key === 'done'": {
+                id: string;
+                type: string;
+                value: string;
+                value_es: string;
+                outcome: string;
+            };
+            "condition: /[a-z\u00E1\u00E9\u00ED\u00F3\u00FA\u00FC\u00F1]/i.test(String(cargo.choiceText || ''))": {
+                id: string;
+                type: string;
+            };
+            "condition: retry !== '1'": {
+                parameters?: any;
+                initializeDefaults?: boolean | undefined;
+                id: any;
+                type: string;
+                value: any;
+                callType: string;
+            };
+            default: {
+                id: string;
+                type: string;
+                value: string;
+                value_es: string;
+            };
+        };
+    })[];
+} | {
+    variables: any;
+    id: string;
+    name: string;
+    version: string;
+    scope: string;
+    description: string;
+    parameters: {
+        name: string;
+        type: string;
+    }[];
+    steps: ({
+        id: any;
+        type: string;
+        variable: any;
+        value: any;
+    } | {
+        parameters?: any;
+        initializeDefaults?: boolean | undefined;
+        id: any;
+        type: string;
+        value: any;
+        callType: string;
+    } | {
+        id: any;
+        type: string;
+        branches: {
+            [x: string]: any;
+            default: {
+                id: any;
+                type: string;
+                variable: any;
+                value: any;
+            };
+        };
+    })[];
+})[];
+//# sourceMappingURL=flows.d.ts.map

package/dist/forms/flows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flows.d.ts","sourceRoot":"","sources":["../../src/forms/flows.js"],"names":[],"mappings":"AAsFA;;;;;;GAMG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2DC;AACD;;;GAGG;AACH;;;;;;EAGC;AAiSD,wHAAwH;AACxH,wEAaC;AACD,4FAA4F;AAC5F;;;EAYC;AACD,sGAAsG;AACtG;;;EAOC;AAlcM,6CAAuG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAknB9G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAOG"}