@nypl/web-reader 0.1.4 → 0.2.0-alpha.3

package/dist/{types.d.ts → types/types.d.ts}

@@ -1,66 +1,66 @@
-/// <reference types="react" />
-import { WebpubManifest } from './WebpubManifestTypes/WebpubManifest';
-export { WebpubManifest };
-export declare const EpubMimeType = "application/epub";
-export declare const WebpubMimeType = "application/webpub";
-export declare type ColorMode = 'night' | 'sepia' | 'day';
-export declare type FontFamily = 'publisher' | 'serif' | 'sans-serif' | 'open-dyslexic';
-export declare type Navigator = {
-    goForward: () => void;
-    goBackward: () => void;
-    setColorMode: (mode: ColorMode) => Promise<void>;
-    setScroll: (val: 'scrolling' | 'paginated') => Promise<void>;
-    increaseFontSize: () => Promise<void>;
-    decreaseFontSize: () => Promise<void>;
-    setFontFamily: (family: FontFamily) => Promise<void>;
-    goToPage: (href: string) => void;
-};
-export declare type PdfNavigator = Navigator;
-export declare type HtmlNavigator = Navigator;
-export declare type ReaderState = {
-    colorMode: ColorMode;
-    isScrolling: boolean;
-    fontSize: number;
-    fontFamily: FontFamily;
-    currentTocUrl: string | null;
-};
-export declare type PdfReaderState = ReaderState;
-export declare type HtmlReaderState = ReaderState;
-export declare type InactiveReader = null;
-export declare type LoadingReader = {
-    isLoading: true;
-    content: JSX.Element;
-    navigator: null;
-    state: null;
-    manifest: null;
-    type: null;
-};
-declare type CommonReader = {
-    isLoading: false;
-    content: JSX.Element;
-    manifest: WebpubManifest;
-};
-export declare type PDFActiveReader = CommonReader & {
-    state: PdfReaderState;
-    navigator: PdfNavigator;
-    type: 'PDF';
-};
-export declare type HTMLActiveReader = CommonReader & {
-    state: HtmlReaderState;
-    navigator: HtmlNavigator;
-    type: 'HTML';
-};
-export declare type ActiveReader = PDFActiveReader | HTMLActiveReader;
-export declare type ReaderReturn = InactiveReader | LoadingReader | ActiveReader;
-export declare type GetContent = (href: string) => Promise<string>;
-export declare type UseWebReaderArguments = {
-    webpubManifestUrl: string;
-    proxyUrl?: string;
-    getContent?: GetContent;
-};
-export declare type ActiveReaderArguments = UseWebReaderArguments & {
-    manifest: WebpubManifest;
-};
-export declare type InactiveReaderArguments = undefined;
-export declare type ReaderArguments = ActiveReaderArguments | InactiveReaderArguments;
-export declare type GetColor = (light: string, dark: string, sepia: string) => string;
+/// <reference types="react" />
+import { WebpubManifest } from './WebpubManifestTypes/WebpubManifest';
+export { WebpubManifest };
+export declare const EpubMimeType = "application/epub";
+export declare const WebpubMimeType = "application/webpub";
+export declare type ColorMode = 'night' | 'sepia' | 'day';
+export declare type FontFamily = 'publisher' | 'serif' | 'sans-serif' | 'open-dyslexic';
+export declare type Navigator = {
+    goForward: () => void;
+    goBackward: () => void;
+    setColorMode: (mode: ColorMode) => Promise<void>;
+    setScroll: (val: 'scrolling' | 'paginated') => Promise<void>;
+    increaseFontSize: () => Promise<void>;
+    decreaseFontSize: () => Promise<void>;
+    setFontFamily: (family: FontFamily) => Promise<void>;
+    goToPage: (href: string) => void;
+};
+export declare type PdfNavigator = Navigator;
+export declare type HtmlNavigator = Navigator;
+export declare type ReaderState = {
+    colorMode: ColorMode;
+    isScrolling: boolean;
+    fontSize: number;
+    fontFamily: FontFamily;
+    currentTocUrl: string | null;
+};
+export declare type PdfReaderState = ReaderState;
+export declare type HtmlReaderState = ReaderState;
+export declare type InactiveReader = null;
+export declare type LoadingReader = {
+    isLoading: true;
+    content: JSX.Element;
+    navigator: null;
+    state: null;
+    manifest: null;
+    type: null;
+};
+declare type CommonReader = {
+    isLoading: false;
+    content: JSX.Element;
+    manifest: WebpubManifest;
+};
+export declare type PDFActiveReader = CommonReader & {
+    state: PdfReaderState;
+    navigator: PdfNavigator;
+    type: 'PDF';
+};
+export declare type HTMLActiveReader = CommonReader & {
+    state: HtmlReaderState;
+    navigator: HtmlNavigator;
+    type: 'HTML';
+};
+export declare type ActiveReader = PDFActiveReader | HTMLActiveReader;
+export declare type ReaderReturn = InactiveReader | LoadingReader | ActiveReader;
+export declare type GetContent = (href: string) => Promise<string>;
+export declare type UseWebReaderArguments = {
+    webpubManifestUrl: string;
+    proxyUrl?: string;
+    getContent?: GetContent;
+};
+export declare type ActiveReaderArguments = UseWebReaderArguments & {
+    manifest: WebpubManifest;
+};
+export declare type InactiveReaderArguments = undefined;
+export declare type ReaderArguments = ActiveReaderArguments | InactiveReaderArguments;
+export declare type GetColor = (light: string, dark: string, sepia: string) => string;

