npm - @openserv-labs/sdk - Versions diffs - 1.0.1 → 1.2.0 - Mend

@openserv-labs/sdk 1.0.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# OpenServ Autonomous AI Agent Development Framework
+# OpenServ TypeScript SDK, Autonomous AI Agent Development Framework
 [![npm version](https://badge.fury.io/js/@openserv-labs%2Fsdk.svg)](https://www.npmjs.com/package/@openserv-labs/sdk)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -12,6 +12,7 @@ A powerful TypeScript framework for building non-deterministic AI agents with ad
   - [Table of Contents](#table-of-contents)
   - [Features](#features)
   - [Framework Architecture](#framework-architecture)
+    - [Framework \& Blockchain Compatibility](#framework--blockchain-compatibility)
     - [Shadow Agents](#shadow-agents)
     - [Control Levels](#control-levels)
     - [Developer Focus](#developer-focus)
@@ -38,6 +39,8 @@ A powerful TypeScript framework for building non-deterministic AI agents with ad
     - [Workspace Management](#workspace-management)
       - [Get Files](#get-files)
       - [Upload File](#upload-file)
+    - [Integration Management](#integration-management)
+      - [Call Integration](#call-integration)
   - [Advanced Usage](#advanced-usage)
     - [OpenAI Process Runtime](#openai-process-runtime)
     - [Error Handling](#error-handling)
@@ -51,6 +54,8 @@ A powerful TypeScript framework for building non-deterministic AI agents with ad
 - 🤝 Inter-agent collaboration and communication
 - 🔌 Extensible agent architecture with custom capabilities
 - 🔧 Fully autonomous agent runtime with shadow agents
+- 🌐 Framework-agnostic - integrate agents from any AI framework
+- ⛓️ Blockchain-agnostic - compatible with any chain implementation
 - 🤖 Task execution and chat message handling
 - 🔄 Asynchronous task management
 - 📁 File operations and management
@@ -61,6 +66,22 @@ A powerful TypeScript framework for building non-deterministic AI agents with ad
 ## Framework Architecture
+### Framework & Blockchain Compatibility
+OpenServ is designed to be completely framework and blockchain agnostic, allowing you to:
+- Integrate agents built with any AI framework (e.g., LangChain, BabyAGI, Eliza, G.A.M.E, etc.)
+- Connect agents operating on any blockchain network
+- Mix and match different framework agents in the same workspace
+- Maintain full compatibility with your existing agent implementations
+This flexibility ensures you can:
+- Use your preferred AI frameworks and tools
+- Leverage existing agent implementations
+- Integrate with any blockchain ecosystem
+- Build cross-framework agent collaborations
 ### Shadow Agents
 Each agent is supported by two "shadow agents":
@@ -498,6 +519,52 @@ await agent.uploadFile({
 })
 ```
+### Integration Management
+#### Call Integration
+```typescript
+const response = await agent.callIntegration({
+  workspaceId: number,
+  integrationId: string,
+  details: {
+    endpoint: string,
+    method: string,
+    data?: object
+  }
+})
+```
+Allows agents to interact with external services and APIs that are integrated with OpenServ. This method provides a secure way to make API calls to configured integrations within a workspace. Authentication is handled securely and automatically through the OpenServ platform. This is primarily useful for calling external APIs in a deterministic way.
+**Parameters:**
+- `workspaceId`: ID of the workspace where the integration is configured
+- `integrationId`: ID of the integration to call (e.g., 'twitter-v2', 'github')
+- `details`: Object containing:
+  - `endpoint`: The endpoint to call on the integration
+  - `method`: HTTP method (GET, POST, etc.)
+  - `data`: Optional payload for the request
+**Returns:** The response from the integration endpoint
+**Example:**
+```typescript
+// Example: Sending a tweet using Twitter integration
+const response = await agent.callIntegration({
+  workspaceId: 123,
+  integrationId: 'twitter-v2',
+  details: {
+    endpoint: '/2/tweets',
+    method: 'POST',
+    data: {
+      text: 'Hello from my AI agent!'
+    }
+  }
+})
+```
 ## Advanced Usage
 ### OpenAI Process Runtime

package/dist/agent.d.ts CHANGED Viewed

@@ -1,6 +1,7 @@
 import { type AxiosInstance } from 'axios';
-import type { GetFilesParams, UploadFileParams, MarkTaskAsErroredParams, CompleteTaskParams, SendChatMessageParams, GetTaskDetailParams, GetAgentsParams, GetTasksParams, CreateTaskParams, AddLogToTaskParams, RequestHumanAssistanceParams, UpdateTaskStatusParams, ProcessParams } from './types';
-import { actionSchema, doTaskActionSchema, respondChatMessageActionSchema } from './types';
+import type { GetFilesParams, GetSecretsParams, GetSecretValueParams, UploadFileParams, MarkTaskAsErroredParams, CompleteTaskParams, SendChatMessageParams, GetTaskDetailParams, GetAgentsParams, GetTasksParams, CreateTaskParams, AddLogToTaskParams, RequestHumanAssistanceParams, UpdateTaskStatusParams, ProcessParams, IntegrationCallRequest } from './types';
+import type { doTaskActionSchema, respondChatMessageActionSchema } from './types';
+import { actionSchema } from './types';
 import type { ChatCompletionMessageParam, ChatCompletion } from 'openai/resources/chat/completions';
 import OpenAI from 'openai';
 import type { z } from 'zod';
@@ -30,6 +31,13 @@ export interface AgentOptions {
      * Required when using the process() method.
      */
     openaiApiKey?: string;
+    /**
+     * Error handler function for all agent operations.
+     * Defaults to logging the error if not provided.
+     * @param error - The error that occurred
+     * @param context - Additional context about where the error occurred
+     */
+    onError?: (error: Error, context?: Record<string, unknown>) => void;
 }
 export declare class Agent {
     private options;
@@ -68,7 +76,7 @@ export declare class Agent {
      * Each capability is an instance of the Capability class with a name, description, schema, and run function.
      * @protected
      */
-    protected tools: Array<Capability<any>>;
+    protected tools: Array<Capability<z.ZodTypeAny>>;
     /**
      * The OpenServ API key used for authentication.
      * Can be provided in options or via OPENSERV_API_KEY environment variable.
@@ -138,7 +146,7 @@ export declare class Agent {
         name: string;
         description: string;
         schema: S;
-        run(params: {
+        run(this: Agent, params: {
             args: z.infer<S>;
             action?: z.infer<typeof actionSchema>;
         }, messages: ChatCompletionMessageParam[]): string | Promise<string>;
@@ -161,10 +169,10 @@ export declare class Agent {
             name: string;
             description: string;
             schema: T[K];
-            run: (params: {
+            run(this: Agent, params: {
                 args: z.infer<T[K]>;
                 action?: z.infer<typeof actionSchema>;
-            }, messages: ChatCompletionMessageParam[]) => string | Promise<string>;
+            }, messages: ChatCompletionMessageParam[]): string | Promise<string>;
         };
     }): this;
     /**
@@ -175,6 +183,20 @@ export declare class Agent {
      * @returns {Promise<any>} The files in the workspace
      */
     getFiles(params: GetFilesParams): Promise<any>;
+    /**
+     * Get all secrets for an agent in a workspace.
+     *
+     * @param {GetSecretsParams} params - Parameters for the secrets retrieval
+     * @returns {Promise<any>} List of agent secrets.
+     */
+    getSecrets(params: GetSecretsParams): Promise<any>;
+    /**
+     * Get the value of a secret for an agent in a workspace
+     *
+     * @param {GetSecretValueParams} params - Parameters for the secret value retrieval
+     * @returns {Promise<string>} The value of the secret.
+     */
+    getSecretValue(params: GetSecretValueParams): Promise<string>;
     /**
      * Uploads a file to a workspace.
      *
@@ -320,6 +342,7 @@ export declare class Agent {
      * @param {Object} req.body - Request body
      * @param {z.infer<z.ZodTypeAny>} [req.body.args] - Arguments for the tool
      * @param {z.infer<typeof actionSchema>} [req.body.action] - Action context
+     * @param {ChatCompletionMessageParam[]} [req.body.messages] - Message history
      * @returns {Promise<{result: string}>} The result of the tool execution
      * @throws {BadRequest} If tool name is missing or tool is not found
      * @throws {Error} If tool execution fails
@@ -331,6 +354,7 @@ export declare class Agent {
         body: {
             args?: z.infer<z.ZodTypeAny>;
             action?: z.infer<typeof actionSchema>;
+            messages?: ChatCompletionMessageParam[];
         };
     }): Promise<{
         result: string;
@@ -365,5 +389,25 @@ export declare class Agent {
      * @returns {Promise<void>} Resolves when the server has stopped
      */
     stop(): Promise<void>;
+    /**
+     * Default error handler that logs the error
+     * @private
+     */
+    private handleError;
+    /**
+     * Calls an integration endpoint through the OpenServ platform.
+     * This method allows agents to interact with external services and APIs that are integrated with OpenServ.
+     *
+     * @param {IntegrationCallRequest} integration - The integration request parameters
+     * @param {number} integration.workspaceId - ID of the workspace where the integration is configured
+     * @param {string} integration.integrationId - ID of the integration to call
+     * @param {Object} integration.details - Details of the integration call
+     * @param {string} integration.details.endpoint - The endpoint to call on the integration
+     * @param {string} integration.details.method - The HTTP method to use (GET, POST, etc.)
+     * @param {Object} [integration.details.data] - Optional data payload for the request
+     * @returns {Promise<any>} The response from the integration endpoint
+     * @throws {Error} If the integration call fails
+     */
+    callIntegration(integration: IntegrationCallRequest): Promise<any>;
 }
 //# sourceMappingURL=agent.d.ts.map

package/dist/agent.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AASjD,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,aAAa,~~EACd~~,MAAM,SAAS,CAAA;AAChB,OAAO,~~EAAE~~,~~YAAY,~~EAAE,kBAAkB,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAA;~~AAE1F~~,OAAO,KAAK,EACV,0BAA0B,EAE1B,cAAc,EACf,MAAM,mCAAmC,CAAA;AAE1C,OAAO,MAAM,MAAM,QAAQ,CAAA;AAC3B,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAMzC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;~~CACtB~~;AAED,qBAAa,KAAK;IAoHJ,OAAO,CAAC,OAAO;IAnH3B;;;;OAIG;IACH,OAAO,CAAC,GAAG,CAAqB;IAEhC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAA2B;IAEzC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAqB;IAEnC;;;;OAIG;IACH,OAAO,CAAC,IAAI,CAAQ;IAEpB;;;;OAIG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,~~GAAG~~,CAAC,CAAC,CAAK;~~IAE5C~~;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;;;OAIG;IACH,OAAO,CAAC,SAAS,CAAe;IAEhC;;;;OAIG;IACH,SAAS,CAAC,aAAa,EAAE,aAAa,CAAA;IAEtC;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;;OAKG;IACH,OAAO,KAAK,WAAW,GAStB;IAED;;;;;;OAMG;IACH,OAAO,KAAK,MAAM,GAWjB;IAED;;;;;;;OAOG;gBACiB,OAAO,EAAE,YAAY;IAwCzC;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EACpC,IAAI,EACJ,WAAW,EACX,MAAM,EACN,GAAG,EACJ,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,CAAC,CAAA;QACT,GAAG,CACD,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;SAAE,EACnE,QAAQ,EAAE,0BAA0B,EAAE,GACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;KAC5B,GAAG,IAAI;~~IASR~~;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE;SACjF,CAAC,IAAI,MAAM,CAAC,GAAG;YACd,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,EAAE,MAAM,CAAA;YACnB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YACZ,GAAG,EAAE,~~CACH~~,MAAM,EAAE;gBAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;aAAE,EACtE,QAAQ,EAAE,0BAA0B,EAAE,~~KACnC~~,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;~~SAC9B~~;KACF,GAAG,IAAI;IAOR;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAKrC;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAyBzC;;;;;;;;OAQG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB;IAUvD;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAU7C;;;;;;;;OAQG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAUnD;;;;;;;OAOG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB;IAO/C;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe;IAKvC;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAKrC;;;;;;;;;;;;OAYG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAYzC;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAY7C;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,MAAM,EAAE,4BAA4B;~~IAYjE~~;;;;;;;;OAQG;IACG,gBAAgB,CAAC,MAAM,EAAE,sBAAsB;IAUrD;;;;;;;OAOG;IACG,OAAO,CAAC,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;~~IAiEnE~~;;;;OAIG;cACa,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC;~~IAmCjE~~;;;;OAIG;cACa,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC;~~IAmCpF;;;;;;;;;;;;OAYG~~;IACG,eAAe,CAAC,GAAG,EAAE;QACzB,MAAM,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;QAC5B,IAAI,EAAE;YACJ,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;YAC5B,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;~~SACtC~~,CAAA;KACF;;;~~IAoBD~~;;;;;;;OAOG;IACG,eAAe,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE;~~IAS5C~~;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAuBnB;;;;;OAKG;IACG,KAAK;IAUX;;;;OAIG;IACG,IAAI;~~CAOX~~"}
1	+ {"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AASjD,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACvB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,kBAAkB,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAA;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEtC,OAAO,KAAK,EACV,0BAA0B,EAE1B,cAAc,EACf,MAAM,mCAAmC,CAAA;AAE1C,OAAO,MAAM,MAAM,QAAQ,CAAA;AAC3B,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAMzC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;CACpE;AAED,qBAAa,KAAK;IAoHJ,OAAO,CAAC,OAAO;IAnH3B;;;;OAIG;IACH,OAAO,CAAC,GAAG,CAAqB;IAEhC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAA2B;IAEzC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAqB;IAEnC;;;;OAIG;IACH,OAAO,CAAC,IAAI,CAAQ;IAEpB;;;;OAIG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAK;IAErD;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;;;OAIG;IACH,OAAO,CAAC,SAAS,CAAe;IAEhC;;;;OAIG;IACH,SAAS,CAAC,aAAa,EAAE,aAAa,CAAA;IAEtC;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;;OAKG;IACH,OAAO,KAAK,WAAW,GAStB;IAED;;;;;;OAMG;IACH,OAAO,KAAK,MAAM,GAWjB;IAED;;;;;;;OAOG;gBACiB,OAAO,EAAE,YAAY;IAwCzC;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EACpC,IAAI,EACJ,WAAW,EACX,MAAM,EACN,GAAG,EACJ,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,CAAC,CAAA;QACT,GAAG,CACD,IAAI,EAAE,KAAK,EACX,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;SAAE,EACnE,QAAQ,EAAE,0BAA0B,EAAE,GACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;KAC5B,GAAG,IAAI;IAYR;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE;SACjF,CAAC,IAAI,MAAM,CAAC,GAAG;YACd,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,EAAE,MAAM,CAAA;YACnB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YACZ,GAAG,CACD,IAAI,EAAE,KAAK,EACX,MAAM,EAAE;gBAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;aAAE,EACtE,QAAQ,EAAE,0BAA0B,EAAE,GACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;SAC5B;KACF,GAAG,IAAI;IAOR;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAKrC;;;;;OAKG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAKzC;;;;;OAKG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAOnE;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAyBzC;;;;;;;;OAQG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB;IAUvD;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAU7C;;;;;;;;OAQG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAUnD;;;;;;;OAOG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB;IAO/C;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe;IAKvC;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAKrC;;;;;;;;;;;;OAYG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAYzC;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAY7C;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,MAAM,EAAE,4BAA4B;IA0BjE;;;;;;;;OAQG;IACG,gBAAgB,CAAC,MAAM,EAAE,sBAAsB;IAUrD;;;;;;;OAOG;IACG,OAAO,CAAC,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAoFnE;;;;OAIG;cACa,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC;IA6BjE;;;;OAIG;cACa,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC;IA+BpF;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,GAAG,EAAE;QACzB,MAAM,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;QAC5B,IAAI,EAAE;YACJ,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;YAC5B,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;YACrC,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAA;SACxC,CAAA;KACF;;;IAyBD;;;;;;;OAOG;IACG,eAAe,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE;IAgB5C;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAuBnB;;;;;OAKG;IACG,KAAK;IAUX;;;;OAIG;IACG,IAAI;IAQV;;;OAGG;IACH,OAAO,CAAC,WAAW;IAOnB;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,WAAW,EAAE,sBAAsB;CAQ1D"}

package/dist/agent.js CHANGED Viewed

@@ -177,6 +177,7 @@ class Agent {
         if (this.tools.some(tool => tool.name === name)) {
             throw new Error(`Tool with name "${name}" already exists`);
         }
+        // Type assertion through unknown for safe conversion between compatible generic types
         this.tools.push(new capability_1.Capability(name, description, schema, run));
         return this;
     }
@@ -194,9 +195,9 @@ class Agent {
      * @throws {Error} If any capability has a name that already exists
      */
     addCapabilities(capabilities) {
-        capabilities.forEach(capability => {
+        for (const capability of capabilities) {
             this.addCapability(capability);
-        });
+        }
         return this;
     }
     /**
@@ -210,6 +211,26 @@ class Agent {
         const response = await this.apiClient.get(`/workspaces/${params.workspaceId}/files`);
         return response.data;
     }
+    /**
+     * Get all secrets for an agent in a workspace.
+     *
+     * @param {GetSecretsParams} params - Parameters for the secrets retrieval
+     * @returns {Promise<any>} List of agent secrets.
+     */
+    async getSecrets(params) {
+        const response = await this.apiClient.get(`/workspaces/${params.workspaceId}/agent-secrets`);
+        return response.data;
+    }
+    /**
+     * Get the value of a secret for an agent in a workspace
+     *
+     * @param {GetSecretValueParams} params - Parameters for the secret value retrieval
+     * @returns {Promise<string>} The value of the secret.
+     */
+    async getSecretValue(params) {
+        const response = await this.apiClient.get(`/workspaces/${params.workspaceId}/agent-secrets/${params.secretId}/value`);
+        return response.data;
+    }
     /**
      * Uploads a file to a workspace.
      *
@@ -376,9 +397,22 @@ class Agent {
      * @returns {Promise<any>} The created assistance request details
      */
     async requestHumanAssistance(params) {
+        let question = params.question;
+        if (typeof question === 'string') {
+            question = {
+                type: 'text',
+                question
+            };
+        }
+        else {
+            question = {
+                type: 'json',
+                ...question
+            };
+        }
         const response = await this.apiClient.post(`/workspaces/${params.workspaceId}/tasks/${params.taskId}/human-assistance`, {
             type: params.type,
-            question: params.question,
+            question,
             agentDump: params.agentDump
         });
         return response.data;
@@ -407,58 +441,75 @@ class Agent {
      * @throws {Error} If no response is received from OpenAI or max iterations are reached
      */
     async process({ messages }) {
-        const currentMessages = [...messages];
-        let completion = null;
-        let iterationCount = 0;
-        const MAX_ITERATIONS = 10;
-        while (iterationCount < MAX_ITERATIONS) {
-            completion = await this.openai.chat.completions.create({
-                model: 'gpt-4o',
-                messages: currentMessages,
-                tools: this.openAiTools
-            });
-            if (!completion.choices?.length || !completion.choices[0]?.message) {
-                throw new Error('No response from OpenAI');
-            }
-            const lastMessage = completion.choices[0].message;
-            // If there are no tool calls, we're done
-            if (!lastMessage.tool_calls?.length) {
-                return completion;
+        try {
+            const apiKey = this.options.openaiApiKey || process.env.OPENAI_API_KEY;
+            if (!apiKey) {
+                throw new Error('OpenAI API key is required for process(). Please provide it in options or set OPENAI_API_KEY environment variable.');
             }
-            // Process each tool call
-            const toolResults = await Promise.all(lastMessage.tool_calls.map(async (toolCall) => {
-                // We know the function exists because we provided the tools
-                const { name, arguments: args } = toolCall.function;
-                const parsedArgs = JSON.parse(args);
-                try {
-                    // Find the tool in our tools array
-                    const tool = this.tools.find(t => t.name === name);
-                    if (!tool) {
-                        throw new Error(`Tool "${name}" not found`);
-                    }
-                    // Call the tool's run method with the parsed arguments and bind this
-                    const result = await tool.run.bind(this)({ args: parsedArgs }, currentMessages);
-                    return {
-                        role: 'tool',
-                        content: JSON.stringify(result),
-                        tool_call_id: toolCall.id
-                    };
+            const currentMessages = [...messages];
+            let completion = null;
+            let iterationCount = 0;
+            const MAX_ITERATIONS = 10;
+            while (iterationCount < MAX_ITERATIONS) {
+                completion = await this.openai.chat.completions.create({
+                    model: 'gpt-4o',
+                    messages: currentMessages,
+                    tools: this.tools.length ? this.openAiTools : undefined
+                });
+                if (!completion.choices?.length || !completion.choices[0]?.message) {
+                    throw new Error('No response from OpenAI');
                 }
-                catch (error) {
-                    const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
-                    logger_1.logger.error({ error, toolCall }, 'Error executing tool call');
-                    return {
-                        role: 'tool',
-                        content: JSON.stringify({ error: errorMessage }),
-                        tool_call_id: toolCall.id
-                    };
+                const lastMessage = completion.choices[0].message;
+                // If there are no tool calls, we're done
+                if (!lastMessage.tool_calls?.length) {
+                    return completion;
                 }
-            }));
-            // Add the assistant's message and tool results to the conversation
-            currentMessages.push(lastMessage, ...toolResults);
-            iterationCount++;
+                // Process each tool call
+                const toolResults = await Promise.all(lastMessage.tool_calls.map(async (toolCall) => {
+                    if (!toolCall.function) {
+                        throw new Error('Tool call function is missing');
+                    }
+                    const { name, arguments: args } = toolCall.function;
+                    const parsedArgs = JSON.parse(args);
+                    try {
+                        // Find the tool in our tools array
+                        const tool = this.tools.find(t => t.name === name);
+                        if (!tool) {
+                            throw new Error(`Tool "${name}" not found`);
+                        }
+                        // Call the tool's run method with the parsed arguments and bind this
+                        const result = await tool.run.bind(this)({ args: parsedArgs }, currentMessages);
+                        return {
+                            role: 'tool',
+                            content: JSON.stringify(result),
+                            tool_call_id: toolCall.id
+                        };
+                    }
+                    catch (error) {
+                        const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
+                        this.handleError(error instanceof Error ? error : new Error(errorMessage), {
+                            toolCall,
+                            context: 'tool_execution'
+                        });
+                        return {
+                            role: 'tool',
+                            content: JSON.stringify({ error: errorMessage }),
+                            tool_call_id: toolCall.id
+                        };
+                    }
+                }));
+                // Add the assistant's message and tool results to the conversation
+                currentMessages.push(lastMessage, ...toolResults);
+                iterationCount++;
+            }
+            throw new Error('Max iterations reached without completion');
+        }
+        catch (error) {
+            this.handleError(error instanceof Error ? error : new Error(String(error)), {
+                context: 'process'
+            });
+            throw error;
         }
-        throw new Error('Max iterations reached without completion');
     }
     /**
      * Handle a task execution request
@@ -486,15 +537,10 @@ class Agent {
             });
         }
         catch (error) {
-            if (action.task) {
-                await this.markTaskAsErrored({
-                    workspaceId: action.workspace.id,
-                    taskId: action.task.id,
-                    error: error instanceof Error ? error.message : 'Unknown error occurred'
-                });
-            }
-            logger_1.logger.error({ error }, 'Failed to forward action to runtime agent');
-            throw error;
+            this.handleError(error instanceof Error ? error : new Error(String(error)), {
+                action,
+                context: 'do_task'
+            });
         }
     }
     /**
@@ -510,12 +556,12 @@ class Agent {
             }
         ];
         if (action.messages) {
-            action.messages.forEach((msg) => {
+            for (const msg of action.messages) {
                 messages.push({
                     role: msg.author === 'user' ? 'user' : 'assistant',
                     content: msg.message
                 });
-            });
+            }
         }
         try {
             await this.runtimeClient.post('/chat', {
@@ -525,13 +571,10 @@ class Agent {
             });
         }
         catch (error) {
-            await this.sendChatMessage({
-                workspaceId: action.workspace.id,
-                agentId: action.me.id,
-                message: error instanceof Error ? error.message : 'Unknown error occurred'
+            this.handleError(error instanceof Error ? error : new Error(String(error)), {
+                action,
+                context: 'respond_to_chat'
             });
-            logger_1.logger.error({ error }, 'Failed to forward action to runtime agent');
-            throw error;
         }
     }
     /**
@@ -543,26 +586,31 @@ class Agent {
      * @param {Object} req.body - Request body
      * @param {z.infer<z.ZodTypeAny>} [req.body.args] - Arguments for the tool
      * @param {z.infer<typeof actionSchema>} [req.body.action] - Action context
+     * @param {ChatCompletionMessageParam[]} [req.body.messages] - Message history
      * @returns {Promise<{result: string}>} The result of the tool execution
      * @throws {BadRequest} If tool name is missing or tool is not found
      * @throws {Error} If tool execution fails
      */
     async handleToolRoute(req) {
-        if (!('toolName' in req.params)) {
-            throw new http_errors_1.BadRequest('Tool name is required');
-        }
-        const tool = this.tools.find(t => t.name === req.params.toolName);
-        if (!tool) {
-            throw new http_errors_1.BadRequest(`Tool "${req.params.toolName}" not found`);
-        }
         try {
+            if (!('toolName' in req.params)) {
+                throw new http_errors_1.BadRequest('Tool name is required');
+            }
+            const tool = this.tools.find(t => t.name === req.params.toolName);
+            if (!tool) {
+                throw new http_errors_1.BadRequest(`Tool "${req.params.toolName}" not found`);
+            }
             const args = await tool.schema.parseAsync(req.body?.args);
-            const result = await tool.run.call(this, { args, action: req.body.action }, []);
+            const messages = req.body.messages || [];
+            const result = await tool.run.call(this, { args, action: req.body.action }, messages);
             return { result };
         }
         catch (error) {
-            const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
-            throw new Error(errorMessage);
+            this.handleError(error instanceof Error ? error : new Error(String(error)), {
+                request: req,
+                context: 'handle_tool_route'
+            });
+            throw error;
         }
     }
     /**
@@ -574,15 +622,23 @@ class Agent {
      * @throws {Error} If action type is invalid
      */
     async handleRootRoute(req) {
-        const action = await types_1.actionSchema.parseAsync(req.body);
-        if (action.type === 'do-task') {
-            this.doTask(action);
+        try {
+            const action = await types_1.actionSchema.parseAsync(req.body);
+            if (action.type === 'do-task') {
+                this.doTask(action);
+            }
+            else if (action.type === 'respond-chat-message') {
+                this.respondToChat(action);
+            }
+            else
+                throw new Error('Invalid action type');
         }
-        else if (action.type === 'respond-chat-message') {
-            this.respondToChat(action);
+        catch (error) {
+            this.handleError(error instanceof Error ? error : new Error(String(error)), {
+                request: req,
+                context: 'handle_root_route'
+            });
         }
-        else
-            throw new Error('Invalid action type');
     }
     /**
      * Sets up the Express routes for the agent's HTTP server.
@@ -635,6 +691,33 @@ class Agent {
             this.server?.close(() => resolve());
         });
     }
+    /**
+     * Default error handler that logs the error
+     * @private
+     */
+    handleError(error, context) {
+        const handler = this.options.onError ??
+            ((err, ctx) => logger_1.logger.error({ error: err, ...ctx }, 'Error in agent operation'));
+        handler(error, context);
+    }
+    /**
+     * Calls an integration endpoint through the OpenServ platform.
+     * This method allows agents to interact with external services and APIs that are integrated with OpenServ.
+     *
+     * @param {IntegrationCallRequest} integration - The integration request parameters
+     * @param {number} integration.workspaceId - ID of the workspace where the integration is configured
+     * @param {string} integration.integrationId - ID of the integration to call
+     * @param {Object} integration.details - Details of the integration call
+     * @param {string} integration.details.endpoint - The endpoint to call on the integration
+     * @param {string} integration.details.method - The HTTP method to use (GET, POST, etc.)
+     * @param {Object} [integration.details.data] - Optional data payload for the request
+     * @returns {Promise<any>} The response from the integration endpoint
+     * @throws {Error} If the integration call fails
+     */
+    async callIntegration(integration) {
+        const response = await this.apiClient.post(`/workspaces/${integration.workspaceId}/integration/${integration.integrationId}/proxy`, integration.details);
+        return response.data;
+    }
 }
 exports.Agent = Agent;
 function convertToolToJsonSchema(tool) {

package/dist/capability.d.ts CHANGED Viewed

@@ -1,11 +1,12 @@
-import { z } from 'zod';
+import type { z } from 'zod';
 import type { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
 import type { CapabilityFuncParams } from './types';
+import type { Agent } from './agent';
 export declare class Capability<Schema extends z.ZodTypeAny> {
     readonly name: string;
     readonly description: string;
     readonly schema: Schema;
-    readonly run: (params: CapabilityFuncParams<Schema>, messages: ChatCompletionMessageParam[]) => string | Promise<string>;
-    constructor(name: string, description: string, schema: Schema, run: (params: CapabilityFuncParams<Schema>, messages: ChatCompletionMessageParam[]) => string | Promise<string>);
+    readonly run: (this: Agent, params: CapabilityFuncParams<Schema>, messages: ChatCompletionMessageParam[]) => string | Promise<string>;
+    constructor(name: string, description: string, schema: Schema, run: (this: Agent, params: CapabilityFuncParams<Schema>, messages: ChatCompletionMessageParam[]) => string | Promise<string>);
 }
 //# sourceMappingURL=capability.d.ts.map

package/dist/capability.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"capability.d.ts","sourceRoot":"","sources":["../src/capability.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;~~AACvB~~,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAA;AACnF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;~~AAEnD~~,qBAAa,UAAU,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU;aAE/B,IAAI,EAAE,MAAM;aACZ,WAAW,EAAE,MAAM;aACnB,MAAM,EAAE,MAAM;aACd,GAAG,EAAE,CACnB,MAAM,EAAE,oBAAoB,CAAC,MAAM,CAAC,EACpC,QAAQ,EAAE,0BAA0B,EAAE,KACnC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;~~gBANb~~,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,CACnB,MAAM,EAAE,oBAAoB,CAAC,MAAM,CAAC,EACpC,QAAQ,EAAE,0BAA0B,EAAE,KACnC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAEhC"}
1	+ {"version":3,"file":"capability.d.ts","sourceRoot":"","sources":["../src/capability.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAA;AACnF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpC,qBAAa,UAAU,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU;aAE/B,IAAI,EAAE,MAAM;aACZ,WAAW,EAAE,MAAM;aACnB,MAAM,EAAE,MAAM;aACd,GAAG,EAAE,CACnB,IAAI,EAAE,KAAK,EACX,MAAM,EAAE,oBAAoB,CAAC,MAAM,CAAC,EACpC,QAAQ,EAAE,0BAA0B,EAAE,KACnC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBAPb,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,CACnB,IAAI,EAAE,KAAK,EACX,MAAM,EAAE,oBAAoB,CAAC,MAAM,CAAC,EACpC,QAAQ,EAAE,0BAA0B,EAAE,KACnC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAEhC"}