mantur-components 0.1.8 → 0.1.10

package/README.md

@@ -26,6 +26,7 @@ npm install react react-dom @arco-design/web-react next-themes react-i18next
 - 获取当前团队
 - 切换团队
 - 获取用户积分
+- 充值积分（固定套餐和自定义金额）
 - 个人资料更新
 - 退出登录
 - 语言切换
@@ -78,6 +79,8 @@ interface ManturHeaderProps {
   brandSlot?: React.ReactNode;
   children?: React.ReactNode;
   onTenantContextChange?: (detail: ManturTenantContextDetail) => void;
+  rechargePaymentMethod?: "card" | "alipay" | "wechat_pay";
+  stripePublishableKey?: string;
 }
 ```
 
@@ -91,6 +94,10 @@ interface ManturHeaderProps {
 
 `onTenantContextChange`：Header 完成团队上下文初始化或切换团队成功后触发，直接透出当前选中团队、团队列表和当前团队认证上下文。宿主项目需要同步自己的 store 时优先使用这个回调。
 
+`rechargePaymentMethod`：兼容旧版本的支付方式参数。当前充值创建订单不再主动提交支付方式，支付方式由 Stripe Checkout Session 内部选择。
+
+`stripePublishableKey`：Stripe publishable key。订单返回 Checkout Session client secret（字段名为 `clientSecret`，值以 `cs_` 开头）时，组件库会用该 key 调起内置 Stripe Embedded Checkout 支付弹窗。
+
 ### 用户类型
 
 ```ts
