@readium/shared 1.3.0 → 2.0.0

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

@@ -2,8 +2,8 @@ export * from './encryption';
 export * from './epub';
 export * from './html';
 export * from './opds';
-export * from './presentation';
 export * from './services';
+export * from './AltIdentifier';
 export * from './BelongsTo';
 export * from './Contributor';
 export * from './Link';
@@ -12,9 +12,12 @@ 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';

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

@@ -7,5 +7,5 @@ export declare function datefromJSON(json: any): Date | undefined;
 export declare function numberfromJSON(json: any): number | undefined;
 /** Parses a numeric value, but returns undefined if it is not a positive number. */
 export declare function positiveNumberfromJSON(json: any): number | undefined;
-/** Converts a Set of a string to a string Array object */
-export declare function setToArray(obj: Set<string>): Array<string>;
+/** Converts a Set to an Array object */
+export declare function setToArray(obj: Set<any>): Array<any>;

package/src/publication/epub/EPUBLayout.ts

@@ -1,10 +0,0 @@
-/* Copyright 2021 Readium Foundation. All rights reserved.
- * Use of this source code is governed by a BSD-style license,
- * available in the LICENSE file present in the Github repository of the project.
- */
-
-/** Hint about the nature of the layout for the linked resources. */
-export enum EPUBLayout {
-  fixed = 'fixed',
-  reflowable = 'reflowable',
-}

package/src/publication/epub/Presentation.ts

@@ -1,16 +0,0 @@
-import { Link } from '../Link';
-import { Presentation } from '../presentation/Presentation';
-import { EPUBLayout } from './EPUBLayout';
-
-declare module '../presentation/Presentation' {
-  export interface Presentation {
-    layoutOf(link: Link): EPUBLayout;
-  }
-}
-
-/** Determines the layout of the given resource in this publication.
- *  Default layout is reflowable.
- */
-Presentation.prototype.layoutOf = function(link: Link): EPUBLayout {
-  return link.properties?.getLayout() || this.layout || EPUBLayout.reflowable;
-};

package/src/publication/presentation/Metadata.ts

@@ -1,19 +0,0 @@
-import { Metadata } from '../Metadata';
-import { Presentation } from './Presentation';
-
-// Presentation extensions for [Metadata]
-
-declare module '../Metadata' {
-  export interface Metadata {
-    getPresentation(): Presentation | undefined;
-  }
-}
-
-Metadata.prototype.getPresentation = function(): Presentation | undefined {
-  const presentation =
-    this.otherMetadata?.['presentation'] || this.otherMetadata?.['rendition'];
-
-  if (!presentation) return;
-
-  return Presentation.deserialize(presentation);
-};

package/src/publication/presentation/Presentation.ts

