ecwt 0.2.0-beta.4 → 0.2.0-beta.5

package/dist/ecwt.cjs

@@ -419,7 +419,7 @@ var EcwtFactory = class {
    * Parses token without throwing errors.
    * @async
    * @param {string} token String representation of token.
-   * @returns {Promise<{ success: boolean, ecwt: Ecwt | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
+   * @returns {Promise<{ success: true, ecwt: Ecwt } | { success: false, ecwt: Ecwt | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
    */
   async safeVerify(token) {
     let ecwt = null;
@@ -451,7 +451,7 @@ var EcwtFactory = class {
    * @param {object} options -
    * @param {string} options.token_id -
    * @param {number} options.ts_ms_created -
-   * @param {number} options.ttl_initial -
+   * @param {number | null} options.ttl_initial -
    * @returns {Promise<void>} -
    */
   async _revoke({

package/package.json

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

package/src/factory.js

@@ -311,7 +311,7 @@ export class EcwtFactory {
 	 * Parses token without throwing errors.
 	 * @async
 	 * @param {string} token String representation of token.
-	 * @returns {Promise<{ success: boolean, ecwt: Ecwt | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
+	 * @returns {Promise<{ success: true, ecwt: Ecwt } | { success: false, ecwt: Ecwt | null }>} Returns whether token was parsed and verified successfully and Ecwt if parsed.
 	 */
 	async safeVerify(token) {
 		let ecwt = null;
@@ -348,7 +348,7 @@ export class EcwtFactory {
 	 * @param {object} options -
 	 * @param {string} options.token_id -
 	 * @param {number} options.ts_ms_created -
-	 * @param {number} options.ttl_initial -
+	 * @param {number | null} options.ttl_initial -
 	 * @returns {Promise<void>} -
 	 */
 	async _revoke({

package/src/main.js

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

package/src/token.js

@@ -1,4 +1,6 @@
 
+// @ts-check
+
 import { toSeconds } from './utils/time.js';
 
 /**

package/src/utils/base62.js

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

package/src/utils/errors.js

@@ -1,4 +1,6 @@
 
+// @ts-check
+
 export class InvalidPackageInstanceError extends TypeError {
 	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.`);

package/src/utils/time.js

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