@ptc-org/nestjs-query-sequelize 1.0.0-alpha.1 → 1.0.0-alpha.2

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

@@ -0,0 +1,147 @@
+import { Query, DeleteManyResponse, UpdateManyResponse, DeepPartial, QueryService, Filter, AggregateQuery, AggregateResponse, FindByIdOptions, GetByIdOptions, UpdateOneOptions, DeleteOneOptions } from '@ptc-org/nestjs-query-core';
+import { Model, ModelCtor } from 'sequelize-typescript';
+import { FilterQueryBuilder } from '../query';
+import { RelationQueryService } from './relation-query.service';
+/**
+ * Base class for all query services that use a `sequelize` Model.
+ *
+ * @example
+ *
+ * ```ts
+ * @QueryService(TodoItemEntity)
+ * export class TodoItemService extends SequelizeQueryService<TodoItemEntity> {
+ *   constructor(
+ *      @InjectRepository(TodoItemEntity) repo: Repository<TodoItemEntity>,
+ *   ) {
+ *     super(repo);
+ *   }
+ * }
+ * ```
+ */
+export declare class SequelizeQueryService<Entity extends Model<Entity, Partial<Entity>>> extends RelationQueryService<Entity> implements QueryService<Entity, DeepPartial<Entity>, DeepPartial<Entity>> {
+    readonly model: ModelCtor<Entity>;
+    readonly filterQueryBuilder: FilterQueryBuilder<Entity>;
+    constructor(model: ModelCtor<Entity>);
+    /**
+     * Query for multiple entities, using a Query from `@ptc-org/nestjs-query-core`.
+     *
+     * @example
+     * ```ts
+     * const todoItems = await this.service.query({
+     *   filter: { title: { eq: 'Foo' } },
+     *   paging: { limit: 10 },
+     *   sorting: [{ field: "create", direction: SortDirection.DESC }],
+     * });
+     * ```
+     * @param query - The Query used to filter, page, and sort rows.
+     */
+    query(query: Query<Entity>): Promise<Entity[]>;
+    aggregate(filter: Filter<Entity>, aggregate: AggregateQuery<Entity>): Promise<AggregateResponse<Entity>[]>;
+    count(filter: Filter<Entity>): Promise<number>;
+    /**
+     * Find an entity by it's `id`.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.findById(1);
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    findById(id: string | number, opts?: FindByIdOptions<Entity>): Promise<Entity | undefined>;
+    /**
+     * Gets an entity by it's `id`. If the entity is not found a rejected promise is returned.
+     *
+     * @example
+     * ```ts
+     * try {
+     *   const todoItem = await this.service.getById(1);
+     * } catch(e) {
+     *   console.error('Unable to find entity with id = 1');
+     * }
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    getById(id: string | number, opts?: GetByIdOptions<Entity>): Promise<Entity>;
+    /**
+     * Creates a single entity.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createOne({title: 'Todo Item', completed: false });
+     * ```
+     * @param record - The entity to create.
+     */
+    createOne(record: DeepPartial<Entity>): Promise<Entity>;
+    /**
+     * Create multiple entities.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createMany([
+     *   {title: 'Todo Item 1', completed: false },
+     *   {title: 'Todo Item 2', completed: true },
+     * ]);
+     * ```
+     * @param records - The entities to create.
+     */
+    createMany(records: DeepPartial<Entity>[]): Promise<Entity[]>;
+    /**
+     * Update an entity.
+     *
+     * @example
+     * ```ts
+     * const updatedEntity = await this.service.updateOne(1, { completed: true });
+     * ```
+     * @param id - The `id` of the record.
+     * @param update - A `Partial` of the entity with fields to update.
+     * @param opts - Additional options.
+     */
+    updateOne(id: number | string, update: DeepPartial<Entity>, opts?: UpdateOneOptions<Entity>): Promise<Entity>;
+    /**
+     * Update multiple entities with a `@ptc-org/nestjs-query-core` Filter.
+     *
+     * @example
+     * ```ts
+     * const { updatedCount } = await this.service.updateMany(
+     *   { completed: true }, // the update to apply
+     *   { title: { eq: 'Foo Title' } } // Filter to find records to update
+     * );
+     * ```
+     * @param update - A `Partial` of entity with the fields to update
+     * @param filter - A Filter used to find the records to update
+     */
+    updateMany(update: DeepPartial<Entity>, filter: Filter<Entity>): Promise<UpdateManyResponse>;
+    /**
+     * Delete an entity by `id`.
+     *
+     * @example
+     *
+     * ```ts
+     * const deletedTodo = await this.service.deleteOne(1);
+     * ```
+     *
+     * @param id - The `id` of the entity to delete.
+     * @param opts - Additional options.
+     */
+    deleteOne(id: string | number, opts?: DeleteOneOptions<Entity>): Promise<Entity>;
+    /**
+     * Delete multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
+     *
+     * @example
+     *
+     * ```ts
+     * const { deletedCount } = this.service.deleteMany({
+     *   created: { lte: new Date('2020-1-1') }
+     * });
+     * ```
+     *
+     * @param filter - A `Filter` to find records to delete.
+     */
+    deleteMany(filter: Filter<Entity>): Promise<DeleteManyResponse>;
+    private getChangedValues;
+    private ensureEntityDoesNotExist;
+    private ensureIdIsNotPresent;
+    private primaryKeyValues;
+}

