Files
docmost/packages/editor-ext/src/lib/transclusion/transclusion-source.ts
T
Philip Okugbe de60aa7e61 feat: synced blocks (transclusion) (#2163)
* feat: synced blocks (transclusion)

* fix:remove name

* make placeholders smaller

* feat: enforce strict transclusion schema

* fix: scope synced blocks to workspace, gate unsync on edit permission

* fix collab module error
2026-05-08 13:23:16 +01:00

135 lines
3.4 KiB
TypeScript

import { mergeAttributes, Node } from "@tiptap/core";
import { ReactNodeViewRenderer } from "@tiptap/react";
import { TRANSCLUSION_SOURCE_CONTENT_EXPRESSION } from "./constants";
export interface TransclusionSourceOptions {
HTMLAttributes: Record<string, any>;
view: any;
}
export interface TransclusionSourceAttributes {
id?: string | null;
}
declare module "@tiptap/core" {
interface Commands<ReturnType> {
transclusionSource: {
insertTransclusionSource: (
attributes?: TransclusionSourceAttributes,
) => ReturnType;
toggleTransclusionSource: () => ReturnType;
unsyncTransclusionSource: () => ReturnType;
};
}
}
export const TransclusionSource = Node.create<TransclusionSourceOptions>({
name: "transclusionSource",
addOptions() {
return {
HTMLAttributes: {},
view: null,
};
},
group: "block",
// Schema-enforced allow-list. Excludes `transclusionSource` (no nesting)
content: TRANSCLUSION_SOURCE_CONTENT_EXPRESSION,
defining: true,
isolating: true,
addAttributes() {
return {
id: {
default: null,
parseHTML: (el) => el.getAttribute("data-id"),
renderHTML: (attrs) =>
attrs.id ? { "data-id": attrs.id } : {},
},
};
},
parseHTML() {
return [{ tag: `div[data-type="${this.name}"]` }];
},
renderHTML({ HTMLAttributes }) {
return [
"div",
mergeAttributes(
{ "data-type": this.name },
this.options.HTMLAttributes,
HTMLAttributes,
),
0,
];
},
addCommands() {
return {
insertTransclusionSource:
(attributes) =>
({ commands, state, chain }) => {
const { $from } = state.selection;
for (let depth = $from.depth; depth > 0; depth -= 1) {
if ($from.node(depth).type.name === this.name) return false;
}
const node = {
type: this.name,
attrs: attributes ?? {},
content: [{ type: "paragraph" }],
};
const parent = $from.parent;
const isEmptyParagraph =
parent.type.name === "paragraph" && parent.content.size === 0;
if (isEmptyParagraph) {
return chain()
.insertContentAt(
{ from: $from.before(), to: $from.after() },
node,
)
.run();
}
return commands.insertContent(node);
},
toggleTransclusionSource:
() =>
({ commands }) =>
commands.toggleWrap(this.name),
unsyncTransclusionSource:
() =>
({ state, tr, dispatch }) => {
const { $from } = state.selection;
// Walk up to the nearest source wrapper.
let depth = $from.depth;
while (depth > 0 && $from.node(depth).type.name !== this.name) {
depth -= 1;
}
if (depth === 0) return false;
const node = $from.node(depth);
const start = $from.before(depth);
const end = start + node.nodeSize;
if (dispatch) {
tr.replaceWith(start, end, node.content);
dispatch(tr);
}
return true;
},
};
},
addNodeView() {
if (!this.options.view) return null;
// Force the react node view to render immediately using flush sync
this.editor.isInitialized = true;
return ReactNodeViewRenderer(this.options.view);
},
});