Merge pull request #1716 from EnsembleUI/device_orientation

Device orientation

Author: TheNoumanDev

modules/ensemble/lib/framework/bindings.dart

@@ -44,6 +44,18 @@ abstract class BindingSource {
       String binding, DataContext dataContext) {
     RegExp variableNameRegex = RegExp('^[0-9a-z_]+', caseSensitive: false);
 
+    // Check for device bindings (both patterns)
+    String deviceExpr = 'ensemble.device.';
+    if (binding.startsWith(deviceExpr)) {
+      // For ensemble.device.property pattern
+      String property = binding.substring(deviceExpr.length);
+      return DeviceBindingSource(property);
+    } else if (binding.startsWith('device.')) {
+      // For device.property pattern
+      String property = binding.substring('device.'.length);
+      return DeviceBindingSource(property);
+    }
+
     // bindable storage
     String storageExpr = 'ensemble.storage.';
     String userExpr = 'ensemble.user.';
@@ -121,6 +133,18 @@ abstract class BindingSource {
       String variable = expression.substring(2, expression.length - 1).trim();
       RegExp variableNameRegex = RegExp('^[0-9a-z_]+', caseSensitive: false);
 
+      // Check for device bindings (both patterns)
+      String deviceExpr = 'ensemble.device.';
+      if (variable.startsWith(deviceExpr)) {
+        // For ensemble.device.property pattern
+        String property = variable.substring(deviceExpr.length);
+        return DeviceBindingSource(property);
+      } else if (variable.startsWith('device.')) {
+        // For device.property pattern
+        String property = variable.substring('device.'.length);
+        return DeviceBindingSource(property);
+      }
+
       // storage bindable
       String storageExpr = 'ensemble.storage.';
       String userExpr = 'ensemble.user.';
@@ -202,6 +226,11 @@ class StorageBindingSource extends BindingSource {
   StorageBindingSource(super.modelId);
 }
 
+/// bindable source backed by device
+class DeviceBindingSource extends BindingSource {
+  DeviceBindingSource(super.modelId);
+}
+
 /// TODO: consolidate this with StorageBindingSource
 class SystemStorageBindingSource extends BindingSource {
   SystemStorageBindingSource(super.modelId, {required this.storagePrefix});

modules/ensemble/lib/framework/data_context.dart

@@ -88,15 +88,19 @@ class DataContext implements Context {
       _contextMap['auth'] = GetIt.instance<AuthContextManager>();
     }
 
-    _addLegacyDataContext();
+    _addLegacyDataContext(buildContext);
   }
 
-  // For backward compatibility
-  void _addLegacyDataContext() {
+
     // device is a common name. If user already uses that, don't override it
     // This is now in ensemble.device.*
+  void _addLegacyDataContext(BuildContext? newBuildContext) {
     if (_contextMap['device'] == null) {
-      _contextMap['device'] = Device();
+        _contextMap['device'] = Device(newBuildContext);
+    } else {
+      // If device exists, update its context
+      final device = _contextMap['device'];
+      device.updateContext(newBuildContext);
     }
   }
 
@@ -468,7 +472,7 @@ class NativeInvokable extends ActionInvokable {
       'user': () => UserInfo(),
       'formatter': () => Formatter(),
       'utils': () => _EnsembleUtils(),
-      'device': () => Device(),
+      'device': () => Device(buildContext),
       'version': () => _cache['version'],
     };
   }

modules/ensemble/lib/framework/device.dart

@@ -1,3 +1,4 @@
+import 'dart:async';
 import 'dart:core';
 import 'dart:io';
 import 'dart:developer';
@@ -14,24 +15,64 @@ import 'package:ensemble_ts_interpreter/invokables/invokable.dart';
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
+import 'package:flutter/widgets.dart';
 import 'package:get_it/get_it.dart';
 import 'package:intl/intl.dart';
 
-/// get device information as well as requesting device permissions
 class Device
     with
         Invokable,
         MediaQueryCapability,
         LocationCapability,
-        DeviceInfoCapability {
+        DeviceInfoCapability,
+        WidgetsBindingObserver {
   static final Device _instance = Device._internal();
+  static late BuildContext context;
 
-  Device._internal();
+  Device._internal() {
+    WidgetsBinding.instance.addObserver(this);
+  }
 
-  factory Device() {
+  factory Device([BuildContext? buildContext]) {
+    if (buildContext != null) {
+      context = buildContext;
+    }
     return _instance;
   }
 
+  // method to update context
+  void updateContext(BuildContext? newContext) {
+    if (newContext != null) {
+      context = newContext;
+    }
+  }
+
+  @override
+  void didChangeMetrics() {
+    WidgetsBinding.instance
+        .addPostFrameCallback((_) => _handleMediaQueryChange());
+  }
+
+  void _handleMediaQueryChange() {
+    final newData = MediaQuery.of(context);
+
+    // Compare with existing static data
+    if (MediaQueryCapability.data?.orientation != newData.orientation ||
+        MediaQueryCapability.data?.size != newData.size) {
+      MediaQueryCapability.data = newData;
+
+      // Dispatch individual property changes
+      ScreenController().dispatchDeviceChanges(context, 'width', screenWidth);
+      ScreenController().dispatchDeviceChanges(context, 'height', screenHeight);
+      ScreenController()
+          .dispatchDeviceChanges(context, 'orientation', screenOrientation);
+      ScreenController()
+          .dispatchDeviceChanges(context, 'safeAreaTop', safeAreaTop);
+      ScreenController()
+          .dispatchDeviceChanges(context, 'safeAreaBottom', safeAreaBottom);
+    }
+  }
+
   @override
   Map<String, Function> getters() {
     return {
@@ -42,6 +83,7 @@ class Device
       // Media Query
       "width": () => screenWidth,
       "height": () => screenHeight,
+      "orientation": () => screenOrientation,
       "safeAreaTop": () => safeAreaTop,
       "safeAreaBottom": () => safeAreaBottom,
 
@@ -73,9 +115,7 @@ class Device
   }
 
   @override
-  Map<String, Function> setters() {
-    return {};
-  }
+  Map<String, Function> setters() => {};
 
   void openAppSettings([String? target]) {
     final settingType =
@@ -96,6 +136,7 @@ mixin MediaQueryCapability {
 
   int get screenWidth => _getData().size.width.toInt();
   int get screenHeight => _getData().size.height.toInt();
+  String get screenOrientation => _getData().orientation.toString();
   int get safeAreaTop => _getData().padding.top.toInt();
   int get safeAreaBottom => _getData().padding.bottom.toInt();
 }

modules/ensemble/lib/screen_controller.dart

@@ -578,6 +578,16 @@ class ScreenController {
     }
   }
 
+  void dispatchDeviceChanges(
+      BuildContext context, String property, dynamic value) {
+    ScopeManager? scopeManager = getScopeManager(context);
+
+    if (scopeManager != null) {
+      scopeManager
+          .dispatch(ModelChangeEvent(DeviceBindingSource(property), value));
+    }
+  }
+
   void dispatchSystemStorageChanges(
       BuildContext context, String key, dynamic value,
       {required String storagePrefix}) {