@@ -1,155 +0,0 @@
-/* Copyright 2021 Readium Foundation. All rights reserved.
- * Use of this source code is governed by a BSD-style license,
- * available in the LICENSE file present in the Github repository of the project.
- */
-
-import { EPUBLayout } from '../epub/EPUBLayout';
-
-/**
- * Suggested orientation for the device when displaying the linked resource.
- */
-export enum Orientation {
-  auto = 'auto',
-  landscape = 'landscape',
-  portrait = 'portrait',
-}
-
-/**
- * Suggested method for handling overflow while displaying the linked resource.
- */
-export enum Overflow {
-  auto = 'auto',
-  clipped = 'clipped',
-  paginated = 'paginated',
-  scrolled = 'scrolled',
-}
-
-/**
- * Indicates how the linked resource should be displayed in a reading environment that displays
- * synthetic spreads.
- */
-export enum Page {
-  left = 'left',
-  right = 'right',
-  center = 'center',
-}
-
-/**
- * Indicates the condition to be met for the linked resource to be rendered within a synthetic
- * spread.
- */
-export enum Spread {
-  auto = 'auto',
-  both = 'both',
-  none = 'none',
-  landscape = 'landscape',
-}
-
-/**
- * Suggested method for constraining a resource inside the viewport.
- */
-export enum Fit {
-  contain = 'contain',
-  cover = 'cover',
-  width = 'width',
-  height = 'height',
-}
-
-// export interface IPresentationMetadata {
-//   clipped?: boolean;
-//   continuous?: boolean;
-//   fit?: Fit;
-//   orientation?: Orientation;
-//   overflow?: Overflow;
-//   spread?: Spread;
-//   layout?: EpubLayout;
-// }
-
-/** The Presentation Hints extension defines a number of hints for User Agents about the way content
- *  should be presented to the user.
- *
- *  https://readium.org/webpub-manifest/extensions/presentation.html
- *  https://readium.org/webpub-manifest/schema/extensions/presentation/metadata.schema.json
- *
- *  These properties can be undefined to avoid having default values when it doesn't make sense for a
- *  given `Publication`. If a navigator needs a default value when not specified,
- *  `Presentation.defaultX` and `Presentation.X.default` can be used.
- */
-export class Presentation {
-  /** Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped */
-  public clipped?: boolean;
-
-  /** Suggested method for constraining a resource inside the viewport. */
-  public fit?: Fit;
-
-  /** Suggested orientation for the device when displaying the linked resource. */
-  public orientation?: Orientation;
-
-  /** Indicates the condition to be met for the linked resource to be rendered
-   *  within a synthetic spread
-   */
-  public spread?: Spread;
-
-  /** Hint about the nature of the layout for the linked resources (EPUB extension). */
-  public layout?: EPUBLayout;
-
-  /** Indicates how the progression between resources from the [readingOrder] should be handled */
-  public continuous?: boolean;
-
-  /** Indicates if the overflow of linked resources from the `readingOrder` or `resources` should
-   *  be handled using dynamic pagination or scrolling.
-   */
-  public overflow?: Overflow;
-
-  /** Creates a [Presentation]. */
-  constructor(values: {
-    clipped?: boolean;
-    continuous?: boolean;
-    fit?: Fit;
-    orientation?: Orientation;
-    overflow?: Overflow;
-    spread?: Spread;
-    layout?: EPUBLayout;
-  }) {
-    this.clipped = values.clipped;
-    this.fit = values.fit;
-    this.orientation = values.orientation;
-    this.spread = values.spread;
-    this.layout = values.layout;
-    this.continuous = values.continuous;
-    this.overflow = values.overflow;
-  }
-
-  /**
-   * Parses a [Presentation] from its RWPM JSON representation.
-   *
-   */
-  public static deserialize(json: any): Presentation | undefined {
-    if (!json) return;
-
-    return new Presentation({
-      clipped: json.clipped,
-      continuous: json.continuous,
-      fit: json.fit,
-      orientation: json.orientation,
-      overflow: json.overflow,
-      spread: json.spread,
-      layout: json.layout,
-    });
-  }
-
-  /**
-   * Serializes a [Presentation] to its RWPM JSON representation.
-   */
-  public serialize(): any {
-    const json: any = {};
-    if (this.clipped !== undefined) json.clipped = this.clipped;
-    if (this.continuous !== undefined) json.continuous = this.continuous;
-    if (this.fit !== undefined) json.fit = this.fit;
-    if (this.orientation !== undefined) json.orientation = this.orientation;
-    if (this.overflow !== undefined) json.overflow = this.overflow;
-    if (this.spread !== undefined) json.spread = this.spread;
-    if (this.layout !== undefined) json.layout = this.layout;
-    return json;
-  }
-}

package/src/publication/presentation/Properties.ts

@@ -1,70 +0,0 @@
-/* Copyright 2021 Readium Foundation. All rights reserved.
- * Use of this source code is governed by a BSD-style license,
- * available in the LICENSE file present in the Github repository of the project.
- */
-
-// Presentation extensions for link [Properties]
-
-import { Properties } from '../Properties';
-import { Fit, Orientation, Overflow, Page, Spread } from './Presentation';
-
-declare module '../Properties' {
-  export interface Properties {
-    /**
-     * Specifies whether or not the parts of a linked resource that flow out of the viewport are
-     * clipped.
-     */
-    getClipped(): boolean | undefined;
-
-    /**
-     * Suggested method for constraining a resource inside the viewport.
-     */
-    getFit(): Fit | undefined;
-
-    /**
-     * Suggested orientation for the device when displaying the linked resource.
-     */
-    getOrientation(): Orientation | undefined;
-
-    /**
-     * Suggested method for handling overflow while displaying the linked resource.
-     */
-    getOverflow(): Overflow | undefined;
-
-    /**
-     * Indicates how the linked resource should be displayed in a reading environment that displays
-     * synthetic spreads.
-     */
-    getPage(): Page | undefined;
-
-    /**
-     * Indicates the condition to be met for the linked resource to be rendered within a synthetic
-     * spread.
-     */
-    getSpread(): Spread | undefined;
-  }
-}
-
-Properties.prototype.getClipped = function(): boolean | undefined {
-  return this.otherProperties['clipped'];
-};
-
-Properties.prototype.getFit = function(): Fit | undefined {
-  return this.otherProperties['fit'];
-};
-
-Properties.prototype.getOrientation = function(): Orientation | undefined {
-  return this.otherProperties['orientation'];
-};
-
-Properties.prototype.getOverflow = function(): Overflow | undefined {
-  return this.otherProperties['overflow'];
-};
-
-Properties.prototype.getPage = function(): Page | undefined {
-  return this.otherProperties['page'] || undefined;
-};
-
-Properties.prototype.getSpread = function(): Spread | undefined {
-  return this.otherProperties['spread'] || undefined;
-};

