document-model.js 3.3.0 → 4.0.0

package/dist/package.js

@@ -1,12 +1,43 @@
 import { PageSizeSchema } from "./geometry.js";
-import { ContentDocumentSchema } from "./content.js";
+import { LayoutMetadataSchema } from "./metadata.js";
+import { ContentFormulaSchema, contentDocumentSharedFields } from "./content.js";
+import { DefinitionsTableSchema, StylesTableSchema } from "./definitions.js";
+import { DrawPageGroupSchema, SectionGroupSchema, SheetGroupSchema, SlideGroupSchema } from "./package-node.js";
 import { z } from "zod";
 //#region src/package.ts
-const DOCUMENT_PACKAGE_FORMAT_VERSION = 2;
-const DocumentPackageSchema = z.object({
-	formatVersion: z.literal(2),
-	content: ContentDocumentSchema,
-	pages: z.array(PageSizeSchema).optional()
-});
+const packageEnvelopeFields = {
+	metadata: LayoutMetadataSchema,
+	...contentDocumentSharedFields,
+	pages: z.array(PageSizeSchema).optional(),
+	styles: StylesTableSchema.optional(),
+	definitions: DefinitionsTableSchema.optional()
+};
+const DocumentPackageSchema = z.discriminatedUnion("kind", [
+	z.object({
+		kind: z.literal("wordprocessing"),
+		...packageEnvelopeFields,
+		children: z.array(SectionGroupSchema)
+	}),
+	z.object({
+		kind: z.literal("presentation"),
+		...packageEnvelopeFields,
+		children: z.array(SlideGroupSchema)
+	}),
+	z.object({
+		kind: z.literal("spreadsheet"),
+		...packageEnvelopeFields,
+		children: z.array(SheetGroupSchema)
+	}),
+	z.object({
+		kind: z.literal("drawing"),
+		...packageEnvelopeFields,
+		children: z.array(DrawPageGroupSchema)
+	}),
+	z.object({
+		kind: z.literal("formula"),
+		...packageEnvelopeFields,
+		children: z.array(ContentFormulaSchema).length(1)
+	})
+]);
 //#endregion
-export { DOCUMENT_PACKAGE_FORMAT_VERSION, DocumentPackageSchema };
+export { DocumentPackageSchema };

package/dist/schema-io.cjs

@@ -1,36 +1,47 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_content = require("./content.cjs");
-const require_layout = require("./layout.cjs");
 const require_package = require("./package.cjs");
 //#region src/schema-io.ts
 const SCHEMA_FILE_NAMES = {
 	DocumentPackage: "document-package.schema.json",
-	ContentDocument: "content-document.schema.json",
-	LayoutDocument: "layout-document.schema.json"
+	ContentDocument: "content-document.schema.json"
 };
 function schemaUriFor(kind) {
-	return `https://cdn.jsdelivr.net/npm/document-schema.js@3.3.0/schemas/${SCHEMA_FILE_NAMES[kind]}`;
+	return `https://cdn.jsdelivr.net/npm/document-schema.js@4.0.0/schemas/${SCHEMA_FILE_NAMES[kind]}`;
+}
+const SCHEMA_URI_PATTERN = /^https:\/\/cdn\.jsdelivr\.net\/npm\/document-schema\.js@([^/]+)\/schemas\/(document-package|content-document|layout-document)\.schema\.json$/;
+function parseSchemaUri(uri) {
+	const match = SCHEMA_URI_PATTERN.exec(uri);
+	if (match === null) return void 0;
+	const version = match[1];
+	const stem = match[2];
+	if (version === void 0 || stem === void 0) return void 0;
+	return {
+		version,
+		stem
+	};
 }
-const SCHEMA_URI_PATTERN = /^https:\/\/cdn\.jsdelivr\.net\/npm\/document-schema\.js@[^/]+\/schemas\/(document-package|content-document|layout-document)\.schema\.json$/;
 function kindForFileStem(stem) {
 	switch (stem) {
 		case "document-package": return "DocumentPackage";
 		case "content-document": return "ContentDocument";
-		case "layout-document": return "LayoutDocument";
 		default: return;
 	}
 }
