Merge pull request #165 from contentstack/feat/cs-43905-less-than

Feat/cs 43905 compare query operators

Author: harshithad0703

src/lib/query.ts

@@ -371,4 +371,76 @@ export class Query extends BaseQuery {
     this._queryParams['typeahead'] = key
     return this
   }
+
+  /**
+   * @method lessThan
+   * @memberof Query
+   * @description Returns the raw (JSON) query based on the filters applied on Query object.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const query = stack.contentType('contenttype_uid').query().where('title', QueryOperation.EQUALS, 'value');
+   * const entryQuery = await stack.contentType('contenttype_uid').query().lessThan('fieldUid', 'value').find();
+   *  
+   * @returns {Query}
+   */
+  lessThan(key: string, value: (string | number)): Query {
+    this._parameters[key] = { '$lt': value };
+    return this;
+  }
+
+  /**
+   * @method lessThanOrEqualTo
+   * @memberof Query
+   * @description Returns the raw (JSON) query based on the filters applied on Query object.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const query = stack.contentType('contenttype_uid').query().where('title', QueryOperation.EQUALS, 'value');
+   * const entryQuery = await stack.contentType('contenttype_uid').query().lessThanOrEqualTo('fieldUid', 'value').find();
+   *  
+   * @returns {Query}
+   */
+  lessThanOrEqualTo(key: string, value: (string | number)): Query {
+    this._parameters[key] = { '$lte': value };
+    return this;
+  }
+
+  /**
+   * @method greaterThan
+   * @memberof Query
+   * @description Returns the raw (JSON) query based on the filters applied on Query object.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const query = stack.contentType('contenttype_uid').query().where('title', QueryOperation.EQUALS, 'value');
+   * const entryQuery = await stack.contentType('contenttype_uid').query().greaterThan('fieldUid', 'value').find();
+   *  
+   * @returns {Query}
+   */
+  greaterThan(key: string, value: (string | number)): Query {
+    this._parameters[key] = { '$gt': value };
+    return this;
+  }
+
+  /**
+   * @method greaterThanOrEqualTo
+   * @memberof Query
+   * @description Returns the raw (JSON) query based on the filters applied on Query object.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const query = stack.contentType('contenttype_uid').query().where('title', QueryOperation.EQUALS, 'value');
+   * const entryQuery = await stack.contentType('contenttype_uid').query().greaterThanOrEqualTo('fieldUid', 'value').find();
+   *  
+   * @returns {Query}
+   */
+  greaterThanOrEqualTo(key: string, value: (string | number)): Query {
+    this._parameters[key] = { '$gte': value };
+    return this;
+  }
 }

test/api/entry-queryables.spec.ts

@@ -187,6 +187,50 @@ describe('Query Operators API test cases', () => {
         expect(query.entries[2].title).toBe('test2');
       }
     });
+
+    it('should get entries which is lessThan the fieldUid and values', async () => {
+      const query = await makeEntries('contenttype_uid').query().lessThan('created_at', '2024-03-01T05:25:30.940Z').find<TEntry>()
+      if (query.entries) {
+        expect(query.entries.length).toBeGreaterThan(0);
+        expect(query.entries[0]._version).toBeDefined();
+        expect(query.entries[0].title).toBeDefined();
+        expect(query.entries[0].uid).toBeDefined();
+        expect(query.entries[0].created_at).toBeDefined();
+      }
+    });
+
+    it('should get entries which is lessThanOrEqualTo the fieldUid and values', async () => {
+      const query = await makeEntries('contenttype_uid').query().lessThanOrEqualTo('created_at', '2024-03-01T05:25:30.940Z').find<TEntry>()
+      if (query.entries) {
+        expect(query.entries.length).toBeGreaterThan(0);
+        expect(query.entries[0]._version).toBeDefined();
+        expect(query.entries[0].title).toBeDefined();
+        expect(query.entries[0].uid).toBeDefined();
+        expect(query.entries[0].created_at).toBeDefined();
+      }
+    });
+
+    it('should get entries which is greaterThan the fieldUid and values', async () => {
+      const query = await makeEntries('contenttype_uid').query().greaterThan('created_at', '2024-03-01T05:25:30.940Z').find<TEntry>()
+      if (query.entries) {
+        expect(query.entries.length).toBeGreaterThan(0);
+        expect(query.entries[0]._version).toBeDefined();
+        expect(query.entries[0].title).toBeDefined();
+        expect(query.entries[0].uid).toBeDefined();
+        expect(query.entries[0].created_at).toBeDefined();
+      }
+    });
+
+    it('should get entries which is greaterThanOrEqualTo the fieldUid and values', async () => {
+      const query = await makeEntries('contenttype_uid').query().greaterThanOrEqualTo('created_at', '2024-03-01T05:25:30.940Z').find<TEntry>()
+      if (query.entries) {
+        expect(query.entries.length).toBeGreaterThan(0);
+        expect(query.entries[0]._version).toBeDefined();
+        expect(query.entries[0].title).toBeDefined();
+        expect(query.entries[0].uid).toBeDefined();
+        expect(query.entries[0].created_at).toBeDefined();
+      }
+    });
 });
 
 function makeEntries(contentTypeUid = ''): Entries {

test/unit/entry-queryable.spec.ts

@@ -91,4 +91,20 @@ describe('Query Operators API test cases', () => {
         expect(query._queryParams).toEqual({ desc: 'fieldUid' });
       }
     });
+    it('should get entries which is lessThan the fieldUid and values', async () => {
+      const query = contentType.Entry().query().lessThan('fieldUID', 'value');
+      expect(query._parameters).toStrictEqual({'fieldUID': {'$lt': 'value'}});
+    });
+    it('should get entries which is lessThanOrEqualTo the fieldUid and values', async () => {
+      const query = contentType.Entry().query().lessThanOrEqualTo('fieldUID', 'value');
+      expect(query._parameters).toStrictEqual({'fieldUID': {'$lte': 'value'}});
+    });
+    it('should get entries which is greaterThan the fieldUid and values', async () => {
+      const query = contentType.Entry().query().greaterThan('fieldUID', 'value');
+      expect(query._parameters).toStrictEqual({'fieldUID': {'$gt': 'value'}});
+    });
+    it('should get entries which is greaterThanOrEqualTo the fieldUid and values', async () => {
+      const query = contentType.Entry().query().greaterThanOrEqualTo('fieldUID', 'value');
+      expect(query._parameters).toStrictEqual({'fieldUID': {'$gte': 'value'}});
+    });
 });