@gooddata/sdk-ui 8.10.0-alpha.75 → 8.10.0-alpha.76

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/base/results/facade.d.ts +0 -4
  2. package/dist/base/results/facade.d.ts.map +1 -1
  3. package/dist/base/results/facade.js +0 -4
  4. package/dist/base/results/facade.js.map +1 -1
  5. package/dist/base/results/internal/definitionMethods.d.ts +1 -1
  6. package/dist/base/results/internal/resultDataMethods.d.ts +1 -1
  7. package/dist/base/results/internal/resultMetaMethods.d.ts +1 -1
  8. package/dist/execution/DataViewLoader.d.ts +70 -0
  9. package/dist/execution/DataViewLoader.d.ts.map +1 -0
  10. package/dist/execution/DataViewLoader.js +146 -0
  11. package/dist/execution/DataViewLoader.js.map +1 -0
  12. package/dist/execution/index.d.ts +1 -0
  13. package/dist/execution/index.d.ts.map +1 -1
  14. package/dist/execution/index.js +3 -1
  15. package/dist/execution/index.js.map +1 -1
  16. package/dist/sdk-ui.d.ts +70 -7
  17. package/esm/base/results/facade.d.ts +0 -4
  18. package/esm/base/results/facade.d.ts.map +1 -1
  19. package/esm/base/results/facade.js +0 -4
  20. package/esm/base/results/facade.js.map +1 -1
  21. package/esm/base/results/internal/definitionMethods.d.ts +1 -1
  22. package/esm/base/results/internal/resultDataMethods.d.ts +1 -1
  23. package/esm/base/results/internal/resultMetaMethods.d.ts +1 -1
  24. package/esm/execution/DataViewLoader.d.ts +70 -0
  25. package/esm/execution/DataViewLoader.d.ts.map +1 -0
  26. package/esm/execution/DataViewLoader.js +143 -0
  27. package/esm/execution/DataViewLoader.js.map +1 -0
  28. package/esm/execution/index.d.ts +1 -0
  29. package/esm/execution/index.d.ts.map +1 -1
  30. package/esm/execution/index.js +1 -0
  31. package/esm/execution/index.js.map +1 -1
  32. package/package.json +11 -8
@@ -18,10 +18,6 @@ import { IDataAccessMethods } from "./dataAccess";
18
18
  * The facade is part of the public API and we strongly recommend to use it whenever client code needs to work with
19
19
  * data view; ideally, single instance of data view facade
20
20
  *
21
- * Note: the facade is currently in alpha quality - mix-match of various functions we found useful so far; consolidation
22
- * and further enhancements will happen, the methods will be removed, renamed and added in the future. The public
23
- * API WILL break.
24
- *
25
21
  * @public
26
22
  */
