@gooddata/sdk-model 11.62.0-alpha.2 → 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 (102) hide show
  1. package/esm/dashboard/filterContext.d.ts +1 -1
  2. package/esm/dashboard/filterContext.d.ts.map +1 -1
  3. package/esm/dashboard/filterContext.js +2 -2
  4. package/esm/dashboard/filterConverters.d.ts.map +1 -1
  5. package/esm/dashboard/filterConverters.js +10 -2
  6. package/esm/execution/filter/factory.d.ts +35 -0
  7. package/esm/execution/filter/factory.d.ts.map +1 -1
  8. package/esm/execution/filter/factory.js +5 -11
  9. package/esm/execution/filter/index.d.ts +13 -0
  10. package/esm/execution/filter/index.d.ts.map +1 -1
  11. package/esm/execution/filter/index.js +2 -0
  12. package/esm/execution/objectFactoryNotation/index.d.ts.map +1 -1
  13. package/esm/execution/objectFactoryNotation/index.js +16 -5
  14. package/esm/genAI/chat.d.ts +3 -2
  15. package/esm/genAI/chat.d.ts.map +1 -1
  16. package/esm/index.d.ts +23 -12
  17. package/esm/index.d.ts.map +1 -1
  18. package/esm/index.js +20 -10
  19. package/esm/publisher/aliases.d.ts +580 -0
  20. package/esm/publisher/aliases.d.ts.map +1 -0
  21. package/esm/publisher/aliases.js +304 -0
  22. package/esm/publisher/v1/builtinPageLayouts.d.ts +45 -0
  23. package/esm/publisher/v1/builtinPageLayouts.d.ts.map +1 -0
  24. package/esm/publisher/{builtinPageLayouts.js → v1/builtinPageLayouts.js} +14 -14
  25. package/esm/publisher/{content.d.ts → v1/content.d.ts} +14 -14
  26. package/esm/publisher/v1/content.d.ts.map +1 -0
  27. package/esm/publisher/{content.js → v1/content.js} +1 -1
  28. package/esm/publisher/{document.d.ts → v1/document.d.ts} +21 -21
  29. package/esm/publisher/v1/document.d.ts.map +1 -0
  30. package/esm/publisher/v1/document.js +35 -0
  31. package/esm/publisher/v1/factory.d.ts +65 -0
  32. package/esm/publisher/v1/factory.d.ts.map +1 -0
  33. package/esm/publisher/{factory.js → v1/factory.js} +12 -12
  34. package/esm/publisher/{layout.d.ts → v1/layout.d.ts} +13 -13
  35. package/esm/publisher/v1/layout.d.ts.map +1 -0
  36. package/esm/publisher/{layout.js → v1/layout.js} +4 -4
  37. package/esm/publisher/{pageFormat.d.ts → v1/pageFormat.d.ts} +6 -6
  38. package/esm/publisher/v1/pageFormat.d.ts.map +1 -0
  39. package/esm/publisher/{pageFormat.js → v1/pageFormat.js} +6 -6
  40. package/esm/publisher/{pageLayout.d.ts → v1/pageLayout.d.ts} +27 -27
  41. package/esm/publisher/v1/pageLayout.d.ts.map +1 -0
  42. package/esm/publisher/{pageLayout.js → v1/pageLayout.js} +18 -18
  43. package/esm/publisher/{slot.d.ts → v1/slot.d.ts} +41 -41
  44. package/esm/publisher/v1/slot.d.ts.map +1 -0
  45. package/esm/publisher/v1/slot.js +90 -0
  46. package/esm/publisher/{styling.d.ts → v1/styling.d.ts} +36 -36
  47. package/esm/publisher/v1/styling.d.ts.map +1 -0
  48. package/esm/publisher/{styling.js → v1/styling.js} +14 -14
  49. package/esm/publisher/{variables.d.ts → v1/variables.d.ts} +10 -10
  50. package/esm/publisher/v1/variables.d.ts.map +1 -0
  51. package/esm/publisher/{variables.js → v1/variables.js} +4 -4
  52. package/esm/publisher/v2/checks.d.ts +58 -0
  53. package/esm/publisher/v2/checks.d.ts.map +1 -0
  54. package/esm/publisher/v2/checks.js +100 -0
  55. package/esm/publisher/v2/content.d.ts +154 -0
  56. package/esm/publisher/v2/content.d.ts.map +1 -0
  57. package/esm/publisher/v2/content.js +34 -0
  58. package/esm/publisher/v2/document.d.ts +116 -0
  59. package/esm/publisher/v2/document.d.ts.map +1 -0
  60. package/esm/publisher/v2/document.js +47 -0
  61. package/esm/publisher/v2/factory.d.ts +69 -0
  62. package/esm/publisher/v2/factory.d.ts.map +1 -0
  63. package/esm/publisher/v2/factory.js +80 -0
  64. package/esm/publisher/v2/layout.d.ts +48 -0
  65. package/esm/publisher/v2/layout.d.ts.map +1 -0
  66. package/esm/publisher/v2/layout.js +20 -0
  67. package/esm/publisher/v2/page.d.ts +67 -0
  68. package/esm/publisher/v2/page.d.ts.map +1 -0
  69. package/esm/publisher/v2/page.js +34 -0
  70. package/esm/publisher/v2/sections.d.ts +34 -0
  71. package/esm/publisher/v2/sections.d.ts.map +1 -0
  72. package/esm/publisher/v2/sections.js +40 -0
  73. package/esm/publisher/v2/structure.d.ts +5 -0
  74. package/esm/publisher/v2/structure.d.ts.map +1 -0
  75. package/esm/publisher/v2/structure.js +533 -0
  76. package/esm/publisher/v2/style.d.ts +323 -0
  77. package/esm/publisher/v2/style.d.ts.map +1 -0
  78. package/esm/publisher/v2/style.js +22 -0
  79. package/esm/publisher/v2/validation.d.ts +26 -0
  80. package/esm/publisher/v2/validation.d.ts.map +1 -0
  81. package/esm/publisher/v2/validation.js +157 -0
  82. package/esm/publisher/v2/widget.d.ts +295 -0
  83. package/esm/publisher/v2/widget.d.ts.map +1 -0
  84. package/esm/publisher/v2/widget.js +79 -0
  85. package/esm/sdk-model.d.ts +2426 -453
  86. package/esm/settings/settings.d.ts +31 -1
  87. package/esm/settings/settings.d.ts.map +1 -1
  88. package/package.json +4 -4
  89. package/esm/publisher/builtinPageLayouts.d.ts +0 -45
  90. package/esm/publisher/builtinPageLayouts.d.ts.map +0 -1
  91. package/esm/publisher/content.d.ts.map +0 -1
  92. package/esm/publisher/document.d.ts.map +0 -1
  93. package/esm/publisher/document.js +0 -35
  94. package/esm/publisher/factory.d.ts +0 -65
  95. package/esm/publisher/factory.d.ts.map +0 -1
  96. package/esm/publisher/layout.d.ts.map +0 -1
  97. package/esm/publisher/pageFormat.d.ts.map +0 -1
  98. package/esm/publisher/pageLayout.d.ts.map +0 -1
  99. package/esm/publisher/slot.d.ts.map +0 -1
  100. package/esm/publisher/slot.js +0 -87
  101. package/esm/publisher/styling.d.ts.map +0 -1
  102. package/esm/publisher/variables.d.ts.map +0 -1
