@gooddata/sdk-backend-spi 10.2.0-alpha.3 → 10.2.0-alpha.31

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,21 +12,21 @@ 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, IAnomalyDetectionConfig, IAnomalyDetectionResult, IClusteringConfig, IClusteringResult, } 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";
19
19
  export { ExportDefinitionOrdering, IExportDefinitionsQuery, IExportDefinitionsQueryOptions, IExportDefinitionsQueryResult, IGetExportDefinitionOptions, IWorkspaceExportDefinitionsService, ExportDefinitionQuerySortDirection, ExportDefinitionQuerySortProperty, ExportDefinitionQuerySort, } from "./workspace/exportDefinitions/index.js";
20
20
  export { IElementsQueryFactory, IElementsQueryResult, IElementsQuery, IElementsQueryOptions, IElementsQueryAttributeFilter, IElementsQueryOptionsElementsByUri, IElementsQueryOptionsElementsByValue, IElementsQueryOptionsElementsByPrimaryDisplayFormValue, ElementsQueryOptionsElementsSpecification, isElementsQueryOptionsElementsByValue, isElementsQueryOptionsElementsByPrimaryDisplayFormValue, isValueBasedElementsQueryOptionsElements, IFilterElementsQuery, FilterWithResolvableElements, } from "./workspace/attributes/elements/index.js";
21
- export { IExportConfig, IExportResult } from "./workspace/execution/export.js";
21
+ export { IExportConfig, IExportResult, IExportPdfConfig } from "./workspace/execution/export.js";
22
22
  export { IWorkspaceStylingService } from "./workspace/styling/index.js";
23
23
  export { AnalyticalBackendError, NoDataError, DataTooLargeError, TimeoutError, ProtectedDataError, UnexpectedResponseError, UnexpectedError, NotSupported, NotImplemented, NotAuthenticated, NotAuthenticatedReason, LimitReached, ContractExpired, ErrorConverter, isAnalyticalBackendError, isNoDataError, isDataTooLargeError, isProtectedDataError, isUnexpectedResponseError, isUnexpectedError, isNotSupported, isNotImplemented, isNotAuthenticated, isLimitReached, isContractExpired, AuthenticationFlow, AnalyticalBackendErrorTypes, } from "./errors/index.js";
24
24
  export { IPagedResource } from "./common/paging.js";
25
- export { IAnalyticalWorkspace, IWorkspacesQuery, IWorkspacesQueryFactory, IWorkspacesQueryResult, IWorkspaceDescriptor, IWorkspaceDescriptorUpdate, } from "./workspace/index.js";
25
+ export { IAnalyticalWorkspace, IWorkspacesQuery, IWorkspacesQueryFactory, IWorkspacesQueryResult, IWorkspacesQueryFilter, IWorkspacesQueryOptions, IWorkspaceDescriptor, IWorkspaceDescriptorUpdate, } from "./workspace/index.js";
26
26
  export { IAttributeHierarchiesService } from "./workspace/attributeHierarchies/index.js";
27
27
  export { IWorkspacePermissionsService } from "./workspace/permissions/index.js";
28
28
  export { IWorkspaceAttributesService } from "./workspace/attributes/index.js";
29
- export { IWorkspaceMeasuresService, IMeasureReferencing } from "./workspace/measures/index.js";
29
+ export { IWorkspaceMeasuresService, IMeasureReferencing, IMeasureKeyDrivers, } from "./workspace/measures/index.js";
30
30
  export { IWorkspaceFactsService } from "./workspace/facts/index.js";
31
31
  export { IWorkspaceDashboardsService, IGetDashboardOptions, IGetDashboardPluginOptions, IGetScheduledMailOptions, IWidgetAlertCount, SupportedDashboardReferenceTypes, IWidgetReferences, SupportedWidgetReferenceTypes, IDashboardReferences, IDashboardWithReferences, IDashboardsQuery, IDashboardsQueryResult, } from "./workspace/dashboards/index.js";
