External Component Node #1

Author: SaadArdati

lib/src/api/node_json_converter.dart

@@ -9,8 +9,8 @@ import 'package:json_annotation/json_annotation.dart';
 import 'nodes/nodes.dart';
 
 /// A deserializer function that takes a map as input and deserializes it into
-/// a [SceneNode].
-typedef JsonNodeDeserializer = SceneNode? Function(Map<dynamic, dynamic> json);
+/// a [BaseNode].
+typedef JsonNodeDeserializer = BaseNode? Function(Map<dynamic, dynamic> json);
 
 /// [NodeJsonConverter] deserializes JSON and converts it into nodes.
 ///
@@ -73,6 +73,7 @@ class NodeJsonConverter implements JsonConverter<BaseNode?, Map> {
       'listView': ListViewNode.fromJson,
       'pageView': PageViewNode.fromJson,
       'tabBar': TabBarNode.fromJson,
+      'external': ExternalComponentNode.fromJson,
     };
   }
 
@@ -103,7 +104,7 @@ class NodeJsonConverter implements JsonConverter<BaseNode?, Map> {
   @override
   BaseNode? fromJson(Map json) {
     if (json['type'] == null || _registry[json['type']] == null) {
-      throw UnsupportedError('Unsupported node type : ${json["type"]}');
+      throw UnsupportedError('Unsupported node type: ${json["type"]}');
     }
     return _registry[json['type']]!(json);
   }

lib/src/api/nodes/external_component_node.dart

@@ -0,0 +1,55 @@
+// Copyright (c) 2022, Codelessly.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE.md file.
+
+import 'package:json_annotation/json_annotation.dart';
+
+import '../mixins.dart';
+import '../models/models.dart';
+import 'nodes.dart';
+
+part 'external_component_node.g.dart';
+
+/// An inert node that does nothing.
+/// This is populated dynamically through the Codelessly SDK.
+@JsonSerializable()
+class ExternalComponentNode extends BaseNode with CustomPropertiesMixin {
+  @override
+  final String type = 'external';
+
+  /// A user-defined ID that is used to map this node to a widget builder.
+  /// The reason we allow an external ID is to allow users to define friendly
+  /// names for their dynamic nodes instead of arbitrarily-generated IDs.
+  /// Another reason is that the ID can be used more than once to map multiple
+  /// nodes to the same widget builder.
+  String? builderID;
+
+  /// Creates an [ExternalComponentNode] with the given data.
+  ExternalComponentNode({
+    required super.id,
+    required super.name,
+    required super.basicBoxLocal,
+    required this.builderID,
+    super.outerBoxLocal,
+    super.retainedOuterBoxLocal,
+    super.visible,
+    super.rotationDegrees,
+    super.alignment,
+    super.margin,
+    super.padding,
+    super.horizontalFit,
+    super.verticalFit,
+    super.flex,
+    super.constraints,
+    super.edgePins,
+    super.aspectRatioLock,
+    super.positioningMode,
+  });
+
+  /// Creates a [ExternalComponentNode] from a JSON object.
+  factory ExternalComponentNode.fromJson(Map json) =>
+      _$ExternalComponentNodeFromJson(json);
+
+  @override
+  Map toJson() => _$ExternalComponentNodeToJson(this);
+}

lib/src/api/nodes/external_component_node.g.dart

@@ -11,6 +11,7 @@ export 'canvas_node.dart';
 export 'checkbox_node.dart';
 export 'divider_node.dart';
 export 'dropdown_node.dart';
+export 'external_component_node.dart';
 export 'embedded_video_node.dart';
 export 'expansion_tile_node.dart';
 export 'floating_action_button_node.dart';
@@ -33,10 +34,10 @@ export 'single_placeholder_node.dart';
 export 'slider_node.dart';
 export 'spacer_node.dart';
 export 'switch_node.dart';
+export 'tab_bar_node.dart';
 export 'text_field_node.dart';
 export 'text_node.dart';
 export 'variance_node.dart';
 export 'web_view_google_maps_properties.dart';
 export 'web_view_node.dart';
 export 'web_view_twitter_properties.dart';
-export 'tab_bar_node.dart';