@readium/shared 2.6.0 → 2.7.0

package/dist/index.js

@@ -1 +1 @@
-import{EmptyFetcher as o}from"./fetcher/Fetcher.js";import{HttpFetcher as i,HttpResource as a}from"./fetcher/HttpFetcher.js";import{NumberRange as n,Resource as p}from"./fetcher/Resource.js";import{AccessMode as x,Accessibility as l,AccessibilityProfile as s,Certification as g,Exemption as c,Feature as d,Hazard as u,PrimaryAccessMode as T}from"./publication/accessibility/Accessibility.js";import{AccessibilityMetadataDisplayGuide as y,AccessibilitySummary as C,AdditionalInformation as A,Conformance as P,HazardType as L,Hazards as N,Legal as S,Navigation as I,NonvisualReading as O,PrerecordedAudio as R,RichContent as v,RichContentType as E,VisualAdjustments as H,WaysOfReading as M}from"./publication/accessibility/AccessibilityMetadataDisplayGuide.js";import{Localization as k}from"./publication/accessibility/Localization.js";import{Encryption as F}from"./publication/encryption/Encryption.js";import{getEncryption as J}from"./publication/encryption/Properties.js";import{MediaOverlay as G}from"./publication/epub/MediaOverlay.js";import{getMediaOverlay as q}from"./publication/epub/Metadata.js";import{getContains as U}from"./publication/epub/Properties.js";import{getLandmarks as Q,getListOfAudioClips as W,getListOfIllustrations as w,getListOfTables as X,getListOfVideoClips as Y,getPageList as Z}from"./publication/epub/Publication.js";import{DomRange as $}from"./publication/html/DomRange.js";import{DomRangePoint as te}from"./publication/html/DomRangePoint.js";import{getCssSelector as re,getDomRange as ie,getFragmentParameters as ae,getHtmlId as me,getPage as ne,getPartialCfi as pe,getSpace as fe,getTextFragment as xe,getTime as le}from"./publication/html/Locations.js";import{getAuthenticate as ge,getAvailability as ce,getCopies as de,getHolds as ue,getIndirectAcquisitions as Te,getNumberOfItems as be,getPrice as ye}from"./publication/opds/Properties.js";import{getImages as Ae}from"./publication/opds/Publication.js";import{buildHtmlTimeline as Le}from"./publication/services/timeline/html.js";import{buildAudioTimeline as Se}from"./publication/services/timeline/audio.js";import{Timeline as Oe}from"./publication/services/timeline/Timeline.js";import{buildTimeline as ve}from"./publication/services/timeline/index.js";import{Content as He}from"./publication/services/content/Content.js";import{TextContentTokenizer as De}from"./publication/services/content/ContentTokenizer.js";import{IllegalStateError as ze,Iterator as Fe}from"./publication/services/content/Iterator.js";import{AudioElement as Je,ContentElement as je,ImageElement as Ge,TextElement as Ve,TextSegment as qe,TextualElement as Be,VideoElement as Ue}from"./publication/services/content/element/element.js";import{Attribute as Qe,AttributeKeys as We,AttributesHolder as we}from"./publication/services/content/element/attributes.js";import{Body as Ye,Footnote as Ze,Heading as _e,TextQuote as $e}from"./publication/services/content/element/text_role.js";import{PublicationContentIterator as tt}from"./publication/services/content/iterators/PublicationContentIterator.js";import{PDFContentElement as rt,PageContentIteratorPDF as it}from"./publication/services/content/iterators/PDFTextContentIterator.js";import{HTMLResourceContentIterator as mt}from"./publication/services/content/iterators/HTMLResourceContentIterator.js";import{AltIdentifier as pt}from"./publication/AltIdentifier.js";import{BelongsTo as xt}from"./publication/BelongsTo.js";import{Contributor as st,Contributors as gt}from"./publication/Contributor.js";import{Link as dt,Links as ut}from"./publication/Link.js";import{LocalizedString as bt}from"./publication/LocalizedString.js";import{Locator as Ct,LocatorLocations as At,LocatorText as Pt}from"./publication/Locator.js";import{LocatorCollection as Nt,LocatorCollectionMetadata as St}from"./publication/LocatorCollection.js";import{Manifest as Ot}from"./publication/Manifest.js";import{Metadata as vt}from"./publication/Metadata.js";import{Profile as Ht}from"./publication/Profiles.js";import{Page as Dt,Properties as kt}from"./publication/Properties.js";import{Publication as Ft}from"./publication/Publication.js";import{PublicationCollection as Jt}from"./publication/PublicationCollection.js";import{Layout as Gt}from"./publication/Layout.js";import{ReadingProgression as qt,leadingPage as Bt}from"./publication/ReadingProgression.js";import{Subject as Kt,Subjects as Qt}from"./publication/Subject.js";import{TDM as wt,TDMReservation as Xt}from"./publication/TDM.js";import{GuidedNavigationDocument as Zt,GuidedNavigationObject as _t,GuidedNavigationText as $t}from"./publication/GuidedNavigation.js";import{Price as to}from"./opds/Price.js";import{Acquisition as ro}from"./opds/Acquisition.js";import{Holds as ao}from"./opds/Holds.js";import{Copies as no}from"./opds/Copies.js";import{Availability as fo,AvailabilityStatus as xo}from"./opds/Availability.js";import{MediaType as so}from"./util/mediatype/MediaType.js";import{arrayfromJSON as co,arrayfromJSONorString as uo,datefromJSON as To,numberfromJSON as bo,positiveNumberfromJSON as yo,setToArray as Co}from"./util/JSONParse.js";import{formatNptTime as Po,isNptStartOfResource as Lo,parseNptTime as No}from"./util/npt.js";import{URITemplate as Io}from"./util/URITemplate.js";import{DefaultTextContentTokenizer as Ro,IntlTextTokenizer as vo,NaiveTextTokenizer as Eo,TextUnit as Ho,speakableToken as Mo}from"./util/tokenizer/TextTokenizer.js";export{x as AccessMode,l as Accessibility,y as AccessibilityMetadataDisplayGuide,s as AccessibilityProfile,C as AccessibilitySummary,ro as Acquisition,A as AdditionalInformation,pt as AltIdentifier,Qe as Attribute,We as AttributeKeys,we as AttributesHolder,Je as AudioElement,fo as Availability,xo as AvailabilityStatus,xt as BelongsTo,Ye as Body,g as Certification,P as Conformance,He as Content,je as ContentElement,st as Contributor,gt as Contributors,no as Copies,Ro as DefaultTextContentTokenizer,$ as DomRange,te as DomRangePoint,o as EmptyFetcher,F as Encryption,c as Exemption,d as Feature,Ze as Footnote,Zt as GuidedNavigationDocument,_t as GuidedNavigationObject,$t as GuidedNavigationText,mt as HTMLResourceContentIterator,u as Hazard,L as HazardType,N as Hazards,_e as Heading,ao as Holds,i as HttpFetcher,a as HttpResource,ze as IllegalStateError,Ge as ImageElement,vo as IntlTextTokenizer,Fe as Iterator,Gt as Layout,S as Legal,dt as Link,ut as Links,k as Localization,bt as LocalizedString,Ct as Locator,Nt as LocatorCollection,St as LocatorCollectionMetadata,At as LocatorLocations,Pt as LocatorText,Ot as Manifest,G as MediaOverlay,so as MediaType,vt as Metadata,Eo as NaiveTextTokenizer,I as Navigation,O as NonvisualReading,n as NumberRange,rt as PDFContentElement,Dt as Page,it as PageContentIteratorPDF,R as PrerecordedAudio,to as Price,T as PrimaryAccessMode,Ht as Profile,kt as Properties,Ft as Publication,Jt as PublicationCollection,tt as PublicationContentIterator,qt as ReadingProgression,p as Resource,v as RichContent,E as RichContentType,Kt as Subject,Qt as Subjects,wt as TDM,Xt as TDMReservation,De as TextContentTokenizer,Ve as TextElement,$e as TextQuote,qe as TextSegment,Ho as TextUnit,Be as TextualElement,Oe as Timeline,Io as URITemplate,Ue as VideoElement,H as VisualAdjustments,M as WaysOfReading,co as arrayfromJSON,uo as arrayfromJSONorString,Se as buildAudioTimeline,Le as buildHtmlTimeline,ve as buildTimeline,To as datefromJSON,Po as formatNptTime,ge as getAuthenticate,ce as getAvailability,U as getContains,de as getCopies,re as getCssSelector,ie as getDomRange,J as getEncryption,ae as getFragmentParameters,ue as getHolds,me as getHtmlId,Ae as getImages,Te as getIndirectAcquisitions,Q as getLandmarks,W as getListOfAudioClips,w as getListOfIllustrations,X as getListOfTables,Y as getListOfVideoClips,q as getMediaOverlay,be as getNumberOfItems,ne as getPage,Z as getPageList,pe as getPartialCfi,ye as getPrice,fe as getSpace,xe as getTextFragment,le as getTime,Lo as isNptStartOfResource,Bt as leadingPage,bo as numberfromJSON,No as parseNptTime,yo as positiveNumberfromJSON,Co as setToArray,Mo as speakableToken};
+import{EmptyFetcher as o}from"./fetcher/Fetcher.js";import{HttpFetcher as i,HttpResource as a}from"./fetcher/HttpFetcher.js";import{NumberRange as n,Resource as p}from"./fetcher/Resource.js";import{AccessMode as x,Accessibility as l,AccessibilityProfile as s,Certification as g,Exemption as c,Feature as d,Hazard as u,PrimaryAccessMode as T}from"./publication/accessibility/Accessibility.js";import{AccessibilityMetadataDisplayGuide as y,AccessibilitySummary as C,AdditionalInformation as A,Conformance as P,HazardType as L,Hazards as N,Legal as S,Navigation as I,NonvisualReading as O,PrerecordedAudio as R,RichContent as v,RichContentType as E,VisualAdjustments as H,WaysOfReading as M}from"./publication/accessibility/AccessibilityMetadataDisplayGuide.js";import{Localization as k}from"./publication/accessibility/Localization.js";import{Encryption as F}from"./publication/encryption/Encryption.js";import{getEncryption as G}from"./publication/encryption/Properties.js";import{MediaOverlay as j}from"./publication/epub/MediaOverlay.js";import{getMediaOverlay as q}from"./publication/epub/Metadata.js";import{getContains as U}from"./publication/epub/Properties.js";import{getLandmarks as Q,getListOfAudioClips as W,getListOfIllustrations as w,getListOfTables as X,getListOfVideoClips as Y,getPageList as Z}from"./publication/epub/Publication.js";import{DomRange as $}from"./publication/html/DomRange.js";import{DomRangePoint as te}from"./publication/html/DomRangePoint.js";import{getCssSelector as re,getDomRange as ie,getFragmentParameters as ae,getHtmlId as me,getPage as ne,getPartialCfi as pe,getSpace as fe,getTextFragment as xe,getTime as le}from"./publication/html/Locations.js";import{getAuthenticate as ge,getAvailability as ce,getCopies as de,getHolds as ue,getIndirectAcquisitions as Te,getNumberOfItems as be,getPrice as ye}from"./publication/opds/Properties.js";import{getImages as Ae}from"./publication/opds/Publication.js";import{buildHtmlTimeline as Le}from"./publication/services/timeline/html.js";import{buildAudioTimeline as Se}from"./publication/services/timeline/audio.js";import{Timeline as Oe}from"./publication/services/timeline/Timeline.js";import{buildTimeline as ve}from"./publication/services/timeline/index.js";import{Content as He}from"./publication/services/content/Content.js";import{TextContentTokenizer as De}from"./publication/services/content/ContentTokenizer.js";import{IllegalStateError as ze,Iterator as Fe}from"./publication/services/content/Iterator.js";import{AudioElement as Ge,ContentElement as Je,ImageElement as je,TextElement as Ve,TextSegment as qe,TextualElement as Be,VideoElement as Ue}from"./publication/services/content/element/element.js";import{Attribute as Qe,AttributeKeys as We,AttributesHolder as we}from"./publication/services/content/element/attributes.js";import{Body as Ye,Footnote as Ze,Heading as _e,TextQuote as $e}from"./publication/services/content/element/text_role.js";import{PublicationContentIterator as tt}from"./publication/services/content/iterators/PublicationContentIterator.js";import{PDFContentElement as rt,PageContentIteratorPDF as it}from"./publication/services/content/iterators/PDFTextContentIterator.js";import{HTMLResourceContentIterator as mt}from"./publication/services/content/iterators/HTMLResourceContentIterator.js";import{AltIdentifier as pt}from"./publication/AltIdentifier.js";import{BelongsTo as xt}from"./publication/BelongsTo.js";import{Contributor as st,Contributors as gt}from"./publication/Contributor.js";import{Link as dt,Links as ut}from"./publication/Link.js";import{LocalizedString as bt}from"./publication/LocalizedString.js";import{Locator as Ct,LocatorLocations as At,LocatorText as Pt}from"./publication/Locator.js";import{LocatorCollection as Nt,LocatorCollectionMetadata as St}from"./publication/LocatorCollection.js";import{Manifest as Ot}from"./publication/Manifest.js";import{Metadata as vt}from"./publication/Metadata.js";import{Profile as Ht}from"./publication/Profiles.js";import{Page as Dt,Properties as kt}from"./publication/Properties.js";import{Publication as Ft}from"./publication/Publication.js";import{PublicationCollection as Gt}from"./publication/PublicationCollection.js";import{Layout as jt}from"./publication/Layout.js";import{ReadingProgression as qt,leadingPage as Bt}from"./publication/ReadingProgression.js";import{Subject as Kt,Subjects as Qt}from"./publication/Subject.js";import{TDM as wt,TDMReservation as Xt}from"./publication/TDM.js";import{GuidedNavigationDescription as Zt,GuidedNavigationDocument as _t,GuidedNavigationObject as $t,GuidedNavigationText as eo}from"./publication/GuidedNavigation.js";import{Price as oo}from"./opds/Price.js";import{Acquisition as io}from"./opds/Acquisition.js";import{Holds as mo}from"./opds/Holds.js";import{Copies as po}from"./opds/Copies.js";import{Availability as xo,AvailabilityStatus as lo}from"./opds/Availability.js";import{MediaType as go}from"./util/mediatype/MediaType.js";import{arrayfromJSON as uo,arrayfromJSONorString as To,datefromJSON as bo,numberfromJSON as yo,positiveNumberfromJSON as Co,setToArray as Ao}from"./util/JSONParse.js";import{formatNptTime as Lo,isNptStartOfResource as No,parseNptTime as So}from"./util/npt.js";import{URITemplate as Oo}from"./util/URITemplate.js";import{DefaultTextContentTokenizer as vo,IntlTextTokenizer as Eo,NaiveTextTokenizer as Ho,TextUnit as Mo,speakableToken as Do}from"./util/tokenizer/TextTokenizer.js";export{x as AccessMode,l as Accessibility,y as AccessibilityMetadataDisplayGuide,s as AccessibilityProfile,C as AccessibilitySummary,io as Acquisition,A as AdditionalInformation,pt as AltIdentifier,Qe as Attribute,We as AttributeKeys,we as AttributesHolder,Ge as AudioElement,xo as Availability,lo as AvailabilityStatus,xt as BelongsTo,Ye as Body,g as Certification,P as Conformance,He as Content,Je as ContentElement,st as Contributor,gt as Contributors,po as Copies,vo as DefaultTextContentTokenizer,$ as DomRange,te as DomRangePoint,o as EmptyFetcher,F as Encryption,c as Exemption,d as Feature,Ze as Footnote,Zt as GuidedNavigationDescription,_t as GuidedNavigationDocument,$t as GuidedNavigationObject,eo as GuidedNavigationText,mt as HTMLResourceContentIterator,u as Hazard,L as HazardType,N as Hazards,_e as Heading,mo as Holds,i as HttpFetcher,a as HttpResource,ze as IllegalStateError,je as ImageElement,Eo as IntlTextTokenizer,Fe as Iterator,jt as Layout,S as Legal,dt as Link,ut as Links,k as Localization,bt as LocalizedString,Ct as Locator,Nt as LocatorCollection,St as LocatorCollectionMetadata,At as LocatorLocations,Pt as LocatorText,Ot as Manifest,j as MediaOverlay,go as MediaType,vt as Metadata,Ho as NaiveTextTokenizer,I as Navigation,O as NonvisualReading,n as NumberRange,rt as PDFContentElement,Dt as Page,it as PageContentIteratorPDF,R as PrerecordedAudio,oo as Price,T as PrimaryAccessMode,Ht as Profile,kt as Properties,Ft as Publication,Gt as PublicationCollection,tt as PublicationContentIterator,qt as ReadingProgression,p as Resource,v as RichContent,E as RichContentType,Kt as Subject,Qt as Subjects,wt as TDM,Xt as TDMReservation,De as TextContentTokenizer,Ve as TextElement,$e as TextQuote,qe as TextSegment,Mo as TextUnit,Be as TextualElement,Oe as Timeline,Oo as URITemplate,Ue as VideoElement,H as VisualAdjustments,M as WaysOfReading,uo as arrayfromJSON,To as arrayfromJSONorString,Se as buildAudioTimeline,Le as buildHtmlTimeline,ve as buildTimeline,bo as datefromJSON,Lo as formatNptTime,ge as getAuthenticate,ce as getAvailability,U as getContains,de as getCopies,re as getCssSelector,ie as getDomRange,G as getEncryption,ae as getFragmentParameters,ue as getHolds,me as getHtmlId,Ae as getImages,Te as getIndirectAcquisitions,Q as getLandmarks,W as getListOfAudioClips,w as getListOfIllustrations,X as getListOfTables,Y as getListOfVideoClips,q as getMediaOverlay,be as getNumberOfItems,ne as getPage,Z as getPageList,pe as getPartialCfi,ye as getPrice,fe as getSpace,xe as getTextFragment,le as getTime,No as isNptStartOfResource,Bt as leadingPage,yo as numberfromJSON,So as parseNptTime,Co as positiveNumberfromJSON,Ao as setToArray,Do as speakableToken};

