@callstack/react-native-brownfield 2.0.1 → 2.0.2

package/README.md

@@ -1,5 +1,5 @@
 <a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=react-native-brownfield" align="center">
-  <img alt="React Native Brownfield" src="https://github.com/user-attachments/assets/55fcdff5-54f0-4081-adf6-55dfa5c29af2">
+  <img alt="React Native Brownfield" src="https://github.com/callstack/react-native-brownfield/raw/refs/heads/main/img/brownfield-banner.jpg">
 </a>
 
 <p align="center">
@@ -30,196 +30,16 @@
 - Works well with **any native navigation** pattern, as well as any React Native JavaScript-based navigation
 - Compatible with all native languages **Objective-C**, **Swift**, **Java** and **Kotlin**
 - Supports UIKit and SwiftUI on iOS and Fragments and Jetpack Compose on Android
+- Out-of-the-box **CLI** that automates the build process
 
-## React Native version compatibility matrix
+## Documentation
 
-| Tested React Native Version | React Native Brownfield Version |
-| --------------------------- | ------------------------------- |
-| 0.81.x, 0.82.x              | ^2.0.0-rc.0                     |
-| 0.78.x                      | ^1.2.0                          |
-
-## Installation
-
-The React Native Brownfield library is intended to be installed in a React Native app that is later consumed as a framework artifact by your native iOS or Android app.
-
-In your React Native project run:
-
-```sh
-npm install @callstack/react-native-brownfield
-```
-
-## Usage
+For full documentation, visit [our documentation](https://oss.callstack.com/react-native-brownfield/).
 
 <a href="https://www.callstack.com/ebooks/incremental-react-native-adoption-in-native-apps?utm_campaign=brownfield&utm_source=github&utm_medium=referral&utm_content=react-native-brownfield" align="center">
   <img alt="Download a free copy of Incremental React Native adoption in native apps ebook" src="https://github.com/user-attachments/assets/ba42bb29-1e7a-4683-80c5-2602afb1a7e6">
 </a>
 
-### Packaging React Native app as a framework
-
-First, we need to package our React Native app as an XCFramework or Fat-AAR.
-
-#### With Rock
-
-Follow [Integrating with Native Apps](https://www.rockjs.dev/docs/brownfield/intro) steps in Rock docs and run:
-
-- `rock package:ios` for iOS
-- `rock package:aar` for Android
-
-#### With custom scripts
-
-Instead of using Rock, you can create your own custom packaging scripts. Here are base versions for iOS and Android that you'll need to adjust for your project-specific setup:
-
-- [Example iOS script](https://github.com/callstackincubator/modern-brownfield-ref/blob/main/scripts/build-xcframework.sh)
-- [Example Android script](https://github.com/callstackincubator/modern-brownfield-ref/blob/main/scripts/build-aar.sh)
-
-### Native iOS app
-
-In your native iOS app, initialize React Native and display it where you like. For example, to display React Native views in SwiftUI, use the provided `ReactNativeView` component:
-
-```swift
-import SwiftUI
-import ReactBrownfield # exposed by RN app framework
-
-@main
-struct MyApp: App {
-  init() {
-    ReactNativeBrownfield.shared.startReactNative {
-      print("React Native bundle loaded")
-    }
-  }
-
-  var body: some Scene {
-    WindowGroup {
-      ContentView()
-    }
-  }
-}
-
-struct ContentView: View {
-  var body: some View {
-    NavigationView {
-      VStack {
-        Text("Welcome to the Native App")
-          .padding()
-
-        NavigationLink("Push React Native Screen") {
-          ReactNativeView(moduleName: "ReactNative")
-            .navigationBarHidden(true)
-        }
-      }
-    }
-  }
-}
-```
-
-For more detailed instructions and API for iOS, see docs for:
-
-- [Objective C](docs/OBJECTIVE_C.md)
-- [Swift](docs/SWIFT.md)
-
-### Native Android app
-
-In your native Android app, create a new `RNAppFragment.kt`:
-
-```kt
-
-import android.os.Bundle
-import android.view.LayoutInflater
-import android.view.View
-import android.view.ViewGroup
-import androidx.fragment.app.Fragment
-
-class RNAppFragment : Fragment() {
-    override fun onCreateView(
-        inflater: LayoutInflater,
-        container: ViewGroup?,
-        savedInstanceState: Bundle?,
-    ): View? = ReactNativeBrownfield.shared.createView(activity, "BrownFieldTest")
-}
-```
-
-Add a button to your `activity_main.xml`:
-
-```xml
-<Button
-    android:id="@+id/show_rn_app_btn"
-    android:layout_width="wrap_content"
-    android:layout_height="wrap_content"
-    android:text="Show RN App"
-    app:layout_constraintBottom_toBottomOf="parent"
-    app:layout_constraintEnd_toEndOf="parent"
-    app:layout_constraintStart_toStartOf="parent"
-    app:layout_constraintTop_toTopOf="parent" />
-```
-
-Add a fragment container:
-
-```xml
-<FrameLayout
-    android:id="@+id/fragmentContainer"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent" />
-```
-
-Update your `MainActivity` to initialize React Native and show the fragment:
-
-```kt
-class MainActivity : AppCompatActivity() {
-    private lateinit var showRNAppBtn: Button
-
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
-        ReactNativeHostManager.shared.initialize(this.application) {
-          println("JS bundle loaded")
-        }
-
-        showRNAppBtn = findViewById(R.id.show_rn_app_btn)
-        showRNAppBtn.setOnClickListener {
-            supportFragmentManager
-                .beginTransaction()
-                .replace(R.id.fragmentContainer, RNAppFragment())
-                .commit()
-        }
-    }
-
-}
-```
-
-For more detailed instructions and API for Android, see docs for:
-
-- [Java](docs/JAVA.md)
-- [Kotlin](docs/KOTLIN.md)
-
-### JavaScript Module
-
-Besides native components, we are exposing JavaScript functions to control the behavior of those components from React Native app.
-
-To use the module, import it:
-
-```js
-import ReactNativeBrownfield from '@callstack/react-native-brownfield';
-```
-
-and use the available methods:
-
-#### setNativeBackGestureAndButtonEnabled(enabled: boolean)
-
-A method used to toggle iOS native back gesture and Android hardware back button.
-
-```ts
-ReactNativeBrownfield.setNativeBackGestureAndButtonEnabled(true);
-```
-
-#### popToNative(animated[iOS only]: boolean)
-
-A method to pop to native screen used to push React Native experience.
-
-```ts
-ReactNativeBrownfield.popToNative(true);
-```
-
-> **Note:** These methods work only with native components provided by this library.
-
 ## Made with ❤️ at Callstack
 
 React Native Brownfield is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Callstack](https://callstack.com) is a group of React and React Native geeks, contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these or just want to say hi!
@@ -243,6 +63,7 @@ This project follows the [all-contributors](https://github.com/kentcdodds/all-co
 
 [build-badge]: https://img.shields.io/circleci/build/github/callstack/react-native-brownfield/master.svg?style=flat-square
 [build]: https://circleci.com/gh/callstack/react-native-brownfield
+[ci]: https://github.com/callstack/react-native-brownfield/actions/workflows/ci.yml/badge.svg
 [version-badge]: https://img.shields.io/npm/v/@callstack/react-native-brownfield.svg?style=flat-square
 [package]: https://www.npmjs.com/package/@callstack/react-native-brownfield
 [license-badge]: https://img.shields.io/npm/l/@callstack/react-native-brownfield.svg?style=flat-square
@@ -254,7 +75,7 @@ This project follows the [all-contributors](https://github.com/kentcdodds/all-co
 [all-contributors-badge]: https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square
 [chat-badge]: https://img.shields.io/discord/613446453762719798.svg?style=flat-square&colorB=758ED3
 [chat]: https://discord.gg/2SR9Mua
-[tweet-badge]: https://img.shields.io/badge/tweet-%23reacnativebrownfield-blue.svg?style=flat-square&colorB=1DA1F2&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAUCAYAAACXtf2DAAAAAXNSR0IArs4c6QAAAaRJREFUOBGtlM8rBGEYx3cWtRHJRaKcuMtBSitxkCQ3LtzkP9iUUu5ODspRHLhRLtq0FxeicEBC2cOivcge%2FMgan3fNM8bbzL4zm6c%2BPT%2Fe7%2FO8887svrFYBWbbtgWzsAt3sAcpqJFxxF1QV8oJFqFPFst5dLWQAT87oTgPB7DtziFRT1EA4yZolsFkhwjGYFRO8Op0KD8HVe7unoB6PRTBZG8IctAmG1xrHcfkQ2B55sfI%2ByGMXSBqV71xZ8CWdxBxN6ThFuECDEAL%2Bc9HIzDYumVZ966GZnX0SzCZvEqTbkaGywkyFE6hKAsBPhFQ18uPUqh2ggJ%2BUor%2F4M%2F%2FzOC8g6YzR1i%2F8g4vvSI%2ByD7FFNjexQrjHd8%2BnjABI3AU4Wl16TuF1qANGll81jsi5qu%2Bw6XIsCn4ijhU5FmCJpkV6BGNw410hfSf6JKBQ%2FUFxHGYBnWnmOwDwYQ%2BwzdHqO75HtiAMJfaC7ph32FSRJCENUhDHsLaJkL%2FX4wMF4%2BwA5bgAcrZE4sr0Cu9Jq9fxyrvBHWbNkMD5CEHWTjjT2m6r5D92jfmbbKJEWuMMAAAAABJRU5ErkJggg%3D%3D
+[tweet-badge]: https://img.shields.io/badge/tweet-%23reactnativebrownfield-blue.svg?style=flat-square&colorB=1DA1F2&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAUCAYAAACXtf2DAAAAAXNSR0IArs4c6QAAAaRJREFUOBGtlM8rBGEYx3cWtRHJRaKcuMtBSitxkCQ3LtzkP9iUUu5ODspRHLhRLtq0FxeicEBC2cOivcge%2FMgan3fNM8bbzL4zm6c%2BPT%2Fe7%2FO8887svrFYBWbbtgWzsAt3sAcpqJFxxF1QV8oJFqFPFst5dLWQAT87oTgPB7DtziFRT1EA4yZolsFkhwjGYFRO8Op0KD8HVe7unoB6PRTBZG8IctAmG1xrHcfkQ2B55sfI%2ByGMXSBqV71xZ8CWdxBxN6ThFuECDEAL%2Bc9HIzDYumVZ966GZnX0SzCZvEqTbkaGywkyFE6hKAsBPhFQ18uPUqh2ggJ%2BUor%2F4M%2F%2FzOC8g6YzR1i%2F8g4vvSI%2ByD7FFNjexQrjHd8%2BnjABI3AU4Wl16TuF1qANGll81jsi5qu%2Bw6XIsCn4ijhU5FmCJpkV6BGNw410hfSf6JKBQ%2FUFxHGYBnWnmOwDwYQ%2BwzdHqO75HtiAMJfaC7ph32FSRJCENUhDHsLaJkL%2FX4wMF4%2BwA5bgAcrZE4sr0Cu9Jq9fxyrvBHWbNkMD5CEHWTjjT2m6r5D92jfmbbKJEWuMMAAAAABJRU5ErkJggg%3D%3D
 [tweet]: https://twitter.com/intent/tweet?text=Check%20out%20react-native-brownfield!%20https://github.com/callstack/react-native-brownfield%20%F0%9F%91%8D
 [callstack-badge]: https://callstack.com/images/callstack-badge.svg
 [callstack]: https://callstack.com/open-source/?utm_source=github.com&utm_medium=referral&utm_campaign=rnbrownfield&utm_term=readme

package/android/gradle.properties

@@ -3,3 +3,6 @@ RNBrownfield_minSdkVersion=21
 RNBrownfield_targetSdkVersion=31
 RNBrownfield_compileSdkVersion=31
 RNBrownfield_ndkversion=21.4.7075529
+
+# Enable Gradle's build cache
+org.gradle.caching=true

package/android/proguard-rules.pro

@@ -18,4 +18,4 @@
 
 # If you keep the line number information, uncomment this to
 # hide the original source file name.
-#-renamesourcefileattribute SourceFile
+#-renamesourcefileattribute SourceFile

package/ios/ReactNativeBrownfieldModule.h

@@ -2,7 +2,7 @@
 
 #import <ReactNativeBrownfield/ReactNativeBrownfield.h>
 
-@interface ReactNativeBrownfieldModule : NSObject <NativeReactNativeBrownfieldModuleSpec>
+@interface ReactNativeBrownfieldModule : NativeReactNativeBrownfieldModuleSpecBase <NativeReactNativeBrownfieldModuleSpec>
 @end
 
 #endif

package/lib/commonjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/lib/commonjs/scripts/brownfield.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+var _brownfieldCli=require("@callstack/brownfield-cli");(0,_brownfieldCli.runCLI)(process.argv);
+//# sourceMappingURL=brownfield.js.map

package/lib/commonjs/scripts/brownfield.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_brownfieldCli","require","runCLI","process","argv"],"sourceRoot":"../../../src","sources":["scripts/brownfield.ts"],"mappings":"AAAA;AAEA,IAAAA,cAAA,CAAAC,OAAA,8BAEA,GAAAC,qBAAM,EAACC,OAAO,CAACC,IAAI,CAAC","ignoreList":[]}

package/lib/module/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/module/scripts/brownfield.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+var _brownfieldCli=require("@callstack/brownfield-cli");(0,_brownfieldCli.runCLI)(process.argv);
+//# sourceMappingURL=brownfield.js.map

package/lib/module/scripts/brownfield.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_brownfieldCli","require","runCLI","process","argv"],"sourceRoot":"../../../src","sources":["scripts/brownfield.ts"],"mappings":"AAAA;AAEA,IAAAA,cAAA,CAAAC,OAAA,8BAEA,GAAAC,qBAAM,EAACC,OAAO,CAACC,IAAI,CAAC","ignoreList":[]}

package/lib/typescript/commonjs/src/scripts/brownfield.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=brownfield.d.ts.map

package/lib/typescript/commonjs/src/scripts/brownfield.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brownfield.d.ts","sourceRoot":"","sources":["../../../../../src/scripts/brownfield.ts"],"names":[],"mappings":""}

package/lib/typescript/module/src/scripts/brownfield.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=brownfield.d.ts.map

package/lib/typescript/module/src/scripts/brownfield.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brownfield.d.ts","sourceRoot":"","sources":["../../../../../src/scripts/brownfield.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "@callstack/react-native-brownfield",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "license": "MIT",
   "author": "Michal Chudziak <mike.chudziak@callstack.com>",
+  "bin": {
+    "brownfield": "lib/commonjs/scripts/brownfield.js"
+  },
   "contributors": [
     "Piotr Drapich <piotr.drapich@callstack.com>"
   ],
   "homepage": "https://github.com/callstack/react-native-brownfield",
+  "repository": {
+    "url": "https://github.com/callstack/react-native-brownfield"
+  },
   "description": "Brownfield helpers for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -26,11 +32,13 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "lint": "eslint . --fix",
+    "lint": "eslint .",
     "typecheck": "tsc --noEmit",
-    "release": "release-it",
-    "prepare": "bob build",
-    "brownfield:plugin:publish:local": "bash ./gradle-plugins/publish-to-maven-local.sh"
+    "build": "bob build",
+    "dev": "nodemon --watch src --ext js,ts,json --exec \"bob build\"",
+    "build:brownfield": "yarn run build",
+    "prepack": "cp ../../README.md ./README.md",
+    "postpack": "rm ./README.md"
   },
   "keywords": [
     "react-native-brownfield",
@@ -54,80 +62,34 @@
     "!**/__tests__",
     "!**/__fixtures__",
     "!**/__mocks__",
-    "!**/.*"
+    "!**/.*",
+    "README.md"
   ],
   "publishConfig": {
     "access": "public"
   },
-  "resolutions": {
-    "@types/react": "19.1.1"
-  },
   "peerDependencies": {
     "react": "*",
     "react-native": "*"
   },
+  "dependencies": {
+    "@callstack/brownfield-cli": "workspace:^"
+  },
   "devDependencies": {
     "@babel/core": "^7.25.2",
     "@babel/preset-env": "^7.25.3",
     "@babel/runtime": "^7.25.0",
     "@react-native/babel-preset": "0.82.1",
-    "@react-native/eslint-config": "0.82.1",
-    "@react-native/typescript-config": "0.82.1",
-    "@release-it/conventional-changelog": "^5.0.0",
-    "@types/jest": "^29.5.13",
+    "@types/jest": "^30.0.0",
     "@types/react": "^19.1.1",
-    "@types/react-test-renderer": "^19.1.0",
-    "babel-plugin-module-resolver": "5.0.0",
-    "eslint": "^8.19.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "jest": "^29.6.3",
-    "prettier": "^3.5.3",
+    "eslint": "^9.28.0",
+    "globals": "^16.2.0",
+    "import": "^0.0.6",
+    "nodemon": "^3.1.11",
     "react": "19.1.1",
     "react-native": "0.82.1",
-    "react-native-builder-bob": "^0.37.0",
-    "react-test-renderer": "19.1.1",
-    "release-it": "^18.1.2",
-    "typescript": "5.8.3"
-  },
-  "release-it": {
-    "git": {
-      "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
-    },
-    "npm": {
-      "publish": true
-    },
-    "github": {
-      "release": true
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular"
-      }
-    }
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "@react-native",
-      "prettier"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    }
+    "react-native-builder-bob": "^0.40.17",
+    "typescript": "5.9.3"
   },
   "codegenConfig": {
     "name": "ReactNativeBrownfield",
@@ -137,42 +99,7 @@
       "javaPackageName": "com.callstack.reactnativebrownfield"
     }
   },
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
-  },
-  "react-native-builder-bob": {
-    "source": "src",
-    "output": "lib",
-    "targets": [
-      [
-        "commonjs",
-        {
-          "esm": true,
-          "configFile": true
-        }
-      ],
-      [
-        "module",
-        {
-          "esm": true,
-          "configFile": true
-        }
-      ],
-      [
-        "typescript",
-        {
-          "project": "tsconfig.build.json",
-          "esm": true
-        }
-      ]
-    ]
-  },
   "engines": {
     "node": ">=20"
-  },
-  "packageManager": "yarn@3.6.4"
+  }
 }

package/src/scripts/brownfield.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runCLI } from '@callstack/brownfield-cli';
+
+runCLI(process.argv);

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2019 Callstack
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.