npm - @storyteller-platform/epub - Versions diffs - 0.4.8 → 0.4.10 - Mend

@storyteller-platform/epub 0.4.8 → 0.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -220,7 +220,7 @@ To get started with developing in the Storyteller monorepo, check out the
 ## Epub
 Defined in:
-[epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L167)
+[epub/index.ts:206](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L206)
 A single EPUB instance.
@@ -262,7 +262,7 @@ https://www.w3.org/TR/epub-33/
 > `protected` **new Epub**(`extractPath`, `inputPath`): [`Epub`](#epub)
 Defined in:
-[epub/index.ts:391](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L391)
+[epub/index.ts:430](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L430)
 ##### Parameters
@@ -282,42 +282,42 @@ Defined in:
 > `protected` **extractPath**: `string`
 Defined in:
-[epub/index.ts:392](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L392)
+[epub/index.ts:431](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L431)
 #### inputPath
 > `protected` **inputPath**: `undefined` \| `string`
 Defined in:
-[epub/index.ts:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L393)
+[epub/index.ts:432](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L432)
 #### xhtmlBuilder
 > `static` **xhtmlBuilder**: `XMLBuilder`
 Defined in:
-[epub/index.ts:215](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L215)
+[epub/index.ts:254](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L254)
 #### xhtmlParser
 > `static` **xhtmlParser**: `XMLParser`
 Defined in:
-[epub/index.ts:175](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L175)
+[epub/index.ts:214](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L214)
 #### xmlBuilder
 > `static` **xmlBuilder**: `XMLBuilder`
 Defined in:
-[epub/index.ts:208](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L208)
+[epub/index.ts:247](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L247)
 #### xmlParser
 > `static` **xmlParser**: `XMLParser`
 Defined in:
-[epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L168)
+[epub/index.ts:207](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L207)
 ### Methods
@@ -326,7 +326,7 @@ Defined in:
 > **\[dispose\]**(): `void`
 Defined in:
-[epub/index.ts:2541](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2541)
+[epub/index.ts:2597](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2597)
 ##### Returns
@@ -337,7 +337,7 @@ Defined in:
 > **addCollection**(`collection`, `index?`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1532](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1532)
+[epub/index.ts:1586](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1586)
 Add a collection to the EPUB metadata.
@@ -360,7 +360,7 @@ collections. Otherwise, it will be added to the end of the list.
 > **addContributor**(`contributor`, `index?`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1874](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1874)
+[epub/index.ts:1928](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1928)
 Add a contributor to the EPUB metadata.
@@ -390,7 +390,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
 > **addCreator**(`creator`, `index?`, `type?`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1719](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1719)
+[epub/index.ts:1773](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1773)
 Add a creator to the EPUB metadata.
@@ -420,7 +420,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
 > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2237](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2237)
+[epub/index.ts:2291](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2291)
 Create a new manifest item and write its contents to a new entry.
@@ -449,7 +449,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
 > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2242](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2242)
+[epub/index.ts:2296](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2296)
 Create a new manifest item and write its contents to a new entry.
@@ -478,7 +478,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
 > **addManifestItem**(`item`, `contents`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2247](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2247)
+[epub/index.ts:2301](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2301)
 Create a new manifest item and write its contents to a new entry.
@@ -506,7 +506,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
 > **addMetadata**(`entry`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2359](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2359)
+[epub/index.ts:2413](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2413)
 Add a new metadata entry to the Epub.
@@ -533,7 +533,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
 > **addSpineItem**(`manifestId`, `index?`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1928](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1928)
+[epub/index.ts:1982](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1982)
 Add an item to the spine of the EPUB.
@@ -563,7 +563,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
 > **addSubject**(`subject`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1061](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1061)
+[epub/index.ts:1115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1115)
 Add a subject to the EPUB metadata.
@@ -581,6 +581,23 @@ Add a subject to the EPUB metadata.
 https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
