@meistrari/auth-nuxt 3.3.3 → 3.3.5

package/dist/module.d.mts

@@ -1,5 +1,28 @@
 import { NuxtModule } from '@nuxt/schema';
 
+/**
+ * Configuration options for the `@meistrari/auth-nuxt` Nuxt module.
+ *
+ * Set these under the `telaAuth` key in your `nuxt.config.ts`:
+ *
+ * @example
+ * ```ts
+ * export default defineNuxtConfig({
+ *   modules: ['@meistrari/auth-nuxt'],
+ *   telaAuth: {
+ *     apiUrl: 'https://auth.example.com',
+ *     jwtCookieName: 'tela-jwt',
+ *     skipServerMiddleware: false,
+ *     application: {
+ *       enabled: true,
+ *       dashboardUrl: 'https://dashboard.example.com',
+ *       applicationId: 'app-123',
+ *       redirectUri: 'https://myapp.com/auth/callback',
+ *     },
+ *   },
+ * })
+ * ```
+ */
 interface ModuleOptions {
     /** Auth API base URL */
     apiUrl: string;
@@ -22,6 +45,17 @@ interface ModuleOptions {
         unauthorizedPath?: string;
     };
 }
+/**
+ * The `@meistrari/auth-nuxt` Nuxt module.
+ *
+ * Registers composables, plugins, server middleware, and server routes for
+ * authentication. Supports two modes:
+ *
+ * - **Application mode** (`application.enabled: true`): OAuth 2.0 PKCE flow with
+ *   access/refresh token management, role-based route guards, and organization switching.
+ * - **Session mode** (default): JWT handshake-based authentication with session
+ *   and organization composables.
+ */
 declare const module$1: NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { module$1 as default };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@meistrari/auth-nuxt",
   "configKey": "telaAuth",
-  "version": "3.3.3",
+  "version": "3.3.5",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/runtime/composables/state.d.ts

@@ -42,6 +42,12 @@ export declare function useOrganizationState(): {
         };
     } | null>;
 };
+/**
+ * Shared state for application-mode authentication.
+ * This module provides access to user and organization state for the OAuth 2.0 PKCE flow.
+ *
+ * @returns An object containing reactive references to the current user and active organization
+ */
 export declare function useApplicationSessionState(): {
     user: Ref<User | null>;
     activeOrganization: Ref<FullOrganization | null>;

package/dist/runtime/server/middleware/application-auth.d.ts

@@ -1,4 +1,22 @@
 import type { AuthenticatedH3Event } from '../types/h3.js';
+/**
+ * Creates a server middleware that verifies the JWT token using JWKS and calls
+ * the provided handler with an authenticated event context.
+ *
+ * Use this to wrap individual route handlers when the global middleware is disabled
+ * via `skipServerMiddleware: true` in application authentication mode.
+ *
+ * @param callback - The event handler to call with the authenticated event
+ * @returns An H3 event handler with authentication context
+ *
+ * @example
+ * ```ts
+ * export default meistrariApplicationAuthMiddleware(async (event) => {
+ *   const user = event.context.auth.user
+ *   return { user }
+ * })
+ * ```
+ */
 export declare function meistrariApplicationAuthMiddleware(callback: (event: AuthenticatedH3Event) => void | Promise<void>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
 declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
 export default _default;

package/dist/runtime/server/middleware/auth.d.ts

@@ -1,4 +1,22 @@
 import type { AuthenticatedH3Event } from '../types/h3.js';
+/**
+ * Creates a server middleware that validates the JWT token and calls the provided
+ * handler with an authenticated event context.
+ *
+ * Use this to wrap individual route handlers when the global middleware is disabled
+ * via `skipServerMiddleware: true`.
+ *
+ * @param callback - The event handler to call with the authenticated event
+ * @returns An H3 event handler with authentication context
+ *
+ * @example
+ * ```ts
+ * export default meistrariAuthMiddleware(async (event) => {
+ *   const user = event.context.auth.user
+ *   return { user }
+ * })
+ * ```
+ */
 export declare function meistrariAuthMiddleware(callback: (event: AuthenticatedH3Event) => void | Promise<void>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
 declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
 export default _default;

package/dist/runtime/server/routes/auth/logout.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Server route handler for user logout
+ *
+ * This route:
+ * 1. Deletes the access and refresh token cookies
+ * 2. Calls the auth API to invalidate the refresh token server-side
+ * 3. Returns success even if the remote invalidation fails (local logout is sufficient)
+ */
 declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<{
     success: boolean;
 }>>;

package/dist/runtime/server/routes/auth/whoami.d.ts

@@ -1,4 +1,12 @@
 import type { FullOrganization, User } from '@meistrari/auth-core';
+/**
+ * Server route handler for retrieving the current user and active organization
+ *
+ * This route:
+ * 1. Retrieves the access token from the cookie
+ * 2. Calls the auth API to get the current user and organization data
+ * 3. Returns the user and organization
+ */
 declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<{
     success: boolean;
     user: User;

package/dist/runtime/shared.d.ts

@@ -1,2 +1,13 @@
 import { AuthClient } from '@meistrari/auth-core';
+/**
+ * Creates an {@link AuthClient} instance configured for use within a Nuxt application.
+ *
+ * Automatically sets the `X-User-Agent` header with SDK version and service name,
+ * and attaches authorization and refresh token headers to outgoing requests.
+ *
+ * @param apiUrl - The base URL of the authentication API
+ * @param getAuthToken - Function that returns the current JWT access token, or `null` if not available
+ * @param getRefreshToken - Function that returns the current refresh token, or `null` if not available
+ * @returns A configured {@link AuthClient} instance
+ */
 export declare function createNuxtAuthClient(apiUrl: string, getAuthToken: () => string | null, getRefreshToken?: () => string | null): AuthClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meistrari/auth-nuxt",
-  "version": "3.3.3",
+  "version": "3.3.5",
   "type": "module",
   "exports": {
     ".": {
@@ -32,7 +32,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build"
+    "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build",
+    "docs": "typedoc"
   },
   "dependencies": {
     "@meistrari/auth-core": "1.15.0",
@@ -54,6 +55,8 @@
     "nuxt": "4.0.3",
     "typescript": "5.9.2",
     "unbuild": "3.6.1",
+    "typedoc": "0.28.18",
+    "typedoc-plugin-markdown": "4.11.0",
     "vitest": "3.2.4",
     "vue-tsc": "3.0.6"
   }