@nypl/web-reader 4.3.0 → 4.3.2

package/dist/types/HtmlReader/effects.d.ts

@@ -1,22 +0,0 @@
-import { ReaderSettings, WebpubManifest } from '../types';
-/**
- * These are effects that reach in to the iframe element and modify it.
- * They are not part of the reducer, and should only be called from within a
- * useEffect hook.
- */
-/**
- * Scroll the HTML element to a given progression by
- * setting the scrollTop or the scrollLeft.
- */
-export declare function navigateToProgression(iframe: HTMLIFrameElement, progression: number, isScrolling: boolean): void;
-export declare function navigateToHash(fragment: string, iframe: HTMLIFrameElement, isScrolling: boolean): void;
-/**
- * Takes the HTML element and sets CSS variables on it based on the
- * reader's state
- */
-export declare function setCss(iframeHtml: Document, settings: ReaderSettings, iframeContainer: HTMLElement | null, manifest: WebpubManifest | undefined): void;
-export declare function setReflowableCss(iframeHtml: HTMLElement, settings: ReaderSettings): void;
-/**
- * Apply the transform property to the iframe document to fit the current screen viewport.
- */
-export declare function setFixedCss(iframeDocument: Document, iframeContainer: HTMLElement | null): void;

package/dist/types/HtmlReader/index.d.ts

@@ -1,3 +0,0 @@
-import { ReaderReturn, ReaderArguments } from '../types';
-export declare const IFRAME_ID_SELECTOR = "html-reader-iframe";
-export default function useHtmlReader(args: ReaderArguments): ReaderReturn;

package/dist/types/HtmlReader/lib.d.ts

@@ -1,107 +0,0 @@
-import { Injectable } from '../Readium/Injectable';
-import { Locator } from '../Readium/Locator';
-import { WebpubManifest, ColorMode, FontFamily } from '../types';
-import { ReadiumLink } from '../WebpubManifestTypes/ReadiumLink';
-import { ActiveState } from './types';
-/**
- * Constants
- */
-export declare const FONT_SIZE_STEP = 4;
-export declare const defaultInjectables: Injectable[];
-export declare const defaultInjectablesFixed: Injectable[];
-/**
- * Creates an element for an injectable so it can be injected into the iframe.
- */
-export declare function makeInjectableElement(document: Document, injectable: Injectable): HTMLElement | undefined;
-/**
- * gets the index of the current location href
- */
-export declare function getCurrentIndex(manifest: WebpubManifest, state: ActiveState, baseUrl: string): number;
-/**
- * Find a link in the reading order from a passed in href.
- */
-export declare function getFromReadingOrder(href: string, manifest: WebpubManifest, baseUrl: string): {
-    link: ReadiumLink;
-    index: number;
-} | undefined;
-/**
- * Check if two hrefs share the same pathname. They can be absolute
- * or relative. This will ignore hash and query params.
- */
-export declare function isSameResource(href1: string, href2: string, baseUrl: string): boolean;
-/**
- * Converts a ReadiumLink to a Locator
- */
-export declare function linkToLocator(link: ReadiumLink, baseUrl: string, locations?: Locator['locations']): Locator;
-declare type CalculatedPosition = {
-    isHorizontalPaginated: boolean;
-    containerSize: number;
-    containerWidth: number;
-    containerHeight: number;
-    pageSize: number;
-    resourceSize: number;
-    scrollPosition: number;
-    totalPages: number;
-    progression: number;
-    currentPage: number;
-    currentPageFloor: number;
-    isAtEnd: boolean;
-    isAtStart: boolean;
-};
-/**
- * Calculate current position information
- */
-export declare function calcPosition(iframe: HTMLIFrameElement, isScrolling: boolean): CalculatedPosition;
-/**
- * Gets scroll position of an element
- */
-export declare function getScrollPosition(element: HTMLElement | undefined | null): {
-    x: number;
-    y: number;
-};
-/**
- * Fetches a resource as text
- */
-export declare function fetchAsTxt(url: string): Promise<string>;
-/**
- * Inject some raw JS into the iframe document
- */
-export declare function injectJS(document: Document): void;
-export declare function getMaybeIframeHtml(iframe: HTMLIFrameElement): HTMLElement | undefined;
-/**
- * Get the HTML element of the iframe
- */
-export declare function getIframeHTML(iframe: HTMLIFrameElement): HTMLElement;
-/**
- * Sets a CSS var on the html element in the iframe. Used to set
- * ReadiumCSS settings like scrolling and color mode and font
- * size.
- */
-export declare function setCSSProperty(html: HTMLElement, name: string, val: string): void;
-/**
- * Translates the readium scroll css var into a boolean
- */
-export declare function getPagination(isPaginated: boolean): 'readium-scroll-on' | 'readium-scroll-off';
-/**
- * Translates the internal color mode value into a Readium
- * color mode value.
- */
-export declare function getColorModeValue(mode: ColorMode): 'readium-default-on' | 'readium-night-on' | 'readium-sepia-on';
-/**
- * Translates the readium color mode value into an internal
- * color mode value
- */
-export declare function getColorMode(d2Mode: string): ColorMode;
-/**
- * Gets the Readium font-override setting based on the given font family.
- */
-export declare function getFontOverride(fontFamily: FontFamily): 'readium-font-off' | 'readium-font-on';
-/**
- * Translates the internal font family to a readium css font family value.
- */
-export declare const familyToReadiumFamily: Record<FontFamily, string>;
-/**
- * Translates a readium css font family to an internal font family.
- */
-export declare const r2FamilyToFamily: Record<string, FontFamily | undefined>;
-export {};

