@better-auth/core 1.4.0-beta.6 → 1.4.0-beta.8

package/dist/shared/core.DeNN5HMO.d.ts

@@ -0,0 +1,143 @@
+import { ZodType } from 'zod';
+
+type Primitive = string | number | symbol | bigint | boolean | null | undefined;
+type LiteralString = "" | (string & Record<never, never>);
+type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
+
+declare module "../index" {
+    interface BetterAuthMutators<O, C> {
+        "better-auth/db": {};
+    }
+}
+type Models = "user" | "account" | "session" | "verification" | "rate-limit" | "organization" | "member" | "invitation" | "jwks" | "passkey" | "two-factor";
+type DBFieldType = "string" | "number" | "boolean" | "date" | "json" | `${"string" | "number"}[]` | Array<LiteralString>;
+type DBPrimitive = string | number | boolean | Date | null | undefined | string[] | number[];
+type DBFieldAttributeConfig = {
+    /**
+     * If the field should be required on a new record.
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * If the value should be returned on a response body.
+     * @default true
+     */
+    returned?: boolean;
+    /**
+     * If a value should be provided when creating a new record.
+     * @default true
+     */
+    input?: boolean;
+    /**
+     * Default value for the field
+     *
+     * Note: This will not create a default value on the database level. It will only
+     * be used when creating a new record.
+     */
+    defaultValue?: DBPrimitive | (() => DBPrimitive);
+    /**
+     * Update value for the field
+     *
+     * Note: This will create an onUpdate trigger on the database level for supported adapters.
+     * It will be called when updating a record.
+     */
+    onUpdate?: () => DBPrimitive;
+    /**
+     * transform the value before storing it.
+     */
+    transform?: {
+        input?: (value: DBPrimitive) => DBPrimitive | Promise<DBPrimitive>;
+        output?: (value: DBPrimitive) => DBPrimitive | Promise<DBPrimitive>;
+    };
+    /**
+     * Reference to another model.
+     */
+    references?: {
+        /**
+         * The model to reference.
+         */
+        model: string;
+        /**
+         * The field on the referenced model.
+         */
+        field: string;
+        /**
+         * The action to perform when the reference is deleted.
+         * @default "cascade"
+         */
+        onDelete?: "no action" | "restrict" | "cascade" | "set null" | "set default";
+    };
+    unique?: boolean;
+    /**
+     * If the field should be a bigint on the database instead of integer.
+     */
+    bigint?: boolean;
+    /**
+     * A zod schema to validate the value.
+     */
+    validator?: {
+        input?: ZodType;
+        output?: ZodType;
+    };
+    /**
+     * The name of the field on the database.
+     */
+    fieldName?: string;
+    /**
+     * If the field should be sortable.
+     *
+     * applicable only for `text` type.
+     * It's useful to mark fields varchar instead of text.
+     */
+    sortable?: boolean;
+};
+type DBFieldAttribute<T extends DBFieldType = DBFieldType> = {
+    type: T;
+} & DBFieldAttributeConfig;
+type BetterAuthDBSchema = Record<string, {
+    /**
+     * The name of the table in the database
+     */
+    modelName: string;
+    /**
+     * The fields of the table
+     */
+    fields: Record<string, DBFieldAttribute>;
+    /**
+     * Whether to disable migrations for this table
+     * @default false
+     */
+    disableMigrations?: boolean;
+    /**
+     * The order of the table
+     */
+    order?: number;
+}>;
+interface SecondaryStorage {
+    /**
+     *
+     * @param key - Key to get
+     * @returns - Value of the key
+     */
+    get: (key: string) => Promise<unknown> | unknown;
+    set: (
+    /**
+     * Key to store
+     */
+    key: string, 
+    /**
+     * Value to store
+     */
+    value: string, 
+    /**
+     * Time to live in seconds
+     */
+    ttl?: number) => Promise<void | null | unknown> | void;
+    /**
+     *
+     * @param key - Key to delete
+     */
+    delete: (key: string) => Promise<void | null | string> | void;
+}
+
+export type { BetterAuthDBSchema as B, DBFieldAttribute as D, LiteralUnion as L, Models as M, SecondaryStorage as S, LiteralString as a, DBFieldAttributeConfig as b, DBFieldType as c, DBPrimitive as d };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-auth/core",
-  "version": "1.4.0-beta.6",
+  "version": "1.4.0-beta.8",
   "description": "The most comprehensive authentication library for TypeScript.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -16,6 +16,26 @@
         "default": "./dist/index.cjs"
       }
     },
