@gooddata/sdk-model 11.26.0-alpha.0 → 11.26.0-alpha.2

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.
@@ -1,6 +1,7 @@
1
- import { type IDateFilterConfig } from "../dateFilterConfig/index.js";
1
+ import { type IFeatureFlags, type IPermanentSettings } from "./settings.js";
2
+ import { type RemotePluggableApplicationsRegistry } from "../pluggableApplication/index.js";
2
3
  /**
3
- * Settings are obtained from backend and are effectively a collection of feature flags or settings with
4
+ * Settings are obtained from the backend and are effectively a collection of feature flags or settings with
4
5
  * concrete string or numeric value.
5
6
  *
6
7
  * @remarks
@@ -9,891 +10,16 @@ import { type IDateFilterConfig } from "../dateFilterConfig/index.js";
9
10
  *
10
11
  * @public
11
12
  */
12
- export interface ISettings {
13
+ export interface ISettings extends IPermanentSettings, IFeatureFlags {
13
14
  /**
14
- * Represents whiteLabeling configuration
15
- */
16
- whiteLabeling?: IWhiteLabeling;
17
- /**
18
- * Represents alert default configuration
19
- */
20
- alertDefault?: IAlertDefault;
21
- /**
22
- * Represents configuration for OpenAI integration
23
- * @alpha
24
- */
25
- openAiConfig?: IOpenAiConfig;
26
- /**
27
- * Represents configuration for Dashboard Filters Apply Mode
28
- * @alpha
29
- */
30
- dashboardFiltersApplyMode?: DashboardFiltersApplyMode;
31
- /**
32
- * Indicates current platform edition.
33
- */
34
- platformEdition?: PlatformEdition;
35
- /**
36
- * Early access features configuration.
37
- * @beta
38
- */
39
- earlyAccessFeatures?: IEarlyAccessFeaturesConfig;
40
- /**
41
- * Week start day
42
- */
43
- weekStart?: WeekStart;
44
- /**
45
- * Fiscal year calendar configuration
46
- */
47
- fiscalYear?: IFiscalYear;
48
- /**
49
- * Active calendars configuration
50
- */
51
- activeCalendars?: IActiveCalendars;
52
- /**
53
- * Locale code to use for metadata.
54
- */
55
- metadataLocale?: string;
56
- /**
57
- * Locale code to use for date formatting.
58
- */
59
- formatLocale?: string;
60
- /**
61
- * Indicates the format in which the dates will be displayed
62
- */
63
- responsiveUiDateFormat?: string;
64
- /**
65
- * IANA identifier of time zone in which the platform metadata are stored.
66
- */
67
- metadataTimeZone?: string;
68
- /**
69
- * Timezone
70
- */
71
- timezone?: string;
72
- /**
73
- * Ai rate limit in requests per minute.
74
- */
75
- aiRateLimit?: number;
76
- /**
77
- * Metric format override configuration.
78
- * @alpha
79
- */
80
- metricFormatOverride?: IMetricFormatOverrideSetting;
81
- /**
82
- * Enables UI and API support for metric type selection and metric format overrides management.
83
- */
84
- enableMetricFormatOverrides?: boolean;
85
- /**
86
- * Resolved currency format override from metricFormatOverride.formats["CURRENCY"].
87
- * This is a convenience property normalized during settings resolution.
88
- * @alpha
89
- */
90
- currencyFormatOverride?: string | null;
91
- /**
92
- * LLM endpoint id as default for the platform.
93
- */
94
- llmEndpoint?: ILlmEndpoint;
95
- /**
96
- * LLM provider id as default for the platform.
97
- */
98
- activeLlmProvider?: ILlmActiveProvider;
99
- /**
100
- * Attachment size limit in bytes (null for no limit).
101
- */
102
- attachmentSizeLimit?: number | null;
103
- /**
104
- * If true, non-TLS endpoints may be used for FlexConnect.
105
- * Otherwise, only TLS-enabled endpoints may be used.
106
- */
107
- allowUnsafeFlexConnectEndpoints?: boolean;
108
- /**
109
- * Enable automation evaluation mode.
110
- */
111
- enableAutomationEvaluationMode?: boolean;
112
- /**
113
- * Maximum zoom level applied to geo visualizations.
15
+ * Registered pluggable applications.
114
16
  *
115
- * @remarks
116
- * Null or undefined means that zoom is unrestricted
117
- * and default chart settings will be applied.
118
- */
119
- maxZoomLevel?: number | null;
120
- /**
121
- * Override the default timeout for polling for the export results.
122
- */
123
- exportResultPollingTimeoutSeconds?: number;
124
- /**
125
- * Enables Highcharts accessibility features.
126
- */
127
- enableHighchartsAccessibility?: boolean;
128
- /**
129
- * Enables accessible chart tooltips with improved readability and persistence for disabled users.
130
- */
131
- enableAccessibleChartTooltip?: boolean;
132
- /**
133
- * Headline component will not be underlined when it is set up with drilling.
134
- */
135
- disableKpiDashboardHeadlineUnderline?: boolean;
136
- /**
137
- * Indicates whether the Waterfall Chart is available in AD.
138
- */
139
- enableWaterfallChart?: boolean;
140
- /**
141
- * Indicates whether unavailable data items are visible in the settings API
142
- * only available on Tiger/Panther
143
- */
144
- showHiddenCatalogItems?: boolean;
145
- /**
146
- * Indicates whether the catalog groups in analytical designer are expanded by default.
147
- */
148
- ADCatalogGroupsExpanded?: boolean;
149
- /**
150
- * Indicates whether the Embed dashboard button is available in KPI dashboards.
151
- */
152
- enableEmbedButtonInKD?: boolean;
153
- /**
154
- * Indicates whether the Embed button/dialog is available in AD.
155
- */
156
- enableEmbedButtonInAD?: boolean;
157
- /**
158
- * Enable usage of insights, widgets, kpis descriptions.
159
- */
160
- enableDescriptions?: boolean;
161
- /**
162
- * Enable use of composite grain
163
- */
164
- enableCompositeGrain?: boolean;
165
- /**
166
- * Enable new max bucket size items limit for Pivot Table
167
- */
168
- enablePivotTableIncreaseBucketSize?: boolean;
169
- /**
170
- * Enable user management page in Home UI.
171
- */
172
- enableUserManagement?: boolean;
173
- /**
174
- * Enable cross filtering in KD
175
- */
176
- enableKDCrossFiltering?: boolean;
177
- /**
178
- * Enable change analysis
179
- */
180
- enableChangeAnalysis?: boolean;
181
- /**
182
- * Enable multiple date filters.
183
- */
184
- enableMultipleDateFilters?: boolean;
185
- /**
186
- * Enable multiple conditions in measure value filters (MVF).
187
- *
188
- * @remarks
189
- * Defaults to true when not provided by the backend.
190
- */
191
- enableMultipleMvfConditions?: boolean;
192
- /**
193
- * Enable ranking filter to be used together with measure value filters (MVF).
194
- *
195
- * @remarks
196
- * Defaults to false when not provided by the backend.
197
- */
198
- enableRankingWithMvf?: boolean;
199
- /**
200
- * Enables rich text widgets on dashboards.
201
- */
202
- enableKDRichText?: boolean;
203
- /**
204
- * Enables visualization switcher widgets on dashboards.
205
- */
206
- enableKDVisualizationSwitcher?: boolean;
207
- /**
208
- * Enable creating users in user management.
209
- */
210
- enableCreateUser?: boolean;
211
- /**
212
- * Enable attribute filter values validation by date filters.
213
- */
214
- enableKDAttributeFilterDatesValidation?: boolean;
215
- /**
216
- * Enable multiple data sources to be used in a single workspace.
217
- */
218
- enableMultipleDataSourcesInWorkspace?: boolean;
219
- /**
220
- * Enables segmentation in scatter plot.
221
- */
222
- enableScatterPlotSegmentation?: boolean;
223
- /**
224
- * Enable clustering in scatter plot.
225
- */
226
- enableScatterPlotClustering?: boolean;
227
- /**
228
- * Enables rich text in descriptions.
229
- */
230
- enableRichTextDescriptions?: boolean;
231
- /**
232
- * Enables scheduling of the dashboard pdf export.
233
- */
234
- enableScheduling?: boolean;
235
- /**
236
- * Enables alerting of the dashboard widgets.
237
- */
238
- enableAlerting?: boolean;
239
- /**
240
- * Enables the replacement of LLM endpoints.
241
- */
242
- enableLlmEndpointReplacement?: boolean;
243
- /**
244
- * Enables attributes in alerts.
245
- */
246
- enableAlertAttributes?: boolean;
247
- /**
248
- * Enables comparison in alerting.
249
- */
250
- enableComparisonInAlerting?: boolean;
251
- /**
252
- * Enables alerting rollout of the dashboard widgets.
253
- */
254
- enableAlertingRollout?: boolean;
255
- /**
256
- * Enables smtp settings.
257
- */
258
- enableSmtp?: boolean;
259
- /**
260
- * Enables storing widget identifiers.
261
- */
262
- enableWidgetIdentifiersRollout?: boolean;
263
- enableDataSection?: boolean;
264
- enableMySqlDataSource?: boolean;
265
- enableMariaDbDataSource?: boolean;
266
- enableOracleDataSource?: boolean;
267
- enableSnowflakeKeyPairAuthentication?: boolean;
268
- enableMotherDuckDataSource?: boolean;
269
- enableMongoDbDataSource?: boolean;
270
- enableStarrocksDataSource?: boolean;
271
- enableSingleStoreDataSource?: boolean;
272
- enableAthenaDataSource?: boolean;
273
- enableCrateDbDataSource?: boolean;
274
- /**
275
- * Enable GenAI-powered functionality, such as semantic-search.
276
- * @deprecated Use separate flags for semantic search and GenAI chat below.
277
- */
278
- enableAIFunctions?: boolean;
279
- /**
280
- * Enable Semantic Search in the UI.
281
- */
282
- enableSemanticSearch?: boolean;
283
- /**
284
- * Enable Semantic Search rollout in the UI.
285
- */
286
- enableSemanticSearchRollout?: boolean;
287
- /**
288
- * Enable Gen AI Chatbot in UI.
289
- */
290
- enableGenAIChat?: boolean;
291
- /**
292
- * Enable Gen AI Chatbot rollout in UI.
293
- */
294
- enableGenAIChatRollout?: boolean;
295
- /**
296
- * Enable GenAI catalog quality checker in Analytics Catalog.
297
- */
298
- enableGenAICatalogQualityChecker?: boolean;
299
- /**
300
- * Enable trending and recommended object tabs in Analytics Catalog.
301
- */
302
- enableCatalogTrendingObjects?: boolean;
303
- /**
304
- * Enable certification indicators in Analytics Catalog.
305
- */
306
- enableCertification?: boolean;
307
- /**
308
- * Allow sending aggregated data to LLM.
309
- */
310
- enableAiOnData?: boolean;
311
- /**
312
- * Enable multiple data sources to be used in a single workspace.
313
- */
314
- enableDashboardFilterViews?: boolean;
315
- /**
316
- * Enable customized dashboards without plugin overlay.
317
- * When enabled, the plugin overlay will not be displayed on dashboard items.
318
- */
319
- enableCustomizedDashboardsWithoutPluginOverlay?: boolean;
320
- /**
321
- * Enables ignore cross-filtering in widgets on dashboard.
322
- */
323
- enableIgnoreCrossFiltering?: boolean;
324
- /**
325
- * Enables manual headline exports on dashboard.
326
- */
327
- enableHeadlineExport?: boolean;
328
- /**
329
- * Enable the use of alias filter titles in cross filtering.
330
- * @internal
331
- */
332
- enableCrossFilteringAliasTitles?: boolean;
333
- /**
334
- * Enable the use of default SMTP in destinations.
335
- */
336
- enableDefaultSmtp?: boolean;
337
- /**
338
- * Enable number separators configuration in home-ui (both organization and workspace level).
339
- */
340
- enableNumberSeparators?: boolean;
341
- /**
342
- * Enable the use of new user creation flow.
343
- */
344
- enableNewUserCreationFlow?: boolean;
345
- /**
346
- * Enable the possibility to test destinations (emails, webhooks) in the UI.
347
- */
348
- enableDestinationTesting?: boolean;
349
- /**
350
- * Enable in-platform notifications.
351
- */
352
- enableInPlatformNotifications?: boolean;
353
- /**
354
- * Enable fine-tuning options for visualization in AD configuration panel.
355
- */
356
- enableVisualizationFineTuning?: boolean;
357
- /**
358
- * Enable improved attribute filters experience in Analytical Designer.
359
- */
360
- enableImprovedAdFilters?: boolean;
361
- /**
362
- * Enable external recipients options
363
- */
364
- enableExternalRecipients?: boolean;
365
- /**
366
- * Enable drilled tooltip in drill dialog
367
- */
368
- enableDrilledTooltip?: boolean;
369
- /**
370
- * Enable dashboard tabular export
371
- */
372
- enableDashboardTabularExport?: boolean;
373
- /**
374
- * Enable orchestrated tabular exports
375
- */
376
- enableOrchestratedTabularExports?: boolean;
377
- /**
378
- * Enable dynamic height of the dashboard section description fields in dashboard edit mode.
379
- */
380
- enableDashboardDescriptionDynamicHeight?: boolean;
381
- /**
382
- * Enables tracking events to Amplitude.
383
- */
384
- enableAmplitudeTracker?: boolean;
385
- /**
386
- * Enable slideshow exports using the new export render mode in KD.
387
- */
388
- enableSlideshowExports?: boolean;
389
- /**
390
- * Enable slideshow exports settings from server
391
- */
392
- enableSlidesExport?: boolean;
393
- /**
394
- * Enable rich text dynamic references.
395
- */
396
- enableRichTextDynamicReferences?: boolean;
397
- /**
398
- * Enable insights export of raw data when limit is reached.
399
- */
400
- enableRawExports?: boolean;
401
- /**
402
- * Enable new PDF tabular export option for insights.
403
- */
404
- enableNewPdfTabularExport?: boolean;
405
- /**
406
- * Enable rich text widget filter configuration.
407
- * Allows users to configure date and attribute filter settings for rich text widgets.
408
- * @alpha
409
- */
410
- enableRichTextWidgetFilterConfiguration?: boolean;
411
- /**
412
- * Enable dashboard-level date dataset configuration for section headers.
413
- * Allows users to select which date dataset to use for filtering metrics in section header rich text.
414
- * @alpha
415
- */
416
- enableDashboardSectionHeadersDateDataSet?: boolean;
417
- /**
418
- * Date filter configuration.
419
- * @alpha
420
- */
421
- dateFilterConfig?: IDateFilterConfig;
422
- /**
423
- * Enable execution cancelling.
424
- */
425
- enableExecutionCancelling?: boolean;
426
- /**
427
- * Enable immediate attribute filter displayAsLabel migration information propagation right upon the load of the component.
428
- */
429
- enableImmediateAttributeFilterDisplayAsLabelMigration?: boolean;
430
- /**
431
- * Enable the URL sharing functionality in the dashboard share dialog.
432
- */
433
- enableDashboardShareLink?: boolean;
434
- /**
435
- * Enable using execution timestamp.
436
- */
437
- enableExecutionTimestamp?: boolean;
438
- /**
439
- * Enable automation filter context.
440
- */
441
- enableAutomationFilterContext?: boolean;
442
- /**
443
- * Enables storing date filter identifiers.
444
- */
445
- enableDateFilterIdentifiersRollout?: boolean;
446
- /**
447
- * Enable to setup alerts evaluation frequency in dashboard settings.
448
- */
449
- enableAlertsEvaluationFrequencySetup?: boolean;
450
- /**
451
- * Enable a configurable trend threshold in line chart visualization.
452
- */
453
- enableLineChartTrendThreshold?: boolean;
454
- /**
455
- * Enable to respect chart legend position in KD.
456
- */
457
- enableKDRespectLegendPosition?: boolean;
458
- /**
459
- * Enables workspace settings link in account menu of the user in every app header.
460
- */
461
- enableWorkspaceSettingsAppHeaderMenuItem?: boolean;
462
- /**
463
- * Enable accessibility enhancements for snapshot export.
464
- */
465
- enableSnapshotExportAccessibility?: boolean;
466
- /**
467
- * Enable widget export to PDF.
468
- */
469
- enableWidgetExportPdf?: boolean;
470
- /**
471
- * Enable widget export to PNG image.
472
- */
473
- enableWidgetExportPngImage?: boolean;
474
- /**
475
- * Enable export to document storage.
476
- */
477
- enableExportToDocumentStorage?: boolean;
478
- /**
479
- * Enable notification channel identifiers
480
- */
481
- enableNotificationChannelIdentifiers?: boolean;
482
- /**
483
- * Enable dashboard share dialog link
484
- */
485
- enableDashboardShareDialogLink?: boolean;
486
- /**
487
- * Enable production features
17
+ * It is a permanent setting option, but it is lifted into this interface to prevent cyclic dependencies
18
+ * as the RemotePluggableApplicationsRegistry references both IPermanentSettings and IFeatureFlags.
488
19
  *
489
20
  * @alpha
490
21
  */
491
- productionFeatures?: IProductionFeaturesConfig;
492
- /**
493
- * Enable new scheduled export
494
- */
495
- enableNewScheduledExport?: boolean;
496
- /**
497
- * Enable custom Identity Provider
498
- */
499
- enableSeamlessIdpSwitch?: boolean;
500
- /**
501
- * Enable pre-aggregation datasets support in LDM Modeler.
502
- */
503
- enablePreAggregationDatasets?: boolean;
504
- /**
505
- * Enable "to date" filters also known as "bounded" filters (e.g. YTD, QTD, MTD, WTD)
506
- */
507
- enableToDateFilters?: boolean;
508
- /**
509
- * Enable new pivot table
510
- */
511
- enableNewPivotTable?: boolean;
512
- /**
513
- * Enable new geo pushpin chart
514
- */
515
- enableNewGeoPushpin?: boolean;
516
- /**
517
- * Enable geo area labels.
518
- */
519
- enableGeoArea?: boolean;
520
- /**
521
- * Enables geo accessibility enhancements introduced for map canvas, legend semantics,
522
- * live announcements, and alternate table view.
523
- */
524
- enableGeoChartA11yImprovements?: boolean;
525
- /**
526
- * Enables viewport configuration for geo charts (custom viewport + pan/zoom navigation controls).
527
- */
528
- enableGeoChartsViewportConfig?: boolean;
529
- /**
530
- * Enables analytical designer recommendation for geo charts when locations contain conflicting segment values.
531
- */
532
- enableGeoSegmentConflictRecommendation?: boolean;
533
- /**
534
- * Enable basemap selection in geo chart configuration.
535
- */
536
- enableGeoBasemapConfig?: boolean;
537
- /**
538
- * Enable Geo collections management UI.
539
- */
540
- enableCustomGeoCollection?: boolean;
541
- /**
542
- * Enable satellite/hybrid basemap option in geo chart configuration.
543
- */
544
- enableGeoSatelliteBasemapOption?: boolean;
545
- /**
546
- * Enable automation management in dashboards
547
- */
548
- enableAutomationManagement?: boolean;
549
- /**
550
- * Enable filter accessibility features including redesigned date filter components.
551
- */
552
- enableFilterAccessibility?: boolean;
553
- /**
554
- * Enable GenAI memory feature
555
- */
556
- enableGenAIMemory?: boolean;
557
- /**
558
- * Enable AI Knowledge feature
559
- */
560
- enableAIKnowledge?: boolean;
561
- /**
562
- * Enable GenAI reasoning visibility.
563
- */
564
- enableGenAIReasoningVisibility?: boolean;
565
- /**
566
- * AI Chat search limit
567
- */
568
- aiChatSearchLimit?: number;
569
- /**
570
- * Enable snapshot export
571
- */
572
- enableSnapshotExport?: boolean;
573
- /**
574
- * Enable accessibility mode
575
- */
576
- enableAccessibilityMode?: boolean;
577
- /**
578
- * Registered pluggable applications
579
- */
580
- registeredPluggableApplications?: string;
581
- /**
582
- * This setting enables drills into URL in pivot table charts by default on all available attributes.
583
- * Renders table cells as hyperlinks.
584
- */
585
- enableDrillToUrlByDefault?: boolean;
586
- /**
587
- * This feature flag enables automatic drill to url setting feature.
588
- */
589
- enableImplicitDrillToUrl?: boolean;
590
- /**
591
- * Enable anomaly detection alert
592
- */
593
- enableAnomalyDetectionAlert?: boolean;
594
- /**
595
- * Enable anomaly detection in visualization
596
- */
597
- enableAnomalyDetectionVisualization?: boolean;
598
- /**
599
- * Enable alert once per interval
600
- */
601
- enableAlertOncePerInterval?: boolean;
602
- /**
603
- * Enable fiscal calendars configuration.
604
- */
605
- enableFiscalCalendars?: boolean;
606
- /**
607
- * Enable pagination for the pivot table.
608
- */
609
- enablePivotTablePagination?: boolean;
610
- /**
611
- * Enable dashboard filter groups.
612
- *
613
- * Filter group are items in a filter bar which groups regular attribute filters into a logical groups.
614
- * Groups are configured via dashboard metadata new tab property called filterGroupsConfig.
615
- */
616
- enableDashboardFilterGroups?: boolean;
617
- /**
618
- * Enable match filter in Analytical Designer.
619
- */
620
- enableMatchFilterAD?: boolean;
621
- /**
622
- * Enable arbitrary filter in Analytical Designer.
623
- */
624
- enableArbitraryFilterAD?: boolean;
625
- /**
626
- * Enable match filter in Dashboard app.
627
- */
628
- enableMatchFilterKD?: boolean;
629
- /**
630
- * Enable arbitrary filter in Dashboard app.
631
- */
632
- enableArbitraryFilterKD?: boolean;
633
- /**
634
- * Enable filtering of visualizations by tags provided via URL.
635
- */
636
- enableVisualizationFilteringByTags?: boolean;
637
- /**
638
- * Restrict access to Base UI applications.
639
- */
640
- restrictBaseUi?: boolean;
641
- /**
642
- * Enables "Empty date values" configuration in KPI Dashboards date filter.
643
- */
644
- enableKDEmptyDateValuesFilter?: boolean;
645
- /**
646
- * Enable filter control in drilling configuration.
647
- */
648
- enableFilterControlInDrillingConfiguration?: boolean;
649
- /**
650
- * Enable shell application.
651
- */
652
- enableShellApplication?: boolean;
653
- /**
654
- * Enable NULL-aware joins used for FULL OUTER JOIN conditions.
655
- */
656
- enableNullJoins?: boolean;
657
- /**
658
- * Enable dashboard density setting.
659
- *
660
- * When enabled, users can switch between "comfortable" and "compact" information density
661
- * in dashboard view mode.
662
- */
663
- enableDashboardDensitySetting?: boolean;
22
+ registeredPluggableApplications?: RemotePluggableApplicationsRegistry;
664
23
  [key: string]: number | boolean | string | object | undefined | null;
665
24
  }
666
- /**
667
- * Describes metric format override configuration.
668
- *
669
- * @alpha
670
- */
671
- export interface IMetricFormatOverrideSetting {
672
- /**
673
- * Mapping of metric type to custom format string.
674
- * When undefined or null, backend defaults are used.
675
- */
676
- formats?: Record<string, string> | null;
677
- }
678
- /**
679
- * Indicates current platform edition.
680
- *
681
- * @public
682
- */
683
- export type PlatformEdition = "free" | "growth" | "enterprise";
684
- /**
685
- * Settings for regional number formatting
686
- *
687
- * @public
688
- */
689
- export interface ISeparators {
690
- /**
691
- * Thousand separator (e.g. " " or ",")
692
- */
693
- thousand: string;
694
- /**
695
- * Decimal separator (e.g. "," or ".")
696
- */
697
- decimal: string;
698
- }
699
- /**
700
- * Determines whether the given object is an instance of {@link ISeparators}.
701
- * @param obj - object to check
702
- *
703
- * @public
704
- */
705
- export declare function isSeparators(obj: unknown): obj is ISeparators;
706
- /**
707
- * @public
708
- */
709
- export interface ILlmEndpoint {
710
- /**
711
- * Unique identifier of the LLM endpoint.
712
- */
713
- id: string;
714
- /**
715
- * Type of the LLM endpoint.
716
- */
717
- type: "llmEndpoint";
718
- }
719
- /**
720
- * @public
721
- */
722
- export interface ILlmActiveProvider {
723
- /**
724
- * Unique identifier of the LLM endpoint.
725
- */
726
- id: string;
727
- /**
728
- * Type of the LLM endpoint.
729
- */
730
- type: "llmProvider";
731
- /**
732
- * Name of the LLM provider.
733
- */
734
- defaultModelId: string;
735
- }
736
- /**
737
- * Configuration of WhiteLabeling.
738
- *
739
- * @public
740
- */
741
- export interface IWhiteLabeling {
742
- /**
743
- * (De)/Activate whiteLabeling
744
- */
745
- enabled: boolean;
746
- /**
747
- * Whitelabeling favicon url
748
- */
749
- faviconUrl?: string;
750
- /**
751
- * Company logo url
752
- */
753
- logoUrl?: string;
754
- /**
755
- * Whitelabeling of Apple touch icon url
756
- */
757
- appleTouchIconUrl?: string;
758
- }
759
- /**
760
- * Alert Default
761
- *
762
- * @public
763
- */
764
- export interface IAlertDefault {
765
- /**
766
- * Default evaluation frequency
767
- */
768
- defaultCron: string;
769
- /**
770
- * Default timezone
771
- */
772
- defaultTimezone: string;
773
- }
774
- /**
775
- * Configuration of integration of OpenAI.
776
- *
777
- * @alpha
778
- */
779
- export interface IOpenAiConfig {
780
- /**
781
- * OpenAI organization ID
782
- */
783
- org: string;
784
- /**
785
- * OpenAI API token
786
- */
787
- token: string;
788
- }
789
- /**
790
- * Values of Dashboard Filters Apply Mode setting. Used for organization and workspace.
791
- * INDIVIDUAL mean that each filter has its own apply button.
792
- * ALL_AT_ONCE mean that there is a single apply button for all dashboard filters.
793
- *
794
- * @public
795
- */
796
- export type DashboardFiltersApplyMode = {
797
- mode: "INDIVIDUAL";
798
- } | {
799
- mode: "ALL_AT_ONCE";
800
- };
801
- /**
802
- * Week start day
803
- *
804
- * @public
805
- */
806
- export type WeekStart = "Sunday" | "Monday";
807
- /**
808
- * Fiscal year calendar configuration
809
- *
810
- * @public
811
- */
812
- export interface IFiscalYear {
813
- /**
814
- * Month offset from January (0 = January, 1 = February, ..., -1 = December of previous year, etc.)
815
- */
816
- monthOffset: number;
817
- /**
818
- * Prefix for fiscal year labels (e.g. "FY")
819
- */
820
- yearPrefix?: string;
821
- /**
822
- * Prefix for fiscal quarter labels (e.g. "Q")
823
- */
824
- quarterPrefix?: string;
825
- /**
826
- * Prefix for fiscal month/period labels (e.g. "P")
827
- */
828
- monthPrefix?: string;
829
- }
830
- /**
831
- * Calendar type
832
- *
833
- * @public
834
- */
835
- export type CalendarType = "STANDARD" | "FISCAL";
836
- /**
837
- * Active calendars configuration
838
- *
839
- * @public
840
- */
841
- export interface IActiveCalendars {
842
- /**
843
- * Which calendar type is the default
844
- */
845
- default: CalendarType;
846
- /**
847
- * Whether standard calendar is enabled
848
- */
849
- standard: boolean;
850
- /**
851
- * Whether fiscal calendar is enabled
852
- */
853
- fiscal: boolean;
854
- }
855
- /**
856
- * @beta
857
- */
858
- export type EarlyAccessFeatureContext = "WORKSPACE" | "ORGANIZATION";
859
- /**
860
- * @beta
861
- */
862
- export type EarlyAccessFeatureStatus = "EXPERIMENTAL" | "BETA";
863
- /**
864
- * @beta
865
- */
866
- export interface IEarlyAccessFeatureConfig {
867
- title: string;
868
- description: string;
869
- docs?: string;
870
- earlyAccess: string;
871
- context: EarlyAccessFeatureContext;
872
- status: EarlyAccessFeatureStatus;
873
- }
874
- /**
875
- * @beta
876
- */
877
- export interface IEarlyAccessFeaturesConfig {
878
- features: IEarlyAccessFeatureConfig[];
879
- }
880
- /**
881
- * @alpha
882
- */
883
- export interface IProductionFeatureConfig {
884
- title: string;
885
- description: string;
886
- docs?: string;
887
- earlyAccess: string;
888
- /**
889
- * Expect global rollout date in ISO-8601 calendar date format (YYYY-MM-DD)
890
- */
891
- globalRollout: string;
892
- }
893
- /**
894
- * @alpha
895
- */
896
- export interface IProductionFeaturesConfig {
897
- features?: IProductionFeatureConfig[];
898
- }
899
25
  //# sourceMappingURL=index.d.ts.map