fix: user session types (#55)

* feat: create User interface for module augmentation

* fix: user is no longer possibly undefined when using `requireUserSession`

* chore: update docs

* fix: explicitly define returntypes

* up

---------

Co-authored-by: Sébastien Chopin <seb@nuxt.com>

Author: Gerbuuun

src/runtime/composables/session.ts

@@ -1,9 +1,9 @@
 import { useState, computed, useRequestFetch } from '#imports'
-import type { UserSession } from '#auth-utils'
+import type { UserSession, UserSessionComposable } from '#auth-utils'
 
 const useSessionState = () => useState<UserSession>('nuxt-session', () => ({}))
 
-export const useUserSession = () => {
+export function useUserSession(): UserSessionComposable  {
   const sessionState = useSessionState()
   return {
     loggedIn: computed(() => Boolean(sessionState.value.user)),

src/runtime/server/utils/session.ts

@@ -59,7 +59,7 @@ export async function clearUserSession (event: H3Event) {
   return true
 }
 
-export async function requireUserSession(event: H3Event) {
+export async function requireUserSession(event: H3Event): Promise<UserSession & { user: User }> {
   const userSession = await getUserSession(event)
 
   if (!userSession.user) {

src/runtime/types/index.ts

@@ -1,2 +1,2 @@
-export type { UserSession, User } from './session'
+export type { User, UserSession, UserSessionComposable } from './session'
 export type { OAuthConfig } from './oauth-config'

src/runtime/types/session.ts

@@ -1,6 +1,16 @@
+import type { ComputedRef, Ref } from 'vue'
+
 export interface User {
 }
 
 export interface UserSession {
   user?: User
 }
+
+export interface UserSessionComposable {
+  loggedIn: ComputedRef<boolean>
+  user: ComputedRef<User | null>
+  session: Ref<UserSession>,
+  fetch: () => Promise<void>,
+  clear: () => Promise<void>
+}