@stll/folio-core 0.6.1 → 0.8.0

package/dist/controller/layoutPipeline.js

@@ -19,6 +19,42 @@ import { tryBuildIncrementalMeasures } from "../paged-layout/incrementalMeasure.
 import { computePerBlockMeasureInputs } from "../paged-layout/sectionBlockWidths.js";
 import { getDocumentWatermark } from "../watermark/index.js";
 //#region src/controller/layoutPipeline.ts
+function bodyMarginsClearHeaderFooter({ authoredMargins, preparedHeader, preparedFooter }) {
+	const headerBottom = preparedHeader ? (authoredMargins.header ?? 0) + (preparedHeader.marginPushBottom ?? preparedHeader.height) : authoredMargins.top;
+	const footerClearance = preparedFooter ? (authoredMargins.footer ?? 0) + (preparedFooter.marginPushBottom ?? preparedFooter.height) : authoredMargins.bottom;
+	const top = Math.max(authoredMargins.top, headerBottom);
+	const bottom = Math.max(authoredMargins.bottom, footerClearance);
+	if (top === authoredMargins.top && bottom === authoredMargins.bottom) return authoredMargins;
+	return {
+		...authoredMargins,
+		top,
+		bottom
+	};
+}
+function bodyBlocksClearSectionHeaderFooter(blocks, { authoredMargins, sectionHeaderFooterRefs, headerContentByRId, footerContentByRId }) {
+	if (!sectionHeaderFooterRefs || !headerContentByRId && !footerContentByRId) return blocks;
+	let sectionIndex = 0;
+	let currentAuthoredMargins = authoredMargins;
+	let changed = false;
+	const nextBlocks = blocks.map((block) => {
+		if (block.kind !== "sectionBreak") return block;
+		currentAuthoredMargins = block.margins ?? currentAuthoredMargins;
+		const refs = sectionHeaderFooterRefs[sectionIndex];
+		sectionIndex += 1;
+		const effectiveMargins = bodyMarginsClearHeaderFooter({
+			authoredMargins: currentAuthoredMargins,
+			preparedHeader: refs?.headerDefault ? headerContentByRId?.get(refs.headerDefault) : void 0,
+			preparedFooter: refs?.footerDefault ? footerContentByRId?.get(refs.footerDefault) : void 0
+		});
+		if (effectiveMargins === currentAuthoredMargins && block.margins === currentAuthoredMargins) return block;
+		changed = true;
+		return {
+			...block,
+			margins: effectiveMargins
+		};
+	});
+	return changed ? nextBlocks : blocks;
+}
 function runLayoutPipeline(deps, state, options = {}) {
 	const { contentWidth, columns, pageSize, margins, pageGap, syncCoordinator, headerContent, footerContent, firstPageHeaderContent, firstPageFooterContent, headerContentRId, footerContentRId, firstPageHeaderContentRId, firstPageFooterContentRId, sectionHeaderFooterRefs, theme: _theme, sectionProperties, document, defaultTabStop, mirrorMargins, styles, layout, hfPMs, painter, pagesContainer, session, renderHfFromContentOrPm, renderHeaderFooterContentByRId, documentFontsAreLoaded, buildFootnoteRenderItems, describeInvalidHighlightMarks, emptyTemplatePreviewEntries: EMPTY_TEMPLATE_PREVIEW_ENTRIES } = deps;
 	let outcome = {};
@@ -92,17 +128,51 @@ function runLayoutPipeline(deps, state, options = {}) {
 		let firstPageFooterForRender = hasTitlePg ? renderHfFromContentOrPm(firstPageFooterContent, firstPageFooterContentRId, hfPMs, contentWidth, hfMetricsFooter, hfOptions) : void 0;
 		let headerContentByRId = renderHeaderFooterContentByRId(document?.package.headers, hfPMs, contentWidth, hfMetricsHeader, hfOptions);
 		let footerContentByRId = renderHeaderFooterContentByRId(document?.package.footers, hfPMs, contentWidth, hfMetricsFooter, hfOptions);
+		const sectionPropertiesForMargins = document?.package.document.sections?.map((section) => section.properties) ?? (sectionProperties ? [sectionProperties] : []);
+		const sectionEvenPageMargins = sectionHeaderFooterRefs?.map((refs, index) => {
+			if (refs.evenAndOddHeaders !== true) return;
+			const properties = sectionPropertiesForMargins[index];
+			return bodyMarginsClearHeaderFooter({
+				authoredMargins: properties ? getMargins(properties) : margins,
+				preparedHeader: refs.headerEven ? headerContentByRId?.get(refs.headerEven) : void 0,
+				preparedFooter: refs.footerEven ? footerContentByRId?.get(refs.footerEven) : void 0
+			});
+		});
+		newBlocks = bodyBlocksClearSectionHeaderFooter(newBlocks, {
+			authoredMargins: margins,
+			sectionHeaderFooterRefs,
+			headerContentByRId,
+			footerContentByRId
+		});
+		outcome.blocks = newBlocks;
+		const initialBodyMargins = bodyMarginsClearHeaderFooter({
+			authoredMargins: margins,
+			preparedHeader: headerContentForRender,
+			preparedFooter: footerContentForRender
+		});
 		recordPhaseDuration("header-footer", phaseStartedAt);
 		phaseStartedAt = performance.now();
 		const bodyLayoutConfig = {
 			pageSize,
-			margins
+			margins: initialBodyMargins
 		};
 		if (columns !== void 0) bodyLayoutConfig.columns = columns;
 		const finalSectionProperties = document?.package.document.sections?.at(-1)?.properties;
+		const finalHeaderRId = sectionHeaderFooterRefs?.at(-1)?.headerDefault;
+		let finalHeaderForLayout = headerContentForRender;
+		if (finalHeaderRId) finalHeaderForLayout = headerContentByRId?.get(finalHeaderRId);
+		else if (sectionHeaderFooterRefs !== void 0) finalHeaderForLayout = void 0;
+		const finalFooterRId = sectionHeaderFooterRefs?.at(-1)?.footerDefault;
+		let finalFooterForLayout = footerContentForRender;
+		if (finalFooterRId) finalFooterForLayout = footerContentByRId?.get(finalFooterRId);
+		else if (sectionHeaderFooterRefs !== void 0) finalFooterForLayout = void 0;
 		const finalLayoutConfig = finalSectionProperties ? {
 			pageSize: getPageSize(finalSectionProperties),
-			margins: getMargins(finalSectionProperties)
+			margins: bodyMarginsClearHeaderFooter({
+				authoredMargins: getMargins(finalSectionProperties),
+				preparedHeader: finalHeaderForLayout,
+				preparedFooter: finalFooterForLayout
+			})
 		} : bodyLayoutConfig;
 		const finalColumns = getColumns(finalSectionProperties);
 		if (finalColumns !== void 0) finalLayoutConfig.columns = finalColumns;
@@ -123,7 +193,10 @@ function runLayoutPipeline(deps, state, options = {}) {
 			measureBlock: measureSingleBlockWithoutFloatingZones
 		}) : null;
 		let newMeasures = incrementalResult?.measures ?? measureBlocks(newBlocks, blockWidths, blockMeasureInputs.marginTops, {
+			pageWidth: blockMeasureInputs.pageWidths,
 			pageHeight: blockMeasureInputs.pageHeights,
+			marginLeft: blockMeasureInputs.marginLefts,
+			marginRight: blockMeasureInputs.marginRights,
 			marginBottom: blockMeasureInputs.marginBottoms
 		});
 		pendingArtifacts = {
@@ -137,21 +210,19 @@ function runLayoutPipeline(deps, state, options = {}) {
 		let newLayout;
 		let pageFootnoteMap = /* @__PURE__ */ new Map();
 		let footnoteContentMap = /* @__PURE__ */ new Map();
-		const bodyBreakType = sectionProperties?.sectionStart;
+		const bodyBreakType = finalSectionProperties?.sectionStart;
 		const buildLayoutOpts = () => {
 			const nextLayoutOpts = {
 				pageSize,
-				margins,
+				margins: initialBodyMargins,
 				pageGap,
 				mirrorMargins
 			};
-			if (hasTitlePg && firstPageHeaderForRender) {
-				const headerBottom = (margins.header ?? 0) + (firstPageHeaderForRender.marginPushBottom ?? firstPageHeaderForRender.height);
-				if (headerBottom > margins.top) nextLayoutOpts.firstPageMargins = {
-					...margins,
-					top: headerBottom
-				};
-			}
+			if (hasTitlePg) nextLayoutOpts.firstPageMargins = bodyMarginsClearHeaderFooter({
+				authoredMargins: margins,
+				preparedHeader: firstPageHeaderForRender,
+				preparedFooter: firstPageFooterForRender
+			});
 			if (finalSectionProperties) {
 				nextLayoutOpts.finalPageSize = finalLayoutConfig.pageSize;
 				nextLayoutOpts.finalMargins = finalLayoutConfig.margins;
@@ -163,6 +234,7 @@ function runLayoutPipeline(deps, state, options = {}) {
 			if (columns !== void 0) nextLayoutOpts.columns = columns;
 			if (bodyBreakType !== void 0) nextLayoutOpts.bodyBreakType = bodyBreakType;
 			if (sectionHeaderFooterRefs !== void 0) nextLayoutOpts.sectionHeaderFooterRefs = sectionHeaderFooterRefs;
+			if (sectionEvenPageMargins !== void 0) nextLayoutOpts.sectionEvenPageMargins = sectionEvenPageMargins;
 			return nextLayoutOpts;
 		};
 		const layoutOpts = buildLayoutOpts();
@@ -229,7 +301,10 @@ function runLayoutPipeline(deps, state, options = {}) {
 				previousFieldValues = values;
 				stabilizedFieldValues = values;
 				newMeasures = measureBlocks(newBlocks, blockWidths, blockMeasureInputs.marginTops, {
+					pageWidth: blockMeasureInputs.pageWidths,
 					pageHeight: blockMeasureInputs.pageHeights,
+					marginLeft: blockMeasureInputs.marginLefts,
+					marginRight: blockMeasureInputs.marginRights,
 					marginBottom: blockMeasureInputs.marginBottoms
 				}, values);
 				relayoutWithCurrentMeasures(layoutOptsUsed);

package/dist/docx/blockContentParser.js

@@ -49,23 +49,42 @@ const formatNumber = (value, numFmt) => {
 		case "lowerRoman": return toRoman(value).toLowerCase();
 		case "upperRoman": return toRoman(value);
 		case "bullet": return "•";
+		case "none": return "";
 		default: return String(value);
 	}
 };
-const computeListMarker = (paragraph, numbering, listCounters, abstractCounters) => {
+const computeListMarker = (paragraph, { numbering, listCounters, abstractCounters, restartedNumIds, previousList }) => {
 	const listRendering = paragraph.listRendering;
-	if (!listRendering || !numbering) return;
+	if (!listRendering || !numbering) {
+		previousList.abstractNumId = null;
+		previousList.fromStyle = false;
+		previousList.numId = null;
+		return;
+	}
 	const { numId, level } = listRendering;
-	if (numId === 0) return;
-	if (!listCounters.has(numId)) listCounters.set(numId, Array.from({ length: 9 }).fill(NaN));
+	if (numId === 0) {
+		previousList.abstractNumId = null;
+		previousList.fromStyle = false;
+		previousList.numId = null;
+		return;
+	}
+	const firstEncounter = !listCounters.has(numId);
+	if (firstEncounter) listCounters.set(numId, Array.from({ length: 9 }).fill(NaN));
 	const counters = listCounters.get(numId);
 	if (!counters) return;
 	const abstractNumId = numbering.getAbstractNumId(numId);
 	const styleNumbering = paragraph.formatting?.numPrFromStyle;
-	if (abstractNumId !== null && styleNumbering) {
+	let resumedAbstractCounters;
+	const resumesRestartedInstance = firstEncounter && listRendering.startOverride === void 0 && abstractNumId !== null && previousList.abstractNumId === abstractNumId && previousList.numId !== null && previousList.numId !== numId && restartedNumIds.has(previousList.numId);
+	const resumesStyleInstance = firstEncounter && !styleNumbering && listRendering.startOverride === void 0 && abstractNumId !== null && previousList.abstractNumId === abstractNumId && previousList.fromStyle === true;
+	if (abstractNumId !== null && (styleNumbering || resumesRestartedInstance || resumesStyleInstance)) {
 		const latestAbstractCounters = abstractCounters.get(abstractNumId);
-		if (latestAbstractCounters) for (let i = 0; i < counters.length; i += 1) counters[i] = latestAbstractCounters[i] ?? NaN;
+		if (latestAbstractCounters) {
+			for (let i = 0; i < counters.length; i += 1) counters[i] = latestAbstractCounters[i] ?? NaN;
+			resumedAbstractCounters = latestAbstractCounters;
+		}
 	}
+	if (listRendering.startOverride !== void 0 || resumesRestartedInstance || previousList.numId === numId && restartedNumIds.has(numId)) restartedNumIds.add(numId);
 	if (abstractNumId !== null && level > 0) {
 		const latestAbstractCounters = abstractCounters.get(abstractNumId);
 		if (counters.slice(0, level).every(Number.isNaN)) for (let i = 0; i < level; i += 1) {
@@ -81,10 +100,22 @@ const computeListMarker = (paragraph, numbering, listCounters, abstractCounters)
 		const childCounter = counters[level + 1];
 		counters[level + 1] = (childCounter === void 0 || Number.isNaN(childCounter) ? 0 : childCounter) + childAdvances;
 	}
-	if (abstractNumId !== null) abstractCounters.set(abstractNumId, [...counters]);
+	if (abstractNumId !== null) {
+		if (resumedAbstractCounters) for (const [otherNumId, otherCounters] of listCounters) {
+			if (otherNumId === numId || numbering.getAbstractNumId(otherNumId) !== abstractNumId || !otherCounters.every((value, index) => Object.is(value, resumedAbstractCounters[index]))) continue;
+			for (let i = 0; i < otherCounters.length; i += 1) otherCounters[i] = counters[i] ?? NaN;
+		}
+		abstractCounters.set(abstractNumId, [...counters]);
+	}
+	previousList.abstractNumId = abstractNumId;
+	previousList.fromStyle = Boolean(styleNumbering);
+	previousList.numId = numId;
 	const pattern = listRendering.marker;
 	if (listRendering.isBullet) {
 		listRendering.marker = convertBulletToUnicode(pattern || "");
+		previousList.abstractNumId = null;
+		previousList.fromStyle = false;
+		previousList.numId = null;
 		return;
 	}
 	let computedMarker = pattern;
@@ -103,6 +134,12 @@ const computeListMarker = (paragraph, numbering, listCounters, abstractCounters)
 const parseBlockContent = (parent, styles, theme, numbering, rels, media, options) => parseBlockContentWithState(parent, styles, theme, numbering, rels, media, {
 	listCounters: /* @__PURE__ */ new Map(),
 	abstractCounters: /* @__PURE__ */ new Map(),
+	restartedNumIds: /* @__PURE__ */ new Set(),
+	previousList: {
+		abstractNumId: null,
+		fromStyle: false,
+		numId: null
+	},
 	options: {
 		...options,
 		rootXmlns: mergeXmlnsDeclarations(options?.rootXmlns ?? {}, parent)
@@ -118,7 +155,13 @@ const parseBlockContentWithState = (parent, styles, theme, numbering, rels, medi
 			const paragraph = parseParagraph(child, styles, theme, numbering, rels, media, state.options);
 			prependPendingBookmarkMarkers(paragraph, pendingBookmarkMarkers);
 			enrichParagraphTextBoxes(paragraph, child, styles, theme, numbering, rels, media);
-			computeListMarker(paragraph, numbering, state.listCounters, state.abstractCounters);
+			computeListMarker(paragraph, {
+				numbering,
+				listCounters: state.listCounters,
+				abstractCounters: state.abstractCounters,
+				restartedNumIds: state.restartedNumIds,
+				previousList: state.previousList
+			});
 			content.push(paragraph);
 			continue;
 		}

package/dist/docx/capabilities.d.ts

@@ -0,0 +1,41 @@
+//#region src/docx/capabilities.d.ts
+declare const FOLIO_DOCX_CAPABILITY_MANIFEST_VERSION: 1;
+declare const FOLIO_DOCX_CAPABILITY_HOSTS: readonly ["browser", "server"];
+declare const FOLIO_DOCX_COMPATIBILITY_HOSTS: readonly ["browser", "server", "unknown"];
+declare const FOLIO_DOCX_PROFILES: readonly ["strict", "transitional"];
+declare const FOLIO_DOCX_COMPATIBILITY_PROFILES: readonly ["strict", "transitional", "unknown"];
+declare const FOLIO_DOCX_CAPABILITY_OPERATIONS: readonly ["create", "edit", "preserve", "read", "render"];
+declare const FOLIO_DOCX_SUPPORT_STATES: readonly ["supported", "partial", "unsupported"];
+declare const FOLIO_DOCX_CAPABILITY_IDS: readonly ["comments", "contentControls", "fields", "headersFooters", "hyperlinks", "images", "math", "notes", "numbering", "opaqueDrawing", "paragraphs", "sections", "styles", "tables", "trackedChanges"];
+type FolioDocxCapabilityHost = (typeof FOLIO_DOCX_CAPABILITY_HOSTS)[number];
+type FolioDocxCompatibilityHost = (typeof FOLIO_DOCX_COMPATIBILITY_HOSTS)[number];
+type FolioDocxProfile = (typeof FOLIO_DOCX_PROFILES)[number];
+type FolioDocxCompatibilityProfile = (typeof FOLIO_DOCX_COMPATIBILITY_PROFILES)[number];
+type FolioDocxCapabilityOperation = (typeof FOLIO_DOCX_CAPABILITY_OPERATIONS)[number];
+type FolioDocxSupportState = (typeof FOLIO_DOCX_SUPPORT_STATES)[number];
+type FolioDocxCapabilityId = (typeof FOLIO_DOCX_CAPABILITY_IDS)[number];
+type FolioDocxFeatureCapability = {
+  readonly id: FolioDocxCapabilityId;
+  readonly feature: "comments" | "contentControls" | "drawings" | "fields" | "headersFooters" | "hyperlinks" | "images" | "math" | "notes" | "numbering" | "paragraphs" | "revisions" | "sections" | "styles" | "tables";
+  readonly hosts: readonly FolioDocxCapabilityHost[];
+  readonly profiles: readonly FolioDocxProfile[];
+  readonly support: Readonly<Record<FolioDocxCapabilityOperation, FolioDocxSupportState>>;
+  readonly evidence: readonly {
+    readonly type: "test";
+    readonly path: string;
+  }[];
+};
+type FolioDocxCapabilityManifest = {
+  readonly version: typeof FOLIO_DOCX_CAPABILITY_MANIFEST_VERSION;
+  readonly capabilities: Readonly<Record<FolioDocxCapabilityId, FolioDocxFeatureCapability>>;
+};
+declare const FOLIO_DOCX_CAPABILITY_MANIFEST: FolioDocxCapabilityManifest;
+declare const InvalidFolioDocxCapabilityIdError_base: import("better-result").TaggedErrorClass<"InvalidFolioDocxCapabilityIdError", {
+  message: string;
+  receivedId: unknown;
+}>;
+declare class InvalidFolioDocxCapabilityIdError extends InvalidFolioDocxCapabilityIdError_base {}
+declare const isFolioDocxCapabilityId: (value: unknown) => value is FolioDocxCapabilityId;
+declare const getFolioDocxCapability: (id: unknown) => FolioDocxFeatureCapability;
+//#endregion
+export { FOLIO_DOCX_CAPABILITY_HOSTS, FOLIO_DOCX_CAPABILITY_IDS, FOLIO_DOCX_CAPABILITY_MANIFEST, FOLIO_DOCX_CAPABILITY_MANIFEST_VERSION, FOLIO_DOCX_CAPABILITY_OPERATIONS, FOLIO_DOCX_COMPATIBILITY_HOSTS, FOLIO_DOCX_COMPATIBILITY_PROFILES, FOLIO_DOCX_PROFILES, FOLIO_DOCX_SUPPORT_STATES, FolioDocxCapabilityHost, FolioDocxCapabilityId, FolioDocxCapabilityManifest, FolioDocxCapabilityOperation, FolioDocxCompatibilityHost, FolioDocxCompatibilityProfile, FolioDocxFeatureCapability, FolioDocxProfile, FolioDocxSupportState, InvalidFolioDocxCapabilityIdError, getFolioDocxCapability, isFolioDocxCapabilityId };

package/dist/docx/capabilities.js

@@ -0,0 +1,322 @@
+import { TaggedError } from "better-result";
+//#region src/docx/capabilities.ts
+const FOLIO_DOCX_CAPABILITY_MANIFEST_VERSION = 1;
+const FOLIO_DOCX_CAPABILITY_HOSTS = Object.freeze(["browser", "server"]);
+const FOLIO_DOCX_COMPATIBILITY_HOSTS = Object.freeze([...FOLIO_DOCX_CAPABILITY_HOSTS, "unknown"]);
+const FOLIO_DOCX_PROFILES = Object.freeze(["strict", "transitional"]);
+const FOLIO_DOCX_COMPATIBILITY_PROFILES = Object.freeze([...FOLIO_DOCX_PROFILES, "unknown"]);
+const FOLIO_DOCX_CAPABILITY_OPERATIONS = Object.freeze([
+	"create",
+	"edit",
+	"preserve",
+	"read",
+	"render"
+]);
+const FOLIO_DOCX_SUPPORT_STATES = Object.freeze([
+	"supported",
+	"partial",
+	"unsupported"
+]);
+const FOLIO_DOCX_CAPABILITY_IDS = Object.freeze([
+	"comments",
+	"contentControls",
+	"fields",
+	"headersFooters",
+	"hyperlinks",
+	"images",
+	"math",
+	"notes",
+	"numbering",
+	"opaqueDrawing",
+	"paragraphs",
+	"sections",
+	"styles",
+	"tables",
+	"trackedChanges"
+]);
+const TRANSITIONAL_PROFILE_COVERAGE = Object.freeze(["transitional"]);
+const STRUCTURED_FEATURE_SUPPORT = Object.freeze({
+	create: "supported",
+	edit: "supported",
+	preserve: "supported",
+	read: "supported",
+	render: "partial"
+});
+const PARTIAL_AUTHORING_FEATURE_SUPPORT = Object.freeze({
+	create: "partial",
+	edit: "partial",
+	preserve: "supported",
+	read: "supported",
+	render: "partial"
+});
+const COMMENTS_CAPABILITY = Object.freeze({
+	id: "comments",
+	feature: "comments",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: STRUCTURED_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/commentReplyThreads.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/commands/comments.test.ts"
+	}])
+});
+const CONTENT_CONTROLS_CAPABILITY = Object.freeze({
+	id: "contentControls",
+	feature: "contentControls",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: Object.freeze({
+		...PARTIAL_AUTHORING_FEATURE_SUPPORT,
+		edit: "supported"
+	}),
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/content-controls/contentControls.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/docx/sdtRoundtrip.property.test.ts"
+	}])
+});
+const FIELDS_CAPABILITY = Object.freeze({
+	id: "fields",
+	feature: "fields",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: PARTIAL_AUTHORING_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/fields/evaluateField.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/extensions/nodes/FieldExtension.test.ts"
+	}])
+});
+const HEADERS_FOOTERS_CAPABILITY = Object.freeze({
+	id: "headersFooters",
+	feature: "headersFooters",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: STRUCTURED_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/headerFooterParser.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/docx/headerFooterMaterialize.test.ts"
+	}])
+});
+const HYPERLINKS_CAPABILITY = Object.freeze({
+	id: "hyperlinks",
+	feature: "hyperlinks",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: PARTIAL_AUTHORING_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/hyperlinkParser.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/conversion/toProseDoc-hyperlink-content.test.ts"
+	}])
+});
+const IMAGES_CAPABILITY = Object.freeze({
+	id: "images",
+	feature: "images",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: Object.freeze({
+		...PARTIAL_AUTHORING_FEATURE_SUPPORT,
+		edit: "supported"
+	}),
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/__tests__/image-crop-roundtrip.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/commands/image.test.ts"
+	}])
+});
+const MATH_CAPABILITY = Object.freeze({
+	id: "math",
+	feature: "math",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: PARTIAL_AUTHORING_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/mathToMathml.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/docx/serializer/math-roundtrip.test.ts"
+	}])
+});
+const NOTES_CAPABILITY = Object.freeze({
+	id: "notes",
+	feature: "notes",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: Object.freeze({
+		create: "partial",
+		edit: "supported",
+		preserve: "supported",
+		read: "supported",
+		render: "partial"
+	}),
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/noteSave.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/layout-bridge/convert/footnoteLayout-collect.test.ts"
+	}])
+});
+const NUMBERING_CAPABILITY = Object.freeze({
+	id: "numbering",
+	feature: "numbering",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: Object.freeze({
+		create: "partial",
+		edit: "supported",
+		preserve: "supported",
+		read: "supported",
+		render: "partial"
+	}),
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/numberingParser-custom-format.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/docx/numberingSave.test.ts"
+	}])
+});
+const OPAQUE_DRAWING_CAPABILITY = Object.freeze({
+	id: "opaqueDrawing",
+	feature: "drawings",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: Object.freeze({
+		create: "unsupported",
+		edit: "unsupported",
+		preserve: "supported",
+		read: "supported",
+		render: "partial"
+	}),
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/compatibility.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/docx/rezip.test.ts"
+	}])
+});
+const PARAGRAPHS_CAPABILITY = Object.freeze({
+	id: "paragraphs",
+	feature: "paragraphs",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: STRUCTURED_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/paragraphParser.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/docx/serializer/paragraphSerializer.test.ts"
+	}])
+});
+const SECTIONS_CAPABILITY = Object.freeze({
+	id: "sections",
+	feature: "sections",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: STRUCTURED_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/serializer/sectionPropertiesSerializer.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/commands/sectionBreak.test.ts"
+	}])
+});
+const STYLES_CAPABILITY = Object.freeze({
+	id: "styles",
+	feature: "styles",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: Object.freeze({
+		create: "partial",
+		edit: "partial",
+		preserve: "supported",
+		read: "supported",
+		render: "partial"
+	}),
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/styleParser.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/conversion/characterStyleRoundtrip.test.ts"
+	}])
+});
+const TABLES_CAPABILITY = Object.freeze({
+	id: "tables",
+	feature: "tables",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: STRUCTURED_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/docx/tableParser.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/conversion/tableBordersRoundtrip.test.ts"
+	}])
+});
+const TRACKED_CHANGES_CAPABILITY = Object.freeze({
+	id: "trackedChanges",
+	feature: "revisions",
+	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
+	profiles: TRANSITIONAL_PROFILE_COVERAGE,
+	support: STRUCTURED_FEATURE_SUPPORT,
+	evidence: Object.freeze([{
+		type: "test",
+		path: "packages/core/src/redline.test.ts"
+	}, {
+		type: "test",
+		path: "packages/core/src/prosemirror/plugins/suggestionMode.test.ts"
+	}])
+});
+const FOLIO_DOCX_CAPABILITY_MANIFEST = Object.freeze({
+	version: 1,
+	capabilities: Object.freeze({
+		comments: COMMENTS_CAPABILITY,
+		contentControls: CONTENT_CONTROLS_CAPABILITY,
+		fields: FIELDS_CAPABILITY,
+		headersFooters: HEADERS_FOOTERS_CAPABILITY,
+		hyperlinks: HYPERLINKS_CAPABILITY,
+		images: IMAGES_CAPABILITY,
+		math: MATH_CAPABILITY,
+		notes: NOTES_CAPABILITY,
+		numbering: NUMBERING_CAPABILITY,
+		opaqueDrawing: OPAQUE_DRAWING_CAPABILITY,
+		paragraphs: PARAGRAPHS_CAPABILITY,
+		sections: SECTIONS_CAPABILITY,
+		styles: STYLES_CAPABILITY,
+		tables: TABLES_CAPABILITY,
+		trackedChanges: TRACKED_CHANGES_CAPABILITY
+	})
+});
+var InvalidFolioDocxCapabilityIdError = class extends TaggedError("InvalidFolioDocxCapabilityIdError")() {};
+const isFolioDocxCapabilityId = (value) => FOLIO_DOCX_CAPABILITY_IDS.some((id) => id === value);
+const getFolioDocxCapability = (id) => {
+	if (!isFolioDocxCapabilityId(id)) throw new InvalidFolioDocxCapabilityIdError({
+		message: "Invalid DOCX capability id.",
+		receivedId: id
+	});
+	return FOLIO_DOCX_CAPABILITY_MANIFEST.capabilities[id];
+};
+//#endregion
+export { FOLIO_DOCX_CAPABILITY_HOSTS, FOLIO_DOCX_CAPABILITY_IDS, FOLIO_DOCX_CAPABILITY_MANIFEST, FOLIO_DOCX_CAPABILITY_MANIFEST_VERSION, FOLIO_DOCX_CAPABILITY_OPERATIONS, FOLIO_DOCX_COMPATIBILITY_HOSTS, FOLIO_DOCX_COMPATIBILITY_PROFILES, FOLIO_DOCX_PROFILES, FOLIO_DOCX_SUPPORT_STATES, InvalidFolioDocxCapabilityIdError, getFolioDocxCapability, isFolioDocxCapabilityId };

