document-content-model 1.4.0 → 1.5.0

package/README.md

@@ -1,29 +1,34 @@
-# document-content-model
+# document-schema.js
 
-[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/document-content-model) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/document-content-model) [![Release](https://img.shields.io/github/v/release/ExaDev/document-content-model)](https://github.com/ExaDev/document-content-model/releases/latest) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/document-content-model/ci.yml?branch=main)](https://github.com/ExaDev/document-content-model/actions)
+[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/document-schema.js) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/document-schema.js) [![Release](https://img.shields.io/github/v/release/ExaDev/document-schema.js)](https://github.com/ExaDev/document-schema.js/releases/latest) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/document-schema.js/ci.yml?branch=main)](https://github.com/ExaDev/document-schema.js/actions)
 
 > The canonical, format-agnostic content and layout schema pivot shared by [ooxml.js](https://github.com/ExaDev/ooxml.js), [odf.js](https://github.com/ExaDev/odf.js), and [documents.js](https://github.com/ExaDev/documents.js).
 
 Both `ooxml.js` and `documents.js` independently arrived at the same content vocabulary -- paragraphs, runs, tables, images, shapes, slides -- because `documents.js`'s docx/pptx-to-PDF pipeline needed a richer model than `ooxml.js`'s own readers originally produced, and that model was later ported back into `ooxml.js` itself. The result was two field-identical copies maintained in two places. This package is the fix: one schema, imported by every format package instead of redefined by each. It also sidesteps a circular dependency that would otherwise appear once `odf.js` exists, since `documents.js` depends on both `ooxml.js` and `odf.js`.
 
-It contains only [Zod](https://zod.dev) schemas, their inferred types, and a handful of trivial schema-attached helpers (hex-colour conversion, a recursive structural type guard for the mutually-recursive table/block types). There is no XML, ZIP, PDF, or other binary handling here, and no `zod` dependency other than `zod` itself.
+`ContentDocument` (the semantic pivot) is a discriminated union of four kinds: `wordprocessing` (docx/odt-style sections of paragraphs/runs/tables/images), `presentation` (pptx/odp-style slides of shapes), `spreadsheet` (xlsx/ods-style sheets of cells, columns, rows, and print settings), and `drawing` (odg-style pages of shapes plus vector primitives -- rect/ellipse/line/path). `ContentEmbeddedObjectSchema` lets any of the four embed another whole `ContentDocument`. `LayoutDocument` (the PDF-rendering pivot) is pages of positioned `LayoutItem`s -- `text`/`image`/`rect`/`line`/`ellipse`/`path`/`link` -- in PDF user-space coordinates, with `LayoutPathSchema` modelling a general vector path rather than only axis-aligned rectangles. `DocumentPackageSchema` is a small envelope pairing the two: `content` required, `layout` optional (it's a derived artifact, absent until something lays the content out), correlated via each item's own `sourcePath` when both are present -- a pairing this schema does not itself keep in sync or detect as stale.
+
+It contains only [Zod](https://zod.dev) schemas, their inferred types, and a handful of trivial schema-attached helpers (hex-colour conversion, a recursive structural type guard for the mutually-recursive table/block/embedded-object types). There is no XML, ZIP, PDF, or other binary handling here, and no `zod` dependency other than `zod` itself.
+
+The GitHub repository is [`ExaDev/document-schema.js`](https://github.com/ExaDev/document-schema.js), matching the published npm package name; `document-content-model` (the repository's original name, kept resolving), `doc-model.js`, `doc-schema.js`, `document-schema`, and `document-model.js` republish the identical build as aliases on npmjs.org, alongside a scoped `@exadev/document-content-model` alias on GitHub Packages. A CI matrix job (`publish-aliases` in `.github/workflows/ci.yml`) rewrites `package.json`'s `name` and registry via `npm pkg set` after each release and publishes under each alias in turn -- install whichever name you already depend on.
 
 ## Usage
 
 ```ts
-import { ContentDocumentSchema, LayoutDocumentSchema } from 'document-content-model';
+import { ContentDocumentSchema, DocumentPackageSchema, LayoutDocumentSchema } from 'document-schema.js';
 
 const content = ContentDocumentSchema.parse(someWordprocessingOrPresentationValue);
 const layout = LayoutDocumentSchema.parse(somePageLayoutValue);
+const pkg = DocumentPackageSchema.parse({ formatVersion: 1, content, layout });
 ```
 
 ## Used by
 
-- [ooxml.js](https://github.com/ExaDev/ooxml.js) — its `readDocx`/`readPptx` return `ContentSection[]`/`ContentSlide[]` typed against this package's own schemas, not a locally-defined lookalike.
-- [odf.js](https://github.com/ExaDev/odf.js) — its ODF typed readers (`readOdt`, `readOdp`, `readOdg`, …) return the same shared types, so an ODF document and an OOXML document speak the identical pivot.
-- [documents.js](https://github.com/ExaDev/documents.js) — the primary consumer of both `ContentDocument` (the semantic pivot) and `LayoutDocument` (the PDF-rendering pivot), which it converts between via its layout engines and PDF codec.
+- [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.
+- [odf.js](https://github.com/ExaDev/odf.js) — its ODF typed readers (`readOdt`, `readOdp`, `readOds`, `readOdg`, …) return the same shared types, so an ODF document and an OOXML document speak the identical pivot.
+- [documents.js](https://github.com/ExaDev/documents.js) — the primary consumer of both `ContentDocument` and `LayoutDocument`, which it converts between via its layout engines and PDF codec, and of `DocumentPackage` as the `onDocument` side-channel value its conversion functions hand back.
 
-None of these three packages depend on each other for this vocabulary — each depends on `document-content-model` directly, which is the whole point: one schema, not three independently-maintained, drift-prone copies.
+None of these three packages depend on each other for this vocabulary — each depends on `document-schema.js` (or one of its aliases above) directly, which is the whole point: one schema, not three independently-maintained, drift-prone copies.
 
 ## License
 

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,15 +1,15 @@
 {
   "name": "document-content-model",
-  "version": "1.4.0",
+  "version": "1.5.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": {
     "type": "git",
-    "url": "git+https://github.com/ExaDev/document-content-model.git"
+    "url": "git+https://github.com/ExaDev/document-schema.js.git"
   },
-  "homepage": "https://github.com/ExaDev/document-content-model#readme",
+  "homepage": "https://github.com/ExaDev/document-schema.js#readme",
   "bugs": {
-    "url": "https://github.com/ExaDev/document-content-model/issues"
+    "url": "https://github.com/ExaDev/document-schema.js/issues"
   },
   "exports": {
     ".": {
@@ -30,24 +30,12 @@
   "publishConfig": {
     "access": "public",
     "provenance": true,
-    "registry": "https://registry.npmjs.org/"
+    "registry": "https://registry.npmjs.org"
   },
   "sideEffects": false,
   "engines": {
     "node": ">=20"
   },
-  "scripts": {
-    "build": "tsdown",
-    "prepublishOnly": "pnpm run lint && pnpm run typecheck && tsdown && 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",
-    "prepare": "husky",
-    "release": "semantic-release"
-  },
   "keywords": [
     "document",
     "content-model",
@@ -61,7 +49,6 @@
     "ods"
   ],
   "license": "MIT",
-  "packageManager": "pnpm@11.6.0",
   "dependencies": {
     "zod": "^4.4.3"
   },
@@ -84,5 +71,15 @@
     "typescript": "^6.0.3",
     "typescript-eslint": "^8.65.0",
     "vitest": "^4.1.10"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "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",
+    "release": "semantic-release"
   }
-}
+}