@cubejs-client/core 0.10.16 → 0.10.61

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.10.61](https://github.com/statsbotco/cubejs-client/compare/v0.10.60...v0.10.61) (2019-10-10)
+
+**Note:** Version bump only for package @cubejs-client/core
+
+
+
+
+
+## [0.10.59](https://github.com/statsbotco/cubejs-client/compare/v0.10.58...v0.10.59) (2019-10-08)
+
+**Note:** Version bump only for package @cubejs-client/core
+
+
+
+
+
+## [0.10.56](https://github.com/statsbotco/cubejs-client/compare/v0.10.55...v0.10.56) (2019-10-04)
+
+**Note:** Version bump only for package @cubejs-client/core
+
+
+
+
+
+## [0.10.55](https://github.com/statsbotco/cubejs-client/compare/v0.10.54...v0.10.55) (2019-10-03)
+
+
+### Bug Fixes
+
+* **client-core:** can't read property 'title' of undefined ([4b48c7f](https://github.com/statsbotco/cubejs-client/commit/4b48c7f))
+
+
+
+
+
 ## [0.10.16](https://github.com/statsbotco/cubejs-client/compare/v0.10.15...v0.10.16) (2019-07-20)
 
 **Note:** Version bump only for package @cubejs-client/core

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

@@ -57,6 +57,9 @@ var TIME_SERIES = {
     });
   }
 };
+/**
+ * Provides a convenient interface for data manipulation.
+ */
 
 var ResultSet =
 /*#__PURE__*/
@@ -160,6 +163,15 @@ function () {
         pivotConfig.y = pivotConfig.y.concat(['measures']);
       }
 
+      if (!(query.measures || []).length) {
+        pivotConfig.x = pivotConfig.x.filter(function (d) {
+          return d !== 'measures';
+        });
+        pivotConfig.y = pivotConfig.y.filter(function (d) {
+          return d !== 'measures';
+        });
+      }
+
       if (pivotConfig.fillMissingDates == null) {
         pivotConfig.fillMissingDates = true;
       }
@@ -311,6 +323,31 @@ function () {
       // TODO
       return this.chartPivot(pivotConfig);
     }
+    /**
+     * Returns normalized query result data in the following format.
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.chartPivot() will return
+     * [
+     *   { "x":"2015-01-01T00:00:00", "Stories.count": 27120 },
+     *   { "x":"2015-02-01T00:00:00", "Stories.count": 25861 },
+     *   { "x": "2015-03-01T00:00:00", "Stories.count": 29661 },
+     *   //...
+     * ]
+     * ```
+     * @param pivotConfig
+     */
+
   }, {
     key: "chartPivot",
     value: function chartPivot(pivotConfig) {
@@ -334,6 +371,34 @@ function () {
         }, {}));
       });
     }
+    /**
+     * Returns normalized query result data prepared for visualization in the table format.
+     *
+     * For example
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.tablePivot() will return
+     * [
+     *   { "Stories.time": "2015-01-01T00:00:00", "Stories.count": 27120 },
+     *   { "Stories.time": "2015-02-01T00:00:00", "Stories.count": 25861 },
+     *   { "Stories.time": "2015-03-01T00:00:00", "Stories.count": 29661 },
+     *   //...
+     * ]
+     * ```
+     * @param pivotConfig
+     * @returns {Array} of pivoted rows
+     */
+
   }, {
     key: "tablePivot",
     value: function tablePivot(pivotConfig) {
@@ -361,6 +426,33 @@ function () {
         }, {});
       });
     }
