@inploi/plugin-chatbot 3.30.0 → 4.0.0

package/dist/chatbot.api.d.ts

@@ -2400,8 +2400,8 @@ export declare const FlowByJobPayloadSchema: import("valibot").ObjectSchema<{
         id: import("valibot").StringSchema<string>;
         title: import("valibot").StringSchema<string>;
     }, undefined, {
-        id: string;
         title: string;
+        id: string;
     }>;
 }, undefined, {
     flow: {
@@ -2645,8 +2645,8 @@ export declare const FlowByJobPayloadSchema: import("valibot").ObjectSchema<{
         name: string;
     };
     job: {
-        id: string;
         title: string;
+        id: string;
     };
 }>;
 export type JobApplication = {

package/dist/chatbot.constants.d.ts

@@ -1,7 +1,2 @@
-export declare const CHATBOT_ELEMENT_ID = "isdk";
-export declare const ERROR_MESSAGES: {
-    not_in_local_storage: string;
-    invalid_end_node: string;
-    no_submissions: string;
-    invalid_state: string;
-};
+export declare const CHATBOT_WIDGET_ID = "inploi-chatbot";
+export declare const CHATBOT_SELECTOR = "[data-widget='inploi-chatbot']";

package/dist/chatbot.d.ts

@@ -1,11 +1,29 @@
+import type { FeedbackPlugin, FeedbackPluginParams } from '@inploi/plugin-feedback';
 import { Logger } from '@inploi/sdk';
 import { Flow } from './chatbot.api';
 import { ChatbotDomManager } from './chatbot.dom';
+import { ChatbotTranslationTerms } from './i18n';
 type RemoveInternal<T extends object> = {
     [P in keyof T as string extends P ? never : P extends `_${string}` ? never : P]: T[P];
 };
+type InternalChatbotPluginParams = {
+    theme: {
+        /** Rotation for the hue. Between 0 and 360. */
+        hue: number;
+        /** Chroma multiplier. Values between 0 and 1.5 work best. */
+        chroma?: number;
+        mode: 'light' | 'dark';
+    };
+    feedback?: {
+        plugin: FeedbackPlugin;
+        params?: Pick<FeedbackPluginParams, 'terms'>;
+    };
+    terms?: ChatbotTranslationTerms;
+    /** @deprecated For internal usage only */
+    _internal_domManager?: ChatbotDomManager;
+};
 export type ChatbotPlugin = typeof chatbotPlugin;
-export type ChatbotPluginParams = RemoveInternal<Parameters<ChatbotPlugin>[0]>;
+export type ChatbotPluginParams = RemoveInternal<InternalChatbotPluginParams>;
 export type Chatbot = ReturnType<ReturnType<ChatbotPlugin>>;
 export type OpenChatbotParams = {
     flow: Flow;
@@ -29,19 +47,11 @@ export type OpenChatbotParams = {
         id_type: 'internal' | 'external';
     };
 };
-export declare const chatbotPlugin: ({ _internal_domManager: dom, theme, }: {
-    theme: {
-        /** Rotation for the hue. Between 0 and 360. */
-        hue: number;
-        /** Chroma multiplier. Values between 0 and 1.5 work best. */
-        chroma?: number;
-        mode: 'light' | 'dark';
-    };
-    /** @deprecated For internal usage only */
-    _internal_domManager?: ChatbotDomManager;
-}) => ({ apiClient, logger, analytics }: {
+export declare const chatbotPlugin: ({ _internal_domManager: dom, theme, terms, feedback, }: InternalChatbotPluginParams) => ({ apiClient, logger, analytics }: {
     apiClient: import("@inploi/sdk").ApiClient;
-    logger: Logger;
+    logger: Logger; /** 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.
+     */
     analytics: import("@inploi/sdk").AnalyticsService;
 }) => {
     /** Optionally eagerly renders the interface ahead of needing the chatbot. */

package/dist/chatbot.dom.d.ts

@@ -1,4 +1,4 @@
 export declare const createChatbotDomManager: () => {
-    getOrCreateChatbotElement: () => HTMLElement;
+    getOrCreateChatbotElement: () => Element;
 };
 export type ChatbotDomManager = ReturnType<typeof createChatbotDomManager>;

package/dist/chatbot.utils.d.ts

@@ -229,7 +229,7 @@ export declare const getHeadOrThrow: (nodes: FlowNode[]) => {
     nextId?: string | undefined;
 };
 export declare const getFlowSubmissionsPayload: (submissions: KeyToSubmissionMap) => Record<string, unknown>;
-export declare const isSubmissionOfType: <T extends "string" | "number" | "boolean" | "enum" | "phone" | "address" | "file" | "integration">(type: T) => (submission?: FlowSubmission) => submission is Extract<import("./chatbot.state").FlowSubmissionString, {
+export declare const isSubmissionOfType: <T extends "string" | "number" | "boolean" | "address" | "enum" | "phone" | "file" | "integration">(type: T) => (submission?: FlowSubmission) => submission is Extract<import("./chatbot.state").FlowSubmissionString, {
     type: T;
 }> | Extract<import("./chatbot.state").FlowSubmissionBoolean, {
     type: T;

package/dist/components/chatbot.d.ts

@@ -1,8 +1,10 @@
 import { AnalyticsService, ApiClient, Logger } from '@inploi/sdk';
+import { ChatbotPluginParams } from '..';
 type ChatbotProps = {
     apiClient: ApiClient;
     logger: Logger;
     analytics: AnalyticsService;
+    params: ChatbotPluginParams;
 };
-export declare const Chatbot: ({ logger, apiClient, analytics }: ChatbotProps) => import("preact/compat").JSX.Element;
+export declare const Chatbot: ({ logger, apiClient, analytics, params }: ChatbotProps) => import("preact/compat").JSX.Element;
 export {};

package/dist/components/status-bar.d.ts

@@ -1,4 +1,6 @@
 import { ComponentChildren } from 'preact';
-export declare const StatusBar: ({ children }: {
+import { ChatbotPluginParams } from '..';
+export declare const StatusBar: ({ children, params }: {
     children?: ComponentChildren;
+    params: ChatbotPluginParams;
 }) => import("preact").JSX.Element;

package/dist/i18n.d.ts

@@ -0,0 +1,271 @@
+export declare const TranslationProvider: (props: {
+    terms?: Partial<import("i18n").TranslationDict<{
+        readonly error_heading: "Something unexpected happened";
+        readonly undo: "Undo";
+        readonly send: "Send";
+        readonly skip: "Skip";
+        readonly skipped: "Skipped";
+        readonly submission_redirect_message: "Almost there! Please complete your submission here:";
+        readonly complete_submission: "Complete submission";
+        readonly submission_completed: "Submission completed!";
+        readonly submission_failed: "Failed to submit";
+        readonly maximize: "Maximise";
+        readonly minimize: "Minimise";
+        readonly close_application: "Close application";
+        readonly applying_for: "Applying for “{{title}}”";
+        /** When an application is at an invalid state, the user will get this error. */
+        readonly invalid_state: "Invalid application state";
+        readonly redirect_url_error: "Couldn’t get the redirect URL.";
+        readonly upload_file: {
+            readonly one: "Select file to upload";
+            readonly other: "Select files to upload";
+        };
+        readonly file_max_size: "max {{size}}";
+        readonly file_extensions: "Accepted file extensions";
+        readonly address_error: "Something went wrong! Plase continue manually";
+        readonly address_search: "Type and search for places…";
+        readonly address_manual: "Fill in manually";
+        readonly back: "Back";
+        readonly search: "Search";
+        readonly unknown_error: "An error occurred";
+        readonly validation_max_chars: "Please enter no more than {{count}} characters";
+        readonly validation_min_chars: "Please enter {{count}} or more characters";
+        readonly validation_phone: "Please enter a valid phone number";
+        readonly validation_country_code: "Please select a country code";
+        readonly validation_number: "Please enter a valid number";
+        readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+        readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+        readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+        readonly validation_file: "Please select a file";
+        readonly validation_file_ext: "Please only upload {{ext}} files";
+        readonly validation_file_max: {
+            readonly one: "Please only upload one file";
+            readonly other: "Please only upload up to {{count}} files";
+        };
+    }>> | undefined;
+    locale: string | undefined;
+    children?: import("preact").ComponentChildren;
+}) => import("preact").JSX.Element, useTranslation: <T extends {
+    readonly error_heading: "Something unexpected happened";
+    readonly undo: "Undo";
+    readonly send: "Send";
+    readonly skip: "Skip";
+    readonly skipped: "Skipped";
+    readonly submission_redirect_message: "Almost there! Please complete your submission here:";
+    readonly complete_submission: "Complete submission";
+    readonly submission_completed: "Submission completed!";
+    readonly submission_failed: "Failed to submit";
+    readonly maximize: "Maximise";
+    readonly minimize: "Minimise";
+    readonly close_application: "Close application";
+    readonly applying_for: "Applying for “{{title}}”";
+    /** When an application is at an invalid state, the user will get this error. */
+    readonly invalid_state: "Invalid application state";
+    readonly redirect_url_error: "Couldn’t get the redirect URL.";
+    readonly upload_file: {
+        readonly one: "Select file to upload";
+        readonly other: "Select files to upload";
+    };
+    readonly file_max_size: "max {{size}}";
+    readonly file_extensions: "Accepted file extensions";
+    readonly address_error: "Something went wrong! Plase continue manually";
+    readonly address_search: "Type and search for places…";
+    readonly address_manual: "Fill in manually";
+    readonly back: "Back";
+    readonly search: "Search";
+    readonly unknown_error: "An error occurred";
+    readonly validation_max_chars: "Please enter no more than {{count}} characters";
+    readonly validation_min_chars: "Please enter {{count}} or more characters";
+    readonly validation_phone: "Please enter a valid phone number";
+    readonly validation_country_code: "Please select a country code";
+    readonly validation_number: "Please enter a valid number";
+    readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+    readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+    readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+    readonly validation_file: "Please select a file";
+    readonly validation_file_ext: "Please only upload {{ext}} files";
+    readonly validation_file_max: {
+        readonly one: "Please only upload one file";
+        readonly other: "Please only upload up to {{count}} files";
+    };
+} = {
+    readonly error_heading: "Something unexpected happened";
+    readonly undo: "Undo";
+    readonly send: "Send";
+    readonly skip: "Skip";
+    readonly skipped: "Skipped";
+    readonly submission_redirect_message: "Almost there! Please complete your submission here:";
+    readonly complete_submission: "Complete submission";
+    readonly submission_completed: "Submission completed!";
+    readonly submission_failed: "Failed to submit";
+    readonly maximize: "Maximise";
+    readonly minimize: "Minimise";
+    readonly close_application: "Close application";
+    readonly applying_for: "Applying for “{{title}}”";
+    /** When an application is at an invalid state, the user will get this error. */
+    readonly invalid_state: "Invalid application state";
+    readonly redirect_url_error: "Couldn’t get the redirect URL.";
+    readonly upload_file: {
+        readonly one: "Select file to upload";
+        readonly other: "Select files to upload";
+    };
+    readonly file_max_size: "max {{size}}";
+    readonly file_extensions: "Accepted file extensions";
+    readonly address_error: "Something went wrong! Plase continue manually";
+    readonly address_search: "Type and search for places…";
+    readonly address_manual: "Fill in manually";
+    readonly back: "Back";
+    readonly search: "Search";
+    readonly unknown_error: "An error occurred";
+    readonly validation_max_chars: "Please enter no more than {{count}} characters";
+    readonly validation_min_chars: "Please enter {{count}} or more characters";
+    readonly validation_phone: "Please enter a valid phone number";
+    readonly validation_country_code: "Please select a country code";
+    readonly validation_number: "Please enter a valid number";
+    readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+    readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+    readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+    readonly validation_file: "Please select a file";
+    readonly validation_file_ext: "Please only upload {{ext}} files";
+    readonly validation_file_max: {
+        readonly one: "Please only upload one file";
+        readonly other: "Please only upload up to {{count}} files";
+    };
+}>() => {
+    t: import("i18n").TFn<T>;
+    locale: string | undefined;
+}, createTFunction: <T extends {
+    readonly error_heading: "Something unexpected happened";
+    readonly undo: "Undo";
+    readonly send: "Send";
+    readonly skip: "Skip";
+    readonly skipped: "Skipped";
+    readonly submission_redirect_message: "Almost there! Please complete your submission here:";
+    readonly complete_submission: "Complete submission";
+    readonly submission_completed: "Submission completed!";
+    readonly submission_failed: "Failed to submit";
+    readonly maximize: "Maximise";
+    readonly minimize: "Minimise";
+    readonly close_application: "Close application";
+    readonly applying_for: "Applying for “{{title}}”";
+    /** When an application is at an invalid state, the user will get this error. */
+    readonly invalid_state: "Invalid application state";
+    readonly redirect_url_error: "Couldn’t get the redirect URL.";
+    readonly upload_file: {
+        readonly one: "Select file to upload";
+        readonly other: "Select files to upload";
+    };
+    readonly file_max_size: "max {{size}}";
+    readonly file_extensions: "Accepted file extensions";
+    readonly address_error: "Something went wrong! Plase continue manually";
+    readonly address_search: "Type and search for places…";
+    readonly address_manual: "Fill in manually";
+    readonly back: "Back";
+    readonly search: "Search";
+    readonly unknown_error: "An error occurred";
+    readonly validation_max_chars: "Please enter no more than {{count}} characters";
+    readonly validation_min_chars: "Please enter {{count}} or more characters";
+    readonly validation_phone: "Please enter a valid phone number";
+    readonly validation_country_code: "Please select a country code";
+    readonly validation_number: "Please enter a valid number";
+    readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+    readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+    readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+    readonly validation_file: "Please select a file";
+    readonly validation_file_ext: "Please only upload {{ext}} files";
+    readonly validation_file_max: {
+        readonly one: "Please only upload one file";
+        readonly other: "Please only upload up to {{count}} files";
+    };
+} = {
+    readonly error_heading: "Something unexpected happened";
+    readonly undo: "Undo";
+    readonly send: "Send";
+    readonly skip: "Skip";
+    readonly skipped: "Skipped";
+    readonly submission_redirect_message: "Almost there! Please complete your submission here:";
+    readonly complete_submission: "Complete submission";
+    readonly submission_completed: "Submission completed!";
+    readonly submission_failed: "Failed to submit";
+    readonly maximize: "Maximise";
+    readonly minimize: "Minimise";
+    readonly close_application: "Close application";
+    readonly applying_for: "Applying for “{{title}}”";
+    /** When an application is at an invalid state, the user will get this error. */
+    readonly invalid_state: "Invalid application state";
+    readonly redirect_url_error: "Couldn’t get the redirect URL.";
+    readonly upload_file: {
+        readonly one: "Select file to upload";
+        readonly other: "Select files to upload";
+    };
+    readonly file_max_size: "max {{size}}";
+    readonly file_extensions: "Accepted file extensions";
+    readonly address_error: "Something went wrong! Plase continue manually";
+    readonly address_search: "Type and search for places…";
+    readonly address_manual: "Fill in manually";
+    readonly back: "Back";
+    readonly search: "Search";
+    readonly unknown_error: "An error occurred";
+    readonly validation_max_chars: "Please enter no more than {{count}} characters";
+    readonly validation_min_chars: "Please enter {{count}} or more characters";
+    readonly validation_phone: "Please enter a valid phone number";
+    readonly validation_country_code: "Please select a country code";
+    readonly validation_number: "Please enter a valid number";
+    readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+    readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+    readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+    readonly validation_file: "Please select a file";
+    readonly validation_file_ext: "Please only upload {{ext}} files";
+    readonly validation_file_max: {
+        readonly one: "Please only upload one file";
+        readonly other: "Please only upload up to {{count}} files";
+    };
+}>(options: {
+    overrides: Partial<import("i18n").TranslationDict<{
+        readonly error_heading: "Something unexpected happened";
+        readonly undo: "Undo";
+        readonly send: "Send";
+        readonly skip: "Skip";
+        readonly skipped: "Skipped";
+        readonly submission_redirect_message: "Almost there! Please complete your submission here:";
+        readonly complete_submission: "Complete submission";
+        readonly submission_completed: "Submission completed!";
+        readonly submission_failed: "Failed to submit";
+        readonly maximize: "Maximise";
+        readonly minimize: "Minimise";
+        readonly close_application: "Close application";
+        readonly applying_for: "Applying for “{{title}}”";
+        /** When an application is at an invalid state, the user will get this error. */
+        readonly invalid_state: "Invalid application state";
+        readonly redirect_url_error: "Couldn’t get the redirect URL.";
+        readonly upload_file: {
+            readonly one: "Select file to upload";
+            readonly other: "Select files to upload";
+        };
+        readonly file_max_size: "max {{size}}";
+        readonly file_extensions: "Accepted file extensions";
+        readonly address_error: "Something went wrong! Plase continue manually";
+        readonly address_search: "Type and search for places…";
+        readonly address_manual: "Fill in manually";
+        readonly back: "Back";
+        readonly search: "Search";
+        readonly unknown_error: "An error occurred";
+        readonly validation_max_chars: "Please enter no more than {{count}} characters";
+        readonly validation_min_chars: "Please enter {{count}} or more characters";
+        readonly validation_phone: "Please enter a valid phone number";
+        readonly validation_country_code: "Please select a country code";
+        readonly validation_number: "Please enter a valid number";
+        readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+        readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+        readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+        readonly validation_file: "Please select a file";
+        readonly validation_file_ext: "Please only upload {{ext}} files";
+        readonly validation_file_max: {
+            readonly one: "Please only upload one file";
+            readonly other: "Please only upload up to {{count}} files";
+        };
+    }>>;
+    locale: string | undefined;
+}) => import("i18n").TFn<T>;
+export type TFunction = ReturnType<typeof useTranslation>['t'];
+export type ChatbotTranslationTerms = Parameters<typeof TranslationProvider>[0]['terms'];