+    "./async_hooks": {
+      "import": {
+        "types": "./dist/async_hooks/index.d.ts",
+        "default": "./dist/async_hooks/index.mjs"
+      },
+      "require": {
+        "types": "./dist/async_hooks/index.d.cts",
+        "default": "./dist/async_hooks/index.cjs"
+      }
+    },
+    "./env": {
+      "import": {
+        "types": "./dist/env/index.d.ts",
+        "default": "./dist/env/index.mjs"
+      },
+      "require": {
+        "types": "./dist/env/index.d.cts",
+        "default": "./dist/env/index.cjs"
+      }
+    },
     "./db": {
       "import": {
         "types": "./dist/db/index.d.ts",
@@ -25,6 +45,26 @@
         "types": "./dist/db/index.d.cts",
         "default": "./dist/db/index.cjs"
       }
+    },
+    "./db/adapter": {
+      "import": {
+        "types": "./dist/db/adapter/index.d.ts",
+        "default": "./dist/db/adapter/index.mjs"
+      },
+      "require": {
+        "types": "./dist/db/adapter/index.d.cts",
+        "default": "./dist/db/adapter/index.cjs"
+      }
+    },
+    "./oauth2": {
+      "import": {
+        "types": "./dist/oauth2/index.d.ts",
+        "default": "./dist/oauth2/index.mjs"
+      },
+      "require": {
+        "types": "./dist/oauth2/index.d.cts",
+        "default": "./dist/oauth2/index.cjs"
+      }
     }
   },
   "typesVersions": {
@@ -32,18 +72,29 @@
       "index": [
         "dist/index.d.ts"
       ],
+      "async_hooks": [
+        "dist/async_hooks.d.ts"
+      ],
       "db": [
         "dist/db.d.ts"
       ]
     }
   },
   "devDependencies": {
+    "@better-auth/utils": "0.3.0",
+    "@better-fetch/fetch": "1.1.18",
+    "jose": "^6.1.0",
     "unbuild": "3.6.1"
   },
   "dependencies": {
     "better-call": "1.0.19",
     "zod": "^4.1.5"
   },
