@rytass/bpm-core-shared 0.1.10 → 0.2.0

package/src/lib/workflow-graph.d.ts

@@ -0,0 +1,96 @@
+import { FormDefinitionSchema, FormFieldDefinition, FormFieldOption } from './form';
+import { ApproverResolver, ServiceAction, WorkflowDefinition, WorkflowEdge, WorkflowEdgeConditionOperator, WorkflowEdgeData, WorkflowNode, WorkflowNodeTriggerMode } from './workflow';
+/**
+ * Pure, framework-agnostic structural operations over a {@link WorkflowDefinition}.
+ *
+ * This module is the canonical home for every transform that the template
+ * designer performs on the workflow graph. It intentionally contains **no**
+ * React, DOM, or layout (dagre) dependency so that both the frontend designer
+ * and the backend can share the exact same semantics, and so the LLM command
+ * layer ({@link ./workflow-command}) can be built on top of it.
+ *
+ * Pixel layout (dagre) and ReactFlow node/edge mapping stay in the React lib;
+ * the structures here only describe the logical graph.
+ */
+/** Node types a user can add from the palette (start/end are implicit). */
+export type NodePaletteType = 'exclusiveGateway' | 'serviceTask' | 'userTask';
+export declare const WORKFLOW_INPUT_HANDLE_ID = "input";
+export declare const WORKFLOW_OUTPUT_HANDLE_ID = "output";
+export declare const WORKFLOW_NODE_TYPE_LABELS: Readonly<Record<WorkflowNode['type'], string>>;
+export interface ConditionOperatorOption {
+    readonly id: WorkflowEdgeConditionOperator;
+    readonly name: string;
+}
+export declare const CONDITION_OPERATOR_OPTIONS: readonly ConditionOperatorOption[];
+export declare const CONDITION_OPERATORS_REQUIRING_VALUE: readonly WorkflowEdgeConditionOperator[];
+export interface WorkflowConnectionCandidate {
+    readonly source?: string | null;
+    readonly sourceHandle?: string | null;
+    readonly target?: string | null;
+    readonly targetHandle?: string | null;
+}
+/** Result of inserting a node, including the post-insert selection intent. */
+export interface WorkflowNodeInsertResult {
+    readonly definition: WorkflowDefinition;
+    readonly editingEdgeId: string | null;
+    readonly selectedEdgeIds: readonly string[];
+    readonly selectedNodeId: string | null;
+}
+/**
+ * Factory used to mint workflow edge ids. Injectable so callers (e.g. tests or
+ * a deterministic reducer run) can supply stable ids; defaults to a
+ * time + random suffix to match the original designer behaviour.
+ */
+export type WorkflowEdgeIdFactory = (source: string, target: string) => string;
+export declare function defaultWorkflowEdgeId(source: string, target: string): string;
+export declare function renameWorkflowNode(node: WorkflowNode, label: string): WorkflowNode;
+export declare function applyWorkflowNodeTriggerMode(node: WorkflowNode, triggerMode: WorkflowNodeTriggerMode): WorkflowNode;
+export declare function normalizeDesignerWorkflowDefinition(definition: WorkflowDefinition): WorkflowDefinition;
+export declare function removeAsyncNotifyOutgoingEdges(definition: WorkflowDefinition): WorkflowDefinition;
+export declare function normalizeSingleIncomingTriggerModes(definition: WorkflowDefinition): WorkflowDefinition;
+export declare function createWorkflowNode(type: NodePaletteType, index: number): WorkflowNode;
+export declare function readNextWorkflowNodeIndex(nodes: readonly WorkflowNode[], type: NodePaletteType): number;
+export declare function createWorkflowEdge(source: string, target: string, data: WorkflowEdgeData, createId?: WorkflowEdgeIdFactory): WorkflowEdge;
+export declare function readInsertedOutgoingEdgeData(node: WorkflowNode): WorkflowEdgeData;
+export declare function insertWorkflowNodeIntoDefinition({ createId, definition, node, selectedEdgeId, selectedNodeId, }: {
+    readonly createId?: WorkflowEdgeIdFactory;
+    readonly definition: WorkflowDefinition;
+    readonly node: WorkflowNode;
+    readonly selectedEdgeId: string | null;
+    readonly selectedNodeId: string | null;
+}): WorkflowNodeInsertResult;
+export declare function insertWorkflowNodeAtEdge(definition: WorkflowDefinition, node: WorkflowNode, edge: WorkflowEdge, createId?: WorkflowEdgeIdFactory): WorkflowNodeInsertResult;
+export declare function insertWorkflowNodeAfterNode(definition: WorkflowDefinition, node: WorkflowNode, sourceNode: WorkflowNode, createId?: WorkflowEdgeIdFactory): WorkflowNodeInsertResult;
+export declare function readFallbackWorkflowDefinition(): WorkflowDefinition;
+export declare function isEmptyDesignerWorkflowDefinition(definition: WorkflowDefinition): boolean;
+export declare function isWorkflowConnectionValid(connection: WorkflowConnectionCandidate, nodes: readonly WorkflowNode[]): boolean;
+export declare function isWorkflowNodeRemovable(node: WorkflowNode): boolean;
+export declare function isWorkflowNodeInputConnectable(node: WorkflowNode): boolean;
+export declare function isWorkflowNodeOutputConnectable(node: WorkflowNode): boolean;
+export declare function isAsyncNotifyServiceTask(node: WorkflowNode): boolean;
+export declare function isExclusiveGatewaySourceEdge(edge: WorkflowEdge, nodes: readonly WorkflowNode[]): boolean;
+export declare function isParallelGatewaySourceEdge(edge: WorkflowEdge, nodes: readonly WorkflowNode[]): boolean;
+export declare function toggleSelectedEdgeId(edgeIds: readonly string[], edgeId: string): readonly string[];
+export declare function readWorkflowDefinitionIssue(definition: WorkflowDefinition): string | null;
+export declare function readApproverResolverIssue(resolver: ApproverResolver): string | null;
+export declare function hasConfiguredConditionEdges(definition: WorkflowDefinition): boolean;
+export declare function readServiceTaskMemberIds(action: ServiceAction): readonly string[];
+export declare function readConditionField(schema: FormDefinitionSchema | null, fieldKey: string | null): FormFieldDefinition | null;
+export declare function readConditionOperator(value: string | null): WorkflowEdgeConditionOperator | null;
+export declare function readConditionOperatorIds(field: FormFieldDefinition): readonly WorkflowEdgeConditionOperator[];
+export interface ConditionValueOption {
+    readonly id: string;
+    readonly name: string;
+}
+export declare function readConditionValueOptions(field: FormFieldDefinition | null): readonly ConditionValueOption[];
+export declare function readNextConditionOperator(field: FormFieldDefinition | null, operator: WorkflowEdgeConditionOperator | null): WorkflowEdgeConditionOperator | undefined;
+export declare function readNextConditionValue(field: FormFieldDefinition | null, operator: WorkflowEdgeConditionOperator | undefined, value: string | null): string | undefined;
+export declare function shouldConditionOperatorUseValue(operator: WorkflowEdgeConditionOperator): boolean;
+export declare function readConditionLabel(field: FormFieldDefinition | null, operator: WorkflowEdgeConditionOperator | undefined, value: string | undefined): string | undefined;
+export declare function readConditionOperatorLabel(operator: WorkflowEdgeConditionOperator): string;
+export declare function readConditionValueLabel(field: FormFieldDefinition, value: string): string;
+export declare function readFormFieldOption(options: readonly FormFieldOption[], value: string): FormFieldOption | null;
+export declare function readConditionExpression(field: FormFieldDefinition | null, operator: WorkflowEdgeConditionOperator | undefined, value: string | undefined): string | undefined;
+export declare function readFormFieldReference(fieldKey: string): string;
+export declare function readConditionExpressionOperator(operator: WorkflowEdgeConditionOperator): string;
+export declare function readConditionExpressionValue(field: FormFieldDefinition, value: string): string;