nuxt-auth-utils 0.0.22 → 0.0.24

package/README.md

@@ -59,7 +59,7 @@ const { loggedIn, user, session, clear } = useUserSession()
   </div>
   <div v-else>
     <h1>Not logged in</h1>
-    <a href="/api/auth/github">Login with GitHub</a>
+    <a href="/auth/github">Login with GitHub</a>
   </div>
 </template>
 ```
@@ -146,6 +146,7 @@ It can also be set using environment variables:
 - AWS Cognito
 - Battle.net
 - Discord
+- Facebook
 - GitHub
 - Google
 - Keycloak

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.0.22"
+  "version": "0.0.24"
 }

package/dist/module.mjs

@@ -1,8 +1,8 @@
+import { readFile, writeFile } from 'node:fs/promises';
 import { defineNuxtModule, createResolver, addImportsDir, addPlugin, addServerHandler } from '@nuxt/kit';
 import { join } from 'pathe';
 import { defu } from 'defu';
 import { randomUUID } from 'uncrypto';
-import { readFile, writeFile } from 'node:fs/promises';
 
 const module = defineNuxtModule({
   meta: {
@@ -119,6 +119,10 @@ const module = defineNuxtModule({
       region: "",
       userPoolId: ""
     });
+    runtimeConfig.oauth.facebook = defu(runtimeConfig.oauth.facebook, {
+      clientId: "",
+      clientSecret: ""
+    });
   }
 });
 

package/dist/runtime/composables/session.mjs

@@ -14,7 +14,8 @@ async function fetch() {
   useSessionState().value = await useRequestFetch()("/api/_auth/session", {
     headers: {
       Accept: "text/json"
-    }
+    },
+    retry: false
   }).catch(() => ({}));
 }
 async function clear() {

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

@@ -1,9 +1,9 @@
+import { randomUUID } from "node:crypto";
 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, {
@@ -65,7 +65,7 @@ export function battledotnetEventHandler({ config, onSuccess, onError }) {
         method: "POST",
         headers: {
           "Content-Type": "application/x-www-form-urlencoded",
-          Authorization: `Basic ${authCode}`
+          "Authorization": `Basic ${authCode}`
         },
         params: {
           code,
@@ -91,7 +91,7 @@ export function battledotnetEventHandler({ config, onSuccess, onError }) {
     const user = await ofetch("https://oauth.battle.net/userinfo", {
       headers: {
         "User-Agent": `Battledotnet-OAuth-${config.clientId}`,
-        Authorization: `Bearer ${accessToken}`
+        "Authorization": `Bearer ${accessToken}`
       }
     });
     if (!user) {

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

@@ -75,7 +75,7 @@ export function discordEventHandler({ config, onSuccess, onError }) {
     const user = await ofetch("https://discord.com/api/users/@me", {
       headers: {
         "user-agent": "Nuxt Auth Utils",
-        Authorization: `Bearer ${accessToken}`
+        "Authorization": `Bearer ${accessToken}`
       }
     });
     return onSuccess(event, {

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

@@ -0,0 +1,36 @@
+import type { OAuthConfig } from '#auth-utils';
+export interface OAuthFacebookConfig {
+    /**
+     * Facebook OAuth Client ID
+     * @default process.env.NUXT_OAUTH_FACEBOOK_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * Facebook OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_FACEBOOK_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * Facebook OAuth Scope
+     * @default []
+     * @see https://developers.facebook.com/docs/permissions
+     * @example [ 'email' ],
+     */
+    scope?: string[];
+    /**
+     * Facebook OAuth Authorization URL
+     * @default 'https://www.facebook.com/v19.0/dialog/oauth'
+     */
+    authorizationURL?: string;
+    /**
+     * Facebook OAuth Token URL
+     * @default 'https://graph.facebook.com/v19.0/oauth/access_token'
+     */
+    tokenURL?: string;
+    /**
+     * Extra authorization parameters to provide to the authorization URL
+     * @see https://developers.facebook.com/docs/facebook-login/guides/advanced/manual-flow/
+     */
+    authorizationParams?: Record<string, string>;
+}
+export declare function facebookEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthFacebookConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -0,0 +1,86 @@
+import {
+  eventHandler,
+  createError,
+  getQuery,
+  getRequestURL,
+  sendRedirect
+} from "h3";
+import { ofetch } from "ofetch";
+import { withQuery } from "ufo";
+import { defu } from "defu";
+import { useRuntimeConfig } from "#imports";
+export function facebookEventHandler({
+  config,
+  onSuccess,
+  onError
+}) {
+  return eventHandler(async (event) => {
+    config = defu(config, useRuntimeConfig(event).oauth?.facebook, {
+      authorizationURL: "https://www.facebook.com/v19.0/dialog/oauth",
+      tokenURL: "https://graph.facebook.com/v19.0/oauth/access_token",
+      authorizationParams: {}
+    });
+    const query = getQuery(event);
+    if (query.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `Facebook login failed: ${query.error || "Unknown error"}`,
+        data: query
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    if (!config.clientId) {
+      const error = createError({
+        statusCode: 500,
+        message: "Missing NUXT_OAUTH_FACEBOOK_CLIENT_ID or NUXT_OAUTH_FACEBOOK_CLIENT_SECRET env variables."
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    const redirectUrl = getRequestURL(event).href;
+    if (!query.code) {
+      config.scope = config.scope || [];
+      return sendRedirect(
+        event,
+        withQuery(config.authorizationURL, {
+          client_id: config.clientId,
+          redirect_uri: redirectUrl,
+          scope: config.scope.join(" ")
+        })
+      );
+    }
+    const tokens = await $fetch(config.tokenURL, {
+      method: "POST",
+      body: {
+        client_id: config.clientId,
+        client_secret: config.clientSecret,
+        redirect_uri: redirectUrl,
+        code: query.code
+      }
+    });
+    if (tokens.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `Facebook 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://graph.facebook.com/v19.0/me?fields=id,name&access_token=${accessToken}`
+    );
+    if (!user) {
+      throw new Error("Facebook login failed: no user found");
+    }
+    return onSuccess(event, {
+      user,
+      tokens
+    });
+  });
+}

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

