Update to v1.4.3

Merge pull request #17 from IMZihad21/main
Destructure payload from decode function properly
2022-06-22 12:37:08 +02:00 · 2022-06-22 12:11:09 +02:00 · 2022-06-22 12:06:50 +06:00 · 2022-06-04 22:29:46 +02:00 · 2022-06-04 22:29:30 +02:00 · 2022-06-04 17:43:48 +02:00
4 changed files with 18 additions and 12 deletions
--- a/README.md
+++ b/README.md
@@ -8,6 +8,9 @@ A lightweight JWT implementation with ZERO dependencies for Cloudflare Workers.
 - [Install](#install)
 - [Examples](#examples)
 - [Usage](#usage)
+    - [Sign](#sign)
+    - [Verify](#verify)
+    - [Decode](#decode)


 ## Install
@@ -85,7 +88,7 @@ Argument    | Type     | Satus    | Default | Description
 ----------- | -------- | -------- | ------- | -----------
 `payload`   | `object` | required | -       | The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
 `secret`    | `string` | required | -       | A string which is used to sign the payload.
-`options`   | `object`, `string` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` and `keyid` or just the algorithm string. (See [Available Algorithms](#available-algorithms))
+`options`   | `object` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` and `keyid`. (See [Available Algorithms](#available-algorithms))

 #### `return`
 Returns token as a `string`.
@@ -101,7 +104,10 @@ Argument    | Type     | Satus    | Default | Description
 ----------- | -------- | -------- | ------- | -----------
 `token`     | `string` | required | -       | The token string generated by `jwt.sign()`.
 `secret`    | `string` | required | -       | The string which was used to sign the payload.
-`algorithm` | `object`, `string` | optional | `{ algorithm: 'HS256', throwError: false }` | The options object supporting `algorithm` or just the algorithm string. (See [Available Algorithms](#available-algorithms))
+`options`   | `object` | optional | `{ algorithm: 'HS256', throwError: false }` | The options object supporting `algorithm` and `throwError`. (See [Available Algorithms](#available-algorithms))
+
+#### `throws`
+If `options.throwError` is `true` and the token is invalid, an error will be thrown.

 #### `return`
 Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`. 
--- a/index.js
+++ b/index.js
@@ -94,7 +94,7 @@ class JWT {
        const importAlgorithm = this.algorithms[options.algorithm]
        if (!importAlgorithm)
            throw new Error('algorithm not found')
-        const payload = this.decode(token)
+        const { payload } = this.decode(token)
        if (payload.nbf && payload.nbf > Math.floor(Date.now() / 1000)) {
            if (options.throwError)
                throw 'NOT_YET_VALID'
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
  "name": "@tsndr/cloudflare-worker-jwt",
-  "version": "1.2.0",
+  "version": "1.4.3",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "@tsndr/cloudflare-worker-jwt",
-      "version": "1.2.0",
+      "version": "1.4.3",
      "license": "MIT",
      "devDependencies": {
        "jest": "^28.1.0"
@@ -4262,9 +4262,9 @@
      }
    },
    "node_modules/path-parse": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
-      "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==",
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+      "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==",
      "dev": true
    },
    "node_modules/picocolors": {
@@ -8066,9 +8066,9 @@
      "dev": true
    },
    "path-parse": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
-      "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==",
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+      "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==",
      "dev": true
    },
    "picocolors": {
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@tsndr/cloudflare-worker-jwt",
-  "version": "1.4.0",
+  "version": "1.4.3",
  "description": "A lightweight JWT implementation with ZERO dependencies for Cloudflare Worker",
  "main": "index.js",
  "scripts": {
Author	SHA1	Message	Date
Tobias Schneider	21ec1b6f2a	Update to v1.4.3	2022-06-22 12:37:08 +02:00
Toby Schneider	97df6e7f81	Merge pull request #17 from IMZihad21/main Destructure payload from decode function properly	2022-06-22 12:11:09 +02:00
ZèD	7198501a40	Destructure payload from decode function properly The decode function returns an object containing a header and payload properties. Assigning the whole object to payload fails nbf and exp checks on verify JWT as those properties not found in decode return object directly. Instead, destructure payload property from decode return data that contains those values and check them correctly. Signed-off-by: ZèD <imzihad@gmail.com>	2022-06-22 12:06:50 +06:00
Tobias Schneider	cb6209b1b6	Docs fix	2022-06-04 22:29:46 +02:00
Tobias Schneider	8f4e5e3199	Docs fix	2022-06-04 22:29:30 +02:00
Tobias Schneider	594cdd6c05	Docs fix	2022-06-04 17:43:48 +02:00
Tobias Schneider	f85abf30a8	Update docs	2022-06-04 17:43:11 +02:00
Tobias Schneider	095b1d43f3	Update docs	2022-06-04 17:42:33 +02:00
Tobias Schneider	0bc128fec1	Update docs	2022-06-04 17:40:47 +02:00