feat(#35): add scope parameter (#37)

druxt · Jul 28, 2023 · b07c40b · b07c40b
1 parent 940533a
commit b07c40b
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 0 deletions.
diff --git a/.changeset/great-snails-lick.md b/.changeset/great-snails-lick.md
@@ -0,0 +1,5 @@
+---
+"druxt-auth": minor
+---
+
+feat(#35): added support for OAuth Scopes / Simple OAuth2 6.x
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v16.20.1
diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ module.exports = {
     ['druxt-auth', {
       clientId: '[DRUPAL_CONSUMER_UUID]',
       clientSecret: '[DRUPAL_CONSUMER_SECRET]',
+      scope: ['default'],
     }]
   ],
   druxt: {
@@ -86,3 +87,4 @@ It adds two auth strategies  that can be used via the `$auth` plugin:
 | --- | --- | --- | --- | --- |
 | `clientId` | `string` | Yes | `undefined` | The Drupal Consumer UUID |
 | `clientSecret` | `string` | No | `undefined` | The Drupal Consumer API secret. Required for Password grant. |
+| `scope` | `array` | No | `undefined` | The OAuth Scopes to be used for the Drupal Consumer. |
diff --git a/src/index.js b/src/index.js
@@ -9,6 +9,7 @@ const NuxtModule = function (moduleOptions = {}) {
       ...(this.options.druxt || {}).auth || {},
       clientId: undefined,
       clientSecret: undefined,
+      scope: undefined,
       ...moduleOptions,
     }
   }
@@ -65,6 +66,7 @@ const NuxtModule = function (moduleOptions = {}) {
         },
         clientId: (options.auth || {}).clientId || process.env.DRUXT_AUTH_CLIENT_ID,
         responseType: 'code',
+        scope: (options.auth || {}).scope,
         grantType: 'authorization_code',
         codeChallengeMethod: 'S256',
       },

diff --git a/test/__snapshots__/index.test.js.snap b/test/__snapshots__/index.test.js.snap
@@ -18,6 +18,7 @@ Object {
       "grantType": "authorization_code",
       "responseType": "code",
       "scheme": "oauth2",
+      "scope": undefined,
     },
     "drupal-password": Object {
       "endpoints": Object {
@@ -75,6 +76,7 @@ Object {
       "grantType": "authorization_code",
       "responseType": "code",
       "scheme": "oauth2",
+      "scope": undefined,
     },
     "drupal-password": Object {
       "endpoints": Object {
@@ -132,6 +134,7 @@ Object {
       "grantType": "authorization_code",
       "responseType": "code",
       "scheme": "oauth2",
+      "scope": undefined,
     },
     "drupal-password": Object {
       "endpoints": Object {
@@ -189,6 +192,7 @@ Object {
       "grantType": "authorization_code",
       "responseType": "code",
       "scheme": "oauth2",
+      "scope": undefined,
     },
     "drupal-password": Object {
       "endpoints": Object {