mantur-components 0.1.12 → 0.1.13-beta.1

package/README.md

@@ -42,7 +42,7 @@ export function Header({
 }: {
   userInfo: { username?: string; nickname?: string; avatar?: string } | null;
 }) {
-  return <ManturHeader user={userInfo} />;
+  return <ManturHeader user={userInfo} appName={import.meta.env.VITE_APP_NAME} />;
 }
 ```
 
@@ -62,6 +62,7 @@ export function Header({
     <ManturHeader
       user={userInfo}
       disabled={disabled}
+      appName={import.meta.env.VITE_APP_NAME}
       brandSlot={<span className="text-lg font-bold">自定义品牌</span>}
     >
       <div className="px-4">自定义中间内容</div>
@@ -80,7 +81,9 @@ interface ManturHeaderProps {
   children?: React.ReactNode;
   onTenantContextChange?: (detail: ManturTenantContextDetail) => void;
   rechargePaymentMethod?: "card" | "alipay" | "wechat_pay";
+  appName?: string;
   stripePublishableKey?: string;
+  stripePaymentWindowFeatures?: string;
 }
 ```
 
@@ -96,7 +99,11 @@ interface ManturHeaderProps {
 
 `rechargePaymentMethod`：兼容旧版本的支付方式参数。当前充值创建订单不再主动提交支付方式，支付方式由 Stripe Checkout Session 内部选择。
 
-`stripePublishableKey`：Stripe publishable key。订单返回 Checkout Session client secret（字段名为 `clientSecret`，值以 `cs_` 开头）时，组件库会用该 key 调起内置 Stripe Embedded Checkout 支付弹窗。
+`appName`：当前宿主应用名，建议宿主在调用 Header 时传 `appName={import.meta.env.VITE_APP_NAME}`。充值创建订单时会优先使用该值作为请求体 `app`，不传时才回退到 `window.__MANTUR_APP_NAME__`、组件库构建环境或本地开发端口推断。
+
+`stripePublishableKey`：Stripe publishable key。订单返回 Checkout Session `clientSecret`（字段名为 `clientSecret`，值以 `cs_` 开头）时，组件库会在自己的支付弹窗中挂载 Stripe Checkout Elements。
+
+`stripePaymentWindowFeatures`：兼容旧版本的窗口配置参数。当前支付不再打开新窗口，不读取该参数。
 
 ### 用户类型
 
@@ -138,6 +145,7 @@ window.__MANTUR_COMPONENTS_STRIPE_PUBLISHABLE_KEY__ = "pk_test_xxx";
 
 ```ts
 import {
+  cancelManturRechargeOrder,
   createManturRechargeOrder,
   getManturBillingAccount,
   getManturBillingLedger,
@@ -145,16 +153,19 @@ import {
   getManturPricingChargePoint,
   getManturPricingChargePoints,
   getManturRechargeOrder,
-  postManturStripePaymentWindowMessage,
   MANTUR_RECHARGE_ORDER_CREATED_EVENT,
 } from "mantur-components";
 ```
 
-充值面板打开时会调用 `getManturBillingPackages()` 拉取 `/billing/packages`；点击支付时会调用 `createManturRechargeOrder()` 创建 `/billing/recharge/orders`，请求体只传 `packageId` 或 `customAmount`。订单创建成功后会触发浏览器事件 `mantur-recharge-order-created`，`detail` 为后端返回的订单信息。
+充值面板打开时会调用 `getManturBillingPackages()` 拉取 `/billing/packages`；点击支付时会调用 `createManturRechargeOrder()` 创建 `/billing/recharge/orders`，请求体传 `packageId` 或 `customAmount`，并固定传 `uiMode: "elements"`。请求体还会补齐 `app` 和 `redirect`：`app` 优先取 `ManturHeader` 的 `appName` prop，建议宿主传 `import.meta.env.VITE_APP_NAME`；未传时回退到 `window.__MANTUR_APP_NAME__` 或组件库内可读取的 `VITE_APP_NAME`；本地开发若没有这些配置，会用当前端口兜底识别应用（`:82` creative-agent、`:83` production-agent、`:81` traffic-engine、`:84` distribution-matrix）。`redirect` 与路由拦截器一致，只取当前页面的 `pathname + search + hash`，不拼接协议、域名或开发端口。订单创建成功后会触发浏览器事件 `mantur-recharge-order-created`，`detail` 为后端返回的订单信息。
+
+积分明细弹窗打开后会调用 `getManturBillingLedger()` 拉取 `/billing/accounts/me/ledger`，并根据“获得/消耗”、来源和日期范围筛选传递 `directions`、`bizTypes`、`fromTime`、`toTime`，分页总数使用接口返回的 `total`。
+
+后端按 Stripe Checkout Elements 要求返回 `clientSecret` 后，`ManturHeader` 会在支付弹窗中挂载 `CheckoutElementsProvider`、`ContactDetailsElement` 和 `PaymentElement`，提交时调用 `checkout.confirm({ redirect: "if_required" })`。后端创建 Checkout Session 时必须使用 `ui_mode="elements"` 或 `ui_mode="custom"`；如果仍创建 `ui_mode="embedded"` 的 Session，Stripe 会拒绝 `initCheckoutElementsSdk`。支付成功后组件库会关闭支付弹窗并刷新积分；用户主动关闭支付弹窗时会先调用 `cancelManturRechargeOrder()` 请求 `/billing/recharge/orders/{orderNo}/cancel`，然后再关闭弹窗。组件库仍兼容旧字段名 `stripeClientSecret`，但优先读取 `clientSecret`。
 
-后端按 `mantur-billing` 文档返回 `ui_mode="embedded"` Checkout Session 的 `clientSecret` 后，`ManturHeader` 会通过 `EmbeddedCheckoutProvider` 挂载 Stripe Embedded Checkout；支付完成后由 Stripe 的 `onComplete` 回调刷新积分。如果后端返回 `paymentUrl`、`checkoutUrl`、`url` 或 `returnUrl` 这类托管支付地址，组件库会直接跳转。组件库仍兼容旧字段名 `stripeClientSecret`，但优先读取 `clientSecret`。
+如果支付方式需要跳出授权，后端的 Stripe return_url 会回到 `front-main` 的 `/pay-callback?app=...&redirect=...`，`pay-callback` 会读取这两个参数并跳回原应用的 `redirect` 路由。
 
-如果宿主项目把 Stripe 支付页放在主应用 `front-main` 中，组件库会在创建订单后按 `redirectToManturMain` 的规则打开子窗口，并通过 URL 参数携带 `orderNo`、`clientSecret`、`amount`、`points` 到 `/stripe-payment`。子页完成支付或点击关闭时调用 `postManturStripePaymentWindowMessage()` 通知父窗口，父窗口会关闭子窗口并刷新用户余额。
+`postManturStripePaymentWindowMessage()`、`resolveManturStripePaymentPageUrl()` 和 `resolveManturRechargePaymentPageUrl()` 对外导出，用于 `front-main` 支付页和其它宿主复用同一套支付窗口消息协议。
 
 ## 团队上下文同步
 
@@ -176,7 +187,13 @@ function applyTenantContext(detail: ManturTenantContextDetail) {
 }
 
 function Header({ userInfo }: { userInfo: UserInfo | null }) {
-  return <ManturHeader user={userInfo} onTenantContextChange={applyTenantContext} />;
+  return (
+    <ManturHeader
+      user={userInfo}
+      appName={import.meta.env.VITE_APP_NAME}
+      onTenantContextChange={applyTenantContext}
+    />
+  );
 }
 ```
 
@@ -270,3 +287,40 @@ import type {
 ```bash
 npm run build
 ```
+
+## 发布
+
+测试包和生产包直接发布到 npm，通过 npm tag 区分：
+
+```bash
+npm run publish:test
+npm run publish:pro
+```
+
+`publish:test` 会使用 `vite build --mode test` 构建，并发布到 `test` tag。测试包版本必须是 prerelease，例如：
+
+```bash
+npm version prerelease --preid beta --no-git-tag-version
+npm run publish:test
+```
+
+测试项目安装：
+
+```bash
+npm install mantur-components@test
+```
+
+`publish:pro` 会使用 `vite build --mode pro` 构建，并发布到 `latest` tag。生产包版本不能包含 `beta`、`alpha`、`rc` 等 prerelease 标识，例如：
+
+```bash
+npm version 0.1.13 --no-git-tag-version
+npm run publish:pro
+```
+
+生产项目安装：
+
+```bash
+npm install mantur-components@latest
+```
+
+环境变量读取遵循 Vite mode 规则：测试包读取 `.env` 和 `.env.test`，生产包读取 `.env` 和 `.env.pro`。发布前需要确认对应环境变量已经写入正确的 `VITE_*` 配置。

package/dist/api.d.ts

@@ -19,6 +19,9 @@ export interface ManturCreateRechargeOrderRequest {
     packageId?: string;
     customAmount?: number;
     paymentMethod?: ManturPaymentMethod;
+    uiMode?: "custom" | "elements" | "embedded";
+    app?: string;
+    redirect?: string;
 }
 export interface ManturCreateRechargeOrderResponse {
     orderNo?: string;
@@ -128,6 +131,7 @@ 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 cancelManturRechargeOrder(orderNo: string): Promise<null | undefined>;
 export declare function getManturPricingChargePoints(): Promise<ManturChargePointWithModelsDTO[]>;
 export declare function getManturPricingChargePoint(chargePointId: string): Promise<ManturChargePointWithModelsDTO | undefined>;
 export declare function getManturBillingAccount(): Promise<ManturBillingAccountDTO | 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, stripePublishableKey, stripePaymentWindowFeatures, }: ManturHeaderProps): import("react/jsx-runtime").JSX.Element;
+export declare function ManturHeader({ user, disabled, brandSlot, children, onTenantContextChange, appName, stripePublishableKey, }: ManturHeaderProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,4 @@
-import type { ManturCreateRechargeOrderResponse } from "../../api";
+import { type ManturCreateRechargeOrderResponse } from "../../api";
 import type { ManturHeaderLabels } from "../../types";
 interface StripePaymentModalProps {
     visible: boolean;

package/dist/header/mock.d.ts

@@ -19,18 +19,3 @@ export interface CustomRechargePackage {
 }
 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";
-export interface PointsLedgerRecord {
-    id: string;
-    type: Exclude<PointsLedgerType, "all">;
-    source?: Exclude<PointsLedgerSource, "all">;
-    name: string;
-    meta: string;
-    date: string;
-    amount: number;
-    badgeKind: PointsLedgerBadgeKind;
-    badgeText: string;
-}
-export declare const MOCK_POINTS_LEDGER: PointsLedgerRecord[];

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 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 { cancelManturRechargeOrder, 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 { getManturRechargeRedirectContext, redirectToManturMain } from "./utils/url";
 export type { ManturMainRedirectOptions } from "./utils/url";
-export { isManturStripePaymentWindowMessage, MANTUR_STRIPE_PAYMENT_ROUTE, MANTUR_STRIPE_PAYMENT_WINDOW_MESSAGE_TYPE, postManturStripePaymentWindowMessage, resolveManturStripePaymentPageUrl, } from "./utils/stripe-payment-window";
-export type { ManturStripePaymentWindowAction, ManturStripePaymentWindowMessage, } from "./utils/stripe-payment-window";
+export { isManturStripePaymentWindowMessage, MANTUR_STRIPE_PAYMENT_ROUTE, MANTUR_STRIPE_PAYMENT_WINDOW_MESSAGE_TYPE, postManturStripePaymentWindowMessage, resolveManturRechargePaymentPageUrl, resolveManturStripePaymentPageUrl, } from "./utils/stripe-payment-window";
+export type { ManturStripePaymentPageUrlOptions, ManturStripePaymentWindowAction, ManturStripePaymentWindowMessage, } from "./utils/stripe-payment-window";
 export type { ManturHeaderLabels, ManturHeaderProps, ManturHeaderUser, ManturPaymentMethod, ManturProfileValues, ManturRole, ManturTenant, ManturTenantAuthContext, ManturTenantContextDetail, ManturUserPoints, } from "./types";