[PR changes #392] feat: move pointer and sessionDataType to the SessionConfig

docs/content/2.configuration/2.nuxt-config.md

@@ -219,14 +219,31 @@ type ProviderLocal = {
      */
      sameSiteAttribute?:  boolean | 'lax' | 'strict' | 'none' | undefined,
   },
-  /**
-   * Define an interface for the session data object that `nuxt-auth` expects to receive from the `getSession` endpoint.
-   *
-   * @default { id: 'string | number' }
-   * @example { id: 'string', name: 'string', email: 'string' }
-   * @advanced_array_example { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" }
+  /*
+   * Settings for the session-data that `nuxt-auth` receives from the `getSession` endpoint.
    */
-  sessionDataType?: SessionDataObject,
+  session?: {
+    /**
+     * Define an interface for the session data object that `nuxt-auth` expects to receive from the `getSession` endpoint.
+     *
+     * @default { id: 'string | number' }
+     * @example { id: 'string', name: 'string', email: 'string' }
+     * @advanced_array_example { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" }
+     */
+    dataType?: SessionDataObject;
+    /**
+     * How to extract the session-data from the session response.
+     *
+     * E.g., setting this to `/data/user` and returning an object like `{ data: { user: { id:number, name: string } }, status: 'ok' }` from the `getSession` endpoint will
+     * storing the 'User' object typed as the type created via the 'dataType' prop.
+     *
+     * This follows the JSON Pointer standard, see it's RFC6901 here: https://www.rfc-editor.org/rfc/rfc6901
+     *
+     * @default / Access the root of the session response object
+     * @example /data/user  Access the `data/user` property of the session response object
+     */
+    dataResponsePointer?: string;
+  }
 }
 
 ```
@@ -364,7 +381,7 @@ type ProviderRefresh = {
      * @default /refreshToken  Access the `refreshToken` property of the sign-in response object
      * @example /       Access the root of the sign-in response object, useful when your endpoint returns a plain, non-object string as the refreshToken
      */
-    signInResponseRefreshTokenPointer?: string
+    signInResponseRefreshTokenPointer?: string,
     /**
      * Maximum age to store the authentication token for. After the expiry time the token is automatically deleted on the application side, i.e., in the users' browser.
      *
@@ -375,14 +392,31 @@ type ProviderRefresh = {
      */
     maxAgeInSeconds?: number,
   },
-  /**
-   * Define an interface for the session data object that `nuxt-auth` expects to receive from the `getSession` endpoint.
-   *
-   * @default { id: 'string | number' }
-   * @example { id: 'string', name: 'string', email: 'string' }
-   * @advanced_array_example { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" }
+  /*
+   * Settings for the session-data that `nuxt-auth` receives from the `getSession` endpoint.
    */
-  sessionDataType?: SessionDataObject,
+  session?: {
+    /**
+     * Define an interface for the session data object that `nuxt-auth` expects to receive from the `getSession` endpoint.
+     *
+     * @default { id: 'string | number' }
+     * @example { id: 'string', name: 'string', email: 'string' }
+     * @advanced_array_example { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" }
+     */
+    dataType?: SessionDataObject;
+    /**
+     * How to extract the session-data from the session response.
+     *
+     * E.g., setting this to `/data/user` and returning an object like `{ data: { user: { id:number, name: string } }, status: 'ok' }` from the `getSession` endpoint will
+     * storing the 'User' object typed as the type created via the 'dataType' prop.
+     *
+     * This follows the JSON Pointer standard, see it's RFC6901 here: https://www.rfc-editor.org/rfc/rfc6901
+     *
+     * @default / Access the root of the session response object
+     * @example /data/user  Access the `data/user` property of the session response object
+     */
+    dataResponsePointer?: string;
+  }
 }
 ```
 ```ts [SessionConfig]
@@ -401,7 +435,7 @@ type SessionConfig = {
    * @default false
    *
    */
-  enableRefreshPeriodically: number | boolean
+  enableRefreshPeriodically: number | boolean,
   /**
    * Whether to refresh the session every time the browser window is refocused.
    *

docs/content/3.application-side/2.session-access-and-management.md

@@ -171,7 +171,7 @@ inferface SessionData {
     id: string | number
 }
 
-// Option B: You configured `auth.provider.sessionDataType` to something like ` { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account' }`
+// Option B: You configured `auth.provider.session.dataType` to something like ` { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account' }`
 inferface SessionData { 
   id: string
   email: string
@@ -181,7 +181,7 @@ inferface SessionData {
 ```
 ::
 
-### About `auth.provider.sessionDataType`
+### About `auth.provider.session.dataType`
 
 This is a configuration option available to dynamically type the `SessionData` that the `local` provider will return when accessing `data.value`. Read more about this in the [nuxt.config.ts configuration documentation](/nuxt-auth/v0.6/configuration/nuxt-config) of the `local` provider.
 

playground-local/nuxt.config.ts

@@ -15,12 +15,14 @@ export default defineNuxtConfig({
       token: {
         signInResponseTokenPointer: '/token/accessToken'
       },
-      sessionDataType: { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" }
+      session: {
+        dataType: { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" },
+        dataResponsePointer: '/data/user'
+      }
     },
     session: {
       // Whether to refresh the session every time the browser window is refocused.
       enableRefreshOnWindowFocus: true,
-
       // Whether to refresh the session every `X` milliseconds. Set this to `false` to turn it off. The session will only be refreshed if a session already exists.
       enableRefreshPeriodically: 5000
     },

src/module.ts

@@ -55,7 +55,10 @@ const defaultsByBackend: {
       maxAgeInSeconds: 30 * 60,
       sameSiteAttribute: 'lax'
     },
-    sessionDataType: { id: 'string | number' }
+    session: {
+      dataType: { id: 'string | number' },
+      dataResponsePointer: '/'
+    }
   },
 
   refresh: {
@@ -82,7 +85,10 @@ const defaultsByBackend: {
       signInResponseRefreshTokenPointer: '/refreshToken',
       maxAgeInSeconds: 60 * 60 * 24 * 7 // 7 days
     },
-    sessionDataType: { id: 'string | number' }
+    session: {
+      dataType: { id: 'string | number' },
+      dataResponsePointer: '/'
+    }
   },
 
   authjs: {
@@ -198,7 +204,7 @@ export default defineNuxtModule<ModuleOptions>({
           options.provider.type === 'local'
             ? genInterface(
               'SessionData',
-              (options.provider as any).sessionDataType
+              (options.provider.session as any).dataType
             )
             : '',
           '}'

src/runtime/composables/local/useAuth.ts

@@ -25,7 +25,7 @@ const signIn: SignInFunc<Credentials, any> = async (credentials, signInOptions,
     params: signInParams ?? {}
   })
 
-  const extractedToken = jsonPointerGet(response, config.token.signInResponseTokenPointer)
+  const extractedToken = jsonPointerGet<string>(response, config.token.signInResponseTokenPointer)
   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)}`)
     return
@@ -84,8 +84,14 @@ const getSession: GetSessionFunc<SessionData | null | void> = async (getSessionO
 
   loading.value = true
   try {
-    data.value = await _fetch<SessionData>(nuxt, path, { method, headers })
-  } catch {
+    const result = await _fetch<any>(nuxt, path, { method, headers })
+    const { dataResponsePointer: sessionDataResponsePointer } = config.session
+    data.value = jsonPointerGet<SessionData>(result, sessionDataResponsePointer)
+  } catch (err) {
+    if (!data.value && err instanceof Error) {
+      console.error(`Session: unable to extract session, ${err.message}`)
+    }
+
     // Clear all data: Request failed so we must not be authenticated
     data.value = null
     rawToken.value = null

src/runtime/composables/refresh/useAuth.ts

@@ -32,7 +32,7 @@ const signIn: ReturnType<typeof useLocalAuth>['signIn'] = async (
     params: signInParams ?? {}
   })
 
-  const extractedToken = jsonPointerGet(
+  const extractedToken = jsonPointerGet<string>(
     response,
     config.token.signInResponseTokenPointer
   )
@@ -47,7 +47,7 @@ const signIn: ReturnType<typeof useLocalAuth>['signIn'] = async (
     return
   }
 
-  const extractedRefreshToken = jsonPointerGet(
+  const extractedRefreshToken = jsonPointerGet<string>(
     response,
     config.refreshToken.signInResponseRefreshTokenPointer
   )
@@ -96,7 +96,7 @@ const refresh = async () => {
     }
   })
 
-  const extractedToken = jsonPointerGet(
+  const extractedToken = jsonPointerGet<string>(
     response,
     config.token.signInResponseTokenPointer
   )
@@ -112,7 +112,7 @@ const refresh = async () => {
   }
 
   if (!config.refreshOnlyToken) {
-    const extractedRefreshToken = jsonPointerGet(
+    const extractedRefreshToken = jsonPointerGet<string>(
       response,
       config.refreshToken.signInResponseRefreshTokenPointer
     )

src/runtime/helpers.ts

@@ -49,10 +49,15 @@ export const useTypedBackendConfig = <T extends SupportedAuthProviders>(
  * @param obj
  * @param pointer
  */
-export const jsonPointerGet = (
-  obj: Record<string, any>,
+export const jsonPointerGet = <TResult, T extends object = object>(
+  obj: T,
   pointer: string
-): string | Record<string, any> => {
+): TResult => {
+  let result = obj as unknown as TResult
+  if (pointer === '/') {
+    return result
+  }
+
   const unescape = (str: string) => str.replace(/~1/g, '/').replace(/~0/g, '~')
   const parse = (pointer: string) => {
     if (pointer === '') {
@@ -68,10 +73,11 @@ export const jsonPointerGet = (
 
   for (let i = 0; i < refTokens.length; ++i) {
     const tok = refTokens[i]
-    if (!(typeof obj === 'object' && tok in obj)) {
+    if (!(typeof result === 'object' && result && tok in result)) {
       throw new Error('Invalid reference token: ' + tok)
     }
-    obj = obj[tok]
+    result = (result as any)[tok]
   }
-  return obj
+
+  return result
 }

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

@@ -27,7 +27,7 @@ export default defineNuxtPlugin({
         headers
       })
 
-      const extractedToken = jsonPointerGet(
+      const extractedToken = jsonPointerGet<string>(
         response,
         config.provider.token.signInResponseTokenPointer
       )
@@ -44,7 +44,7 @@ export default defineNuxtPlugin({
 
       // check if refereshTokenOnly
       if (!configToken.refreshOnlyToken) {
-        const extractedRefreshToken = jsonPointerGet(
+        const extractedRefreshToken = jsonPointerGet<string>(
           response,
           config.provider.refreshToken.signInResponseRefreshTokenPointer
         )

src/runtime/types.ts

@@ -162,13 +162,30 @@ type ProviderLocal = {
     sameSiteAttribute?: boolean | 'lax' | 'strict' | 'none' | undefined;
   };
   /**
-   * Define an interface for the session data object that `nuxt-auth` expects to receive from the `getSession` endpoint.
-   *
-   * @default { id: 'string | number' }
-   * @example { id: 'string', name: 'string', email: 'string' }
-   * @advanced_array_example { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" }
+   * Settings for the session-data that `nuxt-auth` receives from the `getSession` endpoint.
    */
-  sessionDataType?: SessionDataObject;
+  session?: {
+    /*
+     * Define an interface for the session data object that `nuxt-auth` expects to receive from the `getSession` endpoint.
+     *
+     * @default { id: 'string | number' }
+     * @example { id: 'string', name: 'string', email: 'string' }
+     * @advanced_array_example { id: 'string', email: 'string', name: 'string', role: 'admin | guest | account', subscriptions: "{ id: number, status: 'ACTIVE' | 'INACTIVE' }[]" }
+     */
+    dataType?: SessionDataObject;
+    /**
+     * How to extract the session-data from the session response.
+     *
+     * E.g., setting this to `/data/user` and returning an object like `{ data: { user: { id:number, name: string } }, status: 'ok' }` from the `getSession` endpoint will
+     * storing the 'User' object typed as the type created via the 'dataType' prop.
+     *
+     * This follows the JSON Pointer standard, see it's RFC6901 here: https://www.rfc-editor.org/rfc/rfc6901
+     *
+     * @default / Access the root of the session response object
+     * @example /data/user  Access the `data/user` property of the session response object
+     */
+    dataResponsePointer?: string;
+  };
 };
 
 /**