+    /**
+     * Returns array of column definitions for `tablePivot`.
+     *
+     * For example
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.tableColumns() will return
+     * [
+     *   { key: "Stories.time", title: "Stories Time" },
+     *   { key: "Stories.count", title: "Stories Count" },
+     *   //...
+     * ]
+     * ```
+     * @param pivotConfig
+     * @returns {Array} of columns
+     */
+
   }, {
     key: "tableColumns",
     value: function tableColumns(pivotConfig) {
@@ -395,6 +487,29 @@ function () {
       // TODO
       return this.chartPivot(pivotConfig);
     }
+    /**
+     * Returns the array of series objects, containing `key` and `title` parameters.
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.seriesNames() will return
+     * [
+     * { "key":"Stories.count", "title": "Stories Count" }
+     * ]
+     * ```
+     * @param pivotConfig
+     * @returns {Array} of series names
+     */
+
   }, {
     key: "seriesNames",
     value: function seriesNames(pivotConfig) {
@@ -629,6 +744,11 @@ var mutexPromise = function mutexPromise(promise) {
     });
   });
 };
+/**
+ * Main class for accessing Cube.js API
+ * @order -5
+ */
+
 
 var CubejsApi =
 /*#__PURE__*/
@@ -755,6 +875,34 @@ function () {
         return mutexPromise(loadImpl());
       }
     }
+    /**
+     * Fetch data for passed `query`.
+     *
+     * ```js
+     * import cubejs from '@cubejs-client/core';
+     * import Chart from 'chart.js';
+     * import chartjsConfig from './toChartjsData';
+     *
+     * const cubejsApi = cubejs('CUBEJS_TOKEN');
+     *
+     * const resultSet = await cubejsApi.load({
+     *  measures: ['Stories.count'],
+     *  timeDimensions: [{
+     *    dimension: 'Stories.time',
+     *    dateRange: ['2015-01-01', '2015-12-31'],
+     *    granularity: 'month'
+     *   }]
+     * });
+     *
+     * const context = document.getElementById('myChart');
+     * new Chart(context, chartjsConfig(resultSet));
+     * ```
+     * @param query - [Query object](query-format)
+     * @param options
+     * @param callback
+     * @returns {Promise} for {@link ResultSet} if `callback` isn't passed
+     */
+
   }, {
     key: "load",
     value: function load(query, options, callback) {
@@ -766,6 +914,14 @@ function () {
         return new ResultSet(body);
       }, options, callback);
     }
+    /**
+     * Get generated SQL string for given `query`.
+     * @param query - [Query object](query-format)
+     * @param options
+     * @param callback
+     * @return {Promise} for {@link SqlQuery} if `callback` isn't passed
+     */
+
   }, {
     key: "sql",
     value: function sql(query, options, callback) {
@@ -777,6 +933,13 @@ function () {
         return new SqlQuery(body);
       }, options, callback);
     }
+    /**
+     * Get meta description of cubes available for querying.
+     * @param options
+     * @param callback
+     * @return {Promise} for {@link Meta} if `callback` isn't passed
+     */
+
   }, {
     key: "meta",
     value: function meta(options, callback) {
@@ -792,6 +955,28 @@ function () {
 
   return CubejsApi;
 }();
+/**
+ * Create instance of `CubejsApi`.
+ * API entry point.
+ *
+ * ```javascript
+ import cubejs from '@cubejs-client/core';
+
+ const cubejsApi = cubejs(
+ 'CUBEJS-API-TOKEN',
+ { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
+ );
+ ```
+ * @name cubejs
+ * @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.
+ * @param options - options object.
+ * @param options.apiUrl - URL of your Cube.js Backend.
+ * By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`.
+ * @returns {CubejsApi}
+ * @order -10
+ */
+
 
 var index = (function (apiToken, options) {
   return new CubejsApi(apiToken, options);

package/dist/cubejs-client-core.js

@@ -61,6 +61,9 @@ var TIME_SERIES = {
     });
   }
 };
+/**
+ * Provides a convenient interface for data manipulation.
+ */
 
 var ResultSet =
 /*#__PURE__*/
@@ -164,6 +167,15 @@ function () {
         pivotConfig.y = pivotConfig.y.concat(['measures']);
       }
 
+      if (!(query.measures || []).length) {
+        pivotConfig.x = pivotConfig.x.filter(function (d) {
+          return d !== 'measures';
+        });
+        pivotConfig.y = pivotConfig.y.filter(function (d) {
+          return d !== 'measures';
+        });
+      }
+
       if (pivotConfig.fillMissingDates == null) {
         pivotConfig.fillMissingDates = true;
       }
@@ -315,6 +327,31 @@ function () {
       // TODO
       return this.chartPivot(pivotConfig);
     }
+    /**
+     * Returns normalized query result data in the following format.
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.chartPivot() will return
+     * [
+     *   { "x":"2015-01-01T00:00:00", "Stories.count": 27120 },
+     *   { "x":"2015-02-01T00:00:00", "Stories.count": 25861 },
+     *   { "x": "2015-03-01T00:00:00", "Stories.count": 29661 },
+     *   //...
+     * ]
+     * ```
+     * @param pivotConfig
+     */
+
   }, {
     key: "chartPivot",
     value: function chartPivot(pivotConfig) {
@@ -338,6 +375,34 @@ function () {
         }, {}));
       });
     }
