@nlxai/touchpoint-ui 1.1.3 → 1.1.5

package/lib/types.d.ts

@@ -173,6 +173,78 @@ export type CustomLaunchButton = ComponentType<{
  * Input type for the experience
  */
 export type Input = "text" | "voice" | "voiceMini";
+/**
+ * Configuration for bidirectional mode of voice+.
+ */
+export type BidirectionalConfig = {
+    /**
+     * Attempt to gather and send page context automatically. This will work well on semantically coded pages without too many custom form controls.
+     * This enables a number of automatic features.
+     *
+     * Defaults to `false`.
+     */
+    automaticContext?: true;
+    /**
+     * Navigation handler for bidirectional mode.
+     *
+     * If automatic context gathering is enabled, the default implementation will navigate to those pages using standard `window.location` APIs.
+     * @param action - The navigation action to perform.
+     * @param destination - The name of the destination to navigate to if `action` is `"page_custom"`.
+     * @param destinations - A map of destination names to URLs for custom navigation. Only present if `automaticContext` is enabled.
+     */
+    navigation?: (action: "page_next" | "page_previous" | "page_custom", destination: string | undefined, destinations: Record<string, string>) => void;
+    /**
+     * A callback for filling out form fields in bidirectional mode.
+     *
+     * If automatic context gathering is enabled, the default implementation will fill out the form fields using standard DOM APIs.
+     * @param fields - An array of field objects with `id` and `value` properties.
+     * @param pageFields - A map of field IDs to DOM elements for custom form filling. Only present if `automaticContext` is enabled.
+     */
+    input?: (fields: Array<{
+        id: string;
+        value: string;
+    }>, pageFields: Record<string, Element>) => void;
+    /**
+     * A callback for custom actions in bidirectional mode.
+     * @param action - The custom name of your action.
+     * @param payload - The payload defined for the custom action.
+     * @returns
+     */
+    custom?: (action: string, payload: unknown) => void;
+} | {
+    /**
+     * Attempt to gather and send page context automatically. This will work well on semantically coded pages without too many custom form controls.
+     * This enables a number of automatic features.
+     *
+     * Defaults to `false`.
+     */
+    automaticContext: false;
+    /**
+     * Navigation handler for bidirectional mode.
+     *
+     * If automatic context gathering is enabled, the default implementation will navigate to those pages using standard `window.location` APIs.
+     * @param action - The navigation action to perform.
+     * @param destination - The name of the destination to navigate to if `action` is `"page_custom"`.
+     */
+    navigation?: (action: "page_next" | "page_previous" | "page_custom", destination?: string) => void;
+    /**
+     * A callback for filling out form fields in bidirectional mode.
+     *
+     * If automatic context gathering is enabled, the default implementation will fill out the form fields using standard DOM APIs.
+     * @param fields - An array of field objects with `id` and `value` properties.
+     */
+    input?: (fields: Array<{
+        id: string;
+        value: string;
+    }>) => void;
+    /**
+     * A callback for custom actions in bidirectional mode.
+     * @param action - The custom name of your action.
+     * @param payload - The payload defined for the custom action.
+     * @returns
+     */
+    custom?: (action: string, payload: unknown) => void;
+};
 /**
  * Main Touchpoint creation properties object
  */
@@ -226,11 +298,20 @@ export interface TouchpointConfiguration {
      */
     initializeConversation?: InitializeConversation;
     /**
-     * Controls the ways in which the user can communicate with the application. Defaults to `"text"`
+     * Controls the ways in which  the user can communicate with the application. Defaults to `"text"`
      */
     input?: Input;
     /**
      * Context sent with the initial request.
      */
     initialContext?: Context;
+    /**
+     * Enables bidirectional mode of voice+. Will automatically set the bidirectional flag in the config.
+     *
+     */
+    bidirectional?: BidirectionalConfig;
 }
+/**
+ * @internal
+ */
+export type NormalizedTouchpointConfiguration = TouchpointConfiguration & Required<Pick<TouchpointConfiguration, "initializeConversation" | "input">>;

package/lib/voice.d.ts

@@ -1,29 +1,27 @@
 import { Context, ConversationHandler, ModalityPayloads } from '@nlxai/chat-core';
-type VoiceRoomState = "inactive" | "pending" | "active" | "error" | "terminated";
 export interface SoundCheck {
     micAllowed: boolean;
     micNames: string[];
     speakerNames: string[];
 }
+export interface ModalitiesWithContext {
+    modalities: ModalityPayloads;
+    from?: string;
+    timestamp: number;
+}
+type VoiceRoomState = "noAudioPermissions" | "pending" | "active" | "error" | "terminated";
 interface VoiceHookReturn {
     roomState: VoiceRoomState;
     isUserSpeaking: boolean;
     isApplicationSpeaking: boolean;
-    soundCheck: null | SoundCheck;
     roomData: null | ModalitiesWithContext;
-    retrySoundCheck: () => void;
+    retry: () => Promise<void>;
 }
-interface UseVoiceParams {
-    active: boolean;
+interface VoiceHookParams {
     micEnabled: boolean;
     speakersEnabled: boolean;
     handler: ConversationHandler;
     context?: Context;
 }
-export interface ModalitiesWithContext {
-    modalities: ModalityPayloads;
-    from?: string;
-    timestamp: number;
-}
-export declare const useVoice: ({ active, micEnabled, speakersEnabled, handler, context, }: UseVoiceParams) => VoiceHookReturn;
+export declare const useVoice: ({ handler, context, speakersEnabled, micEnabled, }: VoiceHookParams) => VoiceHookReturn;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlxai/touchpoint-ui",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Web UI for Touchpoint",
   "type": "module",
   "main": "lib/index.js",
@@ -24,10 +24,11 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@nlxai/chat-core": "^1.0.5-alpha.13",
+    "@nlxai/chat-core": "^1.1.4",
     "@react-hookz/web": "^25.0.1",
     "@react-input/mask": "^2.0.4",
     "clsx": "^2.1.1",
+    "hast": "^0.0.2",
     "htm": "^3.1.1",
     "livekit-client": "^2.9.9",
     "marked": "^15.0.4",
@@ -35,7 +36,8 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-indiana-drag-scroll": "^2.2.0",
-    "react-textarea-autosize": "^8.5.6"
+    "react-textarea-autosize": "^8.5.6",
+    "unist": "^0.0.1"
   },
   "devDependencies": {
     "@rollup/plugin-replace": "^6.0.2",
@@ -58,5 +60,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d16046654dd9956faf8714a0f6bbf188450b62f3"
+  "gitHead": "9d7f963d6078df83c94998f4ace8d98e35dfa2aa"
 }