package/dist/publication/GuidedNavigation.js

@@ -1 +1 @@
-import{arrayfromJSONorString as a,setToArray as n}from"../util/JSONParse.js";import{Links as o}from"./Link.js";class d{constructor(i){this.links=i.links,this.guided=i.guided}static deserialize(i){if(i)return new d({links:o.deserialize(i.links),guided:r.deserializeArray(i.guided)})}serialize(){const i={};return this.links!==void 0&&(i.links=this.links.serialize()),this.guided!==void 0&&(i.guided=this.guided.map(e=>e.serialize())),i}}class s{constructor(i){this.plain=i.plain,this.ssml=i.ssml,this.language=i.language}static deserialize(i){if(i!=null){if(typeof i=="string")return new s({plain:i});if(i.plain||i.ssml||i.language)return new s({plain:i.plain,ssml:i.ssml,language:i.language})}}serialize(){const i={};return this.plain!==void 0&&(i.plain=this.plain),this.ssml!==void 0&&(i.ssml=this.ssml),this.language!==void 0&&(i.language=this.language),Object.keys(i).length>0?i:void 0}}class r{constructor(i){this.audioref=i.audioref,this.children=i.children,this.imgref=i.imgref,this.role=i.role,this.level=i.level!==void 0?Math.min(6,Math.max(1,i.level)):void 0,this.text=i.text,this.textref=i.textref,this.description=i.description}get plainText(){return this.text?.plain}get ssmlText(){return this.text?.ssml}get textLanguage(){return this.text?.language}static deserialize(i){if(i)return new r({audioref:i.audioref,children:r.deserializeArray(i.children),imgref:i.imgref,role:i.role?new Set(a(i.role)):void 0,level:typeof i.level=="number"?i.level:void 0,text:s.deserialize(i.text),textref:i.textref,description:r.deserialize(i.description)})}static deserializeArray(i){if(Array.isArray(i))return i.map(e=>r.deserialize(e)).filter(e=>e!==void 0)}serialize(){const i={};if(this.audioref!==void 0&&(i.audioref=this.audioref),this.children!==void 0&&(i.children=this.children.map(e=>e.serialize())),this.imgref!==void 0&&(i.imgref=this.imgref),this.role!==void 0&&(i.role=n(this.role)),this.level!==void 0&&(i.level=this.level),this.text!==void 0){const e=this.text.serialize();e!==void 0&&(i.text=e)}return this.textref!==void 0&&(i.textref=this.textref),this.description&&(i.description=this.description.serialize()),i}get audioFile(){return this.audioref?.split("#")[0]}get audioTime(){if(this.audioref?.includes("#"))return this.audioref.split("#",2)[1]}get textFile(){return this.textref?.split("#")[0]}get fragmentId(){if(this.textref?.includes("#"))return this.textref.split("#",2)[1]}get clip(){const i=this.audioFile;if(!i)return;const e=this.audioTime,t={audioResource:i,fragmentId:this.fragmentId};if(!e)return t;const l=this.parseTimer(e);return t.start=l[0],t.end=l[1],t}parseTimer(i){if(!i||!i.startsWith("t="))return[void 0,void 0];const e=i.substring(2).split(",").map(t=>parseFloat(t));return e.length===1?[isNaN(e[0])?void 0:e[0],void 0]:e.length>2?[void 0,void 0]:[isNaN(e[0])?void 0:e[0],isNaN(e[1])?void 0:e[1]]}}export{d as GuidedNavigationDocument,r as GuidedNavigationObject,s as GuidedNavigationText};
+import{arrayfromJSONorString as a,setToArray as n}from"../util/JSONParse.js";class f{constructor(i){this.guided=i.guided}static deserialize(i){if(!i)return;const e=r.deserializeArray(i.guided);if(!(!e||e.length===0))return new f({guided:e})}serialize(){return{guided:this.guided.map(i=>i.serialize())}}}class d{constructor(i){this.plain=i.plain,this.ssml=i.ssml,this.language=i.language}static deserialize(i){if(i!=null){if(typeof i=="string")return i.length>0?new d({plain:i}):void 0;if(i.plain||i.ssml)return new d({plain:i.plain,ssml:i.ssml,language:i.language})}}serialize(){const i={};return this.plain!==void 0&&(i.plain=this.plain),this.ssml!==void 0&&(i.ssml=this.ssml),this.language!==void 0&&(i.language=this.language),Object.keys(i).length>0?i:void 0}}class s{constructor(i){this.audioref=i.audioref,this.imgref=i.imgref,this.textref=i.textref,this.videoref=i.videoref,this.text=i.text}static deserialize(i){if(!i)return;const e=new s({audioref:i.audioref,imgref:i.imgref,textref:i.textref,videoref:i.videoref,text:d.deserialize(i.text)});if(!(e.audioref===void 0&&e.imgref===void 0&&e.textref===void 0&&e.videoref===void 0&&e.text===void 0))return e}serialize(){const i={};this.audioref!==void 0&&(i.audioref=this.audioref),this.imgref!==void 0&&(i.imgref=this.imgref),this.textref!==void 0&&(i.textref=this.textref),this.videoref!==void 0&&(i.videoref=this.videoref);const e=this.text?.serialize();return e!==void 0&&(i.text=e),i}}class r{constructor(i){this.id=i.id,this.audioref=i.audioref,this.children=i.children,this.imgref=i.imgref,this.role=i.role,this.text=i.text,this.textref=i.textref,this.videoref=i.videoref,this.description=i.description}get plainText(){return this.text?.plain}get ssmlText(){return this.text?.ssml}get textLanguage(){return this.text?.language}static deserialize(i){if(!i)return;const e=r.deserializeArray(i.children),t=new r({id:typeof i.id=="string"?i.id:void 0,audioref:i.audioref,children:e&&e.length>0?e:void 0,imgref:i.imgref,role:i.role?new Set(a(i.role)):void 0,text:d.deserialize(i.text),textref:i.textref,videoref:i.videoref,description:s.deserialize(i.description)});if(!(t.audioref===void 0&&t.imgref===void 0&&t.textref===void 0&&t.videoref===void 0&&t.text===void 0&&t.children===void 0))return t}static deserializeArray(i){if(Array.isArray(i))return i.map(e=>r.deserialize(e)).filter(e=>e!==void 0)}serialize(){const i={};if(this.id!==void 0&&(i.id=this.id),this.audioref!==void 0&&(i.audioref=this.audioref),this.children!==void 0&&(i.children=this.children.map(e=>e.serialize())),this.imgref!==void 0&&(i.imgref=this.imgref),this.role!==void 0&&(i.role=n(this.role)),this.text!==void 0){const e=this.text.serialize();e!==void 0&&(i.text=e)}return this.textref!==void 0&&(i.textref=this.textref),this.videoref!==void 0&&(i.videoref=this.videoref),this.description!==void 0&&(i.description=this.description.serialize()),i}get audioFile(){return this.audioref?.split("#")[0]}get audioTime(){if(this.audioref?.includes("#"))return this.audioref.split("#",2)[1]}get textFile(){return this.textref?.split("#")[0]}get fragmentId(){if(this.textref?.includes("#"))return this.textref.split("#",2)[1]}get clip(){const i=this.audioFile;if(!i)return;const e=this.audioTime,t={audioResource:i,fragmentId:this.fragmentId};if(!e)return t;const o=this.parseTimer(e);return t.start=o[0],t.end=o[1],t}parseTimer(i){if(!i||!i.startsWith("t="))return[void 0,void 0];const e=i.substring(2).split(",").map(t=>parseFloat(t));return e.length===1?[isNaN(e[0])?void 0:e[0],void 0]:e.length>2?[void 0,void 0]:[isNaN(e[0])?void 0:e[0],isNaN(e[1])?void 0:e[1]]}}export{s as GuidedNavigationDescription,f as GuidedNavigationDocument,r as GuidedNavigationObject,d as GuidedNavigationText};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/shared",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "type": "module",
   "description": "Shared models to be used across other Readium projects and implementations in Typescript",
   "author": "readium",
