@ptc-org/nestjs-query-core 0.30.1 → 0.30.2

package/src/interfaces/filter.interface.d.ts

@@ -0,0 +1,113 @@
+import { FilterFieldComparison } from './filter-field-comparison.interface';
+/**
+ * A comparison for fields in T.
+ * @example
+ * ```ts
+ * // name LIKE "Foo%"
+ * const filter: Filter<Item> = {
+ *   { name: { like: 'Foo%' } },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // completed IS TRUE
+ * const filter: Filter<Item> = {
+ *   { completed: { is: true } },
+ * }
+ * ```
+ * @typeparam T - the type of object to filter on.
+ */
+export declare type FilterComparisons<T> = {
+    [K in keyof T]?: FilterFieldComparison<T[K]>;
+};
+/**
+ * A grouping of filters that should be ANDed or ORed together.
+ *
+ * * @example
+ * ```ts
+ * // completed IS TRUE OR name = "Foo"
+ * const filter: Filter<Item> = {
+ *   or: [
+ *     { completed: { is: true } },
+ *     { name: { eq: "Foo" } },
+ *   ]
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // completed IS TRUE OR (age > 10 AND age < 20)
+ * const filter: Filter<Item> = {
+ *   or: [
+ *     { completed: { is: true } },
+ *     {
+ *       and: [
+ *         { age: { gt : 10 } },
+ *         { age: { lt : 20 } },
+ *       ]
+ *     },
+ *   ]
+ * }
+ * ```
+ */
+declare type FilterGrouping<T> = {
+    /**
+     * Group an array of filters with an AND operation.
+     */
+    and?: Filter<T>[];
+    /**
+     * Group an array of filters with an OR operation.
+     */
+    or?: Filter<T>[];
+};
+/**
+ * Filter for type T.
+ *
+ * @example
+ * ```ts
+ * // name LIKE "Foo%"
+ * const filter: Filter<Item> = {
+ *   { name: { like: 'Foo%' } },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // completed IS TRUE
+ * const filter: Filter<Item> = {
+ *   { completed: { is: true } },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // completed IS TRUE OR name = "Foo"
+ * const filter: Filter<Item> = {
+ *   or: [
+ *     { completed: { is: true } },
+ *     { name: { eq: "Foo" } },
+ *   ]
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // completed IS TRUE OR (age > 10 AND age < 20)
+ * const filter: Filter<Item> = {
+ *   or: [
+ *     { completed: { is: true } },
+ *     {
+ *       and: [
+ *         { age: { gt : 10 } },
+ *         { age: { lt : 20 } },
+ *       ]
+ *     },
+ *   ]
+ * }
+ * ```
+ *
+ * @typeparam T - the type of object to filter on.
+ */
+export declare type Filter<T> = FilterGrouping<T> & FilterComparisons<T>;
+export {};

package/src/interfaces/filter.interface.js

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

package/src/interfaces/filter.interface.js.map

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

package/src/interfaces/filterable.interface.d.ts

@@ -0,0 +1,13 @@
+import { Filter } from './filter.interface';
+/**
+ * Base interface for all types that allow filtering
+ */
+export interface Filterable<DTO> {
+    /**
+     * Filter to use when operating on a entities.
+     *
+     * When using with a single entity operation (e.g. findById) the filter can be used to apply an additional filter to
+     * ensure that the entity belongs to a particular user.
+     */
+    filter?: Filter<DTO>;
+}

package/src/interfaces/filterable.interface.js

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

package/src/interfaces/filterable.interface.js.map

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

package/src/interfaces/find-by-id-options.interface.d.ts

@@ -0,0 +1,7 @@
+import { Filterable } from './filterable.interface';
+export interface FindByIdOptions<DTO> extends Filterable<DTO> {
+    /**
+     * Allow also deleted records to be get
+     */
+    withDeleted?: boolean;
+}

package/src/interfaces/find-by-id-options.interface.js

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

package/src/interfaces/find-by-id-options.interface.js.map

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

package/src/interfaces/find-relation-options.interface.d.ts

@@ -0,0 +1,2 @@
+import { Filterable } from './filterable.interface';
+export declare type FindRelationOptions<Relation> = Filterable<Relation>;

package/src/interfaces/find-relation-options.interface.js

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

package/src/interfaces/find-relation-options.interface.js.map

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

package/src/interfaces/get-by-id-options.interface.d.ts

@@ -0,0 +1,2 @@
+import { FindByIdOptions } from './find-by-id-options.interface';
+export declare type GetByIdOptions<DTO> = FindByIdOptions<DTO>;

