auth 1.2.2 → 1.5.0-beta.15

package/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2024 - present, Bereket Engida
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,194 +1,47 @@
-<p align="center">
-<img width="96px" src="https://authjs.dev/img/etc/cli.svg" style="margin-right: 16px"/>
-<a href="https://authjs.dev" target="_blank"><img width="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
-  <h1 align="center">Auth.js CLI</h1>
-</p>
-<p align="center">
-  The CLI tool by <a href="https://authjs.dev">Auth.js</a> to supercharge your authentication workflows.
-</p>
-<p align="center">
-  <a href="https://npm.im/auth"><img src="https://img.shields.io/badge/JavaScript-grey?style=flat-square&logo=javascript" alt="JavaScript" /></a>
-  <a href="https://www.npmtrends.com/auth"><img src="https://img.shields.io/npm/dm/auth?style=flat-square&color=cyan" alt="Downloads" /></a>
-  <a href="https://www.npmjs.com/package/auth"><img src="https://img.shields.io/npm/v/auth?style=flat-square&label=latest&color=purple" alt="npm latest release" /></a>
-  <a href="https://github.com/nextauthjs/cli/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/cli?style=flat-square&color=orange" alt="Github Stars" /></a>
-</p>
+# Better Auth CLI
 
-## Features
+Better Auth comes with a built-in CLI to help you manage the database schema
+needed for both core functionality and plugins.
 
-- Natural language search to answer questions about Auth.js, docs, APIs, or general auth concepts
-- Initialize new projects with Auth.js for any of the supported frameworks
-- Guides you through adding authentication providers to your existing project
-- ... and more coming soon!
+### **Init**
 
-## Installation
+The CLI includes an `init` command to add Better Auth to your project.
 
-You don't need to install this package, run the following:
-
-```sh
-npx auth # or pnpx, bunx, yarn dlx, etc.
+```bash title="terminal"
+npx auth@latest init
 ```
 
-## Usage
-
-<!-- GENERATED START -->
-
-```
-Usage: auth [options] [command]
+### **Generate**
 
-Options:
-  -V, --version               output the version number
-  -h, --help                  display help for command
+The `generate` command creates the schema required by Better Auth.
+If you’re using a database adapter like Prisma or Drizzle, this command will
+generate the right schema for your ORM.
+If you’re using the built-in Kysely adapter, it will generate an SQL file you
+can run directly on your database.
 
-Commands:
-  ask [options]               Ask about docs, API, or auth concepts.
-  init [options] [framework]  Initialize a project.
-  secret [options]            Generate a random string and add it to the .env
-                              file.
-  add [provider]              Register a new authentication provider
-  help [command]              display help for command
+```bash title="terminal"
+npx auth@latest generate
 ```
 
