@stll/folio-core 0.45.0 → 0.47.0

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

@@ -1,4 +1,4 @@
-import { EmptyFieldResultMode, ProseDocToBlocksOptions, fromProseDoc, proseDocToBlocks, updateDocumentContent } from "./fromProseDoc.js";
+import { FromProseDocOptions, ProjectionReuse, fromProseDoc, proseDocToBlocks, updateDocumentContent } from "./fromProseDoc.js";
 import { ToProseDocOptions, createEmptyDoc, headerFooterToProseDoc, toProseDoc } from "./toProseDoc.js";
 import { ProseMirrorDocumentValidationIssue, ValidateProseMirrorDocumentResult, assertValidProseMirrorDocument, formatProseMirrorDocumentIssues, validateProseMirrorDocument } from "../validation.js";
-export { type EmptyFieldResultMode, type ProseDocToBlocksOptions, type ProseMirrorDocumentValidationIssue, type ToProseDocOptions, type ValidateProseMirrorDocumentResult, assertValidProseMirrorDocument, createEmptyDoc, formatProseMirrorDocumentIssues, fromProseDoc, headerFooterToProseDoc, proseDocToBlocks, toProseDoc, updateDocumentContent, validateProseMirrorDocument };
+export { type FromProseDocOptions, type ProjectionReuse, type ProseMirrorDocumentValidationIssue, type ToProseDocOptions, type ValidateProseMirrorDocumentResult, assertValidProseMirrorDocument, createEmptyDoc, formatProseMirrorDocumentIssues, fromProseDoc, headerFooterToProseDoc, proseDocToBlocks, toProseDoc, updateDocumentContent, validateProseMirrorDocument };

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

@@ -0,0 +1,39 @@
+import { document_d_exports } from "../../types/document.js";
+//#region src/prosemirror/conversion/preservedSinkCarriers.d.ts
+/**
+ * `Record_` when it declares `preserved`, `never` when it does not.
+ *
+ * A record without the field still satisfies `{ preserved?: PreservedMarkup }`,
+ * so `Extract` would match everything. Inference tells the two apart: a record
+ * that has no such field infers `unknown`, and one that does infers the sink's
+ * own type.
+ */
+type DeclaresSink<Record_> = Record_ extends {
+  preserved?: infer Sink;
+} ? [unknown] extends [Sink] ? never : Record_ : never;
+/**
+ * Every block-level record whose model holds an ordered verbatim sink.
+ *
+ * The universe is the whole block spine the editor walks — blocks, rows and
+ * cells — so a sink added anywhere along it joins the union rather than
+ * slipping past a hand-listed pair.
+ */
+type SinkBearingBlock = DeclaresSink<document_d_exports.BlockContent | document_d_exports.TableRow | document_d_exports.TableCell>;
+/**
+ * The editor carries a sink on the node's own attrs, by reference.
+ *
+ * Reference identity is what tells an authored record from a copy the editor
+ * made, exactly as it does for the attribute remainder: two records that each
+ * parsed their own children hold different arrays however equal their
+ * contents, so the sink can follow the record it was authored on and no other.
+ */
+declare const SINK_ON_NODE_ATTRS = "carried-on-node-attrs";
+/** How the editor carries each sink-bearing record's markup. */
+declare const PRESERVED_SINK_CARRIERS: {
+  readonly table: "carried-on-node-attrs";
+  readonly tableRow: "carried-on-node-attrs";
+};
+/** A sink worth carrying: an empty record is never written. */
+declare const hasSinkChildren: (preserved: document_d_exports.PreservedMarkup | undefined) => preserved is document_d_exports.PreservedMarkup;
+//#endregion
+export { PRESERVED_SINK_CARRIERS, SINK_ON_NODE_ATTRS, SinkBearingBlock, hasSinkChildren };

package/dist/prosemirror/conversion/preservedSinkCarriers.js

@@ -0,0 +1,19 @@
+//#region src/prosemirror/conversion/preservedSinkCarriers.ts
+/**
+* The editor carries a sink on the node's own attrs, by reference.
+*
+* Reference identity is what tells an authored record from a copy the editor
+* made, exactly as it does for the attribute remainder: two records that each
+* parsed their own children hold different arrays however equal their
+* contents, so the sink can follow the record it was authored on and no other.
+*/
+const SINK_ON_NODE_ATTRS = "carried-on-node-attrs";
+/** How the editor carries each sink-bearing record's markup. */
+const PRESERVED_SINK_CARRIERS = {
+	table: SINK_ON_NODE_ATTRS,
+	tableRow: SINK_ON_NODE_ATTRS
+};
+/** A sink worth carrying: an empty record is never written. */
+const hasSinkChildren = (preserved) => preserved !== void 0 && (preserved.children?.length ?? 0) > 0;
+//#endregion
+export { PRESERVED_SINK_CARRIERS, SINK_ON_NODE_ATTRS, hasSinkChildren };