package/dist/{ui → types/ui}/Button.d.ts

@@ -1,7 +1,9 @@
-import React from 'react';
-import { Button as ChakraButton } from '@chakra-ui/react';
-export declare type ButtonProps = React.ComponentPropsWithRef<typeof ChakraButton>;
-declare const Button: React.ForwardRefExoticComponent<Pick<Pick<import("@chakra-ui/react").MergeWithAs<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, any, import("@chakra-ui/react").ButtonProps, React.ElementType<any>>, string | number | symbol> & {
-    ref?: ((instance: HTMLButtonElement | null) => void) | React.RefObject<HTMLButtonElement> | null | undefined;
-}, string | number | symbol> & React.RefAttributes<HTMLButtonElement>>;
-export default Button;
+import React from 'react';
+import { Button as ChakraButton } from '@chakra-ui/react';
+export declare type ButtonProps = React.ComponentPropsWithRef<typeof ChakraButton>;
+declare const Button: React.ForwardRefExoticComponent<Pick<Pick<import("@chakra-ui/react").OmitCommonProps<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, keyof import("@chakra-ui/react").ButtonProps> & import("@chakra-ui/react").ButtonProps & import("@chakra-ui/react").OmitCommonProps<any, keyof import("@chakra-ui/react").ButtonProps> & {
+    as?: import("@chakra-ui/react").As<any> | undefined;
+}, string | number | symbol> & {
+    ref?: ((instance: HTMLButtonElement | null) => void) | React.RefObject<HTMLButtonElement> | null | undefined;
+}, string | number | symbol> & React.RefAttributes<HTMLButtonElement>>;
+export default Button;

package/dist/{ui → types/ui}/Header.d.ts

@@ -1,6 +1,6 @@
-import React from 'react';
-import { ActiveReader } from '../types';
-export declare type HeaderProps = ActiveReader & {
-    headerLeft?: React.ReactNode;
-};
-export default function Header(props: HeaderProps): React.ReactElement;
+import React from 'react';
+import { ActiveReader } from '../types';
+export declare type HeaderProps = ActiveReader & {
+    headerLeft?: React.ReactNode;
+};
+export default function Header(props: HeaderProps): React.ReactElement;

package/dist/{ui → types/ui}/HtmlSettings.d.ts

@@ -1,9 +1,9 @@
-import * as React from 'react';
-import { HtmlNavigator, HtmlReaderState } from '../types';
-declare type HtmlSettingsProps = {
-    navigator: HtmlNavigator;
-    readerState: HtmlReaderState;
-    paginationValue: string;
-};
-export default function HtmlSettings(props: HtmlSettingsProps): React.ReactElement;
-export {};
+import * as React from 'react';
+import { HtmlNavigator, HtmlReaderState } from '../types';
+declare type HtmlSettingsProps = {
+    navigator: HtmlNavigator;
+    readerState: HtmlReaderState;
+    paginationValue: string;
+};
+export default function HtmlSettings(props: HtmlSettingsProps): React.ReactElement;
+export {};

package/dist/{ui → types/ui}/PageButton.d.ts

