@codenameryuu/adonis-lucid-soft-deletes 1.4.0 → 1.6.0

package/README.md

@@ -1,40 +1,33 @@
 # @codenameryuu/adonis-lucid-soft-deletes
 
-This addon adds the functionality to soft deletes Lucid Models through the `deleted_at` flag in AdonisJS 7.
+This addon adds the functionality to soft deletes Lucid Models through the `deleted_at` flag in AdonisJS.
 
-## Introduction
+## Requirement
 
-Sometimes you may wish to "no-delete" a model from database.
-When models are soft deleted, they are not actually removed from your database.
-Instead, a `deleted_at` attribute is set on the model indicating the date
-and time at which the model was "deleted".
-
-:point_right: The SoftDeletes mixin will automatically add the `deleted_at` attribute
-as Luxon / DateTime instance.
+- Adonis Js 7
+- Lucid 22 or higher
 
 ## Installation
 
-Install it using `npm` , `yarn` or `pnpm` .
+- Install the package
 
 ```bash
 yarn add @codenameryuu/adonis-lucid-soft-deletes
 ```
 
-After install call `configure` :
+- Configure the package
 
 ```bash
 node ace configure @codenameryuu/adonis-lucid-soft-deletes
 ```
 
-## Usage
-
-Make sure to register the provider inside `adonisrc.ts` file.
+- Make sure to register the provider inside `adonisrc.ts` file.
 
 ```typescript
 providers: [
   // ...
   () => import('@codenameryuu/adonis-lucid-soft-deletes/provider'),
-]
+],
 ```
 
 You should add the `deleted_at` column to your database tables for models with soft deletes.
@@ -43,8 +36,8 @@ You should add the `deleted_at` column to your database tables for models with s
 // migrations/1234566666_users.ts
 import { BaseSchema } from '@adonisjs/lucid/schema'
 
