@readium/shared 2.4.0-alpha.1 → 2.5.0

package/src/locales/publication-metadata/tr.json

@@ -0,0 +1,51 @@
+{
+    "publication": {
+        "format": {
+            "audiobook": "Sesli Kitap",
+            "audiobookJSON": "Sesli Kitap Manifest Dosyası",
+            "cbz": "Çizgi Roman Arşivi",
+            "divina": "Divina Yayını",
+            "divinaJSON": "Divina Yayını Manifest Dosyası",
+            "epub": "EPUB",
+            "lcpa": "LCP Korumalı Sesli Kitap",
+            "lcpdf": "LCP Korumalı PDF",
+            "lcpl": "LCP Lisans Belgesi",
+            "pdf": "PDF",
+            "rwp": "Readium Web Yayını",
+            "rwpm": "Readium Web Yayını Manifest Dosyası",
+            "zab": "Sesli Kitap Arşivi",
+            "zip": "ZIP Arşivi"
+        },
+        "kind": {
+            "audiobook_one": "Sesli Kitap",
+            "audiobook_other": "Sesli Kitaplar",
+            "book_one": "kitap",
+            "book_other": "kitaplar",
+            "comic_one": "çizgi roman",
+            "comic_other": "çizgi romanlar",
+            "document_one": "belge",
+            "document_other": "belgeler"
+        },
+        "metadata": {
+            "accessibility": {
+                "display-guide": {
+                    "accessibility-summary": {
+                        "no-metadata": "Bilgi mevcut değil",
+                        "publisher-contact": "Bu ürünün erişilebilirliği hakkında daha fazla bilgi için lütfen yayıncıyla bağlantı kurun: ",
+                        "title": "Erişilebilirlik özeti"
+                    },
+                    "additional-accessibility-information": {
+                        "aria": {
+                            "compact": "ARIA rolleri dahildir",
+                            "descriptive": "İçerik, düzeni en iyi hale getirmek ve gezinmeyi kolaylaştırmak için ARIA rolleriyle iyileştirilmiştir"
+                        },
+                        "audio-descriptions": "Sesli betimlemeler",
+                        "braille": "Braille",
+                        "color-not-sole-means-of-conveying-information": "Renk, bilgi aktarmanın tek yolu değildir",
+                        "dyslexia-readability": "Okuma güçlüğü olanlar için uyarlanmış okunabilirlik"
+                    }
+                }
+            }
+        }
+    }
+}

package/src/locales/publication-metadata/uk.json

@@ -0,0 +1 @@
+{}

package/src/publication/Link.ts

@@ -11,7 +11,7 @@ import {
   positiveNumberfromJSON,
   setToArray,
 } from '../util/JSONParse.ts';
-import { LocatorLocations, Locator } from './Locator.ts';
+import { Locator } from './Locator.ts';
 
 /**
  * Link Object for the Readium Web Publication Manifest.
@@ -197,14 +197,10 @@ export class Link {
    * Creates a [Locator] from a reading order [Link].
    */
   public get locator(): Locator {
-    let parts = this.href.split('#');
     return new Locator({
-      href: parts.length > 0 && parts[0] !== undefined ? parts[0] : this.href,
+      href: this.href,
       type: this.type ?? '',
       title: this.title,
-      locations: new LocatorLocations({
-        fragments: parts.length > 1 && parts[1] !== undefined ? [parts[1]] : [],
-      }),
     });
   }
 }

package/src/publication/Locator.ts

@@ -59,12 +59,20 @@ export class LocatorLocations {
       'progression',
       'totalProgression',
       'position',
+      'otherLocations',
     ]);
     Object.entries(json).forEach(([key, value]) => {
       if (!reservedKeys.has(key)) {
         otherLocations.set(key, value);
       }
     });
