@cubejs-client/core 0.29.5 → 0.29.29

package/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * @title @cubejs-client/core
  * @permalink /@cubejs-client-core
- * @menuCategory Cube.js Frontend
+ * @menuCategory Frontend Integrations
  * @subcategory Reference
  * @menuOrder 2
  * @description Vanilla JavaScript Cube.js client.
@@ -27,13 +27,21 @@ declare module '@cubejs-client/core' {
   };
 
   export interface ITransportResponse<R> {
-    subscribe: <CBResult>(cb: (result: R, resubscribe: () => Promise<CBResult>) => CBResult) => Promise<CBResult>;
+    subscribe: <CBResult>(
+      cb: (
+        result: R,
+        resubscribe: () => Promise<CBResult>
+      ) => CBResult
+    ) => Promise<CBResult>;
     // Optional, supported in WebSocketTransport
     unsubscribe?: () => Promise<void>;
   }
 
   export interface ITransport<R> {
-    request(method: string, params: Record<string, unknown>): ITransportResponse<R>;
+    request(
+      method: string,
+      params: Record<string, unknown>
+    ): ITransportResponse<R>;
   }
 
   /**
@@ -80,6 +88,7 @@ declare module '@cubejs-client/core' {
     pollInterval?: number;
     credentials?: 'omit' | 'same-origin' | 'include';
     parseDateMeasures?: boolean;
+    resType?: 'default' | 'compact';
   };
 
   export type LoadMethodOptions = {
@@ -790,6 +799,7 @@ declare module '@cubejs-client/core' {
     timezone?: string;
     renewQuery?: boolean;
     ungrouped?: boolean;
+    responseFormat?: 'compact' | 'default'
   }
 
   export class ProgressResult {
@@ -825,13 +835,14 @@ declare module '@cubejs-client/core' {
   type TCubeMemberType = 'time' | 'number' | 'string' | 'boolean';
 
   // @see BaseCubeMember
-  // @depreacated
+  // @deprecated
   export type TCubeMember = {
     type: TCubeMemberType;
     name: string;
     title: string;
     shortTitle: string;
     isVisible?: boolean;
+    meta?: any;
   };
 
   export type BaseCubeMember = {
@@ -840,6 +851,7 @@ declare module '@cubejs-client/core' {
     title: string;
     shortTitle: string;
     isVisible?: boolean;
+    meta?: any;
   };
 
   export type TCubeMeasure = BaseCubeMember & {
@@ -991,6 +1003,7 @@ declare module '@cubejs-client/core' {
      * @param query - [Query object](query-format)
      */
     load(query: Query | Query[], options?: LoadMethodOptions, callback?: LoadMethodCallback<ResultSet>): void;
