@readium/shared 2.2.0-beta.3 → 2.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/shared",
-  "version": "2.2.0-beta.3",
+  "version": "2.2.1",
   "type": "module",
   "description": "Shared models to be used across other Readium projects and implementations in Typescript",
   "author": "readium",

package/src/fetcher/Fetcher.ts

@@ -1,5 +1,5 @@
-import { Link } from '../publication/Link';
-import { Resource } from './Resource';
+import { Link } from '../publication/Link.ts';
+import { Resource } from './Resource.ts';
 
 /** Provides access to a [Resource] from a [Link]. */
 export interface Fetcher {

package/src/fetcher/HttpFetcher.ts

@@ -1,6 +1,6 @@
-import { Link } from '../publication/Link';
-import { Fetcher } from './Fetcher';
-import { NumberRange, Resource } from './Resource';
+import { Link } from '../publication/Link.ts';
+import { Fetcher } from './Fetcher.ts';
+import { NumberRange, Resource } from './Resource.ts';
 
 export type FetchImplementation = (
   input: RequestInfo | URL,

package/src/fetcher/Resource.ts

@@ -1,4 +1,4 @@
-import { Link } from '../publication/Link';
+import { Link } from '../publication/Link.ts';
 
 export class NumberRange {
   // TODO move to utils

package/src/fetcher/index.ts

@@ -1,3 +1,3 @@
-export * from './Fetcher';
-export * from './HttpFetcher';
-export * from './Resource';
+export * from './Fetcher.ts';
+export * from './HttpFetcher.ts';
+export * from './Resource.ts';

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './fetcher';
-export * from './publication';
-export * from './opds';
-export * from './util';
+export * from './fetcher/index.ts';
+export * from './publication/index.ts';
+export * from './opds/index.ts';
+export * from './util/index.ts';

package/src/opds/Availability.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { datefromJSON } from '../util/JSONParse';
+import { datefromJSON } from '../util/JSONParse.ts';
 
 export enum AvailabilityStatus {
   available = 'available',

package/src/opds/Copies.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { positiveNumberfromJSON } from '../util/JSONParse';
+import { positiveNumberfromJSON } from '../util/JSONParse.ts';
 
 /**
  * Library-specific feature that contains information about the copies that a library has acquired.

package/src/opds/Holds.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { positiveNumberfromJSON } from '../util/JSONParse';
+import { positiveNumberfromJSON } from '../util/JSONParse.ts';
 
 /**
  * Library-specific features when a specific book is unavailable but provides a hold list.

package/src/opds/Price.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { positiveNumberfromJSON } from '../util/JSONParse';
+import { positiveNumberfromJSON } from '../util/JSONParse.ts';
 
 /**
  * The price of a publication in an OPDS link.

package/src/opds/index.ts

@@ -1,5 +1,5 @@
-export * from './Price';
-export * from './Acquisition';
-export * from './Holds';
-export * from './Copies';
-export * from './Availability';
+export * from './Price.ts';
+export * from './Acquisition.ts';
+export * from './Holds.ts';
+export * from './Copies.ts';
+export * from './Availability.ts';

package/src/publication/BelongsTo.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { Contributors as Collection } from './Contributor';
+import { Contributors as Collection } from './Contributor.ts';
 
 /**
  * BelongsTo Object for the Readium Web Publication Manifest.

package/src/publication/Contributor.ts

@@ -3,14 +3,14 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { Links } from './Link';
+import { Links } from './Link.ts';
 import {
   arrayfromJSONorString,
   numberfromJSON,
   setToArray,
-} from '../util/JSONParse';
-import { LocalizedString } from './LocalizedString';
-import { AltIdentifier } from './AltIdentifier';
+} from '../util/JSONParse.ts';
+import { LocalizedString } from './LocalizedString.ts';
+import { AltIdentifier } from './AltIdentifier.ts';
 
 /**
  * Contributor Object for the Readium Web Publication Manifest.

package/src/publication/GuidedNavigation.ts

@@ -1,8 +1,8 @@
 import {
   arrayfromJSONorString,
   setToArray,
-} from '../util/JSONParse';
-import { Links } from "./Link";
+} from '../util/JSONParse.ts';
+import { Links } from "./Link.ts";
 
 export interface Clip {
     audioResource: string;
@@ -49,11 +49,11 @@ export class GuidedNavigationDocument {
 export class GuidedNavigationText {
     /** Plain text content */
     public readonly plain?: string;
-    
+
     /** SSML (Speech Synthesis Markup Language) content */
     public readonly ssml?: string;
-    
-    /** 
+
+    /**
      * BCP 47 language tag
      * @pattern ^((?<grandfathered>(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?<language>([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?<script>[A-Za-z]{4}))?(-(?<region>[A-Za-z]{2}|[0-9]{3}))?(-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?<extension>[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?<privateUse>x(-[A-Za-z0-9]{1,8})+))?)|(?<privateUse2>x(-[A-Za-z0-9]{1,8})+))$
      */
@@ -74,11 +74,11 @@ export class GuidedNavigationText {
      */
     public static deserialize(json: any): GuidedNavigationText | undefined {
         if (json === undefined || json === null) return undefined;
-        
+
         if (typeof json === 'string') {
             return new GuidedNavigationText({ plain: json });
         }
-        
+
         // Only create if there are actual values
         if (json.plain || json.ssml || json.language) {
             return new GuidedNavigationText({
@@ -87,7 +87,7 @@ export class GuidedNavigationText {
                 language: json.language
             });
         }
-        
+
         return undefined;
     }
 
@@ -111,32 +111,32 @@ export class GuidedNavigationText {
 export class GuidedNavigationObject {
   /** References an audio resource or a fragment of it. */
   public readonly audioref?: string;
-    
+
   /** Items that are children of the containing Guided Navigation Object. */
   public readonly children?: GuidedNavigationObject[];
-  
+
   /** References an image or a fragment of it. */
   public readonly imgref?: string;
-  
+
   /** 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.
    */
   public readonly text?: GuidedNavigationText;
-  
+
   /** 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.
    */
@@ -192,7 +192,7 @@ export class GuidedNavigationObject {
      */
     public static deserialize(json: any): GuidedNavigationObject | undefined {
         if (!json) return undefined;
-        
+
         return new GuidedNavigationObject({
             audioref: json.audioref,
             children: GuidedNavigationObject.deserializeArray(json.children),
@@ -207,7 +207,7 @@ export class GuidedNavigationObject {
         });
     }
 
-    /** 
+    /**
      * Parses a [GuidedNavigationObject] array from its RWPM JSON representation.
      */
     public static deserializeArray(json: any): GuidedNavigationObject[] | undefined {

package/src/publication/Link.ts

@@ -3,15 +3,15 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { MediaType } from '../util/mediatype/MediaType';
-import { Properties } from './Properties';
-import { URITemplate } from '../util/URITemplate';
+import { MediaType } from '../util/mediatype/MediaType.ts';
+import { Properties } from './Properties.ts';
+import { URITemplate } from '../util/URITemplate.ts';
 import {
   arrayfromJSONorString,
   positiveNumberfromJSON,
   setToArray,
-} from '../util/JSONParse';
-import { LocatorLocations, Locator } from './Locator';
+} from '../util/JSONParse.ts';
+import { LocatorLocations, Locator } from './Locator.ts';
 
 /**
  * Link Object for the Readium Web Publication Manifest.
@@ -100,7 +100,7 @@ export class Link {
    */
   public static deserialize(json: any): Link | undefined {
     if (!json || typeof json.href !== 'string') return;
-    
+
     return new Link({
       href: json.href,
       templated: json.templated,

package/src/publication/Locator.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { arrayfromJSONorString, numberfromJSON } from '../util/JSONParse';
+import { arrayfromJSONorString, numberfromJSON } from '../util/JSONParse.ts';
 
 /**
  * One or more alternative expressions of the location.

package/src/publication/LocatorCollection.ts

@@ -3,10 +3,10 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { numberfromJSON } from '../util/JSONParse';
-import { Links } from './Link';
-import { LocalizedString } from './LocalizedString';
-import { Locator } from './Locator';
+import { numberfromJSON } from '../util/JSONParse.ts';
+import { Links } from './Link.ts';
+import { LocalizedString } from './LocalizedString.ts';
+import { Locator } from './Locator.ts';
 
 /**
  * Holds the metadata of a `LocatorCollection`.

package/src/publication/Manifest.ts

@@ -3,12 +3,12 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { Metadata } from './Metadata';
-import { Link, Links } from './Link';
-import { arrayfromJSONorString } from '../util/JSONParse';
-import { PublicationCollection } from './PublicationCollection';
-import { MediaType } from '../util/mediatype/MediaType';
-import { Locator, LocatorLocations } from "./Locator";
+import { Metadata } from './Metadata.ts';
+import { Link, Links } from './Link.ts';
+import { arrayfromJSONorString } from '../util/JSONParse.ts';
+import { PublicationCollection } from './PublicationCollection.ts';
+import { MediaType } from '../util/mediatype/MediaType.ts';
+import { Locator, LocatorLocations } from "./Locator.ts";
 
 /** Holds the metadata of a Readium publication, as described in
  *  the Readium Web Publication Manifest.
@@ -19,7 +19,7 @@ export class Manifest {
 
   public readonly metadata: Metadata;
 
-  public readonly links: Links;
+  public readonly links?: Links;
 
   /** Identifies a list of resources in reading order for the publication. */
   public readonly readingOrder: Links;
@@ -35,7 +35,7 @@ export class Manifest {
   constructor(values: {
     context?: Array<string>;
     metadata: Metadata;
-    links: Links;
+    links?: Links;
     readingOrder: Links;
     resources?: Links;
     toc?: Links;
@@ -65,14 +65,18 @@ export class Manifest {
 
     const links = Links.deserialize(json.links);
 
-    if (!links) return;
-
     const readingOrder = Links.deserialize(
       json.readingOrder ? json.readingOrder : json.spine
     );
 
     if (!readingOrder) return;
 
+    const knownKeys = new Set(['@context', 'metadata', 'links', 'readingOrder', 'spine', 'resources', 'toc']);
+    const remaining: Record<string, unknown> = {};
+    Object.keys(json).forEach(key => {
+      if (!knownKeys.has(key)) remaining[key] = json[key];
+    });
+
     return new Manifest({
       context: arrayfromJSONorString(json['@context']),
       metadata,
@@ -80,9 +84,7 @@ export class Manifest {
       readingOrder,
       resources: Links.deserialize(json.resources),
       toc: Links.deserialize(json.toc),
-      subcollections: PublicationCollection.deserializeCollections({
-        sub: json.sub,
-      }),
+      subcollections: PublicationCollection.deserializeCollections(remaining),
     });
   }
 
@@ -93,7 +95,7 @@ export class Manifest {
     const json: any = {};
     if (this.context !== undefined) json['@context'] = this.context;
     json.metadata = this.metadata.serialize();
-    json.links = this.links.serialize();
+    if (this.links !== undefined) json.links = this.links.serialize();
     json.readingOrder = this.readingOrder.serialize();
     if (this.resources) json.resources = this.resources.serialize();
     if (this.toc) json.toc = this.toc.serialize();
@@ -108,7 +110,9 @@ export class Manifest {
     if (this.resources) {
       links.push(this.resources);
     }
-    links.push(this.links);
+    if (this.links) {
+      links.push(this.links);
+    }
 
     let result: Link | undefined;
 
@@ -129,7 +133,9 @@ export class Manifest {
     if (this.resources) {
       result.push(this.resources.filterByRel(rel));
     }
-    result.push(this.links.filterByRel(rel));
+    if (this.links) {
+      result.push(this.links.filterByRel(rel));
+    }
 
     return result.reduce((acc, val) => acc.concat(val), []);
   }
@@ -197,7 +203,9 @@ export class Manifest {
     if (this.resources) {
       links.push(this.resources);
     }
-    links.push(this.links);
+    if (this.links) {
+      links.push(this.links);
+    }
 
     const link = find(links);
 
@@ -218,7 +226,7 @@ export class Manifest {
    *  e.g. https://provider.com/pub1293/manifest.json gives https://provider.com/pub1293/
    */
   public get baseURL(): string | undefined {
-    const selfLink = this.links.items.find(
+    const selfLink = this.links?.items.find(
       el => el.rels && el.rels.has('self')
     );
     if (selfLink) {
@@ -242,10 +250,11 @@ export class Manifest {
    * Sets the URL where this [Publication]'s RWPM manifest is served.
    */
   public setSelfLink(href: string): void {
-    this.links.items = this.links.items.filter(
+    if (!this.links) (this as any).links = new Links([]);
+    this.links!.items = this.links!.items.filter(
       x => x.rels === undefined || !x.rels?.has('self')
     );
-    this.links.items.push(
+    this.links!.items.push(
       new Link({
         href,
         type: MediaType.READIUM_WEBPUB_MANIFEST.string,

package/src/publication/Metadata.ts

@@ -7,17 +7,17 @@ import {
   arrayfromJSONorString,
   datefromJSON,
   positiveNumberfromJSON,
-} from '../util/JSONParse';
-import { AltIdentifier } from './AltIdentifier';
-import { BelongsTo } from './BelongsTo';
-import { Contributors } from './Contributor';
-import { Layout } from './Layout';
-import { LocalizedString } from './LocalizedString';
-import { Profile } from './Profiles';
-import { ReadingProgression } from './ReadingProgression';
-import { Subjects } from './Subject';
-import { Accessibility } from './accessibility/Accessibility';
-import { TDM } from './TDM';
+} from '../util/JSONParse.ts';
+import { AltIdentifier } from './AltIdentifier.ts';
+import { BelongsTo } from './BelongsTo.ts';
+import { Contributors } from './Contributor.ts';
+import { Layout } from './Layout.ts';
+import { LocalizedString } from './LocalizedString.ts';
+import { Profile } from './Profiles.ts';
+import { ReadingProgression } from './ReadingProgression.ts';
+import { Subjects } from './Subject.ts';
+import { Accessibility } from './accessibility/Accessibility.ts';
+import { TDM } from './TDM.ts';
 
 /**
  * https://readium.org/webpub-manifest/schema/metadata.schema.json
@@ -328,13 +328,13 @@ export class Metadata {
 
   /**
    * Computes a [Layout] using the [conformsTo] profile and layout property.
-   * 
+   *
    * Special cases:
    * - EPUB profile defaults to reflowable if layout is not present
    * - Divina profile defaults to fixed if layout is not present
    * - Layout is ignored for audiobook and PDF profiles
    * - Layout is ignored if set to reflowable on a Divina profile
-   * 
+   *
    * Note: Stops at the first matching profile.
    */
   public get effectiveLayout(): Layout | null {

package/src/publication/Publication.ts

@@ -3,17 +3,16 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { Link, Links } from './Link';
-import { Locator } from './Locator';
-import { Manifest } from './Manifest';
-import { Metadata } from './Metadata';
-import { EmptyFetcher, Fetcher } from '../fetcher/Fetcher';
-import { PublicationCollection } from './PublicationCollection';
-import { Resource } from '../fetcher/Resource';
-import { GuidedNavigationDocument } from "./GuidedNavigation";
-import { URITemplate } from "../util";
-import { MediaType } from "../util/mediatype/MediaType";
-import { Timeline } from './services/timeline/Timeline';
+import { Link, Links } from './Link.ts';
+import { Locator } from './Locator.ts';
+import { Manifest } from './Manifest.ts';
+import { Metadata } from './Metadata.ts';
+import { EmptyFetcher, Fetcher } from '../fetcher/Fetcher.ts';
+import { PublicationCollection } from './PublicationCollection.ts';
+import { Resource } from '../fetcher/Resource.ts';
+import { GuidedNavigationDocument } from "./GuidedNavigation.ts";
+import { MediaType, URITemplate } from "../util/index.ts";
+import { Timeline } from './services/timeline/Timeline.ts';
 
 export type ServiceFactory = () => null;
 
@@ -27,7 +26,7 @@ export class Publication {
   // Shortcuts to manifest properties
   public readonly context?: Array<string>;
   public readonly metadata: Metadata;
-  public readonly links: Links;
+  public readonly links?: Links;
   /** Identifies a list of resources in reading order for the publication. */
   public readonly readingOrder: Links;
   /** Identifies resources that are necessary for rendering the publication. */
@@ -51,8 +50,7 @@ export class Publication {
 
   /**
    * Returns the publication's timeline, built from its reading order and table of contents.
-   * Called with no arguments, the result is cached. Pass options to build a fresh timeline
-   * with a specific configuration (e.g. a depth limit).
+   * The result is cached after the first call.
    */
   public get timeline(): Timeline {
     if (!this._timeline) this._timeline = Timeline.build(this);
@@ -95,7 +93,7 @@ export class Publication {
   /**
    * Gets the cover image for the publication.
    * First looks for rel='cover' in links/resources/readingOrder,
-   * then falls back to any image (JPEG, PNG, GIF, AVIF, SVG) as bitmap fallback.
+   * then falls back to any image (JPEG, PNG, GIF, AVIF, SVG).
    */
   public getCover(): Link | undefined {
     const locations = [
@@ -123,7 +121,7 @@ export class Publication {
   }
 
   public async positionsFromManifest(): Promise<Locator[]> {
-    const positionListLink = this.manifest.links.findWithMediaType(
+    const positionListLink = this.manifest.links?.findWithMediaType(
       'application/vnd.readium.position-list+json'
     );
     if (positionListLink === undefined) return [];
@@ -154,7 +152,7 @@ export class Publication {
 
     if(!guidedNavigationLink) {
       // Still unable to find a guided navigation link, try to use the manifest's global document
-      guidedNavigationLink = this.manifest.links.findWithMediaType(
+      guidedNavigationLink = this.manifest.links?.findWithMediaType(
         'application/guided-navigation+json'
       );
     }

package/src/publication/PublicationCollection.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { Links } from './Link';
+import { Links } from './Link.ts';
 
 /**
  * Core Collection Model

package/src/publication/ReadingProgression.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { Page } from "./Properties";
+import { Page } from "./Properties.ts";
 
 export enum ReadingProgression {
   ltr = 'ltr',

package/src/publication/Subject.ts

@@ -3,8 +3,8 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { Links } from './Link';
-import { LocalizedString } from './LocalizedString';
+import { Links } from './Link.ts';
+import { LocalizedString } from './LocalizedString.ts';
 
 /**
  * https://github.com/readium/webpub-manifest/tree/master/contexts/default#subjects