@storyteller-platform/epub 0.5.1 → 0.6.0

package/dist/upgrade.d.cts

@@ -1,4 +1,7 @@
 import { XMLParser, XMLBuilder } from 'fast-xml-parser';
+import { EpubStorageAdapterClass, EpubStorageAdapter, EpubStorageKind, AdapterOptions } from './adapters/interface.cjs';
+import './adapters/memory.cjs';
+import './adapters/tmpfs.cjs';
 
 interface Landmark {
     href: string;
@@ -126,8 +129,29 @@ interface GuideItem {
     type: string;
 }
 type PackageElement = XmlElement<"package">;
+interface FromOptions {
+    /**
+     * when true, mutation methods throw {@link EpubReadOnlyError} at runtime
+     * @default false
+     */
+    readonly?: boolean;
+}
+/**
+ * Read-only view of an EPUB
+ * Returned by Epub.using(MemoryAdapter).from(...) and by Epub.from(path, { readonly: true })
+ */
+type EpubReader = Pick<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;
+/**
+ * Readonly Epub-instance backed by an in-memory zip handle
+ * Returned by `Epub.using(MemoryAdapter).from(...)`
+ */
+type InMemoryEpubReader = EpubReader & {
+    readonly storage: "in-memory";
+};
 declare class EpubVersionError extends Error {
 }
+declare class EpubReadOnlyError extends Error {
+}
 /**
  * A single EPUB instance.
  *
@@ -156,8 +180,10 @@ declare class EpubVersionError extends Error {
  * @link https://www.w3.org/TR/epub-33/
  */
 declare class Epub {
-    protected extractPath: string;
+    protected adapterClass: EpubStorageAdapterClass;
+    protected adapter: EpubStorageAdapter;
     protected inputPath: string | undefined;
+    protected readonlyOverride: boolean;
     static xmlParser: XMLParser;
     static xhtmlParser: XMLParser;
     static xmlBuilder: XMLBuilder;
@@ -229,34 +255,78 @@ declare class Epub {
     private manifest;
     private spine;
     private packageMutex;
-    protected constructor(extractPath: string, inputPath: string | undefined);
     /**
-     * Construct an Epub instance, optionally beginning
-     * with the provided metadata.
+     * Storage backend kind in use for this instance
+     *
+     * Public so callers can declare type-level requirements via {@link InMemoryEpubReader}
+     * Orthogonal to the read-only / writable axis (controlled by `readonlyOverride`
+     * and the adapter's capability bag)
+     */
+    readonly storage: EpubStorageKind;
+    /**
+     * Prefer the static factories ({@link Epub.using}, {@link Epub.from},
+     * {@link Epub.create}, {@link Epub.upgrade}) over calling this constructor
+     * directly. It's public so {@link EpubFactory} can construct instances; nothing
+     * else should need to.
+     */
+    constructor(adapterClass: EpubStorageAdapterClass, adapter: EpubStorageAdapter, inputPath: string | undefined, readonlyOverride?: boolean);
+    /**
+     * Runtime guard for mutation methods
+     */
+    private assertWritable;
+    /**
+     * Construct a new EPUB on a writable backend, optionally seeded
+     * with the provided metadata. Equivalent to
+     * `Epub.using(TmpFsAdapter).create(...)`.
      *
      * @param dublinCore Core metadata terms
      * @param additionalMetadata An array of additional metadata entries
      */
-    static create(path: string, { title, language, identifier, date, subjects, type, creators, contributors, }: DublinCore, additionalMetadata?: EpubMetadata): Promise<Epub>;
+    static create(path: string, dublinCore: DublinCore, additionalMetadata?: EpubMetadata): Promise<Epub>;
     /**
-     * Construct an Epub instance by reading an existing EPUB
-     * publication.
+     * Specify the storage backend to use for the EPUB
+     *
+     * The returned factory exposes `from`, `create`, and `upgrade`,
+     * which route through the supplied adapter.
      *
-     * @param pathOrData Must be either a string representing the
-     *        path to an EPUB file on disk, or a Uint8Array representing
-     *        the data of the EPUB publication.
+     * @example
+     * ```ts
+     * using epub = await Epub.using(TmpFsAdapter).from(path)
+     * using reader = await Epub.using(MemoryAdapter).from(buffer, { cache: false })
+     * ```
      */
-    static from(pathOrData: string | Uint8Array): Promise<Epub>;
+    static using<A extends EpubStorageAdapterClass>(adapterClass: A): EpubFactory<A>;
     /**
-     * Open an EPUB publication and return an Epub instance.
+     * Open an existing EPUB publication, extracting it to a temp directory
+     * so writes can mutate the unpacked tree and rezip with `saveAndClose`.
+     *
+     * Pass `{ readonly: true }` to gate mutations at runtime.
+     *
+     * prefer `Epub.using(TmpFsAdapter).from(path)` (or
+     *   `Epub.using(MemoryAdapter).from(path)` for read-only, in-memory access)
+     * @throws {EpubVersionError} when the archive is not a valid EPUB 3
      */
-    private static open;
+    static from(pathOrData: string | Uint8Array): Promise<Epub>;
+    static from(pathOrData: string | Uint8Array, options: FromOptions & {
+        readonly: true;
+    }): Promise<EpubReader>;
+    static from(pathOrData: string | Uint8Array, options?: FromOptions): Promise<Epub | EpubReader>;
+    static assertEpub3(epub: Epub): Promise<void>;
     copy(path?: string): Promise<Epub>;
     private removeEntry;
+    /**
+     * Read raw bytes (or utf-8 text) from the underlying adapter
+     */
     private getFileData;
+    /**
+     * Length of the underlying archive entry for a manifest item, in bytes
+     * Necessary to compute the readium page count which is for COMPRESSED content
+     * @see {@link https://github.com/readium/architecture/issues/123}
+     */
+    getItemArchiveLength(id: string): Promise<number>;
     getRootfile(): Promise<string>;
     private getPackageDocument;
-    private getPackageElement;
+    getPackageElement(): Promise<XmlElement<"package">>;
     /**
      * Safely modify the package document, without race conditions.
      *
@@ -269,7 +339,7 @@ declare class Epub {
      *    it returns a new package document, that will be persisted, otherwise
      *    it will be assumed that the package document was modified in place.
      */
-    private withPackage;
+    withPackage(producer: ((packageElement: PackageElement) => void) | ((packageElement: PackageElement) => PackageElement) | ((packageElement: PackageElement) => Promise<PackageElement>) | ((packageElement: PackageElement) => Promise<void>)): Promise<void>;
     /**
      * Retrieve the manifest for the Epub.
      *
@@ -891,7 +961,55 @@ declare class Epub {
      */
     saveAndClose(): Promise<void>;
     /**
-     * Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new, valid Epub 3 instance.
+     * Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new,
+     * valid Epub 3 instance. Equivalent to
+     * `Epub.using(TmpFsAdapter).upgrade(...)`.
+     */
+    static upgrade(path: string, options?: Epub2UpgradeOptions): Promise<Epub>;
+    [Symbol.dispose](): void;
+}
+/**
+ * Resolves to {@link Epub} for writable adapters, {@link 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 EpubInstanceFor<A extends EpubStorageAdapterClass> = A["capabilities"]["writable"] extends true ? Epub : EpubReader;
+/**
+ * Adapter-bound factory returned by {@link Epub.using}.
+ *
+ * Mirrors the static factory surface (`from`, `create`, `upgrade`) but routes
+ * all I/O through the supplied adapter. Each method's signature degrades
+ * gracefully when the adapter doesn't support the operation: `create` and
+ * `upgrade` throw at runtime if the adapter is read-only or lacks `initEmpty`.
+ */
+declare class EpubFactory<A extends EpubStorageAdapterClass> {
+    readonly adapterClass: A;
+    constructor(adapterClass: A);
+    /**
+     * Open an existing EPUB through this factory's adapter
+     *
+     * @throws {EpubVersionError} when the archive is not a valid EPUB 3
+     */
+    from(source: string | Uint8Array, options: FromOptions & {
+        readonly: true;
+    } & AdapterOptions<A>): Promise<EpubReader & {
+        storage: A["kind"];
+    }>;
+    from(source: string | Uint8Array, options?: FromOptions & AdapterOptions<A>): Promise<EpubInstanceFor<A> & {
+        storage: A["kind"];
+    }>;
+    /**
+     * Construct a new EPUB on this factory's adapter, optionally seeded
+     * with the provided metadata. Requires a writable adapter that
+     * implements `initEmpty` (today: {@link TmpFsAdapter}).
+     *
+     * @throws when the adapter is read-only or does not implement initEmpty
+     */
+    create(path: string, { title, language, identifier, date, subjects, type, creators, contributors, }: DublinCore, additionalMetadata?: EpubMetadata): Promise<EpubInstanceFor<A>>;
+    /**
+     * Upgrade an EPUB 2 publication to EPUB 3 in place using this
+     * factory's adapter, returning a new, valid Epub 3 instance.
      *
      * Performs the following transformations:
      *  - upgrades OPF metadata to EPUB 3 conventions
@@ -901,9 +1019,14 @@ declare class Epub {
      *  - fixes common font MIME types
      *  - bumps the package version to 3.0
      *  - goes over each xhtml item and rewrites it using XMLParser to make sure the output is valid XHTML
+     *
+     * Requires a writable adapter. When {@link Upgrade.Epub2UpgradeOptions.outputPath}
+     * is set, the source file is copied to that path on disk first; this
+     * only makes sense for adapters whose `source` is a real fs path.
+     *
+     * @throws when the adapter is read-only
      */
-    static upgrade(path: string, options?: Epub2UpgradeOptions): Promise<Epub>;
-    [Symbol.dispose](): void;
+    upgrade(path: string, options?: Epub2UpgradeOptions): Promise<EpubInstanceFor<A>>;
 }
 
-export { type AlternateScript as A, type Collection as C, type DcSubject as D, type ElementName as E, type Epub2UpgradeOptions, type Landmark, type ManifestItem as M, type NavigationItem as N, type ParsedXml as P, type XmlElement as X, type XmlTextNode as a, type XmlNode as b, buildNavDocument, buildTocOl, type MetadataEntry as c, chooseNavHref, collectManifestProperties, type EpubMetadata as d, type DcCreator as e, extractGuideLandmarks, type DublinCore as f, fixFontMimeTypes, type NavigationList as g, type Navigation as h, type PackageElement as i, EpubVersionError as j, Epub as k, removeGuide, removeInvalidDcAttrs, removeNcx, removeSpineTocRef, setLastModified, setPackageVersion, upgradeAuthors, upgradeCover, upgradeDate, upgradeIdentifiers, upgradeLanguages, upgradeMeta, upgradePackageMetadata, upgradeTitle };
+export { type AlternateScript as A, type Collection as C, type DcSubject as D, type ElementName as E, type Epub2UpgradeOptions, type FromOptions as F, type InMemoryEpubReader as I, type Landmark, type ManifestItem as M, type NavigationItem as N, type ParsedXml as P, type XmlElement as X, type XmlTextNode as a, type XmlNode as b, buildNavDocument, buildTocOl, type MetadataEntry as c, chooseNavHref, collectManifestProperties, type EpubMetadata as d, type DcCreator as e, extractGuideLandmarks, type DublinCore as f, fixFontMimeTypes, type NavigationList as g, type Navigation as h, type PackageElement as i, type EpubReader as j, EpubVersionError as k, EpubReadOnlyError as l, Epub as m, type EpubInstanceFor as n, EpubFactory as o, removeGuide, removeInvalidDcAttrs, removeNcx, removeSpineTocRef, setLastModified, setPackageVersion, upgradeAuthors, upgradeCover, upgradeDate, upgradeIdentifiers, upgradeLanguages, upgradeMeta, upgradePackageMetadata, upgradeTitle };

package/dist/upgrade.d.ts

@@ -1,4 +1,7 @@
 import { XMLParser, XMLBuilder } from 'fast-xml-parser';
+import { EpubStorageAdapterClass, EpubStorageAdapter, EpubStorageKind, AdapterOptions } from './adapters/interface.js';
+import './adapters/memory.js';
+import './adapters/tmpfs.js';
 
 interface Landmark {
     href: string;
@@ -126,8 +129,29 @@ interface GuideItem {
     type: string;
 }
 type PackageElement = XmlElement<"package">;
+interface FromOptions {
+    /**
+     * when true, mutation methods throw {@link EpubReadOnlyError} at runtime
+     * @default false
+     */
+    readonly?: boolean;
+}
+/**
+ * Read-only view of an EPUB
+ * Returned by Epub.using(MemoryAdapter).from(...) and by Epub.from(path, { readonly: true })
+ */
+type EpubReader = Pick<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;
+/**
+ * Readonly Epub-instance backed by an in-memory zip handle
+ * Returned by `Epub.using(MemoryAdapter).from(...)`
+ */
+type InMemoryEpubReader = EpubReader & {
+    readonly storage: "in-memory";
+};
 declare class EpubVersionError extends Error {
 }
+declare class EpubReadOnlyError extends Error {
+}
 /**
  * A single EPUB instance.
  *
@@ -156,8 +180,10 @@ declare class EpubVersionError extends Error {
  * @link https://www.w3.org/TR/epub-33/
  */
 declare class Epub {
-    protected extractPath: string;
+    protected adapterClass: EpubStorageAdapterClass;
+    protected adapter: EpubStorageAdapter;
     protected inputPath: string | undefined;
+    protected readonlyOverride: boolean;
     static xmlParser: XMLParser;
     static xhtmlParser: XMLParser;
     static xmlBuilder: XMLBuilder;
@@ -229,34 +255,78 @@ declare class Epub {
     private manifest;
     private spine;
     private packageMutex;
-    protected constructor(extractPath: string, inputPath: string | undefined);
     /**
-     * Construct an Epub instance, optionally beginning
-     * with the provided metadata.
+     * Storage backend kind in use for this instance
+     *
+     * Public so callers can declare type-level requirements via {@link InMemoryEpubReader}
+     * Orthogonal to the read-only / writable axis (controlled by `readonlyOverride`
+     * and the adapter's capability bag)
+     */
+    readonly storage: EpubStorageKind;
+    /**
+     * Prefer the static factories ({@link Epub.using}, {@link Epub.from},
+     * {@link Epub.create}, {@link Epub.upgrade}) over calling this constructor
+     * directly. It's public so {@link EpubFactory} can construct instances; nothing
+     * else should need to.
+     */
+    constructor(adapterClass: EpubStorageAdapterClass, adapter: EpubStorageAdapter, inputPath: string | undefined, readonlyOverride?: boolean);
+    /**
+     * Runtime guard for mutation methods
+     */
+    private assertWritable;
+    /**
+     * Construct a new EPUB on a writable backend, optionally seeded
+     * with the provided metadata. Equivalent to
+     * `Epub.using(TmpFsAdapter).create(...)`.
      *
      * @param dublinCore Core metadata terms
      * @param additionalMetadata An array of additional metadata entries
      */
-    static create(path: string, { title, language, identifier, date, subjects, type, creators, contributors, }: DublinCore, additionalMetadata?: EpubMetadata): Promise<Epub>;
+    static create(path: string, dublinCore: DublinCore, additionalMetadata?: EpubMetadata): Promise<Epub>;
     /**
-     * Construct an Epub instance by reading an existing EPUB
-     * publication.
+     * Specify the storage backend to use for the EPUB
+     *
+     * The returned factory exposes `from`, `create`, and `upgrade`,
+     * which route through the supplied adapter.
      *
-     * @param pathOrData Must be either a string representing the
-     *        path to an EPUB file on disk, or a Uint8Array representing
-     *        the data of the EPUB publication.
+     * @example
+     * ```ts
+     * using epub = await Epub.using(TmpFsAdapter).from(path)
+     * using reader = await Epub.using(MemoryAdapter).from(buffer, { cache: false })
+     * ```
      */
-    static from(pathOrData: string | Uint8Array): Promise<Epub>;
+    static using<A extends EpubStorageAdapterClass>(adapterClass: A): EpubFactory<A>;
     /**
-     * Open an EPUB publication and return an Epub instance.
+     * Open an existing EPUB publication, extracting it to a temp directory
+     * so writes can mutate the unpacked tree and rezip with `saveAndClose`.
+     *
+     * Pass `{ readonly: true }` to gate mutations at runtime.
+     *
+     * prefer `Epub.using(TmpFsAdapter).from(path)` (or
+     *   `Epub.using(MemoryAdapter).from(path)` for read-only, in-memory access)
+     * @throws {EpubVersionError} when the archive is not a valid EPUB 3
      */
-    private static open;
+    static from(pathOrData: string | Uint8Array): Promise<Epub>;
+    static from(pathOrData: string | Uint8Array, options: FromOptions & {
+        readonly: true;
+    }): Promise<EpubReader>;
+    static from(pathOrData: string | Uint8Array, options?: FromOptions): Promise<Epub | EpubReader>;
+    static assertEpub3(epub: Epub): Promise<void>;
     copy(path?: string): Promise<Epub>;
     private removeEntry;
+    /**
+     * Read raw bytes (or utf-8 text) from the underlying adapter
+     */
     private getFileData;
+    /**
+     * Length of the underlying archive entry for a manifest item, in bytes
+     * Necessary to compute the readium page count which is for COMPRESSED content
+     * @see {@link https://github.com/readium/architecture/issues/123}
+     */
+    getItemArchiveLength(id: string): Promise<number>;
     getRootfile(): Promise<string>;
     private getPackageDocument;
-    private getPackageElement;
+    getPackageElement(): Promise<XmlElement<"package">>;
     /**
      * Safely modify the package document, without race conditions.
      *
@@ -269,7 +339,7 @@ declare class Epub {
      *    it returns a new package document, that will be persisted, otherwise
      *    it will be assumed that the package document was modified in place.
      */
-    private withPackage;
+    withPackage(producer: ((packageElement: PackageElement) => void) | ((packageElement: PackageElement) => PackageElement) | ((packageElement: PackageElement) => Promise<PackageElement>) | ((packageElement: PackageElement) => Promise<void>)): Promise<void>;
     /**
      * Retrieve the manifest for the Epub.
      *
@@ -891,7 +961,55 @@ declare class Epub {
      */
     saveAndClose(): Promise<void>;
     /**
-     * Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new, valid Epub 3 instance.
+     * Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new,
+     * valid Epub 3 instance. Equivalent to
+     * `Epub.using(TmpFsAdapter).upgrade(...)`.
+     */
+    static upgrade(path: string, options?: Epub2UpgradeOptions): Promise<Epub>;
+    [Symbol.dispose](): void;
+}
+/**
+ * Resolves to {@link Epub} for writable adapters, {@link 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 EpubInstanceFor<A extends EpubStorageAdapterClass> = A["capabilities"]["writable"] extends true ? Epub : EpubReader;
+/**
+ * Adapter-bound factory returned by {@link Epub.using}.
+ *
+ * Mirrors the static factory surface (`from`, `create`, `upgrade`) but routes
+ * all I/O through the supplied adapter. Each method's signature degrades
+ * gracefully when the adapter doesn't support the operation: `create` and
+ * `upgrade` throw at runtime if the adapter is read-only or lacks `initEmpty`.
+ */
+declare class EpubFactory<A extends EpubStorageAdapterClass> {
+    readonly adapterClass: A;
+    constructor(adapterClass: A);
+    /**
+     * Open an existing EPUB through this factory's adapter
+     *
+     * @throws {EpubVersionError} when the archive is not a valid EPUB 3
+     */
+    from(source: string | Uint8Array, options: FromOptions & {
+        readonly: true;
+    } & AdapterOptions<A>): Promise<EpubReader & {
+        storage: A["kind"];
+    }>;
+    from(source: string | Uint8Array, options?: FromOptions & AdapterOptions<A>): Promise<EpubInstanceFor<A> & {
+        storage: A["kind"];
+    }>;
+    /**
+     * Construct a new EPUB on this factory's adapter, optionally seeded
+     * with the provided metadata. Requires a writable adapter that
+     * implements `initEmpty` (today: {@link TmpFsAdapter}).
+     *
+     * @throws when the adapter is read-only or does not implement initEmpty
+     */
+    create(path: string, { title, language, identifier, date, subjects, type, creators, contributors, }: DublinCore, additionalMetadata?: EpubMetadata): Promise<EpubInstanceFor<A>>;
+    /**
+     * Upgrade an EPUB 2 publication to EPUB 3 in place using this
+     * factory's adapter, returning a new, valid Epub 3 instance.
      *
      * Performs the following transformations:
      *  - upgrades OPF metadata to EPUB 3 conventions
@@ -901,9 +1019,14 @@ declare class Epub {
      *  - fixes common font MIME types
      *  - bumps the package version to 3.0
      *  - goes over each xhtml item and rewrites it using XMLParser to make sure the output is valid XHTML
+     *
+     * Requires a writable adapter. When {@link Upgrade.Epub2UpgradeOptions.outputPath}
+     * is set, the source file is copied to that path on disk first; this
+     * only makes sense for adapters whose `source` is a real fs path.
+     *
+     * @throws when the adapter is read-only
      */
-    static upgrade(path: string, options?: Epub2UpgradeOptions): Promise<Epub>;
-    [Symbol.dispose](): void;
+    upgrade(path: string, options?: Epub2UpgradeOptions): Promise<EpubInstanceFor<A>>;
 }
 
-export { type AlternateScript as A, type Collection as C, type DcSubject as D, type ElementName as E, type Epub2UpgradeOptions, type Landmark, type ManifestItem as M, type NavigationItem as N, type ParsedXml as P, type XmlElement as X, type XmlTextNode as a, type XmlNode as b, buildNavDocument, buildTocOl, type MetadataEntry as c, chooseNavHref, collectManifestProperties, type EpubMetadata as d, type DcCreator as e, extractGuideLandmarks, type DublinCore as f, fixFontMimeTypes, type NavigationList as g, type Navigation as h, type PackageElement as i, EpubVersionError as j, Epub as k, removeGuide, removeInvalidDcAttrs, removeNcx, removeSpineTocRef, setLastModified, setPackageVersion, upgradeAuthors, upgradeCover, upgradeDate, upgradeIdentifiers, upgradeLanguages, upgradeMeta, upgradePackageMetadata, upgradeTitle };
+export { type AlternateScript as A, type Collection as C, type DcSubject as D, type ElementName as E, type Epub2UpgradeOptions, type FromOptions as F, type InMemoryEpubReader as I, type Landmark, type ManifestItem as M, type NavigationItem as N, type ParsedXml as P, type XmlElement as X, type XmlTextNode as a, type XmlNode as b, buildNavDocument, buildTocOl, type MetadataEntry as c, chooseNavHref, collectManifestProperties, type EpubMetadata as d, type DcCreator as e, extractGuideLandmarks, type DublinCore as f, fixFontMimeTypes, type NavigationList as g, type Navigation as h, type PackageElement as i, type EpubReader as j, EpubVersionError as k, EpubReadOnlyError as l, Epub as m, type EpubInstanceFor as n, EpubFactory as o, removeGuide, removeInvalidDcAttrs, removeNcx, removeSpineTocRef, setLastModified, setPackageVersion, upgradeAuthors, upgradeCover, upgradeDate, upgradeIdentifiers, upgradeLanguages, upgradeMeta, upgradePackageMetadata, upgradeTitle };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyteller-platform/epub",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "type": "module",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -47,6 +47,7 @@
     "typescript": "^5.9.2"
   },
   "dependencies": {
+    "@readium/shared": "^2.2.0",
     "@storyteller-platform/fs": "^0.1.4",
     "@storyteller-platform/path": "^0.1.2",
     "@zip.js/zip.js": "^2.0.0",