Merge pull request #325 from victorsoares96/RC-1.4.6

RC-1.4.6
victorsoares96 · Dec 9, 2024 · 7b15838 · 7b15838
2 parents b31d5d5 + aa05d4c
commit 7b15838
Show file tree

Hide file tree

Showing 11 changed files with 4,926 additions and 5,208 deletions.
diff --git a/README.md b/README.md
@@ -112,6 +112,7 @@ export default function App() {
 | `onReady`                    | `function`    | Called once book has been displayed. Optional.               |
 | `onDisplayError`             | `function`    | Called once book has not been displayed. Optional.           |
 | `onRendered`                 | `function`    | Emit that a section has been rendered. Optional.             |
+| `onChangeSection`            | `function`    | Called when section has been change. Optional.               |
 | `onResized`                  | `function`    | Called when occurred a page change. Optional.                |
 | `onLocationChange`           | `function`    | Called when occurred a page change. Optional.                |
 | `onSearch`                   | `function`    | Called once when the book has been searched. Optional.       |
@@ -148,6 +149,7 @@ export default function App() {
 | `fullsize`           | `boolean`    |                                                                           |
 | `waitForLocationsReady`           |  `boolean`    | only render book after locations generated                                                                           |
 | `keepScrollOffsetOnLocationChange` | `boolean` | Prevents scroll top when change location. Works with `scrolled-doc` flow.
+| `charactersPerLocation`           | `number`    | Default is 1600                                                                          |
 
 ## Hooks
 

diff --git a/example-bare/package.json b/example-bare/package.json
@@ -15,15 +15,15 @@
     "@react-navigation/native": "^6.1.15",
     "@react-navigation/native-stack": "^6.9.24",
     "@react-native-community/slider": "^4.5.2",
-    "expo": "~50.0.11",
-    "expo-document-picker": "~11.10.1",
+    "expo": "~51.0.0",
+    "expo-document-picker": "~12.0.0",
     "expo-status-bar": "~1.12.0",
-    "react": "18.2.0",
-    "react-native": "0.73.6",
+    "react": "18.3.1",
+    "react-native": "0.75.2",
     "react-native-fs": "^2.20.0",
     "react-native-gesture-handler": "^2.15.0",
     "react-native-paper": "^5.12.3",
-    "react-native-reanimated": "~3.6.2",
+    "react-native-reanimated": "~3.15.0",
     "react-native-safe-area-context": "^4.9.0",
     "react-native-screens": "^3.29.0",
     "react-native-vector-icons": "^10.0.3",

diff --git a/example-bare/yarn.lock b/example-bare/yarn.lock
diff --git a/example-expo/package.json b/example-expo/package.json
@@ -7,26 +7,25 @@
     "@react-native-community/slider": "^4.5.2",
     "@react-navigation/native": "^6.1.15",
     "@react-navigation/native-stack": "^6.9.24",
-    "expo": "^50.0.1",
-    "expo-document-picker": "~11.10.1",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "react-native": "0.73.6",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "expo": "^51.0.0",
+    "expo-document-picker": "~12.0.0",
+    "react-native": "0.75.2",
     "react-native-fs": "^2.20.0",
-    "react-native-gesture-handler": "~2.14.0",
+    "react-native-gesture-handler": "~2.18.0",
     "react-native-paper": "^5.12.3",
-    "react-native-reanimated": "~3.6.2",
-    "react-native-safe-area-context": "4.8.2",
-    "react-native-screens": "~3.29.0",
+    "react-native-reanimated": "~3.15.0",
+    "react-native-safe-area-context": "4.10.9",
+    "react-native-screens": "~3.34.0",
     "react-native-vector-icons": "^10.0.3",
     "react-native-web": "~0.19.6",
-    "react-native-webview": "13.6.4",
+    "react-native-webview": "13.11.1",
     "usehooks-ts": "^3.1.0"
   },
   "devDependencies": {
     "@babel/core": "^7.19.3",
-    "@types/react": "~18.2.14",
-    "@types/react-native": "~0.73.0",
+    "@types/react": "~18.3.0",
     "typescript": "^5.4.5"
   },
   "scripts": {

diff --git a/example-expo/yarn.lock b/example-expo/yarn.lock
diff --git a/package.json b/package.json
@@ -61,10 +61,9 @@
   "devDependencies": {
     "@react-native-community/eslint-config": "3.2.0",
     "@testing-library/jest-native": "5.4.3",
-    "@testing-library/react-native": "12.4.5",
+    "@testing-library/react-native": "12.6.0",
     "@types/jest": "29.5.12",
-    "@types/react": "~18.2.0",
-    "@types/react-native": "^0.73.0",
+    "@types/react": "~18.3.0",
     "@types/react-test-renderer": "18.3.0",
     "@typescript-eslint/eslint-plugin": "7.11.0",
     "@typescript-eslint/parser": "7.11.0",
@@ -76,29 +75,29 @@
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-jest": "^28.0.0",
-    "eslint-plugin-jsx-a11y": "6.8.0",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-react": "7.34.2",
-    "eslint-plugin-react-hooks": "4.6.0",
+    "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-jsx-a11y": "6.9.0",
+    "eslint-plugin-react": "7.35.0",
+    "eslint-plugin-react-hooks": "4.6.2",
     "eslint-plugin-testing-library": "6.2.2",
     "husky": "9.0.11",
     "jest": "29.7.0",
     "lint-staged": "15.2.5",
     "metro-react-native-babel-preset": "^0.77.0",
     "pod-install": "0.2.2",
     "prettier": "3.2.5",
-    "react": "18.2.0",
-    "react-native": "0.73.6",
+    "react": "18.3.1",
+    "react-native": "0.75.2",
     "react-native-builder-bob": "0.23.2",
     "react-native-gesture-handler": "^2.12.0",
-    "react-native-webview": "13.3.0",
-    "react-test-renderer": "18.2.0",
+    "react-native-webview": "13.11.1",
+    "react-test-renderer": "18.3.1",
     "ts-jest": "29.1.4",
     "ts-node": "10.9.2",
     "typescript": "^5.4.5"
   },
   "resolutions": {
-    "@types/react": "~18.2.0"
+    "@types/react": "~18.3.0"
   },
   "peerDependencies": {
     "react": "*",

diff --git a/src/Reader.tsx b/src/Reader.tsx
@@ -3,7 +3,7 @@ import { Platform } from 'react-native';
 import { LoadingFile } from './utils/LoadingFile';
 import type { ReaderProps } from './types';
 import { View } from './View';
-import { useInjectWebVieWVariables } from './hooks/useInjectWebviewVariables';
+import { useInjectWebViewVariables } from './hooks/useInjectWebviewVariables';
 import { ReaderContext, defaultTheme as initialTheme } from './context';
 import { isURL } from './utils/isURL';
 import { getSourceType } from './utils/getSourceType';
@@ -31,6 +31,7 @@ export function Reader({
   snap,
   spread,
   fullsize,
+  charactersPerLocation,
   ...rest
 }: ReaderProps) {
   const {
@@ -46,7 +47,7 @@ export function Reader({
   const allowPopups = onPressExternalLink ? true : rest.allowPopups || false;
 
   const { setIsLoading, isLoading } = useContext(ReaderContext);
-  const { injectWebVieWVariables } = useInjectWebVieWVariables();
+  const { injectWebViewVariables } = useInjectWebViewVariables();
   const [template, setTemplate] = useState<string | null>(null);
   const [templateUrl, setTemplateUrl] = useState<string | null>(null);
   const [allowedUris, setAllowedUris] = useState<string | null>(null);
@@ -86,7 +87,7 @@ export function Reader({
           }
           if (sourceType === SourceType.BASE64) {
             setTemplate(
-              injectWebVieWVariables({
+              injectWebViewVariables({
                 jszip: jszipFileUri,
                 epubjs: epubjsFileUri,
                 type: SourceType.BASE64,
@@ -101,13 +102,14 @@ export function Reader({
                 snap,
                 spread,
                 fullsize,
+                charactersPerLocation,
               })
             );
 
             setIsLoading(false);
           } else {
             setTemplate(
-              injectWebVieWVariables({
+              injectWebViewVariables({
                 jszip: jszipFileUri,
                 epubjs: epubjsFileUri,
                 type: SourceType.BINARY,
@@ -122,6 +124,7 @@ export function Reader({
                 snap,
                 spread,
                 fullsize,
+                charactersPerLocation,
               })
             );
 
@@ -138,7 +141,7 @@ export function Reader({
 
           if (sourceType === SourceType.OPF || sourceType === SourceType.EPUB) {
             setTemplate(
-              injectWebVieWVariables({
+              injectWebViewVariables({
                 jszip: jszipFileUri,
                 epubjs: epubjsFileUri,
                 type: sourceType,
@@ -153,6 +156,7 @@ export function Reader({
                 snap,
                 spread,
                 fullsize,
+                charactersPerLocation,
               })
             );
 
@@ -165,7 +169,7 @@ export function Reader({
             setAllowedUris(`${bookFileUri},${jszipFileUri},${epubjsFileUri}`);
 
             setTemplate(
-              injectWebVieWVariables({
+              injectWebViewVariables({
                 jszip: jszipFileUri,
                 epubjs: epubjsFileUri,
                 type: sourceType,
@@ -180,6 +184,7 @@ export function Reader({
                 snap,
                 spread,
                 fullsize,
+                charactersPerLocation,
               })
             );
 
@@ -197,7 +202,7 @@ export function Reader({
     downloadFile,
     enableSelection,
     initialLocations,
-    injectWebVieWVariables,
+    injectWebViewVariables,
     setIsLoading,
     src,
     // ! Causing unknown loop

diff --git a/src/View.tsx b/src/View.tsx
@@ -76,6 +76,7 @@ export function View({
   waitForLocationsReady = false,
   keepScrollOffsetOnLocationChange,
   flow,
+  onChangeSection = () => {},
 }: ViewProps) {
   const {
     registerBook,
@@ -98,6 +99,7 @@ export function View({
     removeSelection,
     setAnnotations,
     setInitialAnnotations,
+    section,
     setSection,
     setToc,
     setLandmarks,
@@ -204,6 +206,10 @@ export function View({
       setProgress(progress);
       setSection(currentSection);
 
+      if (section?.href !== currentSection?.href) {
+        onChangeSection(currentSection);
+      }
+
       handleChangeIsBookmarked(bookmarks, currentLocation);
 
       if (currentLocation.atStart) setAtStart(true);
@@ -270,9 +276,9 @@ export function View({
     }
 
     if (type === 'onRendered') {
-      const { section, currentSection } = parsedEvent;
+      const { currentSection } = parsedEvent;
 
-      return onRendered(section, currentSection);
+      return onRendered(parsedEvent.section, currentSection);
     }
 
     if (type === 'onLayout') {

diff --git a/src/hooks/useInjectWebviewVariables.ts b/src/hooks/useInjectWebviewVariables.ts
@@ -3,8 +3,8 @@ import type { Flow, Manager, Spread, Theme, ePubCfi } from '../types';
 import template from '../template';
 import type { SourceType } from '../utils/enums/source-type.enum';
 
-export function useInjectWebVieWVariables() {
-  const injectWebVieWVariables = useCallback(
+export function useInjectWebViewVariables() {
+  const injectWebViewVariables = useCallback(
     ({
       jszip,
       epubjs,
@@ -20,6 +20,7 @@ export function useInjectWebVieWVariables() {
       snap,
       spread,
       fullsize,
+      charactersPerLocation = 1600,
     }: {
       jszip: string;
       epubjs: string;
@@ -35,6 +36,7 @@ export function useInjectWebVieWVariables() {
       snap?: boolean;
       spread?: Spread;
       fullsize?: boolean;
+      charactersPerLocation?: number;
     }) => {
       return template
         .replace(
@@ -71,9 +73,13 @@ export function useInjectWebVieWVariables() {
           /spread: undefined/,
           `spread: ${spread ? JSON.stringify(spread) : undefined}`
         )
-        .replace(/fullsize: undefined/, `fullsize: ${fullsize ?? undefined}`);
+        .replace(/fullsize: undefined/, `fullsize: ${fullsize ?? undefined}`)
+        .replace(
+          /book\.locations\.generate\(1600\)/,
+          `book.locations.generate(${charactersPerLocation})`
+        );
     },
     []
   );
-  return { injectWebVieWVariables };
+  return { injectWebViewVariables };
 }
diff --git a/src/types.ts b/src/types.ts
@@ -274,8 +274,11 @@ export interface ReaderProps {
    * @param {any} section
    * @param {any} currentSection
    * @returns {void} void
+   *
+   * @deprecated use **onChangeSection** instead
    */
   onRendered?: (section: any, currentSection: any) => void;
+  onChangeSection?: (section: Section | null) => void;
   /**
    * Called when book layout is change
    * @param {string} layout
@@ -467,4 +470,9 @@ export interface ReaderProps {
    * Default is false
    */
   keepScrollOffsetOnLocationChange?: boolean;
+
+  /**
+   * Default is 1600
+   */
+  charactersPerLocation?: number;
 }