-export default class Users extends BaseSchema {
-  protected tableName = 'users'
+export default class extends BaseSchema {
+  protected tableName = 'products'
 
   async up() {
     this.schema.createTable(this.tableName, (table) => {
@@ -60,9 +53,9 @@ export default class Users extends BaseSchema {
 
 ```typescript
 import { compose } from '@adonisjs/core/helpers'
-import { SoftDeletes } from 'adonis-lucid-soft-deletes'
+import { SoftDeletes } from '@codenameryuu/adonis-lucid-soft-deletes'
 
-export default class User extends compose(BaseModel, SoftDeletes) {
+export default class Product extends compose(BaseModel, SoftDeletes) {
   // ...columns and props
 }
 ```
@@ -72,23 +65,23 @@ will be set to the current date and time. However, the model's database record w
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class UsersController {
+export default class ProductsController {
   /**
-   * Delete user by id
-   * DELETE /users/:id
+   * Delete product by id
+   * DELETE /products/:id
    */
-  async destroy({ params, response }: HttpContext) {
-    const user = await User.findOrFail(params.id)
-    await user.delete()
+  async destroy({ request, response }: HttpContext) {
+    const product = await Product.findOrFail(request.input('id'))
+    await product.delete()
 
-    return user // or response.noContent()
+    return product // or response.noContent()
   }
 }
 ```
 
-> :boom: Soft delete only works for model instances. `await User.query().delete()` as before
+> :boom: Soft delete only works for model instances. `await Product.query().delete()` as before
 > will delete models from database
 
 :point_right: When querying a model that uses soft deletes, the soft deleted models
@@ -98,19 +91,19 @@ To determine if a given model instance has been soft deleted, you may use the `.
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class UsersController {
+export default class ProductsController {
   /**
-   * Get user by id
-   * GET /users/:id
+   * Get product by id
+   * GET /products/:id
    */
-  async show({ params }: HttpContext) {
-    const user = await User.withTrashed().where('id', params.id).firstOrFail()
-    if (user.trashed) {
+  async show({ request, response }: HttpContext) {
+    const product = await Product.withTrashed().where('id', request.input('id')).firstOrFail()
+    if (product.trashed) {
       return response.forbidden()
     }
-    return user
+    return product
   }
 }
 ```
@@ -119,9 +112,9 @@ export default class UsersController {
 
 ```typescript
 import { compose } from '@adonisjs/core/helpers'
-import { SoftDeletes } from 'adonis-lucid-soft-deletes'
+import { SoftDeletes } from '@codenameryuu/adonis-lucid-soft-deletes'
 
-export default class User extends compose(BaseModel, SoftDeletes) {
+export default class Product extends compose(BaseModel, SoftDeletes) {
   // ...columns and props
 
   @column.dateTime({ columnName: 'customDeletedAtColumn' })
@@ -138,23 +131,23 @@ The `restore` method will set the model's `deleted_at` column to `null` :
 
 ```ts
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class TrashUsersController {
+export default class TrashProductsController {
   /**
-   * Update trashed user by id
-   * PUT /trash/users/:id
+   * Update trashed product by id
+   * PUT /trash/products/:id
    */
-  async update({ params }: HttpContext) {
-    const user = await User.withTrashed().where('id', params.id).firstOrFail()
-    await user.restore()
+  async update({ request }: HttpContext) {
+    const product = await Product.withTrashed().where('id', request.input('id')).firstOrFail()
+    await product.restore()
 
-    return user
+    return product
 
     // or
 
-    await User.withTrashed().where('id', params.id).restore()
-    await User.query().withTrashed().where('id', params.id).restore()
+    await Product.withTrashed().where('id', request.input('id')).restore()
+    await Product.query().withTrashed().where('id', request.input('id')).restore()
   }
 }
 ```
@@ -166,16 +159,16 @@ You may use the `.forceDelete()` method to permanently remove a soft deleted mod
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class UsersController {
+export default class ProductsController {
   /**
-   * Delete user by id
-   * DELETE /users/:id
+   * Delete product by id
+   * DELETE /products/:id
    */
-  async destroy({ params, response }: HttpContext) {
-    const user = await User.findOrFail(params.id)
-    await user.forceDelete()
+  async destroy({ request, response }: HttpContext) {
+    const product = await Product.findOrFail(request.input('id'))
+    await product.forceDelete()
 
     return response.noContent()
   }
@@ -190,25 +183,19 @@ by calling the `.withTrashed()` method on the model:
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class UsersController {
+export default class ProductsController {
   /**
-   * Get a list users
-   * GET /users?withTrashed=1
+   * Get a list products
+   * GET /products?withTrashed=1
    */
   async index({ request }: HttpContext) {
-    const usersQuery = request.input('withTrashed') ? User.withTrashed() : User.query()
-
-    return usersQuery.exec()
-
-    // or
-
-    return User.query()
+    return Product.query()
       .if(request.input('withTrashed'), (query) => {
         query.withTrashed()
       })
-      .exec()
+      .paginate(request.input('page', 1), request.input('perPage', 10))
   }
 }
 ```
@@ -219,15 +206,15 @@ The `.onlyTrashed()` method will retrieve **only** soft deleted models:
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class TrashUsersController {
+export default class TrashProductsController {
   /**
-   * Get a list trashed users
-   * GET /trash/users
+   * Get a list trashed products
+   * GET /trash/products
    */
   async index({ request }: HttpContext) {
-    return User.onlyTrashed().exec()
+    return Product.onlyTrashed().paginate(request.input('page', 1), request.input('perPage', 10))
   }
 }
 ```
@@ -238,6 +225,10 @@ Methods `.withTrashed()` , `.onlyTrashed()` and `.restore()` also available
 in ModelQueryBuilder for models with soft delete, example:
 
 ```typescript
-await User.query().withTrashed().exec()
-await User.query().onlyTrashed().restore()
+await Product.query().withTrashed().paginate(request.input('page', 1), request.input('perPage', 10))
+await Product.query().onlyTrashed().paginate(request.input('page', 1), request.input('perPage', 10))
 ```
+
+## License
+
+This package is open-sourced software licensed under the [MIT license](LICENSE.md).

package/build/configure.js

@@ -0,0 +1,14 @@
+/*
+ * adonis-lucid-soft-deletes
+ *
+ * (c) Lookin Anton <alsd@lookinlab.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export async function configure(command) {
+    const codemods = await command.createCodemods();
+    await codemods.updateRcFile((rcFile) => {
+        rcFile.addProvider('@codenameryuu/adonis-lucid-soft-deletes/provider');
+    });
+}

package/build/index.js

@@ -1,128 +1,10 @@
-import {
-  __decorateClass
-} from "./chunk-EUXUH3YW.js";
-
-// configure.ts
-async function configure(command) {
-  const codemods = await command.createCodemods();
-  await codemods.updateRcFile((rcFile) => {
-    rcFile.addProvider("@codenameryuu/adonis-lucid-soft-deletes/provider");
-  });
-}
-
-// src/mixin.ts
-import { DateTime } from "luxon";
-import { Exception } from "@adonisjs/core/exceptions";
-import { column, beforeFind, beforeFetch, beforePaginate } from "@adonisjs/lucid/orm";
-function SoftDeletes(superclass) {
-  class ModelWithSoftDeletes extends superclass {
-    static ignoreDeleted(query) {
-      if (query["ignoreDeleted"] === false) {
-        return;
-      }
-      const isGroupLimitQuery = query.clone().toQuery().includes("adonis_group_limit_counter");
-      const deletedAtColumn = query.model.$getColumn("deletedAt")?.columnName;
-      const queryIgnoreDeleted = isGroupLimitQuery ? query.knexQuery["_single"].table : query;
-      queryIgnoreDeleted.whereNull(`${query.model.table}.${deletedAtColumn}`);
-    }
-    static ignoreDeletedPaginate([countQuery, query]) {
-      countQuery["ignoreDeleted"] = query["ignoreDeleted"];
-      this.ignoreDeleted(countQuery);
-    }
-    static disableIgnore(query) {
-      if (query["ignoreDeleted"] === false) {
-        return query;
-      }
-      query["ignoreDeleted"] = false;
-      return query;
-    }
-    /**
-     * Fetch all models without filter by deleted_at
-     */
-    static withTrashed() {
-      const query = this.query();
-      return this.disableIgnore(query);
-    }
-    /**
-     * Fetch models only with deleted_at
-     */
-    static onlyTrashed() {
-      const query = this.query();
-      const deletedAtColumn = query.model.$getColumn("deletedAt")?.columnName;
-      return this.disableIgnore(query).whereNotNull(`${query.model.table}.${deletedAtColumn}`);
-    }
-    /**
-     * Force delete instance property
-     */
-    $forceDelete = false;
-    /**
-     * Computed trashed property
-     */
-    get trashed() {
-      return this.deletedAt !== null;
-    }
-    /**
-     * Override default $getQueryFor method
-     */
-    $getQueryFor(action, client) {
-      const softDelete = async () => {
-        this.deletedAt = DateTime.local();
-        await this.save();
-      };
-      if (action === "delete" && !this.$forceDelete) {
-        return { del: softDelete, delete: softDelete };
-      }
-      if (action === "insert") {
-        return super.$getQueryFor(action, client);
-      }
-      return super.$getQueryFor(action, client);
-    }
-    /**
-     * Override default delete method
-     */
-    async delete() {
-      await super.delete();
-      this.$isDeleted = this.$forceDelete;
-    }
-    /**
-     * Restore model
-     */
-    async restore() {
-      if (this.$isDeleted) {
-        throw new Exception("Cannot restore a model instance is was force deleted", {
-          code: "E_MODEL_FORCE_DELETED",
-          status: 500
-        });
-      }
-      if (!this.trashed) {
-        return this;
-      }
-      this.deletedAt = null;
-      await this.save();
-      return this;
-    }
-    /**
-     * Force delete model
-     */
-    async forceDelete() {
-      this.$forceDelete = true;
-      await this.delete();
-    }
-  }
-  __decorateClass([
-    column.dateTime()
-  ], ModelWithSoftDeletes.prototype, "deletedAt", 2);
-  __decorateClass([
-    beforeFind(),
-    beforeFetch()
-  ], ModelWithSoftDeletes, "ignoreDeleted", 1);
-  __decorateClass([
-    beforePaginate()
-  ], ModelWithSoftDeletes, "ignoreDeletedPaginate", 1);
-  return ModelWithSoftDeletes;
-}
-export {
-  SoftDeletes,
-  configure
-};
-//# sourceMappingURL=index.js.map
+/*
+ * adonis-lucid-soft-deletes
+ *
+ * (c) Lookin Anton <alsd@lookinlab.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export { configure } from './configure.js';
+export { SoftDeletes } from './src/mixin.js';

package/build/providers/lucid_soft_deletes_provider.js

@@ -1,19 +1,19 @@
-import {
-  extendModelQueryBuilder
-} from "../chunk-4FLDNTDF.js";
-import "../chunk-EUXUH3YW.js";
-
-// providers/lucid_soft_deletes_provider.ts
-var LucidSoftDeletesProvider = class {
-  constructor(app) {
-    this.app = app;
-  }
-  async boot() {
-    const { ModelQueryBuilder } = await this.app.import("@adonisjs/lucid/orm");
-    extendModelQueryBuilder(ModelQueryBuilder);
-  }
-};
-export {
-  LucidSoftDeletesProvider as default
-};
-//# sourceMappingURL=lucid_soft_deletes_provider.js.map
+/*
+ * adonis-lucid-soft-deletes
+ *
+ * (c) Lookin Anton <alsd@lookinlab.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { extendModelQueryBuilder } from '../src/bindings/model_query_builder.js';
+export default class LucidSoftDeletesProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    async boot() {
+        const { ModelQueryBuilder } = await this.app.import('@adonisjs/lucid/orm');
+        extendModelQueryBuilder(ModelQueryBuilder);
+    }
+}

package/build/src/bindings/model_query_builder.js

@@ -1,8 +1,41 @@
-import {
-  extendModelQueryBuilder
-} from "../../chunk-4FLDNTDF.js";
-import "../../chunk-EUXUH3YW.js";
-export {
-  extendModelQueryBuilder
-};
-//# sourceMappingURL=model_query_builder.js.map
+/*
+ * adonis-lucid-soft-deletes
+ *
+ * (c) Lookin Anton <alsd@lookinlab.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Exception } from '@adonisjs/core/exceptions';
+/**
+ * Raises exception when model not with soft delete
+ */
+function ensureModelWithSoftDeletes(model) {
+    if (!('ignoreDeleted' in model && 'ignoreDeletedPaginate' in model)) {
+        throw new Exception(`${model.name} model don't support Soft Deletes`, {
+            code: 'E_MODEL_SOFT_DELETE',
+            status: 500,
+        });
+    }
+}
+/**
+ * Define SoftDeletes binding to ModelQueryBuilder
+ */
+export function extendModelQueryBuilder(builder) {
+    builder.macro('restore', async function () {
+        ensureModelWithSoftDeletes(this.model);
+        const deletedAtColumn = this.model.$getColumn('deletedAt')?.columnName;
+        if (!deletedAtColumn)
+            return;
+        await this.update({ [deletedAtColumn]: null });
+    });
+    builder.macro('withTrashed', function () {
+        ensureModelWithSoftDeletes(this.model);
+        return this.model.disableIgnore(this);
+    });
+    builder.macro('onlyTrashed', function () {
+        ensureModelWithSoftDeletes(this.model);
+        const deletedAtColumn = this.model.$getColumn('deletedAt')?.columnName;
+        return this.model.disableIgnore(this).whereNotNull(`${this.model.table}.${deletedAtColumn}`);
+    });
+}

package/build/src/mixin.js

@@ -0,0 +1,129 @@
+/*
+ * adonis-lucid-soft-deletes
+ *
+ * (c) Lookin Anton <alsd@lookinlab.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { DateTime } from 'luxon';
+import { Exception } from '@adonisjs/core/exceptions';
+import { column, beforeFind, beforeFetch, beforePaginate } from '@adonisjs/lucid/orm';
+export function SoftDeletes(superclass) {
+    class ModelWithSoftDeletes extends superclass {
+        static ignoreDeleted(query) {
+            if (query['ignoreDeleted'] === false) {
+                return;
+            }
+            const isGroupLimitQuery = query.clone().toQuery().includes('adonis_group_limit_counter');
+            const deletedAtColumn = query.model.$getColumn('deletedAt')?.columnName;
+            const queryIgnoreDeleted = isGroupLimitQuery
+                ? query.knexQuery['_single'].table
+                : query;
+            queryIgnoreDeleted.whereNull(`${query.model.table}.${deletedAtColumn}`);
+        }
+        static ignoreDeletedPaginate([countQuery, query]) {
+            countQuery['ignoreDeleted'] = query['ignoreDeleted'];
+            this.ignoreDeleted(countQuery);
+        }
+        static disableIgnore(query) {
+            if (query['ignoreDeleted'] === false) {
+                return query;
+            }
+            query['ignoreDeleted'] = false;
+            return query;
+        }
+        /**
+         * Fetch all models without filter by deleted_at
+         */
+        static withTrashed() {
+            const query = this.query();
+            return this.disableIgnore(query);
+        }
+        /**
+         * Fetch models only with deleted_at
+         */
+        static onlyTrashed() {
+            const query = this.query();
+            const deletedAtColumn = query.model.$getColumn('deletedAt')?.columnName;
+            return this.disableIgnore(query).whereNotNull(`${query.model.table}.${deletedAtColumn}`);
+        }
+        /**
+         * Force delete instance property
+         */
+        $forceDelete = false;
+        /**
+         * Computed trashed property
+         */
+        get trashed() {
+            return this.deletedAt !== null;
+        }
+        /**
+         * Override default $getQueryFor method
+         */
+        $getQueryFor(action, client) {
+            /**
+             * Soft Delete
+             */
+            const softDelete = async () => {
+                this.deletedAt = DateTime.local();
+                await this.save();
+            };
+            if (action === 'delete' && !this.$forceDelete) {
+                return { del: softDelete, delete: softDelete };
+            }
+            if (action === 'insert') {
+                return super.$getQueryFor(action, client);
+            }
+            return super.$getQueryFor(action, client);
+        }
+        /**
+         * Override default delete method
+         */
+        async delete() {
+            await super.delete();
+            this.$isDeleted = this.$forceDelete;
+        }
+        /**
+         * Restore model
+         */
+        async restore() {
+            if (this.$isDeleted) {
+                throw new Exception('Cannot restore a model instance is was force deleted', {
+                    code: 'E_MODEL_FORCE_DELETED',
+                    status: 500,
+                });
+            }
+            if (!this.trashed) {
+                return this;
+            }
+            this.deletedAt = null;
+            await this.save();
+            return this;
+        }
+        /**
+         * Force delete model
+         */
+        async forceDelete() {
+            this.$forceDelete = true;
+            await this.delete();
+        }
+    }
+    __decorate([
+        column.dateTime()
+    ], ModelWithSoftDeletes.prototype, "deletedAt", void 0);
+    __decorate([
+        beforeFind(),
+        beforeFetch()
+    ], ModelWithSoftDeletes, "ignoreDeleted", null);
+    __decorate([
+        beforePaginate()
+    ], ModelWithSoftDeletes, "ignoreDeletedPaginate", null);
+    return ModelWithSoftDeletes;
+}

package/build/src/types/querybuilder.js

@@ -1 +1,9 @@
-//# sourceMappingURL=querybuilder.js.map
+/*
+ * adonis-lucid-soft-deletes
+ *
+ * (c) Lookin Anton <alsd@lookinlab.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codenameryuu/adonis-lucid-soft-deletes",
-  "description": "Addon for soft deletes Adonis JS 7 Lucid ORM",
-  "version": "1.4.0",
+  "description": "Addon for soft deletes Adonis JS with Lucid ORM",
+  "version": "1.6.0",
   "author": "codenameryuu",
   "license": "MIT",
   "homepage": "https://github.com/codenameryuu/adonis-lucid-soft-deletes#readme",
@@ -29,15 +29,15 @@
     "format": "prettier --write .",
     "clean": "del-cli build",
     "precompile": "npm run lint && npm run clean",
-    "compile": "tsup-node && tsc --emitDeclarationOnly --declaration",
+    "compile": "tsc",
     "build": "npm run compile",
+    "quick:test": "NODE_DEBUG=\"adonis-lucid-soft-deletes\" node --enable-source-maps --loader=ts-node/esm bin/test.ts",
     "pretest": "npm run lint",
     "test": "c8 npm run quick:test",
     "typecheck": "tsc --noEmit",
     "version": "npm run build",
     "prepublishOnly": "npm run build",
-    "release": "np",
-    "quick:test": "NODE_DEBUG=\"adonis-lucid-soft-deletes\" node --enable-source-maps --loader=ts-node/esm bin/test.ts"
+    "release": "np"
   },
   "devDependencies": {
     "@adonisjs/assembler": "^7.7.0",
@@ -104,19 +104,5 @@
       "tests/**",
       "bin/**"
     ]
-  },
-  "tsup": {
-    "entry": [
-      "./index.ts",
-      "./src/types/*.ts",
-      "./src/bindings/model_query_builder.ts",
-      "./providers/lucid_soft_deletes_provider.ts"
-    ],
-    "outDir": "./build",
-    "clean": true,
-    "format": "esm",
-    "dts": false,
-    "sourcemap": true,
-    "target": "esnext"
   }
 }

package/build/chunk-4FLDNTDF.js

@@ -1,32 +0,0 @@
-// src/bindings/model_query_builder.ts
-import { Exception } from "@adonisjs/core/exceptions";
-function ensureModelWithSoftDeletes(model) {
-  if (!("ignoreDeleted" in model && "ignoreDeletedPaginate" in model)) {
-    throw new Exception(`${model.name} model don't support Soft Deletes`, {
-      code: "E_MODEL_SOFT_DELETE",
-      status: 500
-    });
-  }
-}
-function extendModelQueryBuilder(builder) {
-  builder.macro("restore", async function() {
-    ensureModelWithSoftDeletes(this.model);
-    const deletedAtColumn = this.model.$getColumn("deletedAt")?.columnName;
-    if (!deletedAtColumn) return;
-    await this.update({ [deletedAtColumn]: null });
-  });
-  builder.macro("withTrashed", function() {
-    ensureModelWithSoftDeletes(this.model);
-    return this.model.disableIgnore(this);
-  });
-  builder.macro("onlyTrashed", function() {
-    ensureModelWithSoftDeletes(this.model);
-    const deletedAtColumn = this.model.$getColumn("deletedAt")?.columnName;
-    return this.model.disableIgnore(this).whereNotNull(`${this.model.table}.${deletedAtColumn}`);
-  });
-}
-
-export {
-  extendModelQueryBuilder
-};
-//# sourceMappingURL=chunk-4FLDNTDF.js.map

package/build/chunk-4FLDNTDF.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/bindings/model_query_builder.ts"],"sourcesContent":["/*\n * adonis-lucid-soft-deletes\n *\n * (c) Lookin Anton <alsd@lookinlab.ru>\n *\n * For the full copyright and license information, please view the LICENSE\n * file that was distributed with this source code.\n */\n\nimport type {\n  LucidModel,\n  ModelQueryBuilderContract,\n  ModelWithSoftDeletes,\n} from '@adonisjs/lucid/types/model'\n\nimport { Exception } from '@adonisjs/core/exceptions'\n\n/**\n * Raises exception when model not with soft delete\n */\nfunction ensureModelWithSoftDeletes(model: LucidModel) {\n  if (!('ignoreDeleted' in model && 'ignoreDeletedPaginate' in model)) {\n    throw new Exception(`${model.name} model don't support Soft Deletes`, {\n      code: 'E_MODEL_SOFT_DELETE',\n      status: 500,\n    })\n  }\n}\n\n/**\n * Define SoftDeletes binding to ModelQueryBuilder\n */\nexport function extendModelQueryBuilder(builder: any) {\n  builder.macro('restore', async function (this: ModelQueryBuilderContract<LucidModel>) {\n    ensureModelWithSoftDeletes(this.model)\n\n    const deletedAtColumn = this.model.$getColumn('deletedAt')?.columnName\n    if (!deletedAtColumn) return\n\n    await this.update({ [deletedAtColumn]: null })\n  })\n\n  builder.macro('withTrashed', function (this: ModelQueryBuilderContract<ModelWithSoftDeletes>) {\n    ensureModelWithSoftDeletes(this.model)\n    return this.model.disableIgnore(this)\n  })\n\n  builder.macro('onlyTrashed', function (this: ModelQueryBuilderContract<ModelWithSoftDeletes>) {\n    ensureModelWithSoftDeletes(this.model)\n\n    const deletedAtColumn = this.model.$getColumn('deletedAt')?.columnName\n    return this.model.disableIgnore(this).whereNotNull(`${this.model.table}.${deletedAtColumn}`)\n  })\n}\n"],"mappings":";AAeA,SAAS,iBAAiB;AAK1B,SAAS,2BAA2B,OAAmB;AACrD,MAAI,EAAE,mBAAmB,SAAS,2BAA2B,QAAQ;AACnE,UAAM,IAAI,UAAU,GAAG,MAAM,IAAI,qCAAqC;AAAA,MACpE,MAAM;AAAA,MACN,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AACF;AAKO,SAAS,wBAAwB,SAAc;AACpD,UAAQ,MAAM,WAAW,iBAA6D;AACpF,+BAA2B,KAAK,KAAK;AAErC,UAAM,kBAAkB,KAAK,MAAM,WAAW,WAAW,GAAG;AAC5D,QAAI,CAAC,gBAAiB;AAEtB,UAAM,KAAK,OAAO,EAAE,CAAC,eAAe,GAAG,KAAK,CAAC;AAAA,EAC/C,CAAC;AAED,UAAQ,MAAM,eAAe,WAAiE;AAC5F,+BAA2B,KAAK,KAAK;AACrC,WAAO,KAAK,MAAM,cAAc,IAAI;AAAA,EACtC,CAAC;AAED,UAAQ,MAAM,eAAe,WAAiE;AAC5F,+BAA2B,KAAK,KAAK;AAErC,UAAM,kBAAkB,KAAK,MAAM,WAAW,WAAW,GAAG;AAC5D,WAAO,KAAK,MAAM,cAAc,IAAI,EAAE,aAAa,GAAG,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE;AAAA,EAC7F,CAAC;AACH;","names":[]}

package/build/chunk-EUXUH3YW.js

@@ -1,15 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __decorateClass = (decorators, target, key, kind) => {
-  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
-  for (var i = decorators.length - 1, decorator; i >= 0; i--)
-    if (decorator = decorators[i])
-      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
-  if (kind && result) __defProp(target, key, result);
-  return result;
-};
-
-export {
-  __decorateClass
-};
-//# sourceMappingURL=chunk-EUXUH3YW.js.map

package/build/chunk-EUXUH3YW.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/build/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../configure.ts","../src/mixin.ts"],"sourcesContent":["/*\n * adonis-lucid-soft-deletes\n *\n * (c) Lookin Anton <alsd@lookinlab.ru>\n *\n * For the full copyright and license information, please view the LICENSE\n * file that was distributed with this source code.\n */\n\nimport type Configure from '@adonisjs/core/commands/configure'\n\nexport async function configure(command: Configure) {\n  const codemods = await command.createCodemods()\n\n  await codemods.updateRcFile((rcFile) => {\n    rcFile.addProvider('@codenameryuu/adonis-lucid-soft-deletes/provider')\n  })\n}\n","/*\n * adonis-lucid-soft-deletes\n *\n * (c) Lookin Anton <alsd@lookinlab.ru>\n *\n * For the full copyright and license information, please view the LICENSE\n * file that was distributed with this source code.\n */\n\nimport { DateTime } from 'luxon'\nimport type { NormalizeConstructor } from '@adonisjs/core/types/helpers'\nimport type { LucidModel, ModelQueryBuilderContract } from '@adonisjs/lucid/types/model'\nimport type { QueryClientContract } from '@adonisjs/lucid/types/database'\nimport { Exception } from '@adonisjs/core/exceptions'\nimport { column, beforeFind, beforeFetch, beforePaginate, BaseModel } from '@adonisjs/lucid/orm'\n\ntype ModelQueryBuilderContractWithIgnoreDeleted<\n  T extends LucidModel,\n  R = InstanceType<T>,\n> = ModelQueryBuilderContract<T, R> & {\n  ignoreDeleted: boolean\n}\n\nexport function SoftDeletes<T extends NormalizeConstructor<typeof BaseModel>>(superclass: T) {\n  class ModelWithSoftDeletes extends superclass {\n    @beforeFind()\n    @beforeFetch()\n    static ignoreDeleted<Model extends typeof ModelWithSoftDeletes>(\n      query: ModelQueryBuilderContractWithIgnoreDeleted<Model, InstanceType<Model>>\n    ): void {\n      if (query['ignoreDeleted'] === false) {\n        return\n      }\n      const isGroupLimitQuery = query.clone().toQuery().includes('adonis_group_limit_counter')\n      const deletedAtColumn = query.model.$getColumn('deletedAt')?.columnName\n\n      const queryIgnoreDeleted = isGroupLimitQuery\n        ? (query.knexQuery as any)['_single'].table\n        : query\n\n      queryIgnoreDeleted.whereNull(`${query.model.table}.${deletedAtColumn}`)\n    }\n\n    @beforePaginate()\n    static ignoreDeletedPaginate<Model extends typeof ModelWithSoftDeletes>([countQuery, query]: [\n      ModelQueryBuilderContractWithIgnoreDeleted<Model, InstanceType<Model>>,\n      ModelQueryBuilderContractWithIgnoreDeleted<Model, InstanceType<Model>>,\n    ]): void {\n      countQuery['ignoreDeleted'] = query['ignoreDeleted']\n      this.ignoreDeleted(countQuery)\n    }\n\n    static disableIgnore<Model extends typeof ModelWithSoftDeletes, Result = InstanceType<Model>>(\n      this: Model,\n      query: ModelQueryBuilderContractWithIgnoreDeleted<Model, Result>\n    ): ModelQueryBuilderContractWithIgnoreDeleted<Model, Result> {\n      if (query['ignoreDeleted'] === false) {\n        return query\n      }\n      query['ignoreDeleted'] = false\n      return query\n    }\n\n    /**\n     * Fetch all models without filter by deleted_at\n     */\n    static withTrashed<Model extends typeof ModelWithSoftDeletes>(\n      this: Model\n    ): ModelQueryBuilderContractWithIgnoreDeleted<Model, InstanceType<T>> {\n      const query = this.query() as ModelQueryBuilderContractWithIgnoreDeleted<\n        Model,\n        InstanceType<Model>\n      >\n      return this.disableIgnore(query)\n    }\n\n    /**\n     * Fetch models only with deleted_at\n     */\n    static onlyTrashed<Model extends typeof ModelWithSoftDeletes>(\n      this: Model\n    ): ModelQueryBuilderContractWithIgnoreDeleted<Model, InstanceType<Model>> {\n      const query = this.query() as ModelQueryBuilderContractWithIgnoreDeleted<\n        Model,\n        InstanceType<Model>\n      >\n\n      const deletedAtColumn = query.model.$getColumn('deletedAt')?.columnName\n      return this.disableIgnore(query).whereNotNull(`${query.model.table}.${deletedAtColumn}`)\n    }\n\n    /**\n     * Force delete instance property\n     */\n    $forceDelete = false\n\n    /**\n     * Soft deleted property\n     */\n    @column.dateTime()\n    declare deletedAt?: DateTime | null\n\n    /**\n     * Computed trashed property\n     */\n    get trashed(): boolean {\n      return this.deletedAt !== null\n    }\n\n    /**\n     * Override default $getQueryFor method\n     */\n    $getQueryFor(\n      action: 'insert' | 'update' | 'delete' | 'refresh',\n      client: QueryClientContract\n    ): any {\n      /**\n       * Soft Delete\n       */\n      const softDelete = async (): Promise<void> => {\n        this.deletedAt = DateTime.local()\n        await this.save()\n      }\n\n      if (action === 'delete' && !this.$forceDelete) {\n        return { del: softDelete, delete: softDelete }\n      }\n      if (action === 'insert') {\n        return super.$getQueryFor(action, client)\n      }\n      return super.$getQueryFor(action, client)\n    }\n\n    /**\n     * Override default delete method\n     */\n    async delete(): Promise<void> {\n      await super.delete()\n      this.$isDeleted = this.$forceDelete\n    }\n\n    /**\n     * Restore model\n     */\n    async restore(): Promise<this> {\n      if (this.$isDeleted) {\n        throw new Exception('Cannot restore a model instance is was force deleted', {\n          code: 'E_MODEL_FORCE_DELETED',\n          status: 500,\n        })\n      }\n      if (!this.trashed) {\n        return this\n      }\n      this.deletedAt = null\n      await this.save()\n\n      return this\n    }\n\n    /**\n     * Force delete model\n     */\n    async forceDelete(): Promise<void> {\n      this.$forceDelete = true\n      await this.delete()\n    }\n  }\n  return ModelWithSoftDeletes\n}\n"],"mappings":";;;;;AAWA,eAAsB,UAAU,SAAoB;AAClD,QAAM,WAAW,MAAM,QAAQ,eAAe;AAE9C,QAAM,SAAS,aAAa,CAAC,WAAW;AACtC,WAAO,YAAY,kDAAkD;AAAA,EACvE,CAAC;AACH;;;ACRA,SAAS,gBAAgB;AAIzB,SAAS,iBAAiB;AAC1B,SAAS,QAAQ,YAAY,aAAa,sBAAiC;AASpE,SAAS,YAA8D,YAAe;AAAA,EAC3F,MAAM,6BAA6B,WAAW;AAAA,IAG5C,OAAO,cACL,OACM;AACN,UAAI,MAAM,eAAe,MAAM,OAAO;AACpC;AAAA,MACF;AACA,YAAM,oBAAoB,MAAM,MAAM,EAAE,QAAQ,EAAE,SAAS,4BAA4B;AACvF,YAAM,kBAAkB,MAAM,MAAM,WAAW,WAAW,GAAG;AAE7D,YAAM,qBAAqB,oBACtB,MAAM,UAAkB,SAAS,EAAE,QACpC;AAEJ,yBAAmB,UAAU,GAAG,MAAM,MAAM,KAAK,IAAI,eAAe,EAAE;AAAA,IACxE;AAAA,IAGA,OAAO,sBAAiE,CAAC,YAAY,KAAK,GAGjF;AACP,iBAAW,eAAe,IAAI,MAAM,eAAe;AACnD,WAAK,cAAc,UAAU;AAAA,IAC/B;AAAA,IAEA,OAAO,cAEL,OAC2D;AAC3D,UAAI,MAAM,eAAe,MAAM,OAAO;AACpC,eAAO;AAAA,MACT;AACA,YAAM,eAAe,IAAI;AACzB,aAAO;AAAA,IACT;AAAA;AAAA;AAAA;AAAA,IAKA,OAAO,cAE+D;AACpE,YAAM,QAAQ,KAAK,MAAM;AAIzB,aAAO,KAAK,cAAc,KAAK;AAAA,IACjC;AAAA;AAAA;AAAA;AAAA,IAKA,OAAO,cAEmE;AACxE,YAAM,QAAQ,KAAK,MAAM;AAKzB,YAAM,kBAAkB,MAAM,MAAM,WAAW,WAAW,GAAG;AAC7D,aAAO,KAAK,cAAc,KAAK,EAAE,aAAa,GAAG,MAAM,MAAM,KAAK,IAAI,eAAe,EAAE;AAAA,IACzF;AAAA;AAAA;AAAA;AAAA,IAKA,eAAe;AAAA;AAAA;AAAA;AAAA,IAWf,IAAI,UAAmB;AACrB,aAAO,KAAK,cAAc;AAAA,IAC5B;AAAA;AAAA;AAAA;AAAA,IAKA,aACE,QACA,QACK;AAIL,YAAM,aAAa,YAA2B;AAC5C,aAAK,YAAY,SAAS,MAAM;AAChC,cAAM,KAAK,KAAK;AAAA,MAClB;AAEA,UAAI,WAAW,YAAY,CAAC,KAAK,cAAc;AAC7C,eAAO,EAAE,KAAK,YAAY,QAAQ,WAAW;AAAA,MAC/C;AACA,UAAI,WAAW,UAAU;AACvB,eAAO,MAAM,aAAa,QAAQ,MAAM;AAAA,MAC1C;AACA,aAAO,MAAM,aAAa,QAAQ,MAAM;AAAA,IAC1C;AAAA;AAAA;AAAA;AAAA,IAKA,MAAM,SAAwB;AAC5B,YAAM,MAAM,OAAO;AACnB,WAAK,aAAa,KAAK;AAAA,IACzB;AAAA;AAAA;AAAA;AAAA,IAKA,MAAM,UAAyB;AAC7B,UAAI,KAAK,YAAY;AACnB,cAAM,IAAI,UAAU,wDAAwD;AAAA,UAC1E,MAAM;AAAA,UACN,QAAQ;AAAA,QACV,CAAC;AAAA,MACH;AACA,UAAI,CAAC,KAAK,SAAS;AACjB,eAAO;AAAA,MACT;AACA,WAAK,YAAY;AACjB,YAAM,KAAK,KAAK;AAEhB,aAAO;AAAA,IACT;AAAA;AAAA;AAAA;AAAA,IAKA,MAAM,cAA6B;AACjC,WAAK,eAAe;AACpB,YAAM,KAAK,OAAO;AAAA,IACpB;AAAA,EACF;AAnEU;AAAA,IADP,OAAO,SAAS;AAAA,KA3Eb,qBA4EI;AAzED;AAAA,IAFN,WAAW;AAAA,IACX,YAAY;AAAA,KAFT,sBAGG;AAiBA;AAAA,IADN,eAAe;AAAA,KAnBZ,sBAoBG;AA4HT,SAAO;AACT;","names":[]}

package/build/providers/lucid_soft_deletes_provider.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../providers/lucid_soft_deletes_provider.ts"],"sourcesContent":["/*\n * adonis-lucid-soft-deletes\n *\n * (c) Lookin Anton <alsd@lookinlab.ru>\n *\n * For the full copyright and license information, please view the LICENSE\n * file that was distributed with this source code.\n */\n\n/// <reference path=\"../src/types/querybuilder.ts\" />\n\nimport type { ApplicationService } from '@adonisjs/core/types'\nimport { extendModelQueryBuilder } from '../src/bindings/model_query_builder.js'\n\nexport default class LucidSoftDeletesProvider {\n  constructor(protected app: ApplicationService) {}\n\n  async boot() {\n    const { ModelQueryBuilder } = await this.app.import('@adonisjs/lucid/orm')\n    extendModelQueryBuilder(ModelQueryBuilder)\n  }\n}\n"],"mappings":";;;;;;AAcA,IAAqB,2BAArB,MAA8C;AAAA,EAC5C,YAAsB,KAAyB;AAAzB;AAAA,EAA0B;AAAA,EAEhD,MAAM,OAAO;AACX,UAAM,EAAE,kBAAkB,IAAI,MAAM,KAAK,IAAI,OAAO,qBAAqB;AACzE,4BAAwB,iBAAiB;AAAA,EAC3C;AACF;","names":[]}

package/build/src/bindings/model_query_builder.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/build/src/types/querybuilder.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}