@granite-js/micro-frontend 2.3.0 → 2.3.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @granite-js/micro-frontend
 
+## 2.3.2
+
+### Patch Changes
+
+- f92bbc7: Register pending host components with the configured app scheme so route evaluation works before an initial URL is available and does not inherit another app's scheme.
+  - @granite-js/utils@2.3.2
+
+## 2.3.1
+
+### Patch Changes
+
+- 56a5ce8: Support evaluating Android bundles packaged under `assets://` locators.
+  - @granite-js/utils@2.3.1
+
 ## 2.3.0
 
 ### Minor Changes

package/README.md

@@ -168,7 +168,8 @@ app name exactly rather than routing it to another remote.
 ## JavaScript runtime
 
 The adapter owns bundle selection, download, integrity verification, and
-caching. It returns an absolute local bundle path.
+caching. It returns an absolute local bundle path, or an Android `assets://`
+locator for a bundle packaged in the application.
 
 ```ts
 import { createMicroFrontendRuntime } from '@granite-js/micro-frontend';
@@ -220,7 +221,7 @@ The public runtime API is:
 | -------------------------- | --------------------------------------------------------------- |
 | `preloadApp(appName)`      | Load and evaluate one app without importing an exposed module.  |
 | `importApp(request)`       | Ensure the app is evaluated and import `appName/exposedModule`. |
-| `evaluateScript(filePath)` | Evaluate an already-local bundle in the retained runtime.       |
+| `evaluateScript(filePath)` | Evaluate a local file or Android packaged asset in the retained runtime. |
 | `onEvent(listener)`        | Subscribe to native open, close, and visibility events.         |
 
 The host can provide `onLifecycleEvent` when creating the runtime for logging
@@ -371,7 +372,8 @@ The brownfield application must:
    boundary;
 4. bind native screen lifecycle to the session APIs below;
 5. install a Portal destination with the same `sessionId`;
-6. provide `adapter.loadBundle()` and return an absolute verified bundle path;
+6. provide `adapter.loadBundle()` and return an absolute verified bundle path,
+   or an Android `assets://` locator for a verified packaged bundle;
 7. keep the React tree mounted until native teardown emits `closeApp`; and
 8. keep Granite's base brownfield view APIs, such as scheme resolution and
    closing the current Granite view, in the Granite host integration. They are

package/android/src/main/cpp/BundleEvaluator.cpp

@@ -5,6 +5,7 @@
 
 namespace granite::microfrontend {
 
+using facebook::jni::JArrayByte;
 using facebook::jni::JString;
 using facebook::jni::alias_ref;
 using facebook::jsi::Runtime;
@@ -12,7 +13,29 @@ using facebook::jsi::StringBuffer;
 
 void BundleEvaluator::registerNatives() {
   registerHybrid(
-      {makeNativeMethod("evaluateFileSync", BundleEvaluator::evaluateFileSync)});
+      {makeNativeMethod("evaluateFileSync", BundleEvaluator::evaluateFileSync),
+       makeNativeMethod("evaluateScriptSync", BundleEvaluator::evaluateScriptSync)});
+}
+
+void BundleEvaluator::evaluateScriptSync(
+    alias_ref<jhybridobject>,
+    jlong runtimePointer,
+    alias_ref<JArrayByte> scriptData,
+    alias_ref<JString> sourceUrl) {
+  if (runtimePointer == 0) {
+    facebook::jni::throwNewJavaException(
+        "java/lang/IllegalStateException", "JavaScript runtime is unavailable");
+    return;
+  }
+
+  auto pinnedScriptData = scriptData->pin();
+  std::string source{
+      reinterpret_cast<const char *>(pinnedScriptData.get()),
+      pinnedScriptData.size()};
+  auto *runtime = reinterpret_cast<Runtime *>(runtimePointer);
+  runtime->evaluateJavaScript(
+      std::make_shared<StringBuffer>(std::move(source)),
+      sourceUrl->toStdString());
 }
 
 void BundleEvaluator::evaluateFileSync(

package/android/src/main/cpp/BundleEvaluator.h

@@ -15,6 +15,12 @@ struct BundleEvaluator : facebook::jni::HybridClass<BundleEvaluator> {
       jlong runtimePointer,
       facebook::jni::alias_ref<facebook::jni::JString> filePath,
       facebook::jni::alias_ref<facebook::jni::JString> sourceUrl);
+
+  static void evaluateScriptSync(
+      facebook::jni::alias_ref<jhybridobject>,
+      jlong runtimePointer,
+      facebook::jni::alias_ref<facebook::jni::JArrayByte> scriptData,
+      facebook::jni::alias_ref<facebook::jni::JString> sourceUrl);
 };
 
 } // namespace granite::microfrontend