+    /**
+     * Returns normalized query result data prepared for visualization in the table format.
+     *
+     * For example
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.tablePivot() will return
+     * [
+     *   { "Stories.time": "2015-01-01T00:00:00", "Stories.count": 27120 },
+     *   { "Stories.time": "2015-02-01T00:00:00", "Stories.count": 25861 },
+     *   { "Stories.time": "2015-03-01T00:00:00", "Stories.count": 29661 },
+     *   //...
+     * ]
+     * ```
+     * @param pivotConfig
+     * @returns {Array} of pivoted rows
+     */
+
   }, {
     key: "tablePivot",
     value: function tablePivot(pivotConfig) {
@@ -365,6 +430,33 @@ function () {
         }, {});
       });
     }
+    /**
+     * Returns array of column definitions for `tablePivot`.
+     *
+     * For example
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.tableColumns() will return
+     * [
+     *   { key: "Stories.time", title: "Stories Time" },
+     *   { key: "Stories.count", title: "Stories Count" },
+     *   //...
+     * ]
+     * ```
+     * @param pivotConfig
+     * @returns {Array} of columns
+     */
+
   }, {
     key: "tableColumns",
     value: function tableColumns(pivotConfig) {
@@ -399,6 +491,29 @@ function () {
       // TODO
       return this.chartPivot(pivotConfig);
     }
+    /**
+     * Returns the array of series objects, containing `key` and `title` parameters.
+     *
+     * ```js
+     * // For query
+     * {
+     *   measures: ['Stories.count'],
+     *   timeDimensions: [{
+     *     dimension: 'Stories.time',
+     *     dateRange: ['2015-01-01', '2015-12-31'],
+     *     granularity: 'month'
+     *   }]
+     * }
+     *
+     * // ResultSet.seriesNames() will return
+     * [
+     * { "key":"Stories.count", "title": "Stories Count" }
+     * ]
+     * ```
+     * @param pivotConfig
+     * @returns {Array} of series names
+     */
+
   }, {
     key: "seriesNames",
     value: function seriesNames(pivotConfig) {
@@ -633,6 +748,11 @@ var mutexPromise = function mutexPromise(promise) {
     });
   });
 };
+/**
+ * Main class for accessing Cube.js API
+ * @order -5
+ */
+
 
 var CubejsApi =
 /*#__PURE__*/
@@ -759,6 +879,34 @@ function () {
         return mutexPromise(loadImpl());
       }
     }
+    /**
+     * Fetch data for passed `query`.
+     *
+     * ```js
+     * import cubejs from '@cubejs-client/core';
+     * import Chart from 'chart.js';
+     * import chartjsConfig from './toChartjsData';
+     *
+     * const cubejsApi = cubejs('CUBEJS_TOKEN');
+     *
+     * const resultSet = await cubejsApi.load({
+     *  measures: ['Stories.count'],
+     *  timeDimensions: [{
+     *    dimension: 'Stories.time',
+     *    dateRange: ['2015-01-01', '2015-12-31'],
+     *    granularity: 'month'
+     *   }]
+     * });
+     *
+     * const context = document.getElementById('myChart');
+     * new Chart(context, chartjsConfig(resultSet));
+     * ```
+     * @param query - [Query object](query-format)
+     * @param options
+     * @param callback
+     * @returns {Promise} for {@link ResultSet} if `callback` isn't passed
+     */
+
   }, {
     key: "load",
     value: function load(query, options, callback) {
@@ -770,6 +918,14 @@ function () {
         return new ResultSet(body);
       }, options, callback);
     }