@@ -56,7 +56,7 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@readium/helpers": "1.1.1"
+    "@readium/helpers": "1.2.0"
   },
   "files": [
     "dist",
@@ -64,7 +64,7 @@
     "types"
   ],
   "engines": {
-    "node": ">=18"
+    "node": ">=24"
   },
   "devDependencies": {
     "@babel/core": "^7.28.6",

package/src/publication/GuidedNavigation.ts

@@ -2,7 +2,6 @@ import {
   arrayfromJSONorString,
   setToArray,
 } from '../util/JSONParse.ts';
-import { Links } from "./Link.ts";
 
 export interface Clip {
     audioResource: string;
@@ -16,35 +15,34 @@ export interface Clip {
  * https://readium.org/guided-navigation/schema/document.schema.json
  */
 export class GuidedNavigationDocument {
-    public readonly links?: Links;
-    public readonly guided?: GuidedNavigationObject[];
+    /** Non-empty sequence of objects meant to be presented sequentially to the user. */
+    public readonly guided: GuidedNavigationObject[];
 
     constructor(values: {
-        links?: Links;
-        guided?: GuidedNavigationObject[];
+        guided: GuidedNavigationObject[];
     }) {
-        this.links = values.links;
         this.guided = values.guided;
     }
 
+    /**
+     * Deserializes a GuidedNavigationDocument from JSON.
+     * Returns undefined if `guided` is missing or has no valid object.
+     */
     public static deserialize(json: any): GuidedNavigationDocument | undefined {
         if (!json) return;
-        return new GuidedNavigationDocument({
-            links: Links.deserialize(json.links),
-            guided: GuidedNavigationObject.deserializeArray(json.guided),
-        });
+        const guided = GuidedNavigationObject.deserializeArray(json.guided);
+        if (!guided || guided.length === 0) return;
+        return new GuidedNavigationDocument({ guided });
     }
 
     public serialize(): any {
-        const json: any = {};
-        if (this.links !== undefined) json.links = this.links.serialize();
-        if (this.guided !== undefined) json.guided = this.guided.map(x => x.serialize());
-        return json;
+        return { guided: this.guided.map(x => x.serialize()) };
     }
 }
 
 /**
  * Represents a text value containing plain text, SSML, and language information.
+ * https://readium.org/guided-navigation/schema/text.schema.json
  */
 export class GuidedNavigationText {
     /** Plain text content */
@@ -76,11 +74,11 @@ export class GuidedNavigationText {
         if (json === undefined || json === null) return undefined;
 
         if (typeof json === 'string') {
-            return new GuidedNavigationText({ plain: json });
+            return json.length > 0 ? new GuidedNavigationText({ plain: json }) : undefined;
         }
 
-        // Only create if there are actual values
-        if (json.plain || json.ssml || json.language) {
+        // The schema requires a non-empty `plain` or `ssml`
+        if (json.plain || json.ssml) {
             return new GuidedNavigationText({
                 plain: json.plain,
                 ssml: json.ssml,
@@ -104,11 +102,82 @@ export class GuidedNavigationText {
 }
 
 /**
- * Guided Navigation Object
- * https://github.com/readium/guided-navigation/blob/main/schema/object.schema.json
+ * Text, audio, image or video description of a Guided Navigation Object.
+ * https://readium.org/guided-navigation/schema/description.schema.json
  */
+export class GuidedNavigationDescription {
+    /** References an audio resource or a fragment of it. */
+    public readonly audioref?: string;
+
+    /** References an image or a fragment of it. */
+    public readonly imgref?: string;
+
+    /** References a textual resource or a fragment of it. */
+    public readonly textref?: string;
+
+    /** References a video resource or a fragment of it. */
+    public readonly videoref?: string;
+
+    /** Textual description. */
+    public readonly text?: GuidedNavigationText;
+
+    constructor(values: {
+        audioref?: string;
+        imgref?: string;
+        textref?: string;
+        videoref?: string;
+        text?: GuidedNavigationText;
+    }) {
+        this.audioref = values.audioref;
+        this.imgref = values.imgref;
+        this.textref = values.textref;
+        this.videoref = values.videoref;
+        this.text = values.text;
+    }
+
+    /**
+     * Deserializes a GuidedNavigationDescription from JSON.
+     * Returns undefined if it has none of the refs nor text.
+     */
+    public static deserialize(json: any): GuidedNavigationDescription | undefined {
+        if (!json) return undefined;
+        const description = new GuidedNavigationDescription({
+            audioref: json.audioref,
+            imgref: json.imgref,
+            textref: json.textref,
+            videoref: json.videoref,
+            text: GuidedNavigationText.deserialize(json.text)
+        });
+        if (
+            description.audioref === undefined &&
+            description.imgref === undefined &&
+            description.textref === undefined &&
+            description.videoref === undefined &&
+            description.text === undefined
+        ) return undefined;
+        return description;
+    }
+
+    public serialize(): any {
+        const json: any = {};
+        if (this.audioref !== undefined) json.audioref = this.audioref;
+        if (this.imgref !== undefined) json.imgref = this.imgref;
+        if (this.textref !== undefined) json.textref = this.textref;
+        if (this.videoref !== undefined) json.videoref = this.videoref;
+        const text = this.text?.serialize();
+        if (text !== undefined) json.text = text;
+        return json;
+    }
+}
 
+/**
+ * Guided Navigation Object
+ * https://readium.org/guided-navigation/schema/document.schema.json
+ */
 export class GuidedNavigationObject {
+  /** Identifier of the object. */
+  public readonly id?: string;
+
   /** References an audio resource or a fragment of it. */
   public readonly audioref?: string;
 
@@ -121,13 +190,6 @@ export class GuidedNavigationObject {
   /** Convey the structural semantics of a publication. */
   public readonly role?: Set<string>;
 
-  /**
-   * Indicates the heading level (1-6) for the navigation object.
-   * @minimum 1
-   * @maximum 6
-   */
-  public readonly level?: number;
-
   /**
    * Textual equivalent of the resources or fragment of the resources referenced by the current Guided Navigation Object.
    */
@@ -136,32 +198,34 @@ export class GuidedNavigationObject {
   /** References a textual resource or a fragment of it. */
   public readonly textref?: string;
 
-  /**
-   * Describes the image referenced by the current Guided Navigation Object.
-   * This is a GuidedNavigationObject that should not contain 'level' or 'children' properties.
-   */
-  public readonly description?: Omit<GuidedNavigationObject, 'level' | 'children'>;
+  /** References a video resource or a fragment of it. */
+  public readonly videoref?: string;
+
+  /** Text, audio, image or video description of the current Guided Navigation Object. */
+  public readonly description?: GuidedNavigationDescription;
 
     /**
      * Creates a [GuidedNavigation] object.
     */
     constructor(values: {
+        id?: string;
         audioref?: string;
         children?: GuidedNavigationObject[];
         imgref?: string;
         role?: Set<string>;
-        level?: number;
         text?: GuidedNavigationText;
         textref?: string;
-        description?: Omit<GuidedNavigationObject, 'level' | 'children'>;
+        videoref?: string;
+        description?: GuidedNavigationDescription;
     }) {
+        this.id = values.id;
         this.audioref = values.audioref;
         this.children = values.children;
         this.imgref = values.imgref;
         this.role = values.role;
-        this.level = values.level !== undefined ? Math.min(6, Math.max(1, values.level)) : undefined;
         this.text = values.text;
         this.textref = values.textref;
+        this.videoref = values.videoref;
         this.description = values.description;
     }
 
@@ -188,23 +252,35 @@ export class GuidedNavigationObject {
     }
 
     /**
-     * Deserializes a GuidedNavigationObject from JSON
+     * Deserializes a GuidedNavigationObject from JSON.
+     * Returns undefined if it has none of the refs, text, nor children.
      */
     public static deserialize(json: any): GuidedNavigationObject | undefined {
         if (!json) return undefined;
 
-        return new GuidedNavigationObject({
+        const children = GuidedNavigationObject.deserializeArray(json.children);
+        const obj = new GuidedNavigationObject({
+            id: typeof json.id === 'string' ? json.id : undefined,
             audioref: json.audioref,
-            children: GuidedNavigationObject.deserializeArray(json.children),
+            children: children && children.length > 0 ? children : undefined,
             imgref: json.imgref,
             role: json.role
                 ? new Set<string>(arrayfromJSONorString(json.role))
                 : undefined,
-            level: typeof json.level === 'number' ? json.level : undefined,
             text: GuidedNavigationText.deserialize(json.text),
             textref: json.textref,
-            description: GuidedNavigationObject.deserialize(json.description)
+            videoref: json.videoref,
+            description: GuidedNavigationDescription.deserialize(json.description)
         });
+        if (
+            obj.audioref === undefined &&
+            obj.imgref === undefined &&
+            obj.textref === undefined &&
+            obj.videoref === undefined &&
+            obj.text === undefined &&
+            obj.children === undefined
+        ) return undefined;
+        return obj;
     }
 
     /**
@@ -213,8 +289,8 @@ export class GuidedNavigationObject {
     public static deserializeArray(json: any): GuidedNavigationObject[] | undefined {
         if (!(Array.isArray(json))) return undefined;
         return json
-            .map<GuidedNavigationObject>((item) => GuidedNavigationObject.deserialize(item) as GuidedNavigationObject)
-            .filter((x) => x !== undefined);
+            .map((item) => GuidedNavigationObject.deserialize(item))
+            .filter((x): x is GuidedNavigationObject => x !== undefined);
     }
 
     /**
@@ -222,11 +298,11 @@ export class GuidedNavigationObject {
      */
     public serialize(): any {
         const json: any = {};
+        if (this.id !== undefined) json.id = this.id;
         if (this.audioref !== undefined) json.audioref = this.audioref;
         if (this.children !== undefined) json.children = this.children.map(x => x.serialize());
         if (this.imgref !== undefined) json.imgref = this.imgref;
         if (this.role !== undefined) json.role = setToArray(this.role);
-        if (this.level !== undefined) json.level = this.level;
         if (this.text !== undefined) {
             const serializedText = this.text.serialize();
             if (serializedText !== undefined) {
@@ -234,9 +310,8 @@ export class GuidedNavigationObject {
             }
         }
         if (this.textref !== undefined) json.textref = this.textref;
-        if (this.description) {
-            json.description = this.description.serialize();
-        }
+        if (this.videoref !== undefined) json.videoref = this.videoref;
+        if (this.description !== undefined) json.description = this.description.serialize();
         return json;
     }
 

package/src/publication/services/content/ContentTokenizer.ts

@@ -2,9 +2,13 @@ import { DefaultTextContentTokenizer, Range, TextTokenizer, TextUnit, Tokenizer
 import { Locator, LocatorText } from "../../Locator.ts";
 import { ContentElement, TextElement, TextSegment } from "./element/index.ts";
 
-// A tokenizer splitting a [Content.Element] into smaller pieces.
+/**
+ * A tokenizer splitting a [Content.Element] into smaller pieces.
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export type ContentTokenizer  = Tokenizer<ContentElement, ContentElement>;
 
+/** @deprecated Use `@readium/speech`, which segments text itself. */
 export class TextContentTokenizer implements ContentTokenizer {
     /**
      *

package/src/publication/services/content/iterators/HTMLResourceContentIterator.ts

@@ -21,6 +21,8 @@ interface ElementWithDelta {
  * If you want to start from the end of the resource, the [locator] must have a `progression` of 1.0.
  *
  * Locators will contain a `before` context of up to `beforeMaxLength` characters.
+ *
+ * @deprecated Use `@readium/guided-navigation` and `@readium/speech` instead.
  */
 export class HTMLResourceContentIterator extends Iterator {
     private currentElement: ElementWithDelta | null = null;

package/src/util/tokenizer/TextTokenizer.ts

@@ -3,16 +3,21 @@ import { Tokenizer } from "./Tokenizer.ts";
 import BasicEnglishTokenizer from "./tokenize-english/index.js";
 import BasicTokenizer, { TextlintSegment } from "./tokenize-text/index.js";
 
-// Start / End
+/**
+ * Start / End
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export type Range = [number, number];
 
 /**
  * A tokenizer splitting a String into range tokens (e.g. words, sentences, etc.).
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export type TextTokenizer = Tokenizer<string, Range>;
 
 /**
  * A text token unit which can be used with a [TextTokenizer].
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export enum TextUnit {
     Word = "word",
@@ -20,7 +25,10 @@ export enum TextUnit {
     Paragraph = "paragraph",
 }
 
-//  A default cluster [TextTokenizer] taking advantage of the best capabilities of the navigator
+/**
+ * A default cluster [TextTokenizer] taking advantage of the best capabilities of the navigator
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export const DefaultTextContentTokenizer = (language: Language | null, unit: TextUnit): TextTokenizer => {
     if("Segmenter" in Intl) {
         // Available in any evergreen browser EXCEPT for Firefox.
@@ -35,6 +43,7 @@ export const DefaultTextContentTokenizer = (language: Language | null, unit: Tex
 /**
  * A [TextTokenizer] using the Intl.Segmenter API.
  * Very aware of language-specific rules since it uses ICU behind the scenes.
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export class IntlTextTokenizer implements TextTokenizer {
     private segmenter: Intl.Segmenter;
@@ -68,6 +77,7 @@ export class IntlTextTokenizer implements TextTokenizer {
  * A [TextTokenizer] using a naive approach to splitting text into tokens.
  * This is a fallback for browsers that don't support Intl.Segmenter.
  * It works mainly on English and similar languages. Don't use unless necessary.
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export class NaiveTextTokenizer {
     private tokenizer: BasicTokenizer;
@@ -116,8 +126,11 @@ export class NaiveTextTokenizer {
 
 const trimmedMatcher = new RegExp("[\\p{L}\\p{N}]+", "u");
 
-// Unicode-aware of checking if there's anything that can be spoken in a string
-// "Spoken" in this case means at least one unicode letter or unicode number character
+/**
+ * Unicode-aware of checking if there's anything that can be spoken in a string
+ * "Spoken" in this case means at least one unicode letter or unicode number character
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export const speakableToken = (token: string): string | null => {
     const trimmedToken = token.trimEnd();
     if(trimmedToken.length === 0) return null;

package/src/util/tokenizer/Tokenizer.ts

@@ -2,6 +2,7 @@
 
 /**
  * A tokenizer splits a piece of data [D] into a list of [T] tokens.
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export interface Tokenizer<D, T> {
     tokenize(data: D): T[];

package/types/src/publication/GuidedNavigation.d.ts

@@ -1,4 +1,3 @@
-import { Links } from "./Link.ts";
 export interface Clip {
     audioResource: string;
     fragmentId?: string;
@@ -10,17 +9,21 @@ export interface Clip {
  * https://readium.org/guided-navigation/schema/document.schema.json
  */
 export declare class GuidedNavigationDocument {
-    readonly links?: Links;
-    readonly guided?: GuidedNavigationObject[];
+    /** Non-empty sequence of objects meant to be presented sequentially to the user. */
+    readonly guided: GuidedNavigationObject[];
     constructor(values: {
-        links?: Links;
-        guided?: GuidedNavigationObject[];
+        guided: GuidedNavigationObject[];
     });
+    /**
+     * Deserializes a GuidedNavigationDocument from JSON.
+     * Returns undefined if `guided` is missing or has no valid object.
+     */
     static deserialize(json: any): GuidedNavigationDocument | undefined;
     serialize(): any;
 }
 /**
  * Represents a text value containing plain text, SSML, and language information.
+ * https://readium.org/guided-navigation/schema/text.schema.json
  */
 export declare class GuidedNavigationText {
     /** Plain text content */
@@ -46,11 +49,42 @@ export declare class GuidedNavigationText {
      */
     serialize(): any;
 }
+/**
+ * Text, audio, image or video description of a Guided Navigation Object.
+ * https://readium.org/guided-navigation/schema/description.schema.json
+ */
+export declare class GuidedNavigationDescription {
+    /** References an audio resource or a fragment of it. */
+    readonly audioref?: string;
+    /** References an image or a fragment of it. */
+    readonly imgref?: string;
+    /** References a textual resource or a fragment of it. */
+    readonly textref?: string;
+    /** References a video resource or a fragment of it. */
+    readonly videoref?: string;
+    /** Textual description. */
+    readonly text?: GuidedNavigationText;
+    constructor(values: {
+        audioref?: string;
+        imgref?: string;
+        textref?: string;
+        videoref?: string;
+        text?: GuidedNavigationText;
+    });
+    /**
+     * Deserializes a GuidedNavigationDescription from JSON.
+     * Returns undefined if it has none of the refs nor text.
+     */
+    static deserialize(json: any): GuidedNavigationDescription | undefined;
+    serialize(): any;
+}
 /**
  * Guided Navigation Object
- * https://github.com/readium/guided-navigation/blob/main/schema/object.schema.json
+ * https://readium.org/guided-navigation/schema/document.schema.json
  */
 export declare class GuidedNavigationObject {
+    /** Identifier of the object. */
+    readonly id?: string;
     /** References an audio resource or a fragment of it. */
     readonly audioref?: string;
     /** Items that are children of the containing Guided Navigation Object. */
@@ -59,35 +93,29 @@ export declare class GuidedNavigationObject {
     readonly imgref?: string;
     /** Convey the structural semantics of a publication. */
     readonly role?: Set<string>;
-    /**
-     * Indicates the heading level (1-6) for the navigation object.
-     * @minimum 1
-     * @maximum 6
-     */
-    readonly level?: number;
     /**
      * Textual equivalent of the resources or fragment of the resources referenced by the current Guided Navigation Object.
      */
     readonly text?: GuidedNavigationText;
     /** References a textual resource or a fragment of it. */
     readonly textref?: string;
-    /**
-     * Describes the image referenced by the current Guided Navigation Object.
-     * This is a GuidedNavigationObject that should not contain 'level' or 'children' properties.
-     */
-    readonly description?: Omit<GuidedNavigationObject, 'level' | 'children'>;
+    /** References a video resource or a fragment of it. */
+    readonly videoref?: string;
+    /** Text, audio, image or video description of the current Guided Navigation Object. */
+    readonly description?: GuidedNavigationDescription;
     /**
      * Creates a [GuidedNavigation] object.
     */
     constructor(values: {
+        id?: string;
         audioref?: string;
         children?: GuidedNavigationObject[];
         imgref?: string;
         role?: Set<string>;
-        level?: number;
         text?: GuidedNavigationText;
         textref?: string;
-        description?: Omit<GuidedNavigationObject, 'level' | 'children'>;
+        videoref?: string;
+        description?: GuidedNavigationDescription;
     });
     /**
      * Gets the plain text content.
@@ -103,7 +131,8 @@ export declare class GuidedNavigationObject {
      */
     get textLanguage(): string | undefined;
     /**
-     * Deserializes a GuidedNavigationObject from JSON
+     * Deserializes a GuidedNavigationObject from JSON.
+     * Returns undefined if it has none of the refs, text, nor children.
      */
     static deserialize(json: any): GuidedNavigationObject | undefined;
     /**

package/types/src/publication/services/content/ContentTokenizer.d.ts

@@ -1,6 +1,11 @@
 import { TextTokenizer, TextUnit, Tokenizer } from "../../../util/index.ts";
 import { ContentElement } from "./element/index.ts";
+/**
+ * A tokenizer splitting a [Content.Element] into smaller pieces.
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export type ContentTokenizer = Tokenizer<ContentElement, ContentElement>;
+/** @deprecated Use `@readium/speech`, which segments text itself. */
 export declare class TextContentTokenizer implements ContentTokenizer {
     private readonly defaultLanguage;
     private readonly contextSnippetLength;

package/types/src/publication/services/content/iterators/HTMLResourceContentIterator.d.ts

@@ -11,6 +11,8 @@ import { ContentElement } from "../element/index.ts";
  * If you want to start from the end of the resource, the [locator] must have a `progression` of 1.0.
  *
  * Locators will contain a `before` context of up to `beforeMaxLength` characters.
+ *
+ * @deprecated Use `@readium/guided-navigation` and `@readium/speech` instead.
  */
 export declare class HTMLResourceContentIterator extends Iterator {
     private resource;

package/types/src/util/tokenizer/TextTokenizer.d.ts

@@ -1,22 +1,33 @@
 import { Language } from "../Language.ts";
 import { Tokenizer } from "./Tokenizer.ts";
+/**
+ * Start / End
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export type Range = [number, number];
 /**
  * A tokenizer splitting a String into range tokens (e.g. words, sentences, etc.).
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export type TextTokenizer = Tokenizer<string, Range>;
 /**
  * A text token unit which can be used with a [TextTokenizer].
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export declare enum TextUnit {
     Word = "word",
     Sentence = "sentence",
     Paragraph = "paragraph"
 }
+/**
+ * A default cluster [TextTokenizer] taking advantage of the best capabilities of the navigator
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export declare const DefaultTextContentTokenizer: (language: Language | null, unit: TextUnit) => TextTokenizer;
 /**
  * A [TextTokenizer] using the Intl.Segmenter API.
  * Very aware of language-specific rules since it uses ICU behind the scenes.
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export declare class IntlTextTokenizer implements TextTokenizer {
     private unit;
@@ -28,6 +39,7 @@ export declare class IntlTextTokenizer implements TextTokenizer {
  * A [TextTokenizer] using a naive approach to splitting text into tokens.
  * This is a fallback for browsers that don't support Intl.Segmenter.
  * It works mainly on English and similar languages. Don't use unless necessary.
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export declare class NaiveTextTokenizer {
     private unit;
@@ -36,4 +48,9 @@ export declare class NaiveTextTokenizer {
     constructor(language: Language | null, unit: TextUnit);
     tokenize(data: string): Range[];
 }
+/**
+ * Unicode-aware of checking if there's anything that can be spoken in a string
+ * "Spoken" in this case means at least one unicode letter or unicode number character
+ * @deprecated Use `@readium/speech`, which segments text itself.
+ */
 export declare const speakableToken: (token: string) => string | null;

package/types/src/util/tokenizer/Tokenizer.d.ts

@@ -1,5 +1,6 @@
 /**
  * A tokenizer splits a piece of data [D] into a list of [T] tokens.
+ * @deprecated Use `@readium/speech`, which segments text itself.
  */
 export interface Tokenizer<D, T> {
     tokenize(data: D): T[];