package/android/src/main/java/run/granite/microfrontend/BundleEvaluator.kt

@@ -1,11 +1,48 @@
 package run.granite.microfrontend
 
+import android.content.res.AssetManager
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.common.annotations.FrameworkAPI
 import java.io.File
 import java.io.FileNotFoundException
 import java.io.IOException
 
+internal sealed interface ResolvedBundleSource {
+    val sourceUrl: String
+
+    data class Asset(
+        val scriptData: ByteArray,
+        override val sourceUrl: String,
+    ) : ResolvedBundleSource
+
+    data class FilePath(
+        val filePath: String,
+        override val sourceUrl: String,
+    ) : ResolvedBundleSource
+}
+
+internal fun resolveBundleSource(assetManager: AssetManager, bundlePath: String): ResolvedBundleSource {
+    if (bundlePath.startsWith(ASSET_PREFIX)) {
+        val assetPath = bundlePath.removePrefix(ASSET_PREFIX)
+        require(assetPath.isNotBlank()) { "Bundle asset path must not be blank: $bundlePath" }
+        val scriptData = assetManager.open(assetPath).use { it.readBytes() }
+        if (scriptData.isEmpty()) {
+            throw IOException("Bundle asset is empty: $bundlePath")
+        }
+        return ResolvedBundleSource.Asset(scriptData, bundlePath)
+    }
+
+    val file = File(bundlePath)
+    require(file.isAbsolute) { "Bundle path must be absolute: $bundlePath" }
+    if (!file.exists()) {
+        throw FileNotFoundException("Bundle file does not exist: $bundlePath")
+    }
+    if (!file.canRead()) {
+        throw IOException("Bundle file is not readable: $bundlePath")
+    }
+    return ResolvedBundleSource.FilePath(bundlePath, file.toURI().toString())
+}
+
 @OptIn(FrameworkAPI::class)
 internal class BundleEvaluator(
     private val reactContext: ReactApplicationContext,
@@ -22,20 +59,21 @@ internal class BundleEvaluator(
         sourceUrl: String,
     )
 
+    private external fun evaluateScriptSync(
+        runtimePointer: Long,
+        scriptData: ByteArray,
+        sourceUrl: String,
+    )
+
     @Throws(FileNotFoundException::class, IOException::class)
     fun evaluateFile(filePath: String) {
-        val file = File(filePath)
-        require(file.isAbsolute) { "Bundle path must be absolute: $filePath" }
-        if (!file.exists()) {
-            throw FileNotFoundException("Bundle file does not exist: $filePath")
-        }
-        if (!file.canRead()) {
-            throw IOException("Bundle file is not readable: $filePath")
-        }
-
+        val source = resolveBundleSource(reactContext.assets, filePath)
         val runtimePointer = reactContext.javaScriptContextHolder?.get()
             ?: throw IllegalStateException("JavaScript runtime is unavailable")
-        evaluateFileSync(runtimePointer, filePath, file.toURI().toString())
+        when (source) {
+            is ResolvedBundleSource.Asset -> evaluateScriptSync(runtimePointer, source.scriptData, source.sourceUrl)
+            is ResolvedBundleSource.FilePath -> evaluateFileSync(runtimePointer, source.filePath, source.sourceUrl)
+        }
     }
 
     private companion object {
@@ -44,3 +82,5 @@ internal class BundleEvaluator(
         }
     }
 }
