@gooddata/sdk-code-schemas 11.29.0-alpha.4 → 11.29.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/sdk-code-schemas.d.ts +217 -11
- package/esm/v1/metadata.d.ts +33 -9
- package/esm/v1/metadata.d.ts.map +1 -1
- package/esm/v1/metadata.json +225 -4
- package/esm/v1/schema.d.ts +168 -0
- package/esm/v1/schema.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -880,7 +880,7 @@ declare interface Dashboard {
|
|
|
880
880
|
* A dashboard absolute date filter
|
|
881
881
|
*/
|
|
882
882
|
declare interface DashboardAbsoluteDateFilter {
|
|
883
|
-
type: "date_filter" | "attribute_filter" | "filter_group";
|
|
883
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
884
884
|
[k: string]: unknown;
|
|
885
885
|
}
|
|
886
886
|
|
|
@@ -960,7 +960,7 @@ declare type DashboardAttributeFilter1 = {
|
|
|
960
960
|
* A group of dashboard filters displayed together in the filter bar
|
|
961
961
|
*/
|
|
962
962
|
declare interface DashboardFilterGroup {
|
|
963
|
-
type: "date_filter" | "attribute_filter" | "filter_group";
|
|
963
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
964
964
|
}
|
|
965
965
|
|
|
966
966
|
declare interface DashboardFilters {
|
|
@@ -970,7 +970,7 @@ declare interface DashboardFilters {
|
|
|
970
970
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
971
971
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
972
972
|
*/
|
|
973
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardFilterGroup;
|
|
973
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
974
974
|
}
|
|
975
975
|
|
|
976
976
|
/**
|
|
@@ -983,17 +983,36 @@ declare interface DashboardFilters1 {
|
|
|
983
983
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
984
984
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
985
985
|
*/
|
|
986
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardFilterGroup;
|
|
986
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
987
987
|
}
|
|
988
988
|
|
|
989
989
|
/**
|
|
990
990
|
* A dashboard relative date filter
|
|
991
991
|
*/
|
|
992
992
|
declare interface DashboardRelativeDateFilter {
|
|
993
|
-
type: "date_filter" | "attribute_filter" | "filter_group";
|
|
993
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
994
994
|
[k: string]: unknown;
|
|
995
995
|
}
|
|
996
996
|
|
|
997
|
+
/**
|
|
998
|
+
* A dashboard text filter
|
|
999
|
+
*/
|
|
1000
|
+
declare type DashboardTextFilter = DashboardTextFilter1 | DashboardTextFilter2;
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* A dashboard text filter
|
|
1004
|
+
*/
|
|
1005
|
+
declare type DashboardTextFilter1 = {
|
|
1006
|
+
[k: string]: unknown;
|
|
1007
|
+
};
|
|
1008
|
+
|
|
1009
|
+
/**
|
|
1010
|
+
* A dashboard text filter
|
|
1011
|
+
*/
|
|
1012
|
+
declare type DashboardTextFilter2 = {
|
|
1013
|
+
[k: string]: unknown;
|
|
1014
|
+
};
|
|
1015
|
+
|
|
997
1016
|
declare type Dataset = NormalDataset | SQLDataset;
|
|
998
1017
|
|
|
999
1018
|
declare interface DateDataset {
|
|
@@ -1252,17 +1271,19 @@ declare interface Fields2 {
|
|
|
1252
1271
|
* This interface was referenced by `QueryFilters2`'s JSON-Schema definition
|
|
1253
1272
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1254
1273
|
*/
|
|
1255
|
-
declare type Filter = Filter1 | Filter2 | Filter3 | Filter4 | Filter5;
|
|
1274
|
+
declare type Filter = Filter1 | Filter2 | Filter3 | Filter4 | Filter5 | Filter6;
|
|
1256
1275
|
|
|
1257
1276
|
declare type Filter1 = DateFilter;
|
|
1258
1277
|
|
|
1259
1278
|
declare type Filter2 = AttributeFilter1;
|
|
1260
1279
|
|
|
1261
|
-
declare type Filter3 =
|
|
1280
|
+
declare type Filter3 = TextFilter;
|
|
1281
|
+
|
|
1282
|
+
declare type Filter4 = MetricValueFilter;
|
|
1262
1283
|
|
|
1263
|
-
declare type
|
|
1284
|
+
declare type Filter5 = RankingFilter;
|
|
1264
1285
|
|
|
1265
|
-
declare type
|
|
1286
|
+
declare type Filter6 = {
|
|
1266
1287
|
[k: string]: unknown;
|
|
1267
1288
|
};
|
|
1268
1289
|
|
|
@@ -5230,6 +5251,122 @@ export declare const metadata_v1: {
|
|
|
5230
5251
|
mode: string;
|
|
5231
5252
|
};
|
|
5232
5253
|
};
|
|
5254
|
+
dashboardTextFilter: {
|
|
5255
|
+
type: string;
|
|
5256
|
+
title: string;
|
|
5257
|
+
description: string;
|
|
5258
|
+
additionalProperties: boolean;
|
|
5259
|
+
properties: {
|
|
5260
|
+
title: {
|
|
5261
|
+
type: string;
|
|
5262
|
+
description: string;
|
|
5263
|
+
};
|
|
5264
|
+
type: {
|
|
5265
|
+
type: string;
|
|
5266
|
+
enum: string[];
|
|
5267
|
+
};
|
|
5268
|
+
using: {
|
|
5269
|
+
description: string;
|
|
5270
|
+
oneOf: {
|
|
5271
|
+
$ref: string;
|
|
5272
|
+
}[];
|
|
5273
|
+
$semantic: {
|
|
5274
|
+
type: string;
|
|
5275
|
+
};
|
|
5276
|
+
};
|
|
5277
|
+
condition: {
|
|
5278
|
+
type: string;
|
|
5279
|
+
enum: string[];
|
|
5280
|
+
};
|
|
5281
|
+
values: {
|
|
5282
|
+
type: string;
|
|
5283
|
+
items: {
|
|
5284
|
+
type: string[];
|
|
5285
|
+
};
|
|
5286
|
+
};
|
|
5287
|
+
value: {
|
|
5288
|
+
type: string;
|
|
5289
|
+
};
|
|
5290
|
+
case_sensitive: {
|
|
5291
|
+
type: string;
|
|
5292
|
+
};
|
|
5293
|
+
mode: {
|
|
5294
|
+
type: string;
|
|
5295
|
+
enum: string[];
|
|
5296
|
+
description: string;
|
|
5297
|
+
};
|
|
5298
|
+
parents: {
|
|
5299
|
+
type: string;
|
|
5300
|
+
description: string;
|
|
5301
|
+
uniqueItems: boolean;
|
|
5302
|
+
items: {
|
|
5303
|
+
oneOf: ({
|
|
5304
|
+
properties?: undefined;
|
|
5305
|
+
required?: undefined;
|
|
5306
|
+
type: string;
|
|
5307
|
+
title: string;
|
|
5308
|
+
description: string;
|
|
5309
|
+
$semantic: {
|
|
5310
|
+
type: string;
|
|
5311
|
+
sources: string[];
|
|
5312
|
+
};
|
|
5313
|
+
} | {
|
|
5314
|
+
$semantic?: undefined;
|
|
5315
|
+
description?: undefined;
|
|
5316
|
+
type: string;
|
|
5317
|
+
title: string;
|
|
5318
|
+
properties: {
|
|
5319
|
+
using: {
|
|
5320
|
+
type: string;
|
|
5321
|
+
description: string;
|
|
5322
|
+
$semantic: {
|
|
5323
|
+
type: string;
|
|
5324
|
+
source: string;
|
|
5325
|
+
};
|
|
5326
|
+
};
|
|
5327
|
+
common: {
|
|
5328
|
+
type: string;
|
|
5329
|
+
description: string;
|
|
5330
|
+
};
|
|
5331
|
+
};
|
|
5332
|
+
required: string[];
|
|
5333
|
+
})[];
|
|
5334
|
+
};
|
|
5335
|
+
};
|
|
5336
|
+
metric_filters: {
|
|
5337
|
+
type: string;
|
|
5338
|
+
description: string;
|
|
5339
|
+
uniqueItems: boolean;
|
|
5340
|
+
items: {
|
|
5341
|
+
type: string;
|
|
5342
|
+
$semantic: {
|
|
5343
|
+
type: string;
|
|
5344
|
+
sources: string[];
|
|
5345
|
+
typePrefix: boolean;
|
|
5346
|
+
};
|
|
5347
|
+
};
|
|
5348
|
+
};
|
|
5349
|
+
};
|
|
5350
|
+
allOf: {
|
|
5351
|
+
if: {
|
|
5352
|
+
properties: {
|
|
5353
|
+
condition: {
|
|
5354
|
+
enum: string[];
|
|
5355
|
+
};
|
|
5356
|
+
};
|
|
5357
|
+
required: string[];
|
|
5358
|
+
};
|
|
5359
|
+
then: {
|
|
5360
|
+
required: string[];
|
|
5361
|
+
};
|
|
5362
|
+
}[];
|
|
5363
|
+
required: string[];
|
|
5364
|
+
$semantic: {
|
|
5365
|
+
type: string;
|
|
5366
|
+
source: string;
|
|
5367
|
+
mode: string;
|
|
5368
|
+
};
|
|
5369
|
+
};
|
|
5233
5370
|
dashboardFilterGroup: {
|
|
5234
5371
|
type: string;
|
|
5235
5372
|
title: string;
|
|
@@ -5603,6 +5740,58 @@ export declare const metadata_v1: {
|
|
|
5603
5740
|
mode: string;
|
|
5604
5741
|
}[];
|
|
5605
5742
|
};
|
|
5743
|
+
queryTextFilter: {
|
|
5744
|
+
title: string;
|
|
5745
|
+
type: string;
|
|
5746
|
+
additionalProperties: boolean;
|
|
5747
|
+
properties: {
|
|
5748
|
+
type: {
|
|
5749
|
+
type: string;
|
|
5750
|
+
enum: string[];
|
|
5751
|
+
};
|
|
5752
|
+
using: {
|
|
5753
|
+
description: string;
|
|
5754
|
+
oneOf: {
|
|
5755
|
+
$ref: string;
|
|
5756
|
+
}[];
|
|
5757
|
+
};
|
|
5758
|
+
condition: {
|
|
5759
|
+
type: string;
|
|
5760
|
+
enum: string[];
|
|
5761
|
+
};
|
|
5762
|
+
values: {
|
|
5763
|
+
type: string;
|
|
5764
|
+
items: {
|
|
5765
|
+
type: string[];
|
|
5766
|
+
};
|
|
5767
|
+
};
|
|
5768
|
+
value: {
|
|
5769
|
+
type: string;
|
|
5770
|
+
};
|
|
5771
|
+
case_sensitive: {
|
|
5772
|
+
type: string;
|
|
5773
|
+
};
|
|
5774
|
+
};
|
|
5775
|
+
allOf: {
|
|
5776
|
+
if: {
|
|
5777
|
+
properties: {
|
|
5778
|
+
condition: {
|
|
5779
|
+
enum: string[];
|
|
5780
|
+
};
|
|
5781
|
+
};
|
|
5782
|
+
required: string[];
|
|
5783
|
+
};
|
|
5784
|
+
then: {
|
|
5785
|
+
required: string[];
|
|
5786
|
+
};
|
|
5787
|
+
}[];
|
|
5788
|
+
required: string[];
|
|
5789
|
+
$semantic: {
|
|
5790
|
+
type: string;
|
|
5791
|
+
source: string;
|
|
5792
|
+
mode: string;
|
|
5793
|
+
}[];
|
|
5794
|
+
};
|
|
5606
5795
|
queryMetricValueFilter: {
|
|
5607
5796
|
title: string;
|
|
5608
5797
|
type: string;
|
|
@@ -9978,6 +10167,16 @@ declare type Tags8 = string[];
|
|
|
9978
10167
|
*/
|
|
9979
10168
|
declare type Tags9 = string[];
|
|
9980
10169
|
|
|
10170
|
+
declare type TextFilter = TextFilter1 | TextFilter2;
|
|
10171
|
+
|
|
10172
|
+
declare type TextFilter1 = {
|
|
10173
|
+
[k: string]: unknown;
|
|
10174
|
+
};
|
|
10175
|
+
|
|
10176
|
+
declare type TextFilter2 = {
|
|
10177
|
+
[k: string]: unknown;
|
|
10178
|
+
};
|
|
10179
|
+
|
|
9981
10180
|
declare interface TOP {
|
|
9982
10181
|
type: "ranking_filter";
|
|
9983
10182
|
/**
|
|
@@ -10131,6 +10330,9 @@ export declare namespace v1 {
|
|
|
10131
10330
|
LabelIdentifier3,
|
|
10132
10331
|
DisplayAsLabelIdentifier1,
|
|
10133
10332
|
LocalAttributeFilter1,
|
|
10333
|
+
DashboardTextFilter,
|
|
10334
|
+
DashboardTextFilter1,
|
|
10335
|
+
DashboardTextFilter2,
|
|
10134
10336
|
Id12,
|
|
10135
10337
|
Id13,
|
|
10136
10338
|
Id14,
|
|
@@ -10170,6 +10372,10 @@ export declare namespace v1 {
|
|
|
10170
10372
|
DateFilter2,
|
|
10171
10373
|
Filter2,
|
|
10172
10374
|
Filter3,
|
|
10375
|
+
TextFilter,
|
|
10376
|
+
TextFilter1,
|
|
10377
|
+
TextFilter2,
|
|
10378
|
+
Filter4,
|
|
10173
10379
|
MetricValueFilter,
|
|
10174
10380
|
MultipleConditions,
|
|
10175
10381
|
MetricIdentifier,
|
|
@@ -10184,13 +10390,13 @@ export declare namespace v1 {
|
|
|
10184
10390
|
MetricIdentifier2,
|
|
10185
10391
|
All,
|
|
10186
10392
|
MetricIdentifier3,
|
|
10187
|
-
|
|
10393
|
+
Filter5,
|
|
10188
10394
|
RankingFilter,
|
|
10189
10395
|
MetricIdentifier4,
|
|
10190
10396
|
AttributeIdentifier8,
|
|
10191
10397
|
MetricIdentifier5,
|
|
10192
10398
|
AttributeIdentifier9,
|
|
10193
|
-
|
|
10399
|
+
Filter6,
|
|
10194
10400
|
MetricIdentifier6,
|
|
10195
10401
|
CalculatedMetricFieldGuard,
|
|
10196
10402
|
AttributeIdentifier10,
|
package/esm/v1/metadata.d.ts
CHANGED
|
@@ -322,6 +322,22 @@ export type DisplayAsLabelIdentifier1 = string;
|
|
|
322
322
|
* Local attribute or date filter to use as parent
|
|
323
323
|
*/
|
|
324
324
|
export type LocalAttributeFilter1 = string;
|
|
325
|
+
/**
|
|
326
|
+
* A dashboard text filter
|
|
327
|
+
*/
|
|
328
|
+
export type DashboardTextFilter = DashboardTextFilter1 | DashboardTextFilter2;
|
|
329
|
+
/**
|
|
330
|
+
* A dashboard text filter
|
|
331
|
+
*/
|
|
332
|
+
export type DashboardTextFilter1 = {
|
|
333
|
+
[k: string]: unknown;
|
|
334
|
+
};
|
|
335
|
+
/**
|
|
336
|
+
* A dashboard text filter
|
|
337
|
+
*/
|
|
338
|
+
export type DashboardTextFilter2 = {
|
|
339
|
+
[k: string]: unknown;
|
|
340
|
+
};
|
|
325
341
|
/**
|
|
326
342
|
* An unique identifier of the plugin.
|
|
327
343
|
*/
|
|
@@ -429,7 +445,7 @@ export type MetricFieldGuard = MetricField | MetricFieldGuard1;
|
|
|
429
445
|
* This interface was referenced by `QueryFilters2`'s JSON-Schema definition
|
|
430
446
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
431
447
|
*/
|
|
432
|
-
export type Filter = Filter1 | Filter2 | Filter3 | Filter4 | Filter5;
|
|
448
|
+
export type Filter = Filter1 | Filter2 | Filter3 | Filter4 | Filter5 | Filter6;
|
|
433
449
|
export type Filter1 = DateFilter;
|
|
434
450
|
export type DateFilter = DateFilter1 | DateFilter2;
|
|
435
451
|
export type DateFilter1 = {
|
|
@@ -501,7 +517,15 @@ export type DateFilter2 = {
|
|
|
501
517
|
[k: string]: unknown;
|
|
502
518
|
};
|
|
503
519
|
export type Filter2 = AttributeFilter1;
|
|
504
|
-
export type Filter3 =
|
|
520
|
+
export type Filter3 = TextFilter;
|
|
521
|
+
export type TextFilter = TextFilter1 | TextFilter2;
|
|
522
|
+
export type TextFilter1 = {
|
|
523
|
+
[k: string]: unknown;
|
|
524
|
+
};
|
|
525
|
+
export type TextFilter2 = {
|
|
526
|
+
[k: string]: unknown;
|
|
527
|
+
};
|
|
528
|
+
export type Filter4 = MetricValueFilter;
|
|
505
529
|
export type MetricValueFilter = MultipleConditions | Comparison | Range | All;
|
|
506
530
|
export type MultipleConditions = MultipleConditions1;
|
|
507
531
|
/**
|
|
@@ -534,7 +558,7 @@ export type All = All1;
|
|
|
534
558
|
* Metric or local metric to use in this filter.
|
|
535
559
|
*/
|
|
536
560
|
export type MetricIdentifier3 = string;
|
|
537
|
-
export type
|
|
561
|
+
export type Filter5 = RankingFilter;
|
|
538
562
|
export type RankingFilter = BOTTOM | TOP;
|
|
539
563
|
/**
|
|
540
564
|
* Metric identifier to use for this filter.
|
|
@@ -552,7 +576,7 @@ export type MetricIdentifier5 = string;
|
|
|
552
576
|
* Attribute identifier to use for this filter.
|
|
553
577
|
*/
|
|
554
578
|
export type AttributeIdentifier9 = string;
|
|
555
|
-
export type
|
|
579
|
+
export type Filter6 = {
|
|
556
580
|
[k: string]: unknown;
|
|
557
581
|
};
|
|
558
582
|
/**
|
|
@@ -1631,20 +1655,20 @@ export interface DashboardFilters {
|
|
|
1631
1655
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
1632
1656
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1633
1657
|
*/
|
|
1634
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardFilterGroup;
|
|
1658
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
1635
1659
|
}
|
|
1636
1660
|
/**
|
|
1637
1661
|
* A dashboard absolute date filter
|
|
1638
1662
|
*/
|
|
1639
1663
|
export interface DashboardAbsoluteDateFilter {
|
|
1640
|
-
type: "date_filter" | "attribute_filter" | "filter_group";
|
|
1664
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
1641
1665
|
[k: string]: unknown;
|
|
1642
1666
|
}
|
|
1643
1667
|
/**
|
|
1644
1668
|
* A dashboard relative date filter
|
|
1645
1669
|
*/
|
|
1646
1670
|
export interface DashboardRelativeDateFilter {
|
|
1647
|
-
type: "date_filter" | "attribute_filter" | "filter_group";
|
|
1671
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
1648
1672
|
[k: string]: unknown;
|
|
1649
1673
|
}
|
|
1650
1674
|
export interface LocalDateFilter {
|
|
@@ -1673,7 +1697,7 @@ export interface LocalDateFilter1 {
|
|
|
1673
1697
|
* A group of dashboard filters displayed together in the filter bar
|
|
1674
1698
|
*/
|
|
1675
1699
|
export interface DashboardFilterGroup {
|
|
1676
|
-
type: "date_filter" | "attribute_filter" | "filter_group";
|
|
1700
|
+
type: "date_filter" | "attribute_filter" | "text_filter" | "filter_group";
|
|
1677
1701
|
}
|
|
1678
1702
|
export interface Tab {
|
|
1679
1703
|
id: Id14;
|
|
@@ -1697,7 +1721,7 @@ export interface DashboardFilters1 {
|
|
|
1697
1721
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
1698
1722
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1699
1723
|
*/
|
|
1700
|
-
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardFilterGroup;
|
|
1724
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardFilterGroup;
|
|
1701
1725
|
}
|
|
1702
1726
|
/**
|
|
1703
1727
|
* A permission object
|