asteroid-odyssey 1.0.24 → 1.1.2

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Client } from '@hey-api/client-fetch';
-import type { CreateWorkflowRequest, WorkflowExecutionRequest, Execution, BrowserSession } from './generated/agents/types.gen';
+import type { StructuredAgentExecutionRequest, ExecutionStatusResponse, BrowserSessionRecordingResponse } from './generated/agents/types.gen';
 /**
  * Create an API client with a provided API key.
  *
@@ -13,97 +13,88 @@ export declare const AsteroidClient: (apiKey: string, options?: {
     baseUrl?: string;
 }) => Client;
 /**
- * Create a new workflow for a given agent.
+ * Execute an agent with parameters including optional agent profile ID.
  *
  * @param client - The API client.
- * @param agentName - The name of the agent.
- * @param workflowDetails - The workflow details.
- * @returns The ID of the created workflow.
+ * @param agentId - The ID of the agent to execute.
+ * @param executionData - The structured execution parameters.
+ * @returns The execution ID.
  *
  * @example
- * const workflowId = await createNewWorkflow(client, 'my-agent', {
- *    name: "Example Workflow",
- *    start_url: "https://google.com",
- *    prompts: ["On Google, search for {{.website}} and sign in with {{.credentials}}"],
- *    result_schema: {},
- *    provider: 'openai'
+ * const executionId = await executeAgent(client, 'my-agent-id', {
+ *   agent_profile_id: 'profile-123',
+ *   dynamic_data: { input: "some dynamic value" }
  * });
  */
-export declare const createNewWorkflow: (client: Client, agentName: string, workflowDetails: CreateWorkflowRequest) => Promise<string>;
+export declare const executeAgent: (client: Client, agentId: string, executionData: StructuredAgentExecutionRequest) => Promise<string>;
 /**
- * Execute an existing workflow.
+ * Get the current status for an execution.
  *
  * @param client - The API client.
- * @param workflowId - The workflow identifier.
- * @param executionData - The dynamic data to merge with the workflow.
- * @returns The execution ID.
+ * @param executionId - The execution identifier.
+ * @returns The execution status details.
  *
  * @example
- * const executionId = await executeWorkflowById(client, workflowId, { input: "some dynamic value" });
+ * const status = await getExecutionStatus(client, executionId);
+ * console.log(status.status);
  */
-export declare const executeWorkflowById: (client: Client, workflowId: string, executionData: WorkflowExecutionRequest) => Promise<string>;
+export declare const getExecutionStatus: (client: Client, executionId: string) => Promise<ExecutionStatusResponse>;
 /**
- * Get the current status and details for a workflow execution.
+ * Get the final result of an execution.
  *
  * @param client - The API client.
  * @param executionId - The execution identifier.
- * @returns The execution details.
+ * @returns The result object of the execution.
  *
  * @example
- * const execution = await getExecutionStatus(client, executionId);
- * console.log(execution.status);
+ * const result = await getExecutionResult(client, executionId);
+ * console.log(result);
  */
-export declare const getExecutionStatus: (client: Client, executionId: string) => Promise<Execution>;
+export declare const getExecutionResult: (client: Client, executionId: string) => Promise<Record<string, unknown>>;
 /**
- * Get the progress updates for an execution.
+ * Waits for an execution to reach a terminal state and returns the result.
+ * Continuously polls the execution status until it's either "completed", "cancelled", or "failed".
  *
  * @param client - The API client.
  * @param executionId - The execution identifier.
- * @returns Array of progress update objects.
+ * @param interval - Polling interval in milliseconds (default is 1000ms).
+ * @returns A promise that resolves with the execution result if completed.
+ * @throws An error if the execution ends as "cancelled" or "failed".
  *
  * @example
- * const progressUpdates = await getWorkflowExecutionProgress(client, executionId);
- * console.log(progressUpdates);
+ * const result = await waitForExecutionResult(client, executionId, 2000);
  */
