@stll/folio-core 0.0.1-placeholder.0 → 0.1.0

package/dist/prosemirror/commands/pastePlainText.js

@@ -0,0 +1,67 @@
+import { Fragment, Slice } from "prosemirror-model";
+//#region src/prosemirror/commands/pastePlainText.ts
+/**
+* Paste without formatting
+*
+* Inserts clipboard text as unformatted paragraphs, dropping every source mark
+* (bold, colour, font, links) so the pasted text takes on the destination
+* paragraph's own style. This is the "paste without formatting" escape hatch,
+* distinct from the default rich paste that preserves source formatting.
+*/
+const PARAGRAPH_BREAK = /(?:\r\n?|\n)+/;
+/**
+* Dispatched on the editor view DOM when the clipboard read behind a
+* "paste without formatting" keystroke fails (e.g. clipboard-read permission
+* denied). The command owns no UI, so the host shell listens for this bubbling
+* event and decides how to surface it (toast, telemetry, or no-op) rather than
+* the keystroke silently doing nothing.
+*/
+const CLIPBOARD_READ_ERROR_EVENT = "folio:clipboard-read-error";
+/**
+* Build a mark-free slice from plain text, one paragraph per run of newlines.
+*
+* Pure and DOM-free so it is unit-testable and reusable from both the keymap
+* command and the context menu. The slice is opened at both ends
+* ({@link Slice.maxOpen}) so its first and last paragraphs merge into the
+* surrounding block on {@link Transaction.replaceSelection}, matching how the
+* editor's default text paste flows into the current line.
+*/
+function buildPlainTextSlice(text, schema) {
+	const paragraphType = schema.nodes["paragraph"];
+	if (!paragraphType) return text ? new Slice(Fragment.from(schema.text(text)), 0, 0) : Slice.empty;
+	const paragraphs = text.split(PARAGRAPH_BREAK).map((block) => paragraphType.create(null, block ? schema.text(block) : null));
+	return Slice.maxOpen(Fragment.fromArray(paragraphs));
+}
+/**
+* Read the clipboard and insert it as unformatted text at the current selection.
+*
+* Dry-runnable per the ProseMirror command convention: applicability does not
+* depend on the (asynchronously read) clipboard contents, so the command is
+* "available" whenever the runtime exposes a clipboard reader. A probe with no
+* `dispatch` (menus/toolbars) returns `true` without touching the clipboard or
+* the document. Only when `dispatch` is provided does it read the clipboard and
+* insert; it then returns `true` (claiming the key) so the browser's own
+* "paste without formatting" shortcut does not also fire. A failed read (denied
+* permission, unsupported) is surfaced to the host via a
+* {@link CLIPBOARD_READ_ERROR_EVENT} on the view DOM so the keystroke is never a
+* silent no-op.
+*/
+const pasteWithoutFormatting = (state, dispatch, view) => {
+	if (typeof navigator === "undefined" || !navigator.clipboard?.readText) return false;
+	if (!dispatch) return true;
+	if (!view) return false;
+	const { schema } = state;
+	navigator.clipboard.readText().then((text) => {
+		if (!text || view.isDestroyed) return;
+		const slice = buildPlainTextSlice(text, schema);
+		view.dispatch(view.state.tr.replaceSelection(slice).scrollIntoView());
+	}).catch((error) => {
+		if (typeof CustomEvent === "function" && !view.isDestroyed) view.dom.dispatchEvent(new CustomEvent(CLIPBOARD_READ_ERROR_EVENT, {
+			detail: { error },
+			bubbles: true
+		}));
+	});
+	return true;
+};
+//#endregion
+export { CLIPBOARD_READ_ERROR_EVENT, buildPlainTextSlice, pasteWithoutFormatting };

package/dist/prosemirror/commands/table.d.ts

