Refactor service schema interfaces and update type definitions for improved type safety

Author: tacxou

src/_common/abstracts/interfaces/service.schema.interface.ts

@@ -2,6 +2,7 @@ import {
   Document,
   FilterQuery,
   ModifyResult,
+  MongooseBaseQueryOptions,
   ProjectionType,
   Query,
   QueryOptions,
@@ -10,6 +11,7 @@ import {
   UpdateQuery,
 } from 'mongoose';
 import { AbstractSchema } from '../schemas/abstract.schema';
+import mongodb from 'mongodb';
 
 export interface ServiceSchemaInterface {
   /* eslint-disable */
@@ -19,7 +21,7 @@ export interface ServiceSchemaInterface {
     options?: QueryOptions<T> | null | undefined,
   ): Promise<Query<Array<T>, T, any, T>[]>
 
-  count<T extends AbstractSchema | Document>(filter?: FilterQuery<T>, options?: QueryOptions<T> | null | undefined): Promise<number>
+  count<T extends AbstractSchema | Document>(filter?: FilterQuery<T>, options?: (mongodb.CountOptions & MongooseBaseQueryOptions<T>) | null): Promise<number>
 
   findAndCount<T extends AbstractSchema | Document>(
     filter?: FilterQuery<T>,

src/_common/abstracts/schemas/abstract.schema.ts

@@ -3,7 +3,7 @@ import { Types, Document } from 'mongoose';
 import { MetadataPart, MetadataPartSchema } from '~/_common/abstracts/schemas/parts/metadata.part.schema';
 
 export abstract class AbstractSchema extends Document {
-  public readonly _id?: Types.ObjectId | any // eslint-disable-line
+  public readonly _id: Types.ObjectId | any // eslint-disable-line
 
   @Prop({ type: MetadataPartSchema })
   public metadata?: MetadataPart;

src/core/filestorage/filestorage.service.ts

@@ -98,9 +98,9 @@ export class FilestorageService extends AbstractServiceSchema {
       return {
         ...data.toObject(),
         _exists: storageRequest.exists,
-      }
+      } as any
     }
-    return data.toObject()
+    return data.toObject() as any
   }
 
   public async findByIdWithRawData<T extends Filestorage | Document>(
@@ -128,9 +128,9 @@ export class FilestorageService extends AbstractServiceSchema {
       return {
         ...data.toObject(),
         _exists: storageRequest.exists,
-      }
+      } as any
     }
-    return data.toObject()
+    return data.toObject() as any
   }
 
   public async findOneWithRawData<T extends Filestorage | Document>(
@@ -183,7 +183,7 @@ export class FilestorageService extends AbstractServiceSchema {
   ) {
     let stored: Document<any, any, Filestorage> & Filestorage
     try {
-      stored = await this.findOne<Filestorage>(filter, options)
+      stored = (await this.findOne<Filestorage>(filter, options)) as any
     } catch (e) {
       if (e.status !== HttpStatus.NOT_FOUND) throw e
     }

src/core/keyrings/keyrings.service.ts

@@ -5,14 +5,15 @@ import { Model, SaveOptions, Document } from 'mongoose';
 import { AbstractServiceSchema } from '~/_common/abstracts/abstract.service.schema';
 import { KeyringsCreateDto } from './_dto/keyrings.dto';
 import { randomBytes } from 'node:crypto';
+import { AbstractSchema } from '~/_common/abstracts/schemas/abstract.schema';
 
 @Injectable()
 export class KeyringsService extends AbstractServiceSchema {
   constructor(@InjectModel(Keyrings.name) protected _model: Model<Keyrings>) {
     super();
   }
 
-  public async create<T extends Keyrings | Document>(
+  public async create<T extends AbstractSchema | Document>(
     data?: KeyringsCreateDto,
     options?: SaveOptions,
   ): Promise<Document<T, any, T>> {

src/management/identities/_dto/_parts/additionalFields.dto.ts

@@ -11,14 +11,14 @@ export class additionalFieldsPartDto {
   public objectClasses: string[] = [];
 
   @ApiProperty({
-    type: 'object',
+    type: Object,
     name: 'attributes',
   })
   @IsOptional()
   public attributes: { [key: string]: any } = {};
 
   @ApiProperty({
-    type: 'object',
+    type: Object,
     name: 'validations',
   })
   public validations?: { [key: string]: { [key: string]: string } };

src/management/identities/identities-crud.controller.ts

@@ -86,7 +86,7 @@ export class IdentitiesCrudController extends AbstractController {
     const data = await this._service.create<Identities>(body);
     // If the state is TO_COMPLETE, the identity is created but additional fields are missing or invalid
     // Else the state is TO_VALIDATE, we return a 201 status code
-    if ((data as Identities).state === IdentityState.TO_COMPLETE) {
+    if (data.toObject().state === IdentityState.TO_COMPLETE) {
       statusCode = HttpStatus.ACCEPTED;
       message = 'Identitée créée avec succès, mais des champs additionnels sont manquants ou invalides.';
     }
@@ -234,7 +234,7 @@ export class IdentitiesCrudController extends AbstractController {
   public async updateStateMany(
     @Res() res: Response,
     @Body()
-      body: {
+    body: {
       originState: IdentityState;
       targetState: IdentityState;
       ids: Types.ObjectId[];