package/dist/types/HtmlReader/reducer.d.ts

@@ -1,8 +0,0 @@
-import { ReaderArguments } from '../types';
-import { HtmlAction, HtmlState, InactiveState } from './types';
-/**
- * A higher order function that makes it easy to access arguments in the reducer
- * without passing them in to every `dispatch` call.
- */
-export default function makeHtmlReducer(args: ReaderArguments): (state: HtmlState, action: HtmlAction) => HtmlState;
-export declare const inactiveState: InactiveState;

package/dist/types/HtmlReader/types.d.ts

@@ -1,116 +0,0 @@
-import { Locator } from '../Readium/Locator';
-import { ColorMode, FontFamily, ReaderArguments, ReaderSettings, ReaderState } from '../types';
-/**
- * Html Reader States
- *  - Can be broken into distinct states that we create a union from.
- *    This helps us avoid invalid states.
- *  - We include a `state` property so that it is easy to narrow the type
- *    of a given HtmlState to a specific state in the union.
- */
-export declare type HtmlState = InactiveState | ActiveState;
-export declare type ActiveState = FetchingResourceState | ResourceFetchErrorState | RenderingIframeState | LoadingIframeState | NavigatingState | ReadyState;
-export declare type InactiveState = ReaderState & {
-    state: 'INACTIVE';
-    location: undefined;
-    iframe: null;
-    resource: undefined;
-    resourceFetchError: undefined;
-};
-export declare type FetchingResourceState = ReaderState & {
-    state: 'FETCHING_RESOURCE';
-    location: Locator;
-    iframe: null;
-    resource: undefined;
-    resourceFetchError: undefined;
-    settings: ReaderSettings;
-};
-export declare type ResourceFetchErrorState = ReaderState & {
-    state: 'RESOURCE_FETCH_ERROR';
-    location: Locator;
-    iframe: null;
-    resource: undefined;
-    resourceFetchError: Error;
-    settings: ReaderSettings;
-};
-export declare type RenderingIframeState = ReaderState & {
-    state: 'RENDERING_IFRAME';
-    location: Locator;
-    iframe: null;
-    resource: string;
-    resourceFetchError: undefined;
-    settings: ReaderSettings;
-};
-export declare type LoadingIframeState = ReaderState & {
-    state: 'LOADING_IFRAME';
-    location: Locator;
-    iframe: HTMLIFrameElement;
-    resource: string;
-    resourceFetchError: undefined;
-    settings: ReaderSettings;
-};
-export declare type NavigatingState = ReaderState & {
-    state: 'NAVIGATING';
-    location: Locator;
-    iframe: HTMLIFrameElement;
-    resource: string;
-    resourceFetchError: undefined;
-    settings: ReaderSettings;
-};
-export declare type ReadyState = ReaderState & {
-    state: 'READY';
-    location: Locator;
-    iframe: HTMLIFrameElement;
-    resource: string;
-    resourceFetchError: undefined;
-    settings: ReaderSettings;
-};
-export declare type HtmlAction = {
-    type: 'ARGS_CHANGED';
-    args: ReaderArguments;
-} | {
-    type: 'IFRAME_LOADED';
-} | {
-    type: 'NAV_PREVIOUS_RESOURCE';
-} | {
-    type: 'NAV_NEXT_RESOURCE';
-} | {
-    type: 'GO_TO_HREF';
-    href: string;
-} | {
-    type: 'GO_TO_LOCATION';
-    location: Locator;
-} | {
-    type: 'GO_FORWARD';
-} | {
-    type: 'GO_BACKWARD';
-} | {
-    type: 'WINDOW_RESIZED';
-} | {
-    type: 'NAV_COMPLETE';
-} | {
-    type: 'SET_COLOR_MODE';
-    mode: ColorMode;
-} | {
-    type: 'SET_SCROLL';
-    isScrolling: boolean;
-} | {
-    type: 'INCREASE_FONT_SIZE';
-} | {
-    type: 'DECREASE_FONT_SIZE';
-} | {
-    type: 'RESET_SETTINGS';
-} | {
-    type: 'SET_FONT_FAMILY';
-    family: FontFamily;
-} | {
-    type: 'USER_SCROLLED';
-} | {
-    type: 'SET_IFRAME';
-    iframe: HTMLIFrameElement | null;
-} | {
-    type: 'RESOURCE_FETCH_SUCCESS';
-    resource: string;
-} | {
-    type: 'RESOURCE_FETCH_ERROR';
-    error: Error;
-};

