@contentstack/studio-client 1.4.0 → 1.6.0

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 (59) hide show
  1. package/dist/composable-studio/initializer-sdk.js +1 -9
  2. package/dist/composable-studio/initializer-sdk.js.map +1 -1
  3. package/dist/composable-studio/sdk.js +618 -184
  4. package/dist/composable-studio/sdk.js.map +1 -1
  5. package/dist/composable-studio/studio-intelligence.manager.js +135 -0
  6. package/dist/composable-studio/studio-intelligence.manager.js.map +1 -0
  7. package/dist/config/config.schema.js +10 -0
  8. package/dist/config/config.schema.js.map +1 -1
  9. package/dist/config/process-user-config.js +6 -0
  10. package/dist/config/process-user-config.js.map +1 -1
  11. package/dist/config/stack-sdk-wrapper.js +2 -2
  12. package/dist/config/stack-sdk-wrapper.js.map +1 -1
  13. package/dist/design/handle-active-style-change.js +0 -3
  14. package/dist/design/handle-active-style-change.js.map +1 -1
  15. package/dist/dnd/dnd-manager.js +25 -7
  16. package/dist/dnd/dnd-manager.js.map +1 -1
  17. package/dist/dnd/{utils.js → scroll-utils.js} +2 -27
  18. package/dist/dnd/scroll-utils.js.map +1 -0
  19. package/dist/hidden-element-notification/hidden-element-notification-event.js +7 -0
  20. package/dist/hidden-element-notification/hidden-element-notification-event.js.map +1 -1
  21. package/dist/highlight-node/highlight-node-manager.js +7 -1
  22. package/dist/highlight-node/highlight-node-manager.js.map +1 -1
  23. package/dist/highlight-node/highlight-node.js +34 -17
  24. package/dist/highlight-node/highlight-node.js.map +1 -1
  25. package/dist/index.d.ts +227 -23
  26. package/dist/index.js +8 -4
  27. package/dist/index.js.map +1 -1
  28. package/dist/node_modules/fflate/esm/browser.js +384 -0
  29. package/dist/node_modules/fflate/esm/browser.js.map +1 -0
  30. package/dist/packages/studio-internal/dist/utils/spec-compression.js +43 -0
  31. package/dist/packages/studio-internal/dist/utils/spec-compression.js.map +1 -0
  32. package/dist/query/expression-resolver.js +124 -0
  33. package/dist/query/expression-resolver.js.map +1 -0
  34. package/dist/query/query-executor.js +327 -0
  35. package/dist/query/query-executor.js.map +1 -0
  36. package/dist/shared/dnd-events.js +39 -0
  37. package/dist/shared/dnd-events.js.map +1 -0
  38. package/dist/url-change/url-change.js +65 -0
  39. package/dist/url-change/url-change.js.map +1 -0
  40. package/dist/utils/composable-studio-error.js +1 -0
  41. package/dist/utils/composable-studio-error.js.map +1 -1
  42. package/dist/utils/conditionBlock.js +17 -5
  43. package/dist/utils/conditionBlock.js.map +1 -1
  44. package/dist/utils/constants.js +4 -1
  45. package/dist/utils/constants.js.map +1 -1
  46. package/dist/utils/error-messages.default.js +1 -1
  47. package/dist/utils/error-messages.default.js.map +1 -1
  48. package/dist/utils/http-error.constants.js +11 -2
  49. package/dist/utils/http-error.constants.js.map +1 -1
  50. package/dist/utils/is-inside-iframe.js +16 -0
  51. package/dist/utils/is-inside-iframe.js.map +1 -0
  52. package/dist/utils/reference_fetcher.js +98 -12
  53. package/dist/utils/reference_fetcher.js.map +1 -1
  54. package/dist/utils/sdk.js +3 -0
  55. package/dist/utils/sdk.js.map +1 -1
  56. package/dist/utils/spec-analyzer.js +95 -0
  57. package/dist/utils/spec-analyzer.js.map +1 -0
  58. package/package.json +14 -10
  59. package/dist/dnd/utils.js.map +0 -1
@@ -4,7 +4,7 @@ import { COMPOSABLE_DATA_ATTRIBUTES } from '../utils/constants.js';
4
4
  import 'lodash-es';
5
5
  import '@contentstack/studio-registry';
6
6
  import { getComposableElement, getHitboxDetails, serializeEvent } from '../canvas/canvas.utils.js';
7
- import { dndManager } from '../dnd/dnd-manager.js';
7
+ import { dndEventManager } from '../shared/dnd-events.js';
8
8
  import { highlightNodeManager } from './highlight-node-manager.js';
9
9
  import { TARGET_NODE } from '@contentstack/studio-message-types/latest';
10
10
 
@@ -51,9 +51,23 @@ const handleActiveSlot = (payload) => {
51
51
  highlightNodeManager.setActiveSlotUID(slotUid);
52
52
  highlightNodeManager.highlightSlotNode();
53
53
  };
54
+ const isModKey = (e) => {
55
+ return e.metaKey || e.ctrlKey;
56
+ };
57
+ /** Prevents default and stops propagation when the event target is inside an anchor with href (used to disable link navigation on mod+click). */
58
+ const preventAnchorClick = (e) => {
59
+ const anchor = e.target?.closest?.("a");
60
+ if (anchor?.href) {
61
+ e.preventDefault();
62
+ e.stopPropagation();
63
+ e.stopImmediatePropagation();
64
+ }
65
+ };
54
66
  const handleClick = (e) => {
55
- // TODO: @ravencolevol - I think the data-studio-ui is not the correct attribute to check for.
56
- // dont ignore clicks if the target has data attribute data-studio-ui
67
+ if (isModKey(e)) {
68
+ preventAnchorClick(e);
69
+ return;
70
+ }
57
71
  if (e.target && e.target.getAttribute("data-studio-ui")) {
58
72
  return;
59
73
  }
@@ -62,6 +76,10 @@ const handleClick = (e) => {
62
76
  e.stopImmediatePropagation();
63
77
  };
64
78
  const handleMouseDown = (e) => {
79
+ if (isModKey(e)) {
80
+ preventAnchorClick(e);
81
+ return;
82
+ }
65
83
  e.stopImmediatePropagation();
66
84
  e.stopPropagation();
67
85
  e.preventDefault();
@@ -71,13 +89,15 @@ const handleMouseDown = (e) => {
71
89
  highlightNodeManager.resetActiveNode();
72
90
  return;
73
91
  }
74
- dndManager.start(e);
92
+ dndEventManager.emit("dnd-start", e);
75
93
  composableStudioEventManager?.send(POST_MESSAGE_EVENTS.MOUSE_DOWN, {
76
94
  event: serializeEvent(e),
77
95
  details: getHitboxDetails(e),
78
96
  });
79
97
  };
80
98
  const handleMouseOver = (e) => {
99
+ if (isModKey(e))
100
+ return;
81
101
  e.stopImmediatePropagation();
82
102
  e.stopPropagation();
83
103
  e.preventDefault();
@@ -93,13 +113,15 @@ const handleMouseUp = (e) => {
93
113
  event: serializeEvent(e),
94
114
  details: getHitboxDetails(e),
95
115
  });
96
- dndManager.end();
116
+ dndEventManager.emit("dnd-end", undefined);
97
117
  };
