@youversion/platform-react-hooks 1.12.0 → 1.12.1

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @youversion/platform-react-hooks@1.12.0 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/hooks
+> @youversion/platform-react-hooks@1.12.1 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/hooks
 > tsc -p tsconfig.build.json
 

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @youversion/platform-react-hooks
 
+## 1.12.1
+
+### Patch Changes
+
+- 165feca: Fix user settings from localStorage not loading in the bible reader
+- Updated dependencies [165feca]
+  - @youversion/platform-core@1.12.1
+
 ## 1.12.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@youversion/platform-react-hooks",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "type": "module",
   "publishConfig": {
     "access": "public",
@@ -22,7 +22,7 @@
     }
   },
   "dependencies": {
-    "@youversion/platform-core": "1.12.0"
+    "@youversion/platform-core": "1.12.1"
   },
   "peerDependencies": {
     "react": ">=19.1.0 <20.0.0"

package/src/useVerse.test.tsx

@@ -0,0 +1,228 @@
+import { renderHook, waitFor, act } from '@testing-library/react';
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import type { ReactNode } from 'react';
+import { useVerse } from './useVerse';
+import { YouVersionContext } from './context';
+import { type BibleClient, type BibleVerse } from '@youversion/platform-core';
+import { useBibleClient } from './useBibleClient';
+
+vi.mock('./useBibleClient');
+
+describe('useVerse', () => {
+  const mockAppKey = 'test-app-key';
+  const mockGetVerse = vi.fn();
+
+  const mockVerse: BibleVerse = {
+    id: '1',
+    passage_id: 'MAT.1.1',
+    title: '1',
+  };
+
+  const createWrapper = (contextValue: { appKey: string }) => {
+    return ({ children }: { children: ReactNode }) => (
+      <YouVersionContext.Provider value={contextValue}>{children}</YouVersionContext.Provider>
+    );
+  };
+
+  beforeEach(() => {
+    vi.resetAllMocks();
+
+    mockGetVerse.mockResolvedValue(mockVerse);
+
+    const mockClient: Partial<BibleClient> = { getVerse: mockGetVerse };
+    vi.mocked(useBibleClient).mockReturnValue(mockClient as BibleClient);
+  });
+
+  describe('fetching verse', () => {
+    it('should fetch verse with all 4 parameters', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerse(111, 'MAT', 1, 1), { wrapper });
+
+      expect(result.current.loading).toBe(true);
+      expect(result.current.verse).toBe(null);
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledWith(111, 'MAT', 1, 1);
+      expect(result.current.verse).toEqual(mockVerse);
+    });
+
+    it('should refetch when versionId changes', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result, rerender } = renderHook(({ versionId }) => useVerse(versionId, 'MAT', 1, 1), {
+        wrapper,
+        initialProps: { versionId: 1 },
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(1);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(1, 'MAT', 1, 1);
+
+      act(() => {
+        rerender({ versionId: 111 });
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(2);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(111, 'MAT', 1, 1);
+    });
+
+    it('should refetch when book changes', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result, rerender } = renderHook(({ book }) => useVerse(1, book, 1, 1), {
+        wrapper,
+        initialProps: { book: 'MAT' },
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(1);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(1, 'MAT', 1, 1);
+
+      act(() => {
+        rerender({ book: 'GEN' });
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(2);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(1, 'GEN', 1, 1);
+    });
+
+    it('should refetch when chapter changes', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result, rerender } = renderHook(({ chapter }) => useVerse(1, 'MAT', chapter, 1), {
+        wrapper,
+        initialProps: { chapter: 1 },
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(1);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(1, 'MAT', 1, 1);
+
+      act(() => {
+        rerender({ chapter: 5 });
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(2);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(1, 'MAT', 5, 1);
+    });
+
+    it('should refetch when verse changes', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result, rerender } = renderHook(({ verse }) => useVerse(1, 'MAT', 1, verse), {
+        wrapper,
+        initialProps: { verse: 1 },
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(1);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(1, 'MAT', 1, 1);
+
+      act(() => {
+        rerender({ verse: 10 });
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(2);
+      expect(mockGetVerse).toHaveBeenLastCalledWith(1, 'MAT', 1, 10);
+    });
+
+    it('should not fetch when enabled is false', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerse(1, 'MAT', 1, 1, { enabled: false }), {
+        wrapper,
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).not.toHaveBeenCalled();
+      expect(result.current.verse).toBe(null);
+    });
+
+    it('should handle fetch errors', async () => {
+      const error = new Error('Failed to fetch verse');
+      mockGetVerse.mockRejectedValueOnce(error);
+
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerse(1, 'MAT', 1, 1), { wrapper });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(result.current.error).toEqual(error);
+      expect(result.current.verse).toBe(null);
+    });
+
+    it('should support manual refetch', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerse(1, 'MAT', 1, 1), { wrapper });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerse).toHaveBeenCalledTimes(1);
+
+      act(() => {
+        result.current.refetch();
+      });
+
+      await waitFor(() => {
+        expect(mockGetVerse).toHaveBeenCalledTimes(2);
+      });
+    });
+  });
+});

package/src/useVerseSelection.test.tsx

@@ -0,0 +1,33 @@
+import { describe, it, expect, vi } from 'vitest';
+import { renderHook } from '@testing-library/react';
+import type { ReactNode } from 'react';
+import { useVerseSelection } from './useVerseSelection';
+import { VerseSelectionProvider } from './context/VerseSelectionProvider';
+
+// Wrapper for renderHook
+const wrapper = ({ children }: { children: ReactNode }) => (
+  <VerseSelectionProvider>{children}</VerseSelectionProvider>
+);
+
+describe('useVerseSelection', () => {
+  it('should throw error when used outside provider', () => {
+    const consoleSpy = vi.spyOn(console, 'error').mockImplementation(vi.fn());
+
+    expect(() => {
+      renderHook(() => useVerseSelection());
+    }).toThrow('useVerseSelection must be used within a VerseSelectionProvider');
+
+    consoleSpy.mockRestore();
+  });
+
+  it('should return expected shape with correct initial values', () => {
+    const { result } = renderHook(() => useVerseSelection(), { wrapper });
+
+    expect(result.current.selectedVerseUsfms).toBeInstanceOf(Set);
+    expect(result.current.selectedVerseUsfms.size).toBe(0);
+    expect(result.current.selectedCount).toBe(0);
+    expect(typeof result.current.toggleVerse).toBe('function');
+    expect(typeof result.current.isSelected).toBe('function');
+    expect(typeof result.current.clearSelection).toBe('function');
+  });
+});

package/src/useVerses.test.tsx

@@ -0,0 +1,202 @@
+import { renderHook, waitFor, act } from '@testing-library/react';
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import type { ReactNode } from 'react';
+import { useVerses } from './useVerses';
+import { YouVersionContext } from './context';
+import { type BibleClient, type BibleVerse, type Collection } from '@youversion/platform-core';
+import { useBibleClient } from './useBibleClient';
+
+vi.mock('./useBibleClient');
+
+describe('useVerses', () => {
+  const mockAppKey = 'test-app-key';
+  const mockGetVerses = vi.fn();
+
+  const mockVerses: Collection<BibleVerse> = {
+    data: [
+      { id: '1', passage_id: 'MAT.1.1', title: '1' },
+      { id: '2', passage_id: 'MAT.1.2', title: '2' },
+      { id: '3', passage_id: 'MAT.1.3', title: '3' },
+    ],
+    next_page_token: null,
+  };
+
+  const createWrapper = (contextValue: { appKey: string }) => {
+    return ({ children }: { children: ReactNode }) => (
+      <YouVersionContext.Provider value={contextValue}>{children}</YouVersionContext.Provider>
+    );
+  };
+
+  beforeEach(() => {
+    vi.resetAllMocks();
+
+    mockGetVerses.mockResolvedValue(mockVerses);
+
+    const mockClient: Partial<BibleClient> = { getVerses: mockGetVerses };
+    vi.mocked(useBibleClient).mockReturnValue(mockClient as BibleClient);
+  });
+
+  describe('fetching verses', () => {
+    it('should fetch verses with all 3 parameters', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerses(111, 'MAT', 1), { wrapper });
+
+      expect(result.current.loading).toBe(true);
+      expect(result.current.verses).toBe(null);
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledWith(111, 'MAT', 1);
+      expect(result.current.verses).toEqual(mockVerses);
+    });
+
+    it('should refetch when versionId changes', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result, rerender } = renderHook(({ versionId }) => useVerses(versionId, 'MAT', 1), {
+        wrapper,
+        initialProps: { versionId: 1 },
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledTimes(1);
+      expect(mockGetVerses).toHaveBeenLastCalledWith(1, 'MAT', 1);
+
+      act(() => {
+        rerender({ versionId: 111 });
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledTimes(2);
+      expect(mockGetVerses).toHaveBeenLastCalledWith(111, 'MAT', 1);
+    });
+
+    it('should refetch when book changes', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result, rerender } = renderHook(({ book }) => useVerses(1, book, 1), {
+        wrapper,
+        initialProps: { book: 'MAT' },
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledTimes(1);
+      expect(mockGetVerses).toHaveBeenLastCalledWith(1, 'MAT', 1);
+
+      act(() => {
+        rerender({ book: 'GEN' });
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledTimes(2);
+      expect(mockGetVerses).toHaveBeenLastCalledWith(1, 'GEN', 1);
+    });
+
+    it('should refetch when chapter changes', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result, rerender } = renderHook(({ chapter }) => useVerses(1, 'MAT', chapter), {
+        wrapper,
+        initialProps: { chapter: 1 },
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledTimes(1);
+      expect(mockGetVerses).toHaveBeenLastCalledWith(1, 'MAT', 1);
+
+      act(() => {
+        rerender({ chapter: 5 });
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledTimes(2);
+      expect(mockGetVerses).toHaveBeenLastCalledWith(1, 'MAT', 5);
+    });
+
+    it('should not fetch when enabled is false', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerses(1, 'MAT', 1, { enabled: false }), {
+        wrapper,
+      });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).not.toHaveBeenCalled();
+      expect(result.current.verses).toBe(null);
+    });
+
+    it('should handle fetch errors', async () => {
+      const error = new Error('Failed to fetch verses');
+      mockGetVerses.mockRejectedValueOnce(error);
+
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerses(1, 'MAT', 1), { wrapper });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(result.current.error).toEqual(error);
+      expect(result.current.verses).toBe(null);
+    });
+
+    it('should support manual refetch', async () => {
+      const wrapper = createWrapper({
+        appKey: mockAppKey,
+      });
+
+      const { result } = renderHook(() => useVerses(1, 'MAT', 1), { wrapper });
+
+      await waitFor(() => {
+        expect(result.current.loading).toBe(false);
+      });
+
+      expect(mockGetVerses).toHaveBeenCalledTimes(1);
+
+      act(() => {
+        result.current.refetch();
+      });
+
+      await waitFor(() => {
+        expect(mockGetVerses).toHaveBeenCalledTimes(2);
+      });
+    });
+  });
+});