asteroid-odyssey 1.0.12 → 1.0.16

package/README.md

@@ -1,54 +1,17 @@
 # Agents SDK, TypeScript
 
-This is a TypeScript SDK for the Asteroid Agents API.
+The official TypeScript SDK for interacting with the Asteroid Agents API.
 
 ## Installation
 
 ```bash
-npm install asteroid-sdk
+npm install asteroid-odyssey
 ```
 
 ## Usage
 
-Below is a minimal example showing how to start an agent workflow, poll for its status until it's completed, and then retrieve its result:
+Please head to our documentation at https://docs.asteroid.ai/sdk/typescript
 
-```ts
-import { AsteroidAgents } from 'asteroid-sdk';
+## License
 
-const asteroid = new AsteroidAgents('YOUR_API_KEY'); // Generate a key at https://platform.asteroid.ai
-
-const workflowID = 'YOUR_WORKFLOW_ID'; // You can create a workflow at https://platform.asteroid.ai or use the .createWorkflow() method
-
-async function runWorkflowExample() {
-  try {
-    // Start the workflow
-    const runID = await asteroid.runWorkflow(workflowID, { name: 'Alice' });
-    console.log('Workflow run initiated with ID:', runID);
-
-    // Poll for the workflow status until it completes
-    while (true) {
-      const status = await asteroid.getRunStatus(runID);
-      console.log('Current workflow status:', status);
-      if (status === 'completed') break;
-      // Wait for 1 second before checking again
-      await new Promise(resolve => setTimeout(resolve, 1000));
-    }
-
-    // Retrieve the result after completion
-    const result = await asteroid.getRunResult(runID);
-    console.log('Workflow completed. Result:', result);
-  } catch (error) {
-    console.error('Error executing the workflow:', error);
-  }
-}
-
-runWorkflowExample();
-```
-
-## Development
-
-Regenerate the client SDK from the OpenAPI spec (assuming it's located at `../agents/server/api/openapi.yaml`):
-
-```bash
-npm run generate
-```
+The Asteroid Odyssey SDK is available under the MIT License.

package/dist/generated/agents/client.gen.d.ts

@@ -0,0 +1,12 @@
+import type { ClientOptions } from './types.gen';
+import { type Config, type ClientOptions as DefaultClientOptions } from '@hey-api/client-fetch';
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+export declare const client: import("@hey-api/client-fetch").Client;

package/dist/generated/agents/client.gen.js

@@ -0,0 +1,6 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+const client_fetch_1 = require("@hey-api/client-fetch");
+exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)());

package/dist/generated/agents/index.d.ts

@@ -1,16 +1,2 @@
-export { ApiError } from './core/ApiError';
-export { CancelablePromise, CancelError } from './core/CancelablePromise';
-export { OpenAPI } from './core/OpenAPI';
-export type { OpenAPIConfig } from './core/OpenAPI';
-export type { Agent } from './models/Agent';
-export { CreateWorkflowRequest } from './models/CreateWorkflowRequest';
-export type { Execution } from './models/Execution';
-export type { OptimisationRequest } from './models/OptimisationRequest';
-export type { Workflow } from './models/Workflow';
-export type { WorkflowExecution } from './models/WorkflowExecution';
-export type { WorkflowExecutionRequest } from './models/WorkflowExecutionRequest';
-export { AgentService } from './services/AgentService';
-export { ApiService } from './services/ApiService';
-export { DefaultService } from './services/DefaultService';
-export { OptimiserService } from './services/OptimiserService';
-export { WorkflowService } from './services/WorkflowService';
+export * from './types.gen';
+export * from './sdk.gen';

package/dist/generated/agents/index.js