32
32
  export { isDashboardLayoutEmpty, IWidgetWithLayoutPath, LayoutPath, layoutWidgets, layoutWidgetsWithPaths, walkLayout, } from "./workspace/dashboards/utils.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,MAAM,iCAAiC,CAAC;AAE/E,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,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,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,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,EACH,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,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;AAqC3B,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;AAyD5B,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;AA2C3B,OAAO,EACH,sBAAsB,EAGtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC"}
@@ -1,4 +1,4 @@
1
- import { ISettings, IWhiteLabeling } from "@gooddata/sdk-model";
1
+ import { ISettings, IWhiteLabeling, IOpenAiConfig } from "@gooddata/sdk-model";
2
2
  /**
3
3
  * This service provides access to organization settings
4
4
  *
@@ -62,6 +62,15 @@ export interface IOrganizationSettingsService {
62
62
  * @returns promise
63
63
  */
64
64
  setColorPalette(colorPaletteId: string): Promise<void>;
65
+ /**
66
+ * Sets OpenAI configuration for organization.
67
+ *
68
+ * @param config - describes parameters for OpenAI integration.
69
+ *
70
+ * @returns promise
71
+ * @alpha
72
+ */
73
+ setOpenAiConfig(config: IOpenAiConfig): Promise<void>;
65
74
  /**
66
75
  * Deletes theme from organization settings returning workspace styling to default.
67
76
  *
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/settings/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;OAMG;IACH,gBAAgB,CAAC,aAAa,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;OAMG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;CACrC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/settings/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAE/E;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;OAMG;IACH,gBAAgB,CAAC,aAAa,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;OAMG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;;;;OAOG;IACH,eAAe,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;CACrC"}
@@ -1,3 +1,3 @@
1
- // (C) 2022 GoodData Corporation
1
+ // (C) 2022-2024 GoodData Corporation
2
2
  export {};
3
3
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/organization/settings/index.ts"],"names":[],"mappings":"AAAA,gCAAgC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/organization/settings/index.ts"],"names":[],"mappings":"AAAA,qCAAqC"}
@@ -66,6 +66,7 @@ import { IMeasureMetadataObject } from '@gooddata/sdk-model';
66
66
  import { IMeasureMetadataObjectDefinition } from '@gooddata/sdk-model';
67
67
  import { IMetadataObject } from '@gooddata/sdk-model';
68
68
  import { INullableFilter } from '@gooddata/sdk-model';
69
+ import { IOpenAiConfig } from '@gooddata/sdk-model';
69
70
  import { IOrganizationAssignee } from '@gooddata/sdk-model';
70
71
  import { IOrganizationDescriptor } from '@gooddata/sdk-model';
71
72
  import { IOrganizationDescriptorUpdate } from '@gooddata/sdk-model';
@@ -499,6 +500,25 @@ export declare interface IAnalyticalWorkspace {
499
500
  logicalModel(): IWorkspaceLogicalModelService;
500
501
  }
501
502
 
503
+ /**
504
+ * @alpha
505
+ */
506
+ export declare interface IAnomalyDetectionConfig {
507
+ /**
508
+ * Sensitivity of the anomaly detection - e.g. 1.5
509
+ */
510
+ sensitivity: number;
511
+ }
512
+
513
+ /**
514
+ * @alpha
515
+ */
516
+ export declare interface IAnomalyDetectionResult {
517
+ attribute: string[];
518
+ values: number[];
519
+ anomalyFlag: boolean[];
520
+ }
521
+
502
522
  /**
503
523
  * Parsed {@link https://help.gooddata.com/pages/viewpage.action?pageId=86795279 | MAQL} token referencing an attribute element.
504
524
  *
@@ -924,6 +944,26 @@ export declare interface ICancelable<T> {
924
944
  withSignal(signal: AbortSignal): T;
925
945
  }
926
946
 
947
+ /**
948
+ * @alpha
949
+ */
950
+ export declare interface IClusteringConfig {
951
+ /**
952
+ * Number of clusters - e.g. 3
953
+ */
954
+ numberOfClusters: number;
955
+ }
956
+
957
+ /**
958
+ * @alpha
959
+ */
960
+ export declare interface IClusteringResult {
961
+ attribute: string[];
962
+ clusters: number[];
963
+ xcoord: number[];
964
+ ycoord: number[];
965
+ }
966
+
927
967
  /**
928
968
  * Parsed {@link https://help.gooddata.com/pages/viewpage.action?pageId=86795279 | MAQL} comment text.
929
969
  *
@@ -1115,6 +1155,16 @@ export declare interface IDataView {
1115
1155
  * Result of the execution that calculated data for this view.
1116
1156
  */
