@sitecore-content-sdk/core 1.3.0-canary.9 → 1.4.0-canary.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (342) hide show
  1. package/README.md +7 -7
  2. package/dist/cjs/cache-client.js +55 -54
  3. package/dist/cjs/client/constants.js +7 -7
  4. package/dist/cjs/client/edge-proxy.js +24 -22
  5. package/dist/cjs/client/index.js +15 -15
  6. package/dist/cjs/client/models.js +2 -2
  7. package/dist/cjs/client/sitecore-client.js +421 -419
  8. package/dist/cjs/client/utils.js +47 -46
  9. package/dist/cjs/config/define-config.js +194 -193
  10. package/dist/cjs/config/index.js +7 -7
  11. package/dist/cjs/config/models.js +12 -11
  12. package/dist/cjs/config-cli/define-cli-config.js +23 -22
  13. package/dist/cjs/config-cli/index.js +7 -7
  14. package/dist/cjs/config-cli/models.js +8 -7
  15. package/dist/cjs/constants.js +49 -17
  16. package/dist/cjs/debug.js +48 -46
  17. package/dist/cjs/editing/codegen/index.js +14 -9
  18. package/dist/cjs/editing/codegen/preview.js +277 -193
  19. package/dist/cjs/editing/component-layout-service.js +62 -61
  20. package/dist/cjs/editing/design-library.js +183 -126
  21. package/dist/cjs/editing/editing-service.js +75 -74
  22. package/dist/cjs/editing/index.js +33 -27
  23. package/dist/cjs/editing/metadata.js +42 -42
  24. package/dist/cjs/editing/models.js +44 -38
  25. package/dist/cjs/editing/utils.js +108 -90
  26. package/dist/cjs/form/form.js +81 -78
  27. package/dist/cjs/form/index.js +7 -7
  28. package/dist/cjs/graphql-request-client.js +108 -107
  29. package/dist/cjs/i18n/dictionary-service.js +122 -121
  30. package/dist/cjs/i18n/index.js +7 -7
  31. package/dist/cjs/i18n/utils.js +16 -15
  32. package/dist/cjs/index.js +60 -60
  33. package/dist/cjs/layout/content-styles.js +72 -71
  34. package/dist/cjs/layout/index.js +24 -24
  35. package/dist/cjs/layout/layout-service.js +62 -57
  36. package/dist/cjs/layout/models.js +39 -34
  37. package/dist/cjs/layout/themes.js +76 -75
  38. package/dist/cjs/layout/utils.js +117 -110
  39. package/dist/cjs/media/index.js +38 -38
  40. package/dist/cjs/media/media-api.js +100 -96
  41. package/dist/cjs/models.js +2 -2
  42. package/dist/cjs/native-fetcher.js +194 -179
  43. package/dist/cjs/personalize/index.js +15 -15
  44. package/dist/cjs/personalize/layout-personalizer.js +98 -97
  45. package/dist/cjs/personalize/personalize-service.js +98 -94
  46. package/dist/cjs/personalize/utils.js +143 -136
  47. package/dist/cjs/retries.js +43 -42
  48. package/dist/cjs/site/error-pages-service.js +65 -64
  49. package/dist/cjs/site/index.js +26 -26
  50. package/dist/cjs/site/models.js +2 -2
  51. package/dist/cjs/site/redirects-service.js +94 -81
  52. package/dist/cjs/site/robots-service.js +66 -65
  53. package/dist/cjs/site/site-resolver.js +73 -72
  54. package/dist/cjs/site/siteinfo-service.js +84 -80
  55. package/dist/cjs/site/sitemap-xml-service.js +84 -83
  56. package/dist/cjs/site/sitepath-service.js +165 -164
  57. package/dist/cjs/site/utils.js +55 -47
  58. package/dist/cjs/sitecore-service-base.js +36 -36
  59. package/dist/cjs/tools/auth/flow.js +65 -64
  60. package/dist/cjs/tools/auth/index.js +5 -5
  61. package/dist/cjs/tools/auth/models.js +2 -2
  62. package/dist/cjs/tools/auth/tenant-store.js +38 -38
  63. package/dist/cjs/tools/codegen/component-generation.js +52 -50
  64. package/dist/cjs/tools/codegen/extract-files.js +105 -107
  65. package/dist/cjs/tools/codegen/import-map.js +401 -349
  66. package/dist/cjs/tools/codegen/utils.js +418 -418
  67. package/dist/cjs/tools/generate-map.js +2 -2
  68. package/dist/cjs/tools/generateMetadata.js +36 -35
  69. package/dist/cjs/tools/generateSites.js +59 -58
  70. package/dist/cjs/tools/index.js +75 -73
  71. package/dist/cjs/tools/scaffold.js +60 -59
  72. package/dist/cjs/tools/templating/components.js +96 -266
  73. package/dist/cjs/tools/templating/index.js +11 -14
  74. package/dist/cjs/tools/templating/plugins.js +80 -78
  75. package/dist/cjs/tools/templating/utils.js +67 -66
  76. package/dist/cjs/utils/ensurePath.js +20 -20
  77. package/dist/cjs/utils/env.js +28 -27
  78. package/dist/cjs/utils/globalCache.js +55 -0
  79. package/dist/cjs/utils/index.js +26 -21
  80. package/dist/cjs/utils/is-server.js +11 -10
  81. package/dist/cjs/utils/normalize-url.js +5 -5
  82. package/dist/cjs/utils/timeout-promise.js +31 -31
  83. package/dist/cjs/utils/utils.js +254 -229
  84. package/dist/esm/cache-client.js +51 -50
  85. package/dist/esm/client/constants.js +4 -4
  86. package/dist/esm/client/edge-proxy.js +19 -17
  87. package/dist/esm/client/index.js +5 -5
  88. package/dist/esm/client/models.js +1 -1
  89. package/dist/esm/client/sitecore-client.js +414 -412
  90. package/dist/esm/client/utils.js +43 -42
  91. package/dist/esm/config/define-config.js +188 -187
  92. package/dist/esm/config/index.js +2 -2
  93. package/dist/esm/config/models.js +9 -8
  94. package/dist/esm/config-cli/define-cli-config.js +19 -18
  95. package/dist/esm/config-cli/index.js +2 -2
  96. package/dist/esm/config-cli/models.js +5 -4
  97. package/dist/esm/constants.js +46 -14
  98. package/dist/esm/debug.js +41 -39
  99. package/dist/esm/editing/codegen/index.js +1 -1
  100. package/dist/esm/editing/codegen/preview.js +263 -185
  101. package/dist/esm/editing/component-layout-service.js +55 -54
  102. package/dist/esm/editing/design-library.js +171 -117
  103. package/dist/esm/editing/editing-service.js +68 -67
  104. package/dist/esm/editing/index.js +6 -5
  105. package/dist/esm/editing/metadata.js +39 -39
  106. package/dist/esm/editing/models.js +41 -35
  107. package/dist/esm/editing/utils.js +98 -80
  108. package/dist/esm/form/form.js +72 -69
  109. package/dist/esm/form/index.js +1 -1
  110. package/dist/esm/graphql-request-client.js +101 -100
  111. package/dist/esm/i18n/dictionary-service.js +115 -114
  112. package/dist/esm/i18n/index.js +2 -2
  113. package/dist/esm/i18n/utils.js +13 -12
  114. package/dist/esm/index.js +13 -13
  115. package/dist/esm/layout/content-styles.js +64 -63
  116. package/dist/esm/layout/index.js +6 -6
  117. package/dist/esm/layout/layout-service.js +55 -50
  118. package/dist/esm/layout/models.js +36 -31
  119. package/dist/esm/layout/themes.js +71 -70
  120. package/dist/esm/layout/utils.js +109 -102
  121. package/dist/esm/media/index.js +2 -2
  122. package/dist/esm/media/media-api.js +90 -86
  123. package/dist/esm/models.js +1 -1
  124. package/dist/esm/native-fetcher.js +187 -172
  125. package/dist/esm/personalize/index.js +3 -3
  126. package/dist/esm/personalize/layout-personalizer.js +93 -92
  127. package/dist/esm/personalize/personalize-service.js +91 -87
  128. package/dist/esm/personalize/utils.js +135 -128
  129. package/dist/esm/retries.js +39 -38
  130. package/dist/esm/site/error-pages-service.js +58 -57
  131. package/dist/esm/site/index.js +8 -8
  132. package/dist/esm/site/models.js +1 -1
  133. package/dist/esm/site/redirects-service.js +87 -74
  134. package/dist/esm/site/robots-service.js +59 -58
  135. package/dist/esm/site/site-resolver.js +69 -68
  136. package/dist/esm/site/siteinfo-service.js +77 -73
  137. package/dist/esm/site/sitemap-xml-service.js +77 -76
  138. package/dist/esm/site/sitepath-service.js +157 -156
  139. package/dist/esm/site/utils.js +49 -41
  140. package/dist/esm/sitecore-service-base.js +29 -29
  141. package/dist/esm/tools/auth/flow.js +62 -61
  142. package/dist/esm/tools/auth/index.js +1 -1
  143. package/dist/esm/tools/auth/models.js +1 -1
  144. package/dist/esm/tools/auth/tenant-store.js +35 -35
  145. package/dist/esm/tools/codegen/component-generation.js +44 -42
  146. package/dist/esm/tools/codegen/extract-files.js +99 -101
  147. package/dist/esm/tools/codegen/import-map.js +358 -306
  148. package/dist/esm/tools/codegen/utils.js +373 -373
  149. package/dist/esm/tools/generate-map.js +1 -1
  150. package/dist/esm/tools/generateMetadata.js +29 -28
  151. package/dist/esm/tools/generateSites.js +52 -51
  152. package/dist/esm/tools/index.js +28 -27
  153. package/dist/esm/tools/scaffold.js +52 -51
  154. package/dist/esm/tools/templating/components.js +59 -223
  155. package/dist/esm/tools/templating/index.js +3 -3
  156. package/dist/esm/tools/templating/plugins.js +72 -70
  157. package/dist/esm/tools/templating/utils.js +59 -58
  158. package/dist/esm/utils/ensurePath.js +13 -13
  159. package/dist/esm/utils/env.js +24 -23
  160. package/dist/esm/utils/globalCache.js +49 -0
  161. package/dist/esm/utils/index.js +4 -3
  162. package/dist/esm/utils/is-server.js +9 -8
  163. package/dist/esm/utils/normalize-url.js +1 -1
  164. package/dist/esm/utils/timeout-promise.js +28 -28
  165. package/dist/esm/utils/utils.js +238 -213
  166. package/package.json +73 -5
  167. package/types/cache-client.d.ts +68 -64
  168. package/types/cache-client.d.ts.map +1 -0
  169. package/types/client/constants.d.ts +5 -4
  170. package/types/client/constants.d.ts.map +1 -0
  171. package/types/client/edge-proxy.d.ts +18 -15
  172. package/types/client/edge-proxy.d.ts.map +1 -0
  173. package/types/client/index.d.ts +8 -7
  174. package/types/client/index.d.ts.map +1 -0
  175. package/types/client/models.d.ts +21 -19
  176. package/types/client/models.d.ts.map +1 -0
  177. package/types/client/sitecore-client.d.ts +338 -327
  178. package/types/client/sitecore-client.d.ts.map +1 -0
  179. package/types/client/utils.d.ts +15 -9
  180. package/types/client/utils.d.ts.map +1 -0
  181. package/types/config/define-config.d.ts +20 -18
  182. package/types/config/define-config.d.ts.map +1 -0
  183. package/types/config/index.d.ts +3 -2
  184. package/types/config/index.d.ts.map +1 -0
  185. package/types/config/models.d.ts +287 -268
  186. package/types/config/models.d.ts.map +1 -0
  187. package/types/config-cli/define-cli-config.d.ts +9 -7
  188. package/types/config-cli/define-cli-config.d.ts.map +1 -0
  189. package/types/config-cli/index.d.ts +3 -2
  190. package/types/config-cli/index.d.ts.map +1 -0
  191. package/types/config-cli/models.d.ts +6 -4
  192. package/types/config-cli/models.d.ts.map +1 -0
  193. package/types/constants.d.ts +44 -11
  194. package/types/constants.d.ts.map +1 -0
  195. package/types/debug.d.ts +35 -28
  196. package/types/debug.d.ts.map +1 -0
  197. package/types/editing/codegen/index.d.ts +2 -1
  198. package/types/editing/codegen/index.d.ts.map +1 -0
  199. package/types/editing/codegen/preview.d.ts +256 -195
  200. package/types/editing/codegen/preview.d.ts.map +1 -0
  201. package/types/editing/component-layout-service.d.ts +84 -80
  202. package/types/editing/component-layout-service.d.ts.map +1 -0
  203. package/types/editing/design-library.d.ts +111 -63
  204. package/types/editing/design-library.d.ts.map +1 -0
  205. package/types/editing/editing-service.d.ts +72 -62
  206. package/types/editing/editing-service.d.ts.map +1 -0
  207. package/types/editing/index.d.ts +7 -6
  208. package/types/editing/index.d.ts.map +1 -0
  209. package/types/editing/metadata.d.ts +8 -7
  210. package/types/editing/metadata.d.ts.map +1 -0
  211. package/types/editing/models.d.ts +103 -92
  212. package/types/editing/models.d.ts.map +1 -0
  213. package/types/editing/utils.d.ts +91 -74
  214. package/types/editing/utils.d.ts.map +1 -0
  215. package/types/form/form.d.ts +25 -21
  216. package/types/form/form.d.ts.map +1 -0
  217. package/types/form/index.d.ts +2 -1
  218. package/types/form/index.d.ts.map +1 -0
  219. package/types/graphql-request-client.d.ts +112 -105
  220. package/types/graphql-request-client.d.ts.map +1 -0
  221. package/types/i18n/dictionary-service.d.ts +135 -131
  222. package/types/i18n/dictionary-service.d.ts.map +1 -0
  223. package/types/i18n/index.d.ts +3 -2
  224. package/types/i18n/index.d.ts.map +1 -0
  225. package/types/i18n/utils.d.ts +9 -7
  226. package/types/i18n/utils.d.ts.map +1 -0
  227. package/types/index.d.ts +13 -12
  228. package/types/index.d.ts.map +1 -0
  229. package/types/layout/content-styles.d.ts +20 -18
  230. package/types/layout/content-styles.d.ts.map +1 -0
  231. package/types/layout/index.d.ts +6 -5
  232. package/types/layout/index.d.ts.map +1 -0
  233. package/types/layout/layout-service.d.ts +45 -35
  234. package/types/layout/layout-service.d.ts.map +1 -0
  235. package/types/layout/models.d.ts +174 -151
  236. package/types/layout/models.d.ts.map +1 -0
  237. package/types/layout/themes.d.ts +13 -11
  238. package/types/layout/themes.d.ts.map +1 -0
  239. package/types/layout/utils.d.ts +56 -41
  240. package/types/layout/utils.d.ts.map +1 -0
  241. package/types/media/index.d.ts +3 -2
  242. package/types/media/index.d.ts.map +1 -0
  243. package/types/media/media-api.d.ts +60 -55
  244. package/types/media/media-api.d.ts.map +1 -0
  245. package/types/models.d.ts +94 -84
  246. package/types/models.d.ts.map +1 -0
  247. package/types/native-fetcher.d.ts +124 -114
  248. package/types/native-fetcher.d.ts.map +1 -0
  249. package/types/personalize/index.d.ts +4 -3
  250. package/types/personalize/index.d.ts.map +1 -0
  251. package/types/personalize/layout-personalizer.d.ts +29 -27
  252. package/types/personalize/layout-personalizer.d.ts.map +1 -0
  253. package/types/personalize/personalize-service.d.ts +90 -80
  254. package/types/personalize/personalize-service.d.ts.map +1 -0
  255. package/types/personalize/utils.d.ts +78 -69
  256. package/types/personalize/utils.d.ts.map +1 -0
  257. package/types/retries.d.ts +26 -24
  258. package/types/retries.d.ts.map +1 -0
  259. package/types/site/error-pages-service.d.ts +64 -57
  260. package/types/site/error-pages-service.d.ts.map +1 -0
  261. package/types/site/index.d.ts +10 -9
  262. package/types/site/index.d.ts.map +1 -0
  263. package/types/site/models.d.ts +23 -18
  264. package/types/site/models.d.ts.map +1 -0
  265. package/types/site/redirects-service.d.ts +92 -69
  266. package/types/site/redirects-service.d.ts.map +1 -0
  267. package/types/site/robots-service.d.ts +57 -50
  268. package/types/site/robots-service.d.ts.map +1 -0
  269. package/types/site/site-resolver.d.ts +28 -26
  270. package/types/site/site-resolver.d.ts.map +1 -0
  271. package/types/site/siteinfo-service.d.ts +65 -52
  272. package/types/site/siteinfo-service.d.ts.map +1 -0
  273. package/types/site/sitemap-xml-service.d.ts +63 -56
  274. package/types/site/sitemap-xml-service.d.ts.map +1 -0
  275. package/types/site/sitepath-service.d.ts +137 -134
  276. package/types/site/sitepath-service.d.ts.map +1 -0
  277. package/types/site/utils.d.ts +41 -28
  278. package/types/site/utils.d.ts.map +1 -0
  279. package/types/sitecore-service-base.d.ts +31 -30
  280. package/types/sitecore-service-base.d.ts.map +1 -0
  281. package/types/tools/auth/flow.d.ts +29 -27
  282. package/types/tools/auth/flow.d.ts.map +1 -0
  283. package/types/tools/auth/index.d.ts +2 -1
  284. package/types/tools/auth/index.d.ts.map +1 -0
  285. package/types/tools/auth/models.d.ts +35 -33
  286. package/types/tools/auth/models.d.ts.map +1 -0
  287. package/types/tools/auth/tenant-store.d.ts +12 -11
  288. package/types/tools/auth/tenant-store.d.ts.map +1 -0
  289. package/types/tools/codegen/component-generation.d.ts +50 -47
  290. package/types/tools/codegen/component-generation.d.ts.map +1 -0
  291. package/types/tools/codegen/extract-files.d.ts +24 -22
  292. package/types/tools/codegen/extract-files.d.ts.map +1 -0
  293. package/types/tools/codegen/import-map.d.ts +103 -70
  294. package/types/tools/codegen/import-map.d.ts.map +1 -0
  295. package/types/tools/codegen/utils.d.ts +76 -75
  296. package/types/tools/codegen/utils.d.ts.map +1 -0
  297. package/types/tools/generate-map.d.ts +36 -26
  298. package/types/tools/generate-map.d.ts.map +1 -0
  299. package/types/tools/generateMetadata.d.ts +24 -22
  300. package/types/tools/generateMetadata.d.ts.map +1 -0
  301. package/types/tools/generateSites.d.ts +25 -22
  302. package/types/tools/generateSites.d.ts.map +1 -0
  303. package/types/tools/index.d.ts +22 -20
  304. package/types/tools/index.d.ts.map +1 -0
  305. package/types/tools/scaffold.d.ts +27 -25
  306. package/types/tools/scaffold.d.ts.map +1 -0
  307. package/types/tools/templating/components.d.ts +104 -103
  308. package/types/tools/templating/components.d.ts.map +1 -0
  309. package/types/tools/templating/index.d.ts +4 -3
  310. package/types/tools/templating/index.d.ts.map +1 -0
  311. package/types/tools/templating/plugins.d.ts +71 -67
  312. package/types/tools/templating/plugins.d.ts.map +1 -0
  313. package/types/tools/templating/utils.d.ts +42 -40
  314. package/types/tools/templating/utils.d.ts.map +1 -0
  315. package/types/utils/ensurePath.d.ts +7 -6
  316. package/types/utils/ensurePath.d.ts.map +1 -0
  317. package/types/utils/env.d.ts +9 -7
  318. package/types/utils/env.d.ts.map +1 -0
  319. package/types/utils/globalCache.d.ts +37 -0
  320. package/types/utils/globalCache.d.ts.map +1 -0
  321. package/types/utils/index.d.ts +5 -3
  322. package/types/utils/index.d.ts.map +1 -0
  323. package/types/utils/is-server.d.ts +8 -6
  324. package/types/utils/is-server.d.ts.map +1 -0
  325. package/types/utils/normalize-url.d.ts +2 -1
  326. package/types/utils/normalize-url.d.ts.map +1 -0
  327. package/types/utils/timeout-promise.d.ts +18 -17
  328. package/types/utils/timeout-promise.d.ts.map +1 -0
  329. package/types/utils/utils.d.ts +104 -79
  330. package/types/utils/utils.d.ts.map +1 -0
  331. package/client.js +0 -1
  332. package/codegen.js +0 -1
  333. package/config-cli.js +0 -1
  334. package/config.js +0 -1
  335. package/editing.js +0 -1
  336. package/i18n.js +0 -1
  337. package/layout.js +0 -1
  338. package/media.js +0 -1
  339. package/personalize.js +0 -1
  340. package/site.js +0 -1
  341. package/tools.js +0 -1
  342. package/utils.js +0 -1
