Merge pull request #1289 from carp-dk:spm-agb-updates

Add support for iOS light sensor and update dependencies

Author: iarata

packages/light/.gitignore

@@ -0,0 +1,128 @@
+# Miscellaneous
+*.class
+*.lock
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+.build/
+.swiftpm/
+build/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# Visual Studio Code related
+.classpath
+.project
+.settings/
+.vscode/
+
+# Flutter repo-specific
+/bin/cache/
+/bin/internal/bootstrap.bat
+/bin/internal/bootstrap.sh
+/bin/mingit/
+/dev/benchmarks/mega_gallery/
+/dev/bots/.recipe_deps
+/dev/bots/android_tools/
+/dev/devicelab/ABresults*.json
+/dev/docs/doc/
+/dev/docs/flutter.docs.zip
+/dev/docs/lib/
+/dev/docs/pubspec.yaml
+/dev/integration_tests/**/xcuserdata
+/dev/integration_tests/**/Pods
+/packages/flutter/coverage/
+version
+analysis_benchmark.json
+
+# packages file containing multi-root paths
+.packages.generated
+
+# Flutter/Dart/Pub related
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+**/generated_plugin_registrant.dart
+.packages
+.pub-cache/
+.pub/
+build/
+flutter_*.png
+linked_*.ds
+unlinked.ds
+unlinked_spec.ds
+
+# Android related
+**/android/**/gradle-wrapper.jar
+.gradle/
+**/android/captures/
+**/android/gradlew
+**/android/gradlew.bat
+**/android/local.properties
+**/android/**/GeneratedPluginRegistrant.java
+**/android/key.properties
+*.jks
+
+# iOS/XCode related
+**/ios/**/*.mode1v3
+**/ios/**/*.mode2v3
+**/ios/**/*.moved-aside
+**/ios/**/*.pbxuser
+**/ios/**/*.perspectivev3
+**/ios/**/*sync/
+**/ios/**/.sconsign.dblite
+**/ios/**/.tags*
+**/ios/**/.vagrant/
+**/ios/**/DerivedData/
+**/ios/**/Icon?
+**/ios/**/Pods/
+**/ios/**/.symlinks/
+**/ios/**/profile
+**/ios/**/xcuserdata
+**/ioa/**/.build
+**/ios/.generated/
+**/ios/Flutter/.last_build_id
+**/ios/Flutter/App.framework
+**/ios/Flutter/Flutter.framework
+**/ios/Flutter/Flutter.podspec
+**/ios/Flutter/Generated.xcconfig
+**/ios/Flutter/ephemeral
+**/ios/Flutter/app.flx
+**/ios/Flutter/app.zip
+**/ios/Flutter/flutter_assets/
+**/ios/Flutter/flutter_export_environment.sh
+**/ios/ServiceDefinitions.json
+**/ios/Runner/GeneratedPluginRegistrant.*
+
+# macOS
+**/macos/Flutter/GeneratedPluginRegistrant.swift
+**/macos/Flutter/ephemeral
+
+# Coverage
+coverage/
+
+# Symbols
+app.*.symbols
+
+# Exceptions to above rules.
+!**/ios/**/default.mode1v3
+!**/ios/**/default.mode2v3
+!**/ios/**/default.pbxuser
+!**/ios/**/default.perspectivev3
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
+!/dev/ci/**/Gemfile.lock
+
+.sdkmanrc
+**/.cxx/
+.zed/settings.json
+android/bin

