@checodo/better-auth-referral 0.0.0-stage → 0.1.0

package/dist/index-HDtManYT.d.ts

@@ -0,0 +1,777 @@
+import { GenericEndpointContext } from "@better-auth/core";
+import { InferOptionSchema } from "better-auth";
+declare const referralSchema: {
+  /** One code per user. */
+  referralCode: {
+    fields: {
+      userId: {
+        type: "string";
+        required: true;
+        references: {
+          model: string;
+          field: string;
+          onDelete: "cascade";
+        };
+      };
+      /** Uppercase. */
+      code: {
+        type: "string";
+        required: true;
+      };
+      createdAt: {
+        type: "date";
+        required: true;
+      };
+    };
+    indexes: {
+      fields: [string];
+      unique: true;
+    }[];
+  };
+  /** Who referred whom. A user is referred at most once. */
+  referral: {
+    fields: {
+      referrerUserId: {
+        type: "string";
+        required: true;
+        index: true;
+        references: {
+          model: string;
+          field: string;
+          onDelete: "cascade";
+        };
+      };
+      referredUserId: {
+        type: "string";
+        required: true;
+        references: {
+          model: string;
+          field: string;
+          onDelete: "cascade";
+        };
+      };
+      /** The code used at sign-up, kept even if the code changes. */
+      code: {
+        type: "string";
+        required: true;
+      };
+      /** "pending" | "completed" */
+      status: {
+        type: "string";
+        required: true;
+        index: true;
+      };
+      completedAt: {
+        type: "date";
+        required: false;
+      };
+      createdAt: {
+        type: "date";
+        required: true;
+      };
+    };
+    indexes: {
+      fields: [string];
+      unique: true;
+    }[];
+  };
+  /** Steps a referred user has completed. Each step counts once. */
+  referralStep: {
+    fields: {
+      referralId: {
+        type: "string";
+        required: true;
+        references: {
+          model: string;
+          field: string;
+          onDelete: "cascade";
+        };
+      };
+      step: {
+        type: "string";
+        required: true;
+      };
+      /** JSON-encoded. */
+      metadata: {
+        type: "string";
+        required: false;
+      };
+      completedAt: {
+        type: "date";
+        required: true;
+      };
+    };
+    indexes: {
+      fields: [string, string];
+      unique: true;
+    }[];
+  };
+};
+type ReferralSchema = typeof referralSchema;
+/**
+ * - `pending`    the referred user signed up; required `steps` are still open
+ * - `completed`  every required step is done; `onReferralCompleted` has run
+ */
+type ReferralStatus = "pending" | "completed";
+/** A user's referral code, as stored in the `referralCode` table. */
+interface ReferralCode {
+  id: string;
+  userId: string;
+  /** Uppercase. */
+  code: string;
+  createdAt: Date;
+}
+/** A referral, as stored in the `referral` table. */
+interface Referral {
+  id: string;
+  /** The user whose code was used. */
+  referrerUserId: string;
+  /** The user who signed up with it. Unique: a user is referred at most once. */
+  referredUserId: string;
+  /** The code used at sign-up. */
+  code: string;
+  status: ReferralStatus;
+  completedAt?: Date | null | undefined;
+  createdAt: Date;
+}
+/** A completed step of a referral, as stored in the `referralStep` table. */
+interface ReferralStep {
+  id: string;
+  referralId: string;
+  step: string;
+  /** JSON-encoded `metadata` passed when the step was completed. */
+  metadata?: string | null | undefined;
+  completedAt: Date;
+}
+/** A referral with the steps completed so far. */
+interface ReferralWithSteps extends Referral {
+  steps: string[];
+}
+/** What `allowReferral` decides on. */
+interface ReferralCandidate {
+  referrerUserId: string;
+  referredUser: {
+    id: string;
+    email: string;
+  };
+  code: string;
+  /** The request that created the user, `null` outside a request. */
+  context: GenericEndpointContext | null;
+}
+interface ReferralOptions {
+  /** Length of generated codes. Between 6 and 32. Defaults to `8`. */
+  codeLength?: number | undefined;
+  /**
+   * Generates codes instead of the built-in generator (random, without
+   * look-alike characters such as `0`/`O` and `1`/`I`). Codes may use
+   * letters, digits, `-`, and `_` (4 to 64 characters) and are stored in
+   * uppercase. Collisions are retried.
+   */
+  generateCode?: (() => string | Promise<string>) | undefined;
+  /** Give every new user a code when they sign up, not only on `createCode`. Defaults to `false`. */
+  createCodeOnSignUp?: boolean | undefined;
+  /**
+   * Steps a referred user must complete before the referral counts, after
+   * signing up, e.g. `["email-verified", "first-purchase"]`.
+   * `"email-verified"` is recorded automatically when the user's email is
+   * verified; record your own steps with `auth.api.completeReferralStep`.
+   * With `[]`, a referral completes at sign-up, which makes fake sign-ups
+   * worth rewards.
+   *
+   * Defaults to `["email-verified"]` when the app sends verification emails
+   * (`emailVerification.sendVerificationEmail`), otherwise to `[]`.
+   */
+  steps?: readonly string[] | undefined;
+  /**
+   * How many users one user can refer, across all their codes:
+   * `regenerateCode` doesn't reset the count. Unlimited by default.
+   */
+  maxReferralsPerUser?: number | undefined;
+  /**
+   * What happens when someone signs up with a code that doesn't exist or
+   * whose owner has reached `maxReferralsPerUser`: `"ignore"` signs them up without a
+   * referral, `"reject"` fails the sign-up with `INVALID_REFERRAL_CODE`.
+   * Defaults to `"ignore"`.
+   */
+  invalidCode?: "ignore" | "reject" | undefined;
+  /**
+   * Decides whether a sign-up with a valid code counts as a referral, e.g.
+   * to skip sign-ups from the referrer's own IP address. Returning `false`
+   * (or throwing, which is logged) signs the user up without a referral.
+   */
+  allowReferral?: ((candidate: ReferralCandidate) => boolean | Promise<boolean>) | undefined;
+  /** Called when a referral is recorded at sign-up. Errors are logged. */
+  onReferral?: ((referral: Referral) => void | Promise<void>) | undefined;
+  /** Called when a step of a referral is completed for the first time. Errors are logged. */
+  onStepCompleted?: ((details: {
+    referral: Referral;
+    step: string;
+  }) => void | Promise<void>) | undefined;
+  /**
+   * Called once per referral, when every required step is done: grant
+   * rewards here. Errors are logged.
+   */
+  onReferralCompleted?: ((referral: Referral) => void | Promise<void>) | undefined;
+  /**
+   * Show referrers the emails of the users they referred only masked
+   * (`a***@example.com`). Defaults to `true`.
+   */
+  maskEmails?: boolean | undefined;
+  /** Don't show referrers the names of the users they referred. Defaults to `false`. */
+  hideNames?: boolean | undefined;
+  /**
+   * Users with one of these roles (the `role` field of better-auth's
+   * `admin` plugin) may list all referrals. Defaults to `["admin"]`.
+   */
+  adminRoles?: readonly string[] | undefined;
+  /** Users with these ids may list all referrals, whatever their role. */
+  adminUserIds?: readonly string[] | undefined;
+  /**
+   * Rename the plugin's tables or their columns, like better-auth's own
+   * plugins: `{ referral: { modelName: "referrals" } }`.
+   */
+  schema?: InferOptionSchema<ReferralSchema> | undefined;
+}
+declare const REFERRAL_ERROR_CODES: {
+  INVALID_REFERRAL_CODE: import("better-auth").RawError<"INVALID_REFERRAL_CODE">;
+  UNKNOWN_REFERRAL_STEP: import("better-auth").RawError<"UNKNOWN_REFERRAL_STEP">;
+  CODE_GENERATION_FAILED: import("better-auth").RawError<"CODE_GENERATION_FAILED">;
+  METADATA_TOO_LARGE: import("better-auth").RawError<"METADATA_TOO_LARGE">;
+  YOU_ARE_NOT_ALLOWED_TO_LIST_REFERRALS: import("better-auth").RawError<"YOU_ARE_NOT_ALLOWED_TO_LIST_REFERRALS">;
+};
+type ReferralErrorCode = keyof typeof REFERRAL_ERROR_CODES;
+/** A step the plugin records itself, when the referred user's email is verified. */
+declare const EMAIL_VERIFIED_STEP = "email-verified";
+/**
+ * Gives users referral codes, attributes new users to the code they signed
+ * up with (any sign-up method), and tracks steps a referral must complete
+ * before it counts, e.g. a verified email or a first purchase.
+ *
+ * @example
+ * ```ts
+ * import { betterAuth } from "better-auth";
+ * import { referral } from "@checodo/better-auth-referral";
+ *
+ * export const auth = betterAuth({
+ *   plugins: [
+ *     referral({
+ *       steps: ["email-verified", "first-purchase"],
+ *       onReferralCompleted: async ({ referrerUserId }) => {
+ *         await grantCredit(referrerUserId);
+ *       },
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const referral: (options?: ReferralOptions) => {
+  id: "referral";
+  version: string;
+  init(ctx: import("better-auth").AuthContext): {
+    options: {
+      databaseHooks: {
+        user?: {
+          create?: {
+            before?: (user: import("better-auth").User & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                email?: string | undefined;
+                emailVerified?: boolean | undefined;
+                name?: string | undefined;
+                image?: string | null | undefined;
+              } & Record<string, any>;
+            }>;
+            after?: (user: import("better-auth").User & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          update?: {
+            before?: (user: Partial<import("better-auth").User> & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                [x: string]: any;
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                email?: string | undefined;
+                emailVerified?: boolean | undefined;
+                name?: string | undefined;
+                image?: string | null | undefined;
+              };
+            }>;
+            after?: (user: import("better-auth").User & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          delete?: {
+            before?: (user: import("better-auth").User & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void>;
+            after?: (user: import("better-auth").User & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+        };
+        session?: {
+          create?: {
+            before?: (session: import("better-auth").Session & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                userId?: string | undefined;
+                expiresAt?: Date | undefined;
+                token?: string | undefined;
+                ipAddress?: string | null | undefined;
+                userAgent?: string | null | undefined;
+              } & Record<string, any>;
+            }>;
+            after?: (session: import("better-auth").Session & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          update?: {
+            before?: (session: Partial<import("better-auth").Session> & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                [x: string]: any;
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                userId?: string | undefined;
+                expiresAt?: Date | undefined;
+                token?: string | undefined;
+                ipAddress?: string | null | undefined;
+                userAgent?: string | null | undefined;
+              };
+            }>;
+            after?: (session: import("better-auth").Session & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          delete?: {
+            before?: (session: import("better-auth").Session & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void>;
+            after?: (session: import("better-auth").Session & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+        };
+        account?: {
+          create?: {
+            before?: (account: import("better-auth").Account, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                providerId?: string | undefined;
+                accountId?: string | undefined;
+                userId?: string | undefined;
+                accessToken?: string | null | undefined;
+                refreshToken?: string | null | undefined;
+                idToken?: string | null | undefined;
+                accessTokenExpiresAt?: Date | null | undefined;
+                refreshTokenExpiresAt?: Date | null | undefined;
+                scope?: string | null | undefined;
+                password?: string | null | undefined;
+              } & Record<string, any>;
+            }>;
+            after?: (account: import("better-auth").Account, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          update?: {
+            before?: (account: Partial<import("better-auth").Account> & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                [x: string]: any;
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                providerId?: string | undefined;
+                accountId?: string | undefined;
+                userId?: string | undefined;
+                accessToken?: string | null | undefined;
+                refreshToken?: string | null | undefined;
+                idToken?: string | null | undefined;
+                accessTokenExpiresAt?: Date | null | undefined;
+                refreshTokenExpiresAt?: Date | null | undefined;
+                scope?: string | null | undefined;
+                password?: string | null | undefined;
+              };
+            }>;
+            after?: (account: import("better-auth").Account & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          delete?: {
+            before?: (account: import("better-auth").Account & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void>;
+            after?: (account: import("better-auth").Account & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+        };
+        verification?: {
+          create?: {
+            before?: (verification: import("better-auth").Verification & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                value?: string | undefined;
+                expiresAt?: Date | undefined;
+                identifier?: string | undefined;
+              } & Record<string, any>;
+            }>;
+            after?: (verification: import("better-auth").Verification & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          update?: {
+            before?: (verification: Partial<import("better-auth").Verification> & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void | {
+              data: {
+                [x: string]: any;
+                id?: string | undefined;
+                createdAt?: Date | undefined;
+                updatedAt?: Date | undefined;
+                value?: string | undefined;
+                expiresAt?: Date | undefined;
+                identifier?: string | undefined;
+              };
+            }>;
+            after?: (verification: import("better-auth").Verification & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+          delete?: {
+            before?: (verification: import("better-auth").Verification & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<boolean | void>;
+            after?: (verification: import("better-auth").Verification & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null) => Promise<void>;
+          };
+        };
+      } | undefined;
+    };
+  };
+  schema: {
+    referralCode: {
+      fields: {
+        userId: {
+          type: "string";
+          required: true;
+          references: {
+            model: string;
+            field: string;
+            onDelete: "cascade";
+          };
+        };
+        code: {
+          type: "string";
+          required: true;
+        };
+        createdAt: {
+          type: "date";
+          required: true;
+        };
+      };
+      indexes: {
+        fields: [string];
+        unique: true;
+      }[];
+    };
+    referral: {
+      fields: {
+        referrerUserId: {
+          type: "string";
+          required: true;
+          index: true;
+          references: {
+            model: string;
+            field: string;
+            onDelete: "cascade";
+          };
+        };
+        referredUserId: {
+          type: "string";
+          required: true;
+          references: {
+            model: string;
+            field: string;
+            onDelete: "cascade";
+          };
+        };
+        code: {
+          type: "string";
+          required: true;
+        };
+        status: {
+          type: "string";
+          required: true;
+          index: true;
+        };
+        completedAt: {
+          type: "date";
+          required: false;
+        };
+        createdAt: {
+          type: "date";
+          required: true;
+        };
+      };
+      indexes: {
+        fields: [string];
+        unique: true;
+      }[];
+    };
+    referralStep: {
+      fields: {
+        referralId: {
+          type: "string";
+          required: true;
+          references: {
+            model: string;
+            field: string;
+            onDelete: "cascade";
+          };
+        };
+        step: {
+          type: "string";
+          required: true;
+        };
+        metadata: {
+          type: "string";
+          required: false;
+        };
+        completedAt: {
+          type: "date";
+          required: true;
+        };
+      };
+      indexes: {
+        fields: [string, string];
+        unique: true;
+      }[];
+    };
+  };
+  endpoints: {
+    listReferrals: import("better-auth").StrictEndpoint<"/referral/list-referrals", {
+      method: "GET";
+      use: import("better-auth").Middleware<import("better-auth").MiddlewareOptions, (inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<{
+        session: {
+          session: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            userId: string;
+            expiresAt: Date;
+            token: string;
+            ipAddress?: string | null | undefined;
+            userAgent?: string | null | undefined;
+          };
+          user: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            email: string;
+            emailVerified: boolean;
+            name: string;
+            image?: string | null | undefined;
+          };
+        };
+      }>>[];
+      query: import("zod").ZodOptional<import("zod").ZodObject<{
+        limit: import("zod").ZodDefault<import("zod").ZodCoercedNumber<unknown>>;
+        offset: import("zod").ZodDefault<import("zod").ZodCoercedNumber<unknown>>;
+        status: import("zod").ZodOptional<import("zod").ZodEnum<{
+          pending: "pending";
+          completed: "completed";
+        }>>;
+      }, import("zod/v4/core").$strip>>;
+      metadata: {
+        openapi: {
+          description: string;
+        };
+      };
+    }, {
+      referrals: {
+        id: string;
+        status: ReferralStatus;
+        steps: string[];
+        createdAt: Date;
+        completedAt: Date | null;
+        referredUser: {
+          name: string | null;
+          email: string | null;
+        };
+      }[];
+      total: number;
+      completed: number;
+    }>;
+    listAllReferrals: import("better-auth").StrictEndpoint<"/referral/list-all-referrals", {
+      method: "GET";
+      use: import("better-auth").Middleware<import("better-auth").MiddlewareOptions, (inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<{
+        session: {
+          session: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            userId: string;
+            expiresAt: Date;
+            token: string;
+            ipAddress?: string | null | undefined;
+            userAgent?: string | null | undefined;
+          };
+          user: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            email: string;
+            emailVerified: boolean;
+            name: string;
+            image?: string | null | undefined;
+          };
+        };
+      }>>[];
+      query: import("zod").ZodOptional<import("zod").ZodObject<{
+        limit: import("zod").ZodDefault<import("zod").ZodCoercedNumber<unknown>>;
+        offset: import("zod").ZodDefault<import("zod").ZodCoercedNumber<unknown>>;
+        referrerUserId: import("zod").ZodOptional<import("zod").ZodString>;
+        status: import("zod").ZodOptional<import("zod").ZodEnum<{
+          pending: "pending";
+          completed: "completed";
+        }>>;
+      }, import("zod/v4/core").$strip>>;
+      metadata: {
+        openapi: {
+          description: string;
+        };
+      };
+    }, {
+      referrals: ReferralWithSteps[];
+      total: number;
+    }>;
+    completeReferralStep: import("better-auth").StrictEndpoint<string, {
+      method: "POST";
+      body: import("zod").ZodObject<{
+        userId: import("zod").ZodString;
+        step: import("zod").ZodString;
+        metadata: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+      }, import("zod/v4/core").$strip>;
+      metadata: {
+        openapi: {
+          description: string;
+        };
+      };
+    }, {
+      referral: ReferralWithSteps | null;
+    }>;
+    getReferralCode: import("better-auth").StrictEndpoint<"/referral/get-code", {
+      method: "GET";
+      use: import("better-auth").Middleware<import("better-auth").MiddlewareOptions, (inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<{
+        session: {
+          session: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            userId: string;
+            expiresAt: Date;
+            token: string;
+            ipAddress?: string | null | undefined;
+            userAgent?: string | null | undefined;
+          };
+          user: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            email: string;
+            emailVerified: boolean;
+            name: string;
+            image?: string | null | undefined;
+          };
+        };
+      }>>[];
+      metadata: {
+        openapi: {
+          description: string;
+        };
+      };
+    }, {
+      code: string | null;
+    }>;
+    createReferralCode: import("better-auth").StrictEndpoint<"/referral/create-code", {
+      method: "POST";
+      use: import("better-auth").Middleware<import("better-auth").MiddlewareOptions, (inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<{
+        session: {
+          session: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            userId: string;
+            expiresAt: Date;
+            token: string;
+            ipAddress?: string | null | undefined;
+            userAgent?: string | null | undefined;
+          };
+          user: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            email: string;
+            emailVerified: boolean;
+            name: string;
+            image?: string | null | undefined;
+          };
+        };
+      }>>[];
+      metadata: {
+        openapi: {
+          description: string;
+        };
+      };
+    }, {
+      code: string;
+    }>;
+    regenerateReferralCode: import("better-auth").StrictEndpoint<"/referral/regenerate-code", {
+      method: "POST";
+      use: import("better-auth").Middleware<import("better-auth").MiddlewareOptions, (inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<{
+        session: {
+          session: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            userId: string;
+            expiresAt: Date;
+            token: string;
+            ipAddress?: string | null | undefined;
+            userAgent?: string | null | undefined;
+          };
+          user: Record<string, any> & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            email: string;
+            emailVerified: boolean;
+            name: string;
+            image?: string | null | undefined;
+          };
+        };
+      }>>[];
+      metadata: {
+        openapi: {
+          description: string;
+        };
+      };
+    }, {
+      code: string;
+    }>;
+    checkReferralCode: import("better-auth").StrictEndpoint<"/referral/check-code", {
+      method: "GET";
+      query: import("zod").ZodObject<{
+        code: import("zod").ZodString;
+      }, import("zod/v4/core").$strip>;
+      metadata: {
+        openapi: {
+          description: string;
+        };
+      };
+    }, {
+      valid: boolean;
+    }>;
+  };
+  rateLimit: {
+    pathMatcher: (path: string) => path is "/referral/check-code";
+    window: number;
+    max: number;
+  }[];
+  $ERROR_CODES: {
+    INVALID_REFERRAL_CODE: import("better-auth").RawError<"INVALID_REFERRAL_CODE">;
+    UNKNOWN_REFERRAL_STEP: import("better-auth").RawError<"UNKNOWN_REFERRAL_STEP">;
+    CODE_GENERATION_FAILED: import("better-auth").RawError<"CODE_GENERATION_FAILED">;
+    METADATA_TOO_LARGE: import("better-auth").RawError<"METADATA_TOO_LARGE">;
+    YOU_ARE_NOT_ALLOWED_TO_LIST_REFERRALS: import("better-auth").RawError<"YOU_ARE_NOT_ALLOWED_TO_LIST_REFERRALS">;
+  };
+  options: ReferralOptions;
+};
+type ReferralPlugin = ReturnType<typeof referral>;
+/** Lets `auth.$context.getPlugin("referral")` infer this plugin's exact type. */
+declare module "@better-auth/core" {
+  interface BetterAuthPluginRegistry<AuthOptions, Options> {
+    referral: {
+      creator: typeof referral;
+    };
+  }
+}
+export { ReferralErrorCode as a, ReferralCode as c, ReferralStep as d, ReferralWithSteps as f, REFERRAL_ERROR_CODES as i, ReferralOptions as l, referral as n, Referral as o, EMAIL_VERIFIED_STEP as r, ReferralCandidate as s, ReferralPlugin as t, ReferralStatus as u };
+//# sourceMappingURL=index-HDtManYT.d.ts.map