@zucker-framework/payment 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,283 @@
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { Type, DynamicModule, InjectionToken } from '@nestjs/common';
+
+/**
+ * 支付网关接口 — 不绑定任何具体支付商。
+ * 用户通过注入 Stripe/PayPal/微信支付适配器来使用。
+ */
+interface PaymentProvider {
+    id: string;
+    name: string;
+    /** 创建支付意图/订单 */
+    createPaymentIntent(params: CreatePaymentParams): Promise<PaymentIntent>;
+    /** 确认支付 */
+    confirmPayment(intentId: string): Promise<PaymentResult>;
+    /** 退款 */
+    refund(paymentId: string, amount?: number, reason?: string): Promise<RefundResult>;
+    /** 查询支付状态 */
+    getPaymentStatus(intentId: string): Promise<PaymentStatus>;
+    /** 处理 Webhook */
+    handleWebhook(payload: unknown, signature: string): Promise<WebhookEvent>;
+}
+interface CreatePaymentParams {
+    amount: number;
+    currency: string;
+    description?: string;
+    metadata?: Record<string, string>;
+    customerId?: string;
+    returnUrl?: string;
+    cancelUrl?: string;
+}
+interface PaymentIntent {
+    id: string;
+    clientSecret?: string;
+    status: PaymentStatus;
+    amount: number;
+    currency: string;
+    redirectUrl?: string;
+}
+type PaymentStatus = 'pending' | 'processing' | 'succeeded' | 'failed' | 'cancelled' | 'refunded';
+interface PaymentResult {
+    id: string;
+    status: PaymentStatus;
+    amount: number;
+    currency: string;
+    paidAt?: Date;
+}
+interface RefundResult {
+    id: string;
+    paymentId: string;
+    amount: number;
+    status: 'pending' | 'succeeded' | 'failed';
+    reason?: string;
+}
+interface WebhookEvent {
+    type: string;
+    data: Record<string, unknown>;
+}
+interface SubscriptionPlan {
+    id: string;
+    name: string;
+    amount: number;
+    currency: string;
+    interval: 'day' | 'week' | 'month' | 'year';
+    intervalCount: number;
+    trialDays?: number;
+    features?: string[];
+}
+interface Subscription {
+    id: string;
+    planId: string;
+    customerId: string;
+    status: 'active' | 'past_due' | 'cancelled' | 'trialing' | 'paused';
+    currentPeriodStart: Date;
+    currentPeriodEnd: Date;
+    cancelAtPeriodEnd: boolean;
+}
+interface SubscriptionProvider {
+    createSubscription(customerId: string, planId: string): Promise<Subscription>;
+    cancelSubscription(subscriptionId: string, immediately?: boolean): Promise<Subscription>;
+    getSubscription(subscriptionId: string): Promise<Subscription>;
+    listSubscriptions(customerId: string): Promise<Subscription[]>;
+    changePlan(subscriptionId: string, newPlanId: string): Promise<Subscription>;
+}
+
+/**
+ * 支付服务 — 管理多个 PaymentProvider 的注册和路由。
+ *
+ * 使用方式：
+ *   paymentService.register(stripeProvider);
+ *   paymentService.register(wechatPayProvider);
+ *   await paymentService.createPaymentIntent('stripe', params);
+ */
+declare class PaymentService {
+    private readonly logger;
+    private readonly providers;
+    /** 注册支付提供商 */
+    register(provider: PaymentProvider): void;
+    /** 注销支付提供商 */
+    unregister(providerId: string): boolean;
+    /** 获取已注册的提供商列表 */
+    listProviders(): PaymentProvider[];
+    /** 获取指定提供商 */
+    getProvider(providerId: string): PaymentProvider;
+    /** 创建支付意图 */
+    createPaymentIntent(providerId: string, params: CreatePaymentParams): Promise<PaymentIntent>;
+    /** 确认支付 */
+    confirmPayment(providerId: string, intentId: string): Promise<PaymentResult>;
+    /** 退款 */
+    refund(providerId: string, paymentId: string, amount?: number, reason?: string): Promise<RefundResult>;
+    /** 查询支付状态 */
+    getPaymentStatus(providerId: string, intentId: string): Promise<PaymentStatus>;
+    /** 处理 Webhook */
+    handleWebhook(providerId: string, payload: unknown, signature: string): Promise<WebhookEvent>;
+}
+
+type OrderStatus = 'created' | 'paying' | 'paid' | 'failed' | 'refunding' | 'refunded' | 'cancelled';
+interface Order {
+    id: string;
+    providerId: string;
+    paymentIntentId?: string;
+    paymentId?: string;
+    amount: number;
+    currency: string;
+    status: OrderStatus;
+    metadata?: Record<string, string>;
+    createdAt: Date;
+    updatedAt: Date;
+    paidAt?: Date;
+    refundedAt?: Date;
+}
+interface CreateOrderParams {
+    orderId: string;
+    providerId: string;
+    payment: CreatePaymentParams;
+}
+/**
+ * 订单管理服务 — 创建订单 -> 支付 -> 完成/退款。
+ *
+ * 提供内存订单存储（生产环境应替换为数据库持久化）。
+ */
+declare class OrderService {
+    private readonly paymentService;
+    private readonly logger;
+    private readonly orders;
+    constructor(paymentService: PaymentService);
+    /** 创建订单并发起支付 */
+    createOrder(params: CreateOrderParams): Promise<Order>;
+    /** 确认订单支付 */
+    confirmOrder(orderId: string): Promise<PaymentResult>;
+    /** 订单退款 */
+    refundOrder(orderId: string, amount?: number, reason?: string): Promise<RefundResult>;
+    /** 取消订单 */
+    cancelOrder(orderId: string): Order;
+    /** 查询订单 */
+    getOrder(orderId: string): Order;
+    /** 列出所有订单 */
+    listOrders(): Order[];
+}
+
+/** 挽回邮件发送接口 — 由业务项目实现 */
+interface RecoveryMailSender {
+    sendRecoveryEmail(params: RecoveryEmailParams): Promise<void>;
+}
+interface RecoveryEmailParams {
+    to: string;
+    userName: string;
+    orderId: string;
+    orderNumber?: string;
+    amount: number;
+    currency: string;
+    errorReason: string;
+    retryUrl: string;
+    expireHours: number;
+}
+/** 用户信息查询接口 — 由业务项目实现 */
+interface RecoveryUserLookup {
+    getUser(userId: string): Promise<{
+        email?: string;
+        name?: string;
+    } | null>;
+}
+/** 重试链接生成接口 — 由业务项目实现或使用默认 */
+interface RecoveryUrlGenerator {
+    generateRetryUrl(order: Order): Promise<string | null>;
+}
+declare const RECOVERY_MAIL_SENDER = "RECOVERY_MAIL_SENDER";
+declare const RECOVERY_USER_LOOKUP = "RECOVERY_USER_LOOKUP";
+declare const RECOVERY_URL_GENERATOR = "RECOVERY_URL_GENERATOR";
+interface RecoveryOptions {
+    /** 最大挽回次数（默认 3） */
+    maxAttempts?: number;
+    /** 重试链接有效期（小时，默认 48） */
+    retryLinkExpireHours?: number;
+    /** 前端基础 URL（用于默认重试链接生成） */
+    frontendUrl?: string;
+}
+/**
+ * 付款失败挽回服务
+ *
+ * 流程：Webhook 失败 → handleFailedPayment() → 生成重试链接 → 发挽回邮件
+ *
+ * 依赖注入（均为可选，未注入时仅日志记录）：
+ * - RECOVERY_MAIL_SENDER: 邮件发送实现
+ * - RECOVERY_USER_LOOKUP: 用户信息查询
+ * - RECOVERY_URL_GENERATOR: 自定义重试链接生成
+ */
+declare class PaymentRecoveryService {
+    private readonly orderService;
+    private readonly paymentService;
+    private readonly mailSender?;
+    private readonly userLookup?;
+    private readonly urlGenerator?;
+    private readonly eventEmitter?;
+    private readonly logger;
+    private readonly options;
+    /** 内存挽回计数（生产环境建议由业务项目持久化） */
+    private readonly recoveryAttempts;
+    constructor(orderService: OrderService, paymentService: PaymentService, mailSender?: RecoveryMailSender | undefined, userLookup?: RecoveryUserLookup | undefined, urlGenerator?: RecoveryUrlGenerator | undefined, eventEmitter?: EventEmitter2);
+    /** 设置挽回选项 */
+    configure(options: RecoveryOptions): void;
+    /**
+     * 处理付款失败 — 核心挽回入口
+     */
+    handleFailedPayment(orderId: string, errorCode?: string, errorMessage?: string): Promise<void>;
+    /**
+     * 重试失败订单 — 将 failed → created 并重新发起支付
+     */
+    retryOrder(orderId: string): Promise<Order>;
+    /** 获取订单挽回记录 */
+    getRecoveryAttempts(orderId: string): {
+        count: number;
+        lastAt: Date;
+    } | undefined;
+    private generateRetryUrl;
+}
+/** Stripe 错误码 → 用户友好中文描述 */
+declare function friendlyErrorReason(errorCode?: string, errorMessage?: string): string;
+
+/**
+ * 支付系统事件常量及接口
+ */
+declare const PaymentEvents: {
+    readonly ORDER_CREATED: "payment.order.created";
+    readonly ORDER_PAID: "payment.order.paid";
+    readonly ORDER_FAILED: "payment.order.failed";
+    readonly ORDER_CANCELED: "payment.order.canceled";
+    readonly ORDER_REFUNDED: "payment.order.refunded";
+    readonly PAYMENT_RECOVERY_SENT: "payment.recovery.sent";
+};
+type PaymentEventType = (typeof PaymentEvents)[keyof typeof PaymentEvents];
+interface OrderFailedEvent {
+    orderId: string;
+    orderNumber?: string;
+    userId?: string;
+    amount: number;
+    currency: string;
+    providerId: string;
+    errorCode?: string;
+    errorMessage?: string;
+}
+interface PaymentRecoverySentEvent {
+    orderId: string;
+    userId?: string;
+    email: string;
+    retryUrl: string;
+    attemptNumber: number;
+}
+
+declare const PAYMENT_PROVIDERS = "PAYMENT_PROVIDERS";
+interface PaymentModuleOptions {
+    providers?: PaymentProvider[];
+}
+interface PaymentModuleAsyncOptions {
+    imports?: Array<Type | DynamicModule>;
+    useFactory: (...args: unknown[]) => PaymentModuleOptions | Promise<PaymentModuleOptions>;
+    inject?: InjectionToken[];
+}
+declare class ZuckerPaymentModule {
+    static forRoot(options?: PaymentModuleOptions): DynamicModule;
+    static forRootAsync(options: PaymentModuleAsyncOptions): DynamicModule;
+}
+
+export { type CreateOrderParams, type CreatePaymentParams, type Order, type OrderFailedEvent, OrderService, type OrderStatus, PAYMENT_PROVIDERS, type PaymentEventType, PaymentEvents, type PaymentIntent, type PaymentModuleAsyncOptions, type PaymentModuleOptions, type PaymentProvider, type PaymentRecoverySentEvent, PaymentRecoveryService, type PaymentResult, PaymentService, type PaymentStatus, RECOVERY_MAIL_SENDER, RECOVERY_URL_GENERATOR, RECOVERY_USER_LOOKUP, type RecoveryEmailParams, type RecoveryMailSender, type RecoveryOptions, type RecoveryUrlGenerator, type RecoveryUserLookup, type RefundResult, type Subscription, type SubscriptionPlan, type SubscriptionProvider, type WebhookEvent, ZuckerPaymentModule, friendlyErrorReason };