@@ -71,14 +71,14 @@ export function githubEventHandler({ config, onSuccess, onError }) {
     const user = await ofetch("https://api.github.com/user", {
       headers: {
         "User-Agent": `Github-OAuth-${config.clientId}`,
-        Authorization: `token ${accessToken}`
+        "Authorization": `token ${accessToken}`
       }
     });
     if (!user.email && config.emailRequired) {
       const emails = await ofetch("https://api.github.com/user/emails", {
         headers: {
           "User-Agent": `Github-OAuth-${config.clientId}`,
-          Authorization: `token ${accessToken}`
+          "Authorization": `token ${accessToken}`
         }
       });
       const primaryEmail = emails.find((email) => email.primary);

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

@@ -74,7 +74,7 @@ export function linkedinEventHandler({ config, onSuccess, onError }) {
     const user = await ofetch("https://api.linkedin.com/v2/userinfo", {
       headers: {
         "user-agent": "Nuxt Auth Utils",
-        Authorization: `Bearer ${accessToken}`
+        "Authorization": `Bearer ${accessToken}`
       }
     });
     return onSuccess(event, {

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

@@ -43,7 +43,7 @@ export function spotifyEventHandler({ config, onSuccess, onError }) {
       {
         method: "POST",
         headers: {
-          Authorization: `Basic ${authCode}`,
+          "Authorization": `Basic ${authCode}`,
           "Content-Type": "application/x-www-form-urlencoded"
         },
         params: {

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

@@ -6,9 +6,9 @@ export interface OAuthTwitchConfig {
      */
     clientId?: string;
     /**
-    * Twitch OAuth Client Secret
-    * @default process.env.NUXT_OAUTH_TWITCH_CLIENT_SECRET
-    */
+     * Twitch OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_TWITCH_CLIENT_SECRET
+     */
     clientSecret?: string;
     /**
      * Twitch OAuth Scope

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

@@ -69,7 +69,7 @@ export function twitchEventHandler({ config, onSuccess, onError }) {
     const users = await ofetch("https://api.twitch.tv/helix/users", {
       headers: {
         "Client-ID": config.clientId,
-        Authorization: `Bearer ${accessToken}`
+        "Authorization": `Bearer ${accessToken}`
       }
     });
     const user = users.data?.[0];

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

@@ -9,6 +9,7 @@ import { battledotnetEventHandler } from '../lib/oauth/battledotnet';
 import { keycloakEventHandler } from '../lib/oauth/keycloak';
 import { linkedinEventHandler } from '../lib/oauth/linkedin';
 import { cognitoEventHandler } from '../lib/oauth/cognito';
+import { facebookEventHandler } from '../lib/oauth/facebook';
 export declare const oauth: {
     githubEventHandler: typeof githubEventHandler;
     spotifyEventHandler: typeof spotifyEventHandler;
@@ -21,4 +22,5 @@ export declare const oauth: {
     keycloakEventHandler: typeof keycloakEventHandler;
     linkedinEventHandler: typeof linkedinEventHandler;
     cognitoEventHandler: typeof cognitoEventHandler;
+    facebookEventHandler: typeof facebookEventHandler;
 };

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

@@ -9,6 +9,7 @@ import { battledotnetEventHandler } from "../lib/oauth/battledotnet.mjs";
 import { keycloakEventHandler } from "../lib/oauth/keycloak.mjs";
 import { linkedinEventHandler } from "../lib/oauth/linkedin.mjs";
 import { cognitoEventHandler } from "../lib/oauth/cognito.mjs";
+import { facebookEventHandler } from "../lib/oauth/facebook.mjs";
 export const oauth = {
   githubEventHandler,
   spotifyEventHandler,
@@ -20,5 +21,6 @@ export const oauth = {
   battledotnetEventHandler,
   keycloakEventHandler,
   linkedinEventHandler,
-  cognitoEventHandler
+  cognitoEventHandler,
+  facebookEventHandler
 };

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

@@ -6,11 +6,11 @@ export interface SessionHooks {
      * - Add extra properties to the session
      * - Throw an error if the session could not be verified (with a database for example)
      */
-    'fetch': (session: UserSessionRequired, event: H3Event) => void | Promise<void>;
+    fetch: (session: UserSessionRequired, event: H3Event) => void | Promise<void>;
     /**
      * Called before clearing the session
      */
-    'clear': (session: UserSession, event: H3Event) => void | Promise<void>;
+    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>;
@@ -27,4 +27,14 @@ export declare function setUserSession(event: H3Event, data: UserSession): Promi
  */
 export declare function replaceUserSession(event: H3Event, data: UserSession): Promise<UserSession>;
 export declare function clearUserSession(event: H3Event): Promise<boolean>;
-export declare function requireUserSession(event: H3Event): Promise<UserSessionRequired>;
+/**
+ * Require a user session
+ * @param event
+ * @param opts Options to customize the error message and status code
+ * @param opts.statusCode The status code to use for the error (defaults to 401)
+ * @param opts.message The message to use for the error (defaults to Unauthorized)
+ */
+export declare function requireUserSession(event: H3Event, opts?: {
+    statusCode?: number;
+    message?: string;
+}): Promise<UserSessionRequired>;

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

@@ -23,12 +23,12 @@ export async function clearUserSession(event) {
   await session.clear();
   return true;
 }
-export async function requireUserSession(event) {
+export async function requireUserSession(event, opts = {}) {
   const userSession = await getUserSession(event);
   if (!userSession.user) {
     throw createError({
-      statusCode: 401,
-      message: "Unauthorized"
+      statusCode: opts.statusCode || 401,
+      message: opts.message || "Unauthorized"
     });
   }
   return userSession;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.11.1",
+    "@nuxt/kit": "^3.11.2",
     "defu": "^6.1.4",
     "hookable": "^5.5.3",
     "ofetch": "^1.3.4",
@@ -39,20 +39,20 @@
     "uncrypto": "^0.1.3"
   },
   "devDependencies": {
-    "@iconify-json/simple-icons": "^1.1.96",
+    "@iconify-json/simple-icons": "^1.1.99",
     "@nuxt/devtools": "latest",
-    "@nuxt/eslint-config": "^0.2.0",
+    "@nuxt/eslint-config": "^0.3.8",
     "@nuxt/module-builder": "^0.5.5",
-    "@nuxt/schema": "^3.11.1",
-    "@nuxt/test-utils": "^3.12.0",
-    "@nuxt/ui": "^2.14.2",
-    "@nuxt/ui-pro": "^1.0.2",
-    "@types/node": "^20.11.30",
+    "@nuxt/schema": "^3.11.2",
+    "@nuxt/test-utils": "^3.12.1",
+    "@nuxt/ui": "^2.15.2",
+    "@nuxt/ui-pro": "^1.1.0",
+    "@types/node": "^20.12.7",
     "changelogen": "^0.5.5",
-    "eslint": "^8.57.0",
-    "nuxt": "^3.11.1",
-    "typescript": "^5.4.3",
-    "vitest": "^1.4.0",
-    "vue-tsc": "^2.0.7"
+    "eslint": "^9.0.0",
+    "nuxt": "^3.11.2",
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.0",
+    "vue-tsc": "^2.0.13"
   }
 }