feat(): distinct interfaces (#203)

sinuoslabs · Jul 4, 2022 · 6a0f998 · 6a0f998
1 parent 5eeb7a4
commit 6a0f998
Show file tree

Hide file tree

Showing 4 changed files with 14,022 additions and 52 deletions.
diff --git a/lib/interfaces/hasher-module.interface.ts b/lib/interfaces/hasher-module.interface.ts
@@ -8,7 +8,10 @@ export type HasherProviderType = 'bcrypt' | 'argon';
  * @property createHasherOptions()
  */
 export interface HasherModuleOptionsFactory {
-  createHasherOptions(): Promise<HasherModuleOptions> | HasherModuleOptions;
+  createHasherOptions():
+    | Promise<HasherBcryptModuleOptions | HasherArgonModuleOptions>
+    | HasherBcryptModuleOptions
+    | HasherArgonModuleOptions;
 }
 
 /**
@@ -26,17 +29,29 @@ export interface HasherModuleAsyncOptions
   useClass?: Type<HasherModuleOptionsFactory>;
   useFactory?: (
     ...args: any[]
-  ) => Promise<HasherModuleOptions> | HasherModuleOptions;
+  ) =>
+    | Promise<HasherBcryptModuleOptions | HasherArgonModuleOptions>
+    | HasherBcryptModuleOptions
+    | HasherArgonModuleOptions;
   inject?: any[];
   extraProviders?: Provider[];
 }
 
 /**
- * @interface HasherModuleOptions
+ * @interface HasherBcryptModuleOptions
  * @property {HasherProviderType} provider
  * @property {number} round
  */
-export interface HasherModuleOptions {
-  provider: HasherProviderType;
-  round?: number;
+export interface HasherBcryptModuleOptions {
+  provider: 'bcrypt';
+  round: number;
+}
+
+/**
+ * @interface HasherArgonModuleOptions
+ * @property {HasherProviderType} provider
+ * @property {number} round
+ */
+export interface HasherArgonModuleOptions {
+  provider: 'argon';
 }
diff --git a/lib/nestjs-hasher.module.ts b/lib/nestjs-hasher.module.ts
@@ -2,8 +2,9 @@ import { DynamicModule, Module, Provider, ValueProvider } from '@nestjs/common';
 import { NestjsHasherService } from './nestjs-hasher.service';
 import { HASHER_CONFIG } from './constants';
 import {
+  HasherArgonModuleOptions,
+  HasherBcryptModuleOptions,
   HasherModuleAsyncOptions,
-  HasherModuleOptions,
   HasherModuleOptionsFactory,
 } from './interfaces';
 
@@ -12,10 +13,12 @@ export class NestjsHasherModule {
   /**
    * Register module
    * @static
-   * @param {HasherModuleOptions} options
+   * @param {HasherBcryptModuleOptions | HasherArgonModuleOptions} options
    * @return DynamicModule
    */
-  static register(options: HasherModuleOptions): DynamicModule {
+  static register(
+    options: HasherBcryptModuleOptions | HasherArgonModuleOptions,
+  ): DynamicModule {
     const hasherProvider: ValueProvider = {
       provide: HASHER_CONFIG,
       useValue: options,
@@ -107,7 +110,7 @@ export class NestjsHasherModule {
       provide: HASHER_CONFIG,
       async useFactory(
         optionsFactory: HasherModuleOptionsFactory,
-      ): Promise<HasherModuleOptions> {
+      ): Promise<HasherBcryptModuleOptions | HasherArgonModuleOptions> {
         return optionsFactory.createHasherOptions();
       },
       inject: [inject],

diff --git a/lib/nestjs-hasher.service.ts b/lib/nestjs-hasher.service.ts
@@ -1,29 +1,41 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { HasherManagerService } from './managers';
 import { ArgonService, BcryptService } from './providers';
-import { HasherModuleOptions } from './interfaces';
+import {
+  HasherArgonModuleOptions,
+  HasherBcryptModuleOptions,
+  HasherProviderType,
+} from './interfaces';
 import { HASHER_CONFIG } from './constants';
 
 @Injectable()
 export class NestjsHasherService extends HasherManagerService {
   /**
    * Nestjs hasher service constructor.
    * @constructor
-   * @param {HasherModuleOptions} hasherOption
+   * @param {HasherBcryptModuleOptions} options
    */
   constructor(
-    @Inject(HASHER_CONFIG) private hasherOption: HasherModuleOptions,
+    @Inject(HASHER_CONFIG)
+    private options: HasherBcryptModuleOptions | HasherArgonModuleOptions,
   ) {
     super();
+
+    if (
+      this.options.provider !== 'argon' &&
+      this.options.provider !== 'bcrypt'
+    ) {
+      throw new Error(`Config error your provider not exist`);
+    }
   }
 
   /**
    * Get default provider
    * @method
    * @protected
    */
-  protected getDefaultProvider(): string {
-    return this.hasherOption.provider;
+  protected getDefaultProvider(): HasherProviderType {
+    return this.options.provider;
   }
 
   /**
@@ -41,11 +53,16 @@ export class NestjsHasherService extends HasherManagerService {
    * @protected
    */
   protected createBcryptProvider() {
-    if (!this.hasherOption.round) {
-      throw new Error(`To use bcrypt salt round is required`);
-    }
+    if (this.options.provider === 'bcrypt') {
+      // defined option type
+      this.options = this.options as HasherBcryptModuleOptions;
 
-    return new BcryptService(Number(this.hasherOption.round));
+      if (!this.options.round) {
+        throw new Error(`To use bcrypt salt round is required`);
+      }
+
+      return new BcryptService(Number(this.options?.round));
+    }
   }
 
   /**