@storyteller-platform/epub 0.6.2 → 0.7.0

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 (14) hide show
  1. package/README.md +919 -224
  2. package/dist/adapters/tmpfs.cjs +2 -1
  3. package/dist/adapters/tmpfs.js +2 -1
  4. package/dist/epubcheck.cjs +60 -0
  5. package/dist/epubcheck.d.cts +23 -0
  6. package/dist/epubcheck.d.ts +23 -0
  7. package/dist/epubcheck.js +36 -0
  8. package/dist/index.cjs +404 -3
  9. package/dist/index.d.cts +1 -1
  10. package/dist/index.d.ts +1 -1
  11. package/dist/index.js +404 -3
  12. package/dist/upgrade.d.cts +155 -5
  13. package/dist/upgrade.d.ts +155 -5
  14. package/package.json +4 -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:267](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L267)
223
+ [libraries/epub/index.ts:267](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L267)
224
224
 
225
225
  A single EPUB instance.
226
226
 
@@ -263,7 +263,7 @@ https://www.w3.org/TR/epub-33/
263
263
  > [`Epub`](#epub)
264
264
 
265
265
  Defined in:
266
- [epub/index.ts:533](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L533)
266
+ [libraries/epub/index.ts:533](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L533)
267
267
 
268
268
  Prefer the static factories ([Epub.using](#using), [Epub.from](#from),
269
269
  [Epub.create](#create), [Epub.upgrade](#upgrade)) over calling this constructor
@@ -290,7 +290,7 @@ nothing else should need to.
290
290
  > `protected` **adapter**: [`EpubStorageAdapter`](#epubstorageadapter)
291
291
 
292
292
  Defined in:
293
- [epub/index.ts:535](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L535)
293
+ [libraries/epub/index.ts:535](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L535)
294
294
 
295
295
  #### adapterClass
296
296
 
@@ -298,28 +298,28 @@ Defined in:
298
298
  > [`EpubStorageAdapterClass`](#epubstorageadapterclass)
299
299
 
300
300
  Defined in:
301
- [epub/index.ts:534](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L534)
301
+ [libraries/epub/index.ts:534](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L534)
302
302
 
303
303
  #### inputPath
304
304
 
305
305
  > `protected` **inputPath**: `undefined` \| `string`
306
306
 
307
307
  Defined in:
308
- [epub/index.ts:536](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L536)
308
+ [libraries/epub/index.ts:536](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L536)
309
309
 
310
310
  #### readonlyOverride
311
311
 
312
312
  > `protected` **readonlyOverride**: `boolean` = `false`
313
313
 
314
314
  Defined in:
315
- [epub/index.ts:537](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L537)
315
+ [libraries/epub/index.ts:537](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L537)
316
316
 
317
317
  #### storage
318
318
 
319
319
  > `readonly` **storage**: [`EpubStorageKind`](#epubstoragekind)
320
320
 
321
321
  Defined in:
322
- [epub/index.ts:525](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L525)
322
+ [libraries/epub/index.ts:525](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L525)
323
323
 
324
324
  Storage backend kind in use for this instance
325
325
 
@@ -332,28 +332,28 @@ axis (controlled by `readonlyOverride` and the adapter's capability bag)
332
332
  > `static` **xhtmlBuilder**: `XMLBuilder`
333
333
 
334
334
  Defined in:
335
- [epub/index.ts:315](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L315)
335
+ [libraries/epub/index.ts:315](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L315)
336
336
 
337
337
  #### xhtmlParser
338
338
 
339
339
  > `static` **xhtmlParser**: `XMLParser`
340
340
 
341
341
  Defined in:
342
- [epub/index.ts:275](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L275)
342
+ [libraries/epub/index.ts:275](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L275)
343
343
 
344
344
  #### xmlBuilder
345
345
 
346
346
  > `static` **xmlBuilder**: `XMLBuilder`
347
347
 
348
348
  Defined in:
349
- [epub/index.ts:308](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L308)
349
+ [libraries/epub/index.ts:308](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L308)
350
350
 
351
351
  #### xmlParser
352
352
 
353
353
  > `static` **xmlParser**: `XMLParser`
354
354
 
355
355
  Defined in:
356
- [epub/index.ts:268](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L268)
356
+ [libraries/epub/index.ts:268](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L268)
357
357
 
358
358
  ### Methods
359
359
 
@@ -362,7 +362,7 @@ Defined in:
362
362
  > **\[dispose\]**(): `void`
363
363
 
364
364
  Defined in:
365
- [epub/index.ts:2995](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2995)
365
+ [libraries/epub/index.ts:3461](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3461)
366
366
 
367
367
  ##### Returns
368
368
 
@@ -373,7 +373,7 @@ Defined in:
373
373
  > **addCollection**(`collection`, `index?`): `Promise`\<`void`\>
374
374
 
375
375
  Defined in:
376
- [epub/index.ts:1696](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1696)
376
+ [libraries/epub/index.ts:2159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2159)
377
377
 
378
378
  Add a collection to the EPUB metadata.
379
379
 
@@ -396,7 +396,7 @@ collections. Otherwise, it will be added to the end of the list.
396
396
  > **addContributor**(`contributor`, `index?`): `Promise`\<`void`\>
397
397
 
398
398
  Defined in:
399
- [epub/index.ts:2038](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2038)
399
+ [libraries/epub/index.ts:2504](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2504)
400
400
 
401
401
  Add a contributor to the EPUB metadata.
402
402
 
@@ -426,7 +426,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
426
426
  > **addCreator**(`creator`, `index?`, `type?`): `Promise`\<`void`\>
427
427
 
428
428
  Defined in:
429
- [epub/index.ts:1883](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1883)
429
+ [libraries/epub/index.ts:2349](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2349)
430
430
 
431
431
  Add a creator to the EPUB metadata.
432
432
 
@@ -456,7 +456,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
456
456
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
457
457
 
458
458
  Defined in:
459
- [epub/index.ts:2581](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2581)
459
+ [libraries/epub/index.ts:3047](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3047)
460
460
 
461
461
  Create a new manifest item and write its contents to a new entry.
462
462
 
@@ -485,7 +485,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
485
485
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
486
486
 
487
487
  Defined in:
488
- [epub/index.ts:2586](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2586)
488
+ [libraries/epub/index.ts:3052](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3052)
489
489
 
490
490
  Create a new manifest item and write its contents to a new entry.
491
491
 
@@ -514,7 +514,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
514
514
  > **addManifestItem**(`item`, `contents`): `Promise`\<`void`\>
515
515
 
516
516
  Defined in:
517
- [epub/index.ts:2591](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2591)
517
+ [libraries/epub/index.ts:3057](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3057)
518
518
 
519
519
  Create a new manifest item and write its contents to a new entry.
520
520
 
@@ -542,7 +542,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
542
542
  > **addMetadata**(`entry`): `Promise`\<`void`\>
543
543
 
544
544
  Defined in:
545
- [epub/index.ts:2702](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2702)
545
+ [libraries/epub/index.ts:3168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3168)
546
546
 
547
547
  Add a new metadata entry to the Epub.
548
548
 
@@ -569,7 +569,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
569
569
  > **addSpineItem**(`manifestId`, `index?`): `Promise`\<`void`\>
570
570
 
571
571
  Defined in:
572
- [epub/index.ts:2092](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2092)
572
+ [libraries/epub/index.ts:2558](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2558)
573
573
 
574
574
  Add an item to the spine of the EPUB.
575
575
 
@@ -599,7 +599,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
599
599
  > **addSubject**(`subject`): `Promise`\<`void`\>
600
600
 
601
601
  Defined in:
602
- [epub/index.ts:1225](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1225)
602
+ [libraries/epub/index.ts:1688](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1688)
603
603
 
604
604
  Add a subject to the EPUB metadata.
605
605
 
@@ -622,7 +622,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
622
622
  > **copy**(`path?`): `Promise`\<[`Epub`](#epub)\>
623
623
 
624
624
  Defined in:
625
- [epub/index.ts:630](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L630)
625
+ [libraries/epub/index.ts:630](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L630)
626
626
 
627
627
  ##### Parameters
628
628
 
@@ -641,7 +641,7 @@ Defined in:
641
641
  > [`XmlElement`](#xmlelement)\<`"html"`\>)[]\>
642
642
 
643
643
  Defined in:
644
- [epub/index.ts:2398](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2398)
644
+ [libraries/epub/index.ts:2864](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2864)
645
645
 
646
646
  Create a new XHTML document with the given body and head.
647
647
 
@@ -663,7 +663,7 @@ Create a new XHTML document with the given body and head.
663
663
  > **discardAndClose**(): `void`
664
664
 
665
665
  Defined in:
666
- [epub/index.ts:2945](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2945)
666
+ [libraries/epub/index.ts:3411](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3411)
667
667
 
668
668
  ##### Returns
669
669
 
@@ -674,7 +674,7 @@ Defined in:
674
674
  > **findAllMetadataItems**(`predicate`): `Promise`\<`object`[]\>
675
675
 
676
676
  Defined in:
677
- [epub/index.ts:895](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L895)
677
+ [libraries/epub/index.ts:895](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L895)
678
678
 
679
679
  Returns the item in the metadata element's children array that matches the
680
680
  provided predicate.
@@ -714,7 +714,7 @@ provided predicate.
714
714
  > \}\>
715
715
 
716
716
  Defined in:
717
- [epub/index.ts:886](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L886)
717
+ [libraries/epub/index.ts:886](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L886)
718
718
 
719
719
  Returns the item in the metadata element's children array that matches the
720
720
  provided predicate.
@@ -753,7 +753,7 @@ provided predicate.
753
753
  > **getBaseDirection**(): `Promise`\<`"auto"` \| `"rtl"` \| `"ltr"`\>
754
754
 
755
755
  Defined in:
756
- [epub/index.ts:1179](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1179)
756
+ [libraries/epub/index.ts:1642](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1642)
757
757
 
758
758
  Retrieve the base direction from the package element.
759
759
 
@@ -772,7 +772,7 @@ https://www.w3.org/TR/epub-33/#attrdef-dir
772
772
  > **getCollections**(): `Promise`\<[`Collection`](#collection)[]\>
773
773
 
774
774
  Defined in:
775
- [epub/index.ts:1656](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1656)
775
+ [libraries/epub/index.ts:2119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2119)
776
776
 
777
777
  Retrieve the list of collections.
778
778
 
@@ -785,7 +785,7 @@ Retrieve the list of collections.
785
785
  > **getContributors**(): `Promise`\<[`DcCreator`](#dccreator)[]\>
786
786
 
787
787
  Defined in:
788
- [epub/index.ts:1870](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1870)
788
+ [libraries/epub/index.ts:2336](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2336)
789
789
 
790
790
  Retrieve the list of contributors.
791
791
 
@@ -804,7 +804,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccontributor
804
804
  > **getCoverImage**(): `Promise`\<`null` \| `Uint8Array`\<`ArrayBufferLike`\>\>
805
805
 
806
806
  Defined in:
807
- [epub/index.ts:1075](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1075)
807
+ [libraries/epub/index.ts:1538](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1538)
808
808
 
809
809
  Retrieve the cover image data as a byte array.
810
810
 
@@ -825,7 +825,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
825
825
  > [`ManifestItem`](#manifestitem)\>
826
826
 
827
827
  Defined in:
828
- [epub/index.ts:1056](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1056)
828
+ [libraries/epub/index.ts:1519](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1519)
829
829
 
830
830
  Retrieve the cover image manifest item.
831
831
 
@@ -845,7 +845,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
845
845
  > **getCreators**(`type`): `Promise`\<[`DcCreator`](#dccreator)[]\>
846
846
 
847
847
  Defined in:
848
- [epub/index.ts:1809](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1809)
848
+ [libraries/epub/index.ts:2272](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2272)
849
849
 
850
850
  Retrieve the list of creators.
851
851
 
@@ -868,7 +868,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
868
868
  > **getDescription**(): `Promise`\<`null` \| `string`\>
869
869
 
870
870
  Defined in:
871
- [epub/index.ts:1507](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1507)
871
+ [libraries/epub/index.ts:1970](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1970)
872
872
 
873
873
  Retrieve the Epub's description as specified in its package document metadata.
874
874
 
@@ -884,7 +884,7 @@ as a string. Descriptions may include HTML markup.
884
884
  > **getGuideEntries**(): `Promise`\<`GuideItem`[]\>
885
885
 
886
886
  Defined in:
887
- [epub/index.ts:2922](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2922)
887
+ [libraries/epub/index.ts:3388](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3388)
888
888
 
889
889
  Retrieve the guide entries from the package document.
890
890
 
@@ -895,14 +895,15 @@ many publications still include it.
895
895
 
896
896
  `Promise`\<`GuideItem`[]\>
897
897
 
898
- #### getIdentifier()
898
+ #### ~~getIdentifier()~~
899
899
 
900
900
  > **getIdentifier**(): `Promise`\<`null` \| `string`\>
901
901
 
902
902
  Defined in:
903
- [epub/index.ts:990](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L990)
903
+ [libraries/epub/index.ts:993](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L993)
904
904
 
905
- Retrieve the identifier from the dc:identifier element in the EPUB metadata.
905
+ Retrieve the first identifier from the dc:identifier element in the EPUB
906
+ metadata.
906
907
 
907
908
  If there is no dc:identifier element, returns null.
908
909
 
@@ -914,12 +915,39 @@ If there is no dc:identifier element, returns null.
914
915
 
915
916
  https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
916
917
 
918
+ ##### Deprecated
919
+
920
+ Use [getUniqueIdentifier](#getuniqueidentifier) instead to get the unique
921
+ identifier, or [getIdentifiers](#getidentifiers) to get all identifiers.
922
+
923
+ #### getIdentifiers()
924
+
925
+ > **getIdentifiers**(): `Promise`\<[`EpubIdentifier`](#epubidentifier)[]\>
926
+
927
+ Defined in:
928
+ [libraries/epub/index.ts:1168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1168)
929
+
930
+ Retrieve every `dc:identifier` entry, returned as found.
931
+
932
+ Values are not interpreted. Any refining `identifier-type` meta (spec D.3.8) or
933
+ legacy `opf:scheme` attribute is surfaced on the entry, but no parsing of the
934
+ value itself is attempted. To read `dc:source` entries, use
935
+ [getSources](#getsources).
936
+
937
+ ##### Returns
938
+
939
+ `Promise`\<[`EpubIdentifier`](#epubidentifier)[]\>
940
+
941
+ ##### Link
942
+
943
+ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
944
+
917
945
  #### getItemArchiveLength()
918
946
 
919
947
  > **getItemArchiveLength**(`id`): `Promise`\<`number`\>
920
948
 
921
949
  Defined in:
922
- [epub/index.ts:672](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L672)
950
+ [libraries/epub/index.ts:672](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L672)
923
951
 
924
952
  Length of the underlying archive entry for a manifest item, in bytes Necessary
925
953
  to compute the readium page count which is for COMPRESSED content
@@ -944,7 +972,7 @@ to compute the readium page count which is for COMPRESSED content
944
972
  > [`Navigation`](#navigation)\>
945
973
 
946
974
  Defined in:
947
- [epub/index.ts:2271](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2271)
975
+ [libraries/epub/index.ts:2737](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2737)
948
976
 
949
977
  Returns the structured landmarks navigation document as a Navigation object
950
978
 
@@ -968,7 +996,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
968
996
  > **getLanguage**(): `Promise`\<`null` \| `Locale`\>
969
997
 
970
998
  Defined in:
971
- [epub/index.ts:1344](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1344)
999
+ [libraries/epub/index.ts:1807](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1807)
972
1000
 
973
1001
  Retrieve the Epub's language as specified in its package document metadata.
974
1002
 
@@ -988,7 +1016,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
988
1016
  > **getLayout**(): `Promise`\<`"pre-paginated"` \| `"reflowable"`\>
989
1017
 
990
1018
  Defined in:
991
- [epub/index.ts:1160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1160)
1019
+ [libraries/epub/index.ts:1623](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1623)
992
1020
 
993
1021
  Retrieve the layout from the rendition:layout meta element in the EPUB metadata.
994
1022
 
@@ -1008,7 +1036,7 @@ https://www.w3.org/TR/epub-33/#layout
1008
1036
  > [`ManifestItem`](#manifestitem)\>\>
1009
1037
 
1010
1038
  Defined in:
1011
- [epub/index.ts:811](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L811)
1039
+ [libraries/epub/index.ts:811](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L811)
1012
1040
 
1013
1041
  Retrieve the manifest for the Epub.
1014
1042
 
@@ -1028,7 +1056,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
1028
1056
  > **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
1029
1057
 
1030
1058
  Defined in:
1031
- [epub/index.ts:962](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L962)
1059
+ [libraries/epub/index.ts:962](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L962)
1032
1060
 
1033
1061
  Retrieve the metadata entries for the Epub.
1034
1062
 
@@ -1051,7 +1079,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1051
1079
  > **getModifiedDate**(): `Promise`\<`null` \| `Date`\>
1052
1080
 
1053
1081
  Defined in:
1054
- [epub/index.ts:1143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1143)
1082
+ [libraries/epub/index.ts:1606](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1606)
1055
1083
 
1056
1084
  Retrieve the modified date from the dcterms:modified metadata in the EPUB
1057
1085
  metadata as a Date object.
@@ -1071,7 +1099,7 @@ https://www.w3.org/TR/epub-33/#sec-metadata-last-modified
1071
1099
  > **getNcxTableOfContents**(): `Promise`\<[`NavigationList`](#navigationlist)\>
1072
1100
 
1073
1101
  Defined in:
1074
- [epub/index.ts:2827](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2827)
1102
+ [libraries/epub/index.ts:3293](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3293)
1075
1103
 
1076
1104
  Parse the NCX table of contents, if one exists, and return a tree of TocEntry
1077
1105
  nodes.
@@ -1089,7 +1117,7 @@ and EPUB 3 publications that retain an NCX for backwards compatibility.
1089
1117
  > `Promise`\<[`XmlElement`](#xmlelement)\<`"package"`\>\>
1090
1118
 
1091
1119
  Defined in:
1092
- [epub/index.ts:746](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L746)
1120
+ [libraries/epub/index.ts:746](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L746)
1093
1121
 
1094
1122
  ##### Returns
1095
1123
 
@@ -1101,7 +1129,7 @@ Defined in:
1101
1129
  > `string`\>\>
1102
1130
 
1103
1131
  Defined in:
1104
- [epub/index.ts:1524](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1524)
1132
+ [libraries/epub/index.ts:1987](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1987)
1105
1133
 
1106
1134
  Return the set of custom vocabulary prefixes set on this publication's root
1107
1135
  package element.
@@ -1116,13 +1144,35 @@ Returns a map from prefix to URI
1116
1144
 
1117
1145
  https://www.w3.org/TR/epub-33/#sec-prefix-attr
1118
1146
 
1147
+ #### getPageBreakSource()
1148
+
1149
+ > **getPageBreakSource**(): `Promise`\<`null` \| [`EpubSource`](#epubsource)\>
1150
+
1151
+ Defined in:
1152
+ [libraries/epub/index.ts:1205](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1205)
1153
+
1154
+ Retrieve the `pageBreakSource` property (EPUB 3.4, spec D.2.9), the
1155
+ publication-level source for the source of its page break markers.
1156
+
1157
+ This property replaces the refining `source-of="pagination"` meta (spec D.3.11),
1158
+ see EpubSource.sourceOf. If no `pageBreakSource` property is found, we fall back
1159
+ to finding a `dc:source` with a `source-of="pagination"` refinement.
1160
+
1161
+ ##### Returns
1162
+
1163
+ `Promise`\<`null` \| [`EpubSource`](#epubsource)\>
1164
+
1165
+ ##### Link
1166
+
1167
+ https://www.w3.org/TR/epub/#pageBreakSource
1168
+
1119
1169
  #### getPageList()
1120
1170
 
1121
1171
  > **getPageList**(`__namedParameters`): `Promise`\<`null` \|
1122
1172
  > [`Navigation`](#navigation)\>
1123
1173
 
1124
1174
  Defined in:
1125
- [epub/index.ts:2283](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2283)
1175
+ [libraries/epub/index.ts:2749](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2749)
1126
1176
 
1127
1177
  Returns the structured page list navigation document as a Navigation object
1128
1178
 
@@ -1146,7 +1196,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
1146
1196
  > **getPublicationDate**(): `Promise`\<`null` \| `Date`\>
1147
1197
 
1148
1198
  Defined in:
1149
- [epub/index.ts:1112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1112)
1199
+ [libraries/epub/index.ts:1575](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1575)
1150
1200
 
1151
1201
  Retrieve the publication date from the dc:date element in the EPUB metadata as a
1152
1202
  Date object.
@@ -1166,18 +1216,39 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1166
1216
  > **getRootfile**(): `Promise`\<`string`\>
1167
1217
 
1168
1218
  Defined in:
1169
- [epub/index.ts:682](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L682)
1219
+ [libraries/epub/index.ts:682](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L682)
1170
1220
 
1171
1221
  ##### Returns
1172
1222
 
1173
1223
  `Promise`\<`string`\>
1174
1224
 
1225
+ #### getSources()
1226
+
1227
+ > **getSources**(): `Promise`\<[`EpubSource`](#epubsource)[]\>
1228
+
1229
+ Defined in:
1230
+ [libraries/epub/index.ts:1182](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1182)
1231
+
1232
+ Retrieve every `dc:source` entry, returned as found.
1233
+
1234
+ Like [getIdentifiers](#getidentifiers), values are not interpreted. In addition
1235
+ to a refining `identifier-type`, a refining `source-of` meta (spec D.3.11) is
1236
+ surfaced as `sourceOf`.
1237
+
1238
+ ##### Returns
1239
+
1240
+ `Promise`\<[`EpubSource`](#epubsource)[]\>
1241
+
1242
+ ##### Link
1243
+
1244
+ https://www.w3.org/TR/epub-33/#sec-opf-dcsource
1245
+
1175
1246
  #### getSpineItems()
1176
1247
 
1177
1248
  > **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem)[]\>
1178
1249
 
1179
1250
  Defined in:
1180
- [epub/index.ts:2073](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2073)
1251
+ [libraries/epub/index.ts:2539](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2539)
1181
1252
 
1182
1253
  Retrieve the manifest items that make up the Epub's spine.
1183
1254
 
@@ -1197,7 +1268,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1197
1268
  > **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
1198
1269
 
1199
1270
  Defined in:
1200
- [epub/index.ts:1299](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1299)
1271
+ [libraries/epub/index.ts:1762](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1762)
1201
1272
 
1202
1273
  Retrieve the list of subjects for this EPUB.
1203
1274
 
@@ -1218,7 +1289,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
1218
1289
  > **getSubtitle**(): `Promise`\<`null` \| `string`\>
1219
1290
 
1220
1291
  Defined in:
1221
- [epub/index.ts:1414](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1414)
1292
+ [libraries/epub/index.ts:1877](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1877)
1222
1293
 
1223
1294
  Retrieve the subtitle of the Epub, if it exists.
1224
1295
 
@@ -1236,7 +1307,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1236
1307
  > [`Navigation`](#navigation)\>
1237
1308
 
1238
1309
  Defined in:
1239
- [epub/index.ts:2254](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2254)
1310
+ [libraries/epub/index.ts:2720](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2720)
1240
1311
 
1241
1312
  Returns the structured table of contents navigation document as a Navigation
1242
1313
  object.
@@ -1261,7 +1332,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-toc
1261
1332
  > **getTitle**(`expanded`): `Promise`\<`null` \| `string`\>
1262
1333
 
1263
1334
  Defined in:
1264
- [epub/index.ts:1390](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1390)
1335
+ [libraries/epub/index.ts:1853](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1853)
1265
1336
 
1266
1337
  Retrieve the title of the Epub.
1267
1338
 
@@ -1284,7 +1355,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1284
1355
  > **getTitles**(): `Promise`\<`object`[]\>
1285
1356
 
1286
1357
  Defined in:
1287
- [epub/index.ts:1426](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1426)
1358
+ [libraries/epub/index.ts:1889](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1889)
1288
1359
 
1289
1360
  Retrieve all title entries of the Epub.
1290
1361
 
@@ -1301,7 +1372,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1301
1372
  > **getType**(): `Promise`\<`null` \| [`MetadataEntry`](#metadataentry)\>
1302
1373
 
1303
1374
  Defined in:
1304
- [epub/index.ts:1212](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1212)
1375
+ [libraries/epub/index.ts:1675](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1675)
1305
1376
 
1306
1377
  Retrieve the publication type from the dc:type element in the EPUB metadata.
1307
1378
 
@@ -1315,12 +1386,49 @@ If there is no dc:type element, returns null.
1315
1386
 
1316
1387
  https://www.w3.org/TR/epub-33/#sec-opf-dctype
1317
1388
 
1389
+ #### getUniqueIdentifier()
1390
+
1391
+ > **getUniqueIdentifier**(): `Promise`\<`null` \| `string`\>
1392
+
1393
+ Defined in:
1394
+ [libraries/epub/index.ts:1025](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1025)
1395
+
1396
+ Retrieve the identifier with the unique identifier id in the EPUB metadata.
1397
+
1398
+ If there is no unique identifier id, returns the first dc:identifier element.
1399
+
1400
+ ##### Returns
1401
+
1402
+ `Promise`\<`null` \| `string`\>
1403
+
1404
+ ##### Link
1405
+
1406
+ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1407
+
1408
+ #### getUniqueIdentifierId()
1409
+
1410
+ > **getUniqueIdentifierId**(): `Promise`\<`null` \| `string`\>
1411
+
1412
+ Defined in:
1413
+ [libraries/epub/index.ts:1106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1106)
1414
+
1415
+ Retrieve the id of the publication's unique identifier, as declared by the
1416
+ package element's `unique-identifier` attribute.
1417
+
1418
+ ##### Returns
1419
+
1420
+ `Promise`\<`null` \| `string`\>
1421
+
1422
+ ##### Link
1423
+
1424
+ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1425
+
1318
1426
  #### getVersion()
1319
1427
 
1320
1428
  > **getVersion**(): `Promise`\<`string`\>
1321
1429
 
1322
1430
  Defined in:
1323
- [epub/index.ts:2814](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2814)
1431
+ [libraries/epub/index.ts:3280](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3280)
1324
1432
 
1325
1433
  Returns the EPUB version declared on the package element.
1326
1434
 
@@ -1336,7 +1444,7 @@ Returns the EPUB version declared on the package element.
1336
1444
  > `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1337
1445
 
1338
1446
  Defined in:
1339
- [epub/index.ts:2337](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2337)
1447
+ [libraries/epub/index.ts:2803](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2803)
1340
1448
 
1341
1449
  Retrieve the contents of a file, given its href.
1342
1450
 
@@ -1359,7 +1467,7 @@ encoding parameter.
1359
1467
  > **readFileContents**(`href`, `relativeTo`, `encoding`): `Promise`\<`string`\>
1360
1468
 
1361
1469
  Defined in:
1362
- [epub/index.ts:2338](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2338)
1470
+ [libraries/epub/index.ts:2804](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2804)
1363
1471
 
1364
1472
  Retrieve the contents of a file, given its href.
1365
1473
 
@@ -1385,7 +1493,7 @@ encoding parameter.
1385
1493
  > **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1386
1494
 
1387
1495
  Defined in:
1388
- [epub/index.ts:2370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2370)
1496
+ [libraries/epub/index.ts:2836](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2836)
1389
1497
 
1390
1498
  Retrieve the contents of a manifest item, given its id.
1391
1499
 
@@ -1408,7 +1516,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1408
1516
  > **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
1409
1517
 
1410
1518
  Defined in:
1411
- [epub/index.ts:2371](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2371)
1519
+ [libraries/epub/index.ts:2837](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2837)
1412
1520
 
1413
1521
  Retrieve the contents of a manifest item, given its id.
1414
1522
 
@@ -1434,7 +1542,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1434
1542
  > **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`ParsedXml`](#parsedxml)\>
1435
1543
 
1436
1544
  Defined in:
1437
- [epub/index.ts:2433](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2433)
1545
+ [libraries/epub/index.ts:2899](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2899)
1438
1546
 
1439
1547
  Retrieves the contents of an XHTML item, given its manifest id.
1440
1548
 
@@ -1458,7 +1566,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1458
1566
  > **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
1459
1567
 
1460
1568
  Defined in:
1461
- [epub/index.ts:2434](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2434)
1569
+ [libraries/epub/index.ts:2900](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2900)
1462
1570
 
1463
1571
  Retrieves the contents of an XHTML item, given its manifest id.
1464
1572
 
@@ -1482,7 +1590,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1482
1590
  > **removeCollection**(`index`): `Promise`\<`void`\>
1483
1591
 
1484
1592
  Defined in:
1485
- [epub/index.ts:1765](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1765)
1593
+ [libraries/epub/index.ts:2228](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2228)
1486
1594
 
1487
1595
  Remove a collection from the EPUB metadata.
1488
1596
 
@@ -1504,7 +1612,7 @@ returned by `epub.getCollections()`.
1504
1612
  > **removeContributor**(`index`): `Promise`\<`void`\>
1505
1613
 
1506
1614
  Defined in:
1507
- [epub/index.ts:2022](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2022)
1615
+ [libraries/epub/index.ts:2488](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2488)
1508
1616
 
1509
1617
  Remove a contributor from the EPUB metadata.
1510
1618
 
@@ -1532,7 +1640,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1532
1640
  > **removeCreator**(`index`, `type`): `Promise`\<`void`\>
1533
1641
 
1534
1642
  Defined in:
1535
- [epub/index.ts:1970](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1970)
1643
+ [libraries/epub/index.ts:2436](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2436)
1536
1644
 
1537
1645
  Remove a creator from the EPUB metadata.
1538
1646
 
@@ -1559,7 +1667,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1559
1667
  > **removeManifestItem**(`id`): `Promise`\<`void`\>
1560
1668
 
1561
1669
  Defined in:
1562
- [epub/index.ts:2538](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2538)
1670
+ [libraries/epub/index.ts:3004](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3004)
1563
1671
 
1564
1672
  ##### Parameters
1565
1673
 
@@ -1576,7 +1684,7 @@ Defined in:
1576
1684
  > **removeMetadata**(`predicate`): `Promise`\<`void`\>
1577
1685
 
1578
1686
  Defined in:
1579
- [epub/index.ts:2786](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2786)
1687
+ [libraries/epub/index.ts:3252](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3252)
1580
1688
 
1581
1689
  Remove one or more metadata entries.
1582
1690
 
@@ -1602,7 +1710,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1602
1710
  > **removeSpineItem**(`index`): `Promise`\<`void`\>
1603
1711
 
1604
1712
  Defined in:
1605
- [epub/index.ts:2128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2128)
1713
+ [libraries/epub/index.ts:2594](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2594)
1606
1714
 
1607
1715
  Remove the spine item at the specified index.
1608
1716
 
@@ -1625,7 +1733,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1625
1733
  > **removeSubject**(`index`): `Promise`\<`void`\>
1626
1734
 
1627
1735
  Defined in:
1628
- [epub/index.ts:1262](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1262)
1736
+ [libraries/epub/index.ts:1725](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1725)
1629
1737
 
1630
1738
  Remove a subject from the EPUB metadata.
1631
1739
 
@@ -1651,7 +1759,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1651
1759
  > **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
1652
1760
 
1653
1761
  Defined in:
1654
- [epub/index.ts:2741](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2741)
1762
+ [libraries/epub/index.ts:3207](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3207)
1655
1763
 
1656
1764
  Replace a metadata entry with a new one.
1657
1765
 
@@ -1679,7 +1787,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1679
1787
  > `Promise`\<`string`\>
1680
1788
 
1681
1789
  Defined in:
1682
- [epub/index.ts:2309](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2309)
1790
+ [libraries/epub/index.ts:2775](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2775)
1683
1791
 
1684
1792
  Returns a path-relative-scheme-less URL, relative to the container root.
1685
1793
 
@@ -1701,7 +1809,7 @@ Returns a path-relative-scheme-less URL, relative to the container root.
1701
1809
  > **saveAndClose**(): `Promise`\<`void`\>
1702
1810
 
1703
1811
  Defined in:
1704
- [epub/index.ts:2960](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2960)
1812
+ [libraries/epub/index.ts:3426](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3426)
1705
1813
 
1706
1814
  Write the current contents of the Epub to a new EPUB archive on disk.
1707
1815
 
@@ -1717,7 +1825,7 @@ updated to the current UTC timestamp.
1717
1825
  > **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
1718
1826
 
1719
1827
  Defined in:
1720
- [epub/index.ts:1089](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1089)
1828
+ [libraries/epub/index.ts:1552](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1552)
1721
1829
 
1722
1830
  Set the cover image for the EPUB.
1723
1831
 
@@ -1740,7 +1848,7 @@ then writes the provided image data to the provided href within the publication.
1740
1848
  > **setDescription**(`description`): `Promise`\<`void`\>
1741
1849
 
1742
1850
  Defined in:
1743
- [epub/index.ts:1491](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1491)
1851
+ [libraries/epub/index.ts:1954](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1954)
1744
1852
 
1745
1853
  Update the Epub's description metadata entry.
1746
1854
 
@@ -1758,12 +1866,12 @@ encoded as HTML entities.
1758
1866
 
1759
1867
  `Promise`\<`void`\>
1760
1868
 
1761
- #### setIdentifier()
1869
+ #### ~~setIdentifier()~~
1762
1870
 
1763
1871
  > **setIdentifier**(`identifier`): `Promise`\<`void`\>
1764
1872
 
1765
1873
  Defined in:
1766
- [epub/index.ts:1004](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1004)
1874
+ [libraries/epub/index.ts:1009](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1009)
1767
1875
 
1768
1876
  Set the dc:identifier metadata element with the provided string.
1769
1877
 
@@ -1784,12 +1892,54 @@ new element
1784
1892
 
1785
1893
  https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1786
1894
 
1895
+ ##### Deprecated
1896
+
1897
+ Use [setUniqueIdentifier](#setuniqueidentifier) instead.
1898
+
1899
+ #### setIdentifiers()
1900
+
1901
+ > **setIdentifiers**(`identifiers`): `Promise`\<`void`\>
1902
+
1903
+ Defined in:
1904
+ [libraries/epub/index.ts:1274](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1274)
1905
+
1906
+ Replace the publication's `dc:identifier` entries.
1907
+
1908
+ This replaces ALL existing `dc:identifier` elements except the publication's
1909
+ unique identifier (the one referenced by the package element's
1910
+ `unique-identifier` attribute), which is always preserved and must not be
1911
+ included in the provided list. If included anyway, it is ignored. See
1912
+ [setUniqueIdentifier](#setuniqueidentifier) to change it.
1913
+
1914
+ Identifiers are placed in the order they are provided.
1915
+
1916
+ `dc:source` entries are not touched, use [setSources](#setsources) for those.
1917
+
1918
+ When an entry has an `identifierType`, it is written in the refining form (a
1919
+ `meta` with `property="identifier-type"`, carrying the `scheme` attribute when
1920
+ provided). An entry with only a `scheme` is written using the legacy
1921
+ `opf:scheme` attribute.
1922
+
1923
+ ##### Parameters
1924
+
1925
+ | Parameter | Type |
1926
+ | ------------- | ------------------------------------- |
1927
+ | `identifiers` | [`EpubIdentifier`](#epubidentifier)[] |
1928
+
1929
+ ##### Returns
1930
+
1931
+ `Promise`\<`void`\>
1932
+
1933
+ ##### Link
1934
+
1935
+ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1936
+
1787
1937
  #### setLanguage()
1788
1938
 
1789
1939
  > **setLanguage**(`locale`): `Promise`\<`void`\>
1790
1940
 
1791
1941
  Defined in:
1792
- [epub/index.ts:1373](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1373)
1942
+ [libraries/epub/index.ts:1836](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1836)
1793
1943
 
1794
1944
  Update the Epub's language metadata entry.
1795
1945
 
@@ -1815,7 +1965,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1815
1965
  > **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
1816
1966
 
1817
1967
  Defined in:
1818
- [epub/index.ts:1542](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1542)
1968
+ [libraries/epub/index.ts:2005](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2005)
1819
1969
 
1820
1970
  Set a custom vocabulary prefix on the root package element.
1821
1971
 
@@ -1834,12 +1984,38 @@ Set a custom vocabulary prefix on the root package element.
1834
1984
 
1835
1985
  https://www.w3.org/TR/epub-33/#sec-prefix-attr
1836
1986
 
1987
+ #### setPageBreakSource()
1988
+
1989
+ > **setPageBreakSource**(`value`): `Promise`\<`void`\>
1990
+
1991
+ Defined in:
1992
+ [libraries/epub/index.ts:1241](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1241)
1993
+
1994
+ Set the `pageBreakSource` property (EPUB 3.4, spec D.2.9), or remove it when
1995
+ passed null. Replaces an existing `pageBreakSource` meta if present.
1996
+
1997
+ Pass `none` to indicate the pagination is unique to this publication.
1998
+
1999
+ ##### Parameters
2000
+
2001
+ | Parameter | Type |
2002
+ | --------- | ------------------ |
2003
+ | `value` | `null` \| `string` |
2004
+
2005
+ ##### Returns
2006
+
2007
+ `Promise`\<`void`\>
2008
+
2009
+ ##### Link
2010
+
2011
+ https://www.w3.org/TR/epub/#pageBreakSource
2012
+
1837
2013
  #### setPublicationDate()
1838
2014
 
1839
2015
  > **setPublicationDate**(`date`): `Promise`\<`void`\>
1840
2016
 
1841
2017
  Defined in:
1842
- [epub/index.ts:1127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1127)
2018
+ [libraries/epub/index.ts:1590](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1590)
1843
2019
 
1844
2020
  Set the dc:date metadata element with the provided date.
1845
2021
 
@@ -1860,12 +2036,44 @@ element
1860
2036
 
1861
2037
  https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1862
2038
 
2039
+ #### setSources()
2040
+
2041
+ > **setSources**(`sources`): `Promise`\<`void`\>
2042
+
2043
+ Defined in:
2044
+ [libraries/epub/index.ts:1392](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1392)
2045
+
2046
+ Replace the publication's `dc:source` entries.
2047
+
2048
+ This replaces ALL existing `dc:source` elements (and their refining
2049
+ `identifier-type` / `source-of` metas). `dc:identifier` entries are not touched;
2050
+ use [setIdentifiers](#setidentifiers) for those. Pass an empty array to remove
2051
+ all sources.
2052
+
2053
+ When an entry has an `identifierType`, it is written in the refining form. A
2054
+ `sourceOf` value is written as a refining `source-of` meta (spec D.3.11). An
2055
+ entry with only a `scheme` uses the legacy `opf:scheme` attribute.
2056
+
2057
+ ##### Parameters
2058
+
2059
+ | Parameter | Type |
2060
+ | --------- | ----------------------------- |
2061
+ | `sources` | [`EpubSource`](#epubsource)[] |
2062
+
2063
+ ##### Returns
2064
+
2065
+ `Promise`\<`void`\>
2066
+
2067
+ ##### Link
2068
+
2069
+ https://www.w3.org/TR/epub-33/#sec-opf-dcsource
2070
+
1863
2071
  #### setTitle()
1864
2072
 
1865
2073
  > **setTitle**(`title`): `Promise`\<`void`\>
1866
2074
 
1867
2075
  Defined in:
1868
- [epub/index.ts:1566](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1566)
2076
+ [libraries/epub/index.ts:2029](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2029)
1869
2077
 
1870
2078
  Set the title of the Epub.
1871
2079
 
@@ -1893,7 +2101,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1893
2101
  > **setTitles**(`entries`): `Promise`\<`void`\>
1894
2102
 
1895
2103
  Defined in:
1896
- [epub/index.ts:1594](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1594)
2104
+ [libraries/epub/index.ts:2057](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2057)
1897
2105
 
1898
2106
  ##### Parameters
1899
2107
 
@@ -1910,7 +2118,7 @@ Defined in:
1910
2118
  > **setType**(`type`): `Promise`\<`void`\>
1911
2119
 
1912
2120
  Defined in:
1913
- [epub/index.ts:1196](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1196)
2121
+ [libraries/epub/index.ts:1659](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1659)
1914
2122
 
1915
2123
  Set the dc:type metadata element.
1916
2124
 
@@ -1931,12 +2139,42 @@ element.
1931
2139
 
1932
2140
  https://www.w3.org/TR/epub-33/#sec-opf-dctype
1933
2141
 
2142
+ #### setUniqueIdentifier()
2143
+
2144
+ > **setUniqueIdentifier**(`identifier`): `Promise`\<`void`\>
2145
+
2146
+ Defined in:
2147
+ [libraries/epub/index.ts:1050](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1050)
2148
+
2149
+ Set the unique identifier id for the EPUB.
2150
+
2151
+ Updates the existing dc:identifier element referenced by the unique identifier
2152
+ id if one exists. Otherwise creates a new element with the provided identifier,
2153
+ and sets the unique identifier id to the new element's id.
2154
+
2155
+ Note: you likely shouldn't change the unique identifier id unless you are
2156
+ producing a new EPUB.
2157
+
2158
+ ##### Parameters
2159
+
2160
+ | Parameter | Type |
2161
+ | ------------ | -------- |
2162
+ | `identifier` | `string` |
2163
+
2164
+ ##### Returns
2165
+
2166
+ `Promise`\<`void`\>
2167
+
2168
+ ##### Link
2169
+
2170
+ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
2171
+
1934
2172
  #### updateManifestItem()
1935
2173
 
1936
2174
  > **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
1937
2175
 
1938
2176
  Defined in:
1939
- [epub/index.ts:2653](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2653)
2177
+ [libraries/epub/index.ts:3119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3119)
1940
2178
 
1941
2179
  Update the manifest entry for an existing item.
1942
2180
 
@@ -1963,7 +2201,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
1963
2201
  > **withPackage**(`producer`): `Promise`\<`void`\>
1964
2202
 
1965
2203
  Defined in:
1966
- [epub/index.ts:772](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L772)
2204
+ [libraries/epub/index.ts:772](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L772)
1967
2205
 
1968
2206
  Safely modify the package document, without race conditions.
1969
2207
 
@@ -1989,7 +2227,7 @@ update runs exclusively.
1989
2227
  > **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
1990
2228
 
1991
2229
  Defined in:
1992
- [epub/index.ts:2490](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2490)
2230
+ [libraries/epub/index.ts:2956](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2956)
1993
2231
 
1994
2232
  Write new contents for an existing manifest item, specified by its id.
1995
2233
 
@@ -2016,7 +2254,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
2016
2254
  > **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
2017
2255
 
2018
2256
  Defined in:
2019
- [epub/index.ts:2491](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2491)
2257
+ [libraries/epub/index.ts:2957](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2957)
2020
2258
 
2021
2259
  Write new contents for an existing manifest item, specified by its id.
2022
2260
 
@@ -2044,7 +2282,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
2044
2282
  > **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
2045
2283
 
2046
2284
  Defined in:
2047
- [epub/index.ts:2530](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2530)
2285
+ [libraries/epub/index.ts:2996](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2996)
2048
2286
 
2049
2287
  Write new contents for an existing XHTML item, specified by its id.
2050
2288
 
@@ -2071,7 +2309,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
2071
2309
  > `static` **addLinkToXhtmlHead**(`xml`, `link`): `void`
2072
2310
 
2073
2311
  Defined in:
2074
- [epub/index.ts:345](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L345)
2312
+ [libraries/epub/index.ts:345](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L345)
2075
2313
 
2076
2314
  Given an XML structure representing a complete XHTML document, add a `link`
2077
2315
  element to the `head` of the document.
@@ -2097,7 +2335,7 @@ This method modifies the provided XML structure.
2097
2335
  > `static` **assertEpub3**(`epub`): `Promise`\<`void`\>
2098
2336
 
2099
2337
  Defined in:
2100
- [epub/index.ts:620](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L620)
2338
+ [libraries/epub/index.ts:620](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L620)
2101
2339
 
2102
2340
  ##### Parameters
2103
2341
 
@@ -2115,7 +2353,7 @@ Defined in:
2115
2353
  > `Promise`\<[`Epub`](#epub)\>
2116
2354
 
2117
2355
  Defined in:
2118
- [epub/index.ts:568](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L568)
2356
+ [libraries/epub/index.ts:568](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L568)
2119
2357
 
2120
2358
  Construct a new EPUB on a writable backend, optionally seeded with the provided
2121
2359
  metadata. Equivalent to `Epub.using(TmpFsAdapter).create(...)`.
@@ -2138,7 +2376,7 @@ metadata. Equivalent to `Epub.using(TmpFsAdapter).create(...)`.
2138
2376
  > [`XmlElement`](#xmlelement)\<`Name`\>
2139
2377
 
2140
2378
  Defined in:
2141
- [epub/index.ts:380](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L380)
2379
+ [libraries/epub/index.ts:380](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L380)
2142
2380
 
2143
2381
  ##### Type Parameters
2144
2382
 
@@ -2163,7 +2401,7 @@ Defined in:
2163
2401
  > `static` **createXmlTextNode**(`text`): [`XmlTextNode`](#xmltextnode)
2164
2402
 
2165
2403
  Defined in:
2166
- [epub/index.ts:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L393)
2404
+ [libraries/epub/index.ts:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L393)
2167
2405
 
2168
2406
  ##### Parameters
2169
2407
 
@@ -2181,7 +2419,7 @@ Defined in:
2181
2419
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
2182
2420
 
2183
2421
  Defined in:
2184
- [epub/index.ts:466](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L466)
2422
+ [libraries/epub/index.ts:466](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L466)
2185
2423
 
2186
2424
  Given an XML structure, find the first child matching the provided name and
2187
2425
  optional filter.
@@ -2210,7 +2448,7 @@ optional filter.
2210
2448
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
2211
2449
 
2212
2450
  Defined in:
2213
- [epub/index.ts:484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L484)
2451
+ [libraries/epub/index.ts:484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L484)
2214
2452
 
2215
2453
  Given an XML structure, find the first descendant matching the provided name and
2216
2454
  optional filter.
@@ -2241,7 +2479,7 @@ element in the tree matching the name and filter.
2241
2479
  > `static` **formatSmilDuration**(`duration`): `string`
2242
2480
 
2243
2481
  Defined in:
2244
- [epub/index.ts:328](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L328)
2482
+ [libraries/epub/index.ts:328](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L328)
2245
2483
 
2246
2484
  Format a duration, provided as a number of seconds, as a SMIL clock value, to be
2247
2485
  used for Media Overlays.
@@ -2267,7 +2505,7 @@ https://www.w3.org/TR/epub-33/#sec-duration
2267
2505
  > `static` **from**(`pathOrData`): `Promise`\<[`Epub`](#epub)\>
2268
2506
 
2269
2507
  Defined in:
2270
- [epub/index.ts:604](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L604)
2508
+ [libraries/epub/index.ts:604](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L604)
2271
2509
 
2272
2510
  Open an existing EPUB publication, extracting it to a temp directory so writes
2273
2511
  can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2297,7 +2535,7 @@ when the archive is not a valid EPUB 3
2297
2535
  > `Promise`\<[`EpubReader`](#epubreader)\>
2298
2536
 
2299
2537
  Defined in:
2300
- [epub/index.ts:605](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L605)
2538
+ [libraries/epub/index.ts:605](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L605)
2301
2539
 
2302
2540
  Open an existing EPUB publication, extracting it to a temp directory so writes
2303
2541
  can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2328,7 +2566,7 @@ when the archive is not a valid EPUB 3
2328
2566
  > [`EpubReader`](#epubreader)\>
2329
2567
 
2330
2568
  Defined in:
2331
- [epub/index.ts:609](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L609)
2569
+ [libraries/epub/index.ts:609](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L609)
2332
2570
 
2333
2571
  Open an existing EPUB publication, extracting it to a temp directory so writes
2334
2572
  can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2358,7 +2596,7 @@ when the archive is not a valid EPUB 3
2358
2596
  > `static` **getXhtmlBody**(`xml`): [`ParsedXml`](#parsedxml)
2359
2597
 
2360
2598
  Defined in:
2361
- [epub/index.ts:370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L370)
2599
+ [libraries/epub/index.ts:370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L370)
2362
2600
 
2363
2601
  Given an XML structure representing a complete XHTML document, return the
2364
2602
  sub-structure representing the children of the document's body element.
@@ -2378,7 +2616,7 @@ sub-structure representing the children of the document's body element.
2378
2616
  > `static` **getXhtmlTextContent**(`xml`): `string`
2379
2617
 
2380
2618
  Defined in:
2381
- [epub/index.ts:402](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L402)
2619
+ [libraries/epub/index.ts:402](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L402)
2382
2620
 
2383
2621
  Given an XML structure representing a complete XHTML document, return a string
2384
2622
  representing the concatenation of all text nodes in the document.
@@ -2398,7 +2636,7 @@ representing the concatenation of all text nodes in the document.
2398
2636
  > `static` **getXmlAttributes**(`element`): `Record`\<`string`, `string`\>
2399
2637
 
2400
2638
  Defined in:
2401
- [epub/index.ts:419](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L419)
2639
+ [libraries/epub/index.ts:419](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L419)
2402
2640
 
2403
2641
  Given an XMLElement, return its attributes.
2404
2642
 
@@ -2417,7 +2655,7 @@ Given an XMLElement, return its attributes.
2417
2655
  > `static` **getXmlChildren**\<`Name`\>(`element`): [`ParsedXml`](#parsedxml)
2418
2656
 
2419
2657
  Defined in:
2420
- [epub/index.ts:446](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L446)
2658
+ [libraries/epub/index.ts:446](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L446)
2421
2659
 
2422
2660
  Given an XMLElement, return a list of its children
2423
2661
 
@@ -2442,7 +2680,7 @@ Given an XMLElement, return a list of its children
2442
2680
  > `static` **getXmlElementName**\<`Name`\>(`element`): `Name`
2443
2681
 
2444
2682
  Defined in:
2445
- [epub/index.ts:431](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L431)
2683
+ [libraries/epub/index.ts:431](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L431)
2446
2684
 
2447
2685
  Given an XMLElement, return its tag name.
2448
2686
 
@@ -2467,7 +2705,7 @@ Given an XMLElement, return its tag name.
2467
2705
  > `static` **isXmlTextNode**(`node`): `node is XmlTextNode`
2468
2706
 
2469
2707
  Defined in:
2470
- [epub/index.ts:506](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L506)
2708
+ [libraries/epub/index.ts:506](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L506)
2471
2709
 
2472
2710
  Given an XMLNode, determine whether it represents a text node or an XML element.
2473
2711
 
@@ -2486,7 +2724,7 @@ Given an XMLNode, determine whether it represents a text node or an XML element.
2486
2724
  > `static` **replaceXmlChildren**\<`Name`\>(`element`, `children`): `void`
2487
2725
 
2488
2726
  Defined in:
2489
- [epub/index.ts:454](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L454)
2727
+ [libraries/epub/index.ts:454](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L454)
2490
2728
 
2491
2729
  ##### Type Parameters
2492
2730
 
@@ -2510,7 +2748,7 @@ Defined in:
2510
2748
  > `static` **upgrade**(`path`, `options`): `Promise`\<[`Epub`](#epub)\>
2511
2749
 
2512
2750
  Defined in:
2513
- [epub/index.ts:2988](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2988)
2751
+ [libraries/epub/index.ts:3454](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3454)
2514
2752
 
2515
2753
  Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new, valid Epub 3
2516
2754
  instance. Equivalent to `Epub.using(TmpFsAdapter).upgrade(...)`.
@@ -2532,7 +2770,7 @@ instance. Equivalent to `Epub.using(TmpFsAdapter).upgrade(...)`.
2532
2770
  > [`EpubFactory`](#epubfactory)\<`A`\>
2533
2771
 
2534
2772
  Defined in:
2535
- [epub/index.ts:588](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L588)
2773
+ [libraries/epub/index.ts:588](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L588)
2536
2774
 
2537
2775
  Specify the storage backend to use for the EPUB
2538
2776
 
@@ -2567,7 +2805,7 @@ using reader = await Epub.using(MemoryAdapter).from(buffer, { cache: false })
2567
2805
  ## EpubFactory\<A\>
2568
2806
 
2569
2807
  Defined in:
2570
- [epub/index.ts:3017](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3017)
2808
+ [libraries/epub/index.ts:3483](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3483)
2571
2809
 
2572
2810
  Adapter-bound factory returned by [Epub.using](#using).
2573
2811
 
@@ -2590,7 +2828,7 @@ runtime if the adapter is read-only or lacks `initEmpty`.
2590
2828
  > [`EpubFactory`](#epubfactory)\<`A`\>
2591
2829
 
2592
2830
  Defined in:
2593
- [epub/index.ts:3018](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3018)
2831
+ [libraries/epub/index.ts:3484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3484)
2594
2832
 
2595
2833
  ##### Parameters
2596
2834
 
@@ -2609,7 +2847,7 @@ Defined in:
2609
2847
  > `readonly` **adapterClass**: `A`
2610
2848
 
2611
2849
  Defined in:
2612
- [epub/index.ts:3018](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3018)
2850
+ [libraries/epub/index.ts:3484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3484)
2613
2851
 
2614
2852
  ### Methods
2615
2853
 
@@ -2619,7 +2857,7 @@ Defined in:
2619
2857
  > `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\>\>
2620
2858
 
2621
2859
  Defined in:
2622
- [epub/index.ts:3074](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3074)
2860
+ [libraries/epub/index.ts:3540](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3540)
2623
2861
 
2624
2862
  Construct a new EPUB on this factory's adapter, optionally seeded with the
2625
2863
  provided metadata. Requires a writable adapter that implements `initEmpty`
@@ -2646,20 +2884,23 @@ when the adapter is read-only or does not implement initEmpty
2646
2884
  ##### Call Signature
2647
2885
 
2648
2886
  > **from**(`source`, `options`): `Promise`\<`Pick`\<[`Epub`](#epub), `"storage"`
2649
- > \| `"getManifest"` \| `"getVersion"` \| `"getLayout"` \| `"getBaseDirection"`
2650
- > \| `"getMetadata"` \| `"findMetadataItem"` \| `"findAllMetadataItems"` \|
2651
- > `"getIdentifier"` \| `"getTitle"` \| `"getSubtitle"` \| `"getTitles"` \|
2652
- > `"getLanguage"` \| `"getPublicationDate"` \| `"getModifiedDate"` \|
2653
- > `"getDescription"` \| `"getType"` \| `"getCreators"` \| `"getContributors"` \|
2654
- > `"getSubjects"` \| `"getCollections"` \| `"getPackageVocabularyPrefixes"` \|
2655
- > `"getCoverImageItem"` \| `"getCoverImage"` \| `"getSpineItems"` \|
2656
- > `"getNcxTableOfContents"` \| `"getGuideEntries"` \| `"getTableOfContents"` \|
2887
+ > \| `"getItemArchiveLength"` \| `"getRootfile"` \| `"getPackageElement"` \|
2888
+ > `"getManifest"` \| `"findMetadataItem"` \| `"findAllMetadataItems"` \|
2889
+ > `"getMetadata"` \| `"getIdentifier"` \| `"getUniqueIdentifier"` \|
2890
+ > `"getUniqueIdentifierId"` \| `"getIdentifiers"` \| `"getSources"` \|
2891
+ > `"getPageBreakSource"` \| `"getCoverImageItem"` \| `"getCoverImage"` \|
2892
+ > `"getPublicationDate"` \| `"getModifiedDate"` \| `"getLayout"` \|
2893
+ > `"getBaseDirection"` \| `"getType"` \| `"getSubjects"` \| `"getLanguage"` \|
2894
+ > `"getTitle"` \| `"getSubtitle"` \| `"getTitles"` \| `"getDescription"` \|
2895
+ > `"getPackageVocabularyPrefixes"` \| `"getCollections"` \| `"getCreators"` \|
2896
+ > `"getContributors"` \| `"getSpineItems"` \| `"getTableOfContents"` \|
2657
2897
  > `"getLandmarks"` \| `"getPageList"` \| `"resolveHref"` \| `"readFileContents"`
2658
- > \| `"readItemContents"` \| `"readXhtmlItemContents"` \|
2659
- > `"getItemArchiveLength"` \| `"discardAndClose"`\> & `Disposable` & `object`\>
2898
+ > \| `"readItemContents"` \| `"readXhtmlItemContents"` \| `"getVersion"` \|
2899
+ > `"getNcxTableOfContents"` \| `"getGuideEntries"` \| `"discardAndClose"`\> &
2900
+ > `Disposable` & `object`\>
2660
2901
 
2661
2902
  Defined in:
2662
- [epub/index.ts:3025](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3025)
2903
+ [libraries/epub/index.ts:3491](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3491)
2663
2904
 
2664
2905
  Open an existing EPUB through this factory's adapter
2665
2906
 
@@ -2672,18 +2913,21 @@ Open an existing EPUB through this factory's adapter
2672
2913
 
2673
2914
  ###### Returns
2674
2915
 
2675
- `Promise`\<`Pick`\<[`Epub`](#epub), `"storage"` \| `"getManifest"` \|
2676
- `"getVersion"` \| `"getLayout"` \| `"getBaseDirection"` \| `"getMetadata"` \|
2677
- `"findMetadataItem"` \| `"findAllMetadataItems"` \| `"getIdentifier"` \|
2678
- `"getTitle"` \| `"getSubtitle"` \| `"getTitles"` \| `"getLanguage"` \|
2679
- `"getPublicationDate"` \| `"getModifiedDate"` \| `"getDescription"` \|
2680
- `"getType"` \| `"getCreators"` \| `"getContributors"` \| `"getSubjects"` \|
2681
- `"getCollections"` \| `"getPackageVocabularyPrefixes"` \| `"getCoverImageItem"`
2682
- \| `"getCoverImage"` \| `"getSpineItems"` \| `"getNcxTableOfContents"` \|
2683
- `"getGuideEntries"` \| `"getTableOfContents"` \| `"getLandmarks"` \|
2916
+ `Promise`\<`Pick`\<[`Epub`](#epub), `"storage"` \| `"getItemArchiveLength"` \|
2917
+ `"getRootfile"` \| `"getPackageElement"` \| `"getManifest"` \|
2918
+ `"findMetadataItem"` \| `"findAllMetadataItems"` \| `"getMetadata"` \|
2919
+ `"getIdentifier"` \| `"getUniqueIdentifier"` \| `"getUniqueIdentifierId"` \|
2920
+ `"getIdentifiers"` \| `"getSources"` \| `"getPageBreakSource"` \|
2921
+ `"getCoverImageItem"` \| `"getCoverImage"` \| `"getPublicationDate"` \|
2922
+ `"getModifiedDate"` \| `"getLayout"` \| `"getBaseDirection"` \| `"getType"` \|
2923
+ `"getSubjects"` \| `"getLanguage"` \| `"getTitle"` \| `"getSubtitle"` \|
2924
+ `"getTitles"` \| `"getDescription"` \| `"getPackageVocabularyPrefixes"` \|
2925
+ `"getCollections"` \| `"getCreators"` \| `"getContributors"` \|
2926
+ `"getSpineItems"` \| `"getTableOfContents"` \| `"getLandmarks"` \|
2684
2927
  `"getPageList"` \| `"resolveHref"` \| `"readFileContents"` \|
2685
- `"readItemContents"` \| `"readXhtmlItemContents"` \| `"getItemArchiveLength"` \|
2686
- `"discardAndClose"`\> & `Disposable` & `object`\>
2928
+ `"readItemContents"` \| `"readXhtmlItemContents"` \| `"getVersion"` \|
2929
+ `"getNcxTableOfContents"` \| `"getGuideEntries"` \| `"discardAndClose"`\> &
2930
+ `Disposable` & `object`\>
2687
2931
 
2688
2932
  ###### Throws
2689
2933
 
@@ -2695,7 +2939,7 @@ when the archive is not a valid EPUB 3
2695
2939
  > `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\> & `object`\>
2696
2940
 
2697
2941
  Defined in:
2698
- [epub/index.ts:3029](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3029)
2942
+ [libraries/epub/index.ts:3495](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3495)
2699
2943
 
2700
2944
  Open an existing EPUB through this factory's adapter
2701
2945
 
@@ -2720,7 +2964,7 @@ when the archive is not a valid EPUB 3
2720
2964
  > `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\>\>
2721
2965
 
2722
2966
  Defined in:
2723
- [epub/index.ts:3187](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L3187)
2967
+ [libraries/epub/index.ts:3653](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3653)
2724
2968
 
2725
2969
  Upgrade an EPUB 2 publication to EPUB 3 in place using this factory's adapter,
2726
2970
  returning a new, valid Epub 3 instance.
@@ -2761,7 +3005,7 @@ when the adapter is read-only
2761
3005
  ## EpubReadOnlyError
2762
3006
 
2763
3007
  Defined in:
2764
- [epub/index.ts:238](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L238)
3008
+ [libraries/epub/index.ts:238](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L238)
2765
3009
 
2766
3010
  ### Extends
2767
3011
 
@@ -2993,7 +3237,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
2993
3237
  ## EpubVersionError
2994
3238
 
2995
3239
  Defined in:
2996
- [epub/index.ts:237](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L237)
3240
+ [libraries/epub/index.ts:237](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L237)
2997
3241
 
2998
3242
  ### Extends
2999
3243
 
@@ -3224,7 +3468,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
3224
3468
  ## MemoryAdapter
3225
3469
 
3226
3470
  Defined in:
3227
- [epub/adapters/memory.ts:32](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L32)
3471
+ [libraries/epub/adapters/memory.ts:32](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L32)
3228
3472
 
3229
3473
  Loads an EPUB archive into memory and serves all I/O off the in-memory zip
3230
3474
  handle.
@@ -3242,7 +3486,7 @@ read only
3242
3486
  > `readonly` **rootPath**: `string`
3243
3487
 
3244
3488
  Defined in:
3245
- [epub/adapters/memory.ts:71](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L71)
3489
+ [libraries/epub/adapters/memory.ts:71](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L71)
3246
3490
 
3247
3491
  Opaque path prefix used by `resolveInternalHref` to anchor absolute paths within
3248
3492
  the archive. For TmpFsAdapter this is the tmp dir; for MemoryAdapter it's a
@@ -3257,7 +3501,7 @@ virtual prefix that's never written to disk
3257
3501
  > `readonly` `static` **capabilities**: `object`
3258
3502
 
3259
3503
  Defined in:
3260
- [epub/adapters/memory.ts:34](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L34)
3504
+ [libraries/epub/adapters/memory.ts:34](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L34)
3261
3505
 
3262
3506
  ##### writable
3263
3507
 
@@ -3268,7 +3512,7 @@ Defined in:
3268
3512
  > `readonly` `static` **kind**: `"in-memory"`
3269
3513
 
3270
3514
  Defined in:
3271
- [epub/adapters/memory.ts:33](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L33)
3515
+ [libraries/epub/adapters/memory.ts:33](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L33)
3272
3516
 
3273
3517
  ### Methods
3274
3518
 
@@ -3277,7 +3521,7 @@ Defined in:
3277
3521
  > **archiveLength**(`path`): `Promise`\<`number`\>
3278
3522
 
3279
3523
  Defined in:
3280
- [epub/adapters/memory.ts:114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L114)
3524
+ [libraries/epub/adapters/memory.ts:114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L114)
3281
3525
 
3282
3526
  Length of an entry in bytes, for the readium page-count heuristic which expects
3283
3527
  compressed size when available
@@ -3301,7 +3545,7 @@ compressed size when available
3301
3545
  > **dispose**(): `void`
3302
3546
 
3303
3547
  Defined in:
3304
- [epub/adapters/memory.ts:120](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L120)
3548
+ [libraries/epub/adapters/memory.ts:120](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L120)
3305
3549
 
3306
3550
  Always called on close or error
3307
3551
 
@@ -3320,7 +3564,7 @@ Always called on close or error
3320
3564
  > **read**(`path`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
3321
3565
 
3322
3566
  Defined in:
3323
- [epub/adapters/memory.ts:85](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L85)
3567
+ [libraries/epub/adapters/memory.ts:85](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L85)
3324
3568
 
3325
3569
  ###### Parameters
3326
3570
 
@@ -3341,7 +3585,7 @@ Defined in:
3341
3585
  > **read**(`path`, `encoding`): `Promise`\<`string`\>
3342
3586
 
3343
3587
  Defined in:
3344
- [epub/adapters/memory.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L86)
3588
+ [libraries/epub/adapters/memory.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L86)
3345
3589
 
3346
3590
  ###### Parameters
3347
3591
 
@@ -3364,7 +3608,7 @@ Defined in:
3364
3608
  > `Promise`\<[`MemoryAdapter`](#memoryadapter)\>
3365
3609
 
3366
3610
  Defined in:
3367
- [epub/adapters/memory.ts:36](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L36)
3611
+ [libraries/epub/adapters/memory.ts:36](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L36)
3368
3612
 
3369
3613
  ##### Parameters
3370
3614
 
@@ -3382,7 +3626,7 @@ Defined in:
3382
3626
  ## TmpFsAdapter
3383
3627
 
3384
3628
  Defined in:
3385
- [epub/adapters/tmpfs.ts:59](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L59)
3629
+ [libraries/epub/adapters/tmpfs.ts:59](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L59)
3386
3630
 
3387
3631
  Extracts an EPUB archive to a temp directory and serves all I/O off the real
3388
3632
  filesystem. `Epub.using(TmpFsAdapter).from(...)` returns a writable
@@ -3399,7 +3643,7 @@ filesystem. `Epub.using(TmpFsAdapter).from(...)` returns a writable
3399
3643
  > `readonly` **rootPath**: `string`
3400
3644
 
3401
3645
  Defined in:
3402
- [epub/adapters/tmpfs.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L102)
3646
+ [libraries/epub/adapters/tmpfs.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L102)
3403
3647
 
3404
3648
  Opaque path prefix used by `resolveInternalHref` to anchor absolute paths within
3405
3649
  the archive. For TmpFsAdapter this is the tmp dir; for MemoryAdapter it's a
@@ -3414,7 +3658,7 @@ virtual prefix that's never written to disk
3414
3658
  > `readonly` `static` **capabilities**: `object`
3415
3659
 
3416
3660
  Defined in:
3417
- [epub/adapters/tmpfs.ts:61](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L61)
3661
+ [libraries/epub/adapters/tmpfs.ts:61](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L61)
3418
3662
 
3419
3663
  ##### writable
3420
3664
 
@@ -3425,7 +3669,7 @@ Defined in:
3425
3669
  > `readonly` `static` **kind**: `"extracted-dir"`
3426
3670
 
3427
3671
  Defined in:
3428
- [epub/adapters/tmpfs.ts:60](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L60)
3672
+ [libraries/epub/adapters/tmpfs.ts:60](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L60)
3429
3673
 
3430
3674
  ### Methods
3431
3675
 
@@ -3434,7 +3678,7 @@ Defined in:
3434
3678
  > **archiveLength**(`path`): `Promise`\<`number`\>
3435
3679
 
3436
3680
  Defined in:
3437
- [epub/adapters/tmpfs.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L125)
3681
+ [libraries/epub/adapters/tmpfs.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L125)
3438
3682
 
3439
3683
  Length of an entry in bytes, for the readium page-count heuristic which expects
3440
3684
  compressed size when available
@@ -3458,7 +3702,7 @@ compressed size when available
3458
3702
  > **dispose**(): `void`
3459
3703
 
3460
3704
  Defined in:
3461
- [epub/adapters/tmpfs.ts:198](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L198)
3705
+ [libraries/epub/adapters/tmpfs.ts:198](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L198)
3462
3706
 
3463
3707
  Always called on close or error
3464
3708
 
@@ -3475,7 +3719,7 @@ Always called on close or error
3475
3719
  > **duplicate**(): `Promise`\<[`TmpFsAdapter`](#tmpfsadapter)\>
3476
3720
 
3477
3721
  Defined in:
3478
- [epub/adapters/tmpfs.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L149)
3722
+ [libraries/epub/adapters/tmpfs.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L149)
3479
3723
 
3480
3724
  Required for Epub.copy
3481
3725
 
@@ -3492,7 +3736,7 @@ Required for Epub.copy
3492
3736
  > **list**(): `AsyncIterable`\<[`EpubListEntry`](#epublistentry)\>
3493
3737
 
3494
3738
  Defined in:
3495
- [epub/adapters/tmpfs.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L134)
3739
+ [libraries/epub/adapters/tmpfs.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L134)
3496
3740
 
3497
3741
  Required for Epub.saveAndClose to walk the contents
3498
3742
 
@@ -3511,7 +3755,7 @@ Required for Epub.saveAndClose to walk the contents
3511
3755
  > **read**(`path`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
3512
3756
 
3513
3757
  Defined in:
3514
- [epub/adapters/tmpfs.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L104)
3758
+ [libraries/epub/adapters/tmpfs.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L104)
3515
3759
 
3516
3760
  ###### Parameters
3517
3761
 
@@ -3532,7 +3776,7 @@ Defined in:
3532
3776
  > **read**(`path`, `encoding`): `Promise`\<`string`\>
3533
3777
 
3534
3778
  Defined in:
3535
- [epub/adapters/tmpfs.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L105)
3779
+ [libraries/epub/adapters/tmpfs.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L105)
3536
3780
 
3537
3781
  ###### Parameters
3538
3782
 
@@ -3554,7 +3798,7 @@ Defined in:
3554
3798
  > **remove**(`path`): `Promise`\<`void`\>
3555
3799
 
3556
3800
  Defined in:
3557
- [epub/adapters/tmpfs.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L121)
3801
+ [libraries/epub/adapters/tmpfs.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L121)
3558
3802
 
3559
3803
  Required for removeManifestItem / setCoverImage replacement
3560
3804
 
@@ -3577,7 +3821,7 @@ Required for removeManifestItem / setCoverImage replacement
3577
3821
  > **serialize**(`targetPath`): `Promise`\<`void`\>
3578
3822
 
3579
3823
  Defined in:
3580
- [epub/adapters/tmpfs.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L160)
3824
+ [libraries/epub/adapters/tmpfs.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L160)
3581
3825
 
3582
3826
  Required for Epub.saveAndClose
3583
3827
 
@@ -3602,7 +3846,7 @@ Required for Epub.saveAndClose
3602
3846
  > **write**(`path`, `data`): `Promise`\<`void`\>
3603
3847
 
3604
3848
  Defined in:
3605
- [epub/adapters/tmpfs.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L110)
3849
+ [libraries/epub/adapters/tmpfs.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L110)
3606
3850
 
3607
3851
  Required for any mutation method on Epub
3608
3852
 
@@ -3626,7 +3870,7 @@ Required for any mutation method on Epub
3626
3870
  > **write**(`path`, `data`, `encoding`): `Promise`\<`void`\>
3627
3871
 
3628
3872
  Defined in:
3629
- [epub/adapters/tmpfs.ts:111](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L111)
3873
+ [libraries/epub/adapters/tmpfs.ts:111](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L111)
3630
3874
 
3631
3875
  ###### Parameters
3632
3876
 
@@ -3649,7 +3893,7 @@ Defined in:
3649
3893
  > `static` **init**(`source`): `Promise`\<[`TmpFsAdapter`](#tmpfsadapter)\>
3650
3894
 
3651
3895
  Defined in:
3652
- [epub/adapters/tmpfs.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L63)
3896
+ [libraries/epub/adapters/tmpfs.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L63)
3653
3897
 
3654
3898
  ##### Parameters
3655
3899
 
@@ -3666,7 +3910,7 @@ Defined in:
3666
3910
  > `static` **initEmpty**(): `Promise`\<[`TmpFsAdapter`](#tmpfsadapter)\>
3667
3911
 
3668
3912
  Defined in:
3669
- [epub/adapters/tmpfs.ts:96](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/tmpfs.ts#L96)
3913
+ [libraries/epub/adapters/tmpfs.ts:96](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L96)
3670
3914
 
3671
3915
  ##### Returns
3672
3916
 
@@ -3677,7 +3921,7 @@ Defined in:
3677
3921
  ## AlternateScript
3678
3922
 
3679
3923
  Defined in:
3680
- [epub/index.ts:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L127)
3924
+ [libraries/epub/index.ts:154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L154)
3681
3925
 
3682
3926
  ### Properties
3683
3927
 
@@ -3686,21 +3930,21 @@ Defined in:
3686
3930
  > **locale**: `Locale`
3687
3931
 
3688
3932
  Defined in:
3689
- [epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
3933
+ [libraries/epub/index.ts:156](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L156)
3690
3934
 
3691
3935
  #### name
3692
3936
 
3693
3937
  > **name**: `string`
3694
3938
 
3695
3939
  Defined in:
3696
- [epub/index.ts:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L128)
3940
+ [libraries/epub/index.ts:155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L155)
3697
3941
 
3698
3942
  ---
3699
3943
 
3700
3944
  ## Collection
3701
3945
 
3702
3946
  Defined in:
3703
- [epub/index.ts:151](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L151)
3947
+ [libraries/epub/index.ts:178](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L178)
3704
3948
 
3705
3949
  ### Properties
3706
3950
 
@@ -3709,28 +3953,28 @@ Defined in:
3709
3953
  > **name**: `string`
3710
3954
 
3711
3955
  Defined in:
3712
- [epub/index.ts:152](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L152)
3956
+ [libraries/epub/index.ts:179](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L179)
3713
3957
 
3714
3958
  #### position?
3715
3959
 
3716
3960
  > `optional` **position**: `string`
3717
3961
 
3718
3962
  Defined in:
3719
- [epub/index.ts:154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L154)
3963
+ [libraries/epub/index.ts:181](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L181)
3720
3964
 
3721
3965
  #### type?
3722
3966
 
3723
3967
  > `optional` **type**: `string`
3724
3968
 
3725
3969
  Defined in:
3726
- [epub/index.ts:153](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L153)
3970
+ [libraries/epub/index.ts:180](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L180)
3727
3971
 
3728
3972
  ---
3729
3973
 
3730
3974
  ## DcCreator
3731
3975
 
3732
3976
  Defined in:
3733
- [epub/index.ts:132](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L132)
3977
+ [libraries/epub/index.ts:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L159)
3734
3978
 
3735
3979
  ### Properties
3736
3980
 
@@ -3739,42 +3983,42 @@ Defined in:
3739
3983
  > `optional` **alternateScripts**: [`AlternateScript`](#alternatescript)[]
3740
3984
 
3741
3985
  Defined in:
3742
- [epub/index.ts:137](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L137)
3986
+ [libraries/epub/index.ts:164](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L164)
3743
3987
 
3744
3988
  #### fileAs?
3745
3989
 
3746
3990
  > `optional` **fileAs**: `string`
3747
3991
 
3748
3992
  Defined in:
3749
- [epub/index.ts:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L136)
3993
+ [libraries/epub/index.ts:163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L163)
3750
3994
 
3751
3995
  #### name
3752
3996
 
3753
3997
  > **name**: `string`
3754
3998
 
3755
3999
  Defined in:
3756
- [epub/index.ts:133](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L133)
4000
+ [libraries/epub/index.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L160)
3757
4001
 
3758
4002
  #### role?
3759
4003
 
3760
4004
  > `optional` **role**: `string`
3761
4005
 
3762
4006
  Defined in:
3763
- [epub/index.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L134)
4007
+ [libraries/epub/index.ts:161](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L161)
3764
4008
 
3765
4009
  #### roleScheme?
3766
4010
 
3767
4011
  > `optional` **roleScheme**: `string`
3768
4012
 
3769
4013
  Defined in:
3770
- [epub/index.ts:135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L135)
4014
+ [libraries/epub/index.ts:162](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L162)
3771
4015
 
3772
4016
  ---
3773
4017
 
3774
4018
  ## DcSubject
3775
4019
 
3776
4020
  Defined in:
3777
- [epub/index.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L121)
4021
+ [libraries/epub/index.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L121)
3778
4022
 
3779
4023
  ### Properties
3780
4024
 
@@ -3783,28 +4027,28 @@ Defined in:
3783
4027
  > **authority**: `string`
3784
4028
 
3785
4029
  Defined in:
3786
- [epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L123)
4030
+ [libraries/epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L123)
3787
4031
 
3788
4032
  #### term
3789
4033
 
3790
4034
  > **term**: `string`
3791
4035
 
3792
4036
  Defined in:
3793
- [epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L124)
4037
+ [libraries/epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L124)
3794
4038
 
3795
4039
  #### value
3796
4040
 
3797
4041
  > **value**: `string`
3798
4042
 
3799
4043
  Defined in:
3800
- [epub/index.ts:122](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L122)
4044
+ [libraries/epub/index.ts:122](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L122)
3801
4045
 
3802
4046
  ---
3803
4047
 
3804
4048
  ## DublinCore
3805
4049
 
3806
4050
  Defined in:
3807
- [epub/index.ts:140](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L140)
4051
+ [libraries/epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L167)
3808
4052
 
3809
4053
  ### Properties
3810
4054
 
@@ -3813,63 +4057,63 @@ Defined in:
3813
4057
  > `optional` **contributors**: [`DcCreator`](#dccreator)[]
3814
4058
 
3815
4059
  Defined in:
3816
- [epub/index.ts:147](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L147)
4060
+ [libraries/epub/index.ts:174](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L174)
3817
4061
 
3818
4062
  #### creators?
3819
4063
 
3820
4064
  > `optional` **creators**: [`DcCreator`](#dccreator)[]
3821
4065
 
3822
4066
  Defined in:
3823
- [epub/index.ts:146](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L146)
4067
+ [libraries/epub/index.ts:173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L173)
3824
4068
 
3825
4069
  #### date?
3826
4070
 
3827
4071
  > `optional` **date**: `Date`
3828
4072
 
3829
4073
  Defined in:
3830
- [epub/index.ts:144](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L144)
4074
+ [libraries/epub/index.ts:171](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L171)
3831
4075
 
3832
4076
  #### identifier
3833
4077
 
3834
4078
  > **identifier**: `string`
3835
4079
 
3836
4080
  Defined in:
3837
- [epub/index.ts:143](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L143)
4081
+ [libraries/epub/index.ts:170](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L170)
3838
4082
 
3839
4083
  #### language
3840
4084
 
3841
4085
  > **language**: `Locale`
3842
4086
 
3843
4087
  Defined in:
3844
- [epub/index.ts:142](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L142)
4088
+ [libraries/epub/index.ts:169](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L169)
3845
4089
 
3846
4090
  #### subjects?
3847
4091
 
3848
4092
  > `optional` **subjects**: (`string` \| [`DcSubject`](#dcsubject))[]
3849
4093
 
3850
4094
  Defined in:
3851
- [epub/index.ts:145](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L145)
4095
+ [libraries/epub/index.ts:172](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L172)
3852
4096
 
3853
4097
  #### title
3854
4098
 
3855
4099
  > **title**: `string`
3856
4100
 
3857
4101
  Defined in:
3858
- [epub/index.ts:141](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L141)
4102
+ [libraries/epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L168)
3859
4103
 
3860
4104
  #### type?
3861
4105
 
3862
4106
  > `optional` **type**: `string`
3863
4107
 
3864
4108
  Defined in:
3865
- [epub/index.ts:148](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L148)
4109
+ [libraries/epub/index.ts:175](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L175)
3866
4110
 
3867
4111
  ---
3868
4112
 
3869
4113
  ## Epub2UpgradeOptions
3870
4114
 
3871
4115
  Defined in:
3872
- [epub/upgrade.ts:93](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/upgrade.ts#L93)
4116
+ [libraries/epub/upgrade.ts:93](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L93)
3873
4117
 
3874
4118
  ### Properties
3875
4119
 
@@ -3878,7 +4122,7 @@ Defined in:
3878
4122
  > `optional` **outputPath**: `string`
3879
4123
 
3880
4124
  Defined in:
3881
- [epub/upgrade.ts:97](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/upgrade.ts#L97)
4125
+ [libraries/epub/upgrade.ts:97](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L97)
3882
4126
 
3883
4127
  The path to the output file. If provided, the input file will be copied to the
3884
4128
  output path.
@@ -3888,16 +4132,58 @@ output path.
3888
4132
  > `optional` **removeNcx**: `boolean`
3889
4133
 
3890
4134
  Defined in:
3891
- [epub/upgrade.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/upgrade.ts#L101)
4135
+ [libraries/epub/upgrade.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L101)
3892
4136
 
3893
4137
  Whether to remove the NCX file, as it's technically optional in EPUB 3.
3894
4138
 
3895
4139
  ---
3896
4140
 
4141
+ ## EpubIdentifier
4142
+
4143
+ Defined in:
4144
+ [libraries/epub/index.ts:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L127)
4145
+
4146
+ ### Properties
4147
+
4148
+ #### id?
4149
+
4150
+ > `optional` **id**: `string`
4151
+
4152
+ Defined in:
4153
+ [libraries/epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L129)
4154
+
4155
+ #### identifierType?
4156
+
4157
+ > `optional` **identifierType**: `string`
4158
+
4159
+ Defined in:
4160
+ [libraries/epub/index.ts:131](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L131)
4161
+
4162
+ the value of a refining `identifier-type` meta, if present
4163
+
4164
+ #### scheme?
4165
+
4166
+ > `optional` **scheme**: `string`
4167
+
4168
+ Defined in:
4169
+ [libraries/epub/index.ts:133](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L133)
4170
+
4171
+ the `scheme` of a refining `identifier-type` meta, or a legacy `opf:scheme`
4172
+ attribute
4173
+
4174
+ #### value
4175
+
4176
+ > **value**: `string`
4177
+
4178
+ Defined in:
4179
+ [libraries/epub/index.ts:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L128)
4180
+
4181
+ ---
4182
+
3897
4183
  ## EpubListEntry
3898
4184
 
3899
4185
  Defined in:
3900
- [epub/adapters/interface.ts:17](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L17)
4186
+ [libraries/epub/adapters/interface.ts:17](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L17)
3901
4187
 
3902
4188
  ### Properties
3903
4189
 
@@ -3906,7 +4192,7 @@ Defined in:
3906
4192
  > **absolutePath**: `string`
3907
4193
 
3908
4194
  Defined in:
3909
- [epub/adapters/interface.ts:19](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L19)
4195
+ [libraries/epub/adapters/interface.ts:19](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L19)
3910
4196
 
3911
4197
  absolute path under [EpubStorageAdapter.rootPath](#rootpath-2)
3912
4198
 
@@ -3915,16 +4201,72 @@ absolute path under [EpubStorageAdapter.rootPath](#rootpath-2)
3915
4201
  > **relativePath**: `string`
3916
4202
 
3917
4203
  Defined in:
3918
- [epub/adapters/interface.ts:21](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L21)
4204
+ [libraries/epub/adapters/interface.ts:21](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L21)
3919
4205
 
3920
4206
  path relative to [EpubStorageAdapter.rootPath](#rootpath-2), slash-separated
3921
4207
 
3922
4208
  ---
3923
4209
 
4210
+ ## EpubSource
4211
+
4212
+ Defined in:
4213
+ [libraries/epub/index.ts:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L136)
4214
+
4215
+ ### Properties
4216
+
4217
+ #### id?
4218
+
4219
+ > `optional` **id**: `string`
4220
+
4221
+ Defined in:
4222
+ [libraries/epub/index.ts:138](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L138)
4223
+
4224
+ #### identifierType?
4225
+
4226
+ > `optional` **identifierType**: `string`
4227
+
4228
+ Defined in:
4229
+ [libraries/epub/index.ts:140](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L140)
4230
+
4231
+ the value of a refining `identifier-type` meta, if present
4232
+
4233
+ #### isPageBreakSource?
4234
+
4235
+ > `optional` **isPageBreakSource**: `boolean`
4236
+
4237
+ Defined in:
4238
+ [libraries/epub/index.ts:151](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L151)
4239
+
4240
+ whether this source has a `source-of="pagination"` refinement or of a
4241
+ `<meta property="pageBreakSource">` element
4242
+
4243
+ as of EPUB 3.4 `source-of` is advised-deprecated in favour of the
4244
+ publication-level `pageBreakSource` property. if you want to be sure to get the
4245
+ source of pagination, use [Epub.getPageBreakSource](#getpagebreaksource)
4246
+
4247
+ #### scheme?
4248
+
4249
+ > `optional` **scheme**: `string`
4250
+
4251
+ Defined in:
4252
+ [libraries/epub/index.ts:142](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L142)
4253
+
4254
+ the `scheme` of a refining `identifier-type` meta, or a legacy `opf:scheme`
4255
+ attribute
4256
+
4257
+ #### value
4258
+
4259
+ > **value**: `string`
4260
+
4261
+ Defined in:
4262
+ [libraries/epub/index.ts:137](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L137)
4263
+
4264
+ ---
4265
+
3924
4266
  ## EpubStorageAdapter
3925
4267
 
3926
4268
  Defined in:
3927
- [epub/adapters/interface.ts:24](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L24)
4269
+ [libraries/epub/adapters/interface.ts:24](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L24)
3928
4270
 
3929
4271
  ### Properties
3930
4272
 
@@ -3933,7 +4275,7 @@ Defined in:
3933
4275
  > `readonly` **rootPath**: `string`
3934
4276
 
3935
4277
  Defined in:
3936
- [epub/adapters/interface.ts:30](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L30)
4278
+ [libraries/epub/adapters/interface.ts:30](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L30)
3937
4279
 
3938
4280
  Opaque path prefix used by `resolveInternalHref` to anchor absolute paths within
3939
4281
  the archive. For TmpFsAdapter this is the tmp dir; for MemoryAdapter it's a
@@ -3946,7 +4288,7 @@ virtual prefix that's never written to disk
3946
4288
  > **archiveLength**(`path`): `Promise`\<`number`\>
3947
4289
 
3948
4290
  Defined in:
3949
- [epub/adapters/interface.ts:39](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L39)
4291
+ [libraries/epub/adapters/interface.ts:39](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L39)
3950
4292
 
3951
4293
  Length of an entry in bytes, for the readium page-count heuristic which expects
3952
4294
  compressed size when available
@@ -3966,7 +4308,7 @@ compressed size when available
3966
4308
  > **dispose**(): `void` \| `Promise`\<`void`\>
3967
4309
 
3968
4310
  Defined in:
3969
- [epub/adapters/interface.ts:58](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L58)
4311
+ [libraries/epub/adapters/interface.ts:58](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L58)
3970
4312
 
3971
4313
  Always called on close or error
3972
4314
 
@@ -3980,7 +4322,7 @@ Always called on close or error
3980
4322
  > `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
3981
4323
 
3982
4324
  Defined in:
3983
- [epub/adapters/interface.ts:52](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L52)
4325
+ [libraries/epub/adapters/interface.ts:52](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L52)
3984
4326
 
3985
4327
  Required for Epub.copy
3986
4328
 
@@ -3993,7 +4335,7 @@ Required for Epub.copy
3993
4335
  > `optional` **list**(): `AsyncIterable`\<[`EpubListEntry`](#epublistentry)\>
3994
4336
 
3995
4337
  Defined in:
3996
- [epub/adapters/interface.ts:49](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L49)
4338
+ [libraries/epub/adapters/interface.ts:49](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L49)
3997
4339
 
3998
4340
  Required for Epub.saveAndClose to walk the contents
3999
4341
 
@@ -4008,7 +4350,7 @@ Required for Epub.saveAndClose to walk the contents
4008
4350
  > **read**(`path`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
4009
4351
 
4010
4352
  Defined in:
4011
- [epub/adapters/interface.ts:32](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L32)
4353
+ [libraries/epub/adapters/interface.ts:32](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L32)
4012
4354
 
4013
4355
  ###### Parameters
4014
4356
 
@@ -4025,7 +4367,7 @@ Defined in:
4025
4367
  > **read**(`path`, `encoding`): `Promise`\<`string`\>
4026
4368
 
4027
4369
  Defined in:
4028
- [epub/adapters/interface.ts:33](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L33)
4370
+ [libraries/epub/adapters/interface.ts:33](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L33)
4029
4371
 
4030
4372
  ###### Parameters
4031
4373
 
@@ -4043,7 +4385,7 @@ Defined in:
4043
4385
  > `optional` **remove**(`path`): `Promise`\<`void`\>
4044
4386
 
4045
4387
  Defined in:
4046
- [epub/adapters/interface.ts:46](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L46)
4388
+ [libraries/epub/adapters/interface.ts:46](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L46)
4047
4389
 
4048
4390
  Required for removeManifestItem / setCoverImage replacement
4049
4391
 
@@ -4062,7 +4404,7 @@ Required for removeManifestItem / setCoverImage replacement
4062
4404
  > `optional` **serialize**(`targetPath`): `Promise`\<`void`\>
4063
4405
 
4064
4406
  Defined in:
4065
- [epub/adapters/interface.ts:55](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L55)
4407
+ [libraries/epub/adapters/interface.ts:55](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L55)
4066
4408
 
4067
4409
  Required for Epub.saveAndClose
4068
4410
 
@@ -4083,7 +4425,7 @@ Required for Epub.saveAndClose
4083
4425
  > `optional` **write**(`path`, `data`): `Promise`\<`void`\>
4084
4426
 
4085
4427
  Defined in:
4086
- [epub/adapters/interface.ts:42](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L42)
4428
+ [libraries/epub/adapters/interface.ts:42](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L42)
4087
4429
 
4088
4430
  Required for any mutation method on Epub
4089
4431
 
@@ -4103,7 +4445,7 @@ Required for any mutation method on Epub
4103
4445
  > `optional` **write**(`path`, `data`, `encoding`): `Promise`\<`void`\>
4104
4446
 
4105
4447
  Defined in:
4106
- [epub/adapters/interface.ts:43](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L43)
4448
+ [libraries/epub/adapters/interface.ts:43](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L43)
4107
4449
 
4108
4450
  ###### Parameters
4109
4451
 
@@ -4122,7 +4464,7 @@ Defined in:
4122
4464
  ## EpubStorageAdapterClass\<Opts\>
4123
4465
 
4124
4466
  Defined in:
4125
- [epub/adapters/interface.ts:61](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L61)
4467
+ [libraries/epub/adapters/interface.ts:61](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L61)
4126
4468
 
4127
4469
  ### Type Parameters
4128
4470
 
@@ -4138,14 +4480,14 @@ Defined in:
4138
4480
  > [`EpubStorageCapabilities`](#epubstoragecapabilities)
4139
4481
 
4140
4482
  Defined in:
4141
- [epub/adapters/interface.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L63)
4483
+ [libraries/epub/adapters/interface.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L63)
4142
4484
 
4143
4485
  #### kind
4144
4486
 
4145
4487
  > `readonly` **kind**: [`EpubStorageKind`](#epubstoragekind)
4146
4488
 
4147
4489
  Defined in:
4148
- [epub/adapters/interface.ts:62](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L62)
4490
+ [libraries/epub/adapters/interface.ts:62](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L62)
4149
4491
 
4150
4492
  ### Methods
4151
4493
 
@@ -4155,7 +4497,7 @@ Defined in:
4155
4497
  > `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4156
4498
 
4157
4499
  Defined in:
4158
- [epub/adapters/interface.ts:70](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L70)
4500
+ [libraries/epub/adapters/interface.ts:70](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L70)
4159
4501
 
4160
4502
  Open an archive from a path or buffer. The returned adapter is ready to read;
4161
4503
  the Epub class will assert it's a valid EPUB 3 afterwards.
@@ -4177,7 +4519,7 @@ the Epub class will assert it's a valid EPUB 3 afterwards.
4177
4519
  > `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4178
4520
 
4179
4521
  Defined in:
4180
- [epub/adapters/interface.ts:79](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L79)
4522
+ [libraries/epub/adapters/interface.ts:79](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L79)
4181
4523
 
4182
4524
  Initialize an empty extract root for [Epub.create](#create).
4183
4525
 
@@ -4199,7 +4541,7 @@ handles) should leave this off, and `Epub.using(...).create(...)` will throw.
4199
4541
  ## EpubStorageCapabilities
4200
4542
 
4201
4543
  Defined in:
4202
- [epub/adapters/interface.ts:12](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L12)
4544
+ [libraries/epub/adapters/interface.ts:12](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L12)
4203
4545
 
4204
4546
  ### Properties
4205
4547
 
@@ -4208,7 +4550,7 @@ Defined in:
4208
4550
  > `readonly` **writable**: `boolean`
4209
4551
 
4210
4552
  Defined in:
4211
- [epub/adapters/interface.ts:14](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/interface.ts#L14)
4553
+ [libraries/epub/adapters/interface.ts:14](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L14)
4212
4554
 
4213
4555
  when false, the Epub class refuses every mutation method at runtime
4214
4556
 
@@ -4217,7 +4559,7 @@ when false, the Epub class refuses every mutation method at runtime
4217
4559
  ## FromOptions
4218
4560
 
4219
4561
  Defined in:
4220
- [epub/index.ts:178](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L178)
4562
+ [libraries/epub/index.ts:205](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L205)
4221
4563
 
4222
4564
  ### Properties
4223
4565
 
@@ -4226,7 +4568,7 @@ Defined in:
4226
4568
  > `optional` **readonly**: `boolean`
4227
4569
 
4228
4570
  Defined in:
4229
- [epub/index.ts:183](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L183)
4571
+ [libraries/epub/index.ts:210](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L210)
4230
4572
 
4231
4573
  when true, mutation methods throw [EpubReadOnlyError](#epubreadonlyerror) at
4232
4574
  runtime
@@ -4242,7 +4584,7 @@ false
4242
4584
  ## Landmark
4243
4585
 
4244
4586
  Defined in:
4245
- [epub/upgrade.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/upgrade.ts#L87)
4587
+ [libraries/epub/upgrade.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L87)
4246
4588
 
4247
4589
  ### Properties
4248
4590
 
@@ -4251,28 +4593,28 @@ Defined in:
4251
4593
  > **href**: `string`
4252
4594
 
4253
4595
  Defined in:
4254
- [epub/upgrade.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/upgrade.ts#L88)
4596
+ [libraries/epub/upgrade.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L88)
4255
4597
 
4256
4598
  #### title
4257
4599
 
4258
4600
  > **title**: `string`
4259
4601
 
4260
4602
  Defined in:
4261
- [epub/upgrade.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/upgrade.ts#L89)
4603
+ [libraries/epub/upgrade.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L89)
4262
4604
 
4263
4605
  #### type
4264
4606
 
4265
4607
  > **type**: `string`
4266
4608
 
4267
4609
  Defined in:
4268
- [epub/upgrade.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/upgrade.ts#L90)
4610
+ [libraries/epub/upgrade.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L90)
4269
4611
 
4270
4612
  ---
4271
4613
 
4272
4614
  ## MemoryAdapterOptions
4273
4615
 
4274
4616
  Defined in:
4275
- [epub/adapters/memory.ts:15](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L15)
4617
+ [libraries/epub/adapters/memory.ts:15](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L15)
4276
4618
 
4277
4619
  ### Properties
4278
4620
 
@@ -4281,7 +4623,360 @@ Defined in:
4281
4623
  > `optional` **cache**: `boolean`
4282
4624
 
4283
4625
  Defined in:
4284
- [epub/adapters/memory.ts:22](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/adapters/memory.ts#L22)
4626
+ [libraries/epub/adapters/memory.ts:22](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L22)
4285
4627
 
4286
4628
  per-entry decompressed buffer cache turn it off when opening many EPUBs and
4287
- reading eac
4629
+ reading each entry at most once keeps resident size bounded by the entry index,
4630
+ not the decompressed payload sum
4631
+
4632
+ ##### Default
4633
+
4634
+ ```ts
4635
+ true
4636
+ ```
4637
+
4638
+ #### signal?
4639
+
4640
+ > `optional` **signal**: `AbortSignal`
4641
+
4642
+ Defined in:
4643
+ [libraries/epub/adapters/memory.ts:23](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L23)
4644
+
4645
+ ---
4646
+
4647
+ ## Navigation
4648
+
4649
+ Defined in:
4650
+ [libraries/epub/index.ts:192](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L192)
4651
+
4652
+ ### Properties
4653
+
4654
+ #### children
4655
+
4656
+ > **children**: [`NavigationList`](#navigationlist)
4657
+
4658
+ Defined in:
4659
+ [libraries/epub/index.ts:194](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L194)
4660
+
4661
+ #### title?
4662
+
4663
+ > `optional` **title**: `string`
4664
+
4665
+ Defined in:
4666
+ [libraries/epub/index.ts:193](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L193)
4667
+
4668
+ ---
4669
+
4670
+ ## NavigationItem
4671
+
4672
+ Defined in:
4673
+ [libraries/epub/index.ts:184](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L184)
4674
+
4675
+ ### Properties
4676
+
4677
+ #### children?
4678
+
4679
+ > `optional` **children**: [`NavigationList`](#navigationlist)
4680
+
4681
+ Defined in:
4682
+ [libraries/epub/index.ts:187](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L187)
4683
+
4684
+ #### href?
4685
+
4686
+ > `optional` **href**: `string`
4687
+
4688
+ Defined in:
4689
+ [libraries/epub/index.ts:186](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L186)
4690
+
4691
+ #### title
4692
+
4693
+ > **title**: `string`
4694
+
4695
+ Defined in:
4696
+ [libraries/epub/index.ts:185](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L185)
4697
+
4698
+ ---
4699
+
4700
+ ## AdapterOptions\<A\>
4701
+
4702
+ > **AdapterOptions**\<`A`\> = `A` _extends_
4703
+ > [`EpubStorageAdapterClass`](#epubstorageadapterclass)\<infer Opts\> ? `Opts` :
4704
+ > `object`
4705
+
4706
+ Defined in:
4707
+ [libraries/epub/adapters/interface.ts:82](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L82)
4708
+
4709
+ ### Type Parameters
4710
+
4711
+ | Type Parameter |
4712
+ | -------------- |
4713
+ | `A` |
4714
+
4715
+ ---
4716
+
4717
+ ## ElementName
4718
+
4719
+ > **ElementName** =
4720
+ > \`$\{Letter \| Uppercase\<Letter\> \| QuestionMark\}$\{string\}\`
4721
+
4722
+ Defined in:
4723
+ [libraries/epub/index.ts:82](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L82)
4724
+
4725
+ A valid name for an XML element (must start with a letter)
4726
+
4727
+ ---
4728
+
4729
+ ## EpubInstanceFor\<A\>
4730
+
4731
+ > **EpubInstanceFor**\<`A`\> = `A`\[`"capabilities"`\]\[`"writable"`\] _extends_
4732
+ > `true` ? [`Epub`](#epub) : [`EpubReader`](#epubreader)
4733
+
4734
+ Defined in:
4735
+ [libraries/epub/index.ts:3472](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3472)
4736
+
4737
+ Resolves to [Epub](#epub) for writable adapters, [EpubReader](#epubreader) for
4738
+ read-only ones.
4739
+
4740
+ The conditional pivots on `capabilities.writable`, which must be a literal
4741
+ `true`/`false` on the adapter class (use `as const`) for inference to work.
4742
+
4743
+ ### Type Parameters
4744
+
4745
+ | Type Parameter |
4746
+ | ------------------------------------------------------------------- |
4747
+ | `A` _extends_ [`EpubStorageAdapterClass`](#epubstorageadapterclass) |
4748
+
4749
+ ---
4750
+
4751
+ ## EpubMetadata
4752
+
4753
+ > **EpubMetadata** = [`MetadataEntry`](#metadataentry)[]
4754
+
4755
+ Defined in:
4756
+ [libraries/epub/index.ts:119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L119)
4757
+
4758
+ ---
4759
+
4760
+ ## EpubReader
4761
+
4762
+ > **EpubReader** = `Pick`\<[`Epub`](#epub), `"storage"` \| `"findMetadataItem"`
4763
+ > \| `"findAllMetadataItems"` \| `"resolveHref"` \| `"readFileContents"` \|
4764
+ > `"readItemContents"` \| `"readXhtmlItemContents"` \| `"discardAndClose"` \|
4765
+ > `Extract`\<keyof [`Epub`](#epub), `` `get${string}` ``\>\> & `Disposable`
4766
+
4767
+ Defined in:
4768
+ [libraries/epub/index.ts:217](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L217)
4769
+
4770
+ Read-only view of an EPUB Returned by Epub.using(MemoryAdapter).from(...) and by
4771
+ Epub.from(path, { readonly: true })
4772
+
4773
+ ---
4774
+
4775
+ ## EpubStorageKind
4776
+
4777
+ > **EpubStorageKind** = `"tmp-dir"` \| `"in-memory"` \| `string` & `object`
4778
+
4779
+ Defined in:
4780
+ [libraries/epub/adapters/interface.ts:10](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L10)
4781
+
4782
+ Pluggable storage backend for an Epub instance
4783
+
4784
+ Built-in adapters:
4785
+
4786
+ - [TmpFsAdapter](#tmpfsadapter) extracts the archive to a tmp directory and
4787
+ supports the full read/write/save/upgrade
4788
+ - [MemoryAdapter](#memoryadapter) keeps an in-memory zip handle and supports
4789
+ reads only
4790
+
4791
+ ---
4792
+
4793
+ ## InMemoryEpubReader
4794
+
4795
+ > **InMemoryEpubReader** = [`EpubReader`](#epubreader) & `object`
4796
+
4797
+ Defined in:
4798
+ [libraries/epub/index.ts:235](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L235)
4799
+
4800
+ Readonly Epub-instance backed by an in-memory zip handle Returned by
4801
+ `Epub.using(MemoryAdapter).from(...)`
4802
+
4803
+ ### Type Declaration
4804
+
4805
+ #### storage
4806
+
4807
+ > `readonly` **storage**: `"in-memory"`
4808
+
4809
+ ---
4810
+
4811
+ ## ManifestItem
4812
+
4813
+ > **ManifestItem** = `object`
4814
+
4815
+ Defined in:
4816
+ [libraries/epub/index.ts:103](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L103)
4817
+
4818
+ ### Properties
4819
+
4820
+ #### fallback?
4821
+
4822
+ > `optional` **fallback**: `string`
4823
+
4824
+ Defined in:
4825
+ [libraries/epub/index.ts:107](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L107)
4826
+
4827
+ #### href
4828
+
4829
+ > **href**: `string`
4830
+
4831
+ Defined in:
4832
+ [libraries/epub/index.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L105)
4833
+
4834
+ #### id
4835
+
4836
+ > **id**: `string`
4837
+
4838
+ Defined in:
4839
+ [libraries/epub/index.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L104)
4840
+
4841
+ #### mediaOverlay?
4842
+
4843
+ > `optional` **mediaOverlay**: `string`
4844
+
4845
+ Defined in:
4846
+ [libraries/epub/index.ts:108](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L108)
4847
+
4848
+ #### mediaType?
4849
+
4850
+ > `optional` **mediaType**: `string`
4851
+
4852
+ Defined in:
4853
+ [libraries/epub/index.ts:106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L106)
4854
+
4855
+ #### properties?
4856
+
4857
+ > `optional` **properties**: `string`[]
4858
+
4859
+ Defined in:
4860
+ [libraries/epub/index.ts:109](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L109)
4861
+
4862
+ ---
4863
+
4864
+ ## MetadataEntry
4865
+
4866
+ > **MetadataEntry** = `object`
4867
+
4868
+ Defined in:
4869
+ [libraries/epub/index.ts:112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L112)
4870
+
4871
+ ### Properties
4872
+
4873
+ #### id?
4874
+
4875
+ > `optional` **id**: `string`
4876
+
4877
+ Defined in:
4878
+ [libraries/epub/index.ts:113](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L113)
4879
+
4880
+ #### properties
4881
+
4882
+ > **properties**: `Record`\<`string`, `string`\>
4883
+
4884
+ Defined in:
4885
+ [libraries/epub/index.ts:115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L115)
4886
+
4887
+ #### type
4888
+
4889
+ > **type**: [`ElementName`](#elementname)
4890
+
4891
+ Defined in:
4892
+ [libraries/epub/index.ts:114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L114)
4893
+
4894
+ #### value
4895
+
4896
+ > **value**: `string` \| `undefined`
4897
+
4898
+ Defined in:
4899
+ [libraries/epub/index.ts:116](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L116)
4900
+
4901
+ ---
4902
+
4903
+ ## NavigationList
4904
+
4905
+ > **NavigationList** = [`NavigationItem`](#navigationitem)[]
4906
+
4907
+ Defined in:
4908
+ [libraries/epub/index.ts:190](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L190)
4909
+
4910
+ ---
4911
+
4912
+ ## PackageElement
4913
+
4914
+ > **PackageElement** = [`XmlElement`](#xmlelement)\<`"package"`\>
4915
+
4916
+ Defined in:
4917
+ [libraries/epub/index.ts:203](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L203)
4918
+
4919
+ ---
4920
+
4921
+ ## ParsedXml
4922
+
4923
+ > **ParsedXml** = [`XmlNode`](#xmlnode)[]
4924
+
4925
+ Defined in:
4926
+ [libraries/epub/index.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L101)
4927
+
4928
+ An XML structure
4929
+
4930
+ ---
4931
+
4932
+ ## XmlElement\<Name\>
4933
+
4934
+ > **XmlElement**\<`Name`\> = `object` & `{ [key in Name]: ParsedXml }`
4935
+
4936
+ Defined in:
4937
+ [libraries/epub/index.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L88)
4938
+
4939
+ An XML element
4940
+
4941
+ ### Type Declaration
4942
+
4943
+ #### :@?
4944
+
4945
+ > `optional` **:@**: `Record`\<`` `${PropertyPrefix}${string}` ``, `string`\>
4946
+
4947
+ ### Type Parameters
4948
+
4949
+ | Type Parameter | Default type |
4950
+ | ---------------------------------------------- | ----------------------------- |
4951
+ | `Name` _extends_ [`ElementName`](#elementname) | [`ElementName`](#elementname) |
4952
+
4953
+ ---
4954
+
4955
+ ## XmlNode
4956
+
4957
+ > **XmlNode** = [`XmlElement`](#xmlelement) \| [`XmlTextNode`](#xmltextnode)
4958
+
4959
+ Defined in:
4960
+ [libraries/epub/index.ts:98](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L98)
4961
+
4962
+ A valid XML node. May be either an element or a text node.
4963
+
4964
+ ---
4965
+
4966
+ ## XmlTextNode
4967
+
4968
+ > **XmlTextNode** = `object`
4969
+
4970
+ Defined in:
4971
+ [libraries/epub/index.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L95)
4972
+
4973
+ A text node in an XML document
4974
+
4975
+ ### Properties
4976
+
4977
+ #### #text
4978
+
4979
+ > **#text**: `string`
4980
+
4981
+ Defined in:
4982
+ [libraries/epub/index.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L95)