nuxt-auth-utils 0.5.19 → 0.5.21

package/README.md

@@ -156,6 +156,9 @@ 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 to augment the `UserSession` type:
 
+> [!NOTE]
+> If you are using Nuxt >=4.0.0 or compatibility version 4 add the `auth.d.ts` file to the `shared` directory to get the correct types in server and client.
+
 ```ts
 // auth.d.ts
 declare module '#auth-utils' {
@@ -253,7 +256,7 @@ It can also be set using environment variables:
 - Yandex
 - Zitadel
 
-You can add your favorite provider by creating a new file in [src/runtime/server/lib/oauth/](./src/runtime/server/lib/oauth/).
+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).
 
 #### Example
 

package/dist/module.json

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

package/dist/runtime/app/composables/session.js

@@ -2,7 +2,7 @@ import { appendResponseHeader } from "h3";
 import { useState, computed, useRequestFetch, useRequestEvent } from "#imports";
 export function useUserSession() {
   const serverEvent = import.meta.server ? useRequestEvent() : null;
-  const sessionState = useState("nuxt-session", () => ({}));
+  const sessionState = useState("nuxt-session", () => null);
   const authReadyState = useState("nuxt-auth-ready", () => false);
   const clear = async () => {
     await useRequestFetch()("/api/_auth/session", {
@@ -15,7 +15,7 @@ export function useUserSession() {
         }
       }
     });
-    sessionState.value = {};
+    sessionState.value = null;
   };
   const fetch = async () => {
     sessionState.value = await useRequestFetch()("/api/_auth/session", {
@@ -23,7 +23,7 @@ export function useUserSession() {
         accept: "application/json"
       },
       retry: false
-    }).catch(() => ({}));
+    }).catch(() => null);
     if (!authReadyState.value) {
       authReadyState.value = true;
     }
@@ -49,8 +49,8 @@ export function useUserSession() {
   };
   return {
     ready: computed(() => authReadyState.value),
-    loggedIn: computed(() => Boolean(sessionState.value.user)),
-    user: computed(() => sessionState.value.user || null),
+    loggedIn: computed(() => Boolean(sessionState.value?.user)),
+    user: computed(() => sessionState.value?.user || null),
     session: sessionState,
     fetch,
     openInPopup,

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

@@ -1,6 +1,6 @@
 declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<{
     [key: string]: unknown;
-    id?: string;
+    id: string;
     user?: import("../../types").User;
 }>>;
 export default _default;

package/dist/runtime/server/lib/atproto/bluesky.d.ts

@@ -19,7 +19,10 @@ export interface OAuthBlueskyConfig {
 }
 type BlueSkyUser = AppBskyActorDefs.ProfileViewDetailed | Pick<AppBskyActorDefs.ProfileView, 'did'>;
 type BlueSkyTokens = NodeSavedSession['tokenSet'];
-export declare function defineOAuthBlueskyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthBlueskyConfig, BlueSkyUser, BlueSkyTokens>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export declare function defineOAuthBlueskyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthBlueskyConfig, {
+    user: BlueSkyUser;
+    tokens: BlueSkyTokens;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
 export declare class StateStore implements NodeSavedStateStore {
     private event;
     private readonly stateKey;

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

@@ -70,4 +70,8 @@ export interface OAuthAppleUser {
     };
     email?: string;
 }
-export declare function defineOAuthAppleEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthAppleConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export declare function defineOAuthAppleEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthAppleConfig, {
+    user: OAuthAppleUser;
+    payload: OAuthAppleTokens;
+    tokens: any;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -7,6 +7,7 @@ export function defineOAuthAppleEventHandler({
   config,
   onSuccess,
   onError
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
 }) {
   return eventHandler(async (event) => {
     config = defu(config, useRuntimeConfig(event).oauth?.apple, {

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

@@ -1,4 +1,29 @@
 import type { OAuthConfig } from '#auth-utils';
+interface AtlassianUser {
+    account_id?: string;
+    email?: string;
+    name?: string;
+    picture?: string;
+    account_status?: string;
+    characteristics?: {
+        not_mentionable?: boolean;
+    };
+    last_updated?: string;
+    nickname?: string;
+    locale?: string;
+    extended_profile?: {
+        phone_numbers?: string[];
+    };
+    account_type?: string;
+    email_verified?: boolean;
+}
+interface AtlassianTokens {
+    access_token?: string;
+    expires_in?: number;
+    token_type?: string;
+    scope?: string;
+    error?: string;
+}
 /**
  * @see https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps
  */
@@ -63,4 +88,8 @@ export interface OAuthAtlassianConfig {
 /**
  * Atlassian User identity, Confluence, BRIE, Jira platform, Atlassian Personal data reporting
  */
-export declare function defineOAuthAtlassianEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthAtlassianConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export declare function defineOAuthAtlassianEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthAtlassianConfig, {
+    user: AtlassianUser;
+    tokens: AtlassianTokens;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export {};

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

@@ -35,7 +35,7 @@ export function defineOAuthAzureB2CEventHandler({ config, onSuccess, onError })
       );
     }
     if (query.state !== state) {
-      handleInvalidState(event, "azureb2c", onError);
+      return handleInvalidState(event, "azureb2c", onError);
     }
     console.info("code verifier", verifier.code_verifier);
     const tokens = await requestAccessToken(tokenURL, {

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

@@ -50,4 +50,48 @@ export interface OAuthGitHubConfig {
      */
     redirectURL?: string;
 }
-export declare function defineOAuthGitHubEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthGitHubConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+interface GitHubUser {
+    login: string;
+    id: number;
+    node_id: string;
+    avatar_url: string;
+    gravatar_id: string;
+    url: string;
+    html_url: string;
+    followers_url: string;
+    following_url: string;
+    gists_url: string;
+    starred_url: string;
+    subscriptions_url: string;
+    organizations_url: string;
+    repos_url: string;
+    events_url: string;
+    received_events_url: string;
+    type: string;
+    site_admin: boolean;
+    name: string;
+    company: string;
+    blog: string;
+    location: string;
+    email: string | null;
+    hireable: boolean | null;
+    bio: string | null;
+    twitter_username: string | null;
+    public_repos: number;
+    public_gists: number;
+    followers: number;
+    following: number;
+    created_at: string;
+    updated_at: string;
+    email_verified?: boolean;
+}
+interface GitHubTokens {
+    access_token: string;
+    scope: string;
+    token_type: string;
+}
+export declare function defineOAuthGitHubEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthGitHubConfig, {
+    user: GitHubUser;
+    tokens: GitHubTokens;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export {};

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

@@ -46,7 +46,7 @@ export function defineOAuthHerokuEventHandler({
       );
     }
     if (query.state !== state) {
-      handleInvalidState(event, "heroku", onError);
+      return handleInvalidState(event, "heroku", onError);
     }
     const tokens = await requestAccessToken(config.tokenURL, {
       body: {

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

@@ -62,7 +62,7 @@ export function defineOAuthKeycloakEventHandler({
     }
     const accessToken = tokens.access_token;
     const user = await $fetch(
-      `${realmURL}/protocol/openid-connect/userinfo`,
+      `${realmURLInternal}/protocol/openid-connect/userinfo`,
       {
         headers: {
           Authorization: `Bearer ${accessToken}`,

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

@@ -17,10 +17,13 @@ export function defineOAuthLineEventHandler({
     });
     const query = getQuery(event);
     if (query.error) {
-      return onError(
-        event,
-        new Error(`Line login failed: ${query.error || "Unknown error"}`)
-      );
+      const error = createError({
+        statusCode: 401,
+        message: `Line login failed: ${query.error || "Unknown error"}`,
+        data: query
+      });
+      if (!onError) throw error;
+      return onError(event, error);
     }
     if (!config.clientId || !config.clientSecret) {
       return handleMissingConfiguration(event, "line", ["clientId", "clientSecret"], onError);

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

@@ -46,7 +46,7 @@ export function defineOAuthSalesforceEventHandler({
       );
     }
     if (query.state !== state) {
-      handleInvalidState(event, "salesforce", onError);
+      return handleInvalidState(event, "salesforce", onError);
     }
     const tokens = await requestAccessToken(config.tokenURL, {
       body: {

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

@@ -92,4 +92,7 @@ export interface OAuthSeznamUser {
      */
     gender?: string | null;
 }
-export declare function defineOAuthSeznamEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSeznamConfig, OAuthSeznamUser>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export declare function defineOAuthSeznamEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSeznamConfig, {
+    user: OAuthSeznamUser;
+    tokens: unknown;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -46,7 +46,7 @@ export function defineOAuthSlackEventHandler({
       );
     }
     if (query.state !== state) {
-      handleInvalidState(event, "slack", onError);
+      return handleInvalidState(event, "slack", onError);
     }
     const tokens = await requestAccessToken(config.tokenURL, {
       body: {

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

@@ -63,7 +63,7 @@ export function defineOAuthSteamEventHandler({ config, onSuccess, onError }) {
     }
     const idRegex = /^https?:\/\/steamcommunity\.com\/openid\/id\/(\d+)$/;
     const steamIdCheck = idRegex.exec(query["openid.claimed_id"]);
-    const steamId = steamIdCheck[1];
+    const steamId = steamIdCheck?.[1];
     const user = await $fetch(withQuery("https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v2/", {
       key: config.apiKey,
       steamids: steamId

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

@@ -113,4 +113,7 @@ export interface OAuthStravaTokens {
     athlete: OAuthStravaUser;
     error?: string;
 }
-export declare function defineOAuthStravaEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthStravaConfig, OAuthStravaUser>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export declare function defineOAuthStravaEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthStravaConfig, {
+    user: OAuthStravaUser;
+    tokens: OAuthStravaTokens;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

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

@@ -60,4 +60,7 @@ export interface OAuthWorkOSTokens {
     access_token: string;
     refresh_token: string;
 }
-export declare function defineOAuthWorkOSEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthWorkOSConfig, OAuthWorkOSUser, OAuthWorkOSTokens>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export declare function defineOAuthWorkOSEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthWorkOSConfig, {
+    user: OAuthWorkOSUser;
+    tokens: OAuthWorkOSTokens;
+}>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

package/dist/runtime/server/lib/webauthn/register.d.ts

@@ -1,6 +1,6 @@
 import type { H3Event } from 'h3';
+import type { ValidateUserFunction } from '../../../types/webauthn.js';
 import type { WebAuthnUser, WebAuthnRegisterEventHandlerOptions } from '#auth-utils';
-import type { ValidateUserFunction } from '~/src/runtime/types/webauthn';
 export declare function defineWebAuthnRegisterEventHandler<T extends WebAuthnUser>({ storeChallenge, getChallenge, getOptions, validateUser, excludeCredentials, onSuccess, onError, }: WebAuthnRegisterEventHandlerOptions<T>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void | import("@simplewebauthn/server").VerifiedRegistrationResponse | {
     creationOptions: import("@simplewebauthn/types").PublicKeyCredentialCreationOptionsJSON;
     attemptId: string;

package/dist/runtime/server/utils/atproto.js

@@ -1,6 +1,7 @@
+import { getRequestURL } from "h3";
 import { getOAuthRedirectURL } from "../lib/utils.js";
 import { getClientMetadataFilename } from "../../utils/atproto.js";
-import { getRequestURL, useRuntimeConfig } from "#imports";
+import { useRuntimeConfig } from "#imports";
 export function getAtprotoClientMetadata(event, provider, config) {
   const providerRuntimeConfig = useRuntimeConfig(event).oauth[provider];
   const scopes = [.../* @__PURE__ */ new Set(["atproto", ...config?.scope ?? [], ...providerRuntimeConfig.scope ?? []])];

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

@@ -27,13 +27,13 @@ export declare function getUserSession(event: UseSessionEvent): Promise<UserSess
  * @param data User session data, please only store public information since it can be decoded with API calls
  * @see https://github.com/atinux/nuxt-auth-utils
  */
-export declare function setUserSession(event: H3Event, data: UserSession, config?: Partial<SessionConfig>): Promise<UserSession>;
+export declare function setUserSession(event: H3Event, data: Omit<UserSession, 'id'>, config?: Partial<SessionConfig>): Promise<UserSession>;
 /**
  * Replace a user session
  * @param event The Request (h3) event
  * @param data User session data, please only store public information since it can be decoded with API calls
  */
-export declare function replaceUserSession(event: H3Event, data: UserSession, config?: Partial<SessionConfig>): Promise<UserSession>;
+export declare function replaceUserSession(event: H3Event, data: Omit<UserSession, 'id'>, config?: Partial<SessionConfig>): Promise<UserSession>;
 /**
  * Clear the user session and removing the session cookie
  * @param event The Request (h3) event

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

@@ -6,8 +6,8 @@ export const sessionHooks = createHooks();
 export async function getUserSession(event) {
   const session = await _useSession(event);
   return {
-    id: session.id,
-    ...session.data
+    ...session.data,
+    id: session.id
   };
 }
 export async function setUserSession(event, data, config) {

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

@@ -2,11 +2,11 @@ import type { H3Event, H3Error } from 'h3';
 export type ATProtoProvider = 'bluesky';
 export type OAuthProvider = ATProtoProvider | 'atlassian' | 'auth0' | 'authentik' | 'azureb2c' | 'battledotnet' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'gitea' | 'github' | 'gitlab' | 'google' | 'hubspot' | 'instagram' | 'kick' | 'keycloak' | 'line' | 'linear' | 'linkedin' | 'microsoft' | 'paypal' | 'polar' | 'spotify' | 'seznam' | 'steam' | 'strava' | 'tiktok' | 'twitch' | 'vk' | 'workos' | 'x' | 'xsuaa' | 'yandex' | 'zitadel' | 'apple' | 'livechat' | 'salesforce' | 'slack' | 'heroku' | (string & {});
 export type OnError = (event: H3Event, error: H3Error) => Promise<void> | void;
-export interface OAuthConfig<TConfig, TUser = any, TTokens = any> {
+export interface OAuthConfig<TConfig, TResult = {
+    user: any;
+    tokens: any;
+}> {
     config?: TConfig;
-    onSuccess: (event: H3Event, result: {
-        user: TUser;
-        tokens: TTokens;
-    }) => Promise<void> | void;
+    onSuccess: (event: H3Event, result: TResult) => Promise<void> | void;
     onError?: OnError;
 }

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

@@ -7,7 +7,7 @@ export interface UserSession {
     /**
      * Session ID
      */
-    id?: string;
+    id: string;
     /**
      * User session data, available on client and server
      */
@@ -22,7 +22,6 @@ export interface UserSession {
     [key: string]: unknown;
 }
 export interface UserSessionRequired extends UserSession {
-    id: string;
     user: User;
 }
 export interface UserSessionComposable {
@@ -41,7 +40,7 @@ export interface UserSessionComposable {
     /**
      * The session object.
      */
-    session: Ref<UserSession>;
+    session: Ref<UserSession | null>;
     /**
      * Fetch the user session from the server.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.5.19",
+  "version": "0.5.21",
   "description": "Add Authentication to Nuxt applications with secured & sealed cookies sessions.",
   "repository": {
     "type": "git",
@@ -31,7 +31,7 @@
     "lint:fix": "eslint . --fix",
     "test": "vitest run",
     "test:types": "vue-tsc --noEmit",
-    "test:types:playground": "cd playground && vue-tsc --noEmit",
+    "test:types:playground": "nuxt typecheck playground",
     "test:watch": "vitest watch"
   },
   "dependencies": {