@contentstack/studio-messenger 3.1.1 → 3.2.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.
- package/dist/cjs/index.cjs +47 -5
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/constant.d.ts +136 -0
- package/dist/esm/constant.js +14 -1
- package/dist/esm/constant.js.map +1 -1
- package/dist/esm/index.d.ts +30 -4
- package/dist/esm/index.js +2 -2
- package/dist/esm/main.js +34 -7
- package/dist/esm/main.js.map +1 -1
- package/dist/esm/type.d.ts +44 -0
- package/package.json +23 -3
package/dist/cjs/index.cjs
CHANGED
|
@@ -69,6 +69,10 @@ const POST_MESSAGE_EVENTS = {
|
|
|
69
69
|
SET_FOCUSED_NODE: "set-focused-node",
|
|
70
70
|
SET_ACTIVE_NODE: "set-active-node",
|
|
71
71
|
REMOVE_HIGHLIGHT_NODE: "remove-highlight-node",
|
|
72
|
+
/** Studio → canvas: scroll so the author can see a node they picked in Layers. */
|
|
73
|
+
REVEAL_NODE: "reveal-node",
|
|
74
|
+
/** Canvas → Studio: which node it actually scrolled to, and why it missed. */
|
|
75
|
+
REVEAL_RESULT: "reveal-result",
|
|
72
76
|
TRANSFORM_OPERATION: "transform-operation",
|
|
73
77
|
REGISTER_COMPONENTS: "register-components",
|
|
74
78
|
// Iframe → Studio: the app's registered studio-function NAMES (BYOS custom
|
|
@@ -194,12 +198,33 @@ const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS = {
|
|
|
194
198
|
REQUEST_FOR_COMPOSITION_CONFIG: "request-for-composition-config",
|
|
195
199
|
};
|
|
196
200
|
const IS_BROWSER = typeof window !== "undefined";
|
|
201
|
+
/**
|
|
202
|
+
* Transport error code the peer returns when it received the request but has
|
|
203
|
+
* no handler registered for that event.
|
|
204
|
+
*
|
|
205
|
+
* Mirrors `ERROR_CODES.receiveEvent.noRequestListenerFound` in
|
|
206
|
+
* `@contentstack/advanced-post-message`, which does not re-export its
|
|
207
|
+
* constants from the package root.
|
|
208
|
+
*/
|
|
209
|
+
const NO_REQUEST_LISTENER_ERROR_CODE = "NO_REQUEST_LISTENER_FOUND";
|
|
197
210
|
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
211
|
+
// Resolved on first use rather than at import. Resolving (and throwing) at
|
|
212
|
+
// module scope made this module observably side-effecting, so a bundler could
|
|
213
|
+
// never drop it — which put the whole postMessage bridge into the bundle of
|
|
214
|
+
// every site that merely renders a composition, even though the bridge only
|
|
215
|
+
// does anything inside the Studio canvas iframe.
|
|
216
|
+
let cachedEventManagerCtor;
|
|
217
|
+
const resolveEventManagerCtor = () => {
|
|
218
|
+
if (!cachedEventManagerCtor) {
|
|
219
|
+
const apmModule = advancedPostMessage__namespace;
|
|
220
|
+
const ctor = apmModule.EventManager ?? apmModule.default?.EventManager;
|
|
221
|
+
if (!ctor) {
|
|
222
|
+
throw new Error("studio-messenger: EventManager missing from @contentstack/advanced-post-message");
|
|
223
|
+
}
|
|
224
|
+
cachedEventManagerCtor = ctor;
|
|
225
|
+
}
|
|
226
|
+
return cachedEventManagerCtor;
|
|
227
|
+
};
|
|
203
228
|
const getEventManager = (channelId) => {
|
|
204
229
|
if (!IS_BROWSER) {
|
|
205
230
|
return undefined;
|
|
@@ -210,6 +235,7 @@ const getEventManager = (channelId) => {
|
|
|
210
235
|
if (!window.__csMessengerListeners__[channelId]) {
|
|
211
236
|
// Cache one EventManager per channel so repeated imports/mounts reuse the
|
|
212
237
|
// same postMessage bridge instead of creating duplicate listeners.
|
|
238
|
+
const EventManager = resolveEventManagerCtor();
|
|
213
239
|
window.__csMessengerListeners__[channelId] = new EventManager(channelId, {
|
|
214
240
|
target: window.parent,
|
|
215
241
|
debug: false,
|
|
@@ -230,6 +256,20 @@ getEventManager(VISUAL_BUILDER_CHANNEL_ID);
|
|
|
230
256
|
const composableStudioBuiltInCanvasEventManager =
|
|
231
257
|
/*#__PURE__*/
|
|
232
258
|
getEventManager(COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID);
|
|
259
|
+
/**
|
|
260
|
+
* True when a `send` rejected because the peer has no handler for that event.
|
|
261
|
+
*
|
|
262
|
+
* The transport answers an unhandled request with this code instead of timing
|
|
263
|
+
* out, and the receiving side logs it at debug level — it means "the peer does
|
|
264
|
+
* not implement this event", not "the message failed". Senders of an event
|
|
265
|
+
* whose counterpart is not built yet use this to avoid reporting the expected
|
|
266
|
+
* steady state as an error.
|
|
267
|
+
*/
|
|
268
|
+
function isNoRequestListenerError(error) {
|
|
269
|
+
return (typeof error === "object" &&
|
|
270
|
+
error !== null &&
|
|
271
|
+
error.code === NO_REQUEST_LISTENER_ERROR_CODE);
|
|
272
|
+
}
|
|
233
273
|
|
|
234
274
|
exports.COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID = COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID;
|
|
235
275
|
exports.COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS = COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS;
|
|
@@ -238,11 +278,13 @@ exports.COMPOSABLE_STUDIO_POPUP_CHANNEL_ID = COMPOSABLE_STUDIO_POPUP_CHANNEL_ID;
|
|
|
238
278
|
exports.COMPOSABLE_STUDIO_QUERY_PARAM = COMPOSABLE_STUDIO_QUERY_PARAM;
|
|
239
279
|
exports.IS_BROWSER = IS_BROWSER;
|
|
240
280
|
exports.LIVE_EDITOR_CHANNEL_ID = LIVE_EDITOR_CHANNEL_ID;
|
|
281
|
+
exports.NO_REQUEST_LISTENER_ERROR_CODE = NO_REQUEST_LISTENER_ERROR_CODE;
|
|
241
282
|
exports.POST_MESSAGE_EVENTS = POST_MESSAGE_EVENTS;
|
|
242
283
|
exports.VISUAL_BUILDER_CHANNEL_ID = VISUAL_BUILDER_CHANNEL_ID;
|
|
243
284
|
exports.VISUAL_BUILDER_POST_MESSAGE_EVENTS = VISUAL_BUILDER_POST_MESSAGE_EVENTS;
|
|
244
285
|
exports.composableStudioBuiltInCanvasEventManager = composableStudioBuiltInCanvasEventManager;
|
|
245
286
|
exports.composableStudioEventManager = composableStudioEventManager;
|
|
246
287
|
exports.composableStudioPopupEventManager = composableStudioPopupEventManager;
|
|
288
|
+
exports.isNoRequestListenerError = isNoRequestListenerError;
|
|
247
289
|
exports.visualBuilderEventManager = visualBuilderEventManager;
|
|
248
290
|
//# sourceMappingURL=index.cjs.map
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -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;
|
|
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;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
declare const COMPOSABLE_STUDIO_CHANNEL_ID = "composable-studio";
|
|
2
|
+
declare const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID = "composable-studio-built-in-canvas";
|
|
3
|
+
declare const LIVE_EDITOR_CHANNEL_ID = "live-editor";
|
|
4
|
+
declare const COMPOSABLE_STUDIO_POPUP_CHANNEL_ID = "composable-studio-popup";
|
|
5
|
+
declare const VISUAL_BUILDER_CHANNEL_ID = "composable-client-visual-builder";
|
|
6
|
+
declare const COMPOSABLE_STUDIO_QUERY_PARAM: {
|
|
7
|
+
readonly ENABLED: "cs-composable-studio";
|
|
8
|
+
readonly COMPOSABLE_UID: "cs-composable-uid";
|
|
9
|
+
readonly PREVIEW_HASH: "hash";
|
|
10
|
+
/**
|
|
11
|
+
* This hash is same as the PREVIEW_HASH.
|
|
12
|
+
* In the Live preview panel, we receive the hash as live_preview.
|
|
13
|
+
* So we need to handle both the cases.
|
|
14
|
+
*/
|
|
15
|
+
readonly LIVE_PREVIEW_HASH: "live_preview";
|
|
16
|
+
readonly 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
|
+
readonly 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
|
+
readonly 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
|
+
readonly VARIANT_ALIAS: "cs-variant-alias";
|
|
42
|
+
};
|
|
43
|
+
declare const POST_MESSAGE_EVENTS: {
|
|
44
|
+
readonly INIT_STUDIO: "init-studio";
|
|
45
|
+
readonly HIGHLIGHT_NODE: "highlight-node";
|
|
46
|
+
readonly SET_FOCUSED_NODE: "set-focused-node";
|
|
47
|
+
readonly SET_ACTIVE_NODE: "set-active-node";
|
|
48
|
+
readonly REMOVE_HIGHLIGHT_NODE: "remove-highlight-node";
|
|
49
|
+
/** Studio → canvas: scroll so the author can see a node they picked in Layers. */
|
|
50
|
+
readonly REVEAL_NODE: "reveal-node";
|
|
51
|
+
/** Canvas → Studio: which node it actually scrolled to, and why it missed. */
|
|
52
|
+
readonly REVEAL_RESULT: "reveal-result";
|
|
53
|
+
readonly TRANSFORM_OPERATION: "transform-operation";
|
|
54
|
+
readonly REGISTER_COMPONENTS: "register-components";
|
|
55
|
+
readonly REGISTER_STUDIO_FUNCTIONS: "register-studio-functions";
|
|
56
|
+
readonly GET_STUDIO_FUNCTIONS: "get-studio-functions";
|
|
57
|
+
readonly GET_STUDIO_STATE_VALUES: "get-studio-state-values";
|
|
58
|
+
readonly REGISTER_STUDIO_STATE_VALUES: "register-studio-state-values";
|
|
59
|
+
readonly GET_NODE_STYLE: "get-node-style";
|
|
60
|
+
readonly REGISTER_DESIGN_TOKENS: "register-design-tokens";
|
|
61
|
+
readonly REGISTER_DESIGN_CLASSES: "register-design-classes";
|
|
62
|
+
readonly VALIDATE_PROP_VALUE: "validate-prop-value";
|
|
63
|
+
readonly GET_COMPONENT_PROPS: "get-component-props";
|
|
64
|
+
readonly GET_SLOT_COMPONENT_PROPS: "get-slot-component-props";
|
|
65
|
+
readonly UPDATE_DATA_SOURCE: "update-data-source";
|
|
66
|
+
readonly UPDATE_SPEC_DATA: "update-spec-data";
|
|
67
|
+
readonly UPDATE_STATIC_VALUE: "update-static-value";
|
|
68
|
+
readonly MOUSE_DOWN: "mouse-down";
|
|
69
|
+
readonly MOUSE_UP: "mouse-up";
|
|
70
|
+
readonly MOUSE_MOVE: "mouse-move";
|
|
71
|
+
readonly PARENT_DRAG_START: "parent-drag-start";
|
|
72
|
+
readonly PARENT_DRAG_END: "parent-drag-end";
|
|
73
|
+
readonly APPLY_OPERATION: "apply-operation";
|
|
74
|
+
readonly GET_ACTIVE_BREAKPOINT: "get-active-breakpoint";
|
|
75
|
+
readonly REGISTER_BREAKPOINTS: "register-breakpoints";
|
|
76
|
+
readonly SET_CURSOR_TYPE: "set-cursor-type";
|
|
77
|
+
readonly GET_COMPOSITION_SPEC: "get-composition-spec";
|
|
78
|
+
readonly GET_STUDIO_INTELLIGENCE: "get-studio-intelligence";
|
|
79
|
+
readonly IFRAME_STUDIO_CONTEXT: "iframe-studio-context";
|
|
80
|
+
readonly SDK_SPEC_RESOLVED: "sdk-spec-resolved";
|
|
81
|
+
readonly SDK_DIAGNOSTICS: "sdk-diagnostics";
|
|
82
|
+
readonly SDK_INITIALIZED: "sdk-initialized";
|
|
83
|
+
readonly LISTENERS_READY: "listeners-ready";
|
|
84
|
+
readonly REPLACE_PREVIEW_ENTRY: "replace-preview-entry";
|
|
85
|
+
readonly CHANGE_ACTIVE_STYLE_SECTION: "change-active-style-section";
|
|
86
|
+
readonly CHANGE_STYLE_SECTION: "change-style-section";
|
|
87
|
+
readonly HIGHLIGHT_SLOT_NODE: "highlight-slot-node";
|
|
88
|
+
readonly SET_ACTIVE_SLOT_UID: "set-active-slot-uid";
|
|
89
|
+
readonly UPDATE_BINDING_ERRORS: "update-binding-errors";
|
|
90
|
+
readonly OPEN_IN_COMPOSABLE_STUDIO_EVENT_MESSAGE: "open-composable-studio";
|
|
91
|
+
readonly OPEN_SECTION_SLOT_PICKER: "open-section-slot-picker";
|
|
92
|
+
readonly GET_SECTIONS: "get-sections";
|
|
93
|
+
readonly UPDATE_SECTION_CONTEXTS: "update-section-contexts";
|
|
94
|
+
readonly UPDATE_SECTIONS_CATALOG: "update-sections-catalog";
|
|
95
|
+
readonly GET_EDIT_CONTEXT: "get-edit-context";
|
|
96
|
+
readonly SET_EDIT_CONTEXT: "set-edit-context";
|
|
97
|
+
readonly HIDDEN_COMPONENT_NOTIFICATION: "hidden-component-notification";
|
|
98
|
+
readonly CONTEXT_MENU: "context-menu";
|
|
99
|
+
readonly GET_NODE_SCREENSHOT: "get-node-screenshot";
|
|
100
|
+
readonly URL_CHANGE: "url-change";
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* Which data options the empty-canvas WelcomeState step 2 offers for the edited
|
|
104
|
+
* composition. Computed by Studio, carried in the `GET_EDIT_CONTEXT` /
|
|
105
|
+
* `SET_EDIT_CONTEXT` payloads (composable-studio ADR 0008). String values are
|
|
106
|
+
* the wire format — do not change them without a coordinated release.
|
|
107
|
+
*/
|
|
108
|
+
declare enum DataStepMode {
|
|
109
|
+
/** Freeform page — pin data only, no schema to connect. */
|
|
110
|
+
PinOnly = "pin-only",
|
|
111
|
+
/** Schema-based comp (linked page or section) with the Freeform plan on. */
|
|
112
|
+
SchemaOrPin = "schema-or-pin",
|
|
113
|
+
/** Schema-based comp with the Freeform plan off. */
|
|
114
|
+
SchemaOnly = "schema-only"
|
|
115
|
+
}
|
|
116
|
+
declare const VISUAL_BUILDER_POST_MESSAGE_EVENTS: {
|
|
117
|
+
readonly REFETCH_SPEC: "refetch-spec";
|
|
118
|
+
readonly COMPOSITION_SAVED: "composition-saved";
|
|
119
|
+
readonly OPEN_IN_COMPOSABLE_STUDIO_EVENT_MESSAGE: "open-composable-studio";
|
|
120
|
+
readonly PRIMARY_COMPOSITION_DETECTED: "primary-composition-detected";
|
|
121
|
+
};
|
|
122
|
+
declare const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS: {
|
|
123
|
+
readonly REQUEST_FOR_COMPOSITION_CONFIG: "request-for-composition-config";
|
|
124
|
+
};
|
|
125
|
+
declare const IS_BROWSER: boolean;
|
|
126
|
+
/**
|
|
127
|
+
* Transport error code the peer returns when it received the request but has
|
|
128
|
+
* no handler registered for that event.
|
|
129
|
+
*
|
|
130
|
+
* Mirrors `ERROR_CODES.receiveEvent.noRequestListenerFound` in
|
|
131
|
+
* `@contentstack/advanced-post-message`, which does not re-export its
|
|
132
|
+
* constants from the package root.
|
|
133
|
+
*/
|
|
134
|
+
declare const NO_REQUEST_LISTENER_ERROR_CODE = "NO_REQUEST_LISTENER_FOUND";
|
|
135
|
+
|
|
136
|
+
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, NO_REQUEST_LISTENER_ERROR_CODE, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS };
|
package/dist/esm/constant.js
CHANGED
|
@@ -46,6 +46,10 @@ const POST_MESSAGE_EVENTS = {
|
|
|
46
46
|
SET_FOCUSED_NODE: "set-focused-node",
|
|
47
47
|
SET_ACTIVE_NODE: "set-active-node",
|
|
48
48
|
REMOVE_HIGHLIGHT_NODE: "remove-highlight-node",
|
|
49
|
+
/** Studio → canvas: scroll so the author can see a node they picked in Layers. */
|
|
50
|
+
REVEAL_NODE: "reveal-node",
|
|
51
|
+
/** Canvas → Studio: which node it actually scrolled to, and why it missed. */
|
|
52
|
+
REVEAL_RESULT: "reveal-result",
|
|
49
53
|
TRANSFORM_OPERATION: "transform-operation",
|
|
50
54
|
REGISTER_COMPONENTS: "register-components",
|
|
51
55
|
// Iframe → Studio: the app's registered studio-function NAMES (BYOS custom
|
|
@@ -171,6 +175,15 @@ const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS = {
|
|
|
171
175
|
REQUEST_FOR_COMPOSITION_CONFIG: "request-for-composition-config",
|
|
172
176
|
};
|
|
173
177
|
const IS_BROWSER = typeof window !== "undefined";
|
|
178
|
+
/**
|
|
179
|
+
* Transport error code the peer returns when it received the request but has
|
|
180
|
+
* no handler registered for that event.
|
|
181
|
+
*
|
|
182
|
+
* Mirrors `ERROR_CODES.receiveEvent.noRequestListenerFound` in
|
|
183
|
+
* `@contentstack/advanced-post-message`, which does not re-export its
|
|
184
|
+
* constants from the package root.
|
|
185
|
+
*/
|
|
186
|
+
const NO_REQUEST_LISTENER_ERROR_CODE = "NO_REQUEST_LISTENER_FOUND";
|
|
174
187
|
|
|
175
|
-
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 };
|
|
188
|
+
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, NO_REQUEST_LISTENER_ERROR_CODE, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS };
|
|
176
189
|
//# sourceMappingURL=constant.js.map
|
package/dist/esm/constant.js.map
CHANGED
|
@@ -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;
|
|
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;;;;"}
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,13 +1,26 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _contentstack_advanced_post_message from '@contentstack/advanced-post-message';
|
|
2
2
|
export { CompositionResolutionDiagnosticEventData, CompositionSavedEventData, GetNodeScreenshotEventData, GetNodeScreenshotResponseEventData, HiddenElementNotificationEventData, OpenComposableStudioFromStudioEventData, OpenComposableStudioFromVBEventData, PrimaryCompositionDetectedEventData, ResolvedComposition, ShortlistedComposition } from '@contentstack/studio-message-types/latest';
|
|
3
3
|
export { CompositionQuery } from '@contentstack/studio-message-types/base';
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
type AdvancedPostMessageModule = typeof _contentstack_advanced_post_message & {
|
|
6
|
+
default?: typeof _contentstack_advanced_post_message;
|
|
7
|
+
};
|
|
8
|
+
type EventManagerCtor = NonNullable<AdvancedPostMessageModule["EventManager"]>;
|
|
9
|
+
type EventManagerInstance = InstanceType<EventManagerCtor>;
|
|
7
10
|
declare const composableStudioEventManager: EventManagerInstance | undefined;
|
|
8
11
|
declare const composableStudioPopupEventManager: EventManagerInstance | undefined;
|
|
9
12
|
declare const visualBuilderEventManager: EventManagerInstance | undefined;
|
|
10
13
|
declare const composableStudioBuiltInCanvasEventManager: EventManagerInstance | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* True when a `send` rejected because the peer has no handler for that event.
|
|
16
|
+
*
|
|
17
|
+
* The transport answers an unhandled request with this code instead of timing
|
|
18
|
+
* out, and the receiving side logs it at debug level — it means "the peer does
|
|
19
|
+
* not implement this event", not "the message failed". Senders of an event
|
|
20
|
+
* whose counterpart is not built yet use this to avoid reporting the expected
|
|
21
|
+
* steady state as an error.
|
|
22
|
+
*/
|
|
23
|
+
declare function isNoRequestListenerError(error: unknown): boolean;
|
|
11
24
|
|
|
12
25
|
declare const COMPOSABLE_STUDIO_CHANNEL_ID = "composable-studio";
|
|
13
26
|
declare const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID = "composable-studio-built-in-canvas";
|
|
@@ -57,6 +70,10 @@ declare const POST_MESSAGE_EVENTS: {
|
|
|
57
70
|
readonly SET_FOCUSED_NODE: "set-focused-node";
|
|
58
71
|
readonly SET_ACTIVE_NODE: "set-active-node";
|
|
59
72
|
readonly REMOVE_HIGHLIGHT_NODE: "remove-highlight-node";
|
|
73
|
+
/** Studio → canvas: scroll so the author can see a node they picked in Layers. */
|
|
74
|
+
readonly REVEAL_NODE: "reveal-node";
|
|
75
|
+
/** Canvas → Studio: which node it actually scrolled to, and why it missed. */
|
|
76
|
+
readonly REVEAL_RESULT: "reveal-result";
|
|
60
77
|
readonly TRANSFORM_OPERATION: "transform-operation";
|
|
61
78
|
readonly REGISTER_COMPONENTS: "register-components";
|
|
62
79
|
readonly REGISTER_STUDIO_FUNCTIONS: "register-studio-functions";
|
|
@@ -130,6 +147,15 @@ declare const COMPOSABLE_STUDIO_BUILT_IN_CANVAS_POST_MESSAGE_EVENTS: {
|
|
|
130
147
|
readonly REQUEST_FOR_COMPOSITION_CONFIG: "request-for-composition-config";
|
|
131
148
|
};
|
|
132
149
|
declare const IS_BROWSER: boolean;
|
|
150
|
+
/**
|
|
151
|
+
* Transport error code the peer returns when it received the request but has
|
|
152
|
+
* no handler registered for that event.
|
|
153
|
+
*
|
|
154
|
+
* Mirrors `ERROR_CODES.receiveEvent.noRequestListenerFound` in
|
|
155
|
+
* `@contentstack/advanced-post-message`, which does not re-export its
|
|
156
|
+
* constants from the package root.
|
|
157
|
+
*/
|
|
158
|
+
declare const NO_REQUEST_LISTENER_ERROR_CODE = "NO_REQUEST_LISTENER_FOUND";
|
|
133
159
|
|
|
134
160
|
type ComposableStudioQueryParamsKeys = (typeof COMPOSABLE_STUDIO_QUERY_PARAM)[keyof typeof COMPOSABLE_STUDIO_QUERY_PARAM];
|
|
135
161
|
type ComposableStudioQueryParams = {
|
|
@@ -178,5 +204,5 @@ type BuiltInCanvasConfig = {
|
|
|
178
204
|
compositionContentTypeUid: string;
|
|
179
205
|
};
|
|
180
206
|
|
|
181
|
-
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 };
|
|
207
|
+
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, NO_REQUEST_LISTENER_ERROR_CODE, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS, composableStudioBuiltInCanvasEventManager, composableStudioEventManager, composableStudioPopupEventManager, isNoRequestListenerError, visualBuilderEventManager };
|
|
182
208
|
export type { BuiltInCanvasConfig, ComposableStudioQueryParams, ComposableStudioQueryParamsKeys, CompositionQueryInput };
|
package/dist/esm/index.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
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, DataStepMode, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, POST_MESSAGE_EVENTS, VISUAL_BUILDER_CHANNEL_ID, VISUAL_BUILDER_POST_MESSAGE_EVENTS } from './constant.js';
|
|
1
|
+
export { composableStudioBuiltInCanvasEventManager, composableStudioEventManager, composableStudioPopupEventManager, isNoRequestListenerError, 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, DataStepMode, IS_BROWSER, LIVE_EDITOR_CHANNEL_ID, NO_REQUEST_LISTENER_ERROR_CODE, 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,11 +1,23 @@
|
|
|
1
1
|
import * as advancedPostMessage from '@contentstack/advanced-post-message';
|
|
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';
|
|
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';
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
4
|
+
// Resolved on first use rather than at import. Resolving (and throwing) at
|
|
5
|
+
// module scope made this module observably side-effecting, so a bundler could
|
|
6
|
+
// never drop it — which put the whole postMessage bridge into the bundle of
|
|
7
|
+
// every site that merely renders a composition, even though the bridge only
|
|
8
|
+
// does anything inside the Studio canvas iframe.
|
|
9
|
+
let cachedEventManagerCtor;
|
|
10
|
+
const resolveEventManagerCtor = () => {
|
|
11
|
+
if (!cachedEventManagerCtor) {
|
|
12
|
+
const apmModule = advancedPostMessage;
|
|
13
|
+
const ctor = apmModule.EventManager ?? apmModule.default?.EventManager;
|
|
14
|
+
if (!ctor) {
|
|
15
|
+
throw new Error("studio-messenger: EventManager missing from @contentstack/advanced-post-message");
|
|
16
|
+
}
|
|
17
|
+
cachedEventManagerCtor = ctor;
|
|
18
|
+
}
|
|
19
|
+
return cachedEventManagerCtor;
|
|
20
|
+
};
|
|
9
21
|
const getEventManager = (channelId) => {
|
|
10
22
|
if (!IS_BROWSER) {
|
|
11
23
|
return undefined;
|
|
@@ -16,6 +28,7 @@ const getEventManager = (channelId) => {
|
|
|
16
28
|
if (!window.__csMessengerListeners__[channelId]) {
|
|
17
29
|
// Cache one EventManager per channel so repeated imports/mounts reuse the
|
|
18
30
|
// same postMessage bridge instead of creating duplicate listeners.
|
|
31
|
+
const EventManager = resolveEventManagerCtor();
|
|
19
32
|
window.__csMessengerListeners__[channelId] = new EventManager(channelId, {
|
|
20
33
|
target: window.parent,
|
|
21
34
|
debug: false,
|
|
@@ -36,6 +49,20 @@ getEventManager(VISUAL_BUILDER_CHANNEL_ID);
|
|
|
36
49
|
const composableStudioBuiltInCanvasEventManager =
|
|
37
50
|
/*#__PURE__*/
|
|
38
51
|
getEventManager(COMPOSABLE_STUDIO_BUILT_IN_CANVAS_CHANNEL_ID);
|
|
52
|
+
/**
|
|
53
|
+
* True when a `send` rejected because the peer has no handler for that event.
|
|
54
|
+
*
|
|
55
|
+
* The transport answers an unhandled request with this code instead of timing
|
|
56
|
+
* out, and the receiving side logs it at debug level — it means "the peer does
|
|
57
|
+
* not implement this event", not "the message failed". Senders of an event
|
|
58
|
+
* whose counterpart is not built yet use this to avoid reporting the expected
|
|
59
|
+
* steady state as an error.
|
|
60
|
+
*/
|
|
61
|
+
function isNoRequestListenerError(error) {
|
|
62
|
+
return (typeof error === "object" &&
|
|
63
|
+
error !== null &&
|
|
64
|
+
error.code === NO_REQUEST_LISTENER_ERROR_CODE);
|
|
65
|
+
}
|
|
39
66
|
|
|
40
|
-
export { composableStudioBuiltInCanvasEventManager, composableStudioEventManager, composableStudioPopupEventManager, visualBuilderEventManager };
|
|
67
|
+
export { composableStudioBuiltInCanvasEventManager, composableStudioEventManager, composableStudioPopupEventManager, isNoRequestListenerError, visualBuilderEventManager };
|
|
41
68
|
//# sourceMappingURL=main.js.map
|
package/dist/esm/main.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main.js","sources":["../../src/main.ts"],"sourcesContent":[null],"names":[],"mappings":";;;
|
|
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;;;;"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
declare const COMPOSABLE_STUDIO_QUERY_PARAM: {
|
|
2
|
+
readonly ENABLED: "cs-composable-studio";
|
|
3
|
+
readonly COMPOSABLE_UID: "cs-composable-uid";
|
|
4
|
+
readonly PREVIEW_HASH: "hash";
|
|
5
|
+
/**
|
|
6
|
+
* This hash is same as the PREVIEW_HASH.
|
|
7
|
+
* In the Live preview panel, we receive the hash as live_preview.
|
|
8
|
+
* So we need to handle both the cases.
|
|
9
|
+
*/
|
|
10
|
+
readonly LIVE_PREVIEW_HASH: "live_preview";
|
|
11
|
+
readonly VISUAL_BUILDER: "builder";
|
|
12
|
+
/**
|
|
13
|
+
* When Studio renders the iframe and the user has explicitly picked an
|
|
14
|
+
* entry from the navbar, Studio appends this param so the SDK (running
|
|
15
|
+
* inside Studio) can prefer it over a host-passed `templateEntryUid`.
|
|
16
|
+
*
|
|
17
|
+
* Only honored when the SDK detects it is running inside Studio (via
|
|
18
|
+
* `ENABLED`). Outside Studio it is ignored.
|
|
19
|
+
*/
|
|
20
|
+
readonly TEMPLATE_ENTRY_UID: "cs-template-entry-uid";
|
|
21
|
+
/**
|
|
22
|
+
* Locale Studio wants the SDK to render in. Set by Studio when its canvas
|
|
23
|
+
* URL carries `?locale=...`. The SDK overrides its own `config.locale`
|
|
24
|
+
* with this value so all SDK-side data fetches (initial + linked entries)
|
|
25
|
+
* use the right locale, and so the postmessages back to Studio
|
|
26
|
+
* (INIT_STUDIO.globalLocale, GET_COMPOSITION_SPEC.locale) carry it too.
|
|
27
|
+
*
|
|
28
|
+
* Only honored when the SDK detects it is running inside Studio (via
|
|
29
|
+
* `ENABLED`). Outside Studio it is ignored.
|
|
30
|
+
*/
|
|
31
|
+
readonly LOCALE: "cs-locale";
|
|
32
|
+
/**
|
|
33
|
+
* Variant alias Studio wants the SDK to render in. Same flow as `LOCALE`
|
|
34
|
+
* but for variant. Set by Studio when its canvas URL carries `?variant=...`.
|
|
35
|
+
*/
|
|
36
|
+
readonly VARIANT_ALIAS: "cs-variant-alias";
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
type ComposableStudioQueryParamsKeys = (typeof COMPOSABLE_STUDIO_QUERY_PARAM)[keyof typeof COMPOSABLE_STUDIO_QUERY_PARAM];
|
|
40
|
+
type ComposableStudioQueryParams = {
|
|
41
|
+
[key in ComposableStudioQueryParamsKeys]: string;
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
export type { ComposableStudioQueryParams, ComposableStudioQueryParamsKeys };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentstack/studio-messenger",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.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",
|
|
@@ -20,6 +20,26 @@
|
|
|
20
20
|
"types": "./dist/esm/index.d.ts",
|
|
21
21
|
"default": "./dist/cjs/index.cjs"
|
|
22
22
|
}
|
|
23
|
+
},
|
|
24
|
+
"./constants": {
|
|
25
|
+
"import": {
|
|
26
|
+
"types": "./dist/esm/constant.d.ts",
|
|
27
|
+
"default": "./dist/esm/constant.js"
|
|
28
|
+
},
|
|
29
|
+
"require": {
|
|
30
|
+
"types": "./dist/esm/constant.d.ts",
|
|
31
|
+
"default": "./dist/cjs/index.cjs"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"./types": {
|
|
35
|
+
"import": {
|
|
36
|
+
"types": "./dist/esm/type.d.ts",
|
|
37
|
+
"default": "./dist/esm/type.js"
|
|
38
|
+
},
|
|
39
|
+
"require": {
|
|
40
|
+
"types": "./dist/esm/type.d.ts",
|
|
41
|
+
"default": "./dist/cjs/index.cjs"
|
|
42
|
+
}
|
|
23
43
|
}
|
|
24
44
|
},
|
|
25
45
|
"files": [
|
|
@@ -40,7 +60,7 @@
|
|
|
40
60
|
"url": "https://github.com/contentstack/composable-studio-sdk/issues"
|
|
41
61
|
},
|
|
42
62
|
"devDependencies": {
|
|
43
|
-
"@contentstack/common-config": "^1.2.
|
|
63
|
+
"@contentstack/common-config": "^1.2.5",
|
|
44
64
|
"@rollup/plugin-commonjs": "^28.0.6",
|
|
45
65
|
"@rollup/plugin-node-resolve": "^16.0.1",
|
|
46
66
|
"@rollup/plugin-terser": "^1.0.0",
|
|
@@ -53,6 +73,6 @@
|
|
|
53
73
|
},
|
|
54
74
|
"dependencies": {
|
|
55
75
|
"@contentstack/advanced-post-message": "^0.0.5",
|
|
56
|
-
"@contentstack/studio-message-types": "^
|
|
76
|
+
"@contentstack/studio-message-types": "^2.0.0"
|
|
57
77
|
}
|
|
58
78
|
}
|