@agent-commons/sdk 0.3.0 → 0.4.0

package/dist/index.cjs

@@ -30,7 +30,10 @@ module.exports = __toCommonJS(index_exports);
 // src/client.ts
 var CommonsClient = class {
   constructor(config) {
-    this.baseUrl = (config.baseUrl ?? "https://api.agentcommons.io").replace(/\/$/, "");
+    this.baseUrl = (config.baseUrl ?? "https://api.agentcommons.io").replace(
+      /\/$/,
+      ""
+    );
     this.apiKey = config.apiKey;
     this.initiator = config.initiator;
     this._fetch = config.fetch ?? fetch;
@@ -68,6 +71,11 @@ var CommonsClient = class {
       list: (owner) => this.request("GET", `/v1/agents${owner ? `?owner=${owner}` : ""}`),
       get: (agentId) => this.request("GET", `/v1/agents/${agentId}`),
       update: (agentId, params) => this.request("PUT", `/v1/agents/${agentId}`, params),
+      getRuntime: (agentId) => this.request("GET", `/v1/agents/${agentId}/runtime`),
+      configureRuntime: (agentId, params) => this.request("PUT", `/v1/agents/${agentId}/runtime`, params),
+      deployRuntime: (agentId) => this.request("POST", `/v1/agents/${agentId}/runtime/deploy`),
+      sleepRuntime: (agentId) => this.request("POST", `/v1/agents/${agentId}/runtime/sleep`),
+      restartRuntime: (agentId) => this.request("POST", `/v1/agents/${agentId}/runtime/restart`),
       /** List tools assigned to an agent. */
       listTools: (agentId) => this.request("GET", `/v1/agents/${agentId}/tools`),
       /** Assign a tool to an agent. */
@@ -102,32 +110,90 @@ var CommonsClient = class {
       /** Get the knowledgebase entries for an agent. */
       getKnowledgebase: (agentId) => this.request("GET", `/v1/agents/${agentId}/knowledgebase`),
       /** Replace the knowledgebase entries for an agent. */
-      updateKnowledgebase: (agentId, knowledgebase) => this.request("PUT", `/v1/agents/${agentId}/knowledgebase`, { knowledgebase }),
+      updateKnowledgebase: (agentId, knowledgebase) => this.request("PUT", `/v1/agents/${agentId}/knowledgebase`, {
+        knowledgebase
+      }),
       // ── Preferred Connections ────────────────────────────────────────────
       /** List agents that this agent prefers to collaborate with. */
       getPreferredConnections: (agentId) => this.request("GET", `/v1/agents/${agentId}/preferred-connections`),
       /** Add a preferred agent connection. */
-      addPreferredConnection: (agentId, params) => this.request("POST", `/v1/agents/${agentId}/preferred-connections`, params),
+      addPreferredConnection: (agentId, params) => this.request(
+        "POST",
+        `/v1/agents/${agentId}/preferred-connections`,
+        params
+      ),
       /** Remove a preferred agent connection by its record ID. */
       removePreferredConnection: (id) => this.request("DELETE", `/v1/agents/preferred-connections/${id}`),
       // ── Computers ────────────────────────────────────────────────────────
       getComputerConfig: (agentId) => this.request("GET", `/v1/agents/${agentId}/computer/config`),
       updateComputerConfig: (agentId, params) => this.request("PUT", `/v1/agents/${agentId}/computer/config`, params),
-      listComputers: (agentId, filter) => {
-        const qs = new URLSearchParams();
-        if (filter?.sessionId) qs.set("sessionId", filter.sessionId);
-        if (filter?.includeTerminated) qs.set("includeTerminated", "true");
-        const query = qs.toString();
-        return this.request("GET", `/v1/agents/${agentId}/computers${query ? `?${query}` : ""}`);
+      /** Get the agent's one persistent cloud computer. */
+      getComputer: (agentId, _legacyComputerId) => this.request("GET", `/v1/agents/${agentId}/computer`),
+      /** Wake the agent's persistent cloud computer, provisioning it if needed. */
+      wakeComputer: (agentId, params) => this.request("POST", `/v1/agents/${agentId}/computer/wake`, params),
+      /** Sleep the runtime while preserving the computer's durable workspace. */
+      sleepComputer: (agentId, params) => this.request("POST", `/v1/agents/${agentId}/computer/sleep`, params),
+      /** Replace the runtime without replacing the persistent computer. */
+      restartComputer: (agentId, params) => this.request("POST", `/v1/agents/${agentId}/computer/restart`, params),
+      resizeComputer: (agentId, params) => this.request("POST", `/v1/agents/${agentId}/computer/resize`, params),
+      execComputer: (agentId, params) => this.request("POST", `/v1/agents/${agentId}/computer/exec`, params),
+      readComputerFile: (agentId, pathOrLegacyComputerId, legacyPath) => {
+        const path = legacyPath ?? pathOrLegacyComputerId;
+        return this.request(
+          "GET",
+          `/v1/agents/${agentId}/computer/files/read?path=${encodeURIComponent(path)}`
+        );
+      },
+      openComputerBrowser: (agentId, paramsOrLegacyComputerId, legacyParams) => {
+        const params = typeof paramsOrLegacyComputerId === "string" ? legacyParams : paramsOrLegacyComputerId;
+        if (!params) {
+          return Promise.reject(new TypeError("Browser options are required."));
+        }
+        return this.request(
+          "POST",
+          `/v1/agents/${agentId}/computer/browser/open`,
+          params
+        );
+      },
+      listComputerEvents: (agentId, limitOrLegacyComputerId, legacyLimit) => {
+        const limit = typeof limitOrLegacyComputerId === "number" ? limitOrLegacyComputerId : legacyLimit;
+        return this.request(
+          "GET",
+          `/v1/agents/${agentId}/computer/events${limit ? `?limit=${limit}` : ""}`
+        );
+      },
+      // ── Deprecated per-instance compatibility ────────────────────────────
+      /** @deprecated Use getComputer. The singleton is returned as a one-item list. */
+      listComputers: (agentId, _filter) => {
+        return this.request(
+          "GET",
+          `/v1/agents/${agentId}/computer`
+        ).then(({ data }) => ({
+          data: data ? [data] : []
+        }));
+      },
+      /** @deprecated Use wakeComputer. Lifecycle, name, and session are ignored. */
+      startComputer: (agentId, params) => this.request(
+        "POST",
+        `/v1/agents/${agentId}/computer/wake`,
+        params?.reason ? { reason: params.reason } : void 0
+      ),
+      /** @deprecated Use getComputer. Computer IDs are ignored. */
+      refreshComputer: (agentId, _computerId) => this.request("GET", `/v1/agents/${agentId}/computer`),
+      /** @deprecated Use sleepComputer. Computer IDs are ignored. */
+      stopComputer: (agentId, _computerId) => this.request("POST", `/v1/agents/${agentId}/computer/sleep`),
+      /** @deprecated Use execComputer. Computer IDs are ignored. */
+      runComputerCommand: (agentId, paramsOrLegacyComputerId, legacyParams) => {
+        const params = typeof paramsOrLegacyComputerId === "string" ? legacyParams : paramsOrLegacyComputerId;
+        if (!params) {
+          return Promise.reject(new TypeError("Command options are required."));
+        }
+        return this.request(
+          "POST",
+          `/v1/agents/${agentId}/computer/exec`,
+          params
+        );
       },
-      startComputer: (agentId, params) => this.request("POST", `/v1/agents/${agentId}/computers`, params),
-      getComputer: (agentId, computerId) => this.request("GET", `/v1/agents/${agentId}/computers/${computerId}`),
-      refreshComputer: (agentId, computerId) => this.request("POST", `/v1/agents/${agentId}/computers/${computerId}/refresh`),
-      stopComputer: (agentId, computerId) => this.request("POST", `/v1/agents/${agentId}/computers/${computerId}/stop`),
-      readComputerFile: (agentId, computerId, path) => this.request("GET", `/v1/agents/${agentId}/computers/${computerId}/files/read?path=${encodeURIComponent(path)}`),
-      runComputerCommand: (agentId, computerId, params) => this.request("POST", `/v1/agents/${agentId}/computers/${computerId}/commands`, params),
-      openComputerBrowser: (agentId, computerId, params) => this.request("POST", `/v1/agents/${agentId}/computers/${computerId}/browser/open`, params),
-      listComputerEvents: (agentId, computerId, limit) => this.request("GET", `/v1/agents/${agentId}/computers/${computerId}/events${limit ? `?limit=${limit}` : ""}`),
       // ── TTS Voices ───────────────────────────────────────────────────────
       /**
        * List available TTS voices for a provider.
@@ -139,7 +205,10 @@ var CommonsClient = class {
         if (provider) params.set("provider", provider);
         if (q) params.set("q", q);
         const qs = params.toString();
-        return this.request("GET", `/v1/agents/tts/voices${qs ? `?${qs}` : ""}`);
+        return this.request(
+          "GET",
+          `/v1/agents/tts/voices${qs ? `?${qs}` : ""}`
+        );
       }
     };
   }
@@ -153,20 +222,42 @@ var CommonsClient = class {
   get workflows() {
     return {
       create: (params) => this.request("POST", "/v1/workflows", params),
-      list: (ownerId, ownerType) => this.request("GET", `/v1/workflows?ownerId=${ownerId}&ownerType=${ownerType}`),
+      list: (ownerId, ownerType) => this.request(
+        "GET",
+        `/v1/workflows?ownerId=${ownerId}&ownerType=${ownerType}`
+      ),
       get: (workflowId) => this.request("GET", `/v1/workflows/${workflowId}`),
       update: (workflowId, updates) => this.request("PUT", `/v1/workflows/${workflowId}`, updates),
       delete: (workflowId) => this.request("DELETE", `/v1/workflows/${workflowId}`),
       execute: (workflowId, params) => this.request("POST", `/v1/workflows/${workflowId}/execute`, params),
-      getExecution: (workflowId, executionId) => this.request("GET", `/v1/workflows/${workflowId}/executions/${executionId}`),
-      listExecutions: (workflowId, limit) => this.request("GET", `/v1/workflows/${workflowId}/executions${limit ? `?limit=${limit}` : ""}`),
-      cancelExecution: (workflowId, executionId) => this.request("POST", `/v1/workflows/${workflowId}/executions/${executionId}/cancel`),
+      getExecution: (workflowId, executionId) => this.request(
+        "GET",
+        `/v1/workflows/${workflowId}/executions/${executionId}`
+      ),
+      listExecutions: (workflowId, limit) => this.request(
+        "GET",
+        `/v1/workflows/${workflowId}/executions${limit ? `?limit=${limit}` : ""}`
+      ),
+      cancelExecution: (workflowId, executionId) => this.request(
+        "POST",
+        `/v1/workflows/${workflowId}/executions/${executionId}/cancel`
+      ),
       /** Approve a paused human_approval node and resume execution. */
-      approveExecution: (workflowId, executionId, params) => this.request("POST", `/v1/workflows/${workflowId}/executions/${executionId}/approve`, params),
+      approveExecution: (workflowId, executionId, params) => this.request(
+        "POST",
+        `/v1/workflows/${workflowId}/executions/${executionId}/approve`,
+        params
+      ),
       /** Reject a paused human_approval node and terminate execution. */
-      rejectExecution: (workflowId, executionId, params) => this.request("POST", `/v1/workflows/${workflowId}/executions/${executionId}/reject`, params),
+      rejectExecution: (workflowId, executionId, params) => this.request(
+        "POST",
+        `/v1/workflows/${workflowId}/executions/${executionId}/reject`,
+        params
+      ),
       /** Stream execution progress via SSE. Returns an async generator. */
-      stream: (workflowId, executionId) => this._streamSse(`/v1/workflows/${workflowId}/executions/${executionId}/stream`)
+      stream: (workflowId, executionId) => this._streamSse(
+        `/v1/workflows/${workflowId}/executions/${executionId}/stream`
+      )
     };
   }
   // ── Tasks ─────────────────────────────────────────────────────────────────
@@ -196,7 +287,10 @@ var CommonsClient = class {
       /** List all sessions for a given agent (all initiators). */
       listByAgent: (agentId) => this.request("GET", `/v1/sessions/agent/${agentId}`),
       /** List all sessions for a user across all agents. */
-      listByUser: (initiator) => this.request("GET", `/v1/sessions/user/${encodeURIComponent(initiator)}`),
+      listByUser: (initiator) => this.request(
+        "GET",
+        `/v1/sessions/user/${encodeURIComponent(initiator)}`
+      ),
       create: (params) => this.request("POST", "/v1/sessions", params),
       get: (sessionId) => this.request("GET", `/v1/sessions/${sessionId}`),
       /** Get full session with history, tasks, childSessions, and spaces. */
@@ -218,6 +312,37 @@ var CommonsClient = class {
       listStatic: () => this.request("GET", "/v1/tools/static")
     };
   }
+  // ── OAuth Connections ─────────────────────────────────────────────────────
+  get oauth() {
+    return {
+      /** List OAuth providers available on the platform (Google Workspace, GitHub, …). */
+      listProviders: () => this.request("GET", "/v1/oauth/providers"),
+      /** Get one provider's details, including its scope groups. */
+      getProvider: (providerKey) => this.request(
+        "GET",
+        `/v1/oauth/providers/${encodeURIComponent(providerKey)}`
+      ),
+      /**
+       * List the caller's OAuth connections (the accounts agents act with).
+       * `ownerId` is only needed when authenticating with a management key.
+       */
+      listConnections: (params) => {
+        const q = params ? new URLSearchParams(params).toString() : "";
+        return this.request("GET", `/v1/oauth/connections${q ? `?${q}` : ""}`);
+      },
+      /**
+       * Start an OAuth connect flow. Returns the authorization URL the user
+       * must open in a browser to grant access.
+       */
+      connect: (params) => this.request("POST", "/v1/oauth/connect", params),
+      /** Refresh a connection's access token now. */
+      refresh: (connectionId) => this.request("POST", `/v1/oauth/connections/${connectionId}/refresh`),
+      /** Check whether a connection's token is valid. */
+      test: (connectionId) => this.request("GET", `/v1/oauth/connections/${connectionId}/test`),
+      /** Revoke a connection and delete its tokens. */
+      revoke: (connectionId) => this.request("DELETE", `/v1/oauth/connections/${connectionId}`)
+    };
+  }
   // ── Tool Keys ─────────────────────────────────────────────────────────────
   get toolKeys() {
     return {
@@ -247,7 +372,8 @@ var CommonsClient = class {
         const params = new URLSearchParams();
         if (filter?.ownerId) params.set("ownerId", filter.ownerId);
         if (filter?.ownerType) params.set("ownerType", filter.ownerType);
-        if (filter?.isPublic !== void 0) params.set("isPublic", String(filter.isPublic));
+        if (filter?.isPublic !== void 0)
+          params.set("isPublic", String(filter.isPublic));
         const qs = params.toString();
         return this.request("GET", `/v1/skills${qs ? `?${qs}` : ""}`);
       },
@@ -309,7 +435,10 @@ var CommonsClient = class {
       create: (params) => this.request("POST", "/v1/auth/api-keys", params),
       /** List all active API keys for a principal (key values not included). */
       list: (principalId, principalType) => {
-        const q = new URLSearchParams({ principalId, principalType }).toString();
+        const q = new URLSearchParams({
+          principalId,
+          principalType
+        }).toString();
         return this.request("GET", `/v1/auth/api-keys?${q}`);
       },
       /** Revoke (soft-delete) an API key by its UUID. */
@@ -392,7 +521,10 @@ var CommonsClient = class {
         params: { id: taskId }
       }).then((r) => r.result),
       /** List recent A2A tasks for an agent. */
-      listTasks: (agentId, limit) => this.request("GET", `/v1/a2a/${agentId}/tasks${limit ? `?limit=${limit}` : ""}`),
+      listTasks: (agentId, limit) => this.request(
+        "GET",
+        `/v1/a2a/${agentId}/tasks${limit ? `?limit=${limit}` : ""}`
+      ),
       /** Stream A2A task updates (SSE). */
       stream: (agentId, taskId) => this._streamSse(`/v1/a2a/${agentId}/tasks/${taskId}/stream`)
     };
@@ -401,11 +533,18 @@ var CommonsClient = class {
   get mcp() {
     return {
       /** List MCP servers for an owner. */
-      listServers: (ownerId, ownerType) => this.request("GET", `/v1/mcp/servers?ownerId=${ownerId}&ownerType=${ownerType}`),
+      listServers: (ownerId, ownerType) => this.request(
+        "GET",
+        `/v1/mcp/servers?ownerId=${ownerId}&ownerType=${ownerType}`
+      ),
       /** Create a new MCP server. */
       createServer: (params) => {
         const { ownerId, ownerType, ...dto } = params;
-        return this.request("POST", `/v1/mcp/servers?ownerId=${ownerId}&ownerType=${ownerType}`, dto);
+        return this.request(
+          "POST",
+          `/v1/mcp/servers?ownerId=${ownerId}&ownerType=${ownerType}`,
+          dto
+        );
       },
       /** Get MCP server by ID. */
       getServer: (serverId) => this.request("GET", `/v1/mcp/servers/${serverId}`),
@@ -426,15 +565,25 @@ var CommonsClient = class {
       /** List tools discovered from an MCP server. */
       listTools: (serverId) => this.request("GET", `/v1/mcp/servers/${serverId}/tools`),
       /** List all MCP tools across all servers for a given owner. */
-      listToolsByOwner: (ownerId, ownerType) => this.request("GET", `/v1/mcp/tools?ownerId=${ownerId}&ownerType=${ownerType}`),
+      listToolsByOwner: (ownerId, ownerType) => this.request(
+        "GET",
+        `/v1/mcp/tools?ownerId=${ownerId}&ownerType=${ownerType}`
+      ),
       /** List resources from an MCP server. */
       listResources: (serverId) => this.request("GET", `/v1/mcp/servers/${serverId}/resources`),
       /** Read a resource by URI. */
-      readResource: (serverId, uri) => this.request("GET", `/v1/mcp/servers/${serverId}/resources/read?uri=${encodeURIComponent(uri)}`),
+      readResource: (serverId, uri) => this.request(
+        "GET",
+        `/v1/mcp/servers/${serverId}/resources/read?uri=${encodeURIComponent(uri)}`
+      ),
       /** List prompts from an MCP server. */
       listPrompts: (serverId) => this.request("GET", `/v1/mcp/servers/${serverId}/prompts`),
       /** Render a prompt with arguments. */
-      getPrompt: (serverId, promptName, args) => this.request("POST", `/v1/mcp/servers/${serverId}/prompts/${promptName}`, { arguments: args })
+      getPrompt: (serverId, promptName, args) => this.request(
+        "POST",
+        `/v1/mcp/servers/${serverId}/prompts/${promptName}`,
+        { arguments: args }
+      )
     };
   }
   // ── Memory ────────────────────────────────────────────────────────────────
@@ -446,7 +595,10 @@ var CommonsClient = class {
         if (opts?.type) params.set("type", opts.type);
         if (opts?.limit) params.set("limit", String(opts.limit));
         const qs = params.toString();
-        return this.request("GET", `/v1/memory/agents/${agentId}${qs ? `?${qs}` : ""}`);
+        return this.request(
+          "GET",
+          `/v1/memory/agents/${agentId}${qs ? `?${qs}` : ""}`
+        );
       },
       /** Get memory stats for an agent. */
       stats: (agentId) => this.request("GET", `/v1/memory/agents/${agentId}/stats`),
@@ -454,7 +606,10 @@ var CommonsClient = class {
       retrieve: (agentId, query, limit) => {
         const params = new URLSearchParams({ q: query });
         if (limit) params.set("limit", String(limit));
-        return this.request("GET", `/v1/memory/agents/${agentId}/retrieve?${params}`);
+        return this.request(
+          "GET",
+          `/v1/memory/agents/${agentId}/retrieve?${params}`
+        );
       },
       /** Get a single memory by ID. */
       get: (memoryId) => this.request("GET", `/v1/memory/${memoryId}`),
@@ -463,7 +618,11 @@ var CommonsClient = class {
       /** Update a memory. */
       update: (memoryId, params) => this.request("PATCH", `/v1/memory/${memoryId}`, params),
       /** Soft-delete (deactivate) a memory. */
-      delete: (memoryId) => this.request("DELETE", `/v1/memory/${memoryId}`)
+      delete: (memoryId) => this.request("DELETE", `/v1/memory/${memoryId}`),
+      /** Create an append-only memory scope shared by a set of owned agents. */
+      createSharedScope: (params) => this.request("POST", "/v1/memory/shared-scopes", params),
+      /** List shared-memory scopes available to an agent. */
+      listSharedScopes: (agentId) => this.request("GET", `/v1/memory/shared-scopes/agents/${agentId}`)
     };
   }
   // ── Usage / Observability ─────────────────────────────────────────────────
@@ -475,7 +634,10 @@ var CommonsClient = class {
         if (opts?.from) params.set("from", opts.from);
         if (opts?.to) params.set("to", opts.to);
         const qs = params.toString();
-        return this.request("GET", `/v1/usage/agents/${agentId}${qs ? `?${qs}` : ""}`);
+        return this.request(
+          "GET",
+          `/v1/usage/agents/${agentId}${qs ? `?${qs}` : ""}`
+        );
       },
       /** Get aggregated token + cost usage for a session. */
       getSessionUsage: (sessionId) => this.request("GET", `/v1/usage/sessions/${sessionId}`)