Fix generateAuthorizationUri() typedef signature (#215)

* fix generateAuthorizationUri() typedef signature

* update readme

include the replyObject in the generateAuthorizationUri() example

---------

Co-authored-by: Kyriakos Nicola <[email protected]>

Author: knicola

README.md

@@ -245,11 +245,11 @@ fastify.googleOAuth2.getNewAccessTokenUsingRefreshToken(currentAccessToken, (err
 });
 ```
 
-- `generateAuthorizationUri(requestObject)`: A function that returns the authorization uri. This is generally useful when you want to handle the redirect yourself in a specific route. The `requestObject` argument passes the request object to the `generateStateFunction`). You **do not** need to declare a `startRedirectPath` if you use this approach. Example of how you would use it:
+- `generateAuthorizationUri(requestObject, replyObject)`: A function that returns the authorization uri. This is generally useful when you want to handle the redirect yourself in a specific route. The `requestObject` argument passes the request object to the `generateStateFunction`). You **do not** need to declare a `startRedirectPath` if you use this approach. Example of how you would use it:
 
 ```js
 fastify.get('/external', { /* Hooks can be used here */ }, async (req, reply) => {
-  const authorizationEndpoint = fastify.customOAuth2.generateAuthorizationUri(req);
+  const authorizationEndpoint = fastify.customOAuth2.generateAuthorizationUri(req, reply);
   reply.redirect(authorizationEndpoint)
 });
 ```

types/index.d.ts

@@ -1,4 +1,4 @@
-import { FastifyPluginCallback, FastifyRequest } from 'fastify';
+import { FastifyPluginCallback, FastifyReply, FastifyRequest } from 'fastify';
 
 interface FastifyOauth2 extends FastifyPluginCallback<fastifyOauth2.FastifyOAuth2Options> {
   APPLE_CONFIGURATION: fastifyOauth2.ProviderConfiguration;
@@ -127,6 +127,7 @@ declare namespace fastifyOauth2 {
 
     generateAuthorizationUri(
       request: FastifyRequest,
+      reply: FastifyReply,
     ): string;
   }
 

types/index.test-d.ts

@@ -86,7 +86,7 @@ expectAssignable<ProviderConfiguration>(fastifyOauth2.VATSIM_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.VATSIM_DEV_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.EPIC_GAMES_CONFIGURATION);
 
-server.get('/testOauth/callback', async request => {
+server.get('/testOauth/callback', async (request, reply) => {
   expectType<OAuth2Namespace>(server.testOAuthName);
 
   expectType<OAuth2Token>(await server.testOAuthName.getAccessTokenFromAuthorizationCodeFlow(request));
@@ -128,7 +128,8 @@ server.get('/testOauth/callback', async request => {
     expectError<void>(server.testOAuthName.getNewAccessTokenUsingRefreshToken(token.token, {})); // error because function call does not pass a callback as second argument.
   }
 
-  expectType<string>(server.testOAuthName.generateAuthorizationUri(request));
+  expectType<string>(server.testOAuthName.generateAuthorizationUri(request, reply));
+  expectError<string>(server.testOAuthName.generateAuthorizationUri(request)); // error because missing reply argument
 
   return {
     access_token: token.token.access_token,