@relevanceai/sdk 3.0.0-alpha.5 → 3.0.0-alpha.6

package/README.md

@@ -183,6 +183,15 @@ const client = createClient(embedKey);
 #### Loading agents
 
 ```typescript
+// fetch all agents (with pagination)
+const agents = await Agent.getAll({ pageSize: 20, page: 1 });
+
+// fetch all agents with custom page size
+const agents = await Agent.getAll({ pageSize: 50, page: 3 });
+
+// fetch all agents using default options (pageSize: 20, page: 1)
+const agents = await Agent.getAll();
+
 // using the default client
 const agent = await Agent.get("agent-id");
 
@@ -290,7 +299,7 @@ in the Relevance AI workforce platform.
 
 #### Available Events
 
-- **`updated`**: Whenever a subject has been updated.
+- **`update`**: Whenever a subject has been update.
 - **`message`**: Unified event for all message types
 - **`error`**: Error notifications
 
@@ -337,6 +346,7 @@ createClient({ apiKey, region, project });
 
 // Access anywhere in your app
 import { Client } from "@relevanceai/sdk";
+
 const client = Client.default();
 ```
 
@@ -375,6 +385,7 @@ For complete working examples, check out the `internal/examples` directory:
 
   - (Agent) Creating tasks
   - (Agent) Getting a task
+  - (Agent) Getting all agents
   - (Agent) Getting all tasks
   - (Agent) Getting an agent
   - (Workforce) Creating a task
@@ -391,6 +402,7 @@ For complete working examples, check out the `internal/examples` directory:
 ```typescript
 class Client {
   constructor(key: Key);
+
   static default(): Client;
 
   readonly key: Key;
@@ -398,7 +410,9 @@ class Client {
   readonly project: string;
 
   isEmbedKey(): boolean;
+
   fetch<T>(endpoint: string, init?: RequestInit): Promise<T>;
+
   url(path: string): URL;
 }
 
@@ -425,7 +439,9 @@ class Key {
   readonly taskPrefix?: string;
 
   isEmbed(): boolean;
+
   fetchHeaders(): HeadersInit;
+
   toJSON(): CreateKeyOptions;
 }
 
@@ -450,6 +466,11 @@ interface GenerateEmbedKeyOptions {
 class Agent {
   static async get(id: string, client?: Client): Promise<Agent>;
 
+  static async getAll(
+    options?: GetAllOptions,
+    client?: Client
+  ): Promise<Agent[]>;
+
   readonly id: string;
   readonly name?: string;
   readonly description?: string;
@@ -492,6 +513,11 @@ interface GetTaskOptions {
     status?: TaskStatus[];
   };
 }
+
+interface GetAllOptions {
+  pageSize?: number; // default: 20
+  page?: number; // default: 1
+}
 ```
 
 ### Workforce
@@ -527,9 +553,11 @@ class Task<T extends Agent | Workforce = Agent> extends EventTarget {
   getMessages(options: { from: Date }): Promise<AnyTaskMessage[]>;
 
   subscribe(): void;
+
   unsubscribe(): void;
 
   addEventListener(type: string, listener: EventListener): void;
+
   removeEventListener(type: string, listener: EventListener): void;
 }
 
