feat(#854): Add getServerSession and getToken to the local provider

playground-local/app.vue

@@ -41,9 +41,23 @@ const password = ref('')
       refresh session (required: true)
     </button>
     <br>
-    <NuxtLink to="/login">
-      navigate to Login Page
-    </NuxtLink>
+    <h2>Navigation</h2>
+    <p>Navigate to different pages below to test out different things:</p>
+    <div>
+      <nuxt-link to="/api/protected/inline" external>
+        -> API endpoint protected inline
+      </nuxt-link>
+      <br>
+      <nuxt-link to="/api/protected/middleware" external>
+        -> API endpoint protected middleware
+      </nuxt-link>
+      <br>
+      <NuxtLink to="/login">
+        -> navigate to Login Page
+      </NuxtLink>
+      <br>
+    </div>
+    <br>
     <NuxtPage />
   </div>
 </template>

playground-local/server/api/protected/inline.ts

@@ -0,0 +1,10 @@
+import { eventHandler } from 'h3'
+import { getServerSession } from '#auth'
+
+export default eventHandler(async (event) => {
+  const session = await getServerSession(event)
+  if (!session) {
+    return { status: 'unauthenticated!' }
+  }
+  return { status: 'authenticated!', text: 'im protected by an in-endpoint check', session }
+})

playground-local/server/api/protected/middleware.ts

@@ -0,0 +1,3 @@
+import { eventHandler } from 'h3'
+
+export default eventHandler(() => ({ status: 'authenticated', text: 'you only see me if you are logged in, as a server-middleware protects me' }))

playground-local/server/api/session.get.ts

@@ -0,0 +1,4 @@
+import { defineEventHandler } from 'h3'
+import { getServerSession } from '#auth'
+
+export default defineEventHandler(event => getServerSession(event))

playground-local/server/api/token.get.ts

@@ -0,0 +1,4 @@
+import { defineEventHandler } from 'h3'
+import { getToken } from '#auth'
+
+export default defineEventHandler(event => getToken(event))

playground-local/server/middleware/auth.ts

@@ -0,0 +1,14 @@
+import { createError, eventHandler } from 'h3'
+import { getServerSession } from '#auth'
+
+export default eventHandler(async (event) => {
+  // Only protect a certain backend route
+  if (!event.node.req.url?.startsWith('/api/protected/middleware')) {
+    return
+  }
+
+  const session = await getServerSession(event)
+  if (!session) {
+    throw createError({ statusMessage: 'Unauthenticated', statusCode: 403 })
+  }
+})

src/module.ts

@@ -12,7 +12,6 @@ import {
 } from '@nuxt/kit'
 import { defu } from 'defu'
 import { joinURL } from 'ufo'
-import { genInterface } from 'knitwork'
 import type { DeepRequired } from 'ts-essentials'
 import type { NuxtModule } from 'nuxt/schema'
 import { getOriginAndPathnameFromURL, isProduction } from './runtime/helpers'
@@ -23,6 +22,7 @@ import type {
   RefreshHandler,
   SupportedAuthProviders
 } from './runtime/types'
+import { generateModuleTypes } from './runtime/utils/generateTypes'
 
 const topLevelDefaults = {
   isEnabled: true,
@@ -101,7 +101,10 @@ const PACKAGE_NAME = 'sidebase-auth'
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: PACKAGE_NAME,
-    configKey: 'auth'
+    configKey: 'auth',
+    compatibility: {
+      nuxt: '>=3.0.0'
+    }
   },
   setup(userOptions, nuxt) {
     const logger = useLogger(PACKAGE_NAME)
@@ -178,26 +181,13 @@ export default defineNuxtModule<ModuleOptions>({
           inline: [resolve('./runtime')]
         }
       )
-      nitroConfig.alias['#auth'] = resolve('./runtime/server/services')
+
+      nitroConfig.alias['#auth'] = resolve(`./runtime/server/services/${options.provider.type}`)
     })
 
     addTypeTemplate({
       filename: 'types/auth.d.ts',
-      getContents: () =>
-        [
-          '// AUTO-GENERATED BY @sidebase/nuxt-auth',
-          'declare module \'#auth\' {',
-          `  const { getServerSession, getToken, NuxtAuthHandler }: typeof import('${resolve('./runtime/server/services')}')`,
-          ...(options.provider.type === 'local'
-            ? [genInterface(
-                'SessionData',
-                (options.provider as any).session.dataType
-              )]
-            : []
-          ),
-          '}',
-          ''
-        ].join('\n')
+      getContents: () => generateModuleTypes(options.provider)
     })
 
     addTypeTemplate({

src/runtime/server/services/authjs/index.ts

@@ -0,0 +1 @@
+export { NuxtAuthHandler, getServerSession, getToken } from './nuxtAuthHandler'

src/runtime/server/services/local/getServerSession.ts

@@ -0,0 +1,51 @@
+import { type H3Event, createError } from 'h3'
+import getURL from 'requrl'
+import { joinURL } from 'ufo'
+import { jsonPointerGet, useTypedBackendConfig } from '../../../helpers'
+import { getToken } from './getToken'
+
+// @ts-expect-error - #auth not defined
+import type { SessionData } from '#auth'
+import { useRuntimeConfig } from '#imports'
+
+function joinPathToApiURL(event: H3Event, path: string) {
+  const { origin, pathname, fullBaseUrl } = useRuntimeConfig().public.auth.computed
+
+  let baseURL
+  if (origin) {
+    // Case 1: An origin was supplied by the developer in the runtime-config. Use it by returning the already assembled full base url that contains it
+    baseURL = fullBaseUrl
+  }
+  else {
+    // Case 2: An origin was not supplied, we determine it from the request
+    const determinedOrigin = getURL(event.node.req, false)
+    baseURL = joinURL(determinedOrigin, pathname)
+  }
+
+  const base = path.startsWith('/') ? pathname : baseURL
+  return joinURL(base, path)
+}
+
+export async function getServerSession(event: H3Event): Promise<SessionData | null> {
+  const token = getToken(event)
+  if (!token) {
+    return null
+  }
+
+  const config = useTypedBackendConfig(useRuntimeConfig(), 'local')
+  const { path, method } = config.endpoints.getSession
+
+  // Compose heads to request the session
+  const headers = new Headers({ [config.token.headerName]: token } as HeadersInit)
+
+  try {
+    const url = joinPathToApiURL(event, path)
+    const result = await $fetch<any>(url, { method, headers })
+    const { dataResponsePointer: sessionDataResponsePointer } = config.session
+    return jsonPointerGet<SessionData>(result, sessionDataResponsePointer)
+  }
+  catch (err) {
+    console.error(err)
+    throw createError({ statusCode: 401, statusMessage: 'Session could not be retrieved.' })
+  }
+}

src/runtime/server/services/local/getToken.ts

@@ -0,0 +1,15 @@
+import { type H3Event, getCookie } from 'h3'
+import { useTypedBackendConfig } from '../../../helpers'
+import { formatToken } from '../../../utils/local'
+import { useRuntimeConfig } from '#imports'
+
+export function getToken(event: H3Event) {
+  const config = useTypedBackendConfig(useRuntimeConfig(), 'local')
+  const rawToken = getCookie(event, config.token.cookieName)
+  const token = formatToken(rawToken, config)
+
+  if (!token) {
+    return null
+  }
+  return token
+}

src/runtime/server/services/local/index.ts

@@ -0,0 +1,2 @@
+export { getToken } from './getToken'
+export { getServerSession } from './getServerSession'

src/runtime/utils/generateTypes.ts

@@ -0,0 +1,26 @@
+import { genInterface } from 'knitwork'
+import { createResolver } from '@nuxt/kit'
+import type { AuthProviders } from '../types'
+
+export function generateModuleTypes(provider: AuthProviders) {
+  const { resolve } = createResolver(import.meta.url)
+
+  const providerSpecificTypes: string[] = []
+
+  if (provider.type === 'authjs') {
+    providerSpecificTypes.push(`  const { getServerSession, getToken, NuxtAuthHandler }: typeof import('${resolve('./runtime/server/services/authjs')}')`)
+  }
+
+  if (provider.type === 'local') {
+    providerSpecificTypes.push(`  const { getServerSession, getToken }: typeof import('${resolve('./runtime/server/services/local')}')`)
+    providerSpecificTypes.push(genInterface('SessionData', (provider as any).session.dataType))
+  }
+
+  return [
+    '// AUTO-GENERATED BY @sidebase/nuxt-auth',
+    `declare module '#auth' {`,
+    ...providerSpecificTypes,
+    '}',
+    ''
+  ].join('\n')
+}