@readium/shared 2.2.0 → 2.2.2

package/package.json

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

package/src/publication/Manifest.ts

@@ -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/Publication.ts

@@ -14,8 +14,6 @@ import { GuidedNavigationDocument } from "./GuidedNavigation.ts";
 import { MediaType, URITemplate } from "../util/index.ts";
 import { Timeline } from './services/timeline/Timeline.ts';
 
-export type ServiceFactory = () => null;
-
 /** Shared model for a Readium Publication. */
 export class Publication {
   /** The manifest holding the publication metadata extracted from the publication file */
@@ -26,7 +24,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. */
@@ -121,7 +119,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 [];
@@ -152,7 +150,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/services/content/iterators/PublicationContentIterator.ts

@@ -136,7 +136,7 @@ export class PublicationContentIterator extends Iterator {
 
         for (const factory of this.resourceContentIteratorFactories) {
             const res = factory(resource, locator);
-            if(res) new IndexedIterator(index, res);
+            if(res) return new IndexedIterator(index, res);
         }
 
         return null;

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

@@ -9,7 +9,7 @@ import { Locator } from "./Locator.ts";
 export declare class Manifest {
     readonly context?: Array<string>;
     readonly metadata: Metadata;
-    readonly links: Links;
+    readonly links?: Links;
     /** Identifies a list of resources in reading order for the publication. */
     readonly readingOrder: Links;
     /** Identifies resources that are necessary for rendering the publication. */
@@ -20,7 +20,7 @@ export declare class Manifest {
     constructor(values: {
         context?: Array<string>;
         metadata: Metadata;
-        links: Links;
+        links?: Links;
         readingOrder: Links;
         resources?: Links;
         toc?: Links;

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

@@ -7,7 +7,6 @@ import { PublicationCollection } from './PublicationCollection.ts';
 import { Resource } from '../fetcher/Resource.ts';
 import { GuidedNavigationDocument } from "./GuidedNavigation.ts";
 import { Timeline } from './services/timeline/Timeline.ts';
-export type ServiceFactory = () => null;
 /** Shared model for a Readium Publication. */
 export declare class Publication {
     /** The manifest holding the publication metadata extracted from the publication file */
@@ -16,7 +15,7 @@ export declare class Publication {
     private _timeline;
     readonly context?: Array<string>;
     readonly metadata: Metadata;
-    readonly links: Links;
+    readonly links?: Links;
     /** Identifies a list of resources in reading order for the publication. */
     readonly readingOrder: Links;
     /** Identifies resources that are necessary for rendering the publication. */