@ptc-org/nestjs-query-core 0.30.1 → 1.0.0-alpha.1

package/src/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export { mergeQuery, QueryFieldMap, transformQuery, transformSort, applySort, applyPaging, applyQuery, invertSort, } from './query.helpers';
+export { transformAggregateQuery, transformAggregateResponse } from './aggregate.helpers';
+export * from './filter.helpers';

package/src/helpers/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformAggregateResponse = exports.transformAggregateQuery = exports.invertSort = exports.applyQuery = exports.applyPaging = exports.applySort = exports.transformSort = exports.transformQuery = exports.mergeQuery = void 0;
+const tslib_1 = require("tslib");
+var query_helpers_1 = require("./query.helpers");
+Object.defineProperty(exports, "mergeQuery", { enumerable: true, get: function () { return query_helpers_1.mergeQuery; } });
+Object.defineProperty(exports, "transformQuery", { enumerable: true, get: function () { return query_helpers_1.transformQuery; } });
+Object.defineProperty(exports, "transformSort", { enumerable: true, get: function () { return query_helpers_1.transformSort; } });
+Object.defineProperty(exports, "applySort", { enumerable: true, get: function () { return query_helpers_1.applySort; } });
+Object.defineProperty(exports, "applyPaging", { enumerable: true, get: function () { return query_helpers_1.applyPaging; } });
+Object.defineProperty(exports, "applyQuery", { enumerable: true, get: function () { return query_helpers_1.applyQuery; } });
+Object.defineProperty(exports, "invertSort", { enumerable: true, get: function () { return query_helpers_1.invertSort; } });
+var aggregate_helpers_1 = require("./aggregate.helpers");
+Object.defineProperty(exports, "transformAggregateQuery", { enumerable: true, get: function () { return aggregate_helpers_1.transformAggregateQuery; } });
+Object.defineProperty(exports, "transformAggregateResponse", { enumerable: true, get: function () { return aggregate_helpers_1.transformAggregateResponse; } });
+(0, tslib_1.__exportStar)(require("./filter.helpers"), exports);
+//# sourceMappingURL=index.js.map

package/src/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/helpers/index.ts"],"names":[],"mappings":";;;;AAAA,iDASyB;AARvB,2GAAA,UAAU,OAAA;AAEV,+GAAA,cAAc,OAAA;AACd,8GAAA,aAAa,OAAA;AACb,0GAAA,SAAS,OAAA;AACT,4GAAA,WAAW,OAAA;AACX,2GAAA,UAAU,OAAA;AACV,2GAAA,UAAU,OAAA;AAEZ,yDAA0F;AAAjF,4HAAA,uBAAuB,OAAA;AAAE,+HAAA,0BAA0B,OAAA;AAC5D,gEAAiC"}

package/src/helpers/page.builder.d.ts

@@ -0,0 +1,6 @@
+import { Paging } from '../interfaces';
+declare type Pager<DTO> = (dtos: DTO[]) => DTO[];
+export declare class PageBuilder {
+    static build<DTO>(paging: Paging): Pager<DTO>;
+}
+export {};

package/src/helpers/page.builder.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageBuilder = void 0;
+class PageBuilder {
+    static build(paging) {
+        return (dtos) => {
+            const { limit = dtos.length, offset = 0 } = paging;
+            return dtos.slice(offset, limit + offset);
+        };
+    }
+}
+exports.PageBuilder = PageBuilder;
+//# sourceMappingURL=page.builder.js.map

package/src/helpers/page.builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.builder.js","sourceRoot":"","sources":["../../../../../packages/core/src/helpers/page.builder.ts"],"names":[],"mappings":";;;AAGA,MAAa,WAAW;IACtB,MAAM,CAAC,KAAK,CAAM,MAAc;QAC9B,OAAO,CAAC,IAAW,EAAS,EAAE;YAC5B,MAAM,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC;YACnD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;QAC5C,CAAC,CAAC;IACJ,CAAC;CACF;AAPD,kCAOC"}

