@contentstack/studio-client 4.1.0 → 4.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/breakpoints/BreakpointManager.js +3 -2
- package/dist/breakpoints/BreakpointManager.js.map +1 -1
- package/dist/breakpoints/breakpoint-origin.js +30 -0
- package/dist/breakpoints/breakpoint-origin.js.map +1 -0
- package/dist/canvas/canvas.type.js +1 -1
- package/dist/canvas/canvas.utils.js +165 -4
- package/dist/canvas/canvas.utils.js.map +1 -1
- package/dist/composable-studio/binding-defect-report.js +106 -0
- package/dist/composable-studio/binding-defect-report.js.map +1 -0
- package/dist/composable-studio/build-scoped-data.js +21 -11
- package/dist/composable-studio/build-scoped-data.js.map +1 -1
- package/dist/composable-studio/collect-data-needs.js +1 -1
- package/dist/composable-studio/data/pre-process-static-values.js +89 -19
- package/dist/composable-studio/data/pre-process-static-values.js.map +1 -1
- package/dist/composable-studio/delivery-setup-check.js +92 -0
- package/dist/composable-studio/delivery-setup-check.js.map +1 -0
- package/dist/composable-studio/resolution-failure-spec.js +53 -0
- package/dist/composable-studio/resolution-failure-spec.js.map +1 -0
- package/dist/composable-studio/resolution-telemetry.js +68 -0
- package/dist/composable-studio/resolution-telemetry.js.map +1 -0
- package/dist/composable-studio/sdk.js +683 -551
- package/dist/composable-studio/sdk.js.map +1 -1
- package/dist/composable-studio/section-binding/compute-all-section-auto-bindings.js +146 -0
- package/dist/composable-studio/section-binding/compute-all-section-auto-bindings.js.map +1 -0
- package/dist/composable-studio/section-binding/constants.js +27 -0
- package/dist/composable-studio/section-binding/constants.js.map +1 -0
- package/dist/composable-studio/section-binding/index.js +20 -0
- package/dist/composable-studio/section-binding/index.js.map +1 -0
- package/dist/composable-studio/section-binding/schema-path.js +112 -0
- package/dist/composable-studio/section-binding/schema-path.js.map +1 -0
- package/dist/composable-studio/section-binding/section-composition-auto-binding.js +815 -0
- package/dist/composable-studio/section-binding/section-composition-auto-binding.js.map +1 -0
- package/dist/composable-studio/section-binding/section-compositions.js +349 -0
- package/dist/composable-studio/section-binding/section-compositions.js.map +1 -0
- package/dist/composable-studio/section-binding/section-internal-ref-introspection.js +72 -0
- package/dist/composable-studio/section-binding/section-internal-ref-introspection.js.map +1 -0
- package/dist/composable-studio/section-binding/self-describe-section-bindings.js +132 -0
- package/dist/composable-studio/section-binding/self-describe-section-bindings.js.map +1 -0
- package/dist/composable-studio/section-binding/serialization.js +33 -0
- package/dist/composable-studio/section-binding/serialization.js.map +1 -0
- package/dist/composable-studio/section-data.js +5 -1
- package/dist/composable-studio/section-data.js.map +1 -1
- package/dist/composable-studio/setup-check-signal.js +48 -0
- package/dist/composable-studio/setup-check-signal.js.map +1 -0
- package/dist/composable-studio/studio-intelligence.manager.js +6 -2
- package/dist/composable-studio/studio-intelligence.manager.js.map +1 -1
- package/dist/config/config.schema.js +97 -104
- package/dist/config/config.schema.js.map +1 -1
- package/dist/config/process-user-config.js +41 -24
- package/dist/config/process-user-config.js.map +1 -1
- package/dist/config/stack-sdk-wrapper.js +22 -4
- package/dist/config/stack-sdk-wrapper.js.map +1 -1
- package/dist/context-menu/context-menu.js +1 -0
- package/dist/context-menu/context-menu.js.map +1 -1
- package/dist/dnd/dnd-manager.js +1 -0
- package/dist/dnd/dnd-manager.js.map +1 -1
- package/dist/editor.d.ts +34 -1
- package/dist/highlight-node/highlight-node-manager.js +89 -14
- package/dist/highlight-node/highlight-node-manager.js.map +1 -1
- package/dist/highlight-node/highlight-node.js +11 -5
- package/dist/highlight-node/highlight-node.js.map +1 -1
- package/dist/highlight-node/history-shortcut.js +78 -0
- package/dist/highlight-node/history-shortcut.js.map +1 -0
- package/dist/index.d.ts +1082 -354
- package/dist/index.js +18 -6
- package/dist/index.js.map +1 -1
- package/dist/query/query-executor.js +51 -9
- package/dist/query/query-executor.js.map +1 -1
- package/dist/renderer-mode.d.ts +68 -0
- package/dist/renderer-mode.js +2 -0
- package/dist/renderer-mode.js.map +1 -0
- package/dist/url-metadata/entry-check-key.js +14 -0
- package/dist/url-metadata/entry-check-key.js.map +1 -0
- package/dist/url-metadata/select-url-winner.js +64 -12
- package/dist/url-metadata/select-url-winner.js.map +1 -1
- package/dist/url-metadata/types.js +10 -1
- package/dist/url-metadata/types.js.map +1 -1
- package/dist/url-metadata/url-pattern-matcher.js +11 -2
- package/dist/url-metadata/url-pattern-matcher.js.map +1 -1
- package/dist/utils/canvas.js +0 -1
- package/dist/utils/canvas.js.map +1 -1
- package/dist/utils/check-bindings.js +5 -3
- package/dist/utils/check-bindings.js.map +1 -1
- package/dist/utils/classify-response-error.js +243 -33
- package/dist/utils/classify-response-error.js.map +1 -1
- package/dist/utils/composable-studio-error.js +7 -0
- package/dist/utils/composable-studio-error.js.map +1 -1
- package/dist/utils/conditionBlock.js +19 -6
- package/dist/utils/conditionBlock.js.map +1 -1
- package/dist/utils/constants.js +7 -2
- package/dist/utils/constants.js.map +1 -1
- package/dist/utils/http-error.constants.js +24 -1
- package/dist/utils/http-error.constants.js.map +1 -1
- package/dist/utils/include-path-rules.js +3 -2
- package/dist/utils/include-path-rules.js.map +1 -1
- package/dist/utils/load-error-classifier.js +18 -0
- package/dist/utils/load-error-classifier.js.map +1 -0
- package/dist/utils/parse-ui.js +27 -5
- package/dist/utils/parse-ui.js.map +1 -1
- package/dist/utils/preview-hash-refused.js +75 -0
- package/dist/utils/preview-hash-refused.js.map +1 -0
- package/dist/utils/reference_fetcher.js +79 -12
- package/dist/utils/reference_fetcher.js.map +1 -1
- package/dist/utils/require-stack.js +83 -20
- package/dist/utils/require-stack.js.map +1 -1
- package/dist/utils/serialize-for-inline-script.js +19 -0
- package/dist/utils/serialize-for-inline-script.js.map +1 -0
- package/dist/utils/served-by.js +32 -13
- package/dist/utils/served-by.js.map +1 -1
- package/dist/utils/spec-analyzer.js +24 -1
- package/dist/utils/spec-analyzer.js.map +1 -1
- package/dist/utils/studio-error-codes.js +34 -2
- package/dist/utils/studio-error-codes.js.map +1 -1
- package/dist/utils/studio-error.js +68 -7
- package/dist/utils/studio-error.js.map +1 -1
- package/dist/visual-builder/composition-save-event.js +36 -5
- package/dist/visual-builder/composition-save-event.js.map +1 -1
- package/package.json +12 -8
- package/dist/studio-internal/dist/utils/section-slot-walker.js +0 -63
- package/dist/studio-internal/dist/utils/section-slot-walker.js.map +0 -1
- package/dist/studio-internal/dist/utils/spec-compression.js +0 -43
- package/dist/studio-internal/dist/utils/spec-compression.js.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pre-process-static-values.js","sources":["../../../src/composable-studio/data/pre-process-static-values.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA
|
|
1
|
+
{"version":3,"file":"pre-process-static-values.js","sources":["../../../src/composable-studio/data/pre-process-static-values.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA;;;;;;;;AAQG;AACH,SAAS,YAAY,CAAC,KAAa,EAAA;AACjC,IAAA,IAAI;AACF,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC1B;AAAE,IAAA,MAAM;AACN,QAAA,OAAO,SAAS;IAClB;AACF;AAEA;;;;;;;;;AASG;AACH,SAAS,eAAe,CAAC,QAAgB,EAAE,KAAc,EAAA;IACvD,IAAI,QAAQ,KAAK,OAAO;AAAE,QAAA,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;AACrD,IAAA,OAAO,KAAK,KAAK,IAAI,KAAK,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC/E;AAEA,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU;AAE5C;;;;;;;;;;;;;;;;AAgBG;AACH,SAAS,mBAAmB,CAC1B,QAA4B,EAC5B,GAAW,EACX,KAAc,EAAA;AAEd,IAAA,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE;QACzD,OAAO,QAAQ,KAAK,OAAO,GAAG,EAAE,GAAG,EAAE;IACvC;AAEA,IAAA,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,KAAK;AACtE,IAAA,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC;AAAE,QAAA,OAAO,MAAM;AAEpD,IAAA,MAAM,SAAS,GAAG,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,GAAG,EAAE;IACtC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;AACtC,QAAA,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC;QACjC,OAAO,CAAC,IAAI,CACV,CAAA,iCAAA,EAAoC,QAAQ,CAAA,eAAA,EAAkB,GAAG,4CAC/D,QAAQ,KAAK,OAAO,GAAG,QAAQ,GAAG,WACpC,CAAA,kDAAA,CAAoD,CACrD;IACH;AACA,IAAA,OAAO,SAAS;AAClB;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACG,SAAU,sBAAsB,CACpC,eAAwC,EAAA;AAExC,IAAA,IAAI,CAAC,eAAe;AAAE,QAAA,OAAO,EAAE;;;;AAI/B,IAAA,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;AACvC,QAAA,MAAM,MAAM,GAAG,YAAY,CAAC,eAAe,CAAC;AAC5C,QAAA,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;AAAE,YAAA,OAAO,EAAE;QACpD,eAAe,GAAG,MAAwB;IAC5C;IACA,MAAM,qBAAqB,GAAgB,EAAE;AAC7C,IAAA,IAAI,OAAO,eAAe,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;AACzE,QAAA,OAAO,qBAAqB;IAC9B;AACA,IAAA,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,aAAa,CAAC,KAAI;AACpE,QAAA,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAAE;AACnC,QAAA,KAAK,MAAM,UAAU,IAAI,aAAa,EAAE;;AAEtC,YAAA,IACE,CAAC,UAAU;gBACX,OAAO,UAAU,KAAK,QAAQ;AAC9B,gBAAA,OAAO,UAAU,CAAC,GAAG,KAAK,QAAQ,EAClC;gBACA;YACF;YACA,IAAI,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,OAAO,EAAE;AACjD,gBAAA,MAAM,MAAM,GAAG,mBAAmB,CAChC,QAAQ,EACR,UAAU,CAAC,GAAG,EACd,UAAU,CAAC,KAAK,CACjB;gBACD,IAAI,MAAM,KAAK,SAAS;oBAAE;AAC1B,gBAAA,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC;AACnC,oBAAA,QAAQ,KAAK;AACX,0BAAG;AACE,6BAAA,GAAG,CAAC,CAAC,IAAI,KAAI;AACZ,4BAAA,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAc,CAAC;AACnD,4BAAA,IAAI,UAAU,CAAC,OAAO,EAAE;gCACtB,OAAO,UAAU,CAAC,KAAK;4BACzB;AACF,wBAAA,CAAC;6BACA,MAAM,CAAC,OAAO;0BACjB,MAAM;gBACZ;YACF;YAEA,IAAI,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,UAAU,EAAE;gBACjD,MAAM,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAC,KAAe,CAAC;AAChE,gBAAA,IAAI,WAAW,CAAC,OAAO,EAAE;oBACvB,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,KAAK;gBAC3D;gBACA;YACF;YAEA,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,KAAK;QAC1D;AACF,IAAA,CAAC,CAAC;AACF,IAAA,OAAO,qBAAqB;AAC9B;AAcA;;;;;;;;;;AAUG;AACG,SAAU,gBAAgB,CAAC,KAAa,EAAA;AAC5C,IAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAO;AACL,YAAA,KAAK,EAAE,KAAK;AACZ,YAAA,OAAO,EAAE,IAAI;SACd;IACH;AACA,IAAA,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE;AAE5B,IAAA,IAAI,OAAO,KAAK,EAAE,EAAE;QAClB,OAAO;AACL,YAAA,KAAK,EAAE,SAAS;AAChB,YAAA,OAAO,EAAE,IAAI;SACd;IACH;AAEA,IAAA,IAAI;;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QAElC,OAAO;AACL,YAAA,KAAK,EAAE,MAAM;AACb,YAAA,OAAO,EAAE,IAAI;SACd;IACH;IAAE,OAAO,SAAS,EAAE;AAClB,QAAA,IAAI,OAAO,KAAK,WAAW,EAAE;YAC3B,OAAO;AACL,gBAAA,KAAK,EAAE,SAAS;AAChB,gBAAA,OAAO,EAAE,IAAI;aACd;QACH;AAEA,QAAA,IAAI,OAAO,KAAK,KAAK,EAAE;YACrB,OAAO;AACL,gBAAA,KAAK,EAAE,GAAG;AACV,gBAAA,OAAO,EAAE,IAAI;aACd;QACH;QAEA,IAAI,OAAO,KAAK,UAAU,IAAI,OAAO,KAAK,WAAW,EAAE;YACrD,OAAO;AACL,gBAAA,KAAK,EAAE,QAAQ;AACf,gBAAA,OAAO,EAAE,IAAI;aACd;QACH;AAEA,QAAA,IAAI,OAAO,KAAK,WAAW,EAAE;YAC3B,OAAO;gBACL,KAAK,EAAE,CAAC,QAAQ;AAChB,gBAAA,OAAO,EAAE,IAAI;aACd;QACH;;AAGA,QAAA,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE;;AAEhD,YAAA,IAAI,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,EAAE;gBACzD,OAAO;AACL,oBAAA,KAAK,EAAE,WAAW;AAClB,oBAAA,OAAO,EAAE,IAAI;iBACd;YACH;;AAGA,YAAA,IACE,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC;AACpC,gBAAA,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC;AAC9B,gBAAA,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,EAC7B;gBACA,OAAO;AACL,oBAAA,KAAK,EAAE,WAAW;AAClB,oBAAA,OAAO,EAAE,IAAI;iBACd;YACH;QACF;;AAGA,QAAA,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACjD,OAAO;AACL,gBAAA,KAAK,EAAE,OAAO;AACd,gBAAA,OAAO,EAAE,IAAI;aACd;QACH;;QAGA,OAAO;AACL,YAAA,KAAK,EAAE,IAAI;AACX,YAAA,OAAO,EAAE,KAAK;AACd,YAAA,KAAK,EAAE,CAAA,eAAA,EACL,SAAS,YAAY,KAAK,GAAG,SAAS,CAAC,OAAO,GAAG,eACnD,CAAA,CAAE;SACH;IACH;AACF;;;;"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { ComposableStudioError } from '../utils/composable-studio-error.js';
|
|
2
|
+
import { loadErrorClassifier } from '../utils/load-error-classifier.js';
|
|
3
|
+
import { requireStack, requireCompositionContentType } from '../utils/require-stack.js';
|
|
4
|
+
|
|
5
|
+
/** Long enough for a slow region, short enough that a dead host is named promptly. */
|
|
6
|
+
const DEFAULT_TIMEOUT_MS = 10_000;
|
|
7
|
+
/** The request goes to the delivery host, never through live preview. */
|
|
8
|
+
const ROUTE = { servedBy: "cdn" };
|
|
9
|
+
/**
|
|
10
|
+
* Whether the site's delivery setup works, asked with one request.
|
|
11
|
+
*
|
|
12
|
+
* Inside Studio's canvas, live preview sends every page request to the preview
|
|
13
|
+
* host with the preview token, so the delivery host, delivery token and
|
|
14
|
+
* environment the published site depends on are never used there. A wrong one
|
|
15
|
+
* breaks the published site while the canvas looks fine. This is the one request
|
|
16
|
+
* that uses them.
|
|
17
|
+
*
|
|
18
|
+
* It is a plain `fetch`, not the delivery SDK: the delivery SDK retries a 401
|
|
19
|
+
* like a rate limit and reports it with no status, and its stack carries the
|
|
20
|
+
* live preview hash for every request it makes.
|
|
21
|
+
*
|
|
22
|
+
* Resolves `undefined` when Contentstack accepted the setup, an empty list
|
|
23
|
+
* included. Never rejects.
|
|
24
|
+
*/
|
|
25
|
+
async function checkDeliverySetup(config, options = {}) {
|
|
26
|
+
let url;
|
|
27
|
+
let headers;
|
|
28
|
+
try {
|
|
29
|
+
const stack = requireStack(config);
|
|
30
|
+
const contentTypeUid = requireCompositionContentType(config);
|
|
31
|
+
url = new URL(`https://${stack.host}/v3/content_types/${encodeURIComponent(contentTypeUid)}/entries`);
|
|
32
|
+
url.searchParams.set("environment", stack.environment ?? "");
|
|
33
|
+
const locale = stack.locale ?? config.locale;
|
|
34
|
+
if (locale)
|
|
35
|
+
url.searchParams.set("locale", locale);
|
|
36
|
+
url.searchParams.set("limit", "1");
|
|
37
|
+
url.searchParams.append("only[BASE][]", "uid");
|
|
38
|
+
headers = {
|
|
39
|
+
api_key: stack.apiKey,
|
|
40
|
+
access_token: stack.deliveryToken ?? "",
|
|
41
|
+
...(stack.branch ? { branch: stack.branch } : {}),
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
catch (error) {
|
|
45
|
+
// A value that is missing or cannot work is known without asking.
|
|
46
|
+
return await asStudioError(error, config);
|
|
47
|
+
}
|
|
48
|
+
let response;
|
|
49
|
+
try {
|
|
50
|
+
response = await fetch(url, {
|
|
51
|
+
headers,
|
|
52
|
+
signal: timeoutSignal(options.timeoutMs ?? DEFAULT_TIMEOUT_MS),
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
catch {
|
|
56
|
+
// No reply, or none in time: nothing answered.
|
|
57
|
+
const { diagnoseUnreadableResponse } = await loadErrorClassifier();
|
|
58
|
+
return diagnoseUnreadableResponse({ status: 0, error_code: "ERR_NETWORK" }, config, ROUTE);
|
|
59
|
+
}
|
|
60
|
+
if (response.ok)
|
|
61
|
+
return undefined;
|
|
62
|
+
const body = (await response.json().catch(() => ({})));
|
|
63
|
+
const reply = {
|
|
64
|
+
status: response.status,
|
|
65
|
+
error_code: body.error_code,
|
|
66
|
+
error_message: body.error_message,
|
|
67
|
+
};
|
|
68
|
+
const { classifyResponseError, diagnoseUnreadableResponse } = await loadErrorClassifier();
|
|
69
|
+
return (classifyResponseError(reply, config, ROUTE) ??
|
|
70
|
+
diagnoseUnreadableResponse(reply, config, ROUTE));
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* An abort signal that fires after `ms`. `AbortSignal.timeout` is missing from some
|
|
74
|
+
* browsers still in use (Safari before 16), and calling it there would throw — which
|
|
75
|
+
* would read as a host that never answered.
|
|
76
|
+
*/
|
|
77
|
+
function timeoutSignal(ms) {
|
|
78
|
+
if (typeof AbortSignal.timeout === "function")
|
|
79
|
+
return AbortSignal.timeout(ms);
|
|
80
|
+
const controller = new AbortController();
|
|
81
|
+
setTimeout(() => controller.abort(), ms);
|
|
82
|
+
return controller.signal;
|
|
83
|
+
}
|
|
84
|
+
async function asStudioError(error, config) {
|
|
85
|
+
if (error instanceof ComposableStudioError)
|
|
86
|
+
return error;
|
|
87
|
+
const { diagnoseUnreadableResponse } = await loadErrorClassifier();
|
|
88
|
+
return diagnoseUnreadableResponse(error, config, ROUTE);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export { ROUTE, checkDeliverySetup };
|
|
92
|
+
//# sourceMappingURL=delivery-setup-check.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"delivery-setup-check.js","sources":["../../src/composable-studio/delivery-setup-check.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AASA;AACA,MAAM,kBAAkB,GAAG,MAAM;AAEjC;MACa,KAAK,GAAiB,EAAE,QAAQ,EAAE,KAAK;AAEpD;;;;;;;;;;;;;;;AAeG;AACI,eAAe,kBAAkB,CACtC,MAAc,EACd,UAAkC,EAAE,EAAA;AAEpC,IAAA,IAAI,GAAQ;AACZ,IAAA,IAAI,OAA+B;AACnC,IAAA,IAAI;AACF,QAAA,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC;AAClC,QAAA,MAAM,cAAc,GAAG,6BAA6B,CAAC,MAAM,CAAC;AAC5D,QAAA,GAAG,GAAG,IAAI,GAAG,CACX,WAAW,KAAK,CAAC,IAAI,CAAA,kBAAA,EAAqB,kBAAkB,CAAC,cAAc,CAAC,CAAA,QAAA,CAAU,CACvF;AACD,QAAA,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5D,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM;AAC5C,QAAA,IAAI,MAAM;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC;QAClC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC;AAC9C,QAAA,OAAO,GAAG;YACR,OAAO,EAAE,KAAK,CAAC,MAAM;AACrB,YAAA,YAAY,EAAE,KAAK,CAAC,aAAa,IAAI,EAAE;AACvC,YAAA,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;SAClD;IACH;IAAE,OAAO,KAAK,EAAE;;AAEd,QAAA,OAAO,MAAM,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC;IAC3C;AAEA,IAAA,IAAI,QAAkB;AACtB,IAAA,IAAI;AACF,QAAA,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAC1B,OAAO;YACP,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;AAC/D,SAAA,CAAC;IACJ;AAAE,IAAA,MAAM;;AAEN,QAAA,MAAM,EAAE,0BAA0B,EAAE,GAAG,MAAM,mBAAmB,EAAE;AAClE,QAAA,OAAO,0BAA0B,CAC/B,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,EACxC,MAAM,EACN,KAAK,CACN;IACH;IAEA,IAAI,QAAQ,CAAC,EAAE;AAAE,QAAA,OAAO,SAAS;AAEjC,IAAA,MAAM,IAAI,IAAI,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAGpD;AACD,IAAA,MAAM,KAAK,GAAG;QACZ,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;KAClC;IACD,MAAM,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,GACzD,MAAM,mBAAmB,EAAE;IAC7B,QACE,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC;QAC3C,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC;AAEpD;AAEA;;;;AAIG;AACH,SAAS,aAAa,CAAC,EAAU,EAAA;AAC/B,IAAA,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,UAAU;AAAE,QAAA,OAAO,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;AAC7E,IAAA,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE;IACxC,UAAU,CAAC,MAAM,UAAU,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC;IACxC,OAAO,UAAU,CAAC,MAAM;AAC1B;AAEA,eAAe,aAAa,CAC1B,KAAc,EACd,MAAc,EAAA;IAEd,IAAI,KAAK,YAAY,qBAAqB;AAAE,QAAA,OAAO,KAAK;AACxD,IAAA,MAAM,EAAE,0BAA0B,EAAE,GAAG,MAAM,mBAAmB,EAAE;IAClE,OAAO,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC;AACzD;;;;"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { INTERNAL_COMPONENTS_NAMES } from '@contentstack/studio-registry';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Never a real composition's uid, so the push to Studio — which only happens
|
|
5
|
+
* for the composition being edited — can never hand Studio a failure.
|
|
6
|
+
*/
|
|
7
|
+
const RESOLUTION_FAILURE_COMPOSABLE_UID = "__studio_resolution_failure__";
|
|
8
|
+
/**
|
|
9
|
+
* The spec a fetch that failed inside Studio's canvas resolves with: a complete
|
|
10
|
+
* composition whose only node renders the failure. Complete, so every helper
|
|
11
|
+
* that reads a spec keeps working on it.
|
|
12
|
+
*/
|
|
13
|
+
function buildResolutionFailureSpec(telemetry) {
|
|
14
|
+
const telemetryProp = {
|
|
15
|
+
type: "object",
|
|
16
|
+
value: telemetry,
|
|
17
|
+
};
|
|
18
|
+
const data = { dataSources: {}, static_value: {} };
|
|
19
|
+
const compositionEntry = {
|
|
20
|
+
uid: RESOLUTION_FAILURE_COMPOSABLE_UID,
|
|
21
|
+
composable_uid: RESOLUTION_FAILURE_COMPOSABLE_UID,
|
|
22
|
+
title: "",
|
|
23
|
+
url: "url" in telemetry.query ? telemetry.query.url : undefined,
|
|
24
|
+
locale: "",
|
|
25
|
+
tags: [],
|
|
26
|
+
created_by: "",
|
|
27
|
+
updated_by: "",
|
|
28
|
+
created_at: "",
|
|
29
|
+
updated_at: "",
|
|
30
|
+
ui: "",
|
|
31
|
+
data_sources: "",
|
|
32
|
+
};
|
|
33
|
+
return {
|
|
34
|
+
data,
|
|
35
|
+
compositionEntry,
|
|
36
|
+
ui: {
|
|
37
|
+
uid: RESOLUTION_FAILURE_COMPOSABLE_UID,
|
|
38
|
+
type: INTERNAL_COMPONENTS_NAMES.RESOLUTION_FAILURE,
|
|
39
|
+
attrs: {},
|
|
40
|
+
metadata: {},
|
|
41
|
+
props: { telemetry: telemetryProp },
|
|
42
|
+
slots: {},
|
|
43
|
+
styles: {},
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
/** Whether a spec renders a failed fetch rather than a composition. */
|
|
48
|
+
function isResolutionFailureSpec(spec) {
|
|
49
|
+
return spec?.ui?.type === INTERNAL_COMPONENTS_NAMES.RESOLUTION_FAILURE;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export { buildResolutionFailureSpec, isResolutionFailureSpec };
|
|
53
|
+
//# sourceMappingURL=resolution-failure-spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resolution-failure-spec.js","sources":["../../src/composable-studio/resolution-failure-spec.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAQA;;;AAGG;AACH,MAAM,iCAAiC,GAAG,+BAA+B;AAEzE;;;;AAIG;AACG,SAAU,0BAA0B,CACxC,SAAmD,EAAA;AAEnD,IAAA,MAAM,aAAa,GAAuB;AACxC,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,KAAK,EAAE,SAAS;KACjB;IACD,MAAM,IAAI,GAAmB,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;AAClE,IAAA,MAAM,gBAAgB,GAAqB;AACzC,QAAA,GAAG,EAAE,iCAAiC;AACtC,QAAA,cAAc,EAAE,iCAAiC;AACjD,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,GAAG,EAAE,KAAK,IAAI,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,GAAG,SAAS;AAC/D,QAAA,MAAM,EAAE,EAAE;AACV,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,UAAU,EAAE,EAAE;AACd,QAAA,UAAU,EAAE,EAAE;AACd,QAAA,UAAU,EAAE,EAAE;AACd,QAAA,UAAU,EAAE,EAAE;AACd,QAAA,EAAE,EAAE,EAAE;AACN,QAAA,YAAY,EAAE,EAAE;KACjB;IAED,OAAO;QACL,IAAI;QACJ,gBAAgB;AAChB,QAAA,EAAE,EAAE;AACF,YAAA,GAAG,EAAE,iCAAiC;YACtC,IAAI,EAAE,yBAAyB,CAAC,kBAAkB;AAClD,YAAA,KAAK,EAAE,EAAE;AACT,YAAA,QAAQ,EAAE,EAAE;AACZ,YAAA,KAAK,EAAE,EAAE,SAAS,EAAE,aAAa,EAAE;AACnC,YAAA,KAAK,EAAE,EAAE;AACT,YAAA,MAAM,EAAE,EAAE;AACX,SAAA;KACF;AACH;AAEA;AACM,SAAU,uBAAuB,CACrC,IAAmC,EAAA;IAEnC,OAAO,IAAI,EAAE,EAAE,EAAE,IAAI,KAAK,yBAAyB,CAAC,kBAAkB;AACxE;;;;"}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { pick } from 'lodash-es';
|
|
2
|
+
import { ComposableStudioError } from '../utils/composable-studio-error.js';
|
|
3
|
+
import { serializeStudioError } from '../utils/studio-error.js';
|
|
4
|
+
|
|
5
|
+
/** Which identifier the SDK resolves by, mirroring `fetchComposition`'s branch order. */
|
|
6
|
+
function getPrioritizedBy(query) {
|
|
7
|
+
if ("composableUid" in query && query.composableUid)
|
|
8
|
+
return "composableUid";
|
|
9
|
+
if ("templateContentTypeUid" in query && query.templateContentTypeUid)
|
|
10
|
+
return "templateContentTypeUid";
|
|
11
|
+
return "url";
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* The resolution telemetry for one fetch: what was asked for, the candidates,
|
|
15
|
+
* the winner, or why it failed. One builder for every surface, so Studio reads
|
|
16
|
+
* the same shape wherever the fetch ran. Plain data, because a server render
|
|
17
|
+
* carries it to the browser inside the page.
|
|
18
|
+
*/
|
|
19
|
+
function buildResolutionTelemetry({ query, options, isCanvasComponent = false, spec, error, }) {
|
|
20
|
+
const prioritizedBy = getPrioritizedBy(query);
|
|
21
|
+
const entry = spec?.compositionEntry;
|
|
22
|
+
const studioError = error instanceof ComposableStudioError ? error : undefined;
|
|
23
|
+
let shortlisted;
|
|
24
|
+
if (spec?.urlResolution?.shortlisted?.length) {
|
|
25
|
+
// URL metadata path: every candidate considered, with specificity. The content
|
|
26
|
+
// type lets Studio tell templates sharing a URL on one content type (expected
|
|
27
|
+
// until publish settles it) from a clash across content types.
|
|
28
|
+
shortlisted = spec.urlResolution.shortlisted.map((match) => pick(match, [
|
|
29
|
+
"composable_uid",
|
|
30
|
+
"url",
|
|
31
|
+
"specificity",
|
|
32
|
+
"connected_content_type",
|
|
33
|
+
"connectedEntryResult",
|
|
34
|
+
]));
|
|
35
|
+
}
|
|
36
|
+
else if (entry && prioritizedBy !== "url") {
|
|
37
|
+
// uid/ct queries resolve to exactly one composition — itself.
|
|
38
|
+
shortlisted = [pick(entry, ["composable_uid", "uid", "title", "url"])];
|
|
39
|
+
}
|
|
40
|
+
const telemetry = {
|
|
41
|
+
kind: "composition-resolution",
|
|
42
|
+
isCanvasComponent,
|
|
43
|
+
query,
|
|
44
|
+
options: options && pick(options, ["locale", "variantAlias", "templateEntryUid"]),
|
|
45
|
+
prioritizedBy,
|
|
46
|
+
shortlisted,
|
|
47
|
+
urlWinner: spec?.urlResolution?.winner,
|
|
48
|
+
resolved: entry &&
|
|
49
|
+
pick(entry, [
|
|
50
|
+
"composable_uid",
|
|
51
|
+
"uid",
|
|
52
|
+
"title",
|
|
53
|
+
"url",
|
|
54
|
+
"connected_content_type",
|
|
55
|
+
]),
|
|
56
|
+
// On success it comes off the spec; on failure the error carries its own
|
|
57
|
+
// copy of the same block.
|
|
58
|
+
context: spec?.requestContext ?? studioError?.context,
|
|
59
|
+
error: error ? serializeStudioError(error) : undefined,
|
|
60
|
+
timestamp: Date.now(),
|
|
61
|
+
};
|
|
62
|
+
// A JSON copy, not a structured clone: it drops `undefined` fields and
|
|
63
|
+
// anything that is not plain data, which is what a framework will send.
|
|
64
|
+
return JSON.parse(JSON.stringify(telemetry));
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export { buildResolutionTelemetry };
|
|
68
|
+
//# sourceMappingURL=resolution-telemetry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resolution-telemetry.js","sources":["../../src/composable-studio/resolution-telemetry.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAsBA;AACA,SAAS,gBAAgB,CACvB,KAAuB,EAAA;AAEvB,IAAA,IAAI,eAAe,IAAI,KAAK,IAAI,KAAK,CAAC,aAAa;AAAE,QAAA,OAAO,eAAe;AAC3E,IAAA,IAAI,wBAAwB,IAAI,KAAK,IAAI,KAAK,CAAC,sBAAsB;AACnE,QAAA,OAAO,wBAAwB;AACjC,IAAA,OAAO,KAAK;AACd;AAEA;;;;;AAKG;AACG,SAAU,wBAAwB,CAAC,EACvC,KAAK,EACL,OAAO,EACP,iBAAiB,GAAG,KAAK,EACzB,IAAI,EACJ,KAAK,GACoB,EAAA;AACzB,IAAA,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,CAAC;AAC7C,IAAA,MAAM,KAAK,GAAG,IAAI,EAAE,gBAAgB;AACpC,IAAA,MAAM,WAAW,GACf,KAAK,YAAY,qBAAqB,GAAG,KAAK,GAAG,SAAS;AAE5D,IAAA,IAAI,WAAoE;IACxE,IAAI,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE;;;;AAI5C,QAAA,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,KACrD,IAAI,CAAC,KAAK,EAAE;YACV,gBAAgB;YAChB,KAAK;YACL,aAAa;YACb,wBAAwB;YACxB,sBAAsB;AACvB,SAAA,CAAC,CACH;IACH;AAAO,SAAA,IAAI,KAAK,IAAI,aAAa,KAAK,KAAK,EAAE;;AAE3C,QAAA,WAAW,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACxE;AAEA,IAAA,MAAM,SAAS,GAA6C;AAC1D,QAAA,IAAI,EAAE,wBAAwB;QAC9B,iBAAiB;QACjB,KAAK;AACL,QAAA,OAAO,EACL,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC1E,aAAa;QACb,WAAW;AACX,QAAA,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM;AACtC,QAAA,QAAQ,EACN,KAAK;YACL,IAAI,CAAC,KAAK,EAAE;gBACV,gBAAgB;gBAChB,KAAK;gBACL,OAAO;gBACP,KAAK;gBACL,wBAAwB;aACzB,CAAC;;;AAGJ,QAAA,OAAO,EAAE,IAAI,EAAE,cAAc,IAAI,WAAW,EAAE,OAAO;AACrD,QAAA,KAAK,EAAE,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,GAAG,SAAS;AACtD,QAAA,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;KACtB;;;IAID,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;AAC9C;;;;"}
|