@davi-ai/retorik-framework 2.1.0 → 3.0.0

package/dist/index.d.ts

@@ -1,22 +1,20 @@
 import { presets as _presets1, presets } from "@davi-ai/react-bodyengine-three";
-import { StoreApi, UseBoundStore } from "zustand";
-import { SpeechSynthesisEventProps } from "@davi-ai/web-speech-cognitive-services-davi";
-import { TierResult } from "detect-gpu";
+/**
+ * @deprecated AvailableViews is deprecated without replacement since version 2.2.0 and the new menu system
+ */
 export enum AvailableViews {
     home = 1,
     news = 2,
     weather = 3,
     emergency = 4
 }
+/**
+ * @deprecated AvailableSubViews is deprecated without replacement since version 2.2.0 and the new menu system
+ */
 export enum AvailableSubViews {
     history = 1000,
     tutorial = 1001
 }
-enum ContainerParent {
-    agent = 1,
-    widget = 2,
-    news = 3
-}
 export enum CurrentSubView {
     none = 1,
     history = 2,
@@ -57,36 +55,17 @@ export enum InputHintBehaviour {
     never = "never",
     ignore = "ignore"
 }
-enum ListStatus {
-    available = 1,
-    opened = 2,
-    closing = 3,
-    closed = 4
-}
 enum Mode {
     vocal = 1,
     text = 2,
     dashboard = 3
 }
-enum PermissionStatus {
-    waiting = 1,
-    allowed = 2,
-    refused = 3,
-    error = 4
-}
 export enum RetorikEvent {
     DetailViewOpen = 1,
     DetailViewClose = 2,
     SpeechStarted = 3,
     SpeechEnded = 4
 }
-enum RecognitionState {
-    Initializing = 1,
-    Listening = 2,
-    Closing = 3,
-    ForceClosing = 4,
-    Closed = 5
-}
 enum Source3DEngine {
     avatarsdk = "avatarsdk",
     avatarsdkbis = "avatar-sdk",
@@ -96,15 +75,6 @@ enum Source3DEngine {
     rpm = "rpm",
     readyplayerme = "readyplayerme"
 }
-enum UIPart {
-    none = 1,
-    agent = 2,
-    background = 3,
-    remote = 4,
-    languages = 5,
-    card = 6,
-    qroverlay = 7
-}
 interface DirectLineAttachment {
     content?: any;
     contentType: string;
@@ -271,10 +241,23 @@ export interface Configuration extends RetorikMenusConfiguration {
     showTemporaryBanner?: boolean;
     preventVirtualKeyboard?: boolean;
 }
+/**
+ * Configuration of the menus displayed in the dashboard
+ * @param {Array<BaseMenu | CustomMenu> | undefined} baseMenu deprecated since v2.0.4. Use "menu" parameter instead.
+ * @param {Array<CustomMenu> | Array<Array<CustomMenu>> | undefined} customMenu deprecated since v2.0.4. Use "menu" parameter instead.
+ * @param {Array<BaseSubMenu | CustomMenu> | undefined} subMenu deprecated since v2.0.4. Use "menu" parameter instead.
+ * @param {Array<{ title?: string, items: Array<MenuItem> }> | undefined} menu menus displayed in the bashboard.
+ */
 export interface RetorikMenusConfiguration {
     baseMenu?: Array<BaseMenu | CustomMenu>;
     customMenu?: Array<CustomMenu> | Array<Array<CustomMenu>>;
     subMenu?: Array<BaseSubMenu | CustomMenu>;
+    menu?: {
+        categories?: Array<{
+            title?: string;
+            tiles: Array<MenuItem>;
+        }>;
+    };
 }
 interface SpeechRecognitionOptions {
     timerBeforeSpeechEnd?: number;
@@ -470,6 +453,20 @@ export interface CustomMenu {
     closeParametersOnClickInMobileMode?: boolean;
     name?: string;
 }
+interface MenuItem {
+    index: number;
+    text: string;
+    textColor?: string;
+    backgroundColor?: string;
+    image?: {
+        url: string;
+        color?: string;
+    };
+    action: {
+        type: string;
+        value?: Record<string, any>;
+    };
+}
 export interface GDPR {
     userConsent?: boolean;
     title?: Record<string, string>;
@@ -481,261 +478,6 @@ export interface GDPR {
     messageAccepted?: Record<string, string>;
     messageRefused?: Record<string, string>;
 }
-interface ThemeButton {
-    background: {
-        default: string;
-        hover: string;
-    };
-    border: {
-        default: string;
-        hover: string;
-    };
-    text: {
-        default: string;
-        hover: string;
-    };
-}
-interface ThemeButtonConditional {
-    background?: {
-        default?: string;
-        hover?: string;
-    };
-    border?: {
-        default?: string;
-        hover?: string;
-    };
-    text?: {
-        default?: string;
-        hover?: string;
-    };
-}
-export interface RetorikThemeColors {
-    theme?: string;
-    primary?: string;
-    secondary?: string;
-    black?: string;
-    whereToEatColor?: string;
-    whereToSleepColor?: string;
-    tobeSeenColor?: string;
-    tobeDoneColor?: string;
-    localProductsColor?: string;
-    servicesColor?: string;
-    agendaColor?: string;
-    occupantColor?: string;
-    companyName?: string;
-    loader?: {
-        animation?: string;
-        background?: string;
-        text?: string;
-        toggle?: {
-            text: string;
-            background: string;
-        };
-        button?: ThemeButtonConditional;
-    };
-    card?: {
-        frame?: {
-            background?: string;
-            border?: string;
-            text?: string;
-        };
-        button?: ThemeButtonConditional;
-        discoverButton?: ThemeButton;
-    };
-    textMode?: {
-        panel?: {
-            background?: string;
-            border?: string;
-            conversationUser?: string;
-            conversationBot?: string;
-            backgroundUser?: string;
-            backgroundBot?: string;
-        };
-    };
-    vocalMode?: {
-        subtitles?: {
-            text?: string;
-            background?: string;
-        };
-    };
-    formInput?: {
-        text?: {
-            default?: string;
-            hover?: string;
-        };
-        inputRadioCheckbox?: {
-            unchecked?: {
-                background?: string;
-                border?: string;
-            };
-            checked?: {
-                background?: string;
-                border?: string;
-                item?: string;
-            };
-        };
-        inputButton?: ThemeButtonConditional;
-        likert?: {
-            default?: string;
-            hover?: string;
-        };
-    };
-}
-export interface RetorikMainComponentConfiguration extends RetorikSharedProps {
-    config?: Configuration;
-    viewsConfig?: ViewsConfiguration;
-    chatbotData?: ChatbotData;
-    agentData?: BaseAgentData;
-    chatbotDataWidget?: ChatbotData;
-    ponyfillFactoryCredentials?: PonyfillFactoryCredentials;
-    customVoice?: CustomVoice;
-    colors?: RetorikThemeColors;
-    skipLoader?: boolean;
-    defaultMode?: number;
-    GDPR?: GDPR;
-}
-export interface RetorikMainComponentProps extends RetorikMainComponentConfiguration {
-    menuConfig?: RetorikMenusConfiguration;
-}
-interface RetorikWidgetProps {
-    widgetConfig: WidgetConfiguration;
-}
-export interface RetorikSharedProps {
-    addressData: AddressData;
-    externalEventHandler?: (action: any, dispatch?: any) => boolean;
-    externalComponents?: Array<{
-        name: string;
-        component: JSX.Element;
-    }>;
-    userData?: UserData;
-    width?: number | string | 'full';
-    height?: number | string | 'full';
-}
-export const setVisibility: (value: 'visible' | 'hidden') => void;
-export const toggleVisibility: () => void;
-interface UtilsStore {
-    fullScreenImage: string | undefined;
-    lastListActivity: string | undefined;
-    listStatus: ListStatus;
-    currentSubView: number;
-    currentCustomView: CustomMenu | undefined;
-    retorikEvent: RetorikEvent | undefined;
-    displayAgent: boolean;
-    activityToSend: RetorikActivity | undefined;
-    currentNewsActivity: RetorikActivity | undefined;
-    retorikNewsEnded: boolean;
-    userIsTyping: boolean;
-    userIsSwiping: boolean;
-    askedForKioskParametersOpening: boolean;
-    detailedAttachmentTriggers: Array<DetailedAttachmentAction>;
-    modalFullscreenContent: JSX.Element | null;
-    modalFullscreenContentNoDisplayId: string | undefined;
-    printingCallback: ((url: string) => void) | null;
-    GDPRDisplay: boolean;
-    GDPRWindowData: GDPR | undefined;
-    GDPRUserConsent: boolean;
-    unlockClickedButton: boolean;
-    dashboardOpened: boolean;
-    clickedOnUI: UIPart;
-    closeDetailedPOI: boolean;
-    closeList: number;
-}
-export const useUtilsStore: UseBoundStore<StoreApi<UtilsStore>>;
-export const setCurrentSubView: (subview: number) => void;
-export const setCurrentCustomView: (customView: CustomMenu) => void;
-export const showAgent: () => void;
-export const hideAgent: () => void;
-export const sendActivity: (activity: RetorikActivity | undefined) => void;
-export const addDetailedAttachmentTrigger: (value: DetailedAttachmentAction) => void;
-export const setModalFullscreenContent: (value: JSX.Element | null, fromActivity?: string) => void;
-export const setPrintingCallback: (value: ((url: string) => void) | null) => void;
-declare const unlockClickedButton: () => void;
-export const setDashboardOpened: (value: boolean) => void;
-interface Boundary {
-    word: string;
-    startTime: number;
-    endTime: number;
-    boundaryType: string;
-}
-interface SpeechStore {
-    ponyfillCredentials: PonyfillFactoryCredentials | undefined;
-    useContinuousRecognition: boolean;
-    customVoice: CustomVoice | undefined;
-    voice: SpeechSynthesisVoice | null;
-    speaking: boolean;
-    muted: boolean;
-    cancel: boolean;
-    boundaryData: Array<Boundary>;
-    visemeData: Array<SpeechSynthesisEventProps>;
-    singleVisemeAdded: SpeechSynthesisEventProps | null;
-    multiVisemesAdded: Array<SpeechSynthesisEventProps>;
-    currentReplyToId: string | undefined;
-    currentPlaying: RetorikActivity | undefined;
-    endedActivities: Array<string>;
-    currentOrLastPlayedActivity: RetorikActivity | undefined;
-    isMicrophoneAllowed: boolean;
-    showMicrophoneModal: boolean;
-    permissionStatus: PermissionStatus;
-    activeRecognitionState: RecognitionState;
-    lastRecognitionInterim: string;
-    streamingReplyToId: string | null;
-    streamingQueue: Array<RetorikActivity>;
-    streamingQueueForText: Array<RetorikActivity>;
-    currentStreaming: string | null;
-    streamingQueueFullLength: number;
-    streamingReplyToIdToIgnore: string | null;
-    speechRecognitionDynamicGrammars: Array<string>;
-    externalTextToSpeech: string | undefined;
-}
-export const useSpeechStore: UseBoundStore<StoreApi<SpeechStore>>;
-export const setMuted: (value: boolean) => void;
-export const toggleMicrophone: () => void;
-export const playExternalSynthesis: (value: string) => void;
-export const characters: {
-    alice: string;
-    greg: string;
-    jeanmarc: string;
-    jessica: string;
-    jessica_short: string;
-    ikaa: string;
-    karine: string;
-    lea: string;
-    prosper: string;
-    raphael: string;
-    rowan: string;
-    rowan_short: string;
-    zahra: string;
-};
-interface RetorikStore {
-    configuration: Configuration;
-    addressData: AddressData;
-    sendBoxRef: HTMLTextAreaElement | null;
-    sendBoxPlaceHolder: string | undefined;
-    canFocusSendBox: boolean;
-    mode: Mode;
-    fromTextToVocal: boolean;
-    baseAddress: string;
-    subtitlesInConfiguration: boolean;
-    displaySubtitles: boolean;
-    agentData: AgentData | undefined;
-    gpuData: TierResult | undefined;
-    loaderClosed: boolean;
-    appAvailable: boolean;
-    currentLayout: ContainerParent;
-    userAlreadySet: boolean;
-    disableSound: boolean;
-    isWaitingForResponse: boolean;
-    instantIsWaitingForResponse: boolean;
-    skipLoader: boolean;
-    displayAgentInNews: boolean;
-    submitDelayBeforeSendingMessage: number | undefined;
-    disableHistory: boolean;
-}
-export const useRetorikStore: UseBoundStore<StoreApi<RetorikStore>>;
-export const setMode: (value: Mode) => void;
-export const setLoaderClosed: (value: boolean) => void;
-export const setDisplaySubtitles: (value: boolean) => void;
-export const toggleSubtitles: () => void;
 interface TranslationViews {
     '1': string;
     '2': string;
@@ -908,22 +650,197 @@ interface TranslationFile extends TranslationViews {
     anghello: TranslationAnghello;
     microphone: TranslationMicrophone;
 }
-export function fetchAvailableLanguages(baseAddress: string, needVisemes?: boolean): Promise<AvailableLanguages>;
-export default getThemeColors;
-interface LocaleStore {
-    locale: string;
-    defaultLocale: string;
-    supported: string[];
-    dumpedLanguagesFallback: Record<string, string>;
-    replacementLocales: Record<string, string>;
-    defaultTranslations: TranslationFile;
-    currentTranslations: TranslationFile;
-    isRTL: boolean;
-}
-export const useLocaleStore: UseBoundStore<StoreApi<LocaleStore>>;
-export const getLocale: () => string;
-export const setLocale: (locale: string) => void;
-export default getRetorikConfigs;
+interface CommonColors {
+    primary: string;
+    secondary: string;
+    black: string;
+    whereToEatColor: string;
+    whereToSleepColor: string;
+    tobeSeenColor: string;
+    tobeDoneColor: string;
+    localProductsColor: string;
+    servicesColor: string;
+    agendaColor: string;
+    occupantColor: string;
+}
+interface LoaderColors {
+    animation: string;
+    background: string;
+    text: string;
+    toggle: {
+        text: string;
+        background: string;
+    };
+    button: ThemeButton;
+}
+interface ThemeButton {
+    background: {
+        default: string;
+        hover: string;
+    };
+    border: {
+        default: string;
+        hover: string;
+    };
+    text: {
+        default: string;
+        hover: string;
+    };
+}
+interface ThemeButtonConditional {
+    background?: {
+        default?: string;
+        hover?: string;
+    };
+    border?: {
+        default?: string;
+        hover?: string;
+    };
+    text?: {
+        default?: string;
+        hover?: string;
+    };
+}
+interface Theme {
+    companyName: string;
+    loader: LoaderColors;
+    card: {
+        frame: {
+            background: string;
+            border: string;
+            text: string;
+        };
+        button: ThemeButton;
+        discoverButton: ThemeButton;
+    };
+    textMode: {
+        panel: {
+            background: string;
+            border: string;
+            conversationUser: string;
+            conversationBot: string;
+            backgroundUser: string;
+            backgroundBot: string;
+        };
+    };
+    vocalMode: {
+        subtitles: {
+            text: string;
+            background: string;
+        };
+    };
+    formInput: {
+        text: {
+            default: string;
+            hover: string;
+        };
+        inputRadioCheckbox: {
+            unchecked: {
+                background: string;
+                border: string;
+            };
+            checked: {
+                background: string;
+                border: string;
+                item: string;
+            };
+        };
+        inputButton: ThemeButton;
+        likert: {
+            default: string;
+            hover: string;
+        };
+    };
+}
+interface ThemeColors extends CommonColors, Theme {
+}
+export interface RetorikThemeColors {
+    theme?: string;
+    primary?: string;
+    secondary?: string;
+    black?: string;
+    whereToEatColor?: string;
+    whereToSleepColor?: string;
+    tobeSeenColor?: string;
+    tobeDoneColor?: string;
+    localProductsColor?: string;
+    servicesColor?: string;
+    agendaColor?: string;
+    occupantColor?: string;
+    companyName?: string;
+    loader?: {
+        animation?: string;
+        background?: string;
+        text?: string;
+        toggle?: {
+            text: string;
+            background: string;
+        };
+        button?: ThemeButtonConditional;
+    };
+    card?: {
+        frame?: {
+            background?: string;
+            border?: string;
+            text?: string;
+        };
+        button?: ThemeButtonConditional;
+        discoverButton?: ThemeButton;
+    };
+    textMode?: {
+        panel?: {
+            background?: string;
+            border?: string;
+            conversationUser?: string;
+            conversationBot?: string;
+            backgroundUser?: string;
+            backgroundBot?: string;
+        };
+    };
+    vocalMode?: {
+        subtitles?: {
+            text?: string;
+            background?: string;
+        };
+    };
+    formInput?: {
+        text?: {
+            default?: string;
+            hover?: string;
+        };
+        inputRadioCheckbox?: {
+            unchecked?: {
+                background?: string;
+                border?: string;
+            };
+            checked?: {
+                background?: string;
+                border?: string;
+                item?: string;
+            };
+        };
+        inputButton?: ThemeButtonConditional;
+        likert?: {
+            default?: string;
+            hover?: string;
+        };
+    };
+}
+export const characters: {
+    alice: string;
+    greg: string;
+    jeanmarc: string;
+    jessica: string;
+    jessica_short: string;
+    ikaa: string;
+    karine: string;
+    lea: string;
+    prosper: string;
+    raphael: string;
+    rowan: string;
+    rowan_short: string;
+    zahra: string;
+};
 export const CONTENT_TYPE_ADAPTIVE_CARD = "application/vnd.microsoft.card.adaptive";
 export const CONTENT_TYPE_NEWS = "application/vnd.davi.retorik.card.news";
 export const CONTENT_TYPE_POI = "application/vnd.davi.retorik.card.poi";
@@ -983,15 +900,82 @@ interface Coordinates {
     latitude: number;
     longitude: number;
 }
-export const sendMessage: (text?: string, value?: Record<string, any>) => void;
-export const sendEvent: (name: string, value?: Record<string, any> | null) => void;
-export const pauseConversation: () => void;
-export const resumeConversation: () => void;
-export const sendMessageToChatbot: (value: string) => void;
-export const openWidget: () => void;
-export const closeWidget: () => void;
-export const toggleWidget: () => void;
-export const toggleDisplay: () => void;
+export const openWidget: (instanceId?: string) => void;
+export const closeWidget: (instanceId?: string) => void;
+export const toggleWidget: (instanceId?: string) => void;
+export const toggleDisplay: (instanceId?: string) => void;
+export const showAgent: (instanceId?: string) => void;
+export const hideAgent: (instanceId?: string) => void;
+export const setCurrentCustomView: (value: CustomMenu, instanceId?: string) => void;
+export const setCurrentSubView: (value: number, instanceId?: string) => void;
+export const sendActivity: (value: RetorikActivity | undefined, instanceId?: string) => void;
+export const addDetailedAttachmentTrigger: (value: DetailedAttachmentAction, instanceId?: string) => void;
+export const setModalFullscreenContent: (value: JSX.Element | null, instanceId?: string) => void;
+export const setPrintingCallback: (value: ((url: string) => void) | null, instanceId?: string) => void;
+export const setDashboardOpened: (value: boolean, instanceId?: string) => void;
+export const setLocale: (value: string, instanceId?: string) => void;
+export const setVisibility: (value: string, instanceId?: string) => void;
+export const toggleVisibility: (instanceId?: string) => void;
+export const toggleMicrophone: (instanceId?: string) => void;
+export const setMuted: (value: boolean, instanceId?: string) => void;
+export const playExternalSynthesis: (value: string, instanceId?: string) => void;
+export const setDisplaySubtitles: (value: boolean, instanceId?: string) => void;
+export const toggleSubtitles: (instanceId?: string) => void;
+export const setMode: (value: Mode, instanceId?: string) => void;
+export const setLoaderClosed: (value: boolean, instanceId?: string) => void;
+export const sendMessage: (text?: string, value?: Record<string, any>, instanceId?: string) => void;
+export const sendEvent: (name: string, value?: Record<string, any> | null, instanceId?: string) => void;
+export const pauseConversation: (instanceId?: string) => void;
+export const resumeConversation: (instanceId?: string) => void;
+export const sendMessageToChatbot: (value: string, instanceId?: string) => void;
+export function fetchAvailableLanguages(baseAddress: string, needVisemes?: boolean): Promise<AvailableLanguages>;
+export default getThemeColors;
+export interface RetorikMainComponentConfiguration extends RetorikSharedProps {
+    config?: Configuration;
+    viewsConfig?: ViewsConfiguration;
+    chatbotData?: ChatbotData;
+    agentData?: BaseAgentData;
+    chatbotDataWidget?: ChatbotData;
+    ponyfillFactoryCredentials?: PonyfillFactoryCredentials;
+    customVoice?: CustomVoice;
+    colors?: RetorikThemeColors;
+    skipLoader?: boolean;
+    defaultMode?: number;
+    GDPR?: GDPR;
+}
+export interface RetorikMainComponentProps extends RetorikMainComponentConfiguration {
+    menuConfig?: RetorikMenusConfiguration;
+}
+interface RetorikWidgetProps {
+    widgetConfig: WidgetConfiguration;
+}
+export interface RetorikSharedProps {
+    instanceId?: string;
+    addressData: AddressData;
+    externalEventHandler?: (action: any, dispatch?: any) => boolean;
+    externalComponents?: Array<{
+        name: string;
+        component: JSX.Element;
+    }>;
+    userData?: UserData;
+    width?: number | string | 'full';
+    height?: number | string | 'full';
+}
+export default getRetorikConfigs;
+export const useCurrentSubView: (instanceId?: string) => number;
+export const useKioskParameterOpening: (instanceId?: string) => number;
+export const useRetorikEvent: (instanceId?: string) => RetorikEvent | undefined;
+export const useLocale: (instanceId?: string) => string;
+export const useIsRTL: (instanceId?: string) => boolean;
+export const useTranslation: (instanceId?: string) => TranslationFile;
+export const useIsMobile: (instanceId?: string) => boolean;
+export const useIsWidget: (instanceId?: string) => boolean;
+export const useThemeColors: (instanceId?: string) => ThemeColors;
+export const useMode: (instanceId?: string) => Mode;
+export const useMuted: (instanceId?: string) => boolean;
+export const useLoaderClosed: (instanceId?: string) => boolean;
+export const useConfiguration: (instanceId?: string) => Configuration;
+export const useIsUsedOnBorne: (instanceId?: string) => boolean;
 export const RetorikAgent: (props: RetorikMainComponentProps) => JSX.Element;
 export const RetorikWidget: (props: RetorikMainComponentProps & RetorikWidgetProps) => JSX.Element;
 export const RetorikNews: (props: RetorikMainComponentProps) => JSX.Element;