Soft delete trait for Adonis 4.

AdonisJs - SoftDelete.js

// $ adonis make:trait SoftDelete

class SoftDelete {
  register (Model, customOptions = {}) {
    const deletedAtColumn = customOptions.name || `${Model.table}.deleted_at`;

    Model.addGlobalScope(builder => {
      builder.whereNull(deletedAtColumn);
    }, 'soft_delete');

    Model.queryMacro('withTrashed', function () {
      this.ignoreScopes(['soft_delete']);
      return this;
    });

    Model.queryMacro('onlyTrashed', function () {
      this.ignoreScopes(['soft_delete']);
      this.whereNotNull(deletedAtColumn);
      return this;
    });

    Model.prototype.delete = async () => {
      this[deletedAtColumn] = new Date();
      await this.save();
    };

    Model.prototype.restore = async () => {
      this[deletedAtColumn] = null;
      await this.save();
    };

    Model.prototype.forceDelete = async () => {
      await Model.query()
        .where(Model.primaryKey, this[Model.primaryKey])
        .ignoreScopes()
        .delete();
    };
  }
}

module.exports = SoftDelete