@contentstack/studio-client 1.6.0 → 1.7.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.
Files changed (86) hide show
  1. package/dist/breakpoints/BreakpointManager.js +18 -5
  2. package/dist/breakpoints/BreakpointManager.js.map +1 -1
  3. package/dist/canvas/canvas.utils.js +1 -1
  4. package/dist/canvas/canvas.utils.js.map +1 -1
  5. package/dist/composable-studio/build-scoped-data.js +170 -0
  6. package/dist/composable-studio/build-scoped-data.js.map +1 -0
  7. package/dist/composable-studio/collect-data-needs.js +344 -0
  8. package/dist/composable-studio/collect-data-needs.js.map +1 -0
  9. package/dist/composable-studio/composition-metadata.js +75 -0
  10. package/dist/composable-studio/composition-metadata.js.map +1 -0
  11. package/dist/composable-studio/composition-placement.types.js +7 -0
  12. package/dist/composable-studio/composition-placement.types.js.map +1 -0
  13. package/dist/composable-studio/sdk.js +2169 -192
  14. package/dist/composable-studio/sdk.js.map +1 -1
  15. package/dist/composable-studio/studio-intelligence.manager.js +2 -12
  16. package/dist/composable-studio/studio-intelligence.manager.js.map +1 -1
  17. package/dist/config/default-config.js +1 -0
  18. package/dist/config/default-config.js.map +1 -1
  19. package/dist/config/stack-sdk-wrapper.js +86 -0
  20. package/dist/config/stack-sdk-wrapper.js.map +1 -1
  21. package/dist/context-menu/context-menu.js +1 -0
  22. package/dist/context-menu/context-menu.js.map +1 -1
  23. package/dist/dnd/dnd-manager.js +1 -0
  24. package/dist/dnd/dnd-manager.js.map +1 -1
  25. package/dist/highlight-node/highlight-node-manager.js +1 -0
  26. package/dist/highlight-node/highlight-node-manager.js.map +1 -1
  27. package/dist/highlight-node/highlight-node.js +5 -1
  28. package/dist/highlight-node/highlight-node.js.map +1 -1
  29. package/dist/index.d.ts +1033 -294
  30. package/dist/index.js +13 -2
  31. package/dist/index.js.map +1 -1
  32. package/dist/json-rte-registry/embedded-entry-conversion.js +186 -0
  33. package/dist/json-rte-registry/embedded-entry-conversion.js.map +1 -0
  34. package/dist/json-rte-registry/index.js +73 -33
  35. package/dist/json-rte-registry/index.js.map +1 -1
  36. package/dist/json-rte-registry/stack-sdk-store.js +10 -0
  37. package/dist/json-rte-registry/stack-sdk-store.js.map +1 -0
  38. package/dist/query/query-executor.js +182 -27
  39. package/dist/query/query-executor.js.map +1 -1
  40. package/dist/studio-internal/dist/utils/section-slot-walker.js +63 -0
  41. package/dist/studio-internal/dist/utils/section-slot-walker.js.map +1 -0
  42. package/dist/{packages/studio-internal → studio-internal}/dist/utils/spec-compression.js +1 -1
  43. package/dist/studio-internal/dist/utils/spec-compression.js.map +1 -0
  44. package/dist/url-metadata/build-template-query.js +124 -0
  45. package/dist/url-metadata/build-template-query.js.map +1 -0
  46. package/dist/url-metadata/parse-url-metadata.js +75 -0
  47. package/dist/url-metadata/parse-url-metadata.js.map +1 -0
  48. package/dist/url-metadata/rank-url-matches.js +100 -0
  49. package/dist/url-metadata/rank-url-matches.js.map +1 -0
  50. package/dist/url-metadata/select-url-winner.js +45 -0
  51. package/dist/url-metadata/select-url-winner.js.map +1 -0
  52. package/dist/url-metadata/shouldUseUrlMetadataPath.js +22 -0
  53. package/dist/url-metadata/shouldUseUrlMetadataPath.js.map +1 -0
  54. package/dist/url-metadata/types.js +50 -0
  55. package/dist/url-metadata/types.js.map +1 -0
  56. package/dist/url-metadata/url-pattern-matcher.js +311 -0
  57. package/dist/url-metadata/url-pattern-matcher.js.map +1 -0
  58. package/dist/utils/build-composition-fetch-query.js +19 -0
  59. package/dist/utils/build-composition-fetch-query.js.map +1 -0
  60. package/dist/utils/canvas.js +14 -0
  61. package/dist/utils/canvas.js.map +1 -1
  62. package/dist/utils/constants.js +19 -2
  63. package/dist/utils/constants.js.map +1 -1
  64. package/dist/utils/convertCompositionQueryInputToCompositionQuery.js +11 -1
  65. package/dist/utils/convertCompositionQueryInputToCompositionQuery.js.map +1 -1
  66. package/dist/utils/editor-mode.js +142 -0
  67. package/dist/utils/editor-mode.js.map +1 -0
  68. package/dist/utils/editor-utils.js +9 -0
  69. package/dist/utils/editor-utils.js.map +1 -1
  70. package/dist/utils/is-composition-being-edited.js.map +1 -1
  71. package/dist/utils/query-param.js +1 -1
  72. package/dist/utils/query-param.js.map +1 -1
  73. package/dist/utils/reference_fetcher.js +61 -6
  74. package/dist/utils/reference_fetcher.js.map +1 -1
  75. package/dist/utils/sdk.js +16 -1
  76. package/dist/utils/sdk.js.map +1 -1
  77. package/dist/utils/spec-analyzer.js +21 -4
  78. package/dist/utils/spec-analyzer.js.map +1 -1
  79. package/package.json +8 -10
  80. package/dist/get-composition-from-slug/get-composition-from-slug.js +0 -59
  81. package/dist/get-composition-from-slug/get-composition-from-slug.js.map +0 -1
  82. package/dist/node_modules/fflate/esm/browser.js +0 -384
  83. package/dist/node_modules/fflate/esm/browser.js.map +0 -1
  84. package/dist/packages/studio-internal/dist/utils/spec-compression.js.map +0 -1
  85. package/dist/utils/get-url-patterns.js +0 -40
  86. package/dist/utils/get-url-patterns.js.map +0 -1
