@zucker-framework/payment 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,22 @@
+Zucker Framework
+Copyright 2026 Lind and Zucker Framework contributors
+
+Licensed under the Apache License, Version 2.0. See LICENSE.
+
+The framework includes TypeScript adaptations and enhancements of concepts and
+implementations from hsweb-framework and jetlinks-community, both distributed
+under the Apache License, Version 2.0. Individual packages use different subsets
+of the framework. The TypeScript adaptations and Node.js integrations were
+modified for Zucker Framework; they are not the original upstream distribution.
+
+hsweb-framework
+https://github.com/hs-web/hsweb-framework
+Copyright 2020 http://hsweb.me
+
+jetlinks-community
+https://github.com/jetlinks/jetlinks-community
+
+See THIRD_PARTY_NOTICES for license texts and attribution for bundled dependencies
+and reference implementations relevant to this package. External dependencies
+remain subject to their own licenses. This NOTICE is informational and does not
+modify any license or grant rights to upstream trademarks.

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,4 @@
+@zucker-framework/payment
+
+No separately recorded third-party implementation is bundled in this package.
+External dependencies retain their own licenses; see NOTICE for framework attribution.

package/dist/index.d.mts

@@ -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 };