nuxt-auth-utils 0.0.8 → 0.0.10

package/README.md

@@ -150,12 +150,14 @@ It can also be set using environment variables:
 #### Supported OAuth Providers
 
 - Auth0
+- Battle.net
 - Discord
 - GitHub
 - Google
+- LinkedIn
+- Microsoft
 - Spotify
 - Twitch
-- Battle.net
 
 You can add your favorite provider by creating a new file in [src/runtime/server/lib/oauth/](./src/runtime/server/lib/oauth/).
 

package/dist/module.json

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

package/dist/module.mjs

@@ -77,7 +77,17 @@ const module = defineNuxtModule({
     runtimeConfig.oauth.auth0 = defu(runtimeConfig.oauth.auth0, {
       clientId: "",
       clientSecret: "",
-      domain: ""
+      domain: "",
+      audience: ""
+    });
+    runtimeConfig.oauth.microsoft = defu(runtimeConfig.oauth.microsoft, {
+      clientId: "",
+      clientSecret: "",
+      tenant: "",
+      scope: [],
+      authorizationURL: "",
+      tokenURL: "",
+      userURL: ""
     });
     runtimeConfig.oauth.discord = defu(runtimeConfig.oauth.discord, {
       clientId: "",
@@ -87,6 +97,10 @@ const module = defineNuxtModule({
       clientId: "",
       clientSecret: ""
     });
+    runtimeConfig.oauth.linkedin = defu(runtimeConfig.oauth.linkedin, {
+      clientId: "",
+      clientSecret: ""
+    });
   }
 });
 

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

@@ -32,5 +32,11 @@ export interface OAuthAuth0Config {
      * @default false
      */
     emailRequired?: boolean;
+    /**
+     * Maximum Authentication Age. If the elapsed time is greater than this value, the OP must attempt to actively re-authenticate the end-user.
+     * @default 0
+     * @see https://auth0.com/docs/authenticate/login/max-age-reauthentication
+     */
+    maxAge?: number;
 }
 export declare function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthAuth0Config>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -31,7 +31,8 @@ export function auth0EventHandler({ config, onSuccess, onError }) {
           client_id: config.clientId,
           redirect_uri: redirectUrl,
           scope: config.scope.join(" "),
-          audience: config.audience || ""
+          audience: config.audience || "",
+          max_age: config.maxAge || 0
         })
       );
     }

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