package/src/helpers/query.helpers.d.ts

@@ -0,0 +1,11 @@
+import { Paging, Query, SortField } from '../interfaces';
+export declare type QueryFieldMap<From, To, T extends keyof To = keyof To> = {
+    [F in keyof From]?: T;
+};
+export declare const transformSort: <From, To>(sorting: SortField<From>[], fieldMap: QueryFieldMap<From, To, keyof To>) => SortField<To>[];
+export declare const transformQuery: <From, To>(query: Query<From>, fieldMap: QueryFieldMap<From, To, keyof To>) => Query<To>;
+export declare const mergeQuery: <T>(base: Query<T>, source: Query<T>) => Query<T>;
+export declare const applySort: <DTO>(dtos: DTO[], sortFields: SortField<DTO>[]) => DTO[];
+export declare const applyPaging: <DTO>(dtos: DTO[], paging: Paging) => DTO[];
+export declare const applyQuery: <DTO>(dtos: DTO[], query: Query<DTO>) => DTO[];
+export declare function invertSort<DTO>(sortFields: SortField<DTO>[]): SortField<DTO>[];

package/src/helpers/query.helpers.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invertSort = exports.applyQuery = exports.applyPaging = exports.applySort = exports.mergeQuery = exports.transformQuery = exports.transformSort = void 0;
+const tslib_1 = require("tslib");
+const lodash_merge_1 = (0, tslib_1.__importDefault)(require("lodash.merge"));
+const interfaces_1 = require("../interfaces");
+const sort_builder_1 = require("./sort.builder");
+const page_builder_1 = require("./page.builder");
+const filter_helpers_1 = require("./filter.helpers");
+const transformSort = (sorting, fieldMap) => {
+    if (!sorting) {
+        return undefined;
+    }
+    return sorting.map((sf) => {
+        const field = fieldMap[sf.field];
+        if (!field) {
+            throw new Error(`No corresponding field found for '${sf.field}' when transforming SortField`);
+        }
+        return { ...sf, field };
+    });
+};
+exports.transformSort = transformSort;
+const transformQuery = (query, fieldMap) => ({
+    filter: (0, filter_helpers_1.transformFilter)(query.filter, fieldMap),
+    paging: query.paging,
+    sorting: (0, exports.transformSort)(query.sorting, fieldMap),
+});
+exports.transformQuery = transformQuery;
+const mergeQuery = (base, source) => {
+    const { filter: baseFilter = {}, ...restBase } = base;
+    const { filter: sourceFilter = {}, ...restSource } = source;
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    return (0, lodash_merge_1.default)(restBase, restSource, { filter: (0, filter_helpers_1.mergeFilter)(baseFilter, sourceFilter) });
+};
+exports.mergeQuery = mergeQuery;
+const applySort = (dtos, sortFields) => sort_builder_1.SortBuilder.build(sortFields)(dtos);
+exports.applySort = applySort;
+const applyPaging = (dtos, paging) => page_builder_1.PageBuilder.build(paging)(dtos);
+exports.applyPaging = applyPaging;
+const applyQuery = (dtos, query) => {
+    const filtered = (0, filter_helpers_1.applyFilter)(dtos, query.filter ?? {});
+    const sorted = (0, exports.applySort)(filtered, query.sorting ?? []);
+    return (0, exports.applyPaging)(sorted, query.paging ?? {});
+};
+exports.applyQuery = applyQuery;
+function invertSort(sortFields) {
+    return sortFields.map((sf) => {
+        const direction = sf.direction === interfaces_1.SortDirection.ASC ? interfaces_1.SortDirection.DESC : interfaces_1.SortDirection.ASC;
+        let nulls;
+        if (sf.nulls === interfaces_1.SortNulls.NULLS_LAST) {
+            nulls = interfaces_1.SortNulls.NULLS_FIRST;
+        }
+        else if (sf.nulls === interfaces_1.SortNulls.NULLS_FIRST) {
+            nulls = interfaces_1.SortNulls.NULLS_LAST;
+        }
+        return { ...sf, direction, nulls };
+    });
+}
+exports.invertSort = invertSort;
+//# sourceMappingURL=query.helpers.js.map

