@granite-js/react-native 0.0.0-dev-20250725013859

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Viva Republica, Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,24 @@
+# @granite-js/react-native
+
+The Granite Framework
+
+## License
+
+This software is licensed under the [Apache 2 license](LICENSE), quoted below.
+
+```
+Copyright 2025 Viva Republica, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+```

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('@granite-js/cli').initialize();

package/cli.d.ts

@@ -0,0 +1 @@
+export { initialize } from '@granite-js/cli';

package/cli.js

@@ -0,0 +1,4 @@
+const { initialize } = require('@granite-js/cli');
+module.exports = {
+  initialize,
+};

package/config.d.ts

@@ -0,0 +1,2 @@
+export * from '@granite-js/cli';
+export { Config as MpackConfig } from '@granite-js/mpack';

package/config.js

@@ -0,0 +1,5 @@
+const { defineConfig } = require('@granite-js/cli');
+
+module.exports = {
+  defineConfig,
+};

package/dist/app/App/index.android.d.ts

@@ -0,0 +1,2 @@
+import { Props } from '.';
+export declare function App({ children }: Props): import("react/jsx-runtime").JSX.Element;

package/dist/app/App/index.ios.d.ts

@@ -0,0 +1,6 @@
+import { Props } from '.';
+type IOSInitialProps = Props & {
+    isVisible: boolean;
+};
+export declare function App({ children, ...props }: IOSInitialProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/app/AppRoot.d.ts

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

package/dist/app/Granite.d.ts

@@ -0,0 +1,61 @@
+import { ComponentType, PropsWithChildren } from 'react';
+import type { InitialProps } from '../initial-props';
+import type { RouterProps, RequireContext } from '../router';
+export interface GraniteProps {
+    /**
+     * @description
+     * The name of the app.
+     */
+    appName: string;
+    /**
+     * @description
+     * The context of the app.
+     *
+     * @TODO Hide context
+     */
+    context: RequireContext;
+    /**
+     * @description
+     * Configuration object to be passed to the router.
+     */
+    router?: RouterProps;
+}
+/**
+ * @public
+ * @category Core
+ * @name Granite
+ * @description
+ *
+ * @property {RegisterService} registerApp - This function sets up the basic environment for your service and helps you start service development quickly without needing complex configuration. By just passing `appName`, you can immediately use various features such as file-based routing, query parameter handling, and back navigation control.
+ *
+ * The features provided by the `Granite.registerApp` function are as follows:
+ * - Routing: URLs are automatically mapped according to file paths. It works similarly to Next.js's file-based routing. For example, the `/my-service/pages/index.ts` file can be accessed at `scheme://my-service`, and the `/my-service/pages/home.ts` file can be accessed at `scheme://my-service/home`.
+ * - Query Parameters: You can easily use query parameters received through URL schemes. For example, you can receive a `referrer` parameter and log it.
+ * - Back Navigation Control: You can control back navigation events. For example, when a user presses back on a screen, you can show a dialog or close the screen.
+ * - Screen Visibility: You can determine whether a screen is visible or hidden from the user. For example, you can use this value to handle specific actions when a user leaves for the home screen.
+ *
+ * @example
+ *
+ * ### Example of creating with the `Granite` component
+ *
+ * ```tsx
+ * import { PropsWithChildren } from 'react';
+ * import { Granite, InitialProps } from '@granite-js/react-native';
+ * import { context } from '../require.context';
+ *
+ * function AppContainer({ children }: PropsWithChildren<InitialProps>) {
+ *  return <>{children}</>;
+ * }
+ *
+ * export default Granite.registerApp(AppContainer, {
+ *  appName: 'my-app',
+ *  context,
+ * });
+ *
+ * ```
+ */
+export declare const Granite: {
+    registerApp(AppContainer: ComponentType<PropsWithChildren<InitialProps>>, { appName, context, router }: GraniteProps): (initialProps: InitialProps) => JSX.Element;
+    registerHostApp(AppContainer: ComponentType<PropsWithChildren<InitialProps>>, { appName }: Pick<GraniteProps, "appName">): (initialProps: InitialProps) => JSX.Element;
+    readonly appName: string;
+};

package/dist/app/HostAppRoot.d.ts

@@ -0,0 +1 @@
+export declare function HostAppRoot({ container: Container, initialProps }: HostAppRootProps): import("react/jsx-runtime").JSX.Element;

package/dist/app/index.d.ts

@@ -0,0 +1,2 @@
+export { Granite } from './Granite';
+export type { GraniteProps } from './Granite';

package/dist/async-bridges.d.ts

@@ -0,0 +1,2 @@
+export * from './native-modules/natives/closeView';
+export * from './native-modules/natives/openURL';

package/dist/blur/BlurView.d.ts

@@ -0,0 +1,78 @@
+import type { BlurViewProps as InternalBlurViewProps } from '@granite-js/native/@react-native-community/blur';
+import { ViewProps } from 'react-native';
+export type BlurType = InternalBlurViewProps['blurType'];
+export interface BlurViewProps extends ViewProps {
+    blurType?: BlurType;
+    blurAmount?: number;
+    vibrancyEffect?: boolean;
+    reducedTransparencyFallbackColor?: string;
+}
+/**
+ * @public
+ * @category UI
+ * @name BlurView
+ * @description
+ * `BlurView` adds a blurred background effect, primarily on iOS. It creates a visual blur on the background view.
+ *
+ * This component is supported only on iOS. On Android, it simply renders a regular [`View`](https://reactnative.dev/docs/0.72/view) without any blur effect.
+ *
+ * You can control the blur intensity and optionally enable the [vibrancy effect](https://developer.apple.com/documentation/uikit/uivibrancyeffect?language=objc), which enhances the visual impact of content displayed over a blurred background.
+ *
+ * If blur is not supported or doesn't render properly, you can use the `reducedTransparencyFallbackColor` prop to set a fallback background color.
+ *
+ * Use the `isSupported` property to check whether the current device supports blur. Blur is available on iOS from version 5.126.0 and not supported on Android.
+ *
+ * @param {BlurViewProps} [props] The props you can pass to `BlurView`. It extends `react-native`'s `ViewProps`, so you can use layout and style properties. The props align with those of [`@react-native-community/blur`](https://github.com/Kureev/react-native-blur/tree/v4.3.2?tab=readme-ov-file#blurview).
+ * @param {BlurType} [props.blurType] Type of blur to apply, such as `light`, `dark`, or `extraDark`.
+ * @param {number} [props.blurAmount=10] Intensity of the blur effect. Higher values make the blur stronger. Accepts values from `0` to `100`. Default is `10`.
+ * @param {boolean} [props.vibrancyEffect=false] Enables the vibrancy effect. This effect enhances content displayed on top of the blur. Only supported on iOS. Default is `false`.
+ * @param {string} [props.reducedTransparencyFallbackColor] Fallback background color used when blur cannot be applied due to system settings or device limitations.
+ *
+ * @returns {JSX.Element} On iOS, returns a blurred `BlurView` or `VibrancyView` component. On Android, returns a regular `View` without blur.
+ *
+ * ::: warning Note
+ * `BlurView` is only supported on iOS. On Android, it renders a regular `View` without any blur effect.
+ * :::
+ *
+ * @example
+ *
+ * ### Blurring background behind a text
+ *
+ * ```tsx
+ * import { BlurView } from '@granite-js/react-native';
+ * import { View, Text, StyleSheet } from 'react-native';
+ *
+ * export function BlurViewExample() {
+ *   return (
+ *     <View style={styles.container}>
+ *       <Text style={styles.absolute}>Blurred Text</Text>
+ *       <BlurView style={styles.absolute} blurType="light" blurAmount={1} />
+ *       <Text>Non Blurred Text</Text>
+ *     </View>
+ *   );
+ * }
+ *
+ * const styles = StyleSheet.create({
+ *   container: {
+ *     justifyContent: 'center',
+ *     alignItems: 'center',
+ *     width: '100%',
+ *     height: 300,
+ *   },
+ *   absolute: {
+ *     position: 'absolute',
+ *     top: 0,
+ *     left: 0,
+ *     bottom: 0,
+ *     right: 0,
+ *   },
+ * });
+ * ```
+ *
+ * @see [iOS Vibrancy Effect Documentation](https://developer.apple.com/documentation/uikit/uivibrancyeffect)
+ * @see [Zeddios Blog Explanation](https://zeddios.tistory.com/1140)
+ */
+export declare function BlurView({ blurType, blurAmount, reducedTransparencyFallbackColor, vibrancyEffect, ...viewProps }: BlurViewProps): import("react/jsx-runtime").JSX.Element;
+export declare namespace BlurView {
+    var isSupported: boolean;
+}

package/dist/blur/ReactNativeBlurModule.d.ts

@@ -0,0 +1,6 @@
+import type { BlurView, VibrancyView } from '@granite-js/native/@react-native-community/blur';
+declare const ReactNativeBlurModule: {
+    BlurView: typeof BlurView;
+    VibrancyView: typeof VibrancyView;
+} | undefined;
+export { ReactNativeBlurModule };

package/dist/blur/constants.d.ts

@@ -0,0 +1 @@
+export declare const isBlurNativeModuleSupported: boolean;

package/dist/blur/index.d.ts

@@ -0,0 +1 @@
+export * from './BlurView';

package/dist/constant-bridges.d.ts

@@ -0,0 +1 @@
+export * from './native-modules/natives/getSchemeUri';

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const ENTRY_BUNDLE_NAME = "shared";

package/dist/dev-entrypoint/index.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentType } from 'react';
+export declare function register(Component: ComponentType<any>): void;

