-
-
Notifications
You must be signed in to change notification settings - Fork 740
/
actions.ts
474 lines (404 loc) · 11.6 KB
/
actions.ts
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
import {
deprecationWarning,
ERROR_INVALID_NODEID,
ROOT_NODE,
DEPRECATED_ROOT_NODE,
QueryCallbacksFor,
ERROR_NOPARENT,
ERROR_DELETE_TOP_LEVEL_NODE,
CallbacksFor,
Delete,
ERROR_NOT_IN_RESOLVER,
} from '@craftjs/utils';
import invariant from 'tiny-invariant';
import { QueryMethods } from './query';
import {
EditorState,
Indicator,
NodeId,
Node,
Nodes,
Options,
NodeEventTypes,
NodeTree,
SerializedNodes,
NodeSelector,
NodeSelectorType,
} from '../interfaces';
import { fromEntries } from '../utils/fromEntries';
import { getNodesFromSelector } from '../utils/getNodesFromSelector';
import { removeNodeFromEvents } from '../utils/removeNodeFromEvents';
const Methods = (
state: EditorState,
query: QueryCallbacksFor<typeof QueryMethods>
) => {
/** Helper functions */
const addNodeTreeToParent = (
tree: NodeTree,
parentId?: NodeId,
addNodeType?:
| {
type: 'child';
index: number;
}
| {
type: 'linked';
id: string;
}
) => {
const iterateChildren = (id: NodeId, parentId?: NodeId) => {
const node = tree.nodes[id];
if (typeof node.data.type !== 'string') {
invariant(
state.options.resolver[node.data.name],
ERROR_NOT_IN_RESOLVER.replace(
'%node_type%',
`${(node.data.type as any).name}`
)
);
}
state.nodes[id] = {
...node,
data: {
...node.data,
parent: parentId,
},
};
if (node.data.nodes.length > 0) {
delete state.nodes[id].data.props.children;
node.data.nodes.forEach((childNodeId) =>
iterateChildren(childNodeId, node.id)
);
}
Object.values(node.data.linkedNodes).forEach((linkedNodeId) =>
iterateChildren(linkedNodeId, node.id)
);
};
iterateChildren(tree.rootNodeId, parentId);
if (!parentId && tree.rootNodeId === ROOT_NODE) {
return;
}
const parent = getParentAndValidate(parentId);
if (addNodeType.type === 'child') {
const index = addNodeType.index;
if (index != null) {
parent.data.nodes.splice(index, 0, tree.rootNodeId);
} else {
parent.data.nodes.push(tree.rootNodeId);
}
return;
}
parent.data.linkedNodes[addNodeType.id] = tree.rootNodeId;
};
const getParentAndValidate = (parentId: NodeId): Node => {
invariant(parentId, ERROR_NOPARENT);
const parent = state.nodes[parentId];
invariant(parent, ERROR_INVALID_NODEID);
return parent;
};
const deleteNode = (id: NodeId) => {
const targetNode = state.nodes[id],
parentNode = state.nodes[targetNode.data.parent];
if (targetNode.data.nodes) {
// we deep clone here because otherwise immer will mutate the node
// object as we remove nodes
[...targetNode.data.nodes].forEach((childId) => deleteNode(childId));
}
if (targetNode.data.linkedNodes) {
Object.values(targetNode.data.linkedNodes).map((linkedNodeId) =>
deleteNode(linkedNodeId)
);
}
const isChildNode = parentNode.data.nodes.includes(id);
if (isChildNode) {
const parentChildren = parentNode.data.nodes;
parentChildren.splice(parentChildren.indexOf(id), 1);
} else {
const linkedId = Object.keys(parentNode.data.linkedNodes).find(
(id) => parentNode.data.linkedNodes[id] === id
);
if (linkedId) {
delete parentNode.data.linkedNodes[linkedId];
}
}
removeNodeFromEvents(state, id);
delete state.nodes[id];
};
return {
/**
* @private
* Add a new linked Node to the editor.
* Only used internally by the <Element /> component
*
* @param tree
* @param parentId
* @param id
*/
addLinkedNodeFromTree(tree: NodeTree, parentId: NodeId, id: string) {
const parent = getParentAndValidate(parentId);
const existingLinkedNode = parent.data.linkedNodes[id];
if (existingLinkedNode) {
deleteNode(existingLinkedNode);
}
addNodeTreeToParent(tree, parentId, { type: 'linked', id });
},
/**
* Add a new Node to the editor.
*
* @param nodeToAdd
* @param parentId
* @param index
*/
add(nodeToAdd: Node | Node[], parentId?: NodeId, index?: number) {
// TODO: Deprecate adding array of Nodes to keep implementation simpler
let nodes = [nodeToAdd];
if (Array.isArray(nodeToAdd)) {
deprecationWarning('actions.add(node: Node[])', {
suggest: 'actions.add(node: Node)',
});
nodes = nodeToAdd;
}
nodes.forEach((node: Node) => {
addNodeTreeToParent(
{
nodes: {
[node.id]: node,
},
rootNodeId: node.id,
},
parentId,
{ type: 'child', index }
);
});
},
/**
* Add a NodeTree to the editor
*
* @param tree
* @param parentId
* @param index
*/
addNodeTree(tree: NodeTree, parentId?: NodeId, index?: number) {
addNodeTreeToParent(tree, parentId, { type: 'child', index });
},
/**
* Delete a Node
* @param id
*/
delete(selector: NodeSelector<NodeSelectorType.Id>) {
const targets = getNodesFromSelector(state.nodes, selector, {
existOnly: true,
idOnly: true,
});
targets.forEach(({ node }) => {
invariant(
!query.node(node.id).isTopLevelNode(),
ERROR_DELETE_TOP_LEVEL_NODE
);
deleteNode(node.id);
});
},
deserialize(input: SerializedNodes | string) {
const dehydratedNodes =
typeof input == 'string' ? JSON.parse(input) : input;
const nodePairs = Object.keys(dehydratedNodes).map((id) => {
let nodeId = id;
if (id === DEPRECATED_ROOT_NODE) {
nodeId = ROOT_NODE;
}
return [
nodeId,
query
.parseSerializedNode(dehydratedNodes[id])
.toNode((node) => (node.id = nodeId)),
];
});
this.replaceNodes(fromEntries(nodePairs));
},
/**
* Move a target Node to a new Parent at a given index
* @param targetId
* @param newParentId
* @param index
*/
move(selector: NodeSelector, newParentId: NodeId, index: number) {
const targets = getNodesFromSelector(state.nodes, selector, {
existOnly: true,
});
const newParent = state.nodes[newParentId];
const nodesArrToCleanup = new Set<string[]>();
targets.forEach(({ node: targetNode }, i) => {
const targetId = targetNode.id;
const currentParentId = targetNode.data.parent;
query.node(newParentId).isDroppable([targetId], (err) => {
throw new Error(err);
});
// modify node props
state.options.onBeforeMoveEnd(
targetNode,
newParent,
state.nodes[currentParentId]
);
const currentParent = state.nodes[currentParentId];
const currentParentNodes = currentParent.data.nodes;
nodesArrToCleanup.add(currentParentNodes);
const oldIndex = currentParentNodes.indexOf(targetId);
currentParentNodes[oldIndex] = '$$'; // mark for deletion
newParent.data.nodes.splice(index + i, 0, targetId);
state.nodes[targetId].data.parent = newParentId;
});
nodesArrToCleanup.forEach((nodes) => {
const length = nodes.length;
[...nodes].reverse().forEach((value, index) => {
if (value !== '$$') {
return;
}
nodes.splice(length - 1 - index, 1);
});
});
},
replaceNodes(nodes: Nodes) {
this.clearEvents();
state.nodes = nodes;
},
clearEvents() {
this.setNodeEvent('selected', null);
this.setNodeEvent('hovered', null);
this.setNodeEvent('dragged', null);
this.setIndicator(null);
},
/**
* Resets all the editor state.
*/
reset() {
this.clearEvents();
this.replaceNodes({});
},
/**
* Set editor options via a callback function
*
* @param cb: function used to set the options.
*/
setOptions(cb: (options: Partial<Options>) => void) {
cb(state.options);
},
setNodeEvent(
eventType: NodeEventTypes,
nodeIdSelector: NodeSelector<NodeSelectorType.Id>
) {
state.events[eventType].forEach((id) => {
if (state.nodes[id]) {
state.nodes[id].events[eventType] = false;
}
});
state.events[eventType] = new Set();
if (!nodeIdSelector) {
return;
}
const targets = getNodesFromSelector(state.nodes, nodeIdSelector, {
idOnly: true,
existOnly: true,
});
const nodeIds: Set<NodeId> = new Set(targets.map(({ node }) => node.id));
nodeIds.forEach((id) => {
state.nodes[id].events[eventType] = true;
});
state.events[eventType] = nodeIds;
},
/**
* Set custom values to a Node
* @param id
* @param cb
*/
setCustom<T extends NodeId>(
selector: NodeSelector<NodeSelectorType.Id>,
cb: (data: EditorState['nodes'][T]['data']['custom']) => void
) {
const targets = getNodesFromSelector(state.nodes, selector, {
idOnly: true,
existOnly: true,
});
targets.forEach(({ node }) => cb(state.nodes[node.id].data.custom));
},
/**
* Given a `id`, it will set the `dom` porperty of that node.
*
* @param id of the node we want to set
* @param dom
*/
setDOM(id: NodeId, dom: HTMLElement) {
if (!state.nodes[id]) {
return;
}
state.nodes[id].dom = dom;
},
setIndicator(indicator: Indicator | null) {
if (
indicator &&
(!indicator.placement.parent.dom ||
(indicator.placement.currentNode &&
!indicator.placement.currentNode.dom))
)
return;
state.indicator = indicator;
},
/**
* Hide a Node
* @param id
* @param bool
*/
setHidden(id: NodeId, bool: boolean) {
state.nodes[id].data.hidden = bool;
},
/**
* Update the props of a Node
* @param id
* @param cb
*/
setProp(
selector: NodeSelector<NodeSelectorType.Id>,
cb: (props: any) => void
) {
const targets = getNodesFromSelector(state.nodes, selector, {
idOnly: true,
existOnly: true,
});
targets.forEach(({ node }) => cb(state.nodes[node.id].data.props));
},
selectNode(nodeIdSelector?: NodeSelector<NodeSelectorType.Id>) {
if (nodeIdSelector) {
const targets = getNodesFromSelector(state.nodes, nodeIdSelector, {
idOnly: true,
existOnly: true,
});
this.setNodeEvent(
'selected',
targets.map(({ node }) => node.id)
);
} else {
this.setNodeEvent('selected', null);
}
this.setNodeEvent('hovered', null);
},
};
};
export const ActionMethods = (
state: EditorState,
query: QueryCallbacksFor<typeof QueryMethods>
) => {
return {
...Methods(state, query),
// Note: Beware: advanced method! You most likely don't need to use this
// TODO: fix parameter types and cleanup the method
setState(
cb: (
state: EditorState,
actions: Delete<CallbacksFor<typeof Methods>, 'history'>
) => void
) {
const { history, ...actions } = this;
// We pass the other actions as the second parameter, so that devs could still make use of the predefined actions
cb(state, actions);
},
};
};