package/dist/types/HtmlReader/useIframeLinkClick.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { WebpubManifest } from '../WebpubManifestTypes/WebpubManifest';
-import { HtmlAction } from './types';
-export default function useIframeLinkClick(baseUrl: string | undefined, manifest: WebpubManifest | undefined, dispatch: React.Dispatch<HtmlAction>): void;

package/dist/types/HtmlReader/useLocationQuery.d.ts

@@ -1,8 +0,0 @@
-import { Locator } from '../Readium/Locator';
-import { HtmlState } from './types';
-/**
- * Keep the Location state in the browser's url bar.
- * Dispatch location changed when the url changes.
- */
-export default function useLocationQuery(state: HtmlState): void;
-export declare function getLocationQuery(): Locator | undefined;

package/dist/types/HtmlReader/useResource.d.ts

@@ -1,14 +0,0 @@
-import React from 'react';
-import { Injectable } from '../Readium/Injectable';
-import { WebpubManifest } from '../types';
-import { HtmlState, HtmlAction } from './types';
-/**
- * Fetches a resource whenever the url changes and dispatches
- * actions to keep the reducer up to date. Works similar to
- * useSWR, but storing the resource in the reducer state, not
- * separately.
- *
- * Also performs some modifications on the resource to add initial
- * css variables and injectables.
- */
-export default function useResource(manifest: WebpubManifest | undefined, state: HtmlState, getContent: (url: string) => Promise<string>, injectables: Injectable[], dispatch: React.Dispatch<HtmlAction>): void;

package/dist/types/HtmlReader/useUpdateCSS.d.ts

@@ -1,6 +0,0 @@
-import { WebpubManifest } from '../types';
-import { HtmlState } from './types';
-/**
- * Set CSS variables when user state changes
- */
-export default function useUpdateCSS(state: HtmlState, manifest: WebpubManifest | undefined): void;

package/dist/types/HtmlReader/useUpdateScroll.d.ts

@@ -1,6 +0,0 @@
-import * as React from 'react';
-import { HtmlAction, HtmlState } from './types';
-/**
- * Dispatch a USER_SCROLLED event after some delay
- */
-export declare function useUpdateScroll(state: HtmlState, dispatch: React.Dispatch<HtmlAction>): void;

