document-content-model 0.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joseph Mearman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# document-content-model
+
+[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/document-content-model) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/document-content-model) [![Release](https://img.shields.io/github/v/release/ExaDev/document-content-model)](https://github.com/ExaDev/document-content-model/releases/latest) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/document-content-model/ci.yml?branch=main)](https://github.com/ExaDev/document-content-model/actions)
+
+> The canonical, format-agnostic content and layout schema pivot shared by [ooxml.js](https://github.com/ExaDev/ooxml.js), [odf.js](https://github.com/ExaDev/odf.js), and [documents.js](https://github.com/ExaDev/documents.js).
+
+Both `ooxml.js` and `documents.js` independently arrived at the same content vocabulary -- paragraphs, runs, tables, images, shapes, slides -- because `documents.js`'s docx/pptx-to-PDF pipeline needed a richer model than `ooxml.js`'s own readers originally produced, and that model was later ported back into `ooxml.js` itself. The result was two field-identical copies maintained in two places. This package is the fix: one schema, imported by every format package instead of redefined by each. It also sidesteps a circular dependency that would otherwise appear once `odf.js` exists, since `documents.js` depends on both `ooxml.js` and `odf.js`.
+
+It contains only [Zod](https://zod.dev) schemas, their inferred types, and a handful of trivial schema-attached helpers (hex-colour conversion, a recursive structural type guard for the mutually-recursive table/block types). There is no XML, ZIP, PDF, or other binary handling here, and no `zod` dependency other than `zod` itself.
+
+## Usage
+
+```ts
+import { ContentDocumentSchema, LayoutDocumentSchema } from 'document-content-model';
+
+const content = ContentDocumentSchema.parse(someWordprocessingOrPresentationValue);
+const layout = LayoutDocumentSchema.parse(somePageLayoutValue);
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,341 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let zod = require("zod");
+//#region src/color.ts
+const ColorSchema = zod.z.object({
+	r: zod.z.number().min(0).max(1),
+	g: zod.z.number().min(0).max(1),
+	b: zod.z.number().min(0).max(1)
+});
+const COLOR_BLACK = {
+	r: 0,
+	g: 0,
+	b: 0
+};
+const HEX_COLOR_PATTERN = /^#?([0-9a-fA-F]{6})$/;
+const HEX_BYTE_MAX = 255;
+function rgbHexToColor(hex) {
+	const match = HEX_COLOR_PATTERN.exec(hex);
+	if (match === null) throw new Error(`not a 6-digit hex colour: ${hex}`);
+	const digits = match[1];
+	if (digits === void 0) throw new Error(`not a 6-digit hex colour: ${hex}`);
+	const r = Number.parseInt(digits.slice(0, 2), 16);
+	const g = Number.parseInt(digits.slice(2, 4), 16);
+	const b = Number.parseInt(digits.slice(4, 6), 16);
+	return {
+		r: r / HEX_BYTE_MAX,
+		g: g / HEX_BYTE_MAX,
+		b: b / HEX_BYTE_MAX
+	};
+}
+function toHexByte(component) {
+	return Math.round(component * HEX_BYTE_MAX).toString(16).padStart(2, "0");
+}
+function colorToRgbHex(color) {
+	return `${toHexByte(color.r)}${toHexByte(color.g)}${toHexByte(color.b)}`;
+}
+//#endregion
+//#region src/geometry.ts
+const BoxSchema = zod.z.object({
+	xPt: zod.z.number(),
+	yPt: zod.z.number(),
+	widthPt: zod.z.number().nonnegative(),
+	heightPt: zod.z.number().nonnegative()
+});
+const PageSizeSchema = zod.z.object({
+	widthPt: zod.z.number().positive(),
+	heightPt: zod.z.number().positive()
+});
+const MarginsSchema = zod.z.object({
+	topPt: zod.z.number().nonnegative(),
+	rightPt: zod.z.number().nonnegative(),
+	bottomPt: zod.z.number().nonnegative(),
+	leftPt: zod.z.number().nonnegative()
+});
+const PAGE_SIZE_LETTER = {
+	widthPt: 612,
+	heightPt: 792
+};
+const PAGE_SIZE_A4 = {
+	widthPt: 595.28,
+	heightPt: 841.89
+};
+const SLIDE_SIZE_WIDESCREEN = {
+	widthPt: 960,
+	heightPt: 540
+};
+const SLIDE_SIZE_STANDARD = {
+	widthPt: 720,
+	heightPt: 540
+};
+//#endregion
+//#region src/style.ts
+const AlignmentSchema = zod.z.enum([
+	"left",
+	"center",
+	"right",
+	"justify"
+]);
+const LayoutFontSchema = zod.z.object({
+	family: zod.z.string(),
+	weight: zod.z.enum(["normal", "bold"]),
+	style: zod.z.enum(["normal", "italic"])
+});
+const DEFAULT_LAYOUT_FONT = {
+	family: "Helvetica",
+	weight: "normal",
+	style: "normal"
+};
+//#endregion
+//#region src/metadata.ts
+const LayoutMetadataSchema = zod.z.object({
+	title: zod.z.string().optional(),
+	author: zod.z.string().optional(),
+	subject: zod.z.string().optional(),
+	keywords: zod.z.array(zod.z.string()).optional(),
+	creator: zod.z.string().optional(),
+	producer: zod.z.string().optional(),
+	createdIso: zod.z.string().optional(),
+	modifiedIso: zod.z.string().optional()
+});
+//#endregion
+//#region src/content.ts
+const ContentRunSchema = zod.z.object({
+	text: zod.z.string(),
+	bold: zod.z.boolean().optional(),
+	italic: zod.z.boolean().optional(),
+	underline: zod.z.boolean().optional(),
+	strike: zod.z.boolean().optional(),
+	fontFamily: zod.z.string().optional(),
+	sizePt: zod.z.number().positive().optional(),
+	color: ColorSchema.optional(),
+	hyperlink: zod.z.string().optional()
+});
+const ContentListMembershipSchema = zod.z.object({
+	numId: zod.z.string(),
+	level: zod.z.number().int().nonnegative()
+});
+const ContentParagraphSchema = zod.z.object({
+	kind: zod.z.literal("paragraph"),
+	runs: zod.z.array(ContentRunSchema),
+	styleId: zod.z.string().optional(),
+	alignment: AlignmentSchema.optional(),
+	list: ContentListMembershipSchema.optional(),
+	spacingBeforePt: zod.z.number().optional(),
+	spacingAfterPt: zod.z.number().optional(),
+	lineSpacing: zod.z.number().positive().optional(),
+	indentLeftPt: zod.z.number().optional(),
+	indentFirstLinePt: zod.z.number().optional()
+});
+const ContentImageBlockSchema = zod.z.object({
+	kind: zod.z.literal("image"),
+	format: zod.z.enum(["png", "jpeg"]),
+	base64: zod.z.string(),
+	widthPt: zod.z.number().positive(),
+	heightPt: zod.z.number().positive(),
+	altText: zod.z.string().optional()
+});
+const ContentPageBreakSchema = zod.z.object({ kind: zod.z.literal("pageBreak") });
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isContentRun(value) {
+	return isRecord(value) && typeof value.text === "string";
+}
+function isContentTableCell(value) {
+	return isRecord(value) && Array.isArray(value.blocks) && value.blocks.every(isContentBlock);
+}
+function isContentTableRow(value) {
+	return isRecord(value) && Array.isArray(value.cells) && value.cells.every(isContentTableCell) && (value.heightPt === void 0 || typeof value.heightPt === "number");
+}
+function isContentBlock(value) {
+	if (!isRecord(value)) return false;
+	const kind = value.kind;
+	if (kind === "paragraph") return Array.isArray(value.runs) && value.runs.every(isContentRun);
+	if (kind === "image") return (value.format === "png" || value.format === "jpeg") && typeof value.base64 === "string" && typeof value.widthPt === "number" && typeof value.heightPt === "number";
+	if (kind === "pageBreak") return true;
+	if (kind === "table") return Array.isArray(value.rows) && value.rows.every(isContentTableRow) && Array.isArray(value.columnWidthsPt) && value.columnWidthsPt.every((w) => typeof w === "number");
+	return false;
+}
+const ContentBlockSchema = zod.z.custom(isContentBlock);
+const ContentTableCellSchema = zod.z.object({
+	blocks: zod.z.array(ContentBlockSchema),
+	colSpan: zod.z.number().int().positive().optional(),
+	rowSpan: zod.z.number().int().positive().optional(),
+	background: ColorSchema.optional()
+});
+const ContentTableRowSchema = zod.z.object({
+	cells: zod.z.array(ContentTableCellSchema),
+	heightPt: zod.z.number().positive().optional()
+});
+const ContentTableSchema = zod.z.object({
+	kind: zod.z.literal("table"),
+	rows: zod.z.array(ContentTableRowSchema),
+	columnWidthsPt: zod.z.array(zod.z.number().positive())
+});
+const ContentSectionSchema = zod.z.object({
+	pageSize: PageSizeSchema,
+	margins: MarginsSchema,
+	blocks: zod.z.array(ContentBlockSchema)
+});
+const ContentShapeSchema = zod.z.object({
+	name: zod.z.string().optional(),
+	frame: BoxSchema,
+	rotationDeg: zod.z.number().optional(),
+	insetLeftPt: zod.z.number().nonnegative(),
+	insetTopPt: zod.z.number().nonnegative(),
+	insetRightPt: zod.z.number().nonnegative(),
+	insetBottomPt: zod.z.number().nonnegative(),
+	fontScale: zod.z.number().positive().optional(),
+	lineSpacingReduction: zod.z.number().nonnegative().optional(),
+	blocks: zod.z.array(ContentBlockSchema)
+});
+const ContentSlideSchema = zod.z.object({
+	size: PageSizeSchema,
+	shapes: zod.z.array(ContentShapeSchema),
+	notes: zod.z.string()
+});
+const CONTENT_FORMAT_VERSION = 1;
+const ContentDocumentSchema = zod.z.discriminatedUnion("kind", [zod.z.object({
+	kind: zod.z.literal("wordprocessing"),
+	formatVersion: zod.z.literal(1),
+	metadata: LayoutMetadataSchema,
+	sections: zod.z.array(ContentSectionSchema)
+}), zod.z.object({
+	kind: zod.z.literal("presentation"),
+	formatVersion: zod.z.literal(1),
+	metadata: LayoutMetadataSchema,
+	slides: zod.z.array(ContentSlideSchema)
+})]);
+//#endregion
+//#region src/layout.ts
+const LAYOUT_FORMAT_VERSION = 1;
+const LayoutTextSchema = zod.z.object({
+	kind: zod.z.literal("text"),
+	text: zod.z.string(),
+	xPt: zod.z.number(),
+	yPt: zod.z.number(),
+	font: LayoutFontSchema,
+	sizePt: zod.z.number().positive(),
+	color: ColorSchema,
+	widthPt: zod.z.number().nonnegative().optional(),
+	rotationDeg: zod.z.number().optional(),
+	underline: zod.z.boolean().optional()
+});
+const LayoutImageSchema = zod.z.object({
+	kind: zod.z.literal("image"),
+	imageId: zod.z.string(),
+	xPt: zod.z.number(),
+	yPt: zod.z.number(),
+	widthPt: zod.z.number().positive(),
+	heightPt: zod.z.number().positive(),
+	rotationDeg: zod.z.number().optional()
+});
+const LayoutRectSchema = zod.z.object({
+	kind: zod.z.literal("rect"),
+	xPt: zod.z.number(),
+	yPt: zod.z.number(),
+	widthPt: zod.z.number().nonnegative(),
+	heightPt: zod.z.number().nonnegative(),
+	fill: ColorSchema.optional(),
+	stroke: zod.z.object({
+		color: ColorSchema,
+		widthPt: zod.z.number().positive()
+	}).optional()
+});
+const LayoutLineSchema = zod.z.object({
+	kind: zod.z.literal("line"),
+	x1Pt: zod.z.number(),
+	y1Pt: zod.z.number(),
+	x2Pt: zod.z.number(),
+	y2Pt: zod.z.number(),
+	color: ColorSchema,
+	widthPt: zod.z.number().positive()
+});
+const LayoutEllipseSchema = zod.z.object({
+	kind: zod.z.literal("ellipse"),
+	xPt: zod.z.number(),
+	yPt: zod.z.number(),
+	widthPt: zod.z.number().positive(),
+	heightPt: zod.z.number().positive(),
+	fill: ColorSchema.optional(),
+	stroke: zod.z.object({
+		color: ColorSchema,
+		widthPt: zod.z.number().positive()
+	}).optional()
+});
+const LayoutLinkSchema = zod.z.object({
+	kind: zod.z.literal("link"),
+	uri: zod.z.string(),
+	xPt: zod.z.number(),
+	yPt: zod.z.number(),
+	widthPt: zod.z.number().nonnegative(),
+	heightPt: zod.z.number().nonnegative()
+});
+const LayoutItemSchema = zod.z.discriminatedUnion("kind", [
+	LayoutTextSchema,
+	LayoutImageSchema,
+	LayoutRectSchema,
+	LayoutLineSchema,
+	LayoutEllipseSchema,
+	LayoutLinkSchema
+]);
+const LayoutPageSchema = zod.z.object({
+	widthPt: zod.z.number().positive(),
+	heightPt: zod.z.number().positive(),
+	items: zod.z.array(LayoutItemSchema),
+	notes: zod.z.string().optional()
+});
+const LayoutImageAssetSchema = zod.z.object({
+	format: zod.z.enum(["png", "jpeg"]),
+	base64: zod.z.string(),
+	widthPx: zod.z.number().int().positive(),
+	heightPx: zod.z.number().int().positive()
+});
+const LayoutDocumentSchema = zod.z.object({
+	formatVersion: zod.z.literal(1),
+	metadata: LayoutMetadataSchema,
+	pages: zod.z.array(LayoutPageSchema),
+	images: zod.z.record(zod.z.string(), LayoutImageAssetSchema)
+});
+//#endregion
+exports.AlignmentSchema = AlignmentSchema;
+exports.BoxSchema = BoxSchema;
+exports.COLOR_BLACK = COLOR_BLACK;
+exports.CONTENT_FORMAT_VERSION = CONTENT_FORMAT_VERSION;
+exports.ColorSchema = ColorSchema;
+exports.ContentBlockSchema = ContentBlockSchema;
+exports.ContentDocumentSchema = ContentDocumentSchema;
+exports.ContentImageBlockSchema = ContentImageBlockSchema;
+exports.ContentListMembershipSchema = ContentListMembershipSchema;
+exports.ContentPageBreakSchema = ContentPageBreakSchema;
+exports.ContentParagraphSchema = ContentParagraphSchema;
+exports.ContentRunSchema = ContentRunSchema;
+exports.ContentSectionSchema = ContentSectionSchema;
+exports.ContentShapeSchema = ContentShapeSchema;
+exports.ContentSlideSchema = ContentSlideSchema;
+exports.ContentTableCellSchema = ContentTableCellSchema;
+exports.ContentTableRowSchema = ContentTableRowSchema;
+exports.ContentTableSchema = ContentTableSchema;
+exports.DEFAULT_LAYOUT_FONT = DEFAULT_LAYOUT_FONT;
+exports.LAYOUT_FORMAT_VERSION = LAYOUT_FORMAT_VERSION;
+exports.LayoutDocumentSchema = LayoutDocumentSchema;
+exports.LayoutEllipseSchema = LayoutEllipseSchema;
+exports.LayoutFontSchema = LayoutFontSchema;
+exports.LayoutImageAssetSchema = LayoutImageAssetSchema;
+exports.LayoutImageSchema = LayoutImageSchema;
+exports.LayoutItemSchema = LayoutItemSchema;
+exports.LayoutLineSchema = LayoutLineSchema;
+exports.LayoutLinkSchema = LayoutLinkSchema;
+exports.LayoutMetadataSchema = LayoutMetadataSchema;
+exports.LayoutPageSchema = LayoutPageSchema;
+exports.LayoutRectSchema = LayoutRectSchema;
+exports.LayoutTextSchema = LayoutTextSchema;
+exports.MarginsSchema = MarginsSchema;
+exports.PAGE_SIZE_A4 = PAGE_SIZE_A4;
+exports.PAGE_SIZE_LETTER = PAGE_SIZE_LETTER;
+exports.PageSizeSchema = PageSizeSchema;
+exports.SLIDE_SIZE_STANDARD = SLIDE_SIZE_STANDARD;
+exports.SLIDE_SIZE_WIDESCREEN = SLIDE_SIZE_WIDESCREEN;
+exports.colorToRgbHex = colorToRgbHex;
+exports.isContentBlock = isContentBlock;
+exports.rgbHexToColor = rgbHexToColor;