better-auth/dist/plugins/test-utils/index.d.mts

The most comprehensive authentication framework for TypeScript.

import { LoginResult, TestCookie, TestHelpers, TestUtilsOptions } from "./types.mjs";
//#region src/plugins/test-utils/index.d.ts
declare module "@better-auth/core" {
  interface BetterAuthPluginRegistry<AuthOptions, Options> {
    "test-utils": {
      creator: typeof testUtils;
    };
  }
}
/**
 * Test utilities plugin for Better Auth.
 *
 * Provides helpers for integration and E2E testing including:
 * - User/Organization factories (creates objects without DB writes)
 * - Database helpers (save, delete)
 * - Auth helpers (login, getAuthHeaders, getCookies)
 * - OTP capture (when captureOTP: true)
 *
 * This plugin does not register public HTTP routes or API endpoints, but it does
 * expose privileged helpers on `ctx.test` for creating sessions and mutating data.
 * Prefer including it in a test-only auth instance such as `auth.test.ts` instead
 * of a production auth config.
 *
 * If you conditionally spread it into `plugins`, TypeScript may stop inferring
 * `ctx.test` correctly. A separate test-only auth instance keeps the helpers
 * typed without adding the plugin to your production auth config.
 *
 * @example
 * ```ts
 * import { betterAuth } from "better-auth";
 * import { testUtils } from "better-auth/plugins";
 *
 * export const testAuth = betterAuth({
 *   plugins: [
 *     testUtils({ captureOTP: true }),
 *   ],
 * });
 *
 * // In tests, access helpers via context:
 * const ctx = await testAuth.$context;
 * const test = ctx.test;
 *
 * const user = test.createUser({ email: "test@example.com" });
 * const savedUser = await test.saveUser(user);
 * const { headers, cookies } = await test.login({ userId: user.id });
 * ```
 */
declare const testUtils: (options?: TestUtilsOptions) => {
  id: "test-utils";
  version: string;
  init(ctx: import("@better-auth/core").AuthContext): {
    context: {
      test: TestHelpers;
    };
    options: {
      databaseHooks: {
        verification: {
          create: {
            after(verification: {
              identifier: string;
              value: string;
            } | null): Promise<void>;
          };
        };
      };
    } | undefined;
  };
  options: TestUtilsOptions;
};
//#endregion
export { type LoginResult, type TestCookie, type TestHelpers, type TestUtilsOptions, testUtils };