enh(#895): Custom refresh response token pointer

docs/guide/local/quick-start.md

@@ -223,6 +223,7 @@ export default defineNuxtConfig({
         endpoint: { path: '/refresh', method: 'POST' },
         refreshOnlyToken: true,
         token: {
+          refreshResponseTokenPointer: '/token',
           signInResponseRefreshTokenPointer: '/refresh-token',
           refreshRequestTokenPointer: '/refresh-token',
           cookieName: 'auth.token',
@@ -280,6 +281,17 @@ When refreshOnlyToken is set, only the `token` will be refreshed and the `refres
 
 ### `token`
 
+#### `refreshResponseTokenPointer`
+
+- **Type:** `string`
+- **Default:** `'/token'`
+
+How to extract the authentication-token from the refresh response.
+
+E.g., setting this to `/token/bearer` and returning an object like `{ token: { bearer: 'THE_AUTH_TOKEN' }, timestamp: '2023' }` from the `refresh` endpoint will result in `nuxt-auth` extracting and storing `THE_AUTH_TOKEN`.
+
+This follows the JSON Pointer standard, see its RFC6901 here: https://www.rfc-editor.org/rfc/rfc6901
+
 #### `signInResponseRefreshTokenPointer`
 
 - **Type:** `string`

playground-local/nuxt.config.ts

@@ -26,6 +26,7 @@ export default defineNuxtConfig({
         isEnabled: process.env.NUXT_AUTH_REFRESH_ENABLED !== 'false',
         endpoint: { path: '/refresh', method: 'post' },
         token: {
+          refreshResponseTokenPointer: '/token/accessToken',
           signInResponseRefreshTokenPointer: '/token/refreshToken',
           refreshRequestTokenPointer: '/refreshToken'
         },

src/module.ts

@@ -76,6 +76,7 @@ const defaultsByBackend: {
       endpoint: { path: '/refresh', method: 'post' },
       refreshOnlyToken: true,
       token: {
+        refreshResponseTokenPointer: '/token',
         signInResponseRefreshTokenPointer: '/refreshToken',
         refreshRequestTokenPointer: '/refreshToken',
         cookieName: 'auth.refresh-token',

src/runtime/composables/local/useAuth.ts

@@ -195,11 +195,11 @@ async function refresh(getSessionOptions?: GetSessionOptions) {
   })
 
   // Extract the new token from the refresh response
-  const extractedToken = jsonPointerGet(response, config.token.signInResponseTokenPointer)
+  const extractedToken = jsonPointerGet(response, config.refresh.token.refreshResponseTokenPointer)
   if (typeof extractedToken !== 'string') {
     console.error(
       `Auth: string token expected, received instead: ${JSON.stringify(extractedToken)}. `
-      + `Tried to find token at ${config.token.signInResponseTokenPointer} in ${JSON.stringify(response)}`
+      + `Tried to find token at ${config.refresh.token.refreshResponseTokenPointer} in ${JSON.stringify(response)}`
     )
     return
   }

src/runtime/plugins/refresh-token.server.ts

@@ -34,14 +34,13 @@ export default defineNuxtPlugin({
 
         const extractedToken = jsonPointerGet(
           response,
-          provider.token.signInResponseTokenPointer
+          provider.refresh.token.refreshResponseTokenPointer
         )
         if (typeof extractedToken !== 'string') {
           console.error(
             `Auth: string token expected, received instead: ${JSON.stringify(
               extractedToken
-            )}. Tried to find token at ${
-              provider.token.signInResponseTokenPointer
+            )}. Tried to find token at ${provider.refresh.token.refreshResponseTokenPointer
             } in ${JSON.stringify(response)}`
           )
           return
@@ -57,8 +56,7 @@ export default defineNuxtPlugin({
             console.error(
               `Auth: string token expected, received instead: ${JSON.stringify(
                 extractedRefreshToken
-              )}. Tried to find token at ${
-                provider.refresh.token.signInResponseRefreshTokenPointer
+              )}. Tried to find token at ${provider.refresh.token.signInResponseRefreshTokenPointer
               } in ${JSON.stringify(response)}`
             )
             return

src/runtime/types.ts

@@ -243,6 +243,18 @@ export interface ProviderLocal {
      * Settings for the refresh-token that `nuxt-auth` receives from the `signIn` endpoint that is used for the `refresh` endpoint.
      */
     token?: {
+      /**
+       * How to extract the authentication-token from the refresh response.
+       *
+       * E.g., setting this to `/token/bearer` and returning an object like `{ token: { bearer: 'THE_AUTH_TOKEN' }, timestamp: '2023' }` from the `refresh` endpoint will
+       * result in `nuxt-auth` extracting and storing `THE_AUTH_TOKEN`.
+       *
+       * This follows the JSON Pointer standard, see it's RFC6901 here: https://www.rfc-editor.org/rfc/rfc6901
+       *
+       * @default /token  Access the `token` property of the refresh response object
+       * @example /       Access the root of the refresh response object, useful when your endpoint returns a plain, non-object string as the token
+       */
+      refreshResponseTokenPointer?: string
       /**
        * How to extract the authentication-token from the sign-in response.
        *