nuxt-auth-utils 0.5.33 → 0.5.34

package/README.md

@@ -261,6 +261,7 @@ It can also be set using environment variables:
 - X (Twitter)
 - XSUAA
 - Yandex
+- Zendesk
 - Zitadel
 
 You can add your favorite provider by creating a new file in [src/runtime/server/lib/oauth/](https://github.com/atinux/nuxt-auth-utils/tree/main/src/runtime/server/lib/oauth).
@@ -391,7 +392,7 @@ To enable WebAuthn you need to:
 1. Install the peer dependencies:
 
 ```bash
-npx nypm i @simplewebauthn/server@11 @simplewebauthn/browser@11
+npx nypm i @simplewebauthn/server@13 @simplewebauthn/browser@13
 ```
 
 2. Enable it in your `nuxt.config.ts`

package/dist/module.json

@@ -1,9 +1,9 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.5.33",
+  "version": "0.5.34",
   "builder": {
-    "@nuxt/module-builder": "1.0.2",
+    "@nuxt/module-builder": "1.0.3",
     "unbuild": "3.6.1"
   }
 }

package/dist/module.mjs

@@ -436,6 +436,16 @@ const module$1 = defineNuxtModule({
       redirectURL: "",
       scope: []
     });
+    runtimeConfig.oauth.zendesk = defu(runtimeConfig.oauth.zendesk, {
+      clientId: "",
+      clientSecret: "",
+      subdomain: "",
+      redirectURL: "",
+      marketplaceName: "",
+      marketplaceOrgId: "",
+      marketplaceBotId: "",
+      marketplaceAppId: ""
+    });
   }
 });
 

package/dist/runtime/app/components/AuthState.d.vue.ts

@@ -0,0 +1,20 @@
+declare var __VLS_1: {
+    loggedIn: any;
+    user: any;
+    session: any;
+    clear: any;
+}, __VLS_3: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+} & {
+    placeholder?: (props: typeof __VLS_3) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -53,7 +53,7 @@ export function defineOAuthOktaEventHandler({ config, onSuccess, onError }) {
           openIdConfigCache.delete(openIdConfigurationUrl2);
         }
       }
