@getsupervisor/agents-studio-sdk 1.4.0 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,54 @@
+## v1.4.0
+
+## [1.4.0](https://github.com/julio-supervisor/agents-studio-be/compare/v1.3.0...v1.4.0) (2025-10-12)
+
+### Features
+
+* Add new SVG icons, images, and documentation updates for Agents Studio API ([3687495](https://github.com/julio-supervisor/agents-studio-be/commit/3687495640477794754b731e912d3f15b9e6db4e))
+* enhance API documentation for agent management and workspace onboarding processes ([819c26c](https://github.com/julio-supervisor/agents-studio-be/commit/819c26cb662401b60004828ac7364aebd7eca039))
+
+## v1.3.0
+
+## [1.3.0](https://github.com/julio-supervisor/agents-studio-be/compare/v1.2.0...v1.3.0) (2025-10-11)
+
+### Features
+
+* actualizar la configuración de autenticación de npm para usar NODE_AUTH_TOKEN en los flujos de trabajo de despliegue y pruebas ([1817bde](https://github.com/julio-supervisor/agents-studio-be/commit/1817bdef6894d52d8be9b6c9649894446ae8dbf4))
+* actualizar la versión de @getsupervisor/api-query-builder a 1.3.0 y agregar script de ejemplos ([dfc83c5](https://github.com/julio-supervisor/agents-studio-be/commit/dfc83c5c7ffccac704a4212c20f054b37bf4c620))
+* **agents:** mejorar la API de agentes para incluir entidades y respuestas con datos adicionales ([7f0103a](https://github.com/julio-supervisor/agents-studio-be/commit/7f0103a4fd881f74cacaa7057562998ad6cd12a5))
+* agregar autenticación npm en flujos de trabajo y mejorar ejemplos de agente ([7ef9dd5](https://github.com/julio-supervisor/agents-studio-be/commit/7ef9dd54f548d017609e143f1a06200b8e7da121))
+* agregar configuración de autenticación npm para el alcance [@getsupervisor](https://github.com/getsupervisor) en flujos de trabajo ([7cd5890](https://github.com/julio-supervisor/agents-studio-be/commit/7cd5890936e96318f52852898a9d740b87b1eb2f))
+* agregar exclusión de ejemplos de SDK en tsconfig.build.json ([5fe700c](https://github.com/julio-supervisor/agents-studio-be/commit/5fe700c48a04f0419729bdb854f18ad7580d5850))
+* ajustar el directorio de trabajo y mejorar la depuración de autenticación npm en el flujo de trabajo de lanzamiento ([acef050](https://github.com/julio-supervisor/agents-studio-be/commit/acef0502b58d9edd15abf1d252c4c33052536661))
+* ajustar el directorio de trabajo y simplificar la instalación de dependencias en el flujo de trabajo de lanzamiento ([dd2b009](https://github.com/julio-supervisor/agents-studio-be/commit/dd2b0090f3e781472fb1401290ba7e971c4c7b17))
+* **api:** add query builder utilities and enhance OpenAPI spec ([1a6744a](https://github.com/julio-supervisor/agents-studio-be/commit/1a6744ac73c0eb4b5e35a7aadfb8093012c18b29))
+* especificar la ruta del Dockerfile en el proceso de construcción de la imagen ([1a7ac54](https://github.com/julio-supervisor/agents-studio-be/commit/1a7ac5406072a81b316e41014ad9bf482b9733fb))
+* habilitar la ejecución manual del flujo de trabajo de lanzamiento del SDK ([25c3654](https://github.com/julio-supervisor/agents-studio-be/commit/25c365481c81a9d7408e8846aee77af193c271e6))
+* reemplazar npm por yarn para la instalación de dependencias y construcción del paquete ([7f09844](https://github.com/julio-supervisor/agents-studio-be/commit/7f09844a26c311e6762570338063ff1a37002ee7))
+* simplificar la configuración de autenticación npm en el flujo de trabajo de lanzamiento ([94fce18](https://github.com/julio-supervisor/agents-studio-be/commit/94fce181286649a276e5556eb256ac6b62ac178e))
+
+## v1.2.0
+
+## [1.2.0](https://github.com/julio-supervisor/agents-studio-be/compare/v1.1.0...v1.2.0) (2025-10-10)
+
+### Features
+
+* **authorization:** mejorar la configuración y pruebas del sistema de autorización ([d963e9d](https://github.com/julio-supervisor/agents-studio-be/commit/d963e9da8d0f97547c7fb93b9b2fb5689e164cbb))
+* **authz:** add casbin authorization module and tests ([2340f5f](https://github.com/julio-supervisor/agents-studio-be/commit/2340f5f0dc6e3a439b78e8147053c30762cd9dad))
+* **authz:** ajustar rutas de mapeo y mejorar pruebas de autorización ([d8e10ef](https://github.com/julio-supervisor/agents-studio-be/commit/d8e10efcbcf41e07b929fa9578ec65d947d83c66))
+* **authz:** implementar configuración de características de la aplicación y adaptador Casbin sin operaciones ([74599a7](https://github.com/julio-supervisor/agents-studio-be/commit/74599a722452c19599e13be3318a096400a9b8e0))
+* **authz:** refactor NullAuthorizationCache methods and improve policy management logic ([93beddf](https://github.com/julio-supervisor/agents-studio-be/commit/93beddfdb832ab7d3d0562c42e99fdae6eb9fb8b))
+* **docker:** agregar copiado de modelos de Casbin y políticas en el Dockerfile ([8122479](https://github.com/julio-supervisor/agents-studio-be/commit/81224793ed1d6756734f884a1e01950713885ec8))
+* **docker:** ajustar Dockerfile para construir desde el directorio correcto y mejorar la gestión de dependencias ([b382edf](https://github.com/julio-supervisor/agents-studio-be/commit/b382edfd7aaac87b2f8c88cc8f9b270abeaff3a9))
+* enhance agent management with new API endpoints and entity bindings ([ff7fd49](https://github.com/julio-supervisor/agents-studio-be/commit/ff7fd49c572828b394cbc3724568cc1ac3a81664))
+* **issue-templates:** agregar plantillas para reportes de bugs, solicitudes de características y problemas de documentación ([eae8404](https://github.com/julio-supervisor/agents-studio-be/commit/eae840448e403afa783dd5301ff2ebe0e811a724))
+
+### Bug Fixes
+
+* **docker:** corregir rutas en el entrypoint y el comando de inicio para la aplicación ([a8e0c0b](https://github.com/julio-supervisor/agents-studio-be/commit/a8e0c0b7adcb1de5b6a409e99dfc4c4f6c4247ef))
+* **migrations:** corregir rutas de migraciones para asegurar la correcta ejecución ([b2a7ed1](https://github.com/julio-supervisor/agents-studio-be/commit/b2a7ed1eaa153a77646220e7d57d61653bb07919))
+
+
 ## v1.1.0
 
 ## [1.1.0](https://github.com/julio-supervisor/agents-studio-be/compare/v1.0.0...v1.1.0) (2025-10-09)

package/README.md

@@ -1,34 +1,39 @@
-# @getsupervisor/conversation-sdk
+# @getsupervisor/agents-studio-sdk
 
-SDK JS/TS para conectar con Conversational API.
+SDK JS/TS oficial para interactuar con la Public API de Agents Studio.
 
 ## Instalación
 
 ```bash
-npm i @getsupervisor/conversation-sdk
+npm i @getsupervisor/agents-studio-sdk
 ```
 
 ## Uso básico
 
 ```ts
-import { createClient } from '@getsupervisor/conversation-sdk';
+import { createClient } from '@getsupervisor/agents-studio-sdk';
 
-const client = createClient({ baseUrl: 'http://localhost:3000/v1' });
-const id = 'a3b2c1...';
+const client = createClient({
+  baseUrl: 'https://public-api.getsupervisor.ai',
+  headers: { Authorization: 'Bearer <token>' },
+  workspaceId: 'ws-123',
+});
 
-// iniciar auth y obtener QR
-const qr = await client.connections.auth(id);
-console.log(qr.qr);
+const { data: agents } = await client.agents.list({ limit: 10 });
+const agent = await client.agents.get('agent-123');
 
-// escuchar eventos SSE
-const off = client.connections.onEvents(id, (e) => console.log('evt', e.data));
+// administrar versiones e instrucciones
+await client.agents
+  .versions(agent.agentId)
+  .instructions('version-1')
+  .create({ order: 1, content: 'Saluda con empatía' });
 
-// obtener estado
-const state = await client.connections.getState(id);
+// catálogo y recursos de tools
+const tools = await client.tools.list({ agentType: 'chat' });
+await client.tools.uploadResource(tools.data[0].identifier, formData);
 
-// cerrar sesión
-await client.connections.disconnect(id);
-off();
+// eliminar un agente
+await client.agents.delete(agent.agentId);
 ```
 
 ## Configuración
@@ -69,16 +74,19 @@ const scoped = client.workspace.scoped('ws-789');
 await scoped.agents.get('agentId');
 ```
 
+## Novedades (septiembre 2024)
+
+- **Sincronización completa con el OpenAPI más reciente**: se regeneraron los tipos `openapi-types.ts` y se actualizó la superficie pública para reflejar nuevos contratos.
+- **Instrucciones por versión**: ahora puedes gestionar instrucciones directamente sobre versiones (`client.agents.versions(...).instructions(...)`) incluyendo operaciones de listar, crear, actualizar y eliminar.
+- **Catálogo y recursos de tools**: soporte para listar tools filtrando por `agentType`, subir/eliminar/recargar recursos y establecer conexiones (`connect`) de manera tipada.
+- **Deprecación de knowledge en agentes**: las rutas de knowledge fueron removidas del API. El helper anterior arroja un error explícito y los tipos asociados ya no se exportan.
+- **Pruebas actualizadas**: la suite de Vitest se ajustó para cubrir helpers de versiones e instrucciones; `npm test` reporta 11 pruebas exitosas.
+
 ## Errores tipados y reintentos
 
-- HttpError(status, statusText, body)
-- TimeoutError(ms)
-- NetworkError(cause)
-- Política de reintentos con backoff exponencial y jitter.
+Los errores siguen modelados como `HttpError`, `TimeoutError` y `NetworkError`. Puedes configurar la política de reintentos con `retry: { maxRetries, baseDelayMs }` en el `createClient`.
 
 ## Compatibilidad
 
 - Soporta ESM y CJS.
-- Navegador y Node (requiere EventSource global o polyfill para SSE).
-
-..
+- Compatible con navegadores y Node.js (requiere `fetch` y `FormData` disponibles en el entorno).

package/dist/index.cjs

@@ -23,15 +23,15 @@ __export(index_exports, {
   NetworkError: () => NetworkError,
   TimeoutError: () => TimeoutError,
   bindAgentInstructions: () => bindAgentInstructions,
-  bindAgentKnowledge: () => bindAgentKnowledge,
   bindAgentPhones: () => bindAgentPhones,
   bindAgentSchedule: () => bindAgentSchedule,
+  bindAgentTags: () => bindAgentTags,
   bindAgentVersions: () => bindAgentVersions,
   createAgentEntity: () => createAgentEntity,
   createAgentInstructionsApi: () => createAgentInstructionsApi,
-  createAgentKnowledgeApi: () => createAgentKnowledgeApi,
   createAgentPhonesApi: () => createAgentPhonesApi,
   createAgentScheduleApi: () => createAgentScheduleApi,
+  createAgentTagsApi: () => createAgentTagsApi,
   createAgentVersionsApi: () => createAgentVersionsApi,
   createAgentsApi: () => createAgentsApi,
   createClient: () => createClient,
@@ -470,60 +470,6 @@ function createAgentInstructionsApi(cfg) {
   };
 }
 
-// src/api/agent-knowledge.ts
-function createAgentKnowledgeApi(cfg) {
-  const { base, doFetch } = createHttp(cfg);
-  const jsonHeaders = { "content-type": "application/json" };
-  const fetchBasesPage = async (agentId, opts = {}) => {
-    const query = serializeListOptions(opts);
-    const res = await doFetch(`${base}/v1/agents/${agentId}/knowledge/bases`, {
-      method: "GET",
-      query
-    });
-    return res.json();
-  };
-  const fetchUploadsPage = async (agentId, opts = {}) => {
-    const query = serializeListOptions(opts);
-    const res = await doFetch(
-      `${base}/v1/agents/${agentId}/knowledge/uploads`,
-      {
-        method: "GET",
-        query
-      }
-    );
-    return res.json();
-  };
-  return {
-    async upload(agentId, payload) {
-      const res = await doFetch(
-        `${base}/v1/agents/${agentId}/knowledge/upload`,
-        {
-          method: "POST",
-          headers: jsonHeaders,
-          body: JSON.stringify(payload)
-        }
-      );
-      return res.json();
-    },
-    async listBases(agentId, opts = {}) {
-      const normalizedOptions = {
-        ...opts ?? {}
-      };
-      const fetchPage = (options) => fetchBasesPage(agentId, options);
-      const response = await fetchPage(normalizedOptions);
-      return attachPaginator(response, fetchPage, normalizedOptions);
-    },
-    async listUploads(agentId, opts = {}) {
-      const normalizedOptions = {
-        ...opts ?? {}
-      };
-      const fetchPage = (options) => fetchUploadsPage(agentId, options);
-      const response = await fetchPage(normalizedOptions);
-      return attachPaginator(response, fetchPage, normalizedOptions);
-    }
-  };
-}
-
 // src/api/agent-phones.ts
 function createAgentPhonesApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
@@ -567,6 +513,27 @@ function createAgentScheduleApi(cfg) {
   };
 }
 
+// src/api/agent-tags.ts
+function createAgentTagsApi(cfg) {
+  const { base, doFetch } = createHttp(cfg);
+  const jsonHeaders = { "content-type": "application/json" };
+  return {
+    async add(agentId, payload) {
+      const res = await doFetch(`${base}/v1/agents/${agentId}/tags`, {
+        method: "POST",
+        headers: jsonHeaders,
+        body: JSON.stringify(payload)
+      });
+      return res.json();
+    },
+    async remove(agentId, tagId) {
+      await doFetch(`${base}/v1/agents/${agentId}/tags/${tagId}`, {
+        method: "DELETE"
+      });
+    }
+  };
+}
+
 // src/api/agent-versions.ts
 function createAgentVersionsApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
@@ -614,6 +581,52 @@ function createAgentVersionsApi(cfg) {
         }
       );
       return res.json();
+    },
+    async delete(agentId, versionId) {
+      await doFetch(`${base}/v1/agents/${agentId}/versions/${versionId}`, {
+        method: "DELETE"
+      });
+    },
+    async listInstructions(agentId, versionId, opts = {}) {
+      const query = serializeListOptions(opts);
+      const res = await doFetch(
+        `${base}/v1/agents/${agentId}/versions/${versionId}/instructions`,
+        {
+          method: "GET",
+          query
+        }
+      );
+      return res.json();
+    },
+    async createInstruction(agentId, versionId, payload) {
+      const res = await doFetch(
+        `${base}/v1/agents/${agentId}/versions/${versionId}/instructions`,
+        {
+          method: "POST",
+          headers: jsonHeaders,
+          body: JSON.stringify(payload)
+        }
+      );
+      return res.json();
+    },
+    async updateInstruction(agentId, versionId, instructionId, payload) {
+      const res = await doFetch(
+        `${base}/v1/agents/${agentId}/versions/${versionId}/instructions/${instructionId}`,
+        {
+          method: "PATCH",
+          headers: jsonHeaders,
+          body: JSON.stringify(payload)
+        }
+      );
+      return res.json();
+    },
+    async deleteInstruction(agentId, versionId, instructionId) {
+      await doFetch(
+        `${base}/v1/agents/${agentId}/versions/${versionId}/instructions/${instructionId}`,
+        {
+          method: "DELETE"
+        }
+      );
     }
   };
 }
@@ -633,15 +646,12 @@ var bindAgentInstructions = (api, agentId) => ({
     return api.delete(agentId, instructionId);
   }
 });
-var bindAgentKnowledge = (api, agentId) => ({
-  upload(payload) {
-    return api.upload(agentId, payload);
-  },
-  listBases(opts) {
-    return api.listBases(agentId, opts);
+var bindAgentTags = (api, agentId) => ({
+  add(tagId) {
+    return api.add(agentId, { tagId });
   },
-  listUploads(opts) {
-    return api.listUploads(agentId, opts);
+  remove(tagId) {
+    return api.remove(agentId, tagId);
   }
 });
 var bindAgentPhones = (api, agentId) => ({
@@ -672,12 +682,36 @@ var bindAgentVersions = (api, agentId) => ({
   },
   update(versionId, payload) {
     return api.update(agentId, versionId, payload);
+  },
+  delete(versionId) {
+    return api.delete(agentId, versionId);
+  },
+  instructions(versionId) {
+    return {
+      list(opts) {
+        return api.listInstructions(agentId, versionId, opts);
+      },
+      create(payload) {
+        return api.createInstruction(agentId, versionId, payload);
+      },
+      update(instructionId, payload) {
+        return api.updateInstruction(
+          agentId,
+          versionId,
+          instructionId,
+          payload
+        );
+      },
+      delete(instructionId) {
+        return api.deleteInstruction(agentId, versionId, instructionId);
+      }
+    };
   }
 });
 var createAgentEntity = (dto, options) => {
   const {
     instructionsApi,
-    knowledgeApi,
+    tagsApi,
     phonesApi,
     scheduleApi,
     versionsApi,
@@ -688,7 +722,7 @@ var createAgentEntity = (dto, options) => {
   const entity = {
     ...dto,
     instructions: bindAgentInstructions(instructionsApi, dto.agentId),
-    knowledge: bindAgentKnowledge(knowledgeApi, dto.agentId),
+    tagAssignments: bindAgentTags(tagsApi, dto.agentId),
     phones: bindAgentPhones(phonesApi, dto.agentId),
     schedule: bindAgentSchedule(scheduleApi, dto.agentId),
     versions: bindAgentVersions(versionsApi, dto.agentId),
@@ -765,7 +799,7 @@ function createAgentsApi(cfg, relatedApis) {
   }
   const wrapAgent = (detail) => createAgentEntity(detail, {
     instructionsApi: relatedApis.instructionsApi,
-    knowledgeApi: relatedApis.knowledgeApi,
+    tagsApi: relatedApis.tagsApi,
     phonesApi: relatedApis.phonesApi,
     scheduleApi: relatedApis.scheduleApi,
     versionsApi: relatedApis.versionsApi,
@@ -812,23 +846,88 @@ function createAgentsApi(cfg, relatedApis) {
 }
 
 // src/api/tools.ts
+var isFormData = (value) => {
+  return typeof FormData !== "undefined" && value instanceof FormData;
+};
+var toFormData = (payload) => {
+  if (isFormData(payload)) {
+    return payload;
+  }
+  if (typeof FormData === "undefined") {
+    throw new TypeError(
+      "FormData is not available in this environment. Pass a FormData instance instead."
+    );
+  }
+  const formData = new FormData();
+  formData.append("file", payload.file);
+  if (payload.type) {
+    formData.append("type", payload.type);
+  }
+  if (payload.title) {
+    formData.append("title", payload.title);
+  }
+  if (payload.metadata) {
+    formData.append("metadata", JSON.stringify(payload.metadata));
+  }
+  return formData;
+};
 function createToolsApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
   const jsonHeaders = { "content-type": "application/json" };
   const fetchToolsPage = async (options = {}) => {
-    const query = serializeListOptions(options);
+    const { agentType, ...queryOptions } = options ?? {};
+    const query = serializeListOptions(queryOptions, { agentType });
     const res = await doFetch(`${base}/v1/tools`, {
       method: "GET",
       query
     });
     return res.json();
   };
+  const fetchToolResourcesPage = async (toolId, options = {}) => {
+    const { type, ...queryOptions } = options ?? {};
+    const query = serializeListOptions(queryOptions, { type });
+    const res = await doFetch(`${base}/v1/tools/${toolId}/resources`, {
+      method: "GET",
+      query
+    });
+    return res.json();
+  };
   return {
     async list(options = {}) {
       const normalizedOptions = { ...options ?? {} };
       const response = await fetchToolsPage(normalizedOptions);
       return attachPaginator(response, fetchToolsPage, normalizedOptions);
     },
+    async listResources(toolId, options = {}) {
+      const normalizedOptions = {
+        ...options ?? {}
+      };
+      const fetchPage = (opts) => fetchToolResourcesPage(toolId, opts);
+      const response = await fetchPage(normalizedOptions);
+      return attachPaginator(response, fetchPage, normalizedOptions);
+    },
+    async uploadResource(toolId, payload) {
+      const formData = toFormData(payload);
+      const res = await doFetch(`${base}/v1/tools/${toolId}/resources`, {
+        method: "POST",
+        body: formData
+      });
+      return res.json();
+    },
+    async deleteResource(toolId, resourceId) {
+      await doFetch(`${base}/v1/tools/${toolId}/resources/${resourceId}`, {
+        method: "DELETE"
+      });
+    },
+    async reloadResource(toolId, resourceId) {
+      const res = await doFetch(
+        `${base}/v1/tools/${toolId}/resources/${resourceId}/reload`,
+        {
+          method: "POST"
+        }
+      );
+      return res.json();
+    },
     async execute(toolId, payload) {
       const res = await doFetch(`${base}/v1/tools/${toolId}/execute`, {
         method: "POST",
@@ -836,6 +935,14 @@ function createToolsApi(cfg) {
         body: JSON.stringify(payload)
       });
       return res.json();
+    },
+    async connect(toolId, payload) {
+      const res = await doFetch(`${base}/v1/tools/${toolId}/connect`, {
+        method: "POST",
+        headers: jsonHeaders,
+        body: JSON.stringify(payload)
+      });
+      return res.json();
     }
   };
 }
@@ -936,14 +1043,14 @@ function createClient(initialCfg) {
     runtimeCfg.getWorkspaceId = getter;
   };
   const instructionsApi = createAgentInstructionsApi(runtimeCfg);
-  const knowledgeApi = createAgentKnowledgeApi(runtimeCfg);
+  const tagsApi = createAgentTagsApi(runtimeCfg);
   const phonesApi = createAgentPhonesApi(runtimeCfg);
   const scheduleApi = createAgentScheduleApi(runtimeCfg);
   const versionsApi = createAgentVersionsApi(runtimeCfg);
   const voicesApi = createVoicesApi(runtimeCfg);
   const agentsApi = createAgentsApi(runtimeCfg, {
     instructionsApi,
-    knowledgeApi,
+    tagsApi,
     phonesApi,
     scheduleApi,
     versionsApi
@@ -951,8 +1058,8 @@ function createClient(initialCfg) {
   const apis = {
     agents: {
       ...agentsApi,
-      knowledge: knowledgeApi,
       instructions: instructionsApi,
+      tags: tagsApi,
       phones: phonesApi,
       schedule: scheduleApi,
       versions: versionsApi
@@ -992,15 +1099,15 @@ function createClient(initialCfg) {
   NetworkError,
   TimeoutError,
   bindAgentInstructions,
-  bindAgentKnowledge,
   bindAgentPhones,
   bindAgentSchedule,
+  bindAgentTags,
   bindAgentVersions,
   createAgentEntity,
   createAgentInstructionsApi,
-  createAgentKnowledgeApi,
   createAgentPhonesApi,
   createAgentScheduleApi,
+  createAgentTagsApi,
   createAgentVersionsApi,
   createAgentsApi,
   createClient,