Release v0.0.7

.github/workflows/release.yml

@@ -49,10 +49,16 @@ jobs:
 
       - name: Build arm64 release app
         env:
+          APTABASE_APP_KEY: ${{ secrets.APTABASE_APP_KEY }}
           VERSION: ${{ steps.metadata.outputs.version }}
         shell: bash
         run: |
           set -euo pipefail
+          if [[ -z "${APTABASE_APP_KEY:-}" ]]; then
+            echo "APTABASE_APP_KEY secret is required for release builds." >&2
+            exit 1
+          fi
+
           xcodebuild \
             -project MicStatusAI.xcodeproj \
             -scheme MicStatusAI \
@@ -62,12 +68,19 @@ jobs:
             CODE_SIGNING_ALLOWED=NO \
             MARKETING_VERSION="$VERSION" \
             CURRENT_PROJECT_VERSION="$GITHUB_RUN_NUMBER" \
+            APTABASE_APP_KEY="$APTABASE_APP_KEY" \
             ARCHS=arm64 \
             ONLY_ACTIVE_ARCH=NO \
             clean build
 
           app="$RUNNER_TEMP/DerivedData/Build/Products/Release/MicStatusAI.app"
           test -d "$app"
+          embedded_key="$(/usr/libexec/PlistBuddy \
+            -c 'Print :AptabaseAppKey' \
+            "$app/Contents/Info.plist")"
+          test "$embedded_key" = "$APTABASE_APP_KEY"
+          unset embedded_key
+
           architectures="$(lipo -archs "$app/Contents/MacOS/MicStatusAI")"
           test "$architectures" = "arm64"
           echo "Architectures: $architectures"

MicStatusAI/Analytics/AnalyticsEvent.swift

@@ -0,0 +1,104 @@
+struct AnalyticsEvent {
+    enum Property {
+        case string(String)
+        case bool(Bool)
+        case int(Int)
+    }
+
+    enum MuteSource: String {
+        case button
+        case hotKey = "hotkey"
+    }
+
+    enum MicrophoneOperation: String {
+        case monitoring
+        case mute
+        case inputLevel = "input_level"
+    }
+
+    let name: String
+    let properties: [String: Property]
+
+    static let appLaunched = Self(name: "app_launched")
+    static let settingsOpened = Self(name: "settings_opened")
+    static let analyticsEnabled = Self(name: "analytics_enabled")
+    static let overlayPreviewed = Self(name: "overlay_previewed")
+    static let overlayShown = Self(name: "overlay_shown")
+
+    static func monitoringChanged(enabled: Bool) -> Self {
+        Self(
+            name: "monitoring_changed",
+            properties: ["enabled": .bool(enabled)]
+        )
+    }
+
+    static func muteChanged(isMuted: Bool, source: MuteSource) -> Self {
+        Self(
+            name: "mute_changed",
+            properties: [
+                "is_muted": .bool(isMuted),
+                "source": .string(source.rawValue),
+            ]
+        )
+    }
+
+    static func inputLevelChanged(percentBucket: Int) -> Self {
+        Self(
+            name: "input_level_changed",
+            properties: ["percent_bucket": .int(percentBucket)]
+        )
+    }
+
+    static func overlayEnabledChanged(enabled: Bool) -> Self {
+        Self(
+            name: "overlay_enabled_changed",
+            properties: ["enabled": .bool(enabled)]
+        )
+    }
+
+    static func overlayDurationChanged(seconds: Int) -> Self {
+        Self(
+            name: "overlay_duration_changed",
+            properties: ["seconds": .int(seconds)]
+        )
+    }
+
+    static func overlayPlacementChanged(placement: String) -> Self {
+        Self(
+            name: "overlay_placement_changed",
+            properties: ["placement": .string(placement)]
+        )
+    }
+
+    static func overlayTransparencyChanged(percentBucket: Int) -> Self {
+        Self(
+            name: "overlay_transparency_changed",
+            properties: ["percent_bucket": .int(percentBucket)]
+        )
+    }
+
+    static func hotKeyChanged(success: Bool) -> Self {
+        Self(
+            name: "hotkey_changed",
+            properties: ["success": .bool(success)]
+        )
+    }
+
+    static func microphoneError(
+        operation: MicrophoneOperation,
+        category: String
+    ) -> Self {
+        Self(
+            name: "microphone_error",
+            properties: [
+                "operation": .string(operation.rawValue),
+                "category": .string(category),
+            ]
+        )
+    }
+
+    private init(name: String, properties: [String: Property] = [:]) {
+        self.name = name
+        self.properties = properties
+    }
+}

