@cubejs-client/react 0.34.0 → 0.34.9

package/index.d.ts

@@ -457,9 +457,15 @@ declare module '@cubejs-client/react' {
 
   type UseCubeQueryOptions = {
     /**
+     * @deprecated Use the `cubeApi` option
      * A `CubejsApi` instance to use. Taken from the context if the param is not passed
      */
     cubejsApi?: CubejsApi;
+    
+    /**
+     * A `CubejsApi` instance to use. Taken from the context if the param is not passed
+     */
+    cubeApi?: CubejsApi;
     /**
      * Query execution will be skipped when `skip` is set to `true`. You can use this flag to avoid sending incomplete queries.
      */
@@ -491,6 +497,7 @@ declare module '@cubejs-client/react' {
    */
   type CubeFetchOptions = {
     skip?: boolean;
+    cubeApi?: CubejsApi;
     cubejsApi?: CubejsApi;
     query?: Query;
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/react",
-  "version": "0.34.0",
+  "version": "0.34.9",
   "author": "Cube Dev, Inc.",
   "license": "MIT",
   "engines": {},
@@ -24,7 +24,7 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.1.2",
-    "@cubejs-client/core": "^0.34.0",
+    "@cubejs-client/core": "^0.34.9",
     "core-js": "^3.6.5",
     "ramda": "^0.27.2"
   },
@@ -42,5 +42,5 @@
   "peerDependencies": {
     "react": ">=16.10.2"
   },
-  "gitHead": "55e796e52bd276f839c5fa842b9eb821d363e77e"
+  "gitHead": "9c2ceb36b8663483a7c97c195f55c42fc1701dc9"
 }

package/src/CubeProvider.jsx

@@ -1,10 +1,17 @@
-import React from 'react';
+import React, { useEffect } from 'react';
 import CubeContext from './CubeContext';
 
-export default function CubeProvider({ cubejsApi, children, options = {} }) {
+export default function CubeProvider({ cubeApi, cubejsApi, children, options = {} }) {
+  useEffect(() => {
+    if (cubejsApi && !cubeApi) {
+      console.warn('"cubejsApi" is deprecated and will be removed in the following version. Use "cubeApi" instead.');
+    }
+  }, [cubeApi, cubejsApi]);
+  
   return (
     <CubeContext.Provider value={{
       cubejsApi,
+      cubeApi,
       options
     }}
     >

package/src/hooks/cube-fetch.js

@@ -19,12 +19,12 @@ export function useCubeFetch(method, options = {}) {
   const { skip = false } = options;
 
   async function load(loadOptions = {}, ignoreSkip = false) {
-    const cubejsApi = options.cubejsApi || context?.cubejsApi;
+    const cubeApi = options.cubeApi || options.cubejsApi || context?.cubeApi || context?.cubejsApi;
     const query = loadOptions.query || options.query;
 
     const queryCondition = method === 'meta' ? true : query && isQueryPresent(query);
 
-    if (cubejsApi && (ignoreSkip || !skip) && queryCondition) {
+    if (cubeApi && (ignoreSkip || !skip) && queryCondition) {
       setError(null);
       setResponse({
         isLoading: true,
@@ -38,7 +38,7 @@ export function useCubeFetch(method, options = {}) {
       const args = method === 'meta' ? [coreOptions] : [query, coreOptions];
 
       try {
-        const response = await cubejsApi[method](...args);
+        const response = await cubeApi[method](...args);
 
         if (isMounted()) {
           setResponse({

package/src/hooks/cube-query.js

@@ -18,12 +18,18 @@ export function useCubeQuery(query, options = {}) {
   let subscribeRequest = null;
 
   const progressCallback = ({ progressResponse }) => setProgress(progressResponse);
+  
+  useEffect(() => {
+    if (options.cubejsApi && !options.cubeApi) {
+      console.warn('"cubejsApi" is deprecated and will be removed in the following version. Use "cubeApi" instead.');
+    }
+  }, [options.cubeApi, options.cubejsApi]);
 
   async function fetch() {
     const { resetResultSetOnChange } = options;
-    const cubejsApi = options.cubejsApi || context?.cubejsApi;
+    const cubeApi = options.cubeApi || options.cubejsApi || context?.cubeApi || context?.cubejsApi;
 
-    if (!cubejsApi) {
+    if (!cubeApi) {
       throw new Error('Cube API client is not provided');
     }
 
@@ -35,7 +41,7 @@ export function useCubeQuery(query, options = {}) {
     setLoading(true);
     
     try {
-      const response = await cubejsApi.load(query, {
+      const response = await cubeApi.load(query, {
         mutexObj: mutexRef.current,
         mutexKey: 'query',
         progressCallback,
@@ -62,9 +68,9 @@ export function useCubeQuery(query, options = {}) {
   useEffect(() => {
     const { skip = false, resetResultSetOnChange } = options;
 
-    const cubejsApi = options.cubejsApi || context?.cubejsApi;
+    const cubeApi = options.cubeApi || options.cubejsApi || context?.cubeApi || context?.cubejsApi;
 
-    if (!cubejsApi) {
+    if (!cubeApi) {
       throw new Error('Cube API client is not provided');
     }
 
@@ -87,7 +93,7 @@ export function useCubeQuery(query, options = {}) {
           }
 
           if (options.subscribe) {
-            subscribeRequest = cubejsApi.subscribe(
+            subscribeRequest = cubeApi.subscribe(
               query,
               {
                 mutexObj: mutexRef.current,