@sapia-ai/chatbot 2.31.0

package/utils/messageBubble.d.ts

@@ -0,0 +1,11 @@
+import { BubbleStatus, MessageBubble, PiiQuestionType } from "@/types/Next";
+export declare const checkIfMessageIsAnswered: (status?: BubbleStatus) => boolean;
+export declare const checkIfMessageIsEditing: (status?: BubbleStatus) => boolean;
+export declare const checkIfIsPhoneNumberQuestion: (piiQuestionType?: PiiQuestionType) => boolean;
+export declare const checkIfIsEmailQuestion: (piiQuestionType?: PiiQuestionType) => boolean;
+export declare const checkIfIsFullNameQuestion: (piiQuestionType?: PiiQuestionType) => boolean;
+export declare const checkIfIsFirstNameQuestion: (piiQuestionType?: PiiQuestionType) => boolean;
+export declare const checkIfIsLastNameQuestion: (piiQuestionType?: PiiQuestionType) => boolean;
+export declare const checkIfIsLocationQuestion: (piiQuestionType?: PiiQuestionType) => boolean;
+export declare const checkIfSmsConsentMessage: (message: MessageBubble) => boolean;
+export declare const checkIfCustomerSatisfactionCommentFeedbackQuestion: (message: MessageBubble) => boolean;

package/utils/testUtils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get the customized css variable value from the html element
+ * @param element
+ * @param cssVariableName
+ */
+export declare const getHtmlElementCssVariable: (element: HTMLElement, cssVariableName: string) => string;

package/utils/translation/constants.d.ts

@@ -0,0 +1,10 @@
+export declare const SUPPORTED_LANGUAGE: readonly ["en-GB", "en-US", "fr", "es", "de", "fi", "da", "nl", "it", "sv", "nb", "pl"];
+export declare const FALLBACK_LANGUAGE = "en-US";
+export declare const FI_BUTTON_EDIT = "fi_button_edit";
+export declare const FI_BUTTON_CONTINUE = "fi_button_continue";
+export declare const FI_ERROR_AGC_TITLE = "fi_error_agcTitle";
+export declare const FI_ERROR_AGC_FIRST_MESSAGE = "fi_error_agcFirstMessage";
+export declare const FI_ERROR_AGC_SECOND_MESSAGE = "fi_error_agcSecondMessage";
+export declare const FI_ERROR_GENERAL_ERROR_TITLE = "fi_error_generalErrorTitle";
+export declare const FI_ERROR_EDIT_ANSWER_FAILED = "fi_error_editAnswerFailed";
+export declare const FI_ERROR_SEND_ANSWER_FAILED = "fi_error_sendAnswerFailed";

package/utils/translation/fallBackTranslation.d.ts

