nuxt-auth-utils 0.5.6 → 0.5.7

package/README.md

@@ -214,6 +214,7 @@ It can also be set using environment variables:
 - GitHub
 - GitLab
 - Google
+- Hubspot
 - Instagram
 - Keycloak
 - Linear

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -157,6 +157,7 @@ const module = defineNuxtModule({
       clientId: "",
       clientSecret: "",
       serverUrl: "",
+      serverUrlInternal: "",
       realm: "",
       redirectURL: ""
     });
@@ -254,6 +255,11 @@ const module = defineNuxtModule({
       clientSecret: "",
       redirectURL: ""
     });
+    runtimeConfig.oauth.hubspot = defu(runtimeConfig.oauth.hubspot, {
+      clientId: "",
+      clientSecret: "",
+      redirectURL: ""
+    });
   }
 });
 

package/dist/runtime/app/plugins/session.client.d.ts

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

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

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

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

@@ -35,10 +35,5 @@ export interface OAuthCognitoConfig {
      * @default process.env.NUXT_OAUTH_COGNITO_REDIRECT_URL or current URL
      */
     redirectURL?: string;
-    /**
-     * AWS Cognito App Custom Domain – some pool configurations require this
-     * @default ''
-     */
-    domain?: string;
 }
 export declare function defineOAuthCognitoEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthCognitoConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -1,7 +1,8 @@
+import { defu } from "defu";
 import { eventHandler, getQuery, sendRedirect } from "h3";
+import { discovery } from "openid-client";
 import { withQuery } from "ufo";
