@inploi/plugin-chatbot 3.2.5 → 3.2.6

package/dist/chatbot.api.d.ts

@@ -0,0 +1,30 @@
+import { FlowNode } from '@inploi/core/flows';
+import { ApiClient, Logger } from '@inploi/sdk';
+type Result<T> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+    error: string;
+};
+export type JobApplication = {
+    job: {
+        id: string;
+        title: string;
+    };
+    company: {
+        name: string;
+        logo?: string;
+    };
+    flow: {
+        id: string;
+        version: number;
+        nodes: FlowNode[];
+    };
+};
+export declare function getApplicationData({ jobId, apiClient, logger, }: {
+    jobId: string;
+    apiClient: ApiClient;
+    logger: Logger;
+}): Promise<Result<JobApplication>>;
+export {};

package/dist/chatbot.constants.d.ts

@@ -0,0 +1,8 @@
+export declare const CHATBOT_ELEMENT_ID = "isdk";
+export declare const HEADER_HEIGHT = 44;
+export declare const ERROR_MESSAGES: {
+    not_in_local_storage: string;
+    invalid_end_node: string;
+    no_submissions: string;
+    invalid_state: string;
+};

package/dist/chatbot.idb.d.ts

@@ -0,0 +1,9 @@
+import { JobApplication } from './chatbot.api';
+import { ApplicationData } from './chatbot.state';
+export declare const idb: {
+    getApplicationData: (application: JobApplication) => Promise<ApplicationData | undefined>;
+    setApplicationData: (params: {
+        application: JobApplication;
+        data: ApplicationData;
+    }) => Promise<void>;
+};

package/dist/chatbot.state.d.ts

@@ -0,0 +1,90 @@
+import { Signal } from '@preact/signals';
+import { JobApplication } from './chatbot.api';
+import { DistributivePick } from './chatbot.utils';
+import { ChatInput } from './ui/chat-input/chat-input';
+import { ChatbotInput } from './ui/chat-input/chat-input';
+export declare const getCacheKey: (application: JobApplication) => string;
+export type ViewState = 'maximised' | 'minimised';
+export declare const viewState: Signal<ViewState>;
+export declare const inputHeight: Signal<number>;
+export type StartedJobApplication = JobApplication & {
+    data: ApplicationData;
+    startedAt: Date;
+};
+type CurrentApplication = {
+    state: 'idle';
+    application?: never;
+    error?: never;
+} | {
+    state: 'loading';
+    application?: never;
+    error?: never;
+} | {
+    state: 'loaded';
+    application: StartedJobApplication;
+    error?: never;
+} | {
+    state: 'error';
+    application?: never;
+    error: string;
+};
+export declare const application: {
+    current$: Signal<CurrentApplication>;
+    start: (application: JobApplication) => Promise<void>;
+    cancel: () => void;
+    markAsFinished: () => Promise<void>;
+    setCurrentNodeId: (currentNodeId: string) => Promise<void>;
+    restart: () => void;
+    addMessage: (message: ChatMessage, groupId?: string) => Promise<void>;
+    /** Removes from the last message backwards, all the messages that have the groupId passed, until it reaches one that doesn't  */
+    removeLastGroupMessagesById: (groupId: string) => void;
+    setSubmission: (fieldKey: string, submission: ApplicationSubmission) => Promise<void>;
+    setInput: (input: ChatInput | undefined) => 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;
+};
+type LinkMessage = {
+    type: 'link';
+    href: string;
+    text: string;
+};
+type ImageMessage = {
+    author: MessageAuthor;
+    type: 'image';
+    url: string;
+    width: number;
+    height: number;
+};
+type FileMessage = {
+    author: MessageAuthor;
+    type: 'file';
+    fileName: string;
+    fileSizeKb: number;
+};
+export type ChatMessage = TextMessage | ImageMessage | SystemMessage | FileMessage | LinkMessage;
+export type ApplicationSubmission = DistributivePick<ChatbotInput, 'type' | 'value'>;
+export type KeyToSubmissionMap = {
+    [key: string]: ApplicationSubmission;
+};
+/** Dynamic part of an application */
+export type ApplicationData = {
+    /** History of messages left in the chat */
+    messages: (ChatMessage & {
+        groupId?: string;
+    })[];
+    submissions: KeyToSubmissionMap;
+    currentNodeId: string;
+    /** Needs to be separate because a node can have many inputs */
+    currentInput?: ChatInput;
+    isFinished: boolean;
+};
+export {};