+    load(query: Query | Query[], options?: LoadMethodOptions, callback?: LoadMethodCallback<ResultSet>, responseFormat?: string):  Promise<ResultSet>;
 
     /**
      * Allows you to fetch data and receive updates over time. See [Real-Time Data Fetch](real-time-data-fetch)
@@ -1059,7 +1072,7 @@ declare module '@cubejs-client/core' {
    * );
    * ```
    *
-   * @param apiToken - [API token](security) 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 on startup. In case of async function `authorization` is updated for `options.transport` on each request.
+   * @param apiToken - [API token](security) 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;
@@ -1153,5 +1166,3 @@ declare module '@cubejs-client/core' {
     timeElapsed: number;
   };
 }
-
-import '@cubejs-client/dx';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/core",
-  "version": "0.29.5",
+  "version": "0.29.29",
   "engines": {},
   "repository": {
     "type": "git",
@@ -13,8 +13,8 @@
   "types": "index.d.ts",
   "author": "Cube Dev, Inc.",
   "dependencies": {
+    "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/runtime": "^7.1.2",
-    "@cubejs-client/dx": "^0.29.5",
     "core-js": "^3.6.5",
     "cross-fetch": "^3.0.2",
     "dayjs": "^1.10.4",
@@ -46,5 +46,5 @@
     "eslint-plugin-node": "^5.2.1",
     "jest": "^26.0.1"
   },
-  "gitHead": "518281dea6e0c511813df4502f3aa97038f9be23"
+  "gitHead": "23638ee42cceb8fc80e821486ab30825e2b9a483"
 }

package/src/index.js

@@ -10,6 +10,14 @@ let mutexCounter = 0;
 
 const MUTEX_ERROR = 'Mutex has been changed';
 
+/**
+ * Query result dataset formats enum.
+ */
+const ResultType = {
+  DEFAULT: 'default',
+  COMPACT: 'compact'
+};
+
 function mutexPromise(promise) {
   return new Promise(async (resolve, reject) => {
     try {
@@ -24,7 +32,7 @@ function mutexPromise(promise) {
 
 class CubejsApi {
   constructor(apiToken, options) {
-    if (typeof apiToken === 'object') {
+    if (apiToken !== null && !Array.isArray(apiToken) && typeof apiToken === 'object') {
       options = apiToken;
       apiToken = undefined;
     }
@@ -53,7 +61,10 @@ class CubejsApi {
   }
 
   request(method, params) {
-    return this.transport.request(method, { baseRequestId: uuidv4(), ...params });
+    return this.transport.request(method, {
+      baseRequestId: uuidv4(),
+      ...params
+    });
   }
 
   loadMethod(request, toResult, options, callback) {
@@ -70,7 +81,9 @@ class CubejsApi {
       options.mutexObj[mutexKey] = mutexValue;
     }
 
-    const requestPromise = this.updateTransportAuthorization().then(() => request());
+    const requestPromise = this
+      .updateTransportAuthorization()
+      .then(() => request());
 
     let skipAuthorizationUpdate = true;
     let unsubscribed = false;
@@ -78,7 +91,10 @@ class CubejsApi {
     const checkMutex = async () => {
       const requestInstance = await requestPromise;
 
-      if (options.mutexObj && options.mutexObj[mutexKey] !== mutexValue) {
+      if (
+        options.mutexObj &&
+        options.mutexObj[mutexKey] !== mutexValue
+      ) {
         unsubscribed = true;
         if (requestInstance.unsubscribe) {
           await requestInstance.unsubscribe();
@@ -213,18 +229,113 @@ class CubejsApi {
     }
   }
 
-  load(query, options, callback) {
+  /**
+   * Add system properties to a query object.
+   * @param {Query} query
+   * @param {string} responseFormat
+   * @returns {void}
+   * @private
+   */
+  patchQueryInternal(query, responseFormat) {
+    if (
+      responseFormat === ResultType.COMPACT &&
+      query.responseFormat !== ResultType.COMPACT
+    ) {
+      query.responseFormat = ResultType.COMPACT;
+    }
+  }
+
+  /**
+   * Process result fetched from the gateway#load method according
+   * to the network protocol.
+   * @param {*} response
+   * @returns ResultSet
+   * @private
+   */
+  loadResponseInternal(response) {
+    if (
+      response.results.length &&
+      response.results[0].query.responseFormat &&
+      response.results[0].query.responseFormat === ResultType.COMPACT
+    ) {
+      response.results.forEach((result, j) => {
+        const data = [];
+        result.data.dataset.forEach((r) => {
+          const row = {};
+          result.data.members.forEach((m, i) => {
+            row[m] = r[i];
+          });
+          data.push(row);
+        });
+        response.results[j].data = data;
+      });
+    }
+    return new ResultSet(response, {
+      parseDateMeasures: this.parseDateMeasures
+    });
+  }
+
+  /**
+   * Fetch data for the passed `query`. Operates with the
+   * `ApiGateway#load` method to fetch the data.
+   * @param {Query | Query[]} query
+   * @param {LoadMethodOptions | undefined} options
+   * @param {LoadMethodCallback<ResultSet> | undefined} callback
+   * @param {string} responseFormat
+   * @returns {undefined | Promise<ResultSet>}
+   */
+  load(query, options, callback, responseFormat = ResultType.DEFAULT) {
+    if (responseFormat === ResultType.COMPACT) {
+      if (Array.isArray(query)) {
+        query.forEach((q) => {
+          this.patchQueryInternal(q, ResultType.COMPACT);
+        });
+      } else {
+        this.patchQueryInternal(query, ResultType.COMPACT);
+      }
+    }
     return this.loadMethod(
       () => this.request('load', {
         query,
-        queryType: 'multi'
+        queryType: 'multi',
       }),
-      (response) => new ResultSet(response, { parseDateMeasures: this.parseDateMeasures }),
+      this.loadResponseInternal.bind(this),
       options,
       callback
     );
   }
 
+  /**
+   * Allows you to fetch data and receive updates over time. Operates
+   * with the `ApiGateway#load` method to fetch the data.
+   * @link real-time-data-fetch
+   * @param {Query | Query[]} query
+   * @param {LoadMethodOptions | null} options
+   * @param {LoadMethodCallback<ResultSet> | undefined} callback
+   * @param {string} responseFormat
+   * @returns {void}
+   */
+  subscribe(query, options, callback, responseFormat = ResultType.DEFAULT) {
+    if (responseFormat === ResultType.COMPACT) {
+      if (Array.isArray(query)) {
+        query.forEach((q) => {
+          this.patchQueryInternal(q, ResultType.COMPACT);
+        });
+      } else {
+        this.patchQueryInternal(query, ResultType.COMPACT);
+      }
+    }
+    return this.loadMethod(
+      () => this.request('subscribe', {
+        query,
+        queryType: 'multi',
+      }),
+      this.loadResponseInternal.bind(this),
+      { ...options, subscribe: true },
+      callback
+    );
+  }
+
   sql(query, options, callback) {
     return this.loadMethod(
       () => this.request('sql', { query }),
@@ -251,18 +362,6 @@ class CubejsApi {
       callback
     );
   }
-
-  subscribe(query, options, callback) {
-    return this.loadMethod(
-      () => this.request('subscribe', {
-        query,
-        queryType: 'multi'
-      }),
-      (body) => new ResultSet(body, { parseDateMeasures: this.parseDateMeasures }),
-      { ...options, subscribe: true },
-      callback
-    );
-  }
 }
 
 export default (apiToken, options) => new CubejsApi(apiToken, options);