nuxt-auth-utils 0.0.9 → 0.0.11

package/README.md

@@ -154,6 +154,7 @@ It can also be set using environment variables:
 - Discord
 - GitHub
 - Google
+- LinkedIn
 - Microsoft
 - Spotify
 - Twitch
@@ -187,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.9"
+  "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",
@@ -77,7 +78,8 @@ const module = defineNuxtModule({
     runtimeConfig.oauth.auth0 = defu(runtimeConfig.oauth.auth0, {
       clientId: "",
       clientSecret: "",
-      domain: ""
+      domain: "",
+      audience: ""
     });
     runtimeConfig.oauth.microsoft = defu(runtimeConfig.oauth.microsoft, {
       clientId: "",
@@ -96,6 +98,10 @@ const module = defineNuxtModule({
       clientId: "",
       clientSecret: ""
     });
+    runtimeConfig.oauth.linkedin = defu(runtimeConfig.oauth.linkedin, {
+      clientId: "",
+      clientSecret: ""
+    });
   }
 });
 

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/lib/oauth/linkedin.d.ts

@@ -0,0 +1,44 @@
+import type { H3Event, H3Error } from 'h3';
+export interface OAuthLinkedInConfig {
+    /**
+     * LinkedIn OAuth Client ID
+     * @default process.env.NUXT_OAUTH_LINKEDIN_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * LinkedIn OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_LINKEDIN_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * LinkedIn OAuth Scope
+     * @default ['openid', 'profile', 'email']
+     * @example ['openid', 'profile']
+     */
+    scope?: string[];
+    /**
+     * Require email from user, adds the ['email'] scope if not present
+     * @default false
+     */
+    emailRequired?: boolean;
+    /**
+     * LinkedIn OAuth Authorization URL
+     * @default 'https://www.linkedin.com/oauth/v2/authorization'
+     */
+    authorizationURL?: string;
+    /**
+     * LinkedIn OAuth Token URL
+     * @default 'https://www.linkedin.com/oauth/v2/accessToken'
+     */
+    tokenURL?: string;
+}
+interface OAuthConfig {
+    config?: OAuthLinkedInConfig;
+    onSuccess: (event: H3Event, result: {
+        user: any;
+        tokens: any;
+    }) => Promise<void> | void;
+    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
+}
+export declare function linkedinEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export {};

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

@@ -0,0 +1,83 @@
+import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from "h3";
+import { withQuery, parseURL, stringifyParsedURL } from "ufo";
+import { ofetch } from "ofetch";
+import { defu } from "defu";
+import { useRuntimeConfig } from "#imports";
+export function linkedinEventHandler({ config, onSuccess, onError }) {
+  return eventHandler(async (event) => {
+    config = defu(config, useRuntimeConfig(event).oauth?.linkedin, {
+      authorizationURL: "https://www.linkedin.com/oauth/v2/authorization",
+      tokenURL: "https://www.linkedin.com/oauth/v2/accessToken"
+    });
+    const { code } = getQuery(event);
+    if (!config.clientId || !config.clientSecret) {
+      const error = createError({
+        statusCode: 500,
+        message: "Missing NUXT_OAUTH_LINKEDIN_CLIENT_ID or NUXT_OAUTH_LINKEDIN_CLIENT_SECRET env variables."
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    const redirectUrl = getRequestURL(event).href;
+    if (!code) {
+      config.scope = config.scope || [];
+      if (!config.scope.length) {
+        config.scope.push("profile", "openid", "email");
+      }
+      if (config.emailRequired && !config.scope.includes("email")) {
+        config.scope.push("email");
+      }
+      return sendRedirect(
+        event,
+        withQuery(config.authorizationURL, {
+          response_type: "code",
+          client_id: config.clientId,
+          redirect_uri: redirectUrl,
+          scope: config.scope.join(" ")
+        })
+      );
+    }
+    const parsedRedirectUrl = parseURL(redirectUrl);
+    parsedRedirectUrl.search = "";
+    const tokens = await ofetch(
+      config.tokenURL,
+      {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded"
+        },
+        body: new URLSearchParams({
+          grant_type: "authorization_code",
+          code,
+          client_id: config.clientId,
+          client_secret: config.clientSecret,
+          redirect_uri: stringifyParsedURL(parsedRedirectUrl)
+        }).toString()
+      }
+    ).catch((error) => {
+      return { error };
+    });
+    if (tokens.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `LinkedIn login failed: ${tokens.error?.data?.error_description || "Unknown error"}`,
+        data: tokens
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    const accessToken = tokens.access_token;
+    const user = await ofetch("https://api.linkedin.com/v2/userinfo", {
+      headers: {
+        "user-agent": "Nuxt Auth Utils",
+        Authorization: `Bearer ${accessToken}`
+      }
+    });
+    return onSuccess(event, {
+      tokens,
+      user
+    });
+  });
+}

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

@@ -6,6 +6,7 @@ import { auth0EventHandler } from '../lib/oauth/auth0';
 import { microsoftEventHandler } from '../lib/oauth/microsoft';
 import { discordEventHandler } from '../lib/oauth/discord';
 import { battledotnetEventHandler } from '../lib/oauth/battledotnet';
+import { linkedinEventHandler } from '../lib/oauth/linkedin';
 export declare const oauth: {
     githubEventHandler: typeof githubEventHandler;
     spotifyEventHandler: typeof spotifyEventHandler;
@@ -15,4 +16,5 @@ export declare const oauth: {
     microsoftEventHandler: typeof microsoftEventHandler;
     discordEventHandler: typeof discordEventHandler;
     battledotnetEventHandler: typeof battledotnetEventHandler;
+    linkedinEventHandler: typeof linkedinEventHandler;
 };

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

@@ -6,6 +6,7 @@ import { auth0EventHandler } from "../lib/oauth/auth0.mjs";
 import { microsoftEventHandler } from "../lib/oauth/microsoft.mjs";
 import { discordEventHandler } from "../lib/oauth/discord.mjs";
 import { battledotnetEventHandler } from "../lib/oauth/battledotnet.mjs";
+import { linkedinEventHandler } from "../lib/oauth/linkedin.mjs";
 export const oauth = {
   githubEventHandler,
   spotifyEventHandler,
@@ -14,5 +15,6 @@ export const oauth = {
   auth0EventHandler,
   microsoftEventHandler,
   discordEventHandler,
-  battledotnetEventHandler
+  battledotnetEventHandler,
+  linkedinEventHandler
 };

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.9",
+  "version": "0.0.11",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -32,24 +32,25 @@
   "dependencies": {
     "@nuxt/kit": "^3.8.2",
     "defu": "^6.1.3",
+    "hookable": "^5.5.3",
     "ofetch": "^1.3.3",
     "ohash": "^1.1.3"
   },
   "devDependencies": {
-    "@iconify-json/simple-icons": "^1.1.79",
+    "@iconify-json/simple-icons": "^1.1.82",
     "@nuxt/devtools": "latest",
     "@nuxt/eslint-config": "^0.2.0",
     "@nuxt/module-builder": "^0.5.4",
     "@nuxt/schema": "^3.8.2",
     "@nuxt/test-utils": "^3.8.1",
-    "@nuxt/ui": "^2.10.0",
-    "@nuxt/ui-pro": "^0.4.2",
-    "@types/node": "^20.9.3",
+    "@nuxt/ui": "^2.11.0",
+    "@nuxt/ui-pro": "^0.5.0",
+    "@types/node": "^20.10.4",
     "changelogen": "^0.5.5",
-    "eslint": "^8.54.0",
+    "eslint": "^8.55.0",
     "nuxt": "^3.8.2",
-    "typescript": "^5.3.2",
-    "vitest": "^0.34.6",
-    "vue-tsc": "^1.8.22"
+    "typescript": "^5.3.3",
+    "vitest": "^1.0.2",
+    "vue-tsc": "^1.8.25"
   }
 }