@readium/shared 1.3.0 → 2.1.0

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

@@ -0,0 +1,30 @@
+/**
+ * https://readium.org/webpub-manifest/contexts/default/#text-and-data-mining
+ */
+export declare enum TDMReservation {
+    all = "all",
+    none = "none"
+}
+export declare class TDM {
+    /**
+     * Indicates whether the publication allows text and data mining.
+     */
+    readonly reservation?: TDMReservation;
+    /**
+     * Additional policy information about text and data mining usage.
+     */
+    readonly policy?: string;
+    /** Creates a [TDM] object */
+    constructor(values: {
+        reservation?: TDMReservation;
+        policy?: string;
+    });
+    /**
+     * Parses a [TDM] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): TDM | undefined;
+    /**
+     * Serializes a [TDM] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/publication/accessibility/Accessibility.d.ts

@@ -8,7 +8,7 @@ export declare class Accessibility {
     /**
      * An established standard to which the described resource conforms.
      */
-    conformsTo: Profile[];
+    conformsTo: AccessibilityProfile[];
     /**
      * Certification of accessible publications.
      */
@@ -38,7 +38,7 @@ export declare class Accessibility {
      */
     exemption: Exemption[];
     constructor(values?: {
-        conformsTo?: Profile[];
+        conformsTo?: AccessibilityProfile[];
         certification?: Certification | null;
         summary?: string | null;
         accessMode?: AccessMode[];
@@ -56,25 +56,76 @@ export declare class Accessibility {
      */
     serialize(): Record<string, any>;
 }
-export declare class Profile {
+export declare class AccessibilityProfile {
     readonly uri: string;
     constructor(uri: string);
-    static deserialize(json: any): Profile | undefined;
+    /**
+     * Parses an [AccessibilityProfile] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): AccessibilityProfile | undefined;
+    /**
+     * Serializes an [AccessibilityProfile] to its RWPM JSON representation.
+     */
     serialize(): any;
-    static readonly EPUB_A11Y_10_WCAG_20_A: Profile;
-    static readonly EPUB_A11Y_10_WCAG_20_AA: Profile;
-    static readonly EPUB_A11Y_10_WCAG_20_AAA: Profile;
-    static readonly EPUB_A11Y_11_WCAG_20_A: Profile;
-    static readonly EPUB_A11Y_11_WCAG_20_AA: Profile;
-    static readonly EPUB_A11Y_11_WCAG_20_AAA: Profile;
-    static readonly EPUB_A11Y_11_WCAG_21_A: Profile;
-    static readonly EPUB_A11Y_11_WCAG_21_AA: Profile;
-    static readonly EPUB_A11Y_11_WCAG_21_AAA: Profile;
-    static readonly EPUB_A11Y_11_WCAG_22_A: Profile;
-    static readonly EPUB_A11Y_11_WCAG_22_AA: Profile;
-    static readonly EPUB_A11Y_11_WCAG_22_AAA: Profile;
+    /**
+     * EPUB Accessibility 1.0 WCAG 2.0 A – http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a
+     */
+    static readonly EPUB_A11Y_10_WCAG_20_A: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.0 WCAG 2.0 AA – http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa
+     */
+    static readonly EPUB_A11Y_10_WCAG_20_AA: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.0 WCAG 2.0 AAA – http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa
+     */
+    static readonly EPUB_A11Y_10_WCAG_20_AAA: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.0 A – https://www.w3.org/TR/epub-a11y-11#wcag-2.0-a
+     */
+    static readonly EPUB_A11Y_11_WCAG_20_A: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.0 AA – https://www.w3.org/TR/epub-a11y-11#wcag-2.0-aa
+     */
+    static readonly EPUB_A11Y_11_WCAG_20_AA: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.0 AAA – https://www.w3.org/TR/epub-a11y-11#wcag-2.0-aaa
+     */
+    static readonly EPUB_A11Y_11_WCAG_20_AAA: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.1 A – https://www.w3.org/TR/epub-a11y-11#wcag-2.1-a
+     */
+    static readonly EPUB_A11Y_11_WCAG_21_A: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.1 AA – https://www.w3.org/TR/epub-a11y-11#wcag-2.1-aa
+     */
+    static readonly EPUB_A11Y_11_WCAG_21_AA: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.1 AAA – https://www.w3.org/TR/epub-a11y-11#wcag-2.1-aaa
+     */
+    static readonly EPUB_A11Y_11_WCAG_21_AAA: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.2 A – https://www.w3.org/TR/epub-a11y-11#wcag-2.2-a
+     */
+    static readonly EPUB_A11Y_11_WCAG_22_A: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.2 AA – https://www.w3.org/TR/epub-a11y-11#wcag-2.2-aa
+     */
+    static readonly EPUB_A11Y_11_WCAG_22_AA: AccessibilityProfile;
+    /**
+     * EPUB Accessibility 1.1 WCAG 2.2 AAA – https://www.w3.org/TR/epub-a11y-11#wcag-2.2-aaa
+     */
+    static readonly EPUB_A11Y_11_WCAG_22_AAA: AccessibilityProfile;
+    /**
+     * Returns true if the profile is a WCAG Level A profile.
+     */
     get isWCAGLevelA(): boolean;
+    /**
+     * Returns true if the profile is a WCAG Level AA profile.
+     */
     get isWCAGLevelAA(): boolean;
+    /**
+     * Returns true if the profile is a WCAG Level AAA profile.
+     */
     get isWCAGLevelAAA(): boolean;
 }
 export declare class Certification {
@@ -82,115 +133,385 @@ export declare class Certification {
     readonly credential: string | null;
     readonly report: string | null;
     constructor(certifiedBy?: string | null, credential?: string | null, report?: string | null);
+    /**
+     * Parses a [Certification] from its RWPM JSON representation.
+     */
     static deserialize(json: any): Certification | undefined;
+    /**
+     * Serializes a [Certification] to its RWPM JSON representation.
+     */
     serialize(): Record<string, any>;
 }
 export declare class AccessMode {
     readonly value: string;
     constructor(value: string);
+    /**
+     * Parses an [AccessMode] from its RWPM JSON representation.
+     */
     static deserialize(json: any): AccessMode | undefined;
+    /**
+     * Serializes an [AccessMode] to its RWPM JSON representation.
+     */
     serialize(): any;
+    /**
+     * Access mode for auditory content.
+     */
     static readonly AUDITORY: AccessMode;
+    /**
+     * Access mode for chart on visual content.
+     */
     static readonly CHART_ON_VISUAL: AccessMode;
+    /**
+     * Access mode for chemical on visual content.
+     */
     static readonly CHEM_ON_VISUAL: AccessMode;
+    /**
+     * Access mode for color dependent content.
+     */
     static readonly COLOR_DEPENDENT: AccessMode;
+    /**
+     * Access mode for diagram on visual content.
+     */
     static readonly DIAGRAM_ON_VISUAL: AccessMode;
+    /**
+     * Access mode for math on visual content.
+     */
     static readonly MATH_ON_VISUAL: AccessMode;
+    /**
+     * Access mode for music on visual content.
+     */
     static readonly MUSIC_ON_VISUAL: AccessMode;
+    /**
+     * Access mode for tactile content.
+     */
     static readonly TACTILE: AccessMode;
+    /**
+     * Access mode for text on visual content.
+     */
     static readonly TEXT_ON_VISUAL: AccessMode;
+    /**
+     * Access mode for textual content.
+     */
     static readonly TEXTUAL: AccessMode;
+    /**
+     * Access mode for visual content.
+     */
     static readonly VISUAL: AccessMode;
 }
 export declare class PrimaryAccessMode {
     readonly value: string | string[];
     private static readonly VALID_MODES;
     constructor(value: string | string[]);
+    /**
+     * Parses a [PrimaryAccessMode] from its RWPM JSON representation.
+     */
     static deserialize(json: any): PrimaryAccessMode | undefined;
+    /**
+     * Serializes a [PrimaryAccessMode] to its RWPM JSON representation.
+     */
     serialize(): string | string[];
+    /**
+     * Primary access mode for auditory content.
+     */
     static readonly AUDITORY: PrimaryAccessMode;
+    /**
+     * Primary access mode for tactile content.
+     */
     static readonly TACTILE: PrimaryAccessMode;
+    /**
+     * Primary access mode for textual content.
+     */
     static readonly TEXTUAL: PrimaryAccessMode;
+    /**
+     * Primary access mode for visual content.
+     */
     static readonly VISUAL: PrimaryAccessMode;
 }
 export declare class Feature {
     readonly value: string;
     constructor(value: string);
+    /**
+     * Parses a [Feature] from its RWPM JSON representation.
+     */
     static deserialize(json: any): Feature | undefined;
+    /**
+     * Serializes a [Feature] to its RWPM JSON representation.
+     */
     serialize(): any;
+    /**
+     * Feature for no accessibility features.
+     */
     static readonly NONE: Feature;
+    /**
+     * Feature for annotations.
+     */
     static readonly ANNOTATIONS: Feature;
+    /**
+     * Feature for ARIA.
+     */
     static readonly ARIA: Feature;
+    /**
+     * Feature for index.
+     */
     static readonly INDEX: Feature;
+    /**
+     * Feature for page break markers.
+     */
     static readonly PAGE_BREAK_MARKERS: Feature;
+    /**
+     * Feature for page navigation.
+     */
     static readonly PAGE_NAVIGATION: Feature;
+    /**
+     * Feature for print page numbers.
+     */
     static readonly PRINT_PAGE_NUMBERS: Feature;
+    /**
+     * Feature for reading order.
+     */
     static readonly READING_ORDER: Feature;
+    /**
+     * Feature for structural navigation.
+     */
     static readonly STRUCTURAL_NAVIGATION: Feature;
+    /**
+     * Feature for table of contents.
+     */
     static readonly TABLE_OF_CONTENTS: Feature;
+    /**
+     * Feature for tagged PDF.
+     */
     static readonly TAGGED_PDF: Feature;
+    /**
+     * Feature for alternative text.
+     */
     static readonly ALTERNATIVE_TEXT: Feature;
+    /**
+     * Feature for audio description.
+     */
     static readonly AUDIO_DESCRIPTION: Feature;
+    /**
+     * Feature for captions.
+     */
     static readonly CAPTIONS: Feature;
+    /**
+     * Feature for closed captions.
+     */
     static readonly CLOSED_CAPTIONS: Feature;
+    /**
+     * Feature for described math.
+     */
     static readonly DESCRIBED_MATH: Feature;
+    /**
+     * Feature for long description.
+     */
     static readonly LONG_DESCRIPTION: Feature;
+    /**
+     * Feature for open captions.
+     */
     static readonly OPEN_CAPTIONS: Feature;
+    /**
+     * Feature for sign language.
+     */
     static readonly SIGN_LANGUAGE: Feature;
+    /**
+     * Feature for transcript.
+     */
     static readonly TRANSCRIPT: Feature;
+    /**
+     * Feature for display transformability.
+     */
     static readonly DISPLAY_TRANSFORMABILITY: Feature;
+    /**
+     * Feature for synchronized audio text.
+     */
     static readonly SYNCHRONIZED_AUDIO_TEXT: Feature;
+    /**
+     * Feature for timing control.
+     */
     static readonly TIMING_CONTROL: Feature;
+    /**
+     * Feature for unlocked.
+     */
     static readonly UNLOCKED: Feature;
+    /**
+     * Feature for ChemML.
+     */
     static readonly CHEM_ML: Feature;
+    /**
+     * Feature for LaTeX.
+     */
     static readonly LATEX: Feature;
+    /**
+     * Feature for LaTeX chemistry.
+     */
     static readonly LATEX_CHEMISTRY: Feature;
+    /**
+     * Feature for MathML.
+     */
     static readonly MATH_ML: Feature;
+    /**
+     * Feature for MathML chemistry.
+     */
     static readonly MATH_ML_CHEMISTRY: Feature;
+    /**
+     * Feature for TTS markup.
+     */
     static readonly TTS_MARKUP: Feature;
+    /**
+     * Feature for high contrast audio.
+     */
     static readonly HIGH_CONTRAST_AUDIO: Feature;
+    /**
+     * Feature for high contrast display.
+     */
     static readonly HIGH_CONTRAST_DISPLAY: Feature;
+    /**
+     * Feature for large print.
+     */
     static readonly LARGE_PRINT: Feature;
+    /**
+     * Feature for braille.
+     */
     static readonly BRAILLE: Feature;
+    /**
+     * Feature for tactile graphic.
+     */
     static readonly TACTILE_GRAPHIC: Feature;
+    /**
+     * Feature for tactile object.
+     */
     static readonly TACTILE_OBJECT: Feature;
+    /**
+     * Feature for full ruby annotations.
+     */
     static readonly FULL_RUBY_ANNOTATIONS: Feature;
+    /**
+     * Feature for horizontal writing.
+     */
     static readonly HORIZONTAL_WRITING: Feature;
+    /**
+     * Feature for ruby annotations.
+     */
     static readonly RUBY_ANNOTATIONS: Feature;
+    /**
+     * Feature for vertical writing.
+     */
     static readonly VERTICAL_WRITING: Feature;
+    /**
+     * Feature for additional word segmentation.
+     */
     static readonly WITH_ADDITIONAL_WORD_SEGMENTATION: Feature;
+    /**
+     * Feature for lack of additional word segmentation.
+     */
     static readonly WITHOUT_ADDITIONAL_WORD_SEGMENTATION: Feature;
 }
 export declare class Hazard {
     readonly value: string;
     constructor(value: string);
+    /**
+     * Parses a [Hazard] from its RWPM JSON representation.
+     */
     static deserialize(json: any): Hazard | undefined;
+    /**
+     * Serializes a [Hazard] to its RWPM JSON representation.
+     */
     serialize(): any;
+    /**
+     * Hazard for flashing.
+     */
     static readonly FLASHING: Hazard;
+    /**
+     * Hazard for no flashing hazard.
+     */
     static readonly NO_FLASHING_HAZARD: Hazard;
+    /**
+     * Hazard for unknown flashing hazard.
+     */
     static readonly UNKNOWN_FLASHING_HAZARD: Hazard;
+    /**
+     * Hazard for motion simulation.
+     */
     static readonly MOTION_SIMULATION: Hazard;
+    /**
+     * Hazard for no motion simulation hazard.
+     */
     static readonly NO_MOTION_SIMULATION_HAZARD: Hazard;
+    /**
+     * Hazard for unknown motion simulation hazard.
+     */
     static readonly UNKNOWN_MOTION_SIMULATION_HAZARD: Hazard;
+    /**
+     * Hazard for sound.
+     */
     static readonly SOUND: Hazard;
+    /**
+     * Hazard for no sound hazard.
+     */
     static readonly NO_SOUND_HAZARD: Hazard;
+    /**
+     * Hazard for unknown sound hazard.
+     */
     static readonly UNKNOWN_SOUND_HAZARD: Hazard;
+    /**
+     * Hazard for unknown hazard.
+     */
     static readonly UNKNOWN: Hazard;
+    /**
+     * Hazard for no hazard.
+     */
     static readonly NONE: Hazard;
 }
 export declare class Exemption {
     readonly value: string;
     constructor(value: string);
+    /**
+     * Parses an [Exemption] from its RWPM JSON representation.
+     */
     static deserialize(json: any): Exemption | undefined;
+    /**
+     * Serializes an [Exemption] to its RWPM JSON representation.
+     */
     serialize(): any;
+    /**
+     * None exemption.
+     */
     static readonly NONE: Exemption;
+    /**
+     * Documented exemption.
+     */
     static readonly DOCUMENTED: Exemption;
+    /**
+     * Legal exemption.
+     */
     static readonly LEGAL: Exemption;
+    /**
+     * Temporary exemption.
+     */
     static readonly TEMPORARY: Exemption;
+    /**
+     * Technical exemption.
+     */
     static readonly TECHNICAL: Exemption;
+    /**
+     * EAA disproportionate burden exemption.
+     */
     static readonly EAA_DISPROPORTIONATE_BURDEN: Exemption;
+    /**
+     * EAA fundamental alteration exemption.
+     */
     static readonly EAA_FUNDAMENTAL_ALTERATION: Exemption;
+    /**
+     * EAA microenterprise exemption.
+     */
     static readonly EAA_MICROENTERPRISE: Exemption;
+    /**
+     * EAA technical impossibility exemption.
+     */
     static readonly EAA_TECHNICAL_IMPOSSIBILITY: Exemption;
+    /**
+     * EAA temporary exemption.
+     */
     static readonly EAA_TEMPORARY: Exemption;
 }

package/types/src/publication/accessibility/AccessibilityMetadataDisplayGuide.d.ts

@@ -1,13 +1,12 @@
 import { Publication } from '../Publication';
-import { AccessibilityDisplayString } from './AccessibilityDisplayString';
-import { Profile } from './Accessibility';
+import { AccessibilityProfile } from './Accessibility';
 /**
  * Represents a single accessibility claim
  */
 export interface AccessibilityDisplayStatement {
     id: string;
-    displayId: AccessibilityDisplayString;
-    values?: any[];
+    compactString?: string;
+    descriptiveString?: string;
 }
 /**
 * Represents a collection of related accessibility claims which should be
@@ -51,8 +50,8 @@ export declare enum PrerecordedAudio {
  * access.
  */
 export declare class WaysOfReading implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.WaysOfReadingTitle;
-    readonly title = "Ways of Reading";
+    readonly id = "ways-of-reading.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
     readonly visualAdjustments: VisualAdjustments;
     readonly nonvisualReading: NonvisualReading;
@@ -66,8 +65,8 @@ export declare class WaysOfReading implements AccessibilityDisplayField {
  * Navigation features of the content
  */
 export declare class Navigation implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.NavigationTitle;
-    readonly title = "Navigation";
+    readonly id = "navigation.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
     readonly noMetadata: boolean;
     readonly tableOfContents: boolean;
@@ -95,8 +94,8 @@ export declare enum RichContentType {
  * Rich content features of the content
  */
 export declare class RichContent implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.RichContentTitle;
-    readonly title = "Rich Content";
+    readonly id = "rich-content.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
     readonly noMetadata: boolean;
     readonly extendedAltTextDescriptions: boolean;
@@ -116,8 +115,8 @@ export declare class RichContent implements AccessibilityDisplayField {
  * Represents additional accessibility information
  */
 export declare class AdditionalInformation implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.AdditionalInformationTitle;
-    readonly title = "Additional Information";
+    readonly id = "additional-accessibility-information.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
     readonly noMetadata: boolean;
     readonly pageBreakMarkers: boolean;
@@ -147,8 +146,8 @@ export declare enum HazardType {
  * Represents potential hazards in the content
  */
 export declare class Hazards implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.HazardsTitle;
-    readonly title = "Hazards";
+    readonly id = "hazards.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
     readonly noMetadata: boolean;
     readonly noHazards: boolean;
@@ -164,22 +163,21 @@ export declare class Hazards implements AccessibilityDisplayField {
 * Represents conformance to accessibility standards
 */
 export declare class Conformance implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.ConformanceTitle;
-    readonly title = "Conformance";
+    readonly id = "conformance.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
-    readonly profiles: Profile[];
+    readonly profiles: AccessibilityProfile[];
     readonly statements: AccessibilityDisplayStatement[];
     private constructor();
     static fromPublication(publication: Publication): Conformance;
 }
 /**
-* Represents legal exemptions
-*/
+ * Represents legal exemptions
+ */
 export declare class Legal implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.LegalTitle;
-    readonly title = "Legal";
+    readonly id = "legal-considerations.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
-    readonly noMetadata: boolean;
     readonly exemption: boolean;
     readonly statements: AccessibilityDisplayStatement[];
     private constructor();
@@ -189,10 +187,9 @@ export declare class Legal implements AccessibilityDisplayField {
 * Represents the accessibility summary
 */
 export declare class AccessibilitySummary implements AccessibilityDisplayField {
-    readonly id = AccessibilityDisplayString.AccessibilitySummaryTitle;
-    readonly title = "Accessibility Summary";
+    readonly id = "accessibility-summary.title";
+    readonly title: string;
     readonly shouldDisplay: boolean;
-    readonly hasSummary: boolean;
     readonly statements: AccessibilityDisplayStatement[];
     private constructor();
     static fromPublication(publication: Publication): AccessibilitySummary;

package/types/src/publication/accessibility/Localization.d.ts

@@ -0,0 +1,45 @@
+export interface L10nString {
+    compact: string;
+    descriptive: string;
+}
+type LocaleData = Record<string, any>;
+declare class LocalizationImpl {
+    private static instance;
+    private currentLocaleCode;
+    private locale;
+    private availableLocales;
+    private constructor();
+    static getInstance(): LocalizationImpl;
+    /**
+     * Registers a new locale or updates an existing one
+     * @param localeCode BCP 47 language code (e.g., 'en', 'fr-FR')
+     * @param localeData The locale data to register
+     */
+    registerLocale(localeCode: string, localeData: LocaleData): void;
+    /**
+     * Sets the current locale by language code
+     * @param localeCode BCP 47 language code (e.g., 'en', 'fr-FR')
+     * @returns boolean indicating if the locale was set successfully
+     */
+    setLocale(localeCode: string): boolean;
+    /**
+     * Gets the current locale code (BCP 47)
+     */
+    getCurrentLocale(): string;
+    /**
+     * Gets a list of available locale codes
+     */
+    getAvailableLocales(): string[];
+    private getNestedValue;
+    /**
+     * Gets a localized string by key
+     * @param key The key for the string to retrieve
+     * @returns The localized string as a [L10nString], or an empty string if not found
+     */
+    getString(key: string): L10nString;
+}
+/**
+ * The singleton instance of the [Localization] class.
+ */
+export declare const Localization: LocalizationImpl;
+export {};

package/types/src/publication/accessibility/index.d.ts

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