Merge pull request #102 from zendesk/victor.piolin/search-for-custom-object-record

feat(custom-object-service): Add search records method for Custom object service

Author: Vico1993

__tests__/services/custom-objects.spec.ts

@@ -326,5 +326,66 @@ describe("CustomObjectService", () => {
             });
             expect(requestMock).toHaveBeenCalledTimes(1);
         });
+
+        it("should call Zendesk API with search query", async () => {
+            requestMock.mockResolvedValueOnce({
+                custom_object_records: [customObjectRecord],
+                meta: {
+                    has_more: false
+                }
+            });
+
+            await service.searchRecords("foo", "search_query");
+
+            expect(requestMock).toHaveBeenNthCalledWith(1, {
+                url: `/api/v2/custom_objects/foo/records/search`,
+                type: "GET",
+                contentType: "application/json",
+                data: {
+                    query: "search_query"
+                }
+            });
+            expect(requestMock).toHaveBeenCalledTimes(1);
+        });
+
+        it("should keep sort threw all pages ", async () => {
+            requestMock
+                .mockResolvedValueOnce({
+                    custom_object_records: [customObjectRecord],
+                    meta: {
+                        has_more: true,
+                        after_cursor: "1"
+                    }
+                })
+                .mockResolvedValueOnce({
+                    custom_object_records: [customObjectRecord],
+                    meta: {
+                        has_more: false
+                    }
+                });
+
+            await service.retrieveAllCustomObjectRecords("foo", { sort: ListCutomObjectRecordsSortingOptions.ID });
+
+            expect(requestMock).toHaveBeenNthCalledWith(1, {
+                url: `/api/v2/custom_objects/foo/records`,
+                type: "GET",
+                contentType: "application/json",
+                data: {
+                    sort: "id"
+                }
+            });
+            expect(requestMock).toHaveBeenNthCalledWith(2, {
+                url: `/api/v2/custom_objects/foo/records`,
+                type: "GET",
+                contentType: "application/json",
+                data: {
+                    page: {
+                        after: "1"
+                    },
+                    sort: "id"
+                }
+            });
+            expect(requestMock).toHaveBeenCalledTimes(2);
+        });
     });
 });

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zendesk/zaf-toolbox",
-    "version": "0.2.9",
+    "version": "0.2.10",
     "description": "A toolbox for ZAF application built with 🩷 by Zendesk Labs",
     "main": "lib/src/index.js",
     "types": "lib/src/index.d.ts",

src/models/custom-objects.ts

@@ -141,6 +141,10 @@ export interface IListCustomObjectRecordsFilter {
     sort?: ListCutomObjectRecordsSortingOptions;
 }
 
+export interface ISearchCustomObjectRecordsFilter extends IListCustomObjectRecordsFilter {
+    query: string;
+}
+
 export interface ICreateCustomObjectRecordBody<T extends ICustomObjectRecordField> {
     custom_object_fields: T;
     name: string;

src/services/custom-object-service.ts

@@ -11,7 +11,8 @@ import {
     IListCustomObjectRecordsResponse,
     ICustomObjectRecord,
     ListCutomObjectRecordsSortingOptions,
-    ICustomObjectRecordField
+    ICustomObjectRecordField,
+    ISearchCustomObjectRecordsFilter
 } from "@models/index";
 import { Client } from "@zendesk/sell-zaf-app-toolbox";
 
@@ -140,30 +141,9 @@ export class CustomObjectService {
         key: string,
         sortOptions?: { sort: ListCutomObjectRecordsSortingOptions }
     ): Promise<ICustomObjectRecord<T>[]> {
-        let hasMore = true;
-        let data: IListCustomObjectRecordsFilter = {};
-        let objects: ICustomObjectRecord<T>[] = [];
-
-        do {
-            const response = await this.client.request<any, IListCustomObjectRecordsResponse<T>>({
-                url: `/api/v2/custom_objects/${key}/records`,
-                type: "GET",
-                contentType: CONTENT_TYPE,
-                data
-            });
-
-            objects = [...objects, ...response.custom_object_records];
-
-            hasMore = response.meta.has_more;
-            data = {
-                page: {
-                    after: response.meta.after_cursor
-                },
-                ...sortOptions
-            };
-        } while (hasMore);
-
-        return objects;
+        return this.fetchAllPaginatedRecords<T>(`/api/v2/custom_objects/${key}/records`, {
+            sort: sortOptions?.sort
+        } as IListCustomObjectRecordsFilter);
     }
 
     /**
@@ -237,4 +217,63 @@ export class CustomObjectService {
             contentType: CONTENT_TYPE
         });
     }
+
+    /**
+     * Get custom object records by search
+     * The query parameter is used to search text-based fields for records that match specific query terms. The query can be multiple words or numbers. Every record that matches the beginning of any word or number in the query string is returned.
+     * Fuzzy search is supported for the following text-based field types: : Text fields, Multi Line Text fields, and RegExp fields.
+     *
+     * @param key - The custom object key
+     * @param query - The search query
+     * @see https://developer.zendesk.com/api-reference/custom-data/custom-objects/custom_object_records/#search-custom-object-records
+     */
+    public async searchRecords<T extends ICustomObjectRecordField>(key: string, query: string) {
+        return this.fetchAllPaginatedRecords<T>(`/api/v2/custom_objects/${key}/records/search`, {
+            query
+        } as ISearchCustomObjectRecordsFilter);
+    }
+
+    /**
+     * Generic method to fetch all records using pagination
+     *
+     * @param url - The API endpoint URL
+     * @param initialData - Initial request data
+     * @param getNextPageData - Function to build the next page request data
+     * @returns Array of all fetched records
+     */
+    private async fetchAllPaginatedRecords<T extends ICustomObjectRecordField>(
+        url: string,
+        initialData: IListCustomObjectRecordsFilter
+    ): Promise<ICustomObjectRecord<T>[]> {
+        let hasMore = true;
+        let data = initialData;
+        let objects: ICustomObjectRecord<T>[] = [];
+
+        do {
+            const response = await this.client.request<any, IListCustomObjectRecordsResponse<T>>({
+                url,
+                type: "GET",
+                contentType: CONTENT_TYPE,
+                data
+            });
+
+            objects = [...objects, ...response.custom_object_records];
+
+            hasMore = response.meta.has_more;
+            if (hasMore) {
+                data = {
+                    page: {
+                        after: response.meta.after_cursor
+                    },
+                    ...(initialData.sort
+                        ? {
+                              sort: initialData.sort
+                          }
+                        : undefined)
+                } as IListCustomObjectRecordsFilter;
+            }
+        } while (hasMore);
+
+        return objects;
+    }
 }