AI-native design editor. Open-source Figma alternative.
import type { SceneGraph } from '../graph'
import {
isPluginDataEntry,
readPluginData,
withoutPluginData,
withPluginData
} from '../plugin-data/field'
import { OPEN_PENCIL_PLUGIN_DATA } from '../plugin-data/fields'
import type { CommentThread, PluginDataEntry } from '../types'
const { comments } = OPEN_PENCIL_PLUGIN_DATA
/**
* A document's comment threads, deleted ones included. Comments are part of the document: they
* live in OpenPencil's plugin data on the document node, so they travel with the `.fig` file,
* its storage copy and a collaboration room, and Figma or an older OpenPencil open the file as
* before.
*/
export function readComments(graph: SceneGraph): CommentThread[] {
return readPluginData(graph.getNode(graph.rootId)?.pluginData, comments) ?? []
}
/**
* Stores the threads on the document node. This is a document change, so the document asks to
* be saved, but not an undo step: undoing a layer edit never takes back a comment.
*/
export function writeComments(graph: SceneGraph, threads: readonly CommentThread[]): void {
const root = graph.getNode(graph.rootId)
if (!root) return
graph.updateNode(root.id, {
pluginData: withPluginData(
root.pluginData,
comments,
threads.length > 0 ? [...threads] : undefined
)
})
}
/**
* `entries` holding the comments of `live` instead of their own. Undo and redo restore the
* document node with this, so they leave comments as they are now.
*/
export function withLiveComments(
entries: readonly PluginDataEntry[],
live: readonly PluginDataEntry[]
): PluginDataEntry[] {
return [
...withoutPluginData(entries, [comments]),
...live.filter((entry) => isPluginDataEntry(entry, comments))
]
}