Nutella Pancake Machine

    loopback4-meta-info
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.1 • Public • Published

    loopback4-soft-delete

    LoopBack

    Node version Dependencies Status Loopback Core Version Loopback Build Version npm vulnerabilities

    Latest version License Downloads Total Downloads

    Install

    npm install loopback4-meta-info

    NOTE - It only support loopback4.

    npm install loopback4-meta-info

    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 SoftCrudRepository, 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.

    • MetaEntity - 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, deletedOn, deletedBy, and some meta createdBy, updatedBy, createdOn, updatedOn The column names needed to be there in DB within that table are - 'created_on', 'created_by', 'updated_on', 'updated_by','deleted', 'deleted_on', '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.
    • SoftMetaCrudRepository - 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.

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

    1. Extend models with SoftDeleteEntity class replacing Entity. For example,
    import {model, property} from '@loopback/repository';
    import {SoftMetaCrudRepository} from 'loopback4-meta-info';
    
    @model({
      name: 'users',
    })
    export class User extends SoftMetaCrudRepository {
      @property({
        type: 'number',
        id: true,
      })
      id?: number;
    
      // .... More properties
    }
    1. Extend repositories with SoftMetaCrudRepository class replacing DefaultCrudRepository. For example,
    import {Getter, inject} from '@loopback/core';
    import {SoftCrudRepository} from 'loopback4-meta-info';
    import {SecurityBindings, securityId, UserProfile} from '@loopback/security';
    
    import {PgdbDataSource} from '../datasources';
    import {User, UserRelations} from '../models';
    
    export class UserRepository extends SoftMetaCrudRepository<
      User,
      typeof User.prototype.id,
      UserRelations
    > {
      constructor(
        @inject('datasources.pgdb') dataSource: PgdbDataSource,
        @inject.getter(SecurityBindings.USER, {optional: true})
        protected readonly getCurrentUser: Getter< UserProfile | undefined>,
      ) {
        super(User, dataSource, getCurrentUser);
      }
    }

    License

    MIT

    Install

    npm i loopback4-meta-info

    DownloadsWeekly Downloads

    9

    Version

    1.4.1

    License

    MIT

    Unpacked Size

    61.6 kB

    Total Files

    38

    Last publish

    Collaborators

    • vn.chemgio