27
23
  export declare class DataViewFacade {
@@ -1 +1 @@
1
- {"version":3,"file":"facade.d.ts","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,oBAAoB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAgC,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAc;aAce,QAAQ,EAAE,SAAS;IAbzD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAgF;IACtG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAG3B;IAEJ,SAAgB,UAAU,EAAE,oBAAoB,CAAC;IAEjD,OAAO,CAAC,iBAAiB,CAA0C;IACnE,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,SAAS,aAA6B,QAAQ,EAAE,SAAS;IAQzD;;;OAGG;WACW,GAAG,CAAC,QAAQ,EAAE,SAAS,GAAG,cAAc;IAQtD;;;;;;;;;;OAUG;WACW,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,cAAc;IASjE;;;OAGG;IACI,MAAM,IAAI,gBAAgB;IAIjC;;;OAGG;IACI,QAAQ,IAAI,cAAc,EAAE;IAInC;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAI5B;;;OAGG;IACI,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,kBAAkB;IAY1D;;;OAGG;IACI,GAAG,IAAI,2BAA2B;IAQzC;;;OAGG;IACI,IAAI,IAAI,kBAAkB;IAQjC;;;OAGG;IACI,OAAO,IAAI,kBAAkB;CAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAmB1E"}
1
+ {"version":3,"file":"facade.d.ts","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,oBAAoB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAgC,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,cAAc;aAce,QAAQ,EAAE,SAAS;IAbzD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAgF;IACtG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAG3B;IAEJ,SAAgB,UAAU,EAAE,oBAAoB,CAAC;IAEjD,OAAO,CAAC,iBAAiB,CAA0C;IACnE,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,SAAS,aAA6B,QAAQ,EAAE,SAAS;IAQzD;;;OAGG;WACW,GAAG,CAAC,QAAQ,EAAE,SAAS,GAAG,cAAc;IAQtD;;;;;;;;;;OAUG;WACW,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,cAAc;IASjE;;;OAGG;IACI,MAAM,IAAI,gBAAgB;IAIjC;;;OAGG;IACI,QAAQ,IAAI,cAAc,EAAE;IAInC;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAI5B;;;OAGG;IACI,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,kBAAkB;IAY1D;;;OAGG;IACI,GAAG,IAAI,2BAA2B;IAQzC;;;OAGG;IACI,IAAI,IAAI,kBAAkB;IAQjC;;;OAGG;IACI,OAAO,IAAI,kBAAkB;CAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAmB1E"}
@@ -20,10 +20,6 @@ var dataAccessMethods_1 = require("./internal/dataAccessMethods");
20
20
  * The facade is part of the public API and we strongly recommend to use it whenever client code needs to work with
21
21
  * data view; ideally, single instance of data view facade
22
22
  *
23
- * Note: the facade is currently in alpha quality - mix-match of various functions we found useful so far; consolidation
24
- * and further enhancements will happen, the methods will be removed, renamed and added in the future. The public
25
- * API WILL break.
26
- *
27
23
  * @public
28
24
  */
29
25
  var DataViewFacade = /** @class */ (function () {
@@ -1 +1 @@
1
- {"version":3,"file":"facade.js","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,iDAA2F;AAG3F,kEAAyG;AACzG,kEAAwF;AACxF,kEAAwF;AAExF,kEAAoE;AAEpE;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAcI,wBAAsC,QAAmB;QAAnB,aAAQ,GAAR,QAAQ,CAAW;QACrD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,EAAE;IACF,cAAc;IACd,EAAE;IAEF;;;OAGG;IACW,kBAAG,GAAjB,UAAkB,QAAmB;QACjC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACvC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtE;QAED,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;;;OAUG;IACW,wBAAS,GAAvB,UAAwB,MAAwB;QAC5C,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC9C,IAAM,SAAS,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;YACjD,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;SAC9E;QAED,OAAO,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,+BAAM,GAAb;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,iCAAQ,GAAf;;QACI,aAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,mCAAI,EAAE,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,oCAAW,GAAlB;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX,UAAY,MAAyB;QACjC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED,EAAE;IACF,EAAE;IACF,EAAE;IAEF;;;OAGG;IACI,4BAAG,GAAV;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,gDAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,gCAAO,GAAd;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAhIc,sBAAO,GAAuC,IAAI,OAAO,EAA6B,CAAC;IACvF,+BAAgB,GAA8C,IAAI,OAAO,EAGrF,CAAC;IA6HR,qBAAC;CAAA,AAlID,IAkIC;AAlIY,wCAAc;AAoI3B;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,MAAwB;IACnD,IAAA,UAAU,GAAK,MAAM,WAAX,CAAY;IAC9B,IAAM,EAAE,GAAG,0BAAc,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;IAErD,OAAO;QACH,UAAU,YAAA;QACV,MAAM,QAAA;QACN,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACd,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACb,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAClB,WAAW,EAAX;YACI,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,EAAN,UAAO,KAAgB;YACnB,OAAO,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;KACJ,CAAC;AACN,CAAC;AAnBD,wDAmBC"}
1
+ {"version":3,"file":"facade.js","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,iDAA2F;AAG3F,kEAAyG;AACzG,kEAAwF;AACxF,kEAAwF;AAExF,kEAAoE;AAEpE;;;;;;;;;;;;;;GAcG;AACH;IAcI,wBAAsC,QAAmB;QAAnB,aAAQ,GAAR,QAAQ,CAAW;QACrD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,EAAE;IACF,cAAc;IACd,EAAE;IAEF;;;OAGG;IACW,kBAAG,GAAjB,UAAkB,QAAmB;QACjC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACvC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtE;QAED,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;;;OAUG;IACW,wBAAS,GAAvB,UAAwB,MAAwB;QAC5C,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC9C,IAAM,SAAS,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;YACjD,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;SAC9E;QAED,OAAO,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,+BAAM,GAAb;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,iCAAQ,GAAf;;QACI,aAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,mCAAI,EAAE,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,oCAAW,GAAlB;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX,UAAY,MAAyB;QACjC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED,EAAE;IACF,EAAE;IACF,EAAE;IAEF;;;OAGG;IACI,4BAAG,GAAV;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,gDAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,gCAAO,GAAd;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAhIc,sBAAO,GAAuC,IAAI,OAAO,EAA6B,CAAC;IACvF,+BAAgB,GAA8C,IAAI,OAAO,EAGrF,CAAC;IA6HR,qBAAC;CAAA,AAlID,IAkIC;AAlIY,wCAAc;AAoI3B;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,MAAwB;IACnD,IAAA,UAAU,GAAK,MAAM,WAAX,CAAY;IAC9B,IAAM,EAAE,GAAG,0BAAc,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;IAErD,OAAO;QACH,UAAU,YAAA;QACV,MAAM,QAAA;QACN,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACd,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACb,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAClB,WAAW,EAAX;YACI,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,EAAN,UAAO,KAAgB;YACnB,OAAO,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;KACJ,CAAC;AACN,CAAC;AAnBD,wDAmBC"}
@@ -2,7 +2,7 @@ import { IAttribute, IBucket, IExecutionDefinition, IMeasure } from "@gooddata/s
2
2
  /**
3
3
  * Methods to work with execution definition.
4
4
  *
5
- * @public
5
+ * @internal
6
6
  */
7
7
  export interface IExecutionDefinitionMethods {
8
8
  /**
@@ -3,7 +3,7 @@ import { DataValue } from "@gooddata/sdk-model";
3
3
  /**
4
4
  * Methods to access data and totals in a result.
5
5
  *
6
- * @public
6
+ * @internal
7
7
  */
8
8
  export interface IResultDataMethods {
9
9
  /**
@@ -3,7 +3,7 @@ import { ISortItem, IMeasureDescriptor, IDimensionItemDescriptor, IDimensionDesc
3
3
  /**
4
4
  * Methods to access result metadata - dimension descriptors and result headers.
5
5
  *
6
- * @public
6
+ * @internal
7
7
  */
8
8
  export interface IResultMetaMethods {
9
9
  /**
@@ -0,0 +1,70 @@
1
+ import { IAttribute, IAttributeOrMeasure, INullableFilter, ISortItem, ITotal } from "@gooddata/sdk-model";
2
+ import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
3
+ import { DataViewWindow } from "./withExecutionLoading";
4
+ import { DataViewFacade } from "../base";
5
+ /**
6
+ * DataViewLoader allows you to speficy, load and access data results with convenient series and slices API.
7
+ *
8
+ * @alpha
9
+ */
10
+ export declare class DataViewLoader {
11
+ private readonly backend;
12
+ private readonly workspace;
13
+ private readonly options;
14
+ private constructor();
15
+ /**
16
+ * Creates a new instance of the DataViewLoader for particular backend and workspace.
17
+ *
18
+ * @alpha
19
+ */
20
+ static for(backend: IAnalyticalBackend, workspace: string): DataViewLoader;
21
+ /**
22
+ * Data series will be built using the provided measures that are further scoped for
23
+ * elements of the specified attributes.
24
+ *
25
+ * @remarks
26
+ * You must define at least 1 measure for the series.
27
+ *
28
+ * @alpha
29
+ */
30
+ seriesFrom: (...measuresAndScopingAttributes: IAttributeOrMeasure[]) => DataViewLoader;
31
+ /**
32
+ * Slice all data series by elements of these attributes.
33
+ *
34
+ * @alpha
35
+ */
36
+ slicesFrom: (...attributes: IAttribute[]) => DataViewLoader;
37
+ /**
38
+ * Filters to apply on server side.
39
+ *
40
+ * @alpha
41
+ */
42
+ filterBy: (...filters: INullableFilter[]) => DataViewLoader;
43
+ /**
44
+ * Sorting to apply on server side.
45
+ *
46
+ * @alpha
47
+ */
48
+ sortBy: (...sorts: ISortItem[]) => DataViewLoader;
49
+ /**
50
+ * Include these totals among the data slices.
51
+ *
52
+ * @alpha
53
+ */
54
+ withTotals: (...totals: ITotal[]) => DataViewLoader;
55
+ /**
56
+ * Loads subset of the result data and wraps them in {@link DataViewFacade}.
57
+ *
58
+ * @alpha
59
+ */
60
+ loadWindow: (dataWindow: DataViewWindow) => Promise<DataViewFacade>;
61
+ /**
62
+ * Loads all the result data and wraps them in {@link DataViewFacade}.
63
+ *
64
+ * @alpha
65
+ */
66
+ loadAll: () => Promise<DataViewFacade>;
67
+ private loadResult;
68
+ private newLoaderWithOptions;
69
+ }
70
+ //# sourceMappingURL=DataViewLoader.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DataViewLoader.d.ts","sourceRoot":"","sources":["../../src/execution/DataViewLoader.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EAAE,kBAAkB,EAAoB,MAAM,2BAA2B,CAAC;AAEjF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAkBzC;;;;GAIG;AACH,qBAAa,cAAc;IAEnB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAH5B,OAAO;IAMP;;;;OAIG;WACW,GAAG,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,GAAG,cAAc;IAIjF;;;;;;;;OAQG;IACI,UAAU,oCAAqC,mBAAmB,EAAE,KAAG,cAAc,CAE1F;IAEF;;;;OAIG;IACI,UAAU,kBAAmB,UAAU,EAAE,KAAG,cAAc,CAE/D;IAEF;;;;OAIG;IACI,QAAQ,eAAgB,eAAe,EAAE,KAAG,cAAc,CAE/D;IAEF;;;;OAIG;IACI,MAAM,aAAc,SAAS,EAAE,KAAG,cAAc,CAErD;IAEF;;;;OAIG;IACI,UAAU,cAAe,MAAM,EAAE,KAAG,cAAc,CAEvD;IAEF;;;;OAIG;IACI,UAAU,eAAsB,cAAc,KAAG,QAAQ,cAAc,CAAC,CAI7E;IAEF;;;;OAIG;IACI,OAAO,QAAa,QAAQ,cAAc,CAAC,CAIhD;IAEF,OAAO,CAAC,UAAU,CAYhB;IAEF,OAAO,CAAC,oBAAoB,CAE1B;CACL"}
@@ -0,0 +1,146 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DataViewLoader = void 0;
4
+ var tslib_1 = require("tslib");
5
+ // (C) 2019-2022 GoodData Corporation
6
+ var ts_invariant_1 = tslib_1.__importDefault(require("ts-invariant"));
7
+ var createExecution_1 = require("./createExecution");
8
+ var base_1 = require("../base");
9
+ /**
10
+ * DataViewLoader allows you to speficy, load and access data results with convenient series and slices API.
11
+ *
12
+ * @alpha
13
+ */
14
+ var DataViewLoader = /** @class */ (function () {
15
+ function DataViewLoader(backend, workspace, options) {
16
+ var _this = this;
17
+ if (options === void 0) { options = {}; }
18
+ this.backend = backend;
19
+ this.workspace = workspace;
20
+ this.options = options;
21
+ /**
22
+ * Data series will be built using the provided measures that are further scoped for
23
+ * elements of the specified attributes.
24
+ *
25
+ * @remarks
26
+ * You must define at least 1 measure for the series.
27
+ *
28
+ * @alpha
29
+ */
30
+ this.seriesFrom = function () {
31
+ var measuresAndScopingAttributes = [];
32
+ for (var _i = 0; _i < arguments.length; _i++) {
33
+ measuresAndScopingAttributes[_i] = arguments[_i];
34
+ }
35
+ return _this.newLoaderWithOptions({ seriesBy: measuresAndScopingAttributes });
36
+ };
37
+ /**
38
+ * Slice all data series by elements of these attributes.
39
+ *
40
+ * @alpha
41
+ */
42
+ this.slicesFrom = function () {
43
+ var attributes = [];
44
+ for (var _i = 0; _i < arguments.length; _i++) {
45
+ attributes[_i] = arguments[_i];
46
+ }
47
+ return _this.newLoaderWithOptions({ slicesBy: attributes });
48
+ };
49
+ /**
50
+ * Filters to apply on server side.
51
+ *
52
+ * @alpha
53
+ */
54
+ this.filterBy = function () {
55
+ var filters = [];
56
+ for (var _i = 0; _i < arguments.length; _i++) {
57
+ filters[_i] = arguments[_i];
58
+ }
59
+ return _this.newLoaderWithOptions({ filters: filters });
60
+ };
61
+ /**
62
+ * Sorting to apply on server side.
63
+ *
64
+ * @alpha
65
+ */
66
+ this.sortBy = function () {
67
+ var sorts = [];
68
+ for (var _i = 0; _i < arguments.length; _i++) {
69
+ sorts[_i] = arguments[_i];
70
+ }
71
+ return _this.newLoaderWithOptions({ sortBy: sorts });
72
+ };
73
+ /**
74
+ * Include these totals among the data slices.
75
+ *
76
+ * @alpha
77
+ */
78
+ this.withTotals = function () {
79
+ var totals = [];
80
+ for (var _i = 0; _i < arguments.length; _i++) {
81
+ totals[_i] = arguments[_i];
82
+ }
83
+ return _this.newLoaderWithOptions({ totals: totals });
84
+ };
85
+ /**
86
+ * Loads subset of the result data and wraps them in {@link DataViewFacade}.
87
+ *
88
+ * @alpha
89
+ */
90
+ this.loadWindow = function (dataWindow) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
91
+ var result, dataView;
92
+ return tslib_1.__generator(this, function (_a) {
93
+ switch (_a.label) {
94
+ case 0: return [4 /*yield*/, this.loadResult()];
95
+ case 1:
96
+ result = _a.sent();
97
+ return [4 /*yield*/, result.readWindow(dataWindow.offset, dataWindow.size)];
98
+ case 2:
99
+ dataView = _a.sent();
100
+ return [2 /*return*/, base_1.DataViewFacade.for(dataView)];
101
+ }
102
+ });
103
+ }); };
104
+ /**
105
+ * Loads all the result data and wraps them in {@link DataViewFacade}.
106
+ *
107
+ * @alpha
108
+ */
109
+ this.loadAll = function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
110
+ var result, dataView;
111
+ return tslib_1.__generator(this, function (_a) {
112
+ switch (_a.label) {
113
+ case 0: return [4 /*yield*/, this.loadResult()];
114
+ case 1:
115
+ result = _a.sent();
116
+ return [4 /*yield*/, result.readAll()];
117
+ case 2:
118
+ dataView = _a.sent();
119
+ return [2 /*return*/, base_1.DataViewFacade.for(dataView)];
120
+ }
121
+ });
122
+ }); };
123
+ this.loadResult = function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
124
+ var execution;
125
+ return tslib_1.__generator(this, function (_a) {
126
+ ts_invariant_1.default(this.options.seriesBy, "You need to specify series before loading the results.");
127
+ execution = createExecution_1.createExecution(tslib_1.__assign({ backend: this.backend, workspace: this.workspace, seriesBy: this.options.seriesBy, componentName: "DataViewLoader" }, this.options));
128
+ return [2 /*return*/, execution.execute()];
129
+ });
130
+ }); };
131
+ this.newLoaderWithOptions = function (options) {
132
+ return new DataViewLoader(_this.backend, _this.workspace, tslib_1.__assign(tslib_1.__assign({}, _this.options), options));
133
+ };
134
+ }
135
+ /**
136
+ * Creates a new instance of the DataViewLoader for particular backend and workspace.
137
+ *
138
+ * @alpha
139
+ */
140
+ DataViewLoader.for = function (backend, workspace) {
141
+ return new DataViewLoader(backend, workspace);
142
+ };
143
+ return DataViewLoader;
144
+ }());
145
+ exports.DataViewLoader = DataViewLoader;
146
+ //# sourceMappingURL=DataViewLoader.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DataViewLoader.js","sourceRoot":"","sources":["../../src/execution/DataViewLoader.tsx"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,sEAAqC;AAGrC,qDAAoD;AAEpD,gCAAyC;AAkBzC;;;;GAIG;AACH;IACI,wBACqB,OAA2B,EAC3B,SAAiB,EACjB,OAAoC;QAHzD,iBAII;QADiB,wBAAA,EAAA,YAAoC;QAFpC,YAAO,GAAP,OAAO,CAAoB;QAC3B,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAA6B;QAYzD;;;;;;;;WAQG;QACI,eAAU,GAAG;YAAC,sCAAsD;iBAAtD,UAAsD,EAAtD,qBAAsD,EAAtD,IAAsD;gBAAtD,iDAAsD;;YACvE,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,4BAA4B,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC;QAEF;;;;WAIG;QACI,eAAU,GAAG;YAAC,oBAA2B;iBAA3B,UAA2B,EAA3B,qBAA2B,EAA3B,IAA2B;gBAA3B,+BAA2B;;YAC5C,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAC/D,CAAC,CAAC;QAEF;;;;WAIG;QACI,aAAQ,GAAG;YAAC,iBAA6B;iBAA7B,UAA6B,EAA7B,qBAA6B,EAA7B,IAA6B;gBAA7B,4BAA6B;;YAC5C,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF;;;;WAIG;QACI,WAAM,GAAG;YAAC,eAAqB;iBAArB,UAAqB,EAArB,qBAAqB,EAArB,IAAqB;gBAArB,0BAAqB;;YAClC,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC;QAEF;;;;WAIG;QACI,eAAU,GAAG;YAAC,gBAAmB;iBAAnB,UAAmB,EAAnB,qBAAmB,EAAnB,IAAmB;gBAAnB,2BAAmB;;YACpC,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,QAAA,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF;;;;WAIG;QACI,eAAU,GAAG,UAAO,UAA0B;;;;4BAClC,qBAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAhC,MAAM,GAAG,SAAuB;wBACrB,qBAAM,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,EAAA;;wBAAtE,QAAQ,GAAG,SAA2D;wBAC5E,sBAAO,qBAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAC;;;aACvC,CAAC;QAEF;;;;WAIG;QACI,YAAO,GAAG;;;;4BACE,qBAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAhC,MAAM,GAAG,SAAuB;wBACrB,qBAAM,MAAM,CAAC,OAAO,EAAE,EAAA;;wBAAjC,QAAQ,GAAG,SAAsB;wBACvC,sBAAO,qBAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAC;;;aACvC,CAAC;QAEM,eAAU,GAAG;;;gBACjB,sBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,wDAAwD,CAAC,CAAC;gBAErF,SAAS,GAAG,iCAAe,oBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO,EACrB,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAC/B,aAAa,EAAE,gBAAgB,IAC5B,IAAI,CAAC,OAAO,EACjB,CAAC;gBAEH,sBAAO,SAAS,CAAC,OAAO,EAAE,EAAC;;aAC9B,CAAC;QAEM,yBAAoB,GAAG,UAAC,OAA+B;YAC3D,OAAO,IAAI,cAAc,CAAC,KAAI,CAAC,OAAO,EAAE,KAAI,CAAC,SAAS,wCAAO,KAAI,CAAC,OAAO,GAAK,OAAO,EAAG,CAAC;QAC7F,CAAC,CAAC;IAlGC,CAAC;IAEJ;;;;OAIG;IACW,kBAAG,GAAjB,UAAkB,OAA2B,EAAE,SAAiB;QAC5D,OAAO,IAAI,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAClD,CAAC;IA0FL,qBAAC;AAAD,CAAC,AAxGD,IAwGC;AAxGY,wCAAc"}
@@ -9,4 +9,5 @@ export { IExecutionConfiguration, IUseExecutionDataViewConfig, UseExecutionDataV
9
9
  export { IUseInsightDataViewConfig, UseInsightDataViewCallbacks, useInsightDataView, } from "./useInsightDataView";
10
10
  export { ExecuteInsight, IExecuteInsightProps } from "./ExecuteInsight";
11
11
  export { IExecuteErrorComponent, IExecuteErrorComponentProps, IExecuteLoadingComponent } from "./interfaces";
12
+ export { DataViewLoader } from "./DataViewLoader";
12
13
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EACH,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACH,yBAAyB,EACzB,2BAA2B,EAC3B,kBAAkB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EACH,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACH,yBAAyB,EACzB,2BAA2B,EAC3B,kBAAkB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7G,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  // (C) 2020-2022 GoodData Corporation
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.ExecuteInsight = exports.useInsightDataView = exports.useExecutionDataView = exports.useExecution = exports.useDataView = exports.useDataExport = exports.Execute = exports.RawExecute = exports.withExecutionLoading = exports.withExecution = void 0;
4
+ exports.DataViewLoader = exports.ExecuteInsight = exports.useInsightDataView = exports.useExecutionDataView = exports.useExecution = exports.useDataView = exports.useDataExport = exports.Execute = exports.RawExecute = exports.withExecutionLoading = exports.withExecution = void 0;
5
5
  var withExecution_1 = require("./withExecution");
6
6
  Object.defineProperty(exports, "withExecution", { enumerable: true, get: function () { return withExecution_1.withExecution; } });
7
7
  var withExecutionLoading_1 = require("./withExecutionLoading");
@@ -22,4 +22,6 @@ var useInsightDataView_1 = require("./useInsightDataView");
22
22
  Object.defineProperty(exports, "useInsightDataView", { enumerable: true, get: function () { return useInsightDataView_1.useInsightDataView; } });
23
23
  var ExecuteInsight_1 = require("./ExecuteInsight");
24
24
  Object.defineProperty(exports, "ExecuteInsight", { enumerable: true, get: function () { return ExecuteInsight_1.ExecuteInsight; } });
25
+ var DataViewLoader_1 = require("./DataViewLoader");
26
+ Object.defineProperty(exports, "DataViewLoader", { enumerable: true, get: function () { return DataViewLoader_1.DataViewLoader; } });
25
27
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":";AAAA,qCAAqC;;;AAErC,iDAAgE;AAAvD,8GAAA,aAAa,OAAA;AACtB,+DAMgC;AAL5B,4HAAA,oBAAoB,OAAA;AAMxB,2CAA4D;AAAnD,wGAAA,UAAU,OAAA;AACnB,qCAAmD;AAA1C,kGAAA,OAAO,OAAA;AAChB,iDAA4F;AAAnF,8GAAA,aAAa,OAAA;AACtB,6CAAoF;AAA3E,0GAAA,WAAW,OAAA;AACpB,+CAAmE;AAA1D,4GAAA,YAAY,OAAA;AACrB,+DAKgC;AAD5B,4HAAA,oBAAoB,OAAA;AAExB,2DAI8B;AAD1B,wHAAA,kBAAkB,OAAA;AAEtB,mDAAwE;AAA/D,gHAAA,cAAc,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":";AAAA,qCAAqC;;;AAErC,iDAAgE;AAAvD,8GAAA,aAAa,OAAA;AACtB,+DAMgC;AAL5B,4HAAA,oBAAoB,OAAA;AAMxB,2CAA4D;AAAnD,wGAAA,UAAU,OAAA;AACnB,qCAAmD;AAA1C,kGAAA,OAAO,OAAA;AAChB,iDAA4F;AAAnF,8GAAA,aAAa,OAAA;AACtB,6CAAoF;AAA3E,0GAAA,WAAW,OAAA;AACpB,+CAAmE;AAA1D,4GAAA,YAAY,OAAA;AACrB,+DAKgC;AAD5B,4HAAA,oBAAoB,OAAA;AAExB,2DAI8B;AAD1B,wHAAA,kBAAkB,OAAA;AAEtB,mDAAwE;AAA/D,gHAAA,cAAc,OAAA;AAEvB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA"}
package/dist/sdk-ui.d.ts CHANGED
@@ -25,6 +25,7 @@ import { IAnalyticalBackend } from '@gooddata/sdk-backend-spi';
25
25
  import { IAttribute } from '@gooddata/sdk-model';
26
26
  import { IAttributeDescriptor } from '@gooddata/sdk-model';
27
27
  import { IAttributeFilter } from '@gooddata/sdk-model';
28
+ import { IAttributeOrMeasure } from '@gooddata/sdk-model';
28
29
  import { IBucket } from '@gooddata/sdk-model';
29
30
  import { IColor } from '@gooddata/sdk-model';
30
31
  import { IColorPalette } from '@gooddata/sdk-model';
@@ -641,10 +642,6 @@ export declare class DataTooLargeToDisplaySdkError extends GoodDataSdkError {
641
642
  * The facade is part of the public API and we strongly recommend to use it whenever client code needs to work with
642
643
  * data view; ideally, single instance of data view facade
643
644
  *
644
- * Note: the facade is currently in alpha quality - mix-match of various functions we found useful so far; consolidation
645
- * and further enhancements will happen, the methods will be removed, renamed and added in the future. The public
646
- * API WILL break.
647
- *
648
645
  * @public
649
646
  */
650
647
  export declare class DataViewFacade {
@@ -712,6 +709,72 @@ export declare class DataViewFacade {
712
709
  rawData(): IResultDataMethods;
713
710
  }
714
711
 
712
+ /**
713
+ * DataViewLoader allows you to speficy, load and access data results with convenient series and slices API.
714
+ *
715
+ * @alpha
716
+ */
717
+ export declare class DataViewLoader {
718
+ private readonly backend;
719
+ private readonly workspace;
720
+ private readonly options;
721
+ private constructor();
722
+ /**
723
+ * Creates a new instance of the DataViewLoader for particular backend and workspace.
724
+ *
725
+ * @alpha
726
+ */
727
+ static for(backend: IAnalyticalBackend, workspace: string): DataViewLoader;
728
+ /**
729
+ * Data series will be built using the provided measures that are further scoped for
730
+ * elements of the specified attributes.
731
+ *
732
+ * @remarks
733
+ * You must define at least 1 measure for the series.
734
+ *
735
+ * @alpha
736
+ */
737
+ seriesFrom: (...measuresAndScopingAttributes: IAttributeOrMeasure[]) => DataViewLoader;
738
+ /**
739
+ * Slice all data series by elements of these attributes.
740
+ *
741
+ * @alpha
742
+ */
743
+ slicesFrom: (...attributes: IAttribute[]) => DataViewLoader;
744
+ /**
745
+ * Filters to apply on server side.
746
+ *
747
+ * @alpha
748
+ */
749
+ filterBy: (...filters: INullableFilter[]) => DataViewLoader;
750
+ /**
751
+ * Sorting to apply on server side.
752
+ *
753
+ * @alpha
754
+ */
755
+ sortBy: (...sorts: ISortItem[]) => DataViewLoader;
756
+ /**
757
+ * Include these totals among the data slices.
758
+ *
759
+ * @alpha
760
+ */
761
+ withTotals: (...totals: ITotal[]) => DataViewLoader;
762
+ /**
763
+ * Loads subset of the result data and wraps them in {@link DataViewFacade}.
764
+ *
765
+ * @alpha
766
+ */
767
+ loadWindow: (dataWindow: DataViewWindow) => Promise<DataViewFacade>;
768
+ /**
769
+ * Loads all the result data and wraps them in {@link DataViewFacade}.
770
+ *
771
+ * @alpha
772
+ */
773
+ loadAll: () => Promise<DataViewFacade>;
774
+ private loadResult;
775
+ private newLoaderWithOptions;
776
+ }
777
+
715
778
  /**
716
779
  * Structure specifying a particular portion of data.
717
780
  * @public
@@ -2019,7 +2082,7 @@ export declare interface IExecutionConfiguration {
2019
2082
  /**
2020
2083
  * Methods to work with execution definition.
2021
2084
  *
2022
- * @public
2085
+ * @internal
2023
2086
  */
2024
2087
  export declare interface IExecutionDefinitionMethods {
2025
2088
  /**
@@ -2476,7 +2539,7 @@ export declare interface IRawExecuteProps extends IWithLoadingEvents<IRawExecute
2476
2539
  /**
2477
2540
  * Methods to access data and totals in a result.
2478
2541
  *
2479
- * @public
2542
+ * @internal
2480
2543
  */
2481
2544
  export declare interface IResultDataMethods {
2482
2545
  /**
@@ -2531,7 +2594,7 @@ export declare interface IResultDataMethods {
2531
2594
  /**
2532
2595
  * Methods to access result metadata - dimension descriptors and result headers.
2533
2596
  *
2534
- * @public
2597
+ * @internal
2535
2598
  */
2536
2599
  export declare interface IResultMetaMethods {
2537
2600
  /**
@@ -18,10 +18,6 @@ import { IDataAccessMethods } from "./dataAccess";
18
18
  * The facade is part of the public API and we strongly recommend to use it whenever client code needs to work with
19
19
  * data view; ideally, single instance of data view facade
20
20
  *
21
- * Note: the facade is currently in alpha quality - mix-match of various functions we found useful so far; consolidation
22
- * and further enhancements will happen, the methods will be removed, renamed and added in the future. The public
23
- * API WILL break.
24
- *
25
21
  * @public
26
22
  */
27
23
  export declare class DataViewFacade {
@@ -1 +1 @@
1
- {"version":3,"file":"facade.d.ts","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,oBAAoB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAgC,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAc;aAce,QAAQ,EAAE,SAAS;IAbzD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAgF;IACtG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAG3B;IAEJ,SAAgB,UAAU,EAAE,oBAAoB,CAAC;IAEjD,OAAO,CAAC,iBAAiB,CAA0C;IACnE,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,SAAS,aAA6B,QAAQ,EAAE,SAAS;IAQzD;;;OAGG;WACW,GAAG,CAAC,QAAQ,EAAE,SAAS,GAAG,cAAc;IAQtD;;;;;;;;;;OAUG;WACW,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,cAAc;IASjE;;;OAGG;IACI,MAAM,IAAI,gBAAgB;IAIjC;;;OAGG;IACI,QAAQ,IAAI,cAAc,EAAE;IAInC;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAI5B;;;OAGG;IACI,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,kBAAkB;IAY1D;;;OAGG;IACI,GAAG,IAAI,2BAA2B;IAQzC;;;OAGG;IACI,IAAI,IAAI,kBAAkB;IAQjC;;;OAGG;IACI,OAAO,IAAI,kBAAkB;CAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAmB1E"}
1
+ {"version":3,"file":"facade.d.ts","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,oBAAoB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAgC,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,cAAc;aAce,QAAQ,EAAE,SAAS;IAbzD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAgF;IACtG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAG3B;IAEJ,SAAgB,UAAU,EAAE,oBAAoB,CAAC;IAEjD,OAAO,CAAC,iBAAiB,CAA0C;IACnE,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,SAAS,aAA6B,QAAQ,EAAE,SAAS;IAQzD;;;OAGG;WACW,GAAG,CAAC,QAAQ,EAAE,SAAS,GAAG,cAAc;IAQtD;;;;;;;;;;OAUG;WACW,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,cAAc;IASjE;;;OAGG;IACI,MAAM,IAAI,gBAAgB;IAIjC;;;OAGG;IACI,QAAQ,IAAI,cAAc,EAAE;IAInC;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAI5B;;;OAGG;IACI,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,kBAAkB;IAY1D;;;OAGG;IACI,GAAG,IAAI,2BAA2B;IAQzC;;;OAGG;IACI,IAAI,IAAI,kBAAkB;IAQjC;;;OAGG;IACI,OAAO,IAAI,kBAAkB;CAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAmB1E"}
@@ -17,10 +17,6 @@ import { newDataAccessMethods } from "./internal/dataAccessMethods";
17
17
  * The facade is part of the public API and we strongly recommend to use it whenever client code needs to work with
18
18
  * data view; ideally, single instance of data view facade
19
19
  *
20
- * Note: the facade is currently in alpha quality - mix-match of various functions we found useful so far; consolidation
21
- * and further enhancements will happen, the methods will be removed, renamed and added in the future. The public
22
- * API WILL break.
23
- *
24
20
  * @public
25
21
  */
26
22
  var DataViewFacade = /** @class */ (function () {
@@ -1 +1 @@
1
- {"version":3,"file":"facade.js","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AAAA,qCAAqC;AACrC,OAAO,EAAE,cAAc,EAAwC,MAAM,qBAAqB,CAAC;AAG3F,OAAO,EAA+B,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAsB,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAsB,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAExF,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAcI,wBAAsC,QAAmB;QAAnB,aAAQ,GAAR,QAAQ,CAAW;QACrD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,EAAE;IACF,cAAc;IACd,EAAE;IAEF;;;OAGG;IACW,kBAAG,GAAjB,UAAkB,QAAmB;QACjC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACvC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtE;QAED,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;;;OAUG;IACW,wBAAS,GAAvB,UAAwB,MAAwB;QAC5C,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC9C,IAAM,SAAS,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;YACjD,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;SAC9E;QAED,OAAO,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,+BAAM,GAAb;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,iCAAQ,GAAf;;QACI,aAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,mCAAI,EAAE,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,oCAAW,GAAlB;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX,UAAY,MAAyB;QACjC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED,EAAE;IACF,EAAE;IACF,EAAE;IAEF;;;OAGG;IACI,4BAAG,GAAV;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,4BAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,gCAAO,GAAd;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAhIc,sBAAO,GAAuC,IAAI,OAAO,EAA6B,CAAC;IACvF,+BAAgB,GAA8C,IAAI,OAAO,EAGrF,CAAC;IA6HR,qBAAC;CAAA,AAlID,IAkIC;SAlIY,cAAc;AAoI3B;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAAwB;IACnD,IAAA,UAAU,GAAK,MAAM,WAAX,CAAY;IAC9B,IAAM,EAAE,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;IAErD,OAAO;QACH,UAAU,YAAA;QACV,MAAM,QAAA;QACN,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACd,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACb,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAClB,WAAW,EAAX;YACI,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,EAAN,UAAO,KAAgB;YACnB,OAAO,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;KACJ,CAAC;AACN,CAAC"}
1
+ {"version":3,"file":"facade.js","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AAAA,qCAAqC;AACrC,OAAO,EAAE,cAAc,EAAwC,MAAM,qBAAqB,CAAC;AAG3F,OAAO,EAA+B,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAsB,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAsB,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAExF,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH;IAcI,wBAAsC,QAAmB;QAAnB,aAAQ,GAAR,QAAQ,CAAW;QACrD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,EAAE;IACF,cAAc;IACd,EAAE;IAEF;;;OAGG;IACW,kBAAG,GAAjB,UAAkB,QAAmB;QACjC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACvC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtE;QAED,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;;;OAUG;IACW,wBAAS,GAAvB,UAAwB,MAAwB;QAC5C,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC9C,IAAM,SAAS,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;YACjD,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;SAC9E;QAED,OAAO,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,+BAAM,GAAb;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,iCAAQ,GAAf;;QACI,aAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,mCAAI,EAAE,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,oCAAW,GAAlB;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX,UAAY,MAAyB;QACjC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED,EAAE;IACF,EAAE;IACF,EAAE;IAEF;;;OAGG;IACI,4BAAG,GAAV;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,4BAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,gCAAO,GAAd;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAhIc,sBAAO,GAAuC,IAAI,OAAO,EAA6B,CAAC;IACvF,+BAAgB,GAA8C,IAAI,OAAO,EAGrF,CAAC;IA6HR,qBAAC;CAAA,AAlID,IAkIC;SAlIY,cAAc;AAoI3B;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAAwB;IACnD,IAAA,UAAU,GAAK,MAAM,WAAX,CAAY;IAC9B,IAAM,EAAE,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;IAErD,OAAO;QACH,UAAU,YAAA;QACV,MAAM,QAAA;QACN,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACd,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACb,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAClB,WAAW,EAAX;YACI,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,EAAN,UAAO,KAAgB;YACnB,OAAO,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;KACJ,CAAC;AACN,CAAC"}
@@ -2,7 +2,7 @@ import { IAttribute, IBucket, IExecutionDefinition, IMeasure } from "@gooddata/s
2
2
  /**
3
3
  * Methods to work with execution definition.
4
4
  *
5
- * @public
5
+ * @internal
6
6
  */
7
7
  export interface IExecutionDefinitionMethods {
8
8
  /**
@@ -3,7 +3,7 @@ import { DataValue } from "@gooddata/sdk-model";
3
3
  /**
4
4
  * Methods to access data and totals in a result.
5
5
  *
6
- * @public
6
+ * @internal
7
7
  */
8
8
  export interface IResultDataMethods {
9
9
  /**
@@ -3,7 +3,7 @@ import { ISortItem, IMeasureDescriptor, IDimensionItemDescriptor, IDimensionDesc
3
3
  /**
4
4
  * Methods to access result metadata - dimension descriptors and result headers.
5
5
  *
6
- * @public
6
+ * @internal
7
7
  */
8
8
  export interface IResultMetaMethods {
9
9
  /**
@@ -0,0 +1,70 @@
1
+ import { IAttribute, IAttributeOrMeasure, INullableFilter, ISortItem, ITotal } from "@gooddata/sdk-model";
2
+ import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
3
+ import { DataViewWindow } from "./withExecutionLoading";
4
+ import { DataViewFacade } from "../base";
5
+ /**
6
+ * DataViewLoader allows you to speficy, load and access data results with convenient series and slices API.
7
+ *
8
+ * @alpha
9
+ */
10
+ export declare class DataViewLoader {
11
+ private readonly backend;
12
+ private readonly workspace;
13
+ private readonly options;
14
+ private constructor();
15
+ /**
16
+ * Creates a new instance of the DataViewLoader for particular backend and workspace.
17
+ *
18
+ * @alpha
19
+ */
20
+ static for(backend: IAnalyticalBackend, workspace: string): DataViewLoader;
21
+ /**
22
+ * Data series will be built using the provided measures that are further scoped for
23
+ * elements of the specified attributes.
24
+ *
25
+ * @remarks
26
+ * You must define at least 1 measure for the series.
27
+ *
28
+ * @alpha
29
+ */
30
+ seriesFrom: (...measuresAndScopingAttributes: IAttributeOrMeasure[]) => DataViewLoader;
31
+ /**
32
+ * Slice all data series by elements of these attributes.
33
+ *
34
+ * @alpha
35
+ */
36
+ slicesFrom: (...attributes: IAttribute[]) => DataViewLoader;
37
+ /**
38
+ * Filters to apply on server side.
39
+ *
40
+ * @alpha
41
+ */
42
+ filterBy: (...filters: INullableFilter[]) => DataViewLoader;
43
+ /**
44
+ * Sorting to apply on server side.
45
+ *
46
+ * @alpha
47
+ */
48
+ sortBy: (...sorts: ISortItem[]) => DataViewLoader;
49
+ /**
50
+ * Include these totals among the data slices.
51
+ *
52
+ * @alpha
53
+ */
54
+ withTotals: (...totals: ITotal[]) => DataViewLoader;
55
+ /**
56
+ * Loads subset of the result data and wraps them in {@link DataViewFacade}.
57
+ *
58
+ * @alpha
59
+ */
60
+ loadWindow: (dataWindow: DataViewWindow) => Promise<DataViewFacade>;
61
+ /**
62
+ * Loads all the result data and wraps them in {@link DataViewFacade}.
63
+ *
64
+ * @alpha
65
+ */
66
+ loadAll: () => Promise<DataViewFacade>;
67
+ private loadResult;
68
+ private newLoaderWithOptions;
69
+ }
70
+ //# sourceMappingURL=DataViewLoader.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DataViewLoader.d.ts","sourceRoot":"","sources":["../../src/execution/DataViewLoader.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EAAE,kBAAkB,EAAoB,MAAM,2BAA2B,CAAC;AAEjF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAkBzC;;;;GAIG;AACH,qBAAa,cAAc;IAEnB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAH5B,OAAO;IAMP;;;;OAIG;WACW,GAAG,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,GAAG,cAAc;IAIjF;;;;;;;;OAQG;IACI,UAAU,oCAAqC,mBAAmB,EAAE,KAAG,cAAc,CAE1F;IAEF;;;;OAIG;IACI,UAAU,kBAAmB,UAAU,EAAE,KAAG,cAAc,CAE/D;IAEF;;;;OAIG;IACI,QAAQ,eAAgB,eAAe,EAAE,KAAG,cAAc,CAE/D;IAEF;;;;OAIG;IACI,MAAM,aAAc,SAAS,EAAE,KAAG,cAAc,CAErD;IAEF;;;;OAIG;IACI,UAAU,cAAe,MAAM,EAAE,KAAG,cAAc,CAEvD;IAEF;;;;OAIG;IACI,UAAU,eAAsB,cAAc,KAAG,QAAQ,cAAc,CAAC,CAI7E;IAEF;;;;OAIG;IACI,OAAO,QAAa,QAAQ,cAAc,CAAC,CAIhD;IAEF,OAAO,CAAC,UAAU,CAYhB;IAEF,OAAO,CAAC,oBAAoB,CAE1B;CACL"}
@@ -0,0 +1,143 @@
1
+ import { __assign, __awaiter, __generator } from "tslib";
2
+ // (C) 2019-2022 GoodData Corporation
3
+ import invariant from "ts-invariant";
4
+ import { createExecution } from "./createExecution";
5
+ import { DataViewFacade } from "../base";
6
+ /**
7
+ * DataViewLoader allows you to speficy, load and access data results with convenient series and slices API.
8
+ *
9
+ * @alpha
10
+ */
11
+ var DataViewLoader = /** @class */ (function () {
12
+ function DataViewLoader(backend, workspace, options) {
13
+ var _this = this;
14
+ if (options === void 0) { options = {}; }
15
+ this.backend = backend;
16
+ this.workspace = workspace;
17
+ this.options = options;
18
+ /**
19
+ * Data series will be built using the provided measures that are further scoped for
20
+ * elements of the specified attributes.
21
+ *
22
+ * @remarks
23
+ * You must define at least 1 measure for the series.
24
+ *
25
+ * @alpha
26
+ */
27
+ this.seriesFrom = function () {
28
+ var measuresAndScopingAttributes = [];
29
+ for (var _i = 0; _i < arguments.length; _i++) {
30
+ measuresAndScopingAttributes[_i] = arguments[_i];
31
+ }
32
+ return _this.newLoaderWithOptions({ seriesBy: measuresAndScopingAttributes });
33
+ };
34
+ /**
35
+ * Slice all data series by elements of these attributes.
36
+ *
37
+ * @alpha
38
+ */
39
+ this.slicesFrom = function () {
40
+ var attributes = [];
41
+ for (var _i = 0; _i < arguments.length; _i++) {
42
+ attributes[_i] = arguments[_i];
43
+ }
44
+ return _this.newLoaderWithOptions({ slicesBy: attributes });
45
+ };
46
+ /**
47
+ * Filters to apply on server side.
48
+ *
49
+ * @alpha
50
+ */
51
+ this.filterBy = function () {
52
+ var filters = [];
53
+ for (var _i = 0; _i < arguments.length; _i++) {
54
+ filters[_i] = arguments[_i];
55
+ }
56
+ return _this.newLoaderWithOptions({ filters: filters });
57
+ };
58
+ /**
59
+ * Sorting to apply on server side.
60
+ *
61
+ * @alpha
62
+ */
63
+ this.sortBy = function () {
64
+ var sorts = [];
65
+ for (var _i = 0; _i < arguments.length; _i++) {
66
+ sorts[_i] = arguments[_i];
67
+ }
68
+ return _this.newLoaderWithOptions({ sortBy: sorts });
69
+ };
70
+ /**
71
+ * Include these totals among the data slices.
72
+ *
73
+ * @alpha
74
+ */
75
+ this.withTotals = function () {
76
+ var totals = [];
77
+ for (var _i = 0; _i < arguments.length; _i++) {
78
+ totals[_i] = arguments[_i];
79
+ }
80
+ return _this.newLoaderWithOptions({ totals: totals });
81
+ };
82
+ /**
83
+ * Loads subset of the result data and wraps them in {@link DataViewFacade}.
84
+ *
85
+ * @alpha
86
+ */
87
+ this.loadWindow = function (dataWindow) { return __awaiter(_this, void 0, void 0, function () {
88
+ var result, dataView;
89
+ return __generator(this, function (_a) {
90
+ switch (_a.label) {
91
+ case 0: return [4 /*yield*/, this.loadResult()];
92
+ case 1:
93
+ result = _a.sent();
94
+ return [4 /*yield*/, result.readWindow(dataWindow.offset, dataWindow.size)];
95
+ case 2:
96
+ dataView = _a.sent();
97
+ return [2 /*return*/, DataViewFacade.for(dataView)];
98
+ }
99
+ });
100
+ }); };
101
+ /**
102
+ * Loads all the result data and wraps them in {@link DataViewFacade}.
103
+ *
104
+ * @alpha
105
+ */
106
+ this.loadAll = function () { return __awaiter(_this, void 0, void 0, function () {
107
+ var result, dataView;
108
+ return __generator(this, function (_a) {
109
+ switch (_a.label) {
110
+ case 0: return [4 /*yield*/, this.loadResult()];
111
+ case 1:
112
+ result = _a.sent();
113
+ return [4 /*yield*/, result.readAll()];
114
+ case 2:
115
+ dataView = _a.sent();
116
+ return [2 /*return*/, DataViewFacade.for(dataView)];
117
+ }
118
+ });
119
+ }); };
120
+ this.loadResult = function () { return __awaiter(_this, void 0, void 0, function () {
121
+ var execution;
122
+ return __generator(this, function (_a) {
123
+ invariant(this.options.seriesBy, "You need to specify series before loading the results.");
124
+ execution = createExecution(__assign({ backend: this.backend, workspace: this.workspace, seriesBy: this.options.seriesBy, componentName: "DataViewLoader" }, this.options));
125
+ return [2 /*return*/, execution.execute()];
126
+ });
127
+ }); };
128
+ this.newLoaderWithOptions = function (options) {
129
+ return new DataViewLoader(_this.backend, _this.workspace, __assign(__assign({}, _this.options), options));
130
+ };
131
+ }
132
+ /**
133
+ * Creates a new instance of the DataViewLoader for particular backend and workspace.
134
+ *
135
+ * @alpha
136
+ */
137
+ DataViewLoader.for = function (backend, workspace) {
138
+ return new DataViewLoader(backend, workspace);
139
+ };
140
+ return DataViewLoader;
141
+ }());
142
+ export { DataViewLoader };
143
+ //# sourceMappingURL=DataViewLoader.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DataViewLoader.js","sourceRoot":"","sources":["../../src/execution/DataViewLoader.tsx"],"names":[],"mappings":";AAAA,qCAAqC;AACrC,OAAO,SAAS,MAAM,cAAc,CAAC;AAGrC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAkBzC;;;;GAIG;AACH;IACI,wBACqB,OAA2B,EAC3B,SAAiB,EACjB,OAAoC;QAHzD,iBAII;QADiB,wBAAA,EAAA,YAAoC;QAFpC,YAAO,GAAP,OAAO,CAAoB;QAC3B,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAA6B;QAYzD;;;;;;;;WAQG;QACI,eAAU,GAAG;YAAC,sCAAsD;iBAAtD,UAAsD,EAAtD,qBAAsD,EAAtD,IAAsD;gBAAtD,iDAAsD;;YACvE,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,4BAA4B,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC;QAEF;;;;WAIG;QACI,eAAU,GAAG;YAAC,oBAA2B;iBAA3B,UAA2B,EAA3B,qBAA2B,EAA3B,IAA2B;gBAA3B,+BAA2B;;YAC5C,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAC/D,CAAC,CAAC;QAEF;;;;WAIG;QACI,aAAQ,GAAG;YAAC,iBAA6B;iBAA7B,UAA6B,EAA7B,qBAA6B,EAA7B,IAA6B;gBAA7B,4BAA6B;;YAC5C,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF;;;;WAIG;QACI,WAAM,GAAG;YAAC,eAAqB;iBAArB,UAAqB,EAArB,qBAAqB,EAArB,IAAqB;gBAArB,0BAAqB;;YAClC,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC;QAEF;;;;WAIG;QACI,eAAU,GAAG;YAAC,gBAAmB;iBAAnB,UAAmB,EAAnB,qBAAmB,EAAnB,IAAmB;gBAAnB,2BAAmB;;YACpC,OAAO,KAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,QAAA,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF;;;;WAIG;QACI,eAAU,GAAG,UAAO,UAA0B;;;;4BAClC,qBAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAhC,MAAM,GAAG,SAAuB;wBACrB,qBAAM,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,EAAA;;wBAAtE,QAAQ,GAAG,SAA2D;wBAC5E,sBAAO,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAC;;;aACvC,CAAC;QAEF;;;;WAIG;QACI,YAAO,GAAG;;;;4BACE,qBAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAhC,MAAM,GAAG,SAAuB;wBACrB,qBAAM,MAAM,CAAC,OAAO,EAAE,EAAA;;wBAAjC,QAAQ,GAAG,SAAsB;wBACvC,sBAAO,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAC;;;aACvC,CAAC;QAEM,eAAU,GAAG;;;gBACjB,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,wDAAwD,CAAC,CAAC;gBAErF,SAAS,GAAG,eAAe,YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO,EACrB,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAC/B,aAAa,EAAE,gBAAgB,IAC5B,IAAI,CAAC,OAAO,EACjB,CAAC;gBAEH,sBAAO,SAAS,CAAC,OAAO,EAAE,EAAC;;aAC9B,CAAC;QAEM,yBAAoB,GAAG,UAAC,OAA+B;YAC3D,OAAO,IAAI,cAAc,CAAC,KAAI,CAAC,OAAO,EAAE,KAAI,CAAC,SAAS,wBAAO,KAAI,CAAC,OAAO,GAAK,OAAO,EAAG,CAAC;QAC7F,CAAC,CAAC;IAlGC,CAAC;IAEJ;;;;OAIG;IACW,kBAAG,GAAjB,UAAkB,OAA2B,EAAE,SAAiB;QAC5D,OAAO,IAAI,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAClD,CAAC;IA0FL,qBAAC;AAAD,CAAC,AAxGD,IAwGC"}
@@ -9,4 +9,5 @@ export { IExecutionConfiguration, IUseExecutionDataViewConfig, UseExecutionDataV
9
9
  export { IUseInsightDataViewConfig, UseInsightDataViewCallbacks, useInsightDataView, } from "./useInsightDataView";
10
10
  export { ExecuteInsight, IExecuteInsightProps } from "./ExecuteInsight";
11
11
  export { IExecuteErrorComponent, IExecuteErrorComponentProps, IExecuteLoadingComponent } from "./interfaces";
12
+ export { DataViewLoader } from "./DataViewLoader";
12
13
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EACH,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACH,yBAAyB,EACzB,2BAA2B,EAC3B,kBAAkB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EACH,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACH,yBAAyB,EACzB,2BAA2B,EAC3B,kBAAkB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7G,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
@@ -9,4 +9,5 @@ export { useExecution } from "./useExecution";
9
9
  export { useExecutionDataView, } from "./useExecutionDataView";
10
10
  export { useInsightDataView, } from "./useInsightDataView";
11
11
  export { ExecuteInsight } from "./ExecuteInsight";
12
+ export { DataViewLoader } from "./DataViewLoader";
12
13
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAErC,OAAO,EAAE,aAAa,EAAkB,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,GAKvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAoB,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAiB,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAA8C,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAA0C,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAuB,MAAM,gBAAgB,CAAC;AACnE,OAAO,EAIH,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGH,kBAAkB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAwB,MAAM,kBAAkB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAErC,OAAO,EAAE,aAAa,EAAkB,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,GAKvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAoB,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAiB,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAA8C,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAA0C,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAuB,MAAM,gBAAgB,CAAC;AACnE,OAAO,EAIH,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGH,kBAAkB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAwB,MAAM,kBAAkB,CAAC;AAExE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-ui",
3
- "version": "8.10.0-alpha.75",
3
+ "version": "8.10.0-alpha.76",
4
4
  "description": "GoodData.UI SDK - Core",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,7 +14,10 @@
14
14
  "es2015": "esm/index.js",
15
15
  "browser": "dist/index.js",
16
16
  "typings": "esm/index.d.ts",
17
- "sideEffects": false,
17
+ "sideEffects": [
18
+ "*.css",
19
+ "*.svg"
20
+ ],
18
21
  "files": [
19
22
  "dist/**/*.js",
20
23
  "dist/**/*.json",
@@ -34,9 +37,9 @@
34
37
  "dependencies": {
35
38
  "@formatjs/intl-pluralrules": "~1.3.7",
36
39
  "@gooddata/numberjs": "^4.0.1",
37
- "@gooddata/sdk-backend-spi": "^8.10.0-alpha.75",
38
- "@gooddata/sdk-model": "^8.10.0-alpha.75",
39
- "@gooddata/util": "^8.10.0-alpha.75",
40
+ "@gooddata/sdk-backend-spi": "^8.10.0-alpha.76",
41
+ "@gooddata/sdk-model": "^8.10.0-alpha.76",
42
+ "@gooddata/util": "^8.10.0-alpha.76",
40
43
  "custom-event": "^1.0.1",
41
44
  "hoist-non-react-statics": "^3.3.0",
42
45
  "http-status-codes": "^2.1.4",
@@ -54,9 +57,9 @@
54
57
  },
55
58
  "devDependencies": {
56
59
  "@gooddata/eslint-config": "^2.1.0",
57
- "@gooddata/reference-workspace": "^8.10.0-alpha.75",
58
- "@gooddata/sdk-backend-base": "^8.10.0-alpha.75",
59
- "@gooddata/sdk-backend-mockingbird": "^8.10.0-alpha.75",
60
+ "@gooddata/reference-workspace": "^8.10.0-alpha.76",
61
+ "@gooddata/sdk-backend-base": "^8.10.0-alpha.76",
62
+ "@gooddata/sdk-backend-mockingbird": "^8.10.0-alpha.76",
60
63
  "@gooddata/stylelint-config": "^5.0.0",
61
64
  "@microsoft/api-documenter": "^7.17.0",
62
65
  "@microsoft/api-extractor": "^7.20.0",