-export declare const getWorkflowExecutionProgress: (client: Client, executionId: string) => Promise<Array<{
-    execution_id: string;
-    progress: string;
-    created_at: string;
-}>>;
+export declare const waitForExecutionResult: (client: Client, executionId: string, interval?: number, timeout?: number) => Promise<Record<string, unknown>>;
 /**
- * Get the final result of a workflow execution.
+ * Get the browser session recording URL for a completed execution.
  *
  * @param client - The API client.
  * @param executionId - The execution identifier.
- * @returns The result object of the execution.
+ * @returns The browser session recording URL.
  *
  * @example
- * const result = await getWorkflowResult(client, executionId);
- * console.log(result);
+ * const recording = await getBrowserSessionRecording(client, executionId);
+ * console.log(recording.recording_url);
  */
-export declare const getWorkflowResult: (client: Client, executionId: string) => Promise<Record<string, unknown>>;
+export declare const getBrowserSessionRecording: (client: Client, executionId: string) => Promise<BrowserSessionRecordingResponse>;
 /**
- * Get the browser session for an execution.
+ * Upload files to an execution.
  *
  * @param client - The API client.
  * @param executionId - The execution identifier.
- * @returns The browser session.
- */
-export declare const getBrowserSession: (client: Client, executionId: string) => Promise<BrowserSession>;
-/**
- * Waits for a workflow execution to reach a terminal state and returns the result.
- * Continuously polls the execution status until it's either "completed", "cancelled", or "failed".
- *
- * @param client - The API client.
- * @param executionId - The execution identifier.
- * @param interval - Polling interval in milliseconds (default is 1000ms).
- * @returns A promise that resolves with the workflow execution result if completed.
- * @throws An error if the execution ends as "cancelled" or "failed".
+ * @param files - Array of files to upload.
+ * @returns The uploaded file IDs and success message.
  *
  * @example
- * const result = await waitForExecutionResult(client, executionId, 2000);
+ * const fileInput = document.getElementById('file-input') as HTMLInputElement;
+ * const files = Array.from(fileInput.files || []);
+ * const result = await uploadExecutionFiles(client, executionId, files);
+ * console.log(result.file_ids);
  */
-export declare const waitForExecutionResult: (client: Client, executionId: string, interval?: number, timeout?: number) => Promise<Record<string, unknown>>;
+export declare const uploadExecutionFiles: (client: Client, executionId: string, files: Array<Blob | File>) => Promise<{
+    message?: string;
+    file_ids?: string[];
+}>;
 /**
  * Optionally, re-export all generated functions and types.
  */

package/dist/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForExecutionResult = exports.getBrowserSession = exports.getWorkflowResult = exports.getWorkflowExecutionProgress = exports.getExecutionStatus = exports.executeWorkflowById = exports.createNewWorkflow = exports.AsteroidClient = void 0;
+exports.uploadExecutionFiles = exports.getBrowserSessionRecording = exports.waitForExecutionResult = exports.getExecutionResult = exports.getExecutionStatus = exports.executeAgent = exports.AsteroidClient = void 0;
 const client_fetch_1 = require("@hey-api/client-fetch");
 const AgentsSDK = __importStar(require("./generated/agents/sdk.gen"));
 /**
@@ -58,144 +58,86 @@ const AsteroidClient = (apiKey, options) => {
 };
 exports.AsteroidClient = AsteroidClient;
 /**
- * Create a new workflow for a given agent.
+ * Execute an agent with parameters including optional agent profile ID.
  *
  * @param client - The API client.
- * @param agentName - The name of the agent.
- * @param workflowDetails - The workflow details.
- * @returns The ID of the created workflow.
- *
- * @example
- * const workflowId = await createNewWorkflow(client, 'my-agent', {
- *    name: "Example Workflow",
- *    start_url: "https://google.com",
- *    prompts: ["On Google, search for {{.website}} and sign in with {{.credentials}}"],
- *    result_schema: {},
- *    provider: 'openai'
- * });
- */
-const createNewWorkflow = async (client, agentName, workflowDetails) => {
-    const response = await AgentsSDK.createWorkflow({
-        client,
-        path: { agent_name: agentName },
-        body: workflowDetails,
-    });
-    if (response.error) {
-        console.log(response.error);
-        throw new Error(response.error);
-    }
-    return response.data;
-};
-exports.createNewWorkflow = createNewWorkflow;
-/**
- * Execute an existing workflow.
- *
- * @param client - The API client.
- * @param workflowId - The workflow identifier.
- * @param executionData - The dynamic data to merge with the workflow.
+ * @param agentId - The ID of the agent to execute.
+ * @param executionData - The structured execution parameters.
  * @returns The execution ID.
  *
  * @example
- * const executionId = await executeWorkflowById(client, workflowId, { input: "some dynamic value" });
+ * const executionId = await executeAgent(client, 'my-agent-id', {
+ *   agent_profile_id: 'profile-123',
+ *   dynamic_data: { input: "some dynamic value" }
+ * });
  */
