Error with FormContext extension with latest types/xrm 9.0.84

[mrmwink-wtwco]

Hi,

With the latest version of the types/xrm 9.0.84 I get the following error with any forms context generated by dataverse-gen / dataverse-ify

Interface 'new_xxxxxxxFormContext' incorrectly extends interface 'FormContext'.
The types returned by 'getAttribute(...)' are incompatible between these types.
Type 'Attribute[]' is missing the following properties from type 'ItemCollection<Attribute>': get, getLengthts(2430)

Rolling back to previous types continues to work, am I missing something?

Thank

Mike

[kschepperly]

I am also having this same issue.
Interface 'new_xxxxxxxFormContext' incorrectly extends interface 'FormContext'. The types returned by 'getAttribute(...)' are incompatible between these types. Type 'Attribute<any>[]' is missing the following properties from type 'ItemCollection<Attribute<any>>': get, getLength

It appears that the overloads for getAttribute (Line 1170) and getControl (Line 1193) were modified in types/xrm 9.0.84 on Dec 4, 2024. The return types changed as shown below.

PR 71703

BEFORE:

    // Line 1176
    getAttribute(
        delegateFunction: Collection.MatchingDelegate<Attributes.Attribute>
    ): Attributes.Attribute[];

    // Line 1205
    getControl(
        delegateFunction: Collection.MatchingDelegate<Controls.Control>
    ): Controls.Control[];

AFTER:
Line 1170

    getAttribute(
        delegateFunction?: Collection.MatchingDelegate<Attributes.Attribute>
    ): Collection.ItemCollection<Attributes.Attribute> | null;

Line 1193

    getControl(
        delegateFunction?: Collection.MatchingDelegate<Controls.Control>
    ): Collection.ItemCollection<Controls.Control> | null;

The ItemCollection interface defines two additional functions get and getLength which are not present on a standard array. Hence the error as datavers-ify is still using the standard array.

I managed to work around the error by manually changing my local generated FormContext files as below. @scottdurow is this something that can be updated in your templates?

export interface new_xxxxxxxFormContext extends Xrm.FormContext {
    // getAttribute(): Xrm.Attributes.Attribute[];
    // REPLACE WITH ⬇️
    getAttribute(delegateFunction?: Xrm.Collection.MatchingDelegate<Xrm.Attributes.Attribute>): Xrm.Collection.ItemCollection<Xrm.Attributes.Attribute> | null;
    getAttribute<T extends Xrm.Attributes.Attribute>(attributeName: string): T;
    getAttribute(attributeName: string): Xrm.Attributes.Attribute;
    getAttribute(index: number): Xrm.Attributes.Attribute;

    // getControl(): Xrm.Controls.Control[];
    // REPLACE WITH ⬇️
    getControl(delegateFunction?: Xrm.Collection.MatchingDelegate<Xrm.Controls.Control>): Xrm.Collection.ItemCollection<Xrm.Controls.Control> | null;
    getControl<T extends Xrm.Controls.Control>(controlName: string): T;
    getControl(controlName: string): Xrm.Controls.Control;
    getControl(index: number): Xrm.Controls.Control;
    ...
}

[mrmwink-wtwco]

Good shout, I completely forgot you can modify the templates yourself locally so I've applied the change to my _templates for entity.ejs for now as a workaround and works like a charm.

I'll keep this open in case there is a response from Scott re updating the templates but if I get chance I'll create a PR with the change.