@gooddata/sdk-model 11.36.0-alpha.3 → 11.36.0-alpha.6
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/dashboard/drillUrl.d.ts +8 -0
- package/esm/dashboard/drillUrl.js +17 -1
- package/esm/dashboard/filterContext.d.ts +14 -0
- package/esm/internal.d.ts +1 -1
- package/esm/internal.js +1 -1
- package/esm/sdk-model.d.ts +25 -8
- package/esm/settings/settings.d.ts +12 -8
- package/package.json +3 -3
|
@@ -28,7 +28,15 @@ export declare const getAttributeIdentifiersPlaceholdersFromUrl: (url: string) =
|
|
|
28
28
|
* @internal
|
|
29
29
|
*/
|
|
30
30
|
export declare const getDashboardAttributeFilterPlaceholdersFromUrl: (url: string) => IDrillToUrlPlaceholder[];
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
export declare const getDashboardMeasureValueFilterPlaceholdersFromUrl: (url: string) => IDrillToUrlPlaceholder[];
|
|
31
35
|
/**
|
|
32
36
|
* @internal
|
|
33
37
|
*/
|
|
34
38
|
export declare const getInsightAttributeFilterPlaceholdersFromUrl: (url: string) => IDrillToUrlPlaceholder[];
|
|
39
|
+
/**
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
42
|
+
export declare const getInsightMeasureValueFilterPlaceholdersFromUrl: (url: string) => IDrillToUrlPlaceholder[];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// (C) 2022-
|
|
1
|
+
// (C) 2022-2026 GoodData Corporation
|
|
2
2
|
import { idRef } from "../objRef/factory.js";
|
|
3
3
|
import { isIdentifierRef } from "../objRef/index.js";
|
|
4
4
|
function matchAll(regex, text) {
|
|
@@ -12,7 +12,9 @@ function matchAll(regex, text) {
|
|
|
12
12
|
const attributeIdentifierSplitRegexp = /(\{attribute_title\(.*?\)\})/;
|
|
13
13
|
const attributeIdentifierMatchRegexp = /\{attribute_title\((.*?)\)\}/g;
|
|
14
14
|
const dashboardAttributeFilterMatchRegexp = /\{dash_attribute_filter_selection\((.*?)\)\}/g;
|
|
15
|
+
const dashboardMeasureValueFilterMatchRegexp = /\{dash_mvf_condition\((.*?)\)\}/g;
|
|
15
16
|
const insightAttributeFilterMatchRegexp = /\{attribute_filter_selection\((.*?)\)\}/g;
|
|
17
|
+
const insightMeasureValueFilterMatchRegexp = /\{mvf_condition\((.*?)\)\}/g;
|
|
16
18
|
const attributeIdentifierToPlaceholder = (ref) => `{attribute_title(${ref.identifier})}`;
|
|
17
19
|
const matchToUrlPlaceholder = (match) => ({
|
|
18
20
|
placeholder: match[0],
|
|
@@ -20,6 +22,12 @@ const matchToUrlPlaceholder = (match) => ({
|
|
|
20
22
|
ref: idRef(match[1], "displayForm"),
|
|
21
23
|
toBeEncoded: match.index !== 0,
|
|
22
24
|
});
|
|
25
|
+
const matchToMeasureUrlPlaceholder = (match) => ({
|
|
26
|
+
placeholder: match[0],
|
|
27
|
+
identifier: match[1],
|
|
28
|
+
ref: idRef(match[1], "measure"),
|
|
29
|
+
toBeEncoded: match.index !== 0,
|
|
30
|
+
});
|
|
23
31
|
const splitAttributeIdentifierUrl = (url) => url.split(attributeIdentifierSplitRegexp);
|
|
24
32
|
/**
|
|
25
33
|
* @internal
|
|
@@ -58,7 +66,15 @@ export const getAttributeIdentifiersPlaceholdersFromUrl = (url) => matchAll(attr
|
|
|
58
66
|
* @internal
|
|
59
67
|
*/
|
|
60
68
|
export const getDashboardAttributeFilterPlaceholdersFromUrl = (url) => matchAll(dashboardAttributeFilterMatchRegexp, url).map(matchToUrlPlaceholder);
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
export const getDashboardMeasureValueFilterPlaceholdersFromUrl = (url) => matchAll(dashboardMeasureValueFilterMatchRegexp, url).map(matchToMeasureUrlPlaceholder);
|
|
61
73
|
/**
|
|
62
74
|
* @internal
|
|
63
75
|
*/
|
|
64
76
|
export const getInsightAttributeFilterPlaceholdersFromUrl = (url) => matchAll(insightAttributeFilterMatchRegexp, url).map(matchToUrlPlaceholder);
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
80
|
+
export const getInsightMeasureValueFilterPlaceholdersFromUrl = (url) => matchAll(insightMeasureValueFilterMatchRegexp, url).map(matchToMeasureUrlPlaceholder);
|
|
@@ -2,6 +2,7 @@ import { type DateFilterGranularity, type DateString } from "../dateFilterConfig
|
|
|
2
2
|
import { type EmptyValues, type IAttributeElements, type ILowerBoundedFilter, type IUpperBoundedFilter, type MatchFilterOperator, type MeasureValueFilterCondition } from "../execution/filter/index.js";
|
|
3
3
|
import { type ObjRef } from "../objRef/index.js";
|
|
4
4
|
import { type IDashboardObjectIdentity } from "./common.js";
|
|
5
|
+
import { type IDashboardParameter } from "./parameter.js";
|
|
5
6
|
/**
|
|
6
7
|
* Date filter type - relative
|
|
7
8
|
* @beta
|
|
@@ -684,6 +685,13 @@ export interface IDashboardFilterView {
|
|
|
684
685
|
readonly filterContext: IFilterContextDefinition;
|
|
685
686
|
readonly isDefault?: boolean;
|
|
686
687
|
readonly tabLocalIdentifier?: string;
|
|
688
|
+
/**
|
|
689
|
+
* Dashboard parameter overrides captured at the time the view was saved.
|
|
690
|
+
* Absent when the view was saved before parameters were supported.
|
|
691
|
+
*
|
|
692
|
+
* @alpha
|
|
693
|
+
*/
|
|
694
|
+
readonly parameters?: IDashboardParameter[];
|
|
687
695
|
}
|
|
688
696
|
/**
|
|
689
697
|
* Interface that represents an entity provided to SPI function that creates a new dashboard filter view
|
|
@@ -697,4 +705,10 @@ export interface IDashboardFilterViewSaveRequest {
|
|
|
697
705
|
readonly filterContext: IFilterContextDefinition;
|
|
698
706
|
readonly isDefault?: boolean;
|
|
699
707
|
readonly tabLocalIdentifier?: string;
|
|
708
|
+
/**
|
|
709
|
+
* Dashboard parameter overrides to capture in the filter view alongside the filter context.
|
|
710
|
+
*
|
|
711
|
+
* @alpha
|
|
712
|
+
*/
|
|
713
|
+
readonly parameters?: IDashboardParameter[];
|
|
700
714
|
}
|
package/esm/internal.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export { type IDrillToUrlPlaceholder, joinDrillUrlParts, splitDrillUrlParts, getAttributeIdentifiersPlaceholdersFromUrl, getDashboardAttributeFilterPlaceholdersFromUrl, getInsightAttributeFilterPlaceholdersFromUrl, } from "./dashboard/drillUrl.js";
|
|
1
|
+
export { type IDrillToUrlPlaceholder, joinDrillUrlParts, splitDrillUrlParts, getAttributeIdentifiersPlaceholdersFromUrl, getDashboardAttributeFilterPlaceholdersFromUrl, getDashboardMeasureValueFilterPlaceholdersFromUrl, getInsightAttributeFilterPlaceholdersFromUrl, getInsightMeasureValueFilterPlaceholdersFromUrl, } from "./dashboard/drillUrl.js";
|
package/esm/internal.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
// (C) 2023-2026 GoodData Corporation
|
|
2
2
|
/* oxlint-disable no-barrel-files/no-barrel-files */
|
|
3
|
-
export { joinDrillUrlParts, splitDrillUrlParts, getAttributeIdentifiersPlaceholdersFromUrl, getDashboardAttributeFilterPlaceholdersFromUrl, getInsightAttributeFilterPlaceholdersFromUrl, } from "./dashboard/drillUrl.js";
|
|
3
|
+
export { joinDrillUrlParts, splitDrillUrlParts, getAttributeIdentifiersPlaceholdersFromUrl, getDashboardAttributeFilterPlaceholdersFromUrl, getDashboardMeasureValueFilterPlaceholdersFromUrl, getInsightAttributeFilterPlaceholdersFromUrl, getInsightMeasureValueFilterPlaceholdersFromUrl, } from "./dashboard/drillUrl.js";
|
package/esm/sdk-model.d.ts
CHANGED
|
@@ -4740,6 +4740,13 @@ export declare interface IDashboardFilterView {
|
|
|
4740
4740
|
readonly filterContext: IFilterContextDefinition;
|
|
4741
4741
|
readonly isDefault?: boolean;
|
|
4742
4742
|
readonly tabLocalIdentifier?: string;
|
|
4743
|
+
/**
|
|
4744
|
+
* Dashboard parameter overrides captured at the time the view was saved.
|
|
4745
|
+
* Absent when the view was saved before parameters were supported.
|
|
4746
|
+
*
|
|
4747
|
+
* @alpha
|
|
4748
|
+
*/
|
|
4749
|
+
readonly parameters?: IDashboardParameter[];
|
|
4743
4750
|
}
|
|
4744
4751
|
|
|
4745
4752
|
/**
|
|
@@ -4754,6 +4761,12 @@ export declare interface IDashboardFilterViewSaveRequest {
|
|
|
4754
4761
|
readonly filterContext: IFilterContextDefinition;
|
|
4755
4762
|
readonly isDefault?: boolean;
|
|
4756
4763
|
readonly tabLocalIdentifier?: string;
|
|
4764
|
+
/**
|
|
4765
|
+
* Dashboard parameter overrides to capture in the filter view alongside the filter context.
|
|
4766
|
+
*
|
|
4767
|
+
* @alpha
|
|
4768
|
+
*/
|
|
4769
|
+
readonly parameters?: IDashboardParameter[];
|
|
4757
4770
|
}
|
|
4758
4771
|
|
|
4759
4772
|
/**
|
|
@@ -6360,6 +6373,10 @@ export declare interface IFeatureFlags {
|
|
|
6360
6373
|
* Indicates whether the Waterfall Chart is available in AD.
|
|
6361
6374
|
*/
|
|
6362
6375
|
enableWaterfallChart?: boolean;
|
|
6376
|
+
/**
|
|
6377
|
+
* Indicates whether the Radar Chart is available in AD.
|
|
6378
|
+
*/
|
|
6379
|
+
enableRadarChart?: boolean;
|
|
6363
6380
|
/**
|
|
6364
6381
|
* Indicates whether the Embed dashboard button is available in KPI dashboards.
|
|
6365
6382
|
*/
|
|
@@ -6568,10 +6585,6 @@ export declare interface IFeatureFlags {
|
|
|
6568
6585
|
* Enable fine-tuning options for visualization in AD configuration panel.
|
|
6569
6586
|
*/
|
|
6570
6587
|
enableVisualizationFineTuning?: boolean;
|
|
6571
|
-
/**
|
|
6572
|
-
* Enable improved attribute filters experience in Analytical Designer.
|
|
6573
|
-
*/
|
|
6574
|
-
enableImprovedAdFilters?: boolean;
|
|
6575
6588
|
/**
|
|
6576
6589
|
* Enable external recipients options
|
|
6577
6590
|
*/
|
|
@@ -6638,6 +6651,14 @@ export declare interface IFeatureFlags {
|
|
|
6638
6651
|
* @alpha
|
|
6639
6652
|
*/
|
|
6640
6653
|
enableDashboardSectionHeadersDateDataSet?: boolean;
|
|
6654
|
+
/**
|
|
6655
|
+
* When enabled, dashboards are stored using the V3 analytical-dashboard model — tabs-only,
|
|
6656
|
+
* no root-level layout / filter configs / parameters. This reduces payload size for large
|
|
6657
|
+
* dashboards but breaks readability for SDK versions that only know V2 root-level properties.
|
|
6658
|
+
* Opt-in for customers who do not consume dashboards via legacy SDK readers.
|
|
6659
|
+
* @alpha
|
|
6660
|
+
*/
|
|
6661
|
+
enableAnalyticalDashboardVersion3?: boolean;
|
|
6641
6662
|
/**
|
|
6642
6663
|
* Enable execution cancelling.
|
|
6643
6664
|
*/
|
|
@@ -6654,10 +6675,6 @@ export declare interface IFeatureFlags {
|
|
|
6654
6675
|
* Enable using execution timestamp.
|
|
6655
6676
|
*/
|
|
6656
6677
|
enableExecutionTimestamp?: boolean;
|
|
6657
|
-
/**
|
|
6658
|
-
* Enable automation filter context.
|
|
6659
|
-
*/
|
|
6660
|
-
enableAutomationFilterContext?: boolean;
|
|
6661
6678
|
/**
|
|
6662
6679
|
* Enables storing date filter identifiers.
|
|
6663
6680
|
*/
|
|
@@ -420,6 +420,10 @@ export interface IFeatureFlags {
|
|
|
420
420
|
* Indicates whether the Waterfall Chart is available in AD.
|
|
421
421
|
*/
|
|
422
422
|
enableWaterfallChart?: boolean;
|
|
423
|
+
/**
|
|
424
|
+
* Indicates whether the Radar Chart is available in AD.
|
|
425
|
+
*/
|
|
426
|
+
enableRadarChart?: boolean;
|
|
423
427
|
/**
|
|
424
428
|
* Indicates whether the Embed dashboard button is available in KPI dashboards.
|
|
425
429
|
*/
|
|
@@ -628,10 +632,6 @@ export interface IFeatureFlags {
|
|
|
628
632
|
* Enable fine-tuning options for visualization in AD configuration panel.
|
|
629
633
|
*/
|
|
630
634
|
enableVisualizationFineTuning?: boolean;
|
|
631
|
-
/**
|
|
632
|
-
* Enable improved attribute filters experience in Analytical Designer.
|
|
633
|
-
*/
|
|
634
|
-
enableImprovedAdFilters?: boolean;
|
|
635
635
|
/**
|
|
636
636
|
* Enable external recipients options
|
|
637
637
|
*/
|
|
@@ -698,6 +698,14 @@ export interface IFeatureFlags {
|
|
|
698
698
|
* @alpha
|
|
699
699
|
*/
|
|
700
700
|
enableDashboardSectionHeadersDateDataSet?: boolean;
|
|
701
|
+
/**
|
|
702
|
+
* When enabled, dashboards are stored using the V3 analytical-dashboard model — tabs-only,
|
|
703
|
+
* no root-level layout / filter configs / parameters. This reduces payload size for large
|
|
704
|
+
* dashboards but breaks readability for SDK versions that only know V2 root-level properties.
|
|
705
|
+
* Opt-in for customers who do not consume dashboards via legacy SDK readers.
|
|
706
|
+
* @alpha
|
|
707
|
+
*/
|
|
708
|
+
enableAnalyticalDashboardVersion3?: boolean;
|
|
701
709
|
/**
|
|
702
710
|
* Enable execution cancelling.
|
|
703
711
|
*/
|
|
@@ -714,10 +722,6 @@ export interface IFeatureFlags {
|
|
|
714
722
|
* Enable using execution timestamp.
|
|
715
723
|
*/
|
|
716
724
|
enableExecutionTimestamp?: boolean;
|
|
717
|
-
/**
|
|
718
|
-
* Enable automation filter context.
|
|
719
|
-
*/
|
|
720
|
-
enableAutomationFilterContext?: boolean;
|
|
721
725
|
/**
|
|
722
726
|
* Enables storing date filter identifiers.
|
|
723
727
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-model",
|
|
3
|
-
"version": "11.36.0-alpha.
|
|
3
|
+
"version": "11.36.0-alpha.6",
|
|
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/
|
|
61
|
-
"@gooddata/
|
|
60
|
+
"@gooddata/eslint-config": "11.36.0-alpha.6",
|
|
61
|
+
"@gooddata/oxlint-config": "11.36.0-alpha.6"
|
|
62
62
|
},
|
|
63
63
|
"scripts": {
|
|
64
64
|
"_phase:build": "npm run build",
|