package/src/interfaces/get-by-id-options.interface.js

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

package/src/interfaces/get-by-id-options.interface.js.map

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

package/src/interfaces/index.d.ts

@@ -0,0 +1,17 @@
+export * from './filter.interface';
+export * from './filter-field-comparison.interface';
+export * from './paging.interface';
+export * from './query.inteface';
+export * from './sort-field.interface';
+export * from './update-many-response.interface';
+export * from './delete-many-response.interface';
+export * from './aggregate-response.interface';
+export * from './aggregate-query.interface';
+export * from './modify-relation-options.interface';
+export * from './find-relation-options.interface';
+export * from './find-by-id-options.interface';
+export * from './get-by-id-options.interface';
+export * from './update-one-options.interface';
+export * from './delete-one-options.interface';
+export * from './delete-many-options.interface';
+export * from './filterable.interface';

package/src/interfaces/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./filter.interface"), exports);
+(0, tslib_1.__exportStar)(require("./filter-field-comparison.interface"), exports);
+(0, tslib_1.__exportStar)(require("./paging.interface"), exports);
+(0, tslib_1.__exportStar)(require("./query.inteface"), exports);
+(0, tslib_1.__exportStar)(require("./sort-field.interface"), exports);
+(0, tslib_1.__exportStar)(require("./update-many-response.interface"), exports);
+(0, tslib_1.__exportStar)(require("./delete-many-response.interface"), exports);
+(0, tslib_1.__exportStar)(require("./aggregate-response.interface"), exports);
+(0, tslib_1.__exportStar)(require("./aggregate-query.interface"), exports);
+(0, tslib_1.__exportStar)(require("./modify-relation-options.interface"), exports);
+(0, tslib_1.__exportStar)(require("./find-relation-options.interface"), exports);
+(0, tslib_1.__exportStar)(require("./find-by-id-options.interface"), exports);
+(0, tslib_1.__exportStar)(require("./get-by-id-options.interface"), exports);
+(0, tslib_1.__exportStar)(require("./update-one-options.interface"), exports);
+(0, tslib_1.__exportStar)(require("./delete-one-options.interface"), exports);
+(0, tslib_1.__exportStar)(require("./delete-many-options.interface"), exports);
+(0, tslib_1.__exportStar)(require("./filterable.interface"), exports);
+//# sourceMappingURL=index.js.map

package/src/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,kEAAmC;AACnC,mFAAoD;AACpD,kEAAmC;AACnC,gEAAiC;AACjC,sEAAuC;AACvC,gFAAiD;AACjD,gFAAiD;AACjD,8EAA+C;AAC/C,2EAA4C;AAC5C,mFAAoD;AACpD,iFAAkD;AAClD,8EAA+C;AAC/C,6EAA8C;AAC9C,8EAA+C;AAC/C,8EAA+C;AAC/C,+EAAgD;AAChD,sEAAuC"}

package/src/interfaces/modify-relation-options.interface.d.ts

@@ -0,0 +1,9 @@
+import { Filter } from './filter.interface';
+import { Filterable } from './filterable.interface';
+export interface ModifyRelationOptions<DTO, Relation> extends Filterable<DTO> {
+    /**
+     * A filter to use in addition to the primary key(s) when finding the relations to add to the DTO.
+     * For example this could be used to ensure that the a user has access to the records that are being related.
+     */
+    relationFilter?: Filter<Relation>;
+}

package/src/interfaces/modify-relation-options.interface.js

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

package/src/interfaces/modify-relation-options.interface.js.map

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

package/src/interfaces/paging.interface.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface for paging a collection.
+ */
+export interface Paging {
+    /**
+     * The maximum number of items that should be in the collection.
+     */
+    limit?: number;
+    /**
+     * When paging through a collection, the offset represents the index to start at.
+     */
+    offset?: number;
+}

package/src/interfaces/paging.interface.js

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

package/src/interfaces/paging.interface.js.map

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

package/src/interfaces/query.inteface.d.ts

@@ -0,0 +1,37 @@
+import { Paging } from './paging.interface';
+import { SortField } from './sort-field.interface';
+import { Filterable } from './filterable.interface';
+/**
+ * Interface for all queries to a collection of items.
+ *
+ * For example assume the following record type.
+ *
+ * ```ts
+ * class Item {
+ *   id: string;
+ *   name: string;
+ *   completed: boolean;
+ * }
+ * ```
+ * Now lets create a query.
+ *
+ * ```ts
+ * const query: Query<Item> = {
+ *   filter: { name: { like: 'Foo%' } }, // filter name LIKE "Foo%"
+ *   paging: { limit: 10, offset: 20}, // LIMIT 10 OFFSET 20
+ *   sorting: [{ field: 'name', direction: SortDirection.DESC }], // ORDER BY name DESC
+ * };
+ * ```
+ *
+ * @typeparam T - the type of the object to query for.
+ */
+export interface Query<T> extends Filterable<T> {
+    /**
+     * Option to page through the collection.
+     */
+    paging?: Paging;
+    /**
+     * Option to sort the collection.
+     */
+    sorting?: SortField<T>[];
+}

