@gooddata/sdk-code-schemas 11.51.0-alpha.1 → 11.51.0-alpha.3
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 +60 -2
- package/esm/v1/metadata.d.ts +20 -2
- package/esm/v1/metadata.d.ts.map +1 -1
- package/esm/v1/metadata.json +49 -0
- package/esm/v1/schema.d.ts +38 -0
- package/esm/v1/schema.d.ts.map +1 -1
- package/package.json +3 -3
|
@@ -902,6 +902,7 @@ declare interface Dashboard {
|
|
|
902
902
|
* Whether persistent filters across tabs are enabled for this dashboard. Defaults to true.
|
|
903
903
|
*/
|
|
904
904
|
persistent_filters_across_tabs?: boolean;
|
|
905
|
+
timezone_config?: TimezoneConfig;
|
|
905
906
|
/**
|
|
906
907
|
* Applies to the root layout. Whether all sections headers are enabled. Defaults to true.
|
|
907
908
|
*/
|
|
@@ -1162,7 +1163,7 @@ declare interface DateDataset {
|
|
|
1162
1163
|
* A pattern for the title formatting
|
|
1163
1164
|
*/
|
|
1164
1165
|
title_pattern?: string;
|
|
1165
|
-
granularities?: ("MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_WEEK_EU" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "DAY_OF_QUARTER" | "WEEK_OF_YEAR" | "WEEK_OF_YEAR_EU" | "WEEK_OF_QUARTER_EU" | "WEEK_OF_QUARTER" | "MONTH_OF_YEAR" | "MONTH_OF_QUARTER" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH")[];
|
|
1166
|
+
granularities?: ("SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "SECOND_OF_MINUTE" | "SECOND_OF_DAY" | "MINUTE_OF_HOUR" | "MINUTE_OF_DAY" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_WEEK_EU" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "DAY_OF_QUARTER" | "WEEK_OF_YEAR" | "WEEK_OF_YEAR_EU" | "WEEK_OF_QUARTER_EU" | "WEEK_OF_QUARTER" | "MONTH_OF_YEAR" | "MONTH_OF_QUARTER" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH")[];
|
|
1166
1167
|
}
|
|
1167
1168
|
|
|
1168
1169
|
declare type DateFilter = DateFilter1 | DateFilter2;
|
|
@@ -1176,7 +1177,7 @@ declare type DateFilter1 = {
|
|
|
1176
1177
|
/**
|
|
1177
1178
|
* A granularity to use in relative date filter
|
|
1178
1179
|
*/
|
|
1179
|
-
granularity: "MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH";
|
|
1180
|
+
granularity: "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "SECOND_OF_MINUTE" | "SECOND_OF_DAY" | "MINUTE_OF_HOUR" | "MINUTE_OF_DAY" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH";
|
|
1180
1181
|
/**
|
|
1181
1182
|
* A relative granularity from which the filter will be applied.
|
|
1182
1183
|
*/
|
|
@@ -2916,6 +2917,10 @@ export declare const metadata_v1: {
|
|
|
2916
2917
|
type: string;
|
|
2917
2918
|
description: string;
|
|
2918
2919
|
};
|
|
2920
|
+
timezone_config: {
|
|
2921
|
+
$ref: string;
|
|
2922
|
+
description: string;
|
|
2923
|
+
};
|
|
2919
2924
|
enable_section_headers: {
|
|
2920
2925
|
type: string;
|
|
2921
2926
|
description: string;
|
|
@@ -7286,6 +7291,10 @@ export declare const metadata_v1: {
|
|
|
7286
7291
|
type: string;
|
|
7287
7292
|
description: string;
|
|
7288
7293
|
};
|
|
7294
|
+
timezone_config: {
|
|
7295
|
+
$ref: string;
|
|
7296
|
+
description: string;
|
|
7297
|
+
};
|
|
7289
7298
|
enable_section_headers: {
|
|
7290
7299
|
type: string;
|
|
7291
7300
|
description: string;
|
|
@@ -7370,6 +7379,24 @@ export declare const metadata_v1: {
|
|
|
7370
7379
|
};
|
|
7371
7380
|
required: string[];
|
|
7372
7381
|
};
|
|
7382
|
+
timezoneConfig: {
|
|
7383
|
+
type: string;
|
|
7384
|
+
additionalProperties: boolean;
|
|
7385
|
+
properties: {
|
|
7386
|
+
timezone_id: {
|
|
7387
|
+
$ref: string;
|
|
7388
|
+
description: string;
|
|
7389
|
+
};
|
|
7390
|
+
show_timezone_info: {
|
|
7391
|
+
type: string;
|
|
7392
|
+
description: string;
|
|
7393
|
+
};
|
|
7394
|
+
allow_user_override_in_view_mode: {
|
|
7395
|
+
type: string;
|
|
7396
|
+
description: string;
|
|
7397
|
+
};
|
|
7398
|
+
};
|
|
7399
|
+
};
|
|
7373
7400
|
section: {
|
|
7374
7401
|
type: string;
|
|
7375
7402
|
additionalProperties: boolean;
|
|
@@ -7425,6 +7452,18 @@ export declare const metadata_v1: {
|
|
|
7425
7452
|
};
|
|
7426
7453
|
required: string[];
|
|
7427
7454
|
};
|
|
7455
|
+
timezoneId: {
|
|
7456
|
+
description: string;
|
|
7457
|
+
oneOf: ({
|
|
7458
|
+
pattern?: undefined;
|
|
7459
|
+
type: string;
|
|
7460
|
+
const: string;
|
|
7461
|
+
} | {
|
|
7462
|
+
const?: undefined;
|
|
7463
|
+
type: string;
|
|
7464
|
+
pattern: string;
|
|
7465
|
+
})[];
|
|
7466
|
+
};
|
|
7428
7467
|
widget: {
|
|
7429
7468
|
title: string;
|
|
7430
7469
|
type: string;
|
|
@@ -11096,6 +11135,24 @@ declare interface TextFilter2 {
|
|
|
11096
11135
|
[k: string]: unknown;
|
|
11097
11136
|
}
|
|
11098
11137
|
|
|
11138
|
+
/**
|
|
11139
|
+
* Dashboard-level timezone configuration. If omitted, the workspace or organization timezone setting is used.
|
|
11140
|
+
*/
|
|
11141
|
+
declare interface TimezoneConfig {
|
|
11142
|
+
/**
|
|
11143
|
+
* Dashboard default timezone. Use an IANA timezone ID or $browserDetected. If omitted, the workspace or organization timezone setting is used.
|
|
11144
|
+
*/
|
|
11145
|
+
timezone_id?: "$browserDetected" | string;
|
|
11146
|
+
/**
|
|
11147
|
+
* Whether the dashboard timezone indicator is visible.
|
|
11148
|
+
*/
|
|
11149
|
+
show_timezone_info?: boolean;
|
|
11150
|
+
/**
|
|
11151
|
+
* Whether viewers can override the dashboard timezone for their current session.
|
|
11152
|
+
*/
|
|
11153
|
+
allow_user_override_in_view_mode?: boolean;
|
|
11154
|
+
}
|
|
11155
|
+
|
|
11099
11156
|
declare interface TOP {
|
|
11100
11157
|
type: "ranking_filter";
|
|
11101
11158
|
/**
|
|
@@ -11465,6 +11522,7 @@ export declare namespace v1 {
|
|
|
11465
11522
|
Metric,
|
|
11466
11523
|
Metadata13,
|
|
11467
11524
|
Dashboard,
|
|
11525
|
+
TimezoneConfig,
|
|
11468
11526
|
Section,
|
|
11469
11527
|
VisualisationWidget,
|
|
11470
11528
|
InteractionOpenPlainUrl,
|
package/esm/v1/metadata.d.ts
CHANGED
|
@@ -498,7 +498,7 @@ export type DateFilter1 = {
|
|
|
498
498
|
/**
|
|
499
499
|
* A granularity to use in relative date filter
|
|
500
500
|
*/
|
|
501
|
-
granularity: "MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH";
|
|
501
|
+
granularity: "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "SECOND_OF_MINUTE" | "SECOND_OF_DAY" | "MINUTE_OF_HOUR" | "MINUTE_OF_DAY" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH";
|
|
502
502
|
/**
|
|
503
503
|
* A relative granularity from which the filter will be applied.
|
|
504
504
|
*/
|
|
@@ -1447,7 +1447,7 @@ export interface DateDataset {
|
|
|
1447
1447
|
* A pattern for the title formatting
|
|
1448
1448
|
*/
|
|
1449
1449
|
title_pattern?: string;
|
|
1450
|
-
granularities?: ("MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_WEEK_EU" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "DAY_OF_QUARTER" | "WEEK_OF_YEAR" | "WEEK_OF_YEAR_EU" | "WEEK_OF_QUARTER_EU" | "WEEK_OF_QUARTER" | "MONTH_OF_YEAR" | "MONTH_OF_QUARTER" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH")[];
|
|
1450
|
+
granularities?: ("SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "SECOND_OF_MINUTE" | "SECOND_OF_DAY" | "MINUTE_OF_HOUR" | "MINUTE_OF_DAY" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_WEEK_EU" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "DAY_OF_QUARTER" | "WEEK_OF_YEAR" | "WEEK_OF_YEAR_EU" | "WEEK_OF_QUARTER_EU" | "WEEK_OF_QUARTER" | "MONTH_OF_YEAR" | "MONTH_OF_QUARTER" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH")[];
|
|
1451
1451
|
}
|
|
1452
1452
|
export interface Metadata10 {
|
|
1453
1453
|
type: "dataset" | "date" | "metric" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy";
|
|
@@ -1523,6 +1523,7 @@ export interface Dashboard {
|
|
|
1523
1523
|
* Whether persistent filters across tabs are enabled for this dashboard. Defaults to true.
|
|
1524
1524
|
*/
|
|
1525
1525
|
persistent_filters_across_tabs?: boolean;
|
|
1526
|
+
timezone_config?: TimezoneConfig;
|
|
1526
1527
|
/**
|
|
1527
1528
|
* Applies to the root layout. Whether all sections headers are enabled. Defaults to true.
|
|
1528
1529
|
*/
|
|
@@ -1557,6 +1558,23 @@ export interface Dashboard {
|
|
|
1557
1558
|
SHARE?: Permission;
|
|
1558
1559
|
};
|
|
1559
1560
|
}
|
|
1561
|
+
/**
|
|
1562
|
+
* Dashboard-level timezone configuration. If omitted, the workspace or organization timezone setting is used.
|
|
1563
|
+
*/
|
|
1564
|
+
export interface TimezoneConfig {
|
|
1565
|
+
/**
|
|
1566
|
+
* Dashboard default timezone. Use an IANA timezone ID or $browserDetected. If omitted, the workspace or organization timezone setting is used.
|
|
1567
|
+
*/
|
|
1568
|
+
timezone_id?: "$browserDetected" | string;
|
|
1569
|
+
/**
|
|
1570
|
+
* Whether the dashboard timezone indicator is visible.
|
|
1571
|
+
*/
|
|
1572
|
+
show_timezone_info?: boolean;
|
|
1573
|
+
/**
|
|
1574
|
+
* Whether viewers can override the dashboard timezone for their current session.
|
|
1575
|
+
*/
|
|
1576
|
+
allow_user_override_in_view_mode?: boolean;
|
|
1577
|
+
}
|
|
1560
1578
|
export interface Section {
|
|
1561
1579
|
/**
|
|
1562
1580
|
* Optional title of the section
|