-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathapollon-editor.tsx
More file actions
402 lines (353 loc) · 13.1 KB
/
apollon-editor.tsx
File metadata and controls
402 lines (353 loc) · 13.1 KB
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
import ReactDOM from "react-dom/client"
import { AppWithProvider } from "./App"
import { ReactFlowInstance, type Node, type Edge } from "@xyflow/react"
import {
parseDiagramType,
mapFromReactFlowNodeToApollonNode,
mapFromReactFlowEdgeToApollonEdge,
DeepPartial,
getSVG,
getDiagramBounds,
} from "./utils"
import { UMLDiagramType } from "./types"
import { createDiagramStore, DiagramStore } from "@/store/diagramStore"
import { createMetadataStore, MetadataStore } from "@/store/metadataStore"
import { createPopoverStore, PopoverStore } from "@/store/popoverStore"
import {
createAssessmentSelectionStore,
AssessmentSelectionStore,
} from "@/store/assessmentSelectionStore"
import {
createAlignmentGuidesStore,
AlignmentGuidesStore,
} from "@/store/alignmentGuidesStore"
import {
DiagramStoreContext,
MetadataStoreContext,
PopoverStoreContext,
AssessmentSelectionStoreContext,
AlignmentGuidesStoreContext,
} from "./store/context"
import {
MessageType,
SendBroadcastMessage,
YjsSyncClass,
} from "@/sync/yjsSyncClass"
import * as Y from "yjs"
import { StoreApi } from "zustand"
import * as Apollon from "./typings"
export class ApollonEditor {
private root: ReactDOM.Root
private reactFlowInstance: ReactFlowInstance | null = null
private readonly syncManager: YjsSyncClass
private readonly ydoc: Y.Doc
private readonly diagramStore: StoreApi<DiagramStore>
private readonly metadataStore: StoreApi<MetadataStore>
private readonly popoverStore: StoreApi<PopoverStore>
private readonly assessmentSelectionStore: StoreApi<AssessmentSelectionStore>
private readonly alignmentGuidesStore: StoreApi<AlignmentGuidesStore>
private subscribers: Apollon.Subscribers = {}
constructor(element: HTMLElement, options?: Apollon.ApollonOptions) {
if (!(element instanceof HTMLElement)) {
throw new Error("Element is required to initialize Apollon2")
}
this.ydoc = new Y.Doc()
this.diagramStore = createDiagramStore(this.ydoc)
this.metadataStore = createMetadataStore(this.ydoc)
this.popoverStore = createPopoverStore()
this.assessmentSelectionStore = createAssessmentSelectionStore()
this.alignmentGuidesStore = createAlignmentGuidesStore()
this.syncManager = new YjsSyncClass(
this.ydoc,
this.diagramStore,
this.metadataStore
)
const diagramId =
options?.model?.id || Math.random().toString(36).substring(2, 15)
// Initialize React root
this.root = ReactDOM.createRoot(element, {
identifierPrefix: `apollon2-${diagramId}`,
})
this.diagramStore.getState().setDiagramId(diagramId)
// Initialize metadata and diagram type
const diagramName = options?.model?.title || "Untitled Diagram"
const diagramType =
options?.type || options?.model?.type || UMLDiagramType.ClassDiagram
this.metadataStore
.getState()
.updateMetaData(diagramName, parseDiagramType(diagramType))
if (options?.model) {
const nodes = options.model.nodes || []
const edges = options.model.edges || []
const assessments = options.model.assessments || {}
this.diagramStore.getState().setNodesAndEdges(nodes, edges)
this.diagramStore.getState().setAssessments(assessments)
}
if (options?.mode) {
this.metadataStore.getState().setMode(options.mode)
}
if (options?.enablePopups !== undefined) {
this.popoverStore.getState().setPopupEnabled(options.enablePopups)
}
if (options?.readonly !== undefined) {
this.metadataStore.getState().setReadonly(options.readonly)
}
if (options?.debug !== undefined) {
this.metadataStore.getState().setDebug(options.debug)
}
if (options?.scrollLock !== undefined) {
this.metadataStore.getState().setScrollLock(options.scrollLock)
}
if (
this.metadataStore.getState().mode === Apollon.ApollonMode.Modelling &&
!options?.collaborationEnabled
) {
this.diagramStore.getState().initializeUndoManager()
}
this.root.render(
<DiagramStoreContext.Provider value={this.diagramStore}>
<MetadataStoreContext.Provider value={this.metadataStore}>
<PopoverStoreContext.Provider value={this.popoverStore}>
<AssessmentSelectionStoreContext.Provider
value={this.assessmentSelectionStore}
>
<AlignmentGuidesStoreContext.Provider
value={this.alignmentGuidesStore}
>
<AppWithProvider
onReactFlowInit={this.setReactFlowInstance.bind(this)}
/>
</AlignmentGuidesStoreContext.Provider>
</AssessmentSelectionStoreContext.Provider>
</PopoverStoreContext.Provider>
</MetadataStoreContext.Provider>
</DiagramStoreContext.Provider>
)
}
private setReactFlowInstance(instance: ReactFlowInstance) {
this.reactFlowInstance = instance
}
public getNodes(): Node[] {
if (this.reactFlowInstance) {
return this.reactFlowInstance.getNodes()
}
return []
}
public getEdges(): Edge[] {
return this.reactFlowInstance ? this.reactFlowInstance.getEdges() : []
}
set diagramType(type: UMLDiagramType) {
this.metadataStore.getState().updateDiagramType(type)
this.diagramStore.getState().setNodesAndEdges([], [])
this.diagramStore.getState().setAssessments({})
}
public destroy() {
try {
// Clean up all active subscriptions before destroying
Object.keys(this.subscribers).forEach((subscriberId) => {
const unsubscribeCallback = this.subscribers[parseInt(subscriberId)]
unsubscribeCallback?.()
})
this.subscribers = {}
this.syncManager.stopSync()
this.root.unmount()
this.ydoc.destroy()
this.reactFlowInstance = null
// Zustand stores are automatically garbage-collected when references are gone
} catch {
// ignore
}
}
/**
* renders a model as a svg and returns it. Therefore the svg is temporarily added to the dom and removed after it has been rendered.
* @param model the apollon model to export as a svg
* @param options options to change the export behavior (add margin, exclude element ...)
* @param theme the theme which should be applied on the svg
*/
static async exportModelAsSvg(
model: Apollon.UMLModel,
options?: Apollon.ExportOptions,
theme?: DeepPartial<Apollon.Styles>
): Promise<Apollon.SVG> {
void theme
const container = document.createElement("div")
container.style.display = "flex"
container.style.width = "4000px"
container.style.height = "4000px"
container.style.zIndex = "-1000"
container.style.top = "0"
container.style.position = "absolute"
container.style.left = "-99px"
document.body.appendChild(container)
const ydoc = new Y.Doc()
const diagramStore = createDiagramStore(ydoc)
const metadataStore = createMetadataStore(ydoc)
const popoverStore = createPopoverStore()
const assessmentSelectionStore = createAssessmentSelectionStore()
const alignmentGuidesStore = createAlignmentGuidesStore()
const diagramId = Math.random().toString(36).substring(2, 15)
let setReactFlowInstance: (instance: ReactFlowInstance) => void = () => {}
const reactFlowInstancePromise = new Promise<ReactFlowInstance>(
(resolve) => {
setReactFlowInstance = resolve
}
)
const svgRoot = ReactDOM.createRoot(container, {
identifierPrefix: `apollon2-exportAsSVG-${diagramId}`,
})
diagramStore.getState().setNodesAndEdges(model.nodes, model.edges)
diagramStore.getState().setAssessments(model.assessments)
// Render the component
svgRoot.render(
<DiagramStoreContext.Provider value={diagramStore}>
<MetadataStoreContext.Provider value={metadataStore}>
<PopoverStoreContext.Provider value={popoverStore}>
<AssessmentSelectionStoreContext.Provider
value={assessmentSelectionStore}
>
<AlignmentGuidesStoreContext.Provider
value={alignmentGuidesStore}
>
<AppWithProvider onReactFlowInit={setReactFlowInstance} />
</AlignmentGuidesStoreContext.Provider>
</AssessmentSelectionStoreContext.Provider>
</PopoverStoreContext.Provider>
</MetadataStoreContext.Provider>
</DiagramStoreContext.Provider>
)
// Wait for React Flow to initialize
// Create a timeout promise that resolves to undefined after 3 seconds
const timeoutPromise = new Promise<null>((resolve) => {
setTimeout(() => resolve(null), 3000)
})
const reactFlowInstance = await Promise.race([
reactFlowInstancePromise,
timeoutPromise,
])
if (!reactFlowInstance) {
document.body.removeChild(container)
throw new Error("React Flow instance not initialized")
}
// Wait for ReactFlow to fully lay out nodes and measure custom handle
// positions (especially for non-rectangular shapes like parallelograms).
// setTimeout lets ResizeObserver callbacks fire; double-rAF ensures paint.
await new Promise<void>((resolve) => {
setTimeout(() => {
requestAnimationFrame(() => {
requestAnimationFrame(() => resolve())
})
}, 150)
})
const bounds = getDiagramBounds(reactFlowInstance, container)
const margin = 60
const clip = {
x: bounds.x - margin,
y: bounds.y - margin,
width: bounds.width + margin * 2,
height: bounds.height + margin * 2,
}
const svgString = getSVG(container, clip, options)
// Clean up
svgRoot.unmount()
document.body.removeChild(container)
ydoc.destroy()
return {
svg: svgString,
clip,
}
}
/**
* exports current model as svg
* @param options options to change the export behavior (add margin, exclude element ...)
*/
exportAsSVG(options?: Apollon.ExportOptions): Promise<Apollon.SVG> {
return ApollonEditor.exportModelAsSvg(this.model, options)
}
private getNewSubscriptionId(): number {
const subscribers = this.subscribers
// largest key + 1
if (Object.keys(subscribers).length === 0) return 0
return Math.max(...Object.keys(subscribers).map((key) => parseInt(key))) + 1
}
public subscribeToModelChange(
callback: (state: Apollon.UMLModel) => void
): number {
const subscriberId = this.getNewSubscriptionId()
const unsubscribeCallback = this.diagramStore.subscribe(() =>
callback(this.model)
)
this.subscribers[subscriberId] = unsubscribeCallback
return subscriberId
}
public subscribeToDiagramNameChange(
callback: (diagramTitle: string) => void
) {
const subscriberId = this.getNewSubscriptionId()
const unsubscribeCallback = this.metadataStore.subscribe((state) =>
callback(state.diagramTitle)
)
this.subscribers[subscriberId] = unsubscribeCallback
return subscriberId
}
public subscribeToAssessmentSelection(
callback: (selectedElementIds: string[]) => void
) {
const subscriberId = this.getNewSubscriptionId()
const unsubscribeCallback = this.assessmentSelectionStore.subscribe(
(state) => callback(state.selectedElementIds)
)
this.subscribers[subscriberId] = unsubscribeCallback
return subscriberId
}
public unsubscribe(subscriberId: number) {
const unsubscribeCallback = this.subscribers[subscriberId]
if (unsubscribeCallback) {
unsubscribeCallback()
delete this.subscribers[subscriberId]
}
}
public sendBroadcastMessage(sendFn: SendBroadcastMessage) {
this.syncManager.setSendBroadcastMessage(sendFn)
}
public receiveBroadcastedMessage(base64Data: string) {
this.syncManager.handleReceivedData(base64Data)
}
public updateDiagramTitle(name: string) {
this.metadataStore.getState().updateDiagramTitle(name)
}
public getDiagramMetadata() {
const { diagramTitle, diagramType } = this.metadataStore.getState()
return { diagramTitle, diagramType }
}
get model(): Apollon.UMLModel {
const { nodes, edges, diagramId } = this.diagramStore.getState()
const { diagramTitle, diagramType } = this.metadataStore.getState()
return {
id: diagramId,
version: "4.0.0",
title: diagramTitle,
type: diagramType,
nodes: nodes.map((node) => mapFromReactFlowNodeToApollonNode(node)),
edges: edges.map((edge) => mapFromReactFlowEdgeToApollonEdge(edge)),
assessments: this.diagramStore.getState().assessments,
}
}
set model(model: Apollon.UMLModel) {
const { nodes, edges, assessments } = model
this.diagramStore.getState().setNodesAndEdges(nodes, edges)
this.diagramStore.getState().setAssessments(assessments)
this.metadataStore
.getState()
.updateMetaData(model.title, parseDiagramType(model.type))
}
public getSelectedElements(): string[] {
return this.assessmentSelectionStore.getState().selectedElementIds
}
public addOrUpdateAssessment(assessment: Apollon.Assessment): void {
this.diagramStore.getState().addOrUpdateAssessment(assessment)
}
static generateInitialSyncMessage(): string {
const syncMessage = new Uint8Array(new Uint8Array([MessageType.YjsSYNC]))
return YjsSyncClass.uint8ToBase64(syncMessage)
}
}