package/src/interfaces/query.inteface.js

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

package/src/interfaces/query.inteface.js.map

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

package/src/interfaces/sort-field.interface.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Enum for sorting either ASC or DESC.
+ */
+export declare enum SortDirection {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/**
+ * Null sort option.
+ */
+export declare enum SortNulls {
+    /**
+     * All nulls will be first.
+     */
+    NULLS_FIRST = "NULLS FIRST",
+    /**
+     * All nulls will be last.
+     */
+    NULLS_LAST = "NULLS LAST"
+}
+/**
+ * Interface to sort a field.
+ *
+ * Example use in a [[Query]]
+ *
+ * ```ts
+ * // ORDER BY name DESC
+ * const query: Query<Item> = {
+ *   sorting: [{ field: 'name', direction: SortDirection.DESC }],
+ * }
+ * ```
+ *
+ * To sort on multiple fields
+ *
+ * ```ts
+ * // ORDER BY name DESC, age ASC
+ * const query: Query<Item> = {
+ *   sorting: [
+ *     { field: 'name', direction: SortDirection.DESC },
+ *     { field: 'age', direction: SortDirection.ASC },
+ *   ],
+ * }
+ * ```
+ *
+ * @typeparam T - the type of object to sort.
+ */
+export interface SortField<T> {
+    /**
+     * A field in type T to sort on.
+     */
+    field: keyof T;
+    /**
+     * The direction of the sort (ASC or DESC)
+     */
+    direction: SortDirection;
+    /**
+     * The order that nulls values should be sorted.
+     */
+    nulls?: SortNulls;
+}

package/src/interfaces/sort-field.interface.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortNulls = exports.SortDirection = void 0;
+/**
+ * Enum for sorting either ASC or DESC.
+ */
+var SortDirection;
+(function (SortDirection) {
+    SortDirection["ASC"] = "ASC";
+    SortDirection["DESC"] = "DESC";
+})(SortDirection = exports.SortDirection || (exports.SortDirection = {}));
+/**
+ * Null sort option.
+ */
+var SortNulls;
+(function (SortNulls) {
+    /**
+     * All nulls will be first.
+     */
+    SortNulls["NULLS_FIRST"] = "NULLS FIRST";
+    /**
+     * All nulls will be last.
+     */
+    SortNulls["NULLS_LAST"] = "NULLS LAST";
+})(SortNulls = exports.SortNulls || (exports.SortNulls = {}));
+//# sourceMappingURL=sort-field.interface.js.map

package/src/interfaces/sort-field.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-field.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/sort-field.interface.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,4BAAW,CAAA;IACX,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED;;GAEG;AACH,IAAY,SASX;AATD,WAAY,SAAS;IACnB;;OAEG;IACH,wCAA2B,CAAA;IAC3B;;OAEG;IACH,sCAAyB,CAAA;AAC3B,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB"}

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

@@ -0,0 +1,9 @@
+/**
+ * The response from an update many operation.
+ */
+export interface UpdateManyResponse {
+    /**
+     * The number of records deleted.
+     */
+    updatedCount: number;
+}

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

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

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

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

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

@@ -0,0 +1,8 @@
+import { Filter } from './filter.interface';
+export interface UpdateOneOptions<DTO> {
+    /**
+     * Additional filter to use when updating an entity by id. This could be used to apply an additional filter to ensure
+     * that the entity belongs to a particular user.
+     */
+    filter?: Filter<DTO>;
+}

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

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

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

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

package/src/module.d.ts

@@ -0,0 +1,10 @@
+import { DynamicModule, ForwardReference } from '@nestjs/common';
+import { Assembler } from './assemblers';
+import { Class } from './common';
+export interface NestjsQueryCoreModuleOpts {
+    imports?: Array<Class<any> | DynamicModule | Promise<DynamicModule> | ForwardReference>;
+    assemblers?: Class<Assembler<any, any, any, any, any, any>>[];
+}
+export declare class NestjsQueryCoreModule {
+    static forFeature(opts: NestjsQueryCoreModuleOpts): DynamicModule;
+}

package/src/module.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestjsQueryCoreModule = void 0;
+const providers_1 = require("./providers");
+class NestjsQueryCoreModule {
+    static forFeature(opts) {
+        const { imports = [], assemblers = [] } = opts;
+        const assemblerServiceProviders = (0, providers_1.createServices)(assemblers);
+        return {
+            module: NestjsQueryCoreModule,
+            imports: [...imports],
+            providers: [...assemblers, ...assemblerServiceProviders],
+            exports: [...imports, ...assemblers, ...assemblerServiceProviders],
+        };
+    }
+}
+exports.NestjsQueryCoreModule = NestjsQueryCoreModule;
+//# sourceMappingURL=module.js.map

package/src/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../../../packages/core/src/module.ts"],"names":[],"mappings":";;;AAGA,2CAA6C;AAS7C,MAAa,qBAAqB;IAChC,MAAM,CAAC,UAAU,CAAC,IAA+B;QAC/C,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAC/C,MAAM,yBAAyB,GAAG,IAAA,0BAAc,EAAC,UAAU,CAAC,CAAC;QAC7D,OAAO;YACL,MAAM,EAAE,qBAAqB;YAC7B,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC;YACrB,SAAS,EAAE,CAAC,GAAG,UAAU,EAAE,GAAG,yBAAyB,CAAC;YACxD,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,yBAAyB,CAAC;SACnE,CAAC;IACJ,CAAC;CACF;AAXD,sDAWC"}

package/src/providers.d.ts

@@ -0,0 +1,4 @@
+import { Provider } from '@nestjs/common';
+import { Assembler } from './assemblers';
+import { Class } from './common';
+export declare const createServices: (opts: Class<Assembler<unknown, unknown, unknown, unknown, unknown, unknown>>[]) => Provider[];

package/src/providers.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createServices = void 0;
+const assemblers_1 = require("./assemblers");
+const decorators_1 = require("./decorators");
+const helpers_1 = require("./decorators/helpers");
+const services_1 = require("./services");
+function createServiceProvider(AssemblerClass) {
+    const classes = (0, assemblers_1.getAssemblerClasses)(AssemblerClass);
+    if (!classes) {
+        throw new Error(`unable to determine DTO and Entity classes for ${AssemblerClass.name}. Did you decorate your class with @Assembler`);
+    }
+    const { EntityClass } = classes;
+    return {
+        provide: (0, helpers_1.getAssemblerQueryServiceToken)(AssemblerClass),
+        useFactory(assembler, entityService) {
+            return new services_1.AssemblerQueryService(assembler, entityService);
+        },
+        inject: [AssemblerClass, (0, decorators_1.getQueryServiceToken)(EntityClass)],
+    };
+}
+const createServices = (opts) => opts.map((opt) => createServiceProvider(opt));
+exports.createServices = createServices;
+//# sourceMappingURL=providers.js.map

package/src/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../../../packages/core/src/providers.ts"],"names":[],"mappings":";;;AACA,6CAA8D;AAE9D,6CAAoD;AACpD,kDAAqE;AACrE,yCAAiE;AAEjE,SAAS,qBAAqB,CAC5B,cAA2D;IAE3D,MAAM,OAAO,GAAG,IAAA,gCAAmB,EAAC,cAAc,CAAC,CAAC;IACpD,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CACb,kDAAkD,cAAc,CAAC,IAAI,+CAA+C,CACrH,CAAC;KACH;IACD,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAChC,OAAO;QACL,OAAO,EAAE,IAAA,uCAA6B,EAAC,cAAc,CAAC;QACtD,UAAU,CAAC,SAA+C,EAAE,aAA2C;YACrG,OAAO,IAAI,gCAAqB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,EAAE,CAAC,cAAc,EAAE,IAAA,iCAAoB,EAAC,WAAW,CAAC,CAAC;KAC5D,CAAC;AACJ,CAAC;AAEM,MAAM,cAAc,GAAG,CAC5B,IAA8E,EAClE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC;AAFlD,QAAA,cAAc,kBAEoC"}

package/src/services/assembler-query.service.d.ts

@@ -0,0 +1,63 @@
+import { Assembler } from '../assemblers';
+import { Class, DeepPartial } from '../common';
+import { AggregateQuery, AggregateResponse, DeleteManyResponse, DeleteOneOptions, Filter, FindByIdOptions, FindRelationOptions, GetByIdOptions, ModifyRelationOptions, Query, UpdateManyResponse, UpdateOneOptions } from '../interfaces';
+import { QueryService } from './query.service';
+export declare class AssemblerQueryService<DTO, Entity, C = DeepPartial<DTO>, CE = DeepPartial<Entity>, U = C, UE = CE> implements QueryService<DTO, C, U> {
+    readonly assembler: Assembler<DTO, Entity, C, CE, U, UE>;
+    readonly queryService: QueryService<Entity, CE, UE>;
+    constructor(assembler: Assembler<DTO, Entity, C, CE, U, UE>, queryService: QueryService<Entity, CE, UE>);
+    addRelations<Relation>(relationName: string, id: string | number, relationIds: (string | number)[], opts?: ModifyRelationOptions<DTO, Relation>): Promise<DTO>;
+    createMany(items: C[]): Promise<DTO[]>;
+    createOne(item: C): Promise<DTO>;
+    deleteMany(filter: Filter<DTO>): Promise<DeleteManyResponse>;
+    deleteOne(id: number | string, opts?: DeleteOneOptions<DTO>): Promise<DTO>;
+    findById(id: string | number, opts?: FindByIdOptions<DTO>): Promise<DTO | undefined>;
+    getById(id: string | number, opts?: GetByIdOptions<DTO>): Promise<DTO>;
+    query(query: Query<DTO>): Promise<DTO[]>;
+    aggregate(filter: Filter<DTO>, aggregate: AggregateQuery<DTO>): Promise<AggregateResponse<DTO>[]>;
+    count(filter: Filter<DTO>): Promise<number>;
+    /**
+     * Query for relations for an array of DTOs. This method will return a map with the DTO as the key and the relations as the value.
+     * @param RelationClass - The class of the relation.
+     * @param relationName - The name of the relation to load.
+     * @param dtos - the dtos to find relations for.
+     * @param query - A query to use to filter, page, and sort relations.
+     */
+    queryRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: DTO[], query: Query<Relation>): Promise<Map<DTO, Relation[]>>;
+    /**
+     * Query for an array of relations.
+     * @param RelationClass - The class to serialize the relations into.
+     * @param dto - The dto to query relations for.
+     * @param relationName - The name of relation to query for.
+     * @param query - A query to filter, page and sort relations.
+     */
+    queryRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, query: Query<Relation>): Promise<Relation[]>;
+    countRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, filter: Filter<Relation>): Promise<number>;
+    countRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO[], filter: Filter<Relation>): Promise<Map<DTO, number>>;
+    /**
+     * Find a relation for an array of DTOs. This will return a Map where the key is the DTO and the value is to relation or undefined if not found.
+     * @param RelationClass - the class of the relation
+     * @param relationName - the name of the relation to load.
+     * @param dtos - the dtos to find the relation for.
+     * @param filter - Additional filter to apply when finding relations
+     */
+    findRelation<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: DTO[], opts?: FindRelationOptions<Relation>): Promise<Map<DTO, Relation | undefined>>;
+    /**
+     * Finds a single relation.
+     * @param RelationClass - The class to serialize the relation into.
+     * @param dto - The dto to find the relation for.
+     * @param relationName - The name of the relation to query for.
+     * @param filter - Additional filter to apply when finding relations
+     */
+    findRelation<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, opts?: FindRelationOptions<Relation>): Promise<Relation | undefined>;
+    removeRelation<Relation>(relationName: string, id: string | number, relationId: string | number, opts?: ModifyRelationOptions<DTO, Relation>): Promise<DTO>;
+    removeRelations<Relation>(relationName: string, id: string | number, relationIds: (string | number)[], opts?: ModifyRelationOptions<DTO, Relation>): Promise<DTO>;
+    setRelations<Relation>(relationName: string, id: string | number, relationIds: (string | number)[], opts?: ModifyRelationOptions<DTO, Relation>): Promise<DTO>;
+    setRelation<Relation>(relationName: string, id: string | number, relationId: string | number, opts?: ModifyRelationOptions<DTO, Relation>): Promise<DTO>;
+    updateMany(update: U, filter: Filter<DTO>): Promise<UpdateManyResponse>;
+    updateOne(id: string | number, update: U, opts?: UpdateOneOptions<DTO>): Promise<DTO>;
+    aggregateRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, filter: Filter<Relation>, aggregate: AggregateQuery<Relation>): Promise<AggregateResponse<Relation>[]>;
+    aggregateRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: DTO[], filter: Filter<Relation>, aggregate: AggregateQuery<Relation>): Promise<Map<DTO, AggregateResponse<Relation>[]>>;
+    private convertFilterable;
+    private convertModifyRelationsOptions;
+}