@storyteller-platform/epub 0.6.1 → 0.6.3

package/README.md

@@ -4284,4 +4284,365 @@ Defined in:
 [epub/adapters/memory.ts:22](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L22)
 
 per-entry decompressed buffer cache turn it off when opening many EPUBs and
-reading eac
+reading each entry at most once keeps resident size bounded by the entry index,
+not the decompressed payload sum
+
+##### Default
+
+```ts
+true
+```
+
+#### signal?
+
+> `optional` **signal**: `AbortSignal`
+
+Defined in:
+[epub/adapters/memory.ts:23](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L23)
+
+---
+
+## Navigation
+
+Defined in:
+[epub/index.ts:165](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L165)
+
+### Properties
+
+#### children
+
+> **children**: [`NavigationList`](#navigationlist)
+
+Defined in:
+[epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L167)
+
+#### title?
+
+> `optional` **title**: `string`
+
+Defined in:
+[epub/index.ts:166](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L166)
+
+---
+
+## NavigationItem
+
+Defined in:
+[epub/index.ts:157](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L157)
+
+### Properties
+
+#### children?
+
+> `optional` **children**: [`NavigationList`](#navigationlist)
+
+Defined in:
+[epub/index.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L160)
+
+#### href?
+
+> `optional` **href**: `string`
+
+Defined in:
+[epub/index.ts:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L159)
+
+#### title
+
+> **title**: `string`
+
+Defined in:
+[epub/index.ts:158](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L158)
+
+---
+
+## AdapterOptions\<A\>
+
+> **AdapterOptions**\<`A`\> = `A` _extends_
+> [`EpubStorageAdapterClass`](#epubstorageadapterclass)\<infer Opts\> ? `Opts` :
+> `object`
+
+Defined in:
+[epub/adapters/interface.ts:82](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L82)
+
+### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `A`            |
+
+---
+
+## ElementName
+
+> **ElementName** =
+> \`$\{Letter \| Uppercase\<Letter\> \| QuestionMark\}$\{string\}\`
+
+Defined in:
+[epub/index.ts:82](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L82)
+
+A valid name for an XML element (must start with a letter)
+
+---
+
+## EpubInstanceFor\<A\>
+
+> **EpubInstanceFor**\<`A`\> = `A`\[`"capabilities"`\]\[`"writable"`\] _extends_
+> `true` ? [`Epub`](#epub) : [`EpubReader`](#epubreader)
+
+Defined in:
+[epub/index.ts:3006](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3006)
+
+Resolves to [Epub](#epub) for writable adapters, [EpubReader](#epubreader) for
+read-only ones.
+
+The conditional pivots on `capabilities.writable`, which must be a literal
+`true`/`false` on the adapter class (use `as const`) for inference to work.
+
+### Type Parameters
+
+| Type Parameter                                                      |
+| ------------------------------------------------------------------- |
+| `A` _extends_ [`EpubStorageAdapterClass`](#epubstorageadapterclass) |
+
+---
+
+## EpubMetadata
+
+> **EpubMetadata** = [`MetadataEntry`](#metadataentry)[]
+
+Defined in:
+[epub/index.ts:119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L119)
+
+---
+
+## EpubReader
+
+> **EpubReader** = `Pick`\<[`Epub`](#epub), `"storage"` \| `"getManifest"` \|
+> `"getVersion"` \| `"getLayout"` \| `"getBaseDirection"` \| `"getMetadata"` \|
+> `"findMetadataItem"` \| `"findAllMetadataItems"` \| `"getIdentifier"` \|
+> `"getTitle"` \| `"getSubtitle"` \| `"getTitles"` \| `"getLanguage"` \|
+> `"getPublicationDate"` \| `"getModifiedDate"` \| `"getDescription"` \|
+> `"getType"` \| `"getCreators"` \| `"getContributors"` \| `"getSubjects"` \|
+> `"getCollections"` \| `"getPackageVocabularyPrefixes"` \|
+> `"getCoverImageItem"` \| `"getCoverImage"` \| `"getSpineItems"` \|
+> `"getNcxTableOfContents"` \| `"getGuideEntries"` \| `"getTableOfContents"` \|
+> `"getLandmarks"` \| `"getPageList"` \| `"resolveHref"` \| `"readFileContents"`
+> \| `"readItemContents"` \| `"readXhtmlItemContents"` \|
+> `"getItemArchiveLength"` \| `"discardAndClose"`\> & `Disposable`
+
+Defined in:
+[epub/index.ts:190](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L190)
+
+Read-only view of an EPUB Returned by Epub.using(MemoryAdapter).from(...) and by
+Epub.from(path, { readonly: true })
+
+---
+
+## EpubStorageKind
+
+> **EpubStorageKind** = `"tmp-dir"` \| `"in-memory"` \| `string` & `object`
+
+Defined in:
+[epub/adapters/interface.ts:10](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L10)
+
+Pluggable storage backend for an Epub instance
+
+Built-in adapters:
+
+- [TmpFsAdapter](#tmpfsadapter) extracts the archive to a tmp directory and
+  supports the full read/write/save/upgrade
+- [MemoryAdapter](#memoryadapter) keeps an in-memory zip handle and supports
+  reads only
+
+---
+
+## InMemoryEpubReader
+
+> **InMemoryEpubReader** = [`EpubReader`](#epubreader) & `object`
+
+Defined in:
+[epub/index.ts:235](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L235)
+
+Readonly Epub-instance backed by an in-memory zip handle Returned by
+`Epub.using(MemoryAdapter).from(...)`
+
+### Type Declaration
+
+#### storage
+
+> `readonly` **storage**: `"in-memory"`
+
+---
+
+## ManifestItem
+
+> **ManifestItem** = `object`
+
+Defined in:
+[epub/index.ts:103](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L103)
+
+### Properties
+
+#### fallback?
+
+> `optional` **fallback**: `string`
+
+Defined in:
+[epub/index.ts:107](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L107)
+
+#### href
+
+> **href**: `string`
+
+Defined in:
+[epub/index.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L105)
+
+#### id
+
+> **id**: `string`
+
+Defined in:
+[epub/index.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L104)
+
+#### mediaOverlay?
+
+> `optional` **mediaOverlay**: `string`
+
+Defined in:
+[epub/index.ts:108](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L108)
+
+#### mediaType?
+
+> `optional` **mediaType**: `string`
+
+Defined in:
+[epub/index.ts:106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L106)
+
+#### properties?
+
+> `optional` **properties**: `string`[]
+
+Defined in:
+[epub/index.ts:109](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L109)
+
+---
+
+## MetadataEntry
+
+> **MetadataEntry** = `object`
+
+Defined in:
+[epub/index.ts:112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L112)
+
+### Properties
+
+#### id?
+
+> `optional` **id**: `string`
+
+Defined in:
+[epub/index.ts:113](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L113)
+
+#### properties
+
+> **properties**: `Record`\<`string`, `string`\>
+
+Defined in:
+[epub/index.ts:115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L115)
+
+#### type
+
+> **type**: [`ElementName`](#elementname)
+
+Defined in:
+[epub/index.ts:114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L114)
+
+#### value
+
+> **value**: `string` \| `undefined`
+
+Defined in:
+[epub/index.ts:116](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L116)
+
+---
+
+## NavigationList
+
+> **NavigationList** = [`NavigationItem`](#navigationitem)[]
+
+Defined in:
+[epub/index.ts:163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L163)
+
+---
+
+## PackageElement
+
+> **PackageElement** = [`XmlElement`](#xmlelement)\<`"package"`\>
+
+Defined in:
+[epub/index.ts:176](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L176)
+
+---
+
+## ParsedXml
+
+> **ParsedXml** = [`XmlNode`](#xmlnode)[]
+
+Defined in:
+[epub/index.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L101)
+
+An XML structure
+
+---
+
+## XmlElement\<Name\>
+
+> **XmlElement**\<`Name`\> = `object` & `{ [key in Name]: ParsedXml }`
+
+Defined in:
+[epub/index.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L88)
+
+An XML element
+
+### Type Declaration
+
+#### :@?
+
+> `optional` **:@**: `Record`\<`` `${PropertyPrefix}${string}` ``, `string`\>
+
+### Type Parameters
+
+| Type Parameter                                 | Default type                  |
+| ---------------------------------------------- | ----------------------------- |
+| `Name` _extends_ [`ElementName`](#elementname) | [`ElementName`](#elementname) |
+
+---
+
+## XmlNode
+
+> **XmlNode** = [`XmlElement`](#xmlelement) \| [`XmlTextNode`](#xmltextnode)
+
+Defined in:
+[epub/index.ts:98](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L98)
+
+A valid XML node. May be either an element or a text node.
+
+---
+
+## XmlTextNode
+
+> **XmlTextNode** = `object`
+
+Defined in:
+[epub/index.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L95)
+
+A text node in an XML document
+
+### Properties
+
+#### #text
+
+> **#text**: `string`
+
+Defined in:
+[epub/index.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L95)

package/dist/epubcheck.cjs

@@ -0,0 +1,60 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var epubcheck_exports = {};
+__export(epubcheck_exports, {
+  epubcheck: () => epubcheck
+});
+module.exports = __toCommonJS(epubcheck_exports);
+var import_node_child_process = require("node:child_process");
+var import_node_crypto = require("node:crypto");
+var import_promises = require("node:fs/promises");
+var import_node_os = require("node:os");
+var import_node_path = require("node:path");
+var import_node_url = require("node:url");
+var import_node_util = require("node:util");
+const import_meta = {};
+const here = (0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(import_meta.url));
+const JAR = (0, import_node_path.join)(here, "vendors", "epubcheck-5.3.0", "epubcheck.jar");
+async function epubcheck(epubFile) {
+  const output = (0, import_node_path.join)((0, import_node_os.tmpdir)(), `epubcheck-${(0, import_node_crypto.randomUUID)()}.json`);
+  const execFilePromise = (0, import_node_util.promisify)(import_node_child_process.execFile);
+  try {
+    await execFilePromise("java", [
+      "-jar",
+      JAR,
+      "--json",
+      output,
+      epubFile
+    ]).catch((error) => {
+      if (error instanceof Error && error.message.includes("Check finished with errors")) {
+        return;
+      }
+      throw error;
+    });
+    const json = await (0, import_promises.readFile)(output, "utf8");
+    return JSON.parse(json);
+  } finally {
+    await (0, import_promises.unlink)(output).catch(() => {
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  epubcheck
+});

package/dist/epubcheck.d.cts

@@ -0,0 +1,23 @@
+interface Location {
+    url: {
+        hierachical: boolean;
+        opaque: boolean;
+    };
+    path: string;
+    line: number;
+    column: number;
+    context: string | null;
+}
+interface Message {
+    ID: string;
+    severity: "FATAL" | "ERROR" | "WARNING" | "INFO" | "USAGE";
+    message: string;
+    additionalLocations: number;
+    locations: Location[];
+}
+interface Report {
+    messages: Message[];
+}
+declare function epubcheck(epubFile: string): Promise<Report>;
+
+export { type Location, type Message, type Report, epubcheck };

package/dist/epubcheck.d.ts

@@ -0,0 +1,23 @@
+interface Location {
+    url: {
+        hierachical: boolean;
+        opaque: boolean;
+    };
+    path: string;
+    line: number;
+    column: number;
+    context: string | null;
+}
+interface Message {
+    ID: string;
+    severity: "FATAL" | "ERROR" | "WARNING" | "INFO" | "USAGE";
+    message: string;
+    additionalLocations: number;
+    locations: Location[];
+}
+interface Report {
+    messages: Message[];
+}
+declare function epubcheck(epubFile: string): Promise<Report>;
+
+export { type Location, type Message, type Report, epubcheck };

package/dist/epubcheck.js

@@ -0,0 +1,36 @@
+import "./chunk-BIEQXUOY.js";
+import { execFile } from "node:child_process";
+import { randomUUID } from "node:crypto";
+import { readFile, unlink } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { promisify } from "node:util";
+const here = dirname(fileURLToPath(import.meta.url));
+const JAR = join(here, "vendors", "epubcheck-5.3.0", "epubcheck.jar");
+async function epubcheck(epubFile) {
+  const output = join(tmpdir(), `epubcheck-${randomUUID()}.json`);
+  const execFilePromise = promisify(execFile);
+  try {
+    await execFilePromise("java", [
+      "-jar",
+      JAR,
+      "--json",
+      output,
+      epubFile
+    ]).catch((error) => {
+      if (error instanceof Error && error.message.includes("Check finished with errors")) {
+        return;
+      }
+      throw error;
+    });
+    const json = await readFile(output, "utf8");
+    return JSON.parse(json);
+  } finally {
+    await unlink(output).catch(() => {
+    });
+  }
+}
+export {
+  epubcheck
+};

package/dist/index.cjs

@@ -1289,7 +1289,14 @@ ${JSON.stringify(element, null, 2)}`
     const creatorEntries = metadata.filter(
       (entry) => entry.type === `dc:${type}`
     );
-    const creators = creatorEntries.map(({ value }) => value).filter((value) => !!value).map((value) => ({ name: value }));
+    const creators = [];
+    const creatorsById = /* @__PURE__ */ new Map();
+    for (const entry of creatorEntries) {
+      if (!entry.value) continue;
+      const creator = { name: entry.value };
+      creators.push(creator);
+      if (entry.id) creatorsById.set(entry.id, creator);
+    }
     metadata.forEach((entry) => {
       if (entry.type !== "meta" || entry.properties["property"] !== "file-as" && entry.properties["property"] !== "role" && entry.properties["property"] !== "alternate-script" || !entry.value) {
         return;
@@ -1297,9 +1304,8 @@ ${JSON.stringify(element, null, 2)}`
       const creatorIdref = entry.properties["refines"];
       if (!creatorIdref) return;
       const creatorId = creatorIdref.slice(1);
-      const index = creatorEntries.findIndex((entry2) => entry2.id === creatorId);
-      if (index === -1) return;
-      const creator = creators[index];
+      const creator = creatorsById.get(creatorId);
+      if (!creator) return;
       if (entry.properties["alternate-script"]) {
         if (!entry.properties["xml:lang"]) return;
         creator.alternateScripts ??= [];

package/dist/index.js

@@ -1257,7 +1257,14 @@ ${JSON.stringify(element, null, 2)}`
     const creatorEntries = metadata.filter(
       (entry) => entry.type === `dc:${type}`
     );
-    const creators = creatorEntries.map(({ value }) => value).filter((value) => !!value).map((value) => ({ name: value }));
+    const creators = [];
+    const creatorsById = /* @__PURE__ */ new Map();
+    for (const entry of creatorEntries) {
+      if (!entry.value) continue;
+      const creator = { name: entry.value };
+      creators.push(creator);
+      if (entry.id) creatorsById.set(entry.id, creator);
+    }
     metadata.forEach((entry) => {
       if (entry.type !== "meta" || entry.properties["property"] !== "file-as" && entry.properties["property"] !== "role" && entry.properties["property"] !== "alternate-script" || !entry.value) {
         return;
@@ -1265,9 +1272,8 @@ ${JSON.stringify(element, null, 2)}`
       const creatorIdref = entry.properties["refines"];
       if (!creatorIdref) return;
       const creatorId = creatorIdref.slice(1);
-      const index = creatorEntries.findIndex((entry2) => entry2.id === creatorId);
-      if (index === -1) return;
-      const creator = creators[index];
+      const creator = creatorsById.get(creatorId);
+      if (!creator) return;
       if (entry.properties["alternate-script"]) {
         if (!entry.properties["xml:lang"]) return;
         creator.alternateScripts ??= [];

package/dist/upgrade.d.cts

@@ -366,7 +366,7 @@ declare class Epub {
      */
     findMetadataItem(predicate: (entry: MetadataEntry) => boolean): Promise<{
         id: string | undefined;
-        type: `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}` | `?${string}`;
+        type: `?${string}` | `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}`;
         properties: {
             [k: string]: string;
         };
@@ -378,7 +378,7 @@ declare class Epub {
      */
     findAllMetadataItems(predicate: (entry: MetadataEntry) => boolean): Promise<{
         id: string | undefined;
-        type: `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}` | `?${string}`;
+        type: `?${string}` | `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}`;
         properties: {
             [k: string]: string;
         };

package/dist/upgrade.d.ts

@@ -366,7 +366,7 @@ declare class Epub {
      */
     findMetadataItem(predicate: (entry: MetadataEntry) => boolean): Promise<{
         id: string | undefined;
-        type: `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}` | `?${string}`;
+        type: `?${string}` | `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}`;
         properties: {
             [k: string]: string;
         };
@@ -378,7 +378,7 @@ declare class Epub {
      */
     findAllMetadataItems(predicate: (entry: MetadataEntry) => boolean): Promise<{
         id: string | undefined;
-        type: `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}` | `?${string}`;
+        type: `?${string}` | `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `i${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `I${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}`;
         properties: {
             [k: string]: string;
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyteller-platform/epub",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "type": "module",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,8 +23,9 @@
     "readme:toc": "markdown-toc --maxdepth=5 --append='\n- [API Docs](#api-docs)' --bullets='-' -i readme-stub.md",
     "readme:api": "typedoc",
     "readme": "yarn readme:api && yarn readme:toc && cat readme-stub.md > README.md && tail -n +2 gen/README.md >> README.md",
-    "test": "tsx -C @storyteller --test *.test.ts",
-    "test:watch": "tsx -C @storyteller --test --watch *.test.ts",
+    "install-epubcheck": "tsx scripts/install-epubcheck.ts",
+    "test": "yarn install-epubcheck && tsx -C @storyteller --test *.test.ts",
+    "test:watch": "yarn install-epubcheck && tsx -C @storyteller --test --watch *.test.ts",
     "prepack": "yarn build"
   },
   "devDependencies": {
@@ -35,7 +36,6 @@
     "@types/node": "^24.0.0",
     "@types/yauzl-promise": "^4",
     "@types/yazl": "^3",
-    "epubchecker": "^5.2.1",
     "eslint": "^8.0.0",
     "markdown-toc": "^1.2.0",
     "remark-toc": "^9.0.0",