-      let openIdConfig2 = null;
+      let openIdConfig2;
       try {
         openIdConfig2 = await $fetch(openIdConfigurationUrl2);
         if (openIdConfig2) {

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

@@ -14,12 +14,15 @@ export interface OAuthSpotifyConfig {
      * Spotify OAuth Scope
      * @default []
      * @see https://developer.spotify.com/documentation/web-api/concepts/scopes
-     * @example ['user-read-email']
+     * @example ['playlist-read-private']
      */
     scope?: string[];
     /**
      * Require email from user, adds the ['user-read-email'] scope if not present
+     *
+     * Spotify doesn't return the email to Development Mode apps created since February 11, 2026, nor to existing ones since March 9, 2026. Extended Quota Mode apps still receive it.
      * @default false
+     * @see https://developer.spotify.com/documentation/web-api/tutorials/february-2026-migration-guide
      */
     emailRequired?: boolean;
     /**
@@ -44,4 +47,48 @@ export interface OAuthSpotifyConfig {
      */
     redirectURL?: string;
 }
-export declare function defineOAuthSpotifyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSpotifyConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+interface SpotifyUser {
+    /** Stable identifier, recommended by Spotify for account linking instead of `id` */
+    account_id: string;
+    display_name: string | null;
+    external_urls: {
+        spotify: string;
+    };
+    href: string;
+    id: string;
+    images: {
+        url: string;
+        height: number | null;
+        width: number | null;
+    }[];
+    type: string;
+    uri: string;
+    /** @deprecated Only returned to Extended Quota Mode apps since February 2026 */
+    country?: string;
+    /** @deprecated Only returned to Extended Quota Mode apps since February 2026 */
+    email?: string;
+    /** @deprecated Only returned to Extended Quota Mode apps since February 2026 */
+    explicit_content?: {
+        filter_enabled: boolean;
+        filter_locked: boolean;
+    };
+    /** @deprecated Only returned to Extended Quota Mode apps since February 2026 */
+    followers?: {
+        href: string | null;
+        total: number;
+    };
+    /** @deprecated Only returned to Extended Quota Mode apps since February 2026 */
+    product?: string;
+}
+interface SpotifyTokens {
+    access_token: string;
+    token_type: string;
+    scope: string;
+    expires_in: number;
+    refresh_token: string;
+}
+export declare function defineOAuthSpotifyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSpotifyConfig, {
+    user: SpotifyUser;
+    tokens: SpotifyTokens;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export {};

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

@@ -0,0 +1,110 @@
+import type { OAuthConfig } from '#auth-utils';
+export interface OAuthZendeskConfig {
+    /**
+     * Zendesk OAuth Client ID
+     * @default process.env.NUXT_OAUTH_ZENDESK_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * Zendesk OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_ZENDESK_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * Zendesk subdomain, for example `mycompany` for `mycompany.zendesk.com`
+     * @default process.env.NUXT_OAUTH_ZENDESK_SUBDOMAIN
+     */
+    subdomain?: string;
+    /**
+     * Zendesk OAuth Scope
+     * @default ['read']
+     * @see https://support.zendesk.com/hc/en-us/articles/4408845965210-Using-OAuth-authentication-with-your-application
+     * @example ['read', 'write']
+     */
+    scope?: string[];
+    /**
+     * Redirect URL to allow overriding for situations like prod failing to determine public hostname
+     * @default process.env.NUXT_OAUTH_ZENDESK_REDIRECT_URL
+     */
+    redirectURL?: string;
+    /**
+     * Zendesk Marketplace name header value.
+     * Only required for apps published in the Zendesk Marketplace.
+     * @default process.env.NUXT_OAUTH_ZENDESK_MARKETPLACE_NAME
+     */
+    marketplaceName?: string;
+    /**
+     * Zendesk Marketplace organization ID header value.
+     * Only required for apps published in the Zendesk Marketplace.
+     * @default process.env.NUXT_OAUTH_ZENDESK_MARKETPLACE_ORG_ID
+     */
+    marketplaceOrgId?: string;
+    /**
+     * Zendesk Marketplace bot ID header value.
+     * Only required for marketplace bot integrations.
+     * @default process.env.NUXT_OAUTH_ZENDESK_MARKETPLACE_BOT_ID
+     */
+    marketplaceBotId?: string;
+    /**
+     * Zendesk Marketplace app ID header value.
+     * Only required for apps published in the Zendesk Marketplace.
+     * @default process.env.NUXT_OAUTH_ZENDESK_MARKETPLACE_APP_ID
+     */
+    marketplaceAppId?: string;
+}
+export interface ZendeskUser {
+    id: number;
+    url: string;
+    name: string;
+    email: string;
+    created_at: string;
+    updated_at: string;
+    time_zone: string | null;
+    iana_time_zone: string | null;
+    phone: string | null;
+    shared_phone_number: boolean | null;
+    photo: {
+        url: string | null;
+        content_url: string | null;
+    } | null;
+    locale_id: number;
+    locale: string;
+    organization_id: number | null;
+    role: string;
+    verified: boolean;
+    external_id: string | null;
+    tags: string[];
+    alias: string | null;
+    active: boolean;
+    shared: boolean;
+    shared_agent: boolean;
+    last_login_at: string | null;
+    two_factor_auth_enabled: boolean;
+    signature: string | null;
+    details: string | null;
+    notes: string | null;
+    role_type: number | null;
+    custom_role_id: number | null;
+    is_billing_admin: boolean;
+    moderator: boolean;
+    ticket_restriction: string | null;
+    only_private_comments: boolean;
+    restricted_agent: boolean;
+    suspended: boolean;
+    default_group_id: number | null;
+    report_csv: boolean;
+    user_fields: Record<string, unknown>;
+    suspension_details: unknown | null;
+}
+export interface ZendeskTokens {
+    access_token: string;
+    refresh_token?: string;
+    token_type: string;
+    scope: string;
+    expires_in?: number;
+    refresh_token_expires_in?: number;
+}
+export declare function defineOAuthZendeskEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthZendeskConfig, {
+    user: ZendeskUser;
+    tokens: ZendeskTokens;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -0,0 +1,109 @@
+import { eventHandler, getQuery, sendRedirect } from "h3";
+import { withQuery } from "ufo";
+import { defu } from "defu";
+import {
+  handleMissingConfiguration,
+  handleAccessTokenErrorResponse,
+  getOAuthRedirectURL,
+  handleInvalidState,
+  handleState,
+  requestAccessToken
+} from "../utils.js";
+import { useRuntimeConfig } from "#imports";
+function getMarketplaceHeaders(config) {
+  const headers = {};
+  if (config.marketplaceName) {
+    headers["X-Zendesk-Marketplace-Name"] = config.marketplaceName;
+  }
+  if (config.marketplaceOrgId) {
+    headers["X-Zendesk-Marketplace-Organization-Id"] = config.marketplaceOrgId;
+  }
+  if (config.marketplaceBotId) {
+    headers["X-Zendesk-Marketplace-Bot-Id"] = config.marketplaceBotId;
+  }
+  if (config.marketplaceAppId) {
+    headers["X-Zendesk-Marketplace-App-Id"] = config.marketplaceAppId;
+  }
+  return headers;
+}
+export function defineOAuthZendeskEventHandler({
+  config,
+  onSuccess,
+  onError
+}) {
+  return eventHandler(async (event) => {
+    const runtimeConfig = useRuntimeConfig(event).oauth?.zendesk;
+    config = defu(config, runtimeConfig);
+    config.scope = config.scope?.length ? config.scope : ["read"];
+    if (!config.scope.includes("read") && !config.scope.includes("users:read")) {
+      config.scope.push("users:read");
+    }
+    if (!config.clientId || !config.clientSecret || !config.subdomain) {
+      return handleMissingConfiguration(
+        event,
+        "zendesk",
+        ["clientId", "clientSecret", "subdomain"],
+        onError
+      );
+    }
+    const baseURL = `https://${config.subdomain}.zendesk.com`;
+    const query = getQuery(event);
+    const redirectURL = config.redirectURL || getOAuthRedirectURL(event);
+    if (query.error) {
+      return handleAccessTokenErrorResponse(
+        event,
+        "zendesk",
+        {
+          error: query.error,
+          error_description: query.error_description
+        },
+        onError
+      );
+    }
+    const state = await handleState(event);
+    if (!query.code) {
+      return sendRedirect(
+        event,
+        withQuery(`${baseURL}/oauth/authorizations/new`, {
+          response_type: "code",
+          client_id: config.clientId,
+          redirect_uri: redirectURL,
+          scope: config.scope.join(" "),
+          state
+        })
+      );
+    }
+    if (!state || query.state !== state) {
+      return handleInvalidState(event, "zendesk", onError);
+    }
+    const marketplaceHeaders = getMarketplaceHeaders(config);
+    const tokens = await requestAccessToken(`${baseURL}/oauth/tokens`, {
+      headers: {
+        // Zendesk documents JSON bodies for the token endpoint
+        "Content-Type": "application/json",
+        ...marketplaceHeaders
+      },
+      body: {
+        grant_type: "authorization_code",
+        client_id: config.clientId,
+        client_secret: config.clientSecret,
+        redirect_uri: redirectURL,
+        code: query.code,
+        scope: config.scope.join(" ")
+      }
+    });
+    if (tokens.error) {
+      return handleAccessTokenErrorResponse(event, "zendesk", tokens, onError);
+    }
+    const data = await $fetch(`${baseURL}/api/v2/users/me.json`, {
+      headers: {
+        Authorization: `Bearer ${tokens.access_token}`,
+        ...marketplaceHeaders
+      }
+    });
+    return onSuccess(event, {
+      user: data.user,
+      tokens
+    });
+  });
+}

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

@@ -1,6 +1,6 @@
 import type { H3Event, H3Error } from 'h3';
 export type ATProtoProvider = 'bluesky';
-export type OAuthProvider = ATProtoProvider | 'atlassian' | 'auth0' | 'authentik' | 'azureb2c' | 'battledotnet' | 'cloudflare' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'gitea' | 'github' | 'gitlab' | 'google' | 'hubspot' | 'instagram' | 'kick' | 'keycloak' | 'line' | 'linear' | 'linkedin' | 'mastodon' | 'microsoft' | 'paypal' | 'polar' | 'spotify' | 'seznam' | 'steam' | 'strava' | 'tiktok' | 'twitch' | 'vk' | 'wechat' | 'workos' | 'x' | 'xsuaa' | 'yandex' | 'zitadel' | 'apple' | 'livechat' | 'salesforce' | 'slack' | 'heroku' | 'roblox' | 'okta' | 'ory' | 'shopifyCustomer' | 'oidc' | 'osu' | 'riotgames' | 'box' | (string & {});
+export type OAuthProvider = ATProtoProvider | 'atlassian' | 'auth0' | 'authentik' | 'azureb2c' | 'battledotnet' | 'cloudflare' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'gitea' | 'github' | 'gitlab' | 'google' | 'hubspot' | 'instagram' | 'kick' | 'keycloak' | 'line' | 'linear' | 'linkedin' | 'mastodon' | 'microsoft' | 'paypal' | 'polar' | 'spotify' | 'seznam' | 'steam' | 'strava' | 'tiktok' | 'twitch' | 'vk' | 'wechat' | 'workos' | 'x' | 'xsuaa' | 'yandex' | 'zitadel' | 'apple' | 'livechat' | 'salesforce' | 'slack' | 'heroku' | 'roblox' | 'okta' | 'ory' | 'shopifyCustomer' | 'oidc' | 'osu' | 'riotgames' | 'box' | 'zendesk' | (string & {});
 export type OnError = (event: H3Event, error: H3Error) => Promise<void> | void;
 export interface OAuthConfig<TConfig, TResult = {
     user: any;

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

@@ -1,7 +1,9 @@
-import type { AuthenticationResponseJSON, AuthenticatorTransportFuture, RegistrationResponseJSON } from '@simplewebauthn/types';
 import type { Ref } from 'vue';
 import type { H3Event, H3Error, ValidateResult } from 'h3';
-import type { GenerateAuthenticationOptionsOpts, GenerateRegistrationOptionsOpts, VerifiedAuthenticationResponse, VerifiedRegistrationResponse } from '@simplewebauthn/server';
+import type { GenerateAuthenticationOptionsOpts, GenerateRegistrationOptionsOpts, VerifiedAuthenticationResponse, VerifiedRegistrationResponse, verifyAuthenticationResponse, verifyRegistrationResponse } from '@simplewebauthn/server';
+type RegistrationResponseJSON = Parameters<typeof verifyRegistrationResponse>[0]['response'];
+type AuthenticationResponseJSON = Parameters<typeof verifyAuthenticationResponse>[0]['response'];
+type AuthenticatorTransportFuture = NonNullable<Parameters<typeof verifyAuthenticationResponse>[0]['credential']['transports']>[number];
 export interface WebAuthnCredential {
     id: string;
     publicKey: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.5.33",
+  "version": "0.5.34",
   "description": "Add Authentication to Nuxt applications with secured & sealed cookies sessions.",
   "repository": {
     "type": "git",
@@ -29,8 +29,8 @@
     "@adonisjs/hash": "^9.1.1",
     "@nuxt/kit": "^4.3.1",
     "@nuxt/schema": "^4.6.0",
-    "defu": "^6.1.4",
-    "h3": "^1.15.4",
+    "defu": "^6.1.5",
+    "h3": "^1.15.9",
     "hookable": "^6.0.1",
     "jose": "^6.1.3",
     "ofetch": "^1.5.1",
@@ -42,8 +42,8 @@
   "peerDependencies": {
     "@atproto/api": "^0.13.15",
     "@atproto/oauth-client-node": "^0.2.0",
-    "@simplewebauthn/browser": "^11.0.0",
-    "@simplewebauthn/server": "^11.0.0"
+    "@simplewebauthn/browser": "^11.0.0 || ^13.0.0",
+    "@simplewebauthn/server": "^11.0.0 || ^13.3.2"
   },
   "peerDependenciesMeta": {
     "@simplewebauthn/browser": {
@@ -61,12 +61,11 @@
   },
   "devDependencies": {
     "@iconify-json/simple-icons": "^1.2.71",
-    "@nuxt/devtools": "3.2.1",
+    "@nuxt/devtools": "3.4.4",
     "@nuxt/eslint-config": "^1.15.1",
     "@nuxt/module-builder": "^1.0.2",
     "@nuxt/test-utils": "^4.0.0",
     "@nuxt/ui": "^4.4.0",
-    "@simplewebauthn/types": "^12.0.0",
     "@types/node": "latest",
     "eslint": "^10.0.0",
     "nuxt": "^4.6.0",