@bleco/soft-delete NPM

@bleco/soft-delete

A loopback-next extension for soft delete feature
This package is initial forked from loopback4-soft-delete

Install

npm install @bleco/soft-delete

NOTE - With latest version 3.0.0, you also need to install @bleco/authentication for using deleted_by feature added.

npm install @bleco/soft-delete

Quick Starter

For a quick starter guide, you can refer to our loopback 4 starter application which utilizes this package for soft-deletes in a multi-tenant application.

Transaction support

With version 3.0.0, transaction repository support has been added. In place of DefaultSoftCrudRepository, extend your repository with DefaultTransactionSoftCrudRepository. For further usage guidelines, refer below.

Usage

Right now, this extension exports three abstract classes which are actually helping with soft delete operations.

SoftDeleteEntity - An abstract base class for all models which require soft delete feature. This class is a wrapper over Entity class from @loopback/repository adding three attributes to the model class for handling soft-delete, namely, deleted, deletedAt, deletedBy. The column names needed to be there in DB within that table are - 'deleted', 'deleted_at', 'deleted_by'. If you are using auto-migration of loopback 4, then, you may not need to do anything specific to add this column. If not, then please add these columns to the DB table.
DefaultSoftCrudRepository - An abstract base class for all repositories which require soft delete feature. This class is going to be the one which handles soft delete operations and ensures soft deleted entries are not returned in responses, However if there is a need to query soft deleted entries as well,there is an options to achieve that and you can use findAll() in place of find() , findOneIncludeSoftDelete() in place of findOne() and findByIdIncludeSoftDelete() in place of findById(), these will give you the responses including soft deleted entries. This class is a wrapper over DefaultCrudRepository class from @loopback/repository.
DefaultTransactionSoftCrudRepository - An abstract base class for all repositories which require soft delete feature with transaction support. This class is going to be the one which handles soft delete operations and ensures soft deleted entries are not returned in responses, However if there is a need to query soft deleted entries as well,there is an options to achieve that and you can use findAll() in place of find() , findOneIncludeSoftDelete() in place of findOne() and findByIdIncludeSoftDelete() in place of findById(), these will give you the responses including soft deleted entries. This class is a wrapper over DefaultTransactionalRepository class from @loopback/repository.

In order to use this extension in your LB4 application, please follow below steps.

Extend models with SoftDeleteEntity class replacing Entity. For example,

import {SoftDeleteEntity} from '@bleco/soft-delete';
import {model, property} from '@loopback/repository';

@model({
  name: 'users',
})
export class User extends SoftDeleteEntity {
  @property({
    type: 'number',
    id: true,
  })
  id?: number;

  // .... More properties
}

Extend repositories with DefaultSoftCrudRepository class replacing DefaultCrudRepository. For example,

import {AuthenticationBindings, IAuthUser} from '@bleco/authentication';
import {DefaultSoftCrudRepository} from '@bleco/soft-delete';
import {Getter, inject} from '@loopback/core';

import {PgdbDataSource} from '../datasources';
import {User, UserRelations} from '../models';

export class UserRepository extends DefaultSoftCrudRepository<User, typeof User.prototype.id, UserRelations> {
  constructor(
    @inject('datasources.pgdb') dataSource: PgdbDataSource,
    @inject.getter(AuthenticationBindings.CURRENT_USER, {optional: true})
    protected readonly getCurrentUser: Getter<IAuthUser | undefined>,
  ) {
    super(User, dataSource, getCurrentUser);
  }
}

For transaction support, extend repositories with DefaultTransactionSoftCrudRepository class replacing DefaultTransactionalRepository. For example,

import {AuthenticationBindings, IAuthUser} from '@bleco/authentication';
import {DefaultSoftCrudRepository} from '@bleco/soft-delete';
import {Getter, inject} from '@loopback/core';

import {PgdbDataSource} from '../datasources';
import {User, UserRelations} from '../models';

export class UserRepository extends DefaultTransactionSoftCrudRepository<
  User,
  typeof User.prototype.id,
  UserRelations
> {
  constructor(
    @inject('datasources.pgdb') dataSource: PgdbDataSource,
    @inject.getter(AuthenticationBindings.CURRENT_USER, {optional: true})
    protected readonly getCurrentUser: Getter<IAuthUser | undefined>,
  ) {
    super(User, dataSource, getCurrentUser);
  }
}

Feedback

If you've noticed a bug or have a question or have a feature request, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please star it. Appreciation really helps in keeping this project alive.