better-auth-nuxt 0.0.9 → 0.0.10-beta.20

package/README.md

@@ -1,278 +1,27 @@
-# Better Auth Nuxt
+<p align="center">
+  <img src="https://raw.githubusercontent.com/onmax/nuxt-better-auth/main/.github/og.png" alt="Nuxt Better Auth" width="100%">
+  <br>
+  <sub>Designed by <a href="https://github.com/HugoRCD">HugoRCD</a></sub>
+</p>
 
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![License][license-src]][license-href]
-[![Nuxt][nuxt-src]][nuxt-href]
+<h1 align="center">@onmax/nuxt-better-auth</h1>
 
-A Nuxt module for simple, flexible authentication in your Nuxt applications.
+<p align="center">Nuxt module for <a href="https://better-auth.com">Better Auth</a></p>
 
-- [✨ &nbsp;Release Notes](/CHANGELOG.md)
-<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
-<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+<p align="center">
+  <a href="https://npmjs.com/package/@onmax/nuxt-better-auth"><img src="https://img.shields.io/npm/v/@onmax/nuxt-better-auth/latest.svg?style=flat&colorA=020420&colorB=00DC82" alt="npm version"></a>
+  <a href="https://npm.chart.dev/@onmax/nuxt-better-auth"><img src="https://img.shields.io/npm/dm/@onmax/nuxt-better-auth.svg?style=flat&colorA=020420&colorB=00DC82" alt="npm downloads"></a>
+  <a href="https://npmjs.com/package/@onmax/nuxt-better-auth"><img src="https://img.shields.io/npm/l/@onmax/nuxt-better-auth.svg?style=flat&colorA=020420&colorB=00DC82" alt="License"></a>
+  <a href="https://nuxt.com"><img src="https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js" alt="Nuxt"></a>
+</p>
 
-## Features
+> [!WARNING]
+> This library is a work in progress and not ready for production use.
 
-- ⚙️ &nbsp;Auto-scanning of client and server configs for end-to-end TS support
-- 🚀 &nbsp;Built-in authentication middleware
-- 🔑 &nbsp;Multiple authentication strategies (username, email, ...)
-- 🛡️ &nbsp;Role-based access control
-- 🔄 &nbsp;Session management
-- 🔒 &nbsp;Redirect handling for authenticated/unauthenticated users
+## Documentation
 
