Not compatible with TypeScript 4.6

[SimenB]

Issue or Feature

• If this is an issue with installation, I have read the troubleshooting guide.

Steps to Reproduce

https://github.com/SimenB/canvas-ts

node_modules/canvas/types/index.d.ts:170:2 - error TS2416: Property 'globalCompositeOperation' in type 'NodeCanvasRenderingContext2D' is not assignable to the same property in base type 'CanvasRenderingContext2D'.
  Type '"clear" | "color" | "color-burn" | "color-dodge" | "copy" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | ... 16 more ... | "destination"' is not assignable to type 'GlobalCompositeOperation'.
    Type '"clear"' is not assignable to type 'GlobalCompositeOperation'.

170  globalCompositeOperation: 'saturate' | 'clear' | 'copy' | 'destination' | 'source-over' | 'destination-over' |
     ~~~~~~~~~~~~~~~~~~~~~~~~


Found 1 error in node_modules/canvas/types/index.d.ts:170

Your Environment

• Version of node-canvas (output of npm list canvas or yarn list canvas): 2.9.0
• Environment (e.g. node 4.2.0 on Mac OS X 10.8): Node 16.14.0 on macOS 12.2.1 (TypeScript 4.6)

[Caesarovich]

Experiencing the same issue here

[Apolofx]

Same issue here too, found this while comparing Typescript new release v4.6.2 with v4.5.5

Not sure if the issue should be here or in Typescript repo

[SimenB]

Here, typescript being stricter should not be reverted 😀

[zbjornson]

I think we need to finally redo all of the types from scratch instead of trying to extend the native HTML Canvas types. I'll try to do this this week.

[chearon]

Isn't this fixed by #1986? I agree about not extending DOM types. I was going to suggest that in the PR.

[zbjornson]

#1986 broke support for our non-standard "saturate" operator, but otherwise yes.

[chearon]

I didn't see a way not to break that, as long as we were trying to be assignable to the DOM type.

[nathantokarz]

Is there a way to work around this by downgrading to a different type-script version? unable to run any builds due to this error

[Apolofx]

Is there a way to work around this by downgrading to a different type-script version? unable to run any builds due to this error

I locked Typescript version to 4.5.5 in my package.json and that did the job

[nathantokarz]

changing my typescript version to 4.5.5 worked for me as well! Thanks

[ScreamZ]

Also experiencing the issue with 4.6 with CanvasRenderingContext2D which is an alias of NodeCanvasRenderingContext2D downgrading to 4.5.5 resolved the issue.

[LinusU]

#1986 broke support for our non-standard "saturate" operator, but otherwise yes.

I didn't see a way not to break that, as long as we were trying to be assignable to the DOM type.

Maybe we should deprecate "saturate" with a link to an issue for anyone to chime in with use cases. My guess is that it was just thrown in because it exists in Cairo, but it might not actually be widely used.

[Rush]

You can upgrade to my "temporary release" of node-canvas 2.9.0 with just the typings fix. Just change your package.json manually to:

 "canvas": "Rush/node-canvas#v2.9.0-patched",

The typings fix is here: https://github.com/Rush/node-canvas/blob/636e4dbc0a18a5861d77620b3658b944f778691e/types/index.d.ts#L170

[zbjornson]

v2.9.1 is now published.