-const executeWorkflowById = async (client, workflowId, executionData) => {
-    const response = await AgentsSDK.executeWorkflow({
+const executeAgent = async (client, agentId, executionData) => {
+    const response = await AgentsSDK.executeAgentStructured({
         client,
-        path: { workflow_id: workflowId },
+        path: { id: agentId },
         body: executionData,
     });
     if (response.error) {
-        throw new Error(response.error);
+        throw new Error(response.error.error);
     }
-    return response.data;
+    return response.data.execution_id;
 };
-exports.executeWorkflowById = executeWorkflowById;
+exports.executeAgent = executeAgent;
 /**
- * Get the current status and details for a workflow execution.
+ * Get the current status for an execution.
  *
  * @param client - The API client.
  * @param executionId - The execution identifier.
- * @returns The execution details.
+ * @returns The execution status details.
  *
  * @example
- * const execution = await getExecutionStatus(client, executionId);
- * console.log(execution.status);
+ * const status = await getExecutionStatus(client, executionId);
+ * console.log(status.status);
  */
 const getExecutionStatus = async (client, executionId) => {
-    const execution = await AgentsSDK.getExecution({
+    const response = await AgentsSDK.getExecutionStatus({
         client,
         path: { id: executionId },
     });
-    if (execution.error) {
-        throw new Error(execution.error);
+    if (response.error) {
+        throw new Error(response.error.error);
     }
-    return execution.data;
+    return response.data;
 };
 exports.getExecutionStatus = getExecutionStatus;
 /**
- * Get the progress updates for an execution.
- *
- * @param client - The API client.
- * @param executionId - The execution identifier.
- * @returns Array of progress update objects.
- *
- * @example
- * const progressUpdates = await getWorkflowExecutionProgress(client, executionId);
- * console.log(progressUpdates);
- */
-const getWorkflowExecutionProgress = async (client, executionId) => {
-    const progressUpdates = await AgentsSDK.getExecutionProgress({
-        client,
-        path: { id: executionId },
-    });
-    if (progressUpdates.error) {
-        throw new Error(progressUpdates.error);
-    }
-    return progressUpdates.data;
-};
-exports.getWorkflowExecutionProgress = getWorkflowExecutionProgress;
-/**
- * Get the final result of a workflow execution.
+ * Get the final result of an execution.
  *
  * @param client - The API client.
  * @param executionId - The execution identifier.
  * @returns The result object of the execution.
  *
  * @example
- * const result = await getWorkflowResult(client, executionId);
+ * const result = await getExecutionResult(client, executionId);
  * console.log(result);
  */
-const getWorkflowResult = async (client, executionId) => {
-    const execution = await (0, exports.getExecutionStatus)(client, executionId);
-    return execution.result;
-};
-exports.getWorkflowResult = getWorkflowResult;
-/**
- * Get the browser session for an execution.
- *
- * @param client - The API client.
- * @param executionId - The execution identifier.
- * @returns The browser session.
- */
-const getBrowserSession = async (client, executionId) => {
-    const browserSession = await AgentsSDK.getBrowserSession({
+const getExecutionResult = async (client, executionId) => {
+    const response = await AgentsSDK.getExecutionResult({
         client,
         path: { id: executionId },
     });
-    if (browserSession.error) {
-        throw new Error(browserSession.error);
+    if (response.error) {
+        throw new Error(response.error.error);
+    }
+    if (response.data.error) {
+        throw new Error(response.data.error);
     }
-    return browserSession.data;
+    return response.data.result || {};
 };
-exports.getBrowserSession = getBrowserSession;
+exports.getExecutionResult = getExecutionResult;
 /**
- * Waits for a workflow execution to reach a terminal state and returns the result.
+ * Waits for an execution to reach a terminal state and returns the result.
  * Continuously polls the execution status until it's either "completed", "cancelled", or "failed".
  *
  * @param client - The API client.
  * @param executionId - The execution identifier.
  * @param interval - Polling interval in milliseconds (default is 1000ms).
- * @returns A promise that resolves with the workflow execution result if completed.
+ * @returns A promise that resolves with the execution result if completed.
  * @throws An error if the execution ends as "cancelled" or "failed".
  *
  * @example
@@ -206,13 +148,13 @@ const waitForExecutionResult = async (client, executionId, interval = 1000, time
     var steps = Math.floor(timeout / interval);
     // Keep polling the execution status until it's either "completed", "cancelled", or "failed".
     while (steps > 0) {
-        const execution = await (0, exports.getExecutionStatus)(client, executionId);
-        const currentStatus = execution.status?.status;
+        const status = await (0, exports.getExecutionStatus)(client, executionId);
+        const currentStatus = status.status;
         if (currentStatus === 'completed') {
-            return await (0, exports.getWorkflowResult)(client, executionId);
+            return await (0, exports.getExecutionResult)(client, executionId);
         }
         else if (currentStatus === 'failed' || currentStatus === 'cancelled') {
-            throw new Error(`Execution ${executionId} ended with status: ${currentStatus}${execution.status?.reason ? ' - ' + execution.status.reason : ''}`);
+            throw new Error(`Execution ${executionId} ended with status: ${currentStatus}${status.reason ? ' - ' + status.reason : ''}`);
         }
         // Wait for the specified interval before polling again
         await new Promise(resolve => setTimeout(resolve, interval));
@@ -221,6 +163,54 @@ const waitForExecutionResult = async (client, executionId, interval = 1000, time
     throw new Error(`Execution ${executionId} timed out after ${timeout}ms`);
 };
 exports.waitForExecutionResult = waitForExecutionResult;
+/**
+ * Get the browser session recording URL for a completed execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @returns The browser session recording URL.
+ *
+ * @example
+ * const recording = await getBrowserSessionRecording(client, executionId);
+ * console.log(recording.recording_url);
+ */
+const getBrowserSessionRecording = async (client, executionId) => {
+    const response = await AgentsSDK.getBrowserSessionRecording({
+        client,
+        path: { id: executionId },
+    });
+    if (response.error) {
+        throw new Error(response.error.error);
+    }
+    return response.data;
+};
+exports.getBrowserSessionRecording = getBrowserSessionRecording;
+/**
+ * Upload files to an execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @param files - Array of files to upload.
+ * @returns The uploaded file IDs and success message.
+ *
+ * @example
+ * const fileInput = document.getElementById('file-input') as HTMLInputElement;
+ * const files = Array.from(fileInput.files || []);
+ * const result = await uploadExecutionFiles(client, executionId, files);
+ * console.log(result.file_ids);
+ */
+const uploadExecutionFiles = async (client, executionId, files) => {
+    const response = await AgentsSDK.uploadExecutionFiles({
+        client,
+        path: { id: executionId },
+        body: { files },
+    });
+    if (response.error) {
+        throw new Error(response.error.error);
+    }
+    return response.data;
+};
+exports.uploadExecutionFiles = uploadExecutionFiles;
 /**
  * Optionally, re-export all generated functions and types.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asteroid-odyssey",
-  "version": "v1.0.24",
+  "version": "v1.1.2",
   "description": "SDK for interacting with Asteroid Agents API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",