@cubejs-client/core 0.10.59 → 0.10.61

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 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

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

@@ -57,6 +57,9 @@ var TIME_SERIES = {
     });
   }
 };
+/**
+ * Provides a convenient interface for data manipulation.
+ */
 
 var ResultSet =
 /*#__PURE__*/
@@ -320,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) {
@@ -343,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) {
@@ -370,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) {
@@ -404,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) {
@@ -638,6 +744,11 @@ var mutexPromise = function mutexPromise(promise) {
     });
   });
 };
+/**
+ * Main class for accessing Cube.js API
+ * @order -5
+ */
+
 
 var CubejsApi =
 /*#__PURE__*/
@@ -764,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) {
@@ -775,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) {
@@ -786,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) {
@@ -801,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__*/
@@ -324,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) {
@@ -347,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) {
@@ -374,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) {
@@ -408,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) {
@@ -642,6 +748,11 @@ var mutexPromise = function mutexPromise(promise) {
     });
   });
 };
+/**
+ * Main class for accessing Cube.js API
+ * @order -5
+ */
+
 
 var CubejsApi =
 /*#__PURE__*/
@@ -768,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) {
@@ -779,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) {
@@ -790,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) {
@@ -805,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__*/
@@ -14650,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) {
@@ -14673,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) {
@@ -14700,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) {
@@ -14734,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) {
@@ -14968,6 +15074,11 @@
 	    });
 	  });
 	};
+	/**
+	 * Main class for accessing Cube.js API
+	 * @order -5
+	 */
+
 
 	var CubejsApi =
 	/*#__PURE__*/
@@ -15094,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) {
@@ -15105,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) {
@@ -15116,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) {
@@ -15131,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.59",
+  "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": "31a826dedfa046b442e43bb9885e2bcfb00aaebe"
+  "gitHead": "cc5aa4570e7bf9f920686e3574f657ec474bceaf"
 }