feat(repository): feat(repository): add undo soft delete feature

add undo soft delete functionalities =undoById and undoByAll

GH-182

src/models/soft-delete-entity.ts

@@ -23,7 +23,7 @@ export abstract class SoftDeleteEntity extends Entity {
       nullable: true,
     },
   })
-  deletedOn?: Date;
+  deletedOn?: Date | undefined;
 
   @property({
     type: 'string',
@@ -34,6 +34,15 @@ export abstract class SoftDeleteEntity extends Entity {
   })
   deletedBy?: string;
 
+  @property({
+    type: 'string',
+    name: 'modified_by',
+    jsonSchema: {
+      nullable: true,
+    },
+  })
+  modifiedBy?: string;
+
   constructor(data?: Partial<SoftDeleteEntity>) {
     super(data);
   }

src/repositories/soft-crud.repository.base.ts

@@ -168,6 +168,39 @@ export abstract class SoftCrudRepository<
     );
   }
 
+  /**
+   * Method to perform undo the soft delete by Id.
+   * @param id
+   * @param options
+   */
+  async undoSoftDeleteById(id: ID, options?: Options): Promise<void> {
+    const modifiedBy = await this.getUserId(this.getCurrentUser);
+    return super.updateById(
+      id,
+      {
+        deleted: false,
+        deletedOn: undefined,
+        modifiedBy,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Method to perform undo all the soft deletes
+   * @param id
+   * @param options
+   */
+  async undoSoftDeleteAll(where?: Where<E>, options?: Options): Promise<Count> {
+    const modifiedBy = await this.getUserId(this.getCurrentUser);
+    const dataToUpdate: DataObject<E> = {
+      deleted: false,
+      deletedOn: undefined,
+      modifiedBy,
+    };
+    return super.updateAll(dataToUpdate, where, options);
+  }
+
   /**
    * Method to perform hard delete of entries. Take caution.
    * @param entity

src/types.ts

@@ -30,12 +30,14 @@ export interface IBaseEntityConfig {
   deleted?: Partial<PropertyDefinition>;
   deletedOn?: Partial<PropertyDefinition>;
   deletedBy?: Partial<PropertyDefinition>;
+  modifiedBy?: Partial<PropertyDefinition>;
 }
 
 export interface IBaseEntity {
   deleted?: boolean;
-  deletedOn?: Date;
+  deletedOn?: Date | undefined;
   deletedBy?: string;
+  modifiedBy?: string;
 }
 
 export interface ISoftCrudRepositoryMixin<E extends object, ID, R> {