package/dist/docx/compatibility.d.ts

@@ -1,12 +1,44 @@
 import { document_d_exports } from "../types/document.js";
+import { FolioDocxCompatibilityHost, FolioDocxCompatibilityProfile, FolioDocxFeatureCapability } from "./capabilities.js";
 
 //#region src/docx/compatibility.d.ts
 type DocxCompatibilityReason = "opaqueDrawing";
+type DocxCompatibilityContext = {
+  host: FolioDocxCompatibilityHost;
+  profile: FolioDocxCompatibilityProfile;
+};
+type InspectDocxCompatibilityOptions = Partial<DocxCompatibilityContext>;
+type DocxCompatibilityPart = {
+  type: "document";
+} | {
+  type: "header" | "footer";
+  relationshipId: string;
+} | {
+  type: "footnote" | "endnote";
+  id: number;
+};
+type DocxCompatibilityLocation = {
+  part: DocxCompatibilityPart;
+  path: string;
+  blockId?: string;
+};
+type DocxCompatibilityIssue = {
+  code: DocxCompatibilityReason;
+  capability: FolioDocxFeatureCapability;
+  coverage: {
+    host: "covered" | "unknown" | "unverified";
+    profile: "covered" | "unknown" | "unverified";
+  };
+  location: DocxCompatibilityLocation;
+};
 type DocxCompatibility = {
+  schemaVersion: 1;
+  context: DocxCompatibilityContext;
   canSafelyEdit: boolean;
+  issues: DocxCompatibilityIssue[];
   reasons: DocxCompatibilityReason[];
   unsupportedContentCount: number;
 };
-declare function inspectDocxCompatibility(doc: document_d_exports.Document): DocxCompatibility;
+declare const inspectDocxCompatibility: (doc: document_d_exports.Document, options?: InspectDocxCompatibilityOptions) => DocxCompatibility;
 //#endregion
-export { DocxCompatibility, DocxCompatibilityReason, inspectDocxCompatibility };
+export { DocxCompatibility, DocxCompatibilityContext, DocxCompatibilityIssue, DocxCompatibilityLocation, DocxCompatibilityPart, DocxCompatibilityReason, InspectDocxCompatibilityOptions, inspectDocxCompatibility };