1117
1157
  readonly result: IExecutionResult;
1158
+ /**
1159
+ * Configuration for the forecasting, if available.
1160
+ * @beta
1161
+ */
1162
+ readonly forecastConfig?: IForecastConfig;
1163
+ /**
1164
+ * Forecasting result, if available.
1165
+ * @beta
1166
+ */
1167
+ readonly forecastResult?: IForecastResult;
1118
1168
  /**
1119
1169
  * Result warnings.
1120
1170
  *
@@ -1142,6 +1192,21 @@ export declare interface IDataView {
1142
1192
  * Thus, two data views on the same result, with same offset and limit will have the same fingerprint.
1143
1193
  */
1144
1194
  fingerprint(): string;
1195
+ /**
1196
+ * Return forecast data view. This object is empty if not `withForecast` was called
1197
+ * @see IDataView.withForecast
1198
+ * @beta
1199
+ */
1200
+ forecast(): IForecastView;
1201
+ /**
1202
+ * Adds forecast for this data view.
1203
+ *
1204
+ * @beta
1205
+ * @param config - forecast configuration
1206
+ * @param result - forecast result
1207
+ * @returns new data view with forecasting enabled
1208
+ */
1209
+ withForecast(config?: IForecastConfig, result?: IForecastResult): IDataView;
1145
1210
  }
1146
1211
 
1147
1212
  /**
@@ -1560,6 +1625,21 @@ export declare interface IExecutionResult {
1560
1625
  * @returns Promise of data view
1561
1626
  */
1562
1627
  readWindow(offset: number[], size: number[]): Promise<IDataView>;
1628
+ /**
1629
+ * Reads forecast for the execution result.
1630
+ * @beta
1631
+ */
1632
+ readForecastAll(config: IForecastConfig): Promise<IForecastResult>;
1633
+ /**
1634
+ * Reads anomaly detection for the execution result.
1635
+ * @alpha
1636
+ */
1637
+ readAnomalyDetectionAll(config: IAnomalyDetectionConfig): Promise<IAnomalyDetectionResult>;
1638
+ /**
1639
+ * Reads anomaly detection for the execution result.
1640
+ * @alpha
1641
+ */
1642
+ readClusteringAll(config: IClusteringConfig): Promise<IClusteringResult>;
1563
1643
  /**
1564
1644
  * Transforms this execution result - changing the result sorting, dimensionality and available
1565
1645
  * totals is possible through transformation.
@@ -1647,7 +1727,7 @@ export declare interface IExportConfig {
1647
1727
  /**
1648
1728
  * Format of the export file. Defaults to CSV if not specified.
1649
1729
  */
1650
- format?: "xlsx" | "csv" | "raw";
1730
+ format?: "xlsx" | "csv" | "raw" | "pdf";
1651
1731
  /**
1652
1732
  * Applicable for XLSX format; specifies title of the workbook.
1653
1733
  */
@@ -1667,6 +1747,10 @@ export declare interface IExportConfig {
1667
1747
  * into the XLSX in a human readable form.
1668
1748
  */
1669
1749
  showFilters?: boolean;
1750
+ /**
1751
+ * Applicable for PDF format; specifies configuration for PDF export.
1752
+ */
1753
+ pdfConfiguration?: IExportPdfConfig;
1670
1754
  }
1671
1755
 
1672
1756
  /**
@@ -1759,6 +1843,15 @@ export declare interface IExportDefinitionsQueryOptions {
1759
1843
  */
1760
1844
  export declare type IExportDefinitionsQueryResult = IPagedResource<IExportDefinition>;
1761
1845
 