package/src/helpers/query.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.helpers.js","sourceRoot":"","sources":["../../../../../packages/core/src/helpers/query.helpers.ts"],"names":[],"mappings":";;;;AAAA,6EAAiC;AACjC,8CAAmF;AACnF,iDAA6C;AAC7C,iDAA6C;AAC7C,qDAA6E;AAMtE,MAAM,aAAa,GAAG,CAC3B,OAAsC,EACtC,QAAiC,EACJ,EAAE;IAC/B,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QACxB,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,qCAAqC,EAAE,CAAC,KAAe,+BAA+B,CAAC,CAAC;SACzG;QACD,OAAO,EAAE,GAAG,EAAE,EAAE,KAAK,EAAmB,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAdW,QAAA,aAAa,iBAcxB;AAEK,MAAM,cAAc,GAAG,CAAW,KAAkB,EAAE,QAAiC,EAAa,EAAE,CAAC,CAAC;IAC7G,MAAM,EAAE,IAAA,gCAAe,EAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC/C,MAAM,EAAE,KAAK,CAAC,MAAM;IACpB,OAAO,EAAE,IAAA,qBAAa,EAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC;CAChD,CAAC,CAAC;AAJU,QAAA,cAAc,kBAIxB;AAEI,MAAM,UAAU,GAAG,CAAI,IAAc,EAAE,MAAgB,EAAY,EAAE;IAC1E,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;IACtD,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;IAE5D,6DAA6D;IAC7D,OAAO,IAAA,sBAAK,EAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,IAAA,4BAAW,EAAC,UAAU,EAAE,YAAY,CAAC,EAAE,CAAa,CAAC;AACpG,CAAC,CAAC;AANW,QAAA,UAAU,cAMrB;AAEK,MAAM,SAAS,GAAG,CAAM,IAAW,EAAE,UAA4B,EAAS,EAAE,CAAC,0BAAW,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC;AAA3G,QAAA,SAAS,aAAkG;AAEjH,MAAM,WAAW,GAAG,CAAM,IAAW,EAAE,MAAc,EAAS,EAAE,CAAC,0BAAW,CAAC,KAAK,CAAM,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;AAAhG,QAAA,WAAW,eAAqF;AAEtG,MAAM,UAAU,GAAG,CAAM,IAAW,EAAE,KAAiB,EAAS,EAAE;IACvE,MAAM,QAAQ,GAAG,IAAA,4BAAW,EAAC,IAAI,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,IAAA,iBAAS,EAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IACxD,OAAO,IAAA,mBAAW,EAAC,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;AACjD,CAAC,CAAC;AAJW,QAAA,UAAU,cAIrB;AAEF,SAAgB,UAAU,CAAM,UAA4B;IAC1D,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QAC3B,MAAM,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,0BAAa,CAAC,GAAG,CAAC,CAAC,CAAC,0BAAa,CAAC,IAAI,CAAC,CAAC,CAAC,0BAAa,CAAC,GAAG,CAAC;QAC9F,IAAI,KAAK,CAAC;QACV,IAAI,EAAE,CAAC,KAAK,KAAK,sBAAS,CAAC,UAAU,EAAE;YACrC,KAAK,GAAG,sBAAS,CAAC,WAAW,CAAC;SAC/B;aAAM,IAAI,EAAE,CAAC,KAAK,KAAK,sBAAS,CAAC,WAAW,EAAE;YAC7C,KAAK,GAAG,sBAAS,CAAC,UAAU,CAAC;SAC9B;QACD,OAAO,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC;AAXD,gCAWC"}

package/src/helpers/sort.builder.d.ts

