@reachv2/sdk 0.3.3 → 0.5.0

package/dist/resources/shared-billing.js

@@ -0,0 +1,67 @@
+/**
+ * SharedBillingResource — 统一计费（Server API `/api/shared/billing/*`）。
+ *
+ * 鉴权：订阅 / 用量 / 加密收款端点均要求 **账户 JWT**（`requireAuth`）+ 租户成员
+ * （`tenantId` 显式传参，服务端用登录账号校验成员身份）；`plans` / `token-packs` /
+ * `crypto/methods` 公开。
+ *
+ * 未封装：
+ * - `POST /subscriptions`（已退役，恒 410 PLATFORM_PLAN_RETIRED；新购走 `/api/seats`）
+ * - `POST /webhook` / `POST /payments-events`（Stripe/引擎回调，验签即认证，不属于 SDK 调用面）
+ */
+export class SharedBillingResource {
+    constructor(request) {
+        this.request = request;
+    }
+    /** 席位档位套餐列表（**裸数组**，与 `/api/billing/plans` 的 `{ plans }` 不同） */
+    listPlans() {
+        return this.request("GET", "/api/shared/billing/plans");
+    }
+    /** 可购买 Token 包列表（**裸数组**，含 cryptoAmount / price 等全字段） */
+    listTokenPacks() {
+        return this.request("GET", "/api/shared/billing/token-packs");
+    }
+    /** 租户平台订阅列表（含 plan 摘要，按创建时间倒序） */
+    listSubscriptions(tenantId) {
+        return this.request("GET", `/api/shared/billing/subscriptions?tenantId=${encodeURIComponent(tenantId)}`);
+    }
+    /** 当前订阅 + 本月用量 + 分资源配额 + 席位/token 池（无套餐且无席位时 subscription/quota 为 null） */
+    getCurrentSubscription(tenantId) {
+        return this.request("GET", `/api/shared/billing/subscriptions/current?tenantId=${encodeURIComponent(tenantId)}`);
+    }
+    /** 记录用量（统一账本；`llm_tokens` 的 token 数落在 quantity） */
+    recordUsage(params) {
+        return this.request("POST", "/api/shared/billing/usage", params);
+    }
+    /**
+     * 购买 Token 包（fiat Stripe Checkout；渠道未配置时落 pending 单并返回 `manual: true`）。
+     * `usePartnerBalance: true` 时用推广余额全额抵扣，成功即 completed。
+     */
+    purchaseTokenPack(params) {
+        return this.request("POST", "/api/shared/billing/token-packs/purchase", params);
+    }
+    /** 已开放的加密收款通道（链 + 稳定币；未开放返回 `enabled: false`） */
+    listCryptoMethods() {
+        return this.request("GET", "/api/shared/billing/crypto/methods");
+    }
+    /** 创建加密订单（返回 payTo / amountWei / 过期时间，用户链上转账后用返回的 orderId confirm） */
+    createCryptoOrder(params) {
+        return this.request("POST", "/api/shared/billing/crypto/orders", params);
+    }
+    /** 我的加密订单列表（读取时惰性把超时 pending 单置 expired） */
+    listCryptoOrders(tenantId) {
+        return this.request("GET", `/api/shared/billing/crypto/orders?tenantId=${encodeURIComponent(tenantId)}`);
+    }
+    /** 加密订单详情 */
+    getCryptoOrder(orderId, tenantId) {
+        return this.request("GET", `/api/shared/billing/crypto/orders/${encodeURIComponent(orderId)}?tenantId=${encodeURIComponent(tenantId)}`);
+    }
+    /** 取消待付款订单（仅 pending/expired 可取消，已支付不可） */
+    cancelCryptoOrder(orderId, tenantId) {
+        return this.request("POST", `/api/shared/billing/crypto/orders/${encodeURIComponent(orderId)}/cancel`, { tenantId });
+    }
+    /** 提交链上 txHash 换取引擎回执并生效 */
+    confirmCryptoOrder(orderId, params) {
+        return this.request("POST", `/api/shared/billing/crypto/orders/${encodeURIComponent(orderId)}/confirm`, params);
+    }
+}

package/dist/types.d.ts

