@downcity/services 0.1.48 → 0.1.49

package/bin/payment-creem/types.d.ts

@@ -0,0 +1,316 @@
+/**
+ * Creem 一次性充值服务对外类型定义。
+ *
+ * 关键说明（中文）
+ * - 当前能力只覆盖 Creem Checkout 一次性充值
+ * - 不覆盖 subscription / entitlement
+ * - 由于 Creem Checkout 基于 product_id 创建会话，实际充值金额仍以 balance topup 为准
+ */
+/**
+ * 充值单最小只读视图。
+ */
+export interface CreemPaymentTopupRecord extends Record<string, unknown> {
+    /**
+     * 充值单 ID。
+     */
+    topup_id: string;
+    /**
+     * 充值目标用户 ID。
+     */
+    user_id: string;
+    /**
+     * 充值金额。
+     */
+    amount: number;
+    /**
+     * 余额单位。
+     */
+    unit: string;
+    /**
+     * 充值单状态。
+     */
+    status: string;
+    /**
+     * 充值说明。
+     */
+    note: string;
+}
+/**
+ * Creem 服务所需的 balance 最小桥接接口。
+ */
+export interface CreemPaymentServiceBalanceBridge {
+    /**
+     * 读取充值单。
+     */
+    readTopup(topup_id: string): Promise<CreemPaymentTopupRecord>;
+    /**
+     * 完成充值单并真正入账。
+     */
+    finishTopup(topup_id: string, extra?: {
+        /**
+         * 说明文本。
+         */
+        note?: string;
+        /**
+         * 外部引用 ID。
+         */
+        ref?: string;
+        /**
+         * 结构化扩展字段。
+         */
+        meta?: Record<string, unknown>;
+    }): Promise<CreemPaymentTopupRecord>;
+}
+/**
+ * Creem 支付服务配置。
+ */
+export interface CreemPaymentServiceOptions {
+    /**
+     * 已挂载到 City 的 balance 服务实例。
+     *
+     * Creem 服务会通过它读取 topup，并在 webhook 支付成功后调用
+     * `finishTopup()` 真正完成到账。
+     */
+    balance: CreemPaymentServiceBalanceBridge;
+    /**
+     * Creem API Key。
+     *
+     * 未传入时会读取 City env 中的 `CREEM_API_KEY`。
+     */
+    api_key?: string;
+    /**
+     * Creem Checkout 使用的 product_id。
+     *
+     * 未传入时会读取 City env 中的 `CREEM_PRODUCT_ID`。
+     */
+    product_id?: string;
+    /**
+     * Creem webhook 签名密钥。
+     *
+     * 未传入时会读取 City env 中的 `CREEM_WEBHOOK_SECRET`。
+     */
+    webhook_secret?: string;
+    /**
+     * 默认支付成功跳转地址。
+     *
+     * 当 `checkout/create` 未显式传入 `success_url` 时使用。
+     * 如果这里也未配置，服务会继续尝试基于 `DOWNCITY_CITY_BASE_URL`
+     * 自动生成默认结果页地址。
+     */
+    success_url?: string;
+    /**
+     * 默认结算币种。
+     *
+     * 仅用于支付方式目录展示和本地记录；最终收款币种由 Creem product 决定。
+     */
+    currency?: string;
+    /**
+     * Creem API 基础地址。
+     *
+     * 默认值为 Creem 官方 `https://api.creem.io/v1`。
+     * 测试时可以覆写到伪造服务。
+     */
+    api_base_url?: string;
+}
+/**
+ * Creem Checkout 创建请求。
+ */
+export interface CreemCreateCheckoutInput extends Record<string, unknown> {
+    /**
+     * 对应的 balance topup ID。
+     */
+    topup_id: string;
+    /**
+     * 可选支付成功跳转地址。
+     */
+    success_url?: string;
+    /**
+     * 可选支付取消跳转地址。
+     *
+     * 当前 Creem Checkout API 不消费该字段；这里保留是为了前端在多支付方式
+     * checkout 入参里可以复用同一结构。
+     */
+    cancel_url?: string;
+}
+/**
+ * Creem Checkout 创建结果。
+ */
+export interface CreemCheckoutCreateResult {
+    /**
+     * 服务内部支付记录 ID。
+     */
+    payment_id: string;
+    /**
+     * 对应的 balance topup ID。
+     */
+    topup_id: string;
+    /**
+     * Creem Checkout ID。
+     */
+    creem_checkout_id: string;
+    /**
+     * Creem Checkout 托管页面 URL。
+     */
+    checkout_url: string;
+    /**
+     * 当前支付状态。
+     */
+    status: CreemPaymentStatus;
+}
+/**
+ * Creem 支付记录状态。
+ */
+export type CreemPaymentStatus = "pending" | "paid" | "expired" | "failed";
+/**
+ * Creem webhook 同步状态。
+ */
+export type CreemEventSyncStatus = "pending" | "applied" | "ignored" | "failed";
+/**
+ * Creem 支付记录。
+ */
+export interface CreemPaymentRecord extends Record<string, unknown> {
+    /**
+     * 服务内部支付记录 ID。
+     */
+    payment_id: string;
+    /**
+     * 对应的 balance topup ID。
+     */
+    topup_id: string;
+    /**
+     * 充值目标用户 ID。
+     */
+    user_id: string;
+    /**
+     * Creem Checkout ID。
+     */
+    creem_checkout_id: string;
+    /**
+     * Creem Order ID。
+     *
+     * 创建 Checkout 时通常为空字符串，待 webhook 补全。
+     */
+    creem_order_id: string;
+    /**
+     * 本次充值金额。
+     */
+    amount: number;
+    /**
+     * 结算币种。
+     */
+    currency: string;
+    /**
+     * 当前支付状态。
+     */
+    status: CreemPaymentStatus;
+    /**
+     * Creem Checkout 托管页面 URL。
+     */
+    checkout_url: string;
+    /**
+     * 扩展字段 JSON 文本。
+     */
+    metadata_json: string;
+    /**
+     * 创建时间。
+     */
+    created_at: string;
+    /**
+     * 更新时间。
+     */
+    updated_at: string;
+}
+/**
+ * Creem webhook 事件记录。
+ */
+export interface CreemEventRecord extends Record<string, unknown> {
+    /**
+     * Creem webhook 事件 ID。
+     */
+    event_id: string;
+    /**
+     * Creem webhook 事件类型。
+     */
+    type: string;
+    /**
+     * 原始 webhook payload JSON 文本。
+     */
+    payload_json: string;
+    /**
+     * 同步状态。
+     */
+    sync_status: CreemEventSyncStatus;
+    /**
+     * 同步失败信息。
+     */
+    sync_error: string;
+    /**
+     * 创建时间。
+     */
+    created_at: string;
+}
+/**
+ * Creem Checkout API 创建参数。
+ */
+export interface CreemCreateCheckoutSessionInput {
+    /**
+     * 服务内部支付记录 ID。
+     */
+    payment_id: string;
+    /**
+     * 充值单信息。
+     */
+    topup: CreemPaymentTopupRecord;
+    /**
+     * Creem product_id。
+     */
+    product_id: string;
+    /**
+     * 支付成功跳转地址。
+     */
+    success_url: string;
+}
+/**
+ * Creem Checkout API 创建结果。
+ */
+export interface CreemCheckoutSessionResult {
+    /**
+     * Creem Checkout ID。
+     */
+    checkout_id: string;
+    /**
+     * Creem Checkout 托管页面 URL。
+     */
+    checkout_url: string;
+}
+/**
+ * Creem webhook 事件。
+ */
+export interface CreemWebhookEvent extends Record<string, unknown> {
+    /**
+     * Creem webhook 事件 ID。
+     */
+    id?: unknown;
+    /**
+     * Creem webhook 事件类型。
+     */
+    eventType?: unknown;
+    /**
+     * 兼容部分测试或代理转发 payload 的事件类型字段。
+     */
+    type?: unknown;
+    /**
+     * Creem webhook 事件对象。
+     */
+    object?: unknown;
+    /**
+     * 兼容 data.object 形式的事件对象。
+     */
+    data?: {
+        /**
+         * 事件主体对象。
+         */
+        object?: unknown;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/bin/payment-creem/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/payment-creem/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE9D;;OAEG;IACH,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC,GACA,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,OAAO,EAAE,gCAAgC,CAAC;IAE1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACvE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC/D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,oBAAoB,CAAC;IAElC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,uBAAuB,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CAErB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAChE;;OAEG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}

package/bin/payment-creem/types.js

@@ -0,0 +1,10 @@
+/**
+ * Creem 一次性充值服务对外类型定义。
+ *
+ * 关键说明（中文）
+ * - 当前能力只覆盖 Creem Checkout 一次性充值
+ * - 不覆盖 subscription / entitlement
+ * - 由于 Creem Checkout 基于 product_id 创建会话，实际充值金额仍以 balance topup 为准
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/bin/payment-creem/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/payment-creem/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@downcity/services",
-  "version": "0.1.48",
-  "description": "Downcity public services package for accounts, balance, usage, and Stripe payment flows.",
+  "version": "0.1.49",
+  "description": "Downcity public services package for accounts, balance, usage, Stripe payment, and Creem payment flows.",
   "type": "module",
   "main": "./bin/index.js",
   "module": "./bin/index.js",
@@ -33,7 +33,8 @@
     "accounts",
     "balance",
     "usage",
-    "stripe"
+    "stripe",
+    "creem"
   ],
   "engines": {
     "node": ">=22.13.0"