+    /**
+     * Get generated SQL string for given `query`.
+     * @param query - [Query object](query-format)
+     * @param options
+     * @param callback
+     * @return {Promise} for {@link SqlQuery} if `callback` isn't passed
+     */
+
   }, {
     key: "sql",
     value: function sql(query, options, callback) {
@@ -781,6 +937,13 @@ function () {
         return new SqlQuery(body);
       }, options, callback);
     }
+    /**
+     * Get meta description of cubes available for querying.
+     * @param options
+     * @param callback
+     * @return {Promise} for {@link Meta} if `callback` isn't passed
+     */
+
   }, {
     key: "meta",
     value: function meta(options, callback) {
@@ -796,6 +959,28 @@ function () {
 
   return CubejsApi;
 }();
+/**
+ * Create instance of `CubejsApi`.
+ * API entry point.
+ *
+ * ```javascript
+ import cubejs from '@cubejs-client/core';
+
+ const cubejsApi = cubejs(
+ 'CUBEJS-API-TOKEN',
+ { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
+ );
+ ```
+ * @name cubejs
+ * @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.
+ * @param options - options object.
+ * @param options.apiUrl - URL of your Cube.js Backend.
+ * By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`.
+ * @returns {CubejsApi}
+ * @order -10
+ */
+
 
 var index = (function (apiToken, options) {
   return new CubejsApi(apiToken, options);

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

@@ -14387,6 +14387,9 @@
 	    });
 	  }
 	};
+	/**
+	 * Provides a convenient interface for data manipulation.
+	 */
 
 	var ResultSet =
 	/*#__PURE__*/
@@ -14490,6 +14493,15 @@
 	        pivotConfig.y = pivotConfig.y.concat(['measures']);
 	      }
 
+	      if (!(query.measures || []).length) {
+	        pivotConfig.x = pivotConfig.x.filter(function (d) {
+	          return d !== 'measures';
+	        });
+	        pivotConfig.y = pivotConfig.y.filter(function (d) {
+	          return d !== 'measures';
+	        });
+	      }
+
 	      if (pivotConfig.fillMissingDates == null) {
 	        pivotConfig.fillMissingDates = true;
 	      }
@@ -14641,6 +14653,31 @@
 	      // TODO
 	      return this.chartPivot(pivotConfig);
 	    }
+	    /**
+	     * Returns normalized query result data in the following format.
+	     *
+	     * ```js
+	     * // For query
+	     * {
+	     *   measures: ['Stories.count'],
+	     *   timeDimensions: [{
+	     *     dimension: 'Stories.time',
+	     *     dateRange: ['2015-01-01', '2015-12-31'],
+	     *     granularity: 'month'
+	     *   }]
+	     * }
+	     *
+	     * // ResultSet.chartPivot() will return
+	     * [
+	     *   { "x":"2015-01-01T00:00:00", "Stories.count": 27120 },
+	     *   { "x":"2015-02-01T00:00:00", "Stories.count": 25861 },
+	     *   { "x": "2015-03-01T00:00:00", "Stories.count": 29661 },
+	     *   //...
+	     * ]
+	     * ```
+	     * @param pivotConfig
+	     */
+
 	  }, {
 	    key: "chartPivot",
 	    value: function chartPivot(pivotConfig) {
@@ -14664,6 +14701,34 @@
 	        }, {}));
 	      });
 	    }
