@alwatr/crypto 1.2.0 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.0.0](https://github.com/Alwatr/eslib/compare/@alwatr/crypto@1.2.1...@alwatr/crypto@2.0.0) (2023-11-29)
+
+### Features
+
+* **crypto/hash:** review and update all methods and documents ([14acd26](https://github.com/Alwatr/eslib/commit/14acd265a19b1b67bd32f725468fe66985464fe6)) by @AliMD
+* **crypto/preConfig:** update prefix and secret algorithm ([0cfff12](https://github.com/Alwatr/eslib/commit/0cfff124e692d02aad0b5c97908df63bc692f896)) by @AliMD
+* **crypto/token:** review and update all methods and documents ([dc943f8](https://github.com/Alwatr/eslib/commit/dc943f8a007567b58e9e3b7f9cada556ac76ae9b)) by @AliMD
+* **crypto/user:** review and update all methods and documents ([bb79fa8](https://github.com/Alwatr/eslib/commit/bb79fa81f8632d5fe75cac813238b04094d0bb6a)) by @AliMD
+* **crypto:** prefix option ([6be5c90](https://github.com/Alwatr/eslib/commit/6be5c90dad4674e8ae3e27611a13dcf1e08ce11a)) by @AliMD
+
+### BREAKING CHANGES
+
+* **crypto/user:** methods name updated
+* **crypto/token:** methods name updated
+* **crypto/hash:** methods name updated
+
+## [1.2.1](https://github.com/Alwatr/eslib/compare/@alwatr/crypto@1.2.0...@alwatr/crypto@1.2.1) (2023-11-23)
+
+**Note:** Version bump only for package @alwatr/crypto
+
 # [1.2.0](https://github.com/Alwatr/eslib/compare/@alwatr/crypto@1.1.12...@alwatr/crypto@1.2.0) (2023-11-14)
 
 ### Features

package/README.md

@@ -1,6 +1,13 @@
 # Alwatr Crypto - `@alwatr/crypto`
 
-Secure authentication HOTP token generator (the HMAC-based One-Time Password algorithm) and crypto utils written in tiny TypeScript module.
+A robust generator of secure authentication HOTP tokens, employing the HMAC-based One-Time Password algorithm, accompanied by a suite of cryptographic utilities, all encapsulated within a compact TypeScript module.
+
+**This package includes:**
+
+1. [AlwatrHashGenerator](./src/hash.ts): Secure **self-validate** hash generator.
+2. [AlwatrTokenGenerator](./src/token.ts): Secure authentication HOTP token generator (HMAC-based One-Time Password algorithm).
+3. [AlwatrUserGenerator](./src/user.ts): User factory for generating self-validate user-id and user-token.
+4. [PreConfiguration](./src/pre-config.ts): Pre-configuration object for the hash/token generators.
 
 ## References
 

package/hash.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
 import { type BinaryLike } from 'node:crypto';
 import type { HashGeneratorConfig } from './type.js';
 /**
@@ -6,70 +6,75 @@ import type { HashGeneratorConfig } from './type.js';
  */
 export declare class AlwatrHashGenerator {
     config: HashGeneratorConfig;
+    /**
+     * Creates a new instance of the AlwatrHashGenerator class.
+     * @param config The configuration for the hash generator.
+     */
     constructor(config: HashGeneratorConfig);
     /**
-     * Generate simple hash from random data.
-     *
-     * Example:
-     *
-     * ```js
-     * const clientId = hashGenerator.random();
+     * Generate a random hash.
+     * @returns The generated hash.
+     * @example
+     * ```typescript
+     * const clientId = hashGenerator.generateRandom();
      * ```
      */
-    random(): string;
+    generateRandom(): string;
     /**
-     * Generate **self-validate** hash from random data.
-     *
-     * Example:
-     *
-     * ```ts
-     * const userId = hashGenerator.randomSelfValidate();
+     * Generate a **self-validate** random hash.
+     * @returns The generated self-validated hash.
+     * @example
+     * ```typescript
+     * const userId = hashGenerator.generateRandomSelfValidate();
      * ```
      */
-    randomSelfValidate(): string;
+    generateRandomSelfValidate(): string;
     /**
-     * Generate simple hash from data.
-     *
-     * Example:
-     *
-     * ```ts
-     * const crcHash = hashGenerator.generate(downloadedData);
+     * Generate a hash from data.
+     * @param data - The data to generate the hash from.
+     * @returns The generated hash.
+     * @example
+     * ```typescript
+     * const crcHash = hashGenerator.generate(data);
      * ```
      */
     generate(data: BinaryLike): string;
     /**
-     * Generate crc hash.
+     * Generate a crc hash.
+     * @param data - The data to generate the crc hash from.
+     * @returns The generated crc hash.
      */
-    _generateCrc(data: BinaryLike): string;
+    generateCrc(data: BinaryLike): string;
     /**
-     * Generate **self-validate** hash from data.
-     *
-     * Example:
-     *
-     * ```js
-     * const userId = hashGenerator.generateSelfValidate(randomData);
+     * Generate a **self-validate** hash from data.
+     * @param data - The data to generate the self-validated hash from.
+     * @returns The generated self-validated hash.
+     * @example
+     * ```typescript
+     * const userId = hashGenerator.generateSelfValidate(data);
      * ```
      */
     generateSelfValidate(data: BinaryLike): string;
     /**
-     * Verify `generate(data)` equals to `hash`.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!hashGenerator.verify(downloadedData, crcHash)) {
+     * Verify if the generated hash matches the provided hash.
+     * @param data - The data to verify.
+     * @param hash - The hash to compare against.
+     * @returns `true` if the hash is verified, `false` otherwise.
+     * @example
+     * ```typescript
+     * if (!hashGenerator.verify(data, hash)) {
      *   new Error('data_corrupted');
      * }
      * ```
      */
     verify(data: BinaryLike, hash: string): boolean;
     /**
-     * Verify a **self-validate** hash to check its generated by this class (same options).
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!hashGenerator.verifySelfValidate(user.id)) {
+     * Verify a **self-validate** hash to check if it was generated by this class (with the same options).
+     * @param hash - The self-validated hash to verify.
+     * @returns `true` if the hash is verified, `false` otherwise.
+     * @example
+     * ```typescript
+     * if (!hashGenerator.verifySelfValidate(hash)) {
      *   new Error('invalid_user');
      * }
      * ```

package/hash.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["src/hash.ts"],"names":[],"mappings":";AAAA,OAAO,EAA0B,KAAK,UAAU,EAAC,MAAM,aAAa,CAAC;AAErE,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,WAAW,CAAC;AAEnD;;GAEG;AACH,qBAAa,mBAAmB;IACX,MAAM,EAAE,mBAAmB;gBAA3B,MAAM,EAAE,mBAAmB;IAE9C;;;;;;;;OAQG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;;;;;OAQG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIlC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAKtC;;;;;;;;OAQG;IACH,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAM9C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAI/C;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAS1C"}
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["src/hash.ts"],"names":[],"mappings":";AAAA,OAAO,EAA2B,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAErD;;GAEG;AACH,qBAAa,mBAAmB;IAKX,MAAM,EAAE,mBAAmB;IAJ9C;;;OAGG;gBACgB,MAAM,EAAE,mBAAmB;IAE9C;;;;;;;OAOG;IACH,cAAc,IAAI,MAAM;IAIxB;;;;;;;OAOG;IACH,0BAA0B,IAAI,MAAM;IAIpC;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIlC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAKrC;;;;;;;;OAQG;IACH,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAM9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAI/C;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAS1C"}

package/hash.js

@@ -3,73 +3,78 @@ import { createHash, randomBytes } from 'node:crypto';
  * Secure **self-validate** hash generator.
  */
 export class AlwatrHashGenerator {
+    /**
+     * Creates a new instance of the AlwatrHashGenerator class.
+     * @param config The configuration for the hash generator.
+     */
     constructor(config) {
         this.config = config;
     }
     /**
-     * Generate simple hash from random data.
-     *
-     * Example:
-     *
-     * ```js
-     * const clientId = hashGenerator.random();
+     * Generate a random hash.
+     * @returns The generated hash.
+     * @example
+     * ```typescript
+     * const clientId = hashGenerator.generateRandom();
      * ```
      */
-    random() {
+    generateRandom() {
         return this.generate(randomBytes(16));
     }
     /**
-     * Generate **self-validate** hash from random data.
-     *
-     * Example:
-     *
-     * ```ts
-     * const userId = hashGenerator.randomSelfValidate();
+     * Generate a **self-validate** random hash.
+     * @returns The generated self-validated hash.
+     * @example
+     * ```typescript
+     * const userId = hashGenerator.generateRandomSelfValidate();
      * ```
      */
-    randomSelfValidate() {
+    generateRandomSelfValidate() {
         return this.generateSelfValidate(randomBytes(16));
     }
     /**
-     * Generate simple hash from data.
-     *
-     * Example:
-     *
-     * ```ts
-     * const crcHash = hashGenerator.generate(downloadedData);
+     * Generate a hash from data.
+     * @param data - The data to generate the hash from.
+     * @returns The generated hash.
+     * @example
+     * ```typescript
+     * const crcHash = hashGenerator.generate(data);
      * ```
      */
     generate(data) {
-        return createHash(this.config.algorithm).update(data).digest(this.config.encoding);
+        return this.config.prefix + createHash(this.config.algorithm).update(data).digest(this.config.encoding);
     }
     /**
-     * Generate crc hash.
+     * Generate a crc hash.
+     * @param data - The data to generate the crc hash from.
+     * @returns The generated crc hash.
      */
-    _generateCrc(data) {
+    generateCrc(data) {
         const crc = createHash('sha1').update(data).digest(this.config.encoding);
-        return this.config.crcLength == null || this.config.crcLength < 1 ? crc : crc.substring(0, this.config.crcLength);
+        return this.config.crcLength == null || this.config.crcLength < 1 ? crc : crc.slice(0, this.config.crcLength);
     }
     /**
-     * Generate **self-validate** hash from data.
-     *
-     * Example:
-     *
-     * ```js
-     * const userId = hashGenerator.generateSelfValidate(randomData);
+     * Generate a **self-validate** hash from data.
+     * @param data - The data to generate the self-validated hash from.
+     * @returns The generated self-validated hash.
+     * @example
+     * ```typescript
+     * const userId = hashGenerator.generateSelfValidate(data);
      * ```
      */
     generateSelfValidate(data) {
         const mainHash = this.generate(data);
-        const crcHash = this._generateCrc(mainHash);
+        const crcHash = this.generateCrc(mainHash);
         return mainHash + crcHash;
     }
     /**
-     * Verify `generate(data)` equals to `hash`.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!hashGenerator.verify(downloadedData, crcHash)) {
+     * Verify if the generated hash matches the provided hash.
+     * @param data - The data to verify.
+     * @param hash - The hash to compare against.
+     * @returns `true` if the hash is verified, `false` otherwise.
+     * @example
+     * ```typescript
+     * if (!hashGenerator.verify(data, hash)) {
      *   new Error('data_corrupted');
      * }
      * ```
@@ -78,23 +83,23 @@ export class AlwatrHashGenerator {
         return hash === this.generate(data);
     }
     /**
-     * Verify a **self-validate** hash to check its generated by this class (same options).
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!hashGenerator.verifySelfValidate(user.id)) {
+     * Verify a **self-validate** hash to check if it was generated by this class (with the same options).
+     * @param hash - The self-validated hash to verify.
+     * @returns `true` if the hash is verified, `false` otherwise.
+     * @example
+     * ```typescript
+     * if (!hashGenerator.verifySelfValidate(hash)) {
      *   new Error('invalid_user');
      * }
      * ```
      */
     verifySelfValidate(hash) {
         const gapPos = this.config.crcLength == null || this.config.crcLength < 1
-            ? hash.length / 2
+            ? hash.length - (hash.length - this.config.prefix.length) / 2
             : hash.length - this.config.crcLength;
-        const mainHash = hash.substring(0, gapPos);
-        const crcHash = hash.substring(gapPos);
-        return crcHash === this._generateCrc(mainHash);
+        const mainHash = hash.slice(0, gapPos);
+        const crcHash = hash.slice(gapPos);
+        return crcHash === this.generateCrc(mainHash);
     }
 }
 //# sourceMappingURL=hash.js.map

package/hash.js.map

@@ -1 +1 @@
-{"version":3,"file":"hash.js","sourceRoot":"","sources":["src/hash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,WAAW,EAAkB,MAAM,aAAa,CAAC;AAIrE;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B,YAAmB,MAA2B;QAA3B,WAAM,GAAN,MAAM,CAAqB;IAAG,CAAC;IAElD;;;;;;;;OAQG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAgB;QACvB,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,IAAgB;QAC3B,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpH,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAAC,IAAgB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC5C,OAAO,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAgB,EAAE,IAAY;QACnC,OAAO,IAAI,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,IAAY;QAC7B,MAAM,MAAM,GACV,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;YACxD,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;YACjB,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvC,OAAO,OAAO,KAAK,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;CACF","sourcesContent":["import {createHash, randomBytes, type BinaryLike} from 'node:crypto';\n\nimport type {HashGeneratorConfig} from './type.js';\n\n/**\n * Secure **self-validate** hash generator.\n */\nexport class AlwatrHashGenerator {\n  constructor(public config: HashGeneratorConfig) {}\n\n  /**\n   * Generate simple hash from random data.\n   *\n   * Example:\n   *\n   * ```js\n   * const clientId = hashGenerator.random();\n   * ```\n   */\n  random(): string {\n    return this.generate(randomBytes(16));\n  }\n\n  /**\n   * Generate **self-validate** hash from random data.\n   *\n   * Example:\n   *\n   * ```ts\n   * const userId = hashGenerator.randomSelfValidate();\n   * ```\n   */\n  randomSelfValidate(): string {\n    return this.generateSelfValidate(randomBytes(16));\n  }\n\n  /**\n   * Generate simple hash from data.\n   *\n   * Example:\n   *\n   * ```ts\n   * const crcHash = hashGenerator.generate(downloadedData);\n   * ```\n   */\n  generate(data: BinaryLike): string {\n    return createHash(this.config.algorithm).update(data).digest(this.config.encoding);\n  }\n\n  /**\n   * Generate crc hash.\n   */\n  _generateCrc(data: BinaryLike): string {\n    const crc = createHash('sha1').update(data).digest(this.config.encoding);\n    return this.config.crcLength == null || this.config.crcLength < 1 ? crc : crc.substring(0, this.config.crcLength);\n  }\n\n  /**\n   * Generate **self-validate** hash from data.\n   *\n   * Example:\n   *\n   * ```js\n   * const userId = hashGenerator.generateSelfValidate(randomData);\n   * ```\n   */\n  generateSelfValidate(data: BinaryLike): string {\n    const mainHash = this.generate(data);\n    const crcHash = this._generateCrc(mainHash);\n    return mainHash + crcHash;\n  }\n\n  /**\n   * Verify `generate(data)` equals to `hash`.\n   *\n   * Example:\n   *\n   * ```ts\n   * if (!hashGenerator.verify(downloadedData, crcHash)) {\n   *   new Error('data_corrupted');\n   * }\n   * ```\n   */\n  verify(data: BinaryLike, hash: string): boolean {\n    return hash === this.generate(data);\n  }\n\n  /**\n   * Verify a **self-validate** hash to check its generated by this class (same options).\n   *\n   * Example:\n   *\n   * ```ts\n   * if (!hashGenerator.verifySelfValidate(user.id)) {\n   *   new Error('invalid_user');\n   * }\n   * ```\n   */\n  verifySelfValidate(hash: string): boolean {\n    const gapPos =\n      this.config.crcLength == null || this.config.crcLength < 1\n        ? hash.length / 2\n        : hash.length - this.config.crcLength;\n    const mainHash = hash.substring(0, gapPos);\n    const crcHash = hash.substring(gapPos);\n    return crcHash === this._generateCrc(mainHash);\n  }\n}\n"]}
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["src/hash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAmB,MAAM,aAAa,CAAC;AAIvE;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;OAGG;IACH,YAAmB,MAA2B;QAA3B,WAAM,GAAN,MAAM,CAAqB;IAAG,CAAC;IAElD;;;;;;;OAOG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,0BAA0B;QACxB,OAAO,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAgB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1G,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAgB;QAC1B,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAChH,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAAC,IAAgB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAgB,EAAE,IAAY;QACnC,OAAO,IAAI,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,IAAY;QAC7B,MAAM,MAAM,GACV,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;YACxD,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC;YAC7D,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,OAAO,KAAK,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;CACF","sourcesContent":["import { createHash, randomBytes, type BinaryLike } from 'node:crypto';\n\nimport type { HashGeneratorConfig } from './type.js';\n\n/**\n * Secure **self-validate** hash generator.\n */\nexport class AlwatrHashGenerator {\n  /**\n   * Creates a new instance of the AlwatrHashGenerator class.\n   * @param config The configuration for the hash generator.\n   */\n  constructor(public config: HashGeneratorConfig) {}\n\n  /**\n   * Generate a random hash.\n   * @returns The generated hash.\n   * @example\n   * ```typescript\n   * const clientId = hashGenerator.generateRandom();\n   * ```\n   */\n  generateRandom(): string {\n    return this.generate(randomBytes(16));\n  }\n\n  /**\n   * Generate a **self-validate** random hash.\n   * @returns The generated self-validated hash.\n   * @example\n   * ```typescript\n   * const userId = hashGenerator.generateRandomSelfValidate();\n   * ```\n   */\n  generateRandomSelfValidate(): string {\n    return this.generateSelfValidate(randomBytes(16));\n  }\n\n  /**\n   * Generate a hash from data.\n   * @param data - The data to generate the hash from.\n   * @returns The generated hash.\n   * @example\n   * ```typescript\n   * const crcHash = hashGenerator.generate(data);\n   * ```\n   */\n  generate(data: BinaryLike): string {\n    return this.config.prefix + createHash(this.config.algorithm).update(data).digest(this.config.encoding);\n  }\n\n  /**\n   * Generate a crc hash.\n   * @param data - The data to generate the crc hash from.\n   * @returns The generated crc hash.\n   */\n  generateCrc(data: BinaryLike): string {\n    const crc = createHash('sha1').update(data).digest(this.config.encoding);\n    return this.config.crcLength == null || this.config.crcLength < 1 ? crc : crc.slice(0, this.config.crcLength);\n  }\n\n  /**\n   * Generate a **self-validate** hash from data.\n   * @param data - The data to generate the self-validated hash from.\n   * @returns The generated self-validated hash.\n   * @example\n   * ```typescript\n   * const userId = hashGenerator.generateSelfValidate(data);\n   * ```\n   */\n  generateSelfValidate(data: BinaryLike): string {\n    const mainHash = this.generate(data);\n    const crcHash = this.generateCrc(mainHash);\n    return mainHash + crcHash;\n  }\n\n  /**\n   * Verify if the generated hash matches the provided hash.\n   * @param data - The data to verify.\n   * @param hash - The hash to compare against.\n   * @returns `true` if the hash is verified, `false` otherwise.\n   * @example\n   * ```typescript\n   * if (!hashGenerator.verify(data, hash)) {\n   *   new Error('data_corrupted');\n   * }\n   * ```\n   */\n  verify(data: BinaryLike, hash: string): boolean {\n    return hash === this.generate(data);\n  }\n\n  /**\n   * Verify a **self-validate** hash to check if it was generated by this class (with the same options).\n   * @param hash - The self-validated hash to verify.\n   * @returns `true` if the hash is verified, `false` otherwise.\n   * @example\n   * ```typescript\n   * if (!hashGenerator.verifySelfValidate(hash)) {\n   *   new Error('invalid_user');\n   * }\n   * ```\n   */\n  verifySelfValidate(hash: string): boolean {\n    const gapPos =\n      this.config.crcLength == null || this.config.crcLength < 1\n        ? hash.length - (hash.length - this.config.prefix.length) / 2\n        : hash.length - this.config.crcLength;\n    const mainHash = hash.slice(0, gapPos);\n    const crcHash = hash.slice(gapPos);\n    return crcHash === this.generateCrc(mainHash);\n  }\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@alwatr/crypto",
-  "version": "1.2.0",
-  "description": "Secure authentication HOTP token generator (the HMAC-based One-Time Password algorithm) and crypto utils written in tiny TypeScript module.",
+  "version": "2.0.0",
+  "description": "A robust generator of secure authentication HOTP tokens, employing the HMAC-based One-Time Password algorithm, accompanied by a suite of cryptographic utilities, all encapsulated within a compact TypeScript module.",
   "keywords": [
     "crypto",
     "hash",
@@ -40,13 +40,12 @@
     "url": "https://github.com/Alwatr/eslib/issues"
   },
   "dependencies": {
-    "@alwatr/logger": "^2.2.0",
-    "@alwatr/math": "^1.2.0",
-    "@alwatr/util": "^1.3.0",
-    "tslib": "^2.6.2"
+    "@alwatr/logger": "^2.3.1",
+    "@alwatr/math": "^1.2.2",
+    "@alwatr/util": "^1.3.2"
   },
   "devDependencies": {
-    "@types/node": "^20.9.0"
+    "@types/node": "^20.10.0"
   },
-  "gitHead": "c9c6d5abf5e2aeafa915fde58c73e030ac00db27"
+  "gitHead": "27cb935580d5ccdc4459f1018c66f23ea0a42ddf"
 }

package/pre-config.d.ts

@@ -10,5 +10,5 @@ export declare const userIdGeneratorPreConfig: HashGeneratorConfig;
 /**
  * Token generator pre configuration for making secure self-validate **user-token**.
  */
-export declare const userTokenGeneratorPreConfig: Pick<TokenGeneratorConfig, 'algorithm' | 'encoding'>;
+export declare const userTokenGeneratorPreConfig: Pick<TokenGeneratorConfig, 'algorithm' | 'encoding' | 'prefix'>;
 //# sourceMappingURL=pre-config.d.ts.map

package/pre-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pre-config.d.ts","sourceRoot":"","sources":["src/pre-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAE,oBAAoB,EAAC,MAAM,WAAW,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,mBAItC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,mBAItC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,IAAI,CAAC,oBAAoB,EAAE,WAAW,GAAG,UAAU,CAG5F,CAAC"}
+{"version":3,"file":"pre-config.d.ts","sourceRoot":"","sources":["src/pre-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAE,oBAAoB,EAAC,MAAM,WAAW,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,mBAKtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,mBAKtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,IAAI,CAAC,oBAAoB,EAAE,WAAW,GAAG,UAAU,GAAG,QAAQ,CAIvG,CAAC"}

package/pre-config.js

@@ -2,7 +2,8 @@
  * Hash generator pre configuration for making random self-validate **secrets**.
  */
 export const secretGeneratorPreConfig = {
-    algorithm: 'sha256',
+    prefix: 's',
+    algorithm: 'sha384',
     encoding: 'base64url',
     crcLength: 4,
 };
@@ -10,6 +11,7 @@ export const secretGeneratorPreConfig = {
  * Hash generator pre configuration for making random self-validate **user-id**.
  */
 export const userIdGeneratorPreConfig = {
+    prefix: 'u',
     algorithm: 'sha1',
     encoding: 'base64url',
     crcLength: 4,
@@ -18,6 +20,7 @@ export const userIdGeneratorPreConfig = {
  * Token generator pre configuration for making secure self-validate **user-token**.
  */
 export const userTokenGeneratorPreConfig = {
+    prefix: 't',
     algorithm: 'sha224',
     encoding: 'base64url',
 };

package/pre-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"pre-config.js","sourceRoot":"","sources":["src/pre-config.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAwB;IAC3D,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAwB;IAC3D,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAyD;IAC/F,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,WAAW;CACtB,CAAC","sourcesContent":["import {HashGeneratorConfig, TokenGeneratorConfig} from './type.js';\n\n/**\n * Hash generator pre configuration for making random self-validate **secrets**.\n */\nexport const secretGeneratorPreConfig: HashGeneratorConfig = {\n  algorithm: 'sha256',\n  encoding: 'base64url',\n  crcLength: 4,\n};\n\n/**\n * Hash generator pre configuration for making random self-validate **user-id**.\n */\nexport const userIdGeneratorPreConfig: HashGeneratorConfig = {\n  algorithm: 'sha1',\n  encoding: 'base64url',\n  crcLength: 4,\n};\n\n/**\n * Token generator pre configuration for making secure self-validate **user-token**.\n */\nexport const userTokenGeneratorPreConfig: Pick<TokenGeneratorConfig, 'algorithm' | 'encoding'> = {\n  algorithm: 'sha224',\n  encoding: 'base64url',\n};\n"]}
+{"version":3,"file":"pre-config.js","sourceRoot":"","sources":["src/pre-config.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAwB;IAC3D,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAwB;IAC3D,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAoE;IAC1G,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,WAAW;CACtB,CAAC","sourcesContent":["import {HashGeneratorConfig, TokenGeneratorConfig} from './type.js';\n\n/**\n * Hash generator pre configuration for making random self-validate **secrets**.\n */\nexport const secretGeneratorPreConfig: HashGeneratorConfig = {\n  prefix: 's',\n  algorithm: 'sha384',\n  encoding: 'base64url',\n  crcLength: 4,\n};\n\n/**\n * Hash generator pre configuration for making random self-validate **user-id**.\n */\nexport const userIdGeneratorPreConfig: HashGeneratorConfig = {\n  prefix: 'u',\n  algorithm: 'sha1',\n  encoding: 'base64url',\n  crcLength: 4,\n};\n\n/**\n * Token generator pre configuration for making secure self-validate **user-token**.\n */\nexport const userTokenGeneratorPreConfig: Pick<TokenGeneratorConfig, 'algorithm' | 'encoding' | 'prefix'> = {\n  prefix: 't',\n  algorithm: 'sha224',\n  encoding: 'base64url',\n};\n"]}

package/token.d.ts

@@ -5,24 +5,42 @@ import type { TokenGeneratorConfig, TokenStatus } from './type.js';
 export declare class AlwatrTokenGenerator {
     config: TokenGeneratorConfig;
     protected _duration: number | null;
+    /**
+     * The current epoch based on the configured duration.
+     */
     get epoch(): number;
+    /**
+     * Creates a new instance of AlwatrTokenGenerator.
+     * @param config The configuration for the token generator.
+     */
     constructor(config: TokenGeneratorConfig);
-    protected _generate(data: string, epoch: number): string;
     /**
-     * Generate HOTP token from data base on special duration.
-     *
-     * ```ts
+     * Generates a HOTP token based on the provided data for special duration.
+     * @param data The data to generate the token from.
+     * @returns The generated token.
+     * @example
+     * ```typescript
      * user.auth = tokenGenerator.generate(`${user.id}-${user.role}`);
      * ```
      */
     generate(data: string): string;
     /**
-     * Token verification.
-     *
-     * ```ts
+     * Verifies if a token is valid.
+     * @param data The data used to generate the token.
+     * @param token The token to verify.
+     * @returns The status of the token verification.
+     * @example
+     * ```typescript
      * const validateStatus = tokenGenerator.verify(`${user.id}-${user.role}`, user.auth);
      * ```
      */
     verify(data: string, token: string): TokenStatus;
+    /**
+     * Generates a cryptographic token based on the provided data and epoch.
+     * @param data - The data to be used in the token generation.
+     * @param epoch - The epoch value to be used in the token generation.
+     * @returns The generated cryptographic token.
+     */
+    protected _generate(data: string, epoch: number): string;
 }
 //# sourceMappingURL=token.d.ts.map

package/token.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["src/token.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,oBAAoB,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAEjE;;GAEG;AACH,qBAAa,oBAAoB;IAOZ,MAAM,EAAE,oBAAoB;IAN/C,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,IAAI,KAAK,IAAI,MAAM,CAElB;gBAEkB,MAAM,EAAE,oBAAoB;IAI/C,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAOxD;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI9B;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW;CAejD"}
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["src/token.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,oBAAoB,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAEjE;;GAEG;AACH,qBAAa,oBAAoB;IAcZ,MAAM,EAAE,oBAAoB;IAb/C,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;OAGG;gBACgB,MAAM,EAAE,oBAAoB;IAI/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI9B;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW;IAgBhD;;;;;OAKG;IACH,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAKzD"}

package/token.js

@@ -4,22 +4,26 @@ import { parseDuration } from '@alwatr/math';
  * Secure authentication HOTP token generator (HMAC-based One-Time Password algorithm).
  */
 export class AlwatrTokenGenerator {
+    /**
+     * The current epoch based on the configured duration.
+     */
     get epoch() {
         return this._duration == null ? 0 : Math.floor(Date.now() / this._duration);
     }
+    /**
+     * Creates a new instance of AlwatrTokenGenerator.
+     * @param config The configuration for the token generator.
+     */
     constructor(config) {
         this.config = config;
         this._duration = config.duration == null ? null : parseDuration(config.duration);
     }
-    _generate(data, epoch) {
-        return createHmac(this.config.algorithm, data)
-            .update(data + epoch)
-            .digest(this.config.encoding);
-    }
     /**
-     * Generate HOTP token from data base on special duration.
-     *
-     * ```ts
+     * Generates a HOTP token based on the provided data for special duration.
+     * @param data The data to generate the token from.
+     * @returns The generated token.
+     * @example
+     * ```typescript
      * user.auth = tokenGenerator.generate(`${user.id}-${user.role}`);
      * ```
      */
@@ -27,9 +31,12 @@ export class AlwatrTokenGenerator {
         return this._generate(data, this.epoch);
     }
     /**
-     * Token verification.
-     *
-     * ```ts
+     * Verifies if a token is valid.
+     * @param data The data used to generate the token.
+     * @param token The token to verify.
+     * @returns The status of the token verification.
+     * @example
+     * ```typescript
      * const validateStatus = tokenGenerator.verify(`${user.id}-${user.role}`, user.auth);
      * ```
      */
@@ -48,5 +55,16 @@ export class AlwatrTokenGenerator {
             return 'invalid';
         }
     }
+    /**
+     * Generates a cryptographic token based on the provided data and epoch.
+     * @param data - The data to be used in the token generation.
+     * @param epoch - The epoch value to be used in the token generation.
+     * @returns The generated cryptographic token.
+     */
+    _generate(data, epoch) {
+        return this.config.prefix + createHmac(this.config.algorithm, data)
+            .update(data + epoch)
+            .digest(this.config.encoding);
+    }
 }
 //# sourceMappingURL=token.js.map

package/token.js.map

@@ -1 +1 @@
-{"version":3,"file":"token.js","sourceRoot":"","sources":["src/token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAI3C;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAG/B,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;IAED,YAAmB,MAA4B;QAA5B,WAAM,GAAN,MAAM,CAAsB;QAC7C,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnF,CAAC;IAES,SAAS,CAAC,IAAY,EAAE,KAAa;QAC7C,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC;aAC3C,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC;aACpB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAC9B;IACH,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAY;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAY,EAAE,KAAa;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YACzC,OAAO,OAAO,CAAC;SAChB;aACI,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YAC/B,OAAO,SAAS,CAAC;SAClB;aACI,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE;YAClD,OAAO,SAAS,CAAC;SAClB;aACI;YACH,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;CACF","sourcesContent":["import {createHmac} from 'node:crypto';\n\nimport {parseDuration} from '@alwatr/math';\n\nimport type {TokenGeneratorConfig, TokenStatus} from './type.js';\n\n/**\n * Secure authentication HOTP token generator (HMAC-based One-Time Password algorithm).\n */\nexport class AlwatrTokenGenerator {\n  protected _duration: number | null;\n\n  get epoch(): number {\n    return this._duration == null ? 0 : Math.floor(Date.now() / this._duration);\n  }\n\n  constructor(public config: TokenGeneratorConfig) {\n    this._duration = config.duration == null ? null : parseDuration(config.duration);\n  }\n\n  protected _generate(data: string, epoch: number): string {\n    return createHmac(this.config.algorithm, data)\n      .update(data + epoch)\n      .digest(this.config.encoding)\n    ;\n  }\n\n  /**\n   * Generate HOTP token from data base on special duration.\n   *\n   * ```ts\n   * user.auth = tokenGenerator.generate(`${user.id}-${user.role}`);\n   * ```\n   */\n  generate(data: string): string {\n    return this._generate(data, this.epoch);\n  }\n\n  /**\n   * Token verification.\n   *\n   * ```ts\n   * const validateStatus = tokenGenerator.verify(`${user.id}-${user.role}`, user.auth);\n   * ```\n   */\n  verify(data: string, token: string): TokenStatus {\n    const epoch = this.epoch;\n    if (token === this._generate(data, epoch)) {\n      return 'valid';\n    }\n    else if (this._duration == null) {\n      return 'invalid';\n    }\n    else if (token === this._generate(data, epoch - 1)) {\n      return 'expired';\n    }\n    else {\n      return 'invalid';\n    }\n  }\n}\n"]}
+{"version":3,"file":"token.js","sourceRoot":"","sources":["src/token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAI3C;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAG/B;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,YAAmB,MAA4B;QAA5B,WAAM,GAAN,MAAM,CAAsB;QAC7C,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAY;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAY,EAAE,KAAa;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;YAC1C,OAAO,OAAO,CAAC;QACjB,CAAC;aACI,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAChC,OAAO,SAAS,CAAC;QACnB,CAAC;aACI,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC;QACnB,CAAC;aACI,CAAC;YACJ,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACO,SAAS,CAAC,IAAY,EAAE,KAAa;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC;aAChE,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC;aACpB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;CACF","sourcesContent":["import {createHmac} from 'node:crypto';\n\nimport {parseDuration} from '@alwatr/math';\n\nimport type {TokenGeneratorConfig, TokenStatus} from './type.js';\n\n/**\n * Secure authentication HOTP token generator (HMAC-based One-Time Password algorithm).\n */\nexport class AlwatrTokenGenerator {\n  protected _duration: number | null;\n\n  /**\n   * The current epoch based on the configured duration.\n   */\n  get epoch(): number {\n    return this._duration == null ? 0 : Math.floor(Date.now() / this._duration);\n  }\n\n  /**\n   * Creates a new instance of AlwatrTokenGenerator.\n   * @param config The configuration for the token generator.\n   */\n  constructor(public config: TokenGeneratorConfig) {\n    this._duration = config.duration == null ? null : parseDuration(config.duration);\n  }\n\n  /**\n   * Generates a HOTP token based on the provided data for special duration.\n   * @param data The data to generate the token from.\n   * @returns The generated token.\n   * @example\n   * ```typescript\n   * user.auth = tokenGenerator.generate(`${user.id}-${user.role}`);\n   * ```\n   */\n  generate(data: string): string {\n    return this._generate(data, this.epoch);\n  }\n\n  /**\n   * Verifies if a token is valid.\n   * @param data The data used to generate the token.\n   * @param token The token to verify.\n   * @returns The status of the token verification.\n   * @example\n   * ```typescript\n   * const validateStatus = tokenGenerator.verify(`${user.id}-${user.role}`, user.auth);\n   * ```\n   */\n  verify(data: string, token: string): TokenStatus {\n    const epoch = this.epoch;\n    if (token === this._generate(data, epoch)) {\n      return 'valid';\n    }\n    else if (this._duration == null) {\n      return 'invalid';\n    }\n    else if (token === this._generate(data, epoch - 1)) {\n      return 'expired';\n    }\n    else {\n      return 'invalid';\n    }\n  }\n\n  /**\n   * Generates a cryptographic token based on the provided data and epoch.\n   * @param data - The data to be used in the token generation.\n   * @param epoch - The epoch value to be used in the token generation.\n   * @returns The generated cryptographic token.\n   */\n  protected _generate(data: string, epoch: number): string {\n    return this.config.prefix + createHmac(this.config.algorithm, data)\n      .update(data + epoch)\n      .digest(this.config.encoding);\n  }\n}\n"]}

package/type.d.ts

@@ -4,6 +4,7 @@ export type CryptoEncoding = 'base64' | 'base64url' | 'hex' | 'binary';
 export type TokenStatus = 'valid' | 'invalid' | 'expired';
 export type HashStatus = 'valid' | 'invalid';
 export interface TokenGeneratorConfig {
+    prefix: string;
     /**
      * Secret string data to generate token.
      */
@@ -24,6 +25,7 @@ export interface TokenGeneratorConfig {
     encoding: CryptoEncoding;
 }
 export interface HashGeneratorConfig {
+    prefix: string;
     /**
      * OpenSSl digest algorithm.
      */
@@ -37,8 +39,8 @@ export interface HashGeneratorConfig {
      */
     crcLength?: number;
 }
-export interface UserFactoryConfig {
-    tokenConfig: TokenGeneratorConfig;
-    hashConfig: HashGeneratorConfig;
+export interface UserGeneratorConfig {
+    userId: HashGeneratorConfig;
+    token: TokenGeneratorConfig;
 }
 //# sourceMappingURL=type.d.ts.map

package/type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,cAAc,CAAC;AAEjD,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AACzF,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEvE,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAC1D,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,oBAAoB,CAAC;IAClC,UAAU,EAAE,mBAAmB,CAAC;CACjC"}
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,cAAc,CAAC;AAEjD,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AACzF,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEvE,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAC1D,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,KAAK,EAAE,oBAAoB,CAAC;CAC7B"}

package/type.js.map

@@ -1 +1 @@
-{"version":3,"file":"type.js","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":"","sourcesContent":["import type {DurationString} from '@alwatr/math';\n\nexport type CryptoAlgorithm = 'md5' | 'sha1' | 'sha224' | 'sha256' | 'sha384' | 'sha512';\nexport type CryptoEncoding = 'base64' | 'base64url' | 'hex' | 'binary';\n\nexport type TokenStatus = 'valid' | 'invalid' | 'expired';\nexport type HashStatus = 'valid' | 'invalid';\n\nexport interface TokenGeneratorConfig {\n  /**\n   * Secret string data to generate token.\n   */\n  secret: string;\n\n  /**\n   * Token expiration time.\n   *\n   * `null` mean without expiration time\n   */\n  duration: DurationString | null;\n\n  /**\n   * OpenSSl digest algorithm.\n   */\n  algorithm: CryptoAlgorithm;\n\n  /**\n   * Encoding of token.\n   */\n  encoding: CryptoEncoding;\n}\n\nexport interface HashGeneratorConfig {\n  /**\n   * OpenSSl digest algorithm.\n   */\n  algorithm: CryptoAlgorithm;\n\n  /**\n   * Encoding of hash.\n   */\n  encoding: CryptoEncoding;\n\n  /**\n   * CRC hash max length.\n   */\n  crcLength?: number;\n}\n\nexport interface UserFactoryConfig {\n  tokenConfig: TokenGeneratorConfig;\n  hashConfig: HashGeneratorConfig;\n}\n"]}
+{"version":3,"file":"type.js","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":"","sourcesContent":["import type {DurationString} from '@alwatr/math';\n\nexport type CryptoAlgorithm = 'md5' | 'sha1' | 'sha224' | 'sha256' | 'sha384' | 'sha512';\nexport type CryptoEncoding = 'base64' | 'base64url' | 'hex' | 'binary';\n\nexport type TokenStatus = 'valid' | 'invalid' | 'expired';\nexport type HashStatus = 'valid' | 'invalid';\n\nexport interface TokenGeneratorConfig {\n  prefix: string;\n\n  /**\n   * Secret string data to generate token.\n   */\n  secret: string;\n\n  /**\n   * Token expiration time.\n   *\n   * `null` mean without expiration time\n   */\n  duration: DurationString | null;\n\n  /**\n   * OpenSSl digest algorithm.\n   */\n  algorithm: CryptoAlgorithm;\n\n  /**\n   * Encoding of token.\n   */\n  encoding: CryptoEncoding;\n}\n\nexport interface HashGeneratorConfig {\n  prefix: string;\n\n  /**\n   * OpenSSl digest algorithm.\n   */\n  algorithm: CryptoAlgorithm;\n\n  /**\n   * Encoding of hash.\n   */\n  encoding: CryptoEncoding;\n\n  /**\n   * CRC hash max length.\n   */\n  crcLength?: number;\n}\n\nexport interface UserGeneratorConfig {\n  userId: HashGeneratorConfig;\n  token: TokenGeneratorConfig;\n}\n"]}

package/user.d.ts

@@ -1,56 +1,61 @@
 import { AlwatrHashGenerator } from './hash.js';
 import { AlwatrTokenGenerator } from './token.js';
-import type { HashGeneratorConfig, TokenGeneratorConfig, TokenStatus } from './type.js';
+import type { UserGeneratorConfig, TokenStatus } from './type.js';
 /**
  * User factory for generating self-validate user-id and user-token.
  */
-export declare class AlwatrUserFactory {
+export declare class AlwatrUserGenerator {
     protected _tokenGenerator: AlwatrTokenGenerator;
     protected _hashGenerator: AlwatrHashGenerator;
-    constructor(hashConfig: HashGeneratorConfig, tokenConfig: TokenGeneratorConfig);
     /**
-     * Generate new self-verifiable user-id.
-     *
-     * Example:
-     *
-     * ```ts
+     * Creates a new instance of AlwatrUserFactory.
+     * @param hashConfig The configuration for the hash generator.
+     * @param tokenConfig The configuration for the token generator.
+     */
+    constructor(config: UserGeneratorConfig);
+    /**
+     * Generates a new self-verifiable user ID.
+     * @returns The generated user ID.
+     * @example
+     * ```typescript
      * const newUser = {
-     *   id: userFactory.generateId(),
+     *   id: userFactory.generateUserId(),
      *   ...
      * }
      * ```
      */
-    generateId(): string;
+    generateUserId(): string;
     /**
-     * Validate user-id without token.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!userFactory.verifyId(user.id)) {
-     *   new Error('invalid_user');
+     * Validates a user ID without token.
+     * @param userId The user ID to verify.
+     * @returns A boolean indicating whether the user ID is valid.
+     * @example
+     * ```typescript
+     * if (!userFactory.verifyUserId(user.id)) {
+     *   throw new Error('invalid_user');
      * }
      * ```
      */
-    verifyId(id: string): boolean;
+    verifyUserId(userId: string): boolean;
     /**
-     * Generate user auth token.
-     *
-     * Example:
-     *
-     * ```ts
+     * Generates a user authentication token.
+     * @param uniquelyList The list of values to generate the token from.
+     * @returns The generated user token.
+     * @example
+     * ```typescript
      * const userToken = userFactory.generateToken([user.id, user.lpe]);
      * ```
      */
     generateToken(uniquelyList: (string | number | boolean)[]): string;
     /**
-     * Verify user auth token.
-     *
-     * Example:
-     *
-     * ```ts
+     * Verifies a user authentication token.
+     * @param uniquelyList The list of values used to generate the token.
+     * @param token The user token to verify.
+     * @returns The status of the token verification.
+     * @example
+     * ```typescript
      * if (!userFactory.verifyToken([user.id, user.lpe], userToken)) {
-     *   new error('invalid_token');
+     *   throw new Error('invalid_token');
      * }
      * ```
      */

package/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["src/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAC,oBAAoB,EAAC,MAAM,YAAY,CAAC;AAEhD,OAAO,KAAK,EAAC,mBAAmB,EAAE,oBAAoB,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtF;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,SAAS,CAAC,eAAe,uBAAC;IAC1B,SAAS,CAAC,cAAc,sBAAC;gBAEb,UAAU,EAAE,mBAAmB,EAAE,WAAW,EAAE,oBAAoB;IAK9E;;;;;;;;;;;OAWG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAI7B;;;;;;;;OAQG;IACH,aAAa,CAAC,YAAY,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,MAAM;IAIlE;;;;;;;;;;OAUG;IACH,WAAW,CAAC,YAAY,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW;CAGrF"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["src/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD,OAAO,KAAK,EAAC,mBAAmB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAEjE;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,eAAe,EAAE,oBAAoB,CAAC;IAChD,SAAS,CAAC,cAAc,EAAE,mBAAmB,CAAC;IAE9C;;;;OAIG;gBACS,MAAM,EAAE,mBAAmB;IAKvC;;;;;;;;;;OAUG;IACH,cAAc,IAAI,MAAM;IAIxB;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIrC;;;;;;;;OAQG;IACH,aAAa,CAAC,YAAY,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,MAAM;IAIlE;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,YAAY,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW;CAGrF"}

package/user.js

@@ -3,46 +3,50 @@ import { AlwatrTokenGenerator } from './token.js';
 /**
  * User factory for generating self-validate user-id and user-token.
  */
-export class AlwatrUserFactory {
-    constructor(hashConfig, tokenConfig) {
-        this._hashGenerator = new AlwatrHashGenerator(hashConfig);
-        this._tokenGenerator = new AlwatrTokenGenerator(tokenConfig);
+export class AlwatrUserGenerator {
+    /**
+     * Creates a new instance of AlwatrUserFactory.
+     * @param hashConfig The configuration for the hash generator.
+     * @param tokenConfig The configuration for the token generator.
+     */
+    constructor(config) {
+        this._hashGenerator = new AlwatrHashGenerator(config.userId);
+        this._tokenGenerator = new AlwatrTokenGenerator(config.token);
     }
     /**
-     * Generate new self-verifiable user-id.
-     *
-     * Example:
-     *
-     * ```ts
+     * Generates a new self-verifiable user ID.
+     * @returns The generated user ID.
+     * @example
+     * ```typescript
      * const newUser = {
-     *   id: userFactory.generateId(),
+     *   id: userFactory.generateUserId(),
      *   ...
      * }
      * ```
      */
-    generateId() {
-        return 'U' + this._hashGenerator.randomSelfValidate();
+    generateUserId() {
+        return this._hashGenerator.generateRandomSelfValidate();
     }
     /**
-     * Validate user-id without token.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!userFactory.verifyId(user.id)) {
-     *   new Error('invalid_user');
+     * Validates a user ID without token.
+     * @param userId The user ID to verify.
+     * @returns A boolean indicating whether the user ID is valid.
+     * @example
+     * ```typescript
+     * if (!userFactory.verifyUserId(user.id)) {
+     *   throw new Error('invalid_user');
      * }
      * ```
      */
-    verifyId(id) {
-        return this._hashGenerator.verifySelfValidate(id.substring(1));
+    verifyUserId(userId) {
+        return this._hashGenerator.verifySelfValidate(userId);
     }
     /**
-     * Generate user auth token.
-     *
-     * Example:
-     *
-     * ```ts
+     * Generates a user authentication token.
+     * @param uniquelyList The list of values to generate the token from.
+     * @returns The generated user token.
+     * @example
+     * ```typescript
      * const userToken = userFactory.generateToken([user.id, user.lpe]);
      * ```
      */
@@ -50,13 +54,14 @@ export class AlwatrUserFactory {
         return this._tokenGenerator.generate(uniquelyList.join());
     }
     /**
-     * Verify user auth token.
-     *
-     * Example:
-     *
-     * ```ts
+     * Verifies a user authentication token.
+     * @param uniquelyList The list of values used to generate the token.
+     * @param token The user token to verify.
+     * @returns The status of the token verification.
+     * @example
+     * ```typescript
      * if (!userFactory.verifyToken([user.id, user.lpe], userToken)) {
-     *   new error('invalid_token');
+     *   throw new Error('invalid_token');
      * }
      * ```
      */

package/user.js.map

@@ -1 +1 @@
-{"version":3,"file":"user.js","sourceRoot":"","sources":["src/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAC,oBAAoB,EAAC,MAAM,YAAY,CAAC;AAIhD;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAI5B,YAAY,UAA+B,EAAE,WAAiC;QAC5E,IAAI,CAAC,cAAc,GAAG,IAAI,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,GAAG,IAAI,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU;QACR,OAAO,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,YAA2C;QACvD,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,YAA2C,EAAE,KAAa;QACpE,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;CACF","sourcesContent":["import {AlwatrHashGenerator} from './hash.js';\nimport {AlwatrTokenGenerator} from './token.js';\n\nimport type {HashGeneratorConfig, TokenGeneratorConfig, TokenStatus} from './type.js';\n\n/**\n * User factory for generating self-validate user-id and user-token.\n */\nexport class AlwatrUserFactory {\n  protected _tokenGenerator;\n  protected _hashGenerator;\n\n  constructor(hashConfig: HashGeneratorConfig, tokenConfig: TokenGeneratorConfig) {\n    this._hashGenerator = new AlwatrHashGenerator(hashConfig);\n    this._tokenGenerator = new AlwatrTokenGenerator(tokenConfig);\n  }\n\n  /**\n   * Generate new self-verifiable user-id.\n   *\n   * Example:\n   *\n   * ```ts\n   * const newUser = {\n   *   id: userFactory.generateId(),\n   *   ...\n   * }\n   * ```\n   */\n  generateId(): string {\n    return 'U' + this._hashGenerator.randomSelfValidate();\n  }\n\n  /**\n   * Validate user-id without token.\n   *\n   * Example:\n   *\n   * ```ts\n   * if (!userFactory.verifyId(user.id)) {\n   *   new Error('invalid_user');\n   * }\n   * ```\n   */\n  verifyId(id: string): boolean {\n    return this._hashGenerator.verifySelfValidate(id.substring(1));\n  }\n\n  /**\n   * Generate user auth token.\n   *\n   * Example:\n   *\n   * ```ts\n   * const userToken = userFactory.generateToken([user.id, user.lpe]);\n   * ```\n   */\n  generateToken(uniquelyList: (string | number | boolean)[]): string {\n    return this._tokenGenerator.generate(uniquelyList.join());\n  }\n\n  /**\n   * Verify user auth token.\n   *\n   * Example:\n   *\n   * ```ts\n   * if (!userFactory.verifyToken([user.id, user.lpe], userToken)) {\n   *   new error('invalid_token');\n   * }\n   * ```\n   */\n  verifyToken(uniquelyList: (string | number | boolean)[], token: string): TokenStatus {\n    return this._tokenGenerator.verify(uniquelyList.join(), token);\n  }\n}\n"]}
+{"version":3,"file":"user.js","sourceRoot":"","sources":["src/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAIlD;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAI9B;;;;OAIG;IACH,YAAY,MAA2B;QACrC,IAAI,CAAC,cAAc,GAAG,IAAI,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7D,IAAI,CAAC,eAAe,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,cAAc,CAAC,0BAA0B,EAAE,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,YAA2C;QACvD,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,YAA2C,EAAE,KAAa;QACpE,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;CACF","sourcesContent":["import { AlwatrHashGenerator } from './hash.js';\nimport { AlwatrTokenGenerator } from './token.js';\n\nimport type {UserGeneratorConfig, TokenStatus } from './type.js';\n\n/**\n * User factory for generating self-validate user-id and user-token.\n */\nexport class AlwatrUserGenerator {\n  protected _tokenGenerator: AlwatrTokenGenerator;\n  protected _hashGenerator: AlwatrHashGenerator;\n\n  /**\n   * Creates a new instance of AlwatrUserFactory.\n   * @param hashConfig The configuration for the hash generator.\n   * @param tokenConfig The configuration for the token generator.\n   */\n  constructor(config: UserGeneratorConfig) {\n    this._hashGenerator = new AlwatrHashGenerator(config.userId);\n    this._tokenGenerator = new AlwatrTokenGenerator(config.token);\n  }\n\n  /**\n   * Generates a new self-verifiable user ID.\n   * @returns The generated user ID.\n   * @example\n   * ```typescript\n   * const newUser = {\n   *   id: userFactory.generateUserId(),\n   *   ...\n   * }\n   * ```\n   */\n  generateUserId(): string {\n    return this._hashGenerator.generateRandomSelfValidate();\n  }\n\n  /**\n   * Validates a user ID without token.\n   * @param userId The user ID to verify.\n   * @returns A boolean indicating whether the user ID is valid.\n   * @example\n   * ```typescript\n   * if (!userFactory.verifyUserId(user.id)) {\n   *   throw new Error('invalid_user');\n   * }\n   * ```\n   */\n  verifyUserId(userId: string): boolean {\n    return this._hashGenerator.verifySelfValidate(userId);\n  }\n\n  /**\n   * Generates a user authentication token.\n   * @param uniquelyList The list of values to generate the token from.\n   * @returns The generated user token.\n   * @example\n   * ```typescript\n   * const userToken = userFactory.generateToken([user.id, user.lpe]);\n   * ```\n   */\n  generateToken(uniquelyList: (string | number | boolean)[]): string {\n    return this._tokenGenerator.generate(uniquelyList.join());\n  }\n\n  /**\n   * Verifies a user authentication token.\n   * @param uniquelyList The list of values used to generate the token.\n   * @param token The user token to verify.\n   * @returns The status of the token verification.\n   * @example\n   * ```typescript\n   * if (!userFactory.verifyToken([user.id, user.lpe], userToken)) {\n   *   throw new Error('invalid_token');\n   * }\n   * ```\n   */\n  verifyToken(uniquelyList: (string | number | boolean)[], token: string): TokenStatus {\n    return this._tokenGenerator.verify(uniquelyList.join(), token);\n  }\n}\n"]}