@granite-js/react-native 1.0.42 → 1.0.43

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @granite-js/react-native
 
+## 1.0.43
+
+### Patch Changes
+
+- afd4e50: feat(react-native): export InitialPropsProvider
+  - @granite-js/blur-view@1.0.43
+  - @granite-js/brownfield-module@1.0.43
+  - @granite-js/cli@1.0.43
+  - @granite-js/jest@1.0.43
+  - @granite-js/mpack@1.0.43
+  - @granite-js/native@1.0.43
+  - @granite-js/plugin-core@1.0.43
+  - @granite-js/style-utils@1.0.43
+  - @granite-js/video@1.0.43
+
 ## 1.0.42
 
 ### Patch Changes

package/dist/app/context/InitialPropsContext.d.ts

@@ -1,6 +1,33 @@
 import { type PropsWithChildren } from 'react';
 import { InitialProps } from '../../initial-props';
 export declare const InitialPropsContext: import("react").Context<InitialProps | null>;
+/**
+ * @public
+ * @name InitialPropsProvider
+ * @category Core
+ * @description Provides the initial data passed from the native platform (Android or iOS) to `useInitialProps` and `useInitialSearchParams`. `Granite.registerApp` already renders this provider, so you only need it when you register the root component yourself instead of going through the router.
+ * @param {InitialProps} initialProps - Initial data the native platform passed to the root component.
+ * @param {ReactNode | undefined} children - Child components that read the initial data.
+ * @returns {ReactElement} A React Provider component.
+ * @example
+ *
+ * ### Registering a root component without the router
+ *
+ * ```tsx
+ * import { AppRegistry } from 'react-native';
+ * import { InitialPropsProvider, type InitialProps } from '@granite-js/react-native';
+ *
+ * function App(initialProps: InitialProps) {
+ *   return (
+ *     <InitialPropsProvider initialProps={initialProps}>
+ *       <MyApp />
+ *     </InitialPropsProvider>
+ *   );
+ * }
+ *
+ * AppRegistry.registerComponent('my-app', () => App);
+ * ```
+ */
 export declare function InitialPropsProvider({ children, initialProps }: PropsWithChildren<{
     initialProps: InitialProps;
 }>): import("react/jsx-runtime").JSX.Element;

package/dist/app/index.d.ts

@@ -1,4 +1,4 @@
-export { useInitialProps } from './context/InitialPropsContext';
+export { InitialPropsProvider, useInitialProps } from './context/InitialPropsContext';
 export { useInitialSearchParams } from './context/useInitialSearchParams';
 export { Granite } from './Granite';
 export type { GraniteProps } from './Granite';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import './types/global';
-export { Granite, useInitialSearchParams, useInitialProps } from './app';
+export { Granite, InitialPropsProvider, useInitialSearchParams, useInitialProps } from './app';
 export * from '@granite-js/style-utils';
 export { type GraniteImageSource, type GraniteImageStatic, type ResizeMode, type CachePolicy, type Priority, type OnLoadEvent, type OnProgressEvent, } from '@granite-js/native/react-native-fast-image';
 export * from './image';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@granite-js/react-native",
-  "version": "1.0.42",
+  "version": "1.0.43",
   "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.42",
-    "@granite-js/vitest": "1.0.42",
+    "@granite-js/native": "1.0.43",
+    "@granite-js/vitest": "1.0.43",
     "@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.42",
+    "@granite-js/native": "1.0.43",
     "@types/react": "*",
     "brick-module": "*",
     "react": "*",
     "react-native": "*"
   },
   "dependencies": {
-    "@granite-js/blur-view": "1.0.42",
-    "@granite-js/brownfield-module": "1.0.42",
-    "@granite-js/cli": "1.0.42",
-    "@granite-js/jest": "1.0.42",
-    "@granite-js/mpack": "1.0.42",
-    "@granite-js/plugin-core": "1.0.42",
-    "@granite-js/style-utils": "1.0.42",
-    "@granite-js/video": "1.0.42",
+    "@granite-js/blur-view": "1.0.43",
+    "@granite-js/brownfield-module": "1.0.43",
+    "@granite-js/cli": "1.0.43",
+    "@granite-js/jest": "1.0.43",
+    "@granite-js/mpack": "1.0.43",
+    "@granite-js/plugin-core": "1.0.43",
+    "@granite-js/style-utils": "1.0.43",
+    "@granite-js/video": "1.0.43",
     "@standard-schema/spec": "^1.0.0",
     "es-toolkit": "^1.39.8",
     "react-native-url-polyfill": "3.0.0"

package/src/app/context/InitialPropsContext.tsx

@@ -3,6 +3,33 @@ import { InitialProps } from '../../initial-props';
 
 export const InitialPropsContext = createContext<InitialProps | null>(null);
 
+/**
+ * @public
+ * @name InitialPropsProvider
+ * @category Core
+ * @description Provides the initial data passed from the native platform (Android or iOS) to `useInitialProps` and `useInitialSearchParams`. `Granite.registerApp` already renders this provider, so you only need it when you register the root component yourself instead of going through the router.
+ * @param {InitialProps} initialProps - Initial data the native platform passed to the root component.
+ * @param {ReactNode | undefined} children - Child components that read the initial data.
+ * @returns {ReactElement} A React Provider component.
+ * @example
+ *
+ * ### Registering a root component without the router
+ *
+ * ```tsx
+ * import { AppRegistry } from 'react-native';
+ * import { InitialPropsProvider, type InitialProps } from '@granite-js/react-native';
+ *
+ * function App(initialProps: InitialProps) {
+ *   return (
+ *     <InitialPropsProvider initialProps={initialProps}>
+ *       <MyApp />
+ *     </InitialPropsProvider>
+ *   );
+ * }
+ *
+ * AppRegistry.registerComponent('my-app', () => App);
+ * ```
+ */
 export function InitialPropsProvider({ children, initialProps }: PropsWithChildren<{ initialProps: InitialProps }>) {
   return <InitialPropsContext.Provider value={initialProps}>{children}</InitialPropsContext.Provider>;
 }

package/src/app/index.ts

@@ -1,4 +1,4 @@
-export { useInitialProps } from './context/InitialPropsContext';
+export { InitialPropsProvider, useInitialProps } from './context/InitialPropsContext';
 export { useInitialSearchParams } from './context/useInitialSearchParams';
 export { Granite } from './Granite';
 export type { GraniteProps } from './Granite';

package/src/index.ts

@@ -1,6 +1,6 @@
 import './types/global';
 
-export { Granite, useInitialSearchParams, useInitialProps } from './app';
+export { Granite, InitialPropsProvider, useInitialSearchParams, useInitialProps } from './app';
 export * from '@granite-js/style-utils';
 export {
   type GraniteImageSource,