paddle-checkout-accelerator 2.1.0 → 2.1.1

package/dist/index.d.cts

@@ -0,0 +1,290 @@
+import * as react from 'react';
+import * as _paddle_paddle_js from '@paddle/paddle-js';
+
+interface UpgradeModalProps {
+    open: boolean;
+    onClose: () => void;
+    currentPlan: string;
+    targetPlan: string;
+    targetPriceId: string;
+    yearlySavings?: string;
+    onUpgradeSuccess?: (data: unknown) => void;
+}
+declare function UpgradeModal({ open, onClose, currentPlan, targetPlan, targetPriceId, yearlySavings, onUpgradeSuccess, }: UpgradeModalProps): react.JSX.Element | null;
+
+interface UsageMeterProps {
+    current: number;
+    limit: number;
+}
+declare function UsageMeter({ current, limit, }: UsageMeterProps): react.JSX.Element;
+
+interface TrialBannerProps {
+    daysRemaining: number;
+}
+declare function TrialBanner({ daysRemaining, }: TrialBannerProps): react.JSX.Element;
+
+declare function BillingHistory(): react.JSX.Element;
+
+declare function CustomerPortalButton(): react.JSX.Element;
+
+interface SubscriptionCardProps {
+    plan: string;
+    status: string;
+}
+declare function SubscriptionCard({ plan, status, }: SubscriptionCardProps): react.JSX.Element;
+
+interface SubscriptionGateProps {
+    active: boolean;
+    children: React.ReactNode;
+    fallback?: React.ReactNode;
+}
+declare function SubscriptionGate({ active, children, fallback, }: SubscriptionGateProps): string | number | bigint | boolean | react.JSX.Element | Iterable<react.ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<react.ReactNode> | null | undefined>;
+
+declare function openCheckout(items: {
+    priceId: string;
+    quantity: number;
+}[]): Promise<void>;
+
+declare function getPaddle(): Promise<_paddle_paddle_js.Paddle | undefined>;
+
+interface CheckoutItem {
+    priceId: string;
+    quantity: number;
+}
+interface OpenCheckoutOptions {
+    items: CheckoutItem[];
+    customerEmail?: string;
+}
+
+declare function verifyPaddleWebhook(rawBody: string, signature: string): Promise<unknown>;
+
+type PlanId = "free" | "starter" | "pro" | "business";
+type FeatureKey = "checkout" | "customer_portal" | "usage_limits" | "team_members" | "api_access" | "priority_support";
+declare const plans: Record<PlanId, {
+    name: string;
+    monthlyLimit: number;
+    seatLimit: number;
+    features: FeatureKey[];
+}>;
+declare function getPlanSeatLimit(plan: PlanId): number;
+
+type TeamRole = "owner" | "admin" | "member";
+interface TeamMember {
+    userId: string;
+    email?: string;
+    role: TeamRole;
+    joinedAt: string;
+}
+interface TeamRecord {
+    teamId: string;
+    name: string;
+    plan: PlanId;
+    ownerId: string;
+    members: TeamMember[];
+}
+declare function setTeamAdapter(nextAdapter: BillingAdapter): void;
+declare function createTeam({ teamId, name, ownerId, plan, }: {
+    teamId: string;
+    name: string;
+    ownerId: string;
+    plan?: PlanId;
+}): Promise<TeamRecord>;
+declare function getTeam(teamId: string): Promise<TeamRecord | null>;
+declare function updateTeamPlan(teamId: string, plan: PlanId): Promise<TeamRecord>;
+declare function getSeatUsage(teamId: string): Promise<{
+    used: number;
+    limit: number;
+    remaining: number;
+    allowed: boolean;
+}>;
+declare function canInviteTeamMember(teamId: string): Promise<boolean>;
+declare function addTeamMember({ teamId, userId, email, role, }: {
+    teamId: string;
+    userId: string;
+    email?: string;
+    role?: TeamRole;
+}): Promise<TeamRecord>;
+declare function removeTeamMember({ teamId, userId, }: {
+    teamId: string;
+    userId: string;
+}): Promise<TeamRecord>;
+
+type BillingEventType = "subscription_created" | "payment_succeeded" | "payment_failed" | "subscription_updated" | "subscription_paused" | "subscription_canceled" | "portal_opened" | "repair_performed";
+interface BillingEvent {
+    id: string;
+    userId: string;
+    type: BillingEventType;
+    createdAt: string;
+    metadata?: Record<string, unknown>;
+}
+declare function setBillingEventAdapter(nextAdapter: BillingAdapter): void;
+declare function recordBillingEvent(event: BillingEvent): Promise<BillingEvent>;
+declare function getBillingEvents(userId: string): Promise<BillingEvent[]>;
+
+interface BillingAdapter {
+    getSubscription(userId: string): Promise<SubscriptionRecord | null>;
+    upsertSubscription(record: SubscriptionRecord): Promise<SubscriptionRecord>;
+    getUsage(userId: string, key: string, period: string): Promise<number>;
+    incrementUsage(userId: string, key: string, period: string, amount: number): Promise<number>;
+    getTeam?(teamId: string): Promise<TeamRecord | null>;
+    upsertTeam?(team: TeamRecord): Promise<TeamRecord>;
+    recordBillingEvent?(event: BillingEvent): Promise<BillingEvent>;
+    getBillingEvents?(userId: string): Promise<BillingEvent[]>;
+}
+
+declare const memoryBillingAdapter: BillingAdapter;
+
+type PrismaLike = {
+    subscription: {
+        findUnique(args: unknown): Promise<SubscriptionRecord | null>;
+        upsert(args: unknown): Promise<SubscriptionRecord>;
+    };
+    usageEvent: {
+        findUnique(args: unknown): Promise<{
+            count: number;
+        } | null>;
+        upsert(args: unknown): Promise<{
+            count: number;
+        }>;
+    };
+    team: {
+        findUnique(args: unknown): Promise<TeamRecord | null>;
+        upsert(args: unknown): Promise<TeamRecord>;
+    };
+    billingEvent: {
+        create(args: unknown): Promise<BillingEvent>;
+        findMany(args: unknown): Promise<BillingEvent[]>;
+    };
+};
+declare function createPrismaBillingAdapter(prisma: PrismaLike): BillingAdapter;
+
+type SubscriptionStatus = "active" | "trialing" | "past_due" | "paused" | "canceled" | "expired" | "none";
+interface SubscriptionRecord {
+    userId: string;
+    plan: PlanId;
+    status: SubscriptionStatus;
+    paddleCustomerId?: string;
+    paddleSubscriptionId?: string;
+    currentPeriodEnd?: string;
+}
+declare function setBillingAdapter(nextAdapter: BillingAdapter): void;
+declare function getSubscription(userId: string): Promise<SubscriptionRecord>;
+declare function upsertSubscription(record: SubscriptionRecord): Promise<SubscriptionRecord>;
+declare function isSubscriptionActive(subscription: SubscriptionRecord): boolean;
+declare function requireSubscription(userId: string, minimumPlan?: PlanId): Promise<SubscriptionRecord>;
+
+declare function hasFeature(userId: string, feature: FeatureKey): Promise<boolean>;
+declare function requireFeature(userId: string, feature: FeatureKey): Promise<boolean>;
+
+declare function setUsageAdapter(nextAdapter: BillingAdapter): void;
+declare function getUsage(userId: string, key: string): Promise<number>;
+declare function getUsageLimit(userId: string): Promise<number>;
+declare function canUse(userId: string, key: string): Promise<{
+    allowed: boolean;
+    used: number;
+    limit: number;
+    remaining: number;
+}>;
+declare function incrementUsage(userId: string, key: string, amount?: number): Promise<number>;
+declare function requireUsage(userId: string, key: string): Promise<{
+    allowed: boolean;
+    used: number;
+    limit: number;
+    remaining: number;
+}>;
+
+interface PaddleEvent {
+    event_type?: string;
+    data?: {
+        id?: string;
+        status?: string;
+        customer_id?: string;
+        custom_data?: {
+            userId?: string;
+            plan?: PlanId;
+        };
+        current_billing_period?: {
+            ends_at?: string;
+        };
+    };
+}
+declare function syncPaddleEvent(event: PaddleEvent): Promise<{
+    synced: boolean;
+    reason: string;
+    type?: undefined;
+} | {
+    synced: boolean;
+    type: string;
+    reason?: undefined;
+}>;
+
+declare function protectPlan(userId: string, plan: PlanId): Promise<SubscriptionRecord>;
+declare function protectFeature(userId: string, feature: FeatureKey): Promise<boolean>;
+declare function protectUsage(userId: string, usageKey: string, amount?: number): Promise<{
+    allowed: boolean;
+}>;
+
+declare function seedDemoBilling(): Promise<void>;
+
+interface CreatePortalSessionOptions {
+    customerId: string;
+    returnUrl?: string;
+}
+interface PortalSessionResult {
+    url: string;
+}
+declare function createCustomerPortalSession({ customerId, returnUrl, }: CreatePortalSessionOptions): Promise<PortalSessionResult>;
+
+declare function paddleApi<T>(path: string, options?: RequestInit): Promise<T>;
+
+interface PaddleSubscription {
+    id: string;
+    status: string;
+    customer_id?: string;
+    current_billing_period?: {
+        ends_at?: string;
+    };
+    custom_data?: {
+        userId?: string;
+        plan?: "free" | "starter" | "pro" | "business";
+    };
+}
+interface PaddleSubscriptionResponse {
+    data?: PaddleSubscription;
+}
+interface PaddleSubscriptionListResponse {
+    data?: PaddleSubscription[];
+}
+declare function fetchPaddleSubscription(subscriptionId: string): Promise<PaddleSubscriptionResponse>;
+declare function fetchPaddleSubscriptionsForCustomer(customerId: string): Promise<PaddleSubscriptionListResponse>;
+
+declare function refreshSubscriptionFromPaddle(subscriptionId: string): Promise<SubscriptionRecord>;
+
+interface PaddleCustomer {
+    id: string;
+    email?: string;
+    name?: string;
+    status?: string;
+}
+interface PaddleCustomerListResponse {
+    data?: PaddleCustomer[];
+}
+interface PaddleCustomerResponse {
+    data?: PaddleCustomer;
+}
+declare function fetchPaddleCustomer(customerId: string): Promise<PaddleCustomerResponse>;
+declare function findPaddleCustomersByEmail(email: string): Promise<PaddleCustomerListResponse>;
+declare function findFirstPaddleCustomerByEmail(email: string): Promise<PaddleCustomer | null>;
+
+declare function repairSubscriptionByEmail(email: string): Promise<{
+    customer: PaddleCustomer;
+    subscription: SubscriptionRecord;
+}>;
+
+declare function configureBilling({ adapter, }: {
+    adapter: BillingAdapter;
+}): {
+    adapterConfigured: boolean;
+};
+
+export { type BillingAdapter, type BillingEvent, type BillingEventType, BillingHistory, type CheckoutItem, type CreatePortalSessionOptions, CustomerPortalButton, type FeatureKey, type OpenCheckoutOptions, type PaddleCustomer, type PaddleCustomerListResponse, type PaddleCustomerResponse, type PaddleSubscription, type PaddleSubscriptionListResponse, type PaddleSubscriptionResponse, type PlanId, type PortalSessionResult, SubscriptionCard, SubscriptionGate, type SubscriptionRecord, type SubscriptionStatus, type TeamMember, type TeamRecord, type TeamRole, TrialBanner, UpgradeModal, UsageMeter, addTeamMember, canInviteTeamMember, canUse, configureBilling, createCustomerPortalSession, createPrismaBillingAdapter, createTeam, fetchPaddleCustomer, fetchPaddleSubscription, fetchPaddleSubscriptionsForCustomer, findFirstPaddleCustomerByEmail, findPaddleCustomersByEmail, getBillingEvents, getPaddle, getPlanSeatLimit, getSeatUsage, getSubscription, getTeam, getUsage, getUsageLimit, hasFeature, incrementUsage, isSubscriptionActive, memoryBillingAdapter, openCheckout, paddleApi, plans, protectFeature, protectPlan, protectUsage, recordBillingEvent, refreshSubscriptionFromPaddle, removeTeamMember, repairSubscriptionByEmail, requireFeature, requireSubscription, requireUsage, seedDemoBilling, setBillingAdapter, setBillingEventAdapter, setTeamAdapter, setUsageAdapter, syncPaddleEvent, updateTeamPlan, upsertSubscription, verifyPaddleWebhook };

