@stll/folio-core 0.33.0 → 0.33.2

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

@@ -1,4 +1,5 @@
 import { document_d_exports } from "../../types/document.js";
+import { TableAttrs, TableCellAttrs, TableRowAttrs } from "../schema/nodes.js";
 import { Mark, Node } from "prosemirror-model";
 //#region src/prosemirror/conversion/fromProseDoc.d.ts
 /**
@@ -12,7 +13,13 @@ type MarksToTextFormattingOptions = {
   inheritedFormatting: document_d_exports.TextFormatting | undefined;
 };
 declare function marksToTextFormatting(marks: readonly Mark[], options?: MarksToTextFormattingOptions): document_d_exports.TextFormatting;
+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;
 /**
  * Update a Document with content from a ProseMirror document
  * Preserves all non-content parts of the original document
@@ -27,4 +34,4 @@ declare function updateDocumentContent(originalDocument: document_d_exports.Docu
  */
 declare function proseDocToBlocks(pmDoc: Node): document_d_exports.BlockContent[];
 //#endregion
-export { fromProseDoc, marksToTextFormatting, proseDocToBlocks, standaloneTableCellFromProseMirror, updateDocumentContent };
+export { fromProseDoc, marksToTextFormatting, proseDocToBlocks, standaloneTableCellFromProseMirror, tableAttrsToFormatting, tableCellAttrsToFormatting, tableRowAttrsToFormatting, updateDocumentContent };

package/dist/prosemirror/conversion/fromProseDoc.js

@@ -1,6 +1,7 @@
 import { numPrEqual } from "../../docx/numberingParser.js";
 import { ShapeOutlineStyleSchema, narrowEnum } from "../../docx/parserEnums.js";
 import { OUTLINE_STYLE_CSS_ALIASES, normalizeShapeTextAnchor } from "../../types/documentEnumValues.js";
+import { canonicalJson } from "../../utils/canonicalJson.js";
 import { normalizeHorizontalScalePercent } from "../../utils/horizontalScale.js";
 import { pixelsToEmu } from "../../utils/units.js";
 import { expectBlockSdtAttrs, expectCharacterSpacingMarkAttrs, expectCharacterStyleMarkAttrs, expectCommentMarkAttrs, expectEmphasisMarkAttrs, expectFieldAttrs, expectFontFamilyMarkAttrs, expectFontSizeMarkAttrs, expectFootnoteRefMarkAttrs, expectHardBreakAttrs, expectHighlightMarkAttrs, expectHyperlinkMarkAttrs, expectImageAttrs, expectLanguageMarkAttrs, expectMathAttrs, expectParagraphAttrs, expectRunFormattingOverrideMarkAttrs, expectRunPropertyChangeMarkAttrs, expectRunShadingMarkAttrs, expectSdtAttrs, expectShapeAttrs, expectStrikeMarkAttrs, expectSymbolAttrs, expectTabAttrs, expectTableAttrs, expectTableCellAttrs, expectTableRowAttrs, expectTextBoxAttrs, expectTextColorMarkAttrs, expectTextEffectMarkAttrs, expectTrackedChangeMarkAttrs, expectUnderlineMarkAttrs } from "../attrs/index.js";
