document-model.js 1.9.0 → 1.10.0

package/dist/schema-io.d.ts

@@ -0,0 +1,37 @@
+import { ContentDocument } from "./content.js";
+import { LayoutDocument } from "./layout.js";
+import { DocumentPackage } from "./package.js";
+//#region src/schema-io.d.ts
+type DocumentSchemaKind = 'DocumentPackage' | 'ContentDocument' | 'LayoutDocument';
+declare const SCHEMA_FILE_NAMES: Record<DocumentSchemaKind, string>;
+declare function schemaUriFor(kind: DocumentSchemaKind): string;
+declare function documentSchemaKindOf(value: unknown): DocumentSchemaKind | undefined;
+type DocumentPackageJson = DocumentPackage & {
+  readonly $schema: string;
+};
+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);
+}
+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 };

package/dist/schema-io.js

@@ -0,0 +1,79 @@
+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"
+};
+function schemaUriFor(kind) {
+	return `https://cdn.jsdelivr.net/npm/document-schema.js@1.10.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 kindForFileStem(stem) {
+	switch (stem) {
+		case "document-package": return "DocumentPackage";
+		case "content-document": return "ContentDocument";
+		case "layout-document": return "LayoutDocument";
+		default: return;
+	}
+}
+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);
+}
+function documentPackageWithSchema(value) {
+	return {
+		$schema: schemaUriFor("DocumentPackage"),
+		...value
+	};
+}
+function contentDocumentWithSchema(value) {
+	return {
+		$schema: schemaUriFor("ContentDocument"),
+		...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)}).`);
+		this.name = "UnrecognizedDocumentSchemaError";
+		this.schema = schema;
+	}
+};
+function documentFromJson(value) {
+	const kind = documentSchemaKindOf(value);
+	if (kind === void 0) throw new UnrecognizedDocumentSchemaError(isRecord(value) ? value.$schema : void 0);
+	switch (kind) {
+		case "DocumentPackage": return {
+			kind,
+			value: DocumentPackageSchema.parse(value)
+		};
+		case "ContentDocument": return {
+			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 };

package/dist/style.cjs

@@ -0,0 +1,23 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let zod = require("zod");
+//#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
+exports.AlignmentSchema = AlignmentSchema;
+exports.DEFAULT_LAYOUT_FONT = DEFAULT_LAYOUT_FONT;
+exports.LayoutFontSchema = LayoutFontSchema;

package/dist/style.d.cts

@@ -0,0 +1,24 @@
+import { z } from "zod";
+//#region src/style.d.ts
+declare const AlignmentSchema: z.ZodEnum<{
+  left: "left";
+  center: "center";
+  right: "right";
+  justify: "justify";
+}>;
+type Alignment = z.infer<typeof AlignmentSchema>;
+declare const LayoutFontSchema: z.ZodObject<{
+  family: z.ZodString;
+  weight: z.ZodEnum<{
+    normal: "normal";
+    bold: "bold";
+  }>;
+  style: z.ZodEnum<{
+    normal: "normal";
+    italic: "italic";
+  }>;
+}, z.core.$strip>;
+type LayoutFont = z.infer<typeof LayoutFontSchema>;
+declare const DEFAULT_LAYOUT_FONT: LayoutFont;
+//#endregion
+export { Alignment, AlignmentSchema, DEFAULT_LAYOUT_FONT, LayoutFont, LayoutFontSchema };

package/dist/style.d.ts

@@ -0,0 +1,24 @@
+import { z } from "zod";
+//#region src/style.d.ts
+declare const AlignmentSchema: z.ZodEnum<{
+  left: "left";
+  center: "center";
+  right: "right";
+  justify: "justify";
+}>;
+type Alignment = z.infer<typeof AlignmentSchema>;
+declare const LayoutFontSchema: z.ZodObject<{
+  family: z.ZodString;
+  weight: z.ZodEnum<{
+    normal: "normal";
+    bold: "bold";
+  }>;
+  style: z.ZodEnum<{
+    normal: "normal";
+    italic: "italic";
+  }>;
+}, z.core.$strip>;
+type LayoutFont = z.infer<typeof LayoutFontSchema>;
+declare const DEFAULT_LAYOUT_FONT: LayoutFont;
+//#endregion
+export { Alignment, AlignmentSchema, DEFAULT_LAYOUT_FONT, LayoutFont, LayoutFontSchema };

package/dist/style.js

@@ -0,0 +1,20 @@
+import { z } from "zod";
+//#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
+export { AlignmentSchema, DEFAULT_LAYOUT_FONT, LayoutFontSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-model.js",
-  "version": "1.9.0",
+  "version": "1.10.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": {
@@ -20,9 +20,15 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
-    "./schemas/document-package.schema.json": "./schemas/document-package.schema.json",
-    "./schemas/content-document.schema.json": "./schemas/content-document.schema.json",
-    "./schemas/layout-document.schema.json": "./schemas/layout-document.schema.json"
+    "./*": {
+      "types": {
+        "import": "./dist/*.d.ts",
+        "require": "./dist/*.d.cts"
+      },
+      "import": "./dist/*.js",
+      "require": "./dist/*.cjs"
+    },
+    "./schemas/*.schema.json": "./schemas/*.schema.json"
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

package/schemas/content-document.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://cdn.jsdelivr.net/npm/document-schema.js@1.9.0/schemas/content-document.schema.json",
+  "$id": "https://cdn.jsdelivr.net/npm/document-schema.js@1.10.0/schemas/content-document.schema.json",
   "oneOf": [
     {
       "type": "object",
@@ -930,7 +930,7 @@
                       ]
                     },
                     "document": {
-                      "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.9.0/schemas/content-document.schema.json"
+                      "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.10.0/schemas/content-document.schema.json"
                     },
                     "frame": {
                       "$ref": "#/$defs/Box"
@@ -2021,7 +2021,7 @@
           ]
         },
         "document": {
-          "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.9.0/schemas/content-document.schema.json"
+          "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.10.0/schemas/content-document.schema.json"
         },
         "frame": {
           "$ref": "#/$defs/Box"

package/schemas/document-package.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://cdn.jsdelivr.net/npm/document-schema.js@1.9.0/schemas/document-package.schema.json",
+  "$id": "https://cdn.jsdelivr.net/npm/document-schema.js@1.10.0/schemas/document-package.schema.json",
   "type": "object",
   "properties": {
     "formatVersion": {
@@ -8,10 +8,10 @@
       "const": 1
     },
     "content": {
-      "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.9.0/schemas/content-document.schema.json"
+      "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.10.0/schemas/content-document.schema.json"
     },
     "layout": {
-      "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.9.0/schemas/layout-document.schema.json"
+      "$ref": "https://cdn.jsdelivr.net/npm/document-schema.js@1.10.0/schemas/layout-document.schema.json"
     }
   },
   "required": [

package/schemas/layout-document.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://cdn.jsdelivr.net/npm/document-schema.js@1.9.0/schemas/layout-document.schema.json",
+  "$id": "https://cdn.jsdelivr.net/npm/document-schema.js@1.10.0/schemas/layout-document.schema.json",
   "type": "object",
   "properties": {
     "formatVersion": {