ecwt 0.2.1-beta.1 → 0.2.1-beta.3

package/dist/main.cjs

@@ -1,3 +1,4 @@
+"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -43,7 +44,6 @@ var import_snowflake = require("@kirick/snowflake");
 var import_cbor_x = require("cbor-x");
 var import_evilcrypt = require("evilcrypt");
 var import_lru_cache = require("lru-cache");
-var import_redis = require("redis");
 
 // src/utils/time.js
 function toSeconds(value) {
@@ -78,21 +78,21 @@ var Ecwt = class {
   ts_expired;
   /**
    * Data stored in token.
-   * @type {{ [key: string]: any }}
+   * @type {D}
    * @readonly
    */
   data;
   /** @type {EcwtFactory} */
   #ecwtFactory;
-  /** @type {number} */
+  /** @type {number | null} */
   #ttl_initial;
   /**
    * @param {EcwtFactory} ecwtFactory -
    * @param {object} options -
    * @param {string} options.token String representation of token.
    * @param {Snowflake} options.snowflake -
-   * @param {number?} options.ttl_initial Time to live in seconds at the moment of token creation.
-   * @param {object} options.data Data stored in token.
+   * @param {number | null} options.ttl_initial Time to live in seconds at the moment of token creation.
+   * @param {D} options.data Data stored in token.
    */
   constructor(ecwtFactory, {
     token,
@@ -150,7 +150,9 @@ var InvalidPackageInstanceError = class extends TypeError {
    * @param {string} package_name -
    */
   constructor(property, class_name, package_name) {
-    super(`Value ${property} must be an instance of ${class_name} from package "${package_name}". That error is probably caused by two separate installations of "${package_name}". Please, make sure that "${package_name}" in your project is matches "peerDependencies" of "ecwt" package.`);
+    super(
+      `Value ${property} must be an instance of ${class_name} from package "${package_name}". That error is probably caused by two separate installations of "${package_name}". Please, make sure that "${package_name}" in your project is matches "peerDependencies" of "ecwt" package.`
+    );
   }
 };
 var EcwtParseError = class extends Error {
@@ -177,16 +179,6 @@ var EcwtRevokedError = class extends EcwtInvalidError {
 
 // src/factory.js
 var REDIS_PREFIX = "@ecwt:";
-function getAllKeysList(value) {
-  const keys = [];
-  for (const key in value) {
-    keys.push(key);
-  }
-  return keys.sort().join(",");
-}
-var redisClient = (0, import_redis.createClient)();
-var redis_client_constructor_name = redisClient.constructor.name;
-var redis_client_keys = getAllKeysList(redisClient);
 var EcwtFactory = class {
   #redisClient;
   #lruCache;
@@ -197,9 +189,8 @@ var EcwtFactory = class {
   /** @type {CborEncoder | null} */
   #cborEncoder = null;
   /**
-   *
    * @param {object} param0 -
-   * @param {import('redis').RedisClientType} [param0.redisClient] RedisClient instance. If not provided, tokens will not be revoked and cannot be checked for revocation.
+   * @param {import('redis').RedisClientType<import('redis').RedisModules, import('redis').RedisFunctions, import('redis').RedisScripts>} [param0.redisClient] RedisClient instance. If not provided, tokens will not be revoked and cannot be checked for revocation.
    * @param {LRUCache<string, CacheValue>} [param0.lruCache] LRUCache instance. If not provided, tokens will be decrypted every time they are verified.
    * @param {SnowflakeFactory} param0.snowflakeFactory SnowflakeFactory instance.
    * @param {object} param0.options -
@@ -209,7 +200,7 @@ var EcwtFactory = class {
    * @param {Record<string, number>} [param0.options.senml_key_map] Payload object keys mapped for their SenML keys.
    */
   constructor({
-    redisClient: redisClient2,
+    redisClient,
     lruCache,
     snowflakeFactory,
     options: {
@@ -219,14 +210,7 @@ var EcwtFactory = class {
       senml_key_map
     }
   }) {
-    if (redisClient2 !== void 0 && (redisClient2.constructor.name !== redis_client_constructor_name || getAllKeysList(redisClient2) !== redis_client_keys)) {
-      throw new InvalidPackageInstanceError(
-        "redisClient",
-        "Commander extends RedisClient",
-        "redis"
-      );
-    }
-    this.#redisClient = redisClient2;
+    this.#redisClient = redisClient;
     if (lruCache !== void 0 && lruCache instanceof import_lru_cache.LRUCache !== true) {
       throw new InvalidPackageInstanceError(
         "lruCache",
@@ -255,7 +239,7 @@ var EcwtFactory = class {
   /**
    * Creates new token.
    * @async
-   * @param {object} data Data to be stored in token.
+   * @param {D} data Data to be stored in token.
    * @param {object} [options] -
    * @param {number | null} [options.ttl] Time to live in seconds. By default, token will never expire.
    * @returns {Promise<Ecwt>} -
@@ -308,7 +292,7 @@ var EcwtFactory = class {
     this.#lruCache?.set(
       token,
       cache_value,
-      {
+      cache_value.ttl_initial === null ? void 0 : {
         ttl: cache_value.ttl_initial * 1e3
       }
     );
@@ -341,9 +325,7 @@ var EcwtFactory = class {
         throw new EcwtParseError();
       }
       const payload = this.#cborEncoder ? this.#cborEncoder.decode(token_raw) : (0, import_cbor_x.decode)(token_raw);
-      const [
-        snowflake_buffer
-      ] = payload;
+      const [snowflake_buffer] = payload;
       [
         ,
         ttl_initial,
@@ -440,7 +422,7 @@ var EcwtFactory = class {
     ttl_initial
   }) {
     if (this.#redisClient) {
-      ttl_initial = ttl_initial ?? Number.MAX_SAFE_INTEGER;
+      ttl_initial ??= Number.MAX_SAFE_INTEGER;
       const ts_ms_expired = ts_ms_created + ttl_initial * 1e3;
       if (ts_ms_expired > Date.now()) {
         await this.#redisClient.MULTI().addCommand([

package/{types → dist/types}/factory.d.ts

@@ -1,8 +1,10 @@
-export class EcwtFactory {
+/**
+ * @template {Record<string, any>} [D=Record<string, any>]
+ */
+export class EcwtFactory<D extends Record<string, any> = Record<string, any>> {
     /**
-     *
      * @param {object} param0 -
-     * @param {import('redis').RedisClientType} [param0.redisClient] RedisClient instance. If not provided, tokens will not be revoked and cannot be checked for revocation.
+     * @param {import('redis').RedisClientType<import('redis').RedisModules, import('redis').RedisFunctions, import('redis').RedisScripts>} [param0.redisClient] RedisClient instance. If not provided, tokens will not be revoked and cannot be checked for revocation.
      * @param {LRUCache<string, CacheValue>} [param0.lruCache] LRUCache instance. If not provided, tokens will be decrypted every time they are verified.
      * @param {SnowflakeFactory} param0.snowflakeFactory SnowflakeFactory instance.
      * @param {object} param0.options -
@@ -12,27 +14,27 @@ export class EcwtFactory {
      * @param {Record<string, number>} [param0.options.senml_key_map] Payload object keys mapped for their SenML keys.
      */
     constructor({ redisClient, lruCache, snowflakeFactory, options: { namespace, key, validator, senml_key_map, }, }: {
-        redisClient?: import("redis").RedisClientType;
-        lruCache?: LRUCache<string, CacheValue>;
+        redisClient?: import("redis").RedisClientType<import("redis").RedisModules, import("redis").RedisFunctions, import("redis").RedisScripts> | undefined;
+        lruCache?: LRUCache<string, CacheValue, any> | undefined;
         snowflakeFactory: SnowflakeFactory;
         options: {
-            namespace?: string;
+            namespace?: string | undefined;
             key: Buffer;
-            validator?: (value: any) => any;
-            senml_key_map?: Record<string, number>;
+            validator?: ((value: any) => any) | undefined;
+            senml_key_map?: Record<string, number> | undefined;
         };
     });
     /**
      * Creates new token.
      * @async
-     * @param {object} data Data to be stored in token.
+     * @param {D} data Data to be stored in token.
      * @param {object} [options] -
      * @param {number | null} [options.ttl] Time to live in seconds. By default, token will never expire.
      * @returns {Promise<Ecwt>} -
      */
-    create(data: object, { ttl, }?: {
-        ttl?: number | null;
-    }): Promise<Ecwt>;
+    create(data: D, { ttl, }?: {
+        ttl?: number | null | undefined;
+    } | undefined): Promise<Ecwt>;
     /**
      * Parses token.
      * @async
@@ -84,7 +86,7 @@ export type CacheValue = {
     /**
      * -
      */
-    ttl_initial: number;
+    ttl_initial: number | null;
     /**
      * -
      */

package/{types → dist/types}/token.d.ts

@@ -2,20 +2,23 @@
  * @typedef {import('@kirick/snowflake').Snowflake} Snowflake
  * @typedef {import('./factory.js').EcwtFactory} EcwtFactory
  */
-export class Ecwt {
+/**
+ * @template {Record<string, any>} [D=Record<string, any>]
+ */
+export class Ecwt<D extends Record<string, any> = Record<string, any>> {
     /**
      * @param {EcwtFactory} ecwtFactory -
      * @param {object} options -
      * @param {string} options.token String representation of token.
      * @param {Snowflake} options.snowflake -
-     * @param {number?} options.ttl_initial Time to live in seconds at the moment of token creation.
-     * @param {object} options.data Data stored in token.
+     * @param {number | null} options.ttl_initial Time to live in seconds at the moment of token creation.
+     * @param {D} options.data Data stored in token.
      */
     constructor(ecwtFactory: EcwtFactory, { token, snowflake, ttl_initial, data, }: {
         token: string;
         snowflake: Snowflake;
         ttl_initial: number | null;
-        data: object;
+        data: D;
     });
     /**
      * Token string representation.
@@ -43,12 +46,10 @@ export class Ecwt {
     readonly ts_expired: number | null;
     /**
      * Data stored in token.
-     * @type {{ [key: string]: any }}
+     * @type {D}
      * @readonly
      */
-    readonly data: {
-        [key: string]: any;
-    };
+    readonly data: D;
     /**
      * Actual time to live in seconds.
      * @returns {number | null} -

package/{types → dist/types}/utils/errors.d.ts

@@ -23,7 +23,7 @@ export class EcwtInvalidError extends Error {
      * @param {Ecwt} ecwt -
      */
     constructor(ecwt: Ecwt);
-    ecwt: import("../token.js").Ecwt;
+    ecwt: import("../token.js").Ecwt<Record<string, any>>;
 }
 /**
  * Error thrown when parsed Ecwt is expired.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "ecwt",
-	"version": "0.2.1-beta.1",
+	"version": "0.2.1-beta.3",
 	"description": "Encrypted CBOR-encoded Web Token",
 	"type": "module",
 	"main": "src/main.js",
-	"types": "types/main.d.ts",
+	"types": "dist/types/main.d.ts",
 	"exports": {
 		".": {
 			"import": "./src/main.js",
@@ -25,28 +25,21 @@
 		"redis": "^4"
 	},
 	"devDependencies": {
-		"@babel/eslint-parser": "7.21.8",
+		"@kirick/eslint-config": "^0.1.11",
 		"@types/node": "^20.14.9",
-		"eslint": "8.41.0",
-		"eslint-config-xo": "0.43.1",
-		"eslint-plugin-import": "2.27.5",
-		"eslint-plugin-jsdoc": "46.5.0",
-		"eslint-plugin-node": "11.1.0",
-		"eslint-plugin-promise": "6.1.1",
-		"eslint-plugin-unicorn": "47.0.0",
+		"eslint": "9.8.0",
 		"valibot": "^0.33",
 		"vitest": "^1.6"
 	},
 	"scripts": {
-		"test": "export REDIS_PORT=16274 ; bun run redis:up && npm run test:vitest && bun test --coverage ; bun run redis:down",
-		"test:vitest": "vitest run --no-file-parallelism",
 		"build": "bun run build:types && bun run build:cjs",
 		"build:cjs": "bunx esbuild --bundle --platform=node --format=cjs --packages=external --outfile=dist/main.cjs src/main.js",
-		"build:types": "bunx tsc --skipLibCheck --declaration --emitDeclarationOnly --outDir types",
+		"build:types": "bunx tsc --skipLibCheck --declaration --emitDeclarationOnly --outDir dist/types",
 		"lint": "eslint . && bunx tsc --skipLibCheck --noemit",
 		"publish:npm": "bun run build && bun run lint && bun run test && npm publish",
-		"redis:up": "docker ps | grep test-ecwt >/dev/null || docker run --rm -d -p $REDIS_PORT:6379 --name test-ecwt redis:7-alpine",
-		"redis:down": "docker stop test-ecwt || true"
+		"redis:up": "docker ps | grep test-redis >/dev/null || docker run --rm -d -p $REDIS_PORT:6379 --name test-redis redis:7-alpine",
+		"test": "export REDIS_PORT=16379 ; bun run redis:up && npm run test:vitest && bun test --coverage",
+		"test:vitest": "vitest run --no-file-parallelism"
 	},
 	"repository": {
 		"type": "git",

package/src/factory.js

@@ -5,7 +5,7 @@
 /**
  * @typedef {object} CacheValue
  * @property {Snowflake} snowflake -
- * @property {number} ttl_initial -
+ * @property {number | null} ttl_initial -
  * @property {Record<string, any>} data -
  */
 
@@ -13,12 +13,13 @@ import { SnowflakeFactory }       from '@kirick/snowflake';
 import {
 	Encoder as CborEncoder,
 	encode as cborEncode,
-	decode as cborDecode }        from 'cbor-x';
+	decode as cborDecode,
+}                                 from 'cbor-x';
 import {
 	decrypt as evilcryptDecrypt,
-	v2 as evilcryptV2          }  from 'evilcrypt';
+	v2 as evilcryptV2,
+}                                 from 'evilcrypt';
 import { LRUCache }               from 'lru-cache';
-import { createClient }           from 'redis';
 import { Ecwt }                   from './token.js';
 import { base62 }                 from './utils/base62.js';
 import {
@@ -26,43 +27,27 @@ import {
 	EcwtInvalidError,
 	EcwtExpiredError,
 	EcwtRevokedError,
-    EcwtParseError }              from './utils/errors.js';
+    EcwtParseError,
+}                                 from './utils/errors.js';
 
 const REDIS_PREFIX = '@ecwt:';
 
 /**
- * @param {object} value -
- * @returns {string} -
+ * @template {Record<string, any>} [D=Record<string, any>]
  */
-function getAllKeysList(value) {
-	const keys = [];
-	// eslint-disable-next-line guard-for-in
-	for (const key in value) {
-		keys.push(key);
-	}
-	return keys.sort().join(',');
-}
-
-const redisClient = createClient();
-const redis_client_constructor_name = redisClient.constructor.name;
-const redis_client_keys = getAllKeysList(redisClient);
-
 export class EcwtFactory {
 	#redisClient;
 	#lruCache;
 	#snowflakeFactory;
-
 	#redis_key_revoked;
 	#encryption_key;
-
 	#validator;
 	/** @type {CborEncoder | null} */
 	#cborEncoder = null;
 
 	/**
-	 *
 	 * @param {object} param0 -
-	 * @param {import('redis').RedisClientType} [param0.redisClient] RedisClient instance. If not provided, tokens will not be revoked and cannot be checked for revocation.
+	 * @param {import('redis').RedisClientType<import('redis').RedisModules, import('redis').RedisFunctions, import('redis').RedisScripts>} [param0.redisClient] RedisClient instance. If not provided, tokens will not be revoked and cannot be checked for revocation.
 	 * @param {LRUCache<string, CacheValue>} [param0.lruCache] LRUCache instance. If not provided, tokens will be decrypted every time they are verified.
 	 * @param {SnowflakeFactory} param0.snowflakeFactory SnowflakeFactory instance.
 	 * @param {object} param0.options -
@@ -82,19 +67,6 @@ export class EcwtFactory {
 			senml_key_map,
 		},
 	}) {
-		if (
-			redisClient !== undefined
-			&& (
-				redisClient.constructor.name !== redis_client_constructor_name
-				|| getAllKeysList(redisClient) !== redis_client_keys
-			)
-		) {
-			throw new InvalidPackageInstanceError(
-				'redisClient',
-				'Commander extends RedisClient',
-				'redis',
-			);
-		}
 		this.#redisClient = redisClient;
 
 		if (
@@ -107,6 +79,7 @@ export class EcwtFactory {
 				'lru-cache',
 			);
 		}
+
 		this.#lruCache = lruCache;
 
 		if (snowflakeFactory instanceof SnowflakeFactory !== true) {
@@ -116,6 +89,7 @@ export class EcwtFactory {
 				'@kirick/snowflake',
 			);
 		}
+
 		this.#snowflakeFactory = snowflakeFactory;
 
 		this.#redis_key_revoked = `${REDIS_PREFIX}${namespace}:revoked`;
@@ -134,7 +108,7 @@ export class EcwtFactory {
 	/**
 	 * Creates new token.
 	 * @async
-	 * @param {object} data Data to be stored in token.
+	 * @param {D} data Data to be stored in token.
 	 * @param {object} [options] -
 	 * @param {number | null} [options.ttl] Time to live in seconds. By default, token will never expire.
 	 * @returns {Promise<Ecwt>} -
@@ -204,9 +178,11 @@ export class EcwtFactory {
 		this.#lruCache?.set(
 			token,
 			cache_value,
-			{
-				ttl: cache_value.ttl_initial * 1000,
-			},
+			cache_value.ttl_initial === null
+				? undefined
+				: {
+					ttl: cache_value.ttl_initial * 1000,
+				},
 		);
 	}
 
@@ -247,9 +223,7 @@ export class EcwtFactory {
 				? this.#cborEncoder.decode(token_raw)
 				: cborDecode(token_raw);
 
-			const [
-				snowflake_buffer,
-			] = payload;
+			const [ snowflake_buffer ] = payload;
 			[
 				,
 				ttl_initial,
@@ -369,7 +343,7 @@ export class EcwtFactory {
 		ttl_initial,
 	}) {
 		if (this.#redisClient) {
-			ttl_initial = ttl_initial ?? Number.MAX_SAFE_INTEGER;
+			ttl_initial ??= Number.MAX_SAFE_INTEGER;
 
 			const ts_ms_expired = ts_ms_created + (ttl_initial * 1000);
 			if (ts_ms_expired > Date.now()) {

package/src/token.js

@@ -6,6 +6,9 @@ import { toSeconds } from './utils/time.js';
  * @typedef {import('./factory.js').EcwtFactory} EcwtFactory
  */
 
+/**
+ * @template {Record<string, any>} [D=Record<string, any>]
+ */
 export class Ecwt {
 	/**
 	 * Token string representation.
@@ -33,14 +36,13 @@ export class Ecwt {
 	ts_expired;
 	/**
 	 * Data stored in token.
-	 * @type {{ [key: string]: any }}
+	 * @type {D}
 	 * @readonly
 	 */
 	data;
-
 	/** @type {EcwtFactory} */
 	#ecwtFactory;
-	/** @type {number} */
+	/** @type {number | null} */
 	#ttl_initial;
 
 	/**
@@ -48,8 +50,8 @@ export class Ecwt {
 	 * @param {object} options -
 	 * @param {string} options.token String representation of token.
 	 * @param {Snowflake} options.snowflake -
-	 * @param {number?} options.ttl_initial Time to live in seconds at the moment of token creation.
-	 * @param {object} options.data Data stored in token.
+	 * @param {number | null} options.ttl_initial Time to live in seconds at the moment of token creation.
+	 * @param {D} options.data Data stored in token.
 	 */
 	constructor(
 		ecwtFactory,

package/src/utils/errors.js

@@ -10,7 +10,11 @@ export class InvalidPackageInstanceError extends TypeError {
 	 * @param {string} package_name -
 	 */
 	constructor(property, class_name, package_name) {
-		super(`Value ${property} must be an instance of ${class_name} from package "${package_name}". That error is probably caused by two separate installations of "${package_name}". Please, make sure that "${package_name}" in your project is matches "peerDependencies" of "ecwt" package.`);
+		super(
+			`Value ${property} must be an instance of ${class_name} from package "${package_name}".`
+			+ ` That error is probably caused by two separate installations of "${package_name}".`
+			+ ` Please, make sure that "${package_name}" in your project is matches "peerDependencies" of "ecwt" package.`,
+		);
 	}
 }
 

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "esnext",
-		"module": "esnext",
-		"noImplicitAny": true,
-		"checkJs": true,
-		"allowJs": true,
-		"moduleResolution": "node",
-		"allowSyntheticDefaultImports": true
-	},
-	"include": [
-		"src/**/*"
-	],
-	"exclude": [
-		"node_modules/",
-		"dist/",
-		"**/*.test.js"
-	]
-}