nuxt-auth-utils 0.0.23 → 0.0.25

package/README.md

@@ -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,9 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.0.23"
+  "version": "0.0.25",
+  "builder": {
+    "@nuxt/module-builder": "0.6.0",
+    "unbuild": "2.0.0"
+  }
 }

package/dist/module.mjs

@@ -1,5 +1,5 @@
 import { readFile, writeFile } from 'node:fs/promises';
-import { defineNuxtModule, createResolver, addImportsDir, addPlugin, addServerHandler } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addImportsDir, addPlugin, addServerPlugin, addServerHandler } from '@nuxt/kit';
 import { join } from 'pathe';
 import { defu } from 'defu';
 import { randomUUID } from 'uncrypto';
@@ -37,6 +37,7 @@ const module = defineNuxtModule({
         ]
       });
     }
+    addServerPlugin(resolver.resolve("./runtime/server/plugins/oauth"));
     addServerHandler({
       handler: resolver.resolve("./runtime/server/api/session.delete"),
       route: "/api/_auth/session",
@@ -119,6 +120,10 @@ const module = defineNuxtModule({
       region: "",
       userPoolId: ""
     });
+    runtimeConfig.oauth.facebook = defu(runtimeConfig.oauth.facebook, {
+      clientId: "",
+      clientSecret: ""
+    });
   }
 });
 

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

@@ -1,2 +1,2 @@
-declare const _default: any;
+declare const _default: import("#app").Plugin<Record<string, unknown>> & import("#app").ObjectPlugin<Record<string, unknown>>;
 export default _default;

package/dist/runtime/server/api/session.get.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<UserSessionRequired>>;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<import("../../types").UserSessionRequired>>;
 export default _default;

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

@@ -52,4 +52,4 @@ export interface OAuthAuth0Config {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthAuth0Config>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthAuth0Config>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -40,4 +40,4 @@ export interface OAuthBattledotnetConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function battledotnetEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthBattledotnetConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function battledotnetEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthBattledotnetConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -31,4 +31,4 @@ export interface OAuthCognitoConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function cognitoEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthCognitoConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function cognitoEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthCognitoConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -45,4 +45,4 @@ export interface OAuthDiscordConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function discordEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthDiscordConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function discordEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthDiscordConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -0,0 +1,43 @@
+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 User Fields
+     * @default [ 'id', 'name'],
+     * @see https://developers.facebook.com/docs/graph-api/guides/field-expansion
+     * @example [ 'id', 'name', 'email' ],
+     */
+    fields?: 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<void>>;

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

@@ -0,0 +1,88 @@
+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;
+    config.fields = config.fields || ["id", "name"];
+    const fields = config.fields.join(",");
+    const user = await ofetch(
+      `https://graph.facebook.com/v19.0/me?fields=${fields}&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.d.ts

@@ -39,4 +39,4 @@ export interface OAuthGitHubConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function githubEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthGitHubConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function githubEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthGitHubConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -39,4 +39,4 @@ export interface OAuthGoogleConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function googleEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthGoogleConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function googleEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthGoogleConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -33,4 +33,4 @@ export interface OAuthKeycloakConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function keycloakEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthKeycloakConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function keycloakEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthKeycloakConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -39,4 +39,4 @@ export interface OAuthSpotifyConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSpotifyConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSpotifyConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -39,4 +39,4 @@ export interface OAuthTwitchConfig {
      */
     authorizationParams?: Record<string, string>;
 }
-export declare function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthTwitchConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export declare function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthTwitchConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -0,0 +1,2 @@
+declare const _default: import("nitropack").NitroAppPlugin;
+export default _default;

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

@@ -0,0 +1,16 @@
+import { defineNitroPlugin } from "nitropack/runtime";
+export default defineNitroPlugin((nitroApp) => {
+  if (process.env.NUXT_OAUTH_FACEBOOK_CLIENT_ID && process.env.NUXT_OAUTH_FACEBOOK_CLIENT_SECRET) {
+    nitroApp.hooks.hook("render:html", (html) => {
+      html.head.unshift(`
+      <script>
+        if (window.location.hash === "#_=_"){
+          history.replaceState
+              ? history.replaceState(null, null, window.location.href.split("#")[0])
+              : window.location.hash = "";
+        }
+      <\/script>
+    `);
+    });
+  }
+});

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -41,8 +41,8 @@
   "devDependencies": {
     "@iconify-json/simple-icons": "^1.1.99",
     "@nuxt/devtools": "latest",
-    "@nuxt/eslint-config": "^0.3.7",
-    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/eslint-config": "^0.3.8",
+    "@nuxt/module-builder": "^0.6.0",
     "@nuxt/schema": "^3.11.2",
     "@nuxt/test-utils": "^3.12.1",
     "@nuxt/ui": "^2.15.2",