ecwt 0.2.1-beta.1 → 0.2.1-beta.2

package/dist/main.cjs

@@ -1,3 +1,4 @@
+"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -78,21 +79,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,
@@ -197,9 +198,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 -
@@ -255,7 +255,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 +308,7 @@ var EcwtFactory = class {
     this.#lruCache?.set(
       token,
       cache_value,
-      {
+      cache_value.ttl_initial === null ? void 0 : {
         ttl: cache_value.ttl_initial * 1e3
       }
     );

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ecwt",
-	"version": "0.2.1-beta.1",
+	"version": "0.2.1-beta.2",
 	"description": "Encrypted CBOR-encoded Web Token",
 	"type": "module",
 	"main": "src/main.js",

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 -
  */
 
@@ -47,6 +47,9 @@ const redisClient = createClient();
 const redis_client_constructor_name = redisClient.constructor.name;
 const redis_client_keys = getAllKeysList(redisClient);
 
+/**
+ * @template {Record<string, any>} [D=Record<string, any>]
+ */
 export class EcwtFactory {
 	#redisClient;
 	#lruCache;
@@ -60,9 +63,8 @@ export class EcwtFactory {
 	#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 -
@@ -134,7 +136,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 +206,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,
+				},
 		);
 	}
 

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,14 @@ 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 +51,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/tsconfig.json

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

package/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/factory.test.d.ts

@@ -0,0 +1 @@
+export {};

package/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/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.