@contentstack/studio-messenger 3.2.0 → 3.3.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.
@@ -62,6 +62,24 @@ const COMPOSABLE_STUDIO_QUERY_PARAM = {
62
62
  * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
63
63
  */
64
64
  VARIANT_ALIAS: "cs-variant-alias",
65
+ /**
66
+ * The composition a render asks the URL resolver to prefer. When several
67
+ * templates tie on the requested URL, are linked to the same content type
68
+ * and each has an entry for it, the one named here renders instead of the
69
+ * one the live site would pick. Anything else (a more specific URL, another
70
+ * content type, no entry) is resolved as on the live site.
71
+ *
72
+ * Sent by Studio's canvas (the template being edited, beside
73
+ * `COMPOSABLE_UID`), and by the Visual Editor and Live Preview (the template
74
+ * their own lookup chose). It changes which template renders, nothing else;
75
+ * edit mode stays with `COMPOSABLE_UID`.
76
+ *
77
+ * Only honored inside Studio (via `ENABLED`) or on a preview request: a
78
+ * preview hash in the address, the stack served by the preview service (Live
79
+ * Preview hands a client-rendered page its hash by message), or inside the
80
+ * Visual Editor. On a visitor's request it is ignored.
81
+ */
82
+ PREFERRED_COMPOSITION_UID: "cs-preferred-composition-uid",
65
83
  };