package/dist/index.d.ts

@@ -0,0 +1,290 @@
+import * as react from 'react';
+import * as _paddle_paddle_js from '@paddle/paddle-js';
+
+interface UpgradeModalProps {
+    open: boolean;
+    onClose: () => void;
+    currentPlan: string;
+    targetPlan: string;
+    targetPriceId: string;
+    yearlySavings?: string;
+    onUpgradeSuccess?: (data: unknown) => void;
+}
+declare function UpgradeModal({ open, onClose, currentPlan, targetPlan, targetPriceId, yearlySavings, onUpgradeSuccess, }: UpgradeModalProps): react.JSX.Element | null;
+
+interface UsageMeterProps {
+    current: number;
+    limit: number;
+}
+declare function UsageMeter({ current, limit, }: UsageMeterProps): react.JSX.Element;
+
+interface TrialBannerProps {
+    daysRemaining: number;
+}
+declare function TrialBanner({ daysRemaining, }: TrialBannerProps): react.JSX.Element;
+
+declare function BillingHistory(): react.JSX.Element;
+
+declare function CustomerPortalButton(): react.JSX.Element;
+
+interface SubscriptionCardProps {
+    plan: string;
+    status: string;
+}
+declare function SubscriptionCard({ plan, status, }: SubscriptionCardProps): react.JSX.Element;
+
+interface SubscriptionGateProps {
+    active: boolean;
+    children: React.ReactNode;
+    fallback?: React.ReactNode;
+}
+declare function SubscriptionGate({ active, children, fallback, }: SubscriptionGateProps): string | number | bigint | boolean | react.JSX.Element | Iterable<react.ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<react.ReactNode> | null | undefined>;
+
+declare function openCheckout(items: {
+    priceId: string;
+    quantity: number;
+}[]): Promise<void>;
+
+declare function getPaddle(): Promise<_paddle_paddle_js.Paddle | undefined>;
+
+interface CheckoutItem {
+    priceId: string;
+    quantity: number;
+}
+interface OpenCheckoutOptions {
+    items: CheckoutItem[];
+    customerEmail?: string;
+}
+
+declare function verifyPaddleWebhook(rawBody: string, signature: string): Promise<unknown>;
+
+type PlanId = "free" | "starter" | "pro" | "business";
+type FeatureKey = "checkout" | "customer_portal" | "usage_limits" | "team_members" | "api_access" | "priority_support";
+declare const plans: Record<PlanId, {
+    name: string;
+    monthlyLimit: number;
+    seatLimit: number;
+    features: FeatureKey[];
+}>;
+declare function getPlanSeatLimit(plan: PlanId): number;
+
+type TeamRole = "owner" | "admin" | "member";
+interface TeamMember {
+    userId: string;
+    email?: string;
+    role: TeamRole;
+    joinedAt: string;
+}
+interface TeamRecord {
+    teamId: string;
+    name: string;
+    plan: PlanId;
+    ownerId: string;
+    members: TeamMember[];
+}
+declare function setTeamAdapter(nextAdapter: BillingAdapter): void;
+declare function createTeam({ teamId, name, ownerId, plan, }: {
+    teamId: string;
+    name: string;
+    ownerId: string;
+    plan?: PlanId;
+}): Promise<TeamRecord>;
+declare function getTeam(teamId: string): Promise<TeamRecord | null>;
+declare function updateTeamPlan(teamId: string, plan: PlanId): Promise<TeamRecord>;
+declare function getSeatUsage(teamId: string): Promise<{
+    used: number;
+    limit: number;
+    remaining: number;
+    allowed: boolean;
+}>;
+declare function canInviteTeamMember(teamId: string): Promise<boolean>;
+declare function addTeamMember({ teamId, userId, email, role, }: {
+    teamId: string;
+    userId: string;
+    email?: string;
+    role?: TeamRole;
+}): Promise<TeamRecord>;
+declare function removeTeamMember({ teamId, userId, }: {
+    teamId: string;
+    userId: string;
+}): Promise<TeamRecord>;
+
+type BillingEventType = "subscription_created" | "payment_succeeded" | "payment_failed" | "subscription_updated" | "subscription_paused" | "subscription_canceled" | "portal_opened" | "repair_performed";
+interface BillingEvent {
+    id: string;
+    userId: string;
+    type: BillingEventType;
+    createdAt: string;
+    metadata?: Record<string, unknown>;
+}
+declare function setBillingEventAdapter(nextAdapter: BillingAdapter): void;
+declare function recordBillingEvent(event: BillingEvent): Promise<BillingEvent>;
+declare function getBillingEvents(userId: string): Promise<BillingEvent[]>;
+
+interface BillingAdapter {
+    getSubscription(userId: string): Promise<SubscriptionRecord | null>;
+    upsertSubscription(record: SubscriptionRecord): Promise<SubscriptionRecord>;
+    getUsage(userId: string, key: string, period: string): Promise<number>;
+    incrementUsage(userId: string, key: string, period: string, amount: number): Promise<number>;
+    getTeam?(teamId: string): Promise<TeamRecord | null>;
+    upsertTeam?(team: TeamRecord): Promise<TeamRecord>;
+    recordBillingEvent?(event: BillingEvent): Promise<BillingEvent>;
+    getBillingEvents?(userId: string): Promise<BillingEvent[]>;
+}
+
+declare const memoryBillingAdapter: BillingAdapter;
+
+type PrismaLike = {
+    subscription: {
+        findUnique(args: unknown): Promise<SubscriptionRecord | null>;
+        upsert(args: unknown): Promise<SubscriptionRecord>;
+    };
+    usageEvent: {
+        findUnique(args: unknown): Promise<{
+            count: number;
+        } | null>;
+        upsert(args: unknown): Promise<{
+            count: number;
+        }>;
+    };
+    team: {
+        findUnique(args: unknown): Promise<TeamRecord | null>;
+        upsert(args: unknown): Promise<TeamRecord>;
+    };
+    billingEvent: {
+        create(args: unknown): Promise<BillingEvent>;
+        findMany(args: unknown): Promise<BillingEvent[]>;
+    };
+};
+declare function createPrismaBillingAdapter(prisma: PrismaLike): BillingAdapter;
+
+type SubscriptionStatus = "active" | "trialing" | "past_due" | "paused" | "canceled" | "expired" | "none";
+interface SubscriptionRecord {
+    userId: string;
+    plan: PlanId;
+    status: SubscriptionStatus;
+    paddleCustomerId?: string;
+    paddleSubscriptionId?: string;
+    currentPeriodEnd?: string;
+}
+declare function setBillingAdapter(nextAdapter: BillingAdapter): void;
+declare function getSubscription(userId: string): Promise<SubscriptionRecord>;
+declare function upsertSubscription(record: SubscriptionRecord): Promise<SubscriptionRecord>;
+declare function isSubscriptionActive(subscription: SubscriptionRecord): boolean;
+declare function requireSubscription(userId: string, minimumPlan?: PlanId): Promise<SubscriptionRecord>;
+
+declare function hasFeature(userId: string, feature: FeatureKey): Promise<boolean>;
+declare function requireFeature(userId: string, feature: FeatureKey): Promise<boolean>;
+
+declare function setUsageAdapter(nextAdapter: BillingAdapter): void;
+declare function getUsage(userId: string, key: string): Promise<number>;
+declare function getUsageLimit(userId: string): Promise<number>;
+declare function canUse(userId: string, key: string): Promise<{
+    allowed: boolean;
+    used: number;
+    limit: number;
+    remaining: number;
+}>;
+declare function incrementUsage(userId: string, key: string, amount?: number): Promise<number>;
+declare function requireUsage(userId: string, key: string): Promise<{
+    allowed: boolean;
+    used: number;
+    limit: number;
+    remaining: number;
+}>;
+
+interface PaddleEvent {
+    event_type?: string;
+    data?: {
+        id?: string;
+        status?: string;
+        customer_id?: string;
+        custom_data?: {
+            userId?: string;
+            plan?: PlanId;
+        };
+        current_billing_period?: {
+            ends_at?: string;
+        };
+    };
+}
+declare function syncPaddleEvent(event: PaddleEvent): Promise<{
+    synced: boolean;
+    reason: string;
+    type?: undefined;
+} | {
+    synced: boolean;
+    type: string;
+    reason?: undefined;
+}>;
+
+declare function protectPlan(userId: string, plan: PlanId): Promise<SubscriptionRecord>;
+declare function protectFeature(userId: string, feature: FeatureKey): Promise<boolean>;
+declare function protectUsage(userId: string, usageKey: string, amount?: number): Promise<{
+    allowed: boolean;
+}>;
+
+declare function seedDemoBilling(): Promise<void>;
+
+interface CreatePortalSessionOptions {
+    customerId: string;
+    returnUrl?: string;
+}
+interface PortalSessionResult {
+    url: string;
+}
+declare function createCustomerPortalSession({ customerId, returnUrl, }: CreatePortalSessionOptions): Promise<PortalSessionResult>;
+
+declare function paddleApi<T>(path: string, options?: RequestInit): Promise<T>;
+
+interface PaddleSubscription {
+    id: string;
+    status: string;
+    customer_id?: string;
+    current_billing_period?: {
+        ends_at?: string;
+    };
+    custom_data?: {
+        userId?: string;
+        plan?: "free" | "starter" | "pro" | "business";
+    };
+}
+interface PaddleSubscriptionResponse {
+    data?: PaddleSubscription;
+}
+interface PaddleSubscriptionListResponse {
+    data?: PaddleSubscription[];
+}
+declare function fetchPaddleSubscription(subscriptionId: string): Promise<PaddleSubscriptionResponse>;
+declare function fetchPaddleSubscriptionsForCustomer(customerId: string): Promise<PaddleSubscriptionListResponse>;
+
+declare function refreshSubscriptionFromPaddle(subscriptionId: string): Promise<SubscriptionRecord>;
+
+interface PaddleCustomer {
+    id: string;
+    email?: string;
+    name?: string;
+    status?: string;
+}
+interface PaddleCustomerListResponse {
+    data?: PaddleCustomer[];
+}
+interface PaddleCustomerResponse {
+    data?: PaddleCustomer;
+}
+declare function fetchPaddleCustomer(customerId: string): Promise<PaddleCustomerResponse>;
+declare function findPaddleCustomersByEmail(email: string): Promise<PaddleCustomerListResponse>;
+declare function findFirstPaddleCustomerByEmail(email: string): Promise<PaddleCustomer | null>;
+
+declare function repairSubscriptionByEmail(email: string): Promise<{
+    customer: PaddleCustomer;
+    subscription: SubscriptionRecord;
+}>;
+
+declare function configureBilling({ adapter, }: {
+    adapter: BillingAdapter;
+}): {
+    adapterConfigured: boolean;
+};
+
+export { type BillingAdapter, type BillingEvent, type BillingEventType, BillingHistory, type CheckoutItem, type CreatePortalSessionOptions, CustomerPortalButton, type FeatureKey, type OpenCheckoutOptions, type PaddleCustomer, type PaddleCustomerListResponse, type PaddleCustomerResponse, type PaddleSubscription, type PaddleSubscriptionListResponse, type PaddleSubscriptionResponse, type PlanId, type PortalSessionResult, SubscriptionCard, SubscriptionGate, type SubscriptionRecord, type SubscriptionStatus, type TeamMember, type TeamRecord, type TeamRole, TrialBanner, UpgradeModal, UsageMeter, addTeamMember, canInviteTeamMember, canUse, configureBilling, createCustomerPortalSession, createPrismaBillingAdapter, createTeam, fetchPaddleCustomer, fetchPaddleSubscription, fetchPaddleSubscriptionsForCustomer, findFirstPaddleCustomerByEmail, findPaddleCustomersByEmail, getBillingEvents, getPaddle, getPlanSeatLimit, getSeatUsage, getSubscription, getTeam, getUsage, getUsageLimit, hasFeature, incrementUsage, isSubscriptionActive, memoryBillingAdapter, openCheckout, paddleApi, plans, protectFeature, protectPlan, protectUsage, recordBillingEvent, refreshSubscriptionFromPaddle, removeTeamMember, repairSubscriptionByEmail, requireFeature, requireSubscription, requireUsage, seedDemoBilling, setBillingAdapter, setBillingEventAdapter, setTeamAdapter, setUsageAdapter, syncPaddleEvent, updateTeamPlan, upsertSubscription, verifyPaddleWebhook };