craft-native 0.0.115 → 0.0.119

package/dist/android/src/index.js

@@ -418,8 +418,12 @@ async function init(options) {
   if (config.renderer === "native") {
     const mutationTemplate = readFileSync(join(TEMPLATES_DIR, "CraftNativeMutation.kt.template"), "utf-8");
     const flatListTemplate = readFileSync(join(TEMPLATES_DIR, "CraftNativeFlatList.kt.template"), "utf-8");
+    const capabilityTemplate = readFileSync(join(TEMPLATES_DIR, "CraftNativeCapabilities.kt.template"), "utf-8");
+    const notificationTemplate = readFileSync(join(TEMPLATES_DIR, "CraftNativeNotificationReceiver.kt.template"), "utf-8");
     writeFileSync(join(output, "app/src/main/java", packagePath, "CraftNativeMutation.kt"), mutationTemplate.replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName));
     writeFileSync(join(output, "app/src/main/java", packagePath, "CraftNativeFlatList.kt"), flatListTemplate.replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName));
+    writeFileSync(join(output, "app/src/main/java", packagePath, "CraftNativeCapabilities.kt"), capabilityTemplate.replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName));
+    writeFileSync(join(output, "app/src/main/java", packagePath, "CraftNativeNotificationReceiver.kt"), notificationTemplate.replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName));
   }
   const craftBridgeTemplate = readFileSync(join(TEMPLATES_DIR, "CraftBridge.kt.template"), "utf-8");
   const craftBridge = craftBridgeTemplate.replace(/\{\{PROMISE_RUNTIME\}\}/g, () => renderAndroidPromiseRuntime("            ")).replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName).replace(/\{\{ENABLE_SPEECH\}\}/g, String(Boolean(config.enableSpeechRecognition))).replace(/\{\{ENABLE_HAPTICS\}\}/g, String(Boolean(config.enableHaptics))).replace(/\{\{ENABLE_SHARE\}\}/g, String(Boolean(config.enableShare))).replace(/\{\{ENABLE_CAMERA\}\}/g, String(Boolean(config.enableCamera))).replace(/\{\{ENABLE_BIOMETRIC\}\}/g, String(Boolean(config.enableBiometric))).replace(/\{\{ENABLE_PUSH\}\}/g, String(Boolean(config.enablePushNotifications))).replace(/\{\{ENABLE_SECURE_STORAGE\}\}/g, String(Boolean(config.enableSecureStorage))).replace(/\{\{ENABLE_GEOLOCATION\}\}/g, String(Boolean(config.enableGeolocation))).replace(/\{\{ENABLE_BACKGROUND_LOCATION\}\}/g, String(Boolean(config.enableBackgroundLocation))).replace(/\{\{ENABLE_KEEP_AWAKE\}\}/g, String(Boolean(config.enableKeepAwake))).replace(/\{\{ENABLE_DEEP_LINKS\}\}/g, String(Boolean(config.enableDeepLinks))).replace(/\{\{ENABLE_HEALTH_CONNECT\}\}/g, String(Boolean(config.enableHealthConnect))).replace(/\{\{FIREBASE_IMPORT\}\}/g, config.enablePushNotifications ? "import com.google.firebase.messaging.FirebaseMessaging" : "").replace(/\{\{REGISTER_PUSH_IMPLEMENTATION\}\}/g, config.enablePushNotifications ? `activity.runOnUiThread {
@@ -451,7 +455,7 @@ async function init(options) {
   const healthTemplate = readFileSync(join(TEMPLATES_DIR, config.enableHealthConnect ? "CraftHealthConnect.kt.template" : "CraftHealthConnectStub.kt.template"), "utf-8");
   writeFileSync(join(output, "app/src/main/java", packagePath, "CraftHealthConnect.kt"), healthTemplate.replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName));
   const manifestTemplate = readFileSync(join(TEMPLATES_DIR, "AndroidManifest.xml.template"), "utf-8");
-  const manifest = manifestTemplate.replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName).replace(/\{\{APP_NAME\}\}/g, name).replace(/\{\{PERMISSIONS\}\}/g, renderAndroidPermissions(config)).replace(/\{\{USES_CLEARTEXT\}\}/g, config.devServerURL?.startsWith("http://") || config.enableLocalNetwork ? "true" : "false").replace(/\{\{DEEP_LINK_INTENT_FILTERS\}\}/g, renderAndroidDeepLinks(config)).replace(/\{\{BACKGROUND_SERVICE\}\}/g, config.enableBackgroundLocation ? '        <service android:name="com.craft.runtime.LocationRecordingService" android:exported="false" android:foregroundServiceType="location" android:stopWithTask="false" />' : "").replace(/\{\{HEALTH_CONNECT_QUERIES\}\}/g, config.enableHealthConnect ? `    <queries>
+  const manifest = manifestTemplate.replace(/\{\{PACKAGE_NAME\}\}/g, finalPackageName).replace(/\{\{APP_NAME\}\}/g, name).replace(/\{\{PERMISSIONS\}\}/g, renderAndroidPermissions(config)).replace(/\{\{USES_CLEARTEXT\}\}/g, config.devServerURL?.startsWith("http://") || config.enableLocalNetwork ? "true" : "false").replace(/\{\{DEEP_LINK_INTENT_FILTERS\}\}/g, renderAndroidDeepLinks(config)).replace(/\{\{BACKGROUND_SERVICE\}\}/g, config.enableBackgroundLocation ? '        <service android:name="com.craft.runtime.LocationRecordingService" android:exported="false" android:foregroundServiceType="location" android:stopWithTask="false" />' : "").replace(/\{\{NATIVE_NOTIFICATION_RECEIVER\}\}/g, config.renderer === "native" ? '        <receiver android:name=".CraftNativeNotificationReceiver" android:exported="false" />' : "").replace(/\{\{HEALTH_CONNECT_QUERIES\}\}/g, config.enableHealthConnect ? `    <queries>
         <package android:name="com.google.android.apps.healthdata" />
     </queries>` : "").replace(/\{\{HEALTH_CONNECT_RATIONALE\}\}/g, config.enableHealthConnect ? `            <intent-filter>
                 <action android:name="androidx.health.ACTION_SHOW_PERMISSIONS_RATIONALE" />

package/dist/android/templates/AndroidManifest.xml.template

@@ -5,6 +5,14 @@
 {{PERMISSIONS}}
 {{HEALTH_CONNECT_QUERIES}}
 
+    <!-- craft.speech: from Android 11 an app cannot see, and so cannot bind,
+         a text-to-speech engine it has not declared it will look for. -->
+    <queries>
+        <intent>
+            <action android:name="android.intent.action.TTS_SERVICE" />
+        </intent>
+    </queries>
+
     <!-- Camera feature (optional) -->
     <uses-feature android:name="android.hardware.camera" android:required="false" />
     <uses-feature android:name="android.hardware.camera.autofocus" android:required="false" />
@@ -37,6 +45,7 @@
         </activity>
 
 {{BACKGROUND_SERVICE}}
+{{NATIVE_NOTIFICATION_RECEIVER}}
 
     </application>
 

package/dist/android/templates/CraftBridge.kt.template

@@ -36,6 +36,11 @@ import android.provider.Settings
 import android.speech.RecognitionListener
 import android.speech.RecognizerIntent
 import android.speech.SpeechRecognizer
+import android.speech.tts.TextToSpeech
+import android.speech.tts.UtteranceProgressListener
+import android.media.AudioAttributes
+import android.media.AudioFocusRequest
+import android.media.AudioManager
 import android.util.DisplayMetrics
 import android.webkit.JavascriptInterface
 import android.webkit.WebView
@@ -199,6 +204,17 @@ internal object CraftPermissionPolicy {
             isGranted(Manifest.permission.ACCESS_COARSE_LOCATION)
 }
 
+private data class SpeechRequest(
+    val text: String,
+    val rate: Float,
+    val language: String?,
+    val callbackId: Int,
+    val generation: Int
+)
+
+/** The navigation it belongs to, so a page that has gone hears nothing. */
+private data class PendingUtterance(val callbackId: Int, val generation: Int)
+
 private data class PendingPermissionRequest(
     val callbackId: Int,
     val permission: String,
@@ -279,6 +295,19 @@ class CraftBridge(
     // Keep awake
     private var isKeepingAwake = false
 
+    // Speech synthesis, all of it touched on the main thread only. The engine
+    // is bound on the first speak rather than here, so an app that never
+    // speaks never starts a TTS service. Requests made while it binds wait in
+    // queuedSpeech; each utterance handed to it waits in pendingUtterances,
+    // under the id the engine reports back, for the page call it answers.
+    private var textToSpeech: TextToSpeech? = null
+    private var textToSpeechReady = false
+    private val queuedSpeech = mutableListOf<SpeechRequest>()
+    private val pendingUtterances = linkedMapOf<String, PendingUtterance>()
+    private var nextUtteranceId = 0L
+    private var speechFocusRequest: AudioFocusRequest? = null
+    private val speechHandler = Handler(Looper.getMainLooper())
+
     // Billing clients for in-app purchases
     private var productBillingClient: BillingClient? = null
     private var restoreBillingClient: BillingClient? = null
@@ -388,6 +417,7 @@ class CraftBridge(
                     networkStatus: true,
                     appReview: true,
                     flashlight: {{ENABLE_CAMERA}} && ${hasFlashlight()},
+                    speech: true,
                     openURL: true,
                     vibrationPattern: true,
                     appState: true,
@@ -1590,6 +1620,9 @@ class CraftBridge(
                 craft.secureStorage = {
                     set: function(key, value) { return Promise.resolve().then(function() { legacySecureStore.set(key, value); }); },
                     get: function(key) { return Promise.resolve().then(function() { return legacySecureStore.get(key); }); },
+                    // Keep the legacy public name alongside `delete` for
+                    // native STX callers compiled against the older contract.
+                    remove: function(key) { return Promise.resolve().then(function() { legacySecureStore.remove(key); }); },
                     delete: function(key) { return Promise.resolve().then(function() { legacySecureStore.remove(key); }); },
                     clear: function() { return Promise.resolve().then(function() { CraftAndroid.secureClear(); }); }
                 };
@@ -1642,6 +1675,66 @@ class CraftBridge(
                         return Promise.resolve().then(function() { CraftAndroid.openPermissionSettings(); });
                     }
                 };
+                // Speech synthesis. speak() settles when the utterance ends:
+                // true when it was spoken, false when something stopped it
+                // or the device has no engine to speak with. No timeout, as
+                // on iOS: a long sentence at a slow rate outlasts any
+                // deadline that would be fair to a short cue.
+                var speechRequestSequence = 0;
+                var speechRequests = Object.create(null);
+                var speechRuntimeClosed = false;
+                window.__craftSpeechResult = function(id, spoken) {
+                    if (speechRuntimeClosed) return;
+                    var pending = speechRequests[id];
+                    if (!pending) return;
+                    delete speechRequests[id];
+                    pending.resolve(spoken === true);
+                };
+                window.__craftSpeechError = function(id, message, code) {
+                    if (speechRuntimeClosed) return;
+                    var pending = speechRequests[id];
+                    if (!pending) return;
+                    delete speechRequests[id];
+                    var error = new Error(message);
+                    error.code = code || 'CRAFT_ERROR';
+                    error.bridge = true;
+                    pending.reject(error);
+                };
+                window.__craftRejectSpeechRequests = function(message) {
+                    speechRuntimeClosed = true;
+                    Object.keys(speechRequests).forEach(function(id) {
+                        var pending = speechRequests[id];
+                        delete speechRequests[id];
+                        pending.reject(new Error(message || 'Android bridge closed'));
+                    });
+                };
+                craft.speech = {
+                    speak: function(text, options) {
+                        if (speechRuntimeClosed) {
+                            return Promise.reject(new Error('Android bridge is closed'));
+                        }
+                        options = options || {};
+                        var settings = JSON.stringify({
+                            rate: typeof options.rate === 'number' ? options.rate : null,
+                            language: typeof options.language === 'string' ? options.language : null,
+                            interrupt: options.interrupt !== false
+                        });
+                        return new Promise(function(resolve, reject) {
+                            speechRequestSequence += 1;
+                            var id = speechRequestSequence;
+                            speechRequests[id] = {resolve: resolve, reject: reject};
+                            try {
+                                CraftAndroid.speak(text == null ? '' : String(text), settings, id);
+                            } catch (error) {
+                                delete speechRequests[id];
+                                reject(error);
+                            }
+                        });
+                    },
+                    stop: function() {
+                        return Promise.resolve().then(function() { CraftAndroid.stopSpeaking(); });
+                    }
+                };
                 craft.location = {
                     getCurrentPosition: craft.getCurrentPosition,
                     watchPosition: craft.watchPosition,
@@ -3556,6 +3649,189 @@ class CraftBridge(
         return true
     }
 
+    // ==================== Speech Synthesis ====================
+
+    /**
+     * Say [text], and answer the page's call [callbackId] once it has been
+     * said (`true`) or stopped (`false`).
+     *
+     * The audio is marked as navigation guidance and asks for transient,
+     * may-duck focus, which is what makes the music dip under the cue rather
+     * than stop, and come back once [abandonSpeechFocus] runs. The WebView's
+     * own `speechSynthesis` has no say in either.
+     */
+    @JavascriptInterface
+    fun speak(text: String?, optionsJson: String?, callbackId: Int) {
+        activity.runOnUiThread {
+            if (closed) return@runOnUiThread
+            if (text.isNullOrBlank()) {
+                rejectSpeech(callbackId, "speak needs some text to say", "INVALID_ARGUMENT")
+                return@runOnUiThread
+            }
+            val options = runCatching { JSONObject(optionsJson ?: "{}") }.getOrElse { JSONObject() }
+            val rate = if (options.isNull("rate")) 1.0 else options.optDouble("rate", 1.0)
+            val request = SpeechRequest(
+                text = text,
+                // 1 is normal on both scales, so this only bounds it.
+                rate = (if (rate.isFinite()) rate else 1.0).coerceIn(0.5, 2.0).toFloat(),
+                language = if (options.isNull("language")) null else options.optString("language").ifBlank { null },
+                callbackId = callbackId,
+                generation = navigationGeneration
+            )
+            if (options.optBoolean("interrupt", true)) cancelPendingSpeech()
+
+            val engine = textToSpeech
+            if (engine != null && textToSpeechReady) {
+                startUtterance(engine, request)
+            } else {
+                queuedSpeech.add(request)
+                bindTextToSpeech()
+            }
+        }
+    }
+
+    @JavascriptInterface
+    fun stopSpeaking(): Boolean {
+        activity.runOnUiThread {
+            if (closed) return@runOnUiThread
+            cancelPendingSpeech()
+            abandonSpeechFocus()
+        }
+        return true
+    }
+
+    private val speechAudioAttributes: AudioAttributes by lazy {
+        AudioAttributes.Builder()
+            .setUsage(AudioAttributes.USAGE_ASSISTANCE_NAVIGATION_GUIDANCE)
+            .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
+            .build()
+    }
+
+    /** Main thread. Binding takes a moment, and finishes in the listener. */
+    private fun bindTextToSpeech() {
+        if (textToSpeech != null) return
+        var engine: TextToSpeech? = null
+        // Posted, never run inline: an engine that cannot bind reports so
+        // from inside its own constructor, before `engine` has been assigned,
+        // and runOnUiThread on the main thread would run it right there.
+        engine = TextToSpeech(activity.applicationContext) { status ->
+            speechHandler.post { onTextToSpeechBound(engine, status == TextToSpeech.SUCCESS) }
+        }
+        textToSpeech = engine
+    }
+
+    private fun onTextToSpeechBound(engine: TextToSpeech?, succeeded: Boolean) {
+        // An engine that close() or a failed earlier bind has since replaced.
+        if (closed || engine == null || engine !== textToSpeech) return
+        val waiting = queuedSpeech.toList()
+        queuedSpeech.clear()
+        if (!succeeded) {
+            // No engine, or none that would start. Each call settles as
+            // "nothing was said", and the next speak tries binding again.
+            runCatching { engine.shutdown() }
+            textToSpeech = null
+            waiting.forEach { settleSpeech(it.callbackId, it.generation, false) }
+            return
+        }
+        engine.setAudioAttributes(speechAudioAttributes)
+        engine.setOnUtteranceProgressListener(object : UtteranceProgressListener() {
+            override fun onStart(utteranceId: String?) {}
+            override fun onDone(utteranceId: String?) {
+                activity.runOnUiThread { utteranceEnded(utteranceId, true) }
+            }
+            @Deprecated("Deprecated in Java")
+            override fun onError(utteranceId: String?) {
+                activity.runOnUiThread { utteranceEnded(utteranceId, false) }
+            }
+            override fun onError(utteranceId: String?, errorCode: Int) {
+                activity.runOnUiThread { utteranceEnded(utteranceId, false) }
+            }
+            override fun onStop(utteranceId: String?, interrupted: Boolean) {
+                activity.runOnUiThread { utteranceEnded(utteranceId, false) }
+            }
+        })
+        textToSpeechReady = true
+        waiting.forEach { startUtterance(engine, it) }
+    }
+
+    private fun startUtterance(engine: TextToSpeech, request: SpeechRequest) {
+        if (!requestSpeechFocus()) {
+            // A call, or something else that may not be talked over.
+            settleSpeech(request.callbackId, request.generation, false)
+            return
+        }
+        // Both apply to the speak calls after them, so each utterance sets
+        // its own rather than inheriting the last one's.
+        engine.setSpeechRate(request.rate)
+        val locale = request.language?.let { Locale.forLanguageTag(it) }
+        if (locale == null || engine.setLanguage(locale) < TextToSpeech.LANG_AVAILABLE) {
+            engine.setLanguage(Locale.getDefault())
+        }
+
+        nextUtteranceId += 1
+        val utteranceId = "craft-speech-$nextUtteranceId"
+        pendingUtterances[utteranceId] = PendingUtterance(request.callbackId, request.generation)
+        if (engine.speak(request.text, TextToSpeech.QUEUE_ADD, null, utteranceId) != TextToSpeech.SUCCESS) {
+            pendingUtterances.remove(utteranceId)
+            settleSpeech(request.callbackId, request.generation, false)
+            if (pendingUtterances.isEmpty()) abandonSpeechFocus()
+        }
+    }
+
+    private fun utteranceEnded(utteranceId: String?, spoken: Boolean) {
+        val pending = utteranceId?.let { pendingUtterances.remove(it) }
+        if (pending != null) settleSpeech(pending.callbackId, pending.generation, spoken)
+        if (pendingUtterances.isEmpty() && queuedSpeech.isEmpty()) abandonSpeechFocus()
+    }
+
+    /**
+     * Stop the engine and settle every call waiting on it, false.
+     *
+     * Settled here rather than in `onStop`, so that a request still waiting
+     * for the engine to bind, which the engine has never heard of, settles
+     * too.
+     */
+    private fun cancelPendingSpeech() {
+        val waiting = pendingUtterances.values.toList() +
+            queuedSpeech.map { PendingUtterance(it.callbackId, it.generation) }
+        pendingUtterances.clear()
+        queuedSpeech.clear()
+        if (textToSpeechReady) runCatching { textToSpeech?.stop() }
+        waiting.forEach { settleSpeech(it.callbackId, it.generation, false) }
+    }
+
+    private fun requestSpeechFocus(): Boolean {
+        if (speechFocusRequest != null) return true
+        val manager = activity.getSystemService(Context.AUDIO_SERVICE) as? AudioManager ?: return true
+        val request = AudioFocusRequest.Builder(AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK)
+            .setAudioAttributes(speechAudioAttributes)
+            .build()
+        if (manager.requestAudioFocus(request) == AudioManager.AUDIOFOCUS_REQUEST_FAILED) return false
+        speechFocusRequest = request
+        return true
+    }
+
+    private fun abandonSpeechFocus() {
+        val request = speechFocusRequest ?: return
+        speechFocusRequest = null
+        val manager = activity.getSystemService(Context.AUDIO_SERVICE) as? AudioManager ?: return
+        runCatching { manager.abandonAudioFocusRequest(request) }
+    }
+
+    /** An answer for a page that has since navigated away is dropped. */
+    private fun settleSpeech(callbackId: Int, generation: Int, spoken: Boolean) {
+        if (generation != navigationGeneration) return
+        evaluateJavascriptUnlessClosed(
+            "window.__craftSpeechResult && window.__craftSpeechResult($callbackId, $spoken)"
+        )
+    }
+
+    private fun rejectSpeech(callbackId: Int, message: String, code: String) {
+        evaluateJavascriptUnlessClosed(
+            "window.__craftSpeechError && window.__craftSpeechError($callbackId, ${jsQuote(message)}, ${jsQuote(code)})"
+        )
+    }
+
     // ==================== Orientation Lock ====================
 
     @JavascriptInterface
@@ -4077,7 +4353,8 @@ class CraftBridge(
             runCatching {
                 webView.evaluateJavascript(
                     "window.__craftRejectPendingPromises && window.__craftRejectPendingPromises('Android bridge closed');" +
-                        "window.__craftRejectPermissionRequests && window.__craftRejectPermissionRequests('Android bridge closed')",
+                        "window.__craftRejectPermissionRequests && window.__craftRejectPermissionRequests('Android bridge closed');" +
+                        "window.__craftRejectSpeechRequests && window.__craftRejectSpeechRequests('Android bridge closed')",
                     null
                 )
             }
@@ -4144,6 +4421,16 @@ class CraftBridge(
         runCatching { database?.close() }
         database = null
 
+        // The page's calls were rejected above; this only silences the
+        // engine and gives the music back its volume.
+        queuedSpeech.clear()
+        pendingUtterances.clear()
+        runCatching { textToSpeech?.stop() }
+        runCatching { textToSpeech?.shutdown() }
+        textToSpeech = null
+        textToSpeechReady = false
+        abandonSpeechFocus()
+
         if (isFlashlightOn) setFlashlight(false)
         activity.window.clearFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON)
         isKeepingAwake = false