@granite-js/react-native 1.0.39 → 1.0.40

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @granite-js/react-native
 
+## 1.0.40
+
+### Patch Changes
+
+- c7e7fc9: fix(react-native): unset iOS back press handler on cleanup instead of re-registering
+  - @granite-js/blur-view@1.0.40
+  - @granite-js/brownfield-module@1.0.40
+  - @granite-js/cli@1.0.40
+  - @granite-js/jest@1.0.40
+  - @granite-js/mpack@1.0.40
+  - @granite-js/native@1.0.40
+  - @granite-js/plugin-core@1.0.40
+  - @granite-js/style-utils@1.0.40
+  - @granite-js/video@1.0.40
+
 ## 1.0.39
 
 ### Patch Changes

package/dist/app/Granite.d.ts

@@ -1,6 +1,6 @@
 import { ComponentType, type JSX, PropsWithChildren } from 'react';
 import type { InitialProps } from '../initial-props';
-import type { RouterProps, RequireContext } from '../router';
+import type { RouterProps, RequireContext, SetIOSBackPressHandler } from '../router';
 export interface GraniteProps {
     /**
      * @description
@@ -34,10 +34,11 @@ export interface GraniteProps {
     /**
      * @description
      * The function to register a handler that runs when the iOS swipe back gesture is detected.
+     * Called with empty params (`{}`, no `handler`) when the handler should be unset — in
+     * that case the implementation must initialize the registered handler to `null`
+     * (e.g. call `unsetBackPressHandler()`), not keep an empty function registered.
      */
-    setiOSBackPressHandler?: ({ handler }: {
-        handler: () => void;
-    }) => Promise<void> | void;
+    setiOSBackPressHandler?: SetIOSBackPressHandler;
     /**
      * @description
      * The function to provide the initial URL to router.

package/dist/router/components/CanGoBackGuard.d.ts

@@ -3,8 +3,15 @@ import type { BackEvent } from '../../use-back-event';
 type SetIosSwipeGestureEnabled = ({ isEnabled }: {
     isEnabled: boolean;
 }) => Promise<void> | void;
-type SetIOSBackPressHandler = ({ handler }: {
-    handler: () => void;
+/**
+ * Registers the iOS back press handler. Called with empty params (`{}`, no
+ * `handler`) to unset — mirroring `unsetBackPressHandler()`, which calls
+ * `setBackPressHandler` with empty params. In that case implementations should
+ * initialize the registered handler to `null`, not keep an empty function
+ * registered.
+ */
+export type SetIOSBackPressHandler = ({ handler }: {
+    handler?: () => void;
 }) => Promise<void> | void;
 export declare function CanGoBackGuard({ children, canGoBack, hasBackEvent, onBack, isInitialScreen, setIosSwipeGestureEnabled, setiOSBackPressHandler, }: {
     canGoBack: boolean;

package/dist/router/index.d.ts

@@ -2,4 +2,5 @@ export * from './Router';
 export { getRouteScreens, getScreenPathMapConfig, defaultParserParams } from './utils';
 export * from './types';
 export * from './components/BackButton';
+export type { SetIOSBackPressHandler } from './components/CanGoBackGuard';
 export * from './components/useRouterBackHandler';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@granite-js/react-native",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "description": "The Granite Framework",
   "bin": {
     "granite": "./bin/cli.js"
@@ -91,8 +91,8 @@
     "@babel/core": "7.28.5",
     "@babel/preset-env": "7.28.5",
     "@babel/preset-typescript": "7.28.5",
-    "@granite-js/native": "1.0.39",
-    "@granite-js/vitest": "1.0.39",
+    "@granite-js/native": "1.0.40",
+    "@granite-js/vitest": "1.0.40",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.1.0",
     "@types/babel__core": "^7",
@@ -114,21 +114,21 @@
     "zod": "^4.1.12"
   },
   "peerDependencies": {
-    "@granite-js/native": "1.0.39",
+    "@granite-js/native": "1.0.40",
     "@types/react": "*",
     "brick-module": "*",
     "react": "*",
     "react-native": "*"
   },
   "dependencies": {
-    "@granite-js/blur-view": "1.0.39",
-    "@granite-js/brownfield-module": "1.0.39",
-    "@granite-js/cli": "1.0.39",
-    "@granite-js/jest": "1.0.39",
-    "@granite-js/mpack": "1.0.39",
-    "@granite-js/plugin-core": "1.0.39",
-    "@granite-js/style-utils": "1.0.39",
-    "@granite-js/video": "1.0.39",
+    "@granite-js/blur-view": "1.0.40",
+    "@granite-js/brownfield-module": "1.0.40",
+    "@granite-js/cli": "1.0.40",
+    "@granite-js/jest": "1.0.40",
+    "@granite-js/mpack": "1.0.40",
+    "@granite-js/plugin-core": "1.0.40",
+    "@granite-js/style-utils": "1.0.40",
+    "@granite-js/video": "1.0.40",
     "@standard-schema/spec": "^1.0.0",
     "es-toolkit": "^1.39.8",
     "react-native-url-polyfill": "3.0.0"

package/src/app/AppRoot.tsx

@@ -1,7 +1,7 @@
 import { SafeAreaProvider } from '@granite-js/native/react-native-safe-area-context';
 import type { ComponentType, PropsWithChildren } from 'react';
 import type { InitialProps } from '../initial-props';
-import { Router, type InternalRouterProps } from '../router';
+import { Router, type InternalRouterProps, type SetIOSBackPressHandler } from '../router';
 import { BackEventProvider } from '../use-back-event';
 import { App } from './App';
 import type { GraniteProps } from './Granite';
@@ -16,7 +16,7 @@ interface AppRootProps extends GraniteProps {
   initialProps: InitialProps;
   initialScheme: string;
   setIosSwipeGestureEnabled?: ({ isEnabled }: { isEnabled: boolean }) => void;
-  setiOSBackPressHandler?: ({ handler }: { handler: () => void }) => Promise<void> | void;
+  setiOSBackPressHandler?: SetIOSBackPressHandler;
   getInitialUrl: InternalRouterProps['getInitialUrl'];
 }
 

package/src/app/Granite.tsx

@@ -2,7 +2,7 @@ import { ComponentType, type JSX, PropsWithChildren } from 'react';
 import { AppRegistry } from 'react-native';
 import { ENTRY_BUNDLE_NAME } from '../constants';
 import type { InitialProps } from '../initial-props';
-import type { RouterProps, RequireContext } from '../router';
+import type { RouterProps, RequireContext, SetIOSBackPressHandler } from '../router';
 import { AppRoot } from './AppRoot';
 import { HostAppRoot } from './HostAppRoot';
 import { getSchemeUri } from '../constant-bridges';
@@ -42,8 +42,11 @@ export interface GraniteProps {
   /**
    * @description
    * The function to register a handler that runs when the iOS swipe back gesture is detected.
+   * Called with empty params (`{}`, no `handler`) when the handler should be unset — in
+   * that case the implementation must initialize the registered handler to `null`
+   * (e.g. call `unsetBackPressHandler()`), not keep an empty function registered.
    */
-  setiOSBackPressHandler?: ({ handler }: { handler: () => void }) => Promise<void> | void;
+  setiOSBackPressHandler?: SetIOSBackPressHandler;
 
   /**
    * @description

package/src/router/Router.tsx

@@ -20,7 +20,7 @@ import {
 import { InitialProps } from '..';
 import { closeView } from '../native-modules';
 import { BackButton } from './components/BackButton';
-import { CanGoBackGuard } from './components/CanGoBackGuard';
+import { CanGoBackGuard, type SetIOSBackPressHandler } from './components/CanGoBackGuard';
 import { StackNavigator } from './components/StackNavigator';
 import { useInternalRouterBackHandler } from './components/useRouterBackHandler';
 import { useRouterControls, type RouterControlsConfig } from './hooks/useRouterControls';
@@ -65,7 +65,7 @@ export interface InternalRouterProps {
   initialProps: InitialProps;
   initialScheme: string;
   setIosSwipeGestureEnabled?: ({ isEnabled }: { isEnabled: boolean }) => Promise<void> | void;
-  setiOSBackPressHandler?: ({ handler }: { handler: () => void }) => Promise<void> | void;
+  setiOSBackPressHandler?: SetIOSBackPressHandler;
   getInitialUrl?: RouterControlsConfig['getInitialUrl'];
 }
 

package/src/router/components/CanGoBackGuard.spec.tsx

@@ -73,7 +73,72 @@ describe('CanGoBackGuard', () => {
 
     unmount();
 
-    expect(setiOSBackPressHandler).toHaveBeenLastCalledWith({ handler: expect.any(Function) });
+    expect(setiOSBackPressHandler).toHaveBeenLastCalledWith({});
+  });
+
+  it('unsets the iOS back press handler on unmount so the registered handler is initialized to null', () => {
+    mockPlatformOS('ios');
+
+    let registeredHandler: (() => void) | null = null;
+    // destructures params like legacy host implementations — must not crash on unset
+    const setiOSBackPressHandler = vi.fn(({ handler }: { handler?: () => void }) => {
+      registeredHandler = handler ?? null;
+    });
+
+    const { unmount } = render(
+      <CanGoBackGuard
+        canGoBack={true}
+        hasBackEvent={true}
+        isInitialScreen={true}
+        setiOSBackPressHandler={setiOSBackPressHandler}
+      >
+        <div />
+      </CanGoBackGuard>
+    );
+
+    expect(registeredHandler).toEqual(expect.any(Function));
+
+    unmount();
+
+    expect(setiOSBackPressHandler).toHaveBeenLastCalledWith({});
+    expect(registeredHandler).toBeNull();
+  });
+
+  it('unsets the iOS back press handler when back events no longer exist', () => {
+    mockPlatformOS('ios');
+
+    let registeredHandler: (() => void) | null = null;
+    // destructures params like legacy host implementations — must not crash on unset
+    const setiOSBackPressHandler = vi.fn(({ handler }: { handler?: () => void }) => {
+      registeredHandler = handler ?? null;
+    });
+
+    const { rerender } = render(
+      <CanGoBackGuard
+        canGoBack={true}
+        hasBackEvent={true}
+        isInitialScreen={true}
+        setiOSBackPressHandler={setiOSBackPressHandler}
+      >
+        <div />
+      </CanGoBackGuard>
+    );
+
+    expect(registeredHandler).toEqual(expect.any(Function));
+
+    rerender(
+      <CanGoBackGuard
+        canGoBack={true}
+        hasBackEvent={false}
+        isInitialScreen={true}
+        setiOSBackPressHandler={setiOSBackPressHandler}
+      >
+        <div />
+      </CanGoBackGuard>
+    );
+
+    expect(setiOSBackPressHandler).toHaveBeenLastCalledWith({});
+    expect(registeredHandler).toBeNull();
   });
 
   it('disables iOS swipe when the current state should block default back navigation', () => {

package/src/router/components/CanGoBackGuard.tsx

@@ -3,7 +3,15 @@ import { BackHandler, Platform } from 'react-native';
 import type { BackEvent } from '../../use-back-event';
 
 type SetIosSwipeGestureEnabled = ({ isEnabled }: { isEnabled: boolean }) => Promise<void> | void;
-type SetIOSBackPressHandler = ({ handler }: { handler: () => void }) => Promise<void> | void;
+
+/**
+ * Registers the iOS back press handler. Called with empty params (`{}`, no
+ * `handler`) to unset — mirroring `unsetBackPressHandler()`, which calls
+ * `setBackPressHandler` with empty params. In that case implementations should
+ * initialize the registered handler to `null`, not keep an empty function
+ * registered.
+ */
+export type SetIOSBackPressHandler = ({ handler }: { handler?: () => void }) => Promise<void> | void;
 
 export function CanGoBackGuard({
   children,
@@ -74,7 +82,7 @@ export function CanGoBackGuard({
     });
 
     return () => {
-      setiOSBackPressHandler({ handler: () => {} });
+      setiOSBackPressHandler?.({});
     };
   }, [hasBackEvent, onBack, setiOSBackPressHandler]);
 

package/src/router/index.ts

@@ -2,4 +2,5 @@ export * from './Router';
 export { getRouteScreens, getScreenPathMapConfig, defaultParserParams } from './utils';
 export * from './types';
 export * from './components/BackButton';
+export type { SetIOSBackPressHandler } from './components/CanGoBackGuard';
 export * from './components/useRouterBackHandler';