@@ -1801,6 +1802,16 @@ function buildCellMarginsFromAttrs(m) {
 /**
 * Convert ProseMirror table attrs to TableFormatting
 */
+/**
+* Whether a live attr still holds what the style cascade resolved to.
+*
+* `toProseDoc` seeds an attr with the EFFECTIVE value — a border a table
+* style supplied, a margin a table declared — because that is what the editor
+* renders with. A save must write only what the node itself states, or the
+* inherited value becomes a direct override that outranks the style it came
+* from on reload. The resolved companion is what tells the two apart.
+*/
+const sameResolvedValue = (live, resolved) => resolved !== void 0 && resolved !== null && canonicalJson(live) === canonicalJson(resolved);
 function tableAttrsToFormatting(attrs) {
 	if (attrs._originalFormatting) {
 		const orig = attrs._originalFormatting;
@@ -1824,7 +1835,7 @@ function tableAttrsToFormatting(attrs) {
 			type: tableWidthType ?? "dxa"
 		};
 		else delete result.width;
-		if (attrs.cellMargins) result.cellMargins = buildCellMarginsFromAttrs(attrs.cellMargins);
+		if (attrs.cellMargins && !sameResolvedValue(attrs.cellMargins, attrs._resolvedCellMargins)) result.cellMargins = buildCellMarginsFromAttrs(attrs.cellMargins);
 		return result;
 	}
 	const tableWidth = attrs.width;
@@ -2022,8 +2033,8 @@ function tableCellAttrsToFormatting(attrs) {
 		if (attrs.verticalAlign !== (orig.verticalAlign ?? void 0)) if (attrs.verticalAlign) result.verticalAlign = attrs.verticalAlign;
 		else delete result.verticalAlign;
 		if (backgroundChanged) result.shading = cellShadingFromAttrs(attrs);
-		if (attrs.borders) result.borders = attrs.borders;
-		if (attrs.margins) result.margins = buildCellMarginsFromAttrs(attrs.margins);
+		if (attrs.borders && !sameResolvedValue(attrs.borders, attrs._resolvedBorders)) result.borders = attrs.borders;
+		if (attrs.margins && !sameResolvedValue(attrs.margins, attrs._resolvedMargins)) result.margins = buildCellMarginsFromAttrs(attrs.margins);
 		if (attrs.textDirection !== (orig.textDirection ?? void 0)) if (attrs.textDirection) result.textDirection = attrs.textDirection;
 		else delete result.textDirection;
 		return result;
@@ -2154,4 +2165,4 @@ function proseDocToBlocks(pmDoc) {
 	return extractBlocks(pmDoc);
 }
 //#endregion
-export { fromProseDoc, marksToTextFormatting, proseDocToBlocks, standaloneTableCellFromProseMirror, updateDocumentContent };
+export { fromProseDoc, marksToTextFormatting, proseDocToBlocks, standaloneTableCellFromProseMirror, tableAttrsToFormatting, tableCellAttrsToFormatting, tableRowAttrsToFormatting, updateDocumentContent };

package/dist/prosemirror/conversion/toProseDoc.js

@@ -850,7 +850,10 @@ function convertTable(table, styleResolver, context) {
 	if (table.formatting?.justification) attrs.justification = table.formatting.justification;
 	if (columnWidths) attrs.columnWidths = columnWidths;
 	if (table.formatting?.floating) attrs.floating = table.formatting.floating;
-	if (cellMarginsAttr) attrs.cellMargins = cellMarginsAttr;
+	if (cellMarginsAttr) {
+		attrs.cellMargins = cellMarginsAttr;
+		attrs._resolvedCellMargins = cellMarginsAttr;
+	}
 	if (table.formatting?.look) attrs.look = table.formatting.look;
 	if (table.formatting?.borders) attrs.borders = table.formatting.borders;
 	if (resolvedTableIndent) attrs._resolvedIndent = resolvedTableIndent;
@@ -1059,8 +1062,14 @@ function convertTableCell({ cell, styleResolver, context, isHeader, gridWidthPer
 	if (formatting?.noWrap !== void 0) attrs.noWrap = formatting.noWrap;
 	const hideMark = formatting?.hideMark ?? conditionalStyle?.tcPr?.hideMark;
 	if (hideMark !== void 0) attrs.hideMark = hideMark;
-	if (effectiveFormatting.borders) attrs.borders = effectiveFormatting.borders;
-	if (effectiveFormatting.margins) attrs.margins = effectiveFormatting.margins;
+	if (effectiveFormatting.borders) {
+		attrs.borders = effectiveFormatting.borders;
+		attrs._resolvedBorders = effectiveFormatting.borders;
+	}
+	if (effectiveFormatting.margins) {
+		attrs.margins = effectiveFormatting.margins;
+		attrs._resolvedMargins = effectiveFormatting.margins;
+	}
 	if (formatting) attrs._originalFormatting = formatting;
 	if (cell.propertyChanges && cell.propertyChanges.length > 0) attrs.tcPrChange = [...cell.propertyChanges];
 	if (cell.structuralChange?.type === "tableCellInsertion") attrs.cellMarker = {

package/dist/prosemirror/extensions/nodes/TableExtension.js

@@ -151,6 +151,7 @@ const tableSpec = {
 		columnWidths: { default: null },
 		floating: { default: null },
 		cellMargins: { default: null },
+		_resolvedCellMargins: { default: null },
 		look: { default: null },
 		borders: { default: null },
 		_resolvedIndent: { default: null },
@@ -319,7 +320,9 @@ const tableCellSpec = {
 		backgroundColor: { default: null },
 		_resolvedBackgroundColor: { default: null },
 		borders: { default: null },
+		_resolvedBorders: { default: null },
 		margins: { default: null },
+		_resolvedMargins: { default: null },
 		textDirection: { default: null },
 		noWrap: { default: false },
 		hideMark: { default: false },
@@ -375,7 +378,9 @@ const tableHeaderSpec = {
 		backgroundColor: { default: null },
 		_resolvedBackgroundColor: { default: null },
 		borders: { default: null },
+		_resolvedBorders: { default: null },
 		margins: { default: null },
+		_resolvedMargins: { default: null },
 		textDirection: { default: null },
 		noWrap: { default: false },
 		hideMark: { default: false },

package/dist/prosemirror/schema/marks.d.ts

@@ -1,5 +1,5 @@
-import { document_d_exports } from "../../types/document.js";
 import { ShadingProperties } from "../../types/colors.js";
+import { document_d_exports } from "../../types/document.js";
 //#region src/prosemirror/schema/marks.d.ts
 /**
  * Text color mark attributes

package/dist/prosemirror/schema/nodes.d.ts

@@ -569,6 +569,13 @@ type TableAttrs = {
   look?: document_d_exports.TableLook;
   /** Table-level borders (w:tblBorders) — full BorderSpec per side */
   borders?: document_d_exports.TableBorders;
+  /**
+   * Effective default cell margins after the table-style cascade. PM-only;
+   * never serialized. What `cellMargins` resolves to when the table declares
+   * none of its own, so a save can tell a value a style supplied from one the
+   * table states — and stop writing the style's into the table's `w:tblPr`.
+   */
+  _resolvedCellMargins?: TableAttrs["cellMargins"];
   /** Effective table indent after style resolution. PM-only; never serialized. */
   _resolvedIndent?: NonNullable<document_d_exports.TableFormatting["indent"]>;
   /** Style-derived table justification fallback. PM-only; never serialized. */
@@ -677,6 +684,14 @@ type TableCellAttrs = {
   hideMark?: boolean;
   /** Cell borders — full BorderSpec per side (style, color, size) */
   borders?: document_d_exports.TableCellBorders;
+  /**
+   * Effective borders after the table and table-style cascade. PM-only; never
+   * serialized. The companion to `borders` that `_resolvedBackgroundColor` is
+   * to `backgroundColor`: what the cell renders with when it declares none of
+   * its own, so a save can tell a border a style supplied from one the cell
+   * states.
+   */
+  _resolvedBorders?: document_d_exports.TableCellBorders;
   /** Cell margins/padding in twips per side */
   margins?: {
     top?: number;
@@ -684,6 +699,13 @@ type TableCellAttrs = {
     left?: number;
     right?: number;
   };
+  /** Effective margins after the cascade. PM-only; never serialized. */
+  _resolvedMargins?: {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+  };
   /** Original cell formatting from DOCX for lossless round-trip serialization */
   _originalFormatting?: document_d_exports.TableCellFormatting;
   /** Tracked cell property changes (w:tcPrChange) for round-trip + accept/reject */

package/dist/server.d.ts

@@ -1,8 +1,8 @@
 import { FolioAIBlock, FolioAIBlockAnchor, FolioAIBlockKind, FolioAIBlockPreviewRun, FolioAIComment, FolioAIEditApplyMode, FolioAIEditApplyResult, FolioAIEditNormalization, FolioAIEditNormalizationCode, FolioAIEditOperation, FolioAIEditPrecondition, FolioAIEditSnapshot, FolioAIInlineFormatting, FolioAITextRangeHandle, FolioDocumentNavigationTarget, FolioDocumentOutline, FolioDocumentOutlineEntry, FolioDocumentSection, FolioDocumentSectionHandle, FolioDocumentSectionReadResult } from "./ai-edits/types.js";
 import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocumentOperation, FolioDocumentOperationAffectedTarget, FolioDocumentOperationBatch, FolioDocumentOperationBatchPrecondition, FolioDocumentOperationCapabilities, FolioDocumentOperationIssue, FolioDocumentOperationMode, FolioDocumentOperationPrecondition, FolioDocumentOperationQueuedOperation, FolioDocumentOperationReceipt, FolioDocumentOperationRecovery, FolioDocumentOperationResult, FolioDocumentOperationResultBase, FolioDocumentOperationStatus, FolioDocumentOperationStory, FolioDocumentOperationType, FolioDocumentOperationUndoFailureReason, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "./document-operations.js";
 import { FolioReviewChange, FolioReviewChangeKind } from "./ai-edits/read.js";
-import { ApplyFolioAIEditsToBufferOptions, ApplyFolioAIEditsToBufferResult, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioApplyDocumentOperationsOptions, FolioApplyDocumentOperationsToStoryOptions, FolioApplyOperationsOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioDocxReviewer, FolioDocxReviewerOptions, FolioEditableDocumentStoryHandle, FolioReadReviewedStoryOptions, FolioResolveReviewedStoryOptions, FolioResolvedReviewedView, FolioReviewChangeFilter, FolioReviewComment, FolioReviewCommentFilter, FolioReviewCommentReply, FolioReviewReplyInput, FolioReviewedStory, FolioReviewedView, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, isFolioResolvedReviewedView, isFolioReviewedView } from "./ai-edits/headless.js";
 import { createFolioAITextRangeHandle, hashFolioAIBlockText, isFolioAIContentBlock, normalizeFolioAIBlockText } from "./ai-edits/snapshot.js";
+import { ApplyFolioAIEditsToBufferOptions, ApplyFolioAIEditsToBufferResult, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioApplyDocumentOperationsOptions, FolioApplyDocumentOperationsToStoryOptions, FolioApplyOperationsOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioDocxReviewer, FolioDocxReviewerOptions, FolioEditableDocumentStoryHandle, FolioReadReviewedStoryOptions, FolioResolveReviewedStoryOptions, FolioResolvedReviewedView, FolioReviewChangeFilter, FolioReviewComment, FolioReviewCommentFilter, FolioReviewCommentReply, FolioReviewReplyInput, FolioReviewedStory, FolioReviewedView, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, isFolioResolvedReviewedView, isFolioReviewedView } from "./ai-edits/headless.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./ai-edits/scoped-reading.js";
 import { DeriveBlockIdInput, FolioBlockId, deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DocumentPreset, DocumentStyleSet } from "./style-sets/types.js";

package/dist/types/block-id.d.ts

@@ -61,6 +61,17 @@ declare const isBlankFolioBlockId: (id: string) => boolean;
  * without an upfront brand check.
  */
 declare const getFolioParaIdFromBlockId: (id: string) => string | null;
+/**
+ * The id a block recorded earlier answers to in the document as parsed now.
+ *
+ * A paragraph id above the 31-bit bound the schema sets is brought into range
+ * on parse, so an id recorded from such a paragraph before that no longer
+ * names it. The mapping is a pure function of the id alone, so the recorded id
+ * resolves to the current one with no document in hand. Sequential and blank
+ * ids carry no paragraph id, and an id the parser would not have mapped is
+ * returned as it is.
+ */
+declare const currentFolioBlockId: (id: string) => string;
 /**
  * The 1-based document position encoded in a sequential fallback id
  * (`seq-0011` -> 11), or `null` for paraId-backed ids. The number is
@@ -76,4 +87,4 @@ declare const getSequentialFolioBlockIdIndex: (id: string) => number | null;
  */
 declare const isFolioBlockId: (value: unknown) => value is FolioBlockId;
 //#endregion
-export { DeriveBlockIdInput, FolioBlockId, deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId };
+export { DeriveBlockIdInput, FolioBlockId, currentFolioBlockId, deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId };

package/dist/types/block-id.js

@@ -1,3 +1,5 @@
+import { paraIdInRange } from "../docx/paraIdRangeNormalization.js";
+import { isValidHexId } from "../utils/hexId.js";
 //#region src/types/block-id.ts
 /**
 * Single source of truth for folio block ids.
@@ -91,6 +93,20 @@ const isBlankFolioBlockId = (id) => BLANK_BLOCK_ID_PATTERN.test(id);
 */
 const getFolioParaIdFromBlockId = (id) => isSequentialFolioBlockId(id) || isBlankFolioBlockId(id) ? null : id;
 /**
+* The id a block recorded earlier answers to in the document as parsed now.
+*
+* A paragraph id above the 31-bit bound the schema sets is brought into range
+* on parse, so an id recorded from such a paragraph before that no longer
+* names it. The mapping is a pure function of the id alone, so the recorded id
+* resolves to the current one with no document in hand. Sequential and blank
+* ids carry no paragraph id, and an id the parser would not have mapped is
+* returned as it is.
+*/
+const currentFolioBlockId = (id) => {
+	const paraId = getFolioParaIdFromBlockId(id);
+	return paraId !== null && isValidHexId(paraId) ? paraIdInRange(paraId) : id;
+};
+/**
 * The 1-based document position encoded in a sequential fallback id
 * (`seq-0011` -> 11), or `null` for paraId-backed ids. The number is
 * the block's position in the same non-empty-block walk both the
@@ -114,4 +130,4 @@ const isFolioBlockId = (value) => {
 	return true;
 };
 //#endregion
-export { deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId };
+export { currentFolioBlockId, deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId };

package/dist/utils/canonicalJson.d.ts

@@ -0,0 +1,14 @@
+//#region src/utils/canonicalJson.d.ts
+/**
+ * JSON with object keys in a fixed order, for comparing two values that were
+ * built by different code paths.
+ *
+ * `JSON.stringify` writes keys in insertion order, so two objects holding the
+ * same properties compare unequal whenever one was assembled in a different
+ * sequence — which is what happens whenever a parsed record is compared with a
+ * rebuilt one. `undefined` members are omitted, so an absent property and one
+ * explicitly set to `undefined` read alike.
+ */
+declare const canonicalJson: (value: unknown) => string;
+//#endregion
+export { canonicalJson };

package/dist/utils/canonicalJson.js

@@ -0,0 +1,19 @@
+//#region src/utils/canonicalJson.ts
+/**
+* JSON with object keys in a fixed order, for comparing two values that were
+* built by different code paths.
+*
+* `JSON.stringify` writes keys in insertion order, so two objects holding the
+* same properties compare unequal whenever one was assembled in a different
+* sequence — which is what happens whenever a parsed record is compared with a
+* rebuilt one. `undefined` members are omitted, so an absent property and one
+* explicitly set to `undefined` read alike.
+*/
+const canonicalJson = (value) => {
+	if (value === null || value === void 0) return "null";
+	if (Array.isArray(value)) return `[${value.map(canonicalJson).join(",")}]`;
+	if (typeof value !== "object") return JSON.stringify(value) ?? "null";
+	return `{${Object.entries(value).filter(([, entry]) => entry !== void 0).toSorted(([left], [right]) => left.localeCompare(right)).map(([key, entry]) => `${JSON.stringify(key)}:${canonicalJson(entry)}`).join(",")}}`;
+};
+//#endregion
+export { canonicalJson };

package/dist/utils/formatToStyle.d.ts

@@ -1,5 +1,5 @@
-import { document_d_exports } from "../types/document.js";
 import { ColorValue } from "../types/colors.js";
+import { document_d_exports } from "../types/document.js";
 import { Properties } from "csstype";
 //#region src/utils/formatToStyle.d.ts
 type CSSProperties = Properties<string | number>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stll/folio-core",
-  "version": "0.33.0",
+  "version": "0.33.2",
   "description": "Headless, framework-neutral core of folio: the OOXML (.docx) parser, document model, ProseMirror integration, and page-layout engine. No React.",
   "keywords": [
     "document-model",
@@ -115,7 +115,7 @@
     "perf": "bun scripts/profile-editor.ts"
   },
   "dependencies": {
-    "@stll/docx-core": "^0.19.0",
+    "@stll/docx-core": "^0.19.1",
     "@stll/docx-utils": "^0.1.0",
     "@stll/template-conditions": "^0.1.0",
     "better-result": "3.0.1",