@stll/folio-core 0.62.0 → 0.63.1

package/dist/prosemirror/commentReferenceIntegrity.js

@@ -1,4 +1,75 @@
+import { readCommentRangeBoundaryAttrs } from "./commentRangeBoundaryAttrs.js";
+import { isCommentRangeInertAtom } from "./commentRangeInlineAtoms.js";
+import { readCommentReferenceAttrs } from "./commentReferenceAttrs.js";
+import "./extensions/nodes/CommentRangeBoundaryExtension.js";
+import "./extensions/nodes/RangeAnchorExtension.js";
+import { readRangeAnchorAttrs } from "./rangeAnchorAttrs.js";
+import { panic } from "better-result";
+import { Transform } from "prosemirror-transform";
 //#region src/prosemirror/commentReferenceIntegrity.ts
+const COMMENT_REFERENCE_NODE_NAME = "commentReference";
+const surveyCommentReferences = (doc) => {
+	const references = [];
+	const markEnds = /* @__PURE__ */ new Map();
+	const unanchoredMarks = [];
+	doc.descendants((node, position) => {
+		const inert = isCommentRangeInertAtom(node);
+		if (inert) {
+			for (const mark of node.marks) if (mark.type.name === "comment") unanchoredMarks.push({
+				position,
+				size: node.nodeSize,
+				mark
+			});
+		}
+		if (node.type.name === "commentReference") {
+			const attrs = readCommentReferenceAttrs(node);
+			references.push(attrs.ok ? {
+				status: "valid",
+				commentId: attrs.value.commentId,
+				position,
+				size: node.nodeSize
+			} : {
+				status: "malformed",
+				position,
+				size: node.nodeSize
+			});
+			return false;
+		}
+		if (node.type.name === "rangeAnchor") {
+			const attrs = readRangeAnchorAttrs(node);
+			if (attrs.ok && attrs.value.start.type === "commentRangeStart") {
+				const { id } = attrs.value.start;
+				markEnds.set(id, Math.max(markEnds.get(id) ?? 0, position + node.nodeSize));
+			}
+			return false;
+		}
+		if (node.type.name === "commentRangeBoundary") {
+			const attrs = readCommentRangeBoundaryAttrs(node);
+			if (attrs.ok) {
+				const { id } = attrs.value.marker;
+				markEnds.set(id, Math.max(markEnds.get(id) ?? 0, position + node.nodeSize));
+			}
+			return false;
+		}
+		if (inert) return false;
+		if (!node.isInline) return true;
+		for (const mark of node.marks) {
+			if (mark.type.name !== "comment") continue;
+			const commentId = mark.attrs["commentId"];
+			if (typeof commentId !== "number") continue;
+			markEnds.set(commentId, Math.max(markEnds.get(commentId) ?? 0, position + node.nodeSize));
+		}
+		return true;
+	});
+	return {
+		references,
+		unanchoredMarks,
+		markExtents: [...markEnds].map(([commentId, end]) => ({
+			commentId,
+			end
+		}))
+	};
+};
 /**
 * The repairs that make a document total, as positions in the document they
 * were read from. Deletions come first, last-first, so they apply in sequence
@@ -47,5 +118,26 @@ const planCommentReferenceRepairs = ({ references, markExtents }) => {
 	}
 	return [...deletions.toSorted((first, second) => second.position - first.position), ...insertions.toSorted((first, second) => second.position - first.position)];
 };
+const resolveCommentReferences = (doc) => {
+	const survey = surveyCommentReferences(doc);
+	const repairs = planCommentReferenceRepairs(survey);
+	if (repairs.length === 0 && survey.unanchoredMarks.length === 0) return null;
+	const transform = new Transform(doc);
+	for (const { position, size, mark } of survey.unanchoredMarks) transform.removeMark(position, position + size, mark);
+	const referenceType = doc.type.schema.nodes[COMMENT_REFERENCE_NODE_NAME];
+	for (const repair of repairs) {
+		if (repair.type === "delete") {
+			transform.delete(repair.position, repair.position + repair.size);
+			continue;
+		}
+		if (!referenceType) return panic("Comment reference repairs require a commentReference node.");
+		transform.insert(transform.mapping.map(repair.position), referenceType.create({ commentId: repair.commentId }));
+	}
+	return {
+		doc: transform.doc,
+		steps: transform.steps,
+		positionMaps: transform.mapping.maps
+	};
+};
 //#endregion
-export { planCommentReferenceRepairs };
+export { COMMENT_REFERENCE_NODE_NAME, planCommentReferenceRepairs, resolveCommentReferences };

package/dist/prosemirror/containerFinalParagraph.d.ts

@@ -16,7 +16,7 @@ import { Node, ResolvedPos } from "prosemirror-model";
  * sibling, so the paragraph does not end anything and carries its own mark
  * like any other.
  */
