nuxt-auth-utils 0.0.5 → 0.0.7

package/README.md

@@ -53,13 +53,13 @@ export default defineNuxtConfig({
 NUXT_SESSION_PASSWORD=password-with-at-least-32-characters
 ```
 
-Nuxt Auth Core can generate one for you when running Nuxt in development the first time when no `NUXT_SESSION_PASSWORD` is set.
+Nuxt Auth Utils can generate one for you when running Nuxt in development the first time when no `NUXT_SESSION_PASSWORD` is set.
 
 4. That's it! You can now add authentication to your Nuxt app ✨
 
 ## Vue Composables
 
-Nuxt Neo automatically add some plugins to fetch the current user session to let you access it from your Vue components.
+Nuxt Auth Utils automatically adds some plugins to fetch the current user session to let you access it from your Vue components.
 
 ### User Session
 
@@ -108,7 +108,7 @@ await clearUserSession(event)
 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:
+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
 declare module '#auth-utils' {
@@ -116,6 +116,7 @@ declare module '#auth-utils' {
     // define the type here
   }
 }
+export {}
 ```
 
 ### OAuth Event Handlers
@@ -142,16 +143,19 @@ export default defineNuxtConfig({
 ```
 
 It can also be set using environment variables:
+
 - `NUXT_OAUTH_<PROVIDER>_CLIENT_ID`
 - `NUXT_OAUTH_<PROVIDER>_CLIENT_SECRET`
 
 #### Supported OAuth Providers
 
+- Auth0
+- Discord
 - GitHub
-- Spotify
 - Google
+- Spotify
 - Twitch
-- Auth0
+- Battle.net
 
 You can add your favorite provider by creating a new file in [src/runtime/server/lib/oauth/](./src/runtime/server/lib/oauth/).
 
@@ -182,7 +186,6 @@ export default oauth.githubEventHandler({
 
 Make sure to set the callback URL in your OAuth app settings as `<your-domain>/auth/github`.
 
-
 ## Development
 
 ```bash

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.0.5"
+  "version": "0.0.7"
 }

package/dist/module.mjs

@@ -17,7 +17,7 @@ const module = defineNuxtModule({
       console.warn("No session password set, using a random password, please set NUXT_SESSION_PASSWORD in your .env file with at least 32 chars");
       console.log(`NUXT_SESSION_PASSWORD=${randomPassword}`);
     }
-    nuxt.options.alias["#auth-utils"] = resolver.resolve("./runtime/types/auth-utils-session");
+    nuxt.options.alias["#auth-utils"] = resolver.resolve("./runtime/types/index");
     addImportsDir(resolver.resolve("./runtime/composables"));
     addPlugin(resolver.resolve("./runtime/plugins/session.server"));
     if (nuxt.options.nitro.imports !== false) {
@@ -52,7 +52,10 @@ const module = defineNuxtModule({
     const runtimeConfig = nuxt.options.runtimeConfig;
     runtimeConfig.session = defu(runtimeConfig.session, {
       name: "nuxt-session",
-      password: ""
+      password: "",
+      cookie: {
+        sameSite: "lax"
+      }
     });
     runtimeConfig.oauth = defu(runtimeConfig.oauth, {});
     runtimeConfig.oauth.github = defu(runtimeConfig.oauth.github, {
@@ -76,6 +79,14 @@ const module = defineNuxtModule({
       clientSecret: "",
       domain: ""
     });
+    runtimeConfig.oauth.discord = defu(runtimeConfig.oauth.discord, {
+      clientId: "",
+      clientSecret: ""
+    });
+    runtimeConfig.oauth.battledotnet = defu(runtimeConfig.oauth.battledotnet, {
+      clientId: "",
+      clientSecret: ""
+    });
   }
 });
 

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthAuth0Config {
     /**
      * Auth0 OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthAuth0Config {
      */
     emailRequired?: boolean;
 }
-interface OAuthConfig {
-    config?: OAuthAuth0Config;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthAuth0Config>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -0,0 +1,38 @@
+import type { OAuthConfig } from '#auth-utils';
+export interface OAuthBattledotnetConfig {
+    /**
+     * Battle.net OAuth Client ID
+     * @default process.env.NUXT_OAUTH_BATTLEDOTNET_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * Battle.net OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_BATTLEDOTNET_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * Battle.net OAuth Scope
+     * @default []
+     * @see https://develop.battle.net/documentation/guides/using-oauth
+     * @example ['openid', 'wow.profile', 'sc2.profile', 'd3.profile']
+     */
+    scope?: string[];
+    /**
+     * Battle.net OAuth Region
+     * @default EU
+     * @see https://develop.battle.net/documentation/guides/using-oauth
+     * @example EU (possible values: US, EU, APAC)
+     */
+    region?: string;
+    /**
+     * Battle.net OAuth Authorization URL
+     * @default 'https://oauth.battle.net/authorize'
+     */
+    authorizationURL?: string;
+    /**
+     * Battle.net OAuth Token URL
+     * @default 'https://oauth.battle.net/token'
+     */
+    tokenURL?: string;
+}
+export declare function battledotnetEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthBattledotnetConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -0,0 +1,110 @@
+import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from "h3";
+import { ofetch } from "ofetch";
+import { withQuery, parsePath } from "ufo";
+import { defu } from "defu";
+import { useRuntimeConfig } from "#imports";
+import { randomUUID } from "crypto";
+export function battledotnetEventHandler({ config, onSuccess, onError }) {
+  return eventHandler(async (event) => {
+    config = defu(config, useRuntimeConfig(event).oauth?.battledotnet, {
+      authorizationURL: "https://oauth.battle.net/authorize",
+      tokenURL: "https://oauth.battle.net/token"
+    });
+    const query = getQuery(event);
+    const { code } = query;
+    if (query.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `Battle.net login failed: ${query.error || "Unknown error"}`,
+        data: query
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    if (!config.clientId || !config.clientSecret) {
+      const error = createError({
+        statusCode: 500,
+        message: "Missing NUXT_OAUTH_BATTLEDOTNET_CLIENT_ID or NUXT_OAUTH_BATTLEDOTNET_CLIENT_SECRET env variables."
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    if (!code) {
+      config.scope = config.scope || ["openid"];
+      config.region = config.region || "EU";
+      if (config.region === "CN") {
+        config.authorizationURL = "https://oauth.battlenet.com.cn/authorize";
+        config.tokenURL = "https://oauth.battlenet.com.cn/token";
+      }
+      const redirectUrl2 = getRequestURL(event).href;
+      return sendRedirect(
+        event,
+        withQuery(config.authorizationURL, {
+          client_id: config.clientId,
+          redirect_uri: redirectUrl2,
+          scope: config.scope.join(" "),
+          state: randomUUID(),
+          // Todo: handle PKCE flow
+          response_type: "code"
+        })
+      );
+    }
+    const redirectUrl = getRequestURL(event).href;
+    config.scope = config.scope || [];
+    if (!config.scope.includes("openid")) {
+      config.scope.push("openid");
+    }
+    const authCode = Buffer.from(`${config.clientId}:${config.clientSecret}`).toString("base64");
+    const tokens = await $fetch(
+      config.tokenURL,
+      {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded",
+          Authorization: `Basic ${authCode}`
+        },
+        params: {
+          code,
+          grant_type: "authorization_code",
+          scope: config.scope.join(" "),
+          redirect_uri: parsePath(redirectUrl).pathname
+        }
+      }
+    ).catch((error) => {
+      return { error };
+    });
+    if (tokens.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `Battle.net login failed: ${tokens.error || "Unknown error"}`,
+        data: tokens
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    const accessToken = tokens.access_token;
+    const user = await ofetch("https://oauth.battle.net/userinfo", {
+      headers: {
+        "User-Agent": `Battledotnet-OAuth-${config.clientId}`,
+        Authorization: `Bearer ${accessToken}`
+      }
+    });
+    if (!user) {
+      const error = createError({
+        statusCode: 500,
+        message: "Could not get Battle.net user",
+        data: tokens
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    return onSuccess(event, {
+      user,
+      tokens
+    });
+  });
+}

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

@@ -0,0 +1,42 @@
+import type { OAuthConfig } from '#auth-utils';
+export interface OAuthDiscordConfig {
+    /**
+     * Discord OAuth Client ID
+     * @default process.env.NUXT_OAUTH_DISCORD_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * Discord OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_DISCORD_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * Discord OAuth Scope
+     * @default []
+     * @see https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes
+     * @example ['identify', 'email']
+     * Without the identify scope the user will not be returned.
+     */
+    scope?: string[];
+    /**
+     * Require email from user, adds the ['email'] scope if not present.
+     * @default false
+     */
+    emailRequired?: boolean;
+    /**
+     * Require profile from user, adds the ['identify'] scope if not present.
+     * @default true
+     */
+    profileRequired?: boolean;
+    /**
+     * Discord OAuth Authorization URL
+     * @default 'https://discord.com/oauth2/authorize'
+     */
+    authorizationURL?: string;
+    /**
+     * Discord OAuth Token URL
+     * @default 'https://discord.com/api/oauth2/token'
+     */
+    tokenURL?: string;
+}
+export declare function discordEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthDiscordConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -0,0 +1,85 @@
+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 discordEventHandler({ config, onSuccess, onError }) {
+  return eventHandler(async (event) => {
+    config = defu(config, useRuntimeConfig(event).oauth?.discord, {
+      authorizationURL: "https://discord.com/oauth2/authorize",
+      tokenURL: "https://discord.com/api/oauth2/token",
+      profileRequired: true
+    });
+    const { code } = getQuery(event);
+    if (!config.clientId || !config.clientSecret) {
+      const error = createError({
+        statusCode: 500,
+        message: "Missing NUXT_OAUTH_DISCORD_CLIENT_ID or NUXT_OAUTH_DISCORD_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.emailRequired && !config.scope.includes("email")) {
+        config.scope.push("email");
+      }
+      if (config.profileRequired && !config.scope.includes("identify")) {
+        config.scope.push("identify");
+      }
+      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({
+          client_id: config.clientId,
+          client_secret: config.clientSecret,
+          grant_type: "authorization_code",
+          redirect_uri: stringifyParsedURL(parsedRedirectUrl),
+          code
+        }).toString()
+      }
+    ).catch((error) => {
+      return { error };
+    });
+    if (tokens.error) {
+      console.log(tokens);
+      const error = createError({
+        statusCode: 401,
+        message: `Discord 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://discord.com/api/users/@me", {
+      headers: {
+        "user-agent": "Nuxt Auth Utils",
+        Authorization: `Bearer ${accessToken}`
+      }
+    });
+    return onSuccess(event, {
+      tokens,
+      user
+    });
+  });
+}

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthGitHubConfig {
     /**
      * GitHub OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthGitHubConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthGitHubConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function githubEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function githubEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthGitHubConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthGoogleConfig {
     /**
      * Google OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthGoogleConfig {
      */
     redirectUrl: '/auth/google';
 }
-interface OAuthConfig {
-    config?: OAuthGoogleConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function googleEventHandler({ config, onSuccess, onError, }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function googleEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthGoogleConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthSpotifyConfig {
     /**
      * Spotify OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthSpotifyConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthSpotifyConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSpotifyConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthTwitchConfig {
     /**
      * Twitch Client ID
@@ -33,13 +33,4 @@ export interface OAuthTwitchConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthTwitchConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthTwitchConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -3,10 +3,14 @@ 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 { discordEventHandler } from '../lib/oauth/discord';
+import { battledotnetEventHandler } from '../lib/oauth/battledotnet';
 export declare const oauth: {
     githubEventHandler: typeof githubEventHandler;
     spotifyEventHandler: typeof spotifyEventHandler;
     googleEventHandler: typeof googleEventHandler;
     twitchEventHandler: typeof twitchEventHandler;
     auth0EventHandler: typeof auth0EventHandler;
+    discordEventHandler: typeof discordEventHandler;
+    battledotnetEventHandler: typeof battledotnetEventHandler;
 };

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

@@ -3,10 +3,14 @@ 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 { discordEventHandler } from "../lib/oauth/discord.mjs";
+import { battledotnetEventHandler } from "../lib/oauth/battledotnet.mjs";
 export const oauth = {
   githubEventHandler,
   spotifyEventHandler,
   googleEventHandler,
   twitchEventHandler,
-  auth0EventHandler
+  auth0EventHandler,
+  discordEventHandler,
+  battledotnetEventHandler
 };

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

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

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

@@ -0,0 +1,10 @@
+import type { H3Event, H3Error } from 'h3';
+import type { UserSession } from '#auth-utils';
+export interface OAuthConfig<TConfig, TUser = UserSession, TTokens = any> {
+    config?: TConfig;
+    onSuccess: (event: H3Event, result: {
+        user: TUser;
+        tokens: TTokens;
+    }) => Promise<void> | void;
+    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
+}

package/dist/types.d.mts

@@ -1,5 +1,6 @@
 
-import { ModuleOptions } from './module'
+import type { ModuleOptions } from './module'
+
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['auth']?: Partial<ModuleOptions> }
@@ -12,4 +13,4 @@ declare module 'nuxt/schema' {
 }
 
 
-export { ModuleOptions, default } from './module'
+export type { ModuleOptions, default } from './module'

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 
-import { ModuleOptions } from './module'
+import type { ModuleOptions } from './module'
+
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['auth']?: Partial<ModuleOptions> }
@@ -12,4 +13,4 @@ declare module 'nuxt/schema' {
 }
 
 
-export { ModuleOptions, default } from './module'
+export type { ModuleOptions, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "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.76",
+    "@iconify-json/simple-icons": "^1.1.78",
     "@nuxt/devtools": "latest",
     "@nuxt/eslint-config": "^0.2.0",
-    "@nuxt/module-builder": "^0.5.2",
+    "@nuxt/module-builder": "^0.5.4",
     "@nuxt/schema": "^3.8.1",
     "@nuxt/test-utils": "^3.8.1",
     "@nuxt/ui": "^2.10.0",
     "@nuxt/ui-pro": "^0.4.2",
-    "@types/node": "^20.8.9",
+    "@types/node": "^20.9.0",
     "changelogen": "^0.5.5",
-    "eslint": "^8.52.0",
+    "eslint": "^8.53.0",
     "nuxt": "^3.8.1",
     "typescript": "^5.2.2",
-    "vitest": "^0.33.0",
+    "vitest": "^0.34.6",
     "vue-tsc": "^1.8.22"
   }
 }