Argument of type 'WebPartContext' is not assignable to parameter of type 'ISPFXContext'.

[Ofer-Gal]

Category

• Enhancement
• [] Bug
• [] Question
• [ X] Documentation gap/issue

Version

Please specify what version of the library you are using: [ 3.4.1 ]

Please specify what version(s) of SharePoint you are targeting: [ SPO SPFx 1.15.0 ]

If you are not using the latest release, please update and see if the issue is resolved before submitting an issue.

Expected / Desired Behavior / Question

No issue with code from the example

Observed Behavior

Now that I upgraded to SPFx 1.15.0 (with newer TS and strict ESlint) I get TS Error:

Argument of type 'WebPartContext' is not assignable to parameter of type 'ISPFXContext'.
The types of 'msGraphClientFactory.getClient' are incompatible between these types.
Type '(version: "3") => Promise' is not assignable to type '() => Promise'.ts(2345)

Steps to Reproduce

Just use the code from the documentation the error will show.

Is PnP.JS not ready for 1.15.1? any workaround that will work?

Thank you for your help!

[IvanTheBearable]

MSGraphClientFactory in 1.15 is defined with this getClient method:
getClient(version: '3'): Promise<MSGraphClientV3>;

ISPFXContext declares it as:

msGraphClientFactory?: {
    getClient: () => Promise<any>;
};

If you are not using Graph then this workaround should get past the compiler errors:
spfi().using(SPFx((this.context as unknown) as ISPFXContext))

If you are using Graph then it may be more complex. I don't know the inner workings of PnPjs well enough to be sure. A quick code search seems to suggest it doesn't get used at all but I am probably missing something.

[Ofer-Gal]

the code is not in the web part "init" so "this.context" does not exist but comes as parameter Type "WebPartContext"

[juliemturner]

@IvanTheBearable is correct, this is a viable typing workaround:

spfi().using(SPFx((context as unknown) as ISPFXContext))

I prefer this:

spfi().using(SPFx({pageContext: context.pageContext}));

And no we do not use the msGraphClient in PnPjs.

We'll work on updates to address SPFx 1.15's release for our next version.

[github-actions]

This issue is locked for inactivity or age. If you have a related issue please open a new issue and reference this one. Closed issues are not tracked.