package/src/services/sequelize-query.service.js

@@ -0,0 +1,239 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SequelizeQueryService = void 0;
+const tslib_1 = require("tslib");
+const lodash_pick_1 = (0, tslib_1.__importDefault)(require("lodash.pick"));
+const common_1 = require("@nestjs/common");
+const query_1 = require("../query");
+const relation_query_service_1 = require("./relation-query.service");
+/**
+ * Base class for all query services that use a `sequelize` Model.
+ *
+ * @example
+ *
+ * ```ts
+ * @QueryService(TodoItemEntity)
+ * export class TodoItemService extends SequelizeQueryService<TodoItemEntity> {
+ *   constructor(
+ *      @InjectRepository(TodoItemEntity) repo: Repository<TodoItemEntity>,
+ *   ) {
+ *     super(repo);
+ *   }
+ * }
+ * ```
+ */
+class SequelizeQueryService extends relation_query_service_1.RelationQueryService {
+    constructor(model) {
+        super();
+        this.model = model;
+        this.filterQueryBuilder = new query_1.FilterQueryBuilder(model);
+    }
+    /**
+     * Query for multiple entities, using a Query from `@ptc-org/nestjs-query-core`.
+     *
+     * @example
+     * ```ts
+     * const todoItems = await this.service.query({
+     *   filter: { title: { eq: 'Foo' } },
+     *   paging: { limit: 10 },
+     *   sorting: [{ field: "create", direction: SortDirection.DESC }],
+     * });
+     * ```
+     * @param query - The Query used to filter, page, and sort rows.
+     */
+    async query(query) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return this.model.findAll(this.filterQueryBuilder.findOptions(query));
+    }
+    async aggregate(filter, aggregate) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        const result = await this.model.findAll(this.filterQueryBuilder.aggregateOptions({ filter }, aggregate));
+        if (!result) {
+            return [{}];
+        }
+        return query_1.AggregateBuilder.convertToAggregateResponse(result);
+    }
+    async count(filter) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return this.model.count(this.filterQueryBuilder.countOptions({ filter }));
+    }
+    /**
+     * Find an entity by it's `id`.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.findById(1);
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    async findById(id, opts) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        const model = await this.model.findOne(this.filterQueryBuilder.findByIdOptions(id, opts ?? {}));
+        if (!model) {
+            return undefined;
+        }
+        return model;
+    }
+    /**
+     * Gets an entity by it's `id`. If the entity is not found a rejected promise is returned.
+     *
+     * @example
+     * ```ts
+     * try {
+     *   const todoItem = await this.service.getById(1);
+     * } catch(e) {
+     *   console.error('Unable to find entity with id = 1');
+     * }
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    async getById(id, opts) {
+        const entity = await this.findById(id, opts ?? {});
+        if (!entity) {
+            throw new common_1.NotFoundException(`Unable to find ${this.model.name} with id: ${id}`);
+        }
+        return entity;
+    }
+    /**
+     * Creates a single entity.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createOne({title: 'Todo Item', completed: false });
+     * ```
+     * @param record - The entity to create.
+     */
+    async createOne(record) {
+        await this.ensureEntityDoesNotExist(record);
+        const changedValues = this.getChangedValues(record);
+        return this.model.create(changedValues);
+    }
+    /**
+     * Create multiple entities.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createMany([
+     *   {title: 'Todo Item 1', completed: false },
+     *   {title: 'Todo Item 2', completed: true },
+     * ]);
+     * ```
+     * @param records - The entities to create.
+     */
+    async createMany(records) {
+        await Promise.all(records.map((r) => this.ensureEntityDoesNotExist(r)));
+        return this.model.bulkCreate(records.map((r) => this.getChangedValues(r)));
+    }
+    /**
+     * Update an entity.
+     *
+     * @example
+     * ```ts
+     * const updatedEntity = await this.service.updateOne(1, { completed: true });
+     * ```
+     * @param id - The `id` of the record.
+     * @param update - A `Partial` of the entity with fields to update.
+     * @param opts - Additional options.
+     */
+    async updateOne(id, update, opts) {
+        this.ensureIdIsNotPresent(update);
+        const entity = await this.getById(id, opts);
+        const changedValues = this.getChangedValues(update);
+        return entity.update(changedValues);
+    }
+    /**
+     * Update multiple entities with a `@ptc-org/nestjs-query-core` Filter.
+     *
+     * @example
+     * ```ts
+     * const { updatedCount } = await this.service.updateMany(
+     *   { completed: true }, // the update to apply
+     *   { title: { eq: 'Foo Title' } } // Filter to find records to update
+     * );
+     * ```
+     * @param update - A `Partial` of entity with the fields to update
+     * @param filter - A Filter used to find the records to update
+     */
+    async updateMany(update, filter) {
+        this.ensureIdIsNotPresent(update);
+        const changedValues = this.getChangedValues(update);
+        const [count] = await this.model.update(changedValues, this.filterQueryBuilder.updateOptions({ filter }));
+        return { updatedCount: count };
+    }
+    /**
+     * Delete an entity by `id`.
+     *
+     * @example
+     *
+     * ```ts
+     * const deletedTodo = await this.service.deleteOne(1);
+     * ```
+     *
+     * @param id - The `id` of the entity to delete.
+     * @param opts - Additional options.
+     */
+    async deleteOne(id, opts) {
+        const entity = await this.getById(id, opts);
+        await entity.destroy();
+        return entity;
+    }
+    /**
+     * Delete multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
+     *
+     * @example
+     *
+     * ```ts
+     * const { deletedCount } = this.service.deleteMany({
+     *   created: { lte: new Date('2020-1-1') }
+     * });
+     * ```
+     *
+     * @param filter - A `Filter` to find records to delete.
+     */
+    async deleteMany(filter) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        const deletedCount = await this.model.destroy(this.filterQueryBuilder.destroyOptions({ filter }));
+        return { deletedCount: deletedCount || 0 };
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    getChangedValues(record) {
+        if (record instanceof this.model) {
+            const recordEntity = record;
+            const raw = recordEntity.get({ plain: true });
+            const changed = recordEntity.changed();
+            if (changed === false) {
+                return {};
+            }
+            return (0, lodash_pick_1.default)(raw, changed);
+        }
+        return record;
+    }
+    async ensureEntityDoesNotExist(entity) {
+        const pks = this.primaryKeyValues(entity);
+        if (Object.keys(pks).length) {
+            const found = await this.model.findOne({ where: pks });
+            if (found) {
+                throw new Error('Entity already exists');
+            }
+        }
+    }
+    ensureIdIsNotPresent(entity) {
+        if (Object.keys(this.primaryKeyValues(entity)).length) {
+            throw new Error('Id cannot be specified when updating');
+        }
+    }
+    primaryKeyValues(entity) {
+        const changed = this.getChangedValues(entity);
+        return this.model.primaryKeyAttributes.reduce((pks, pk) => {
+            const key = pk;
+            if (key in changed && changed[key] !== undefined) {
+                return { ...pks, [pk]: changed[key] };
+            }
+            return pks;
+        }, {});
+    }
+}
+exports.SequelizeQueryService = SequelizeQueryService;
+//# sourceMappingURL=sequelize-query.service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sequelize-query.service.js","sourceRoot":"","sources":["../../../../../packages/query-sequelize/src/services/sequelize-query.service.ts"],"names":[],"mappings":";;;;AAcA,2EAAqC;AAGrC,2CAAmD;AACnD,oCAAgE;AAChE,qEAAgE;AAGhE;;;;;;;;;;;;;;;GAeG;AACH,MAAa,qBACX,SAAQ,6CAA4B;IAKpC,YAAqB,KAAwB;QAC3C,KAAK,EAAE,CAAC;QADW,UAAK,GAAL,KAAK,CAAmB;QAE3C,IAAI,CAAC,kBAAkB,GAAG,IAAI,0BAAkB,CAAS,KAAK,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CAAC,KAAoB;QAC9B,iEAAiE;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAS,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,MAAsB,EAAE,SAAiC;QACvE,iEAAiE;QACjE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QACzG,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,CAAC,EAAE,CAAC,CAAC;SACb;QACD,OAAO,wBAAgB,CAAC,0BAA0B,CAAC,MAA8C,CAAC,CAAC;IACrG,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAsB;QAChC,iEAAiE;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAmB,EAAE,IAA8B;QAChE,iEAAiE;QACjE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAS,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;QACxG,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,OAAO,CAAC,EAAmB,EAAE,IAA6B;QAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,0BAAiB,CAAC,kBAAkB,IAAI,CAAC,KAAK,CAAC,IAAI,aAAa,EAAE,EAAE,CAAC,CAAC;SACjF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CAAC,MAA2B;QACzC,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAS,aAA4C,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,OAA8B;QAC7C,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAExE,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAS,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAgC,CAAC,CAAC,CAAC;IACpH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CAAC,EAAmB,EAAE,MAA2B,EAAE,IAA+B;QAC/F,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAE5C,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEpD,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CAAC,MAA2B,EAAE,MAAsB;QAClE,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAElC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEpD,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC1G,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CAAC,EAAmB,EAAE,IAA+B;QAClE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CAAC,MAAsB;QACrC,iEAAiE;QACjE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAClG,OAAO,EAAE,YAAY,EAAE,YAAY,IAAI,CAAC,EAAE,CAAC;IAC7C,CAAC;IAED,wDAAwD;IAChD,gBAAgB,CAAC,MAA2B;QAClD,IAAI,MAAM,YAAY,IAAI,CAAC,KAAK,EAAE;YAChC,MAAM,YAAY,GAAG,MAAgB,CAAC;YAEtC,MAAM,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9C,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC;YACvC,IAAI,OAAO,KAAK,KAAK,EAAE;gBACrB,OAAO,EAAE,CAAC;aACX;YAED,OAAO,IAAA,qBAAU,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACjC;QAED,OAAO,MAAyB,CAAC;IACnC,CAAC;IAEO,KAAK,CAAC,wBAAwB,CAAC,MAA2B;QAChE,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAE1C,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE;YAC3B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YAEvD,IAAI,KAAK,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC1C;SACF;IACH,CAAC;IAEO,oBAAoB,CAAC,MAA2B;QACtD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE;YACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;IACH,CAAC;IAEO,gBAAgB,CAAC,MAA2B;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;YACxD,MAAM,GAAG,GAAG,EAAkB,CAAC;YAE/B,IAAI,GAAG,IAAI,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBAChD,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAA0B,CAAC;aAC/D;YAED,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAA0B,CAAC,CAAC;IACjC,CAAC;CACF;AApPD,sDAoPC"}