@craft-native/ios 0.0.150 → 0.0.152

package/README.md

@@ -179,6 +179,7 @@ Edit `craft.config.json` in your iOS project:
   "enableNFC": true,
   "enableHealthKit": false,
   "enableAppleMusic": false,
+  "enableHeartRate": false,
   "enableScreenCapture": true,
   "iosVersion": "15.0",
   "teamId": ""
@@ -558,6 +559,35 @@ window.addEventListener('craftMusicChange', (event) => render(event.detail));
 // CraftFakeMusicPlayer -bool YES`) for three made-up songs that play (counting as other audio) and skip.
 // Simulator builds only; a device always talks to the Music app.
 
+// Heart rate (enableHeartRate): a Bluetooth strap, or a watch broadcasting
+// its heart rate, through the standard Heart Rate Service (0x180D) and its
+// Heart Rate Measurement (0x2A37): bpm, sensor contact, energy and RR
+// intervals. The app gets the `bluetooth-central` background mode, so
+// readings keep coming during a workout with the screen locked. iOS asks
+// for Bluetooth on the first scan or connect (or requestAuthorization()); word
+// it with usageDescriptions.NSBluetoothAlwaysUsageDescription.
+window.addEventListener('craftHeartRate', (event) => {
+  // { type: 'device', device: { id, name, rssi } }      a scan found a strap
+  // { type: 'reading', bpm, rrIntervals, contact, energyExpended, timestamp, deviceId }
+  // { type: 'state', connection, bluetooth, device, lastDevice, bpm, ... }
+});
+await window.craft.heartRate.scan({ timeout: 15 });     // straps nearby, and one already connected
+const strap = (await window.craft.heartRate.getDevices())[0]; // strongest signal first
+await window.craft.heartRate.connect(strap.id);  // remembered; rejects TIMEOUT after 15 s while still asking
+await window.craft.heartRate.reconnect();        // next time: the remembered strap, no scan
+// A strap that drops out is asked for again (connection 'reconnecting')
+// until disconnect({ forget }) lets it go.
+await window.craft.heartRate.startRecording();   // every reading kept natively, app closed or not
+await window.craft.heartRate.pauseRecording();   // resumeRecording() / getRecordingState()
+const { samples } = await window.craft.heartRate.stopRecording(); // [{ timestamp, bpm, rr? }]
+// Native screens call the same service as the HeartRate module (capability
+// `heartRate`), and hear the same craftHeartRate events. Or use `heartRate`
+// from 'craft-native/mobile' (onReading, onDevice, onState); off a phone it
+// answers { available: false }.
+// The simulator has no Bluetooth: `simctl spawn <device> defaults write
+// <bundle id> CraftFakeHeartRateMonitor -bool YES` stands in a strap ("Simulated
+// HRM") whose readings are encoded and decoded as 0x2A37 payloads. Simulator builds only.
+
 // Speech: short spoken cues that duck the person's music instead of stopping
 // it, and play with the silent switch on. Always available (no config flag).
 // Resolves when the utterance ends: true if spoken, false if stopped or

package/dist/cli.js

