document-schema.js 1.5.3 → 1.6.1

package/README.md

@@ -22,6 +22,26 @@ const layout = LayoutDocumentSchema.parse(somePageLayoutValue);
 const pkg = DocumentPackageSchema.parse({ formatVersion: 1, content, layout });
 ```
 
+## JSON Schema
+
+Alongside the Zod schemas/types above, the package publishes three plain [JSON Schema](https://json-schema.org) files -- generated from the same Zod definitions via [`z.toJSONSchema()`](https://zod.dev/json-schema) at build time (`scripts/generate-json-schemas.mjs`) -- for non-TypeScript consumers that want to validate against or generate types from these shapes without depending on Zod at all:
+
+```ts
+const documentPackageSchema = require('document-schema.js/schemas/document-package.schema.json');
+// or, from a bundler/toolchain that supports JSON module imports:
+import documentPackageSchema from 'document-schema.js/schemas/document-package.schema.json' with { type: 'json' };
+```
+
+or from any language/tool that can read a file out of `node_modules`:
+
+```
+node_modules/document-schema.js/schemas/document-package.schema.json
+node_modules/document-schema.js/schemas/content-document.schema.json
+node_modules/document-schema.js/schemas/layout-document.schema.json
+```
+
+Each file's `$id` is a `https://cdn.jsdelivr.net/npm/document-schema.js@<version>/schemas/<file>` URL, pinned to the exact npm version that generated it -- immutable (jsdelivr serves each version's own published tarball contents forever, with an immutable cache header) and genuinely live the moment that version is published, unlike a commit-SHA-pinned raw GitHub URL would be: a gitignored, generated file can never actually be committed at the commit whose SHA it would need to embed, since committing it changes the tree and thus the hash. The three files are cross-referenced via real `$ref`s (e.g. `document-package.schema.json`'s `content`/`layout` properties `$ref` the other two files directly, at that same version), so a JSON Schema validator that resolves `$ref`s over HTTP (or against local copies of all three files) can validate a whole `DocumentPackage` value. `content-document.schema.json` additionally carries a `$defs` block for the recursive paragraph/table/embedded-object block model, which Zod's own converter can't express directly (see that script's own top-of-file comment for why).
+
 ## Used by
 
 - [ooxml.js](https://github.com/ExaDev/ooxml.js) — its `readDocx`/`readPptx`/`readXlsxContent` return `ContentSection[]`/`ContentSlide[]`/spreadsheet `ContentSheet[]` typed against this package's own schemas, not a locally-defined lookalike.

package/dist/index.d.cts

@@ -46,12 +46,12 @@ type Alignment = z.infer<typeof AlignmentSchema>;
 declare const LayoutFontSchema: z.ZodObject<{
   family: z.ZodString;
   weight: z.ZodEnum<{
-    normal: "normal";
     bold: "bold";
+    normal: "normal";
   }>;
   style: z.ZodEnum<{
-    normal: "normal";
     italic: "italic";
+    normal: "normal";
   }>;
 }, z.core.$strip>;
 type LayoutFont = z.infer<typeof LayoutFontSchema>;
@@ -1264,12 +1264,12 @@ declare const LayoutTextSchema: z.ZodObject<{
   font: z.ZodObject<{
     family: z.ZodString;
     weight: z.ZodEnum<{
-      normal: "normal";
       bold: "bold";
+      normal: "normal";
     }>;
     style: z.ZodEnum<{
-      normal: "normal";
       italic: "italic";
+      normal: "normal";
     }>;
   }, z.core.$strip>;
   sizePt: z.ZodNumber;
@@ -1445,12 +1445,12 @@ declare const LayoutItemSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   font: z.ZodObject<{
     family: z.ZodString;
     weight: z.ZodEnum<{
-      normal: "normal";
       bold: "bold";
+      normal: "normal";
     }>;
     style: z.ZodEnum<{
-      normal: "normal";
       italic: "italic";
+      normal: "normal";
     }>;
   }, z.core.$strip>;
   sizePt: z.ZodNumber;
@@ -1584,12 +1584,12 @@ declare const LayoutPageSchema: z.ZodObject<{
     font: z.ZodObject<{
       family: z.ZodString;
       weight: z.ZodEnum<{
-        normal: "normal";
         bold: "bold";
+        normal: "normal";
       }>;
       style: z.ZodEnum<{
-        normal: "normal";
         italic: "italic";
+        normal: "normal";
       }>;
     }, z.core.$strip>;
     sizePt: z.ZodNumber;
@@ -1747,12 +1747,12 @@ declare const LayoutDocumentSchema: z.ZodObject<{
       font: z.ZodObject<{
         family: z.ZodString;
         weight: z.ZodEnum<{
-          normal: "normal";
           bold: "bold";
+          normal: "normal";
         }>;
         style: z.ZodEnum<{
-          normal: "normal";
           italic: "italic";
+          normal: "normal";
         }>;
       }, z.core.$strip>;
       sizePt: z.ZodNumber;
@@ -2271,12 +2271,12 @@ declare const DocumentPackageSchema: z.ZodObject<{
         font: z.ZodObject<{
           family: z.ZodString;
           weight: z.ZodEnum<{
-            normal: "normal";
             bold: "bold";
+            normal: "normal";
           }>;
           style: z.ZodEnum<{
-            normal: "normal";
             italic: "italic";
+            normal: "normal";
           }>;
         }, z.core.$strip>;
         sizePt: z.ZodNumber;

package/dist/index.d.ts

@@ -46,12 +46,12 @@ type Alignment = z.infer<typeof AlignmentSchema>;
 declare const LayoutFontSchema: z.ZodObject<{
   family: z.ZodString;
   weight: z.ZodEnum<{
-    normal: "normal";
     bold: "bold";
+    normal: "normal";
   }>;
   style: z.ZodEnum<{
-    normal: "normal";
     italic: "italic";
+    normal: "normal";
   }>;
 }, z.core.$strip>;
 type LayoutFont = z.infer<typeof LayoutFontSchema>;
@@ -1264,12 +1264,12 @@ declare const LayoutTextSchema: z.ZodObject<{
   font: z.ZodObject<{
     family: z.ZodString;
     weight: z.ZodEnum<{
-      normal: "normal";
       bold: "bold";
+      normal: "normal";
     }>;
     style: z.ZodEnum<{
-      normal: "normal";
       italic: "italic";
+      normal: "normal";
     }>;
   }, z.core.$strip>;
   sizePt: z.ZodNumber;
@@ -1445,12 +1445,12 @@ declare const LayoutItemSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   font: z.ZodObject<{
     family: z.ZodString;
     weight: z.ZodEnum<{
-      normal: "normal";
       bold: "bold";
+      normal: "normal";
     }>;
     style: z.ZodEnum<{
-      normal: "normal";
       italic: "italic";
+      normal: "normal";
     }>;
   }, z.core.$strip>;
   sizePt: z.ZodNumber;
@@ -1584,12 +1584,12 @@ declare const LayoutPageSchema: z.ZodObject<{
     font: z.ZodObject<{
       family: z.ZodString;
       weight: z.ZodEnum<{
-        normal: "normal";
         bold: "bold";
+        normal: "normal";
       }>;
       style: z.ZodEnum<{
-        normal: "normal";
         italic: "italic";
+        normal: "normal";
       }>;
     }, z.core.$strip>;
     sizePt: z.ZodNumber;
@@ -1747,12 +1747,12 @@ declare const LayoutDocumentSchema: z.ZodObject<{
       font: z.ZodObject<{
         family: z.ZodString;
         weight: z.ZodEnum<{
-          normal: "normal";
           bold: "bold";
+          normal: "normal";
         }>;
         style: z.ZodEnum<{
-          normal: "normal";
           italic: "italic";
+          normal: "normal";
         }>;
       }, z.core.$strip>;
       sizePt: z.ZodNumber;
@@ -2271,12 +2271,12 @@ declare const DocumentPackageSchema: z.ZodObject<{
         font: z.ZodObject<{
           family: z.ZodString;
           weight: z.ZodEnum<{
-            normal: "normal";
             bold: "bold";
+            normal: "normal";
           }>;
           style: z.ZodEnum<{
-            normal: "normal";
             italic: "italic";
+            normal: "normal";
           }>;
         }, z.core.$strip>;
         sizePt: z.ZodNumber;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-schema.js",
-  "version": "1.5.3",
+  "version": "1.6.1",
   "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": {
@@ -19,13 +19,17 @@
       },
       "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"
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "schemas"
   ],
   "publishConfig": {
     "access": "public",
@@ -37,14 +41,14 @@
     "node": ">=20"
   },
   "scripts": {
-    "build": "tsdown",
-    "prepublishOnly": "pnpm run lint && pnpm run typecheck && tsdown && publint && attw --pack",
+    "build": "tsdown && node scripts/generate-json-schemas.mjs",
+    "prepublishOnly": "pnpm run lint && pnpm run typecheck && pnpm run build && publint && attw --pack",
     "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",
+    "test:smoke": "pnpm run build && vitest run --project smoke",
     "prepare": "husky",
     "release": "semantic-release"
   },