@decocms/blocks 7.26.2 → 7.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/blocks",
-  "version": "7.26.2",
+  "version": "7.27.0",
   "type": "module",
   "engines": {
     "node": ">=24"

package/src/cms/schema.test.ts

@@ -253,9 +253,10 @@ describe("commerce SEO section schemas", () => {
     // PLP-specific structured-data config (see seo-form-mode.ts PLP_SEO_FIELD_KEYS).
     expect(props.configJsonLD.properties).toHaveProperty("removeVideos");
     expect(props.configJsonLD.properties).toHaveProperty("ignoreStructuredData");
-    // The data source is set once at creation and stays hidden in the SEO panel;
-    // it round-trips via the form rather than being re-picked here.
-    expect(props.jsonLD.hide).toBe(true);
+    // The data source is a loader picker (anyOf over the loader union), not
+    // hidden — the user picks the PLP loader that feeds the structured data.
+    expect(Array.isArray(props.jsonLD.anyOf)).toBe(true);
+    expect(props.jsonLD.title).toBe("Data Source");
   });
 
   it("emits editable props for the product-details SEO section (pdp mode)", () => {
@@ -268,10 +269,14 @@ describe("commerce SEO section schemas", () => {
     // PDP-specific fields (see seo-form-mode.ts PDP_SEO_FIELD_KEYS).
     expect(props).toHaveProperty("omitVariants");
     expect(props).toHaveProperty("ignoreStructuredData");
-    expect(props.jsonLD.hide).toBe(true);
+    expect(Array.isArray(props.jsonLD.anyOf)).toBe(true);
+    expect(props.jsonLD.title).toBe("Data Source");
   });
 
-  it("always registers the defs + manifest blocks so existing pages resolve", () => {
+  it("registers the defs + manifest blocks and offers them as page.seo options", () => {
+    // Unconditional (no commerce gate): meta.gen.json is baked at generation
+    // time when the loader registry is empty, and the runtime serves that baked
+    // meta as-is, so a registry-based gate would never bake the options.
     const meta = composeMeta(emptySiteMeta());
     for (const key of [
       "commerce/sections/Seo/SeoPLPV2.tsx",
@@ -279,26 +284,53 @@ describe("commerce SEO section schemas", () => {
     ]) {
       expect(meta.manifest.blocks.sections).toHaveProperty(key);
       expect(meta.schema.definitions).toHaveProperty(b64(key));
+      expect(meta.schema.root.sections.anyOf).toContainEqual(b64Ref(key));
     }
   });
 
-  it("offers them as page.seo options only on a commerce site", () => {
-    // "commerce site" = product-list loaders registered (the signal
-    // buildFrameworkSections gates the picker on). The key must match
-    // inferLoaderTags so it is tagged "product-list".
-    registerAppSchemas({
-      namespace: "vtex",
-      loaders: {
-        "vtex/loaders/test/ProductListForSeoPicker.ts": { type: "object", properties: {} },
-      },
-    });
-    const meta = composeMeta(emptySiteMeta());
-    for (const key of [
-      "commerce/sections/Seo/SeoPLPV2.tsx",
-      "commerce/sections/Seo/SeoPDPV2.tsx",
-    ]) {
-      expect(meta.schema.root.sections.anyOf).toContainEqual(b64Ref(key));
-    }
+  // Mirrors a generated site meta: a loader carries a real def AND is listed in
+  // the site's loader union. `@ignore`d loaders are the exception — they get a
+  // def but are withheld from the union.
+  function siteMetaWithLoader(key: string, opts: { inUnion: boolean }) {
+    const site = emptySiteMeta();
+    site.schema.definitions[b64(key)] = {
+      title: key,
+      type: "object",
+      properties: { __resolveType: { type: "string", enum: [key] } },
+    };
+    site.manifest.blocks.loaders = {
+      [key]: { $ref: `#/definitions/${b64(key)}`, namespace: "site" },
+    };
+    site.schema.root = { loaders: { anyOf: opts.inUnion ? [b64Ref(key)] : [] } };
+    return site;
+  }
+
+  it("feeds the site's own loaders into the jsonLD data-source picker", () => {
+    // The runtime loader registry is empty at generation time, so the union must
+    // be seeded from the site's own loader union — else the picker has no
+    // options and the user can't wire the data source.
+    const loaderKey = "site/loaders/product/productDetailsPage.ts";
+    const meta = composeMeta(siteMetaWithLoader(loaderKey, { inUnion: true }));
+
+    // The picker option is real, not a dangling $ref: its def survives.
+    expect(meta.schema.definitions).toHaveProperty(b64(loaderKey));
+    // …offered in both the root union and the commerce SEO jsonLD picker.
+    expect(meta.schema.root.loaders.anyOf).toContainEqual(b64Ref(loaderKey));
+    const seoDef =
+      meta.schema.definitions[b64("commerce/sections/Seo/SeoPDPV2.tsx")];
+    expect(seoDef.properties.jsonLD.anyOf).toContainEqual(b64Ref(loaderKey));
+  });
+
+  it("keeps @ignore'd loaders (in the manifest, not the union) out of the picker", () => {
+    // Seeding from `manifest.blocks.loaders` would resurrect hidden loaders;
+    // seeding from the union keeps them out.
+    const hiddenKey = "site/loaders/internal/hidden.ts";
+    const meta = composeMeta(siteMetaWithLoader(hiddenKey, { inUnion: false }));
+
+    expect(meta.schema.root.loaders.anyOf).not.toContainEqual(b64Ref(hiddenKey));
+    const seoDef =
+      meta.schema.definitions[b64("commerce/sections/Seo/SeoPDPV2.tsx")];
+    expect(seoDef.properties.jsonLD.anyOf).not.toContainEqual(b64Ref(hiddenKey));
   });
 });
 

package/src/cms/schema.ts

@@ -731,17 +731,11 @@ function buildPageSchema(sectionAnyOf: any[]) {
 // Framework sections
 // ---------------------------------------------------------------------------
 
-function buildFrameworkSections(sectionAnyOf: any[]) {
+function buildFrameworkSections(sectionAnyOf: any[], loaderUnion: any[]) {
   const definitions: Record<string, any> = {};
   const manifestBlocks: Record<string, any> = {};
   const extraAnyOf: any[] = [];
 
-  // A site is "commerce" when it registered product-list loaders (same signal
-  // wrapResolvableProperties uses). Gates whether the commerce SEO section types
-  // below are offered as pickable page.seo options — a blog site should not see
-  // "Product listing SEO" in the SEO type dropdown.
-  const hasCommerce = getProductListLoaderKeys().length > 0;
-
   // --- website/sections/Rendering/Lazy.tsx ---
   const LAZY_TYPE = "website/sections/Rendering/Lazy.tsx";
   const lazyKey = toBase64(LAZY_TYPE);
@@ -845,13 +839,20 @@ function buildFrameworkSections(sectionAnyOf: any[]) {
   // there is no manifest to emit these props from. The Studio's SEO editor
   // already knows this type as its "plp" mode (see seo-form-mode.ts); it just
   // needs the props schema to render the override fields. `jsonLD` is the
-  // data-source block-ref set once when the page is created; it round-trips via
-  // the form (kept `hide`) rather than being re-picked in the SEO panel.
+  // data-source loader picker (mirrors deco-cx's `@title Data Source`) — an
+  // inline anyOf over the loader union so the editor lets you pick the PLP/PDP
+  // loader that feeds the structured data. Inlined (a fresh copy) rather than a
+  // `$ref: "#/root/loaders"` because the Studio drops the prop-level title when
+  // resolving a `$ref` union, which would lose the "Data Source" label; the
+  // copy also avoids sharing one array instance across the two defs + root.
   //
-  // The def + manifest block are always registered so the SEO editor can resolve
-  // a schema for pages already on these types. They are added to `extraAnyOf`
-  // (offered as a selectable page.seo type) only on commerce sites, so a blog
-  // does not get "Product listing SEO" in its SEO type dropdown.
+  // Added to `extraAnyOf` (offered as a selectable page.seo type) unconditionally,
+  // like the website Seo sections above. Gating this on "is a commerce site" via
+  // the loader registry does NOT work: meta.gen.json is baked at generation time
+  // (blocks-cli), when the registry is empty, and the runtime serves that baked,
+  // already-composed meta as-is (composeMeta is idempotent on it) — so a gate
+  // would drop the options at bake and never re-add them. Non-commerce sites
+  // seeing these two extra options is a minor, acceptable cost.
   const SEO_PLP_V2_TYPE = "commerce/sections/Seo/SeoPLPV2.tsx";
   const seoPlpV2Key = toBase64(SEO_PLP_V2_TYPE);
   definitions[seoPlpV2Key] = {
@@ -864,12 +865,7 @@ function buildFrameworkSections(sectionAnyOf: any[]) {
         enum: [SEO_PLP_V2_TYPE],
         default: SEO_PLP_V2_TYPE,
       },
-      jsonLD: {
-        type: "object",
-        title: "Data Source",
-        additionalProperties: true,
-        hide: true,
-      },
+      jsonLD: { title: "Data Source", anyOf: [...loaderUnion] },
       title: { type: "string", title: "Title Override" },
       description: { type: "string", title: "Description Override" },
       noIndexing: { type: "boolean", title: "Disable indexing" },
@@ -887,7 +883,7 @@ function buildFrameworkSections(sectionAnyOf: any[]) {
     $ref: `#/definitions/${seoPlpV2Key}`,
     namespace: "commerce",
   };
-  if (hasCommerce) extraAnyOf.push({ $ref: `#/definitions/${seoPlpV2Key}` });
+  extraAnyOf.push({ $ref: `#/definitions/${seoPlpV2Key}` });
 
   // --- commerce/sections/Seo/SeoPDPV2.tsx ---
   // Product-details SEO. Studio "pdp" mode counterpart of the PLP section above.
@@ -903,12 +899,7 @@ function buildFrameworkSections(sectionAnyOf: any[]) {
         enum: [SEO_PDP_V2_TYPE],
         default: SEO_PDP_V2_TYPE,
       },
-      jsonLD: {
-        type: "object",
-        title: "Data Source",
-        additionalProperties: true,
-        hide: true,
-      },
+      jsonLD: { title: "Data Source", anyOf: [...loaderUnion] },
       omitVariants: { type: "boolean", title: "Omit variants" },
       title: { type: "string", title: "Title Override" },
       description: { type: "string", title: "Description Override" },
@@ -920,7 +911,7 @@ function buildFrameworkSections(sectionAnyOf: any[]) {
     $ref: `#/definitions/${seoPdpV2Key}`,
     namespace: "commerce",
   };
-  if (hasCommerce) extraAnyOf.push({ $ref: `#/definitions/${seoPdpV2Key}` });
+  extraAnyOf.push({ $ref: `#/definitions/${seoPdpV2Key}` });
 
   // --- website/flags/multivariate/section.ts ---
   const MV_SECTION_TYPE = "website/flags/multivariate/section.ts";
@@ -1112,11 +1103,36 @@ export function composeMeta(
 
   const siteAnyOf = siteMeta.schema?.root?.sections?.anyOf || [];
 
-  // Build all framework components
-  const fwSections = buildFrameworkSections(siteAnyOf);
+  // Build all framework components. Loaders first: the commerce SEO sections'
+  // `jsonLD` data-source picker references the loader union, and that union must
+  // include the site's OWN loaders. The runtime registry (loaderRegistry) is
+  // empty at generation time, so `buildLoaderDefinitions` alone yields just
+  // `Resolvable` — merge in the site's own loaders so loader-backed pickers have
+  // real options in the baked meta, not only at runtime.
+  //
+  // Seed from the site's loader UNION (`schema.root.loaders.anyOf`), NOT
+  // `manifest.blocks.loaders`: the generator keeps `@ignore`d loaders in the
+  // manifest (they still need a def) while withholding them from the union so
+  // they can't be picked — reading the manifest would resurrect them. This
+  // source is also already `{ $ref }`-shaped and only points at defs that exist
+  // (no dangling refs).
+  //
+  // TODO: `root.matchers`/`root.actions` have the same empty-union-at-gen-time
+  // gap; only loaders are merged here (commerce SEO scope). Generalize if a
+  // matcher/action picker ever needs baked options.
+  const loaders = buildLoaderDefinitions();
+  const siteLoaderRefs = (siteMeta.schema?.root?.loaders?.anyOf ?? []).filter(
+    (ref: any): ref is { $ref: string } => Boolean(ref) && typeof ref.$ref === "string",
+  );
+  const seenLoaderRefs = new Set<string>(loaders.loaderAnyOf.map((r: any) => r.$ref));
+  const loaderUnion = [
+    ...loaders.loaderAnyOf,
+    ...siteLoaderRefs.filter((r) => !seenLoaderRefs.has(r.$ref)),
+  ];
+
+  const fwSections = buildFrameworkSections(siteAnyOf, loaderUnion);
   const fullSectionAnyOf = [...siteAnyOf, ...fwSections.extraAnyOf];
   const page = buildPageSchema(fullSectionAnyOf);
-  const loaders = buildLoaderDefinitions();
   const actions = buildActionDefinitions();
   const matchers = buildMatcherDefinitions();
 
@@ -1177,7 +1193,7 @@ export function composeMeta(
         ...(siteMeta.schema?.root || {}),
         sections: { anyOf: fullSectionAnyOf },
         pages: { anyOf: page.rootAnyOf },
-        loaders: { anyOf: loaders.loaderAnyOf },
+        loaders: { anyOf: loaderUnion },
         matchers: { anyOf: matchers.matcherAnyOf },
       },
     },