@@ -0,0 +1,75 @@
1
+ const pushTag = (tags, attr, key, content) => {
2
+ if (!content)
3
+ return;
4
+ tags.push({ attr, key, content });
5
+ };
6
+ /**
7
+ * Derives framework-neutral SEO metadata from a fetched composition.
8
+ *
9
+ * The heavy lifting (resolving field bindings for title/description/OG image)
10
+ * already happens inside `fetchCompositionData` — this helper only shapes the
11
+ * resolved values into standard head-tag structures.
12
+ *
13
+ * @example Plain Node
14
+ * ```ts
15
+ * const meta = getCompositionMetadata(specOptions, { baseUrl: "https://example.com" });
16
+ * res.send(`<head><title>${meta.title}</title>${renderMetadataToHtml(meta)}</head>...`);
17
+ * ```
18
+ *
19
+ * @example Next.js App Router
20
+ * ```ts
21
+ * export async function generateMetadata() {
22
+ * const meta = getCompositionMetadata(await getSpecOptions());
23
+ * return { title: meta.title, description: meta.description };
24
+ * }
25
+ * ```
26
+ */
27
+ function getCompositionMetadata(specOptions, options = {}) {
28
+ const seo = specOptions.seo;
29
+ const tags = [];
30
+ const title = seo?.pageTitle || specOptions.spec?.compositionEntry?.title;
31
+ const description = seo?.pageDescription || undefined;
32
+ const ogImage = seo?.openGraphImage || undefined;
33
+ let canonical;
34
+ const compositionUrl = specOptions.spec?.compositionEntry?.url;
35
+ if (options.baseUrl && compositionUrl) {
36
+ const origin = options.baseUrl.replace(/\/+$/, "");
37
+ const path = compositionUrl.startsWith("/")
38
+ ? compositionUrl
39
+ : `/${compositionUrl}`;
40
+ canonical = `${origin}${path}`;
41
+ }
42
+ pushTag(tags, "name", "description", description);
43
+ pushTag(tags, "property", "og:title", title);
44
+ pushTag(tags, "property", "og:description", description);
45
+ pushTag(tags, "property", "og:image", ogImage);
46
+ pushTag(tags, "property", "og:url", canonical);
47
+ pushTag(tags, "name", "twitter:card", ogImage ? "summary_large_image" : "");
48
+ pushTag(tags, "name", "twitter:title", title);
49
+ pushTag(tags, "name", "twitter:description", description);
50
+ pushTag(tags, "name", "twitter:image", ogImage);
51
+ (seo?.metaProps ?? []).forEach((prop) => {
52
+ pushTag(tags, "name", prop.name, prop.value || prop.defaultValue);
53
+ });
54
+ return { title, description, ogImage, canonical, tags };
55
+ }
56
+ const escapeHtmlAttr = (value) => value
57
+ .replace(/&/g, "&amp;")
58
+ .replace(/"/g, "&quot;")
59
+ .replace(/</g, "&lt;")
60
+ .replace(/>/g, "&gt;");
61
+ /**
62
+ * Renders {@link CompositionMetadata} to a raw HTML string (meta + canonical
63
+ * link tags — the `<title>` element is left to the caller since most hosts
64
+ * manage it separately). For template-string SSR hosts (Express/Fastify).
65
+ */
66
+ function renderMetadataToHtml(metadata) {
67
+ const parts = metadata.tags.map((tag) => `<meta ${tag.attr}="${escapeHtmlAttr(tag.key)}" content="${escapeHtmlAttr(tag.content)}">`);
68
+ if (metadata.canonical) {
69
+ parts.push(`<link rel="canonical" href="${escapeHtmlAttr(metadata.canonical)}">`);
70
+ }
71
+ return parts.join("\n");
72
+ }
73
+
74
+ export { getCompositionMetadata, renderMetadataToHtml };
75
+ //# sourceMappingURL=composition-metadata.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"composition-metadata.js","sources":["../../src/composable-studio/composition-metadata.ts"],"sourcesContent":[null],"names":[],"mappings":"AAuCA,MAAM,OAAO,GAAG,CACd,IAA0B,EAC1B,IAAgC,EAChC,GAAW,EACX,OAA2B,KACzB;AACF,IAAA,IAAI,CAAC,OAAO;QAAE;IACd,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;AAoBG;SACa,sBAAsB,CACpC,WAA6D,EAC7D,UAAyC,EAAE,EAAA;AAE3C,IAAA,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG;IAC3B,MAAM,IAAI,GAAyB,EAAE;AAErC,IAAA,MAAM,KAAK,GAAG,GAAG,EAAE,SAAS,IAAI,WAAW,CAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK;AACzE,IAAA,MAAM,WAAW,GAAG,GAAG,EAAE,eAAe,IAAI,SAAS;AACrD,IAAA,MAAM,OAAO,GAAG,GAAG,EAAE,cAAc,IAAI,SAAS;AAEhD,IAAA,IAAI,SAA6B;IACjC,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,EAAE,gBAAgB,EAAE,GAAG;AAC9D,IAAA,IAAI,OAAO,CAAC,OAAO,IAAI,cAAc,EAAE;AACrC,QAAA,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;AAClD,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG;AACxC,cAAE;AACF,cAAE,CAAA,CAAA,EAAI,cAAc,CAAA,CAAE;AACxB,QAAA,SAAS,GAAG,CAAA,EAAG,MAAM,CAAA,EAAG,IAAI,EAAE;IAChC;IAEA,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC;IAEjD,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC;IAC5C,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,CAAC;IACxD,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC;IAC9C,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC;AAE9C,IAAA,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,GAAG,qBAAqB,GAAG,EAAE,CAAC;IAC3E,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,KAAK,CAAC;IAC7C,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,qBAAqB,EAAE,WAAW,CAAC;IACzD,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC;AAE/C,IAAA,CAAC,GAAG,EAAE,SAAS,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC,IAAc,KAAI;AAChD,QAAA,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC;AACnE,IAAA,CAAC,CAAC;IAEF,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;AACzD;AAEA,MAAM,cAAc,GAAG,CAAC,KAAa,KACnC;AACG,KAAA,OAAO,CAAC,IAAI,EAAE,OAAO;AACrB,KAAA,OAAO,CAAC,IAAI,EAAE,QAAQ;AACtB,KAAA,OAAO,CAAC,IAAI,EAAE,MAAM;AACpB,KAAA,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;AAE1B;;;;AAIG;AACG,SAAU,oBAAoB,CAAC,QAA6B,EAAA;AAChE,IAAA,MAAM,KAAK,GAAa,QAAQ,CAAC,IAAI,CAAC,GAAG,CACvC,CAAC,GAAG,KACF,SAAS,GAAG,CAAC,IAAI,CAAA,EAAA,EAAK,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA,WAAA,EAAc,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA,EAAA,CAAI,CAC7F;AACD,IAAA,IAAI,QAAQ,CAAC,SAAS,EAAE;AACtB,QAAA,KAAK,CAAC,IAAI,CACR,CAAA,4BAAA,EAA+B,cAAc,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA,EAAA,CAAI,CACtE;IACH;AACA,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;AACzB;;;;"}
@@ -0,0 +1,7 @@
1
+ const COMPOSITION_PLACEMENT_OPTIONS = {
2
+ PAGE: "page",
3
+ SECTION: "section",
4
+ };
5
+
6
+ export { COMPOSITION_PLACEMENT_OPTIONS };
7
+ //# sourceMappingURL=composition-placement.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"composition-placement.types.js","sources":["../../src/composable-studio/composition-placement.types.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAO,MAAM,6BAA6B,GAAG;AAC3C,IAAA,IAAI,EAAE,MAAM;AACZ,IAAA,OAAO,EAAE,SAAS;;;;;"}