@ptc-org/nestjs-query-core 2.2.0 → 2.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptc-org/nestjs-query-core",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Base query package",
   "author": "doug-martin <doug@dougamartin.com>",
   "homepage": "https://github.com/tripss/nestjs-query#readme",

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

@@ -1,4 +1,5 @@
 import { Filterable } from './filterable.interface';
+import { SelectRelations } from './select-relation.interface';
 import { WithDeleted } from './with-deleted.interface';
-export interface FindByIdOptions<DTO> extends Filterable<DTO>, WithDeleted {
+export interface FindByIdOptions<DTO> extends Filterable<DTO>, SelectRelations<DTO>, WithDeleted {
 }

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

@@ -4,4 +4,8 @@ export interface FindRelationOptions<Relation> extends Filterable<Relation> {
      * Allow also deleted records to be retrieved
      */
     withDeleted?: boolean;
+    /**
+     * Relation is looked ahead
+     */
+    lookedAhead?: boolean;
 }

package/src/interfaces/index.d.ts

@@ -14,6 +14,7 @@ export * from './get-by-id-options.interface';
 export * from './modify-relation-options.interface';
 export * from './paging.interface';
 export * from './query.inteface';
+export * from './select-relation.interface';
 export * from './query-options.interface';
 export * from './sort-field.interface';
 export * from './update-many-response.interface';

package/src/interfaces/index.js

@@ -17,6 +17,7 @@ tslib_1.__exportStar(require("./get-by-id-options.interface"), exports);
 tslib_1.__exportStar(require("./modify-relation-options.interface"), exports);
 tslib_1.__exportStar(require("./paging.interface"), exports);
 tslib_1.__exportStar(require("./query.inteface"), exports);
+tslib_1.__exportStar(require("./select-relation.interface"), exports);
 tslib_1.__exportStar(require("./query-options.interface"), exports);
 tslib_1.__exportStar(require("./sort-field.interface"), exports);
 tslib_1.__exportStar(require("./update-many-response.interface"), exports);

package/src/interfaces/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,wEAA6C;AAC7C,sEAA2C;AAC3C,yEAA8C;AAC9C,oEAAyC;AACzC,0EAA+C;AAC/C,2EAAgD;AAChD,yEAA8C;AAC9C,6DAAkC;AAClC,8EAAmD;AACnD,iEAAsC;AACtC,yEAA8C;AAC9C,4EAAiD;AACjD,wEAA6C;AAC7C,8EAAmD;AACnD,6DAAkC;AAClC,2DAAgC;AAChC,oEAAyC;AACzC,iEAAsC;AACtC,2EAAgD;AAChD,yEAA8C;AAC9C,mEAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,wEAA6C;AAC7C,sEAA2C;AAC3C,yEAA8C;AAC9C,oEAAyC;AACzC,0EAA+C;AAC/C,2EAAgD;AAChD,yEAA8C;AAC9C,6DAAkC;AAClC,8EAAmD;AACnD,iEAAsC;AACtC,yEAA8C;AAC9C,4EAAiD;AACjD,wEAA6C;AAC7C,8EAAmD;AACnD,6DAAkC;AAClC,2DAAgC;AAChC,sEAA2C;AAC3C,oEAAyC;AACzC,iEAAsC;AACtC,2EAAgD;AAChD,yEAA8C;AAC9C,mEAAwC"}

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

@@ -1,5 +1,6 @@
 import { Filterable } from './filterable.interface';
 import { Paging } from './paging.interface';
+import { SelectRelation } from './select-relation.interface';
 import { SortField } from './sort-field.interface';
 /**
  * Interface for all queries to a collection of items.
@@ -25,7 +26,7 @@ import { SortField } from './sort-field.interface';
  *
  * @typeparam T - the type of the object to query for.
  */
-export interface Query<T> extends Filterable<T> {
+export interface Query<DTO> extends Filterable<DTO> {
     /**
      * Option to page through the collection.
      */
@@ -33,5 +34,10 @@ export interface Query<T> extends Filterable<T> {
     /**
      * Option to sort the collection.
      */
-    sorting?: SortField<T>[];
+    sorting?: SortField<DTO>[];
+    /**
+     * Select relations when doing the query.
+     * @internal this implementation is not final and subjected to change! Use at own risk!
+     */
+    relations?: SelectRelation<DTO>[];
 }

package/src/interfaces/select-relation.interface.d.ts

@@ -0,0 +1,11 @@
+import { Query } from './query.inteface';
+export interface SelectRelation<DTO> {
+    name: string;
+    query: Query<DTO>;
+}
+export interface SelectRelations<DTO> {
+    /**
+     * Select relations when doing the database query
+     */
+    relations?: SelectRelation<DTO>[];
+}

package/src/interfaces/select-relation.interface.js

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

package/src/interfaces/select-relation.interface.js.map

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

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

@@ -9,6 +9,7 @@ export interface QueryService<DTO, C = DeepPartial<DTO>, U = DeepPartial<DTO>> {
     /**
      * Query for multiple records of type `T`.
      * @param query - the query used to filer, page or sort records.
+     * @param selectRelations - additional relation to select and fetch in the same query.
      * @returns a promise with an array of records that match the query.
      */
     query(query: Query<DTO>, opts?: QueryOptions): Promise<DTO[]>;

package/src/services/query.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"query.service.js","sourceRoot":"","sources":["../../../../../packages/core/src/services/query.service.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;AA0R3C;;;GAGG;AACH,4GAA4G;AAC5G,SAAgB,YAAY,CAAkD,QAAoB;IAChG,OAAO,CAA6C,GAAQ,EAAc,EAAE;QAC1E,OAAO,IAAA,mBAAU,GAAE,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC,CAAA;AACH,CAAC;AAJD,oCAIC"}
+{"version":3,"file":"query.service.js","sourceRoot":"","sources":["../../../../../packages/core/src/services/query.service.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;AA2R3C;;;GAGG;AACH,4GAA4G;AAC5G,SAAgB,YAAY,CAAkD,QAAoB;IAChG,OAAO,CAA6C,GAAQ,EAAc,EAAE;QAC1E,OAAO,IAAA,mBAAU,GAAE,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC,CAAA;AACH,CAAC;AAJD,oCAIC"}