@inploi/plugin-chatbot 14.8.0 → 14.10.0

package/dist/chatbot.utils.d.ts

@@ -1,260 +1,8 @@
-import { FlowNode } from '@inploi/core/flows';
-import { FlowStateData, FlowSubmission } from './chatbot.state';
+import { FlowStateData, FlowSubmission } from '@inploi/flows/engine';
 
-export type DistributivePick<T, K extends keyof T> = T extends unknown ? Pick<T, K> : never;
-export declare const getHeadOrThrow: (nodes: FlowNode[]) => {
-    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;
-};
 export declare const isSubmissionOfType: <T extends FlowSubmission["type"]>(type: T) => (submission?: FlowSubmission) => submission is Extract<FlowSubmission, {
     type: T;
 }>;
 export declare function gzip(string: string): string | Promise<string>;
-export declare class AbortedError extends Error {
-    constructor();
-}
 export declare const initialiseFlowStateData: () => FlowStateData;
 export declare const getFormSubmitter: (e: Event) => HTMLButtonElement | HTMLInputElement;

package/dist/components/chat-input/chat-input.address.d.ts

@@ -1,18 +1,5 @@
-import { QuestionAddressNode } from '@inploi/core/flows';
+import { AddressInputPayload } from '@inploi/flows/engine';
 import { JSX } from 'preact';
-import { FlowSubmissionAddress } from '../../chatbot.state';
 import { ChatInputProps } from './chat-input';
 
-export type AddressInputPayload = {
-    type: 'address';
-    /** submission id to wrap the address fields. */
-    key: string | undefined;
-    config: {
-        optional: boolean;
-        keys: QuestionAddressNode['data']['keys'];
-        line2Required?: boolean;
-        placeholder?: string;
-    };
-    submission: FlowSubmissionAddress | null;
-};
 export declare const ChatInputAddress: ({ input, onSubmitSuccess, logger }: ChatInputProps<AddressInputPayload>) => JSX.Element;

package/dist/components/chat-input/chat-input.boolean.d.ts

@@ -1,18 +1,6 @@
-import { FlowSubmissionBoolean } from '../../chatbot.state';
+import { BooleanChoicePayload } from '@inploi/flows/engine';
 import { ChatInputProps } from './chat-input';
 