@@ -0,0 +1,136 @@
+/**
+ * We don't expect to use this file. In the worse case, we will use this file as the fallback language
+ * Using en-US as the fallback language
+ * This is copy latest from en-US.json in https://github.com/PredictiveHire/sapia-translation-config/tree/main/translation/fi
+ * This must be updated manually when translation is updated in the translation repo
+ */
+export declare const fallbackTranslation: {
+    fi_label_typing: string;
+    fi_label_enterResponse: string;
+    fi_error_notEnoughWords: string;
+    fi_error_notEnoughtWordsMin: string;
+    fi_error_notEnoughWordsEdit: string;
+    fi_error_notEnoughWordsEditNow: string;
+    fi_button_edit: string;
+    fi_button_continue: string;
+    fi_check_dontShow: string;
+    fi_alt_shortResponse: string;
+    fi_alt_goodResponse: string;
+    fi_alt_maxWords: string;
+    fi_button_recordVideo: string;
+    fi_button_record: string;
+    fi_button_play: string;
+    fi_button_retry: string;
+    fi_button_save: string;
+    fi_button_pause: string;
+    fi_button_help: string;
+    fi_button_stop: string;
+    fi_error_unsuccessfulRecord: string;
+    fi_button_ok: string;
+    fi_label_uploading: string;
+    fi_label_dontClose: string;
+    fi_toolTip_retry: string;
+    fi_error_finalRetry: string;
+    fi_error_noChances: string;
+    fi_button_cancel: string;
+    fi_toolTip_noRetry: string;
+    fi_label_editing: string;
+    fi_label_errorTitle: string;
+    fi_label_errorMessageInstruction: string;
+    fi_label_errorMessageUnsupportedBrowser: string;
+    fi_placeholder_demoNameInput: string;
+    fi_placeholder_demoEmailInput: string;
+    fi_label_demoWelcome: string;
+    fi_label_demoSapiaDescription: string;
+    fi_label_demoTestDescription: string;
+    fi_button_demoCI: string;
+    fi_button_demoCoachingInsights: string;
+    fi_button_demoVi: string;
+    fi_placeholder_dropdown: string;
+    fi_error_piiEmail: string;
+    fi_error_piiFullName: string;
+    fi_error_piiFirstName: string;
+    fi_error_piiLastName: string;
+    fi_error_piiPhoneNumber: string;
+    fi_label_cancelEditMobile: string;
+    fi_label_cancelEditDesktop: string;
+    fi_error_iosChromeNotSupport: string;
+    fi_error_iosChromeCopyLink: string;
+    fi_error_iosChromeOpenEmail: string;
+    fi_error_thankCustomer: string;
+    fi_tooltip_copiedUrl: string;
+    fi_button_copyUrl: string;
+    fi_error_mulTabsWarning: string;
+    fi_label_refreshBrowser: string;
+    fi_label_contactSupport: string;
+    fi_label_noRetry: string;
+    fi_label_webcamNotReady: string;
+    fi_label_recordRetryInstruction: string;
+    fi_label_stopRecordBeforePlay: string;
+    fi_error_playVideo: string;
+    fi_label_stopRecordBeforeSubmit: string;
+    fi_error_submitVideo: string;
+    fi_label_stopRecordBeforeRetry: string;
+    fi_label_warningCloseRecordModalTitle: string;
+    fi_label_warningCloseRecordModalMessage: string;
+    fi_button_confirmCloseRecord: string;
+    fi_button_cancelCloseRecord: string;
+    fi_label_uploadFailed: string;
+    fi_label_checkInternetCon: string;
+    fi_button_tryAgain: string;
+    fi_label_noRecordRemaining: string;
+    fi_label_completedAssessment: string;
+    fi_label_saveRecordMessage: string;
+    fi_error_editAnswerFailed: string;
+    fi_error_sendAnswerFailed: string;
+    fi_label_ratingMessage: string;
+    fi_button_submitRating: string;
+    fi_label_warningModalTitle: string;
+    fi_button_close: string;
+    fi_label_multiTabsWarning: string;
+    fi_error_startedAssessment: string;
+    fi_error_roleClosed: string;
+    fi_error_reuseComplete: string;
+    fi_label_unsupportedBrowserTitle: string;
+    fi_error_cohortClosedTitle: string;
+    fi_error_cohortClosedMessage: string;
+    fi_error_videoPlayback: string;
+    fi_label_tabClose: string;
+    fi_error_notEnoughWordsMin: string;
+    fi_error_notEnoughWordsAim: string;
+    fi_label_words_one: string;
+    fi_label_words_other: string;
+    fi_label_missingCohortId: string;
+    fi_error_agcTitle: string;
+    fi_error_agcFirstMessage: string;
+    fi_error_agcSecondMessage: string;
+    fi_error_generalErrorTitle: string;
+    fi_label_enterOrPasteResponse: string;
+    fi_label_welcomeBack: string;
+    fi_label_modalDescription: string;
+    fi_input_email: string;
+    fi_button_confirm: string;
+    fi_error_emailDoesNotMatch: string;
+    fi_label_languageSelectionWarning: string;
+    fi_placeholder_selectLanguage: string;
+    fi_label_languageSelectionWelcome: string;
+    fi_button_startMyInterview: string;
+    fi_alt_fullName: string;
+    fi_button_ignore: string;
+    fi_button_correct: string;
+    fi_alt_firstName: string;
+    fi_alt_lastName: string;
+    fi_dictation_deviceSelector_iOS: string;
+    fi_dictation_deviceSelector_iPad: string;
+    fi_dictation_deviceSelector_android: string;
+    fi_dictation_deviceSelector_desktop: string;
+    fi_dictation_content_iOS: string;
+    fi_dictation_content_iPad: string;
+    fi_dictation_content_android: string;
+    fi_dictation_content_desktop: string;
+    fi_dictation_deviceLabel: string;
+    fi_dictation_title: string;
+    fi_dictation_tip: string;
+    fi_dictation_how: string;
+    fi_label_enterOrSkipFeedback: string;
+};

