@gooddata/sdk-model 11.63.0-alpha.1 → 11.63.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/esm/agentSkill/index.d.ts +1 -1
  2. package/esm/agentSkill/index.d.ts.map +1 -1
  3. package/esm/index.d.ts +8 -6
  4. package/esm/index.d.ts.map +1 -1
  5. package/esm/index.js +6 -4
  6. package/esm/publisher/aliases.d.ts +33 -33
  7. package/esm/publisher/aliases.d.ts.map +1 -1
  8. package/esm/publisher/aliases.js +25 -25
  9. package/esm/publisher/v1/content.d.ts +2 -2
  10. package/esm/publisher/v1/content.d.ts.map +1 -1
  11. package/esm/publisher/v1/defaultPageTemplates.d.ts +45 -0
  12. package/esm/publisher/v1/defaultPageTemplates.d.ts.map +1 -0
  13. package/esm/publisher/v1/{builtinPageLayouts.js → defaultPageTemplates.js} +25 -25
  14. package/esm/publisher/v1/factory.d.ts +5 -5
  15. package/esm/publisher/v1/factory.d.ts.map +1 -1
  16. package/esm/publisher/v1/factory.js +4 -4
  17. package/esm/publisher/v1/layout.d.ts +4 -4
  18. package/esm/publisher/v1/layout.d.ts.map +1 -1
  19. package/esm/publisher/v1/pageFormat.d.ts +1 -1
  20. package/esm/publisher/v1/{pageLayout.d.ts → pageTemplate.d.ts} +19 -19
  21. package/esm/publisher/v1/pageTemplate.d.ts.map +1 -0
  22. package/esm/publisher/v1/{pageLayout.js → pageTemplate.js} +7 -7
  23. package/esm/publisher/v1/slot.d.ts +1 -1
  24. package/esm/publisher/v2/themeReference.d.ts +17 -0
  25. package/esm/publisher/v2/themeReference.d.ts.map +1 -0
  26. package/esm/publisher/v2/themeReference.js +27 -0
  27. package/esm/publisher/v2/variables.d.ts +31 -0
  28. package/esm/publisher/v2/variables.d.ts.map +1 -0
  29. package/esm/publisher/v2/variables.js +59 -0
  30. package/esm/sdk-model.d.ts +479 -179
  31. package/esm/theme/index.d.ts +231 -0
  32. package/esm/theme/index.d.ts.map +1 -1
  33. package/package.json +3 -3
  34. package/esm/publisher/v1/builtinPageLayouts.d.ts +0 -45
  35. package/esm/publisher/v1/builtinPageLayouts.d.ts.map +0 -1
  36. package/esm/publisher/v1/pageLayout.d.ts.map +0 -1
@@ -43,7 +43,7 @@ export declare type AccessGranularPermission = "VIEW" | "EDIT" | "SHARE";
43
43
  *
44
44
  * @alpha
45
45
  */
46
- export declare type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "dashboard_builder" | "dashboard_editor" | "dashboard_summary" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge" | "report_builder";
46
+ export declare type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "dashboard_builder" | "dashboard_editor" | "dashboard_summary" | "document_builder" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge" | "report_builder";
47
47
 
48
48
  /**
49
49
  * Determines when an agent instruction is applied to a request.
@@ -970,105 +970,6 @@ 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
-
980
- /**
981
- * Built-in cover page: document title and subtitle.
982
- *
983
- * @alpha
984
- */
985
- export declare const BuiltInPublisherPageLayoutCoverV1: IPublisherPageLayoutV1;
986
-
987
- /**
988
- * Current version of {@link BuiltInPublisherPageLayoutPortraitCoverV1}.
989
- *
990
- * @alpha
991
- */
992
- export declare const BuiltInPublisherPageLayoutPortraitCover: IPublisherPageLayoutV1;
993
-
994
- /**
995
- * Built-in portrait cover page: document title and subtitle.
996
- *
997
- * @alpha
998
- */
999
- export declare const BuiltInPublisherPageLayoutPortraitCoverV1: IPublisherPageLayoutV1;
1000
-
1001
- /**
1002
- * Current version of {@link BuiltInPublisherPageLayoutPortraitSectionV1}.
1003
- *
1004
- * @alpha
1005
- */
1006
- export declare const BuiltInPublisherPageLayoutPortraitSection: IPublisherPageLayoutV1;
1007
-
1008
- /**
1009
- * Built-in portrait section divider page.
1010
- *
1011
- * @alpha
1012
- */
1013
- export declare const BuiltInPublisherPageLayoutPortraitSectionV1: IPublisherPageLayoutV1;
1014
-
1015
- /**
1016
- * Current version of {@link BuiltInPublisherPageLayoutPortraitSummaryV1}.
1017
- *
1018
- * @alpha
1019
- */
1020
- export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLayoutV1;
1021
-
1022
- /**
1023
- * Built-in portrait page carrying a full-page narrative, with no visualization.
1024
- *
1025
- * @alpha
1026
- */
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;
1049
-
1050
- /**
1051
- * All built-in page layouts served by the SPI. Built-ins are read-only: they cannot be
1052
- * edited or deleted, and they are never persisted on the backend.
1053
- *
1054
- * @alpha
1055
- */
1056
- export declare const BuiltInPublisherPageLayoutsV1: readonly IPublisherPageLayoutV1[];
1057
-
1058
- /**
1059
- * Current version of {@link BuiltInPublisherPageLayoutViz6TextLeftV1}.
1060
- *
1061
- * @alpha
1062
- */
1063
- export declare const BuiltInPublisherPageLayoutViz6TextLeft: IPublisherPageLayoutV1;
1064
-
1065
- /**
1066
- * Built-in content page with six visualizations and a text column on the left.
1067
- *
1068
- * @alpha
1069
- */
1070
- export declare const BuiltInPublisherPageLayoutViz6TextLeftV1: IPublisherPageLayoutV1;
1071
-
1072
973
  /**
1073
974
  * Current version of {@link BuiltInPublisherSlotTypesV1}.
1074
975
  *
@@ -1972,6 +1873,105 @@ export declare const DefaultPublisherPageFormatV1: PublisherPageFormatV1;
1972
1873
  */