package/dist/chatbot.utils.d.ts

@@ -0,0 +1,160 @@
+import { FlowNode } from '@inploi/core/flows';
+import { ApplicationSubmission, KeyToSubmissionMap } from './chatbot.state';
+export type DistributivePick<T, K extends keyof T> = T extends unknown ? Pick<T, K> : never;
+export declare const getHeadOrThrow: (nodes: FlowNode[]) => {
+    id: string;
+    data: {
+        text: string;
+    };
+    type: "text";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        systemMessage?: string | undefined;
+    };
+    type: "end-flow";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        type: "ats";
+    };
+    type: "submit";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        href: string;
+        cta: string;
+    };
+    type: "link";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        url: string;
+        width: number;
+        height: number;
+    };
+    type: "image";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        key: string;
+        question: string;
+        trueLabel: string;
+        falseLabel: string;
+    };
+    type: "question-boolean";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        key: string;
+        question: string;
+        format: "text" | "url" | "email" | "phone";
+        placeholder?: string | undefined;
+    };
+    type: "question-text";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        key: string;
+        question: string;
+        placeholder?: string | undefined;
+        decimalCases?: number | undefined;
+        min?: number | undefined;
+        max?: number | undefined;
+    };
+    type: "question-number";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        options: {
+            value: string;
+            label: string;
+        }[];
+        key: string;
+        question: string;
+        maxSelected: number;
+        minSelected: number;
+    };
+    type: "question-enum";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        key: string;
+        question: string;
+        extensions: string[];
+        multiple?: boolean | undefined;
+        maxSizeKb?: number | undefined;
+    };
+    type: "question-file";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        keys: {
+            line1: string;
+            line2: string;
+            line3: string;
+            city: string;
+            state: string;
+            postcode: string;
+            country: string;
+        };
+        question: string;
+        placeholder?: string | undefined;
+    };
+    type: "question-address";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        compareKey: string;
+        compareValue: string;
+        compare: "equals" | "notEquals" | "contains" | "notContains";
+    };
+    type: "if-block";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+    branchId?: string | undefined;
+} | {
+    id: string;
+    data: {
+        targetId: string;
+    };
+    type: "jump";
+    isHead?: boolean | undefined;
+    nextId?: string | undefined;
+};
+export declare const getApplicationSubmissionsPayload: (submissions: KeyToSubmissionMap) => Record<string, string | string[] | import("./ui/chat-input/chat-input.file").FileToUpload[]>;
+export declare const isSubmissionOfType: <T extends "boolean" | "text" | "multiple-choice" | "file">(type: T) => (submission?: ApplicationSubmission) => submission is Extract<Pick<import("./ui/chat-input/chat-input.text").TextPayload, "value" | "type">, {
+    type: T;
+}> | Extract<Pick<import("./ui/chat-input/chat-input.multiple-choice").MultipleChoicePayload, "value" | "type">, {
+    type: T;
+}> | Extract<Pick<import("./ui/chat-input/chat-input.boolean").BooleanChoicePayload, "value" | "type">, {
+    type: T;
+}> | Extract<Pick<import("./ui/chat-input/chat-input.file").FilePayload, "value" | "type">, {
+    type: T;
+}>;
+export declare function gzip(string: string): string | Promise<string>;
+export declare class AbortedError extends Error {
+    constructor();
+}