@huanban/rulego-editor-core 1.4.1 → 2.0.0

package/dist/api/types.d.ts

@@ -33,10 +33,10 @@ 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>;
+    getSharedNodes: (keywords: string, page: number, size: number, type?: string, signal?: AbortSignal) => Promise<PagedResponse<SharedNode>>;
+    getSharedNode: (id: string, type: string, signal?: AbortSignal) => Promise<SharedNode>;
+    saveSharedNode: (id: string, type: string, body: SharedNode, signal?: AbortSignal) => Promise<unknown>;
+    deleteSharedNode: (id: string, type: string, signal?: AbortSignal) => Promise<unknown>;
 }
 export type RuleMaintenanceSeverity = 'info' | 'warning' | 'error';
 export type RuleMaintenanceCategory = 'request' | 'dsl' | 'component' | 'endpoint' | 'runtime' | 'security' | 'compatibility';
@@ -89,6 +89,38 @@ export interface RulePatchPreviewResponse {
     rejected: RuleMaintenanceIssue[];
     issues?: RuleMaintenanceIssue[];
 }
+export type RuleMessageMetadata = Record<string, string> | URLSearchParams | string;
+export interface RuleMessageBody {
+    msgId?: string;
+    metadata?: RuleMessageMetadata;
+    body?: unknown;
+    config?: Omit<RequestInit, 'method' | 'body'>;
+}
+export interface RunsListOptions {
+    page?: number;
+    size?: number;
+    status?: string;
+    msgType?: string;
+    source?: string;
+    startTime?: number | string;
+    endTime?: number | string;
+    startDate?: string;
+    endDate?: string;
+}
+export interface RunRecord {
+    [field: string]: unknown;
+}
+export interface ComponentDSL {
+    [field: string]: unknown;
+}
+export interface RuleListOptions {
+    page?: number;
+    size?: number;
+    keywords?: string;
+    root?: boolean;
+    disabled?: boolean;
+    category?: string;
+}
 export type ApiRequestHeaders = Record<string, string> | (() => Record<string, string>);
 export type ApiCustomFetch = (url: string, init?: RequestInit) => Promise<Response>;
 export type ApiCacheKey = string;
@@ -98,15 +130,17 @@ export interface ApiAuthRequiredDetails {
 }
 export type ApiAuthRequiredHandler = (details: ApiAuthRequiredDetails) => void;
 export interface WorkflowFetcher {
-    list: (page: number, size: number, keywords: string) => Promise<PagedResponse<WorkflowItem>>;
+    list: (page: number, size: number, keywords: string, signal?: AbortSignal) => 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>;
+    create: (data: Record<string, unknown>, options?: {
+        draft?: boolean;
+    }) => Promise<ApiResult>;
     remove: (id: string) => Promise<ApiResult>;
     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>>;
+    getContent: (id: string, signal?: AbortSignal) => 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>;
@@ -115,6 +149,18 @@ export interface WorkflowFetcher {
     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>;
+    notifyRule?: (chainId: string, msgType: string, body?: RuleMessageBody) => Promise<void>;
+    executeRule?: (chainId: string, msgType: string, body?: RuleMessageBody) => Promise<unknown>;
+    listFiltered?: (options?: RuleListOptions, signal?: AbortSignal) => Promise<PagedResponse<WorkflowItem>>;
+    getRuleCategories?: (signal?: AbortSignal) => Promise<string[]>;
+    getDebugData?: (chainId: string, nodeId?: string, page?: number, size?: number, signal?: AbortSignal) => Promise<unknown[]>;
+    getRunsList?: (chainId: string, options?: RunsListOptions, signal?: AbortSignal) => Promise<PagedResponse<RunRecord>>;
+    getRuns?: (chainId: string, id: string, signal?: AbortSignal) => Promise<RunRecord>;
+    deleteRuns?: (chainId: string, ids?: string | string[], signal?: AbortSignal) => Promise<void>;
+    getComponentDSL?: (nodeType: string, signal?: AbortSignal) => Promise<ComponentDSL>;
+    installComponent?: (nodeType: string, dsl: ComponentDSL, signal?: AbortSignal) => Promise<void>;
+    uninstallComponent?: (nodeType: string, signal?: AbortSignal) => Promise<void>;
+    queryDynamicBuiltin?: (name: string, params?: Record<string, unknown>, signal?: AbortSignal) => Promise<unknown>;
 }
 export interface WorkflowListIcons {
     design?: unknown;
@@ -150,15 +196,41 @@ export interface RuleChainRoutes {
     status?: (id: string) => string;
     sharedNodeStatuses?: string;
     sharedNodes?: string;
-    sharedNode?: (encodedId: string, encodedType: string) => string;
+    sharedNode?: (encodedId: string, resourceType: string) => string;
     saveBaseInfo: (id: string) => string;
     saveConfig: (id: string, configType: string) => string;
-    validateUpstream: (id: string) => string;
-    schemaDiff: (id: string) => string;
-    repairPlan: (id: string) => string;
-    patchPreview: (id: string) => string;
-}
-export declare const DEFAULT_ROUTES: RuleChainRoutes;
+    validateUpstream?: (id: string) => string;
+    schemaDiff?: (id: string) => string;
+    repairPlan?: (id: string) => string;
+    patchPreview?: (id: string) => string;
+    notifyRule?: (id: string, msgType: string) => string;
+    executeRule?: (id: string, msgType: string) => string;
+    ruleCategories?: string;
+    debugData?: string;
+    runsList?: string;
+    dynamicComponent?: (nodeType: string) => string;
+    queryDynamicBuiltin?: (name: string) => string;
+}
+export declare const DEFAULT_ROUTES: {
+    list: string;
+    create: string;
+    remove: (id: string) => string;
+    operate: (id: string, type: string) => string;
+    getContent: (id: string) => string;
+    status: (id: string) => string;
+    sharedNodeStatuses: string;
+    sharedNodes: string;
+    sharedNode: (encodedId: string, resourceType: string) => string;
+    saveBaseInfo: (id: string) => string;
+    saveConfig: (id: string, configType: string) => string;
+    notifyRule: (id: string, msgType: string) => string;
+    executeRule: (id: string, msgType: string) => string;
+    ruleCategories: string;
+    debugData: string;
+    runsList: string;
+    dynamicComponent: (nodeType: string) => string;
+    queryDynamicBuiltin: (name: string) => string;
+};
 export interface RuleChainAPIOptions {
     apiBase: string;
     timeout?: number;