@inploi/plugin-chatbot 3.11.0 → 3.12.0

package/dist/chatbot.d.ts

@@ -1,3 +1,4 @@
+import { Flow } from './chatbot.api';
 import { ChatbotDomManager } from './chatbot.dom';
 type RemoveInternal<T extends object> = {
     [P in keyof T as string extends P ? never : P extends `_${string}` ? never : P]: T[P];
@@ -5,6 +6,18 @@ type RemoveInternal<T extends object> = {
 export type ChatbotPlugin = typeof chatbotPlugin;
 export type ChatbotPluginParams = RemoveInternal<Parameters<ChatbotPlugin>[0]>;
 export type Chatbot = ReturnType<ReturnType<ChatbotPlugin>>;
+export type OpenChatbotParams = {
+    flow: Flow;
+    /** Specify the cache keys for restoring this flow from local state.
+     *  This will be appended to the flow id and version passed to `flow` property.
+     *  @example [job.id] if you want the flows to be unique per job.
+     */
+    flowKeys: string[];
+    /** Context to be forwarded to analytics or used by nodes internally. */
+    context: Record<string, unknown>;
+    /** Title to display in the status bar */
+    title: string;
+};
 export declare const chatbotPlugin: ({ _internal_domManager: dom, theme, }: {
     theme: {
         /** Rotation for the hue. Between 0 and 360. */
@@ -22,11 +35,18 @@ export declare const chatbotPlugin: ({ _internal_domManager: dom, theme, }: {
     logger: import("@inploi/sdk").Logger;
     analytics: import("@inploi/sdk").AnalyticsService;
 }) => {
-    /** Optionally eagerly renders the interface ahead of application requests. */
+    /** Optionally eagerly renders the interface ahead of needing the chatbot. */
     prepare: () => Promise<void>;
-    startApplication: ({ jobId }: {
-        jobId: string;
-    }) => Promise<void>;
-    closeApplication: () => Promise<void>;
+    /** Fetches a flow by job ID.
+     *  @param jobId - The job ID to fetch the flow for. This is the job ID according to the **ATS**, and not the inploi job ID.
+     */
+    fetchFlowByJobId: (jobId: string) => Promise<OpenChatbotParams>;
+    fetchFlowById: (flowId: string) => Promise<OpenChatbotParams>;
+    open: (params: OpenChatbotParams | Promise<OpenChatbotParams>) => Promise<void>;
+    /** @deprecated - Please use `open` instead. */
+    startApplication: never;
+    /** @deprecated - Please use `close` instead */
+    closeApplication: never;
+    close: () => Promise<void>;
 };
 export {};

package/dist/chatbot.idb.d.ts

@@ -1,9 +1,17 @@
-import { JobApplication } from './chatbot.api';
-import { ApplicationData } from './chatbot.state';
+import { Flow } from './chatbot.api';
+import { ChatMessage, KeyToSubmissionMap, StartedFlow } from './chatbot.state';
+import { ChatInput } from './components/chat-input/chat-input';
 export declare const idb: {
-    getApplicationData: (application: JobApplication) => Promise<ApplicationData | undefined>;
-    setApplicationData: (params: {
-        application: JobApplication;
-        data: ApplicationData;
-    }) => Promise<void>;
+    getStateData: (flow: Flow, flowKeys: string[]) => Promise<{
+        currentInput: ChatInput | null;
+        nodeHistory: string[];
+        flowSessionId: string;
+        isFinished: boolean;
+        messages: (ChatMessage & {
+            groupId?: string;
+        })[];
+        sequence: number;
+        submissions: KeyToSubmissionMap;
+    } | undefined>;
+    setStateData: (params: StartedFlow) => Promise<string | undefined>;
 };

package/dist/chatbot.utils.d.ts

@@ -1,5 +1,5 @@
 import { FlowNode } from '@inploi/core/flows';
-import { ApplicationSubmission, KeyToSubmissionMap } from './chatbot.state';
+import { FlowSubmission, KeyToSubmissionMap } from './chatbot.state';
 export type DistributivePick<T, K extends keyof T> = T extends unknown ? Pick<T, K> : never;
 export declare const kbToReadableSize: (kb: number) => string;
 export declare const getHeadOrThrow: (nodes: FlowNode[]) => {
@@ -159,17 +159,20 @@ export declare const getHeadOrThrow: (nodes: FlowNode[]) => {
     isHead?: boolean | undefined;
     nextId?: string | undefined;
 };
-export declare const getApplicationSubmissionsPayload: (submissions: KeyToSubmissionMap) => Record<string, string | string[] | import("./components/chat-input/chat-input.file").FileToUpload[] | null>;
-export declare const isSubmissionOfType: <T extends "boolean" | "text" | "multiple-choice" | "file">(type: T) => (submission?: ApplicationSubmission) => submission is Extract<Pick<import("./components/chat-input/chat-input.text").TextPayload, "value" | "type">, {
+export declare const getFlowSubmissionsPayload: (submissions: KeyToSubmissionMap) => Record<string, string | string[] | import("./components/chat-input/chat-input.file").FileToUpload[] | null>;
+export declare const isSubmissionOfType: <T extends "boolean" | "text" | "multiple-choice" | "file" | "submit">(type: T) => (submission?: FlowSubmission) => submission is Extract<Pick<import("./components/chat-input/chat-input.text").TextPayload, "type" | "value">, {
     type: T;
-}> | Extract<Pick<import("./components/chat-input/chat-input.multiple-choice").MultipleChoicePayload, "value" | "type">, {
+}> | Extract<Pick<import("./components/chat-input/chat-input.multiple-choice").MultipleChoicePayload, "type" | "value">, {
     type: T;
-}> | Extract<Pick<import("./components/chat-input/chat-input.boolean").BooleanChoicePayload, "value" | "type">, {
+}> | Extract<Pick<import("./components/chat-input/chat-input.boolean").BooleanChoicePayload, "type" | "value">, {
     type: T;
-}> | Extract<Pick<import("./components/chat-input/chat-input.file").FilePayload, "value" | "type">, {
+}> | Extract<Pick<import("./components/chat-input/chat-input.file").FilePayload, "type" | "value">, {
+    type: T;
+}> | Extract<Pick<import("./components/chat-input/chat-input.submit").SubmitPayload, "type" | "value">, {
     type: T;
 }>;
 export declare function gzip(string: string): string | Promise<string>;
 export declare class AbortedError extends Error {
     constructor();
 }
+export declare function debounce<TFn extends (...params: any[]) => void>(func: TFn, timeout?: number): TFn;