@canopycanopycanopy/b-ber-reader-react 1.2.13-react-reader.35 → 1.2.13-react-reader.45

package/index.d.ts

@@ -41,7 +41,7 @@ export enum Layout {
   COLUMNS = 'columns',
 }
 
-type RequireOneOf<T, Keys extends keyof T = keyof T> = Pick<
+export type RequireOneOf<T, Keys extends keyof T = keyof T> = Pick<
   T,
   Exclude<keyof T, Keys>
 > &
@@ -57,54 +57,49 @@ export interface BberReaderQueryParameterKeys {
   spreadIndex?: number
 }
 
-interface Download {
+export interface Download {
   label: string
   title: string
   url: string
   description?: string
 }
 
-interface UiOptionsNavigationHeaderIcons {
+export interface UiOptionsNavigationHeaderIcons {
   home?: boolean
   toc?: boolean
   downloads?: boolean
   info?: boolean
 }
 
-interface UiOptionsNavigationFooterIcons {
+export interface UiOptionsNavigationFooterIcons {
   chapter?: boolean
   page?: boolean
 }
 
-interface UiOptionsNavigation {
+export interface UiOptionsNavigation {
   header_icons?: UiOptionsNavigationHeaderIcons
   footer_icons?: UiOptionsNavigationFooterIcons
 }
 
-interface UiOptions {
+export interface UiOptions {
   navigation?: UiOptionsNavigation
 }
 
-enum SidebarName {
+export enum SidebarName {
   CHAPTERS = 'chapters',
   DOWNLOADS = 'downloads',
   METADATA = 'metadata',
   // SETTINGS = 'settings',
 }
 
-interface NavigationHeaderProps {
+export interface NavigationHeaderProps {
   destroyReaderComponent: () => void
-  handleSidebarButtonClick: (name: SidebarName | null) => void
+  handleSidebarButtonClick: (name: `${SidebarName}` | null) => void
   downloads: Download[]
   uiOptions: UiOptions
 }
 
-enum Layout {
-  SCROLL = 'scroll',
-  COLUMNS = 'columns',
-}
-
-interface SpineItem {
+export interface SpineItem {
   absoluteURL: string
   children: SpineItem[]
   depth: number
@@ -119,9 +114,9 @@ interface SpineItem {
   title: string
 }
 
-type Spine = SpineItem[]
+export type Spine = SpineItem[]
 
-interface Metadata {
+export interface Metadata {
   title: string
   creator: string
   date: string
@@ -132,11 +127,11 @@ interface Metadata {
   identifier: string
 }
 
-interface NavigationFooterProps {
+export interface NavigationFooterProps {
   uiOptions: UiOptions
   currentSpineItemIndex: number
   spine: Spine
-  layout: Layout
+  layout: `${Layout}`
   spreadIndex: number
   lastSpreadIndex: number
   handleEvents: boolean
@@ -149,28 +144,34 @@ interface NavigationFooterProps {
   goToNextPage: () => void
 }
 
-interface SidebarChaptersProps {
+export interface SidebarChaptersProps {
   showSidebar: SidebarName | null
   spine: Spine
   currentSpineItemIndex: number
   navigateToChapterByURL: (url: string) => void
 }
 
-interface SidebarDownloadsProps {
+export interface SidebarDownloadsProps {
   showSidebar: SidebarName | null
   downloads: Download[]
 }
 
-interface SidebarMetadataProps {
+export interface SidebarMetadataProps {
   showSidebar: SidebarName | null
   metadata: Metadata
 }
 
 // interface SidebarSettingsProps {}
 
-type UiReaderProp<T> = React.Component<T> | ((props: T) => JSX.Element)
+export type UiReaderProp<T> = React.Component<T> | ((props: T) => JSX.Element)
 
-interface OptionalBberReaderProps {
+export type LocationState = 'memory' | 'localStorage' | 'queryParams'
+
+export type KeysValues<T> = { [P in keyof T]: T[P] }
+
+export type SearchParams = string | KeysValues<BberReaderQueryParameterKeys>
+
+export interface OptionalBberReaderProps {
   bookURL?: string
   manifestURL?: string
   projectURL?: string
@@ -180,8 +181,8 @@ interface OptionalBberReaderProps {
   loadRemoteLibrary?: boolean
   uiOptions?: UI
   cache?: boolean
-  layout?: Layout
-  paramKeys?: BberReaderQueryParameterKeys
+  layout?: `${Layout}`
+  searchParamKeys?: BberReaderQueryParameterKeys
   disableBodyStyles?: boolean
 
   NavigationHeader?: UiReaderProp<NavigationHeaderProps>
@@ -190,6 +191,9 @@ interface OptionalBberReaderProps {
   SidebarDownloads?: UiReaderProp<SidebarDownloadsProps>
   SidebarMetadata?: UiReaderProp<SidebarMetadataProps>
   // SidebarSettings?: UiReaderProp<SidebarSettingsProps>
+
+  locationState?: LocationState
+  searchParams?: SearchParams
 }
 
 export type BberReaderProps = RequireOneOf<

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-reader-react",
-  "version": "1.2.13-react-reader.35+527d8e79",
+  "version": "1.2.13-react-reader.45+ff99b231",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -61,6 +61,7 @@
     "postcss-loader": "^2.1.1",
     "prop-types": "^15.6.1",
     "react-test-renderer": "^16.4.0",
+    "redux-mock-store": "^1.5.4",
     "resize-observer-polyfill": "^1.5.0",
     "rimraf": "^2.7.1",
     "sass": "^1.49.8",
@@ -121,5 +122,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "527d8e79f950d695509b03743e7a1c0d6bd66edf"
+  "gitHead": "ff99b23185b94316fc96251b2d580a00a2649ed5"
 }