nuxt-auth-utils 0.0.21 → 0.0.22

package/README.md

@@ -23,30 +23,13 @@ This module only works with SSR (server-side rendering) enabled as it uses serve
 
 ## Quick Setup
 
-1. Add `nuxt-auth-utils` dependency to your project
+1. Add `nuxt-auth-utils` in your Nuxt project
 
 ```bash
-# Using pnpm
-pnpm add -D nuxt-auth-utils
-
-# Using yarn
-yarn add --dev nuxt-auth-utils
-
-# Using npm
-npm install --save-dev nuxt-auth-utils
-```
-
-2. Add `nuxt-auth-utils` to the `modules` section of `nuxt.config.ts`
-
-```js
-export default defineNuxtConfig({
-  modules: [
-    'nuxt-auth-utils'
-  ]
-})
+npx nuxi@latest module add auth-utils
 ```
 
-3. Add a `NUXT_SESSION_PASSWORD` env variable with at least 32 characters in the `.env`.
+2. Add a `NUXT_SESSION_PASSWORD` env variable with at least 32 characters in the `.env`.
 
 ```bash
 # .env
@@ -57,7 +40,6 @@ Nuxt Auth Utils generates one for you when running Nuxt in development the first
 
 3. That's it! You can now add authentication to your Nuxt app ✨
 
-
 ## Vue Composables
 
 Nuxt Auth Utils automatically adds some plugins to fetch the current user session to let you access it from your Vue components.
@@ -116,6 +98,7 @@ const session = await requireUserSession(event)
 You can define the type for your user session by creating a type declaration file (for example, `auth.d.ts`) in your project to augment the `UserSession` type:
 
 ```ts
+// auth.d.ts
 declare module '#auth-utils' {
   interface User {
     // Add your own fields
@@ -222,6 +205,37 @@ export default defineNitroPlugin(() => {
 })
 ```
 
+## Configuration
+
+We leverage `runtimeConfig.session` to give the defaults option to [h3 `useSession`](https://h3.unjs.io/examples/handle-session).
+
+You can overwrite the options in your `nuxt.config.ts`:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['nuxt-auth-utils'],
+  runtimeConfig: {
+    session: {
+      maxAge: 60 * 60 * 24 * 7 // 1 week
+    }
+  }
+})
+```
+
+Our defaults are:
+
+```ts
+{
+  name: 'nuxt-session',
+  password: process.env.NUXT_SESSION_PASSWORD || '',
+  cookie: {
+    sameSite: 'lax'
+  }
+}
+```
+
+Checkout the [`SessionConfig`](https://github.com/unjs/h3/blob/c04c458810e34eb15c1647e1369e7d7ef19f567d/src/utils/session.ts#L20) for all options.
+
 ## Development
 
 ```bash

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.0.21"
+  "version": "0.0.22"
 }

package/dist/runtime/server/api/session.get.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<UserSessionRequired>>;
 export default _default;

package/dist/runtime/server/lib/oauth/microsoft.d.ts

@@ -44,6 +44,12 @@ export interface OAuthMicrosoftConfig {
      * @see https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
      */
     authorizationParams?: Record<string, string>;
+    /**
+     * Redirect URL to prevent in prod prevent redirect_uri mismatch http to https
+     * @default process.env.NUXT_OAUTH_MICROSOFT_REDIRECT_URL
+     * @see https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
+     */
+    redirectUrl?: string;
 }
 interface OAuthConfig {
     config?: OAuthMicrosoftConfig;

package/dist/runtime/server/lib/oauth/microsoft.mjs

@@ -20,7 +20,7 @@ export function microsoftEventHandler({ config, onSuccess, onError }) {
     }
     const authorizationURL = config.authorizationURL || `https://login.microsoftonline.com/${config.tenant}/oauth2/v2.0/authorize`;
     const tokenURL = config.tokenURL || `https://login.microsoftonline.com/${config.tenant}/oauth2/v2.0/token`;
-    const redirectUrl = getRequestURL(event).href;
+    const redirectUrl = config.redirectUrl || getRequestURL(event).href;
     if (!code) {
       const scope = config.scope && config.scope.length > 0 ? config.scope : ["User.Read"];
       return sendRedirect(

package/dist/runtime/server/utils/session.d.ts

@@ -1,12 +1,12 @@
 import type { H3Event } from 'h3';
-import type { User, UserSession } from '#auth-utils';
+import type { UserSession, UserSessionRequired } from '#auth-utils';
 export interface SessionHooks {
     /**
      * Called when fetching the session from the API
      * - Add extra properties to the session
      * - Throw an error if the session could not be verified (with a database for example)
      */
-    'fetch': (session: UserSession, event: H3Event) => void | Promise<void>;
+    'fetch': (session: UserSessionRequired, event: H3Event) => void | Promise<void>;
     /**
      * Called before clearing the session
      */
@@ -27,6 +27,4 @@ export declare function setUserSession(event: H3Event, data: UserSession): Promi
  */
 export declare function replaceUserSession(event: H3Event, data: UserSession): Promise<UserSession>;
 export declare function clearUserSession(event: H3Event): Promise<boolean>;
-export declare function requireUserSession(event: H3Event): Promise<UserSession & {
-    user: User;
-}>;
+export declare function requireUserSession(event: H3Event): Promise<UserSessionRequired>;

package/dist/runtime/types/index.d.ts

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

package/dist/runtime/types/session.d.ts

@@ -4,6 +4,9 @@ export interface User {
 export interface UserSession {
     user?: User;
 }
+export interface UserSessionRequired extends UserSession {
+    user: User;
+}
 export interface UserSessionComposable {
     loggedIn: ComputedRef<boolean>;
     user: ComputedRef<User | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",