@gooddata/sdk-ui 8.10.0-alpha.32 → 8.10.0-alpha.35

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 (64) hide show
  1. package/dist/base/react/useCancelablePromise.d.ts +15 -11
  2. package/dist/base/react/useCancelablePromise.d.ts.map +1 -1
  3. package/dist/base/react/useCancelablePromise.js +6 -2
  4. package/dist/base/react/useCancelablePromise.js.map +1 -1
  5. package/dist/base/react/useCancelablePromiseUtils.d.ts +2 -2
  6. package/dist/base/react/useCancelablePromiseUtils.js +2 -2
  7. package/dist/base/results/internal/definitionMethods.d.ts +1 -1
  8. package/dist/base/results/internal/definitionMethods.js +1 -1
  9. package/dist/base/results/internal/resultDataMethods.d.ts +1 -1
  10. package/dist/base/results/internal/resultMetaMethods.d.ts +1 -1
  11. package/dist/base/results/internal/resultMetaMethods.js +1 -1
  12. package/dist/execution/ExecuteInsight.d.ts +19 -2
  13. package/dist/execution/ExecuteInsight.d.ts.map +1 -1
  14. package/dist/execution/ExecuteInsight.js +6 -4
  15. package/dist/execution/ExecuteInsight.js.map +1 -1
  16. package/dist/execution/useDataExport.d.ts +3 -3
  17. package/dist/execution/useDataExport.js +1 -1
  18. package/dist/execution/useDataView.d.ts +3 -0
  19. package/dist/execution/useDataView.d.ts.map +1 -1
  20. package/dist/execution/useDataView.js +1 -0
  21. package/dist/execution/useDataView.js.map +1 -1
  22. package/dist/execution/useExecution.d.ts +2 -0
  23. package/dist/execution/useExecution.d.ts.map +1 -1
  24. package/dist/execution/useExecution.js +1 -0
  25. package/dist/execution/useExecution.js.map +1 -1
  26. package/dist/execution/useExecutionDataView.d.ts +3 -3
  27. package/dist/execution/useExecutionDataView.js +1 -1
  28. package/dist/execution/useInsightDataView.d.ts +19 -2
  29. package/dist/execution/useInsightDataView.d.ts.map +1 -1
  30. package/dist/execution/useInsightDataView.js +5 -4
  31. package/dist/execution/useInsightDataView.js.map +1 -1
  32. package/dist/sdk-ui.d.ts +69 -26
  33. package/esm/base/react/useCancelablePromise.d.ts +15 -11
  34. package/esm/base/react/useCancelablePromise.d.ts.map +1 -1
  35. package/esm/base/react/useCancelablePromise.js +6 -2
  36. package/esm/base/react/useCancelablePromise.js.map +1 -1
  37. package/esm/base/react/useCancelablePromiseUtils.d.ts +2 -2
  38. package/esm/base/react/useCancelablePromiseUtils.js +2 -2
  39. package/esm/base/results/internal/definitionMethods.d.ts +1 -1
  40. package/esm/base/results/internal/definitionMethods.js +1 -1
  41. package/esm/base/results/internal/resultDataMethods.d.ts +1 -1
  42. package/esm/base/results/internal/resultMetaMethods.d.ts +1 -1
  43. package/esm/base/results/internal/resultMetaMethods.js +1 -1
  44. package/esm/execution/ExecuteInsight.d.ts +19 -2
  45. package/esm/execution/ExecuteInsight.d.ts.map +1 -1
  46. package/esm/execution/ExecuteInsight.js +6 -4
  47. package/esm/execution/ExecuteInsight.js.map +1 -1
  48. package/esm/execution/useDataExport.d.ts +3 -3
  49. package/esm/execution/useDataExport.js +1 -1
  50. package/esm/execution/useDataView.d.ts +3 -0
  51. package/esm/execution/useDataView.d.ts.map +1 -1
  52. package/esm/execution/useDataView.js +1 -0
  53. package/esm/execution/useDataView.js.map +1 -1
  54. package/esm/execution/useExecution.d.ts +2 -0
  55. package/esm/execution/useExecution.d.ts.map +1 -1
  56. package/esm/execution/useExecution.js +1 -0
  57. package/esm/execution/useExecution.js.map +1 -1
  58. package/esm/execution/useExecutionDataView.d.ts +3 -3
  59. package/esm/execution/useExecutionDataView.js +1 -1
  60. package/esm/execution/useInsightDataView.d.ts +19 -2
  61. package/esm/execution/useInsightDataView.d.ts.map +1 -1
  62. package/esm/execution/useInsightDataView.js +5 -4
  63. package/esm/execution/useInsightDataView.js.map +1 -1
  64. package/package.json +7 -7
