
Security News
vlt Launches "reproduce": A New Tool Challenging the Limits of Package Provenance
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
loopback4-soft-delete
Advanced tools
npm install loopback4-soft-delete
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.
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.
Right now, this extension exports three abstract classes which are actually helping with soft delete operations.
In order to use this extension in your LB4 application, please follow below steps.
import {model, property} from '@loopback/repository';
import {SoftDeleteEntity} from 'loopback4-soft-delete';
@model({
name: 'users',
})
export class User extends SoftDeleteEntity {
@property({
type: 'number',
id: true,
})
id?: number;
// .... More properties
}
import {Getter, inject} from '@loopback/core';
import {SoftCrudRepository} from 'loopback4-soft-delete';
import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
import {PgdbDataSource} from '../datasources';
import {User, UserRelations} from '../models';
export class UserRepository extends SoftCrudRepository<
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);
}
}
import {Getter, inject} from '@loopback/core';
import {SoftCrudRepository} from 'loopback4-soft-delete';
import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
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);
}
}
The package also provides the following mixins which can be used for soft delete functionality:
interface IBaseEntity {
deleted?: boolean;
deletedOn?: Date;
deletedBy?: string;
}
There is also an option to provide config for the @property decorator for all these properties. Usage of SoftDeleteEntityMixin is as follows:
class Item extends Entity {
@property({
type: 'number',
id: true,
generated: true,
})
id?: number;
@property({
type: 'string',
required: true,
})
name: string;
constructor(data?: Partial<Item>) {
super(data);
}
}
@model()
export class ItemSoftDelete extends SoftDeleteEntityMixin(Item, {
deletedBy: {name: 'deleted_by_userid'},
}) {}
import {Constructor, Getter, inject} from '@loopback/core';
import {DefaultCrudRepository} from '@loopback/repository';
import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
import {SoftCrudRepositoryMixin} from 'loopback4-soft-delete';
import {TestDataSource} from '../datasources';
import {ItemSoftDelete, ItemSoftDeleteRelations} from '../models';
export class ItemRepository extends SoftCrudRepositoryMixin<
ItemSoftDelete,
typeof ItemSoftDelete.prototype.id,
Constructor<
DefaultCrudRepository<
ItemSoftDelete,
typeof ItemSoftDelete.prototype.id,
ItemSoftDeleteRelations
>
>,
ItemSoftDeleteRelations
>(DefaultCrudRepository) {
constructor(
@inject('datasources.test') dataSource: TestDataSource,
@inject.getter(AuthenticationBindings.CURRENT_USER)
public getCurrentUser: Getter<IAuthUser>,
) {
super(ItemSoftDelete, dataSource);
}
}
Whenever any entry is deleted using deleteById, delete and deleteAll repository methods, it also sets deletedBy column with a value with user id whoever is logged in currently. Hence it uses a Getter function of IUser type. However, if you want to use some other attribute of user model other than id, you can do it by overriding deletedByIdKey. Here is an example.
import {Getter, inject} from '@loopback/core';
import {SoftCrudRepository, IUser} from 'loopback4-soft-delete';
import {AuthenticationBindings} from 'loopback4-authentication';
import {PgdbDataSource} from '../datasources';
import {User, UserRelations} from '../models';
export class UserRepository extends SoftCrudRepository<
User,
typeof User.prototype.id,
UserRelations
> {
constructor(
@inject('datasources.pgdb') dataSource: PgdbDataSource,
@inject.getter(AuthenticationBindings.CURRENT_USER, {optional: true})
protected readonly getCurrentUser: Getter<User | undefined>,
) {
super(User, dataSource, getCurrentUser);
}
}
Model class for custom identifier case. Notice the getIdentifier() method
and IUser
interface implemented.
@model()
class User extends SoftDeleteEntity implements IUser {
@property({
id: true,
})
id: string;
@property()
username: string;
getIdentifier() {
return this.username;
}
constructor(data?: Partial<User>) {
super(data);
}
}
Release v7.1.2 February 17, 2023
Welcome to the February 17, 2023 release of loopback4-soft-delete. There are many updates in this version that we hope you will like, the key highlights include:
Package Update - loopback4-soft-delete :- remove all current vulnerability of loopback4-soft-delete was commited on February 17, 2023 by Sunny Tyagi
remove all current vulnerability
GH-125
loopback version update
GH-125
Correction to the changelog format :- fix(chore): corrected the issue number was commited on February 15, 2023 by yeshamavani
now will show correct issue description as well
GH-123
Clink on the above links to understand the changes in detail.
FAQs
A loopback-next extension for soft delete feature.
The npm package loopback4-soft-delete receives a total of 960 weekly downloads. As such, loopback4-soft-delete popularity was classified as not popular.
We found that loopback4-soft-delete demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.