@storyteller-platform/epub 0.2.0 → 0.2.1

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.
package/README.md CHANGED
@@ -233,7 +233,7 @@ Defined in:
233
233
  > `protected` **new Epub**(`entries`, `onClose?`): [`Epub`](#epub)
234
234
 
235
235
  Defined in:
236
- [epub/index.ts:410](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L410)
236
+ [epub/index.ts:409](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L409)
237
237
 
238
238
  ##### Parameters
239
239
 
@@ -257,7 +257,7 @@ Defined in:
257
257
  > `static` **xhtmlBuilder**: `XMLBuilder`
258
258
 
259
259
  Defined in:
260
- [epub/index.ts:242](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L242)
260
+ [epub/index.ts:241](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L241)
261
261
 
262
262
  ##### Inherited from
263
263
 
@@ -268,7 +268,7 @@ Defined in:
268
268
  > `static` **xhtmlParser**: `XMLParser`
269
269
 
270
270
  Defined in:
271
- [epub/index.ts:210](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L210)
271
+ [epub/index.ts:209](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L209)
272
272
 
273
273
  ##### Inherited from
274
274
 
@@ -279,7 +279,7 @@ Defined in:
279
279
  > `static` **xmlBuilder**: `XMLBuilder`
280
280
 
281
281
  Defined in:
282
- [epub/index.ts:235](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L235)
282
+ [epub/index.ts:234](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L234)
283
283
 
284
284
  ##### Inherited from
285
285
 
@@ -290,7 +290,7 @@ Defined in:
290
290
  > `static` **xmlParser**: `XMLParser`
291
291
 
292
292
  Defined in:
293
- [epub/index.ts:203](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L203)
293
+ [epub/index.ts:202](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L202)
294
294
 
295
295
  ##### Inherited from
296
296
 
@@ -303,7 +303,7 @@ Defined in:
303
303
  > **addCollection**(`collection`, `index?`): `Promise`\<`void`\>
304
304
 
305
305
  Defined in:
306
- [epub/index.ts:1520](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1520)
306
+ [epub/index.ts:1518](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1518)
307
307
 
308
308
  Add a collection to the EPUB metadata.
309
309
 
@@ -330,7 +330,7 @@ collections. Otherwise, it will be added to the end of the list.
330
330
  > **addContributor**(`contributor`, `index?`): `Promise`\<`void`\>
331
331
 
332
332
  Defined in:
333
- [epub/index.ts:1862](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1862)
333
+ [epub/index.ts:1860](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1860)
334
334
 
335
335
  Add a contributor to the EPUB metadata.
336
336
 
@@ -364,7 +364,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
364
364
  > **addCreator**(`creator`, `index?`, `type?`): `Promise`\<`void`\>
365
365
 
366
366
  Defined in:
367
- [epub/index.ts:1707](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1707)
367
+ [epub/index.ts:1705](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1705)
368
368
 
369
369
  Add a creator to the EPUB metadata.
370
370
 
@@ -398,7 +398,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
398
398
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
399
399
 
400
400
  Defined in:
401
- [epub/index.ts:2198](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2198)
401
+ [epub/index.ts:2196](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2196)
402
402
 
403
403
  Create a new manifest item and write its contents to a new entry.
404
404
 
@@ -431,7 +431,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
431
431
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
432
432
 
433
433
  Defined in:
434
- [epub/index.ts:2203](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2203)
434
+ [epub/index.ts:2201](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2201)
435
435
 
436
436
  Create a new manifest item and write its contents to a new entry.
437
437
 
@@ -464,7 +464,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
464
464
  > **addManifestItem**(`item`, `contents`): `Promise`\<`void`\>
465
465
 
466
466
  Defined in:
467
- [epub/index.ts:2208](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2208)
467
+ [epub/index.ts:2206](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2206)
468
468
 
469
469
  Create a new manifest item and write its contents to a new entry.
470
470
 
@@ -496,7 +496,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
496
496
  > **addMetadata**(`entry`): `Promise`\<`void`\>
497
497
 
498
498
  Defined in:
499
- [epub/index.ts:2317](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2317)
499
+ [epub/index.ts:2315](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2315)
500
500
 
501
501
  Add a new metadata entry to the Epub.
502
502
 
@@ -527,7 +527,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
527
527
  > **addSpineItem**(`manifestId`, `index?`): `Promise`\<`void`\>
528
528
 
529
529
  Defined in:
530
- [epub/index.ts:1916](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1916)
530
+ [epub/index.ts:1914](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1914)
531
531
 
532
532
  Add an item to the spine of the EPUB.
533
533
 
@@ -561,7 +561,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
561
561
  > **addSubject**(`subject`): `Promise`\<`void`\>
562
562
 
563
563
  Defined in:
564
- [epub/index.ts:1052](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1052)
564
+ [epub/index.ts:1051](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1051)
565
565
 
566
566
  Add a subject to the EPUB metadata.
567
567
 
@@ -588,7 +588,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
588
588
  > **close**(): `Promise`\<`void`\>
589
589
 
590
590
  Defined in:
591
- [epub/index.ts:430](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L430)
591
+ [epub/index.ts:429](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L429)
592
592
 
593
593
  Close the Epub. Must be called before the Epub goes out of scope/is garbage
594
594
  collected.
@@ -608,7 +608,7 @@ collected.
608
608
  > [`XmlElement`](#xmlelement)\<`"?xml"`\>)[]\>
609
609
 
610
610
  Defined in:
611
- [epub/index.ts:2021](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2021)
611
+ [epub/index.ts:2019](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2019)
612
612
 
613
613
  Create a new XHTML document with the given body and head.
614
614
 
@@ -634,7 +634,7 @@ Create a new XHTML document with the given body and head.
634
634
  > **findAllMetadataItems**(`predicate`): `Promise`\<`object`[]\>
635
635
 
636
636
  Defined in:
637
- [epub/index.ts:805](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L805)
637
+ [epub/index.ts:804](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L804)
638
638
 
639
639
  Returns the item in the metadata element's children array that matches the
640
640
  provided predicate.
@@ -678,7 +678,7 @@ provided predicate.
678
678
  > \}\>
679
679
 
680
680
  Defined in:
681
- [epub/index.ts:796](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L796)
681
+ [epub/index.ts:795](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L795)
682
682
 
683
683
  Returns the item in the metadata element's children array that matches the
684
684
  provided predicate.
@@ -721,7 +721,7 @@ provided predicate.
721
721
  > **getCollections**(): `Promise`\<[`Collection`](#collection)[]\>
722
722
 
723
723
  Defined in:
724
- [epub/index.ts:1480](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1480)
724
+ [epub/index.ts:1478](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1478)
725
725
 
726
726
  Retrieve the list of collections.
727
727
 
@@ -738,7 +738,7 @@ Retrieve the list of collections.
738
738
  > **getContributors**(): `Promise`\<[`DcCreator`](#dccreator)[]\>
739
739
 
740
740
  Defined in:
741
- [epub/index.ts:1694](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1694)
741
+ [epub/index.ts:1692](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1692)
742
742
 
743
743
  Retrieve the list of contributors.
744
744
 
@@ -761,7 +761,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccontributor
761
761
  > **getCoverImage**(): `Promise`\<`null` \| `Uint8Array`\<`ArrayBufferLike`\>\>
762
762
 
763
763
  Defined in:
764
- [epub/index.ts:955](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L955)
764
+ [epub/index.ts:954](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L954)
765
765
 
766
766
  Retrieve the cover image data as a byte array.
767
767
 
@@ -786,7 +786,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
786
786
  > [`ManifestItem`](#manifestitem)\>
787
787
 
788
788
  Defined in:
789
- [epub/index.ts:936](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L936)
789
+ [epub/index.ts:935](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L935)
790
790
 
791
791
  Retrieve the cover image manifest item.
792
792
 
@@ -810,7 +810,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
810
810
  > **getCreators**(`type`): `Promise`\<[`DcCreator`](#dccreator)[]\>
811
811
 
812
812
  Defined in:
813
- [epub/index.ts:1633](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1633)
813
+ [epub/index.ts:1631](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1631)
814
814
 
815
815
  Retrieve the list of creators.
816
816
 
@@ -837,7 +837,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
837
837
  > **getDescription**(): `Promise`\<`null` \| `string`\>
838
838
 
839
839
  Defined in:
840
- [epub/index.ts:1330](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1330)
840
+ [epub/index.ts:1329](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1329)
841
841
 
842
842
  Retrieve the Epub's description as specified in its package document metadata.
843
843
 
@@ -857,7 +857,7 @@ as a string. Descriptions may include HTML markup.
857
857
  > **getLanguage**(): `Promise`\<`null` \| `Locale`\>
858
858
 
859
859
  Defined in:
860
- [epub/index.ts:1171](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1171)
860
+ [epub/index.ts:1170](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1170)
861
861
 
862
862
  Retrieve the Epub's language as specified in its package document metadata.
863
863
 
@@ -882,7 +882,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
882
882
  > [`ManifestItem`](#manifestitem)\>\>
883
883
 
884
884
  Defined in:
885
- [epub/index.ts:721](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L721)
885
+ [epub/index.ts:720](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L720)
886
886
 
887
887
  Retrieve the manifest for the Epub.
888
888
 
@@ -906,7 +906,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
906
906
  > **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
907
907
 
908
908
  Defined in:
909
- [epub/index.ts:872](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L872)
909
+ [epub/index.ts:871](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L871)
910
910
 
911
911
  Retrieve the metadata entries for the Epub.
912
912
 
@@ -934,7 +934,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
934
934
  > `string`\>\>
935
935
 
936
936
  Defined in:
937
- [epub/index.ts:1348](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1348)
937
+ [epub/index.ts:1346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1346)
938
938
 
939
939
  Return the set of custom vocabulary prefixes set on this publication's root
940
940
  package element.
@@ -958,7 +958,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
958
958
  > **getPublicationDate**(): `Promise`\<`null` \| `Date`\>
959
959
 
960
960
  Defined in:
961
- [epub/index.ts:992](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L992)
961
+ [epub/index.ts:991](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L991)
962
962
 
963
963
  Retrieve the publication date from the dc:date element in the EPUB metadata as a
964
964
  Date object.
@@ -982,7 +982,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
982
982
  > **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem)[]\>
983
983
 
984
984
  Defined in:
985
- [epub/index.ts:1897](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1897)
985
+ [epub/index.ts:1895](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1895)
986
986
 
987
987
  Retrieve the manifest items that make up the Epub's spine.
988
988
 
@@ -1006,7 +1006,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1006
1006
  > **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
1007
1007
 
1008
1008
  Defined in:
1009
- [epub/index.ts:1126](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1126)
1009
+ [epub/index.ts:1125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1125)
1010
1010
 
1011
1011
  Retrieve the list of subjects for this EPUB.
1012
1012
 
@@ -1031,7 +1031,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
1031
1031
  > **getSubtitle**(): `Promise`\<`null` \| `string`\>
1032
1032
 
1033
1033
  Defined in:
1034
- [epub/index.ts:1237](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1237)
1034
+ [epub/index.ts:1236](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1236)
1035
1035
 
1036
1036
  Retrieve the subtitle of the Epub, if it exists.
1037
1037
 
@@ -1052,7 +1052,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1052
1052
  > **getTitle**(`expanded`): `Promise`\<`null` \| `string`\>
1053
1053
 
1054
1054
  Defined in:
1055
- [epub/index.ts:1213](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1213)
1055
+ [epub/index.ts:1212](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1212)
1056
1056
 
1057
1057
  Retrieve the title of the Epub.
1058
1058
 
@@ -1079,7 +1079,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1079
1079
  > **getTitles**(): `Promise`\<`object`[]\>
1080
1080
 
1081
1081
  Defined in:
1082
- [epub/index.ts:1249](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1249)
1082
+ [epub/index.ts:1248](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1248)
1083
1083
 
1084
1084
  Retrieve all title entries of the Epub.
1085
1085
 
@@ -1100,7 +1100,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1100
1100
  > **getType**(): `Promise`\<`null` \| [`MetadataEntry`](#metadataentry)\>
1101
1101
 
1102
1102
  Defined in:
1103
- [epub/index.ts:1039](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1039)
1103
+ [epub/index.ts:1038](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1038)
1104
1104
 
1105
1105
  Retrieve the publication type from the dc:type element in the EPUB metadata.
1106
1106
 
@@ -1125,7 +1125,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1125
1125
  > **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1126
1126
 
1127
1127
  Defined in:
1128
- [epub/index.ts:1993](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1993)
1128
+ [epub/index.ts:1991](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1991)
1129
1129
 
1130
1130
  Retrieve the contents of a manifest item, given its id.
1131
1131
 
@@ -1152,7 +1152,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1152
1152
  > **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
1153
1153
 
1154
1154
  Defined in:
1155
- [epub/index.ts:1994](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1994)
1155
+ [epub/index.ts:1992](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1992)
1156
1156
 
1157
1157
  Retrieve the contents of a manifest item, given its id.
1158
1158
 
@@ -1182,7 +1182,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1182
1182
  > **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`ParsedXml`](#parsedxml)\>
1183
1183
 
1184
1184
  Defined in:
1185
- [epub/index.ts:2054](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2054)
1185
+ [epub/index.ts:2052](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2052)
1186
1186
 
1187
1187
  Retrieves the contents of an XHTML item, given its manifest id.
1188
1188
 
@@ -1210,7 +1210,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1210
1210
  > **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
1211
1211
 
1212
1212
  Defined in:
1213
- [epub/index.ts:2055](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2055)
1213
+ [epub/index.ts:2053](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2053)
1214
1214
 
1215
1215
  Retrieves the contents of an XHTML item, given its manifest id.
1216
1216
 
@@ -1238,7 +1238,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1238
1238
  > **removeCollection**(`index`): `Promise`\<`void`\>
1239
1239
 
1240
1240
  Defined in:
1241
- [epub/index.ts:1589](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1589)
1241
+ [epub/index.ts:1587](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1587)
1242
1242
 
1243
1243
  Remove a collection from the EPUB metadata.
1244
1244
 
@@ -1264,7 +1264,7 @@ returned by `epub.getCollections()`.
1264
1264
  > **removeContributor**(`index`): `Promise`\<`void`\>
1265
1265
 
1266
1266
  Defined in:
1267
- [epub/index.ts:1846](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1846)
1267
+ [epub/index.ts:1844](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1844)
1268
1268
 
1269
1269
  Remove a contributor from the EPUB metadata.
1270
1270
 
@@ -1296,7 +1296,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1296
1296
  > **removeCreator**(`index`, `type`): `Promise`\<`void`\>
1297
1297
 
1298
1298
  Defined in:
1299
- [epub/index.ts:1794](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1794)
1299
+ [epub/index.ts:1792](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1792)
1300
1300
 
1301
1301
  Remove a creator from the EPUB metadata.
1302
1302
 
@@ -1327,7 +1327,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1327
1327
  > **removeManifestItem**(`id`): `Promise`\<`void`\>
1328
1328
 
1329
1329
  Defined in:
1330
- [epub/index.ts:2155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2155)
1330
+ [epub/index.ts:2153](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2153)
1331
1331
 
1332
1332
  ##### Parameters
1333
1333
 
@@ -1348,7 +1348,7 @@ Defined in:
1348
1348
  > **removeMetadata**(`predicate`): `Promise`\<`void`\>
1349
1349
 
1350
1350
  Defined in:
1351
- [epub/index.ts:2401](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2401)
1351
+ [epub/index.ts:2399](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2399)
1352
1352
 
1353
1353
  Remove one or more metadata entries.
1354
1354
 
@@ -1378,7 +1378,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1378
1378
  > **removeSpineItem**(`index`): `Promise`\<`void`\>
1379
1379
 
1380
1380
  Defined in:
1381
- [epub/index.ts:1952](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1952)
1381
+ [epub/index.ts:1950](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1950)
1382
1382
 
1383
1383
  Remove the spine item at the specified index.
1384
1384
 
@@ -1405,7 +1405,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1405
1405
  > **removeSubject**(`index`): `Promise`\<`void`\>
1406
1406
 
1407
1407
  Defined in:
1408
- [epub/index.ts:1089](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1089)
1408
+ [epub/index.ts:1088](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1088)
1409
1409
 
1410
1410
  Remove a subject from the EPUB metadata.
1411
1411
 
@@ -1435,7 +1435,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1435
1435
  > **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
1436
1436
 
1437
1437
  Defined in:
1438
- [epub/index.ts:2356](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2356)
1438
+ [epub/index.ts:2354](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2354)
1439
1439
 
1440
1440
  Replace a metadata entry with a new one.
1441
1441
 
@@ -1466,7 +1466,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1466
1466
  > **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
1467
1467
 
1468
1468
  Defined in:
1469
- [epub/index.ts:969](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L969)
1469
+ [epub/index.ts:968](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L968)
1470
1470
 
1471
1471
  Set the cover image for the EPUB.
1472
1472
 
@@ -1493,7 +1493,7 @@ then writes the provided image data to the provided href within the publication.
1493
1493
  > **setDescription**(`description`): `Promise`\<`void`\>
1494
1494
 
1495
1495
  Defined in:
1496
- [epub/index.ts:1314](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1314)
1496
+ [epub/index.ts:1313](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1313)
1497
1497
 
1498
1498
  Update the Epub's description metadata entry.
1499
1499
 
@@ -1520,7 +1520,7 @@ encoded as HTML entities.
1520
1520
  > **setLanguage**(`locale`): `Promise`\<`void`\>
1521
1521
 
1522
1522
  Defined in:
1523
- [epub/index.ts:1196](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1196)
1523
+ [epub/index.ts:1195](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1195)
1524
1524
 
1525
1525
  Update the Epub's language metadata entry.
1526
1526
 
@@ -1550,7 +1550,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1550
1550
  > **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
1551
1551
 
1552
1552
  Defined in:
1553
- [epub/index.ts:1366](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1366)
1553
+ [epub/index.ts:1364](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1364)
1554
1554
 
1555
1555
  Set a custom vocabulary prefix on the root package element.
1556
1556
 
@@ -1578,7 +1578,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1578
1578
  > **setPublicationDate**(`date`): `Promise`\<`void`\>
1579
1579
 
1580
1580
  Defined in:
1581
- [epub/index.ts:1007](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1007)
1581
+ [epub/index.ts:1006](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1006)
1582
1582
 
1583
1583
  Set the dc:date metadata element with the provided date.
1584
1584
 
@@ -1608,7 +1608,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1608
1608
  > **setTitle**(`title`): `Promise`\<`void`\>
1609
1609
 
1610
1610
  Defined in:
1611
- [epub/index.ts:1390](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1390)
1611
+ [epub/index.ts:1388](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1388)
1612
1612
 
1613
1613
  Set the title of the Epub.
1614
1614
 
@@ -1640,7 +1640,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1640
1640
  > **setTitles**(`entries`): `Promise`\<`void`\>
1641
1641
 
1642
1642
  Defined in:
1643
- [epub/index.ts:1418](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1418)
1643
+ [epub/index.ts:1416](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1416)
1644
1644
 
1645
1645
  ##### Parameters
1646
1646
 
@@ -1661,7 +1661,7 @@ Defined in:
1661
1661
  > **setType**(`type`): `Promise`\<`void`\>
1662
1662
 
1663
1663
  Defined in:
1664
- [epub/index.ts:1023](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1023)
1664
+ [epub/index.ts:1022](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1022)
1665
1665
 
1666
1666
  Set the dc:type metadata element.
1667
1667
 
@@ -1691,7 +1691,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1691
1691
  > **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
1692
1692
 
1693
1693
  Defined in:
1694
- [epub/index.ts:2268](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2268)
1694
+ [epub/index.ts:2266](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2266)
1695
1695
 
1696
1696
  Update the manifest entry for an existing item.
1697
1697
 
@@ -1724,7 +1724,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
1724
1724
  > **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
1725
1725
 
1726
1726
  Defined in:
1727
- [epub/index.ts:2107](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2107)
1727
+ [epub/index.ts:2105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2105)
1728
1728
 
1729
1729
  Write new contents for an existing manifest item, specified by its id.
1730
1730
 
@@ -1755,7 +1755,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1755
1755
  > **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
1756
1756
 
1757
1757
  Defined in:
1758
- [epub/index.ts:2108](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2108)
1758
+ [epub/index.ts:2106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2106)
1759
1759
 
1760
1760
  Write new contents for an existing manifest item, specified by its id.
1761
1761
 
@@ -1787,7 +1787,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1787
1787
  > **writeToArray**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1788
1788
 
1789
1789
  Defined in:
1790
- [epub/index.ts:2438](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2438)
1790
+ [epub/index.ts:2436](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2436)
1791
1791
 
1792
1792
  Write the current contents of the Epub to a new Uint8Array.
1793
1793
 
@@ -1835,7 +1835,7 @@ updated to the current UTC timestamp.
1835
1835
  > **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
1836
1836
 
1837
1837
  Defined in:
1838
- [epub/index.ts:2147](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2147)
1838
+ [epub/index.ts:2145](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2145)
1839
1839
 
1840
1840
  Write new contents for an existing XHTML item, specified by its id.
1841
1841
 
@@ -1866,7 +1866,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1866
1866
  > `static` **addLinkToXhtmlHead**(`xml`, `link`): `void`
1867
1867
 
1868
1868
  Defined in:
1869
- [epub/index.ts:272](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L272)
1869
+ [epub/index.ts:271](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L271)
1870
1870
 
1871
1871
  Given an XML structure representing a complete XHTML document, add a `link`
1872
1872
  element to the `head` of the document.
@@ -1920,7 +1920,7 @@ Construct an Epub instance, optionally beginning with the provided metadata.
1920
1920
  > [`XmlElement`](#xmlelement)\<`Name`\>
1921
1921
 
1922
1922
  Defined in:
1923
- [epub/index.ts:307](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L307)
1923
+ [epub/index.ts:306](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L306)
1924
1924
 
1925
1925
  ##### Type Parameters
1926
1926
 
@@ -1949,7 +1949,7 @@ Defined in:
1949
1949
  > `static` **createXmlTextNode**(`text`): [`XmlTextNode`](#xmltextnode)
1950
1950
 
1951
1951
  Defined in:
1952
- [epub/index.ts:320](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L320)
1952
+ [epub/index.ts:319](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L319)
1953
1953
 
1954
1954
  ##### Parameters
1955
1955
 
@@ -1971,7 +1971,7 @@ Defined in:
1971
1971
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
1972
1972
 
1973
1973
  Defined in:
1974
- [epub/index.ts:381](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L381)
1974
+ [epub/index.ts:380](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L380)
1975
1975
 
1976
1976
  Given an XML structure, find the first child matching the provided name and
1977
1977
  optional filter.
@@ -2003,7 +2003,7 @@ optional filter.
2003
2003
  > `static` **formatSmilDuration**(`duration`): `string`
2004
2004
 
2005
2005
  Defined in:
2006
- [epub/index.ts:255](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L255)
2006
+ [epub/index.ts:254](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L254)
2007
2007
 
2008
2008
  Format a duration, provided as a number of seconds, as a SMIL clock value, to be
2009
2009
  used for Media Overlays.
@@ -2054,7 +2054,7 @@ Construct an Epub instance by reading an existing EPUB publication.
2054
2054
  > `static` **getXhtmlBody**(`xml`): [`ParsedXml`](#parsedxml)
2055
2055
 
2056
2056
  Defined in:
2057
- [epub/index.ts:297](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L297)
2057
+ [epub/index.ts:296](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L296)
2058
2058
 
2059
2059
  Given an XML structure representing a complete XHTML document, return the
2060
2060
  sub-structure representing the children of the document's body element.
@@ -2078,7 +2078,7 @@ sub-structure representing the children of the document's body element.
2078
2078
  > `static` **getXhtmlTextContent**(`xml`): `string`
2079
2079
 
2080
2080
  Defined in:
2081
- [epub/index.ts:329](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L329)
2081
+ [epub/index.ts:328](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L328)
2082
2082
 
2083
2083
  Given an XML structure representing a complete XHTML document, return a string
2084
2084
  representing the concatenation of all text nodes in the document.
@@ -2102,7 +2102,7 @@ representing the concatenation of all text nodes in the document.
2102
2102
  > `static` **getXmlChildren**\<`Name`\>(`element`): [`ParsedXml`](#parsedxml)
2103
2103
 
2104
2104
  Defined in:
2105
- [epub/index.ts:361](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L361)
2105
+ [epub/index.ts:360](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L360)
2106
2106
 
2107
2107
  Given an XMLElement, return a list of its children
2108
2108
 
@@ -2131,7 +2131,7 @@ Given an XMLElement, return a list of its children
2131
2131
  > `static` **getXmlElementName**\<`Name`\>(`element`): `Name`
2132
2132
 
2133
2133
  Defined in:
2134
- [epub/index.ts:346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L346)
2134
+ [epub/index.ts:345](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L345)
2135
2135
 
2136
2136
  Given an XMLElement, return its tag name.
2137
2137
 
@@ -2160,7 +2160,7 @@ Given an XMLElement, return its tag name.
2160
2160
  > `static` **isXmlTextNode**(`node`): `node is XmlTextNode`
2161
2161
 
2162
2162
  Defined in:
2163
- [epub/index.ts:394](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L394)
2163
+ [epub/index.ts:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L393)
2164
2164
 
2165
2165
  Given an XMLNode, determine whether it represents a text node or an XML element.
2166
2166
 
@@ -2183,7 +2183,7 @@ Given an XMLNode, determine whether it represents a text node or an XML element.
2183
2183
  > `static` **replaceXmlChildren**\<`Name`\>(`element`, `children`): `void`
2184
2184
 
2185
2185
  Defined in:
2186
- [epub/index.ts:369](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L369)
2186
+ [epub/index.ts:368](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L368)
2187
2187
 
2188
2188
  ##### Type Parameters
2189
2189
 
@@ -2211,7 +2211,7 @@ Defined in:
2211
2211
  ## AlternateScript
2212
2212
 
2213
2213
  Defined in:
2214
- [epub/index.ts:143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L143)
2214
+ [epub/index.ts:142](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L142)
2215
2215
 
2216
2216
  ### Properties
2217
2217
 
@@ -2220,21 +2220,21 @@ Defined in:
2220
2220
  > **locale**: `Locale`
2221
2221
 
2222
2222
  Defined in:
2223
- [epub/index.ts:145](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L145)
2223
+ [epub/index.ts:144](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L144)
2224
2224
 
2225
2225
  #### name
2226
2226
 
2227
2227
  > **name**: `string`
2228
2228
 
2229
2229
  Defined in:
2230
- [epub/index.ts:144](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L144)
2230
+ [epub/index.ts:143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L143)
2231
2231
 
2232
2232
  ---
2233
2233
 
2234
2234
  ## Collection
2235
2235
 
2236
2236
  Defined in:
2237
- [epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L167)
2237
+ [epub/index.ts:166](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L166)
2238
2238
 
2239
2239
  ### Properties
2240
2240
 
@@ -2243,28 +2243,28 @@ Defined in:
2243
2243
  > **name**: `string`
2244
2244
 
2245
2245
  Defined in:
2246
- [epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L168)
2246
+ [epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L167)
2247
2247
 
2248
2248
  #### position?
2249
2249
 
2250
2250
  > `optional` **position**: `string`
2251
2251
 
2252
2252
  Defined in:
2253
- [epub/index.ts:170](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L170)
2253
+ [epub/index.ts:169](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L169)
2254
2254
 
2255
2255
  #### type?
2256
2256
 
2257
2257
  > `optional` **type**: `string`
2258
2258
 
2259
2259
  Defined in:
2260
- [epub/index.ts:169](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L169)
2260
+ [epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L168)
2261
2261
 
2262
2262
  ---
2263
2263
 
2264
2264
  ## DcCreator
2265
2265
 
2266
2266
  Defined in:
2267
- [epub/index.ts:148](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L148)
2267
+ [epub/index.ts:147](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L147)
2268
2268
 
2269
2269
  ### Properties
2270
2270
 
@@ -2273,42 +2273,42 @@ Defined in:
2273
2273
  > `optional` **alternateScripts**: [`AlternateScript`](#alternatescript)[]
2274
2274
 
2275
2275
  Defined in:
2276
- [epub/index.ts:153](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L153)
2276
+ [epub/index.ts:152](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L152)
2277
2277
 
2278
2278
  #### fileAs?
2279
2279
 
2280
2280
  > `optional` **fileAs**: `string`
2281
2281
 
2282
2282
  Defined in:
2283
- [epub/index.ts:152](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L152)
2283
+ [epub/index.ts:151](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L151)
2284
2284
 
2285
2285
  #### name
2286
2286
 
2287
2287
  > **name**: `string`
2288
2288
 
2289
2289
  Defined in:
2290
- [epub/index.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L149)
2290
+ [epub/index.ts:148](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L148)
2291
2291
 
2292
2292
  #### role?
2293
2293
 
2294
2294
  > `optional` **role**: `string`
2295
2295
 
2296
2296
  Defined in:
2297
- [epub/index.ts:150](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L150)
2297
+ [epub/index.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L149)
2298
2298
 
2299
2299
  #### roleScheme?
2300
2300
 
2301
2301
  > `optional` **roleScheme**: `string`
2302
2302
 
2303
2303
  Defined in:
2304
- [epub/index.ts:151](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L151)
2304
+ [epub/index.ts:150](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L150)
2305
2305
 
2306
2306
  ---
2307
2307
 
2308
2308
  ## DcSubject
2309
2309
 
2310
2310
  Defined in:
2311
- [epub/index.ts:137](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L137)
2311
+ [epub/index.ts:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L136)
2312
2312
 
2313
2313
  ### Properties
2314
2314
 
@@ -2317,28 +2317,28 @@ Defined in:
2317
2317
  > **authority**: `string`
2318
2318
 
2319
2319
  Defined in:
2320
- [epub/index.ts:139](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L139)
2320
+ [epub/index.ts:138](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L138)
2321
2321
 
2322
2322
  #### term
2323
2323
 
2324
2324
  > **term**: `string`
2325
2325
 
2326
2326
  Defined in:
2327
- [epub/index.ts:140](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L140)
2327
+ [epub/index.ts:139](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L139)
2328
2328
 
2329
2329
  #### value
2330
2330
 
2331
2331
  > **value**: `string`
2332
2332
 
2333
2333
  Defined in:
2334
- [epub/index.ts:138](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L138)
2334
+ [epub/index.ts:137](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L137)
2335
2335
 
2336
2336
  ---
2337
2337
 
2338
2338
  ## DublinCore
2339
2339
 
2340
2340
  Defined in:
2341
- [epub/index.ts:156](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L156)
2341
+ [epub/index.ts:155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L155)
2342
2342
 
2343
2343
  ### Properties
2344
2344
 
@@ -2347,56 +2347,56 @@ Defined in:
2347
2347
  > `optional` **contributors**: [`DcCreator`](#dccreator)[]
2348
2348
 
2349
2349
  Defined in:
2350
- [epub/index.ts:163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L163)
2350
+ [epub/index.ts:162](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L162)
2351
2351
 
2352
2352
  #### creators?
2353
2353
 
2354
2354
  > `optional` **creators**: [`DcCreator`](#dccreator)[]
2355
2355
 
2356
2356
  Defined in:
2357
- [epub/index.ts:162](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L162)
2357
+ [epub/index.ts:161](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L161)
2358
2358
 
2359
2359
  #### date?
2360
2360
 
2361
2361
  > `optional` **date**: `Date`
2362
2362
 
2363
2363
  Defined in:
2364
- [epub/index.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L160)
2364
+ [epub/index.ts:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L159)
2365
2365
 
2366
2366
  #### identifier
2367
2367
 
2368
2368
  > **identifier**: `string`
2369
2369
 
2370
2370
  Defined in:
2371
- [epub/index.ts:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L159)
2371
+ [epub/index.ts:158](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L158)
2372
2372
 
2373
2373
  #### language
2374
2374
 
2375
2375
  > **language**: `Locale`
2376
2376
 
2377
2377
  Defined in:
2378
- [epub/index.ts:158](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L158)
2378
+ [epub/index.ts:157](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L157)
2379
2379
 
2380
2380
  #### subjects?
2381
2381
 
2382
2382
  > `optional` **subjects**: (`string` \| [`DcSubject`](#dcsubject))[]
2383
2383
 
2384
2384
  Defined in:
2385
- [epub/index.ts:161](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L161)
2385
+ [epub/index.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L160)
2386
2386
 
2387
2387
  #### title
2388
2388
 
2389
2389
  > **title**: `string`
2390
2390
 
2391
2391
  Defined in:
2392
- [epub/index.ts:157](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L157)
2392
+ [epub/index.ts:156](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L156)
2393
2393
 
2394
2394
  #### type?
2395
2395
 
2396
2396
  > `optional` **type**: `string`
2397
2397
 
2398
2398
  Defined in:
2399
- [epub/index.ts:164](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L164)
2399
+ [epub/index.ts:163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L163)
2400
2400
 
2401
2401
  ---
2402
2402
 
@@ -2406,7 +2406,7 @@ Defined in:
2406
2406
  > \`$\{Letter \| Uppercase\<Letter\> \| QuestionMark\}$\{string\}\`
2407
2407
 
2408
2408
  Defined in:
2409
- [epub/index.ts:64](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L64)
2409
+ [epub/index.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L63)
2410
2410
 
2411
2411
  A valid name for an XML element (must start with a letter)
2412
2412
 
@@ -2417,7 +2417,7 @@ A valid name for an XML element (must start with a letter)
2417
2417
  > **EpubMetadata** = [`MetadataEntry`](#metadataentry)[]
2418
2418
 
2419
2419
  Defined in:
2420
- [epub/index.ts:135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L135)
2420
+ [epub/index.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L134)
2421
2421
 
2422
2422
  ---
2423
2423
 
@@ -2426,7 +2426,7 @@ Defined in:
2426
2426
  > **ManifestItem** = `object`
2427
2427
 
2428
2428
  Defined in:
2429
- [epub/index.ts:85](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L85)
2429
+ [epub/index.ts:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L84)
2430
2430
 
2431
2431
  ### Properties
2432
2432
 
@@ -2435,42 +2435,42 @@ Defined in:
2435
2435
  > `optional` **fallback**: `string`
2436
2436
 
2437
2437
  Defined in:
2438
- [epub/index.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L89)
2438
+ [epub/index.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L88)
2439
2439
 
2440
2440
  #### href
2441
2441
 
2442
2442
  > **href**: `string`
2443
2443
 
2444
2444
  Defined in:
2445
- [epub/index.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L87)
2445
+ [epub/index.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L86)
2446
2446
 
2447
2447
  #### id
2448
2448
 
2449
2449
  > **id**: `string`
2450
2450
 
2451
2451
  Defined in:
2452
- [epub/index.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L86)
2452
+ [epub/index.ts:85](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L85)
2453
2453
 
2454
2454
  #### mediaOverlay?
2455
2455
 
2456
2456
  > `optional` **mediaOverlay**: `string`
2457
2457
 
2458
2458
  Defined in:
2459
- [epub/index.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L90)
2459
+ [epub/index.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L89)
2460
2460
 
2461
2461
  #### mediaType?
2462
2462
 
2463
2463
  > `optional` **mediaType**: `string`
2464
2464
 
2465
2465
  Defined in:
2466
- [epub/index.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L88)
2466
+ [epub/index.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L87)
2467
2467
 
2468
2468
  #### properties?
2469
2469
 
2470
2470
  > `optional` **properties**: `string`[]
2471
2471
 
2472
2472
  Defined in:
2473
- [epub/index.ts:91](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L91)
2473
+ [epub/index.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L90)
2474
2474
 
2475
2475
  ---
2476
2476
 
@@ -2479,7 +2479,7 @@ Defined in:
2479
2479
  > **MetadataEntry** = `object`
2480
2480
 
2481
2481
  Defined in:
2482
- [epub/index.ts:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L128)
2482
+ [epub/index.ts:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L127)
2483
2483
 
2484
2484
  ### Properties
2485
2485
 
@@ -2488,28 +2488,28 @@ Defined in:
2488
2488
  > `optional` **id**: `string`
2489
2489
 
2490
2490
  Defined in:
2491
- [epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
2491
+ [epub/index.ts:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L128)
2492
2492
 
2493
2493
  #### properties
2494
2494
 
2495
2495
  > **properties**: `Record`\<`string`, `string`\>
2496
2496
 
2497
2497
  Defined in:
2498
- [epub/index.ts:131](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L131)
2498
+ [epub/index.ts:130](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L130)
2499
2499
 
2500
2500
  #### type
2501
2501
 
2502
2502
  > **type**: [`ElementName`](#elementname)
2503
2503
 
2504
2504
  Defined in:
2505
- [epub/index.ts:130](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L130)
2505
+ [epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
2506
2506
 
2507
2507
  #### value
2508
2508
 
2509
2509
  > **value**: `string` \| `undefined`
2510
2510
 
2511
2511
  Defined in:
2512
- [epub/index.ts:132](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L132)
2512
+ [epub/index.ts:131](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L131)
2513
2513
 
2514
2514
  ---
2515
2515
 
@@ -2518,7 +2518,7 @@ Defined in:
2518
2518
  > **ParsedXml** = [`XmlNode`](#xmlnode)[]
2519
2519
 
2520
2520
  Defined in:
2521
- [epub/index.ts:83](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L83)
2521
+ [epub/index.ts:82](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L82)
2522
2522
 
2523
2523
  An XML structure
2524
2524
 
@@ -2529,7 +2529,7 @@ An XML structure
2529
2529
  > **XmlElement**\<`Name`\> = `object` & `{ [key in Name]: ParsedXml }`
2530
2530
 
2531
2531
  Defined in:
2532
- [epub/index.ts:70](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L70)
2532
+ [epub/index.ts:69](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L69)
2533
2533
 
2534
2534
  An XML element
2535
2535
 
@@ -2552,7 +2552,7 @@ An XML element
2552
2552
  > **XmlNode** = [`XmlElement`](#xmlelement) \| [`XmlTextNode`](#xmltextnode)
2553
2553
 
2554
2554
  Defined in:
2555
- [epub/index.ts:80](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L80)
2555
+ [epub/index.ts:79](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L79)
2556
2556
 
2557
2557
  A valid XML node. May be either an element or a text node.
2558
2558
 
@@ -2563,7 +2563,7 @@ A valid XML node. May be either an element or a text node.
2563
2563
  > **XmlTextNode** = `object`
2564
2564
 
2565
2565
  Defined in:
2566
- [epub/index.ts:77](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L77)
2566
+ [epub/index.ts:76](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L76)
2567
2567
 
2568
2568
  A text node in an XML document
2569
2569
 
@@ -2574,4 +2574,4 @@ A text node in an XML document
2574
2574
  > **#text**: `string`
2575
2575
 
2576
2576
  Defined in:
2577
- [epub/index.ts:77](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L77)
2577
+ [epub/index.ts:76](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L76)
package/dist/index.cjs CHANGED
@@ -34,7 +34,6 @@ module.exports = __toCommonJS(index_exports);
34
34
  var import_zip = require("@zip.js/zip.js");
35
35
  var import_async_mutex = require("async-mutex");
36
36
  var import_fast_xml_parser = require("fast-xml-parser");
37
- var import_he = __toESM(require("he"), 1);
38
37
  var import_mem = __toESM(require("mem"), 1);
39
38
  var import_mime_types = require("mime-types");
40
39
  var import_nanoid = require("nanoid");
@@ -939,7 +938,7 @@ ${JSON.stringify(element, null, 2)}`
939
938
  async setDescription(description) {
940
939
  await this.replaceMetadata(({ type }) => type === "dc:description", {
941
940
  type: "dc:description",
942
- value: import_he.default.encode(description),
941
+ value: description,
943
942
  properties: {}
944
943
  });
945
944
  }
@@ -957,8 +956,7 @@ ${JSON.stringify(element, null, 2)}`
957
956
  (entry) => entry.type === "dc:description"
958
957
  );
959
958
  if (!(descriptionEntry == null ? void 0 : descriptionEntry.value)) return null;
960
- const escaped = descriptionEntry.value;
961
- return import_he.default.decode(escaped);
959
+ return descriptionEntry.value;
962
960
  }
963
961
  /**
964
962
  * Return the set of custom vocabulary prefixes set on this publication's
package/dist/index.js CHANGED
@@ -7,7 +7,6 @@ import {
7
7
  } from "@zip.js/zip.js";
8
8
  import { Mutex } from "async-mutex";
9
9
  import { XMLBuilder, XMLParser } from "fast-xml-parser";
10
- import he from "he";
11
10
  import memoize from "mem";
12
11
  import { lookup } from "mime-types";
13
12
  import { nanoid } from "nanoid";
@@ -912,7 +911,7 @@ ${JSON.stringify(element, null, 2)}`
912
911
  async setDescription(description) {
913
912
  await this.replaceMetadata(({ type }) => type === "dc:description", {
914
913
  type: "dc:description",
915
- value: he.encode(description),
914
+ value: description,
916
915
  properties: {}
917
916
  });
918
917
  }
@@ -930,8 +929,7 @@ ${JSON.stringify(element, null, 2)}`
930
929
  (entry) => entry.type === "dc:description"
931
930
  );
932
931
  if (!(descriptionEntry == null ? void 0 : descriptionEntry.value)) return null;
933
- const escaped = descriptionEntry.value;
934
- return he.decode(escaped);
932
+ return descriptionEntry.value;
935
933
  }
936
934
  /**
937
935
  * Return the set of custom vocabulary prefixes set on this publication's
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storyteller-platform/epub",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "type": "module",
5
5
  "module": "dist/index.js",
6
6
  "types": "dist/index.d.ts",