document-model.js 4.0.0 → 4.1.0

package/dist/construct.js

@@ -0,0 +1,93 @@
+import { z } from "zod";
+//#region src/construct.ts
+const ContentControlTypeSchema = z.enum([
+	"richText",
+	"plainText",
+	"checkbox",
+	"dropDown",
+	"comboBox",
+	"date",
+	"picture",
+	"repeatingSection",
+	"button",
+	"index",
+	"group"
+]);
+const ContentControlLockSchema = z.enum([
+	"content",
+	"container",
+	"both"
+]);
+const ContentControlDescriptorSchema = z.strictObject({
+	kind: z.literal("contentControl"),
+	controlType: ContentControlTypeSchema,
+	tag: z.string().optional(),
+	alias: z.string().optional(),
+	lock: ContentControlLockSchema.optional(),
+	value: z.string().optional(),
+	checked: z.boolean().optional(),
+	options: z.array(z.string()).optional()
+});
+const FieldDescriptorSchema = z.strictObject({
+	kind: z.literal("field"),
+	instruction: z.string(),
+	cachedResult: z.string().optional()
+});
+const AnchorTypeSchema = z.enum([
+	"bookmark",
+	"footnote",
+	"endnote",
+	"comment"
+]);
+const AnchorDescriptorSchema = z.strictObject({
+	kind: z.literal("anchor"),
+	anchorType: AnchorTypeSchema,
+	name: z.string(),
+	definition: z.string().optional()
+});
+const LinkTargetSchema = z.discriminatedUnion("kind", [z.strictObject({
+	kind: z.literal("external"),
+	uri: z.string()
+}), z.strictObject({
+	kind: z.literal("internal"),
+	anchor: z.string()
+})]);
+const LinkDescriptorSchema = z.strictObject({
+	kind: z.literal("link"),
+	target: LinkTargetSchema,
+	title: z.string().optional()
+});
+const ProvenanceChangeSchema = z.enum([
+	"insertion",
+	"deletion",
+	"moveFrom",
+	"moveTo",
+	"formatChange"
+]);
+const ProvenanceDescriptorSchema = z.strictObject({
+	kind: z.literal("provenance"),
+	change: ProvenanceChangeSchema,
+	author: z.string().optional(),
+	dateIso: z.string().optional()
+});
+const DivisionSourceSchema = z.strictObject({
+	href: z.string(),
+	sectionName: z.string().optional()
+});
+const DivisionDescriptorSchema = z.strictObject({
+	kind: z.literal("division"),
+	name: z.string().optional(),
+	columnCount: z.number().int().positive().optional(),
+	protected: z.boolean().optional(),
+	source: DivisionSourceSchema.optional()
+});
+const ConstructDescriptorSchema = z.discriminatedUnion("kind", [
+	ContentControlDescriptorSchema,
+	FieldDescriptorSchema,
+	AnchorDescriptorSchema,
+	LinkDescriptorSchema,
+	ProvenanceDescriptorSchema,
+	DivisionDescriptorSchema
+]);
+//#endregion
+export { AnchorDescriptorSchema, AnchorTypeSchema, ConstructDescriptorSchema, ContentControlDescriptorSchema, ContentControlLockSchema, ContentControlTypeSchema, DivisionDescriptorSchema, DivisionSourceSchema, FieldDescriptorSchema, LinkDescriptorSchema, LinkTargetSchema, ProvenanceChangeSchema, ProvenanceDescriptorSchema };

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

@@ -1267,6 +1267,7 @@ const CONTENT_DEFS = {
 				items: { oneOf: [
 					{ $ref: "#/$defs/HeadingGroup" },
 					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/SectionConstructGroup" },
 					{ $ref: "#/$defs/ContentBlock" }
 				] }
 			}
@@ -1284,6 +1285,7 @@ const CONTENT_DEFS = {
 				items: { oneOf: [
 					{ $ref: "#/$defs/HeadingGroup" },
 					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/SectionConstructGroup" },
 					{ $ref: "#/$defs/ContentBlock" }
 				] }
 			}