package/dist/prosemirror/conversion/runShadingMark.js

@@ -1,5 +1,17 @@
+import { knownThemeColor } from "@stll/docx-core/model";
 //#region src/prosemirror/conversion/runShadingMark.ts
 /**
+* Converters between the model's run-level shading (`ShadingProperties`, from
+* `w:shd`) and the `runShading` ProseMirror mark's attrs. The mark carries the
+* shading FILL flattened as a ColorValue (mirroring the textColor mark) plus a
+* non-default pattern, so a custom run background survives the PM round-trip
+* (it was previously dropped on import) and re-serializes to `w:shd`.
+*
+* eigenpal #722 (#712) — folio models highlight as a strict OOXML named-palette
+* union, so arbitrary run backgrounds (Word/Google Docs `w:shd` fills) cannot be
+* represented as a highlight here; they round-trip as this dedicated mark.
+*/
+/**
 * Build the mark attrs for a run shading, or null when the shading has no
 * renderable/round-trippable fill (theme-less, `auto`, or fill-less). The
 * default `clear` pattern is the no-op carrier for a solid fill and is dropped:
@@ -13,7 +25,8 @@ function shadingToRunShadingAttrs(shading) {
 	if (!fill || fill.auto || !fill.rgb && !fill.themeColor) return null;
 	const attrs = {};
 	if (fill.rgb) attrs.rgb = fill.rgb;
-	if (fill.themeColor) attrs.themeColor = fill.themeColor;
+	const themeColor = fill.themeColor && knownThemeColor(fill.themeColor);
+	if (themeColor) attrs.themeColor = themeColor;
 	if (fill.themeTint) attrs.themeTint = fill.themeTint;
 	if (fill.themeShade) attrs.themeShade = fill.themeShade;
 	if (!isSolid && shading.pattern && shading.pattern !== "clear") {

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

@@ -1,9 +1,18 @@
 import { document_d_exports } from "../../types/document.js";
 import { SdtAttrs } from "../schema/nodes.js";
 //#region src/prosemirror/conversion/sdtAttrs.d.ts
+/**
+ * A three-state toggle carried on a `data-` attribute.
+ *
+ * The attribute is written only when the control states the toggle, so an
+ * absent one is `null` — undecided — rather than an off. `=== "true"` alone
+ * would answer a two-state question and fold the two together, which is what
+ * the `w:showingPlcHdr` and `w:checked` round trips need to keep apart.
+ */
+declare const onOffFromDataset: (raw: string | undefined) => boolean | null;
 declare const sdtAttrsFromProperties: (properties: document_d_exports.SdtProperties) => SdtAttrs;
 declare const sdtPropertiesFromAttrs: (attrs: SdtAttrs) => document_d_exports.SdtProperties;
 declare const sdtPropertiesMatchAttrs: (properties: document_d_exports.SdtProperties, attrs: SdtAttrs) => boolean;
 declare const decodeSdtListItems: (rawItems: string) => NonNullable<document_d_exports.SdtProperties["listItems"]>;
 //#endregion
-export { decodeSdtListItems, sdtAttrsFromProperties, sdtPropertiesFromAttrs, sdtPropertiesMatchAttrs };
+export { decodeSdtListItems, onOffFromDataset, sdtAttrsFromProperties, sdtPropertiesFromAttrs, sdtPropertiesMatchAttrs };

package/dist/prosemirror/conversion/sdtAttrs.js

@@ -1,4 +1,16 @@
 //#region src/prosemirror/conversion/sdtAttrs.ts
