@cubejs-client/react 0.33.44 → 0.33.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cubejs-client-react.esm.js +8 -5
- package/dist/cubejs-client-react.esm.js.map +1 -1
- package/dist/cubejs-client-react.js +11 -6
- package/dist/cubejs-client-react.js.map +1 -1
- package/dist/cubejs-client-react.umd.js +11 -12
- package/dist/cubejs-client-react.umd.js.map +1 -1
- package/index.d.ts +13 -3
- package/package.json +3 -3
- package/src/CubeProvider.jsx +10 -2
- package/src/hooks/cube-query.js +4 -3
package/index.d.ts
CHANGED
|
@@ -34,8 +34,13 @@ declare module '@cubejs-client/react' {
|
|
|
34
34
|
QueryRecordType,
|
|
35
35
|
} from '@cubejs-client/core';
|
|
36
36
|
|
|
37
|
+
type CubeProviderOptions = {
|
|
38
|
+
castNumerics?: boolean;
|
|
39
|
+
}
|
|
40
|
+
|
|
37
41
|
type CubeProviderProps = {
|
|
38
42
|
cubejsApi: CubejsApi | null;
|
|
43
|
+
options?: CubeProviderOptions;
|
|
39
44
|
children: React.ReactNode;
|
|
40
45
|
};
|
|
41
46
|
|
|
@@ -69,6 +74,7 @@ declare module '@cubejs-client/react' {
|
|
|
69
74
|
|
|
70
75
|
type CubeContextProps = {
|
|
71
76
|
cubejsApi: CubejsApi;
|
|
77
|
+
options?: CubeProviderOptions;
|
|
72
78
|
};
|
|
73
79
|
|
|
74
80
|
/**
|
|
@@ -116,12 +122,12 @@ declare module '@cubejs-client/react' {
|
|
|
116
122
|
|
|
117
123
|
type QueryRendererProps = {
|
|
118
124
|
/**
|
|
119
|
-
* Analytic query. [Learn more about it's format](query-format)
|
|
125
|
+
* Analytic query. [Learn more about it's format](/product/apis-integrations/rest-api/query-format)
|
|
120
126
|
*/
|
|
121
127
|
query: Query | Query[];
|
|
122
128
|
queries?: { [key: string]: Query };
|
|
123
129
|
/**
|
|
124
|
-
* Indicates whether the generated by `Cube.js` SQL Code should be requested. See [rest-api#sql](rest-api#
|
|
130
|
+
* Indicates whether the generated by `Cube.js` SQL Code should be requested. See [rest-api#sql](/reference/rest-api#v1sql). When set to `only` then only the request to [/v1/sql](/reference/rest-api#v1sql) will be performed. When set to `true` the sql request will be performed along with the query request. Will not be performed if set to `false`
|
|
125
131
|
*/
|
|
126
132
|
loadSql?: 'only' | boolean;
|
|
127
133
|
/**
|
|
@@ -459,13 +465,17 @@ declare module '@cubejs-client/react' {
|
|
|
459
465
|
*/
|
|
460
466
|
skip?: boolean;
|
|
461
467
|
/**
|
|
462
|
-
* Use continuous fetch behavior. See [Real-Time Data Fetch](real-time-data-fetch)
|
|
468
|
+
* Use continuous fetch behavior. See [Real-Time Data Fetch](/product/apis-integrations/rest-api/real-time-data-fetch)
|
|
463
469
|
*/
|
|
464
470
|
subscribe?: boolean;
|
|
465
471
|
/**
|
|
466
472
|
* When `true` the resultSet will be reset to `null` first
|
|
467
473
|
*/
|
|
468
474
|
resetResultSetOnChange?: boolean;
|
|
475
|
+
/**
|
|
476
|
+
* If enabled, all members of the 'number' type will be automatically converted to numerical values on the client side
|
|
477
|
+
*/
|
|
478
|
+
castNumerics?: boolean;
|
|
469
479
|
};
|
|
470
480
|
|
|
471
481
|
type UseCubeQueryResult<TData> = {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cubejs-client/react",
|
|
3
|
-
"version": "0.33.
|
|
3
|
+
"version": "0.33.55",
|
|
4
4
|
"author": "Cube Dev, Inc.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"engines": {},
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
],
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@babel/runtime": "^7.1.2",
|
|
27
|
-
"@cubejs-client/core": "^0.33.
|
|
27
|
+
"@cubejs-client/core": "^0.33.55",
|
|
28
28
|
"core-js": "^3.6.5",
|
|
29
29
|
"ramda": "^0.27.2"
|
|
30
30
|
},
|
|
@@ -42,5 +42,5 @@
|
|
|
42
42
|
"peerDependencies": {
|
|
43
43
|
"react": ">=16.10.2"
|
|
44
44
|
},
|
|
45
|
-
"gitHead": "
|
|
45
|
+
"gitHead": "7cb9ace521ab59474e54e4f7cbfb98acb91c9008"
|
|
46
46
|
}
|
package/src/CubeProvider.jsx
CHANGED
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import CubeContext from './CubeContext';
|
|
3
3
|
|
|
4
|
-
export default function CubeProvider({ cubejsApi, children }) {
|
|
5
|
-
return
|
|
4
|
+
export default function CubeProvider({ cubejsApi, children, options = {} }) {
|
|
5
|
+
return (
|
|
6
|
+
<CubeContext.Provider value={{
|
|
7
|
+
cubejsApi,
|
|
8
|
+
options
|
|
9
|
+
}}
|
|
10
|
+
>
|
|
11
|
+
{children}
|
|
12
|
+
</CubeContext.Provider>
|
|
13
|
+
);
|
|
6
14
|
}
|
package/src/hooks/cube-query.js
CHANGED
|
@@ -24,7 +24,7 @@ export function useCubeQuery(query, options = {}) {
|
|
|
24
24
|
const cubejsApi = options.cubejsApi || context?.cubejsApi;
|
|
25
25
|
|
|
26
26
|
if (!cubejsApi) {
|
|
27
|
-
throw new Error('Cube
|
|
27
|
+
throw new Error('Cube API client is not provided');
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
if (resetResultSetOnChange) {
|
|
@@ -33,12 +33,13 @@ export function useCubeQuery(query, options = {}) {
|
|
|
33
33
|
|
|
34
34
|
setError(null);
|
|
35
35
|
setLoading(true);
|
|
36
|
-
|
|
36
|
+
|
|
37
37
|
try {
|
|
38
38
|
const response = await cubejsApi.load(query, {
|
|
39
39
|
mutexObj: mutexRef.current,
|
|
40
40
|
mutexKey: 'query',
|
|
41
41
|
progressCallback,
|
|
42
|
+
castNumerics: Boolean(typeof options.castNumerics === 'boolean' ? options.castNumerics : context?.options?.castNumerics)
|
|
42
43
|
});
|
|
43
44
|
|
|
44
45
|
if (isMounted()) {
|
|
@@ -64,7 +65,7 @@ export function useCubeQuery(query, options = {}) {
|
|
|
64
65
|
const cubejsApi = options.cubejsApi || context?.cubejsApi;
|
|
65
66
|
|
|
66
67
|
if (!cubejsApi) {
|
|
67
|
-
throw new Error('Cube
|
|
68
|
+
throw new Error('Cube API client is not provided');
|
|
68
69
|
}
|
|
69
70
|
|
|
70
71
|
async function loadQuery() {
|