1846
+ /**
1847
+ * Configuration for PDF export.
1848
+ *
1849
+ * @public
1850
+ */
1851
+ export declare interface IExportPdfConfig {
1852
+ orientation: "portrait" | "landscape";
1853
+ }
1854
+
1762
1855
  /**
1763
1856
  * Result of export is an object URL pointing to a Blob of downloaded data attached to the current
1764
1857
  * window instance. The result also contains name of the downloaded file provided by the backend export
@@ -1809,6 +1902,47 @@ export declare interface IFilterElementsQuery {
1809
1902
  query(): Promise<IElementsQueryResult>;
1810
1903
  }
1811
1904
 
1905
+ /**
1906
+ * @beta
1907
+ */
1908
+ export declare interface IForecastConfig {
1909
+ /**
1910
+ * Forecast period in number of periods - e.g. 3
1911
+ */
1912
+ forecastPeriod: number;
1913
+ /**
1914
+ * Confidence level of the forecast in percents - e.g. 0.95
1915
+ */
1916
+ confidenceLevel: number;
1917
+ /**
1918
+ * Defines, whether the forecast should be seasonal.
1919
+ */
1920
+ seasonal: boolean;
1921
+ }
1922
+
1923
+ /**
1924
+ * @beta
1925
+ */
1926
+ export declare interface IForecastResult {
1927
+ attribute: string[];
1928
+ origin: number[];
1929
+ prediction: number[];
1930
+ lowerBound: number[];
1931
+ upperBound: number[];
1932
+ }
1933
+
1934
+ /**
1935
+ * Represents a prediction, lower bound and upper bound for a forecast.
1936
+ * @beta
1937
+ */
1938
+ export declare interface IForecastView {
1939
+ headerItems: IResultHeader[][][];
1940
+ prediction: DataValue[][];
1941
+ low: DataValue[][];
1942
+ high: DataValue[][];
1943
+ loading: boolean;
1944
+ }
1945
+
1812
1946
  /**
1813
1947
  * Configuration options for getting dashboards.
1814
1948
  *
@@ -2093,6 +2227,22 @@ export declare type IInsightsQueryResult = IPagedResource<IInsight>;
2093
2227
  */
2094
2228
  export declare type IMeasureExpressionToken = IObjectExpressionToken | IAttributeElementExpressionToken | ITextExpressionToken | ICommentExpressionToken | IBracketExpressionToken;
2095
2229
 
2230
+ /**
2231
+ * Contains information about key drivers for a given measure.
2232
+ *
2233
+ * @alpha
2234
+ */
2235
+ export declare interface IMeasureKeyDrivers {
2236
+ /**
2237
+ * Labels for the key drivers
2238
+ */
2239
+ labels: string[];
2240
+ /**
2241
+ * Effects for the key drivers
2242
+ */
2243
+ effects: number[];
2244
+ }
2245
+
2096
2246
  /**
2097
2247
  * Contains information about objects that may be referencing an measure. {@link IWorkspaceMeasuresService.getMeasureReferencingObjects} function.
2098
2248
  *
@@ -2331,6 +2481,15 @@ export declare interface IOrganizationSettingsService {
2331
2481
  * @returns promise
2332
2482
  */
2333
2483
  setColorPalette(colorPaletteId: string): Promise<void>;
2484
+ /**
2485
+ * Sets OpenAI configuration for organization.
2486
+ *
2487
+ * @param config - describes parameters for OpenAI integration.
2488
+ *
2489
+ * @returns promise
2490
+ * @alpha
2491
+ */
2492
+ setOpenAiConfig(config: IOpenAiConfig): Promise<void>;
2334
2493
  /**
2335
2494
  * Deletes theme from organization settings returning workspace styling to default.
2336
2495
  *
@@ -3796,6 +3955,10 @@ export declare interface IWorkspaceDescriptor {
3796
3955
  * Early access attribute value of the workspace
3797
3956
  */
3798
3957
  earlyAccess?: string;
3958
+ /**
3959
+ * Number of child workspaces
3960
+ */
3961
+ childWorkspacesCount?: number;
3799
3962
  }
3800
3963
 