package/utils/translation/translation.d.ts

@@ -0,0 +1,25 @@
+import { TOptions } from "i18next";
+import { SUPPORTED_LANGUAGE } from "./constants";
+export declare type SupportedLanguage = typeof SUPPORTED_LANGUAGE[number];
+declare type TranslationFile = {
+    [key: string]: string;
+};
+export declare class Translation {
+    private static instance;
+    private translationFile;
+    private translationFileCache;
+    private language;
+    private constructor();
+    static init(translationFile: {
+        [key: string]: string;
+    }, language: string): void;
+    static getInstance(): Translation;
+    setTranslationSource(translationFile: {
+        [key: string]: string;
+    }, language: string): void;
+    getLanguage(): string;
+    getTranslationFileByLanguage(language: string): TranslationFile;
+    private getPluralizationKey;
+    translate: (key: string, options?: TOptions) => string;
+}
+export {};

package/utils/utils.d.ts

@@ -0,0 +1,16 @@
+export declare const getEnv: (host: string) => string;
+export declare enum RegionCode {
+    "AU" = "au",
+    "EU" = "eu",
+    "US" = "us"
+}
+export declare enum Region {
+    "AU" = "ap-southeast-2",
+    "EU" = "eu-west-1",
+    "US" = "us-east-1"
+}
+/**
+ * We might have region or region code in url, we will convert them to aws region (chatbot region)
+ */
+export declare const convertToChatbotRegion: (regionString: string) => string;
+export declare const fakeAsyncFunc: (timeout?: number, callback?: () => void) => Promise<unknown>;

package/vite.chatbot.config.js

