@contentstack/studio-messenger 1.4.0 → 1.5.1

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.
@@ -2,6 +2,25 @@
2
2
 
3
3
  var advancedPostMessage = require('@contentstack/advanced-post-message');
4
4
 
5
+ function _interopNamespaceDefault(e) {
6
+ var n = Object.create(null);
7
+ if (e) {
8
+ Object.keys(e).forEach(function (k) {
9
+ if (k !== 'default') {
10
+ var d = Object.getOwnPropertyDescriptor(e, k);
11
+ Object.defineProperty(n, k, d.get ? d : {
12
+ enumerable: true,
13
+ get: function () { return e[k]; }
14
+ });
15
+ }
16
+ });
17
+ }
18
+ n.default = e;
19
+ return Object.freeze(n);
20
+ }
21
+
22
+ var advancedPostMessage__namespace = /*#__PURE__*/_interopNamespaceDefault(advancedPostMessage);
23
+
5
24
  const COMPOSABLE_STUDIO_CHANNEL_ID = "composable-studio";
6
25
  const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID = "composable-studio-built-in-canvas";
7
26
  const LIVE_EDITOR_CHANNEL_ID = "live-editor";
@@ -9,7 +28,6 @@ const COMPOSABLE_STUDIO_POPUP_CHANNEL_ID = "composable-studio-popup";
9
28
  const VISUAL_BUILDER_CHANNEL_ID = "composable-client-visual-builder";
10
29
  const COMPOSABLE_STUDIO_QUERY_PARAM = {
11
30
  ENABLED: "cs-composable-studio",
12
- COMPOSITION_ENTRY_UID: "cs-composition-uid",
13
31
  COMPOSABLE_UID: "cs-composable-uid",
14
32
  PREVIEW_HASH: "hash",
15
33
  /**
@@ -18,9 +36,32 @@ const COMPOSABLE_STUDIO_QUERY_PARAM = {
18
36
  * So we need to handle both the cases.
19
37
  */
20
38
  LIVE_PREVIEW_HASH: "live_preview",
21
- CONNECTED_CONTENT_TYPE: "connected-content-type",
22
- DYNAMIC_URL: "dynamic-url",
23
39
  VISUAL_BUILDER: "builder",
40
+ /**
41
+ * When Studio renders the iframe and the user has explicitly picked an
42
+ * entry from the navbar, Studio appends this param so the SDK (running
43
+ * inside Studio) can prefer it over a host-passed `templateEntryUid`.
44
+ *
45
+ * Only honored when the SDK detects it is running inside Studio (via
46
+ * `ENABLED`). Outside Studio it is ignored.
47
+ */
48
+ TEMPLATE_ENTRY_UID: "cs-template-entry-uid",
49
+ /**
50
+ * Locale Studio wants the SDK to render in. Set by Studio when its canvas
51
+ * URL carries `?locale=...`. The SDK overrides its own `config.locale`
52
+ * with this value so all SDK-side data fetches (initial + linked entries)
53
+ * use the right locale, and so the postmessages back to Studio
54
+ * (INIT_STUDIO.globalLocale, GET_COMPOSITION_SPEC.locale) carry it too.
55
+ *
56
+ * Only honored when the SDK detects it is running inside Studio (via
57
+ * `ENABLED`). Outside Studio it is ignored.
58
+ */
59
+ LOCALE: "cs-locale",
60
+ /**
61
+ * Variant alias Studio wants the SDK to render in. Same flow as `LOCALE`
62
+ * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
63
+ */
64
+ VARIANT_ALIAS: "cs-variant-alias",
24
65
  };
