odf.js 1.12.0 → 1.13.0

package/README.md

@@ -10,6 +10,35 @@
 
 Both packages **do** depend on [`document-schema.js`](https://github.com/ExaDev/document-schema.js), the genuinely shared canonical schema for `ContentDocument`/`LayoutDocument` — the semantic content model (paragraphs, runs, tables, shapes, slides) both an ODF and an OOXML reader ultimately produce. `odf.js`'s typed readers return the real, imported `ContentSection`/`ContentSlide`/etc. types from that package, not a structurally-similar lookalike, so a downstream consumer (`documents.js`) can run an `.odt` through the exact same layout/pagination engine it already uses for `.docx`, unmodified.
 
+```mermaid
+graph TD
+    schema("document-schema.js")
+    ooxml("ooxml.js")
+    odf("odf.js")
+    pdfcodec("pdf-codec")
+    documents("documents.js")
+    cli("document-cli")
+
+    schema --> ooxml
+    schema --> odf
+    schema --> pdfcodec
+    schema --> documents
+    ooxml --> documents
+    odf --> documents
+    pdfcodec --> documents
+    documents --> cli
+    odf --> cli
+
+    click schema "https://github.com/ExaDev/document-schema.js" "document-schema.js"
+    click ooxml "https://github.com/ExaDev/ooxml.js" "ooxml.js"
+    click odf "https://github.com/ExaDev/odf.js" "odf.js"
+    click pdfcodec "https://github.com/ExaDev/pdf-codec" "pdf-codec"
+    click documents "https://github.com/ExaDev/documents.js" "documents.js"
+    click cli "https://github.com/ExaDev/document-cli" "document-cli"
+
+    style odf fill:#f9a825,stroke:#333,stroke-width:3px
+```
+
 ## Status
 
 This package is under active development. What's built and shipped:
@@ -68,6 +97,16 @@ syncManifest(pkg); // rebuilds manifest.xml to exactly match pkg's current parts
 readMimetype(pkg); // 'application/vnd.oasis.opendocument.text'
 ```
 
+Every module is also importable directly by its own subpath, without going through the barrel — useful for a caller that wants one narrow piece of the package (e.g. a bundler doing tree-shaking, or a script that only needs the length-unit parser) without pulling in the rest:
+
+```ts
+import { parseOdfLength } from 'odf.js/typed/shared/units';
+
+parseOdfLength('2.5cm'); // 70.86614173228347
+```
+
+Any `src/**/*.ts` module (excluding tests and internal `test-support/` fixtures) resolves this way, at its path relative to `src/` — `src/manifest.ts` as `odf.js/manifest`, `src/typed/odt/read.ts` as `odf.js/typed/odt/read`, and so on.
+
 ## Architecture
 
 Layered from a lossless core outward, mirroring `ooxml.js`'s own structure:

package/dist/codec.cjs

@@ -0,0 +1,28 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_model_node = require("./model/node.cjs");
+const require_model_package = require("./model/package.cjs");
+const require_xml_parse = require("./xml/parse.cjs");
+const require_package_io_read = require("./package-io/read.cjs");
+const require_xml_build = require("./xml/build.cjs");
+const require_package_io_write = require("./package-io/write.cjs");
+let zod = require("zod");
+//#region src/codec.ts
+const xmlCodec = zod.z.codec(zod.z.string(), zod.z.array(require_model_node.XmlNodeSchema), {
+	decode: (xml) => require_xml_parse.parseXml(xml),
+	encode: (nodes) => require_xml_build.buildXml(nodes)
+});
+const packageCodec = zod.z.codec(zod.z.instanceof(Uint8Array), require_model_package.PackageSchema, {
+	decode: (bytes) => require_package_io_read.parsePackage(bytes),
+	encode: (pkg) => require_package_io_write.serializePackage(pkg)
+});
+function decodePackage(bytes) {
+	return zod.z.decode(packageCodec, bytes);
+}
+function encodePackage(pkg) {
+	return zod.z.encode(packageCodec, pkg);
+}
+//#endregion
+exports.decodePackage = decodePackage;
+exports.encodePackage = encodePackage;
+exports.packageCodec = packageCodec;
+exports.xmlCodec = xmlCodec;

package/dist/codec.d.cts

@@ -0,0 +1,72 @@
+import { d as XmlNode } from "./node-CkBWRjNR.cjs";
+import { Package } from "./model/package.cjs";
+import { z } from "zod";
+//#region src/codec.d.ts
+declare const xmlCodec: z.ZodCodec<z.ZodString, z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+  type: z.ZodLiteral<"text">;
+  value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"cdata">;
+  value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"comment">;
+  value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"declaration">;
+  attributes: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"pi">;
+  target: z.ZodString;
+  content: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"element">;
+  tag: z.ZodString;
+  attributes: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodString;
+  }, z.core.$strip>>;
+  children: z.ZodArray<z.ZodCustom<XmlNode, XmlNode>>;
+}, z.core.$strip>], "type">>>;
+declare const packageCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, z.ZodObject<{
+  parts: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"xml">;
+    nodes: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"text">;
+      value: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"cdata">;
+      value: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"comment">;
+      value: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"declaration">;
+      attributes: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"pi">;
+      target: z.ZodString;
+      content: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"element">;
+      tag: z.ZodString;
+      attributes: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+      }, z.core.$strip>>;
+      children: z.ZodArray<z.ZodCustom<XmlNode, XmlNode>>;
+    }, z.core.$strip>], "type">>;
+  }, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"binary">;
+    base64: z.ZodString;
+  }, z.core.$strip>], "kind">>;
+}, z.core.$strip>>;
+declare function decodePackage(bytes: Uint8Array<ArrayBuffer>): Package;
+declare function encodePackage(pkg: Package): Uint8Array<ArrayBuffer>;
+//#endregion
+export { type XmlNode, decodePackage, encodePackage, packageCodec, xmlCodec };

package/dist/codec.d.ts

@@ -0,0 +1,72 @@
+import { d as XmlNode } from "./node-CkBWRjNR.js";
+import { Package } from "./model/package.js";
+import { z } from "zod";
+//#region src/codec.d.ts
+declare const xmlCodec: z.ZodCodec<z.ZodString, z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+  type: z.ZodLiteral<"text">;
+  value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"cdata">;
+  value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"comment">;
+  value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"declaration">;
+  attributes: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"pi">;
+  target: z.ZodString;
+  content: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"element">;
+  tag: z.ZodString;
+  attributes: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodString;
+  }, z.core.$strip>>;
+  children: z.ZodArray<z.ZodCustom<XmlNode, XmlNode>>;
+}, z.core.$strip>], "type">>>;
+declare const packageCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, z.ZodObject<{
+  parts: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"xml">;
+    nodes: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"text">;
+      value: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"cdata">;
+      value: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"comment">;
+      value: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"declaration">;
+      attributes: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"pi">;
+      target: z.ZodString;
+      content: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"element">;
+      tag: z.ZodString;
+      attributes: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+      }, z.core.$strip>>;
+      children: z.ZodArray<z.ZodCustom<XmlNode, XmlNode>>;
+    }, z.core.$strip>], "type">>;
+  }, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"binary">;
+    base64: z.ZodString;
+  }, z.core.$strip>], "kind">>;
+}, z.core.$strip>>;
+declare function decodePackage(bytes: Uint8Array<ArrayBuffer>): Package;
+declare function encodePackage(pkg: Package): Uint8Array<ArrayBuffer>;
+//#endregion
+export { type XmlNode, decodePackage, encodePackage, packageCodec, xmlCodec };

package/dist/codec.js

@@ -0,0 +1,24 @@
+import { XmlNodeSchema } from "./model/node.js";
+import { PackageSchema } from "./model/package.js";
+import { parseXml } from "./xml/parse.js";
+import { parsePackage } from "./package-io/read.js";
+import { buildXml } from "./xml/build.js";
+import { serializePackage } from "./package-io/write.js";
+import { z } from "zod";
+//#region src/codec.ts
+const xmlCodec = z.codec(z.string(), z.array(XmlNodeSchema), {
+	decode: (xml) => parseXml(xml),
+	encode: (nodes) => buildXml(nodes)
+});
+const packageCodec = z.codec(z.instanceof(Uint8Array), PackageSchema, {
+	decode: (bytes) => parsePackage(bytes),
+	encode: (pkg) => serializePackage(pkg)
+});
+function decodePackage(bytes) {
+	return z.decode(packageCodec, bytes);
+}
+function encodePackage(pkg) {
+	return z.encode(packageCodec, pkg);
+}
+//#endregion
+export { decodePackage, encodePackage, packageCodec, xmlCodec };

package/dist/image/sniff.cjs

@@ -0,0 +1,28 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/image/sniff.ts
+const PNG_SIGNATURE = [
+	137,
+	80,
+	78,
+	71,
+	13,
+	10,
+	26,
+	10
+];
+const JPEG_SIGNATURE = [
+	255,
+	216,
+	255
+];
+function startsWith(bytes, signature) {
+	if (bytes.length < signature.length) return false;
+	for (let i = 0; i < signature.length; i++) if (bytes[i] !== signature[i]) return false;
+	return true;
+}
+function sniffImageFormat(bytes) {
+	if (startsWith(bytes, PNG_SIGNATURE)) return "png";
+	if (startsWith(bytes, JPEG_SIGNATURE)) return "jpeg";
+}
+//#endregion
+exports.sniffImageFormat = sniffImageFormat;

package/dist/image/sniff.d.cts

@@ -0,0 +1,5 @@
+//#region src/image/sniff.d.ts
+type ImageFormat = 'png' | 'jpeg';
+declare function sniffImageFormat(bytes: Uint8Array<ArrayBuffer>): ImageFormat | undefined;
+//#endregion
+export { ImageFormat, sniffImageFormat };

package/dist/image/sniff.d.ts

@@ -0,0 +1,5 @@
+//#region src/image/sniff.d.ts
+type ImageFormat = 'png' | 'jpeg';
+declare function sniffImageFormat(bytes: Uint8Array<ArrayBuffer>): ImageFormat | undefined;
+//#endregion
+export { ImageFormat, sniffImageFormat };

package/dist/image/sniff.js

@@ -0,0 +1,27 @@
+//#region src/image/sniff.ts
+const PNG_SIGNATURE = [
+	137,
+	80,
+	78,
+	71,
+	13,
+	10,
+	26,
+	10
+];
+const JPEG_SIGNATURE = [
+	255,
+	216,
+	255
+];
+function startsWith(bytes, signature) {
+	if (bytes.length < signature.length) return false;
+	for (let i = 0; i < signature.length; i++) if (bytes[i] !== signature[i]) return false;
+	return true;
+}
+function sniffImageFormat(bytes) {
+	if (startsWith(bytes, PNG_SIGNATURE)) return "png";
+	if (startsWith(bytes, JPEG_SIGNATURE)) return "jpeg";
+}
+//#endregion
+export { sniffImageFormat };