@stll/folio-core 0.8.0 → 0.10.0

package/dist/server.js

@@ -1,14 +1,18 @@
 import { deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { createFolioAITextRangeHandle } from "./ai-edits/snapshot.js";
 import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "./document-operations.js";
+import { DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION } from "./style-sets/types.js";
 import { createEmptyDocument } from "./utils/createDocument.js";
+import { extractDocumentStyleSet, extractDocumentStyleSetFromDocx, inspectDocumentStyles, inspectDocumentStylesFromDocx } from "./style-sets/extract.js";
+import { STELLA_STYLE_SET_NAME, createStellaStyleDocumentPreset, createStellaStyleSet } from "./style-sets/stellaStyle.js";
 import { createDocx } from "./docx/rezip.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./ai-edits/scoped-reading.js";
 import { replyToComment } from "./docx/replyToComment.js";
-import { FolioDocxReviewer, applyFolioAIEditsToBuffer } from "./ai-edits/headless.js";
-import { compareDocxVersions } from "./version-comparison.js";
-import { generateRedlineDocx } from "./redline.js";
+import { FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, FolioDocxReviewer, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, isFolioResolvedReviewedView, isFolioReviewedView } from "./ai-edits/headless.js";
+import { FOLIO_DOCUMENT_METADATA_PROPERTIES, FOLIO_DOCUMENT_PRIVACY_TRANSFORMS, FolioDocumentPrivacyArchiveError, InvalidFolioDocumentPrivacyOptionsError, isFolioDocumentPrivacyTransform, rewriteDocxMetadataPrivacy } from "./docx/metadataPrivacy.js";
+import { FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, InvalidFolioVersionComparisonOptionsError, applyFolioVersionDiffPrivacy, compareDocxVersions, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope } from "./version-comparison.js";
+import { InvalidGenerateRedlineDocxOptionsError, generateRedlineDocx } from "./redline.js";
 import { EnsureParaIdsError, ensureParaIds } from "./docx/ensureParaIds.js";
 import { DocxArchiveError } from "./docx/server/boundedArchive.js";
 import { extractDocxText } from "./docx/server/extractDocxText.js";
-export { DocxArchiveError, EnsureParaIdsError, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocxReviewer, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, applyFolioAIEditsToBuffer, assertSupportedFolioDocumentOperationVersion, compareDocxVersions, createDocx, createEmptyDocument, createFolioAITextRangeHandle, deriveBlockId, ensureParaIds, extractDocxText, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, isFolioBlockId, isFolioDocumentOperationModeSupported, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch, readFolioDocumentSection, replyToComment };
+export { DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DocxArchiveError, EnsureParaIdsError, FOLIO_DOCUMENT_METADATA_PROPERTIES, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_DOCUMENT_PRIVACY_TRANSFORMS, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, FolioDocumentPrivacyArchiveError, FolioDocumentStoryNotFoundError, FolioDocxReviewer, InvalidFolioDocumentOperationBatchError, InvalidFolioDocumentPrivacyOptionsError, InvalidFolioVersionComparisonOptionsError, InvalidGenerateRedlineDocxOptionsError, STELLA_STYLE_SET_NAME, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, applyFolioVersionDiffPrivacy, assertSupportedFolioDocumentOperationVersion, compareDocxVersions, createDocx, createEmptyDocument, createFolioAITextRangeHandle, createStellaStyleDocumentPreset, createStellaStyleSet, deriveBlockId, ensureParaIds, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractDocxText, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, inspectDocumentStyles, inspectDocumentStylesFromDocx, isFolioBlockId, isFolioDocumentOperationModeSupported, isFolioDocumentPrivacyTransform, isFolioResolvedReviewedView, isFolioReviewedView, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch, readFolioDocumentSection, replyToComment, rewriteDocxMetadataPrivacy };

package/dist/style-sets/extract.d.ts

@@ -0,0 +1,35 @@
+import { document_d_exports } from "../types/document.js";
+import { DocumentStyleSet } from "./types.js";
+import { DocxInput } from "../utils/docxInput.js";
+
+//#region src/style-sets/extract.d.ts
+type ExtractDocumentStyleSetOptions = {
+  name: string; /** Style IDs selected by the user. Omit to extract every style. */
+  styleIds?: readonly string[]; /** Defaults to the source document's default paragraph style. */
+  initialParagraphStyleId?: string;
+};
+type DocumentStyleCatalogEntry = {
+  styleId: string;
+  name: string;
+  type: document_d_exports.Style["type"];
+  role: "default" | "quick" | "available" | "supporting";
+  dependencies: string[];
+  numberingId?: number;
+};
+type DocumentStyleCatalog = {
+  defaultParagraphStyleId?: string;
+  styles: DocumentStyleCatalogEntry[];
+};
+declare const inspectDocumentStyles: (document: document_d_exports.Document) => DocumentStyleCatalog;
+declare const inspectDocumentStylesFromDocx: (input: DocxInput) => Promise<DocumentStyleCatalog>;
+/**
+ * Extract a sanitized style set from a parsed document.
+ *
+ * Selected styles expand to a dependency closure over basedOn, next, and link
+ * references. Only numbering definitions referenced by the resulting styles
+ * are retained. No source content or package relationship can enter the result.
+ */
+declare const extractDocumentStyleSet: (document: document_d_exports.Document, options: ExtractDocumentStyleSetOptions) => DocumentStyleSet;
+declare const extractDocumentStyleSetFromDocx: (input: DocxInput, options: ExtractDocumentStyleSetOptions) => Promise<DocumentStyleSet>;
+//#endregion
+export { DocumentStyleCatalog, DocumentStyleCatalogEntry, ExtractDocumentStyleSetOptions, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, inspectDocumentStyles, inspectDocumentStylesFromDocx };

package/dist/style-sets/extract.js

@@ -0,0 +1,123 @@
+import "./types.js";
+import { parseDocx } from "../docx/parser.js";
+import { panic } from "better-result";
+//#region src/style-sets/extract.ts
+const inspectDocumentStyles = (document) => {
+	const styles = document.package.styles?.styles ?? [];
+	const defaultParagraphStyleId = styles.find((style) => style.type === "paragraph" && style.default)?.styleId;
+	return {
+		...defaultParagraphStyleId ? { defaultParagraphStyleId } : {},
+		styles: styles.map(toCatalogEntry)
+	};
+};
+const inspectDocumentStylesFromDocx = async (input) => inspectDocumentStyles(await parseDocx(input, {
+	preloadFonts: false,
+	parseHeadersFooters: false,
+	parseNotes: false,
+	detectVariables: false
+}));
+/**
+* Extract a sanitized style set from a parsed document.
+*
+* Selected styles expand to a dependency closure over basedOn, next, and link
+* references. Only numbering definitions referenced by the resulting styles
+* are retained. No source content or package relationship can enter the result.
+*/
+const extractDocumentStyleSet = (document, options) => {
+	const definitions = document.package.styles;
+	if (!definitions || definitions.styles.length === 0) return panic("Cannot extract a style set from a document without styles");
+	const stylesById = new Map(definitions.styles.map((style) => [style.styleId, style]));
+	const selectedStyleIds = options.styleIds === void 0 ? new Set(stylesById.keys()) : collectStyleDependencyClosure(stylesById, options.styleIds);
+	const styles = definitions.styles.filter((style) => selectedStyleIds.has(style.styleId));
+	if (styles.length === 0) return panic("Cannot extract an empty style set");
+	const defaultParagraphStyle = styles.find((style) => style.type === "paragraph" && style.default);
+	const initialParagraphStyleId = options.initialParagraphStyleId ?? defaultParagraphStyle?.styleId ?? "Normal";
+	if (!styles.find((style) => style.styleId === initialParagraphStyleId && style.type === "paragraph")) return panic(`Initial paragraph style "${initialParagraphStyleId}" is not present in the extracted set`);
+	const numbering = extractReferencedNumbering(styles, document);
+	const fontTable = sanitizeFontTable(document.package.fontTable);
+	return structuredClone({
+		version: 1,
+		name: options.name,
+		initialParagraphStyleId,
+		styles: {
+			...definitions.docDefaults ? { docDefaults: definitions.docDefaults } : {},
+			...definitions.latentStyles ? { latentStyles: definitions.latentStyles } : {},
+			styles
+		},
+		...numbering ? { numbering } : {},
+		...document.package.theme ? { theme: document.package.theme } : {},
+		...fontTable ? { fontTable } : {},
+		...document.package.settings ? { settings: document.package.settings } : {}
+	});
+};
+const extractDocumentStyleSetFromDocx = async (input, options) => {
+	const document = await parseDocx(input, {
+		preloadFonts: false,
+		parseHeadersFooters: false,
+		parseNotes: false,
+		detectVariables: false
+	});
+	return extractDocumentStyleSet(document, options);
+};
+const collectStyleDependencyClosure = (stylesById, requestedStyleIds) => {
+	const selected = /* @__PURE__ */ new Set();
+	const pending = [...requestedStyleIds];
+	while (pending.length > 0) {
+		const styleId = pending.pop();
+		if (styleId === void 0 || selected.has(styleId)) continue;
+		const style = stylesById.get(styleId);
+		if (!style) return panic(`Cannot extract unknown style "${styleId}"`);
+		selected.add(styleId);
+		for (const dependency of [
+			style.basedOn,
+			style.next,
+			style.link
+		]) if (dependency !== void 0 && !selected.has(dependency)) pending.push(dependency);
+	}
+	return selected;
+};
+const extractReferencedNumbering = (styles, document) => {
+	const source = document.package.numbering;
+	if (!source) return;
+	const referencedNumIds = /* @__PURE__ */ new Set();
+	for (const style of styles) {
+		const numId = style.pPr?.numPr?.numId;
+		if (numId !== void 0) referencedNumIds.add(numId);
+	}
+	if (referencedNumIds.size === 0) return;
+	const nums = source.nums.filter((numbering) => referencedNumIds.has(numbering.numId));
+	const referencedAbstractNumIds = new Set(nums.map((numbering) => numbering.abstractNumId));
+	return {
+		abstractNums: source.abstractNums.filter((numbering) => referencedAbstractNumIds.has(numbering.abstractNumId)),
+		nums
+	};
+};
+const sanitizeFontTable = (fontTable) => {
+	if (!fontTable) return;
+	return { fonts: fontTable.fonts.map(stripEmbeddedFontRelationships) };
+};
+const stripEmbeddedFontRelationships = ({ embedRegular: _embedRegular, embedBold: _embedBold, embedItalic: _embedItalic, embedBoldItalic: _embedBoldItalic, ...font }) => font;
+const toCatalogEntry = (style) => {
+	const entry = {
+		styleId: style.styleId,
+		name: style.name ?? style.styleId,
+		type: style.type,
+		role: styleRole(style),
+		dependencies: [...new Set([
+			style.basedOn,
+			style.next,
+			style.link
+		].filter((dependency) => dependency !== void 0))]
+	};
+	const numberingId = style.pPr?.numPr?.numId;
+	if (numberingId !== void 0) entry.numberingId = numberingId;
+	return entry;
+};
+const styleRole = (style) => {
+	if (style.default) return "default";
+	if (style.qFormat) return "quick";
+	if (!style.hidden && !style.semiHidden) return "available";
+	return "supporting";
+};
+//#endregion
+export { extractDocumentStyleSet, extractDocumentStyleSetFromDocx, inspectDocumentStyles, inspectDocumentStylesFromDocx };

package/dist/style-sets/stellaStyle.d.ts

@@ -0,0 +1,13 @@
+import { DocumentPreset, DocumentStyleSet } from "./types.js";
+
+//#region src/style-sets/stellaStyle.d.ts
+declare const STELLA_STYLE_SET_NAME = "Stella Style";
+/**
+ * A conservative legal drafting system inspired by common continental and
+ * common-law contract structure. It uses explicit fonts and neutral punctuation
+ * so the package does not depend on a locale-specific Office theme.
+ */
+declare const createStellaStyleSet: () => DocumentStyleSet;
+declare const createStellaStyleDocumentPreset: () => DocumentPreset;
+//#endregion
+export { STELLA_STYLE_SET_NAME, createStellaStyleDocumentPreset, createStellaStyleSet };