@granite-js/react-native 0.1.23 → 0.1.25

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @granite-js/react-native
 
+## 0.1.25
+
+### Patch Changes
+
+- 6717901: add getInitialUrl option
+  - @granite-js/cli@0.1.25
+  - @granite-js/image@0.1.25
+  - @granite-js/jest@0.1.25
+  - @granite-js/lottie@0.1.25
+  - @granite-js/mpack@0.1.25
+  - @granite-js/native@0.1.25
+  - @granite-js/plugin-core@0.1.25
+  - @granite-js/style-utils@0.1.25
+
+## 0.1.24
+
+### Patch Changes
+
+- Updated dependencies [6e42c3d]
+  - @granite-js/plugin-core@0.1.24
+  - @granite-js/mpack@0.1.24
+  - @granite-js/cli@0.1.24
+  - @granite-js/image@0.1.24
+  - @granite-js/jest@0.1.24
+  - @granite-js/lottie@0.1.24
+  - @granite-js/native@0.1.24
+  - @granite-js/style-utils@0.1.24
+
 ## 0.1.23
 
 ### Patch Changes

package/dist/app/AppRoot.d.ts

@@ -1 +1 @@
-export declare function AppRoot({ appName, context, container: Container, initialProps, initialScheme, router, setIosSwipeGestureEnabled, }: AppRootProps): import("react/jsx-runtime").JSX.Element;
+export declare function AppRoot({ appName, context, container: Container, initialProps, initialScheme, router, setIosSwipeGestureEnabled, getInitialUrl, }: AppRootProps): import("react/jsx-runtime").JSX.Element;

package/dist/app/Granite.d.ts

@@ -31,6 +31,13 @@ export interface GraniteProps {
     setIosSwipeGestureEnabled?: ({ isEnabled }: {
         isEnabled: boolean;
     }) => void;
+    /**
+     * @description
+     * The function to provide the initial URL to router.
+     * @param initialScheme The initial scheme of the app.
+     * @returns
+     */
+    getInitialUrl?: (initialScheme: string) => string | undefined | Promise<string | undefined>;
 }
 /**
  * @public
@@ -67,7 +74,7 @@ export interface GraniteProps {
  * ```
  */
 export declare const Granite: {
-    registerApp(AppContainer: ComponentType<PropsWithChildren<InitialProps>>, { appName, context, router, initialScheme, setIosSwipeGestureEnabled }: GraniteProps): (initialProps: InitialProps) => JSX.Element;
+    registerApp(AppContainer: ComponentType<PropsWithChildren<InitialProps>>, { appName, context, router, initialScheme, setIosSwipeGestureEnabled, getInitialUrl }: GraniteProps): (initialProps: InitialProps) => JSX.Element;
     registerHostApp(AppContainer: ComponentType<PropsWithChildren<InitialProps>>, { appName }: Pick<GraniteProps, "appName">): (initialProps: InitialProps) => JSX.Element;
     readonly appName: string;
 };

package/dist/router/Router.d.ts

