ecwt 0.2.1-beta.3 → 0.2.1-beta.5

package/dist/main.cjs

@@ -196,7 +196,7 @@ var EcwtFactory = class {
    * @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 {(value: unknown) => D} [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({
@@ -242,7 +242,7 @@ var EcwtFactory = class {
    * @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>} -
+   * @returns {Promise<Ecwt<D>>} -
    */
   async create(data, {
     ttl = null
@@ -301,7 +301,7 @@ var EcwtFactory = class {
    * Parses token.
    * @async
    * @param {string} token String representation of token.
-   * @returns {Promise<Ecwt>} -
+   * @returns {Promise<Ecwt<D>>} -
    */
   async verify(token) {
     if (typeof token !== "string") {
@@ -381,7 +381,7 @@ var EcwtFactory = class {
    * 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.
+   * @returns {Promise<{ success: true, ecwt: Ecwt<D> } | { success: false, ecwt: Ecwt<D> | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
    */
   async safeVerify(token) {
     let ecwt = null;

package/dist/types/factory.d.ts

@@ -10,7 +10,7 @@ export class EcwtFactory<D extends Record<string, any> = Record<string, any>> {
      * @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 {(value: unknown) => D} [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, }, }: {
@@ -20,7 +20,7 @@ export class EcwtFactory<D extends Record<string, any> = Record<string, any>> {
         options: {
             namespace?: string | undefined;
             key: Buffer;
-            validator?: ((value: any) => any) | undefined;
+            validator?: ((value: unknown) => D) | undefined;
             senml_key_map?: Record<string, number> | undefined;
         };
     });
@@ -30,30 +30,30 @@ export class EcwtFactory<D extends Record<string, any> = Record<string, any>> {
      * @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>} -
+     * @returns {Promise<Ecwt<D>>} -
      */
     create(data: D, { ttl, }?: {
         ttl?: number | null | undefined;
-    } | undefined): Promise<Ecwt>;
+    } | undefined): Promise<Ecwt<D>>;
     /**
      * Parses token.
      * @async
      * @param {string} token String representation of token.
-     * @returns {Promise<Ecwt>} -
+     * @returns {Promise<Ecwt<D>>} -
      */
-    verify(token: string): Promise<Ecwt>;
+    verify(token: string): Promise<Ecwt<D>>;
     /**
      * 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.
+     * @returns {Promise<{ success: true, ecwt: Ecwt<D> } | { success: false, ecwt: Ecwt<D> | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
      */
     safeVerify(token: string): Promise<{
         success: true;
-        ecwt: Ecwt;
+        ecwt: Ecwt<D>;
     } | {
         success: false;
-        ecwt: Ecwt | null;
+        ecwt: Ecwt<D> | null;
     }>;
     /**
      * Revokes token.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ecwt",
-	"version": "0.2.1-beta.3",
+	"version": "0.2.1-beta.5",
 	"description": "Encrypted CBOR-encoded Web Token",
 	"type": "module",
 	"main": "src/main.js",
@@ -25,20 +25,20 @@
 		"redis": "^4"
 	},
 	"devDependencies": {
-		"@kirick/eslint-config": "^0.1.11",
-		"@types/node": "^20.14.9",
+		"@kirick/eslint-config": "^0.1.21",
+		"@types/node": "^22.2",
 		"eslint": "9.8.0",
-		"valibot": "^0.33",
+		"valibot": "^0.37",
 		"vitest": "^1.6"
 	},
 	"scripts": {
 		"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 dist/types",
+		"build:types": "rm -rf dist/esm dist/types ; bunx tsc --emitDeclarationOnly && rm dist/**/*.test.d.ts",
 		"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-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",
+		"redis:up": "docker ps | grep test-redis >/dev/null || docker run --rm -d -p 16379:6379 --name test-redis redis:7-alpine",
+		"test": "bun run redis:up && npm run test:vitest && bun test --coverage",
 		"test:vitest": "vitest run --no-file-parallelism"
 	},
 	"repository": {

package/src/factory.js

@@ -53,7 +53,7 @@ export class EcwtFactory {
 	 * @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 {(value: unknown) => D} [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({
@@ -111,7 +111,7 @@ export class EcwtFactory {
 	 * @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>} -
+	 * @returns {Promise<Ecwt<D>>} -
 	 */
 	async create(
 		data,
@@ -190,7 +190,7 @@ export class EcwtFactory {
 	 * Parses token.
 	 * @async
 	 * @param {string} token String representation of token.
-	 * @returns {Promise<Ecwt>} -
+	 * @returns {Promise<Ecwt<D>>} -
 	 */
 	async verify(token) {
 		if (typeof token !== 'string') {
@@ -297,7 +297,7 @@ export class EcwtFactory {
 	 * 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.
+	 * @returns {Promise<{ success: true, ecwt: Ecwt<D> } | { success: false, ecwt: Ecwt<D> | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
 	 */
 	async safeVerify(token) {
 		let ecwt = null;