@alexasomba/better-auth-paystack 2.1.0 → 2.2.0

package/dist/types-B5ZnlFrq.d.mts

@@ -0,0 +1,258 @@
+import { GenericEndpointContext, Session, User } from "better-auth";
+import { PaystackCustomerClient, PaystackPlanClient, PaystackProductClient, PaystackSubscriptionClient, PaystackTransactionClient, PaystackWebhookEvent, components } from "@alexasomba/paystack-node";
+//#region src/types.d.ts
+type PaystackCheckoutChannel = "card" | "bank" | "ussd" | "qr" | "mobile_money" | "bank_transfer" | "eft" | "apple_pay";
+/**
+ * Custom models for Paystack Plugin
+ * These align with the database schema in src/schema.ts
+ */
+interface PaystackTransaction {
+  id: string;
+  reference: string;
+  paystackId?: string;
+  referenceId: string;
+  userId: string;
+  amount: number;
+  currency: string;
+  status: string;
+  plan?: string | null;
+  product?: string | null;
+  metadata?: string | null;
+  createdAt: Date;
+  updatedAt: Date;
+}
+interface PaystackProduct {
+  id?: string;
+  name: string;
+  description?: string;
+  price: number;
+  currency: string;
+  quantity?: number;
+  unlimited?: boolean;
+  paystackId?: string;
+  slug?: string;
+  metadata?: string | null;
+  createdAt: Date;
+  updatedAt: Date;
+}
+interface PaystackPlan {
+  id?: string;
+  name: string;
+  description?: string;
+  amount?: number;
+  currency?: string;
+  interval?: string;
+  planCode?: string;
+  paystackId?: string;
+  seatAmount?: number;
+  /**
+   * Deprecated legacy alias for `seatAmount`.
+   * If used, it must still be a numeric amount in the smallest currency unit.
+   */
+  seatPriceId?: number | string;
+  seatPlanCode?: string;
+  invoiceLimit?: number;
+  freeTrial?: {
+    days?: number;
+    onTrialStart?: (subscription: Subscription) => Promise<void>;
+  };
+  limits?: Record<string, unknown>;
+  features?: string[];
+  metadata?: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+/**
+ * Paystack Webhook Payload structure
+ */
+type PaystackWebhookPayload = PaystackWebhookEvent;
+/**
+ * Paystack SDK Result types
+ */
+type PaystackTransactionResponse = components["schemas"]["VerifyResponse"]["data"];
+interface SubscriptionOptions {
+  /**
+   * Enable subscriptions
+   */
+  enabled?: boolean;
+  /**
+   * Plans configuration
+   */
+  plans: PaystackPlan[] | (() => Promise<PaystackPlan[]>);
+  /**
+   * Automatically sync quantity from local DB to Paystack (if seats are used)
+   */
+  autoSyncQuantity?: boolean;
+  /**
+   * Handling of subscription cancellation
+   * @default "at_period_end"
+   */
+  cancelBehavior?: "at_period_end" | "immediately";
+  /**
+   * Handlers for subscription events
+   */
+  onSubscriptionComplete?: (data: {
+    event: PaystackWebhookPayload;
+    subscription: Subscription;
+    plan: PaystackPlan;
+  }, ctx: GenericEndpointContext) => Promise<void>;
+  onSubscriptionCreated?: (data: {
+    event: PaystackWebhookPayload;
+    subscription: Subscription;
+    plan: PaystackPlan;
+  }, ctx: GenericEndpointContext) => Promise<void>;
+  onSubscriptionCancel?: (data: {
+    event: PaystackWebhookPayload;
+    subscription: Subscription;
+  }, ctx: GenericEndpointContext) => Promise<void>;
+  /**
+   * Authorization handler for reference checks
+   */
+  authorizeReference?: (data: {
+    user: User;
+    session: Session;
+    referenceId: string;
+    action: string;
+  }, ctx: GenericEndpointContext) => Promise<boolean>;
+  /**
+   * Require email verification before subscription
+   */
+  requireEmailVerification?: boolean;
+  /**
+   * Restrict checkout to specific Paystack channels for subscription flows.
+   * Use `["card"]` to enforce card-only subscriptions.
+   */
+  allowedPaymentChannels?: PaystackCheckoutChannel[];
+}
+interface PaystackOptions<TPaystackClient extends PaystackClientLike = PaystackClientLike> {
+  /**
+   * Paystack Secret Key
+   */
+  secretKey: string;
+  /**
+   * Deprecated alias for `webhook.secret`.
+   * Use `webhook.secret` for new code.
+   */
+  paystackWebhookSecret?: string;
+  /**
+   * Paystack Client Instance
+   * If provided, will be used instead of creating a new one with secretKey
+   */
+  paystackClient?: TPaystackClient;
+  /**
+   * Webhook configuration
+   */
+  webhook?: {
+    /**
+     * Webhook secret for signature verification
+     */
+    secret?: string;
+    /**
+     * Whether to verify the request origin IP address
+     * @default false
+     */
+    verifyIP?: boolean;
+    /**
+     * List of trusted IP addresses for webhooks.
+     * Defaults to official Paystack IPs if verifyIP is true and this is empty.
+     */
+    trustedIPs?: string[];
+  };
+  /**
+   * Subscription configuration
+   */
+  subscription?: SubscriptionOptions;
+  /**
+   * Billing pattern
+   * @default "native"
+   */
+  billingPattern?: "native" | "local";
+  /**
+   * Global event handler
+   */
+  onEvent?: (event: PaystackWebhookEvent) => Promise<void>;
+  /**
+   * Organization billing configuration
+   */
+  organization?: {
+    enabled?: boolean;
+    getCustomerCreateParams?: (org: {
+      id: string;
+      name: string;
+      email?: string | null;
+    }, ctx: GenericEndpointContext) => Promise<Record<string, unknown>>;
+    onCustomerCreate?: (data: {
+      paystackCustomer: Record<string, unknown>;
+      organization: unknown;
+    }, ctx: GenericEndpointContext) => Promise<void>;
+  };
+  /**
+   * Products configuration
+   */
+  products?: {
+    products?: PaystackProduct[] | (() => Promise<PaystackProduct[]>);
+  };
+  createCustomerOnSignUp?: boolean;
+  onCustomerCreate?: (data: {
+    paystackCustomer: Record<string, unknown>;
+    user: unknown;
+  }, ctx: GenericEndpointContext) => Promise<void>;
+  /**
+   * Custom database schema / model names
+   */
+  schema?: Record<string, {
+    modelName?: string;
+    fields?: Record<string, string>;
+  }>;
+}
+interface Subscription {
+  id: string;
+  userId: string;
+  organizationId?: string;
+  plan: string;
+  pendingPlan?: string | null;
+  paystackSubscriptionCode?: string;
+  paystackCustomerCode?: string;
+  paystackPlanCode?: string;
+  paystackAuthorizationCode?: string;
+  paystackTransactionReference?: string;
+  paystackEmailToken?: string;
+  status: string;
+  seats: number;
+  referenceId: string;
+  periodStart?: Date | null;
+  periodEnd?: Date | null;
+  cancelAtPeriodEnd: boolean;
+  trialStart?: Date | null;
+  trialEnd?: Date | null;
+  groupId?: string | null;
+  createdAt: Date;
+  updatedAt: Date;
+}
+interface ChargeRecurringSubscriptionInput {
+  subscriptionId: string;
+  amount?: number;
+}
+interface ChargeRecurringSubscriptionResult {
+  status: "success" | "failed";
+  data: PaystackTransactionResponse;
+}
+interface PaystackSyncResult {
+  status: "success";
+  count: number;
+}
+type AnyPaystackOptions = PaystackOptions<PaystackClientLike>;
+/**
+ * Exact grouped SDK slices used by this plugin.
+ * This deliberately matches the official SDK surface instead of a handwritten approximation.
+ */
+interface PaystackClientLike {
+  transaction: Pick<PaystackTransactionClient, "initialize" | "verify" | "chargeAuthorization">;
+  customer: Pick<PaystackCustomerClient, "create" | "update" | "fetch">;
+  subscription: Pick<PaystackSubscriptionClient, "create" | "fetch" | "disable" | "enable" | "manageLink">;
+  product: Pick<PaystackProductClient, "fetch" | "list">;
+  plan: Pick<PaystackPlanClient, "list" | "create">;
+}
+//#endregion
+export { PaystackOptions as a, PaystackSyncResult as c, Subscription as d, SubscriptionOptions as f, PaystackClientLike as i, PaystackTransaction as l, ChargeRecurringSubscriptionInput as n, PaystackPlan as o, ChargeRecurringSubscriptionResult as r, PaystackProduct as s, AnyPaystackOptions as t, PaystackTransactionResponse as u };
+//# sourceMappingURL=types-B5ZnlFrq.d.mts.map

package/dist/types-B5ZnlFrq.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-B5ZnlFrq.d.mts","names":["GenericEndpointContext","Session","User","Organization","Member","PaystackPaths","PaystackResponse","PaystackWebhookEvent","PaystackClient","PaystackCustomerClient","PaystackPlanClient","PaystackProductClient","PaystackSubscriptionClient","PaystackTransactionClient","components","PaystackCurrency","PaystackCheckoutChannel","PaystackTransaction","Date","id","reference","paystackId","referenceId","userId","amount","currency","status","plan","product","metadata","createdAt","updatedAt","PaystackProduct","name","description","price","quantity","unlimited","slug","InputPaystackProduct","PaystackUser","paystackCustomerCode","PaystackOrganization","PaystackPlan","Subscription","Promise","Record","interval","planCode","seatAmount","seatPriceId","seatPlanCode","invoiceLimit","freeTrial","days","onTrialStart","subscription","limits","features","PaystackWebhookPayload","PaystackTransactionResponse","PaystackPlanResponse","PaystackCustomerResponse","PaystackSubscriptionResponse","PaystackProductResponse","SubscriptionOptions","enabled","plans","autoSyncQuantity","cancelBehavior","onSubscriptionComplete","event","data","ctx","onSubscriptionCreated","onSubscriptionCancel","authorizeReference","user","session","action","requireEmailVerification","allowedPaymentChannels","PaystackOptions","TPaystackClient","PaystackClientLike","secretKey","paystackWebhookSecret","paystackClient","webhook","secret","verifyIP","trustedIPs","billingPattern","onEvent","organization","getCustomerCreateParams","email","org","onCustomerCreate","paystackCustomer","products","createCustomerOnSignUp","schema","modelName","fields","organizationId","pendingPlan","paystackSubscriptionCode","paystackPlanCode","paystackAuthorizationCode","paystackTransactionReference","paystackEmailToken","seats","periodStart","periodEnd","cancelAtPeriodEnd","trialStart","trialEnd","groupId","ChargeRecurringSubscriptionInput","subscriptionId","ChargeRecurringSubscriptionResult","PaystackSyncResult","count","AnyPaystackOptions","Pick","transaction","customer"],"sources":["../src/types.d.ts"],"mappings":";;;KAOYgB,uBAAAA;;;;;UAWKC,mBAAAA;EACbE,EAAAA;EACAC,SAAAA;EACAC,UAAAA;EACAC,WAAAA;EACAC,MAAAA;EACAC,MAAAA;EACAC,QAAAA;EACAC,MAAAA;EACAC,IAAAA;EACAC,OAAAA;EACAC,QAAAA;EACAC,SAAAA,EAAWZ,IAAAA;EACXa,SAAAA,EAAWb,IAAAA;AAAAA;AAAAA,UAEEc,eAAAA;EACbb,EAAAA;EACAc,IAAAA;EACAC,WAAAA;EACAC,KAAAA;EACAV,QAAAA;EACAW,QAAAA;EACAC,SAAAA;EACAhB,UAAAA;EACAiB,IAAAA;EACAT,QAAAA;EACAC,SAAAA,EAAWZ,IAAAA;EACXa,SAAAA,EAAWb,IAAAA;AAAAA;AAAAA,UAiBEyB,YAAAA;EACbxB,EAAAA;EACAc,IAAAA;EACAC,WAAAA;EACAV,MAAAA;EACAC,QAAAA;EACAsB,QAAAA;EACAC,QAAAA;EACA3B,UAAAA;EACA4B,UAAAA;EAOAG;;;;EAFAF,WAAAA;EACAC,YAAAA;EACAC,YAAAA;EACAC,SAAAA;IACIC,IAAAA;IACAC,YAAAA,IAAgBC,YAAAA,EAAcZ,YAAAA,KAAiBC,OAAAA;EAAAA;EAEnDY,MAAAA,GAASX,MAAAA;EACTY,QAAAA;EACA7B,QAAAA;EACAC,SAAAA,GAAYZ,IAAAA;EACZa,SAAAA,GAAYb,IAAAA;AAAAA;AAKhB;;;AAAA,KAAYyC,sBAAAA,GAAyBpD,oBAAAA;;AAIrC;;KAAYqD,2BAAAA,GAA8B9C,UAAAA;AAAAA,UAKzBmD,mBAAAA;EAQNtB;;;EAJPuB,OAAAA;EAmBkBtB;;;EAflBuB,KAAAA,EAAOxB,YAAAA,YAAwBE,OAAAA,CAAQF,YAAAA;EAmB5BgB;;;EAfXS,gBAAAA;EAkBmCvB;;;;EAbnCwB,cAAAA;EAsBUnE;;;EAlBVoE,sBAAAA,IAA0BE,IAAAA;IACtBD,KAAAA,EAAOZ,sBAAAA;IACPH,YAAAA,EAAcZ,YAAAA;IACdjB,IAAAA,EAAMgB,YAAAA;EAAAA,GACP8B,GAAAA,EAAKzE,sBAAAA,KAA2B6C,OAAAA;EACnC6B,qBAAAA,IAAyBF,IAAAA;IACrBD,KAAAA,EAAOZ,sBAAAA;IACPH,YAAAA,EAAcZ,YAAAA;IACdjB,IAAAA,EAAMgB,YAAAA;EAAAA,GACP8B,GAAAA,EAAKzE,sBAAAA,KAA2B6C,OAAAA;EACnC8B,oBAAAA,IAAwBH,IAAAA;IACpBD,KAAAA,EAAOZ,sBAAAA;IACPH,YAAAA,EAAcZ,YAAAA;EAAAA,GACf6B,GAAAA,EAAKzE,sBAAAA,KAA2B6C,OAAAA;EAX/BW;;;EAeJoB,kBAAAA,IAAsBJ,IAAAA;IAClBK,IAAAA,EAAM3E,IAAAA;IACN4E,OAAAA,EAAS7E,OAAAA;IACTqB,WAAAA;IACAyD,MAAAA;EAAAA,GACDN,GAAAA,EAAKzE,sBAAAA,KAA2B6C,OAAAA;EAhB/B0B;;;EAoBJS,wBAAAA;EAlBIrD;;;;EAuBJsD,sBAAAA,GAAyBjE,uBAAAA;AAAAA;AAAAA,UAEZkE,eAAAA,yBAAwCE,kBAAAA,GAAqBA,kBAAAA;EAtBtEb;;;EA0BJc,SAAAA;EA3BwBb;;;;EAgCxBc,qBAAAA;EAxBIT;;;;EA6BJU,cAAAA,GAAiBJ,eAAAA;EA1BbJ;;;EA8BJS,OAAAA;IA7BmC3C;;;IAiC/B4C,MAAAA;IAxB4C;;AAEpD;;IA2BQC,QAAAA;IA3BiDN;;;;IAgCjDO,UAAAA;EAAAA;EAwBQ3F;;;EAnBZwD,YAAAA,GAAeS,mBAAAA;EAuBHjE;;;;EAlBZ4F,cAAAA;EA4BsB9C;;;EAxBtB+C,OAAAA,IAAWtB,KAAAA,EAAOhE,oBAAAA,KAAyBsC,OAAAA;EA8BlCC;;;EA1BTgD,YAAAA;IACI5B,OAAAA;IACA6B,uBAAAA,IAA2BE,GAAAA;MACvB9E,EAAAA;MACAc,IAAAA;MACA+D,KAAAA;IAAAA,GACDvB,GAAAA,EAAKzE,sBAAAA,KAA2B6C,OAAAA,CAAQC,MAAAA;IAC3CoD,gBAAAA,IAAoB1B,IAAAA;MAChB2B,gBAAAA,EAAkBrD,MAAAA;MAClBgD,YAAAA;IAAAA,GACDrB,GAAAA,EAAKzE,sBAAAA,KAA2B6C,OAAAA;EAAAA;EAvBxBoB;;;EA4BfmC,QAAAA;IACIA,QAAAA,GAAWpE,eAAAA,YAA2Ba,OAAAA,CAAQb,eAAAA;EAAAA;EAElDqE,sBAAAA;EACAH,gBAAAA,IAAoB1B,IAAAA;IAChB2B,gBAAAA,EAAkBrD,MAAAA;IAClB+B,IAAAA;EAAAA,GACDJ,GAAAA,EAAKzE,sBAAAA,KAA2B6C,OAAAA;EAjB3BmD;;;EAqBRM,MAAAA,GAASxD,MAAAA;IACLyD,SAAAA;IACAC,MAAAA,GAAS1D,MAAAA;EAAAA;AAAAA;AAAAA,UAGAF,YAAAA;EACbzB,EAAAA;EACAI,MAAAA;EACAkF,cAAAA;EACA9E,IAAAA;EACA+E,WAAAA;EACAC,wBAAAA;EACAlE,oBAAAA;EACAmE,gBAAAA;EACAC,yBAAAA;EACAC,4BAAAA;EACAC,kBAAAA;EACArF,MAAAA;EACAsF,KAAAA;EACA1F,WAAAA;EACA2F,WAAAA,GAAc/F,IAAAA;EACdgG,SAAAA,GAAYhG,IAAAA;EACZiG,iBAAAA;EACAC,UAAAA,GAAalG,IAAAA;EACbmG,QAAAA,GAAWnG,IAAAA;EACXoG,OAAAA;EACAxF,SAAAA,EAAWZ,IAAAA;EACXa,SAAAA,EAAWb,IAAAA;AAAAA;AAAAA,UAEEqG,gCAAAA;EACbC,cAAAA;EACAhG,MAAAA;AAAAA;AAAAA,UAEaiG,iCAAAA;EACb/F,MAAAA;EACA8C,IAAAA,EAAMZ,2BAAAA;AAAAA;AAAAA,UAEO8D,kBAAAA;EACbhG,MAAAA;EACAiG,KAAAA;AAAAA;AAAAA,KAEQC,kBAAAA,GAAqB1C,eAAAA,CAAgBE,kBAAAA;;;;;UAKhCA,kBAAAA;EACb0C,WAAAA,EAAaD,IAAAA,CAAKhH,yBAAAA;EAClBkH,QAAAA,EAAUF,IAAAA,CAAKpH,sBAAAA;EACf+C,YAAAA,EAAcqE,IAAAA,CAAKjH,0BAAAA;EACnBgB,OAAAA,EAASiG,IAAAA,CAAKlH,qBAAAA;EACdgB,IAAAA,EAAMkG,IAAAA,CAAKnH,kBAAAA;AAAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alexasomba/better-auth-paystack",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Production-ready Paystack billing plugin for Better Auth. Supports subscriptions, one-time payments, organization billing, secure webhooks and more",
   "keywords": [
     "africa",
@@ -65,7 +65,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@alexasomba/paystack-node": "^1.9.2",
+    "@alexasomba/paystack-node": "^1.9.4",
     "better-call": "^1.3.5",
     "defu": "^6.1.7",
     "zod": "^4.3.6"
@@ -85,7 +85,7 @@
     "better-auth": "1.7.0-beta.1",
     "eslint-plugin-import-x": "^4.16.2",
     "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-react-hooks": "^7.1.0",
+    "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-unicorn": "^64.0.0",
     "publint": "^0.3.18",
     "typescript": "^5.9.3",
@@ -97,7 +97,7 @@
     "better-auth": "^1.6.5"
   },
   "optionalDependencies": {
-    "@rollup/rollup-linux-x64-gnu": "^4.60.1"
+    "@rollup/rollup-linux-x64-gnu": "^4.60.2"
   },
   "engines": {
     "node": ">=24.0.0"