@nypl/web-reader 2.0.0 → 3.1.0

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

@@ -1,4 +1,4 @@
-import { ReaderSettings } from '../types';
+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
@@ -14,4 +14,9 @@ export declare function navigateToHash(fragment: string, iframe: HTMLIFrameEleme
  * Takes the HTML element and sets CSS variables on it based on the
  * reader's state
  */
-export declare function setCss(html: HTMLElement, settings: ReaderSettings): void;
+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,12 +1,10 @@
 import { ReaderReturn, ReaderArguments } from '../types';
+export declare const IFRAME_ID_SELECTOR = "html-reader-iframe";
 /**
  * @TODO :
  *
  * Future:
  *  - provide default injectables (Readium CSS)
- *  - Don't use ReadiumCSS for fixed layout
- *  - Make fixed layout work
- *  - Update to latest Readium CSS
  *  - Find some way to organize effects and actions together so you can navigate, wait for iframe to load,
  *    then run some other effect.
  *  - goForward and goBackward should return a promise that resolves once isNavigated flips to true.

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

@@ -1,5 +1,6 @@
 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
@@ -10,4 +11,4 @@ import { HtmlState, HtmlAction } from './types';
  * Also performs some modifications on the resource to add initial
  * css variables and injectables.
  */
-export default function useResource(state: HtmlState, getContent: (url: string) => Promise<string>, injectables: Injectable[], dispatch: React.Dispatch<HtmlAction>): void;
+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/useWindowResize.d.ts

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

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

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

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

@@ -1,8 +1,9 @@
 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 {
+export interface Metadata extends Contributors, EPUBExtensionMetadata {
     identifier?: string;
     '@type'?: string;
     conformsTo?: ConformsTo;

package/dist/types/constants.d.ts

@@ -7,3 +7,5 @@ export declare const CHROME_HEIGHT: number;
 export declare const DEFAULT_HEIGHT: string;
 export declare const DEFAULT_SHOULD_GROW_WHEN_SCROLLING = true;
 export declare const DEFAULT_SETTINGS: ReaderSettings;
+export declare const LOCAL_STORAGE_SETTINGS_KEY = "web-reader-settings";
+export declare const LOCAL_STORAGE_LOCATIONS_KEY = "web-reader-locations";

package/dist/types/index.d.ts

@@ -14,3 +14,4 @@ export { default as usePdfReader } from './PdfReader';
 export { getTheme } from './ui/theme';
 export { default as useColorModeValue } from './ui/hooks/useColorModeValue';
 export * from './constants';
+export { clearWebReaderLocalStorage } from './utils/localstorage';

package/dist/types/types.d.ts

@@ -76,7 +76,7 @@ export declare type UseWebReaderArguments = {
     proxyUrl?: string;
     getContent?: GetContent;
     pdfWorkerSrc?: string;
-    injectables?: Injectable[];
+    injectablesReflowable?: Injectable[];
     injectablesFixed?: Injectable[];
     /**
      * CSS string to set the height of the reader in paginated mode, and also
@@ -99,6 +99,20 @@ export declare type UseWebReaderArguments = {
      * Initial user settings for the reader
      */
     readerSettings?: Partial<ReaderSettings>;
+    /**
+     * If enabled, reading location will be persisted to local storage and recalled from
+     * there upon initial load.
+     *
+     * Default: `true`
+     */
+    persistLastLocation?: boolean;
+    /**
+     * If enabled, reader settings will be persisted to local storage and recalled
+     * from there upon initial load.
+     *
+     * Default: `true`
+     */
+    persistSettings?: boolean;
 };
 export declare type ActiveReaderArguments = UseWebReaderArguments & {
     manifest: WebpubManifest;

package/dist/types/utils/localstorage.d.ts

@@ -1,10 +1,21 @@
 import { HtmlState } from '../HtmlReader/types';
 import { Locator } from '../Readium/Locator';
-import { ReaderSettings } from '../types';
-export declare type LSLocationRecord = {
+import { ReaderArguments, ReaderSettings } from '../types';
+/**
+ * Use getLocalStorageLocation to get the location when
+ * initializing the reducer. useUpdateLocalStorage will set
+ * values in local storage as they change.
+ *
+ * TODO:
+ *  - PDF Sync
+ *  - how to handle non backwards compatible updates
+ */
+export declare type LSLocation = {
     location: Locator;
     createdAt: number;
 };
-export declare function getLocalStorageLocation(identifier: string): LSLocationRecord | undefined;
-export declare function getLocalStorageSettings(): ReaderSettings | undefined;
-export default function useUpdateLocalStorage(identifier: string | null, state: HtmlState): void;
+export declare type LSLocationsRecord = Record<string, LSLocation>;
+export declare function getLocalStorageLocation(identifier: string, args: ReaderArguments): LSLocation | undefined;
+export declare function getLocalStorageSettings(args: ReaderArguments): ReaderSettings | undefined;
+export default function useUpdateLocalStorage(identifier: string | null, state: HtmlState, args: ReaderArguments): void;
+export declare function clearWebReaderLocalStorage(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nypl/web-reader",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "license": "MIT",
   "repository": "https://github.com/NYPL-Simplified/web-reader",
   "homepage": "https://github.com/NYPL-Simplified/web-reader",