nuxt-auth-utils 0.0.10 → 0.0.11

package/README.md

@@ -188,6 +188,25 @@ export default oauth.githubEventHandler({
 
 Make sure to set the callback URL in your OAuth app settings as `<your-domain>/auth/github`.
 
+### Extend Session
+
+We leverage hooks to let you extend the session data with your own data or to log when the user clear its session.
+
+```ts
+// server/plugins/session.ts
+export default defineNitroPlugin(() => {
+  sessionHooks.hook('verify', async (session, event) => {
+    // extend User Session by calling your database
+    // or
+    // throw createError({ ... }) if session is invalid for example
+  })
+
+  sessionHooks.hook('clear', async (session, event) => {
+    // Log that user logged out
+  })
+})
+```
+
 ## Development
 
 ```bash

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.0.10"
+  "version": "0.0.11"
 }

package/dist/module.mjs

@@ -30,6 +30,7 @@ const module = defineNuxtModule({
           {
             from: resolver.resolve("./runtime/server/utils/session"),
             imports: [
+              "sessionHooks",
               "getUserSession",
               "setUserSession",
               "clearUserSession",

package/dist/runtime/server/api/session.get.mjs

@@ -1,5 +1,7 @@
 import { eventHandler } from "h3";
-import { requireUserSession } from "../utils/session.mjs";
+import { requireUserSession, sessionHooks } from "../utils/session.mjs";
 export default eventHandler(async (event) => {
-  return await requireUserSession(event);
+  const session = await requireUserSession(event);
+  await sessionHooks.callHookParallel("verify", event, session);
+  return session;
 });

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

@@ -1,5 +1,18 @@
 import type { H3Event } from 'h3';
 import type { UserSession } 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)
+     */
+    'verify': (session: UserSession, event: H3Event) => void | Promise<void>;
+    /**
+     * Called before clearing the session
+     */
+    'clear': (session: UserSession, event: H3Event) => void | Promise<void>;
+}
+export declare const sessionHooks: import("hookable").Hookable<SessionHooks, import("hookable").HookKeys<SessionHooks>>;
 export declare function getUserSession(event: H3Event): Promise<UserSession>;
 /**
  * Set a user session

package/dist/runtime/server/utils/session.mjs

@@ -1,6 +1,8 @@
 import { useSession, createError } from "h3";
 import { defu } from "defu";
+import { createHooks } from "hookable";
 import { useRuntimeConfig } from "#imports";
+export const sessionHooks = createHooks();
 export async function getUserSession(event) {
   return (await _useSession(event)).data;
 }
@@ -11,6 +13,7 @@ export async function setUserSession(event, data) {
 }
 export async function clearUserSession(event) {
   const session = await _useSession(event);
+  await sessionHooks.callHookParallel("clear", event, session);
   await session.clear();
   return true;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -32,6 +32,7 @@
   "dependencies": {
     "@nuxt/kit": "^3.8.2",
     "defu": "^6.1.3",
+    "hookable": "^5.5.3",
     "ofetch": "^1.3.3",
     "ohash": "^1.1.3"
   },