@@ -60,7 +60,6 @@ export function discordEventHandler({ config, onSuccess, onError }) {
       return { error };
     });
     if (tokens.error) {
-      console.log(tokens);
       const error = createError({
         statusCode: 401,
         message: `Discord login failed: ${tokens.error?.data?.error_description || "Unknown error"}`,

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

@@ -0,0 +1,52 @@
+import type { H3Event, H3Error } from 'h3';
+export interface OAuthMicrosoftConfig {
+    /**
+     * Microsoft OAuth Client ID
+     * @default process.env.NUXT_OAUTH_MICROSOFT_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * Microsoft  OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_MICROSOFT_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * Microsoft OAuth Tenant ID
+     * @default process.env.NUXT_OAUTH_MICROSOFT_TENANT
+     */
+    tenant?: string;
+    /**
+     * Microsoft  OAuth Scope
+     * @default ['User.Read']
+     * @see https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc
+     */
+    scope?: string[];
+    /**
+     * Microsoft OAuth Authorization URL
+     * @default https://login.microsoftonline.com/${tenant}/oauth2/v2.0/authorize
+     * @see https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
+     */
+    authorizationURL?: string;
+    /**
+     * Microsoft OAuth Token URL
+     * @default https://login.microsoftonline.com/${tenant}/oauth2/v2.0/token
+     * @see https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
+     */
+    tokenURL?: string;
+    /**
+     * Microsoft OAuth User URL
+     * @default https://graph.microsoft.com/v1.0/me
+     * @see https://docs.microsoft.com/en-us/graph/api/user-get?view=graph-rest-1.0&tabs=http
+     */
+    userURL?: string;
+}
+interface OAuthConfig {
+    config?: OAuthMicrosoftConfig;
+    onSuccess: (event: H3Event, result: {
+        user: any;
+        tokens: any;
+    }) => Promise<void> | void;
+    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
+}
+export declare function microsoftEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export {};

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

@@ -0,0 +1,87 @@
+import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from "h3";
+import { withQuery, parsePath } from "ufo";
+import { ofetch } from "ofetch";
+import { defu } from "defu";
+import { useRuntimeConfig } from "#imports";
+export function microsoftEventHandler({ config, onSuccess, onError }) {
+  return eventHandler(async (event) => {
+    config = defu(config, useRuntimeConfig(event).oauth?.microsoft);
+    const { code } = getQuery(event);
+    if (!config.clientId || !config.clientSecret || !config.tenant) {
+      const error = createError({
+        statusCode: 500,
+        message: "Missing NUXT_OAUTH_MICROSOFT_CLIENT_ID or NUXT_OAUTH_MICROSOFT_CLIENT_SECRET or NUXT_OAUTH_MICROSOFT_TENANT env variables."
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    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;
+    if (!code) {
+      const scope = config.scope && config.scope.length > 0 ? config.scope : ["User.Read"];
+      return sendRedirect(
+        event,
+        withQuery(authorizationURL, {
+          client_id: config.clientId,
+          response_type: "code",
+          redirect_uri: redirectUrl,
+          scope: scope.join("%20")
+        })
+      );
+    }
+    const data = new URLSearchParams();
+    data.append("grant_type", "authorization_code");
+    data.append("client_id", config.clientId);
+    data.append("client_secret", config.clientSecret);
+    data.append("redirect_uri", parsePath(redirectUrl).pathname);
+    data.append("code", String(code));
+    const tokens = await ofetch(
+      tokenURL,
+      {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded"
+        },
+        body: data
+      }
+    ).catch((error) => {
+      return { error };
+    });
+    if (tokens.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `Microsoft login failed: ${tokens.error?.data?.error_description || "Unknown error"}`,
+        data: tokens
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    const tokenType = tokens.token_type;
+    const accessToken = tokens.access_token;
+    const userURL = config.userURL || "https://graph.microsoft.com/v1.0/me";
+    const user = await ofetch(userURL, {
+      headers: {
+        Authorization: `${tokenType} ${accessToken}`
+      }
+    }).catch((error) => {
+      return { error };
+    });
+    if (user.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `Microsoft login failed: ${user.error || "Unknown error"}`,
+        data: user
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    return onSuccess(event, {
+      tokens,
+      user
+    });
+  });
+}

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

@@ -3,14 +3,18 @@ import { googleEventHandler } from '../lib/oauth/google';
 import { spotifyEventHandler } from '../lib/oauth/spotify';
 import { twitchEventHandler } from '../lib/oauth/twitch';
 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;
     googleEventHandler: typeof googleEventHandler;
     twitchEventHandler: typeof twitchEventHandler;
     auth0EventHandler: typeof auth0EventHandler;
+    microsoftEventHandler: typeof microsoftEventHandler;
     discordEventHandler: typeof discordEventHandler;
     battledotnetEventHandler: typeof battledotnetEventHandler;
+    linkedinEventHandler: typeof linkedinEventHandler;
 };

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

@@ -3,14 +3,18 @@ import { googleEventHandler } from "../lib/oauth/google.mjs";
 import { spotifyEventHandler } from "../lib/oauth/spotify.mjs";
 import { twitchEventHandler } from "../lib/oauth/twitch.mjs";
 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,
   googleEventHandler,
   twitchEventHandler,
   auth0EventHandler,
+  microsoftEventHandler,
   discordEventHandler,
-  battledotnetEventHandler
+  battledotnetEventHandler,
+  linkedinEventHandler
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -36,20 +36,20 @@
     "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"
   }
 }