-## Quick Setup
+**[nuxt-better-auth.onmax.me](https://nuxt-better-auth.onmax.me/)**
 
-1. Install the module:
+## License
 
-```bash
-# Using npm
-npm install better-auth-nuxt better-auth
-
-# Using yarn
-yarn add better-auth-nuxt better-auth
-
-# Using pnpm
-pnpm add better-auth-nuxt better-auth
-```
-
-2. Add the module to your `nuxt.config.ts`:
-
-```ts
-export default defineNuxtConfig({
-  modules: ['better-auth-nuxt'],
-
-  betterAuth: {
-    // Configure auth endpoints (default: '/api/auth/**')
-    endpoint: '/api/auth/**',
-
-    // Configure redirect paths
-    redirectOptions: {
-      redirectGuestTo: '/auth/login',
-      redirectUserTo: '/',
-      redirectUnauthorizedTo: '/401',
-    },
-
-    // Configure client and server options
-    options: {
-      client: {
-        basePath: '/api/auth',
-        // Optional: baseURL, disableDefaultFetchPlugins
-      },
-      server: {
-        appName: 'My Nuxt App',
-        // Optional: baseURL, basePath, secret
-      },
-    },
-  }
-})
-```
-
-3. Use the module in your pages:
-
-```vue
-<script setup>
-// Protect route for authenticated users only
-definePageMeta({
-  auth: {
-    only: 'user',
-  }
-})
-
-// Access auth functionality
-const { loggedIn, user, signOut } = useUserSession()
-</script>
-
-<template>
-  <div v-if="loggedIn">
-    <h1>Welcome, {{ user?.name }}</h1>
-    <button @click="signOut()">Sign Out</button>
-  </div>
-</template>
-```
-
-## Module Options
-
-### Auth Configuration
-
-```ts
-interface ModuleOptions {
-  // Auth endpoint
-  endpoint: string
-
-  // Patterns to match auth configuration files
-  serverConfigs?: string[]
-  clientConfigs?: string[]
-
-  // Client and server options
-  options: {
-    client?: ModuleClientOptions
-    server?: ModuleServerOptions
-  }
-
-  // Redirect options
-  redirectOptions: {
-    redirectUserTo?: string
-    redirectGuestTo?: string
-    redirectUnauthorizedTo?: string
-  }
-}
-```
-
-### Server Options
-
-```ts
-interface ModuleServerOptions {
-  appName?: string   // Application name
-  baseURL?: string   // Base URL for the auth API
-  basePath?: string  // Base path for the auth API
-  secret?: string    // Secret for JWT/session encryption
-}
-```
-
-### Client Options
-
-```ts
-interface ModuleClientOptions {
-  baseURL?: string                  // Base URL for the auth API
-  basePath?: string                 // Base path for the auth API
-  disableDefaultFetchPlugins?: boolean // Disable default fetch plugins
-}
-```
-
-## API Reference
-
-### Client-side Composables
-
-#### `useUserSession()`
-
-Provides access to the authenticated user session and auth methods.
-
-```ts
-const {
-  // State
-  loggedIn,         // Ref<boolean> - Is the user logged in
-  user,             // Ref<User> - Current user data
-  session,          // Ref<Session> - Current session data
-
-  // Methods
-  fetchSession,     // () => Promise<void> - Fetch current session
-  signIn: {
-    username,       // (credentials) => Promise<void> - Sign in with username
-    email,          // (credentials) => Promise<void> - Sign in with email
-  },
-  signUp: {
-    username,       // (userData) => Promise<void> - Register with username
-    email,          // (userData) => Promise<void> - Register with email
-  },
-  signOut,          // (options?) => Promise<void> - Sign out the user
-
-  // Configuration
-  options,          // Auth configuration options
-} = useUserSession()
-```
-
-### Server-side Utilities
-
-#### `useAuth()`
-
-Access the auth instance on the server.
-
-```ts
-// In API route handlers:
-const auth = useAuth()
-```
-
-### Route Protection
-
-Use the `auth` meta property to protect routes:
-
-```ts
-definePageMeta({
-  auth: {
-    // Only allow specific roles
-    only: 'user' | 'admin' | 'guest' | ['user', 'admin'],
-
-    // Custom redirect paths (override global config)
-    redirectUserTo: '/dashboard',
-    redirectGuestTo: '/login',
-    redirectUnauthorizedTo: '/unauthorized',
-  }
-})
-```
-
-## Configuration Files
-
-You can create configuration files to customize authentication:
-
-### Server Configuration
-
-Create a `*.better-auth.ts` file to configure server-side auth:
-
-```ts
-// server/my-auth.better-auth.ts
-import type { BetterAuthOptions } from 'better-auth'
-
-export default () => ({
-  // Custom server-side auth configuration
-} satisfies BetterAuthOptions)
-```
-
-### Client Configuration
-
-Create a `*.better-auth-client.ts` file to configure client-side auth:
-
-```ts
-// app/my-auth.better-auth-client.ts
-import type { ClientOptions } from 'better-auth'
-
-export default {
-  // Custom client-side auth configuration
-} satisfies ClientOptions
-```
-
-> **Note**: After adding or modifying configuration files, run `pnpm nuxt prepare` to ensure your changes are properly recognized by Nuxt.
-
-## Contribution
-
-<details>
-  <summary>Local development</summary>
-
-  ```bash
-  # Install dependencies
-  pnpm install
-
-  # Generate type stubs
-  pnpm dev:prepare
-
-  # Develop with the playground
-  pnpm dev
-
-  # Build the playground
-  pnpm dev:build
-
-  # Run ESLint
-  pnpm lint
-
-  # Run Vitest
-  pnpm test
-  pnpm test:watch
-
-  # Release new version
-  pnpm release
-  ```
-
-</details>
-
-
-<!-- Badges -->
-[npm-version-src]: https://img.shields.io/npm/v/better-auth-nuxt/latest.svg?style=flat&colorA=020420&colorB=00DC82
-[npm-version-href]: https://npmjs.com/package/better-auth-nuxt
-
-[npm-downloads-src]: https://img.shields.io/npm/dm/better-auth-nuxt.svg?style=flat&colorA=020420&colorB=00DC82
-[npm-downloads-href]: https://npm.chart.dev/better-auth-nuxt
-
-[license-src]: https://img.shields.io/npm/l/better-auth-nuxt.svg?style=flat&colorA=020420&colorB=00DC82
-[license-href]: https://npmjs.com/package/better-auth-nuxt
-
-[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
-[nuxt-href]: https://nuxt.com
+MIT

package/dist/module.d.mts

@@ -1,47 +1,20 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { ClientOptions, BetterAuthOptions } from 'better-auth';
+import { BetterAuthModuleOptions } from '../dist/runtime/config.js';
+export { BetterAuthModuleOptions, defineClientAuth, defineServerAuth } from '../dist/runtime/config.js';
+import { BetterAuthOptions } from 'better-auth';
+export { Auth, AuthMeta, AuthMode, AuthRouteRules, AuthSession, AuthUser, InferSession, InferUser, RequireSessionOptions, ServerAuthContext, UserMatch } from '../dist/runtime/types.js';
 
-interface ModuleServerOptions extends Pick<BetterAuthOptions, 'appName' | 'baseURL' | 'basePath' | 'secret'> {
-}
-interface ModuleClientOptions extends Pick<ClientOptions, 'baseURL' | 'basePath' | 'disableDefaultFetchPlugins'> {
-}
-interface ModuleOptions {
-    /**
-     * auth endpoint
-     * @default 'api/auth/**'
-     */
-    endpoint: string;
-    /**
-     * @default ['*.better-auth']
-     */
-    serverConfigs?: string[];
-    /**
-     * @default ['*.better-auth-client']
-     */
-    clientConfigs?: string[];
-    options: {
-        /**
-         * client options object or path to client setup script
-         */
-        client?: ModuleClientOptions;
+declare module '@nuxt/schema' {
+    interface NuxtHooks {
         /**
-         * server options object or path to server setup script
+         * Extend better-auth config with additional plugins or options.
+         * Called after user's auth.config.ts is loaded.
+         * @param config - Partial config to merge into the auth options
          */
-        server?: ModuleServerOptions;
-    };
-    /**
-     * redirect options
-     */
-    redirectOptions: {
-        redirectUserTo?: string;
-        redirectGuestTo?: string;
-        redirectUnauthorizedTo?: string;
-    };
-}
-interface ModulePublicRuntimeConfig {
-    betterAuth: ModuleOptions;
+        'better-auth:config:extend': (config: Partial<BetterAuthOptions>) => void | Promise<void>;
+    }
 }
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+declare const _default: _nuxt_schema.NuxtModule<BetterAuthModuleOptions, BetterAuthModuleOptions, false>;
 
 export { _default as default };
-export type { ModuleClientOptions, ModuleOptions, ModulePublicRuntimeConfig, ModuleServerOptions };

package/dist/module.json

@@ -1,9 +1,12 @@
 {
-  "name": "better-auth",
-  "configKey": "betterAuth",
-  "version": "0.0.9",
+  "name": "better-auth-nuxt",
+  "version": "0.0.10-beta.20",
+  "configKey": "auth",
+  "compatibility": {
+    "nuxt": ">=3.0.0"
+  },
   "builder": {
-    "@nuxt/module-builder": "1.0.1",
-    "unbuild": "3.5.0"
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
   }
 }