@storyteller-platform/epub 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -220,7 +220,7 @@ To get started with developing in the Storyteller monorepo, check out the
220
220
  ## Epub
221
221
 
222
222
  Defined in:
223
- [libraries/epub/index.ts:267](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L267)
223
+ [libraries/epub/index.ts:346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L346)
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
- [libraries/epub/index.ts:533](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L533)
266
+ [libraries/epub/index.ts:612](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L612)
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
- [libraries/epub/index.ts:535](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L535)
293
+ [libraries/epub/index.ts:614](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L614)
294
294
 
295
295
  #### adapterClass
296
296
 
@@ -298,28 +298,28 @@ Defined in:
298
298
  > [`EpubStorageAdapterClass`](#epubstorageadapterclass)
299
299
 
300
300
  Defined in:
301
- [libraries/epub/index.ts:534](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L534)
301
+ [libraries/epub/index.ts:613](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L613)
302
302
 
303
303
  #### inputPath
304
304
 
305
305
  > `protected` **inputPath**: `undefined` \| `string`
306
306
 
307
307
  Defined in:
308
- [libraries/epub/index.ts:536](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L536)
308
+ [libraries/epub/index.ts:615](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L615)
309
309
 
310
310
  #### readonlyOverride
311
311
 
312
312
  > `protected` **readonlyOverride**: `boolean` = `false`
313
313
 
314
314
  Defined in:
315
- [libraries/epub/index.ts:537](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L537)
315
+ [libraries/epub/index.ts:616](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L616)
316
316
 
317
317
  #### storage
318
318
 
319
319
  > `readonly` **storage**: [`EpubStorageKind`](#epubstoragekind)
320
320
 
321
321
  Defined in:
322
- [libraries/epub/index.ts:525](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L525)
322
+ [libraries/epub/index.ts:604](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L604)
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
- [libraries/epub/index.ts:315](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L315)
335
+ [libraries/epub/index.ts:394](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L394)
336
336
 
337
337
  #### xhtmlParser
338
338
 
339
339
  > `static` **xhtmlParser**: `XMLParser`
340
340
 
341
341
  Defined in:
342
- [libraries/epub/index.ts:275](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L275)
342
+ [libraries/epub/index.ts:354](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L354)
343
343
 
344
344
  #### xmlBuilder
345
345
 
346
346
  > `static` **xmlBuilder**: `XMLBuilder`
347
347
 
348
348
  Defined in:
349
- [libraries/epub/index.ts:308](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L308)
349
+ [libraries/epub/index.ts:387](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L387)
350
350
 
351
351
  #### xmlParser
352
352
 
353
353
  > `static` **xmlParser**: `XMLParser`
354
354
 
355
355
  Defined in:
356
- [libraries/epub/index.ts:268](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L268)
356
+ [libraries/epub/index.ts:347](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L347)
357
357
 
358
358
  ### Methods
359
359
 
@@ -362,7 +362,7 @@ Defined in:
362
362
  > **\[dispose\]**(): `void`
363
363
 
364
364
  Defined in:
365
- [libraries/epub/index.ts:3461](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3461)
365
+ [libraries/epub/index.ts:3577](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3577)
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
- [libraries/epub/index.ts:2159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2159)
376
+ [libraries/epub/index.ts:2223](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2223)
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
- [libraries/epub/index.ts:2504](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2504)
399
+ [libraries/epub/index.ts:2568](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2568)
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
- [libraries/epub/index.ts:2349](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2349)
429
+ [libraries/epub/index.ts:2413](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2413)
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
- [libraries/epub/index.ts:3047](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3047)
459
+ [libraries/epub/index.ts:3164](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3164)
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
- [libraries/epub/index.ts:3052](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3052)
488
+ [libraries/epub/index.ts:3169](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3169)
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
- [libraries/epub/index.ts:3057](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3057)
517
+ [libraries/epub/index.ts:3174](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3174)
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
- [libraries/epub/index.ts:3168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3168)
545
+ [libraries/epub/index.ts:3285](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3285)
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
- [libraries/epub/index.ts:2558](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2558)
572
+ [libraries/epub/index.ts:2622](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2622)
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
- [libraries/epub/index.ts:1688](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1688)
602
+ [libraries/epub/index.ts:1752](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1752)
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
- [libraries/epub/index.ts:630](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L630)
625
+ [libraries/epub/index.ts:709](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L709)
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
- [libraries/epub/index.ts:2864](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2864)
644
+ [libraries/epub/index.ts:2981](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2981)
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
- [libraries/epub/index.ts:3411](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3411)
666
+ [libraries/epub/index.ts:3527](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3527)
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
- [libraries/epub/index.ts:895](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L895)
677
+ [libraries/epub/index.ts:959](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L959)
678
678
 
679
679
  Returns the item in the metadata element's children array that matches the
680
680
  provided predicate.
@@ -693,28 +693,28 @@ provided predicate.
693
693
 
694
694
  > **findMetadataItem**(`predicate`): `Promise`\<`null` \| \{ `id`: `undefined`
695
695
  > \| `string`; `properties`: \{[`k`: `string`]: `string`; \}; `type`:
696
- > `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \|
697
- > `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \|
698
- > `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \|
699
- > `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \|
700
- > `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \|
701
- > `` `p${string}` `` \| `` `q${string}` `` \| `` `r${string}` `` \|
696
+ > `` `r${string}` `` \| `` `a${string}` `` \| `` `b${string}` `` \|
697
+ > `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \|
698
+ > `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \|
699
+ > `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \|
700
+ > `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \|
701
+ > `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \|
702
702
  > `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \|
703
703
  > `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \|
704
- > `` `y${string}` `` \| `` `z${string}` `` \| `` `A${string}` `` \|
705
- > `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \|
706
- > `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \|
707
- > `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \|
708
- > `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \|
709
- > `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \|
710
- > `` `Q${string}` `` \| `` `R${string}` `` \| `` `S${string}` `` \|
704
+ > `` `y${string}` `` \| `` `z${string}` `` \| `` `R${string}` `` \|
705
+ > `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \|
706
+ > `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \|
707
+ > `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \|
708
+ > `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \|
709
+ > `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \|
710
+ > `` `P${string}` `` \| `` `Q${string}` `` \| `` `S${string}` `` \|
711
711
  > `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \|
712
712
  > `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \|
713
713
  > `` `Z${string}` `` \| `` `?${string}` ``; `value`: `undefined` \| `string`;
714
714
  > \}\>
715
715
 
716
716
  Defined in:
717
- [libraries/epub/index.ts:886](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L886)
717
+ [libraries/epub/index.ts:950](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L950)
718
718
 
719
719
  Returns the item in the metadata element's children array that matches the
720
720
  provided predicate.
@@ -728,21 +728,21 @@ provided predicate.
728
728
  ##### Returns
729
729
 
730
730
  `Promise`\<`null` \| \{ `id`: `undefined` \| `string`; `properties`: \{[`k`:
731
- `string`]: `string`; \}; `type`: `` `a${string}` `` \| `` `b${string}` `` \|
732
- `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \|
733
- `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \|
734
- `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \|
735
- `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \|
736
- `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \|
737
- `` `r${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \|
731
+ `string`]: `string`; \}; `type`: `` `r${string}` `` \| `` `a${string}` `` \|
732
+ `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \|
733
+ `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \|
734
+ `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \|
735
+ `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \|
736
+ `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \|
737
+ `` `q${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \|
738
738
  `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \|
739
739
  `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \|
740
- `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \|
741
- `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \|
742
- `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \|
743
- `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \|
744
- `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \|
745
- `` `P${string}` `` \| `` `Q${string}` `` \| `` `R${string}` `` \|
740
+ `` `R${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \|
741
+ `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \|
742
+ `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \|
743
+ `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \|
744
+ `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \|
745
+ `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \|
746
746
  `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \|
747
747
  `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \|
748
748
  `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` ``; `value`:
@@ -753,7 +753,7 @@ provided predicate.
753
753
  > **getBaseDirection**(): `Promise`\<`"auto"` \| `"rtl"` \| `"ltr"`\>
754
754
 
755
755
  Defined in:
756
- [libraries/epub/index.ts:1642](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1642)
756
+ [libraries/epub/index.ts:1706](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1706)
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
- [libraries/epub/index.ts:2119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2119)
775
+ [libraries/epub/index.ts:2183](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2183)
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
- [libraries/epub/index.ts:2336](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2336)
788
+ [libraries/epub/index.ts:2400](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2400)
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
- [libraries/epub/index.ts:1538](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1538)
807
+ [libraries/epub/index.ts:1602](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1602)
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
- [libraries/epub/index.ts:1519](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1519)
828
+ [libraries/epub/index.ts:1583](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1583)
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
- [libraries/epub/index.ts:2272](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2272)
848
+ [libraries/epub/index.ts:2336](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2336)
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
- [libraries/epub/index.ts:1970](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1970)
871
+ [libraries/epub/index.ts:2034](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2034)
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
- [libraries/epub/index.ts:3388](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3388)
887
+ [libraries/epub/index.ts:3504](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3504)
888
888
 
889
889
  Retrieve the guide entries from the package document.
890
890
 
@@ -900,7 +900,7 @@ many publications still include it.
900
900
  > **getIdentifier**(): `Promise`\<`null` \| `string`\>
901
901
 
902
902
  Defined in:
903
- [libraries/epub/index.ts:993](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L993)
903
+ [libraries/epub/index.ts:1057](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1057)
904
904
 
905
905
  Retrieve the first identifier from the dc:identifier element in the EPUB
906
906
  metadata.
@@ -925,7 +925,7 @@ identifier, or [getIdentifiers](#getidentifiers) to get all identifiers.
925
925
  > **getIdentifiers**(): `Promise`\<[`EpubIdentifier`](#epubidentifier)[]\>
926
926
 
927
927
  Defined in:
928
- [libraries/epub/index.ts:1168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1168)
928
+ [libraries/epub/index.ts:1232](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1232)
929
929
 
930
930
  Retrieve every `dc:identifier` entry, returned as found.
931
931
 
@@ -947,7 +947,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
947
947
  > **getItemArchiveLength**(`id`): `Promise`\<`number`\>
948
948
 
949
949
  Defined in:
950
- [libraries/epub/index.ts:672](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L672)
950
+ [libraries/epub/index.ts:735](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L735)
951
951
 
952
952
  Length of the underlying archive entry for a manifest item, in bytes Necessary
953
953
  to compute the readium page count which is for COMPRESSED content
@@ -972,7 +972,7 @@ to compute the readium page count which is for COMPRESSED content
972
972
  > [`Navigation`](#navigation)\>
973
973
 
974
974
  Defined in:
975
- [libraries/epub/index.ts:2737](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2737)
975
+ [libraries/epub/index.ts:2801](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2801)
976
976
 
977
977
  Returns the structured landmarks navigation document as a Navigation object
978
978
 
@@ -996,7 +996,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
996
996
  > **getLanguage**(): `Promise`\<`null` \| `Locale`\>
997
997
 
998
998
  Defined in:
999
- [libraries/epub/index.ts:1807](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1807)
999
+ [libraries/epub/index.ts:1871](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1871)
1000
1000
 
1001
1001
  Retrieve the Epub's language as specified in its package document metadata.
1002
1002
 
@@ -1016,7 +1016,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1016
1016
  > **getLayout**(): `Promise`\<`"pre-paginated"` \| `"reflowable"`\>
1017
1017
 
1018
1018
  Defined in:
1019
- [libraries/epub/index.ts:1623](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1623)
1019
+ [libraries/epub/index.ts:1687](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1687)
1020
1020
 
1021
1021
  Retrieve the layout from the rendition:layout meta element in the EPUB metadata.
1022
1022
 
@@ -1036,7 +1036,7 @@ https://www.w3.org/TR/epub-33/#layout
1036
1036
  > [`ManifestItem`](#manifestitem)\>\>
1037
1037
 
1038
1038
  Defined in:
1039
- [libraries/epub/index.ts:811](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L811)
1039
+ [libraries/epub/index.ts:875](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L875)
1040
1040
 
1041
1041
  Retrieve the manifest for the Epub.
1042
1042
 
@@ -1056,7 +1056,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
1056
1056
  > **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
1057
1057
 
1058
1058
  Defined in:
1059
- [libraries/epub/index.ts:962](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L962)
1059
+ [libraries/epub/index.ts:1026](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1026)
1060
1060
 
1061
1061
  Retrieve the metadata entries for the Epub.
1062
1062
 
@@ -1079,7 +1079,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1079
1079
  > **getModifiedDate**(): `Promise`\<`null` \| `Date`\>
1080
1080
 
1081
1081
  Defined in:
1082
- [libraries/epub/index.ts:1606](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1606)
1082
+ [libraries/epub/index.ts:1670](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1670)
1083
1083
 
1084
1084
  Retrieve the modified date from the dcterms:modified metadata in the EPUB
1085
1085
  metadata as a Date object.
@@ -1099,7 +1099,7 @@ https://www.w3.org/TR/epub-33/#sec-metadata-last-modified
1099
1099
  > **getNcxTableOfContents**(): `Promise`\<[`NavigationList`](#navigationlist)\>
1100
1100
 
1101
1101
  Defined in:
1102
- [libraries/epub/index.ts:3293](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3293)
1102
+ [libraries/epub/index.ts:3410](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3410)
1103
1103
 
1104
1104
  Parse the NCX table of contents, if one exists, and return a tree of TocEntry
1105
1105
  nodes.
@@ -1117,7 +1117,7 @@ and EPUB 3 publications that retain an NCX for backwards compatibility.
1117
1117
  > `Promise`\<[`XmlElement`](#xmlelement)\<`"package"`\>\>
1118
1118
 
1119
1119
  Defined in:
1120
- [libraries/epub/index.ts:746](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L746)
1120
+ [libraries/epub/index.ts:810](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L810)
1121
1121
 
1122
1122
  ##### Returns
1123
1123
 
@@ -1129,7 +1129,7 @@ Defined in:
1129
1129
  > `string`\>\>
1130
1130
 
1131
1131
  Defined in:
1132
- [libraries/epub/index.ts:1987](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1987)
1132
+ [libraries/epub/index.ts:2051](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2051)
1133
1133
 
1134
1134
  Return the set of custom vocabulary prefixes set on this publication's root
1135
1135
  package element.
@@ -1149,7 +1149,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1149
1149
  > **getPageBreakSource**(): `Promise`\<`null` \| [`EpubSource`](#epubsource)\>
1150
1150
 
1151
1151
  Defined in:
1152
- [libraries/epub/index.ts:1205](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1205)
1152
+ [libraries/epub/index.ts:1269](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1269)
1153
1153
 
1154
1154
  Retrieve the `pageBreakSource` property (EPUB 3.4, spec D.2.9), the
1155
1155
  publication-level source for the source of its page break markers.
@@ -1172,7 +1172,7 @@ https://www.w3.org/TR/epub/#pageBreakSource
1172
1172
  > [`Navigation`](#navigation)\>
1173
1173
 
1174
1174
  Defined in:
1175
- [libraries/epub/index.ts:2749](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2749)
1175
+ [libraries/epub/index.ts:2813](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2813)
1176
1176
 
1177
1177
  Returns the structured page list navigation document as a Navigation object
1178
1178
 
@@ -1196,7 +1196,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
1196
1196
  > **getPublicationDate**(): `Promise`\<`null` \| `Date`\>
1197
1197
 
1198
1198
  Defined in:
1199
- [libraries/epub/index.ts:1575](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1575)
1199
+ [libraries/epub/index.ts:1639](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1639)
1200
1200
 
1201
1201
  Retrieve the publication date from the dc:date element in the EPUB metadata as a
1202
1202
  Date object.
@@ -1216,7 +1216,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1216
1216
  > **getRootfile**(): `Promise`\<`string`\>
1217
1217
 
1218
1218
  Defined in:
1219
- [libraries/epub/index.ts:682](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L682)
1219
+ [libraries/epub/index.ts:746](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L746)
1220
1220
 
1221
1221
  ##### Returns
1222
1222
 
@@ -1227,7 +1227,7 @@ Defined in:
1227
1227
  > **getSources**(): `Promise`\<[`EpubSource`](#epubsource)[]\>
1228
1228
 
1229
1229
  Defined in:
1230
- [libraries/epub/index.ts:1182](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1182)
1230
+ [libraries/epub/index.ts:1246](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1246)
1231
1231
 
1232
1232
  Retrieve every `dc:source` entry, returned as found.
1233
1233
 
@@ -1248,7 +1248,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsource
1248
1248
  > **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem)[]\>
1249
1249
 
1250
1250
  Defined in:
1251
- [libraries/epub/index.ts:2539](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2539)
1251
+ [libraries/epub/index.ts:2603](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2603)
1252
1252
 
1253
1253
  Retrieve the manifest items that make up the Epub's spine.
1254
1254
 
@@ -1268,7 +1268,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1268
1268
  > **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
1269
1269
 
1270
1270
  Defined in:
1271
- [libraries/epub/index.ts:1762](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1762)
1271
+ [libraries/epub/index.ts:1826](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1826)
1272
1272
 
1273
1273
  Retrieve the list of subjects for this EPUB.
1274
1274
 
@@ -1289,7 +1289,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
1289
1289
  > **getSubtitle**(): `Promise`\<`null` \| `string`\>
1290
1290
 
1291
1291
  Defined in:
1292
- [libraries/epub/index.ts:1877](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1877)
1292
+ [libraries/epub/index.ts:1941](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1941)
1293
1293
 
1294
1294
  Retrieve the subtitle of the Epub, if it exists.
1295
1295
 
@@ -1307,7 +1307,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1307
1307
  > [`Navigation`](#navigation)\>
1308
1308
 
1309
1309
  Defined in:
1310
- [libraries/epub/index.ts:2720](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2720)
1310
+ [libraries/epub/index.ts:2784](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2784)
1311
1311
 
1312
1312
  Returns the structured table of contents navigation document as a Navigation
1313
1313
  object.
@@ -1332,7 +1332,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-toc
1332
1332
  > **getTitle**(`expanded`): `Promise`\<`null` \| `string`\>
1333
1333
 
1334
1334
  Defined in:
1335
- [libraries/epub/index.ts:1853](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1853)
1335
+ [libraries/epub/index.ts:1917](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1917)
1336
1336
 
1337
1337
  Retrieve the title of the Epub.
1338
1338
 
@@ -1355,7 +1355,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1355
1355
  > **getTitles**(): `Promise`\<`object`[]\>
1356
1356
 
1357
1357
  Defined in:
1358
- [libraries/epub/index.ts:1889](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1889)
1358
+ [libraries/epub/index.ts:1953](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1953)
1359
1359
 
1360
1360
  Retrieve all title entries of the Epub.
1361
1361
 
@@ -1372,7 +1372,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1372
1372
  > **getType**(): `Promise`\<`null` \| [`MetadataEntry`](#metadataentry)\>
1373
1373
 
1374
1374
  Defined in:
1375
- [libraries/epub/index.ts:1675](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1675)
1375
+ [libraries/epub/index.ts:1739](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1739)
1376
1376
 
1377
1377
  Retrieve the publication type from the dc:type element in the EPUB metadata.
1378
1378
 
@@ -1391,7 +1391,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1391
1391
  > **getUniqueIdentifier**(): `Promise`\<`null` \| `string`\>
1392
1392
 
1393
1393
  Defined in:
1394
- [libraries/epub/index.ts:1025](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1025)
1394
+ [libraries/epub/index.ts:1089](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1089)
1395
1395
 
1396
1396
  Retrieve the identifier with the unique identifier id in the EPUB metadata.
1397
1397
 
@@ -1410,7 +1410,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1410
1410
  > **getUniqueIdentifierId**(): `Promise`\<`null` \| `string`\>
1411
1411
 
1412
1412
  Defined in:
1413
- [libraries/epub/index.ts:1106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1106)
1413
+ [libraries/epub/index.ts:1170](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1170)
1414
1414
 
1415
1415
  Retrieve the id of the publication's unique identifier, as declared by the
1416
1416
  package element's `unique-identifier` attribute.
@@ -1428,7 +1428,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1428
1428
  > **getVersion**(): `Promise`\<`string`\>
1429
1429
 
1430
1430
  Defined in:
1431
- [libraries/epub/index.ts:3280](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3280)
1431
+ [libraries/epub/index.ts:3397](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3397)
1432
1432
 
1433
1433
  Returns the EPUB version declared on the package element.
1434
1434
 
@@ -1444,7 +1444,7 @@ Returns the EPUB version declared on the package element.
1444
1444
  > `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1445
1445
 
1446
1446
  Defined in:
1447
- [libraries/epub/index.ts:2803](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2803)
1447
+ [libraries/epub/index.ts:2920](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2920)
1448
1448
 
1449
1449
  Retrieve the contents of a file, given its href.
1450
1450
 
@@ -1467,7 +1467,7 @@ encoding parameter.
1467
1467
  > **readFileContents**(`href`, `relativeTo`, `encoding`): `Promise`\<`string`\>
1468
1468
 
1469
1469
  Defined in:
1470
- [libraries/epub/index.ts:2804](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2804)
1470
+ [libraries/epub/index.ts:2921](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2921)
1471
1471
 
1472
1472
  Retrieve the contents of a file, given its href.
1473
1473
 
@@ -1493,7 +1493,7 @@ encoding parameter.
1493
1493
  > **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1494
1494
 
1495
1495
  Defined in:
1496
- [libraries/epub/index.ts:2836](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2836)
1496
+ [libraries/epub/index.ts:2953](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2953)
1497
1497
 
1498
1498
  Retrieve the contents of a manifest item, given its id.
1499
1499
 
@@ -1516,7 +1516,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1516
1516
  > **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
1517
1517
 
1518
1518
  Defined in:
1519
- [libraries/epub/index.ts:2837](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2837)
1519
+ [libraries/epub/index.ts:2954](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2954)
1520
1520
 
1521
1521
  Retrieve the contents of a manifest item, given its id.
1522
1522
 
@@ -1542,7 +1542,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1542
1542
  > **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`ParsedXml`](#parsedxml)\>
1543
1543
 
1544
1544
  Defined in:
1545
- [libraries/epub/index.ts:2899](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2899)
1545
+ [libraries/epub/index.ts:3016](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3016)
1546
1546
 
1547
1547
  Retrieves the contents of an XHTML item, given its manifest id.
1548
1548
 
@@ -1566,7 +1566,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1566
1566
  > **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
1567
1567
 
1568
1568
  Defined in:
1569
- [libraries/epub/index.ts:2900](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2900)
1569
+ [libraries/epub/index.ts:3017](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3017)
1570
1570
 
1571
1571
  Retrieves the contents of an XHTML item, given its manifest id.
1572
1572
 
@@ -1590,7 +1590,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1590
1590
  > **removeCollection**(`index`): `Promise`\<`void`\>
1591
1591
 
1592
1592
  Defined in:
1593
- [libraries/epub/index.ts:2228](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2228)
1593
+ [libraries/epub/index.ts:2292](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2292)
1594
1594
 
1595
1595
  Remove a collection from the EPUB metadata.
1596
1596
 
@@ -1612,7 +1612,7 @@ returned by `epub.getCollections()`.
1612
1612
  > **removeContributor**(`index`): `Promise`\<`void`\>
1613
1613
 
1614
1614
  Defined in:
1615
- [libraries/epub/index.ts:2488](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2488)
1615
+ [libraries/epub/index.ts:2552](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2552)
1616
1616
 
1617
1617
  Remove a contributor from the EPUB metadata.
1618
1618
 
@@ -1640,7 +1640,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1640
1640
  > **removeCreator**(`index`, `type`): `Promise`\<`void`\>
1641
1641
 
1642
1642
  Defined in:
1643
- [libraries/epub/index.ts:2436](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2436)
1643
+ [libraries/epub/index.ts:2500](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2500)
1644
1644
 
1645
1645
  Remove a creator from the EPUB metadata.
1646
1646
 
@@ -1667,7 +1667,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1667
1667
  > **removeManifestItem**(`id`): `Promise`\<`void`\>
1668
1668
 
1669
1669
  Defined in:
1670
- [libraries/epub/index.ts:3004](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3004)
1670
+ [libraries/epub/index.ts:3121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3121)
1671
1671
 
1672
1672
  ##### Parameters
1673
1673
 
@@ -1684,7 +1684,7 @@ Defined in:
1684
1684
  > **removeMetadata**(`predicate`): `Promise`\<`void`\>
1685
1685
 
1686
1686
  Defined in:
1687
- [libraries/epub/index.ts:3252](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3252)
1687
+ [libraries/epub/index.ts:3369](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3369)
1688
1688
 
1689
1689
  Remove one or more metadata entries.
1690
1690
 
@@ -1710,7 +1710,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1710
1710
  > **removeSpineItem**(`index`): `Promise`\<`void`\>
1711
1711
 
1712
1712
  Defined in:
1713
- [libraries/epub/index.ts:2594](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2594)
1713
+ [libraries/epub/index.ts:2658](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2658)
1714
1714
 
1715
1715
  Remove the spine item at the specified index.
1716
1716
 
@@ -1733,7 +1733,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1733
1733
  > **removeSubject**(`index`): `Promise`\<`void`\>
1734
1734
 
1735
1735
  Defined in:
1736
- [libraries/epub/index.ts:1725](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1725)
1736
+ [libraries/epub/index.ts:1789](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1789)
1737
1737
 
1738
1738
  Remove a subject from the EPUB metadata.
1739
1739
 
@@ -1759,7 +1759,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1759
1759
  > **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
1760
1760
 
1761
1761
  Defined in:
1762
- [libraries/epub/index.ts:3207](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3207)
1762
+ [libraries/epub/index.ts:3324](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3324)
1763
1763
 
1764
1764
  Replace a metadata entry with a new one.
1765
1765
 
@@ -1787,10 +1787,13 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1787
1787
  > `Promise`\<`string`\>
1788
1788
 
1789
1789
  Defined in:
1790
- [libraries/epub/index.ts:2775](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2775)
1790
+ [libraries/epub/index.ts:2876](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2876)
1791
1791
 
1792
1792
  Returns a path-relative-scheme-less URL, relative to the container root.
1793
1793
 
1794
+ An href that points outside the publication, such as an external link in a
1795
+ navigation document, is handed back unchanged.
1796
+
1794
1797
  ##### Parameters
1795
1798
 
1796
1799
  | Parameter | Type | Description |
@@ -1809,7 +1812,7 @@ Returns a path-relative-scheme-less URL, relative to the container root.
1809
1812
  > **saveAndClose**(): `Promise`\<`void`\>
1810
1813
 
1811
1814
  Defined in:
1812
- [libraries/epub/index.ts:3426](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3426)
1815
+ [libraries/epub/index.ts:3542](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3542)
1813
1816
 
1814
1817
  Write the current contents of the Epub to a new EPUB archive on disk.
1815
1818
 
@@ -1825,7 +1828,7 @@ updated to the current UTC timestamp.
1825
1828
  > **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
1826
1829
 
1827
1830
  Defined in:
1828
- [libraries/epub/index.ts:1552](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1552)
1831
+ [libraries/epub/index.ts:1616](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1616)
1829
1832
 
1830
1833
  Set the cover image for the EPUB.
1831
1834
 
@@ -1848,7 +1851,7 @@ then writes the provided image data to the provided href within the publication.
1848
1851
  > **setDescription**(`description`): `Promise`\<`void`\>
1849
1852
 
1850
1853
  Defined in:
1851
- [libraries/epub/index.ts:1954](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1954)
1854
+ [libraries/epub/index.ts:2018](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2018)
1852
1855
 
1853
1856
  Update the Epub's description metadata entry.
1854
1857
 
@@ -1871,7 +1874,7 @@ encoded as HTML entities.
1871
1874
  > **setIdentifier**(`identifier`): `Promise`\<`void`\>
1872
1875
 
1873
1876
  Defined in:
1874
- [libraries/epub/index.ts:1009](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1009)
1877
+ [libraries/epub/index.ts:1073](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1073)
1875
1878
 
1876
1879
  Set the dc:identifier metadata element with the provided string.
1877
1880
 
@@ -1901,7 +1904,7 @@ Use [setUniqueIdentifier](#setuniqueidentifier) instead.
1901
1904
  > **setIdentifiers**(`identifiers`): `Promise`\<`void`\>
1902
1905
 
1903
1906
  Defined in:
1904
- [libraries/epub/index.ts:1274](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1274)
1907
+ [libraries/epub/index.ts:1338](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1338)
1905
1908
 
1906
1909
  Replace the publication's `dc:identifier` entries.
1907
1910
 
@@ -1939,7 +1942,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1939
1942
  > **setLanguage**(`locale`): `Promise`\<`void`\>
1940
1943
 
1941
1944
  Defined in:
1942
- [libraries/epub/index.ts:1836](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1836)
1945
+ [libraries/epub/index.ts:1900](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1900)
1943
1946
 
1944
1947
  Update the Epub's language metadata entry.
1945
1948
 
@@ -1965,7 +1968,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1965
1968
  > **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
1966
1969
 
1967
1970
  Defined in:
1968
- [libraries/epub/index.ts:2005](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2005)
1971
+ [libraries/epub/index.ts:2069](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2069)
1969
1972
 
1970
1973
  Set a custom vocabulary prefix on the root package element.
1971
1974
 
@@ -1989,7 +1992,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1989
1992
  > **setPageBreakSource**(`value`): `Promise`\<`void`\>
1990
1993
 
1991
1994
  Defined in:
1992
- [libraries/epub/index.ts:1241](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1241)
1995
+ [libraries/epub/index.ts:1305](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1305)
1993
1996
 
1994
1997
  Set the `pageBreakSource` property (EPUB 3.4, spec D.2.9), or remove it when
1995
1998
  passed null. Replaces an existing `pageBreakSource` meta if present.
@@ -2015,7 +2018,7 @@ https://www.w3.org/TR/epub/#pageBreakSource
2015
2018
  > **setPublicationDate**(`date`): `Promise`\<`void`\>
2016
2019
 
2017
2020
  Defined in:
2018
- [libraries/epub/index.ts:1590](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1590)
2021
+ [libraries/epub/index.ts:1654](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1654)
2019
2022
 
2020
2023
  Set the dc:date metadata element with the provided date.
2021
2024
 
@@ -2041,7 +2044,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
2041
2044
  > **setSources**(`sources`): `Promise`\<`void`\>
2042
2045
 
2043
2046
  Defined in:
2044
- [libraries/epub/index.ts:1392](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1392)
2047
+ [libraries/epub/index.ts:1456](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1456)
2045
2048
 
2046
2049
  Replace the publication's `dc:source` entries.
2047
2050
 
@@ -2073,7 +2076,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsource
2073
2076
  > **setTitle**(`title`): `Promise`\<`void`\>
2074
2077
 
2075
2078
  Defined in:
2076
- [libraries/epub/index.ts:2029](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2029)
2079
+ [libraries/epub/index.ts:2093](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2093)
2077
2080
 
2078
2081
  Set the title of the Epub.
2079
2082
 
@@ -2101,7 +2104,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
2101
2104
  > **setTitles**(`entries`): `Promise`\<`void`\>
2102
2105
 
2103
2106
  Defined in:
2104
- [libraries/epub/index.ts:2057](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2057)
2107
+ [libraries/epub/index.ts:2121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2121)
2105
2108
 
2106
2109
  ##### Parameters
2107
2110
 
@@ -2118,7 +2121,7 @@ Defined in:
2118
2121
  > **setType**(`type`): `Promise`\<`void`\>
2119
2122
 
2120
2123
  Defined in:
2121
- [libraries/epub/index.ts:1659](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1659)
2124
+ [libraries/epub/index.ts:1723](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1723)
2122
2125
 
2123
2126
  Set the dc:type metadata element.
2124
2127
 
@@ -2144,7 +2147,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
2144
2147
  > **setUniqueIdentifier**(`identifier`): `Promise`\<`void`\>
2145
2148
 
2146
2149
  Defined in:
2147
- [libraries/epub/index.ts:1050](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1050)
2150
+ [libraries/epub/index.ts:1114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L1114)
2148
2151
 
2149
2152
  Set the unique identifier id for the EPUB.
2150
2153
 
@@ -2174,7 +2177,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
2174
2177
  > **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
2175
2178
 
2176
2179
  Defined in:
2177
- [libraries/epub/index.ts:3119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3119)
2180
+ [libraries/epub/index.ts:3236](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3236)
2178
2181
 
2179
2182
  Update the manifest entry for an existing item.
2180
2183
 
@@ -2201,7 +2204,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
2201
2204
  > **withPackage**(`producer`): `Promise`\<`void`\>
2202
2205
 
2203
2206
  Defined in:
2204
- [libraries/epub/index.ts:772](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L772)
2207
+ [libraries/epub/index.ts:836](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L836)
2205
2208
 
2206
2209
  Safely modify the package document, without race conditions.
2207
2210
 
@@ -2227,7 +2230,7 @@ update runs exclusively.
2227
2230
  > **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
2228
2231
 
2229
2232
  Defined in:
2230
- [libraries/epub/index.ts:2956](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2956)
2233
+ [libraries/epub/index.ts:3073](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3073)
2231
2234
 
2232
2235
  Write new contents for an existing manifest item, specified by its id.
2233
2236
 
@@ -2254,7 +2257,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
2254
2257
  > **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
2255
2258
 
2256
2259
  Defined in:
2257
- [libraries/epub/index.ts:2957](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2957)
2260
+ [libraries/epub/index.ts:3074](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3074)
2258
2261
 
2259
2262
  Write new contents for an existing manifest item, specified by its id.
2260
2263
 
@@ -2282,7 +2285,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
2282
2285
  > **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
2283
2286
 
2284
2287
  Defined in:
2285
- [libraries/epub/index.ts:2996](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L2996)
2288
+ [libraries/epub/index.ts:3113](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3113)
2286
2289
 
2287
2290
  Write new contents for an existing XHTML item, specified by its id.
2288
2291
 
@@ -2309,7 +2312,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
2309
2312
  > `static` **addLinkToXhtmlHead**(`xml`, `link`): `void`
2310
2313
 
2311
2314
  Defined in:
2312
- [libraries/epub/index.ts:345](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L345)
2315
+ [libraries/epub/index.ts:424](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L424)
2313
2316
 
2314
2317
  Given an XML structure representing a complete XHTML document, add a `link`
2315
2318
  element to the `head` of the document.
@@ -2335,7 +2338,7 @@ This method modifies the provided XML structure.
2335
2338
  > `static` **assertEpub3**(`epub`): `Promise`\<`void`\>
2336
2339
 
2337
2340
  Defined in:
2338
- [libraries/epub/index.ts:620](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L620)
2341
+ [libraries/epub/index.ts:699](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L699)
2339
2342
 
2340
2343
  ##### Parameters
2341
2344
 
@@ -2353,7 +2356,7 @@ Defined in:
2353
2356
  > `Promise`\<[`Epub`](#epub)\>
2354
2357
 
2355
2358
  Defined in:
2356
- [libraries/epub/index.ts:568](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L568)
2359
+ [libraries/epub/index.ts:647](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L647)
2357
2360
 
2358
2361
  Construct a new EPUB on a writable backend, optionally seeded with the provided
2359
2362
  metadata. Equivalent to `Epub.using(TmpFsAdapter).create(...)`.
@@ -2376,13 +2379,13 @@ metadata. Equivalent to `Epub.using(TmpFsAdapter).create(...)`.
2376
2379
  > [`XmlElement`](#xmlelement)\<`Name`\>
2377
2380
 
2378
2381
  Defined in:
2379
- [libraries/epub/index.ts:380](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L380)
2382
+ [libraries/epub/index.ts:459](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L459)
2380
2383
 
2381
2384
  ##### Type Parameters
2382
2385
 
2383
2386
  | Type Parameter |
2384
2387
  | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2385
- | `Name` _extends_ `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `r${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `R${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2388
+ | `Name` _extends_ `` `r${string}` `` \| `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `R${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2386
2389
 
2387
2390
  ##### Parameters
2388
2391
 
@@ -2401,7 +2404,7 @@ Defined in:
2401
2404
  > `static` **createXmlTextNode**(`text`): [`XmlTextNode`](#xmltextnode)
2402
2405
 
2403
2406
  Defined in:
2404
- [libraries/epub/index.ts:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L393)
2407
+ [libraries/epub/index.ts:472](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L472)
2405
2408
 
2406
2409
  ##### Parameters
2407
2410
 
@@ -2419,7 +2422,7 @@ Defined in:
2419
2422
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
2420
2423
 
2421
2424
  Defined in:
2422
- [libraries/epub/index.ts:466](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L466)
2425
+ [libraries/epub/index.ts:545](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L545)
2423
2426
 
2424
2427
  Given an XML structure, find the first child matching the provided name and
2425
2428
  optional filter.
@@ -2428,7 +2431,7 @@ optional filter.
2428
2431
 
2429
2432
  | Type Parameter |
2430
2433
  | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2431
- | `Name` _extends_ `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `r${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `R${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2434
+ | `Name` _extends_ `` `r${string}` `` \| `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `R${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2432
2435
 
2433
2436
  ##### Parameters
2434
2437
 
@@ -2448,7 +2451,7 @@ optional filter.
2448
2451
  > `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
2449
2452
 
2450
2453
  Defined in:
2451
- [libraries/epub/index.ts:484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L484)
2454
+ [libraries/epub/index.ts:563](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L563)
2452
2455
 
2453
2456
  Given an XML structure, find the first descendant matching the provided name and
2454
2457
  optional filter.
@@ -2460,7 +2463,7 @@ element in the tree matching the name and filter.
2460
2463
 
2461
2464
  | Type Parameter |
2462
2465
  | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2463
- | `Name` _extends_ `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `r${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `R${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2466
+ | `Name` _extends_ `` `r${string}` `` \| `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `R${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2464
2467
 
2465
2468
  ##### Parameters
2466
2469
 
@@ -2479,7 +2482,7 @@ element in the tree matching the name and filter.
2479
2482
  > `static` **formatSmilDuration**(`duration`): `string`
2480
2483
 
2481
2484
  Defined in:
2482
- [libraries/epub/index.ts:328](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L328)
2485
+ [libraries/epub/index.ts:407](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L407)
2483
2486
 
2484
2487
  Format a duration, provided as a number of seconds, as a SMIL clock value, to be
2485
2488
  used for Media Overlays.
@@ -2505,7 +2508,7 @@ https://www.w3.org/TR/epub-33/#sec-duration
2505
2508
  > `static` **from**(`pathOrData`): `Promise`\<[`Epub`](#epub)\>
2506
2509
 
2507
2510
  Defined in:
2508
- [libraries/epub/index.ts:604](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L604)
2511
+ [libraries/epub/index.ts:683](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L683)
2509
2512
 
2510
2513
  Open an existing EPUB publication, extracting it to a temp directory so writes
2511
2514
  can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2535,7 +2538,7 @@ when the archive is not a valid EPUB 3
2535
2538
  > `Promise`\<[`EpubReader`](#epubreader)\>
2536
2539
 
2537
2540
  Defined in:
2538
- [libraries/epub/index.ts:605](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L605)
2541
+ [libraries/epub/index.ts:684](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L684)
2539
2542
 
2540
2543
  Open an existing EPUB publication, extracting it to a temp directory so writes
2541
2544
  can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2566,7 +2569,7 @@ when the archive is not a valid EPUB 3
2566
2569
  > [`EpubReader`](#epubreader)\>
2567
2570
 
2568
2571
  Defined in:
2569
- [libraries/epub/index.ts:609](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L609)
2572
+ [libraries/epub/index.ts:688](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L688)
2570
2573
 
2571
2574
  Open an existing EPUB publication, extracting it to a temp directory so writes
2572
2575
  can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2596,7 +2599,7 @@ when the archive is not a valid EPUB 3
2596
2599
  > `static` **getXhtmlBody**(`xml`): [`ParsedXml`](#parsedxml)
2597
2600
 
2598
2601
  Defined in:
2599
- [libraries/epub/index.ts:370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L370)
2602
+ [libraries/epub/index.ts:449](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L449)
2600
2603
 
2601
2604
  Given an XML structure representing a complete XHTML document, return the
2602
2605
  sub-structure representing the children of the document's body element.
@@ -2616,7 +2619,7 @@ sub-structure representing the children of the document's body element.
2616
2619
  > `static` **getXhtmlTextContent**(`xml`): `string`
2617
2620
 
2618
2621
  Defined in:
2619
- [libraries/epub/index.ts:402](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L402)
2622
+ [libraries/epub/index.ts:481](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L481)
2620
2623
 
2621
2624
  Given an XML structure representing a complete XHTML document, return a string
2622
2625
  representing the concatenation of all text nodes in the document.
@@ -2636,7 +2639,7 @@ representing the concatenation of all text nodes in the document.
2636
2639
  > `static` **getXmlAttributes**(`element`): `Record`\<`string`, `string`\>
2637
2640
 
2638
2641
  Defined in:
2639
- [libraries/epub/index.ts:419](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L419)
2642
+ [libraries/epub/index.ts:498](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L498)
2640
2643
 
2641
2644
  Given an XMLElement, return its attributes.
2642
2645
 
@@ -2655,7 +2658,7 @@ Given an XMLElement, return its attributes.
2655
2658
  > `static` **getXmlChildren**\<`Name`\>(`element`): [`ParsedXml`](#parsedxml)
2656
2659
 
2657
2660
  Defined in:
2658
- [libraries/epub/index.ts:446](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L446)
2661
+ [libraries/epub/index.ts:525](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L525)
2659
2662
 
2660
2663
  Given an XMLElement, return a list of its children
2661
2664
 
@@ -2663,7 +2666,7 @@ Given an XMLElement, return a list of its children
2663
2666
 
2664
2667
  | Type Parameter |
2665
2668
  | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2666
- | `Name` _extends_ `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `r${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `R${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2669
+ | `Name` _extends_ `` `r${string}` `` \| `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `R${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2667
2670
 
2668
2671
  ##### Parameters
2669
2672
 
@@ -2680,7 +2683,7 @@ Given an XMLElement, return a list of its children
2680
2683
  > `static` **getXmlElementName**\<`Name`\>(`element`): `Name`
2681
2684
 
2682
2685
  Defined in:
2683
- [libraries/epub/index.ts:431](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L431)
2686
+ [libraries/epub/index.ts:510](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L510)
2684
2687
 
2685
2688
  Given an XMLElement, return its tag name.
2686
2689
 
@@ -2688,7 +2691,7 @@ Given an XMLElement, return its tag name.
2688
2691
 
2689
2692
  | Type Parameter |
2690
2693
  | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2691
- | `Name` _extends_ `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `r${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `R${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2694
+ | `Name` _extends_ `` `r${string}` `` \| `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `R${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2692
2695
 
2693
2696
  ##### Parameters
2694
2697
 
@@ -2705,7 +2708,7 @@ Given an XMLElement, return its tag name.
2705
2708
  > `static` **isXmlTextNode**(`node`): `node is XmlTextNode`
2706
2709
 
2707
2710
  Defined in:
2708
- [libraries/epub/index.ts:506](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L506)
2711
+ [libraries/epub/index.ts:585](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L585)
2709
2712
 
2710
2713
  Given an XMLNode, determine whether it represents a text node or an XML element.
2711
2714
 
@@ -2724,13 +2727,13 @@ Given an XMLNode, determine whether it represents a text node or an XML element.
2724
2727
  > `static` **replaceXmlChildren**\<`Name`\>(`element`, `children`): `void`
2725
2728
 
2726
2729
  Defined in:
2727
- [libraries/epub/index.ts:454](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L454)
2730
+ [libraries/epub/index.ts:533](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L533)
2728
2731
 
2729
2732
  ##### Type Parameters
2730
2733
 
2731
2734
  | Type Parameter |
2732
2735
  | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2733
- | `Name` _extends_ `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `r${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `R${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2736
+ | `Name` _extends_ `` `r${string}` `` \| `` `a${string}` `` \| `` `b${string}` `` \| `` `c${string}` `` \| `` `d${string}` `` \| `` `e${string}` `` \| `` `f${string}` `` \| `` `g${string}` `` \| `` `h${string}` `` \| `` `i${string}` `` \| `` `j${string}` `` \| `` `k${string}` `` \| `` `l${string}` `` \| `` `m${string}` `` \| `` `n${string}` `` \| `` `o${string}` `` \| `` `p${string}` `` \| `` `q${string}` `` \| `` `s${string}` `` \| `` `t${string}` `` \| `` `u${string}` `` \| `` `v${string}` `` \| `` `w${string}` `` \| `` `x${string}` `` \| `` `y${string}` `` \| `` `z${string}` `` \| `` `R${string}` `` \| `` `A${string}` `` \| `` `B${string}` `` \| `` `C${string}` `` \| `` `D${string}` `` \| `` `E${string}` `` \| `` `F${string}` `` \| `` `G${string}` `` \| `` `H${string}` `` \| `` `I${string}` `` \| `` `J${string}` `` \| `` `K${string}` `` \| `` `L${string}` `` \| `` `M${string}` `` \| `` `N${string}` `` \| `` `O${string}` `` \| `` `P${string}` `` \| `` `Q${string}` `` \| `` `S${string}` `` \| `` `T${string}` `` \| `` `U${string}` `` \| `` `V${string}` `` \| `` `W${string}` `` \| `` `X${string}` `` \| `` `Y${string}` `` \| `` `Z${string}` `` \| `` `?${string}` `` |
2734
2737
 
2735
2738
  ##### Parameters
2736
2739
 
@@ -2748,7 +2751,7 @@ Defined in:
2748
2751
  > `static` **upgrade**(`path`, `options`): `Promise`\<[`Epub`](#epub)\>
2749
2752
 
2750
2753
  Defined in:
2751
- [libraries/epub/index.ts:3454](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3454)
2754
+ [libraries/epub/index.ts:3570](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3570)
2752
2755
 
2753
2756
  Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new, valid Epub 3
2754
2757
  instance. Equivalent to `Epub.using(TmpFsAdapter).upgrade(...)`.
@@ -2770,7 +2773,7 @@ instance. Equivalent to `Epub.using(TmpFsAdapter).upgrade(...)`.
2770
2773
  > [`EpubFactory`](#epubfactory)\<`A`\>
2771
2774
 
2772
2775
  Defined in:
2773
- [libraries/epub/index.ts:588](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L588)
2776
+ [libraries/epub/index.ts:667](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L667)
2774
2777
 
2775
2778
  Specify the storage backend to use for the EPUB
2776
2779
 
@@ -2805,7 +2808,7 @@ using reader = await Epub.using(MemoryAdapter).from(buffer, { cache: false })
2805
2808
  ## EpubFactory\<A\>
2806
2809
 
2807
2810
  Defined in:
2808
- [libraries/epub/index.ts:3483](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3483)
2811
+ [libraries/epub/index.ts:3599](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3599)
2809
2812
 
2810
2813
  Adapter-bound factory returned by [Epub.using](#using).
2811
2814
 
@@ -2828,7 +2831,7 @@ runtime if the adapter is read-only or lacks `initEmpty`.
2828
2831
  > [`EpubFactory`](#epubfactory)\<`A`\>
2829
2832
 
2830
2833
  Defined in:
2831
- [libraries/epub/index.ts:3484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3484)
2834
+ [libraries/epub/index.ts:3600](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3600)
2832
2835
 
2833
2836
  ##### Parameters
2834
2837
 
@@ -2847,7 +2850,7 @@ Defined in:
2847
2850
  > `readonly` **adapterClass**: `A`
2848
2851
 
2849
2852
  Defined in:
2850
- [libraries/epub/index.ts:3484](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3484)
2853
+ [libraries/epub/index.ts:3600](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3600)
2851
2854
 
2852
2855
  ### Methods
2853
2856
 
@@ -2857,7 +2860,7 @@ Defined in:
2857
2860
  > `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\>\>
2858
2861
 
2859
2862
  Defined in:
2860
- [libraries/epub/index.ts:3540](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3540)
2863
+ [libraries/epub/index.ts:3661](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3661)
2861
2864
 
2862
2865
  Construct a new EPUB on this factory's adapter, optionally seeded with the
2863
2866
  provided metadata. Requires a writable adapter that implements `initEmpty`
@@ -2900,7 +2903,7 @@ when the adapter is read-only or does not implement initEmpty
2900
2903
  > `Disposable` & `object`\>
2901
2904
 
2902
2905
  Defined in:
2903
- [libraries/epub/index.ts:3491](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3491)
2906
+ [libraries/epub/index.ts:3607](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3607)
2904
2907
 
2905
2908
  Open an existing EPUB through this factory's adapter
2906
2909
 
@@ -2939,7 +2942,7 @@ when the archive is not a valid EPUB 3
2939
2942
  > `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\> & `object`\>
2940
2943
 
2941
2944
  Defined in:
2942
- [libraries/epub/index.ts:3495](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3495)
2945
+ [libraries/epub/index.ts:3611](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3611)
2943
2946
 
2944
2947
  Open an existing EPUB through this factory's adapter
2945
2948
 
@@ -2964,7 +2967,7 @@ when the archive is not a valid EPUB 3
2964
2967
  > `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\>\>
2965
2968
 
2966
2969
  Defined in:
2967
- [libraries/epub/index.ts:3653](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3653)
2970
+ [libraries/epub/index.ts:3768](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L3768)
2968
2971
 
2969
2972
  Upgrade an EPUB 2 publication to EPUB 3 in place using this factory's adapter,
2970
2973
  returning a new, valid Epub 3 instance.
@@ -3005,7 +3008,7 @@ when the adapter is read-only
3005
3008
  ## EpubReadOnlyError
3006
3009
 
3007
3010
  Defined in:
3008
- [libraries/epub/index.ts:238](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L238)
3011
+ [libraries/epub/index.ts:233](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L233)
3009
3012
 
3010
3013
  ### Extends
3011
3014
 
@@ -3237,7 +3240,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
3237
3240
  ## EpubVersionError
3238
3241
 
3239
3242
  Defined in:
3240
- [libraries/epub/index.ts:237](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L237)
3243
+ [libraries/epub/index.ts:232](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L232)
3241
3244
 
3242
3245
  ### Extends
3243
3246
 
@@ -3468,7 +3471,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
3468
3471
  ## MemoryAdapter
3469
3472
 
3470
3473
  Defined in:
3471
- [libraries/epub/adapters/memory.ts:32](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L32)
3474
+ [libraries/epub/adapters/memory.ts:27](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L27)
3472
3475
 
3473
3476
  Loads an EPUB archive into memory and serves all I/O off the in-memory zip
3474
3477
  handle.
@@ -3481,27 +3484,12 @@ read only
3481
3484
 
3482
3485
  ### Properties
3483
3486
 
3484
- #### rootPath
3485
-
3486
- > `readonly` **rootPath**: `string`
3487
-
3488
- Defined in:
3489
- [libraries/epub/adapters/memory.ts:71](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L71)
3490
-
3491
- Opaque path prefix used by `resolveInternalHref` to anchor absolute paths within
3492
- the archive. For TmpFsAdapter this is the tmp dir; for MemoryAdapter it's a
3493
- virtual prefix that's never written to disk
3494
-
3495
- ##### Implementation of
3496
-
3497
- [`EpubStorageAdapter`](#epubstorageadapter).[`rootPath`](#rootpath-2)
3498
-
3499
3487
  #### capabilities
3500
3488
 
3501
3489
  > `readonly` `static` **capabilities**: `object`
3502
3490
 
3503
3491
  Defined in:
3504
- [libraries/epub/adapters/memory.ts:34](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L34)
3492
+ [libraries/epub/adapters/memory.ts:29](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L29)
3505
3493
 
3506
3494
  ##### writable
3507
3495
 
@@ -3512,16 +3500,16 @@ Defined in:
3512
3500
  > `readonly` `static` **kind**: `"in-memory"`
3513
3501
 
3514
3502
  Defined in:
3515
- [libraries/epub/adapters/memory.ts:33](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L33)
3503
+ [libraries/epub/adapters/memory.ts:28](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L28)
3516
3504
 
3517
3505
  ### Methods
3518
3506
 
3519
3507
  #### archiveLength()
3520
3508
 
3521
- > **archiveLength**(`path`): `Promise`\<`number`\>
3509
+ > **archiveLength**(`entry`): `Promise`\<`number`\>
3522
3510
 
3523
3511
  Defined in:
3524
- [libraries/epub/adapters/memory.ts:114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L114)
3512
+ [libraries/epub/adapters/memory.ts:94](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L94)
3525
3513
 
3526
3514
  Length of an entry in bytes, for the readium page-count heuristic which expects
3527
3515
  compressed size when available
@@ -3530,7 +3518,7 @@ compressed size when available
3530
3518
 
3531
3519
  | Parameter | Type |
3532
3520
  | --------- | -------- |
3533
- | `path` | `string` |
3521
+ | `entry` | `string` |
3534
3522
 
3535
3523
  ##### Returns
3536
3524
 
@@ -3545,7 +3533,7 @@ compressed size when available
3545
3533
  > **dispose**(): `void`
3546
3534
 
3547
3535
  Defined in:
3548
- [libraries/epub/adapters/memory.ts:120](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L120)
3536
+ [libraries/epub/adapters/memory.ts:100](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L100)
3549
3537
 
3550
3538
  Always called on close or error
3551
3539
 
@@ -3557,20 +3545,44 @@ Always called on close or error
3557
3545
 
3558
3546
  [`EpubStorageAdapter`](#epubstorageadapter).[`dispose`](#dispose-6)
3559
3547
 
3548
+ #### exists()
3549
+
3550
+ > **exists**(`entry`): `Promise`\<`boolean`\>
3551
+
3552
+ Defined in:
3553
+ [libraries/epub/adapters/memory.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L89)
3554
+
3555
+ Whether the archive holds an entry under exactly this name. Used to choose
3556
+ between different canditates for an href so should be exact
3557
+
3558
+ ##### Parameters
3559
+
3560
+ | Parameter | Type |
3561
+ | --------- | -------- |
3562
+ | `entry` | `string` |
3563
+
3564
+ ##### Returns
3565
+
3566
+ `Promise`\<`boolean`\>
3567
+
3568
+ ##### Implementation of
3569
+
3570
+ [`EpubStorageAdapter`](#epubstorageadapter).[`exists`](#exists-4)
3571
+
3560
3572
  #### read()
3561
3573
 
3562
3574
  ##### Call Signature
3563
3575
 
3564
- > **read**(`path`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
3576
+ > **read**(`entry`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
3565
3577
 
3566
3578
  Defined in:
3567
- [libraries/epub/adapters/memory.ts:85](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L85)
3579
+ [libraries/epub/adapters/memory.ts:61](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L61)
3568
3580
 
3569
3581
  ###### Parameters
3570
3582
 
3571
3583
  | Parameter | Type |
3572
3584
  | --------- | -------- |
3573
- | `path` | `string` |
3585
+ | `entry` | `string` |
3574
3586
 
3575
3587
  ###### Returns
3576
3588
 
@@ -3582,16 +3594,16 @@ Defined in:
3582
3594
 
3583
3595
  ##### Call Signature
3584
3596
 
3585
- > **read**(`path`, `encoding`): `Promise`\<`string`\>
3597
+ > **read**(`entry`, `encoding`): `Promise`\<`string`\>
3586
3598
 
3587
3599
  Defined in:
3588
- [libraries/epub/adapters/memory.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L86)
3600
+ [libraries/epub/adapters/memory.ts:62](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L62)
3589
3601
 
3590
3602
  ###### Parameters
3591
3603
 
3592
3604
  | Parameter | Type |
3593
3605
  | ---------- | --------- |
3594
- | `path` | `string` |
3606
+ | `entry` | `string` |
3595
3607
  | `encoding` | `"utf-8"` |
3596
3608
 
3597
3609
  ###### Returns
@@ -3608,7 +3620,7 @@ Defined in:
3608
3620
  > `Promise`\<[`MemoryAdapter`](#memoryadapter)\>
3609
3621
 
3610
3622
  Defined in:
3611
- [libraries/epub/adapters/memory.ts:36](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L36)
3623
+ [libraries/epub/adapters/memory.ts:31](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L31)
3612
3624
 
3613
3625
  ##### Parameters
3614
3626
 
@@ -3626,7 +3638,7 @@ Defined in:
3626
3638
  ## TmpFsAdapter
3627
3639
 
3628
3640
  Defined in:
3629
- [libraries/epub/adapters/tmpfs.ts:59](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L59)
3641
+ [libraries/epub/adapters/tmpfs.ts:53](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L53)
3630
3642
 
3631
3643
  Extracts an EPUB archive to a temp directory and serves all I/O off the real
3632
3644
  filesystem. `Epub.using(TmpFsAdapter).from(...)` returns a writable
@@ -3638,27 +3650,12 @@ filesystem. `Epub.using(TmpFsAdapter).from(...)` returns a writable
3638
3650
 
3639
3651
  ### Properties
3640
3652
 
3641
- #### rootPath
3642
-
3643
- > `readonly` **rootPath**: `string`
3644
-
3645
- Defined in:
3646
- [libraries/epub/adapters/tmpfs.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L102)
3647
-
3648
- Opaque path prefix used by `resolveInternalHref` to anchor absolute paths within
3649
- the archive. For TmpFsAdapter this is the tmp dir; for MemoryAdapter it's a
3650
- virtual prefix that's never written to disk
3651
-
3652
- ##### Implementation of
3653
-
3654
- [`EpubStorageAdapter`](#epubstorageadapter).[`rootPath`](#rootpath-2)
3655
-
3656
3653
  #### capabilities
3657
3654
 
3658
3655
  > `readonly` `static` **capabilities**: `object`
3659
3656
 
3660
3657
  Defined in:
3661
- [libraries/epub/adapters/tmpfs.ts:61](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L61)
3658
+ [libraries/epub/adapters/tmpfs.ts:55](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L55)
3662
3659
 
3663
3660
  ##### writable
3664
3661
 
@@ -3669,16 +3666,16 @@ Defined in:
3669
3666
  > `readonly` `static` **kind**: `"extracted-dir"`
3670
3667
 
3671
3668
  Defined in:
3672
- [libraries/epub/adapters/tmpfs.ts:60](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L60)
3669
+ [libraries/epub/adapters/tmpfs.ts:54](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L54)
3673
3670
 
3674
3671
  ### Methods
3675
3672
 
3676
3673
  #### archiveLength()
3677
3674
 
3678
- > **archiveLength**(`path`): `Promise`\<`number`\>
3675
+ > **archiveLength**(`entry`): `Promise`\<`number`\>
3679
3676
 
3680
3677
  Defined in:
3681
- [libraries/epub/adapters/tmpfs.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L125)
3678
+ [libraries/epub/adapters/tmpfs.ts:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L136)
3682
3679
 
3683
3680
  Length of an entry in bytes, for the readium page-count heuristic which expects
3684
3681
  compressed size when available
@@ -3687,7 +3684,7 @@ compressed size when available
3687
3684
 
3688
3685
  | Parameter | Type |
3689
3686
  | --------- | -------- |
3690
- | `path` | `string` |
3687
+ | `entry` | `string` |
3691
3688
 
3692
3689
  ##### Returns
3693
3690
 
@@ -3702,7 +3699,7 @@ compressed size when available
3702
3699
  > **dispose**(): `void`
3703
3700
 
3704
3701
  Defined in:
3705
- [libraries/epub/adapters/tmpfs.ts:198](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L198)
3702
+ [libraries/epub/adapters/tmpfs.ts:213](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L213)
3706
3703
 
3707
3704
  Always called on close or error
3708
3705
 
@@ -3719,7 +3716,7 @@ Always called on close or error
3719
3716
  > **duplicate**(): `Promise`\<[`TmpFsAdapter`](#tmpfsadapter)\>
3720
3717
 
3721
3718
  Defined in:
3722
- [libraries/epub/adapters/tmpfs.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L149)
3719
+ [libraries/epub/adapters/tmpfs.ts:163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L163)
3723
3720
 
3724
3721
  Required for Epub.copy
3725
3722
 
@@ -3731,12 +3728,36 @@ Required for Epub.copy
3731
3728
 
3732
3729
  [`EpubStorageAdapter`](#epubstorageadapter).[`duplicate`](#duplicate-2)
3733
3730
 
3731
+ #### exists()
3732
+
3733
+ > **exists**(`entry`): `Promise`\<`boolean`\>
3734
+
3735
+ Defined in:
3736
+ [libraries/epub/adapters/tmpfs.ts:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L127)
3737
+
3738
+ Whether the archive holds an entry under exactly this name. Used to choose
3739
+ between different canditates for an href so should be exact
3740
+
3741
+ ##### Parameters
3742
+
3743
+ | Parameter | Type |
3744
+ | --------- | -------- |
3745
+ | `entry` | `string` |
3746
+
3747
+ ##### Returns
3748
+
3749
+ `Promise`\<`boolean`\>
3750
+
3751
+ ##### Implementation of
3752
+
3753
+ [`EpubStorageAdapter`](#epubstorageadapter).[`exists`](#exists-4)
3754
+
3734
3755
  #### list()
3735
3756
 
3736
3757
  > **list**(): `AsyncIterable`\<[`EpubListEntry`](#epublistentry)\>
3737
3758
 
3738
3759
  Defined in:
3739
- [libraries/epub/adapters/tmpfs.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L134)
3760
+ [libraries/epub/adapters/tmpfs.ts:145](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L145)
3740
3761
 
3741
3762
  Required for Epub.saveAndClose to walk the contents
3742
3763
 
@@ -3752,16 +3773,16 @@ Required for Epub.saveAndClose to walk the contents
3752
3773
 
3753
3774
  ##### Call Signature
3754
3775
 
3755
- > **read**(`path`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
3776
+ > **read**(`entry`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
3756
3777
 
3757
3778
  Defined in:
3758
- [libraries/epub/adapters/tmpfs.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L104)
3779
+ [libraries/epub/adapters/tmpfs.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L105)
3759
3780
 
3760
3781
  ###### Parameters
3761
3782
 
3762
3783
  | Parameter | Type |
3763
3784
  | --------- | -------- |
3764
- | `path` | `string` |
3785
+ | `entry` | `string` |
3765
3786
 
3766
3787
  ###### Returns
3767
3788
 
@@ -3773,16 +3794,16 @@ Defined in:
3773
3794
 
3774
3795
  ##### Call Signature
3775
3796
 
3776
- > **read**(`path`, `encoding`): `Promise`\<`string`\>
3797
+ > **read**(`entry`, `encoding`): `Promise`\<`string`\>
3777
3798
 
3778
3799
  Defined in:
3779
- [libraries/epub/adapters/tmpfs.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L105)
3800
+ [libraries/epub/adapters/tmpfs.ts:106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L106)
3780
3801
 
3781
3802
  ###### Parameters
3782
3803
 
3783
3804
  | Parameter | Type |
3784
3805
  | ---------- | --------- |
3785
- | `path` | `string` |
3806
+ | `entry` | `string` |
3786
3807
  | `encoding` | `"utf-8"` |
3787
3808
 
3788
3809
  ###### Returns
@@ -3795,10 +3816,10 @@ Defined in:
3795
3816
 
3796
3817
  #### remove()
3797
3818
 
3798
- > **remove**(`path`): `Promise`\<`void`\>
3819
+ > **remove**(`entry`): `Promise`\<`void`\>
3799
3820
 
3800
3821
  Defined in:
3801
- [libraries/epub/adapters/tmpfs.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L121)
3822
+ [libraries/epub/adapters/tmpfs.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L123)
3802
3823
 
3803
3824
  Required for removeManifestItem / setCoverImage replacement
3804
3825
 
@@ -3806,7 +3827,7 @@ Required for removeManifestItem / setCoverImage replacement
3806
3827
 
3807
3828
  | Parameter | Type |
3808
3829
  | --------- | -------- |
3809
- | `path` | `string` |
3830
+ | `entry` | `string` |
3810
3831
 
3811
3832
  ##### Returns
3812
3833
 
@@ -3821,7 +3842,7 @@ Required for removeManifestItem / setCoverImage replacement
3821
3842
  > **serialize**(`targetPath`): `Promise`\<`void`\>
3822
3843
 
3823
3844
  Defined in:
3824
- [libraries/epub/adapters/tmpfs.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L160)
3845
+ [libraries/epub/adapters/tmpfs.ts:174](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L174)
3825
3846
 
3826
3847
  Required for Epub.saveAndClose
3827
3848
 
@@ -3843,10 +3864,10 @@ Required for Epub.saveAndClose
3843
3864
 
3844
3865
  ##### Call Signature
3845
3866
 
3846
- > **write**(`path`, `data`): `Promise`\<`void`\>
3867
+ > **write**(`entry`, `data`): `Promise`\<`void`\>
3847
3868
 
3848
3869
  Defined in:
3849
- [libraries/epub/adapters/tmpfs.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L110)
3870
+ [libraries/epub/adapters/tmpfs.ts:111](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L111)
3850
3871
 
3851
3872
  Required for any mutation method on Epub
3852
3873
 
@@ -3854,7 +3875,7 @@ Required for any mutation method on Epub
3854
3875
 
3855
3876
  | Parameter | Type |
3856
3877
  | --------- | ------------ |
3857
- | `path` | `string` |
3878
+ | `entry` | `string` |
3858
3879
  | `data` | `Uint8Array` |
3859
3880
 
3860
3881
  ###### Returns
@@ -3867,16 +3888,16 @@ Required for any mutation method on Epub
3867
3888
 
3868
3889
  ##### Call Signature
3869
3890
 
3870
- > **write**(`path`, `data`, `encoding`): `Promise`\<`void`\>
3891
+ > **write**(`entry`, `data`, `encoding`): `Promise`\<`void`\>
3871
3892
 
3872
3893
  Defined in:
3873
- [libraries/epub/adapters/tmpfs.ts:111](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L111)
3894
+ [libraries/epub/adapters/tmpfs.ts:112](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L112)
3874
3895
 
3875
3896
  ###### Parameters
3876
3897
 
3877
3898
  | Parameter | Type |
3878
3899
  | ---------- | --------- |
3879
- | `path` | `string` |
3900
+ | `entry` | `string` |
3880
3901
  | `data` | `string` |
3881
3902
  | `encoding` | `"utf-8"` |
3882
3903
 
@@ -3893,7 +3914,7 @@ Defined in:
3893
3914
  > `static` **init**(`source`): `Promise`\<[`TmpFsAdapter`](#tmpfsadapter)\>
3894
3915
 
3895
3916
  Defined in:
3896
- [libraries/epub/adapters/tmpfs.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L63)
3917
+ [libraries/epub/adapters/tmpfs.ts:57](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L57)
3897
3918
 
3898
3919
  ##### Parameters
3899
3920
 
@@ -3910,7 +3931,7 @@ Defined in:
3910
3931
  > `static` **initEmpty**(): `Promise`\<[`TmpFsAdapter`](#tmpfsadapter)\>
3911
3932
 
3912
3933
  Defined in:
3913
- [libraries/epub/adapters/tmpfs.ts:96](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L96)
3934
+ [libraries/epub/adapters/tmpfs.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/tmpfs.ts#L88)
3914
3935
 
3915
3936
  ##### Returns
3916
3937
 
@@ -3921,7 +3942,7 @@ Defined in:
3921
3942
  ## AlternateScript
3922
3943
 
3923
3944
  Defined in:
3924
- [libraries/epub/index.ts:154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L154)
3945
+ [libraries/epub/index.ts:149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L149)
3925
3946
 
3926
3947
  ### Properties
3927
3948
 
@@ -3930,21 +3951,21 @@ Defined in:
3930
3951
  > **locale**: `Locale`
3931
3952
 
3932
3953
  Defined in:
3933
- [libraries/epub/index.ts:156](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L156)
3954
+ [libraries/epub/index.ts:151](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L151)
3934
3955
 
3935
3956
  #### name
3936
3957
 
3937
3958
  > **name**: `string`
3938
3959
 
3939
3960
  Defined in:
3940
- [libraries/epub/index.ts:155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L155)
3961
+ [libraries/epub/index.ts:150](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L150)
3941
3962
 
3942
3963
  ---
3943
3964
 
3944
3965
  ## Collection
3945
3966
 
3946
3967
  Defined in:
3947
- [libraries/epub/index.ts:178](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L178)
3968
+ [libraries/epub/index.ts:173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L173)
3948
3969
 
3949
3970
  ### Properties
3950
3971
 
@@ -3953,28 +3974,28 @@ Defined in:
3953
3974
  > **name**: `string`
3954
3975
 
3955
3976
  Defined in:
3956
- [libraries/epub/index.ts:179](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L179)
3977
+ [libraries/epub/index.ts:174](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L174)
3957
3978
 
3958
3979
  #### position?
3959
3980
 
3960
3981
  > `optional` **position**: `string`
3961
3982
 
3962
3983
  Defined in:
3963
- [libraries/epub/index.ts:181](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L181)
3984
+ [libraries/epub/index.ts:176](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L176)
3964
3985
 
3965
3986
  #### type?
3966
3987
 
3967
3988
  > `optional` **type**: `string`
3968
3989
 
3969
3990
  Defined in:
3970
- [libraries/epub/index.ts:180](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L180)
3991
+ [libraries/epub/index.ts:175](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L175)
3971
3992
 
3972
3993
  ---
3973
3994
 
3974
3995
  ## DcCreator
3975
3996
 
3976
3997
  Defined in:
3977
- [libraries/epub/index.ts:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L159)
3998
+ [libraries/epub/index.ts:154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L154)
3978
3999
 
3979
4000
  ### Properties
3980
4001
 
@@ -3983,42 +4004,42 @@ Defined in:
3983
4004
  > `optional` **alternateScripts**: [`AlternateScript`](#alternatescript)[]
3984
4005
 
3985
4006
  Defined in:
3986
- [libraries/epub/index.ts:164](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L164)
4007
+ [libraries/epub/index.ts:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L159)
3987
4008
 
3988
4009
  #### fileAs?
3989
4010
 
3990
4011
  > `optional` **fileAs**: `string`
3991
4012
 
3992
4013
  Defined in:
3993
- [libraries/epub/index.ts:163](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L163)
4014
+ [libraries/epub/index.ts:158](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L158)
3994
4015
 
3995
4016
  #### name
3996
4017
 
3997
4018
  > **name**: `string`
3998
4019
 
3999
4020
  Defined in:
4000
- [libraries/epub/index.ts:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L160)
4021
+ [libraries/epub/index.ts:155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L155)
4001
4022
 
4002
4023
  #### role?
4003
4024
 
4004
4025
  > `optional` **role**: `string`
4005
4026
 
4006
4027
  Defined in:
4007
- [libraries/epub/index.ts:161](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L161)
4028
+ [libraries/epub/index.ts:156](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L156)
4008
4029
 
4009
4030
  #### roleScheme?
4010
4031
 
4011
4032
  > `optional` **roleScheme**: `string`
4012
4033
 
4013
4034
  Defined in:
4014
- [libraries/epub/index.ts:162](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L162)
4035
+ [libraries/epub/index.ts:157](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L157)
4015
4036
 
4016
4037
  ---
4017
4038
 
4018
4039
  ## DcSubject
4019
4040
 
4020
4041
  Defined in:
4021
- [libraries/epub/index.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L121)
4042
+ [libraries/epub/index.ts:116](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L116)
4022
4043
 
4023
4044
  ### Properties
4024
4045
 
@@ -4027,28 +4048,28 @@ Defined in:
4027
4048
  > **authority**: `string`
4028
4049
 
4029
4050
  Defined in:
4030
- [libraries/epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L123)
4051
+ [libraries/epub/index.ts:118](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L118)
4031
4052
 
4032
4053
  #### term
4033
4054
 
4034
4055
  > **term**: `string`
4035
4056
 
4036
4057
  Defined in:
4037
- [libraries/epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L124)
4058
+ [libraries/epub/index.ts:119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L119)
4038
4059
 
4039
4060
  #### value
4040
4061
 
4041
4062
  > **value**: `string`
4042
4063
 
4043
4064
  Defined in:
4044
- [libraries/epub/index.ts:122](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L122)
4065
+ [libraries/epub/index.ts:117](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L117)
4045
4066
 
4046
4067
  ---
4047
4068
 
4048
4069
  ## DublinCore
4049
4070
 
4050
4071
  Defined in:
4051
- [libraries/epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L167)
4072
+ [libraries/epub/index.ts:162](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L162)
4052
4073
 
4053
4074
  ### Properties
4054
4075
 
@@ -4057,926 +4078,25 @@ Defined in:
4057
4078
  > `optional` **contributors**: [`DcCreator`](#dccreator)[]
4058
4079
 
4059
4080
  Defined in:
4060
- [libraries/epub/index.ts:174](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L174)
4081
+ [libraries/epub/index.ts:169](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L169)
4061
4082
 
4062
4083
  #### creators?
4063
4084
 
4064
4085
  > `optional` **creators**: [`DcCreator`](#dccreator)[]
4065
4086
 
4066
4087
  Defined in:
4067
- [libraries/epub/index.ts:173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L173)
4088
+ [libraries/epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L168)
4068
4089
 
4069
4090
  #### date?
4070
4091
 
4071
4092
  > `optional` **date**: `Date`
4072
4093
 
4073
4094
  Defined in:
4074
- [libraries/epub/index.ts:171](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L171)
4095
+ [libraries/epub/index.ts:166](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L166)
4075
4096
 
4076
4097
  #### identifier
4077
4098
 
4078
4099
  > **identifier**: `string`
4079
4100
 
4080
4101
  Defined in:
4081
- [libraries/epub/index.ts:170](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L170)
4082
-
4083
- #### language
4084
-
4085
- > **language**: `Locale`
4086
-
4087
- Defined in:
4088
- [libraries/epub/index.ts:169](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L169)
4089
-
4090
- #### subjects?
4091
-
4092
- > `optional` **subjects**: (`string` \| [`DcSubject`](#dcsubject))[]
4093
-
4094
- Defined in:
4095
- [libraries/epub/index.ts:172](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L172)
4096
-
4097
- #### title
4098
-
4099
- > **title**: `string`
4100
-
4101
- Defined in:
4102
- [libraries/epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L168)
4103
-
4104
- #### type?
4105
-
4106
- > `optional` **type**: `string`
4107
-
4108
- Defined in:
4109
- [libraries/epub/index.ts:175](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L175)
4110
-
4111
- ---
4112
-
4113
- ## Epub2UpgradeOptions
4114
-
4115
- Defined in:
4116
- [libraries/epub/upgrade.ts:93](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L93)
4117
-
4118
- ### Properties
4119
-
4120
- #### outputPath?
4121
-
4122
- > `optional` **outputPath**: `string`
4123
-
4124
- Defined in:
4125
- [libraries/epub/upgrade.ts:97](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L97)
4126
-
4127
- The path to the output file. If provided, the input file will be copied to the
4128
- output path.
4129
-
4130
- #### removeNcx?
4131
-
4132
- > `optional` **removeNcx**: `boolean`
4133
-
4134
- Defined in:
4135
- [libraries/epub/upgrade.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L101)
4136
-
4137
- Whether to remove the NCX file, as it's technically optional in EPUB 3.
4138
-
4139
- ---
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
-
4183
- ## EpubListEntry
4184
-
4185
- Defined in:
4186
- [libraries/epub/adapters/interface.ts:17](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L17)
4187
-
4188
- ### Properties
4189
-
4190
- #### absolutePath
4191
-
4192
- > **absolutePath**: `string`
4193
-
4194
- Defined in:
4195
- [libraries/epub/adapters/interface.ts:19](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L19)
4196
-
4197
- absolute path under [EpubStorageAdapter.rootPath](#rootpath-2)
4198
-
4199
- #### relativePath
4200
-
4201
- > **relativePath**: `string`
4202
-
4203
- Defined in:
4204
- [libraries/epub/adapters/interface.ts:21](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L21)
4205
-
4206
- path relative to [EpubStorageAdapter.rootPath](#rootpath-2), slash-separated
4207
-
4208
- ---
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
-
4266
- ## EpubStorageAdapter
4267
-
4268
- Defined in:
4269
- [libraries/epub/adapters/interface.ts:24](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L24)
4270
-
4271
- ### Properties
4272
-
4273
- #### rootPath
4274
-
4275
- > `readonly` **rootPath**: `string`
4276
-
4277
- Defined in:
4278
- [libraries/epub/adapters/interface.ts:30](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L30)
4279
-
4280
- Opaque path prefix used by `resolveInternalHref` to anchor absolute paths within
4281
- the archive. For TmpFsAdapter this is the tmp dir; for MemoryAdapter it's a
4282
- virtual prefix that's never written to disk
4283
-
4284
- ### Methods
4285
-
4286
- #### archiveLength()
4287
-
4288
- > **archiveLength**(`path`): `Promise`\<`number`\>
4289
-
4290
- Defined in:
4291
- [libraries/epub/adapters/interface.ts:39](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L39)
4292
-
4293
- Length of an entry in bytes, for the readium page-count heuristic which expects
4294
- compressed size when available
4295
-
4296
- ##### Parameters
4297
-
4298
- | Parameter | Type |
4299
- | --------- | -------- |
4300
- | `path` | `string` |
4301
-
4302
- ##### Returns
4303
-
4304
- `Promise`\<`number`\>
4305
-
4306
- #### dispose()
4307
-
4308
- > **dispose**(): `void` \| `Promise`\<`void`\>
4309
-
4310
- Defined in:
4311
- [libraries/epub/adapters/interface.ts:58](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L58)
4312
-
4313
- Always called on close or error
4314
-
4315
- ##### Returns
4316
-
4317
- `void` \| `Promise`\<`void`\>
4318
-
4319
- #### duplicate()?
4320
-
4321
- > `optional` **duplicate**():
4322
- > `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4323
-
4324
- Defined in:
4325
- [libraries/epub/adapters/interface.ts:52](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L52)
4326
-
4327
- Required for Epub.copy
4328
-
4329
- ##### Returns
4330
-
4331
- `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4332
-
4333
- #### list()?
4334
-
4335
- > `optional` **list**(): `AsyncIterable`\<[`EpubListEntry`](#epublistentry)\>
4336
-
4337
- Defined in:
4338
- [libraries/epub/adapters/interface.ts:49](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L49)
4339
-
4340
- Required for Epub.saveAndClose to walk the contents
4341
-
4342
- ##### Returns
4343
-
4344
- `AsyncIterable`\<[`EpubListEntry`](#epublistentry)\>
4345
-
4346
- #### read()
4347
-
4348
- ##### Call Signature
4349
-
4350
- > **read**(`path`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
4351
-
4352
- Defined in:
4353
- [libraries/epub/adapters/interface.ts:32](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L32)
4354
-
4355
- ###### Parameters
4356
-
4357
- | Parameter | Type |
4358
- | --------- | -------- |
4359
- | `path` | `string` |
4360
-
4361
- ###### Returns
4362
-
4363
- `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
4364
-
4365
- ##### Call Signature
4366
-
4367
- > **read**(`path`, `encoding`): `Promise`\<`string`\>
4368
-
4369
- Defined in:
4370
- [libraries/epub/adapters/interface.ts:33](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L33)
4371
-
4372
- ###### Parameters
4373
-
4374
- | Parameter | Type |
4375
- | ---------- | --------- |
4376
- | `path` | `string` |
4377
- | `encoding` | `"utf-8"` |
4378
-
4379
- ###### Returns
4380
-
4381
- `Promise`\<`string`\>
4382
-
4383
- #### remove()?
4384
-
4385
- > `optional` **remove**(`path`): `Promise`\<`void`\>
4386
-
4387
- Defined in:
4388
- [libraries/epub/adapters/interface.ts:46](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L46)
4389
-
4390
- Required for removeManifestItem / setCoverImage replacement
4391
-
4392
- ##### Parameters
4393
-
4394
- | Parameter | Type |
4395
- | --------- | -------- |
4396
- | `path` | `string` |
4397
-
4398
- ##### Returns
4399
-
4400
- `Promise`\<`void`\>
4401
-
4402
- #### serialize()?
4403
-
4404
- > `optional` **serialize**(`targetPath`): `Promise`\<`void`\>
4405
-
4406
- Defined in:
4407
- [libraries/epub/adapters/interface.ts:55](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L55)
4408
-
4409
- Required for Epub.saveAndClose
4410
-
4411
- ##### Parameters
4412
-
4413
- | Parameter | Type |
4414
- | ------------ | -------- |
4415
- | `targetPath` | `string` |
4416
-
4417
- ##### Returns
4418
-
4419
- `Promise`\<`void`\>
4420
-
4421
- #### write()?
4422
-
4423
- ##### Call Signature
4424
-
4425
- > `optional` **write**(`path`, `data`): `Promise`\<`void`\>
4426
-
4427
- Defined in:
4428
- [libraries/epub/adapters/interface.ts:42](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L42)
4429
-
4430
- Required for any mutation method on Epub
4431
-
4432
- ###### Parameters
4433
-
4434
- | Parameter | Type |
4435
- | --------- | ------------ |
4436
- | `path` | `string` |
4437
- | `data` | `Uint8Array` |
4438
-
4439
- ###### Returns
4440
-
4441
- `Promise`\<`void`\>
4442
-
4443
- ##### Call Signature
4444
-
4445
- > `optional` **write**(`path`, `data`, `encoding`): `Promise`\<`void`\>
4446
-
4447
- Defined in:
4448
- [libraries/epub/adapters/interface.ts:43](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L43)
4449
-
4450
- ###### Parameters
4451
-
4452
- | Parameter | Type |
4453
- | ---------- | --------- |
4454
- | `path` | `string` |
4455
- | `data` | `string` |
4456
- | `encoding` | `"utf-8"` |
4457
-
4458
- ###### Returns
4459
-
4460
- `Promise`\<`void`\>
4461
-
4462
- ---
4463
-
4464
- ## EpubStorageAdapterClass\<Opts\>
4465
-
4466
- Defined in:
4467
- [libraries/epub/adapters/interface.ts:61](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L61)
4468
-
4469
- ### Type Parameters
4470
-
4471
- | Type Parameter | Default type |
4472
- | ------------------------- | ------------ |
4473
- | `Opts` _extends_ `object` | `object` |
4474
-
4475
- ### Properties
4476
-
4477
- #### capabilities
4478
-
4479
- > `readonly` **capabilities**:
4480
- > [`EpubStorageCapabilities`](#epubstoragecapabilities)
4481
-
4482
- Defined in:
4483
- [libraries/epub/adapters/interface.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L63)
4484
-
4485
- #### kind
4486
-
4487
- > `readonly` **kind**: [`EpubStorageKind`](#epubstoragekind)
4488
-
4489
- Defined in:
4490
- [libraries/epub/adapters/interface.ts:62](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L62)
4491
-
4492
- ### Methods
4493
-
4494
- #### init()
4495
-
4496
- > **init**(`source`, `opts?`):
4497
- > `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4498
-
4499
- Defined in:
4500
- [libraries/epub/adapters/interface.ts:70](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L70)
4501
-
4502
- Open an archive from a path or buffer. The returned adapter is ready to read;
4503
- the Epub class will assert it's a valid EPUB 3 afterwards.
4504
-
4505
- ##### Parameters
4506
-
4507
- | Parameter | Type |
4508
- | --------- | --------------------------------------------- |
4509
- | `source` | `string` \| `Uint8Array`\<`ArrayBufferLike`\> |
4510
- | `opts?` | `Opts` |
4511
-
4512
- ##### Returns
4513
-
4514
- `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4515
-
4516
- #### initEmpty()?
4517
-
4518
- > `optional` **initEmpty**(`opts?`):
4519
- > `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4520
-
4521
- Defined in:
4522
- [libraries/epub/adapters/interface.ts:79](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L79)
4523
-
4524
- Initialize an empty extract root for [Epub.create](#create).
4525
-
4526
- Optional — adapters that can't be written to from scratch (e.g. read-only zip
4527
- handles) should leave this off, and `Epub.using(...).create(...)` will throw.
4528
-
4529
- ##### Parameters
4530
-
4531
- | Parameter | Type |
4532
- | --------- | ------ |
4533
- | `opts?` | `Opts` |
4534
-
4535
- ##### Returns
4536
-
4537
- `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
4538
-
4539
- ---
4540
-
4541
- ## EpubStorageCapabilities
4542
-
4543
- Defined in:
4544
- [libraries/epub/adapters/interface.ts:12](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L12)
4545
-
4546
- ### Properties
4547
-
4548
- #### writable
4549
-
4550
- > `readonly` **writable**: `boolean`
4551
-
4552
- Defined in:
4553
- [libraries/epub/adapters/interface.ts:14](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/interface.ts#L14)
4554
-
4555
- when false, the Epub class refuses every mutation method at runtime
4556
-
4557
- ---
4558
-
4559
- ## FromOptions
4560
-
4561
- Defined in:
4562
- [libraries/epub/index.ts:205](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L205)
4563
-
4564
- ### Properties
4565
-
4566
- #### readonly?
4567
-
4568
- > `optional` **readonly**: `boolean`
4569
-
4570
- Defined in:
4571
- [libraries/epub/index.ts:210](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/index.ts#L210)
4572
-
4573
- when true, mutation methods throw [EpubReadOnlyError](#epubreadonlyerror) at
4574
- runtime
4575
-
4576
- ##### Default
4577
-
4578
- ```ts
4579
- false
4580
- ```
4581
-
4582
- ---
4583
-
4584
- ## Landmark
4585
-
4586
- Defined in:
4587
- [libraries/epub/upgrade.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L87)
4588
-
4589
- ### Properties
4590
-
4591
- #### href
4592
-
4593
- > **href**: `string`
4594
-
4595
- Defined in:
4596
- [libraries/epub/upgrade.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L88)
4597
-
4598
- #### title
4599
-
4600
- > **title**: `string`
4601
-
4602
- Defined in:
4603
- [libraries/epub/upgrade.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L89)
4604
-
4605
- #### type
4606
-
4607
- > **type**: `string`
4608
-
4609
- Defined in:
4610
- [libraries/epub/upgrade.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/upgrade.ts#L90)
4611
-
4612
- ---
4613
-
4614
- ## MemoryAdapterOptions
4615
-
4616
- Defined in:
4617
- [libraries/epub/adapters/memory.ts:15](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L15)
4618
-
4619
- ### Properties
4620
-
4621
- #### cache?
4622
-
4623
- > `optional` **cache**: `boolean`
4624
-
4625
- Defined in:
4626
- [libraries/epub/adapters/memory.ts:22](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/adapters/memory.ts#L22)
4627
-
4628
- per-entry decompressed buffer cache turn it off when opening many EPUBs and
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)
4102
+ [libraries/epub/index.ts:165](https://gitlab.com