@@ -0,0 +1,11 @@
+import { SortDirection, SortField, SortNulls } from '../interfaces';
+declare type SortResult = -1 | 0 | 1;
+declare type SortComparator<Field> = (a: Field, b: Field) => SortResult;
+declare type Sorter<DTO> = (dtos: DTO[]) => DTO[];
+export declare class SortBuilder {
+    static build<DTO>(sorts: SortField<DTO>[]): Sorter<DTO>;
+    static buildComparator<DTO>(field: keyof DTO, direction: SortDirection, nulls?: SortNulls): SortComparator<DTO>;
+    static fieldValueComparator<DTO, Field extends keyof DTO>(field: keyof DTO, direction: SortDirection): SortComparator<DTO[Field]>;
+    static nullsComparator<Field>(direction: SortDirection, nulls?: SortNulls): SortComparator<Field>;
+}
+export {};

package/src/helpers/sort.builder.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortBuilder = void 0;
+const interfaces_1 = require("../interfaces");
+function isNullish(a) {
+    return a === null || a === undefined;
+}
+function nullComparator(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    return a === null ? 1 : -1;
+}
+function nullsFirstSort(a, b) {
+    if (!(isNullish(a) || isNullish(b))) {
+        return 0;
+    }
+    if (isNullish(a) && isNullish(b)) {
+        return nullComparator(a, b);
+    }
+    return isNullish(a) ? -1 : 1;
+}
+function nullsLastSort(a, b) {
+    return (nullsFirstSort(a, b) * -1);
+}
+function ascSort(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    return a < b ? -1 : 1;
+}
+function descSort(a, b) {
+    return (ascSort(a, b) * -1);
+}
+class SortBuilder {
+    static build(sorts) {
+        const comparators = sorts.map(({ field, direction, nulls }) => this.buildComparator(field, direction, nulls));
+        const comparator = (a, b) => comparators.reduce((result, cmp) => {
+            if (result === 0) {
+                return cmp(a, b);
+            }
+            return result;
+        }, 0);
+        return (dtos) => [...dtos].sort(comparator);
+    }
+    static buildComparator(field, direction, nulls) {
+        const nullSort = this.nullsComparator(direction, nulls);
+        const fieldValueComparator = this.fieldValueComparator(field, direction);
+        return (a, b) => {
+            const aField = a[field];
+            const bField = b[field];
+            const nullResult = nullSort(aField, bField);
+            if (nullResult !== 0) {
+                return nullResult;
+            }
+            return fieldValueComparator(aField, bField);
+        };
+    }
+    static fieldValueComparator(field, direction) {
+        if (direction === interfaces_1.SortDirection.ASC) {
+            return (a, b) => ascSort(a, b);
+        }
+        return (a, b) => descSort(a, b);
+    }
+    static nullsComparator(direction, nulls) {
+        switch (nulls) {
+            case interfaces_1.SortNulls.NULLS_FIRST:
+                return nullsFirstSort;
+            case interfaces_1.SortNulls.NULLS_LAST:
+                return nullsLastSort;
+            default:
+                switch (direction) {
+                    case interfaces_1.SortDirection.DESC:
+                        return nullsFirstSort;
+                    default:
+                        return nullsLastSort;
+                }
+        }
+    }
+}
+exports.SortBuilder = SortBuilder;
+//# sourceMappingURL=sort.builder.js.map

