@gooddata/sdk-model 11.62.0-alpha.3 → 11.62.0-alpha.4

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 (89) hide show
  1. package/esm/genAI/chat.d.ts +3 -2
  2. package/esm/genAI/chat.d.ts.map +1 -1
  3. package/esm/index.d.ts +21 -10
  4. package/esm/index.d.ts.map +1 -1
  5. package/esm/index.js +20 -10
  6. package/esm/publisher/aliases.d.ts +580 -0
  7. package/esm/publisher/aliases.d.ts.map +1 -0
  8. package/esm/publisher/aliases.js +304 -0
  9. package/esm/publisher/v1/builtinPageLayouts.d.ts +45 -0
  10. package/esm/publisher/v1/builtinPageLayouts.d.ts.map +1 -0
  11. package/esm/publisher/{builtinPageLayouts.js → v1/builtinPageLayouts.js} +14 -14
  12. package/esm/publisher/{content.d.ts → v1/content.d.ts} +14 -14
  13. package/esm/publisher/v1/content.d.ts.map +1 -0
  14. package/esm/publisher/{content.js → v1/content.js} +1 -1
  15. package/esm/publisher/{document.d.ts → v1/document.d.ts} +21 -21
  16. package/esm/publisher/v1/document.d.ts.map +1 -0
  17. package/esm/publisher/v1/document.js +35 -0
  18. package/esm/publisher/v1/factory.d.ts +65 -0
  19. package/esm/publisher/v1/factory.d.ts.map +1 -0
  20. package/esm/publisher/{factory.js → v1/factory.js} +12 -12
  21. package/esm/publisher/{layout.d.ts → v1/layout.d.ts} +13 -13
  22. package/esm/publisher/v1/layout.d.ts.map +1 -0
  23. package/esm/publisher/{layout.js → v1/layout.js} +4 -4
  24. package/esm/publisher/{pageFormat.d.ts → v1/pageFormat.d.ts} +6 -6
  25. package/esm/publisher/v1/pageFormat.d.ts.map +1 -0
  26. package/esm/publisher/{pageFormat.js → v1/pageFormat.js} +6 -6
  27. package/esm/publisher/{pageLayout.d.ts → v1/pageLayout.d.ts} +27 -27
  28. package/esm/publisher/v1/pageLayout.d.ts.map +1 -0
  29. package/esm/publisher/{pageLayout.js → v1/pageLayout.js} +18 -18
  30. package/esm/publisher/{slot.d.ts → v1/slot.d.ts} +41 -41
  31. package/esm/publisher/v1/slot.d.ts.map +1 -0
  32. package/esm/publisher/v1/slot.js +90 -0
  33. package/esm/publisher/{styling.d.ts → v1/styling.d.ts} +36 -36
  34. package/esm/publisher/v1/styling.d.ts.map +1 -0
  35. package/esm/publisher/{styling.js → v1/styling.js} +14 -14
  36. package/esm/publisher/{variables.d.ts → v1/variables.d.ts} +10 -10
  37. package/esm/publisher/v1/variables.d.ts.map +1 -0
  38. package/esm/publisher/{variables.js → v1/variables.js} +4 -4
  39. package/esm/publisher/v2/checks.d.ts +58 -0
  40. package/esm/publisher/v2/checks.d.ts.map +1 -0
  41. package/esm/publisher/v2/checks.js +100 -0
  42. package/esm/publisher/v2/content.d.ts +154 -0
  43. package/esm/publisher/v2/content.d.ts.map +1 -0
  44. package/esm/publisher/v2/content.js +34 -0
  45. package/esm/publisher/v2/document.d.ts +116 -0
  46. package/esm/publisher/v2/document.d.ts.map +1 -0
  47. package/esm/publisher/v2/document.js +47 -0
  48. package/esm/publisher/v2/factory.d.ts +69 -0
  49. package/esm/publisher/v2/factory.d.ts.map +1 -0
  50. package/esm/publisher/v2/factory.js +80 -0
  51. package/esm/publisher/v2/layout.d.ts +48 -0
  52. package/esm/publisher/v2/layout.d.ts.map +1 -0
  53. package/esm/publisher/v2/layout.js +20 -0
  54. package/esm/publisher/v2/page.d.ts +67 -0
  55. package/esm/publisher/v2/page.d.ts.map +1 -0
  56. package/esm/publisher/v2/page.js +34 -0
  57. package/esm/publisher/v2/sections.d.ts +34 -0
  58. package/esm/publisher/v2/sections.d.ts.map +1 -0
  59. package/esm/publisher/v2/sections.js +40 -0
  60. package/esm/publisher/v2/structure.d.ts +5 -0
  61. package/esm/publisher/v2/structure.d.ts.map +1 -0
  62. package/esm/publisher/v2/structure.js +533 -0
  63. package/esm/publisher/v2/style.d.ts +323 -0
  64. package/esm/publisher/v2/style.d.ts.map +1 -0
  65. package/esm/publisher/v2/style.js +22 -0
  66. package/esm/publisher/v2/validation.d.ts +26 -0
  67. package/esm/publisher/v2/validation.d.ts.map +1 -0
  68. package/esm/publisher/v2/validation.js +157 -0
  69. package/esm/publisher/v2/widget.d.ts +295 -0
  70. package/esm/publisher/v2/widget.d.ts.map +1 -0
  71. package/esm/publisher/v2/widget.js +79 -0
  72. package/esm/sdk-model.d.ts +2364 -462
  73. package/esm/settings/settings.d.ts +11 -1
  74. package/esm/settings/settings.d.ts.map +1 -1
  75. package/package.json +3 -3
  76. package/esm/publisher/builtinPageLayouts.d.ts +0 -45
  77. package/esm/publisher/builtinPageLayouts.d.ts.map +0 -1
  78. package/esm/publisher/content.d.ts.map +0 -1
  79. package/esm/publisher/document.d.ts.map +0 -1
  80. package/esm/publisher/document.js +0 -35
  81. package/esm/publisher/factory.d.ts +0 -65
  82. package/esm/publisher/factory.d.ts.map +0 -1
  83. package/esm/publisher/layout.d.ts.map +0 -1
  84. package/esm/publisher/pageFormat.d.ts.map +0 -1
  85. package/esm/publisher/pageLayout.d.ts.map +0 -1
  86. package/esm/publisher/slot.d.ts.map +0 -1
  87. package/esm/publisher/slot.js +0 -87
  88. package/esm/publisher/styling.d.ts.map +0 -1
  89. package/esm/publisher/variables.d.ts.map +0 -1
@@ -970,33 +970,82 @@ export declare function bucketsTotals(buckets: IBucket[]): ITotal[];
970
970
  */
971
971
  export declare function bucketTotals(bucket: IBucket): ITotal[];
972
972
 
973
+ /**
974
+ * Current version of {@link BuiltInPublisherPageLayoutCoverV1}.
975
+ *
976
+ * @alpha
977
+ */
978
+ export declare const BuiltInPublisherPageLayoutCover: IPublisherPageLayoutV1;
979
+
973
980
  /**
974
981
  * Built-in cover page: document title and subtitle.
975
982
  *
976
983
  * @alpha
977
984
  */
978
- export declare const BuiltInPublisherPageLayoutCover: IPublisherPageLayout;
985
+ export declare const BuiltInPublisherPageLayoutCoverV1: IPublisherPageLayoutV1;
986
+
987
+ /**
988
+ * Current version of {@link BuiltInPublisherPageLayoutPortraitCoverV1}.
989
+ *
990
+ * @alpha
991
+ */
992
+ export declare const BuiltInPublisherPageLayoutPortraitCover: IPublisherPageLayoutV1;
979
993
 
980
994
  /**
981
995
  * Built-in portrait cover page: document title and subtitle.
982
996
  *
983
997
  * @alpha
984
998
  */
985
- export declare const BuiltInPublisherPageLayoutPortraitCover: IPublisherPageLayout;
999
+ export declare const BuiltInPublisherPageLayoutPortraitCoverV1: IPublisherPageLayoutV1;
1000
+
1001
+ /**
1002
+ * Current version of {@link BuiltInPublisherPageLayoutPortraitSectionV1}.
1003
+ *
1004
+ * @alpha
1005
+ */
1006
+ export declare const BuiltInPublisherPageLayoutPortraitSection: IPublisherPageLayoutV1;
986
1007
 
987
1008
  /**
988
1009
  * Built-in portrait section divider page.
989
1010
  *
990
1011
  * @alpha
991
1012
  */
992
- export declare const BuiltInPublisherPageLayoutPortraitSection: IPublisherPageLayout;
1013
+ export declare const BuiltInPublisherPageLayoutPortraitSectionV1: IPublisherPageLayoutV1;
1014
+
1015
+ /**
1016
+ * Current version of {@link BuiltInPublisherPageLayoutPortraitSummaryV1}.
1017
+ *
1018
+ * @alpha
1019
+ */
1020
+ export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLayoutV1;
993
1021
 
994
1022
  /**
995
1023
  * Built-in portrait page carrying a full-page narrative, with no visualization.
996
1024
  *
997
1025
  * @alpha
998
1026
  */
999
- export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLayout;
1027
+ export declare const BuiltInPublisherPageLayoutPortraitSummaryV1: IPublisherPageLayoutV1;
1028
+
1029
+ /**
1030
+ * Current version of {@link BuiltInPublisherPageLayoutsV1}.
1031
+ *
1032
+ * @alpha
1033
+ */
1034
+ export declare const BuiltInPublisherPageLayouts: readonly IPublisherPageLayoutV1[];
1035
+
1036
+ /**
1037
+ * Current version of {@link BuiltInPublisherPageLayoutSectionV1}.
1038
+ *
1039
+ * @alpha
1040
+ */
1041
+ export declare const BuiltInPublisherPageLayoutSection: IPublisherPageLayoutV1;
1042
+
1043
+ /**
1044
+ * Built-in section divider page.
1045
+ *
1046
+ * @alpha
1047
+ */
1048
+ export declare const BuiltInPublisherPageLayoutSectionV1: IPublisherPageLayoutV1;
1000
1049
 
1001
1050
  /**
1002
1051
  * All built-in page layouts served by the SPI. Built-ins are read-only: they cannot be
@@ -1004,29 +1053,36 @@ export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLa
1004
1053
  *
1005
1054
  * @alpha
1006
1055
  */
1007
- export declare const BuiltInPublisherPageLayouts: readonly IPublisherPageLayout[];
1056
+ export declare const BuiltInPublisherPageLayoutsV1: readonly IPublisherPageLayoutV1[];
1008
1057
 
1009
1058
  /**
1010
- * Built-in section divider page.
1059
+ * Current version of {@link BuiltInPublisherPageLayoutViz6TextLeftV1}.
1011
1060
  *
1012
1061
  * @alpha
1013
1062
  */
1014
- export declare const BuiltInPublisherPageLayoutSection: IPublisherPageLayout;
1063
+ export declare const BuiltInPublisherPageLayoutViz6TextLeft: IPublisherPageLayoutV1;
1015
1064
 
1016
1065
  /**
1017
1066
  * Built-in content page with six visualizations and a text column on the left.
1018
1067
  *
1019
1068
  * @alpha
1020
1069
  */
1021
- export declare const BuiltInPublisherPageLayoutViz6TextLeft: IPublisherPageLayout;
1070
+ export declare const BuiltInPublisherPageLayoutViz6TextLeftV1: IPublisherPageLayoutV1;
1022
1071
 
1023
1072
  /**
1024
- * List of built-in document slot type names.
1073
+ * Current version of {@link BuiltInPublisherSlotTypesV1}.
1025
1074
  *
1026
1075
  * @alpha
1027
1076
  */
1028
1077
  export declare const BuiltInPublisherSlotTypes: string[];
1029
1078
 
1079
+ /**
1080
+ * List of built-in document slot type names.
1081
+ *
1082
+ * @alpha
1083
+ */
1084
+ export declare const BuiltInPublisherSlotTypesV1: string[];
1085
+
1030
1086
  /**
1031
1087
  * List of built-in widget types. These type names are reserved and must not be used by custom widgets.
1032
1088
  *
@@ -1882,12 +1938,26 @@ export declare function defaultDimensionsGenerator(definition: IExecutionDefinit
1882
1938
  */
1883
1939
  export declare const DefaultLocale: ILocale;
1884
1940
 
1941
+ /**
1942
+ * Current version of {@link DefaultPublisherHeadingTypeV1}.
1943
+ *
1944
+ * @alpha
1945
+ */
1946
+ export declare const DefaultPublisherHeadingType: PublisherHeadingTypeV1;
1947
+
1885
1948
  /**
1886
1949
  * Size a heading slot that states none is rendered at.
1887
1950
  *
1888
1951
  * @alpha
1889
1952
  */
1890
- export declare const DefaultPublisherHeadingType: PublisherHeadingType;
1953
+ export declare const DefaultPublisherHeadingTypeV1: PublisherHeadingTypeV1;
1954
+
1955
+ /**
1956
+ * Current version of {@link DefaultPublisherPageFormatV1}.
1957
+ *
1958
+ * @alpha
1959
+ */
1960
+ export declare const DefaultPublisherPageFormat: PublisherPageFormatV1;
1891
1961
 
1892
1962
  /**
1893
1963
  * Format assumed by a page that declares none, which keeps pages authored before formats existed
@@ -1895,14 +1965,26 @@ export declare const DefaultPublisherHeadingType: PublisherHeadingType;
1895
1965
  *
1896
1966
  * @alpha
1897
1967
  */
1898
- export declare const DefaultPublisherPageFormat: PublisherPageFormat;
1968
+ export declare const DefaultPublisherPageFormatV1: PublisherPageFormatV1;
1969
+
1970
+ /**
1971
+ * @alpha
1972
+ */
1973
+ export declare const DefaultPublisherPageSizeV2: PublisherPageSizeV2;
1974
+
1975
+ /**
1976
+ * Current version of {@link DefaultPublisherParagraphTypeV1}.
1977
+ *
1978
+ * @alpha
1979
+ */
1980
+ export declare const DefaultPublisherParagraphType: PublisherParagraphTypeV1;
1899
1981
 
1900
1982
  /**
1901
1983
  * Size a paragraph slot that states none is rendered at.
1902
1984
  *
1903
1985
  * @alpha
1904
1986
  */
1905
- export declare const DefaultPublisherParagraphType: PublisherParagraphType;
1987
+ export declare const DefaultPublisherParagraphTypeV1: PublisherParagraphTypeV1;
1906
1988
 
1907
1989
  /**
1908
1990
  * Calculates fingerprint for the execution definition.
@@ -2920,12 +3002,19 @@ export declare function getPluggableApplicationHref(app: PluggableApplicationReg
2920
3002
  */
2921
3003
  export declare function getPluggableApplicationLocalizedTitle(app: PluggableApplicationRegistryItem, locale: ILocale | undefined): string;
2922
3004
 
3005
+ /**
3006
+ * Current version of {@link getPublisherTextPlaceholdersV1}.
3007
+ *
3008
+ * @alpha
3009
+ */
3010
+ export declare const getPublisherTextPlaceholders: typeof getPublisherTextPlaceholdersV1;
3011
+
2923
3012
  /**
2924
3013
  * Collects the distinct `{variable}` names referenced in the text, in order of first occurrence.
2925
3014
  *
2926
3015
  * @alpha
2927
3016
  */
2928
- export declare function getPublisherTextPlaceholders(text: string): string[];
3017
+ export declare function getPublisherTextPlaceholdersV1(text: string): string[];
2929
3018
 
2930
3019
  /**
2931
3020
  * Returns count of selected elements
@@ -7880,7 +7969,6 @@ export declare interface IFeatureFlags {
7880
7969
  enableOracleDataSource?: boolean;
7881
7970
  enableOidcAuth?: boolean;
7882
7971
  enableMotherDuckDataSource?: boolean;
7883
- enableMongoDbDataSource?: boolean;
7884
7972
  enableStarrocksDataSource?: boolean;
7885
7973
  enableSingleStoreDataSource?: boolean;
7886
7974
  enableDenodoDataSource?: boolean;
@@ -8353,6 +8441,10 @@ export declare interface IFeatureFlags {
8353
8441
  * Enable the templates and page layouts screens of the Business Briefing reports application.
8354
8442
  */
8355
8443
  enableReportsSubsections?: boolean;
8444
+ /**
8445
+ * Enable Publisher v2.
8446
+ */
8447
+ enablePublisherV2?: boolean;
8356
8448
  /**
8357
8449
  * Enable the write and export postMessage commands for embedded dashboards and Analytical Designer.
8358
8450
  *
@@ -8373,6 +8465,13 @@ export declare interface IFeatureFlags {
8373
8465
  * Disabled by default.
8374
8466
  */
8375
8467
  enableLocalizationOverview?: boolean;
8468
+ /**
8469
+ * Enable the new rendering of charts in the AI Assistant.
8470
+ *
8471
+ * @remarks
8472
+ * Disabled by default.
8473
+ */
8474
+ enableAiAssistantChartsV2?: boolean;
8376
8475
  }
8377
8476
 
8378
8477
  /**
@@ -8838,8 +8937,9 @@ export declare interface IGenAIPublisherDocumentContext {
8838
8937
  title?: string;
8839
8938
  /**
8840
8939
  * Document definition as the user sees it, including edits that are not saved yet.
8940
+ * Pinned to the v1 type because the v1 copilot reads it; it does not follow newer Publisher versions.
8841
8941
  */
8842
- definition?: IPublisherDocumentDefinition;
8942
+ definition?: IPublisherDocumentDefinitionV1;
8843
8943
  /**
8844
8944
  * Name of the conversation draft the editor shows, while that draft is not saved yet.
8845
8945
  */
@@ -10938,6 +11038,20 @@ export declare interface INegativeAttributeFilterBody extends IIdentifiableFilte
10938
11038
  notIn: IAttributeElements;
10939
11039
  }
10940
11040
 
11041
+ /**
11042
+ * @alpha
11043
+ */
11044
+ export declare interface INewPublisherDocumentFilterIdOptionsV2 {
11045
+ /**
11046
+ * The label of an attribute filter or the dataset of a date filter, as an identifier ref.
11047
+ */
11048
+ target: ObjRef;
11049
+ /**
11050
+ * Local identifiers of the document's `content.filters`.
11051
+ */
11052
+ usedIds: ReadonlySet<string>;
11053
+ }
11054
+
10941
11055
  /**
10942
11056
  * Builder for inline measures.
10943
11057
  *
@@ -12232,12 +12346,37 @@ export declare interface IProductionFeaturesConfig {
12232
12346
  features?: IProductionFeatureConfig[];
12233
12347
  }
12234
12348
 
12349
+ /**
12350
+ * Both ends are inclusive.
12351
+ *
12352
+ * @alpha
12353
+ */
12354
+ export declare interface IPublisherAbsolutePeriodV2 {
12355
+ type: "absolute";
12356
+ granularity: "GDC.time.date";
12357
+ /**
12358
+ * `YYYY-MM-DD`.
12359
+ */
12360
+ from: string;
12361
+ /**
12362
+ * `YYYY-MM-DD`.
12363
+ */
12364
+ to: string;
12365
+ }
12366
+
12367
+ /**
12368
+ * Current version of {@link IPublisherAiTextSourceV1}.
12369
+ *
12370
+ * @alpha
12371
+ */
12372
+ export declare type IPublisherAiTextSource = IPublisherAiTextSourceV1;
12373
+
12235
12374
  /**
12236
12375
  * Text generated by AI at document-build time.
12237
12376
  *
12238
12377
  * @alpha
12239
12378
  */