@@ -1,7 +1,7 @@
-import React from 'react';
-import { Button } from '@chakra-ui/react';
-export declare type PageButtonProps = React.ComponentPropsWithoutRef<typeof Button> & {
-    children: React.ReactNode;
-};
-declare function PageButton(props: React.PropsWithoutRef<PageButtonProps>): React.ReactElement;
-export default PageButton;
+import React from 'react';
+import { Button } from '@chakra-ui/react';
+export declare type PageButtonProps = React.ComponentPropsWithoutRef<typeof Button> & {
+    children: React.ReactNode;
+};
+declare function PageButton(props: React.PropsWithoutRef<PageButtonProps>): React.ReactElement;
+export default PageButton;

package/dist/{ui → types/ui}/PdfSettings.d.ts

@@ -1,9 +1,9 @@
-import * as React from 'react';
-import { PdfNavigator, PdfReaderState } from '../types';
-declare type PdfSettingsProps = {
-    navigator: PdfNavigator;
-    readerState: PdfReaderState;
-    paginationValue: string;
-};
-export default function PdfSettings(props: PdfSettingsProps): React.ReactElement;
-export {};
+import * as React from 'react';
+import { PdfNavigator, PdfReaderState } from '../types';
+declare type PdfSettingsProps = {
+    navigator: PdfNavigator;
+    readerState: PdfReaderState;
+    paginationValue: string;
+};
+export default function PdfSettings(props: PdfSettingsProps): React.ReactElement;
+export {};

package/dist/{ui → types/ui}/SettingsButton.d.ts

@@ -1,5 +1,5 @@
-import * as React from 'react';
-import { PDFActiveReader, HTMLActiveReader } from '../types';
-declare type SettingsCardProps = Pick<PDFActiveReader, 'navigator' | 'state' | 'type'> | Pick<HTMLActiveReader, 'navigator' | 'state' | 'type'>;
-export default function SettingsCard(props: SettingsCardProps): React.ReactElement;
-export {};
+import * as React from 'react';
+import { PDFActiveReader, HTMLActiveReader } from '../types';
+declare type SettingsCardProps = Pick<PDFActiveReader, 'navigator' | 'state' | 'type'> | Pick<HTMLActiveReader, 'navigator' | 'state' | 'type'>;
+export default function SettingsCard(props: SettingsCardProps): React.ReactElement;
+export {};

package/dist/{ui → types/ui}/TableOfContent.d.ts

@@ -1,7 +1,7 @@
-import React from 'react';
-import { Navigator, ReaderState, WebpubManifest } from '../types';
-export default function TableOfContent({ navigator, manifest, readerState, }: {
-    navigator: Navigator;
-    manifest: WebpubManifest;
-    readerState: ReaderState;
-}): React.ReactElement;
+import React from 'react';
+import { Navigator, ReaderState, WebpubManifest } from '../types';
+export default function TableOfContent({ navigator, manifest, readerState, }: {
+    navigator: Navigator;
+    manifest: WebpubManifest;
+    readerState: ReaderState;
+}): React.ReactElement;

package/dist/{ui → types/ui}/ToggleButton.d.ts

@@ -1,10 +1,10 @@
-import React from 'react';
-import { Box as ChakraBox } from '@chakra-ui/react';
-import { ColorMode } from '../types';
-export interface ToggleButtonProps extends React.ComponentPropsWithoutRef<typeof ChakraBox> {
-    isChecked?: false;
-    colorMode?: ColorMode;
-    value: string;
-}
-declare function ToggleButton(props: React.PropsWithoutRef<ToggleButtonProps>): React.ReactElement;
-export default ToggleButton;
+import React from 'react';
+import { Box as ChakraBox } from '@chakra-ui/react';
+import { ColorMode } from '../types';
+export interface ToggleButtonProps extends React.ComponentPropsWithoutRef<typeof ChakraBox> {
+    isChecked?: false;
+    colorMode?: ColorMode;
+    value: string;
+}
+declare function ToggleButton(props: React.PropsWithoutRef<ToggleButtonProps>): React.ReactElement;
+export default ToggleButton;

package/dist/{ui → types/ui}/ToggleGroup.d.ts