package/src/helpers/sort.builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort.builder.js","sourceRoot":"","sources":["../../../../../packages/core/src/helpers/sort.builder.ts"],"names":[],"mappings":";;;AAAA,8CAAoE;AAMpE,SAAS,SAAS,CAAC,CAAU;IAC3B,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC;AACvC,CAAC;AAED,SAAS,cAAc,CAAC,CAAmB,EAAE,CAAmB;IAC9D,IAAI,CAAC,KAAK,CAAC,EAAE;QACX,OAAO,CAAC,CAAC;KACV;IACD,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,CAAU,EAAE,CAAU;IAC5C,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE;QACnC,OAAO,CAAC,CAAC;KACV;IACD,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE;QAChC,OAAO,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAC7B;IACD,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC;AACD,SAAS,aAAa,CAAC,CAAU,EAAE,CAAU;IAC3C,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAe,CAAC;AACnD,CAAC;AAED,SAAS,OAAO,CAAQ,CAAQ,EAAE,CAAQ;IACxC,IAAI,CAAC,KAAK,CAAC,EAAE;QACX,OAAO,CAAC,CAAC;KACV;IACD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACxB,CAAC;AAED,SAAS,QAAQ,CAAQ,CAAQ,EAAE,CAAQ;IACzC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAe,CAAC;AAC5C,CAAC;AAED,MAAa,WAAW;IACtB,MAAM,CAAC,KAAK,CAAM,KAAuB;QACvC,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9G,MAAM,UAAU,GAAwB,CAAC,CAAC,EAAE,CAAC,EAAc,EAAE,CAC3D,WAAW,CAAC,MAAM,CAAC,CAAC,MAAkB,EAAE,GAAG,EAAE,EAAE;YAC7C,IAAI,MAAM,KAAK,CAAC,EAAE;gBAChB,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAClB;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,CAAC,CAAC,CAAC;QACR,OAAO,CAAC,IAAW,EAAS,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CAAC,eAAe,CAAM,KAAgB,EAAE,SAAwB,EAAE,KAAiB;QACvF,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACxD,MAAM,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACzE,OAAO,CAAC,CAAC,EAAE,CAAC,EAAc,EAAE;YAC1B,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YACxB,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YACxB,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC5C,IAAI,UAAU,KAAK,CAAC,EAAE;gBACpB,OAAO,UAAU,CAAC;aACnB;YACD,OAAO,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC9C,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,oBAAoB,CACzB,KAAgB,EAChB,SAAwB;QAExB,IAAI,SAAS,KAAK,0BAAa,CAAC,GAAG,EAAE;YACnC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAChC;QACD,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,eAAe,CAAQ,SAAwB,EAAE,KAAiB;QACvE,QAAQ,KAAK,EAAE;YACb,KAAK,sBAAS,CAAC,WAAW;gBACxB,OAAO,cAAc,CAAC;YACxB,KAAK,sBAAS,CAAC,UAAU;gBACvB,OAAO,aAAa,CAAC;YACvB;gBACE,QAAQ,SAAS,EAAE;oBACjB,KAAK,0BAAa,CAAC,IAAI;wBACrB,OAAO,cAAc,CAAC;oBACxB;wBACE,OAAO,aAAa,CAAC;iBACxB;SACJ;IACH,CAAC;CACF;AApDD,kCAoDC"}

package/src/helpers/types.d.ts

@@ -0,0 +1,3 @@
+import { CommonFieldComparisonBetweenType } from '../interfaces';
+export declare type FilterFn<DTO> = (dto?: DTO) => boolean;
+export declare type ComparisonField<DTO, F extends keyof DTO> = DTO[F] | DTO[F][] | CommonFieldComparisonBetweenType<DTO[F]> | true | false | null;

package/src/helpers/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/src/helpers/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/core/src/helpers/types.ts"],"names":[],"mappings":""}

package/src/index.d.ts

