document-content-model 1.5.1 → 1.5.2

package/README.md

@@ -2,7 +2,7 @@
 
 [![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).
+> 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), [documents.js](https://github.com/ExaDev/documents.js), and [pdf-codec](https://github.com/ExaDev/pdf-codec).
 
 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`.
 
@@ -26,9 +26,10 @@ const pkg = DocumentPackageSchema.parse({ formatVersion: 1, content, layout });
 
 - [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.
+- [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 its `pdf-codec` dependency, and of `DocumentPackage` as the `onDocument` side-channel value its conversion functions hand back.
+- [pdf-codec](https://github.com/ExaDev/pdf-codec) — the hand-written PDF codec extracted from `documents.js`: `readPdf`/`writePdf` and its own `pdfCodec` z.codec() pair operate entirely in terms of this package's `LayoutDocument` (plus the item kinds it's built from -- `LayoutItem`/`LayoutText`/`LayoutImage`/`LayoutRect`/`LayoutEllipse`/`LayoutLink`/`LayoutPath`/`LayoutSubpath`/`LayoutPathSegment`/`LayoutPage`/`LayoutImageAsset`/`LayoutMetadata`), `Color`/`LayoutFont` (aliased `LayoutColor`/`LayoutFont` at its own call sites), and `LAYOUT_FORMAT_VERSION`/`COLOR_BLACK`/`LayoutDocumentSchema` -- it never redeclares any of these itself, unlike its own `MathBox`/`PositionedFormula` mirror of `documents.js`'s MathML types (a deliberate, narrower exception -- see pdf-codec's own README).
 
-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.
+None of these four 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 four 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,6 +1,6 @@
 {
   "name": "document-content-model",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "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": {