openhaystack/openhaystack-mobile/lib/accessory/accessory_dto.dart

/// This class is used for de-/serializing data to the JSON transfer format.
class AccessoryDTO {
  int id;
  List<double> colorComponents;
  String name;
  double? lastDerivationTimestamp;
  String? symmetricKey;
  int? updateInterval;
  String privateKey;
  String icon;
  bool isDeployed;
  String colorSpaceName;
  bool usesDerivation;
  String? oldestRelevantSymmetricKey;
  bool isActive;

  /// Creates a transfer object to serialize to the JSON export format.
  /// 
  /// This implements the [toJson] method used by the Dart JSON serializer.
  /// ```dart
  ///   var accessoryDTO = AccessoryDTO(...);
  ///   jsonEncode(accessoryDTO);
  /// ```
  AccessoryDTO({
    required this.id,
    required this.colorComponents,
    required this.name,
    this.lastDerivationTimestamp,
    this.symmetricKey,
    this.updateInterval,
    required this.privateKey,
    required this.icon,
    required this.isDeployed,
    required this.colorSpaceName,
    required this.usesDerivation,
    this.oldestRelevantSymmetricKey,
    required this.isActive,
  });

  /// Creates a transfer object from deserialized JSON data.
  /// 
  /// The data is only decoded and not processed further.
  /// 
  /// Typically used with JSON decoder.
  /// ```dart
  ///   String json = '...';
  ///   var accessoryDTO = AccessoryDTO.fromJSON(jsonDecode(json));
  /// ```
  /// 
  /// This implements the [toJson] method used by the Dart JSON serializer.
  /// ```dart
  ///   var accessoryDTO = AccessoryDTO(...);
  ///   jsonEncode(accessoryDTO);
  /// ```
  AccessoryDTO.fromJson(Map<String, dynamic> json)
    : id = json['id'],
      colorComponents = List.from(json['colorComponents'])
        .map((val) => double.parse(val.toString())).toList(),
      name = json['name'],
      lastDerivationTimestamp = json['lastDerivationTimestamp'] ?? 0,
      symmetricKey = json['symmetricKey'] ?? '',
      updateInterval = json['updateInterval'] ?? 0,
      privateKey = json['privateKey'],
      icon = json['icon'],
      isDeployed = json['isDeployed'],
      colorSpaceName = json['colorSpaceName'],
      usesDerivation = json['usesDerivation'] ?? false,
      oldestRelevantSymmetricKey = json['oldestRelevantSymmetricKey'] ?? '',
      isActive = json['isActive'];

  /// Creates a JSON map of the serialized transfer object.
  /// 
  /// Typically used by JSON encoder.
  /// ```dart
  ///   var accessoryDTO = AccessoryDTO(...);
  ///   jsonEncode(accessoryDTO);
  /// ```
  Map<String, dynamic> toJson() => usesDerivation ? {
    // With derivation
    'id': id,
    'colorComponents': colorComponents,
    'name': name,
    'lastDerivationTimestamp': lastDerivationTimestamp,
    'symmetricKey': symmetricKey,
    'updateInterval': updateInterval,
    'privateKey': privateKey,
    'icon': icon,
    'isDeployed': isDeployed,
    'colorSpaceName': colorSpaceName,
    'usesDerivation': usesDerivation,
    'oldestRelevantSymmetricKey': oldestRelevantSymmetricKey,
    'isActive': isActive,
  } : {
    // Without derivation (skip rolling key params)
    'id': id,
    'colorComponents': colorComponents,
    'name': name,
    'privateKey': privateKey,
    'icon': icon,
    'isDeployed': isDeployed,
    'colorSpaceName': colorSpaceName,
    'usesDerivation': usesDerivation,
    'isActive': isActive,
  };

}