document-model.js 1.10.1 → 2.0.0

package/dist/content-json-schema-defs.js

@@ -0,0 +1,409 @@
+import { schemaUriFor } from "./schema-io.js";
+//#region src/content-json-schema-defs.ts
+const MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER;
+const EMBEDDED_OBJECT_KINDS = [
+	"formula",
+	"wordprocessing",
+	"presentation",
+	"spreadsheet",
+	"drawing"
+];
+const CONTENT_DOCUMENT_URI = schemaUriFor("ContentDocument");
+const CONTENT_DEFS = {
+	Color: {
+		type: "object",
+		properties: {
+			r: {
+				type: "number",
+				minimum: 0,
+				maximum: 1
+			},
+			g: {
+				type: "number",
+				minimum: 0,
+				maximum: 1
+			},
+			b: {
+				type: "number",
+				minimum: 0,
+				maximum: 1
+			}
+		},
+		required: [
+			"r",
+			"g",
+			"b"
+		],
+		additionalProperties: false
+	},
+	Box: {
+		type: "object",
+		properties: {
+			xPt: { type: "number" },
+			yPt: { type: "number" },
+			widthPt: {
+				type: "number",
+				minimum: 0
+			},
+			heightPt: {
+				type: "number",
+				minimum: 0
+			}
+		},
+		required: [
+			"xPt",
+			"yPt",
+			"widthPt",
+			"heightPt"
+		],
+		additionalProperties: false
+	},
+	Alignment: {
+		type: "string",
+		enum: [
+			"left",
+			"center",
+			"right",
+			"justify"
+		]
+	},
+	ContentStrokeStyle: {
+		type: "string",
+		enum: [
+			"solid",
+			"dashed",
+			"dotted",
+			"double"
+		]
+	},
+	ContentBorder: {
+		type: "object",
+		properties: {
+			color: { $ref: "#/$defs/Color" },
+			widthPt: {
+				type: "number",
+				exclusiveMinimum: 0
+			},
+			style: { $ref: "#/$defs/ContentStrokeStyle" }
+		},
+		required: ["color", "widthPt"],
+		additionalProperties: false
+	},
+	ContentCellBorders: {
+		type: "object",
+		properties: {
+			left: { $ref: "#/$defs/ContentBorder" },
+			right: { $ref: "#/$defs/ContentBorder" },
+			top: { $ref: "#/$defs/ContentBorder" },
+			bottom: { $ref: "#/$defs/ContentBorder" }
+		},
+		additionalProperties: false
+	},
+	ContentListMembership: {
+		type: "object",
+		properties: {
+			numId: { type: "string" },
+			level: {
+				type: "integer",
+				minimum: 0,
+				maximum: MAX_SAFE_INTEGER
+			}
+		},
+		required: ["numId", "level"],
+		additionalProperties: false
+	},
+	ContentRun: {
+		type: "object",
+		properties: {
+			text: { type: "string" },
+			bold: { type: "boolean" },
+			italic: { type: "boolean" },
+			underline: { type: "boolean" },
+			strike: { type: "boolean" },
+			fontFamily: { type: "string" },
+			sizePt: {
+				type: "number",
+				exclusiveMinimum: 0
+			},
+			color: { $ref: "#/$defs/Color" },
+			hyperlink: { type: "string" },
+			sourcePath: { type: "string" }
+		},
+		required: ["text"],
+		additionalProperties: false
+	},
+	ContentParagraph: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "paragraph"
+			},
+			runs: {
+				type: "array",
+				items: { $ref: "#/$defs/ContentRun" }
+			},
+			styleId: { type: "string" },
+			alignment: { $ref: "#/$defs/Alignment" },
+			list: { $ref: "#/$defs/ContentListMembership" },
+			spacingBeforePt: { type: "number" },
+			spacingAfterPt: { type: "number" },
+			lineSpacing: {
+				type: "number",
+				exclusiveMinimum: 0
+			},
+			indentLeftPt: { type: "number" },
+			indentFirstLinePt: { type: "number" },
+			sourcePath: { type: "string" }
+		},
+		required: ["kind", "runs"],
+		additionalProperties: false
+	},
+	ContentImageBlock: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "image"
+			},
+			format: {
+				type: "string",
+				enum: ["png", "jpeg"]
+			},
+			base64: { type: "string" },
+			widthPt: {
+				type: "number",
+				exclusiveMinimum: 0
+			},
+			heightPt: {
+				type: "number",
+				exclusiveMinimum: 0
+			},
+			altText: { type: "string" },
+			sourcePath: { type: "string" }
+		},
+		required: [
+			"kind",
+			"format",
+			"base64",
+			"widthPt",
+			"heightPt"
+		],
+		additionalProperties: false
+	},
+	ContentPageBreak: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "pageBreak"
+			},
+			sourcePath: { type: "string" }
+		},
+		required: ["kind"],
+		additionalProperties: false
+	},
+	ContentTableCell: {
+		type: "object",
+		properties: {
+			blocks: {
+				type: "array",
+				items: { $ref: "#/$defs/ContentBlock" }
+			},
+			colSpan: {
+				type: "integer",
+				exclusiveMinimum: 0,
+				maximum: MAX_SAFE_INTEGER
+			},
+			rowSpan: {
+				type: "integer",
+				exclusiveMinimum: 0,
+				maximum: MAX_SAFE_INTEGER
+			},
+			background: { $ref: "#/$defs/Color" },
+			borders: { $ref: "#/$defs/ContentCellBorders" },
+			sourcePath: { type: "string" }
+		},
+		required: ["blocks"],
+		additionalProperties: false
+	},
+	ContentTableRow: {
+		type: "object",
+		properties: {
+			cells: {
+				type: "array",
+				items: { $ref: "#/$defs/ContentTableCell" }
+			},
+			heightPt: {
+				type: "number",
+				exclusiveMinimum: 0
+			}
+		},
+		required: ["cells"],
+		additionalProperties: false
+	},
+	ContentTable: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "table"
+			},
+			rows: {
+				type: "array",
+				items: { $ref: "#/$defs/ContentTableRow" }
+			},
+			columnWidthsPt: {
+				type: "array",
+				items: {
+					type: "number",
+					exclusiveMinimum: 0
+				}
+			},
+			sourcePath: { type: "string" }
+		},
+		required: [
+			"kind",
+			"rows",
+			"columnWidthsPt"
+		],
+		additionalProperties: false
+	},
+	ContentEmbeddedObjectBlock: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "embeddedObject"
+			},
+			objectKind: {
+				type: "string",
+				enum: EMBEDDED_OBJECT_KINDS
+			},
+			document: { $ref: CONTENT_DOCUMENT_URI },
+			frame: { $ref: "#/$defs/Box" },
+			sourcePath: { type: "string" }
+		},
+		required: [
+			"kind",
+			"objectKind",
+			"document",
+			"frame"
+		],
+		additionalProperties: false
+	},
+	ContentBlock: { oneOf: [
+		{ $ref: "#/$defs/ContentParagraph" },
+		{ $ref: "#/$defs/ContentTable" },
+		{ $ref: "#/$defs/ContentImageBlock" },
+		{ $ref: "#/$defs/ContentPageBreak" },
+		{ $ref: "#/$defs/ContentEmbeddedObjectBlock" }
+	] },
+	MathMlAttribute: {
+		type: "object",
+		properties: {
+			name: { type: "string" },
+			value: { type: "string" }
+		},
+		required: ["name", "value"],
+		additionalProperties: false
+	},
+	MathMlElement: {
+		type: "object",
+		properties: {
+			type: {
+				type: "string",
+				const: "element"
+			},
+			tag: { type: "string" },
+			attributes: {
+				type: "array",
+				items: { $ref: "#/$defs/MathMlAttribute" }
+			},
+			children: {
+				type: "array",
+				items: { $ref: "#/$defs/MathMlNode" }
+			}
+		},
+		required: [
+			"type",
+			"tag",
+			"attributes",
+			"children"
+		],
+		additionalProperties: false
+	},
+	MathMlNode: { oneOf: [
+		{
+			type: "object",
+			properties: {
+				type: {
+					type: "string",
+					const: "text"
+				},
+				value: { type: "string" }
+			},
+			required: ["type", "value"],
+			additionalProperties: false
+		},
+		{
+			type: "object",
+			properties: {
+				type: {
+					type: "string",
+					const: "cdata"
+				},
+				value: { type: "string" }
+			},
+			required: ["type", "value"],
+			additionalProperties: false
+		},
+		{
+			type: "object",
+			properties: {
+				type: {
+					type: "string",
+					const: "comment"
+				},
+				value: { type: "string" }
+			},
+			required: ["type", "value"],
+			additionalProperties: false
+		},
+		{
+			type: "object",
+			properties: {
+				type: {
+					type: "string",
+					const: "declaration"
+				},
+				attributes: {
+					type: "array",
+					items: { $ref: "#/$defs/MathMlAttribute" }
+				}
+			},
+			required: ["type", "attributes"],
+			additionalProperties: false
+		},
+		{
+			type: "object",
+			properties: {
+				type: {
+					type: "string",
+					const: "pi"
+				},
+				target: { type: "string" },
+				content: { type: "string" }
+			},
+			required: [
+				"type",
+				"target",
+				"content"
+			],
+			additionalProperties: false
+		},
+		{ $ref: "#/$defs/MathMlElement" }
+	] }
+};
+//#endregion
+export { CONTENT_DEFS, CONTENT_DOCUMENT_URI, EMBEDDED_OBJECT_KINDS, MAX_SAFE_INTEGER };

