kommo-aiatende-api 1.2.6 → 1.2.7

package/dist/index.d.mts

@@ -895,6 +895,15 @@ interface ListCustomField extends BaseCustomField {
 }
 interface ListEntityCustomFieldsResponse {
     _total_items?: number;
+    _page?: number;
+    _links?: {
+        self?: {
+            href: string;
+        };
+        next?: {
+            href: string;
+        };
+    };
     _embedded?: {
         custom_fields?: EntityCustomField[];
     };
@@ -982,6 +991,12 @@ interface CustomFieldGroup {
 }
 interface ListCustomFieldGroupsResponse {
     _embedded?: {
+        /** A chave que o Kommo devolve. */
+        custom_field_groups?: CustomFieldGroup[];
+        /**
+         * @deprecated Nome errado usado até a 1.2.6 (o Kommo nunca devolveu esta chave). O SDK ainda
+         * preenche com a mesma lista; use `custom_field_groups`.
+         */
         custom_fields_groups?: CustomFieldGroup[];
     };
 }
@@ -997,7 +1012,16 @@ interface UpdateCustomFieldGroupInput {
 }
 
 declare class CustomFieldsResource extends BaseResource {
-    listEntity(entityType: EntityType): Promise<ListEntityCustomFieldsResponse>;
+    /**
+     * Campos da entidade. O Kommo devolve no máximo 50 por página: sem `page`, percorre todas as
+     * páginas e devolve a lista inteira (conta com mais de 50 campos perdia o resto). Com `page`,
+     * só aquela página.
+     */
+    listEntity(entityType: EntityType, params?: {
+        page?: number;
+        limit?: number;
+    }): Promise<ListEntityCustomFieldsResponse>;
+    private paginaDeCampos;
     getEntityById(entityType: EntityType, id: number): Promise<EntityCustomField>;
     createEntity(entityType: EntityType, items: CreateEntityCustomFieldInput | CreateEntityCustomFieldInput[]): Promise<ListEntityCustomFieldsResponse>;
     updateEntity(entityType: EntityType, items: UpdateEntityCustomFieldInput | UpdateEntityCustomFieldInput[]): Promise<ListEntityCustomFieldsResponse>;

package/dist/index.d.ts

@@ -895,6 +895,15 @@ interface ListCustomField extends BaseCustomField {
 }
 interface ListEntityCustomFieldsResponse {
     _total_items?: number;
+    _page?: number;
+    _links?: {
+        self?: {
+            href: string;
+        };
+        next?: {
+            href: string;
+        };
+    };
     _embedded?: {
         custom_fields?: EntityCustomField[];
     };
@@ -982,6 +991,12 @@ interface CustomFieldGroup {
 }
 interface ListCustomFieldGroupsResponse {
     _embedded?: {
+        /** A chave que o Kommo devolve. */
+        custom_field_groups?: CustomFieldGroup[];
+        /**
+         * @deprecated Nome errado usado até a 1.2.6 (o Kommo nunca devolveu esta chave). O SDK ainda
+         * preenche com a mesma lista; use `custom_field_groups`.
+         */
         custom_fields_groups?: CustomFieldGroup[];
     };
 }
@@ -997,7 +1012,16 @@ interface UpdateCustomFieldGroupInput {
 }
 
 declare class CustomFieldsResource extends BaseResource {
-    listEntity(entityType: EntityType): Promise<ListEntityCustomFieldsResponse>;
+    /**
+     * Campos da entidade. O Kommo devolve no máximo 50 por página: sem `page`, percorre todas as
+     * páginas e devolve a lista inteira (conta com mais de 50 campos perdia o resto). Com `page`,
+     * só aquela página.
+     */
+    listEntity(entityType: EntityType, params?: {
+        page?: number;
+        limit?: number;
+    }): Promise<ListEntityCustomFieldsResponse>;
+    private paginaDeCampos;
     getEntityById(entityType: EntityType, id: number): Promise<EntityCustomField>;
     createEntity(entityType: EntityType, items: CreateEntityCustomFieldInput | CreateEntityCustomFieldInput[]): Promise<ListEntityCustomFieldsResponse>;
     updateEntity(entityType: EntityType, items: UpdateEntityCustomFieldInput | UpdateEntityCustomFieldInput[]): Promise<ListEntityCustomFieldsResponse>;

package/dist/index.js

@@ -135,6 +135,15 @@ var BaseResource = class {
   }
 };
 
+// src/utils/emptyList.ts
+function listOrEmpty(response, key, page = 1) {
+  const data = response.data;
+  if (response.status === 204 || data === "" || data === null || data === void 0) {
+    return { _page: page, _embedded: { [key]: [] } };
+  }
+  return response.data;
+}
+
 // src/resources/leads/index.ts
 var LeadsResource = class extends BaseResource {
   async list(params) {
@@ -187,7 +196,7 @@ var LeadsResource = class extends BaseResource {
     const query = import_qs.default.stringify(queryParams, { skipNulls: true, arrayFormat: "brackets" });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/leads${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "leads", params?.page ?? 1);
   }
   async getById(id, params) {
     try {
@@ -234,7 +243,7 @@ var LeadsResource = class extends BaseResource {
   }
   async listLossReasons() {
     const response = await this.client.get("/api/v4/leads/loss_reasons");
-    return response.data;
+    return listOrEmpty(response, "loss_reasons");
   }
   async getLossReasonById(id) {
     const response = await this.client.get(`/api/v4/leads/loss_reasons/${id}`);
@@ -289,7 +298,7 @@ var ContactsResource = class extends BaseResource {
     const query = import_qs2.default.stringify(queryParams, { skipNulls: true, arrayFormat: "brackets" });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/contacts${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "contacts", params?.page ?? 1);
   }
   async getById(id, params) {
     try {
@@ -371,7 +380,7 @@ var TasksResource = class extends BaseResource {
     const query = import_qs3.default.stringify(queryParams, { skipNulls: true, arrayFormat: "brackets" });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/tasks${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "tasks", params?.page ?? 1);
   }
   async getById(id) {
     const response = await this.client.get(`/api/v4/tasks/${id}`);
@@ -435,7 +444,7 @@ var NotesResource = class extends BaseResource {
     const response = await this.client.get(
       `/api/v4/${normalType}/${entityId}/notes${qsStr}`
     );
-    return response.data;
+    return listOrEmpty(response, "notes");
   }
   async listByEntityType(entityType, params) {
     const normalType = this.normalizeEntityType(entityType);
@@ -468,7 +477,7 @@ var NotesResource = class extends BaseResource {
     const response = await this.client.get(
       `/api/v4/${normalType}/notes${qsStr}`
     );
-    return response.data;
+    return listOrEmpty(response, "notes");
   }
   async getById(entityType, id) {
     const normalType = this.normalizeEntityType(entityType);
@@ -512,13 +521,32 @@ var NotesResource = class extends BaseResource {
 };
 
 // src/resources/custom-fields/index.ts
+var LIMITE_DE_CAMPOS = 50;
+var MAX_PAGINAS_DE_CAMPOS = 40;
 var CustomFieldsResource = class extends BaseResource {
   // ==== CAMPOS DE ENTIDADES ====
-  async listEntity(entityType) {
+  /**
+   * Campos da entidade. O Kommo devolve no máximo 50 por página: sem `page`, percorre todas as
+   * páginas e devolve a lista inteira (conta com mais de 50 campos perdia o resto). Com `page`,
+   * só aquela página.
+   */
+  async listEntity(entityType, params) {
+    if (params?.page !== void 0)
+      return this.paginaDeCampos(entityType, params.page, params.limit);
+    const campos = [];
+    for (let page = 1; page <= MAX_PAGINAS_DE_CAMPOS; page++) {
+      const r = await this.paginaDeCampos(entityType, page, LIMITE_DE_CAMPOS);
+      const lista = r._embedded?.custom_fields ?? [];
+      campos.push(...lista);
+      if (lista.length < LIMITE_DE_CAMPOS) break;
+    }
+    return { _total_items: campos.length, _embedded: { custom_fields: campos } };
+  }
+  async paginaDeCampos(entityType, page, limit = LIMITE_DE_CAMPOS) {
     const response = await this.client.get(
-      `/api/v4/${entityType}/custom_fields`
+      `/api/v4/${entityType}/custom_fields?page=${page}&limit=${limit}`
     );
-    return response.data;
+    return listOrEmpty(response, "custom_fields", page);
   }
   async getEntityById(entityType, id) {
     const response = await this.client.get(
@@ -557,7 +585,7 @@ var CustomFieldsResource = class extends BaseResource {
     const response = await this.client.get(
       `/api/v4/catalogs/${listId}/custom_fields`
     );
-    return response.data;
+    return listOrEmpty(response, "custom_fields");
   }
   async getListById(listId, customFieldId) {
     const response = await this.client.get(
@@ -592,12 +620,19 @@ var CustomFieldsResource = class extends BaseResource {
     await this.client.delete(`/api/v4/catalogs/${listId}/custom_fields/${id}`);
   }
 };
+function comGrupos(r) {
+  const grupos = r._embedded?.custom_field_groups ?? r._embedded?.custom_fields_groups ?? [];
+  return {
+    ...r,
+    _embedded: { ...r._embedded, custom_field_groups: grupos, custom_fields_groups: grupos }
+  };
+}
 var CustomFieldGroupsResource = class extends BaseResource {
   async list(entityType) {
     const response = await this.client.get(
       `/api/v4/${entityType}/custom_fields/groups`
     );
-    return response.data;
+    return comGrupos(listOrEmpty(response, "custom_field_groups"));
   }
   async getById(entityType, id) {
     const response = await this.client.get(
@@ -611,7 +646,7 @@ var CustomFieldGroupsResource = class extends BaseResource {
       `/api/v4/${entityType}/custom_fields/groups`,
       payload
     );
-    return response.data;
+    return comGrupos(response.data);
   }
   async update(entityType, id, payload) {
     const response = await this.client.patch(
@@ -721,7 +756,7 @@ var PipelinesResource = class extends BaseResource {
   // PIPELINES
   async list() {
     const response = await this.client.get("/api/v4/leads/pipelines");
-    return response.data;
+    return listOrEmpty(response, "pipelines");
   }
   async getById(id) {
     const response = await this.client.get(`/api/v4/leads/pipelines/${id}`);
@@ -749,7 +784,7 @@ var PipelinesResource = class extends BaseResource {
     const response = await this.client.get(
       `/api/v4/leads/pipelines/${pipelineId}/statuses${qsStr}`
     );
-    return response.data;
+    return listOrEmpty(response, "statuses");
   }
   async getStatusById(pipelineId, id, params) {
     const query = import_qs6.default.stringify({ with: params?.with }, { skipNulls: true });
@@ -844,7 +879,7 @@ var CompaniesResource = class extends BaseResource {
     const query = import_qs7.default.stringify(queryParams, { skipNulls: true, arrayFormat: "brackets" });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/companies${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "companies", params?.page ?? 1);
   }
   async getById(id, params) {
     try {
@@ -895,7 +930,7 @@ var CatalogsResource = class extends BaseResource {
     const query = import_qs8.default.stringify({ page: params?.page, limit: params?.limit }, { skipNulls: true });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/catalogs${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "catalogs", params?.page ?? 1);
   }
   async getById(id) {
     const response = await this.client.get(`/api/v4/catalogs/${id}`);
@@ -933,7 +968,7 @@ var CatalogsResource = class extends BaseResource {
     const response = await this.client.get(
       `/api/v4/catalogs/${listId}/elements${qsStr}`
     );
-    return response.data;
+    return listOrEmpty(response, "elements");
   }
   async getElementById(listId, elementId) {
     const response = await this.client.get(
@@ -980,7 +1015,7 @@ var UsersResource = class extends BaseResource {
     const query = import_qs9.default.stringify(queryParams, { skipNulls: true });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/users${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "users", params?.page ?? 1);
   }
   async getById(id, params) {
     const queryParams = {};
@@ -1010,7 +1045,7 @@ var RolesResource = class extends BaseResource {
     const query = import_qs9.default.stringify(queryParams, { skipNulls: true });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/roles${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "roles");
   }
   async getById(id, params) {
     const queryParams = {};
@@ -1077,7 +1112,7 @@ var EventsResource = class extends BaseResource {
     const query = import_qs10.default.stringify(queryParams, { skipNulls: true, arrayFormat: "brackets" });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/events${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "events", params?.page ?? 1);
   }
   async getById(id, params) {
     const queryParams = {};
@@ -1097,7 +1132,7 @@ var EventsResource = class extends BaseResource {
     const query = import_qs10.default.stringify(queryParams, { skipNulls: true });
     const qsStr = query ? `?${query}` : "";
     const response = await this.client.get(`/api/v4/events/types${qsStr}`);
-    return response.data;
+    return listOrEmpty(response, "events_types");
   }
 };