PaYamlV3 schema and OM updates (#713)

## Changes

- Remove `Groups` from control containers
- Add `ControlInstance.Group` name to allow a control to belong to a group for use in Studio
- Removed `InstanceCreationParameters` as no longer needed
- Add `ControlInstance.Variant` as this will be part of required properties for some 1P controls

- Updated v3 yaml schema:
  - With all updates above
  - Added top-level `DataSources` property to PaModule files.

schemas/pa-yaml/v3.0/pa.schema.yaml

@@ -14,6 +14,9 @@ properties:
     $ref: "#/definitions/Screens-name-instance-map"
   ComponentDefinitions:
     $ref: "#/definitions/ComponentDefinitions-name-instance-map"
+  DataSources:
+    $ref: "#/definitions/DataSources-name-instance-map"
+
 defaultSnippets:
   - label: App
     body:
@@ -56,9 +59,7 @@ definitions:
     type: object
     additionalProperties: false
     properties:
-      CreationParameters: { $ref: "#/definitions/InstanceCreationParameters" }
       Properties: { $ref: "#/definitions/Properties-formula-map" }
-      Groups: { $ref: "#/definitions/Groups-of-controls" }
       Children: { $ref: "#/definitions/Children-Control-instance-sequence" }
 
   Children-Control-instance-sequence:
@@ -170,6 +171,7 @@ definitions:
     required: [Control]
     properties:
       Control: { $ref: "#/definitions/ControlTypeId" }
+      Group: { $ref: "#/definitions/Control-Group-name" }
       Properties: { $ref: "#/definitions/Properties-formula-map" }
     if:
       required: [Control]
@@ -187,6 +189,7 @@ definitions:
               Control: true
               ComponentLibraryUniqueName: { $ref: "#/definitions/ComponentLibrary-unique-name" }
               ComponentName: { $ref: "#/definitions/ComponentDefinition-name" }
+              Group: true
               Properties: true
         - if:
             properties:
@@ -197,73 +200,26 @@ definitions:
             properties:
               Control: true
               ComponentName: { $ref: "#/definitions/CodeComponent-name" }
+              Group: true
               Properties: true
     else:
       additionalProperties: false
       properties:
         Control: true
-        CreationParameters: { $ref: "#/definitions/InstanceCreationParameters" }
+        Variant:
+          type: string
+          minLength: 1
+        Group: true
         Properties: true
-        Groups: { $ref: "#/definitions/Groups-of-controls" }
         Children: { $ref: "#/definitions/Children-Control-instance-sequence" }
 
-  InstanceCreationParameters:
-    description: A set of optional internal creation parameters coming from the Maker.
-    type: object
-    additionalProperties: false
-    properties:
-      Variant:
-        type: string
-        minLength: 1
-      Layout:
-        type: string
-        minLength: 1
-      ParentTemplate:
-        description: Metadata needed to identify the parent template that originally created this instance.
-        type: object
-        additionalProperties: false
-        properties:
-          CompositionName:
-            description: The name of the composition template that originally created this instance.
-            type: string
-            minLength: 1
-          Variant:
-            description: The variant of the parent template that originally created this instance.
-            type: string
-            minLength: 1
-      MetadataId:
-        type: string
-        minLength: 1
-      StyleName:
-        type: string
-        minLength: 1
-
-  Groups-of-controls:
+  Control-Group-name:
     description: |-
-      A mapping of groups of controls under this container. The keys of this object represent the name of the Group.
+      The name of the group of controls to associate this control with.
       
       Groups do not impact the behavior of an app, but are used in the Studio to organize controls when editing.
-    type: object
-    propertyNames: { $ref: "#/definitions/Control-instance-name" }
-    additionalProperties:
-      type: object
-      required: [ControlNames]
-      additionalProperties: false
-      properties:
-        ControlNames:
-          description: |-
-            An array of the names of controls that are part of this group.
-            A group must have at least two (2) controls in it.
-          type: array
-          minItems: 2
-          items: { $ref: "#/definitions/Control-instance-name" }
-    defaultSnippets:
-      - label: Add Group
-        body:
-          ${1:Group1}:
-            ControlNames:
-              - ${2:ControlName1}
-              - ${3:ControlName2}
+    allOf:
+      - { $ref: "#/definitions/Control-instance-name" }
 
   CodeComponent-name:
     description: |-
@@ -306,7 +262,6 @@ definitions:
                   - Height
                   - Width
                   - OnReset
-        Groups: { $ref: "#/definitions/Groups-of-controls" }
         Children: { $ref: "#/definitions/Children-Control-instance-sequence" }
 
   ComponentDefinition-name:
@@ -436,6 +391,35 @@ definitions:
       pattern: |-
         [.\\/:*?"<>|]
 
+
+  DataSources-name-instance-map:
+    type: object
+    propertyNames: { $ref: "#/definitions/DataSource-name" }
+    additionalProperties:
+      $ref: "#/definitions/DataSource-instance"
+
+  DataSource-name:
+    $ref: "#/definitions/entity-name"
+
+  DataSource-Type:
+    enum:
+      - DataverseTable
+
+  DataSource-instance:
+    type: object
+    required: [Type]
+    properties:
+      Type: { $ref: "#/definitions/DataSource-Type" }
+    oneOf:
+      - required: [Type]
+        additionalProperties: false
+        properties:
+          Type:
+            const: DataverseTable
+          TableLogicalName:
+            type: string
+            minLength: 1
+
   Properties-formula-map:
     description: >-
       A map of property names to formulas.

src/PAModel/packages.lock.json

@@ -2,12 +2,6 @@
   "version": 1,
   "dependencies": {
     ".NETStandard,Version=v2.0": {
-      "Microsoft.Net.Compilers.Toolset.Framework": {
-        "type": "Direct",
-        "requested": "[4.10.0-3.24216.12, )",
-        "resolved": "4.10.0-3.24216.12",
-        "contentHash": "Y1T1ZN3cHWToRYZHhRs8xby1tMCkF23Jb//zK+Tdf4ourzwbMQ4GiTRVVFAlWvmA10iVNUyCZucAeLt5XeiDqA=="
-      },
       "NETStandard.Library": {
         "type": "Direct",
         "requested": "[2.0.3, )",
@@ -103,12 +97,6 @@
       }
     },
     "net8.0": {
-      "Microsoft.Net.Compilers.Toolset.Framework": {
-        "type": "Direct",
-        "requested": "[4.10.0-3.24216.12, )",
-        "resolved": "4.10.0-3.24216.12",
-        "contentHash": "Y1T1ZN3cHWToRYZHhRs8xby1tMCkF23Jb//zK+Tdf4ourzwbMQ4GiTRVVFAlWvmA10iVNUyCZucAeLt5XeiDqA=="
-      },
       "Newtonsoft.Json": {
         "type": "Direct",
         "requested": "[13.0.1, )",

src/Persistence.Tests/PaYaml/Serialization/PaYamlSerializerTests.cs

@@ -86,18 +86,29 @@ public void DeserializeExamplePaYamlScreen(string path, int expectedScreenProper
         if (expectedScreenChildrenCount == 0)
             screen.Children.Should().BeNull();
         else
+        {
             screen.Children.Should().HaveCount(expectedScreenChildrenCount);
+            GetGroupCount(screen).Should().Be(expectedScreenGroupsCount);
+        }
 
         if (expectedDescendantsCount == 0)
             screen.Properties.Should().BeNull();
         else
             screen.DescendantControlInstances().Should().HaveCount(expectedDescendantsCount);
 
-        if (expectedScreenGroupsCount == 0)
-            screen.Properties.Should().BeNull();
-        else
-            screen.Groups.Should().HaveCount(expectedScreenGroupsCount);
-        screen.DescendantControlInstances().SelectMany(nc => nc.Value.Groups ?? []).Should().HaveCount(expectedTotalGroupsCount - expectedScreenGroupsCount);
+        screen.DescendantControlInstances().Sum(nc => GetGroupCount(nc.Value)).Should().Be(expectedTotalGroupsCount - expectedScreenGroupsCount);
+
+        static int GetGroupCount(IPaControlInstanceContainer container)
+        {
+            if (container.Children is null)
+                return 0;
+
+            return container.Children
+                .Select(c => c.Value.GroupName)
+                .Where(g => g != null)
+                .Distinct()
+                .Count();
+        }
     }
 
     [TestMethod]

src/Persistence/PaYaml/Models/SchemaV3/ComponentDefinition.cs

@@ -26,8 +26,6 @@ public record ComponentDefinition : IPaControlInstanceContainer
 
     public NamedObjectMapping<PFxExpressionYaml>? Properties { get; init; }
 
-    public NamedObjectMapping<ControlGroup>? Groups { get; init; }
-
     public NamedObjectSequence<ControlInstance>? Children { get; init; }
 }
 

src/Persistence/PaYaml/Models/SchemaV3/ControlInstance.cs

@@ -20,15 +20,20 @@ public ControlInstance(string controlTypeId)
     [property: YamlMember(Alias = "Control")]
     public required string ControlTypeId { get; init; }
 
+    public string? Variant { get; init; }
+
     public string? ComponentName { get; init; }
 
     public string? ComponentLibraryUniqueName { get; init; }
 
-    public InstanceCreationParameters? CreationParameters { get; init; }
+    /// <summary>
+    /// The name of the group of controls that this control should be grouped with.
+    /// This does not impact the visual layout of the control or behavior, but is used to group controls together for organizational purposes from within the Studio.
+    /// </summary>
+    [property: YamlMember(Alias = "Group")]
+    public string? GroupName { get; init; }
 
     public NamedObjectMapping<PFxExpressionYaml>? Properties { get; init; }
 
-    public NamedObjectMapping<ControlGroup>? Groups { get; init; }
-
     public NamedObjectSequence<ControlInstance>? Children { get; init; }
 }

src/Persistence/PaYaml/Models/SchemaV3/IPaControlInstanceContainer.cs

@@ -5,6 +5,5 @@ namespace Microsoft.PowerPlatform.PowerApps.Persistence.PaYaml.Models.SchemaV3;
 
 public interface IPaControlInstanceContainer
 {
-    NamedObjectMapping<ControlGroup>? Groups { get; }
     NamedObjectSequence<ControlInstance>? Children { get; }
 }

src/Persistence/PaYaml/Models/SchemaV3/ScreenInstance.cs

@@ -7,11 +7,7 @@ namespace Microsoft.PowerPlatform.PowerApps.Persistence.PaYaml.Models.SchemaV3;
 
 public record ScreenInstance : IPaControlInstanceContainer
 {
-    public InstanceCreationParameters? CreationParameters { get; init; }
-
     public NamedObjectMapping<PFxExpressionYaml>? Properties { get; init; }
 
-    public NamedObjectMapping<ControlGroup>? Groups { get; init; }
-
     public NamedObjectSequence<ControlInstance>? Children { get; init; }
 }