epub-codec 0.0.0 → 1.0.0

package/dist/xml/parse.cjs

@@ -0,0 +1,88 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/xml/parse.ts
+const PARSER = new (require("fast-xml-parser")).XMLParser({
+	preserveOrder: true,
+	attributeNamePrefix: "@_",
+	ignoreAttributes: false,
+	textNodeName: "#text",
+	cdataPropName: "__cdata",
+	commentPropName: "__comment",
+	processEntities: false,
+	parseTagValue: false,
+	trimValues: false
+});
+function parseXml(xml) {
+	return parseNodes(PARSER.parse(xml));
+}
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isUnknownArray(value) {
+	return Array.isArray(value);
+}
+function asString(value) {
+	if (typeof value !== "string") throw new Error(`expected string while parsing XML, got ${typeof value}`);
+	return value;
+}
+function parseNodes(raw) {
+	if (!isUnknownArray(raw)) throw new Error("fast-xml-parser output was not an ordered array");
+	return raw.map(parseNode);
+}
+function parseNode(raw) {
+	if (!isRecord(raw)) throw new Error("fast-xml-parser node was not an object");
+	let tagKey;
+	for (const key of Object.keys(raw)) if (key !== ":@") {
+		if (tagKey !== void 0) throw new Error("XML node had multiple tag keys");
+		tagKey = key;
+	}
+	if (tagKey === void 0) throw new Error("XML node had no tag key");
+	const attributes = parseAttributes(raw[":@"]);
+	if (tagKey === "#text") return {
+		type: "text",
+		value: asString(raw["#text"])
+	};
+	if (tagKey === "__comment") return {
+		type: "comment",
+		value: scalarText(raw.__comment)
+	};
+	if (tagKey === "__cdata") return {
+		type: "cdata",
+		value: scalarText(raw.__cdata)
+	};
+	if (tagKey === "?xml") return {
+		type: "declaration",
+		attributes
+	};
+	if (tagKey.startsWith("?")) return {
+		type: "pi",
+		target: tagKey.slice(1),
+		content: scalarText(raw[tagKey])
+	};
+	return {
+		type: "element",
+		tag: tagKey,
+		attributes,
+		children: parseNodes(raw[tagKey])
+	};
+}
+function parseAttributes(raw) {
+	if (raw === void 0) return [];
+	if (!isRecord(raw)) throw new Error("XML attributes were not an object");
+	const attrs = [];
+	for (const key of Object.keys(raw)) {
+		if (!key.startsWith("@_")) throw new Error(`unexpected attribute key without @_ prefix: ${key}`);
+		attrs.push({
+			name: key.slice(2),
+			value: asString(raw[key])
+		});
+	}
+	return attrs;
+}
+function scalarText(raw) {
+	if (!isUnknownArray(raw) || raw.length === 0) throw new Error("expected a scalar-text wrapper array");
+	const first = raw[0];
+	if (!isRecord(first)) throw new Error("scalar-text wrapper was not an object");
+	return asString(first["#text"]);
+}
+//#endregion
+exports.parseXml = parseXml;

package/dist/xml/parse.d.cts

@@ -0,0 +1,5 @@
+import { XmlNode } from "./node.cjs";
+//#region src/xml/parse.d.ts
+declare function parseXml(xml: string): XmlNode[];
+//#endregion
+export { parseXml };

package/dist/xml/parse.d.ts

@@ -0,0 +1,5 @@
+import { XmlNode } from "./node.js";
+//#region src/xml/parse.d.ts
+declare function parseXml(xml: string): XmlNode[];
+//#endregion
+export { parseXml };

package/dist/xml/parse.js

