nuxt-auth-utils 0.3.3 → 0.3.5

package/dist/runtime/server/lib/oauth/x.js

@@ -1,13 +1,13 @@
 import { randomUUID } from "node:crypto";
 import {
   eventHandler,
-  createError,
   getQuery,
   getRequestURL,
   sendRedirect
 } from "h3";
 import { withQuery, parsePath } from "ufo";
 import { defu } from "defu";
+import { handleAccessTokenErrorResponse, handleMissingConfiguration } from "../utils.js";
 import { useRuntimeConfig } from "#imports";
 export function oauthXEventHandler({
   config,
@@ -16,9 +16,9 @@ export function oauthXEventHandler({
 }) {
   return eventHandler(async (event) => {
     config = defu(config, useRuntimeConfig(event).oauth?.x, {
-      authorizationURL: "https://twitter.com/i/oauth2/authorize",
-      tokenURL: "https://api.twitter.com/2/oauth2/token",
-      userURL: "https://api.twitter.com/2/users/me",
+      authorizationURL: "https://x.com/i/oauth2/authorize",
+      tokenURL: "https://api.x.com/2/oauth2/token",
+      userURL: "https://api.x.com/2/users/me",
       authorizationParams: {
         state: randomUUID(),
         code_challenge: randomUUID()
@@ -26,14 +26,9 @@ export function oauthXEventHandler({
     });
     const { code } = getQuery(event);
     if (!config.clientId) {
-      const error = createError({
-        statusCode: 500,
-        message: "Missing NUXT_OAUTH_X_CLIENT_ID env variables."
-      });
-      if (!onError) throw error;
-      return onError(event, error);
+      return handleMissingConfiguration(event, "x", ["clientId"], onError);
     }
-    const redirectUrl = getRequestURL(event).href;
+    const redirectURL = config.redirectURL || getRequestURL(event).href;
     if (!code) {
       config.scope = config.scope || ["tweet.read", "users.read", "offline.access"];
       return sendRedirect(
@@ -42,7 +37,7 @@ export function oauthXEventHandler({
           response_type: "code",
           client_id: config.clientId,
           code_challenge_method: "plain",
-          redirect_uri: redirectUrl,
+          redirect_uri: redirectURL,
           scope: config.scope.join(" "),
           ...config.authorizationParams
         })
@@ -50,8 +45,8 @@ export function oauthXEventHandler({
     }
     const params = {
       grant_type: "authorization_code",
-      code_verifier: config.authorizationParams.code_challenge,
-      redirect_uri: parsePath(redirectUrl).pathname,
+      code_verifier: config.authorizationParams?.code_challenge,
+      redirect_uri: parsePath(redirectURL).pathname,
       code
     };
     const authCode = Buffer.from(`${config.clientId}:${config.clientSecret}`).toString("base64");
@@ -66,13 +61,7 @@ export function oauthXEventHandler({
       return { error };
     });
     if (tokens.error) {
-      const error = createError({
-        statusCode: 401,
-        message: `X login failed: ${tokens.error?.data?.error_description || "Unknown error"}`,
-        data: tokens
-      });
-      if (!onError) throw error;
-      return onError(event, error);
+      return handleAccessTokenErrorResponse(event, "x", tokens, onError);
     }
     const accessToken = tokens.access_token;
     const user = await $fetch(
@@ -88,29 +77,6 @@ export function oauthXEventHandler({
     ).catch((error) => {
       return error;
     });
-    if (config.emailRequired) {
-      const emailData = await $fetch("https://api.twitter.com/1.1/account/verify_credentials.json", {
-        headers: {
-          Authorization: `Bearer ${accessToken}`
-        },
-        query: {
-          include_email: "true",
-          skip_status: "true"
-        }
-      }).catch((error) => {
-        return error;
-      });
-      if (emailData && emailData.email) {
-        user.email = emailData.email;
-      } else {
-        const error = createError({
-          statusCode: 401,
-          message: "Twitter login failed: no user email found"
-        });
-        if (!onError) throw error;
-        return onError(event, error);
-      }
-    }
     return onSuccess(event, {
       tokens,
       user: user?.data

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

@@ -22,5 +22,10 @@ export interface OAuthXSUAAConfig {
      * @example ['openid']
      */
     scope?: string[];
+    /**
+     * Redirect URL to to allow overriding for situations like prod failing to determine public hostname
+     * @default process.env.NUXT_OAUTH_XSUAA_REDIRECT_URL or current URL
+     */
+    redirectURL?: string;
 }
 export declare function oauthXSUAAEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthXSUAAConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

package/dist/runtime/server/lib/oauth/xsuaa.js

@@ -1,22 +1,18 @@
-import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from "h3";
+import { eventHandler, getQuery, getRequestURL, sendRedirect } from "h3";
 import { withQuery, parsePath } from "ufo";
 import { defu } from "defu";
+import { handleAccessTokenErrorResponse, handleMissingConfiguration } from "../utils.js";
 import { useRuntimeConfig } from "#imports";
 export function oauthXSUAAEventHandler({ config, onSuccess, onError }) {
   return eventHandler(async (event) => {
     config = defu(config, useRuntimeConfig(event).oauth?.xsuaa);
     const { code } = getQuery(event);
     if (!config.clientId || !config.clientSecret || !config.domain) {
-      const error = createError({
-        statusCode: 500,
-        message: "Missing NUXT_OAUTH_XSUAA_CLIENT_ID or NUXT_OAUTH_XSUAA_CLIENT_SECRET or NUXT_OAUTH_XSUAA_DOMAIN env variables."
-      });
-      if (!onError) throw error;
-      return onError(event, error);
+      return handleMissingConfiguration(event, "xsuaa", ["clientId", "clientSecret", "domain"], onError);
     }
     const authorizationURL = `https://${config.domain}/oauth/authorize`;
     const tokenURL = `https://${config.domain}/oauth/token`;
-    const redirectUrl = getRequestURL(event).href;
+    const redirectURL = config.redirectURL || getRequestURL(event).href;
     if (!code) {
       config.scope = config.scope || [];
       return sendRedirect(
@@ -24,7 +20,7 @@ export function oauthXSUAAEventHandler({ config, onSuccess, onError }) {
         withQuery(authorizationURL, {
           response_type: "code",
           client_id: config.clientId,
-          redirect_uri: redirectUrl,
+          redirect_uri: redirectURL,
           scope: config.scope.join(" ")
         })
       );
@@ -40,7 +36,7 @@ export function oauthXSUAAEventHandler({ config, onSuccess, onError }) {
           grant_type: "authorization_code",
           client_id: config.clientId,
           client_secret: config.clientSecret,
-          redirect_uri: parsePath(redirectUrl).pathname,
+          redirect_uri: parsePath(redirectURL).pathname,
           code: `${code}`
         })
       }
@@ -48,13 +44,7 @@ export function oauthXSUAAEventHandler({ config, onSuccess, onError }) {
       return { error };
     });
     if (tokens.error) {
-      const error = createError({
-        statusCode: 401,
-        message: `XSUAA login failed: ${tokens.error?.data?.error_description || "Unknown error"}`,
-        data: tokens
-      });
-      if (!onError) throw error;
-      return onError(event, error);
+      return handleAccessTokenErrorResponse(event, "auth0", tokens, onError);
     }
     const tokenType = tokens.token_type;
     const accessToken = tokens.access_token;

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

@@ -37,5 +37,10 @@ export interface OAuthYandexConfig {
      * @default 'https://login.yandex.ru/info'
      */
     userURL?: string;
+    /**
+     * Redirect URL to to allow overriding for situations like prod failing to determine public hostname
+     * @default process.env.NUXT_OAUTH_YANDEX_REDIRECT_URL or current URL
+     */
+    redirectURL?: string;
 }
 export declare function oauthYandexEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthYandexConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

package/dist/runtime/server/lib/oauth/yandex.js

@@ -1,12 +1,12 @@
 import {
   eventHandler,
-  createError,
   getQuery,
   getRequestURL,
   sendRedirect
 } from "h3";
 import { withQuery, parseURL, stringifyParsedURL } from "ufo";
 import { defu } from "defu";
+import { handleAccessTokenErrorResponse, handleMissingConfiguration } from "../utils.js";
 import { useRuntimeConfig } from "#imports";
 export function oauthYandexEventHandler({
   config,
@@ -21,14 +21,9 @@ export function oauthYandexEventHandler({
     });
     const { code } = getQuery(event);
     if (!config.clientId || !config.clientSecret) {
-      const error = createError({
-        statusCode: 500,
-        message: "Missing NUXT_OAUTH_YANDEX_CLIENT_ID or NUXT_OAUTH_YANDEX_CLIENT_SECRET env variables."
-      });
-      if (!onError) throw error;
-      return onError(event, error);
+      return handleMissingConfiguration(event, "yandex", ["clientId", "clientSecret"], onError);
     }
-    const redirectUrl = getRequestURL(event).href;
+    const redirectURL = config.redirectURL || getRequestURL(event).href;
     if (!code) {
       config.scope = config.scope || [];
       if (config.emailRequired && !config.scope.includes("login:email")) {
@@ -39,7 +34,7 @@ export function oauthYandexEventHandler({
         withQuery(config.authorizationURL, {
           response_type: "code",
           client_id: config.clientId,
-          redirect_uri: redirectUrl,
+          redirect_uri: redirectURL,
           scope: config.scope.join(" ")
         })
       );
@@ -53,20 +48,14 @@ export function oauthYandexEventHandler({
         client_id: config.clientId,
         client_secret: config.clientSecret,
         grant_type: "authorization_code",
-        redirect_uri: stringifyParsedURL(parseURL(redirectUrl)),
+        redirect_uri: stringifyParsedURL(parseURL(redirectURL)),
         code
       }).toString()
     }).catch((error) => {
       return { error };
     });
     if (tokens.error) {
-      const error = createError({
-        statusCode: 401,
-        message: `Yandex login failed: ${tokens.error?.data?.error_description || "Unknown error"}`,
-        data: tokens
-      });
-      if (!onError) throw error;
-      return onError(event, error);
+      return handleAccessTokenErrorResponse(event, "yandex", tokens, onError);
     }
     const accessToken = tokens.access_token;
     const user = await $fetch(config.userURL, {

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

@@ -0,0 +1,9 @@
+import type { H3Event } from 'h3';
+import type { OnError, OAuthProvider } from '#auth-utils';
+/**
+ * Handle OAuth access token error response
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
+ */
+export declare function handleAccessTokenErrorResponse(event: H3Event, oauthProvider: OAuthProvider, oauthError: any, onError?: OnError): void | Promise<void>;
+export declare function handleMissingConfiguration(event: H3Event, provider: OAuthProvider, missingKeys: string[], onError?: OnError): void | Promise<void>;

package/dist/runtime/server/lib/utils.js

@@ -0,0 +1,21 @@
+import { snakeCase, upperFirst } from "scule";
+import { createError } from "#imports";
+export function handleAccessTokenErrorResponse(event, oauthProvider, oauthError, onError) {
+  const message = `${upperFirst(oauthProvider)} login failed: ${oauthError.error_description || oauthError.error || "Unknown error"}`;
+  const error = createError({
+    statusCode: 401,
+    message,
+    data: oauthError
+  });
+  if (!onError) throw error;
+  return onError(event, error);
+}
+export function handleMissingConfiguration(event, provider, missingKeys, onError) {
+  const environmentVariables = missingKeys.map((key) => `NUXT_OAUTH_${provider.toUpperCase()}_${snakeCase(key).toUpperCase()}`);
+  const error = createError({
+    statusCode: 500,
+    message: `Missing ${environmentVariables.join(" or ")} env ${missingKeys.length > 1 ? "variables" : "variable"}.`
+  });
+  if (!onError) throw error;
+  return onError(event, error);
+}

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

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

package/dist/runtime/types/oauth-config.d.ts

@@ -1,9 +1,11 @@
 import type { H3Event, H3Error } from 'h3';
+export type OAuthProvider = 'auth0' | 'battledotnet' | 'cognito' | 'discord' | 'facebook' | 'github' | 'google' | 'keycloak' | 'linkedin' | 'microsoft' | 'paypal' | 'spotify' | 'steam' | 'twitch' | 'x' | 'xsuaa' | 'yandex' | (string & {});
+export type OnError = (event: H3Event, error: H3Error) => Promise<void> | void;
 export interface OAuthConfig<TConfig, TUser = any, TTokens = any> {
     config?: TConfig;
     onSuccess: (event: H3Event, result: {
         user: TUser;
         tokens: TTokens;
     }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
+    onError?: OnError;
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
   "type": "module",
-  "packageManager": "pnpm@9.7.0",
+  "packageManager": "pnpm@9.9.0",
   "exports": {
     ".": {
       "types": "./dist/types.d.ts",
@@ -32,26 +32,27 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.12.4",
+    "@nuxt/kit": "^3.13.0",
     "defu": "^6.1.4",
     "hookable": "^5.5.3",
     "ofetch": "^1.3.4",
     "ohash": "^1.1.3",
     "pathe": "^1.1.2",
+    "scule": "^1.3.0",
     "uncrypto": "^0.1.3"
   },
   "devDependencies": {
-    "@iconify-json/simple-icons": "^1.1.113",
+    "@iconify-json/simple-icons": "^1.1.115",
     "@nuxt/devtools": "latest",
-    "@nuxt/eslint-config": "^0.5.0",
-    "@nuxt/module-builder": "^0.8.1",
-    "@nuxt/schema": "^3.12.4",
-    "@nuxt/test-utils": "^3.14.0",
+    "@nuxt/eslint-config": "^0.5.3",
+    "@nuxt/module-builder": "^0.8.3",
+    "@nuxt/schema": "^3.13.0",
+    "@nuxt/test-utils": "^3.14.1",
     "@nuxt/ui": "^2.18.4",
     "@nuxt/ui-pro": "^1.4.1",
     "changelogen": "^0.5.5",
-    "eslint": "^9.9.0",
-    "nuxt": "^3.12.4",
+    "eslint": "^9.9.1",
+    "nuxt": "^3.13.0",
     "typescript": "^5.5.4",
     "vitest": "^2.0.5",
     "vue-tsc": "^2.0.29"