-import { defu } from "defu";
-import { handleMissingConfiguration, handleAccessTokenErrorResponse, getOAuthRedirectURL, requestAccessToken } from "../utils.js";
+import { getOAuthRedirectURL, handleAccessTokenErrorResponse, handleMissingConfiguration, requestAccessToken } from "../utils.js";
 import { useRuntimeConfig } from "#imports";
 export function defineOAuthCognitoEventHandler({ config, onSuccess, onError }) {
   return eventHandler(async (event) => {
@@ -11,9 +12,16 @@ export function defineOAuthCognitoEventHandler({ config, onSuccess, onError }) {
     if (!config.clientId || !config.clientSecret || !config.userPoolId || !config.region) {
       return handleMissingConfiguration(event, "cognito", ["clientId", "clientSecret", "userPoolId", "region"], onError);
     }
-    const urlBase = config?.domain || `${config.userPoolId}.auth.${config.region}.amazoncognito.com`;
-    const authorizationURL = `https://${urlBase}/oauth2/authorize`;
-    const tokenURL = `https://${urlBase}/oauth2/token`;
+    const congitoDiscoveryUrl = new URL(`https://cognito-idp.${config.region}.amazonaws.com/${config.userPoolId}/.well-known/openid-configuration`);
+    const issuer = await discovery(congitoDiscoveryUrl, config.clientId, config.clientSecret);
+    const {
+      authorization_endpoint: authorizationURL,
+      token_endpoint: tokenURL,
+      userinfo_endpoint: userinfoURL,
+      // TODO: implement logout
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      end_session_endpoint: logoutURL
+    } = issuer.serverMetadata();
     const query = getQuery(event);
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {
@@ -46,7 +54,7 @@ export function defineOAuthCognitoEventHandler({ config, onSuccess, onError }) {
     }
     const tokenType = tokens.token_type;
     const accessToken = tokens.access_token;
-    const user = await $fetch(`https://${urlBase}/oauth2/userInfo`, {
+    const user = await $fetch(userinfoURL, {
       headers: {
         Authorization: `${tokenType} ${accessToken}`
       }

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

@@ -11,8 +11,8 @@ export function defineOAuthDropboxEventHandler({ config, onSuccess, onError }) {
       authorizationParams: {}
     });
     const query = getQuery(event);
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "dropbox", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "dropbox", ["clientId", "clientSecret"], onError);
     }
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {

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

@@ -24,8 +24,8 @@ export function defineOAuthFacebookEventHandler({
       if (!onError) throw error;
       return onError(event, error);
     }
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "facebook", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "facebook", ["clientId", "clientSecret"], onError);
     }
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {

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

@@ -16,8 +16,8 @@ export function defineOAuthGoogleEventHandler({
       authorizationParams: {}
     });
     const query = getQuery(event);
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "google", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "google", ["clientId", "clientSecret"], onError);
     }
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {

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

@@ -0,0 +1,26 @@
+import type { OAuthConfig } from '#auth-utils';
+export interface OAuthHubspotConfig {
+    /**
+     * Hubspot OAuth Client ID
+     * @default process.env.NUXT_OAUTH_HUBSPOT_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * Hubspot OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_HUBSPOT_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * Hubspot OAuth Redirect URL
+     * @default process.env.NUXT_OAUTH_HUBSPOT_REDIRECT_URL
+     */
+    redirectURL?: string;
+    /**
+     * Hubspot OAuth Scope
+     * @default ['oauth']
+     * @see https://developers.hubspot.com/beta-docs/guides/apps/authentication/scopes
+     * @example ['accounting', 'automation', 'actions']
+     */
+    scope?: string[];
+}
+export declare function defineOAuthHubspotEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthHubspotConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -0,0 +1,57 @@
+import { eventHandler, getQuery, sendRedirect } from "h3";
+import { withQuery } from "ufo";
+import defu from "defu";
+import {
+  getOAuthRedirectURL,
+  handleAccessTokenErrorResponse,
+  handleMissingConfiguration,
+  requestAccessToken
+} from "../utils.js";
+import { useRuntimeConfig } from "#imports";
+export function defineOAuthHubspotEventHandler({ config, onSuccess, onError }) {
+  return eventHandler(async (event) => {
+    config = defu(config, useRuntimeConfig(event).oauth?.hubspot);
+    if (!config.clientId || !config.clientSecret || !config.redirectURL) {
+      return handleMissingConfiguration(event, "hubspot", ["clientId", "clientSecret", "redirectURL"], onError);
+    }
+    const query = getQuery(event);
+    const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
+    if (query.error) {
+      return handleAccessTokenErrorResponse(event, "hubspot", query, onError);
+    }
+    if (!query.code) {
+      return sendRedirect(
+        event,
+        withQuery("https://app.hubspot.com/oauth/authorize", {
+          client_id: config.clientId,
+          redirect_uri: redirectURL,
+          scope: config.scope?.join(" ") || "oauth"
+        })
+      );
+    }
+    const tokens = await requestAccessToken(
+      "https://api.hubapi.com/oauth/v1/token",
+      {
+        body: {
+          client_id: config.clientId,
+          client_secret: config.clientSecret,
+          code: query.code,
+          redirect_uri: redirectURL,
+          grant_type: "authorization_code"
+        }
+      }
+    );
+    if (tokens.error) {
+      return handleAccessTokenErrorResponse(event, "hubspot", tokens, onError);
+    }
+    const info = await $fetch("https://api.hubapi.com/oauth/v1/access-tokens/" + tokens.access_token);
+    return onSuccess(event, {
+      user: {
+        id: info.user_id,
+        email: info.user,
+        domain: info.hub_domain
+      },
+      tokens
+    });
+  });
+}

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

@@ -29,8 +29,8 @@ export function defineOAuthInstagramEventHandler({
       if (!onError) throw error;
       return onError(event, error);
     }
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "instagram", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "instagram", ["clientId", "clientSecret"], onError);
     }
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {

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

@@ -12,10 +12,17 @@ export interface OAuthKeycloakConfig {
     clientSecret?: string;
     /**
      * Keycloak OAuth Server URL
-     * @example http://192.168.1.10:8080/auth
+     * @example http://192.168.1.10:8080
      * @default process.env.NUXT_OAUTH_KEYCLOAK_SERVER_URL
      */
     serverUrl?: string;
+    /**
+     * Optional Keycloak OAuth Server URL to use internally, e.g. if Nuxt connects to a Docker hostname while the browser
+     * redirect goes to localhost
+     * @example http://keycloak:8080
+     * @default process.env.NUXT_OAUTH_KEYCLOAK_SERVER_URL_INTERNAL
+     */
+    serverUrlInternal?: string;
     /**
      * Keycloak OAuth Realm
      * @default process.env.NUXT_OAUTH_KEYCLOAK_REALM
@@ -33,7 +40,7 @@ export interface OAuthKeycloakConfig {
      */
     authorizationParams?: Record<string, string>;
     /**
-     * Redirect URL to to allow overriding for situations like prod failing to determine public hostname
+     * Redirect URL to allow overriding for situations like prod failing to determine public hostname
      * @default process.env.NUXT_OAUTH_KEYCLOAK_REDIRECT_URL or current URL
      */
     redirectURL?: string;

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

@@ -26,8 +26,9 @@ export function defineOAuthKeycloakEventHandler({
       return handleMissingConfiguration(event, "keycloak", ["clientId", "clientSecret", "serverUrl", "realm"], onError);
     }
     const realmURL = `${config.serverUrl}/realms/${config.realm}`;
+    const realmURLInternal = `${config.serverUrlInternal || config.serverUrl}/realms/${config.realm}`;
     const authorizationURL = `${realmURL}/protocol/openid-connect/auth`;
-    const tokenURL = `${realmURL}/protocol/openid-connect/token`;
+    const tokenURL = `${realmURLInternal}/protocol/openid-connect/token`;
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {
       config.scope = config.scope || ["openid"];

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

@@ -12,8 +12,8 @@ export function defineOAuthPaypalEventHandler({ config, onSuccess, onError }) {
       authorizationParams: {}
     });
     const query = getQuery(event);
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "paypal", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "paypal", ["clientId", "clientSecret"], onError);
     }
     let paypalAPI = "api-m.paypal.com";
     if (config.sandbox) {

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

@@ -11,8 +11,8 @@ export function defineOAuthSeznamEventHandler({ config, onSuccess, onError }) {
       userURL: "https://login.szn.cz/api/v1/user"
     });
     const query = getQuery(event);
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "seznam", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "seznam", ["clientId", "clientSecret"], onError);
     }
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {

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

@@ -11,8 +11,8 @@ export function defineOAuthTwitchEventHandler({ config, onSuccess, onError }) {
       authorizationParams: {}
     });
     const query = getQuery(event);
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "twitch", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "twitch", ["clientId", "clientSecret"], onError);
     }
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {

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

@@ -25,8 +25,8 @@ export function defineOAuthXEventHandler({
       }
     });
     const query = getQuery(event);
-    if (!config.clientId) {
-      return handleMissingConfiguration(event, "x", ["clientId"], onError);
+    if (!config.clientId || !config.clientSecret) {
+      return handleMissingConfiguration(event, "x", ["clientId", "clientSecret"], onError);
     }
     const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
     if (!query.code) {

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

@@ -1,5 +1,5 @@
 import type { H3Event, H3Error } from 'h3';
-export type OAuthProvider = 'auth0' | 'authentik' | 'battledotnet' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'github' | 'gitlab' | 'google' | 'instagram' | 'keycloak' | 'linear' | 'linkedin' | 'microsoft' | 'paypal' | 'polar' | 'spotify' | 'seznam' | 'steam' | 'strava' | 'tiktok' | 'twitch' | 'vk' | 'workos' | 'x' | 'xsuaa' | 'yandex' | 'zitadel' | (string & {});
+export type OAuthProvider = 'auth0' | 'authentik' | 'battledotnet' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'github' | 'gitlab' | 'google' | 'hubspot' | 'instagram' | 'keycloak' | 'linear' | 'linkedin' | 'microsoft' | 'paypal' | 'polar' | 'spotify' | 'seznam' | 'steam' | 'strava' | 'tiktok' | 'twitch' | 'vk' | 'workos' | 'x' | 'xsuaa' | 'yandex' | 'zitadel' | (string & {});
 export type OnError = (event: H3Event, error: H3Error) => Promise<void> | void;
 export interface OAuthConfig<TConfig, TUser = any, TTokens = any> {
     config?: TConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "description": "Add Authentication to Nuxt applications with secured & sealed cookies sessions.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
   },
   "license": "MIT",
   "type": "module",
-  "packageManager": "pnpm@9.13.2",
+  "packageManager": "pnpm@9.15.0",
   "exports": {
     ".": {
       "types": "./dist/types.d.ts",
@@ -36,12 +36,13 @@
   },
   "dependencies": {
     "@adonisjs/hash": "^9.0.5",
-    "@nuxt/kit": "^3.14.159",
+    "@nuxt/kit": "^3.14.1592",
     "defu": "^6.1.4",
     "h3": "^1.13.0",
     "hookable": "^5.5.3",
     "ofetch": "^1.4.1",
     "ohash": "^1.1.4",
+    "openid-client": "^6.1.7",
     "pathe": "^1.1.2",
     "scule": "^1.3.0",
     "uncrypto": "^0.1.3"
@@ -59,20 +60,20 @@
     }
   },
   "devDependencies": {
-    "@iconify-json/simple-icons": "^1.2.11",
+    "@iconify-json/simple-icons": "^1.2.15",
     "@nuxt/devtools": "latest",
-    "@nuxt/eslint-config": "^0.6.1",
+    "@nuxt/eslint-config": "^0.7.3",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.14.159",
-    "@nuxt/test-utils": "^3.14.4",
-    "@nuxt/ui": "^2.19.2",
-    "@nuxt/ui-pro": "^1.5.0",
+    "@nuxt/schema": "^3.14.1592",
+    "@nuxt/test-utils": "^3.15.1",
+    "@nuxt/ui": "^2.20.0",
+    "@nuxt/ui-pro": "^1.6.0",
     "@simplewebauthn/types": "^11.0.0",
     "changelogen": "^0.5.7",
-    "eslint": "^9.14.0",
-    "nuxt": "^3.14.159",
+    "eslint": "^9.16.0",
+    "nuxt": "^3.14.1592",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.5",
+    "vitest": "^2.1.8",
     "vue-tsc": "^2.1.10"
   }
 }