+function majorVersionOf(version) {
+	const match = /^(\d+)/.exec(version);
+	if (match?.[1] === void 0) return void 0;
+	return Number(match[1]);
+}
 function isRecord(value) {
 	return typeof value === "object" && value !== null && !Array.isArray(value);
 }
 function documentSchemaKindOf(value) {
 	if (!isRecord(value)) return void 0;
 	if (!("$schema" in value) || typeof value.$schema !== "string") return void 0;
-	const match = SCHEMA_URI_PATTERN.exec(value.$schema);
-	if (match === null) return void 0;
-	const stem = match[1];
-	if (stem === void 0) return void 0;
-	return kindForFileStem(stem);
+	const parts = parseSchemaUri(value.$schema);
+	if (parts === void 0) return void 0;
+	return kindForFileStem(parts.stem);
 }
 function documentPackageWithSchema(value) {
 	return {
@@ -44,23 +55,45 @@ function contentDocumentWithSchema(value) {
 		...value
 	};
 }
-function layoutDocumentWithSchema(value) {
-	return {
-		$schema: schemaUriFor("LayoutDocument"),
-		...value
-	};
-}
 var UnrecognizedDocumentSchemaError = class extends Error {
 	schema;
 	constructor(schema) {
-		super(`documentFromJson: value has no recognized "$schema" property (expected one of the three document-schema.js .schema.json URIs; found: ${JSON.stringify(schema)}).`);
+		super(`documentFromJson: value has no recognized "$schema" property (expected one of the document-schema.js .schema.json URIs; found: ${JSON.stringify(schema)}).`);
 		this.name = "UnrecognizedDocumentSchemaError";
 		this.schema = schema;
 	}
 };
+var LayoutSchemaDemotedError = class extends Error {
+	schema;
+	constructor(schema) {
+		super(`documentFromJson: this value is a layout-document dump (${schema}), and LayoutDocument moved to pdf-codec in document-schema.js 4.0.0 (ExaDev/pdf-codec#65). Read it with pdf-codec's own layout model, or with a document-schema.js 3.x release.`);
+		this.name = "LayoutSchemaDemotedError";
+		this.schema = schema;
+	}
+};
+var SchemaVersionMismatchError = class extends Error {
+	schema;
+	dumpVersion;
+	installedVersion;
+	constructor(schema, dumpVersion, installedVersion) {
+		const dumpMajor = majorVersionOf(dumpVersion);
+		const installedMajor = majorVersionOf(installedVersion);
+		const isOlder = dumpMajor !== void 0 && installedMajor !== void 0 && dumpMajor < installedMajor;
+		super(`documentFromJson: this dump's $schema pins document-schema.js@${dumpVersion}, but the installed release is @${installedVersion}, and a dump only parses under the major that wrote it.` + (isOlder ? ` Dumps from before 4.0.0 carry the retired formatVersion field and (for packages) the flat { formatVersion, content, pages } shape, replaced in 4.0.0 by the tree-form DocumentPackage (ExaDev/document-schema.js#20). Re-dump the value with a 4.x release, or parse it with the release that produced it.` : ` Upgrade document-schema.js to read it.`));
+		this.name = "SchemaVersionMismatchError";
+		this.schema = schema;
+		this.dumpVersion = dumpVersion;
+		this.installedVersion = installedVersion;
+	}
+};
 function documentFromJson(value) {
-	const kind = documentSchemaKindOf(value);
-	if (kind === void 0) throw new UnrecognizedDocumentSchemaError(isRecord(value) ? value.$schema : void 0);
+	if (!isRecord(value) || typeof value.$schema !== "string") throw new UnrecognizedDocumentSchemaError(isRecord(value) ? value.$schema : void 0);
+	const parts = parseSchemaUri(value.$schema);
+	if (parts === void 0) throw new UnrecognizedDocumentSchemaError(value.$schema);
+	if (parts.stem === "layout-document") throw new LayoutSchemaDemotedError(value.$schema);
+	const kind = kindForFileStem(parts.stem);
+	if (kind === void 0) throw new UnrecognizedDocumentSchemaError(value.$schema);
+	if (majorVersionOf(parts.version) !== majorVersionOf("4.0.0")) throw new SchemaVersionMismatchError(value.$schema, parts.version, "4.0.0");
 	switch (kind) {
 		case "DocumentPackage": return {
 			kind,
@@ -70,18 +103,15 @@ function documentFromJson(value) {
 			kind,
 			value: require_content.ContentDocumentSchema.parse(value)
 		};
-		case "LayoutDocument": return {
-			kind,
-			value: require_layout.LayoutDocumentSchema.parse(value)
-		};
 	}
 }
 //#endregion
+exports.LayoutSchemaDemotedError = LayoutSchemaDemotedError;
 exports.SCHEMA_FILE_NAMES = SCHEMA_FILE_NAMES;
+exports.SchemaVersionMismatchError = SchemaVersionMismatchError;
 exports.UnrecognizedDocumentSchemaError = UnrecognizedDocumentSchemaError;
 exports.contentDocumentWithSchema = contentDocumentWithSchema;
 exports.documentFromJson = documentFromJson;
 exports.documentPackageWithSchema = documentPackageWithSchema;
 exports.documentSchemaKindOf = documentSchemaKindOf;
-exports.layoutDocumentWithSchema = layoutDocumentWithSchema;
 exports.schemaUriFor = schemaUriFor;

package/dist/schema-io.d.cts

@@ -1,8 +1,7 @@
-import { ContentDocument } from "./content.cjs";
-import { LayoutDocument } from "./layout.cjs";
+import { l as ContentDocument } from "./content-BN0PWqpt.cjs";
 import { DocumentPackage } from "./package.cjs";
 //#region src/schema-io.d.ts
-type DocumentSchemaKind = 'DocumentPackage' | 'ContentDocument' | 'LayoutDocument';
+type DocumentSchemaKind = 'DocumentPackage' | 'ContentDocument';
 declare const SCHEMA_FILE_NAMES: Record<DocumentSchemaKind, string>;
 declare function schemaUriFor(kind: DocumentSchemaKind): string;
 declare function documentSchemaKindOf(value: unknown): DocumentSchemaKind | undefined;
@@ -12,26 +11,29 @@ type DocumentPackageJson = DocumentPackage & {
 type ContentDocumentJson = ContentDocument & {
   readonly $schema: string;
 };
-type LayoutDocumentJson = LayoutDocument & {
-  readonly $schema: string;
-};
 declare function documentPackageWithSchema(value: DocumentPackage): DocumentPackageJson;
 declare function contentDocumentWithSchema(value: ContentDocument): ContentDocumentJson;
-declare function layoutDocumentWithSchema(value: LayoutDocument): LayoutDocumentJson;
 declare class UnrecognizedDocumentSchemaError extends Error {
   readonly schema: unknown;
   constructor(schema: unknown);
 }
+declare class LayoutSchemaDemotedError extends Error {
+  readonly schema: string;
+  constructor(schema: string);
+}
+declare class SchemaVersionMismatchError extends Error {
+  readonly schema: string;
+  readonly dumpVersion: string;
+  readonly installedVersion: string;
+  constructor(schema: string, dumpVersion: string, installedVersion: string);
+}
 type DocumentJsonResult = {
   kind: 'DocumentPackage';
   value: DocumentPackage;
 } | {
   kind: 'ContentDocument';
   value: ContentDocument;
-} | {
-  kind: 'LayoutDocument';
-  value: LayoutDocument;
 };
 declare function documentFromJson(value: unknown): DocumentJsonResult;
 //#endregion
-export { ContentDocumentJson, DocumentJsonResult, DocumentPackageJson, DocumentSchemaKind, LayoutDocumentJson, SCHEMA_FILE_NAMES, UnrecognizedDocumentSchemaError, contentDocumentWithSchema, documentFromJson, documentPackageWithSchema, documentSchemaKindOf, layoutDocumentWithSchema, schemaUriFor };
+export { ContentDocumentJson, DocumentJsonResult, DocumentPackageJson, DocumentSchemaKind, LayoutSchemaDemotedError, SCHEMA_FILE_NAMES, SchemaVersionMismatchError, UnrecognizedDocumentSchemaError, contentDocumentWithSchema, documentFromJson, documentPackageWithSchema, documentSchemaKindOf, schemaUriFor };

package/dist/schema-io.d.ts

@@ -1,8 +1,7 @@
-import { ContentDocument } from "./content.js";
-import { LayoutDocument } from "./layout.js";
+import { l as ContentDocument } from "./content-CiZf6Fqn.js";
 import { DocumentPackage } from "./package.js";
 //#region src/schema-io.d.ts
-type DocumentSchemaKind = 'DocumentPackage' | 'ContentDocument' | 'LayoutDocument';
+type DocumentSchemaKind = 'DocumentPackage' | 'ContentDocument';
 declare const SCHEMA_FILE_NAMES: Record<DocumentSchemaKind, string>;
 declare function schemaUriFor(kind: DocumentSchemaKind): string;
 declare function documentSchemaKindOf(value: unknown): DocumentSchemaKind | undefined;
@@ -12,26 +11,29 @@ type DocumentPackageJson = DocumentPackage & {
 type ContentDocumentJson = ContentDocument & {
   readonly $schema: string;
 };
-type LayoutDocumentJson = LayoutDocument & {
-  readonly $schema: string;
-};
 declare function documentPackageWithSchema(value: DocumentPackage): DocumentPackageJson;
 declare function contentDocumentWithSchema(value: ContentDocument): ContentDocumentJson;
-declare function layoutDocumentWithSchema(value: LayoutDocument): LayoutDocumentJson;
 declare class UnrecognizedDocumentSchemaError extends Error {
   readonly schema: unknown;
   constructor(schema: unknown);
 }
+declare class LayoutSchemaDemotedError extends Error {
+  readonly schema: string;
+  constructor(schema: string);
+}
+declare class SchemaVersionMismatchError extends Error {
+  readonly schema: string;
+  readonly dumpVersion: string;
+  readonly installedVersion: string;
+  constructor(schema: string, dumpVersion: string, installedVersion: string);
+}
 type DocumentJsonResult = {
   kind: 'DocumentPackage';
   value: DocumentPackage;
 } | {
   kind: 'ContentDocument';
   value: ContentDocument;
-} | {
-  kind: 'LayoutDocument';
-  value: LayoutDocument;
 };
 declare function documentFromJson(value: unknown): DocumentJsonResult;
 //#endregion
-export { ContentDocumentJson, DocumentJsonResult, DocumentPackageJson, DocumentSchemaKind, LayoutDocumentJson, SCHEMA_FILE_NAMES, UnrecognizedDocumentSchemaError, contentDocumentWithSchema, documentFromJson, documentPackageWithSchema, documentSchemaKindOf, layoutDocumentWithSchema, schemaUriFor };
+export { ContentDocumentJson, DocumentJsonResult, DocumentPackageJson, DocumentSchemaKind, LayoutSchemaDemotedError, SCHEMA_FILE_NAMES, SchemaVersionMismatchError, UnrecognizedDocumentSchemaError, contentDocumentWithSchema, documentFromJson, documentPackageWithSchema, documentSchemaKindOf, schemaUriFor };

package/dist/schema-io.js

@@ -1,35 +1,46 @@
 import { ContentDocumentSchema } from "./content.js";
-import { LayoutDocumentSchema } from "./layout.js";
 import { DocumentPackageSchema } from "./package.js";
 //#region src/schema-io.ts
 const SCHEMA_FILE_NAMES = {
 	DocumentPackage: "document-package.schema.json",
-	ContentDocument: "content-document.schema.json",
-	LayoutDocument: "layout-document.schema.json"
+	ContentDocument: "content-document.schema.json"
 };
 function schemaUriFor(kind) {
-	return `https://cdn.jsdelivr.net/npm/document-schema.js@3.3.0/schemas/${SCHEMA_FILE_NAMES[kind]}`;
+	return `https://cdn.jsdelivr.net/npm/document-schema.js@4.0.0/schemas/${SCHEMA_FILE_NAMES[kind]}`;
+}
+const SCHEMA_URI_PATTERN = /^https:\/\/cdn\.jsdelivr\.net\/npm\/document-schema\.js@([^/]+)\/schemas\/(document-package|content-document|layout-document)\.schema\.json$/;
+function parseSchemaUri(uri) {
+	const match = SCHEMA_URI_PATTERN.exec(uri);
+	if (match === null) return void 0;
+	const version = match[1];
+	const stem = match[2];
+	if (version === void 0 || stem === void 0) return void 0;
+	return {
+		version,
+		stem
+	};
 }
-const SCHEMA_URI_PATTERN = /^https:\/\/cdn\.jsdelivr\.net\/npm\/document-schema\.js@[^/]+\/schemas\/(document-package|content-document|layout-document)\.schema\.json$/;
 function kindForFileStem(stem) {
 	switch (stem) {
 		case "document-package": return "DocumentPackage";
 		case "content-document": return "ContentDocument";
-		case "layout-document": return "LayoutDocument";
 		default: return;
 	}
 }
+function majorVersionOf(version) {
+	const match = /^(\d+)/.exec(version);
+	if (match?.[1] === void 0) return void 0;
+	return Number(match[1]);
+}
 function isRecord(value) {
 	return typeof value === "object" && value !== null && !Array.isArray(value);
 }
 function documentSchemaKindOf(value) {
 	if (!isRecord(value)) return void 0;
 	if (!("$schema" in value) || typeof value.$schema !== "string") return void 0;
-	const match = SCHEMA_URI_PATTERN.exec(value.$schema);
-	if (match === null) return void 0;
-	const stem = match[1];
-	if (stem === void 0) return void 0;
-	return kindForFileStem(stem);
+	const parts = parseSchemaUri(value.$schema);
+	if (parts === void 0) return void 0;
+	return kindForFileStem(parts.stem);
 }
 function documentPackageWithSchema(value) {
 	return {
@@ -43,23 +54,45 @@ function contentDocumentWithSchema(value) {
 		...value
 	};
 }
-function layoutDocumentWithSchema(value) {
-	return {
-		$schema: schemaUriFor("LayoutDocument"),
-		...value
-	};
-}
 var UnrecognizedDocumentSchemaError = class extends Error {
 	schema;
 	constructor(schema) {
-		super(`documentFromJson: value has no recognized "$schema" property (expected one of the three document-schema.js .schema.json URIs; found: ${JSON.stringify(schema)}).`);
+		super(`documentFromJson: value has no recognized "$schema" property (expected one of the document-schema.js .schema.json URIs; found: ${JSON.stringify(schema)}).`);
 		this.name = "UnrecognizedDocumentSchemaError";
 		this.schema = schema;
 	}
 };
+var LayoutSchemaDemotedError = class extends Error {
+	schema;
+	constructor(schema) {
+		super(`documentFromJson: this value is a layout-document dump (${schema}), and LayoutDocument moved to pdf-codec in document-schema.js 4.0.0 (ExaDev/pdf-codec#65). Read it with pdf-codec's own layout model, or with a document-schema.js 3.x release.`);
+		this.name = "LayoutSchemaDemotedError";
+		this.schema = schema;
+	}
+};
+var SchemaVersionMismatchError = class extends Error {
+	schema;
+	dumpVersion;
+	installedVersion;
+	constructor(schema, dumpVersion, installedVersion) {
+		const dumpMajor = majorVersionOf(dumpVersion);
+		const installedMajor = majorVersionOf(installedVersion);
+		const isOlder = dumpMajor !== void 0 && installedMajor !== void 0 && dumpMajor < installedMajor;
+		super(`documentFromJson: this dump's $schema pins document-schema.js@${dumpVersion}, but the installed release is @${installedVersion}, and a dump only parses under the major that wrote it.` + (isOlder ? ` Dumps from before 4.0.0 carry the retired formatVersion field and (for packages) the flat { formatVersion, content, pages } shape, replaced in 4.0.0 by the tree-form DocumentPackage (ExaDev/document-schema.js#20). Re-dump the value with a 4.x release, or parse it with the release that produced it.` : ` Upgrade document-schema.js to read it.`));
+		this.name = "SchemaVersionMismatchError";
+		this.schema = schema;
+		this.dumpVersion = dumpVersion;
+		this.installedVersion = installedVersion;
+	}
+};
 function documentFromJson(value) {
-	const kind = documentSchemaKindOf(value);
-	if (kind === void 0) throw new UnrecognizedDocumentSchemaError(isRecord(value) ? value.$schema : void 0);
+	if (!isRecord(value) || typeof value.$schema !== "string") throw new UnrecognizedDocumentSchemaError(isRecord(value) ? value.$schema : void 0);
+	const parts = parseSchemaUri(value.$schema);
+	if (parts === void 0) throw new UnrecognizedDocumentSchemaError(value.$schema);
+	if (parts.stem === "layout-document") throw new LayoutSchemaDemotedError(value.$schema);
+	const kind = kindForFileStem(parts.stem);
+	if (kind === void 0) throw new UnrecognizedDocumentSchemaError(value.$schema);
+	if (majorVersionOf(parts.version) !== majorVersionOf("4.0.0")) throw new SchemaVersionMismatchError(value.$schema, parts.version, "4.0.0");
 	switch (kind) {
 		case "DocumentPackage": return {
 			kind,
@@ -69,11 +102,7 @@ function documentFromJson(value) {
 			kind,
 			value: ContentDocumentSchema.parse(value)
 		};
-		case "LayoutDocument": return {
-			kind,
-			value: LayoutDocumentSchema.parse(value)
-		};
 	}
 }
 //#endregion
-export { SCHEMA_FILE_NAMES, UnrecognizedDocumentSchemaError, contentDocumentWithSchema, documentFromJson, documentPackageWithSchema, documentSchemaKindOf, layoutDocumentWithSchema, schemaUriFor };
+export { LayoutSchemaDemotedError, SCHEMA_FILE_NAMES, SchemaVersionMismatchError, UnrecognizedDocumentSchemaError, contentDocumentWithSchema, documentFromJson, documentPackageWithSchema, documentSchemaKindOf, schemaUriFor };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "document-model.js",
-  "version": "3.3.0",
-  "description": "The canonical, format-agnostic content and layout schemas shared by ooxml.js, odf.js, and documents.js -- pure Zod schemas, no behaviour.",
+  "version": "4.0.0",
+  "description": "The canonical, format-agnostic content and document-package schemas shared by ooxml.js, odf.js, documents.js, pdf-codec, and markdown-codec -- pure Zod schemas, no behaviour.",
   "type": "module",
   "repository": {
     "type": "git",