package/dist/event/abstract.d.ts

@@ -0,0 +1,42 @@
+export declare abstract class GraniteEventDefinition<O = undefined, R = void> {
+    abstract name: string;
+    /**
+     * Method to implement event logic.
+     * @param options - Event options (undefined if not used)
+     * @param onEvent - Callback called when the event is triggered.
+     * @param onError - Callback called on error (error type: unknown)
+     */
+    abstract listener(options: O, onEvent: (response: R) => void, onError: (error: unknown) => void): void;
+    /**
+     * Additional logic to execute when removing the event listener.
+     * If needed in the plugin, override this method and it will be called
+     * when the listener is removed.
+     */
+    abstract remove(): void;
+}
+/**
+ * GraniteEvent class registers event definition instances passed to the constructor.
+ * The addEventListener method only allows registered event names, and the types of passed
+ * options/callbacks are automatically inferred.
+ *
+ * Each subscription is uniquely identified by (event name + options).
+ */
+export declare class GraniteEvent<Defs extends GraniteEventDefinition<unknown, unknown>> {
+    private definitions;
+    private subscriptionGroups;
+    constructor(defs: Defs[]);
+    addEventListener<E extends Defs['name']>(eventName: E, listener: Extract<Defs, {
+        name: E;
+    }> extends GraniteEventDefinition<infer O, infer R> ? [O] extends [undefined] ? {
+        onEvent: (response: R) => void;
+        onError?: (error: unknown) => void;
+    } : {
+        options: O;
+        onEvent: (response: R) => void;
+        onError?: (error: unknown) => void;
+    } : never): () => void;
+    emit<E extends Defs['name']>(eventName: E, data: Extract<Defs, {
+        name: E;
+    }> extends GraniteEventDefinition<unknown, infer R> ? R : never): void;
+    private _getKey;
+}

package/dist/event/index.d.ts

@@ -0,0 +1,2 @@
+export * from './abstract';
+export * from './useGraniteEvent';

package/dist/event/useGraniteEvent.d.ts

@@ -0,0 +1,14 @@
+import { GraniteEvent, GraniteEventDefinition } from './abstract';
+import { BackEventControls } from '../use-back-event/useBackEvent';
+declare class BackEvent extends GraniteEventDefinition<void, void> {
+    private backEventControls;
+    name: "backEvent";
+    ref: {
+        remove: () => void;
+    };
+    constructor(backEventControls: BackEventControls);
+    remove(): void;
+    listener(_: void, onEvent: (response: void) => void): void;
+}
+export declare function useGraniteEvent(): GraniteEvent<BackEvent>;
+export {};