-export type BooleanChoicePayload = {
-    type: 'boolean';
-    config: {
-        labels: {
-            true: string;
-            false: string;
-        };
-        optional: boolean;
-    };
-    key: string | undefined;
-    submission: FlowSubmissionBoolean | null;
-};
 export declare const booleanButtonListClass = "flex items-center flex-wrap gap-2 p-2.5";
 export declare const booleanButtonListItemClass = "min-w-0 max-w-full flex-auto";
 export declare const BooleanOption: import('preact').FunctionalComponent<Omit<import("preact").JSX.HTMLAttributes<HTMLButtonElement> & {

package/dist/components/chat-input/chat-input.d.ts

@@ -1,14 +1,5 @@
+import { ChatbotInput, FlowSubmission } from '@inploi/flows/engine';
 import { AnalyticsService, Logger } from '@inploi/sdk';
-import { DistributivePick } from '../../chatbot.utils';
-import { FlowSubmission } from '../../chatbot.state';
-import { AddressInputPayload } from './chat-input.address';
-import { BooleanChoicePayload } from './chat-input.boolean';
-import { FilePayload } from './chat-input.file';
-import { MultipleChoicePayload } from './chat-input.multiple-choice';
-import { NumberPayload } from './chat-input.number';
-import { PhonePayload } from './chat-input.phone-number';
-import { SubmitPayload } from './chat-input.submit';
-import { TextPayload } from './chat-input.text';
 
 export type SubmitSuccessFn = (submission: FlowSubmission | null) => void;
 export type ChatInputProps<T extends ChatbotInput> = {
@@ -17,6 +8,4 @@ export type ChatInputProps<T extends ChatbotInput> = {
     logger: Logger;
     analytics: Pick<AnalyticsService, 'log'>;
 };
-export type ChatbotInput = TextPayload | NumberPayload | MultipleChoicePayload | BooleanChoicePayload | FilePayload | SubmitPayload | AddressInputPayload | PhonePayload;
-export type ChatInput = DistributivePick<ChatbotInput, 'type' | 'config' | 'key'>;
 export declare const ChatInput: ({ logger, analytics }: Pick<ChatInputProps<ChatbotInput>, "logger" | "analytics">) => import("preact").JSX.Element;

package/dist/components/chat-input/chat-input.file.d.ts

@@ -1,18 +1,7 @@
+import { FilePayload, FileToUpload } from '@inploi/flows/engine';
 import { ComponentProps } from 'preact';
-import { FileToUpload, FlowSubmissionFile } from '../../chatbot.state';
 import { ChatInputProps } from './chat-input';
 
-export type FilePayload = {
-    type: 'file';
-    config: {
-        optional: boolean;
-        extensions: string[];
-        fileSizeLimitKib?: number;
-        allowMultiple: boolean;
-    };
-    key: string;
-    submission: FlowSubmissionFile | null;
-};
 export declare const FileThumbnail: ({ file, class: className, ...props }: ComponentProps<"div"> & {
     file: Pick<FileToUpload, "name" | "sizeKb">;
 }) => import("preact").JSX.Element;

package/dist/components/chat-input/chat-input.multiple-choice.d.ts

@@ -1,17 +1,4 @@
-import { FlowSubmissionEnum } from '../../chatbot.state';
+import { MultipleChoicePayload } from '@inploi/flows/engine';
 import { ChatInputProps } from './chat-input';
 
-export type MultipleChoicePayload = {
-    type: 'multiple-choice';
-    key: string | undefined;
-    config: {
-        options: {
-            value: string;
-            label: string;
-        }[];
-        minSelected?: number;
-        maxSelected?: number;
-    };
-    submission: FlowSubmissionEnum;
-};
 export declare const ChatInputMultipleChoice: ({ input, onSubmitSuccess }: ChatInputProps<MultipleChoicePayload>) => import("preact").JSX.Element;

package/dist/components/chat-input/chat-input.number.d.ts

@@ -1,17 +1,4 @@
-import { FlowSubmissionNumber } from '../../chatbot.state';
+import { NumberPayload } from '@inploi/flows/engine';
 import { ChatInputProps } from './chat-input';
 
-export type NumberPayload = {
-    type: 'number';
-    key: string | undefined;
-    config: {
-        optional: boolean;
-        placeholder?: string;
-        defaultValue?: string;
-        decimalCases?: number;
-        min?: number;
-        max?: number;
-    };
-    submission: FlowSubmissionNumber | null;
-};
 export declare const ChatInputNumber: ({ input, onSubmitSuccess }: ChatInputProps<NumberPayload>) => import("preact").JSX.Element;

package/dist/components/chat-input/chat-input.phone-number.d.ts

@@ -1,20 +1,4 @@
-import { FlowSubmissionPhone, FlowSubmissionString } from '../../chatbot.state';
+import { PhonePayload } from '@inploi/flows/engine';
 import { ChatInputProps } from './chat-input';
 
-export type PhonePayload = {
-    type: 'phone';
-    key: string | undefined;
-    config: {
-        optional: boolean;
-        submissionFormat: 'phone' | 'text';
-        placeholder?: string;
-        defaultValue: {
-            countryCode?: string;
-            phoneNumber?: string;
-        };
-        minChars?: number;
-        maxChars?: number;
-    };
-    submission: FlowSubmissionPhone | FlowSubmissionString | null;
-};
 export declare const ChatInputPhoneNumber: ({ input, onSubmitSuccess }: ChatInputProps<PhonePayload>) => import("preact").JSX.Element;

package/dist/components/chat-input/chat-input.submit.d.ts

@@ -1,13 +1,4 @@
+import { SubmitPayload } from '@inploi/flows/engine';
 import { ChatInputProps } from './chat-input';
 
-export type SubmitPayload = {
-    type: 'submit';
-    /** `availableAt` (epoch ms) keeps submit unavailable until then, after an unsuccessful attempt (PROD-7112). */
-    config: {
-        label: string;
-        availableAt?: number;
-    };
-    key: string | undefined;
-    submission: null;
-};
 export declare const ChatInputSubmit: ({ input, onSubmitSuccess }: ChatInputProps<SubmitPayload>) => import("preact").JSX.Element;

package/dist/components/chat-input/chat-input.text.d.ts

@@ -1,18 +1,5 @@
+import { TextPayload } from '@inploi/flows/engine';
 import { JSX } from 'preact';
-import { FlowSubmissionString } from '../../chatbot.state';
 import { ChatInputProps } from './chat-input';
 
-export type TextPayload = {
-    type: 'text';
-    key: string | undefined;
-    config: {
-        optional: boolean;
-        placeholder?: string;
-        format: 'date' | 'text' | 'email' | 'url';
-        defaultValue?: string;
-        maxChars: number | undefined;
-        minChars: number | undefined;
-    };
-    submission: FlowSubmissionString | null;
-};
 export declare const ChatInputText: ({ input, onSubmitSuccess }: ChatInputProps<TextPayload>) => JSX.Element;

package/dist/components/chat-input/chat-input.text.test.d.ts

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

package/dist/components/chatbot-body.lifecycle.test.d.ts

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

package/dist/components/message.link.d.ts

@@ -1,4 +1,4 @@
-import { LinkMessage as LinkMessageProps } from '../chatbot.state';
+import { LinkMessage as LinkMessageProps } from '@inploi/flows/engine';
 
 export declare const LinkMessage: ({ message }: {
     message: LinkMessageProps;

package/dist/components/useChatService.d.ts

@@ -1,10 +1,13 @@
-import { ChatService } from '../interpreter';
+import { ChatService } from '@inploi/flows/engine';
 import { SubmitSuccessFn } from './chat-input/chat-input';
 
 export declare const chatStore: {
     onSubmitSuccessFn$: import('@preact/signals').Signal<SubmitSuccessFn>;
     onInteractionFn$: import('@preact/signals').Signal<() => void>;
     isBotTyping$: import('@preact/signals').Signal<boolean>;
+    /** A Turnstile challenge is waiting for the candidate in the conversation (PROD-7320). */
+    captchaVisible$: import('@preact/signals').Signal<boolean>;
+    themeMode$: import('@preact/signals').Signal<"light" | "dark">;
     isReadingHistory$: import('@preact/signals').Signal<boolean>;
     scrollToEnd: () => void;
 };

package/dist/components/useChatService.test.d.ts

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