@alwatr/crypto 1.2.1 → 3.0.0

package/CHANGELOG.md

@@ -3,6 +3,40 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/Alwatr/alwatr-es-sdk/compare/@alwatr/crypto@2.0.0...@alwatr/crypto@3.0.0) (2023-12-09)
+
+### Bug Fixes
+
+* **crypto:** use import type ([30e3bac](https://github.com/Alwatr/alwatr-es-sdk/commit/30e3bacb187d58417cb62e2a1511de4ade3f80c0)) by @njfamirm
+
+### Features
+
+* **crypto/api:**  AlwatrCryptoFactory with secret and device id ([2d754a1](https://github.com/Alwatr/alwatr-es-sdk/commit/2d754a19b2f04f64d0828e31ba004fc192f466d3)) by @njfamirm
+* **crypto/api:**  device id generator preconfig ([71e80d6](https://github.com/Alwatr/alwatr-es-sdk/commit/71e80d63743579505a6be17d014c364e9f6cf55c)) by @njfamirm
+* **crypto:** complete rewrite with new api ([3d56861](https://github.com/Alwatr/alwatr-es-sdk/commit/3d56861a2857e760c7cd5f03be98f003738fc7a9)) by @AliMD
+* **crypto:** rename user file to api ([52343ea](https://github.com/Alwatr/alwatr-es-sdk/commit/52343ead04c23f50bedac2caa01f46bf489ab318)) by @njfamirm
+
+### BREAKING CHANGES
+
+* **crypto:** new api
+* **crypto/api:** rename AlwatrUserGenerator to AlwatrCryptoFactory and change config
+
+# [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

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/api.d.ts

@@ -0,0 +1,129 @@
+import { DurationString } from '@alwatr/math';
+import { AlwatrHashGenerator } from './hash.js';
+import { AlwatrTokenGenerator, type TokenValidity } from './token.js';
+/**
+ * Configuration options for the CryptoFactory.
+ */
+export interface CryptoFactoryConfig {
+    /**
+     * The secret used for encryption and decryption tokens.
+     */
+    secret: string;
+    /**
+     * The duration for which the token is valid.
+     */
+    duration: DurationString | 'infinite';
+}
+/**
+ * Crypto factory for generating self-validate user-id, user-token, secret, device-id.
+ */
+export declare class AlwatrCryptoFactory {
+    protected _generators: {
+        readonly secret: AlwatrHashGenerator;
+        readonly deviceId: AlwatrHashGenerator;
+        readonly userId: AlwatrHashGenerator;
+        readonly token: AlwatrTokenGenerator;
+    };
+    /**
+     * Creates a new instance of crypto factory.
+     * @param config The configuration used to create the crypto factory.
+     */
+    constructor(config: CryptoFactoryConfig);
+    /**
+     * Generate self-verifiable user ID.
+     * @returns The generated user ID.
+     * @example
+     * ```typescript
+     * const newUser = {
+     *   id: cryptoFactory.generateUserId(),
+     *   ...
+     * }
+     * ```
+     */
+    generateUserId(): string;
+    /**
+     * Verify 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 (!cryptoFactory.verifyUserId(user.id)) {
+     *   throw new Error('invalid_user');
+     * }
+     * ```
+     */
+    verifyUserId(userId: string): boolean;
+    /**
+     * Generate authentication token.
+     * @param uniquelyList The list of uniq values to generate the token from.
+     * @returns The generated user token.
+     * @example
+     * ```typescript
+     * const userToken = cryptoFactory.generateToken([user.id, user.lpe]);
+     * ```
+     */
+    generateToken(uniquelyList: (string | number)[]): string;
+    /**
+     * Verify a authentication token.
+     * @param uniquelyList The list of uniq values used to generate the token.
+     * @param token The user token to verify.
+     * @returns The validity of the token.
+     * @example
+     * ```typescript
+     * if (!cryptoFactory.verifyToken([user.id, user.lpe], userToken)) {
+     *   throw new Error('invalid_token');
+     * }
+     * ```
+     */
+    verifyToken(uniquelyList: (string | number)[], token: string): TokenValidity;
+    /**
+     * Generate self-verifiable secret.
+     * @returns The generated secret.
+     * @example
+     * ```typescript
+     * const config = {
+     *   storageToken: cryptoFactory.generateSecret(),
+     *   ...
+     * }
+     * ```
+     */
+    generateSecret(): string;
+    /**
+     * Verify a secret.
+     * @param secret The secret to verify.
+     * @returns A boolean indicating whether the secret is valid.
+     * @example
+     * ```typescript
+     * if (!cryptoFactory.verifySecret(config.storageToken)) {
+     *   throw new Error('invalid_secret');
+     * }
+     * ```
+     */
+    verifySecret(secret: string): boolean;
+    /**
+     * Generate self-verifiable device ID.
+     * @returns The generated device ID.
+     * @example
+     * ```typescript
+     * const deviceId = deviceFactory.generateDeviceId();
+     * ```
+     */
+    generateDeviceId(): string;
+    /**
+     * Verify a device ID.
+     * @param deviceId The device ID to verify.
+     * @returns A boolean indicating whether the device ID is valid.
+     * @example
+     * ```typescript
+     * if (!deviceFactory.verifyDeviceId(bodyJson.deviceId)) {
+     *   throw {
+     *    ok: false,
+     *    status: 400,
+     *    error: 'invalid_device_id',
+     *   }
+     * }
+     * ```
+     */
+    verifyDeviceId(deviceId: string): boolean;
+}
+//# sourceMappingURL=api.d.ts.map

package/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,cAAc,CAAC;AAE5C,OAAO,EAAC,mBAAmB,EAAC,MAAM,WAAW,CAAC;AAO9C,OAAO,EAAC,oBAAoB,EAAE,KAAK,aAAa,EAAC,MAAM,YAAY,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,cAAc,GAAG,UAAU,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,WAAW;;;;;MAAC;IAEtB;;;OAGG;gBACS,MAAM,EAAE,mBAAmB;IAYvC;;;;;;;;;;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,CAAC,EAAE,GAAG,MAAM;IAIxD;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,YAAY,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa;IAI5E;;;;;;;;;;OAUG;IACH,cAAc,IAAI,MAAM;IAIxB;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIrC;;;;;;;OAOG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAG1C"}

package/api.js

@@ -0,0 +1,136 @@
+import { AlwatrHashGenerator } from './hash.js';
+import { deviceIdGeneratorRecommendedConfig, secretGeneratorRecommendedConfig, userIdGeneratorRecommendedConfig, userTokenGeneratorRecommendedConfig, } from './pre-config.js';
+import { AlwatrTokenGenerator } from './token.js';
+/**
+ * Crypto factory for generating self-validate user-id, user-token, secret, device-id.
+ */
+export class AlwatrCryptoFactory {
+    /**
+     * Creates a new instance of crypto factory.
+     * @param config The configuration used to create the crypto factory.
+     */
+    constructor(config) {
+        this._generators = {
+            secret: new AlwatrHashGenerator(secretGeneratorRecommendedConfig),
+            deviceId: new AlwatrHashGenerator(deviceIdGeneratorRecommendedConfig),
+            userId: new AlwatrHashGenerator(userIdGeneratorRecommendedConfig),
+            token: new AlwatrTokenGenerator({
+                ...userTokenGeneratorRecommendedConfig,
+                ...config
+            }),
+        };
+    }
+    /**
+     * Generate self-verifiable user ID.
+     * @returns The generated user ID.
+     * @example
+     * ```typescript
+     * const newUser = {
+     *   id: cryptoFactory.generateUserId(),
+     *   ...
+     * }
+     * ```
+     */
+    generateUserId() {
+        return this._generators.userId.generateRandomSelfValidate();
+    }
+    /**
+     * Verify 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 (!cryptoFactory.verifyUserId(user.id)) {
+     *   throw new Error('invalid_user');
+     * }
+     * ```
+     */
+    verifyUserId(userId) {
+        return this._generators.userId.verifySelfValidate(userId);
+    }
+    /**
+     * Generate authentication token.
+     * @param uniquelyList The list of uniq values to generate the token from.
+     * @returns The generated user token.
+     * @example
+     * ```typescript
+     * const userToken = cryptoFactory.generateToken([user.id, user.lpe]);
+     * ```
+     */
+    generateToken(uniquelyList) {
+        return this._generators.token.generate(uniquelyList.join());
+    }
+    /**
+     * Verify a authentication token.
+     * @param uniquelyList The list of uniq values used to generate the token.
+     * @param token The user token to verify.
+     * @returns The validity of the token.
+     * @example
+     * ```typescript
+     * if (!cryptoFactory.verifyToken([user.id, user.lpe], userToken)) {
+     *   throw new Error('invalid_token');
+     * }
+     * ```
+     */
+    verifyToken(uniquelyList, token) {
+        return this._generators.token.verify(uniquelyList.join(), token);
+    }
+    /**
+     * Generate self-verifiable secret.
+     * @returns The generated secret.
+     * @example
+     * ```typescript
+     * const config = {
+     *   storageToken: cryptoFactory.generateSecret(),
+     *   ...
+     * }
+     * ```
+     */
+    generateSecret() {
+        return this._generators.secret.generateRandomSelfValidate();
+    }
+    /**
+     * Verify a secret.
+     * @param secret The secret to verify.
+     * @returns A boolean indicating whether the secret is valid.
+     * @example
+     * ```typescript
+     * if (!cryptoFactory.verifySecret(config.storageToken)) {
+     *   throw new Error('invalid_secret');
+     * }
+     * ```
+     */
+    verifySecret(secret) {
+        return this._generators.secret.verifySelfValidate(secret);
+    }
+    /**
+     * Generate self-verifiable device ID.
+     * @returns The generated device ID.
+     * @example
+     * ```typescript
+     * const deviceId = deviceFactory.generateDeviceId();
+     * ```
+     */
+    generateDeviceId() {
+        return this._generators.deviceId.generateRandomSelfValidate();
+    }
+    /**
+     * Verify a device ID.
+     * @param deviceId The device ID to verify.
+     * @returns A boolean indicating whether the device ID is valid.
+     * @example
+     * ```typescript
+     * if (!deviceFactory.verifyDeviceId(bodyJson.deviceId)) {
+     *   throw {
+     *    ok: false,
+     *    status: 400,
+     *    error: 'invalid_device_id',
+     *   }
+     * }
+     * ```
+     */
+    verifyDeviceId(deviceId) {
+        return this._generators.deviceId.verifySelfValidate(deviceId);
+    }
+}
+//# sourceMappingURL=api.js.map

package/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["src/api.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,mBAAmB,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,EACL,kCAAkC,EAClC,gCAAgC,EAChC,gCAAgC,EAChC,mCAAmC,GACpC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,oBAAoB,EAAqB,MAAM,YAAY,CAAC;AAiBpE;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAG9B;;;OAGG;IACH,YAAY,MAA2B;QACrC,IAAI,CAAC,WAAW,GAAG;YACjB,MAAM,EAAE,IAAI,mBAAmB,CAAC,gCAAgC,CAAC;YACjE,QAAQ,EAAE,IAAI,mBAAmB,CAAC,kCAAkC,CAAC;YACrE,MAAM,EAAE,IAAI,mBAAmB,CAAC,gCAAgC,CAAC;YACjE,KAAK,EAAE,IAAI,oBAAoB,CAAC;gBAC9B,GAAG,mCAAmC;gBACtC,GAAG,MAAM;aACV,CAAC;SACM,CAAC;IACb,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,YAAiC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,YAAiC,EAAE,KAAa;QAC1D,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,0BAA0B,EAAE,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAChE,CAAC;CACF","sourcesContent":["import {DurationString} from '@alwatr/math';\n\nimport {AlwatrHashGenerator} from './hash.js';\nimport {\n  deviceIdGeneratorRecommendedConfig,\n  secretGeneratorRecommendedConfig,\n  userIdGeneratorRecommendedConfig,\n  userTokenGeneratorRecommendedConfig,\n} from './pre-config.js';\nimport {AlwatrTokenGenerator, type TokenValidity} from './token.js';\n\n/**\n * Configuration options for the CryptoFactory.\n */\nexport interface CryptoFactoryConfig {\n  /**\n   * The secret used for encryption and decryption tokens.\n   */\n  secret: string;\n\n  /**\n   * The duration for which the token is valid.\n   */\n  duration: DurationString | 'infinite';\n}\n\n/**\n * Crypto factory for generating self-validate user-id, user-token, secret, device-id.\n */\nexport class AlwatrCryptoFactory {\n  protected _generators;\n\n  /**\n   * Creates a new instance of crypto factory.\n   * @param config The configuration used to create the crypto factory.\n   */\n  constructor(config: CryptoFactoryConfig) {\n    this._generators = {\n      secret: new AlwatrHashGenerator(secretGeneratorRecommendedConfig),\n      deviceId: new AlwatrHashGenerator(deviceIdGeneratorRecommendedConfig),\n      userId: new AlwatrHashGenerator(userIdGeneratorRecommendedConfig),\n      token: new AlwatrTokenGenerator({\n        ...userTokenGeneratorRecommendedConfig,\n        ...config\n      }),\n    } as const;\n  }\n\n  /**\n   * Generate self-verifiable user ID.\n   * @returns The generated user ID.\n   * @example\n   * ```typescript\n   * const newUser = {\n   *   id: cryptoFactory.generateUserId(),\n   *   ...\n   * }\n   * ```\n   */\n  generateUserId(): string {\n    return this._generators.userId.generateRandomSelfValidate();\n  }\n\n  /**\n   * Verify 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 (!cryptoFactory.verifyUserId(user.id)) {\n   *   throw new Error('invalid_user');\n   * }\n   * ```\n   */\n  verifyUserId(userId: string): boolean {\n    return this._generators.userId.verifySelfValidate(userId);\n  }\n\n  /**\n   * Generate authentication token.\n   * @param uniquelyList The list of uniq values to generate the token from.\n   * @returns The generated user token.\n   * @example\n   * ```typescript\n   * const userToken = cryptoFactory.generateToken([user.id, user.lpe]);\n   * ```\n   */\n  generateToken(uniquelyList: (string | number)[]): string {\n    return this._generators.token.generate(uniquelyList.join());\n  }\n\n  /**\n   * Verify a authentication token.\n   * @param uniquelyList The list of uniq values used to generate the token.\n   * @param token The user token to verify.\n   * @returns The validity of the token.\n   * @example\n   * ```typescript\n   * if (!cryptoFactory.verifyToken([user.id, user.lpe], userToken)) {\n   *   throw new Error('invalid_token');\n   * }\n   * ```\n   */\n  verifyToken(uniquelyList: (string | number)[], token: string): TokenValidity {\n    return this._generators.token.verify(uniquelyList.join(), token);\n  }\n\n  /**\n   * Generate self-verifiable secret.\n   * @returns The generated secret.\n   * @example\n   * ```typescript\n   * const config = {\n   *   storageToken: cryptoFactory.generateSecret(),\n   *   ...\n   * }\n   * ```\n   */\n  generateSecret(): string {\n    return this._generators.secret.generateRandomSelfValidate();\n  }\n\n  /**\n   * Verify a secret.\n   * @param secret The secret to verify.\n   * @returns A boolean indicating whether the secret is valid.\n   * @example\n   * ```typescript\n   * if (!cryptoFactory.verifySecret(config.storageToken)) {\n   *   throw new Error('invalid_secret');\n   * }\n   * ```\n   */\n  verifySecret(secret: string): boolean {\n    return this._generators.secret.verifySelfValidate(secret);\n  }\n\n  /**\n   * Generate self-verifiable device ID.\n   * @returns The generated device ID.\n   * @example\n   * ```typescript\n   * const deviceId = deviceFactory.generateDeviceId();\n   * ```\n   */\n  generateDeviceId(): string {\n    return this._generators.deviceId.generateRandomSelfValidate();\n  }\n\n  /**\n   * Verify a device ID.\n   * @param deviceId The device ID to verify.\n   * @returns A boolean indicating whether the device ID is valid.\n   * @example\n   * ```typescript\n   * if (!deviceFactory.verifyDeviceId(bodyJson.deviceId)) {\n   *   throw {\n   *    ok: false,\n   *    status: 400,\n   *    error: 'invalid_device_id',\n   *   }\n   * }\n   * ```\n   */\n  verifyDeviceId(deviceId: string): boolean {\n    return this._generators.deviceId.verifySelfValidate(deviceId);\n  }\n}\n"]}

package/hash.d.ts

@@ -1,76 +1,102 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
 import { type BinaryLike } from 'node:crypto';
-import type { HashGeneratorConfig } from './type.js';
+import type { CryptoAlgorithm, CryptoEncoding } from './type.js';
+/**
+ * Represents the configuration for a hash generator.
+ */
+export interface HashGeneratorConfig {
+    /**
+     * The prefix to be added to the generated hash.
+     */
+    prefix: string;
+    /**
+     * The algorithm used for hashing.
+     */
+    algorithm: CryptoAlgorithm;
+    /**
+     * The encoding used for the generated hash.
+     */
+    encoding: CryptoEncoding;
+    /**
+     * The length of the CRC (Cyclic Redundancy Check) value.
+     */
+    crcLength: number;
+}
 /**
  * Secure **self-validate** hash generator.
  */
 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)) {
-     *   new Error('invalid_user');
+     * 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_hash');
      * }
      * ```
      */

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,EAA0B,KAAK,UAAU,EAAC,MAAM,aAAa,CAAC;AAErE,OAAO,KAAK,EAAC,eAAe,EAAE,cAAc,EAAC,MAAM,WAAW,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;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;CAM1C"}

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,21 @@ 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)) {
-     *   new Error('invalid_user');
+     * 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_hash');
      * }
      * ```
      */
     verifySelfValidate(hash) {
-        const gapPos = this.config.crcLength == null || this.config.crcLength < 1
-            ? hash.length / 2
-            : hash.length - this.config.crcLength;
-        const mainHash = hash.substring(0, gapPos);
-        const crcHash = hash.substring(gapPos);
-        return crcHash === this._generateCrc(mainHash);
+        const gapPos = hash.length - this.config.crcLength;
+        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,EAAC,UAAU,EAAE,WAAW,EAAkB,MAAM,aAAa,CAAC;AA6BrE;;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,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;QACnD,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 {CryptoAlgorithm, CryptoEncoding} from './type.js';\n\n/**\n * Represents the configuration for a hash generator.\n */\nexport interface HashGeneratorConfig {\n  /**\n   * The prefix to be added to the generated hash.\n   */\n  prefix: string;\n\n  /**\n   * The algorithm used for hashing.\n   */\n  algorithm: CryptoAlgorithm;\n\n  /**\n   * The encoding used for the generated hash.\n   */\n  encoding: CryptoEncoding;\n\n  /**\n   * The length of the CRC (Cyclic Redundancy Check) value.\n   */\n  crcLength: number;\n}\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_hash');\n   * }\n   * ```\n   */\n  verifySelfValidate(hash: string): boolean {\n    const gapPos = 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/index.d.ts

@@ -1,6 +1,6 @@
 export * from './hash.js';
 export * from './token.js';
-export * from './user.js';
+export * from './api.js';
 export * from './type.js';
 export * from './pre-config.js';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC"}

package/index.js

@@ -1,8 +1,8 @@
 import { definePackage } from '@alwatr/logger';
 export * from './hash.js';
 export * from './token.js';
-export * from './user.js';
+export * from './api.js';
 export * from './type.js';
 export * from './pre-config.js';
-definePackage('crypto', '1.x');
+definePackage('crypto', '3.x');
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,gBAAgB,CAAC;AAE7C,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAEhC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC","sourcesContent":["import {definePackage} from '@alwatr/logger';\n\nexport * from './hash.js';\nexport * from './token.js';\nexport * from './user.js';\nexport * from './type.js';\nexport * from './pre-config.js';\n\ndefinePackage('crypto', '1.x');\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,gBAAgB,CAAC;AAE7C,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAEhC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC","sourcesContent":["import {definePackage} from '@alwatr/logger';\n\nexport * from './hash.js';\nexport * from './token.js';\nexport * from './api.js';\nexport * from './type.js';\nexport * from './pre-config.js';\n\ndefinePackage('crypto', '3.x');\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@alwatr/crypto",
-  "version": "1.2.1",
-  "description": "Secure authentication HOTP token generator (the HMAC-based One-Time Password algorithm) and crypto utils written in tiny TypeScript module.",
+  "version": "3.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",
@@ -32,21 +32,20 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Alwatr/eslib",
+    "url": "https://github.com/Alwatr/alwatr-es-sdk",
     "directory": "packages/crypto"
   },
-  "homepage": "https://github.com/Alwatr/eslib/tree/next/packages/crypto#readme",
+  "homepage": "https://github.com/Alwatr/alwatr-es-sdk/tree/next/packages/crypto#readme",
   "bugs": {
-    "url": "https://github.com/Alwatr/eslib/issues"
+    "url": "https://github.com/Alwatr/alwatr-es-sdk/issues"
   },
   "dependencies": {
-    "@alwatr/logger": "^2.3.0",
-    "@alwatr/math": "^1.2.1",
-    "@alwatr/util": "^1.3.1",
-    "tslib": "^2.6.2"
+    "@alwatr/logger": "^2.3.2",
+    "@alwatr/math": "^1.2.3",
+    "@alwatr/util": "^1.3.3"
   },
   "devDependencies": {
-    "@types/node": "^20.9.4"
+    "@types/node": "^20.10.4"
   },
-  "gitHead": "0f5a2f89263e9bf03a7f5087b0715ea1fc059674"
+  "gitHead": "932c439c39ad9aa340cf53e0704cece565d68326"
 }

package/pre-config.d.ts

@@ -1,14 +1,19 @@
-import { HashGeneratorConfig, TokenGeneratorConfig } from './type.js';
+import type { HashGeneratorConfig } from './hash.js';
+import type { TokenGeneratorConfig } from './token.js';
 /**
- * Hash generator pre configuration for making random self-validate **secrets**.
+ * Alwatr hash generator recommended configuration for making random self-validate **user-id**.
+ */
+export declare const userIdGeneratorRecommendedConfig: HashGeneratorConfig;
+/**
+ * Hash generator recommended configuration for making random self-validate **device-id**.
  */
-export declare const secretGeneratorPreConfig: HashGeneratorConfig;
+export declare const deviceIdGeneratorRecommendedConfig: HashGeneratorConfig;
 /**
- * Hash generator pre configuration for making random self-validate **user-id**.
+ * Hash generator pre configuration for making random self-validate **secrets**.
  */
-export declare const userIdGeneratorPreConfig: HashGeneratorConfig;
+export declare const secretGeneratorRecommendedConfig: HashGeneratorConfig;
 /**
- * Token generator pre configuration for making secure self-validate **user-token**.
+ * Token generator recommended configuration for making secure self-validate **user-token**.
  */
-export declare const userTokenGeneratorPreConfig: Pick<TokenGeneratorConfig, 'algorithm' | 'encoding'>;
+export declare const userTokenGeneratorRecommendedConfig: Omit<TokenGeneratorConfig, 'secret' | 'duration'>;
 //# 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,KAAK,EAAC,mBAAmB,EAAC,MAAM,WAAW,CAAC;AACnD,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,YAAY,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,gCAAgC,EAAE,mBAK9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,EAAE,mBAGhD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,EAAE,mBAK9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC,EAAE,IAAI,CAAC,oBAAoB,EAAE,QAAQ,GAAG,UAAU,CAIjG,CAAC"}

package/pre-config.js

@@ -1,23 +1,33 @@
 /**
- * Hash generator pre configuration for making random self-validate **secrets**.
+ * Alwatr hash generator recommended configuration for making random self-validate **user-id**.
  */
-export const secretGeneratorPreConfig = {
-    algorithm: 'sha256',
+export const userIdGeneratorRecommendedConfig = {
+    prefix: 'u',
+    algorithm: 'sha1',
     encoding: 'base64url',
     crcLength: 4,
 };
 /**
- * Hash generator pre configuration for making random self-validate **user-id**.
+ * Hash generator recommended configuration for making random self-validate **device-id**.
  */
-export const userIdGeneratorPreConfig = {
-    algorithm: 'sha1',
+export const deviceIdGeneratorRecommendedConfig = {
+    ...userIdGeneratorRecommendedConfig,
+    prefix: 'd',
+};
+/**
+ * Hash generator pre configuration for making random self-validate **secrets**.
+ */
+export const secretGeneratorRecommendedConfig = {
+    prefix: 's',
+    algorithm: 'sha384',
     encoding: 'base64url',
     crcLength: 4,
 };
 /**
- * Token generator pre configuration for making secure self-validate **user-token**.
+ * Token generator recommended configuration for making secure self-validate **user-token**.
  */
-export const userTokenGeneratorPreConfig = {
+export const userTokenGeneratorRecommendedConfig = {
+    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":"AAGA;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAwB;IACnE,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAwB;IACrE,GAAG,gCAAgC;IACnC,MAAM,EAAE,GAAG;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAwB;IACnE,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAsD;IACpG,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,WAAW;CACtB,CAAC","sourcesContent":["import type {HashGeneratorConfig} from './hash.js';\nimport type {TokenGeneratorConfig} from './token.js';\n\n/**\n * Alwatr hash generator recommended configuration for making random self-validate **user-id**.\n */\nexport const userIdGeneratorRecommendedConfig: HashGeneratorConfig = {\n  prefix: 'u',\n  algorithm: 'sha1',\n  encoding: 'base64url',\n  crcLength: 4,\n};\n\n/**\n * Hash generator recommended configuration for making random self-validate **device-id**.\n */\nexport const deviceIdGeneratorRecommendedConfig: HashGeneratorConfig = {\n  ...userIdGeneratorRecommendedConfig,\n  prefix: 'd',\n};\n\n/**\n * Hash generator pre configuration for making random self-validate **secrets**.\n */\nexport const secretGeneratorRecommendedConfig: HashGeneratorConfig = {\n  prefix: 's',\n  algorithm: 'sha384',\n  encoding: 'base64url',\n  crcLength: 4,\n};\n\n/**\n * Token generator recommended configuration for making secure self-validate **user-token**.\n */\nexport const userTokenGeneratorRecommendedConfig: Omit<TokenGeneratorConfig, 'secret' | 'duration'> = {\n  prefix: 't',\n  algorithm: 'sha224',\n  encoding: 'base64url',\n};\n"]}

package/token.d.ts

@@ -1,28 +1,73 @@
-import type { TokenGeneratorConfig, TokenStatus } from './type.js';
+import { DurationString } from '@alwatr/math';
+import type { CryptoAlgorithm, CryptoEncoding } from './type.js';
+export type TokenValidity = 'valid' | 'invalid' | 'expired';
+/**
+ * Represents the configuration for a token generator.
+ */
+export interface TokenGeneratorConfig {
+    /**
+     * The prefix to be added to the generated hash.
+     */
+    prefix: string;
+    /**
+     * The algorithm used for hashing.
+     */
+    algorithm: CryptoAlgorithm;
+    /**
+     * The encoding used for the generated hash.
+     */
+    encoding: CryptoEncoding;
+    /**
+     * The secret used for encryption and decryption tokens.
+     */
+    secret: string;
+    /**
+     * The duration for which the token is valid.
+     */
+    duration: DurationString | 'infinite';
+}
 /**
  * Secure authentication HOTP token generator (HMAC-based One-Time Password algorithm).
  */
 export declare class AlwatrTokenGenerator {
     config: TokenGeneratorConfig;
-    protected _duration: number | null;
-    get epoch(): number;
+    private _duration;
+    /**
+     * The current epoch based on the configured duration.
+     */
+    protected 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
-     * const validateStatus = tokenGenerator.verify(`${user.id}-${user.role}`, user.auth);
+     * Verifies if a token is valid.
+     * @param data The data used to generate the token.
+     * @param token The token to verify.
+     * @returns The validity of the token.
+     * @example
+     * ```typescript
+     * const validateStatus = tokenGenerator.verify([user.id,user.role].join(), user.auth);
      * ```
      */
-    verify(data: string, token: string): TokenStatus;
+    verify(data: string, token: string): TokenValidity;
+    /**
+     * 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":"AAEA,OAAO,EAAC,cAAc,EAAgB,MAAM,cAAc,CAAC;AAE3D,OAAO,KAAK,EAAC,eAAe,EAAE,cAAc,EAAC,MAAM,WAAW,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,cAAc,GAAG,UAAU,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAcZ,MAAM,EAAE,oBAAoB;IAb/C,OAAO,CAAC,SAAS,CAAS;IAE1B;;OAEG;IACH,SAAS,KAAK,MAAM,IAAI,MAAM,CAE7B;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,aAAa;IAQlD;;;;;OAKG;IACH,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAQzD"}

package/token.js

@@ -4,49 +4,63 @@ import { parseDuration } from '@alwatr/math';
  * Secure authentication HOTP token generator (HMAC-based One-Time Password algorithm).
  */
 export class AlwatrTokenGenerator {
-    get epoch() {
-        return this._duration == null ? 0 : Math.floor(Date.now() / this._duration);
+    /**
+     * The current epoch based on the configured duration.
+     */
+    get _epoch() {
+        return this._duration == 0 ? 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);
+        this._duration = config.duration == 'infinite' ? 0 : parseDuration(config.duration);
     }
     /**
-     * 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) {
-        return this._generate(data, this.epoch);
+        return this._generate(data, this._epoch);
     }
     /**
-     * Token verification.
-     *
-     * ```ts
-     * const validateStatus = tokenGenerator.verify(`${user.id}-${user.role}`, user.auth);
+     * Verifies if a token is valid.
+     * @param data The data used to generate the token.
+     * @param token The token to verify.
+     * @returns The validity of the token.
+     * @example
+     * ```typescript
+     * const validateStatus = tokenGenerator.verify([user.id,user.role].join(), user.auth);
      * ```
      */
     verify(data, token) {
-        const epoch = this.epoch;
-        if (token === this._generate(data, epoch)) {
+        const epoch = this._epoch;
+        if (token === this._generate(data, epoch))
             return 'valid';
-        }
-        else if (this._duration == null) {
+        if (this._duration == 0)
             return 'invalid';
-        }
-        else if (token === this._generate(data, epoch - 1)) {
+        if (token === this._generate(data, epoch - 1))
             return 'expired';
-        }
-        else {
-            return 'invalid';
-        }
+        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,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;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,EAAiB,aAAa,EAAC,MAAM,cAAc,CAAC;AAoC3D;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAG/B;;OAEG;IACH,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,YAAmB,MAA4B;QAA5B,WAAM,GAAN,MAAM,CAAsB;QAC7C,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAY;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAY,EAAE,KAAa;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC;YAAE,OAAO,OAAO,CAAC;QAC1D,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC;YAAE,OAAO,SAAS,CAAC;QAC1C,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QAChE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACO,SAAS,CAAC,IAAY,EAAE,KAAa;QAC7C,OAAO,CACL,IAAI,CAAC,MAAM,CAAC,MAAM;YAClB,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC;iBACpC,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC;iBACpB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAChC,CAAC;IACJ,CAAC;CACF","sourcesContent":["import {createHmac} from 'node:crypto';\n\nimport {DurationString, parseDuration} from '@alwatr/math';\n\nimport type {CryptoAlgorithm, CryptoEncoding} from './type.js';\n\nexport type TokenValidity = 'valid' | 'invalid' | 'expired';\n\n/**\n * Represents the configuration for a token generator.\n */\nexport interface TokenGeneratorConfig {\n  /**\n   * The prefix to be added to the generated hash.\n   */\n  prefix: string;\n\n  /**\n   * The algorithm used for hashing.\n   */\n  algorithm: CryptoAlgorithm;\n\n  /**\n   * The encoding used for the generated hash.\n   */\n  encoding: CryptoEncoding;\n\n  /**\n   * The secret used for encryption and decryption tokens.\n   */\n  secret: string;\n\n  /**\n   * The duration for which the token is valid.\n   */\n  duration: DurationString | 'infinite';\n}\n\n/**\n * Secure authentication HOTP token generator (HMAC-based One-Time Password algorithm).\n */\nexport class AlwatrTokenGenerator {\n  private _duration: number;\n\n  /**\n   * The current epoch based on the configured duration.\n   */\n  protected get _epoch(): number {\n    return this._duration == 0 ? 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 == 'infinite' ? 0 : 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 validity of the token.\n   * @example\n   * ```typescript\n   * const validateStatus = tokenGenerator.verify([user.id,user.role].join(), user.auth);\n   * ```\n   */\n  verify(data: string, token: string): TokenValidity {\n    const epoch = this._epoch;\n    if (token === this._generate(data, epoch)) return 'valid';\n    if (this._duration == 0) return 'invalid';\n    if (token === this._generate(data, epoch - 1)) return 'expired';\n    return 'invalid';\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 (\n      this.config.prefix +\n      createHmac(this.config.algorithm, data)\n        .update(data + epoch)\n        .digest(this.config.encoding)\n    );\n  }\n}\n"]}

package/type.d.ts

@@ -1,44 +1,11 @@
-import type { DurationString } from '@alwatr/math';
+/**
+ * Represents a cryptographic algorithm.
+ * Supported algorithms include: 'md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512'.
+ */
 export type CryptoAlgorithm = 'md5' | 'sha1' | 'sha224' | 'sha256' | 'sha384' | 'sha512';
+/**
+ * Represents the encoding options for cryptographic operations.
+ * The encoding can be one of the following: 'base64', 'base64url', 'hex', or 'binary'.
+ */
 export type CryptoEncoding = 'base64' | 'base64url' | 'hex' | 'binary';
-export type TokenStatus = 'valid' | 'invalid' | 'expired';
-export type HashStatus = 'valid' | 'invalid';
-export interface TokenGeneratorConfig {
-    /**
-     * Secret string data to generate token.
-     */
-    secret: string;
-    /**
-     * Token expiration time.
-     *
-     * `null` mean without expiration time
-     */
-    duration: DurationString | null;
-    /**
-     * OpenSSl digest algorithm.
-     */
-    algorithm: CryptoAlgorithm;
-    /**
-     * Encoding of token.
-     */
-    encoding: CryptoEncoding;
-}
-export interface HashGeneratorConfig {
-    /**
-     * OpenSSl digest algorithm.
-     */
-    algorithm: CryptoAlgorithm;
-    /**
-     * Encoding of hash.
-     */
-    encoding: CryptoEncoding;
-    /**
-     * CRC hash max length.
-     */
-    crcLength?: number;
-}
-export interface UserFactoryConfig {
-    tokenConfig: TokenGeneratorConfig;
-    hashConfig: HashGeneratorConfig;
-}
 //# 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;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,GAAG,KAAK,GAAG,QAAQ,CAAC"}

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":["/**\n * Represents a cryptographic algorithm.\n * Supported algorithms include: 'md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512'.\n */\nexport type CryptoAlgorithm = 'md5' | 'sha1' | 'sha224' | 'sha256' | 'sha384' | 'sha512';\n\n/**\n * Represents the encoding options for cryptographic operations.\n * The encoding can be one of the following: 'base64', 'base64url', 'hex', or 'binary'.\n */\nexport type CryptoEncoding = 'base64' | 'base64url' | 'hex' | 'binary';\n"]}

package/user.d.ts

@@ -1,59 +0,0 @@
-import { AlwatrHashGenerator } from './hash.js';
-import { AlwatrTokenGenerator } from './token.js';
-import type { HashGeneratorConfig, TokenGeneratorConfig, TokenStatus } from './type.js';
-/**
- * User factory for generating self-validate user-id and user-token.
- */
-export declare class AlwatrUserFactory {
-    protected _tokenGenerator: AlwatrTokenGenerator;
-    protected _hashGenerator: AlwatrHashGenerator;
-    constructor(hashConfig: HashGeneratorConfig, tokenConfig: TokenGeneratorConfig);
-    /**
-     * Generate new self-verifiable user-id.
-     *
-     * Example:
-     *
-     * ```ts
-     * const newUser = {
-     *   id: userFactory.generateId(),
-     *   ...
-     * }
-     * ```
-     */
-    generateId(): string;
-    /**
-     * Validate user-id without token.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!userFactory.verifyId(user.id)) {
-     *   new Error('invalid_user');
-     * }
-     * ```
-     */
-    verifyId(id: string): boolean;
-    /**
-     * Generate user auth token.
-     *
-     * Example:
-     *
-     * ```ts
-     * const userToken = userFactory.generateToken([user.id, user.lpe]);
-     * ```
-     */
-    generateToken(uniquelyList: (string | number | boolean)[]): string;
-    /**
-     * Verify user auth token.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!userFactory.verifyToken([user.id, user.lpe], userToken)) {
-     *   new error('invalid_token');
-     * }
-     * ```
-     */
-    verifyToken(uniquelyList: (string | number | boolean)[], token: string): TokenStatus;
-}
-//# sourceMappingURL=user.d.ts.map

package/user.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/user.js

@@ -1,67 +0,0 @@
-import { AlwatrHashGenerator } from './hash.js';
-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);
-    }
-    /**
-     * Generate new self-verifiable user-id.
-     *
-     * Example:
-     *
-     * ```ts
-     * const newUser = {
-     *   id: userFactory.generateId(),
-     *   ...
-     * }
-     * ```
-     */
-    generateId() {
-        return 'U' + this._hashGenerator.randomSelfValidate();
-    }
-    /**
-     * Validate user-id without token.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!userFactory.verifyId(user.id)) {
-     *   new Error('invalid_user');
-     * }
-     * ```
-     */
-    verifyId(id) {
-        return this._hashGenerator.verifySelfValidate(id.substring(1));
-    }
-    /**
-     * Generate user auth token.
-     *
-     * Example:
-     *
-     * ```ts
-     * const userToken = userFactory.generateToken([user.id, user.lpe]);
-     * ```
-     */
-    generateToken(uniquelyList) {
-        return this._tokenGenerator.generate(uniquelyList.join());
-    }
-    /**
-     * Verify user auth token.
-     *
-     * Example:
-     *
-     * ```ts
-     * if (!userFactory.verifyToken([user.id, user.lpe], userToken)) {
-     *   new error('invalid_token');
-     * }
-     * ```
-     */
-    verifyToken(uniquelyList, token) {
-        return this._tokenGenerator.verify(uniquelyList.join(), token);
-    }
-}
-//# sourceMappingURL=user.js.map

package/user.js.map

@@ -1 +0,0 @@
-{"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"]}