+	    /**
+	     * Returns normalized query result data prepared for visualization in the table format.
+	     *
+	     * For example
+	     *
+	     * ```js
+	     * // For query
+	     * {
+	     *   measures: ['Stories.count'],
+	     *   timeDimensions: [{
+	     *     dimension: 'Stories.time',
+	     *     dateRange: ['2015-01-01', '2015-12-31'],
+	     *     granularity: 'month'
+	     *   }]
+	     * }
+	     *
+	     * // ResultSet.tablePivot() will return
+	     * [
+	     *   { "Stories.time": "2015-01-01T00:00:00", "Stories.count": 27120 },
+	     *   { "Stories.time": "2015-02-01T00:00:00", "Stories.count": 25861 },
+	     *   { "Stories.time": "2015-03-01T00:00:00", "Stories.count": 29661 },
+	     *   //...
+	     * ]
+	     * ```
+	     * @param pivotConfig
+	     * @returns {Array} of pivoted rows
+	     */
+
 	  }, {
 	    key: "tablePivot",
 	    value: function tablePivot(pivotConfig) {
@@ -14691,6 +14756,33 @@
 	        }, {});
 	      });
 	    }
+	    /**
+	     * Returns array of column definitions for `tablePivot`.
+	     *
+	     * For example
+	     *
+	     * ```js
+	     * // For query
+	     * {
+	     *   measures: ['Stories.count'],
+	     *   timeDimensions: [{
+	     *     dimension: 'Stories.time',
+	     *     dateRange: ['2015-01-01', '2015-12-31'],
+	     *     granularity: 'month'
+	     *   }]
+	     * }
+	     *
+	     * // ResultSet.tableColumns() will return
+	     * [
+	     *   { key: "Stories.time", title: "Stories Time" },
+	     *   { key: "Stories.count", title: "Stories Count" },
+	     *   //...
+	     * ]
+	     * ```
+	     * @param pivotConfig
+	     * @returns {Array} of columns
+	     */
+
 	  }, {
 	    key: "tableColumns",
 	    value: function tableColumns(pivotConfig) {
@@ -14725,6 +14817,29 @@
 	      // TODO
 	      return this.chartPivot(pivotConfig);
 	    }
+	    /**
+	     * Returns the array of series objects, containing `key` and `title` parameters.
+	     *
+	     * ```js
+	     * // For query
+	     * {
+	     *   measures: ['Stories.count'],
+	     *   timeDimensions: [{
+	     *     dimension: 'Stories.time',
+	     *     dateRange: ['2015-01-01', '2015-12-31'],
+	     *     granularity: 'month'
+	     *   }]
+	     * }
+	     *
+	     * // ResultSet.seriesNames() will return
+	     * [
+	     * { "key":"Stories.count", "title": "Stories Count" }
+	     * ]
+	     * ```
+	     * @param pivotConfig
+	     * @returns {Array} of series names
+	     */
+
 	  }, {
 	    key: "seriesNames",
 	    value: function seriesNames(pivotConfig) {
@@ -14959,6 +15074,11 @@
 	    });
 	  });
 	};
+	/**
+	 * Main class for accessing Cube.js API
+	 * @order -5
+	 */
+
 
 	var CubejsApi =
 	/*#__PURE__*/
@@ -15085,6 +15205,34 @@
 	        return mutexPromise(loadImpl());
 	      }
 	    }
+	    /**
+	     * Fetch data for passed `query`.
+	     *
+	     * ```js
+	     * import cubejs from '@cubejs-client/core';
+	     * import Chart from 'chart.js';
+	     * import chartjsConfig from './toChartjsData';
+	     *
+	     * const cubejsApi = cubejs('CUBEJS_TOKEN');
+	     *
+	     * const resultSet = await cubejsApi.load({
+	     *  measures: ['Stories.count'],
+	     *  timeDimensions: [{
+	     *    dimension: 'Stories.time',
+	     *    dateRange: ['2015-01-01', '2015-12-31'],
+	     *    granularity: 'month'
+	     *   }]
+	     * });
+	     *
+	     * const context = document.getElementById('myChart');
+	     * new Chart(context, chartjsConfig(resultSet));
+	     * ```
+	     * @param query - [Query object](query-format)
+	     * @param options
+	     * @param callback
+	     * @returns {Promise} for {@link ResultSet} if `callback` isn't passed
+	     */
+
 	  }, {
 	    key: "load",
 	    value: function load(query, options, callback) {
@@ -15096,6 +15244,14 @@
 	        return new ResultSet(body);
 	      }, options, callback);
 	    }