@@ -0,0 +1,88 @@
+import { XMLParser } from "fast-xml-parser";
+//#region src/xml/parse.ts
+const PARSER = new XMLParser({
+	preserveOrder: true,
+	attributeNamePrefix: "@_",
+	ignoreAttributes: false,
+	textNodeName: "#text",
+	cdataPropName: "__cdata",
+	commentPropName: "__comment",
+	processEntities: false,
+	parseTagValue: false,
+	trimValues: false
+});
+function parseXml(xml) {
+	return parseNodes(PARSER.parse(xml));
+}
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isUnknownArray(value) {
+	return Array.isArray(value);
+}
+function asString(value) {
+	if (typeof value !== "string") throw new Error(`expected string while parsing XML, got ${typeof value}`);
+	return value;
+}
+function parseNodes(raw) {
+	if (!isUnknownArray(raw)) throw new Error("fast-xml-parser output was not an ordered array");
+	return raw.map(parseNode);
+}
+function parseNode(raw) {
+	if (!isRecord(raw)) throw new Error("fast-xml-parser node was not an object");
+	let tagKey;
+	for (const key of Object.keys(raw)) if (key !== ":@") {
+		if (tagKey !== void 0) throw new Error("XML node had multiple tag keys");
+		tagKey = key;
+	}
+	if (tagKey === void 0) throw new Error("XML node had no tag key");
+	const attributes = parseAttributes(raw[":@"]);
+	if (tagKey === "#text") return {
+		type: "text",
+		value: asString(raw["#text"])
+	};
+	if (tagKey === "__comment") return {
+		type: "comment",
+		value: scalarText(raw.__comment)
+	};
+	if (tagKey === "__cdata") return {
+		type: "cdata",
+		value: scalarText(raw.__cdata)
+	};
+	if (tagKey === "?xml") return {
+		type: "declaration",
+		attributes
+	};
+	if (tagKey.startsWith("?")) return {
+		type: "pi",
+		target: tagKey.slice(1),
+		content: scalarText(raw[tagKey])
+	};
+	return {
+		type: "element",
+		tag: tagKey,
+		attributes,
+		children: parseNodes(raw[tagKey])
+	};
+}
+function parseAttributes(raw) {
+	if (raw === void 0) return [];
+	if (!isRecord(raw)) throw new Error("XML attributes were not an object");
+	const attrs = [];
+	for (const key of Object.keys(raw)) {
+		if (!key.startsWith("@_")) throw new Error(`unexpected attribute key without @_ prefix: ${key}`);
+		attrs.push({
+			name: key.slice(2),
+			value: asString(raw[key])
+		});
+	}
+	return attrs;
+}
+function scalarText(raw) {
+	if (!isUnknownArray(raw) || raw.length === 0) throw new Error("expected a scalar-text wrapper array");
+	const first = raw[0];
+	if (!isRecord(first)) throw new Error("scalar-text wrapper was not an object");
+	return asString(first["#text"]);
+}
+//#endregion
+export { parseXml };

package/dist/xml/query.cjs

@@ -0,0 +1,44 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/xml/query.ts
+function rootElement(nodes) {
+	for (const node of nodes) if (node.type === "element") return node;
+}
+function findChildElement(nodes, tag) {
+	for (const node of nodes) if (node.type === "element" && node.tag === tag) return node;
+}
+function childrenWithTag(element, tag) {
+	const out = [];
+	for (const child of element.children) if (child.type === "element" && child.tag === tag) out.push(child);
+	return out;
+}
+function* walk(nodes) {
+	for (const node of nodes) {
+		yield node;
+		if (node.type === "element") yield* walk(node.children);
+	}
+}
+function elementsWithTag(nodes, tag) {
+	const out = [];
+	for (const node of walk(nodes)) if (node.type === "element" && node.tag === tag) out.push(node);
+	return out;
+}
+function findElement(nodes, predicate) {
+	for (const node of walk(nodes)) if (node.type === "element" && predicate(node)) return node;
+}
+function attrValue(element, name) {
+	return element.attributes.find((attribute) => attribute.name === name)?.value;
+}
+function textContent(nodes) {
+	let out = "";
+	for (const node of nodes) if (node.type === "text") out += node.value;
+	else if (node.type === "element") out += textContent(node.children);
+	return out;
+}
+//#endregion
+exports.attrValue = attrValue;
+exports.childrenWithTag = childrenWithTag;
+exports.elementsWithTag = elementsWithTag;
+exports.findChildElement = findChildElement;
+exports.findElement = findElement;
+exports.rootElement = rootElement;
+exports.textContent = textContent;

package/dist/xml/query.d.cts

