@nlxai/touchpoint-ui 1.0.5-alpha.0 → 1.0.5-alpha.2

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import { BotMessage, ConversationHandler } from '@nlxai/chat-core';
+import { Config, BotMessage, ConversationHandler } from '@nlxai/chat-core';
 import { FC } from 'react';
 /**
  * Window size configuration
@@ -27,7 +27,7 @@ export interface ChoiceMessage {
 }
 /**
  * Custom Modalities allow rendering of rich components from nodes.
- * See: https://docs.studio.nlx.ai/intentflows/documentation-flows/flows-build-mode/advanced-messaging-+-functionality#modalities
+ * See: https://docs.studio.nlx.ai/build/resources/modalities
  */
 export type CustomModalityComponent<Data> = FC<{
     /**
@@ -38,6 +38,12 @@ export type CustomModalityComponent<Data> = FC<{
      * Conversation handler instance
      */
     conversationHandler: ConversationHandler;
+    /**
+     * Whether the component is enabled
+     * We should probably use context and handle disabling interactive components automatically for the user
+     * @internal
+     */
+    enabled: boolean;
 }>;
 /**
  * The full theme expressed as CSS custom properties
@@ -144,3 +150,52 @@ export interface Theme {
      */
     outerBorderRadius: string;
 }
+/**
+ * Custom conversation init method. Defaults to sending the welcome intent
+ * @param handler - the conversation handler.
+ */
+export type InitializeConversation = (handler: ConversationHandler) => void;
+/**
+ * Main Touchpoint creation properties object
+ */
+export interface TouchpointConfiguration {
+    /**
+     * Connection information for the \@nlxai/chat-core conversation handler
+     */
+    config: Config;
+    /**
+     * Optional window size for the chat window, defaults to `half`
+     */
+    windowSize?: WindowSize;
+    /**
+     * Optional color mode for the chat window, defaults to `dark`
+     */
+    colorMode?: ColorMode;
+    /**
+     * URL of icon used to display the brand in the chat header
+     */
+    brandIcon?: string;
+    /**
+     * URL of icon used on the launch icon in the bottom right when the experience is collapsed.
+     *
+     * When set to `false`, no launch button is shown at all. When not set or set to `true`, the default launch icon is rendered.
+     */
+    launchIcon?: string | boolean;
+    /**
+     * Optional theme object to override default theme values
+     */
+    theme?: Partial<Theme>;
+    /**
+     * Optional custom modality components to render in Touchpoint
+     */
+    customModalities?: Record<string, CustomModalityComponent<any>>;
+    /**
+     * Custom conversation init method. Defaults to sending the welcome intent
+     * @param handler - the conversation handler.
+     */
+    initializeConversation?: InitializeConversation;
+    /**
+     * Controls the ways in which the user can communicate with the application. Defaults to `"text"`
+     */
+    input?: "text" | "textAndVoice";
+}

package/lib/voice.d.ts

@@ -0,0 +1,11 @@
+import { ConversationHandler } from '@nlxai/chat-core';
+type VoiceRoomState = "inactive" | "pending" | "active" | "error";
+interface VoiceHookReturn {
+    roomState: VoiceRoomState;
+    isUserSpeaking: boolean;
+}
+export declare const useVoice: ({ active, handler, }: {
+    active: boolean;
+    handler: ConversationHandler;
+}) => VoiceHookReturn;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlxai/touchpoint-ui",
-  "version": "1.0.5-alpha.0",
+  "version": "1.0.5-alpha.2",
   "description": "Web UI for Touchpoint",
   "type": "module",
   "main": "lib/index.js",
@@ -24,11 +24,12 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@nlxai/chat-core": "^1.0.5-alpha.0",
+    "@nlxai/chat-core": "^1.0.5-alpha.2",
     "@react-hookz/web": "^25.0.1",
     "@react-input/mask": "^2.0.4",
     "clsx": "^2.1.1",
     "htm": "^3.1.1",
+    "livekit-client": "^2.9.9",
     "marked": "^15.0.4",
     "ramda": "^0.30.1",
     "react": "^18.3.1",
@@ -56,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "97ea824c481708936aae75fb9a051ec0e651ea39"
+  "gitHead": "af2fea91300ecfab6c3ca8832dc3b13971ba5f46"
 }