3801
3964
  /**
@@ -3990,6 +4153,17 @@ export declare interface IWorkspaceLogicalModelService {
3990
4153
  * @public
3991
4154
  */
3992
4155
  export declare interface IWorkspaceMeasuresService {
4156
+ /**
4157
+ * Compute key drivers for a given measure.
4158
+ *
4159
+ * @param metric - the measure to compute key drivers for
4160
+ * @param sortDirection - the direction to sort the key drivers by
4161
+ * @returns promise of the key drivers
4162
+ * @alpha
4163
+ */
4164
+ computeKeyDrivers: (measure: IMeasure, options?: {
4165
+ sortDirection: "ASC" | "DESC";
4166
+ }) => Promise<IMeasureKeyDrivers>;
3993
4167
  /**
3994
4168
  * Get measure expression tokens for provided measure identifier
3995
4169
  * @param ref - ref of the measure
@@ -4128,11 +4302,13 @@ export declare interface IWorkspacesQuery {
4128
4302
  * @param filter - an object of attributes and values to filter by
4129
4303
  * @alpha
4130
4304
  */
4131
- withFilter(filter: {
4132
- description?: string;
4133
- earlyAccess?: string;
4134
- prefix?: string;
4135
- }): IWorkspacesQuery;
4305
+ withFilter(filter: IWorkspacesQueryFilter): IWorkspacesQuery;
4306
+ /**
4307
+ * Sets additional options for the query.
4308
+ * @param options - an object of options to modify the query behavior
4309
+ * @alpha
4310
+ */
4311
+ withOptions(options: IWorkspacesQueryOptions): IWorkspacesQuery;
4136
4312
  /**
4137
4313
  * Sets a text to search.
4138
4314
  * @param search - text to search
@@ -4165,6 +4341,42 @@ export declare interface IWorkspacesQueryFactory {
4165
4341
  forCurrentUser(): IWorkspacesQuery;
4166
4342
  }
4167
4343
 
4344
+ /**
4345
+ * Filter options for workspaces query.
4346
+ *
4347
+ * @public
4348
+ */
4349
+ export declare interface IWorkspacesQueryFilter {
4350
+ /**
4351
+ * Filter by description of the workspace
4352
+ */
4353
+ description?: string;
4354
+ /**
4355
+ * Filter by earlyAccess property on the workspace
4356
+ */
4357
+ earlyAccess?: string;
4358
+ /**
4359
+ * Filter by entity identifiers prefix in the workspace
4360
+ */
4361
+ prefix?: string;
4362
+ /**
4363
+ * When applied, only root workspaces without a parent workspace are queried
4364
+ */
4365
+ rootWorkspacesOnly?: boolean;
4366
+ }
4367
+
4368
+ /**
4369
+ * Additional options for workspaces query.
4370
+ *
4371
+ * @public
4372
+ */
4373
+ export declare interface IWorkspacesQueryOptions {
4374
+ /**
4375
+ * Include count of child workspaces in the result
4376
+ */
4377
+ includeChildWorkspacesCount?: boolean;
4378
+ }
4379
+
4168
4380
  /**
4169
4381
  * Paged resource with results of a workspace query.
4170
4382
  *
@@ -7,7 +7,7 @@ export interface IExportConfig {
7
7
  /**
8
8
  * Format of the export file. Defaults to CSV if not specified.
9
9
  */
10
- format?: "xlsx" | "csv" | "raw";
10
+ format?: "xlsx" | "csv" | "raw" | "pdf";
11
11
  /**
12
12
  * Applicable for XLSX format; specifies title of the workbook.
13
13
  */
@@ -27,6 +27,18 @@ export interface IExportConfig {
27
27
  * into the XLSX in a human readable form.
28
28
  */
29
29
  showFilters?: boolean;
30
+ /**
31
+ * Applicable for PDF format; specifies configuration for PDF export.
32
+ */
33
+ pdfConfiguration?: IExportPdfConfig;
34
+ }
35
+ /**
36
+ * Configuration for PDF export.
37
+ *
38
+ * @public
39
+ */
40
+ export interface IExportPdfConfig {
41
+ orientation: "portrait" | "landscape";
30
42
  }
31
43
  /**
32
44
  * Result of export is an object URL pointing to a Blob of downloaded data attached to the current
@@ -1 +1 @@
1
- {"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/export.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC1B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB"}
1
+ {"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/export.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,WAAW,EAAE,UAAU,GAAG,WAAW,CAAC;CACzC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC1B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB"}
@@ -1,3 +1,3 @@
1
- // (C) 2019-2023 GoodData Corporation
1
+ // (C) 2019-2024 GoodData Corporation
2
2
  export {};
3
3
  //# sourceMappingURL=export.js.map
@@ -1,5 +1,67 @@
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
+ }
30
+ /**
31
+ * @alpha
32
+ */
33
+ export interface IAnomalyDetectionConfig {
34
+ /**
35
+ * Sensitivity of the anomaly detection - e.g. 1.5
36
+ */
37
+ sensitivity: number;
38
+ }
39
+ /**
40
+ * @alpha
41
+ */
42
+ export interface IAnomalyDetectionResult {
43
+ attribute: string[];
44
+ values: number[];
45
+ anomalyFlag: boolean[];
46
+ }
47
+ /**
48
+ * @alpha
49
+ */
50
+ export interface IClusteringConfig {
51
+ /**
52
+ * Number of clusters - e.g. 3
53
+ */
54
+ numberOfClusters: number;
55
+ }
56
+ /**
57
+ * @alpha
58
+ */
59
+ export interface IClusteringResult {
60
+ attribute: string[];
61
+ clusters: number[];
62
+ xcoord: number[];
63
+ ycoord: number[];
64
+ }
3
65
  /**
4
66
  * Execution factory provides several methods to create a prepared execution from different types
5
67
  * of inputs.
@@ -250,6 +312,21 @@ export interface IExecutionResult {
250
312
  * @returns Promise of data view
251
313
  */
252
314
  readWindow(offset: number[], size: number[]): Promise<IDataView>;
315
+ /**
316
+ * Reads forecast for the execution result.
317
+ * @beta
318
+ */
319
+ readForecastAll(config: IForecastConfig): Promise<IForecastResult>;
320
+ /**
321
+ * Reads anomaly detection for the execution result.
322
+ * @alpha
323
+ */
324
+ readAnomalyDetectionAll(config: IAnomalyDetectionConfig): Promise<IAnomalyDetectionResult>;
325
+ /**
326
+ * Reads anomaly detection for the execution result.
327
+ * @alpha
328
+ */
329
+ readClusteringAll(config: IClusteringConfig): Promise<IClusteringResult>;
253
330
  /**
254
331
  * Transforms this execution result - changing the result sorting, dimensionality and available
255
332
  * totals is possible through transformation.
@@ -371,6 +448,16 @@ export interface IDataView {
371
448
  * Result of the execution that calculated data for this view.
372
449
  */
373
450
  readonly result: IExecutionResult;
451
+ /**
452
+ * Configuration for the forecasting, if available.
453
+ * @beta
454
+ */
455
+ readonly forecastConfig?: IForecastConfig;
456
+ /**
457
+ * Forecasting result, if available.
458
+ * @beta
459
+ */
460
+ readonly forecastResult?: IForecastResult;
374
461
  /**
375
462
  * Result warnings.
376
463
  *
@@ -398,5 +485,31 @@ export interface IDataView {
398
485
  * Thus, two data views on the same result, with same offset and limit will have the same fingerprint.
399
486
  */
400
487
  fingerprint(): string;
488
+ /**
489
+ * Return forecast data view. This object is empty if not `withForecast` was called
490
+ * @see IDataView.withForecast
491
+ * @beta
492
+ */
493
+ forecast(): IForecastView;
494
+ /**
495
+ * Adds forecast for this data view.
496
+ *
497
+ * @beta
498
+ * @param config - forecast configuration
499
+ * @param result - forecast result
500
+ * @returns new data view with forecasting enabled
501
+ */
502
+ withForecast(config?: IForecastConfig, result?: IForecastResult): IDataView;
503
+ }
504
+ /**
505
+ * Represents a prediction, lower bound and upper bound for a forecast.
506
+ * @beta
507
+ */
508
+ export interface IForecastView {
509
+ headerItems: IResultHeader[][][];
510
+ prediction: DataValue[][];
511
+ low: DataValue[][];
512
+ high: DataValue[][];
513
+ loading: boolean;
401
514
  }