-<!-- GENERATED END -->
-
-## Security
-
-If you think you have found a vulnerability (or are not sure) in Auth.js or any of the related packages (i.e. Adapters), we ask you to read our [Security Policy](https://authjs.dev/security) to reach out responsibly. Please do not open Pull Requests/Issues/Discussions before consulting with us.
+### **Migrate**
 
-## Acknowledgements
+The `migrate` command applies the Better Auth schema directly to your database.
+This is available if you’re using the built-in Kysely adapter.
+For other adapters, you’ll need to apply the schema using your ORM’s migration
+tool.
 
-Special thanks to Craig for the `auth` package name on npm.
-
-### Sponsors
-
-We have an [OpenCollective](https://opencollective.com/nextauth) for companies and individuals looking to contribute financially to the project!
-
-<!--sponsors start-->
-<table>
-  <tbody>
-    <tr>
-      <td align="center" valign="top">
-        <a href="https://clerk.com?utm_source=sponsorship&utm_medium=github&utm_campaign=authjs&utm_content=sponsor" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/49538330?s=200&v=4" alt="Clerk Logo" />
-        </a><br />
-        <div>Clerk</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://a0.to/signup/nextauthjs" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/2824157?v=4" alt="Auth0 Logo" />
-        </a><br />
-        <div>Auth0</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://fusionauth.io" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/41974756?s=200&v=4" alt="FusionAuth Logo" />
-        </a><br />
-        <div>FusionAuth</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://www.beyondidentity.com" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/69811361?s=200&v=4" alt="Beyond Identity Logo" />
-        </a><br />
-        <div>Beyond Identity</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://stytch.com" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/69983493?s=200&v=4" alt="Stytch Logo" />
-        </a><br />
-        <div>Stytch</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://prisma.io" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/17219288?s=200&v=4" alt="Prisma Logo" />
-        </a><br />
-        <div>Prisma</div>
-        <sub>💵</sub>
-      </td>
-    </tr>
-    <tr>
-      <td align="center" valign="top">
-        <a href="https://lowdefy.com" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/47087496?s=200&v=4" alt="Lowdefy Logo" />
-        </a><br />
-        <div>Lowdefy</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://www.descope.com" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/97479186?s=200&v=4" alt="Descope Logo" />
-        </a><br />
-        <div>Descope</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://badass.dev" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/136839242?v=4" alt="Badass Courses Logo" />
-        </a><br />
-        <div>Badass Courses</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://github.com/encoredev/encore" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/50438175?v=4" alt="Encore Logo" />
-        </a><br />
-        <div>Encore</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://arcjet.com/?ref=auth.js" target="_blank">
-          <img width="108" src="https://avatars.githubusercontent.com/u/24397786?s=200&v=4" alt="Arcjet Logo" />
-        </a><br />
-        <div>Arcjet</div>
-        <sub>💵</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://www.netlight.com/" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/1672348?s=200&v=4" alt="Netlight logo" />
-        </a><br />
-        <div>Netlight</div>
-        <sub>☁️</sub>
-      </td>
-    </tr>
-    <tr>
-      <td align="center" valign="top">
-        <a href="https://checklyhq.com" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/25982255?s=200&v=4" alt="Checkly Logo" />
-        </a><br />
-        <div>Checkly</div>
-        <sub>☁️</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://superblog.ai/" target="_blank">
-          <img height="96" src="https://d33wubrfki0l68.cloudfront.net/cdc4a3833bd878933fcc131655878dbf226ac1c5/10cd6/images/logo_bolt_small.png" alt="superblog Logo" />
-        </a><br />
-        <div>superblog</div>
-        <sub>☁️</sub>
-      </td>
-      <td align="center" valign="top">
-        <a href="https://vercel.com" target="_blank">
-          <img height="96" src="https://avatars.githubusercontent.com/u/14985020?s=200&v=4" alt="Vercel Logo" />
-        </a><br />
-        <div>Vercel</div>
-        <sub>☁️</sub>
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-- 💵 Financial Sponsor
-- ☁️ Infrastructure Support
+```bash title="terminal"
+npx auth@latest migrate
+```
 
-<br />
-<!--sponsors end-->
+### **Secret**
 
-## Contributing
+The CLI also provides a way to generate a secret key for your Better Auth
+instance.
 
-We're open to all community contributions! If you'd like to contribute in any way, please first read
-our [Contributing Guide](https://github.com/nextauthjs/.github/blob/main/CONTRIBUTING.md).
+```bash title="terminal"
+npx auth@latest secret
+```
 
 ## License
 

package/dist/api.d.mts

@@ -0,0 +1,45 @@
+import { DBAdapter, DBAdapter as DBAdapter$1 } from "@better-auth/core/db/adapter";
+import { BetterAuthOptions } from "@better-auth/core";
+
+//#region src/generators/types.d.ts
+interface SchemaGeneratorResult {
+  code?: string;
+  fileName: string;
+  overwrite?: boolean;
+  append?: boolean;
+}
+interface SchemaGenerator {
+  <Options extends BetterAuthOptions>(opts: {
+    file?: string;
+    adapter: DBAdapter$1;
+    options: Options;
+  }): Promise<SchemaGeneratorResult>;
+}
+//#endregion
+//#region src/generators/index.d.ts
+declare const adapters: {
+  prisma: SchemaGenerator;
+  drizzle: SchemaGenerator;
+  kysely: SchemaGenerator;
+};
+declare const generateSchema: (opts: {
+  adapter: DBAdapter$1;
+  file?: string;
+  options: BetterAuthOptions;
+}) => Promise<SchemaGeneratorResult> | Promise<{
+  code: string;
+  fileName: string;
+  overwrite: boolean | undefined;
+}>;
+//#endregion
+//#region src/generators/drizzle.d.ts
+declare const generateDrizzleSchema: SchemaGenerator;
+//#endregion
+//#region src/generators/kysely.d.ts
+declare const generateKyselySchema: SchemaGenerator;
+//#endregion
+//#region src/generators/prisma.d.ts
+declare const generatePrismaSchema: SchemaGenerator;
+//#endregion
+export { type DBAdapter, type SchemaGenerator, type SchemaGeneratorResult, adapters, generateDrizzleSchema, generateKyselySchema, generatePrismaSchema, generateSchema };
+//# sourceMappingURL=api.d.mts.map

package/dist/api.mjs

@@ -0,0 +1,3 @@
+import { d as generateDrizzleSchema, n as generateSchema, r as generatePrismaSchema, t as adapters, u as generateKyselySchema } from "./generators-DNY9D4Si.mjs";
+
+export { adapters, generateDrizzleSchema, generateKyselySchema, generatePrismaSchema, generateSchema };