ecwt 0.2.0-beta.5 → 0.2.1-beta.2

package/dist/{ecwt.cjs → main.cjs}

@@ -1,3 +1,4 @@
+"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -51,21 +52,7 @@ function toSeconds(value) {
 }
 
 // src/token.js
-function assign(target, key, value) {
-  Object.defineProperty(
-    target,
-    key,
-    {
-      value,
-      enumerable: true,
-      writable: false,
-      configurable: false
-    }
-  );
-}
 var Ecwt = class {
-  #ecwtFactory;
-  #ttl_initial;
   /**
    * Token string representation.
    * @type {string}
@@ -92,17 +79,21 @@ var Ecwt = class {
   ts_expired;
   /**
    * Data stored in token.
-   * @type {{ [key: string]: any }}
+   * @type {D}
    * @readonly
    */
   data;
+  /** @type {EcwtFactory} */
+  #ecwtFactory;
+  /** @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,
@@ -112,23 +103,11 @@ var Ecwt = class {
   }) {
     this.#ecwtFactory = ecwtFactory;
     this.#ttl_initial = ttl_initial;
-    assign(this, "token", token);
-    assign(
-      this,
-      "id",
-      snowflake.toBase62()
-    );
-    assign(this, "snowflake", snowflake);
-    assign(
-      this,
-      "ts_expired",
-      this.#getTimestampExpired()
-    );
-    assign(
-      this,
-      "data",
-      Object.freeze(data)
-    );
+    this.token = token;
+    this.id = snowflake.toBase62();
+    this.snowflake = snowflake;
+    this.ts_expired = this.#getTimestampExpired();
+    this.data = Object.freeze(data);
   }
   #getTimestampExpired() {
     if (this.#ttl_initial === null) {
@@ -166,6 +145,11 @@ var base62 = (0, import_base_x.default)("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabc
 
 // src/utils/errors.js
 var InvalidPackageInstanceError = class extends TypeError {
+  /**
+   * @param {string} property -
+   * @param {string} class_name -
+   * @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.`);
   }
@@ -176,24 +160,20 @@ var EcwtParseError = class extends Error {
   }
 };
 var EcwtInvalidError = class extends Error {
+  message = "Ecwt token is invalid.";
+  /**
+   * @param {Ecwt} ecwt -
+   */
   constructor(ecwt) {
-    super("Ecwt token is invalid.");
+    super();
     this.ecwt = ecwt;
   }
 };
 var EcwtExpiredError = class extends EcwtInvalidError {
-  constructor(ecwt) {
-    super();
-    this.ecwt = ecwt;
-    this.message = "Ecwt is expired.";
-  }
+  message = "Ecwt is expired.";
 };
 var EcwtRevokedError = class extends EcwtInvalidError {
-  constructor(ecwt) {
-    super();
-    this.ecwt = ecwt;
-    this.message = "Ecwt is revoked.";
-  }
+  message = "Ecwt is revoked.";
 };
 
 // src/factory.js
