@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
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/layout/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,SAAS,EACT,eAAe,EACf,kBAAkB,EAClB,KAAK,EACL,iBAAiB,EACjB,IAAI,EACJ,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,QAAQ,EACR,aAAa,EACb,aAAa,EACb,YAAY,EACZ,6BAA6B,EAC7B,oBAAoB,GACrB,MAAM,UAAU,CAAC;AAElB,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAE5D,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC"}
@@ -1,35 +1,45 @@
1
- import { LayoutServiceData, RouteOptions } from './models';
2
- import { SitecoreConfigInput } from '../config';
3
- import { GraphQLServiceConfig, SitecoreServiceBase } from '../sitecore-service-base';
4
- import { FetchOptions } from '../models';
5
- export declare const GRAPHQL_LAYOUT_QUERY_NAME = "ContentSdkLayoutQuery";
6
- export type LayoutServiceConfig = GraphQLServiceConfig & Partial<SitecoreConfigInput['layout']>;
7
- /**
8
- * Service that fetch layout data using Sitecore's GraphQL API.
9
- * @augments LayoutServiceBase
10
- * @mixes GraphQLRequestClient
11
- */
12
- export declare class LayoutService extends SitecoreServiceBase {
13
- serviceConfig: LayoutServiceConfig;
14
- /**
15
- * Fetch layout data using the Sitecore GraphQL endpoint.
16
- * @param {LayoutServiceConfig} serviceConfig configuration
17
- */
18
- constructor(serviceConfig: LayoutServiceConfig);
19
- /**
20
- * Fetch layout data for an item.
21
- * @param {string} itemPath item path to fetch layout data for.
22
- * @param {RouteOptions} [routeOptions] Request options like language and site to retrieve data for
23
- * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
24
- * @returns {Promise<LayoutServiceData>} layout service data
25
- */
26
- fetchLayoutData(itemPath: string, routeOptions: RouteOptions, fetchOptions?: FetchOptions): Promise<LayoutServiceData>;
27
- /**
28
- * Returns GraphQL Layout query
29
- * @param {string} itemPath page route
30
- * @param {string} [site] site name
31
- * @param {string} [language] language
32
- * @returns {string} GraphQL query
33
- */
34
- protected getLayoutQuery(itemPath: string, site: string, language?: string): string;
35
- }
1
+ import { LayoutServiceData, RouteOptions } from './models';
2
+ import { SitecoreConfigInput } from '../config';
3
+ import { GraphQLServiceConfig, SitecoreServiceBase } from '../sitecore-service-base';
4
+ import { FetchOptions } from '../models';
5
+ /**
6
+ * GraphQL layout query name
7
+ * @internal
8
+ */
9
+ export declare const GRAPHQL_LAYOUT_QUERY_NAME = "ContentSdkLayoutQuery";
10
+ /**
11
+ * Layout service configuration
12
+ * @public
13
+ */
14
+ export type LayoutServiceConfig = GraphQLServiceConfig & Partial<SitecoreConfigInput['layout']>;
15
+ /**
16
+ * Service that fetch layout data using Sitecore's GraphQL API.
17
+ * @augments LayoutServiceBase
18
+ * @mixes GraphQLRequestClient
19
+ * @public
20
+ */
21
+ export declare class LayoutService extends SitecoreServiceBase {
22
+ serviceConfig: LayoutServiceConfig;
23
+ /**
24
+ * Fetch layout data using the Sitecore GraphQL endpoint.
25
+ * @param {LayoutServiceConfig} serviceConfig configuration
26
+ */
27
+ constructor(serviceConfig: LayoutServiceConfig);
28
+ /**
29
+ * Fetch layout data for an item.
30
+ * @param {string} itemPath item path to fetch layout data for.
31
+ * @param {RouteOptions} [routeOptions] Request options like language and site to retrieve data for
32
+ * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
33
+ * @returns {Promise<LayoutServiceData>} layout service data
34
+ */
35
+ fetchLayoutData(itemPath: string, routeOptions: RouteOptions, fetchOptions?: FetchOptions): Promise<LayoutServiceData>;
36
+ /**
37
+ * Returns GraphQL Layout query
38
+ * @param {string} itemPath page route
39
+ * @param {string} [site] site name
40
+ * @param {string} [language] language
41
+ * @returns {string} GraphQL query
42
+ */
43
+ protected getLayoutQuery(itemPath: string, site: string, language?: string): string;
44
+ }
45
+ //# sourceMappingURL=layout-service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"layout-service.d.ts","sourceRoot":"","sources":["../../src/layout/layout-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,yBAAyB,0BAA0B,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEhG;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,mBAAmB;IAKjC,aAAa,EAAE,mBAAmB;IAJrD;;;OAGG;gBACgB,aAAa,EAAE,mBAAmB;IAIrD;;;;;;OAMG;IACG,eAAe,CACnB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,YAAY,EAC1B,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAgB7B;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;CAe3E"}
@@ -1,151 +1,174 @@
1
- /**
2
- * A reply from the Sitecore Layout Service
3
- */
4
- export interface LayoutServiceData {
5
- sitecore: LayoutServiceContextData & {
6
- route: RouteData | null;
7
- };
8
- }
9
- /**
10
- * Layout Service page state enum
11
- */
12
- export declare enum LayoutServicePageState {
13
- Preview = "preview",
14
- Edit = "edit",
15
- Normal = "normal"
16
- }
17
- /**
18
- * Represents the edit mode for rendering content in Sitecore Editors
19
- */
20
- export declare enum EditMode {
21
- Metadata = "metadata"
22
- }
23
- /**
24
- * Shape of context data from the Sitecore Layout Service
25
- */
26
- export interface LayoutServiceContext {
27
- [key: string]: unknown;
28
- pageEditing?: boolean;
29
- language?: string;
30
- itemPath?: string;
31
- pageState?: LayoutServicePageState;
32
- visitorIdentificationTimestamp?: number;
33
- site?: {
34
- name?: string;
35
- };
36
- renderingType?: RenderingType;
37
- clientScripts?: string[];
38
- clientData?: Record<string, Record<string, unknown>>;
39
- }
40
- /**
41
- * Context information from the Sitecore Layout Service
42
- */
43
- export interface LayoutServiceContextData {
44
- context: LayoutServiceContext;
45
- }
46
- /**
47
- * Shape of route data returned from Sitecore Layout Service
48
- */
49
- export interface RouteData<Fields = Record<string, Field | Item | Item[]>> {
50
- name: string;
51
- displayName?: string;
52
- fields?: Fields;
53
- databaseName?: string;
54
- deviceId?: string;
55
- itemLanguage?: string;
56
- itemVersion?: number;
57
- layoutId?: string;
58
- templateId?: string;
59
- templateName?: string;
60
- placeholders: PlaceholdersData;
61
- itemId?: string;
62
- }
63
- /**
64
- * Placeholder contents data (name: placeholder name, then array of components within that placeholder name)
65
- */
66
- export type PlaceholdersData<TYPEDNAME extends string = string> = {
67
- [P in TYPEDNAME]: Array<ComponentRendering>;
68
- };
69
- /**
70
- * Content field data passed to a component
71
- */
72
- export interface ComponentFields {
73
- [name: string]: Field | Item | Item[];
74
- }
75
- /**
76
- * Component params
77
- */
78
- export interface ComponentParams {
79
- [name: string]: string;
80
- }
81
- /**
82
- * Definition of a component instance within a placeholder on a route
83
- */
84
- export interface ComponentRendering<T = ComponentFields> {
85
- componentName: string;
86
- dataSource?: string;
87
- uid?: string;
88
- placeholders?: PlaceholdersData;
89
- fields?: T;
90
- params?: ComponentParams;
91
- }
92
- /**
93
- * Field value data on a component
94
- */
95
- export type GenericFieldValue = string | boolean | number | Date | {
96
- [key: string]: unknown;
97
- } | Array<{
98
- [key: string]: unknown;
99
- }>;
100
- export interface Field<T = GenericFieldValue> extends FieldMetadata {
101
- value: T;
102
- }
103
- /**
104
- * Field metadata in editing mode
105
- */
106
- export interface FieldMetadata {
107
- metadata?: {
108
- [key: string]: unknown;
109
- };
110
- }
111
- /**
112
- * Content data returned from Layout Service
113
- */
114
- export interface Item {
115
- name: string;
116
- displayName?: string;
117
- id?: string;
118
- url?: string;
119
- fields: {
120
- [name: string]: Field | Item | Item[] | undefined;
121
- };
122
- }
123
- /**
124
- * Contents of a single placeholder returned from placeholder service
125
- */
126
- export interface PlaceholderData {
127
- name: string;
128
- path: string;
129
- elements: ComponentRendering[];
130
- }
131
- /**
132
- * Editing rendering type
133
- */
134
- export declare enum RenderingType {
135
- Component = "component"
136
- }
137
- /**
138
- * Contract for additional route options when requesting layout data
139
- */
140
- export type RouteOptions = {
141
- site: string;
142
- locale?: string;
143
- };
144
- /**
145
- * Static placeholder name used for component rendering
146
- */
147
- export declare const EDITING_COMPONENT_PLACEHOLDER = "editing-componentmode-placeholder";
148
- /**
149
- * Id of wrapper for component rendering
150
- */
151
- export declare const EDITING_COMPONENT_ID = "editing-component";
1
+ /**
2
+ * A reply from the Sitecore Layout Service
3
+ * @public
4
+ */
5
+ export interface LayoutServiceData {
6
+ sitecore: LayoutServiceContextData & {
7
+ route: RouteData | null;
8
+ };
9
+ }
10
+ /**
11
+ * Layout Service page state enum
12
+ * @public
13
+ */
14
+ export declare enum LayoutServicePageState {
15
+ Preview = "preview",
16
+ Edit = "edit",
17
+ Normal = "normal"
18
+ }
19
+ /**
20
+ * Represents the edit mode for rendering content in Sitecore Editors
21
+ * @public
22
+ */
23
+ export declare enum EditMode {
24
+ Metadata = "metadata"
25
+ }
26
+ /**
27
+ * Shape of context data from the Sitecore Layout Service
28
+ * @public
29
+ */
30
+ export interface LayoutServiceContext {
31
+ [key: string]: unknown;
32
+ pageEditing?: boolean;
33
+ language?: string;
34
+ itemPath?: string;
35
+ pageState?: LayoutServicePageState;
36
+ visitorIdentificationTimestamp?: number;
37
+ site?: {
38
+ name?: string;
39
+ };
40
+ renderingType?: RenderingType;
41
+ clientScripts?: string[];
42
+ clientData?: Record<string, Record<string, unknown>>;
43
+ }
44
+ /**
45
+ * Context information from the Sitecore Layout Service
46
+ * @public
47
+ */
48
+ export interface LayoutServiceContextData {
49
+ context: LayoutServiceContext;
50
+ }
51
+ /**
52
+ * Shape of route data returned from Sitecore Layout Service
53
+ * @public
54
+ */
55
+ export interface RouteData<Fields = Record<string, Field | Item | Item[]>> {
56
+ name: string;
57
+ displayName?: string;
58
+ fields?: Fields;
59
+ databaseName?: string;
60
+ deviceId?: string;
61
+ itemLanguage?: string;
62
+ itemVersion?: number;
63
+ layoutId?: string;
64
+ templateId?: string;
65
+ templateName?: string;
66
+ placeholders: PlaceholdersData;
67
+ itemId?: string;
68
+ }
69
+ /**
70
+ * Placeholder contents data (name: placeholder name, then array of components within that placeholder name)
71
+ * @public
72
+ */
73
+ export type PlaceholdersData<TYPEDNAME extends string = string> = {
74
+ [P in TYPEDNAME]: Array<ComponentRendering>;
75
+ };
76
+ /**
77
+ * Content field data passed to a component
78
+ * @public
79
+ */
80
+ export interface ComponentFields {
81
+ [name: string]: Field | Item | Item[];
82
+ }
83
+ /**
84
+ * Component params
85
+ * @public
86
+ */
87
+ export interface ComponentParams {
88
+ [name: string]: string;
89
+ }
90
+ /**
91
+ * Definition of a component instance within a placeholder on a route
92
+ * @public
93
+ */
94
+ export interface ComponentRendering<T = ComponentFields> {
95
+ componentName: string;
96
+ dataSource?: string;
97
+ uid?: string;
98
+ placeholders?: PlaceholdersData;
99
+ fields?: T;
100
+ params?: ComponentParams;
101
+ }
102
+ /**
103
+ * Field value data on a component
104
+ * @public
105
+ */
106
+ export type GenericFieldValue = string | boolean | number | Date | {
107
+ [key: string]: unknown;
108
+ } | Array<{
109
+ [key: string]: unknown;
110
+ }>;
111
+ /**
112
+ * Field interface
113
+ * @public
114
+ */
115
+ export interface Field<T = GenericFieldValue> extends FieldMetadata {
116
+ value: T;
117
+ }
118
+ /**
119
+ * Field metadata in editing mode
120
+ * @public
121
+ */
122
+ export interface FieldMetadata {
123
+ metadata?: {
124
+ [key: string]: unknown;
125
+ };
126
+ }
127
+ /**
128
+ * Content data returned from Layout Service
129
+ * @public
130
+ */
131
+ export interface Item {
132
+ name: string;
133
+ displayName?: string;
134
+ id?: string;
135
+ url?: string;
136
+ fields: {
137
+ [name: string]: Field | Item | Item[] | undefined;
138
+ };
139
+ }
140
+ /**
141
+ * Contents of a single placeholder returned from placeholder service
142
+ * @public
143
+ */
144
+ export interface PlaceholderData {
145
+ name: string;
146
+ path: string;
147
+ elements: ComponentRendering[];
148
+ }
149
+ /**
150
+ * Editing rendering type
151
+ * @public
152
+ */
153
+ export declare enum RenderingType {
154
+ Component = "component"
155
+ }
156
+ /**
157
+ * Contract for additional route options when requesting layout data
158
+ * @public
159
+ */
160
+ export type RouteOptions = {
161
+ site: string;
162
+ locale?: string;
163
+ };
164
+ /**
165
+ * Static placeholder name used for component rendering
166
+ * @internal
167
+ */
168
+ export declare const EDITING_COMPONENT_PLACEHOLDER = "editing-componentmode-placeholder";
169
+ /**
170
+ * Id of wrapper for component rendering
171
+ * @internal
172
+ */
173
+ export declare const EDITING_COMPONENT_ID = "editing-component";
174
+ //# sourceMappingURL=models.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/layout/models.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,wBAAwB,GAAG;QACnC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;KACzB,CAAC;CACH;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,gBAAgB,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;KAC/D,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,kBAAkB,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,eAAe;IACrD,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,OAAO,GACP,MAAM,GACN,IAAI,GACJ;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAC1B,KAAK,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC,CAAC;AAGtC;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,iBAAiB,CAAE,SAAQ,aAAa;IACjE,KAAK,EAAE,CAAC,CAAC;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,GAAG,SAAS,CAAC;KACnD,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,oBAAY,aAAa;IACvB,SAAS,cAAc;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,sCAAsC,CAAC;AACjF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC"}
@@ -1,11 +1,13 @@
1
- import { LayoutServiceData } from '.';
2
- import { HTMLLink } from '../models';
3
- /**
4
- * Walks through rendering tree and returns list of links of all FEAAS, BYOC or SXA Design Library Stylesheets that are used
5
- * @param {LayoutServiceData} layoutData Layout service data
6
- * @param {string} sitecoreEdgeContextId Sitecore Edge Context ID
7
- * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
8
- * @returns {HTMLLink[]} library stylesheet links
9
- */
10
- export declare function getDesignLibraryStylesheetLinks(layoutData: LayoutServiceData, sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string): HTMLLink[];
11
- export declare const getStylesheetUrl: (id: string, sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string) => string;
1
+ import { LayoutServiceData } from '.';
2
+ import { HTMLLink } from '../models';
3
+ /**
4
+ * Walks through rendering tree and returns list of links of all FEAAS, BYOC or SXA Design Library Stylesheets that are used
5
+ * @param {LayoutServiceData} layoutData Layout service data
6
+ * @param {string} sitecoreEdgeContextId Sitecore Edge Context ID
7
+ * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
8
+ * @returns {HTMLLink[]} library stylesheet links
9
+ * @public
10
+ */
11
+ export declare function getDesignLibraryStylesheetLinks(layoutData: LayoutServiceData, sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string): HTMLLink[];
12
+ export declare const getStylesheetUrl: (id: string, sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string) => string;
13
+ //# sourceMappingURL=themes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"themes.d.ts","sourceRoot":"","sources":["../../src/layout/themes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,iBAAiB,EAA4B,MAAM,GAAG,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAUrC;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,iBAAiB,EAC7B,qBAAqB,EAAE,MAAM,EAC7B,eAAe,SAA4B,GAC1C,QAAQ,EAAE,CAWZ;AAED,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,uBAAuB,MAAM,EAC7B,wBAA2C,WAK5C,CAAC"}
@@ -1,41 +1,56 @@
1
- import { ComponentRendering, ComponentFields, Field, GenericFieldValue } from './models';
2
- /**
3
- * Safely extracts a field value from a rendering or fields object.
4
- * Null will be returned if the field is not defined.
5
- * @param {ComponentRendering | Fields} renderingOrFields the rendering or fields object to extract the field from
6
- * @param {string} fieldName the name of the field to extract
7
- * @param defaultValue
8
- * @returns {T | undefined} the field value or null if the field is not defined
9
- */
10
- export declare function getFieldValue<T>(renderingOrFields: ComponentRendering | ComponentFields, fieldName: string): T | undefined;
11
- export declare function getFieldValue<T>(renderingOrFields: ComponentRendering | ComponentFields, fieldName: string, defaultValue: T): T;
12
- /**
13
- * Gets rendering definitions in a given child placeholder under a current rendering.
14
- * @param {ComponentRendering} rendering
15
- * @param {string} placeholderName
16
- * @returns {ComponentRendering[]} child placeholder
17
- */
18
- export declare function getChildPlaceholder(rendering: ComponentRendering, placeholderName: string): ComponentRendering[];
19
- /**
20
- * Returns a regular expression pattern for a dynamic placeholder name.
21
- * @param {string} placeholder Placeholder name with a dynamic segment (e.g. 'main-{*}')
22
- * @returns Regular expression pattern for the dynamic segment
23
- */
24
- export declare const getDynamicPlaceholderPattern: (placeholder: string) => RegExp;
25
- /**
26
- * Checks if the placeholder name is dynamic.
27
- * @param {string} placeholder Placeholder name
28
- * @returns True if the placeholder name is dynamic
29
- */
30
- export declare const isDynamicPlaceholder: (placeholder: string) => boolean;
31
- /**
32
- * The default value for an empty Date field.
33
- * This value is defined as a default one by .NET
34
- */
35
- export declare const EMPTY_DATE_FIELD_VALUE = "0001-01-01T00:00:00Z";
36
- /**
37
- * Determines if the passed in field object's value is empty.
38
- * @param {GenericFieldValue | Partial<Field>} field the field object.
39
- * Partial<T> type is used here because _field.value_ could be required or optional for the different field types
40
- */
41
- export declare function isFieldValueEmpty(field: GenericFieldValue | Partial<Field>): boolean;
1
+ import { ComponentRendering, ComponentFields, Field, GenericFieldValue } from './models';
2
+ /**
3
+ * Safely extracts a field value from a rendering or fields object.
4
+ * Null will be returned if the field is not defined.
5
+ * @param {ComponentRendering | Fields} renderingOrFields the rendering or fields object to extract the field from
6
+ * @param {string} fieldName the name of the field to extract
7
+ * @returns {T | undefined} the field value or null if the field is not defined
8
+ * @public
9
+ */
10
+ export declare function getFieldValue<T>(renderingOrFields: ComponentRendering | ComponentFields, fieldName: string): T | undefined;
11
+ /**
12
+ * Safely extracts a field value from a rendering or fields object.
13
+ * @param {ComponentRendering | ComponentFields} renderingOrFields the rendering or fields object to extract the field from
14
+ * @param {string} fieldName the name of the field to extract
15
+ * @param {T} defaultValue the default value to return if the field is not defined
16
+ * @returns {T} the field value or the default value if the field is not defined
17
+ * @public
18
+ */
19
+ export declare function getFieldValue<T>(renderingOrFields: ComponentRendering | ComponentFields, fieldName: string, defaultValue: T): T;
20
+ /**
21
+ * Gets rendering definitions in a given child placeholder under a current rendering.
22
+ * @param {ComponentRendering} rendering
23
+ * @param {string} placeholderName
24
+ * @returns {ComponentRendering[]} child placeholder
25
+ * @public
26
+ */
27
+ export declare function getChildPlaceholder(rendering: ComponentRendering, placeholderName: string): ComponentRendering[];
28
+ /**
29
+ * Returns a regular expression pattern for a dynamic placeholder name.
30
+ * @param {string} placeholder Placeholder name with a dynamic segment (e.g. 'main-{*}')
31
+ * @returns Regular expression pattern for the dynamic segment
32
+ * @internal
33
+ */
34
+ export declare const getDynamicPlaceholderPattern: (placeholder: string) => RegExp;
35
+ /**
36
+ * Checks if the placeholder name is dynamic.
37
+ * @param {string} placeholder Placeholder name
38
+ * @returns True if the placeholder name is dynamic
39
+ * @internal
40
+ */
41
+ export declare const isDynamicPlaceholder: (placeholder: string) => boolean;
42
+ /**
43
+ * The default value for an empty Date field.
44
+ * This value is defined as a default one by .NET
45
+ * @internal
46
+ */
47
+ export declare const EMPTY_DATE_FIELD_VALUE = "0001-01-01T00:00:00Z";
48
+ /**
49
+ * Determines if the passed in field object's value is empty.
50
+ * @param {GenericFieldValue | Partial<Field>} field the field object.
51
+ * Partial<T> type is used here because _field.value_ could be required or optional for the different field types
52
+ * @returns True if the field value is empty
53
+ * @public
54
+ */
55
+ export declare function isFieldValueEmpty(field: GenericFieldValue | Partial<Field> | null | undefined): field is null | undefined;
56
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/layout/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAEzF;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,iBAAiB,EAAE,kBAAkB,GAAG,eAAe,EACvD,SAAS,EAAE,MAAM,GAChB,CAAC,GAAG,SAAS,CAAC;AACjB;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,iBAAiB,EAAE,kBAAkB,GAAG,eAAe,EACvD,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,CAAC,GACd,CAAC,CAAC;AAoCL;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,kBAAkB,EAC7B,eAAe,EAAE,MAAM,GACtB,kBAAkB,EAAE,CAWtB;AAED;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GAAI,aAAa,MAAM,WAE/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,aAAa,MAAM,YAAsC,CAAC;AAE/F;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,yBAAyB,CAAC;AAE7D;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,GAC3D,KAAK,IAAI,IAAI,GAAG,SAAS,CA8C3B"}
@@ -1,2 +1,3 @@
1
- import * as mediaApi from './media-api';
2
- export { mediaApi };
1
+ import * as mediaApi from './media-api';
2
+ export { mediaApi };
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/media/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,QAAQ,EAAE,CAAC"}