Add support for search query

samuelreichor · Dec 30, 2024 · db0c83e · db0c83e
1 parent 969381d
commit db0c83e
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/.changeset/long-cows-compare.md b/.changeset/long-cows-compare.md
@@ -0,0 +1,5 @@
+---
+'js-craftcms-api': patch
+---
+
+Add support for search query
diff --git a/src/index.ts b/src/index.ts
@@ -24,6 +24,7 @@ export interface CommonQueryParams {
   offset?: number;
   orderBy?: string;
   fields?: string | string[];
+  search?: string;
 }
 
 // Specific query parameters for each element type
@@ -85,6 +86,7 @@ export interface CommonQueryBuilder {
   offset: (value: CommonQueryParams['offset']) => this;
   orderBy: (value: CommonQueryParams['orderBy']) => this;
   fields: (value: CommonQueryParams['fields']) => this;
+  search: (value: CommonQueryParams['search']) => this;
   buildBaseUrl: (value: ExecutionMethod) => string;
 }
 
@@ -169,6 +171,10 @@ export function buildCraftQueryUrl<T extends ElementType>(elementType: T): Query
       params.fields = value;
       return this;
     },
+    search(value) {
+      params.search = value;
+      return this;
+    },
     buildBaseUrl(value) {
       if (value === 'all') {
         params.one = undefined;

diff --git a/src/tests/index.test.ts b/src/tests/index.test.ts
@@ -15,14 +15,15 @@ describe('buildCraftQueryUrl Tests', () => {
         .limit(5)
         .offset(2)
         .orderBy('name')
-        .fields(['title', 'heroImage']);
+        .fields(['title', 'heroImage'])
+        .search('q');
 
       arrOfExecutionTypes.forEach((executionType) => {
         it(`Should execute all commonQueryBuilder functions for ${elementType} with ${executionType}()`, async () => {
           const queryUrlOne = baseQuery.buildBaseUrl(executionType);
 
           expect(queryUrlOne).toContain(
-            `elementType=${elementType}&id=12%2C34%2Cnot&limit=5&offset=2&orderBy=name&fields=title%2CheroImage&${executionType}=1`,
+            `elementType=${elementType}&id=12%2C34%2Cnot&limit=5&offset=2&orderBy=name&fields=title%2CheroImage&search=q&${executionType}=1`,
           );
         });
       });