@nest-boot/hash 7.0.0 → 7.0.2

package/dist/hash-module-options.interface.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Configuration options for the HashModule.
+ */
 export interface HashModuleOptions {
+    /**
+     * The secret key used for hashing.
+     * If not provided, falls back to HASH_SECRET or APP_SECRET environment variables.
+     */
     secret?: string;
 }

package/dist/hash.module-definition.d.ts

@@ -1,8 +1,2 @@
 import { type HashModuleOptions } from "./hash-module-options.interface";
-export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<HashModuleOptions, "register", "create", {
-    isGlobal: boolean;
-}>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: HashModuleOptions & Partial<{
-    isGlobal: boolean;
-}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<HashModuleOptions, "create"> & Partial<{
-    isGlobal: boolean;
-}>;
+export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<HashModuleOptions, "register", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: HashModuleOptions & Partial<{}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<HashModuleOptions, "create"> & Partial<{}>;

package/dist/hash.module-definition.js

@@ -3,12 +3,5 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ASYNC_OPTIONS_TYPE = exports.OPTIONS_TYPE = exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = void 0;
 const common_1 = require("@nestjs/common");
-_a = new common_1.ConfigurableModuleBuilder()
-    .setExtras({
-    isGlobal: false,
-}, (definition, extras) => ({
-    ...definition,
-    global: extras.isGlobal,
-}))
-    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
+_a = new common_1.ConfigurableModuleBuilder().build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
 //# sourceMappingURL=hash.module-definition.js.map

