@readium/shared 2.1.5 → 2.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/shared",
-  "version": "2.1.5",
+  "version": "2.2.0-alpha.1",
   "type": "module",
   "description": "Shared models to be used across other Readium projects and implementations in Typescript",
   "author": "readium",
@@ -44,15 +44,6 @@
   "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",
@@ -77,5 +68,14 @@
     "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<XMLDocument> {
+  async readAsXML(): Promise<Document> {
     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(),
-      'application/xml'
+      this._link.mediaType.isHTML ? (this._link.mediaType.string as 'application/xhtml+xml' | 'text/html') : 'text/xml'
     );
   }
 }

package/src/fetcher/Resource.ts

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

package/src/publication/html/Locations.ts

@@ -53,6 +53,13 @@ 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;
   }
 }
 
@@ -126,4 +133,11 @@ 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/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<XMLDocument>;
+    readAsXML(): Promise<Document>;
 }

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<XMLDocument | undefined>;
+    readAsXML(): Promise<Document | undefined>;
     abstract close(): void;
 }

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

@@ -41,5 +41,11 @@ 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;
     }
 }