@@ -4,42 +4,47 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
5
5
function _interopDefault ( ex ) { return ( ex && ( typeof ex === 'object' ) && 'default' in ex ) ? ex [ 'default' ] : ex ; }
6
6
7
+ require ( 'core-js/modules/es.object.to-string' ) ;
8
+ require ( 'core-js/modules/es.promise' ) ;
9
+ require ( 'core-js/modules/web.timers' ) ;
7
10
var _regeneratorRuntime = _interopDefault ( require ( '@babel/runtime/regenerator' ) ) ;
8
11
require ( 'regenerator-runtime/runtime' ) ;
9
12
var _asyncToGenerator = _interopDefault ( require ( '@babel/runtime/helpers/asyncToGenerator' ) ) ;
10
13
var _objectSpread2 = _interopDefault ( require ( '@babel/runtime/helpers/objectSpread' ) ) ;
11
14
var _typeof = _interopDefault ( require ( '@babel/runtime/helpers/typeof' ) ) ;
12
15
var _classCallCheck = _interopDefault ( require ( '@babel/runtime/helpers/classCallCheck' ) ) ;
13
16
var _createClass = _interopDefault ( require ( '@babel/runtime/helpers/createClass' ) ) ;
14
- require ( 'core-js/modules/es6.promise' ) ;
15
- require ( 'core-js/modules/es6.object.to-string' ) ;
16
17
var uuid = _interopDefault ( require ( 'uuid/v4' ) ) ;
17
- require ( 'core-js/modules/es6.number.parse-float' ) ;
18
- require ( 'core-js/modules/es6.number.constructor' ) ;
19
- require ( 'core-js/modules/es6.number.is-nan' ) ;
20
- require ( 'core-js/modules/web.dom.iterable' ) ;
21
- require ( 'core-js/modules/es6.array.iterator' ) ;
22
- require ( 'core-js/modules/es6.object.keys' ) ;
18
+ require ( 'core-js/modules/es.array.concat' ) ;
19
+ require ( 'core-js/modules/es.array.filter' ) ;
20
+ require ( 'core-js/modules/es.array.find' ) ;
21
+ require ( 'core-js/modules/es.array.from' ) ;
22
+ require ( 'core-js/modules/es.array.index-of' ) ;
23
+ require ( 'core-js/modules/es.array.join' ) ;
24
+ require ( 'core-js/modules/es.array.map' ) ;
25
+ require ( 'core-js/modules/es.array.reduce' ) ;
26
+ require ( 'core-js/modules/es.date.to-string' ) ;
27
+ require ( 'core-js/modules/es.number.constructor' ) ;
28
+ require ( 'core-js/modules/es.number.is-nan' ) ;
29
+ require ( 'core-js/modules/es.number.parse-float' ) ;
30
+ require ( 'core-js/modules/es.object.assign' ) ;
31
+ require ( 'core-js/modules/es.object.keys' ) ;
32
+ require ( 'core-js/modules/es.regexp.exec' ) ;
33
+ require ( 'core-js/modules/es.string.iterator' ) ;
34
+ require ( 'core-js/modules/es.string.match' ) ;
23
35
var _slicedToArray = _interopDefault ( require ( '@babel/runtime/helpers/slicedToArray' ) ) ;
24
- require ( 'core-js/modules/es6.object.assign' ) ;
25
36
var _defineProperty = _interopDefault ( require ( '@babel/runtime/helpers/defineProperty' ) ) ;
26
- require ( 'core-js/modules/es6.array.reduce' ) ;
27
- require ( 'core-js/modules/es6.regexp.match' ) ;
28
- require ( 'core-js/modules/es6.array.index-of' ) ;
29
- require ( 'core-js/modules/es6.array.find' ) ;
30
- require ( 'core-js/modules/es6.array.filter' ) ;
31
37
var _objectWithoutProperties = _interopDefault ( require ( '@babel/runtime/helpers/objectWithoutProperties' ) ) ;
32
- require ( 'core-js/modules/es6.string.iterator' ) ;
33
- require ( 'core-js/modules/es6.array.from' ) ;
34
- require ( 'core-js/modules/es6.array.map' ) ;
35
38
var ramda = require ( 'ramda' ) ;
36
39
var Moment = _interopDefault ( require ( 'moment' ) ) ;
37
40
var momentRange = _interopDefault ( require ( 'moment-range' ) ) ;
38
- require ( 'core-js/modules/es6.array.is-array' ) ;
39
- require ( 'core-js/modules/es6.regexp.split' ) ;
40
- require ( 'core-js/modules/es6.function.name' ) ;
41
- require ( 'core-js/modules/es6.regexp.to-string' ) ;
42
- require ( 'core-js/modules/es6.date.to-string' ) ;
41
+ require ( 'core-js/modules/es.array.is-array' ) ;
42
+ require ( 'core-js/modules/es.function.name' ) ;
43
+ require ( 'core-js/modules/es.string.split' ) ;
44
+ require ( 'core-js/modules/es.array.iterator' ) ;
45
+ require ( 'core-js/modules/es.regexp.to-string' ) ;
46
+ require ( 'core-js/modules/web.dom-collections.iterator' ) ;
47
+ require ( 'core-js/modules/web.url' ) ;
43
48
var fetch = _interopDefault ( require ( 'cross-fetch' ) ) ;
44
49
require ( 'url-search-params-polyfill' ) ;
45
50
@@ -932,9 +937,19 @@ function () {
932
937
return ProgressResult ;
933
938
} ( ) ;
934
939
940
+ /**
941
+ * Default transport implementation.
942
+ */
943
+
935
944
var HttpTransport =
936
945
/*#__PURE__*/
937
946
function ( ) {
947
+ /**
948
+ * @param options - mandatory options object
949
+ * @param options.authorization - [jwt auth token](security)
950
+ * @param options.apiUrl - path to `/cubejs-api/v1`
951
+ * @param [options.headers] - object of custom headers
952
+ */
938
953
function HttpTransport ( _ref ) {
939
954
var authorization = _ref . authorization ,
940
955
apiUrl = _ref . apiUrl ,
@@ -1059,6 +1074,23 @@ function () {
1059
1074
baseRequestId : uuid ( )
1060
1075
} , params ) ) ;
1061
1076
}
1077
+ /**
1078
+ * Base method used to perform all API calls.
1079
+ * Shouldn't be used directly.
1080
+ * @param request - function that invoked to perform actual request using `transport.request()` method.
1081
+ * @param toResult - function that maps results of invocation to method return result
1082
+ * @param [options] - options object
1083
+ * @param options.mutexObj - object to use to store MUTEX
1084
+ * @param [options.mutexKey='default'] - key to use to store current request MUTEX inside `mutexObj`.
1085
+ * MUTEX object is used to reject orphaned queries results when new queries are sent.
1086
+ * For example if two queries are sent with same `mutexKey` only last one will return results.
1087
+ * @param options.subscribe - pass `true` to use continuous fetch behavior.
1088
+ * @param {Function } options.progressCallback - function that receives `ProgressResult` on each
1089
+ * `Continue wait` message.
1090
+ * @param [callback] - if passed `callback` function will be called instead of `Promise` returned
1091
+ * @return {{unsubscribe: function()} }
1092
+ */
1093
+
1062
1094
} , {
1063
1095
key : "loadMethod" ,
1064
1096
value : function loadMethod ( request , toResult , options , callback ) {
@@ -1474,8 +1506,8 @@ function () {
1474
1506
* new Chart(context, chartjsConfig(resultSet));
1475
1507
* ```
1476
1508
* @param query - [Query object](query-format)
1477
- * @param options
1478
- * @param callback
1509
+ * @param [ options] - See { @link CubejsApi#loadMethod}
1510
+ * @param [ callback] - See { @link CubejsApi#loadMethod}
1479
1511
* @returns {Promise } for {@link ResultSet} if `callback` isn't passed
1480
1512
*/
1481
1513
@@ -1497,8 +1529,8 @@ function () {
1497
1529
/**
1498
1530
* Get generated SQL string for given `query`.
1499
1531
* @param query - [Query object](query-format)
1500
- * @param options
1501
- * @param callback
1532
+ * @param [ options] - See { @link CubejsApi#loadMethod}
1533
+ * @param [ callback] - See { @link CubejsApi#loadMethod}
1502
1534
* @return {Promise } for {@link SqlQuery} if `callback` isn't passed
1503
1535
*/
1504
1536
@@ -1517,8 +1549,8 @@ function () {
1517
1549
}
1518
1550
/**
1519
1551
* Get meta description of cubes available for querying.
1520
- * @param options
1521
- * @param callback
1552
+ * @param [ options] - See { @link CubejsApi#loadMethod}
1553
+ * @param [ callback] - See { @link CubejsApi#loadMethod}
1522
1554
* @return {Promise } for {@link Meta} if `callback` isn't passed
1523
1555
*/
1524
1556
@@ -1567,12 +1599,13 @@ function () {
1567
1599
);
1568
1600
```
1569
1601
* @name cubejs
1570
- * @param apiToken - [API token](security) is used to authorize requests and determine SQL database you're accessing.
1602
+ * @param [ apiToken] - [API token](security) is used to authorize requests and determine SQL database you're accessing.
1571
1603
* In the development mode, Cube.js Backend will print the API token to the console on on startup.
1572
- * Can be an async function without arguments that returns API token. Optional.
1573
- * @param options - options object.
1604
+ * Can be an async function without arguments that returns API token.
1605
+ * @param [ options] - options object.
1574
1606
* @param options.apiUrl - URL of your Cube.js Backend.
1575
1607
* By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`.
1608
+ * @param options.transport - transport implementation to use. {@link HttpTransport} will be used by default.
1576
1609
* @returns {CubejsApi }
1577
1610
* @order -10
1578
1611
*/
0 commit comments