Skip to content

Commit e8fe16a

Browse files
abhinav-from-contentstackabhinav-from-contentstack
committed
fix: separated taxonomy query operators
1 parent aa8195b commit e8fe16a

6 files changed

Lines changed: 27 additions & 25 deletions

File tree

‎src/lib/query.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { AxiosInstance } from '@contentstack/core';
22
import { BaseQuery } from './base-query';
3-
import { BaseQueryParameters, QueryOperation, QueryOperator } from './types';
3+
import { BaseQueryParameters, QueryOperation, QueryOperator, TaxonomyQueryOperation } from './types';
44
export class Query extends BaseQuery {
55
private _contentTypeUid?: string;
66

@@ -37,7 +37,7 @@ export class Query extends BaseQuery {
3737
*/
3838
where(
3939
fieldUid: string,
40-
queryOperation: QueryOperation,
40+
queryOperation: QueryOperation | TaxonomyQueryOperation,
4141
fields: string | string[] | number | number[] | object | boolean,
4242
additionalData?: object
4343
): Query {

‎src/lib/types.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,10 +129,13 @@ export enum QueryOperation {
129129
IS_GREATER_THAN_OR_EQUAL = '$gte',
130130
EXISTS = '$exists',
131131
MATCHES = '$regex',
132+
}
133+
134+
export enum TaxonomyQueryOperation {
132135
ABOVE = '$above',
133136
BELOW = '$below',
134137
EQ_ABOVE = '$eq_above',
135-
EQ_BELOW = '$eq_below',
138+
EQ_BELOW = '$eq_below'
136139
}
137140

138141
export type BaseQueryParameters = {

‎test/api/entries.spec.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/* eslint-disable no-console */
22
/* eslint-disable promise/always-return */
3-
import { QueryOperation, QueryOperator } from '../../src/lib/types';
3+
import { QueryOperation, QueryOperator, TaxonomyQueryOperation } from '../../src/lib/types';
44
import { Entries } from '../../src/lib/entries';
55
import { stackInstance } from '../utils/stack-instance';
66
import { TEntries } from './types';
@@ -94,25 +94,25 @@ describe('Entries API test cases', () => {
9494
})
9595

9696
it('CT Taxonomies Query: Get Entries With Taxonomy Terms and Also Matching Its Children Term ($eq_below, level)', async () => {
97-
let Query = makeEntries('source').query().where('taxonomies.one', QueryOperation.EQ_BELOW, 'term_one', {"levels": 1});
97+
let Query = makeEntries('source').query().where('taxonomies.one', TaxonomyQueryOperation.EQ_BELOW, 'term_one', {"levels": 1});
9898
const data = await Query.find<TEntries>();
9999
return expect(data.entries.length).toBeGreaterThan(0);
100100
})
101101

102102
it('CT Taxonomies Query: Get Entries With Taxonomy Terms Children\'s and Excluding the term itself ($below, level)', async () => {
103-
let Query = makeEntries('source').query().where('taxonomies.one', QueryOperation.BELOW, 'term_one', {"levels": 1});
103+
let Query = makeEntries('source').query().where('taxonomies.one', TaxonomyQueryOperation.BELOW, 'term_one', {"levels": 1});
104104
const data = await Query.find<TEntries>();
105105
return expect(data.entries.length).toBeGreaterThan(0);
106106
})
107107

108108
it('CT Taxonomies Query: Get Entries With Taxonomy Terms and Also Matching Its Parent Term ($eq_above, level)', async () => {
109-
let Query = makeEntries('source').query().where('taxonomies.one', QueryOperation.EQ_ABOVE, 'term_one', {"levels": 1});
109+
let Query = makeEntries('source').query().where('taxonomies.one', TaxonomyQueryOperation.EQ_ABOVE, 'term_one', {"levels": 1});
110110
const data = await Query.find<TEntries>();
111111
return expect(data.entries.length).toBeGreaterThan(0);
112112
})
113113

114114
it('CT Taxonomies Query: Get Entries With Taxonomy Terms Parent and Excluding the term itself ($above, level)', async () => {
115-
let Query = makeEntries('source').query().where('taxonomies.one', QueryOperation.ABOVE, 'term_one_child', {"levels": 1});
115+
let Query = makeEntries('source').query().where('taxonomies.one', TaxonomyQueryOperation.ABOVE, 'term_one_child', {"levels": 1});
116116
const data = await Query.find<TEntries>();
117117
return expect(data.entries.length).toBeGreaterThan(0);
118118
})

‎test/api/taxonomy-query.spec.ts‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
import { QueryOperation, QueryOperator } from "../../src/lib/types";
2-
import {TaxonomyQuery} from "../../src/lib/taxonomy-query";
1+
import { QueryOperation, QueryOperator, TaxonomyQueryOperation } from "../../src/lib/types";
32
import { stackInstance } from "../utils/stack-instance";
43
import dotenv from "dotenv"
5-
import { TEntries, TEntry } from "./types";
4+
import { TEntries } from "./types";
65

76
dotenv.config();
87
jest.setTimeout(60000);
@@ -45,25 +44,25 @@ describe('Taxonomy API test cases', () => {
4544
})
4645

4746
test('Taxonomies Endpoint: Get Entries With Taxonomy Terms and Also Matching Its Children Term ($eq_below, level)', async () => {
48-
let taxonomy = stack.Taxonomy().where('taxonomies.one', QueryOperation.EQ_BELOW, 'term_one', {"levels": 1})
47+
let taxonomy = stack.Taxonomy().where('taxonomies.one', TaxonomyQueryOperation.EQ_BELOW, 'term_one', {"levels": 1})
4948
const data = await taxonomy.find<TEntries>();
5049
return expect(data.entries.length).toBeGreaterThan(0);
5150
})
5251

5352
test('Taxonomies Endpoint: Get Entries With Taxonomy Terms Children\'s and Excluding the term itself ($below, level)', async () => {
54-
let taxonomy = stack.Taxonomy().where('taxonomies.one', QueryOperation.BELOW, 'term_one', {"levels": 1})
53+
let taxonomy = stack.Taxonomy().where('taxonomies.one', TaxonomyQueryOperation.BELOW, 'term_one', {"levels": 1})
5554
const data = await taxonomy.find<TEntries>();
5655
return expect(data.entries.length).toBeGreaterThan(0);
5756
})
5857

5958
test('Taxonomies Endpoint: Get Entries With Taxonomy Terms and Also Matching Its Parent Term ($eq_above, level)', async () => {
60-
let taxonomy = stack.Taxonomy().where('taxonomies.one', QueryOperation.EQ_ABOVE, 'term_one', {"levels": 1})
59+
let taxonomy = stack.Taxonomy().where('taxonomies.one', TaxonomyQueryOperation.EQ_ABOVE, 'term_one', {"levels": 1})
6160
const data = await taxonomy.find<TEntries>();
6261
return expect(data.entries.length).toBeGreaterThan(0);
6362
})
6463

6564
test('Taxonomies Endpoint: Get Entries With Taxonomy Terms Parent and Excluding the term itself ($above, level)', async () => {
66-
let taxonomy = stack.Taxonomy().where('taxonomies.one', QueryOperation.ABOVE, 'term_one_child', {"levels": 1})
65+
let taxonomy = stack.Taxonomy().where('taxonomies.one', TaxonomyQueryOperation.ABOVE, 'term_one_child', {"levels": 1})
6766
const data = await taxonomy.find<TEntries>();
6867
return expect(data.entries.length).toBeGreaterThan(0);
6968
})

‎test/unit/entries.spec.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { Entries } from '../../src/lib/entries';
44
import MockAdapter from 'axios-mock-adapter';
55
import { entryFetchMock, entryFindMock } from '../utils/mocks';
66
import { Query } from '../../src/lib/query';
7-
import { QueryOperation, QueryOperator } from '../../src/lib/types';
7+
import { QueryOperation, QueryOperator, TaxonomyQueryOperation } from '../../src/lib/types';
88

99
describe('Entries class', () => {
1010
let entry: Entries;
@@ -118,22 +118,22 @@ describe('Entries class', () => {
118118
});
119119

120120
test('CT Taxonomy Query: Get entries with taxonomy terms and also matching its children terms ($eq_below, level)', () => {
121-
const query = entry.query().where("taxonomies.taxonomy_uid", QueryOperation.EQ_BELOW, "term_uid", {"levels": 4});
121+
const query = entry.query().where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.EQ_BELOW, "term_uid", {"levels": 4});
122122
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$eq_below": "term_uid", "levels": 4 }});
123123
});
124124

125125
test('CT Taxonomy Query: Get Entries With Taxonomy Terms Children\'s and Excluding the term itself ($below, level) ', () => {
126-
const query = entry.query().where("taxonomies.taxonomy_uid", QueryOperation.BELOW, "term_uid");
126+
const query = entry.query().where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.BELOW, "term_uid");
127127
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$below": "term_uid" }});
128128
});
129129

130130
test('CT Taxonomy Query: Get Entries With Taxonomy Terms and Also Matching Its Parent Term ($eq_above, level)', () => {
131-
const query = entry.query().where("taxonomies.taxonomy_uid", QueryOperation.EQ_ABOVE, "term_uid", {"levels": 4});
131+
const query = entry.query().where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.EQ_ABOVE, "term_uid", {"levels": 4});
132132
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$eq_above": "term_uid", "levels": 4 }});
133133
});
134134

135135
test('CT Taxonomy Query: Get Entries With Taxonomy Terms Parent and Excluding the term itself ($above, level)', () => {
136-
const query = entry.query().where("taxonomies.taxonomy_uid", QueryOperation.ABOVE, "term_uid", {"levels": 4});
136+
const query = entry.query().where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.ABOVE, "term_uid", {"levels": 4});
137137
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$above": "term_uid", "levels": 4 }});
138138
});
139139
});