@@ -0,0 +1,11 @@
+import { XmlElement, XmlNode } from "./node.cjs";
+//#region src/xml/query.d.ts
+declare function rootElement(nodes: readonly XmlNode[]): XmlElement | undefined;
+declare function findChildElement(nodes: readonly XmlNode[], tag: string): XmlElement | undefined;
+declare function childrenWithTag(element: XmlElement, tag: string): XmlElement[];
+declare function elementsWithTag(nodes: readonly XmlNode[], tag: string): XmlElement[];
+declare function findElement(nodes: readonly XmlNode[], predicate: (element: XmlElement) => boolean): XmlElement | undefined;
+declare function attrValue(element: XmlElement, name: string): string | undefined;
+declare function textContent(nodes: readonly XmlNode[]): string;
+//#endregion
+export { attrValue, childrenWithTag, elementsWithTag, findChildElement, findElement, rootElement, textContent };

package/dist/xml/query.d.ts

@@ -0,0 +1,11 @@
+import { XmlElement, XmlNode } from "./node.js";
+//#region src/xml/query.d.ts
+declare function rootElement(nodes: readonly XmlNode[]): XmlElement | undefined;
+declare function findChildElement(nodes: readonly XmlNode[], tag: string): XmlElement | undefined;
+declare function childrenWithTag(element: XmlElement, tag: string): XmlElement[];
+declare function elementsWithTag(nodes: readonly XmlNode[], tag: string): XmlElement[];
+declare function findElement(nodes: readonly XmlNode[], predicate: (element: XmlElement) => boolean): XmlElement | undefined;
+declare function attrValue(element: XmlElement, name: string): string | undefined;
+declare function textContent(nodes: readonly XmlNode[]): string;
+//#endregion
+export { attrValue, childrenWithTag, elementsWithTag, findChildElement, findElement, rootElement, textContent };

package/dist/xml/query.js

@@ -0,0 +1,37 @@
+//#region src/xml/query.ts
+function rootElement(nodes) {
+	for (const node of nodes) if (node.type === "element") return node;
+}
+function findChildElement(nodes, tag) {
+	for (const node of nodes) if (node.type === "element" && node.tag === tag) return node;
+}
+function childrenWithTag(element, tag) {
+	const out = [];
+	for (const child of element.children) if (child.type === "element" && child.tag === tag) out.push(child);
+	return out;
+}
+function* walk(nodes) {
+	for (const node of nodes) {
+		yield node;
+		if (node.type === "element") yield* walk(node.children);
+	}
+}
+function elementsWithTag(nodes, tag) {
+	const out = [];
+	for (const node of walk(nodes)) if (node.type === "element" && node.tag === tag) out.push(node);
+	return out;
+}
+function findElement(nodes, predicate) {
+	for (const node of walk(nodes)) if (node.type === "element" && predicate(node)) return node;
+}
+function attrValue(element, name) {
+	return element.attributes.find((attribute) => attribute.name === name)?.value;
+}
+function textContent(nodes) {
+	let out = "";
+	for (const node of nodes) if (node.type === "text") out += node.value;
+	else if (node.type === "element") out += textContent(node.children);
+	return out;
+}
+//#endregion
+export { attrValue, childrenWithTag, elementsWithTag, findChildElement, findElement, rootElement, textContent };

package/dist/zip.cjs

@@ -0,0 +1,19 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let fflate = require("fflate");
+//#region src/zip.ts
+function unzipPackage(bytes) {
+	return (0, fflate.unzipSync)(bytes);
+}
+const FIXED_ENTRY_MTIME = new Date(Date.UTC(1980, 0, 1, 0, 0, 0));
+function zipPackage(entries) {
+	const data = {};
+	for (const [path, entry] of entries) if (entry.stored === true) data[path] = [entry.bytes, {
+		level: 0,
+		mtime: FIXED_ENTRY_MTIME
+	}];
+	else data[path] = [entry.bytes, { mtime: FIXED_ENTRY_MTIME }];
+	return (0, fflate.zipSync)(data);
+}
+//#endregion
+exports.unzipPackage = unzipPackage;
+exports.zipPackage = zipPackage;

package/dist/zip.d.cts