+#### copy()
+> **copy**(`path?`): `Promise`\<[`Epub`](#epub)\>
+Defined in:
+[epub/index.ts:593](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L593)
+##### Parameters
+| Parameter | Type     |
+| --------- | -------- |
+| `path?`   | `string` |
+##### Returns
+`Promise`\<[`Epub`](#epub)\>
 #### createXhtmlDocument()
 > **createXhtmlDocument**(`body`, `head?`, `language?`):
@@ -588,7 +605,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
 > [`XmlElement`](#xmlelement)\<`"?xml"`\>)[]\>
 Defined in:
-[epub/index.ts:2063](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2063)
+[epub/index.ts:2117](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2117)
 Create a new XHTML document with the given body and head.
@@ -610,7 +627,7 @@ Create a new XHTML document with the given body and head.
 > **discardAndClose**(): `void`
 Defined in:
-[epub/index.ts:2468](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2468)
+[epub/index.ts:2522](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2522)
 ##### Returns
@@ -621,7 +638,7 @@ Defined in:
 > **findAllMetadataItems**(`predicate`): `Promise`\<`object`[]\>
 Defined in:
-[epub/index.ts:784](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L784)
+[epub/index.ts:838](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L838)
 Returns the item in the metadata element's children array that matches the
 provided predicate.
@@ -661,7 +678,7 @@ provided predicate.
 > \}\>
 Defined in:
-[epub/index.ts:775](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L775)
+[epub/index.ts:829](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L829)
 Returns the item in the metadata element's children array that matches the
 provided predicate.
@@ -700,7 +717,7 @@ provided predicate.
 > **getCollections**(): `Promise`\<[`Collection`](#collection)[]\>
 Defined in:
-[epub/index.ts:1492](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1492)
+[epub/index.ts:1546](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1546)
 Retrieve the list of collections.
@@ -713,7 +730,7 @@ Retrieve the list of collections.
 > **getContributors**(): `Promise`\<[`DcCreator`](#dccreator)[]\>
 Defined in:
-[epub/index.ts:1706](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1706)
+[epub/index.ts:1760](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1760)
 Retrieve the list of contributors.
@@ -732,7 +749,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccontributor
 > **getCoverImage**(): `Promise`\<`null` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 Defined in:
-[epub/index.ts:964](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L964)
+[epub/index.ts:1018](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1018)
 Retrieve the cover image data as a byte array.
@@ -753,7 +770,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
 > [`ManifestItem`](#manifestitem)\>
 Defined in:
-[epub/index.ts:945](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L945)
+[epub/index.ts:999](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L999)
 Retrieve the cover image manifest item.
@@ -773,7 +790,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
 > **getCreators**(`type`): `Promise`\<[`DcCreator`](#dccreator)[]\>
 Defined in:
-[epub/index.ts:1645](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1645)
+[epub/index.ts:1699](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1699)
 Retrieve the list of creators.
@@ -796,7 +813,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
 > **getDescription**(): `Promise`\<`null` \| `string`\>
 Defined in:
-[epub/index.ts:1343](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1343)
+[epub/index.ts:1397](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1397)
 Retrieve the Epub's description as specified in its package document metadata.
@@ -812,7 +829,7 @@ as a string. Descriptions may include HTML markup.
 > **getIdentifier**(): `Promise`\<`null` \| `string`\>
 Defined in:
-[epub/index.ts:879](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L879)
+[epub/index.ts:933](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L933)
 Retrieve the identifier from the dc:identifier element in the EPUB metadata.
@@ -831,7 +848,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
 > **getLanguage**(): `Promise`\<`null` \| `Locale`\>
 Defined in:
-[epub/index.ts:1180](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1180)
+[epub/index.ts:1234](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1234)
 Retrieve the Epub's language as specified in its package document metadata.
@@ -852,7 +869,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
 > [`ManifestItem`](#manifestitem)\>\>
 Defined in:
-[epub/index.ts:700](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L700)
+[epub/index.ts:754](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L754)
 Retrieve the manifest for the Epub.
@@ -872,7 +889,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
 > **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
 Defined in:
-[epub/index.ts:851](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L851)
+[epub/index.ts:905](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L905)
 Retrieve the metadata entries for the Epub.
@@ -896,7 +913,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
 > `string`\>\>
 Defined in:
-[epub/index.ts:1360](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1360)
+[epub/index.ts:1414](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1414)
 Return the set of custom vocabulary prefixes set on this publication's root
 package element.
@@ -916,7 +933,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
 > **getPublicationDate**(): `Promise`\<`null` \| `Date`\>
 Defined in:
-[epub/index.ts:1001](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1001)
+[epub/index.ts:1055](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1055)
 Retrieve the publication date from the dc:date element in the EPUB metadata as a
 Date object.
@@ -936,7 +953,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
 > **getRootfile**(): `Promise`\<`string`\>
 Defined in:
-[epub/index.ts:552](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L552)
+[epub/index.ts:626](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L626)
 ##### Returns
@@ -947,7 +964,7 @@ Defined in:
 > **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem)[]\>
 Defined in:
-[epub/index.ts:1909](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1909)
+[epub/index.ts:1963](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1963)
 Retrieve the manifest items that make up the Epub's spine.
@@ -967,7 +984,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
 > **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
 Defined in:
-[epub/index.ts:1135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1135)
+[epub/index.ts:1189](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1189)
 Retrieve the list of subjects for this EPUB.
@@ -988,7 +1005,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
 > **getSubtitle**(): `Promise`\<`null` \| `string`\>
 Defined in:
-[epub/index.ts:1250](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1250)
+[epub/index.ts:1304](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1304)
 Retrieve the subtitle of the Epub, if it exists.
@@ -1005,7 +1022,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
 > **getTitle**(`expanded`): `Promise`\<`null` \| `string`\>
 Defined in:
-[epub/index.ts:1226](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1226)
+[epub/index.ts:1280](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1280)
 Retrieve the title of the Epub.
@@ -1028,7 +1045,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
 > **getTitles**(): `Promise`\<`object`[]\>
 Defined in:
-[epub/index.ts:1262](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1262)
+[epub/index.ts:1316](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1316)
 Retrieve all title entries of the Epub.
@@ -1045,7 +1062,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
 > **getType**(): `Promise`\<`null` \| [`MetadataEntry`](#metadataentry)\>
 Defined in:
-[epub/index.ts:1048](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1048)
+[epub/index.ts:1102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1102)
 Retrieve the publication type from the dc:type element in the EPUB metadata.
@@ -1067,7 +1084,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
 > `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 Defined in:
-[epub/index.ts:2004](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2004)
+[epub/index.ts:2058](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2058)
 Retrieve the contents of a file, given its href.
@@ -1090,7 +1107,7 @@ encoding parameter.
 > **readFileContents**(`href`, `relativeTo`, `encoding`): `Promise`\<`string`\>
 Defined in:
-[epub/index.ts:2005](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2005)
+[epub/index.ts:2059](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2059)
 Retrieve the contents of a file, given its href.
@@ -1116,7 +1133,7 @@ encoding parameter.
 > **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 Defined in:
-[epub/index.ts:2035](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2035)
+[epub/index.ts:2089](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2089)
 Retrieve the contents of a manifest item, given its id.
@@ -1139,7 +1156,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
 > **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
 Defined in:
-[epub/index.ts:2036](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2036)
+[epub/index.ts:2090](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2090)
 Retrieve the contents of a manifest item, given its id.
@@ -1165,7 +1182,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
 > **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`ParsedXml`](#parsedxml)\>
 Defined in:
-[epub/index.ts:2098](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2098)
+[epub/index.ts:2152](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2152)
 Retrieves the contents of an XHTML item, given its manifest id.
@@ -1189,7 +1206,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
 > **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
 Defined in:
-[epub/index.ts:2099](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2099)
+[epub/index.ts:2153](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2153)
 Retrieves the contents of an XHTML item, given its manifest id.
@@ -1213,7 +1230,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
 > **removeCollection**(`index`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1601](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1601)
+[epub/index.ts:1655](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1655)
 Remove a collection from the EPUB metadata.
@@ -1235,7 +1252,7 @@ returned by `epub.getCollections()`.
 > **removeContributor**(`index`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1858](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1858)
+[epub/index.ts:1912](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1912)
 Remove a contributor from the EPUB metadata.
@@ -1263,7 +1280,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
 > **removeCreator**(`index`, `type`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1806](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1806)
+[epub/index.ts:1860](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1860)
 Remove a creator from the EPUB metadata.
@@ -1290,7 +1307,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
 > **removeManifestItem**(`id`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2194](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2194)
+[epub/index.ts:2248](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2248)
 ##### Parameters
@@ -1307,7 +1324,7 @@ Defined in:
 > **removeMetadata**(`predicate`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2443](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2443)
+[epub/index.ts:2497](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2497)
 Remove one or more metadata entries.
@@ -1333,7 +1350,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
 > **removeSpineItem**(`index`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1964](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1964)
+[epub/index.ts:2018](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2018)
 Remove the spine item at the specified index.
@@ -1356,7 +1373,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
 > **removeSubject**(`index`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1098](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1098)
+[epub/index.ts:1152](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1152)
 Remove a subject from the EPUB metadata.
@@ -1382,7 +1399,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
 > **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2398](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2398)
+[epub/index.ts:2452](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2452)
 Replace a metadata entry with a new one.
@@ -1409,7 +1426,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
 > **saveAndClose**(): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2484)
+[epub/index.ts:2538](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2538)
 Write the current contents of the Epub to a new EPUB archive on disk.
@@ -1425,7 +1442,7 @@ updated to the current UTC timestamp.
 > **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:978](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L978)
+[epub/index.ts:1032](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1032)
 Set the cover image for the EPUB.
@@ -1448,7 +1465,7 @@ then writes the provided image data to the provided href within the publication.
 > **setDescription**(`description`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1327](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1327)
+[epub/index.ts:1381](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1381)
 Update the Epub's description metadata entry.
@@ -1471,7 +1488,7 @@ encoded as HTML entities.
 > **setIdentifier**(`identifier`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:893](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L893)
+[epub/index.ts:947](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L947)
 Set the dc:identifier metadata element with the provided string.
@@ -1497,7 +1514,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
 > **setLanguage**(`locale`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1209](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1209)
+[epub/index.ts:1263](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1263)
 Update the Epub's language metadata entry.
@@ -1523,7 +1540,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
 > **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1378](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1378)
+[epub/index.ts:1432](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1432)
 Set a custom vocabulary prefix on the root package element.
@@ -1547,7 +1564,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
 > **setPublicationDate**(`date`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1016](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1016)
+[epub/index.ts:1070](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1070)
 Set the dc:date metadata element with the provided date.
@@ -1573,7 +1590,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
 > **setTitle**(`title`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1402](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1402)
+[epub/index.ts:1456](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1456)
 Set the title of the Epub.
@@ -1601,7 +1618,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
 > **setTitles**(`entries`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1430](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1430)
+[epub/index.ts:1484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1484)
 ##### Parameters
@@ -1618,7 +1635,7 @@ Defined in:
 > **setType**(`type`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:1032](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1032)
+[epub/index.ts:1086](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1086)
 Set the dc:type metadata element.
@@ -1644,7 +1661,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
 > **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2310](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2310)
+[epub/index.ts:2364](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2364)
 Update the manifest entry for an existing item.
@@ -1673,7 +1690,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
 > **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2146](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2146)
+[epub/index.ts:2200](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2200)
 Write new contents for an existing manifest item, specified by its id.
@@ -1700,7 +1717,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
 > **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2147](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2147)
+[epub/index.ts:2201](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2201)
 Write new contents for an existing manifest item, specified by its id.
@@ -1728,7 +1745,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
 > **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
 Defined in:
-[epub/index.ts:2186](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2186)
+[epub/index.ts:2240](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2240)
 Write new contents for an existing XHTML item, specified by its id.
@@ -1755,7 +1772,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
 > `static` **addLinkToXhtmlHead**(`xml`, `link`): `void`
 Defined in:
-[epub/index.ts:245](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L245)
+[epub/index.ts:284](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L284)
 Given an XML structure representing a complete XHTML document, add a `link`
 element to the `head` of the document.
@@ -1782,7 +1799,7 @@ This method modifies the provided XML structure.
 > `Promise`\<[`Epub`](#epub)\>
 Defined in:
-[epub/index.ts:411](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L411)
+[epub/index.ts:450](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L450)
 Construct an Epub instance, optionally beginning with the provided metadata.
@@ -1804,7 +1821,7 @@ Construct an Epub instance, optionally beginning with the provided metadata.
 > [`XmlElement`](#xmlelement)\<`Name`\>
 Defined in:
-[epub/index.ts:280](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L280)
+[epub/index.ts:319](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L319)
 ##### Type Parameters
@@ -1829,7 +1846,7 @@ Defined in:
 > `static` **createXmlTextNode**(`text`): [`XmlTextNode`](#xmltextnode)
 Defined in:
-[epub/index.ts:293](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L293)
+[epub/index.ts:332](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L332)
 ##### Parameters
@@ -1847,7 +1864,7 @@ Defined in:
 > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
 Defined in:
-[epub/index.ts:366](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L366)
+[epub/index.ts:405](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L405)
 Given an XML structure, find the first child matching the provided name and
 optional filter.
@@ -1875,7 +1892,7 @@ optional filter.
 > `static` **formatSmilDuration**(`duration`): `string`
 Defined in:
-[epub/index.ts:228](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L228)
+[epub/index.ts:267](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L267)
 Format a duration, provided as a number of seconds, as a SMIL clock value, to be
 used for Media Overlays.
@@ -1899,7 +1916,7 @@ https://www.w3.org/TR/epub-33/#sec-duration
 > `static` **from**(`pathOrData`): `Promise`\<[`Epub`](#epub)\>
 Defined in:
-[epub/index.ts:495](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L495)
+[epub/index.ts:534](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L534)
 Construct an Epub instance by reading an existing EPUB publication.
@@ -1918,7 +1935,7 @@ Construct an Epub instance by reading an existing EPUB publication.
 > `static` **getXhtmlBody**(`xml`): [`ParsedXml`](#parsedxml)
 Defined in:
-[epub/index.ts:270](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L270)
+[epub/index.ts:309](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L309)
 Given an XML structure representing a complete XHTML document, return the
 sub-structure representing the children of the document's body element.
@@ -1938,7 +1955,7 @@ sub-structure representing the children of the document's body element.
 > `static` **getXhtmlTextContent**(`xml`): `string`
 Defined in:
-[epub/index.ts:302](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L302)
+[epub/index.ts:341](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L341)
 Given an XML structure representing a complete XHTML document, return a string
 representing the concatenation of all text nodes in the document.
@@ -1958,7 +1975,7 @@ representing the concatenation of all text nodes in the document.
 > `static` **getXmlAttributes**(`element`): `Record`\<`string`, `string`\>
 Defined in:
-[epub/index.ts:319](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L319)
+[epub/index.ts:358](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L358)
 Given an XMLElement, return its attributes.
@@ -1977,7 +1994,7 @@ Given an XMLElement, return its attributes.
 > `static` **getXmlChildren**\<`Name`\>(`element`): [`ParsedXml`](#parsedxml)
 Defined in:
-[epub/index.ts:346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L346)
+[epub/index.ts:385](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L385)
 Given an XMLElement, return a list of its children
@@ -2002,7 +2019,7 @@ Given an XMLElement, return a list of its children
 > `static` **getXmlElementName**\<`Name`\>(`element`): `Name`
 Defined in:
-[epub/index.ts:331](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L331)
+[epub/index.ts:370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L370)
 Given an XMLElement, return its tag name.
@@ -2027,7 +2044,7 @@ Given an XMLElement, return its tag name.
 > `static` **isXmlTextNode**(`node`): `node is XmlTextNode`
 Defined in:
-[epub/index.ts:379](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L379)
+[epub/index.ts:418](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L418)
 Given an XMLNode, determine whether it represents a text node or an XML element.
@@ -2046,7 +2063,7 @@ Given an XMLNode, determine whether it represents a text node or an XML element.
 > `static` **replaceXmlChildren**\<`Name`\>(`element`, `children`): `void`
 Defined in:
-[epub/index.ts:354](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L354)
+[epub/index.ts:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L393)
 ##### Type Parameters
@@ -2374,8 +2391,7 @@ Defined in:
 ## PackageElement
-> **PackageElement** = [`XmlElement`](#xmlelement)\<`"package"`\> \|
-> [`XmlElement`](#xmlelement)\<`"opf:package"`\>
+> **PackageElement** = [`XmlElement`](#xmlelement)\<`"package"`\>
 Defined in:
 [epub/index.ts:138](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L138)

package/dist/index.cjs CHANGED Viewed

@@ -89,6 +89,31 @@ var import_nanoid = require("nanoid");
 var import_yauzl_promise = require("yauzl-promise");
 var import_yazl = require("yazl");
 var import_path = require("@storyteller-platform/path");
+const MP3_FILE_EXTENSIONS = [".mp3"];
+const MPEG4_FILE_EXTENSIONS = [".mp4", ".m4a", ".m4b"];
+const AAC_FILE_EXTENSIONS = [".aac"];
+const OGG_FILE_EXTENSIONS = [".ogg", ".oga", ".mogg"];
+const OPUS_FILE_EXTENSIONS = [".opus"];
+const WAVE_FILE_EXTENSIONS = [".wav"];
+const AIFF_FILE_EXTENSIONS = [".aiff"];
+const FLAC_FILE_EXTENSIONS = [".flac"];
+const ALAC_FILE_EXTENSIONS = [".alac"];
+const WEBM_FILE_EXTENSIONS = [".weba"];
+const AUDIO_FILE_EXTENSIONS = [
+  ...MP3_FILE_EXTENSIONS,
+  ...AAC_FILE_EXTENSIONS,
+  ...MPEG4_FILE_EXTENSIONS,
+  ...OPUS_FILE_EXTENSIONS,
+  ...OGG_FILE_EXTENSIONS,
+  ...WAVE_FILE_EXTENSIONS,
+  ...AIFF_FILE_EXTENSIONS,
+  ...FLAC_FILE_EXTENSIONS,
+  ...ALAC_FILE_EXTENSIONS,
+  ...WEBM_FILE_EXTENSIONS
+];
+function isAudioFile(filenameOrExt) {
+  return AUDIO_FILE_EXTENSIONS.some((ext) => filenameOrExt.endsWith(ext));
+}
 class Epub {
   constructor(extractPath, inputPath) {
     this.extractPath = extractPath;
@@ -348,6 +373,7 @@ ${JSON.stringify(element, null, 2)}`
    */
   // eslint-disable-next-line @typescript-eslint/require-await
   static async from(pathOrData) {
+    var _a, _b;
     const extractPath = (0, import_path.join)(
       (0, import_node_os.tmpdir)(),
       `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}.epub`
@@ -380,10 +406,39 @@ ${JSON.stringify(element, null, 2)}`
       (0, import_node_fs.rmSync)(extractPath, { force: true, recursive: true });
       throw error;
     }
-    return new this(
+    const epub = new this(
       extractPath,
       typeof pathOrData === "string" ? pathOrData : void 0
     );
+    try {
+      await epub.getPackageElement();
+    } catch (e) {
+      epub.discardAndClose();
+      console.error(e);
+      throw new Error(
+        "This is not a valid EPUB 3 publication. This library only support EPUB 3, not EPUB 2. Try using an automatic conversion tool to convert this publication to EPUB 3."
+      );
+    }
+    const packageEl = await epub.getPackageElement();
+    if (!((_b = (_a = packageEl[":@"]) == null ? void 0 : _a["@_version"]) == null ? void 0 : _b.startsWith("3."))) {
+      throw new Error(
+        "This is not a valid EPUB 3 publication. This library only support EPUB 3, not EPUB 2. Try using an automatic conversion tool to convert this publication to EPUB 3."
+      );
+    }
+    return epub;
+  }
+  async copy(path) {
+    const extractPath = (0, import_path.join)(
+      (0, import_node_os.tmpdir)(),
+      `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}.epub`
+    );
+    try {
+      await (0, import_promises.cp)(this.extractPath, extractPath, { recursive: true });
+    } catch (error) {
+      (0, import_node_fs.rmSync)(extractPath, { force: true, recursive: true });
+      throw error;
+    }
+    return new Epub(extractPath, path);
   }
   async removeEntry(href) {
     const rootfile = await this.getRootfile();
@@ -432,17 +487,6 @@ ${JSON.stringify(element, null, 2)}`
     this.rootfile = (0, import_path.resolve)(this.extractPath, fullPath);
     return this.rootfile;
   }
-  migratePackageDocument(packageDocument) {
-    for (const element of packageDocument) {
-      if (Epub.isXmlTextNode(element)) continue;
-      const elementName = Epub.getXmlElementName(element);
-      if (elementName.startsWith("opf:")) {
-        element[elementName.replace("opf:", "")] = Epub.getXmlChildren(element);
-        delete element[elementName];
-        this.migratePackageDocument(Epub.getXmlChildren(element));
-      }
-    }
-  }
   async getPackageDocument() {
     const rootfile = await this.getRootfile();
     const packageDocumentString = await this.getFileData(rootfile, "utf-8");
@@ -457,13 +501,12 @@ ${JSON.stringify(element, null, 2)}`
   }
   async getPackageElement() {
     const packageDocument = await this.getPackageDocument();
-    const packageElement = Epub.findXmlChildByName("package", packageDocument) ?? Epub.findXmlChildByName("opf:package", packageDocument);
+    const packageElement = Epub.findXmlChildByName("package", packageDocument);
     if (!packageElement) {
       throw new Error(
         "Failed to parse EPUB: Found no package element in package document"
       );
     }
-    this.migratePackageDocument(packageDocument);
     return packageElement;
   }
   /**
@@ -481,7 +524,7 @@ ${JSON.stringify(element, null, 2)}`
   async withPackage(producer) {
     await this.packageMutex.runExclusive(async () => {
       const packageDocument = await this.getPackageDocument();
-      const packageElement = Epub.findXmlChildByName("package", packageDocument) ?? Epub.findXmlChildByName("opf:package", packageDocument);
+      const packageElement = Epub.findXmlChildByName("package", packageDocument);
       if (!packageElement) {
         throw new Error(
           "Failed to parse EPUB: Found no package element in package document"
@@ -1910,7 +1953,8 @@ ${JSON.stringify(element, null, 2)}`
         if (entry.name === "mimetype" || entry.isDirectory()) continue;
         zipfile.addFile(
           (0, import_path.join)(entry.parentPath, entry.name),
-          (0, import_path.join)(entry.parentPath, entry.name).replace(`${this.extractPath}/`, "")
+          (0, import_path.join)(entry.parentPath, entry.name).replace(`${this.extractPath}/`, ""),
+          { compress: !isAudioFile(entry.name) }
         );
       }
       zipfile.end();

package/dist/index.d.cts CHANGED Viewed

@@ -74,7 +74,7 @@ interface Collection {
     type?: string;
     position?: string;
 }
-type PackageElement = XmlElement<"package"> | XmlElement<"opf:package">;
+type PackageElement = XmlElement<"package">;
 /**
  * A single EPUB instance.
  *
@@ -186,10 +186,10 @@ declare class Epub {
      *        the data of the EPUB publication.
      */
     static from(pathOrData: string | Uint8Array): Promise<Epub>;
+    copy(path?: string): Promise<Epub>;
     private removeEntry;
     private getFileData;
     getRootfile(): Promise<string>;
-    private migratePackageDocument;
     private getPackageDocument;
     private getPackageElement;
     /**

package/dist/index.d.ts CHANGED Viewed

@@ -74,7 +74,7 @@ interface Collection {
     type?: string;
     position?: string;
 }
-type PackageElement = XmlElement<"package"> | XmlElement<"opf:package">;
+type PackageElement = XmlElement<"package">;
 /**
  * A single EPUB instance.
  *
@@ -186,10 +186,10 @@ declare class Epub {
      *        the data of the EPUB publication.
      */
     static from(pathOrData: string | Uint8Array): Promise<Epub>;
+    copy(path?: string): Promise<Epub>;
     private removeEntry;
     private getFileData;
     getRootfile(): Promise<string>;
-    private migratePackageDocument;
     private getPackageDocument;
     private getPackageElement;
     /**

package/dist/index.js CHANGED Viewed

@@ -56,6 +56,31 @@ import { nanoid } from "nanoid";
 import { fromBuffer, open } from "yauzl-promise";
 import { ZipFile } from "yazl";
 import { dirname, join, resolve } from "@storyteller-platform/path";
+const MP3_FILE_EXTENSIONS = [".mp3"];
+const MPEG4_FILE_EXTENSIONS = [".mp4", ".m4a", ".m4b"];
+const AAC_FILE_EXTENSIONS = [".aac"];
+const OGG_FILE_EXTENSIONS = [".ogg", ".oga", ".mogg"];
+const OPUS_FILE_EXTENSIONS = [".opus"];
+const WAVE_FILE_EXTENSIONS = [".wav"];
+const AIFF_FILE_EXTENSIONS = [".aiff"];
+const FLAC_FILE_EXTENSIONS = [".flac"];
+const ALAC_FILE_EXTENSIONS = [".alac"];
+const WEBM_FILE_EXTENSIONS = [".weba"];
+const AUDIO_FILE_EXTENSIONS = [
+  ...MP3_FILE_EXTENSIONS,
+  ...AAC_FILE_EXTENSIONS,
+  ...MPEG4_FILE_EXTENSIONS,
+  ...OPUS_FILE_EXTENSIONS,
+  ...OGG_FILE_EXTENSIONS,
+  ...WAVE_FILE_EXTENSIONS,
+  ...AIFF_FILE_EXTENSIONS,
+  ...FLAC_FILE_EXTENSIONS,
+  ...ALAC_FILE_EXTENSIONS,
+  ...WEBM_FILE_EXTENSIONS
+];
+function isAudioFile(filenameOrExt) {
+  return AUDIO_FILE_EXTENSIONS.some((ext) => filenameOrExt.endsWith(ext));
+}
 class Epub {
   constructor(extractPath, inputPath) {
     this.extractPath = extractPath;
@@ -315,6 +340,7 @@ ${JSON.stringify(element, null, 2)}`
    */
   // eslint-disable-next-line @typescript-eslint/require-await
   static async from(pathOrData) {
+    var _a, _b;
     const extractPath = join(
       tmpdir(),
       `storyteller-platform-epub-${randomUUID()}.epub`
@@ -347,10 +373,39 @@ ${JSON.stringify(element, null, 2)}`
       rmSync(extractPath, { force: true, recursive: true });
       throw error;
     }
-    return new this(
+    const epub = new this(
       extractPath,
       typeof pathOrData === "string" ? pathOrData : void 0
     );
+    try {
+      await epub.getPackageElement();
+    } catch (e) {
+      epub.discardAndClose();
+      console.error(e);
+      throw new Error(
+        "This is not a valid EPUB 3 publication. This library only support EPUB 3, not EPUB 2. Try using an automatic conversion tool to convert this publication to EPUB 3."
+      );
+    }
+    const packageEl = await epub.getPackageElement();
+    if (!((_b = (_a = packageEl[":@"]) == null ? void 0 : _a["@_version"]) == null ? void 0 : _b.startsWith("3."))) {
+      throw new Error(
+        "This is not a valid EPUB 3 publication. This library only support EPUB 3, not EPUB 2. Try using an automatic conversion tool to convert this publication to EPUB 3."
+      );
+    }
+    return epub;
+  }
+  async copy(path) {
+    const extractPath = join(
+      tmpdir(),
+      `storyteller-platform-epub-${randomUUID()}.epub`
+    );
+    try {
+      await cp(this.extractPath, extractPath, { recursive: true });
+    } catch (error) {
+      rmSync(extractPath, { force: true, recursive: true });
+      throw error;
+    }
+    return new Epub(extractPath, path);
   }
   async removeEntry(href) {
     const rootfile = await this.getRootfile();
@@ -399,17 +454,6 @@ ${JSON.stringify(element, null, 2)}`
     this.rootfile = resolve(this.extractPath, fullPath);
     return this.rootfile;
   }
-  migratePackageDocument(packageDocument) {
-    for (const element of packageDocument) {
-      if (Epub.isXmlTextNode(element)) continue;
-      const elementName = Epub.getXmlElementName(element);
-      if (elementName.startsWith("opf:")) {
-        element[elementName.replace("opf:", "")] = Epub.getXmlChildren(element);
-        delete element[elementName];
-        this.migratePackageDocument(Epub.getXmlChildren(element));
-      }
-    }
-  }
   async getPackageDocument() {
     const rootfile = await this.getRootfile();
     const packageDocumentString = await this.getFileData(rootfile, "utf-8");
@@ -424,13 +468,12 @@ ${JSON.stringify(element, null, 2)}`
   }
   async getPackageElement() {
     const packageDocument = await this.getPackageDocument();
-    const packageElement = Epub.findXmlChildByName("package", packageDocument) ?? Epub.findXmlChildByName("opf:package", packageDocument);
+    const packageElement = Epub.findXmlChildByName("package", packageDocument);
     if (!packageElement) {
       throw new Error(
         "Failed to parse EPUB: Found no package element in package document"
       );
     }
-    this.migratePackageDocument(packageDocument);
     return packageElement;
   }
   /**
@@ -448,7 +491,7 @@ ${JSON.stringify(element, null, 2)}`
   async withPackage(producer) {
     await this.packageMutex.runExclusive(async () => {
       const packageDocument = await this.getPackageDocument();
-      const packageElement = Epub.findXmlChildByName("package", packageDocument) ?? Epub.findXmlChildByName("opf:package", packageDocument);
+      const packageElement = Epub.findXmlChildByName("package", packageDocument);
       if (!packageElement) {
         throw new Error(
           "Failed to parse EPUB: Found no package element in package document"
@@ -1877,7 +1920,8 @@ ${JSON.stringify(element, null, 2)}`
         if (entry.name === "mimetype" || entry.isDirectory()) continue;
         zipfile.addFile(
           join(entry.parentPath, entry.name),
-          join(entry.parentPath, entry.name).replace(`${this.extractPath}/`, "")
+          join(entry.parentPath, entry.name).replace(`${this.extractPath}/`, ""),
+          { compress: !isAudioFile(entry.name) }
         );
       }
       zipfile.end();

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@storyteller-platform/epub",
-  "version": "0.4.8",
+  "version": "0.4.10",
   "type": "module",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",