+  "peerDependencies": {
+    "@better-auth/utils": "0.3.0",
+    "@better-fetch/fetch": "1.1.18",
+    "jose": "^6.1.0"
+  },
   "scripts": {
     "build": "unbuild --clean",
     "stub": "unbuild --stub",

package/src/async_hooks/index.ts

@@ -0,0 +1,43 @@
+/**
+ * AsyncLocalStorage will be import directly in 1.5.x
+ */
+import type { AsyncLocalStorage } from "node:async_hooks";
+
+// We only export the type here to avoid issues in environments where AsyncLocalStorage is not available.
+export type { AsyncLocalStorage };
+
+/**
+ * Dynamically import AsyncLocalStorage to avoid issues in environments where it's not available.
+ *
+ * Right now, this is primarily for Cloudflare Workers.
+ *
+ */
+let moduleName: string = "node:async_hooks";
+
+const AsyncLocalStoragePromise: Promise<typeof AsyncLocalStorage> = import(
+	/* @vite-ignore */
+	/* webpackIgnore: true */
+	moduleName
+)
+	.then((mod) => mod.AsyncLocalStorage)
+	.catch((err) => {
+		if ("AsyncLocalStorage" in globalThis) {
+			return (globalThis as any).AsyncLocalStorage;
+		}
+		console.warn(
+			"[better-auth] Warning: AsyncLocalStorage is not available in this environment. Some features may not work as expected.",
+		);
+		console.warn(
+			"[better-auth] Please read more about this warning at https://better-auth.com/docs/installation#mount-handler",
+		);
+		console.warn(
+			"[better-auth] If you are using Cloudflare Workers, please see: https://developers.cloudflare.com/workers/configuration/compatibility-flags/#nodejs-compatibility-flag",
+		);
+		throw err;
+	});
+
+export async function getAsyncLocalStorage(): Promise<
+	typeof AsyncLocalStorage
+> {
+	return AsyncLocalStoragePromise;
+}

package/src/db/adapter/index.ts

@@ -0,0 +1,24 @@
+export type DBAdapterDebugLogOption =
+	| boolean
+	| {
+			/**
+			 * Useful when you want to log only certain conditions.
+			 */
+			logCondition?: (() => boolean) | undefined;
+			create?: boolean;
+			update?: boolean;
+			updateMany?: boolean;
+			findOne?: boolean;
+			findMany?: boolean;
+			delete?: boolean;
+			deleteMany?: boolean;
+			count?: boolean;
+	  }
+	| {
+			/**
+			 * Only used for adapter tests to show debug logs if a test fails.
+			 *
+			 * @deprecated Not actually deprecated. Doing this for IDEs to show this option at the very bottom and stop end-users from using this.
+			 */
+			isRunningAdapterTests: boolean;
+	  };

package/src/db/index.ts

@@ -5,6 +5,15 @@ import type {
 	DBPrimitive,
 	BetterAuthDBSchema,
 } from "./type";
+import type { BetterAuthPluginDBSchema } from "./plugin";
+export type { BetterAuthPluginDBSchema } from "./plugin";
+export type { SecondaryStorage } from "./type";
+export { coreSchema } from "./schema/shared";
+export { userSchema, type User } from "./schema/user";
+export { accountSchema, type Account } from "./schema/account";
+export { sessionSchema, type Session } from "./schema/session";
+export { verificationSchema, type Verification } from "./schema/verification";
+export { rateLimitSchema, type RateLimit } from "./schema/rate-limit";
 
 export type {
 	DBFieldAttribute,
@@ -14,6 +23,10 @@ export type {
 	BetterAuthDBSchema,
 };
 
+/**
+ * @deprecated Backport for 1.3.x, we will remove this in 1.4.x
+ */
+export type AuthPluginSchema = BetterAuthPluginDBSchema;
 /**
  * @deprecated Backport for 1.3.x, we will remove this in 1.4.x
  */

package/src/db/plugin.ts

@@ -0,0 +1,11 @@
+import type { DBFieldAttribute } from "./type";
+
+export type BetterAuthPluginDBSchema = {
+	[table in string]: {
+		fields: {
+			[field in string]: DBFieldAttribute;
+		};
+		disableMigration?: boolean;
+		modelName?: string;
+	};
+};

package/src/db/schema/account.ts

@@ -0,0 +1,34 @@
+import * as z from "zod";
+import { coreSchema } from "./shared";
+
+export const accountSchema = coreSchema.extend({
+	providerId: z.string(),
+	accountId: z.string(),
+	userId: z.coerce.string(),
+	accessToken: z.string().nullish(),
+	refreshToken: z.string().nullish(),
+	idToken: z.string().nullish(),
+	/**
+	 * Access token expires at
+	 */
+	accessTokenExpiresAt: z.date().nullish(),
+	/**
+	 * Refresh token expires at
+	 */
+	refreshTokenExpiresAt: z.date().nullish(),
+	/**
+	 * The scopes that the user has authorized
+	 */
+	scope: z.string().nullish(),
+	/**
+	 * Password is only stored in the credential provider
+	 */
+	password: z.string().nullish(),
+});
+
+/**
+ * Account schema type used by better-auth, note that it's possible that account could have additional fields
+ *
+ * todo: we should use generics to extend this type with additional fields from plugins and options in the future
+ */
+export type Account = z.infer<typeof accountSchema>;

package/src/db/schema/rate-limit.ts

@@ -0,0 +1,21 @@
+import * as z from "zod";
+
+export const rateLimitSchema = z.object({
+	/**
+	 * The key to use for rate limiting
+	 */
+	key: z.string(),
+	/**
+	 * The number of requests made
+	 */
+	count: z.number(),
+	/**
+	 * The last request time in milliseconds
+	 */
+	lastRequest: z.number(),
+});
+
+/**
+ * Rate limit schema type used by better-auth for rate limiting
+ */
+export type RateLimit = z.infer<typeof rateLimitSchema>;

package/src/db/schema/session.ts

@@ -0,0 +1,17 @@
+import * as z from "zod";
+import { coreSchema } from "./shared";
+
+export const sessionSchema = coreSchema.extend({
+	userId: z.coerce.string(),
+	expiresAt: z.date(),
+	token: z.string(),
+	ipAddress: z.string().nullish(),
+	userAgent: z.string().nullish(),
+});
+
+/**
+ * Session schema type used by better-auth, note that it's possible that session could have additional fields
+ *
+ * todo: we should use generics to extend this type with additional fields from plugins and options in the future
+ */
+export type Session = z.infer<typeof sessionSchema>;

package/src/db/schema/shared.ts

@@ -0,0 +1,7 @@
+import * as z from "zod";
+
+export const coreSchema = z.object({
+	id: z.string(),
+	createdAt: z.date().default(() => new Date()),
+	updatedAt: z.date().default(() => new Date()),
+});

package/src/db/schema/user.ts

@@ -0,0 +1,16 @@
+import * as z from "zod";
+import { coreSchema } from "./shared";
+
+export const userSchema = coreSchema.extend({
+	email: z.string().transform((val) => val.toLowerCase()),
+	emailVerified: z.boolean().default(false),
+	name: z.string(),
+	image: z.string().nullish(),
+});
+
+/**
+ * User schema type used by better-auth, note that it's possible that user could have additional fields
+ *
+ * todo: we should use generics to extend this type with additional fields from plugins and options in the future
+ */
+export type User = z.infer<typeof userSchema>;

package/src/db/schema/verification.ts

@@ -0,0 +1,15 @@
+import * as z from "zod";
+import { coreSchema } from "./shared";
+
+export const verificationSchema = coreSchema.extend({
+	value: z.string(),
+	expiresAt: z.date(),
+	identifier: z.string(),
+});
+
+/**
+ * Verification schema type used by better-auth, note that it's possible that verification could have additional fields
+ *
+ * todo: we should use generics to extend this type with additional fields from plugins and options in the future
+ */
+export type Verification = z.infer<typeof verificationSchema>;

package/src/db/type.ts

@@ -1,6 +1,28 @@
 import type { ZodType } from "zod";
 import type { LiteralString } from "../types";
 
+declare module "../index" {
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	interface BetterAuthMutators<O, C> {
+		"better-auth/db": {
+			// todo: we should infer the schema from the adapter
+		};
+	}
+}
+
+export type Models =
+	| "user"
+	| "account"
+	| "session"
+	| "verification"
+	| "rate-limit"
+	| "organization"
+	| "member"
+	| "invitation"
+	| "jwks"
+	| "passkey"
+	| "two-factor";
+
 export type DBFieldType =
 	| "string"
 	| "number"
@@ -131,3 +153,31 @@ export type BetterAuthDBSchema = Record<
 		order?: number;
 	}
 >;
+
+export interface SecondaryStorage {
+	/**
+	 *
+	 * @param key - Key to get
+	 * @returns - Value of the key
+	 */
+	get: (key: string) => Promise<unknown> | unknown;
+	set: (
+		/**
+		 * Key to store
+		 */
+		key: string,
+		/**
+		 * Value to store
+		 */
+		value: string,
+		/**
+		 * Time to live in seconds
+		 */
+		ttl?: number,
+	) => Promise<void | null | unknown> | void;
+	/**
+	 *
+	 * @param key - Key to delete
+	 */
+	delete: (key: string) => Promise<void | null | string> | void;
+}

package/src/env/color-depth.ts

@@ -0,0 +1,171 @@
+// Source code copied & modified from node internals: https://github.com/nodejs/node/blob/5b32bb1573dace2dd058c05ac4fab1e4e446c775/lib/internal/tty.js#L123
+import { env, getEnvVar } from "./env-impl";
+
+const COLORS_2 = 1;
+const COLORS_16 = 4;
+const COLORS_256 = 8;
+const COLORS_16m = 24;
+
+const TERM_ENVS: Record<string, number> = {
+	eterm: COLORS_16,
+	cons25: COLORS_16,
+	console: COLORS_16,
+	cygwin: COLORS_16,
+	dtterm: COLORS_16,
+	gnome: COLORS_16,
+	hurd: COLORS_16,
+	jfbterm: COLORS_16,
+	konsole: COLORS_16,
+	kterm: COLORS_16,
+	mlterm: COLORS_16,
+	mosh: COLORS_16m,
+	putty: COLORS_16,
+	st: COLORS_16,
+	// http://lists.schmorp.de/pipermail/rxvt-unicode/2016q2/002261.html
+	"rxvt-unicode-24bit": COLORS_16m,
+	// https://bugs.launchpad.net/terminator/+bug/1030562
+	terminator: COLORS_16m,
+	"xterm-kitty": COLORS_16m,
+};
+
+const CI_ENVS_MAP = new Map(
+	Object.entries({
+		APPVEYOR: COLORS_256,
+		BUILDKITE: COLORS_256,
+		CIRCLECI: COLORS_16m,
+		DRONE: COLORS_256,
+		GITEA_ACTIONS: COLORS_16m,
+		GITHUB_ACTIONS: COLORS_16m,
+		GITLAB_CI: COLORS_256,
+		TRAVIS: COLORS_256,
+	}),
+);
+
+const TERM_ENVS_REG_EXP = [
+	/ansi/,
+	/color/,
+	/linux/,
+	/direct/,
+	/^con[0-9]*x[0-9]/,
+	/^rxvt/,
+	/^screen/,
+	/^xterm/,
+	/^vt100/,
+	/^vt220/,
+];
+
+// The `getColorDepth` API got inspired by multiple sources such as
+// https://github.com/chalk/supports-color,
+// https://github.com/isaacs/color-support.
+export function getColorDepth(): number {
+	// Use level 0-3 to support the same levels as `chalk` does. This is done for
+	// consistency throughout the ecosystem.
+	if (getEnvVar("FORCE_COLOR") !== undefined) {
+		switch (getEnvVar("FORCE_COLOR")) {
+			case "":
+			case "1":
+			case "true":
+				return COLORS_16;
+			case "2":
+				return COLORS_256;
+			case "3":
+				return COLORS_16m;
+			default:
+				return COLORS_2;
+		}
+	}
+
+	if (
+		(getEnvVar("NODE_DISABLE_COLORS") !== undefined &&
+			getEnvVar("NODE_DISABLE_COLORS") !== "") ||
+		// See https://no-color.org/
+		(getEnvVar("NO_COLOR") !== undefined && getEnvVar("NO_COLOR") !== "") ||
+		// The "dumb" special terminal, as defined by terminfo, doesn't support
+		// ANSI color control codes.
+		// See https://invisible-island.net/ncurses/terminfo.ti.html#toc-_Specials
+		getEnvVar("TERM") === "dumb"
+	) {
+		return COLORS_2;
+	}
+
+	if (typeof process !== "undefined" && process.platform === "win32") {
+		// Windows 10 build 14931 (from 2016) has true color support
+		return COLORS_16m;
+	}
+
+	if (getEnvVar("TMUX")) {
+		return COLORS_16m;
+	}
+
+	// Azure DevOps
+	if ("TF_BUILD" in env && "AGENT_NAME" in env) {
+		return COLORS_16;
+	}
+
+	if ("CI" in env) {
+		for (const { 0: envName, 1: colors } of CI_ENVS_MAP) {
+			if (envName in env) {
+				return colors;
+			}
+		}
+		if (getEnvVar("CI_NAME") === "codeship") {
+			return COLORS_256;
+		}
+		return COLORS_2;
+	}
+
+	if ("TEAMCITY_VERSION" in env) {
+		return /^(9\.(0*[1-9]\d*)\.|\d{2,}\.)/.exec(
+			getEnvVar("TEAMCITY_VERSION"),
+		) !== null
+			? COLORS_16
+			: COLORS_2;
+	}
+
+	switch (getEnvVar("TERM_PROGRAM")) {
+		case "iTerm.app":
+			if (
+				!getEnvVar("TERM_PROGRAM_VERSION") ||
+				/^[0-2]\./.exec(getEnvVar("TERM_PROGRAM_VERSION")) !== null
+			) {
+				return COLORS_256;
+			}
+			return COLORS_16m;
+		case "HyperTerm":
+		case "MacTerm":
+			return COLORS_16m;
+		case "Apple_Terminal":
+			return COLORS_256;
+	}
+
+	if (
+		getEnvVar("COLORTERM") === "truecolor" ||
+		getEnvVar("COLORTERM") === "24bit"
+	) {
+		return COLORS_16m;
+	}
+
+	if (getEnvVar("TERM")) {
+		if (/truecolor/.exec(getEnvVar("TERM")) !== null) {
+			return COLORS_16m;
+		}
+
+		if (/^xterm-256/.exec(getEnvVar("TERM")) !== null) {
+			return COLORS_256;
+		}
+
+		const termEnv = getEnvVar("TERM").toLowerCase();
+
+		if (TERM_ENVS[termEnv]) {
+			return TERM_ENVS[termEnv];
+		}
+		if (TERM_ENVS_REG_EXP.some((term) => term.exec(termEnv) !== null)) {
+			return COLORS_16;
+		}
+	}
+	// Move 16 color COLORTERM below 16m and 256
+	if (getEnvVar("COLORTERM")) {
+		return COLORS_16;
+	}
+	return COLORS_2;
+}