package/dist/types/HtmlReader/useWindowResize.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import { WebpubManifest } from '../types';
-import { HtmlAction, HtmlState } from './types';
-/**
- * Simply dispatches an action when the window is resized.
- */
-export default function useWindowResize(manifest: WebpubManifest | undefined, state: HtmlState, dispatch: React.Dispatch<HtmlAction>): void;

package/dist/types/PdfReader/ChakraPage.d.ts

@@ -1,3 +0,0 @@
-import { Page } from 'react-pdf';
-declare const ChakraPage: import("@chakra-ui/react").ChakraComponent<typeof Page, {}>;
-export default ChakraPage;

package/dist/types/PdfReader/ScrollPage.d.ts

@@ -1,12 +0,0 @@
-import { FC } from 'react';
-import { PageProps } from 'react-pdf';
-declare type ScrollPageProps = {
-    pageNumber: number;
-    width: number | undefined;
-    scale: number;
-    onLoadSuccess: (page: PageProps) => void;
-    placeholderHeight: number;
-    placeholderWidth: number;
-};
-declare const ScrollPage: FC<ScrollPageProps>;
-export default ScrollPage;

package/dist/types/PdfReader/addTocToManifest.d.ts

@@ -1,10 +0,0 @@
-import { WebpubManifest } from '../types';
-/**
- * Adds TOC data to Webpub Manifest from single-resource PDF using PDF.js
- * @param manifest
- * @param getResource - a function to get the resource. This allows the caller
- * to decide how to get the resource, for example through a proxy if necessary.
- * @param pdfWorkerSrc - the path to the pdfjs worker file. Necessary to use pdfjs.
- * @returns {WebpubManifest} manifest object
- */
-export default function addTocToManifest(manifest: WebpubManifest, getResource: (url: string) => Promise<Uint8Array>, pdfWorkerSrc: string): Promise<WebpubManifest>;

package/dist/types/PdfReader/index.d.ts

@@ -1,12 +0,0 @@
-import { ReaderArguments, ReaderReturn } from '../types';
-import 'react-pdf/dist/esm/Page/AnnotationLayer.css';
-/**
- * The PDF reader
- *
- * The PDF reader loads resources in two stages:  First, it fetches the PDF resource as an Uint8Array
- * Then, it passes this array into the <Document> object, which loads the PDF inside an iframe
- *
- * @param args T
- * @returns
- */
-export default function usePdfReader(args: ReaderArguments): ReaderReturn;

package/dist/types/PdfReader/lib.d.ts

@@ -1,26 +0,0 @@
-import { WebpubManifest } from '../types';
-import { ReadiumLink } from '../WebpubManifestTypes/ReadiumLink';
-export declare const IFRAME_WRAPPER_ID = "iframe-wrapper";
-export declare const SCALE_STEP = 0.1;
-export declare const START_QUERY = "start";
-export declare const getResourceUrl: (index: number, readingOrder: ReadiumLink[] | undefined) => string;
-export declare const loadResource: (resourceUrl: string, proxyUrl?: string | undefined) => Promise<Uint8Array>;
-/**
- * Gets the index of the provided href in the readingOrder, or throws an error if one
- * is not found.
- */
-export declare function getIndexFromHref(href: string, manifest: WebpubManifest): number;
-/**
- * Compares two hrefs without query params or hash
- */
-export declare function doHrefsMatch(href1: string | URL, href2: string | URL): boolean;
-/**
- * Extracts a start page from a href if it exists and is in the format
- * `?startPage=1`. Returns undefined if none found.
- */
-export declare const getStartPageFromHref: (href: string) => number | undefined;
-/**
- * Extracts a page number from a href if it exists and is in
- * the format of `#page=1`
- */
-export declare const getPageNumberFromHref: (href: string) => number | undefined;

package/dist/types/PdfReader/reducer.d.ts

@@ -1,3 +0,0 @@
-import { ReaderArguments } from '../types';
-import { PdfState, PdfReaderAction } from './types';
-export declare function makePdfReducer(args: ReaderArguments): (state: PdfState, action: PdfReaderAction) => PdfState;

