@stll/folio-core 0.7.0 → 0.9.0

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 };

package/dist/style-sets/stellaStyle.js

@@ -0,0 +1,516 @@
+import "./types.js";
+//#region src/style-sets/stellaStyle.ts
+const CLAUSE_NUMBERING_ID = 1;
+const DEFINITIONS_NUMBERING_ID = 2;
+const RECITALS_NUMBERING_ID = 3;
+const PARTIES_NUMBERING_ID = 4;
+const BULLET_NUMBERING_ID = 5;
+const CLAUSE_ABSTRACT_NUMBERING_ID = 1;
+const DEFINITIONS_ABSTRACT_NUMBERING_ID = 2;
+const PARENTHETICAL_ABSTRACT_NUMBERING_ID = 3;
+const BULLET_ABSTRACT_NUMBERING_ID = 4;
+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.
+*/
+const createStellaStyleSet = () => ({
+	version: 1,
+	name: STELLA_STYLE_SET_NAME,
+	initialParagraphStyleId: "BodyText",
+	settings: { defaultTabStop: 720 },
+	fontTable: { fonts: [{
+		name: "Arial",
+		family: "swiss",
+		pitch: "variable"
+	}, {
+		name: "Georgia",
+		family: "roman",
+		pitch: "variable"
+	}] },
+	styles: {
+		docDefaults: { rPr: {
+			fontFamily: {
+				ascii: "Arial",
+				hAnsi: "Arial",
+				cs: "Arial"
+			},
+			fontSize: 20,
+			fontSizeCs: 20
+		} },
+		styles: [
+			{
+				styleId: "Normal",
+				type: "paragraph",
+				name: "Normal",
+				default: true,
+				qFormat: true,
+				uiPriority: 0,
+				pPr: {
+					alignment: "both",
+					spaceAfter: 240
+				},
+				rPr: {
+					fontFamily: {
+						ascii: "Arial",
+						hAnsi: "Arial",
+						cs: "Arial"
+					},
+					fontSize: 20,
+					fontSizeCs: 20
+				}
+			},
+			{
+				styleId: "DefaultParagraphFont",
+				type: "character",
+				name: "Default Paragraph Font",
+				default: true,
+				semiHidden: true,
+				unhideWhenUsed: true
+			},
+			{
+				styleId: "BodyText",
+				type: "paragraph",
+				name: "Body Text",
+				basedOn: "Normal",
+				qFormat: true,
+				uiPriority: 1
+			},
+			{
+				styleId: "Title",
+				type: "paragraph",
+				name: "Title",
+				basedOn: "BodyText",
+				next: "BodyText",
+				qFormat: true,
+				uiPriority: 2,
+				pPr: {
+					alignment: "center",
+					keepNext: true,
+					spaceAfter: 360
+				},
+				rPr: {
+					bold: true,
+					fontSize: 32,
+					fontSizeCs: 32
+				}
+			},
+			{
+				styleId: "TitleWithSubtitle",
+				type: "paragraph",
+				name: "Title with Subtitle",
+				basedOn: "Title",
+				next: "Subtitle",
+				qFormat: true,
+				uiPriority: 3,
+				pPr: { spaceAfter: 0 }
+			},
+			{
+				styleId: "Subtitle",
+				type: "paragraph",
+				name: "Subtitle",
+				basedOn: "Title",
+				next: "BodyText",
+				qFormat: true,
+				uiPriority: 4,
+				rPr: {
+					fontFamily: {
+						ascii: "Georgia",
+						hAnsi: "Georgia"
+					},
+					italic: true,
+					color: { rgb: "7F7F7F" }
+				}
+			},
+			{
+				styleId: "RecitalsHeading",
+				type: "paragraph",
+				name: "Recitals Heading",
+				basedOn: "BodyText",
+				next: "Recital",
+				qFormat: true,
+				uiPriority: 5,
+				pPr: { keepNext: true },
+				rPr: { bold: true }
+			},
+			{
+				styleId: "Recital",
+				type: "paragraph",
+				name: "Recital",
+				basedOn: "BodyText",
+				qFormat: true,
+				uiPriority: 6,
+				pPr: { numPr: {
+					numId: RECITALS_NUMBERING_ID,
+					ilvl: 0
+				} }
+			},
+			{
+				styleId: "AgreedTerms",
+				type: "paragraph",
+				name: "Agreed Terms",
+				basedOn: "BodyText",
+				next: "ClauseHeading1",
+				qFormat: true,
+				uiPriority: 7,
+				pPr: {
+					keepNext: true,
+					spaceBefore: 240
+				},
+				rPr: { bold: true }
+			},
+			...createClauseStyles(),
+			...createDefinitionStyles(),
+			{
+				styleId: "Party",
+				type: "paragraph",
+				name: "Party",
+				basedOn: "BodyText",
+				qFormat: true,
+				uiPriority: 30,
+				pPr: { numPr: {
+					numId: PARTIES_NUMBERING_ID,
+					ilvl: 0
+				} }
+			},
+			{
+				styleId: "ListParagraph",
+				type: "paragraph",
+				name: "List Paragraph",
+				basedOn: "BodyText",
+				qFormat: true,
+				uiPriority: 31,
+				pPr: { numPr: {
+					numId: BULLET_NUMBERING_ID,
+					ilvl: 0
+				} }
+			},
+			{
+				styleId: "TableText",
+				type: "paragraph",
+				name: "Table Text",
+				basedOn: "Normal",
+				qFormat: true,
+				uiPriority: 32,
+				pPr: { spaceAfter: 0 }
+			},
+			{
+				styleId: "ScheduleHeading",
+				type: "paragraph",
+				name: "Schedule Heading",
+				basedOn: "Title",
+				next: "BodyText",
+				qFormat: true,
+				uiPriority: 33,
+				pPr: {
+					pageBreakBefore: true,
+					keepNext: true,
+					spaceAfter: 240
+				}
+			},
+			{
+				styleId: "FootnoteText",
+				type: "paragraph",
+				name: "Footnote Text",
+				basedOn: "Normal",
+				link: "FootnoteTextChar",
+				semiHidden: true,
+				unhideWhenUsed: true,
+				uiPriority: 99,
+				pPr: { spaceAfter: 0 },
+				rPr: {
+					fontSize: 18,
+					fontSizeCs: 18
+				}
+			},
+			{
+				styleId: "FootnoteTextChar",
+				type: "character",
+				name: "Footnote Text Char",
+				basedOn: "DefaultParagraphFont",
+				link: "FootnoteText",
+				semiHidden: true,
+				unhideWhenUsed: true,
+				uiPriority: 99,
+				rPr: {
+					fontSize: 18,
+					fontSizeCs: 18
+				}
+			},
+			{
+				styleId: "FootnoteReference",
+				type: "character",
+				name: "Footnote Reference",
+				basedOn: "DefaultParagraphFont",
+				semiHidden: true,
+				unhideWhenUsed: true,
+				uiPriority: 99,
+				rPr: { vertAlign: "superscript" }
+			},
+			{
+				styleId: "Footer",
+				type: "paragraph",
+				name: "Footer",
+				basedOn: "Normal",
+				pPr: {
+					alignment: "right",
+					spaceAfter: 0
+				},
+				rPr: {
+					color: { rgb: "7F7F7F" },
+					fontSize: 18,
+					fontSizeCs: 18
+				}
+			},
+			{
+				styleId: "Hyperlink",
+				type: "character",
+				name: "Hyperlink",
+				basedOn: "DefaultParagraphFont",
+				unhideWhenUsed: true,
+				uiPriority: 99,
+				rPr: {
+					color: { rgb: "0563C1" },
+					underline: { style: "single" }
+				}
+			},
+			{
+				styleId: "TableNormal",
+				type: "table",
+				name: "Normal Table",
+				default: true,
+				semiHidden: true,
+				unhideWhenUsed: true,
+				uiPriority: 99
+			},
+			{
+				styleId: "TableGrid",
+				type: "table",
+				name: "Table Grid",
+				basedOn: "TableNormal",
+				qFormat: true,
+				uiPriority: 59,
+				tblPr: { borders: {
+					top: {
+						style: "single",
+						size: 4,
+						color: { rgb: "BFBFBF" }
+					},
+					left: {
+						style: "single",
+						size: 4,
+						color: { rgb: "BFBFBF" }
+					},
+					bottom: {
+						style: "single",
+						size: 4,
+						color: { rgb: "BFBFBF" }
+					},
+					right: {
+						style: "single",
+						size: 4,
+						color: { rgb: "BFBFBF" }
+					},
+					insideH: {
+						style: "single",
+						size: 4,
+						color: { rgb: "BFBFBF" }
+					},
+					insideV: {
+						style: "single",
+						size: 4,
+						color: { rgb: "BFBFBF" }
+					}
+				} }
+			}
+		]
+	},
+	numbering: createLegalNumbering()
+});
+const createStellaStyleDocumentPreset = () => ({
+	version: 1,
+	name: STELLA_STYLE_SET_NAME,
+	styleSet: createStellaStyleSet(),
+	sectionProperties: {
+		pageWidth: 11906,
+		pageHeight: 16838,
+		orientation: "portrait",
+		marginTop: 1440,
+		marginBottom: 1440,
+		marginLeft: 1440,
+		marginRight: 1440,
+		headerDistance: 708,
+		footerDistance: 708,
+		gutter: 0,
+		columnCount: 1,
+		columnSpace: 708,
+		equalWidth: true,
+		sectionStart: "nextPage",
+		verticalAlign: "top"
+	}
+});
+const createClauseStyles = () => {
+	return [
+		{
+			styleId: "ClauseHeading1",
+			name: "Clause Heading",
+			level: 0,
+			bold: true,
+			next: "ClauseParagraph1"
+		},
+		{
+			styleId: "ClauseParagraph1",
+			name: "Clause 1.1",
+			level: 1,
+			bold: false,
+			next: "ClauseParagraph1"
+		},
+		{
+			styleId: "ClauseParagraph2",
+			name: "Clause (a)",
+			level: 2,
+			bold: false,
+			next: "ClauseParagraph2"
+		},
+		{
+			styleId: "ClauseParagraph3",
+			name: "Clause (i)",
+			level: 3,
+			bold: false,
+			next: "ClauseParagraph3"
+		},
+		{
+			styleId: "ClauseParagraph4",
+			name: "Clause (A)",
+			level: 4,
+			bold: false,
+			next: "ClauseParagraph4"
+		}
+	].map(({ styleId, name, level, bold, next }) => {
+		const style = {
+			styleId,
+			type: "paragraph",
+			name,
+			basedOn: "BodyText",
+			next,
+			qFormat: true,
+			uiPriority: 10 + level,
+			pPr: {
+				numPr: {
+					numId: CLAUSE_NUMBERING_ID,
+					ilvl: level
+				},
+				keepNext: level < 2,
+				spaceBefore: clauseSpaceBefore(level)
+			}
+		};
+		if (bold) return Object.assign(style, { rPr: { bold: true } });
+		return style;
+	});
+};
+const clauseSpaceBefore = (level) => {
+	if (level === 0) return 360;
+	return 0;
+};
+const createDefinitionStyles = () => {
+	return [
+		{
+			styleId: "Definition1",
+			name: "Definition (a)",
+			level: 0
+		},
+		{
+			styleId: "Definition2",
+			name: "Definition (i)",
+			level: 1
+		},
+		{
+			styleId: "Definition3",
+			name: "Definition (A)",
+			level: 2
+		}
+	].map(({ styleId, name, level }) => ({
+		styleId,
+		type: "paragraph",
+		name,
+		basedOn: "BodyText",
+		qFormat: true,
+		uiPriority: 20 + level,
+		pPr: { numPr: {
+			numId: DEFINITIONS_NUMBERING_ID,
+			ilvl: level
+		} }
+	}));
+};
+const createLegalNumbering = () => ({
+	abstractNums: [
+		{
+			abstractNumId: CLAUSE_ABSTRACT_NUMBERING_ID,
+			multiLevelType: "multilevel",
+			levels: [
+				legalLevel(0, "decimal", "%1", 567, 567, true),
+				legalLevel(1, "decimal", "%1.%2", 567, 567, true),
+				legalLevel(2, "lowerLetter", "(%3)", 1134, 567),
+				legalLevel(3, "lowerRoman", "(%4)", 1701, 567),
+				legalLevel(4, "upperLetter", "(%5)", 2268, 567)
+			]
+		},
+		{
+			abstractNumId: DEFINITIONS_ABSTRACT_NUMBERING_ID,
+			multiLevelType: "multilevel",
+			levels: [
+				legalLevel(0, "lowerLetter", "(%1)", 720, 360),
+				legalLevel(1, "lowerRoman", "(%2)", 1440, 360),
+				legalLevel(2, "upperLetter", "(%3)", 2160, 360)
+			]
+		},
+		{
+			abstractNumId: PARENTHETICAL_ABSTRACT_NUMBERING_ID,
+			multiLevelType: "singleLevel",
+			levels: [legalLevel(0, "upperLetter", "(%1)", 720, 360)]
+		},
+		{
+			abstractNumId: BULLET_ABSTRACT_NUMBERING_ID,
+			multiLevelType: "singleLevel",
+			levels: [legalLevel(0, "bullet", "•", 720, 360)]
+		}
+	],
+	nums: [
+		{
+			numId: CLAUSE_NUMBERING_ID,
+			abstractNumId: CLAUSE_ABSTRACT_NUMBERING_ID
+		},
+		{
+			numId: DEFINITIONS_NUMBERING_ID,
+			abstractNumId: DEFINITIONS_ABSTRACT_NUMBERING_ID
+		},
+		{
+			numId: RECITALS_NUMBERING_ID,
+			abstractNumId: PARENTHETICAL_ABSTRACT_NUMBERING_ID
+		},
+		{
+			numId: PARTIES_NUMBERING_ID,
+			abstractNumId: PARENTHETICAL_ABSTRACT_NUMBERING_ID
+		},
+		{
+			numId: BULLET_NUMBERING_ID,
+			abstractNumId: BULLET_ABSTRACT_NUMBERING_ID
+		}
+	]
+});
+const legalLevel = (ilvl, numFmt, lvlText, indentLeft, hangingIndent, isLegal = false) => ({
+	ilvl,
+	start: 1,
+	numFmt,
+	lvlText,
+	suffix: "tab",
+	...isLegal ? { isLgl: true } : {},
+	pPr: {
+		indentLeft,
+		indentFirstLine: hangingIndent,
+		hangingIndent: true
+	}
+});
+//#endregion
+export { STELLA_STYLE_SET_NAME, createStellaStyleDocumentPreset, createStellaStyleSet };