document-model.js 0.0.0 → 1.5.0

package/dist/index.js

@@ -0,0 +1,539 @@
+import { z } from "zod";
+//#region src/color.ts
+const ColorSchema = z.object({
+	r: z.number().min(0).max(1),
+	g: z.number().min(0).max(1),
+	b: 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 = z.object({
+	xPt: z.number(),
+	yPt: z.number(),
+	widthPt: z.number().nonnegative(),
+	heightPt: z.number().nonnegative()
+});
+const PageSizeSchema = z.object({
+	widthPt: z.number().positive(),
+	heightPt: z.number().positive()
+});
+const MarginsSchema = z.object({
+	topPt: z.number().nonnegative(),
+	rightPt: z.number().nonnegative(),
+	bottomPt: z.number().nonnegative(),
+	leftPt: 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 = z.enum([
+	"left",
+	"center",
+	"right",
+	"justify"
+]);
+const LayoutFontSchema = z.object({
+	family: z.string(),
+	weight: z.enum(["normal", "bold"]),
+	style: z.enum(["normal", "italic"])
+});
+const DEFAULT_LAYOUT_FONT = {
+	family: "Helvetica",
+	weight: "normal",
+	style: "normal"
+};
+//#endregion
+//#region src/metadata.ts
+const LayoutMetadataSchema = z.object({
+	title: z.string().optional(),
+	author: z.string().optional(),
+	subject: z.string().optional(),
+	keywords: z.array(z.string()).optional(),
+	creator: z.string().optional(),
+	producer: z.string().optional(),
+	createdIso: z.string().optional(),
+	modifiedIso: z.string().optional()
+});
+//#endregion
+//#region src/content.ts
+const ContentRunSchema = z.object({
+	text: z.string(),
+	bold: z.boolean().optional(),
+	italic: z.boolean().optional(),
+	underline: z.boolean().optional(),
+	strike: z.boolean().optional(),
+	fontFamily: z.string().optional(),
+	sizePt: z.number().positive().optional(),
+	color: ColorSchema.optional(),
+	hyperlink: z.string().optional(),
+	sourcePath: z.string().optional()
+});
+const ContentListMembershipSchema = z.object({
+	numId: z.string(),
+	level: z.number().int().nonnegative()
+});
+const ContentParagraphSchema = z.object({
+	kind: z.literal("paragraph"),
+	runs: z.array(ContentRunSchema),
+	styleId: z.string().optional(),
+	alignment: AlignmentSchema.optional(),
+	list: ContentListMembershipSchema.optional(),
+	spacingBeforePt: z.number().optional(),
+	spacingAfterPt: z.number().optional(),
+	lineSpacing: z.number().positive().optional(),
+	indentLeftPt: z.number().optional(),
+	indentFirstLinePt: z.number().optional(),
+	sourcePath: z.string().optional()
+});
+const ContentImageBlockSchema = z.object({
+	kind: z.literal("image"),
+	format: z.enum(["png", "jpeg"]),
+	base64: z.string(),
+	widthPt: z.number().positive(),
+	heightPt: z.number().positive(),
+	altText: z.string().optional(),
+	sourcePath: z.string().optional()
+});
+const ContentPageBreakSchema = z.object({
+	kind: z.literal("pageBreak"),
+	sourcePath: z.string().optional()
+});
+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 isContentEmbeddedObjectKind(value) {
+	return value === "formula" || value === "wordprocessing" || value === "presentation" || value === "spreadsheet" || value === "drawing";
+}
+function isContentEmbeddedObject(value) {
+	return isRecord(value) && isContentEmbeddedObjectKind(value.objectKind) && BoxSchema.safeParse(value.frame).success && ContentDocumentSchema.safeParse(value.document).success;
+}
+function isContentEmbeddedObjectBlock(value) {
+	return isRecord(value) && value.kind === "embeddedObject" && isContentEmbeddedObject(value);
+}
+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");
+	if (kind === "embeddedObject") return isContentEmbeddedObject(value);
+	return false;
+}
+const ContentBlockSchema = z.custom(isContentBlock);
+const ContentEmbeddedObjectSchema = z.custom(isContentEmbeddedObject);
+const ContentEmbeddedObjectBlockSchema = z.custom(isContentEmbeddedObjectBlock);
+const ContentTableCellSchema = z.object({
+	blocks: z.array(ContentBlockSchema),
+	colSpan: z.number().int().positive().optional(),
+	rowSpan: z.number().int().positive().optional(),
+	background: ColorSchema.optional()
+});
+const ContentTableRowSchema = z.object({
+	cells: z.array(ContentTableCellSchema),
+	heightPt: z.number().positive().optional()
+});
+const ContentTableSchema = z.object({
+	kind: z.literal("table"),
+	rows: z.array(ContentTableRowSchema),
+	columnWidthsPt: z.array(z.number().positive()),
+	sourcePath: z.string().optional()
+});
+const ContentSectionSchema = z.object({
+	pageSize: PageSizeSchema,
+	margins: MarginsSchema,
+	blocks: z.array(ContentBlockSchema)
+});
+const ContentShapeSchema = z.object({
+	name: z.string().optional(),
+	frame: BoxSchema,
+	rotationDeg: z.number().optional(),
+	insetLeftPt: z.number().nonnegative(),
+	insetTopPt: z.number().nonnegative(),
+	insetRightPt: z.number().nonnegative(),
+	insetBottomPt: z.number().nonnegative(),
+	fontScale: z.number().positive().optional(),
+	lineSpacingReduction: z.number().nonnegative().optional(),
+	sourcePath: z.string().optional(),
+	blocks: z.array(ContentBlockSchema)
+});
+const ContentSlideSchema = z.object({
+	size: PageSizeSchema,
+	shapes: z.array(ContentShapeSchema),
+	notes: z.string()
+});
+const ContentCellValueSchema = z.discriminatedUnion("kind", [
+	z.object({
+		kind: z.literal("number"),
+		value: z.number()
+	}),
+	z.object({
+		kind: z.literal("percentage"),
+		value: z.number()
+	}),
+	z.object({
+		kind: z.literal("currency"),
+		value: z.number(),
+		currency: z.string().optional()
+	}),
+	z.object({
+		kind: z.literal("boolean"),
+		value: z.boolean()
+	}),
+	z.object({
+		kind: z.literal("date"),
+		value: z.string()
+	}),
+	z.object({
+		kind: z.literal("time"),
+		value: z.string()
+	}),
+	z.object({
+		kind: z.literal("string"),
+		value: z.string()
+	}),
+	z.object({
+		kind: z.literal("error"),
+		value: z.string()
+	}),
+	z.object({ kind: z.literal("empty") })
+]);
+const ContentSheetCellSchema = z.object({
+	row: z.number().int().nonnegative(),
+	column: z.number().int().nonnegative(),
+	value: ContentCellValueSchema,
+	formula: z.string().optional(),
+	displayText: z.string(),
+	runs: z.array(ContentRunSchema).optional(),
+	colSpan: z.number().int().positive().optional(),
+	rowSpan: z.number().int().positive().optional()
+});
+const ContentSheetColumnSchema = z.object({
+	index: z.number().int().nonnegative(),
+	widthPt: z.number().nonnegative(),
+	hidden: z.boolean().optional()
+});
+const ContentSheetRowSchema = z.object({
+	index: z.number().int().nonnegative(),
+	heightPt: z.number().nonnegative(),
+	hidden: z.boolean().optional()
+});
+const ContentSheetPrintRangeSchema = z.object({
+	startRow: z.number().int().nonnegative(),
+	startColumn: z.number().int().nonnegative(),
+	endRow: z.number().int().nonnegative(),
+	endColumn: z.number().int().nonnegative()
+});
+const ContentSheetRepeatRangeSchema = z.object({
+	start: z.number().int().nonnegative(),
+	end: z.number().int().nonnegative()
+});
+const ContentSheetPrintSettingsSchema = z.object({
+	pageSize: PageSizeSchema,
+	margins: MarginsSchema,
+	printRange: ContentSheetPrintRangeSchema.optional(),
+	scale: z.number().positive().optional(),
+	fitToPages: z.object({
+		width: z.number().int().positive(),
+		height: z.number().int().positive()
+	}).optional(),
+	repeatRows: ContentSheetRepeatRangeSchema.optional(),
+	repeatColumns: ContentSheetRepeatRangeSchema.optional(),
+	gridlines: z.boolean(),
+	headers: z.boolean(),
+	pageOrder: z.enum(["downThenOver", "overThenDown"]),
+	manualBreaks: z.object({
+		rows: z.array(z.number().int().nonnegative()),
+		columns: z.array(z.number().int().nonnegative())
+	}).optional()
+});
+const ContentSheetImageSchema = ContentImageBlockSchema.extend({
+	anchorRow: z.number().int().nonnegative(),
+	anchorColumn: z.number().int().nonnegative(),
+	offsetXPt: z.number(),
+	offsetYPt: z.number()
+});
+const ContentSheetSchema = z.object({
+	name: z.string(),
+	cells: z.array(ContentSheetCellSchema),
+	columns: z.array(ContentSheetColumnSchema),
+	rows: z.array(ContentSheetRowSchema),
+	images: z.array(ContentSheetImageSchema),
+	printSettings: ContentSheetPrintSettingsSchema,
+	embeddedObjects: z.array(ContentEmbeddedObjectSchema).optional()
+});
+const ContentStrokeSchema = z.object({
+	color: ColorSchema,
+	widthPt: z.number().positive()
+});
+const ContentPathPointSchema = z.object({
+	xPt: z.number(),
+	yPt: z.number()
+});
+const ContentPathSegmentSchema = z.discriminatedUnion("kind", [z.object({
+	kind: z.literal("line"),
+	to: ContentPathPointSchema
+}), z.object({
+	kind: z.literal("cubic"),
+	control1: ContentPathPointSchema,
+	control2: ContentPathPointSchema,
+	to: ContentPathPointSchema
+})]);
+const ContentSubpathSchema = z.object({
+	start: ContentPathPointSchema,
+	segments: z.array(ContentPathSegmentSchema),
+	closed: z.boolean()
+});
+const ContentVectorSchema = z.discriminatedUnion("kind", [
+	z.object({
+		kind: z.literal("rect"),
+		frame: BoxSchema,
+		fill: ColorSchema.optional(),
+		stroke: ContentStrokeSchema.optional(),
+		sourcePath: z.string().optional()
+	}),
+	z.object({
+		kind: z.literal("ellipse"),
+		frame: BoxSchema,
+		fill: ColorSchema.optional(),
+		stroke: ContentStrokeSchema.optional(),
+		sourcePath: z.string().optional()
+	}),
+	z.object({
+		kind: z.literal("line"),
+		from: ContentPathPointSchema,
+		to: ContentPathPointSchema,
+		stroke: ContentStrokeSchema,
+		sourcePath: z.string().optional()
+	}),
+	z.object({
+		kind: z.literal("path"),
+		frame: BoxSchema,
+		subpaths: z.array(ContentSubpathSchema),
+		fill: ColorSchema.optional(),
+		fillRule: z.enum(["nonzero", "evenodd"]).optional(),
+		stroke: ContentStrokeSchema.optional(),
+		sourcePath: z.string().optional()
+	})
+]);
+const ContentDrawPageSchema = z.object({
+	size: PageSizeSchema,
+	shapes: z.array(ContentShapeSchema),
+	vectors: z.array(ContentVectorSchema)
+});
+const CONTENT_FORMAT_VERSION = 1;
+const ContentDocumentSchema = z.discriminatedUnion("kind", [
+	z.object({
+		kind: z.literal("wordprocessing"),
+		formatVersion: z.literal(1),
+		metadata: LayoutMetadataSchema,
+		sections: z.array(ContentSectionSchema)
+	}),
+	z.object({
+		kind: z.literal("presentation"),
+		formatVersion: z.literal(1),
+		metadata: LayoutMetadataSchema,
+		slides: z.array(ContentSlideSchema)
+	}),
+	z.object({
+		kind: z.literal("spreadsheet"),
+		formatVersion: z.literal(1),
+		metadata: LayoutMetadataSchema,
+		sheets: z.array(ContentSheetSchema)
+	}),
+	z.object({
+		kind: z.literal("drawing"),
+		formatVersion: z.literal(1),
+		metadata: LayoutMetadataSchema,
+		pages: z.array(ContentDrawPageSchema)
+	})
+]);
+//#endregion
+//#region src/layout.ts
+const LAYOUT_FORMAT_VERSION = 1;
+const LayoutTextSchema = z.object({
+	kind: z.literal("text"),
+	text: z.string(),
+	xPt: z.number(),
+	yPt: z.number(),
+	font: LayoutFontSchema,
+	sizePt: z.number().positive(),
+	color: ColorSchema,
+	widthPt: z.number().nonnegative().optional(),
+	rotationDeg: z.number().optional(),
+	underline: z.boolean().optional(),
+	sourcePath: z.string().optional()
+});
+const LayoutImageSchema = z.object({
+	kind: z.literal("image"),
+	imageId: z.string(),
+	xPt: z.number(),
+	yPt: z.number(),
+	widthPt: z.number().positive(),
+	heightPt: z.number().positive(),
+	rotationDeg: z.number().optional(),
+	sourcePath: z.string().optional()
+});
+const LayoutRectSchema = z.object({
+	kind: z.literal("rect"),
+	xPt: z.number(),
+	yPt: z.number(),
+	widthPt: z.number().nonnegative(),
+	heightPt: z.number().nonnegative(),
+	fill: ColorSchema.optional(),
+	stroke: z.object({
+		color: ColorSchema,
+		widthPt: z.number().positive()
+	}).optional(),
+	sourcePath: z.string().optional()
+});
+const LayoutLineSchema = z.object({
+	kind: z.literal("line"),
+	x1Pt: z.number(),
+	y1Pt: z.number(),
+	x2Pt: z.number(),
+	y2Pt: z.number(),
+	color: ColorSchema,
+	widthPt: z.number().positive(),
+	sourcePath: z.string().optional()
+});
+const LayoutEllipseSchema = z.object({
+	kind: z.literal("ellipse"),
+	xPt: z.number(),
+	yPt: z.number(),
+	widthPt: z.number().positive(),
+	heightPt: z.number().positive(),
+	fill: ColorSchema.optional(),
+	stroke: z.object({
+		color: ColorSchema,
+		widthPt: z.number().positive()
+	}).optional(),
+	sourcePath: z.string().optional()
+});
+const LayoutPathSegmentSchema = z.discriminatedUnion("kind", [z.object({
+	kind: z.literal("line"),
+	xPt: z.number(),
+	yPt: z.number()
+}), z.object({
+	kind: z.literal("cubic"),
+	c1xPt: z.number(),
+	c1yPt: z.number(),
+	c2xPt: z.number(),
+	c2yPt: z.number(),
+	xPt: z.number(),
+	yPt: z.number()
+})]);
+const LayoutSubpathSchema = z.object({
+	startXPt: z.number(),
+	startYPt: z.number(),
+	segments: z.array(LayoutPathSegmentSchema),
+	closed: z.boolean()
+});
+const LayoutPathSchema = z.object({
+	kind: z.literal("path"),
+	subpaths: z.array(LayoutSubpathSchema),
+	fill: ColorSchema.optional(),
+	fillRule: z.enum(["nonzero", "evenodd"]).optional(),
+	stroke: z.object({
+		color: ColorSchema,
+		widthPt: z.number().positive()
+	}).optional(),
+	sourcePath: z.string().optional()
+});
+const LayoutLinkSchema = z.object({
+	kind: z.literal("link"),
+	uri: z.string(),
+	xPt: z.number(),
+	yPt: z.number(),
+	widthPt: z.number().nonnegative(),
+	heightPt: z.number().nonnegative(),
+	sourcePath: z.string().optional()
+});
+const LayoutItemSchema = z.discriminatedUnion("kind", [
+	LayoutTextSchema,
+	LayoutImageSchema,
+	LayoutRectSchema,
+	LayoutLineSchema,
+	LayoutEllipseSchema,
+	LayoutPathSchema,
+	LayoutLinkSchema
+]);
+const LayoutPageSchema = z.object({
+	widthPt: z.number().positive(),
+	heightPt: z.number().positive(),
+	items: z.array(LayoutItemSchema),
+	notes: z.string().optional()
+});
+const LayoutImageAssetSchema = z.object({
+	format: z.enum(["png", "jpeg"]),
+	base64: z.string(),
+	widthPx: z.number().int().positive(),
+	heightPx: z.number().int().positive()
+});
+const LayoutDocumentSchema = z.object({
+	formatVersion: z.literal(1),
+	metadata: LayoutMetadataSchema,
+	pages: z.array(LayoutPageSchema),
+	images: z.record(z.string(), LayoutImageAssetSchema)
+});
+//#endregion
+//#region src/package.ts
+const DOCUMENT_PACKAGE_FORMAT_VERSION = 1;
+const DocumentPackageSchema = z.object({
+	formatVersion: z.literal(1),
+	content: ContentDocumentSchema,
+	layout: LayoutDocumentSchema.optional()
+});
+//#endregion
+export { AlignmentSchema, BoxSchema, COLOR_BLACK, CONTENT_FORMAT_VERSION, ColorSchema, ContentBlockSchema, ContentCellValueSchema, ContentDocumentSchema, ContentDrawPageSchema, ContentEmbeddedObjectBlockSchema, ContentEmbeddedObjectSchema, ContentImageBlockSchema, ContentListMembershipSchema, ContentPageBreakSchema, ContentParagraphSchema, ContentPathPointSchema, ContentPathSegmentSchema, ContentRunSchema, ContentSectionSchema, ContentShapeSchema, ContentSheetCellSchema, ContentSheetColumnSchema, ContentSheetImageSchema, ContentSheetPrintRangeSchema, ContentSheetPrintSettingsSchema, ContentSheetRepeatRangeSchema, ContentSheetRowSchema, ContentSheetSchema, ContentSlideSchema, ContentStrokeSchema, ContentSubpathSchema, ContentTableCellSchema, ContentTableRowSchema, ContentTableSchema, ContentVectorSchema, DEFAULT_LAYOUT_FONT, DOCUMENT_PACKAGE_FORMAT_VERSION, DocumentPackageSchema, LAYOUT_FORMAT_VERSION, LayoutDocumentSchema, LayoutEllipseSchema, LayoutFontSchema, LayoutImageAssetSchema, LayoutImageSchema, LayoutItemSchema, LayoutLineSchema, LayoutLinkSchema, LayoutMetadataSchema, LayoutPageSchema, LayoutPathSchema, LayoutPathSegmentSchema, LayoutRectSchema, LayoutSubpathSchema, LayoutTextSchema, MarginsSchema, PAGE_SIZE_A4, PAGE_SIZE_LETTER, PageSizeSchema, SLIDE_SIZE_STANDARD, SLIDE_SIZE_WIDESCREEN, colorToRgbHex, isContentBlock, rgbHexToColor };

package/package.json

@@ -1,5 +1,85 @@
 {
   "name": "document-model.js",
-  "version": "0.0.0",
-  "private": false
-}
+  "version": "1.5.0",
+  "description": "The canonical, format-agnostic content and layout schemas shared by ooxml.js, odf.js, and documents.js -- pure Zod schemas, no behaviour.",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExaDev/document-schema.js.git"
+  },
+  "homepage": "https://github.com/ExaDev/document-schema.js#readme",
+  "bugs": {
+    "url": "https://github.com/ExaDev/document-schema.js/issues"
+  },
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "document",
+    "content-model",
+    "zod",
+    "schema",
+    "docx",
+    "pptx",
+    "xlsx",
+    "odt",
+    "odp",
+    "ods"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@commitlint/cli": "^21.2.1",
+    "@commitlint/config-conventional": "^21.2.0",
+    "@eslint/js": "^10.0.1",
+    "@semantic-release/changelog": "^7.0.0",
+    "@semantic-release/git": "^11.0.1",
+    "@types/node": "^26.1.1",
+    "@vitest/coverage-v8": "^4.1.10",
+    "eslint": "^10.8.0",
+    "globals": "^17.8.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.2.0",
+    "publint": "^0.3.21",
+    "semantic-release": "^25.0.8",
+    "tsdown": "^0.22.13",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.65.0",
+    "vitest": "^4.1.10"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint . --max-warnings 0",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --project unit",
+    "test:watch": "vitest --project unit",
+    "test:coverage": "vitest run --project unit --coverage",
+    "test:smoke": "tsdown && vitest run --project smoke",
+    "release": "semantic-release"
+  }
+}