@gooddata/sdk-model 11.62.0-alpha.0 → 11.62.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.
Files changed (58) hide show
  1. package/esm/genAI/chat.d.ts +9 -9
  2. package/esm/genAI/chat.d.ts.map +1 -1
  3. package/esm/index.d.ts +12 -12
  4. package/esm/index.d.ts.map +1 -1
  5. package/esm/index.js +10 -10
  6. package/esm/publisher/builtinPageLayouts.d.ts +45 -0
  7. package/esm/publisher/builtinPageLayouts.d.ts.map +1 -0
  8. package/esm/{reports → publisher}/builtinPageLayouts.js +19 -19
  9. package/esm/{reports → publisher}/content.d.ts +20 -20
  10. package/esm/publisher/content.d.ts.map +1 -0
  11. package/esm/{reports → publisher}/content.js +2 -2
  12. package/esm/{reports/report.d.ts → publisher/document.d.ts} +28 -28
  13. package/esm/publisher/document.d.ts.map +1 -0
  14. package/esm/{reports/report.js → publisher/document.js} +10 -10
  15. package/esm/publisher/factory.d.ts +65 -0
  16. package/esm/publisher/factory.d.ts.map +1 -0
  17. package/esm/{reports → publisher}/factory.js +22 -22
  18. package/esm/{reports → publisher}/layout.d.ts +15 -15
  19. package/esm/publisher/layout.d.ts.map +1 -0
  20. package/esm/{reports → publisher}/layout.js +4 -4
  21. package/esm/publisher/pageFormat.d.ts +38 -0
  22. package/esm/publisher/pageFormat.d.ts.map +1 -0
  23. package/esm/publisher/pageFormat.js +33 -0
  24. package/esm/{reports → publisher}/pageLayout.d.ts +28 -28
  25. package/esm/publisher/pageLayout.d.ts.map +1 -0
  26. package/esm/{reports → publisher}/pageLayout.js +18 -18
  27. package/esm/{reports → publisher}/slot.d.ts +48 -48
  28. package/esm/publisher/slot.d.ts.map +1 -0
  29. package/esm/publisher/slot.js +87 -0
  30. package/esm/{reports → publisher}/styling.d.ts +39 -39
  31. package/esm/publisher/styling.d.ts.map +1 -0
  32. package/esm/publisher/styling.js +58 -0
  33. package/esm/publisher/variables.d.ts +72 -0
  34. package/esm/publisher/variables.d.ts.map +1 -0
  35. package/esm/{reports → publisher}/variables.js +7 -7
  36. package/esm/sdk-model.d.ts +889 -858
  37. package/esm/settings/settings.d.ts +13 -0
  38. package/esm/settings/settings.d.ts.map +1 -1
  39. package/esm/theme/index.d.ts +68 -51
  40. package/esm/theme/index.d.ts.map +1 -1
  41. package/package.json +3 -3
  42. package/esm/reports/builtinPageLayouts.d.ts +0 -45
  43. package/esm/reports/builtinPageLayouts.d.ts.map +0 -1
  44. package/esm/reports/content.d.ts.map +0 -1
  45. package/esm/reports/factory.d.ts +0 -65
  46. package/esm/reports/factory.d.ts.map +0 -1
  47. package/esm/reports/layout.d.ts.map +0 -1
  48. package/esm/reports/pageFormat.d.ts +0 -38
  49. package/esm/reports/pageFormat.d.ts.map +0 -1
  50. package/esm/reports/pageFormat.js +0 -33
  51. package/esm/reports/pageLayout.d.ts.map +0 -1
  52. package/esm/reports/report.d.ts.map +0 -1
  53. package/esm/reports/slot.d.ts.map +0 -1
  54. package/esm/reports/slot.js +0 -87
  55. package/esm/reports/styling.d.ts.map +0 -1
  56. package/esm/reports/styling.js +0 -58
  57. package/esm/reports/variables.d.ts +0 -72
  58. package/esm/reports/variables.d.ts.map +0 -1
@@ -971,61 +971,61 @@ export declare function bucketsTotals(buckets: IBucket[]): ITotal[];
971
971
  export declare function bucketTotals(bucket: IBucket): ITotal[];
972
972
 
973
973
  /**
974
- * Built-in cover page: report title and subtitle.
974
+ * Built-in cover page: document title and subtitle.
975
975
  *
976
976
  * @alpha
977
977
  */
978
- export declare const BuiltInReportPageLayoutCover: IReportPageLayout;
978
+ export declare const BuiltInPublisherPageLayoutCover: IPublisherPageLayout;
979
979
 
980
980
  /**
981
- * Built-in portrait cover page: report title and subtitle.
981
+ * Built-in portrait cover page: document title and subtitle.
982
982
  *
983
983
  * @alpha
984
984
  */
985
- export declare const BuiltInReportPageLayoutPortraitCover: IReportPageLayout;
985
+ export declare const BuiltInPublisherPageLayoutPortraitCover: IPublisherPageLayout;
986
986
 
987
987
  /**
988
988
  * Built-in portrait section divider page.
989
989
  *
990
990
  * @alpha
991
991
  */
992
- export declare const BuiltInReportPageLayoutPortraitSection: IReportPageLayout;
992
+ export declare const BuiltInPublisherPageLayoutPortraitSection: IPublisherPageLayout;
993
993
 
994
994
  /**
995
995
  * Built-in portrait page carrying a full-page narrative, with no visualization.
996
996
  *
997
997
  * @alpha
998
998
  */
999
- export declare const BuiltInReportPageLayoutPortraitSummary: IReportPageLayout;
999
+ export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLayout;
1000
1000
 
1001
1001
  /**
1002
- * All built-in report pages served by the SPI. Built-ins are read-only: they cannot be
1002
+ * All built-in page layouts served by the SPI. Built-ins are read-only: they cannot be
1003
1003
  * edited or deleted, and they are never persisted on the backend.
1004
1004
  *
1005
1005
  * @alpha
1006
1006
  */
1007
- export declare const BuiltInReportPageLayouts: readonly IReportPageLayout[];
1007
+ export declare const BuiltInPublisherPageLayouts: readonly IPublisherPageLayout[];
1008
1008
 
1009
1009
  /**
1010
1010
  * Built-in section divider page.
1011
1011
  *
1012
1012
  * @alpha
1013
1013
  */
1014
- export declare const BuiltInReportPageLayoutSection: IReportPageLayout;
1014
+ export declare const BuiltInPublisherPageLayoutSection: IPublisherPageLayout;
1015
1015
 
1016
1016
  /**
1017
1017
  * Built-in content page with six visualizations and a text column on the left.
1018
1018
  *
1019
1019
  * @alpha
1020
1020
  */
1021
- export declare const BuiltInReportPageLayoutViz6TextLeft: IReportPageLayout;
1021
+ export declare const BuiltInPublisherPageLayoutViz6TextLeft: IPublisherPageLayout;
1022
1022
 
1023
1023
  /**
1024
- * List of built-in report slot type names.
1024
+ * List of built-in document slot type names.
1025
1025
  *
1026
1026
  * @alpha
1027
1027
  */
1028
- export declare const BuiltInReportSlotTypes: string[];
1028
+ export declare const BuiltInPublisherSlotTypes: string[];
1029
1029
 
1030
1030
  /**
1031
1031
  * List of built-in widget types. These type names are reserved and must not be used by custom widgets.
@@ -1887,7 +1887,7 @@ export declare const DefaultLocale: ILocale;
1887
1887
  *
1888
1888
  * @alpha
1889
1889
  */
1890
- export declare const DefaultReportHeadingType: ReportHeadingType;
1890
+ export declare const DefaultPublisherHeadingType: PublisherHeadingType;
1891
1891
 
1892
1892
  /**
1893
1893
  * Format assumed by a page that declares none, which keeps pages authored before formats existed
@@ -1895,14 +1895,14 @@ export declare const DefaultReportHeadingType: ReportHeadingType;
1895
1895
  *
1896
1896
  * @alpha
1897
1897
  */
1898
- export declare const DefaultReportPageFormat: ReportPageFormat;
1898
+ export declare const DefaultPublisherPageFormat: PublisherPageFormat;
1899
1899
 
1900
1900
  /**
1901
1901
  * Size a paragraph slot that states none is rendered at.
1902
1902
  *
1903
1903
  * @alpha
1904
1904
  */
1905
- export declare const DefaultReportParagraphType: ReportParagraphType;
1905
+ export declare const DefaultPublisherParagraphType: PublisherParagraphType;
1906
1906
 
1907
1907
  /**
1908
1908
  * Calculates fingerprint for the execution definition.
@@ -2925,7 +2925,7 @@ export declare function getPluggableApplicationLocalizedTitle(app: PluggableAppl
2925
2925
  *
2926
2926
  * @alpha
2927
2927
  */
2928
- export declare function getReportTextPlaceholders(text: string): string[];
2928
+ export declare function getPublisherTextPlaceholders(text: string): string[];
2929
2929
 
2930
2930
  /**
2931
2931
  * Returns count of selected elements
@@ -7846,6 +7846,7 @@ export declare interface IFeatureFlags {
7846
7846
  enableStarrocksDataSource?: boolean;
7847
7847
  enableSingleStoreDataSource?: boolean;
7848
7848
  enableDenodoDataSource?: boolean;
7849
+ enableTrinoDataSource?: boolean;
7849
7850
  /**
7850
7851
  * Enables the data source cache retention policy: the UI for viewing and setting how long
7851
7852
  * a data source's cached results are kept becomes available on the data source detail screen.
@@ -8326,6 +8327,14 @@ export declare interface IFeatureFlags {
8326
8327
  * Disabled by default.
8327
8328
  */
8328
8329
  enableEmbeddingWriteCommands?: boolean;
8330
+ /**
8331
+ * Enable the localization overview in organization settings: settings split into subpages under an
8332
+ * expandable Settings group in the navigation, and the per-language usage overview.
8333
+ *
8334
+ * @remarks
8335
+ * Disabled by default.
8336
+ */
8337
+ enableLocalizationOverview?: boolean;
8329
8338
  }
8330
8339
 
8331
8340
  /**
@@ -8777,22 +8786,22 @@ export declare interface IGenAIObjectReferenceGroup {
8777
8786
  }
8778
8787
 
8779
8788
  /**
8780
- * Report context for GenAI.
8789
+ * Publisher document context for GenAI.
8781
8790
  * @internal
8782
8791
  */
