bpmn-auto-layout/lib/layout/Types.ts at main · bpmn-io/bpmn-auto-layout · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
import type { LayoutWarning } from '../LayoutWarning.js';
import type {
  Point,
  Rect
} from 'diagram-js/lib/util/Types.js';

import type { BpmnElement } from './bpmn/Types.js';

export type { BpmnElement } from './bpmn/Types.js';

export type Bounds = Rect;

export type Waypoint = Point;

export type LayoutState = {
  scope: BpmnElement;
  shapes: Map<BpmnElement, Bounds>;
  edges: Map<BpmnElement, Waypoint[]>;
  children: LayoutState[];
  emitInParent: boolean;
};

export type LayoutRecord = {
  element: BpmnElement;
  index: number;
  size: {
    width: number;
    height: number;
  };
  isBoundary: boolean;
  isArtifact: boolean;
  expanded: boolean;
  child: LayoutState | null;
  bounds?: Bounds;
};

export type SemanticPolicy = {
  spine: Set<BpmnElement>;
  straightEdges: Set<BpmnElement>;
  bands: Map<BpmnElement, number>;
  components: Map<BpmnElement, number>;
  edgeOrder: Map<BpmnElement, number>;
  flowNodeDocumentIndex: Map<BpmnElement, number>;
  graphEdges: BpmnElement[];
  compactFlowRegions: unknown[];
  rankWeights: Map<BpmnElement, number>;
  backEdges: Set<BpmnElement>;
  boundaryBayEdges: Set<BpmnElement>;
};

export type RankAssignment = {
  rank: Map<BpmnElement, number>;
};

export type ProcessLayoutStep = (
  context: ProcessLayoutContext
) => ProcessLayoutContext;

export type ProcessLayoutResult = {
  layout: LayoutState;
  warnings: LayoutWarning[];
};

export type ProcessLayoutOptions = {
  expandedIds: Set<string>;
  participantProcess: boolean;
  messageFlowEndpointDirections: Map<BpmnElement, Set<string>>;
  layoutScope: (
    scope: BpmnElement,
    options?: Partial<ProcessLayoutOptions>
  ) => ProcessLayoutResult;
};

export type ProcessElements = {
  groups: BpmnElement[];
  sequenceFlows: BpmnElement[];
  associations: BpmnElement[];
};

export type ProcessPlacement = {
  records: LayoutRecord[];
  recordsByElement: Map<BpmnElement, LayoutRecord>;
};

export type ProcessGraph = {
  nodes: BpmnElement[];
  edges: BpmnElement[];
  boundaryEdges: BpmnElement[];
};

export type ProcessSemantics = {
  policy: SemanticPolicy | null;
  ranks: RankAssignment | null;
};

export type ProcessLayoutContext = {
  scope: BpmnElement;
  options: ProcessLayoutOptions;
  elements: ProcessElements;
  graph: ProcessGraph;
  semantics: ProcessSemantics;
  placement: ProcessPlacement;
  layout: LayoutState;
  warnings: LayoutWarning[];
};

export type CollaborationLayoutStep = (
  context: CollaborationLayoutContext
) => CollaborationLayoutContext;

export type CollaborationLayoutOptions = {
  expandedIds: Set<string>;
};

export type CollaborationLayoutContext = {
  collaboration: BpmnElement;
  options: CollaborationLayoutOptions;
  participants: {
    layouts: Map<BpmnElement, LayoutState>;
    anchorPositioned: Set<BpmnElement>;
    expandable: Set<BpmnElement>;
    order: BpmnElement[];
  };
  routing: {
    endpointDirections: Map<BpmnElement, Set<string>>;
    channelOffsets: Map<BpmnElement, number>;
  };
  layout: LayoutState;
  warnings: LayoutWarning[];
};