@@ -3,12 +3,12 @@ import { IExportConfig, IPreparedExecution } from "@gooddata/sdk-backend-spi";
3
3
  import { GoodDataSdkError, UseCancelablePromiseCallbacks, UseCancelablePromiseState } from "../base";
4
4
  /**
5
5
  * Indicates current state of useDataExport hook
6
- * @beta
6
+ * @public
7
7
  */
8
8
  export declare type UseDataExportState = UseCancelablePromiseState<string, GoodDataSdkError>;
9
9
  /**
10
10
  * Callbacks for useDataExport hook
11
- * @beta
11
+ * @public
12
12
  */
13
13
  export declare type UseDataExportCallbacks = UseCancelablePromiseCallbacks<string, GoodDataSdkError>;
14
14
  /**
@@ -18,7 +18,7 @@ export declare type UseDataExportCallbacks = UseCancelablePromiseCallbacks<strin
18
18
  * As a result, you will receive a string with uri, so you can easily create a download link.
19
19
  * Be aware that execution is re-executed only on dependency list change, not on execution/exportConfig/callbacks change.
20
20
  *
21
- * @beta
21
+ * @public
22
22
  */
23
23
  export declare function useDataExport({ execution, exportConfig, onCancel, onError, onLoading, onPending, onSuccess, }: {
24
24
  execution: IPreparedExecution | undefined | null;
@@ -6,7 +6,7 @@ import { convertError, useCancelablePromise, } from "../base";
6
6
  * As a result, you will receive a string with uri, so you can easily create a download link.
7
7
  * Be aware that execution is re-executed only on dependency list change, not on execution/exportConfig/callbacks change.
8
8
  *
9
- * @beta
9
+ * @public
10
10
  */
11
11
  export function useDataExport(_a, deps) {
12
12
  var execution = _a.execution, _b = _a.exportConfig, exportConfig = _b === void 0 ? {} : _b, onCancel = _a.onCancel, onError = _a.onError, onLoading = _a.onLoading, onPending = _a.onPending, onSuccess = _a.onSuccess;
@@ -4,11 +4,13 @@ import { DataViewWindow } from "./withExecutionLoading";
4
4
  import { DataViewFacade, GoodDataSdkError, UseCancelablePromiseCallbacks, UseCancelablePromiseState } from "../base";
5
5
  /**
6
6
  * Indicates current state of useDataView hook
7
+ * @deprecated use {@link useExecutionDataView} instead
7
8
  * @beta
8
9
  */
9
10
  export declare type UseDataViewState = UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
10
11
  /**
11
12
  * Callbacks for useDataView hook
13
+ * @deprecated use {@link useExecutionDataView} instead
12
14
  * @beta
13
15
  */
14
16
  export declare type UseDataViewCallbacks = UseCancelablePromiseCallbacks<DataViewFacade, GoodDataSdkError>;
@@ -19,6 +21,7 @@ export declare type UseDataViewCallbacks = UseCancelablePromiseCallbacks<DataVie
19
21
  * You can use it to create custom visualizations on top of GoodData platform.
20
22
  * Be aware that execution is re-executed only on dependency list change, not on execution/window/callbacks change.
21
23
  *
24
+ * @deprecated use {@link useExecutionDataView} instead
22
25
  * @beta
23
26
  */
24
27
  export declare function useDataView({ execution, window, onCancel, onError, onLoading, onPending, onSuccess, }: {
@@ -1 +1 @@
1
- {"version":3,"file":"useDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAEH,cAAc,EACd,gBAAgB,EAEhB,6BAA6B,EAC7B,yBAAyB,EAC5B,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAE3F;;;GAGG;AACH,oBAAY,oBAAoB,GAAG,6BAA6B,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAEnG;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACvB,EACI,SAAS,EACT,MAAM,EACN,QAAQ,EACR,OAAO,EACP,SAAS,EACT,SAAS,EACT,SAAS,GACZ,EAAE;IACC,SAAS,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAAC;IACjD,MAAM,CAAC,EAAE,cAAc,CAAC;CAC3B,GAAG,oBAAoB,EACxB,IAAI,CAAC,EAAE,cAAc,GACtB,gBAAgB,CA2BlB"}
1
+ {"version":3,"file":"useDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAEH,cAAc,EACd,gBAAgB,EAEhB,6BAA6B,EAC7B,yBAAyB,EAC5B,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,oBAAY,gBAAgB,GAAG,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,oBAAY,oBAAoB,GAAG,6BAA6B,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAEnG;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CACvB,EACI,SAAS,EACT,MAAM,EACN,QAAQ,EACR,OAAO,EACP,SAAS,EACT,SAAS,EACT,SAAS,GACZ,EAAE;IACC,SAAS,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAAC;IACjD,MAAM,CAAC,EAAE,cAAc,CAAC;CAC3B,GAAG,oBAAoB,EACxB,IAAI,CAAC,EAAE,cAAc,GACtB,gBAAgB,CA2BlB"}
@@ -6,6 +6,7 @@ import { convertError, DataViewFacade, useCancelablePromise, } from "../base";
6
6
  * You can use it to create custom visualizations on top of GoodData platform.
7
7
  * Be aware that execution is re-executed only on dependency list change, not on execution/window/callbacks change.
8
8
  *
9
+ * @deprecated use {@link useExecutionDataView} instead
9
10
  * @beta
10
11
  */
11
12
  export function useDataView(_a, deps) {
@@ -1 +1 @@
1
- {"version":3,"file":"useDataView.js","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,YAAY,EACZ,cAAc,EAEd,oBAAoB,GAGvB,MAAM,SAAS,CAAC;AAcjB;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CACvB,EAWwB,EACxB,IAAqB;QAXjB,SAAS,eAAA,EACT,MAAM,YAAA,EACN,QAAQ,cAAA,EACR,OAAO,aAAA,EACP,SAAS,eAAA,EACT,SAAS,eAAA,EACT,SAAS,eAAA;IAOb,OAAO,oBAAoB,CACvB;QACI,OAAO,EAAE,SAAS;YACd,CAAC,CAAC;gBACI,OAAA,SAAS;qBACJ,OAAO,EAAE;qBACT,IAAI,CAAC,UAAC,eAAe;oBAClB,OAAA,MAAM;wBACF,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;wBACxD,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE;gBAF/B,CAE+B,CAClC;qBACA,IAAI,CAAC,UAAC,QAAQ;oBACX,OAAO,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC,CAAC;YAZN,CAYM;YACZ,CAAC,CAAC,IAAI;QACV,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,SAAS,WAAA;QACT,SAAS,WAAA;QACT,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;AACN,CAAC"}
1
+ {"version":3,"file":"useDataView.js","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,YAAY,EACZ,cAAc,EAEd,oBAAoB,GAGvB,MAAM,SAAS,CAAC;AAgBjB;;;;;;;;;GASG;AACH,MAAM,UAAU,WAAW,CACvB,EAWwB,EACxB,IAAqB;QAXjB,SAAS,eAAA,EACT,MAAM,YAAA,EACN,QAAQ,cAAA,EACR,OAAO,aAAA,EACP,SAAS,eAAA,EACT,SAAS,eAAA,EACT,SAAS,eAAA;IAOb,OAAO,oBAAoB,CACvB;QACI,OAAO,EAAE,SAAS;YACd,CAAC,CAAC;gBACI,OAAA,SAAS;qBACJ,OAAO,EAAE;qBACT,IAAI,CAAC,UAAC,eAAe;oBAClB,OAAA,MAAM;wBACF,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;wBACxD,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE;gBAF/B,CAE+B,CAClC;qBACA,IAAI,CAAC,UAAC,QAAQ;oBACX,OAAO,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC,CAAC;YAZN,CAYM;YACZ,CAAC,CAAC,IAAI;QACV,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,SAAS,WAAA;QACT,SAAS,WAAA;QACT,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;AACN,CAAC"}
@@ -1,6 +1,7 @@
1
1
  import { IAnalyticalBackend, IPreparedExecution } from "@gooddata/sdk-backend-spi";
2
2
  import { AttributesMeasuresOrPlaceholders, AttributesOrPlaceholders, TotalsOrPlaceholders, NullableFiltersOrPlaceholders, SortsOrPlaceholders } from "../base";
3
3
  /**
4
+ * @deprecated use {@link useExecutionDataView} instead
4
5
  * @beta
5
6
  */
6
7
  export interface IUseExecutionConfig {
@@ -62,6 +63,7 @@ export interface IUseExecutionConfig {
62
63
  * @remarks
63
64
  * It builds the execution on top of the backend passed to the BackendProvider, and workspace passed to the WorkspaceProvider.
64
65
  *
66
+ * @deprecated use {@link useExecutionDataView} instead
65
67
  * @beta
66
68
  */
67
69
  export declare function useExecution(config: IUseExecutionConfig): IPreparedExecution;
@@ -1 +1 @@
1
- {"version":3,"file":"useExecution.d.ts","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAIH,gCAAgC,EAChC,wBAAwB,EACxB,oBAAoB,EACpB,6BAA6B,EAC7B,mBAAmB,EACtB,MAAM,SAAS,CAAC;AAGjB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,kBAAkB,CAkB5E"}
1
+ {"version":3,"file":"useExecution.d.ts","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAIH,gCAAgC,EAChC,wBAAwB,EACxB,oBAAoB,EACpB,6BAA6B,EAC7B,mBAAmB,EACtB,MAAM,SAAS,CAAC;AAGjB;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,kBAAkB,CAkB5E"}
@@ -7,6 +7,7 @@ import { createExecution } from "./createExecution";
7
7
  * @remarks
8
8
  * It builds the execution on top of the backend passed to the BackendProvider, and workspace passed to the WorkspaceProvider.
9
9
  *
10
+ * @deprecated use {@link useExecutionDataView} instead
10
11
  * @beta
11
12
  */
12
13
  export function useExecution(config) {
@@ -1 +1 @@
1
- {"version":3,"file":"useExecution.js","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":";AAEA,OAAO,EACH,UAAU,EACV,gCAAgC,EAChC,YAAY,GAMf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAmEpD;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,MAA2B;IACpD,IAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3C,IAAA,KAAA,OAAgD,gCAAgC,CAClF,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAChF,MAAM,CAAC,6BAA6B,CACvC,IAAA,EAHM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QAGjD,CAAC;IAEF,OAAO,eAAe,uBACf,MAAM,KACT,OAAO,SAAA;QACP,SAAS,WAAA;QACT,QAAQ,UAAA;QACR,QAAQ,UAAA;QACR,MAAM,QAAA;QACN,OAAO,SAAA;QACP,MAAM,QAAA,IACR,CAAC;AACP,CAAC"}
1
+ {"version":3,"file":"useExecution.js","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":";AAEA,OAAO,EACH,UAAU,EACV,gCAAgC,EAChC,YAAY,GAMf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAoEpD;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,MAA2B;IACpD,IAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3C,IAAA,KAAA,OAAgD,gCAAgC,CAClF,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAChF,MAAM,CAAC,6BAA6B,CACvC,IAAA,EAHM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QAGjD,CAAC;IAEF,OAAO,eAAe,uBACf,MAAM,KACT,OAAO,SAAA;QACP,SAAS,WAAA;QACT,QAAQ,UAAA;QACR,QAAQ,UAAA;QACR,MAAM,QAAA;QACN,OAAO,SAAA;QACP,MAAM,QAAA,IACR,CAAC;AACP,CAAC"}
@@ -3,7 +3,7 @@ import { IAnalyticalBackend, IPreparedExecution } from "@gooddata/sdk-backend-sp
3
3
  import { DataViewWindow } from "./withExecutionLoading";
4
4
  import { DataViewFacade, GoodDataSdkError, UseCancelablePromiseState, AttributesMeasuresOrPlaceholders, AttributesOrPlaceholders, NullableFiltersOrPlaceholders, SortsOrPlaceholders, TotalsOrPlaceholders } from "../base";
5
5
  /**
6
- * @beta
6
+ * @public
7
7
  */
8
8
  export interface IExecutionConfiguration {
9
9
  /**
@@ -43,7 +43,7 @@ export interface IExecutionConfiguration {
43
43
  componentName?: string;
44
44
  }
45
45
  /**
46
- * @beta
46
+ * @public
47
47
  */
48
48
  export interface IUseExecutionDataViewConfig {
49
49
  /**
@@ -77,7 +77,7 @@ export interface IUseExecutionDataViewConfig {
77
77
  /**
78
78
  * React hook to get data for a specific execution.
79
79
  *
80
- * @beta
80
+ * @public
81
81
  */
82
82
  export declare function useExecutionDataView(config: IUseExecutionDataViewConfig, deps?: React.DependencyList): UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
83
83
  //# sourceMappingURL=useExecutionDataView.d.ts.map
@@ -13,7 +13,7 @@ function isExecutionConfiguration(obj) {
13
13
  /**
14
14
  * React hook to get data for a specific execution.
15
15
  *
16
- * @beta
16
+ * @public
17
17
  */
18
18
  export function useExecutionDataView(config, deps) {
19
19
  var _a;
@@ -4,7 +4,7 @@ import { IDimension, IExecutionDefinition, INullableFilter, ISortItem, ObjRef }
4
4
  import { UseCancelablePromiseState, DataViewFacade, GoodDataSdkError } from "../base";
5
5
  import { DataViewWindow } from "./withExecutionLoading";
6
6
  /**
7
- * @beta
7
+ * @public
8
8
  */
9
9
  export interface IUseInsightDataViewConfig {
10
10
  /**
@@ -37,6 +37,23 @@ export interface IUseInsightDataViewConfig {
37
37
  * This is useful if you want to page data.
38
38
  */
39
39
  window?: DataViewWindow;
40
+ /**
41
+ * Indicates that the execution to obtain the data for the insight should be an 'execution by reference'.
42
+ *
43
+ * Execution by reference means that the useInsightDataView will ask analytical backend to compute results for an insight
44
+ * which is stored on the backend by specifying link to the insight, additional filters and description how
45
+ * to organize the data.
46
+ *
47
+ * Otherwise, a freeform execution is done, in which the InsightView will send to backend the full execution
48
+ * definition of what to compute.
49
+ *
50
+ * This distinction is in place because some backends MAY want to prohibit users from doing freeform executions
51
+ * and only allow computing data for set of insights created by admins.
52
+ *
53
+ * Note: the need for execute by reference is rare. You will typically be notified by the solution admin to use
54
+ * this mode.
55
+ */
56
+ executeByReference?: boolean;
40
57
  /**
41
58
  * Backend to work with.
42
59
  *
@@ -57,7 +74,7 @@ export interface IUseInsightDataViewConfig {
57
74
  /**
58
75
  * React hook to get data for a specific insight.
59
76
  *
60
- * @beta
77
+ * @public
61
78
  */
62
79
  export declare function useInsightDataView(config: IUseInsightDataViewConfig, deps?: React.DependencyList): UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
63
80
  //# sourceMappingURL=useInsightDataView.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"useInsightDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useInsightDataView.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EAKH,yBAAyB,EACzB,cAAc,EACd,gBAAgB,EACnB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,KAAK,SAAS,EAAE,CAAC,CAAC;IAEnE;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,KAAK,UAAU,EAAE,CAAC,CAAC;IAE1E;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,KAAK,MAAM,CAAC,CAAC;IAE9D;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAE5B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,yBAAyB,EACjC,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,GAC5B,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CA8C7D"}
1
+ {"version":3,"file":"useInsightDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useInsightDataView.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EAKH,yBAAyB,EACzB,cAAc,EACd,gBAAgB,EACnB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,KAAK,SAAS,EAAE,CAAC,CAAC;IAEnE;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,KAAK,UAAU,EAAE,CAAC,CAAC;IAE1E;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,KAAK,MAAM,CAAC,CAAC;IAE9D;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAE5B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,yBAAyB,EACjC,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,GAC5B,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CA0D7D"}
@@ -5,16 +5,17 @@ import { useInsight } from "./useInsight";
5
5
  /**
6
6
  * React hook to get data for a specific insight.
7
7
  *
8
- * @beta
8
+ * @public
9
9
  */
10
10
  export function useInsightDataView(config, deps) {
11
- var insightRef = config.insight, sorts = config.sorts, dateFormat = config.dateFormat, dimensions = config.dimensions, filters = config.filters, window = config.window;
11
+ var insightRef = config.insight, sorts = config.sorts, dateFormat = config.dateFormat, dimensions = config.dimensions, filters = config.filters, window = config.window, executeByReference = config.executeByReference;
12
12
  var backend = useBackendStrict(config.backend, "useInsightDataView");
13
13
  var workspace = useWorkspaceStrict(config.workspace, "useInsightDataView");
14
14
  var effectiveDeps = deps !== null && deps !== void 0 ? deps : [];
15
15
  var insightPromise = useInsight({ insight: insightRef, backend: backend, workspace: workspace }, effectiveDeps);
16
- var insightExecution = insightPromise.result &&
17
- backend.workspace(workspace).execution().forInsightByRef(insightPromise.result, filters);
16
+ var executionFactory = backend.workspace(workspace).execution();
17
+ var executeFn = (executeByReference ? executionFactory.forInsightByRef : executionFactory.forInsight).bind(executionFactory);
18
+ var insightExecution = insightPromise.result && executeFn(insightPromise.result, filters);
18
19
  if (insightExecution) {
19
20
  if (sorts) {
20
21
  var resolvedSorts = typeof sorts === "function" ? sorts(insightExecution.definition) : sorts;
@@ -1 +1 @@
1
- {"version":3,"file":"useInsightDataView.js","sourceRoot":"","sources":["../../src/execution/useInsightDataView.ts"],"names":[],"mappings":";AAGA,OAAO,EACH,gBAAgB,EAChB,kBAAkB,EAClB,kCAAkC,EAClC,iCAAiC,GAIpC,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AA6D1C;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAC9B,MAAiC,EACjC,IAA2B;IAEnB,IAAS,UAAU,GAAqD,MAAM,QAA3D,EAAE,KAAK,GAA8C,MAAM,MAApD,EAAE,UAAU,GAAkC,MAAM,WAAxC,EAAE,UAAU,GAAsB,MAAM,WAA5B,EAAE,OAAO,GAAa,MAAM,QAAnB,EAAE,MAAM,GAAK,MAAM,OAAX,CAAY;IACvF,IAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IACvE,IAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAC7E,IAAM,aAAa,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC;IAEjC,IAAM,cAAc,GAAG,UAAU,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,SAAA,EAAE,SAAS,WAAA,EAAE,EAAE,aAAa,CAAC,CAAC;IAE9F,IAAI,gBAAgB,GAChB,cAAc,CAAC,MAAM;QACrB,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC,eAAe,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7F,IAAI,gBAAgB,EAAE;QAClB,IAAI,KAAK,EAAE;YACP,IAAM,aAAa,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAC/F,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,OAA5B,gBAAgB,WAAgB,aAAa,EAAC,CAAC;SACrE;QACD,IAAI,UAAU,EAAE;YACZ,IAAM,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YAC5F,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,OAA/B,gBAAgB,WAAmB,kBAAkB,EAAC,CAAC;SAC7E;QACD,IAAI,UAAU,EAAE;YACZ,IAAM,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YAC5F,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;SAC1E;KACJ;IAED,IAAM,wBAAwB,GAAG,oBAAoB,CACjD;QACI,SAAS,EAAE,gBAAgB;QAC3B,MAAM,QAAA;QACN,OAAO,SAAA;QACP,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;IAEF,IAAM,kBAAkB,GAAG,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;IAEtE,OAAO;QACH,MAAM,EAAE,wBAAwB,CAAC,MAAM;QACvC,KAAK,EAAE,iCAAiC,CAAC,kBAAkB,CAAC;QAC5D,MAAM,EAAE,kCAAkC,CAAC,kBAAkB,CAAC;KACF,CAAC;AACrE,CAAC"}
1
+ {"version":3,"file":"useInsightDataView.js","sourceRoot":"","sources":["../../src/execution/useInsightDataView.ts"],"names":[],"mappings":";AAGA,OAAO,EACH,gBAAgB,EAChB,kBAAkB,EAClB,kCAAkC,EAClC,iCAAiC,GAIpC,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AA+E1C;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAC9B,MAAiC,EACjC,IAA2B;IAGvB,IAAS,UAAU,GAOnB,MAAM,QAPa,EACnB,KAAK,GAML,MAAM,MAND,EACL,UAAU,GAKV,MAAM,WALI,EACV,UAAU,GAIV,MAAM,WAJI,EACV,OAAO,GAGP,MAAM,QAHC,EACP,MAAM,GAEN,MAAM,OAFA,EACN,kBAAkB,GAClB,MAAM,mBADY,CACX;IACX,IAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IACvE,IAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAC7E,IAAM,aAAa,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC;IAEjC,IAAM,cAAc,GAAG,UAAU,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,SAAA,EAAE,SAAS,WAAA,EAAE,EAAE,aAAa,CAAC,CAAC;IAE9F,IAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;IAElE,IAAM,SAAS,GAAG,CACd,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CACtF,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAEzB,IAAI,gBAAgB,GAAG,cAAc,CAAC,MAAM,IAAI,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE1F,IAAI,gBAAgB,EAAE;QAClB,IAAI,KAAK,EAAE;YACP,IAAM,aAAa,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAC/F,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,OAA5B,gBAAgB,WAAgB,aAAa,EAAC,CAAC;SACrE;QACD,IAAI,UAAU,EAAE;YACZ,IAAM,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YAC5F,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,OAA/B,gBAAgB,WAAmB,kBAAkB,EAAC,CAAC;SAC7E;QACD,IAAI,UAAU,EAAE;YACZ,IAAM,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YAC5F,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;SAC1E;KACJ;IAED,IAAM,wBAAwB,GAAG,oBAAoB,CACjD;QACI,SAAS,EAAE,gBAAgB;QAC3B,MAAM,QAAA;QACN,OAAO,SAAA;QACP,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;IAEF,IAAM,kBAAkB,GAAG,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;IAEtE,OAAO;QACH,MAAM,EAAE,wBAAwB,CAAC,MAAM;QACvC,KAAK,EAAE,iCAAiC,CAAC,kBAAkB,CAAC;QAC5D,MAAM,EAAE,kCAAkC,CAAC,kBAAkB,CAAC;KACF,CAAC;AACrE,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-ui",
3
- "version": "8.10.0-alpha.32",
3
+ "version": "8.10.0-alpha.35",
4
4
  "description": "GoodData.UI SDK - Core",
5
5
  "repository": {
6
6
  "type": "git",
@@ -37,9 +37,9 @@
37
37
  "dependencies": {
38
38
  "@formatjs/intl-pluralrules": "~1.3.7",
39
39
  "@gooddata/numberjs": "^4.0.1",
40
- "@gooddata/sdk-backend-spi": "^8.10.0-alpha.32",
41
- "@gooddata/sdk-model": "^8.10.0-alpha.32",
42
- "@gooddata/util": "^8.10.0-alpha.32",
40
+ "@gooddata/sdk-backend-spi": "^8.10.0-alpha.35",
41
+ "@gooddata/sdk-model": "^8.10.0-alpha.35",
42
+ "@gooddata/util": "^8.10.0-alpha.35",
43
43
  "custom-event": "^1.0.1",
44
44
  "hoist-non-react-statics": "^3.3.0",
45
45
  "http-status-codes": "^2.1.4",
@@ -57,9 +57,9 @@
57
57
  },
58
58
  "devDependencies": {
59
59
  "@gooddata/eslint-config": "^2.1.0",
60
- "@gooddata/reference-workspace": "^8.10.0-alpha.32",
61
- "@gooddata/sdk-backend-base": "^8.10.0-alpha.32",
62
- "@gooddata/sdk-backend-mockingbird": "^8.10.0-alpha.32",
60
+ "@gooddata/reference-workspace": "^8.10.0-alpha.35",
61
+ "@gooddata/sdk-backend-base": "^8.10.0-alpha.35",
62
+ "@gooddata/sdk-backend-mockingbird": "^8.10.0-alpha.35",
63
63
  "@gooddata/stylelint-config": "^5.0.0",
64
64
  "@microsoft/api-documenter": "^7.12.13",
65
65
  "@microsoft/api-extractor": "^7.18.4",