@@ -0,0 +1,304 @@
1
+ // (C) 2026 GoodData Corporation
2
+ import { BuiltInPublisherPageLayoutCoverV1, BuiltInPublisherPageLayoutPortraitCoverV1, BuiltInPublisherPageLayoutPortraitSectionV1, BuiltInPublisherPageLayoutPortraitSummaryV1, BuiltInPublisherPageLayoutSectionV1, BuiltInPublisherPageLayoutViz6TextLeftV1, BuiltInPublisherPageLayoutsV1, } from "./v1/builtinPageLayouts.js";
3
+ import { isPublisherDocumentDefinitionV1, isPublisherDocumentTemplateDefinitionV1, isPublisherDocumentTemplateV1, isPublisherDocumentV1, } from "./v1/document.js";
4
+ import { newAdHocPublisherDocumentDefinitionV1, newPublisherDocumentContentV1, newPublisherDocumentDefinitionFromTemplateV1, newPublisherDocumentPageFromLayoutV1, newPublisherDocumentTemplateDefinitionV1, newPublisherPageLayoutDefinitionV1, publisherDocumentPageV1, } from "./v1/factory.js";
5
+ import { isPublisherLayoutSectionV1, isPublisherLayoutSlotRefV1, } from "./v1/layout.js";
6
+ import { DefaultPublisherPageFormatV1, PublisherPageFormatAspectRatiosV1, PublisherPageFormatsV1, isPublisherPageFormatV1, } from "./v1/pageFormat.js";
7
+ import { isPublisherPageLayoutDefinitionV1, isPublisherPageLayoutV1, validatePublisherPageBodyV1, } from "./v1/pageLayout.js";
8
+ import { BuiltInPublisherSlotTypesV1, PublisherTextTypesV1, isPublisherHeadingSlotV1, isPublisherImageSlotV1, isPublisherParagraphSlotV1, isPublisherSlotV1, isPublisherTextSlotV1, isPublisherVisualizationSlotV1, publisherTextSlotTypeV1, publisherTextSlotTypesV1, } from "./v1/slot.js";
9
+ import { DefaultPublisherHeadingTypeV1, DefaultPublisherParagraphTypeV1, PublisherHeadingTypesV1, PublisherParagraphTypesV1, isPublisherColorBackgroundV1, isPublisherHeadingTypeV1, isPublisherImageBackgroundV1, isPublisherParagraphTypeV1, } from "./v1/styling.js";
10
+ import { PublisherBuiltInVariablesV1, getPublisherTextPlaceholdersV1, publisherTextPlaceholderV1, resolvePublisherTextPlaceholdersV1, } from "./v1/variables.js";
11
+ /**
12
+ * Current version of {@link PublisherBuiltInVariablesV1}.
13
+ *
14
+ * @alpha
15
+ */
16
+ export const PublisherBuiltInVariables = PublisherBuiltInVariablesV1;
17
+ /**
18
+ * Current version of {@link getPublisherTextPlaceholdersV1}.
19
+ *
20
+ * @alpha
21
+ */
22
+ export const getPublisherTextPlaceholders = getPublisherTextPlaceholdersV1;
23
+ /**
24
+ * Current version of {@link publisherTextPlaceholderV1}.
25
+ *
26
+ * @alpha
27
+ */
28
+ export const publisherTextPlaceholder = publisherTextPlaceholderV1;
29
+ /**
30
+ * Current version of {@link resolvePublisherTextPlaceholdersV1}.
31
+ *
32
+ * @alpha
33
+ */
34
+ export const resolvePublisherTextPlaceholders = resolvePublisherTextPlaceholdersV1;
35
+ /**
36
+ * Current version of {@link isPublisherLayoutSectionV1}.
37
+ *
38
+ * @alpha
39
+ */
40
+ export const isPublisherLayoutSection = isPublisherLayoutSectionV1;
41
+ /**
42
+ * Current version of {@link isPublisherLayoutSlotRefV1}.
43
+ *
44
+ * @alpha
45
+ */
46
+ export const isPublisherLayoutSlotRef = isPublisherLayoutSlotRefV1;
47
+ /**
48
+ * Current version of {@link BuiltInPublisherSlotTypesV1}.
49
+ *
50
+ * @alpha
51
+ */
52
+ export const BuiltInPublisherSlotTypes = BuiltInPublisherSlotTypesV1;
53
+ /**
54
+ * Current version of {@link PublisherTextTypesV1}.
55
+ *
56
+ * @alpha
57
+ */
58
+ export const PublisherTextTypes = PublisherTextTypesV1;
59
+ /**
60
+ * Current version of {@link publisherTextSlotTypeV1}.
61
+ *
62
+ * @alpha
63
+ */
64
+ export const publisherTextSlotType = publisherTextSlotTypeV1;
65
+ /**
66
+ * Current version of {@link publisherTextSlotTypesV1}.
67
+ *
68
+ * @alpha
69
+ */
70
+ export const publisherTextSlotTypes = publisherTextSlotTypesV1;
71
+ /**
72
+ * Current version of {@link isPublisherVisualizationSlotV1}.
73
+ *
74
+ * @alpha
75
+ */
76
+ export const isPublisherVisualizationSlot = isPublisherVisualizationSlotV1;
77
+ /**
78
+ * Current version of {@link isPublisherHeadingSlotV1}.
79
+ *
80
+ * @alpha
81
+ */
82
+ export const isPublisherHeadingSlot = isPublisherHeadingSlotV1;
83
+ /**
84
+ * Current version of {@link isPublisherParagraphSlotV1}.
85
+ *
86
+ * @alpha
87
+ */
88
+ export const isPublisherParagraphSlot = isPublisherParagraphSlotV1;
89
+ /**
90
+ * Current version of {@link isPublisherTextSlotV1}.
91
+ *
92
+ * @alpha
93
+ */
94
+ export const isPublisherTextSlot = isPublisherTextSlotV1;
95
+ /**
96
+ * Current version of {@link isPublisherImageSlotV1}.
97
+ *
98
+ * @alpha
99
+ */
100
+ export const isPublisherImageSlot = isPublisherImageSlotV1;
101
+ /**
102
+ * Current version of {@link isPublisherSlotV1}.
103
+ *
104
+ * @alpha
105
+ */
106
+ export const isPublisherSlot = isPublisherSlotV1;
107
+ /**
108
+ * Current version of {@link PublisherHeadingTypesV1}.
109
+ *
110
+ * @alpha
111
+ */
112
+ export const PublisherHeadingTypes = PublisherHeadingTypesV1;
113
+ /**
114
+ * Current version of {@link PublisherParagraphTypesV1}.
115
+ *
116
+ * @alpha
117
+ */
118
+ export const PublisherParagraphTypes = PublisherParagraphTypesV1;
119
+ /**
120
+ * Current version of {@link DefaultPublisherHeadingTypeV1}.
121
+ *
122
+ * @alpha
123
+ */
124
+ export const DefaultPublisherHeadingType = DefaultPublisherHeadingTypeV1;
125
+ /**
126
+ * Current version of {@link DefaultPublisherParagraphTypeV1}.
127
+ *
128
+ * @alpha
129
+ */
130
+ export const DefaultPublisherParagraphType = DefaultPublisherParagraphTypeV1;
131
+ /**
132
+ * Current version of {@link isPublisherHeadingTypeV1}.
133
+ *
134
+ * @alpha
135
+ */
136
+ export const isPublisherHeadingType = isPublisherHeadingTypeV1;
137
+ /**
138
+ * Current version of {@link isPublisherParagraphTypeV1}.
139
+ *
140
+ * @alpha
141
+ */
142
+ export const isPublisherParagraphType = isPublisherParagraphTypeV1;
143
+ /**
144
+ * Current version of {@link isPublisherColorBackgroundV1}.
145
+ *
146
+ * @alpha
147
+ */
148
+ export const isPublisherColorBackground = isPublisherColorBackgroundV1;
149
+ /**
150
+ * Current version of {@link isPublisherImageBackgroundV1}.
151
+ *
152
+ * @alpha
153
+ */
154
+ export const isPublisherImageBackground = isPublisherImageBackgroundV1;
155
+ /**
156
+ * Current version of {@link DefaultPublisherPageFormatV1}.
157
+ *
158
+ * @alpha
159
+ */
160
+ export const DefaultPublisherPageFormat = DefaultPublisherPageFormatV1;
161
+ /**
162
+ * Current version of {@link PublisherPageFormatsV1}.
163
+ *
164
+ * @alpha
165
+ */
166
+ export const PublisherPageFormats = PublisherPageFormatsV1;
167
+ /**
168
+ * Current version of {@link PublisherPageFormatAspectRatiosV1}.
169
+ *
170
+ * @alpha
171
+ */
172
+ export const PublisherPageFormatAspectRatios = PublisherPageFormatAspectRatiosV1;
173
+ /**
174
+ * Current version of {@link isPublisherPageFormatV1}.
175
+ *
176
+ * @alpha
177
+ */
178
+ export const isPublisherPageFormat = isPublisherPageFormatV1;
179
+ /**
180
+ * Current version of {@link isPublisherPageLayoutDefinitionV1}.
181
+ *
182
+ * @alpha
183
+ */
184
+ export const isPublisherPageLayoutDefinition = isPublisherPageLayoutDefinitionV1;
185
+ /**
186
+ * Current version of {@link isPublisherPageLayoutV1}.
187
+ *
188
+ * @alpha
189
+ */
190
+ export const isPublisherPageLayout = isPublisherPageLayoutV1;
191
+ /**
192
+ * Current version of {@link validatePublisherPageBodyV1}.
193
+ *
194
+ * @alpha
195
+ */
196
+ export const validatePublisherPageBody = validatePublisherPageBodyV1;
197
+ /**
198
+ * Current version of {@link isPublisherDocumentTemplateDefinitionV1}.
199
+ *
200
+ * @alpha
201
+ */
202
+ export const isPublisherDocumentTemplateDefinition = isPublisherDocumentTemplateDefinitionV1;
203
+ /**
204
+ * Current version of {@link isPublisherDocumentTemplateV1}.
205
+ *
206
+ * @alpha
207
+ */
208
+ export const isPublisherDocumentTemplate = isPublisherDocumentTemplateV1;
209
+ /**
210
+ * Current version of {@link isPublisherDocumentDefinitionV1}.
211
+ *
212
+ * @alpha
213
+ */
214
+ export const isPublisherDocumentDefinition = isPublisherDocumentDefinitionV1;
215
+ /**
216
+ * Current version of {@link isPublisherDocumentV1}.
217
+ *
218
+ * @alpha
219
+ */
220
+ export const isPublisherDocument = isPublisherDocumentV1;
221
+ /**
222
+ * Current version of {@link newPublisherPageLayoutDefinitionV1}.
223
+ *
224
+ * @alpha
225
+ */
226
+ export const newPublisherPageLayoutDefinition = newPublisherPageLayoutDefinitionV1;
227
+ /**
228
+ * Current version of {@link newPublisherDocumentPageFromLayoutV1}.
229
+ *
230
+ * @alpha
231
+ */
232
+ export const newPublisherDocumentPageFromLayout = newPublisherDocumentPageFromLayoutV1;
233
+ /**
234
+ * Current version of {@link newPublisherDocumentContentV1}.
235
+ *
236
+ * @alpha
237
+ */
238
+ export const newPublisherDocumentContent = newPublisherDocumentContentV1;
239
+ /**
240
+ * Current version of {@link newPublisherDocumentTemplateDefinitionV1}.
241
+ *
242
+ * @alpha
243
+ */
244
+ export const newPublisherDocumentTemplateDefinition = newPublisherDocumentTemplateDefinitionV1;
245
+ /**
246
+ * Current version of {@link newPublisherDocumentDefinitionFromTemplateV1}.
247
+ *
248
+ * @alpha
249
+ */
250
+ export const newPublisherDocumentDefinitionFromTemplate = newPublisherDocumentDefinitionFromTemplateV1;
251
+ /**
252
+ * Current version of {@link newAdHocPublisherDocumentDefinitionV1}.
253
+ *
254
+ * @alpha
255
+ */
256
+ export const newAdHocPublisherDocumentDefinition = newAdHocPublisherDocumentDefinitionV1;
257
+ /**
258
+ * Current version of {@link publisherDocumentPageV1}.
259
+ *
260
+ * @alpha
261
+ */
262
+ export const publisherDocumentPage = publisherDocumentPageV1;
263
+ /**
264
+ * Current version of {@link BuiltInPublisherPageLayoutCoverV1}.
265
+ *
266
+ * @alpha
267
+ */
268
+ export const BuiltInPublisherPageLayoutCover = BuiltInPublisherPageLayoutCoverV1;
269
+ /**
270
+ * Current version of {@link BuiltInPublisherPageLayoutSectionV1}.
271
+ *
272
+ * @alpha
273
+ */
274
+ export const BuiltInPublisherPageLayoutSection = BuiltInPublisherPageLayoutSectionV1;
275
+ /**
276
+ * Current version of {@link BuiltInPublisherPageLayoutViz6TextLeftV1}.
277
+ *
278
+ * @alpha
279
+ */
280
+ export const BuiltInPublisherPageLayoutViz6TextLeft = BuiltInPublisherPageLayoutViz6TextLeftV1;
281
+ /**
282
+ * Current version of {@link BuiltInPublisherPageLayoutPortraitCoverV1}.
283
+ *
284
+ * @alpha
285
+ */
286
+ export const BuiltInPublisherPageLayoutPortraitCover = BuiltInPublisherPageLayoutPortraitCoverV1;
287
+ /**
288
+ * Current version of {@link BuiltInPublisherPageLayoutPortraitSectionV1}.
289
+ *
290
+ * @alpha
291
+ */
292
+ export const BuiltInPublisherPageLayoutPortraitSection = BuiltInPublisherPageLayoutPortraitSectionV1;
293
+ /**
294
+ * Current version of {@link BuiltInPublisherPageLayoutPortraitSummaryV1}.
295
+ *
296
+ * @alpha
297
+ */
298
+ export const BuiltInPublisherPageLayoutPortraitSummary = BuiltInPublisherPageLayoutPortraitSummaryV1;
299
+ /**
300
+ * Current version of {@link BuiltInPublisherPageLayoutsV1}.
301
+ *
302
+ * @alpha
303
+ */
304
+ export const BuiltInPublisherPageLayouts = BuiltInPublisherPageLayoutsV1;
@@ -0,0 +1,45 @@
1
+ import { type IPublisherPageLayoutV1 } from "./pageLayout.js";
2
+ /**
3
+ * Built-in cover page: document title and subtitle.
4
+ *
5
+ * @alpha
6
+ */
7
+ export declare const BuiltInPublisherPageLayoutCoverV1: IPublisherPageLayoutV1;
8
+ /**
9
+ * Built-in section divider page.
10
+ *
11
+ * @alpha
12
+ */
13
+ export declare const BuiltInPublisherPageLayoutSectionV1: IPublisherPageLayoutV1;
14
+ /**
15
+ * Built-in content page with six visualizations and a text column on the left.
16
+ *
17
+ * @alpha
18
+ */
19
+ export declare const BuiltInPublisherPageLayoutViz6TextLeftV1: IPublisherPageLayoutV1;
20
+ /**
21
+ * Built-in portrait cover page: document title and subtitle.
22
+ *
23
+ * @alpha
24
+ */
25
+ export declare const BuiltInPublisherPageLayoutPortraitCoverV1: IPublisherPageLayoutV1;
26
+ /**
27
+ * Built-in portrait section divider page.
28
+ *
29
+ * @alpha
30
+ */
31
+ export declare const BuiltInPublisherPageLayoutPortraitSectionV1: IPublisherPageLayoutV1;
32
+ /**
33
+ * Built-in portrait page carrying a full-page narrative, with no visualization.
34
+ *
35
+ * @alpha
36
+ */
37
+ export declare const BuiltInPublisherPageLayoutPortraitSummaryV1: IPublisherPageLayoutV1;
38
+ /**
39
+ * All built-in page layouts served by the SPI. Built-ins are read-only: they cannot be
40
+ * edited or deleted, and they are never persisted on the backend.
41
+ *
42
+ * @alpha
43
+ */
44
+ export declare const BuiltInPublisherPageLayoutsV1: readonly IPublisherPageLayoutV1[];
45
+ //# sourceMappingURL=builtinPageLayouts.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"builtinPageLayouts.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/builtinPageLayouts.ts"],"names":[],"mappings":"AAMA,OAAO,EAA6B,KAAK,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAqLzF;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,EAAE,sBAkB9C,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,mCAAmC,EAAE,sBAahD,CAAC;AA2DH;;;;GAIG;AACH,eAAO,MAAM,wCAAwC,EAAE,sBA0BrD,CAAC;AAiDH;;;;GAIG;AACH,eAAO,MAAM,yCAAyC,EAAE,sBAkBtD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,2CAA2C,EAAE,sBAaxD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,2CAA2C,EAAE,sBAcxD,CAAC;AA8CH;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,EAAE,SAAS,sBAAsB,EAazE,CAAC"}
@@ -1,5 +1,5 @@
1
1
  // (C) 2026 GoodData Corporation