402
515
  //# 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;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,OAAO,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;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;;;OAGG;IACH,uBAAuB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE3F;;;OAGG;IACH,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEzE;;;;;;;;;;;;;;;;;;;;;;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,CAAC,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CAC/E;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;IACpB,OAAO,EAAE,OAAO,CAAC;CACpB"}
@@ -156,6 +156,10 @@ export interface IWorkspaceDescriptor {
156
156
  * Early access attribute value of the workspace
157
157
  */
158
158
  earlyAccess?: string;
159
+ /**
160
+ * Number of child workspaces
161
+ */
162
+ childWorkspacesCount?: number;
159
163
  }
160
164
  /**
161
165
  * Workspace descriptor properties to update.
@@ -190,6 +194,40 @@ export interface IWorkspacesQueryFactory {
190
194
  */
191
195
  forCurrentUser(): IWorkspacesQuery;
192
196
  }
197
+ /**
198
+ * Filter options for workspaces query.
199
+ *
200
+ * @public
201
+ */
202
+ export interface IWorkspacesQueryFilter {
203
+ /**
204
+ * Filter by description of the workspace
205
+ */
206
+ description?: string;
207
+ /**
208
+ * Filter by earlyAccess property on the workspace
209
+ */
210
+ earlyAccess?: string;
211
+ /**
212
+ * Filter by entity identifiers prefix in the workspace
213
+ */
214
+ prefix?: string;
215
+ /**
216
+ * When applied, only root workspaces without a parent workspace are queried
217
+ */
218
+ rootWorkspacesOnly?: boolean;
219
+ }
220
+ /**
221
+ * Additional options for workspaces query.
222
+ *
223
+ * @public
224
+ */
225
+ export interface IWorkspacesQueryOptions {
226
+ /**
227
+ * Include count of child workspaces in the result
228
+ */
229
+ includeChildWorkspacesCount?: boolean;
230
+ }
193
231
  /**
194
232
  * Query to retrieve available workspaces.
195
233
  *
@@ -218,11 +256,13 @@ export interface IWorkspacesQuery {
218
256
  * @param filter - an object of attributes and values to filter by
219
257
  * @alpha
220
258
  */
