@nypl/web-reader 4.2.0 → 4.3.0

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

@@ -1,15 +1,3 @@
 import { ReaderReturn, ReaderArguments } from '../types';
 export declare const IFRAME_ID_SELECTOR = "html-reader-iframe";
-/**
- * @TODO :
- *
- * Future:
- *  - provide default injectables (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.
- *  - Sync settings to localStorage or something similar.
- *  - Add a way to call a callback when current reading position changes (so OE web can save current position).
- *  - Maybe use history.pushState when navigating via nextPage or previousPage or toc.
- */
 export default function useHtmlReader(args: ReaderArguments): ReaderReturn;

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

@@ -7,11 +7,6 @@ import { ActiveState } from './types';
  * Constants
  */
 export declare const FONT_SIZE_STEP = 4;
-/**
- * If we provide injectables that are not found, the app won't load at all.
- * Therefore we will not provide any default injectables.
- * @todo - this is not true in our custom renderer. We should provide default injectables.
- */
 export declare const defaultInjectables: Injectable[];
 export declare const defaultInjectablesFixed: Injectable[];
 /**

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

@@ -1,7 +1,6 @@
 import { WebpubManifest } from '../types';
 import { HtmlState } from './types';
 /**
- * Set CSS variables when user state changes.
- * @todo - narrow down the dependencies so this doesn't run on _every_ state change.
+ * Set CSS variables when user state changes
  */
 export default function useUpdateCSS(state: HtmlState, manifest: WebpubManifest | undefined): void;

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

@@ -0,0 +1,10 @@
+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,6 +1,5 @@
 import { ReaderArguments, ReaderReturn } from '../types';
 import 'react-pdf/dist/esm/Page/AnnotationLayer.css';
-export declare const SCALE_STEP = 0.1;
 /**
  * The PDF reader
  *

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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,61 @@
+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/index.d.ts

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

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

@@ -1,20 +1,16 @@
 import { HtmlState } from '../HtmlReader/types';
 import { Locator } from '../Readium/Locator';
 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 type LSLocationsRecord = Record<string, LSLocation>;
+/**
+ * Use getLocalStorageLocation to get the location when
+ * initializing the reducer. useUpdateLocalStorage will set
+ * values in local storage as they change.
+ */
 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nypl/web-reader",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "license": "MIT",
   "repository": "https://github.com/NYPL-Simplified/web-reader",
   "homepage": "https://github.com/NYPL-Simplified/web-reader",
@@ -25,8 +25,6 @@
     "example:build": "parcel build",
     "example:nocache": "parcel --no-cache",
     "example": "parcel",
-    "example:https": "parcel --cert localhost.pem --key localhost-key.pem",
-    "example:sw": "ENABLE_SW=true npm run example:https",
     "start": "ts-node -T build.ts -w",
     "build": "ts-node -T build.ts",
     "test": "jest --watch",
@@ -42,8 +40,6 @@
     "prepare": "npm run build && husky install",
     "size": "size-limit",
     "analyze": "size-limit --why",
-    "storybook": "start-storybook -p 6006",
-    "build-storybook": "build-storybook",
     "cors-proxy": "node example/cors-proxy.js",
     "release": "release-it --verbose",
     "release:alpha": "release-it --verbose --preRelease=alpha"
@@ -54,7 +50,7 @@
     "@emotion/styled": "^11.8.1",
     "react": "^16.8.0 || 17.x || 18.x",
     "react-dom": "^16.8.0 || 17.x || 18.x",
-    "swr": "^1.0.1"
+    "swr": "^2.0.3"
   },
   "prettier": {
     "printWidth": 80,
@@ -84,13 +80,6 @@
     "@babel/core": "^7.12.10",
     "@emotion/jest": "^11.8.0",
     "@parcel/transformer-typescript-tsc": "^2.4.1",
-    "@storybook/addon-actions": "^6.5.13",
-    "@storybook/addon-essentials": "^6.4.22",
-    "@storybook/addon-info": "^3.0.0",
-    "@storybook/addon-links": "^6.5.13",
-    "@storybook/addon-storyshots": "^6.1.21",
-    "@storybook/addons": "^6.5.13",
-    "@storybook/react": "^6.1.21",
     "@testing-library/cypress": "^8.0.2",
     "@testing-library/jest-dom": "^5.16.3",
     "@testing-library/react": "^12.0.0",