1973
1874
  export declare const DefaultPublisherPageSizeV2: PublisherPageSizeV2;
1974
1875
 
1876
+ /**
1877
+ * Current version of {@link DefaultPublisherPageTemplateCoverV1}.
1878
+ *
1879
+ * @alpha
1880
+ */
1881
+ export declare const DefaultPublisherPageTemplateCover: IPublisherPageTemplateV1;
1882
+
1883
+ /**
1884
+ * Default cover page: document title and subtitle.
1885
+ *
1886
+ * @alpha
1887
+ */
1888
+ export declare const DefaultPublisherPageTemplateCoverV1: IPublisherPageTemplateV1;
1889
+
1890
+ /**
1891
+ * Current version of {@link DefaultPublisherPageTemplatePortraitCoverV1}.
1892
+ *
1893
+ * @alpha
1894
+ */
1895
+ export declare const DefaultPublisherPageTemplatePortraitCover: IPublisherPageTemplateV1;
1896
+
1897
+ /**
1898
+ * Default portrait cover page: document title and subtitle.
1899
+ *
1900
+ * @alpha
1901
+ */
1902
+ export declare const DefaultPublisherPageTemplatePortraitCoverV1: IPublisherPageTemplateV1;
1903
+
1904
+ /**
1905
+ * Current version of {@link DefaultPublisherPageTemplatePortraitSectionV1}.
1906
+ *
1907
+ * @alpha
1908
+ */
1909
+ export declare const DefaultPublisherPageTemplatePortraitSection: IPublisherPageTemplateV1;
1910
+
1911
+ /**
1912
+ * Default portrait section divider page.
1913
+ *
1914
+ * @alpha
1915
+ */
1916
+ export declare const DefaultPublisherPageTemplatePortraitSectionV1: IPublisherPageTemplateV1;
1917
+
1918
+ /**
1919
+ * Current version of {@link DefaultPublisherPageTemplatePortraitSummaryV1}.
1920
+ *
1921
+ * @alpha
1922
+ */
1923
+ export declare const DefaultPublisherPageTemplatePortraitSummary: IPublisherPageTemplateV1;
1924
+
1925
+ /**
1926
+ * Default portrait page carrying a full-page narrative, with no visualization.
1927
+ *
1928
+ * @alpha
1929
+ */
1930
+ export declare const DefaultPublisherPageTemplatePortraitSummaryV1: IPublisherPageTemplateV1;
1931
+
1932
+ /**
1933
+ * Current version of {@link DefaultPublisherPageTemplatesV1}.
1934
+ *
1935
+ * @alpha
1936
+ */
1937
+ export declare const DefaultPublisherPageTemplates: readonly IPublisherPageTemplateV1[];
1938
+
1939
+ /**
1940
+ * Current version of {@link DefaultPublisherPageTemplateSectionV1}.
1941
+ *
1942
+ * @alpha
1943
+ */
1944
+ export declare const DefaultPublisherPageTemplateSection: IPublisherPageTemplateV1;
1945
+
1946
+ /**
1947
+ * Default section divider page.
1948
+ *
1949
+ * @alpha
1950
+ */
1951
+ export declare const DefaultPublisherPageTemplateSectionV1: IPublisherPageTemplateV1;
1952
+
1953
+ /**
1954
+ * All default page templates served by the SPI. They are read-only: they cannot be
1955
+ * edited or deleted, and they are never persisted on the backend.
1956
+ *
1957
+ * @alpha
1958
+ */
1959
+ export declare const DefaultPublisherPageTemplatesV1: readonly IPublisherPageTemplateV1[];
1960
+
1961
+ /**
1962
+ * Current version of {@link DefaultPublisherPageTemplateViz6TextLeftV1}.
1963
+ *
1964
+ * @alpha
1965
+ */
1966
+ export declare const DefaultPublisherPageTemplateViz6TextLeft: IPublisherPageTemplateV1;
1967
+
1968
+ /**
1969
+ * Default content page with six visualizations and a text column on the left.
1970
+ *
1971
+ * @alpha
1972
+ */
1973
+ export declare const DefaultPublisherPageTemplateViz6TextLeftV1: IPublisherPageTemplateV1;
1974
+
1975
1975
  /**
1976
1976
  * Current version of {@link DefaultPublisherParagraphTypeV1}.
1977
1977
  *
@@ -3016,6 +3016,24 @@ export declare const getPublisherTextPlaceholders: typeof getPublisherTextPlaceh
3016
3016
  */
3017
3017
  export declare function getPublisherTextPlaceholdersV1(text: string): string[];
