Improve out of the box types by using a prefix when decorating (#224)

* Use a prefix when decorating fastify

This enables out of the box typing + can, if the old way is eventually dropped, stop the risk of clashes between other fastify plugins and/or core methods and the names used in auth configurations.

Signed-off-by: Pelle Wessman <[email protected]>

* Fix feedback from @mcollina

---------

Signed-off-by: Pelle Wessman <[email protected]>

Author: voxpelli

README.md

@@ -221,20 +221,20 @@ See the [`example/`](./examples/) folder for more examples.
 ## Reference
 
 This Fastify plugin decorates the fastify instance with the [`simple-oauth2`](https://github.com/lelylan/simple-oauth2)
-instance inside a **namespace** specified by the property `name`.
+instance inside a **namespace** specified by the property `name` both with and without an `oauth2` prefix.
 
 E.g. For `name: 'customOauth2'`, the `simple-oauth2` instance will become accessible like this:
 
-`fastify.customOauth2.oauth2`
+`fastify.oauth2CustomOauth2.oauth2` and `fastify.customOauth2.oauth2`
 
 In this manner we are able to register multiple OAuth providers and each OAuth providers `simple-oauth2` instance will live in it's own **namespace**.
 
 E.g.
 
-- `fastify.facebook.oauth2`
-- `fastify.github.oauth2`
-- `fastify.spotify.oauth2`
-- `fastify.vkontakte.oauth2`
+- `fastify.oauth2Facebook.oauth2`
+- `fastify.oauth2Github.oauth2`
+- `fastify.oauth2Spotify.oauth2`
+- `fastify.oauth2Vkontakte.oauth2`
 
 Assuming we have registered multiple OAuth providers like this:
 
@@ -263,7 +263,7 @@ fastify.googleOAuth2.getNewAccessTokenUsingRefreshToken(currentAccessToken, (err
 
 ```js
 fastify.get('/external', { /* Hooks can be used here */ }, async (req, reply) => {
-  const authorizationEndpoint = fastify.customOAuth2.generateAuthorizationUri(req, reply);
+  const authorizationEndpoint = fastify.oauth2CustomOAuth2.generateAuthorizationUri(req, reply);
   reply.redirect(authorizationEndpoint)
 });
 ```
@@ -282,8 +282,8 @@ fastify.googleOAuth2.revokeAllToken(currentAccessToken, undefined, (err) => {
 ```
 E.g. For `name: 'customOauth2'`, the helpers `getAccessTokenFromAuthorizationCodeFlow` and `getNewAccessTokenUsingRefreshToken` will become accessible like this:
 
-- `fastify.customOauth2.getAccessTokenFromAuthorizationCodeFlow`
-- `fastify.customOauth2.getNewAccessTokenUsingRefreshToken`
+- `fastify.oauth2CustomOauth2.getAccessTokenFromAuthorizationCodeFlow`
+- `fastify.oauth2CustomOauth2.getNewAccessTokenUsingRefreshToken`
 
 ## Usage with TypeScript
 
@@ -302,6 +302,8 @@ declare module 'fastify' {
 }
 ```
 
+All auth configurations are made available with an `oauth2` prefix that's typed to `OAuth2Namespace | undefined`, such as eg. `fastify.oauth2CustomOauth2` for `customOauth2`.
+
 ## Provider Quirks
 
 The following providers require additional work to be set up correctly.

index.js

@@ -206,15 +206,18 @@ function fastifyOauth2 (fastify, options, next) {
     fastify.get(startRedirectPath, { schema }, startRedirectHandler)
   }
 
+  const decoration = {
+    oauth2,
+    getAccessTokenFromAuthorizationCodeFlow,
+    getNewAccessTokenUsingRefreshToken,
+    generateAuthorizationUri,
+    revokeToken,
+    revokeAllToken
+  }
+
   try {
-    fastify.decorate(name, {
-      oauth2,
-      getAccessTokenFromAuthorizationCodeFlow,
-      getNewAccessTokenUsingRefreshToken,
-      generateAuthorizationUri,
-      revokeToken,
-      revokeAllToken
-    })
+    fastify.decorate(name, decoration)
+    fastify.decorate(`oauth2${name.slice(0, 1).toUpperCase()}${name.slice(1)}`, decoration)
   } catch (e) {
     next(e)
     return

test/index.test.js

@@ -85,6 +85,9 @@ t.test('fastify-oauth2', t => {
     })
 
     fastify.get('/', function (request, reply) {
+      if (this.githubOAuth2 !== this.oauth2GithubOAuth2) {
+        throw new Error('Expected oauth2GithubOAuth2 to match githubOAuth2')
+      }
       this.githubOAuth2.getAccessTokenFromAuthorizationCodeFlow(request, (err, result) => {
         if (err) throw err
 

types/index.d.ts

@@ -162,3 +162,12 @@ declare namespace fastifyOauth2 {
 declare function fastifyOauth2(...params: Parameters<FastifyOauth2>): ReturnType<FastifyOauth2>
 
 export = fastifyOauth2
+
+type UpperCaseCharacters = 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z';
+
+declare module 'fastify' {
+    interface FastifyInstance {
+        // UpperCaseCharacters ensures that the name has at least one character in it + is a simple camel-case:ification
+        [key: `oauth2${UpperCaseCharacters}${string}`]: fastifyOauth2.OAuth2Namespace | undefined;
+    }
+}

types/index.test-d.ts

@@ -121,6 +121,7 @@ expectAssignable<ProviderConfiguration>(fastifyOauth2.YANDEX_CONFIGURATION);
 
 server.get('/testOauth/callback', async (request, reply) => {
     expectType<OAuth2Namespace>(server.testOAuthName);
+    expectType<OAuth2Namespace | undefined>(server.oauth2TestOAuthName);
 
     expectType<OAuth2Token>(await server.testOAuthName.getAccessTokenFromAuthorizationCodeFlow(request));
     expectType<Promise<OAuth2Token>>(server.testOAuthName.getAccessTokenFromAuthorizationCodeFlow(request));