@storyteller-platform/epub 0.5.0 → 0.5.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
@@ -220,7 +220,7 @@ To get started with developing in the Storyteller monorepo, check out the
220
220
  ## Epub
221
221
 
222
222
  Defined in:
223
- [epub/index.ts:229](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L229)
223
+ [epub/index.ts:235](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L235)
224
224
 
225
225
  A single EPUB instance.
226
226
 
@@ -262,7 +262,7 @@ https://www.w3.org/TR/epub-33/
262
262
  > `protected` **new Epub**(`extractPath`, `inputPath`): [`Epub`](#epub)
263
263
 
264
264
  Defined in:
265
- [epub/index.ts:480](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L480)
265
+ [epub/index.ts:486](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L486)
266
266
 
267
267
  ##### Parameters
268
268
 
@@ -282,42 +282,42 @@ Defined in:
282
282
  > `protected` **extractPath**: `string`
283
283
 
284
284
  Defined in:
285
- [epub/index.ts:481](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L481)
285
+ [epub/index.ts:487](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L487)
286
286
 
287
287
  #### inputPath
288
288
 
289
289
  > `protected` **inputPath**: `undefined` \| `string`
290
290
 
291
291
  Defined in:
292
- [epub/index.ts:482](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L482)
292
+ [epub/index.ts:488](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L488)
293
293
 
294
294
  #### xhtmlBuilder
295
295
 
296
296
  > `static` **xhtmlBuilder**: `XMLBuilder`
297
297
 
298
298
  Defined in:
299
- [epub/index.ts:277](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L277)
299
+ [epub/index.ts:283](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L283)
300
300
 
301
301
  #### xhtmlParser
302
302
 
303
303
  > `static` **xhtmlParser**: `XMLParser`
304
304
 
305
305
  Defined in:
306
- [epub/index.ts:237](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L237)
306
+ [epub/index.ts:243](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L243)
307
307
 
308
308
  #### xmlBuilder
309
309
 
310
310
  > `static` **xmlBuilder**: `XMLBuilder`
311
311
 
312
312
  Defined in:
313
- [epub/index.ts:270](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L270)
313
+ [epub/index.ts:276](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L276)
314
314
 
315
315
  #### xmlParser
316
316
 
317
317
  > `static` **xmlParser**: `XMLParser`
318
318
 
319
319
  Defined in:
320
- [epub/index.ts:230](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L230)
320
+ [epub/index.ts:236](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L236)
321
321
 
322
322
  ### Methods
323
323
 
@@ -326,7 +326,7 @@ Defined in:
326
326
  > **\[dispose\]**(): `void`
327
327
 
328
328
  Defined in:
329
- [epub/index.ts:3098](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3098)
329
+ [epub/index.ts:3108](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3108)
330
330
 
331
331
  ##### Returns
332
332
 
@@ -337,7 +337,7 @@ Defined in:
337
337
  > **addCollection**(`collection`, `index?`): `Promise`\<`void`\>
338
338
 
339
339
  Defined in:
340
- [epub/index.ts:1698](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1698)
340
+ [epub/index.ts:1704](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1704)
341
341
 
342
342
  Add a collection to the EPUB metadata.
343
343
 
@@ -360,7 +360,7 @@ collections. Otherwise, it will be added to the end of the list.
360
360
  > **addContributor**(`contributor`, `index?`): `Promise`\<`void`\>
361
361
 
362
362
  Defined in:
363
- [epub/index.ts:2040](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2040)
363
+ [epub/index.ts:2046](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2046)
364
364
 
365
365
  Add a contributor to the EPUB metadata.
366
366
 
@@ -390,7 +390,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
390
390
  > **addCreator**(`creator`, `index?`, `type?`): `Promise`\<`void`\>
391
391
 
392
392
  Defined in:
393
- [epub/index.ts:1885](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1885)
393
+ [epub/index.ts:1891](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1891)
394
394
 
395
395
  Add a creator to the EPUB metadata.
396
396
 
@@ -420,7 +420,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
420
420
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
421
421
 
422
422
  Defined in:
423
- [epub/index.ts:2570](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2570)
423
+ [epub/index.ts:2580](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2580)
424
424
 
425
425
  Create a new manifest item and write its contents to a new entry.
426
426
 
@@ -449,7 +449,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
449
449
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
450
450
 
451
451
  Defined in:
452
- [epub/index.ts:2575](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2575)
452
+ [epub/index.ts:2585](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2585)
453
453
 
454
454
  Create a new manifest item and write its contents to a new entry.
455
455
 
@@ -478,7 +478,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
478
478
  > **addManifestItem**(`item`, `contents`): `Promise`\<`void`\>
479
479
 
480
480
  Defined in:
481
- [epub/index.ts:2580](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2580)
481
+ [epub/index.ts:2590](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2590)
482
482
 
483
483
  Create a new manifest item and write its contents to a new entry.
484
484
 
@@ -506,7 +506,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
506
506
  > **addMetadata**(`entry`): `Promise`\<`void`\>
507
507
 
508
508
  Defined in:
509
- [epub/index.ts:2692](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2692)
509
+ [epub/index.ts:2702](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2702)
510
510
 
511
511
  Add a new metadata entry to the Epub.
512
512
 
@@ -533,7 +533,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
533
533
  > **addSpineItem**(`manifestId`, `index?`): `Promise`\<`void`\>
534
534
 
535
535
  Defined in:
536
- [epub/index.ts:2094](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2094)
536
+ [epub/index.ts:2100](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2100)
537
537
 
538
538
  Add an item to the spine of the EPUB.
539
539
 
@@ -563,7 +563,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
563
563
  > **addSubject**(`subject`): `Promise`\<`void`\>
564
564
 
565
565
  Defined in:
566
- [epub/index.ts:1227](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1227)
566
+ [epub/index.ts:1233](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1233)
567
567
 
568
568
  Add a subject to the EPUB metadata.
569
569
 
@@ -586,7 +586,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
586
586
  > **copy**(`path?`): `Promise`\<[`Epub`](#epub)\>
587
587
 
588
588
  Defined in:
589
- [epub/index.ts:652](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L652)
589
+ [epub/index.ts:658](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L658)
590
590
 
591
591
  ##### Parameters
592
592
 
@@ -605,7 +605,7 @@ Defined in:
605
605
  > [`XmlElement`](#xmlelement)\<`"html"`\>)[]\>
606
606
 
607
607
  Defined in:
608
- [epub/index.ts:2396](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2396)
608
+ [epub/index.ts:2406](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2406)
609
609
 
610
610
  Create a new XHTML document with the given body and head.
611
611
 
@@ -627,7 +627,7 @@ Create a new XHTML document with the given body and head.
627
627
  > **discardAndClose**(): `void`
628
628
 
629
629
  Defined in:
630
- [epub/index.ts:2935](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2935)
630
+ [epub/index.ts:2945](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2945)
631
631
 
632
632
  ##### Returns
633
633
 
@@ -638,7 +638,7 @@ Defined in:
638
638
  > **findAllMetadataItems**(`predicate`): `Promise`\<`object`[]\>
639
639
 
640
640
  Defined in:
641
- [epub/index.ts:897](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L897)
641
+ [epub/index.ts:903](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L903)
642
642
 
643
643
  Returns the item in the metadata element's children array that matches the
644
644
  provided predicate.
@@ -678,7 +678,7 @@ provided predicate.
678
678
  > \}\>
679
679
 
680
680
  Defined in:
681
- [epub/index.ts:888](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L888)
681
+ [epub/index.ts:894](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L894)
682
682
 
683
683
  Returns the item in the metadata element's children array that matches the
684
684
  provided predicate.
@@ -717,7 +717,7 @@ provided predicate.
717
717
  > **getBaseDirection**(): `Promise`\<`"auto"` \| `"rtl"` \| `"ltr"`\>
718
718
 
719
719
  Defined in:
720
- [epub/index.ts:1181](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1181)
720
+ [epub/index.ts:1187](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1187)
721
721
 
722
722
  Retrieve the base direction from the package element.
723
723
 
@@ -736,7 +736,7 @@ https://www.w3.org/TR/epub-33/#attrdef-dir
736
736
  > **getCollections**(): `Promise`\<[`Collection`](#collection)[]\>
737
737
 
738
738
  Defined in:
739
- [epub/index.ts:1658](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1658)
739
+ [epub/index.ts:1664](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1664)
740
740
 
741
741
  Retrieve the list of collections.
742
742
 
@@ -749,7 +749,7 @@ Retrieve the list of collections.
749
749
  > **getContributors**(): `Promise`\<[`DcCreator`](#dccreator)[]\>
750
750
 
751
751
  Defined in:
752
- [epub/index.ts:1872](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1872)
752
+ [epub/index.ts:1878](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1878)
753
753
 
754
754
  Retrieve the list of contributors.
755
755
 
@@ -768,7 +768,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccontributor
768
768
  > **getCoverImage**(): `Promise`\<`null` \| `Uint8Array`\<`ArrayBufferLike`\>\>
769
769
 
770
770
  Defined in:
771
- [epub/index.ts:1077](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1077)
771
+ [epub/index.ts:1083](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1083)
772
772
 
773
773
  Retrieve the cover image data as a byte array.
774
774
 
@@ -789,7 +789,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
789
789
  > [`ManifestItem`](#manifestitem)\>
790
790
 
791
791
  Defined in:
792
- [epub/index.ts:1058](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1058)
792
+ [epub/index.ts:1064](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1064)
793
793
 
794
794
  Retrieve the cover image manifest item.
795
795
 
@@ -809,7 +809,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
809
809
  > **getCreators**(`type`): `Promise`\<[`DcCreator`](#dccreator)[]\>
810
810
 
811
811
  Defined in:
812
- [epub/index.ts:1811](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1811)
812
+ [epub/index.ts:1817](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1817)
813
813
 
814
814
  Retrieve the list of creators.
815
815
 
@@ -832,7 +832,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
832
832
  > **getDescription**(): `Promise`\<`null` \| `string`\>
833
833
 
834
834
  Defined in:
835
- [epub/index.ts:1509](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1509)
835
+ [epub/index.ts:1515](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1515)
836
836
 
837
837
  Retrieve the Epub's description as specified in its package document metadata.
838
838
 
@@ -848,7 +848,7 @@ as a string. Descriptions may include HTML markup.
848
848
  > **getGuideEntries**(): `Promise`\<`GuideItem`[]\>
849
849
 
850
850
  Defined in:
851
- [epub/index.ts:2912](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2912)
851
+ [epub/index.ts:2922](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2922)
852
852
 
853
853
  Retrieve the guide entries from the package document.
854
854
 
@@ -864,7 +864,7 @@ many publications still include it.
864
864
  > **getIdentifier**(): `Promise`\<`null` \| `string`\>
865
865
 
866
866
  Defined in:
867
- [epub/index.ts:992](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L992)
867
+ [epub/index.ts:998](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L998)
868
868
 
869
869
  Retrieve the identifier from the dc:identifier element in the EPUB metadata.
870
870
 
@@ -884,7 +884,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
884
884
  > [`Navigation`](#navigation)\>
885
885
 
886
886
  Defined in:
887
- [epub/index.ts:2273](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2273)
887
+ [epub/index.ts:2279](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2279)
888
888
 
889
889
  Returns the structured landmarks navigation document as a Navigation object
890
890
 
@@ -908,7 +908,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
908
908
  > **getLanguage**(): `Promise`\<`null` \| `Locale`\>
909
909
 
910
910
  Defined in:
911
- [epub/index.ts:1346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1346)
911
+ [epub/index.ts:1352](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1352)
912
912
 
913
913
  Retrieve the Epub's language as specified in its package document metadata.
914
914
 
@@ -928,7 +928,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
928
928
  > **getLayout**(): `Promise`\<`"pre-paginated"` \| `"reflowable"`\>
929
929
 
930
930
  Defined in:
931
- [epub/index.ts:1162](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1162)
931
+ [epub/index.ts:1168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1168)
932
932
 
933
933
  Retrieve the layout from the rendition:layout meta element in the EPUB metadata.
934
934
 
@@ -948,7 +948,7 @@ https://www.w3.org/TR/epub-33/#layout
948
948
  > [`ManifestItem`](#manifestitem)\>\>
949
949
 
950
950
  Defined in:
951
- [epub/index.ts:813](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L813)
951
+ [epub/index.ts:819](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L819)
952
952
 
953
953
  Retrieve the manifest for the Epub.
954
954
 
@@ -968,7 +968,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
968
968
  > **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
969
969
 
970
970
  Defined in:
971
- [epub/index.ts:964](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L964)
971
+ [epub/index.ts:970](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L970)
972
972
 
973
973
  Retrieve the metadata entries for the Epub.
974
974
 
@@ -991,7 +991,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
991
991
  > **getModifiedDate**(): `Promise`\<`null` \| `Date`\>
992
992
 
993
993
  Defined in:
994
- [epub/index.ts:1145](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1145)
994
+ [epub/index.ts:1151](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1151)
995
995
 
996
996
  Retrieve the modified date from the dcterms:modified metadata in the EPUB
997
997
  metadata as a Date object.
@@ -1011,7 +1011,7 @@ https://www.w3.org/TR/epub-33/#sec-metadata-last-modified
1011
1011
  > **getNcxTableOfContents**(): `Promise`\<[`NavigationList`](#navigationlist)\>
1012
1012
 
1013
1013
  Defined in:
1014
- [epub/index.ts:2817](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2817)
1014
+ [epub/index.ts:2827](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2827)
1015
1015
 
1016
1016
  Parse the NCX table of contents, if one exists, and return a tree of TocEntry
1017
1017
  nodes.
@@ -1029,7 +1029,7 @@ and EPUB 3 publications that retain an NCX for backwards compatibility.
1029
1029
  > `string`\>\>
1030
1030
 
1031
1031
  Defined in:
1032
- [epub/index.ts:1526](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1526)
1032
+ [epub/index.ts:1532](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1532)
1033
1033
 
1034
1034
  Return the set of custom vocabulary prefixes set on this publication's root
1035
1035
  package element.
@@ -1050,7 +1050,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1050
1050
  > [`Navigation`](#navigation)\>
1051
1051
 
1052
1052
  Defined in:
1053
- [epub/index.ts:2285](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2285)
1053
+ [epub/index.ts:2291](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2291)
1054
1054
 
1055
1055
  Returns the structured page list navigation document as a Navigation object
1056
1056
 
@@ -1074,7 +1074,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
1074
1074
  > **getPublicationDate**(): `Promise`\<`null` \| `Date`\>
1075
1075
 
1076
1076
  Defined in:
1077
- [epub/index.ts:1114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1114)
1077
+ [epub/index.ts:1120](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1120)
1078
1078
 
1079
1079
  Retrieve the publication date from the dc:date element in the EPUB metadata as a
1080
1080
  Date object.
@@ -1094,7 +1094,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1094
1094
  > **getRootfile**(): `Promise`\<`string`\>
1095
1095
 
1096
1096
  Defined in:
1097
- [epub/index.ts:685](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L685)
1097
+ [epub/index.ts:691](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L691)
1098
1098
 
1099
1099
  ##### Returns
1100
1100
 
@@ -1105,7 +1105,7 @@ Defined in:
1105
1105
  > **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem)[]\>
1106
1106
 
1107
1107
  Defined in:
1108
- [epub/index.ts:2075](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2075)
1108
+ [epub/index.ts:2081](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2081)
1109
1109
 
1110
1110
  Retrieve the manifest items that make up the Epub's spine.
1111
1111
 
@@ -1125,7 +1125,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1125
1125
  > **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
1126
1126
 
1127
1127
  Defined in:
1128
- [epub/index.ts:1301](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1301)
1128
+ [epub/index.ts:1307](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1307)
1129
1129
 
1130
1130
  Retrieve the list of subjects for this EPUB.
1131
1131
 
@@ -1146,7 +1146,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
1146
1146
  > **getSubtitle**(): `Promise`\<`null` \| `string`\>
1147
1147
 
1148
1148
  Defined in:
1149
- [epub/index.ts:1416](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1416)
1149
+ [epub/index.ts:1422](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1422)
1150
1150
 
1151
1151
  Retrieve the subtitle of the Epub, if it exists.
1152
1152
 
@@ -1164,7 +1164,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1164
1164
  > [`Navigation`](#navigation)\>
1165
1165
 
1166
1166
  Defined in:
1167
- [epub/index.ts:2256](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2256)
1167
+ [epub/index.ts:2262](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2262)
1168
1168
 
1169
1169
  Returns the structured table of contents navigation document as a Navigation
1170
1170
  object.
@@ -1189,7 +1189,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-toc
1189
1189
  > **getTitle**(`expanded`): `Promise`\<`null` \| `string`\>
1190
1190
 
1191
1191
  Defined in:
1192
- [epub/index.ts:1392](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1392)
1192
+ [epub/index.ts:1398](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1398)
1193
1193
 
1194
1194
  Retrieve the title of the Epub.
1195
1195
 
@@ -1212,7 +1212,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1212
1212
  > **getTitles**(): `Promise`\<`object`[]\>
1213
1213
 
1214
1214
  Defined in:
1215
- [epub/index.ts:1428](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1428)
1215
+ [epub/index.ts:1434](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1434)
1216
1216
 
1217
1217
  Retrieve all title entries of the Epub.
1218
1218
 
@@ -1229,7 +1229,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1229
1229
  > **getType**(): `Promise`\<`null` \| [`MetadataEntry`](#metadataentry)\>
1230
1230
 
1231
1231
  Defined in:
1232
- [epub/index.ts:1214](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1214)
1232
+ [epub/index.ts:1220](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1220)
1233
1233
 
1234
1234
  Retrieve the publication type from the dc:type element in the EPUB metadata.
1235
1235
 
@@ -1248,7 +1248,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1248
1248
  > **getVersion**(): `Promise`\<`string`\>
1249
1249
 
1250
1250
  Defined in:
1251
- [epub/index.ts:2804](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2804)
1251
+ [epub/index.ts:2814](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2814)
1252
1252
 
1253
1253
  Returns the EPUB version declared on the package element.
1254
1254
 
@@ -1264,7 +1264,7 @@ Returns the EPUB version declared on the package element.
1264
1264
  > `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1265
1265
 
1266
1266
  Defined in:
1267
- [epub/index.ts:2335](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2335)
1267
+ [epub/index.ts:2345](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2345)
1268
1268
 
1269
1269
  Retrieve the contents of a file, given its href.
1270
1270
 
@@ -1287,7 +1287,7 @@ encoding parameter.
1287
1287
  > **readFileContents**(`href`, `relativeTo`, `encoding`): `Promise`\<`string`\>
1288
1288
 
1289
1289
  Defined in:
1290
- [epub/index.ts:2336](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2336)
1290
+ [epub/index.ts:2346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2346)
1291
1291
 
1292
1292
  Retrieve the contents of a file, given its href.
1293
1293
 
@@ -1313,7 +1313,7 @@ encoding parameter.
1313
1313
  > **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1314
1314
 
1315
1315
  Defined in:
1316
- [epub/index.ts:2368](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2368)
1316
+ [epub/index.ts:2378](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2378)
1317
1317
 
1318
1318
  Retrieve the contents of a manifest item, given its id.
1319
1319
 
@@ -1336,7 +1336,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1336
1336
  > **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
1337
1337
 
1338
1338
  Defined in:
1339
- [epub/index.ts:2369](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2369)
1339
+ [epub/index.ts:2379](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2379)
1340
1340
 
1341
1341
  Retrieve the contents of a manifest item, given its id.
1342
1342
 
@@ -1362,7 +1362,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1362
1362
  > **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`ParsedXml`](#parsedxml)\>
1363
1363
 
1364
1364
  Defined in:
1365
- [epub/index.ts:2431](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2431)
1365
+ [epub/index.ts:2441](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2441)
1366
1366
 
1367
1367
  Retrieves the contents of an XHTML item, given its manifest id.
1368
1368
 
@@ -1386,7 +1386,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1386
1386
  > **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
1387
1387
 
1388
1388
  Defined in:
1389
- [epub/index.ts:2432](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2432)
1389
+ [epub/index.ts:2442](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2442)
1390
1390
 
1391
1391
  Retrieves the contents of an XHTML item, given its manifest id.
1392
1392
 
@@ -1410,7 +1410,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1410
1410
  > **removeCollection**(`index`): `Promise`\<`void`\>
1411
1411
 
1412
1412
  Defined in:
1413
- [epub/index.ts:1767](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1767)
1413
+ [epub/index.ts:1773](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1773)
1414
1414
 
1415
1415
  Remove a collection from the EPUB metadata.
1416
1416
 
@@ -1432,7 +1432,7 @@ returned by `epub.getCollections()`.
1432
1432
  > **removeContributor**(`index`): `Promise`\<`void`\>
1433
1433
 
1434
1434
  Defined in:
1435
- [epub/index.ts:2024](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2024)
1435
+ [epub/index.ts:2030](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2030)
1436
1436
 
1437
1437
  Remove a contributor from the EPUB metadata.
1438
1438
 
@@ -1460,7 +1460,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1460
1460
  > **removeCreator**(`index`, `type`): `Promise`\<`void`\>
1461
1461
 
1462
1462
  Defined in:
1463
- [epub/index.ts:1972](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1972)
1463
+ [epub/index.ts:1978](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1978)
1464
1464
 
1465
1465
  Remove a creator from the EPUB metadata.
1466
1466
 
@@ -1487,7 +1487,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1487
1487
  > **removeManifestItem**(`id`): `Promise`\<`void`\>
1488
1488
 
1489
1489
  Defined in:
1490
- [epub/index.ts:2527](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2527)
1490
+ [epub/index.ts:2537](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2537)
1491
1491
 
1492
1492
  ##### Parameters
1493
1493
 
@@ -1504,7 +1504,7 @@ Defined in:
1504
1504
  > **removeMetadata**(`predicate`): `Promise`\<`void`\>
1505
1505
 
1506
1506
  Defined in:
1507
- [epub/index.ts:2776](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2776)
1507
+ [epub/index.ts:2786](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2786)
1508
1508
 
1509
1509
  Remove one or more metadata entries.
1510
1510
 
@@ -1530,7 +1530,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1530
1530
  > **removeSpineItem**(`index`): `Promise`\<`void`\>
1531
1531
 
1532
1532
  Defined in:
1533
- [epub/index.ts:2130](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2130)
1533
+ [epub/index.ts:2136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2136)
1534
1534
 
1535
1535
  Remove the spine item at the specified index.
1536
1536
 
@@ -1553,7 +1553,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1553
1553
  > **removeSubject**(`index`): `Promise`\<`void`\>
1554
1554
 
1555
1555
  Defined in:
1556
- [epub/index.ts:1264](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1264)
1556
+ [epub/index.ts:1270](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1270)
1557
1557
 
1558
1558
  Remove a subject from the EPUB metadata.
1559
1559
 
@@ -1579,7 +1579,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1579
1579
  > **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
1580
1580
 
1581
1581
  Defined in:
1582
- [epub/index.ts:2731](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2731)
1582
+ [epub/index.ts:2741](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2741)
1583
1583
 
1584
1584
  Replace a metadata entry with a new one.
1585
1585
 
@@ -1607,7 +1607,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1607
1607
  > `Promise`\<`string`\>
1608
1608
 
1609
1609
  Defined in:
1610
- [epub/index.ts:2307](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2307)
1610
+ [epub/index.ts:2317](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2317)
1611
1611
 
1612
1612
  Returns a path-relative-scheme-less URL, relative to the container root.
1613
1613
 
@@ -1629,7 +1629,7 @@ Returns a path-relative-scheme-less URL, relative to the container root.
1629
1629
  > **saveAndClose**(): `Promise`\<`void`\>
1630
1630
 
1631
1631
  Defined in:
1632
- [epub/index.ts:2951](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2951)
1632
+ [epub/index.ts:2961](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2961)
1633
1633
 
1634
1634
  Write the current contents of the Epub to a new EPUB archive on disk.
1635
1635
 
@@ -1645,7 +1645,7 @@ updated to the current UTC timestamp.
1645
1645
  > **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
1646
1646
 
1647
1647
  Defined in:
1648
- [epub/index.ts:1091](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1091)
1648
+ [epub/index.ts:1097](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1097)
1649
1649
 
1650
1650
  Set the cover image for the EPUB.
1651
1651
 
@@ -1668,7 +1668,7 @@ then writes the provided image data to the provided href within the publication.
1668
1668
  > **setDescription**(`description`): `Promise`\<`void`\>
1669
1669
 
1670
1670
  Defined in:
1671
- [epub/index.ts:1493](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1493)
1671
+ [epub/index.ts:1499](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1499)
1672
1672
 
1673
1673
  Update the Epub's description metadata entry.
1674
1674
 
@@ -1691,7 +1691,7 @@ encoded as HTML entities.
1691
1691
  > **setIdentifier**(`identifier`): `Promise`\<`void`\>
1692
1692
 
1693
1693
  Defined in:
1694
- [epub/index.ts:1006](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1006)
1694
+ [epub/index.ts:1012](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1012)
1695
1695
 
1696
1696
  Set the dc:identifier metadata element with the provided string.
1697
1697
 
@@ -1717,7 +1717,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1717
1717
  > **setLanguage**(`locale`): `Promise`\<`void`\>
1718
1718
 
1719
1719
  Defined in:
1720
- [epub/index.ts:1375](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1375)
1720
+ [epub/index.ts:1381](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1381)
1721
1721
 
1722
1722
  Update the Epub's language metadata entry.
1723
1723
 
@@ -1743,7 +1743,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1743
1743
  > **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
1744
1744
 
1745
1745
  Defined in:
1746
- [epub/index.ts:1544](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1544)
1746
+ [epub/index.ts:1550](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1550)
1747
1747
 
1748
1748
  Set a custom vocabulary prefix on the root package element.
1749
1749
 
@@ -1767,7 +1767,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1767
1767
  > **setPublicationDate**(`date`): `Promise`\<`void`\>
1768
1768
 
1769
1769
  Defined in:
1770
- [epub/index.ts:1129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1129)
1770
+ [epub/index.ts:1135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1135)
1771
1771
 
1772
1772
  Set the dc:date metadata element with the provided date.
1773
1773
 
@@ -1793,7 +1793,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1793
1793
  > **setTitle**(`title`): `Promise`\<`void`\>
1794
1794
 
1795
1795
  Defined in:
1796
- [epub/index.ts:1568](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1568)
1796
+ [epub/index.ts:1574](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1574)
1797
1797
 
1798
1798
  Set the title of the Epub.
1799
1799
 
@@ -1821,7 +1821,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1821
1821
  > **setTitles**(`entries`): `Promise`\<`void`\>
1822
1822
 
1823
1823
  Defined in:
1824
- [epub/index.ts:1596](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1596)
1824
+ [epub/index.ts:1602](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1602)
1825
1825
 
1826
1826
  ##### Parameters
1827
1827
 
@@ -1838,7 +1838,7 @@ Defined in:
1838
1838
  > **setType**(`type`): `Promise`\<`void`\>
1839
1839
 
1840
1840
  Defined in:
1841
- [epub/index.ts:1198](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1198)
1841
+ [epub/index.ts:1204](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1204)
1842
1842
 
1843
1843
  Set the dc:type metadata element.
1844
1844
 
@@ -1864,7 +1864,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1864
1864
  > **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
1865
1865
 
1866
1866
  Defined in:
1867
- [epub/index.ts:2643](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2643)
1867
+ [epub/index.ts:2653](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2653)
1868
1868
 
1869
1869
  Update the manifest entry for an existing item.
1870
1870
 
@@ -1893,7 +1893,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
1893
1893
  > **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
1894
1894
 
1895
1895
  Defined in:
1896
- [epub/index.ts:2479](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2479)
1896
+ [epub/index.ts:2489](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2489)
1897
1897
 
1898
1898
  Write new contents for an existing manifest item, specified by its id.
1899
1899
 
@@ -1920,7 +1920,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1920
1920
  > **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
1921
1921
 
1922
1922
  Defined in:
1923
- [epub/index.ts:2480](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2480)
1923
+ [epub/index.ts:2490](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2490)
1924
1924
 
1925
1925
  Write new contents for an existing manifest item, specified by its id.
1926
1926
 
@@ -1948,7 +1948,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1948
1948
  > **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
1949
1949
 
1950
1950
  Defined in:
1951
- [epub/index.ts:2519](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2519)
1951
+ [epub/index.ts:2529](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2529)
1952
1952
 
1953
1953
  Write new contents for an existing XHTML item, specified by its id.
1954
1954
 
@@ -1975,7 +1975,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1975
1975
  > `static` **addLinkToXhtmlHead**(`xml`, `link`): `void`
1976
1976
 
1977
1977
  Defined in:
1978
- [epub/index.ts:307](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L307)
1978
+ [epub/index.ts:313](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L313)
1979
1979
 
1980
1980
  Given an XML structure representing a complete XHTML document, add a `link`
1981
1981
  element to the `head` of the document.
@@ -2002,7 +2002,7 @@ This method modifies the provided XML structure.
2002
2002
  > `Promise`\<[`Epub`](#epub)\>
2003
2003
 
2004
2004
  Defined in:
2005
- [epub/index.ts:500](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L500)
2005
+ [epub/index.ts:506](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L506)
2006
2006
 
2007
2007
  Construct an Epub instance, optionally beginning with the provided metadata.
2008
2008
 
@@ -2024,7 +2024,7 @@ Construct an Epub instance, optionally beginning with the provided metadata.
2024
2024
  > [`XmlElement`](#xmlelement)\<`Name`\>
2025
2025
 
2026
2026
  Defined in:
2027
- [epub/index.ts:342](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L342)
2027
+ [epub/index.ts:348](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L348)
2028
2028
 
2029
2029
  ##### Type Parameters
2030
2030
 
@@ -2049,7 +2049,7 @@ Defined in:
2049
2049
  > `static` **createXmlTextNode**(`text`): [`XmlTextNode`](#xmltextnode)
2050
2050
 
2051
2051
  Defined in:
2052
- [epub/index.ts:355](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L355)
2052
+ [epub/index.ts:361](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L361)
2053
2053
 
2054
2054
  ##### Parameters
2055
2055
 
@@ -2067,7 +2067,7 @@ Defined in:
2067
2067
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
2068
2068
 
2069
2069
  Defined in:
2070
- [epub/index.ts:428](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L428)
2070
+ [epub/index.ts:434](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L434)
2071
2071
 
2072
2072
  Given an XML structure, find the first child matching the provided name and
2073
2073
  optional filter.
@@ -2096,7 +2096,7 @@ optional filter.
2096
2096
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
2097
2097
 
2098
2098
  Defined in:
2099
- [epub/index.ts:446](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L446)
2099
+ [epub/index.ts:452](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L452)
2100
2100
 
2101
2101
  Given an XML structure, find the first descendant matching the provided name and
2102
2102
  optional filter.
@@ -2127,7 +2127,7 @@ element in the tree matching the name and filter.
2127
2127
  > `static` **formatSmilDuration**(`duration`): `string`
2128
2128
 
2129
2129
  Defined in:
2130
- [epub/index.ts:290](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L290)
2130
+ [epub/index.ts:296](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L296)
2131
2131
 
2132
2132
  Format a duration, provided as a number of seconds, as a SMIL clock value, to be
2133
2133
  used for Media Overlays.
@@ -2151,7 +2151,7 @@ https://www.w3.org/TR/epub-33/#sec-duration
2151
2151
  > `static` **from**(`pathOrData`): `Promise`\<[`Epub`](#epub)\>
2152
2152
 
2153
2153
  Defined in:
2154
- [epub/index.ts:583](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L583)
2154
+ [epub/index.ts:589](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L589)
2155
2155
 
2156
2156
  Construct an Epub instance by reading an existing EPUB publication.
2157
2157
 
@@ -2170,7 +2170,7 @@ Construct an Epub instance by reading an existing EPUB publication.
2170
2170
  > `static` **getXhtmlBody**(`xml`): [`ParsedXml`](#parsedxml)
2171
2171
 
2172
2172
  Defined in:
2173
- [epub/index.ts:332](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L332)
2173
+ [epub/index.ts:338](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L338)
2174
2174
 
2175
2175
  Given an XML structure representing a complete XHTML document, return the
2176
2176
  sub-structure representing the children of the document's body element.
@@ -2190,7 +2190,7 @@ sub-structure representing the children of the document's body element.
2190
2190
  > `static` **getXhtmlTextContent**(`xml`): `string`
2191
2191
 
2192
2192
  Defined in:
2193
- [epub/index.ts:364](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L364)
2193
+ [epub/index.ts:370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L370)
2194
2194
 
2195
2195
  Given an XML structure representing a complete XHTML document, return a string
2196
2196
  representing the concatenation of all text nodes in the document.
@@ -2210,7 +2210,7 @@ representing the concatenation of all text nodes in the document.
2210
2210
  > `static` **getXmlAttributes**(`element`): `Record`\<`string`, `string`\>
2211
2211
 
2212
2212
  Defined in:
2213
- [epub/index.ts:381](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L381)
2213
+ [epub/index.ts:387](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L387)
2214
2214
 
2215
2215
  Given an XMLElement, return its attributes.
2216
2216
 
@@ -2229,7 +2229,7 @@ Given an XMLElement, return its attributes.
2229
2229
  > `static` **getXmlChildren**\<`Name`\>(`element`): [`ParsedXml`](#parsedxml)
2230
2230
 
2231
2231
  Defined in:
2232
- [epub/index.ts:408](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L408)
2232
+ [epub/index.ts:414](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L414)
2233
2233
 
2234
2234
  Given an XMLElement, return a list of its children
2235
2235
 
@@ -2254,7 +2254,7 @@ Given an XMLElement, return a list of its children
2254
2254
  > `static` **getXmlElementName**\<`Name`\>(`element`): `Name`
2255
2255
 
2256
2256
  Defined in:
2257
- [epub/index.ts:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L393)
2257
+ [epub/index.ts:399](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L399)
2258
2258
 
2259
2259
  Given an XMLElement, return its tag name.
2260
2260
 
@@ -2279,7 +2279,7 @@ Given an XMLElement, return its tag name.
2279
2279
  > `static` **isXmlTextNode**(`node`): `node is XmlTextNode`
2280
2280
 
2281
2281
  Defined in:
2282
- [epub/index.ts:468](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L468)
2282
+ [epub/index.ts:474](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L474)
2283
2283
 
2284
2284
  Given an XMLNode, determine whether it represents a text node or an XML element.
2285
2285
 
@@ -2298,7 +2298,7 @@ Given an XMLNode, determine whether it represents a text node or an XML element.
2298
2298
  > `static` **replaceXmlChildren**\<`Name`\>(`element`, `children`): `void`
2299
2299
 
2300
2300
  Defined in:
2301
- [epub/index.ts:416](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L416)
2301
+ [epub/index.ts:422](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L422)
2302
2302
 
2303
2303
  ##### Type Parameters
2304
2304
 
@@ -2322,7 +2322,7 @@ Defined in:
2322
2322
  > `static` **upgrade**(`path`, `options`): `Promise`\<[`Epub`](#epub)\>
2323
2323
 
2324
2324
  Defined in:
2325
- [epub/index.ts:3022](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3022)
2325
+ [epub/index.ts:3032](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3032)
2326
2326
 
2327
2327
  Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new, valid Epub 3
2328
2328
  instance.
@@ -2354,7 +2354,7 @@ Performs the following transformations:
2354
2354
  ## EpubVersionError
2355
2355
 
2356
2356
  Defined in:
2357
- [epub/index.ts:200](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L200)
2357
+ [epub/index.ts:206](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L206)
2358
2358
 
2359
2359
  ### Extends
2360
2360
 
@@ -2585,7 +2585,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
2585
2585
  ## AlternateScript
2586
2586
 
2587
2587
  Defined in:
2588
- [epub/index.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L110)
2588
+ [epub/index.ts:116](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L116)
2589
2589
 
2590
2590
  ### Properties
2591
2591
 
@@ -2594,21 +2594,21 @@ Defined in:
2594
2594
  > **locale**: `Locale`
2595
2595
 
2596
2596
  Defined in:
2597
- [epub/index.ts:112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L112)
2597
+ [epub/index.ts:118](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L118)
2598
2598
 
2599
2599
  #### name
2600
2600
 
2601
2601
  > **name**: `string`
2602
2602
 
2603
2603
  Defined in:
2604
- [epub/index.ts:111](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L111)
2604
+ [epub/index.ts:117](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L117)
2605
2605
 
2606
2606
  ---
2607
2607
 
2608
2608
  ## Collection
2609
2609
 
2610
2610
  Defined in:
2611
- [epub/index.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L134)
2611
+ [epub/index.ts:140](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L140)
2612
2612
 
2613
2613
  ### Properties
2614
2614
 
@@ -2617,28 +2617,28 @@ Defined in:
2617
2617
  > **name**: `string`
2618
2618
 
2619
2619
  Defined in:
2620
- [epub/index.ts:135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L135)
2620
+ [epub/index.ts:141](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L141)
2621
2621
 
2622
2622
  #### position?
2623
2623
 
2624
2624
  > `optional` **position**: `string`
2625
2625
 
2626
2626
  Defined in:
2627
- [epub/index.ts:137](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L137)
2627
+ [epub/index.ts:143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L143)
2628
2628
 
2629
2629
  #### type?
2630
2630
 
2631
2631
  > `optional` **type**: `string`
2632
2632
 
2633
2633
  Defined in:
2634
- [epub/index.ts:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L136)
2634
+ [epub/index.ts:142](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L142)
2635
2635
 
2636
2636
  ---
2637
2637
 
2638
2638
  ## DcCreator
2639
2639
 
2640
2640
  Defined in:
2641
- [epub/index.ts:115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L115)
2641
+ [epub/index.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L121)
2642
2642
 
2643
2643
  ### Properties
2644
2644
 
@@ -2647,42 +2647,42 @@ Defined in:
2647
2647
  > `optional` **alternateScripts**: [`AlternateScript`](#alternatescript)[]
2648
2648
 
2649
2649
  Defined in:
2650
- [epub/index.ts:120](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L120)
2650
+ [epub/index.ts:126](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L126)
2651
2651
 
2652
2652
  #### fileAs?
2653
2653
 
2654
2654
  > `optional` **fileAs**: `string`
2655
2655
 
2656
2656
  Defined in:
2657
- [epub/index.ts:119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L119)
2657
+ [epub/index.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L125)
2658
2658
 
2659
2659
  #### name
2660
2660
 
2661
2661
  > **name**: `string`
2662
2662
 
2663
2663
  Defined in:
2664
- [epub/index.ts:116](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L116)
2664
+ [epub/index.ts:122](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L122)
2665
2665
 
2666
2666
  #### role?
2667
2667
 
2668
2668
  > `optional` **role**: `string`
2669
2669
 
2670
2670
  Defined in:
2671
- [epub/index.ts:117](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L117)
2671
+ [epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L123)
2672
2672
 
2673
2673
  #### roleScheme?
2674
2674
 
2675
2675
  > `optional` **roleScheme**: `string`
2676
2676
 
2677
2677
  Defined in:
2678
- [epub/index.ts:118](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L118)
2678
+ [epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L124)
2679
2679
 
2680
2680
  ---
2681
2681
 
2682
2682
  ## DcSubject
2683
2683
 
2684
2684
  Defined in:
2685
- [epub/index.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L104)
2685
+ [epub/index.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L110)
2686
2686
 
2687
2687
  ### Properties
2688
2688
 
@@ -2691,28 +2691,28 @@ Defined in:
2691
2691
  > **authority**: `string`
2692
2692
 
2693
2693
  Defined in:
2694
- [epub/index.ts:106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L106)
2694
+ [epub/index.ts:112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L112)
2695
2695
 
2696
2696
  #### term
2697
2697
 
2698
2698
  > **term**: `string`
2699
2699
 
2700
2700
  Defined in:
2701
- [epub/index.ts:107](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L107)
2701
+ [epub/index.ts:113](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L113)
2702
2702
 
2703
2703
  #### value
2704
2704
 
2705
2705
  > **value**: `string`
2706
2706
 
2707
2707
  Defined in:
2708
- [epub/index.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L105)
2708
+ [epub/index.ts:111](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L111)
2709
2709
 
2710
2710
  ---
2711
2711
 
2712
2712
  ## DublinCore
2713
2713
 
2714
2714
  Defined in:
2715
- [epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L123)
2715
+ [epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
2716
2716
 
2717
2717
  ### Properties
2718
2718
 
@@ -2721,56 +2721,56 @@ Defined in:
2721
2721
  > `optional` **contributors**: [`DcCreator`](#dccreator)[]
2722
2722
 
2723
2723
  Defined in:
2724
- [epub/index.ts:130](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L130)
2724
+ [epub/index.ts:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L136)
2725
2725
 
2726
2726
  #### creators?
2727
2727
 
2728
2728
  > `optional` **creators**: [`DcCreator`](#dccreator)[]
2729
2729
 
2730
2730
  Defined in:
2731
- [epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
2731
+ [epub/index.ts:135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L135)
2732
2732
 
2733
2733
  #### date?
2734
2734
 
2735
2735
  > `optional` **date**: `Date`
2736
2736
 
2737
2737
  Defined in:
2738
- [epub/index.ts:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L127)
2738
+ [epub/index.ts:133](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L133)
2739
2739
 
2740
2740
  #### identifier
2741
2741
 
2742
2742
  > **identifier**: `string`
2743
2743
 
2744
2744
  Defined in:
2745
- [epub/index.ts:126](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L126)
2745
+ [epub/index.ts:132](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L132)
2746
2746
 
2747
2747
  #### language
2748
2748
 
2749
2749
  > **language**: `Locale`
2750
2750
 
2751
2751
  Defined in:
2752
- [epub/index.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L125)
2752
+ [epub/index.ts:131](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L131)
2753
2753
 
2754
2754
  #### subjects?
2755
2755
 
2756
2756
  > `optional` **subjects**: (`string` \| [`DcSubject`](#dcsubject))[]
2757
2757
 
2758
2758
  Defined in:
2759
- [epub/index.ts:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L128)
2759
+ [epub/index.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L134)
2760
2760
 
2761
2761
  #### title
2762
2762
 
2763
2763
  > **title**: `string`
2764
2764
 
2765
2765
  Defined in:
2766
- [epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L124)
2766
+ [epub/index.ts:130](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L130)
2767
2767
 
2768
2768
  #### type?
2769
2769
 
2770
2770
  > `optional` **type**: `string`
2771
2771
 
2772
2772
  Defined in:
2773
- [epub/index.ts:131](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L131)
2773
+ [epub/index.ts:137](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L137)
2774
2774
 
2775
2775
  ---
2776
2776
 
@@ -2835,7 +2835,7 @@ Defined in:
2835
2835
  ## Navigation
2836
2836
 
2837
2837
  Defined in:
2838
- [epub/index.ts:148](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L148)
2838
+ [epub/index.ts:154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L154)
2839
2839
 
2840
2840
  ### Properties
2841
2841
 
@@ -2844,21 +2844,21 @@ Defined in:
2844
2844
  > **children**: [`NavigationList`](#navigationlist)
2845
2845
 
2846
2846
  Defined in:
2847
- [epub/index.ts:150](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L150)
2847
+ [epub/index.ts:156](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L156)
2848
2848
 
2849
2849
  #### title?
2850
2850
 
2851
2851
  > `optional` **title**: `string`
2852
2852
 
2853
2853
  Defined in:
2854
- [epub/index.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L149)
2854
+ [epub/index.ts:155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L155)
2855
2855
 
2856
2856
  ---
2857
2857
 
2858
2858
  ## NavigationItem
2859
2859
 
2860
2860
  Defined in:
2861
- [epub/index.ts:140](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L140)
2861
+ [epub/index.ts:146](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L146)
2862
2862
 
2863
2863
  ### Properties
2864
2864
 
@@ -2867,21 +2867,21 @@ Defined in:
2867
2867
  > `optional` **children**: [`NavigationList`](#navigationlist)
2868
2868
 
2869
2869
  Defined in:
2870
- [epub/index.ts:143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L143)
2870
+ [epub/index.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L149)
2871
2871
 
2872
2872
  #### href?
2873
2873
 
2874
2874
  > `optional` **href**: `string`
2875
2875
 
2876
2876
  Defined in:
2877
- [epub/index.ts:142](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L142)
2877
+ [epub/index.ts:148](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L148)
2878
2878
 
2879
2879
  #### title
2880
2880
 
2881
2881
  > **title**: `string`
2882
2882
 
2883
2883
  Defined in:
2884
- [epub/index.ts:141](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L141)
2884
+ [epub/index.ts:147](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L147)
2885
2885
 
2886
2886
  ---
2887
2887
 
@@ -2891,7 +2891,7 @@ Defined in:
2891
2891
  > \`$\{Letter \| Uppercase\<Letter\> \| QuestionMark\}$\{string\}\`
2892
2892
 
2893
2893
  Defined in:
2894
- [epub/index.ts:65](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L65)
2894
+ [epub/index.ts:71](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L71)
2895
2895
 
2896
2896
  A valid name for an XML element (must start with a letter)
2897
2897
 
@@ -2902,7 +2902,7 @@ A valid name for an XML element (must start with a letter)
2902
2902
  > **EpubMetadata** = [`MetadataEntry`](#metadataentry)[]
2903
2903
 
2904
2904
  Defined in:
2905
- [epub/index.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L102)
2905
+ [epub/index.ts:108](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L108)
2906
2906
 
2907
2907
  ---
2908
2908
 
@@ -2911,7 +2911,7 @@ Defined in:
2911
2911
  > **ManifestItem** = `object`
2912
2912
 
2913
2913
  Defined in:
2914
- [epub/index.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L86)
2914
+ [epub/index.ts:92](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L92)
2915
2915
 
2916
2916
  ### Properties
2917
2917
 
@@ -2920,42 +2920,42 @@ Defined in:
2920
2920
  > `optional` **fallback**: `string`
2921
2921
 
2922
2922
  Defined in:
2923
- [epub/index.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L90)
2923
+ [epub/index.ts:96](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L96)
2924
2924
 
2925
2925
  #### href
2926
2926
 
2927
2927
  > **href**: `string`
2928
2928
 
2929
2929
  Defined in:
2930
- [epub/index.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L88)
2930
+ [epub/index.ts:94](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L94)
2931
2931
 
2932
2932
  #### id
2933
2933
 
2934
2934
  > **id**: `string`
2935
2935
 
2936
2936
  Defined in:
2937
- [epub/index.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L87)
2937
+ [epub/index.ts:93](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L93)
2938
2938
 
2939
2939
  #### mediaOverlay?
2940
2940
 
2941
2941
  > `optional` **mediaOverlay**: `string`
2942
2942
 
2943
2943
  Defined in:
2944
- [epub/index.ts:91](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L91)
2944
+ [epub/index.ts:97](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L97)
2945
2945
 
2946
2946
  #### mediaType?
2947
2947
 
2948
2948
  > `optional` **mediaType**: `string`
2949
2949
 
2950
2950
  Defined in:
2951
- [epub/index.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L89)
2951
+ [epub/index.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L95)
2952
2952
 
2953
2953
  #### properties?
2954
2954
 
2955
2955
  > `optional` **properties**: `string`[]
2956
2956
 
2957
2957
  Defined in:
2958
- [epub/index.ts:92](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L92)
2958
+ [epub/index.ts:98](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L98)
2959
2959
 
2960
2960
  ---
2961
2961
 
@@ -2964,7 +2964,7 @@ Defined in:
2964
2964
  > **MetadataEntry** = `object`
2965
2965
 
2966
2966
  Defined in:
2967
- [epub/index.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L95)
2967
+ [epub/index.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L101)
2968
2968
 
2969
2969
  ### Properties
2970
2970
 
@@ -2973,28 +2973,28 @@ Defined in:
2973
2973
  > `optional` **id**: `string`
2974
2974
 
2975
2975
  Defined in:
2976
- [epub/index.ts:96](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L96)
2976
+ [epub/index.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L102)
2977
2977
 
2978
2978
  #### properties
2979
2979
 
2980
2980
  > **properties**: `Record`\<`string`, `string`\>
2981
2981
 
2982
2982
  Defined in:
2983
- [epub/index.ts:98](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L98)
2983
+ [epub/index.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L104)
2984
2984
 
2985
2985
  #### type
2986
2986
 
2987
2987
  > **type**: [`ElementName`](#elementname)
2988
2988
 
2989
2989
  Defined in:
2990
- [epub/index.ts:97](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L97)
2990
+ [epub/index.ts:103](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L103)
2991
2991
 
2992
2992
  #### value
2993
2993
 
2994
2994
  > **value**: `string` \| `undefined`
2995
2995
 
2996
2996
  Defined in:
2997
- [epub/index.ts:99](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L99)
2997
+ [epub/index.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L105)
2998
2998
 
2999
2999
  ---
3000
3000
 
@@ -3003,7 +3003,7 @@ Defined in:
3003
3003
  > **NavigationList** = [`NavigationItem`](#navigationitem)[]
3004
3004
 
3005
3005
  Defined in:
3006
- [epub/index.ts:146](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L146)
3006
+ [epub/index.ts:152](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L152)
3007
3007
 
3008
3008
  ---
3009
3009
 
@@ -3012,7 +3012,7 @@ Defined in:
3012
3012
  > **PackageElement** = [`XmlElement`](#xmlelement)\<`"package"`\>
3013
3013
 
3014
3014
  Defined in:
3015
- [epub/index.ts:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L159)
3015
+ [epub/index.ts:165](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L165)
3016
3016
 
3017
3017
  ---
3018
3018
 
@@ -3021,7 +3021,7 @@ Defined in:
3021
3021
  > **ParsedXml** = [`XmlNode`](#xmlnode)[]
3022
3022
 
3023
3023
  Defined in:
3024
- [epub/index.ts:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L84)
3024
+ [epub/index.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L90)
3025
3025
 
3026
3026
  An XML structure
3027
3027
 
@@ -3032,7 +3032,7 @@ An XML structure
3032
3032
  > **XmlElement**\<`Name`\> = `object` & `{ [key in Name]: ParsedXml }`
3033
3033
 
3034
3034
  Defined in:
3035
- [epub/index.ts:71](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L71)
3035
+ [epub/index.ts:77](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L77)
3036
3036
 
3037
3037
  An XML element
3038
3038
 
@@ -3055,7 +3055,7 @@ An XML element
3055
3055
  > **XmlNode** = [`XmlElement`](#xmlelement) \| [`XmlTextNode`](#xmltextnode)
3056
3056
 
3057
3057
  Defined in:
3058
- [epub/index.ts:81](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L81)
3058
+ [epub/index.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L87)
3059
3059
 
3060
3060
  A valid XML node. May be either an element or a text node.
3061
3061
 
@@ -3066,7 +3066,7 @@ A valid XML node. May be either an element or a text node.
3066
3066
  > **XmlTextNode** = `object`
3067
3067
 
3068
3068
  Defined in:
3069
- [epub/index.ts:78](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L78)
3069
+ [epub/index.ts:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L84)
3070
3070
 
3071
3071
  A text node in an XML document
3072
3072
 
@@ -3077,4 +3077,4 @@ A text node in an XML document
3077
3077
  > **#text**: `string`
3078
3078
 
3079
3079
  Defined in:
3080
- [epub/index.ts:78](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L78)
3080
+ [epub/index.ts:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L84)