AI-native design editor. Open-source Figma alternative.
import { SIZE_FIELDS, TRANSFORM_FIELDS } from '../fields/geometry'
import type { SceneNode } from '../types'
/** The layout results a format keeps apart from what it saved once an edit moves or sizes. */
const EDITED_GEOMETRY_FIELDS: ReadonlySet<keyof SceneNode> = new Set([
...TRANSFORM_FIELDS,
...SIZE_FIELDS
])
interface LayerWrites {
before: Partial<SceneNode>
changed: Set<keyof SceneNode>
/** Geometry an edit's layout wrote, rather than layout of what the document already holds. */
edited: Set<keyof SceneNode>
}
/**
* What one layout run writes to each layer: the values before its first write, and the keys it
* actually changed. Layout passes can size a layer and size it back, such as a frame laid out on
* its own and then by its parent, so a key that changed and came back is left out of the update.
*/
export class LayoutWrites {
private readonly layers = new Map<string, LayerWrites>()
/** Call before `changes` are applied to `node`; `edit` when an edit's layout writes them. */
record(node: SceneNode, changes: Partial<SceneNode>, edit: boolean): void {
let layer = this.layers.get(node.id)
if (!layer) {
layer = { before: {}, changed: new Set(), edited: new Set() }
this.layers.set(node.id, layer)
}
for (const key of Object.keys(changes) as (keyof SceneNode)[]) {
if (!Object.hasOwn(layer.before, key)) Object.assign(layer.before, { [key]: node[key] })
if (!Object.is(node[key], changes[key])) layer.changed.add(key)
if (edit && EDITED_GEOMETRY_FIELDS.has(key)) layer.edited.add(key)
}
}
/**
* Each written layer's update: the values layout changed and kept, and values it wrote as they
* already were, which a preview's commit writes to publish what it showed. With it come the
* geometry fields of that update an edit's layout wrote, which count as edited.
*/
*updates(
getNode: (id: string) => SceneNode | undefined
): Generator<[SceneNode, Partial<SceneNode>, (keyof SceneNode)[]]> {
for (const [id, { before, changed, edited }] of this.layers) {
const node = getNode(id)
if (!node) continue
const changes: Partial<SceneNode> = {}
for (const key of Object.keys(before) as (keyof SceneNode)[]) {
if (changed.has(key) && Object.is(node[key], before[key])) continue
Object.assign(changes, { [key]: node[key] })
}
const keys = Object.keys(changes) as (keyof SceneNode)[]
if (keys.length > 0) yield [node, changes, keys.filter((key) => edited.has(key))]
}
}
}