@@ -0,0 +1,7 @@
+export * from './interfaces';
+export * from './common';
+export { InjectAssemblerQueryService, InjectQueryService, getQueryServiceToken } from './decorators';
+export { QueryService, AssemblerQueryService, RelationQueryService, NoOpQueryService, QueryServiceRelation, ProxyQueryService, } from './services';
+export { transformFilter, transformQuery, transformSort, applyFilter, getFilterFields, QueryFieldMap, transformAggregateQuery, transformAggregateResponse, applySort, applyPaging, applyQuery, mergeQuery, mergeFilter, invertSort, getFilterComparisons, getFilterOmitting, } from './helpers';
+export { ClassTransformerAssembler, DefaultAssembler, AbstractAssembler, Assembler, AssemblerSerializer, AssemblerDeserializer, AssemblerFactory, } from './assemblers';
+export { NestjsQueryCoreModule, NestjsQueryCoreModuleOpts } from './module';

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":";;;;AAAA,kCAAkC;AAClC,4DAA6B;AAC7B,wDAAyB;AACzB,2CAAqG;AAA5F,yHAAA,2BAA2B,OAAA;AAAE,gHAAA,kBAAkB,OAAA;AAAE,kHAAA,oBAAoB,OAAA;AAC9E,uCAOoB;AANlB,wGAAA,YAAY,OAAA;AACZ,iHAAA,qBAAqB,OAAA;AACrB,gHAAA,oBAAoB,OAAA;AACpB,4GAAA,gBAAgB,OAAA;AAEhB,6GAAA,iBAAiB,OAAA;AAEnB,qCAiBmB;AAhBjB,0GAAA,eAAe,OAAA;AACf,yGAAA,cAAc,OAAA;AACd,wGAAA,aAAa,OAAA;AACb,sGAAA,WAAW,OAAA;AACX,0GAAA,eAAe,OAAA;AAEf,kHAAA,uBAAuB,OAAA;AACvB,qHAAA,0BAA0B,OAAA;AAC1B,oGAAA,SAAS,OAAA;AACT,sGAAA,WAAW,OAAA;AACX,qGAAA,UAAU,OAAA;AACV,qGAAA,UAAU,OAAA;AACV,sGAAA,WAAW,OAAA;AACX,qGAAA,UAAU,OAAA;AACV,+GAAA,oBAAoB,OAAA;AACpB,4GAAA,iBAAiB,OAAA;AAEnB,2CAQsB;AAPpB,uHAAA,yBAAyB,OAAA;AACzB,8GAAA,gBAAgB,OAAA;AAChB,+GAAA,iBAAiB,OAAA;AACjB,uGAAA,SAAS,OAAA;AACT,iHAAA,mBAAmB,OAAA;AACnB,mHAAA,qBAAqB,OAAA;AACrB,8GAAA,gBAAgB,OAAA;AAElB,mCAA4E;AAAnE,+GAAA,qBAAqB,OAAA"}

package/src/interfaces/aggregate-query.interface.d.ts

@@ -0,0 +1,8 @@
+export declare type AggregateQuery<DTO> = {
+    count?: (keyof DTO)[];
+    sum?: (keyof DTO)[];
+    avg?: (keyof DTO)[];
+    max?: (keyof DTO)[];
+    min?: (keyof DTO)[];
+    groupBy?: (keyof DTO)[];
+};

package/src/interfaces/aggregate-query.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=aggregate-query.interface.js.map

package/src/interfaces/aggregate-query.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate-query.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/aggregate-query.interface.ts"],"names":[],"mappings":""}

package/src/interfaces/aggregate-response.interface.d.ts

@@ -0,0 +1,14 @@
+export declare type NumberAggregate<DTO> = {
+    [K in keyof DTO]?: number;
+};
+export declare type TypeAggregate<DTO> = {
+    [K in keyof DTO]?: DTO[K];
+};
+export declare type AggregateResponse<DTO> = {
+    count?: NumberAggregate<DTO>;
+    sum?: NumberAggregate<DTO>;
+    avg?: NumberAggregate<DTO>;
+    max?: TypeAggregate<DTO>;
+    min?: TypeAggregate<DTO>;
+    groupBy?: Partial<DTO>;
+};

package/src/interfaces/aggregate-response.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=aggregate-response.interface.js.map

package/src/interfaces/aggregate-response.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate-response.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/aggregate-response.interface.ts"],"names":[],"mappings":""}

package/src/interfaces/delete-many-options.interface.d.ts

@@ -0,0 +1,2 @@
+import { DeleteOneOptions } from './delete-one-options.interface';
+export declare type DeleteManyOptions<DTO> = DeleteOneOptions<DTO>;

