cube icon indicating copy to clipboard operation
cube copied to clipboard

Deprecation warning but TypeScript still refers to deprecated value

Open c-kirkeby opened this issue 1 year ago • 3 comments

Describe the bug The new version of the React client library gives a deprecation warning if you pass the prop cubejsApi to CubeProvider but gives type errors if you use the new cubeApi value.

Looks like this was introduced in https://github.com/cube-js/cube/pull/7300

To Reproduce Install @cubejs-client/[email protected].

Create a

Expected behavior The CubeProviderProps type should contain the cubeApi type.

Screenshots image

Minimally reproducible Cube Schema N/A

Version: @cubejs-client/[email protected]

Additional context Happy to raise a PR to fix - seems like it'd be a matter of changing the index.d.ts file.

I've locally patched it like this:

diff --git a/index.d.ts b/index.d.ts
index 17cabc64b86b4fa9ca5939853d88efc0cf3969f2..1347bc67bff3ab64d22622685a73e6af3dcd6134 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -39,7 +39,8 @@ declare module '@cubejs-client/react' {
   }
   
   type CubeProviderProps = {
-    cubejsApi: CubejsApi | null;
+    cubejsApi?: CubejsApi | null;
+    cubeApi: CubejsApi | null;
     options?: CubeProviderOptions;
     children: React.ReactNode;
   };

Please let me know if there are any issues with this approach.

c-kirkeby avatar Oct 27 '23 00:10 c-kirkeby

Hello @c-kirkeby,

Could you please send a PR? Contributions are welcome!

Thanks

ovr avatar Oct 27 '23 13:10 ovr

If you are interested in working on this issue, please leave a comment below and we will be happy to assign the issue to you. If this is the first time you are contributing a Pull Request to Cube.js, please check our contribution guidelines. You can also post any questions while contributing in the #contributors channel in the Cube.js Slack.

github-actions[bot] avatar Oct 27 '23 13:10 github-actions[bot]

What's the status of this one? I can see the open PR, but nothing has happened in it for a while. Is there anything that can be picked up by someone else?

westn avatar Jan 30 '24 14:01 westn