+
+private const val ASSET_PREFIX = "assets://"

package/android/src/test/java/run/granite/microfrontend/BundleEvaluatorTest.kt

@@ -0,0 +1,42 @@
+package run.granite.microfrontend
+
+import android.content.res.AssetManager
+import org.junit.Assert.assertArrayEquals
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertTrue
+import org.junit.Test
+import org.mockito.Mockito.mock
+import org.mockito.Mockito.verify
+import org.mockito.Mockito.`when`
+import java.io.ByteArrayInputStream
+import java.io.File
+
+class BundleEvaluatorTest {
+    @Test
+    fun `asset bundle locator reads the built-in bundle through AssetManager`() {
+        val assetManager = mock(AssetManager::class.java)
+        val scriptData = "built-in bundle".toByteArray()
+        `when`(assetManager.open("bundles/example.hbc")).thenReturn(ByteArrayInputStream(scriptData))
+
+        val source = resolveBundleSource(assetManager, "assets://bundles/example.hbc")
+
+        assertTrue(source is ResolvedBundleSource.Asset)
+        assertArrayEquals(scriptData, (source as ResolvedBundleSource.Asset).scriptData)
+        assertEquals("assets://bundles/example.hbc", source.sourceUrl)
+        verify(assetManager).open("bundles/example.hbc")
+    }
+
+    @Test
+    fun `absolute file path keeps filesystem bundle evaluation`() {
+        val bundleFile = File.createTempFile("granite-micro-frontend", ".hbc")
+        try {
+            val source = resolveBundleSource(mock(AssetManager::class.java), bundleFile.absolutePath)
+
+            assertTrue(source is ResolvedBundleSource.FilePath)
+            assertEquals(bundleFile.absolutePath, (source as ResolvedBundleSource.FilePath).filePath)
+            assertEquals(bundleFile.toURI().toString(), source.sourceUrl)
+        } finally {
+            bundleFile.delete()
+        }
+    }
+}

package/dist/module/createRoute.js

@@ -1,6 +1,6 @@
 "use strict";
 