66
84
  const POST_MESSAGE_EVENTS = {
67
85
  INIT_STUDIO: "init-studio",
@@ -73,6 +91,8 @@ const POST_MESSAGE_EVENTS = {
73
91
  REVEAL_NODE: "reveal-node",
74
92
  /** Canvas → Studio: which node it actually scrolled to, and why it missed. */
75
93
  REVEAL_RESULT: "reveal-result",
94
+ /** Canvas → Studio: the author pressed undo/redo while focus was inside the canvas. */
95
+ HISTORY_SHORTCUT: "history-shortcut",
76
96
  TRANSFORM_OPERATION: "transform-operation",
77
97
  REGISTER_COMPONENTS: "register-components",
78
98
  // Iframe → Studio: the app's registered studio-function NAMES (BYOS custom
@@ -122,6 +142,11 @@ const POST_MESSAGE_EVENTS = {
122
142
  // Emitted by every SDK component instance regardless of the edited-composition
123
143
  // gate, so Studio can list what loaded and explain why the edited one didn't.
124
144
  SDK_DIAGNOSTICS: "sdk-diagnostics",
145
+ // Iframe → Studio: the result of the one request that tests the site's own
146
+ // delivery setup, sent once per page load inside Studio. Live preview routes
147
+ // every page request to the preview host, so without it a broken delivery
148
+ // setup never shows in the canvas.
149
+ SETUP_CHECK: "setup-check",
125
150
  // SDK Initialization Signal (SDK 1.5.0+)
126
151
  SDK_INITIALIZED: "sdk-initialized",
127
152
  // Iframe → Studio: fired once the post-message listeners registered by
@@ -166,6 +191,15 @@ const POST_MESSAGE_EVENTS = {
166
191
  // then, so no init race. Carries `allowPinData` — whether the pinning
167
192
  // affordances (empty-canvas WelcomeState copy, etc.) should show.
168
193
  SET_EDIT_CONTEXT: "set-edit-context",
194
+ // SDK → Parent (request/response): the editor asks Studio, once its own
195
+ // listeners are mounted, what the saved code design system knows about each
196
+ // component type (display name, who last edited it), so a composition node
197
+ // whose type this app no longer registers can render an "unavailable"
198
+ // placeholder that says whom to ask. Returns `{ components }`.
199
+ GET_SAVED_COMPONENTS: "get-saved-components",
200
+ // Parent → SDK: live update of the same `{ components }` when the saved
201
+ // design system or the user names change.
202
+ UPDATE_SAVED_COMPONENTS: "update-saved-components",
169
203
  HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification",
170
204
  CONTEXT_MENU: "context-menu",
171
205
  GET_NODE_SCREENSHOT: "get-node-screenshot",
@@ -225,6 +259,16 @@ const resolveEventManagerCtor = () => {
225
259
  }
226
260
  return cachedEventManagerCtor;
227
261
  };
262
+ /**
263
+ * The window a channel posts to. Studio opened as a popup by the Visual
264
+ * Builder (the "Open in Studio" button on a composition) tells the window that
265
+ * opened it about a save on the popup channel, so that channel talks to
266
+ * `window.opener`; in a popup `window.parent` is the popup itself. Every other
267
+ * channel talks to the parent frame.
268
+ */
269
+ const getTargetWindow = (channelId) => channelId === COMPOSABLE_STUDIO_POPUP_CHANNEL_ID && window.opener
270
+ ? window.opener
271
+ : window.parent;
228
272
  const getEventManager = (channelId) => {
229
273
  if (!IS_BROWSER) {
230
274
  return undefined;
@@ -237,7 +281,7 @@ const getEventManager = (channelId) => {
237
281
  // same postMessage bridge instead of creating duplicate listeners.
238
282
  const EventManager = resolveEventManagerCtor();
239
283
  window.__csMessengerListeners__[channelId] = new EventManager(channelId, {
240
- target: window.parent,
284
+ target: getTargetWindow(channelId),
241
285
  debug: false,
242
286
  });
243
287
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","sources":["../../src/constant.ts","../../src/main.ts"],"sourcesContent":[null,null],"names":["DataStepMode","advancedPostMessage"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAO,MAAM,4BAA4B,GAAG;AACrC,MAAM,4CAA4C,GACvD;AACK,MAAM,sBAAsB,GAAG;AAE/B,MAAM,kCAAkC,GAAG;AAC3C,MAAM,yBAAyB,GAAG;AAElC,MAAM,6BAA6B,GAAG;AAC3C,IAAA,OAAO,EAAE,sBAAsB;AAC/B,IAAA,cAAc,EAAE,mBAAmB;AACnC,IAAA,YAAY,EAAE,MAAM;AACpB;;;;AAIG;AACH,IAAA,iBAAiB,EAAE,cAAc;AACjC,IAAA,cAAc,EAAE,SAAS;AACzB;;;;;;;AAOG;AACH,IAAA,kBAAkB,EAAE,uBAAuB;AAC3C;;;;;;;;;AASG;AACH,IAAA,MAAM,EAAE,WAAW;AACnB;;;AAGG;AACH,IAAA,aAAa,EAAE,kBAAkB;;AAG5B,MAAM,mBAAmB,GAAG;AACjC,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;;AAE9C,IAAA,WAAW,EAAE,aAAa;;AAE1B,IAAA,aAAa,EAAE,eAAe;AAC9B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;;AAI1C,IAAA,yBAAyB,EAAE,2BAA2B;;;;AAItD,IAAA,oBAAoB,EAAE,sBAAsB;;;;AAI5C,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,4BAA4B,EAAE,8BAA8B;AAC5D,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;AAG1C,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,kBAAkB,EAAE,oBAAoB;AACxC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,QAAQ,EAAE,UAAU;AACpB,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,oBAAoB,EAAE,sBAAsB;;AAE5C,IAAA,uBAAuB,EAAE,yBAAyB;;AAElD,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,iBAAiB,EAAE,mBAAmB;;;;;AAKtC,IAAA,eAAe,EAAE,iBAAiB;;AAElC,IAAA,eAAe,EAAE,iBAAiB;;;;;;;AAOlC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,2BAA2B,EAAE,6BAA6B;AAC1D,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;AAE1C,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,uCAAuC,EAAE,wBAAwB;;;;;;;;AAQjE,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,YAAY,EAAE,cAAc;;;;AAI5B,IAAA,uBAAuB,EAAE,yBAAyB;;;;;AAKlD,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,gBAAgB,EAAE,kBAAkB;;;;;AAKpC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,6BAA6B,EAAE,+BAA+B;AAC9D,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;;AAG1B;;;;;AAKG;AACSA;AAAZ,CAAA,UAAY,YAAY,EAAA;;AAEtB,IAAA,YAAA,CAAA,SAAA,CAAA,GAAA,UAAoB;;AAEpB,IAAA,YAAA,CAAA,aAAA,CAAA,GAAA,eAA6B;;AAE7B,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B;AAC5B,CAAC,EAPWA,oBAAY,KAAZA,oBAAY,GAAA,EAAA,CAAA,CAAA;AASjB,MAAM,kCAAkC,GAAG;;AAEhD,IAAA,YAAY,EAAE,cAAc;;AAG5B,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,uCAAuC,EAAE,wBAAwB;AACjE,IAAA,4BAA4B,EAAE,8BAA8B;;AAGvD,MAAM,qDAAqD,GAAG;AACnE,IAAA,8BAA8B,EAAE,gCAAgC;;MAGrD,UAAU,GAAG,OAAO,MAAM,KAAK;AAE5C;;;;;;;AAOG;AACI,MAAM,8BAA8B,GAAG;;AC5K9C;AACA;AACA;AACA;AACA;AACA,IAAI,sBAAoD;AAExD,MAAM,uBAAuB,GAAG,MAAuB;IACrD,IAAI,CAAC,sBAAsB,EAAE;QAC3B,MAAM,SAAS,GAAGC,8BAAgD;QAClE,MAAM,IAAI,GAAG,SAAS,CAAC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,YAAY;QACtE,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF;QACH;QACA,sBAAsB,GAAG,IAAI;IAC/B;AACA,IAAA,OAAO,sBAAsB;AAC/B,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,SAAiB,KAAI;IAC5C,IAAI,CAAC,UAAU,EAAE;AACf,QAAA,OAAO,SAAS;IAClB;AACA,IAAA,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE;AACpC,QAAA,MAAM,CAAC,wBAAwB,GAAG,EAAE;IACtC;IACA,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE;;;AAG/C,QAAA,MAAM,YAAY,GAAG,uBAAuB,EAAE;QAC9C,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,GAAG,IAAI,YAAY,CAAC,SAAS,EAAE;YACvE,MAAM,EAAE,MAAM,CAAC,MAAM;AACrB,YAAA,KAAK,EAAE,KAAK;AACb,SAAA,CAAC;IACJ;AACA,IAAA,OAAO,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACnD,CAAC;AACD;MACa,4BAA4B;AACvC;AACA,eAAe,CAAC,4BAA4B;MACjC,iCAAiC;AAG5C;AACA,eAAe,CAAC,kCAAkC;MACvC,yBAAyB;AACpC;AACA,eAAe,CAAC,yBAAyB;MAC9B,yCAAyC;AAGpD;AACA,eAAe,CAAC,4CAA4C;AAE9D;;;;;;;;AAQG;AACG,SAAU,wBAAwB,CAAC,KAAc,EAAA;AACrD,IAAA,QACE,OAAO,KAAK,KAAK,QAAQ;AACzB,QAAA,KAAK,KAAK,IAAI;AACb,QAAA,KAA4B,CAAC,IAAI,KAAK,8BAA8B;AAEzE;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.cjs","sources":["../../src/constant.ts","../../src/main.ts"],"sourcesContent":[null,null],"names":["DataStepMode","advancedPostMessage"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAO,MAAM,4BAA4B,GAAG;AACrC,MAAM,4CAA4C,GACvD;AACK,MAAM,sBAAsB,GAAG;AAE/B,MAAM,kCAAkC,GAAG;AAC3C,MAAM,yBAAyB,GAAG;AAElC,MAAM,6BAA6B,GAAG;AAC3C,IAAA,OAAO,EAAE,sBAAsB;AAC/B,IAAA,cAAc,EAAE,mBAAmB;AACnC,IAAA,YAAY,EAAE,MAAM;AACpB;;;;AAIG;AACH,IAAA,iBAAiB,EAAE,cAAc;AACjC,IAAA,cAAc,EAAE,SAAS;AACzB;;;;;;;AAOG;AACH,IAAA,kBAAkB,EAAE,uBAAuB;AAC3C;;;;;;;;;AASG;AACH,IAAA,MAAM,EAAE,WAAW;AACnB;;;AAGG;AACH,IAAA,aAAa,EAAE,kBAAkB;AACjC;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,yBAAyB,EAAE,8BAA8B;;AAGpD,MAAM,mBAAmB,GAAG;AACjC,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;;AAE9C,IAAA,WAAW,EAAE,aAAa;;AAE1B,IAAA,aAAa,EAAE,eAAe;;AAE9B,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;;AAI1C,IAAA,yBAAyB,EAAE,2BAA2B;;;;AAItD,IAAA,oBAAoB,EAAE,sBAAsB;;;;AAI5C,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,4BAA4B,EAAE,8BAA8B;AAC5D,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;AAG1C,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,kBAAkB,EAAE,oBAAoB;AACxC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,QAAQ,EAAE,UAAU;AACpB,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,oBAAoB,EAAE,sBAAsB;;AAE5C,IAAA,uBAAuB,EAAE,yBAAyB;;AAElD,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,iBAAiB,EAAE,mBAAmB;;;;;AAKtC,IAAA,eAAe,EAAE,iBAAiB;;;;;AAKlC,IAAA,WAAW,EAAE,aAAa;;AAE1B,IAAA,eAAe,EAAE,iBAAiB;;;;;;;AAOlC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,2BAA2B,EAAE,6BAA6B;AAC1D,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;AAE1C,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,uCAAuC,EAAE,wBAAwB;;;;;;;;AAQjE,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,YAAY,EAAE,cAAc;;;;AAI5B,IAAA,uBAAuB,EAAE,yBAAyB;;;;;AAKlD,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,gBAAgB,EAAE,kBAAkB;;;;;AAKpC,IAAA,gBAAgB,EAAE,kBAAkB;;;;;;AAMpC,IAAA,oBAAoB,EAAE,sBAAsB;;;AAG5C,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,6BAA6B,EAAE,+BAA+B;AAC9D,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;;AAG1B;;;;;AAKG;AACSA;AAAZ,CAAA,UAAY,YAAY,EAAA;;AAEtB,IAAA,YAAA,CAAA,SAAA,CAAA,GAAA,UAAoB;;AAEpB,IAAA,YAAA,CAAA,aAAA,CAAA,GAAA,eAA6B;;AAE7B,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B;AAC5B,CAAC,EAPWA,oBAAY,KAAZA,oBAAY,GAAA,EAAA,CAAA,CAAA;AASjB,MAAM,kCAAkC,GAAG;;AAEhD,IAAA,YAAY,EAAE,cAAc;;AAG5B,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,uCAAuC,EAAE,wBAAwB;AACjE,IAAA,4BAA4B,EAAE,8BAA8B;;AAGvD,MAAM,qDAAqD,GAAG;AACnE,IAAA,8BAA8B,EAAE,gCAAgC;;MAGrD,UAAU,GAAG,OAAO,MAAM,KAAK;AAE5C;;;;;;;AAOG;AACI,MAAM,8BAA8B,GAAG;;AC9M9C;AACA;AACA;AACA;AACA;AACA,IAAI,sBAAoD;AAExD,MAAM,uBAAuB,GAAG,MAAuB;IACrD,IAAI,CAAC,sBAAsB,EAAE;QAC3B,MAAM,SAAS,GAAGC,8BAAgD;QAClE,MAAM,IAAI,GAAG,SAAS,CAAC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,YAAY;QACtE,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF;QACH;QACA,sBAAsB,GAAG,IAAI;IAC/B;AACA,IAAA,OAAO,sBAAsB;AAC/B,CAAC;AAED;;;;;;AAMG;AACH,MAAM,eAAe,GAAG,CAAC,SAAiB,KACxC,SAAS,KAAK,kCAAkC,IAAI,MAAM,CAAC;MACtD,MAAM,CAAC;AACV,MAAE,MAAM,CAAC,MAAM;AAEnB,MAAM,eAAe,GAAG,CAAC,SAAiB,KAAI;IAC5C,IAAI,CAAC,UAAU,EAAE;AACf,QAAA,OAAO,SAAS;IAClB;AACA,IAAA,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE;AACpC,QAAA,MAAM,CAAC,wBAAwB,GAAG,EAAE;IACtC;IACA,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE;;;AAG/C,QAAA,MAAM,YAAY,GAAG,uBAAuB,EAAE;QAC9C,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,GAAG,IAAI,YAAY,CAAC,SAAS,EAAE;AACvE,YAAA,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC;AAClC,YAAA,KAAK,EAAE,KAAK;AACb,SAAA,CAAC;IACJ;AACA,IAAA,OAAO,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACnD,CAAC;AACD;MACa,4BAA4B;AACvC;AACA,eAAe,CAAC,4BAA4B;MACjC,iCAAiC;AAG5C;AACA,eAAe,CAAC,kCAAkC;MACvC,yBAAyB;AACpC;AACA,eAAe,CAAC,yBAAyB;MAC9B,yCAAyC;AAGpD;AACA,eAAe,CAAC,4CAA4C;AAE9D;;;;;;;;AAQG;AACG,SAAU,wBAAwB,CAAC,KAAc,EAAA;AACrD,IAAA,QACE,OAAO,KAAK,KAAK,QAAQ;AACzB,QAAA,KAAK,KAAK,IAAI;AACb,QAAA,KAA4B,CAAC,IAAI,KAAK,8BAA8B;AAEzE;;;;;;;;;;;;;;;;;;;"}
@@ -39,6 +39,24 @@ declare const COMPOSABLE_STUDIO_QUERY_PARAM: {
39
39
  * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
40
40
  */
41
41
  readonly VARIANT_ALIAS: "cs-variant-alias";
42
+ /**
43
+ * The composition a render asks the URL resolver to prefer. When several
44
+ * templates tie on the requested URL, are linked to the same content type
45
+ * and each has an entry for it, the one named here renders instead of the
46
+ * one the live site would pick. Anything else (a more specific URL, another
47
+ * content type, no entry) is resolved as on the live site.
48
+ *
49
+ * Sent by Studio's canvas (the template being edited, beside
50
+ * `COMPOSABLE_UID`), and by the Visual Editor and Live Preview (the template
51
+ * their own lookup chose). It changes which template renders, nothing else;
52
+ * edit mode stays with `COMPOSABLE_UID`.
53
+ *
54
+ * Only honored inside Studio (via `ENABLED`) or on a preview request: a
55
+ * preview hash in the address, the stack served by the preview service (Live
56
+ * Preview hands a client-rendered page its hash by message), or inside the
57
+ * Visual Editor. On a visitor's request it is ignored.
58
+ */
59
+ readonly PREFERRED_COMPOSITION_UID: "cs-preferred-composition-uid";
42
60
  };
43
61
  declare const POST_MESSAGE_EVENTS: {
44
62
  readonly INIT_STUDIO: "init-studio";
@@ -50,6 +68,8 @@ declare const POST_MESSAGE_EVENTS: {
50
68
  readonly REVEAL_NODE: "reveal-node";
51
69
  /** Canvas → Studio: which node it actually scrolled to, and why it missed. */
52
70
  readonly REVEAL_RESULT: "reveal-result";
71
+ /** Canvas → Studio: the author pressed undo/redo while focus was inside the canvas. */
72
+ readonly HISTORY_SHORTCUT: "history-shortcut";
53
73
  readonly TRANSFORM_OPERATION: "transform-operation";
54
74
  readonly REGISTER_COMPONENTS: "register-components";
55
75
  readonly REGISTER_STUDIO_FUNCTIONS: "register-studio-functions";
@@ -79,6 +99,7 @@ declare const POST_MESSAGE_EVENTS: {
79
99
  readonly IFRAME_STUDIO_CONTEXT: "iframe-studio-context";
80
100
  readonly SDK_SPEC_RESOLVED: "sdk-spec-resolved";
81
101
  readonly SDK_DIAGNOSTICS: "sdk-diagnostics";
102
+ readonly SETUP_CHECK: "setup-check";
82
103
  readonly SDK_INITIALIZED: "sdk-initialized";
83
104
  readonly LISTENERS_READY: "listeners-ready";
84
105
  readonly REPLACE_PREVIEW_ENTRY: "replace-preview-entry";
@@ -94,6 +115,8 @@ declare const POST_MESSAGE_EVENTS: {
94
115
  readonly UPDATE_SECTIONS_CATALOG: "update-sections-catalog";
95
116
  readonly GET_EDIT_CONTEXT: "get-edit-context";
96
117
  readonly SET_EDIT_CONTEXT: "set-edit-context";
118
+ readonly GET_SAVED_COMPONENTS: "get-saved-components";
119
+ readonly UPDATE_SAVED_COMPONENTS: "update-saved-components";
97
120
  readonly HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification";
98
121
  readonly CONTEXT_MENU: "context-menu";
99
122
  readonly GET_NODE_SCREENSHOT: "get-node-screenshot";
@@ -39,6 +39,24 @@ const COMPOSABLE_STUDIO_QUERY_PARAM = {
39
39
  * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
40
40
  */
41
41
  VARIANT_ALIAS: "cs-variant-alias",
42
+ /**
43
+ * The composition a render asks the URL resolver to prefer. When several
44
+ * templates tie on the requested URL, are linked to the same content type
45
+ * and each has an entry for it, the one named here renders instead of the
46
+ * one the live site would pick. Anything else (a more specific URL, another
47
+ * content type, no entry) is resolved as on the live site.
48
+ *
49
+ * Sent by Studio's canvas (the template being edited, beside
50
+ * `COMPOSABLE_UID`), and by the Visual Editor and Live Preview (the template
51
+ * their own lookup chose). It changes which template renders, nothing else;
52
+ * edit mode stays with `COMPOSABLE_UID`.
53
+ *
54
+ * Only honored inside Studio (via `ENABLED`) or on a preview request: a
55
+ * preview hash in the address, the stack served by the preview service (Live
56
+ * Preview hands a client-rendered page its hash by message), or inside the
57
+ * Visual Editor. On a visitor's request it is ignored.
58
+ */
59
+ PREFERRED_COMPOSITION_UID: "cs-preferred-composition-uid",
42
60
  };
43
61
  const POST_MESSAGE_EVENTS = {
44
62
  INIT_STUDIO: "init-studio",
@@ -50,6 +68,8 @@ const POST_MESSAGE_EVENTS = {
50
68
  REVEAL_NODE: "reveal-node",
51
69
  /** Canvas → Studio: which node it actually scrolled to, and why it missed. */
52
70
  REVEAL_RESULT: "reveal-result",
71
+ /** Canvas → Studio: the author pressed undo/redo while focus was inside the canvas. */
72
+ HISTORY_SHORTCUT: "history-shortcut",
53
73
  TRANSFORM_OPERATION: "transform-operation",
54
74
  REGISTER_COMPONENTS: "register-components",
55
75
  // Iframe → Studio: the app's registered studio-function NAMES (BYOS custom
@@ -99,6 +119,11 @@ const POST_MESSAGE_EVENTS = {
99
119
  // Emitted by every SDK component instance regardless of the edited-composition
100
120
  // gate, so Studio can list what loaded and explain why the edited one didn't.
101
121
  SDK_DIAGNOSTICS: "sdk-diagnostics",
122
+ // Iframe → Studio: the result of the one request that tests the site's own
123
+ // delivery setup, sent once per page load inside Studio. Live preview routes
124
+ // every page request to the preview host, so without it a broken delivery
125
+ // setup never shows in the canvas.
126
+ SETUP_CHECK: "setup-check",
102
127
  // SDK Initialization Signal (SDK 1.5.0+)
103
128
  SDK_INITIALIZED: "sdk-initialized",
104
129
  // Iframe → Studio: fired once the post-message listeners registered by
@@ -143,6 +168,15 @@ const POST_MESSAGE_EVENTS = {
143
168
  // then, so no init race. Carries `allowPinData` — whether the pinning
144
169
  // affordances (empty-canvas WelcomeState copy, etc.) should show.
145
170
  SET_EDIT_CONTEXT: "set-edit-context",
171
+ // SDK → Parent (request/response): the editor asks Studio, once its own
172
+ // listeners are mounted, what the saved code design system knows about each
173
+ // component type (display name, who last edited it), so a composition node
174
+ // whose type this app no longer registers can render an "unavailable"
175
+ // placeholder that says whom to ask. Returns `{ components }`.
176
+ GET_SAVED_COMPONENTS: "get-saved-components",
177
+ // Parent → SDK: live update of the same `{ components }` when the saved
178
+ // design system or the user names change.
179
+ UPDATE_SAVED_COMPONENTS: "update-saved-components",
146
180
  HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification",
147
181
  CONTEXT_MENU: "context-menu",
148
182
  GET_NODE_SCREENSHOT: "get-node-screenshot",
@@ -1 +1 @@
1
- {"version":3,"file":"constant.js","sources":["../../src/constant.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAO,MAAM,4BAA4B,GAAG;AACrC,MAAM,4CAA4C,GACvD;AACK,MAAM,sBAAsB,GAAG;AAE/B,MAAM,kCAAkC,GAAG;AAC3C,MAAM,yBAAyB,GAAG;AAElC,MAAM,6BAA6B,GAAG;AAC3C,IAAA,OAAO,EAAE,sBAAsB;AAC/B,IAAA,cAAc,EAAE,mBAAmB;AACnC,IAAA,YAAY,EAAE,MAAM;AACpB;;;;AAIG;AACH,IAAA,iBAAiB,EAAE,cAAc;AACjC,IAAA,cAAc,EAAE,SAAS;AACzB;;;;;;;AAOG;AACH,IAAA,kBAAkB,EAAE,uBAAuB;AAC3C;;;;;;;;;AASG;AACH,IAAA,MAAM,EAAE,WAAW;AACnB;;;AAGG;AACH,IAAA,aAAa,EAAE,kBAAkB;;AAG5B,MAAM,mBAAmB,GAAG;AACjC,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;;AAE9C,IAAA,WAAW,EAAE,aAAa;;AAE1B,IAAA,aAAa,EAAE,eAAe;AAC9B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;;AAI1C,IAAA,yBAAyB,EAAE,2BAA2B;;;;AAItD,IAAA,oBAAoB,EAAE,sBAAsB;;;;AAI5C,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,4BAA4B,EAAE,8BAA8B;AAC5D,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;AAG1C,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,kBAAkB,EAAE,oBAAoB;AACxC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,QAAQ,EAAE,UAAU;AACpB,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,oBAAoB,EAAE,sBAAsB;;AAE5C,IAAA,uBAAuB,EAAE,yBAAyB;;AAElD,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,iBAAiB,EAAE,mBAAmB;;;;;AAKtC,IAAA,eAAe,EAAE,iBAAiB;;AAElC,IAAA,eAAe,EAAE,iBAAiB;;;;;;;AAOlC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,2BAA2B,EAAE,6BAA6B;AAC1D,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;AAE1C,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,uCAAuC,EAAE,wBAAwB;;;;;;;;AAQjE,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,YAAY,EAAE,cAAc;;;;AAI5B,IAAA,uBAAuB,EAAE,yBAAyB;;;;;AAKlD,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,gBAAgB,EAAE,kBAAkB;;;;;AAKpC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,6BAA6B,EAAE,+BAA+B;AAC9D,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;;AAG1B;;;;;AAKG;IACS;AAAZ,CAAA,UAAY,YAAY,EAAA;;AAEtB,IAAA,YAAA,CAAA,SAAA,CAAA,GAAA,UAAoB;;AAEpB,IAAA,YAAA,CAAA,aAAA,CAAA,GAAA,eAA6B;;AAE7B,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B;AAC5B,CAAC,EAPW,YAAY,KAAZ,YAAY,GAAA,EAAA,CAAA,CAAA;AASjB,MAAM,kCAAkC,GAAG;;AAEhD,IAAA,YAAY,EAAE,cAAc;;AAG5B,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,uCAAuC,EAAE,wBAAwB;AACjE,IAAA,4BAA4B,EAAE,8BAA8B;;AAGvD,MAAM,qDAAqD,GAAG;AACnE,IAAA,8BAA8B,EAAE,gCAAgC;;MAGrD,UAAU,GAAG,OAAO,MAAM,KAAK;AAE5C;;;;;;;AAOG;AACI,MAAM,8BAA8B,GAAG;;;;"}
1
+ {"version":3,"file":"constant.js","sources":["../../src/constant.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAO,MAAM,4BAA4B,GAAG;AACrC,MAAM,4CAA4C,GACvD;AACK,MAAM,sBAAsB,GAAG;AAE/B,MAAM,kCAAkC,GAAG;AAC3C,MAAM,yBAAyB,GAAG;AAElC,MAAM,6BAA6B,GAAG;AAC3C,IAAA,OAAO,EAAE,sBAAsB;AAC/B,IAAA,cAAc,EAAE,mBAAmB;AACnC,IAAA,YAAY,EAAE,MAAM;AACpB;;;;AAIG;AACH,IAAA,iBAAiB,EAAE,cAAc;AACjC,IAAA,cAAc,EAAE,SAAS;AACzB;;;;;;;AAOG;AACH,IAAA,kBAAkB,EAAE,uBAAuB;AAC3C;;;;;;;;;AASG;AACH,IAAA,MAAM,EAAE,WAAW;AACnB;;;AAGG;AACH,IAAA,aAAa,EAAE,kBAAkB;AACjC;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,yBAAyB,EAAE,8BAA8B;;AAGpD,MAAM,mBAAmB,GAAG;AACjC,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;;AAE9C,IAAA,WAAW,EAAE,aAAa;;AAE1B,IAAA,aAAa,EAAE,eAAe;;AAE9B,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;;AAI1C,IAAA,yBAAyB,EAAE,2BAA2B;;;;AAItD,IAAA,oBAAoB,EAAE,sBAAsB;;;;AAI5C,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,4BAA4B,EAAE,8BAA8B;AAC5D,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;;AAG1C,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,kBAAkB,EAAE,oBAAoB;AACxC,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,QAAQ,EAAE,UAAU;AACpB,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,oBAAoB,EAAE,sBAAsB;;AAE5C,IAAA,uBAAuB,EAAE,yBAAyB;;AAElD,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,iBAAiB,EAAE,mBAAmB;;;;;AAKtC,IAAA,eAAe,EAAE,iBAAiB;;;;;AAKlC,IAAA,WAAW,EAAE,aAAa;;AAE1B,IAAA,eAAe,EAAE,iBAAiB;;;;;;;AAOlC,IAAA,eAAe,EAAE,iBAAiB;AAClC,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,2BAA2B,EAAE,6BAA6B;AAC1D,IAAA,oBAAoB,EAAE,sBAAsB;AAC5C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;;AAE1C,IAAA,qBAAqB,EAAE,uBAAuB;AAC9C,IAAA,uCAAuC,EAAE,wBAAwB;;;;;;;;AAQjE,IAAA,wBAAwB,EAAE,0BAA0B;AACpD,IAAA,YAAY,EAAE,cAAc;;;;AAI5B,IAAA,uBAAuB,EAAE,yBAAyB;;;;;AAKlD,IAAA,uBAAuB,EAAE,yBAAyB;;;;AAIlD,IAAA,gBAAgB,EAAE,kBAAkB;;;;;AAKpC,IAAA,gBAAgB,EAAE,kBAAkB;;;;;;AAMpC,IAAA,oBAAoB,EAAE,sBAAsB;;;AAG5C,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,6BAA6B,EAAE,+BAA+B;AAC9D,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;;AAG1B;;;;;AAKG;IACS;AAAZ,CAAA,UAAY,YAAY,EAAA;;AAEtB,IAAA,YAAA,CAAA,SAAA,CAAA,GAAA,UAAoB;;AAEpB,IAAA,YAAA,CAAA,aAAA,CAAA,GAAA,eAA6B;;AAE7B,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B;AAC5B,CAAC,EAPW,YAAY,KAAZ,YAAY,GAAA,EAAA,CAAA,CAAA;AASjB,MAAM,kCAAkC,GAAG;;AAEhD,IAAA,YAAY,EAAE,cAAc;;AAG5B,IAAA,iBAAiB,EAAE,mBAAmB;AACtC,IAAA,uCAAuC,EAAE,wBAAwB;AACjE,IAAA,4BAA4B,EAAE,8BAA8B;;AAGvD,MAAM,qDAAqD,GAAG;AACnE,IAAA,8BAA8B,EAAE,gCAAgC;;MAGrD,UAAU,GAAG,OAAO,MAAM,KAAK;AAE5C;;;;;;;AAOG;AACI,MAAM,8BAA8B,GAAG;;;;"}
@@ -1,5 +1,5 @@
1
1
  import * as _contentstack_advanced_post_message from '@contentstack/advanced-post-message';
2
- export { CompositionResolutionDiagnosticEventData, CompositionSavedEventData, GetNodeScreenshotEventData, GetNodeScreenshotResponseEventData, HiddenElementNotificationEventData, OpenComposableStudioFromStudioEventData, OpenComposableStudioFromVBEventData, PrimaryCompositionDetectedEventData, ResolvedComposition, ShortlistedComposition } from '@contentstack/studio-message-types/latest';
2
+ export { CompositionResolutionDiagnosticEventData, CompositionSavedEventData, GetNodeScreenshotEventData, GetNodeScreenshotResponseEventData, HiddenElementNotificationEventData, OpenComposableStudioFromStudioEventData, OpenComposableStudioFromVBEventData, PrimaryCompositionDetectedEventData, ResolvedComposition, SetupCheckEventData, ShortlistedComposition, UrlWinner } from '@contentstack/studio-message-types/latest';
3
3
  export { CompositionQuery } from '@contentstack/studio-message-types/base';
4
4
 
5
5
  type AdvancedPostMessageModule = typeof _contentstack_advanced_post_message & {
@@ -63,6 +63,24 @@ declare const COMPOSABLE_STUDIO_QUERY_PARAM: {
63
63
  * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
64
64
  */
65
65
  readonly VARIANT_ALIAS: "cs-variant-alias";
66
+ /**
67
+ * The composition a render asks the URL resolver to prefer. When several
68
+ * templates tie on the requested URL, are linked to the same content type
69
+ * and each has an entry for it, the one named here renders instead of the
70
+ * one the live site would pick. Anything else (a more specific URL, another
71
+ * content type, no entry) is resolved as on the live site.
72
+ *
73
+ * Sent by Studio's canvas (the template being edited, beside
74
+ * `COMPOSABLE_UID`), and by the Visual Editor and Live Preview (the template
75
+ * their own lookup chose). It changes which template renders, nothing else;
76
+ * edit mode stays with `COMPOSABLE_UID`.
77
+ *
78
+ * Only honored inside Studio (via `ENABLED`) or on a preview request: a
79
+ * preview hash in the address, the stack served by the preview service (Live
80
+ * Preview hands a client-rendered page its hash by message), or inside the
81
+ * Visual Editor. On a visitor's request it is ignored.
82
+ */
83
+ readonly PREFERRED_COMPOSITION_UID: "cs-preferred-composition-uid";
66
84
  };
67
85
  declare const POST_MESSAGE_EVENTS: {
68
86
  readonly INIT_STUDIO: "init-studio";
@@ -74,6 +92,8 @@ declare const POST_MESSAGE_EVENTS: {
74
92
  readonly REVEAL_NODE: "reveal-node";
75
93
  /** Canvas → Studio: which node it actually scrolled to, and why it missed. */
76
94
  readonly REVEAL_RESULT: "reveal-result";
95
+ /** Canvas → Studio: the author pressed undo/redo while focus was inside the canvas. */
96
+ readonly HISTORY_SHORTCUT: "history-shortcut";
77
97
  readonly TRANSFORM_OPERATION: "transform-operation";
78
98
  readonly REGISTER_COMPONENTS: "register-components";
79
99
  readonly REGISTER_STUDIO_FUNCTIONS: "register-studio-functions";
@@ -103,6 +123,7 @@ declare const POST_MESSAGE_EVENTS: {
103
123
  readonly IFRAME_STUDIO_CONTEXT: "iframe-studio-context";
104
124
  readonly SDK_SPEC_RESOLVED: "sdk-spec-resolved";
105
125
  readonly SDK_DIAGNOSTICS: "sdk-diagnostics";
126
+ readonly SETUP_CHECK: "setup-check";
106
127
  readonly SDK_INITIALIZED: "sdk-initialized";
107
128
  readonly LISTENERS_READY: "listeners-ready";
108
129
  readonly REPLACE_PREVIEW_ENTRY: "replace-preview-entry";
@@ -118,6 +139,8 @@ declare const POST_MESSAGE_EVENTS: {
118
139
  readonly UPDATE_SECTIONS_CATALOG: "update-sections-catalog";
119
140
  readonly GET_EDIT_CONTEXT: "get-edit-context";
120
141
  readonly SET_EDIT_CONTEXT: "set-edit-context";
142
+ readonly GET_SAVED_COMPONENTS: "get-saved-components";
143
+ readonly UPDATE_SAVED_COMPONENTS: "update-saved-components";
121
144
  readonly HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification";
122
145
  readonly CONTEXT_MENU: "context-menu";
123
146
  readonly GET_NODE_SCREENSHOT: "get-node-screenshot";
package/dist/esm/main.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as advancedPostMessage from '@contentstack/advanced-post-message';
2
- import { NO_REQUEST_LISTENER_ERROR_CODE, IS_BROWSER, COMPOSABLE_STUDIO_CHANNEL_ID, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, VISUAL_BUILDER_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID } from './constant.js';
2
+ import { NO_REQUEST_LISTENER_ERROR_CODE, IS_BROWSER, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, COMPOSABLE_STUDIO_CHANNEL_ID, VISUAL_BUILDER_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID } from './constant.js';
3
3
 
4
4
  // Resolved on first use rather than at import. Resolving (and throwing) at
5
5
  // module scope made this module observably side-effecting, so a bundler could
@@ -18,6 +18,16 @@ const resolveEventManagerCtor = () => {
18
18
  }
19
19
  return cachedEventManagerCtor;
20
20
  };
21
+ /**
22
+ * The window a channel posts to. Studio opened as a popup by the Visual
23
+ * Builder (the "Open in Studio" button on a composition) tells the window that
24
+ * opened it about a save on the popup channel, so that channel talks to
25
+ * `window.opener`; in a popup `window.parent` is the popup itself. Every other
26
+ * channel talks to the parent frame.
27
+ */
28
+ const getTargetWindow = (channelId) => channelId === COMPOSABLE_STUDIO_POPUP_CHANNEL_ID && window.opener
29
+ ? window.opener
30
+ : window.parent;
21
31
  const getEventManager = (channelId) => {
22
32
  if (!IS_BROWSER) {
23
33
  return undefined;
@@ -30,7 +40,7 @@ const getEventManager = (channelId) => {
30
40
  // same postMessage bridge instead of creating duplicate listeners.
31
41
  const EventManager = resolveEventManagerCtor();
32
42
  window.__csMessengerListeners__[channelId] = new EventManager(channelId, {
33
- target: window.parent,
43
+ target: getTargetWindow(channelId),
34
44
  debug: false,
35
45
  });
36
46
  }
@@ -1 +1 @@
1
- {"version":3,"file":"main.js","sources":["../../src/main.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAsBA;AACA;AACA;AACA;AACA;AACA,IAAI,sBAAoD;AAExD,MAAM,uBAAuB,GAAG,MAAuB;IACrD,IAAI,CAAC,sBAAsB,EAAE;QAC3B,MAAM,SAAS,GAAG,mBAAgD;QAClE,MAAM,IAAI,GAAG,SAAS,CAAC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,YAAY;QACtE,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF;QACH;QACA,sBAAsB,GAAG,IAAI;IAC/B;AACA,IAAA,OAAO,sBAAsB;AAC/B,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,SAAiB,KAAI;IAC5C,IAAI,CAAC,UAAU,EAAE;AACf,QAAA,OAAO,SAAS;IAClB;AACA,IAAA,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE;AACpC,QAAA,MAAM,CAAC,wBAAwB,GAAG,EAAE;IACtC;IACA,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE;;;AAG/C,QAAA,MAAM,YAAY,GAAG,uBAAuB,EAAE;QAC9C,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,GAAG,IAAI,YAAY,CAAC,SAAS,EAAE;YACvE,MAAM,EAAE,MAAM,CAAC,MAAM;AACrB,YAAA,KAAK,EAAE,KAAK;AACb,SAAA,CAAC;IACJ;AACA,IAAA,OAAO,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACnD,CAAC;AACD;MACa,4BAA4B;AACvC;AACA,eAAe,CAAC,4BAA4B;MACjC,iCAAiC;AAG5C;AACA,eAAe,CAAC,kCAAkC;MACvC,yBAAyB;AACpC;AACA,eAAe,CAAC,yBAAyB;MAC9B,yCAAyC;AAGpD;AACA,eAAe,CAAC,4CAA4C;AAE9D;;;;;;;;AAQG;AACG,SAAU,wBAAwB,CAAC,KAAc,EAAA;AACrD,IAAA,QACE,OAAO,KAAK,KAAK,QAAQ;AACzB,QAAA,KAAK,KAAK,IAAI;AACb,QAAA,KAA4B,CAAC,IAAI,KAAK,8BAA8B;AAEzE;;;;"}
1
+ {"version":3,"file":"main.js","sources":["../../src/main.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAsBA;AACA;AACA;AACA;AACA;AACA,IAAI,sBAAoD;AAExD,MAAM,uBAAuB,GAAG,MAAuB;IACrD,IAAI,CAAC,sBAAsB,EAAE;QAC3B,MAAM,SAAS,GAAG,mBAAgD;QAClE,MAAM,IAAI,GAAG,SAAS,CAAC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,YAAY;QACtE,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF;QACH;QACA,sBAAsB,GAAG,IAAI;IAC/B;AACA,IAAA,OAAO,sBAAsB;AAC/B,CAAC;AAED;;;;;;AAMG;AACH,MAAM,eAAe,GAAG,CAAC,SAAiB,KACxC,SAAS,KAAK,kCAAkC,IAAI,MAAM,CAAC;MACtD,MAAM,CAAC;AACV,MAAE,MAAM,CAAC,MAAM;AAEnB,MAAM,eAAe,GAAG,CAAC,SAAiB,KAAI;IAC5C,IAAI,CAAC,UAAU,EAAE;AACf,QAAA,OAAO,SAAS;IAClB;AACA,IAAA,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE;AACpC,QAAA,MAAM,CAAC,wBAAwB,GAAG,EAAE;IACtC;IACA,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE;;;AAG/C,QAAA,MAAM,YAAY,GAAG,uBAAuB,EAAE;QAC9C,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,GAAG,IAAI,YAAY,CAAC,SAAS,EAAE;AACvE,YAAA,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC;AAClC,YAAA,KAAK,EAAE,KAAK;AACb,SAAA,CAAC;IACJ;AACA,IAAA,OAAO,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACnD,CAAC;AACD;MACa,4BAA4B;AACvC;AACA,eAAe,CAAC,4BAA4B;MACjC,iCAAiC;AAG5C;AACA,eAAe,CAAC,kCAAkC;MACvC,yBAAyB;AACpC;AACA,eAAe,CAAC,yBAAyB;MAC9B,yCAAyC;AAGpD;AACA,eAAe,CAAC,4CAA4C;AAE9D;;;;;;;;AAQG;AACG,SAAU,wBAAwB,CAAC,KAAc,EAAA;AACrD,IAAA,QACE,OAAO,KAAK,KAAK,QAAQ;AACzB,QAAA,KAAK,KAAK,IAAI;AACb,QAAA,KAA4B,CAAC,IAAI,KAAK,8BAA8B;AAEzE;;;;"}
@@ -34,6 +34,24 @@ declare const COMPOSABLE_STUDIO_QUERY_PARAM: {
34
34
  * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
35
35
  */
36
36
  readonly VARIANT_ALIAS: "cs-variant-alias";
37
+ /**
38
+ * The composition a render asks the URL resolver to prefer. When several
39
+ * templates tie on the requested URL, are linked to the same content type
40
+ * and each has an entry for it, the one named here renders instead of the
41
+ * one the live site would pick. Anything else (a more specific URL, another
42
+ * content type, no entry) is resolved as on the live site.
43
+ *
44
+ * Sent by Studio's canvas (the template being edited, beside
45
+ * `COMPOSABLE_UID`), and by the Visual Editor and Live Preview (the template
46
+ * their own lookup chose). It changes which template renders, nothing else;
47
+ * edit mode stays with `COMPOSABLE_UID`.
48
+ *
49
+ * Only honored inside Studio (via `ENABLED`) or on a preview request: a
50
+ * preview hash in the address, the stack served by the preview service (Live
51
+ * Preview hands a client-rendered page its hash by message), or inside the
52
+ * Visual Editor. On a visitor's request it is ignored.
53
+ */
54
+ readonly PREFERRED_COMPOSITION_UID: "cs-preferred-composition-uid";
37
55
  };
38
56
 
39
57
  type ComposableStudioQueryParamsKeys = (typeof COMPOSABLE_STUDIO_QUERY_PARAM)[keyof typeof COMPOSABLE_STUDIO_QUERY_PARAM];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contentstack/studio-messenger",
3
- "version": "3.2.0",
3
+ "version": "3.3.0",
4
4
  "description": "This package handles communication between the Studio platform and the iframe webpage.",
5
5
  "main": "dist/cjs/index.cjs",
6
6
  "types": "dist/esm/index.d.ts",
@@ -52,7 +52,7 @@
52
52
  "scripts": {
53
53
  "dev": "rollup -c ./rollup.config.mjs --watch",
54
54
  "build": "rollup -c rollup.config.mjs",
55
- "test": "exit 0",
55
+ "test": "vitest run",
56
56
  "lint": "eslint src/ --max-warnings 0",
57
57
  "lint:fix": "eslint src/ --fix"
58
58
  },
@@ -60,7 +60,7 @@
60
60
  "url": "https://github.com/contentstack/composable-studio-sdk/issues"
61
61
  },
62
62
  "devDependencies": {
63
- "@contentstack/common-config": "^1.2.5",
63
+ "@contentstack/common-config": "^1.2.7",
64
64
  "@rollup/plugin-commonjs": "^28.0.6",
65
65
  "@rollup/plugin-node-resolve": "^16.0.1",
66
66
  "@rollup/plugin-terser": "^1.0.0",
@@ -73,6 +73,6 @@
73
73
  },
74
74
  "dependencies": {
75
75
  "@contentstack/advanced-post-message": "^0.0.5",
76
- "@contentstack/studio-message-types": "^2.0.0"
76
+ "@contentstack/studio-message-types": "^2.2.0"
77
77
  }
78
78
  }