@@ -212,21 +192,21 @@ var EcwtFactory = class {
   #redisClient;
   #lruCache;
   #snowflakeFactory;
-  #redis_keys = {};
+  #redis_key_revoked;
   #encryption_key;
   #validator;
-  #cborEncoder;
+  /** @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 {LRUCache} [param0.lruCache] LRUCache instance. If not provided, tokens will be decrypted every time they are verified.
+   * @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 -
    * @param {string} [param0.options.namespace] Namespace for Redis keys.
    * @param {Buffer} param0.options.key Encryption key, 64 bytes
    * @param {(value: any) => any} [param0.options.validator] Validator for token data. Should return validated value or throw an error.
-   * @param {{ [key: string]: number }} [param0.options.senml_key_map] Payload object keys mapped for their SenML keys.
+   * @param {Record<string, number>} [param0.options.senml_key_map] Payload object keys mapped for their SenML keys.
    */
   constructor({
     redisClient: redisClient2,
@@ -263,7 +243,7 @@ var EcwtFactory = class {
       );
     }
     this.#snowflakeFactory = snowflakeFactory;
-    this.#redis_keys.revoked = `${REDIS_PREFIX}${namespace}:revoked`;
+    this.#redis_key_revoked = `${REDIS_PREFIX}${namespace}:revoked`;
     this.#encryption_key = key;
     this.#validator = validator;
     if (senml_key_map) {
@@ -275,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>} -
@@ -322,14 +302,14 @@ var EcwtFactory = class {
   /**
    * Sets data to cache.
    * @param {string} token String representation of token.
-   * @param {object} data Data to be stored in cache.
+   * @param {CacheValue} cache_value Data to be stored in cache.
    */
-  #setCache(token, data) {
+  #setCache(token, cache_value) {
     this.#lruCache?.set(
       token,
-      data,
-      {
-        ttl: data.ttl * 1e3
+      cache_value,
+      cache_value.ttl_initial === null ? void 0 : {
+        ttl: cache_value.ttl_initial * 1e3
       }
     );
   }
@@ -406,7 +386,7 @@ var EcwtFactory = class {
     }
     if (this.#redisClient) {
       const score = await this.#redisClient.ZSCORE(
-        this.#redis_keys.revoked,
+        this.#redis_key_revoked,
         ecwt.id
       );
       if (score !== null) {
@@ -465,12 +445,12 @@ var EcwtFactory = class {
       if (ts_ms_expired > Date.now()) {
         await this.#redisClient.MULTI().addCommand([
           "ZADD",
-          this.#redis_keys.revoked,
+          this.#redis_key_revoked,
           String(ts_ms_expired),
           token_id
         ]).addCommand([
           "ZREMRANGEBYSCORE",
-          this.#redis_keys.revoked,
+          this.#redis_key_revoked,
           "-inf",
           String(Date.now())
         ]).EXEC();

package/package.json

@@ -1,13 +1,14 @@
 {
 	"name": "ecwt",
-	"version": "0.2.0-beta.5",
+	"version": "0.2.1-beta.2",
 	"description": "Encrypted CBOR-encoded Web Token",
-	"main": "src/main.js",
 	"type": "module",
+	"main": "src/main.js",
+	"types": "types/main.d.ts",
 	"exports": {
 		".": {
 			"import": "./src/main.js",
-			"require": "./dist/ecwt.cjs"
+			"require": "./dist/main.cjs"
 		}
 	},
 	"engines": {
@@ -16,35 +17,36 @@
 	"dependencies": {
 		"base-x": "4.0.0",
 		"cbor-x": "1.5.6",
-		"evilcrypt": "0.2.0-beta.4"
+		"evilcrypt": "0.2.1-beta.1"
 	},
 	"peerDependencies": {
-		"@kirick/snowflake": "^0.2.1-beta.1",
+		"@kirick/snowflake": "^0.2.2-beta.2",
 		"lru-cache": "^9 || ^10",
 		"redis": "^4"
 	},
 	"devDependencies": {
 		"@babel/eslint-parser": "7.21.8",
+		"@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.9.1",
+		"eslint-plugin-jsdoc": "46.5.0",
 		"eslint-plugin-node": "11.1.0",
 		"eslint-plugin-promise": "6.1.1",
 		"eslint-plugin-unicorn": "47.0.0",
-		"valibot": "0.33",
-		"vitest": "1.6"
+		"valibot": "^0.33",
+		"vitest": "^1.6"
 	},
 	"scripts": {
-		"test": "bun run redis-up && bun test && npm run test-node",
-		"test-node": "vitest run --no-file-parallelism",
-		"coverage": "bun run redis-up && bun test --coverage",
-		"build": "bun run build-cjs",
-		"build-cjs": "bunx esbuild --bundle --platform=node --format=cjs --packages=external --outfile=dist/ecwt.cjs src/main.js",
-		"npm-publish": "bun run build && bun run eslint . && bun run test && npm publish; bun run redis-down",
-		"npm-publish-beta": "bun run build && bun run eslint . && bun run test && npm publish --tag beta; bun run redis-down",
-		"redis-up": "docker ps | grep test-redis-ecwt-test >/dev/null || docker run --rm -d -p 16274:6379 --name test-redis-ecwt-test redis:7-alpine",
-		"redis-down": "docker stop test-redis-ecwt-test"
+		"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",
+		"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"
 	},
 	"repository": {
 		"type": "git",

package/src/factory.js

@@ -1,5 +1,13 @@
 
-// @ts-check
+/**
+ * @typedef {import('@kirick/snowflake').Snowflake} Snowflake
+ */
+/**
+ * @typedef {object} CacheValue
+ * @property {Snowflake} snowflake -
+ * @property {number | null} ttl_initial -
+ * @property {Record<string, any>} data -
+ */
 
 import { SnowflakeFactory }       from '@kirick/snowflake';
 import {
@@ -22,7 +30,10 @@ import {
 
 const REDIS_PREFIX = '@ecwt:';
 
-// eslint-disable-next-line jsdoc/require-jsdoc
+/**
+ * @param {object} value -
+ * @returns {string} -
+ */
 function getAllKeysList(value) {
 	const keys = [];
 	// eslint-disable-next-line guard-for-in
@@ -36,28 +47,31 @@ 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;
 	#snowflakeFactory;
 
-	#redis_keys = {};
+	#redis_key_revoked;
 	#encryption_key;
 
 	#validator;
-	#cborEncoder;
+	/** @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 {LRUCache} [param0.lruCache] LRUCache instance. If not provided, tokens will be decrypted every time they are verified.
+	 * @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 -
 	 * @param {string} [param0.options.namespace] Namespace for Redis keys.
 	 * @param {Buffer} param0.options.key Encryption key, 64 bytes
 	 * @param {(value: any) => any} [param0.options.validator] Validator for token data. Should return validated value or throw an error.
-	 * @param {{ [key: string]: number }} [param0.options.senml_key_map] Payload object keys mapped for their SenML keys.
+	 * @param {Record<string, number>} [param0.options.senml_key_map] Payload object keys mapped for their SenML keys.
 	 */
 	constructor({
 		redisClient,
@@ -106,7 +120,7 @@ export class EcwtFactory {
 		}
 		this.#snowflakeFactory = snowflakeFactory;
 
-		this.#redis_keys.revoked = `${REDIS_PREFIX}${namespace}:revoked`;
+		this.#redis_key_revoked = `${REDIS_PREFIX}${namespace}:revoked`;
 
 		this.#encryption_key = key;
 
@@ -122,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>} -
@@ -186,15 +200,17 @@ export class EcwtFactory {
 	/**
 	 * Sets data to cache.
 	 * @param {string} token String representation of token.
-	 * @param {object} data Data to be stored in cache.
+	 * @param {CacheValue} cache_value Data to be stored in cache.
 	 */
-	#setCache(token, data) {
+	#setCache(token, cache_value) {
 		this.#lruCache?.set(
 			token,
-			data,
-			{
-				ttl: data.ttl * 1000,
-			},
+			cache_value,
+			cache_value.ttl_initial === null
+				? undefined
+				: {
+					ttl: cache_value.ttl_initial * 1000,
+				},
 		);
 	}
 
@@ -296,7 +312,7 @@ export class EcwtFactory {
 
 		if (this.#redisClient) {
 			const score = await this.#redisClient.ZSCORE(
-				this.#redis_keys.revoked,
+				this.#redis_key_revoked,
 				ecwt.id,
 			);
 			if (score !== null) {
@@ -370,13 +386,13 @@ export class EcwtFactory {
 				await this.#redisClient.MULTI()
 					.addCommand([
 						'ZADD',
-						this.#redis_keys.revoked,
+						this.#redis_key_revoked,
 						String(ts_ms_expired),
 						token_id,
 					])
 					.addCommand([
 						'ZREMRANGEBYSCORE',
-						this.#redis_keys.revoked,
+						this.#redis_key_revoked,
 						'-inf',
 						String(Date.now()),
 					])

package/src/main.js

@@ -1,6 +1,4 @@
 
-// @ts-check
-
 export { EcwtFactory } from './factory.js';
 export { Ecwt } from './token.js';
 export {

package/src/token.js

@@ -1,6 +1,4 @@
 
-// @ts-check
-
 import { toSeconds } from './utils/time.js';
 
 /**
@@ -9,28 +7,9 @@ import { toSeconds } from './utils/time.js';
  */
 
 /**
- * Assigns property to object.
- * @param {object} target -
- * @param {string} key -
- * @param {any} value -
+ * @template {Record<string, any>} [D=Record<string, any>]
  */
-function assign(target, key, value) {
-	Object.defineProperty(
-		target,
-		key,
-		{
-			value,
-			enumerable: true,
-			writable: false,
-			configurable: false,
-		},
-	);
-}
-
 export class Ecwt {
-	#ecwtFactory;
-	#ttl_initial;
-
 	/**
 	 * Token string representation.
 	 * @type {string}
@@ -57,18 +36,23 @@ export class Ecwt {
 	ts_expired;
 	/**
 	 * Data stored in token.
-	 * @type {{ [key: string]: any }}
+	 * @type {D}
 	 * @readonly
 	 */
 	data;
 
+	/** @type {EcwtFactory} */
+	#ecwtFactory;
+	/** @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,
@@ -80,26 +64,13 @@ export class Ecwt {
 		},
 	) {
 		this.#ecwtFactory = ecwtFactory;
-
 		this.#ttl_initial = ttl_initial;
 
-		assign(this, 'token', token);
-		assign(
-			this,
-			'id',
-			snowflake.toBase62(),
-		);
-		assign(this, 'snowflake', snowflake);
-		assign(
-			this,
-			'ts_expired',
-			this.#getTimestampExpired(),
-		);
-		assign(
-			this,
-			'data',
-			Object.freeze(data),
-		);
+		this.token = token;
+		this.id = snowflake.toBase62();
+		this.snowflake = snowflake;
+		this.ts_expired = this.#getTimestampExpired();
+		this.data = Object.freeze(data);
 	}
 
 	#getTimestampExpired() {

package/src/utils/base62.js

@@ -1,6 +1,4 @@
 
-// @ts-check
-
 import basex from 'base-x';
 
 export const base62 = basex('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');

package/src/utils/errors.js

@@ -1,7 +1,14 @@
 
-// @ts-check
+/**
+ * @typedef {import('../token.js').Ecwt} Ecwt
+ */
 
 export class InvalidPackageInstanceError extends TypeError {
+	/**
+	 * @param {string} property -
+	 * @param {string} class_name -
+	 * @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.`);
 	}
@@ -20,8 +27,13 @@ export class EcwtParseError extends Error {
  * Error thrown when parsed Ecwt is invalid.
  */
 export class EcwtInvalidError extends Error {
+	message = 'Ecwt token is invalid.';
+
+	/**
+	 * @param {Ecwt} ecwt -
+	 */
 	constructor(ecwt) {
-		super('Ecwt token is invalid.');
+		super();
 
 		this.ecwt = ecwt;
 	}
@@ -31,22 +43,12 @@ export class EcwtInvalidError extends Error {
  * Error thrown when parsed Ecwt is expired.
  */
 export class EcwtExpiredError extends EcwtInvalidError {
-	constructor(ecwt) {
-		super();
-
-		this.ecwt = ecwt;
-		this.message = 'Ecwt is expired.';
-	}
+	message = 'Ecwt is expired.';
 }
 
 /**
  * Error thrown when parsed Ecwt is revoked.
  */
 export class EcwtRevokedError extends EcwtInvalidError {
-	constructor(ecwt) {
-		super();
-
-		this.ecwt = ecwt;
-		this.message = 'Ecwt is revoked.';
-	}
+	message = 'Ecwt is revoked.';
 }

package/src/utils/time.js

@@ -1,6 +1,4 @@
 
-// @ts-check
-
 /**
  * Convert timestamp in seconds to milliseconds.
  * @param {*} value Timestamp in milliseconds.

package/tsconfig.json

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

package/types/factory.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @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<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 -
+     * @param {string} [param0.options.namespace] Namespace for Redis keys.
+     * @param {Buffer} param0.options.key Encryption key, 64 bytes
+     * @param {(value: any) => any} [param0.options.validator] Validator for token data. Should return validated value or throw an error.
+     * @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<import("redis").RedisModules, import("redis").RedisFunctions, import("redis").RedisScripts> | undefined;
+        lruCache?: LRUCache<string, CacheValue, any> | undefined;
+        snowflakeFactory: SnowflakeFactory;
+        options: {
+            namespace?: string | undefined;
+            key: Buffer;
+            validator?: ((value: any) => any) | undefined;
+            senml_key_map?: Record<string, number> | undefined;
+        };
+    });
+    /**
+     * Creates new token.
+     * @async
+     * @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: D, { ttl, }?: {
+        ttl?: number | null | undefined;
+    } | undefined): Promise<Ecwt>;
+    /**
+     * Parses token.
+     * @async
+     * @param {string} token String representation of token.
+     * @returns {Promise<Ecwt>} -
+     */
+    verify(token: string): Promise<Ecwt>;
+    /**
+     * Parses token without throwing errors.
+     * @async
+     * @param {string} token String representation of token.
+     * @returns {Promise<{ success: true, ecwt: Ecwt } | { success: false, ecwt: Ecwt | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
+     */
+    safeVerify(token: string): Promise<{
+        success: true;
+        ecwt: Ecwt;
+    } | {
+        success: false;
+        ecwt: Ecwt | null;
+    }>;
+    /**
+     * Revokes token.
+     * @async
+     * @param {object} options -
+     * @param {string} options.token_id -
+     * @param {number} options.ts_ms_created -
+     * @param {number | null} options.ttl_initial -
+     * @returns {Promise<void>} -
+     */
+    _revoke({ token_id, ts_ms_created, ttl_initial, }: {
+        token_id: string;
+        ts_ms_created: number;
+        ttl_initial: number | null;
+    }): Promise<void>;
+    /**
+     * Purges cache.
+     * @private
+     * @returns {void} -
+     */
+    private _purgeCache;
+    #private;
+}
+export type Snowflake = import("@kirick/snowflake").Snowflake;
+export type CacheValue = {
+    /**
+     * -
+     */
+    snowflake: Snowflake;
+    /**
+     * -
+     */
+    ttl_initial: number | null;
+    /**
+     * -
+     */
+    data: Record<string, any>;
+};
+import { Ecwt } from './token.js';
+import { LRUCache } from 'lru-cache';
+import { SnowflakeFactory } from '@kirick/snowflake';

package/types/factory.test.d.ts

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

package/types/main.d.ts

@@ -0,0 +1,3 @@
+export { EcwtFactory } from "./factory.js";
+export { Ecwt } from "./token.js";
+export { EcwtParseError, EcwtInvalidError, EcwtExpiredError, EcwtRevokedError } from "./utils/errors.js";

package/types/token.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @typedef {import('@kirick/snowflake').Snowflake} Snowflake
+ * @typedef {import('./factory.js').EcwtFactory} EcwtFactory
+ */
+/**
+ * @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 | 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: D;
+    });
+    /**
+     * Token string representation.
+     * @type {string}
+     * @readonly
+     */
+    readonly token: string;
+    /**
+     * Token ID.
+     * @type {string}
+     * @readonly
+     */
+    readonly id: string;
+    /**
+     * Snowflake associated with token.
+     * @type {Snowflake}
+     * @readonly
+     */
+    readonly snowflake: Snowflake;
+    /**
+     * Timestamp when token expires in seconds.
+     * @type {number?}
+     * @readonly
+     */
+    readonly ts_expired: number | null;
+    /**
+     * Data stored in token.
+     * @type {D}
+     * @readonly
+     */
+    readonly data: D;
+    /**
+     * Actual time to live in seconds.
+     * @returns {number | null} -
+     */
+    getTTL(): number | null;
+    /**
+     * Revokes token.
+     * @returns {Promise<void>} -
+     */
+    revoke(): Promise<void>;
+    #private;
+}
+export type Snowflake = import("@kirick/snowflake").Snowflake;
+export type EcwtFactory = import("./factory.js").EcwtFactory;

package/types/utils/base62.d.ts

@@ -0,0 +1,2 @@
+export const base62: basex.BaseConverter;
+import basex from 'base-x';

package/types/utils/errors.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @typedef {import('../token.js').Ecwt} Ecwt
+ */
+export class InvalidPackageInstanceError extends TypeError {
+    /**
+     * @param {string} property -
+     * @param {string} class_name -
+     * @param {string} package_name -
+     */
+    constructor(property: string, class_name: string, package_name: string);
+}
+/**
+ * Error thrown when string token cannot be parsed to Ecwt.
+ */
+export class EcwtParseError extends Error {
+    constructor();
+}
+/**
+ * Error thrown when parsed Ecwt is invalid.
+ */
+export class EcwtInvalidError extends Error {
+    /**
+     * @param {Ecwt} ecwt -
+     */
+    constructor(ecwt: Ecwt);
+    ecwt: import("../token.js").Ecwt<Record<string, any>>;
+}
+/**
+ * Error thrown when parsed Ecwt is expired.
+ */
+export class EcwtExpiredError extends EcwtInvalidError {
+}
+/**
+ * Error thrown when parsed Ecwt is revoked.
+ */
+export class EcwtRevokedError extends EcwtInvalidError {
+}
+export type Ecwt = import("../token.js").Ecwt;

package/types/utils/time.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Convert timestamp in seconds to milliseconds.
+ * @param {*} value Timestamp in milliseconds.
+ * @returns {number} Timestamp in seconds.
+ */
+export function toSeconds(value: any): number;