@@ -567,6 +595,11 @@ class UserMessage extends GenericMessage {
 
 class ToolMessage extends GenericMessage {
   readonly status: "cancelled" | "pending" | "running" | "completed" | "failed";
+  readonly tool?: Tool; // Available when message is from a tool (not subagent)
+  readonly toolOrAgentId: string; // ID of the tool or subagent
+
+  isSubAgent(): boolean; // Check if this is a subagent execution
+  subAgentTaskId: string | null; // Task ID if this is a subagent, null otherwise
 }
 
 class AgentErrorMessage extends GenericMessage {}
@@ -576,6 +609,20 @@ class WorkforceAgentMessage extends GenericMessage {}
 class WorkforceAgentHandoverMessage extends GenericMessage {}
 ```
 
+### Tool
+
+```typescript
+class Tool {
+  readonly id: string;
+  readonly name: string;
+  readonly avatar?: string;
+  readonly description?: string;
+  readonly region: Region;
+  readonly project: string;
+  readonly parametersSchema: JSONSchema4;
+}
+```
+
 ## Contributing
 
 We welcome contributions to improve the SDK. Please follow these guidelines:

package/esm/agent.d.ts

@@ -4,6 +4,7 @@ import { Task, type TaskStatus } from "./task/task.js";
 export interface AgentConfig {
     agent_id: string;
     public: boolean;
+    project: string;
     name?: string;
     description?: string;
     emoji?: string;
@@ -39,9 +40,14 @@ type GetTaskOptions = {
         status?: TaskStatus[];
     };
 };
+type GetAllOptions = {
+    pageSize?: number;
+    page?: number;
+};
 export declare class Agent {
     #private;
     static get(id: string, client?: Client): Promise<Agent>;
+    static getAll({ page, pageSize, }?: GetAllOptions, client?: Client): Promise<Agent[]>;
     private readonly client;
     constructor(config: AgentConfig, client: Client);
     get id(): string;

package/esm/agent.js

@@ -78,7 +78,7 @@ function statusToStates(status) {
             return ["errored-pending-approval", "timed-out", "unrecoverable"];
     }
 }
-function sortOptionsToParam(sort) {
+function taskSortOptionsToParam(sort) {
     if ("createdAt" in sort) {
         return { insert_date: sort.createdAt };
     }
@@ -93,6 +93,16 @@ export class Agent {
         const config = await Agent.#fetchConfig(id, client);
         return new Agent(config, client);
     }
+    static async getAll({ page = 1, pageSize = 20, } = {}, client = Client.default()) {
+        const { results } = await client.fetch("/agents/list", {
+            method: "POST",
+            body: JSON.stringify({
+                page_size: pageSize,
+                page,
+            }),
+        });
+        return results.map((config) => new Agent(config, client));
+    }
     static #fetchConfig(agentId, client = Client.default()) {
         return client.fetch(`/agents/${agentId}/get`).then(({ agent }) => agent);
     }
@@ -109,7 +119,7 @@ export class Agent {
         return this.client.region;
     }
     get project() {
-        return this.client.project;
+        return this.#config.project;
     }
     get name() {
         return this.#config.name;
@@ -149,7 +159,7 @@ export class Agent {
                 }
             }
         }
-        const sortParam = sortOptionsToParam(sort);
+        const sortParam = taskSortOptionsToParam(sort);
         const query = new URLSearchParams([
             ["filters", JSON.stringify(filtersParam)],
             ["sort", JSON.stringify([sortParam])],
@@ -204,6 +214,6 @@ export class Agent {
         if (task) {
             task[resetBackoffDuration]();
         }
-        return task ?? this.getTask(res.conversation_id);
+        return task ?? await this.getTask(res.conversation_id);
     }
 }

package/esm/client.d.ts

@@ -30,7 +30,7 @@ export declare class Client {
     get region(): Region;
     get project(): string;
     isEmbedKey(): boolean;
-    fetch<T>(input: "/agents/trigger" | `/agents/${string}/get` | `/agents/${string}/tasks/${string}/metadata` | `/agents/${string}/tasks/${string}/view` | "/agents/conversations/list" | "/services/get_temporary_file_upload_url" | `/workforce/items/${string}` | `/workforce/tasks/${string}/metadata` | `/workforce/items/${string}/tasks/${string}/messages` | "/workforce/trigger", init?: RequestInit): Promise<T>;
+    fetch<T>(input: "/agents/trigger" | `/agents/${string}/get` | `/agents/${string}/tasks/${string}/metadata` | `/agents/${string}/tasks/${string}/view` | "/agents/conversations/list" | "/services/get_temporary_file_upload_url" | `/workforce/items/${string}` | `/workforce/tasks/${string}/metadata` | `/workforce/items/${string}/tasks/${string}/messages` | "/workforce/trigger" | "/agents/list", init?: RequestInit): Promise<T>;
     url(path: string): URL;
     uploadTempFile(file: File): Promise<Attachment>;
 }

package/esm/event.d.ts

@@ -1,6 +1,6 @@
 import type { AgentErrorMessage } from "./message/agent-error.js";
 import type { AnyTaskMessage } from "./message/task.js";
-export declare class TaskUpdatedEvent extends CustomEvent<void> {
+export declare class TaskUpdateEvent extends CustomEvent<void> {
     readonly type = "update";
     constructor();
 }

package/esm/event.js

@@ -1,4 +1,4 @@
-export class TaskUpdatedEvent extends CustomEvent {
+export class TaskUpdateEvent extends CustomEvent {
     type = "update";
     constructor() {
         super("update");

package/esm/message/tool.d.ts

@@ -1,5 +1,7 @@
+import type { JSONSchema4 } from "json-schema";
 import type { Region } from "../region.js";
-import { GenericMessage } from "./task.js";
+import { GenericMessage, type TaskMessageData } from "./task.js";
+import { Tool } from "../tool.js";
 type ToolState = "cancelled" | "error" | "finished" | "pending" | "running";
 export type ToolStatus = "cancelled" | "error" | "completed" | "pending" | "running";
 export interface ToolMessageContent {
@@ -21,13 +23,19 @@ export interface ToolMessageContent {
         step_name: string;
     }[];
     tool_config: {
-        id: string;
-        type: "tool" | "agent";
+        type: "agent" | "tool";
+        title: string;
+        description: string;
         region: Region;
         project: string;
+        id: string;
+        emoji?: string;
+        params_schema: JSONSchema4;
     };
 }
 export declare class ToolMessage extends GenericMessage<ToolMessageContent> {
+    readonly tool?: Tool;
+    constructor(message: TaskMessageData<ToolMessageContent>);
     /**
      * The tool status for _this_ message.
      *
@@ -57,11 +65,11 @@ export declare class ToolMessage extends GenericMessage<ToolMessageContent> {
         message: string;
     }[];
     /**
-     * The tool's ID.
+     * The tool or agent ID.
      *
      * @property {string}
      */
-    get toolId(): string;
+    get toolOrAgentId(): string;
     /**
      * The agent's ID, if a sub-agent.
      *
@@ -82,8 +90,8 @@ export declare class ToolMessage extends GenericMessage<ToolMessageContent> {
      */
     get region(): Region;
     /**
-     * The task ID the sub-agent ran. Will be `null` if the tool message is not
-     * a sub-agent.
+     * The task ID the subagent ran. Will be `null` if the tool message is not
+     * a subagent.
      *
      * @property {string}
      * @see {@link ToolMessage.isSubAgent}

package/esm/message/tool.js

@@ -1,5 +1,15 @@
 import { GenericMessage } from "./task.js";
+import { Tool } from "../tool.js";
 export class ToolMessage extends GenericMessage {
+    tool;
+    constructor(message) {
+        super(message);
+        if (message.content.tool_config.type === "tool") {
+            const { id, ...config } = message.content.tool_config;
+            this.tool = new Tool({ studio_id: id, ...config });
+        }
+        // @todo: subagent
+    }
     /**
      * The tool status for _this_ message.
      *
@@ -48,11 +58,11 @@ export class ToolMessage extends GenericMessage {
         }));
     }
     /**
-     * The tool's ID.
+     * The tool or agent ID.
      *
      * @property {string}
      */
-    get toolId() {
+    get toolOrAgentId() {
         return this.message.content.tool_config.id;
     }
     /**
@@ -83,8 +93,8 @@ export class ToolMessage extends GenericMessage {
         return this.message.content.tool_config.region;
     }
     /**
-     * The task ID the sub-agent ran. Will be `null` if the tool message is not
-     * a sub-agent.
+     * The task ID the subagent ran. Will be `null` if the tool message is not
+     * a subagent.
      *
      * @property {string}
      * @see {@link ToolMessage.isSubAgent}

package/esm/message/user.d.ts

@@ -1,5 +1,10 @@
+import type { Attachment } from "../client.js";
 import { GenericMessage } from "./task.js";
 export interface UserMessageContent {
+    attachments?: {
+        file_url: string;
+        file_name: string;
+    }[];
     type: "user-message";
     text: string;
     is_trigger_message: boolean;
@@ -17,4 +22,16 @@ export declare class UserMessage extends GenericMessage<UserMessageContent> {
      * @returns {boolean}
      */
     isTrigger(): boolean;
+    /**
+     * The attachments sent with the message.
+     *
+     * @property {Attachment[]}
+     */
+    get attachments(): Attachment[];
+    /**
+     * Returns if the message has attachments.
+     *
+     * @returns {boolean}
+     */
+    hasAttachments(): boolean;
 }

package/esm/message/user.js

@@ -16,4 +16,23 @@ export class UserMessage extends GenericMessage {
     isTrigger() {
         return this.message.content.is_trigger_message;
     }
+    /**
+     * The attachments sent with the message.
+     *
+     * @property {Attachment[]}
+     */
+    get attachments() {
+        return (this.message.content.attachments?.map(({ file_name, file_url }) => ({
+            fileName: file_name,
+            fileUrl: file_url,
+        })) ?? []);
+    }
+    /**
+     * Returns if the message has attachments.
+     *
+     * @returns {boolean}
+     */
+    hasAttachments() {
+        return this.attachments.length > 0;
+    }
 }

package/esm/mod.d.ts

@@ -1,5 +1,6 @@
 export { Agent } from "./agent.js";
-export { Client, createClient } from "./client.js";
+export { type Attachment, Client, createClient } from "./client.js";
 export { Key } from "./key.js";
 export { type Region, REGION_AU, REGION_EU, REGION_US } from "./region.js";
 export { Workforce } from "./workforce.js";
+export type { Task } from "./task/task.js";

package/esm/task/task.js

@@ -1,6 +1,6 @@
 import { Emitter } from "../emitter.js";
 import { abortPromise, delay } from "../utils.js";
-import { TaskErrorEvent, TaskMessageEvent, TaskUpdatedEvent, } from "../event.js";
+import { TaskErrorEvent, TaskMessageEvent, TaskUpdateEvent, } from "../event.js";
 export const resetBackoffDuration = Symbol("resetBackoffDuration");
 const backoffStartingDuration = 1_000;
 const backoffMaxDuration = 60_000;
@@ -74,7 +74,7 @@ export class Task extends Emitter {
                     }
                     let hasChanges = false;
                     if (metadata.updatedAt > this.updatedAt) {
-                        this.dispatchEvent(new TaskUpdatedEvent());
+                        this.dispatchEvent(new TaskUpdateEvent());
                         hasChanges = true;
                     }
                     this.#metadata = metadata;

package/esm/tool.d.ts

@@ -0,0 +1,22 @@
+import type { Region } from "./region.js";
+import type { JSONSchema4 } from "json-schema";
+export type ToolConfig = {
+    region: Region;
+    project: string;
+    studio_id: string;
+    title: string;
+    description: string;
+    emoji?: string;
+    params_schema: JSONSchema4;
+};
+export declare class Tool {
+    #private;
+    constructor(config: ToolConfig);
+    get id(): string;
+    get region(): Region;
+    get project(): string;
+    get name(): string;
+    get avatar(): string | undefined;
+    get description(): string | undefined;
+    get parametersSchema(): JSONSchema4;
+}

package/esm/tool.js

@@ -0,0 +1,27 @@
+export class Tool {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    get id() {
+        return this.#config.studio_id;
+    }
+    get region() {
+        return this.#config.region;
+    }
+    get project() {
+        return this.#config.project;
+    }
+    get name() {
+        return this.#config.title;
+    }
+    get avatar() {
+        return this.#config.emoji;
+    }
+    get description() {
+        return this.#config.description;
+    }
+    get parametersSchema() {
+        return this.#config.params_schema;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relevanceai/sdk",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.6",
   "license": "MIT",
   "main": "./script/mod.js",
   "module": "./esm/mod.js",
@@ -11,5 +11,11 @@
     }
   },
   "scripts": {},
+  "dependencies": {
+    "json-schema": "^0.4.0"
+  },
+  "devDependencies": {
+    "@types/json-schema": "^7.0.15"
+  },
   "_generatedBy": "dnt@dev"
 }

package/script/agent.d.ts

@@ -4,6 +4,7 @@ import { Task, type TaskStatus } from "./task/task.js";
 export interface AgentConfig {
     agent_id: string;
     public: boolean;
+    project: string;
     name?: string;
     description?: string;
     emoji?: string;
@@ -39,9 +40,14 @@ type GetTaskOptions = {
         status?: TaskStatus[];
     };
 };
+type GetAllOptions = {
+    pageSize?: number;
+    page?: number;
+};
 export declare class Agent {
     #private;
     static get(id: string, client?: Client): Promise<Agent>;
+    static getAll({ page, pageSize, }?: GetAllOptions, client?: Client): Promise<Agent[]>;
     private readonly client;
     constructor(config: AgentConfig, client: Client);
     get id(): string;

package/script/agent.js

@@ -82,7 +82,7 @@ function statusToStates(status) {
             return ["errored-pending-approval", "timed-out", "unrecoverable"];
     }
 }
-function sortOptionsToParam(sort) {
+function taskSortOptionsToParam(sort) {
     if ("createdAt" in sort) {
         return { insert_date: sort.createdAt };
     }
@@ -97,6 +97,16 @@ class Agent {
         const config = await Agent.#fetchConfig(id, client);
         return new Agent(config, client);
     }
+    static async getAll({ page = 1, pageSize = 20, } = {}, client = client_js_1.Client.default()) {
+        const { results } = await client.fetch("/agents/list", {
+            method: "POST",
+            body: JSON.stringify({
+                page_size: pageSize,
+                page,
+            }),
+        });
+        return results.map((config) => new Agent(config, client));
+    }
     static #fetchConfig(agentId, client = client_js_1.Client.default()) {
         return client.fetch(`/agents/${agentId}/get`).then(({ agent }) => agent);
     }
@@ -113,7 +123,7 @@ class Agent {
         return this.client.region;
     }
     get project() {
-        return this.client.project;
+        return this.#config.project;
     }
     get name() {
         return this.#config.name;
@@ -153,7 +163,7 @@ class Agent {
                 }
             }
         }
-        const sortParam = sortOptionsToParam(sort);
+        const sortParam = taskSortOptionsToParam(sort);
         const query = new URLSearchParams([
             ["filters", JSON.stringify(filtersParam)],
             ["sort", JSON.stringify([sortParam])],
@@ -208,7 +218,7 @@ class Agent {
         if (task) {
             task[task_js_1.resetBackoffDuration]();
         }
-        return task ?? this.getTask(res.conversation_id);
+        return task ?? await this.getTask(res.conversation_id);
     }
 }
 exports.Agent = Agent;

package/script/client.d.ts

@@ -30,7 +30,7 @@ export declare class Client {
     get region(): Region;
     get project(): string;
     isEmbedKey(): boolean;
-    fetch<T>(input: "/agents/trigger" | `/agents/${string}/get` | `/agents/${string}/tasks/${string}/metadata` | `/agents/${string}/tasks/${string}/view` | "/agents/conversations/list" | "/services/get_temporary_file_upload_url" | `/workforce/items/${string}` | `/workforce/tasks/${string}/metadata` | `/workforce/items/${string}/tasks/${string}/messages` | "/workforce/trigger", init?: RequestInit): Promise<T>;
+    fetch<T>(input: "/agents/trigger" | `/agents/${string}/get` | `/agents/${string}/tasks/${string}/metadata` | `/agents/${string}/tasks/${string}/view` | "/agents/conversations/list" | "/services/get_temporary_file_upload_url" | `/workforce/items/${string}` | `/workforce/tasks/${string}/metadata` | `/workforce/items/${string}/tasks/${string}/messages` | "/workforce/trigger" | "/agents/list", init?: RequestInit): Promise<T>;
     url(path: string): URL;
     uploadTempFile(file: File): Promise<Attachment>;
 }

package/script/event.d.ts

@@ -1,6 +1,6 @@
 import type { AgentErrorMessage } from "./message/agent-error.js";
 import type { AnyTaskMessage } from "./message/task.js";
-export declare class TaskUpdatedEvent extends CustomEvent<void> {
+export declare class TaskUpdateEvent extends CustomEvent<void> {
     readonly type = "update";
     constructor();
 }

package/script/event.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskErrorEvent = exports.TaskMessageEvent = exports.TaskUpdatedEvent = void 0;
-class TaskUpdatedEvent extends CustomEvent {
+exports.TaskErrorEvent = exports.TaskMessageEvent = exports.TaskUpdateEvent = void 0;
+class TaskUpdateEvent extends CustomEvent {
     type = "update";
     constructor() {
         super("update");
     }
 }
-exports.TaskUpdatedEvent = TaskUpdatedEvent;
+exports.TaskUpdateEvent = TaskUpdateEvent;
 class TaskMessageEvent extends CustomEvent {
     type = "message";
     constructor(message) {

package/script/message/tool.d.ts

@@ -1,5 +1,7 @@
+import type { JSONSchema4 } from "json-schema";
 import type { Region } from "../region.js";
-import { GenericMessage } from "./task.js";
+import { GenericMessage, type TaskMessageData } from "./task.js";
+import { Tool } from "../tool.js";
 type ToolState = "cancelled" | "error" | "finished" | "pending" | "running";
 export type ToolStatus = "cancelled" | "error" | "completed" | "pending" | "running";
 export interface ToolMessageContent {
@@ -21,13 +23,19 @@ export interface ToolMessageContent {
         step_name: string;
     }[];
     tool_config: {
-        id: string;
-        type: "tool" | "agent";
+        type: "agent" | "tool";
+        title: string;
+        description: string;
         region: Region;
         project: string;
+        id: string;
+        emoji?: string;
+        params_schema: JSONSchema4;
     };
 }
 export declare class ToolMessage extends GenericMessage<ToolMessageContent> {
+    readonly tool?: Tool;
+    constructor(message: TaskMessageData<ToolMessageContent>);
     /**
      * The tool status for _this_ message.
      *
@@ -57,11 +65,11 @@ export declare class ToolMessage extends GenericMessage<ToolMessageContent> {
         message: string;
     }[];
     /**
-     * The tool's ID.
+     * The tool or agent ID.
      *
      * @property {string}
      */
-    get toolId(): string;
+    get toolOrAgentId(): string;
     /**
      * The agent's ID, if a sub-agent.
      *
@@ -82,8 +90,8 @@ export declare class ToolMessage extends GenericMessage<ToolMessageContent> {
      */
     get region(): Region;
     /**
-     * The task ID the sub-agent ran. Will be `null` if the tool message is not
-     * a sub-agent.
+     * The task ID the subagent ran. Will be `null` if the tool message is not
+     * a subagent.
      *
      * @property {string}
      * @see {@link ToolMessage.isSubAgent}

package/script/message/tool.js

@@ -2,7 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolMessage = void 0;
 const task_js_1 = require("./task.js");
+const tool_js_1 = require("../tool.js");
 class ToolMessage extends task_js_1.GenericMessage {
+    tool;
+    constructor(message) {
+        super(message);
+        if (message.content.tool_config.type === "tool") {
+            const { id, ...config } = message.content.tool_config;
+            this.tool = new tool_js_1.Tool({ studio_id: id, ...config });
+        }
+        // @todo: subagent
+    }
     /**
      * The tool status for _this_ message.
      *
@@ -51,11 +61,11 @@ class ToolMessage extends task_js_1.GenericMessage {
         }));
     }
     /**
-     * The tool's ID.
+     * The tool or agent ID.
      *
      * @property {string}
      */
-    get toolId() {
+    get toolOrAgentId() {
         return this.message.content.tool_config.id;
     }
     /**
@@ -86,8 +96,8 @@ class ToolMessage extends task_js_1.GenericMessage {
         return this.message.content.tool_config.region;
     }
     /**
-     * The task ID the sub-agent ran. Will be `null` if the tool message is not
-     * a sub-agent.
+     * The task ID the subagent ran. Will be `null` if the tool message is not
+     * a subagent.
      *
      * @property {string}
      * @see {@link ToolMessage.isSubAgent}

package/script/message/user.d.ts

@@ -1,5 +1,10 @@
+import type { Attachment } from "../client.js";
 import { GenericMessage } from "./task.js";
 export interface UserMessageContent {
+    attachments?: {
+        file_url: string;
+        file_name: string;
+    }[];
     type: "user-message";
     text: string;
     is_trigger_message: boolean;
@@ -17,4 +22,16 @@ export declare class UserMessage extends GenericMessage<UserMessageContent> {
      * @returns {boolean}
      */
     isTrigger(): boolean;
+    /**
+     * The attachments sent with the message.
+     *
+     * @property {Attachment[]}
+     */
+    get attachments(): Attachment[];
+    /**
+     * Returns if the message has attachments.
+     *
+     * @returns {boolean}
+     */
+    hasAttachments(): boolean;
 }

package/script/message/user.js

@@ -19,5 +19,24 @@ class UserMessage extends task_js_1.GenericMessage {
     isTrigger() {
         return this.message.content.is_trigger_message;
     }
+    /**
+     * The attachments sent with the message.
+     *
+     * @property {Attachment[]}
+     */
+    get attachments() {
+        return (this.message.content.attachments?.map(({ file_name, file_url }) => ({
+            fileName: file_name,
+            fileUrl: file_url,
+        })) ?? []);
+    }
+    /**
+     * Returns if the message has attachments.
+     *
+     * @returns {boolean}
+     */
+    hasAttachments() {
+        return this.attachments.length > 0;
+    }
 }
 exports.UserMessage = UserMessage;

package/script/mod.d.ts

@@ -1,5 +1,6 @@
 export { Agent } from "./agent.js";
-export { Client, createClient } from "./client.js";
+export { type Attachment, Client, createClient } from "./client.js";
 export { Key } from "./key.js";
 export { type Region, REGION_AU, REGION_EU, REGION_US } from "./region.js";
 export { Workforce } from "./workforce.js";
+export type { Task } from "./task/task.js";

package/script/task/task.js

@@ -77,7 +77,7 @@ class Task extends emitter_js_1.Emitter {
                     }
                     let hasChanges = false;
                     if (metadata.updatedAt > this.updatedAt) {
-                        this.dispatchEvent(new event_js_1.TaskUpdatedEvent());
+                        this.dispatchEvent(new event_js_1.TaskUpdateEvent());
                         hasChanges = true;
                     }
                     this.#metadata = metadata;

package/script/tool.d.ts

@@ -0,0 +1,22 @@
+import type { Region } from "./region.js";
+import type { JSONSchema4 } from "json-schema";
+export type ToolConfig = {
+    region: Region;
+    project: string;
+    studio_id: string;
+    title: string;
+    description: string;
+    emoji?: string;
+    params_schema: JSONSchema4;
+};
+export declare class Tool {
+    #private;
+    constructor(config: ToolConfig);
+    get id(): string;
+    get region(): Region;
+    get project(): string;
+    get name(): string;
+    get avatar(): string | undefined;
+    get description(): string | undefined;
+    get parametersSchema(): JSONSchema4;
+}

package/script/tool.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tool = void 0;
+class Tool {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    get id() {
+        return this.#config.studio_id;
+    }
+    get region() {
+        return this.#config.region;
+    }
+    get project() {
+        return this.#config.project;
+    }
+    get name() {
+        return this.#config.title;
+    }
+    get avatar() {
+        return this.#config.emoji;
+    }
+    get description() {
+        return this.#config.description;
+    }
+    get parametersSchema() {
+        return this.#config.params_schema;
+    }
+}
+exports.Tool = Tool;