package/src/publication/presentation/index.ts

@@ -1,3 +0,0 @@
-export * from './Presentation';
-export * from './Metadata';
-export * from './Properties';

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

@@ -1,56 +0,0 @@
-export declare enum AccessibilityDisplayString {
-    WaysOfReadingTitle = "ways_of_reading_title",
-    WaysOfReadingVisualAdjustmentsModifiable = "ways_of_reading_visual_adjustments_modifiable",
-    WaysOfReadingVisualAdjustmentsUnmodifiable = "ways_of_reading_visual_adjustments_unmodifiable",
-    WaysOfReadingNonvisualReading = "ways_of_reading_nonvisual_reading",
-    WaysOfReadingNonvisualReadingAltText = "ways_of_reading_nonvisual_reading_alt_text",
-    WaysOfReadingPrerecordedAudio = "ways_of_reading_prerecorded_audio",
-    NavigationTitle = "navigation_title",
-    NavigationToc = "navigation_toc",
-    NavigationIndex = "navigation_index",
-    NavigationStructural = "navigation_structural",
-    NavigationPageNavigation = "navigation_page_navigation",
-    NavigationNoMetadata = "navigation_no_metadata",
-    AdditionalInformationTitle = "additional_information_title",
-    AdditionalInformationPageBreaks = "additional_information_page_breaks",
-    AdditionalInformationAria = "additional_information_aria",
-    AdditionalInformationAudioDescriptions = "additional_information_audio_descriptions",
-    AdditionalInformationBraille = "additional_information_braille",
-    AdditionalInformationRubyAnnotations = "additional_information_ruby_annotations",
-    AdditionalInformationFullRubyAnnotations = "additional_information_full_ruby_annotations",
-    AdditionalInformationHighContrastBetweenForegroundAndBackgroundAudio = "additional_information_high_contrast_between_foreground_and_background_audio",
-    AdditionalInformationHighContrastBetweenTextAndBackground = "additional_information_high_contrast_between_text_and_background",
-    AdditionalInformationLargePrint = "additional_information_large_print",
-    AdditionalInformationSignLanguage = "additional_information_sign_language",
-    AdditionalInformationTactileGraphics = "additional_information_tactile_graphics",
-    AdditionalInformationTactileObjects = "additional_information_tactile_objects",
-    AdditionalInformationTextToSpeechHinting = "additional_information_text_to_speech_hinting",
-    RichContentTitle = "rich_content_title",
-    RichContentExtended = "rich_content_extended",
-    RichContentAccessibleMathDescribed = "rich_content_accessible_math_described",
-    RichContentAccessibleMathAsMathml = "rich_content_accessible_math_as_mathml",
-    RichContentAccessibleMathAsLatex = "rich_content_accessible_math_as_latex",
-    RichContentAccessibleChemistryAsMathml = "rich_content_accessible_chemistry_as_mathml",
-    RichContentAccessibleChemistryAsLatex = "rich_content_accessible_chemistry_as_latex",
-    RichContentClosedCaptions = "rich_content_closed_captions",
-    RichContentOpenCaptions = "rich_content_open_captions",
-    RichContentTranscript = "rich_content_transcript",
-    RichContentUnknown = "rich_content_unknown",
-    HazardsTitle = "hazards_title",
-    HazardsMotion = "hazards_motion",
-    HazardsSound = "hazards_sound",
-    HazardsFlashing = "hazards_flashing",
-    ConformanceTitle = "conformance_title",
-    ConformanceNo = "conformance_no",
-    ConformanceA = "conformance_a",
-    ConformanceAa = "conformance_aa",
-    ConformanceAaa = "conformance_aaa",
-    ConformanceUnknownStandard = "conformance_unknown_standard",
-    ConformanceWCAG = "conformance_wcag",
-    ConformanceEPUB = "conformance_epub",
-    LegalTitle = "legal_title",
-    LegalExemption = "legal_exemption",
-    LegalNoMetadata = "legal_no_metadata",
-    AccessibilitySummaryTitle = "accessibility_summary_title",
-    AccessibilitySummary = "accessibility_summary"
-}

package/types/src/publication/epub/EPUBLayout.d.ts

@@ -1,5 +0,0 @@
-/** Hint about the nature of the layout for the linked resources. */
-export declare enum EPUBLayout {
-    fixed = "fixed",
-    reflowable = "reflowable"
-}

package/types/src/publication/epub/Presentation.d.ts

@@ -1,7 +0,0 @@
-import { Link } from '../Link';
-import { EPUBLayout } from './EPUBLayout';
-declare module '../presentation/Presentation' {
-    interface Presentation {
-        layoutOf(link: Link): EPUBLayout;
-    }
-}

