better-auth/dist/plugins/magic-link/index.d.mts

The most comprehensive authentication framework for TypeScript.

import { Awaitable, GenericEndpointContext } from "@better-auth/core";
import * as z from "zod";
//#region src/plugins/magic-link/index.d.ts
declare module "@better-auth/core" {
  interface BetterAuthPluginRegistry<AuthOptions, Options> {
    "magic-link": {
      creator: typeof magicLink;
    };
  }
}
interface MagicLinkOptions {
  /**
   * Time in seconds until the magic link expires.
   * @default (60 * 5) // 5 minutes
   */
  expiresIn?: number | undefined;
  /**
   * Allowed attempts for verifying the magic link token.
   *
   * @deprecated Multi-attempt verification is no longer supported. Each
   * magic link token is consumed atomically on the first verification call,
   * so a given token mints at most one session regardless of this value
   * The option is kept for source compatibility and may be removed in a future
   * major; any value other than `1` is ignored and emits a `console.warn` at
   * plugin construction.
   *
   * @default 1
   */
  allowedAttempts?: number;
  /**
   * Send magic link implementation.
   */
  sendMagicLink: (data: {
    email: string;
    url: string;
    token: string;
    metadata?: Record<string, any>;
  }, ctx?: GenericEndpointContext | undefined) => Awaitable<void>;
  /**
   * Disable sign up if user is not found.
   *
   * @default false
   */
  disableSignUp?: boolean | undefined;
  /**
   * Rate limit configuration.
   *
   * @default {
   *  window: 60,
   *  max: 5,
   * }
   */
  rateLimit?: {
    window: number;
    max: number;
  } | undefined;
  /**
   * Custom function to generate a token
   */
  generateToken?: ((email: string) => Awaitable<string>) | undefined;
  /**
   * This option allows you to configure how the token is stored in your database.
   * Note: This will not affect the token that's sent, it will only affect the token stored in your database.
   *
   * @default "plain"
   */
  storeToken?: ("plain" | "hashed" | {
    type: "custom-hasher";
    hash: (token: string) => Promise<string>;
  }) | undefined;
}
declare const magicLink: (options: MagicLinkOptions) => {
  id: "magic-link";
  version: string;
  endpoints: {
    /**
     * ### Endpoint
     *
     * POST `/sign-in/magic-link`
     *
     * ### API Methods
     *
     * **server:**
     * `auth.api.signInMagicLink`
     *
     * **client:**
     * `authClient.signIn.magicLink`
     *
     * @see [Read our docs to learn more.](https://better-auth.com/docs/plugins/sign-in#api-method-sign-in-magic-link)
     */
    signInMagicLink: import("better-call").StrictEndpoint<"/sign-in/magic-link", {
      method: "POST";
      requireHeaders: true;
      use: ((inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>)[];
      body: z.ZodObject<{
        email: z.ZodEmail;
        name: z.ZodOptional<z.ZodString>;
        callbackURL: z.ZodOptional<z.ZodString>;
        newUserCallbackURL: z.ZodOptional<z.ZodString>;
        errorCallbackURL: z.ZodOptional<z.ZodString>;
        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
      }, z.core.$strip>;
      metadata: {
        openapi: {
          operationId: string;
          description: string;
          responses: {
            200: {
              description: string;
              content: {
                "application/json": {
                  schema: {
                    type: "object";
                    properties: {
                      status: {
                        type: string;
                      };
                    };
                  };
                };
              };
            };
          };
        };
      };
    }, {
      status: boolean;
    }>;
    /**
     * ### Endpoint
     *
     * GET `/magic-link/verify`
     *
     * ### API Methods
     *
     * **server:**
     * `auth.api.magicLinkVerify`
     *
     * **client:**
     * `authClient.magicLink.verify`
     *
     * @see [Read our docs to learn more.](https://better-auth.com/docs/plugins/magic-link#api-method-magic-link-verify)
     */
    magicLinkVerify: import("better-call").StrictEndpoint<"/magic-link/verify", {
      method: "GET";
      query: z.ZodObject<{
        token: z.ZodString;
        callbackURL: z.ZodOptional<z.ZodString>;
        errorCallbackURL: z.ZodOptional<z.ZodString>;
        newUserCallbackURL: z.ZodOptional<z.ZodString>;
      }, z.core.$strip>;
      use: ((inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>)[];
      requireHeaders: true;
      metadata: {
        openapi: {
          operationId: string;
          description: string;
          responses: {
            200: {
              description: string;
              content: {
                "application/json": {
                  schema: {
                    type: "object";
                    properties: {
                      session: {
                        $ref: string;
                      };
                      user: {
                        $ref: string;
                      };
                    };
                  };
                };
              };
            };
          };
        };
      };
    }, {
      token: string;
      user: {
        id: string;
        createdAt: Date;
        updatedAt: Date;
        email: string;
        emailVerified: boolean;
        name: string;
        image?: string | null | undefined;
      };
      session: {
        id: string;
        createdAt: Date;
        updatedAt: Date;
        userId: string;
        expiresAt: Date;
        token: string;
        ipAddress?: string | null | undefined;
        userAgent?: string | null | undefined;
      };
    }>;
  };
  rateLimit: {
    pathMatcher(path: string): boolean;
    window: number;
    max: number;
  }[];
  options: MagicLinkOptions;
};
//#endregion
export { MagicLinkOptions, magicLink };