@nypl/web-reader 4.3.3 → 4.3.5

package/dist/index.d.ts

@@ -423,14 +423,14 @@ declare type HTMLActiveReader = CommonReader & {
 };
 declare type ActiveReader = PDFActiveReader | HTMLActiveReader;
 declare type ReaderReturn = InactiveReader | LoadingReader | ActiveReader;
-declare type GetContent = (href: string) => Promise<string>;
+declare type GetContent<T extends string | Uint8Array> = (href: string, proxyUrl?: string) => Promise<T>;
 declare type ReaderManagerArguments = {
     headerLeft?: JSX.Element;
 };
-declare type UseWebReaderArguments = {
+declare type UseWebReaderArguments<T extends string | Uint8Array> = {
     webpubManifestUrl: string;
     proxyUrl?: string;
-    getContent?: GetContent;
+    getContent?: GetContent<T>;
     pdfWorkerSrc?: string;
     injectablesReflowable?: Injectable[];
     injectablesFixed?: Injectable[];
@@ -470,20 +470,23 @@ declare type UseWebReaderArguments = {
      */
     persistSettings?: boolean;
 };
-declare type ActiveReaderArguments = UseWebReaderArguments & {
+declare type ActiveReaderArguments<T extends string | Uint8Array> = UseWebReaderArguments<T> & {
     manifest: WebpubManifest;
 };
 declare type InactiveReaderArguments = undefined;
-declare type ReaderArguments = ActiveReaderArguments | InactiveReaderArguments;
 
 /**
  * The React hook that exposes the main API into the reader. It
  * will determine the type of the webpub, and then use the correct reader
  * for that type.
  */
-declare function useWebReader(args: UseWebReaderArguments): HTMLActiveReader | PDFActiveReader | LoadingReader;
+declare function useWebReader(args: UseWebReaderArguments<string | Uint8Array>): HTMLActiveReader | PDFActiveReader | LoadingReader;
 
-declare function useHtmlReader(args: ReaderArguments): ReaderReturn;
+declare type HtmlReaderArguments = ActiveReaderArguments<string> | InactiveReaderArguments;
+
+declare function useHtmlReader(args: HtmlReaderArguments): ReaderReturn;
+
+declare type PdfReaderArguments = ActiveReaderArguments<Uint8Array> | InactiveReaderArguments;
 
 /**
  * The PDF reader
@@ -494,7 +497,7 @@ declare function useHtmlReader(args: ReaderArguments): ReaderReturn;
  * @param args T
  * @returns
  */
-declare function usePdfReader(args: ReaderArguments): ReaderReturn;
+declare function usePdfReader(args: PdfReaderArguments): ReaderReturn;
 
 declare type Dict<T = any> = Record<string, T>;
 
@@ -526,8 +529,8 @@ declare function addTocToManifest(manifest: WebpubManifest, getResource: (url: s
 /**
  * The main React component export.
  */
-declare type WebReaderProps = UseWebReaderArguments & ReaderManagerArguments;
+declare type WebReaderProps = UseWebReaderArguments<string | Uint8Array> & ReaderManagerArguments;
 declare const WebReaderWithoutBoundary: FC<WebReaderProps>;
 declare const WebReader: FC<WebReaderProps>;
 
-export { CHROME_HEIGHT, DEFAULT_HEIGHT, DEFAULT_SETTINGS, DEFAULT_SHOULD_GROW_WHEN_SCROLLING, FONT_DETAILS, FOOTER_HEIGHT, HEADER_HEIGHT, IS_DEV, LOCAL_STORAGE_LOCATIONS_KEY, LOCAL_STORAGE_SETTINGS_KEY, MAIN_CONTENT_ID, ReadiumWebpubContext, WebReaderProps, WebReaderWithoutBoundary, addTocToManifest, clearWebReaderLocalStorage, WebReader as default, getTheme, useColorModeValue, useHtmlReader, usePdfReader, useWebReader };
+export { CHROME_HEIGHT, DEFAULT_HEIGHT, DEFAULT_SETTINGS, DEFAULT_SHOULD_GROW_WHEN_SCROLLING, FONT_DETAILS, FOOTER_HEIGHT, HEADER_HEIGHT, IS_DEV, LOCAL_STORAGE_LOCATIONS_KEY, LOCAL_STORAGE_SETTINGS_KEY, MAIN_CONTENT_ID, ReadiumLink, ReadiumWebpubContext, WebReaderProps, WebReaderWithoutBoundary, WebpubManifest, addTocToManifest, clearWebReaderLocalStorage, WebReader as default, getTheme, useColorModeValue, useHtmlReader, usePdfReader, useWebReader };