Merge pull request #19 from yubinTW/feature/callback-option

feat(plugin-option): add custom callback option (#18)

README.md

@@ -20,7 +20,7 @@ yarn add fastify-keycloak-adapter
 ## Fastify Version
 
 - Fastify 4 -> `npm i fastify-keycloak-adapter`
-- Fastify 3 -> `npm i [email protected]`
+- Fastify 3 -> `npm i [email protected]` (deprecated)
 
 ## Usage
 
@@ -54,6 +54,8 @@ server.register(keycloak, opts)
 
 - `scope` client scope of keycloak (optional, string[], defaults to `['openid']`)
 
+- `callback` Relative or absolute URL to receive the response data (optional, defaults to `/`)
+
 - `retries` The number of times to retry before failing. (optional, number, defaults to 3)
 
 - `logoutEndpoint` route path of doing logout (optional, defaults to `/logout`)
@@ -85,7 +87,8 @@ const opts: KeycloakOptions = {
   clientId: 'myclient01',
   clientSecret: 'myClientSecret',
   logoutEndpoint: '/logout',
-  excludedPatterns: ['/metrics', '/api/todos/**']
+  excludedPatterns: ['/metrics', '/manifest.json', '/api/todos/**'],
+  callback: '/hello'
 }
 
 server.register(keycloak, opts)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "fastify-keycloak-adapter",
   "author": "Yubin, Hsu",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "main": "dist/keycloak",
   "keywords": [
     "fastify",

src/keycloak.ts

@@ -82,6 +82,7 @@ const partialOptions = t.partial({
   logoutEndpoint: t.readonly(t.string),
   excludedPatterns: t.readonly(t.array(t.string)),
   scope: t.array(t.readonly(t.string)),
+  callback: t.readonly(t.string),
   disableCookiePlugin: t.readonly(t.boolean),
   disableSessionPlugin: t.readonly(t.boolean),
   retries: t.readonly(t.number),
@@ -182,7 +183,7 @@ export default fastifyPlugin(async (fastify: FastifyInstance, opts: KeycloakOpti
           oauth: 2,
           authorize_url: config.authorization_endpoint,
           access_url: config.token_endpoint,
-          callback: '/',
+          callback: opts.callback ?? '/',
           scope: opts.scope ?? ['openid'],
           nonce: true
         }