@@ -1,80 +1,84 @@
1
- import { LayoutServiceData } from '../layout/models';
2
- import { DesignLibraryMode, DesignLibraryVariantGeneration } from './models';
3
- import { FetchOptions } from '../models';
4
- /**
5
- * Params for requesting component data in Design Library mode
6
- */
7
- export interface ComponentLayoutRequestParams {
8
- /**
9
- * Item id to be used as context for rendering the component
10
- */
11
- itemId: string;
12
- /**
13
- * Component identifier. Can be either taken from item's layout details or
14
- * an arbitrary one (component renderingId and datasource would be used for identification then)
15
- */
16
- componentUid: string;
17
- /**
18
- * site name to be used as context for rendering the component
19
- */
20
- siteName: string;
21
- /**
22
- * language to render component in
23
- */
24
- language?: string;
25
- /**
26
- * optional component datasource
27
- */
28
- dataSourceId?: string;
29
- /**
30
- * ID of the component definition rendering item in Sitecore
31
- */
32
- renderingId?: string;
33
- /**
34
- * version of the context item (latest by default)
35
- */
36
- version?: string;
37
- /**
38
- * mode to be used for rendering the component
39
- */
40
- mode?: DesignLibraryMode;
41
- /**
42
- * design library variant generation mode
43
- */
44
- generation?: DesignLibraryVariantGeneration;
45
- }
46
- /**
47
- * Config for ComponentLayoutService.
48
- * Provide contextId (server) and optionally clientContextId (browser).
49
- */
50
- export interface ComponentLayoutServiceConfig {
51
- /**
52
- * A unified identifier used to connect and retrieve data from XM Cloud instance used on the client
53
- */
54
- clientContextId?: string;
55
- /**
56
- * A unified identifier used to connect and retrieve data from XM Cloud instance used on the server
57
- */
58
- contextId: string;
59
- /**
60
- * XM Cloud endpoint that the app will communicate and retrieve data from
61
- * @default https://edge-platform.sitecorecloud.io
62
- */
63
- edgeUrl?: string;
64
- }
65
- /**
66
- * REST service that enables Design Library functionality.
67
- * Returns layout data for a single rendered component.
68
- */
69
- export declare class ComponentLayoutService {
70
- private config;
71
- constructor(config: ComponentLayoutServiceConfig);
72
- fetchComponentData(params: ComponentLayoutRequestParams, fetchOptions?: FetchOptions): Promise<LayoutServiceData>;
73
- protected getComponentFetchParams(params: ComponentLayoutRequestParams): any;
74
- /**
75
- * Get the fetch URL for the partial layout data endpoint
76
- * @param {ComponentLayoutRequestParams} params - The parameters for the request
77
- * @returns {string} The fetch URL for the component data
78
- */
79
- private getFetchUrl;
80
- }
1
+ import { LayoutServiceData } from '../layout/models';
2
+ import { DesignLibraryMode, DesignLibraryVariantGeneration } from './models';
3
+ import { FetchOptions } from '../models';
4
+ /**
5
+ * Params for requesting component data in Design Library mode
6
+ * @public
7
+ */
8
+ export interface ComponentLayoutRequestParams {
9
+ /**
10
+ * Item id to be used as context for rendering the component
11
+ */
12
+ itemId: string;
13
+ /**
14
+ * Component identifier. Can be either taken from item's layout details or
15
+ * an arbitrary one (component renderingId and datasource would be used for identification then)
16
+ */
17
+ componentUid: string;
18
+ /**
19
+ * site name to be used as context for rendering the component
20
+ */
21
+ siteName: string;
22
+ /**
23
+ * language to render component in
24
+ */
25
+ language?: string;
26
+ /**
27
+ * optional component datasource
28
+ */
29
+ dataSourceId?: string;
30
+ /**
31
+ * ID of the component definition rendering item in Sitecore
32
+ */
33
+ renderingId?: string;
34
+ /**
35
+ * version of the context item (latest by default)
36
+ */
37
+ version?: string;
38
+ /**
39
+ * mode to be used for rendering the component
40
+ */
41
+ mode?: DesignLibraryMode;
42
+ /**
43
+ * design library variant generation mode
44
+ */
45
+ generation?: DesignLibraryVariantGeneration;
46
+ }
47
+ /**
48
+ * Config for ComponentLayoutService.
49
+ * Provide contextId (server) and optionally clientContextId (browser).
50
+ * @public
51
+ */
52
+ export interface ComponentLayoutServiceConfig {
53
+ /**
54
+ * A unified identifier used to connect and retrieve data from XM Cloud instance used on the client
55
+ */
56
+ clientContextId?: string;
57
+ /**
58
+ * A unified identifier used to connect and retrieve data from XM Cloud instance used on the server
59
+ */
60
+ contextId: string;
61
+ /**
62
+ * XM Cloud endpoint that the app will communicate and retrieve data from
63
+ * @default https://edge-platform.sitecorecloud.io
64
+ */
65
+ edgeUrl?: string;
66
+ }
67
+ /**
68
+ * REST service that enables Design Library functionality.
69
+ * Returns layout data for a single rendered component.
70
+ * @public
71
+ */
72
+ export declare class ComponentLayoutService {
73
+ private config;
74
+ constructor(config: ComponentLayoutServiceConfig);
75
+ fetchComponentData(params: ComponentLayoutRequestParams, fetchOptions?: FetchOptions): Promise<LayoutServiceData>;
76
+ protected getComponentFetchParams(params: ComponentLayoutRequestParams): any;
77
+ /**
78
+ * Get the fetch URL for the partial layout data endpoint
79
+ * @param {ComponentLayoutRequestParams} params - The parameters for the request
80
+ * @returns {string} The fetch URL for the component data
81
+ */
82
+ private getFetchUrl;
83
+ }
84
+ //# sourceMappingURL=component-layout-service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"component-layout-service.d.ts","sourceRoot":"","sources":["../../src/editing/component-layout-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAKrD,OAAO,EAAE,iBAAiB,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,8BAA8B,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,qBAAa,sBAAsB;IACrB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,4BAA4B;IAExD,kBAAkB,CAChB,MAAM,EAAE,4BAA4B,EACpC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IA6B7B,SAAS,CAAC,uBAAuB,CAAC,MAAM,EAAE,4BAA4B;IA0BtE;;;;OAIG;IACH,OAAO,CAAC,WAAW;CAMpB"}
@@ -1,63 +1,111 @@
1
- import { ComponentRendering, Field, GenericFieldValue } from '../layout/models';
2
- import { DesignLibraryMode } from './models';
3
- /**
4
- * Event to be sent when report status to design library
5
- */
6
- declare const DESIGN_LIBRARY_STATUS_EVENT_NAME = "component:status";
7
- /**
8
- * Represents an event indicating the status of a component in the library.
9
- */
10
- export interface DesignLibraryStatusEvent {
11
- name: typeof DESIGN_LIBRARY_STATUS_EVENT_NAME;
12
- message: {
13
- status: 'ready' | 'rendered';
14
- uid: string;
15
- };
16
- }
17
- /**
18
- * Enumeration of statuses for the design library.
19
- */
20
- export declare enum DesignLibraryStatus {
21
- READY = "ready",
22
- RENDERED = "rendered"
23
- }
24
- /**
25
- * Event args for Design Library `update` event
26
- */
27
- export interface ComponentUpdateEventArgs {
28
- name: string;
29
- details?: {
30
- uid: string;
31
- params?: Record<string, string>;
32
- fields?: Record<string, Field<GenericFieldValue>>;
33
- };
34
- }
35
- /**
36
- * Adds the browser-side event handler for 'component:update' message used in Design Library
37
- * The event should update a component on page by uid, with fields and params from event args
38
- * @param {ComponentRendering} rootComponent root component displayed for Design Library page
39
- * @param {Function} successCallback callback to be called after successful component update
40
- */
41
- export declare const addComponentUpdateHandler: (rootComponent: ComponentRendering, successCallback?: (updatedRootComponent: ComponentRendering) => void) => (() => void) | undefined;
42
- export declare const validateOrigin: (event: MessageEvent) => boolean;
43
- export declare const updateComponentHandler: (e: MessageEvent, rootComponent: ComponentRendering, successCallback?: (updatedRootComponent: ComponentRendering) => void) => ComponentRendering<import("../layout/models").ComponentFields> | undefined;
44
- /**
45
- * Generates a DesignLibraryStatusEvent with the given status and uid.
46
- * @param {DesignLibraryStatus} status - The status of rendering.
47
- * @param {string} uid - The unique identifier for the event.
48
- * @returns An object representing the DesignLibraryStatusEvent.
49
- */
50
- export declare function getDesignLibraryStatusEvent(status: DesignLibraryStatus, uid: string): DesignLibraryStatusEvent;
51
- /**
52
- * Generates the URL for the design library script link.
53
- * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
54
- * @returns The full URL to the design library script.
55
- */
56
- export declare function getDesignLibraryScriptLink(sitecoreEdgeUrl?: string): string;
57
- /**
58
- * Checks if the given mode is a Design Library mode.
59
- * @param {unknown} mode - The mode to check.
60
- * @returns {boolean} True if the mode is a Design Library mode, false otherwise.
61
- */
62
- export declare function isDesignLibraryMode(mode: unknown): mode is DesignLibraryMode;
63
- export {};
1
+ import { ComponentFields, ComponentParams, ComponentRendering, Field, GenericFieldValue } from '../layout/models';
2
+ import { DesignLibraryMode } from './models';
3
+ /**
4
+ * Event to be sent when report status to design library
5
+ */
6
+ declare const DESIGN_LIBRARY_STATUS_EVENT_NAME = "component:status";
7
+ /**
8
+ * Prefix for component update cache keys
9
+ * @internal
10
+ */
11
+ export declare const COMPONENT_UPDATE_CACHE_KEY_PREFIX = "component-update-";
12
+ /**
13
+ * Base interface for all Design Library events.
14
+ */
15
+ export interface DesignLibraryEvent {
16
+ /**
17
+ * The name of the event.
18
+ */
19
+ name: string;
20
+ /**
21
+ * The message payload for the event.
22
+ */
23
+ message: Record<string, unknown>;
24
+ }
25
+ /**
26
+ * Represents an event indicating the status of a component in the library.
27
+ * @internal
28
+ */
29
+ export interface DesignLibraryStatusEvent extends DesignLibraryEvent {
30
+ name: typeof DESIGN_LIBRARY_STATUS_EVENT_NAME;
31
+ message: {
32
+ status: 'ready' | 'rendered';
33
+ uid: string;
34
+ };
35
+ }
36
+ /**
37
+ * Enumeration of statuses for the design library.
38
+ * @internal
39
+ */
40
+ export declare enum DesignLibraryStatus {
41
+ READY = "ready",
42
+ RENDERED = "rendered"
43
+ }
44
+ /**
45
+ * Event args for Design Library `update` event
46
+ * @internal
47
+ */
48
+ export interface ComponentUpdateEventArgs extends DesignLibraryEvent {
49
+ name: string;
50
+ details?: {
51
+ uid: string;
52
+ params?: Record<string, string>;
53
+ fields?: Record<string, Field<GenericFieldValue>>;
54
+ };
55
+ }
56
+ /**
57
+ * Adds the browser-side event handler for 'component:update' message used in Design Library
58
+ * The event should update a component on page by uid, with fields and params from event args
59
+ * @param {ComponentRendering} rootComponent root component displayed for Design Library page
60
+ * @param {Function} successCallback callback to be called after successful component update
61
+ * @internal
62
+ */
63
+ export declare const addComponentUpdateHandler: (rootComponent: ComponentRendering, successCallback?: (updatedRootComponent: ComponentRendering) => void) => (() => void) | undefined;
64
+ export declare const validateOrigin: (event: MessageEvent) => boolean;
65
+ /**
66
+ * Validates that a MessageEvent has the expected event name and required data.
67
+ * Logs debug information when validation fails due to invalid origin.
68
+ * @param {MessageEvent} e - The message event to validate.
69
+ * @param {string} eventName - The expected event name to match against e.data.name.
70
+ * @returns {boolean} True if the event has a valid origin, data object, and matching event name; otherwise false.
71
+ */
72
+ export declare const validateEvent: (e: MessageEvent, eventName: string) => boolean;
73
+ export declare const updateComponentHandler: (e: MessageEvent, rootComponent: ComponentRendering, successCallback?: (updatedRootComponent: ComponentRendering) => void) => ComponentRendering<ComponentFields> | undefined;
74
+ /**
75
+ * Updates a component's fields and params with the provided values.
76
+ * @param {ComponentRendering<ComponentFields>} component - The component to update.
77
+ * @param {ComponentFields | undefined} fields - The fields to merge into the component.
78
+ * @param {ComponentParams | undefined} params - The params to merge into the component.
79
+ * @internal
80
+ */
81
+ export declare const updateComponent: (component: ComponentRendering<ComponentFields>, fields: ComponentFields | undefined, params: ComponentParams | undefined) => void;
82
+ /**
83
+ * Generates a DesignLibraryStatusEvent with the given status and uid.
84
+ * @param {DesignLibraryStatus} status - The status of rendering.
85
+ * @param {string} uid - The unique identifier for the event.
86
+ * @returns An object representing the DesignLibraryStatusEvent.
87
+ * @internal
88
+ */
89
+ export declare function getDesignLibraryStatusEvent(status: DesignLibraryStatus, uid: string): DesignLibraryStatusEvent;
90
+ /**
91
+ * Generates the URL for the design library script link.
92
+ * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
93
+ * @returns The full URL to the design library script.
94
+ * @internal
95
+ */
96
+ export declare function getDesignLibraryScriptLink(sitecoreEdgeUrl?: string): string;
97
+ /**
98
+ * Checks if the given mode is a Design Library mode.
99
+ * @param {unknown} mode - The mode to check.
100
+ * @returns {boolean} True if the mode is a Design Library mode, false otherwise.
101
+ * @internal
102
+ */
103
+ export declare function isDesignLibraryMode(mode: unknown): mode is DesignLibraryMode;
104
+ /**
105
+ * Sends an event to the Design Library
106
+ * @param {DesignLibraryEvent} evt - The event object to send.
107
+ * @internal
108
+ */
109
+ export declare const postToDesignLibrary: (evt: DesignLibraryEvent) => void;
110
+ export {};
111
+ //# sourceMappingURL=design-library.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"design-library.d.ts","sourceRoot":"","sources":["../../src/editing/design-library.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,KAAK,EACL,iBAAiB,EAClB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;GAEG;AACH,QAAA,MAAM,gCAAgC,qBAAqB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,iCAAiC,sBAAsB,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,IAAI,EAAE,OAAO,gCAAgC,CAAC;IAC9C,OAAO,EAAE;QACP,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;QAC7B,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B,KAAK,UAAU;IACf,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;KACnD,CAAC;CACH;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,GACpC,eAAe,kBAAkB,EACjC,kBAAkB,CAAC,oBAAoB,EAAE,kBAAkB,KAAK,IAAI,6BAUrE,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,YAAY,YASjD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,GAAG,YAAY,EAAE,WAAW,MAAM,KAAG,OAelE,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,GAAG,YAAY,EACf,eAAe,kBAAkB,EACjC,kBAAkB,CAAC,oBAAoB,EAAE,kBAAkB,KAAK,IAAI,oDAkDrE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAC1B,WAAW,kBAAkB,CAAC,eAAe,CAAC,EAC9C,QAAQ,eAAe,GAAG,SAAS,EACnC,QAAQ,eAAe,GAAG,SAAS,SAQpC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,mBAAmB,EAC3B,GAAG,EAAE,MAAM,GACV,wBAAwB,CAQ1B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,eAAe,SAA4B,GAAG,MAAM,CAE9F;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,iBAAiB,CAE5E;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,kBAAkB,SAW1D,CAAC"}
@@ -1,62 +1,72 @@
1
- import { GraphQLClient, GraphQLRequestClientFactory } from '../graphql-request-client';
2
- import { LayoutServiceData, LayoutServicePageState } from '../layout';
3
- import { LayoutKind } from './models';
4
- import { FetchOptions } from '../models';
5
- /**
6
- * GraphQL query for fetching editing data.
7
- */
8
- export declare const query = "\n query EditingQuery($itemId: String!, $language: String!, $version: String) {\n item(path: $itemId, language: $language, version: $version) {\n rendered\n }\n }\n";
9
- /**
10
- * Response from the GraphQL Editing query.
11
- */
12
- export type GraphQLEditingQueryResponse = {
13
- item: {
14
- rendered: LayoutServiceData;
15
- };
16
- };
17
- export interface EditingServiceConfig {
18
- /**
19
- * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
20
- * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
21
- */
22
- clientFactory: GraphQLRequestClientFactory;
23
- }
24
- export type EditingOptions = {
25
- itemId: string;
26
- language: string;
27
- version?: string;
28
- layoutKind?: LayoutKind;
29
- mode: Exclude<LayoutServicePageState, 'Normal'>;
30
- };
31
- /**
32
- * Service for fetching editing data from Sitecore using the Sitecore's GraphQL API.
33
- * Expected to be used in XMCloud Pages preview (editing) Metadata Edit Mode.
34
- */
35
- export declare class EditingService {
36
- serviceConfig: EditingServiceConfig;
37
- private graphQLClient;
38
- /**
39
- * Fetch layout data using the Sitecore GraphQL endpoint.
40
- * @param {EditingServiceConfig} serviceConfig configuration
41
- */
42
- constructor(serviceConfig: EditingServiceConfig);
43
- /**
44
- * Fetches editing data. Provides the layout data and dictionary phrases
45
- * @param {object} variables - The parameters for fetching editing data.
46
- * @param {string} variables.itemId - The item id (path) to fetch layout data for.
47
- * @param {string} variables.language - The language to fetch layout data for.
48
- * @param {string} variables.mode - The editing mode to fetch layout data for.
49
- * @param {string} [variables.version] - The version of the item (optional).
50
- * @param {LayoutKind} [variables.layoutKind] - The final or shared layout variant.
51
- * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
52
- * @returns {Promise} The layout data and dictionary phrases.
53
- */
54
- fetchEditingData({ itemId, language, version, layoutKind, mode }: EditingOptions, fetchOptions?: FetchOptions): Promise<{
55
- layoutData: LayoutServiceData;
56
- }>;
57
- /**
58
- * Gets a GraphQL client that can make requests to the API.
59
- * @returns {GraphQLClient} implementation
60
- */
61
- protected getGraphQLClient(): GraphQLClient;
62
- }
1
+ import { GraphQLClient, GraphQLRequestClientFactory } from '../graphql-request-client';
2
+ import { LayoutServiceData, LayoutServicePageState } from '../layout';
3
+ import { LayoutKind } from './models';
4
+ import { FetchOptions } from '../models';
5
+ /**
6
+ * GraphQL query for fetching editing data.
7
+ */
8
+ export declare const query = "\n query EditingQuery($itemId: String!, $language: String!, $version: String) {\n item(path: $itemId, language: $language, version: $version) {\n rendered\n }\n }\n";
9
+ /**
10
+ * Response from the GraphQL Editing query.
11
+ */
12
+ export type GraphQLEditingQueryResponse = {
13
+ item: {
14
+ rendered: LayoutServiceData;
15
+ };
16
+ };
17
+ /**
18
+ * Configuration for the EditingService
19
+ * @public
20
+ */
21
+ export interface EditingServiceConfig {
22
+ /**
23
+ * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
24
+ * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
25
+ */
26
+ clientFactory: GraphQLRequestClientFactory;
27
+ }
28
+ /**
29
+ * Options for fetching editing data
30
+ * @public
31
+ */
32
+ export type EditingOptions = {
33
+ itemId: string;
34
+ language: string;
35
+ version?: string;
36
+ layoutKind?: LayoutKind;
37
+ mode: Exclude<LayoutServicePageState, 'Normal'>;
38
+ };
39
+ /**
40
+ * Service for fetching editing data from Sitecore using the Sitecore's GraphQL API.
41
+ * Expected to be used in XMCloud Pages preview (editing) Metadata Edit Mode.
42
+ * @public
43
+ */
44
+ export declare class EditingService {
45
+ serviceConfig: EditingServiceConfig;
46
+ private graphQLClient;
47
+ /**
48
+ * Fetch layout data using the Sitecore GraphQL endpoint.
49
+ * @param {EditingServiceConfig} serviceConfig configuration
50
+ */
51
+ constructor(serviceConfig: EditingServiceConfig);
52
+ /**
53
+ * Fetches editing data. Provides the layout data and dictionary phrases
54
+ * @param {object} variables - The parameters for fetching editing data.
55
+ * @param {string} variables.itemId - The item id (path) to fetch layout data for.
56
+ * @param {string} variables.language - The language to fetch layout data for.
57
+ * @param {string} variables.mode - The editing mode to fetch layout data for.
58
+ * @param {string} [variables.version] - The version of the item (optional).
59
+ * @param {LayoutKind} [variables.layoutKind] - The final or shared layout variant.
60
+ * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
61
+ * @returns {Promise} The layout data and dictionary phrases.
62
+ */
63
+ fetchEditingData({ itemId, language, version, layoutKind, mode }: EditingOptions, fetchOptions?: FetchOptions): Promise<{
64
+ layoutData: LayoutServiceData;
65
+ }>;
66
+ /**
67
+ * Gets a GraphQL client that can make requests to the API.
68
+ * @returns {GraphQLClient} implementation
69
+ */
70
+ protected getGraphQLClient(): GraphQLClient;
71
+ }
72
+ //# sourceMappingURL=editing-service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"editing-service.d.ts","sourceRoot":"","sources":["../../src/editing/editing-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,eAAO,MAAM,KAAK,sLAMjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE;QAAE,QAAQ,EAAE,iBAAiB,CAAA;KAAE,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,IAAI,EAAE,OAAO,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,qBAAa,cAAc;IAON,aAAa,EAAE,oBAAoB;IANtD,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACgB,aAAa,EAAE,oBAAoB;IAItD;;;;;;;;;;OAUG;IACG,gBAAgB,CACpB,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAA6B,EAAE,IAAI,EAAE,EAAE,cAAc,EAClF,YAAY,CAAC,EAAE,YAAY;;;IAoC7B;;;OAGG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAS5C"}
@@ -1,6 +1,7 @@
1
- export { EditingService } from './editing-service';
2
- export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, Metadata, getContentSdkPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, PAGES_EDITING_MARKER, ComponentUpdateEventArgs, PREVIEW_KEY, } from './utils';
3
- export { ComponentLayoutService, ComponentLayoutRequestParams } from './component-layout-service';
4
- export { EditingRenderQueryParams, RenderComponentQueryParams } from './models';
5
- export { LayoutKind, MetadataKind, EditingPreviewData, DesignLibraryRenderPreviewData, DesignLibraryMode, } from './models';
6
- export { addComponentUpdateHandler, DesignLibraryStatus, DesignLibraryStatusEvent, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, isDesignLibraryMode, } from './design-library';
1
+ export { EditingService, EditingOptions, EditingServiceConfig } from './editing-service';
2
+ export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, Metadata, getContentSdkPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, INVALID_SECRET_HTML_MESSAGE, PAGES_EDITING_MARKER, ComponentUpdateEventArgs, PREVIEW_KEY, } from './utils';
3
+ export { ComponentLayoutService, ComponentLayoutRequestParams, ComponentLayoutServiceConfig, } from './component-layout-service';
4
+ export { EditingRenderQueryParams, RenderComponentQueryParams, DesignLibraryVariantGeneration, } from './models';
5
+ export { LayoutKind, MetadataKind, EditingPreviewData, DesignLibraryRenderPreviewData, DesignLibraryMode, } from './models';
6
+ export { addComponentUpdateHandler, DesignLibraryStatus, DesignLibraryStatusEvent, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, isDesignLibraryMode, postToDesignLibrary, COMPONENT_UPDATE_CACHE_KEY_PREFIX, updateComponent, } from './design-library';
7
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/editing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzF,OAAO,EACL,uBAAuB,EACvB,WAAW,EACX,cAAc,EACd,kBAAkB,EAClB,QAAQ,EACR,4BAA4B,EAC5B,uBAAuB,EACvB,0BAA0B,EAC1B,2BAA2B,EAC3B,oBAAoB,EACpB,wBAAwB,EACxB,WAAW,GACZ,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,sBAAsB,EACtB,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,wBAAwB,EACxB,0BAA0B,EAC1B,8BAA8B,GAC/B,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,8BAA8B,EAC9B,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EACxB,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,mBAAmB,EACnB,iCAAiC,EACjC,eAAe,GAChB,MAAM,kBAAkB,CAAC"}
@@ -1,7 +1,8 @@
1
- import { Metadata } from './';
2
- /**
3
- * Get application metadata
4
- * @param {boolean} allowWorkspaces - Whether to allow workspaces in the metadata generation.
5
- * @returns {Metadata} The generated metadata.
6
- */
7
- export declare function getMetadata(allowWorkspaces?: boolean): Metadata;
1
+ import { Metadata } from './';
2
+ /**
3
+ * Get application metadata
4
+ * @param {boolean} allowWorkspaces - Whether to allow workspaces in the metadata generation.
5
+ * @returns {Metadata} The generated metadata.
6
+ */
7
+ export declare function getMetadata(allowWorkspaces?: boolean): Metadata;
8
+ //# sourceMappingURL=metadata.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/editing/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAe9B;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,eAAe,GAAE,OAAe,GAAG,QAAQ,CAgBtE"}