@cubejs-client/core 0.34.60 → 0.35.23

package/index.d.ts

@@ -66,7 +66,7 @@ declare module '@cubejs-client/core' {
     public request(method: string, params: any): ITransportResponse<ResultSet>;
   }
 
-  export type CubeJSApiOptions = {
+  export type CubeApiOptions = {
     /**
      * URL of your Cube.js Backend. By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`
      */
@@ -80,6 +80,7 @@ declare module '@cubejs-client/core' {
     credentials?: 'omit' | 'same-origin' | 'include';
     parseDateMeasures?: boolean;
     resType?: 'default' | 'compact';
+    castNumerics?: boolean;
   };
 
   export type LoadMethodOptions = {
@@ -98,7 +99,7 @@ declare module '@cubejs-client/core' {
     /**
      * A Cube API instance. If not provided will be taken from `CubeProvider`
      */
-    cubejsApi?: CubejsApi;
+    cubeApi?: CubeApi;
     /**
      * If enabled, all members of the 'number' type will be automatically converted to numerical values on the client side
      */
@@ -324,7 +325,7 @@ declare module '@cubejs-client/core' {
      * ```js
      * import { ResultSet } from '@cubejs-client/core';
      *
-     * const resultSet = await cubejsApi.load(query);
+     * const resultSet = await cubeApi.load(query);
      * // You can store the result somewhere
      * const tmp = resultSet.serialize();
      *
@@ -1072,11 +1073,11 @@ declare module '@cubejs-client/core' {
   }
 
   /**
-   * Main class for accessing Cube.js API
+   * Main class for accessing Cube API
    *
    * @order 2
    */
-  export class CubejsApi {
+  export class CubeApi {
     load<QueryType extends DeeplyReadonly<Query | Query[]>>(
       query: QueryType,
       options?: LoadMethodOptions,
@@ -1085,13 +1086,13 @@ declare module '@cubejs-client/core' {
      * Fetch data for the passed `query`.
      *
      * ```js
-     * import cubejs from '@cubejs-client/core';
+     * import cube from '@cubejs-client/core';
      * import Chart from 'chart.js';
      * import chartjsConfig from './toChartjsData';
      *
-     * const cubejsApi = cubejs('CUBEJS_TOKEN');
+     * const cubeApi = cube('CUBEJS_TOKEN');
      *
-     * const resultSet = await cubejsApi.load({
+     * const resultSet = await cubeApi.load({
      *  measures: ['Stories.count'],
      *  timeDimensions: [{
      *    dimension: 'Stories.time',
@@ -1123,7 +1124,7 @@ declare module '@cubejs-client/core' {
      *
      * ```js
      * // Subscribe to a query's updates
-     * const subscription = await cubejsApi.subscribe(
+     * const subscription = await cubeApi.subscribe(
      *   {
      *     measures: ['Logs.count'],
      *     timeDimensions: [
@@ -1173,12 +1174,12 @@ declare module '@cubejs-client/core' {
   }
 
   /**
-   * Creates an instance of the `CubejsApi`. The API entry point.
+   * Creates an instance of the `CubeApi`. The API entry point.
    *
    * ```js
-   * import cubejs from '@cubejs-client/core';
-   * const cubejsApi = cubejs(
-   *   'CUBEJS-API-TOKEN',
+   * import cube from '@cubejs-client/core';
+   * const cubeApi = cube(
+   *   'CUBE-API-TOKEN',
    *   { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
    * );
    * ```
@@ -1186,8 +1187,8 @@ declare module '@cubejs-client/core' {
    * You can also pass an async function or a promise that will resolve to the API token
    *
    * ```js
-   * import cubejs from '@cubejs-client/core';
-   * const cubejsApi = cubejs(
+   * import cube from '@cubejs-client/core';
+   * const cubeApi = cube(
    *   async () => await Auth.getJwtToken(),
    *   { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
    * );
@@ -1196,8 +1197,8 @@ declare module '@cubejs-client/core' {
    * @param apiToken - [API token](/product/auth) is used to authorize requests and determine SQL database you're accessing. In the development mode, Cube.js Backend will print the API token to the console on startup. In case of async function `authorization` is updated for `options.transport` on each request.
    * @order 1
    */
-  export default function cubejs(apiToken: string | (() => Promise<string>), options: CubeJSApiOptions): CubejsApi;
-  export default function cubejs(options: CubeJSApiOptions): CubejsApi;
+  export default function cube(apiToken: string | (() => Promise<string>), options: CubeApiOptions): CubeApi;
+  export default function cube(options: CubeApiOptions): CubeApi;
 
   /**
    * @hidden

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/core",
-  "version": "0.34.60",
+  "version": "0.35.23",
   "engines": {},
   "repository": {
     "type": "git",
@@ -45,5 +45,5 @@
     "eslint-plugin-node": "^5.2.1",
     "jest": "^27"
   },
-  "gitHead": "7434929be3e99eb1d1fbb8a6b6c7f2427c6fcae6"
+  "gitHead": "50ddcfc277feb55a8781129e7b3a5579e00ea334"
 }

package/src/index.js

@@ -30,7 +30,7 @@ function mutexPromise(promise) {
   });
 }
 
-class CubejsApi {
+class CubeApi {
   constructor(apiToken, options) {
     if (apiToken !== null && !Array.isArray(apiToken) && typeof apiToken === 'object') {
       options = apiToken;
@@ -56,6 +56,7 @@ class CubejsApi {
     });
     this.pollInterval = options.pollInterval || 5;
     this.parseDateMeasures = options.parseDateMeasures;
+    this.castNumerics = typeof options.castNumerics === 'boolean' ? options.castNumerics : false;
 
     this.updateAuthorizationPromise = null;
   }
@@ -308,6 +309,11 @@ class CubejsApi {
   }
 
   load(query, options, callback, responseFormat = ResultType.DEFAULT) {
+    options = {
+      castNumerics: this.castNumerics,
+      ...options
+    };
+
     if (responseFormat === ResultType.COMPACT) {
       if (Array.isArray(query)) {
         query = query.map((q) => this.patchQueryInternal(q, ResultType.COMPACT));
@@ -327,6 +333,11 @@ class CubejsApi {
   }
 
   subscribe(query, options, callback, responseFormat = ResultType.DEFAULT) {
+    options = {
+      castNumerics: this.castNumerics,
+      ...options
+    };
+
     if (responseFormat === ResultType.COMPACT) {
       if (Array.isArray(query)) {
         query = query.map((q) => this.patchQueryInternal(q, ResultType.COMPACT));
@@ -373,7 +384,7 @@ class CubejsApi {
   }
 }
 
-export default (apiToken, options) => new CubejsApi(apiToken, options);
+export default (apiToken, options) => new CubeApi(apiToken, options);
 
-export { CubejsApi, CubejsApi as CubeApi, HttpTransport, ResultSet, RequestError, Meta };
+export { CubeApi, HttpTransport, ResultSet, RequestError, Meta };
 export * from './utils';

package/src/index.test.js

@@ -1,13 +1,13 @@
 /**
  * @license Apache-2.0
  * @copyright Cube Dev, Inc.
- * @fileoverview CubejsApi class unit tests.
+ * @fileoverview CubeApi class unit tests.
  */
 
 /* globals describe,test,expect,beforeEach,jest */
 
 import ResultSet from './ResultSet';
-import { CubejsApi } from './index';
+import { CubeApi } from './index';
 
 jest.mock('./ResultSet');
 beforeEach(() => {
@@ -203,9 +203,9 @@ const mockData = {
   }],
 };
 
-describe('CubejsApi', () => {
-  test('CubejsApi#loadResponseInternal should work with the "default" resType for regular query', () => {
-    const api = new CubejsApi(undefined, {
+describe('CubeApi', () => {
+  test('CubeApi#loadResponseInternal should work with the "default" resType for regular query', () => {
+    const api = new CubeApi(undefined, {
       apiUrl: 'http://localhost:4000/cubejs-api/v1',
     });
     const income = {
@@ -236,8 +236,8 @@ describe('CubejsApi', () => {
     });
   });
 
-  test('CubejsApi#loadResponseInternal should work with the "default" resType for compare date range query', () => {
-    const api = new CubejsApi(undefined, {
+  test('CubeApi#loadResponseInternal should work with the "default" resType for compare date range query', () => {
+    const api = new CubeApi(undefined, {
       apiUrl: 'http://localhost:4000/cubejs-api/v1',
     });
     const income = {
@@ -282,8 +282,8 @@ describe('CubejsApi', () => {
     });
   });
 
-  test('CubejsApi#loadResponseInternal should work with the "default" resType for blending query', () => {
-    const api = new CubejsApi(undefined, {
+  test('CubeApi#loadResponseInternal should work with the "default" resType for blending query', () => {
+    const api = new CubeApi(undefined, {
       apiUrl: 'http://localhost:4000/cubejs-api/v1',
     });
     const income = {
@@ -328,8 +328,8 @@ describe('CubejsApi', () => {
     });
   });
 
-  test('CubejsApi#loadResponseInternal should work with the "compact" resType for regular query', () => {
-    const api = new CubejsApi(undefined, {
+  test('CubeApi#loadResponseInternal should work with the "compact" resType for regular query', () => {
+    const api = new CubeApi(undefined, {
       apiUrl: 'http://localhost:4000/cubejs-api/v1',
     });
     const income = {
@@ -360,8 +360,8 @@ describe('CubejsApi', () => {
     });
   });
 
-  test('CubejsApi#loadResponseInternal should work with the "compact" resType for compare date range query', () => {
-    const api = new CubejsApi(undefined, {
+  test('CubeApi#loadResponseInternal should work with the "compact" resType for compare date range query', () => {
+    const api = new CubeApi(undefined, {
       apiUrl: 'http://localhost:4000/cubejs-api/v1',
     });
     const income = {
@@ -406,8 +406,8 @@ describe('CubejsApi', () => {
     });
   });
 
-  test('CubejsApi#loadResponseInternal should work with the "compact" resType for blending query', () => {
-    const api = new CubejsApi(undefined, {
+  test('CubeApi#loadResponseInternal should work with the "compact" resType for blending query', () => {
+    const api = new CubeApi(undefined, {
       apiUrl: 'http://localhost:4000/cubejs-api/v1',
     });
     const income = {

package/src/index.umd.js

@@ -1,8 +1,8 @@
-import cubejs from './index';
+import cube from './index';
 import * as clientCoreExports from './index';
 
 Object.keys(clientCoreExports).forEach((key) => {
-  cubejs[key] = clientCoreExports[key];
+  cube[key] = clientCoreExports[key];
 });
 
-export default cubejs;
+export default cube;