@nestlize/repository 0.1.13 → 0.1.14

package/README.md

@@ -74,13 +74,13 @@ All methods return Promises.
 | `findAll(query?, options?)`                    | `query?: WhereOptions`, `options?: Omit<FindOptions, 'where'>`                                                                                      | Find all matching records                       |   
 | `findAllPaginated(options?)`                   | `limit?: number`, `offset?: number`, `page?: number`, `query?: WhereOptions`, `options?: Omit<FindAndCountOptions, 'where' \| 'offset' \| 'limit'>` | Find paginated records and total count          |
 | `updateByPk(primaryKey, dto, options?)`        | `primaryKey: string \| number`, `dto: Partial<Attributes<TModel>>`, `options?: SaveOptions`                                                         | Update record by primary key                    |
+| `delete(query, options?)`                      | `query?: WhereOptions`, `options?: Omit<DestroyOptions<Attributes<TModel>>, 'where'>`                                                               | Update record by primary key                    |
+| `restore(query, options?)`                     | `query?: WhereOptions`, `options?: Omit<RestoreOptions<Attributes<TModel>>, 'where'>`                                                               | Update record by primary key                    |
 | `deleteByPk(primaryKey, options?)`             | `primaryKey: string \| number`, `options?: InstanceDestroyOptions`                                                                                  | Delete (soft/hard) record by primary key        |
 | `restoreByPk(primaryKey, options?)`            | `primaryKey: string \| number`, `options?: InstanceRestoreOptions`                                                                                  | Restore previously soft-deleted record          |
 | `transaction(runInTransaction)`                | `(transaction: Transaction) => Promise<R>`                                                                                                          | Execute callback within a Sequelize transaction |
 | `calculateOffset(limit: number, page: number)` | `limit: number, page: number`                                                                                                                       | Calculate offset for page pagination            |
 
----
-
 ## 🚀 Quick Start
 
 ### 1. Define a model

package/index.d.ts

@@ -11,6 +11,8 @@ import {
   FindOptions,
   BulkCreateOptions,
   FindAndCountOptions,
+  DestroyOptions,
+  RestoreOptions,
 } from 'sequelize'
 import { Model, ModelCtor } from 'sequelize-typescript'
 
@@ -163,6 +165,30 @@ export interface IRepository<TModel extends Model> {
     options?: SaveOptions<Attributes<TModel>>,
   ): Promise<TModel | null>
 
+  /**
+   * Delete all records matching query
+   *
+   * @param query A Sequelize where clause.
+   * @param options Optional Sequelize destroy options.
+   * @returns A Promise represented amount of deleted records.
+   */
+  delete(
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<DestroyOptions<Attributes<TModel>>, 'where'>,
+  ): Promise<number>
+
+  /**
+   * Restore all deleted records.
+   *
+   * @param query A Sequelize where clause.
+   * @param options Optional Sequelize restore options.
+   * @returns Promise<void>
+   */
+  restore(
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<RestoreOptions<Attributes<TModel>>, 'where'>,
+  ): Promise<void>
+
   /**
    * Deletes (soft or hard) a record by its primary key.
    *
@@ -322,6 +348,22 @@ export declare class AbstractRepository<
     options?: SaveOptions<Attributes<TModel>>,
   ): Promise<TModel | null>
 
+  /**
+   * @inheritdoc
+   */
+  delete(
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<DestroyOptions<Attributes<TModel>>, 'where'>,
+  ): Promise<number>
+
+  /**
+   * @inheritdoc
+   */
+  restore(
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<RestoreOptions<Attributes<TModel>>, 'where'>,
+  ): Promise<void>
+
   /**
    * @inheritdoc
    */

package/index.js

@@ -127,6 +127,27 @@ class AbstractRepository {
             throw new common_1.InternalServerErrorException();
         }
     }
+    async delete(query, options) {
+        try {
+            return this.model.destroy({
+                where: query,
+                ...options,
+            });
+        }
+        catch (error) {
+            this.logger.error(`delete: ${error}`);
+            throw new common_1.InternalServerErrorException();
+        }
+    }
+    async restore(query, options) {
+        try {
+            return this.model.restore({ where: query, ...options });
+        }
+        catch (error) {
+            this.logger.error(`restore: ${error}`);
+            throw new common_1.InternalServerErrorException();
+        }
+    }
     async deleteByPk(primaryKey, options) {
         try {
             const entity = await this.findByPk(primaryKey, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestlize/repository",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Abstract repository and other database tools for Nest and Sequelize.js ORM",
   "keywords": [
     "sequelize.js",