@@ -1298,7 +1300,11 @@ const CONTENT_DEFS = {
 			style: { type: "string" },
 			children: {
 				type: "array",
-				items: { oneOf: [{ $ref: "#/$defs/ListGroup" }, { $ref: "#/$defs/ContentBlock" }] }
+				items: { oneOf: [
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/ShapeConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
 			}
 		},
 		required: ["node", "children"],
@@ -1324,7 +1330,11 @@ const CONTENT_DEFS = {
 			style: { type: "string" },
 			children: {
 				type: "array",
-				items: { oneOf: [{ $ref: "#/$defs/ListGroup" }, { $ref: "#/$defs/ContentBlock" }] }
+				items: { oneOf: [
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/ShapeConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
 			}
 		},
 		required: ["node", "children"],
@@ -1356,6 +1366,218 @@ const CONTENT_DEFS = {
 		required: ["node", "children"],
 		additionalProperties: false
 	},
+	SectionConstructGroup: {
+		type: "object",
+		properties: {
+			node: { $ref: "#/$defs/ConstructDescriptor" },
+			style: { type: "string" },
+			children: {
+				type: "array",
+				items: { oneOf: [
+					{ $ref: "#/$defs/HeadingGroup" },
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/SectionConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
+			}
+		},
+		required: ["node", "children"],
+		additionalProperties: false
+	},
+	ShapeConstructGroup: {
+		type: "object",
+		properties: {
+			node: { $ref: "#/$defs/ConstructDescriptor" },
+			style: { type: "string" },
+			children: {
+				type: "array",
+				items: { oneOf: [
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/ShapeConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
+			}
+		},
+		required: ["node", "children"],
+		additionalProperties: false
+	},
+	ContentControlDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "contentControl"
+			},
+			controlType: {
+				type: "string",
+				enum: [
+					"richText",
+					"plainText",
+					"checkbox",
+					"dropDown",
+					"comboBox",
+					"date",
+					"picture",
+					"repeatingSection",
+					"button",
+					"index",
+					"group"
+				]
+			},
+			tag: { type: "string" },
+			alias: { type: "string" },
+			lock: {
+				type: "string",
+				enum: [
+					"content",
+					"container",
+					"both"
+				]
+			},
+			value: { type: "string" },
+			checked: { type: "boolean" },
+			options: {
+				type: "array",
+				items: { type: "string" }
+			}
+		},
+		required: ["kind", "controlType"],
+		additionalProperties: false
+	},
+	FieldDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "field"
+			},
+			instruction: { type: "string" },
+			cachedResult: { type: "string" }
+		},
+		required: ["kind", "instruction"],
+		additionalProperties: false
+	},
+	AnchorDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "anchor"
+			},
+			anchorType: {
+				type: "string",
+				enum: [
+					"bookmark",
+					"footnote",
+					"endnote",
+					"comment"
+				]
+			},
+			name: { type: "string" },
+			definition: { type: "string" }
+		},
+		required: [
+			"kind",
+			"anchorType",
+			"name"
+		],
+		additionalProperties: false
+	},
+	LinkTarget: { oneOf: [{
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "external"
+			},
+			uri: { type: "string" }
+		},
+		required: ["kind", "uri"],
+		additionalProperties: false
+	}, {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "internal"
+			},
+			anchor: { type: "string" }
+		},
+		required: ["kind", "anchor"],
+		additionalProperties: false
+	}] },
+	LinkDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "link"
+			},
+			target: { $ref: "#/$defs/LinkTarget" },
+			title: { type: "string" }
+		},
+		required: ["kind", "target"],
+		additionalProperties: false
+	},
+	ProvenanceDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "provenance"
+			},
+			change: {
+				type: "string",
+				enum: [
+					"insertion",
+					"deletion",
+					"moveFrom",
+					"moveTo",
+					"formatChange"
+				]
+			},
+			author: { type: "string" },
+			dateIso: { type: "string" }
+		},
+		required: ["kind", "change"],
+		additionalProperties: false
+	},
+	DivisionSource: {
+		type: "object",
+		properties: {
+			href: { type: "string" },
+			sectionName: { type: "string" }
+		},
+		required: ["href"],
+		additionalProperties: false
+	},
+	DivisionDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "division"
+			},
+			name: { type: "string" },
+			columnCount: {
+				type: "integer",
+				exclusiveMinimum: 0,
+				maximum: MAX_SAFE_INTEGER
+			},
+			protected: { type: "boolean" },
+			source: { $ref: "#/$defs/DivisionSource" }
+		},
+		required: ["kind"],
+		additionalProperties: false
+	},
+	ConstructDescriptor: { oneOf: [
+		{ $ref: "#/$defs/ContentControlDescriptor" },
+		{ $ref: "#/$defs/FieldDescriptor" },
+		{ $ref: "#/$defs/AnchorDescriptor" },
+		{ $ref: "#/$defs/LinkDescriptor" },
+		{ $ref: "#/$defs/ProvenanceDescriptor" },
+		{ $ref: "#/$defs/DivisionDescriptor" }
+	] },
 	StyleParagraphProperties: {
 		type: "object",
 		properties: {

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

@@ -1266,6 +1266,7 @@ const CONTENT_DEFS = {
 				items: { oneOf: [
 					{ $ref: "#/$defs/HeadingGroup" },
 					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/SectionConstructGroup" },
 					{ $ref: "#/$defs/ContentBlock" }
 				] }
 			}
@@ -1283,6 +1284,7 @@ const CONTENT_DEFS = {
 				items: { oneOf: [
 					{ $ref: "#/$defs/HeadingGroup" },
 					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/SectionConstructGroup" },
 					{ $ref: "#/$defs/ContentBlock" }
 				] }
 			}
@@ -1297,7 +1299,11 @@ const CONTENT_DEFS = {
 			style: { type: "string" },
 			children: {
 				type: "array",
-				items: { oneOf: [{ $ref: "#/$defs/ListGroup" }, { $ref: "#/$defs/ContentBlock" }] }
+				items: { oneOf: [
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/ShapeConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
 			}
 		},
 		required: ["node", "children"],
@@ -1323,7 +1329,11 @@ const CONTENT_DEFS = {
 			style: { type: "string" },
 			children: {
 				type: "array",
-				items: { oneOf: [{ $ref: "#/$defs/ListGroup" }, { $ref: "#/$defs/ContentBlock" }] }
+				items: { oneOf: [
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/ShapeConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
 			}
 		},
 		required: ["node", "children"],
@@ -1355,6 +1365,218 @@ const CONTENT_DEFS = {
 		required: ["node", "children"],
 		additionalProperties: false
 	},
+	SectionConstructGroup: {
+		type: "object",
+		properties: {
+			node: { $ref: "#/$defs/ConstructDescriptor" },
+			style: { type: "string" },
+			children: {
+				type: "array",
+				items: { oneOf: [
+					{ $ref: "#/$defs/HeadingGroup" },
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/SectionConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
+			}
+		},
+		required: ["node", "children"],
+		additionalProperties: false
+	},
+	ShapeConstructGroup: {
+		type: "object",
+		properties: {
+			node: { $ref: "#/$defs/ConstructDescriptor" },
+			style: { type: "string" },
+			children: {
+				type: "array",
+				items: { oneOf: [
+					{ $ref: "#/$defs/ListGroup" },
+					{ $ref: "#/$defs/ShapeConstructGroup" },
+					{ $ref: "#/$defs/ContentBlock" }
+				] }
+			}
+		},
+		required: ["node", "children"],
+		additionalProperties: false
+	},
+	ContentControlDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "contentControl"
+			},
+			controlType: {
+				type: "string",
+				enum: [
+					"richText",
+					"plainText",
+					"checkbox",
+					"dropDown",
+					"comboBox",
+					"date",
+					"picture",
+					"repeatingSection",
+					"button",
+					"index",
+					"group"
+				]
+			},
+			tag: { type: "string" },
+			alias: { type: "string" },
+			lock: {
+				type: "string",
+				enum: [
+					"content",
+					"container",
+					"both"
+				]
+			},
+			value: { type: "string" },
+			checked: { type: "boolean" },
+			options: {
+				type: "array",
+				items: { type: "string" }
+			}
+		},
+		required: ["kind", "controlType"],
+		additionalProperties: false
+	},
+	FieldDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "field"
+			},
+			instruction: { type: "string" },
+			cachedResult: { type: "string" }
+		},
+		required: ["kind", "instruction"],
+		additionalProperties: false
+	},
+	AnchorDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "anchor"
+			},
+			anchorType: {
+				type: "string",
+				enum: [
+					"bookmark",
+					"footnote",
+					"endnote",
+					"comment"
+				]
+			},
+			name: { type: "string" },
+			definition: { type: "string" }
+		},
+		required: [
+			"kind",
+			"anchorType",
+			"name"
+		],
+		additionalProperties: false
+	},
+	LinkTarget: { oneOf: [{
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "external"
+			},
+			uri: { type: "string" }
+		},
+		required: ["kind", "uri"],
+		additionalProperties: false
+	}, {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "internal"
+			},
+			anchor: { type: "string" }
+		},
+		required: ["kind", "anchor"],
+		additionalProperties: false
+	}] },
+	LinkDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "link"
+			},
+			target: { $ref: "#/$defs/LinkTarget" },
+			title: { type: "string" }
+		},
+		required: ["kind", "target"],
+		additionalProperties: false
+	},
+	ProvenanceDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "provenance"
+			},
+			change: {
+				type: "string",
+				enum: [
+					"insertion",
+					"deletion",
+					"moveFrom",
+					"moveTo",
+					"formatChange"
+				]
+			},
+			author: { type: "string" },
+			dateIso: { type: "string" }
+		},
+		required: ["kind", "change"],
+		additionalProperties: false
+	},
+	DivisionSource: {
+		type: "object",
+		properties: {
+			href: { type: "string" },
+			sectionName: { type: "string" }
+		},
+		required: ["href"],
+		additionalProperties: false
+	},
+	DivisionDescriptor: {
+		type: "object",
+		properties: {
+			kind: {
+				type: "string",
+				const: "division"
+			},
+			name: { type: "string" },
+			columnCount: {
+				type: "integer",
+				exclusiveMinimum: 0,
+				maximum: MAX_SAFE_INTEGER
+			},
+			protected: { type: "boolean" },
+			source: { $ref: "#/$defs/DivisionSource" }
+		},
+		required: ["kind"],
+		additionalProperties: false
+	},
+	ConstructDescriptor: { oneOf: [
+		{ $ref: "#/$defs/ContentControlDescriptor" },
+		{ $ref: "#/$defs/FieldDescriptor" },
+		{ $ref: "#/$defs/AnchorDescriptor" },
+		{ $ref: "#/$defs/LinkDescriptor" },
+		{ $ref: "#/$defs/ProvenanceDescriptor" },
+		{ $ref: "#/$defs/DivisionDescriptor" }
+	] },
 	StyleParagraphProperties: {
 		type: "object",
 		properties: {

package/dist/index.cjs

@@ -2,6 +2,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_a1 = require("./a1.cjs");
 require("./codec.cjs");
 const require_color = require("./color.cjs");
+const require_construct = require("./construct.cjs");
 const require_math = require("./math.cjs");
 const require_geometry = require("./geometry.cjs");
 const require_mathml = require("./mathml.cjs");
@@ -17,15 +18,21 @@ require("./font-port.cjs");
 require("./text-layout.cjs");
 require("./math-layout.cjs");
 exports.AlignmentSchema = require_style.AlignmentSchema;
+exports.AnchorDescriptorSchema = require_construct.AnchorDescriptorSchema;
+exports.AnchorTypeSchema = require_construct.AnchorTypeSchema;
 exports.BoxSchema = require_geometry.BoxSchema;
 exports.COLOR_BLACK = require_color.COLOR_BLACK;
 exports.CONTENT_DEFS = require_content_json_schema_defs.CONTENT_DEFS;
 exports.CONTENT_DOCUMENT_URI = require_content_json_schema_defs.CONTENT_DOCUMENT_URI;
 exports.ColorSchema = require_color.ColorSchema;
+exports.ConstructDescriptorSchema = require_construct.ConstructDescriptorSchema;
 exports.ContentBlockSchema = require_content.ContentBlockSchema;
 exports.ContentBorderSchema = require_content.ContentBorderSchema;
 exports.ContentCellBordersSchema = require_content.ContentCellBordersSchema;
 exports.ContentCellValueSchema = require_content.ContentCellValueSchema;
+exports.ContentControlDescriptorSchema = require_construct.ContentControlDescriptorSchema;
+exports.ContentControlLockSchema = require_construct.ContentControlLockSchema;
+exports.ContentControlTypeSchema = require_construct.ContentControlTypeSchema;
 exports.ContentDocumentSchema = require_content.ContentDocumentSchema;
 exports.ContentDrawPageSchema = require_content.ContentDrawPageSchema;
 exports.ContentEmbeddedObjectBlockSchema = require_content.ContentEmbeddedObjectBlockSchema;
@@ -62,17 +69,22 @@ exports.DecimalStringSchema = require_content.DecimalStringSchema;
 exports.DefinitionEntrySchema = require_definitions.DefinitionEntrySchema;
 exports.DefinitionsTableSchema = require_definitions.DefinitionsTableSchema;
 exports.DimensionVectorSchema = require_math.DimensionVectorSchema;
+exports.DivisionDescriptorSchema = require_construct.DivisionDescriptorSchema;
+exports.DivisionSourceSchema = require_construct.DivisionSourceSchema;
 exports.DocumentPackageSchema = require_package.DocumentPackageSchema;
 exports.DrawPageDescriptorSchema = require_package_node.DrawPageDescriptorSchema;
 exports.DrawPageGroupSchema = require_package_node.DrawPageGroupSchema;
 exports.EMBEDDED_OBJECT_KINDS = require_content_json_schema_defs.EMBEDDED_OBJECT_KINDS;
 exports.ExactRationalSchema = require_math.ExactRationalSchema;
+exports.FieldDescriptorSchema = require_construct.FieldDescriptorSchema;
 exports.HeadingGroupSchema = require_package_node.HeadingGroupSchema;
 exports.HeadingParagraphSchema = require_package_node.HeadingParagraphSchema;
 exports.LayoutFontSchema = require_style.LayoutFontSchema;
 exports.LayoutFrameSchema = require_geometry.LayoutFrameSchema;
 exports.LayoutMetadataSchema = require_metadata.LayoutMetadataSchema;
 exports.LayoutSchemaDemotedError = require_schema_io.LayoutSchemaDemotedError;
+exports.LinkDescriptorSchema = require_construct.LinkDescriptorSchema;
+exports.LinkTargetSchema = require_construct.LinkTargetSchema;
 exports.ListGroupSchema = require_package_node.ListGroupSchema;
 exports.ListParagraphSchema = require_package_node.ListParagraphSchema;
 exports.MAX_SAFE_INTEGER = require_content_json_schema_defs.MAX_SAFE_INTEGER;
@@ -106,13 +118,17 @@ exports.PackageGroupSchema = require_package_node.PackageGroupSchema;
 exports.PackageLeafSchema = require_package_node.PackageLeafSchema;
 exports.PackageNodeSchema = require_package_node.PackageNodeSchema;
 exports.PageSizeSchema = require_geometry.PageSizeSchema;
+exports.ProvenanceChangeSchema = require_construct.ProvenanceChangeSchema;
+exports.ProvenanceDescriptorSchema = require_construct.ProvenanceDescriptorSchema;
 exports.SCHEMA_FILE_NAMES = require_schema_io.SCHEMA_FILE_NAMES;
 exports.SI_BASE_DIMENSIONS = require_math.SI_BASE_DIMENSIONS;
 exports.SLIDE_SIZE_STANDARD = require_geometry.SLIDE_SIZE_STANDARD;
 exports.SLIDE_SIZE_WIDESCREEN = require_geometry.SLIDE_SIZE_WIDESCREEN;
 exports.SchemaVersionMismatchError = require_schema_io.SchemaVersionMismatchError;
+exports.SectionConstructGroupSchema = require_package_node.SectionConstructGroupSchema;
 exports.SectionDescriptorSchema = require_package_node.SectionDescriptorSchema;
 exports.SectionGroupSchema = require_package_node.SectionGroupSchema;
+exports.ShapeConstructGroupSchema = require_package_node.ShapeConstructGroupSchema;
 exports.ShapeDescriptorSchema = require_package_node.ShapeDescriptorSchema;
 exports.ShapeGroupSchema = require_package_node.ShapeGroupSchema;
 exports.SheetDescriptorSchema = require_package_node.SheetDescriptorSchema;
@@ -146,7 +162,9 @@ exports.isMathMlNode = require_mathml.isMathMlNode;
 exports.isPackageGroup = require_package_node.isPackageGroup;
 exports.isPackageLeaf = require_package_node.isPackageLeaf;
 exports.isPackageNode = require_package_node.isPackageNode;
+exports.isSectionConstructGroupNode = require_package_node.isSectionConstructGroupNode;
 exports.isSectionGroupNode = require_package_node.isSectionGroupNode;
+exports.isShapeConstructGroupNode = require_package_node.isShapeConstructGroupNode;
 exports.isShapeGroupNode = require_package_node.isShapeGroupNode;
 exports.isSheetGroupNode = require_package_node.isSheetGroupNode;
 exports.isSlideGroupNode = require_package_node.isSlideGroupNode;