@readium/shared 2.2.1 → 2.2.3

package/package.json

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

package/src/opds/Acquisition.ts

@@ -6,7 +6,7 @@
 /**
  * OPDS Acquisition Object.
  *
- * https://drafts.opds.io/schema/acquisition-object.schema.json
+ * https://specs.opds.io/schema/acquisition-object.schema.json
  */
 export class Acquisition {
   /** Currency for the price, eg. EUR. */

package/src/opds/Availability.ts

@@ -14,7 +14,7 @@ export enum AvailabilityStatus {
 /**
  * Indicated the availability of a given resource.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  *
  */
 export class Availability {

package/src/opds/Copies.ts

@@ -8,7 +8,7 @@ import { positiveNumberfromJSON } from '../util/JSONParse.ts';
 /**
  * Library-specific feature that contains information about the copies that a library has acquired.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  */
 export class Copies {
   public total?: number;

package/src/opds/Holds.ts

@@ -8,7 +8,7 @@ import { positiveNumberfromJSON } from '../util/JSONParse.ts';
 /**
  * Library-specific features when a specific book is unavailable but provides a hold list.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  */
 export class Holds {
   public total?: number;

package/src/opds/Price.ts

@@ -8,7 +8,7 @@ import { positiveNumberfromJSON } from '../util/JSONParse.ts';
 /**
  * The price of a publication in an OPDS link.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  *
  * currency Currency for the price, eg. EUR.
  * value Price value, should only be used for display purposes, because of precision issues

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 */

package/src/publication/html/Locations.ts

@@ -1,5 +1,6 @@
 import { LocatorLocations } from '../Locator.ts';
 import { DomRange } from './DomRange.ts';
+import { parseNptTime } from '../../util/npt.ts';
 
 // HTML extensions for [Locations].
 // https://github.com/readium/architecture/blob/master/models/locators/extensions/html.md
@@ -112,10 +113,9 @@ LocatorLocations.prototype.page = function(): number | undefined {
 }
 
 LocatorLocations.prototype.time = function(): number | undefined {
-  // TODO more sophiticated parsing
-  const i = parseInt(this.fragmentParameters().get("t")!);
-  if(!isNaN(i)) return i;
-  return undefined;
+  const raw = this.fragmentParameters().get("t");
+  if (!raw) return undefined;
+  return parseNptTime(raw);
 }
 
 LocatorLocations.prototype.space = function(): [number, number, number, number] | undefined {

package/src/publication/opds/Properties.ts

@@ -4,7 +4,7 @@ import { Link } from '../Link.ts';
 import { Properties } from '../Properties.ts';
 
 // OPDS extensions for link [Properties].
-// https://drafts.opds.io/schema/properties.schema.json
+// https://specs.opds.io/schema/properties.schema.json
 
 declare module '../Properties' {
   export interface Properties {
@@ -43,7 +43,7 @@ declare module '../Properties' {
      * Indicates that the linked resource supports authentication with the associated Authentication
      * Document.
      *
-     * See https://drafts.opds.io/authentication-for-opds-1.0.html
+     * See https://specs.opds.io/authentication-for-opds-1.0.html
      */
     getAuthenticate(): Link | undefined;
   }

package/src/publication/services/timeline/Timeline.ts

@@ -1,6 +1,7 @@
 import { Link, Links } from "../../Link.ts";
 import { Locator } from "../../Locator.ts";
 import { TimelineItem } from "./TimelineItem.ts";
+import { isNptStartOfResource, parseNptTime } from "../../../util/npt.ts";
 
 interface PublicationLike {
     toc?: Links;
@@ -271,15 +272,14 @@ export class Timeline {
 
     /**
      * A TOC href points to the start of its resource when it has no fragment,
-     * or when the fragment contains a parsable `t=` value of 0 (audio: explicit
-     * beginning of the file).  Accepts decimals and extra params, e.g. `t=0.0`
-     * or `foo=bar&t=0`.
+     * or when the fragment contains a parsable NPT `t=` value of 0 (audio:
+     * explicit beginning of the file).
      */
     private static isStartOfResource(href: string): boolean {
         const fragment = href.split("#")[1];
         if (!fragment) return true;
-        const match = fragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
-        return match !== null && parseFloat(match[1]) === 0;
+        const match = fragment.match(/(?:^|&)t=([^&]+)/);
+        return match !== null && isNptStartOfResource(match[1]);
     }
 
     // -------------------------------------------------------------------------
@@ -322,8 +322,8 @@ export class Timeline {
             const effectiveHref = refHref || this.bareHrefFromItem(item);
             if (effectiveHref !== href) continue;
             if (!refFragment) return undefined;
-            const match = refFragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
-            return match ? parseFloat(match[1]) : undefined;
+            const match = refFragment.match(/(?:^|&)t=([^&]+)/);
+            return match ? parseNptTime(match[1]) : undefined;
         }
         return undefined;
     }
@@ -337,8 +337,8 @@ export class Timeline {
         if (!ref) return undefined;
         const fragment = ref.split("#")[1];
         if (!fragment) return undefined;
-        const match = fragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
-        return match ? parseFloat(match[1]) : undefined;
+        const match = fragment.match(/(?:^|&)t=([^&]+)/);
+        return match ? parseNptTime(match[1]) : undefined;
     }
 
     private ancestorPath(items: TimelineItem[], target: TimelineItem): TimelineItem[] | null {

package/src/util/index.ts

@@ -1,5 +1,6 @@
 export * from './mediatype/index.ts';
 export * from './JSONParse.ts';
+export * from './npt.ts';
 export * from './URITemplate.ts';
 export * from './Language.ts';
 export * from './tokenizer/index.ts';

package/src/util/npt.ts

@@ -0,0 +1,51 @@
+/**
+ * Parses a W3C Media Fragments NPT (Normal Play Time) temporal value and
+ * returns the corresponding time in seconds.
+ *
+ * Accepts the start of a range expression (e.g. "10,20" → 10).
+ * Handles the optional "npt:" prefix and all three clock formats:
+ *   - Seconds:       "1647.202"  or  "npt:1647.202"
+ *   - MM:SS:         "27:27.2"   or  "npt:27:27.2"
+ *   - HH:MM:SS:      "0:27:27.2" or  "npt:0:27:27.202"
+ *
+ * Returns `undefined` for any value that cannot be parsed.
+ *
+ * https://www.w3.org/TR/media-frags/#naming-time
+ */
+export function parseNptTime(raw: string): number | undefined {
+    const start = raw.split(",")[0].trim();
+    const normalizedStart = start.toLowerCase();
+    const s = normalizedStart.startsWith("npt:") ? start.slice(4) : start;
+    const parts = s.split(":");
+
+    if (parts.length === 1) {
+        const sec = parseFloat(parts[0]);
+        return isNaN(sec) ? undefined : sec;
+    }
+
+    if (parts.length === 2) {
+        const min = parseInt(parts[0], 10);
+        const sec = parseFloat(parts[1]);
+        if (isNaN(min) || isNaN(sec)) return undefined;
+        return min * 60 + sec;
+    }
+
+    if (parts.length === 3) {
+        const hr = parseInt(parts[0], 10);
+        const min = parseInt(parts[1], 10);
+        const sec = parseFloat(parts[2]);
+        if (isNaN(hr) || isNaN(min) || isNaN(sec)) return undefined;
+        return hr * 3600 + min * 60 + sec;
+    }
+
+    return undefined;
+}
+
+/**
+ * Returns true when the NPT time value represents the start of a resource
+ * (t=0, t=0.0, t=npt:0, t=npt:0:0:0, etc.).
+ */
+export function isNptStartOfResource(raw: string): boolean {
+    const t = parseNptTime(raw);
+    return t !== undefined && t === 0;
+}

package/types/src/opds/Acquisition.d.ts

@@ -1,7 +1,7 @@
 /**
  * OPDS Acquisition Object.
  *
- * https://drafts.opds.io/schema/acquisition-object.schema.json
+ * https://specs.opds.io/schema/acquisition-object.schema.json
  */
 export declare class Acquisition {
     /** Currency for the price, eg. EUR. */

package/types/src/opds/Availability.d.ts

@@ -6,7 +6,7 @@ export declare enum AvailabilityStatus {
 /**
  * Indicated the availability of a given resource.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  *
  */
 export declare class Availability {

package/types/src/opds/Copies.d.ts

@@ -1,7 +1,7 @@
 /**
  * Library-specific feature that contains information about the copies that a library has acquired.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  */
 export declare class Copies {
     total?: number;

package/types/src/opds/Holds.d.ts

@@ -1,7 +1,7 @@
 /**
  * Library-specific features when a specific book is unavailable but provides a hold list.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  */
 export declare class Holds {
     total?: number;

package/types/src/opds/Price.d.ts

@@ -1,7 +1,7 @@
 /**
  * The price of a publication in an OPDS link.
  *
- * https://drafts.opds.io/schema/properties.schema.json
+ * https://specs.opds.io/schema/properties.schema.json
  *
  * currency Currency for the price, eg. EUR.
  * value Price value, should only be used for display purposes, because of precision issues

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 */

package/types/src/publication/opds/Properties.d.ts

@@ -31,7 +31,7 @@ declare module '../Properties' {
          * Indicates that the linked resource supports authentication with the associated Authentication
          * Document.
          *
-         * See https://drafts.opds.io/authentication-for-opds-1.0.html
+         * See https://specs.opds.io/authentication-for-opds-1.0.html
          */
         getAuthenticate(): Link | undefined;
     }

package/types/src/publication/services/timeline/Timeline.d.ts

@@ -76,9 +76,8 @@ export declare class Timeline {
     private static collectTocCandidates;
     /**
      * A TOC href points to the start of its resource when it has no fragment,
-     * or when the fragment contains a parsable `t=` value of 0 (audio: explicit
-     * beginning of the file).  Accepts decimals and extra params, e.g. `t=0.0`
-     * or `foo=bar&t=0`.
+     * or when the fragment contains a parsable NPT `t=` value of 0 (audio:
+     * explicit beginning of the file).
      */
     private static isStartOfResource;
     private static trimToDepth;

package/types/src/util/index.d.ts

@@ -1,5 +1,6 @@
 export * from './mediatype/index.ts';
 export * from './JSONParse.ts';
+export * from './npt.ts';
 export * from './URITemplate.ts';
 export * from './Language.ts';
 export * from './tokenizer/index.ts';

package/types/src/util/npt.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Parses a W3C Media Fragments NPT (Normal Play Time) temporal value and
+ * returns the corresponding time in seconds.
+ *
+ * Accepts the start of a range expression (e.g. "10,20" → 10).
+ * Handles the optional "npt:" prefix and all three clock formats:
+ *   - Seconds:       "1647.202"  or  "npt:1647.202"
+ *   - MM:SS:         "27:27.2"   or  "npt:27:27.2"
+ *   - HH:MM:SS:      "0:27:27.2" or  "npt:0:27:27.202"
+ *
+ * Returns `undefined` for any value that cannot be parsed.
+ *
+ * https://www.w3.org/TR/media-frags/#naming-time
+ */
+export declare function parseNptTime(raw: string): number | undefined;
+/**
+ * Returns true when the NPT time value represents the start of a resource
+ * (t=0, t=0.0, t=npt:0, t=npt:0:0:0, etc.).
+ */
+export declare function isNptStartOfResource(raw: string): boolean;