@gooddata/sdk-backend-spi 10.2.0-alpha.18 → 10.2.0-alpha.19

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.
package/esm/index.d.ts CHANGED
@@ -12,7 +12,7 @@ export { IBackendCapabilities } from "./backend/capabilities.js";
12
12
  export { IUserSettings, IWorkspaceSettings, IUserWorkspaceSettings } from "./common/settings.js";
13
13
  export { IUserService } from "./user/index.js";
14
14
  export { IUserSettingsService } from "./user/settings/index.js";
15
- export { IExecutionFactory, IPreparedExecution, IExecutionResult, IDataView, ExplainConfig, IExplainResult, IExplainProvider, ExplainType, } from "./workspace/execution/index.js";
15
+ export { IExecutionFactory, IPreparedExecution, IExecutionResult, IDataView, IForecastView, ExplainConfig, IExplainResult, IExplainProvider, ExplainType, IForecastResult, IForecastConfig, } from "./workspace/execution/index.js";
16
16
  export { IWorkspaceSettingsService } from "./workspace/settings/index.js";
17
17
  export { CancelableOptions, ICancelable } from "./cancelation/index.js";
18
18
  export { IGetInsightOptions, IGetVisualizationClassesOptions, IWorkspaceInsightsService, InsightOrdering, IInsightsQueryOptions, IInsightsQuery, IInsightsQueryResult, IInsightReferences, IInsightReferencing, InsightReferenceTypes, SupportedInsightReferenceTypes, } from "./workspace/insights/index.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,OAAO,EACH,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,GACd,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EACH,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,EACxC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACH,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEzF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAE9E,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAE/F,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EACH,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AACvG,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EACH,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEpF,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7G,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,OAAO,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,OAAO,EACH,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,GAClB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EACH,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,EACxC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACH,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEzF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAE9E,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAE/F,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EACH,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AACvG,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EACH,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEpF,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7G,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,OAAO,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC"}
package/esm/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AACrC;;;;;;;;GAQG;AACH,OAAO,EAIH,gBAAgB,GAKnB,MAAM,oBAAoB,CAAC;AAkD5B,OAAO,EAUH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAG3C,MAAM,0CAA0C,CAAC;AAKlD,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAEhB,YAAY,EACZ,eAAe,EAEf,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EAEjB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAuC3B,OAAO,EACH,sBAAsB,EAGtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AACrC;;;;;;;;GAQG;AACH,OAAO,EAIH,gBAAgB,GAKnB,MAAM,oBAAoB,CAAC;AAqD5B,OAAO,EAUH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAG3C,MAAM,0CAA0C,CAAC;AAKlD,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAEhB,YAAY,EACZ,eAAe,EAEf,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EAEjB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAuC3B,OAAO,EACH,sBAAsB,EAGtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC"}
@@ -1116,6 +1116,16 @@ export declare interface IDataView {
1116
1116
  * Result of the execution that calculated data for this view.
1117
1117
  */
1118
1118
  readonly result: IExecutionResult;
1119
+ /**
1120
+ * Configuration for the forecasting, if available.
1121
+ * @beta
1122
+ */
1123
+ readonly forecastConfig?: IForecastConfig;
1124
+ /**
1125
+ * Forecasting result, if available.
1126
+ * @beta
1127
+ */
1128
+ readonly forecastResult?: IForecastResult;
1119
1129
  /**
1120
1130
  * Result warnings.
1121
1131
  *
@@ -1143,6 +1153,21 @@ export declare interface IDataView {
1143
1153
  * Thus, two data views on the same result, with same offset and limit will have the same fingerprint.
1144
1154
  */
1145
1155
  fingerprint(): string;
1156
+ /**
1157
+ * Return forecast data view. This object is empty if not `withForecast` was called
1158
+ * @see IDataView.withForecast
1159
+ * @beta
1160
+ */
1161
+ forecast(): IForecastView;
1162
+ /**
1163
+ * Adds forecast for this data view.
1164
+ *
1165
+ * @beta
1166
+ * @param config - forecast configuration
1167
+ * @param result - forecast result
1168
+ * @returns new data view with forecasting enabled
1169
+ */
1170
+ withForecast(config: IForecastConfig, result?: IForecastResult): IDataView;
1146
1171
  }
1147
1172
 
1148
1173
  /**
@@ -1561,6 +1586,11 @@ export declare interface IExecutionResult {
1561
1586
  * @returns Promise of data view
1562
1587
  */
1563
1588
  readWindow(offset: number[], size: number[]): Promise<IDataView>;