3018
3018
 
3019
+ /**
3020
+ * Collects the distinct `{variable}` names referenced in the text, in order of first occurrence.
3021
+ *
3022
+ * @alpha
3023
+ */
3024
+ export declare function getPublisherTextPlaceholdersV2(text: string): string[];
3025
+
3026
+ /**
3027
+ * The path of a theme reference such as `{theme.colors.texts.muted}`, as
3028
+ * `["colors", "texts", "muted"]`; undefined when the value is not one.
3029
+ *
3030
+ * @remarks
3031
+ * A theme reference is always the whole value, never part of a longer string.
3032
+ *
3033
+ * @alpha
3034
+ */
3035
+ export declare function getPublisherThemeReferencePathV2(value: unknown): string[] | undefined;
3036
+
3019
3037
  /**
3020
3038
  * Returns count of selected elements
3021
3039
  * @alpha
@@ -12832,7 +12850,7 @@ export declare interface IPublisherDocumentPagesContentV2 extends IPublisherDocu
12832
12850
  * plus its own identity.
12833
12851
  *
12834
12852
  * @remarks
12835
- * Cloning a {@link IPublisherPageLayoutV1} into content assigns the localIdentifier and regenerates
12853
+ * Cloning a {@link IPublisherPageTemplateV1} into content assigns the localIdentifier and regenerates
12836
12854
  * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
12837
12855
  * Deliberately carries NO reference back to the source page — later page edits never
12838
12856
  * affect existing templates or documents.
@@ -13192,7 +13210,7 @@ export declare interface IPublisherInheritedTextStyleV2 {
13192
13210
  export declare type IPublisherLayoutNodeBase = IPublisherLayoutNodeBaseV1;
13193
13211
 
13194
13212
  /**
13195
- * Fields common to all page layout nodes.
13213
+ * Fields common to all layout nodes.
13196
13214
  *
13197
13215
  * @alpha
13198
13216
  */
@@ -13222,7 +13240,7 @@ export declare interface IPublisherLayoutSectionV1 extends IPublisherLayoutNodeB
13222
13240
  * "row" lays children out horizontally, "column" vertically.
13223
13241
  */
13224
13242
  direction: "row" | "column";
13225
- children: PublisherPageLayoutNodeV1[];
13243
+ children: PublisherLayoutNodeV1[];
13226
13244
  /**
13227
13245
  * Paint of this section's box. Never affects how children are laid out.
13228
13246
  */
@@ -13275,7 +13293,7 @@ export declare type IPublisherPageBody = IPublisherPageBodyV1;
13275
13293
  * Body of a document page: geometry (flex split tree) plus the slots it places.
13276
13294
  *
13277
13295
  * @remarks
13278
- * This is both the content of the standalone {@link IPublisherPageLayoutV1} object and the shape
13296
+ * This is both the content of the standalone {@link IPublisherPageTemplateV1} object and the shape
13279
13297
  * embedded in template/document content ({@link IPublisherDocumentPageV1}).
13280
13298
  *
13281
13299
  * There is no header/footer chrome: page title, description, footer, page numbers and