8783
- export declare interface IGenAIReportContext {
8792
+ export declare interface IGenAIPublisherDocumentContext {
8784
8793
  /**
8785
- * Report object reference. Absent while the report is not saved yet.
8794
+ * Document object reference. Absent while the document is not saved yet.
8786
8795
  */
8787
8796
  ref?: ObjRef;
8788
8797
  /**
8789
- * Report title.
8798
+ * Document title.
8790
8799
  */
8791
8800
  title?: string;
8792
8801
  /**
8793
- * Report definition as the user sees it, including edits that are not saved yet.
8802
+ * Document definition as the user sees it, including edits that are not saved yet.
8794
8803
  */
8795
- definition?: IReportDefinition;
8804
+ definition?: IPublisherDocumentDefinition;
8796
8805
  /**
8797
8806
  * Name of the conversation draft the editor shows, while that draft is not saved yet.
8798
8807
  */
@@ -8840,9 +8849,9 @@ export declare interface IGenAIUIContext {
8840
8849
  */
8841
8850
  dashboard?: IGenAIDashboardContext;
8842
8851
  /**
8843
- * Report the user is currently viewing or editing.
8852
+ * Document the user is currently viewing or editing.
8844
8853
  */
8845
- report?: IGenAIReportContext;
8854
+ publisherDocument?: IGenAIPublisherDocumentContext;
8846
8855
  }
8847
8856
 
8848
8857
  /**
@@ -11825,6 +11834,10 @@ export declare interface IPermanentSettings {
11825
11834
  * Locale code to use for metadata.
11826
11835
  */
11827
11836
  metadataLocale?: string;
11837
+ /**
11838
+ * Locale code to use for data values.
11839
+ */
11840
+ dataLocale?: string;
11828
11841
  /**
11829
11842
  * Locale code to use for date formatting.
11830
11843
  */
@@ -12170,479 +12183,221 @@ export declare interface IProductionFeaturesConfig {
12170
12183
  }
12171
12184
 
12172
12185
  /**
12173
- * @public
12174
- */
12175
- export declare interface IRangeCondition {
12176
- range: IRangeConditionBody;
12177
- }
12178
-
12179
- /**
12180
- * Object defining the {@link IRangeCondition} object body.
12181
- *
12182
- * @public
12183
- */
12184
- export declare interface IRangeConditionBody {
12185
- operator: RangeConditionOperator;
12186
- from: number;
12187
- to: number;
12188
- treatNullValuesAs?: number;
12189
- }
12190
-
12191
- /**
12192
- * @public
12193
- */
12194
- export declare interface IRankingFilter {
12195
- rankingFilter: IRankingFilterBody;
12196
- }
12197
-
12198
- /**
12199
- * Object defining the {@link IRankingFilter} object body.
12186
+ * Text generated by AI at document-build time.
12200
12187
  *
12201
- * @public
12188
+ * @alpha
12202
12189
  */
12203
- export declare interface IRankingFilterBody extends IIdentifiableFilter {
12204
- measure: ObjRefInScope;
12205
- attributes?: ObjRefInScope[];
12206
- operator: RankingFilterOperator;
12207
- value: number;
12208
- applyOnResult?: boolean;
12190
+ export declare interface IPublisherAiTextSource {
12191
+ type: "ai";
12209
12192
  /**
12210
- * When set to true, the filter returns exactly {@link IRankingFilterBody.value} items and excludes
12211
- * additional items that share the boundary value (ties). When false or omitted, the backend default
12212
- * tie-handling behavior is used.
12193
+ * Instruction for the generator. Supports `{variables}`.
12213
12194
  */
12214
- strictLimitOfRows?: boolean;
12195
+ prompt: string;
12196
+ /**
12197
+ * Materialized generation result (markdown), stored so the document renders
12198
+ * deterministically without re-invoking AI. Absent until first generation.
12199
+ */
12200
+ content?: string;
12201
+ /**
12202
+ * ISO 8601 timestamp of the stored generation.
12203
+ */
12204
+ generatedAt?: string;
12215
12205
  }
12216
12206
 
12217
12207
  /**
12218
- * Object defining the {@link IRelativeDateFilter} object body.
12208
+ * Configuration of a document's content-level attribute filter: the part of a dashboard attribute
12209
+ * filter's configuration that documents support.
12219
12210
  *
12220
- * @public
12211
+ * @alpha
12221
12212
  */
12222
- export declare interface IRelativeBoundedDateFilterBody extends IRelativeDateFilterBody {
12223
- boundedFilter: IUpperBoundedFilter | ILowerBoundedFilter;
12224
- }
12213
+ export declare type IPublisherAttributeFilterConfig = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
12225
12214
 
12226
12215
  /**
12227
- * Filters results to a relative date range.
12228
- *
12229
- * @remarks
12230
- * The relative filtering is always done on some granularity - this specifies
12231
- * the units in the 'from' and 'to' fields.
12216
+ * Paint of the box itself. Never affects the geometry of the box or its children —
12217
+ * geometry always comes from layout weights.
12232
12218
  *
12233
- * See {@link DateAttributeGranularity}, {@link AllTimeGranularity} and {@link DateGranularity} for further detail.
12234
- * @public
12219
+ * @alpha
12235
12220
  */
12236
- export declare type IRelativeDateFilter = {
12237
- relativeDateFilter: IRelativeDateFilterBody;
12238
- } | {
12239
- relativeDateFilter: IRelativeDateFilterAllTimeBody;
12240
- } | {
12241
- relativeDateFilter: IRelativeBoundedDateFilterBody;
12242
- };
12221
+ export declare interface IPublisherBoxStyle {
12222
+ background?: PublisherBackground;
12223
+ /**
12224
+ * Corner radius in percent of the page width — the same relative unit the rest of a document page
12225
+ * is sized in, so the corners keep their proportion however large the page is rendered.
12226
+ * Content reaching into a rounded corner is clipped.
12227
+ */
12228
+ borderRadius?: number;
12229
+ /**
12230
+ * Inset of the box's own content, in percent of the page width like
12231
+ * {@link IPublisherBoxStyle.borderRadius}. Insets only inward — siblings and the layout
12232
+ * gaps around the box are untouched. A box that paints a background usually wants one;
12233
+ * a full-bleed box (an image-backed cover) wants none, which is why no default exists.
12234
+ */
12235
+ padding?: number;
12236
+ }
12243
12237
 
12244
12238
  /**
12245
- * Object defining the {@link IRelativeDateFilter} object body.
12239
+ * Solid color painted behind a section's or page's content.
12246
12240
  *
12247
- * @public
12241
+ * @alpha
12248
12242
  */
12249
- export declare interface IRelativeDateFilterAllTimeBody extends IIdentifiableFilter {
12250
- dataSet: ObjRef;
12251
- granularity: AllTimeGranularity;
12252
- from: 0;
12253
- to: 0;
12243
+ export declare interface IPublisherColorBackground {
12244
+ type: "color";
12254
12245
  /**
12255
- * How to treat empty date values.
12246
+ * CSS color value. Absolute: document styling states brand colors directly and does not
12247
+ * follow the workspace theme.
12256
12248
  */
12257
- emptyValueHandling?: EmptyValues;
12249
+ color: string;
12258
12250
  }
12259
12251
 
12260
12252
  /**
12261
- * Object defining the {@link IRelativeDateFilter} object body.
12253
+ * Document metadata object.
12262
12254
  *
12263
- * @public
12255
+ * @alpha
12264
12256
  */
12265
- export declare interface IRelativeDateFilterBody extends IIdentifiableFilter {
12266
- dataSet: ObjRef;
12267
- granularity: DateAttributeGranularity;
12268
- from: number;
12269
- to: number;
12257
+ export declare interface IPublisherDocument extends IPublisherDocumentDefinition, IAuditableDates, IAuditableUsers {
12258
+ ref: ObjRef;
12270
12259
  /**
12271
- * How to treat empty date values.
12260
+ * When true, the object comes from a parent workspace and is not editable
12261
+ * in the current workspace.
12272
12262
  */
12273
- emptyValueHandling?: EmptyValues;
12263
+ isLocked?: boolean;
12274
12264
  }
12275
12265
 
12276
12266
  /**
12277
- * Customized options for the global relative date filter
12267
+ * Fields shared by document definitions and persisted documents.
12268
+ *
12278
12269
  * @alpha
12279
12270
  */
12280
- export declare interface IRelativeDateFilterForm extends IDateFilterOption {
12271
+ export declare interface IPublisherDocumentBase {
12272
+ title: string;
12273
+ description?: string;
12274
+ tags?: string[];
12281
12275
  /**
12282
- * Type to identify the global relative date filter
12276
+ * Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
12277
+ *
12278
+ * @remarks
12279
+ * At execution time the period materializes as an absolute date filter on each
12280
+ * visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
12281
+ * ignoreReportPeriod). Also available as `{periodStart}` in text.
12283
12282
  */
12284
- type: DateFilterOptionRelativeFormType;
12283
+ periodStart: PublisherDateString;
12285
12284
  /**
12286
- * Available granularities for the global relative date filter
12285
+ * Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
12287
12286
  */
12288
- availableGranularities: DateFilterGranularity[];
12287
+ periodEnd: PublisherDateString;
12289
12288
  /**
12290
- * Optional configuration for how this option should treat empty date values.
12289
+ * Content of the document. When created from a template the content is deep-copied
12290
+ * and NO reference to the template is kept — the document stays frozen while pages
12291
+ * and templates evolve.
12291
12292
  */
12292
- emptyValueHandling?: EmptyValues;
12293
+ content: IPublisherDocumentContent;
12294
+ /**
12295
+ * Values for variables declared in content.variables, keyed by variable name.
12296
+ */
12297
+ variableValues?: Record<string, string>;
12293
12298
  }
12294
12299
 
12295
12300
  /**
12296
- * Custom relative date filter preset
12301
+ * Versioned content shared verbatim by document templates and documents.
12302
+ *
12297
12303
  * @alpha
12298
12304
  */
12299
- export declare interface IRelativeDateFilterPreset extends IDateFilterOption {
12305
+ export declare interface IPublisherDocumentContent {
12300
12306
  /**
12301
- * Type to identify a relative date filter preset
12307
+ * Content model version, for stored-content evolution.
12302
12308
  */
12303
- type: DateFilterOptionRelativePresetType;
12309
+ version: "1";
12304
12310
  /**
12305
- * Relative date filter granularity (day/week/year,etc.)
12311
+ * Ordered pages of the document.
12306
12312
  */
12307
- granularity: DateFilterGranularity;
12313
+ pages: IPublisherDocumentPage[];
12308
12314
  /**
12309
- * Relative date filter granularity start offset
12315
+ * Content-level default filters; pages and slots may extend or override them.
12316
+ * The document period is NOT stored here — it is derived from periodStart/periodEnd
12317
+ * at execution time.
12310
12318
  */
12311
- from: RelativeDateFilterGranularityOffset;
12319
+ filters?: FilterContextItem[];
12312
12320
  /**
12313
- * Relative date filter granularity end offset
12321
+ * Configuration of the content-level attribute filters, keyed by the filter's local identifier.
12322
+ *
12323
+ * @remarks
12324
+ * A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
12325
+ * is read as primary-label values and shown by `displayAsLabel`.
12314
12326
  */
12315
- to: RelativeDateFilterGranularityOffset;
12327
+ attributeFilterConfigs?: IPublisherAttributeFilterConfig[];
12316
12328
  /**
12317
- * Additional bound for the relative date filter
12329
+ * Custom variable declarations. Values live on the document
12330
+ * ({@link IPublisherDocumentBase.variableValues}).
12318
12331
  */
12319
- boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
12332
+ variables?: IPublisherVariableDefinition[];
12320
12333
  /**
12321
- * Optional configuration for how this preset should treat empty date values.
12334
+ * Instructions every AI-written text without instructions of its own is generated with.
12335
+ * Supports `{variables}`.
12322
12336
  */
12323
- emptyValueHandling?: EmptyValues;
12337
+ takeawaysInstruction?: string;
12324
12338
  }
12325
12339
 
12326
12340
  /**
12327
- * Generic type to express relative date filter preset of a particular granularity
12341
+ * Payload for creating or updating a document.
12342
+ *
12328
12343
  * @alpha
12329
12344
  */
12330
- export declare interface IRelativeDateFilterPresetOfGranularity<Key extends DateFilterGranularity> extends IRelativeDateFilterPreset {
12345
+ export declare interface IPublisherDocumentDefinition extends IPublisherDocumentBase {
12346
+ type: "report";
12331
12347
  /**
12332
- * Particular relative date filter preset granularity
12348
+ * Present when updating an existing document.
12333
12349
  */
12334
- granularity: Key;
12350
+ ref?: ObjRef;
12335
12351
  }
12336
12352
 
12337
12353
  /**
12338
- * Represents values of a relative filter.
12354
+ * Page instance embedded in template/document content: a deep clone of a page body
12355
+ * plus its own identity.
12339
12356
  *
12340
- * @public
12341
- */
12342
- export declare interface IRelativeDateFilterValues {
12343
- from: number;
12344
- to: number;
12345
- granularity: string;
12346
- dataSet?: ObjRef;
12347
- boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
12348
- emptyValueHandling?: EmptyValues;
12349
- }
12350
-
12351
- /**
12352
- * Definition of the remote pluggable application.
12353
- * The application is loaded via Module Federation.
12357
+ * @remarks
12358
+ * Cloning a {@link IPublisherPageLayout} into content assigns the localIdentifier and regenerates
12359
+ * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
12360
+ * Deliberately carries NO reference back to the source page — later page edits never
12361
+ * affect existing templates or documents.
12354
12362
  *
12355
12363
  * @alpha
12356
12364
  */
12357
- export declare interface IRemotePluggableApplicationModule {
12358
- /**
12359
- * Full URL of the remote federated module with the application bundle.
12360
- *
12361
- * @example
12362
- * https://my-remote-federated-module.com/remoteEntry.js
12363
- */
12364
- url: string;
12365
- /**
12366
- * Unique module federation scope value (must match the remote module definition during build)
12367
- * Must be unique within the same remote federation to not share dependencies and scope with another
12368
- * application.
12369
- *
12370
- * @example
12371
- * "my-remote-federated-module"
12372
- */
12373
- scope: string;
12374
- /**
12375
- * Exposed module name. Must match the remote module definition.
12376
- * Maps to internal application module (e.g. "./src/remote-entry.tsx")
12377
- *
12378
- * @example
12379
- * "./AppModule"
12380
- */
12381
- module: string;
12365
+ export declare interface IPublisherDocumentPage extends IPublisherPageBody {
12382
12366
  /**
12383
- * Base route of the application.
12384
- * It is relative to the shell application route.
12385
- *
12386
- * @example
12387
- * "/my-application"
12388
- *
12389
- * When the application is registered to "organization" scope, the application will be hosted at
12390
- * /organization/my-application.
12391
- * When the application is registered to the "workspace" scope, the application will be hosted at
12392
- * /workspace/\{workspaceId\}/my-application.
12367
+ * Identifier unique within the content; stable across template-to-document copy and reordering.
12393
12368
  */
12394
- routeBase: string;
12369
+ localIdentifier: string;
12395
12370
  }
12396
12371
 
12397
12372
  /**
12398
- * Remote pluggable application registry item, v1.
12399
- * Loaded via Module Federation.
12373
+ * Document template metadata object.
12400
12374
  *
12401
12375
  * @alpha
12402
12376
  */
12403
- export declare interface IRemotePluggableApplicationRegistryItemV1 extends IPluggableApplicationMetaV1 {
12377
+ export declare interface IPublisherDocumentTemplate extends IPublisherDocumentTemplateDefinition, IAuditableDates, IAuditableUsers {
12378
+ ref: ObjRef;
12404
12379
  /**
12405
- * Defines how the remote-federated module should be loaded.
12380
+ * When true, the object comes from a parent workspace and is not editable
12381
+ * in the current workspace.
12406
12382
  */
12407
- remote: IRemotePluggableApplicationModule;
12383
+ isLocked?: boolean;
12408
12384
  }
12409
12385
 
12410
12386
  /**
12411
- * Pluggable application remote registry, v1.
12387
+ * Payload for creating or updating a document template.
12412
12388
  *
12413
12389
  * @alpha
12414
12390
  */
12415
- export declare interface IRemotePluggableApplicationsRegistryV1 {
12391
+ export declare interface IPublisherDocumentTemplateDefinition {
12392
+ type: "reportTemplate";
12416
12393
  /**
12417
- * The version of the API used by the application manifest
12394
+ * Present when updating an existing template.
12418
12395
  */
12419
- apiVersion: "1.0";
12420
- /**
12421
- * The overrides of the pluggable applications deployed in the shell application by default.
12422
- *
12423
- * Each override is mapped to a key that is the well-documented ID of the default pluggable application,
12424
- * e.g., gdc-analytical-designer, gdc-dashboards, etc. The property can be used, for example, to disable
12425
- * one of these applications or changing the order under which it is added to the Application Header menu.
12426
- */
12427
- overrides?: {
12428
- [applicationId: string]: Partial<PluggableApplicationRegistryItem>;
12429
- };
12430
- /**
12431
- * The optional list of allowed standard applications.
12432
- *
12433
- * The array of well-documented IDs of the standard applications that are deployed in the shell
12434
- * application by default. The property can be used to stabilize which of the standard applications
12435
- * will be available in the Application Header menu. When a new standard application is deployed in
12436
- * the shell application, it will not appear in the menu until it is added to the list of allowed
12437
- * standard applications.
12438
- */
12439
- allowedStandardApplications?: string[];
12440
- /**
12441
- * The list of additional pluggable applications registered to the shell application.
12442
- *
12443
- * Mainly used to register 3rd party hosted remote module federated applications.
12444
- */
12445
- applications?: PluggableApplicationRegistryItem[];
12446
- /**
12447
- * Optional remote module federation definition for a custom host UI module.
12448
- *
12449
- * @remarks
12450
- * When set, the shell application loads the UI module from this remote instead of using the
12451
- * built-in default host UI. The loaded module must conform to the {@link @gooddata/sdk-pluggable-application-model#IHostUiModule}
12452
- * interface.
12453
- *
12454
- * This allows organizations to fully replace the application chrome (header, navigation, layout)
12455
- * with a custom implementation while keeping the pluggable application loading and lifecycle
12456
- * management intact.
12457
- */
12458
- uiModule?: IRemotePluggableApplicationModule;
12459
- }
12460
-
12461
- /**
12462
- * Report metadata object.
12463
- *
12464
- * @alpha
12465
- */
12466
- export declare interface IReport extends IReportDefinition, IAuditableDates, IAuditableUsers {
12467
- ref: ObjRef;
12468
- /**
12469
- * When true, the object comes from a parent workspace and is not editable
12470
- * in the current workspace.
12471
- */
12472
- isLocked?: boolean;
12473
- }
12474
-
12475
- /**
12476
- * Text generated by AI at report-build time.
12477
- *
12478
- * @alpha
12479
- */
12480
- export declare interface IReportAiTextSource {
12481
- type: "ai";
12482
- /**
12483
- * Instruction for the generator. Supports `{variables}`.
12484
- */
12485
- prompt: string;
12486
- /**
12487
- * Materialized generation result (markdown), stored so the report renders
12488
- * deterministically without re-invoking AI. Absent until first generation.
12489
- */
12490
- content?: string;
12491
- /**
12492
- * ISO 8601 timestamp of the stored generation.
12493
- */
12494
- generatedAt?: string;
12495
- }
12496
-
12497
- /**
12498
- * Configuration of a report's content-level attribute filter: the part of a dashboard attribute
12499
- * filter's configuration that reports support.
12500
- *
12501
- * @alpha
12502
- */
12503
- export declare type IReportAttributeFilterConfig = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
12504
-
12505
- /**
12506
- * Fields shared by report definitions and persisted reports.
12507
- *
12508
- * @alpha
12509
- */
12510
- export declare interface IReportBase {
12396
+ ref?: ObjRef;
12511
12397
  title: string;
12512
12398
  description?: string;
12513
12399
  tags?: string[];
12514
- /**
12515
- * Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
12516
- *
12517
- * @remarks
12518
- * At execution time the period materializes as an absolute date filter on each
12519
- * visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
12520
- * ignoreReportPeriod). Also available as `{periodStart}` in text.
12521
- */
12522
- periodStart: ReportDateString;
12523
- /**
12524
- * Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
12525
- */
12526
- periodEnd: ReportDateString;
12527
- /**
12528
- * Content of the report. When created from a template the content is deep-copied
12529
- * and NO reference to the template is kept — the report stays frozen while pages
12530
- * and templates evolve.
12531
- */
12532
- content: IReportContent;
12533
- /**
12534
- * Values for variables declared in content.variables, keyed by variable name.
12535
- */
12536
- variableValues?: Record<string, string>;
12537
- }
12538
-
12539
- /**
12540
- * Paint of the box itself. Never affects the geometry of the box or its children —
12541
- * geometry always comes from layout weights.
12542
- *
12543
- * @alpha
12544
- */
12545
- export declare interface IReportBoxStyle {
12546
- background?: ReportBackground;
12547
- /**
12548
- * Corner radius in percent of the page width — the same relative unit the rest of a report page
12549
- * is sized in, so the corners keep their proportion however large the page is rendered.
12550
- * Content reaching into a rounded corner is clipped.
12551
- */
12552
- borderRadius?: number;
12553
- /**
12554
- * Inset of the box's own content, in percent of the page width like
12555
- * {@link IReportBoxStyle.borderRadius}. Insets only inward — siblings and the layout
12556
- * gaps around the box are untouched. A box that paints a background usually wants one;
12557
- * a full-bleed box (an image-backed cover) wants none, which is why no default exists.
12558
- */
12559
- padding?: number;
12560
- }
12561
-
12562
- /**
12563
- * Solid color painted behind a section's or page's content.
12564
- *
12565
- * @alpha
12566
- */
12567
- export declare interface IReportColorBackground {
12568
- type: "color";
12569
- /**
12570
- * CSS color value. Absolute: report styling states brand colors directly and does not
12571
- * follow the workspace theme.
12572
- */
12573
- color: string;
12574
- }
12575
-
12576
- /**
12577
- * Versioned content shared verbatim by report templates and reports.
12578
- *
12579
- * @alpha
12580
- */
12581
- export declare interface IReportContent {
12582
- /**
12583
- * Content model version, for stored-content evolution.
12584
- */
12585
- version: "1";
12586
- /**
12587
- * Ordered pages of the document.
12588
- */
12589
- pages: IReportContentPage[];
12590
- /**
12591
- * Content-level default filters; pages and slots may extend or override them.
12592
- * The report period is NOT stored here — it is derived from periodStart/periodEnd
12593
- * at execution time.
12594
- */
12595
- filters?: FilterContextItem[];
12596
- /**
12597
- * Configuration of the content-level attribute filters, keyed by the filter's local identifier.
12598
- *
12599
- * @remarks
12600
- * A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
12601
- * is read as primary-label values and shown by `displayAsLabel`.
12602
- */
12603
- attributeFilterConfigs?: IReportAttributeFilterConfig[];
12604
- /**
12605
- * Custom variable declarations. Values live on the report
12606
- * ({@link IReportBase.variableValues}).
12607
- */
12608
- variables?: IReportVariableDefinition[];
12609
- /**
12610
- * Instructions every AI-written text without instructions of its own is generated with.
12611
- * Supports `{variables}`.
12612
- */
12613
- takeawaysInstruction?: string;
12614
- }
12615
-
12616
- /**
12617
- * Page instance embedded in template/report content: a deep clone of a page body
12618
- * plus its own identity.
12619
- *
12620
- * @remarks
12621
- * Cloning a {@link IReportPageLayout} into content assigns the localIdentifier and regenerates
12622
- * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
12623
- * Deliberately carries NO reference back to the source page — later page edits never
12624
- * affect existing templates or reports.
12625
- *
12626
- * @alpha
12627
- */
12628
- export declare interface IReportContentPage extends IReportPageBody {
12629
- /**
12630
- * Identifier unique within the content; stable across template-to-report copy and reordering.
12631
- */
12632
- localIdentifier: string;
12633
- }
12634
-
12635
- /**
12636
- * Payload for creating or updating a report.
12637
- *
12638
- * @alpha
12639
- */
12640
- export declare interface IReportDefinition extends IReportBase {
12641
- type: "report";
12642
- /**
12643
- * Present when updating an existing report.
12644
- */
12645
- ref?: ObjRef;
12400
+ content: IPublisherDocumentContent;
12646
12401
  }
12647
12402
 
12648
12403
  /**
@@ -12654,13 +12409,13 @@ export declare interface IReportDefinition extends IReportBase {
12654
12409
  *
12655
12410
  * @alpha
12656
12411
  */
12657
- export declare interface IReportHeadingSlot extends IReportSlotBase {
12412
+ export declare interface IPublisherHeadingSlot extends IPublisherSlotBase {
12658
12413
  type: "heading";
12659
- style?: IReportHeadingStyle;
12414
+ style?: IPublisherHeadingStyle;
12660
12415
  /**
12661
12416
  * Undefined = declared-but-empty slot.
12662
12417
  */
12663
- source?: ReportTextSource;
12418
+ source?: PublisherTextSource;
12664
12419
  }
12665
12420
 
12666
12421
  /**
@@ -12668,12 +12423,12 @@ export declare interface IReportHeadingSlot extends IReportSlotBase {
12668
12423
  *
12669
12424
  * @alpha
12670
12425
  */
12671
- export declare interface IReportHeadingStyle extends IReportTextStyle {
12426
+ export declare interface IPublisherHeadingStyle extends IPublisherTextStyle {
12672
12427
  /**
12673
- * Defaults to {@link DefaultReportHeadingType}. The size owns the semantic typography that goes
12428
+ * Defaults to {@link DefaultPublisherHeadingType}. The size owns the semantic typography that goes
12674
12429
  * with it; the rest of the style overrides ink and placement on top of it.
12675
12430
  */
12676
- type?: ReportHeadingType;
12431
+ type?: PublisherHeadingType;
12677
12432
  }
12678
12433
 
12679
12434
  /**
@@ -12681,10 +12436,10 @@ export declare interface IReportHeadingStyle extends IReportTextStyle {
12681
12436
  *
12682
12437
  * @alpha
12683
12438
  */
12684
- export declare interface IReportImageBackground {
12439
+ export declare interface IPublisherImageBackground {
12685
12440
  type: "image";
12686
12441
  /**
12687
- * Local identifier of an image slot in {@link IReportPageBody.slots}. Routing the image
12442
+ * Local identifier of an image slot in {@link IPublisherPageBody.slots}. Routing the image
12688
12443
  * through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
12689
12444
  * A reference that is missing or resolves to a non-image slot paints no background.
12690
12445
  */
@@ -12696,21 +12451,21 @@ export declare interface IReportImageBackground {
12696
12451
  *
12697
12452
  * @alpha
12698
12453
  */
12699
- export declare interface IReportImageSlot extends IReportSlotBase {
12454
+ export declare interface IPublisherImageSlot extends IPublisherSlotBase {
12700
12455
  type: "image";
12701
12456
  /**
12702
12457
  * Undefined = declared-but-empty slot.
12703
12458
  */
12704
- source?: ReportImageSource;
12459
+ source?: PublisherImageSource;
12705
12460
  altText?: string;
12706
12461
  /**
12707
12462
  * How the image fills the slot area. Defaults to "contain".
12708
12463
  */
12709
- fit?: ReportImageFit;
12464
+ fit?: PublisherImageFit;
12710
12465
  /**
12711
12466
  * Placement overrides for the drawn image; centered on both axes by default.
12712
12467
  */
12713
- style?: IReportImageStyle;
12468
+ style?: IPublisherImageStyle;
12714
12469
  }
12715
12470
 
12716
12471
  /**
@@ -12719,17 +12474,17 @@ export declare interface IReportImageSlot extends IReportSlotBase {
12719
12474
  *
12720
12475
  * @alpha
12721
12476
  */
12722
- export declare interface IReportImageStyle {
12723
- horizontalAlign?: ReportContentAlignment;
12724
- verticalAlign?: ReportContentAlignment;
12477
+ export declare interface IPublisherImageStyle {
12478
+ horizontalAlign?: PublisherContentAlignment;
12479
+ verticalAlign?: PublisherContentAlignment;
12725
12480
  }
12726
12481
 
12727
12482
  /**
12728
- * Fields common to all report layout nodes.
12483
+ * Fields common to all page layout nodes.
12729
12484
  *
12730
12485
  * @alpha
12731
12486
  */
12732
- export declare interface IReportLayoutNodeBase {
12487
+ export declare interface IPublisherLayoutNodeBase {
12733
12488
  /**
12734
12489
  * Fractional weight of this node inside its parent (flex-grow semantics).
12735
12490
  * Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
@@ -12742,17 +12497,17 @@ export declare interface IReportLayoutNodeBase {
12742
12497
  *
12743
12498
  * @alpha
12744
12499
  */
12745
- export declare interface IReportLayoutSection extends IReportLayoutNodeBase {
12500
+ export declare interface IPublisherLayoutSection extends IPublisherLayoutNodeBase {
12746
12501
  type: "section";
12747
12502
  /**
12748
12503
  * "row" lays children out horizontally, "column" vertically.
12749
12504
  */
12750
12505
  direction: "row" | "column";
12751
- children: ReportPageLayoutNode[];
12506
+ children: PublisherPageLayoutNode[];
12752
12507
  /**
12753
12508
  * Paint of this section's box. Never affects how children are laid out.
12754
12509
  */
12755
- style?: IReportBoxStyle;
12510
+ style?: IPublisherBoxStyle;
12756
12511
  }
12757
12512
 
12758
12513
  /**
@@ -12760,21 +12515,21 @@ export declare interface IReportLayoutSection extends IReportLayoutNodeBase {
12760
12515
  *
12761
12516
  * @alpha
12762
12517
  */
12763
- export declare interface IReportLayoutSlotRef extends IReportLayoutNodeBase {
12518
+ export declare interface IPublisherLayoutSlotRef extends IPublisherLayoutNodeBase {
12764
12519
  type: "slotRef";
12765
12520
  /**
12766
- * Local identifier of a slot in {@link IReportPageBody.slots}.
12521
+ * Local identifier of a slot in {@link IPublisherPageBody.slots}.
12767
12522
  * A slotId with no matching slot renders as an empty area.
12768
12523
  */
12769
12524
  slotId: string;
12770
12525
  }
12771
12526
 
12772
12527
  /**
12773
- * Body of a report page: geometry (flex split tree) plus the slots it places.
12528
+ * Body of a document page: geometry (flex split tree) plus the slots it places.
12774
12529
  *
12775
12530
  * @remarks
12776
- * This is both the content of the standalone {@link IReportPageLayout} object and the shape
12777
- * embedded in template/report content ({@link IReportContentPage}).
12531
+ * This is both the content of the standalone {@link IPublisherPageLayout} object and the shape
12532
+ * embedded in template/document content ({@link IPublisherDocumentPage}).
12778
12533
  *
12779
12534
  * There is no header/footer chrome: page title, description, footer, page numbers and
12780
12535
  * logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
@@ -12782,7 +12537,7 @@ export declare interface IReportLayoutSlotRef extends IReportLayoutNodeBase {
12782
12537
  *
12783
12538
  * @alpha
12784
12539
  */
12785
- export declare interface IReportPageBody {
12540
+ export declare interface IPublisherPageBody {
12786
12541
  /**
12787
12542
  * Editor hint only (template galleries, default styling, AI context).
12788
12543
  * Renderers must not branch layout logic on it — geometry always comes from `layout`.
@@ -12790,21 +12545,21 @@ export declare interface IReportPageBody {
12790
12545
  kind?: "cover" | "section" | "content";
12791
12546
  /**
12792
12547
  * Page proportions the layout was authored for. Defaults to
12793
- * {@link DefaultReportPageFormat}.
12548
+ * {@link DefaultPublisherPageFormat}.
12794
12549
  */
12795
- format?: ReportPageFormat;
12550
+ format?: PublisherPageFormat;
12796
12551
  /**
12797
12552
  * Paint of the page itself, behind everything the layout places.
12798
12553
  */
12799
- style?: IReportBoxStyle;
12554
+ style?: IPublisherBoxStyle;
12800
12555
  /**
12801
12556
  * Root of the page layout tree.
12802
12557
  */
12803
- layout: ReportPageLayoutNode;
12558
+ layout: PublisherPageLayoutNode;
12804
12559
  /**
12805
12560
  * All slots referenced by the layout, flat, keyed by localIdentifier.
12806
12561
  */
12807
- slots: ReportSlot[];
12562
+ slots: PublisherSlot[];
12808
12563
  /**
12809
12564
  * Page-level filters: merged over content-level filters (a filter targeting the
12810
12565
  * same object replaces the inherited one); slot filters apply on top.
@@ -12813,21 +12568,21 @@ export declare interface IReportPageBody {
12813
12568
  }
12814
12569
 
12815
12570
  /**
12816
- * Validation issue found in a report page body.
12571
+ * Validation issue found in a page body.
12817
12572
  *
12818
12573
  * @alpha
12819
12574
  */
12820
- export declare interface IReportPageBodyValidationIssue {
12575
+ export declare interface IPublisherPageBodyValidationIssue {
12821
12576
  severity: "error" | "warning";
12822
12577
  message: string;
12823
12578
  }
12824
12579
 
12825
12580
  /**
12826
- * Reusable report page metadata object.
12581
+ * Reusable page layout metadata object.
12827
12582
  *
12828
12583
  * @alpha
12829
12584
  */
12830
- export declare interface IReportPageLayout extends IReportPageLayoutDefinition, IAuditableDates, IAuditableUsers {
12585
+ export declare interface IPublisherPageLayout extends IPublisherPageLayoutDefinition, IAuditableDates, IAuditableUsers {
12831
12586
  ref: ObjRef;
12832
12587
  /**
12833
12588
  * When true, the object comes from a parent workspace and is not editable
@@ -12846,7 +12601,7 @@ export declare interface IReportPageLayout extends IReportPageLayoutDefinition,
12846
12601
  *
12847
12602
  * @alpha
12848
12603
  */
12849
- export declare interface IReportPageLayoutContent extends IReportPageBody {
12604
+ export declare interface IPublisherPageLayoutContent extends IPublisherPageBody {
12850
12605
  /**
12851
12606
  * Content model version, for stored-content evolution.
12852
12607
  */
@@ -12854,11 +12609,11 @@ export declare interface IReportPageLayoutContent extends IReportPageBody {
12854
12609
  }
12855
12610
 
12856
12611
  /**
12857
- * Payload for creating or updating a report page.
12612
+ * Payload for creating or updating a page layout.
12858
12613
  *
12859
12614
  * @alpha
12860
12615
  */
12861
- export declare interface IReportPageLayoutDefinition {
12616
+ export declare interface IPublisherPageLayoutDefinition {
12862
12617
  type: "reportPageLayout";
12863
12618
  /**
12864
12619
  * Present when updating an existing page.
@@ -12867,7 +12622,7 @@ export declare interface IReportPageLayoutDefinition {
12867
12622
  title: string;
12868
12623
  description?: string;
12869
12624
  tags?: string[];
12870
- content: IReportPageLayoutContent;
12625
+ content: IPublisherPageLayoutContent;
12871
12626
  }
12872
12627
 
12873
12628
  /**
@@ -12875,199 +12630,457 @@ export declare interface IReportPageLayoutDefinition {
12875
12630
  *
12876
12631
  * @alpha
12877
12632
  */
12878
- export declare interface IReportParagraphSlot extends IReportSlotBase {
12633
+ export declare interface IPublisherParagraphSlot extends IPublisherSlotBase {
12879
12634
  type: "paragraph";
12880
- style?: IReportParagraphStyle;
12635
+ style?: IPublisherParagraphStyle;
12881
12636
  /**
12882
12637
  * Undefined = declared-but-empty slot.
12883
12638
  */
12884
- source?: ReportTextSource;
12639
+ source?: PublisherTextSource;
12885
12640
  }
12886
12641
 
12887
12642
  /**
12888
12643
  * Styling of a paragraph slot.
12889
12644
  *
12890
- * @alpha
12645
+ * @alpha
12646
+ */
12647
+ export declare interface IPublisherParagraphStyle extends IPublisherTextStyle {
12648
+ /**
12649
+ * Defaults to {@link DefaultPublisherParagraphType}.
12650
+ */
12651
+ type?: PublisherParagraphType;
12652
+ }
12653
+
12654
+ /**
12655
+ * Structural base of every document slot.
12656
+ *
12657
+ * @remarks
12658
+ * Parsers written against this base can skip slot types introduced by a newer
12659
+ * content version instead of failing.
12660
+ *
12661
+ * @alpha
12662
+ */
12663
+ export declare interface IPublisherSlotBase {
12664
+ type: string;
12665
+ /**
12666
+ * Identifier unique within the page body. The layout tree references it, and it is
12667
+ * the join key when a document fills a template's slots. Regenerated when a page is
12668
+ * cloned into template content so repeated use of one page stays unique.
12669
+ */
12670
+ localIdentifier: string;
12671
+ /**
12672
+ * Present when the slot is an unfilled placeholder.
12673
+ */
12674
+ placeholder?: IPublisherSlotPlaceholder;
12675
+ }
12676
+
12677
+ /**
12678
+ * Metadata of a slot that is intentionally left unfilled in a page layout or template.
12679
+ *
12680
+ * @alpha
12681
+ */
12682
+ export declare interface IPublisherSlotPlaceholder {
12683
+ /**
12684
+ * Authoring hint shown in the empty slot.
12685
+ */
12686
+ hint?: string;
12687
+ /**
12688
+ * When true, a document is not considered complete until this slot is filled.
12689
+ */
12690
+ required?: boolean;
12691
+ }
12692
+
12693
+ /**
12694
+ * Author-written text.
12695
+ *
12696
+ * @alpha
12697
+ */
12698
+ export declare interface IPublisherStaticTextSource {
12699
+ type: "static";
12700
+ /**
12701
+ * Markdown content with `{variable}` placeholders. Stored raw — placeholders are
12702
+ * resolved only at render/export time.
12703
+ */
12704
+ content: string;
12705
+ }
12706
+
12707
+ /**
12708
+ * Slot rendering text of either kind.
12709
+ *
12710
+ * @alpha
12711
+ */
12712
+ export declare type IPublisherTextSlot = IPublisherHeadingSlot | IPublisherParagraphSlot;
12713
+
12714
+ /**
12715
+ * Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
12716
+ *
12717
+ * @alpha
12718
+ */
12719
+ export declare interface IPublisherTextStyle extends IPublisherBoxStyle {
12720
+ /**
12721
+ * CSS color value. Absolute, like {@link IPublisherColorBackground.color}.
12722
+ */
12723
+ color?: string;
12724
+ horizontalAlign?: PublisherContentAlignment;
12725
+ verticalAlign?: PublisherContentAlignment;
12726
+ }
12727
+
12728
+ /**
12729
+ * A custom variable declared by document content and given a value by a document.
12730
+ *
12731
+ * @remarks
12732
+ * Referenced from text as `{name}`. Values come from {@link IPublisherDocumentBase.variableValues},
12733
+ * falling back to {@link IPublisherVariableDefinition.defaultValue}.
12734
+ *
12735
+ * @alpha
12736
+ */
12737
+ export declare interface IPublisherVariableDefinition {
12738
+ /**
12739
+ * Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
12740
+ * Built-in names ({@link PublisherBuiltInVariable}) are reserved.
12741
+ */
12742
+ name: string;
12743
+ /**
12744
+ * Human readable label shown in the editor.
12745
+ */
12746
+ title?: string;
12747
+ description?: string;
12748
+ /**
12749
+ * Value used when the document does not provide one. May not contain further
12750
+ * placeholders — there is no recursive expansion.
12751
+ */
12752
+ defaultValue?: string;
12753
+ }
12754
+
12755
+ /**
12756
+ * Slot rendering an insight, with its own filter context.
12757
+ *
12758
+ * @alpha
12759
+ */
12760
+ export declare interface IPublisherVisualizationSlot extends IPublisherSlotBase {
12761
+ type: "visualization";
12762
+ /**
12763
+ * Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
12764
+ */
12765
+ insight?: ObjRef;
12766
+ /**
12767
+ * Optional title rendered above the visualization. Supports `{variables}`.
12768
+ */
12769
+ title?: string;
12770
+ showTitle?: boolean;
12771
+ /**
12772
+ * Visualization properties overriding the insight's own.
12773
+ */
12774
+ properties?: VisualizationProperties;
12775
+ /**
12776
+ * Slot-level filters, applied on top of the effective content and page filters.
12777
+ * A slot filter targeting the same object replaces the inherited one.
12778
+ */
12779
+ filters?: FilterContextItem[];
12780
+ /**
12781
+ * Content- and page-level filters this slot ignores (matched by display form / date dataset).
12782
+ */
12783
+ ignoredFilters?: IDashboardFilterReference[];
12784
+ /**
12785
+ * Date dataset the document's period (periodStart/periodEnd) is applied to as an
12786
+ * absolute date filter at execution time. Undefined = backend date-dataset
12787
+ * auto-resolution applies.
12788
+ */
12789
+ dateDataSet?: ObjRef;
12790
+ /**
12791
+ * When true, the implicit date filter derived from the document's period is not
12792
+ * applied to this slot.
12793
+ */
12794
+ ignoreReportPeriod?: boolean;
12795
+ }
12796
+
12797
+ /**
12798
+ * @public
12799
+ */
12800
+ export declare interface IRangeCondition {
12801
+ range: IRangeConditionBody;
12802
+ }
12803
+
12804
+ /**
12805
+ * Object defining the {@link IRangeCondition} object body.
12806
+ *
12807
+ * @public
12808
+ */
12809
+ export declare interface IRangeConditionBody {
12810
+ operator: RangeConditionOperator;
12811
+ from: number;
12812
+ to: number;
12813
+ treatNullValuesAs?: number;
12814
+ }
12815
+
12816
+ /**
12817
+ * @public
12818
+ */
12819
+ export declare interface IRankingFilter {
12820
+ rankingFilter: IRankingFilterBody;
12821
+ }
12822
+
12823
+ /**
12824
+ * Object defining the {@link IRankingFilter} object body.
12825
+ *
12826
+ * @public
12827
+ */
12828
+ export declare interface IRankingFilterBody extends IIdentifiableFilter {
12829
+ measure: ObjRefInScope;
12830
+ attributes?: ObjRefInScope[];
12831
+ operator: RankingFilterOperator;
12832
+ value: number;
12833
+ applyOnResult?: boolean;
12834
+ /**
12835
+ * When set to true, the filter returns exactly {@link IRankingFilterBody.value} items and excludes
12836
+ * additional items that share the boundary value (ties). When false or omitted, the backend default
12837
+ * tie-handling behavior is used.
12838
+ */
12839
+ strictLimitOfRows?: boolean;
12840
+ }
12841
+
12842
+ /**
12843
+ * Object defining the {@link IRelativeDateFilter} object body.
12844
+ *
12845
+ * @public
12846
+ */
12847
+ export declare interface IRelativeBoundedDateFilterBody extends IRelativeDateFilterBody {
12848
+ boundedFilter: IUpperBoundedFilter | ILowerBoundedFilter;
12849
+ }
12850
+
12851
+ /**
12852
+ * Filters results to a relative date range.
12853
+ *
12854
+ * @remarks
12855
+ * The relative filtering is always done on some granularity - this specifies
12856
+ * the units in the 'from' and 'to' fields.
12857
+ *
12858
+ * See {@link DateAttributeGranularity}, {@link AllTimeGranularity} and {@link DateGranularity} for further detail.
12859
+ * @public
12860
+ */
12861
+ export declare type IRelativeDateFilter = {
12862
+ relativeDateFilter: IRelativeDateFilterBody;
12863
+ } | {
12864
+ relativeDateFilter: IRelativeDateFilterAllTimeBody;
12865
+ } | {
12866
+ relativeDateFilter: IRelativeBoundedDateFilterBody;
12867
+ };
12868
+
12869
+ /**
12870
+ * Object defining the {@link IRelativeDateFilter} object body.
12871
+ *
12872
+ * @public
12873
+ */
12874
+ export declare interface IRelativeDateFilterAllTimeBody extends IIdentifiableFilter {
12875
+ dataSet: ObjRef;
12876
+ granularity: AllTimeGranularity;
12877
+ from: 0;
12878
+ to: 0;
12879
+ /**
12880
+ * How to treat empty date values.
12881
+ */
12882
+ emptyValueHandling?: EmptyValues;
12883
+ }
12884
+
12885
+ /**
12886
+ * Object defining the {@link IRelativeDateFilter} object body.
12887
+ *
12888
+ * @public
12891
12889
  */
12892
- export declare interface IReportParagraphStyle extends IReportTextStyle {
12890
+ export declare interface IRelativeDateFilterBody extends IIdentifiableFilter {
12891
+ dataSet: ObjRef;
12892
+ granularity: DateAttributeGranularity;
12893
+ from: number;
12894
+ to: number;
12893
12895
  /**
12894
- * Defaults to {@link DefaultReportParagraphType}.
12896
+ * How to treat empty date values.
12895
12897
  */
12896
- type?: ReportParagraphType;
12898
+ emptyValueHandling?: EmptyValues;
12897
12899
  }
12898
12900
 
12899
12901
  /**
12900
- * Structural base of every report slot.
12901
- *
12902
- * @remarks
12903
- * Parsers written against this base can skip slot types introduced by a newer
12904
- * content version instead of failing.
12905
- *
12902
+ * Customized options for the global relative date filter
12906
12903
  * @alpha
12907
12904
  */
12908
- export declare interface IReportSlotBase {
12909
- type: string;
12905
+ export declare interface IRelativeDateFilterForm extends IDateFilterOption {
12910
12906
  /**
12911
- * Identifier unique within the page body. The layout tree references it, and it is
12912
- * the join key when a report fills a template's slots. Regenerated when a page is
12913
- * cloned into template content so repeated use of one page stays unique.
12907
+ * Type to identify the global relative date filter
12914
12908
  */
12915
- localIdentifier: string;
12909
+ type: DateFilterOptionRelativeFormType;
12916
12910
  /**
12917
- * Present when the slot is an unfilled placeholder.
12911
+ * Available granularities for the global relative date filter
12918
12912
  */
12919
- placeholder?: IReportSlotPlaceholder;
12913
+ availableGranularities: DateFilterGranularity[];
12914
+ /**
12915
+ * Optional configuration for how this option should treat empty date values.
12916
+ */
12917
+ emptyValueHandling?: EmptyValues;
12920
12918
  }
12921
12919
 
12922
12920
  /**
12923
- * Metadata of a slot that is intentionally left unfilled in a report page or template.
12924
- *
12921
+ * Custom relative date filter preset
12925
12922
  * @alpha
12926
12923
  */
12927
- export declare interface IReportSlotPlaceholder {
12924
+ export declare interface IRelativeDateFilterPreset extends IDateFilterOption {
12928
12925
  /**
12929
- * Authoring hint shown in the empty slot.
12926
+ * Type to identify a relative date filter preset
12930
12927
  */
12931
- hint?: string;
12928
+ type: DateFilterOptionRelativePresetType;
12932
12929
  /**
12933
- * When true, a report is not considered complete until this slot is filled.
12930
+ * Relative date filter granularity (day/week/year,etc.)
12934
12931
  */
12935
- required?: boolean;
12936
- }
12937
-
12938
- /**
12939
- * Author-written text.
12940
- *
12941
- * @alpha
12942
- */
12943
- export declare interface IReportStaticTextSource {
12944
- type: "static";
12932
+ granularity: DateFilterGranularity;
12945
12933
  /**
12946
- * Markdown content with `{variable}` placeholders. Stored raw — placeholders are
12947
- * resolved only at render/export time.
12934
+ * Relative date filter granularity start offset
12948
12935
  */
12949
- content: string;
12950
- }
12951
-
12952
- /**
12953
- * Report template metadata object.
12954
- *
12955
- * @alpha
12956
- */
12957
- export declare interface IReportTemplate extends IReportTemplateDefinition, IAuditableDates, IAuditableUsers {
12958
- ref: ObjRef;
12936
+ from: RelativeDateFilterGranularityOffset;
12959
12937
  /**
12960
- * When true, the object comes from a parent workspace and is not editable
12961
- * in the current workspace.
12938
+ * Relative date filter granularity end offset
12962
12939
  */
12963
- isLocked?: boolean;
12940
+ to: RelativeDateFilterGranularityOffset;
12941
+ /**
12942
+ * Additional bound for the relative date filter
12943
+ */
12944
+ boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
12945
+ /**
12946
+ * Optional configuration for how this preset should treat empty date values.
12947
+ */
12948
+ emptyValueHandling?: EmptyValues;
12964
12949
  }
12965
12950
 
12966
12951
  /**
12967
- * Payload for creating or updating a report template.
12968
- *
12952
+ * Generic type to express relative date filter preset of a particular granularity
12969
12953
  * @alpha
12970
12954
  */
12971
- export declare interface IReportTemplateDefinition {
12972
- type: "reportTemplate";
12955
+ export declare interface IRelativeDateFilterPresetOfGranularity<Key extends DateFilterGranularity> extends IRelativeDateFilterPreset {
12973
12956
  /**
12974
- * Present when updating an existing template.
12957
+ * Particular relative date filter preset granularity
12975
12958
  */
12976
- ref?: ObjRef;
12977
- title: string;
12978
- description?: string;
12979
- tags?: string[];
12980
- content: IReportContent;
12959
+ granularity: Key;
12981
12960
  }
12982
12961
 
12983
12962
  /**
12984
- * Slot rendering text of either kind.
12963
+ * Represents values of a relative filter.
12985
12964
  *
12986
- * @alpha
12965
+ * @public
12987
12966
  */
12988
- export declare type IReportTextSlot = IReportHeadingSlot | IReportParagraphSlot;
12967
+ export declare interface IRelativeDateFilterValues {
12968
+ from: number;
12969
+ to: number;
12970
+ granularity: string;
12971
+ dataSet?: ObjRef;
12972
+ boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
12973
+ emptyValueHandling?: EmptyValues;
12974
+ }
12989
12975
 
12990
12976
  /**
12991
- * Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
12977
+ * Definition of the remote pluggable application.
12978
+ * The application is loaded via Module Federation.
12992
12979
  *
12993
12980
  * @alpha
12994
12981
  */
12995
- export declare interface IReportTextStyle extends IReportBoxStyle {
12982
+ export declare interface IRemotePluggableApplicationModule {
12996
12983
  /**
12997
- * CSS color value. Absolute, like {@link IReportColorBackground.color}.
12984
+ * Full URL of the remote federated module with the application bundle.
12985
+ *
12986
+ * @example
12987
+ * https://my-remote-federated-module.com/remoteEntry.js
12998
12988
  */
12999
- color?: string;
13000
- horizontalAlign?: ReportContentAlignment;
13001
- verticalAlign?: ReportContentAlignment;
13002
- }
13003
-
13004
- /**
13005
- * A custom variable declared by report content and given a value by a report.
13006
- *
13007
- * @remarks
13008
- * Referenced from text as `{name}`. Values come from {@link IReportBase.variableValues},
13009
- * falling back to {@link IReportVariableDefinition.defaultValue}.
13010
- *
13011
- * @alpha
13012
- */
13013
- export declare interface IReportVariableDefinition {
12989
+ url: string;
13014
12990
  /**
13015
- * Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
13016
- * Built-in names ({@link ReportBuiltInVariable}) are reserved.
12991
+ * Unique module federation scope value (must match the remote module definition during build)
12992
+ * Must be unique within the same remote federation to not share dependencies and scope with another
12993
+ * application.
12994
+ *
12995
+ * @example
12996
+ * "my-remote-federated-module"
13017
12997
  */
13018
- name: string;
12998
+ scope: string;
13019
12999
  /**
13020
- * Human readable label shown in the editor.
13000
+ * Exposed module name. Must match the remote module definition.
13001
+ * Maps to internal application module (e.g. "./src/remote-entry.tsx")
13002
+ *
13003
+ * @example
13004
+ * "./AppModule"
13021
13005
  */
13022
- title?: string;
13023
- description?: string;
13006
+ module: string;
13024
13007
  /**
13025
- * Value used when the report does not provide one. May not contain further
13026
- * placeholders — there is no recursive expansion.
13008
+ * Base route of the application.
13009
+ * It is relative to the shell application route.
13010
+ *
13011
+ * @example
13012
+ * "/my-application"
13013
+ *
13014
+ * When the application is registered to "organization" scope, the application will be hosted at
13015
+ * /organization/my-application.
13016
+ * When the application is registered to the "workspace" scope, the application will be hosted at
13017
+ * /workspace/\{workspaceId\}/my-application.
13027
13018
  */
13028
- defaultValue?: string;
13019
+ routeBase: string;
13029
13020
  }
13030
13021
 
13031
13022
  /**
13032
- * Slot rendering an insight, with its own filter context.
13023
+ * Remote pluggable application registry item, v1.
13024
+ * Loaded via Module Federation.
13033
13025
  *
13034
13026
  * @alpha
13035
13027
  */
13036
- export declare interface IReportVisualizationSlot extends IReportSlotBase {
13037
- type: "visualization";
13038
- /**
13039
- * Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
13040
- */
13041
- insight?: ObjRef;
13028
+ export declare interface IRemotePluggableApplicationRegistryItemV1 extends IPluggableApplicationMetaV1 {
13042
13029
  /**
13043
- * Optional title rendered above the visualization. Supports `{variables}`.
13030
+ * Defines how the remote-federated module should be loaded.
13044
13031
  */
13045
- title?: string;
13046
- showTitle?: boolean;
13032
+ remote: IRemotePluggableApplicationModule;
13033
+ }
13034
+
13035
+ /**
13036
+ * Pluggable application remote registry, v1.
13037
+ *
13038
+ * @alpha
13039
+ */
13040
+ export declare interface IRemotePluggableApplicationsRegistryV1 {
13047
13041
  /**
13048
- * Visualization properties overriding the insight's own.
13042
+ * The version of the API used by the application manifest
13049
13043
  */
13050
- properties?: VisualizationProperties;
13044
+ apiVersion: "1.0";
13051
13045
  /**
13052
- * Slot-level filters, applied on top of the effective content and page filters.
13053
- * A slot filter targeting the same object replaces the inherited one.
13046
+ * The overrides of the pluggable applications deployed in the shell application by default.
13047
+ *
13048
+ * Each override is mapped to a key that is the well-documented ID of the default pluggable application,
13049
+ * e.g., gdc-analytical-designer, gdc-dashboards, etc. The property can be used, for example, to disable
13050
+ * one of these applications or changing the order under which it is added to the Application Header menu.
13054
13051
  */
13055
- filters?: FilterContextItem[];
13052
+ overrides?: {
13053
+ [applicationId: string]: Partial<PluggableApplicationRegistryItem>;
13054
+ };
13056
13055
  /**
13057
- * Content- and page-level filters this slot ignores (matched by display form / date dataset).
13056
+ * The optional list of allowed standard applications.
13057
+ *
13058
+ * The array of well-documented IDs of the standard applications that are deployed in the shell
13059
+ * application by default. The property can be used to stabilize which of the standard applications
13060
+ * will be available in the Application Header menu. When a new standard application is deployed in
13061
+ * the shell application, it will not appear in the menu until it is added to the list of allowed
13062
+ * standard applications.
13058
13063
  */
13059
- ignoredFilters?: IDashboardFilterReference[];
13064
+ allowedStandardApplications?: string[];
13060
13065
  /**
13061
- * Date dataset the report's period (periodStart/periodEnd) is applied to as an
13062
- * absolute date filter at execution time. Undefined = backend date-dataset
13063
- * auto-resolution applies.
13066
+ * The list of additional pluggable applications registered to the shell application.
13067
+ *
13068
+ * Mainly used to register 3rd party hosted remote module federated applications.
13064
13069
  */
13065
- dateDataSet?: ObjRef;
13070
+ applications?: PluggableApplicationRegistryItem[];
13066
13071
  /**
13067
- * When true, the implicit date filter derived from the report's period is not
13068
- * applied to this slot.
13072
+ * Optional remote module federation definition for a custom host UI module.
13073
+ *
13074
+ * @remarks
13075
+ * When set, the shell application loads the UI module from this remote instead of using the
13076
+ * built-in default host UI. The loaded module must conform to the {@link @gooddata/sdk-pluggable-application-model#IHostUiModule}
13077
+ * interface.
13078
+ *
13079
+ * This allows organizations to fully replace the application chrome (header, navigation, layout)
13080
+ * with a custom implementation while keeping the pluggable application loading and lifecycle
13081
+ * management intact.
13069
13082
  */
13070
- ignoreReportPeriod?: boolean;
13083
+ uiModule?: IRemotePluggableApplicationModule;
13071
13084
  }
13072
13085
 
13073
13086
  /**
@@ -15034,260 +15047,260 @@ export declare function isPreviousPeriodMeasure(obj: unknown): obj is IMeasure<I
15034
15047
  export declare function isPreviousPeriodMeasureDefinition(obj: unknown): obj is IPreviousPeriodMeasureDefinition;
15035
15048
 
15036
15049
  /**
15037
- * Type guard checking whether the provided object is a measure value filter's range condition.
15050
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackground}.
15038
15051
  *
15039
- * @public
15052
+ * @alpha
15040
15053
  */
15041
- export declare function isRangeCondition(obj: unknown): obj is IRangeCondition;
15054
+ export declare function isPublisherColorBackground(obj: unknown): obj is IPublisherColorBackground;
15042
15055
 
15043
15056
  /**
15044
- * Type guard checking whether the provided object is a measure value filter's range condition operator.
15057
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocument}.
15045
15058
  *
15046
- * @public
15059
+ * @alpha
15047
15060
  */
15048
- export declare function isRangeConditionOperator(obj: unknown): obj is RangeConditionOperator;
15061
+ export declare function isPublisherDocument(obj: unknown): obj is IPublisherDocument;
15049
15062
 
15050
15063
  /**
15051
- * Type guard checking whether the provided object is a ranking filter.
15064
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContent}.
15052
15065
  *
15053
- * @public
15066
+ * @alpha
15054
15067
  */
15055
- export declare function isRankingFilter(obj: unknown): obj is IRankingFilter;
15068
+ export declare function isPublisherDocumentContentV1(obj: unknown): obj is IPublisherDocumentContent;
15056
15069
 
15057
15070
  /**
15058
- * Type guard checking whether the provided object is a relative date filter with bounded.
15071
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinition}.
15059
15072
  *
15060
- * @public
15073
+ * @alpha
15061
15074
  */
15062
- export declare function isRelativeBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
15063
- relativeDateFilter: IRelativeBoundedDateFilterBody;
15064
- };
15075
+ export declare function isPublisherDocumentDefinition(obj: unknown): obj is IPublisherDocumentDefinition;
15065
15076
 
15066
15077
  /**
15067
- * Type guard checking whether the provided object is a relative date filter body with bounded.
15078
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplate}.
15068
15079
  *
15069
- * @public
15070
- */
15071
- export declare function isRelativeBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody;
15072
-
15073
- /**
15074
- * Returns true when given date filter has type set to relative.
15075
15080
  * @alpha
15076
15081
  */
15077
- export declare function isRelativeDashboardDateFilter(dateFilter: IDashboardDateFilter): boolean;
15082
+ export declare function isPublisherDocumentTemplate(obj: unknown): obj is IPublisherDocumentTemplate;
15078
15083
 
15079
15084
  /**
15080
- * Type guard checking whether the provided object is a relative date filter.
15085
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinition}.
15081
15086
  *
15082
- * @public
15083
- */
15084
- export declare function isRelativeDateFilter(obj: unknown): obj is IRelativeDateFilter;
15085
-
15086
- /**
15087
- * Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterForm}.
15088
15087
  * @alpha
15089
15088
  */
15090
- export declare const isRelativeDateFilterForm: (obj: unknown) => obj is IRelativeDateFilterForm;
15089
+ export declare function isPublisherDocumentTemplateDefinition(obj: unknown): obj is IPublisherDocumentTemplateDefinition;
15091
15090
 
15092
15091
  /**
15093
- * Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterPreset}.
15092
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherHeadingSlot}.
15093
+ *
15094
15094
  * @alpha
15095
15095
  */
15096
- export declare const isRelativeDateFilterPreset: (obj: unknown) => obj is IRelativeDateFilterPreset;
15096
+ export declare function isPublisherHeadingSlot(obj: unknown): obj is IPublisherHeadingSlot;
15097
15097
 
15098
15098
  /**
15099
- * Type guard checking whether the provided filter is a relative date filter with lower bounded.
15099
+ * Type-guard testing whether the value is a {@link PublisherHeadingType}.
15100
15100
  *
15101
- * @public
15101
+ * @alpha
15102
15102
  */
15103
- export declare function isRelativeLowerBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
15104
- relativeDateFilter: IRelativeBoundedDateFilterBody & {
15105
- boundedFilter: ILowerBoundedFilter;
15106
- };
15107
- };
15103
+ export declare function isPublisherHeadingType(value: unknown): value is PublisherHeadingType;
15108
15104
 
15109
15105
  /**
15110
- * Type guard checking whether the provided filter body has a bounded filter with lower bounded.
15106
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackground}.
15111
15107
  *
15112
- * @public
15108
+ * @alpha
15113
15109
  */
15114
- export declare function isRelativeLowerBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody & {
15115
- boundedFilter: ILowerBoundedFilter;
15116
- };
15110
+ export declare function isPublisherImageBackground(obj: unknown): obj is IPublisherImageBackground;
15117
15111
 
15118
15112
  /**
15119
- * Type guard checking whether the provided filter is a relative date filter with upper bounded.
15113
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageSlot}.
15120
15114
  *
15121
- * @public
15115
+ * @alpha
15122
15116
  */
15123
- export declare function isRelativeUpperBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
15124
- relativeDateFilter: IRelativeBoundedDateFilterBody & {
15125
- boundedFilter: IUpperBoundedFilter;
15126
- };
15127
- };
15117
+ export declare function isPublisherImageSlot(obj: unknown): obj is IPublisherImageSlot;
15128
15118
 
15129
15119
  /**
15130
- * Type guard checking whether the provided filter body has a bounded filter with upper bounded.
15120
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSection}.
15131
15121
  *
15132
- * @public
15122
+ * @alpha
15133
15123
  */
15134
- export declare function isRelativeUpperBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody & {
15135
- boundedFilter: IUpperBoundedFilter;
15136
- };
15124
+ export declare function isPublisherLayoutSection(obj: unknown): obj is IPublisherLayoutSection;
15137
15125
 
15138
15126
  /**
15139
- * Type guard for RemotePluggableApplicationRegistryItem
15127
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRef}.
15140
15128
  *
15141
15129
  * @alpha
15142
15130
  */
15143
- export declare function isRemotePluggableApplicationRegistryItem(app: PluggableApplicationRegistryItem): app is RemotePluggableApplicationRegistryItem;
15131
+ export declare function isPublisherLayoutSlotRef(obj: unknown): obj is IPublisherLayoutSlotRef;
15144
15132
 
15145
15133
  /**
15146
- * Type-guard testing whether the provided object is an instance of {@link IReport}.
15134
+ * Type-guard testing whether the provided value is a {@link PublisherPageFormat}.
15147
15135
  *
15148
15136
  * @alpha
15149
15137
  */
15150
- export declare function isReport(obj: unknown): obj is IReport;
15138
+ export declare function isPublisherPageFormat(value: unknown): value is PublisherPageFormat;
15151
15139
 
15152
15140
  /**
15153
- * Type-guard testing whether the provided object is an instance of {@link IReportColorBackground}.
15141
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayout}.
15154
15142
  *
15155
15143
  * @alpha
15156
15144
  */
15157
- export declare function isReportColorBackground(obj: unknown): obj is IReportColorBackground;
15145
+ export declare function isPublisherPageLayout(obj: unknown): obj is IPublisherPageLayout;
15158
15146
 
15159
15147
  /**
15160
- * Type-guard testing whether the provided object is an instance of {@link IReportContent}.
15148
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
15161
15149
  *
15162
15150
  * @alpha
15163
15151
  */
15164
- export declare function isReportContentV1(obj: unknown): obj is IReportContent;
15152
+ export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContent;
15165
15153
 
15166
15154
  /**
15167
- * Type-guard testing whether the provided object is an instance of {@link IReportDefinition}.
15155
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
15168
15156
  *
15169
15157
  * @alpha
15170
15158
  */
15171
- export declare function isReportDefinition(obj: unknown): obj is IReportDefinition;
15159
+ export declare function isPublisherPageLayoutDefinition(obj: unknown): obj is IPublisherPageLayoutDefinition;
15172
15160
 
15173
15161
  /**
15174
- * Type-guard testing whether the provided object is an instance of {@link IReportHeadingSlot}.
15162
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlot}.
15175
15163
  *
15176
15164
  * @alpha
15177
15165
  */
15178
- export declare function isReportHeadingSlot(obj: unknown): obj is IReportHeadingSlot;
15166
+ export declare function isPublisherParagraphSlot(obj: unknown): obj is IPublisherParagraphSlot;
15179
15167
 
15180
15168
  /**
15181
- * Type-guard testing whether the value is a {@link ReportHeadingType}.
15169
+ * Type-guard testing whether the value is a {@link PublisherParagraphType}.
15182
15170
  *
15183
15171
  * @alpha
15184
15172
  */
15185
- export declare function isReportHeadingType(value: unknown): value is ReportHeadingType;
15173
+ export declare function isPublisherParagraphType(value: unknown): value is PublisherParagraphType;
15186
15174
 
15187
15175
  /**
15188
- * Type-guard testing whether the provided object is an instance of {@link IReportImageBackground}.
15176
+ * Type-guard testing whether the provided object is an instance of {@link PublisherSlot}.
15189
15177
  *
15190
15178
  * @alpha
15191
15179
  */
15192
- export declare function isReportImageBackground(obj: unknown): obj is IReportImageBackground;
15180
+ export declare function isPublisherSlot(obj: unknown): obj is PublisherSlot;
15193
15181
 
15194
15182
  /**
15195
- * Type-guard testing whether the provided object is an instance of {@link IReportImageSlot}.
15183
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlot}.
15196
15184
  *
15197
15185
  * @alpha
15198
15186
  */
15199
- export declare function isReportImageSlot(obj: unknown): obj is IReportImageSlot;
15187
+ export declare function isPublisherTextSlot(obj: unknown): obj is IPublisherTextSlot;
15200
15188
 
15201
15189
  /**
15202
- * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSection}.
15190
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlot}.
15203
15191
  *
15204
15192
  * @alpha
15205
15193
  */
15206
- export declare function isReportLayoutSection(obj: unknown): obj is IReportLayoutSection;
15194
+ export declare function isPublisherVisualizationSlot(obj: unknown): obj is IPublisherVisualizationSlot;
15207
15195
 
15208
15196
  /**
15209
- * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSlotRef}.
15197
+ * Type guard checking whether the provided object is a measure value filter's range condition.
15210
15198
  *
15211
- * @alpha
15199
+ * @public
15212
15200
  */
15213
- export declare function isReportLayoutSlotRef(obj: unknown): obj is IReportLayoutSlotRef;
15201
+ export declare function isRangeCondition(obj: unknown): obj is IRangeCondition;
15214
15202
 
15215
15203
  /**
15216
- * Type-guard testing whether the provided value is a {@link ReportPageFormat}.
15204
+ * Type guard checking whether the provided object is a measure value filter's range condition operator.
15217
15205
  *
15218
- * @alpha
15206
+ * @public
15219
15207
  */
15220
- export declare function isReportPageFormat(value: unknown): value is ReportPageFormat;
15208
+ export declare function isRangeConditionOperator(obj: unknown): obj is RangeConditionOperator;
15221
15209
 
15222
15210
  /**
15223
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayout}.
15211
+ * Type guard checking whether the provided object is a ranking filter.
15224
15212
  *
15225
- * @alpha
15213
+ * @public
15226
15214
  */
15227
- export declare function isReportPageLayout(obj: unknown): obj is IReportPageLayout;
15215
+ export declare function isRankingFilter(obj: unknown): obj is IRankingFilter;
15228
15216
 
15229
15217
  /**
15230
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutContent}.
15218
+ * Type guard checking whether the provided object is a relative date filter with bounded.
15231
15219
  *
15232
- * @alpha
15220
+ * @public
15233
15221
  */
15234
- export declare function isReportPageLayoutContentV1(obj: unknown): obj is IReportPageLayoutContent;
15222
+ export declare function isRelativeBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
15223
+ relativeDateFilter: IRelativeBoundedDateFilterBody;
15224
+ };
15235
15225
 
15236
15226
  /**
15237
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutDefinition}.
15227
+ * Type guard checking whether the provided object is a relative date filter body with bounded.
15238
15228
  *
15229
+ * @public
15230
+ */
15231
+ export declare function isRelativeBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody;
15232
+
15233
+ /**
15234
+ * Returns true when given date filter has type set to relative.
15239
15235
  * @alpha
15240
15236
  */
15241
- export declare function isReportPageLayoutDefinition(obj: unknown): obj is IReportPageLayoutDefinition;
15237
+ export declare function isRelativeDashboardDateFilter(dateFilter: IDashboardDateFilter): boolean;
15242
15238
 
15243
15239
  /**
15244
- * Type-guard testing whether the provided object is an instance of {@link IReportParagraphSlot}.
15240
+ * Type guard checking whether the provided object is a relative date filter.
15245
15241
  *
15242
+ * @public
15243
+ */
15244
+ export declare function isRelativeDateFilter(obj: unknown): obj is IRelativeDateFilter;
15245
+
15246
+ /**
15247
+ * Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterForm}.
15246
15248
  * @alpha
15247
15249
  */
15248
- export declare function isReportParagraphSlot(obj: unknown): obj is IReportParagraphSlot;
15250
+ export declare const isRelativeDateFilterForm: (obj: unknown) => obj is IRelativeDateFilterForm;
15249
15251
 
15250
15252
  /**
15251
- * Type-guard testing whether the value is a {@link ReportParagraphType}.
15252
- *
15253
+ * Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterPreset}.
15253
15254
  * @alpha
15254
15255
  */
15255
- export declare function isReportParagraphType(value: unknown): value is ReportParagraphType;
15256
+ export declare const isRelativeDateFilterPreset: (obj: unknown) => obj is IRelativeDateFilterPreset;
15256
15257
 
15257
15258
  /**
15258
- * Type-guard testing whether the provided object is an instance of {@link ReportSlot}.
15259
+ * Type guard checking whether the provided filter is a relative date filter with lower bounded.
15259
15260
  *
15260
- * @alpha
15261
+ * @public
15261
15262
  */
15262
- export declare function isReportSlot(obj: unknown): obj is ReportSlot;
15263
+ export declare function isRelativeLowerBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
15264
+ relativeDateFilter: IRelativeBoundedDateFilterBody & {
15265
+ boundedFilter: ILowerBoundedFilter;
15266
+ };
15267
+ };
15263
15268
 
15264
15269
  /**
15265
- * Type-guard testing whether the provided object is an instance of {@link IReportTemplate}.
15270
+ * Type guard checking whether the provided filter body has a bounded filter with lower bounded.
15266
15271
  *
15267
- * @alpha
15272
+ * @public
15268
15273
  */
15269
- export declare function isReportTemplate(obj: unknown): obj is IReportTemplate;
15274
+ export declare function isRelativeLowerBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody & {
15275
+ boundedFilter: ILowerBoundedFilter;
15276
+ };
15270
15277
 
15271
15278
  /**
15272
- * Type-guard testing whether the provided object is an instance of {@link IReportTemplateDefinition}.
15279
+ * Type guard checking whether the provided filter is a relative date filter with upper bounded.
15273
15280
  *
15274
- * @alpha
15281
+ * @public
15275
15282
  */
15276
- export declare function isReportTemplateDefinition(obj: unknown): obj is IReportTemplateDefinition;
15283
+ export declare function isRelativeUpperBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
15284
+ relativeDateFilter: IRelativeBoundedDateFilterBody & {
15285
+ boundedFilter: IUpperBoundedFilter;
15286
+ };
15287
+ };
15277
15288
 
15278
15289
  /**
15279
- * Type-guard testing whether the provided object is an instance of {@link IReportTextSlot}.
15290
+ * Type guard checking whether the provided filter body has a bounded filter with upper bounded.
15280
15291
  *
15281
- * @alpha
15292
+ * @public
15282
15293
  */
15283
- export declare function isReportTextSlot(obj: unknown): obj is IReportTextSlot;
15294
+ export declare function isRelativeUpperBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody & {
15295
+ boundedFilter: IUpperBoundedFilter;
15296
+ };
15284
15297
 
15285
15298
  /**
15286
- * Type-guard testing whether the provided object is an instance of {@link IReportVisualizationSlot}.
15299
+ * Type guard for RemotePluggableApplicationRegistryItem
15287
15300
  *
15288
15301
  * @alpha
15289
15302
  */
15290
- export declare function isReportVisualizationSlot(obj: unknown): obj is IReportVisualizationSlot;
15303
+ export declare function isRemotePluggableApplicationRegistryItem(app: PluggableApplicationRegistryItem): app is RemotePluggableApplicationRegistryItem;
15291
15304
 
15292
15305
  /**
15293
15306
  * Type-guard testing whether the provided object is an instance of {@link IResultAttributeHeader}.
@@ -15823,6 +15836,12 @@ export declare interface ITheme {
15823
15836
  * Toast message specific properties
15824
15837
  */
15825
15838
  toastMessage?: IThemeToastMessage;
15839
+ /**
15840
+ * Toolbar customizable UI properties
15841
+ *
15842
+ * @alpha
15843
+ */
15844
+ toolbar?: IThemeToolbar;
15826
15845
  /**
15827
15846
  * Application header (top bar) specific properties
15828
15847
  *
@@ -15830,13 +15849,13 @@ export declare interface ITheme {
15830
15849
  */
15831
15850
  header?: IThemeHeader;
15832
15851
  /**
15833
- * Report specific properties
15852
+ * Publisher-specific properties
15834
15853
  *
15835
15854
  * @alpha
15836
15855
  */
15837
- reports?: IThemeReports;
15856
+ reports?: IThemePublisher;
15838
15857
  /**
15839
- * Image assets offered to reports
15858
+ * Image assets offered to documents
15840
15859
  *
15841
15860
  * @alpha
15842
15861
  */
@@ -15868,10 +15887,10 @@ export declare interface IThemeAnalyticalDesignerTitle {
15868
15887
  }
15869
15888
 
15870
15889
  /**
15871
- * Externally hosted image the theme offers to reports.
15890
+ * Externally hosted image the theme offers to documents.
15872
15891
  *
15873
15892
  * @remarks
15874
- * The `id` is also the report variable the asset resolves: report content references it as `{id}`.
15893
+ * The `id` is also the document variable the asset resolves: document content references it as `{id}`.
15875
15894
  * It must match `^[a-zA-Z][a-zA-Z0-9_]*$`.
15876
15895
  *
15877
15896
  * @alpha
@@ -16705,31 +16724,31 @@ export declare interface IThemePalette {
16705
16724
  }
16706
16725
 
16707
16726
  /**
16708
- * Report specific theme properties.
16727
+ * Publisher-specific theme properties.
16709
16728
  *
16710
16729
  * @remarks
16711
- * Consumed by the reports application only; the properties are not part of the shared theming
16730
+ * Consumed by the publisher application only; the properties are not part of the shared theming
16712
16731
  * CSS variable specification.
16713
16732
  *
16714
16733
  * @alpha
16715
16734
  */
16716
- export declare interface IThemeReports {
16735
+ export declare interface IThemePublisher {
16717
16736
  /**
16718
- * Colors of visualizations in reports: stated inline, or a reference to a color palette
16719
- * object. When absent, reports use the workspace's active color palette.
16737
+ * Colors of visualizations in documents: stated inline, or a reference to a color palette
16738
+ * object. When absent, documents use the workspace's active color palette.
16720
16739
  */
16721
16740
  visualizationPalette?: ThemeColor[] | IThemeColorPaletteRef;
16722
- page?: IThemeReportsPage;
16723
- colors?: IThemeReportsColors;
16724
- textStyle?: IThemeReportsTextStyle;
16741
+ page?: IThemePublisherPage;
16742
+ colors?: IThemePublisherColors;
16743
+ textStyle?: IThemePublisherTextStyle;
16725
16744
  }
16726
16745
 
16727
16746
  /**
16728
- * Colors offered to report authors as swatches. Each list is exposed as indexed CSS variables.
16747
+ * Colors offered to document authors as swatches. Each list is exposed as indexed CSS variables.
16729
16748
  *
16730
16749
  * @alpha
16731
16750
  */
16732
- export declare interface IThemeReportsColors {
16751
+ export declare interface IThemePublisherColors {
16733
16752
  /**
16734
16753
  * Offered for element backgrounds.
16735
16754
  */
@@ -16741,13 +16760,13 @@ export declare interface IThemeReportsColors {
16741
16760
  }
16742
16761
 
16743
16762
  /**
16744
- * One hosted font file registered as a font face for rendered reports.
16763
+ * One hosted font file registered as a font face for rendered documents.
16745
16764
  *
16746
16765
  * @alpha
16747
16766
  */
16748
- export declare interface IThemeReportsFontFace {
16767
+ export declare interface IThemePublisherFontFace {
16749
16768
  /**
16750
- * Font family name the face registers; referenced from {@link IThemeReportsTypography.fontFamily}.
16769
+ * Font family name the face registers; referenced from {@link IThemePublisherTypography.fontFamily}.
16751
16770
  */
16752
16771
  family: string;
16753
16772
  /**
@@ -16766,42 +16785,42 @@ export declare interface IThemeReportsFontFace {
16766
16785
 
16767
16786
  /**
16768
16787
  * Heading levels. Each level takes what it does not state from here, then from
16769
- * {@link IThemeReportsTextStyle}.
16788
+ * {@link IThemePublisherTextStyle}.
16770
16789
  *
16771
16790
  * @alpha
16772
16791
  */
16773
- export declare interface IThemeReportsHeading {
16792
+ export declare interface IThemePublisherHeading {
16774
16793
  color?: ThemeColor;
16775
- lineHeight?: ThemeReportsLength;
16776
- h1?: IThemeReportsTextLevel;
16777
- h2?: IThemeReportsTextLevel;
16778
- h3?: IThemeReportsTextLevel;
16779
- h4?: IThemeReportsTextLevel;
16780
- h5?: IThemeReportsTextLevel;
16781
- h6?: IThemeReportsTextLevel;
16794
+ lineHeight?: ThemePublisherLength;
16795
+ h1?: IThemePublisherTextLevel;
16796
+ h2?: IThemePublisherTextLevel;
16797
+ h3?: IThemePublisherTextLevel;
16798
+ h4?: IThemePublisherTextLevel;
16799
+ h5?: IThemePublisherTextLevel;
16800
+ h6?: IThemePublisherTextLevel;
16782
16801
  }
16783
16802
 
16784
16803
  /**
16785
- * Report page properties.
16804
+ * Document page properties.
16786
16805
  *
16787
16806
  * @alpha
16788
16807
  */
16789
- export declare interface IThemeReportsPage {
16808
+ export declare interface IThemePublisherPage {
16790
16809
  backgroundColor?: ThemeColor;
16791
16810
  }
16792
16811
 
16793
16812
  /**
16794
16813
  * Paragraph levels. Each level takes what it does not state from here, then from
16795
- * {@link IThemeReportsTextStyle}.
16814
+ * {@link IThemePublisherTextStyle}.
16796
16815
  *
16797
16816
  * @alpha
16798
16817
  */
16799
- export declare interface IThemeReportsParagraph {
16818
+ export declare interface IThemePublisherParagraph {
16800
16819
  color?: ThemeColor;
16801
- lineHeight?: ThemeReportsLength;
16802
- largeText?: IThemeReportsTextLevel;
16803
- normalText?: IThemeReportsTextLevel;
16804
- smallText?: IThemeReportsTextLevel;
16820
+ lineHeight?: ThemePublisherLength;
16821
+ largeText?: IThemePublisherTextLevel;
16822
+ normalText?: IThemePublisherTextLevel;
16823
+ smallText?: IThemePublisherTextLevel;
16805
16824
  }
16806
16825
 
16807
16826
  /**
@@ -16809,9 +16828,9 @@ export declare interface IThemeReportsParagraph {
16809
16828
  *
16810
16829
  * @alpha
16811
16830
  */
16812
- export declare interface IThemeReportsTextLevel {
16813
- fontSize?: ThemeReportsLength;
16814
- lineHeight?: ThemeReportsLength;
16831
+ export declare interface IThemePublisherTextLevel {
16832
+ fontSize?: ThemePublisherLength;
16833
+ lineHeight?: ThemePublisherLength;
16815
16834
  /**
16816
16835
  * Overrides the color of the level's group.
16817
16836
  */
@@ -16819,29 +16838,29 @@ export declare interface IThemeReportsTextLevel {
16819
16838
  }
16820
16839
 
16821
16840
  /**
16822
- * Text of rendered reports.
16841
+ * Text of rendered documents.
16823
16842
  *
16824
16843
  * @alpha
16825
16844
  */
16826
- export declare interface IThemeReportsTextStyle {
16845
+ export declare interface IThemePublisherTextStyle {
16827
16846
  color?: ThemeColor;
16828
- lineHeight?: ThemeReportsLength;
16829
- typography?: IThemeReportsTypography;
16830
- heading?: IThemeReportsHeading;
16831
- paragraph?: IThemeReportsParagraph;
16847
+ lineHeight?: ThemePublisherLength;
16848
+ typography?: IThemePublisherTypography;
16849
+ heading?: IThemePublisherHeading;
16850
+ paragraph?: IThemePublisherParagraph;
16832
16851
  }
16833
16852
 
16834
16853
  /**
16835
- * Typography of rendered reports.
16854
+ * Typography of rendered documents.
16836
16855
  *
16837
16856
  * @alpha
16838
16857
  */
16839
- export declare interface IThemeReportsTypography {
16858
+ export declare interface IThemePublisherTypography {
16840
16859
  /**
16841
- * CSS font-family stack applied to rendered reports.
16860
+ * CSS font-family stack applied to rendered documents.
16842
16861
  */
16843
16862
  fontFamily?: string;
16844
- fonts?: IThemeReportsFontFace[];
16863
+ fonts?: IThemePublisherFontFace[];
16845
16864
  }
16846
16865
 
16847
16866
  /**
@@ -16932,6 +16951,18 @@ export declare interface IThemeToastMessageVariant extends IThemeMessageVariant
16932
16951
  separatorLineColor?: ThemeColor;
16933
16952
  }
16934
16953
 
16954
+ /**
16955
+ * Toolbar customizable UI properties
16956
+ *
16957
+ * @alpha
16958
+ */
16959
+ export declare interface IThemeToolbar {
16960
+ /**
16961
+ * Radius of the toolbar container border in px. Controls inside the toolbar keep their own radius.
16962
+ */
16963
+ borderRadius?: string;
16964
+ }
16965
+
16935
16966
  /**
16936
16967
  * Tooltip customizable UI properties
16937
16968
  *
@@ -18782,16 +18813,16 @@ export declare function newAbsoluteDashboardDateFilter(from: DateString, to: Dat
18782
18813
  export declare function newAbsoluteDateFilter(dateDataSet: ObjRef | Identifier, from: string, to: string, localIdentifier?: string, emptyValueHandling?: EmptyValues): IAbsoluteDateFilter;
18783
18814
 
18784
18815
  /**
18785
- * Creates an ad-hoc report definition not based on any template.
18816
+ * Creates an ad-hoc document definition not based on any template.
18786
18817
  *
18787
18818
  * @alpha
18788
18819
  */
18789
- export declare function newAdHocReportDefinition(options: {
18820
+ export declare function newAdHocPublisherDocumentDefinition(options: {
18790
18821
  title: string;
18791
- periodStart: ReportDateString;
18792
- periodEnd: ReportDateString;
18793
- pages?: IReportContentPage[];
18794
- }, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
18822
+ periodStart: PublisherDateString;
18823
+ periodEnd: PublisherDateString;
18824
+ pages?: IPublisherDocumentPage[];
18825
+ }, modifications?: Partial<Omit<IPublisherDocumentDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinition;
18795
18826
 
18796
18827
  /**
18797
18828
  * Creates a new all time date filter. This filter is used to indicate that there should be no filtering on the dates.
@@ -19131,6 +19162,54 @@ export declare function newPositiveAttributeFilter(attributeOrRef: IAttribute |
19131
19162
  */
19132
19163
  export declare function newPreviousPeriodMeasure(measureIdOrLocalId: MeasureOrLocalId, dateDataSets: IPreviousPeriodDateDataSetSimple[], modifications?: MeasureModifications<PreviousPeriodMeasureBuilder>): IMeasure<IPreviousPeriodMeasureDefinition>;
19133
19164
 
19165
+ /**
19166
+ * Creates document content from page instances.
19167
+ *
19168
+ * @alpha
19169
+ */
19170
+ export declare function newPublisherDocumentContent(pages: IPublisherDocumentPage[], modifications?: Partial<Omit<IPublisherDocumentContent, "version" | "pages">>): IPublisherDocumentContent;
19171
+
19172
+ /**
19173
+ * Creates a document definition from a template.
19174
+ *
19175
+ * @remarks
19176
+ * The template content is deep-copied; no reference to the template is kept, so the
19177
+ * document stays frozen while the template evolves.
19178
+ *
19179
+ * @alpha
19180
+ */
19181
+ export declare function newPublisherDocumentDefinitionFromTemplate(template: IPublisherDocumentTemplate | IPublisherDocumentTemplateDefinition, options: {
19182
+ title: string;
19183
+ periodStart: PublisherDateString;
19184
+ periodEnd: PublisherDateString;
19185
+ }, modifications?: Partial<Omit<IPublisherDocumentDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinition;
19186
+
19187
+ /**
19188
+ * Clones a page layout into a page instance embeddable in template/document content.
19189
+ *
19190
+ * @remarks
19191
+ * The body is deep-copied and detached from the source page — no reference is kept.
19192
+ * Slot localIdentifiers (and the layout slotIds pointing at them) are prefixed with the
19193
+ * page-instance localIdentifier, so one page used repeatedly in the same content stays unique.
19194
+ *
19195
+ * @alpha
19196
+ */
19197
+ export declare function newPublisherDocumentPageFromLayout(page: IPublisherPageLayout | IPublisherPageLayoutDefinition, localIdentifier?: string): IPublisherDocumentPage;
19198
+
19199
+ /**
19200
+ * Creates a new document template definition.
19201
+ *
19202
+ * @alpha
19203
+ */
19204
+ export declare function newPublisherDocumentTemplateDefinition(title: string, content: IPublisherDocumentContent, modifications?: Partial<Omit<IPublisherDocumentTemplateDefinition, "type" | "title" | "content">>): IPublisherDocumentTemplateDefinition;
19205
+
19206
+ /**
19207
+ * Creates a new page layout definition.
19208
+ *
19209
+ * @alpha
19210
+ */
19211
+ export declare function newPublisherPageLayoutDefinition(title: string, body: IPublisherPageBody, modifications?: Partial<Omit<IPublisherPageLayoutDefinition, "type" | "title" | "content">>): IPublisherPageLayoutDefinition;
19212
+
19134
19213
  /**
19135
19214
  * Creates a new ranking filter.
19136
19215
  *
@@ -19183,54 +19262,6 @@ export declare function newRelativeDashboardDateFilter(granularity: DateFilterGr
19183
19262
  */
19184
19263
  export declare function newRelativeDateFilter(dateDataSet: ObjRef | Identifier, granularity: DateAttributeGranularity, from: number, to: number, localIdentifier?: string, boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter, emptyValueHandling?: EmptyValues): IRelativeDateFilter;
19185
19264
 
19186
- /**
19187
- * Creates report content from page instances.
19188
- *
19189
- * @alpha
19190
- */
19191
- export declare function newReportContent(pages: IReportContentPage[], modifications?: Partial<Omit<IReportContent, "version" | "pages">>): IReportContent;
19192
-
19193
- /**
19194
- * Clones a report page into a page instance embeddable in template/report content.
19195
- *
19196
- * @remarks
19197
- * The body is deep-copied and detached from the source page — no reference is kept.
19198
- * Slot localIdentifiers (and the layout slotIds pointing at them) are prefixed with the
19199
- * page-instance localIdentifier, so one page used repeatedly in the same content stays unique.
19200
- *
19201
- * @alpha
19202
- */
19203
- export declare function newReportContentPageFromLayout(page: IReportPageLayout | IReportPageLayoutDefinition, localIdentifier?: string): IReportContentPage;
19204
-
19205
- /**
19206
- * Creates a report definition from a template.
19207
- *
19208
- * @remarks
19209
- * The template content is deep-copied; no reference to the template is kept, so the
19210
- * report stays frozen while the template evolves.
19211
- *
19212
- * @alpha
19213
- */
19214
- export declare function newReportDefinitionFromTemplate(template: IReportTemplate | IReportTemplateDefinition, options: {
19215
- title: string;
19216
- periodStart: ReportDateString;
19217
- periodEnd: ReportDateString;
19218
- }, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
19219
-
19220
- /**
19221
- * Creates a new report page definition.
19222
- *
19223
- * @alpha
19224
- */
19225
- export declare function newReportPageLayoutDefinition(title: string, body: IReportPageBody, modifications?: Partial<Omit<IReportPageLayoutDefinition, "type" | "title" | "content">>): IReportPageLayoutDefinition;
19226
-
19227
- /**
19228
- * Creates a new report template definition.
19229
- *
19230
- * @alpha
19231
- */
19232
- export declare function newReportTemplateDefinition(title: string, content: IReportContent, modifications?: Partial<Omit<IReportTemplateDefinition, "type" | "title" | "content">>): IReportTemplateDefinition;
19233
-
19234
19265
  /**
19235
19266
  * Creates a new total.
19236
19267
  *
@@ -19598,93 +19629,51 @@ export declare type PreviousPeriodMeasureBuilderInput = {
19598
19629
  dateDataSets: IPreviousPeriodDateDataSetSimple[];
19599
19630
  } | IMeasure<IPreviousPeriodMeasureDefinition>;
19600
19631
 
19601
- /**
19602
- * @public
19603
- */
19604
- export declare type RangeConditionOperator = "BETWEEN" | "NOT_BETWEEN";
19605
-
19606
- /**
19607
- * @public
19608
- */
19609
- export declare type RankingFilterOperator = "TOP" | "BOTTOM";
19610
-
19611
- /**
19612
- * Relative granularity offset
19613
- * (e.g. "GDC.time.year" granularity with offset -2 means "the previous 2 years")
19614
- * @alpha
19615
- */
19616
- export declare type RelativeDateFilterGranularityOffset = number;
19617
-
19618
- /**
19619
- * Gets effective values of a relative date filter.
19620
- *
19621
- * @param filter - date filter to work with
19622
- * @param includeDataSet - whether to include data set in the returned values
19623
- * @returns filter values
19624
- * @public
19625
- */
19626
- export declare function relativeDateFilterValues(filter: IRelativeDateFilter, includeDataSet?: boolean): IRelativeDateFilterValues;
19627
-
19628
- /**
19629
- * Remote pluggable application registry item.
19630
- * Loaded via Module Federation.
19631
- *
19632
- * @alpha
19633
- */
19634
- export declare type RemotePluggableApplicationRegistryItem = IRemotePluggableApplicationRegistryItemV1;
19635
-
19636
- /**
19637
- * Pluggable application remote registry
19638
- *
19639
- * @alpha
19640
- */
19641
- export declare type RemotePluggableApplicationsRegistry = IRemotePluggableApplicationsRegistryV1;
19642
-
19643
19632
  /**
19644
19633
  * What a section or page paints behind its content.
19645
19634
  *
19646
19635
  * @alpha
19647
19636
  */
19648
- export declare type ReportBackground = IReportColorBackground | IReportImageBackground;
19637
+ export declare type PublisherBackground = IPublisherColorBackground | IPublisherImageBackground;
19649
19638
 
19650
19639
  /**
19651
19640
  * Variables resolved by the rendering runtime; they are never declared or stored.
19652
19641
  *
19653
19642
  * @remarks
19654
- * Referenced from report text as `{name}`. Custom variable names must not collide with these;
19643
+ * Referenced from document text as `{name}`. Custom variable names must not collide with these;
19655
19644
  * on collision the built-in wins.
19656
19645
  *
19657
19646
  * @alpha
19658
19647
  */
19659
- export declare type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
19648
+ export declare type PublisherBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
19660
19649
 
19661
19650
  /**
19662
- * All built-in report variable names.
19651
+ * All built-in document variable names.
19663
19652
  *
19664
19653
  * @alpha
19665
19654
  */
19666
- export declare const ReportBuiltInVariables: ReportBuiltInVariable[];
19655
+ export declare const PublisherBuiltInVariables: PublisherBuiltInVariable[];
19667
19656
 
19668
19657
  /**
19669
19658
  * Where content sits inside the box that carries it, along one axis.
19670
19659
  *
19671
19660
  * @alpha
19672
19661
  */
19673
- export declare type ReportContentAlignment = "start" | "center" | "end";
19662
+ export declare type PublisherContentAlignment = "start" | "center" | "end";
19674
19663
 
19675
19664
  /**
19676
- * Convenience accessor for a report or template page by its localIdentifier.
19665
+ * ISO 8601 calendar date (YYYY-MM-DD).
19677
19666
  *
19678
19667
  * @alpha
19679
19668
  */
19680
- export declare function reportContentPage(reportOrTemplate: IReport | IReportDefinition | IReportTemplate | IReportTemplateDefinition, pageLocalIdentifier: string): IReportContentPage | undefined;
19669
+ export declare type PublisherDateString = string;
19681
19670
 
19682
19671
  /**
19683
- * ISO 8601 calendar date (YYYY-MM-DD).
19672
+ * Convenience accessor for a document or template page by its localIdentifier.
19684
19673
  *
19685
19674
  * @alpha
19686
19675
  */
19687
- export declare type ReportDateString = string;
19676
+ export declare function publisherDocumentPage(documentOrTemplate: IPublisherDocument | IPublisherDocumentDefinition | IPublisherDocumentTemplate | IPublisherDocumentTemplateDefinition, pageLocalIdentifier: string): IPublisherDocumentPage | undefined;
19688
19677
 
19689
19678
  /**
19690
19679
  * Size a heading is rendered at. Each size is styled by the matching theme text level
@@ -19692,14 +19681,14 @@ export declare type ReportDateString = string;
19692
19681
  *
19693
19682
  * @alpha
19694
19683
  */
19695
- export declare type ReportHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
19684
+ export declare type PublisherHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
19696
19685
 
19697
19686
  /**
19698
19687
  * All heading sizes, largest first.
19699
19688
  *
19700
19689
  * @alpha
19701
19690
  */
19702
- export declare const ReportHeadingTypes: ReportHeadingType[];
19691
+ export declare const PublisherHeadingTypes: PublisherHeadingType[];
19703
19692
 
19704
19693
  /**
19705
19694
  * How an image is fitted to the area it is drawn in: kept whole inside it, filling it and cropped to
@@ -19707,14 +19696,14 @@ export declare const ReportHeadingTypes: ReportHeadingType[];
19707
19696
  *
19708
19697
  * @alpha
19709
19698
  */
19710
- export declare type ReportImageFit = "contain" | "cover" | "fill";
19699
+ export declare type PublisherImageFit = "contain" | "cover" | "fill";
19711
19700
 
19712
19701
  /**
19713
19702
  * What an image slot displays.
19714
19703
  *
19715
19704
  * @alpha
19716
19705
  */
19717
- export declare type ReportImageSource = {
19706
+ export declare type PublisherImageSource = {
19718
19707
  type: "url";
19719
19708
  /**
19720
19709
  * Image URL. Supports `{variables}` — a logo slot uses `{logo}`.
@@ -19729,40 +19718,40 @@ export declare type ReportImageSource = {
19729
19718
  };
19730
19719
 
19731
19720
  /**
19732
- * Page shape a report page layout is designed for.
19721
+ * Page shape a page layout is designed for.
19733
19722
  *
19734
19723
  * @remarks
19735
19724
  * A layout's geometry only reads correctly at the proportions it was authored for: a row of three
19736
- * visualizations that works on a widescreen slide is unusably narrow on an upright page. The format
19725
+ * visualizations that works on a widescreen page is unusably narrow on an upright page. The format
19737
19726
  * is therefore a property of the page, not a choice made when rendering it.
19738
19727
  *
19739
19728
  * @alpha
19740
19729
  */
19741
- export declare type ReportPageFormat = "widescreen" | "a4Portrait" | "letterPortrait";
19730
+ export declare type PublisherPageFormat = "widescreen" | "a4Portrait" | "letterPortrait";
19742
19731
 
19743
19732
  /**
19744
- * Width divided by height for each page format: 16:9 for a slide, ISO A4 (210 x 297 mm) and
19733
+ * Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and
19745
19734
  * US Letter (8.5 x 11 in) upright.
19746
19735
  *
19747
19736
  * @alpha
19748
19737
  */
19749
- export declare const ReportPageFormatAspectRatios: Record<ReportPageFormat, number>;
19738
+ export declare const PublisherPageFormatAspectRatios: Record<PublisherPageFormat, number>;
19750
19739
 
19751
19740
  /**
19752
- * List of built-in report page format names.
19741
+ * List of built-in page format names.
19753
19742
  *
19754
19743
  * @alpha
19755
19744
  */
19756
- export declare const ReportPageFormats: ReportPageFormat[];
19745
+ export declare const PublisherPageFormats: PublisherPageFormat[];
19757
19746
 
19758
19747
  /**
19759
- * Node of a report page layout: a recursive row/column split tree (flexbox semantics)
19748
+ * Node of a page layout: a recursive row/column split tree (flexbox semantics)
19760
19749
  * over a fixed page. Leaves assign their area to slots; the tree carries geometry and
19761
- * box paint, slot content lives in {@link IReportPageBody.slots}.
19750
+ * box paint, slot content lives in {@link IPublisherPageBody.slots}.
19762
19751
  *
19763
19752
  * @alpha
19764
19753
  */
19765
- export declare type ReportPageLayoutNode = IReportLayoutSection | IReportLayoutSlotRef;
19754
+ export declare type PublisherPageLayoutNode = IPublisherLayoutSection | IPublisherLayoutSlotRef;
19766
19755
 
19767
19756
  /**
19768
19757
  * Size a paragraph is rendered at. Each size is styled by the matching theme text level
@@ -19770,28 +19759,28 @@ export declare type ReportPageLayoutNode = IReportLayoutSection | IReportLayoutS
19770
19759
  *
19771
19760
  * @alpha
19772
19761
  */
19773
- export declare type ReportParagraphType = "largeText" | "normalText" | "smallText";
19762
+ export declare type PublisherParagraphType = "largeText" | "normalText" | "smallText";
19774
19763
 
19775
19764
  /**
19776
19765
  * All paragraph sizes, largest first.
19777
19766
  *
19778
19767
  * @alpha
19779
19768
  */
19780
- export declare const ReportParagraphTypes: ReportParagraphType[];
19769
+ export declare const PublisherParagraphTypes: PublisherParagraphType[];
19781
19770
 
19782
19771
  /**
19783
- * All slot types of report content version 1.
19772
+ * All slot types of document content version 1.
19784
19773
  *
19785
19774
  * @alpha
19786
19775
  */
19787
- export declare type ReportSlot = IReportVisualizationSlot | IReportTextSlot | IReportImageSlot;
19776
+ export declare type PublisherSlot = IPublisherVisualizationSlot | IPublisherTextSlot | IPublisherImageSlot;
19788
19777
 
19789
19778
  /**
19790
- * The marker referencing the named variable from report text.
19779
+ * The marker referencing the named variable from document text.
19791
19780
  *
19792
19781
  * @alpha
19793
19782
  */
19794
- export declare function reportTextPlaceholder(name: string): string;
19783
+ export declare function publisherTextPlaceholder(name: string): string;
19795
19784
 
19796
19785
  /**
19797
19786
  * Size the slot is rendered at.
@@ -19802,35 +19791,77 @@ export declare function reportTextPlaceholder(name: string): string;
19802
19791
  *
19803
19792
  * @alpha
19804
19793
  */
19805
- export declare function reportTextSlotType(slot: IReportTextSlot): ReportTextType;
19794
+ export declare function publisherTextSlotType(slot: IPublisherTextSlot): PublisherTextType;
19806
19795
 
19807
19796
  /**
19808
19797
  * Sizes the slot can be rendered at, which is what its own type decides.
19809
19798
  *
19810
19799
  * @alpha
19811
19800
  */
19812
- export declare function reportTextSlotTypes(slot: IReportTextSlot): ReportTextType[];
19801
+ export declare function publisherTextSlotTypes(slot: IPublisherTextSlot): PublisherTextType[];
19813
19802
 
19814
19803
  /**
19815
19804
  * Where the text of a text slot comes from.
19816
19805
  *
19817
19806
  * @alpha
19818
19807
  */
19819
- export declare type ReportTextSource = IReportStaticTextSource | IReportAiTextSource;
19808
+ export declare type PublisherTextSource = IPublisherStaticTextSource | IPublisherAiTextSource;
19820
19809
 
19821
19810
  /**
19822
- * Size any report text is rendered at.
19811
+ * Size any document text is rendered at.
19823
19812
  *
19824
19813
  * @alpha
19825
19814
  */
19826
- export declare type ReportTextType = ReportHeadingType | ReportParagraphType;
19815
+ export declare type PublisherTextType = PublisherHeadingType | PublisherParagraphType;
19827
19816
 
19828
19817
  /**
19829
19818
  * All sizes a text slot can be rendered at, headings first.
19830
19819
  *
19831
19820
  * @alpha
19832
19821
  */
19833
- export declare const ReportTextTypes: ReportTextType[];
19822
+ export declare const PublisherTextTypes: PublisherTextType[];
19823
+
19824
+ /**
19825
+ * @public
19826
+ */
19827
+ export declare type RangeConditionOperator = "BETWEEN" | "NOT_BETWEEN";
19828
+
19829
+ /**
19830
+ * @public
19831
+ */
19832
+ export declare type RankingFilterOperator = "TOP" | "BOTTOM";
19833
+
19834
+ /**
19835
+ * Relative granularity offset
19836
+ * (e.g. "GDC.time.year" granularity with offset -2 means "the previous 2 years")
19837
+ * @alpha
19838
+ */
19839
+ export declare type RelativeDateFilterGranularityOffset = number;
19840
+
19841
+ /**
19842
+ * Gets effective values of a relative date filter.
19843
+ *
19844
+ * @param filter - date filter to work with
19845
+ * @param includeDataSet - whether to include data set in the returned values
19846
+ * @returns filter values
19847
+ * @public
19848
+ */
19849
+ export declare function relativeDateFilterValues(filter: IRelativeDateFilter, includeDataSet?: boolean): IRelativeDateFilterValues;
19850
+
19851
+ /**
19852
+ * Remote pluggable application registry item.
19853
+ * Loaded via Module Federation.
19854
+ *
19855
+ * @alpha
19856
+ */
19857
+ export declare type RemotePluggableApplicationRegistryItem = IRemotePluggableApplicationRegistryItemV1;
19858
+
19859
+ /**
19860
+ * Pluggable application remote registry
19861
+ *
19862
+ * @alpha
19863
+ */
19864
+ export declare type RemotePluggableApplicationsRegistry = IRemotePluggableApplicationsRegistryV1;
19834
19865
 
19835
19866
  /**
19836
19867
  * Entitlements and their values that must be set for the pluggable application to be accessible for
@@ -19872,11 +19903,11 @@ export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableA
19872
19903
  *
19873
19904
  * @remarks
19874
19905
  * A marker resolves wherever it appears, braces around it included, so there is no escape for a
19875
- * literal `{name}` in report text.
19906
+ * literal `{name}` in document text.
19876
19907
  *
19877
19908
  * @alpha
19878
19909
  */
19879
- export declare function resolveReportTextPlaceholders(text: string, values: Record<string, string>): string;
19910
+ export declare function resolvePublisherTextPlaceholders(text: string, values: Record<string, string>): string;
19880
19911
 
19881
19912
  /**
19882
19913
  * Resolves a dashboard timezone value to a concrete IANA timezone ID: the {@link BROWSER_DETECTED}
@@ -20132,10 +20163,10 @@ export declare type ThemeDashboardDensity = "comfortable" | "compact";
20132
20163
  export declare type ThemeFontUri = string;
20133
20164
 
20134
20165
  /**
20135
- * Length used in rendered reports.
20166
+ * Length used in rendered documents.
20136
20167
  *
20137
20168
  * @remarks
20138
- * A report page scales with its width, so lengths are stated in `cqw` (1cqw = 1% of the page
20169
+ * A document page scales with its width, so lengths are stated in `cqw` (1cqw = 1% of the page
20139
20170
  * width). A bare number means cqw: `3.5` and `"3.5cqw"` are the same length. `cqi`, `em` and `%`
20140
20171
  * are accepted as well. Anything that does not follow the page width is ignored: `px` and `rem`
20141
20172
  * hold their size, and `cqh` and `cqb` resolve against the viewport, because a page contains its
@@ -20146,7 +20177,7 @@ export declare type ThemeFontUri = string;
20146
20177
  *
20147
20178
  * @alpha
20148
20179
  */
20149
- export declare type ThemeReportsLength = string | number;
20180
+ export declare type ThemePublisherLength = string | number;
20150
20181
 
20151
20182
  /**
20152
20183
  * Throwing exhaustiveness check for discriminated unions: the `never` parameter fails the build on an
@@ -20277,7 +20308,7 @@ export declare function userFullName(user: IUser): string | undefined;
20277
20308
  *
20278
20309
  * @alpha
20279
20310
  */
20280
- export declare function validateReportPageBody(body: IReportPageBody): IReportPageBodyValidationIssue[];
20311
+ export declare function validatePublisherPageBody(body: IPublisherPageBody): IPublisherPageBodyValidationIssue[];
20281
20312
 
20282
20313
  /**
20283
20314
  * Builder for virtual arithmetic measures.