package/src/interfaces/delete-many-options.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=delete-many-options.interface.js.map

package/src/interfaces/delete-many-options.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-many-options.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/delete-many-options.interface.ts"],"names":[],"mappings":""}

package/src/interfaces/delete-many-response.interface.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The response from a delete many operation.
+ */
+export interface DeleteManyResponse {
+    /**
+     * The number of records deleted.
+     */
+    deletedCount: number;
+}

package/src/interfaces/delete-many-response.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=delete-many-response.interface.js.map

package/src/interfaces/delete-many-response.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-many-response.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/delete-many-response.interface.ts"],"names":[],"mappings":""}

package/src/interfaces/delete-one-options.interface.d.ts

@@ -0,0 +1,7 @@
+import { Filterable } from './filterable.interface';
+export interface DeleteOneOptions<DTO> extends Filterable<DTO> {
+    /**
+     * Use soft delete when doing delete mutation
+     */
+    useSoftDelete?: boolean;
+}

package/src/interfaces/delete-one-options.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=delete-one-options.interface.js.map

package/src/interfaces/delete-one-options.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-one-options.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/delete-one-options.interface.ts"],"names":[],"mappings":""}

package/src/interfaces/filter-field-comparison.interface.d.ts

@@ -0,0 +1,202 @@
+/**
+ * Field comparisons with a type of `boolean`.
+ */
+import { Filter } from './filter.interface';
+export interface BooleanFieldComparisons {
+    /**
+     * Is operator.
+     *
+     * ```ts
+     * // field IS TRUE
+     * { field: { is: true } }
+     *
+     * // field IS FALSE
+     * { field: { is: false } }
+     *
+     * // field IS NULL
+     * { field: { is: null } }
+     * ```
+     */
+    is?: boolean | null;
+    /**
+     * Is not operator.
+     *
+     * ```ts
+     * // field IS NOT TRUE
+     * { field: { isNot: true } }
+     *
+     * // field IS NOT FALSE
+     * { field: { isNot: false } }
+     *
+     * // field IS NOT NULL
+     * { field: { isNot: null } }
+     * ```
+     */
+    isNot?: boolean | null;
+}
+export interface CommonFieldComparisonBetweenType<FieldType> {
+    lower: FieldType;
+    upper: FieldType;
+}
+/**
+ * Field comparisons for all types that are NOT `null` or `boolean`.
+ *
+ * @typeparam FieldType - The TS type of the field.
+ */
+export interface CommonFieldComparisonType<FieldType> extends BooleanFieldComparisons {
+    /**
+     * Field equality.
+     *
+     * ```ts
+     * // field = "bar"
+     * { field: { eq: 'bar' } }
+     * ```
+     */
+    eq?: FieldType;
+    /**
+     * Field in-equality.
+     *
+     * ```ts
+     * // field != "bar"
+     * { field: { neq: 'bar' } }
+     * ```
+     */
+    neq?: FieldType;
+    /**
+     * Greater than comparison.
+     *
+     * ```ts
+     * // field > 1
+     * { field: { gt: 1 } }
+     * ```
+     */
+    gt?: FieldType;
+    /**
+     * Greater than or equal to comparison.
+     *
+     * ```ts
+     * // field >= 1
+     * { field: { gte: 1 } }
+     * ```
+     */
+    gte?: FieldType;
+    /**
+     * Less than comparison.
+     *
+     * ```ts
+     * // field < 1
+     * { field: { lt: 1 } }
+     * ```
+     */
+    lt?: FieldType;
+    /**
+     * Less than or equal to comparison.
+     *
+     * ```ts
+     * // field <= 1
+     * { field: { lte: 1 } }
+     * ```
+     */
+    lte?: FieldType;
+    /**
+     * Check that a field is included in an array of values.
+     *
+     * ```ts
+     * // field IN ("a", "b", "c")
+     * { field: { in: ['a', 'b', 'c'] } }
+     * ```
+     */
+    in?: FieldType[];
+    /**
+     * Check that a field is not included in an array of values.
+     *
+     * ```ts
+     * // field NOT IN ("a", "b", "c")
+     * { field: { notIn: ['a', 'b', 'c'] } }
+     * ```
+     */
+    notIn?: FieldType[];
+    /**
+     * Checks that a field is between a lower and upper bound. The bounds are included!
+     *
+     * ```ts
+     * // field BETWEEN lower AND upper
+     * { field: { between: { lower: 1, upper: 10 } } }
+     * ```
+     */
+    between?: CommonFieldComparisonBetweenType<FieldType>;
+    /**
+     * Checks that a field is not between a lower and upper bound. The bounds are excluded!
+     *
+     * ```ts
+     * // field NOT BETWEEN lower AND upper
+     * { field: { notBetween: { lower: 1, upper: 10 } } }
+     * ```
+     */
+    notBetween?: CommonFieldComparisonBetweenType<FieldType>;
+}
+/**
+ * Field comparisons for `string` types.
+ */
+export interface StringFieldComparisons extends CommonFieldComparisonType<string> {
+    /**
+     * Like comparison.
+     *
+     * ```ts
+     * // field LIKE "Foo%"
+     * { field: { like: 'Foo%' } }
+     * ```
+     */
+    like?: string;
+    /**
+     * Not like comparison.
+     *
+     * ```ts
+     * // field NOT LIKE "Foo%"
+     * { field: { notLike: 'Foo%' } }
+     * ```
+     */
+    notLike?: string;
+    /**
+     * Case insensitive like comparison.
+     *
+     * ```ts
+     * // field ILIKE "Foo%"
+     * { field: { iLike: 'Foo%' } }
+     * ```
+     */
+    iLike?: string;
+    /**
+     * Case insensitive not like comparison.
+     *
+     * ```ts
+     * // field NOT ILIKE "Foo%"
+     * { field: { notILike: 'Foo%' } }
+     * ```
+     */
+    notILike?: string;
+}
+declare type BuiltInTypes = boolean | boolean | string | string | number | Date | RegExp | bigint | symbol | null | undefined | never;
+/**
+ * Type for field comparisons.
+ *
+ * * `string` - [[StringFieldComparisons]]
+ * * `boolean|null|undefined|never` - [[BooleanFieldComparisons]]
+ * * all other types use [[CommonFieldComparisonType]]
+ */
+declare type FilterFieldComparisonType<FieldType, IsKeys extends true | false> = FieldType extends string | String ? StringFieldComparisons : FieldType extends boolean | Boolean ? BooleanFieldComparisons : FieldType extends number | Date | RegExp | bigint | BuiltInTypes[] | symbol ? CommonFieldComparisonType<FieldType> : FieldType extends Array<infer U> ? CommonFieldComparisonType<U> | Filter<U> : IsKeys extends true ? CommonFieldComparisonType<FieldType> & StringFieldComparisons & Filter<FieldType> : CommonFieldComparisonType<FieldType> | Filter<FieldType>;
+/**
+ * Type for field comparisons.
+ *
+ * * `string` - [[StringFieldComparisons]]
+ * * `boolean|null|undefined|never` - [[BooleanFieldComparisons]]
+ * * all other types use [[CommonFieldComparisonType]]
+ */
+export declare type FilterFieldComparison<FieldType> = FilterFieldComparisonType<FieldType, false>;
+/**
+ * Type for all comparison operators for a field type.
+ *
+ * @typeparam FieldType - The TS type of the field.
+ */
+export declare type FilterComparisonOperators<FieldType> = keyof FilterFieldComparisonType<FieldType, true>;
+export {};

package/src/interfaces/filter-field-comparison.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=filter-field-comparison.interface.js.map

package/src/interfaces/filter-field-comparison.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-field-comparison.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/filter-field-comparison.interface.ts"],"names":[],"mappings":""}