asteroid-odyssey 1.0.12 → 1.0.16

package/dist/index.d.ts

@@ -1,70 +1,101 @@
-import { OpenAPI as AgentsOpenAPI } from './generated/agents';
-import { OpenAPI as PlatformOpenAPI } from './generated/platform';
-import type { Agent } from './generated/agents/models/Agent';
-import type { CreateWorkflowRequest } from './generated/agents/models/CreateWorkflowRequest';
-import type { WorkflowExecutionRequest } from './generated/agents/models/WorkflowExecutionRequest';
-import type { WorkflowExecution } from './generated/agents/models/WorkflowExecution';
-import type { Status } from './generated/platform/models/Status';
-import type { FeedbackRequest } from './generated/platform/models/FeedbackRequest';
-import type { Feedback } from './generated/platform/models/Feedback';
+import type { Client } from '@hey-api/client-fetch';
+import type { CreateWorkflowRequest, WorkflowExecutionRequest, Execution } from './generated/agents/types.gen';
 /**
- * AgentsSDK provides a simple interface for interacting with the Asteroid Agents API.
- * It wraps the generated client services and exposes high-level methods.
+ * Create an API client with a provided API key.
+ *
+ * @param apiKey - Your API key.
+ * @returns A configured API client.
+ *
+ * @example
+ * const client = AsteroidClient('your-api-key');
  */
-export declare class AsteroidAgents {
-    /**
-     * Optionally pass a custom OpenAPI config. For instance, to change the API base URL.
-     * @param config Partial OpenAPI config values.
-     */
-    constructor(apiKey: string, agentsConfig?: Partial<typeof AgentsOpenAPI>, platformConfig?: Partial<typeof PlatformOpenAPI>);
-    /**
-     * Retrieves the OpenAPI schema from the API.
-     * @returns The OpenAPI specification.
-     */
-    getOpenApiSchema(): Promise<any>;
-    /**
-     * Checks the health of the API.
-     * @returns An object containing the health status.
-     */
-    healthCheck(): Promise<{
-        status?: string;
-    }>;
-    /**
-     * Retrieves a list of all agents.
-     * @returns An array of agents.
-     */
-    getAgents(): Promise<Agent[]>;
-    /**
-     * Creates a new workflow for a given agent.
-     * @param agentName The name of the agent for which the workflow is created.
-     * @param request The workflow creation request.
-     * @returns The ID of the newly created workflow.
-     */
-    createWorkflow(agentName: string, request: CreateWorkflowRequest): Promise<string>;
-    /**
-     * Executes a saved workflow for an agent.
-     * @param workflowId The ID of the workflow to execute.
-     * @param request The execution request containing dynamic values.
-     * @returns A string indicating that the job was queued.
-     */
-    runWorkflow(workflowId: string, request: WorkflowExecutionRequest): Promise<string>;
-    /**
-     * Retrieves all workflows along with their executions.
-     * @returns An array containing workflow executions.
-     */
-    getWorkflowRuns(): Promise<WorkflowExecution[]>;
-    /**
-     * Retrieves the status of a run.
-     * @param runId The ID of the run to retrieve the status for.
-     * @returns The status of the run.
-     */
-    getRunStatus(runId: string): Promise<Status>;
-    getRunResult(runId: string): Promise<string>;
-    /**
-     * Creates feedback for a run.
-     * @param runId The ID of the run to create feedback for.
-     * @param request The feedback request.
-     * @returns The feedback created.
-     */
-    createRunFeedback(runId: string, request: FeedbackRequest): Promise<Feedback>;
-}
+export declare const AsteroidClient: (apiKey: string) => Client;
+/**
+ * Create a new workflow for a given agent.
+ *
+ * @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",
+ *    result_schema: {},
+ *    fields: { exampleField: "value" },
+ *    prompts: ["Enter some data:"],
+ *    provider: 'openai'
+ * });
+ */
+export declare const createNewWorkflow: (client: Client, agentName: string, workflowDetails: CreateWorkflowRequest) => Promise<string>;
+/**
+ * Execute an existing workflow.
+ *
+ * @param client - The API client.
+ * @param workflowId - The workflow identifier.
+ * @param executionData - The dynamic data to merge with the workflow.
+ * @returns The execution ID.
+ *
+ * @example
+ * const executionId = await executeWorkflowById(client, workflowId, { input: "some dynamic value" });
+ */
+export declare const executeWorkflowById: (client: Client, workflowId: string, executionData: WorkflowExecutionRequest) => Promise<string>;
+/**
+ * Get the current status and details for a workflow execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @returns The execution details.
+ *
+ * @example
+ * const execution = await getExecutionStatus(client, executionId);
+ * console.log(execution.status);
+ */
+export declare const getExecutionStatus: (client: Client, executionId: string) => Promise<Execution>;
+/**
+ * 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);
+ */
+export declare const getWorkflowExecutionProgress: (client: Client, executionId: string) => Promise<Array<{
+    execution_id: string;
+    progress: string;
+    created_at: string;
+}>>;
+/**
+ * Get the final result of a workflow 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);
+ * console.log(result);
+ */
+export declare const getWorkflowResult: (client: Client, executionId: string) => Promise<Record<string, unknown>>;
+/**
+ * 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".
+ *
+ * @example
+ * const result = await waitForExecutionResult(client, executionId, 2000);
+ */
+export declare const waitForExecutionResult: (client: Client, executionId: string, interval?: number, timeout?: number) => Promise<Record<string, unknown>>;
+/**
+ * Optionally, re-export all generated functions and types.
+ */
+export * from './generated/agents/sdk.gen';
+export * from './generated/agents/types.gen';