221
- withFilter(filter: {
222
- description?: string;
223
- earlyAccess?: string;
224
- prefix?: string;
225
- }): IWorkspacesQuery;
259
+ withFilter(filter: IWorkspacesQueryFilter): IWorkspacesQuery;
260
+ /**
261
+ * Sets additional options for the query.
262
+ * @param options - an object of options to modify the query behavior
263
+ * @alpha
264
+ */
265
+ withOptions(options: IWorkspacesQueryOptions): IWorkspacesQuery;
226
266
  /**
227
267
  * Sets a text to search.
228
268
  * @param search - text to search
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAEhE;;OAEG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,iBAAiB,IAAI,uBAAuB,CAAC;IAE7C;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAC;IAEhC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,SAAS,IAAI,iBAAiB,CAAC;IAE/B;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAC;IAE9B;;OAEG;IACH,UAAU,IAAI,yBAAyB,CAAC;IAExC;;OAEG;IACH,WAAW,IAAI,4BAA4B,CAAC;IAE5C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,aAAa,IAAI,8BAA8B,CAAC;IAEhD;;;OAGG;IACH,oBAAoB,IAAI,4BAA4B,CAAC;IAErD;;;OAGG;IACH,iBAAiB,IAAI,kCAAkC,CAAC;IAExD;;;OAGG;IACH,WAAW,IAAI,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,YAAY,IAAI,6BAA6B,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE1C;;;;OAIG;IACH,cAAc,IAAI,gBAAgB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAE9D;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,gBAAgB,CAAC;IAEtG;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAEhE;;OAEG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,iBAAiB,IAAI,uBAAuB,CAAC;IAE7C;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAC;IAEhC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,SAAS,IAAI,iBAAiB,CAAC;IAE/B;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAC;IAE9B;;OAEG;IACH,UAAU,IAAI,yBAAyB,CAAC;IAExC;;OAEG;IACH,WAAW,IAAI,4BAA4B,CAAC;IAE5C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,aAAa,IAAI,8BAA8B,CAAC;IAEhD;;;OAGG;IACH,oBAAoB,IAAI,4BAA4B,CAAC;IAErD;;;OAGG;IACH,iBAAiB,IAAI,kCAAkC,CAAC;IAExD;;;OAGG;IACH,WAAW,IAAI,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,YAAY,IAAI,6BAA6B,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE1C;;;;OAIG;IACH,cAAc,IAAI,gBAAgB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAE9D;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,sBAAsB,GAAG,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,uBAAuB,GAAG,gBAAgB,CAAC;IAEhE;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC"}
@@ -1,4 +1,4 @@
1
- import { IMetadataObject, ObjRef, IMeasureMetadataObject, IMeasureMetadataObjectDefinition, IInsight } from "@gooddata/sdk-model";
1
+ import { IMetadataObject, ObjRef, IMeasureMetadataObject, IMeasureMetadataObjectDefinition, IInsight, IMeasure } from "@gooddata/sdk-model";
2
2
  import { IMeasureExpressionToken } from "./measure.js";
3
3
  /**
4
4
  * Contains information about objects that may be referencing an measure. {@link IWorkspaceMeasuresService.getMeasureReferencingObjects} function.
@@ -9,6 +9,21 @@ export interface IMeasureReferencing {
9
9
  measures?: IMetadataObject[];
10
10
  insights?: IInsight[];
11
11
  }
12
+ /**
13
+ * Contains information about key drivers for a given measure.
14
+ *
15
+ * @alpha
16
+ */
17
+ export interface IMeasureKeyDrivers {
18
+ /**
19
+ * Labels for the key drivers
20
+ */
21
+ labels: string[];
22
+ /**
23
+ * Effects for the key drivers
24
+ */
25
+ effects: number[];
26
+ }
12
27
  /**
13
28
  * Service for create, update or delete measures and querying additional measures data.
14
29
  * If you want to query measures themselves, use catalog {@link IWorkspaceCatalogFactory}
@@ -16,6 +31,17 @@ export interface IMeasureReferencing {
16
31
  * @public
17
32
  */