@@ -1,8 +1,8 @@
-import React from 'react';
-import { UseRadioGroupProps } from '@chakra-ui/react';
-declare type ToggleGroupProps = Omit<UseRadioGroupProps, 'value' | 'defaultValue'> & {
-    value: string;
-    label: string;
-};
-declare const ToggleGroup: React.FC<ToggleGroupProps>;
-export default ToggleGroup;
+import React from 'react';
+import { UseRadioGroupProps } from '@chakra-ui/react';
+declare type ToggleGroupProps = Omit<UseRadioGroupProps, 'value' | 'defaultValue'> & {
+    value: string;
+    label: string;
+};
+declare const ToggleGroup: React.FC<ToggleGroupProps>;
+export default ToggleGroup;

package/dist/{ui → types/ui}/constants.d.ts

@@ -1 +1 @@
-export declare const HEADER_HEIGHT = 48;
+export declare const HEADER_HEIGHT = 48;

package/dist/{ui → types/ui}/hooks/useColorModeValue.d.ts

@@ -1,7 +1,7 @@
-import { Theme } from '@emotion/react';
-import { ColorMode } from '../../types';
-export interface ColorModeTheme extends Theme {
-    currentColorMode: ColorMode;
-}
-declare const useColorModeValue: (light: string, dark: string, sepia: string) => string;
-export default useColorModeValue;
+import { Theme } from '@emotion/react';
+import { ColorMode } from '../../types';
+export interface ColorModeTheme extends Theme {
+    currentColorMode: ColorMode;
+}
+declare const useColorModeValue: (light: string, dark: string, sepia: string) => string;
+export default useColorModeValue;

package/dist/{ui → types/ui}/hooks/useContainerWidth.d.ts

@@ -1,6 +1,6 @@
-/**
- * Returns the interior width of the container in pixels.
- *
- * @returns {number} Width of the container in pixels
- */
-export default function useContainerWidth(containerId: string): number;
+/**
+ * Returns the interior width of the container in pixels.
+ *
+ * @returns {number} Width of the container in pixels
+ */
+export default function useContainerWidth(containerId: string): number;

package/dist/{ui → types/ui}/hooks/useEventListener.d.ts

@@ -1,8 +1,8 @@
-/**
- * Adds event listener to a given element.
- *
- * @param {HTMLElement} element Element to attach the listener to
- * @param {string} type Event type
- * @param {Function} listener Event listener
- */
-export default function useEventListener(element: HTMLElement | Window, type: string, listener: () => void): void;
+/**
+ * Adds event listener to a given element.
+ *
+ * @param {HTMLElement} element Element to attach the listener to
+ * @param {string} type Event type
+ * @param {Function} listener Event listener
+ */
+export default function useEventListener(element: HTMLElement | Window, type: string, listener: () => void): void;

package/dist/{ui → types/ui}/manager.d.ts

@@ -1,9 +1,9 @@
-import * as React from 'react';
-import { ReaderReturn } from '../types';
-/**
- * The default Manager UI. This will be broken into individual components
- * that can be imported and used separately or in a customized setup.
- * It takes the return value of useWebReader as props
- */
-declare const ManagerUI: React.FC<ReaderReturn>;
-export default ManagerUI;
+import * as React from 'react';
+import { ReaderReturn } from '../types';
+/**
+ * The default Manager UI. This will be broken into individual components
+ * that can be imported and used separately or in a customized setup.
+ * It takes the return value of useWebReader as props
+ */
+declare const ManagerUI: React.FC<ReaderReturn>;
+export default ManagerUI;

package/dist/{ui → types/ui}/nypl-base-theme/components/button.d.ts