package/dist/index.js

@@ -1,104 +1,214 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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.AsteroidAgents = void 0;
-const agents_1 = require("./generated/agents");
-const platform_1 = require("./generated/platform");
+exports.waitForExecutionResult = exports.getWorkflowResult = exports.getWorkflowExecutionProgress = exports.getExecutionStatus = exports.executeWorkflowById = exports.createNewWorkflow = exports.AsteroidClient = void 0;
+const client_fetch_1 = require("@hey-api/client-fetch");
+const AgentsSDK = __importStar(require("./generated/agents/sdk.gen"));
 /**
- * AgentsSDK provides a simple interface for interacting with the Asteroid Agents API.
- * It wraps the generated client services and exposes high-level methods.
+ * Create an API client with a provided API key.
+ *
+ * @param apiKey - Your API key.
+ * @returns A configured API client.
+ *
+ * @example
+ * const client = AsteroidClient('your-api-key');
  */
-class AsteroidAgents {
-    /**
-     * Optionally pass a custom OpenAPI config. For instance, to change the API base URL.
-     * @param config Partial OpenAPI config values.
-     */
-    constructor(apiKey, agentsConfig, platformConfig) {
-        // We use a custom headers for the API keys
-        platform_1.OpenAPI.HEADERS = { 'X-Asteroid-Api-Key': apiKey };
-        agents_1.OpenAPI.HEADERS = { 'X-Asteroid-Agents-Api-Key': apiKey };
-        agents_1.OpenAPI.BASE = 'https://odyssey.asteroid.ai/api/v1';
-        platform_1.OpenAPI.BASE = 'https://platform.asteroid.ai/api/v1';
-        if (agentsConfig) {
-            Object.assign(agents_1.OpenAPI, agentsConfig);
-        }
-        if (platformConfig) {
-            Object.assign(platform_1.OpenAPI, platformConfig);
+const AsteroidClient = (apiKey) => {
+    return (0, client_fetch_1.createClient)({
+        baseUrl: 'http://localhost:9090/api/v1',
+        // baseUrl: 'https://odyssey.asteroid.ai/api/v1',
+        headers: {
+            'X-Asteroid-Agents-Api-Key': apiKey
         }
+    });
+};
+exports.AsteroidClient = AsteroidClient;
+/**
+ * Create a new workflow for a given agent.
+ *
+ * @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",
+ *    result_schema: {},
+ *    fields: { exampleField: "value" },
+ *    prompts: ["Enter some data:"],
+ *    provider: 'openai'
+ * });
+ */
+const createNewWorkflow = async (client, agentName, workflowDetails) => {
+    // Add a workflow_name key to the workflowDetails.fields object
+    // This field is deprecated and will be removed in a future version.
+    workflowDetails.fields.workflow_name = workflowDetails.name;
+    const response = await AgentsSDK.createWorkflow({
+        client,
+        path: { agent_name: agentName },
+        body: workflowDetails,
+    });
+    if (response.error) {
+        console.log(response.error);
+        throw new Error(response.error);
     }
-    /**
-     * Retrieves the OpenAPI schema from the API.
-     * @returns The OpenAPI specification.
-     */
-    async getOpenApiSchema() {
-        return agents_1.ApiService.getOpenApi();
-    }
-    /**
-     * Checks the health of the API.
-     * @returns An object containing the health status.
-     */
-    async healthCheck() {
-        return agents_1.DefaultService.healthCheck();
-    }
-    /**
-     * Retrieves a list of all agents.
-     * @returns An array of agents.
-     */
-    async getAgents() {
-        return agents_1.AgentService.getAgents();
-    }
-    /**
-     * Creates a new workflow for a given agent.
-     * @param agentName The name of the agent for which the workflow is created.
-     * @param request The workflow creation request.
-     * @returns The ID of the newly created workflow.
-     */
-    async createWorkflow(agentName, request) {
-        return agents_1.DefaultService.createWorkflow(agentName, request);
-    }
-    /**
-     * Executes a saved workflow for an agent.
-     * @param workflowId The ID of the workflow to execute.
-     * @param request The execution request containing dynamic values.
-     * @returns A string indicating that the job was queued.
-     */
-    async runWorkflow(workflowId, request) {
-        return agents_1.WorkflowService.executeWorkflow(workflowId, request);
+    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.
+ * @returns The execution ID.
+ *
+ * @example
+ * const executionId = await executeWorkflowById(client, workflowId, { input: "some dynamic value" });
+ */
+const executeWorkflowById = async (client, workflowId, executionData) => {
+    const response = await AgentsSDK.executeWorkflow({
+        client,
+        path: { workflow_id: workflowId },
+        body: executionData,
+    });
+    if (response.error) {
+        throw new Error(response.error);
     }
-    /**
-     * Retrieves all workflows along with their executions.
-     * @returns An array containing workflow executions.
-     */
-    async getWorkflowRuns() {
-        return agents_1.WorkflowService.getWorkflowExecutions("ceres");
+    return response.data;
+};
+exports.executeWorkflowById = executeWorkflowById;
+/**
+ * Get the current status and details for a workflow execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @returns The execution details.
+ *
+ * @example
+ * const execution = await getExecutionStatus(client, executionId);
+ * console.log(execution.status);
+ */
+const getExecutionStatus = async (client, executionId) => {
+    const execution = await AgentsSDK.getExecution({
+        client,
+        path: { id: executionId },
+    });
+    if (execution.error) {
+        throw new Error(execution.error);
     }
-    /**
-     * Retrieves the status of a run.
-     * @param runId The ID of the run to retrieve the status for.
-     * @returns The status of the run.
-     */
-    async getRunStatus(runId) {
-        return platform_1.RunService.getRunStatus(runId);
+    return execution.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);
     }
-    async getRunResult(runId) {
-        const run = await platform_1.RunService.getRun(runId);
-        const metadata = run.metadata;
-        if (!metadata) {
-            throw new Error('Run metadata not found');
+    return progressUpdates.data;
+};
+exports.getWorkflowExecutionProgress = getWorkflowExecutionProgress;
+/**
+ * Get the final result of a workflow 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);
+ * console.log(result);
+ */
+const getWorkflowResult = async (client, executionId) => {
+    const execution = await (0, exports.getExecutionStatus)(client, executionId);
+    return execution.result;
+};
+exports.getWorkflowResult = getWorkflowResult;
+/**
+ * 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".
+ *
+ * @example
+ * const result = await waitForExecutionResult(client, executionId, 2000);
+ */
+const waitForExecutionResult = async (client, executionId, interval = 1000, timeout = 3600000 // 1 hour
+) => {
+    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;
+        if (currentStatus === 'completed') {
+            return await (0, exports.getWorkflowResult)(client, executionId);
         }
-        const result = metadata.final_result;
-        if (!result) {
-            throw new Error('Run result not found');
+        else if (currentStatus === 'failed' || currentStatus === 'cancelled') {
+            throw new Error(`Execution ${executionId} ended with status: ${currentStatus}${execution.status?.reason ? ' - ' + execution.status.reason : ''}`);
         }
-        return result;
-    }
-    /**
-     * Creates feedback for a run.
-     * @param runId The ID of the run to create feedback for.
-     * @param request The feedback request.
-     * @returns The feedback created.
-     */
-    async createRunFeedback(runId, request) {
-        return platform_1.ImproveService.createFeedback(runId, request);
+        // Wait for the specified interval before polling again
+        await new Promise(resolve => setTimeout(resolve, interval));
+        steps--;
     }
-}
-exports.AsteroidAgents = AsteroidAgents;
+    throw new Error(`Execution ${executionId} timed out after ${timeout}ms`);
+};
+exports.waitForExecutionResult = waitForExecutionResult;
+/**
+ * Optionally, re-export all generated functions and types.
+ */
+__exportStar(require("./generated/agents/sdk.gen"), exports);
+__exportStar(require("./generated/agents/types.gen"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asteroid-odyssey",
-  "version": "v1.0.12",
+  "version": "v1.0.16",
   "description": "SDK for interacting with Asteroid Agents API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,8 @@
     "generate-platform": "openapi -i ../platform/server/openapi.yaml -o src/generated/platform",
     "generate": "npm run generate-agents && npm run generate-platform",
     "build": "tsc",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "openapi-ts": "openapi-ts"
   },
   "keywords": [
     "asteroid",
@@ -23,8 +24,12 @@
   "author": "Asteroid",
   "license": "MIT",
   "devDependencies": {
+    "@hey-api/openapi-ts": "^0.64.12",
     "@types/node": "^22.13.4",
     "openapi-typescript-codegen": "^0.29.0",
     "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "@hey-api/client-fetch": "^0.8.3"
   }
 }