@readium/shared 2.2.0-beta.2 → 2.2.0

package/src/publication/accessibility/Localization.ts

@@ -1,6 +1,6 @@
 // Localization.ts
 
-import { SUPPORTED_LANGUAGES } from './SupportedLanguages';
+import { SUPPORTED_LANGUAGES } from './SupportedLanguages.ts';
 // Static import for English (default locale)
 import enLocale from '@edrlab/thorium-locales/publication-metadata/en.json';
 
@@ -65,20 +65,20 @@ class LocalizationImpl {
     if (localeCode in this.loadedLocales) {
       return true;
     }
-    
+
     try {
       // Check if we have a loader for this locale
       if (!(localeCode in jsonLoaders)) {
         console.warn(`Locale file not found for: ${localeCode}`);
         return false;
       }
-      
+
       const localeModule = await jsonLoaders[localeCode]();
       const data = localeModule.default;
-      
+
       // Extract the accessibility.display-guide part
       const accessibilityData = data?.publication?.metadata?.accessibility?.['display-guide'];
-      
+
       if (accessibilityData) {
         this.loadedLocales[localeCode] = accessibilityData;
         return true;
@@ -113,12 +113,12 @@ class LocalizationImpl {
     if (!(localeCode in this.loadedLocales)) {
       await this.loadLocale(localeCode);
     }
-    
+
     if (!(localeCode in this.loadedLocales)) {
       console.warn(`Locale '${localeCode}' is not available`);
       return false;
     }
-    
+
     this.locale = this.loadedLocales[localeCode];
     this.currentLocaleCode = localeCode;
     return true;
@@ -141,14 +141,14 @@ class LocalizationImpl {
   private getNestedValue(obj: any, path: string): string | L10nString | undefined {
     const parts = path.split('.');
     let current = obj;
-    
+
     for (const part of parts) {
       if (current === null || current === undefined) {
         return undefined;
       }
       current = current[part];
     }
-    
+
     return current;
   }
 
@@ -160,19 +160,19 @@ class LocalizationImpl {
   public getString(key: string): L10nString {
     // First try the current locale
     let value = this.getNestedValue(this.locale, key);
-    
+
     // If not found and current locale is not English, try falling back to English
     if (value === undefined && this.currentLocaleCode !== 'en') {
       value = this.getNestedValue(this.loadedLocales['en'], key);
     }
-    
+
     // If we have a value, return it with proper formatting
     if (value !== undefined) {
-      return typeof value === 'string' 
-        ? { compact: value, descriptive: value } 
+      return typeof value === 'string'
+        ? { compact: value, descriptive: value }
         : value;
     }
-    
+
     // If we get here, the key wasn't found in either locale
     console.warn(`Missing localization for key: ${key}`);
     return { compact: '', descriptive: '' };
@@ -182,4 +182,4 @@ class LocalizationImpl {
 /**
  * The singleton instance of the [Localization] class.
  */
-export const Localization = LocalizationImpl.getInstance();
+export const Localization = LocalizationImpl.getInstance();

package/src/publication/accessibility/index.ts

@@ -1,3 +1,3 @@
-export * from './Accessibility';
-export * from './AccessibilityMetadataDisplayGuide';
-export * from './Localization';
+export * from './Accessibility.ts';
+export * from './AccessibilityMetadataDisplayGuide.ts';
+export * from './Localization.ts';

package/src/publication/encryption/Properties.ts

@@ -1,5 +1,5 @@
-import { Properties } from '../Properties';
-import { Encryption } from './Encryption';
+import { Properties } from '../Properties.ts';
+import { Encryption } from './Encryption.ts';
 
 // Encryption extensions for link [Properties].
 

package/src/publication/encryption/index.ts

@@ -1,2 +1,2 @@
-export * from './Encryption';
-export * from './Properties';
+export * from './Encryption.ts';
+export * from './Properties.ts';

package/src/publication/epub/Metadata.ts

@@ -1,5 +1,5 @@
-import { Metadata } from "../Metadata";
-import { MediaOverlay } from "./MediaOverlay";
+import { Metadata } from "../Metadata.ts";
+import { MediaOverlay } from "./MediaOverlay.ts";
 
 declare module '../Metadata' {
   export interface Metadata {
@@ -13,4 +13,4 @@ Metadata.prototype.getMediaOverlay = function(): MediaOverlay | undefined {
   if (!mediaOverlay) return;
 
   return MediaOverlay.deserialize(mediaOverlay);
-};
+};

package/src/publication/epub/Properties.ts

@@ -1,4 +1,4 @@
-import { Properties } from '../Properties';
+import { Properties } from '../Properties.ts';
 
 // EPUB extensions for link [Properties].
 // https://readium.org/webpub-manifest/schema/extensions/epub/properties.schema.json

package/src/publication/epub/Publication.ts

@@ -1,5 +1,5 @@
-import { Links } from '../Link';
-import { Publication } from '../Publication';
+import { Links } from '../Link.ts';
+import { Publication } from '../Publication.ts';
 
 // EPUB extensions for [Publication].
 // https://readium.org/webpub-manifest/schema/extensions/epub/subcollections.schema.json

package/src/publication/epub/index.ts

@@ -1,4 +1,4 @@
-export * from './MediaOverlay';
-export * from './Metadata';
-export * from './Properties';
-export * from './Publication';
+export * from './MediaOverlay.ts';
+export * from './Metadata.ts';
+export * from './Properties.ts';
+export * from './Publication.ts';

package/src/publication/html/DomRange.ts

@@ -3,7 +3,7 @@
  * available in the LICENSE file present in the Github repository of the project.
  */
 
-import { DomRangePoint } from './DomRangePoint';
+import { DomRangePoint } from './DomRangePoint.ts';
 
 /**
  * This construct enables a serializable representation of a DOM Range.

package/src/publication/html/DomRangePoint.ts

@@ -1,4 +1,4 @@
-import { positiveNumberfromJSON } from '../../util/JSONParse';
+import { positiveNumberfromJSON } from '../../util/JSONParse.ts';
 
 /**
  * A serializable representation of a boundary point in a DOM Range.

package/src/publication/html/Locations.ts

@@ -1,5 +1,5 @@
-import { LocatorLocations } from '../Locator';
-import { DomRange } from './DomRange';
+import { LocatorLocations } from '../Locator.ts';
+import { DomRange } from './DomRange.ts';
 
 // HTML extensions for [Locations].
 // https://github.com/readium/architecture/blob/master/models/locators/extensions/html.md
@@ -126,4 +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];
-}
+}

package/src/publication/html/index.ts

@@ -1,3 +1,3 @@
-export * from './DomRange';
-export * from './DomRangePoint';
-export * from './Locations';
+export * from './DomRange.ts';
+export * from './DomRangePoint.ts';
+export * from './Locations.ts';

package/src/publication/index.ts

@@ -1,24 +1,24 @@
-export * from './accessibility';
-export * from './encryption';
-export * from './epub';
-export * from './html';
-export * from './opds';
-export * from './services';
-export * from './AltIdentifier';
-export * from './BelongsTo';
-export * from './Contributor';
-export * from './Link';
-export * from './LocalizedString';
-export * from './Locator';
-export * from './LocatorCollection';
-export * from './Manifest';
-export * from './Metadata';
-export * from './Profiles';
-export * from './Properties';
-export * from './Publication';
-export * from './PublicationCollection';
-export * from './Layout';
-export * from './ReadingProgression';
-export * from './Subject';
-export * from './TDM';
-export * from './GuidedNavigation';
+export * from './accessibility/index.ts';
+export * from './encryption/index.ts';
+export * from './epub/index.ts';
+export * from './html/index.ts';
+export * from './opds/index.ts';
+export * from './services/index.ts';
+export * from './AltIdentifier.ts';
+export * from './BelongsTo.ts';
+export * from './Contributor.ts';
+export * from './Link.ts';
+export * from './LocalizedString.ts';
+export * from './Locator.ts';
+export * from './LocatorCollection.ts';
+export * from './Manifest.ts';
+export * from './Metadata.ts';
+export * from './Profiles.ts';
+export * from './Properties.ts';
+export * from './Publication.ts';
+export * from './PublicationCollection.ts';
+export * from './Layout.ts';
+export * from './ReadingProgression.ts';
+export * from './Subject.ts';
+export * from './TDM.ts';
+export * from './GuidedNavigation.ts';

package/src/publication/opds/Properties.ts

@@ -1,7 +1,7 @@
-import { Copies, Acquisition, Holds, Price, Availability } from '../../opds';
-import { positiveNumberfromJSON } from '../../util/JSONParse';
-import { Link } from '../Link';
-import { Properties } from '../Properties';
+import { Copies, Acquisition, Holds, Price, Availability } from '../../opds/index.ts';
+import { positiveNumberfromJSON } from '../../util/JSONParse.ts';
+import { Link } from '../Link.ts';
+import { Properties } from '../Properties.ts';
 
 // OPDS extensions for link [Properties].
 // https://drafts.opds.io/schema/properties.schema.json

package/src/publication/opds/Publication.ts

@@ -1,5 +1,5 @@
-import { Links } from '../Link';
-import { Publication } from '../Publication';
+import { Links } from '../Link.ts';
+import { Publication } from '../Publication.ts';
 
 // OPDS extensions for [Publication]
 

package/src/publication/opds/index.ts

@@ -1,2 +1,2 @@
-export * from './Properties';
-export * from './Publication';
+export * from './Properties.ts';
+export * from './Publication.ts';

package/src/publication/services/content/Content.ts

@@ -1,5 +1,5 @@
-import { Iterator } from "./Iterator";
-import { ContentElement, TextualElement } from "./element";
+import { Iterator } from "./Iterator.ts";
+import { ContentElement, TextualElement } from "./element/index.ts";
 
 /**
  * Provides an iterable list of content [Element]s.
@@ -33,4 +33,4 @@ export abstract class Content {
         }
         return list;
     }
-}
+}

package/src/publication/services/content/ContentTokenizer.ts

@@ -1,13 +1,13 @@
-import { DefaultTextContentTokenizer, Range, TextTokenizer, TextUnit, Tokenizer } from "../../../util";
-import { Locator, LocatorText } from "../../Locator";
-import { ContentElement, TextElement, TextSegment } from "./element";
+import { DefaultTextContentTokenizer, Range, TextTokenizer, TextUnit, Tokenizer } from "../../../util/index.ts";
+import { Locator, LocatorText } from "../../Locator.ts";
+import { ContentElement, TextElement, TextSegment } from "./element/index.ts";
 
 // A tokenizer splitting a [Content.Element] into smaller pieces.
 export type ContentTokenizer  = Tokenizer<ContentElement, ContentElement>;
 
 export class TextContentTokenizer implements ContentTokenizer {
     /**
-     * 
+     *
      * @param defaultLanguage The default assumed language
      * @param unit The unit of the produced [Locator]s.
      * @param contextSnippetLength Length of `before` and `after` snippets in the produced [Locator]s.
@@ -27,7 +27,7 @@ export class TextContentTokenizer implements ContentTokenizer {
                 new TextElement(
                     data.locator,
                     data.role,
-                    data.segments.map(s => this.tokenizeSegment(s)).flat(), 
+                    data.segments.map(s => this.tokenizeSegment(s)).flat(),
                 )
             ];
         }
@@ -59,4 +59,4 @@ export class TextContentTokenizer implements ContentTokenizer {
             highlight: str.substring(range[0], range[1]),
         })
     }
-}
+}

package/src/publication/services/content/Iterator.ts

@@ -1,4 +1,4 @@
-import { ContentElement } from "./element";
+import { ContentElement } from "./element/index.ts";
 
 export class IllegalStateError extends Error {
     constructor(message: string) {
@@ -43,4 +43,4 @@ export abstract class Iterator {
     async previousOrNull(): Promise<ContentElement | null> {
         return (await this.hasPrevious()) ? this.previous() : null;
     }
-}
+}

package/src/publication/services/content/element/attributes.ts

@@ -1,4 +1,4 @@
-import { Language } from "../../../../util/Language";
+import { Language } from "../../../../util/Language.ts";
 
 export class Attribute<V> {
     constructor(
@@ -41,4 +41,4 @@ export abstract class AttributesHolder {
     attributes<V>(key: AttributeKeys | string): V[] {
         return this._attributes.filter(attribute => attribute.key === key).map(attribute => attribute.value);
     }
-}
+}

package/src/publication/services/content/element/element.ts

@@ -1,7 +1,7 @@
-import { Link } from "../../../Link";
-import { Locator } from "../../../Locator";
-import { AttributesHolder, Attribute } from "./attributes";
-import { TextRole } from "./text_role";
+import { Link } from "../../../Link.ts";
+import { Locator } from "../../../Locator.ts";
+import { AttributesHolder, Attribute } from "./attributes.ts";
+import { TextRole } from "./text_role.ts";
 
 /**
  * Represents a single semantic content element part of a publication.
@@ -115,4 +115,4 @@ export class TextElement extends TextualElement {
     get text(): string | undefined {
         return this.segments.map(segment => segment.text).join("");
     }
-}
+}

package/src/publication/services/content/element/index.ts

@@ -1,3 +1,3 @@
-export * from './element';
-export * from './attributes';
-export * from './text_role';
+export * from './element.ts';
+export * from './attributes.ts';
+export * from './text_role.ts';

package/src/publication/services/content/index.ts

@@ -1,5 +1,5 @@
-export * from './Content';
-export * from './ContentTokenizer';
-export * from './Iterator';
-export * from './element';
-export * from './iterators';
+export * from './Content.ts';
+export * from './ContentTokenizer.ts';
+export * from './Iterator.ts';
+export * from './element/index.ts';
+export * from './iterators/index.ts';

package/src/publication/services/content/iterators/HTMLResourceContentIterator.ts

@@ -1,9 +1,9 @@
-import { Resource } from "../../../../fetcher/Resource";
-import { Link, Links } from "../../../Link";
-import { Locator, LocatorLocations } from "../../../Locator";
-import { IllegalStateError, Iterator } from "../Iterator";
-import { Attribute, AttributeKeys, AudioElement, Body, ContentElement, Footnote, Heading, ImageElement, TextElement, TextQuote, TextRole, TextSegment, VideoElement } from "../element";
-import { appendNormalizedWhitespace, elementLanguage, isBlank, isInlineTag, srcRelativeToHref, trimUnicodeSpace, trimUnicodeSpaceEnd, trimUnicodeSpaceStart, trimmingTextLocator } from "./helpers";
+import { Resource } from "../../../../fetcher/Resource.ts";
+import { Link, Links } from "../../../Link.ts";
+import { Locator, LocatorLocations } from "../../../Locator.ts";
+import { IllegalStateError, Iterator } from "../Iterator.ts";
+import { Attribute, AttributeKeys, AudioElement, Body, ContentElement, Footnote, Heading, ImageElement, TextElement, TextQuote, TextRole, TextSegment, VideoElement } from "../element/index.ts";
+import { appendNormalizedWhitespace, elementLanguage, isBlank, isInlineTag, srcRelativeToHref, trimUnicodeSpace, trimUnicodeSpaceEnd, trimUnicodeSpaceStart, trimmingTextLocator } from "./helpers.ts";
 import { getCssSelector } from "css-selector-generator";
 
 interface ElementWithDelta {
@@ -297,7 +297,7 @@ class ContentParser implements NodeVisitor {
                     sr.attributes
                 );
             });
-    
+
             return new TextElement(
                 new Locator({
                     href: this.baseLocator.href,
@@ -568,4 +568,4 @@ class ContentParser implements NodeVisitor {
         this.rawTextAcc = "";
         this.textAcc = "";
     }
-}
+}

package/src/publication/services/content/iterators/PDFTextContentIterator.ts

@@ -1,6 +1,6 @@
-import { Locator } from "../../../Locator";
-import { Attribute, ContentElement } from "../element";
-import { IllegalStateError, Iterator } from "../Iterator";
+import { Locator } from "../../../Locator.ts";
+import { Attribute, ContentElement } from "../element/index.ts";
+import { IllegalStateError, Iterator } from "../Iterator.ts";
 
 // Type TextItem represents a text item in a PDF page (extracted from pdf.js TextItem type).
 type TextItem = {
@@ -47,7 +47,7 @@ class ElementInDirection {
     ) {}
 }
 
-/* An iterator which iterates through a whole PDF page provided, 
+/* An iterator which iterates through a whole PDF page provided,
     and returns the elements based on a [PDFReadableElement] array. */
 
 // TODO extend Iterator class!
@@ -65,7 +65,7 @@ export class PageContentIteratorPDF extends Iterator{
          */
         private pageContent: Array<TextItem>,
         private startLocator?: Locator | null | undefined
-    ) { 
+    ) {
         super();
         const contentFiltered = this.pageContent.filter(
             (item: TextItem) => item?.str !== " " && item?.str !== ""
@@ -95,7 +95,7 @@ export class PageContentIteratorPDF extends Iterator{
 
 
     // Returns the current element to be read.
-    current(): ContentElement | null { 
+    current(): ContentElement | null {
         return this.currentElement ? this.currentElement.element : null;
     }
 
@@ -105,9 +105,9 @@ export class PageContentIteratorPDF extends Iterator{
     }
 
     previous(): ContentElement {
-        
+
         if (!this.currentElement) throw new IllegalStateError("Called next() without a successful call to hasNext() first");
-        
+
         this.currentElement = this.nextIn(Direction.Backward);
 
         if (this.currentElementIndex && this.currentElementIndex > 0) {
@@ -115,11 +115,11 @@ export class PageContentIteratorPDF extends Iterator{
             this.currentProgression = newIndex / this.pageContentFiltered.length * 100;
             this.currentElementIndex = newIndex;
         }
-        
-        return this.currentElement ? 
-            this.currentElement.element : 
+
+        return this.currentElement ?
+            this.currentElement.element :
             new PDFContentElement(new Locator( { href : "", type: "" }), { index: -1, text: "" });
-        
+
     }
 
     async hasNext(): Promise<boolean> {
@@ -128,21 +128,21 @@ export class PageContentIteratorPDF extends Iterator{
     }
 
     next(): ContentElement {
-        
+
         this.currentElement = this.nextIn(Direction.Forward);
         const currentIndex = this.currentElementIndex;
         if (currentIndex !== null &&
-            currentIndex >= 0 && 
+            currentIndex >= 0 &&
             currentIndex < this.pageContentFiltered.length - 1) {
             const newIndex = currentIndex + 1;
             this.currentProgression = newIndex / (this.pageContentFiltered.length) * 100;
             this.currentElementIndex = newIndex;
         }
-    
-        return this.currentElement ? 
-            this.currentElement.element : 
+
+        return this.currentElement ?
+            this.currentElement.element :
             new PDFContentElement(new Locator( { href : "", type: "" }), { index: -1, text: "" });
-             
+
     }
 
     private nextIn(direction: Direction): ElementInDirection | null {
@@ -173,12 +173,12 @@ export class PageContentIteratorPDF extends Iterator{
      */
     private updateElementIndex(): number | null {
         if (this.currentProgression === 0) return 0;
-        
+
         // return null if the current progression is out of bounds
         if (this.currentProgression < 0 || this.currentProgression >= 100) return null;
-        
+
         // Convert the progression percentage to an index in the pageContentFiltered array
         return Math.floor(this.currentProgression * this.pageContentFiltered.length / 100);
     }
 
-}
+}

package/src/publication/services/content/iterators/PublicationContentIterator.ts

@@ -1,8 +1,8 @@
-import { Resource } from "../../../../fetcher/Resource";
-import { Locator } from "../../../Locator";
-import { Publication } from "../../../Publication";
-import { IllegalStateError, Iterator } from "../Iterator";
-import { ContentElement } from "../element";
+import { Resource } from "../../../../fetcher/Resource.ts";
+import { Locator } from "../../../Locator.ts";
+import { Publication } from "../../../Publication.ts";
+import { IllegalStateError, Iterator } from "../Iterator.ts";
+import { ContentElement } from "../element/index.ts";
 
 // Creates a [Content.Iterator] instance for the [Resource], starting from the given [Locator].
 // Returns null if the resource media type is not supported.
@@ -141,4 +141,4 @@ export class PublicationContentIterator extends Iterator {
 
         return null;
     }
-}
+}

package/src/publication/services/content/iterators/helpers.ts

@@ -1,4 +1,4 @@
-import { LocatorText } from "../../../Locator";
+import { LocatorText } from "../../../Locator.ts";
 
 
 // https://github.com/jhy/jsoup/blob/0b10d516ed8f907f8fb4acb9a0806137a8988d45/src/main/java/org/jsoup/parser/Tag.java#L243

package/src/publication/services/content/iterators/index.ts

@@ -1,3 +1,3 @@
-export * from './PublicationContentIterator';
-export * from './PDFTextContentIterator';
-export * from './HTMLResourceContentIterator';
+export * from './PublicationContentIterator.ts';
+export * from './PDFTextContentIterator.ts';
+export * from './HTMLResourceContentIterator.ts';

package/src/publication/services/index.ts

@@ -1,2 +1,2 @@
-export * from './content';
-export * from './timeline';
+export * from './timeline/index.ts';
+export * from './content/index.ts';