12240
- export declare interface IPublisherAiTextSource {
12379
+ export declare interface IPublisherAiTextSourceV1 {
12241
12380
  type: "ai";
12242
12381
  /**
12243
12382
  * Instruction for the generator. Supports `{variables}`.
@@ -12254,13 +12393,99 @@ export declare interface IPublisherAiTextSource {
12254
12393
  generatedAt?: string;
12255
12394
  }
12256
12395
 
12396
+ /**
12397
+ * Current version of {@link IPublisherAttributeFilterConfigV1}.
12398
+ *
12399
+ * @alpha
12400
+ */
12401
+ export declare type IPublisherAttributeFilterConfig = IPublisherAttributeFilterConfigV1;
12402
+
12257
12403
  /**
12258
12404
  * Configuration of a document's content-level attribute filter: the part of a dashboard attribute
12259
12405
  * filter's configuration that documents support.
12260
12406
  *
12261
12407
  * @alpha
12262
12408
  */
12263
- export declare type IPublisherAttributeFilterConfig = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
12409
+ export declare type IPublisherAttributeFilterConfigV1 = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
12410
+
12411
+ /**
12412
+ * @alpha
12413
+ */
12414
+ export declare interface IPublisherAxisDisplayV2 {
12415
+ visible?: boolean;
12416
+ /**
12417
+ * The axis title.
12418
+ */
12419
+ name?: {
12420
+ visible?: boolean;
12421
+ position?: "low" | "middle" | "high";
12422
+ };
12423
+ /**
12424
+ * The tick labels. Rotation is in degrees, -90 to 90.
12425
+ */
12426
+ values?: {
12427
+ visible?: boolean;
12428
+ rotation?: number;
12429
+ };
12430
+ min?: number;
12431
+ max?: number;
12432
+ }
12433
+
12434
+ /**
12435
+ * @alpha
12436
+ */
12437
+ export declare interface IPublisherBackgroundStyleV2 {
12438
+ backgroundColor?: PublisherColorValueV2;
12439
+ /**
12440
+ * Opacity of the background color only.
12441
+ */
12442
+ backgroundOpacity?: PublisherOpacityV2;
12443
+ backgroundImage?: PublisherImageSourceV2;
12444
+ backgroundImageOpacity?: PublisherOpacityV2;
12445
+ /**
12446
+ * Defaults to `cover`.
12447
+ */
12448
+ backgroundFit?: "cover" | "contain" | "fill" | "tile";
12449
+ backgroundHorizontalAlign?: PublisherHorizontalAlignV2;
12450
+ backgroundVerticalAlign?: PublisherVerticalAlignV2;
12451
+ backgroundOffset?: PublisherPxV2;
12452
+ backgroundOffsetTop?: PublisherPxV2;
12453
+ backgroundOffsetRight?: PublisherPxV2;
12454
+ backgroundOffsetBottom?: PublisherPxV2;
12455
+ backgroundOffsetLeft?: PublisherPxV2;
12456
+ }
12457
+
12458
+ /**
12459
+ * @remarks
12460
+ * A side key wins over the matching all-sides key in any order. `borderStyle` defaults to `solid`,
12461
+ * so a width alone draws a line.
12462
+ *
12463
+ * @alpha
12464
+ */
12465
+ export declare interface IPublisherBorderStyleV2 {
12466
+ borderWidth?: PublisherPxV2;
12467
+ borderStyle?: PublisherBorderLineStyleV2;
12468
+ borderColor?: PublisherColorValueV2;
12469
+ borderTopWidth?: PublisherPxV2;
12470
+ borderTopStyle?: PublisherBorderLineStyleV2;
12471
+ borderTopColor?: PublisherColorValueV2;
12472
+ borderRightWidth?: PublisherPxV2;
12473
+ borderRightStyle?: PublisherBorderLineStyleV2;
12474
+ borderRightColor?: PublisherColorValueV2;
12475
+ borderBottomWidth?: PublisherPxV2;
12476
+ borderBottomStyle?: PublisherBorderLineStyleV2;
12477
+ borderBottomColor?: PublisherColorValueV2;
12478
+ borderLeftWidth?: PublisherPxV2;
12479
+ borderLeftStyle?: PublisherBorderLineStyleV2;
12480
+ borderLeftColor?: PublisherColorValueV2;
12481
+ }
12482
+
12483
+ /**
12484
+ * Current version of {@link IPublisherBoxStyleV1}.
12485
+ *
12486
+ * @alpha
12487
+ */
12488
+ export declare type IPublisherBoxStyle = IPublisherBoxStyleV1;
12264
12489
 
12265
12490
  /**
12266
12491
  * Paint of the box itself. Never affects the geometry of the box or its children —
@@ -12268,8 +12493,8 @@ export declare type IPublisherAttributeFilterConfig = Pick<IDashboardAttributeFi
12268
12493
  *
12269
12494
  * @alpha
12270
12495
  */
12271
- export declare interface IPublisherBoxStyle {
12272
- background?: PublisherBackground;
12496
+ export declare interface IPublisherBoxStyleV1 {
12497
+ background?: PublisherBackgroundV1;
12273
12498
  /**
12274
12499
  * Corner radius in percent of the page width — the same relative unit the rest of a document page
12275
12500
  * is sized in, so the corners keep their proportion however large the page is rendered.
@@ -12278,19 +12503,63 @@ export declare interface IPublisherBoxStyle {
12278
12503
  borderRadius?: number;
12279
12504
  /**
12280
12505
  * Inset of the box's own content, in percent of the page width like
12281
- * {@link IPublisherBoxStyle.borderRadius}. Insets only inward — siblings and the layout
12506
+ * {@link IPublisherBoxStyleV1.borderRadius}. Insets only inward — siblings and the layout
12282
12507
  * gaps around the box are untouched. A box that paints a background usually wants one;
12283
12508
  * a full-bleed box (an image-backed cover) wants none, which is why no default exists.
12284
12509
  */
12285
12510
  padding?: number;
12286
12511
  }
12287
12512
 
12513
+ /**
12514
+ * Box keys. They apply to the node they are set on and never inherit.
12515
+ *
12516
+ * @alpha
12517
+ */
12518
+ export declare interface IPublisherBoxStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherBorderStyleV2, IPublisherCornerStyleV2, IPublisherShadowStyleV2 {
12519
+ /**
12520
+ * Opacity of the whole node, content included.
12521
+ */
12522
+ opacity?: PublisherOpacityV2;
12523
+ }
12524
+
12525
+ /**
12526
+ * @alpha
12527
+ */
12528
+ export declare interface IPublisherChartStyleV2 {
12529
+ fontSize?: PublisherPxV2;
12530
+ textColor?: PublisherColorValueV2;
12531
+ axisLineColor?: PublisherColorValueV2;
12532
+ /**
12533
+ * Color of the axis title.
12534
+ */
12535
+ axisNameColor?: PublisherColorValueV2;
12536
+ axisNameSize?: PublisherPxV2;
12537
+ /**
12538
+ * Color of the tick labels.
12539
+ */
12540
+ axisValueColor?: PublisherColorValueV2;
12541
+ axisValueSize?: PublisherPxV2;
12542
+ gridColor?: PublisherColorValueV2;
12543
+ plotLineColor?: PublisherColorValueV2;
12544
+ legendColor?: PublisherColorValueV2;
12545
+ legendSize?: PublisherPxV2;
12546
+ dataLabelColor?: PublisherColorValueV2;
12547
+ dataLabelSize?: PublisherPxV2;
12548
+ }
12549
+
12550
+ /**
12551
+ * Current version of {@link IPublisherColorBackgroundV1}.
12552
+ *
12553
+ * @alpha
12554
+ */
12555
+ export declare type IPublisherColorBackground = IPublisherColorBackgroundV1;
12556
+
12288
12557
  /**
12289
12558
  * Solid color painted behind a section's or page's content.
12290
12559
  *
12291
12560
  * @alpha
12292
12561
  */
12293
- export declare interface IPublisherColorBackground {
12562
+ export declare interface IPublisherColorBackgroundV1 {
12294
12563
  type: "color";
12295
12564
  /**
12296
12565
  * CSS color value. Absolute: document styling states brand colors directly and does not
@@ -12300,25 +12569,80 @@ export declare interface IPublisherColorBackground {
12300
12569
  }
12301
12570
 
12302
12571
  /**
12303
- * Document metadata object.
12572
+ * @alpha
12573
+ */
12574
+ export declare interface IPublisherContainerStyleV2 extends IPublisherBoxStyleV2, IPublisherInheritedTextStyleV2 {
12575
+ gap?: PublisherGapValueV2;
12576
+ }
12577
+
12578
+ /**
12579
+ * Row or column of layout nodes.
12304
12580
  *
12305
12581
  * @alpha
12306
12582
  */
12307
- export declare interface IPublisherDocument extends IPublisherDocumentDefinition, IAuditableDates, IAuditableUsers {
12308
- ref: ObjRef;
12583
+ export declare interface IPublisherContainerV2 {
12584
+ type: "row" | "column";
12309
12585
  /**
12310
- * When true, the object comes from a parent workspace and is not editable
12311
- * in the current workspace.
12586
+ * Matches `[A-Za-z0-9_.-]{1,64}`.
12312
12587
  */
12313
- isLocked?: boolean;
12588
+ id?: string;
12589
+ /**
12590
+ * In reading order. An empty list renders as a spacer.
12591
+ */
12592
+ children: PublisherLayoutNodeV2[];
12593
+ /**
12594
+ * Share of the parent's main axis, greater than 0. Defaults to 1.
12595
+ */
12596
+ proportion?: number;
12597
+ /**
12598
+ * Enforced by the editor, never checked on write.
12599
+ */
12600
+ locked?: boolean;
12601
+ style?: IPublisherContainerStyleV2;
12602
+ }
12603
+
12604
+ /**
12605
+ * @remarks
12606
+ * A corner key wins over `borderRadius` in any order.
12607
+ *
12608
+ * @alpha
12609
+ */
12610
+ export declare interface IPublisherCornerStyleV2 {
12611
+ borderRadius?: PublisherRadiusValueV2;
12612
+ borderTopLeftRadius?: PublisherRadiusValueV2;
12613
+ borderTopRightRadius?: PublisherRadiusValueV2;
12614
+ borderBottomRightRadius?: PublisherRadiusValueV2;
12615
+ borderBottomLeftRadius?: PublisherRadiusValueV2;
12616
+ }
12617
+
12618
+ /**
12619
+ * @alpha
12620
+ */
12621
+ export declare interface IPublisherDataSetRefV2 {
12622
+ identifier: string;
12623
+ type: "dataSet";
12314
12624
  }
12315
12625
 
12626
+ /**
12627
+ * Current version of {@link IPublisherDocumentV1}.
12628
+ *
12629
+ * @alpha
12630
+ */
12631
+ export declare type IPublisherDocument = IPublisherDocumentV1;
12632
+
12633
+ /**
12634
+ * Current version of {@link IPublisherDocumentBaseV1}.
12635
+ *
12636
+ * @alpha
12637
+ */
12638
+ export declare type IPublisherDocumentBase = IPublisherDocumentBaseV1;
12639
+
12316
12640
  /**
12317
12641
  * Fields shared by document definitions and persisted documents.
12318
12642
  *
12319
12643
  * @alpha
12320
12644
  */
12321
- export declare interface IPublisherDocumentBase {
12645
+ export declare interface IPublisherDocumentBaseV1 {
12322
12646
  title: string;
12323
12647
  description?: string;
12324
12648
  tags?: string[];
@@ -12330,29 +12654,70 @@ export declare interface IPublisherDocumentBase {
12330
12654
  * visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
12331
12655
  * ignoreReportPeriod). Also available as `{periodStart}` in text.
12332
12656
  */
12333
- periodStart: PublisherDateString;
12657
+ periodStart: PublisherDateStringV1;
12334
12658
  /**
12335
12659
  * Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
12336
12660
  */
12337
- periodEnd: PublisherDateString;
12661
+ periodEnd: PublisherDateStringV1;
12338
12662
  /**
12339
12663
  * Content of the document. When created from a template the content is deep-copied
12340
12664
  * and NO reference to the template is kept — the document stays frozen while pages
12341
12665
  * and templates evolve.
12342
12666
  */
12343
- content: IPublisherDocumentContent;
12667
+ content: IPublisherDocumentContentV1;
12344
12668
  /**
12345
12669
  * Values for variables declared in content.variables, keyed by variable name.
12346
12670
  */
12347
12671
  variableValues?: Record<string, string>;
12348
12672
  }
12349
12673
 
12674
+ /**
12675
+ * Current version of {@link IPublisherDocumentContentV1}.
12676
+ *
12677
+ * @alpha
12678
+ */
12679
+ export declare type IPublisherDocumentContent = IPublisherDocumentContentV1;
12680
+
12681
+ /**
12682
+ * Keys shared by both shapes of document content.
12683
+ *
12684
+ * @alpha
12685
+ */
12686
+ export declare interface IPublisherDocumentContentBaseV2 {
12687
+ defaults?: IPublisherDocumentDefaultsV2;
12688
+ /**
12689
+ * Date filters name their `dataSet`. At most one filter per attribute or date dataset.
12690
+ */
12691
+ filters?: FilterContextItem[];
12692
+ attributeFilterConfigs?: IDashboardAttributeFilterConfig[];
12693
+ style?: IPublisherDocumentStyleV2;
12694
+ /**
12695
+ * Overrides the workspace locale for this document, for example `de-DE`.
12696
+ */
12697
+ locale?: string;
12698
+ /**
12699
+ * Overrides the workspace format locale used for dates, for example `de-DE`.
12700
+ */
12701
+ formatLocale?: string;
12702
+ }
12703
+
12704
+ /**
12705
+ * @alpha
12706
+ */
12707
+ export declare interface IPublisherDocumentContentSetSectionsOptionsV2 {
12708
+ /**
12709
+ * Content the sections were read from. Its other keys are kept.
12710
+ */
12711
+ content: PublisherDocumentContentV2;
12712
+ sections: IPublisherSectionV2[];
12713
+ }
12714
+
12350
12715
  /**
12351
12716
  * Versioned content shared verbatim by document templates and documents.
12352
12717
  *
12353
12718
  * @alpha
12354
12719
  */
12355
- export declare interface IPublisherDocumentContent {
12720
+ export declare interface IPublisherDocumentContentV1 {
12356
12721
  /**
12357
12722
  * Content model version, for stored-content evolution.
12358
12723
  */
@@ -12360,7 +12725,7 @@ export declare interface IPublisherDocumentContent {
12360
12725
  /**
12361
12726
  * Ordered pages of the document.
12362
12727
  */
12363
- pages: IPublisherDocumentPage[];
12728
+ pages: IPublisherDocumentPageV1[];
12364
12729
  /**
12365
12730
  * Content-level default filters; pages and slots may extend or override them.
12366
12731
  * The document period is NOT stored here — it is derived from periodStart/periodEnd
@@ -12374,12 +12739,12 @@ export declare interface IPublisherDocumentContent {
12374
12739
  * A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
12375
12740
  * is read as primary-label values and shown by `displayAsLabel`.
12376
12741
  */
12377
- attributeFilterConfigs?: IPublisherAttributeFilterConfig[];
12742
+ attributeFilterConfigs?: IPublisherAttributeFilterConfigV1[];
12378
12743
  /**
12379
12744
  * Custom variable declarations. Values live on the document
12380
- * ({@link IPublisherDocumentBase.variableValues}).
12745
+ * ({@link IPublisherDocumentBaseV1.variableValues}).
12381
12746
  */
12382
- variables?: IPublisherVariableDefinition[];
12747
+ variables?: IPublisherVariableDefinitionV1[];
12383
12748
  /**
12384
12749
  * Instructions every AI-written text without instructions of its own is generated with.
12385
12750
  * Supports `{variables}`.
@@ -12388,433 +12753,1140 @@ export declare interface IPublisherDocumentContent {
12388
12753
  }
12389
12754
 
12390
12755
  /**
12391
- * Payload for creating or updating a document.
12392
- *
12393
12756
  * @alpha
12394
12757
  */
12395
- export declare interface IPublisherDocumentDefinition extends IPublisherDocumentBase {
12396
- type: "report";
12758
+ export declare interface IPublisherDocumentDefaultsV2 {
12397
12759
  /**
12398
- * Present when updating an existing document.
12760
+ * Applies to every page without its own `pageSize`.
12399
12761
  */
12400
- ref?: ObjRef;
12762
+ pageSize?: PublisherPageSizeV2;
12763
+ takeaway?: {
12764
+ /**
12765
+ * Combined with each takeaway widget's own `generation`.
12766
+ */
12767
+ generation?: IPublisherTakeawayGenerationV2;
12768
+ };
12769
+ /**
12770
+ * Document templates only. A document stores its period on the entity.
12771
+ */
12772
+ period?: PublisherPeriodV2;
12401
12773
  }
12402
12774
 
12403
12775
  /**
12404
- * Page instance embedded in template/document content: a deep clone of a page body
12405
- * plus its own identity.
12406
- *
12407
- * @remarks
12408
- * Cloning a {@link IPublisherPageLayout} into content assigns the localIdentifier and regenerates
12409
- * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
12410
- * Deliberately carries NO reference back to the source page — later page edits never
12411
- * affect existing templates or documents.
12776
+ * Current version of {@link IPublisherDocumentDefinitionV1}.
12412
12777
  *
12413
12778
  * @alpha
12414
12779
  */
12415
- export declare interface IPublisherDocumentPage extends IPublisherPageBody {
12416
- /**
12417
- * Identifier unique within the content; stable across template-to-document copy and reordering.
12418
- */
12419
- localIdentifier: string;
12420
- }
12780
+ export declare type IPublisherDocumentDefinition = IPublisherDocumentDefinitionV1;
12421
12781
 
12422
12782
  /**
12423
- * Document template metadata object.
12783
+ * Payload for creating or updating a document.
12424
12784
  *
12425
12785
  * @alpha
12426
12786
  */
12427
- export declare interface IPublisherDocumentTemplate extends IPublisherDocumentTemplateDefinition, IAuditableDates, IAuditableUsers {
12428
- ref: ObjRef;
12787
+ export declare interface IPublisherDocumentDefinitionV1 extends IPublisherDocumentBaseV1 {
12788
+ type: "report";
12429
12789
  /**
12430
- * When true, the object comes from a parent workspace and is not editable
12431
- * in the current workspace.
12790
+ * Present when updating an existing document.
12432
12791
  */
12433
- isLocked?: boolean;
12792
+ ref?: ObjRef;
12434
12793
  }
12435
12794
 
12436
12795
  /**
12437
- * Payload for creating or updating a document template.
12796
+ * Payload for creating or updating a document.
12438
12797
  *
12439
12798
  * @alpha
12440
12799
  */
12441
- export declare interface IPublisherDocumentTemplateDefinition {
12442
- type: "reportTemplate";
12800
+ export declare interface IPublisherDocumentDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
12801
+ type: "document";
12802
+ period: PublisherPeriodV2;
12443
12803
  /**
12444
- * Present when updating an existing template.
12804
+ * A document created from a template gets a deep copy of its content and keeps no reference to it.
12445
12805
  */
12446
- ref?: ObjRef;
12447
- title: string;
12448
- description?: string;
12449
- tags?: string[];
12450
- content: IPublisherDocumentContent;
12806
+ content: PublisherDocumentContentV2;
12451
12807
  }
12452
12808
 
12453
12809
  /**
12454
- * Slot rendering a heading.
12455
- *
12456
- * @remarks
12457
- * A heading is a line of display text, so it carries no markup of its own: what is typed in it is
12458
- * what it renders.
12810
+ * Current version of {@link IPublisherDocumentPageV1}.
12459
12811
  *
12460
12812
  * @alpha
12461
12813
  */
12462
- export declare interface IPublisherHeadingSlot extends IPublisherSlotBase {
12463
- type: "heading";
12464
- style?: IPublisherHeadingStyle;
12465
- /**
12466
- * Undefined = declared-but-empty slot.
12467
- */
12468
- source?: PublisherTextSource;
12469
- }
12814
+ export declare type IPublisherDocumentPage = IPublisherDocumentPageV1;
12470
12815
 
12471
12816
  /**
12472
- * Styling of a heading slot.
12817
+ * Document content stored as a flat list of pages.
12473
12818
  *
12474
12819
  * @alpha
12475
12820
  */
12476
- export declare interface IPublisherHeadingStyle extends IPublisherTextStyle {
12477
- /**
12478
- * Defaults to {@link DefaultPublisherHeadingType}. The size owns the semantic typography that goes
12479
- * with it; the rest of the style overrides ink and placement on top of it.
12480
- */
12481
- type?: PublisherHeadingType;
12821
+ export declare interface IPublisherDocumentPagesContentV2 extends IPublisherDocumentContentBaseV2 {
12822
+ pages: IPublisherDocumentPageV2[];
12823
+ sections?: never;
12482
12824
  }
12483
12825
 
12484
12826
  /**
12485
- * Image painted behind a section's or page's content.
12827
+ * Page instance embedded in template/document content: a deep clone of a page body
12828
+ * plus its own identity.
12829
+ *
12830
+ * @remarks
12831
+ * Cloning a {@link IPublisherPageLayoutV1} into content assigns the localIdentifier and regenerates
12832
+ * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
12833
+ * Deliberately carries NO reference back to the source page — later page edits never
12834
+ * affect existing templates or documents.
12486
12835
  *
12487
12836
  * @alpha
12488
12837
  */
12489
- export declare interface IPublisherImageBackground {
12490
- type: "image";
12838
+ export declare interface IPublisherDocumentPageV1 extends IPublisherPageBodyV1 {
12491
12839
  /**
12492
- * Local identifier of an image slot in {@link IPublisherPageBody.slots}. Routing the image
12493
- * through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
12494
- * A reference that is missing or resolves to a non-image slot paints no background.
12840
+ * Identifier unique within the content; stable across template-to-document copy and reordering.
12495
12841
  */
12496
- slotId: string;
12842
+ localIdentifier: string;
12497
12843
  }
12498
12844
 
12499
12845
  /**
12500
- * Slot rendering an image.
12846
+ * Page inside a document.
12501
12847
  *
12502
12848
  * @alpha
12503
12849
  */
12504
- export declare interface IPublisherImageSlot extends IPublisherSlotBase {
12505
- type: "image";
12506
- /**
12507
- * Undefined = declared-but-empty slot.
12508
- */
12509
- source?: PublisherImageSource;
12510
- altText?: string;
12850
+ export declare interface IPublisherDocumentPageV2 extends IPublisherPageBodyV2 {
12511
12851
  /**
12512
- * How the image fills the slot area. Defaults to "contain".
12852
+ * Unique in the document. Matches `[A-Za-z0-9_.-]{1,64}`.
12513
12853
  */
12514
- fit?: PublisherImageFit;
12854
+ id: string;
12515
12855
  /**
12516
- * Placement overrides for the drawn image; centered on both axes by default.
12856
+ * Defaults to `true`. A hidden page is left out of the viewer, exports and page numbers.
12517
12857
  */
12518
- style?: IPublisherImageStyle;
12858
+ visible?: boolean;
12519
12859
  }
12520
12860
 
12521
12861
  /**
12522
- * Where the drawn image sits when it does not fill its box, and which part of it is kept when it
12523
- * is cropped to fill one.
12862
+ * Document content stored as sections of pages.
12524
12863
  *
12525
12864
  * @alpha
12526
12865
  */
12527
- export declare interface IPublisherImageStyle {
12528
- horizontalAlign?: PublisherContentAlignment;
12529
- verticalAlign?: PublisherContentAlignment;
12866
+ export declare interface IPublisherDocumentSectionsContentV2 extends IPublisherDocumentContentBaseV2 {
12867
+ sections: IPublisherSectionV2[];
12868
+ pages?: never;
12530
12869
  }
12531
12870
 
12532
12871
  /**
12533
- * Fields common to all page layout nodes.
12872
+ * Style of the area behind the pages. Exports ignore it.
12534
12873
  *
12535
12874
  * @alpha
12536
12875
  */
12537
- export declare interface IPublisherLayoutNodeBase {
12876
+ export declare interface IPublisherDocumentStyleV2 extends IPublisherBackgroundStyleV2 {
12538
12877
  /**
12539
- * Fractional weight of this node inside its parent (flex-grow semantics).
12540
- * Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
12878
+ * Space between pages in the viewer and the editor.
12541
12879
  */
12542
- weight?: number;
12880
+ gap?: PublisherGapValueV2;
12543
12881
  }
12544
12882
 
12545
12883
  /**
12546
- * A container splitting its area into children laid out along a direction.
12884
+ * Current version of {@link IPublisherDocumentTemplateV1}.
12547
12885
  *
12548
12886
  * @alpha
12549
12887
  */
12550
- export declare interface IPublisherLayoutSection extends IPublisherLayoutNodeBase {
12551
- type: "section";
12552
- /**
12553
- * "row" lays children out horizontally, "column" vertically.
12554
- */
12555
- direction: "row" | "column";
12556
- children: PublisherPageLayoutNode[];
12557
- /**
12558
- * Paint of this section's box. Never affects how children are laid out.
12559
- */
12560
- style?: IPublisherBoxStyle;
12561
- }
12888
+ export declare type IPublisherDocumentTemplate = IPublisherDocumentTemplateV1;
12562
12889
 
12563
12890
  /**
12564
- * A leaf assigning its area to a slot. The slot fills the area completely.
12891
+ * Current version of {@link IPublisherDocumentTemplateDefinitionV1}.
12565
12892
  *
12566
12893
  * @alpha
12567
12894
  */
12568
- export declare interface IPublisherLayoutSlotRef extends IPublisherLayoutNodeBase {
12569
- type: "slotRef";
12895
+ export declare type IPublisherDocumentTemplateDefinition = IPublisherDocumentTemplateDefinitionV1;
12896
+
12897
+ /**
12898
+ * Payload for creating or updating a document template.
12899
+ *
12900
+ * @alpha
12901
+ */
12902
+ export declare interface IPublisherDocumentTemplateDefinitionV1 {
12903
+ type: "reportTemplate";
12570
12904
  /**
12571
- * Local identifier of a slot in {@link IPublisherPageBody.slots}.
12572
- * A slotId with no matching slot renders as an empty area.
12905
+ * Present when updating an existing template.
12573
12906
  */
12574
- slotId: string;
12907
+ ref?: ObjRef;
12908
+ title: string;
12909
+ description?: string;
12910
+ tags?: string[];
12911
+ content: IPublisherDocumentContentV1;
12575
12912
  }
12576
12913
 
12577
12914
  /**
12578
- * Body of a document page: geometry (flex split tree) plus the slots it places.
12579
- *
12580
- * @remarks
12581
- * This is both the content of the standalone {@link IPublisherPageLayout} object and the shape
12582
- * embedded in template/document content ({@link IPublisherDocumentPage}).
12915
+ * Payload for creating or updating a document template.
12583
12916
  *
12584
- * There is no header/footer chrome: page title, description, footer, page numbers and
12585
- * logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
12586
- * an image slot with `{logo}`). Every slot fills its layout area completely.
12917
+ * @alpha
12918
+ */
12919
+ export declare interface IPublisherDocumentTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
12920
+ type: "documentTemplate";
12921
+ content: PublisherDocumentContentV2;
12922
+ }
12923
+
12924
+ /**
12925
+ * Document template metadata object.
12587
12926
  *
12588
12927
  * @alpha
12589
12928
  */
12590
- export declare interface IPublisherPageBody {
12591
- /**
12592
- * Editor hint only (template galleries, default styling, AI context).
12593
- * Renderers must not branch layout logic on it — geometry always comes from `layout`.
12594
- */
12595
- kind?: "cover" | "section" | "content";
12596
- /**
12597
- * Page proportions the layout was authored for. Defaults to
12598
- * {@link DefaultPublisherPageFormat}.
12599
- */
12600
- format?: PublisherPageFormat;
12601
- /**
12602
- * Paint of the page itself, behind everything the layout places.
12603
- */
12604
- style?: IPublisherBoxStyle;
12605
- /**
12606
- * Root of the page layout tree.
12607
- */
12608
- layout: PublisherPageLayoutNode;
12609
- /**
12610
- * All slots referenced by the layout, flat, keyed by localIdentifier.
12611
- */
12612
- slots: PublisherSlot[];
12929
+ export declare interface IPublisherDocumentTemplateV1 extends IPublisherDocumentTemplateDefinitionV1, IAuditableDates, IAuditableUsers {
12930
+ ref: ObjRef;
12613
12931
  /**
12614
- * Page-level filters: merged over content-level filters (a filter targeting the
12615
- * same object replaces the inherited one); slot filters apply on top.
12932
+ * When true, the object comes from a parent workspace and is not editable
12933
+ * in the current workspace.
12616
12934
  */
12617
- filters?: FilterContextItem[];
12935
+ isLocked?: boolean;
12618
12936
  }
12619
12937
 
12620
12938
  /**
12621
- * Validation issue found in a page body.
12939
+ * Document template metadata object.
12622
12940
  *
12623
12941
  * @alpha
12624
12942
  */
12625
- export declare interface IPublisherPageBodyValidationIssue {
12626
- severity: "error" | "warning";
12627
- message: string;
12943
+ export declare interface IPublisherDocumentTemplateV2 extends IPublisherDocumentTemplateDefinitionV2, IPublisherEntityMetadataV2 {
12944
+ ref: ObjRef;
12628
12945
  }
12629
12946
 
12630
12947
  /**
12631
- * Reusable page layout metadata object.
12948
+ * Document metadata object.
12632
12949
  *
12633
12950
  * @alpha
12634
12951
  */
12635
- export declare interface IPublisherPageLayout extends IPublisherPageLayoutDefinition, IAuditableDates, IAuditableUsers {
12952
+ export declare interface IPublisherDocumentV1 extends IPublisherDocumentDefinitionV1, IAuditableDates, IAuditableUsers {
12636
12953
  ref: ObjRef;
12637
12954
  /**
12638
12955
  * When true, the object comes from a parent workspace and is not editable
12639
12956
  * in the current workspace.
12640
12957
  */
12641
12958
  isLocked?: boolean;
12642
- /**
12643
- * Predefined page shipped with the product, populated by the SPI. Never sent to or
12644
- * stored on the backend; UI must disable deletion and editing of built-in pages.
12645
- */
12646
- isBuiltIn?: boolean;
12647
12959
  }
12648
12960
 
12649
12961
  /**
12650
- * Stored content of the reportPage entity.
12962
+ * Document metadata object.
12651
12963
  *
12652
12964
  * @alpha
12653
12965
  */
12654
- export declare interface IPublisherPageLayoutContent extends IPublisherPageBody {
12655
- /**
12656
- * Content model version, for stored-content evolution.
12657
- */
12658
- version: "1";
12966
+ export declare interface IPublisherDocumentV2 extends IPublisherDocumentDefinitionV2, IPublisherEntityMetadataV2 {
12967
+ ref: ObjRef;
12659
12968
  }
12660
12969
 
12661
12970
  /**
12662
- * Payload for creating or updating a page layout.
12971
+ * Fields shared by the definitions of all Publisher entities.
12663
12972
  *
12664
12973
  * @alpha
12665
12974
  */
12666
- export declare interface IPublisherPageLayoutDefinition {
12667
- type: "reportPageLayout";
12975
+ export declare interface IPublisherEntityDefinitionBaseV2 {
12668
12976
  /**
12669
- * Present when updating an existing page.
12977
+ * Present when updating an existing entity.
12670
12978
  */
12671
12979
  ref?: ObjRef;
12672
12980
  title: string;
12673
12981
  description?: string;
12674
12982
  tags?: string[];
12675
- content: IPublisherPageLayoutContent;
12983
+ version: PublisherContentVersionV2;
12676
12984
  }
12677
12985
 
12678
12986
  /**
12679
- * Slot rendering prose, written as markdown.
12987
+ * Fields shared by all persisted Publisher entities.
12680
12988
  *
12681
12989
  * @alpha
12682
12990
  */
12683
- export declare interface IPublisherParagraphSlot extends IPublisherSlotBase {
12684
- type: "paragraph";
12685
- style?: IPublisherParagraphStyle;
12991
+ export declare interface IPublisherEntityMetadataV2 extends IAuditableDates, IAuditableUsers {
12992
+ ref: ObjRef;
12686
12993
  /**
12687
- * Undefined = declared-but-empty slot.
12994
+ * When true, the object comes from a parent workspace and is not editable
12995
+ * in the current workspace.
12688
12996
  */
12689
- source?: PublisherTextSource;
12997
+ isLocked?: boolean;
12690
12998
  }
12691
12999
 
12692
13000
  /**
12693
- * Styling of a paragraph slot.
13001
+ * Current version of {@link IPublisherHeadingSlotV1}.
12694
13002
  *
12695
13003
  * @alpha
12696
13004
  */
12697
- export declare interface IPublisherParagraphStyle extends IPublisherTextStyle {
12698
- /**
12699
- * Defaults to {@link DefaultPublisherParagraphType}.
12700
- */
12701
- type?: PublisherParagraphType;
12702
- }
13005
+ export declare type IPublisherHeadingSlot = IPublisherHeadingSlotV1;
12703
13006
 
12704
13007
  /**
12705
- * Structural base of every document slot.
13008
+ * Slot rendering a heading.
12706
13009
  *
12707
13010
  * @remarks
12708
- * Parsers written against this base can skip slot types introduced by a newer
12709
- * content version instead of failing.
13011
+ * A heading is a line of display text, so it carries no markup of its own: what is typed in it is
13012
+ * what it renders.
12710
13013
  *
12711
13014
  * @alpha
12712
13015
  */
12713
- export declare interface IPublisherSlotBase {
12714
- type: string;
13016
+ export declare interface IPublisherHeadingSlotV1 extends IPublisherSlotBaseV1 {
13017
+ type: "heading";
13018
+ style?: IPublisherHeadingStyleV1;
12715
13019
  /**
12716
- * Identifier unique within the page body. The layout tree references it, and it is
12717
- * the join key when a document fills a template's slots. Regenerated when a page is
12718
- * cloned into template content so repeated use of one page stays unique.
13020
+ * Undefined = declared-but-empty slot.
12719
13021
  */
12720
- localIdentifier: string;
13022
+ source?: PublisherTextSourceV1;
13023
+ }
13024
+
13025
+ /**
13026
+ * Current version of {@link IPublisherHeadingStyleV1}.
13027
+ *
13028
+ * @alpha
13029
+ */
13030
+ export declare type IPublisherHeadingStyle = IPublisherHeadingStyleV1;
13031
+
13032
+ /**
13033
+ * Styling of a heading slot.
13034
+ *
13035
+ * @alpha
13036
+ */
13037
+ export declare interface IPublisherHeadingStyleV1 extends IPublisherTextStyleV1 {
12721
13038
  /**
12722
- * Present when the slot is an unfilled placeholder.
13039
+ * Defaults to {@link DefaultPublisherHeadingTypeV1}. The size owns the semantic typography that goes
13040
+ * with it; the rest of the style overrides ink and placement on top of it.
12723
13041
  */
12724
- placeholder?: IPublisherSlotPlaceholder;
13042
+ type?: PublisherHeadingTypeV1;
12725
13043
  }
12726
13044
 
12727
13045
  /**
12728
- * Metadata of a slot that is intentionally left unfilled in a page layout or template.
12729
- *
12730
13046
  * @alpha
12731
13047
  */
12732
- export declare interface IPublisherSlotPlaceholder {
13048
+ export declare interface IPublisherHeadingWidgetV2 extends IPublisherWidgetBaseV2 {
13049
+ type: "heading";
12733
13050
  /**
12734
- * Authoring hint shown in the empty slot.
13051
+ * Inline markdown only.
12735
13052
  */
12736
- hint?: string;
13053
+ markdown?: string;
12737
13054
  /**
12738
- * When true, a document is not considered complete until this slot is filled.
13055
+ * Outline level below the page title, independent of the text style. Defaults to 1.
12739
13056
  */
12740
- required?: boolean;
13057
+ level?: PublisherHeadingLevelV2;
13058
+ /**
13059
+ * `textStyle` defaults to {@link publisherHeadingDefaultTextStyleV2} of the level.
13060
+ */
13061
+ style?: IPublisherTextWidgetStyleV2;
12741
13062
  }
12742
13063
 
12743
13064
  /**
12744
- * Author-written text.
12745
- *
12746
13065
  * @alpha
12747
13066
  */
12748
- export declare interface IPublisherStaticTextSource {
12749
- type: "static";
12750
- /**
12751
- * Markdown content with `{variable}` placeholders. Stored raw — placeholders are
12752
- * resolved only at render/export time.
12753
- */
12754
- content: string;
13067
+ export declare interface IPublisherHeadlineStyleV2 {
13068
+ primaryValueColor?: PublisherColorValueV2;
13069
+ primaryValueSize?: PublisherPxV2;
13070
+ secondaryValueColor?: PublisherColorValueV2;
13071
+ secondaryValueSize?: PublisherPxV2;
13072
+ positiveColor?: PublisherColorValueV2;
13073
+ negativeColor?: PublisherColorValueV2;
12755
13074
  }
12756
13075
 
12757
13076
  /**
12758
- * Slot rendering text of either kind.
13077
+ * Current version of {@link IPublisherImageBackgroundV1}.
12759
13078
  *
12760
13079
  * @alpha
12761
13080
  */
12762
- export declare type IPublisherTextSlot = IPublisherHeadingSlot | IPublisherParagraphSlot;
13081
+ export declare type IPublisherImageBackground = IPublisherImageBackgroundV1;
12763
13082
 
12764
13083
  /**
12765
- * Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
13084
+ * Image painted behind a section's or page's content.
12766
13085
  *
12767
13086
  * @alpha
12768
13087
  */
12769
- export declare interface IPublisherTextStyle extends IPublisherBoxStyle {
13088
+ export declare interface IPublisherImageBackgroundV1 {
13089
+ type: "image";
12770
13090
  /**
12771
- * CSS color value. Absolute, like {@link IPublisherColorBackground.color}.
13091
+ * Local identifier of an image slot in {@link IPublisherPageBodyV1.slots}. Routing the image
13092
+ * through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
13093
+ * A reference that is missing or resolves to a non-image slot paints no background.
12772
13094
  */
12773
- color?: string;
12774
- horizontalAlign?: PublisherContentAlignment;
12775
- verticalAlign?: PublisherContentAlignment;
13095
+ slotId: string;
12776
13096
  }
12777
13097
 
12778
13098
  /**
12779
- * A custom variable declared by document content and given a value by a document.
13099
+ * Current version of {@link IPublisherImageSlotV1}.
12780
13100
  *
12781
- * @remarks
12782
- * Referenced from text as `{name}`. Values come from {@link IPublisherDocumentBase.variableValues},
12783
- * falling back to {@link IPublisherVariableDefinition.defaultValue}.
13101
+ * @alpha
13102
+ */
13103
+ export declare type IPublisherImageSlot = IPublisherImageSlotV1;
13104
+
13105
+ /**
13106
+ * Slot rendering an image.
12784
13107
  *
12785
13108
  * @alpha
12786
13109
  */
12787
- export declare interface IPublisherVariableDefinition {
13110
+ export declare interface IPublisherImageSlotV1 extends IPublisherSlotBaseV1 {
13111
+ type: "image";
12788
13112
  /**
12789
- * Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
12790
- * Built-in names ({@link PublisherBuiltInVariable}) are reserved.
13113
+ * Undefined = declared-but-empty slot.
12791
13114
  */
12792
- name: string;
13115
+ source?: PublisherImageSourceV1;
13116
+ altText?: string;
12793
13117
  /**
12794
- * Human readable label shown in the editor.
13118
+ * How the image fills the slot area. Defaults to "contain".
12795
13119
  */
12796
- title?: string;
12797
- description?: string;
13120
+ fit?: PublisherImageFitV1;
12798
13121
  /**
12799
- * Value used when the document does not provide one. May not contain further
12800
- * placeholders — there is no recursive expansion.
13122
+ * Placement overrides for the drawn image; centered on both axes by default.
12801
13123
  */
12802
- defaultValue?: string;
13124
+ style?: IPublisherImageStyleV1;
12803
13125
  }
12804
13126
 
12805
13127
  /**
12806
- * Slot rendering an insight, with its own filter context.
13128
+ * Current version of {@link IPublisherImageStyleV1}.
12807
13129
  *
12808
13130
  * @alpha
12809
13131
  */
12810
- export declare interface IPublisherVisualizationSlot extends IPublisherSlotBase {
12811
- type: "visualization";
13132
+ export declare type IPublisherImageStyle = IPublisherImageStyleV1;
13133
+
13134
+ /**
13135
+ * Where the drawn image sits when it does not fill its box, and which part of it is kept when it
13136
+ * is cropped to fill one.
13137
+ *
13138
+ * @alpha
13139
+ */
13140
+ export declare interface IPublisherImageStyleV1 {
13141
+ horizontalAlign?: PublisherContentAlignmentV1;
13142
+ verticalAlign?: PublisherContentAlignmentV1;
13143
+ }
13144
+
13145
+ /**
13146
+ * @alpha
13147
+ */
13148
+ export declare interface IPublisherImageWidgetStyleV2 extends IPublisherBoxStyleV2 {
12812
13149
  /**
12813
- * Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
13150
+ * Defaults to `contain`.
12814
13151
  */
12815
- insight?: ObjRef;
13152
+ fit?: "contain" | "cover" | "fill";
13153
+ horizontalAlign?: PublisherHorizontalAlignV2;
13154
+ verticalAlign?: PublisherVerticalAlignV2;
13155
+ }
13156
+
13157
+ /**
13158
+ * @alpha
13159
+ */
13160
+ export declare interface IPublisherImageWidgetV2 extends IPublisherWidgetBaseV2 {
13161
+ type: "image";
13162
+ source?: PublisherImageSourceV2;
13163
+ altText?: string;
13164
+ decorative?: boolean;
13165
+ style?: IPublisherImageWidgetStyleV2;
13166
+ }
13167
+
13168
+ /**
13169
+ * Text keys that a page or container passes down to the content inside, unless a widget sets its own.
13170
+ *
13171
+ * @alpha
13172
+ */
13173
+ export declare interface IPublisherInheritedTextStyleV2 {
13174
+ textStyle?: PublisherTextStyleNameV2;
13175
+ textColor?: PublisherColorValueV2;
12816
13176
  /**
12817
- * Optional title rendered above the visualization. Supports `{variables}`.
13177
+ * `justify` applies to text only.
13178
+ */
13179
+ horizontalAlign?: PublisherHorizontalAlignV2 | "justify";
13180
+ verticalAlign?: PublisherVerticalAlignV2;
13181
+ }
13182
+
13183
+ /**
13184
+ * Current version of {@link IPublisherLayoutNodeBaseV1}.
13185
+ *
13186
+ * @alpha
13187
+ */
13188
+ export declare type IPublisherLayoutNodeBase = IPublisherLayoutNodeBaseV1;
13189
+
13190
+ /**
13191
+ * Fields common to all page layout nodes.
13192
+ *
13193
+ * @alpha
13194
+ */
13195
+ export declare interface IPublisherLayoutNodeBaseV1 {
13196
+ /**
13197
+ * Fractional weight of this node inside its parent (flex-grow semantics).
13198
+ * Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
13199
+ */
13200
+ weight?: number;
13201
+ }
13202
+
13203
+ /**
13204
+ * Current version of {@link IPublisherLayoutSectionV1}.
13205
+ *
13206
+ * @alpha
13207
+ */
13208
+ export declare type IPublisherLayoutSection = IPublisherLayoutSectionV1;
13209
+
13210
+ /**
13211
+ * A container splitting its area into children laid out along a direction.
13212
+ *
13213
+ * @alpha
13214
+ */
13215
+ export declare interface IPublisherLayoutSectionV1 extends IPublisherLayoutNodeBaseV1 {
13216
+ type: "section";
13217
+ /**
13218
+ * "row" lays children out horizontally, "column" vertically.
13219
+ */
13220
+ direction: "row" | "column";
13221
+ children: PublisherPageLayoutNodeV1[];
13222
+ /**
13223
+ * Paint of this section's box. Never affects how children are laid out.
13224
+ */
13225
+ style?: IPublisherBoxStyleV1;
13226
+ }
13227
+
13228
+ /**
13229
+ * Current version of {@link IPublisherLayoutSlotRefV1}.
13230
+ *
13231
+ * @alpha
13232
+ */
13233
+ export declare type IPublisherLayoutSlotRef = IPublisherLayoutSlotRefV1;
13234
+
13235
+ /**
13236
+ * A leaf assigning its area to a slot. The slot fills the area completely.
13237
+ *
13238
+ * @alpha
13239
+ */
13240
+ export declare interface IPublisherLayoutSlotRefV1 extends IPublisherLayoutNodeBaseV1 {
13241
+ type: "slotRef";
13242
+ /**
13243
+ * Local identifier of a slot in {@link IPublisherPageBodyV1.slots}.
13244
+ * A slotId with no matching slot renders as an empty area.
13245
+ */
13246
+ slotId: string;
13247
+ }
13248
+
13249
+ /**
13250
+ * @remarks
13251
+ * A side key wins over `padding` in any order.
13252
+ *
13253
+ * @alpha
13254
+ */
13255
+ export declare interface IPublisherPaddingStyleV2 {
13256
+ padding?: PublisherPaddingValueV2;
13257
+ paddingTop?: PublisherPaddingValueV2;
13258
+ paddingRight?: PublisherPaddingValueV2;
13259
+ paddingBottom?: PublisherPaddingValueV2;
13260
+ paddingLeft?: PublisherPaddingValueV2;
13261
+ }
13262
+
13263
+ /**
13264
+ * Current version of {@link IPublisherPageBodyV1}.
13265
+ *
13266
+ * @alpha
13267
+ */
13268
+ export declare type IPublisherPageBody = IPublisherPageBodyV1;
13269
+
13270
+ /**
13271
+ * Body of a document page: geometry (flex split tree) plus the slots it places.
13272
+ *
13273
+ * @remarks
13274
+ * This is both the content of the standalone {@link IPublisherPageLayoutV1} object and the shape
13275
+ * embedded in template/document content ({@link IPublisherDocumentPageV1}).
13276
+ *
13277
+ * There is no header/footer chrome: page title, description, footer, page numbers and
13278
+ * logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
13279
+ * an image slot with `{logo}`). Every slot fills its layout area completely.
13280
+ *
13281
+ * @alpha
13282
+ */
13283
+ export declare interface IPublisherPageBodyV1 {
13284
+ /**
13285
+ * Editor hint only (template galleries, default styling, AI context).
13286
+ * Renderers must not branch layout logic on it — geometry always comes from `layout`.
13287
+ */
13288
+ kind?: "cover" | "section" | "content";
13289
+ /**
13290
+ * Page proportions the layout was authored for. Defaults to
13291
+ * {@link DefaultPublisherPageFormatV1}.
13292
+ */
13293
+ format?: PublisherPageFormatV1;
13294
+ /**
13295
+ * Paint of the page itself, behind everything the layout places.
13296
+ */
13297
+ style?: IPublisherBoxStyleV1;
13298
+ /**
13299
+ * Root of the page layout tree.
13300
+ */
13301
+ layout: PublisherPageLayoutNodeV1;
13302
+ /**
13303
+ * All slots referenced by the layout, flat, keyed by localIdentifier.
13304
+ */
13305
+ slots: PublisherSlotV1[];
13306
+ /**
13307
+ * Page-level filters: merged over content-level filters (a filter targeting the
13308
+ * same object replaces the inherited one); slot filters apply on top.
13309
+ */
13310
+ filters?: FilterContextItem[];
13311
+ }
13312
+
13313
+ /**
13314
+ * Content of one page, as a page template stores it.
13315
+ *
13316
+ * @alpha
13317
+ */
13318
+ export declare interface IPublisherPageBodyV2 {
13319
+ kind?: PublisherPageKindV2;
13320
+ pageSize?: PublisherPageSizeV2;
13321
+ /**
13322
+ * Markdown speaker notes, never drawn on the page.
13323
+ */
13324
+ notes?: string;
13325
+ style?: IPublisherPageStyleV2;
13326
+ layout: PublisherLayoutNodeV2;
13327
+ filters?: FilterContextItem[];
13328
+ }
13329
+
13330
+ /**
13331
+ * Current version of {@link IPublisherPageBodyValidationIssueV1}.
13332
+ *
13333
+ * @alpha
13334
+ */
13335
+ export declare type IPublisherPageBodyValidationIssue = IPublisherPageBodyValidationIssueV1;
13336
+
13337
+ /**
13338
+ * Validation issue found in a page body.
13339
+ *
13340
+ * @alpha
13341
+ */
13342
+ export declare interface IPublisherPageBodyValidationIssueV1 {
13343
+ severity: "error" | "warning";
13344
+ message: string;
13345
+ }
13346
+
13347
+ /**
13348
+ * Current version of {@link IPublisherPageLayoutV1}.
13349
+ *
13350
+ * @alpha
13351
+ */
13352
+ export declare type IPublisherPageLayout = IPublisherPageLayoutV1;
13353
+
13354
+ /**
13355
+ * Current version of {@link IPublisherPageLayoutContentV1}.
13356
+ *
13357
+ * @alpha
13358
+ */
13359
+ export declare type IPublisherPageLayoutContent = IPublisherPageLayoutContentV1;
13360
+
13361
+ /**
13362
+ * Stored content of the reportPage entity.
13363
+ *
13364
+ * @alpha
13365
+ */
13366
+ export declare interface IPublisherPageLayoutContentV1 extends IPublisherPageBodyV1 {
13367
+ /**
13368
+ * Content model version, for stored-content evolution.
13369
+ */
13370
+ version: "1";
13371
+ }
13372
+
13373
+ /**
13374
+ * Current version of {@link IPublisherPageLayoutDefinitionV1}.
13375
+ *
13376
+ * @alpha
13377
+ */
13378
+ export declare type IPublisherPageLayoutDefinition = IPublisherPageLayoutDefinitionV1;
13379
+
13380
+ /**
13381
+ * Payload for creating or updating a page layout.
13382
+ *
13383
+ * @alpha
13384
+ */
13385
+ export declare interface IPublisherPageLayoutDefinitionV1 {
13386
+ type: "reportPageLayout";
13387
+ /**
13388
+ * Present when updating an existing page.
13389
+ */
13390
+ ref?: ObjRef;
13391
+ title: string;
13392
+ description?: string;
13393
+ tags?: string[];
13394
+ content: IPublisherPageLayoutContentV1;
13395
+ }
13396
+
13397
+ /**
13398
+ * Reusable page layout metadata object.
13399
+ *
13400
+ * @alpha
13401
+ */
13402
+ export declare interface IPublisherPageLayoutV1 extends IPublisherPageLayoutDefinitionV1, IAuditableDates, IAuditableUsers {
13403
+ ref: ObjRef;
13404
+ /**
13405
+ * When true, the object comes from a parent workspace and is not editable
13406
+ * in the current workspace.
13407
+ */
13408
+ isLocked?: boolean;
13409
+ /**
13410
+ * Predefined page shipped with the product, populated by the SPI. Never sent to or
13411
+ * stored on the backend; UI must disable deletion and editing of built-in pages.
13412
+ */
13413
+ isBuiltIn?: boolean;
13414
+ }
13415
+
13416
+ /**
13417
+ * @alpha
13418
+ */
13419
+ export declare interface IPublisherPageStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherInheritedTextStyleV2 {
13420
+ /**
13421
+ * Default gap of every container on the page.
13422
+ */
13423
+ gap?: PublisherGapValueV2;
13424
+ }
13425
+
13426
+ /**
13427
+ * Payload for creating or updating a page template.
13428
+ *
13429
+ * @alpha
13430
+ */
13431
+ export declare interface IPublisherPageTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
13432
+ type: "pageTemplate";
13433
+ content: IPublisherPageBodyV2;
13434
+ }
13435
+
13436
+ /**
13437
+ * Page template metadata object.
13438
+ *
13439
+ * @alpha
13440
+ */
13441
+ export declare interface IPublisherPageTemplateV2 extends IPublisherPageTemplateDefinitionV2, IPublisherEntityMetadataV2 {
13442
+ ref: ObjRef;
13443
+ /**
13444
+ * True for the default page templates the backend serves. Their ids start with `default.`.
13445
+ */
13446
+ isDefault?: boolean;
13447
+ }
13448
+
13449
+ /**
13450
+ * Current version of {@link IPublisherParagraphSlotV1}.
13451
+ *
13452
+ * @alpha
13453
+ */
13454
+ export declare type IPublisherParagraphSlot = IPublisherParagraphSlotV1;
13455
+
13456
+ /**
13457
+ * Slot rendering prose, written as markdown.
13458
+ *
13459
+ * @alpha
13460
+ */
13461
+ export declare interface IPublisherParagraphSlotV1 extends IPublisherSlotBaseV1 {
13462
+ type: "paragraph";
13463
+ style?: IPublisherParagraphStyleV1;
13464
+ /**
13465
+ * Undefined = declared-but-empty slot.
13466
+ */
13467
+ source?: PublisherTextSourceV1;
13468
+ }
13469
+
13470
+ /**
13471
+ * Current version of {@link IPublisherParagraphStyleV1}.
13472
+ *
13473
+ * @alpha
13474
+ */
13475
+ export declare type IPublisherParagraphStyle = IPublisherParagraphStyleV1;
13476
+
13477
+ /**
13478
+ * Styling of a paragraph slot.
13479
+ *
13480
+ * @alpha
13481
+ */
13482
+ export declare interface IPublisherParagraphStyleV1 extends IPublisherTextStyleV1 {
13483
+ /**
13484
+ * Defaults to {@link DefaultPublisherParagraphTypeV1}.
13485
+ */
13486
+ type?: PublisherParagraphTypeV1;
13487
+ }
13488
+
13489
+ /**
13490
+ * Both ends are inclusive.
13491
+ *
13492
+ * @alpha
13493
+ */
13494
+ export declare interface IPublisherRelativePeriodV2 {
13495
+ type: "relative";
13496
+ granularity: DateFilterGranularity;
13497
+ /**
13498
+ * Offset in `granularity` units from the current one, for example `-1`.
13499
+ */
13500
+ from: number;
13501
+ to: number;
13502
+ }
13503
+
13504
+ /**
13505
+ * Named group of pages.
13506
+ *
13507
+ * @alpha
13508
+ */
13509
+ export declare interface IPublisherSectionV2 {
13510
+ /**
13511
+ * Unique in the document. Matches `[A-Za-z0-9_.-]{1,64}`.
13512
+ */
13513
+ id: string;
13514
+ title?: string;
13515
+ description?: string;
13516
+ pages: IPublisherDocumentPageV2[];
13517
+ }
13518
+
13519
+ /**
13520
+ * @remarks
13521
+ * The part keys override the named `shadow`, or define a shadow without one.
13522
+ *
13523
+ * @alpha
13524
+ */
13525
+ export declare interface IPublisherShadowStyleV2 {
13526
+ shadow?: PublisherShadowValueV2;
13527
+ /**
13528
+ * px on the design canvas; may be negative.
13529
+ */
13530
+ shadowX?: number;
13531
+ /**
13532
+ * px on the design canvas; may be negative.
13533
+ */
13534
+ shadowY?: number;
13535
+ shadowBlur?: PublisherPxV2;
13536
+ /**
13537
+ * px on the design canvas; may be negative.
13538
+ */
13539
+ shadowSpread?: number;
13540
+ shadowColor?: PublisherColorValueV2;
13541
+ shadowOpacity?: PublisherOpacityV2;
13542
+ }
13543
+
13544
+ /**
13545
+ * Current version of {@link IPublisherSlotBaseV1}.
13546
+ *
13547
+ * @alpha
13548
+ */
13549
+ export declare type IPublisherSlotBase = IPublisherSlotBaseV1;
13550
+
13551
+ /**
13552
+ * Structural base of every document slot.
13553
+ *
13554
+ * @remarks
13555
+ * Parsers written against this base can skip slot types introduced by a newer
13556
+ * content version instead of failing.
13557
+ *
13558
+ * @alpha
13559
+ */
13560
+ export declare interface IPublisherSlotBaseV1 {
13561
+ type: string;
13562
+ /**
13563
+ * Identifier unique within the page body. The layout tree references it, and it is
13564
+ * the join key when a document fills a template's slots. Regenerated when a page is
13565
+ * cloned into template content so repeated use of one page stays unique.
13566
+ */
13567
+ localIdentifier: string;
13568
+ /**
13569
+ * Present when the slot is an unfilled placeholder.
13570
+ */
13571
+ placeholder?: IPublisherSlotPlaceholderV1;
13572
+ }
13573
+
13574
+ /**
13575
+ * Current version of {@link IPublisherSlotPlaceholderV1}.
13576
+ *
13577
+ * @alpha
13578
+ */
13579
+ export declare type IPublisherSlotPlaceholder = IPublisherSlotPlaceholderV1;
13580
+
13581
+ /**
13582
+ * Metadata of a slot that is intentionally left unfilled in a page layout or template.
13583
+ *
13584
+ * @alpha
13585
+ */
13586
+ export declare interface IPublisherSlotPlaceholderV1 {
13587
+ /**
13588
+ * Authoring hint shown in the empty slot.
13589
+ */
13590
+ hint?: string;
13591
+ /**
13592
+ * When true, a document is not considered complete until this slot is filled.
13593
+ */
13594
+ required?: boolean;
13595
+ }
13596
+
13597
+ /**
13598
+ * Current version of {@link IPublisherStaticTextSourceV1}.
13599
+ *
13600
+ * @alpha
13601
+ */
13602
+ export declare type IPublisherStaticTextSource = IPublisherStaticTextSourceV1;
13603
+
13604
+ /**
13605
+ * Author-written text.
13606
+ *
13607
+ * @alpha
13608
+ */
13609
+ export declare interface IPublisherStaticTextSourceV1 {
13610
+ type: "static";
13611
+ /**
13612
+ * Markdown content with `{variable}` placeholders. Stored raw — placeholders are
13613
+ * resolved only at render/export time.
13614
+ */
13615
+ content: string;
13616
+ }
13617
+
13618
+ /**
13619
+ * @alpha
13620
+ */
13621
+ export declare interface IPublisherTableStyleV2 {
13622
+ fontSize?: PublisherPxV2;
13623
+ rowHeight?: PublisherPxV2;
13624
+ gridColor?: PublisherColorValueV2;
13625
+ valueColor?: PublisherColorValueV2;
13626
+ nullValueColor?: PublisherColorValueV2;
13627
+ headerLabelColor?: PublisherColorValueV2;
13628
+ headerBackgroundColor?: PublisherColorValueV2;
13629
+ totalValueColor?: PublisherColorValueV2;
13630
+ totalBackgroundColor?: PublisherColorValueV2;
13631
+ subtotalBackgroundColor?: PublisherColorValueV2;
13632
+ }
13633
+
13634
+ /**
13635
+ * @alpha
13636
+ */
13637
+ export declare interface IPublisherTakeawayGenerationV2 {
13638
+ /**
13639
+ * Appended to the preset instructions. Sent together with the document's takeaway instructions;
13640
+ * the widget's instructions win on a clash.
13641
+ */
13642
+ instructions?: string;
13643
+ /**
13644
+ * What the AI reads.
13645
+ */
13646
+ context?: {
13647
+ /**
13648
+ * Widget ids on the same page. Defaults to every visualization on the page.
13649
+ */
13650
+ widgets?: string[];
13651
+ /**
13652
+ * Defaults to `true`.
13653
+ */
13654
+ pageTitle?: boolean;
13655
+ /**
13656
+ * Filters and period. Defaults to `true`.
13657
+ */
13658
+ filters?: boolean;
13659
+ /**
13660
+ * Defaults to `false`.
13661
+ */
13662
+ otherPages?: boolean;
13663
+ };
13664
+ }
13665
+
13666
+ /**
13667
+ * @alpha
13668
+ */
13669
+ export declare interface IPublisherTakeawayWidgetV2 extends IPublisherWidgetBaseV2 {
13670
+ type: "takeaway";
13671
+ /**
13672
+ * Text defaults to a localized "Takeaway".
13673
+ */
13674
+ title?: IPublisherWidgetTitleV2;
13675
+ /**
13676
+ * The generated or written text.
13677
+ */
13678
+ markdown?: string;
13679
+ generation?: IPublisherTakeawayGenerationV2;
13680
+ style?: IPublisherTextWidgetStyleV2;
13681
+ }
13682
+
13683
+ /**
13684
+ * Current version of {@link IPublisherTextSlotV1}.
13685
+ *
13686
+ * @alpha
13687
+ */
13688
+ export declare type IPublisherTextSlot = IPublisherTextSlotV1;
13689
+
13690
+ /**
13691
+ * Slot rendering text of either kind.
13692
+ *
13693
+ * @alpha
13694
+ */
13695
+ export declare type IPublisherTextSlotV1 = IPublisherHeadingSlotV1 | IPublisherParagraphSlotV1;
13696
+
13697
+ /**
13698
+ * Current version of {@link IPublisherTextStyleV1}.
13699
+ *
13700
+ * @alpha
13701
+ */
13702
+ export declare type IPublisherTextStyle = IPublisherTextStyleV1;
13703
+
13704
+ /**
13705
+ * Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
13706
+ *
13707
+ * @alpha
13708
+ */
13709
+ export declare interface IPublisherTextStyleV1 extends IPublisherBoxStyleV1 {
13710
+ /**
13711
+ * CSS color value. Absolute, like {@link IPublisherColorBackgroundV1.color}.
13712
+ */
13713
+ color?: string;
13714
+ horizontalAlign?: PublisherContentAlignmentV1;
13715
+ verticalAlign?: PublisherContentAlignmentV1;
13716
+ }
13717
+
13718
+ /**
13719
+ * @alpha
13720
+ */
13721
+ export declare interface IPublisherTextStyleV2 extends IPublisherInheritedTextStyleV2 {
13722
+ fontSize?: PublisherPxV2;
13723
+ /**
13724
+ * 1 to 1000.
13725
+ */
13726
+ fontWeight?: number;
13727
+ fontStyle?: "normal" | "italic";
13728
+ /**
13729
+ * Multiple of the font size.
13730
+ */
13731
+ lineHeight?: number;
13732
+ /**
13733
+ * In em.
13734
+ */
13735
+ letterSpacing?: number;
13736
+ textTransform?: "none" | "uppercase" | "lowercase" | "capitalize";
13737
+ /**
13738
+ * Defaults to `shrink`.
13739
+ */
13740
+ textOverflow?: "shrink" | "clip" | "ellipsis";
13741
+ }
13742
+
13743
+ /**
13744
+ * @alpha
13745
+ */
13746
+ export declare interface IPublisherTextWidgetStyleV2 extends IPublisherBoxStyleV2, IPublisherTextStyleV2 {
13747
+ }
13748
+
13749
+ /**
13750
+ * @alpha
13751
+ */
13752
+ export declare interface IPublisherTextWidgetV2 extends IPublisherWidgetBaseV2 {
13753
+ type: "text";
13754
+ /**
13755
+ * Full markdown: paragraphs, lists, quotes and headings.
13756
+ */
13757
+ markdown?: string;
13758
+ /**
13759
+ * Page furniture such as page numbers: kept out of the accessibility tree, PDF tags and AI context.
13760
+ */
13761
+ decorative?: boolean;
13762
+ /**
13763
+ * `textStyle` defaults to `normalText`.
13764
+ */
13765
+ style?: IPublisherTextWidgetStyleV2;
13766
+ }
13767
+
13768
+ /**
13769
+ * Page title: the PowerPoint slide title and the page name for screen readers.
13770
+ *
13771
+ * @remarks
13772
+ * At most one per page. A page without one uses its first heading as the slide title.
13773
+ *
13774
+ * @alpha
13775
+ */
13776
+ export declare interface IPublisherTitleWidgetV2 extends IPublisherWidgetBaseV2 {
13777
+ type: "title";
13778
+ /**
13779
+ * Inline markdown only: strong, emphasis, highlight, strike, links and line breaks.
13780
+ */
13781
+ markdown?: string;
13782
+ /**
13783
+ * `textStyle` defaults to `title`.
13784
+ */
13785
+ style?: IPublisherTextWidgetStyleV2;
13786
+ }
13787
+
13788
+ /**
13789
+ * @alpha
13790
+ */
13791
+ export declare interface IPublisherValidationIssueV2 {
13792
+ /**
13793
+ * Where the problem is, for example `content.sections[1].pages[0].layout.children[2].id`.
13794
+ * Empty for the validated value itself.
13795
+ */
13796
+ path: string;
13797
+ message: string;
13798
+ }
13799
+
13800
+ /**
13801
+ * Current version of {@link IPublisherVariableDefinitionV1}.
13802
+ *
13803
+ * @alpha
13804
+ */
13805
+ export declare type IPublisherVariableDefinition = IPublisherVariableDefinitionV1;
13806
+
13807
+ /**
13808
+ * A custom variable declared by document content and given a value by a document.
13809
+ *
13810
+ * @remarks
13811
+ * Referenced from text as `{name}`. Values come from {@link IPublisherDocumentBaseV1.variableValues},
13812
+ * falling back to {@link IPublisherVariableDefinitionV1.defaultValue}.
13813
+ *
13814
+ * @alpha
13815
+ */
13816
+ export declare interface IPublisherVariableDefinitionV1 {
13817
+ /**
13818
+ * Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
13819
+ * Built-in names ({@link PublisherBuiltInVariableV1}) are reserved.
13820
+ */
13821
+ name: string;
13822
+ /**
13823
+ * Human readable label shown in the editor.
13824
+ */
13825
+ title?: string;
13826
+ description?: string;
13827
+ /**
13828
+ * Value used when the document does not provide one. May not contain further
13829
+ * placeholders — there is no recursive expansion.
13830
+ */
13831
+ defaultValue?: string;
13832
+ }
13833
+
13834
+ /**
13835
+ * Overrides of the saved visualization's display settings.
13836
+ *
13837
+ * @remarks
13838
+ * A key left out keeps the saved visualization's value. A key the visualization type does not
13839
+ * support is ignored.
13840
+ *
13841
+ * @alpha
13842
+ */
13843
+ export declare interface IPublisherVisualizationDisplayV2 {
13844
+ legend?: {
13845
+ visible?: boolean;
13846
+ position?: "auto" | "top" | "bottom" | "left" | "right";
13847
+ };
13848
+ xAxis?: IPublisherAxisDisplayV2;
13849
+ yAxis?: IPublisherAxisDisplayV2;
13850
+ secondaryYAxis?: IPublisherAxisDisplayV2;
13851
+ gridlines?: {
13852
+ visible?: boolean;
13853
+ };
13854
+ dataLabels?: {
13855
+ visible?: boolean | "auto";
13856
+ };
13857
+ dataPoints?: {
13858
+ visible?: boolean | "auto";
13859
+ };
13860
+ }
13861
+
13862
+ /**
13863
+ * @alpha
13864
+ */
13865
+ export declare interface IPublisherVisualizationRefV2 {
13866
+ identifier: string;
13867
+ type: "insight";
13868
+ }
13869
+
13870
+ /**
13871
+ * Current version of {@link IPublisherVisualizationSlotV1}.
13872
+ *
13873
+ * @alpha
13874
+ */
13875
+ export declare type IPublisherVisualizationSlot = IPublisherVisualizationSlotV1;
13876
+
13877
+ /**
13878
+ * Slot rendering an insight, with its own filter context.
13879
+ *
13880
+ * @alpha
13881
+ */
13882
+ export declare interface IPublisherVisualizationSlotV1 extends IPublisherSlotBaseV1 {
13883
+ type: "visualization";
13884
+ /**
13885
+ * Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
13886
+ */
13887
+ insight?: ObjRef;
13888
+ /**
13889
+ * Optional title rendered above the visualization. Supports `{variables}`.
12818
13890
  */
12819
13891
  title?: string;
12820
13892
  showTitle?: boolean;
@@ -12823,25 +13895,109 @@ export declare interface IPublisherVisualizationSlot extends IPublisherSlotBase
12823
13895
  */
12824
13896
  properties?: VisualizationProperties;
12825
13897
  /**
12826
- * Slot-level filters, applied on top of the effective content and page filters.
12827
- * A slot filter targeting the same object replaces the inherited one.
13898
+ * Slot-level filters, applied on top of the effective content and page filters.
13899
+ * A slot filter targeting the same object replaces the inherited one.
13900
+ */
13901
+ filters?: FilterContextItem[];
13902
+ /**
13903
+ * Content- and page-level filters this slot ignores (matched by display form / date dataset).
13904
+ */
13905
+ ignoredFilters?: IDashboardFilterReference[];
13906
+ /**
13907
+ * Date dataset the document's period (periodStart/periodEnd) is applied to as an
13908
+ * absolute date filter at execution time. Undefined = backend date-dataset
13909
+ * auto-resolution applies.
13910
+ */
13911
+ dateDataSet?: ObjRef;
13912
+ /**
13913
+ * When true, the implicit date filter derived from the document's period is not
13914
+ * applied to this slot.
13915
+ */
13916
+ ignoreReportPeriod?: boolean;
13917
+ }
13918
+
13919
+ /**
13920
+ * @remarks
13921
+ * Each of `chart`, `table` and `headline` applies only while the visualization renders as that kind,
13922
+ * so the style survives a switch from a chart to a table.
13923
+ *
13924
+ * @alpha
13925
+ */
13926
+ export declare interface IPublisherVisualizationStyleV2 extends IPublisherBoxStyleV2 {
13927
+ chart?: IPublisherChartStyleV2;
13928
+ table?: IPublisherTableStyleV2;
13929
+ headline?: IPublisherHeadlineStyleV2;
13930
+ }
13931
+
13932
+ /**
13933
+ * @alpha
13934
+ */
13935
+ export declare interface IPublisherVisualizationWidgetV2 extends IPublisherWidgetBaseV2 {
13936
+ type: "visualization";
13937
+ visualization?: IPublisherVisualizationRefV2;
13938
+ title?: IPublisherWidgetTitleV2;
13939
+ /**
13940
+ * Defaults to the visualization's description.
13941
+ */
13942
+ altText?: string;
13943
+ /**
13944
+ * The date dataset that the document period filters.
13945
+ */
13946
+ dateDataSet?: IPublisherDataSetRefV2;
13947
+ ignoreDocumentPeriod?: boolean;
13948
+ filters?: FilterContextItem[];
13949
+ /**
13950
+ * May name a filter the document no longer has.
13951
+ */
13952
+ ignoreDocumentFilters?: IDashboardFilterReference[];
13953
+ display?: IPublisherVisualizationDisplayV2;
13954
+ style?: IPublisherVisualizationStyleV2;
13955
+ }
13956
+
13957
+ /**
13958
+ * @remarks
13959
+ * Empty content is an absent key; `""` and `null` are invalid.
13960
+ *
13961
+ * @alpha
13962
+ */
13963
+ export declare interface IPublisherWidgetBaseV2 {
13964
+ type: PublisherWidgetTypeV2;
13965
+ /**
13966
+ * Unique within its page. Copying a page keeps widget ids as written. Matches `[A-Za-z0-9_.-]{1,64}`.
13967
+ */
13968
+ id: string;
13969
+ /**
13970
+ * Share of the parent's main axis, greater than 0. Defaults to 1.
12828
13971
  */
12829
- filters?: FilterContextItem[];
13972
+ proportion?: number;
13973
+ placeholder?: IPublisherWidgetPlaceholderV2;
12830
13974
  /**
12831
- * Content- and page-level filters this slot ignores (matched by display form / date dataset).
13975
+ * Enforced by the editor, never checked on write.
12832
13976
  */
12833
- ignoredFilters?: IDashboardFilterReference[];
13977
+ locked?: boolean;
13978
+ }
13979
+
13980
+ /**
13981
+ * @alpha
13982
+ */
13983
+ export declare interface IPublisherWidgetPlaceholderV2 {
13984
+ hint?: string;
13985
+ required?: boolean;
13986
+ }
13987
+
13988
+ /**
13989
+ * @alpha
13990
+ */
13991
+ export declare interface IPublisherWidgetTitleV2 {
12834
13992
  /**
12835
- * Date dataset the document's period (periodStart/periodEnd) is applied to as an
12836
- * absolute date filter at execution time. Undefined = backend date-dataset
12837
- * auto-resolution applies.
13993
+ * Defaults to `true`.
12838
13994
  */
12839
- dateDataSet?: ObjRef;
13995
+ visible?: boolean;
12840
13996
  /**
12841
- * When true, the implicit date filter derived from the document's period is not
12842
- * applied to this slot.
13997
+ * May contain text variables. A visible title without text shows the visualization's own title.
12843
13998
  */
12844
- ignoreReportPeriod?: boolean;
13999
+ text?: string;
14000
+ style?: IPublisherTextStyleV2;
12845
14001
  }
12846
14002
 
12847
14003
  /**
@@ -15019,229 +16175,486 @@ export declare interface ISourceInsightAttributeFilterRef {
15019
16175
  }
15020
16176
 
15021
16177
  /**
15022
- * Source insight date filter reference.
15023
- * @public
16178
+ * Source insight date filter reference.
16179
+ * @public
16180
+ */
16181
+ export declare interface ISourceInsightDateFilterRef {
16182
+ type: "dateFilter";
16183
+ dataSet: ObjRefInScope;
16184
+ }
16185
+
16186
+ /**
16187
+ * Source insight measure value filter reference.
16188
+ * @public
16189
+ */
16190
+ export declare interface ISourceInsightMeasureValueFilterRef {
16191
+ type: "measureValueFilter";
16192
+ measure: ObjRefInScope;
16193
+ }
16194
+
16195
+ /**
16196
+ * Source insight ranking filter reference.
16197
+ * @public
16198
+ */
16199
+ export declare interface ISourceInsightRankingFilterRef {
16200
+ type: "rankingFilter";
16201
+ measure: ObjRefInScope;
16202
+ }
16203
+
16204
+ /**
16205
+ * Tests whether the provided object is of type {@link IParameterMetadataObject}.
16206
+ *
16207
+ * @param obj - object to test
16208
+ * @public
16209
+ */
16210
+ export declare function isParameterMetadataObject(obj: unknown): obj is IParameterMetadataObject;
16211
+
16212
+ /**
16213
+ * Tests whether the provided object is of type {@link IParameterMetadataObjectDefinition}.
16214
+ *
16215
+ * @param obj - object to test
16216
+ * @public
16217
+ */
16218
+ export declare function isParameterMetadataObjectDefinition(obj: unknown): obj is IParameterMetadataObjectDefinition;
16219
+
16220
+ /**
16221
+ * Type guard for checking whether object is a period-over-period measure.
16222
+ *
16223
+ * @public
16224
+ */
16225
+ export declare function isPoPMeasure(obj: unknown): obj is IMeasure<IPoPMeasureDefinition>;
16226
+
16227
+ /**
16228
+ * Type guard for checking whether object is a period-over-period measure definition.
16229
+ *
16230
+ * @public
16231
+ */
16232
+ export declare function isPoPMeasureDefinition(obj: unknown): obj is IPoPMeasureDefinition;
16233
+
16234
+ /**
16235
+ * Type guard checking whether the provided object is a positive attribute filter.
16236
+ *
16237
+ * @public
16238
+ */
16239
+ export declare function isPositiveAttributeFilter(obj: unknown): obj is IPositiveAttributeFilter;
16240
+
16241
+ /**
16242
+ * Type guard for checking whether object is a previous-period measure.
16243
+ *
16244
+ * @public
16245
+ */
16246
+ export declare function isPreviousPeriodMeasure(obj: unknown): obj is IMeasure<IPreviousPeriodMeasureDefinition>;
16247
+
16248
+ /**
16249
+ * Type guard for checking whether object is a previous period measure definition.
16250
+ *
16251
+ * @public
16252
+ */
16253
+ export declare function isPreviousPeriodMeasureDefinition(obj: unknown): obj is IPreviousPeriodMeasureDefinition;
16254
+
16255
+ /**
16256
+ * @alpha
16257
+ */
16258
+ export declare function isPublisherAbsolutePeriodV2(obj: unknown): obj is IPublisherAbsolutePeriodV2;
16259
+
16260
+ /**
16261
+ * Current version of {@link isPublisherColorBackgroundV1}.
16262
+ *
16263
+ * @alpha
16264
+ */
16265
+ export declare const isPublisherColorBackground: typeof isPublisherColorBackgroundV1;
16266
+
16267
+ /**
16268
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackgroundV1}.
16269
+ *
16270
+ * @alpha
16271
+ */
16272
+ export declare function isPublisherColorBackgroundV1(obj: unknown): obj is IPublisherColorBackgroundV1;
16273
+
16274
+ /**
16275
+ * @alpha
16276
+ */
16277
+ export declare function isPublisherColumnV2(obj: unknown): obj is IPublisherContainerV2 & {
16278
+ type: "column";
16279
+ };
16280
+
16281
+ /**
16282
+ * @alpha
16283
+ */
16284
+ export declare function isPublisherContainerV2(obj: unknown): obj is IPublisherContainerV2;
16285
+
16286
+ /**
16287
+ * Current version of {@link isPublisherDocumentV1}.
16288
+ *
16289
+ * @alpha
16290
+ */
16291
+ export declare const isPublisherDocument: typeof isPublisherDocumentV1;
16292
+
16293
+ /**
16294
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContentV1}.
16295
+ *
16296
+ * @alpha
16297
+ */
16298
+ export declare function isPublisherDocumentContentV1(obj: unknown): obj is IPublisherDocumentContentV1;
16299
+
16300
+ /**
16301
+ * Current version of {@link isPublisherDocumentDefinitionV1}.
16302
+ *
16303
+ * @alpha
16304
+ */
16305
+ export declare const isPublisherDocumentDefinition: typeof isPublisherDocumentDefinitionV1;
16306
+
16307
+ /**
16308
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinitionV1}.
16309
+ *
16310
+ * @alpha
16311
+ */
16312
+ export declare function isPublisherDocumentDefinitionV1(obj: unknown): obj is IPublisherDocumentDefinitionV1;
16313
+
16314
+ /**
16315
+ * @alpha
16316
+ */
16317
+ export declare function isPublisherDocumentDefinitionV2(obj: unknown): obj is IPublisherDocumentDefinitionV2;
16318
+
16319
+ /**
16320
+ * @alpha
16321
+ */
16322
+ export declare function isPublisherDocumentPagesContentV2(obj: unknown): obj is IPublisherDocumentPagesContentV2;
16323
+
16324
+ /**
16325
+ * @alpha
16326
+ */
16327
+ export declare function isPublisherDocumentPageV2(obj: unknown): obj is IPublisherDocumentPageV2;
16328
+
16329
+ /**
16330
+ * @alpha
16331
+ */
16332
+ export declare function isPublisherDocumentSectionsContentV2(obj: unknown): obj is IPublisherDocumentSectionsContentV2;
16333
+
16334
+ /**
16335
+ * Current version of {@link isPublisherDocumentTemplateV1}.
16336
+ *
16337
+ * @alpha
16338
+ */
16339
+ export declare const isPublisherDocumentTemplate: typeof isPublisherDocumentTemplateV1;
16340
+
16341
+ /**
16342
+ * Current version of {@link isPublisherDocumentTemplateDefinitionV1}.
16343
+ *
16344
+ * @alpha
16345
+ */
16346
+ export declare const isPublisherDocumentTemplateDefinition: typeof isPublisherDocumentTemplateDefinitionV1;
16347
+
16348
+ /**
16349
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinitionV1}.
16350
+ *
16351
+ * @alpha
16352
+ */
16353
+ export declare function isPublisherDocumentTemplateDefinitionV1(obj: unknown): obj is IPublisherDocumentTemplateDefinitionV1;
16354
+
16355
+ /**
16356
+ * @alpha
16357
+ */
16358
+ export declare function isPublisherDocumentTemplateDefinitionV2(obj: unknown): obj is IPublisherDocumentTemplateDefinitionV2;
16359
+
16360
+ /**
16361
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateV1}.
16362
+ *
16363
+ * @alpha
16364
+ */
16365
+ export declare function isPublisherDocumentTemplateV1(obj: unknown): obj is IPublisherDocumentTemplateV1;
16366
+
16367
+ /**
16368
+ * @alpha
16369
+ */
16370
+ export declare function isPublisherDocumentTemplateV2(obj: unknown): obj is IPublisherDocumentTemplateV2;
16371
+
16372
+ /**
16373
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentV1}.
16374
+ *
16375
+ * @alpha
16376
+ */
16377
+ export declare function isPublisherDocumentV1(obj: unknown): obj is IPublisherDocumentV1;
16378
+
16379
+ /**
16380
+ * @alpha
16381
+ */
16382
+ export declare function isPublisherDocumentV2(obj: unknown): obj is IPublisherDocumentV2;
16383
+
16384
+ /**
16385
+ * Current version of {@link isPublisherHeadingSlotV1}.
16386
+ *
16387
+ * @alpha
16388
+ */
16389
+ export declare const isPublisherHeadingSlot: typeof isPublisherHeadingSlotV1;
16390
+
16391
+ /**
16392
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherHeadingSlotV1}.
16393
+ *
16394
+ * @alpha
16395
+ */
16396
+ export declare function isPublisherHeadingSlotV1(obj: unknown): obj is IPublisherHeadingSlotV1;
16397
+
16398
+ /**
16399
+ * Current version of {@link isPublisherHeadingTypeV1}.
16400
+ *
16401
+ * @alpha
16402
+ */
16403
+ export declare const isPublisherHeadingType: typeof isPublisherHeadingTypeV1;
16404
+
16405
+ /**
16406
+ * Type-guard testing whether the value is a {@link PublisherHeadingTypeV1}.
16407
+ *
16408
+ * @alpha
16409
+ */
16410
+ export declare function isPublisherHeadingTypeV1(value: unknown): value is PublisherHeadingTypeV1;
16411
+
16412
+ /**
16413
+ * @alpha
16414
+ */
16415
+ export declare function isPublisherHeadingWidgetV2(obj: unknown): obj is IPublisherHeadingWidgetV2;
16416
+
16417
+ /**
16418
+ * Current version of {@link isPublisherImageBackgroundV1}.
16419
+ *
16420
+ * @alpha
16421
+ */
16422
+ export declare const isPublisherImageBackground: typeof isPublisherImageBackgroundV1;
16423
+
16424
+ /**
16425
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackgroundV1}.
16426
+ *
16427
+ * @alpha
16428
+ */
16429
+ export declare function isPublisherImageBackgroundV1(obj: unknown): obj is IPublisherImageBackgroundV1;
16430
+
16431
+ /**
16432
+ * Current version of {@link isPublisherImageSlotV1}.
16433
+ *
16434
+ * @alpha
16435
+ */
16436
+ export declare const isPublisherImageSlot: typeof isPublisherImageSlotV1;
16437
+
16438
+ /**
16439
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageSlotV1}.
16440
+ *
16441
+ * @alpha
16442
+ */
16443
+ export declare function isPublisherImageSlotV1(obj: unknown): obj is IPublisherImageSlotV1;
16444
+
16445
+ /**
16446
+ * @alpha
16447
+ */
16448
+ export declare function isPublisherImageWidgetV2(obj: unknown): obj is IPublisherImageWidgetV2;
16449
+
16450
+ /**
16451
+ * Current version of {@link isPublisherLayoutSectionV1}.
16452
+ *
16453
+ * @alpha
16454
+ */
16455
+ export declare const isPublisherLayoutSection: typeof isPublisherLayoutSectionV1;
16456
+
16457
+ /**
16458
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSectionV1}.
16459
+ *
16460
+ * @alpha
16461
+ */
16462
+ export declare function isPublisherLayoutSectionV1(obj: unknown): obj is IPublisherLayoutSectionV1;
16463
+
16464
+ /**
16465
+ * Current version of {@link isPublisherLayoutSlotRefV1}.
16466
+ *
16467
+ * @alpha
15024
16468
  */
15025
- export declare interface ISourceInsightDateFilterRef {
15026
- type: "dateFilter";
15027
- dataSet: ObjRefInScope;
15028
- }
16469
+ export declare const isPublisherLayoutSlotRef: typeof isPublisherLayoutSlotRefV1;
15029
16470
 
15030
16471
  /**
15031
- * Source insight measure value filter reference.
15032
- * @public
16472
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRefV1}.
16473
+ *
16474
+ * @alpha
15033
16475
  */
15034
- export declare interface ISourceInsightMeasureValueFilterRef {
15035
- type: "measureValueFilter";
15036
- measure: ObjRefInScope;
15037
- }
16476
+ export declare function isPublisherLayoutSlotRefV1(obj: unknown): obj is IPublisherLayoutSlotRefV1;
15038
16477
 
15039
16478
  /**
15040
- * Source insight ranking filter reference.
15041
- * @public
16479
+ * @alpha
15042
16480
  */
15043
- export declare interface ISourceInsightRankingFilterRef {
15044
- type: "rankingFilter";
15045
- measure: ObjRefInScope;
15046
- }
16481
+ export declare function isPublisherPageBodyV2(obj: unknown): obj is IPublisherPageBodyV2;
15047
16482
 
15048
16483
  /**
15049
- * Tests whether the provided object is of type {@link IParameterMetadataObject}.
16484
+ * Current version of {@link isPublisherPageFormatV1}.
15050
16485
  *
15051
- * @param obj - object to test
15052
- * @public
16486
+ * @alpha
15053
16487
  */
15054
- export declare function isParameterMetadataObject(obj: unknown): obj is IParameterMetadataObject;
16488
+ export declare const isPublisherPageFormat: typeof isPublisherPageFormatV1;
15055
16489
 
15056
16490
  /**
15057
- * Tests whether the provided object is of type {@link IParameterMetadataObjectDefinition}.
16491
+ * Type-guard testing whether the provided value is a {@link PublisherPageFormatV1}.
15058
16492
  *
15059
- * @param obj - object to test
15060
- * @public
16493
+ * @alpha
15061
16494
  */
15062
- export declare function isParameterMetadataObjectDefinition(obj: unknown): obj is IParameterMetadataObjectDefinition;
16495
+ export declare function isPublisherPageFormatV1(value: unknown): value is PublisherPageFormatV1;
15063
16496
 
15064
16497
  /**
15065
- * Type guard for checking whether object is a period-over-period measure.
16498
+ * Current version of {@link isPublisherPageLayoutV1}.
15066
16499
  *
15067
- * @public
16500
+ * @alpha
15068
16501
  */
15069
- export declare function isPoPMeasure(obj: unknown): obj is IMeasure<IPoPMeasureDefinition>;
16502
+ export declare const isPublisherPageLayout: typeof isPublisherPageLayoutV1;
15070
16503
 
15071
16504
  /**
15072
- * Type guard for checking whether object is a period-over-period measure definition.
16505
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContentV1}.
15073
16506
  *
15074
- * @public
16507
+ * @alpha
15075
16508
  */
15076
- export declare function isPoPMeasureDefinition(obj: unknown): obj is IPoPMeasureDefinition;
16509
+ export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContentV1;
15077
16510
 
15078
16511
  /**
15079
- * Type guard checking whether the provided object is a positive attribute filter.
16512
+ * Current version of {@link isPublisherPageLayoutDefinitionV1}.
15080
16513
  *
15081
- * @public
16514
+ * @alpha
15082
16515
  */
15083
- export declare function isPositiveAttributeFilter(obj: unknown): obj is IPositiveAttributeFilter;
16516
+ export declare const isPublisherPageLayoutDefinition: typeof isPublisherPageLayoutDefinitionV1;
15084
16517
 
15085
16518
  /**
15086
- * Type guard for checking whether object is a previous-period measure.
16519
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinitionV1}.
15087
16520
  *
15088
- * @public
16521
+ * @alpha
15089
16522
  */
15090
- export declare function isPreviousPeriodMeasure(obj: unknown): obj is IMeasure<IPreviousPeriodMeasureDefinition>;
16523
+ export declare function isPublisherPageLayoutDefinitionV1(obj: unknown): obj is IPublisherPageLayoutDefinitionV1;
15091
16524
 
15092
16525
  /**
15093
- * Type guard for checking whether object is a previous period measure definition.
16526
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutV1}.
15094
16527
  *
15095
- * @public
16528
+ * @alpha
15096
16529
  */
15097
- export declare function isPreviousPeriodMeasureDefinition(obj: unknown): obj is IPreviousPeriodMeasureDefinition;
16530
+ export declare function isPublisherPageLayoutV1(obj: unknown): obj is IPublisherPageLayoutV1;
15098
16531
 
15099
16532
  /**
15100
- * Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackground}.
15101
- *
15102
16533
  * @alpha
15103
16534
  */
15104
- export declare function isPublisherColorBackground(obj: unknown): obj is IPublisherColorBackground;
16535
+ export declare function isPublisherPageSizeV2(value: unknown): value is PublisherPageSizeV2;
15105
16536
 
15106
16537
  /**
15107
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocument}.
15108
- *
15109
16538
  * @alpha
15110
16539
  */
15111
- export declare function isPublisherDocument(obj: unknown): obj is IPublisherDocument;
16540
+ export declare function isPublisherPageTemplateDefinitionV2(obj: unknown): obj is IPublisherPageTemplateDefinitionV2;
15112
16541
 
15113
16542
  /**
15114
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContent}.
15115
- *
15116
16543
  * @alpha
15117
16544
  */
15118
- export declare function isPublisherDocumentContentV1(obj: unknown): obj is IPublisherDocumentContent;
16545
+ export declare function isPublisherPageTemplateV2(obj: unknown): obj is IPublisherPageTemplateV2;
15119
16546
 
15120
16547
  /**
15121
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinition}.
16548
+ * Current version of {@link isPublisherParagraphSlotV1}.
15122
16549
  *
15123
16550
  * @alpha
15124
16551
  */
15125
- export declare function isPublisherDocumentDefinition(obj: unknown): obj is IPublisherDocumentDefinition;
16552
+ export declare const isPublisherParagraphSlot: typeof isPublisherParagraphSlotV1;
15126
16553
 
15127
16554
  /**
15128
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplate}.
16555
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlotV1}.
15129
16556
  *
15130
16557
  * @alpha
15131
16558
  */
15132
- export declare function isPublisherDocumentTemplate(obj: unknown): obj is IPublisherDocumentTemplate;
16559
+ export declare function isPublisherParagraphSlotV1(obj: unknown): obj is IPublisherParagraphSlotV1;
15133
16560
 
15134
16561
  /**
15135
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinition}.
16562
+ * Current version of {@link isPublisherParagraphTypeV1}.
15136
16563
  *
15137
16564
  * @alpha
15138
16565
  */
15139
- export declare function isPublisherDocumentTemplateDefinition(obj: unknown): obj is IPublisherDocumentTemplateDefinition;
16566
+ export declare const isPublisherParagraphType: typeof isPublisherParagraphTypeV1;
15140
16567
 
15141
16568
  /**
15142
- * Type-guard testing whether the provided object is an instance of {@link IPublisherHeadingSlot}.
16569
+ * Type-guard testing whether the value is a {@link PublisherParagraphTypeV1}.
15143
16570
  *
15144
16571
  * @alpha
15145
16572
  */
15146
- export declare function isPublisherHeadingSlot(obj: unknown): obj is IPublisherHeadingSlot;
16573
+ export declare function isPublisherParagraphTypeV1(value: unknown): value is PublisherParagraphTypeV1;
15147
16574
 
15148
16575
  /**
15149
- * Type-guard testing whether the value is a {@link PublisherHeadingType}.
15150
- *
15151
16576
  * @alpha
15152
16577
  */
15153
- export declare function isPublisherHeadingType(value: unknown): value is PublisherHeadingType;
16578
+ export declare function isPublisherRelativePeriodV2(obj: unknown): obj is IPublisherRelativePeriodV2;
15154
16579
 
15155
16580
  /**
15156
- * Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackground}.
15157
- *
15158
16581
  * @alpha
15159
16582
  */
15160
- export declare function isPublisherImageBackground(obj: unknown): obj is IPublisherImageBackground;
16583
+ export declare function isPublisherRowV2(obj: unknown): obj is IPublisherContainerV2 & {
16584
+ type: "row";
16585
+ };
15161
16586
 
15162
16587
  /**
15163
- * Type-guard testing whether the provided object is an instance of {@link IPublisherImageSlot}.
16588
+ * Current version of {@link isPublisherSlotV1}.
15164
16589
  *
15165
16590
  * @alpha
15166
16591
  */
15167
- export declare function isPublisherImageSlot(obj: unknown): obj is IPublisherImageSlot;
16592
+ export declare const isPublisherSlot: typeof isPublisherSlotV1;
15168
16593
 
15169
16594
  /**
15170
- * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSection}.
16595
+ * Type-guard testing whether the provided object is an instance of {@link PublisherSlotV1}.
15171
16596
  *
15172
16597
  * @alpha
15173
16598
  */
15174
- export declare function isPublisherLayoutSection(obj: unknown): obj is IPublisherLayoutSection;
16599
+ export declare function isPublisherSlotV1(obj: unknown): obj is PublisherSlotV1;
15175
16600
 
15176
16601
  /**
15177
- * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRef}.
15178
- *
15179
16602
  * @alpha
15180
16603
  */
15181
- export declare function isPublisherLayoutSlotRef(obj: unknown): obj is IPublisherLayoutSlotRef;
16604
+ export declare function isPublisherTakeawayWidgetV2(obj: unknown): obj is IPublisherTakeawayWidgetV2;
15182
16605
 
15183
16606
  /**
15184
- * Type-guard testing whether the provided value is a {@link PublisherPageFormat}.
16607
+ * Current version of {@link isPublisherTextSlotV1}.
15185
16608
  *
15186
16609
  * @alpha
15187
16610
  */
15188
- export declare function isPublisherPageFormat(value: unknown): value is PublisherPageFormat;
16611
+ export declare const isPublisherTextSlot: typeof isPublisherTextSlotV1;
15189
16612
 
15190
16613
  /**
15191
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayout}.
16614
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlotV1}.
15192
16615
  *
15193
16616
  * @alpha
15194
16617
  */
15195
- export declare function isPublisherPageLayout(obj: unknown): obj is IPublisherPageLayout;
16618
+ export declare function isPublisherTextSlotV1(obj: unknown): obj is IPublisherTextSlotV1;
15196
16619
 
15197
16620
  /**
15198
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
15199
- *
15200
16621
  * @alpha
15201
16622
  */
15202
- export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContent;
16623
+ export declare function isPublisherTextStyleNameV2(value: unknown): value is PublisherTextStyleNameV2;
15203
16624
 
15204
16625
  /**
15205
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
15206
- *
15207
16626
  * @alpha
15208
16627
  */
15209
- export declare function isPublisherPageLayoutDefinition(obj: unknown): obj is IPublisherPageLayoutDefinition;
16628
+ export declare function isPublisherTextWidgetV2(obj: unknown): obj is IPublisherTextWidgetV2;
15210
16629
 
15211
16630
  /**
15212
- * Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlot}.
15213
- *
15214
16631
  * @alpha
15215
16632
  */
15216
- export declare function isPublisherParagraphSlot(obj: unknown): obj is IPublisherParagraphSlot;
16633
+ export declare function isPublisherTitleWidgetV2(obj: unknown): obj is IPublisherTitleWidgetV2;
15217
16634
 
15218
16635
  /**
15219
- * Type-guard testing whether the value is a {@link PublisherParagraphType}.
16636
+ * Current version of {@link isPublisherVisualizationSlotV1}.
15220
16637
  *
15221
16638
  * @alpha
15222
16639
  */
15223
- export declare function isPublisherParagraphType(value: unknown): value is PublisherParagraphType;
16640
+ export declare const isPublisherVisualizationSlot: typeof isPublisherVisualizationSlotV1;
15224
16641
 
15225
16642
  /**
15226
- * Type-guard testing whether the provided object is an instance of {@link PublisherSlot}.
16643
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlotV1}.
15227
16644
  *
15228
16645
  * @alpha
15229
16646
  */
15230
- export declare function isPublisherSlot(obj: unknown): obj is PublisherSlot;
16647
+ export declare function isPublisherVisualizationSlotV1(obj: unknown): obj is IPublisherVisualizationSlotV1;
15231
16648
 
15232
16649
  /**
15233
- * Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlot}.
15234
- *
15235
16650
  * @alpha
15236
16651
  */
15237
- export declare function isPublisherTextSlot(obj: unknown): obj is IPublisherTextSlot;
16652
+ export declare function isPublisherVisualizationWidgetV2(obj: unknown): obj is IPublisherVisualizationWidgetV2;
15238
16653
 
15239
16654
  /**
15240
- * Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlot}.
15241
- *
15242
16655
  * @alpha
15243
16656
  */
15244
- export declare function isPublisherVisualizationSlot(obj: unknown): obj is IPublisherVisualizationSlot;
16657
+ export declare function isPublisherWidgetV2(obj: unknown): obj is PublisherWidgetV2;
15245
16658
 
15246
16659
  /**
15247
16660
  * Type guard checking whether the provided object is a measure value filter's range condition.
@@ -18874,17 +20287,24 @@ export declare function newAbsoluteDateFilter(dateDataSet: ObjRef | Identifier,
18874
20287
  */
18875
20288
  export declare function newAbsoluteDateFilter(dateDataSet: ObjRef | Identifier, from: string, to: string, localIdentifier?: string, emptyValueHandling?: EmptyValues): IAbsoluteDateFilter;
18876
20289
 
20290
+ /**
20291
+ * Current version of {@link newAdHocPublisherDocumentDefinitionV1}.
20292
+ *
20293
+ * @alpha
20294
+ */
20295
+ export declare const newAdHocPublisherDocumentDefinition: typeof newAdHocPublisherDocumentDefinitionV1;
20296
+
18877
20297
  /**
18878
20298
  * Creates an ad-hoc document definition not based on any template.
18879
20299
  *
18880
20300
  * @alpha
18881
20301
  */
18882
- export declare function newAdHocPublisherDocumentDefinition(options: {
20302
+ export declare function newAdHocPublisherDocumentDefinitionV1(options: {
18883
20303
  title: string;
18884
- periodStart: PublisherDateString;
18885
- periodEnd: PublisherDateString;
18886
- pages?: IPublisherDocumentPage[];
18887
- }, modifications?: Partial<Omit<IPublisherDocumentDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinition;
20304
+ periodStart: PublisherDateStringV1;
20305
+ periodEnd: PublisherDateStringV1;
20306
+ pages?: IPublisherDocumentPageV1[];
20307
+ }, modifications?: Partial<Omit<IPublisherDocumentDefinitionV1, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinitionV1;
18888
20308
 
18889
20309
  /**
18890
20310
  * Creates a new all time date filter. This filter is used to indicate that there should be no filtering on the dates.
@@ -19224,12 +20644,26 @@ export declare function newPositiveAttributeFilter(attributeOrRef: IAttribute |
19224
20644
  */
19225
20645
  export declare function newPreviousPeriodMeasure(measureIdOrLocalId: MeasureOrLocalId, dateDataSets: IPreviousPeriodDateDataSetSimple[], modifications?: MeasureModifications<PreviousPeriodMeasureBuilder>): IMeasure<IPreviousPeriodMeasureDefinition>;
19226
20646
 
20647
+ /**
20648
+ * Current version of {@link newPublisherDocumentContentV1}.
20649
+ *
20650
+ * @alpha
20651
+ */
20652
+ export declare const newPublisherDocumentContent: typeof newPublisherDocumentContentV1;
20653
+
19227
20654
  /**
19228
20655
  * Creates document content from page instances.
19229
20656
  *
19230
20657
  * @alpha
19231
20658
  */
19232
- export declare function newPublisherDocumentContent(pages: IPublisherDocumentPage[], modifications?: Partial<Omit<IPublisherDocumentContent, "version" | "pages">>): IPublisherDocumentContent;
20659
+ export declare function newPublisherDocumentContentV1(pages: IPublisherDocumentPageV1[], modifications?: Partial<Omit<IPublisherDocumentContentV1, "version" | "pages">>): IPublisherDocumentContentV1;
20660
+
20661
+ /**
20662
+ * Current version of {@link newPublisherDocumentDefinitionFromTemplateV1}.
20663
+ *
20664
+ * @alpha
20665
+ */
20666
+ export declare const newPublisherDocumentDefinitionFromTemplate: typeof newPublisherDocumentDefinitionFromTemplateV1;
19233
20667
 
19234
20668
  /**
19235
20669
  * Creates a document definition from a template.
@@ -19240,11 +20674,32 @@ export declare function newPublisherDocumentContent(pages: IPublisherDocumentPag
19240
20674
  *
19241
20675
  * @alpha
19242
20676
  */
19243
- export declare function newPublisherDocumentDefinitionFromTemplate(template: IPublisherDocumentTemplate | IPublisherDocumentTemplateDefinition, options: {
20677
+ export declare function newPublisherDocumentDefinitionFromTemplateV1(template: IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1, options: {
19244
20678
  title: string;
19245
- periodStart: PublisherDateString;
19246
- periodEnd: PublisherDateString;
19247
- }, modifications?: Partial<Omit<IPublisherDocumentDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinition;
20679
+ periodStart: PublisherDateStringV1;
20680
+ periodEnd: PublisherDateStringV1;
20681
+ }, modifications?: Partial<Omit<IPublisherDocumentDefinitionV1, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinitionV1;
20682
+
20683
+ /**
20684
+ * Generates a document filter id such as `document_filter_region_name`.
20685
+ *
20686
+ * @remarks
20687
+ * Every character of the target's identifier outside `[A-Za-z0-9_]` becomes `_`, and the id is cut to
20688
+ * 64 characters. When the document already uses the id, `_2`, `_3` and so on is appended, with the
20689
+ * base shortened so the id stays within 64 characters.
20690
+ *
20691
+ * Throws when the target is not an identifier ref.
20692
+ *
20693
+ * @alpha
20694
+ */
20695
+ export declare function newPublisherDocumentFilterIdV2({ target, usedIds, }: INewPublisherDocumentFilterIdOptionsV2): string;
20696
+
20697
+ /**
20698
+ * Current version of {@link newPublisherDocumentPageFromLayoutV1}.
20699
+ *
20700
+ * @alpha
20701
+ */
20702
+ export declare const newPublisherDocumentPageFromLayout: typeof newPublisherDocumentPageFromLayoutV1;
19248
20703
 
19249
20704
  /**
19250
20705
  * Clones a page layout into a page instance embeddable in template/document content.
@@ -19256,21 +20711,80 @@ export declare function newPublisherDocumentDefinitionFromTemplate(template: IPu
19256
20711
  *
19257
20712
  * @alpha
19258
20713
  */
19259
- export declare function newPublisherDocumentPageFromLayout(page: IPublisherPageLayout | IPublisherPageLayoutDefinition, localIdentifier?: string): IPublisherDocumentPage;
20714
+ export declare function newPublisherDocumentPageFromLayoutV1(page: IPublisherPageLayoutV1 | IPublisherPageLayoutDefinitionV1, localIdentifier?: string): IPublisherDocumentPageV1;
20715
+
20716
+ /**
20717
+ * Copies a page template's content into a new document page.
20718
+ *
20719
+ * @remarks
20720
+ * The page is a deep copy with its own page id. Widget ids stay as written, so pages made from
20721
+ * one template share widget ids; a widget is addressed by page id plus widget id.
20722
+ *
20723
+ * A document page can be passed as the template: its `id` is replaced and its `visible` is dropped.
20724
+ *
20725
+ * @alpha
20726
+ */
20727
+ export declare function newPublisherDocumentPageFromTemplateV2(body: IPublisherPageBodyV2 & Partial<Pick<IPublisherDocumentPageV2, "id" | "visible">>, id?: string): IPublisherDocumentPageV2;
20728
+
20729
+ /**
20730
+ * Current version of {@link newPublisherDocumentTemplateDefinitionV1}.
20731
+ *
20732
+ * @alpha
20733
+ */
20734
+ export declare const newPublisherDocumentTemplateDefinition: typeof newPublisherDocumentTemplateDefinitionV1;
19260
20735
 
19261
20736
  /**
19262
20737
  * Creates a new document template definition.
19263
20738
  *
19264
20739
  * @alpha
19265
20740
  */
19266
- export declare function newPublisherDocumentTemplateDefinition(title: string, content: IPublisherDocumentContent, modifications?: Partial<Omit<IPublisherDocumentTemplateDefinition, "type" | "title" | "content">>): IPublisherDocumentTemplateDefinition;
20741
+ export declare function newPublisherDocumentTemplateDefinitionV1(title: string, content: IPublisherDocumentContentV1, modifications?: Partial<Omit<IPublisherDocumentTemplateDefinitionV1, "type" | "title" | "content">>): IPublisherDocumentTemplateDefinitionV1;
20742
+
20743
+ /**
20744
+ * Generates an id such as `widget_7f3a91c4`.
20745
+ *
20746
+ * @remarks
20747
+ * For a valid id, the prefix uses only `[A-Za-z0-9_.-]`, has at most 55 characters and does not
20748
+ * start with `default.`.
20749
+ *
20750
+ * @alpha
20751
+ */
20752
+ export declare function newPublisherIdV2(prefix: string): string;
20753
+
20754
+ /**
20755
+ * Generates a page id such as `page_7f3a91c4`.
20756
+ *
20757
+ * @alpha
20758
+ */
20759
+ export declare function newPublisherPageIdV2(): string;
20760
+
20761
+ /**
20762
+ * Current version of {@link newPublisherPageLayoutDefinitionV1}.
20763
+ *
20764
+ * @alpha
20765
+ */
20766
+ export declare const newPublisherPageLayoutDefinition: typeof newPublisherPageLayoutDefinitionV1;
19267
20767
 
19268
20768
  /**
19269
20769
  * Creates a new page layout definition.
19270
20770
  *
19271
20771
  * @alpha
19272
20772
  */
19273
- export declare function newPublisherPageLayoutDefinition(title: string, body: IPublisherPageBody, modifications?: Partial<Omit<IPublisherPageLayoutDefinition, "type" | "title" | "content">>): IPublisherPageLayoutDefinition;
20773
+ export declare function newPublisherPageLayoutDefinitionV1(title: string, body: IPublisherPageBodyV1, modifications?: Partial<Omit<IPublisherPageLayoutDefinitionV1, "type" | "title" | "content">>): IPublisherPageLayoutDefinitionV1;
20774
+
20775
+ /**
20776
+ * Generates a section id such as `section_7f3a91c4`.
20777
+ *
20778
+ * @alpha
20779
+ */
20780
+ export declare function newPublisherSectionIdV2(): string;
20781
+
20782
+ /**
20783
+ * Generates a widget id such as `widget_7f3a91c4`.
20784
+ *
20785
+ * @alpha
20786
+ */
20787
+ export declare function newPublisherWidgetIdV2(): string;
19274
20788
 
19275
20789
  /**
19276
20790
  * Creates a new ranking filter.
@@ -19653,98 +21167,234 @@ export declare class PoPMeasureBuilder extends MeasureBuilderBase<IPoPMeasureDef
19653
21167
  }
19654
21168
 
19655
21169
  /**
19656
- * Input to the PoPMeasureBuilder.
19657
- * @public
21170
+ * Input to the PoPMeasureBuilder.
21171
+ * @public
21172
+ */
21173
+ export declare type PoPMeasureBuilderInput = {
21174
+ measureOrLocalId: MeasureOrLocalId;
21175
+ popAttrIdOrRef: ObjRef | Identifier;
21176
+ } | IMeasure<IPoPMeasureDefinition>;
21177
+
21178
+ /**
21179
+ * Builder for previous period measures.
21180
+ *
21181
+ * Do not instantiate this builder directly, instead use {@link newPreviousPeriodMeasure}.
21182
+ *
21183
+ * @public
21184
+ */
21185
+ export declare class PreviousPeriodMeasureBuilder extends MeasureBuilderBase<IPreviousPeriodMeasureDefinition> {
21186
+ private previousPeriodMeasure;
21187
+ /**
21188
+ * @internal
21189
+ */
21190
+ constructor(input: PreviousPeriodMeasureBuilderInput);
21191
+ /**
21192
+ * Sets master measure from which this previous period measure should be calculated.
21193
+ *
21194
+ * @param measureOrLocalId - measure value or measure local identifier
21195
+ */
21196
+ masterMeasure: (measureOrLocalId: MeasureOrLocalId) => this;
21197
+ /**
21198
+ * Sets date data set + offset within the data set to use when calculating values of this measure.
21199
+ *
21200
+ * @param dd - date data set + offset
21201
+ */
21202
+ dateDataSets: (dd: IPreviousPeriodDateDataSetSimple[]) => this;
21203
+ protected buildDefinition(): IPreviousPeriodMeasureDefinition;
21204
+ protected generateLocalId(): string;
21205
+ private convertDd;
21206
+ }
21207
+
21208
+ /**
21209
+ * Import to the PreviousPeriodMeasureBuilder.
21210
+ * @public
21211
+ */
21212
+ export declare type PreviousPeriodMeasureBuilderInput = {
21213
+ measureIdOrLocalId: MeasureOrLocalId;
21214
+ dateDataSets: IPreviousPeriodDateDataSetSimple[];
21215
+ } | IMeasure<IPreviousPeriodMeasureDefinition>;
21216
+
21217
+ /**
21218
+ * Current version of {@link PublisherBackgroundV1}.
21219
+ *
21220
+ * @alpha
21221
+ */
21222
+ export declare type PublisherBackground = PublisherBackgroundV1;
21223
+
21224
+ /**
21225
+ * What a section or page paints behind its content.
21226
+ *
21227
+ * @alpha
21228
+ */
21229
+ export declare type PublisherBackgroundV1 = IPublisherColorBackgroundV1 | IPublisherImageBackgroundV1;
21230
+
21231
+ /**
21232
+ * @alpha
21233
+ */
21234
+ export declare type PublisherBorderLineStyleV2 = "solid" | "dashed" | "dotted" | "none";
21235
+
21236
+ /**
21237
+ * Current version of {@link PublisherBuiltInVariableV1}.
21238
+ *
21239
+ * @alpha
21240
+ */
21241
+ export declare type PublisherBuiltInVariable = PublisherBuiltInVariableV1;
21242
+
21243
+ /**
21244
+ * Current version of {@link PublisherBuiltInVariablesV1}.
21245
+ *
21246
+ * @alpha
21247
+ */
21248
+ export declare const PublisherBuiltInVariables: PublisherBuiltInVariableV1[];
21249
+
21250
+ /**
21251
+ * All built-in document variable names.
21252
+ *
21253
+ * @alpha
21254
+ */
21255
+ export declare const PublisherBuiltInVariablesV1: PublisherBuiltInVariableV1[];
21256
+
21257
+ /**
21258
+ * Variables resolved by the rendering runtime; they are never declared or stored.
21259
+ *
21260
+ * @remarks
21261
+ * Referenced from document text as `{name}`. Custom variable names must not collide with these;
21262
+ * on collision the built-in wins.
21263
+ *
21264
+ * @alpha
21265
+ */
21266
+ export declare type PublisherBuiltInVariableV1 = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
21267
+
21268
+ /**
21269
+ * Theme color reference or literal color.
21270
+ *
21271
+ * @remarks
21272
+ * A reference is the whole value, never part of a longer string:
21273
+ * `{theme.colors.<list>.<id>}`, where list is `backgrounds`, `texts` or `lines`, or
21274
+ * `{theme.palette.<name>}`, where name is `primary`, `success`, `error` or `warning`.
21275
+ * The ids `default`, `surface`, `inverse`, `muted` and `accent` always resolve.
21276
+ *
21277
+ * A literal is `#rgb`, `#rrggbb`, `#rrggbbaa`, or `rgb()` with 3 or 4 arguments. `#rgba` is invalid.
21278
+ *
21279
+ * @alpha
21280
+ */
21281
+ export declare type PublisherColorValueV2 = string;
21282
+
21283
+ /**
21284
+ * Current version of {@link PublisherContentAlignmentV1}.
21285
+ *
21286
+ * @alpha
21287
+ */
21288
+ export declare type PublisherContentAlignment = PublisherContentAlignmentV1;
21289
+
21290
+ /**
21291
+ * Where content sits inside the box that carries it, along one axis.
21292
+ *
21293
+ * @alpha
21294
+ */
21295
+ export declare type PublisherContentAlignmentV1 = "start" | "center" | "end";
21296
+
21297
+ /**
21298
+ * @alpha
21299
+ */
21300
+ export declare type PublisherContentVersionV2 = "2";
21301
+
21302
+ /**
21303
+ * Current version of {@link PublisherDateStringV1}.
21304
+ *
21305
+ * @alpha
21306
+ */
21307
+ export declare type PublisherDateString = PublisherDateStringV1;
21308
+
21309
+ /**
21310
+ * ISO 8601 calendar date (YYYY-MM-DD).
21311
+ *
21312
+ * @alpha
21313
+ */
21314
+ export declare type PublisherDateStringV1 = string;
21315
+
21316
+ /**
21317
+ * Returns the sections of document content. Content stored as `pages` becomes one untitled section
21318
+ * with a generated id.
21319
+ *
21320
+ * @remarks
21321
+ * For content stored as `pages`, each call returns a new section id. Read once and keep the result
21322
+ * for as long as the section must stay the same one.
21323
+ *
21324
+ * @alpha
19658
21325
  */
19659
- export declare type PoPMeasureBuilderInput = {
19660
- measureOrLocalId: MeasureOrLocalId;
19661
- popAttrIdOrRef: ObjRef | Identifier;
19662
- } | IMeasure<IPoPMeasureDefinition>;
21326
+ export declare function publisherDocumentContentSectionsV2(content: PublisherDocumentContentV2): IPublisherSectionV2[];
19663
21327
 
19664
21328
  /**
19665
- * Builder for previous period measures.
21329
+ * Writes sections back into document content, in the shape the content was read in.
19666
21330
  *
19667
- * Do not instantiate this builder directly, instead use {@link newPreviousPeriodMeasure}.
21331
+ * @remarks
21332
+ * The result holds `sections` when the content held `sections`, when there is more than one section,
21333
+ * or when the only section has a title or description. Otherwise it holds `pages`, and the section's
21334
+ * id is dropped.
19668
21335
  *
19669
- * @public
21336
+ * @alpha
19670
21337
  */
19671
- export declare class PreviousPeriodMeasureBuilder extends MeasureBuilderBase<IPreviousPeriodMeasureDefinition> {
19672
- private previousPeriodMeasure;
19673
- /**
19674
- * @internal
19675
- */
19676
- constructor(input: PreviousPeriodMeasureBuilderInput);
19677
- /**
19678
- * Sets master measure from which this previous period measure should be calculated.
19679
- *
19680
- * @param measureOrLocalId - measure value or measure local identifier
19681
- */
19682
- masterMeasure: (measureOrLocalId: MeasureOrLocalId) => this;
19683
- /**
19684
- * Sets date data set + offset within the data set to use when calculating values of this measure.
19685
- *
19686
- * @param dd - date data set + offset
19687
- */
19688
- dateDataSets: (dd: IPreviousPeriodDateDataSetSimple[]) => this;
19689
- protected buildDefinition(): IPreviousPeriodMeasureDefinition;
19690
- protected generateLocalId(): string;
19691
- private convertDd;
19692
- }
21338
+ export declare function publisherDocumentContentSetSectionsV2({ content, sections, }: IPublisherDocumentContentSetSectionsOptionsV2): PublisherDocumentContentV2;
19693
21339
 
19694
21340
  /**
19695
- * Import to the PreviousPeriodMeasureBuilder.
19696
- * @public
21341
+ * Content of a document or a document template. It holds `pages` or `sections`, never both.
21342
+ *
21343
+ * @alpha
19697
21344
  */
19698
- export declare type PreviousPeriodMeasureBuilderInput = {
19699
- measureIdOrLocalId: MeasureOrLocalId;
19700
- dateDataSets: IPreviousPeriodDateDataSetSimple[];
19701
- } | IMeasure<IPreviousPeriodMeasureDefinition>;
21345
+ export declare type PublisherDocumentContentV2 = IPublisherDocumentPagesContentV2 | IPublisherDocumentSectionsContentV2;
19702
21346
 
19703
21347
  /**
19704
- * What a section or page paints behind its content.
21348
+ * Current version of {@link publisherDocumentPageV1}.
19705
21349
  *
19706
21350
  * @alpha
19707
21351
  */
19708
- export declare type PublisherBackground = IPublisherColorBackground | IPublisherImageBackground;
21352
+ export declare const publisherDocumentPage: typeof publisherDocumentPageV1;
19709
21353
 
19710
21354
  /**
19711
- * Variables resolved by the rendering runtime; they are never declared or stored.
19712
- *
19713
- * @remarks
19714
- * Referenced from document text as `{name}`. Custom variable names must not collide with these;
19715
- * on collision the built-in wins.
21355
+ * Convenience accessor for a document or template page by its localIdentifier.
19716
21356
  *
19717
21357
  * @alpha
19718
21358
  */
19719
- export declare type PublisherBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
21359
+ export declare function publisherDocumentPageV1(documentOrTemplate: IPublisherDocumentV1 | IPublisherDocumentDefinitionV1 | IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1, pageLocalIdentifier: string): IPublisherDocumentPageV1 | undefined;
19720
21360
 
19721
21361
  /**
19722
- * All built-in document variable names.
21362
+ * @alpha
21363
+ */
21364
+ export declare type PublisherGapValueV2 = PublisherPxV2 | "{theme.spacing.gap.compact}" | "{theme.spacing.gap.normal}" | "{theme.spacing.gap.spacious}";
21365
+
21366
+ /**
21367
+ * Text style a heading uses when its style sets none: `h(n+1)` for level n, `h6` for levels 5 and 6.
19723
21368
  *
19724
21369
  * @alpha
19725
21370
  */
19726
- export declare const PublisherBuiltInVariables: PublisherBuiltInVariable[];
21371
+ export declare function publisherHeadingDefaultTextStyleV2(level?: PublisherHeadingLevelV2): Extract<PublisherTextStyleNameV2, "h2" | "h3" | "h4" | "h5" | "h6">;
19727
21372
 
19728
21373
  /**
19729
- * Where content sits inside the box that carries it, along one axis.
21374
+ * @alpha
21375
+ */
21376
+ export declare type PublisherHeadingLevelV2 = 1 | 2 | 3 | 4 | 5 | 6;
21377
+
21378
+ /**
21379
+ * Current version of {@link PublisherHeadingTypeV1}.
19730
21380
  *
19731
21381
  * @alpha
19732
21382
  */
19733
- export declare type PublisherContentAlignment = "start" | "center" | "end";
21383
+ export declare type PublisherHeadingType = PublisherHeadingTypeV1;
19734
21384
 
19735
21385
  /**
19736
- * ISO 8601 calendar date (YYYY-MM-DD).
21386
+ * Current version of {@link PublisherHeadingTypesV1}.
19737
21387
  *
19738
21388
  * @alpha
19739
21389
  */
19740
- export declare type PublisherDateString = string;
21390
+ export declare const PublisherHeadingTypes: PublisherHeadingTypeV1[];
19741
21391
 
19742
21392
  /**
19743
- * Convenience accessor for a document or template page by its localIdentifier.
21393
+ * All heading sizes, largest first.
19744
21394
  *
19745
21395
  * @alpha
19746
21396
  */
19747
- export declare function publisherDocumentPage(documentOrTemplate: IPublisherDocument | IPublisherDocumentDefinition | IPublisherDocumentTemplate | IPublisherDocumentTemplateDefinition, pageLocalIdentifier: string): IPublisherDocumentPage | undefined;
21397
+ export declare const PublisherHeadingTypesV1: PublisherHeadingTypeV1[];
19748
21398
 
19749
21399
  /**
19750
21400
  * Size a heading is rendered at. Each size is styled by the matching theme text level
@@ -19752,14 +21402,19 @@ export declare function publisherDocumentPage(documentOrTemplate: IPublisherDocu
19752
21402
  *
19753
21403
  * @alpha
19754
21404
  */
19755
- export declare type PublisherHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
21405
+ export declare type PublisherHeadingTypeV1 = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
19756
21406
 
19757
21407
  /**
19758
- * All heading sizes, largest first.
21408
+ * @alpha
21409
+ */
21410
+ export declare type PublisherHorizontalAlignV2 = "left" | "center" | "right";
21411
+
21412
+ /**
21413
+ * Current version of {@link PublisherImageFitV1}.
19759
21414
  *
19760
21415
  * @alpha
19761
21416
  */
19762
- export declare const PublisherHeadingTypes: PublisherHeadingType[];
21417
+ export declare type PublisherImageFit = PublisherImageFitV1;
19763
21418
 
19764
21419
  /**
19765
21420
  * How an image is fitted to the area it is drawn in: kept whole inside it, filling it and cropped to
@@ -19767,14 +21422,21 @@ export declare const PublisherHeadingTypes: PublisherHeadingType[];
19767
21422
  *
19768
21423
  * @alpha
19769
21424
  */
19770
- export declare type PublisherImageFit = "contain" | "cover" | "fill";
21425
+ export declare type PublisherImageFitV1 = "contain" | "cover" | "fill";
21426
+
21427
+ /**
21428
+ * Current version of {@link PublisherImageSourceV1}.
21429
+ *
21430
+ * @alpha
21431
+ */
21432
+ export declare type PublisherImageSource = PublisherImageSourceV1;
19771
21433
 
19772
21434
  /**
19773
21435
  * What an image slot displays.
19774
21436
  *
19775
21437
  * @alpha
19776
21438
  */
19777
- export declare type PublisherImageSource = {
21439
+ export declare type PublisherImageSourceV1 = {
19778
21440
  type: "url";
19779
21441
  /**
19780
21442
  * Image URL. Supports `{variables}` — a logo slot uses `{logo}`.
@@ -19788,6 +21450,73 @@ export declare type PublisherImageSource = {
19788
21450
  ref: ObjRef;
19789
21451
  };
19790
21452
 
21453
+ /**
21454
+ * Theme image reference or https URL.
21455
+ *
21456
+ * @remarks
21457
+ * A reference is the whole value: `{theme.logo}`, `{theme.coverImage}`, `{theme.assets.logos.<id>}`
21458
+ * or `{theme.assets.images.<id>}`.
21459
+ *
21460
+ * A URL must start with `https://` and may contain text variables; each resolved value is
21461
+ * percent-encoded and the result must still start with `https://`.
21462
+ *
21463
+ * @alpha
21464
+ */
21465
+ export declare type PublisherImageSourceV2 = string;
21466
+
21467
+ /**
21468
+ * @alpha
21469
+ */
21470
+ export declare type PublisherLayoutNodeV2 = IPublisherContainerV2 | PublisherWidgetV2;
21471
+
21472
+ /**
21473
+ * Number from 0 to 1.
21474
+ *
21475
+ * @alpha
21476
+ */
21477
+ export declare type PublisherOpacityV2 = number;
21478
+
21479
+ /**
21480
+ * @alpha
21481
+ */
21482
+ export declare type PublisherPaddingValueV2 = PublisherPxV2 | "{theme.spacing.padding.compact}" | "{theme.spacing.padding.normal}" | "{theme.spacing.padding.spacious}";
21483
+
21484
+ /**
21485
+ * Current version of {@link PublisherPageFormatV1}.
21486
+ *
21487
+ * @alpha
21488
+ */
21489
+ export declare type PublisherPageFormat = PublisherPageFormatV1;
21490
+
21491
+ /**
21492
+ * Current version of {@link PublisherPageFormatAspectRatiosV1}.
21493
+ *
21494
+ * @alpha
21495
+ */
21496
+ export declare const PublisherPageFormatAspectRatios: Record<PublisherPageFormatV1, number>;
21497
+
21498
+ /**
21499
+ * Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and
21500
+ * US Letter (8.5 x 11 in) upright.
21501
+ *
21502
+ * @alpha
21503
+ */
21504
+ export declare const PublisherPageFormatAspectRatiosV1: Record<PublisherPageFormatV1, number>;
21505
+
21506
+ /**
21507
+ * Current version of {@link PublisherPageFormatsV1}.
21508
+ *
21509
+ * @alpha
21510
+ */
21511
+ export declare const PublisherPageFormats: PublisherPageFormatV1[];
21512
+
21513
+ /**
21514
+ * List of built-in page format names.
21515
+ *
21516
+ * @alpha
21517
+ */
21518
+ export declare const PublisherPageFormatsV1: PublisherPageFormatV1[];
21519
+
19791
21520
  /**
19792
21521
  * Page shape a page layout is designed for.
19793
21522
  *
@@ -19798,31 +21527,63 @@ export declare type PublisherImageSource = {
19798
21527
  *
19799
21528
  * @alpha
19800
21529
  */
19801
- export declare type PublisherPageFormat = "widescreen" | "a4Portrait" | "letterPortrait";
21530
+ export declare type PublisherPageFormatV1 = "widescreen" | "a4Portrait" | "letterPortrait";
19802
21531
 
19803
21532
  /**
19804
- * Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and
19805
- * US Letter (8.5 x 11 in) upright.
21533
+ * Editor hint; it does not change how the page renders.
19806
21534
  *
19807
21535
  * @alpha
19808
21536
  */
19809
- export declare const PublisherPageFormatAspectRatios: Record<PublisherPageFormat, number>;
21537
+ export declare type PublisherPageKindV2 = "cover" | "section" | "content";
19810
21538
 
19811
21539
  /**
19812
- * List of built-in page format names.
21540
+ * Current version of {@link PublisherPageLayoutNodeV1}.
19813
21541
  *
19814
21542
  * @alpha
19815
21543
  */
19816
- export declare const PublisherPageFormats: PublisherPageFormat[];
21544
+ export declare type PublisherPageLayoutNode = PublisherPageLayoutNodeV1;
19817
21545
 
19818
21546
  /**
19819
21547
  * Node of a page layout: a recursive row/column split tree (flexbox semantics)
19820
21548
  * over a fixed page. Leaves assign their area to slots; the tree carries geometry and
19821
- * box paint, slot content lives in {@link IPublisherPageBody.slots}.
21549
+ * box paint, slot content lives in {@link IPublisherPageBodyV1.slots}.
21550
+ *
21551
+ * @alpha
21552
+ */
21553
+ export declare type PublisherPageLayoutNodeV1 = IPublisherLayoutSectionV1 | IPublisherLayoutSlotRefV1;
21554
+
21555
+ /**
21556
+ * @alpha
21557
+ */
21558
+ export declare const PublisherPageSizesV2: readonly ["widescreen"];
21559
+
21560
+ /**
21561
+ * Page size. The widescreen design canvas is 1920 × 1080 px.
21562
+ *
21563
+ * @alpha
21564
+ */
21565
+ export declare type PublisherPageSizeV2 = (typeof PublisherPageSizesV2)[number];
21566
+
21567
+ /**
21568
+ * Current version of {@link PublisherParagraphTypeV1}.
21569
+ *
21570
+ * @alpha
21571
+ */
21572
+ export declare type PublisherParagraphType = PublisherParagraphTypeV1;
21573
+
21574
+ /**
21575
+ * Current version of {@link PublisherParagraphTypesV1}.
21576
+ *
21577
+ * @alpha
21578
+ */
21579
+ export declare const PublisherParagraphTypes: PublisherParagraphTypeV1[];
21580
+
21581
+ /**
21582
+ * All paragraph sizes, largest first.
19822
21583
  *
19823
21584
  * @alpha
19824
21585
  */
19825
- export declare type PublisherPageLayoutNode = IPublisherLayoutSection | IPublisherLayoutSlotRef;
21586
+ export declare const PublisherParagraphTypesV1: PublisherParagraphTypeV1[];
19826
21587
 
19827
21588
  /**
19828
21589
  * Size a paragraph is rendered at. Each size is styled by the matching theme text level
@@ -19830,28 +21591,82 @@ export declare type PublisherPageLayoutNode = IPublisherLayoutSection | IPublish
19830
21591
  *
19831
21592
  * @alpha
19832
21593
  */
19833
- export declare type PublisherParagraphType = "largeText" | "normalText" | "smallText";
21594
+ export declare type PublisherParagraphTypeV1 = "largeText" | "normalText" | "smallText";
19834
21595
 
19835
21596
  /**
19836
- * All paragraph sizes, largest first.
21597
+ * Reported period, in the dashboard date filter grammar without a dataset.
21598
+ *
21599
+ * @alpha
21600
+ */
21601
+ export declare type PublisherPeriodV2 = IPublisherAbsolutePeriodV2 | IPublisherRelativePeriodV2;
21602
+
21603
+ /**
21604
+ * Length in px on the page's design canvas, zero or more.
21605
+ *
21606
+ * @alpha
21607
+ */
21608
+ export declare type PublisherPxV2 = number;
21609
+
21610
+ /**
21611
+ * @alpha
21612
+ */
21613
+ export declare type PublisherRadiusValueV2 = PublisherPxV2 | "{theme.corners.small}" | "{theme.corners.medium}" | "{theme.corners.large}" | "{theme.corners.full}";
21614
+
21615
+ /**
21616
+ * `{theme.shadows.<name>}` or `none`.
21617
+ *
21618
+ * @alpha
21619
+ */
21620
+ export declare type PublisherShadowValueV2 = string;
21621
+
21622
+ /**
21623
+ * Current version of {@link PublisherSlotV1}.
19837
21624
  *
19838
21625
  * @alpha
19839
21626
  */
19840
- export declare const PublisherParagraphTypes: PublisherParagraphType[];
21627
+ export declare type PublisherSlot = PublisherSlotV1;
19841
21628
 
19842
21629
  /**
19843
21630
  * All slot types of document content version 1.
19844
21631
  *
19845
21632
  * @alpha
19846
21633
  */
19847
- export declare type PublisherSlot = IPublisherVisualizationSlot | IPublisherTextSlot | IPublisherImageSlot;
21634
+ export declare type PublisherSlotV1 = IPublisherVisualizationSlotV1 | IPublisherTextSlotV1 | IPublisherImageSlotV1;
21635
+
21636
+ /**
21637
+ * Current version of {@link publisherTextPlaceholderV1}.
21638
+ *
21639
+ * @alpha
21640
+ */
21641
+ export declare const publisherTextPlaceholder: typeof publisherTextPlaceholderV1;
19848
21642
 
19849
21643
  /**
19850
21644
  * The marker referencing the named variable from document text.
19851
21645
  *
19852
21646
  * @alpha
19853
21647
  */
19854
- export declare function publisherTextPlaceholder(name: string): string;
21648
+ export declare function publisherTextPlaceholderV1(name: string): string;
21649
+
21650
+ /**
21651
+ * Current version of {@link publisherTextSlotTypeV1}.
21652
+ *
21653
+ * @alpha
21654
+ */
21655
+ export declare const publisherTextSlotType: typeof publisherTextSlotTypeV1;
21656
+
21657
+ /**
21658
+ * Current version of {@link publisherTextSlotTypesV1}.
21659
+ *
21660
+ * @alpha
21661
+ */
21662
+ export declare const publisherTextSlotTypes: typeof publisherTextSlotTypesV1;
21663
+
21664
+ /**
21665
+ * Sizes the slot can be rendered at, which is what its own type decides.
21666
+ *
21667
+ * @alpha
21668
+ */
21669
+ export declare function publisherTextSlotTypesV1(slot: IPublisherTextSlotV1): PublisherTextTypeV1[];
19855
21670
 
19856
21671
  /**
19857
21672
  * Size the slot is rendered at.
@@ -19862,35 +21677,81 @@ export declare function publisherTextPlaceholder(name: string): string;
19862
21677
  *
19863
21678
  * @alpha
19864
21679
  */
19865
- export declare function publisherTextSlotType(slot: IPublisherTextSlot): PublisherTextType;
21680
+ export declare function publisherTextSlotTypeV1(slot: IPublisherTextSlotV1): PublisherTextTypeV1;
19866
21681
 
19867
21682
  /**
19868
- * Sizes the slot can be rendered at, which is what its own type decides.
21683
+ * Current version of {@link PublisherTextSourceV1}.
19869
21684
  *
19870
21685
  * @alpha
19871
21686
  */
19872
- export declare function publisherTextSlotTypes(slot: IPublisherTextSlot): PublisherTextType[];
21687
+ export declare type PublisherTextSource = PublisherTextSourceV1;
19873
21688
 
19874
21689
  /**
19875
21690
  * Where the text of a text slot comes from.
19876
21691
  *
19877
21692
  * @alpha
19878
21693
  */
19879
- export declare type PublisherTextSource = IPublisherStaticTextSource | IPublisherAiTextSource;
21694
+ export declare type PublisherTextSourceV1 = IPublisherStaticTextSourceV1 | IPublisherAiTextSourceV1;
19880
21695
 
19881
21696
  /**
19882
- * Size any document text is rendered at.
21697
+ * @alpha
21698
+ */
21699
+ export declare const PublisherTextStyleNamesV2: readonly ["title", "h1", "h2", "h3", "h4", "h5", "h6", "largeText", "normalText", "smallText"];
21700
+
21701
+ /**
21702
+ * Named text style from the theme's `documents.textStyle`.
21703
+ *
21704
+ * @alpha
21705
+ */
21706
+ export declare type PublisherTextStyleNameV2 = (typeof PublisherTextStyleNamesV2)[number];
21707
+
21708
+ /**
21709
+ * Current version of {@link PublisherTextTypeV1}.
21710
+ *
21711
+ * @alpha
21712
+ */
21713
+ export declare type PublisherTextType = PublisherTextTypeV1;
21714
+
21715
+ /**
21716
+ * Current version of {@link PublisherTextTypesV1}.
19883
21717
  *
19884
21718
  * @alpha
19885
21719
  */
19886
- export declare type PublisherTextType = PublisherHeadingType | PublisherParagraphType;
21720
+ export declare const PublisherTextTypes: PublisherTextTypeV1[];
19887
21721
 
19888
21722
  /**
19889
21723
  * All sizes a text slot can be rendered at, headings first.
19890
21724
  *
19891
21725
  * @alpha
19892
21726
  */
19893
- export declare const PublisherTextTypes: PublisherTextType[];
21727
+ export declare const PublisherTextTypesV1: PublisherTextTypeV1[];
21728
+
21729
+ /**
21730
+ * Size any document text is rendered at.
21731
+ *
21732
+ * @alpha
21733
+ */
21734
+ export declare type PublisherTextTypeV1 = PublisherHeadingTypeV1 | PublisherParagraphTypeV1;
21735
+
21736
+ /**
21737
+ * @alpha
21738
+ */
21739
+ export declare type PublisherVerticalAlignV2 = "top" | "center" | "bottom";
21740
+
21741
+ /**
21742
+ * @alpha
21743
+ */
21744
+ export declare const PublisherWidgetTypesV2: readonly ["title", "heading", "text", "image", "visualization", "takeaway"];
21745
+
21746
+ /**
21747
+ * @alpha
21748
+ */
21749
+ export declare type PublisherWidgetTypeV2 = (typeof PublisherWidgetTypesV2)[number];
21750
+
21751
+ /**
21752
+ * @alpha
21753
+ */
21754
+ export declare type PublisherWidgetV2 = IPublisherTitleWidgetV2 | IPublisherHeadingWidgetV2 | IPublisherTextWidgetV2 | IPublisherImageWidgetV2 | IPublisherVisualizationWidgetV2 | IPublisherTakeawayWidgetV2;
19894
21755
 
19895
21756
  /**
19896
21757
  * @public
@@ -19968,6 +21829,13 @@ export declare type RequiredSettings = Condition<Partial<IPermanentSettings | IF
19968
21829
  */
19969
21830
  export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableApplicationWorkspacePermissions>>;
19970
21831
 
21832
+ /**
21833
+ * Current version of {@link resolvePublisherTextPlaceholdersV1}.
21834
+ *
21835
+ * @alpha
21836
+ */
21837
+ export declare const resolvePublisherTextPlaceholders: typeof resolvePublisherTextPlaceholdersV1;
21838
+
19971
21839
  /**
19972
21840
  * Replaces `{variable}` markers with values. Markers with no value are left as-is.
19973
21841
  * Values are inserted verbatim — there is no recursive expansion.
@@ -19978,7 +21846,7 @@ export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableA
19978
21846
  *
19979
21847
  * @alpha
19980
21848
  */
19981
- export declare function resolvePublisherTextPlaceholders(text: string, values: Record<string, string>): string;
21849
+ export declare function resolvePublisherTextPlaceholdersV1(text: string, values: Record<string, string>): string;
19982
21850
 
19983
21851
  /**
19984
21852
  * Resolves a dashboard timezone value to a concrete IANA timezone ID: the {@link BROWSER_DETECTED}
@@ -20369,6 +22237,32 @@ export declare type UserDataFilterDefinition = IUserDataFilterDefinition | IUser
20369
22237
  */
20370
22238
  export declare function userFullName(user: IUser): string | undefined;
20371
22239
 
22240
+ /**
22241
+ * Validates the content of a document or a document template: every key, value and node type,
22242
+ * exactly one of `pages` and `sections`, page and section ids unique in the document, a `dataSet` on
22243
+ * every date filter, at most one filter per attribute display form or date dataset, and the page
22244
+ * rules on every page.
22245
+ *
22246
+ * @alpha
22247
+ */
22248
+ export declare function validatePublisherDocumentContentV2(content: unknown): IPublisherValidationIssueV2[];
22249
+
22250
+ /**
22251
+ * Validates a document, document template or page template, as a definition or as a persisted
22252
+ * object: everything its content validator checks, `version` `"2"`, `defaults.period` set on document
22253
+ * templates only, and the `default.` id prefix left to the backend's default page templates.
22254
+ *
22255
+ * @alpha
22256
+ */
22257
+ export declare function validatePublisherEntityV2(entity: unknown): IPublisherValidationIssueV2[];
22258
+
22259
+ /**
22260
+ * Current version of {@link validatePublisherPageBodyV1}.
22261
+ *
22262
+ * @alpha
22263
+ */
22264
+ export declare const validatePublisherPageBody: typeof validatePublisherPageBodyV1;
22265
+
20372
22266
  /**
20373
22267
  * Validates the structural invariants of a page body beyond what its types guarantee for content
20374
22268
  * arriving from the wire: the page format is known, slot localIdentifiers are unique, layout
@@ -20379,7 +22273,15 @@ export declare function userFullName(user: IUser): string | undefined;
20379
22273
  *
20380
22274
  * @alpha
20381
22275
  */
20382
- export declare function validatePublisherPageBody(body: IPublisherPageBody): IPublisherPageBodyValidationIssue[];
22276
+ export declare function validatePublisherPageBodyV1(body: IPublisherPageBodyV1): IPublisherPageBodyValidationIssueV1[];
22277
+
22278
+ /**
22279
+ * Validates a page body, such as a page template's content: every key, value and node type, at most
22280
+ * one title widget, and widget ids unique in the page.
22281
+ *
22282
+ * @alpha
22283
+ */
22284
+ export declare function validatePublisherPageBodyV2(body: unknown): IPublisherValidationIssueV2[];
20383
22285
 
20384
22286
  /**
20385
22287
  * Builder for virtual arithmetic measures.