+	    /**
+	     * Get generated SQL string for given `query`.
+	     * @param query - [Query object](query-format)
+	     * @param options
+	     * @param callback
+	     * @return {Promise} for {@link SqlQuery} if `callback` isn't passed
+	     */
+
 	  }, {
 	    key: "sql",
 	    value: function sql(query, options, callback) {
@@ -15107,6 +15263,13 @@
 	        return new SqlQuery(body);
 	      }, options, callback);
 	    }
+	    /**
+	     * Get meta description of cubes available for querying.
+	     * @param options
+	     * @param callback
+	     * @return {Promise} for {@link Meta} if `callback` isn't passed
+	     */
+
 	  }, {
 	    key: "meta",
 	    value: function meta(options, callback) {
@@ -15122,6 +15285,28 @@
 
 	  return CubejsApi;
 	}();
+	/**
+	 * Create instance of `CubejsApi`.
+	 * API entry point.
+	 *
+	 * ```javascript
+	 import cubejs from '@cubejs-client/core';
+
+	 const cubejsApi = cubejs(
+	 'CUBEJS-API-TOKEN',
+	 { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
+	 );
+	 ```
+	 * @name cubejs
+	 * @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.
+	 * @param options - options object.
+	 * @param options.apiUrl - URL of your Cube.js Backend.
+	 * By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`.
+	 * @returns {CubejsApi}
+	 * @order -10
+	 */
+
 
 	var index = (function (apiToken, options) {
 	  return new CubejsApi(apiToken, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/core",
-  "version": "0.10.16",
+  "version": "0.10.61",
   "description": "cube.js client",
   "main": "dist/cubejs-client-core.js",
   "author": "Statsbot, Inc.",
@@ -26,5 +26,5 @@
     "babel-jest": "^24.1.0",
     "jest": "^24.1.0"
   },
-  "gitHead": "993b8eaf27d17e8d319d26c588490764936ef5fd"
+  "gitHead": "cc5aa4570e7bf9f920686e3574f657ec474bceaf"
 }

package/src/ResultSet.js

@@ -1,3 +1,7 @@
+/**
+ * @module @cubejs-client/core
+ */
+
 import {
   groupBy, pipe, toPairs, uniq, filter, map, unnest, dropLast, equals, reduce, minBy, maxBy
 } from 'ramda';
@@ -19,7 +23,10 @@ const TIME_SERIES = {
     .map(d => d.startOf('isoweek').format('YYYY-MM-DDT00:00:00.000'))
 };
 
-export default class ResultSet {
+/**
+ * Provides a convenient interface for data manipulation.
+ */
+class ResultSet {
   constructor(loadResponse) {
     this.loadResponse = loadResponse;
   }
@@ -74,6 +81,10 @@ export default class ResultSet {
     if (!pivotConfig.x.concat(pivotConfig.y).find(d => d === 'measures')) {
       pivotConfig.y = pivotConfig.y.concat(['measures']);
     }
+    if (!(query.measures || []).length) {
+      pivotConfig.x = pivotConfig.x.filter(d => d !== 'measures');
+      pivotConfig.y = pivotConfig.y.filter(d => d !== 'measures');
+    }
     if (pivotConfig.fillMissingDates == null) {
       pivotConfig.fillMissingDates = true;
     }
@@ -187,6 +198,30 @@ export default class ResultSet {
     return this.chartPivot(pivotConfig);
   }
 
+  /**
+   * Returns normalized query result data in the following format.
+   *
+   * ```js
+   * // For query
+   * {
+   *   measures: ['Stories.count'],
+   *   timeDimensions: [{
+   *     dimension: 'Stories.time',
+   *     dateRange: ['2015-01-01', '2015-12-31'],
+   *     granularity: 'month'
+   *   }]
+   * }
+   *
+   * // ResultSet.chartPivot() will return
+   * [
+   *   { "x":"2015-01-01T00:00:00", "Stories.count": 27120 },
+   *   { "x":"2015-02-01T00:00:00", "Stories.count": 25861 },
+   *   { "x": "2015-03-01T00:00:00", "Stories.count": 29661 },
+   *   //...
+   * ]
+   * ```
+   * @param pivotConfig
+   */
   chartPivot(pivotConfig) {
     return this.pivot(pivotConfig).map(({ xValues, yValuesArray }) => ({
       category: this.axisValuesString(xValues, ', '), // TODO deprecated
@@ -199,6 +234,33 @@ export default class ResultSet {
     }));
   }
 
+  /**
+   * Returns normalized query result data prepared for visualization in the table format.
+   *
+   * For example
+   *
+   * ```js
+   * // For query
+   * {
+   *   measures: ['Stories.count'],
+   *   timeDimensions: [{
+   *     dimension: 'Stories.time',
+   *     dateRange: ['2015-01-01', '2015-12-31'],
+   *     granularity: 'month'
+   *   }]
+   * }
+   *
+   * // ResultSet.tablePivot() will return
+   * [
+   *   { "Stories.time": "2015-01-01T00:00:00", "Stories.count": 27120 },
+   *   { "Stories.time": "2015-02-01T00:00:00", "Stories.count": 25861 },
+   *   { "Stories.time": "2015-03-01T00:00:00", "Stories.count": 29661 },
+   *   //...
+   * ]
+   * ```
+   * @param pivotConfig
+   * @returns {Array} of pivoted rows
+   */
   tablePivot(pivotConfig) {
     const normalizedPivotConfig = this.normalizePivotConfig(pivotConfig);
     const valueToObject =
@@ -217,6 +279,32 @@ export default class ResultSet {
     ));
   }
 
+  /**
+   * Returns array of column definitions for `tablePivot`.
+   *
+   * For example
+   *
+   * ```js
+   * // For query
+   * {
+   *   measures: ['Stories.count'],
+   *   timeDimensions: [{
+   *     dimension: 'Stories.time',
+   *     dateRange: ['2015-01-01', '2015-12-31'],
+   *     granularity: 'month'
+   *   }]
+   * }
+   *
+   * // ResultSet.tableColumns() will return
+   * [
+   *   { key: "Stories.time", title: "Stories Time" },
+   *   { key: "Stories.count", title: "Stories Count" },
+   *   //...
+   * ]
+   * ```
+   * @param pivotConfig
+   * @returns {Array} of columns
+   */
   tableColumns(pivotConfig) {
     const normalizedPivotConfig = this.normalizePivotConfig(pivotConfig);
     const column = field => (
@@ -243,6 +331,28 @@ export default class ResultSet {
     return this.chartPivot(pivotConfig);
   }
 
+  /**
+   * Returns the array of series objects, containing `key` and `title` parameters.
+   *
+   * ```js
+   * // For query
+   * {
+   *   measures: ['Stories.count'],
+   *   timeDimensions: [{
+   *     dimension: 'Stories.time',
+   *     dateRange: ['2015-01-01', '2015-12-31'],
+   *     granularity: 'month'
+   *   }]
+   * }
+   *
+   * // ResultSet.seriesNames() will return
+   * [
+   * { "key":"Stories.count", "title": "Stories Count" }
+   * ]
+   * ```
+   * @param pivotConfig
+   * @returns {Array} of series names
+   */
   seriesNames(pivotConfig) {
     pivotConfig = this.normalizePivotConfig(pivotConfig);
     return pipe(map(this.axisValues(pivotConfig.y)), unnest, uniq)(this.loadResponse.data).map(axisValues => ({
@@ -262,3 +372,5 @@ export default class ResultSet {
     return this.loadResponse.data;
   }
 }
+
+export default ResultSet;

package/src/ResultSet.test.js

@@ -87,7 +87,7 @@ describe('ResultSet', () => {
 
       expect(resultSet.normalizePivotConfig({ y: ['Foo.bar'] })).toEqual({
         x: ['Foo.createdAt'],
-        y: ['Foo.bar', 'measures'],
+        y: ['Foo.bar'],
         fillMissingDates: true
       });
     });

package/src/index.js

@@ -1,3 +1,11 @@
+/**
+ * Vanilla JavaScript Cube.js client.
+ * @module @cubejs-client/core
+ * @permalink /@cubejs-client-core
+ * @category Cube.js Frontend
+ * @menuOrder 2
+ */
+
 import fetch from 'cross-fetch';
 import ResultSet from './ResultSet';
 import SqlQuery from './SqlQuery';
@@ -13,9 +21,13 @@ const MUTEX_ERROR = 'Mutex has been changed';
 const mutexPromise = (promise) => {
   return new Promise((resolve, reject) => {
     promise.then(r => resolve(r), e => e !== MUTEX_ERROR && reject(e));
-  })
+  });
 };
 
+/**
+ * Main class for accessing Cube.js API
+ * @order -5
+ */
 class CubejsApi {
   constructor(apiToken, options) {
     options = options || {};
@@ -78,6 +90,33 @@ class CubejsApi {
     }
   }
 
+  /**
+   * Fetch data for passed `query`.
+   *
+   * ```js
+   * import cubejs from '@cubejs-client/core';
+   * import Chart from 'chart.js';
+   * import chartjsConfig from './toChartjsData';
+   *
+   * const cubejsApi = cubejs('CUBEJS_TOKEN');
+   *
+   * const resultSet = await cubejsApi.load({
+   *  measures: ['Stories.count'],
+   *  timeDimensions: [{
+   *    dimension: 'Stories.time',
+   *    dateRange: ['2015-01-01', '2015-12-31'],
+   *    granularity: 'month'
+   *   }]
+   * });
+   *
+   * const context = document.getElementById('myChart');
+   * new Chart(context, chartjsConfig(resultSet));
+   * ```
+   * @param query - [Query object](query-format)
+   * @param options
+   * @param callback
+   * @returns {Promise} for {@link ResultSet} if `callback` isn't passed
+   */
   load(query, options, callback) {
     return this.loadMethod(
       () => this.request(`/load?query=${encodeURIComponent(JSON.stringify(query))}`),
@@ -87,6 +126,13 @@ class CubejsApi {
     );
   }
 
+  /**
+   * Get generated SQL string for given `query`.
+   * @param query - [Query object](query-format)
+   * @param options
+   * @param callback
+   * @return {Promise} for {@link SqlQuery} if `callback` isn't passed
+   */
   sql(query, options, callback) {
     return this.loadMethod(
       () => this.request(`/sql?query=${JSON.stringify(query)}`),
@@ -96,6 +142,12 @@ class CubejsApi {
     );
   }
 
+  /**
+   * Get meta description of cubes available for querying.
+   * @param options
+   * @param callback
+   * @return {Promise} for {@link Meta} if `callback` isn't passed
+   */
   meta(options, callback) {
     return this.loadMethod(
       () => this.request(`/meta`),
@@ -106,6 +158,27 @@ class CubejsApi {
   }
 }
 
+/**
+ * Create instance of `CubejsApi`.
+ * API entry point.
+ *
+ * ```javascript
+ import cubejs from '@cubejs-client/core';
+
+ const cubejsApi = cubejs(
+ 'CUBEJS-API-TOKEN',
+ { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
+ );
+ ```
+ * @name cubejs
+ * @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.
+ * @param options - options object.
+ * @param options.apiUrl - URL of your Cube.js Backend.
+ * By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`.
+ * @returns {CubejsApi}
+ * @order -10
+ */
 export default (apiToken, options) => {
   return new CubejsApi(apiToken, options);
 };