@@ -55,5 +55,5 @@ type NavigationContainerProps = Pick<ComponentProps<typeof NavigationContainer>,
  * }
  * ```
  */
-export declare function Router({ prefix, context, container: Container, initialProps, initialScheme, navigationContainerRef, defaultScreenOption, screenContainer, setIosSwipeGestureEnabled, ...navigationContainerProps }: InternalRouterProps & RouterProps): ReactElement;
+export declare function Router({ prefix, context, container: Container, initialProps, initialScheme, navigationContainerRef, defaultScreenOption, screenContainer, setIosSwipeGestureEnabled, getInitialUrl, ...navigationContainerProps }: InternalRouterProps & RouterProps): ReactElement;
 export {};

package/dist/router/hooks/useRouterControls.d.ts

@@ -4,9 +4,10 @@ export interface RouterControlsConfig {
     prefix: string;
     initialScheme: string;
     context: RequireContext;
+    getInitialUrl?: (initialScheme: string) => string | undefined | Promise<string | undefined>;
     screenContainer?: ComponentType<PropsWithChildren<any>>;
 }
-export declare function useRouterControls({ prefix, context, screenContainer: ScreenContainer, initialScheme, }: RouterControlsConfig): {
+export declare function useRouterControls({ prefix, context, screenContainer: ScreenContainer, getInitialUrl, initialScheme, }: RouterControlsConfig): {
     Screens: import("react/jsx-runtime").JSX.Element[];
     linkingOptions: import("@react-navigation/native").LinkingOptions<{}>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@granite-js/react-native",
-  "version": "0.1.23",
+  "version": "0.1.25",
   "description": "The Granite Framework",
   "bin": {
     "granite": "./bin/cli.js"
@@ -86,7 +86,7 @@
     "@babel/core": "^7.24.9",
     "@babel/preset-env": "^7.24.8",
     "@babel/preset-typescript": "^7.24.7",
-    "@granite-js/native": "0.1.23",
+    "@granite-js/native": "0.1.25",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.1.0",
     "@types/babel__core": "^7",
@@ -112,13 +112,13 @@
     "react-native": "*"
   },
   "dependencies": {
-    "@granite-js/cli": "0.1.23",
-    "@granite-js/image": "0.1.23",
-    "@granite-js/jest": "0.1.23",
-    "@granite-js/lottie": "0.1.23",
-    "@granite-js/mpack": "0.1.23",
-    "@granite-js/plugin-core": "0.1.23",
-    "@granite-js/style-utils": "0.1.23",
+    "@granite-js/cli": "0.1.25",
+    "@granite-js/image": "0.1.25",
+    "@granite-js/jest": "0.1.25",
+    "@granite-js/lottie": "0.1.25",
+    "@granite-js/mpack": "0.1.25",
+    "@granite-js/plugin-core": "0.1.25",
+    "@granite-js/style-utils": "0.1.25",
     "es-toolkit": "^1.39.8",
     "react-native-url-polyfill": "1.3.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 } from '../router';
+import { Router, type InternalRouterProps } from '../router';
 import { BackEventProvider } from '../use-back-event';
 import { App } from './App';
 import type { GraniteProps } from './Granite';
@@ -16,6 +16,7 @@ interface AppRootProps extends GraniteProps {
   initialProps: InitialProps;
   initialScheme: string;
   setIosSwipeGestureEnabled?: ({ isEnabled }: { isEnabled: boolean }) => void;
+  getInitialUrl: InternalRouterProps['getInitialUrl'];
 }
 
 export function AppRoot({
@@ -26,6 +27,7 @@ export function AppRoot({
   initialScheme,
   router,
   setIosSwipeGestureEnabled,
+  getInitialUrl,
 }: AppRootProps) {
   const prefix = getSchemePrefix({
     appName,
@@ -45,6 +47,7 @@ export function AppRoot({
               container={Container}
               prefix={prefix}
               setIosSwipeGestureEnabled={setIosSwipeGestureEnabled}
+              getInitialUrl={getInitialUrl}
               {...router}
             />
           </BackEventProvider>

package/src/app/Granite.tsx

@@ -37,6 +37,14 @@ export interface GraniteProps {
    * The function to set the iOS swipe gesture enabled.
    */
   setIosSwipeGestureEnabled?: ({ isEnabled }: { isEnabled: boolean }) => void;
+
+  /**
+   * @description
+   * The function to provide the initial URL to router.
+   * @param initialScheme The initial scheme of the app.
+   * @returns
+   */
+  getInitialUrl?: (initialScheme: string) => string | undefined | Promise<string | undefined>;
 }
 
 const createApp = () => {
@@ -54,7 +62,7 @@ const createApp = () => {
   return {
     registerApp(
       AppContainer: ComponentType<PropsWithChildren<InitialProps>>,
-      { appName, context, router, initialScheme, setIosSwipeGestureEnabled }: GraniteProps
+      { appName, context, router, initialScheme, setIosSwipeGestureEnabled, getInitialUrl }: GraniteProps
     ): (initialProps: InitialProps) => JSX.Element {
       if (appName === ENTRY_BUNDLE_NAME) {
         throw new Error(`Reserved app name 'shared' cannot be used`);
@@ -67,6 +75,7 @@ const createApp = () => {
             initialProps={initialProps}
             initialScheme={initialScheme ?? getSchemeUri()}
             setIosSwipeGestureEnabled={setIosSwipeGestureEnabled}
+            getInitialUrl={getInitialUrl}
             appName={appName}
             context={context}
             router={router}

package/src/router/Router.tsx

@@ -15,7 +15,7 @@ import { CanGoBackGuard } from './components/CanGoBackGuard';
 import { StackNavigator } from './components/StackNavigator';
 import { useInternalRouterBackHandler } from './components/useRouterBackHandler';
 import { useInitialRouteName } from './hooks/useInitialRouteName';
-import { useRouterControls } from './hooks/useRouterControls';
+import { useRouterControls, type RouterControlsConfig } from './hooks/useRouterControls';
 import { RequireContext } from './types';
 import { BASE_STACK_NAVIGATOR_STYLE } from './types/screen-option';
 
@@ -57,6 +57,7 @@ export interface InternalRouterProps {
   initialProps: InitialProps;
   initialScheme: string;
   setIosSwipeGestureEnabled?: ({ isEnabled }: { isEnabled: boolean }) => Promise<void> | void;
+  getInitialUrl?: RouterControlsConfig['getInitialUrl'];
 }
 
 export type RouterProps = StackNavigatorProps & NavigationContainerProps;
@@ -131,6 +132,7 @@ export function Router({
   screenContainer,
   // Public props (StackNavigator)
   setIosSwipeGestureEnabled,
+  getInitialUrl,
   ...navigationContainerProps
 }: InternalRouterProps & RouterProps): ReactElement {
   const initialRouteName = useInitialRouteName({ prefix, initialScheme });
@@ -139,6 +141,7 @@ export function Router({
     context,
     screenContainer,
     initialScheme,
+    getInitialUrl,
   });
 
   const ref = useMemo(() => navigationContainerRef ?? createNavigationContainerRef<any>(), [navigationContainerRef]);

package/src/router/hooks/useRouterControls.tsx

@@ -14,6 +14,7 @@ export interface RouterControlsConfig {
   prefix: string;
   initialScheme: string;
   context: RequireContext;
+  getInitialUrl?: (initialScheme: string) => string | undefined | Promise<string | undefined>;
   screenContainer?: ComponentType<PropsWithChildren<any>>;
 }
 
@@ -21,6 +22,7 @@ export function useRouterControls({
   prefix,
   context,
   screenContainer: ScreenContainer,
+  getInitialUrl = defaultGetInitialUrl,
   initialScheme,
 }: RouterControlsConfig) {
   const routeScreens = useMemo(() => getRouteScreens(context), [context]);
@@ -61,15 +63,19 @@ export function useRouterControls({
         screens: getScreenPathMapConfig(registerScreens),
       },
       async getInitialURL() {
-        if (initialScheme == null) {
-          return;
-        }
-
-        /** @NOTE Korean paths need to be decoded. */
-        return decodeURI(initialScheme);
+        return (getInitialUrl ?? defaultGetInitialUrl)(initialScheme);
       },
     };
-  }, [initialScheme, prefix, registerScreens]);
+  }, [initialScheme, prefix, registerScreens, getInitialUrl]);
 
   return { Screens, linkingOptions };
 }
+
+function defaultGetInitialUrl(initialScheme: string) {
+  if (initialScheme == null) {
+    return;
+  }
+
+  /** @NOTE Korean paths need to be decoded. */
+  return decodeURI(initialScheme);
+}