nuxt-auth-utils 0.0.2 → 0.0.4

package/README.md

@@ -107,6 +107,16 @@ 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:
+
+```ts
+declare module '#auth-utils' {
+  interface UserSession {
+    // define the type here
+  }
+}
+```
+
 ### OAuth Event Handlers
 
 All helpers are exposed from the `oauth` global variable and can be used in your server routes or API routes.

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "auth-core",
   "configKey": "auth",
-  "version": "0.0.2"
+  "version": "0.0.4"
 }

package/dist/module.mjs

@@ -12,16 +12,35 @@ const module = defineNuxtModule({
   setup(options, nuxt) {
     const resolver = createResolver(import.meta.url);
     if (!process.env.NUXT_SESSION_PASSWORD) {
-      console.warn("No session password set, using a random password, please set NUXT_SESSION_PASSWORD in your .env file with at least 32 chars");
       const randomPassword = sha256(`${Date.now()}${Math.random()}`).slice(0, 32);
-      console.log(`NUXT_SESSION_PASSWORD=${randomPassword}`);
       process.env.NUXT_SESSION_PASSWORD = randomPassword;
+      if (!nuxt.options._prepare) {
+        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");
     addImportsDir(resolver.resolve("./runtime/composables"));
     addPlugin(resolver.resolve("./runtime/plugins/session.server"));
-    nuxt.options.nitro.imports = nuxt.options.nitro.imports || {};
-    nuxt.options.nitro.imports.dirs = nuxt.options.nitro.imports.dirs || [];
-    nuxt.options.nitro.imports.dirs.push(resolver.resolve("./runtime/server/utils"));
+    if (nuxt.options.nitro.imports !== false) {
+      nuxt.options.nitro.imports = defu(nuxt.options.nitro.imports, {
+        presets: [
+          {
+            from: resolver.resolve("./runtime/server/utils/oauth"),
+            imports: ["oauth"]
+          },
+          {
+            from: resolver.resolve("./runtime/server/utils/session"),
+            imports: [
+              "getUserSession",
+              "setUserSession",
+              "clearUserSession",
+              "requireUserSession"
+            ]
+          }
+        ]
+      });
+    }
     addServerHandler({
       handler: resolver.resolve("./runtime/server/api/session.delete"),
       route: "/api/_auth/session",

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

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<import("../utils/session").UserSession>>;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<UserSession>>;
 export default _default;

package/dist/runtime/server/lib/oauth/github.mjs

@@ -2,6 +2,7 @@ import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from
 import { ofetch } from "ofetch";
 import { withQuery } from "ufo";
 import { defu } from "defu";
+import { useRuntimeConfig } from "#imports";
 export function githubEventHandler({ config, onSuccess, onError }) {
   return eventHandler(async (event) => {
     config = defu(config, useRuntimeConfig(event).oauth?.github, {

package/dist/runtime/server/lib/oauth/spotify.mjs

@@ -2,6 +2,7 @@ import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from
 import { withQuery, parsePath } from "ufo";
 import { ofetch } from "ofetch";
 import { defu } from "defu";
+import { useRuntimeConfig } from "#imports";
 export function spotifyEventHandler({ config, onSuccess, onError }) {
   return eventHandler(async (event) => {
     config = defu(config, useRuntimeConfig(event).oauth?.spotify, {

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

@@ -1,8 +1,5 @@
 import type { H3Event } from 'h3';
-export interface UserSession {
-    user?: any;
-    [key: string]: any;
-}
+import type { UserSession } from '#auth-utils';
 export declare function getUserSession(event: H3Event): Promise<UserSession>;
 /**
  * Set a user session

package/dist/runtime/types/auth-utils-session.d.ts

@@ -0,0 +1,3 @@
+export interface UserSession {
+    user?: {};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -25,10 +25,12 @@
     "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
     "lint": "eslint .",
     "test": "vitest run",
+    "test:types": "vue-tsc --noEmit",
+    "test:types:playground": "cd playground && vue-tsc --noEmit",
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.8.0",
+    "@nuxt/kit": "^3.8.1",
     "defu": "^6.1.3",
     "ohash": "^1.1.3"
   },
@@ -37,14 +39,16 @@
     "@nuxt/devtools": "latest",
     "@nuxt/eslint-config": "^0.2.0",
     "@nuxt/module-builder": "^0.5.2",
-    "@nuxt/schema": "^3.8.0",
-    "@nuxt/test-utils": "^3.8.0",
+    "@nuxt/schema": "^3.8.1",
+    "@nuxt/test-utils": "^3.8.1",
     "@nuxt/ui": "^2.10.0",
     "@nuxt/ui-pro": "^0.4.2",
     "@types/node": "^20.8.9",
     "changelogen": "^0.5.5",
     "eslint": "^8.52.0",
-    "nuxt": "^3.8.0",
-    "vitest": "^0.33.0"
+    "nuxt": "^3.8.1",
+    "typescript": "^5.2.2",
+    "vitest": "^0.33.0",
+    "vue-tsc": "^1.8.22"
   }
 }