25
66
  const POST_MESSAGE_EVENTS = {
26
67
  INIT_STUDIO: "init-studio",
@@ -35,6 +76,9 @@ const POST_MESSAGE_EVENTS = {
35
76
  REGISTER_DESIGN_CLASSES: "register-design-classes",
36
77
  VALIDATE_PROP_VALUE: "validate-prop-value",
37
78
  GET_COMPONENT_PROPS: "get-component-props",
79
+ // Per-slot component_props reported by <Slot data={...}>, keyed by slot identity
80
+ // (`${parentNodeUid}:${slotUid}`) so the data-picker can surface slot-scoped keys.
81
+ GET_SLOT_COMPONENT_PROPS: "get-slot-component-props",
38
82
  UPDATE_DATA_SOURCE: "update-data-source",
39
83
  UPDATE_SPEC_DATA: "update-spec-data",
40
84
  UPDATE_STATIC_VALUE: "update-static-value",
@@ -54,8 +98,20 @@ const POST_MESSAGE_EVENTS = {
54
98
  // Fast Rendering Protocol (Canvas Delay Fix)
55
99
  IFRAME_STUDIO_CONTEXT: "iframe-studio-context",
56
100
  SDK_SPEC_RESOLVED: "sdk-spec-resolved",
101
+ // Iframe → Studio: per-component resolution telemetry (what was queried,
102
+ // which compositions were shortlisted with specificity, and which won).
103
+ // Emitted by every SDK component instance regardless of the edited-composition
104
+ // gate, so Studio can list what loaded and explain why the edited one didn't.
105
+ SDK_DIAGNOSTICS: "sdk-diagnostics",
57
106
  // SDK Initialization Signal (SDK 1.5.0+)
58
107
  SDK_INITIALIZED: "sdk-initialized",
108
+ // Iframe → Studio: fired once the post-message listeners registered by
109
+ // `useSpecDataListener` are in place. Studio should gate any editor → iframe
110
+ // sends (notably UPDATE_SPEC_DATA) on receipt of this signal — it is the
111
+ // only event guaranteed to fire AFTER EditableRenderer commits its first
112
+ // render. Earlier signals (SDK_SPEC_RESOLVED, INIT_STUDIO) fire before the
113
+ // React tree mounts and race against the listener registration.
114
+ LISTENERS_READY: "listeners-ready",
59
115
  REPLACE_PREVIEW_ENTRY: "replace-preview-entry",
60
116
  CHANGE_ACTIVE_STYLE_SECTION: "change-active-style-section",
61
117
  CHANGE_STYLE_SECTION: "change-style-section",
@@ -65,12 +121,47 @@ const POST_MESSAGE_EVENTS = {
65
121
  UPDATE_BINDING_ERRORS: "update-binding-errors",
66
122
  OPEN_IN_COMPOSABLE_STUDIO_EVENT_MESSAGE: "open-composable-studio",
67
123
  UPDATE_SYMBOLS: "update-symbols",
124
+ GET_SYMBOLS: "get-symbols",
125
+ GET_SECTIONS: "get-sections",
126
+ // Parent → SDK: push the latest per-instance section binding map
127
+ // (dataSources.section_compositions) after a section-context recompute on
128
+ // Studio side. Carries only the section slice, not the full spec.data.
129
+ UPDATE_SECTION_CONTEXTS: "update-section-contexts",
130
+ // Parent → SDK: push the full section-composition catalog (one entry per
131
+ // section in the project). Fired by Studio whenever the local section
132
+ // store hydrates / updates, so the iframe doesn't depend on a one-shot
133
+ // GET_SECTIONS reply that races with Studio's async fetch.
134
+ UPDATE_SECTIONS_CATALOG: "update-sections-catalog",
68
135
  ADD_NEW_SYMBOL: "add-new-symbol",
136
+ // SDK → Parent (request/response): the editor asks Studio for the
137
+ // per-composition editor context once its own listeners are mounted. A pull,
138
+ // so it never races Studio's init timing. Returns `{ allowPinData }`.
139
+ GET_EDIT_CONTEXT: "get-edit-context",
140
+ // Parent → SDK: live update of the editor context when it changes mid-session
141
+ // (e.g. the Freeform plan is toggled). The listener is already registered by
142
+ // then, so no init race. Carries `allowPinData` — whether the pinning
143
+ // affordances (empty-canvas WelcomeState copy, etc.) should show.
144
+ SET_EDIT_CONTEXT: "set-edit-context",
69
145
  HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification",
70
146
  CONTEXT_MENU: "context-menu",
71
147
  GET_NODE_SCREENSHOT: "get-node-screenshot",
72
148
  URL_CHANGE: "url-change",
73
149
  };
150
+ /**
151
+ * Which data options the empty-canvas WelcomeState step 2 offers for the edited
152
+ * composition. Computed by Studio, carried in the `GET_EDIT_CONTEXT` /
153
+ * `SET_EDIT_CONTEXT` payloads (composable-studio ADR 0008). String values are
154
+ * the wire format — do not change them without a coordinated release.
155
+ */
156
+ exports.DataStepMode = void 0;
157
+ (function (DataStepMode) {
158
+ /** Freeform page — pin data only, no schema to connect. */
159
+ DataStepMode["PinOnly"] = "pin-only";
160
+ /** Schema-based comp (linked page or section) with the Freeform plan on. */
161
+ DataStepMode["SchemaOrPin"] = "schema-or-pin";
162
+ /** Schema-based comp with the Freeform plan off. */
163
+ DataStepMode["SchemaOnly"] = "schema-only";
164
+ })(exports.DataStepMode || (exports.DataStepMode = {}));
74
165
  const VISUAL_BUILDER_POST_MESSAGE_EVENTS = {
75
166
  // From visual builder to composable client
76
167
  REFETCH_SPEC: "refetch-spec",
@@ -84,6 +175,11 @@ const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS = {
84
175
  };
85
176
  const IS_BROWSER = typeof window !== "undefined";
86
177
 
178
+ const apmModule = advancedPostMessage__namespace;
179
+ const EventManager = apmModule.EventManager ?? apmModule.default?.EventManager;
180
+ if (!EventManager) {
181
+ throw new Error("studio-messenger: EventManager missing from @contentstack/advanced-post-message");
182
+ }
87
183
  const getEventManager = (channelId) => {
88
184
  if (!IS_BROWSER) {
89
185
  return undefined;
@@ -92,7 +188,9 @@ const getEventManager = (channelId) => {
92
188
  window.__csMessengerListeners__ = {};
93
189
  }
94
190
  if (!window.__csMessengerListeners__[channelId]) {
95
- window.__csMessengerListeners__[channelId] = new advancedPostMessage.EventManager(channelId, {
191
+ // Cache one EventManager per channel so repeated imports/mounts reuse the
192
+ // same postMessage bridge instead of creating duplicate listeners.
193
+ window.__csMessengerListeners__[channelId] = new EventManager(channelId, {
96
194
  target: window.parent,
97
195
  debug: false,
98
196
  });
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","sources":["../../src/constant.ts","../../src/main.ts"],"sourcesContent":[null,null],"names":["EventManager"],"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,qBAAqB,EAAE,oBAAoB;AAC3C,IAAA,cAAc,EAAE,mBAAmB;AACnC,IAAA,YAAY,EAAE,MAAM;AACpB;;;;AAIG;AACH,IAAA,iBAAiB,EAAE,cAAc;AACjC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,cAAc,EAAE,SAAS;;AAGpB,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;AAC9C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,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,sBAAsB,EAAE,wBAAwB;AAChD,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;;AAEtC,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;AACjE,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,6BAA6B,EAAE,+BAA+B;AAC9D,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;;AAGnB,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;;AC/E5C,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;QAC/C,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,GAAG,IAAIA,gCAAY,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;AAC5C;AACA,eAAe,CAAC,kCAAkC;MACvC,yBAAyB;AACpC;AACA,eAAe,CAAC,yBAAyB;MAC9B,yCAAyC;AAGpD;AACA,eAAe,CAAC,4CAA4C;;;;;;;;;;;;;;;;;"}
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;AAC9C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,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,sBAAsB,EAAE,wBAAwB;AAChD,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;AACjE,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,YAAY,EAAE,cAAc;;;;AAI5B,IAAA,uBAAuB,EAAE,yBAAyB;;;;;AAKlD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,cAAc,EAAE,gBAAgB;;;;AAIhC,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;;AC9I5C,MAAM,SAAS,GAAGC,8BAAgD;AAClE,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,YAAY;AAE9E,IAAI,CAAC,YAAY,EAAE;AACjB,IAAA,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF;AACH;AAIA,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;;;QAG/C,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;;;;;;;;;;;;;;;;;"}
@@ -5,7 +5,6 @@ const COMPOSABLE_STUDIO_POPUP_CHANNEL_ID = "composable-studio-popup";
5
5
  const VISUAL_BUILDER_CHANNEL_ID = "composable-client-visual-builder";
6
6
  const COMPOSABLE_STUDIO_QUERY_PARAM = {
7
7
  ENABLED: "cs-composable-studio",
8
- COMPOSITION_ENTRY_UID: "cs-composition-uid",
9
8
  COMPOSABLE_UID: "cs-composable-uid",
10
9
  PREVIEW_HASH: "hash",
11
10
  /**
@@ -14,9 +13,32 @@ const COMPOSABLE_STUDIO_QUERY_PARAM = {
14
13
  * So we need to handle both the cases.
15
14
  */
16
15
  LIVE_PREVIEW_HASH: "live_preview",
17
- CONNECTED_CONTENT_TYPE: "connected-content-type",
18
- DYNAMIC_URL: "dynamic-url",
19
16
  VISUAL_BUILDER: "builder",
17
+ /**
18
+ * When Studio renders the iframe and the user has explicitly picked an
19
+ * entry from the navbar, Studio appends this param so the SDK (running
20
+ * inside Studio) can prefer it over a host-passed `templateEntryUid`.
21
+ *
22
+ * Only honored when the SDK detects it is running inside Studio (via
23
+ * `ENABLED`). Outside Studio it is ignored.
24
+ */
25
+ TEMPLATE_ENTRY_UID: "cs-template-entry-uid",
26
+ /**
27
+ * Locale Studio wants the SDK to render in. Set by Studio when its canvas
28
+ * URL carries `?locale=...`. The SDK overrides its own `config.locale`
29
+ * with this value so all SDK-side data fetches (initial + linked entries)
30
+ * use the right locale, and so the postmessages back to Studio
31
+ * (INIT_STUDIO.globalLocale, GET_COMPOSITION_SPEC.locale) carry it too.
32
+ *
33
+ * Only honored when the SDK detects it is running inside Studio (via
34
+ * `ENABLED`). Outside Studio it is ignored.
35
+ */
36
+ LOCALE: "cs-locale",
37
+ /**
38
+ * Variant alias Studio wants the SDK to render in. Same flow as `LOCALE`
39
+ * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
40
+ */
41
+ VARIANT_ALIAS: "cs-variant-alias",
20
42
  };
21
43
  const POST_MESSAGE_EVENTS = {
22
44
  INIT_STUDIO: "init-studio",
@@ -31,6 +53,9 @@ const POST_MESSAGE_EVENTS = {
31
53
  REGISTER_DESIGN_CLASSES: "register-design-classes",
32
54
  VALIDATE_PROP_VALUE: "validate-prop-value",
33
55
  GET_COMPONENT_PROPS: "get-component-props",
56
+ // Per-slot component_props reported by <Slot data={...}>, keyed by slot identity
57
+ // (`${parentNodeUid}:${slotUid}`) so the data-picker can surface slot-scoped keys.
58
+ GET_SLOT_COMPONENT_PROPS: "get-slot-component-props",
34
59
  UPDATE_DATA_SOURCE: "update-data-source",
35
60
  UPDATE_SPEC_DATA: "update-spec-data",
36
61
  UPDATE_STATIC_VALUE: "update-static-value",
@@ -50,8 +75,20 @@ const POST_MESSAGE_EVENTS = {
50
75
  // Fast Rendering Protocol (Canvas Delay Fix)
51
76
  IFRAME_STUDIO_CONTEXT: "iframe-studio-context",
52
77
  SDK_SPEC_RESOLVED: "sdk-spec-resolved",
78
+ // Iframe → Studio: per-component resolution telemetry (what was queried,
79
+ // which compositions were shortlisted with specificity, and which won).
80
+ // Emitted by every SDK component instance regardless of the edited-composition
81
+ // gate, so Studio can list what loaded and explain why the edited one didn't.
82
+ SDK_DIAGNOSTICS: "sdk-diagnostics",
53
83
  // SDK Initialization Signal (SDK 1.5.0+)
54
84
  SDK_INITIALIZED: "sdk-initialized",
85
+ // Iframe → Studio: fired once the post-message listeners registered by
86
+ // `useSpecDataListener` are in place. Studio should gate any editor → iframe
87
+ // sends (notably UPDATE_SPEC_DATA) on receipt of this signal — it is the
88
+ // only event guaranteed to fire AFTER EditableRenderer commits its first
89
+ // render. Earlier signals (SDK_SPEC_RESOLVED, INIT_STUDIO) fire before the
90
+ // React tree mounts and race against the listener registration.
91
+ LISTENERS_READY: "listeners-ready",
55
92
  REPLACE_PREVIEW_ENTRY: "replace-preview-entry",
56
93
  CHANGE_ACTIVE_STYLE_SECTION: "change-active-style-section",
57
94
  CHANGE_STYLE_SECTION: "change-style-section",
@@ -61,12 +98,47 @@ const POST_MESSAGE_EVENTS = {
61
98
  UPDATE_BINDING_ERRORS: "update-binding-errors",
62
99
  OPEN_IN_COMPOSABLE_STUDIO_EVENT_MESSAGE: "open-composable-studio",
63
100
  UPDATE_SYMBOLS: "update-symbols",
101
+ GET_SYMBOLS: "get-symbols",
102
+ GET_SECTIONS: "get-sections",
103
+ // Parent → SDK: push the latest per-instance section binding map
104
+ // (dataSources.section_compositions) after a section-context recompute on
105
+ // Studio side. Carries only the section slice, not the full spec.data.
106
+ UPDATE_SECTION_CONTEXTS: "update-section-contexts",
107
+ // Parent → SDK: push the full section-composition catalog (one entry per
108
+ // section in the project). Fired by Studio whenever the local section
109
+ // store hydrates / updates, so the iframe doesn't depend on a one-shot
110
+ // GET_SECTIONS reply that races with Studio's async fetch.
111
+ UPDATE_SECTIONS_CATALOG: "update-sections-catalog",
64
112
  ADD_NEW_SYMBOL: "add-new-symbol",
113
+ // SDK → Parent (request/response): the editor asks Studio for the
114
+ // per-composition editor context once its own listeners are mounted. A pull,
115
+ // so it never races Studio's init timing. Returns `{ allowPinData }`.
116
+ GET_EDIT_CONTEXT: "get-edit-context",
117
+ // Parent → SDK: live update of the editor context when it changes mid-session
118
+ // (e.g. the Freeform plan is toggled). The listener is already registered by
119
+ // then, so no init race. Carries `allowPinData` — whether the pinning
120
+ // affordances (empty-canvas WelcomeState copy, etc.) should show.
121
+ SET_EDIT_CONTEXT: "set-edit-context",
65
122
  HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification",
66
123
  CONTEXT_MENU: "context-menu",
67
124
  GET_NODE_SCREENSHOT: "get-node-screenshot",
68
125
  URL_CHANGE: "url-change",
69
126
  };
127
+ /**
128
+ * Which data options the empty-canvas WelcomeState step 2 offers for the edited
129
+ * composition. Computed by Studio, carried in the `GET_EDIT_CONTEXT` /
130
+ * `SET_EDIT_CONTEXT` payloads (composable-studio ADR 0008). String values are
131
+ * the wire format — do not change them without a coordinated release.
132
+ */
133
+ var DataStepMode;
134
+ (function (DataStepMode) {
135
+ /** Freeform page — pin data only, no schema to connect. */
136
+ DataStepMode["PinOnly"] = "pin-only";
137
+ /** Schema-based comp (linked page or section) with the Freeform plan on. */
138
+ DataStepMode["SchemaOrPin"] = "schema-or-pin";
139
+ /** Schema-based comp with the Freeform plan off. */
140
+ DataStepMode["SchemaOnly"] = "schema-only";
141
+ })(DataStepMode || (DataStepMode = {}));
70
142
  const VISUAL_BUILDER_POST_MESSAGE_EVENTS = {
71
143
  // From visual builder to composable client
72
144
  REFETCH_SPEC: "refetch-spec",
@@ -80,5 +152,5 @@ const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS = {
80
152
  };
81
153
  const IS_BROWSER = typeof window !== "undefined";
82
154
 
83
- export { COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS, COMPOSABLE_STUDIO_CHANNEL_ID, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, COMPOSABLE_STUDIO_QUERY_PARAM, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS };
155
+ export { COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS, COMPOSABLE_STUDIO_CHANNEL_ID, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, COMPOSABLE_STUDIO_QUERY_PARAM, DataStepMode, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS };
84
156
  //# sourceMappingURL=constant.js.map
@@ -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,qBAAqB,EAAE,oBAAoB;AAC3C,IAAA,cAAc,EAAE,mBAAmB;AACnC,IAAA,YAAY,EAAE,MAAM;AACpB;;;;AAIG;AACH,IAAA,iBAAiB,EAAE,cAAc;AACjC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,cAAc,EAAE,SAAS;;AAGpB,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;AAC9C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,sBAAsB,EAAE,wBAAwB;AAChD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,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,sBAAsB,EAAE,wBAAwB;AAChD,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;;AAEtC,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;AACjE,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,6BAA6B,EAAE,+BAA+B;AAC9D,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,UAAU,EAAE,YAAY;;AAGnB,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;;;;"}
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;AAC9C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,IAAA,mBAAmB,EAAE,qBAAqB;AAC1C,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,sBAAsB,EAAE,wBAAwB;AAChD,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;AACjE,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,YAAY,EAAE,cAAc;;;;AAI5B,IAAA,uBAAuB,EAAE,yBAAyB;;;;;AAKlD,IAAA,uBAAuB,EAAE,yBAAyB;AAClD,IAAA,cAAc,EAAE,gBAAgB;;;;AAIhC,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;;;;"}
@@ -1,10 +1,13 @@
1
- import { EventManager } from '@contentstack/advanced-post-message';
2
- export { CompositionSavedEventData, GetNodeScreenshotEventData, GetNodeScreenshotResponseEventData, HiddenElementNotificationEventData, OpenComposableStudioFromStudioEventData, OpenComposableStudioFromVBEventData, PrimaryCompositionDetectedEventData } from '@contentstack/studio-message-types/latest';
1
+ import * as advancedPostMessage from '@contentstack/advanced-post-message';
2
+ export { CompositionResolutionDiagnosticEventData, CompositionSavedEventData, GetNodeScreenshotEventData, GetNodeScreenshotResponseEventData, HiddenElementNotificationEventData, OpenComposableStudioFromStudioEventData, OpenComposableStudioFromVBEventData, PrimaryCompositionDetectedEventData, ResolvedComposition, ShortlistedComposition } from '@contentstack/studio-message-types/latest';
3
+ export { CompositionQuery } from '@contentstack/studio-message-types/base';
3
4
 
4
- declare const composableStudioEventManager: EventManager | undefined;
5
- declare const composableStudioPopupEventManager: EventManager | undefined;
6
- declare const visualBuilderEventManager: EventManager | undefined;
7
- declare const composableStudioBuiltInCanvasEventManager: EventManager | undefined;
5
+ declare const EventManager: typeof advancedPostMessage.EventManager;
6
+ type EventManagerInstance = InstanceType<typeof EventManager>;
7
+ declare const composableStudioEventManager: EventManagerInstance | undefined;
8
+ declare const composableStudioPopupEventManager: EventManagerInstance | undefined;
9
+ declare const visualBuilderEventManager: EventManagerInstance | undefined;
10
+ declare const composableStudioBuiltInCanvasEventManager: EventManagerInstance | undefined;
8
11
 
9
12
  declare const COMPOSABLE_STUDIO_CHANNEL_ID = "composable-studio";
10
13
  declare const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID = "composable-studio-built-in-canvas";
@@ -13,7 +16,6 @@ declare const COMPOSABLE_STUDIO_POPUP_CHANNEL_ID = "composable-studio-popup";
13
16
  declare const VISUAL_BUILDER_CHANNEL_ID = "composable-client-visual-builder";
14
17
  declare const COMPOSABLE_STUDIO_QUERY_PARAM: {
15
18
  readonly ENABLED: "cs-composable-studio";
16
- readonly COMPOSITION_ENTRY_UID: "cs-composition-uid";
17
19
  readonly COMPOSABLE_UID: "cs-composable-uid";
18
20
  readonly PREVIEW_HASH: "hash";
19
21
  /**
@@ -22,9 +24,32 @@ declare const COMPOSABLE_STUDIO_QUERY_PARAM: {
22
24
  * So we need to handle both the cases.
23
25
  */
24
26
  readonly LIVE_PREVIEW_HASH: "live_preview";
25
- readonly CONNECTED_CONTENT_TYPE: "connected-content-type";
26
- readonly DYNAMIC_URL: "dynamic-url";
27
27
  readonly VISUAL_BUILDER: "builder";
28
+ /**
29
+ * When Studio renders the iframe and the user has explicitly picked an
30
+ * entry from the navbar, Studio appends this param so the SDK (running
31
+ * inside Studio) can prefer it over a host-passed `templateEntryUid`.
32
+ *
33
+ * Only honored when the SDK detects it is running inside Studio (via
34
+ * `ENABLED`). Outside Studio it is ignored.
35
+ */
36
+ readonly TEMPLATE_ENTRY_UID: "cs-template-entry-uid";
37
+ /**
38
+ * Locale Studio wants the SDK to render in. Set by Studio when its canvas
39
+ * URL carries `?locale=...`. The SDK overrides its own `config.locale`
40
+ * with this value so all SDK-side data fetches (initial + linked entries)
41
+ * use the right locale, and so the postmessages back to Studio
42
+ * (INIT_STUDIO.globalLocale, GET_COMPOSITION_SPEC.locale) carry it too.
43
+ *
44
+ * Only honored when the SDK detects it is running inside Studio (via
45
+ * `ENABLED`). Outside Studio it is ignored.
46
+ */
47
+ readonly LOCALE: "cs-locale";
48
+ /**
49
+ * Variant alias Studio wants the SDK to render in. Same flow as `LOCALE`
50
+ * but for variant. Set by Studio when its canvas URL carries `?variant=...`.
51
+ */
52
+ readonly VARIANT_ALIAS: "cs-variant-alias";
28
53
  };
29
54
  declare const POST_MESSAGE_EVENTS: {
30
55
  readonly INIT_STUDIO: "init-studio";
@@ -39,6 +64,7 @@ declare const POST_MESSAGE_EVENTS: {
39
64
  readonly REGISTER_DESIGN_CLASSES: "register-design-classes";
40
65
  readonly VALIDATE_PROP_VALUE: "validate-prop-value";
41
66
  readonly GET_COMPONENT_PROPS: "get-component-props";
67
+ readonly GET_SLOT_COMPONENT_PROPS: "get-slot-component-props";
42
68
  readonly UPDATE_DATA_SOURCE: "update-data-source";
43
69
  readonly UPDATE_SPEC_DATA: "update-spec-data";
44
70
  readonly UPDATE_STATIC_VALUE: "update-static-value";
@@ -56,7 +82,9 @@ declare const POST_MESSAGE_EVENTS: {
56
82
  readonly GET_STUDIO_INTELLIGENCE: "get-studio-intelligence";
57
83
  readonly IFRAME_STUDIO_CONTEXT: "iframe-studio-context";
58
84
  readonly SDK_SPEC_RESOLVED: "sdk-spec-resolved";
85
+ readonly SDK_DIAGNOSTICS: "sdk-diagnostics";
59
86
  readonly SDK_INITIALIZED: "sdk-initialized";
87
+ readonly LISTENERS_READY: "listeners-ready";
60
88
  readonly REPLACE_PREVIEW_ENTRY: "replace-preview-entry";
61
89
  readonly CHANGE_ACTIVE_STYLE_SECTION: "change-active-style-section";
62
90
  readonly CHANGE_STYLE_SECTION: "change-style-section";
@@ -65,12 +93,32 @@ declare const POST_MESSAGE_EVENTS: {
65
93
  readonly UPDATE_BINDING_ERRORS: "update-binding-errors";
66
94
  readonly OPEN_IN_COMPOSABLE_STUDIO_EVENT_MESSAGE: "open-composable-studio";
67
95
  readonly UPDATE_SYMBOLS: "update-symbols";
96
+ readonly GET_SYMBOLS: "get-symbols";
97
+ readonly GET_SECTIONS: "get-sections";
98
+ readonly UPDATE_SECTION_CONTEXTS: "update-section-contexts";
99
+ readonly UPDATE_SECTIONS_CATALOG: "update-sections-catalog";
68
100
  readonly ADD_NEW_SYMBOL: "add-new-symbol";
101
+ readonly GET_EDIT_CONTEXT: "get-edit-context";
102
+ readonly SET_EDIT_CONTEXT: "set-edit-context";
69
103
  readonly HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification";
70
104
  readonly CONTEXT_MENU: "context-menu";
71
105
  readonly GET_NODE_SCREENSHOT: "get-node-screenshot";
72
106
  readonly URL_CHANGE: "url-change";
73
107
  };
108
+ /**
109
+ * Which data options the empty-canvas WelcomeState step 2 offers for the edited
110
+ * composition. Computed by Studio, carried in the `GET_EDIT_CONTEXT` /
111
+ * `SET_EDIT_CONTEXT` payloads (composable-studio ADR 0008). String values are
112
+ * the wire format — do not change them without a coordinated release.
113
+ */
114
+ declare enum DataStepMode {
115
+ /** Freeform page — pin data only, no schema to connect. */
116
+ PinOnly = "pin-only",
117
+ /** Schema-based comp (linked page or section) with the Freeform plan on. */
118
+ SchemaOrPin = "schema-or-pin",
119
+ /** Schema-based comp with the Freeform plan off. */
120
+ SchemaOnly = "schema-only"
121
+ }
74
122
  declare const VISUAL_BUILDER_POST_MESSAGE_EVENTS: {
75
123
  readonly REFETCH_SPEC: "refetch-spec";
76
124
  readonly COMPOSITION_SAVED: "composition-saved";
@@ -87,20 +135,15 @@ type ComposableStudioQueryParams = {
87
135
  [key in ComposableStudioQueryParamsKeys]: string;
88
136
  };
89
137
 
90
- type CompositionQuery = {
91
- composableUid: string;
92
- } | {
138
+ type CompositionQueryInput = {
93
139
  /**
94
- * IMPORTANT: If you only pass the URL without the composable UID,
95
- * we will still fetch the composition. However, it will be slower
96
- * as we will have to process all the compositions.
140
+ * Passing only the composition UID is the fastest way to fetch the composition.
141
+ * It is useful for the freeform templates.
142
+ *
143
+ * However, if you only pass the composition UID, you should also pass the
144
+ * `templateEntryUid` to fetch the correct entry from the connected content type.
145
+ * Otherwise, we will fetch the first entry of the connected content type.
97
146
  */
98
- url: string;
99
- } | {
100
- composableUid: string;
101
- url: string;
102
- };
103
- type CompositionQueryInput = {
104
147
  compositionUid: string;
105
148
  } | {
106
149
  /**
@@ -112,11 +155,27 @@ type CompositionQueryInput = {
112
155
  } | {
113
156
  compositionUid: string;
114
157
  url: string;
158
+ } | {
159
+ url: string;
160
+ /**
161
+ * It is the Content type UID of the connected content type.
162
+ */
163
+ templateContentTypeUid: string;
164
+ } | {
165
+ /**
166
+ * It is the Content type UID of the connected content type.
167
+ *
168
+ * If you only pass the template content type UID, you should also pass the
169
+ * `templateEntryUid` to fetch the correct entry from the connected content type.
170
+ * Otherwise, we will fetch the first entry of the connected content type.
171
+ * first entry of the connected content type for the linked templates.
172
+ */
173
+ templateContentTypeUid: string;
115
174
  };
116
175
 
117
176
  type BuiltInCanvasConfig = {
118
177
  compositionContentTypeUid: string;
119
178
  };
120
179
 
121
- export { COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS, COMPOSABLE_STUDIO_CHANNEL_ID, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, COMPOSABLE_STUDIO_QUERY_PARAM, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS, composableStudioBuiltInCanvasEventManager, composableStudioEventManager, composableStudioPopupEventManager, visualBuilderEventManager };
122
- export type { BuiltInCanvasConfig, ComposableStudioQueryParams, ComposableStudioQueryParamsKeys, CompositionQuery, CompositionQueryInput };
180
+ export { COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS, COMPOSABLE_STUDIO_CHANNEL_ID, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, COMPOSABLE_STUDIO_QUERY_PARAM, DataStepMode, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS, composableStudioBuiltInCanvasEventManager, composableStudioEventManager, composableStudioPopupEventManager, visualBuilderEventManager };
181
+ export type { BuiltInCanvasConfig, ComposableStudioQueryParams, ComposableStudioQueryParamsKeys, CompositionQueryInput };
package/dist/esm/index.js CHANGED
@@ -1,3 +1,3 @@
1
1
  export { composableStudioBuiltInCanvasEventManager, composableStudioEventManager, composableStudioPopupEventManager, visualBuilderEventManager } from './main.js';
2
- export { COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS, COMPOSABLE_STUDIO_CHANNEL_ID, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, COMPOSABLE_STUDIO_QUERY_PARAM, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS } from './constant.js';
2
+ export { COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID, COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS, COMPOSABLE_STUDIO_CHANNEL_ID, COMPOSABLE_STUDIO_POPUP_CHANNEL_ID, COMPOSABLE_STUDIO_QUERY_PARAM, DataStepMode, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS } from './constant.js';
3
3
  //# sourceMappingURL=index.js.map
package/dist/esm/main.js CHANGED
@@ -1,6 +1,11 @@
1
- import { EventManager } from '@contentstack/advanced-post-message';
1
+ import * as advancedPostMessage from '@contentstack/advanced-post-message';
2
2
  import { 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';
3
3
 
4
+ const apmModule = advancedPostMessage;
5
+ const EventManager = apmModule.EventManager ?? apmModule.default?.EventManager;
6
+ if (!EventManager) {
7
+ throw new Error("studio-messenger: EventManager missing from @contentstack/advanced-post-message");
8
+ }
4
9
  const getEventManager = (channelId) => {
5
10
  if (!IS_BROWSER) {
6
11
  return undefined;
@@ -9,6 +14,8 @@ const getEventManager = (channelId) => {
9
14
  window.__csMessengerListeners__ = {};
10
15
  }
11
16
  if (!window.__csMessengerListeners__[channelId]) {
17
+ // Cache one EventManager per channel so repeated imports/mounts reuse the
18
+ // same postMessage bridge instead of creating duplicate listeners.
12
19
  window.__csMessengerListeners__[channelId] = new EventManager(channelId, {
13
20
  target: window.parent,
14
21
  debug: false,
@@ -1 +1 @@
1
- {"version":3,"file":"main.js","sources":["../../src/main.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AASA,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;QAC/C,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;AAC5C;AACA,eAAe,CAAC,kCAAkC;MACvC,yBAAyB;AACpC;AACA,eAAe,CAAC,yBAAyB;MAC9B,yCAAyC;AAGpD;AACA,eAAe,CAAC,4CAA4C;;;;"}
1
+ {"version":3,"file":"main.js","sources":["../../src/main.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAkBA,MAAM,SAAS,GAAG,mBAAgD;AAClE,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,YAAY;AAE9E,IAAI,CAAC,YAAY,EAAE;AACjB,IAAA,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF;AACH;AAIA,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;;;QAG/C,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;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contentstack/studio-messenger",
3
- "version": "1.4.0",
3
+ "version": "1.5.1",
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",
@@ -40,7 +40,7 @@
40
40
  "url": "https://github.com/contentstack/composable-studio-sdk/issues"
41
41
  },
42
42
  "devDependencies": {
43
- "@contentstack/common-config": "^1.1.8",
43
+ "@contentstack/common-config": "^1.2.1",
44
44
  "@rollup/plugin-commonjs": "^28.0.6",
45
45
  "@rollup/plugin-node-resolve": "^16.0.1",
46
46
  "@rollup/plugin-terser": "^1.0.0",
@@ -52,11 +52,8 @@
52
52
  "typescript": "^5.5.4"
53
53
  },
54
54
  "dependencies": {
55
- "@contentstack/advanced-post-message": "^0.0.2",
56
- "@contentstack/studio-message-types": "^1.2.2"
55
+ "@contentstack/advanced-post-message": "^0.0.5",
56
+ "@contentstack/studio-message-types": "^1.3.1"
57
57
  },
58
- "publishConfig": {
59
- "access": "public"
60
- },
61
- "gitHead": "1877b45f4a73ffb0c570ea06c197ba95504c014a"
58
+ "gitHead": "27539dc404d9358c9aa334ccbe6cd98e0405c205"
62
59
  }