@@ -1,26 +1,19 @@
 "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 __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.WorkflowService = exports.OptimiserService = exports.DefaultService = exports.ApiService = exports.AgentService = exports.CreateWorkflowRequest = exports.OpenAPI = exports.CancelError = exports.CancelablePromise = exports.ApiError = void 0;
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-var ApiError_1 = require("./core/ApiError");
-Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return ApiError_1.ApiError; } });
-var CancelablePromise_1 = require("./core/CancelablePromise");
-Object.defineProperty(exports, "CancelablePromise", { enumerable: true, get: function () { return CancelablePromise_1.CancelablePromise; } });
-Object.defineProperty(exports, "CancelError", { enumerable: true, get: function () { return CancelablePromise_1.CancelError; } });
-var OpenAPI_1 = require("./core/OpenAPI");
-Object.defineProperty(exports, "OpenAPI", { enumerable: true, get: function () { return OpenAPI_1.OpenAPI; } });
-var CreateWorkflowRequest_1 = require("./models/CreateWorkflowRequest");
-Object.defineProperty(exports, "CreateWorkflowRequest", { enumerable: true, get: function () { return CreateWorkflowRequest_1.CreateWorkflowRequest; } });
-var AgentService_1 = require("./services/AgentService");
-Object.defineProperty(exports, "AgentService", { enumerable: true, get: function () { return AgentService_1.AgentService; } });
-var ApiService_1 = require("./services/ApiService");
-Object.defineProperty(exports, "ApiService", { enumerable: true, get: function () { return ApiService_1.ApiService; } });
-var DefaultService_1 = require("./services/DefaultService");
-Object.defineProperty(exports, "DefaultService", { enumerable: true, get: function () { return DefaultService_1.DefaultService; } });
-var OptimiserService_1 = require("./services/OptimiserService");
-Object.defineProperty(exports, "OptimiserService", { enumerable: true, get: function () { return OptimiserService_1.OptimiserService; } });
-var WorkflowService_1 = require("./services/WorkflowService");
-Object.defineProperty(exports, "WorkflowService", { enumerable: true, get: function () { return WorkflowService_1.WorkflowService; } });
+// This file is auto-generated by @hey-api/openapi-ts
+__exportStar(require("./types.gen"), exports);
+__exportStar(require("./sdk.gen"), exports);

package/dist/generated/agents/sdk.gen.d.ts