1589
+ /**
1590
+ * Reads forecast for the execution result.
1591
+ * @beta
1592
+ */
1593
+ readForecastAll(config: IForecastConfig): Promise<IForecastResult>;
1564
1594
  /**
1565
1595
  * Transforms this execution result - changing the result sorting, dimensionality and available
1566
1596
  * totals is possible through transformation.
@@ -1823,6 +1853,46 @@ export declare interface IFilterElementsQuery {
1823
1853
  query(): Promise<IElementsQueryResult>;
1824
1854
  }
1825
1855
 
1856
+ /**
1857
+ * @beta
1858
+ */
1859
+ export declare interface IForecastConfig {
1860
+ /**
1861
+ * Forecast period in number of periods - e.g. 3
1862
+ */
1863
+ forecastPeriod: number;
1864
+ /**
1865
+ * Confidence level of the forecast in percents - e.g. 0.95
1866
+ */
1867
+ confidenceLevel: number;
1868
+ /**
1869
+ * Defines, whether the forecast should be seasonal.
1870
+ */
1871
+ seasonal: boolean;
1872
+ }
1873
+
1874
+ /**
1875
+ * @beta
1876
+ */
1877
+ export declare interface IForecastResult {
1878
+ attribute: string[];
1879
+ origin: number[];
1880
+ prediction: number[];
1881
+ lowerBound: number[];
1882
+ upperBound: number[];
1883
+ }
1884
+
1885
+ /**
1886
+ * Represents a prediction, lower bound and upper bound for a forecast.
1887
+ * @beta
1888
+ */
1889
+ export declare interface IForecastView {
1890
+ headerItems: IResultHeader[][][];
1891
+ prediction: DataValue[][];
1892
+ low: DataValue[][];
1893
+ high: DataValue[][];
1894
+ }
1895
+
1826
1896
  /**
1827
1897
  * Configuration options for getting dashboards.
1828
1898
  *
@@ -1,5 +1,32 @@
1
1
  import { IAttributeOrMeasure, IBucket, IDimension, IInsightDefinition, ISortItem, IExecutionDefinition, DimensionGenerator, IInsight, INullableFilter, IExecutionConfig, DataValue, IDimensionDescriptor, IResultHeader, IResultWarning } from "@gooddata/sdk-model";
2
2
  import { IExportConfig, IExportResult } from "./export.js";
3
+ /**
4
+ * @beta
5
+ */
6
+ export interface IForecastConfig {
7
+ /**
8
+ * Forecast period in number of periods - e.g. 3
9
+ */
10
+ forecastPeriod: number;
11
+ /**
12
+ * Confidence level of the forecast in percents - e.g. 0.95
13
+ */
14
+ confidenceLevel: number;
15
+ /**
16
+ * Defines, whether the forecast should be seasonal.
17
+ */
18
+ seasonal: boolean;
19
+ }
20
+ /**
21
+ * @beta
22
+ */
23
+ export interface IForecastResult {
24
+ attribute: string[];
25
+ origin: number[];
26
+ prediction: number[];
27
+ lowerBound: number[];
28
+ upperBound: number[];
29
+ }
3
30
  /**
4
31
  * Execution factory provides several methods to create a prepared execution from different types
5
32
  * of inputs.
@@ -250,6 +277,11 @@ export interface IExecutionResult {
250
277
  * @returns Promise of data view
251
278
  */
252
279
  readWindow(offset: number[], size: number[]): Promise<IDataView>;
280
+ /**
281
+ * Reads forecast for the execution result.
282
+ * @beta
283
+ */
284
+ readForecastAll(config: IForecastConfig): Promise<IForecastResult>;
253
285
  /**
254
286
  * Transforms this execution result - changing the result sorting, dimensionality and available
255
287
  * totals is possible through transformation.
@@ -371,6 +403,16 @@ export interface IDataView {
371
403
  * Result of the execution that calculated data for this view.
372
404
  */
373
405
  readonly result: IExecutionResult;
406
+ /**
407
+ * Configuration for the forecasting, if available.
408
+ * @beta
409
+ */
410
+ readonly forecastConfig?: IForecastConfig;
411
+ /**
412
+ * Forecasting result, if available.
413
+ * @beta
414
+ */
415
+ readonly forecastResult?: IForecastResult;
374
416
  /**
375
417
  * Result warnings.
376
418
  *
@@ -398,5 +440,30 @@ export interface IDataView {
398
440
  * Thus, two data views on the same result, with same offset and limit will have the same fingerprint.
399
441
  */
400
442
  fingerprint(): string;
443
+ /**
444
+ * Return forecast data view. This object is empty if not `withForecast` was called
445
+ * @see IDataView.withForecast
446
+ * @beta
447
+ */
448
+ forecast(): IForecastView;
449
+ /**
450
+ * Adds forecast for this data view.
451
+ *
452
+ * @beta
453
+ * @param config - forecast configuration
454
+ * @param result - forecast result
455
+ * @returns new data view with forecasting enabled
456
+ */
457
+ withForecast(config: IForecastConfig, result?: IForecastResult): IDataView;
458
+ }
459
+ /**
460
+ * Represents a prediction, lower bound and upper bound for a forecast.
461
+ * @beta
462
+ */
463
+ export interface IForecastView {
464
+ headerItems: IResultHeader[][][];
465
+ prediction: DataValue[][];
466
+ low: DataValue[][];
467
+ high: DataValue[][];
401
468
  }