98
118
  const handleMouseMove = (e) => {
119
+ if (isModKey(e))
120
+ return;
99
121
  e.preventDefault();
100
122
  e.stopImmediatePropagation();
101
123
  e.stopPropagation();
102
- dndManager.mouseMove(e);
124
+ dndEventManager.emit("dnd-move", e);
103
125
  composableStudioEventManager?.send(POST_MESSAGE_EVENTS.MOUSE_MOVE, {
104
126
  event: serializeEvent(e),
105
127
  details: getHitboxDetails(e),
@@ -181,21 +203,16 @@ function addHighlightNodeEventListeners() {
181
203
  const { styleGroup, uid } = event.data;
182
204
  return highlightNodeManager.setAndHighlightStyleNode(styleGroup, uid);
183
205
  });
184
- if (activeNodeListener) {
206
+ if (activeNodeListener)
185
207
  studioEventListeners.push(activeNodeListener);
186
- }
187
- if (focusedNodeListener) {
208
+ if (focusedNodeListener)
188
209
  studioEventListeners.push(focusedNodeListener);
189
- }
190
- if (activeStyleChangeListener) {
210
+ if (activeStyleChangeListener)
191
211
  studioEventListeners.push(activeStyleChangeListener);
192
- }
193
- if (hoveredNodeListener) {
212
+ if (hoveredNodeListener)
194
213
  studioEventListeners.push(hoveredNodeListener);
195
- }
196
- if (activeSlotListener) {
214
+ if (activeSlotListener)
197
215
  studioEventListeners.push(activeSlotListener);
198
- }
199
216
  return {
200
217
  removeEventListeners: () => {
201
218
  windowEventListeners.forEach(({ type, handler, options }) => {
@@ -208,5 +225,5 @@ function addHighlightNodeEventListeners() {
208
225
  };
209
226
  }
210
227
 
211
- export { addHighlightNodeEventListeners, handleOnScroll, handleResize };
228
+ export { addHighlightNodeEventListeners, handleOnScroll, handleResize, isModKey };
212
229
  //# sourceMappingURL=highlight-node.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"highlight-node.js","sources":["../../src/highlight-node/highlight-node.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;AAwBA,IAAI,WAAW,GAAG,KAAK;AACvB,IAAI,SAAS,GAAQ,CAAC;SACN,cAAc,GAAA;IAC5B,WAAW,GAAG,IAAI;IAClB,oBAAoB,CAAC,oBAAoB,EAAE;IAC3C,YAAY,CAAC,SAAS,CAAC;AAEvB,IAAA,SAAS,GAAG,UAAU,CAAC,MAAK;QAC1B,WAAW,GAAG,KAAK;QACnB,oBAAoB,CAAC,mBAAmB,EAAE;QAC1C,oBAAoB,CAAC,oBAAoB,EAAE;QAC3C,oBAAoB,CAAC,kBAAkB,EAAE;QACzC,oBAAoB,CAAC,iBAAiB,EAAE;QACxC,oBAAoB,CAAC,oBAAoB,EAAE;IAC7C,CAAC,EAAE,GAAG,CAAC;AACT;SAEgB,YAAY,GAAA;AAC1B,IAAA,cAAc,EAAE;AAClB;AAEA,MAAM,gBAAgB,GAAG,CAAC,OAAgC,KAAI;AAC5D,IAAA,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO;IACvB,IAAI,CAAC,GAAG,EAAE;QACR,oBAAoB,CAAC,eAAe,EAAE;QACtC;IACF;AACA,IAAA,oBAAoB,CAAC,yBAAyB,CAAC,GAAG,CAAC;AACrD,CAAC;AAED,MAAM,iBAAiB,GAAG,CAAC,OAAiC,KAAI;AAC9D,IAAA,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO;IACvB,IAAI,CAAC,GAAG,EAAE;QACR,oBAAoB,CAAC,gBAAgB,EAAE;QACvC;IACF;AACA,IAAA,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,CAAC;AACtD,CAAC;AACD,MAAM,gBAAgB,GAAG,CAAC,OAA6B,KAAI;AACzD,IAAA,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO;IAC3B,IAAI,CAAC,OAAO,EAAE;AACZ,QAAA,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAC3C;IACF;AACA,IAAA,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC;IAC9C,oBAAoB,CAAC,iBAAiB,EAAE;AAC1C,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,CAAa,KAAI;;;AAGpC,IAAA,IAAI,CAAC,CAAC,MAAM,IAAK,CAAC,CAAC,MAAsB,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QACxE;IACF;IAEA,CAAC,CAAC,cAAc,EAAE;IAClB,CAAC,CAAC,eAAe,EAAE;IACnB,CAAC,CAAC,wBAAwB,EAAE;AAC9B,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,CAAa,KAAI;IACxC,CAAC,CAAC,wBAAwB,EAAE;IAC5B,CAAC,CAAC,eAAe,EAAE;IACnB,CAAC,CAAC,cAAc,EAAE;AAClB,IAAA,MAAM,MAAM,GAAG,CAAC,CAAC,MAAqB;AACtC,IAAA,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAChC,CAAA,CAAA,EAAI,0BAA0B,CAAC,IAAI,CAAA,CAAA,CAAG,CACxB;IAEhB,IAAI,CAAC,WAAW,EAAE;QAChB,oBAAoB,CAAC,eAAe,EAAE;QACtC;IACF;AACA,IAAA,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AACnB,IAAA,4BAA4B,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE;AACjE,QAAA,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;AACxB,QAAA,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7B,KAAA,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,CAAa,KAAI;IACxC,CAAC,CAAC,wBAAwB,EAAE;IAC5B,CAAC,CAAC,eAAe,EAAE;IACnB,CAAC,CAAC,cAAc,EAAE;AAClB,IAAA,MAAM,MAAM,GAAG,CAAC,CAAC,MAAqB;AAEtC,IAAA,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAChC,CAAA,CAAA,EAAI,0BAA0B,CAAC,IAAI,CAAA,CAAA,CAAG,CACxB;IAChB,MAAM,iBAAiB,GAAG,WAAW,EAAE,YAAY,CACjD,0BAA0B,CAAC,EAAE,CAC9B;AACD,IAAA,IAAI,CAAC,WAAW,IAAI,CAAC,iBAAiB;QAAE;AACxC,IAAA,oBAAoB,CAAC,0BAA0B,CAAC,iBAAiB,CAAC;AACpE,CAAC;AAED,MAAM,aAAa,GAAG,CAAC,CAAa,KAAI;AACtC,IAAA,4BAA4B,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE;AAC/D,QAAA,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;AACxB,QAAA,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7B,KAAA,CAAC;IACF,UAAU,CAAC,GAAG,EAAE;AAClB,CAAC;AACD,MAAM,eAAe,GAAG,CAAC,CAAa,KAAI;IACxC,CAAC,CAAC,cAAc,EAAE;IAClB,CAAC,CAAC,wBAAwB,EAAE;IAC5B,CAAC,CAAC,eAAe,EAAE;AACnB,IAAA,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AACvB,IAAA,4BAA4B,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE;AACjE,QAAA,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;AACxB,QAAA,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7B,KAAA,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,GAAA;AACnC,IAAA,MAAM,UAAU,GAAG,QAAQ,CAAC,eAAe;;AAG3C,IAAA,MAAM,MAAM,GAAG;AACb,QAAA,UAAU,EAAE,IAAI;AAChB,QAAA,SAAS,EAAE,IAAI;AACf,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,aAAa,EAAE,IAAI;KACpB;IAED,MAAM,QAAQ,GAAG,MAAK;;AAEpB,QAAA,IAAI,oBAAoB,CAAC,aAAa,EAAE;YACtC,MAAM,OAAO,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,aAAa,CAAC;AACxE,YAAA,MAAM,IAAI,GAAG,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS;AAE/D,YAAA,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE;gBACrB,oBAAoB,CAAC,eAAe,EAAE;gBACtC,oBAAoB,CAAC,eAAe,EAAE;gBACtC;YACF;QACF;QACA,oBAAoB,CAAC,mBAAmB,EAAE;QAC1C,oBAAoB,CAAC,oBAAoB,EAAE;QAC3C,oBAAoB,CAAC,kBAAkB,EAAE;AAC3C,IAAA,CAAC;AAED,IAAA,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,QAAQ,CAAC;IAC/C,IAAI,WAAW,EAAE;QACf,QAAQ,CAAC,UAAU,EAAE;IACvB;SAAO;AACL,QAAA,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC;IACtC;AACF;SAEgB,8BAA8B,GAAA;AAC5C,IAAA,IAAI,CAAC,UAAU;QAAE;IACjB,MAAM,oBAAoB,GAIpB,EAAE;IACR,MAAM,oBAAoB,GAAiC,EAAE;AAE7D,IAAA,SAAS,sBAAsB,CAC7B,IAAO,EACP,OAA2C,EAC3C,OAA2C,EAAA;QAE3C,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC;QAC/C,oBAAoB,CAAC,IAAI,CAAC;YACxB,IAAI;AACJ,YAAA,OAAO,EAAE,OAAwB;YACjC,OAAO;AACR,SAAA,CAAC;IACJ;IAEA,sBAAsB,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACjE,sBAAsB,CAAC,QAAQ,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACnE,sBAAsB,CAAC,WAAW,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACvE,sBAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC/D,sBAAsB,CAAC,WAAW,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACvE,sBAAsB,CAAC,SAAS,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACnE,IAAA,sBAAsB,CAAC,WAAW,EAAE,eAAe,EAAE;AACnD,QAAA,OAAO,EAAE,KAAK;AACd,QAAA,OAAO,EAAE,IAAI;AACd,KAAA,CAAC;AAEF,IAAA,4BAA4B,EAAE;;IAG9B,MAAM,kBAAkB,GACtB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,eAAe,EACnC,CAAC,KAAK,KAAK,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CACxC;IAEH,MAAM,mBAAmB,GACvB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,gBAAgB,EACpC,CAAC,KAAK,KAAK,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CACzC;IAEH,MAAM,kBAAkB,GACtB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,mBAAmB,EACvC,CAAC,KAAK,KAAK,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CACxC;AAEH,IAAA,MAAM,mBAAmB,GACvB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,cAAc,EAClC,CAAC,KAAK,KAAI;QACR,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI;AAClC,QAAA,IAAI,MAAM,KAAK,WAAW,CAAC,WAAW,EAAE;AACtC,YAAA,OAAO,oBAAoB,CAAC,yBAAyB,CAAC,GAAG,CAAC;QAC5D;AACA,QAAA,IAAI,MAAM,KAAK,WAAW,CAAC,YAAY,EAAE;AACvC,YAAA,OAAO,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,CAAC;QAC7D;AACA,QAAA,IAAI,MAAM,KAAK,WAAW,CAAC,YAAY,EAAE;AACvC,YAAA,OAAO,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,CAAC;QAC7D;AACF,IAAA,CAAC,CACF;AAEH,IAAA,MAAM,yBAAyB,GAAG,4BAA4B,EAAE,EAAE,CAGhE,mBAAmB,CAAC,2BAA2B,EAAE,CAAC,KAAK,KAAI;QAC3D,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI;QACtC,OAAO,oBAAoB,CAAC,wBAAwB,CAAC,UAAU,EAAE,GAAG,CAAC;AACvE,IAAA,CAAC,CAAC;IAEF,IAAI,kBAAkB,EAAE;AACtB,QAAA,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC;IAC/C;IAEA,IAAI,mBAAmB,EAAE;AACvB,QAAA,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,CAAC;IAChD;IAEA,IAAI,yBAAyB,EAAE;AAC7B,QAAA,oBAAoB,CAAC,IAAI,CAAC,yBAAyB,CAAC;IACtD;IAEA,IAAI,mBAAmB,EAAE;AACvB,QAAA,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,CAAC;IAChD;IAEA,IAAI,kBAAkB,EAAE;AACtB,QAAA,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC;IAC/C;IAEA,OAAO;QACL,oBAAoB,EAAE,MAAK;AACzB,YAAA,oBAAoB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAI;gBAC1D,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC;AACpD,YAAA,CAAC,CAAC;YAEF,oBAAoB,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,KAAI;AAC9C,gBAAA,UAAU,EAAE;AACd,YAAA,CAAC,CAAC;QACJ,CAAC;KACF;AACH;;;;"}
1
+ {"version":3,"file":"highlight-node.js","sources":["../../src/highlight-node/highlight-node.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;AAwBA,IAAI,WAAW,GAAG,KAAK;AACvB,IAAI,SAAS,GAAQ,CAAC;SACN,cAAc,GAAA;IAC5B,WAAW,GAAG,IAAI;IAClB,oBAAoB,CAAC,oBAAoB,EAAE;IAC3C,YAAY,CAAC,SAAS,CAAC;AAEvB,IAAA,SAAS,GAAG,UAAU,CAAC,MAAK;QAC1B,WAAW,GAAG,KAAK;QACnB,oBAAoB,CAAC,mBAAmB,EAAE;QAC1C,oBAAoB,CAAC,oBAAoB,EAAE;QAC3C,oBAAoB,CAAC,kBAAkB,EAAE;QACzC,oBAAoB,CAAC,iBAAiB,EAAE;QACxC,oBAAoB,CAAC,oBAAoB,EAAE;IAC7C,CAAC,EAAE,GAAG,CAAC;AACT;SAEgB,YAAY,GAAA;AAC1B,IAAA,cAAc,EAAE;AAClB;AAEA,MAAM,gBAAgB,GAAG,CAAC,OAAgC,KAAI;AAC5D,IAAA,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO;IACvB,IAAI,CAAC,GAAG,EAAE;QACR,oBAAoB,CAAC,eAAe,EAAE;QACtC;IACF;AACA,IAAA,oBAAoB,CAAC,yBAAyB,CAAC,GAAG,CAAC;AACrD,CAAC;AAED,MAAM,iBAAiB,GAAG,CAAC,OAAiC,KAAI;AAC9D,IAAA,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO;IACvB,IAAI,CAAC,GAAG,EAAE;QACR,oBAAoB,CAAC,gBAAgB,EAAE;QACvC;IACF;AACA,IAAA,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,CAAC;AACtD,CAAC;AACD,MAAM,gBAAgB,GAAG,CAAC,OAA6B,KAAI;AACzD,IAAA,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO;IAC3B,IAAI,CAAC,OAAO,EAAE;AACZ,QAAA,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAC3C;IACF;AACA,IAAA,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC;IAC9C,oBAAoB,CAAC,iBAAiB,EAAE;AAC1C,CAAC;AAEM,MAAM,QAAQ,GAAG,CAAC,CAA6B,KAAa;AACjE,IAAA,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO;AAC/B;AAEA;AACA,MAAM,kBAAkB,GAAG,CAAC,CAAa,KAAU;IACjD,MAAM,MAAM,GAAI,CAAC,CAAC,MAAsB,EAAE,OAAO,GAAG,GAAG,CAAC;AACxD,IAAA,IAAI,MAAM,EAAE,IAAI,EAAE;QAChB,CAAC,CAAC,cAAc,EAAE;QAClB,CAAC,CAAC,eAAe,EAAE;QACnB,CAAC,CAAC,wBAAwB,EAAE;IAC9B;AACF,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,CAAa,KAAI;AACpC,IAAA,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE;QACf,kBAAkB,CAAC,CAAC,CAAC;QACrB;IACF;AAEA,IAAA,IAAI,CAAC,CAAC,MAAM,IAAK,CAAC,CAAC,MAAsB,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QACxE;IACF;IAEA,CAAC,CAAC,cAAc,EAAE;IAClB,CAAC,CAAC,eAAe,EAAE;IACnB,CAAC,CAAC,wBAAwB,EAAE;AAC9B,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,CAAa,KAAI;AACxC,IAAA,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE;QACf,kBAAkB,CAAC,CAAC,CAAC;QACrB;IACF;IAEA,CAAC,CAAC,wBAAwB,EAAE;IAC5B,CAAC,CAAC,eAAe,EAAE;IACnB,CAAC,CAAC,cAAc,EAAE;AAElB,IAAA,MAAM,MAAM,GAAG,CAAC,CAAC,MAAqB;AACtC,IAAA,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAChC,CAAA,CAAA,EAAI,0BAA0B,CAAC,IAAI,CAAA,CAAA,CAAG,CACxB;IAEhB,IAAI,CAAC,WAAW,EAAE;QAChB,oBAAoB,CAAC,eAAe,EAAE;QACtC;IACF;AAEA,IAAA,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACpC,IAAA,4BAA4B,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE;AACjE,QAAA,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;AACxB,QAAA,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7B,KAAA,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,CAAa,KAAI;IACxC,IAAI,QAAQ,CAAC,CAAC,CAAC;QAAE;IACjB,CAAC,CAAC,wBAAwB,EAAE;IAC5B,CAAC,CAAC,eAAe,EAAE;IACnB,CAAC,CAAC,cAAc,EAAE;AAClB,IAAA,MAAM,MAAM,GAAG,CAAC,CAAC,MAAqB;AAEtC,IAAA,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAChC,CAAA,CAAA,EAAI,0BAA0B,CAAC,IAAI,CAAA,CAAA,CAAG,CACxB;IAChB,MAAM,iBAAiB,GAAG,WAAW,EAAE,YAAY,CACjD,0BAA0B,CAAC,EAAE,CAC9B;AACD,IAAA,IAAI,CAAC,WAAW,IAAI,CAAC,iBAAiB;QAAE;AACxC,IAAA,oBAAoB,CAAC,0BAA0B,CAAC,iBAAiB,CAAC;AACpE,CAAC;AAED,MAAM,aAAa,GAAG,CAAC,CAAa,KAAI;AACtC,IAAA,4BAA4B,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE;AAC/D,QAAA,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;AACxB,QAAA,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7B,KAAA,CAAC;AACF,IAAA,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;AAC5C,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,CAAa,KAAI;IACxC,IAAI,QAAQ,CAAC,CAAC,CAAC;QAAE;IACjB,CAAC,CAAC,cAAc,EAAE;IAClB,CAAC,CAAC,wBAAwB,EAAE;IAC5B,CAAC,CAAC,eAAe,EAAE;AACnB,IAAA,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;AACnC,IAAA,4BAA4B,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE;AACjE,QAAA,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;AACxB,QAAA,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7B,KAAA,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,GAAA;AACnC,IAAA,MAAM,UAAU,GAAG,QAAQ,CAAC,eAAe;;AAG3C,IAAA,MAAM,MAAM,GAAG;AACb,QAAA,UAAU,EAAE,IAAI;AAChB,QAAA,SAAS,EAAE,IAAI;AACf,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,aAAa,EAAE,IAAI;KACpB;IAED,MAAM,QAAQ,GAAG,MAAK;;AAEpB,QAAA,IAAI,oBAAoB,CAAC,aAAa,EAAE;YACtC,MAAM,OAAO,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,aAAa,CAAC;AACxE,YAAA,MAAM,IAAI,GAAG,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS;AAE/D,YAAA,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE;gBACrB,oBAAoB,CAAC,eAAe,EAAE;gBACtC,oBAAoB,CAAC,eAAe,EAAE;gBACtC;YACF;QACF;QACA,oBAAoB,CAAC,mBAAmB,EAAE;QAC1C,oBAAoB,CAAC,oBAAoB,EAAE;QAC3C,oBAAoB,CAAC,kBAAkB,EAAE;AAC3C,IAAA,CAAC;AAED,IAAA,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,QAAQ,CAAC;IAC/C,IAAI,WAAW,EAAE;QACf,QAAQ,CAAC,UAAU,EAAE;IACvB;SAAO;AACL,QAAA,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC;IACtC;AACF;SAEgB,8BAA8B,GAAA;AAC5C,IAAA,IAAI,CAAC,UAAU;QAAE;IACjB,MAAM,oBAAoB,GAIpB,EAAE;IACR,MAAM,oBAAoB,GAAiC,EAAE;AAE7D,IAAA,SAAS,sBAAsB,CAC7B,IAAO,EACP,OAA2C,EAC3C,OAA2C,EAAA;QAE3C,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC;QAC/C,oBAAoB,CAAC,IAAI,CAAC;YACxB,IAAI;AACJ,YAAA,OAAO,EAAE,OAAwB;YACjC,OAAO;AACR,SAAA,CAAC;IACJ;IAEA,sBAAsB,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACjE,sBAAsB,CAAC,QAAQ,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACnE,sBAAsB,CAAC,WAAW,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACvE,sBAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC/D,sBAAsB,CAAC,WAAW,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACvE,sBAAsB,CAAC,SAAS,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACnE,IAAA,sBAAsB,CAAC,WAAW,EAAE,eAAe,EAAE;AACnD,QAAA,OAAO,EAAE,KAAK;AACd,QAAA,OAAO,EAAE,IAAI;AACd,KAAA,CAAC;AAEF,IAAA,4BAA4B,EAAE;;IAG9B,MAAM,kBAAkB,GACtB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,eAAe,EACnC,CAAC,KAAK,KAAK,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CACxC;IAEH,MAAM,mBAAmB,GACvB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,gBAAgB,EACpC,CAAC,KAAK,KAAK,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CACzC;IAEH,MAAM,kBAAkB,GACtB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,mBAAmB,EACvC,CAAC,KAAK,KAAK,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CACxC;AAEH,IAAA,MAAM,mBAAmB,GACvB,4BAA4B,EAAE,EAAE,CAC9B,mBAAmB,CAAC,cAAc,EAClC,CAAC,KAAK,KAAI;QACR,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI;AAClC,QAAA,IAAI,MAAM,KAAK,WAAW,CAAC,WAAW,EAAE;AACtC,YAAA,OAAO,oBAAoB,CAAC,yBAAyB,CAAC,GAAG,CAAC;QAC5D;AACA,QAAA,IAAI,MAAM,KAAK,WAAW,CAAC,YAAY,EAAE;AACvC,YAAA,OAAO,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,CAAC;QAC7D;AACA,QAAA,IAAI,MAAM,KAAK,WAAW,CAAC,YAAY,EAAE;AACvC,YAAA,OAAO,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,CAAC;QAC7D;AACF,IAAA,CAAC,CACF;AAEH,IAAA,MAAM,yBAAyB,GAAG,4BAA4B,EAAE,EAAE,CAGhE,mBAAmB,CAAC,2BAA2B,EAAE,CAAC,KAAK,KAAI;QAC3D,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI;QACtC,OAAO,oBAAoB,CAAC,wBAAwB,CAAC,UAAU,EAAE,GAAG,CAAC;AACvE,IAAA,CAAC,CAAC;AAEF,IAAA,IAAI,kBAAkB;AAAE,QAAA,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC;AACrE,IAAA,IAAI,mBAAmB;AAAE,QAAA,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,CAAC;AACvE,IAAA,IAAI,yBAAyB;AAC3B,QAAA,oBAAoB,CAAC,IAAI,CAAC,yBAAyB,CAAC;AACtD,IAAA,IAAI,mBAAmB;AAAE,QAAA,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,CAAC;AACvE,IAAA,IAAI,kBAAkB;AAAE,QAAA,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC;IAErE,OAAO;QACL,oBAAoB,EAAE,MAAK;AACzB,YAAA,oBAAoB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAI;gBAC1D,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC;AACpD,YAAA,CAAC,CAAC;YACF,oBAAoB,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,KAAI;AAC9C,gBAAA,UAAU,EAAE;AACd,YAAA,CAAC,CAAC;QACJ,CAAC;KACF;AACH;;;;"}
package/dist/index.d.ts CHANGED
@@ -1,15 +1,14 @@
1
1
  import * as _contentstack_studio_internal from '@contentstack/studio-internal';
2
- import { Node, PathNode, Path, Descendant, Operation, BindingType, Condition, NodeStyles } from '@contentstack/studio-internal';
2
+ import { Node, PathNode, Path, Operation, Descendant, BindingType, Condition, NodeStyles } from '@contentstack/studio-internal';
3
3
  import * as _contentstack_studio_registry from '@contentstack/studio-registry';
4
- import { StudioSpecData, RawStaticValue, ICSEntryReference, StaticValue, BreakpointInput, Breakpoint } from '@contentstack/studio-registry';
4
+ import { RawStaticValue, ICSEntryReference, StudioSpecData, StaticValue, BreakpointInput, Breakpoint } from '@contentstack/studio-registry';
5
5
  export { Breakpoint } from '@contentstack/studio-registry';
6
6
  import * as _contentstack_studio_messenger from '@contentstack/studio-messenger';
7
- import { CompositionQueryInput, ComposableStudioQueryParams, CompositionQuery, ComposableStudioQueryParamsKeys, HiddenElementNotificationEventData, POST_MESSAGE_EVENTS } from '@contentstack/studio-messenger';
7
+ import { CompositionQuery, CompositionQueryInput, ComposableStudioQueryParams, ComposableStudioQueryParamsKeys, HiddenElementNotificationEventData, POST_MESSAGE_EVENTS } from '@contentstack/studio-messenger';
8
8
  export { IS_BROWSER } from '@contentstack/studio-messenger';
9
9
  import { z } from 'zod';
10
10
  import deliverySdk, { BaseAsset } from '@contentstack/delivery-sdk';
11
11
  import { Stack } from 'contentstack';
12
- import { InitMessage } from '@contentstack/studio-message-types/base';
13
12
  import { HitboxDetails, SerializedEvent, RefetchSpecEventData, ApplySymbolOperationEventData } from '@contentstack/studio-message-types/latest';
14
13
  export { ActiveBreakpointEventPayload, BaseHighlightEventPayload, ChangeActiveStyleGroupPayload, ComputedStyleSection, DraggerPosition, HighlightActiveNodeEventPayload, HighlightAncestorsEventPayload, HighlightFocusedNodeEventPayload, HighlightNodeEventPayload, HighlightSlotNodeEventPayload, HighlightStyleNodeEventPayload, HitboxDetails, MouseMoveEventPayload, MouseUpEventPayload, RefetchSpecEventData, RequestHighlightNodeEventPayload, SetCursorTypeEventPayload, TARGET_NODE, UpdateStyleEventPayload, ValidatePropEventPayload, handleActiveNodePayload, handleActiveSlotNode, handleFocusedNodePayload } from '@contentstack/studio-message-types/latest';
15
14
  import { EventEmitter } from 'eventemitter3';
@@ -43,6 +42,8 @@ declare const userConfigSchema: z.ZodObject<{
43
42
  enable?: boolean | undefined;
44
43
  position?: "top" | "top-left" | "top-right" | "top-center" | "bottom" | "bottom-left" | "bottom-right" | "bottom-center" | undefined;
45
44
  }>>;
45
+ fetchComposition: z.ZodOptional<z.ZodType<CompositionFetcher, z.ZodTypeDef, CompositionFetcher>>;
46
+ fetchTemplateEntry: z.ZodOptional<z.ZodType<TemplateEntryFetcher, z.ZodTypeDef, TemplateEntryFetcher>>;
46
47
  }, "strip", z.ZodTypeAny, {
47
48
  contentTypeUid?: string | undefined;
48
49
  stackSdk?: any;
@@ -54,6 +55,8 @@ declare const userConfigSchema: z.ZodObject<{
54
55
  enable?: boolean | undefined;
55
56
  position?: "top" | "top-left" | "top-right" | "top-center" | "bottom" | "bottom-left" | "bottom-right" | "bottom-center" | undefined;
56
57
  } | undefined;
58
+ fetchComposition?: CompositionFetcher | undefined;
59
+ fetchTemplateEntry?: TemplateEntryFetcher | undefined;
57
60
  }, {
58
61
  contentTypeUid?: string | undefined;
59
62
  stackSdk?: any;
@@ -65,6 +68,8 @@ declare const userConfigSchema: z.ZodObject<{
65
68
  enable?: boolean | undefined;
66
69
  position?: "top" | "top-left" | "top-right" | "top-center" | "bottom" | "bottom-left" | "bottom-right" | "bottom-center" | undefined;
67
70
  } | undefined;
71
+ fetchComposition?: CompositionFetcher | undefined;
72
+ fetchTemplateEntry?: TemplateEntryFetcher | undefined;
68
73
  }>;
69
74
 
70
75
  type JSStack = Stack;
@@ -73,7 +78,7 @@ declare class StackSDK {
73
78
  sdk: JSStack | TSStack;
74
79
  private _locale?;
75
80
  constructor(sdk: JSStack | TSStack, locale?: string);
76
- isJavaScriptSDK(sdk: Stack | ReturnType<(typeof deliverySdk)["stack"]>): sdk is Stack;
81
+ isJavaScriptSDK(_sdk: Stack | ReturnType<(typeof deliverySdk)["stack"]>): _sdk is Stack;
77
82
  livePreviewQuery(livePreviewHash: string): void;
78
83
  ctQuery(contentTypeUid: string, options?: {
79
84
  includeAll?: boolean;
@@ -100,9 +105,11 @@ declare class StackSDK {
100
105
  get locale(): string | undefined;
101
106
  }
102
107
 
103
- interface Config extends DeepRequired<Omit<UserConfig, "stackSdk" | "locale">> {
108
+ interface Config extends DeepRequired<Omit<UserConfig, "stackSdk" | "locale" | "fetchComposition" | "fetchTemplateEntry">> {
104
109
  stackSdk: StackSDK;
105
110
  locale?: string;
111
+ fetchComposition?: CompositionFetcher;
112
+ fetchTemplateEntry?: TemplateEntryFetcher;
106
113
  }
107
114
  type LightConfig = Pick<Config, "openInStudioButton" | "contentTypeUid" | "cslp">;
108
115
  type UserConfig = z.infer<typeof userConfigSchema>;
@@ -111,6 +118,8 @@ declare function getDefaultConfig(): Config;
111
118
 
112
119
  declare const isBrowser: () => boolean;
113
120
  declare const INCLUDE_DEPTH_COUNT = 4;
121
+ declare const SDK_VERSION: string;
122
+ declare const SCHEMA_VERSION = "1.0.0";
114
123
  declare const COMPOSABLE_DATA_ATTRIBUTES: {
115
124
  readonly BUILDER: "data-composable-studio-builder";
116
125
  readonly PLACEHOLDER: "data-composable-studio-placeholder";
@@ -228,7 +237,91 @@ type CompositionQueryOptions = {
228
237
  only?: (string | [string, string])[];
229
238
  };
230
239
  };
240
+ /**
241
+ * UID of a specific entry in the connected content type to use
242
+ * as the template/preview entry.
243
+ *
244
+ * When provided, the SDK fetches this exact entry instead of
245
+ * resolving by URL or grabbing the first available entry.
246
+ *
247
+ * Resolution priority: templateEntryUid > url > first entry (limit 1)
248
+ */
249
+ templateEntryUid?: string;
250
+ /**
251
+ * Per-query composition fetcher override. Takes precedence over global.
252
+ * Return the composition entry, null for not-found, or call `defaultFetch()`.
253
+ */
254
+ fetchComposition?: CompositionFetcher;
255
+ /**
256
+ * Per-query template entry fetcher override. Takes precedence over global.
257
+ * Return the entry, null for not-found, or call `defaultFetch()`.
258
+ */
259
+ fetchTemplateEntry?: TemplateEntryFetcher;
231
260
  };
261
+ /**
262
+ * CompositionQueryOptions with fetcher callbacks stripped.
263
+ * Passed to custom fetchers via the `options` field.
264
+ * Automatically picks up any future additions to CompositionQueryOptions.
265
+ */
266
+ type ResolvedQueryOptions = Omit<CompositionQueryOptions, "fetchComposition" | "fetchTemplateEntry">;
267
+ /**
268
+ * Context provided to a custom composition fetcher.
269
+ */
270
+ interface FetchCompositionContext {
271
+ /** The query input — has composableUid, url, or both */
272
+ compositionQuery: CompositionQuery;
273
+ /** The content type UID where compositions are stored */
274
+ contentTypeUid: string;
275
+ /** All query options (locale, variantAlias, extendQuery, templateEntryUid, + future) */
276
+ options: ResolvedQueryOptions;
277
+ /** The raw Contentstack SDK instance passed to studioSdk.init() */
278
+ stackSdk: any;
279
+ /**
280
+ * Calls the SDK's default composition fetching logic.
281
+ * Use this to: conditionally fall through, wrap/decorate, inspect/transform.
282
+ */
283
+ defaultFetch: () => Promise<CompositionEntry>;
284
+ }
285
+ /**
286
+ * Context provided to a custom template entry fetcher.
287
+ */
288
+ interface FetchTemplateEntryContext {
289
+ /** The already-fetched composition entry */
290
+ compositionEntry: CompositionEntry;
291
+ /** The original query (has composableUid, url, or both) */
292
+ compositionQuery: CompositionQuery;
293
+ /** The content type UID that this composition is linked to */
294
+ connectedContentType: string;
295
+ /** All query options (locale, variantAlias, extendQuery, templateEntryUid, + future) */
296
+ options: ResolvedQueryOptions;
297
+ /**
298
+ * SDK-computed reference field paths from UI tree bindings + options.extendQuery.
299
+ * e.g., ["author", "categories", "related_posts.author"]
300
+ */
301
+ includeReferences: string[];
302
+ /**
303
+ * SDK-computed field projections from UI tree bindings + options.extendQuery.
304
+ * Empty when inside Visual Builder (all fields fetched).
305
+ */
306
+ only: [string, string][];
307
+ /** The raw Contentstack SDK instance passed to studioSdk.init() */
308
+ stackSdk: any;
309
+ /**
310
+ * Calls the SDK's default template entry fetching logic.
311
+ * Uses templateEntryUid > url > first entry resolution.
312
+ */
313
+ defaultFetch: () => Promise<any>;
314
+ }
315
+ /**
316
+ * User-provided fetcher for compositions.
317
+ * Return the composition entry, null for not-found, or call defaultFetch().
318
+ */
319
+ type CompositionFetcher = (context: FetchCompositionContext) => Promise<CompositionEntry | null>;
320
+ /**
321
+ * User-provided fetcher for template entries.
322
+ * Return the entry, null for not-found, or call defaultFetch().
323
+ */
324
+ type TemplateEntryFetcher = (context: FetchTemplateEntryContext) => Promise<any | null>;
232
325
  /**
233
326
  * The query string we get after running URLSearchParams.toString()
234
327
  */
@@ -290,17 +383,16 @@ declare const studioSdk: {
290
383
  internal: {
291
384
  getConfig(): Config;
292
385
  isInsideStudioFrame: () => boolean;
293
- fetchSpec: (queryOptions: _contentstack_studio_messenger.CompositionQuery, options?: CompositionQueryOptions) => Promise<StudioSpec>;
386
+ fetchSpec: (queryOptions: _contentstack_studio_messenger.CompositionQuery, options?: CompositionQueryOptions, skipComponentLoading?: boolean) => Promise<StudioSpec>;
387
+ fetchMultipleSpecs: (queries: _contentstack_studio_messenger.CompositionQuery[], options?: CompositionQueryOptions) => Promise<StudioSpec[]>;
294
388
  fetchData: (compositionEntry: CompositionEntry, queryOptions: _contentstack_studio_messenger.CompositionQuery, options?: CompositionQueryOptions) => Promise<_contentstack_studio_registry.StudioSpecData>;
295
- fetchTemplateEntry: (options: {
389
+ fetchTemplateEntry: (fetchOptions: {
296
390
  connected_content_type: string;
297
391
  compositionQuery: _contentstack_studio_messenger.CompositionQuery;
298
392
  includeQueries: string[];
299
393
  onlyQueries: [string, string][];
300
394
  composableUid: string;
301
- variantAlias?: string;
302
- locale?: string;
303
- }, data: _contentstack_studio_registry.StudioSpecData) => Promise<void>;
395
+ }, data: _contentstack_studio_registry.StudioSpecData, compositionEntry: CompositionEntry, compositionQueryOptions?: CompositionQueryOptions) => Promise<void>;
304
396
  getSeoMetadata: (ui: _contentstack_studio_internal.Node) => SeoMetadata;
305
397
  };
306
398
  public: {
@@ -314,7 +406,6 @@ declare const studioSdk: {
314
406
  };
315
407
  };
316
408
  };
317
- declare const sendInitMessage: (message: InitMessage) => void;
318
409
 
319
410
  declare const ELEMENT_TO_NODE: WeakMap<HTMLElement, any>;
320
411
  declare const NODE_TO_ELEMENT: WeakMap<any, HTMLElement>;
@@ -407,19 +498,11 @@ declare const dndEventListener: () => {
407
498
  };
408
499
 
409
500
  declare const getScrollableParent: (el: HTMLElement) => HTMLElement;
410
- declare const getScrollContainerRect: () => DOMRect | {
411
- top: number;
412
- left: number;
413
- right: number;
414
- bottom: number;
415
- width: number;
416
- height: number;
417
- } | null;
418
- declare const getScrollContainer: () => HTMLElement | (Window & typeof globalThis) | null;
419
501
  declare const calculateDynamicSpeed: (distance: number, padding: number, maxSpeed: number) => number;
420
502
 
421
503
  declare function handleOnScroll(): void;
422
504
  declare function handleResize(): void;
505
+ declare const isModKey: (e: MouseEvent | KeyboardEvent) => boolean;
423
506
  declare function addHighlightNodeEventListeners(): {
424
507
  removeEventListeners: () => void;
425
508
  } | undefined;
@@ -517,6 +600,15 @@ declare class HighlightNodeManager {
517
600
  }
518
601
  declare const highlightNodeManager: HighlightNodeManager;
519
602
 
603
+ /**
604
+ * Listens for URL changes inside the iframe (SPA navigations, pushState, replaceState, popstate)
605
+ * and sends URL_CHANGE postMessage to the parent so the studio can sync the navbar URL.
606
+ * Uses Navigation API when available, with popstate + history monkey-patch fallback.
607
+ */
608
+ declare function addUrlChangeListeners(): {
609
+ removeEventListeners: () => void;
610
+ } | undefined;
611
+
520
612
  declare function addHighlightSpacingEventListeners(): {
521
613
  removeEventListeners: () => void;
522
614
  } | undefined;
@@ -564,6 +656,13 @@ declare function entriesFromResponse<T>(response: EntriesResponse<T>): T[];
564
656
 
565
657
  declare const isInsideVisualBuilderFrame: () => boolean;
566
658
 
659
+ /**
660
+ * Checks if the current context is inside an iframe.
661
+ *
662
+ * @returns {boolean} True if inside an iframe, false otherwise.
663
+ */
664
+ declare const isInsideIframe: () => boolean;
665
+
567
666
  declare const ComposableStudioErrors: {
568
667
  readonly COMPOSITION_NOT_FOUND: "COMPOSITION_NOT_FOUND";
569
668
  readonly COMPOSITION_NOT_FOUND_BY_URL: "COMPOSITION_NOT_FOUND_BY_URL";
@@ -578,6 +677,7 @@ declare const ComposableStudioErrors: {
578
677
  readonly NETWORK_ERROR: "NETWORK_ERROR";
579
678
  readonly AUTHENTICATION_ERROR: "AUTHENTICATION_ERROR";
580
679
  readonly SERVER_ERROR: "SERVER_ERROR";
680
+ readonly COMPONENT_NOT_FOUND: "COMPONENT_NOT_FOUND";
581
681
  };
582
682
  /**
583
683
  * Information about a possible cause of an error and how to fix it
@@ -667,6 +767,38 @@ declare class RendererModeUtil {
667
767
  declare const clientRendererModeUtil: RendererModeUtil;
668
768
  declare const serializeComputedStyles: (computedStyle: CSSStyleDeclaration) => Record<string, string>;
669
769
 
770
+ /**
771
+ * Analyzes a UI spec (Node tree) and extracts all component types used.
772
+ * Recursively traverses the spec to find all components.
773
+ *
774
+ * @param spec - The root node of the UI spec
775
+ * @returns Set of component types used in the spec
776
+ */
777
+ declare function analyzeUsedComponents(spec: Node | null | undefined): Set<string>;
778
+ /**
779
+ * Analyzes multiple UI specs and returns the union of all component types used.
780
+ * Useful for optimizing multi-composition loading.
781
+ *
782
+ * @param specs - Array of UI spec root nodes
783
+ * @returns Set of all unique component types used across all specs
784
+ */
785
+ declare function analyzeMultipleSpecs(specs: (Node | null | undefined)[]): Set<string>;
786
+ /**
787
+ * Checks if a spec uses a specific component type.
788
+ *
789
+ * @param spec - The UI spec to check
790
+ * @param componentType - The component type to look for
791
+ * @returns true if the component is used in the spec
792
+ */
793
+ declare function specUsesComponent(spec: Node | null | undefined, componentType: string): boolean;
794
+ /**
795
+ * Gets component usage statistics for a spec.
796
+ *
797
+ * @param spec - The UI spec to analyze
798
+ * @returns Map of component types to their usage count
799
+ */
800
+ declare function getComponentUsageStats(spec: Node | null | undefined): Map<string, number>;
801
+
670
802
  interface GoogleFont {
671
803
  family: string;
672
804
  variants: string[];
@@ -761,5 +893,77 @@ declare function getNodeScreenshotEvent(): {
761
893
  unregister: () => void;
762
894
  } | undefined;
763
895
 
764
- export { BreakpointManager, COMPOSABLE_DATA_ATTRIBUTES, COMPOSABLE_STUDIO_EMITTED_EVENTS, ComposableStudioError, ComposableStudioErrors, DEFAULT_BREAKPOINTS, EDGE_PADDING, ELEMENT_TO_NODE, GOOGLE_FONT_API, INCLUDE_DEPTH_COUNT, MAX_SCROLL_SPEED, NODE_TO_ELEMENT, NODE_TO_PARENT, NODE_TO_PATH_NODE, RendererMode, RendererModeUtil, SCROLL_INTERVAL, addBreakpointEventListeners, addContextMenuEventListeners, addHighlightNodeEventListeners, addHighlightSpacingEventListeners, applyOperation, batchFetchEntries, calculateDynamicSpeed, clientRendererModeUtil, closeHiddenElementNotification, composableStudioEventEmitter, compositionSaveEventListener, createClassNameUid, studioSdk as default, dndEventListener, dndManager, entriesFromResponse, evaluateCondition, findNearestBuilderNode, findNearestSlotNode, findPath, findPathForElement, getBindingStringForCS, getComposableElement, getComputedStyles, getDefaultConfig, getHitboxDetails, getHitboxDirection, getJSONRTE, getNodeScreenshotEvent, getScrollContainer, getScrollContainerRect, getScrollableParent, handleOnScroll, handleResize, hasSlotDropzone, hiddenElementNotificationEventEmitter, highlightNodeManager, isBrowser, isCompositionBeingEdited, isInsideVisualBuilderFrame, loadGoogleFont, onlyParmasGenerator, openHiddenElementNotification, parseStringValue, preProcessStaticValues, queryParam, registerJSONRTE, sendInitMessage, serializeComputedStyles, serializeEvent, setStaticEntryInDS, setTemplateEntryInDS, studioSdk, toggleNodeVisible, updateStyleOnStyleNodeChange };
765
- export type { ClientEditableNodeInternalAttributes, ClientPreviewNodeInternalAttributes, ComposableStudioErrorDetails, ComposableStudioLightSdk, CompositionEntry, CompositionEntryIncompleteUi, CompositionQueryForSSR, CompositionQueryForSSRInput, CompositionQueryOptions, Config, EmittedEvents, FontVariants, GoogleFont, HiddenElementNotificationHandler, LightConfig, MetaProp, ParsedStringResult, SearchQueryInput, SeoMetadata, StudioComponentFetchOptions, StudioComponentSpecOptions, StudioSdk, StudioSpec, SymbolEntry, TroubleshootingInfo, URLSearchParamsString, UserConfig };
896
+ interface QuerySpec {
897
+ contentType: string;
898
+ sourceType?: "content_type" | "taxonomy";
899
+ query: Record<string, any>;
900
+ params: Record<string, any>;
901
+ }
902
+ interface QueryResult {
903
+ entries: any[];
904
+ count: number;
905
+ currentPage: number;
906
+ pageSize: number;
907
+ hasNextPage: boolean;
908
+ hasPreviousPage: boolean;
909
+ }
910
+ interface QueryState extends QueryResult {
911
+ isLoading: boolean;
912
+ error: Error | null;
913
+ }
914
+ interface QueryExecutionOptions {
915
+ variantAlias?: string;
916
+ locale?: string;
917
+ }
918
+ interface RuntimeContext {
919
+ url?: {
920
+ params: Record<string, string>;
921
+ path: Record<string, string>;
922
+ hash?: string;
923
+ };
924
+ componentProps?: Record<string, any>;
925
+ user?: {
926
+ id?: string;
927
+ email?: string;
928
+ name?: string;
929
+ role?: string;
930
+ preferences?: Record<string, any>;
931
+ };
932
+ environment?: {
933
+ locale?: string;
934
+ region?: string;
935
+ timezone?: string;
936
+ };
937
+ }
938
+
939
+ declare class ExpressionResolver {
940
+ resolve(expression: any, context: RuntimeContext): any;
941
+ private resolveTimeExpression;
942
+ private resolveUrlExpression;
943
+ private resolvePropsExpression;
944
+ private resolveUserExpression;
945
+ private resolveEnvExpression;
946
+ private getNestedValue;
947
+ }
948
+
949
+ declare class QueryExecutor {
950
+ private sdk;
951
+ private expressionResolver;
952
+ constructor(sdk: any);
953
+ /**
954
+ * Detection logic:
955
+ * 1. If 'contentType' (lowercase) exists in object or prototype, it's likely TS SDK or CMA SDK.
956
+ * 2. If 'ContentType' (uppercase) exists AND 'contentType' doesn't, it's likely legacy JS Delivery SDK.
957
+ */
958
+ private isJavaScriptSDK;
959
+ /** TS @contentstack/delivery-sdk: Mongo filter must be sent via addParams({ query }), not .query(obj) */
960
+ private usesTsContentTypeEntryQuery;
961
+ execute(querySpec: QuerySpec, page?: number, context?: RuntimeContext, options?: QueryExecutionOptions): Promise<QueryResult>;
962
+ /**
963
+ * Helper to resolve expressions in nested query objects
964
+ */
965
+ private resolveExpressionsInQuery;
966
+ }
967
+
968
+ export { BreakpointManager, COMPOSABLE_DATA_ATTRIBUTES, COMPOSABLE_STUDIO_EMITTED_EVENTS, ComposableStudioError, ComposableStudioErrors, DEFAULT_BREAKPOINTS, EDGE_PADDING, ELEMENT_TO_NODE, ExpressionResolver, GOOGLE_FONT_API, INCLUDE_DEPTH_COUNT, MAX_SCROLL_SPEED, NODE_TO_ELEMENT, NODE_TO_PARENT, NODE_TO_PATH_NODE, QueryExecutor, RendererMode, RendererModeUtil, SCHEMA_VERSION, SCROLL_INTERVAL, SDK_VERSION, addBreakpointEventListeners, addContextMenuEventListeners, addHighlightNodeEventListeners, addHighlightSpacingEventListeners, addUrlChangeListeners, analyzeMultipleSpecs, analyzeUsedComponents, applyOperation, batchFetchEntries, calculateDynamicSpeed, clientRendererModeUtil, closeHiddenElementNotification, composableStudioEventEmitter, compositionSaveEventListener, createClassNameUid, studioSdk as default, dndEventListener, dndManager, entriesFromResponse, evaluateCondition, findNearestBuilderNode, findNearestSlotNode, findPath, findPathForElement, getBindingStringForCS, getComponentUsageStats, getComposableElement, getComputedStyles, getDefaultConfig, getHitboxDetails, getHitboxDirection, getJSONRTE, getNodeScreenshotEvent, getScrollableParent, handleOnScroll, handleResize, hasSlotDropzone, hiddenElementNotificationEventEmitter, highlightNodeManager, isBrowser, isCompositionBeingEdited, isInsideIframe, isInsideVisualBuilderFrame, isModKey, loadGoogleFont, onlyParmasGenerator, openHiddenElementNotification, parseStringValue, preProcessStaticValues, queryParam, registerJSONRTE, serializeComputedStyles, serializeEvent, setStaticEntryInDS, setTemplateEntryInDS, specUsesComponent, studioSdk, toggleNodeVisible, updateStyleOnStyleNodeChange };
969
+ export type { ClientEditableNodeInternalAttributes, ClientPreviewNodeInternalAttributes, ComposableStudioErrorDetails, ComposableStudioLightSdk, CompositionEntry, CompositionEntryIncompleteUi, CompositionFetcher, CompositionQueryForSSR, CompositionQueryForSSRInput, CompositionQueryOptions, Config, EmittedEvents, FetchCompositionContext, FetchTemplateEntryContext, FontVariants, GoogleFont, HiddenElementNotificationHandler, LightConfig, MetaProp, ParsedStringResult, QueryExecutionOptions, QueryResult, QuerySpec, QueryState, ResolvedQueryOptions, RuntimeContext, SearchQueryInput, SeoMetadata, StudioComponentFetchOptions, StudioComponentSpecOptions, StudioSdk, StudioSpec, SymbolEntry, TemplateEntryFetcher, TroubleshootingInfo, URLSearchParamsString, UserConfig };
package/dist/index.js CHANGED
@@ -1,14 +1,14 @@
1
1
  import { studioSdk } from './composable-studio/initializer-sdk.js';
2
- export { sendInitMessage } from './composable-studio/initializer-sdk.js';
3
2
  export { ELEMENT_TO_NODE, NODE_TO_ELEMENT, NODE_TO_PARENT, NODE_TO_PATH_NODE } from './composable-studio/weak-maps.js';
4
3
  export { parseStringValue, preProcessStaticValues } from './composable-studio/data/pre-process-static-values.js';
5
4
  export { addContextMenuEventListeners } from './context-menu/context-menu.js';
6
5
  export { EDGE_PADDING, MAX_SCROLL_SPEED, SCROLL_INTERVAL, dndManager } from './dnd/dnd-manager.js';
7
6
  export { dndEventListener } from './dnd/dnd-event.js';
8
- export { calculateDynamicSpeed, getScrollContainer, getScrollContainerRect, getScrollableParent } from './dnd/utils.js';
9
- export { addHighlightNodeEventListeners, handleOnScroll, handleResize } from './highlight-node/highlight-node.js';
7
+ export { calculateDynamicSpeed, getScrollableParent } from './dnd/scroll-utils.js';
8
+ export { addHighlightNodeEventListeners, handleOnScroll, handleResize, isModKey } from './highlight-node/highlight-node.js';
10
9
  export { highlightNodeManager } from './highlight-node/highlight-node-manager.js';
11
10
  export { TARGET_NODE } from '@contentstack/studio-message-types/latest';
11
+ export { addUrlChangeListeners } from './url-change/url-change.js';
12
12
  export { addHighlightSpacingEventListeners } from './highlight-spacing/highlight-spacing-events.js';
13
13
  export { getDefaultConfig } from './config/default-config.js';
14
14
  export { addBreakpointEventListeners } from './breakpoints/breakpoint.js';
@@ -16,15 +16,17 @@ export { DEFAULT_BREAKPOINTS } from './breakpoints/breakpoint.constant.js';
16
16
  export { BreakpointManager } from './breakpoints/BreakpointManager.js';
17
17
  export { RendererMode } from './canvas/canvas.type.js';
18
18
  export { findNearestBuilderNode, findNearestSlotNode, getComposableElement, getComputedStyles, getHitboxDetails, getHitboxDirection, hasSlotDropzone, serializeEvent, toggleNodeVisible } from './canvas/canvas.utils.js';
19
- export { COMPOSABLE_DATA_ATTRIBUTES, INCLUDE_DEPTH_COUNT, isBrowser } from './utils/constants.js';
19
+ export { COMPOSABLE_DATA_ATTRIBUTES, INCLUDE_DEPTH_COUNT, SCHEMA_VERSION, SDK_VERSION, isBrowser } from './utils/constants.js';
20
20
  export { applyOperation, findPath, findPathForElement } from './utils/editor-utils.js';
21
21
  export { isCompositionBeingEdited } from './utils/is-composition-being-edited.js';
22
22
  export { onlyParmasGenerator, queryParam } from './utils/query-param.js';
23
23
  export { batchFetchEntries, entriesFromResponse, getBindingStringForCS, setStaticEntryInDS, setTemplateEntryInDS } from './utils/sdk.js';
24
24
  export { isInsideVisualBuilderFrame } from './utils/is-inside-visual-builder-frame.js';
25
+ export { isInsideIframe } from './utils/is-inside-iframe.js';
25
26
  export { ComposableStudioError, ComposableStudioErrors } from './utils/composable-studio-error.js';
26
27
  export { evaluateCondition } from './utils/conditionBlock.js';
27
28
  export { RendererModeUtil, clientRendererModeUtil, serializeComputedStyles } from './utils/canvas.js';
29
+ export { analyzeMultipleSpecs, analyzeUsedComponents, getComponentUsageStats, specUsesComponent } from './utils/spec-analyzer.js';
28
30
  export { loadGoogleFont } from './design/fonts/index.js';
29
31
  export { GOOGLE_FONT_API } from './design/fonts/fonts.constant.js';
30
32
  export { createClassNameUid } from './design/create-class-name-uid.js';
@@ -35,6 +37,8 @@ export { getJSONRTE, registerJSONRTE } from './json-rte-registry/index.js';
35
37
  export { compositionSaveEventListener } from './visual-builder/composition-save-event.js';
36
38
  export { closeHiddenElementNotification, hiddenElementNotificationEventEmitter, openHiddenElementNotification } from './hidden-element-notification/hidden-element-notification-event.js';
37
39
  export { getNodeScreenshotEvent } from './get-active-node-screenshot/get-node-screenshot-event.js';
40
+ export { ExpressionResolver } from './query/expression-resolver.js';
41
+ export { QueryExecutor } from './query/query-executor.js';
38
42
  export { IS_BROWSER } from '@contentstack/studio-messenger';
39
43
 
40
44
  // STUDIO SDK
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;"}
1
+ {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;"}