@@ -0,0 +1,9 @@
+//#region src/zip.d.ts
+interface ZipEntry {
+  readonly bytes: Uint8Array<ArrayBuffer>;
+  readonly stored?: boolean;
+}
+declare function unzipPackage(bytes: Uint8Array<ArrayBuffer>): Record<string, Uint8Array<ArrayBuffer>>;
+declare function zipPackage(entries: readonly (readonly [string, ZipEntry])[]): Uint8Array<ArrayBuffer>;
+//#endregion
+export { ZipEntry, unzipPackage, zipPackage };

package/dist/zip.d.ts

@@ -0,0 +1,9 @@
+//#region src/zip.d.ts
+interface ZipEntry {
+  readonly bytes: Uint8Array<ArrayBuffer>;
+  readonly stored?: boolean;
+}
+declare function unzipPackage(bytes: Uint8Array<ArrayBuffer>): Record<string, Uint8Array<ArrayBuffer>>;
+declare function zipPackage(entries: readonly (readonly [string, ZipEntry])[]): Uint8Array<ArrayBuffer>;
+//#endregion
+export { ZipEntry, unzipPackage, zipPackage };

package/dist/zip.js

@@ -0,0 +1,17 @@
+import { unzipSync, zipSync } from "fflate";
+//#region src/zip.ts
+function unzipPackage(bytes) {
+	return unzipSync(bytes);
+}
+const FIXED_ENTRY_MTIME = new Date(Date.UTC(1980, 0, 1, 0, 0, 0));
+function zipPackage(entries) {
+	const data = {};
+	for (const [path, entry] of entries) if (entry.stored === true) data[path] = [entry.bytes, {
+		level: 0,
+		mtime: FIXED_ENTRY_MTIME
+	}];
+	else data[path] = [entry.bytes, { mtime: FIXED_ENTRY_MTIME }];
+	return zipSync(data);
+}
+//#endregion
+export { unzipPackage, zipPackage };

package/package.json

@@ -1,5 +1,98 @@
 {
   "name": "epub-codec",
-  "version": "0.0.0",
-  "private": false
+  "version": "1.0.0",
+  "description": "EPUB 2/3 reading and deterministic EPUB 3 writing against the shared document-schema.js content pivot.",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExaDev/documents.js.git",
+    "directory": "packages/epub-codec"
+  },
+  "homepage": "https://github.com/ExaDev/documents.js/tree/main/packages/epub-codec",
+  "bugs": {
+    "url": "https://github.com/ExaDev/documents.js/issues"
+  },
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./*": {
+      "types": {
+        "import": "./dist/*.d.ts",
+        "require": "./dist/*.d.cts"
+      },
+      "import": "./dist/*.js",
+      "require": "./dist/*.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "turbo run _build",
+    "_build": "tsdown",
+    "prepublishOnly": "pnpm run lint && pnpm run typecheck && tsdown && publint && attw --pack",
+    "lint": "turbo run _lint",
+    "_lint": "eslint . --fix --cache --max-warnings 0",
+    "lint:check": "eslint . --max-warnings 0",
+    "typecheck": "turbo run _typecheck _typecheck:attw",
+    "_typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.node.json",
+    "_typecheck:attw": "attw --pack",
+    "test": "turbo run _test",
+    "_test": "vitest run --project unit",
+    "test:watch": "vitest --project unit",
+    "test:workers": "turbo run _test:workers",
+    "_test:workers": "vitest run --config vitest.workers.config.ts",
+    "test:smoke": "turbo run _test:smoke",
+    "_test:smoke": "vitest run --project smoke",
+    "prepare": "husky"
+  },
+  "keywords": [
+    "epub",
+    "epub2",
+    "epub3",
+    "codec",
+    "zod",
+    "ebook"
+  ],
+  "license": "MIT",
+  "packageManager": "pnpm@11.6.0",
+  "dependencies": {
+    "document-schema.js": "^5.4.0",
+    "fast-xml-parser": "^5.10.1",
+    "fflate": "^0.8.3",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@cloudflare/vitest-pool-workers": "^0.20.1",
+    "@types/node": "^26.1.2",
+    "eslint": "^10.8.0",
+    "husky": "^9.1.7",
+    "publint": "^0.3.21",
+    "tsdown": "^0.22.13",
+    "turbo": "^2.10.8",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10"
+  },
+  "lint-staged": {
+    "*.ts": "eslint --fix"
+  }
 }