feat: adding types for frontChat

examples/boot/index.ts

@@ -1,4 +1,5 @@
 import {boot} from '../../lib/helpers/boot';
+import {FrontChatCmdType} from '../../lib/types/front-chat-types';
 
 /*
  * Constants.
@@ -17,9 +18,9 @@ boot(document.body)
     // option to the 'init' command. The below callback is just an example of waiting for the chat widget to
     // be initialized, before performing another action.
     const onInitCompleted = () => {
-      frontChat('show');
+      frontChat(FrontChatCmdType.Show);
     };
 
-    frontChat('init', {chatId, onInitCompleted});
+    frontChat(FrontChatCmdType.Init, {chatId, onInitCompleted});
   })
   .catch(console.error);

examples/react-embed-front-chat/index.tsx

@@ -1,5 +1,7 @@
 import {useEffect, useRef} from 'react';
 
+import {FrontChatCmdType} from '../../lib/types/front-chat-types';
+
 /*
  * Constants.
  */
@@ -33,7 +35,7 @@ export function App() {
     scriptTag.setAttribute('type', 'text/javascript');
     scriptTag.setAttribute('src', scriptSrc);
     scriptTag.onload = () => {
-      iframe.contentWindow?.FrontChat?.('init', {
+      iframe.contentWindow?.FrontChat?.(FrontChatCmdType.Init, {
         chatId,
         useDefaultLauncher: false,
         shouldShowWindowOnLaunch: true,

examples/react-use-front-chat-boot/index.tsx

@@ -1,6 +1,7 @@
 import {useEffect, useState} from 'react';
 
 import {useFrontChatBoot} from '../../lib/hooks/use-front-chat-boot';
+import {FrontChatCmdType} from '../../lib/types/front-chat-types';
 
 /*
  * Constants.
@@ -34,7 +35,7 @@ export function App() {
       return;
     }
 
-    frontChat('show');
+    frontChat(FrontChatCmdType.Show);
     setIsWindowVisible;
   }, [frontChat, isInitialized, isWindowVisible]);
 

examples/react-verified-user/index.tsx

@@ -2,6 +2,7 @@ import {createHmac} from 'crypto';
 import {useEffect, useState} from 'react';
 
 import {useFrontChatBoot} from '../../lib/hooks/use-front-chat-boot';
+import {FrontChatCmdType} from '../../lib/types/front-chat-types';
 
 /*
  * Constants.
@@ -52,7 +53,7 @@ export function App() {
       return;
     }
 
-    frontChat('show');
+    frontChat(FrontChatCmdType.Show);
     setIsWindowVisible;
   }, [frontChat, isInitialized, isWindowVisible]);
 

lib/helpers/initialize/index.ts

@@ -1,3 +1,4 @@
+import {FrontChatCmdType} from '../../types/front-chat-types';
 import {boot} from '../boot';
 
 /*
@@ -7,5 +8,5 @@ import {boot} from '../boot';
 export async function initialize(chatId: string, element?: HTMLElement) {
   const frontChat = await boot(element);
 
-  frontChat('init', {chatId});
+  frontChat(FrontChatCmdType.Init, {chatId});
 }

lib/hooks/use-front-chat-boot/index.ts

@@ -1,7 +1,12 @@
 import {useEffect, useRef, useState} from 'react';
 
 import {boot} from '../../helpers/boot';
-import {type FrontChat, type FrontChatOptions, type FrontChatParams} from '../../types/front-chat-types';
+import {
+  type FrontChat,
+  FrontChatCmdType,
+  type FrontChatOptions,
+  type FrontChatParams
+} from '../../types/front-chat-types';
 
 /*
  * Types.
@@ -53,15 +58,15 @@ export function useFrontChatBoot(element?: HTMLElement, options?: FrontChatOptio
       return;
     }
 
-    if (cmdType === 'init') {
+    if (cmdType === FrontChatCmdType.Init) {
       const onInitCompleted = () => {
         setStatus(FrontChatStatusesEnum.INITIALIZED);
       };
 
       return window.FrontChat(cmdType, {...params, onInitCompleted});
     }
 
-    if (cmdType === 'shutdown') {
+    if (cmdType === FrontChatCmdType.Shutdown) {
       setStatus(FrontChatStatusesEnum.READY);
     }
 
@@ -73,7 +78,7 @@ export function useFrontChatBoot(element?: HTMLElement, options?: FrontChatOptio
       return;
     }
 
-    frontChat('init', params);
+    frontChat(FrontChatCmdType.Init, params);
   };
 
   return {

lib/types/front-chat-types/index.ts

@@ -12,11 +12,33 @@ declare global {
  * Types.
  */
 
+export enum FrontChatCommand {
+  Init = 'init',
+  Show = 'show',
+  Hide = 'hide',
+  Shutdown = 'shutdown'
+}
+
+export type FrontChatParams = {
+  chatId?: string;
+  userId?: string;
+  userHash?: string;
+  shouldShowWindowOnLaunch?: boolean;
+  shouldExpandOnShowWindow?: boolean;
+  shouldHideCloseButton?: boolean;
+  shouldHideExpandButton?: boolean;
+  welcomeMessageAppearance?: 'hidden' | 'always';
+  isMobileWebview?: boolean;
+  useDefaultLauncher?: boolean;
+  onInitCompleted?: () => void;
+  // Allow any other key with a value of string, boolean, object, or undefined
+  [key: string]: string | boolean | object | undefined;
+};
+
 export interface FrontChatOptions {
   nonce?: string;
 }
 
 type UnbindHandler = () => void;
 
-export type FrontChatParams = Record<string, string | boolean | object>;
-export type FrontChat = (cmdType: string, params?: FrontChatParams) => UnbindHandler | undefined;
+export type FrontChat = (cmdType: FrontChatCmdType, params?: FrontChatParams) => UnbindHandler | undefined;