18
33
  export interface IWorkspaceMeasuresService {
34
+ /**
35
+ * Compute key drivers for a given measure.
36
+ *
37
+ * @param metric - the measure to compute key drivers for
38
+ * @param sortDirection - the direction to sort the key drivers by
39
+ * @returns promise of the key drivers
40
+ * @alpha
41
+ */
42
+ computeKeyDrivers: (measure: IMeasure, options?: {
43
+ sortDirection: "ASC" | "DESC";
44
+ }) => Promise<IMeasureKeyDrivers>;
19
45
  /**
20
46
  * Get measure expression tokens for provided measure identifier
21
47
  * @param ref - ref of the measure
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/measures/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,eAAe,EACf,MAAM,EACN,sBAAsB,EACtB,gCAAgC,EAChC,QAAQ,EACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAE5E;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAEhF;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,4BAA4B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClF"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/measures/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,eAAe,EACf,MAAM,EACN,sBAAsB,EACtB,gCAAgC,EAChC,QAAQ,EACR,QAAQ,EACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;;;;OAOG;IACH,iBAAiB,EAAE,CACf,OAAO,EAAE,QAAQ,EACjB,OAAO,CAAC,EAAE;QACN,aAAa,EAAE,KAAK,GAAG,MAAM,CAAC;KACjC,KACA,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEjC;;;;OAIG;IACH,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAE5E;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAEhF;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,4BAA4B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-backend-spi",
3
- "version": "10.2.0-alpha.3",
3
+ "version": "10.2.0-alpha.31",
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.3"
27
+ "@gooddata/sdk-model": "10.2.0-alpha.31"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@gooddata/eslint-config": "^4.1.0",