‎test/unit/taxonomy-query.spec.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { TaxonomyQuery } from "../../src/lib/taxonomy-query";
22
import { AxiosInstance, HttpClientParams, httpClient } from "@contentstack/core";
33
import MockAdapter from 'axios-mock-adapter';
4-
import { QueryOperation, QueryOperator } from "../../src/lib/types";
4+
import { QueryOperation, QueryOperator, TaxonomyQueryOperation } from "../../src/lib/types";
55

66
describe("Taxonomy-query class", () => {
77
let taxonomyQuery: TaxonomyQuery;
@@ -50,22 +50,22 @@ describe("Taxonomy-query class", () => {
5050
});
5151

5252
it('Taxonomy Query: Get entries with taxonomy terms and also matching its children terms ($eq_below, level)', () => {
53-
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", QueryOperation.EQ_BELOW, "term_uid", {"levels": 4});
53+
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.EQ_BELOW, "term_uid", {"levels": 4});
5454
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$eq_below": "term_uid", "levels": 4 }});
5555
});
5656

5757
test('Taxonomy Query: Get Entries With Taxonomy Terms Children\'s and Excluding the term itself ($below, level) ', () => {
58-
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", QueryOperation.BELOW, "term_uid");
58+
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.BELOW, "term_uid");
5959
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$below": "term_uid" }});
6060
});
6161

6262
test('Taxonomy Query: Get Entries With Taxonomy Terms and Also Matching Its Parent Term ($eq_above, level)', () => {
63-
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", QueryOperation.EQ_ABOVE, "term_uid", {"levels": 4});
63+
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.EQ_ABOVE, "term_uid", {"levels": 4});
6464
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$eq_above": "term_uid", "levels": 4 }});
6565
});
6666

6767
test('Taxonomy Query: Get Entries With Taxonomy Terms Parent and Excluding the term itself ($above, level)', () => {
68-
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", QueryOperation.ABOVE, "term_uid", {"levels": 4});
68+
const query = taxonomyQuery.where("taxonomies.taxonomy_uid", TaxonomyQueryOperation.ABOVE, "term_uid", {"levels": 4});
6969
expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$above": "term_uid", "levels": 4 }});
7070
});
7171

0 commit comments

Comments
 (0)