package/dist/hash.module-definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"hash.module-definition.js","sourceRoot":"","sources":["../src/hash.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI9C,KAKT,IAAI,kCAAyB,EAAqB;KACnD,SAAS,CACR;IACE,QAAQ,EAAE,KAAK;CAChB,EACD,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;IACvB,GAAG,UAAU;IACb,MAAM,EAAE,MAAM,CAAC,QAAQ;CACxB,CAAC,CACH;KACA,KAAK,EAAE,EAdR,+BAAuB,+BACvB,4BAAoB,4BACpB,oBAAY,oBACZ,0BAAkB,yBAWT"}
+{"version":3,"file":"hash.module-definition.js","sourceRoot":"","sources":["../src/hash.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI9C,KAKT,IAAI,kCAAyB,EAAqB,CAAC,KAAK,EAAE,EAJ5D,+BAAuB,+BACvB,4BAAoB,4BACpB,oBAAY,oBACZ,0BAAkB,yBAC2C"}

package/dist/hash.module.d.ts

@@ -1,3 +1,34 @@
-import { ConfigurableModuleClass } from "./hash.module-definition";
+import { type DynamicModule } from "@nestjs/common";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./hash.module-definition";
+/**
+ * Module that provides password hashing services using Argon2.
+ *
+ * @example
+ * ```typescript
+ * import { HashModule } from '@nest-boot/hash';
+ *
+ * @Module({
+ *   imports: [
+ *     HashModule.register({
+ *       secret: 'your-secret-key',
+ *       isGlobal: true,
+ *     }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
 export declare class HashModule extends ConfigurableModuleClass {
+    /**
+     * Registers the HashModule with the given options.
+     * @param options - Configuration options including secret and isGlobal
+     * @returns Dynamic module configuration
+     */
+    static register(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the HashModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static registerAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
 }

package/dist/hash.module.js

@@ -10,10 +10,45 @@ exports.HashModule = void 0;
 const common_1 = require("@nestjs/common");
 const hash_module_definition_1 = require("./hash.module-definition");
 const hash_service_1 = require("./hash.service");
+/**
+ * Module that provides password hashing services using Argon2.
+ *
+ * @example
+ * ```typescript
+ * import { HashModule } from '@nest-boot/hash';
+ *
+ * @Module({
+ *   imports: [
+ *     HashModule.register({
+ *       secret: 'your-secret-key',
+ *       isGlobal: true,
+ *     }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
 let HashModule = class HashModule extends hash_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the HashModule with the given options.
+     * @param options - Configuration options including secret and isGlobal
+     * @returns Dynamic module configuration
+     */
+    static register(options) {
+        return super.register(options);
+    }
+    /**
+     * Registers the HashModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static registerAsync(options) {
+        return super.registerAsync(options);
+    }
 };
 exports.HashModule = HashModule;
 exports.HashModule = HashModule = __decorate([
+    (0, common_1.Global)(),
     (0, common_1.Module)({ providers: [hash_service_1.HashService], exports: [hash_service_1.HashService] })
 ], HashModule);
 //# sourceMappingURL=hash.module.js.map

package/dist/hash.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"hash.module.js","sourceRoot":"","sources":["../src/hash.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AAExC,qEAAmE;AACnE,iDAA6C;AAGtC,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,gDAAuB;CAAG,CAAA;AAA7C,gCAAU;qBAAV,UAAU;IADtB,IAAA,eAAM,EAAC,EAAE,SAAS,EAAE,CAAC,0BAAW,CAAC,EAAE,OAAO,EAAE,CAAC,0BAAW,CAAC,EAAE,CAAC;GAChD,UAAU,CAAmC"}
+{"version":3,"file":"hash.module.js","sourceRoot":"","sources":["../src/hash.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAoE;AAEpE,qEAIkC;AAClC,iDAA6C;AAE7C;;;;;;;;;;;;;;;;;GAiBG;AAGI,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,gDAAuB;IACrD;;;;OAIG;IACH,MAAM,CAAU,QAAQ,CAAC,OAA4B;QACnD,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAU,aAAa,CAC3B,OAAkC;QAElC,OAAO,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;AApBY,gCAAU;qBAAV,UAAU;IAFtB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,SAAS,EAAE,CAAC,0BAAW,CAAC,EAAE,OAAO,EAAE,CAAC,0BAAW,CAAC,EAAE,CAAC;GAChD,UAAU,CAoBtB"}

package/dist/hash.service.d.ts

@@ -1,8 +1,45 @@
 import { HashModuleOptions } from "./hash-module-options.interface";
+/**
+ * Service that provides password hashing and verification using Argon2 algorithm.
+ *
+ * @example
+ * ```typescript
+ * import { HashService } from '@nest-boot/hash';
+ *
+ * @Injectable()
+ * export class AuthService {
+ *   constructor(private readonly hashService: HashService) {}
+ *
+ *   async hashPassword(password: string): Promise<string> {
+ *     return this.hashService.create(password);
+ *   }
+ *
+ *   async verifyPassword(hash: string, password: string): Promise<boolean> {
+ *     return this.hashService.verify(hash, password);
+ *   }
+ * }
+ * ```
+ */
 export declare class HashService {
-    private readonly options;
     private readonly secret?;
+    /**
+     * Creates an instance of HashService.
+     * @param options - Configuration options for the hash service
+     */
     constructor(options?: HashModuleOptions);
+    /**
+     * Creates a hash from the given value using Argon2.
+     * @param value - The value to hash (password or other sensitive data)
+     * @param secret - Optional secret key to use instead of the default
+     * @returns The hashed string
+     */
     create(value: string | Buffer, secret?: string): Promise<string>;
+    /**
+     * Verifies a value against a hash.
+     * @param hashed - The hash to verify against
+     * @param value - The value to verify
+     * @param secret - Optional secret key to use instead of the default
+     * @returns True if the value matches the hash, false otherwise
+     */
     verify(hashed: string | Buffer, value: string | Buffer, secret?: string): Promise<boolean>;
 }

package/dist/hash.service.js

@@ -16,19 +16,56 @@ exports.HashService = void 0;
 const common_1 = require("@nestjs/common");
 const argon2_1 = require("@node-rs/argon2");
 const hash_module_definition_1 = require("./hash.module-definition");
+/**
+ * Service that provides password hashing and verification using Argon2 algorithm.
+ *
+ * @example
+ * ```typescript
+ * import { HashService } from '@nest-boot/hash';
+ *
+ * @Injectable()
+ * export class AuthService {
+ *   constructor(private readonly hashService: HashService) {}
+ *
+ *   async hashPassword(password: string): Promise<string> {
+ *     return this.hashService.create(password);
+ *   }
+ *
+ *   async verifyPassword(hash: string, password: string): Promise<boolean> {
+ *     return this.hashService.verify(hash, password);
+ *   }
+ * }
+ * ```
+ */
 let HashService = class HashService {
+    /**
+     * Creates an instance of HashService.
+     * @param options - Configuration options for the hash service
+     */
     constructor(options = {}) {
-        this.options = options;
         const secret = options.secret ?? process.env.HASH_SECRET ?? process.env.APP_SECRET;
         if (secret) {
             this.secret = Buffer.from(secret);
         }
     }
+    /**
+     * Creates a hash from the given value using Argon2.
+     * @param value - The value to hash (password or other sensitive data)
+     * @param secret - Optional secret key to use instead of the default
+     * @returns The hashed string
+     */
     async create(value, secret) {
         return await (0, argon2_1.hash)(value, {
             secret: typeof secret !== "undefined" ? Buffer.from(secret) : this.secret,
         });
     }
+    /**
+     * Verifies a value against a hash.
+     * @param hashed - The hash to verify against
+     * @param value - The value to verify
+     * @param secret - Optional secret key to use instead of the default
+     * @returns True if the value matches the hash, false otherwise
+     */
     async verify(hashed, value, secret) {
         return await (0, argon2_1.verify)(hashed, value, {
             secret: typeof secret !== "undefined" ? Buffer.from(secret) : this.secret,

package/dist/hash.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"hash.service.js","sourceRoot":"","sources":["../src/hash.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA8D;AAC9D,4CAA+C;AAE/C,qEAAgE;AAIzD,IAAM,WAAW,GAAjB,MAAM,WAAW;IAGtB,YAGmB,UAA6B,EAAE;QAA/B,YAAO,GAAP,OAAO,CAAwB;QAEhD,MAAM,MAAM,GACV,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;QAEtE,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAsB,EAAE,MAAe;QAClD,OAAO,MAAM,IAAA,aAAI,EAAC,KAAK,EAAE;YACvB,MAAM,EAAE,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;SAC1E,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAAuB,EACvB,KAAsB,EACtB,MAAe;QAEf,OAAO,MAAM,IAAA,eAAM,EAAC,MAAM,EAAE,KAAK,EAAE;YACjC,MAAM,EAAE,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;SAC1E,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AA/BY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;IAKR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,WAAA,IAAA,eAAM,EAAC,6CAAoB,CAAC,CAAA;;GALpB,WAAW,CA+BvB"}
+{"version":3,"file":"hash.service.js","sourceRoot":"","sources":["../src/hash.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA8D;AAC9D,4CAA+C;AAE/C,qEAAgE;AAGhE;;;;;;;;;;;;;;;;;;;;GAoBG;AAEI,IAAM,WAAW,GAAjB,MAAM,WAAW;IAGtB;;;OAGG;IACH,YAGE,UAA6B,EAAE;QAE/B,MAAM,MAAM,GACV,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;QAEtE,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,KAAsB,EAAE,MAAe;QAClD,OAAO,MAAM,IAAA,aAAI,EAAC,KAAK,EAAE;YACvB,MAAM,EAAE,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;SAC1E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,MAAuB,EACvB,KAAsB,EACtB,MAAe;QAEf,OAAO,MAAM,IAAA,eAAM,EAAC,MAAM,EAAE,KAAK,EAAE;YACjC,MAAM,EAAE,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;SAC1E,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAhDY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;IASR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,WAAA,IAAA,eAAM,EAAC,6CAAoB,CAAC,CAAA;;GATpB,WAAW,CAgDvB"}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./hash.module";
 export * from "./hash.service";
+export * from "./hash-module-options.interface";

package/dist/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./hash.module"), exports);
 __exportStar(require("./hash.service"), exports);
+__exportStar(require("./hash-module-options.interface"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,iDAA+B;AAC/B,kEAAgD"}