@@ -115,6 +115,7 @@ var DEFAULT_CONFIG = {
   enableAR: false,
   enableMLKit: false,
   enableAppleMusic: false,
+  enableHeartRate: false,
   iosVersion: "16.0",
   watchosVersion: "9.0",
   teamId: "",
@@ -171,7 +172,7 @@ function renderUsageDescriptions(config) {
     [config.enableBackgroundLocation, "NSLocationAlwaysAndWhenInUseUsageDescription", `${config.appName} continues recording your route when the screen is locked or the app is in the background.`],
     [config.enableContacts, "NSContactsUsageDescription", `${config.appName} accesses contacts only when you choose a contact feature.`],
     [config.enableCalendar, "NSCalendarsUsageDescription", `${config.appName} accesses your calendar only when you choose a calendar feature.`],
-    [config.enableBluetooth, "NSBluetoothAlwaysUsageDescription", `${config.appName} uses Bluetooth to connect to nearby devices.`],
+    [config.enableBluetooth || config.enableHeartRate, "NSBluetoothAlwaysUsageDescription", config.enableHeartRate ? `${config.appName} connects to your heart-rate monitor over Bluetooth to show and record your heart rate during a workout.` : `${config.appName} uses Bluetooth to connect to nearby devices.`],
     [config.enableMotionSensors, "NSMotionUsageDescription", `${config.appName} uses motion data for activity features.`],
     [config.enableNFC, "NFCReaderUsageDescription", `${config.appName} reads NFC tags when you start a scan.`],
     [config.enableLocalNetwork, "NSLocalNetworkUsageDescription", `${config.appName} connects to your own devices on this network.`],
@@ -254,6 +255,8 @@ function renderBackgroundModes(config) {
     modes.add("processing");
   if (config.enablePushNotifications)
     modes.add("remote-notification");
+  if (config.enableHeartRate)
+    modes.add("bluetooth-central");
   if (!modes.size)
     return "";
   return `    <key>UIBackgroundModes</key>
@@ -732,9 +735,11 @@ async function init(options) {
   cpSync(join(TEMPLATES_DIR, "CraftNativeActions.swift"), join(output, "Sources", "CraftNativeActions.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftHealth.swift"), join(output, "Sources", "CraftHealth.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftMusic.swift"), join(output, "Sources", "CraftMusic.swift"));
+  cpSync(join(TEMPLATES_DIR, "CraftHeartRate.swift"), join(output, "Sources", "CraftHeartRate.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeMutation.swift"), join(output, "Sources", "CraftNativeMutation.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeUI.swift"), join(output, "Sources", "CraftNativeUI.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeServices.swift"), join(output, "Sources", "CraftNativeServices.swift"));
+  cpSync(join(TEMPLATES_DIR, "CraftWebAudio.swift"), join(output, "Sources", "CraftWebAudio.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftHybrid.swift"), join(output, "Sources", "CraftHybrid.swift"));
   const infoPlistTemplate = readFileSync(join(TEMPLATES_DIR, "Info.plist.template"), "utf-8");
   const infoPlist = infoPlistTemplate.replace(/\{\{APP_NAME\}\}/g, xmlEscape(displayName)).replace(/\{\{BUNDLE_ID\}\}/g, finalBundleId).replace(/\{\{VERSION\}\}/g, config.version || "1.0.0").replace(/\{\{BUILD_NUMBER\}\}/g, config.buildNumber || "1").replace(/\{\{UI_STYLE\}\}/g, renderAppearance(config).interfaceStyle).replace(/\{\{STATUS_BAR_STYLE\}\}/g, renderAppearance(config).statusBarStyle).replace(/\{\{ORIENTATIONS\}\}/g, renderOrientations(config)).replace(/\{\{USAGE_DESCRIPTIONS\}\}/g, renderUsageDescriptions(config)).replace(/\{\{URL_TYPES\}\}/g, renderUrlTypes(config)).replace(/\{\{APP_BOUND_DOMAINS\}\}/g, renderAppBoundDomains(config)).replace(/\{\{BACKGROUND_MODES\}\}/g, renderBackgroundModes(config)).replace(/\{\{BACKGROUND_TASK_IDENTIFIERS\}\}/g, renderBackgroundTaskIdentifiers(config)).replace(/\{\{LAUNCH_SCREEN\}\}/g, renderLaunchScreen(config)).replace(/\{\{NON_EXEMPT_ENCRYPTION\}\}/g, config.usesNonExemptEncryption ? "true" : "false").replace(/\{\{LIVE_ACTIVITY_SUPPORT\}\}/g, config.enableLiveActivities ? `    <key>NSSupportsLiveActivities</key>

package/dist/index.d.ts

@@ -68,6 +68,15 @@ export interface CraftConfig {
      * `craft.music.requestAuthorization()`, never at launch.
      */
     enableAppleMusic?: boolean;
+    /**
+     * Read a Bluetooth heart-rate strap, or a watch broadcasting its heart rate
+     * (the standard Heart Rate Service), through `craft.heartRate`: scan,
+     * connect, live readings with RR intervals, and a recording kept natively.
+     * Adds the `bluetooth-central` background mode, so readings keep coming
+     * during a workout with the screen locked. iOS asks for Bluetooth the first
+     * time the page scans or connects.
+     */
+    enableHeartRate?: boolean;
     /**
      * Purpose strings in the app's own words, by Info.plist key
      * (`{ NSAppleMusicUsageDescription: 'Shows the song playing during a workout.' }`).

package/dist/index.js

@@ -170,6 +170,7 @@ var DEFAULT_CONFIG = {
   enableAR: false,
   enableMLKit: false,
   enableAppleMusic: false,
+  enableHeartRate: false,
   iosVersion: "16.0",
   watchosVersion: "9.0",
   teamId: "",
@@ -226,7 +227,7 @@ function renderUsageDescriptions(config) {
     [config.enableBackgroundLocation, "NSLocationAlwaysAndWhenInUseUsageDescription", `${config.appName} continues recording your route when the screen is locked or the app is in the background.`],
     [config.enableContacts, "NSContactsUsageDescription", `${config.appName} accesses contacts only when you choose a contact feature.`],
     [config.enableCalendar, "NSCalendarsUsageDescription", `${config.appName} accesses your calendar only when you choose a calendar feature.`],
-    [config.enableBluetooth, "NSBluetoothAlwaysUsageDescription", `${config.appName} uses Bluetooth to connect to nearby devices.`],
+    [config.enableBluetooth || config.enableHeartRate, "NSBluetoothAlwaysUsageDescription", config.enableHeartRate ? `${config.appName} connects to your heart-rate monitor over Bluetooth to show and record your heart rate during a workout.` : `${config.appName} uses Bluetooth to connect to nearby devices.`],
     [config.enableMotionSensors, "NSMotionUsageDescription", `${config.appName} uses motion data for activity features.`],
     [config.enableNFC, "NFCReaderUsageDescription", `${config.appName} reads NFC tags when you start a scan.`],
     [config.enableLocalNetwork, "NSLocalNetworkUsageDescription", `${config.appName} connects to your own devices on this network.`],
@@ -309,6 +310,8 @@ function renderBackgroundModes(config) {
     modes.add("processing");
   if (config.enablePushNotifications)
     modes.add("remote-notification");
+  if (config.enableHeartRate)
+    modes.add("bluetooth-central");
   if (!modes.size)
     return "";
   return `    <key>UIBackgroundModes</key>
@@ -787,9 +790,11 @@ async function init(options) {
   cpSync(join(TEMPLATES_DIR, "CraftNativeActions.swift"), join(output, "Sources", "CraftNativeActions.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftHealth.swift"), join(output, "Sources", "CraftHealth.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftMusic.swift"), join(output, "Sources", "CraftMusic.swift"));
+  cpSync(join(TEMPLATES_DIR, "CraftHeartRate.swift"), join(output, "Sources", "CraftHeartRate.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeMutation.swift"), join(output, "Sources", "CraftNativeMutation.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeUI.swift"), join(output, "Sources", "CraftNativeUI.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeServices.swift"), join(output, "Sources", "CraftNativeServices.swift"));
+  cpSync(join(TEMPLATES_DIR, "CraftWebAudio.swift"), join(output, "Sources", "CraftWebAudio.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftHybrid.swift"), join(output, "Sources", "CraftHybrid.swift"));
   const infoPlistTemplate = readFileSync(join(TEMPLATES_DIR, "Info.plist.template"), "utf-8");
   const infoPlist = infoPlistTemplate.replace(/\{\{APP_NAME\}\}/g, xmlEscape(displayName)).replace(/\{\{BUNDLE_ID\}\}/g, finalBundleId).replace(/\{\{VERSION\}\}/g, config.version || "1.0.0").replace(/\{\{BUILD_NUMBER\}\}/g, config.buildNumber || "1").replace(/\{\{UI_STYLE\}\}/g, renderAppearance(config).interfaceStyle).replace(/\{\{STATUS_BAR_STYLE\}\}/g, renderAppearance(config).statusBarStyle).replace(/\{\{ORIENTATIONS\}\}/g, renderOrientations(config)).replace(/\{\{USAGE_DESCRIPTIONS\}\}/g, renderUsageDescriptions(config)).replace(/\{\{URL_TYPES\}\}/g, renderUrlTypes(config)).replace(/\{\{APP_BOUND_DOMAINS\}\}/g, renderAppBoundDomains(config)).replace(/\{\{BACKGROUND_MODES\}\}/g, renderBackgroundModes(config)).replace(/\{\{BACKGROUND_TASK_IDENTIFIERS\}\}/g, renderBackgroundTaskIdentifiers(config)).replace(/\{\{LAUNCH_SCREEN\}\}/g, renderLaunchScreen(config)).replace(/\{\{NON_EXEMPT_ENCRYPTION\}\}/g, config.usesNonExemptEncryption ? "true" : "false").replace(/\{\{LIVE_ACTIVITY_SUPPORT\}\}/g, config.enableLiveActivities ? `    <key>NSSupportsLiveActivities</key>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@craft-native/ios",
-  "version": "0.0.150",
+  "version": "0.0.152",
   "homepage": "https://github.com/craft-native/craft/tree/main/packages/ios#readme",
   "repository": {
     "type": "git",

package/templates/CraftApp.swift

@@ -1119,6 +1119,9 @@ struct CraftConfig: Codable {
     var enableMLKit: Bool = false
     /// The Music app's song and transport through `craft.music` (CraftMusic.swift).
     var enableAppleMusic: Bool = false
+    /// A Bluetooth heart-rate strap (or a watch broadcasting its heart rate)
+    /// through `craft.heartRate` (CraftHeartRate.swift).
+    var enableHeartRate: Bool = false
     var devServerURL: String? = nil
     var trustedOrigins: [String] = []
     /// The longest the launch splash stays up when the page neither says it is
@@ -1641,6 +1644,16 @@ struct CraftWebView: UIViewRepresentable {
             if config.enableMotionSensors {
                 motionManager = CMMotionManager()
             }
+            if config.enableHeartRate {
+                // The strap's readings and connection changes reach the page,
+                // and through sendToWeb every native screen too. False once
+                // this coordinator is gone: native screens still hear them.
+                CraftHeartRate.shared.pageSink = { [weak self] detail in
+                    guard let self else { return false }
+                    self.sendToWeb("craftHeartRate", data: detail)
+                    return true
+                }
+            }
             if config.enableWatchApp {
                 setupWatchConnectivity()
             }
@@ -2213,6 +2226,22 @@ struct CraftWebView: UIViewRepresentable {
                 } else {
                     rejectCallback(callbackId, error: "Apple Music is disabled", code: "CAPABILITY_DISABLED")
                 }
+            // MARK: - Heart rate (CraftHeartRate.swift)
+            // Gated on enableHeartRate. One action for every method, as a
+            // native screen's HeartRate module calls them; asking for
+            // Bluetooth has its own, which waits on the person.
+            case "heartRate", "heartRateRequestAuthorization":
+                if !config.enableHeartRate {
+                    rejectCallback(callbackId, error: "Heart rate is disabled", code: "CAPABILITY_DISABLED")
+                } else {
+                    let method = action == "heartRate" ? body["method"] as? String ?? "" : "requestAuthorization"
+                    CraftHeartRate.shared.perform(method: method, args: [body["options"] as? [String: Any] ?? [:]]) { [weak self] result in
+                        switch result {
+                        case .success(let value): self?.resolveCallback(callbackId, result: value)
+                        case .failure(let failure): self?.rejectCallback(callbackId, error: failure.message, code: failure.code)
+                        }
+                    }
+                }
             // MARK: - Orientation Lock
             case "lockOrientation":
                 if config.enableOrientationLock {
@@ -3198,6 +3227,7 @@ struct CraftWebView: UIViewRepresentable {
                     flashlight: true,
                     brightness: true,
                     music: \(config.enableAppleMusic),
+                    heartRate: \(config.enableHeartRate),
                     speech: true,
                     network: true,
                     deviceInfo: true,
@@ -4737,6 +4767,7 @@ struct CraftWebView: UIViewRepresentable {
                 var personFacing = {
                     requestHealthAuthorization: true,
                     musicRequestAuthorization: true,
+                    heartRateRequestAuthorization: true,
                     requestPermission: true,
                     signInWithApple: true,
                     dialogAlert: true,
@@ -4951,6 +4982,30 @@ struct CraftWebView: UIViewRepresentable {
                     },
                     observe: function(enabled) { return craft._invoke('musicObserve', {enabled: enabled !== false}); }
                 };
+                // A Bluetooth heart-rate strap, or a watch broadcasting its
+                // heart rate. Readings, devices found by scan() and connection
+                // changes arrive as craftHeartRate events ({type: 'reading' |
+                // 'device' | 'state'}); startRecording() keeps every reading
+                // natively, screen locked or app closed, until stopRecording().
+                (function() {
+                    function heartRate(method, options) { return craft._invoke('heartRate', {method: method, options: options || {}}); }
+                    craft.heartRate = {
+                        getState: function() { return heartRate('getState'); },
+                        requestAuthorization: function() { return craft._invoke('heartRateRequestAuthorization'); },
+                        scan: function(options) { return heartRate('scan', {timeout: options && typeof options.timeout === 'number' ? options.timeout : null}); },
+                        stopScan: function() { return heartRate('stopScan'); },
+                        getDevices: function() { return heartRate('getDevices'); },
+                        connect: function(id) { return heartRate('connect', {id: typeof id === 'string' ? id : id && id.id}); },
+                        reconnect: function() { return heartRate('reconnect'); },
+                        disconnect: function(options) { return heartRate('disconnect', {forget: !!(options && options.forget)}); },
+                        startRecording: function() { return heartRate('startRecording'); },
+                        pauseRecording: function() { return heartRate('pauseRecording'); },
+                        resumeRecording: function() { return heartRate('resumeRecording'); },
+                        stopRecording: function() { return heartRate('stopRecording'); },
+                        getRecordingState: function() { return heartRate('getRecordingState'); },
+                        readRecording: function(options) { return heartRate('readRecording', {since: options && typeof options.since === 'number' ? options.since : null}); }
+                    };
+                })();
                 craft.liveActivity = {
                     start: function(options) { return craft._invoke('startLiveActivity', options || {}); },
                     update: function(idOrState, state) {
@@ -8450,7 +8505,7 @@ final class CraftZigRuntime: NSObject {
 enum CraftWebServices {
     private static var waiting: [String: (Result<Any, CraftNativeActionError>) -> Void] = [:]
     /// Coordinator events a native screen hears too.
-    static let forwardedEvents: Set<String> = ["craftLocationUpdate", "craftLocationError", "craftMusicChange"]
+    static let forwardedEvents: Set<String> = ["craftLocationUpdate", "craftLocationError", "craftMusicChange", "craftHeartRate"]
     static let event = Notification.Name("craftWebServicesEvent")
 
     static var isAvailable: Bool { CraftSwiftShim.coordinator != nil }