@relevanceai/sdk 3.0.0-alpha.2 → 3.0.0-alpha.3

package/script/emitter.d.ts

@@ -0,0 +1,16 @@
+export type EventMap = Record<string, unknown>;
+/**
+ * Emitter
+ *
+ * Abstraction for type-assisting event targets.
+ *
+ * @internal
+ */
+export declare abstract class Emitter<M extends EventMap = Record<string, never>> extends EventTarget {
+    addEventListener<K extends keyof M>(type: Extract<K, string>, listener: ((event: CustomEvent<M[K]>) => void) | {
+        handleEvent: (event: CustomEvent<M[K]>) => void;
+    } | null, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener<K extends keyof M>(type: Extract<K, string>, listener: ((event: CustomEvent<M[K]>) => void) | {
+        handleEvent: (event: CustomEvent<M[K]>) => void;
+    } | null, options?: boolean | AddEventListenerOptions): void;
+}

package/script/emitter.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Emitter = void 0;
+/**
+ * Emitter
+ *
+ * Abstraction for type-assisting event targets.
+ *
+ * @internal
+ */
+class Emitter extends EventTarget {
+    addEventListener(type, listener, options) {
+        super.addEventListener(type, listener, options);
+    }
+    removeEventListener(type, listener, options) {
+        super.removeEventListener(type, listener, options);
+    }
+}
+exports.Emitter = Emitter;

package/{esm/events.d.ts → script/event.d.ts}

@@ -1,4 +1,7 @@
-import type { TaskMessage } from "./message.js";
+import type { AgentErrorMessage } from "./message/agent-error.js";
+import type { AgentMessage } from "./message/agent.js";
+import type { ToolMessage } from "./message/tool.js";
+import type { UserMessage } from "./message/user.js";
 import type { TaskStatus } from "./task.js";
 export declare class TaskStartEvent extends CustomEvent<{
     id: string;
@@ -14,27 +17,21 @@ export declare class TaskStatusEvent extends CustomEvent<{
     constructor(status: TaskStatus);
 }
 export declare class TaskMessageEvent extends CustomEvent<{
-    message: TaskMessage;
+    message: AgentMessage | UserMessage;
 }> {
     readonly type = "message";
-    constructor(message: TaskMessage);
+    constructor(message: AgentMessage | UserMessage);
     isUserMessage(): boolean;
 }
 export declare class TaskUpdateEvent extends CustomEvent<{
-    message: TaskMessage;
+    message: ToolMessage;
 }> {
     readonly type = "update";
-    constructor(message: TaskMessage);
-}
-export declare class TaskActionEvent extends CustomEvent<{
-    message: TaskMessage;
-}> {
-    readonly type = "action";
-    constructor(message: TaskMessage);
+    constructor(message: ToolMessage);
 }
 export declare class TaskErrorEvent extends CustomEvent<{
-    message: TaskMessage;
+    message: AgentErrorMessage;
 }> {
     readonly type = "error";
-    constructor(message: TaskMessage);
+    constructor(message: AgentErrorMessage);
 }

package/script/{events.js → event.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskErrorEvent = exports.TaskActionEvent = exports.TaskUpdateEvent = exports.TaskMessageEvent = exports.TaskStatusEvent = exports.TaskStartEvent = void 0;
+exports.TaskErrorEvent = exports.TaskUpdateEvent = exports.TaskMessageEvent = exports.TaskStatusEvent = exports.TaskStartEvent = void 0;
 class TaskStartEvent extends CustomEvent {
     type = "start";
     constructor(id, status) {
@@ -32,13 +32,6 @@ class TaskUpdateEvent extends CustomEvent {
     }
 }
 exports.TaskUpdateEvent = TaskUpdateEvent;
-class TaskActionEvent extends CustomEvent {
-    type = "action";
-    constructor(message) {
-        super("action", { detail: { message } });
-    }
-}
-exports.TaskActionEvent = TaskActionEvent;
 class TaskErrorEvent extends CustomEvent {
     type = "error";
     constructor(message) {

package/script/message/agent-error.d.ts

@@ -0,0 +1,6 @@
+import { TaskMessage } from "./task.js";
+export interface AgentErrorMessageContent {
+    type: "agent-error";
+}
+export declare class AgentErrorMessage extends TaskMessage<AgentErrorMessageContent> {
+}

package/script/message/agent-error.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentErrorMessage = void 0;
+const task_js_1 = require("./task.js");
+class AgentErrorMessage extends task_js_1.TaskMessage {
+}
+exports.AgentErrorMessage = AgentErrorMessage;

package/script/message/agent.d.ts

@@ -0,0 +1,9 @@
+import { TaskMessage } from "./task.js";
+export interface AgentMessageContent {
+    type: "agent-message";
+    text: string;
+}
+export declare class AgentMessage extends TaskMessage<AgentMessageContent> {
+    get text(): string;
+    get agentId(): string;
+}

package/script/message/agent.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentMessage = void 0;
+const task_js_1 = require("./task.js");
+class AgentMessage extends task_js_1.TaskMessage {
+    get text() {
+        return this.message.content.text;
+    }
+    get agentId() {
+        return "";
+    }
+}
+exports.AgentMessage = AgentMessage;

package/script/message/task.d.ts

@@ -0,0 +1,42 @@
+import type { AgentMessage } from "./agent.js";
+import type { AgentErrorMessage } from "./agent-error.js";
+import type { ToolMessage } from "./tool.js";
+import type { UserMessage } from "./user.js";
+export type AnyTaskMessage = AgentMessage | AgentErrorMessage | ToolMessage | UserMessage;
+interface MessageContent {
+    type: AnyTaskMessage["type"];
+}
+export interface TaskMessageData<C extends MessageContent = MessageContent> {
+    item_id: string;
+    insert_date_: string;
+    content: C;
+}
+export declare abstract class TaskMessage<C extends MessageContent = MessageContent> {
+    protected readonly message: TaskMessageData<C>;
+    constructor(message: TaskMessageData<C>);
+    /**
+     * The task's message type.
+     *
+     * @property {"agent-error" | "agent-message" | "tool-run" | "user-message"}
+     */
+    get type(): C["type"];
+    /**
+     * The task message ID. Used for referencing the message.
+     *
+     * @property {string}
+     */
+    get id(): string;
+    /**
+     * The time the task was created.
+     *
+     * @property {Date}
+     */
+    get createdAt(): Date;
+    /**
+     * Returns if the message was sent from the agent.
+     *
+     * @returns {boolean}
+     */
+    isAgent(): boolean;
+}
+export {};

package/script/message/task.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskMessage = void 0;
+class TaskMessage {
+    message;
+    constructor(message) {
+        this.message = message;
+    }
+    /**
+     * The task's message type.
+     *
+     * @property {"agent-error" | "agent-message" | "tool-run" | "user-message"}
+     */
+    get type() {
+        return this.message.content.type;
+    }
+    /**
+     * The task message ID. Used for referencing the message.
+     *
+     * @property {string}
+     */
+    get id() {
+        return this.message.item_id;
+    }
+    /**
+     * The time the task was created.
+     *
+     * @property {Date}
+     */
+    get createdAt() {
+        return new Date(this.message.insert_date_);
+    }
+    /**
+     * Returns if the message was sent from the agent.
+     *
+     * @returns {boolean}
+     */
+    isAgent() {
+        return this.type === "agent-message";
+    }
+}
+exports.TaskMessage = TaskMessage;

package/script/message/tool.d.ts

@@ -0,0 +1,108 @@
+import type { Region } from "../region.js";
+import { TaskMessage } from "./task.js";
+export interface ToolMessageContent {
+    type: "tool-run";
+    tool_run_state: "cancelled" | "error" | "finished" | "pending" | "running";
+    output: Record<string, unknown> & {
+        _agent_conversation_details?: {
+            agent_id: string;
+            conversation_id: string;
+        };
+    };
+    params: {
+        resolved?: Record<string, unknown>;
+        valid: boolean;
+    };
+    errors: {
+        body: string;
+        raw: string;
+        step_name: string;
+    }[];
+    tool_config: {
+        id: string;
+        type: "tool" | "agent";
+        region: Region;
+        project: string;
+    };
+}
+export declare class ToolMessage extends TaskMessage<ToolMessageContent> {
+    /**
+     * The tool status for _this_ message.
+     *
+     * @property {"cancelled" | "error" | "finished" | "pending" | "running"}
+     */
+    get status(): "cancelled" | "error" | "finished" | "pending" | "running";
+    /**
+     * Parameters used to call the tool.
+     *
+     * @property {object}
+     */
+    get params(): Record<string, unknown> | null;
+    /**
+     * The tool's output. Will be `null` if the status is **not** "finished".
+     *
+     * @property {object|null}
+     */
+    get output(): Record<string, unknown> | null;
+    /**
+     * Tool errors.
+     *
+     * @property {array}
+     * @see {@link ToolMessage#hasErrors}
+     */
+    get errors(): {
+        stepName: string;
+        message: string;
+    }[];
+    /**
+     * The tool's ID.
+     *
+     * @property {string}
+     */
+    get toolId(): string;
+    /**
+     * The agent's ID, if a sub-agent.
+     *
+     * @property {string}
+     * @see {@link ToolMessage.isSubAgent}
+     */
+    get agentId(): string | null;
+    /**
+     * The tool/agent's corresponding project.
+     *
+     * @property {string}
+     */
+    get project(): string;
+    /**
+     * The tool/agent's corresponding region.
+     *
+     * @property {Region}
+     */
+    get region(): Region;
+    /**
+     * The task ID the sub-agent ran. Will be `null` if the tool message is not
+     * a sub-agent.
+     *
+     * @property {string}
+     * @see {@link ToolMessage.isSubAgent}
+     */
+    get subAgentTaskId(): string | null;
+    /**
+     * Checks if the tool message came from a sub-agent.
+     *
+     * @returns {boolean}
+     */
+    isSubAgent(): boolean;
+    /**
+     * Checks if the tool call parameters where valid.
+     *
+     * @returns {boolean}
+     */
+    areParamsValid(): boolean;
+    /**
+     * Returns if the tool message has any errors.
+     *
+     * @returns {boolean}
+     */
+    hasErrors(): boolean;
+}

package/script/message/tool.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolMessage = void 0;
+const task_js_1 = require("./task.js");
+class ToolMessage extends task_js_1.TaskMessage {
+    /**
+     * The tool status for _this_ message.
+     *
+     * @property {"cancelled" | "error" | "finished" | "pending" | "running"}
+     */
+    get status() {
+        return this.message.content.tool_run_state;
+    }
+    /**
+     * Parameters used to call the tool.
+     *
+     * @property {object}
+     */
+    get params() {
+        return this.message.content.params.resolved ?? null;
+    }
+    /**
+     * The tool's output. Will be `null` if the status is **not** "finished".
+     *
+     * @property {object|null}
+     */
+    get output() {
+        return this.status === "finished" ? this.message.content.output : null;
+    }
+    /**
+     * Tool errors.
+     *
+     * @property {array}
+     * @see {@link ToolMessage#hasErrors}
+     */
+    get errors() {
+        return this.message.content.errors.map((e) => ({
+            stepName: e.step_name,
+            message: e.body,
+        }));
+    }
+    /**
+     * The tool's ID.
+     *
+     * @property {string}
+     */
+    get toolId() {
+        return this.message.content.tool_config.id;
+    }
+    /**
+     * The agent's ID, if a sub-agent.
+     *
+     * @property {string}
+     * @see {@link ToolMessage.isSubAgent}
+     */
+    get agentId() {
+        return this.isSubAgent()
+            ? this.message.content.output._agent_conversation_details?.agent_id
+            : null;
+    }
+    /**
+     * The tool/agent's corresponding project.
+     *
+     * @property {string}
+     */
+    get project() {
+        return this.message.content.tool_config.project;
+    }
+    /**
+     * The tool/agent's corresponding region.
+     *
+     * @property {Region}
+     */
+    get region() {
+        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.
+     *
+     * @property {string}
+     * @see {@link ToolMessage.isSubAgent}
+     */
+    get subAgentTaskId() {
+        return this.message.content.output._agent_conversation_details
+            ?.conversation_id ?? null;
+    }
+    /**
+     * Checks if the tool message came from a sub-agent.
+     *
+     * @returns {boolean}
+     */
+    isSubAgent() {
+        return this.message.content.tool_config.type === "agent";
+    }
+    /**
+     * Checks if the tool call parameters where valid.
+     *
+     * @returns {boolean}
+     */
+    areParamsValid() {
+        return this.message.content.params.valid;
+    }
+    /**
+     * Returns if the tool message has any errors.
+     *
+     * @returns {boolean}
+     */
+    hasErrors() {
+        return this.message.content.errors.length > 0;
+    }
+}
+exports.ToolMessage = ToolMessage;

package/script/message/user.d.ts

@@ -0,0 +1,20 @@
+import { TaskMessage } from "./task.js";
+export interface UserMessageContent {
+    type: "user-message";
+    text: string;
+    is_trigger_message: boolean;
+}
+export declare class UserMessage extends TaskMessage<UserMessageContent> {
+    /**
+     * The message as text sent.
+     *
+     * @property {string} text
+     */
+    get text(): string;
+    /**
+     * Returns if the message triggered a subject.
+     *
+     * @returns {boolean}
+     */
+    isTrigger(): boolean;
+}

package/script/message/user.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserMessage = void 0;
+const task_js_1 = require("./task.js");
+class UserMessage extends task_js_1.TaskMessage {
+    /**
+     * The message as text sent.
+     *
+     * @property {string} text
+     */
+    get text() {
+        return this.message.content.text;
+    }
+    /**
+     * Returns if the message triggered a subject.
+     *
+     * @returns {boolean}
+     */
+    isTrigger() {
+        return this.message.content.is_trigger_message;
+    }
+}
+exports.UserMessage = UserMessage;

package/script/mod.d.ts

@@ -2,6 +2,9 @@ export { Agent } from "./agent.js";
 export { Client, createClient } from "./client.js";
 export { Key } from "./key.js";
 export { type Region, REGION_AU, REGION_EU, REGION_US } from "./region.js";
-export type { AgentTask } from "./agent-task.js";
-export type { TaskMessage } from "./message.js";
-export type { Task, TaskStatus } from "./task.js";
+export { Task, type TaskStatus } from "./task.js";
+export type { AgentErrorMessage } from "./message/agent-error.js";
+export type { AgentMessage } from "./message/agent.js";
+export type { ToolMessage } from "./message/tool.js";
+export type { UserMessage } from "./message/user.js";
+export type { AnyTaskMessage } from "./message/task.js";

package/script/mod.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REGION_US = exports.REGION_EU = exports.REGION_AU = exports.Key = exports.createClient = exports.Client = exports.Agent = void 0;
+exports.Task = exports.REGION_US = exports.REGION_EU = exports.REGION_AU = exports.Key = exports.createClient = exports.Client = exports.Agent = void 0;
 var agent_js_1 = require("./agent.js");
 Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return agent_js_1.Agent; } });
 var client_js_1 = require("./client.js");
@@ -12,3 +12,5 @@ var region_js_1 = require("./region.js");
 Object.defineProperty(exports, "REGION_AU", { enumerable: true, get: function () { return region_js_1.REGION_AU; } });
 Object.defineProperty(exports, "REGION_EU", { enumerable: true, get: function () { return region_js_1.REGION_EU; } });
 Object.defineProperty(exports, "REGION_US", { enumerable: true, get: function () { return region_js_1.REGION_US; } });
+var task_js_1 = require("./task.js");
+Object.defineProperty(exports, "Task", { enumerable: true, get: function () { return task_js_1.Task; } });

package/script/task.d.ts

@@ -1,25 +1,57 @@
+import { Agent } from "./agent.js";
 import { Client } from "./client.js";
-import type { TaskMessage } from "./message.js";
+import { Emitter } from "./emitter.js";
+import { AgentMessage } from "./message/agent.js";
+import type { AnyTaskMessage } from "./message/task.js";
+import { ToolMessage } from "./message/tool.js";
+import { UserMessage } from "./message/user.js";
+export type TaskState = "idle" | "starting-up" | "running" | "pending-approval" | "waiting-for-capacity" | "cancelled" | "timed-out" | "escalated" | "unrecoverable" | "paused" | "completed" | "errored-pending-approval" | "queued-for-approval" | "queued-for-rerun";
 export type TaskStatus = "not-started" | "idle" | "queued" | "running" | "action" | "complete" | "error";
-export declare abstract class Task<S, E extends Record<string, unknown>> extends EventTarget {
+type TaskMetadata = {
+    knowledge_set: string;
+    insert_date: string;
+    update_date: string;
+    conversation: {
+        created_by_user_id: string;
+        state: TaskState;
+        title: string;
+    };
+};
+type TaskEventMap = {
+    start: {
+        status: TaskStatus;
+    };
+    status: {
+        status: TaskStatus;
+    };
+    message: {
+        message: AgentMessage | UserMessage;
+    };
+    update: {
+        message: ToolMessage;
+    };
+};
+export declare const resetSubscribeBackoff: unique symbol;
+export declare class Task extends Emitter<TaskEventMap> {
     #private;
-    readonly subject: S;
+    static get(id: string, agentOrAgentId: Agent | string, client?: Client): Promise<Task>;
+    readonly agent: Agent;
     protected readonly client: Client;
-    private listenController;
-    abstract fetchMessages(fetchOptions?: {
+    protected constructor(metadata: TaskMetadata, agent: Agent, client?: Client);
+    get id(): string;
+    get title(): string;
+    get status(): TaskStatus;
+    isRunning(): boolean;
+    getMessages({ from }?: {
         from?: Date;
-    }): Promise<TaskMessage[]>;
-    abstract fetchStatus(): Promise<TaskStatus>;
-    constructor(subject: S, id?: string | undefined, client?: Client);
-    get id(): string | undefined;
-    protected setId(id: string, status?: TaskStatus): void;
-    listen(): void;
-    isListening(): boolean;
-    stopListening(): void;
-    addEventListener<K extends keyof E>(type: Extract<K, string>, listener: ((event: CustomEvent<E[K]>) => void) | {
-        handleEvent: (event: CustomEvent<E[K]>) => void;
-    } | null, options?: boolean | AddEventListenerOptions): void;
-    removeEventListener<K extends keyof E>(type: Extract<K, string>, listener: ((event: CustomEvent<E[K]>) => void) | {
-        handleEvent: (event: CustomEvent<E[K]>) => void;
+    }): Promise<AnyTaskMessage[]>;
+    protected refresh(): Promise<void>;
+    [resetSubscribeBackoff](): void;
+    subscribe(): void;
+    protected isSubscribed(): boolean;
+    unsubscribe(): void;
+    addEventListener<K extends keyof TaskEventMap>(type: Extract<K, string>, listener: ((event: CustomEvent<TaskEventMap[K]>) => void) | {
+        handleEvent: (event: CustomEvent<TaskEventMap[K]>) => void;
     } | null, options?: boolean | AddEventListenerOptions): void;
 }
+export {};