package/dist/content.cjs

@@ -1,6 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_color = require("./color.cjs");
 const require_geometry = require("./geometry.cjs");
+const require_mathml = require("./mathml.cjs");
 const require_metadata = require("./metadata.cjs");
 const require_style = require("./style.cjs");
 let zod = require("zod");
@@ -81,11 +82,30 @@ function isContentBlock(value) {
 const ContentBlockSchema = zod.z.custom(isContentBlock);
 const ContentEmbeddedObjectSchema = zod.z.custom(isContentEmbeddedObject);
 const ContentEmbeddedObjectBlockSchema = zod.z.custom(isContentEmbeddedObjectBlock);
+const ContentStrokeStyleSchema = zod.z.enum([
+	"solid",
+	"dashed",
+	"dotted",
+	"double"
+]);
+const ContentBorderSchema = zod.z.object({
+	color: require_color.ColorSchema,
+	widthPt: zod.z.number().positive(),
+	style: ContentStrokeStyleSchema.optional()
+});
+const ContentCellBordersSchema = zod.z.object({
+	left: ContentBorderSchema.optional(),
+	right: ContentBorderSchema.optional(),
+	top: ContentBorderSchema.optional(),
+	bottom: ContentBorderSchema.optional()
+});
 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: require_color.ColorSchema.optional()
+	background: require_color.ColorSchema.optional(),
+	borders: ContentCellBordersSchema.optional(),
+	sourcePath: zod.z.string().optional()
 });
 const ContentTableRowSchema = zod.z.object({
 	cells: zod.z.array(ContentTableCellSchema),
@@ -112,6 +132,7 @@ const ContentShapeSchema = zod.z.object({
 	insetBottomPt: zod.z.number().nonnegative(),
 	fontScale: zod.z.number().positive().optional(),
 	lineSpacingReduction: zod.z.number().nonnegative().optional(),
+	paintOrder: zod.z.number().optional(),
 	sourcePath: zod.z.string().optional(),
 	blocks: zod.z.array(ContentBlockSchema)
 });
@@ -120,19 +141,23 @@ const ContentSlideSchema = zod.z.object({
 	shapes: zod.z.array(ContentShapeSchema),
 	notes: zod.z.string()
 });
+const DecimalStringSchema = zod.z.string().regex(/^-?(0|[1-9]\d*)(\.\d+)?$/);
 const ContentCellValueSchema = zod.z.discriminatedUnion("kind", [
 	zod.z.object({
 		kind: zod.z.literal("number"),
-		value: zod.z.number()
+		value: zod.z.number(),
+		exactValue: DecimalStringSchema.optional()
 	}),
 	zod.z.object({
 		kind: zod.z.literal("percentage"),
-		value: zod.z.number()
+		value: zod.z.number(),
+		exactValue: DecimalStringSchema.optional()
 	}),
 	zod.z.object({
 		kind: zod.z.literal("currency"),
 		value: zod.z.number(),
-		currency: zod.z.string().optional()
+		currency: zod.z.string().optional(),
+		exactValue: DecimalStringSchema.optional()
 	}),
 	zod.z.object({
 		kind: zod.z.literal("boolean"),
@@ -146,6 +171,10 @@ const ContentCellValueSchema = zod.z.discriminatedUnion("kind", [
 		kind: zod.z.literal("time"),
 		value: zod.z.string()
 	}),
+	zod.z.object({
+		kind: zod.z.literal("dateTime"),
+		value: zod.z.string()
+	}),
 	zod.z.object({
 		kind: zod.z.literal("string"),
 		value: zod.z.string()
@@ -164,16 +193,25 @@ const ContentSheetCellSchema = zod.z.object({
 	displayText: zod.z.string(),
 	runs: zod.z.array(ContentRunSchema).optional(),
 	colSpan: zod.z.number().int().positive().optional(),
-	rowSpan: zod.z.number().int().positive().optional()
+	rowSpan: zod.z.number().int().positive().optional(),
+	background: require_color.ColorSchema.optional(),
+	borders: ContentCellBordersSchema.optional(),
+	alignment: require_style.AlignmentSchema.optional(),
+	verticalAlignment: zod.z.enum([
+		"top",
+		"middle",
+		"bottom"
+	]).optional(),
+	sourcePath: zod.z.string().optional()
 });
 const ContentSheetColumnSchema = zod.z.object({
 	index: zod.z.number().int().nonnegative(),
-	widthPt: zod.z.number().nonnegative(),
+	widthPt: zod.z.number().positive().optional(),
 	hidden: zod.z.boolean().optional()
 });
 const ContentSheetRowSchema = zod.z.object({
 	index: zod.z.number().int().nonnegative(),
-	heightPt: zod.z.number().nonnegative(),
+	heightPt: zod.z.number().positive().optional(),
 	hidden: zod.z.boolean().optional()
 });
 const ContentSheetPrintRangeSchema = zod.z.object({
@@ -190,7 +228,7 @@ const ContentSheetPrintSettingsSchema = zod.z.object({
 	pageSize: require_geometry.PageSizeSchema,
 	margins: require_geometry.MarginsSchema,
 	printRange: ContentSheetPrintRangeSchema.optional(),
-	scale: zod.z.number().positive().optional(),
+	scalePercent: zod.z.number().positive().optional(),
 	fitToPages: zod.z.object({
 		width: zod.z.number().int().positive(),
 		height: zod.z.number().int().positive()
@@ -222,7 +260,8 @@ const ContentSheetSchema = zod.z.object({
 });
 const ContentStrokeSchema = zod.z.object({
 	color: require_color.ColorSchema,
-	widthPt: zod.z.number().positive()
+	widthPt: zod.z.number().positive(),
+	style: ContentStrokeStyleSchema.optional()
 });
 const ContentPathPointSchema = zod.z.object({
 	xPt: zod.z.number(),
@@ -246,15 +285,19 @@ const ContentVectorSchema = zod.z.discriminatedUnion("kind", [
 	zod.z.object({
 		kind: zod.z.literal("rect"),
 		frame: require_geometry.BoxSchema,
+		rotationDeg: zod.z.number().optional(),
 		fill: require_color.ColorSchema.optional(),
 		stroke: ContentStrokeSchema.optional(),
+		paintOrder: zod.z.number().optional(),
 		sourcePath: zod.z.string().optional()
 	}),
 	zod.z.object({
 		kind: zod.z.literal("ellipse"),
 		frame: require_geometry.BoxSchema,
+		rotationDeg: zod.z.number().optional(),
 		fill: require_color.ColorSchema.optional(),
 		stroke: ContentStrokeSchema.optional(),
+		paintOrder: zod.z.number().optional(),
 		sourcePath: zod.z.string().optional()
 	}),
 	zod.z.object({
@@ -262,15 +305,18 @@ const ContentVectorSchema = zod.z.discriminatedUnion("kind", [
 		from: ContentPathPointSchema,
 		to: ContentPathPointSchema,
 		stroke: ContentStrokeSchema,
+		paintOrder: zod.z.number().optional(),
 		sourcePath: zod.z.string().optional()
 	}),
 	zod.z.object({
 		kind: zod.z.literal("path"),
 		frame: require_geometry.BoxSchema,
+		rotationDeg: zod.z.number().optional(),
 		subpaths: zod.z.array(ContentSubpathSchema),
 		fill: require_color.ColorSchema.optional(),
 		fillRule: zod.z.enum(["nonzero", "evenodd"]).optional(),
 		stroke: ContentStrokeSchema.optional(),
+		paintOrder: zod.z.number().optional(),
 		sourcePath: zod.z.string().optional()
 	})
 ]);
@@ -279,41 +325,54 @@ const ContentDrawPageSchema = zod.z.object({
 	shapes: zod.z.array(ContentShapeSchema),
 	vectors: zod.z.array(ContentVectorSchema)
 });
-const CONTENT_FORMAT_VERSION = 1;
+const ContentFormulaSchema = zod.z.object({
+	mathml: zod.z.array(require_mathml.MathMlNodeSchema),
+	starMath: zod.z.string().optional()
+});
+const CONTENT_FORMAT_VERSION = 2;
 const ContentDocumentSchema = zod.z.discriminatedUnion("kind", [
 	zod.z.object({
 		kind: zod.z.literal("wordprocessing"),
-		formatVersion: zod.z.literal(1),
+		formatVersion: zod.z.literal(2),
 		metadata: require_metadata.LayoutMetadataSchema,
 		sections: zod.z.array(ContentSectionSchema)
 	}),
 	zod.z.object({
 		kind: zod.z.literal("presentation"),
-		formatVersion: zod.z.literal(1),
+		formatVersion: zod.z.literal(2),
 		metadata: require_metadata.LayoutMetadataSchema,
 		slides: zod.z.array(ContentSlideSchema)
 	}),
 	zod.z.object({
 		kind: zod.z.literal("spreadsheet"),
-		formatVersion: zod.z.literal(1),
+		formatVersion: zod.z.literal(2),
 		metadata: require_metadata.LayoutMetadataSchema,
 		sheets: zod.z.array(ContentSheetSchema)
 	}),
 	zod.z.object({
 		kind: zod.z.literal("drawing"),
-		formatVersion: zod.z.literal(1),
+		formatVersion: zod.z.literal(2),
 		metadata: require_metadata.LayoutMetadataSchema,
 		pages: zod.z.array(ContentDrawPageSchema)
+	}),
+	zod.z.object({
+		kind: zod.z.literal("formula"),
+		formatVersion: zod.z.literal(2),
+		metadata: require_metadata.LayoutMetadataSchema,
+		formula: ContentFormulaSchema
 	})
 ]);
 //#endregion
 exports.CONTENT_FORMAT_VERSION = CONTENT_FORMAT_VERSION;
 exports.ContentBlockSchema = ContentBlockSchema;
+exports.ContentBorderSchema = ContentBorderSchema;
+exports.ContentCellBordersSchema = ContentCellBordersSchema;
 exports.ContentCellValueSchema = ContentCellValueSchema;
 exports.ContentDocumentSchema = ContentDocumentSchema;
 exports.ContentDrawPageSchema = ContentDrawPageSchema;
 exports.ContentEmbeddedObjectBlockSchema = ContentEmbeddedObjectBlockSchema;
 exports.ContentEmbeddedObjectSchema = ContentEmbeddedObjectSchema;
+exports.ContentFormulaSchema = ContentFormulaSchema;
 exports.ContentImageBlockSchema = ContentImageBlockSchema;
 exports.ContentListMembershipSchema = ContentListMembershipSchema;
 exports.ContentPageBreakSchema = ContentPageBreakSchema;
@@ -333,9 +392,11 @@ exports.ContentSheetRowSchema = ContentSheetRowSchema;
 exports.ContentSheetSchema = ContentSheetSchema;
 exports.ContentSlideSchema = ContentSlideSchema;
 exports.ContentStrokeSchema = ContentStrokeSchema;
+exports.ContentStrokeStyleSchema = ContentStrokeStyleSchema;
 exports.ContentSubpathSchema = ContentSubpathSchema;
 exports.ContentTableCellSchema = ContentTableCellSchema;
 exports.ContentTableRowSchema = ContentTableRowSchema;
 exports.ContentTableSchema = ContentTableSchema;
 exports.ContentVectorSchema = ContentVectorSchema;
+exports.DecimalStringSchema = DecimalStringSchema;
 exports.isContentBlock = isContentBlock;