@getsupervisor/agents-studio-sdk 1.3.0 → 1.4.0

package/dist/index.js

@@ -1,3 +1,95 @@
+// src/utils/pagination.ts
+var toNumber = (value) => {
+  return typeof value === "number" ? value : void 0;
+};
+var toBoolean = (value) => {
+  return typeof value === "boolean" ? value : void 0;
+};
+function cloneOptions(options, overrides) {
+  return {
+    ...options ?? {},
+    ...overrides ?? {}
+  };
+}
+function normalizeMeta(meta) {
+  if (!meta) {
+    return void 0;
+  }
+  const metaRecord = meta;
+  return {
+    ...metaRecord,
+    page: toNumber(metaRecord.page),
+    limit: toNumber(metaRecord.limit) ?? toNumber(metaRecord.pageSize),
+    total: toNumber(metaRecord.total) ?? toNumber(metaRecord.totalItems),
+    hasNext: toBoolean(metaRecord.hasNext),
+    hasPrevious: toBoolean(metaRecord.hasPrevious),
+    totalPages: toNumber(metaRecord.totalPages)
+  };
+}
+function resolveHasNext(meta, limit) {
+  if (typeof meta?.hasNext === "boolean") {
+    return meta.hasNext;
+  }
+  if (typeof meta?.total === "number" && typeof meta?.page === "number" && typeof limit === "number") {
+    return meta.page * limit < meta.total;
+  }
+  if (typeof meta?.totalPages === "number" && typeof meta?.page === "number") {
+    return meta.page < meta.totalPages;
+  }
+  return false;
+}
+function resolveHasPrevious(meta) {
+  if (typeof meta?.hasPrevious === "boolean") {
+    return meta.hasPrevious;
+  }
+  if (typeof meta?.page === "number") {
+    return meta.page > 1;
+  }
+  return false;
+}
+function attachPaginator(response, fetchPage, options) {
+  const baseOptions = options ?? {};
+  const meta = normalizeMeta(response.meta);
+  const currentPage = typeof meta?.page === "number" ? meta.page : typeof baseOptions.page === "number" ? baseOptions.page : 1;
+  const currentLimit = typeof meta?.limit === "number" ? meta.limit : typeof baseOptions.limit === "number" ? baseOptions.limit : void 0;
+  const getNextResponse = async (page, overrides) => {
+    const nextOptions = cloneOptions(baseOptions, {
+      ...overrides,
+      page
+    });
+    const nextResponse = await fetchPage(nextOptions);
+    return attachPaginator(nextResponse, fetchPage, nextOptions);
+  };
+  return Object.assign(response, {
+    async next() {
+      if (!resolveHasNext(meta, currentLimit)) {
+        return null;
+      }
+      return getNextResponse(currentPage + 1);
+    },
+    async prev() {
+      if (!resolveHasPrevious(meta)) {
+        return null;
+      }
+      return getNextResponse(Math.max(1, currentPage - 1));
+    },
+    async page(pageNumber) {
+      if (typeof pageNumber !== "number" || Number.isNaN(pageNumber)) {
+        throw new TypeError("page(pageNumber) requires a numeric value.");
+      }
+      if (pageNumber < 1) {
+        throw new RangeError(
+          "Page numbers must be greater than or equal to 1."
+        );
+      }
+      return getNextResponse(pageNumber);
+    },
+    async reload() {
+      return getNextResponse(currentPage);
+    }
+  });
+}
+
 // src/errors.ts
 var HttpError = class extends Error {
   constructor(status, statusText, body, url) {
@@ -286,15 +378,23 @@ function getQueryBuilderString(value) {
 function createAgentInstructionsApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
   const jsonHeaders = { "content-type": "application/json" };
+  const fetchInstructionPage = async (agentId, opts = {}) => {
+    const { versionId, ...queryOptions } = opts ?? {};
+    const query = serializeListOptions(queryOptions, { versionId });
+    const res = await doFetch(`${base}/v1/agents/${agentId}/instructions`, {
+      method: "GET",
+      query
+    });
+    return res.json();
+  };
   return {
     async list(agentId, opts = {}) {
-      const { versionId, ...queryOptions } = opts;
-      const query = serializeListOptions(queryOptions, { versionId });
-      const res = await doFetch(`${base}/v1/agents/${agentId}/instructions`, {
-        method: "GET",
-        query
-      });
-      return res.json();
+      const normalizedOptions = {
+        ...opts ?? {}
+      };
+      const fetchPage = (options) => fetchInstructionPage(agentId, options);
+      const response = await fetchPage(normalizedOptions);
+      return attachPaginator(response, fetchPage, normalizedOptions);
     },
     async create(agentId, payload) {
       const res = await doFetch(`${base}/v1/agents/${agentId}/instructions`, {
@@ -330,6 +430,25 @@ function createAgentInstructionsApi(cfg) {
 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(
@@ -343,26 +462,20 @@ function createAgentKnowledgeApi(cfg) {
       return res.json();
     },
     async listBases(agentId, opts = {}) {
-      const query = serializeListOptions(opts);
-      const res = await doFetch(
-        `${base}/v1/agents/${agentId}/knowledge/bases`,
-        {
-          method: "GET",
-          query
-        }
-      );
-      return res.json();
+      const normalizedOptions = {
+        ...opts ?? {}
+      };
+      const fetchPage = (options) => fetchBasesPage(agentId, options);
+      const response = await fetchPage(normalizedOptions);
+      return attachPaginator(response, fetchPage, normalizedOptions);
     },
     async listUploads(agentId, opts = {}) {
-      const query = serializeListOptions(opts);
-      const res = await doFetch(
-        `${base}/v1/agents/${agentId}/knowledge/uploads`,
-        {
-          method: "GET",
-          query
-        }
-      );
-      return res.json();
+      const normalizedOptions = {
+        ...opts ?? {}
+      };
+      const fetchPage = (options) => fetchUploadsPage(agentId, options);
+      const response = await fetchPage(normalizedOptions);
+      return attachPaginator(response, fetchPage, normalizedOptions);
     }
   };
 }
@@ -414,15 +527,21 @@ function createAgentScheduleApi(cfg) {
 function createAgentVersionsApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
   const jsonHeaders = { "content-type": "application/json" };
+  const fetchVersionsPage = async (agentId, opts = {}) => {
+    const { status, ...queryOptions } = opts ?? {};
+    const query = serializeListOptions(queryOptions, { status });
+    const res = await doFetch(`${base}/v1/agents/${agentId}/versions`, {
+      method: "GET",
+      query
+    });
+    return res.json();
+  };
   return {
     async list(agentId, opts = {}) {
-      const { status, ...queryOptions } = opts;
-      const query = serializeListOptions(queryOptions, { status });
-      const res = await doFetch(`${base}/v1/agents/${agentId}/versions`, {
-        method: "GET",
-        query
-      });
-      return res.json();
+      const normalizedOptions = { ...opts ?? {} };
+      const fetchPage = (options) => fetchVersionsPage(agentId, options);
+      const response = await fetchPage(normalizedOptions);
+      return attachPaginator(response, fetchPage, normalizedOptions);
     },
     async get(agentId, versionId) {
       const res = await doFetch(
@@ -518,7 +637,9 @@ var createAgentEntity = (dto, options) => {
     phonesApi,
     scheduleApi,
     versionsApi,
-    reload
+    reload,
+    updateAgent,
+    deleteAgent
   } = options;
   const entity = {
     ...dto,
@@ -527,6 +648,12 @@ var createAgentEntity = (dto, options) => {
     phones: bindAgentPhones(phonesApi, dto.agentId),
     schedule: bindAgentSchedule(scheduleApi, dto.agentId),
     versions: bindAgentVersions(versionsApi, dto.agentId),
+    async save(patch) {
+      return updateAgent(dto.agentId, patch);
+    },
+    async delete() {
+      await deleteAgent(dto.agentId);
+    },
     async refresh() {
       return reload(dto.agentId);
     }
@@ -538,7 +665,7 @@ var createAgentEntity = (dto, options) => {
 function createAgentsApi(cfg, relatedApis) {
   const { base, doFetch } = createHttp(cfg);
   const jsonHeaders = { "content-type": "application/json" };
-  const listAgents = async (options = {}) => {
+  const fetchAgentsPage = async (options = {}) => {
     const query = serializeListOptions(options);
     const res = await doFetch(`${base}/v1/agents`, {
       method: "GET",
@@ -546,6 +673,11 @@ function createAgentsApi(cfg, relatedApis) {
     });
     return res.json();
   };
+  const listAgents = async (options = {}) => {
+    const normalizedOptions = { ...options ?? {} };
+    const response = await fetchAgentsPage(normalizedOptions);
+    return attachPaginator(response, fetchAgentsPage, normalizedOptions);
+  };
   const getAgentDetail = async (agentId) => {
     const res = await doFetch(`${base}/v1/agents/${agentId}`, {
       method: "GET"
@@ -568,7 +700,11 @@ function createAgentsApi(cfg, relatedApis) {
     });
     return res.json();
   };
-  const deleteAgent = async (agentId) => {
+  const resolveAgentId = (agent) => {
+    return typeof agent === "string" ? agent : agent.agentId;
+  };
+  const deleteAgent = async (agent) => {
+    const agentId = resolveAgentId(agent);
     await doFetch(`${base}/v1/agents/${agentId}`, {
       method: "DELETE"
     });
@@ -592,17 +728,29 @@ function createAgentsApi(cfg, relatedApis) {
     reload: async (agentId) => {
       const latest = await getAgentDetail(agentId);
       return wrapAgent(latest);
+    },
+    updateAgent: async (agentId, payload) => {
+      const updated = await updateAgent(agentId, payload);
+      return wrapAgent(updated);
+    },
+    deleteAgent: async (agentId) => {
+      await deleteAgent(agentId);
     }
   });
   return {
     ...baseApi,
     async list(options = {}) {
-      const response = await listAgents(options);
-      const items = Array.isArray(response.data) ? response.data : [];
-      return {
-        ...response,
-        data: items.map((summary) => wrapAgent(summary))
+      const normalizedOptions = { ...options ?? {} };
+      const applyWrap = async (opts) => {
+        const result = await fetchAgentsPage(opts);
+        const items = Array.isArray(result.data) ? result.data : [];
+        return {
+          ...result,
+          data: items.map((summary) => wrapAgent(summary))
+        };
       };
+      const initial = await applyWrap(normalizedOptions);
+      return attachPaginator(initial, applyWrap, normalizedOptions);
     },
     async get(agentId) {
       const detail = await getAgentDetail(agentId);
@@ -623,14 +771,19 @@ function createAgentsApi(cfg, relatedApis) {
 function createToolsApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
   const jsonHeaders = { "content-type": "application/json" };
+  const fetchToolsPage = async (options = {}) => {
+    const query = serializeListOptions(options);
+    const res = await doFetch(`${base}/v1/tools`, {
+      method: "GET",
+      query
+    });
+    return res.json();
+  };
   return {
     async list(options = {}) {
-      const query = serializeListOptions(options);
-      const res = await doFetch(`${base}/v1/tools`, {
-        method: "GET",
-        query
-      });
-      return res.json();
+      const normalizedOptions = { ...options ?? {} };
+      const response = await fetchToolsPage(normalizedOptions);
+      return attachPaginator(response, fetchToolsPage, normalizedOptions);
     },
     async execute(toolId, payload) {
       const res = await doFetch(`${base}/v1/tools/${toolId}/execute`, {
@@ -646,32 +799,37 @@ function createToolsApi(cfg) {
 // src/api/voices.ts
 function createVoicesApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
+  const fetchVoicesPage = async (options = {}) => {
+    const { agentId, agentVersionId, gender, locale } = options;
+    const query = serializeListOptions(
+      {
+        page: options.page,
+        limit: options.limit ?? options.pageSize,
+        sort: options.sort,
+        fields: options.fields,
+        include: options.include,
+        search: options.search,
+        filter: options.filter,
+        or: options.or
+      },
+      {
+        agentId,
+        agentVersionId,
+        gender,
+        locale
+      }
+    );
+    const res = await doFetch(`${base}/v1/voices`, {
+      method: "GET",
+      query
+    });
+    return res.json();
+  };
   return {
     async list(options = {}) {
-      const { agentId, agentVersionId, gender, locale } = options;
-      const query = serializeListOptions(
-        {
-          page: options.page,
-          limit: options.limit ?? options.pageSize,
-          sort: options.sort,
-          fields: options.fields,
-          include: options.include,
-          search: options.search,
-          filter: options.filter,
-          or: options.or
-        },
-        {
-          agentId,
-          agentVersionId,
-          gender,
-          locale
-        }
-      );
-      const res = await doFetch(`${base}/v1/voices`, {
-        method: "GET",
-        query
-      });
-      return res.json();
+      const normalizedOptions = { ...options ?? {} };
+      const response = await fetchVoicesPage(normalizedOptions);
+      return attachPaginator(response, fetchVoicesPage, normalizedOptions);
     }
   };
 }
@@ -680,27 +838,35 @@ function createVoicesApi(cfg) {
 function createWorkspacesApi(cfg) {
   const { base, doFetch } = createHttp(cfg);
   const jsonHeaders = { "content-type": "application/json" };
+  const fetchPhonesPage = async (workspaceId, opts = {}) => {
+    const { channel } = opts ?? {};
+    const query = serializeListOptions(
+      {
+        page: opts.page,
+        limit: opts.limit,
+        sort: opts.sort,
+        fields: opts.fields,
+        include: opts.include,
+        search: opts.search,
+        filter: opts.filter,
+        or: opts.or
+      },
+      { channel }
+    );
+    const res = await doFetch(`${base}/v1/workspaces/${workspaceId}/phones`, {
+      method: "GET",
+      query
+    });
+    return res.json();
+  };
   return {
     async listPhones(workspaceId, opts = {}) {
-      const { channel } = opts;
-      const query = serializeListOptions(
-        {
-          page: opts.page,
-          limit: opts.limit,
-          sort: opts.sort,
-          fields: opts.fields,
-          include: opts.include,
-          search: opts.search,
-          filter: opts.filter,
-          or: opts.or
-        },
-        { channel }
-      );
-      const res = await doFetch(`${base}/v1/workspaces/${workspaceId}/phones`, {
-        method: "GET",
-        query
-      });
-      return res.json();
+      const normalizedOptions = {
+        ...opts ?? {}
+      };
+      const response = await fetchPhonesPage(workspaceId, normalizedOptions);
+      const fetchPage = (options) => fetchPhonesPage(workspaceId, options);
+      return attachPaginator(response, fetchPage, normalizedOptions);
     },
     async enable(workspaceId, payload) {
       const res = await doFetch(`${base}/v1/workspaces/${workspaceId}/enable`, {