@gooddata/sdk-code-schemas 11.32.0-alpha.3 → 11.32.0-alpha.5
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/sdk-code-schemas.d.ts +149 -95
- package/esm/v1/metadata.d.ts +12 -5
- package/esm/v1/metadata.d.ts.map +1 -1
- package/esm/v1/metadata.json +153 -92
- package/esm/v1/schema.d.ts +135 -90
- package/esm/v1/schema.d.ts.map +1 -1
- package/package.json +3 -3
|
@@ -900,7 +900,7 @@ declare interface Dashboard {
|
|
|
900
900
|
* A dashboard absolute date filter
|
|
901
901
|
*/
|
|
902
902
|
declare interface DashboardAbsoluteDateFilter {
|
|
903
|
-
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
903
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
904
904
|
[k: string]: unknown;
|
|
905
905
|
}
|
|
906
906
|
|
|
@@ -988,7 +988,7 @@ declare type DashboardAttributeFilter1 = {
|
|
|
988
988
|
* A group of dashboard filters displayed together in the filter bar
|
|
989
989
|
*/
|
|
990
990
|
declare interface DashboardFilterGroup {
|
|
991
|
-
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
991
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
992
992
|
}
|
|
993
993
|
|
|
994
994
|
declare interface DashboardFilters {
|
|
@@ -998,7 +998,7 @@ declare interface DashboardFilters {
|
|
|
998
998
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
999
999
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1000
1000
|
*/
|
|
1001
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
1001
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
1002
1002
|
}
|
|
1003
1003
|
|
|
1004
1004
|
/**
|
|
@@ -1011,14 +1011,22 @@ declare interface DashboardFilters1 {
|
|
|
1011
1011
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
1012
1012
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1013
1013
|
*/
|
|
1014
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
1014
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
/**
|
|
1018
|
+
* A dashboard-level filter that filters data by metric value across visualizations. Conditions are OR-ed together; omitting them means "All" (no filtering). Granularity is inherited from each affected visualization.
|
|
1019
|
+
*/
|
|
1020
|
+
declare interface DashboardMetricValueFilter {
|
|
1021
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
1022
|
+
[k: string]: unknown;
|
|
1015
1023
|
}
|
|
1016
1024
|
|
|
1017
1025
|
/**
|
|
1018
1026
|
* A dashboard relative date filter
|
|
1019
1027
|
*/
|
|
1020
1028
|
declare interface DashboardRelativeDateFilter {
|
|
1021
|
-
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
1029
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
1022
1030
|
[k: string]: unknown;
|
|
1023
1031
|
}
|
|
1024
1032
|
|
|
@@ -5650,6 +5658,51 @@ export declare const metadata_v1: {
|
|
|
5650
5658
|
mode: string;
|
|
5651
5659
|
};
|
|
5652
5660
|
};
|
|
5661
|
+
dashboardMetricValueFilter: {
|
|
5662
|
+
type: string;
|
|
5663
|
+
title: string;
|
|
5664
|
+
description: string;
|
|
5665
|
+
properties: {
|
|
5666
|
+
type: {
|
|
5667
|
+
type: string;
|
|
5668
|
+
enum: string[];
|
|
5669
|
+
};
|
|
5670
|
+
title: {
|
|
5671
|
+
type: string;
|
|
5672
|
+
description: string;
|
|
5673
|
+
};
|
|
5674
|
+
using: {
|
|
5675
|
+
$ref: string;
|
|
5676
|
+
description: string;
|
|
5677
|
+
$semantic: {
|
|
5678
|
+
type: string;
|
|
5679
|
+
source: string;
|
|
5680
|
+
};
|
|
5681
|
+
};
|
|
5682
|
+
conditions: {
|
|
5683
|
+
type: string;
|
|
5684
|
+
description: string;
|
|
5685
|
+
items: {
|
|
5686
|
+
$ref: string;
|
|
5687
|
+
};
|
|
5688
|
+
};
|
|
5689
|
+
null_values_as_zero: {
|
|
5690
|
+
type: string;
|
|
5691
|
+
description: string;
|
|
5692
|
+
};
|
|
5693
|
+
mode: {
|
|
5694
|
+
type: string;
|
|
5695
|
+
enum: string[];
|
|
5696
|
+
description: string;
|
|
5697
|
+
};
|
|
5698
|
+
};
|
|
5699
|
+
required: string[];
|
|
5700
|
+
$semantic: {
|
|
5701
|
+
type: string;
|
|
5702
|
+
source: string;
|
|
5703
|
+
mode: string;
|
|
5704
|
+
};
|
|
5705
|
+
};
|
|
5653
5706
|
dashboardFilterGroup: {
|
|
5654
5707
|
type: string;
|
|
5655
5708
|
title: string;
|
|
@@ -5752,6 +5805,94 @@ export declare const metadata_v1: {
|
|
|
5752
5805
|
type: string;
|
|
5753
5806
|
enum: string[];
|
|
5754
5807
|
};
|
|
5808
|
+
mvfCondition: {
|
|
5809
|
+
title: string;
|
|
5810
|
+
type: string;
|
|
5811
|
+
properties: {
|
|
5812
|
+
condition: {
|
|
5813
|
+
type: string;
|
|
5814
|
+
enum: string[];
|
|
5815
|
+
description: string;
|
|
5816
|
+
};
|
|
5817
|
+
};
|
|
5818
|
+
allOf: ({
|
|
5819
|
+
title: string;
|
|
5820
|
+
if: {
|
|
5821
|
+
properties?: undefined;
|
|
5822
|
+
required?: undefined;
|
|
5823
|
+
not: {
|
|
5824
|
+
required: string[];
|
|
5825
|
+
};
|
|
5826
|
+
};
|
|
5827
|
+
then: {
|
|
5828
|
+
required?: undefined;
|
|
5829
|
+
additionalProperties: boolean;
|
|
5830
|
+
properties: {
|
|
5831
|
+
from?: undefined;
|
|
5832
|
+
to?: undefined;
|
|
5833
|
+
value?: undefined;
|
|
5834
|
+
condition?: undefined;
|
|
5835
|
+
};
|
|
5836
|
+
};
|
|
5837
|
+
} | {
|
|
5838
|
+
title: string;
|
|
5839
|
+
if: {
|
|
5840
|
+
not?: undefined;
|
|
5841
|
+
properties: {
|
|
5842
|
+
condition: {
|
|
5843
|
+
enum: string[];
|
|
5844
|
+
};
|
|
5845
|
+
};
|
|
5846
|
+
required: string[];
|
|
5847
|
+
};
|
|
5848
|
+
then: {
|
|
5849
|
+
additionalProperties: boolean;
|
|
5850
|
+
properties: {
|
|
5851
|
+
from?: undefined;
|
|
5852
|
+
to?: undefined;
|
|
5853
|
+
condition: {
|
|
5854
|
+
type: string;
|
|
5855
|
+
enum: string[];
|
|
5856
|
+
};
|
|
5857
|
+
value: {
|
|
5858
|
+
type: string;
|
|
5859
|
+
description: string;
|
|
5860
|
+
};
|
|
5861
|
+
};
|
|
5862
|
+
required: string[];
|
|
5863
|
+
};
|
|
5864
|
+
} | {
|
|
5865
|
+
title: string;
|
|
5866
|
+
if: {
|
|
5867
|
+
not?: undefined;
|
|
5868
|
+
properties: {
|
|
5869
|
+
condition: {
|
|
5870
|
+
enum: string[];
|
|
5871
|
+
};
|
|
5872
|
+
};
|
|
5873
|
+
required: string[];
|
|
5874
|
+
};
|
|
5875
|
+
then: {
|
|
5876
|
+
additionalProperties: boolean;
|
|
5877
|
+
properties: {
|
|
5878
|
+
value?: undefined;
|
|
5879
|
+
condition: {
|
|
5880
|
+
type: string;
|
|
5881
|
+
enum: string[];
|
|
5882
|
+
};
|
|
5883
|
+
from: {
|
|
5884
|
+
type: string;
|
|
5885
|
+
description: string;
|
|
5886
|
+
};
|
|
5887
|
+
to: {
|
|
5888
|
+
type: string;
|
|
5889
|
+
description: string;
|
|
5890
|
+
};
|
|
5891
|
+
};
|
|
5892
|
+
required: string[];
|
|
5893
|
+
};
|
|
5894
|
+
})[];
|
|
5895
|
+
};
|
|
5755
5896
|
queryFilter: {
|
|
5756
5897
|
title: string;
|
|
5757
5898
|
allOf: ({
|
|
@@ -6142,10 +6283,10 @@ export declare const metadata_v1: {
|
|
|
6142
6283
|
if: {
|
|
6143
6284
|
not?: undefined;
|
|
6144
6285
|
properties: {
|
|
6286
|
+
condition?: undefined;
|
|
6145
6287
|
conditions: {
|
|
6146
6288
|
type: string;
|
|
6147
6289
|
};
|
|
6148
|
-
condition?: undefined;
|
|
6149
6290
|
};
|
|
6150
6291
|
required: string[];
|
|
6151
6292
|
};
|
|
@@ -6155,6 +6296,7 @@ export declare const metadata_v1: {
|
|
|
6155
6296
|
from?: undefined;
|
|
6156
6297
|
to?: undefined;
|
|
6157
6298
|
value?: undefined;
|
|
6299
|
+
condition?: undefined;
|
|
6158
6300
|
type: {
|
|
6159
6301
|
type: string;
|
|
6160
6302
|
enum: string[];
|
|
@@ -6204,7 +6346,6 @@ export declare const metadata_v1: {
|
|
|
6204
6346
|
})[];
|
|
6205
6347
|
};
|
|
6206
6348
|
};
|
|
6207
|
-
condition?: undefined;
|
|
6208
6349
|
};
|
|
6209
6350
|
required: string[];
|
|
6210
6351
|
};
|
|
@@ -6490,94 +6631,6 @@ export declare const metadata_v1: {
|
|
|
6490
6631
|
mode: string;
|
|
6491
6632
|
};
|
|
6492
6633
|
};
|
|
6493
|
-
mvfCondition: {
|
|
6494
|
-
title: string;
|
|
6495
|
-
type: string;
|
|
6496
|
-
properties: {
|
|
6497
|
-
condition: {
|
|
6498
|
-
type: string;
|
|
6499
|
-
enum: string[];
|
|
6500
|
-
description: string;
|
|
6501
|
-
};
|
|
6502
|
-
};
|
|
6503
|
-
allOf: ({
|
|
6504
|
-
title: string;
|
|
6505
|
-
if: {
|
|
6506
|
-
properties?: undefined;
|
|
6507
|
-
required?: undefined;
|
|
6508
|
-
not: {
|
|
6509
|
-
required: string[];
|
|
6510
|
-
};
|
|
6511
|
-
};
|
|
6512
|
-
then: {
|
|
6513
|
-
required?: undefined;
|
|
6514
|
-
additionalProperties: boolean;
|
|
6515
|
-
properties: {
|
|
6516
|
-
from?: undefined;
|
|
6517
|
-
to?: undefined;
|
|
6518
|
-
value?: undefined;
|
|
6519
|
-
condition?: undefined;
|
|
6520
|
-
};
|
|
6521
|
-
};
|
|
6522
|
-
} | {
|
|
6523
|
-
title: string;
|
|
6524
|
-
if: {
|
|
6525
|
-
not?: undefined;
|
|
6526
|
-
properties: {
|
|
6527
|
-
condition: {
|
|
6528
|
-
enum: string[];
|
|
6529
|
-
};
|
|
6530
|
-
};
|
|
6531
|
-
required: string[];
|
|
6532
|
-
};
|
|
6533
|
-
then: {
|
|
6534
|
-
additionalProperties: boolean;
|
|
6535
|
-
properties: {
|
|
6536
|
-
from?: undefined;
|
|
6537
|
-
to?: undefined;
|
|
6538
|
-
condition: {
|
|
6539
|
-
type: string;
|
|
6540
|
-
enum: string[];
|
|
6541
|
-
};
|
|
6542
|
-
value: {
|
|
6543
|
-
type: string;
|
|
6544
|
-
description: string;
|
|
6545
|
-
};
|
|
6546
|
-
};
|
|
6547
|
-
required: string[];
|
|
6548
|
-
};
|
|
6549
|
-
} | {
|
|
6550
|
-
title: string;
|
|
6551
|
-
if: {
|
|
6552
|
-
not?: undefined;
|
|
6553
|
-
properties: {
|
|
6554
|
-
condition: {
|
|
6555
|
-
enum: string[];
|
|
6556
|
-
};
|
|
6557
|
-
};
|
|
6558
|
-
required: string[];
|
|
6559
|
-
};
|
|
6560
|
-
then: {
|
|
6561
|
-
additionalProperties: boolean;
|
|
6562
|
-
properties: {
|
|
6563
|
-
value?: undefined;
|
|
6564
|
-
condition: {
|
|
6565
|
-
type: string;
|
|
6566
|
-
enum: string[];
|
|
6567
|
-
};
|
|
6568
|
-
from: {
|
|
6569
|
-
type: string;
|
|
6570
|
-
description: string;
|
|
6571
|
-
};
|
|
6572
|
-
to: {
|
|
6573
|
-
type: string;
|
|
6574
|
-
description: string;
|
|
6575
|
-
};
|
|
6576
|
-
};
|
|
6577
|
-
required: string[];
|
|
6578
|
-
};
|
|
6579
|
-
})[];
|
|
6580
|
-
};
|
|
6581
6634
|
widthItem: {
|
|
6582
6635
|
title: string;
|
|
6583
6636
|
type: string;
|
|
@@ -10908,6 +10961,7 @@ export declare namespace v1 {
|
|
|
10908
10961
|
DashboardTextFilter1,
|
|
10909
10962
|
LocalDateFilter2,
|
|
10910
10963
|
DashboardTextFilter2,
|
|
10964
|
+
DashboardMetricValueFilter,
|
|
10911
10965
|
DashboardFilterGroup,
|
|
10912
10966
|
Tab,
|
|
10913
10967
|
DashboardFilters1,
|
package/esm/v1/metadata.d.ts
CHANGED
|
@@ -1705,20 +1705,20 @@ export interface DashboardFilters {
|
|
|
1705
1705
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
1706
1706
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1707
1707
|
*/
|
|
1708
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
1708
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
1709
1709
|
}
|
|
1710
1710
|
/**
|
|
1711
1711
|
* A dashboard absolute date filter
|
|
1712
1712
|
*/
|
|
1713
1713
|
export interface DashboardAbsoluteDateFilter {
|
|
1714
|
-
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
1714
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
1715
1715
|
[k: string]: unknown;
|
|
1716
1716
|
}
|
|
1717
1717
|
/**
|
|
1718
1718
|
* A dashboard relative date filter
|
|
1719
1719
|
*/
|
|
1720
1720
|
export interface DashboardRelativeDateFilter {
|
|
1721
|
-
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
1721
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
1722
1722
|
[k: string]: unknown;
|
|
1723
1723
|
}
|
|
1724
1724
|
export interface LocalDateFilter {
|
|
@@ -1816,11 +1816,18 @@ export interface DashboardTextFilter2 {
|
|
|
1816
1816
|
selection_type?: "list" | "text" | "listOrText";
|
|
1817
1817
|
[k: string]: unknown;
|
|
1818
1818
|
}
|
|
1819
|
+
/**
|
|
1820
|
+
* A dashboard-level filter that filters data by metric value across visualizations. Conditions are OR-ed together; omitting them means "All" (no filtering). Granularity is inherited from each affected visualization.
|
|
1821
|
+
*/
|
|
1822
|
+
export interface DashboardMetricValueFilter {
|
|
1823
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
1824
|
+
[k: string]: unknown;
|
|
1825
|
+
}
|
|
1819
1826
|
/**
|
|
1820
1827
|
* A group of dashboard filters displayed together in the filter bar
|
|
1821
1828
|
*/
|
|
1822
1829
|
export interface DashboardFilterGroup {
|
|
1823
|
-
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
1830
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "metric_value_filter" | "filter_group";
|
|
1824
1831
|
}
|
|
1825
1832
|
export interface Tab {
|
|
1826
1833
|
id: Id14;
|
|
@@ -1844,7 +1851,7 @@ export interface DashboardFilters1 {
|
|
|
1844
1851
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
1845
1852
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1846
1853
|
*/
|
|
1847
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
1854
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
1848
1855
|
}
|
|
1849
1856
|
/**
|
|
1850
1857
|
* A permission object
|