@gooddata/sdk-backend-spi 11.48.0-alpha.0 → 11.48.0-alpha.2
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 +1 -2
- package/esm/index.d.ts.map +1 -1
- package/esm/sdk-backend-spi.d.ts +88 -0
- package/esm/workspace/dashboards/index.d.ts +1 -1
- package/esm/workspace/dashboards/index.d.ts.map +1 -1
- package/esm/workspace/execution/index.d.ts +127 -2
- package/esm/workspace/execution/index.d.ts.map +1 -1
- package/esm/workspace/styling/index.d.ts +65 -1
- package/esm/workspace/styling/index.d.ts.map +1 -1
- package/esm/workspace/styling/index.js +1 -0
- package/package.json +4 -4
- package/esm/workspace/execution/export.d.ts +0 -105
- package/esm/workspace/execution/export.d.ts.map +0 -1
- package/esm/workspace/execution/export.js +0 -2
package/esm/index.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ export type { IBackendCapabilities } from "./backend/capabilities.js";
|
|
|
12
12
|
export type { IUserSettings, IWorkspaceSettings, IUserWorkspaceSettings } from "./common/settings.js";
|
|
13
13
|
export type { IUserService } from "./user/index.js";
|
|
14
14
|
export type { IUserSettingsService } from "./user/settings/index.js";
|
|
15
|
-
export type { IPreparedExecutionOptions, IExecutionContext, IExecutionFactory, IPreparedExecution, IExecutionResult, IDataView, IForecastView, ExplainConfig, IExplainResult, IExplainProvider, ExplainType, IForecastResult, IForecastConfig, IAnomalyDetectionConfig, IAnomalyDetectionResult, IClusteringConfig, IClusteringResult, ICollectionItemsConfig, ICollectionItemsResult, IExecutionResultMetadata, IExecutionResultDataSourceMessage, IOutliersView, IOutliersConfig, IOutliersResult, IExecutionResultBinaryStreamConfig, ExecutionResultBinaryStreamFormat, } from "./workspace/execution/index.js";
|
|
15
|
+
export type { IPreparedExecutionOptions, IExecutionContext, IExecutionFactory, IPreparedExecution, IExecutionResult, IDataView, IForecastView, ExplainConfig, IExplainResult, IExplainProvider, ExplainType, IForecastResult, IForecastConfig, IAnomalyDetectionConfig, IAnomalyDetectionResult, IClusteringConfig, IClusteringResult, ICollectionItemsConfig, ICollectionItemsResult, IExecutionResultMetadata, IExecutionResultDataSourceMessage, IOutliersView, IOutliersConfig, IOutliersResult, IExecutionResultBinaryStreamConfig, ExecutionResultBinaryStreamFormat, IExportConfig, IExportResult, IExportPdfConfig, IExportAdditionalExecution, } from "./workspace/execution/index.js";
|
|
16
16
|
export type { IWorkspaceSettingsService } from "./workspace/settings/index.js";
|
|
17
17
|
export type { IWorkspaceParametersService, IParametersQuery, IParametersQueryResult, } from "./workspace/parameters/index.js";
|
|
18
18
|
export type { CancelableOptions, ICancelable } from "./cancelation/index.js";
|
|
@@ -20,7 +20,6 @@ export type { IGetInsightOptions, IGetVisualizationClassesOptions, IWorkspaceIns
|
|
|
20
20
|
export type { ExportDefinitionOrdering, IExportDefinitionsQuery, IExportDefinitionsQueryOptions, IExportDefinitionsQueryResult, IGetExportDefinitionOptions, IWorkspaceExportDefinitionsService, ExportDefinitionQuerySortDirection, ExportDefinitionQuerySortProperty, ExportDefinitionQuerySort, } from "./workspace/exportDefinitions/index.js";
|
|
21
21
|
export type { IWorkspaceExportTemplatesService } from "./workspace/exportTemplates/index.js";
|
|
22
22
|
export { type IElementsQueryFactory, type IElementsQueryResult, type IElementsQuery, type IElementsQueryOptions, type IElementsQueryAttributeFilter, type IElementsQueryOptionsElementsByUri, type IElementsQueryOptionsElementsByValue, type IElementsQueryOptionsElementsByPrimaryDisplayFormValue, type ElementsQueryOptionsElementsSpecification, type IFilterElementsQuery, type FilterWithResolvableElements, isElementsQueryOptionsElementsByValue, isElementsQueryOptionsElementsByPrimaryDisplayFormValue, isValueBasedElementsQueryOptionsElements, } from "./workspace/attributes/elements/index.js";
|
|
23
|
-
export type { IExportConfig, IExportResult, IExportPdfConfig } from "./workspace/execution/export.js";
|
|
24
23
|
export { type AnalyticsCatalogGenerateTitleObjectType, type IAnalyticsCatalogGenerateTitleRequest, type IAnalyticsCatalogGenerateTitleResponse, type IAnalyticsCatalogTrendingObject, type IAnalyticsCatalogTrendingObjects, type IKnowledgeDocumentsService, type IKnowledgeDocumentMetadata, type ICreateKnowledgeDocumentRequest, type IUpsertKnowledgeDocumentRequest, type IDeleteKnowledgeDocumentResponse, type IPatchKnowledgeDocumentRequest, type IKnowledgeSearchResult, type IKnowledgeSearchStatistics, type ISearchKnowledgeResponse, type ISearchKnowledgeOptions, type IListKnowledgeDocumentsOptions, type IKnowledgeDocumentsPage, type AnalyticsCatalogGenerateDescriptionObjectType, type IAnalyticsCatalogGenerateDescriptionRequest, type IAnalyticsCatalogGenerateDescriptionResponse, type IGenAIService, type IDashboardSummaryRequest, type IDashboardSummary, type IDashboardSummaryIncludedVisualization, type IDashboardSummaryExcludedVisualization, type IAnalyticsCatalogService, type IAnalyticsCatalogTags, type IAnalyticsCatalogCreatedBy, type ISemanticSearchQuery, type ISemanticSearchResult, type IChatThread, type IChatThreadHistory, type IChatThreadQuery, type IGenAIChatEvaluation, type ISemanticQualityService, type IMemoryItemsService, type IMemoryCreatedByUsers, type IMemoryItemsQuery, type IMemoryItemsFilterOptions, type IMemoryItemsQueryResult, type IChatConversationError, type IChatConversationThread, type IChatConversationThreadQuery, type IChatConversation, type IChatConversationCreateOptions, type IChatConversationItem, type IChatConversationItemsQuery, type IChatConversationItemsQueryResult, type IChatConversationFeedback, type IChatConversations, type IChatConversationContent, type IChatConversationMultipartContent, type IChatConversationKeyDriverAnalysisContent, type IChatConversationWhatIfContent, type IChatConversationReasoningContent, type IChatConversationMultipartPart, type IChatConversationToolCallContent, type IChatConversationTextContent, type IChatConversationToolResultContent, type IChatConversationVisualisationContent, type IChatConversationAlertProposalContent, type IChatConversationSearchContent, type IChatKdaDefinition, type IChatWhatIfDefinition, type IChatWhatIfAdjustment, type IChatWhatIfScenario, type IChatSuggestion, type IChatSuggestions, type IAlertProposal, isChatConversationError, isChatConversationItem, isChatConversationTextContent, isChatConversationReasoningContent, isChatConversationMultipartContent, isChatConversationToolCallContent, isChatConversationToolResultContent, isChatConversationVisualisationContent, isChatConversationKeyDriverAnalysisContent, isChatConversationWhatIfContent, isChatConversationSearchContent, isChatConversationAlertProposalContent, } from "./workspace/genAI/index.js";
|
|
25
24
|
export type { IOrganizationAIObservabilityMetric, IOrganizationAIObservabilityMetricType, IOrganizationAIObservabilityOverview, IOrganizationAIObservabilityService, IOrganizationGenAIService, } from "./organization/genAI/index.js";
|
|
26
25
|
export type { IReferencesResult, IReferencesOption, IReferencesService, } from "./workspace/references/index.js";
|
package/esm/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,OAAO,EACH,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,gBAAgB,GACnB,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,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,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,iCAAiC,EACjC,aAAa,EACb,eAAe,EACf,eAAe,EACf,kCAAkC,EAClC,iCAAiC,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,OAAO,EACH,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,gBAAgB,GACnB,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,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,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,iCAAiC,EACjC,aAAa,EACb,eAAe,EACf,eAAe,EACf,kCAAkC,EAClC,iCAAiC,EACjC,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,0BAA0B,GAC7B,MAAM,gCAAgC,CAAC;AAExC,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC/E,YAAY,EACR,2BAA2B,EAC3B,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE7E,YAAY,EACR,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,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC;AAE7F,OAAO,EACH,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAClC,KAAK,kCAAkC,EACvC,KAAK,oCAAoC,EACzC,KAAK,sDAAsD,EAC3D,KAAK,yCAAyC,EAC9C,KAAK,oBAAoB,EACzB,KAAK,4BAA4B,EACjC,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACH,KAAK,uCAAuC,EAC5C,KAAK,qCAAqC,EAC1C,KAAK,sCAAsC,EAC3C,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACnC,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,uBAAuB,EAC5B,KAAK,6CAA6C,EAClD,KAAK,2CAA2C,EAChD,KAAK,4CAA4C,EACjD,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,sCAAsC,EAC3C,KAAK,sCAAsC,EAC3C,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,iCAAiC,EACtC,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,iCAAiC,EACtC,KAAK,yCAAyC,EAC9C,KAAK,8BAA8B,EACnC,KAAK,iCAAiC,EACtC,KAAK,8BAA8B,EACnC,KAAK,gCAAgC,EACrC,KAAK,4BAA4B,EACjC,KAAK,kCAAkC,EACvC,KAAK,qCAAqC,EAC1C,KAAK,qCAAqC,EAC1C,KAAK,8BAA8B,EACnC,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,uBAAuB,EACvB,sBAAsB,EACtB,6BAA6B,EAC7B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,mCAAmC,EACnC,sCAAsC,EACtC,0CAA0C,EAC1C,+BAA+B,EAC/B,+BAA+B,EAC/B,sCAAsC,GACzC,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EACR,kCAAkC,EAClC,sCAAsC,EACtC,oCAAoC,EACpC,mCAAmC,EACnC,yBAAyB,GAC5B,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACR,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACrB,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EACH,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,mCAAmC,EACxC,KAAK,yCAAyC,EAC9C,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,UAAU,EACV,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,2BAA2B,EAC3B,YAAY,GACf,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,YAAY,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,YAAY,EACR,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAE9F,YAAY,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAE3E,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EACR,2BAA2B,EAC3B,wBAAwB,EACxB,gBAAgB,EAChB,6BAA6B,EAC7B,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EACR,yBAAyB,EACzB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,GACjB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EAAE,sBAAsB,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEzG,YAAY,EACR,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,8BAA8B,EAC9B,4BAA4B,EAC5B,mCAAmC,EACnC,YAAY,EACZ,8BAA8B,EAC9B,oCAAoC,EACpC,qCAAqC,GACxC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,KAAK,qBAAqB,EAC1B,KAAK,UAAU,EACf,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACR,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACR,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EACR,2BAA2B,EAC3B,cAAc,EACd,oBAAoB,EACpB,yBAAyB,GAC5B,MAAM,6BAA6B,CAAC;AAErC,YAAY,EACR,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC7E,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAClE,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAC9G,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC5G,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AACnF,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AACrF,YAAY,EAAE,mCAAmC,EAAE,MAAM,yCAAyC,CAAC;AAEnG,YAAY,EACR,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AACzF,YAAY,EACR,wBAAwB,EACxB,kCAAkC,GACrC,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACR,8BAA8B,EAC9B,sBAAsB,GACzB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AAC5G,YAAY,EAAE,kCAAkC,EAAE,MAAM,wCAAwC,CAAC;AACjG,YAAY,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAC5F,YAAY,EACR,0BAA0B,EAC1B,gCAAgC,EAChC,0CAA0C,GAC7C,MAAM,8CAA8C,CAAC;AACtD,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,YAAY,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE5F,YAAY,EACR,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,kCAAkC,CAAC;AAE1C,YAAY,EACR,8BAA8B,EAC9B,6BAA6B,EAC7B,mCAAmC,GACtC,MAAM,qCAAqC,CAAC;AAE7C,YAAY,EACR,0BAA0B,EAC1B,YAAY,EACZ,kBAAkB,GACrB,MAAM,gCAAgC,CAAC;AAExC,YAAY,EACR,cAAc,EACd,oBAAoB,EACpB,2BAA2B,GAC9B,MAAM,yBAAyB,CAAC;AAEjC,YAAY,EACR,kCAAkC,EAClC,sBAAsB,EACtB,UAAU,EACV,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,gCAAgC,EAChC,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,sCAAsC,CAAC;AAE9C,YAAY,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AAC9F,YAAY,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC"}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -3716,6 +3716,18 @@ export declare type IExplainResult = {
|
|
|
3716
3716
|
["SQL"]: string;
|
|
3717
3717
|
};
|
|
3718
3718
|
|
|
3719
|
+
/**
|
|
3720
|
+
* A single pre-executed additional layer in a multi-layer tabular export.
|
|
3721
|
+
*
|
|
3722
|
+
* @alpha
|
|
3723
|
+
*/
|
|
3724
|
+
export declare interface IExportAdditionalExecution {
|
|
3725
|
+
/** Already-executed result for this layer. */
|
|
3726
|
+
executionResult: IExecutionResult;
|
|
3727
|
+
/** Layer title used for the exported sheet or file name. */
|
|
3728
|
+
title?: string;
|
|
3729
|
+
}
|
|
3730
|
+
|
|
3719
3731
|
/**
|
|
3720
3732
|
* Configuration for exports of results into tabular formats.
|
|
3721
3733
|
*
|
|
@@ -3781,6 +3793,18 @@ export declare interface IExportConfig {
|
|
|
3781
3793
|
* We recommend not setting this lower than 5 seconds as it would mean only one attempt would be made.
|
|
3782
3794
|
*/
|
|
3783
3795
|
timeout?: number;
|
|
3796
|
+
/**
|
|
3797
|
+
* Pre-executed additional layers for multi-layer geo visualizations.
|
|
3798
|
+
*
|
|
3799
|
+
* @remarks
|
|
3800
|
+
* When set, the export includes one sheet (XLSX) or file (CSV zip) per layer. The result
|
|
3801
|
+
* that {@link IExecutionResult.export} is called on is the main layer (index 0); these are
|
|
3802
|
+
* the additional layers, in their original order. Each layer carries its own execution result
|
|
3803
|
+
* so the backend can build per-layer overrides.
|
|
3804
|
+
*
|
|
3805
|
+
* @alpha
|
|
3806
|
+
*/
|
|
3807
|
+
additionalExecutions?: ReadonlyArray<IExportAdditionalExecution>;
|
|
3784
3808
|
}
|
|
3785
3809
|
|
|
3786
3810
|
/**
|
|
@@ -9537,6 +9561,11 @@ export declare interface IWorkspaceStylingService {
|
|
|
9537
9561
|
/**
|
|
9538
9562
|
* Set active theme setting in workspace.
|
|
9539
9563
|
*
|
|
9564
|
+
* @remarks
|
|
9565
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceTheme"` activates a
|
|
9566
|
+
* workspace-scoped theme, otherwise the theme is treated as organization-scoped. There is no
|
|
9567
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
9568
|
+
*
|
|
9540
9569
|
* @param themeRef - active theme reference
|
|
9541
9570
|
* @returns promise
|
|
9542
9571
|
*/
|
|
@@ -9556,6 +9585,11 @@ export declare interface IWorkspaceStylingService {
|
|
|
9556
9585
|
/**
|
|
9557
9586
|
* Set active color palette setting in workspace.
|
|
9558
9587
|
*
|
|
9588
|
+
* @remarks
|
|
9589
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceColorPalette"` activates a
|
|
9590
|
+
* workspace-scoped color palette, otherwise it is treated as organization-scoped. There is no
|
|
9591
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
9592
|
+
*
|
|
9559
9593
|
* @param colorPaletteRef - active color palette reference
|
|
9560
9594
|
* @returns promise
|
|
9561
9595
|
*/
|
|
@@ -9566,6 +9600,60 @@ export declare interface IWorkspaceStylingService {
|
|
|
9566
9600
|
* @returns promise
|
|
9567
9601
|
*/
|
|
9568
9602
|
clearActiveColorPalette(): Promise<void>;
|
|
9603
|
+
/**
|
|
9604
|
+
* Request all themes defined on the workspace level.
|
|
9605
|
+
*
|
|
9606
|
+
* @returns promise of array of theme metadata objects
|
|
9607
|
+
*/
|
|
9608
|
+
getThemes(): Promise<IThemeMetadataObject[]>;
|
|
9609
|
+
/**
|
|
9610
|
+
* Create a new theme on the workspace level.
|
|
9611
|
+
*
|
|
9612
|
+
* @param theme - theme definition
|
|
9613
|
+
* @returns promise of the created theme metadata object
|
|
9614
|
+
*/
|
|
9615
|
+
createTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
9616
|
+
/**
|
|
9617
|
+
* Update an existing theme on the workspace level.
|
|
9618
|
+
*
|
|
9619
|
+
* @param theme - theme definition
|
|
9620
|
+
* @returns promise of the updated theme metadata object
|
|
9621
|
+
*/
|
|
9622
|
+
updateTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
9623
|
+
/**
|
|
9624
|
+
* Delete a theme on the workspace level.
|
|
9625
|
+
*
|
|
9626
|
+
* @param themeRef - theme reference
|
|
9627
|
+
* @returns promise
|
|
9628
|
+
*/
|
|
9629
|
+
deleteTheme(themeRef: ObjRef): Promise<void>;
|
|
9630
|
+
/**
|
|
9631
|
+
* Request all color palettes defined on the workspace level.
|
|
9632
|
+
*
|
|
9633
|
+
* @returns promise of array of color palette metadata objects
|
|
9634
|
+
*/
|
|
9635
|
+
getColorPalettes(): Promise<IColorPaletteMetadataObject[]>;
|
|
9636
|
+
/**
|
|
9637
|
+
* Create a new color palette on the workspace level.
|
|
9638
|
+
*
|
|
9639
|
+
* @param colorPalette - color palette definition
|
|
9640
|
+
* @returns promise of the created color palette metadata object
|
|
9641
|
+
*/
|
|
9642
|
+
createColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
9643
|
+
/**
|
|
9644
|
+
* Update an existing color palette on the workspace level.
|
|
9645
|
+
*
|
|
9646
|
+
* @param colorPalette - color palette definition
|
|
9647
|
+
* @returns promise of the updated color palette metadata object
|
|
9648
|
+
*/
|
|
9649
|
+
updateColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
9650
|
+
/**
|
|
9651
|
+
* Delete a color palette on the workspace level.
|
|
9652
|
+
*
|
|
9653
|
+
* @param colorPaletteRef - color palette reference
|
|
9654
|
+
* @returns promise
|
|
9655
|
+
*/
|
|
9656
|
+
deleteColorPalette(colorPaletteRef: ObjRef): Promise<void>;
|
|
9569
9657
|
}
|
|
9570
9658
|
|
|
9571
9659
|
/**
|
|
@@ -2,7 +2,7 @@ import type { CatalogItem, FilterContextItem, IDashboard, IDashboardAttributeFil
|
|
|
2
2
|
import type { IFilterBaseOptions } from "../../common/filtering.js";
|
|
3
3
|
import type { IPagedResource } from "../../common/paging.js";
|
|
4
4
|
import type { QueryMethod } from "../../common/query.js";
|
|
5
|
-
import type { IExportResult } from "../execution/
|
|
5
|
+
import type { IExportResult } from "../execution/index.js";
|
|
6
6
|
/**
|
|
7
7
|
* Dashboard referenced objects
|
|
8
8
|
* @alpha
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/dashboards/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,+BAA+B,EAC/B,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,oBAAoB,EACpB,+BAA+B,EAC/B,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,sBAAsB,EACtB,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACP,cAAc,EACd,wBAAwB,EACxB,QAAQ,EACR,gBAAgB,EAChB,yBAAyB,EACzB,cAAc,EACd,wBAAwB,EACxB,OAAO,EACP,YAAY,EACZ,sBAAsB,EACtB,MAAM,EACN,YAAY,EACZ,UAAU,EACb,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/dashboards/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,+BAA+B,EAC/B,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,oBAAoB,EACpB,+BAA+B,EAC/B,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,sBAAsB,EACtB,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACP,cAAc,EACd,wBAAwB,EACxB,QAAQ,EACR,gBAAgB,EAChB,yBAAyB,EACzB,cAAc,EACd,wBAAwB,EACxB,OAAO,EACP,YAAY,EACZ,sBAAsB,EACtB,MAAM,EACN,YAAY,EACZ,UAAU,EACb,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,QAAQ,EAAE,QAAQ,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,SAAS,EAAE,UAAU,CAAC;IACtB,UAAU,EAAE,oBAAoB,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,OAAO,CAC/C,UAAU,EACR,MAAM,GACN,WAAW,GACX,aAAa,GACb,SAAS,GACT,KAAK,GACL,SAAS,GACT,UAAU,GACV,cAAc,GACd,oBAAoB,CACzB,CAAC;AAGF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG,SAAS,GAAG,iBAAiB,GAAG,SAAS,CAAC;AAEzF;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAEpD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;CAC3D;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,wBAAwB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE/C;;OAEG;IACH,6BAA6B,CAAC,EAAE,YAAY,CAAC;IAE7C;;;OAGG;IACH,gCAAgC,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,CAAC,CAAC;IAE/E;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACf,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,QAAQ,CAAC;QAClC,eAAe,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;QAC3C,YAAY,CAAC,EAAE,OAAO,CAAC;KAC1B,CAAC;IAEF;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,CAAC,CAAC;IAE9D;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,CAAC,CAAC;IAE9D;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAChD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,CAAC,CAAC;IAE9D;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAE9F;;;;GAIG;AACH,MAAM,WAAW,oCAAoC;IACjD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,8BAA8B,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAsC,SAAQ,oCAAoC;IAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EACP,YAAY,GACZ,iBAAiB,GACjB,eAAe,GACf,sBAAsB,GACtB,UAAU,GACV,IAAI,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAE3E;;;;OAIG;IACH,kBAAkB,IAAI,gBAAgB,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE1G;;;;;;;;;;OAUG;IACH,0BAA0B,CACtB,GAAG,EAAE,MAAM,EACX,gBAAgB,CAAC,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,oBAAoB,EAC9B,KAAK,CAAC,EAAE,gCAAgC,EAAE,GAC3C,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,6BAA6B,CACzB,SAAS,EAAE,UAAU,EACrB,KAAK,CAAC,EAAE,gCAAgC,EAAE,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,0BAA0B,CACtB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,EACrC,KAAK,CAAC,EAAE,MAAM,GACf,OAAO,CAAC;QACP,aAAa,CAAC,EAAE,cAAc,CAAC;QAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC3C,GAAG,IAAI,CAAC,CAAC;IAEV;;;;;OAKG;IACH,eAAe,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEtE;;;;;;OAMG;IACH,eAAe,CAAC,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpG;;;;;OAKG;IACH,mBAAmB,CACf,gBAAgB,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC,GACrE,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvB;;;;;OAKG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExF;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;;;;;OAUG;IACH,oBAAoB,CAChB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,EAAE,EAC7B,YAAY,CAAC,EAAE,YAAY,EAC3B,OAAO,CAAC,EAAE,0BAA0B,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1B;;;;;;;;;;;;OAYG;IACH,6BAA6B,CACzB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,KAAK,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,iBAAiB,EAAE,EAC7B,YAAY,CAAC,EAAE,YAAY,EAC3B,OAAO,CAAC,EAAE,mCAAmC,GAC9C,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1B;;;;;;;;;;;OAWG;IAEH,sBAAsB,CAClB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,EAAE,EAC7B,YAAY,CAAC,EAAE,YAAY,EAC3B,OAAO,CAAC,EAAE,4BAA4B,GACvC,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1B;;;;;;;;;OASG;IACH,wBAAwB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAExG;;;;;;;;;;OAUG;IACH,uBAAuB,CACnB,UAAU,EAAE,oBAAoB,EAChC,QAAQ,EAAE,MAAM,EAChB,eAAe,CAAC,EAAE,yBAAyB,EAC3C,OAAO,CAAC,EAAE,0BAA0B,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1B;;;;;;OAMG;IACH,mBAAmB,CACf,aAAa,EAAE,wBAAwB,EACvC,mBAAmB,CAAC,EAAE,wBAAwB,GAC/C,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;OAOG;IACH,mBAAmB,CACf,GAAG,EAAE,MAAM,EACX,aAAa,EAAE,wBAAwB,EACvC,gBAAgB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,6BAA6B,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1G;;;;;OAKG;IACH,kCAAkC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjE;;;;OAIG;IACH,gCAAgC,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE5D;;;;;OAKG;IACH,sCAAsC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAExE;;;;;OAKG;IACH,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEvF;;;;;OAKG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,0BAA0B,CACtB,MAAM,EAAE,OAAO,EACf,KAAK,CAAC,EAAE,6BAA6B,EAAE,GACxC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE9B;;;;;;;;;;;;;;OAcG;IACH,2BAA2B,CACvB,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,OAAO,EAAE,EAClB,sBAAsB,EAAE,+BAA+B,EAAE,GAC1D,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,kDAAkD,CAC9C,MAAM,EAAE,OAAO,EACf,iBAAiB,EAAE,WAAW,EAAE,EAChC,YAAY,EAAE,OAAO,EAAE,EACvB,sBAAsB,EAAE,+BAA+B,EAAE,GAC1D,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEtB;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAEvF;;;;;OAKG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEjG;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAErF;;;;;;;OAOG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAErE;;;;;OAKG;IACH,2BAA2B,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAEpF;;;;OAIG;IACH,4BAA4B,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAEpF;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,+BAA+B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE7F;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;;OAQG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvE;;;OAGG;IACH,6BAA6B,CAAC,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;IAEnG;;;;OAIG;IACH,iCAAiC,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,qCAAqC,CAAC,CAAC;CACrG;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEzC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEzC;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;IAEzD;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IAE9C;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IAEjD;;;;;OAKG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IAEzD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,gBAAgB,CAAC;IAEnE;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,gBAAgB,CAAC;IAElD;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { type DataValue, type DimensionGenerator, type GeoCollectionKind, type IAttributeOrMeasure, type IBucket, type IDimension, type IDimensionDescriptor, type IExecutionConfig, type IExecutionDefinition, type IExecutionResultLimitBreak, type IGeoJsonFeature, type IInsight, type IInsightDefinition, type IMeasureDescriptor, type INullableFilter, type IResultHeader, type IResultWarning, type ISortItem } from "@gooddata/sdk-model";
|
|
1
|
+
import { type DataValue, type DimensionGenerator, type GeoCollectionKind, type IAttributeOrMeasure, type IBucket, type IDimension, type IDimensionDescriptor, type IExecutionConfig, type IExecutionDefinition, type IExecutionResultLimitBreak, type IFilter, type IGeoJsonFeature, type IInsight, type IInsightDefinition, type IMeasureDescriptor, type INullableFilter, type IResultHeader, type IResultWarning, type ISortItem } from "@gooddata/sdk-model";
|
|
2
2
|
import { type ICancelable } from "../../cancelation/index.js";
|
|
3
|
-
import { type IExportConfig, type IExportResult } from "./export.js";
|
|
4
3
|
/**
|
|
5
4
|
* @beta
|
|
6
5
|
*/
|
|
@@ -460,6 +459,132 @@ export interface IPreparedExecution extends ICancelable<IPreparedExecution> {
|
|
|
460
459
|
*/
|
|
461
460
|
withContext(context: IExecutionContext): IPreparedExecution;
|
|
462
461
|
}
|
|
462
|
+
/**
|
|
463
|
+
* Configuration for exports of results into tabular formats.
|
|
464
|
+
*
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
export interface IExportConfig {
|
|
468
|
+
/**
|
|
469
|
+
* Format of the export file. Defaults to CSV if not specified.
|
|
470
|
+
*/
|
|
471
|
+
format?: "xlsx" | "csv" | "raw" | "pdf";
|
|
472
|
+
/**
|
|
473
|
+
* Applicable for XLSX format; specifies title of the workbook.
|
|
474
|
+
*/
|
|
475
|
+
title?: string;
|
|
476
|
+
/**
|
|
477
|
+
* Applicable for CSV format; specifies the delimiter to use between values.
|
|
478
|
+
*/
|
|
479
|
+
delimiter?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Applicable for XLSX format; indicates whether headers and cells in the sheet
|
|
482
|
+
* should be merged.
|
|
483
|
+
*/
|
|
484
|
+
mergeHeaders?: boolean;
|
|
485
|
+
/**
|
|
486
|
+
* Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in
|
|
487
|
+
* the Excel sheet.
|
|
488
|
+
*
|
|
489
|
+
* @remarks
|
|
490
|
+
* Filters provided here are purely to paint a better context for the
|
|
491
|
+
* person looking at the exported file. They serve no other purpose and are merely serialized
|
|
492
|
+
* in the export in a human-readable form.
|
|
493
|
+
* The visualizationObjectId has to be provided to make this work for PDF format.
|
|
494
|
+
*/
|
|
495
|
+
showFilters?: boolean;
|
|
496
|
+
/**
|
|
497
|
+
* Applicable for PDF format; specifies configuration for PDF export.
|
|
498
|
+
*/
|
|
499
|
+
pdfConfiguration?: IExportPdfConfig;
|
|
500
|
+
/**
|
|
501
|
+
* Visualization object identifier. Used to ensure the export result is generated based on
|
|
502
|
+
* existing visualization in the PDF document. (PDF only)
|
|
503
|
+
*/
|
|
504
|
+
visualizationObjectId?: string;
|
|
505
|
+
/**
|
|
506
|
+
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied
|
|
507
|
+
* when visualizationObject is given. (PDF only)
|
|
508
|
+
*/
|
|
509
|
+
visualizationObjectCustomFilters?: Array<IFilter>;
|
|
510
|
+
/**
|
|
511
|
+
* Position of grand totals in the exported document.
|
|
512
|
+
*
|
|
513
|
+
* @remarks
|
|
514
|
+
* Takes precedence over the position specified in the visualization object.
|
|
515
|
+
* Applicable to all tabular export formats (XLSX, CSV, PDF).
|
|
516
|
+
*/
|
|
517
|
+
grandTotalsPosition?: "pinnedBottom" | "pinnedTop" | "bottom" | "top";
|
|
518
|
+
/**
|
|
519
|
+
* Override the default export result polling timeout (in milliseconds).
|
|
520
|
+
*
|
|
521
|
+
* @remarks
|
|
522
|
+
* If not specified, there is still a default timeout applied.
|
|
523
|
+
* You can use this to make the timeout more aggressive or more relaxed than the default.
|
|
524
|
+
* We recommend not setting this lower than 5 seconds as it would mean only one attempt would be made.
|
|
525
|
+
*/
|
|
526
|
+
timeout?: number;
|
|
527
|
+
/**
|
|
528
|
+
* Pre-executed additional layers for multi-layer geo visualizations.
|
|
529
|
+
*
|
|
530
|
+
* @remarks
|
|
531
|
+
* When set, the export includes one sheet (XLSX) or file (CSV zip) per layer. The result
|
|
532
|
+
* that {@link IExecutionResult.export} is called on is the main layer (index 0); these are
|
|
533
|
+
* the additional layers, in their original order. Each layer carries its own execution result
|
|
534
|
+
* so the backend can build per-layer overrides.
|
|
535
|
+
*
|
|
536
|
+
* @alpha
|
|
537
|
+
*/
|
|
538
|
+
additionalExecutions?: ReadonlyArray<IExportAdditionalExecution>;
|
|
539
|
+
}
|
|
540
|
+
/**
|
|
541
|
+
* A single pre-executed additional layer in a multi-layer tabular export.
|
|
542
|
+
*
|
|
543
|
+
* @alpha
|
|
544
|
+
*/
|
|
545
|
+
export interface IExportAdditionalExecution {
|
|
546
|
+
/** Already-executed result for this layer. */
|
|
547
|
+
executionResult: IExecutionResult;
|
|
548
|
+
/** Layer title used for the exported sheet or file name. */
|
|
549
|
+
title?: string;
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* Configuration for PDF export.
|
|
553
|
+
*
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
export interface IExportPdfConfig {
|
|
557
|
+
/** Page size and orientation (e.g. 'a4 landscape'). @deprecated Use pageSize and pageOrientation instead. */
|
|
558
|
+
pdfPageSize?: string;
|
|
559
|
+
/** PDF top left header content. @deprecated This property is no longer supported. */
|
|
560
|
+
pdfTopLeftContent?: string;
|
|
561
|
+
/** PDF top right header content. @deprecated This property is no longer supported. */
|
|
562
|
+
pdfTopRightContent?: string;
|
|
563
|
+
/** Page size */
|
|
564
|
+
pageSize?: "A3" | "A4" | "LETTER";
|
|
565
|
+
/** Page orientation */
|
|
566
|
+
pageOrientation?: "PORTRAIT" | "LANDSCAPE";
|
|
567
|
+
/** Show info page with export information. */
|
|
568
|
+
showInfoPage?: boolean;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* Result of export is an object URL pointing to a Blob of downloaded data attached to the current
|
|
572
|
+
* window instance. The result also contains name of the downloaded file provided by the backend export
|
|
573
|
+
* service.
|
|
574
|
+
*
|
|
575
|
+
* {@link URL#revokeObjectURL} method must be used when object URL is no longer needed to release
|
|
576
|
+
* the blob memory.
|
|
577
|
+
*
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
export interface IExportResult {
|
|
581
|
+
/** URI from which can the export be fetched again */
|
|
582
|
+
uri: string;
|
|
583
|
+
/** Object URL pointing to the downloaded blob of exported data */
|
|
584
|
+
objectUrl: string;
|
|
585
|
+
/** Name of the exported file provided by the export service */
|
|
586
|
+
fileName?: string;
|
|
587
|
+
}
|
|
463
588
|
/**
|
|
464
589
|
* Represents results of execution done with particular definition.
|
|
465
590
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,SAAS,EACd,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,SAAS,EACjB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAE9D
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,SAAS,EACd,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,SAAS,EACjB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAE9D;;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,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC7B,UAAU,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACjC,UAAU,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACjC,UAAU,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,WAAW,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACvC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;QACxB,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;KAChC,EAAE,CAAC;CACP;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,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC7B,WAAW,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC/B,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC7B,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,eAAe,EAAE,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAC9C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,aAAa,CAAC,iCAAiC,CAAC,CAAC;IAC9E;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;CACpE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,iCAAiC,GAAG,cAAc,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAC/C;;OAEG;IACH,MAAM,CAAC,EAAE,iCAAiC,CAAC;CAC9C;AAED;;;;GAIG;AACH;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,kBAAkB,CAAC;IAElG;;;;;;;;;;;OAWG;IACH,QAAQ,CACJ,KAAK,EAAE,mBAAmB,EAAE,EAC5B,OAAO,CAAC,EAAE,eAAe,EAAE,EAC3B,OAAO,CAAC,EAAE,yBAAyB,GACpC,kBAAkB,CAAC;IAEtB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,CACN,OAAO,EAAE,OAAO,EAAE,EAClB,OAAO,CAAC,EAAE,eAAe,EAAE,EAC3B,OAAO,CAAC,EAAE,yBAAyB,GACpC,kBAAkB,CAAC;IAEtB;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACN,iBAAiB,EAAE,kBAAkB,EACrC,OAAO,CAAC,EAAE,eAAe,EAAE,EAC3B,OAAO,CAAC,EAAE,yBAAyB,GACpC,kBAAkB,CAAC;IAEtB;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,CACX,OAAO,EAAE,QAAQ,EACjB,OAAO,CAAC,EAAE,eAAe,EAAE,EAC3B,OAAO,CAAC,EAAE,yBAAyB,GACpC,kBAAkB,CAAC;CACzB;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;IAE1B,IAAI,IAAI,OAAO,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChF;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW,CAAC,kBAAkB,CAAC;IACvE;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAErC;;;;;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,CAAC,OAAO,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpD;;;;;;;;;;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;IAE7D;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;CAC/D;AAED;;;;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;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,gCAAgC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEtE;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;CACpE;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC,8CAA8C;IAC9C,eAAe,EAAE,gBAAgB,CAAC;IAClC,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,6GAA6G;IAC7G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qFAAqF;IACrF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sFAAsF;IACtF,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,QAAQ,CAAC;IAClC,uBAAuB;IACvB,eAAe,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAC3C,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;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;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW,CAAC,gBAAgB,CAAC;IACnE;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,EAAE,CAAC;IAE5C;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE9B;;;;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,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;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,kCAAkC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEzF;;;;;;;;;;;;;;;;;;;;;;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;IAEtB;;;;;;;;;OASG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;CAClC;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;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,wBAAwB,CAAC;IAE5C;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,eAAe,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,eAAe,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,eAAe,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,eAAe,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IAE9C;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IAE9C;;;;;;;;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;;;;OAIG;IACH,UAAU,IAAI,iBAAiB,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,IAAI,aAAa,CAAC;IAE1B;;;;;;;OAOG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAE5E;;;;;;OAMG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAElF;;;;;;OAMG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAE5E;;;;;;;OAOG;IACH,mBAAmB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACxF;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;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,WAAW,EAAE,CAAC,aAAa,GAAG,kBAAkB,CAAC,EAAE,CAAC;IACpD,SAAS,EAAE,SAAS,EAAE,EAAE,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;CACpB"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type IColorPalette, type ITheme, type ObjRef } from "@gooddata/sdk-model";
|
|
1
|
+
import { type IColorPalette, type IColorPaletteDefinition, type IColorPaletteMetadataObject, type ITheme, type IThemeDefinition, type IThemeMetadataObject, type ObjRef } from "@gooddata/sdk-model";
|
|
2
2
|
/**
|
|
3
3
|
* This service provides access to workspace styling settings such as color palette.
|
|
4
4
|
*
|
|
@@ -31,6 +31,11 @@ export interface IWorkspaceStylingService {
|
|
|
31
31
|
/**
|
|
32
32
|
* Set active theme setting in workspace.
|
|
33
33
|
*
|
|
34
|
+
* @remarks
|
|
35
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceTheme"` activates a
|
|
36
|
+
* workspace-scoped theme, otherwise the theme is treated as organization-scoped. There is no
|
|
37
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
38
|
+
*
|
|
34
39
|
* @param themeRef - active theme reference
|
|
35
40
|
* @returns promise
|
|
36
41
|
*/
|
|
@@ -50,6 +55,11 @@ export interface IWorkspaceStylingService {
|
|
|
50
55
|
/**
|
|
51
56
|
* Set active color palette setting in workspace.
|
|
52
57
|
*
|
|
58
|
+
* @remarks
|
|
59
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceColorPalette"` activates a
|
|
60
|
+
* workspace-scoped color palette, otherwise it is treated as organization-scoped. There is no
|
|
61
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
62
|
+
*
|
|
53
63
|
* @param colorPaletteRef - active color palette reference
|
|
54
64
|
* @returns promise
|
|
55
65
|
*/
|
|
@@ -60,5 +70,59 @@ export interface IWorkspaceStylingService {
|
|
|
60
70
|
* @returns promise
|
|
61
71
|
*/
|
|
62
72
|
clearActiveColorPalette(): Promise<void>;
|
|
73
|
+
/**
|
|
74
|
+
* Request all themes defined on the workspace level.
|
|
75
|
+
*
|
|
76
|
+
* @returns promise of array of theme metadata objects
|
|
77
|
+
*/
|
|
78
|
+
getThemes(): Promise<IThemeMetadataObject[]>;
|
|
79
|
+
/**
|
|
80
|
+
* Create a new theme on the workspace level.
|
|
81
|
+
*
|
|
82
|
+
* @param theme - theme definition
|
|
83
|
+
* @returns promise of the created theme metadata object
|
|
84
|
+
*/
|
|
85
|
+
createTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
86
|
+
/**
|
|
87
|
+
* Update an existing theme on the workspace level.
|
|
88
|
+
*
|
|
89
|
+
* @param theme - theme definition
|
|
90
|
+
* @returns promise of the updated theme metadata object
|
|
91
|
+
*/
|
|
92
|
+
updateTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
93
|
+
/**
|
|
94
|
+
* Delete a theme on the workspace level.
|
|
95
|
+
*
|
|
96
|
+
* @param themeRef - theme reference
|
|
97
|
+
* @returns promise
|
|
98
|
+
*/
|
|
99
|
+
deleteTheme(themeRef: ObjRef): Promise<void>;
|
|
100
|
+
/**
|
|
101
|
+
* Request all color palettes defined on the workspace level.
|
|
102
|
+
*
|
|
103
|
+
* @returns promise of array of color palette metadata objects
|
|
104
|
+
*/
|
|
105
|
+
getColorPalettes(): Promise<IColorPaletteMetadataObject[]>;
|
|
106
|
+
/**
|
|
107
|
+
* Create a new color palette on the workspace level.
|
|
108
|
+
*
|
|
109
|
+
* @param colorPalette - color palette definition
|
|
110
|
+
* @returns promise of the created color palette metadata object
|
|
111
|
+
*/
|
|
112
|
+
createColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
113
|
+
/**
|
|
114
|
+
* Update an existing color palette on the workspace level.
|
|
115
|
+
*
|
|
116
|
+
* @param colorPalette - color palette definition
|
|
117
|
+
* @returns promise of the updated color palette metadata object
|
|
118
|
+
*/
|
|
119
|
+
updateColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
120
|
+
/**
|
|
121
|
+
* Delete a color palette on the workspace level.
|
|
122
|
+
*
|
|
123
|
+
* @param colorPaletteRef - color palette reference
|
|
124
|
+
* @returns promise
|
|
125
|
+
*/
|
|
126
|
+
deleteColorPalette(colorPaletteRef: ObjRef): Promise<void>;
|
|
63
127
|
}
|
|
64
128
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/styling/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/styling/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACd,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;;OAIG;IACH,qBAAqB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAErD;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,kBAAkB,CAAC,YAAY,EAAE,uBAAuB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,kBAAkB,CAAC,YAAY,EAAE,uBAAuB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "11.48.0-alpha.
|
|
3
|
+
"version": "11.48.0-alpha.2",
|
|
4
4
|
"description": "GoodData Backend SPI abstraction interfaces",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "GoodData",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"lodash-es": "^4.17.23",
|
|
25
25
|
"ts-invariant": "0.10.3",
|
|
26
26
|
"tslib": "2.8.1",
|
|
27
|
-
"@gooddata/sdk-model": "11.48.0-alpha.
|
|
27
|
+
"@gooddata/sdk-model": "11.48.0-alpha.2"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@microsoft/api-documenter": "^7.17.0",
|
|
@@ -48,8 +48,8 @@
|
|
|
48
48
|
"oxlint-tsgolint": "0.15.0",
|
|
49
49
|
"typescript": "5.9.3",
|
|
50
50
|
"vitest": "4.1.8",
|
|
51
|
-
"@gooddata/
|
|
52
|
-
"@gooddata/
|
|
51
|
+
"@gooddata/eslint-config": "11.48.0-alpha.2",
|
|
52
|
+
"@gooddata/oxlint-config": "11.48.0-alpha.2"
|
|
53
53
|
},
|
|
54
54
|
"scripts": {
|
|
55
55
|
"_phase:build": "npm run build",
|
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
import { type IFilter } from "@gooddata/sdk-model";
|
|
2
|
-
/**
|
|
3
|
-
* Configuration for exports of results into tabular formats.
|
|
4
|
-
*
|
|
5
|
-
* @public
|
|
6
|
-
*/
|
|
7
|
-
export interface IExportConfig {
|
|
8
|
-
/**
|
|
9
|
-
* Format of the export file. Defaults to CSV if not specified.
|
|
10
|
-
*/
|
|
11
|
-
format?: "xlsx" | "csv" | "raw" | "pdf";
|
|
12
|
-
/**
|
|
13
|
-
* Applicable for XLSX format; specifies title of the workbook.
|
|
14
|
-
*/
|
|
15
|
-
title?: string;
|
|
16
|
-
/**
|
|
17
|
-
* Applicable for CSV format; specifies the delimiter to use between values.
|
|
18
|
-
*/
|
|
19
|
-
delimiter?: string;
|
|
20
|
-
/**
|
|
21
|
-
* Applicable for XLSX format; indicates whether headers and cells in the sheet
|
|
22
|
-
* should be merged.
|
|
23
|
-
*/
|
|
24
|
-
mergeHeaders?: boolean;
|
|
25
|
-
/**
|
|
26
|
-
* Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in
|
|
27
|
-
* the Excel sheet.
|
|
28
|
-
*
|
|
29
|
-
* @remarks
|
|
30
|
-
* Filters provided here are purely to paint a better context for the
|
|
31
|
-
* person looking at the exported file. They serve no other purpose and are merely serialized
|
|
32
|
-
* in the export in a human-readable form.
|
|
33
|
-
* The visualizationObjectId has to be provided to make this work for PDF format.
|
|
34
|
-
*/
|
|
35
|
-
showFilters?: boolean;
|
|
36
|
-
/**
|
|
37
|
-
* Applicable for PDF format; specifies configuration for PDF export.
|
|
38
|
-
*/
|
|
39
|
-
pdfConfiguration?: IExportPdfConfig;
|
|
40
|
-
/**
|
|
41
|
-
* Visualization object identifier. Used to ensure the export result is generated based on
|
|
42
|
-
* existing visualization in the PDF document. (PDF only)
|
|
43
|
-
*/
|
|
44
|
-
visualizationObjectId?: string;
|
|
45
|
-
/**
|
|
46
|
-
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied
|
|
47
|
-
* when visualizationObject is given. (PDF only)
|
|
48
|
-
*/
|
|
49
|
-
visualizationObjectCustomFilters?: Array<IFilter>;
|
|
50
|
-
/**
|
|
51
|
-
* Position of grand totals in the exported document.
|
|
52
|
-
*
|
|
53
|
-
* @remarks
|
|
54
|
-
* Takes precedence over the position specified in the visualization object.
|
|
55
|
-
* Applicable to all tabular export formats (XLSX, CSV, PDF).
|
|
56
|
-
*/
|
|
57
|
-
grandTotalsPosition?: "pinnedBottom" | "pinnedTop" | "bottom" | "top";
|
|
58
|
-
/**
|
|
59
|
-
* Override the default export result polling timeout (in milliseconds).
|
|
60
|
-
*
|
|
61
|
-
* @remarks
|
|
62
|
-
* If not specified, there is still a default timeout applied.
|
|
63
|
-
* You can use this to make the timeout more aggressive or more relaxed than the default.
|
|
64
|
-
* We recommend not setting this lower than 5 seconds as it would mean only one attempt would be made.
|
|
65
|
-
*/
|
|
66
|
-
timeout?: number;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Configuration for PDF export.
|
|
70
|
-
*
|
|
71
|
-
* @public
|
|
72
|
-
*/
|
|
73
|
-
export interface IExportPdfConfig {
|
|
74
|
-
/** Page size and orientation (e.g. 'a4 landscape'). @deprecated Use pageSize and pageOrientation instead. */
|
|
75
|
-
pdfPageSize?: string;
|
|
76
|
-
/** PDF top left header content. @deprecated This property is no longer supported. */
|
|
77
|
-
pdfTopLeftContent?: string;
|
|
78
|
-
/** PDF top right header content. @deprecated This property is no longer supported. */
|
|
79
|
-
pdfTopRightContent?: string;
|
|
80
|
-
/** Page size */
|
|
81
|
-
pageSize?: "A3" | "A4" | "LETTER";
|
|
82
|
-
/** Page orientation */
|
|
83
|
-
pageOrientation?: "PORTRAIT" | "LANDSCAPE";
|
|
84
|
-
/** Show info page with export information. */
|
|
85
|
-
showInfoPage?: boolean;
|
|
86
|
-
}
|
|
87
|
-
/**
|
|
88
|
-
* Result of export is an object URL pointing to a Blob of downloaded data attached to the current
|
|
89
|
-
* window instance. The result also contains name of the downloaded file provided by the backend export
|
|
90
|
-
* service.
|
|
91
|
-
*
|
|
92
|
-
* {@link URL#revokeObjectURL} method must be used when object URL is no longer needed to release
|
|
93
|
-
* the blob memory.
|
|
94
|
-
*
|
|
95
|
-
* @public
|
|
96
|
-
*/
|
|
97
|
-
export interface IExportResult {
|
|
98
|
-
/** URI from which can the export be fetched again */
|
|
99
|
-
uri: string;
|
|
100
|
-
/** Object URL pointing to the downloaded blob of exported data */
|
|
101
|
-
objectUrl: string;
|
|
102
|
-
/** Name of the exported file provided by the export service */
|
|
103
|
-
fileName?: string;
|
|
104
|
-
}
|
|
105
|
-
//# sourceMappingURL=export.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/export.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;;;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;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,gCAAgC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEtE;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,6GAA6G;IAC7G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qFAAqF;IACrF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sFAAsF;IACtF,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,QAAQ,CAAC;IAClC,uBAAuB;IACvB,eAAe,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAC3C,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;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"}
|