create-mithril-lynx 2.4.0 → 2.5.2

package/templates/_shared/ts/package.json

@@ -9,7 +9,7 @@
     "preview": "rspeedy preview"
   },
   "dependencies": {
-    "mithril-runtime": "^1.1.0",
+    "mithril-runtime": "latest",
     "mithril-lynx": "{{MITHRIL_LYNX_VERSION}}"
   },
   "devDependencies": {

package/templates/_shared/ts/src/rspeedy-env.d.ts

@@ -1,3 +1,21 @@
 /// <reference types="@lynx-js/rspeedy/client" />
 /// <reference types="@lynx-js/types" />
 /// <reference types="@lynx-js/type-element-api" />
+
+declare module "@lynx-js/types" {
+	interface NativeModules {
+		/** Android host bridge used by mithril-lynx/route.listenBackButton(). */
+		MithrilLynxNavigationModule?: {
+			setCanGoBack(canGoBack: boolean): void;
+		};
+		LynxBatteryPlugin?: { getStatus(requestId: string): void };
+		LynxCameraPlugin?: { takePhoto(requestId: string): void };
+		LynxDevicePlugin?: { getInfo(requestId: string): void };
+		LynxGeolocationPlugin?: { getCurrentPosition(requestId: string, highAccuracy: boolean): void };
+		LynxNetworkPlugin?: { getInfo(requestId: string): void };
+		LynxVibrationPlugin?: {
+			vibrate(requestId: string, durationMs: number): void;
+			cancel(requestId: string): void;
+		};
+	}
+}

package/templates/android/app-scripts/android-prepare.mjs

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+/**
+ * Copies the Android resources kept beside the JS source into the sibling
+ * Gradle host. Edit <project>/android/*.xml, then run:
+ *
+ *   bun run android:prepare
+ */
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const projectRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
+const sourceDir = path.join(projectRoot, "android");
+const androidDir = path.resolve(projectRoot, "{{ANDROID_REL_DIR}}");
+
+const files = [
+	["AndroidManifest.xml", ["app", "src", "main", "AndroidManifest.xml"]],
+	["strings.xml", ["app", "src", "main", "res", "values", "strings.xml"]],
+	["styles.xml", ["app", "src", "main", "res", "values", "styles.xml"]],
+	["config.xml", ["app", "src", "main", "res", "xml", "config.xml"]],
+	["network_security_config.xml", ["app", "src", "main", "res", "xml", "network_security_config.xml"]],
+	["file_paths.xml", ["app", "src", "main", "res", "xml", "file_paths.xml"]],
+];
+
+function fail(message) {
+	console.error(`\n  ✖ ${message}\n`);
+	process.exit(1);
+}
+
+if (!fs.existsSync(path.join(androidDir, "settings.gradle.kts"))) {
+	fail(`Can't find the Android host at ${androidDir}.`);
+}
+
+for (const [name, destination] of files) {
+	const source = path.join(sourceDir, name);
+	if (!fs.existsSync(source)) {
+		fail(`Missing ${path.relative(projectRoot, source)}. Restore it before preparing the Android host.`);
+	}
+	const target = path.join(androidDir, ...destination);
+	fs.mkdirSync(path.dirname(target), { recursive: true });
+	fs.copyFileSync(source, target);
+	console.log(`  → ${path.relative(projectRoot, target)}`);
+}
+
+const mapsConfig = path.join(sourceDir, "maps.json");
+if (fs.existsSync(mapsConfig)) {
+	const mapsTarget = path.join(androidDir, "app", "src", "main", "assets", "lynx_maps", "config.json");
+	fs.mkdirSync(path.dirname(mapsTarget), { recursive: true });
+	fs.copyFileSync(mapsConfig, mapsTarget);
+	console.log(`  → ${path.relative(projectRoot, mapsTarget)}`);
+}
+
+console.log("\n  ✔ Android resources prepared.\n");

package/templates/android/host/app/build.gradle.kts

@@ -98,6 +98,10 @@ dependencies {
     // gesture then never works).
     implementation("androidx.viewpager2:viewpager2:1.1.0")
 
+    // <create-mithril-lynx:android-connectors>
+{{ANDROID_PLUGIN_DEPENDENCIES}}
+    // </create-mithril-lynx:android-connectors>
+
     implementation("androidx.appcompat:appcompat:1.7.0")
     implementation("androidx.core:core-splashscreen:1.0.1")
 }

package/templates/android/host/app/src/main/AndroidManifest.xml

@@ -11,6 +11,7 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:hardwareAccelerated="true"
         android:usesCleartextTraffic="true"
+        android:networkSecurityConfig="@xml/network_security_config"
         android:theme="@style/AppTheme">
 
         <activity

package/templates/android/host/app/src/main/java/package-path/MainActivity.kt

@@ -1,14 +1,20 @@
 package {{PACKAGE_NAME}}
 
 import android.os.Bundle
+// <create-mithril-lynx:connector-imports>
+// </create-mithril-lynx:connector-imports>
+import androidx.activity.OnBackPressedCallback
 import androidx.appcompat.app.AppCompatActivity
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
+import com.lynx.react.bridge.JavaOnlyArray
 import com.lynx.tasm.LynxBooleanOption
 import com.lynx.tasm.LynxViewBuilder
 import com.lynx.tasm.ThreadStrategyForRendering
 import com.lynx.xelement.XElementBehaviors
 
 class MainActivity : AppCompatActivity() {
+    private var backCallback: OnBackPressedCallback? = null
+
     override fun onCreate(savedInstanceState: Bundle?) {
         // Must run BEFORE super.onCreate() — a Splash Screen API requirement.
         installSplashScreen()
@@ -20,6 +26,11 @@ class MainActivity : AppCompatActivity() {
         // keyboard. Remove this line (and the xelement dependencies) if you
         // don't use them.
         builder.addBehaviors(XElementBehaviors().create())
+        // Lets mithril-lynx/route tell Android when its in-memory history can
+        // handle Back. See MithrilLynxNavigationModule and the callback below.
+        builder.registerModule("MithrilLynxNavigationModule", MithrilLynxNavigationModule::class.java)
+        // <create-mithril-lynx:connector-registration>
+        // </create-mithril-lynx:connector-registration>
         // lynx-family/lynx's own explorer/android registers a
         // GenericResourceFetcher unconditionally (LynxViewShellActivity —
         // "used inside LynxEngine for resource loading capabilities of
@@ -37,9 +48,32 @@ class MainActivity : AppCompatActivity() {
         val lynxView = builder.build(this)
         setContentView(lynxView)
 
+        // Disabled until route.listenBackButton() reports that JS has an
+        // in-app history entry. When disabled, Android's normal Back behavior
+        // remains in charge and closes the activity from the first screen.
+        val callback = object : OnBackPressedCallback(false) {
+            override fun handleOnBackPressed() {
+                lynxView.sendGlobalEvent("mithrilLynx:back", JavaOnlyArray())
+            }
+        }
+        onBackPressedDispatcher.addCallback(this, callback)
+        backCallback = callback
+
         // The bundle lives in app/src/main/assets/main-thread.bundle, copied
         // there by `npm run android` (scripts/android.mjs) from the JS
         // project's dist/. The name has to match exactly.
         lynxView.renderTemplateUrl("main-thread.bundle", "")
     }
+
+    fun setCanGoBack(canGoBack: Boolean) {
+        backCallback?.isEnabled = canGoBack
+    }
+
+    // <create-mithril-lynx:connector-callbacks>
+    // </create-mithril-lynx:connector-callbacks>
+
+    override fun onDestroy() {
+        backCallback = null
+        super.onDestroy()
+    }
 }

package/templates/android/host/app/src/main/java/package-path/MithrilLynxNavigationModule.kt

@@ -0,0 +1,28 @@
+package {{PACKAGE_NAME}}
+
+import android.content.Context
+import android.os.Handler
+import android.os.Looper
+import com.lynx.jsbridge.LynxMethod
+import com.lynx.jsbridge.LynxModule
+import com.lynx.tasm.behavior.LynxContext
+
+/**
+ * JS -> Android half of mithril-lynx/route's system Back integration.
+ *
+ * MainActivity supplies the Android -> JS half with sendGlobalEvent(). Keeping
+ * the callback disabled when the route history is empty preserves Android's
+ * default behavior on the app's first screen, including predictive Back.
+ */
+class MithrilLynxNavigationModule(context: Context) : LynxModule(context) {
+    private val activity = (context as? LynxContext)?.activity as? MainActivity
+
+    @LynxMethod
+    fun setCanGoBack(canGoBack: Boolean) {
+        // Lynx invokes native modules from its JS thread; Android's callback
+        // belongs to the main thread.
+        Handler(Looper.getMainLooper()).post {
+            activity?.setCanGoBack(canGoBack)
+        }
+    }
+}

package/templates/android/host/app/src/main/res/xml/config.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Project-owned Android configuration entry point. Android does not consume a
+  generic config.xml by itself; use it for XML metadata that a manifest entry
+  or a native integration needs, keeping that configuration beside the other
+  editable Android files in <project>/android/.
+-->
+<config />

package/templates/android/host/app/src/main/res/xml/file_paths.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Ready for an androidx.core.content.FileProvider declaration in
+  AndroidManifest.xml when the app needs to share a file with another app.
+-->
+<paths>
+    <files-path name="files" path="." />
+    <cache-path name="cache" path="." />
+    <external-files-path name="external_files" path="." />
+</paths>

package/templates/android/host/app/src/main/res/xml/network_security_config.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  The generated manifest references this resource. It deliberately matches the
+  previous host default (cleartext allowed) so existing local HTTP workflows do
+  not change. Restrict this before a production release when possible.
+-->
+<network-security-config>
+    <base-config cleartextTrafficPermitted="true" />
+</network-security-config>

package/templates/basic-activity/ts/src/app-bar.ts

@@ -1,10 +1,9 @@
 import m from "mithril-runtime";
 
 // A reusable app bar: a title, plus a back affordance when `onBack` is
-// given. No m.route.Link involved for the back button — see
-// mithril-lynx/route.js's README section on route.back(): Lynx has no
-// hardware back button, so a screen's own back affordance has to call
-// route.back() explicitly.
+// given. No m.route.Link involved for this on-screen affordance: it calls
+// route.back() explicitly. The generated Android host's system Back bridge
+// reaches the same history separately through route.listenBackButton().
 export function AppBar(title: string, onBack?: () => void) {
 	return m("view", { class: "AppBar" }, [
 		onBack != null ? m("text", { class: "AppBar-back", ontap: onBack }, "←") : null,

package/templates/basic-activity/ts/src/background.ts

@@ -21,12 +21,24 @@ route("/", {
 	"/detail": DetailHost,
 });
 
+// The host generated by --android forwards the system Back button through a
+// Lynx global event. The module is optional so this template still runs in
+// LynxExplorer, or when generated without its native Android host.
+route.listenBackButton({
+	onCanGoBackChange: (canGoBack) =>
+		NativeModules.MithrilLynxNavigationModule?.setCanGoBack(canGoBack),
+});
+
 declare const module: {
 	hot?: {
 		accept(path: string, callback: () => void): void;
 	};
 };
-declare const require: (id: string) => unknown;
+// Overloads: HMR reloads the two screen modules; DEV font registration
+// prepended by --with-font/--find-font requires .ttf paths as string URLs.
+declare function require(id: "./screens/home.js"): typeof homeModule;
+declare function require(id: "./screens/detail.js"): typeof detailModule;
+declare function require(id: string): string;
 
 if (module.hot) {
 	module.hot.accept("./screens/home.js", () => {