@cubejs-client/core 0.29.23 → 0.29.29

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.29.29](https://github.com/cube-js/cube.js/compare/v0.29.28...v0.29.29) (2022-03-03)
+
+
+### Features
+
+* Compact JSON array based response data format support ([#4046](https://github.com/cube-js/cube.js/issues/4046)) ([e74d73c](https://github.com/cube-js/cube.js/commit/e74d73c140f56e71a24c35a5f03e9af63022bced)), closes [#1](https://github.com/cube-js/cube.js/issues/1)
+
+
+
+
+
 ## [0.29.23](https://github.com/cube-js/cube.js/compare/v0.29.22...v0.29.23) (2022-01-26)
 
 

package/dist/cubejs-client-core.esm.js

@@ -2,8 +2,6 @@ import 'core-js/modules/es.object.keys.js';
 import 'core-js/modules/es.symbol.js';
 import 'core-js/modules/es.array.filter.js';
 import 'core-js/modules/es.object.get-own-property-descriptor.js';
-import 'core-js/modules/es.array.for-each.js';
-import 'core-js/modules/web.dom-collections.for-each.js';
 import 'core-js/modules/es.object.get-own-property-descriptors.js';
 import 'core-js/modules/es.object.define-properties.js';
 import 'core-js/modules/es.object.define-property.js';
@@ -17,6 +15,9 @@ import 'core-js/modules/es.object.to-string.js';
 import 'core-js/modules/es.promise.js';
 import 'core-js/modules/es.array.is-array.js';
 import 'core-js/modules/web.timers.js';
+import 'core-js/modules/es.array.for-each.js';
+import 'core-js/modules/web.dom-collections.for-each.js';
+import 'core-js/modules/es.function.bind.js';
 import 'core-js/modules/es.array.map.js';
 import { v4 } from 'uuid';
 import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
@@ -1622,6 +1623,14 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var mutexCounter = 0;
 var MUTEX_ERROR = 'Mutex has been changed';
+/**
+ * Query result dataset formats enum.
+ */
+
+var ResultType = {
+  DEFAULT: 'default',
+  COMPACT: 'compact'
+};
 
 function mutexPromise(promise) {
   return new Promise( /*#__PURE__*/function () {
@@ -2144,29 +2153,128 @@ var CubejsApi = /*#__PURE__*/function () {
 
       return updateTransportAuthorization;
     }()
+    /**
+     * Add system properties to a query object.
+     * @param {Query} query
+     * @param {string} responseFormat
+     * @returns {void}
+     * @private
+     */
+
+  }, {
+    key: "patchQueryInternal",
+    value: function 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
+     */
+
+  }, {
+    key: "loadResponseInternal",
+    value: function loadResponseInternal(response) {
+      if (response.results.length && response.results[0].query.responseFormat && response.results[0].query.responseFormat === ResultType.COMPACT) {
+        response.results.forEach(function (result, j) {
+          var data = [];
+          result.data.dataset.forEach(function (r) {
+            var row = {};
+            result.data.members.forEach(function (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>}
+     */
+
   }, {
     key: "load",
     value: function load(query, options, callback) {
       var _this3 = this;
 
+      var responseFormat = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : ResultType.DEFAULT;
+
+      if (responseFormat === ResultType.COMPACT) {
+        if (Array.isArray(query)) {
+          query.forEach(function (q) {
+            _this3.patchQueryInternal(q, ResultType.COMPACT);
+          });
+        } else {
+          this.patchQueryInternal(query, ResultType.COMPACT);
+        }
+      }
+
       return this.loadMethod(function () {
         return _this3.request('load', {
           query: query,
           queryType: 'multi'
         });
-      }, function (response) {
-        return new ResultSet(response, {
-          parseDateMeasures: _this3.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}
+     */
+
+  }, {
+    key: "subscribe",
+    value: function subscribe(query, options, callback) {
+      var _this4 = this;
+
+      var responseFormat = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : ResultType.DEFAULT;
+
+      if (responseFormat === ResultType.COMPACT) {
+        if (Array.isArray(query)) {
+          query.forEach(function (q) {
+            _this4.patchQueryInternal(q, ResultType.COMPACT);
+          });
+        } else {
+          this.patchQueryInternal(query, ResultType.COMPACT);
+        }
+      }
+
+      return this.loadMethod(function () {
+        return _this4.request('subscribe', {
+          query: query,
+          queryType: 'multi'
         });
-      }, options, callback);
+      }, this.loadResponseInternal.bind(this), _objectSpread(_objectSpread({}, options), {}, {
+        subscribe: true
+      }), callback);
     }
   }, {
     key: "sql",
     value: function sql(query, options, callback) {
-      var _this4 = this;
+      var _this5 = this;
 
       return this.loadMethod(function () {
-        return _this4.request('sql', {
+        return _this5.request('sql', {
           query: query
         });
       }, function (response) {
@@ -2178,10 +2286,10 @@ var CubejsApi = /*#__PURE__*/function () {
   }, {
     key: "meta",
     value: function meta(options, callback) {
-      var _this5 = this;
+      var _this6 = this;
 
       return this.loadMethod(function () {
-        return _this5.request('meta');
+        return _this6.request('meta');
       }, function (body) {
         return new Meta(body);
       }, options, callback);
@@ -2189,34 +2297,16 @@ var CubejsApi = /*#__PURE__*/function () {
   }, {
     key: "dryRun",
     value: function dryRun(query, options, callback) {
-      var _this6 = this;
+      var _this7 = this;
 
       return this.loadMethod(function () {
-        return _this6.request('dry-run', {
+        return _this7.request('dry-run', {
           query: query
         });
       }, function (response) {
         return response;
       }, options, callback);
     }
-  }, {
-    key: "subscribe",
-    value: function subscribe(query, options, callback) {
-      var _this7 = this;
-
-      return this.loadMethod(function () {
-        return _this7.request('subscribe', {
-          query: query,
-          queryType: 'multi'
-        });
-      }, function (body) {
-        return new ResultSet(body, {
-          parseDateMeasures: _this7.parseDateMeasures
-        });
-      }, _objectSpread(_objectSpread({}, options), {}, {
-        subscribe: true
-      }), callback);
-    }
   }]);
 
   return CubejsApi;