@readium/shared 2.2.0-alpha.1 → 2.2.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/shared",
-  "version": "2.2.0-alpha.1",
+  "version": "2.2.0-beta.1",
   "type": "module",
   "description": "Shared models to be used across other Readium projects and implementations in Typescript",
   "author": "readium",
@@ -44,6 +44,15 @@
   "engines": {
     "node": ">=18"
   },
+  "scripts": {
+    "dev": "vite",
+    "clean": "rimraf types dist",
+    "build": "pnpm clean && tsc && vite build",
+    "test": "jest",
+    "size": "size-limit",
+    "check-locales": "node scripts/check-locales.mjs",
+    "update-locales": "pnpm remove @edrlab/thorium-locales && pnpm add @edrlab/thorium-locales@github:edrlab/thorium-locales && pnpm check-locales"
+  },
   "size-limit": [
     {
       "path": "dist/index.js",
@@ -68,14 +77,5 @@
     "tslib": "^2.8.1",
     "typescript": "^5.9.3",
     "vite": "^7.3.1"
-  },
-  "scripts": {
-    "dev": "vite",
-    "clean": "rimraf types dist",
-    "build": "pnpm clean && tsc && vite build",
-    "test": "jest",
-    "size": "size-limit",
-    "check-locales": "node scripts/check-locales.mjs",
-    "update-locales": "pnpm remove @edrlab/thorium-locales && pnpm add @edrlab/thorium-locales@github:edrlab/thorium-locales && pnpm check-locales"
   }
-}
+}

package/src/fetcher/HttpFetcher.ts

@@ -108,7 +108,7 @@ export class HttpResource implements Resource {
     return await resp.text();
   }
 
-  async readAsXML(): Promise<Document> {
+  async readAsXML(): Promise<XMLDocument> {
     const resp = await this.client(this.url);
     if (!resp.ok)
       throw new Error(
@@ -116,7 +116,7 @@ export class HttpResource implements Resource {
       ); // TODO
     return new DOMParser().parseFromString(
       await resp.text(),
-      this._link.mediaType.isHTML ? (this._link.mediaType.string as 'application/xhtml+xml' | 'text/html') : 'text/xml'
+      'application/xml'
     );
   }
 }

package/src/fetcher/Resource.ts

@@ -27,11 +27,11 @@ export abstract class Resource {
       return JSON.parse(str);
     });
   }
-  readAsXML(): Promise<Document | undefined> {
-    return this.link().then(l => this.readAsString().then(str => {
+  readAsXML(): Promise<XMLDocument | undefined> {
+    return this.readAsString().then(str => {
       if (str === undefined) return str;
-      return new DOMParser().parseFromString(str, l.mediaType.isHTML ? (l.mediaType.string as 'application/xhtml+xml' | 'text/html') : 'text/xml');
-    }));
+      return new DOMParser().parseFromString(str, 'text/xml');
+    });
   }
   abstract close(): void;
 }

package/src/publication/Publication.ts

@@ -12,6 +12,7 @@ import { PublicationCollection } from './PublicationCollection';
 import { Resource } from '../fetcher/Resource';
 import { GuidedNavigationDocument } from "./GuidedNavigation";
 import { URITemplate } from "../util";
+import { MediaType } from "../util/mediatype/MediaType";
 
 export type ServiceFactory = () => null;
 
@@ -79,6 +80,36 @@ export class Publication {
     return this.manifest.linkWithRel(rel);
   }
 
