@aui.io/aui-client 1.2.17 → 1.2.18

package/README.md

@@ -31,7 +31,8 @@ const client = new ApolloClient({
 ```typescript
 // Create a new task
 const taskResponse = await client.controllerApi.createTask({
-    user_id: 'user123'
+    user_id: 'user123',
+    task_origin_type: 'web-widget'  // Required: identifies the source of the task
 });
 
 console.log('Task ID:', taskResponse.id);
@@ -165,12 +166,15 @@ Create a new task for the agent.
 
 ```typescript
 const taskResponse = await client.controllerApi.createTask({
-    user_id: string    // Unique user identifier
+    user_id: string,              // Unique user identifier
+    task_origin_type: string      // Required: origin type (e.g., 'web-widget', 'mobile-app', 'api')
 });
 
 // Returns: { id: string, user_id: string, title: string, welcome_message?: string }
 ```
 
+**Note:** `task_origin_type` is required in v1.2.17+. Common values: `'web-widget'`, `'mobile-app'`, `'api'`, `'internal-tool'`
+
 #### `getTaskMessages(taskId)` - Get Task Messages
 Retrieve all messages for a specific task.
 
@@ -206,6 +210,17 @@ const tasksResponse = await client.controllerApi.listUserTasks({
 // Returns: { tasks: Task[], total: number, page: number, size: number }
 ```
 
+#### `getProductMetadata(link)` - Get Product Metadata
+Retrieve metadata for a product from a given URL/link.
+
+```typescript
+const metadata = await client.controllerApi.getProductMetadata({
+    link: string    // Product URL or link
+});
+
+// Returns: Record<string, any> - Product metadata object
+```
+
 ---
 
 ### WebSocket API
@@ -246,6 +261,11 @@ socket.on('close', (event: CloseEvent) => void);
 - `final_message` - Complete response with optional product cards
 - `error` - Error message from the agent
 
+**New in v0.6.0:**
+- **Message fields:** `welcome_message`, `executed_workflows` - Track workflow execution and welcome messages
+- **Card fields:** `category`, `query`, `sub_entities`, `self_review` - Enhanced product card information with self-review scoring
+- **Product Metadata API:** New endpoint to retrieve metadata from product URLs
+
 #### Socket Methods
 
 ```typescript
@@ -280,7 +300,8 @@ const client = new ApolloClient({
 async function searchProducts(userId: string, query: string) {
     // Step 1: Create a task
     const taskResponse = await client.controllerApi.createTask({
-        user_id: userId
+        user_id: userId,
+        task_origin_type: 'web-widget'
     });
     
     const taskId = taskResponse.id;
@@ -367,6 +388,40 @@ async function getTaskHistory(userId: string) {
 getTaskHistory('user123');
 ```
 
+### Get Product Metadata
+
+```typescript
+import { ApolloClient } from '@aui.io/aui-client';
+
+const client = new ApolloClient({
+    networkApiKey: 'API_KEY_YOUR_KEY_HERE'
+});
+
+async function fetchProductMetadata(productLink: string) {
+    try {
+        // Fetch metadata for a product
+        const metadata = await client.controllerApi.getProductMetadata({
+            link: productLink
+        });
+        
+        console.log('Product Metadata:', metadata);
+        
+        // Metadata might include: name, price, description, images, etc.
+        if (metadata) {
+            console.log('Available fields:', Object.keys(metadata));
+        }
+        
+        return metadata;
+    } catch (error) {
+        console.error('Error fetching product metadata:', error);
+        throw error;
+    }
+}
+
+// Example usage
+fetchProductMetadata('https://www.example.com/product/12345');
+```
+
 ## 🔧 Advanced Configuration
 
 ### Custom Timeout and Retries
@@ -380,7 +435,10 @@ const client = new ApolloClient({
 
 // Per-request overrides
 const taskResponse = await client.controllerApi.createTask(
-    { user_id: 'user123' },
+    { 
+        user_id: 'user123',
+        task_origin_type: 'web-widget'
+    },
     {
         timeoutInSeconds: 30,  // Override for this request only
         maxRetries: 2
@@ -414,7 +472,8 @@ const client = new ApolloClient({
 
 try {
     const taskResponse = await client.controllerApi.createTask({
-        user_id: 'user123'
+        user_id: 'user123',
+        task_origin_type: 'web-widget'
     });
 } catch (error) {
     if (error instanceof UnprocessableEntityError) {
@@ -534,6 +593,23 @@ const client = new ApolloClient({
 npm install --save-dev typescript@latest
 ```
 
+## 📚 Examples
+
+The `examples/` directory contains ready-to-run code examples:
+
+- **Product Metadata API** - [`examples/test-product-metadata.js`](./examples/test-product-metadata.js)
+  - Fetch product information from URLs
+  - Handle errors and edge cases
+  - Extract and use metadata
+
+Run examples:
+```bash
+export NETWORK_API_KEY="API_KEY_YOUR_KEY_HERE"
+node examples/test-product-metadata.js
+```
+
+See the [examples README](./examples/README.md) for more details.
+
 ## 🔗 Resources
 
 - **GitHub Repository:** [aui-io/aui-client-typescript](https://github.com/aui-io/aui-client-typescript)

package/dist/cjs/Client.js

@@ -45,8 +45,8 @@ class ApolloClient {
                 "x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@aui.io/aui-client",
-                "X-Fern-SDK-Version": "1.2.17",
-                "User-Agent": "@aui.io/aui-client/1.2.17",
+                "X-Fern-SDK-Version": "1.2.18",
+                "User-Agent": "@aui.io/aui-client/1.2.18",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/controllerApi/client/Client.d.ts

@@ -33,7 +33,8 @@ export declare class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request: Apollo.CreateTaskRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.CreateTaskResponse>;

package/dist/cjs/api/resources/controllerApi/client/Client.js

@@ -147,7 +147,8 @@ class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request, requestOptions) {

package/dist/cjs/api/resources/controllerApi/client/requests/CreateTaskRequest.d.ts

@@ -1,9 +1,12 @@
+import type * as Apollo from "../../../../index.js";
 /**
  * @example
  *     {
- *         user_id: "user_id"
+ *         user_id: "user_id",
+ *         task_origin_type: "stores"
  *     }
  */
 export interface CreateTaskRequest {
     user_id: string;
+    task_origin_type: Apollo.RecordOriginType;
 }

package/dist/cjs/api/types/Message.d.ts

@@ -9,4 +9,5 @@ export interface Message {
     welcome_message?: string;
     followup_suggestions: string[];
     executed_workflows?: string[];
+    url?: string;
 }

package/dist/cjs/api/types/RecordOriginType.d.ts

@@ -0,0 +1,9 @@
+export declare const RecordOriginType: {
+    readonly Stores: "stores";
+    readonly WebWidget: "web-widget";
+    readonly InspectionPlayground: "inspection-playground";
+    readonly FeedbackPlayground: "feedback-playground";
+    readonly LlmManagement: "llm-management";
+    readonly ThirdParty: "third-party";
+};
+export type RecordOriginType = (typeof RecordOriginType)[keyof typeof RecordOriginType];

package/dist/cjs/api/types/RecordOriginType.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordOriginType = void 0;
+exports.RecordOriginType = {
+    Stores: "stores",
+    WebWidget: "web-widget",
+    InspectionPlayground: "inspection-playground",
+    FeedbackPlayground: "feedback-playground",
+    LlmManagement: "llm-management",
+    ThirdParty: "third-party",
+};

package/dist/cjs/api/types/index.d.ts

@@ -16,6 +16,7 @@ export * from "./OptionsSearchSelfReviewMethod.js";
 export * from "./ParameterType.js";
 export * from "./ProductCard.js";
 export * from "./ProductParameter.js";
+export * from "./RecordOriginType.js";
 export * from "./StreamingUpdatePayload.js";
 export * from "./TaskInteractionOptionSelfReview.js";
 export * from "./TaskInteractionOptionSelfReviewScore.js";

package/dist/cjs/api/types/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./OptionsSearchSelfReviewMethod.js"), exports);
 __exportStar(require("./ParameterType.js"), exports);
 __exportStar(require("./ProductCard.js"), exports);
 __exportStar(require("./ProductParameter.js"), exports);
+__exportStar(require("./RecordOriginType.js"), exports);
 __exportStar(require("./StreamingUpdatePayload.js"), exports);
 __exportStar(require("./TaskInteractionOptionSelfReview.js"), exports);
 __exportStar(require("./TaskInteractionOptionSelfReviewScore.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.17";
+export declare const SDK_VERSION = "1.2.18";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.2.17";
+exports.SDK_VERSION = "1.2.18";

package/dist/esm/Client.mjs

@@ -9,8 +9,8 @@ export class ApolloClient {
                 "x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@aui.io/aui-client",
-                "X-Fern-SDK-Version": "1.2.17",
-                "User-Agent": "@aui.io/aui-client/1.2.17",
+                "X-Fern-SDK-Version": "1.2.18",
+                "User-Agent": "@aui.io/aui-client/1.2.18",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/controllerApi/client/Client.d.mts

@@ -33,7 +33,8 @@ export declare class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request: Apollo.CreateTaskRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.CreateTaskResponse>;

package/dist/esm/api/resources/controllerApi/client/Client.mjs

@@ -111,7 +111,8 @@ export class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request, requestOptions) {

package/dist/esm/api/resources/controllerApi/client/requests/CreateTaskRequest.d.mts

@@ -1,9 +1,12 @@
+import type * as Apollo from "../../../../index.mjs";
 /**
  * @example
  *     {
- *         user_id: "user_id"
+ *         user_id: "user_id",
+ *         task_origin_type: "stores"
  *     }
  */
 export interface CreateTaskRequest {
     user_id: string;
+    task_origin_type: Apollo.RecordOriginType;
 }

package/dist/esm/api/types/Message.d.mts

@@ -9,4 +9,5 @@ export interface Message {
     welcome_message?: string;
     followup_suggestions: string[];
     executed_workflows?: string[];
+    url?: string;
 }

package/dist/esm/api/types/RecordOriginType.d.mts

@@ -0,0 +1,9 @@
+export declare const RecordOriginType: {
+    readonly Stores: "stores";
+    readonly WebWidget: "web-widget";
+    readonly InspectionPlayground: "inspection-playground";
+    readonly FeedbackPlayground: "feedback-playground";
+    readonly LlmManagement: "llm-management";
+    readonly ThirdParty: "third-party";
+};
+export type RecordOriginType = (typeof RecordOriginType)[keyof typeof RecordOriginType];

package/dist/esm/api/types/RecordOriginType.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export const RecordOriginType = {
+    Stores: "stores",
+    WebWidget: "web-widget",
+    InspectionPlayground: "inspection-playground",
+    FeedbackPlayground: "feedback-playground",
+    LlmManagement: "llm-management",
+    ThirdParty: "third-party",
+};

package/dist/esm/api/types/index.d.mts

@@ -16,6 +16,7 @@ export * from "./OptionsSearchSelfReviewMethod.mjs";
 export * from "./ParameterType.mjs";
 export * from "./ProductCard.mjs";
 export * from "./ProductParameter.mjs";
+export * from "./RecordOriginType.mjs";
 export * from "./StreamingUpdatePayload.mjs";
 export * from "./TaskInteractionOptionSelfReview.mjs";
 export * from "./TaskInteractionOptionSelfReviewScore.mjs";

package/dist/esm/api/types/index.mjs

@@ -16,6 +16,7 @@ export * from "./OptionsSearchSelfReviewMethod.mjs";
 export * from "./ParameterType.mjs";
 export * from "./ProductCard.mjs";
 export * from "./ProductParameter.mjs";
+export * from "./RecordOriginType.mjs";
 export * from "./StreamingUpdatePayload.mjs";
 export * from "./TaskInteractionOptionSelfReview.mjs";
 export * from "./TaskInteractionOptionSelfReviewScore.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.17";
+export declare const SDK_VERSION = "1.2.18";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.2.17";
+export const SDK_VERSION = "1.2.18";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@aui.io/aui-client",
-    "version": "1.2.17",
+    "version": "1.2.18",
     "private": false,
     "repository": "github:aui-io/aui-client-typescript",
     "type": "commonjs",

package/reference.md

@@ -67,7 +67,8 @@ await client.controllerApi.listUserTasks({
 
 ```typescript
 await client.controllerApi.createTask({
-    user_id: "user_id"
+    user_id: "user_id",
+    task_origin_type: "stores"
 });
 
 ```