402
469
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,mBAAmB,EACnB,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EACpB,kBAAkB,EAClB,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,oBAAoB,EACpB,aAAa,EACb,cAAc,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE3D;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;;;OAUG;IACH,aAAa,CAAC,GAAG,EAAE,oBAAoB,GAAG,kBAAkB,CAAC;IAE7D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,mBAAmB,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAExF;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAEhF;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAEnG;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;CACvF;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,YAAY,GAAG,KAAK,GAAG,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,KAAK,CAAC;AAE5G;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,SAAS,IAAI;IAC3D,WAAW,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IACxB,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACjB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAChB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACpB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IACvB,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,WAAW,GAAG,SAAS;IAC/D,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,IAAI,OAAO,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;;;;OAKG;IACH,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,EAAE,GAAG,kBAAkB,CAAC;IAEvD;;;;;;;;;OASG;IACH,cAAc,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,UAAU,GAAG,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;IAEnF;;;;;;OAMG;IACH,WAAW,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC;IAEvD;;;;;OAKG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEvD;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,CAAC,SAAS,WAAW,GAAG,SAAS,EACrC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GACzB,gBAAgB,CAAC,OAAO,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IAElD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAE3C;;;;;;OAMG;IACH,WAAW,IAAI,MAAM,CAAC;IAEtB;;OAEG;IAEH,cAAc,CAAC,MAAM,EAAE,gBAAgB,GAAG,kBAAkB,CAAC;CAChE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,EAAE,CAAC;IAE5C;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;IAE9B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAEjE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,IAAI,kBAAkB,CAAC;IAEhC;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEvD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC;IAEzC;;;;;;;;OAQG;IACH,WAAW,IAAI,MAAM,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,WAAW,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC;IAE3C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAErC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IAElC;;;;;;;;OAQG;IACH,WAAW,IAAI,MAAM,CAAC;CACzB"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,mBAAmB,EACnB,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EACpB,kBAAkB,EAClB,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,oBAAoB,EACpB,aAAa,EACb,cAAc,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;;;OAUG;IACH,aAAa,CAAC,GAAG,EAAE,oBAAoB,GAAG,kBAAkB,CAAC;IAE7D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,mBAAmB,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAExF;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAEhF;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAEnG;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;CACvF;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,YAAY,GAAG,KAAK,GAAG,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,KAAK,CAAC;AAE5G;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,SAAS,IAAI;IAC3D,WAAW,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IACxB,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACjB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAChB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACpB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IACvB,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,WAAW,GAAG,SAAS;IAC/D,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,IAAI,OAAO,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;;;;OAKG;IACH,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,EAAE,GAAG,kBAAkB,CAAC;IAEvD;;;;;;;;;OASG;IACH,cAAc,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,UAAU,GAAG,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;IAEnF;;;;;;OAMG;IACH,WAAW,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC;IAEvD;;;;;OAKG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEvD;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,CAAC,SAAS,WAAW,GAAG,SAAS,EACrC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GACzB,gBAAgB,CAAC,OAAO,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IAElD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAE3C;;;;;;OAMG;IACH,WAAW,IAAI,MAAM,CAAC;IAEtB;;OAEG;IAEH,cAAc,CAAC,MAAM,EAAE,gBAAgB,GAAG,kBAAkB,CAAC;CAChE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,EAAE,CAAC;IAE5C;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;IAE9B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAEjE;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,IAAI,kBAAkB,CAAC;IAEhC;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEvD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC;IAEzC;;;;;;;;OAQG;IACH,WAAW,IAAI,MAAM,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,WAAW,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC;IAE3C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,eAAe,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,eAAe,CAAC;IAE1C;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAErC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IAElC;;;;;;;;OAQG;IACH,WAAW,IAAI,MAAM,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,IAAI,aAAa,CAAC;IAE1B;;;;;;;OAOG;IACH,YAAY,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,WAAW,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;IACjC,UAAU,EAAE,SAAS,EAAE,EAAE,CAAC;IAC1B,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC;IACnB,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC;CACvB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-backend-spi",
3
- "version": "10.2.0-alpha.18",
3
+ "version": "10.2.0-alpha.19",
4
4
  "author": "GoodData",
5
5
  "description": "GoodData Backend SPI abstraction interfaces",
6
6
  "repository": {
@@ -24,7 +24,7 @@
24
24
  "lodash": "^4.17.21",
25
25
  "ts-invariant": "^0.7.5",
26
26
  "tslib": "^2.5.0",
27
- "@gooddata/sdk-model": "10.2.0-alpha.18"
27
+ "@gooddata/sdk-model": "10.2.0-alpha.19"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@gooddata/eslint-config": "^4.1.0",