package/dist/types/PdfReader/types.d.ts

@@ -1,61 +0,0 @@
-import { ReaderArguments, ReaderSettings, ReaderState } from '../types';
-export declare type InternalState = {
-    resourceIndex: number;
-    resource: {
-        data: Uint8Array;
-    } | null;
-    numPages: number | null;
-    pageNumber: number;
-    scale: number;
-    pdfHeight: number;
-    pdfWidth: number;
-    pageHeight: number | undefined;
-    pageWidth: number | undefined;
-    rendered: boolean;
-};
-export declare type InactiveState = ReaderState & InternalState & {
-    state: 'INACTIVE';
-    settings: undefined;
-};
-export declare type ActiveState = ReaderState & InternalState & {
-    state: 'ACTIVE';
-    settings: ReaderSettings;
-};
-export declare type PdfState = InactiveState | ActiveState;
-export declare type PdfReaderAction = {
-    type: 'ARGS_CHANGED';
-    args: ReaderArguments;
-} | {
-    type: 'GO_FORWARD';
-} | {
-    type: 'GO_BACKWARD';
-} | {
-    type: 'GO_TO_HREF';
-    href: string;
-} | {
-    type: 'RESOURCE_FETCH_SUCCESS';
-    resource: {
-        data: Uint8Array;
-    };
-} | {
-    type: 'PDF_PARSED';
-    numPages: number;
-} | {
-    type: 'SET_SCALE';
-    scale: number;
-} | {
-    type: 'SET_SCROLL';
-    isScrolling: boolean;
-} | {
-    type: 'PAGE_LOAD_SUCCESS';
-    height: number;
-    width: number;
-} | {
-    type: 'RESIZE_PAGE';
-    height: number | undefined;
-    width: number | undefined;
-} | {
-    type: 'BOOK_BOUNDARY_CHANGED';
-    atStart: boolean;
-    atEnd: boolean;
-};

package/dist/types/PdfReader/useMeasure.d.ts

@@ -1,7 +0,0 @@
-export declare type Dimensions = Pick<DOMRectReadOnly, 'x' | 'y' | 'top' | 'left' | 'right' | 'bottom' | 'height' | 'width'>;
-export declare type UseMeasureRef<E extends Element = Element> = (element: E) => void;
-export declare type UseMeasureResult<E extends Element = Element> = [
-    UseMeasureRef<E> | null,
-    Dimensions
-];
-export default function useMeasure<E extends Element = Element>(): UseMeasureResult<E>;

package/dist/types/Readium/Injectable.d.ts

@@ -1,11 +0,0 @@
-export interface Injectable {
-    type: string;
-    url?: string;
-    r2after?: boolean;
-    r2before?: boolean;
-    r2default?: boolean;
-    fontFamily?: string;
-    systemFont?: boolean;
-    appearance?: string;
-    async?: boolean;
-}

package/dist/types/Readium/Locator.d.ts

@@ -1,20 +0,0 @@
-export interface Locator {
-    href: string;
-    type?: string;
-    title?: string;
-    locations: Locations;
-    text?: LocatorText;
-}
-export interface LocatorText {
-    after?: string;
-    before?: string;
-    highlight?: string;
-}
-export interface Locations {
-    fragment?: string;
-    progression?: number;
-    position?: number;
-    totalProgression?: number;
-    remainingPositions?: number;
-    totalRemainingPositions?: number;
-}

package/dist/types/WebpubManifestTypes/ConformsTo.d.ts

@@ -1,3 +0,0 @@
-export declare const WebpubPdfConformsTo = "http://librarysimplified.org/terms/profiles/pdf";
-export declare const EpubConformsTo = "https://readium.org/webpub-manifest/profiles/epub";
-export declare type ConformsTo = typeof WebpubPdfConformsTo | typeof EpubConformsTo;

package/dist/types/WebpubManifestTypes/Contributor.d.ts