+  /**
+   * 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.
+   */
+  public getCover(): Link | undefined {
+    const locations = [
+      this.links,
+      this.resources,
+      this.readingOrder
+    ].filter(Boolean) as Links[];
+
+    // First, look for explicit cover relationship
+    for (const location of locations) {
+      const cover = location.items.find(link => link.rels?.has('cover'));
+      if (cover) return cover;
+    }
+
+    // Fallback to any image (including SVG which is not bitmap)
+    for (const location of locations) {
+      const image = location.items.find(link => 
+        link.mediaType.isBitmap || 
+        link.mediaType.matches(MediaType.SVG)
+      );
+      if (image) return image;
+    }
+
+    return undefined;
+  }
+
   public async positionsFromManifest(): Promise<Locator[]> {
     const positionListLink = this.manifest.links.findWithMediaType(
       'application/vnd.readium.position-list+json'

package/src/publication/html/Locations.ts

@@ -53,13 +53,6 @@ declare module '../Locator' {
      * https://www.w3.org/TR/media-frags/
      */
     space(): [number, number, number, number] | undefined;
-
-    /**
-     * Text fragments, used by browsers to jump to/highlight text.
-     *
-     * https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments
-     */
-    text(): string | undefined;
   }
 }
 
@@ -133,11 +126,4 @@ LocatorLocations.prototype.space = function(): [number, number, number, number]
   if(xywh.length !== 4) return; // Must have four parts
   if(xywh.some(isNaN)) return; // All parts must be numbers
   return xywh as [number, number, number, number];
-}
-
-LocatorLocations.prototype.text = function(): string | undefined {
-  const fp = this.fragmentParameters();
-  console.log(fp);
-  // :~:
-  return undefined;
 }

package/src/util/mediatype/MediaType.ts

@@ -224,6 +224,7 @@ export class MediaType {
   /** Returns whether this media type is of a bitmap image, so excluding vectorial formats. */
   public get isBitmap(): boolean {
     return this.matchesAny(
+      MediaType.AVIF,
       MediaType.BMP,
       MediaType.GIF,
       MediaType.JPEG,
@@ -292,6 +293,9 @@ export class MediaType {
       fileExtension: 'avi',
     });
   }
+  public static get AVIF(): MediaType {
+    return MediaType.parse({ mediaType: 'image/avif', fileExtension: 'avif' });
+  }
   public static get BINARY(): MediaType {
     return MediaType.parse({ mediaType: 'application/octet-stream' });
   }

package/types/src/fetcher/HttpFetcher.d.ts

@@ -24,5 +24,5 @@ export declare class HttpResource implements Resource {
     length(): Promise<number>;
     readAsJSON(): Promise<unknown>;
     readAsString(): Promise<string>;
-    readAsXML(): Promise<Document>;
+    readAsXML(): Promise<XMLDocument>;
 }

package/types/src/fetcher/Resource.d.ts

@@ -10,6 +10,6 @@ export declare abstract class Resource {
     abstract read(range?: NumberRange): Promise<Uint8Array | undefined>;
     readAsString(): Promise<string | undefined>;
     readAsJSON(): Promise<unknown | undefined>;
-    readAsXML(): Promise<Document | undefined>;
+    readAsXML(): Promise<XMLDocument | undefined>;
     abstract close(): void;
 }

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

@@ -44,6 +44,12 @@ export declare class Publication {
      * Finds the first [Link] having the given [rel] in the publications's links.
      */
     linkWithRel(rel: string): Link | undefined;
+    /**
+     * 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.
+     */
+    getCover(): Link | undefined;
     positionsFromManifest(): Promise<Locator[]>;
     guideForLink(link: Link): Promise<GuidedNavigationDocument | undefined>;
     /**

package/types/src/publication/html/Locations.d.ts

@@ -41,11 +41,5 @@ declare module '../Locator' {
          * https://www.w3.org/TR/media-frags/
          */
         space(): [number, number, number, number] | undefined;
-        /**
-         * Text fragments, used by browsers to jump to/highlight text.
-         *
-         * https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments
-         */
-        text(): string | undefined;
     }
 }

package/types/src/util/mediatype/MediaType.d.ts

@@ -89,6 +89,7 @@ export declare class MediaType {
     static get ACSM(): MediaType;
     static get AIFF(): MediaType;
     static get AVI(): MediaType;
+    static get AVIF(): MediaType;
     static get BINARY(): MediaType;
     static get BMP(): MediaType;
     static get CBZ(): MediaType;

package/LICENSE

@@ -1,28 +0,0 @@
-BSD 3-Clause License
-
-Copyright (c) 2022, Readium Foundation
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.