@@ -0,0 +1,90 @@
+import { getBabelOutputPlugin } from "@rollup/plugin-babel"
+import path from "path"
+import { defineConfig } from "vite"
+import cssInjectedByJsPlugin from "vite-plugin-css-injected-by-js"
+
+export default defineConfig({
+  // we build chatersertbot in single file, vite does not include css in js file we need to plugin to build js and css in 1 single js file
+  plugins: [cssInjectedByJsPlugin()],
+  build: {
+    target: "es5",
+    lib: {
+      entry: path.resolve(__dirname, "src/predictivehire.tsx"),
+      name: "PredictiveHire",
+      // We build and release 2 formats
+      // es is used for modern FE application tool such as React, Vue... which will use esm to import our lib e.g import {PHChatbot} from @predictivehire/chatbot
+      // umd is used for any browser in script tag
+      formats: ["es", "umd"],
+      fileName: format => {
+        if (format === "es") {
+          return "predictivehire.js"
+        } else {
+          return `predictivehire.${format}.js`
+        }
+      }
+    },
+    rollupOptions: {
+      external: ["react", "react-dom"],
+      output: {
+        exports: "named",
+        globals: {
+          react: "React",
+          "react-dom": "ReactDOM"
+        }
+      },
+      plugins: [
+        /**
+         * Running Babel on the generated code:
+         *  https://github.com/rollup/plugins/blob/master/packages/babel/README.md#running-babel-on-the-generated-code
+         *
+         * Transforming ES6+ syntax to ES5 is not supported yet, there are two ways to do:
+         *  https://github.com/evanw/esbuild/issues/1010#issuecomment-803865232
+         * We choose to run Babel on the output files after esbuild.
+         *
+         * @vitejs/plugin-legacy does not support library mode:
+         *  https://github.com/vitejs/vite/issues/1639
+         */
+        getBabelOutputPlugin({
+          allowAllFormats: true,
+          presets: [
+            [
+              "@babel/preset-env",
+              {
+                useBuiltIns: false, // Default：false
+                // Exclude transforms that make all code slower
+                exclude: ["transform-typeof-symbol"],
+                // https://babeljs.io/docs/en/babel-preset-env#modules
+                modules: false
+              }
+            ]
+          ]
+        })
+      ]
+    },
+    outDir: path.resolve(__dirname, "dist-chatbot"),
+    minify: true
+  },
+  resolve: {
+    extensions: [".tsx", ".ts", ".js"],
+    alias: {
+      "@": path.resolve(__dirname, "src")
+    }
+  },
+  css: {
+    preprocessorOptions: {
+      less: {
+        modifyVars: {
+          "@font-size-base": "16px",
+          "@primary-color": "#232FFD"
+        },
+        javascriptEnabled: true
+      }
+    }
+  },
+  optimizeDeps: {
+    include: ["antd"]
+  },
+  server: {
+    open: true
+  }
+})

package/vite.config.js

@@ -0,0 +1,77 @@
+import react from "@vitejs/plugin-react"
+import path from "path"
+import { defineConfig } from "vite"
+// eslint-disable-next-line import/default
+import checker from "vite-plugin-checker"
+// eslint-disable-next-line import/default
+import eslint from "vite-plugin-eslint"
+import { configDefaults } from "vitest/config"
+
+export default defineConfig(({ mode }) => {
+  return {
+    build: {
+      outDir: "build"
+    },
+    preview: {
+      port: 8080
+    },
+    server: {
+      port: 3000,
+      open: true,
+      allowedHosts: ["fi.localhost.com"]
+    },
+    resolve: {
+      alias: {
+        "@": path.resolve(__dirname, "./src"),
+        // @root point to dist-chatbot to use build version of chatbot when build and deploy this fi-widget to fi-widget.qa.predictivehive.com domain
+        "@root": mode === "production" ? path.resolve(__dirname, "dist-chatbot") : path.resolve(__dirname, "./src")
+      }
+    },
+    optimizeDeps: {
+      esbuildOptions: {
+        // Node.js global to browser globalThis
+        define: {
+          global: "globalThis"
+        }
+      }
+    },
+    define: {
+      "process.env": {}
+    },
+    plugins: [
+      checker({
+        typescript: true
+      }),
+      react(),
+      eslint()
+    ],
+    // Config for vitest
+    test: {
+      globals: true,
+      css: {
+        modules: {
+          // Does not use css module changing css class name because we have some tests using class name in assertions
+          // TODO: research more about best practices testing css especially css module
+          classNameStrategy: "non-scoped"
+        }
+      },
+      environment: "jsdom",
+      setupFiles: ["./src/vitest.setup.js"],
+      coverage: {
+        provider: "istanbul",
+        exclude: [
+          ...configDefaults.coverage.exclude,
+          "./vitest.setup.ts",
+          "**/src/config.ts",
+          "**/src/components/Icons/**",
+          "**/src/constants/**",
+          "**/src/styles/**",
+          "**/src/types/**",
+          "**/src/**/index.ts"
+        ],
+        // you can include other reporters, but 'json-summary' is required, json is recommended
+        reporter: ["text", "json-summary", "json"]
+      }
+    }
+  }
+})

package/vitest.setup.d.ts

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