@nlxai/touchpoint-ui 1.1.8-alpha.2 → 1.1.8-alpha.3

package/lib/interface.d.ts

@@ -406,3 +406,73 @@ export interface BidirectionalCustomCommand {
      */
     handler: (value: any) => void;
 }
+/**
+ * Instance of a Touchpoint UI component
+ */
+export interface TouchpointInstance {
+    /**
+     * Controls whether the Touchpoint UI is expanded or collapsed
+     */
+    expanded: boolean;
+    /**
+     * The conversation handler instance for interacting with the application
+     */
+    conversationHandler: ConversationHandler;
+    /**
+     * Method to remove the Touchpoint UI from the DOM
+     */
+    teardown: () => void;
+    /**
+     * Sets currently available custom bidirectional commands.
+     * This allows you to define custom commands that can be used in the voice bot.
+     * The commands will be available in the voice bot and can be used to trigger actions.
+     *
+     * Example:
+     * ```javascript
+     * client.setCustomBidirectionalCommands([
+     *     {
+     *       action: "Meal",
+     *       description: "add a meal to your flight",
+     *       schema: {
+     *         enum: ["standard", "vegetarian", "vegan", "gluten-free"],
+     *       },
+     *       handler: (value) => {
+     *         console.log("Meal option:", value);
+     *       },
+     *     },
+     *   ]);
+     * ```
+     *
+     * This will allow the voice bot to use the command `Meal` with the value `standard`, `vegetarian`, `vegan`, or `gluten-free`.
+     *
+     * When using more complex arguments, a library such as [Zod](https://zod.dev) can be useful:
+     *
+     * ```javascript
+     * import * as z from "zod/v4";
+     *
+     * const schema = z.object({
+     *   "name": z.string().describe("The customer's name, such as John Doe"),
+     *   "email": z.string().email().describe("The customer's email address"),
+     * });
+     *
+     * client.setCustomBidirectionalCommands([
+     *     {
+     *       action: "Meal",
+     *       description: "add a meal to your flight",
+     *       schema: z.toJSONSchema(schema, {io: "input"}),
+     *       handler: (value) => {
+     *         const result = z.safeParse(schema, value);
+     *         if (result.success) {
+     *           // result.data is now type safe and TypeScript can reason about it
+     *           console.log("Meal option:", result.data);
+     *         } else {
+     *           console.error("Failed to parse Meal option:", result.error);
+     *         }
+     *       },
+     *     },
+     *   ]);
+     * ```
+     * @param commands - A list containing the custom commands to set.
+     */
+    setCustomBidirectionalCommands: (commands: BidirectionalCustomCommand[]) => void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlxai/touchpoint-ui",
-  "version": "1.1.8-alpha.2",
+  "version": "1.1.8-alpha.3",
   "description": "Web UI for Touchpoint",
   "type": "module",
   "main": "lib/index.js",
@@ -29,7 +29,6 @@
     "@react-input/mask": "^2.0.4",
     "@types/json-schema": "^7.0.15",
     "clsx": "^2.1.1",
-    "hast": "^0.0.2",
     "htm": "^3.1.1",
     "livekit-client": "^2.9.9",
     "marked": "^15.0.4",
@@ -37,8 +36,7 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-indiana-drag-scroll": "^2.2.0",
-    "react-textarea-autosize": "^8.5.6",
-    "unist": "^0.0.1"
+    "react-textarea-autosize": "^8.5.6"
   },
   "devDependencies": {
     "@rollup/plugin-replace": "^6.0.2",
@@ -55,11 +53,12 @@
     "postcss": "^8.4.38",
     "tailwindcss": "^3.4.3",
     "typescript": "^5.4.5",
-    "vite": "^5.4.19",
-    "vite-plugin-dts": "^4.5.0"
+    "vite": "^6.0",
+    "vite-plugin-dts": "^4.5.0",
+    "zod": "^4.1.5"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a9cf00e44e050d087a2ffa657dc5e73d0bcf6816"
+  "gitHead": "7dcad47764e9b7bc859f13d757e4412cd7537614"
 }