+/**
+* A three-state toggle carried on a `data-` attribute.
+*
+* The attribute is written only when the control states the toggle, so an
+* absent one is `null` — undecided — rather than an off. `=== "true"` alone
+* would answer a two-state question and fold the two together, which is what
+* the `w:showingPlcHdr` and `w:checked` round trips need to keep apart.
+*/
+const onOffFromDataset = (raw) => {
+	if (raw === "true") return true;
+	return raw === "false" ? false : null;
+};
 const sdtAttrsFromProperties = (properties) => ({
 	sdtType: properties.sdtType,
 	...properties.alias !== void 0 ? { alias: properties.alias } : {},
@@ -6,14 +18,15 @@ const sdtAttrsFromProperties = (properties) => ({
 	...properties.id !== void 0 ? { id: properties.id } : {},
 	...properties.lock !== void 0 ? { lock: properties.lock } : {},
 	...properties.placeholder !== void 0 ? { placeholder: properties.placeholder } : {},
-	showingPlaceholder: properties.showingPlaceholder ?? false,
+	...properties.showingPlaceholder !== void 0 ? { showingPlaceholder: properties.showingPlaceholder } : {},
 	...properties.dateFormat !== void 0 ? { dateFormat: properties.dateFormat } : {},
 	...properties.dateValueISO !== void 0 ? { dateValueISO: properties.dateValueISO } : {},
 	...properties.listItems !== void 0 ? { listItems: JSON.stringify(properties.listItems) } : {},
 	...properties.dropdownLastValue !== void 0 ? { dropdownLastValue: properties.dropdownLastValue } : {},
 	...properties.checked !== void 0 ? { checked: properties.checked } : {},
-	...properties.rawPropertiesXml !== void 0 ? { rawPropertiesXml: properties.rawPropertiesXml } : {},
-	...properties.rawEndPropertiesXml !== void 0 ? { rawEndPropertiesXml: properties.rawEndPropertiesXml } : {}
+	...properties.preserved !== void 0 ? { _preserved: properties.preserved } : {},
+	...properties.rawEndPropertiesXml !== void 0 ? { rawEndPropertiesXml: properties.rawEndPropertiesXml } : {},
+	...properties.endProperties !== void 0 ? { endProperties: properties.endProperties } : {}
 });
 const sdtPropertiesFromAttrs = (attrs) => {
 	const properties = { sdtType: attrs.sdtType };
@@ -28,8 +41,9 @@ const sdtPropertiesFromAttrs = (attrs) => {
 	if (attrs.listItems) properties.listItems = decodeSdtListItems(attrs.listItems);
 	if (typeof attrs.dropdownLastValue === "string") properties.dropdownLastValue = attrs.dropdownLastValue;
 	if (typeof attrs.checked === "boolean") properties.checked = attrs.checked;
-	if (attrs.rawPropertiesXml) properties.rawPropertiesXml = attrs.rawPropertiesXml;
+	if (attrs._preserved) properties.preserved = attrs._preserved;
 	if (attrs.rawEndPropertiesXml) properties.rawEndPropertiesXml = attrs.rawEndPropertiesXml;
+	if (attrs.endProperties) properties.endProperties = attrs.endProperties;
 	return properties;
 };
 const sdtPropertiesMatchAttrs = (properties, attrs) => JSON.stringify(sdtAttrsFromProperties(properties)) === JSON.stringify(sdtAttrsFromProperties(sdtPropertiesFromAttrs(attrs)));
@@ -51,4 +65,4 @@ const decodeSdtListItems = (rawItems) => {
 	});
 };
 //#endregion
-export { decodeSdtListItems, sdtAttrsFromProperties, sdtPropertiesFromAttrs, sdtPropertiesMatchAttrs };
+export { decodeSdtListItems, onOffFromDataset, sdtAttrsFromProperties, sdtPropertiesFromAttrs, sdtPropertiesMatchAttrs };

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

@@ -1,16 +1,9 @@
 import { document_d_exports } from "../../types/document.js";
 import { StyleEngine } from "../../style-engine/styleEngine.js";
 import "../../style-engine/index.js";
+import { ParseContext } from "../../docx/parseContext.js";
 import { Node } from "prosemirror-model";
 //#region src/prosemirror/conversion/toProseDoc.d.ts
-type UnsupportedDocxToProseMirrorOwner = "complex-field-instruction" | "field-result" | "page-break-bearing-run" | "paragraph-borders" | "paragraph-frame" | "paragraph-outline" | "paragraph-text-box-anchor" | "table-cell" | "text-box";
-declare const UnsupportedDocxToProseMirrorConversionError_base: import("better-result").TaggedErrorClass<"UnsupportedDocxToProseMirrorConversionError">;
-/** DOCX content that cannot be preserved by the editable ProseMirror model. */
-declare class UnsupportedDocxToProseMirrorConversionError extends UnsupportedDocxToProseMirrorConversionError_base<{
-  message: string;
-  owner: UnsupportedDocxToProseMirrorOwner;
-  contentType: document_d_exports.RunContent["type"];
-}> {}
 /**
  * Options for document conversion
  */
@@ -19,6 +12,11 @@ type ToProseDocOptions = {
   styles?: document_d_exports.StyleDefinitions;
   /** Theme used when converting themed table/cell values in nested content. */
   theme?: document_d_exports.Theme | null;
+  /**
+   * Where a projection approximation is reported, on the channel the parsers
+   * already use. Absent means nobody is listening, not that nothing happened.
+   */
+  warn?: ParseContext["warn"];
 };
 /**
  * Convert a Document to a ProseMirror document
@@ -53,4 +51,4 @@ declare function footnoteToProseDoc(content: document_d_exports.BlockContent[],
  */
 declare function createEmptyDoc(): Node;
 //#endregion
-export { ToProseDocOptions, UnsupportedDocxToProseMirrorConversionError, createEmptyDoc, footnoteToProseDoc, headerFooterToProseDoc, resolveParagraphDefaultTextFormatting, standaloneTableCellToProseMirror, toProseDoc };
+export { ToProseDocOptions, createEmptyDoc, footnoteToProseDoc, headerFooterToProseDoc, resolveParagraphDefaultTextFormatting, standaloneTableCellToProseMirror, toProseDoc };