2
- import { idRef } from "../objRef/factory.js";
2
+ import { idRef } from "../../objRef/factory.js";
3
3
  const textSource = (spec) => spec.content === undefined
4
4
  ? { placeholder: { hint: spec.hint } }
5
5
  : { source: { type: "static", content: spec.content } };
@@ -124,7 +124,7 @@ const builtInPage = ({ id, title, description, body, }) => deepFreeze({
124
124
  *
125
125
  * @alpha
126
126
  */
127
- export const BuiltInPublisherPageLayoutCover = builtInPage({
127
+ export const BuiltInPublisherPageLayoutCoverV1 = builtInPage({
128
128
  id: "cover",
129
129
  title: "Cover",
130
130
  description: "Title page",
@@ -148,7 +148,7 @@ export const BuiltInPublisherPageLayoutCover = builtInPage({
148
148
  *
149
149
  * @alpha
150
150
  */
151
- export const BuiltInPublisherPageLayoutSection = builtInPage({
151
+ export const BuiltInPublisherPageLayoutSectionV1 = builtInPage({
152
152
  id: "section",
153
153
  title: "Section",
154
154
  description: "Section divider page",
@@ -222,7 +222,7 @@ const widescreenContentPages = [
222
222
  *
223
223
  * @alpha
224
224
  */
225
- export const BuiltInPublisherPageLayoutViz6TextLeft = builtInPage({
225
+ export const BuiltInPublisherPageLayoutViz6TextLeftV1 = builtInPage({
226
226
  id: "viz6TextLeft",
227
227
  title: "6 visualizations + text",
228
228
  description: "Two rows of three visualizations with a text column on the left",
@@ -280,7 +280,7 @@ const portraitContentPage = ({ vizRows, text, summary }) => {
280
280
  *
281
281
  * @alpha
282
282
  */
283
- export const BuiltInPublisherPageLayoutPortraitCover = builtInPage({
283
+ export const BuiltInPublisherPageLayoutPortraitCoverV1 = builtInPage({
284
284
  id: "portraitCover",
285
285
  title: "Cover (portrait)",
286
286
  description: "Title page of an upright document",
@@ -304,7 +304,7 @@ export const BuiltInPublisherPageLayoutPortraitCover = builtInPage({
304
304
  *
305
305
  * @alpha
306
306
  */
307
- export const BuiltInPublisherPageLayoutPortraitSection = builtInPage({
307
+ export const BuiltInPublisherPageLayoutPortraitSectionV1 = builtInPage({
308
308
  id: "portraitSection",
309
309
  title: "Section (portrait)",
310
310
  description: "Section divider page of an upright document",
@@ -323,7 +323,7 @@ export const BuiltInPublisherPageLayoutPortraitSection = builtInPage({
323
323
  *
324
324
  * @alpha
325
325
  */
326
- export const BuiltInPublisherPageLayoutPortraitSummary = builtInPage({
326
+ export const BuiltInPublisherPageLayoutPortraitSummaryV1 = builtInPage({
327
327
  id: "portraitSummary",
328
328
  title: "Summary (portrait)",
329
329
  description: "Full-page narrative with no visualization",
@@ -387,13 +387,13 @@ const portraitContentPages = [
387
387
  *
388
388
  * @alpha
389
389
  */
390
- export const BuiltInPublisherPageLayouts = Object.freeze([
391
- BuiltInPublisherPageLayoutCover,
392
- BuiltInPublisherPageLayoutSection,
390
+ export const BuiltInPublisherPageLayoutsV1 = Object.freeze([
391
+ BuiltInPublisherPageLayoutCoverV1,
392
+ BuiltInPublisherPageLayoutSectionV1,
393
393
  ...widescreenContentPages.map(([id, title, description, spec]) => builtInPage({ id, title, description, body: widescreenContentPage(spec) })),
394
- BuiltInPublisherPageLayoutViz6TextLeft,
395
- BuiltInPublisherPageLayoutPortraitCover,
396
- BuiltInPublisherPageLayoutPortraitSection,
397
- BuiltInPublisherPageLayoutPortraitSummary,
394
+ BuiltInPublisherPageLayoutViz6TextLeftV1,
395
+ BuiltInPublisherPageLayoutPortraitCoverV1,
396
+ BuiltInPublisherPageLayoutPortraitSectionV1,
397
+ BuiltInPublisherPageLayoutPortraitSummaryV1,
398
398
  ...portraitContentPages.map(([id, title, description, spec]) => builtInPage({ id, title, description, body: portraitContentPage(spec) })),
399
399
  ]);
@@ -1,20 +1,20 @@
1
- import { type IDashboardAttributeFilterConfig } from "../dashboard/dashboard.js";
2
- import { type FilterContextItem } from "../dashboard/filterContext.js";
3
- import { type IPublisherPageBody } from "./pageLayout.js";
4
- import { type IPublisherVariableDefinition } from "./variables.js";
1
+ import { type IDashboardAttributeFilterConfig } from "../../dashboard/dashboard.js";
2
+ import { type FilterContextItem } from "../../dashboard/filterContext.js";
3
+ import { type IPublisherPageBodyV1 } from "./pageLayout.js";
4
+ import { type IPublisherVariableDefinitionV1 } from "./variables.js";
5
5
  /**
6
6
  * Page instance embedded in template/document content: a deep clone of a page body
7
7
  * plus its own identity.
8
8
  *
9
9
  * @remarks
10
- * Cloning a {@link IPublisherPageLayout} into content assigns the localIdentifier and regenerates
10
+ * Cloning a {@link IPublisherPageLayoutV1} into content assigns the localIdentifier and regenerates
11
11
  * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
12
12
  * Deliberately carries NO reference back to the source page — later page edits never
13
13
  * affect existing templates or documents.
14
14
  *
15
15
  * @alpha
16
16
  */
17
- export interface IPublisherDocumentPage extends IPublisherPageBody {
17
+ export interface IPublisherDocumentPageV1 extends IPublisherPageBodyV1 {
18
18
  /**
19
19
  * Identifier unique within the content; stable across template-to-document copy and reordering.
20
20
  */
@@ -26,13 +26,13 @@ export interface IPublisherDocumentPage extends IPublisherPageBody {
26
26
  *
27
27
  * @alpha
28
28
  */
29
- export type IPublisherAttributeFilterConfig = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
29
+ export type IPublisherAttributeFilterConfigV1 = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
30
30
  /**
31
31
  * Versioned content shared verbatim by document templates and documents.
32
32
  *
33
33
  * @alpha
34
34
  */
35
- export interface IPublisherDocumentContent {
35
+ export interface IPublisherDocumentContentV1 {
36
36
  /**
37
37
  * Content model version, for stored-content evolution.
38
38
  */
@@ -40,7 +40,7 @@ export interface IPublisherDocumentContent {
40
40
  /**
41
41
  * Ordered pages of the document.
42
42
  */
43
- pages: IPublisherDocumentPage[];
43
+ pages: IPublisherDocumentPageV1[];
44
44
  /**
45
45
  * Content-level default filters; pages and slots may extend or override them.
46
46
  * The document period is NOT stored here — it is derived from periodStart/periodEnd
@@ -54,12 +54,12 @@ export interface IPublisherDocumentContent {
54
54
  * A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
55
55
  * is read as primary-label values and shown by `displayAsLabel`.
56
56
  */
57
- attributeFilterConfigs?: IPublisherAttributeFilterConfig[];
57
+ attributeFilterConfigs?: IPublisherAttributeFilterConfigV1[];
58
58
  /**
59
59
  * Custom variable declarations. Values live on the document
60
- * ({@link IPublisherDocumentBase.variableValues}).
60
+ * ({@link IPublisherDocumentBaseV1.variableValues}).
61
61
  */
62
- variables?: IPublisherVariableDefinition[];
62
+ variables?: IPublisherVariableDefinitionV1[];
63
63
  /**
64
64
  * Instructions every AI-written text without instructions of its own is generated with.
65
65
  * Supports `{variables}`.
@@ -67,9 +67,9 @@ export interface IPublisherDocumentContent {
67
67
  takeawaysInstruction?: string;
68
68
  }
69
69
  /**
70
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContent}.
70
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContentV1}.
71
71
  *
72
72
  * @alpha
73
73
  */
74
- export declare function isPublisherDocumentContentV1(obj: unknown): obj is IPublisherDocumentContent;
74
+ export declare function isPublisherDocumentContentV1(obj: unknown): obj is IPublisherDocumentContentV1;
75
75
  //# sourceMappingURL=content.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/content.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AACpF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,KAAK,8BAA8B,EAAE,MAAM,gBAAgB,CAAC;AAErE;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IAClE;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,MAAM,iCAAiC,GAAG,IAAI,CAChD,+BAA+B,EAC/B,iBAAiB,GAAG,gBAAgB,CACvC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,wBAAwB,EAAE,CAAC;IAElC;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE9B;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAE7D;;;OAGG;IACH,SAAS,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAE7C;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,2BAA2B,CAM7F"}
@@ -1,7 +1,7 @@
1
1
  // (C) 2026 GoodData Corporation
2
2
  import { isEmpty } from "lodash-es";
3
3
  /**
4
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContent}.
4
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContentV1}.
5
5
  *
6
6
  * @alpha
7
7
  */
@@ -1,13 +1,13 @@
1
- import { type IAuditableDates, type IAuditableUsers } from "../base/metadata.js";
2
- import { type ObjRef } from "../objRef/index.js";
3
- import { type IPublisherDocumentContent } from "./content.js";
4
- import { type PublisherDateString } from "./variables.js";
1
+ import { type IAuditableDates, type IAuditableUsers } from "../../base/metadata.js";
2
+ import { type ObjRef } from "../../objRef/index.js";
3
+ import { type IPublisherDocumentContentV1 } from "./content.js";
4
+ import { type PublisherDateStringV1 } from "./variables.js";
5
5
  /**
6
6
  * Payload for creating or updating a document template.
7
7
  *
8
8
  * @alpha
9
9
  */
10
- export interface IPublisherDocumentTemplateDefinition {
10
+ export interface IPublisherDocumentTemplateDefinitionV1 {
11
11
  type: "reportTemplate";
12
12
  /**
13
13
  * Present when updating an existing template.
@@ -16,14 +16,14 @@ export interface IPublisherDocumentTemplateDefinition {
16
16
  title: string;
17
17
  description?: string;
18
18
  tags?: string[];
19
- content: IPublisherDocumentContent;
19
+ content: IPublisherDocumentContentV1;
20
20
  }
21
21
  /**
22
22
  * Document template metadata object.
23
23
  *
24
24
  * @alpha
25
25
  */
26
- export interface IPublisherDocumentTemplate extends IPublisherDocumentTemplateDefinition, IAuditableDates, IAuditableUsers {
26
+ export interface IPublisherDocumentTemplateV1 extends IPublisherDocumentTemplateDefinitionV1, IAuditableDates, IAuditableUsers {
27
27
  ref: ObjRef;
28
28
  /**
29
29
  * When true, the object comes from a parent workspace and is not editable
@@ -36,7 +36,7 @@ export interface IPublisherDocumentTemplate extends IPublisherDocumentTemplateDe
36
36
  *
37
37
  * @alpha
38
38
  */
39
- export interface IPublisherDocumentBase {
39
+ export interface IPublisherDocumentBaseV1 {
40
40
  title: string;
41
41
  description?: string;
42
42
  tags?: string[];
@@ -48,17 +48,17 @@ export interface IPublisherDocumentBase {
48
48
  * visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
49
49
  * ignoreReportPeriod). Also available as `{periodStart}` in text.
50
50
  */
51
- periodStart: PublisherDateString;
51
+ periodStart: PublisherDateStringV1;
52
52
  /**
53
53
  * Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
54
54
  */
55
- periodEnd: PublisherDateString;
55
+ periodEnd: PublisherDateStringV1;
56
56
  /**
57
57
  * Content of the document. When created from a template the content is deep-copied
58
58
  * and NO reference to the template is kept — the document stays frozen while pages
59
59
  * and templates evolve.
60
60
  */
61
- content: IPublisherDocumentContent;
61
+ content: IPublisherDocumentContentV1;
62
62
  /**
63
63
  * Values for variables declared in content.variables, keyed by variable name.
64
64
  */
@@ -69,7 +69,7 @@ export interface IPublisherDocumentBase {
69
69
  *
70
70
  * @alpha
71
71
  */
72
- export interface IPublisherDocumentDefinition extends IPublisherDocumentBase {
72
+ export interface IPublisherDocumentDefinitionV1 extends IPublisherDocumentBaseV1 {
73
73
  type: "report";
74
74
  /**
75
75
  * Present when updating an existing document.
@@ -81,7 +81,7 @@ export interface IPublisherDocumentDefinition extends IPublisherDocumentBase {
81
81
  *
82
82
  * @alpha
83
83
  */
84
- export interface IPublisherDocument extends IPublisherDocumentDefinition, IAuditableDates, IAuditableUsers {
84
+ export interface IPublisherDocumentV1 extends IPublisherDocumentDefinitionV1, IAuditableDates, IAuditableUsers {
85
85
  ref: ObjRef;
86
86
  /**
87
87
  * When true, the object comes from a parent workspace and is not editable
@@ -90,27 +90,27 @@ export interface IPublisherDocument extends IPublisherDocumentDefinition, IAudit
90
90
  isLocked?: boolean;
91
91
  }
92
92
  /**
93
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinition}.
93
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinitionV1}.
94
94
  *
95
95
  * @alpha
96
96
  */
97
- export declare function isPublisherDocumentTemplateDefinition(obj: unknown): obj is IPublisherDocumentTemplateDefinition;
97
+ export declare function isPublisherDocumentTemplateDefinitionV1(obj: unknown): obj is IPublisherDocumentTemplateDefinitionV1;
98
98
  /**
99
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplate}.
99
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateV1}.
100
100
  *
101
101
  * @alpha
102
102
  */
103
- export declare function isPublisherDocumentTemplate(obj: unknown): obj is IPublisherDocumentTemplate;
103
+ export declare function isPublisherDocumentTemplateV1(obj: unknown): obj is IPublisherDocumentTemplateV1;
104
104
  /**
105
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinition}.
105
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinitionV1}.
106
106
  *
107
107
  * @alpha
108
108
  */
109
- export declare function isPublisherDocumentDefinition(obj: unknown): obj is IPublisherDocumentDefinition;
109
+ export declare function isPublisherDocumentDefinitionV1(obj: unknown): obj is IPublisherDocumentDefinitionV1;
110
110
  /**
111
- * Type-guard testing whether the provided object is an instance of {@link IPublisherDocument}.
111
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentV1}.
112
112
  *
113
113
  * @alpha
114
114
  */
115
- export declare function isPublisherDocument(obj: unknown): obj is IPublisherDocument;
115
+ export declare function isPublisherDocumentV1(obj: unknown): obj is IPublisherDocumentV1;
116
116
  //# sourceMappingURL=document.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/document.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,EAAE,KAAK,MAAM,EAAY,MAAM,uBAAuB,CAAC;AAE9D,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAE5D;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACnD,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,OAAO,EAAE,2BAA2B,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BACb,SAAQ,sCAAsC,EAAE,eAAe,EAAE,eAAe;IAChF,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;;;;;;OAOG;IACH,WAAW,EAAE,qBAAqB,CAAC;IAEnC;;OAEG;IACH,SAAS,EAAE,qBAAqB,CAAC;IAEjC;;;;OAIG;IACH,OAAO,EAAE,2BAA2B,CAAC;IAErC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA+B,SAAQ,wBAAwB;IAC5E,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBACb,SAAQ,8BAA8B,EAAE,eAAe,EAAE,eAAe;IACxE,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,uCAAuC,CACnD,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,sCAAsC,CAE/C;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,4BAA4B,CAI/F;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,8BAA8B,CAEnG;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAE/E"}