feature: add callback uri params (#19)

Author: meotimdihia

index.js

@@ -29,6 +29,9 @@ const oauthPlugin = fp(function (fastify, options, next) {
   if (typeof options.callbackUri !== 'string') {
     return next(new Error('options.callbackUri should be a string'))
   }
+  if (options.callbackUriParams && typeof options.callbackUriParams !== 'object') {
+    return next(new Error('options.callbackUriParams should be a object'))
+  }
   if (options.generateStateFunction && typeof options.generateStateFunction !== 'function') {
     return next(new Error('options.generateStateFunction should be a function'))
   }
@@ -45,19 +48,21 @@ const oauthPlugin = fp(function (fastify, options, next) {
   const name = options.name
   const credentials = options.credentials
   const callbackUri = options.callbackUri
+  const callbackUriParams = options.callbackUriParams || {}
   const scope = options.scope
   const generateStateFunction = options.generateStateFunction || defaultGenerateStateFunction
   const checkStateFunction = options.checkStateFunction || defaultCheckStateFunction
   const startRedirectPath = options.startRedirectPath
 
   function startRedirectHandler (request, reply) {
     const state = generateStateFunction()
-
-    const authorizationUri = this[name].authorizationCode.authorizeURL({
+    const urlOptions = Object.assign({}, callbackUriParams, {
       redirect_uri: callbackUri,
       scope: scope,
       state: state
     })
+
+    const authorizationUri = this[name].authorizationCode.authorizeURL(urlOptions)
     reply.redirect(authorizationUri)
   }
 

test.js

@@ -210,6 +210,67 @@ t.test('options.callbackUri should be and object', t => {
     })
 })
 
+t.test('options.callbackUriParams should be and object', t => {
+  t.plan(1)
+
+  const fastify = createFastify({ logger: { level: 'silent' } })
+
+  fastify.register(oauthPlugin, {
+    name: 'the-name',
+    credentials: {
+      client: {
+        id: 'my-client-id',
+        secret: 'my-secret'
+      },
+      auth: oauthPlugin.GITHUB_CONFIGURATION
+    },
+    callbackUri: '/callback',
+    callbackUriParams: 1
+  })
+    .ready(err => {
+      t.strictSame(err.message, 'options.callbackUriParams should be a object')
+    })
+})
+
+t.test('options.callbackUriParams', t => {
+  const fastify = createFastify({ logger: true })
+
+  fastify.register(oauthPlugin, {
+    name: 'the-name',
+    credentials: {
+      client: {
+        id: 'my-client-id',
+        secret: 'my-secret'
+      },
+      auth: oauthPlugin.GITHUB_CONFIGURATION
+    },
+    startRedirectPath: '/login/github',
+    callbackUri: '/callback',
+    callbackUriParams: {
+      access_type: 'offline'
+    },
+    scope: ['notifications']
+  })
+
+  t.tearDown(fastify.close.bind(fastify))
+
+  fastify.listen(0, function (err) {
+    t.error(err)
+
+    fastify.inject({
+      method: 'GET',
+      url: '/login/github'
+    }, function (err, responseStart) {
+      t.error(err)
+
+      t.equal(responseStart.statusCode, 302)
+      const matched = responseStart.headers.location.match(/https:\/\/github\.com\/login\/oauth\/authorize\?response_type=code&client_id=my-client-id&access_type=offline&redirect_uri=%2Fcallback&scope=notifications&state=(.*)/)
+      t.ok(matched)
+      t.end()
+    })
+  })
+})
+
 t.test('options.generateStateFunction should be and object', t => {
   t.plan(1)