Merge pull request #4 from yubinTW/scope

add scope to KeycloakOptions

README.md

@@ -40,6 +40,8 @@ server.register(keycloak, opts)
 
 - `clientSecret` client secret (required)
 
+- `scope` client scope of keycloak (optional, string[], defaults to `['openid']`)
+
 - `logoutEndpoint` route path of doing logout (optional, defaults to `/logout`)
 
 - `excludedPatterns` string array for non-authorized urls (optional, support  `?`, `*` and `**` wildcards)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "fastify-keycloak-adapter",
   "author": "Yubin, Hsu",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "main": "dist/keycloak",
   "types": "dist/keycloak",
   "keywords": [
@@ -25,7 +25,7 @@
   "scripts": {
     "build": "tsc",
     "test": "jest --coverage --runInBand --detectOpenHandles",
-    "fix-prettier": "prettier --write \"./{src,test}/**/*.ts\""
+    "fix-prettier": "prettier --write \"./src/**/*.ts\""
   },
   "dependencies": {
     "@fastify/cookie": "^6.0.0",

src/keycloak.ts

@@ -47,10 +47,12 @@ export type KeycloakOptions = {
   clientSecret?: string
   logoutEndpoint?: string
   excludedPatterns?: Array<string>
+  scope?: Array<string>
   userPayloadMapper?: (userPayload: UserInfo) => {}
 }
 
 export default fastifyPlugin(async (fastify: FastifyInstance, opts: KeycloakOptions) => {
+  console.log(`opts = ${inspect(opts, false, null)}`)
   function getWellKnownConfiguration(url: string) {
     return TE.tryCatch(
       () => axios.get<WellKnownConfiguration>(url),
@@ -101,7 +103,7 @@ export default fastifyPlugin(async (fastify: FastifyInstance, opts: KeycloakOpti
           authorize_url: config.authorization_endpoint,
           access_url: config.token_endpoint,
           callback: '/',
-          scope: ['openid'],
+          scope: opts.scope ?? ['openid'],
           nonce: true
         }
       })

src/tests/server.test.ts

@@ -1,4 +1,3 @@
-import axios from 'axios'
 import { FastifyInstance } from 'fastify'
 import { KeycloakContainer, StartedKeycloakContainer } from 'testcontainers-keycloak'
 import { KeycloakOptions } from '../keycloak'