Structure Changes

 - Moved providers into runtime folder, you still need to use #auth/providers to access them externally, this is just for structure internally.

- Added hasOwn to utils. In the event that your browser does not support hasOwn it will use Object.prototype.hasOwnProperty.call instead which is functionally the same.

- Some type fixes

build.config.ts

@@ -16,7 +16,6 @@ export default defineBuildConfig({
         { input: 'src/types/', outDir: 'dist/types', ext: 'd.ts' },
         { input: 'src/runtime/', outDir: 'dist/runtime', ext: 'mjs' },
         { input: 'src/utils/', outDir: 'dist/utils', ext: 'mjs' },
-        { input: 'src/providers/', outDir: 'dist/providers', ext: 'mjs' },
     ],
     rollup: {
         emitCJS: false,

src/module.ts

@@ -69,14 +69,14 @@ export default defineNuxtModule({
         const runtime = resolver.resolve('runtime');
         nuxt.options.alias['#auth/runtime'] = runtime;
 
+        // Providers
+        const providers = resolver.resolve('runtime/providers');
+        nuxt.options.alias['#auth/providers'] = providers;
+
         // Utils
         const utils = resolver.resolve('utils');
         nuxt.options.alias['#auth/utils'] = utils;
 
-        // Providers
-        const providers = resolver.resolve('providers');
-        nuxt.options.alias['#auth/providers'] = providers;
-
         // Transpile
         nuxt.options.build.transpile.push(runtime, providers, utils)
 

src/plugin.ts

@@ -1,5 +1,5 @@
-import { ImportOptions } from './resolve';
-import { ModuleOptions, Strategy } from './types';
+import type { ImportOptions } from './resolve';
+import type { ModuleOptions, Strategy } from './types';
 
 export const getAuthDTS = () => {
 return `import type { Plugin } from '#app'

src/resolve.ts

@@ -1,12 +1,12 @@
 import type { Strategy, ModuleOptions } from './types';
 import type { Nuxt } from '@nuxt/schema';
-import { ProviderAliases } from './providers';
-import * as AUTH_PROVIDERS from './providers';
+import { ProviderAliases } from './runtime/providers';
+import * as AUTH_PROVIDERS from './runtime/providers';
 import { resolvePath } from '@nuxt/kit';
 import { existsSync } from 'fs';
 import { hash } from 'ohash';
 
-const BuiltinSchemes = {
+export const BuiltinSchemes = {
     local: 'LocalScheme',
     cookie: 'CookieScheme',
     oauth2: 'Oauth2Scheme',
@@ -22,7 +22,7 @@ export interface ImportOptions {
     from: string;
 }
 
-export async function resolveStrategies(nuxt: Nuxt, options: ModuleOptions): Promise<{ strategies: Strategy[]; strategyScheme: Record<string, ImportOptions>; }> {
+export async function resolveStrategies(nuxt: Nuxt, options: ModuleOptions) {
     const strategies: Strategy[] = [];
     const strategyScheme = {} as Record<string, ImportOptions>;
 
@@ -78,7 +78,7 @@ export async function resolveStrategies(nuxt: Nuxt, options: ModuleOptions): Pro
     };
 }
 
-export async function resolveScheme(scheme: string): Promise<ImportOptions | void> {
+export async function resolveScheme(scheme: string) {
     if (typeof scheme !== 'string') {
         return;
     }

src/runtime/core/auth.ts

@@ -1,6 +1,6 @@
 import type { HTTPRequest, HTTPResponse, Scheme, SchemeCheck, TokenableScheme, RefreshableScheme, ModuleOptions, Route, AuthState } from '../../types';
 import type { NuxtApp } from '#app';
-import { isSet, getProp, routeMeta, isRelativeURL } from '../../utils';
+import { isSet, getProp, routeMeta, isRelativeURL, hasOwn } from '../../utils';
 import { navigateTo, useRoute, useRouter } from "#imports";
 import { Storage } from './storage';
 import { isSamePath, withQuery } from 'ufo';
@@ -113,7 +113,7 @@ export class Auth {
             if (process.client && this.options.watchLoggedIn) {
                 this.$storage.watchState('loggedIn', (loggedIn: boolean) => {
                     if (this.$state.loggedIn === loggedIn) return;
-                    if (Object.hasOwn(useRoute().meta, 'auth') && !routeMeta(useRoute(), 'auth', false)) {
+                    if (hasOwn(useRoute().meta, 'auth') && !routeMeta(useRoute(), 'auth', false)) {
                         this.redirect(loggedIn ? 'home' : 'logout');
                     }
                 });

src/runtime/core/middleware.ts

@@ -1,4 +1,4 @@
-import { routeMeta, getMatchedComponents, normalizePath } from '../../utils';
+import { routeMeta, getMatchedComponents, normalizePath, hasOwn } from '../../utils';
 import { useNuxtApp, defineNuxtRouteMiddleware } from '#imports';
 
 export default defineNuxtRouteMiddleware(async (to, from) => {
@@ -19,7 +19,7 @@ export default defineNuxtRouteMiddleware(async (to, from) => {
 
     const { login, callback } = ctx.$auth.options.redirect;
 
-    const pageIsInGuestMode = Object.hasOwn(to.meta, 'auth') && routeMeta(to, 'auth', 'guest');
+    const pageIsInGuestMode = hasOwn(to.meta, 'auth') && routeMeta(to, 'auth', 'guest');
 
     const insidePage = (page: string) => normalizePath(to.path) === normalizePath(page);
 

src/runtime/core/storage.ts

@@ -45,7 +45,7 @@ export class Storage {
         this.setSessionStorage(key, value);
 
         // Local state
-        this.setState(key as keyof AuthState, value);
+        this.setState(key, value);
 
         return value;
     }
@@ -55,7 +55,7 @@ export class Storage {
 
         // Local state
         if (process.server) {
-            value = this.getState(key as keyof AuthState);
+            value = this.getState(key);
         }
 
         // Cookies
@@ -75,7 +75,7 @@ export class Storage {
 
         // Local state
         if (isUnset(value)) {
-            value = this.getState(key as keyof AuthState);
+            value = this.getState(key);
         }
 
         return value;
@@ -96,7 +96,7 @@ export class Storage {
     }
 
     removeUniversal(key: string): void {
-        this.removeState(key as keyof AuthState);
+        this.removeState(key);
         this.removeCookie(key);
         this.removeLocalStorage(key);
         this.removeSessionStorage(key);
@@ -147,8 +147,8 @@ export class Storage {
         return this.#initStore;
     }
 
-    setState(key: keyof AuthState, value: any) {
-        if (key[0] === '_') {
+    setState(key: string, value: any) {
+        if (key.startsWith('_')) {
             this.#state[key] = value;
         }
         else if (this.#piniaEnabled) {
@@ -159,14 +159,14 @@ export class Storage {
             this.state[key] = value;
         }
 
-        return value;
+        return this.state[key];
     }
 
-    getState(key: keyof AuthState) {
-        if (key[0] !== '_') {
+    getState(key: string) {
+        if (!key.startsWith('_')) {
             return this.state[key];
         } else {
-            return this.#state[key];
+            return this.#state[key] as AuthState;
         }
     }
 
@@ -183,7 +183,7 @@ export class Storage {
         }
     }
 
-    removeState(key: keyof AuthState): void {
+    removeState(key: string): void {
         this.setState(key, undefined);
     }
 

src/runtime/inc/configuration-document.ts

@@ -32,8 +32,8 @@ export class ConfigurationDocument {
         return this.$storage.setState(this.key, value);
     }
 
-    get(): OpenIDConnectConfigurationDocument {
-        return this.$storage.getState(this.key);
+    get() {
+        return this.$storage.getState(this.key) as OpenIDConnectConfigurationDocument;
     }
 
     set(value: OpenIDConnectConfigurationDocument | boolean) {
@@ -44,8 +44,7 @@ export class ConfigurationDocument {
 
     async request() {
         // Get Configuration document from state hydration
-        // @ts-ignore
-        const serverDoc: OpenIDConnectConfigurationDocument = this.scheme.$auth.ctx.payload!.data.$auth?.openIDConnect?.configurationDocument;
+        const serverDoc: OpenIDConnectConfigurationDocument = this.scheme.$auth.ctx.payload.data.$auth?.openIDConnect?.configurationDocument;
 
         if (process.client && serverDoc) {
             this.set(serverDoc);

src/runtime/inc/request-handler.ts

@@ -1,6 +1,6 @@
 import type { TokenableScheme, RefreshableScheme } from '../../types';
 import { ExpiredAuthSessionError } from './expired-auth-session-error';
-import { FetchInstance, FetchConfig } from '@refactorjs/ofetch'
+import { FetchInstance, FetchConfig } from '@refactorjs/ofetch';
 
 export class RequestHandler {
     scheme: TokenableScheme | RefreshableScheme;

src/runtime/index.ts

@@ -1,3 +1,3 @@
 export * from "./core";
 export * from "./inc";
-export * from "./schemes";
+export * from "./schemes";

src/providers/auth0.ts → src/runtime/providers/auth0.ts

@@ -1,7 +1,7 @@
-import type { ProviderOptions, ProviderPartialOptions } from '../types';
-import type { Oauth2SchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignDefaults } from '../utils/provider';
+import type { ProviderOptions, ProviderPartialOptions } from '../../types';
+import type { Oauth2SchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignDefaults } from '../../utils/provider';
 
 export interface Auth0ProviderOptions extends ProviderOptions, Oauth2SchemeOptions {
     domain: string;

src/providers/discord.ts → src/runtime/providers/discord.ts

@@ -1,7 +1,7 @@
-import type { ProviderOptions, ProviderPartialOptions } from '../types';
-import type { Oauth2SchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignDefaults, addAuthorize } from '../utils/provider';
+import type { ProviderOptions, ProviderPartialOptions } from '../../types';
+import type { Oauth2SchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignDefaults, addAuthorize } from '../../utils/provider';
 
 export interface DiscordProviderOptions extends ProviderOptions, Oauth2SchemeOptions {}
 

src/providers/facebook.ts → src/runtime/providers/facebook.ts

@@ -1,7 +1,7 @@
-import type { ProviderPartialOptions, ProviderOptions } from '../types';
-import type { Oauth2SchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignDefaults } from '../utils/provider';
+import type { ProviderPartialOptions, ProviderOptions } from '../../types';
+import type { Oauth2SchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignDefaults } from '../../utils/provider';
 
 export interface FacebookProviderOptions extends ProviderOptions, Oauth2SchemeOptions {}
 

src/providers/github.ts → src/runtime/providers/github.ts

@@ -1,7 +1,7 @@
-import type { ProviderOptions, ProviderPartialOptions } from '../types';
-import type { Oauth2SchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignDefaults, addAuthorize } from '../utils/provider';
+import type { ProviderOptions, ProviderPartialOptions } from '../../types';
+import type { Oauth2SchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignDefaults, addAuthorize } from '../../utils/provider';
 
 export interface GithubProviderOptions extends ProviderOptions, Oauth2SchemeOptions {}
 

src/providers/google.ts → src/runtime/providers/google.ts

@@ -1,7 +1,7 @@
-import type { ProviderPartialOptions, ProviderOptions } from '../types';
-import type { Oauth2SchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignDefaults } from '../utils/provider';
+import type { ProviderPartialOptions, ProviderOptions } from '../../types';
+import type { Oauth2SchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignDefaults } from '../../utils/provider';
 
 export interface GoogleProviderOptions extends ProviderOptions, Oauth2SchemeOptions {}
 

src/providers/laravel-jwt.ts → src/runtime/providers/laravel-jwt.ts

@@ -1,7 +1,7 @@
-import type { ProviderPartialOptions, ProviderOptions } from '../types';
-import type { RefreshSchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignDefaults, assignAbsoluteEndpoints } from '../utils/provider';
+import type { ProviderPartialOptions, ProviderOptions } from '../../types';
+import type { RefreshSchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignDefaults, assignAbsoluteEndpoints } from '../../utils/provider';
 
 export interface LaravelJWTProviderOptions extends ProviderOptions, RefreshSchemeOptions {
     url: string;

src/providers/laravel-passport.ts → src/runtime/providers/laravel-passport.ts

@@ -1,7 +1,7 @@
-import type { RefreshTokenOptions, TokenOptions, UserOptions, RecursivePartial, ProviderPartialOptions, ProviderOptions } from '../types';
-import type { Oauth2SchemeOptions, RefreshSchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignDefaults, addAuthorize, initializePasswordGrantFlow, assignAbsoluteEndpoints } from '../utils/provider';
+import type { RefreshTokenOptions, TokenOptions, UserOptions, RecursivePartial, ProviderPartialOptions, ProviderOptions } from '../../types';
+import type { Oauth2SchemeOptions, RefreshSchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignDefaults, addAuthorize, initializePasswordGrantFlow, assignAbsoluteEndpoints } from '../../utils/provider';
 
 export interface LaravelPassportProviderOptions extends ProviderOptions, Oauth2SchemeOptions {
     url: string;

src/providers/laravel-sanctum.ts → src/runtime/providers/laravel-sanctum.ts

@@ -1,7 +1,7 @@
-import type { ProviderPartialOptions, HTTPRequest, ProviderOptions } from '../types';
-import type { CookieSchemeOptions } from '../runtime';
-import type { Nuxt } from '@nuxt/schema'
-import { assignAbsoluteEndpoints, assignDefaults } from '../utils/provider';
+import type { ProviderPartialOptions, HTTPRequest, ProviderOptions } from '../../types';
+import type { CookieSchemeOptions } from '..';
+import type { Nuxt } from '@nuxt/schema';
+import { assignAbsoluteEndpoints, assignDefaults } from '../../utils/provider';
 
 export interface LaravelSanctumProviderOptions extends ProviderOptions, CookieSchemeOptions {}
 

src/runtime/schemes/oauth2.ts

@@ -1,9 +1,9 @@
 import type { RefreshableScheme, SchemePartialOptions, SchemeCheck, RefreshableSchemeOptions, UserOptions, SchemeOptions, HTTPResponse, EndpointsOption, TokenableSchemeOptions } from '../../types';
-import type { IncomingMessage } from 'http'
+import type { IncomingMessage } from 'node:http';
 import type { Auth } from '../core';
 import { getProp, normalizePath, randomString, removeTokenPrefix, parseQuery } from '../../utils';
 import { RefreshController, RequestHandler, ExpiredAuthSessionError, Token, RefreshToken } from '../inc';
-import { joinURL, withQuery } from 'ufo'
+import { joinURL, withQuery } from 'ufo';
 import { BaseScheme } from './base';
 import { useRoute, useRuntimeConfig } from '#imports';
 import requrl from 'requrl';
@@ -197,7 +197,7 @@ export class Oauth2Scheme<OptionsT extends Oauth2SchemeOptions = Oauth2SchemeOpt
         this.requestHandler.reset();
     }
 
-    async login($opts: { state?: string; params?: any; nonce?: string } = {}): Promise<void> {
+    async login(options: { state?: string; params?: any; nonce?: string } = {}): Promise<void> {
         const opts = {
             protocol: 'oauth2',
             response_type: this.options.responseType,
@@ -207,12 +207,12 @@ export class Oauth2Scheme<OptionsT extends Oauth2SchemeOptions = Oauth2SchemeOpt
             scope: this.scope,
             // Note: The primary reason for using the state parameter is to mitigate CSRF attacks.
             // https://auth0.com/docs/protocols/oauth2/oauth-state
-            state: $opts.state || randomString(10),
+            state: options.state || randomString(10),
             code_challenge_method: this.options.codeChallengeMethod,
             clientWindow: this.options.clientWindow,
             clientWindowWidth: this.options.clientWindowWidth,
             clientWindowHeight: this.options.clientWindowHeight,
-            ...$opts.params,
+            ...options.params,
         };
 
         if (this.options.organization) {
@@ -259,7 +259,7 @@ export class Oauth2Scheme<OptionsT extends Oauth2SchemeOptions = Oauth2SchemeOpt
         // Keycloak uses nonce for token as well, so support that too
         // https://github.com/nuxt-community/auth-module/pull/709
         if (opts.response_type.includes('token') || opts.response_type.includes('id_token')) {
-            opts.nonce = $opts.nonce || randomString(10);
+            opts.nonce = options.nonce || randomString(10);
         }
 
         if (opts.code_challenge_method) {

src/runtime/schemes/openIDConnect.ts

@@ -5,7 +5,7 @@ import { normalizePath, getProp, parseQuery } from '../../utils';
 import { IdToken, ConfigurationDocument } from '../inc';
 import { IdTokenableSchemeOptions } from '../../types';
 import { useRoute } from '#imports';
-import { withQuery, QueryObject, QueryValue } from 'ufo'
+import { withQuery, QueryObject, QueryValue } from 'ufo';
 
 export interface OpenIDConnectSchemeEndpoints extends Oauth2SchemeEndpoints {
     configuration: string;

src/types/index.d.ts

@@ -33,6 +33,7 @@ export interface UserInfo {
 }
 
 export type AuthState = {
+    [key: string]: unknown;
     // user object
     user?: UserInfo;
     // indicates whether the user is logged in

src/types/options.d.ts

@@ -1,5 +1,5 @@
 import type { Strategy } from './strategy';
-import type { NuxtPlugin } from '@nuxt/schema'
+import type { NuxtPlugin } from '@nuxt/schema';
 import type { PersistedStateOptions } from 'pinia-plugin-persistedstate';
 
 export interface ModuleOptions {

src/types/request.d.ts

@@ -1,4 +1,4 @@
-import { FetchConfig } from '@refactorjs/ofetch'
+import { FetchConfig } from '@refactorjs/ofetch';
 
 export type HTTPRequest = FetchConfig & {
     body?: Record<string, any>;

src/utils/index.ts

@@ -154,4 +154,6 @@ export function setH3Cookie(event: H3Event, serializedCookie: string) {
             (val) => val.startsWith(value.slice(0, value.indexOf('='))) 
         ) === index
     ));
-}
+}
+
+export const hasOwn = <O extends object, K extends PropertyKey>(object: O, key: K) => Object.hasOwn ? Object.hasOwn(object, key) : Object.prototype.hasOwnProperty.call(object, key);

src/utils/provider.ts

@@ -1,6 +1,6 @@
 import type { Oauth2SchemeOptions, RefreshSchemeOptions, LocalSchemeOptions, CookieSchemeOptions } from '../runtime';
 import type { StrategyOptions, HTTPRequest } from '../types';
-import type { Nuxt } from '@nuxt/schema'
+import type { Nuxt } from '@nuxt/schema';
 import { addServerHandler, addTemplate } from '@nuxt/kit';
 import { join } from 'pathe';
 import { defu } from 'defu';