-import { createRoute as createGraniteRoute, getSchemeUri } from '@granite-js/react-native';
+import { createRoute as createGraniteRoute } from '@granite-js/react-native';
 import { registerPendingHostComponentRoute } from "./host/pendingHostComponentStore.js";
 export function createRoute(path, options) {
   const {
@@ -27,10 +27,10 @@ function getCurrentGraniteApp() {
   }
   const host = granite['app']['host'];
   const name = granite['app']['name'];
-  if (typeof host !== 'string' || typeof name !== 'string') {
+  const scheme = granite['app']['scheme'];
+  if (typeof host !== 'string' || typeof name !== 'string' || typeof scheme !== 'string') {
     return null;
   }
-  const scheme = new URL(getSchemeUri()).protocol.replace(/:$/g, '');
   return {
     name,
     scheme,

package/dist/module/createRoute.js.map

@@ -1 +1 @@
-{"version":3,"names":["createRoute","createGraniteRoute","getSchemeUri","registerPendingHostComponentRoute","path","options","hostPendingComponent","routeOptions","app","getCurrentGraniteApp","String","component","parserParams","validateParams","granite","Reflect","get","globalThis","isPropertyMap","host","name","scheme","URL","protocol","replace","value"],"sourceRoot":"../../src","sources":["createRoute.ts"],"mappings":";;AAAA,SACEA,WAAW,IAAIC,kBAAkB,EACjCC,YAAY,QAIP,0BAA0B;AAEjC,SAASC,iCAAiC,QAAQ,qCAAkC;AA+BpF,OAAO,SAASH,WAAWA,CACzBI,IAA+B,EAC/BC,OAA2C,EAC3C;EACA,MAAM;IAAEC,oBAAoB;IAAE,GAAGC;EAAa,CAAC,GAAGF,OAAO;EAEzD,IAAIC,oBAAoB,IAAI,IAAI,EAAE;IAChC,MAAME,GAAG,GAAGC,oBAAoB,CAAC,CAAC;IAClC,IAAID,GAAG,IAAI,IAAI,EAAE;MACfL,iCAAiC,CAACO,MAAM,CAACN,IAAI,CAAC,EAAE;QAC9CI,GAAG;QACHG,SAAS,EAAEL,oBAAoB;QAC/BM,YAAY,EAAEL,YAAY,CAACK,YAAY;QACvCC,cAAc,EAAEN,YAAY,CAACM;MAC/B,CAAC,CAAC;IACJ;EACF;EAEA,OAAOZ,kBAAkB,CAACG,IAAI,EAAEG,YAAY,CAAC;AAC/C;AAEA,SAASE,oBAAoBA,CAAA,EAAyC;EACpE,MAAMK,OAAgB,GAAGC,OAAO,CAACC,GAAG,CAACC,UAAU,EAAE,WAAW,CAAC;EAC7D,IAAI,CAACC,aAAa,CAACJ,OAAO,CAAC,IAAI,CAACI,aAAa,CAACJ,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE;IAC7D,OAAO,IAAI;EACb;EAEA,MAAMK,IAAI,GAAGL,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;EACnC,MAAMM,IAAI,GAAGN,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;EACnC,IAAI,OAAOK,IAAI,KAAK,QAAQ,IAAI,OAAOC,IAAI,KAAK,QAAQ,EAAE;IACxD,OAAO,IAAI;EACb;EAEA,MAAMC,MAAM,GAAG,IAAIC,GAAG,CAACpB,YAAY,CAAC,CAAC,CAAC,CAACqB,QAAQ,CAACC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;EAElE,OAAO;IACLJ,IAAI;IACJC,MAAM;IACNF;EACF,CAAC;AACH;AAEA,SAASD,aAAaA,CAACO,KAAc,EAAmD;EACtF,OAAO,OAAOA,KAAK,KAAK,QAAQ,IAAIA,KAAK,KAAK,IAAI;AACpD","ignoreList":[]}
+{"version":3,"names":["createRoute","createGraniteRoute","registerPendingHostComponentRoute","path","options","hostPendingComponent","routeOptions","app","getCurrentGraniteApp","String","component","parserParams","validateParams","granite","Reflect","get","globalThis","isPropertyMap","host","name","scheme","value"],"sourceRoot":"../../src","sources":["createRoute.ts"],"mappings":";;AAAA,SACEA,WAAW,IAAIC,kBAAkB,QAI5B,0BAA0B;AAEjC,SAASC,iCAAiC,QAAQ,qCAAkC;AA+BpF,OAAO,SAASF,WAAWA,CACzBG,IAA+B,EAC/BC,OAA2C,EAC3C;EACA,MAAM;IAAEC,oBAAoB;IAAE,GAAGC;EAAa,CAAC,GAAGF,OAAO;EAEzD,IAAIC,oBAAoB,IAAI,IAAI,EAAE;IAChC,MAAME,GAAG,GAAGC,oBAAoB,CAAC,CAAC;IAClC,IAAID,GAAG,IAAI,IAAI,EAAE;MACfL,iCAAiC,CAACO,MAAM,CAACN,IAAI,CAAC,EAAE;QAC9CI,GAAG;QACHG,SAAS,EAAEL,oBAAoB;QAC/BM,YAAY,EAAEL,YAAY,CAACK,YAAY;QACvCC,cAAc,EAAEN,YAAY,CAACM;MAC/B,CAAC,CAAC;IACJ;EACF;EAEA,OAAOX,kBAAkB,CAACE,IAAI,EAAEG,YAAY,CAAC;AAC/C;AAEA,SAASE,oBAAoBA,CAAA,EAAyC;EACpE,MAAMK,OAAgB,GAAGC,OAAO,CAACC,GAAG,CAACC,UAAU,EAAE,WAAW,CAAC;EAC7D,IAAI,CAACC,aAAa,CAACJ,OAAO,CAAC,IAAI,CAACI,aAAa,CAACJ,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE;IAC7D,OAAO,IAAI;EACb;EAEA,MAAMK,IAAI,GAAGL,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;EACnC,MAAMM,IAAI,GAAGN,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;EACnC,MAAMO,MAAM,GAAGP,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC;EACvC,IAAI,OAAOK,IAAI,KAAK,QAAQ,IAAI,OAAOC,IAAI,KAAK,QAAQ,IAAI,OAAOC,MAAM,KAAK,QAAQ,EAAE;IACtF,OAAO,IAAI;EACb;EAEA,OAAO;IACLD,IAAI;IACJC,MAAM;IACNF;EACF,CAAC;AACH;AAEA,SAASD,aAAaA,CAACI,KAAc,EAAmD;EACtF,OAAO,OAAOA,KAAK,KAAK,QAAQ,IAAIA,KAAK,KAAK,IAAI;AACpD","ignoreList":[]}

package/dist/typescript/types.d.ts

@@ -3,6 +3,7 @@ export interface MicroFrontendBundleRequest {
     readonly appName: string;
 }
 export interface MicroFrontendBundle {
+    /** An absolute local file path, or an Android `assets://` locator for a packaged bundle. */
     readonly filePath: string;
 }
 export interface MicroFrontendAppProps {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@granite-js/micro-frontend",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Micro-frontend build, runtime, session, and Portal contracts for Granite brownfield applications",
   "main": "./dist/module/index.js",
   "types": "./dist/typescript/index.d.ts",
@@ -56,7 +56,7 @@
   },
   "dependencies": {
     "@babel/core": "7.28.5",
-    "@granite-js/utils": "2.3.0",
+    "@granite-js/utils": "2.3.2",
     "@standard-schema/spec": "^1.0.0"
   },
   "peerDependencies": {
@@ -72,8 +72,8 @@
   },
   "devDependencies": {
     "@babel/types": "7.28.5",
-    "@granite-js/plugin-core": "2.3.0",
-    "@granite-js/react-native": "2.3.0",
+    "@granite-js/plugin-core": "2.3.2",
+    "@granite-js/react-native": "2.3.2",
     "@types/babel__core": "^7.20.5",
     "@types/node": "24.10.12",
     "@types/react": "19.2.0",

package/src/createRoute.ts

@@ -1,6 +1,5 @@
 import {
   createRoute as createGraniteRoute,
-  getSchemeUri,
   type RegisterScreenInput,
   type RouteOptions,
   useNavigation,
@@ -66,12 +65,11 @@ function getCurrentGraniteApp(): PendingHostComponentAppConfig | null {
 
   const host = granite['app']['host'];
   const name = granite['app']['name'];
-  if (typeof host !== 'string' || typeof name !== 'string') {
+  const scheme = granite['app']['scheme'];
+  if (typeof host !== 'string' || typeof name !== 'string' || typeof scheme !== 'string') {
     return null;
   }
 
-  const scheme = new URL(getSchemeUri()).protocol.replace(/:$/g, '');
-
   return {
     name,
     scheme,

package/src/types.ts

@@ -5,6 +5,7 @@ export interface MicroFrontendBundleRequest {
 }
 
 export interface MicroFrontendBundle {
+  /** An absolute local file path, or an Android `assets://` locator for a packaged bundle. */
   readonly filePath: string;
 }