@@ -13300,9 +13318,9 @@ export declare interface IPublisherPageBodyV1 {
13300
13318
  */
13301
13319
  style?: IPublisherBoxStyleV1;
13302
13320
  /**
13303
- * Root of the page layout tree.
13321
+ * Root of the layout tree.
13304
13322
  */
13305
- layout: PublisherPageLayoutNodeV1;
13323
+ layout: PublisherLayoutNodeV1;
13306
13324
  /**
13307
13325
  * All slots referenced by the layout, flat, keyed by localIdentifier.
13308
13326
  */
@@ -13349,25 +13367,35 @@ export declare interface IPublisherPageBodyValidationIssueV1 {
13349
13367
  }
13350
13368
 
13351
13369
  /**
13352
- * Current version of {@link IPublisherPageLayoutV1}.
13370
+ * @alpha
13371
+ */
13372
+ export declare interface IPublisherPageStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherInheritedTextStyleV2 {
13373
+ /**
13374
+ * Default gap of every container on the page.
13375
+ */
13376
+ gap?: PublisherGapValueV2;
13377
+ }
13378
+
13379
+ /**
13380
+ * Current version of {@link IPublisherPageTemplateV1}.
13353
13381
  *
13354
13382
  * @alpha
13355
13383
  */
13356
- export declare type IPublisherPageLayout = IPublisherPageLayoutV1;
13384
+ export declare type IPublisherPageTemplate = IPublisherPageTemplateV1;
13357
13385
 
13358
13386
  /**
13359
- * Current version of {@link IPublisherPageLayoutContentV1}.
13387
+ * Current version of {@link IPublisherPageTemplateContentV1}.
13360
13388
  *
13361
13389
  * @alpha
13362
13390
  */
13363
- export declare type IPublisherPageLayoutContent = IPublisherPageLayoutContentV1;
13391
+ export declare type IPublisherPageTemplateContent = IPublisherPageTemplateContentV1;
13364
13392
 
13365
13393
  /**
13366
13394
  * Stored content of the reportPage entity.
13367
13395
  *
13368
13396
  * @alpha
13369
13397
  */
13370
- export declare interface IPublisherPageLayoutContentV1 extends IPublisherPageBodyV1 {
13398
+ export declare interface IPublisherPageTemplateContentV1 extends IPublisherPageBodyV1 {
13371
13399
  /**
13372
13400
  * Content model version, for stored-content evolution.
13373
13401
  */
@@ -13375,18 +13403,18 @@ export declare interface IPublisherPageLayoutContentV1 extends IPublisherPageBod
13375
13403
  }
13376
13404
 
13377
13405
  /**
13378
- * Current version of {@link IPublisherPageLayoutDefinitionV1}.
13406
+ * Current version of {@link IPublisherPageTemplateDefinitionV1}.
13379
13407
  *
13380
13408
  * @alpha
13381
13409
  */
13382
- export declare type IPublisherPageLayoutDefinition = IPublisherPageLayoutDefinitionV1;
13410
+ export declare type IPublisherPageTemplateDefinition = IPublisherPageTemplateDefinitionV1;
13383
13411
 
13384
13412
  /**
13385
- * Payload for creating or updating a page layout.
13413
+ * Payload for creating or updating a page template.
13386
13414
  *
13387
13415
  * @alpha
13388
13416
  */
13389
- export declare interface IPublisherPageLayoutDefinitionV1 {
13417
+ export declare interface IPublisherPageTemplateDefinitionV1 {
13390
13418
  type: "reportPageLayout";
13391
13419
  /**
13392
13420
  * Present when updating an existing page.
@@ -13395,15 +13423,25 @@ export declare interface IPublisherPageLayoutDefinitionV1 {
13395
13423
  title: string;
13396
13424
  description?: string;
13397
13425
  tags?: string[];
13398
- content: IPublisherPageLayoutContentV1;
13426
+ content: IPublisherPageTemplateContentV1;
13399
13427
  }
13400
13428
 
13401
13429
  /**
13402
- * Reusable page layout metadata object.
13430
+ * Payload for creating or updating a page template.
13403
13431
  *
13404
13432
  * @alpha
13405
13433
  */
13406
- export declare interface IPublisherPageLayoutV1 extends IPublisherPageLayoutDefinitionV1, IAuditableDates, IAuditableUsers {
13434
+ export declare interface IPublisherPageTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
13435
+ type: "pageTemplate";
13436
+ content: IPublisherPageBodyV2;
13437
+ }
13438
+
13439
+ /**
13440
+ * Reusable page template metadata object.
13441
+ *
13442
+ * @alpha
13443
+ */
13444
+ export declare interface IPublisherPageTemplateV1 extends IPublisherPageTemplateDefinitionV1, IAuditableDates, IAuditableUsers {
13407
13445
  ref: ObjRef;
13408
13446
  /**
13409
13447
  * When true, the object comes from a parent workspace and is not editable
@@ -13412,29 +13450,9 @@ export declare interface IPublisherPageLayoutV1 extends IPublisherPageLayoutDefi
13412
13450
  isLocked?: boolean;
13413
13451
  /**
13414
13452
  * Predefined page shipped with the product, populated by the SPI. Never sent to or
13415
- * stored on the backend; UI must disable deletion and editing of built-in pages.
13416
- */
13417
- isBuiltIn?: boolean;
13418
- }
13419
-
13420
- /**
13421
- * @alpha
13422
- */
13423
- export declare interface IPublisherPageStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherInheritedTextStyleV2 {
13424
- /**
13425
- * Default gap of every container on the page.
13453
+ * stored on the backend; UI must disable deletion and editing of default page templates.
13426
13454
  */
13427
- gap?: PublisherGapValueV2;
13428
- }
13429
-
13430
- /**
13431
- * Payload for creating or updating a page template.
13432
- *
13433
- * @alpha
13434
- */
13435
- export declare interface IPublisherPageTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
13436
- type: "pageTemplate";
13437
- content: IPublisherPageBodyV2;
13455
+ isDefault?: boolean;
13438
13456
  }
13439
13457
 
13440
13458
  /**
@@ -13583,7 +13601,7 @@ export declare interface IPublisherSlotBaseV1 {
13583
13601
  export declare type IPublisherSlotPlaceholder = IPublisherSlotPlaceholderV1;
13584
13602
 
13585
13603
  /**
13586
- * Metadata of a slot that is intentionally left unfilled in a page layout or template.
13604
+ * Metadata of a slot that is intentionally left unfilled in a page template or document template.
13587
13605
  *
13588
13606
  * @alpha
13589
13607
  */
@@ -16499,49 +16517,49 @@ export declare const isPublisherPageFormat: typeof isPublisherPageFormatV1;
16499
16517
  export declare function isPublisherPageFormatV1(value: unknown): value is PublisherPageFormatV1;
16500
16518
 
16501
16519
  /**
16502
- * Current version of {@link isPublisherPageLayoutV1}.
16503
- *
16504
16520
  * @alpha
16505
16521
  */
16506
- export declare const isPublisherPageLayout: typeof isPublisherPageLayoutV1;
16522
+ export declare function isPublisherPageSizeV2(value: unknown): value is PublisherPageSizeV2;
16507
16523
 
16508
16524
  /**
16509
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContentV1}.
16525
+ * Current version of {@link isPublisherPageTemplateV1}.
16510
16526
  *
16511
16527
  * @alpha
16512
16528
  */
16513
- export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContentV1;
16529
+ export declare const isPublisherPageTemplate: typeof isPublisherPageTemplateV1;
16514
16530
 
16515
16531
  /**
16516
- * Current version of {@link isPublisherPageLayoutDefinitionV1}.
16532
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageTemplateContentV1}.
16517
16533
  *
16518
16534
  * @alpha
16519
16535
  */
16520
- export declare const isPublisherPageLayoutDefinition: typeof isPublisherPageLayoutDefinitionV1;
16536
+ export declare function isPublisherPageTemplateContentV1(obj: unknown): obj is IPublisherPageTemplateContentV1;
16521
16537
 
16522
16538
  /**
16523
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinitionV1}.
16539
+ * Current version of {@link isPublisherPageTemplateDefinitionV1}.
16524
16540
  *
16525
16541
  * @alpha
16526
16542
  */
16527
- export declare function isPublisherPageLayoutDefinitionV1(obj: unknown): obj is IPublisherPageLayoutDefinitionV1;
16543
+ export declare const isPublisherPageTemplateDefinition: typeof isPublisherPageTemplateDefinitionV1;
16528
16544
 
16529
16545
  /**
16530
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutV1}.
16546
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageTemplateDefinitionV1}.
16531
16547
  *
16532
16548
  * @alpha
16533
16549
  */
16534
- export declare function isPublisherPageLayoutV1(obj: unknown): obj is IPublisherPageLayoutV1;
16550
+ export declare function isPublisherPageTemplateDefinitionV1(obj: unknown): obj is IPublisherPageTemplateDefinitionV1;
16535
16551
 
16536
16552
  /**
16537
16553
  * @alpha
16538
16554
  */
16539
- export declare function isPublisherPageSizeV2(value: unknown): value is PublisherPageSizeV2;
16555
+ export declare function isPublisherPageTemplateDefinitionV2(obj: unknown): obj is IPublisherPageTemplateDefinitionV2;
16540
16556
 
16541
16557
  /**
16558
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageTemplateV1}.
16559
+ *
16542
16560
  * @alpha
16543
16561
  */
16544
- export declare function isPublisherPageTemplateDefinitionV2(obj: unknown): obj is IPublisherPageTemplateDefinitionV2;
16562
+ export declare function isPublisherPageTemplateV1(obj: unknown): obj is IPublisherPageTemplateV1;
16545
16563
 
16546
16564
  /**
16547
16565
  * @alpha
@@ -17321,6 +17339,13 @@ export declare interface ITheme {
17321
17339
  * @alpha
17322
17340
  */
17323
17341
  reports?: IThemePublisher;
17342
+ /**
17343
+ * How documents with content version 2 look. Version 1 documents read `reports` until the
17344
+ * switch to version 2.
17345
+ *
17346
+ * @alpha
17347
+ */
17348
+ documents?: IThemeDocuments;
17324
17349
  /**
17325
17350
  * Image assets offered to documents
17326
17351
  *
@@ -17939,6 +17964,239 @@ export declare interface IThemeDefinition extends Partial<IMetadataObject> {
17939
17964
  readonly theme: ITheme;
17940
17965
  }
17941
17966
 
17967
+ /**
17968
+ * How documents with content version 2 look.
17969
+ *
17970
+ * @remarks
17971
+ * A key left out falls back to the matching platform key, then the complementary palette, then the
17972
+ * built-in default. Only documents follow it; the Publisher UI around them follows the platform theme.
17973
+ *
17974
+ * @alpha
17975
+ */
17976
+ export declare interface IThemeDocuments {
17977
+ colors?: IThemeDocumentsColors;
17978
+ textStyle?: IThemeDocumentsTextStyle;
17979
+ chart?: IPublisherChartStyleV2;
17980
+ table?: IPublisherTableStyleV2;
17981
+ headline?: IPublisherHeadlineStyleV2;
17982
+ shadows?: Record<string, IThemeDocumentsShadow>;
17983
+ /**
17984
+ * The default look of a takeaway widget.
17985
+ */
17986
+ takeaway?: IPublisherTextWidgetStyleV2;
17987
+ page?: IThemeDocumentsPage;
17988
+ corners?: IThemeDocumentsCorners;
17989
+ spacing?: IThemeDocumentsSpacing;
17990
+ }
17991
+
17992
+ /**
17993
+ * A color offered to documents. Content stores its id, never its position in the list.
17994
+ *
17995
+ * @alpha
17996
+ */
17997
+ export declare interface IThemeDocumentsColor {
17998
+ id: string;
17999
+ /**
18000
+ * Absent: the role keeps its inherited value. May reference `{theme.palette.<name>}`.
18001
+ */
18002
+ color?: PublisherColorValueV2;
18003
+ }
18004
+
18005
+ /**
18006
+ * Colors offered to documents, one list per kind of paint.
18007
+ *
18008
+ * @remarks
18009
+ * The ids `default`, `surface` and `inverse` (backgrounds), `default`, `muted` and `inverse` (texts),
18010
+ * `default` (lines) and `accent` (any list) always resolve, falling back to the platform palette.
18011
+ *
18012
+ * @alpha
18013
+ */
18014
+ export declare interface IThemeDocumentsColors {
18015
+ backgrounds?: IThemeDocumentsColor[];
18016
+ texts?: IThemeDocumentsColor[];
18017
+ /**
18018
+ * Borders, dividers, accent bars, gridlines and axis lines.
18019
+ */
18020
+ lines?: IThemeDocumentsColor[];
18021
+ /**
18022
+ * Colors of visualizations: stated inline, or a reference to a color palette object. When
18023
+ * absent, documents use the workspace's active color palette.
18024
+ */
18025
+ visualizationPalette?: PublisherColorValueV2[] | IThemeColorPaletteRef;
18026
+ }
18027
+
18028
+ /**
18029
+ * Corner radius steps; `full` is built in.
18030
+ *
18031
+ * @alpha
18032
+ */
18033
+ export declare interface IThemeDocumentsCorners {
18034
+ small?: ThemeDocumentsLength;
18035
+ medium?: ThemeDocumentsLength;
18036
+ large?: ThemeDocumentsLength;
18037
+ }
18038
+
18039
+ /**
18040
+ * One hosted font file registered as a font face for documents.
18041
+ *
18042
+ * @alpha
18043
+ */
18044
+ export declare interface IThemeDocumentsFontFace {
18045
+ family: string;
18046
+ url: string;
18047
+ /**
18048
+ * `"400 700"` covers a variable font's range with one face.
18049
+ */
18050
+ weight?: number | string;
18051
+ style?: "normal" | "italic";
18052
+ unicodeRange?: string;
18053
+ }
18054
+
18055
+ /**
18056
+ * Heading text styles.
18057
+ *
18058
+ * @alpha
18059
+ */
18060
+ export declare interface IThemeDocumentsHeading extends IThemeDocumentsTextGroup {
18061
+ h1?: IThemeDocumentsTextLevel;
18062
+ h2?: IThemeDocumentsTextLevel;
18063
+ h3?: IThemeDocumentsTextLevel;
18064
+ h4?: IThemeDocumentsTextLevel;
18065
+ h5?: IThemeDocumentsTextLevel;
18066
+ h6?: IThemeDocumentsTextLevel;
18067
+ }
18068
+
18069
+ /**
18070
+ * The look of marked text: strong, emphasis, highlight or link.
18071
+ *
18072
+ * @alpha
18073
+ */
18074
+ export declare interface IThemeDocumentsMarkStyle {
18075
+ color?: PublisherColorValueV2;
18076
+ backgroundColor?: PublisherColorValueV2;
18077
+ fontWeight?: number;
18078
+ fontStyle?: "normal" | "italic";
18079
+ }
18080
+
18081
+ /**
18082
+ * Page defaults of documents.
18083
+ *
18084
+ * @alpha
18085
+ */
18086
+ export declare interface IThemeDocumentsPage {
18087
+ padding?: PublisherPaddingValueV2;
18088
+ gap?: PublisherGapValueV2;
18089
+ }
18090
+
18091
+ /**
18092
+ * A named shadow, referenced from content as `{theme.shadows.<name>}`.
18093
+ *
18094
+ * @alpha
18095
+ */
18096
+ export declare interface IThemeDocumentsShadow {
18097
+ x?: number;
18098
+ y?: number;
18099
+ blur?: ThemeDocumentsLength;
18100
+ spread?: number;
18101
+ color?: PublisherColorValueV2;
18102
+ opacity?: number;
18103
+ }
18104
+
18105
+ /**
18106
+ * Spacing scales of documents.
18107
+ *
18108
+ * @alpha
18109
+ */
18110
+ export declare interface IThemeDocumentsSpacing {
18111
+ gap?: IThemeDocumentsSteps;
18112
+ padding?: IThemeDocumentsSteps;
18113
+ }
18114
+
18115
+ /**
18116
+ * The named steps of a document spacing scale.
18117
+ *
18118
+ * @alpha
18119
+ */
18120
+ export declare interface IThemeDocumentsSteps {
18121
+ compact?: ThemeDocumentsLength;
18122
+ normal?: ThemeDocumentsLength;
18123
+ spacious?: ThemeDocumentsLength;
18124
+ }
18125
+
18126
+ /**
18127
+ * Body text styles.
18128
+ *
18129
+ * @alpha
18130
+ */
18131
+ export declare interface IThemeDocumentsText extends IThemeDocumentsTextGroup {
18132
+ largeText?: IThemeDocumentsTextLevel;
18133
+ normalText?: IThemeDocumentsTextLevel;
18134
+ smallText?: IThemeDocumentsTextLevel;
18135
+ }
18136
+
18137
+ /**
18138
+ * Values a group of text styles shares unless a level sets its own.
18139
+ *
18140
+ * @alpha
18141
+ */
18142
+ export declare interface IThemeDocumentsTextGroup {
18143
+ color?: PublisherColorValueV2;
18144
+ /**
18145
+ * A multiple of the font size.
18146
+ */
18147
+ lineHeight?: number;
18148
+ }
18149
+
18150
+ /**
18151
+ * One named text style.
18152
+ *
18153
+ * @alpha
18154
+ */
18155
+ export declare interface IThemeDocumentsTextLevel extends IThemeDocumentsTextGroup {
18156
+ fontSize?: ThemeDocumentsLength;
18157
+ }
18158
+
18159
+ /**
18160
+ * The named text styles of documents.
18161
+ *
18162
+ * @alpha
18163
+ */
18164
+ export declare interface IThemeDocumentsTextStyle {
18165
+ typography?: IThemeDocumentsTypography;
18166
+ /**
18167
+ * Falls back to `heading.h1`.
18168
+ */
18169
+ title?: IThemeDocumentsTextLevel;
18170
+ heading?: IThemeDocumentsHeading;
18171
+ text?: IThemeDocumentsText;
18172
+ /**
18173
+ * Default: bold.
18174
+ */
18175
+ strong?: IThemeDocumentsMarkStyle;
18176
+ /**
18177
+ * Default: italic.
18178
+ */
18179
+ emphasis?: IThemeDocumentsMarkStyle;
18180
+ highlight?: IThemeDocumentsMarkStyle;
18181
+ /**
18182
+ * Default color: `{theme.palette.primary}`.
18183
+ */
18184
+ link?: IThemeDocumentsMarkStyle;
18185
+ }
18186
+
18187
+ /**
18188
+ * Fonts of documents.
18189
+ *
18190
+ * @alpha
18191
+ */
18192
+ export declare interface IThemeDocumentsTypography {
18193
+ /**
18194
+ * A CSS font family list; a name with a digit must be quoted.
18195
+ */
18196
+ fontFamily?: string;
18197
+ fonts?: IThemeDocumentsFontFace[];
18198
+ }
18199
+
17942
18200
  /**
17943
18201
  *
17944
18202
  * @beta
@@ -20699,14 +20957,14 @@ export declare function newPublisherDocumentDefinitionFromTemplateV1(template: I
20699
20957
  export declare function newPublisherDocumentFilterIdV2({ target, usedIds, }: INewPublisherDocumentFilterIdOptionsV2): string;
20700
20958
 
20701
20959
  /**
20702
- * Current version of {@link newPublisherDocumentPageFromLayoutV1}.
20960
+ * Current version of {@link newPublisherDocumentPageFromTemplateV1}.
20703
20961
  *
20704
20962
  * @alpha
20705
20963
  */
20706
- export declare const newPublisherDocumentPageFromLayout: typeof newPublisherDocumentPageFromLayoutV1;
20964
+ export declare const newPublisherDocumentPageFromTemplate: typeof newPublisherDocumentPageFromTemplateV1;
20707
20965
 
20708
20966
  /**
20709
- * Clones a page layout into a page instance embeddable in template/document content.
20967
+ * Clones a page template into a page instance embeddable in template/document content.
20710
20968
  *
20711
20969
  * @remarks
20712
20970
  * The body is deep-copied and detached from the source page — no reference is kept.
@@ -20715,7 +20973,7 @@ export declare const newPublisherDocumentPageFromLayout: typeof newPublisherDocu
20715
20973
  *
20716
20974
  * @alpha
20717
20975
  */
20718
- export declare function newPublisherDocumentPageFromLayoutV1(page: IPublisherPageLayoutV1 | IPublisherPageLayoutDefinitionV1, localIdentifier?: string): IPublisherDocumentPageV1;
20976
+ export declare function newPublisherDocumentPageFromTemplateV1(page: IPublisherPageTemplateV1 | IPublisherPageTemplateDefinitionV1, localIdentifier?: string): IPublisherDocumentPageV1;
20719
20977
 
20720
20978
  /**
20721
20979
  * Copies a page template's content into a new document page.
@@ -20763,18 +21021,18 @@ export declare function newPublisherIdV2(prefix: string): string;
20763
21021
  export declare function newPublisherPageIdV2(): string;
20764
21022
 
20765
21023
  /**
20766
- * Current version of {@link newPublisherPageLayoutDefinitionV1}.
21024
+ * Current version of {@link newPublisherPageTemplateDefinitionV1}.
20767
21025
  *
20768
21026
  * @alpha
20769
21027
  */
20770
- export declare const newPublisherPageLayoutDefinition: typeof newPublisherPageLayoutDefinitionV1;
21028
+ export declare const newPublisherPageTemplateDefinition: typeof newPublisherPageTemplateDefinitionV1;
20771
21029
 
20772
21030
  /**
20773
- * Creates a new page layout definition.
21031
+ * Creates a new page template definition.
20774
21032
  *
20775
21033
  * @alpha
20776
21034
  */
20777
- export declare function newPublisherPageLayoutDefinitionV1(title: string, body: IPublisherPageBodyV1, modifications?: Partial<Omit<IPublisherPageLayoutDefinitionV1, "type" | "title" | "content">>): IPublisherPageLayoutDefinitionV1;
21035
+ export declare function newPublisherPageTemplateDefinitionV1(title: string, body: IPublisherPageBodyV1, modifications?: Partial<Omit<IPublisherPageTemplateDefinitionV1, "type" | "title" | "content">>): IPublisherPageTemplateDefinitionV1;
20778
21036
 
20779
21037
  /**
20780
21038
  * Generates a section id such as `section_7f3a91c4`.
@@ -21468,6 +21726,22 @@ export declare type PublisherImageSourceV1 = {
21468
21726
  */
21469
21727
  export declare type PublisherImageSourceV2 = string;
21470
21728
 
21729
+ /**
21730
+ * Current version of {@link PublisherLayoutNodeV1}.
21731
+ *
21732
+ * @alpha
21733
+ */
21734
+ export declare type PublisherLayoutNode = PublisherLayoutNodeV1;
21735
+
21736
+ /**
21737
+ * Node of a page's layout tree: a recursive row/column split tree (flexbox semantics)
21738
+ * over a fixed page. Leaves assign their area to slots; the tree carries geometry and
21739
+ * box paint, slot content lives in {@link IPublisherPageBodyV1.slots}.
21740
+ *
21741
+ * @alpha
21742
+ */
21743
+ export declare type PublisherLayoutNodeV1 = IPublisherLayoutSectionV1 | IPublisherLayoutSlotRefV1;
21744
+
21471
21745
  /**
21472
21746
  * @alpha
21473
21747
  */
@@ -21522,7 +21796,7 @@ export declare const PublisherPageFormats: PublisherPageFormatV1[];
21522
21796
  export declare const PublisherPageFormatsV1: PublisherPageFormatV1[];
21523
21797
 
21524
21798
  /**
21525
- * Page shape a page layout is designed for.
21799
+ * Page shape a page template is designed for.
21526
21800
  *
21527
21801
  * @remarks
21528
21802
  * A layout's geometry only reads correctly at the proportions it was authored for: a row of three
@@ -21540,22 +21814,6 @@ export declare type PublisherPageFormatV1 = "widescreen" | "a4Portrait" | "lette
21540
21814
  */
21541
21815
  export declare type PublisherPageKindV2 = "cover" | "section" | "content";
21542
21816
 
21543
- /**
21544
- * Current version of {@link PublisherPageLayoutNodeV1}.
21545
- *
21546
- * @alpha
21547
- */
21548
- export declare type PublisherPageLayoutNode = PublisherPageLayoutNodeV1;
21549
-
21550
- /**
21551
- * Node of a page layout: a recursive row/column split tree (flexbox semantics)
21552
- * over a fixed page. Leaves assign their area to slots; the tree carries geometry and
21553
- * box paint, slot content lives in {@link IPublisherPageBodyV1.slots}.
21554
- *
21555
- * @alpha
21556
- */
21557
- export declare type PublisherPageLayoutNodeV1 = IPublisherLayoutSectionV1 | IPublisherLayoutSlotRefV1;
21558
-
21559
21817
  /**
21560
21818
  * @alpha
21561
21819
  */
@@ -21651,6 +21909,13 @@ export declare const publisherTextPlaceholder: typeof publisherTextPlaceholderV1
21651
21909
  */
21652
21910
  export declare function publisherTextPlaceholderV1(name: string): string;
21653
21911
 
21912
+ /**
21913
+ * The marker referencing the variable from document text.
21914
+ *
21915
+ * @alpha
21916
+ */
21917
+ export declare function publisherTextPlaceholderV2(name: PublisherTextVariableV2): string;
21918
+
21654
21919
  /**
21655
21920
  * Current version of {@link publisherTextSlotTypeV1}.
21656
21921
  *
@@ -21737,6 +22002,27 @@ export declare const PublisherTextTypesV1: PublisherTextTypeV1[];
21737
22002
  */
21738
22003
  export declare type PublisherTextTypeV1 = PublisherHeadingTypeV1 | PublisherParagraphTypeV1;
21739
22004
 
22005
+ /**
22006
+ * All document text variable names.
22007
+ *
22008
+ * @alpha
22009
+ */
22010
+ export declare const PublisherTextVariablesV2: readonly PublisherTextVariableV2[];
22011
+
22012
+ /**
22013
+ * A variable every document resolves, referenced from text as `{name}`.
22014
+ *
22015
+ * @alpha
22016
+ */
22017
+ export declare type PublisherTextVariableV2 = "documentName" | "documentDescription" | "documentDateRange" | "documentAttributeFilters" | "periodStart" | "periodEnd" | "lastModifiedAt" | "lastModifiedBy" | "exportedAt" | "exportedBy" | "workspaceName" | "workspaceId" | "currentPageNumber" | "totalPages";
22018
+
22019
+ /**
22020
+ * The theme reference to the path, such as `{theme.assets.images.cover}`.
22021
+ *
22022
+ * @alpha
22023
+ */
22024
+ export declare function publisherThemeReferenceV2(path: readonly string[]): string;
22025
+
21740
22026
  /**
21741
22027
  * @alpha
21742
22028
  */
@@ -21852,6 +22138,13 @@ export declare const resolvePublisherTextPlaceholders: typeof resolvePublisherTe
21852
22138
  */
21853
22139
  export declare function resolvePublisherTextPlaceholdersV1(text: string, values: Record<string, string>): string;
21854
22140
 
22141
+ /**
22142
+ * Replaces `{variable}` markers with values. A marker with no value stays as typed.
22143
+ *
22144
+ * @alpha
22145
+ */
22146
+ export declare function resolvePublisherTextPlaceholdersV2(text: string, values: Partial<Record<PublisherTextVariableV2, string>>): string;
22147
+
21855
22148
  /**
21856
22149
  * Resolves a dashboard timezone value to a concrete IANA timezone ID: the {@link BROWSER_DETECTED}
21857
22150
  * sentinel resolves to the browser/runtime timezone, any other value is returned as-is.
@@ -22098,6 +22391,13 @@ export declare type ThemeColor = string;
22098
22391
  */
22099
22392
  export declare type ThemeDashboardDensity = "comfortable" | "compact";
22100
22393
 
22394
+ /**
22395
+ * A length on the document page canvas, in px. Units are not accepted.
22396
+ *
22397
+ * @alpha
22398
+ */
22399
+ export declare type ThemeDocumentsLength = number;
22400
+
22101
22401
  /**
22102
22402
  * Custom font URI which is used to override the default font
22103
22403
  *