@@ -1,17 +0,0 @@
-import { ReadiumLink } from './ReadiumLink';
-export interface ContributorObject {
-    name: string | {
-        /**
-         * This interface was referenced by `undefined`'s JSON-Schema definition
-         * via the `patternProperty` "^((?<grandfathered>(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?<language>([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?<script>[A-Za-z]{4}))?(-(?<region>[A-Za-z]{2}|[0-9]{3}))?(-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?<extension>[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?<privateUse>x(-[A-Za-z0-9]{1,8})+))?)|(?<privateUse2>x(-[A-Za-z0-9]{1,8})+))$".
-         */
-        [k: string]: string;
-    };
-    identifier?: string;
-    sortAs?: string;
-    role?: string | string[];
-    position?: number;
-    links?: ReadiumLink[];
-    [k: string]: unknown;
-}
-export declare type Contributor = string | (string | ContributorObject)[] | ContributorObject;

package/dist/types/WebpubManifestTypes/EpubExtension.d.ts

@@ -1,47 +0,0 @@
-export interface EPUBExtensionLinkProperties {
-    /**
-     * Identifies content contained in the linked resource, that cannot be strictly identified using a media type.
-     */
-    contains?: ('mathml' | 'onix' | 'remote-resources' | 'js' | 'svg' | 'xmp')[];
-    /**
-     * Hints how the layout of the resource should be presented
-     */
-    layout?: 'fixed' | 'reflowable';
-    /**
-     * Indicates that a resource is encrypted/obfuscated and provides relevant information for decryption
-     */
-    encrypted?: {
-        /**
-         * Identifies the algorithm used to encrypt the resource
-         */
-        algorithm: string;
-        /**
-         * Compression method used on the resource
-         */
-        compression?: string;
-        /**
-         * Original length of the resource in bytes before compression and/or encryption
-         */
-        originalLength?: number;
-        /**
-         * Identifies the encryption profile used to encrypt the resource
-         */
-        profile?: string;
-        /**
-         * Identifies the encryption scheme used to encrypt the resource
-         */
-        scheme?: string;
-        [k: string]: unknown;
-    };
-    [k: string]: unknown;
-}
-export interface EPUBExtensionMetadata {
-    presentation?: {
-        /**
-         * Hints how the layout of the resource should be presented
-         */
-        layout?: 'fixed' | 'reflowable';
-        [k: string]: unknown;
-    };
-    [k: string]: unknown;
-}

package/dist/types/WebpubManifestTypes/LanguageMap.d.ts

@@ -1,3 +0,0 @@
-export declare type LanguageMap = string | {
-    [k: string]: string;
-};

package/dist/types/WebpubManifestTypes/Metadata.d.ts

@@ -1,47 +0,0 @@
-import { ConformsTo } from './ConformsTo';
-import { Contributor } from './Contributor';
-import { EPUBExtensionMetadata } from './EpubExtension';
-import { LanguageMap } from './LanguageMap';
-import { Subject } from './Subject';
-export interface Metadata extends Contributors, EPUBExtensionMetadata {
-    identifier?: string;
-    '@type'?: string;
-    conformsTo?: ConformsTo;
-    title: LanguageMap;
-    subtitle?: LanguageMap;
-    modified?: string;
-    published?: {
-        [k: string]: unknown;
-    } & string;
-    /**
-     * The language must be a valid BCP 47 tag.
-     */
-    language?: string | string[];
-    sortAs?: LanguageMap;
-    subject?: Subject;
-    readingProgression?: 'rtl' | 'ltr' | 'ttb' | 'btt' | 'auto';
-    description?: string;
-    duration?: number;
-    numberOfPages?: number;
-    belongsTo?: {
-        collection?: Contributor;
-        series?: Contributor;
-        [k: string]: unknown;
-    };
-    [k: string]: unknown;
-}
-export interface Contributors {
-    author?: Contributor;
-    translator?: Contributor;
-    editor?: Contributor;
-    artist?: Contributor;
-    illustrator?: Contributor;
-    letterer?: Contributor;
-    penciler?: Contributor;
-    colorist?: Contributor;
-    inker?: Contributor;
-    narrator?: Contributor;
-    contributor?: Contributor;
-    publisher?: Contributor;
-    imprint?: Contributor;
-}