@@ -0,0 +1,83 @@
+import { BorderPreset, TableBorderPreset, TableContextInfo, getTableContext, isInTable as isInTableCell } from "../extensions/nodes/TableExtension.js";
+import { EditorState, Transaction } from "prosemirror-state";
+
+//#region src/prosemirror/commands/table.d.ts
+declare function insertTable(rows: number, cols: number): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function addRowAbove(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function addRowBelow(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function deleteRow(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function addColumnLeft(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function addColumnRight(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function deleteColumn(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function deleteTable(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function selectTable(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function selectRow(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function selectColumn(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function mergeCells(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function splitCell(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function setCellBorder(side: "top" | "bottom" | "left" | "right" | "all", spec: {
+  style: string;
+  size?: number;
+  color?: {
+    rgb: string;
+  };
+} | null, clearOthers?: boolean): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setTableBorderPreset(preset: TableBorderPreset): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setTableBorders(preset: BorderPreset, borderSpec?: {
+  style: string;
+  size: number;
+  color: {
+    rgb: string;
+  };
+}): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function removeTableBorders(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+declare function setAllTableBorders(state: EditorState, dispatch?: (tr: Transaction) => void, borderSpec?: {
+  style: string;
+  size: number;
+  color: {
+    rgb: string;
+  };
+}): boolean;
+declare function setOutsideTableBorders(state: EditorState, dispatch?: (tr: Transaction) => void, borderSpec?: {
+  style: string;
+  size: number;
+  color: {
+    rgb: string;
+  };
+}): boolean;
+declare function setInsideTableBorders(state: EditorState, dispatch?: (tr: Transaction) => void, borderSpec?: {
+  style: string;
+  size: number;
+  color: {
+    rgb: string;
+  };
+}): boolean;
+declare function setCellVerticalAlign(align: "top" | "center" | "bottom"): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setCellMargins(margins: {
+  top?: number;
+  bottom?: number;
+  left?: number;
+  right?: number;
+}): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setCellTextDirection(direction: string | null): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function toggleNoWrap(): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setRowHeight(height: number | null, rule?: "auto" | "atLeast" | "exact"): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function toggleHeaderRow(): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function distributeColumns(): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function autoFitContents(): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setTableProperties(props: {
+  width?: number | null;
+  widthType?: string | null;
+  justification?: "left" | "center" | "right" | null;
+}): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function applyTableStyle(styleData: {
+  styleId: string;
+  tableBorders?: Record<string, unknown>;
+  conditionals?: Record<string, unknown>;
+  look?: Record<string, boolean>;
+}): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setCellFillColor(color: string | null): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setTableBorderColor(color: string): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+declare function setTableBorderWidth(size: number): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+//#endregion
+export { type BorderPreset, type TableBorderPreset, type TableContextInfo, addColumnLeft, addColumnRight, addRowAbove, addRowBelow, applyTableStyle, autoFitContents, deleteColumn, deleteRow, deleteTable, distributeColumns, getTableContext, insertTable, isInTableCell as isInTable, mergeCells, removeTableBorders, selectColumn, selectRow, selectTable, setAllTableBorders, setCellBorder, setCellFillColor, setCellMargins, setCellTextDirection, setCellVerticalAlign, setInsideTableBorders, setOutsideTableBorders, setRowHeight, setTableBorderColor, setTableBorderPreset, setTableBorderWidth, setTableBorders, setTableProperties, splitCell, toggleHeaderRow, toggleNoWrap };

package/dist/prosemirror/commands/table.js

@@ -0,0 +1,105 @@
+import { getTableContext, isInTable as isInTableCell } from "../extensions/nodes/TableExtension.js";
+import { singletonManager } from "../schema/index.js";
+//#region src/prosemirror/commands/table.ts
+const cmds = singletonManager.getCommands();
+function insertTable(rows, cols) {
+	return cmds["insertTable"](rows, cols);
+}
+function addRowAbove(state, dispatch) {
+	return cmds["addRowAbove"]()(state, dispatch);
+}
+function addRowBelow(state, dispatch) {
+	return cmds["addRowBelow"]()(state, dispatch);
+}
+function deleteRow(state, dispatch) {
+	return cmds["deleteRow"]()(state, dispatch);
+}
+function addColumnLeft(state, dispatch) {
+	return cmds["addColumnLeft"]()(state, dispatch);
+}
+function addColumnRight(state, dispatch) {
+	return cmds["addColumnRight"]()(state, dispatch);
+}
+function deleteColumn(state, dispatch) {
+	return cmds["deleteColumn"]()(state, dispatch);
+}
+function deleteTable(state, dispatch) {
+	return cmds["deleteTable"]()(state, dispatch);
+}
+function selectTable(state, dispatch) {
+	return cmds["selectTable"]()(state, dispatch);
+}
+function selectRow(state, dispatch) {
+	return cmds["selectRow"]()(state, dispatch);
+}
+function selectColumn(state, dispatch) {
+	return cmds["selectColumn"]()(state, dispatch);
+}
+function mergeCells(state, dispatch) {
+	return cmds["mergeCells"]()(state, dispatch);
+}
+function splitCell(state, dispatch) {
+	return cmds["splitCell"]()(state, dispatch);
+}
+function setCellBorder(side, spec, clearOthers) {
+	return cmds["setCellBorder"](side, spec, clearOthers);
+}
+function setTableBorderPreset(preset) {
+	return cmds["setTableBorderPreset"](preset);
+}
+function setTableBorders(preset, borderSpec) {
+	return cmds["setTableBorders"](preset, borderSpec);
+}
+function removeTableBorders(state, dispatch) {
+	return cmds["removeTableBorders"]()(state, dispatch);
+}
+function setAllTableBorders(state, dispatch, borderSpec) {
+	return cmds["setAllTableBorders"](borderSpec)(state, dispatch);
+}
+function setOutsideTableBorders(state, dispatch, borderSpec) {
+	return cmds["setOutsideTableBorders"](borderSpec)(state, dispatch);
+}
+function setInsideTableBorders(state, dispatch, borderSpec) {
+	return cmds["setInsideTableBorders"](borderSpec)(state, dispatch);
+}
+function setCellVerticalAlign(align) {
+	return cmds["setCellVerticalAlign"](align);
+}
+function setCellMargins(margins) {
+	return cmds["setCellMargins"](margins);
+}
+function setCellTextDirection(direction) {
+	return cmds["setCellTextDirection"](direction);
+}
+function toggleNoWrap() {
+	return cmds["toggleNoWrap"]();
+}
+function setRowHeight(height, rule) {
+	return cmds["setRowHeight"](height, rule);
+}
+function toggleHeaderRow() {
+	return cmds["toggleHeaderRow"]();
+}
+function distributeColumns() {
+	return cmds["distributeColumns"]();
+}
+function autoFitContents() {
+	return cmds["autoFitContents"]();
+}
+function setTableProperties(props) {
+	return cmds["setTableProperties"](props);
+}
+function applyTableStyle(styleData) {
+	return cmds["applyTableStyle"](styleData);
+}
+function setCellFillColor(color) {
+	return cmds["setCellFillColor"](color);
+}
+function setTableBorderColor(color) {
+	return cmds["setTableBorderColor"](color);
+}
+function setTableBorderWidth(size) {
+	return cmds["setTableBorderWidth"](size);
+}
+//#endregion
+export { addColumnLeft, addColumnRight, addRowAbove, addRowBelow, applyTableStyle, autoFitContents, deleteColumn, deleteRow, deleteTable, distributeColumns, getTableContext, insertTable, isInTableCell as isInTable, mergeCells, removeTableBorders, selectColumn, selectRow, selectTable, setAllTableBorders, setCellBorder, setCellFillColor, setCellMargins, setCellTextDirection, setCellVerticalAlign, setInsideTableBorders, setOutsideTableBorders, setRowHeight, setTableBorderColor, setTableBorderPreset, setTableBorderWidth, setTableBorders, setTableProperties, splitCell, toggleHeaderRow, toggleNoWrap };

package/dist/prosemirror/conversion/fromProseDoc.d.ts

@@ -0,0 +1,27 @@
+import { document_d_exports } from "../../types/document.js";
+import { Mark, Node } from "prosemirror-model";
+
+//#region src/prosemirror/conversion/fromProseDoc.d.ts
+/**
+ * Convert a ProseMirror document to our Document type
+ */
+declare function fromProseDoc(pmDoc: Node, baseDocument?: document_d_exports.Document): document_d_exports.Document;
+/**
+ * Convert ProseMirror marks to TextFormatting
+ */
+declare function marksToTextFormatting(marks: readonly Mark[]): document_d_exports.TextFormatting;
+/**
+ * Update a Document with content from a ProseMirror document
+ * Preserves all non-content parts of the original document
+ */
+declare function updateDocumentContent(originalDocument: document_d_exports.Document, pmDoc: Node): document_d_exports.Document;
+/**
+ * Convert a ProseMirror document back to an array of `BlockContent` blocks
+ * (paragraphs, tables, and block-level content controls).
+ *
+ * Used for converting edited header/footer PM content back to the document
+ * model.
+ */
+declare function proseDocToBlocks(pmDoc: Node): document_d_exports.BlockContent[];
+//#endregion
+export { fromProseDoc, marksToTextFormatting, proseDocToBlocks, updateDocumentContent };