@huanban/rulego-editor-core 1.3.18 → 1.4.0

package/dist/api/response-utils.d.ts

@@ -1,28 +1,10 @@
-/**
- * Unwrap common backend envelopes while keeping native RuleGo payloads intact.
- *
- * Supported:
- * - { code: 0, data: ... }
- * - { success: true, data: ... }
- * - { status: "ok", data: ... }
- * - { data: ... }
- */
 export declare function unwrapApiEnvelope<T = unknown>(raw: unknown): T;
-/**
- * Normalize list responses used by RuleGo-compatible backends.
- *
- * Supported list shapes:
- * - [...]
- * - { items, total, page, size }
- * - { records, total, current, size }
- * - { rows, count }
- * - { data: { items|records|rows|list, total } }
- * - { code, data: ... }
- */
-export declare function normalizePagedResponse<T>(raw: unknown, mapItem: (item: unknown) => T, fallbackPage?: number, fallbackPageSize?: number): {
+export declare function normalizePagedResponse<T>(raw: unknown, mapItem: (item: unknown) => T, fallbackPage?: number, fallbackPageSize?: number, options?: {
+    includeMetadata?: boolean;
+}): {
     items: T[];
     total: number;
+    totalIsAuthoritative?: boolean;
     page: number;
     pageSize: number;
 };
-//# sourceMappingURL=response-utils.d.ts.map

package/dist/api/types.d.ts

@@ -1,64 +1,43 @@
-/**
- * @file api/types.ts
- * @description 规则链 API 通用类型定义 — 框架无关
- *
- * 这些类型在 editor-core / editor-react / editor-vue 三个包之间共享。
- * 消费者通过实现 WorkflowFetcher 接口来替换默认的请求实现。
- *
- * @module @huanban/rulego-editor-core/api
- */
-/**
- * 工作流列表项（前端扁平化结构）
- *
- * @description 后端返回嵌套 { ruleChain: {...}, metadata: {...} }，
- * 经过 parseRuleChain() 转换为此扁平结构供 UI 消费。
- */
 export interface WorkflowItem {
-    /** 规则链 ID */
     id: string;
-    /** 规则链名称 */
     name: string;
-    /** 是否为根规则链 */
     root: boolean;
-    /** 是否禁用 */
     disabled: boolean;
-    /** 是否开启调试模式 */
     debugMode: boolean;
-    /** 描述 */
     description: string;
-    /** 附加信息（保留原始字段） */
     additionalInfo: Record<string, unknown>;
-    /** 创建时间 */
     createTime: string;
-    /** 更新时间 */
     updateTime: string;
-    /** 是否运行中 (原版协议: disabled=false -> 运行, disabled=true -> 停用) */
     deployed: boolean;
 }
-/**
- * 分页响应
- */
 export interface PagedResponse<T> {
-    /** 数据列表 */
     items: T[];
-    /** 总记录数 */
     total: number;
-    /** 当前页码 */
+    totalIsAuthoritative?: boolean;
     page: number;
-    /** 每页条数 */
     pageSize: number;
 }
-/**
- * API 操作结果
- */
+export interface ListAllResult<T> {
+    items: T[];
+    complete: boolean;
+    pages: number;
+    total: number | null;
+    maxPages: number;
+}
 export interface ApiResult {
-    /** 是否成功 */
     success: boolean;
-    /** 消息 */
     msg?: string;
-    /** 可选数据 */
     data?: unknown;
 }
+export interface SharedNode {
+    [field: string]: unknown;
+}
+export interface SharedNodeFetcher {
+    getSharedNodes: (keywords: string, page: number, size: number, type?: string) => Promise<PagedResponse<SharedNode>>;
+    getSharedNode: (id: string, type: string) => Promise<SharedNode>;
+    saveSharedNode: (id: string, type: string, body: SharedNode) => Promise<unknown>;
+    deleteSharedNode: (id: string, type: string) => Promise<unknown>;
+}
 export type RuleMaintenanceSeverity = 'info' | 'warning' | 'error';
 export type RuleMaintenanceCategory = 'request' | 'dsl' | 'component' | 'endpoint' | 'runtime' | 'security' | 'compatibility';
 export interface RuleMaintenanceIssue {
@@ -110,202 +89,88 @@ export interface RulePatchPreviewResponse {
     rejected: RuleMaintenanceIssue[];
     issues?: RuleMaintenanceIssue[];
 }
-/**
- * 工作流请求适配器接口
- *
- * @description 消费者可实现此接口来替换包的默认请求方式。
- * 不传 fetcher 时，包会用内置的 RuleChainAPI (纯 fetch) 实现。
- * 传了 fetcher 后，apiBase 参数不再生效。
- *
- * @example 使用 axios 替换:
- * ```ts
- * const myFetcher: WorkflowFetcher = {
- *   list: async (page, size, kw) => {
- *     const res = await axios.get('/api/v1/rules', { params: { page, size, keywords: kw } })
- *     return res.data
- *   },
- *   create: async (data) => {
- *     await axios.post(`/api/v1/rules/${data.ruleChain.id}`, data)
- *     return { success: true }
- *   },
- *   // ...
- * }
- * ```
- *
- * @example 使用 systemGateway (HuanbanClaw):
- * ```ts
- * const myFetcher: WorkflowFetcher = {
- *   list: (p, s, kw) => systemGateway.getRuleChains(p, s, kw),
- *   create: (data) => systemGateway.createRuleChain(data),
- *   remove: (id) => systemGateway.deleteRuleChain(id),
- *   operate: (id, type) => systemGateway.operateRuleChain(id, type),
- *   copy: (id) => systemGateway.copyRuleChain(id),
- *   getContent: (id) => systemGateway.getRuleChainContent(id),
- *   saveBaseInfo: (id, data) => systemGateway.saveRuleChainBaseInfo(id, data),
- *   saveConfig: (id, type, data) => systemGateway.saveRuleChainConfig(id, type, data),
- * }
- * ```
- */
+export type ApiRequestHeaders = Record<string, string> | (() => Record<string, string>);
+export type ApiCustomFetch = (url: string, init?: RequestInit) => Promise<Response>;
+export type ApiCacheKey = string;
+export interface ApiAuthRequiredDetails {
+    status: 401 | 403;
+    url: string;
+}
+export type ApiAuthRequiredHandler = (details: ApiAuthRequiredDetails) => void;
 export interface WorkflowFetcher {
-    /** 查询列表（分页 + 搜索） */
     list: (page: number, size: number, keywords: string) => Promise<PagedResponse<WorkflowItem>>;
-    /** 创建规则链 */
+    listAll?: (size?: number, keywords?: string, maxPages?: number) => Promise<WorkflowItem[]>;
+    listAllDetailed?: (size?: number, keywords?: string, maxPages?: number) => Promise<ListAllResult<WorkflowItem>>;
     create: (data: Record<string, unknown>) => Promise<ApiResult>;
-    /** 删除规则链 */
     remove: (id: string) => Promise<ApiResult>;
-    /** 部署/下线 (原版接口动作: start=部署/启动, stop=下线) */
     operate: (id: string, type: 'start' | 'stop') => Promise<ApiResult>;
-    /** 复制规则链 */
+    restart?: (id: string) => Promise<ApiResult>;
     copy: (id: string, newName?: string) => Promise<ApiResult>;
-    /** 获取完整内容 */
     getContent: (id: string) => Promise<Record<string, unknown>>;
-    /** 保存基础信息 */
+    getChainStatuses?: (id: string, signal?: AbortSignal) => Promise<unknown>;
+    getSharedNodeStatuses?: (signal?: AbortSignal) => Promise<unknown>;
     saveBaseInfo: (id: string, info: Record<string, unknown>) => Promise<ApiResult>;
-    /** 保存配置（变量或秘钥） */
     saveConfig: (id: string, configType: 'vars' | 'secrets', data: Record<string, string>) => Promise<ApiResult>;
-    /** 运行上游兼容校验，只读，不保存、不部署 */
     validateUpstream?: (id: string, dsl: Record<string, unknown>, options?: Record<string, unknown>) => Promise<RuleValidateUpstreamResponse>;
-    /** 获取结构差异，只读 */
     getSchemaDiff?: (id: string) => Promise<RuleSchemaDiffResponse>;
-    /** 获取修复建议，只读，不保存 */
     getRepairPlan?: (id: string, dsl: Record<string, unknown>, options?: Record<string, unknown>) => Promise<RuleRepairPlanResponse>;
-    /** 预览补丁结果，只读，不保存、不部署 */
     previewPatch?: (id: string, dsl: Record<string, unknown>, operations: JSONPatchOperation[]) => Promise<RulePatchPreviewResponse>;
 }
-/**
- * 工作流列表图标映射
- *
- * @description 消费者可传入自定义图标（React/Vue 节点或字符串）。
- * 不传时使用包内置的 emoji 图标（零依赖）。
- *
- * 在 原生 JS 中传 HTML 字符串:
- * ```js
- * icons: { design: '<svg>...</svg>', delete: '🗑' }
- * ```
- *
- * 在 React 中传 JSX:
- * ```tsx
- * icons={{ design: <EditOutlined />, delete: <DeleteOutlined /> }}
- * ```
- */
 export interface WorkflowListIcons {
-    /** 设计按钮图标 */
     design?: unknown;
-    /** 信息按钮图标 */
     info?: unknown;
-    /** 部署按钮图标 */
     start?: unknown;
-    /** 下线按钮图标 */
     stop?: unknown;
-    /** 复制按钮图标 */
     copy?: unknown;
-    /** 删除按钮图标 */
     delete?: unknown;
-    /** 搜索图标 */
     search?: unknown;
-    /** 刷新图标 */
     refresh?: unknown;
-    /** 添加图标 */
     add?: unknown;
-    /** 工作流图标 */
     workflow?: unknown;
-    /** 记录图标 */
+    subWorkflow?: unknown;
     logs?: unknown;
 }
-/**
- * 工作流信息面板图标映射
- */
 export interface WorkflowInfoIcons {
-    /** 变量图标 */
     variable?: unknown;
-    /** 秘钥图标 */
     secret?: unknown;
-    /** API 集成图标 */
     api?: unknown;
-    /** MCP 集成图标 */
     mcp?: unknown;
-    /** 复制图标 */
     copy?: unknown;
-    /** 删除图标 */
     delete?: unknown;
-    /** 添加图标 */
     add?: unknown;
-    /** 保存图标 */
     save?: unknown;
 }
-/**
- * 支持的主题类型
- */
 export type WorkflowTheme = 'light' | 'dark' | string;
-/**
- * API 路由映射
- *
- * @description 消费者可逐个覆盖 API 路径。
- * 支持字符串模板或函数两种形式，函数接收动态参数返回完整路径。
- *
- * @example 自定义路由:
- * ```ts
- * const routes: Partial<RuleChainRoutes> = {
- *   list: '/my-api/chains',                    // 字符串
- *   getContent: (id) => `/my-api/chains/${id}`, // 函数
- *   operate: (id, type) => `/my-api/chains/${id}/action/${type}`,
- *   saveBaseInfo: (id) => `/custom/${id}/info`,
- * }
- * ```
- */
 export interface RuleChainRoutes {
-    /** 列表路径，默认 '/rules' */
     list: string;
-    /** 创建/保存路径模板，默认 '/rules/:id' */
     create: string;
-    /** 删除路径，接收 (id) => string，默认 '/rules/:id' */
     remove: (id: string) => string;
-    /** 部署/下线路径，接收 (id, type) => string，默认 '/rules/:id/operate/:type' */
     operate: (id: string, type: string) => string;
-    /** 获取内容路径，接收 (id) => string，默认 '/rules/:id' */
     getContent: (id: string) => string;
-    /** 保存基础信息路径，接收 (id) => string，默认 '/rules/:id/base' */
+    status?: (id: string) => string;
+    sharedNodeStatuses?: string;
+    sharedNodes?: string;
+    sharedNode?: (encodedId: string, encodedType: string) => string;
     saveBaseInfo: (id: string) => string;
-    /** 保存配置路径，接收 (id, configType) => string，默认 '/rules/:id/config/:configType' */
     saveConfig: (id: string, configType: string) => string;
-    /** 上游兼容校验路径，默认 '/rules/:id/validate-upstream' */
     validateUpstream: (id: string) => string;
-    /** 结构差异路径，默认 '/rules/:id/schema-diff' */
     schemaDiff: (id: string) => string;
-    /** 修复建议路径，默认 '/rules/:id/repair-plan' */
     repairPlan: (id: string) => string;
-    /** 补丁预览路径，默认 '/rules/:id/patch-preview' */
     patchPreview: (id: string) => string;
 }
-/**
- * 默认路由映射
- *
- * @description 对齐原版前端 rules.js: operateWorkflow(id, operateType)
- */
 export declare const DEFAULT_ROUTES: RuleChainRoutes;
-/**
- * 内置 API 客户端配置
- */
 export interface RuleChainAPIOptions {
-    /** API 基础地址（如 'http://127.0.0.1:9090/api/v1'） */
     apiBase: string;
-    /** 请求超时毫秒数，默认 8000 */
     timeout?: number;
-    /** 自定义请求头；支持函数形式以便每次请求读取最新 token */
-    headers?: Record<string, string> | (() => Record<string, string>);
-    /** 认证 Token */
+    headers?: ApiRequestHeaders;
     authToken?: string;
-    /**
-     * 自定义路由映射（可部分覆盖）
-     *
-     * @example
-     * ```ts
-     * routes: {
-     *   list: '/my-custom/chains',
-     *   remove: (id) => `/my-custom/chains/${id}`,
-     * }
-     * ```
-     */
+    includeStoredToken?: boolean;
+    customFetch?: ApiCustomFetch;
+    credentials?: RequestCredentials;
+    onAuthRequired?: (details: {
+        status: 401 | 403;
+        url: string;
+    }) => void;
+    serverStatus?: import('../core/server-status').ServerStatusStore;
     routes?: Partial<RuleChainRoutes>;
 }
-//# sourceMappingURL=types.d.ts.map