MicStatusAI/App/MicStatusAIApp.swift

@@ -1,6 +1,7 @@
 import SwiftUI
 
 @main
+@MainActor
 struct MicStatusAIApp: App {
     @AppStorage("statusOverlayEnabled")
     private var statusOverlayEnabled = true
@@ -10,9 +11,28 @@ struct MicStatusAIApp: App {
     private var statusOverlayPlacement: StatusOverlayPlacement = .center
     @AppStorage("statusOverlayTransparency")
     private var statusOverlayTransparency = StatusOverlayTransparency.defaultValue
-    @State private var model = MicrophoneStatusModel()
+    @AppStorage("analyticsEnabled")
+    private var analyticsEnabled = true
+
+    @State private var model: MicrophoneStatusModel
     @State private var statusOverlayPresenter = StatusOverlayPresenter()
 
+    private let analytics: AptabaseAnalytics
+
+    init() {
+        let isAnalyticsEnabled = UserDefaults.standard.object(
+            forKey: "analyticsEnabled"
+        ) as? Bool ?? true
+        let analyticsClient = AptabaseAnalytics(
+            appKey: AptabaseAnalytics.configuredAppKey(),
+            isEnabled: isAnalyticsEnabled
+        )
+
+        analytics = analyticsClient
+        _model = State(initialValue: MicrophoneStatusModel(analytics: analyticsClient))
+        analyticsClient.track(.appLaunched)
+    }
+
     var body: some Scene {
         MenuBarExtra {
             StatusPanel(model: model)
@@ -31,6 +51,7 @@ struct MicStatusAIApp: App {
                         placement: statusOverlayPlacement,
                         transparency: statusOverlayTransparency
                     )
+                    analytics.track(.overlayShown)
                 }
                 .onChange(of: statusOverlayEnabled) { _, isEnabled in
                     if !isEnabled {
@@ -46,8 +67,22 @@ struct MicStatusAIApp: App {
                 statusOverlayEnabled: $statusOverlayEnabled,
                 statusOverlayDuration: $statusOverlayDuration,
                 statusOverlayPlacement: $statusOverlayPlacement,
-                statusOverlayTransparency: $statusOverlayTransparency
+                statusOverlayTransparency: $statusOverlayTransparency,
+                analyticsEnabled: $analyticsEnabled,
+                analytics: analytics,
+                onShowOverlayPreview: showOverlayPreview
             )
         }
+        .windowResizability(.contentSize)
+    }
+
+    private func showOverlayPreview() {
+        statusOverlayPresenter.show(
+            status: model.status,
+            duration: statusOverlayDuration.seconds,
+            placement: statusOverlayPlacement,
+            transparency: statusOverlayTransparency
+        )
+        analytics.track(.overlayPreviewed)
     }
 }

MicStatusAI/Coordinators/HotKeyRecorderCoordinator.swift

@@ -16,6 +16,10 @@ final class HotKeyRecorderCoordinator: NSObject {
         button.window?.makeFirstResponder(button)
     }
 
+    func recordingDidChange(_ isRecording: Bool) {
+        parent.isRecording = isRecording
+    }
+
     func record(_ event: NSEvent, in button: HotKeyRecorderButton) {
         guard !event.isARepeat else { return }
 

MicStatusAI/Errors/MicrophoneError.swift

@@ -7,6 +7,21 @@ enum MicrophoneError: LocalizedError {
     case muteStateVerificationFailed
     case coreAudio(OSStatus)
 
+    var analyticsCategory: String {
+        switch self {
+        case .noDefaultInputDevice:
+            "no_default_input"
+        case .volumeControlUnavailable:
+            "volume_control_unavailable"
+        case .muteControlUnavailable:
+            "mute_control_unavailable"
+        case .muteStateVerificationFailed:
+            "mute_verification_failed"
+        case .coreAudio:
+            "core_audio"
+        }
+    }
+
     var errorDescription: String? {
         switch self {
         case .noDefaultInputDevice:

MicStatusAI/Generated/L10n.swift

@@ -5,11 +5,21 @@
 import Foundation
 
 public enum L10n {
+  /// Cancel
+  public static var actionCancel: String {
+    return tr(key: "action.cancel")
+  }
+
   /// Mute
   public static var actionMute: String {
     return tr(key: "action.mute")
   }
 
+  /// Mute or unmute the default microphone. Monitoring must be on.
+  public static var actionMuteHelp: String {
+    return tr(key: "action.muteHelp")
+  }
+
   /// Quit
   public static var actionQuit: String {
     return tr(key: "action.quit")
@@ -20,21 +30,31 @@ public enum L10n {
     return tr(key: "action.restoreHotkey")
   }
 
-  /// Start Monitoring
-  public static var actionStart: String {
-    return tr(key: "action.start")
-  }
-
-  /// Stop Monitoring
-  public static var actionStop: String {
-    return tr(key: "action.stop")
+  /// Retry
+  public static var actionRetry: String {
+    return tr(key: "action.retry")
   }
 
   /// Unmute
   public static var actionUnmute: String {
     return tr(key: "action.unmute")
   }
 
+  /// Share Anonymous Analytics
+  public static var analyticsEnabled: String {
+    return tr(key: "analytics.enabled")
+  }
+
+  /// Anonymous usage events are sent through Aptabase. Audio, microphone names, and shortcut keys are never collected.
+  public static var analyticsHelp: String {
+    return tr(key: "analytics.help")
+  }
+
+  /// Privacy
+  public static var analyticsTitle: String {
+    return tr(key: "analytics.title")
+  }
+
   /// CoreAudio error %d.
   public static func errorCoreAudio(_ p1: Int) -> String {
     return tr(key: "error.coreAudio", p1)
@@ -110,6 +130,11 @@ public enum L10n {
     return tr(key: "hotkey.recording")
   }
 
+  /// Recording…
+  public static var hotkeyRecordingStatus: String {
+    return tr(key: "hotkey.recordingStatus")
+  }
+
   /// Mute / Unmute Hotkey
   public static var hotkeyTitle: String {
     return tr(key: "hotkey.title")
@@ -135,6 +160,11 @@ public enum L10n {
     return tr(key: "monitoring.active")
   }
 
+  /// Monitor Microphone
+  public static var monitoringEnabled: String {
+    return tr(key: "monitoring.enabled")
+  }
+
   /// Monitoring Off
   public static var monitoringOff: String {
     return tr(key: "monitoring.off")
@@ -145,6 +175,11 @@ public enum L10n {
     return tr(key: "monitoring.paused")
   }
 
+  /// Start monitoring to use microphone controls.
+  public static var monitoringRequired: String {
+    return tr(key: "monitoring.required")
+  }
+
   /// Display Duration
   public static var overlayDuration: String {
     return tr(key: "overlay.duration")
@@ -185,6 +220,11 @@ public enum L10n {
     return tr(key: "overlay.placement.center")
   }
 
+  /// Show Preview
+  public static var overlayPreview: String {
+    return tr(key: "overlay.preview")
+  }
+
   /// Status Overlay
   public static var overlayTitle: String {
     return tr(key: "overlay.title")
@@ -195,6 +235,16 @@ public enum L10n {
     return tr(key: "overlay.transparency")
   }
 
+  /// About
+  public static var settingsAbout: String {
+    return tr(key: "settings.about")
+  }
+
+  /// GitHub
+  public static var settingsGithub: String {
+    return tr(key: "settings.github")
+  }
+
   /// Settings…
   public static var settingsOpen: String {
     return tr(key: "settings.open")
@@ -205,6 +255,16 @@ public enum L10n {
     return tr(key: "settings.title")
   }
 
+  /// Version %@
+  public static func settingsVersion(_ p1: String) -> String {
+    return tr(key: "settings.version", p1)
+  }
+
+  /// X
+  public static var settingsXProfile: String {
+    return tr(key: "settings.xProfile")
+  }
+
   /// Microphone Muted
   public static var statusMuted: String {
     return tr(key: "status.muted")

MicStatusAI/Info.plist

@@ -2,6 +2,8 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
+    <key>AptabaseAppKey</key>
+    <string>$(APTABASE_APP_KEY)</string>
     <key>CFBundleDevelopmentRegion</key>
     <string>$(DEVELOPMENT_LANGUAGE)</string>
     <key>CFBundleExecutable</key>