nhb-toolbox 4.28.0 → 4.28.1

package/CHANGELOG.md

@@ -6,6 +6,10 @@ All notable changes to the package will be documented here.
 
 ---
 
+## [4.28.1] - 2025-12-02
+
+- **Updated** *type* names `TokenHeader` to `SignetHeader` and `TokenPayload` to `SignetPayload` and both are available to import.
+
 ## [4.28.0] - 2025-12-01
 
 - **Added** *new* class `Cipher` to *encrypt/decrypt* string with *secret key*.

package/dist/dts/hash/Signet.d.ts

@@ -1,5 +1,5 @@
 import type { GenericObject } from '../object/types';
-import type { DecodedToken, SignOptions, TokenPayload, TokenString, VerifiedToken, VerifyOptions } from './types';
+import type { DecodedToken, SignetPayload, SignOptions, TokenString, VerifiedToken, VerifyOptions } from './types';
 /**
  * * A lightweight, secure implementation of JWT-like tokens using `HMAC-SHA256` signatures.
  *   - This class provides methods to create, verify, and decode tokens with a simple API similar to JSON Web Tokens (`JWT`) but with a smaller footprint and zero dependencies.
@@ -166,7 +166,7 @@ export declare class Signet {
      *
      * @remarks
      * - Tokens without `exp` claim are considered non-expiring (returns `false`)
-     * - Uses current system time for comparison
+     * - Uses current system time for comparison ({@link Date.now()})
      * - Does not verify the signature (use only with trusted tokens or after verification)
      *
      * @example
@@ -192,7 +192,10 @@ export declare class Signet {
      *
      * @throws If the token is malformed or cannot be decoded.
      *
-     * @remarks Useful for implementing time-based access control, like activation links that shouldn't be used until a certain time.
+     * @remarks
+     * - Useful for implementing time-based access control, like activation links that shouldn't be used until a certain time.
+     * - Uses current system time for comparison ({@link Date.now()})
+     * - Does not verify the signature (use only with trusted tokens or after verification)
      *
      * @example
      * ```typescript
@@ -310,7 +313,7 @@ export declare class Signet {
      * @param options - Optional validation criteria for token claims.
      *
      * @returns A {@link VerifiedToken} object indicating success or failure.
-     *          - If valid: `{ isValid: true, payload: TokenPayload<T> }`
+     *          - If valid: `{ isValid: true, payload: SignetPayload<T> }`
      *          - If invalid: `{ isValid: false, error: string }`
      *
      * @remarks
@@ -440,5 +443,5 @@ export declare class Signet {
      * const canDelete = payload.permissions.includes('delete');
      * ```
      */
-    decodePayload<T extends GenericObject = GenericObject>(token: string): TokenPayload<T>;
+    decodePayload<T extends GenericObject = GenericObject>(token: string): SignetPayload<T>;
 }

package/dist/dts/hash/types.d.ts

@@ -45,7 +45,7 @@ export interface DecodedUUID {
     node?: string;
 }
 /** Header for `Signet` */
-export type TokenHeader = {
+export type SignetHeader = {
     /** Algorithm used. Currently supports `'HS256'` only */
     alg: 'HS256';
     /** Type of token. Fixed `'SIGNET+JWT'` */
@@ -79,14 +79,14 @@ export interface SignOptions extends VerifyOptions {
      */
     notBefore?: TimeWithUnit | Numeric;
 }
-/** Pattern of a valid 3-parts token */
+/** 3-parts dot separated token string */
 export type TokenString = `${string}.${string}.${string}`;
 /** Interface of token verification result if token is valid */
 export type $ValidToken<T extends GenericObject = GenericObject> = {
     /** Whether the token is valid */
     isValid: true;
-    /** Decoded payload after successful verification with common {@link TokenPayload} properties */
-    payload: TokenPayload<T>;
+    /** Decoded payload after successful verification with common {@link SignetPayload} properties */
+    payload: SignetPayload<T>;
 };
 /** Interface of token verification result if token is invalid */
 export type $InvalidToken = {
@@ -97,7 +97,7 @@ export type $InvalidToken = {
 };
 /** Result of token verification */
 export type VerifiedToken<T extends GenericObject = GenericObject> = $ValidToken<T> | $InvalidToken;
-export type TokenPayload<T extends GenericObject = GenericObject> = {
+export type SignetPayload<T extends GenericObject = GenericObject> = {
     /** When the token was created (unix timestamp in seconds) */
     iat: number;
     /** When the token was created (as JavaScript {@link Date}) */
@@ -120,9 +120,9 @@ export type TokenPayload<T extends GenericObject = GenericObject> = {
 /** Interface of a decoded token */
 export type DecodedToken<T extends GenericObject = GenericObject> = {
     /** Token header info, algorithm, type etc. */
-    header: TokenHeader;
-    /** Decoded payload after with common {@link TokenPayload} properties */
-    payload: TokenPayload<T>;
+    header: SignetHeader;
+    /** Decoded payload after with common {@link SignetPayload} properties */
+    payload: SignetPayload<T>;
     /**
      * The `Base64`-encoded signature from the token.
      * This is the third part of the token string.
@@ -131,3 +131,4 @@ export type DecodedToken<T extends GenericObject = GenericObject> = {
     /** The header and payload in encrypted `Base64` format.*/
     signingInput: `${string}.${string}`;
 };
+export type { SignetPayload as TokenPayload, SignetHeader as TokenHeader };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "4.28.0",
+  "version": "4.28.1",
   "description": "A versatile collection of smart, efficient, and reusable utility functions, classes and types for everyday development needs.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -42,8 +42,8 @@
     "@eslint/js": "^9.39.1",
     "@types/jest": "^30.0.0",
     "@types/node": "^24.10.1",
-    "@typescript-eslint/eslint-plugin": "^8.47.0",
-    "@typescript-eslint/parser": "^8.47.0",
+    "@typescript-eslint/eslint-plugin": "^8.48.0",
+    "@typescript-eslint/parser": "^8.48.0",
     "eslint": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.4",
@@ -52,10 +52,10 @@
     "jest": "^30.2.0",
     "lint-staged": "^16.2.7",
     "nhb-scripts": "^1.8.88",
-    "prettier": "^3.6.2",
-    "ts-jest": "^29.4.5",
+    "prettier": "^3.7.3",
+    "ts-jest": "^29.4.6",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.47.0"
+    "typescript-eslint": "^8.48.0"
   },
   "keywords": [
     "toolbox",