better-auth-lead 0.4.3 → 0.6.0

package/dist/index-BX1SlAVz.d.mts

@@ -0,0 +1,472 @@
+import { InferOptionSchema, StandardSchemaV1 } from "better-auth";
+
+//#region src/schema.d.ts
+declare const lead$1: {
+  lead: {
+    fields: {
+      createdAt: {
+        type: "date";
+        defaultValue: () => Date;
+        required: true;
+        input: false;
+      };
+      updatedAt: {
+        type: "date";
+        defaultValue: () => Date;
+        onUpdate: () => Date;
+        required: true;
+        input: false;
+      };
+      email: {
+        type: "string";
+        required: false;
+        unique: true;
+      };
+      userId: {
+        type: "string";
+        required: false;
+        unique: true;
+        references: {
+          model: string;
+          field: string;
+        };
+      };
+      confirmed: {
+        type: "boolean";
+        defaultValue: false;
+        required: true;
+        input: false;
+      };
+      confirmationSentAt: {
+        type: "date";
+        required: false;
+        input: false;
+      };
+      metadata: {
+        type: "string";
+        required: false;
+      };
+    };
+  };
+};
+//#endregion
+//#region src/type.d.ts
+interface LeadOptions {
+  /**
+   * Send a verification email
+   * @param data the data object
+   * @param request the request object
+   */
+  sendConfirmationEmail?: (
+  /**
+   * @param lead the lead to send the confirmation email to
+   * @param email the email address to send the confirmation to
+   * @param url the confirmation url
+   * @param token the confirmation token
+   * @param unsubscribeUrl the one-click unsubscribe URL (RFC 8058) to include in List-Unsubscribe headers
+   */
+
+  data: {
+    lead: Lead;
+    email: string;
+    url: string;
+    token: string;
+    unsubscribeUrl: string;
+  }, request?: Request) => Promise<boolean>;
+  onConfirmed?: (
+  /**
+   * @param lead the lead that confirmed their subscription
+   */
+
+  data: {
+    lead: Lead;
+  }, request?: Request) => Promise<void>;
+  /**
+   * Number of seconds the confirmation token is
+   * valid for.
+   * @default 3600 seconds (1 hour)
+   */
+  expiresIn?: number;
+  /**
+   * Number of seconds the unsubscribe token is valid for.
+   * Should be long-lived since users may click the link long
+   * after receiving the email.
+   * @default undefined (no expiry)
+   */
+  unsubscribeExpiresIn?: number;
+  /**
+   * Rate limit configuration for /lead/subscribe and /lead/resend endpoints.
+   */
+  rateLimit?: {
+    /**
+     * Time window in seconds for which the rate limit applies.
+     * @default 10 seconds
+     */
+    window: number;
+    /**
+     * Maximum number of requests allowed within the time window.
+     * @default 3 requests
+     */
+    max: number;
+  };
+  /**
+   * Schema for the lead plugin
+   */
+  schema?: InferOptionSchema<typeof lead$1> | undefined;
+  metadata?: {
+    validationSchema?: StandardSchemaV1;
+  };
+  /**
+   * Admin-only endpoints. Requires the better-auth `admin` plugin to be
+   * registered. When enabled, exposes `GET /lead/list` which returns all
+   * leads to users whose role matches `admin.roles`.
+   */
+  admin?: {
+    /**
+     * Enable admin endpoints (e.g. `/lead/list`).
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * Roles allowed to call admin endpoints. The check is performed against
+     * `session.user.role` (added by the admin plugin), which may contain a
+     * comma-separated list of roles.
+     * @default ['admin']
+     */
+    roles?: string[];
+  };
+}
+interface Lead {
+  /**
+   * Database identifier
+   */
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
+  email: string | null;
+  userId: string | null;
+  confirmed: boolean;
+  confirmationSentAt: Date | null;
+  metadata?: string;
+}
+type LeadPayload = {
+  email?: string | null;
+  userId?: string | null;
+  metadata?: string;
+};
+//#endregion
+//#region src/index.d.ts
+declare const lead: <O extends LeadOptions>(options?: O) => {
+  id: "lead";
+  schema: {
+    lead: {
+      fields: {
+        createdAt: {
+          type: "date";
+          defaultValue: () => Date;
+          required: true;
+          input: false;
+        };
+        updatedAt: {
+          type: "date";
+          defaultValue: () => Date;
+          onUpdate: () => Date;
+          required: true;
+          input: false;
+        };
+        email: {
+          type: "string";
+          required: false;
+          unique: true;
+        };
+        userId: {
+          type: "string";
+          required: false;
+          unique: true;
+          references: {
+            model: string;
+            field: string;
+          };
+        };
+        confirmed: {
+          type: "boolean";
+          defaultValue: false;
+          required: true;
+          input: false;
+        };
+        confirmationSentAt: {
+          type: "date";
+          required: false;
+          input: false;
+        };
+        metadata: {
+          type: "string";
+          required: false;
+        };
+      };
+    };
+  };
+  endpoints: {
+    listLeads?: import("better-auth").StrictEndpoint<"/lead/list-leads", {
+      method: "GET";
+      query: import("zod").ZodObject<{
+        searchValue: import("zod").ZodOptional<import("zod").ZodString>;
+        searchField: import("zod").ZodOptional<import("zod").ZodEnum<{
+          email: "email";
+        }>>;
+        searchOperator: import("zod").ZodOptional<import("zod").ZodEnum<{
+          contains: "contains";
+          starts_with: "starts_with";
+          ends_with: "ends_with";
+        }>>;
+        limit: import("zod").ZodOptional<import("zod").ZodCoercedNumber<unknown>>;
+        offset: import("zod").ZodOptional<import("zod").ZodCoercedNumber<unknown>>;
+        sortBy: import("zod").ZodOptional<import("zod").ZodString>;
+        sortDirection: import("zod").ZodOptional<import("zod").ZodEnum<{
+          asc: "asc";
+          desc: "desc";
+        }>>;
+        filterField: import("zod").ZodOptional<import("zod").ZodString>;
+        filterValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodUnion<[import("zod").ZodUnion<[import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber]>, import("zod").ZodBoolean]>, import("zod").ZodArray<import("zod").ZodString>]>, import("zod").ZodArray<import("zod").ZodNumber>]>>;
+        filterOperator: import("zod").ZodOptional<import("zod").ZodEnum<{
+          in: "in";
+          contains: "contains";
+          starts_with: "starts_with";
+          ends_with: "ends_with";
+          eq: "eq";
+          ne: "ne";
+          lt: "lt";
+          lte: "lte";
+          gt: "gt";
+          gte: "gte";
+          not_in: "not_in";
+        }>>;
+      }, import("better-auth").$strip>;
+      use: ((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;
+          };
+        };
+      }>)[];
+    }, {
+      leads: Lead[];
+      total: number;
+      limit: number;
+      offset: number;
+    }> | undefined;
+    getLead?: import("better-auth").StrictEndpoint<"lead/get-lead", {
+      method: "POST";
+      query: import("zod").ZodObject<{
+        id: import("zod").ZodString;
+      }, import("better-auth").$strip>;
+      use: ((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;
+          };
+        };
+      }>)[];
+    }, Lead> | undefined;
+    removeLead?: import("better-auth").StrictEndpoint<"lead/remove-lead", {
+      method: "POST";
+      body: import("zod").ZodObject<{
+        leadId: import("zod").ZodCoercedString<unknown>;
+      }, import("better-auth").$strip>;
+      use: ((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;
+          };
+        };
+      }>)[];
+    }, {
+      success: boolean;
+    }> | undefined;
+    subscribe: import("better-auth").StrictEndpoint<"/lead/subscribe", {
+      method: "POST";
+      body: import("zod").ZodObject<{
+        email: import("zod").ZodOptional<import("zod").ZodString>;
+        metadata: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
+      }, import("better-auth").$strip>;
+      metadata: {
+        $Infer: {
+          body: {
+            email?: string;
+            metadata?: (O extends {
+              metadata: {
+                validationSchema: import("better-auth").StandardSchemaV1<unknown, infer Out>;
+              };
+            } ? Out : Record<string, any>) | undefined;
+          };
+        };
+      };
+    }, {
+      status: boolean;
+    }>;
+    verify: import("better-auth").StrictEndpoint<"/lead/verify", {
+      method: "GET";
+      query: import("zod").ZodObject<{
+        token: import("zod").ZodString;
+      }, import("better-auth").$strip>;
+    }, {
+      status: boolean;
+    }>;
+    unsubscribe: import("better-auth").StrictEndpoint<"/lead/unsubscribe", {
+      method: "POST";
+      query: import("zod").ZodObject<{
+        token: import("zod").ZodString;
+      }, import("better-auth").$strip>;
+      metadata: {
+        allowedMediaTypes: never[];
+      };
+    }, {
+      status: boolean;
+    }>;
+    unsubscribeSession: import("better-auth").StrictEndpoint<"/lead/unsubscribe-session", {
+      method: "POST";
+      use: ((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;
+          };
+        };
+      }>)[];
+    }, {
+      status: boolean;
+    }>;
+    resend: import("better-auth").StrictEndpoint<"/lead/resend", {
+      method: "POST";
+      body: import("zod").ZodObject<{
+        email: import("zod").ZodOptional<import("zod").ZodString>;
+      }, import("better-auth").$strip>;
+    }, {
+      status: boolean;
+    }>;
+    update: import("better-auth").StrictEndpoint<"/lead/update", {
+      method: "POST";
+      body: import("zod").ZodObject<{
+        metadata: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
+      }, import("better-auth").$strip>;
+      use: ((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: {
+        $Infer: {
+          body: {
+            metadata?: (O extends {
+              metadata: {
+                validationSchema: import("better-auth").StandardSchemaV1<unknown, infer Out>;
+              };
+            } ? Out : Record<string, any>) | undefined;
+          };
+        };
+      };
+    }, {
+      status: boolean;
+    }>;
+  };
+  options: NoInfer<O>;
+  rateLimit: {
+    pathMatcher: (path: string) => boolean;
+    window: number;
+    max: number;
+  }[];
+  $ERROR_CODES: {
+    FORBIDDEN: import("better-auth").RawError<"FORBIDDEN">;
+    INVALID_EMAIL: import("better-auth").RawError<"INVALID_EMAIL">;
+    INVALID_TOKEN: import("better-auth").RawError<"INVALID_TOKEN">;
+    TOKEN_EXPIRED: import("better-auth").RawError<"TOKEN_EXPIRED">;
+    INVALID_METADATA: import("better-auth").RawError<"INVALID_METADATA">;
+    EMAIL_OR_SESSION_REQUIRED: import("better-auth").RawError<"EMAIL_OR_SESSION_REQUIRED">;
+    ADMIN_PLUGIN_REQUIRED: import("better-auth").RawError<"ADMIN_PLUGIN_REQUIRED">;
+    LEAD_NOT_FOUND: import("better-auth").RawError<"LEAD_NOT_FOUND">;
+  };
+};
+//#endregion
+export { LeadPayload as i, Lead as n, LeadOptions as r, lead as t };
+//# sourceMappingURL=index-BX1SlAVz.d.mts.map

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import { i as LeadPayload, n as Lead, r as LeadOptions, t as lead } from "./index-P6m89iLp.mjs";
+import { i as LeadPayload, n as Lead, r as LeadOptions, t as lead } from "./index-BX1SlAVz.mjs";
 export { type Lead, type LeadOptions, type LeadPayload, lead };