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

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"

package/src/index.ts

@@ -1 +1,3 @@
-export {};
+// Shared types and interfaces for BetterAuth, allowing plugins to extend functionality.
+export interface BetterAuthMutators<O, C> {}
+export * from "./types";

package/src/types/helper.ts

@@ -1 +1,6 @@
+type Primitive = string | number | symbol | bigint | boolean | null | undefined;
+
 export type LiteralString = "" | (string & Record<never, never>);
+export type LiteralUnion<LiteralType, BaseType extends Primitive> =
+	| LiteralType
+	| (BaseType & Record<never, never>);

package/src/types/index.ts

@@ -1 +1,2 @@
-export * from "./helper";
+export type * from "./helper";
+export type { BetterAuthAdvancedOptions, GenerateIdFn } from "./init-options";

package/src/types/init-options.ts

@@ -0,0 +1,119 @@
+import type { CookieOptions } from "better-call";
+import type { LiteralUnion } from "./helper";
+import type { Models } from "../db/type";
+
+export type GenerateIdFn = (options: {
+	model: LiteralUnion<Models, string>;
+	size?: number;
+}) => string | false;
+
+export type BetterAuthAdvancedOptions = {
+	/**
+	 * Ip address configuration
+	 */
+	ipAddress?: {
+		/**
+		 * List of headers to use for ip address
+		 *
+		 * Ip address is used for rate limiting and session tracking
+		 *
+		 * @example ["x-client-ip", "x-forwarded-for", "cf-connecting-ip"]
+		 *
+		 * @default
+		 * @link https://github.com/better-auth/better-auth/blob/main/packages/better-auth/src/utils/get-request-ip.ts#L8
+		 */
+		ipAddressHeaders?: string[];
+		/**
+		 * Disable ip tracking
+		 *
+		 * ⚠︎ This is a security risk and it may expose your application to abuse
+		 */
+		disableIpTracking?: boolean;
+	};
+	/**
+	 * Use secure cookies
+	 *
+	 * @default false
+	 */
+	useSecureCookies?: boolean;
+	/**
+	 * Disable trusted origins check
+	 *
+	 * ⚠︎ This is a security risk and it may expose your application to CSRF attacks
+	 */
+	disableCSRFCheck?: boolean;
+	/**
+	 * Configure cookies to be cross subdomains
+	 */
+	crossSubDomainCookies?: {
+		/**
+		 * Enable cross subdomain cookies
+		 */
+		enabled: boolean;
+		/**
+		 * Additional cookies to be shared across subdomains
+		 */
+		additionalCookies?: string[];
+		/**
+		 * The domain to use for the cookies
+		 *
+		 * By default, the domain will be the root
+		 * domain from the base URL.
+		 */
+		domain?: string;
+	};
+	/*
+	 * Allows you to change default cookie names and attributes
+	 *
+	 * default cookie names:
+	 * - "session_token"
+	 * - "session_data"
+	 * - "dont_remember"
+	 *
+	 * plugins can also add additional cookies
+	 */
+	cookies?: {
+		[key: string]: {
+			name?: string;
+			attributes?: CookieOptions;
+		};
+	};
+	defaultCookieAttributes?: CookieOptions;
+	/**
+	 * Prefix for cookies. If a cookie name is provided
+	 * in cookies config, this will be overridden.
+	 *
+	 * @default
+	 * ```txt
+	 * "appName" -> which defaults to "better-auth"
+	 * ```
+	 */
+	cookiePrefix?: string;
+	/**
+	 * Database configuration.
+	 */
+	database?: {
+		/**
+		 * The default number of records to return from the database
+		 * when using the `findMany` adapter method.
+		 *
+		 * @default 100
+		 */
+		defaultFindManyLimit?: number;
+		/**
+		 * If your database auto increments number ids, set this to `true`.
+		 *
+		 * Note: If enabled, we will not handle ID generation (including if you use `generateId`), and it would be expected that your database will provide the ID automatically.
+		 *
+		 * @default false
+		 */
+		useNumberId?: boolean;
+		/**
+		 * Custom generateId function.
+		 *
+		 * If not provided, random ids will be generated.
+		 * If set to false, the database's auto generated id will be used.
+		 */
+		generateId?: GenerateIdFn | false;
+	};
+};

package/tsconfig.json

@@ -4,7 +4,7 @@
     "rootDir": "./src",
     "outDir": "./dist",
     "lib": ["esnext", "dom", "dom.iterable"],
-    "types": []
+    "types": ["node"]
   },
   "include": ["src"]
 }