@@ -525,7 +525,7 @@ export interface AgentChatParams {
     conversationId?: string;
     /** 钱包地址：交易/综合 agent 构造链上操作时必填 */
     userAddress?: string;
-    /** 目标链 id（Ethereum/BNB/Polygon/Arbitrum/Base/Optimism/OxaChain 等） */
+    /** 目标链 id（Ethereum/BNB/Polygon/Arbitrum/Base/Optimism 等） */
     chainId?: number;
     agentxAgentId?: number;
     tools?: ChatToolDefinition[];
@@ -570,13 +570,13 @@ export interface LightRAGKeyInfo {
 export interface LightRAGDocumentParams {
     text: string;
     file_name?: string;
-    /** Per-user namespace within a bot (defaults to botId = shared) */
+    /** Per-user namespace within a bot (defaults to botId = shared). 平台共享 namespace `market` / `onchain` 只读（仅 query 可用） */
     namespace?: string;
 }
 export interface LightRAGQueryParams {
     query: string;
     mode?: "mix" | "local" | "global" | "hybrid" | "naive";
-    /** Per-user namespace within a bot (defaults to botId = shared) */
+    /** Per-user namespace within a bot (defaults to botId = shared). 平台共享 namespace `market` / `onchain` 只读可查 */
     namespace?: string;
 }
 export interface LightRAGQueryResult {
@@ -903,3 +903,242 @@ export interface HealthInfo {
     uptime?: number;
     [key: string]: unknown;
 }
+/** 商户入驻参数（POST /api/auth/merchant-onboard） */
+export interface MerchantOnboardParams {
+    /** 商户名称（owner 未绑定时用于创建商户） */
+    name: string;
+}
+/** 商户入驻 / 接受邀请结果：在 AuthResult 基础上追加绑定信息 */
+export interface MerchantAuthResult extends AuthResult {
+    merchantId?: string | number;
+    role?: string;
+    accepted?: boolean;
+    alreadyMember?: boolean;
+    alreadyProcessed?: boolean;
+}
+/** 公开商户邀请信息（GET /api/auth/merchant-invites/:token，登录前可读） */
+export interface MerchantInviteInfo {
+    merchant: {
+        id: string | number;
+        name: string;
+    };
+    email: string | null;
+    role: string;
+    status: string;
+}
+/** 发送邮箱验证码（POST /api/auth/email-code/send） */
+export interface EmailCodeSendResult {
+    sent: boolean;
+    ttlSec: number;
+}
+/** 验证码登录参数（POST /api/auth/email-code/login；启用 MFA 的账户需再带 mfaCode） */
+export interface EmailCodeLoginParams {
+    email: string;
+    code: string;
+    mfaCode?: string;
+}
+/** 当前账户 + 租户成员关系（GET /api/auth/me） */
+export interface AccountMeResult extends AuthAccount {
+    tenants: Array<{
+        id: string | number;
+        name: string;
+        slug: string;
+        role: string;
+    }>;
+}
+/** 商户看板（GET /api/merchant/dashboard；camelCase） */
+export interface MerchantDashboardStats {
+    projects: number;
+    bots: number;
+    totalTokens: number;
+    totalConversations: number;
+    documentsCount: number;
+    activeAgents: number;
+    plan: string;
+    planLabel?: string | null;
+    seatCount?: number | null;
+    planStartedAt?: string | null;
+    planExpiresAt?: string | null;
+    docLimit?: number | null;
+    tokenQuota?: number | null;
+    tokensUsedThisMonth?: number;
+    tokensRemaining?: number | null;
+    conversationTrend?: unknown[];
+    botDistribution?: unknown[];
+    quality?: unknown;
+    groupActivity?: unknown;
+}
+/** 转人工工单（GET /api/merchant/tickets，camelCase） */
+export interface MerchantTicket {
+    id: string;
+    conversationId: string | null;
+    botId: string | null;
+    merchantId: string;
+    channel: string | null;
+    title: string | null;
+    status: "open" | "in_progress" | "resolved" | "closed" | string;
+    handler: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface MerchantTicketUpdateParams {
+    status?: "open" | "in_progress" | "resolved" | "closed";
+    handler?: string;
+}
+/** 商户项目（GET /api/merchant/projects；snake_case + 聚合计数） */
+export interface MerchantProject {
+    id: string;
+    name: string;
+    description?: string | null;
+    bot_count?: number;
+    total_tokens?: number;
+    total_conversations?: number;
+    created_at?: string;
+    updated_at?: string;
+    [key: string]: unknown;
+}
+/** 商户 Bot（GET /api/merchant/projects/:id/bots；snake_case） */
+export interface MerchantBot {
+    id: string;
+    project_id: string;
+    name: string;
+    type?: string;
+    status?: string;
+    description?: string | null;
+    prompt?: string | null;
+    [key: string]: unknown;
+}
+export interface MerchantProjectCreateParams {
+    name: string;
+    description?: string;
+}
+export interface MerchantBotCreateParams {
+    name: string;
+    description?: string;
+    prompt?: string;
+}
+/** Bot LLM 配置（GET /api/merchant/.../llm-config 返回 snake_case；未配置时为 null） */
+export interface MerchantLlmConfig {
+    provider: string;
+    endpoint_url: string | null;
+    api_key: string | null;
+    model: string | null;
+}
+/** 写入 Bot LLM 配置（BYOK） */
+export interface MerchantLlmConfigInput {
+    provider: string;
+    endpointUrl?: string;
+    apiKey?: string;
+    model?: string;
+}
+export interface MerchantChain {
+    chainId: number;
+    name: string;
+    rpcUrl: string;
+    explorerUrl?: string | null;
+    symbol?: string | null;
+    decimals?: number | null;
+    [key: string]: unknown;
+}
+export interface MerchantChainAddParams {
+    chainId: number;
+    name: string;
+    rpcUrl: string;
+    explorerUrl?: string;
+    symbol?: string;
+    decimals?: number;
+}
+/** GET /api/merchant/chains */
+export interface MerchantChainList {
+    chains: MerchantChain[];
+    /** 自定义链 id 列表（内置链之外） */
+    custom: number[];
+}
+/** 可授予的商户团队角色（owner 仅商户所有者，不可授予） */
+export type MerchantTeamRole = "admin" | "editor" | "member" | "viewer";
+export interface MerchantTeamMember {
+    key: string;
+    accountId: string | null;
+    role: "owner" | MerchantTeamRole;
+    status: "active" | "invited" | string;
+    username: string | null;
+    email: string | null;
+    wallet: string | null;
+    joinedAt: string | null;
+    /** 仅 owner/admin 可见：待接受邀请的 token */
+    inviteToken?: string;
+}
+export interface MerchantTeamResult {
+    merchantId: string;
+    canManage: boolean;
+    members: MerchantTeamMember[];
+}
+export interface MerchantTeamMemberAddParams {
+    email?: string;
+    wallet?: string;
+    role?: MerchantTeamRole;
+}
+export interface MerchantTeamInviteParams {
+    email: string;
+    role?: MerchantTeamRole;
+}
+export interface MerchantTeamInviteResult {
+    ok: boolean;
+    id: string | number;
+    email: string;
+    role: MerchantTeamRole;
+    status: "invited" | string;
+    inviteToken: string;
+    inviteUrl: string;
+}
+/** 通道连接 / 状态结果（各平台字段不同，保留索引签名） */
+export interface ChannelActionResult {
+    success?: boolean;
+    status?: string;
+    message?: string;
+    qr?: string | null;
+    [key: string]: unknown;
+}
+export interface SendTextParams {
+    chatId: string;
+    text: string;
+}
+/** Telegram 文件发送：documentName 指向该 Bot 已上传的文档 */
+export interface TelegramSendFileParams {
+    chatId: string;
+    documentName: string;
+    caption?: string;
+}
+export interface DiscordDmParams {
+    userId: string;
+    text: string;
+    /** 默认 true：未 opt-in / 不可达则拒绝发送 */
+    enforceOptIn?: boolean;
+}
+export interface DiscordDmOptInParams {
+    userId: string;
+    status: "opted_in" | "revoked" | string;
+    source?: string;
+    note?: string;
+}
+export interface MerchantGroupList {
+    groups: Array<Record<string, unknown>>;
+    botRunning?: boolean;
+    botUsername?: string | null;
+    botConnected?: boolean;
+    [key: string]: unknown;
+}
+export interface EmailMailbox {
+    id: string;
+    botId: string;
+    address: string;
+    [key: string]: unknown;
+}
+export interface EmailMailboxCreateParams {
+    address: string;
+    [key: string]: unknown;
+}
+export interface EmailThreadList {
+    threads: Array<Record<string, unknown>>;
+    take: number;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@reachv2/sdk",
-  "version": "0.3.3",
-  "description": "Reach unified REST API client library for TypeScript — crm 域（AgentApi/Project/Bot/Knowledge/Channel/Conversation/Transaction/Auth/Chat/ApiKey/LightRAG/Orchestration/ScheduledTasks/Internal/Abis/Admin）+ social 域（Content/Tts/Accounts/ContentPlans 内容计划/PublishPlans 发布计划/BrowserTemplates 流程模板/AiMedia 视频脚本/Effect 效果追踪/SeoGeo SEO-GEO 矩阵/ContentRules 内容规则引擎/DataSources 数据源）+ 统一 DashboardApi（crm/social 看板）+ 统一租户成员模型（Tenants/Team/Health，G-1~G-3）",
+  "version": "0.5.0",
+  "description": "Reach unified REST API client library for TypeScript — crm 域（AgentApi/Project/Bot/Knowledge/Channel/Conversation/Transaction/Auth/Chat/ApiKey/LightRAG/Orchestration/ScheduledTasks/Internal/Abis/Admin）+ social 域（Content/Tts/Accounts/ContentPlans 内容计划/PublishPlans 发布计划/BrowserTemplates 流程模板/AiMedia 视频脚本/Effect 效果追踪/SeoGeo SEO-GEO 矩阵/ContentRules 内容规则引擎/DataSources 数据源）+ 商户域（Merchant 控制台/ChannelAdmin 通道与群发/EmailChannel 邮件通道）+ 计费与配额（Billing 社媒计费/SharedBilling 统一订阅与加密收款/Quota 社媒配额）+ 统一 DashboardApi（crm/social 看板）+ 统一租户成员模型（Tenants/Team/Health，G-1~G-3）",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,6 +18,7 @@
     "clean": "rm -rf dist",
     "build": "npm run clean && tsc",
     "test": "node --test",
+    "openapi": "node scripts/generate-openapi.mjs",
     "prepublishOnly": "npm run build && npm test"
   },
   "keywords": [