Merge pull request #161 from contentstack/feat/cs-43921-search-query-operator

Feat/cs 43921 search query operator

Author: harshithad0703

package-lock.json

@@ -24,7 +24,7 @@
   },
   "dependencies": {
     "@contentstack/core": "^1.0.1",
-    "@contentstack/utils": "^1.3.1",
+    "@contentstack/utils": "^1.3.3",
     "@types/humps": "^2.0.6",
     "dotenv": "^16.3.1",
     "humps": "^2.0.1"

package.json

@@ -295,7 +295,7 @@ export class Query extends BaseQuery {
    *  
    * @returns {Query}
    */
-  referenceIn(key: string, query: Query) {
+  referenceIn(key: string, query: Query): Query {
     this._parameters[key] = { '$in_query': query._parameters }
     return this;
   }
@@ -313,7 +313,7 @@ export class Query extends BaseQuery {
    *  
    * @returns {Query}
    */
-  referenceNotIn(key: string, query: Query) {
+  referenceNotIn(key: string, query: Query): Query {
     this._parameters[key] = { '$nin_query': query._parameters }
     return this;
   }
@@ -335,4 +335,8 @@ export class Query extends BaseQuery {
     this._parameters['tags'] = values;
     return this;
   }
+  search(key: string): Query {
+    this._queryParams['typeahead'] = key
+    return this
+  }
 }

src/lib/query.ts

@@ -142,6 +142,16 @@ describe('Query Operators API test cases', () => {
         expect(query.entries[0].title).toBe('value');
       }
     });
+
+    it('should search for the matching key and return the entry', async () => {
+      const query = await makeEntries('contenttype_uid').query().search('value2').find<TEntry>();
+      if (query.entries) {
+        expect(query.entries[0]._version).toBeDefined();
+        expect(query.entries[0].locale).toBeDefined();
+        expect(query.entries[0].uid).toBeDefined();
+        expect(query.entries[0].title).toBe('value2');
+      }
+    });
 });
 
 function makeEntries(contentTypeUid = ''): Entries {

test/api/entry-queryables.spec.ts

@@ -67,4 +67,10 @@ describe('Query Operators API test cases', () => {
         expect(query._parameters).toEqual({ tags: ['tag1'] });
       }
     });
+    it('should search for the matching key and return the entry', async () => {
+      const query =  contentType.Entry().query().search('entry');
+      if (query) {
+        expect(query._queryParams).toEqual({ typeahead: 'entry' });
+      }
+    });
 });