packages/light/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 5.0.0
+
+* Update Gradle and Kotlin
+* Added support for iOS Ambient reading - Requires specific permissions and certificates (see [Apple Docs | Configuring for SensorKit](https://developer.apple.com/documentation/sensorkit/configuring-your-project-for-sensor-reading))
+
 ## 4.1.1
 
 * upgrading ios version

packages/light/README.md

@@ -2,33 +2,67 @@
 
 [![pub package](https://img.shields.io/pub/v/light.svg)](https://pub.dartlang.org/packages/light)
 
-A Flutter plugin for collecting ambient light data from the [Android Environment Sensors](https://developer.android.com/develop/sensors-and-location/sensors/sensors_environment).
+A Flutter plugin for collecting ambient light data on Android and iOS.
+
+Android uses the [Environment Sensors API](https://developer.android.com/develop/sensors-and-location/sensors/sensors_environment).
+iOS uses [SensorKit ambient light sensor](https://developer.apple.com/documentation/sensorkit/srsensor/ambientlightsensor).
 
 ## Install
 
-Add `light` as a dependency in the `pubspec.yaml` file.
+Add `light` as a dependency in `pubspec.yaml`.
 
-For help on adding as a dependency, view the [documentation](https://flutter.io/using-packages/).
+## iOS requirements
 
-## Usage
+> [!CAUTION]
+> Not all devices have SensorKit. Requires iOS 14 or higher. Reading sensory data from iOS requires research entitlements and previous approval from Apple for reading sensory data. Please see the documentations at [Configuring your project for sensor reading](https://developer.apple.com/documentation/sensorkit/configuring-your-project-for-sensor-reading).
+
+SensorKit requires more setup than Android.
+
+1. Enable the SensorKit entitlement and include ambient light in your app entitlements:
+
+```xml
+<key>com.apple.developer.sensorkit.reader.allow</key>
+<array>
+  <string>ambient-light-sensor</string>
+</array>
+```
+
+SensorKit access is entitlement-gated by Apple. Without approved entitlement provisioning, iOS returns an invalid-entitlement error.
+
+2. Add SensorKit purpose text in `Info.plist`:
+
+```xml
+<key>NSSensorKitUsageDetail</key>
+<dict>
+  <key>SRSensorUsageAmbientLightSensor</key>
+  <string>Explain why your app needs ambient light sensor data.</string>
+</dict>
+```
 
-Use the singleton `Light()` to listen on the `lightSensorStream` stream.
+3. Request authorization before or while starting the stream:
 
 ```dart
-  StreamSubscription<int>? _lightEvents;
-
-  void startListening() {
-    try {
-      _lightEvents =
-          Light().lightSensorStream.listen((luxValue) => setState(() {
-                // Do something with the lux value
-              }));
-    } catch (exception) {
-      print(exception);
-    }
-  }
-
-  void stopListening() {
-    _lightEvents?.cancel();
-  }
+final LightAuthorizationStatus status =
+    await Light().requestAuthorization();
+```
+
+On Android, `requestAuthorization()` returns `LightAuthorizationStatus.unavailable` and no runtime permission prompt is required.
+
+If iOS setup is incomplete, the stream emits a `PlatformException` (for example, missing entitlement or usage description).
+
+## Usage
+
+```dart
+StreamSubscription<int>? _lightEvents;
+
+Future<void> startListening() async {
+  await Light().requestAuthorization(); // no-op on Android
+  _lightEvents = Light().lightSensorStream.listen((int luxValue) {
+    // Do something with lux.
+  });
+}
+
+void stopListening() {
+  _lightEvents?.cancel();
+}
 ```

packages/light/android/build.gradle

@@ -2,14 +2,14 @@ group = "dk.cachet.light"
 version = "1.0-SNAPSHOT"
 
 buildscript {
-    ext.kotlin_version = "1.8.22"
+    ext.kotlin_version = "2.2.20"
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath("com.android.tools.build:gradle:8.1.0")
+        classpath("com.android.tools.build:gradle:8.12.1")
         classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version")
     }
 }
@@ -35,7 +35,7 @@ android {
     }
 
     kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_11
+        jvmTarget = "11"
     }
 
     sourceSets {
@@ -47,7 +47,7 @@ android {
         minSdk = 21
     }
 
-    def flutterRoot = {
+    dependencies {
         testImplementation("org.jetbrains.kotlin:kotlin-test")
         testImplementation("org.mockito:mockito-core:5.0.0")
     }

packages/light/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME