@sitecore-content-sdk/core 1.5.0 → 2.0.0-canary.10

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 (337) hide show
  1. package/LICENSE.txt +202 -202
  2. package/dist/cjs/constants.js +7 -21
  3. package/dist/cjs/debug.js +14 -18
  4. package/dist/cjs/graphql-request-client.js +10 -5
  5. package/dist/cjs/index.js +3 -7
  6. package/dist/cjs/native-fetcher.js +1 -1
  7. package/dist/cjs/{utils → tools}/ensurePath.js +1 -0
  8. package/dist/cjs/{media/index.js → tools/index-node.js} +27 -3
  9. package/dist/cjs/tools/index.js +28 -72
  10. package/dist/cjs/tools/{generateMetadata.js → metadata/generateMetadata.js} +2 -2
  11. package/dist/cjs/tools/metadata/index.js +5 -0
  12. package/dist/cjs/{editing → tools/metadata}/metadata.js +1 -6
  13. package/dist/cjs/tools/normalize-env-value.js +22 -0
  14. package/dist/cjs/{utils → tools}/normalize-url.js +6 -0
  15. package/dist/cjs/tools/resolve-edge-url.js +95 -0
  16. package/dist/cjs/{utils → tools}/utils.js +6 -64
  17. package/dist/esm/constants.js +6 -20
  18. package/dist/esm/debug.js +13 -17
  19. package/dist/esm/graphql-request-client.js +10 -5
  20. package/dist/esm/index.js +1 -6
  21. package/dist/esm/native-fetcher.js +1 -1
  22. package/dist/esm/{utils → tools}/ensurePath.js +1 -0
  23. package/dist/esm/tools/index-node.js +22 -0
  24. package/dist/esm/tools/index.js +6 -28
  25. package/dist/esm/tools/{generateMetadata.js → metadata/generateMetadata.js} +2 -2
  26. package/dist/esm/tools/metadata/index.js +1 -0
  27. package/dist/esm/{editing → tools/metadata}/metadata.js +1 -6
  28. package/dist/esm/tools/normalize-env-value.js +19 -0
  29. package/dist/esm/tools/normalize-url.js +7 -0
  30. package/dist/esm/tools/resolve-edge-url.js +89 -0
  31. package/dist/esm/{utils → tools}/utils.js +5 -61
  32. package/node-tools.d.ts +1 -0
  33. package/package.json +98 -163
  34. package/types/constants.d.ts +6 -17
  35. package/types/constants.d.ts.map +1 -1
  36. package/types/debug.d.ts +13 -13
  37. package/types/debug.d.ts.map +1 -1
  38. package/types/graphql-request-client.d.ts +8 -2
  39. package/types/graphql-request-client.d.ts.map +1 -1
  40. package/types/index.d.ts +3 -6
  41. package/types/index.d.ts.map +1 -1
  42. package/types/models.d.ts +0 -31
  43. package/types/models.d.ts.map +1 -1
  44. package/types/{utils → tools}/ensurePath.d.ts +1 -0
  45. package/types/tools/ensurePath.d.ts.map +1 -0
  46. package/types/{utils → tools}/globalCache.d.ts.map +1 -1
  47. package/types/tools/index-node.d.ts +14 -0
  48. package/types/tools/index-node.d.ts.map +1 -0
  49. package/types/tools/index.d.ts +5 -21
  50. package/types/tools/index.d.ts.map +1 -1
  51. package/types/tools/is-server.d.ts.map +1 -0
  52. package/types/tools/metadata/generateMetadata.d.ts.map +1 -0
  53. package/types/tools/metadata/index.d.ts +3 -0
  54. package/types/tools/metadata/index.d.ts.map +1 -0
  55. package/types/{editing → tools/metadata}/metadata.d.ts +9 -1
  56. package/types/tools/metadata/metadata.d.ts.map +1 -0
  57. package/types/tools/normalize-env-value.d.ts +10 -0
  58. package/types/tools/normalize-env-value.d.ts.map +1 -0
  59. package/types/tools/normalize-url.d.ts +8 -0
  60. package/types/tools/normalize-url.d.ts.map +1 -0
  61. package/types/tools/resolve-edge-url.d.ts +52 -0
  62. package/types/tools/resolve-edge-url.d.ts.map +1 -0
  63. package/types/{utils → tools}/timeout-promise.d.ts.map +1 -1
  64. package/types/{utils → tools}/utils.d.ts +6 -26
  65. package/types/tools/utils.d.ts.map +1 -0
  66. package/client.d.ts +0 -1
  67. package/codegen.d.ts +0 -1
  68. package/config-cli.d.ts +0 -1
  69. package/config.d.ts +0 -1
  70. package/dist/cjs/client/constants.js +0 -7
  71. package/dist/cjs/client/edge-proxy.js +0 -24
  72. package/dist/cjs/client/index.js +0 -15
  73. package/dist/cjs/client/models.js +0 -2
  74. package/dist/cjs/client/sitecore-client.js +0 -424
  75. package/dist/cjs/client/utils.js +0 -51
  76. package/dist/cjs/config/define-config.js +0 -195
  77. package/dist/cjs/config/index.js +0 -7
  78. package/dist/cjs/config/models.js +0 -12
  79. package/dist/cjs/config-cli/define-cli-config.js +0 -23
  80. package/dist/cjs/config-cli/index.js +0 -7
  81. package/dist/cjs/config-cli/models.js +0 -8
  82. package/dist/cjs/editing/codegen/index.js +0 -15
  83. package/dist/cjs/editing/codegen/preview.js +0 -306
  84. package/dist/cjs/editing/component-layout-service.js +0 -63
  85. package/dist/cjs/editing/design-library.js +0 -190
  86. package/dist/cjs/editing/editing-service.js +0 -81
  87. package/dist/cjs/editing/index.js +0 -34
  88. package/dist/cjs/editing/models.js +0 -44
  89. package/dist/cjs/editing/utils.js +0 -108
  90. package/dist/cjs/form/form.js +0 -81
  91. package/dist/cjs/form/index.js +0 -7
  92. package/dist/cjs/i18n/dictionary-service.js +0 -144
  93. package/dist/cjs/i18n/index.js +0 -7
  94. package/dist/cjs/i18n/utils.js +0 -16
  95. package/dist/cjs/layout/content-styles.js +0 -72
  96. package/dist/cjs/layout/index.js +0 -24
  97. package/dist/cjs/layout/layout-service.js +0 -68
  98. package/dist/cjs/layout/models.js +0 -39
  99. package/dist/cjs/layout/themes.js +0 -76
  100. package/dist/cjs/layout/utils.js +0 -117
  101. package/dist/cjs/media/media-api.js +0 -100
  102. package/dist/cjs/personalize/index.js +0 -15
  103. package/dist/cjs/personalize/layout-personalizer.js +0 -98
  104. package/dist/cjs/personalize/personalize-service.js +0 -109
  105. package/dist/cjs/personalize/utils.js +0 -143
  106. package/dist/cjs/site/error-pages-service.js +0 -82
  107. package/dist/cjs/site/index.js +0 -26
  108. package/dist/cjs/site/models.js +0 -2
  109. package/dist/cjs/site/redirects-service.js +0 -108
  110. package/dist/cjs/site/robots-service.js +0 -74
  111. package/dist/cjs/site/site-resolver.js +0 -73
  112. package/dist/cjs/site/siteinfo-service.js +0 -94
  113. package/dist/cjs/site/sitemap-xml-service.js +0 -92
  114. package/dist/cjs/site/sitepath-service.js +0 -201
  115. package/dist/cjs/site/utils.js +0 -55
  116. package/dist/cjs/sitecore-service-base.js +0 -36
  117. package/dist/cjs/tools/codegen/component-generation.js +0 -52
  118. package/dist/cjs/tools/codegen/extract-files.js +0 -105
  119. package/dist/cjs/tools/codegen/import-map.js +0 -411
  120. package/dist/cjs/tools/codegen/utils.js +0 -418
  121. package/dist/cjs/tools/generate-map.js +0 -2
  122. package/dist/cjs/tools/generateSites.js +0 -59
  123. package/dist/cjs/tools/scaffold.js +0 -62
  124. package/dist/cjs/tools/templating/components.js +0 -96
  125. package/dist/cjs/tools/templating/index.js +0 -11
  126. package/dist/cjs/tools/templating/plugins.js +0 -80
  127. package/dist/cjs/tools/templating/utils.js +0 -67
  128. package/dist/cjs/utils/env.js +0 -28
  129. package/dist/cjs/utils/index.js +0 -26
  130. package/dist/esm/client/constants.js +0 -4
  131. package/dist/esm/client/edge-proxy.js +0 -19
  132. package/dist/esm/client/index.js +0 -5
  133. package/dist/esm/client/models.js +0 -1
  134. package/dist/esm/client/sitecore-client.js +0 -417
  135. package/dist/esm/client/utils.js +0 -47
  136. package/dist/esm/config/define-config.js +0 -189
  137. package/dist/esm/config/index.js +0 -2
  138. package/dist/esm/config/models.js +0 -9
  139. package/dist/esm/config-cli/define-cli-config.js +0 -19
  140. package/dist/esm/config-cli/index.js +0 -2
  141. package/dist/esm/config-cli/models.js +0 -5
  142. package/dist/esm/editing/codegen/index.js +0 -1
  143. package/dist/esm/editing/codegen/preview.js +0 -288
  144. package/dist/esm/editing/component-layout-service.js +0 -56
  145. package/dist/esm/editing/design-library.js +0 -178
  146. package/dist/esm/editing/editing-service.js +0 -74
  147. package/dist/esm/editing/index.js +0 -6
  148. package/dist/esm/editing/models.js +0 -41
  149. package/dist/esm/editing/utils.js +0 -98
  150. package/dist/esm/form/form.js +0 -72
  151. package/dist/esm/form/index.js +0 -1
  152. package/dist/esm/i18n/dictionary-service.js +0 -137
  153. package/dist/esm/i18n/index.js +0 -2
  154. package/dist/esm/i18n/utils.js +0 -13
  155. package/dist/esm/layout/content-styles.js +0 -64
  156. package/dist/esm/layout/index.js +0 -6
  157. package/dist/esm/layout/layout-service.js +0 -61
  158. package/dist/esm/layout/models.js +0 -36
  159. package/dist/esm/layout/themes.js +0 -71
  160. package/dist/esm/layout/utils.js +0 -109
  161. package/dist/esm/media/index.js +0 -2
  162. package/dist/esm/media/media-api.js +0 -90
  163. package/dist/esm/personalize/index.js +0 -3
  164. package/dist/esm/personalize/layout-personalizer.js +0 -93
  165. package/dist/esm/personalize/personalize-service.js +0 -102
  166. package/dist/esm/personalize/utils.js +0 -135
  167. package/dist/esm/site/error-pages-service.js +0 -75
  168. package/dist/esm/site/index.js +0 -8
  169. package/dist/esm/site/models.js +0 -1
  170. package/dist/esm/site/redirects-service.js +0 -101
  171. package/dist/esm/site/robots-service.js +0 -67
  172. package/dist/esm/site/site-resolver.js +0 -69
  173. package/dist/esm/site/siteinfo-service.js +0 -87
  174. package/dist/esm/site/sitemap-xml-service.js +0 -85
  175. package/dist/esm/site/sitepath-service.js +0 -193
  176. package/dist/esm/site/utils.js +0 -49
  177. package/dist/esm/sitecore-service-base.js +0 -29
  178. package/dist/esm/tools/codegen/component-generation.js +0 -44
  179. package/dist/esm/tools/codegen/extract-files.js +0 -99
  180. package/dist/esm/tools/codegen/import-map.js +0 -368
  181. package/dist/esm/tools/codegen/utils.js +0 -373
  182. package/dist/esm/tools/generate-map.js +0 -1
  183. package/dist/esm/tools/generateSites.js +0 -52
  184. package/dist/esm/tools/scaffold.js +0 -54
  185. package/dist/esm/tools/templating/components.js +0 -59
  186. package/dist/esm/tools/templating/index.js +0 -3
  187. package/dist/esm/tools/templating/plugins.js +0 -72
  188. package/dist/esm/tools/templating/utils.js +0 -59
  189. package/dist/esm/utils/env.js +0 -24
  190. package/dist/esm/utils/index.js +0 -4
  191. package/dist/esm/utils/normalize-url.js +0 -1
  192. package/editing.d.ts +0 -1
  193. package/i18n.d.ts +0 -1
  194. package/layout.d.ts +0 -1
  195. package/media.d.ts +0 -1
  196. package/personalize.d.ts +0 -1
  197. package/site.d.ts +0 -1
  198. package/types/client/constants.d.ts +0 -5
  199. package/types/client/constants.d.ts.map +0 -1
  200. package/types/client/edge-proxy.d.ts +0 -18
  201. package/types/client/edge-proxy.d.ts.map +0 -1
  202. package/types/client/index.d.ts +0 -8
  203. package/types/client/index.d.ts.map +0 -1
  204. package/types/client/models.d.ts +0 -21
  205. package/types/client/models.d.ts.map +0 -1
  206. package/types/client/sitecore-client.d.ts +0 -338
  207. package/types/client/sitecore-client.d.ts.map +0 -1
  208. package/types/client/utils.d.ts +0 -15
  209. package/types/client/utils.d.ts.map +0 -1
  210. package/types/config/define-config.d.ts +0 -20
  211. package/types/config/define-config.d.ts.map +0 -1
  212. package/types/config/index.d.ts +0 -3
  213. package/types/config/index.d.ts.map +0 -1
  214. package/types/config/models.d.ts +0 -287
  215. package/types/config/models.d.ts.map +0 -1
  216. package/types/config-cli/define-cli-config.d.ts +0 -9
  217. package/types/config-cli/define-cli-config.d.ts.map +0 -1
  218. package/types/config-cli/index.d.ts +0 -3
  219. package/types/config-cli/index.d.ts.map +0 -1
  220. package/types/config-cli/models.d.ts +0 -6
  221. package/types/config-cli/models.d.ts.map +0 -1
  222. package/types/editing/codegen/index.d.ts +0 -2
  223. package/types/editing/codegen/index.d.ts.map +0 -1
  224. package/types/editing/codegen/preview.d.ts +0 -289
  225. package/types/editing/codegen/preview.d.ts.map +0 -1
  226. package/types/editing/component-layout-service.d.ts +0 -84
  227. package/types/editing/component-layout-service.d.ts.map +0 -1
  228. package/types/editing/design-library.d.ts +0 -118
  229. package/types/editing/design-library.d.ts.map +0 -1
  230. package/types/editing/editing-service.d.ts +0 -72
  231. package/types/editing/editing-service.d.ts.map +0 -1
  232. package/types/editing/index.d.ts +0 -7
  233. package/types/editing/index.d.ts.map +0 -1
  234. package/types/editing/metadata.d.ts.map +0 -1
  235. package/types/editing/models.d.ts +0 -103
  236. package/types/editing/models.d.ts.map +0 -1
  237. package/types/editing/utils.d.ts +0 -91
  238. package/types/editing/utils.d.ts.map +0 -1
  239. package/types/form/form.d.ts +0 -25
  240. package/types/form/form.d.ts.map +0 -1
  241. package/types/form/index.d.ts +0 -2
  242. package/types/form/index.d.ts.map +0 -1
  243. package/types/i18n/dictionary-service.d.ts +0 -135
  244. package/types/i18n/dictionary-service.d.ts.map +0 -1
  245. package/types/i18n/index.d.ts +0 -3
  246. package/types/i18n/index.d.ts.map +0 -1
  247. package/types/i18n/utils.d.ts +0 -9
  248. package/types/i18n/utils.d.ts.map +0 -1
  249. package/types/layout/content-styles.d.ts +0 -20
  250. package/types/layout/content-styles.d.ts.map +0 -1
  251. package/types/layout/index.d.ts +0 -6
  252. package/types/layout/index.d.ts.map +0 -1
  253. package/types/layout/layout-service.d.ts +0 -45
  254. package/types/layout/layout-service.d.ts.map +0 -1
  255. package/types/layout/models.d.ts +0 -174
  256. package/types/layout/models.d.ts.map +0 -1
  257. package/types/layout/themes.d.ts +0 -13
  258. package/types/layout/themes.d.ts.map +0 -1
  259. package/types/layout/utils.d.ts +0 -56
  260. package/types/layout/utils.d.ts.map +0 -1
  261. package/types/media/index.d.ts +0 -3
  262. package/types/media/index.d.ts.map +0 -1
  263. package/types/media/media-api.d.ts +0 -60
  264. package/types/media/media-api.d.ts.map +0 -1
  265. package/types/personalize/index.d.ts +0 -4
  266. package/types/personalize/index.d.ts.map +0 -1
  267. package/types/personalize/layout-personalizer.d.ts +0 -29
  268. package/types/personalize/layout-personalizer.d.ts.map +0 -1
  269. package/types/personalize/personalize-service.d.ts +0 -90
  270. package/types/personalize/personalize-service.d.ts.map +0 -1
  271. package/types/personalize/utils.d.ts +0 -78
  272. package/types/personalize/utils.d.ts.map +0 -1
  273. package/types/site/error-pages-service.d.ts +0 -64
  274. package/types/site/error-pages-service.d.ts.map +0 -1
  275. package/types/site/index.d.ts +0 -10
  276. package/types/site/index.d.ts.map +0 -1
  277. package/types/site/models.d.ts +0 -23
  278. package/types/site/models.d.ts.map +0 -1
  279. package/types/site/redirects-service.d.ts +0 -92
  280. package/types/site/redirects-service.d.ts.map +0 -1
  281. package/types/site/robots-service.d.ts +0 -57
  282. package/types/site/robots-service.d.ts.map +0 -1
  283. package/types/site/site-resolver.d.ts +0 -28
  284. package/types/site/site-resolver.d.ts.map +0 -1
  285. package/types/site/siteinfo-service.d.ts +0 -65
  286. package/types/site/siteinfo-service.d.ts.map +0 -1
  287. package/types/site/sitemap-xml-service.d.ts +0 -63
  288. package/types/site/sitemap-xml-service.d.ts.map +0 -1
  289. package/types/site/sitepath-service.d.ts +0 -137
  290. package/types/site/sitepath-service.d.ts.map +0 -1
  291. package/types/site/utils.d.ts +0 -41
  292. package/types/site/utils.d.ts.map +0 -1
  293. package/types/sitecore-service-base.d.ts +0 -31
  294. package/types/sitecore-service-base.d.ts.map +0 -1
  295. package/types/tools/codegen/component-generation.d.ts +0 -50
  296. package/types/tools/codegen/component-generation.d.ts.map +0 -1
  297. package/types/tools/codegen/extract-files.d.ts +0 -24
  298. package/types/tools/codegen/extract-files.d.ts.map +0 -1
  299. package/types/tools/codegen/import-map.d.ts +0 -102
  300. package/types/tools/codegen/import-map.d.ts.map +0 -1
  301. package/types/tools/codegen/utils.d.ts +0 -76
  302. package/types/tools/codegen/utils.d.ts.map +0 -1
  303. package/types/tools/generate-map.d.ts +0 -36
  304. package/types/tools/generate-map.d.ts.map +0 -1
  305. package/types/tools/generateMetadata.d.ts.map +0 -1
  306. package/types/tools/generateSites.d.ts +0 -25
  307. package/types/tools/generateSites.d.ts.map +0 -1
  308. package/types/tools/scaffold.d.ts +0 -27
  309. package/types/tools/scaffold.d.ts.map +0 -1
  310. package/types/tools/templating/components.d.ts +0 -104
  311. package/types/tools/templating/components.d.ts.map +0 -1
  312. package/types/tools/templating/index.d.ts +0 -4
  313. package/types/tools/templating/index.d.ts.map +0 -1
  314. package/types/tools/templating/plugins.d.ts +0 -71
  315. package/types/tools/templating/plugins.d.ts.map +0 -1
  316. package/types/tools/templating/utils.d.ts +0 -42
  317. package/types/tools/templating/utils.d.ts.map +0 -1
  318. package/types/utils/ensurePath.d.ts.map +0 -1
  319. package/types/utils/env.d.ts +0 -9
  320. package/types/utils/env.d.ts.map +0 -1
  321. package/types/utils/index.d.ts +0 -5
  322. package/types/utils/index.d.ts.map +0 -1
  323. package/types/utils/is-server.d.ts.map +0 -1
  324. package/types/utils/normalize-url.d.ts +0 -2
  325. package/types/utils/normalize-url.d.ts.map +0 -1
  326. package/types/utils/utils.d.ts.map +0 -1
  327. package/utils.d.ts +0 -1
  328. /package/dist/cjs/{utils → tools}/globalCache.js +0 -0
  329. /package/dist/cjs/{utils → tools}/is-server.js +0 -0
  330. /package/dist/cjs/{utils → tools}/timeout-promise.js +0 -0
  331. /package/dist/esm/{utils → tools}/globalCache.js +0 -0
  332. /package/dist/esm/{utils → tools}/is-server.js +0 -0
  333. /package/dist/esm/{utils → tools}/timeout-promise.js +0 -0
  334. /package/types/{utils → tools}/globalCache.d.ts +0 -0
  335. /package/types/{utils → tools}/is-server.d.ts +0 -0
  336. /package/types/tools/{generateMetadata.d.ts → metadata/generateMetadata.d.ts} +0 -0
  337. /package/types/{utils → tools}/timeout-promise.d.ts +0 -0
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Normalizes values that may come from environment variables.
3
+ * In Node, setting `process.env.FOO = undefined` results in the string 'undefined',
4
+ * which should be treated as if the variable is not set.
5
+ * @param {string | undefined} value - Possibly undefined env-like value
6
+ * @returns {string | undefined} A usable string value, or undefined if not meaningful
7
+ * @internal
8
+ */
9
+ export function normalizeEnvValue(value) {
10
+ if (!value)
11
+ return undefined;
12
+ const trimmed = value.trim();
13
+ if (!trimmed)
14
+ return undefined;
15
+ const lowered = trimmed.toLowerCase();
16
+ if (lowered === 'undefined' || lowered === 'null')
17
+ return undefined;
18
+ return trimmed;
19
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Normalize a URL by removing the trailing slash
3
+ * @param {string} url - The URL to normalize
4
+ * @returns {string} The normalized URL
5
+ * @public
6
+ */
7
+ export const normalizeUrl = (url) => (url.endsWith('/') ? url.slice(0, -1) : url);
@@ -0,0 +1,89 @@
1
+ import { SITECORE_EDGE_PLATFORM_URL_DEFAULT, SITECORE_EXPERIENCE_EDGE_URL_DEFAULT, } from '../constants';
2
+ import { normalizeEnvValue } from './normalize-env-value';
3
+ import { normalizeUrl } from './normalize-url';
4
+ /**
5
+ * Environment variable name for the custom Edge Platform hostname (framework-agnostic).
6
+ * Used for service endpoints (GraphQL, APIs, forms). Server-side only.
7
+ * @public
8
+ */
9
+ export const SITECORE_EDGE_PLATFORM_HOSTNAME_ENV = 'SITECORE_EDGE_PLATFORM_HOSTNAME';
10
+ /**
11
+ * Environment variable name for the custom Experience Edge hostname.
12
+ * Used only when rewriting media URLs in layout/editing (rewrite-edge-host). Server-side only.
13
+ * @public
14
+ */
15
+ export const SITECORE_EXPERIENCE_EDGE_HOSTNAME_ENV = 'SITECORE_EXPERIENCE_EDGE_HOSTNAME';
16
+ /**
17
+ * Resolves the Sitecore Edge URL based on configuration and environment.
18
+ *
19
+ * Priority order:
20
+ * 1. Explicit `edgeUrl` parameter (if provided and not empty)
21
+ * 2. `SITECORE_EDGE_PLATFORM_HOSTNAME` environment variable
22
+ * 3. Default Edge Platform URL (`https://edge-platform.sitecorecloud.io`)
23
+ *
24
+ * The hostname env var can be provided as:
25
+ * - Full URL: `https://my-custom-edge.example.com`
26
+ * - Hostname only: `my-custom-edge.example.com` (will be prefixed with `https://`)
27
+ * @param {string} [edgeUrl] - Optional explicit Edge URL to use (takes precedence if provided)
28
+ * @returns {string} The resolved Edge Platform base URL (normalized, no trailing slash)
29
+ * @public
30
+ * @example
31
+ * resolveEdgeUrl() // => 'https://my-tenant.edge.example.com'
32
+ * @example
33
+ * resolveEdgeUrl('https://custom.edge.com') // => 'https://custom.edge.com'
34
+ * @example
35
+ * resolveEdgeUrl() // => 'https://edge-platform.sitecorecloud.io'
36
+ */
37
+ export function resolveEdgeUrl(edgeUrl) {
38
+ // Use explicit edgeUrl if provided and not empty
39
+ const explicit = normalizeEnvValue(edgeUrl);
40
+ if (explicit) {
41
+ return normalizeUrl(explicit);
42
+ }
43
+ // Check for custom hostname env var
44
+ const hostnameEnvVar = normalizeEnvValue(process.env[SITECORE_EDGE_PLATFORM_HOSTNAME_ENV]);
45
+ if (hostnameEnvVar) {
46
+ return normalizeHostnameToUrl(hostnameEnvVar);
47
+ }
48
+ return SITECORE_EDGE_PLATFORM_URL_DEFAULT;
49
+ }
50
+ /**
51
+ * Resolves the Experience Edge URL for media URL rewriting.
52
+ * Use only when rewriting media URLs in layout/editing (e.g. rewriteEdgeHostInResponse).
53
+ * Priority: SITECORE_EXPERIENCE_EDGE_HOSTNAME env, then default (edge.sitecorecloud.io).
54
+ * Server-side only.
55
+ * @returns {string} The Experience Edge base URL (no trailing slash)
56
+ * @public
57
+ */
58
+ export function resolveExperienceEdgeUrl() {
59
+ const hostnameEnvVar = normalizeEnvValue(process.env[SITECORE_EXPERIENCE_EDGE_HOSTNAME_ENV]);
60
+ if (hostnameEnvVar) {
61
+ return normalizeHostnameToUrl(hostnameEnvVar);
62
+ }
63
+ return SITECORE_EXPERIENCE_EDGE_URL_DEFAULT;
64
+ }
65
+ /**
66
+ * Resolves the Edge URL for static files (e.g. stylesheets) by ignoring the custom hostname.
67
+ * Use this when the custom host does not serve static file paths (e.g. /v1/files/...).
68
+ * Returns the default Edge Platform URL.
69
+ * @returns {string} The Edge Platform base URL for static files (no trailing slash)
70
+ * @public
71
+ */
72
+ export function resolveEdgeUrlForStaticFiles() {
73
+ return SITECORE_EDGE_PLATFORM_URL_DEFAULT;
74
+ }
75
+ /**
76
+ * Normalizes a hostname or URL to a full HTTPS URL without trailing slash.
77
+ * @param {string} hostnameOrUrl - A hostname (e.g., 'my.domain.com') or full URL (e.g., 'https://my.domain.com')
78
+ * @returns {string} A normalized HTTPS URL
79
+ * @internal
80
+ */
81
+ function normalizeHostnameToUrl(hostnameOrUrl) {
82
+ const trimmed = hostnameOrUrl.trim();
83
+ // If it already has a protocol, normalize and return
84
+ if (trimmed.startsWith('https://') || trimmed.startsWith('http://')) {
85
+ return normalizeUrl(trimmed);
86
+ }
87
+ // Otherwise, treat as hostname and add https://
88
+ return normalizeUrl(`https://${trimmed}`);
89
+ }
@@ -27,7 +27,6 @@ export function resolveUrl(urlBase, params = {}) {
27
27
  // This is a better way to work with URLs since it handles different user input
28
28
  // edge cases. This works in Node and all browser except IE11.
29
29
  // https://developer.mozilla.org/en-US/docs/Web/API/URL
30
- // TODO: Verify our browser support requirements.
31
30
  if (isServer()) {
32
31
  const url = new URL(urlBase);
33
32
  for (const key in params) {
@@ -42,21 +41,6 @@ export function resolveUrl(urlBase, params = {}) {
42
41
  const result = urlBase.indexOf('?') !== -1 ? `${urlBase}&${qs}` : `${urlBase}?${qs}`;
43
42
  return result;
44
43
  }
45
- /**
46
- * Checks if the given URL is an absolute URL
47
- * @param {string} url - The URL to check.
48
- * @returns {boolean} - Returns true if the URL is an absolute URL, otherwise false.
49
- * @public
50
- */
51
- export const isAbsoluteUrl = (url) => {
52
- if (!url) {
53
- return false;
54
- }
55
- if (typeof url !== 'string') {
56
- throw new TypeError('Expected a string');
57
- }
58
- return /^[a-z][a-z0-9+.-]*:/.test(url);
59
- };
60
44
  /**
61
45
  * Indicates whether the error is a timeout error
62
46
  * @param {unknown} error error
@@ -83,53 +67,13 @@ const convertToWildcardRegex = (pattern) => {
83
67
  export const getAllowedOriginsFromEnv = () => process.env.JSS_ALLOWED_ORIGINS
84
68
  ? process.env.JSS_ALLOWED_ORIGINS.replace(' ', '').split(',')
85
69
  : [];
86
- /**
87
- * Tests origin from incoming request against allowed origins list that can be
88
- * set in JSS's JSS_ALLOWED_ORIGINS env variable, passed via allowedOrigins param and/or
89
- * be already set in Access-Control-Allow-Origin by other logic.
90
- * Applies Access-Control-Allow-Origin and Access-Control-Allow-Methods on match
91
- * Also applies Access-Control-Allow-Headers for preflight requests
92
- * @param {IncomingMessage} req incoming request
93
- * @param {OutgoingMessage} res response to set CORS headers for
94
- * @param {string[]} [allowedOrigins] additional list of origins to test against
95
- * @returns true if incoming origin matches the allowed lists, false when it does not
96
- * @deprecated use getEnforcedCorsHeaders instead
97
- * @public
98
- */
99
- export const enforceCors = (req, res, allowedOrigins) => {
100
- // origin in not present for non-CORS requests (e.g. server-side) - so we skip the checks
101
- if (!req.headers.origin) {
102
- return true;
103
- }
104
- // 3 sources of allowed origins are considered:
105
- // the env value
106
- const defaultAllowedOrigins = getAllowedOriginsFromEnv();
107
- // the allowedOrigins prop
108
- allowedOrigins = defaultAllowedOrigins.concat(allowedOrigins || []);
109
- // and the existing CORS header, if present (i.e. set by nextjs config)
110
- const presetCors = res.getHeader('Access-Control-Allow-Origin');
111
- if (presetCors) {
112
- allowedOrigins.push(presetCors);
113
- }
114
- const origin = req.headers.origin;
115
- if (origin &&
116
- allowedOrigins.some((allowedOrigin) => origin === allowedOrigin || new RegExp(convertToWildcardRegex(allowedOrigin)).test(origin))) {
117
- res.setHeader('Access-Control-Allow-Origin', origin);
118
- res.setHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS, DELETE, PUT, PATCH');
119
- // set the allowed headers for preflight requests
120
- if (req.method === 'OPTIONS') {
121
- res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
122
- }
123
- return true;
124
- }
125
- return false;
126
- };
127
70
  /**
128
71
  * Gets enforced CORS headers
129
- * @param {string} requestMethod - The HTTP method of the request.
130
- * @param {IncomingHttpHeaders | Headers} headers - The headers of the request.
131
- * @param {string | string[]} presetCorsHeader - The preset CORS header.
132
- * @param {string[]} [allowedOrigins] - The allowed origins.
72
+ * @param {object} options - The options
73
+ * @param {string} options.requestMethod - The HTTP method of the request.
74
+ * @param {IncomingHttpHeaders | Headers} options.headers - The headers of the request.
75
+ * @param {string | string[]} options.presetCorsHeader - The preset CORS header.
76
+ * @param {string[]} [options.allowedOrigins] - The allowed origins.
133
77
  * @returns {Record<string, string>} - The enforced CORS headers.
134
78
  * @public
135
79
  */
@@ -0,0 +1 @@
1
+ export * from './types/tools/index-node';
package/package.json CHANGED
@@ -1,163 +1,98 @@
1
- {
2
- "name": "@sitecore-content-sdk/core",
3
- "version": "1.5.0",
4
- "main": "dist/cjs/index.js",
5
- "module": "dist/esm/index.js",
6
- "sideEffects": false,
7
- "publishConfig": {
8
- "access": "public",
9
- "registry": "https://registry.npmjs.org/"
10
- },
11
- "scripts": {
12
- "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
13
- "clean": "del-cli dist types",
14
- "lint": "eslint \"./src/**/*.ts\"",
15
- "test": "mocha \"./src/**/*.test.ts\"",
16
- "prepublishOnly": "npm run build",
17
- "coverage": "nyc npm test",
18
- "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/client/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts --entryPoints src/codegen/index.ts --githubPages false",
19
- "api-extractor": "npm run build && api-extractor run --local --verbose",
20
- "api-extractor:verify": "api-extractor run"
21
- },
22
- "engines": {
23
- "node": ">=22"
24
- },
25
- "author": {
26
- "name": "Sitecore Corporation",
27
- "url": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html"
28
- },
29
- "repository": {
30
- "type": "git",
31
- "url": "https://github.com/Sitecore/content-sdk"
32
- },
33
- "license": "Apache-2.0",
34
- "homepage": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html",
35
- "bugs": {
36
- "url": "https://github.com/sitecore/content-sdk/issues"
37
- },
38
- "devDependencies": {
39
- "@sitecore-cloudsdk/events": "^0.5.1",
40
- "@stylistic/eslint-plugin": "^5.2.2",
41
- "@types/chai": "^5.2.2",
42
- "@types/chai-spies": "^1.0.6",
43
- "@types/chai-string": "^1.4.5",
44
- "@types/debug": "^4.1.12",
45
- "@types/jsdom": "^21.1.7",
46
- "@types/memory-cache": "^0.2.6",
47
- "@types/mocha": "^10.0.10",
48
- "@types/node": "^22.15.14",
49
- "@types/proxyquire": "^1.3.31",
50
- "@types/sinon": "^17.0.4",
51
- "@types/sinon-chai": "^4.0.0",
52
- "@types/url-parse": "1.4.11",
53
- "@typescript-eslint/eslint-plugin": "8.39.0",
54
- "@typescript-eslint/parser": "8.39.0",
55
- "chai": "^4.4.1",
56
- "chai-spies": "^1.1.0",
57
- "chai-string": "^1.6.0",
58
- "del-cli": "^6.0.0",
59
- "eslint": "^9.32.0",
60
- "eslint-config-prettier": "^10.1.8",
61
- "eslint-plugin-import": "2.32.0",
62
- "eslint-plugin-jsdoc": "52.0.3",
63
- "eslint-plugin-prettier": "^4.0.0",
64
- "jsdom": "^26.1.0",
65
- "mocha": "^11.2.2",
66
- "nock": "14.0.0-beta.7",
67
- "nyc": "^17.1.0",
68
- "prettier": "^2.8.0",
69
- "proxyquire": "^2.1.3",
70
- "sinon": "^20.0.0",
71
- "tslib": "^2.8.1",
72
- "tsx": "^4.19.4",
73
- "typescript": "~5.8.3"
74
- },
75
- "peerDependencies": {
76
- "@sitecore-cloudsdk/events": "^0.5.1"
77
- },
78
- "dependencies": {
79
- "chalk": "^4.1.2",
80
- "debug": "^4.4.0",
81
- "glob": "^11.0.2",
82
- "graphql": "^16.11.0",
83
- "graphql-request": "^6.1.0",
84
- "memory-cache": "^0.2.0",
85
- "sinon-chai": "^4.0.0",
86
- "url-parse": "^1.5.10"
87
- },
88
- "description": "",
89
- "types": "types/index.d.ts",
90
- "gitHead": "ea5d751f45a07b8ae5359f92a4234fcfe4b166b2",
91
- "files": [
92
- "dist",
93
- "types",
94
- "/*.d.ts"
95
- ],
96
- "exports": {
97
- ".": {
98
- "import": "./dist/esm/index.js",
99
- "require": "./dist/cjs/index.js",
100
- "types": "./types/index.d.ts"
101
- },
102
- "./client": {
103
- "import": "./dist/esm/client/index.js",
104
- "require": "./dist/cjs/client/index.js",
105
- "types": "./types/client/index.d.ts"
106
- },
107
- "./config": {
108
- "import": "./dist/esm/config/index.js",
109
- "require": "./dist/cjs/config/index.js",
110
- "types": "./types/config/index.d.ts"
111
- },
112
- "./config-cli": {
113
- "import": "./dist/esm/config-cli/index.js",
114
- "require": "./dist/cjs/config-cli/index.js",
115
- "types": "./types/config-cli/index.d.ts"
116
- },
117
- "./codegen": {
118
- "import": "./dist/esm/editing/codegen/index.js",
119
- "require": "./dist/cjs/editing/codegen/index.js",
120
- "types": "./types/editing/codegen/index.d.ts"
121
- },
122
- "./editing": {
123
- "import": "./dist/esm/editing/index.js",
124
- "require": "./dist/cjs/editing/index.js",
125
- "types": "./types/editing/index.d.ts"
126
- },
127
- "./i18n": {
128
- "import": "./dist/esm/i18n/index.js",
129
- "require": "./dist/cjs/i18n/index.js",
130
- "types": "./types/i18n/index.d.ts"
131
- },
132
- "./layout": {
133
- "import": "./dist/esm/layout/index.js",
134
- "require": "./dist/cjs/layout/index.js",
135
- "types": "./types/layout/index.d.ts"
136
- },
137
- "./media": {
138
- "import": "./dist/esm/media/index.js",
139
- "require": "./dist/cjs/media/index.js",
140
- "types": "./types/media/index.d.ts"
141
- },
142
- "./personalize": {
143
- "import": "./dist/esm/personalize/index.js",
144
- "require": "./dist/cjs/personalize/index.js",
145
- "types": "./types/personalize/index.d.ts"
146
- },
147
- "./site": {
148
- "import": "./dist/esm/site/index.js",
149
- "require": "./dist/cjs/site/index.js",
150
- "types": "./types/site/index.d.ts"
151
- },
152
- "./tools": {
153
- "import": "./dist/esm/tools/index.js",
154
- "require": "./dist/cjs/tools/index.js",
155
- "types": "./types/tools/index.d.ts"
156
- },
157
- "./utils": {
158
- "import": "./dist/esm/utils/index.js",
159
- "require": "./dist/cjs/utils/index.js",
160
- "types": "./types/utils/index.d.ts"
161
- }
162
- }
163
- }
1
+ {
2
+ "name": "@sitecore-content-sdk/core",
3
+ "version": "2.0.0-canary.10",
4
+ "main": "dist/cjs/index.js",
5
+ "module": "dist/esm/index.js",
6
+ "sideEffects": false,
7
+ "publishConfig": {
8
+ "access": "public",
9
+ "registry": "https://registry.npmjs.org/"
10
+ },
11
+ "scripts": {
12
+ "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
13
+ "clean": "del-cli dist types",
14
+ "lint": "eslint \"./src/**/*.ts\"",
15
+ "test": "mocha \"./src/**/*.test.ts\"",
16
+ "prepublishOnly": "npm run build",
17
+ "coverage": "nyc npm test",
18
+ "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/tools/index.ts --entryPoints src/tools/index-node.ts --githubPages false",
19
+ "api-extractor": "npm run build && api-extractor run --local --verbose",
20
+ "api-extractor:verify": "api-extractor run"
21
+ },
22
+ "engines": {
23
+ "node": ">=24"
24
+ },
25
+ "author": {
26
+ "name": "Sitecore Corporation",
27
+ "url": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html"
28
+ },
29
+ "repository": {
30
+ "type": "git",
31
+ "url": "https://github.com/Sitecore/content-sdk"
32
+ },
33
+ "license": "Apache-2.0",
34
+ "homepage": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html",
35
+ "bugs": {
36
+ "url": "https://github.com/sitecore/content-sdk/issues"
37
+ },
38
+ "devDependencies": {
39
+ "@stylistic/eslint-plugin": "^5.2.2",
40
+ "@types/chai": "^5.2.2",
41
+ "@types/chai-spies": "^1.0.6",
42
+ "@types/debug": "^4.1.12",
43
+ "@types/memory-cache": "^0.2.6",
44
+ "@types/mocha": "^10.0.10",
45
+ "@types/node": "^24.10.4",
46
+ "@types/sinon": "^17.0.4",
47
+ "@types/url-parse": "1.4.11",
48
+ "@typescript-eslint/eslint-plugin": "8.39.0",
49
+ "@typescript-eslint/parser": "8.39.0",
50
+ "chai": "^4.4.1",
51
+ "chai-spies": "^1.1.0",
52
+ "del-cli": "^6.0.0",
53
+ "eslint": "^9.32.0",
54
+ "eslint-config-prettier": "^10.1.8",
55
+ "eslint-plugin-import": "2.32.0",
56
+ "eslint-plugin-jsdoc": "52.0.3",
57
+ "eslint-plugin-prettier": "^4.0.0",
58
+ "mocha": "^11.2.2",
59
+ "nock": "14.0.0-beta.7",
60
+ "nyc": "^17.1.0",
61
+ "prettier": "^2.8.0",
62
+ "sinon": "^20.0.0",
63
+ "tsx": "^4.19.4",
64
+ "typescript": "~5.8.3"
65
+ },
66
+ "dependencies": {
67
+ "debug": "^4.4.0",
68
+ "graphql": "^16.11.0",
69
+ "graphql-request": "^6.1.0",
70
+ "memory-cache": "^0.2.0",
71
+ "url-parse": "^1.5.10"
72
+ },
73
+ "description": "",
74
+ "types": "types/index.d.ts",
75
+ "gitHead": "6246e4787e22778e64c90bcd9292a9988b3552a8",
76
+ "files": [
77
+ "dist",
78
+ "types",
79
+ "/*.d.ts"
80
+ ],
81
+ "exports": {
82
+ ".": {
83
+ "import": "./dist/esm/index.js",
84
+ "require": "./dist/cjs/index.js",
85
+ "types": "./types/index.d.ts"
86
+ },
87
+ "./tools": {
88
+ "import": "./dist/esm/tools/index.js",
89
+ "require": "./dist/cjs/tools/index.js",
90
+ "types": "./types/tools/index.d.ts"
91
+ },
92
+ "./node-tools": {
93
+ "import": "./dist/esm/tools/index-node.js",
94
+ "require": "./dist/cjs/tools/index-node.js",
95
+ "types": "./types/tools/index-node.d.ts"
96
+ }
97
+ }
98
+ }
@@ -1,26 +1,15 @@
1
1
  /**
2
- * Sitecore template IDs
3
- * @public
4
- */
5
- export declare enum SitecoreTemplateId {
6
- ContentSdkApp = "061cba1554744b918a0617903b102b82",
7
- DictionaryEntry = "6d1cd89719364a3aa511289a94c2a7b1"
8
- }
9
- /**
10
- * Site name error
11
- * @internal
12
- */
13
- export declare const siteNameError = "The siteName cannot be empty";
14
- /**
15
- * Default Sitecore edge URL
2
+ * Default Edge Platform URL (edge-platform.sitecorecloud.io). Used for service endpoints
3
+ * (GraphQL, content API, forms, layout, static files) when no custom hostname is configured.
16
4
  * @internal
17
5
  */
18
- export declare const SITECORE_EDGE_URL_DEFAULT = "https://edge-platform.sitecorecloud.io";
6
+ export declare const SITECORE_EDGE_PLATFORM_URL_DEFAULT = "https://edge-platform.sitecorecloud.io";
19
7
  /**
20
- * Hidden rendering name
8
+ * Default Experience Edge URL (edge.sitecorecloud.io). Used only when replacing media URLs
9
+ * in layout/editing responses (rewrite-edge-host). Do not use for service endpoints.
21
10
  * @internal
22
11
  */
23
- export declare const HIDDEN_RENDERING_NAME = "Hidden Rendering";
12
+ export declare const SITECORE_EXPERIENCE_EDGE_URL_DEFAULT = "https://edge.sitecorecloud.io";
24
13
  /**
25
14
  * Claims URL
26
15
  * @internal
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,kBAAkB;IAE5B,aAAa,qCAAqC;IAGlD,eAAe,qCAAqC;CACrD;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,iCAAiC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,2CAA2C,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,MAAM,yCAAyC,CAAC;AAC7D;;;GAGG;AACH,eAAO,MAAM,4BAA4B,kCAAkC,CAAC;AAC5E;;;GAGG;AACH,eAAO,MAAM,8BAA8B,iCAAiC,CAAC;AAC7E;;;GAGG;AACH,eAAO,MAAM,8BAA8B,kDAAkD,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,2CAA2C,CAAC;AAE3F;;;;GAIG;AACH,eAAO,MAAM,oCAAoC,kCAAkC,CAAC;AAEpF;;;GAGG;AACH,eAAO,MAAM,MAAM,yCAAyC,CAAC;AAC7D;;;GAGG;AACH,eAAO,MAAM,4BAA4B,kCAAkC,CAAC;AAC5E;;;GAGG;AACH,eAAO,MAAM,8BAA8B,iCAAiC,CAAC;AAC7E;;;GAGG;AACH,eAAO,MAAM,8BAA8B,kDAAkD,CAAC"}
package/types/debug.d.ts CHANGED
@@ -1,4 +1,17 @@
1
1
  import debug from 'debug';
2
+ /**
3
+ * Debug module
4
+ * @public
5
+ */
6
+ export declare const debugModule: debug.Debug & {
7
+ debug: debug.Debug;
8
+ default: debug.Debug;
9
+ };
10
+ /**
11
+ * Debug namespace
12
+ * @public
13
+ */
14
+ export declare const debugNamespace = "content-sdk";
2
15
  /**
3
16
  * Debugger type
4
17
  * @public
@@ -15,21 +28,8 @@ export declare const enableDebug: (namespaces: string) => void;
15
28
  * See {@link https://www.npmjs.com/package/debug} for details.
16
29
  */
17
30
  declare const _default: {
18
- search: debug.Debugger;
19
31
  common: debug.Debugger;
20
- form: debug.Debugger;
21
32
  http: debug.Debugger;
22
- layout: debug.Debugger;
23
- dictionary: debug.Debugger;
24
- editing: debug.Debugger;
25
- sitemap: debug.Debugger;
26
- multisite: debug.Debugger;
27
- robots: debug.Debugger;
28
- redirects: debug.Debugger;
29
- personalize: debug.Debugger;
30
- locale: debug.Debugger;
31
- errorpages: debug.Debugger;
32
- proxy: debug.Debugger;
33
33
  };
34
34
  export default _default;
35
35
  //# sourceMappingURL=debug.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;AActC;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,YAAY,MAAM,SAA6B,CAAC;AAE5E;;;GAGG;;;;;;;;;;;;;;;;;;AACH,wBAgBE"}
1
+ {"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B;;;GAGG;AACH,eAAO,MAAM,WAAW;;;CAAQ,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;AActC;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,YAAY,MAAM,SAA6B,CAAC;AAE5E;;;GAGG;;;;;AACH,wBAGE"}
@@ -31,6 +31,10 @@ export type GraphQLRequestClientConfig = {
31
31
  * The API key to use for authentication. This will be added as an 'sc_apikey' header.
32
32
  */
33
33
  apiKey?: string;
34
+ /**
35
+ * A unified identifier used to connect and retrieve data from XM Cloud instance
36
+ */
37
+ contextId?: string;
34
38
  /**
35
39
  * Override debugger for logging. Uses 'content-sdk:http' by default.
36
40
  */
@@ -64,7 +68,7 @@ export type GraphQLRequestClientConfig = {
64
68
  * @returns An instance of a GraphQL Request Client ready to send GraphQL requests.
65
69
  * @public
66
70
  */
67
- export type GraphQLRequestClientFactory = (config?: Omit<GraphQLRequestClientConfig, 'apiKey'>) => GraphQLRequestClient;
71
+ export type GraphQLRequestClientFactory = (config?: Omit<GraphQLRequestClientConfig, 'apiKey' | 'contextId'>) => GraphQLRequestClient;
68
72
  /**
69
73
  * Configuration type for @type GraphQLRequestClientFactory
70
74
  * @public
@@ -72,6 +76,7 @@ export type GraphQLRequestClientFactory = (config?: Omit<GraphQLRequestClientCon
72
76
  export type GraphQLRequestClientFactoryConfig = {
73
77
  endpoint: string;
74
78
  apiKey?: string;
79
+ contextId?: string;
75
80
  };
76
81
  /**
77
82
  * A GraphQL client for Sitecore APIs that uses the 'graphql-request' library.
@@ -98,8 +103,9 @@ export declare class GraphQLRequestClient implements GraphQLClient {
98
103
  * @param {object} config - client configuration options.
99
104
  * @param {string} config.endpoint - endpoint
100
105
  * @param {string} [config.apiKey] - apikey
106
+ * @param {string} [config.contextId] - contextId
101
107
  */
102
- static createClientFactory({ endpoint, apiKey, }: GraphQLRequestClientFactoryConfig): GraphQLRequestClientFactory;
108
+ static createClientFactory({ endpoint, apiKey, contextId, }: GraphQLRequestClientFactoryConfig): GraphQLRequestClientFactory;
103
109
  /**
104
110
  * Execute graphql request
105
111
  * @param {string | DocumentNode} query graphql query
@@ -1 +1 @@
1
- {"version":3,"file":"graphql-request-client.d.ts","sourceRoot":"","sources":["../src/graphql-request-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEvE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAkB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGlF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,CAAC,CAAC,EACP,KAAK,EAAE,MAAM,GAAG,YAAY,EAC5B,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EACtC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,CAAC,CAAC,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,yBAAyB,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,CACxC,MAAM,CAAC,EAAE,IAAI,CAAC,0BAA0B,EAAE,QAAQ,CAAC,KAChD,oBAAoB,CAAC;AAE1B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IAc5C,OAAO,CAAC,QAAQ;IAb5B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,YAAY,CAAC,CAAiB;IACtC,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,aAAa,CAAgB;IAErC;;;;OAIG;gBACiB,QAAQ,EAAE,MAAM,EAAE,YAAY,GAAE,0BAA+B;IA0BnF;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,EACzB,QAAQ,EACR,MAAM,GACP,EAAE,iCAAiC,GAAG,2BAA2B;IAKlE;;;;OAIG;IACG,OAAO,CAAC,CAAC,EACb,KAAK,EAAE,MAAM,GAAG,YAAY,EAC5B,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EACtC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,CAAC,CAAC;CAmDd"}
1
+ {"version":3,"file":"graphql-request-client.d.ts","sourceRoot":"","sources":["../src/graphql-request-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEvE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAkB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGlF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,CAAC,CAAC,EACP,KAAK,EAAE,MAAM,GAAG,YAAY,EAC5B,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EACtC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,CAAC,CAAC,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,yBAAyB,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,CACxC,MAAM,CAAC,EAAE,IAAI,CAAC,0BAA0B,EAAE,QAAQ,GAAG,WAAW,CAAC,KAC9D,oBAAoB,CAAC;AAE1B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IAc5C,OAAO,CAAC,QAAQ;IAb5B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,YAAY,CAAC,CAAiB;IACtC,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,aAAa,CAAgB;IAErC;;;;OAIG;gBACiB,QAAQ,EAAE,MAAM,EAAE,YAAY,GAAE,0BAA+B;IA6BnF;;;;;;OAMG;IACH,MAAM,CAAC,mBAAmB,CAAC,EACzB,QAAQ,EACR,MAAM,EACN,SAAS,GACV,EAAE,iCAAiC,GAAG,2BAA2B;IAKlE;;;;OAIG;IACG,OAAO,CAAC,CAAC,EACb,KAAK,EAAE,MAAM,GAAG,YAAY,EAC5B,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EACtC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,CAAC,CAAC;CAoDd"}
package/types/index.d.ts CHANGED
@@ -1,13 +1,10 @@
1
1
  import * as constants from './constants';
2
- import * as form from './form';
3
- export { default as debug, Debugger, enableDebug } from './debug';
4
- export { GraphQLClient, GraphQLRequestClient, GraphQLRequestClientConfig, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, } from './graphql-request-client';
2
+ export { default as debug, Debugger, enableDebug, debugNamespace, debugModule } from './debug';
3
+ export { GraphQLClient, GraphQLRequestClient, GraphQLClientError, GraphQLRequestClientConfig, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, } from './graphql-request-client';
5
4
  export { DefaultRetryStrategy } from './retries';
6
5
  export { CacheClient, CacheOptions, MemoryCacheClient } from './cache-client';
7
6
  export { ClientError } from 'graphql-request';
8
7
  export { NativeDataFetcher, NativeDataFetcherConfig, NativeDataFetcherError, NativeDataFetcherResponse, } from './native-fetcher';
9
- export { HTMLLink, RetryStrategy, GenericGraphQLClientError, StaticPath } from './models';
8
+ export { RetryStrategy, GenericGraphQLClientError, FetchOptions } from './models';
10
9
  export { constants };
11
- export { form };
12
- export { defineConfig } from './config';
13
10
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,iCAAiC,GAClC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,yBAAyB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,CAAC;AAChB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC/F,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,iCAAiC,GAClC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAClF,OAAO,EAAE,SAAS,EAAE,CAAC"}