Skip to content

Feat/cs 43902 exist query #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harshithad0703 merged 2 commits into from
Mar 19, 2024
Merged

Feat/cs 43902 exist query #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27ef180
feat: exist query operator implementation
harshithad0703 Mar 19, 2024
17b4e2e
test: unit and api test cases
harshithad0703 Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions src/lib/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,24 @@ export class Query extends BaseQuery {
return this;
}

/**
* @method exists
* @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("contentTypeUid").entry().query();
* const result = await query.exists('fieldUid').find()
*
* @returns {Query}
*/
exists(key: string): Query {
this._parameters[key] = { '$exists': true };
return this;
}

/**
* @method notExists
* @memberof Query
Expand Down Expand Up @@ -291,7 +309,7 @@ export class Query extends BaseQuery {
*
* 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().referenceIn('reference_uid', query).find<TEntry>();
* const entryQuery = await stack.contentType('contenttype_uid').query().referenceIn('reference_uid', query).find();
*
* @returns {Query}
*/
Expand All @@ -309,7 +327,7 @@ export class Query extends BaseQuery {
*
* 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().referenceNotIn('reference_uid', query).find<TEntry>();
* const entryQuery = await stack.contentType('contenttype_uid').query().referenceNotIn('reference_uid', query).find();
*
* @returns {Query}
*/
Expand All @@ -327,14 +345,28 @@ export class Query extends BaseQuery {
*
* 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().tags(['tag1']).find<TEntry>();
* const entryQuery = await stack.contentType('contenttype_uid').query().tags(['tag1']).find();
*
* @returns {Query}
*/
tags(values: (string | number | boolean)[]): Query {
this._parameters['tags'] = values;
return this;
}

/**
* @method search
* @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().search('key').find();
*
* @returns {Query}
*/
search(key: string): Query {
this._queryParams['typeahead'] = key
return this
Expand Down
37 changes: 36 additions & 1 deletion test/api/entry-queryables.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ describe('Query Operators API test cases', () => {
});

it('should get entries which does not match the fieldUid - notExists', async () => {
const query = await makeEntries('contenttype_uid').query().notExists('multi_line').find<TEntry>()
const query = await makeEntries('contenttype_uid2').query().notExists('multi_line').find<TEntry>()
if (query.entries) {
expect(query.entries[0]._version).toBeDefined();
expect(query.entries[0].title).toBeDefined();
Expand All @@ -38,6 +38,17 @@ describe('Query Operators API test cases', () => {
}
});

it('should get entries which matches the fieldUid - exists', async () => {
const query = await makeEntries('contenttype_uid').query().exists('multi_line').find<TEntry>()
if (query.entries) {
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();
expect((query.entries[0] as any).multi_line).toBeDefined()
}
});

it('should return entries matching any of the conditions - or', async () => {
const query1: Query = await makeEntries('contenttype_uid').query().containedIn('title', ['value']);
const query2: Query = await makeEntries('contenttype_uid').query().where('title', QueryOperation.EQUALS, 'value2');
Expand Down Expand Up @@ -152,6 +163,30 @@ describe('Query Operators API test cases', () => {
expect(query.entries[0].title).toBe('value2');
}
});

it('should sort entries in ascending order of the given fieldUID', async () => {
const query = await makeEntries('contenttype_uid').query().orderByAscending('title').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('test');
expect(query.entries[1].title).toBe('test2');
expect(query.entries[2].title).toBe('value');
}
});

it('should sort entries in descending order of the given fieldUID', async () => {
const query = await makeEntries('contenttype_uid').query().orderByDescending('title').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');
expect(query.entries[1].title).toBe('value');
expect(query.entries[2].title).toBe('test2');
}
});
});

function makeEntries(contentTypeUid = ''): Entries {
Expand Down
18 changes: 18 additions & 0 deletions test/unit/entry-queryable.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ describe('Query Operators API test cases', () => {
const query = contentType.Entry().query().notExists('fieldUID');
expect(query._parameters).toStrictEqual({'fieldUID': {'$exists': false}});
});
it('should get entries which matches the fieldUid - exists', async () => {
const query = contentType.Entry().query().exists('fieldUID');
if (query) {
expect(query._parameters).toEqual({'fieldUID': {'$exists': true}});
}
});
it('should return entries matching any of the conditions - or', async () => {
const query1: Query = await contentType.Entry().query().containedIn('fieldUID', ['value']);
const query2: Query = await contentType.Entry().query().where('fieldUID', QueryOperation.EQUALS, 'value2');
Expand Down Expand Up @@ -73,4 +79,16 @@ describe('Query Operators API test cases', () => {
expect(query._queryParams).toEqual({ typeahead: 'entry' });
}
});
it('should sort entries in ascending order of the given fieldUID', async () => {
const query = contentType.Entry().query().orderByAscending('fieldUid');
if (query) {
expect(query._queryParams).toEqual({ asc: 'fieldUid' });
}
});
it('should sort entries in descending order of the given fieldUID', async () => {
const query = contentType.Entry().query().orderByDescending('fieldUid');
if (query) {
expect(query._queryParams).toEqual({ desc: 'fieldUid' });
}
});
});