package/types/src/publication/presentation/Metadata.d.ts

@@ -1,6 +0,0 @@
-import { Presentation } from './Presentation';
-declare module '../Metadata' {
-    interface Metadata {
-        getPresentation(): Presentation | undefined;
-    }
-}

package/types/src/publication/presentation/Presentation.d.ts

@@ -1,95 +0,0 @@
-import { EPUBLayout } from '../epub/EPUBLayout';
-/**
- * Suggested orientation for the device when displaying the linked resource.
- */
-export declare enum Orientation {
-    auto = "auto",
-    landscape = "landscape",
-    portrait = "portrait"
-}
-/**
- * Suggested method for handling overflow while displaying the linked resource.
- */
-export declare enum Overflow {
-    auto = "auto",
-    clipped = "clipped",
-    paginated = "paginated",
-    scrolled = "scrolled"
-}
-/**
- * Indicates how the linked resource should be displayed in a reading environment that displays
- * synthetic spreads.
- */
-export declare enum Page {
-    left = "left",
-    right = "right",
-    center = "center"
-}
-/**
- * Indicates the condition to be met for the linked resource to be rendered within a synthetic
- * spread.
- */
-export declare enum Spread {
-    auto = "auto",
-    both = "both",
-    none = "none",
-    landscape = "landscape"
-}
-/**
- * Suggested method for constraining a resource inside the viewport.
- */
-export declare enum Fit {
-    contain = "contain",
-    cover = "cover",
-    width = "width",
-    height = "height"
-}
-/** The Presentation Hints extension defines a number of hints for User Agents about the way content
- *  should be presented to the user.
- *
- *  https://readium.org/webpub-manifest/extensions/presentation.html
- *  https://readium.org/webpub-manifest/schema/extensions/presentation/metadata.schema.json
- *
- *  These properties can be undefined to avoid having default values when it doesn't make sense for a
- *  given `Publication`. If a navigator needs a default value when not specified,
- *  `Presentation.defaultX` and `Presentation.X.default` can be used.
- */
-export declare class Presentation {
-    /** Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped */
-    clipped?: boolean;
-    /** Suggested method for constraining a resource inside the viewport. */
-    fit?: Fit;
-    /** Suggested orientation for the device when displaying the linked resource. */
-    orientation?: Orientation;
-    /** Indicates the condition to be met for the linked resource to be rendered
-     *  within a synthetic spread
-     */
-    spread?: Spread;
-    /** Hint about the nature of the layout for the linked resources (EPUB extension). */
-    layout?: EPUBLayout;
-    /** Indicates how the progression between resources from the [readingOrder] should be handled */
-    continuous?: boolean;
-    /** Indicates if the overflow of linked resources from the `readingOrder` or `resources` should
-     *  be handled using dynamic pagination or scrolling.
-     */
-    overflow?: Overflow;
-    /** Creates a [Presentation]. */
-    constructor(values: {
-        clipped?: boolean;
-        continuous?: boolean;
-        fit?: Fit;
-        orientation?: Orientation;
-        overflow?: Overflow;
-        spread?: Spread;
-        layout?: EPUBLayout;
-    });
-    /**
-     * Parses a [Presentation] from its RWPM JSON representation.
-     *
-     */
-    static deserialize(json: any): Presentation | undefined;
-    /**
-     * Serializes a [Presentation] to its RWPM JSON representation.
-     */
-    serialize(): any;
-}

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

@@ -1,32 +0,0 @@
-import { Fit, Orientation, Overflow, Page, Spread } from './Presentation';
-declare module '../Properties' {
-    interface Properties {
-        /**
-         * Specifies whether or not the parts of a linked resource that flow out of the viewport are
-         * clipped.
-         */
-        getClipped(): boolean | undefined;
-        /**
-         * Suggested method for constraining a resource inside the viewport.
-         */
-        getFit(): Fit | undefined;
-        /**
-         * Suggested orientation for the device when displaying the linked resource.
-         */
-        getOrientation(): Orientation | undefined;
-        /**
-         * Suggested method for handling overflow while displaying the linked resource.
-         */
-        getOverflow(): Overflow | undefined;
-        /**
-         * Indicates how the linked resource should be displayed in a reading environment that displays
-         * synthetic spreads.
-         */
-        getPage(): Page | undefined;
-        /**
-         * Indicates the condition to be met for the linked resource to be rendered within a synthetic
-         * spread.
-         */
-        getSpread(): Spread | undefined;
-    }
-}

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

@@ -1,3 +0,0 @@
-export * from './Presentation';
-export * from './Metadata';
-export * from './Properties';