+    // json may be a live LocatorLocations instance (e.g. passed through in-memory
+    // rather than round-tripped as RWPM JSON) — its otherLocations is a Map, not
+    // flattened keys, and must be merged in directly rather than treated as an
+    // extension entry itself.
+    if (json.otherLocations instanceof Map) {
+      json.otherLocations.forEach((value: any, key: string) => otherLocations.set(key, value));
+    }
 
     return new LocatorLocations({
       fragments: arrayfromJSONorString(json.fragments || json.fragment),
@@ -176,12 +184,22 @@ export class Locator {
     locations?: LocatorLocations;
     text?: LocatorText;
   }) {
-    this.href = values.href;
+    const hashIndex = values.href.indexOf("#");
+    const hrefFragment = hashIndex >= 0 ? values.href.slice(hashIndex + 1) : undefined;
+    this.href = hashIndex >= 0 ? values.href.slice(0, hashIndex) : values.href;
     this.type = values.type;
     this.title = values.title;
+    // If locations.fragments is already set, it takes precedence over any fragment in the href.
+    // We don't merge both because explicit fragments are considered authoritative.
+    const existingFragments = values.locations?.fragments;
+    const needsFragment = hrefFragment && (!existingFragments || existingFragments.length === 0);
     this.locations = values.locations
-      ? values.locations
-      : new LocatorLocations({});
+      ? needsFragment
+        ? new LocatorLocations({ ...values.locations, fragments: [hrefFragment!] })
+        : values.locations
+      : hrefFragment
+        ? new LocatorLocations({ fragments: [hrefFragment] })
+        : new LocatorLocations({});
     this.text = values.text;
   }
 

package/src/publication/Manifest.ts

@@ -43,7 +43,7 @@ export class Manifest {
   }) {
     this.context = values.context;
     this.metadata = values.metadata;
-    this.links = values.links || new Links([]);
+    this.links = values.links;
     this.readingOrder = values.readingOrder;
     this.resources = values.resources;
     this.toc = values.toc;
@@ -63,6 +63,8 @@ export class Manifest {
 
     if (!metadata) return;
 
+    const links = Links.deserialize(json.links);
+
     const readingOrder = Links.deserialize(
       json.readingOrder ? json.readingOrder : json.spine
     );
@@ -78,7 +80,7 @@ export class Manifest {
     return new Manifest({
       context: arrayfromJSONorString(json['@context']),
       metadata,
-      links: Links.deserialize(json.links),
+      links,
       readingOrder,
       resources: Links.deserialize(json.resources),
       toc: Links.deserialize(json.toc),
@@ -93,7 +95,7 @@ export class Manifest {
     const json: any = {};
     if (this.context !== undefined) json['@context'] = this.context;
     json.metadata = this.metadata.serialize();
-    if (this.links && this.links.items.length > 0) 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();
@@ -143,21 +145,19 @@ export class Manifest {
    * Returns null if the resource is not found in this manifest.
    */
   public locatorFromLink(link: Link): Locator | undefined {
-    const components = link.href.split("#");
-    const href = components.length == 2 ? components[0] : link.href;
-    const resourceLink = this.linkWithHref(href);
+    const bare = link.href.split("#")[0];
+    const resourceLink = this.linkWithHref(bare);
     if(!resourceLink) return undefined;
     const type = resourceLink.type;
     if(!type) return undefined;
-    const fragment = components.length == 2 ? components[1] : undefined;
+    const hasFragment = link.href.includes("#");
 
     return new Locator({
-      href,
+      href: link.href,
       type,
       title: resourceLink.title ?? link.title,
       locations: new LocatorLocations({
-        fragments: fragment ? [fragment] : undefined,
-        progression: fragment ? undefined : 0.0,
+        progression: hasFragment ? undefined : 0.0,
       })
     });
   }

package/src/publication/Publication.ts

@@ -13,6 +13,7 @@ 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';
+import { buildTimeline } from './services/timeline/index.ts';
 
 /** Shared model for a Readium Publication. */
 export class Publication {
@@ -51,7 +52,7 @@ export class Publication {
    * The result is cached after the first call.
    */
   public get timeline(): Timeline {
-    if (!this._timeline) this._timeline = Timeline.build(this);
+    if (!this._timeline) this._timeline = buildTimeline(this);
     return this._timeline;
   }
 

package/src/publication/accessibility/Localization.ts

@@ -1,8 +1,5 @@
-// Localization.ts
-
 import { SUPPORTED_LANGUAGES } from './SupportedLanguages.ts';
-// Static import for English (default locale)
-import enLocale from '@edrlab/thorium-locales/publication-metadata/en.json';
+import enLocale from '../../locales/publication-metadata/en.json';
 
 export interface L10nString {
   compact: string;
@@ -16,16 +13,17 @@ interface LocaleData {
 
 // Dynamic imports for non-English locales
 const jsonLoaders: Record<string, () => Promise<{ default: any }>> = {
-  'fr': () => import('@edrlab/thorium-locales/publication-metadata/fr.json'),
-  'ar': () => import('@edrlab/thorium-locales/publication-metadata/ar.json'),
-  'da': () => import('@edrlab/thorium-locales/publication-metadata/da.json'),
-//  'el': () => import('@edrlab/thorium-locales/publication-metadata/el.json'),
-//  'et': () => import('@edrlab/thorium-locales/publication-metadata/et.json'),
-  'it': () => import('@edrlab/thorium-locales/publication-metadata/it.json'),
-  'pt_PT': () => import('@edrlab/thorium-locales/publication-metadata/pt_PT.json'),
-  'sv': () => import('@edrlab/thorium-locales/publication-metadata/sv.json'),
-//  'tr': () => import('@edrlab/thorium-locales/publication-metadata/tr.json'),
-//  'uk': () => import('@edrlab/thorium-locales/publication-metadata/uk.json')
+  'ar': () => import('../../locales/publication-metadata/ar.json'),
+  'da': () => import('../../locales/publication-metadata/da.json'),
+  'el': () => import('../../locales/publication-metadata/el.json'),
+  'es': () => import('../../locales/publication-metadata/es.json'),
+  'et': () => import('../../locales/publication-metadata/et.json'),
+  'fi': () => import('../../locales/publication-metadata/fi.json'),
+  'fr': () => import('../../locales/publication-metadata/fr.json'),
+  'it': () => import('../../locales/publication-metadata/it.json'),
+  'pl': () => import('../../locales/publication-metadata/pl.json'),
+  'pt_PT': () => import('../../locales/publication-metadata/pt_PT.json'),
+  'sv': () => import('../../locales/publication-metadata/sv.json')
 };
 
 // Extract English accessibility data

package/src/publication/accessibility/SupportedLanguages.ts

@@ -1 +1 @@
-export const SUPPORTED_LANGUAGES = ['en', 'ar', 'da', 'fr', 'it', 'pt_PT', 'sv'];
+export const SUPPORTED_LANGUAGES = ['en', 'ar', 'da', 'el', 'es', 'et', 'fi', 'fr', 'it', 'pl', 'pt_PT', 'sv'];

package/src/publication/encryption/Properties.ts

@@ -1,20 +1,8 @@
 import { Properties } from '../Properties.ts';
 import { Encryption } from './Encryption.ts';
 
-// Encryption extensions for link [Properties].
+// Encryption extensions for link Properties.
 
-declare module '../Properties' {
-  export interface Properties {
-    /**
-     * Indicates that a resource is encrypted/obfuscated and provides relevant information for
-     * decryption.
-     */
-    encryption: Encryption | undefined;
-  }
+export function getEncryption(properties: Properties): Encryption | undefined {
+  return Encryption.deserialize(properties.otherProperties.encrypted);
 }
-
-Object.defineProperty(Properties.prototype, 'encryption', {
-  get: function(): Encryption | undefined {
-    return Encryption.deserialize(this.otherProperties.encrypted);
-  },
-});

package/src/publication/epub/Metadata.ts

@@ -1,16 +1,10 @@
-import { Metadata } from "../Metadata.ts";
-import { MediaOverlay } from "./MediaOverlay.ts";
+import { Metadata } from '../Metadata.ts';
+import { MediaOverlay } from './MediaOverlay.ts';
 
-declare module '../Metadata' {
-  export interface Metadata {
-    getMediaOverlay(): MediaOverlay | undefined;
-  }
-}
-
-Metadata.prototype.getMediaOverlay = function(): MediaOverlay | undefined {
-  const mediaOverlay = this.otherMetadata?.['mediaOverlay'];
+// EPUB extensions for Metadata.
 
+export function getMediaOverlay(metadata: Metadata): MediaOverlay | undefined {
+  const mediaOverlay = metadata.otherMetadata?.['mediaOverlay'];
   if (!mediaOverlay) return;
-
   return MediaOverlay.deserialize(mediaOverlay);
-};
+}

package/src/publication/epub/Properties.ts

@@ -1,18 +1,8 @@
 import { Properties } from '../Properties.ts';
 
-// EPUB extensions for link [Properties].
+// EPUB extensions for link Properties.
 // https://readium.org/webpub-manifest/schema/extensions/epub/properties.schema.json
 
-declare module '../Properties' {
-  export interface Properties {
-    /**
-     * Identifies content contained in the linked resource, that cannot be strictly identified using a
-     * media type.
-     */
-    getContains(): Set<string> | undefined;
-  }
+export function getContains(properties: Properties): Set<string> {
+  return new Set<string>(properties.otherProperties['contains'] || []);
 }
-
-Properties.prototype.getContains = function(): Set<string> | undefined {
-  return new Set<string>(this.otherProperties['contains'] || []);
-};

package/src/publication/epub/Publication.ts

@@ -1,51 +1,30 @@
 import { Links } from '../Link.ts';
 import { Publication } from '../Publication.ts';
 
-// EPUB extensions for [Publication].
+// EPUB extensions for Publication.
 // https://readium.org/webpub-manifest/schema/extensions/epub/subcollections.schema.json
 // https://idpf.github.io/epub-vocabs/structure/#navigation
 
-declare module '../Publication' {
-  export interface Publication {
-    /**
-     * Provides navigation to positions in the Publication content that correspond to the locations of
-     * page boundaries present in a print source being represented by this EPUB Publication.
-     */
-    getPageList(): Links | undefined;
-
-    /**
-     * Identifies fundamental structural components of the publication in order to enable Reading
-     * Systems to provide the User efficient access to them.
-     */
-    getLandmarks(): Links | undefined;
-
-    getListOfAudioClips(): Links | undefined;
-    getListOfIllustrations(): Links | undefined;
-    getListOfTables(): Links | undefined;
-    getListOfVideoClips(): Links | undefined;
-  }
+export function getPageList(pub: Publication): Links | undefined {
+  return pub.linksWithRole('pageList');
 }
 
-Publication.prototype.getPageList = function(): Links | undefined {
-  return this.linksWithRole('pageList');
-};
-
-Publication.prototype.getLandmarks = function(): Links | undefined {
-  return this.linksWithRole('landmarks');
-};
+export function getLandmarks(pub: Publication): Links | undefined {
+  return pub.linksWithRole('landmarks');
+}
 
-Publication.prototype.getListOfAudioClips = function(): Links | undefined {
-  return this.linksWithRole('loa');
-};
+export function getListOfAudioClips(pub: Publication): Links | undefined {
+  return pub.linksWithRole('loa');
+}
 
-Publication.prototype.getListOfIllustrations = function(): Links | undefined {
-  return this.linksWithRole('loi');
-};
+export function getListOfIllustrations(pub: Publication): Links | undefined {
+  return pub.linksWithRole('loi');
+}
 
-Publication.prototype.getListOfTables = function(): Links | undefined {
-  return this.linksWithRole('lot');
-};
+export function getListOfTables(pub: Publication): Links | undefined {
+  return pub.linksWithRole('lot');
+}
 
-Publication.prototype.getListOfVideoClips = function(): Links | undefined {
-  return this.linksWithRole('lov');
-};
+export function getListOfVideoClips(pub: Publication): Links | undefined {
+  return pub.linksWithRole('lov');
+}

package/src/publication/html/Locations.ts

@@ -1,129 +1,93 @@
 import { LocatorLocations } from '../Locator.ts';
 import { DomRange } from './DomRange.ts';
 import { parseNptTime } from '../../util/npt.ts';
+import { decodeTextFragmentDirective, TextFragmentDirective } from '@readium/helpers';
 
-// HTML extensions for [Locations].
+// HTML extensions for LocatorLocations.
 // https://github.com/readium/architecture/blob/master/models/locators/extensions/html.md
 
-declare module '../Locator' {
-  export interface LocatorLocations {
-    /**
-     * A CSS Selector.
-     */
-    getCssSelector(): string | undefined;
-
-    /**
-     * [partialCfi] is an expression conforming to the "right-hand" side of the EPUB CFI syntax, that is
-     * to say: without the EPUB-specific OPF spine item reference that precedes the first ! exclamation
-     * mark (which denotes the "step indirection" into a publication document). Note that the wrapping
-     * epubcfi(***) syntax is not used for the [partialCfi] string, i.e. the "fragment" part of the CFI
-     * grammar is ignored.
-     */
-    getPartialCfi(): string | undefined;
-
-    /**
-     * An HTML DOM range.
-     */
-    getDomRange(): DomRange | undefined;
-
-    /**
-     * All named parameters found in the fragments, such as `p=5`.
-     */
-    fragmentParameters(): Map<string, string>;
-
-    /**
-     * HTML ID fragment identifier.
-     */
-    htmlId(): string | undefined;
+export function getCssSelector(loc: LocatorLocations): string | undefined {
+  return loc.otherLocations?.get('cssSelector');
+}
 
-    /**
-     * Page fragment identifier, used for example in PDF.
-     */
-    page(): number | undefined;
+export function getPartialCfi(loc: LocatorLocations): string | undefined {
+  return loc.otherLocations?.get('partialCfi');
+}
 
-    /**
-     * Temporal Dimension media fragment, used for example in audiobooks.
-     *
-     * https://www.w3.org/TR/media-frags/
-     */
-    time(): number | undefined;
+export function getDomRange(loc: LocatorLocations): DomRange | undefined {
+  return DomRange.deserialize(loc.otherLocations?.get('domRange'));
+}
 
-    /**
-     * Spatial Dimension media fragment, used for example in audiobooks.
-     *
-     * https://www.w3.org/TR/media-frags/
-     */
-    space(): [number, number, number, number] | undefined;
+// A WICG text-fragment directive (":~:text=...") found among fragments, per
+// https://wicg.github.io/scroll-to-text-fragment/.
+export function getTextFragment(loc: LocatorLocations): TextFragmentDirective | undefined {
+  for (const fragment of loc.fragments) {
+    const directive = decodeTextFragmentDirective(fragment);
+    if (directive) return directive;
   }
+  return undefined;
 }
 
-LocatorLocations.prototype.getCssSelector = function(): string | undefined {
-  return this.otherLocations?.get('cssSelector');
-};
-
-LocatorLocations.prototype.getPartialCfi = function(): string | undefined {
-  return this.otherLocations?.get('partialCfi');
-};
-
-LocatorLocations.prototype.getDomRange = function(): DomRange | undefined {
-  return DomRange.deserialize(this.otherLocations?.get('domRange'));
-};
-
-// Below is technically part of the Navigator's Locator extensions, we're putting it here for now
-
-// Reference: https://www.w3.org/TR/fragid-best-practices
-LocatorLocations.prototype.fragmentParameters = function(): Map<string, string> {
+export function getFragmentParameters(loc: LocatorLocations): Map<string, string> {
   return new Map(
-    this.fragments
-      // Concatenates fragments together, after dropping any #
-      .map(f => f.startsWith("#") ? f.slice(1) : f)
-      .join("&")
-      // Splits parameters
-      .split("&")
-      .filter(f => !f.startsWith("#"))
-      .map(f => f.split("="))
-      // Only keep named parameters
+    loc.fragments
+      .map(f => f.startsWith('#') ? f.slice(1) : f)
+      .join('&')
+      .split('&')
+      .filter(f => !f.startsWith('#'))
+      .map(f => f.split('='))
       .filter(f => f.length === 2)
-      .map(f => [
-        f[0].trim().toLowerCase(),
-        f[1].trim()
-      ])
+      .map(f => [f[0].trim().toLowerCase(), f[1].trim()])
   );
-};
+}
 
-LocatorLocations.prototype.htmlId = function(): string | undefined {
+export function getHtmlId(loc: LocatorLocations): string | undefined {
   /*
   The HTML 5 specification (used for WebPub) allows any character in an HTML ID, except spaces.
   This is an issue to differentiate with named parameters, so we ignore any ID containing `=`.
   */
-  if(!this.fragments.length) return;
-  let f = this.fragments.find(f => f.length && !f.includes("="));
-  if(!f) {
-    const fp = this.fragmentParameters();
-    if(fp.has("id")) f = fp.get("id");
-    else if(fp.has("name")) f = fp.get("name");
+  if (!loc.fragments.length) return;
+  let f = loc.fragments.find(f => f.length && !f.includes('='));
+  if (!f) {
+    const fp = getFragmentParameters(loc);
+    if (fp.has('id')) f = fp.get('id');
+    else if (fp.has('name')) f = fp.get('name');
   }
-  return f?.startsWith("#") ? f.slice(1) : f;
-};
+  return f?.startsWith('#') ? f.slice(1) : f;
+}
 
-LocatorLocations.prototype.page = function(): number | undefined {
-  const i = parseInt(this.fragmentParameters().get("page")!);
-  if(!isNaN(i) && i >= 0) return i;
+export function getPage(loc: LocatorLocations): number | undefined {
+  const i = parseInt(getFragmentParameters(loc).get('page')!);
+  if (!isNaN(i) && i >= 0) return i;
   return undefined;
 }
 
-LocatorLocations.prototype.time = function(): number | undefined {
-  const raw = this.fragmentParameters().get("t");
+export function getTime(loc: LocatorLocations): number | undefined {
+  const raw = getFragmentParameters(loc).get('t');
   if (!raw) return undefined;
   return parseNptTime(raw);
 }
 
-LocatorLocations.prototype.space = function(): [number, number, number, number] | undefined {
-  const fp = this.fragmentParameters();
-  if(!fp.has("xywh")) return;
-  // TODO more sophiticated parsing to handle the format
-  const xywh = fp.get("xywh")!.split(",").map(s => parseInt(s));
-  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];
+export function getSpace(loc: LocatorLocations): { unit: "pixel" | "percent"; x: number; y: number; width: number; height: number } | undefined {
+  const fp = getFragmentParameters(loc);
+  if (!fp.has('xywh')) return;
+
+  const raw = fp.get('xywh')!;
+  let unit: "pixel" | "percent" = "pixel";
+  let coords = raw;
+
+  const normalizedRaw = raw.toLowerCase();
+  if (normalizedRaw.startsWith("pixel:")) {
+    coords = raw.slice(6);
+  } else if (normalizedRaw.startsWith("percent:")) {
+    unit = "percent";
+    coords = raw.slice(8);
+  }
+
+  const parse = unit === "percent" ? parseFloat : (s: string) => parseInt(s, 10);
+  const parts = coords.split(",").map(parse);
+  if (parts.length !== 4 || parts.some(isNaN)) return;
+
+  const [x, y, width, height] = parts;
+  return { unit, x, y, width, height };
 }