@nlxai/touchpoint-ui 1.2.4-alpha.9 → 1.2.5

package/lib/interface.d.ts

@@ -283,6 +283,10 @@ export interface TouchpointConfiguration {
      * Controls the ways in which  the user can communicate with the application. Defaults to `"text"`
      */
     input?: Input;
+    /**
+     * Sets whether the transcript is shown in `voice` and `voiceMini` inputs.
+     */
+    showVoiceTranscript?: boolean;
     /**
      * Context sent with the initial request.
      */
@@ -292,17 +296,21 @@ export interface TouchpointConfiguration {
      *
      */
     bidirectional?: BidirectionalConfig;
+    /**
+     * Copy
+     */
+    copy?: Partial<Copy>;
 }
 /**
  * The full theme expressed as CSS custom properties.
  * This means that for instance colors can be made to switch automatically based on the system color mode by using the `light-dark()` CSS function.
- * Note also that not all colors need to be provided manually. For instance if only `primary80` is provided, the rest of the primary colors will be computed automatically based on it.
- * Therefore, for a fully custom but minimal theme, you only need to provide `accent`, `primary80`, `secondary80`, `background`, `overlay`, and potentially the warning and error colors.
+ * Note also that not all colors need to be provided manually. For instance if only `primary` is provided, the rest of the primary colors will be computed automatically based on it.
+ * Therefore, for a fully custom but minimal theme, you only need to provide `accent`, `primary`, `secondary`, `background`, `overlay`, and potentially the warning and error colors.
  * @example
  * ```typescript
  * const theme : Partial<Theme> = {
- *   primary80: "light-dark(rgba(0, 2, 9, 0.8), rgba(255, 255, 255, 0.8))",
- *   secondary80: "light-dark(rgba(255, 255, 255, 0.8), rgba(0, 2, 9, 0.8))",
+ *   primary: "light-dark(rgb(0, 2, 9), rgb(255, 255, 255))",
+ *   secondary: "light-dark(rgb(255, 255, 255), rgb(0, 2, 9))",
  *   accent: "light-dark(rgb(28, 99, 218), rgb(174, 202, 255))",
  *   background: "light-dark(rgba(220, 220, 220, 0.9), rgba(0, 2, 9, 0.9))",
  * }
@@ -314,6 +322,14 @@ export interface Theme {
      * Font family
      */
     fontFamily: string;
+    /**
+     * Primary color
+     */
+    primary: string;
+    /**
+     * Primary color with 90% opacity
+     */
+    primary90: string;
     /**
      * Primary color with 80% opacity
      */
@@ -342,6 +358,14 @@ export interface Theme {
      * Primary color with 1% opacity
      */
     primary1: string;
+    /**
+     * Secondary color
+     */
+    secondary: string;
+    /**
+     * Secondary color with 90% opacity
+     */
+    secondary90: string;
     /**
      * Secondary color with 80% opacity
      */
@@ -514,3 +538,28 @@ export interface TouchpointInstance {
      */
     setCustomBidirectionalCommands: (commands: BidirectionalCustomCommand[]) => void;
 }
+/**
+ * Copy configuration
+ */
+export interface Copy {
+    /**
+     * Escalation attempt notice
+     */
+    escalationAttemptNotice: string;
+    /**
+     * Escalation notice
+     */
+    escalationNotice: string;
+    /**
+     * Restart conversation button label
+     */
+    restartConversationButtonLabel: string;
+    /**
+     * Restart conversation button label
+     */
+    escalationButtonLabel: string;
+    /**
+     * Send message button label
+     */
+    sendMessageButtonLabel: string;
+}

package/lib/utils/useAppRoot.d.ts

@@ -0,0 +1,3 @@
+import { RefObject } from 'react';
+export declare const AppRootProvider: import('react').Provider<RefObject<HTMLElement> | null>;
+export declare const useAppRoot: () => RefObject<HTMLElement> | null;

package/lib/utils/useCopy.d.ts

@@ -0,0 +1,4 @@
+import { Copy } from '../interface';
+export declare const defaultCopy: (languageCode: string) => Copy;
+export declare const CopyProvider: import('react').Provider<Copy>;
+export declare const useCopy: () => Copy;

package/lib/voice.d.ts

@@ -1,27 +1,70 @@
-import { Context, ConversationHandler, ModalityPayloads } from '@nlxai/core';
-export interface SoundCheck {
-    micAllowed: boolean;
-    micNames: string[];
-    speakerNames: string[];
-}
-export interface ModalitiesWithContext {
-    modalities: ModalityPayloads;
+import { Context, ModalityPayloads, ConversationHandler, ApplicationMessage } from '@nlxai/core';
+type DebugEvent = any;
+/**
+ * Contains modality data paired with timing information.
+ */
+export interface RoomDataEventsWithContext {
+    /** The modality data. */
+    data: RoomDataEvent;
+    /** The participant identity the data is from, if available. */
     from?: string;
+    /** The timestamp when the data was received. */
     timestamp: number;
 }
-type VoiceRoomState = "noAudioPermissions" | "pending" | "active" | "error" | "terminated";
-interface VoiceHookReturn {
-    roomState: VoiceRoomState;
+type RoomDataEvent = {
+    type: "agent_interim_response";
+    message: string;
+} | {
+    type: "agent_response";
+    message: string;
+    debugEvents?: DebugEvent[];
+} | {
+    type: "agent_final_response";
+    messages: ApplicationMessage[];
+    debugEvents?: DebugEvent[];
+    modalities?: ModalityPayloads;
+};
+/**
+ * How to handle voice connections.
+ */
+export interface VoiceHandler {
+    /** Enable or disable the microphone. */
+    setMicrophone: (micEnabled: boolean) => Promise<void>;
+    /** Enable or disable the speakers. */
+    setSpeakers: (speakersEnabled: boolean) => Promise<void>;
+    /** Retry connecting to the voice service. */
+    retry: () => Promise<void>;
+    /** Disconnect from the voice service. Must be called at the end of the session. */
+    disconnect: () => Promise<void>;
+}
+/**
+ * The state of the voice connection.
+ */
+export interface VoiceState {
+    /** Whether the voice connection has been terminated from the remote end. */
+    isTerminated: boolean;
+    /** Is the user speaking at the moment. */
     isUserSpeaking: boolean;
+    /** Is the application/agent speaking at the moment. */
     isApplicationSpeaking: boolean;
-    modalities: ModalitiesWithContext[];
-    retry: () => Promise<void>;
+    /** Are the speakers enabled */
+    isSpeakersEnabled: boolean;
+    /** Is the mic enabled */
+    isMicEnabled: boolean;
+    /** Interim message */
+    interimMessage?: string;
 }
-interface VoiceHookParams {
-    micEnabled: boolean;
-    speakersEnabled: boolean;
-    handler: ConversationHandler;
-    context?: Context;
+/** Thrown when we detect missing audio permissions */
+export declare class MissingAudioPermissionsError extends Error {
+    /** */
+    constructor();
 }
-export declare const useVoice: ({ handler, context, speakersEnabled, micEnabled, }: VoiceHookParams) => VoiceHookReturn;
+/**
+ * How to handle voice connections.
+ * @param handler - The conversation handler.
+ * @param context - The context for the voice connection.
+ * @param onRoomStateChanged - Callback for when the room state changes.
+ * @returns The voice handler.
+ */
+export declare const initiateVoice: (handler: ConversationHandler, context: Context, onRoomStateChanged?: (state: VoiceState) => void) => Promise<VoiceHandler>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlxai/touchpoint-ui",
-  "version": "1.2.4-alpha.9",
+  "version": "1.2.5",
   "description": "Web UI for Touchpoint",
   "type": "module",
   "main": "lib/index.js",
@@ -14,7 +14,7 @@
     "design-system": "vite --mode design-system",
     "build": "tsc && vite build",
     "docs": "rm -rf docs/ && typedoc && concat-md --decrease-title-levels --dir-name-as-title docs/ > docs/index.md",
-    "lint:check": "eslint src/ --ext .ts,.tsx,.js,.jsx --max-warnings 0",
+    "lint:check": "eslint src/ --ext .ts,.tsx,.js,.jsx --max-warnings 0  && markdown-link-check README.md",
     "prepublish": "npm run build",
     "lint": "eslint src/ --ext .ts,.tsx,.js,.jsx --fix",
     "format": "git ls-files | grep -E '\\.(js|jsx|ts|tsx|css|html)$' | xargs prettier --write",
@@ -22,17 +22,19 @@
     "publish-docs": "npm run docs && mv docs/index.md ../website/src/content/touchpoint-ui-api-reference.md",
     "test": "typedoc --emit none && vitest run",
     "tsc": "tsc",
-    "update-readme:docs": "rm -rf docs/ && typedoc",
+    "update-readme:docs": "rm -rf docs/ && typedoc --excludeExternals --externalPattern src/components/ui/Icons.tsx",
     "update-readme:merge": "../../scripts/transclude-markdown.js",
     "update-readme": "npm run update-readme:docs && npm run update-readme:merge"
   },
   "dependencies": {
-    "@nlxai/core": "^1.2.4-alpha.9",
+    "@base-ui/react": "^1.1.0",
+    "@nlxai/core": "^1.2.4",
     "@react-hookz/web": "^25.0.1",
     "@react-input/mask": "^2.0.4",
     "@rive-app/webgl2": "^2.31.5",
     "@types/json-schema": "^7.0.15",
     "clsx": "^2.1.1",
+    "dompurify": "^3.3.1",
     "htm": "^3.1.1",
     "livekit-client": "^2.15.14",
     "marked": "^15.0.4",
@@ -44,6 +46,7 @@
     "react-textarea-autosize": "^8.5.6"
   },
   "devDependencies": {
+    "@boillodmanuel/markdown-link-check": "^4.7.0",
     "@rollup/plugin-replace": "^6.0.2",
     "@tailwindcss/vite": "^4.1.16",
     "@testing-library/react": "^16.3.1",
@@ -70,5 +73,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a749667b96b11c1d187e9f0447abb2ebc755094c"
+  "gitHead": "597906e46de64f0183bb8942ac18455be0d4a90d"
 }