ecwt 0.1.0-beta.3 → 0.1.1-beta.2

package/README.md

@@ -147,19 +147,24 @@ create(
         [key: string]: any,
     },
     options: {
-        ttl: number?,
+        ttl: number | null,
     }
 ): Promise<Ecwt>
 ```
 
 Creates a token.
 
-`options.ttl` specifies the time to live of the token in seconds. If not specified, the token will not expire.
+`options.ttl` specifies the time to live of the token in seconds. If set to null, token will never expire.
+
+> **Be careful with `ttl　=　null`!**
+>
+> Revoked tokens are stored in Redis until they expire. Never-expiring tokens will be stored in Redis **forever**, which will lead to uncontrolled Redis database growth.
 
 Returns `Ecwt` instance.
 
 ```javascript
-const ecwt_token = await ecwtFactory.create(
+// Example
+const ecwt = await ecwtFactory.create(
     {
         user_id: 1,
         nick: 'kirick',
@@ -190,40 +195,44 @@ Returns `Ecwt` instance.
 If the token is invalid, throws `EcwtInvalidError` which contains `Ecwt` instance in the `ecwt` property.
 
 ```javascript
-const ecwt_token = await ecwtFactory.verify(token);
+const ecwt = await ecwtFactory.verify(token);
 ```
 
 ### `Ecwt`
 
-Represents the token. It cannot be created by the user.
+Represents the token. Its counstructor cannot be called by the user.
 
 ```javascript
 import { Ecwt } from 'ecwt';
 ```
 
-#### Class property `token: string`
+#### Class property `readonly token: string`
 
 The string representation of the token.
 
-#### Class property `id: string`
+#### Class property `readonly id: string`
 
 The unique ID of the token.
 
-#### Class property `snowflake: Snowflake`
+#### Class property `readonly snowflake: Snowflake`
 
 The `Snowflake` instance of the token. For documentation, see [snowflake-js repository](https://github.com/kirick13/snowflake-js).
 
-#### Class property `ts_expired: number`
+#### Class property `readonly ts_expired: number | null`
 
-The timestamp of the token expiration in seconds. If the token does not expire, it is `Number.POSITIVE_INFINITY`.
+The timestamp of the token expiration in seconds. Equals to `null` if the token does not expire.
 
-#### Class property `ttl: number`
+#### Class property `readonly data: { [key: string]: any }`
 
-Current the time to live of the token in seconds. If the token does not expire, it is `Number.POSITIVE_INFINITY`.
+The payload of the token.
 
-#### Class property `data: { [key: string]: any }`
+#### Class method `getTTL`
 
-The payload of the token.
+```typescript
+getTTL(): number | null
+```
+
+Returns current the time to live of the token in seconds. If the token does not expire, returns `null`.
 
 #### Class method `revoke`
 
@@ -231,4 +240,4 @@ The payload of the token.
 revoke(): Promise<void>
 ```
 
-Revokes the token. It will be impossible to verify it after that.
+Revokes the token. Attempts to verify the revoked token will throw `EcwtRevokedError`.

package/dist/ecwt.cjs

@@ -30,7 +30,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var main_exports = {};
 __export(main_exports, {
   Ecwt: () => Ecwt,
-  EcwtFactory: () => EcwtFactory
+  EcwtExpiredError: () => EcwtExpiredError,
+  EcwtFactory: () => EcwtFactory,
+  EcwtInvalidError: () => EcwtInvalidError,
+  EcwtRevokedError: () => EcwtRevokedError
 });
 module.exports = __toCommonJS(main_exports);
 
@@ -47,18 +50,57 @@ 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;
-  #token;
-  #snowflake;
   #ttl_initial;
-  #data;
+  /**
+   * Token string representation.
+   * @type {string}
+   * @readonly
+   */
+  token;
+  /**
+   * Token ID.
+   * @type {string}
+   * @readonly
+   */
+  id;
+  /**
+   * Snowflake associated with token.
+   * @type {Snowflake}
+   * @readonly
+   */
+  snowflake;
+  /**
+   * Timestamp when token expires in seconds.
+   * @type {number?}
+   * @readonly
+   */
+  ts_expired;
+  /**
+   * Data stored in token.
+   * @type {{ [key: string]: any }}
+   * @readonly
+   */
+  data;
   /**
    * @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 {number?} options.ttl_initial Time to live in seconds at the moment of token creation.
    * @param {object} options.data Data stored in token.
    */
   constructor(ecwtFactory, {
@@ -68,45 +110,46 @@ var Ecwt = class {
     data
   }) {
     this.#ecwtFactory = ecwtFactory;
-    this.#token = token;
-    this.#snowflake = snowflake;
     this.#ttl_initial = ttl_initial;
-    this.#data = Object.freeze(data);
-  }
-  get token() {
-    return this.#token;
-  }
-  get id() {
-    return this.#snowflake.base62;
-  }
-  get snowflake() {
-    return this.#snowflake;
+    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)
+    );
   }
-  get ts_expired() {
+  #getTimestampExpired() {
     if (this.#ttl_initial === null) {
-      return Number.POSITIVE_INFINITY;
+      return null;
     }
-    return toSeconds(this.#snowflake.timestamp) + this.#ttl_initial;
+    return toSeconds(this.snowflake.timestamp) + this.#ttl_initial;
   }
   /**
-   * Time to live in seconds.
-   * @type {number}
-   * @readonly
+   * Actual time to live in seconds.
+   * @returns {number | null} -
    */
-  get ttl() {
+  getTTL() {
     if (this.#ttl_initial === null) {
-      return Number.POSITIVE_INFINITY;
+      return null;
     }
-    return this.#ttl_initial - toSeconds(Date.now() - this.#snowflake.timestamp);
-  }
-  get data() {
-    return this.#data;
+    return this.#ttl_initial - toSeconds(Date.now() - this.snowflake.timestamp);
   }
   /* async */
   revoke() {
     return this.#ecwtFactory._revoke({
       token_id: this.id,
-      ts_ms_created: this.#snowflake.timestamp,
+      ts_ms_created: this.snowflake.timestamp,
       ttl_initial: this.#ttl_initial
     });
   }
@@ -233,12 +276,12 @@ var EcwtFactory = class {
       }
       payload.push(value);
     }
-    if (typeof ttl !== "number" && Number.isNaN(ttl) !== true || ttl === Number.POSITIVE_INFINITY) {
-      ttl = null;
+    if (typeof ttl !== "number" && Number.isNaN(ttl) !== true && ttl !== null) {
+      throw new TypeError("TTL must be a number or null.");
     }
     const snowflake = await this.#snowflakeFactory.createSafe();
     const token_raw = (0, import_cbor_x.encode)([
-      snowflake.buffer,
+      snowflake.toBuffer(),
       ttl,
       payload
     ]);
@@ -360,6 +403,7 @@ var EcwtFactory = class {
     ttl_initial
   }) {
     if (this.#redisClient) {
+      ttl_initial = 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.sendCommand([
@@ -385,5 +429,8 @@ var EcwtFactory = class {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Ecwt,
-  EcwtFactory
+  EcwtExpiredError,
+  EcwtFactory,
+  EcwtInvalidError,
+  EcwtRevokedError
 });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ecwt",
-	"version": "0.1.0-beta.3",
+	"version": "0.1.1-beta.2",
 	"description": "Encrypted CBOR-encoded Web Token",
 	"main": "src/main.js",
 	"type": "module",
@@ -19,7 +19,7 @@
 		"evilcrypt": "0.2.0-beta.4"
 	},
 	"peerDependencies": {
-		"@kirick/snowflake": "^0.2.0-beta.7",
+		"@kirick/snowflake": "^0.2.1-beta.1",
 		"lru-cache": "^7 || ^8 || ^9 || ^10",
 		"redis": "^4"
 	},

package/src/factory.js

@@ -137,19 +137,17 @@ export class EcwtFactory {
 		}
 
 		if (
-			(
-				typeof ttl !== 'number'
-				&& Number.isNaN(ttl) !== true
-			)
-			|| ttl === Number.POSITIVE_INFINITY
+			typeof ttl !== 'number'
+			&& Number.isNaN(ttl) !== true
+			&& ttl !== null
 		) {
-			ttl = null;
+			throw new TypeError('TTL must be a number or null.');
 		}
 
 		const snowflake = await this.#snowflakeFactory.createSafe();
 
 		const token_raw = cborEncode([
-			snowflake.buffer,
+			snowflake.toBuffer(),
 			ttl,
 			payload,
 		]);
@@ -299,6 +297,8 @@ export class EcwtFactory {
 		ttl_initial,
 	}) {
 		if (this.#redisClient) {
+			ttl_initial = ttl_initial ?? Number.MAX_SAFE_INTEGER;
+
 			const ts_ms_expired = ts_ms_created + (ttl_initial * 1000);
 			if (ts_ms_expired > Date.now()) {
 				await this.#redisClient.sendCommand([

package/src/main.js

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

package/src/token.js

@@ -2,24 +2,70 @@
 import { toSeconds } from './utils/time.js';
 
 /**
- * @typedef {import('@kirick/snowflake/src/snowflake.js').Snowflake} Snowflake
+ * @typedef {import('@kirick/snowflake').Snowflake} Snowflake
  * @typedef {import('./factory.js').EcwtFactory} EcwtFactory
  */
 
+/**
+ * Assigns property to object.
+ * @param {object} target -
+ * @param {string} key -
+ * @param {any} value -
+ */
+function assign(target, key, value) {
+	Object.defineProperty(
+		target,
+		key,
+		{
+			value,
+			enumerable: true,
+			writable: false,
+			configurable: false,
+		},
+	);
+}
+
 export class Ecwt {
 	#ecwtFactory;
-
-	#token;
-	#snowflake;
 	#ttl_initial;
-	#data;
+
+	/**
+	 * Token string representation.
+	 * @type {string}
+	 * @readonly
+	 */
+	token;
+	/**
+	 * Token ID.
+	 * @type {string}
+	 * @readonly
+	 */
+	id;
+	/**
+	 * Snowflake associated with token.
+	 * @type {Snowflake}
+	 * @readonly
+	 */
+	snowflake;
+	/**
+	 * Timestamp when token expires in seconds.
+	 * @type {number?}
+	 * @readonly
+	 */
+	ts_expired;
+	/**
+	 * Data stored in token.
+	 * @type {{ [key: string]: any }}
+	 * @readonly
+	 */
+	data;
 
 	/**
 	 * @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 {number?} options.ttl_initial Time to live in seconds at the moment of token creation.
 	 * @param {object} options.data Data stored in token.
 	 */
 	constructor(
@@ -33,53 +79,51 @@ export class Ecwt {
 	) {
 		this.#ecwtFactory = ecwtFactory;
 
-		this.#token = token;
-		this.#snowflake = snowflake;
 		this.#ttl_initial = ttl_initial;
-		this.#data = Object.freeze(data);
-	}
 
-	get token() {
-		return this.#token;
+		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),
+		);
 	}
 
-	get id() {
-		return this.#snowflake.base62;
-	}
-
-	get snowflake() {
-		return this.#snowflake;
-	}
-
-	get ts_expired() {
+	#getTimestampExpired() {
 		if (this.#ttl_initial === null) {
-			return Number.POSITIVE_INFINITY;
+			return null;
 		}
 
-		return toSeconds(this.#snowflake.timestamp) + this.#ttl_initial;
+		return toSeconds(this.snowflake.timestamp) + this.#ttl_initial;
 	}
 
 	/**
-	 * Time to live in seconds.
-	 * @type {number}
-	 * @readonly
+	 * Actual time to live in seconds.
+	 * @returns {number | null} -
 	 */
-	get ttl() {
+	getTTL() {
 		if (this.#ttl_initial === null) {
-			return Number.POSITIVE_INFINITY;
+			return null;
 		}
 
-		return this.#ttl_initial - toSeconds(Date.now() - this.#snowflake.timestamp);
-	}
-
-	get data() {
-		return this.#data;
+		return this.#ttl_initial - toSeconds(Date.now() - this.snowflake.timestamp);
 	}
 
 	/* async */ revoke() {
 		return this.#ecwtFactory._revoke({
 			token_id: this.id,
-			ts_ms_created: this.#snowflake.timestamp,
+			ts_ms_created: this.snowflake.timestamp,
 			ttl_initial: this.#ttl_initial,
 		});
 	}