@@ -113,12 +120,39 @@ interface ManturHeaderUser {
 window.__MANTUR_COMPONENTS_API_BASE__ = "/api";
 ```
 
-积分接口默认是 `/users/me/points`，也可以覆盖：
+积分接口默认是 `/billing/accounts/me`，也可以覆盖：
 
 ```ts
 window.__MANTUR_COMPONENTS_POINTS_ENDPOINT__ = "/users/me/points";
 ```
 
+Stripe publishable key 可以通过 `ManturHeader` 的 `stripePublishableKey` 传入，也可以在渲染组件前通过全局变量覆盖：
+
+```ts
+window.__MANTUR_COMPONENTS_STRIPE_PUBLISHABLE_KEY__ = "pk_test_xxx";
+```
+
+## Billing API
+
+组件库按 `mantur-billing` 用户端接口导出以下 helper：
+
+```ts
+import {
+  createManturRechargeOrder,
+  getManturBillingAccount,
+  getManturBillingLedger,
+  getManturBillingPackages,
+  getManturPricingChargePoint,
+  getManturPricingChargePoints,
+  getManturRechargeOrder,
+  MANTUR_RECHARGE_ORDER_CREATED_EVENT,
+} from "mantur-components";
+```
+
+充值面板打开时会调用 `getManturBillingPackages()` 拉取 `/billing/packages`；点击支付时会调用 `createManturRechargeOrder()` 创建 `/billing/recharge/orders`，请求体只传 `packageId` 或 `customAmount`。订单创建成功后会触发浏览器事件 `mantur-recharge-order-created`，`detail` 为后端返回的订单信息。
+
+后端按 `mantur-billing` 文档返回 `ui_mode="embedded"` Checkout Session 的 `clientSecret` 后，`ManturHeader` 会通过 `EmbeddedCheckoutProvider` 挂载 Stripe Embedded Checkout；支付完成后由 Stripe 的 `onComplete` 回调刷新积分。如果后端返回 `paymentUrl`、`checkoutUrl`、`url` 或 `returnUrl` 这类托管支付地址，组件库会直接跳转。组件库仍兼容旧字段名 `stripeClientSecret`，但优先读取 `clientSecret`。
+
 ## 团队上下文同步
 
 团队列表、当前团队、切换团队都由 `ManturHeader` 内部处理。
@@ -215,11 +249,14 @@ redirectToManturMain(import.meta.env.VITE_MAIN_PREFIX, import.meta.env.VITE_APP_
 ```ts
 import { ManturHeader, formatDateByLang, redirectToManturMain } from "mantur-components";
 import type {
+  ManturBillingPackageDTO,
+  ManturCreateRechargeOrderResponse,
   ManturDateFormatType,
   ManturDateInput,
   ManturHeaderProps,
   ManturHeaderUser,
   ManturMainRedirectOptions,
+  ManturPaymentMethod,
   ManturTenant,
   ManturTenantContextDetail,
 } from "mantur-components";

package/dist/api.d.ts

@@ -1,10 +1,120 @@
-import type { ManturHeaderUser, ManturProfileValues, ManturTenant, ManturTenantAuthContext, ManturTenantContextDetail, ManturUserPoints } from "./types";
+import type { ManturHeaderUser, ManturPaymentMethod, ManturProfileValues, ManturTenant, ManturTenantAuthContext, ManturTenantContextDetail, ManturUserPoints } from "./types";
 export declare const MANTUR_POINTS_REFRESH_EVENT = "mantur-points-refresh";
+export declare const MANTUR_RECHARGE_ORDER_CREATED_EVENT = "mantur-recharge-order-created";
 export declare const MANTUR_TENANT_CONTEXT_CHANGE_EVENT = "mantur-tenant-context-change";
+export interface ManturBillingPackageDTO {
+    id?: string;
+    packageCode?: string;
+    packageName?: string;
+    packageNameEn?: string;
+    amount?: number;
+    points?: number;
+    isRecommended?: boolean;
+    sortOrder?: number;
+    status?: number;
+    createTime?: string;
+    updateTime?: string;
+}
+export interface ManturCreateRechargeOrderRequest {
+    packageId?: string;
+    customAmount?: number;
+    paymentMethod?: ManturPaymentMethod;
+}
+export interface ManturCreateRechargeOrderResponse {
+    orderNo?: string;
+    amount?: number;
+    points?: number;
+    clientSecret?: string;
+    stripeClientSecret?: string;
+    paymentUrl?: string;
+    checkoutUrl?: string;
+    url?: string;
+    returnUrl?: string;
+}
+export interface ManturRechargeOrderDTO {
+    orderNo?: string;
+    userId?: string;
+    packageId?: string;
+    packageName?: string;
+    packageNameEn?: string;
+    stripeTradeNo?: string;
+    amount?: number;
+    points?: number;
+    channel?: number;
+    paymentMethod?: ManturPaymentMethod | string;
+    channelFeeAmount?: number;
+    status?: number;
+    paidTime?: string;
+    fulfilledTime?: string;
+    batchId?: string;
+    createTime?: string;
+    userEmail?: string;
+    userNickname?: string;
+    userAvatar?: string;
+}
+export interface ManturBillingAccountDTO {
+    userId?: string;
+    totalBalance?: number;
+    rechargeBalance?: number;
+    giftBalance?: number;
+    earliestExpireTime?: string;
+    rechargeEarliestExpireTime?: string;
+    giftEarliestExpireTime?: string;
+}
+export interface ManturModelRuleDTO {
+    modelId?: string;
+    modelName?: string;
+    modelNameEn?: string;
+    modelProvider?: string;
+    modelType?: number;
+    ruleJson?: string;
+    ruleVersion?: number;
+    status?: number;
+}
+export interface ManturChargePointWithModelsDTO {
+    chargePointId?: string;
+    chargePointName?: string;
+    chargePointNameEn?: string;
+    module?: string;
+    chargeType?: number;
+    fixedPoints?: number;
+    ruleVersion?: number;
+    status?: number;
+    models?: ManturModelRuleDTO[];
+}
+export interface ManturLedgerEntryDTO {
+    id?: string;
+    direction?: number;
+    amount?: number;
+    pointType?: number;
+    bizType?: number;
+    bizRefId?: string;
+    balanceAfter?: number;
+    context?: string;
+    createTime?: string;
+    actionName?: string;
+    contextDisplay?: string;
+}
+export interface ManturPageResult<T> {
+    total?: number;
+    pageNum?: number;
+    pageSize?: number;
+    pages?: number;
+    records?: T[];
+}
+export interface ManturLedgerQuery {
+    pageNum: number;
+    pageSize: number;
+    directions?: number[];
+    bizTypes?: number[];
+    fromTime?: string;
+    toTime?: string;
+}
 declare global {
     interface Window {
         __MANTUR_COMPONENTS_API_BASE__?: string;
         __MANTUR_COMPONENTS_POINTS_ENDPOINT__?: string;
+        __MANTUR_COMPONENTS_STRIPE_PUBLISHABLE_KEY__?: string;
         __MANTUR_COMPONENTS_TENANT_CONTEXT__?: ManturTenantContextDetail;
     }
 }
@@ -13,6 +123,13 @@ export declare function logoutManturUser(): Promise<void>;
 export declare function updateManturProfile(values: ManturProfileValues): Promise<ManturHeaderUser | undefined>;
 export declare function getManturUserPoints(): Promise<ManturUserPoints>;
 export declare function refreshManturUserPoints(): Promise<ManturUserPoints>;
+export declare function getManturBillingPackages(): Promise<ManturBillingPackageDTO[]>;
+export declare function createManturRechargeOrder(requestBody: ManturCreateRechargeOrderRequest): Promise<ManturCreateRechargeOrderResponse | undefined>;
+export declare function getManturRechargeOrder(orderNo: string): Promise<ManturRechargeOrderDTO | undefined>;
+export declare function getManturPricingChargePoints(): Promise<ManturChargePointWithModelsDTO[]>;
+export declare function getManturPricingChargePoint(chargePointId: string): Promise<ManturChargePointWithModelsDTO | undefined>;
+export declare function getManturBillingAccount(): Promise<ManturBillingAccountDTO | undefined>;
+export declare function getManturBillingLedger(query: ManturLedgerQuery): Promise<ManturPageResult<ManturLedgerEntryDTO>>;
 export declare function getManturTenantContextSnapshot(): ManturTenantContextDetail | undefined;
 export declare function getManturTenants(): Promise<ManturTenant[]>;
 export declare function getManturCurrentTenant(): Promise<ManturTenantAuthContext | undefined>;

package/dist/header/ManturHeader.d.ts

@@ -1,2 +1,2 @@
 import type { ManturHeaderProps } from "../types";
-export declare function ManturHeader({ user, disabled, brandSlot, children, onTenantContextChange, }: ManturHeaderProps): import("react/jsx-runtime").JSX.Element;
+export declare function ManturHeader({ user, disabled, brandSlot, children, onTenantContextChange, stripePublishableKey, }: ManturHeaderProps): import("react/jsx-runtime").JSX.Element;

package/dist/header/components/RechargeModal.d.ts

@@ -1,10 +1,13 @@
 import type { ManturHeaderLabels, ManturHeaderUser, ManturUserPoints } from "../../types";
-import { type RechargePackage } from "../mock";
-export declare function RechargeModal({ visible, user, points, text, onCancel, onPay, }: {
+import { type FixedRechargePackage, type RechargePackage } from "../mock";
+export declare function RechargeModal({ visible, user, points, text, packages, packageLoading, submitting, onCancel, onPay, }: {
     visible: boolean;
     user?: ManturHeaderUser | null;
     points: Required<ManturUserPoints>;
     text: ManturHeaderLabels;
+    packages?: FixedRechargePackage[];
+    packageLoading?: boolean;
+    submitting?: boolean;
     onCancel: () => void;
-    onPay: (rechargePackage: RechargePackage) => void;
+    onPay: (rechargePackage: RechargePackage) => void | Promise<void>;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/header/components/StripePaymentModal.d.ts

@@ -0,0 +1,12 @@
+import type { ManturCreateRechargeOrderResponse } from "../../api";
+import type { ManturHeaderLabels } from "../../types";
+interface StripePaymentModalProps {
+    visible: boolean;
+    publishableKey?: string;
+    order?: ManturCreateRechargeOrderResponse;
+    text: ManturHeaderLabels;
+    onCancel: () => void;
+    onSuccess: () => void;
+}
+export declare function StripePaymentModal({ visible, publishableKey, order, text, onCancel, onSuccess, }: StripePaymentModalProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/header/mock.d.ts

@@ -1,23 +1,24 @@
-export declare const RECHARGE_PACKAGES: readonly [{
-    readonly id: "points-500";
-    readonly points: 500;
-    readonly price: 5;
-}, {
-    readonly id: "points-1000";
-    readonly points: 1000;
-    readonly price: 10;
-}, {
-    readonly id: "points-5500";
-    readonly points: 5500;
-    readonly price: 50;
-    readonly recommended: true;
-}, {
-    readonly id: "points-24000";
-    readonly points: 24000;
-    readonly price: 200;
-}];
-export type RechargePackage = (typeof RECHARGE_PACKAGES)[number];
-export type RechargePackageId = RechargePackage["id"];
+export interface FixedRechargePackage {
+    id: string;
+    packageCode?: string;
+    packageName?: string;
+    packageNameEn?: string;
+    points: number;
+    price: number;
+    recommended?: boolean;
+    sortOrder?: number;
+}
+export declare const RECHARGE_PACKAGES: FixedRechargePackage[];
+export declare const CUSTOM_RECHARGE_MIN_PRICE = 10;
+export declare const CUSTOM_RECHARGE_POINTS_PER_USD = 100;
+export interface CustomRechargePackage {
+    id: "custom";
+    points: number;
+    price: number;
+    custom: true;
+}
+export type RechargePackage = FixedRechargePackage | CustomRechargePackage;
+export type RechargePackageId = FixedRechargePackage["id"] | CustomRechargePackage["id"];
 export type PointsLedgerType = "all" | "income" | "expense";
 export type PointsLedgerSource = "all" | "recharge" | "gift";
 export type PointsLedgerBadgeKind = "recharge" | "gift" | "deducted" | "expired";

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export { ManturHeader } from "./header";
+export { createManturRechargeOrder, getManturBillingAccount, getManturBillingLedger, getManturBillingPackages, getManturPricingChargePoint, getManturPricingChargePoints, getManturRechargeOrder, MANTUR_POINTS_REFRESH_EVENT, MANTUR_RECHARGE_ORDER_CREATED_EVENT, MANTUR_TENANT_CONTEXT_CHANGE_EVENT, refreshManturUserPoints, refreshManturTenantContext, } from "./api";
+export type { ManturBillingAccountDTO, ManturBillingPackageDTO, ManturChargePointWithModelsDTO, ManturCreateRechargeOrderRequest, ManturCreateRechargeOrderResponse, ManturLedgerEntryDTO, ManturLedgerQuery, ManturModelRuleDTO, ManturPageResult, ManturRechargeOrderDTO, } from "./api";
 export { formatDateByLang } from "./utils/date";
 export type { ManturDateFormatType, ManturDateInput } from "./utils/date";
 export { redirectToManturMain } from "./utils/url";
 export type { ManturMainRedirectOptions } from "./utils/url";
-export type { ManturHeaderLabels, ManturHeaderProps, ManturHeaderUser, ManturProfileValues, ManturRole, ManturTenant, ManturTenantAuthContext, ManturTenantContextDetail, ManturUserPoints, } from "./types";
+export type { ManturHeaderLabels, ManturHeaderProps, ManturHeaderUser, ManturPaymentMethod, ManturProfileValues, ManturRole, ManturTenant, ManturTenantAuthContext, ManturTenantContextDetail, ManturUserPoints, } from "./types";