fix(repository): type mismatch for Iauthuser

gh-0

Author: Samarpan Bhattacharya

README.md

@@ -197,7 +197,7 @@ Whenever any entry is deleted using deleteById, delete and deleteAll repository
 
 ```ts
 import {Getter, inject} from '@loopback/core';
-import {SoftCrudRepository} from 'loopback4-soft-delete';
+import {SoftCrudRepository, IUser} from 'loopback4-soft-delete';
 import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
 
 import {PgdbDataSource} from '../datasources';
@@ -211,10 +211,10 @@ export class UserRepository extends SoftCrudRepository<
   constructor(
     @inject('datasources.pgdb') dataSource: PgdbDataSource,
     @inject.getter(AuthenticationBindings.CURRENT_USER, {optional: true})
-    protected readonly getCurrentUser: Getter<IAuthUser | undefined>,
+    protected readonly getCurrentUser: Getter<(IAuthUser & IUser) | undefined>,
     protected readonly deletedByIdKey: string = 'userTenantId',
   ) {
-    super(User, dataSource, getCurrentUser);
+    super(User, dataSource, getCurrentUser, deletedByIdKey);
   }
 }
 ```

src/__tests__/unit/mixin/soft-crud.mixin.unit.ts

@@ -18,7 +18,7 @@ import {
 import {fail} from 'assert';
 import {SoftCrudRepositoryMixin} from '../../..';
 import {SoftDeleteEntity} from '../../../models';
-import {IAuthUser} from '../../../types';
+import {IUser} from '../../../types';
 
 /**
  * A mock up model class
@@ -56,7 +56,7 @@ class CustomerCrudRepo extends SoftCrudRepositoryMixin<
       prototype: Customer;
     },
     dataSource: juggler.DataSource,
-    readonly getCurrentUser: Getter<IAuthUser | undefined>,
+    readonly getCurrentUser: Getter<IUser | undefined>,
   ) {
     super(entityClass, dataSource, getCurrentUser);
   }
@@ -75,7 +75,7 @@ class Customer2CrudRepo extends SoftCrudRepositoryMixin<
       prototype: Customer;
     },
     dataSource: juggler.DataSource,
-    readonly getCurrentUser: Getter<IAuthUser | undefined>,
+    readonly getCurrentUser: Getter<IUser | undefined>,
     readonly deletedByIdKey: string = 'id',
   ) {
     super(entityClass, dataSource, getCurrentUser);

src/__tests__/unit/mixin/soft-delete-entity.mixin.unit.ts

@@ -17,7 +17,7 @@ import {
 
 import {PropertyDefinition} from 'loopback-datasource-juggler';
 import {SoftCrudRepositoryMixin, SoftDeleteEntityMixin} from '../../..';
-import {IAuthUser} from '../../../types';
+import {IUser} from '../../../types';
 /**
  * A mock up model class
  */
@@ -80,7 +80,7 @@ class CustomerCrudRepo extends SoftCrudRepositoryMixin<
 >(DefaultTransactionalRepository) {
   constructor(
     dataSource: juggler.DataSource,
-    readonly getCurrentUser: Getter<IAuthUser | undefined>,
+    readonly getCurrentUser: Getter<IUser | undefined>,
   ) {
     super(CustomerSoftDelete, dataSource);
   }

src/__tests__/unit/repository/default-transaction-soft-crud.repository.base.ts

@@ -16,7 +16,7 @@ import {
 import {fail} from 'assert';
 import {SoftDeleteEntity} from '../../../models';
 import {DefaultTransactionSoftCrudRepository} from '../../../repositories';
-import {IAuthUser} from '../../../types';
+import {IUser} from '../../../types';
 
 /**
  * A mock up model class
@@ -50,7 +50,7 @@ class CustomerCrudRepo extends DefaultTransactionSoftCrudRepository<
       prototype: Customer;
     },
     dataSource: juggler.DataSource,
-    protected readonly getCurrentUser?: Getter<IAuthUser | undefined>,
+    protected readonly getCurrentUser?: Getter<IUser | undefined>,
   ) {
     super(entityClass, dataSource, getCurrentUser);
   }
@@ -65,7 +65,7 @@ class Customer2CrudRepo extends DefaultTransactionSoftCrudRepository<
       prototype: Customer2;
     },
     dataSource: juggler.DataSource,
-    protected readonly getCurrentUser?: Getter<IAuthUser | undefined>,
+    protected readonly getCurrentUser?: Getter<IUser | undefined>,
     protected readonly deletedByIdKey: string = 'id',
   ) {
     super(entityClass, dataSource, getCurrentUser);

src/__tests__/unit/repository/soft-crud.repository.unit.ts

@@ -16,7 +16,7 @@ import {
 import {fail} from 'assert';
 import {SoftDeleteEntity} from '../../../models';
 import {SoftCrudRepository} from '../../../repositories';
-import {IAuthUser} from '../../../types';
+import {IUser} from '../../../types';
 
 /**
  * A mock up model class
@@ -47,7 +47,7 @@ class CustomerCrudRepo extends SoftCrudRepository<Customer, number> {
       prototype: Customer;
     },
     dataSource: juggler.DataSource,
-    protected readonly getCurrentUser?: Getter<IAuthUser | undefined>,
+    protected readonly getCurrentUser?: Getter<IUser | undefined>,
   ) {
     super(entityClass, dataSource, getCurrentUser);
   }
@@ -59,7 +59,7 @@ class Customer2CrudRepo extends SoftCrudRepository<Customer2, number> {
       prototype: Customer;
     },
     dataSource: juggler.DataSource,
-    protected readonly getCurrentUser?: Getter<IAuthUser | undefined>,
+    protected readonly getCurrentUser?: Getter<IUser | undefined>,
     protected readonly deletedByIdKey: string = 'id',
   ) {
     super(entityClass, dataSource, getCurrentUser);

src/index.ts

@@ -1,4 +1,6 @@
 export * from './component';
-export * from './repositories';
-export * from './models';
+export * from './error-keys';
 export * from './mixins';
+export * from './models';
+export * from './repositories';
+export * from './types';

src/mixins/soft-crud.repository.mixin.ts

@@ -17,9 +17,9 @@ import {ErrorKeys} from '../error-keys';
 import {SoftDeleteEntity} from '../models';
 import {
   AbstractConstructor,
-  IAuthUser,
   IBaseEntity,
   ISoftCrudRepositoryMixin,
+  IUser,
 } from '../types';
 
 export function SoftCrudRepositoryMixin<
@@ -34,7 +34,7 @@ export function SoftCrudRepositoryMixin<
     extends base
     implements ISoftCrudRepositoryMixin<E, ID, R>
   {
-    getCurrentUser: Getter<IAuthUser | undefined>;
+    getCurrentUser: Getter<IUser | undefined>;
     deletedByIdKey = 'id';
 
     find(filter?: Filter<E>, options?: Options): Promise<(E & R)[]> {
@@ -335,7 +335,7 @@ export function SoftCrudRepositoryMixin<
       if (!currentUser) {
         return undefined;
       }
-      return currentUser[this.deletedByIdKey]?.toString();
+      return currentUser[this.deletedByIdKey] as string;
     }
   }
   return SoftCrudRepository;

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

@@ -15,7 +15,7 @@ import {HttpErrors} from '@loopback/rest';
 import {Options} from 'loopback-datasource-juggler';
 import {ErrorKeys} from '../error-keys';
 import {SoftDeleteEntity} from '../models';
-import {IAuthUser} from '../types';
+import {IUser} from '../types';
 
 export abstract class DefaultTransactionSoftCrudRepository<
   T extends SoftDeleteEntity,
@@ -27,7 +27,7 @@ export abstract class DefaultTransactionSoftCrudRepository<
       prototype: T;
     },
     dataSource: juggler.DataSource,
-    protected readonly getCurrentUser?: Getter<IAuthUser | undefined>,
+    protected readonly getCurrentUser?: Getter<IUser | undefined>,
     protected readonly deletedByIdKey: string = 'id',
   ) {
     super(entityClass, dataSource);
@@ -320,6 +320,6 @@ export abstract class DefaultTransactionSoftCrudRepository<
     if (!currentUser) {
       return undefined;
     }
-    return currentUser[this.deletedByIdKey]?.toString();
+    return currentUser[this.deletedByIdKey] as string;
   }
 }

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

@@ -16,7 +16,7 @@ import {AnyObject, Options} from 'loopback-datasource-juggler';
 
 import {ErrorKeys} from '../error-keys';
 import {SoftDeleteEntity} from '../models';
-import {IAuthUser} from '../types';
+import {IUser} from '../types';
 
 export abstract class SoftCrudRepository<
   T extends SoftDeleteEntity,
@@ -28,7 +28,7 @@ export abstract class SoftCrudRepository<
       prototype: T;
     },
     dataSource: juggler.DataSource,
-    protected readonly getCurrentUser?: Getter<IAuthUser | undefined>,
+    protected readonly getCurrentUser?: Getter<IUser | undefined>,
     protected readonly deletedByIdKey: string = 'id',
   ) {
     super(entityClass, dataSource);
@@ -354,6 +354,6 @@ export abstract class SoftCrudRepository<
     if (!currentUser) {
       return undefined;
     }
-    return currentUser[this.deletedByIdKey]?.toString();
+    return currentUser[this.deletedByIdKey] as string;
   }
 }

src/types.ts

@@ -12,9 +12,9 @@ import {
 export type AbstractConstructor<T> = abstract new (...args: any[]) => T;
 // sonarignore:end
 
-export interface IAuthUser {
+export interface IUser {
   id?: number | string;
-  [key: string]: number | string | undefined;
+  [key: string]: unknown;
 }
 
 export interface IBaseEntityConfig {
@@ -30,7 +30,7 @@ export interface IBaseEntity {
 }
 
 export interface ISoftCrudRepositoryMixin<E extends object, ID, R> {
-  getCurrentUser: Getter<IAuthUser | undefined>;
+  getCurrentUser: Getter<IUser | undefined>;
   findAll(filter?: Filter<E>, options?: Options): Promise<(E & R)[]>;
   deleteHard(entity: E, options?: Options): Promise<void>;
   deleteByIdHard(id: ID, options?: Options): Promise<void>;