nuxt-auth-utils 0.0.6 → 0.0.8

package/README.md

@@ -53,13 +53,13 @@ export default defineNuxtConfig({
 NUXT_SESSION_PASSWORD=password-with-at-least-32-characters
 ```
 
-Nuxt Auth Core can generate one for you when running Nuxt in development the first time when no `NUXT_SESSION_PASSWORD` is set.
+Nuxt Auth Utils can generate one for you when running Nuxt in development the first time when no `NUXT_SESSION_PASSWORD` is set.
 
 4. That's it! You can now add authentication to your Nuxt app ✨
 
 ## Vue Composables
 
-Nuxt Neo automatically add some plugins to fetch the current user session to let you access it from your Vue components.
+Nuxt Auth Utils automatically adds some plugins to fetch the current user session to let you access it from your Vue components.
 
 ### User Session
 
@@ -108,7 +108,7 @@ await clearUserSession(event)
 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:
+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:
 
 ```ts
 declare module '#auth-utils' {
@@ -116,6 +116,7 @@ declare module '#auth-utils' {
     // define the type here
   }
 }
+export {}
 ```
 
 ### OAuth Event Handlers

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.0.6"
+  "version": "0.0.8"
 }

package/dist/module.mjs

@@ -17,7 +17,7 @@ const module = defineNuxtModule({
       console.warn("No session password set, using a random password, please set NUXT_SESSION_PASSWORD in your .env file with at least 32 chars");
       console.log(`NUXT_SESSION_PASSWORD=${randomPassword}`);
     }
-    nuxt.options.alias["#auth-utils"] = resolver.resolve("./runtime/types/auth-utils-session");
+    nuxt.options.alias["#auth-utils"] = resolver.resolve("./runtime/types/index");
     addImportsDir(resolver.resolve("./runtime/composables"));
     addPlugin(resolver.resolve("./runtime/plugins/session.server"));
     if (nuxt.options.nitro.imports !== false) {
@@ -52,7 +52,10 @@ const module = defineNuxtModule({
     const runtimeConfig = nuxt.options.runtimeConfig;
     runtimeConfig.session = defu(runtimeConfig.session, {
       name: "nuxt-session",
-      password: ""
+      password: "",
+      cookie: {
+        sameSite: "lax"
+      }
     });
     runtimeConfig.oauth = defu(runtimeConfig.oauth, {});
     runtimeConfig.oauth.github = defu(runtimeConfig.oauth.github, {

package/dist/runtime/composables/session.mjs

@@ -11,7 +11,11 @@ export const useUserSession = () => {
   };
 };
 async function fetch() {
-  useSessionState().value = await useRequestFetch()("/api/_auth/session").catch(() => ({}));
+  useSessionState().value = await useRequestFetch()("/api/_auth/session", {
+    headers: {
+      Accept: "text/json"
+    }
+  }).catch(() => ({}));
 }
 async function clear() {
   await $fetch("/api/_auth/session", { method: "DELETE" });

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthAuth0Config {
     /**
      * Auth0 OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthAuth0Config {
      */
     emailRequired?: boolean;
 }
-interface OAuthConfig {
-    config?: OAuthAuth0Config;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthAuth0Config>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthBattledotnetConfig {
     /**
      * Battle.net OAuth Client ID
@@ -35,13 +35,4 @@ export interface OAuthBattledotnetConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthBattledotnetConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function battledotnetEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function battledotnetEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthBattledotnetConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthDiscordConfig {
     /**
      * Discord OAuth Client ID
@@ -39,13 +39,4 @@ export interface OAuthDiscordConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthDiscordConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function discordEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function discordEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthDiscordConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthGitHubConfig {
     /**
      * GitHub OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthGitHubConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthGitHubConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function githubEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function githubEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthGitHubConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthGoogleConfig {
     /**
      * Google OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthGoogleConfig {
      */
     redirectUrl: '/auth/google';
 }
-interface OAuthConfig {
-    config?: OAuthGoogleConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function googleEventHandler({ config, onSuccess, onError, }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function googleEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthGoogleConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthSpotifyConfig {
     /**
      * Spotify OAuth Client ID
@@ -33,13 +33,4 @@ export interface OAuthSpotifyConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthSpotifyConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSpotifyConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3';
+import type { OAuthConfig } from '#auth-utils';
 export interface OAuthTwitchConfig {
     /**
      * Twitch Client ID
@@ -33,13 +33,4 @@ export interface OAuthTwitchConfig {
      */
     tokenURL?: string;
 }
-interface OAuthConfig {
-    config?: OAuthTwitchConfig;
-    onSuccess: (event: H3Event, result: {
-        user: any;
-        tokens: any;
-    }) => Promise<void> | void;
-    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-export declare function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export {};
+export declare function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthTwitchConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;

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

@@ -0,0 +1,2 @@
+export type { UserSession } from './session';
+export type { OAuthConfig } from './oauth-config';

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

@@ -0,0 +1,10 @@
+import type { H3Event, H3Error } from 'h3';
+import type { UserSession } from '#auth-utils';
+export interface OAuthConfig<TConfig, TUser = UserSession, TTokens = any> {
+    config?: TConfig;
+    onSuccess: (event: H3Event, result: {
+        user: TUser;
+        tokens: TTokens;
+    }) => Promise<void> | void;
+    onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -30,25 +30,25 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.8.1",
+    "@nuxt/kit": "^3.8.2",
     "defu": "^6.1.3",
     "ofetch": "^1.3.3",
     "ohash": "^1.1.3"
   },
   "devDependencies": {
-    "@iconify-json/simple-icons": "^1.1.78",
+    "@iconify-json/simple-icons": "^1.1.79",
     "@nuxt/devtools": "latest",
     "@nuxt/eslint-config": "^0.2.0",
     "@nuxt/module-builder": "^0.5.4",
-    "@nuxt/schema": "^3.8.1",
+    "@nuxt/schema": "^3.8.2",
     "@nuxt/test-utils": "^3.8.1",
     "@nuxt/ui": "^2.10.0",
     "@nuxt/ui-pro": "^0.4.2",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.9.3",
     "changelogen": "^0.5.5",
-    "eslint": "^8.53.0",
-    "nuxt": "^3.8.1",
-    "typescript": "^5.2.2",
+    "eslint": "^8.54.0",
+    "nuxt": "^3.8.2",
+    "typescript": "^5.3.2",
     "vitest": "^0.34.6",
     "vue-tsc": "^1.8.22"
   }