@@ -0,0 +1,95 @@
+import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
+import type { GetOpenApiData, HealthCheckData, GetAgentsData, QueueOptimisationJobData, CreateWorkflowData, DeleteWorkflowData, GetWorkflowData, ExecuteWorkflowData, GetExecutionsForWorkflowData, DeleteExecutionData, GetExecutionData, UpdateExecutionStatusData, GetBrowserSessionData, SetSlackChannelData, GetAgentWorkflowExecutionsData, GetExecutionProgressData, GetExecutionFilesData } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Get the OpenAPI schema
+ */
+export declare const getOpenApi: <ThrowOnError extends boolean = false>(options?: Options<GetOpenApiData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
+/**
+ * Check the health of the API
+ */
+export declare const healthCheck: <ThrowOnError extends boolean = false>(options?: Options<HealthCheckData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    status?: string;
+}, {
+    error?: string;
+}, ThrowOnError>;
+/**
+ * Get all agents
+ */
+export declare const getAgents: <ThrowOnError extends boolean = false>(options?: Options<GetAgentsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Agent[], unknown, ThrowOnError>;
+/**
+ * Queue an optimisation job
+ */
+export declare const queueOptimisationJob: <ThrowOnError extends boolean = false>(options?: Options<QueueOptimisationJobData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
+/**
+ * Create a new workflow for an agent
+ */
+export declare const createWorkflow: <ThrowOnError extends boolean = false>(options: Options<CreateWorkflowData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<string, unknown, ThrowOnError>;
+/**
+ * Delete a workflow
+ */
+export declare const deleteWorkflow: <ThrowOnError extends boolean = false>(options: Options<DeleteWorkflowData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    result?: string;
+}, {
+    error?: string;
+}, ThrowOnError>;
+/**
+ * Get a workflow
+ */
+export declare const getWorkflow: <ThrowOnError extends boolean = false>(options: Options<GetWorkflowData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Workflow, unknown, ThrowOnError>;
+/**
+ * Execute a saved workflow for an agent
+ */
+export declare const executeWorkflow: <ThrowOnError extends boolean = false>(options: Options<ExecuteWorkflowData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<string, unknown, ThrowOnError>;
+/**
+ * Get all executions for a workflow
+ */
+export declare const getExecutionsForWorkflow: <ThrowOnError extends boolean = false>(options: Options<GetExecutionsForWorkflowData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Execution[], unknown, ThrowOnError>;
+/**
+ * Delete an execution
+ */
+export declare const deleteExecution: <ThrowOnError extends boolean = false>(options: Options<DeleteExecutionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    result?: string;
+}, {
+    error?: string;
+}, ThrowOnError>;
+/**
+ * Get an execution
+ */
+export declare const getExecution: <ThrowOnError extends boolean = false>(options: Options<GetExecutionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Execution, unknown, ThrowOnError>;
+/**
+ * Update the status of an execution
+ */
+export declare const updateExecutionStatus: <ThrowOnError extends boolean = false>(options: Options<UpdateExecutionStatusData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
+/**
+ * Get the browser session for an execution
+ */
+export declare const getBrowserSession: <ThrowOnError extends boolean = false>(options: Options<GetBrowserSessionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").BrowserSession, unknown, ThrowOnError>;
+/**
+ * Set your slack notification channel
+ */
+export declare const setSlackChannel: <ThrowOnError extends boolean = false>(options: Options<SetSlackChannelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
+/**
+ * Get all workflows and their executions
+ */
+export declare const getAgentWorkflowExecutions: <ThrowOnError extends boolean = false>(options: Options<GetAgentWorkflowExecutionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").WorkflowExecution[], unknown, ThrowOnError>;
+/**
+ * Get the progress of an execution
+ */
+export declare const getExecutionProgress: <ThrowOnError extends boolean = false>(options: Options<GetExecutionProgressData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ProgressUpdate[], unknown, ThrowOnError>;
+/**
+ * Get files for an execution
+ */
+export declare const getExecutionFiles: <ThrowOnError extends boolean = false>(options: Options<GetExecutionFilesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").File[], unknown, ThrowOnError>;

package/dist/generated/agents/sdk.gen.js

@@ -0,0 +1,195 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExecutionFiles = exports.getExecutionProgress = exports.getAgentWorkflowExecutions = exports.setSlackChannel = exports.getBrowserSession = exports.updateExecutionStatus = exports.getExecution = exports.deleteExecution = exports.getExecutionsForWorkflow = exports.executeWorkflow = exports.getWorkflow = exports.deleteWorkflow = exports.createWorkflow = exports.queueOptimisationJob = exports.getAgents = exports.healthCheck = exports.getOpenApi = void 0;
+const client_gen_1 = require("./client.gen");
+/**
+ * Get the OpenAPI schema
+ */
+const getOpenApi = (options) => {
+    return (options?.client ?? client_gen_1.client).get({
+        url: '/openapi.yaml',
+        ...options
+    });
+};
+exports.getOpenApi = getOpenApi;
+/**
+ * Check the health of the API
+ */
+const healthCheck = (options) => {
+    return (options?.client ?? client_gen_1.client).get({
+        url: '/health',
+        ...options
+    });
+};
+exports.healthCheck = healthCheck;
+/**
+ * Get all agents
+ */
+const getAgents = (options) => {
+    return (options?.client ?? client_gen_1.client).get({
+        url: '/agents',
+        ...options
+    });
+};
+exports.getAgents = getAgents;
+/**
+ * Queue an optimisation job
+ */
+const queueOptimisationJob = (options) => {
+    return (options?.client ?? client_gen_1.client).post({
+        url: '/optimiser',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.queueOptimisationJob = queueOptimisationJob;
+/**
+ * Create a new workflow for an agent
+ */
+const createWorkflow = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        url: '/workflow/{agent_name}/create',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.createWorkflow = createWorkflow;
+/**
+ * Delete a workflow
+ */
+const deleteWorkflow = (options) => {
+    return (options.client ?? client_gen_1.client).delete({
+        url: '/workflow/{workflow_id}',
+        ...options
+    });
+};
+exports.deleteWorkflow = deleteWorkflow;
+/**
+ * Get a workflow
+ */
+const getWorkflow = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/workflow/{workflow_id}',
+        ...options
+    });
+};
+exports.getWorkflow = getWorkflow;
+/**
+ * Execute a saved workflow for an agent
+ */
+const executeWorkflow = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        url: '/workflow/{workflow_id}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.executeWorkflow = executeWorkflow;
+/**
+ * Get all executions for a workflow
+ */
+const getExecutionsForWorkflow = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/workflow/{workflow_id}/executions',
+        ...options
+    });
+};
+exports.getExecutionsForWorkflow = getExecutionsForWorkflow;
+/**
+ * Delete an execution
+ */
+const deleteExecution = (options) => {
+    return (options.client ?? client_gen_1.client).delete({
+        url: '/execution/{id}',
+        ...options
+    });
+};
+exports.deleteExecution = deleteExecution;
+/**
+ * Get an execution
+ */
+const getExecution = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/execution/{id}',
+        ...options
+    });
+};
+exports.getExecution = getExecution;
+/**
+ * Update the status of an execution
+ */
+const updateExecutionStatus = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        url: '/execution/{id}/status',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.updateExecutionStatus = updateExecutionStatus;
+/**
+ * Get the browser session for an execution
+ */
+const getBrowserSession = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/execution/{id}/browser_session',
+        ...options
+    });
+};
+exports.getBrowserSession = getBrowserSession;
+/**
+ * Set your slack notification channel
+ */
+const setSlackChannel = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        url: '/slack_channel',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.setSlackChannel = setSlackChannel;
+/**
+ * Get all workflows and their executions
+ */
+const getAgentWorkflowExecutions = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/agent/{agent_name}/workflows',
+        ...options
+    });
+};
+exports.getAgentWorkflowExecutions = getAgentWorkflowExecutions;
+/**
+ * Get the progress of an execution
+ */
+const getExecutionProgress = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/execution/{id}/progress',
+        ...options
+    });
+};
+exports.getExecutionProgress = getExecutionProgress;
+/**
+ * Get files for an execution
+ */
+const getExecutionFiles = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/execution/{id}/files',
+        ...options
+    });
+};
+exports.getExecutionFiles = getExecutionFiles;