@inploi/plugin-chatbot 14.8.0 → 14.10.0

package/dist/chatbot.state.d.ts

@@ -1,6 +1,6 @@
+import { ApplicationRecovery, ChatInput, ChatMessage, FlowStateData, FlowSubmission } from '@inploi/flows/engine';
 import { OpenChatbotParams } from '.';
 import { Flow } from './chatbot.api';
-import { ChatInput } from './components/chat-input/chat-input';
 import { ChatbotFlowProgress } from './progress';
 
 export declare const getCacheKey: (flow: Pick<StartedFlow, "flowKeys" | "id" | "version" | "build" | "context">) => string;
@@ -14,8 +14,25 @@ export type StartedFlow = Flow & {
     locationOrigin: OpenChatbotParams['locationOrigin'];
     nodeIdToProgress: Record<string, ChatbotFlowProgress>;
     analytics: OpenChatbotParams['analytics'];
-};
-export declare const getCorrectionNodeId: (flow: StartedFlow) => string | undefined;
+    /**
+     * The candidate came back to a saved, unsubmitted application and has not yet chosen to continue it or start again
+     * (PROD-7338). Memory only, never in browser storage: asked on the first open after the page loads, not on a reopen.
+     */
+    offerResume?: boolean;
+};
+/**
+ * A saved application worth asking about when the candidate comes back: the candidate answered something, it is not finished, and no
+ * submit has started. A started write may have landed or succeeded, and its own guard already says so. Caches from
+ * before the write barrier existed count a visited submit node as started, as the interpreter does.
+ */
+export declare const hasUnfinishedApplication: ({ data, nodes }: Pick<StartedFlow, "data" | "nodes">) => boolean;
+/**
+ * A saved application still in the chatbot's hands: not finished, and the candidate answered something or a submit
+ * started (all questions may have been optional). Unlike the resume prompt's test, a started, pending or unknown
+ * submit counts, because only the chatbot holds its write barrier and recovery state (PROD-7342: such an application
+ * finishes in the chatbot).
+ */
+export declare const hasApplicationInProgress: ({ data, nodes }: Pick<StartedFlow, "data" | "nodes">) => boolean;
 type CurrentFlow = {
     state: 'idle';
     flow?: never;
@@ -35,277 +52,11 @@ type CurrentFlow = {
 };
 export declare const store: {
     current$: import('@preact/signals').Signal<CurrentFlow>;
-    viewState$: import('@preact/signals').Signal<"closed" | "maximised" | "minimised">;
-    prepareFlow: ({ flow, context, flowKeys, title, analytics, job, locationOrigin }: OpenChatbotParams) => Promise<{
-        data: FlowStateData;
-        startedAt: Date;
-        nodeIdToProgress: Record<string, ChatbotFlowProgress>;
-        flowKeys: string[];
-        id: string;
-        version: number;
-        nodes: ({
-            type: "flow-section";
-            id: string;
-            data: {
-                title: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "pre-apply-result";
-            id: string;
-            data: {
-                key: string;
-                participationKey: string;
-                messages: {
-                    hard: string;
-                    advisory: string;
-                    matched: string;
-                };
-                continueLabel: string;
-                alternativeLink?: {
-                    href: string;
-                    label: string;
-                } | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "text";
-            id: string;
-            data: {
-                text: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "end-flow";
-            id: string;
-            data: {
-                systemMessage: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "integration-application-submit";
-            id: string;
-            data: {
-                integrationId: string;
-                skipConfirmation: boolean;
-                submitLabel: string;
-                submitKeys: "all" | string[];
-                key?: string | undefined;
-                successMessage?: string | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "integration-workflow-get";
-            id: string;
-            data: {
-                integrationId: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "link";
-            id: string;
-            data: {
-                href: string;
-                cta: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "image";
-            id: string;
-            data: {
-                url: string;
-                width: number;
-                height: number;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "question-boolean";
-            id: string;
-            data: {
-                key: string;
-                question: string;
-                trueLabel: string;
-                falseLabel: string;
-                optional: boolean;
-                preApply?: {
-                    severity: "hard" | "advisory";
-                    mismatchMessage: string;
-                    expectedValue: boolean;
-                } | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "question-text";
-            id: string;
-            data: {
-                key: string;
-                question: string;
-                optional: boolean;
-                format: "date" | "text" | "url" | "email" | "phone";
-                placeholder?: string | undefined;
-                maxChars?: number | undefined;
-                minChars?: number | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "question-number";
-            id: string;
-            data: {
-                key: string;
-                question: string;
-                optional: boolean;
-                placeholder?: string | undefined;
-                decimalCases?: number | undefined;
-                min?: number | undefined;
-                max?: number | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "question-phone";
-            id: string;
-            data: {
-                key: string;
-                question: string;
-                optional: boolean;
-                placeholder: string;
-                minChars: number;
-                defaultCountryCode: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "question-enum";
-            id: string;
-            data: {
-                options: {
-                    value: string;
-                    label: string;
-                }[];
-                key: string;
-                question: string;
-                maxSelected: number;
-                minSelected: number;
-                preApply?: {
-                    severity: "hard" | "advisory";
-                    mismatchMessage: string;
-                    expectedValue: string;
-                } | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "question-file";
-            id: string;
-            data: {
-                key: string;
-                question: string;
-                optional: boolean;
-                extensions: string[];
-                multiple?: boolean | undefined;
-                maxSizeKb?: number | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "question-address";
-            id: string;
-            data: {
-                keys: {
-                    line1: string | null;
-                    line2: string | null;
-                    line3: string | null;
-                    city: string | null;
-                    state: string | null;
-                    postcode: string | null;
-                    country: string | null;
-                };
-                key: string;
-                question: string;
-                optional: boolean;
-                placeholder?: string | undefined;
-                line2Required?: boolean | undefined;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "if-block";
-            id: string;
-            data: {
-                compareKey: string;
-                compareValue: string;
-                compare: "equals" | "notEquals" | "contains" | "notContains" | "greaterThan" | "lessThan" | "greaterThanOrEqualTo" | "lessThanOrEqualTo";
-            } | {
-                combinator: "and" | "or";
-                conditions: {
-                    compareKey: string;
-                    compareValue: string;
-                    compare: "equals" | "notEquals" | "contains" | "notContains" | "greaterThan" | "lessThan" | "greaterThanOrEqualTo" | "lessThanOrEqualTo";
-                }[];
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-            branchId?: string | undefined;
-        } | {
-            type: "jump";
-            id: string;
-            data: {
-                targetId: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "add-submission";
-            id: string;
-            data: {
-                value: string;
-                key: string;
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "check-duplicate";
-            id: string;
-            data: {
-                key: string;
-                email: string;
-                scope: "job" | "company";
-            };
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        } | {
-            type: "feedback";
-            id: string;
-            data: {};
-            isHead?: boolean | undefined;
-            nextId?: string | undefined;
-        })[];
-        build: number;
-        context: Record<string, unknown>;
-        title: string;
-        analytics: {
-            customProperties?: Record<string, unknown>;
-        } | undefined;
-        job: {
-            id: string;
-            id_type: "internal" | "external";
-        } | undefined;
-        locationOrigin: {
-            lat?: number;
-            lng?: number;
-        } | undefined;
-    }>;
+    viewState$: import('@preact/signals').Signal<"maximised" | "minimised" | "closed">;
+    prepareFlow: ({ flow, context, flowKeys, title, analytics, job, locationOrigin, }: OpenChatbotParams) => Promise<StartedFlow>;
     commitFlow: (flow: StartedFlow) => void;
+    /** The candidate chose to continue or start again, so this page does not ask about this application again. */
+    settleResume: (flow: StartedFlow) => void;
     cancelCurrentFlow: () => void;
     markAsFinished: () => void;
     markAsInteracted: () => void;
@@ -319,135 +70,4 @@ export declare const store: {
     setInput: (input: ChatInput | undefined) => void;
     persistWriteBarrier: (flow: StartedFlow) => Promise<void>;
 };
-export type MessageAuthor = 'bot' | 'user';
-type SystemMessage = {
-    type: 'system';
-    text: string;
-    variant: 'info' | 'warning' | 'error' | 'success';
-};
-type TextMessage = {
-    author: MessageAuthor;
-    type: 'text';
-    text: string;
-};
-export type LinkMessage = {
-    type: 'link';
-    href: string;
-    text: string;
-    onClick?: () => void;
-};
-type ImageMessage = {
-    author: MessageAuthor;
-    type: 'image';
-    url: string;
-    width: number;
-    height: number;
-};
-type FileMessage = {
-    author: MessageAuthor;
-    type: 'file';
-    fileName: string;
-    fileSizeKb: number;
-};
-export type LoadingMessage = {
-    type: 'loading';
-    /** Shown beside the indicator and announced to screen readers. */ text?: string;
-};
-export type ChatMessage = TextMessage | ImageMessage | SystemMessage | FileMessage | LinkMessage | LoadingMessage;
-export type FileToUpload = {
-    name: string;
-    data: string;
-    sizeKb: number;
-};
-export type FlowSubmissionAddress = {
-    value: Record<string, string | undefined>;
-    type: 'address';
-};
-export type FlowSubmissionFile = {
-    value: FileToUpload[];
-    type: 'file';
-};
-export type FlowSubmissionString = {
-    value: string;
-    type: 'string';
-};
-export type FlowSubmissionBoolean = {
-    value: boolean;
-    type: 'boolean';
-};
-export type FlowSubmissionNumber = {
-    value: number;
-    type: 'number';
-};
-export type FlowSubmissionPhone = {
-    value: {
-        countryCode: string;
-        phoneNumber: string;
-    };
-    type: 'phone';
-};
-export type FlowSubmissionEnum = {
-    value: string[];
-    type: 'enum';
-};
-export type FlowSubmissionIntegration = {
-    value: unknown;
-    type: 'integration';
-};
-export type FlowSubmission = FlowSubmissionString | FlowSubmissionBoolean | FlowSubmissionNumber | FlowSubmissionPhone | FlowSubmissionEnum | FlowSubmissionAddress | FlowSubmissionFile | FlowSubmissionIntegration;
-export type KeyToSubmissionMap = {
-    [key: string]: FlowSubmission;
-};
-export type ApplicationRecovery = {
-    fileQuestionNodeId: string;
-    submitNodeId: string;
-};
-export type SubmitCooldown = {
-    key: string;
-    until: number;
-    /** Consecutive throttles or temporary outages behind this wait, when it follows one; it sets the next one (PROD-6636, PROD-7172). */
-    throttles?: number;
-};
-/** Dynamic part of a flow */
-export type FlowStateData = {
-    /** History of messages left in the chat */
-    messages: (ChatMessage & {
-        groupId?: string;
-    })[];
-    submissions: KeyToSubmissionMap;
-    nodeHistory: string[];
-    /**
-     * Browser replay barrier: submit nodes whose write has started, flushed to the flow cache before the POST so
-     * Undo and reload cannot resend a pending, accepted or unknown attempt. It is not proof that the provider
-     * accepted the application and not server idempotency: independent tabs, cleared storage and the memory-only
-     * fallback are not coordinated. An explicit not_submitted result releases only the attempt that added the
-     * entry. Caches from before this field infer it conservatively from visited submit nodes.
-     */
-    startedWriteNodeIds?: string[];
-    /**
-     * When the most recent unsuccessful submit of any kind, other than a duplicate, happened (epoch ms), by submit
-     * node (and job, when known) key. A duplicate within an hour of it is most likely that attempt having landed
-     * (PROD-7208). Kept across Restart, which is how a candidate retries after a failure; browser-local, like the barrier.
-     */
-    failedAttemptAt?: Record<string, number>;
-    /**
-     * Legacy, read-only: keys of attempts with an unknown or missing verdict, written before failures carried a time
-     * (PROD-7055). Still in candidates' browser storage; with no time to compare, a key here counts as a recent
-     * failure until a new failure on that key replaces it with a time in `failedAttemptAt`. Never added to.
-     */
-    unconfirmedAttemptKeys?: string[];
-    /**
-     * When submit becomes available again after an unsuccessful attempt, for the attempt key above (PROD-7112),
-     * and how many throttles or outages in a row led to it (PROD-6636, PROD-7172). Cleared by a success. Kept across Restart so neither
-     * Restart nor a reload skips the wait or resets the escalation; browser-local, like the barrier.
-     */
-    submitCooldown?: SubmitCooldown;
-    applicationRecovery?: ApplicationRecovery;
-    /** Needs to be separate because a node can have many inputs */
-    currentInput: ChatInput | null;
-    isFinished: boolean;
-    hasInteracted?: boolean;
-    sequence: number;
-    flowSessionId: string;
-};
 export {};

package/dist/chatbot.storage.test.d.ts

@@ -0,0 +1 @@
+export {};