@@ -1,94 +1,94 @@
-import { Dict } from '../types';
-declare const ButtonStyle: {
-    baseStyle: {
-        borderRadius: string;
-        fontWeight: string;
-    };
-    sizes: {
-        lg: {
-            h: number;
-            minW: number;
-            fontSize: string;
-            px: number;
-        };
-        md: {
-            h: string;
-            minW: number;
-            fontSize: string;
-            px: number;
-        };
-        sm: {
-            h: number;
-            minW: number;
-            fontSize: string;
-            px: number;
-        };
-        xs: {
-            h: number;
-            minW: number;
-            fontSize: string;
-            px: number;
-        };
-    };
-    variants: {
-        pill: {
-            border: string;
-            borderColor: string;
-            borderRadius: string;
-            height: number;
-            px: number;
-            fontSize: string;
-            my: string;
-        };
-        solid: typeof variantSolid;
-        secondary: {
-            border: string;
-            borderColor: string;
-            _hover: {
-                bg: string;
-                borderColor: string;
-            };
-        };
-    };
-    defaultProps: {
-        size: string;
-        variant: string;
-        colorScheme: string;
-    };
-};
-declare function variantSolid(props: Dict): {
-    _hover: {
-        _disabled: {
-            bg: string;
-            color: string;
-        };
-    };
-    _disabled: {
-        bg: string;
-        color: string;
-    };
-    bg: string;
-    _active: {
-        bg: string;
-    };
-    color?: undefined;
-    hoverBg?: undefined;
-    activeBg?: undefined;
-} | {
-    _hover: {
-        _disabled: {
-            bg: string;
-            color: string;
-        };
-    };
-    _disabled: {
-        bg: string;
-        color: string;
-    };
-    bg: string;
-    color: string;
-    hoverBg: string;
-    activeBg: string;
-    _active?: undefined;
-};
-export default ButtonStyle;
+import { Dict } from '../types';
+declare const ButtonStyle: {
+    baseStyle: {
+        borderRadius: string;
+        fontWeight: string;
+    };
+    sizes: {
+        lg: {
+            h: number;
+            minW: number;
+            fontSize: string;
+            px: number;
+        };
+        md: {
+            h: string;
+            minW: number;
+            fontSize: string;
+            px: number;
+        };
+        sm: {
+            h: number;
+            minW: number;
+            fontSize: string;
+            px: number;
+        };
+        xs: {
+            h: number;
+            minW: number;
+            fontSize: string;
+            px: number;
+        };
+    };
+    variants: {
+        pill: {
+            border: string;
+            borderColor: string;
+            borderRadius: string;
+            height: number;
+            px: number;
+            fontSize: string;
+            my: string;
+        };
+        solid: typeof variantSolid;
+        secondary: {
+            border: string;
+            borderColor: string;
+            _hover: {
+                bg: string;
+                borderColor: string;
+            };
+        };
+    };
+    defaultProps: {
+        size: string;
+        variant: string;
+        colorScheme: string;
+    };
+};
+declare function variantSolid(props: Dict): {
+    _hover: {
+        _disabled: {
+            bg: string;
+            color: string;
+        };
+    };
+    _disabled: {
+        bg: string;
+        color: string;
+    };
+    bg: string;
+    _active: {
+        bg: string;
+    };
+    color?: undefined;
+    hoverBg?: undefined;
+    activeBg?: undefined;
+} | {
+    _hover: {
+        _disabled: {
+            bg: string;
+            color: string;
+        };
+    };
+    _disabled: {
+        bg: string;
+        color: string;
+    };
+    bg: string;
+    color: string;
+    hoverBg: string;
+    activeBg: string;
+    _active?: undefined;
+};
+export default ButtonStyle;

package/dist/{ui → types/ui}/nypl-base-theme/components/checkbox.d.ts

@@ -1,41 +1,41 @@
-declare const Checkbox: {
-    baseStyle: {
-        control: {
-            borderColor: string;
-            _hover: {
-                bg: string;
-                _disabled: {
-                    bg: string;
-                };
-            };
-            _checked: {
-                bg: string;
-                color: string;
-                borderColor: string;
-                _hover: {
-                    bg: string;
-                    borderColor: string;
-                };
-            };
-            _disabled: {
-                bg: string;
-                borderColor: string;
-            };
-        };
-        label: {
-            userSelect: string;
-            fontWeight: string;
-            _disabled: {
-                color: string;
-                opacity: number;
-            };
-        };
-    };
-    sizes: {};
-    variants: {};
-    defaultProps: {
-        size: string;
-        colorScheme: string;
-    };
-};
-export default Checkbox;
+declare const Checkbox: {
+    baseStyle: {
+        control: {
+            borderColor: string;
+            _hover: {
+                bg: string;
+                _disabled: {
+                    bg: string;
+                };
+            };
+            _checked: {
+                bg: string;
+                color: string;
+                borderColor: string;
+                _hover: {
+                    bg: string;
+                    borderColor: string;
+                };
+            };
+            _disabled: {
+                bg: string;
+                borderColor: string;
+            };
+        };
+        label: {
+            userSelect: string;
+            fontWeight: string;
+            _disabled: {
+                color: string;
+                opacity: number;
+            };
+        };
+    };
+    sizes: {};
+    variants: {};
+    defaultProps: {
+        size: string;
+        colorScheme: string;
+    };
+};
+export default Checkbox;