🤖 Merge PR DefinitelyTyped#72427 Fix for not returning null for array get commands by @daryllabar

Author: daryllabar

types/xrm/index.d.ts

@@ -1169,7 +1169,18 @@ declare namespace Xrm {
          */
         getAttribute(
             delegateFunction?: Collection.MatchingDelegate<Attributes.Attribute>,
-        ): Collection.ItemCollection<Attributes.Attribute> | null;
+        ): Attributes.Attribute[];
+
+        /**
+         * Gets a collection of attributes using a delegate function or gets all attributes if delegateFunction is not provided.
+         * @param T An Attribute type.
+         * @param delegateFunction A matching delegate function
+         * @returns An collection of attributes.
+         * @see {@link https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/clientapi/reference/collections External Link: Collections (Client API reference)}
+         */
+        getAttribute<T extends Attributes.Attribute>(
+            delegateFunction?: Collection.MatchingDelegate<Attributes.Attribute>,
+        ): T[];
 
         /**
          * Gets a control by name or index.
@@ -1194,7 +1205,18 @@ declare namespace Xrm {
          */
         getControl(
             delegateFunction?: Collection.MatchingDelegate<Controls.Control>,
-        ): Collection.ItemCollection<Controls.Control> | null;
+        ): Controls.Control[];
+
+        /**
+         * Gets a collection of controls using a delegate function or gets all controls if delegateFunction is not provided.
+         * @param T A Control type.  There is no guarentee that all control types will match.
+         * @param delegateFunction A matching delegate function.
+         * @returns An collection of controls.
+         * @see {@link https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/clientapi/reference/collections External Link: Collections (Client API reference)}
+         */
+        getControl<T extends Controls.Control>(
+            delegateFunction?: Collection.MatchingDelegate<Controls.Control>,
+        ): T[];
     }
 
     /**
@@ -1859,7 +1881,7 @@ declare namespace Xrm {
              * @param delegate A matching delegate function
              * @returns A T[] whose members have been validated by delegate or a entire array of T[]
              */
-            get(delegate?: MatchingDelegate<T>): T[] | null;
+            get(delegate?: MatchingDelegate<T>): T[];
 
             /**
              * Gets the length of the collection.

types/xrm/xrm-tests.ts

@@ -723,3 +723,38 @@ function ActionOnPostsave(context: Xrm.Events.PostSaveEventContext) {
         console.log(args.getSaveErrorInfo());
     }
 }
+
+// Demonstrate non-index/name getAttribute/getControl returns non-null array
+
+function GetAll(context: Xrm.FormContext) {
+    const allAttributes: Xrm.Attributes.Attribute[] = context.getAttribute();
+    const allAttributesTyped: Xrm.Attributes.StringAttribute[] = context.getAttribute<Xrm.Attributes.StringAttribute>();
+    const noAttributes: Xrm.Attributes.Attribute[] = context.getAttribute(() => false);
+    const noAttributesTyped: Xrm.Attributes.StringAttribute[] = context.getAttribute<Xrm.Attributes.StringAttribute>(
+        () => false,
+    );
+    if (
+        allAttributes === null
+        || allAttributesTyped === null
+        || noAttributes === null
+        || noAttributesTyped === null
+    ) {
+        throw new Error("Will return an empty array if no attributes are present.");
+    }
+
+    const allControls: Xrm.Controls.Control[] = context.getControl();
+    const allControlsTyped: Xrm.Controls.StringControl[] = context.getControl<Xrm.Controls.StringControl>();
+    const itemCollection: Xrm.Controls.Control[] = (context.getControl("mySection") as unknown as Xrm.Controls.Section)
+        .controls.get();
+    const noControls: Xrm.Controls.Control[] = context.getControl(() => false);
+    const noControlsTyped: Xrm.Controls.StringControl[] = context.getControl<Xrm.Controls.StringControl>(() => false);
+    if (
+        allControls === null
+        || allControlsTyped === null
+        || itemCollection === null
+        || noControls === null
+        || noControlsTyped === null
+    ) {
+        throw new Error("Will return an empty array if no controls are present.");
+    }
+}