@nuxtjs/better-auth 0.0.0 → 0.1.3

package/README.md

@@ -0,0 +1,67 @@
+# `@nuxtjs/better-auth`
+
+Nuxt module for [Better Auth](https://better-auth.com) with Nuxt-native route protection, SSR-safe session access, auto-imported helpers, and optional NuxtHub-backed schema generation.
+
+## Who this is for
+
+Use this module if you want Better Auth in a Nuxt 4 app and you want the Nuxt-specific pieces handled for you:
+
+- `useUserSession()` for reactive auth state
+- `requireUserSession(event)` and related server helpers
+- route protection through `routeRules` and `definePageMeta({ auth })`
+- generated `server/auth.config.ts` and `app/auth.config.ts`
+- optional NuxtHub database integration and schema generation
+
+## Install the module
+
+For the fastest path in a Nuxt 4 app:
+
+```bash
+npx nuxi module add @nuxtjs/better-auth
+```
+
+Then create or confirm these files:
+
+- `server/auth.config.ts`
+- `app/auth.config.ts`
+- `.env` with `NUXT_BETTER_AUTH_SECRET`
+
+For the full setup flow, follow the [installation guide](https://better-auth.nuxt.dev/getting-started/installation).
+
+## Choose your setup path
+
+- Use [NuxtHub integration](https://better-auth.nuxt.dev/integrations/nuxthub) if you want the shortest path to database-backed auth.
+- Use [custom database setup](https://better-auth.nuxt.dev/guides/custom-database) if you already have your own database stack.
+- Use [external auth backend](https://better-auth.nuxt.dev/guides/external-auth-backend) if Better Auth runs in a separate service.
+- Use [database-less mode](https://better-auth.nuxt.dev/guides/database-less-mode) for stateless or OAuth-first setups with clear tradeoffs.
+
+## Documentation
+
+The documentation site is at [better-auth.nuxt.dev](https://better-auth.nuxt.dev).
+
+Recommended reading order:
+
+1. [Quickstart](https://better-auth.nuxt.dev/getting-started)
+2. [Installation](https://better-auth.nuxt.dev/getting-started/installation)
+3. [Configuration](https://better-auth.nuxt.dev/getting-started/configuration)
+4. [Client setup](https://better-auth.nuxt.dev/getting-started/client-setup)
+5. [Route protection](https://better-auth.nuxt.dev/core-concepts/route-protection)
+
+## Development
+
+```bash
+pnpm install
+pnpm dev:docs
+```
+
+Useful commands:
+
+- `pnpm dev` to run the playground
+- `pnpm dev:docs` to run the docs site
+- `pnpm lint` to lint the repo
+- `pnpm test` to run the test suite
+- `pnpm build:docs` to build the docs site
+
+## License
+
+[MIT](https://github.com/nuxt-modules/better-auth/blob/main/LICENSE)

package/dist/module.d.mts

@@ -0,0 +1,47 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { Nuxt } from '@nuxt/schema';
+import { BetterAuthModuleOptions } from '../dist/runtime/config.js';
+export { BetterAuthModuleOptions, defineClientAuth, defineServerAuth } from '../dist/runtime/config.js';
+import { BetterAuthOptions } from 'better-auth';
+export { AppSession, Auth, AuthActionError, AuthMeta, AuthMode, AuthRouteRules, AuthSession, AuthSocialProviderId, AuthUser, InferSession, InferUser, RequireSessionOptions, ServerAuthContext, UserMatch } from '../dist/runtime/types.js';
+
+type DbDialect = 'sqlite' | 'postgresql' | 'mysql';
+
+interface BetterAuthDatabaseProviderBuildContext {
+    hubDialect: DbDialect;
+    usePlural: boolean;
+    camelCase: boolean;
+}
+interface BetterAuthDatabaseProviderSetupContext {
+    nuxt: Nuxt;
+    options: BetterAuthModuleOptions;
+    clientOnly: boolean;
+}
+interface BetterAuthDatabaseProviderEnabledContext extends BetterAuthDatabaseProviderSetupContext {
+    hasHubDbAvailable: boolean;
+}
+interface BetterAuthDatabaseProviderDefinition {
+    buildDatabaseCode: (ctx: BetterAuthDatabaseProviderBuildContext) => string;
+    setup?: (ctx: BetterAuthDatabaseProviderSetupContext) => void | Promise<void>;
+    isEnabled?: (ctx: BetterAuthDatabaseProviderEnabledContext) => boolean;
+    priority?: number;
+}
+declare module '@nuxt/schema' {
+    interface NuxtHooks {
+        /**
+         * 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
+         */
+        'better-auth:config:extend': (config: Partial<BetterAuthOptions>) => void | Promise<void>;
+        /**
+         * Register or override Better Auth database providers.
+         * Providers are auto-selected via `isEnabled` + `priority`.
+         */
+        'better-auth:database:providers': (providers: Record<string, BetterAuthDatabaseProviderDefinition>) => void | Promise<void>;
+    }
+}
+
+declare const _default: _nuxt_schema.NuxtModule<BetterAuthModuleOptions, BetterAuthModuleOptions, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "@nuxtjs/better-auth",
+  "version": "0.1.3",
+  "configKey": "auth",
+  "compatibility": {
+    "nuxt": ">=4.0.0"
+  },
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "unknown"
+  }
+}