@gooddata/sdk-model 11.35.0-alpha.5 → 11.35.0-alpha.7
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/agentSkill/index.d.ts +1 -1
- package/esm/dashboard/dashboard.d.ts +15 -4
- package/esm/dashboard/filterContext.d.ts +8 -0
- package/esm/dashboard/filterContext.js +14 -0
- package/esm/index.d.ts +2 -2
- package/esm/index.js +1 -1
- package/esm/sdk-model.d.ts +73 -5
- package/esm/settings/index.d.ts +46 -1
- package/package.json +4 -4
|
@@ -5,7 +5,7 @@ import { type IUser, type IUserGroup } from "../user/index.js";
|
|
|
5
5
|
*
|
|
6
6
|
* @alpha
|
|
7
7
|
*/
|
|
8
|
-
export type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge";
|
|
8
|
+
export type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "dashboard_summary" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge";
|
|
9
9
|
/**
|
|
10
10
|
* Skills mode for an AI agent.
|
|
11
11
|
*
|
|
@@ -216,6 +216,15 @@ export interface IDashboardTab<TWidget = IDashboardWidget> {
|
|
|
216
216
|
* If not defined, filters are displayed ungrouped as defined in single context.
|
|
217
217
|
*/
|
|
218
218
|
filterGroupsConfig?: IDashboardFilterGroupsConfig;
|
|
219
|
+
/**
|
|
220
|
+
* Tab-scoped parameter overrides. Each entry references a workspace parameter and optionally
|
|
221
|
+
* pins a dashboard-scope value, label, and mode. A parameter affects only the widgets on the
|
|
222
|
+
* tab where it is configured; the same ref may be added independently to multiple tabs with
|
|
223
|
+
* independent values, labels, and modes.
|
|
224
|
+
*
|
|
225
|
+
* @alpha
|
|
226
|
+
*/
|
|
227
|
+
parameters?: IDashboardParameter[];
|
|
219
228
|
}
|
|
220
229
|
/**
|
|
221
230
|
* Dashboard common properties
|
|
@@ -384,9 +393,9 @@ export interface IDashboard<TWidget = IDashboardWidget> extends IDashboardBase,
|
|
|
384
393
|
*/
|
|
385
394
|
readonly measureValueFilterConfigs?: IDashboardMeasureValueFilterConfig[];
|
|
386
395
|
/**
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
*
|
|
396
|
+
* Legacy dashboard-level parameters. Preserved as a read-only fallback for legacy metadata;
|
|
397
|
+
* saves emit parameters per tab on {@link IDashboardTab.parameters} instead. Honored on load
|
|
398
|
+
* only when no tab carries parameters.
|
|
390
399
|
*
|
|
391
400
|
* @alpha
|
|
392
401
|
*/
|
|
@@ -464,7 +473,9 @@ export interface IDashboardDefinition<TWidget = IDashboardWidget> extends IDashb
|
|
|
464
473
|
*/
|
|
465
474
|
readonly measureValueFilterConfigs?: IDashboardMeasureValueFilterConfig[];
|
|
466
475
|
/**
|
|
467
|
-
*
|
|
476
|
+
* Legacy dashboard-level parameters. Preserved as a read-only fallback for legacy metadata;
|
|
477
|
+
* saves emit parameters per tab on {@link IDashboardTab.parameters} instead. Honored on load
|
|
478
|
+
* only when no tab carries parameters.
|
|
468
479
|
*
|
|
469
480
|
* @alpha
|
|
470
481
|
*/
|
|
@@ -427,6 +427,14 @@ export declare function isDashboardMeasureValueFilter(obj: unknown): obj is IDas
|
|
|
427
427
|
* @alpha
|
|
428
428
|
*/
|
|
429
429
|
export declare function dashboardMeasureValueFilterLocalIdentifier(filter: IDashboardMeasureValueFilter): string;
|
|
430
|
+
/**
|
|
431
|
+
* Type-guard testing whether the provided object is an "All" dashboard measure value filter —
|
|
432
|
+
* a no-op MVF with no effective conditions (undefined or empty array). Such filters do not
|
|
433
|
+
* restrict execution and are typically stripped from stored filter contexts.
|
|
434
|
+
*
|
|
435
|
+
* @alpha
|
|
436
|
+
*/
|
|
437
|
+
export declare function isAllDashboardMeasureValueFilter(obj: unknown): boolean;
|
|
430
438
|
/**
|
|
431
439
|
* Type-guard testing whether the provider object is an All values attribute filter
|
|
432
440
|
* @alpha
|
|
@@ -223,6 +223,20 @@ export function isDashboardMeasureValueFilter(obj) {
|
|
|
223
223
|
export function dashboardMeasureValueFilterLocalIdentifier(filter) {
|
|
224
224
|
return filter.dashboardMeasureValueFilter.localIdentifier;
|
|
225
225
|
}
|
|
226
|
+
/**
|
|
227
|
+
* Type-guard testing whether the provided object is an "All" dashboard measure value filter —
|
|
228
|
+
* a no-op MVF with no effective conditions (undefined or empty array). Such filters do not
|
|
229
|
+
* restrict execution and are typically stripped from stored filter contexts.
|
|
230
|
+
*
|
|
231
|
+
* @alpha
|
|
232
|
+
*/
|
|
233
|
+
export function isAllDashboardMeasureValueFilter(obj) {
|
|
234
|
+
if (!isDashboardMeasureValueFilter(obj)) {
|
|
235
|
+
return false;
|
|
236
|
+
}
|
|
237
|
+
const conditions = obj.dashboardMeasureValueFilter.conditions;
|
|
238
|
+
return !conditions || conditions.length === 0;
|
|
239
|
+
}
|
|
226
240
|
/**
|
|
227
241
|
* Type-guard testing whether the provider object is an All values attribute filter
|
|
228
242
|
* @alpha
|
package/esm/index.d.ts
CHANGED
|
@@ -42,7 +42,7 @@ export { insightSanitize, sanitizeBucketTotals } from "./insight/sanitization.js
|
|
|
42
42
|
export { factoryNotationFor } from "./execution/objectFactoryNotation/index.js";
|
|
43
43
|
export { type DateFilterOptionAbsoluteFormType, type DateFilterOptionAbsolutePresetType, type DateFilterOptionAllTimeType, type DateFilterOptionType, type DateFilterOptionEmptyValuesType, type DateFilterOptionRelativeFormType, type DateFilterOptionRelativePresetType, type RelativeDateFilterGranularityOffset, type DateFilterGranularity, type DateString, type IAbsoluteDateFilterForm, type IAbsoluteDateFilterPreset, type IAllTimeDateFilterOption, type IDateFilterConfig, type IDateFilterOption, type IEmptyValuesDateFilterOption, type IRelativeDateFilterForm, type IRelativeDateFilterPreset, type IRelativeDateFilterPresetOfGranularity, isAbsoluteDateFilterForm, isAbsoluteDateFilterPreset, isAllTimeDateFilterOption, isEmptyValuesDateFilterOption, isDateFilterGranularity, isRelativeDateFilterForm, isRelativeDateFilterPreset, } from "./dateFilterConfig/index.js";
|
|
44
44
|
export type { IDashboardObjectIdentity } from "./dashboard/common.js";
|
|
45
|
-
export { type DateFilterAbsoluteType, type DateFilterRelativeType, type DateFilterType, type FilterContextItem, type IDashboardAttributeFilter, type IDashboardArbitraryAttributeFilter, type IDashboardMatchAttributeFilter, type DashboardAttributeFilterItem, type DashboardTextAttributeFilter, type DashboardAttributeFilterSelectionMode, type IDashboardAttributeFilterParent, type IDashboardAttributeFilterReference, type IDashboardAttributeFilterByDate, type IDashboardDateFilter, type IDashboardDateFilterReference, type IDashboardMeasureValueFilter, type IDashboardMeasureValueFilterReference, type IDashboardFilterReference, type IFilterContext, type IFilterContextBase, type IFilterContextDefinition, type ITempFilterContext, type IDashboardFilterView, type IDashboardFilterViewSaveRequest, dashboardFilterReferenceObjRef, isAllTimeDashboardDateFilter, isAllTimeDashboardDateFilterWithEmptyValueHandling, isNoopAllTimeDashboardDateFilter, isAllValuesDashboardAttributeFilter, isDashboardAttributeFilter, isDashboardArbitraryAttributeFilter, isDashboardMatchAttributeFilter, isDashboardAttributeFilterItem, isDashboardTextAttributeFilter, isSingleSelectionFilter, isNegativeAttributeFilter as isNegativeDashboardAttributeFilter, getSelectedElementsCount, isDashboardAttributeFilterReference, isDashboardDateFilter, isDashboardDateFilterWithDimension, isDashboardCommonDateFilter, isRelativeDashboardDateFilter, isAbsoluteDashboardDateFilter, isDashboardDateFilterReference, isDashboardMeasureValueFilter, isDashboardMeasureValueFilterReference, isFilterContext, isFilterContextDefinition, isTempFilterContext, newAbsoluteDashboardDateFilter, newAllTimeDashboardDateFilter, newRelativeDashboardDateFilter, isFilterContextItem, dashboardFilterLocalIdentifier, dashboardFilterObjRef, dashboardAttributeFilterItemDisplayForm, dashboardAttributeFilterItemLocalIdentifier, dashboardMeasureValueFilterLocalIdentifier, dashboardAttributeFilterItemTitle, dashboardAttributeFilterItemFilterElementsBy, dashboardAttributeFilterItemFilterElementsByDate, dashboardAttributeFilterItemValidateElementsBy, } from "./dashboard/filterContext.js";
|
|
45
|
+
export { type DateFilterAbsoluteType, type DateFilterRelativeType, type DateFilterType, type FilterContextItem, type IDashboardAttributeFilter, type IDashboardArbitraryAttributeFilter, type IDashboardMatchAttributeFilter, type DashboardAttributeFilterItem, type DashboardTextAttributeFilter, type DashboardAttributeFilterSelectionMode, type IDashboardAttributeFilterParent, type IDashboardAttributeFilterReference, type IDashboardAttributeFilterByDate, type IDashboardDateFilter, type IDashboardDateFilterReference, type IDashboardMeasureValueFilter, type IDashboardMeasureValueFilterReference, type IDashboardFilterReference, type IFilterContext, type IFilterContextBase, type IFilterContextDefinition, type ITempFilterContext, type IDashboardFilterView, type IDashboardFilterViewSaveRequest, dashboardFilterReferenceObjRef, isAllTimeDashboardDateFilter, isAllTimeDashboardDateFilterWithEmptyValueHandling, isNoopAllTimeDashboardDateFilter, isAllValuesDashboardAttributeFilter, isDashboardAttributeFilter, isDashboardArbitraryAttributeFilter, isDashboardMatchAttributeFilter, isDashboardAttributeFilterItem, isDashboardTextAttributeFilter, isSingleSelectionFilter, isNegativeAttributeFilter as isNegativeDashboardAttributeFilter, getSelectedElementsCount, isDashboardAttributeFilterReference, isDashboardDateFilter, isDashboardDateFilterWithDimension, isDashboardCommonDateFilter, isRelativeDashboardDateFilter, isAbsoluteDashboardDateFilter, isDashboardDateFilterReference, isAllDashboardMeasureValueFilter, isDashboardMeasureValueFilter, isDashboardMeasureValueFilterReference, isFilterContext, isFilterContextDefinition, isTempFilterContext, newAbsoluteDashboardDateFilter, newAllTimeDashboardDateFilter, newRelativeDashboardDateFilter, isFilterContextItem, dashboardFilterLocalIdentifier, dashboardFilterObjRef, dashboardAttributeFilterItemDisplayForm, dashboardAttributeFilterItemLocalIdentifier, dashboardMeasureValueFilterLocalIdentifier, dashboardAttributeFilterItemTitle, dashboardAttributeFilterItemFilterElementsBy, dashboardAttributeFilterItemFilterElementsByDate, dashboardAttributeFilterItemValidateElementsBy, } from "./dashboard/filterContext.js";
|
|
46
46
|
export { type IWidgetAlert, type IWidgetAlertBase, type IWidgetAlertDefinition, isWidgetAlert, isWidgetAlertDefinition, } from "./dashboard/alert.js";
|
|
47
47
|
export { type DrillDefinition, type DrillOrigin, type DrillOriginType, type DrillTransition, type DrillType, type IDrill, type IDrillDownReference, type IDateHierarchyReference, type IAttributeHierarchyReference, type IDrillFromAttribute, type IDrillFromMeasure, type IDrillOrigin, type IDrillTarget, type IDrillToAttributeUrl, type IDrillToAttributeUrlTarget, type IDrillToCustomUrl, type IDrillToCustomUrlTarget, type IDrillToDashboard, type IDrillToInsight, type IDrillToLegacyDashboard, type ISourceInsightAttributeFilterRef, type ISourceInsightDateFilterRef, type ISourceInsightMeasureValueFilterRef, type ISourceInsightRankingFilterRef, type SourceInsightFilterObjRef, type SourceMeasureFilterObjRef, type InsightDrillDefinition, type KpiDrillDefinition, type ICrossFiltering, type IKeyDriveAnalysis, isDrillFromAttribute, isDrillFromMeasure, isDrillToAttributeUrl, isDrillToCustomUrl, isDrillToDashboard, isDrillToInsight, isDrillToLegacyDashboard, isAttributeHierarchyReference, isDateHierarchyReference, isCrossFiltering, isKeyDriveAnalysis, drillDownReferenceHierarchyRef, drillDownReferenceAttributeRef, } from "./dashboard/drill.js";
|
|
48
48
|
export { type IBaseWidget, type IDrillableWidget, type IFilterableWidget, type IWidgetDescription, type IDrillDownIntersectionIgnoredAttributes, BuiltInWidgetTypes, } from "./dashboard/baseWidget.js";
|
|
@@ -77,7 +77,7 @@ export { type IUser, type IUserGroup, type IWorkspaceUser, type IOrganizationUse
|
|
|
77
77
|
export { type IDashboardLayout, type IDashboardWidget, type IDashboardLayoutSection, type IDashboardLayoutSectionHeader, type IDashboardLayoutSize, type IDashboardLayoutSizeByScreenSize, type IDashboardLayoutItem, type IDashboardLayoutWidget, type IDashboardLayoutConfiguration, type IDashboardLayoutSectionsConfiguration, type IDashboardLayoutContainerDirection, type ScreenSize, isDashboardLayout, isDashboardLayoutSection, isDashboardLayoutItem, isDashboardWidget, } from "./dashboard/layout.js";
|
|
78
78
|
export { type IDashboard, type IDashboardDefinition, type IListedDashboard, type ListedDashboardAvailability, type IDashboardBase, type IDashboardDateFilterConfig, type DashboardDateFilterConfigMode, type IDashboardAttributeFilterConfig, type IDashboardMeasureValueFilterConfig, type IDashboardDateFilterConfigItem, type DashboardAttributeFilterConfigMode, type DashboardAttributeFilterSelectionType, DashboardAttributeFilterSelectionTypeValues, type IDashboardDateFilterAddedPresets, type IDashboardPluginBase, type IDashboardPlugin, type IDashboardPluginDefinition, type IDashboardPluginLink, type IAccessControlAware, type ShareStatus, type SharePermission, type IDashboardPermissions, type IExistingDashboard, type IDashboardTab, type IDashboardFilterGroup, type IDashboardFilterGroupItem, type IDashboardFilterGroupsConfig, DashboardDateFilterConfigModeValues, DashboardAttributeFilterConfigModeValues, isDashboard, isDashboardDefinition, isListedDashboard, isDashboardTab, } from "./dashboard/dashboard.js";
|
|
79
79
|
export { type IDashboardParameter, type DashboardParameterMode, DashboardParameterModeValues, isDashboardParameter, } from "./dashboard/parameter.js";
|
|
80
|
-
export { type ISettings } from "./settings/index.js";
|
|
80
|
+
export { type ISettings, type IUserSettings, type IWorkspaceSettings, type IUserWorkspaceSettings, } from "./settings/index.js";
|
|
81
81
|
export { type ISeparators, type IPermanentSettings, type IFeatureFlags, type PlatformEdition, type IWhiteLabeling, type IAlertDefault, type WeekStart, type IFiscalYear, type IActiveCalendars, type CalendarType, type IOpenAiConfig, type ILlmEndpoint, type ILlmActiveProvider, type IAiRateLimit, type DashboardFiltersApplyMode, type EarlyAccessFeatureContext, type EarlyAccessFeatureStatus, type IEarlyAccessFeatureConfig, type IEarlyAccessFeaturesConfig, type IProductionFeatureConfig, type IProductionFeaturesConfig, type IMetricFormatOverrideSetting, isSeparators, } from "./settings/settings.js";
|
|
82
82
|
export type { IWorkspaceUserGroup } from "./userGroup/index.js";
|
|
83
83
|
export type { ThemeFontUri, ThemeColor, IThemeColorFamily, IThemeComplementaryPalette, IThemeWidgetTitle, IThemeTypography, IThemeFontsDef, IThemePalette, IThemeKpi, IThemeKpiValue, IThemeChart, IThemeTable, ITheme, IThemeAnalyticalDesigner, IThemeAnalyticalDesignerTitle, IThemeButton, IThemeDashboard, IThemeDashboardContent, IThemeDashboardContentKpi, IThemeDashboardContentWidget, IThemeDashboardEditPanel, IThemeDashboardFilterBar, IThemeDashboardFilterBarButton, IThemeDashboardNavigation, IThemeDashboardNavigationItem, IThemeDashboardNavigationTitle, IThemeDashboardSection, IThemeDashboardSectionDescription, IThemeDashboardSectionTitle, IThemeDashboardTitle, IThemeMetadataObject, IThemeDefinition, IThemeModal, IThemeModalTitle, IThemeTooltip, IThemeImages, IThemeMessage, IThemeMessageVariant, IThemeToastMessage, IThemeToastMessageVariant, IThemeHeader, ImageUri, IThemeAxis, IThemeChartTooltip, IThemeDataLabel, ThemeDashboardDensity, } from "./theme/index.js";
|
package/esm/index.js
CHANGED
|
@@ -40,7 +40,7 @@ export { newInsightDefinition, InsightDefinitionBuilder, } from "./insight/facto
|
|
|
40
40
|
export { insightSanitize, sanitizeBucketTotals } from "./insight/sanitization.js";
|
|
41
41
|
export { factoryNotationFor } from "./execution/objectFactoryNotation/index.js";
|
|
42
42
|
export { isAbsoluteDateFilterForm, isAbsoluteDateFilterPreset, isAllTimeDateFilterOption, isEmptyValuesDateFilterOption, isDateFilterGranularity, isRelativeDateFilterForm, isRelativeDateFilterPreset, } from "./dateFilterConfig/index.js";
|
|
43
|
-
export { dashboardFilterReferenceObjRef, isAllTimeDashboardDateFilter, isAllTimeDashboardDateFilterWithEmptyValueHandling, isNoopAllTimeDashboardDateFilter, isAllValuesDashboardAttributeFilter, isDashboardAttributeFilter, isDashboardArbitraryAttributeFilter, isDashboardMatchAttributeFilter, isDashboardAttributeFilterItem, isDashboardTextAttributeFilter, isSingleSelectionFilter, isNegativeAttributeFilter as isNegativeDashboardAttributeFilter, getSelectedElementsCount, isDashboardAttributeFilterReference, isDashboardDateFilter, isDashboardDateFilterWithDimension, isDashboardCommonDateFilter, isRelativeDashboardDateFilter, isAbsoluteDashboardDateFilter, isDashboardDateFilterReference, isDashboardMeasureValueFilter, isDashboardMeasureValueFilterReference, isFilterContext, isFilterContextDefinition, isTempFilterContext, newAbsoluteDashboardDateFilter, newAllTimeDashboardDateFilter, newRelativeDashboardDateFilter, isFilterContextItem, dashboardFilterLocalIdentifier, dashboardFilterObjRef, dashboardAttributeFilterItemDisplayForm, dashboardAttributeFilterItemLocalIdentifier, dashboardMeasureValueFilterLocalIdentifier, dashboardAttributeFilterItemTitle, dashboardAttributeFilterItemFilterElementsBy, dashboardAttributeFilterItemFilterElementsByDate, dashboardAttributeFilterItemValidateElementsBy, } from "./dashboard/filterContext.js";
|
|
43
|
+
export { dashboardFilterReferenceObjRef, isAllTimeDashboardDateFilter, isAllTimeDashboardDateFilterWithEmptyValueHandling, isNoopAllTimeDashboardDateFilter, isAllValuesDashboardAttributeFilter, isDashboardAttributeFilter, isDashboardArbitraryAttributeFilter, isDashboardMatchAttributeFilter, isDashboardAttributeFilterItem, isDashboardTextAttributeFilter, isSingleSelectionFilter, isNegativeAttributeFilter as isNegativeDashboardAttributeFilter, getSelectedElementsCount, isDashboardAttributeFilterReference, isDashboardDateFilter, isDashboardDateFilterWithDimension, isDashboardCommonDateFilter, isRelativeDashboardDateFilter, isAbsoluteDashboardDateFilter, isDashboardDateFilterReference, isAllDashboardMeasureValueFilter, isDashboardMeasureValueFilter, isDashboardMeasureValueFilterReference, isFilterContext, isFilterContextDefinition, isTempFilterContext, newAbsoluteDashboardDateFilter, newAllTimeDashboardDateFilter, newRelativeDashboardDateFilter, isFilterContextItem, dashboardFilterLocalIdentifier, dashboardFilterObjRef, dashboardAttributeFilterItemDisplayForm, dashboardAttributeFilterItemLocalIdentifier, dashboardMeasureValueFilterLocalIdentifier, dashboardAttributeFilterItemTitle, dashboardAttributeFilterItemFilterElementsBy, dashboardAttributeFilterItemFilterElementsByDate, dashboardAttributeFilterItemValidateElementsBy, } from "./dashboard/filterContext.js";
|
|
44
44
|
export { isWidgetAlert, isWidgetAlertDefinition, } from "./dashboard/alert.js";
|
|
45
45
|
export { isDrillFromAttribute, isDrillFromMeasure, isDrillToAttributeUrl, isDrillToCustomUrl, isDrillToDashboard, isDrillToInsight, isDrillToLegacyDashboard, isAttributeHierarchyReference, isDateHierarchyReference, isCrossFiltering, isKeyDriveAnalysis, drillDownReferenceHierarchyRef, drillDownReferenceAttributeRef, } from "./dashboard/drill.js";
|
|
46
46
|
export { BuiltInWidgetTypes, } from "./dashboard/baseWidget.js";
|
package/esm/sdk-model.d.ts
CHANGED
|
@@ -43,7 +43,7 @@ export declare type AccessGranularPermission = "VIEW" | "EDIT" | "SHARE";
|
|
|
43
43
|
*
|
|
44
44
|
* @alpha
|
|
45
45
|
*/
|
|
46
|
-
export declare type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge";
|
|
46
|
+
export declare type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "dashboard_summary" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge";
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Skills mode for an AI agent.
|
|
@@ -4186,9 +4186,9 @@ export declare interface IDashboard<TWidget = IDashboardWidget> extends IDashboa
|
|
|
4186
4186
|
*/
|
|
4187
4187
|
readonly measureValueFilterConfigs?: IDashboardMeasureValueFilterConfig[];
|
|
4188
4188
|
/**
|
|
4189
|
-
*
|
|
4190
|
-
*
|
|
4191
|
-
*
|
|
4189
|
+
* Legacy dashboard-level parameters. Preserved as a read-only fallback for legacy metadata;
|
|
4190
|
+
* saves emit parameters per tab on {@link IDashboardTab.parameters} instead. Honored on load
|
|
4191
|
+
* only when no tab carries parameters.
|
|
4192
4192
|
*
|
|
4193
4193
|
* @alpha
|
|
4194
4194
|
*/
|
|
@@ -4620,7 +4620,9 @@ export declare interface IDashboardDefinition<TWidget = IDashboardWidget> extend
|
|
|
4620
4620
|
*/
|
|
4621
4621
|
readonly measureValueFilterConfigs?: IDashboardMeasureValueFilterConfig[];
|
|
4622
4622
|
/**
|
|
4623
|
-
*
|
|
4623
|
+
* Legacy dashboard-level parameters. Preserved as a read-only fallback for legacy metadata;
|
|
4624
|
+
* saves emit parameters per tab on {@link IDashboardTab.parameters} instead. Honored on load
|
|
4625
|
+
* only when no tab carries parameters.
|
|
4624
4626
|
*
|
|
4625
4627
|
* @alpha
|
|
4626
4628
|
*/
|
|
@@ -5211,6 +5213,15 @@ export declare interface IDashboardTab<TWidget = IDashboardWidget> {
|
|
|
5211
5213
|
* If not defined, filters are displayed ungrouped as defined in single context.
|
|
5212
5214
|
*/
|
|
5213
5215
|
filterGroupsConfig?: IDashboardFilterGroupsConfig;
|
|
5216
|
+
/**
|
|
5217
|
+
* Tab-scoped parameter overrides. Each entry references a workspace parameter and optionally
|
|
5218
|
+
* pins a dashboard-scope value, label, and mode. A parameter affects only the widgets on the
|
|
5219
|
+
* tab where it is configured; the same ref may be added independently to multiple tabs with
|
|
5220
|
+
* independent values, labels, and modes.
|
|
5221
|
+
*
|
|
5222
|
+
* @alpha
|
|
5223
|
+
*/
|
|
5224
|
+
parameters?: IDashboardParameter[];
|
|
5214
5225
|
}
|
|
5215
5226
|
|
|
5216
5227
|
/**
|
|
@@ -10882,6 +10893,15 @@ export declare function isAdhocMeasure(obj: unknown): obj is IMeasure<IMeasureDe
|
|
|
10882
10893
|
*/
|
|
10883
10894
|
export declare function isAlertNotification(notification: unknown): notification is IAlertNotification;
|
|
10884
10895
|
|
|
10896
|
+
/**
|
|
10897
|
+
* Type-guard testing whether the provided object is an "All" dashboard measure value filter —
|
|
10898
|
+
* a no-op MVF with no effective conditions (undefined or empty array). Such filters do not
|
|
10899
|
+
* restrict execution and are typically stripped from stored filter contexts.
|
|
10900
|
+
*
|
|
10901
|
+
* @alpha
|
|
10902
|
+
*/
|
|
10903
|
+
export declare function isAllDashboardMeasureValueFilter(obj: unknown): boolean;
|
|
10904
|
+
|
|
10885
10905
|
/**
|
|
10886
10906
|
* Type-guard testing whether the provided object is an All time dashboard date filter.
|
|
10887
10907
|
* @alpha
|
|
@@ -14220,6 +14240,26 @@ export declare interface IUserGroupDataFilterDefinition extends IUserDataFilterD
|
|
|
14220
14240
|
*/
|
|
14221
14241
|
export declare type IUserGroupWorkspaceAccessGrantee = IWorkspaceAccess & IGranularUserGroupAccessGrantee;
|
|
14222
14242
|
|
|
14243
|
+
/**
|
|
14244
|
+
* Settings for a particular user.
|
|
14245
|
+
*
|
|
14246
|
+
* @public
|
|
14247
|
+
*/
|
|
14248
|
+
export declare interface IUserSettings extends ISettings {
|
|
14249
|
+
/**
|
|
14250
|
+
* User to which the settings belong.
|
|
14251
|
+
*/
|
|
14252
|
+
userId: string;
|
|
14253
|
+
/**
|
|
14254
|
+
* User locale
|
|
14255
|
+
*/
|
|
14256
|
+
locale: string;
|
|
14257
|
+
/**
|
|
14258
|
+
* Regional number formatting
|
|
14259
|
+
*/
|
|
14260
|
+
separators: ISeparators;
|
|
14261
|
+
}
|
|
14262
|
+
|
|
14223
14263
|
/**
|
|
14224
14264
|
* Workspace access for user with granular permissions.
|
|
14225
14265
|
*
|
|
@@ -14227,6 +14267,14 @@ export declare type IUserGroupWorkspaceAccessGrantee = IWorkspaceAccess & IGranu
|
|
|
14227
14267
|
*/
|
|
14228
14268
|
export declare type IUserWorkspaceAccessGrantee = IWorkspaceAccess & IGranularUserAccessGrantee;
|
|
14229
14269
|
|
|
14270
|
+
/**
|
|
14271
|
+
* Settings for a particular combination of user and workspace.
|
|
14272
|
+
*
|
|
14273
|
+
* @public
|
|
14274
|
+
*/
|
|
14275
|
+
export declare interface IUserWorkspaceSettings extends IUserSettings, IWorkspaceSettings {
|
|
14276
|
+
}
|
|
14277
|
+
|
|
14230
14278
|
/**
|
|
14231
14279
|
* Variable metadata object
|
|
14232
14280
|
*
|
|
@@ -14697,6 +14745,26 @@ export declare type IWorkspacePermissions = {
|
|
|
14697
14745
|
[permission in WorkspacePermission]: boolean;
|
|
14698
14746
|
};
|
|
14699
14747
|
|
|
14748
|
+
/**
|
|
14749
|
+
* Settings for a particular workspace.
|
|
14750
|
+
*
|
|
14751
|
+
* @public
|
|
14752
|
+
*/
|
|
14753
|
+
export declare interface IWorkspaceSettings extends ISettings {
|
|
14754
|
+
/**
|
|
14755
|
+
* Workspace to which the settings belong.
|
|
14756
|
+
*/
|
|
14757
|
+
workspace: string;
|
|
14758
|
+
/**
|
|
14759
|
+
* Stores Mapbox token used for WS
|
|
14760
|
+
*/
|
|
14761
|
+
mapboxToken?: string;
|
|
14762
|
+
/**
|
|
14763
|
+
* Stores AgGrid token used for WS
|
|
14764
|
+
*/
|
|
14765
|
+
agGridToken?: string;
|
|
14766
|
+
}
|
|
14767
|
+
|
|
14700
14768
|
/**
|
|
14701
14769
|
* Represents platform user in context of the workspace.
|
|
14702
14770
|
*
|
package/esm/settings/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type RemotePluggableApplicationsRegistry } from "../pluggableApplication/index.js";
|
|
2
|
-
import { type IFeatureFlags, type IPermanentSettings } from "./settings.js";
|
|
2
|
+
import { type IFeatureFlags, type IPermanentSettings, type ISeparators } from "./settings.js";
|
|
3
3
|
/**
|
|
4
4
|
* Settings are obtained from the backend and are effectively a collection of feature flags or settings with
|
|
5
5
|
* concrete string or numeric value.
|
|
@@ -22,3 +22,48 @@ export interface ISettings extends IPermanentSettings, IFeatureFlags {
|
|
|
22
22
|
registeredPluggableApplications?: RemotePluggableApplicationsRegistry;
|
|
23
23
|
[key: string]: number | boolean | string | object | undefined | null;
|
|
24
24
|
}
|
|
25
|
+
/**
|
|
26
|
+
* Settings for a particular user.
|
|
27
|
+
*
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export interface IUserSettings extends ISettings {
|
|
31
|
+
/**
|
|
32
|
+
* User to which the settings belong.
|
|
33
|
+
*/
|
|
34
|
+
userId: string;
|
|
35
|
+
/**
|
|
36
|
+
* User locale
|
|
37
|
+
*/
|
|
38
|
+
locale: string;
|
|
39
|
+
/**
|
|
40
|
+
* Regional number formatting
|
|
41
|
+
*/
|
|
42
|
+
separators: ISeparators;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Settings for a particular workspace.
|
|
46
|
+
*
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
export interface IWorkspaceSettings extends ISettings {
|
|
50
|
+
/**
|
|
51
|
+
* Workspace to which the settings belong.
|
|
52
|
+
*/
|
|
53
|
+
workspace: string;
|
|
54
|
+
/**
|
|
55
|
+
* Stores Mapbox token used for WS
|
|
56
|
+
*/
|
|
57
|
+
mapboxToken?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Stores AgGrid token used for WS
|
|
60
|
+
*/
|
|
61
|
+
agGridToken?: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Settings for a particular combination of user and workspace.
|
|
65
|
+
*
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export interface IUserWorkspaceSettings extends IUserSettings, IWorkspaceSettings {
|
|
69
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-model",
|
|
3
|
-
"version": "11.35.0-alpha.
|
|
3
|
+
"version": "11.35.0-alpha.7",
|
|
4
4
|
"description": "GoodData Model definitions used by UI components and Backend SPI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "GoodData",
|
|
@@ -57,8 +57,8 @@
|
|
|
57
57
|
"oxlint-tsgolint": "0.11.4",
|
|
58
58
|
"typescript": "5.9.3",
|
|
59
59
|
"vitest": "4.1.0",
|
|
60
|
-
"@gooddata/eslint-config": "11.35.0-alpha.
|
|
61
|
-
"@gooddata/oxlint-config": "11.35.0-alpha.
|
|
60
|
+
"@gooddata/eslint-config": "11.35.0-alpha.7",
|
|
61
|
+
"@gooddata/oxlint-config": "11.35.0-alpha.7"
|
|
62
62
|
},
|
|
63
63
|
"scripts": {
|
|
64
64
|
"_phase:build": "npm run build",
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
"build": "npm-run-all -p build-check build-ts && npm run api-extractor",
|
|
69
69
|
"build-check": "tsgo",
|
|
70
70
|
"build-ts": "tsgo -p tsconfig.build.json",
|
|
71
|
-
"clean": "../../common/scripts/clean-command-state.sh && rm -rf ci dist esm coverage *.log tsconfig.tsbuildinfo",
|
|
71
|
+
"clean": "../../common/scripts/clean-command-state.sh && rm -rf ci dist esm coverage temp *.log tsconfig.tsbuildinfo",
|
|
72
72
|
"dep-cruiser": "depcruise --validate .dependency-cruiser.js --output-type err-long src/",
|
|
73
73
|
"format-check": "oxfmt --check .",
|
|
74
74
|
"format-write": "oxfmt .",
|