@storyteller-platform/epub 0.4.0 → 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +134 -142
  2. package/dist/index.cjs +195 -69
  3. package/dist/index.d.cts +2 -5
  4. package/dist/index.d.ts +2 -5
  5. package/dist/index.js +197 -71
  6. package/package.json +6 -4
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:164](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L164)
223
+ [epub/index.ts:206](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L206)
224
224
 
225
225
  A single EPUB instance.
226
226
 
@@ -259,18 +259,17 @@ https://www.w3.org/TR/epub-33/
259
259
 
260
260
  #### Constructor
261
261
 
262
- > `protected` **new Epub**(`zipFs`, `zipPath`, `inputPath`): [`Epub`](#epub)
262
+ > `protected` **new Epub**(`extractPath`, `inputPath`): [`Epub`](#epub)
263
263
 
264
264
  Defined in:
265
- [epub/index.ts:368](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L368)
265
+ [epub/index.ts:410](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L410)
266
266
 
267
267
  ##### Parameters
268
268
 
269
- | Parameter | Type |
270
- | ----------- | ----------------------- |
271
- | `zipFs` | `ZipFS` |
272
- | `zipPath` | `NativePath` |
273
- | `inputPath` | `undefined` \| `string` |
269
+ | Parameter | Type |
270
+ | ------------- | ----------------------- |
271
+ | `extractPath` | `string` |
272
+ | `inputPath` | `undefined` \| `string` |
274
273
 
275
274
  ##### Returns
276
275
 
@@ -278,54 +277,47 @@ Defined in:
278
277
 
279
278
  ### Properties
280
279
 
281
- #### inputPath
282
-
283
- > `protected` **inputPath**: `undefined` \| `string`
284
-
285
- Defined in:
286
- [epub/index.ts:371](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L371)
287
-
288
- #### zipFs
280
+ #### extractPath
289
281
 
290
- > `protected` **zipFs**: `ZipFS`
282
+ > `protected` **extractPath**: `string`
291
283
 
292
284
  Defined in:
293
- [epub/index.ts:369](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L369)
285
+ [epub/index.ts:411](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L411)
294
286
 
295
- #### zipPath
287
+ #### inputPath
296
288
 
297
- > `protected` **zipPath**: `NativePath`
289
+ > `protected` **inputPath**: `undefined` \| `string`
298
290
 
299
291
  Defined in:
300
- [epub/index.ts:370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L370)
292
+ [epub/index.ts:412](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L412)
301
293
 
302
294
  #### xhtmlBuilder
303
295
 
304
296
  > `static` **xhtmlBuilder**: `XMLBuilder`
305
297
 
306
298
  Defined in:
307
- [epub/index.ts:204](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L204)
299
+ [epub/index.ts:246](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L246)
308
300
 
309
301
  #### xhtmlParser
310
302
 
311
303
  > `static` **xhtmlParser**: `XMLParser`
312
304
 
313
305
  Defined in:
314
- [epub/index.ts:172](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L172)
306
+ [epub/index.ts:214](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L214)
315
307
 
316
308
  #### xmlBuilder
317
309
 
318
310
  > `static` **xmlBuilder**: `XMLBuilder`
319
311
 
320
312
  Defined in:
321
- [epub/index.ts:197](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L197)
313
+ [epub/index.ts:239](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L239)
322
314
 
323
315
  #### xmlParser
324
316
 
325
317
  > `static` **xmlParser**: `XMLParser`
326
318
 
327
319
  Defined in:
328
- [epub/index.ts:165](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L165)
320
+ [epub/index.ts:207](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L207)
329
321
 
330
322
  ### Methods
331
323
 
@@ -334,7 +326,7 @@ Defined in:
334
326
  > **\[dispose\]**(): `void`
335
327
 
336
328
  Defined in:
337
- [epub/index.ts:2445](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2445)
329
+ [epub/index.ts:2537](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2537)
338
330
 
339
331
  ##### Returns
340
332
 
@@ -345,7 +337,7 @@ Defined in:
345
337
  > **addCollection**(`collection`, `index?`): `Promise`\<`void`\>
346
338
 
347
339
  Defined in:
348
- [epub/index.ts:1494](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1494)
340
+ [epub/index.ts:1564](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1564)
349
341
 
350
342
  Add a collection to the EPUB metadata.
351
343
 
@@ -368,7 +360,7 @@ collections. Otherwise, it will be added to the end of the list.
368
360
  > **addContributor**(`contributor`, `index?`): `Promise`\<`void`\>
369
361
 
370
362
  Defined in:
371
- [epub/index.ts:1836](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1836)
363
+ [epub/index.ts:1906](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1906)
372
364
 
373
365
  Add a contributor to the EPUB metadata.
374
366
 
@@ -398,7 +390,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
398
390
  > **addCreator**(`creator`, `index?`, `type?`): `Promise`\<`void`\>
399
391
 
400
392
  Defined in:
401
- [epub/index.ts:1681](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1681)
393
+ [epub/index.ts:1751](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1751)
402
394
 
403
395
  Add a creator to the EPUB metadata.
404
396
 
@@ -428,7 +420,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
428
420
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
429
421
 
430
422
  Defined in:
431
- [epub/index.ts:2163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2163)
423
+ [epub/index.ts:2233](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2233)
432
424
 
433
425
  Create a new manifest item and write its contents to a new entry.
434
426
 
@@ -457,7 +449,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
457
449
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
458
450
 
459
451
  Defined in:
460
- [epub/index.ts:2168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2168)
452
+ [epub/index.ts:2238](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2238)
461
453
 
462
454
  Create a new manifest item and write its contents to a new entry.
463
455
 
@@ -486,7 +478,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
486
478
  > **addManifestItem**(`item`, `contents`): `Promise`\<`void`\>
487
479
 
488
480
  Defined in:
489
- [epub/index.ts:2173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2173)
481
+ [epub/index.ts:2243](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2243)
490
482
 
491
483
  Create a new manifest item and write its contents to a new entry.
492
484
 
@@ -514,7 +506,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
514
506
  > **addMetadata**(`entry`): `Promise`\<`void`\>
515
507
 
516
508
  Defined in:
517
- [epub/index.ts:2285](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2285)
509
+ [epub/index.ts:2355](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2355)
518
510
 
519
511
  Add a new metadata entry to the Epub.
520
512
 
@@ -541,7 +533,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
541
533
  > **addSpineItem**(`manifestId`, `index?`): `Promise`\<`void`\>
542
534
 
543
535
  Defined in:
544
- [epub/index.ts:1890](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1890)
536
+ [epub/index.ts:1960](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1960)
545
537
 
546
538
  Add an item to the spine of the EPUB.
547
539
 
@@ -571,7 +563,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
571
563
  > **addSubject**(`subject`): `Promise`\<`void`\>
572
564
 
573
565
  Defined in:
574
- [epub/index.ts:1027](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1027)
566
+ [epub/index.ts:1093](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1093)
575
567
 
576
568
  Add a subject to the EPUB metadata.
577
569
 
@@ -596,7 +588,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
596
588
  > [`XmlElement`](#xmlelement)\<`"?xml"`\>)[]\>
597
589
 
598
590
  Defined in:
599
- [epub/index.ts:1991](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1991)
591
+ [epub/index.ts:2061](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2061)
600
592
 
601
593
  Create a new XHTML document with the given body and head.
602
594
 
@@ -618,7 +610,7 @@ Create a new XHTML document with the given body and head.
618
610
  > **discardAndClose**(): `void`
619
611
 
620
612
  Defined in:
621
- [epub/index.ts:2394](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2394)
613
+ [epub/index.ts:2464](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2464)
622
614
 
623
615
  ##### Returns
624
616
 
@@ -629,7 +621,7 @@ Defined in:
629
621
  > **findAllMetadataItems**(`predicate`): `Promise`\<`object`[]\>
630
622
 
631
623
  Defined in:
632
- [epub/index.ts:750](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L750)
624
+ [epub/index.ts:816](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L816)
633
625
 
634
626
  Returns the item in the metadata element's children array that matches the
635
627
  provided predicate.
@@ -669,7 +661,7 @@ provided predicate.
669
661
  > \}\>
670
662
 
671
663
  Defined in:
672
- [epub/index.ts:741](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L741)
664
+ [epub/index.ts:807](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L807)
673
665
 
674
666
  Returns the item in the metadata element's children array that matches the
675
667
  provided predicate.
@@ -708,7 +700,7 @@ provided predicate.
708
700
  > **getCollections**(): `Promise`\<[`Collection`](#collection)[]\>
709
701
 
710
702
  Defined in:
711
- [epub/index.ts:1454](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1454)
703
+ [epub/index.ts:1524](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1524)
712
704
 
713
705
  Retrieve the list of collections.
714
706
 
@@ -721,7 +713,7 @@ Retrieve the list of collections.
721
713
  > **getContributors**(): `Promise`\<[`DcCreator`](#dccreator)[]\>
722
714
 
723
715
  Defined in:
724
- [epub/index.ts:1668](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1668)
716
+ [epub/index.ts:1738](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1738)
725
717
 
726
718
  Retrieve the list of contributors.
727
719
 
@@ -740,7 +732,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccontributor
740
732
  > **getCoverImage**(): `Promise`\<`null` \| `Uint8Array`\<`ArrayBufferLike`\>\>
741
733
 
742
734
  Defined in:
743
- [epub/index.ts:930](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L930)
735
+ [epub/index.ts:996](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L996)
744
736
 
745
737
  Retrieve the cover image data as a byte array.
746
738
 
@@ -761,7 +753,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
761
753
  > [`ManifestItem`](#manifestitem)\>
762
754
 
763
755
  Defined in:
764
- [epub/index.ts:911](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L911)
756
+ [epub/index.ts:977](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L977)
765
757
 
766
758
  Retrieve the cover image manifest item.
767
759
 
@@ -781,7 +773,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
781
773
  > **getCreators**(`type`): `Promise`\<[`DcCreator`](#dccreator)[]\>
782
774
 
783
775
  Defined in:
784
- [epub/index.ts:1607](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1607)
776
+ [epub/index.ts:1677](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1677)
785
777
 
786
778
  Retrieve the list of creators.
787
779
 
@@ -804,7 +796,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
804
796
  > **getDescription**(): `Promise`\<`null` \| `string`\>
805
797
 
806
798
  Defined in:
807
- [epub/index.ts:1305](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1305)
799
+ [epub/index.ts:1375](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1375)
808
800
 
809
801
  Retrieve the Epub's description as specified in its package document metadata.
810
802
 
@@ -820,7 +812,7 @@ as a string. Descriptions may include HTML markup.
820
812
  > **getIdentifier**(): `Promise`\<`null` \| `string`\>
821
813
 
822
814
  Defined in:
823
- [epub/index.ts:845](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L845)
815
+ [epub/index.ts:911](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L911)
824
816
 
825
817
  Retrieve the identifier from the dc:identifier element in the EPUB metadata.
826
818
 
@@ -839,7 +831,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
839
831
  > **getLanguage**(): `Promise`\<`null` \| `Locale`\>
840
832
 
841
833
  Defined in:
842
- [epub/index.ts:1146](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1146)
834
+ [epub/index.ts:1212](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1212)
843
835
 
844
836
  Retrieve the Epub's language as specified in its package document metadata.
845
837
 
@@ -860,7 +852,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
860
852
  > [`ManifestItem`](#manifestitem)\>\>
861
853
 
862
854
  Defined in:
863
- [epub/index.ts:666](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L666)
855
+ [epub/index.ts:732](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L732)
864
856
 
865
857
  Retrieve the manifest for the Epub.
866
858
 
@@ -880,7 +872,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
880
872
  > **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
881
873
 
882
874
  Defined in:
883
- [epub/index.ts:817](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L817)
875
+ [epub/index.ts:883](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L883)
884
876
 
885
877
  Retrieve the metadata entries for the Epub.
886
878
 
@@ -904,7 +896,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
904
896
  > `string`\>\>
905
897
 
906
898
  Defined in:
907
- [epub/index.ts:1322](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1322)
899
+ [epub/index.ts:1392](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1392)
908
900
 
909
901
  Return the set of custom vocabulary prefixes set on this publication's root
910
902
  package element.
@@ -924,7 +916,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
924
916
  > **getPublicationDate**(): `Promise`\<`null` \| `Date`\>
925
917
 
926
918
  Defined in:
927
- [epub/index.ts:967](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L967)
919
+ [epub/index.ts:1033](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1033)
928
920
 
929
921
  Retrieve the publication date from the dc:date element in the EPUB metadata as a
930
922
  Date object.
@@ -944,7 +936,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
944
936
  > **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem)[]\>
945
937
 
946
938
  Defined in:
947
- [epub/index.ts:1871](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1871)
939
+ [epub/index.ts:1941](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1941)
948
940
 
949
941
  Retrieve the manifest items that make up the Epub's spine.
950
942
 
@@ -964,7 +956,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
964
956
  > **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
965
957
 
966
958
  Defined in:
967
- [epub/index.ts:1101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1101)
959
+ [epub/index.ts:1167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1167)
968
960
 
969
961
  Retrieve the list of subjects for this EPUB.
970
962
 
@@ -985,7 +977,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
985
977
  > **getSubtitle**(): `Promise`\<`null` \| `string`\>
986
978
 
987
979
  Defined in:
988
- [epub/index.ts:1212](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1212)
980
+ [epub/index.ts:1282](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1282)
989
981
 
990
982
  Retrieve the subtitle of the Epub, if it exists.
991
983
 
@@ -1002,7 +994,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1002
994
  > **getTitle**(`expanded`): `Promise`\<`null` \| `string`\>
1003
995
 
1004
996
  Defined in:
1005
- [epub/index.ts:1188](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1188)
997
+ [epub/index.ts:1258](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1258)
1006
998
 
1007
999
  Retrieve the title of the Epub.
1008
1000
 
@@ -1025,7 +1017,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1025
1017
  > **getTitles**(): `Promise`\<`object`[]\>
1026
1018
 
1027
1019
  Defined in:
1028
- [epub/index.ts:1224](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1224)
1020
+ [epub/index.ts:1294](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1294)
1029
1021
 
1030
1022
  Retrieve all title entries of the Epub.
1031
1023
 
@@ -1042,7 +1034,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1042
1034
  > **getType**(): `Promise`\<`null` \| [`MetadataEntry`](#metadataentry)\>
1043
1035
 
1044
1036
  Defined in:
1045
- [epub/index.ts:1014](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1014)
1037
+ [epub/index.ts:1080](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1080)
1046
1038
 
1047
1039
  Retrieve the publication type from the dc:type element in the EPUB metadata.
1048
1040
 
@@ -1063,7 +1055,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1063
1055
  > **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1064
1056
 
1065
1057
  Defined in:
1066
- [epub/index.ts:1963](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1963)
1058
+ [epub/index.ts:2033](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2033)
1067
1059
 
1068
1060
  Retrieve the contents of a manifest item, given its id.
1069
1061
 
@@ -1086,7 +1078,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1086
1078
  > **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
1087
1079
 
1088
1080
  Defined in:
1089
- [epub/index.ts:1964](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1964)
1081
+ [epub/index.ts:2034](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2034)
1090
1082
 
1091
1083
  Retrieve the contents of a manifest item, given its id.
1092
1084
 
@@ -1112,7 +1104,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1112
1104
  > **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`ParsedXml`](#parsedxml)\>
1113
1105
 
1114
1106
  Defined in:
1115
- [epub/index.ts:2024](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2024)
1107
+ [epub/index.ts:2094](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2094)
1116
1108
 
1117
1109
  Retrieves the contents of an XHTML item, given its manifest id.
1118
1110
 
@@ -1136,7 +1128,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1136
1128
  > **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
1137
1129
 
1138
1130
  Defined in:
1139
- [epub/index.ts:2025](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2025)
1131
+ [epub/index.ts:2095](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2095)
1140
1132
 
1141
1133
  Retrieves the contents of an XHTML item, given its manifest id.
1142
1134
 
@@ -1160,7 +1152,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1160
1152
  > **removeCollection**(`index`): `Promise`\<`void`\>
1161
1153
 
1162
1154
  Defined in:
1163
- [epub/index.ts:1563](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1563)
1155
+ [epub/index.ts:1633](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1633)
1164
1156
 
1165
1157
  Remove a collection from the EPUB metadata.
1166
1158
 
@@ -1182,7 +1174,7 @@ returned by `epub.getCollections()`.
1182
1174
  > **removeContributor**(`index`): `Promise`\<`void`\>
1183
1175
 
1184
1176
  Defined in:
1185
- [epub/index.ts:1820](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1820)
1177
+ [epub/index.ts:1890](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1890)
1186
1178
 
1187
1179
  Remove a contributor from the EPUB metadata.
1188
1180
 
@@ -1210,7 +1202,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1210
1202
  > **removeCreator**(`index`, `type`): `Promise`\<`void`\>
1211
1203
 
1212
1204
  Defined in:
1213
- [epub/index.ts:1768](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1768)
1205
+ [epub/index.ts:1838](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1838)
1214
1206
 
1215
1207
  Remove a creator from the EPUB metadata.
1216
1208
 
@@ -1237,7 +1229,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1237
1229
  > **removeManifestItem**(`id`): `Promise`\<`void`\>
1238
1230
 
1239
1231
  Defined in:
1240
- [epub/index.ts:2120](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2120)
1232
+ [epub/index.ts:2190](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2190)
1241
1233
 
1242
1234
  ##### Parameters
1243
1235
 
@@ -1254,7 +1246,7 @@ Defined in:
1254
1246
  > **removeMetadata**(`predicate`): `Promise`\<`void`\>
1255
1247
 
1256
1248
  Defined in:
1257
- [epub/index.ts:2369](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2369)
1249
+ [epub/index.ts:2439](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2439)
1258
1250
 
1259
1251
  Remove one or more metadata entries.
1260
1252
 
@@ -1280,7 +1272,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1280
1272
  > **removeSpineItem**(`index`): `Promise`\<`void`\>
1281
1273
 
1282
1274
  Defined in:
1283
- [epub/index.ts:1926](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1926)
1275
+ [epub/index.ts:1996](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1996)
1284
1276
 
1285
1277
  Remove the spine item at the specified index.
1286
1278
 
@@ -1303,7 +1295,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1303
1295
  > **removeSubject**(`index`): `Promise`\<`void`\>
1304
1296
 
1305
1297
  Defined in:
1306
- [epub/index.ts:1064](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1064)
1298
+ [epub/index.ts:1130](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1130)
1307
1299
 
1308
1300
  Remove a subject from the EPUB metadata.
1309
1301
 
@@ -1329,7 +1321,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1329
1321
  > **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
1330
1322
 
1331
1323
  Defined in:
1332
- [epub/index.ts:2324](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2324)
1324
+ [epub/index.ts:2394](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2394)
1333
1325
 
1334
1326
  Replace a metadata entry with a new one.
1335
1327
 
@@ -1356,7 +1348,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1356
1348
  > **saveAndClose**(): `Promise`\<`void`\>
1357
1349
 
1358
1350
  Defined in:
1359
- [epub/index.ts:2411](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2411)
1351
+ [epub/index.ts:2480](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2480)
1360
1352
 
1361
1353
  Write the current contents of the Epub to a new EPUB archive on disk.
1362
1354
 
@@ -1372,7 +1364,7 @@ updated to the current UTC timestamp.
1372
1364
  > **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
1373
1365
 
1374
1366
  Defined in:
1375
- [epub/index.ts:944](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L944)
1367
+ [epub/index.ts:1010](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1010)
1376
1368
 
1377
1369
  Set the cover image for the EPUB.
1378
1370
 
@@ -1395,7 +1387,7 @@ then writes the provided image data to the provided href within the publication.
1395
1387
  > **setDescription**(`description`): `Promise`\<`void`\>
1396
1388
 
1397
1389
  Defined in:
1398
- [epub/index.ts:1289](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1289)
1390
+ [epub/index.ts:1359](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1359)
1399
1391
 
1400
1392
  Update the Epub's description metadata entry.
1401
1393
 
@@ -1418,7 +1410,7 @@ encoded as HTML entities.
1418
1410
  > **setIdentifier**(`identifier`): `Promise`\<`void`\>
1419
1411
 
1420
1412
  Defined in:
1421
- [epub/index.ts:859](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L859)
1413
+ [epub/index.ts:925](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L925)
1422
1414
 
1423
1415
  Set the dc:identifier metadata element with the provided string.
1424
1416
 
@@ -1444,7 +1436,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1444
1436
  > **setLanguage**(`locale`): `Promise`\<`void`\>
1445
1437
 
1446
1438
  Defined in:
1447
- [epub/index.ts:1171](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1171)
1439
+ [epub/index.ts:1241](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1241)
1448
1440
 
1449
1441
  Update the Epub's language metadata entry.
1450
1442
 
@@ -1470,7 +1462,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1470
1462
  > **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
1471
1463
 
1472
1464
  Defined in:
1473
- [epub/index.ts:1340](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1340)
1465
+ [epub/index.ts:1410](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1410)
1474
1466
 
1475
1467
  Set a custom vocabulary prefix on the root package element.
1476
1468
 
@@ -1494,7 +1486,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1494
1486
  > **setPublicationDate**(`date`): `Promise`\<`void`\>
1495
1487
 
1496
1488
  Defined in:
1497
- [epub/index.ts:982](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L982)
1489
+ [epub/index.ts:1048](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1048)
1498
1490
 
1499
1491
  Set the dc:date metadata element with the provided date.
1500
1492
 
@@ -1520,7 +1512,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1520
1512
  > **setTitle**(`title`): `Promise`\<`void`\>
1521
1513
 
1522
1514
  Defined in:
1523
- [epub/index.ts:1364](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1364)
1515
+ [epub/index.ts:1434](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1434)
1524
1516
 
1525
1517
  Set the title of the Epub.
1526
1518
 
@@ -1548,7 +1540,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1548
1540
  > **setTitles**(`entries`): `Promise`\<`void`\>
1549
1541
 
1550
1542
  Defined in:
1551
- [epub/index.ts:1392](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1392)
1543
+ [epub/index.ts:1462](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1462)
1552
1544
 
1553
1545
  ##### Parameters
1554
1546
 
@@ -1565,7 +1557,7 @@ Defined in:
1565
1557
  > **setType**(`type`): `Promise`\<`void`\>
1566
1558
 
1567
1559
  Defined in:
1568
- [epub/index.ts:998](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L998)
1560
+ [epub/index.ts:1064](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1064)
1569
1561
 
1570
1562
  Set the dc:type metadata element.
1571
1563
 
@@ -1591,7 +1583,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1591
1583
  > **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
1592
1584
 
1593
1585
  Defined in:
1594
- [epub/index.ts:2236](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2236)
1586
+ [epub/index.ts:2306](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2306)
1595
1587
 
1596
1588
  Update the manifest entry for an existing item.
1597
1589
 
@@ -1620,7 +1612,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
1620
1612
  > **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
1621
1613
 
1622
1614
  Defined in:
1623
- [epub/index.ts:2072](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2072)
1615
+ [epub/index.ts:2142](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2142)
1624
1616
 
1625
1617
  Write new contents for an existing manifest item, specified by its id.
1626
1618
 
@@ -1647,7 +1639,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1647
1639
  > **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
1648
1640
 
1649
1641
  Defined in:
1650
- [epub/index.ts:2073](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2073)
1642
+ [epub/index.ts:2143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2143)
1651
1643
 
1652
1644
  Write new contents for an existing manifest item, specified by its id.
1653
1645
 
@@ -1675,7 +1667,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1675
1667
  > **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
1676
1668
 
1677
1669
  Defined in:
1678
- [epub/index.ts:2112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2112)
1670
+ [epub/index.ts:2182](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2182)
1679
1671
 
1680
1672
  Write new contents for an existing XHTML item, specified by its id.
1681
1673
 
@@ -1702,7 +1694,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1702
1694
  > `static` **addLinkToXhtmlHead**(`xml`, `link`): `void`
1703
1695
 
1704
1696
  Defined in:
1705
- [epub/index.ts:234](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L234)
1697
+ [epub/index.ts:276](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L276)
1706
1698
 
1707
1699
  Given an XML structure representing a complete XHTML document, add a `link`
1708
1700
  element to the `head` of the document.
@@ -1729,7 +1721,7 @@ This method modifies the provided XML structure.
1729
1721
  > `Promise`\<[`Epub`](#epub)\>
1730
1722
 
1731
1723
  Defined in:
1732
- [epub/index.ts:389](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L389)
1724
+ [epub/index.ts:430](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L430)
1733
1725
 
1734
1726
  Construct an Epub instance, optionally beginning with the provided metadata.
1735
1727
 
@@ -1751,7 +1743,7 @@ Construct an Epub instance, optionally beginning with the provided metadata.
1751
1743
  > [`XmlElement`](#xmlelement)\<`Name`\>
1752
1744
 
1753
1745
  Defined in:
1754
- [epub/index.ts:269](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L269)
1746
+ [epub/index.ts:311](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L311)
1755
1747
 
1756
1748
  ##### Type Parameters
1757
1749
 
@@ -1776,7 +1768,7 @@ Defined in:
1776
1768
  > `static` **createXmlTextNode**(`text`): [`XmlTextNode`](#xmltextnode)
1777
1769
 
1778
1770
  Defined in:
1779
- [epub/index.ts:282](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L282)
1771
+ [epub/index.ts:324](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L324)
1780
1772
 
1781
1773
  ##### Parameters
1782
1774
 
@@ -1794,7 +1786,7 @@ Defined in:
1794
1786
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
1795
1787
 
1796
1788
  Defined in:
1797
- [epub/index.ts:343](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L343)
1789
+ [epub/index.ts:385](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L385)
1798
1790
 
1799
1791
  Given an XML structure, find the first child matching the provided name and
1800
1792
  optional filter.
@@ -1822,7 +1814,7 @@ optional filter.
1822
1814
  > `static` **formatSmilDuration**(`duration`): `string`
1823
1815
 
1824
1816
  Defined in:
1825
- [epub/index.ts:217](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L217)
1817
+ [epub/index.ts:259](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L259)
1826
1818
 
1827
1819
  Format a duration, provided as a number of seconds, as a SMIL clock value, to be
1828
1820
  used for Media Overlays.
@@ -1846,7 +1838,7 @@ https://www.w3.org/TR/epub-33/#sec-duration
1846
1838
  > `static` **from**(`pathOrData`): `Promise`\<[`Epub`](#epub)\>
1847
1839
 
1848
1840
  Defined in:
1849
- [epub/index.ts:480](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L480)
1841
+ [epub/index.ts:514](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L514)
1850
1842
 
1851
1843
  Construct an Epub instance by reading an existing EPUB publication.
1852
1844
 
@@ -1865,7 +1857,7 @@ Construct an Epub instance by reading an existing EPUB publication.
1865
1857
  > `static` **getXhtmlBody**(`xml`): [`ParsedXml`](#parsedxml)
1866
1858
 
1867
1859
  Defined in:
1868
- [epub/index.ts:259](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L259)
1860
+ [epub/index.ts:301](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L301)
1869
1861
 
1870
1862
  Given an XML structure representing a complete XHTML document, return the
1871
1863
  sub-structure representing the children of the document's body element.
@@ -1885,7 +1877,7 @@ sub-structure representing the children of the document's body element.
1885
1877
  > `static` **getXhtmlTextContent**(`xml`): `string`
1886
1878
 
1887
1879
  Defined in:
1888
- [epub/index.ts:291](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L291)
1880
+ [epub/index.ts:333](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L333)
1889
1881
 
1890
1882
  Given an XML structure representing a complete XHTML document, return a string
1891
1883
  representing the concatenation of all text nodes in the document.
@@ -1905,7 +1897,7 @@ representing the concatenation of all text nodes in the document.
1905
1897
  > `static` **getXmlChildren**\<`Name`\>(`element`): [`ParsedXml`](#parsedxml)
1906
1898
 
1907
1899
  Defined in:
1908
- [epub/index.ts:323](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L323)
1900
+ [epub/index.ts:365](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L365)
1909
1901
 
1910
1902
  Given an XMLElement, return a list of its children
1911
1903
 
@@ -1930,7 +1922,7 @@ Given an XMLElement, return a list of its children
1930
1922
  > `static` **getXmlElementName**\<`Name`\>(`element`): `Name`
1931
1923
 
1932
1924
  Defined in:
1933
- [epub/index.ts:308](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L308)
1925
+ [epub/index.ts:350](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L350)
1934
1926
 
1935
1927
  Given an XMLElement, return its tag name.
1936
1928
 
@@ -1955,7 +1947,7 @@ Given an XMLElement, return its tag name.
1955
1947
  > `static` **isXmlTextNode**(`node`): `node is XmlTextNode`
1956
1948
 
1957
1949
  Defined in:
1958
- [epub/index.ts:356](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L356)
1950
+ [epub/index.ts:398](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L398)
1959
1951
 
1960
1952
  Given an XMLNode, determine whether it represents a text node or an XML element.
1961
1953
 
@@ -1974,7 +1966,7 @@ Given an XMLNode, determine whether it represents a text node or an XML element.
1974
1966
  > `static` **replaceXmlChildren**\<`Name`\>(`element`, `children`): `void`
1975
1967
 
1976
1968
  Defined in:
1977
- [epub/index.ts:331](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L331)
1969
+ [epub/index.ts:373](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L373)
1978
1970
 
1979
1971
  ##### Type Parameters
1980
1972
 
@@ -1998,7 +1990,7 @@ Defined in:
1998
1990
  ## AlternateScript
1999
1991
 
2000
1992
  Defined in:
2001
- [epub/index.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L105)
1993
+ [epub/index.ts:147](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L147)
2002
1994
 
2003
1995
  ### Properties
2004
1996
 
@@ -2007,21 +1999,21 @@ Defined in:
2007
1999
  > **locale**: `Locale`
2008
2000
 
2009
2001
  Defined in:
2010
- [epub/index.ts:107](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L107)
2002
+ [epub/index.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L149)
2011
2003
 
2012
2004
  #### name
2013
2005
 
2014
2006
  > **name**: `string`
2015
2007
 
2016
2008
  Defined in:
2017
- [epub/index.ts:106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L106)
2009
+ [epub/index.ts:148](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L148)
2018
2010
 
2019
2011
  ---
2020
2012
 
2021
2013
  ## Collection
2022
2014
 
2023
2015
  Defined in:
2024
- [epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
2016
+ [epub/index.ts:171](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L171)
2025
2017
 
2026
2018
  ### Properties
2027
2019
 
@@ -2030,28 +2022,28 @@ Defined in:
2030
2022
  > **name**: `string`
2031
2023
 
2032
2024
  Defined in:
2033
- [epub/index.ts:130](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L130)
2025
+ [epub/index.ts:172](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L172)
2034
2026
 
2035
2027
  #### position?
2036
2028
 
2037
2029
  > `optional` **position**: `string`
2038
2030
 
2039
2031
  Defined in:
2040
- [epub/index.ts:132](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L132)
2032
+ [epub/index.ts:174](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L174)
2041
2033
 
2042
2034
  #### type?
2043
2035
 
2044
2036
  > `optional` **type**: `string`
2045
2037
 
2046
2038
  Defined in:
2047
- [epub/index.ts:131](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L131)
2039
+ [epub/index.ts:173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L173)
2048
2040
 
2049
2041
  ---
2050
2042
 
2051
2043
  ## DcCreator
2052
2044
 
2053
2045
  Defined in:
2054
- [epub/index.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L110)
2046
+ [epub/index.ts:152](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L152)
2055
2047
 
2056
2048
  ### Properties
2057
2049
 
@@ -2060,42 +2052,42 @@ Defined in:
2060
2052
  > `optional` **alternateScripts**: [`AlternateScript`](#alternatescript)[]
2061
2053
 
2062
2054
  Defined in:
2063
- [epub/index.ts:115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L115)
2055
+ [epub/index.ts:157](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L157)
2064
2056
 
2065
2057
  #### fileAs?
2066
2058
 
2067
2059
  > `optional` **fileAs**: `string`
2068
2060
 
2069
2061
  Defined in:
2070
- [epub/index.ts:114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L114)
2062
+ [epub/index.ts:156](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L156)
2071
2063
 
2072
2064
  #### name
2073
2065
 
2074
2066
  > **name**: `string`
2075
2067
 
2076
2068
  Defined in:
2077
- [epub/index.ts:111](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L111)
2069
+ [epub/index.ts:153](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L153)
2078
2070
 
2079
2071
  #### role?
2080
2072
 
2081
2073
  > `optional` **role**: `string`
2082
2074
 
2083
2075
  Defined in:
2084
- [epub/index.ts:112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L112)
2076
+ [epub/index.ts:154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L154)
2085
2077
 
2086
2078
  #### roleScheme?
2087
2079
 
2088
2080
  > `optional` **roleScheme**: `string`
2089
2081
 
2090
2082
  Defined in:
2091
- [epub/index.ts:113](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L113)
2083
+ [epub/index.ts:155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L155)
2092
2084
 
2093
2085
  ---
2094
2086
 
2095
2087
  ## DcSubject
2096
2088
 
2097
2089
  Defined in:
2098
- [epub/index.ts:99](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L99)
2090
+ [epub/index.ts:141](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L141)
2099
2091
 
2100
2092
  ### Properties
2101
2093
 
@@ -2104,28 +2096,28 @@ Defined in:
2104
2096
  > **authority**: `string`
2105
2097
 
2106
2098
  Defined in:
2107
- [epub/index.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L101)
2099
+ [epub/index.ts:143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L143)
2108
2100
 
2109
2101
  #### term
2110
2102
 
2111
2103
  > **term**: `string`
2112
2104
 
2113
2105
  Defined in:
2114
- [epub/index.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L102)
2106
+ [epub/index.ts:144](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L144)
2115
2107
 
2116
2108
  #### value
2117
2109
 
2118
2110
  > **value**: `string`
2119
2111
 
2120
2112
  Defined in:
2121
- [epub/index.ts:100](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L100)
2113
+ [epub/index.ts:142](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L142)
2122
2114
 
2123
2115
  ---
2124
2116
 
2125
2117
  ## DublinCore
2126
2118
 
2127
2119
  Defined in:
2128
- [epub/index.ts:118](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L118)
2120
+ [epub/index.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L160)
2129
2121
 
2130
2122
  ### Properties
2131
2123
 
@@ -2134,56 +2126,56 @@ Defined in:
2134
2126
  > `optional` **contributors**: [`DcCreator`](#dccreator)[]
2135
2127
 
2136
2128
  Defined in:
2137
- [epub/index.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L125)
2129
+ [epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L167)
2138
2130
 
2139
2131
  #### creators?
2140
2132
 
2141
2133
  > `optional` **creators**: [`DcCreator`](#dccreator)[]
2142
2134
 
2143
2135
  Defined in:
2144
- [epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L124)
2136
+ [epub/index.ts:166](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L166)
2145
2137
 
2146
2138
  #### date?
2147
2139
 
2148
2140
  > `optional` **date**: `Date`
2149
2141
 
2150
2142
  Defined in:
2151
- [epub/index.ts:122](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L122)
2143
+ [epub/index.ts:164](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L164)
2152
2144
 
2153
2145
  #### identifier
2154
2146
 
2155
2147
  > **identifier**: `string`
2156
2148
 
2157
2149
  Defined in:
2158
- [epub/index.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L121)
2150
+ [epub/index.ts:163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L163)
2159
2151
 
2160
2152
  #### language
2161
2153
 
2162
2154
  > **language**: `Locale`
2163
2155
 
2164
2156
  Defined in:
2165
- [epub/index.ts:120](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L120)
2157
+ [epub/index.ts:162](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L162)
2166
2158
 
2167
2159
  #### subjects?
2168
2160
 
2169
2161
  > `optional` **subjects**: (`string` \| [`DcSubject`](#dcsubject))[]
2170
2162
 
2171
2163
  Defined in:
2172
- [epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L123)
2164
+ [epub/index.ts:165](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L165)
2173
2165
 
2174
2166
  #### title
2175
2167
 
2176
2168
  > **title**: `string`
2177
2169
 
2178
2170
  Defined in:
2179
- [epub/index.ts:119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L119)
2171
+ [epub/index.ts:161](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L161)
2180
2172
 
2181
2173
  #### type?
2182
2174
 
2183
2175
  > `optional` **type**: `string`
2184
2176
 
2185
2177
  Defined in:
2186
- [epub/index.ts:126](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L126)
2178
+ [epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L168)
2187
2179
 
2188
2180
  ---
2189
2181
 
@@ -2193,7 +2185,7 @@ Defined in:
2193
2185
  > \`$\{Letter \| Uppercase\<Letter\> \| QuestionMark\}$\{string\}\`
2194
2186
 
2195
2187
  Defined in:
2196
- [epub/index.ts:60](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L60)
2188
+ [epub/index.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L102)
2197
2189
 
2198
2190
  A valid name for an XML element (must start with a letter)
2199
2191
 
@@ -2204,7 +2196,7 @@ A valid name for an XML element (must start with a letter)
2204
2196
  > **EpubMetadata** = [`MetadataEntry`](#metadataentry)[]
2205
2197
 
2206
2198
  Defined in:
2207
- [epub/index.ts:97](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L97)
2199
+ [epub/index.ts:139](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L139)
2208
2200
 
2209
2201
  ---
2210
2202
 
@@ -2213,7 +2205,7 @@ Defined in:
2213
2205
  > **ManifestItem** = `object`
2214
2206
 
2215
2207
  Defined in:
2216
- [epub/index.ts:81](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L81)
2208
+ [epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L123)
2217
2209
 
2218
2210
  ### Properties
2219
2211
 
@@ -2222,42 +2214,42 @@ Defined in:
2222
2214
  > `optional` **fallback**: `string`
2223
2215
 
2224
2216
  Defined in:
2225
- [epub/index.ts:85](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L85)
2217
+ [epub/index.ts:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L127)
2226
2218
 
2227
2219
  #### href
2228
2220
 
2229
2221
  > **href**: `string`
2230
2222
 
2231
2223
  Defined in:
2232
- [epub/index.ts:83](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L83)
2224
+ [epub/index.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L125)
2233
2225
 
2234
2226
  #### id
2235
2227
 
2236
2228
  > **id**: `string`
2237
2229
 
2238
2230
  Defined in:
2239
- [epub/index.ts:82](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L82)
2231
+ [epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L124)
2240
2232
 
2241
2233
  #### mediaOverlay?
2242
2234
 
2243
2235
  > `optional` **mediaOverlay**: `string`
2244
2236
 
2245
2237
  Defined in:
2246
- [epub/index.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L86)
2238
+ [epub/index.ts:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L128)
2247
2239
 
2248
2240
  #### mediaType?
2249
2241
 
2250
2242
  > `optional` **mediaType**: `string`
2251
2243
 
2252
2244
  Defined in:
2253
- [epub/index.ts:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L84)
2245
+ [epub/index.ts:126](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L126)
2254
2246
 
2255
2247
  #### properties?
2256
2248
 
2257
2249
  > `optional` **properties**: `string`[]
2258
2250
 
2259
2251
  Defined in:
2260
- [epub/index.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L87)
2252
+ [epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
2261
2253
 
2262
2254
  ---
2263
2255
 
@@ -2266,7 +2258,7 @@ Defined in:
2266
2258
  > **MetadataEntry** = `object`
2267
2259
 
2268
2260
  Defined in:
2269
- [epub/index.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L90)
2261
+ [epub/index.ts:132](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L132)
2270
2262
 
2271
2263
  ### Properties
2272
2264
 
@@ -2275,28 +2267,28 @@ Defined in:
2275
2267
  > `optional` **id**: `string`
2276
2268
 
2277
2269
  Defined in:
2278
- [epub/index.ts:91](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L91)
2270
+ [epub/index.ts:133](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L133)
2279
2271
 
2280
2272
  #### properties
2281
2273
 
2282
2274
  > **properties**: `Record`\<`string`, `string`\>
2283
2275
 
2284
2276
  Defined in:
2285
- [epub/index.ts:93](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L93)
2277
+ [epub/index.ts:135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L135)
2286
2278
 
2287
2279
  #### type
2288
2280
 
2289
2281
  > **type**: [`ElementName`](#elementname)
2290
2282
 
2291
2283
  Defined in:
2292
- [epub/index.ts:92](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L92)
2284
+ [epub/index.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L134)
2293
2285
 
2294
2286
  #### value
2295
2287
 
2296
2288
  > **value**: `string` \| `undefined`
2297
2289
 
2298
2290
  Defined in:
2299
- [epub/index.ts:94](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L94)
2291
+ [epub/index.ts:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L136)
2300
2292
 
2301
2293
  ---
2302
2294
 
@@ -2306,7 +2298,7 @@ Defined in:
2306
2298
  > [`XmlElement`](#xmlelement)\<`"opf:package"`\>
2307
2299
 
2308
2300
  Defined in:
2309
- [epub/index.ts:135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L135)
2301
+ [epub/index.ts:177](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L177)
2310
2302
 
2311
2303
  ---
2312
2304
 
@@ -2315,7 +2307,7 @@ Defined in:
2315
2307
  > **ParsedXml** = [`XmlNode`](#xmlnode)[]
2316
2308
 
2317
2309
  Defined in:
2318
- [epub/index.ts:79](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L79)
2310
+ [epub/index.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L121)
2319
2311
 
2320
2312
  An XML structure
2321
2313
 
@@ -2326,7 +2318,7 @@ An XML structure
2326
2318
  > **XmlElement**\<`Name`\> = `object` & `{ [key in Name]: ParsedXml }`
2327
2319
 
2328
2320
  Defined in:
2329
- [epub/index.ts:66](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L66)
2321
+ [epub/index.ts:108](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L108)
2330
2322
 
2331
2323
  An XML element
2332
2324
 
@@ -2349,7 +2341,7 @@ An XML element
2349
2341
  > **XmlNode** = [`XmlElement`](#xmlelement) \| [`XmlTextNode`](#xmltextnode)
2350
2342
 
2351
2343
  Defined in:
2352
- [epub/index.ts:76](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L76)
2344
+ [epub/index.ts:118](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L118)
2353
2345
 
2354
2346
  A valid XML node. May be either an element or a text node.
2355
2347
 
@@ -2360,7 +2352,7 @@ A valid XML node. May be either an element or a text node.
2360
2352
  > **XmlTextNode** = `object`
2361
2353
 
2362
2354
  Defined in:
2363
- [epub/index.ts:73](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L73)
2355
+ [epub/index.ts:115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L115)
2364
2356
 
2365
2357
  A text node in an XML document
2366
2358
 
@@ -2371,4 +2363,4 @@ A text node in an XML document
2371
2363
  > **#text**: `string`
2372
2364
 
2373
2365
  Defined in:
2374
- [epub/index.ts:73](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L73)
2366
+ [epub/index.ts:115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L115)