-declare const paragraphEndsItsContainer: (at: ResolvedPos, paragraphTypeName: string) => boolean;
+export declare const paragraphEndsItsContainer: (at: ResolvedPos, paragraphTypeName: string) => boolean;
 /**
  * Every paragraph a container ENDS with in `doc`, with its position.
  *
@@ -24,7 +24,7 @@ declare const paragraphEndsItsContainer: (at: ResolvedPos, paragraphTypeName: st
  * turn costs a scan of its siblings each time, which is quadratic in a body
  * whose paragraphs a batch has just filled.
  */
-declare const finalParagraphsOf: (doc: Node, paragraphTypeName: string) => {
+export declare const finalParagraphsOf: (doc: Node, paragraphTypeName: string) => {
   position: number;
   node: Node;
 }[];
@@ -45,9 +45,9 @@ type AddedBreakCarrierBeforeOptions = {
  * paragraph whose mark the rotation must not overwrite, or a container whose
  * every paragraph is new.
  */
-declare const addedBreakCarrierBefore: ({ at, paragraphTypeName, canCrossTable }: AddedBreakCarrierBeforeOptions) => {
+export declare const addedBreakCarrierBefore: ({ at, paragraphTypeName, canCrossTable }: AddedBreakCarrierBeforeOptions) => {
   position: number;
   node: Node;
 } | null;
 //#endregion
-export { addedBreakCarrierBefore, finalParagraphsOf, paragraphEndsItsContainer };
+export {};

package/dist/prosemirror/contentControlRevisions.d.ts

@@ -1,11 +1,11 @@
 import { MarkType, Node } from "prosemirror-model";
 import { Transaction } from "prosemirror-state";
 //#region src/prosemirror/contentControlRevisions.d.ts
-declare const ENCLOSING_REVISION_IDS_ATTR = "_docxEnclosingRevisionIds";
+export declare const ENCLOSING_REVISION_IDS_ATTR = "_docxEnclosingRevisionIds";
 /** The revisions whose element encloses `control`. */
-declare const enclosingRevisionIds: (control: Node) => readonly number[];
+export declare const enclosingRevisionIds: (control: Node) => readonly number[];
 /** `control`'s attrs with `revisionId` added to its enclosing revisions. */
-declare const withEnclosingRevision: (control: Node, revisionId: number) => Node["attrs"] | null;
+export declare const withEnclosingRevision: (control: Node, revisionId: number) => Node["attrs"] | null;
 type ResolutionRemovesControlOptions = {
   control: Node;
   /** The revision mark type the resolution removes content under. */
@@ -18,13 +18,13 @@ type ResolutionRemovesControlOptions = {
  * resolved in the direction that removes its content, and still covers all of
  * it. Removing only the content leaves the control standing, emptied.
  */
-declare const resolutionRemovesControl: ({ control, removeType, resolves }: ResolutionRemovesControlOptions) => boolean;
+export declare const resolutionRemovesControl: ({ control, removeType, resolves }: ResolutionRemovesControlOptions) => boolean;
 /**
  * `control`'s attrs without the enclosing revisions `resolved` names, or
  * `null` when none of them is: a resolved revision no longer exists, and an id
  * left behind would claim whatever revision is later given that id.
  */
-declare const withoutResolvedEnclosures: (control: Node, resolved: (revisionId: number) => boolean) => Node["attrs"] | null;
+export declare const withoutResolvedEnclosures: (control: Node, resolved: (revisionId: number) => boolean) => Node["attrs"] | null;
 type EncloseWholeControlsOptions = {
   tr: Transaction;
   from: number;
@@ -38,6 +38,6 @@ type EncloseWholeControlsOptions = {
  * the range covers only the content of is left alone, and its revision stays
  * one over that content.
  */
-declare const encloseWholeControls: ({ tr, from, to, revisionId }: EncloseWholeControlsOptions) => void;
+export declare const encloseWholeControls: ({ tr, from, to, revisionId }: EncloseWholeControlsOptions) => void;
 //#endregion
-export { ENCLOSING_REVISION_IDS_ATTR, encloseWholeControls, enclosingRevisionIds, resolutionRemovesControl, withEnclosingRevision, withoutResolvedEnclosures };
+export {};

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

@@ -1,6 +1,6 @@
 import { document_d_exports } from "../../types/document.js";
 //#region src/prosemirror/conversion/effectiveTableCellFormatting.d.ts
-type TableCellMarginsAttrs = {
+export type TableCellMarginsAttrs = {
   top?: number;
   bottom?: number;
   left?: number;
@@ -28,7 +28,7 @@ type EffectiveTableCellFormatting = Readonly<{
   borders: document_d_exports.TableCellBorders | undefined;
   margins: TableCellMarginsAttrs | undefined;
 }>;
-type TableCellPosition = {
+export type TableCellPosition = {
   isFirstRow?: boolean;
   isLastRow?: boolean;
   isFirstColumn?: boolean;
@@ -48,6 +48,6 @@ type ResolveEffectiveTableCellFormattingOptions = {
  * OOXML formatting. Source discriminators keep inherited values distinct from
  * direct values that the editor may later override.
  */
-declare const resolveEffectiveTableCellFormatting: ({ directFormatting, styleFormatting, tableBorders, position, gridWidthPercent, defaultMargins, theme }: ResolveEffectiveTableCellFormattingOptions) => EffectiveTableCellFormatting;
+export declare const resolveEffectiveTableCellFormatting: ({ directFormatting, styleFormatting, tableBorders, position, gridWidthPercent, defaultMargins, theme }: ResolveEffectiveTableCellFormattingOptions) => EffectiveTableCellFormatting;
 //#endregion
-export { TableCellMarginsAttrs, TableCellPosition, resolveEffectiveTableCellFormatting };
+export {};

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

@@ -13,9 +13,9 @@ import { Node } from "prosemirror-model";
  * merge does, and it panics until it is implemented. An accepted-but-inert
  * value would let a caller believe it had asked for a merge and get a rebuild.
  */
-type ProjectionReuse = "none" | "matched";
+export type ProjectionReuse = "none" | "matched";
 /** How the conversion treats records the editor did not change. */
-type FromProseDocOptions = {
+export type FromProseDocOptions = {
   /**
    * The stylesheet authority used to construct the projection. With a parsed package,
    * package source uses its captured definitions; edits to live package.styles do not
@@ -35,19 +35,19 @@ type FromProseDocOptions = {
   reuse?: ProjectionReuse;
 };
 /** Convert a ProseMirror document to the document model. */
-declare function fromProseDoc(pmDoc: Node, baseDocument: document_d_exports.Document | undefined, { stylesheetSource, reuse }: FromProseDocOptions): document_d_exports.Document;
-declare function tableAttrsToFormatting(attrs: TableAttrs): document_d_exports.TableFormatting | undefined;
+export declare function fromProseDoc(pmDoc: Node, baseDocument: document_d_exports.Document | undefined, { stylesheetSource, reuse }: FromProseDocOptions): document_d_exports.Document;
+export declare function tableAttrsToFormatting(attrs: TableAttrs): document_d_exports.TableFormatting | undefined;
 /**
  * Convert ProseMirror table row attrs to TableRowFormatting
  */
-declare function tableRowAttrsToFormatting(attrs: TableRowAttrs): document_d_exports.TableRowFormatting | undefined;
-declare const standaloneTableCellFromProseMirror: (node: Node) => document_d_exports.TableCell;
-declare function tableCellAttrsToFormatting(attrs: TableCellAttrs): document_d_exports.TableCellFormatting | undefined;
+export declare function tableRowAttrsToFormatting(attrs: TableRowAttrs): document_d_exports.TableRowFormatting | undefined;
+export declare const standaloneTableCellFromProseMirror: (node: Node) => document_d_exports.TableCell;
+export declare function tableCellAttrsToFormatting(attrs: TableCellAttrs): document_d_exports.TableCellFormatting | undefined;
 /**
  * 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;
+export 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).
@@ -55,6 +55,6 @@ declare function updateDocumentContent(originalDocument: document_d_exports.Docu
  * Used for converting edited header/footer PM content back to the document
  * model.
  */
-declare function proseDocToBlocks(pmDoc: Node, baseContent?: document_d_exports.BlockContent[], styles?: NonNullable<document_d_exports.Document["package"]>["styles"]): document_d_exports.BlockContent[];
+export declare function proseDocToBlocks(pmDoc: Node, baseContent?: document_d_exports.BlockContent[], styles?: NonNullable<document_d_exports.Document["package"]>["styles"]): document_d_exports.BlockContent[];
 //#endregion
-export { FromProseDocOptions, ProjectionReuse, fromProseDoc, marksToTextFormatting, proseDocToBlocks, standaloneTableCellFromProseMirror, tableAttrsToFormatting, tableCellAttrsToFormatting, tableRowAttrsToFormatting, updateDocumentContent };
+export { marksToTextFormatting };