@aduptive/strapi-blockscene 2.0.0-alpha.8 → 2.0.0-alpha.9

package/README.md

@@ -147,9 +147,10 @@ layout, guessed from the component name and display name (hero, banner,
 cover; text, rich, quote, title; image, media, video, gallery, carousel; list,
 query, archive, related, posts, projects; card; cta, button, link; form,
 contact; wrapper, column, grid, divider, spacer, section; else text). Override
-it, and add up to 10 tags (1 to 24 characters), in Settings, Blockscene, or in
-the plugin config: `components[uid].typology` and `components[uid].tags`. A
-Settings value wins over the config. The former `category` config key still
+it, and add up to 10 tags (1 to 24 characters), in Settings, Blockscene, in
+the plugin config (`components[uid].typology` and `components[uid].tags`) or in
+the component schema ([`pluginOptions.blockscene`](#describing-blocks-and-fields-in-the-schema)).
+A Settings value wins over the config, the config over the schema. The former `category` config key still
 works: it becomes the block's tag when no tags are set.
 
 The native "Add a component to <zone>" button of an editable zone opens this
@@ -269,7 +270,16 @@ as an input: the plugin removes it from the components' edit layouts through
 the Content Manager's layout hook (it may be listed in "Configure the view" of
 a component; leave it out of the layout). It is not marked `visible: false`,
 because before Strapi 5.45 the edit view crashes on a value whose attribute the
-admin does not know. Rename it with the plugin config
+admin does not know. It is kept out of the Content-Type Builder instead (the
+plugin wraps the builder's component reads), so saving a component there in
+`strapi develop` never writes it to the component's JSON file. With earlier
+versions (up to 2.0.0-alpha.8, and 1.0.0-alpha.8 on Strapi 4) the builder did
+write it (`"bsHidden": { "type": "boolean", "configurable": false, "default": false }`);
+a file that has it keeps working, and the builder keeps it there on later saves.
+To clean it up, delete that entry from the component JSON by hand (the plugin
+still adds the attribute at startup, so the column and its data stay). To check,
+edit a Dynamic Zone component in the builder (for example its display name),
+save, and diff its JSON file: only your change is there. Rename it with the plugin config
 `hiddenAttribute: 'myName'`, or set `hiddenAttribute: false` to add nothing (no
 eye, nothing stripped). A component that already has an attribute of that name
 with another type is skipped with a warning. Removing the plugin (or setting
@@ -777,8 +787,10 @@ same hook the i18n plugin uses), so nothing in the DOM is patched and the
 saved view configuration is never changed. Per field, the first that applies:
 
 1. **Project texts** from the plugin config `fields` (below);
-2. **a label set in "Configure the view"** (anything other than the attribute name);
-3. **the humanized name** when "Friendly field labels" is on: `mobileColumnsCount`
+2. **schema metadata**: `pluginOptions.blockscene` on the attribute, with its
+   translations (see [Describing blocks and fields in the schema](#describing-blocks-and-fields-in-the-schema));
+3. **a label set in "Configure the view"** (anything other than the attribute name);
+4. **the humanized name** when "Friendly field labels" is on: `mobileColumnsCount`
    reads "Mobile columns count", `page_seo` "Page seo", acronym runs stay
    (`pageSEO` "Page SEO", `ctaURL` "Cta URL").
 
@@ -838,6 +850,85 @@ content type turned off all leave the native labels; any error leaves the
 layout untouched. Changing the interface language applies from the next edit
 view.
 
+## Describing blocks and fields in the schema
+
+The same texts can live in the component and content type JSON files, next to
+what they describe, instead of the long `components` and `fields` config maps:
+
+```jsonc
+// src/components/sections/rich-text.json
+{
+  "collectionName": "components_sections_rich_texts",
+  "info": { "displayName": "Rich text", "description": "Formatted text with an optional title and anchor." },
+  "pluginOptions": { "blockscene": { "tags": ["Editorial"] } },
+  "attributes": {
+    "anchor": { "type": "string", "pluginOptions": { "blockscene": { "help": "Id for links to this block (#id), without the \"#\"." } } },
+    "text": { "type": "richtext" }
+  }
+}
+// src/components/shared/tag.json, attribute "label"
+"label": { "type": "string", "pluginOptions": { "blockscene": { "label": "Tag text", "help": "One or two words." } } }
+```
+
+- **Block**: the native `info.description` is the gallery description;
+  `pluginOptions.blockscene` takes `label`, `typology`, `tags`, `keywords` and
+  `image`, with the same rules as the `components` config entries.
+- **Field** (any content type or component attribute): `pluginOptions.blockscene`
+  takes `label` (up to 80 characters), `description` (300), `placeholder` (120)
+  and `help` (500), each a plain string in the source language, English.
+
+Other languages go in one flat file per locale, given to the plugin config:
+
+```js
+// config/plugins.js
+blockscene: { config: { translations: { 'pt-BR': require('./blockscene/pt-BR.json') } } },
+```
+
+```json
+{
+  "sections.rich-text": "Texto formatado",
+  "sections.rich-text.description": "Texto formatado com título e âncora opcionais.",
+  "sections.rich-text.anchor": "Âncora",
+  "sections.rich-text.anchor.help": "Id para links a este bloco (#id), sem o \"#\".",
+  "shared.tag.label": "Texto da tag"
+}
+```
+
+Keys are `<uid>` (block label, else the `displayName`), `<uid>.description`
+(block description), `<uid>.<attribute>` (field label) and
+`<uid>.<attribute>.<description|placeholder|help>`. A component attribute named
+`description` takes its label as `<uid>.description.label`. The admin picks the
+language as for the field labels above; a missing key shows the schema's
+English text, and a translated field label with no English one in the schema
+shows Strapi's own label in English.
+
+Precedence, per text: the plugin config (`components`, `fields`, and Settings
+for typology and tags) > schema metadata > native Strapi ("Configure the view"
+labels, `displayName`) > automatic (humanized names, guessed typology). The
+existing config keeps working unchanged. Everything is read once at boot:
+invalid values (a typology outside the list, a label over 80 characters, an
+unknown key) and translation keys naming no known block or field are left out,
+with one warning listing them by uid.
+
+**Content-Type Builder.** Tested on Strapi 5.52.1 and 4.26.1 in development
+mode: editing and saving a component in the Content-Type Builder keeps
+`pluginOptions.blockscene` (block and attributes) and `info.description`. It
+has no field for them, so add and change them in the JSON files.
+
+To move an existing config, from a clone of this repository (idempotent; each
+schema file keeps its indentation and key order; labels equal to what the
+plugin would show anyway, the humanized name or the `displayName`, are dropped):
+
+```bash
+node scripts/schema-metadata.mjs ../my-project/backend --fields fields.json --components components.json [--out dir] [--source en] [--dry-run]
+```
+
+`fields.json` and `components.json` hold the two config maps as JSON. The
+translation files go to `config/blockscene/<locale>.json`; the script lists
+what it could not place and the `components` keys that stay in the config
+(`variants`, `template`). Remove the migrated entries from the config
+afterwards: the config wins.
+
 ## Version history (Strapi 5)
 
 Off by default. Turn it on in Settings, Blockscene, "Version history" (or from

package/dist/admin.cjs

@@ -482,6 +482,11 @@ function localized(value, locale = "en") {
   const key = keys.find((k) => k.toLowerCase() === lower) ?? keys.find((k) => k.toLowerCase() === lang(lower)) ?? keys.find((k) => lang(k) === lang(lower)) ?? keys.find((k) => lang(k) === "en") ?? keys[0];
   return key === void 0 ? void 0 : value[key];
 }
+function localizeBlocks(catalog, locale) {
+  if (!catalog?.components) return catalog;
+  const text = (value) => localized(value, locale) ?? void 0;
+  return { ...catalog, components: Object.fromEntries(Object.entries(catalog.components).map(([uid, entry]) => [uid, entry && (typeof entry.label === "object" || typeof entry.description === "object") ? { ...entry, label: text(entry.label), description: text(entry.description) } : entry])) };
+}
 function fieldText(fields, owner, name, label, locale, on) {
   const entry = owner && fields?.[owner]?.[name] || {};
   const out = {};
@@ -489,7 +494,7 @@ function fieldText(fields, owner, name, label, locale, on) {
   if (text !== void 0) out.label = text;
   for (const key of ["description", "placeholder", "help"]) {
     const value = localized(entry[key], locale);
-    if (value !== void 0) out[key] = value;
+    if (value != null) out[key] = value;
   }
   return Object.keys(out).length ? out : null;
 }
@@ -6370,7 +6375,7 @@ function ZoneGallery({
     setConfig(null);
     setDetail(null);
     get("/blockscene/catalog").then(({ data }) => {
-      if (active) setConfig(data);
+      if (active) setConfig(localizeBlocks(data, t.locale));
     }).catch(() => {
       if (active) setError(t.failed);
     });
@@ -7053,6 +7058,14 @@ var EdgeButton = import_styled_components6.default.button`
 `;
 var HOVER_ATTR = "data-blockscene-hover";
 var HOVER_GRACE = 1200;
+var accordionCard = (row, ds) => {
+  const toggle = row.querySelector("button[aria-expanded]");
+  if (!toggle) return row;
+  if (ds === 2) return toggle.closest("div[data-state]:has(> h3)") || row;
+  for (let el = toggle.parentElement; el && el !== row; el = el.parentElement)
+    if (getComputedStyle(el).borderTopStyle !== "none") return el;
+  return row;
+};
 var Frame2 = import_styled_components6.default.iframe`
   position: absolute;
   top: 0;
@@ -7746,7 +7759,8 @@ function PagePreview({
     const item = hovered && active ? findZoneList(live.current.zoneLabel)?.querySelectorAll(":scope > li")[indexOf(hovered)] : void 0;
     hoverRow.current = item || null;
     if (!item) return setEdge(null);
-    item.setAttribute(HOVER_ATTR, "");
+    const card = accordionCard(item, host.ds);
+    card.setAttribute(HOVER_ATTR, "");
     const measure = () => {
       const r = item.getBoundingClientRect();
       setEdge(r.bottom < 0 ? "up" : r.top > window.innerHeight ? "down" : null);
@@ -7755,7 +7769,7 @@ function PagePreview({
     window.addEventListener("scroll", measure, true);
     window.addEventListener("resize", measure);
     return () => {
-      item.removeAttribute(HOVER_ATTR);
+      card.removeAttribute(HOVER_ATTR);
       window.removeEventListener("scroll", measure, true);
       window.removeEventListener("resize", measure);
     };
@@ -7824,7 +7838,7 @@ function PagePreview({
             },
             children: [
               /* @__PURE__ */ (0, import_jsx_runtime9.jsx)("style", { children: `${SPLIT_STYLE}
-[${HOVER_ATTR}] { outline: 2px solid ${theme?.colors?.primary600 || "#4945ff"}; outline-offset: 2px; border-radius: 4px; }
+[${HOVER_ATTR}] { ${host.ds === 2 ? `box-shadow: 0 0 0 1px ${theme?.colors?.primary600 || "#4945ff"};` : `border-color: ${theme?.colors?.primary600 || "#4945ff"} !important;`} }
 ${/* Strapi 4's scrolled header is fixed to the viewport's right edge: beside the pane in split mode, gone under it otherwise. */
               resizable ? "[data-strapi-header-sticky] { right: var(--bp-pane) !important; }" : "[data-strapi-header-sticky] { display: none !important; }"}` }),
               resizable && edge && /* @__PURE__ */ (0, import_jsx_runtime9.jsx)(
@@ -9460,8 +9474,8 @@ var cached = null;
 var pending = null;
 var flight = null;
 var load = (get) => flight || (flight = get("/blockscene/catalog").then(({ data }) => {
-  cached = data;
-  return data;
+  cached = localizeBlocks(data, adminLocale());
+  return cached;
 }).finally(() => {
   flight = null;
 }));

package/dist/admin.mjs

@@ -501,6 +501,11 @@ function localized(value, locale = "en") {
   const key = keys.find((k) => k.toLowerCase() === lower) ?? keys.find((k) => k.toLowerCase() === lang(lower)) ?? keys.find((k) => lang(k) === lang(lower)) ?? keys.find((k) => lang(k) === "en") ?? keys[0];
   return key === void 0 ? void 0 : value[key];
 }
+function localizeBlocks(catalog, locale) {
+  if (!catalog?.components) return catalog;
+  const text = (value) => localized(value, locale) ?? void 0;
+  return { ...catalog, components: Object.fromEntries(Object.entries(catalog.components).map(([uid, entry]) => [uid, entry && (typeof entry.label === "object" || typeof entry.description === "object") ? { ...entry, label: text(entry.label), description: text(entry.description) } : entry])) };
+}
 function fieldText(fields, owner, name, label, locale, on) {
   const entry = owner && fields?.[owner]?.[name] || {};
   const out = {};
@@ -508,7 +513,7 @@ function fieldText(fields, owner, name, label, locale, on) {
   if (text !== void 0) out.label = text;
   for (const key of ["description", "placeholder", "help"]) {
     const value = localized(entry[key], locale);
-    if (value !== void 0) out[key] = value;
+    if (value != null) out[key] = value;
   }
   return Object.keys(out).length ? out : null;
 }
@@ -6389,7 +6394,7 @@ function ZoneGallery({
     setConfig(null);
     setDetail(null);
     get("/blockscene/catalog").then(({ data }) => {
-      if (active) setConfig(data);
+      if (active) setConfig(localizeBlocks(data, t.locale));
     }).catch(() => {
       if (active) setError(t.failed);
     });
@@ -7072,6 +7077,14 @@ var EdgeButton = styled6.button`
 `;
 var HOVER_ATTR = "data-blockscene-hover";
 var HOVER_GRACE = 1200;
+var accordionCard = (row, ds) => {
+  const toggle = row.querySelector("button[aria-expanded]");
+  if (!toggle) return row;
+  if (ds === 2) return toggle.closest("div[data-state]:has(> h3)") || row;
+  for (let el = toggle.parentElement; el && el !== row; el = el.parentElement)
+    if (getComputedStyle(el).borderTopStyle !== "none") return el;
+  return row;
+};
 var Frame2 = styled6.iframe`
   position: absolute;
   top: 0;
@@ -7765,7 +7778,8 @@ function PagePreview({
     const item = hovered && active ? findZoneList(live.current.zoneLabel)?.querySelectorAll(":scope > li")[indexOf(hovered)] : void 0;
     hoverRow.current = item || null;
     if (!item) return setEdge(null);
-    item.setAttribute(HOVER_ATTR, "");
+    const card = accordionCard(item, host.ds);
+    card.setAttribute(HOVER_ATTR, "");
     const measure = () => {
       const r = item.getBoundingClientRect();
       setEdge(r.bottom < 0 ? "up" : r.top > window.innerHeight ? "down" : null);
@@ -7774,7 +7788,7 @@ function PagePreview({
     window.addEventListener("scroll", measure, true);
     window.addEventListener("resize", measure);
     return () => {
-      item.removeAttribute(HOVER_ATTR);
+      card.removeAttribute(HOVER_ATTR);
       window.removeEventListener("scroll", measure, true);
       window.removeEventListener("resize", measure);
     };
@@ -7843,7 +7857,7 @@ function PagePreview({
             },
             children: [
               /* @__PURE__ */ jsx9("style", { children: `${SPLIT_STYLE}
-[${HOVER_ATTR}] { outline: 2px solid ${theme?.colors?.primary600 || "#4945ff"}; outline-offset: 2px; border-radius: 4px; }
+[${HOVER_ATTR}] { ${host.ds === 2 ? `box-shadow: 0 0 0 1px ${theme?.colors?.primary600 || "#4945ff"};` : `border-color: ${theme?.colors?.primary600 || "#4945ff"} !important;`} }
 ${/* Strapi 4's scrolled header is fixed to the viewport's right edge: beside the pane in split mode, gone under it otherwise. */
               resizable ? "[data-strapi-header-sticky] { right: var(--bp-pane) !important; }" : "[data-strapi-header-sticky] { display: none !important; }"}` }),
               resizable && edge && /* @__PURE__ */ jsx9(
@@ -9490,8 +9504,8 @@ var cached = null;
 var pending = null;
 var flight = null;
 var load = (get) => flight || (flight = get("/blockscene/catalog").then(({ data }) => {
-  cached = data;
-  return data;
+  cached = localizeBlocks(data, adminLocale());
+  return cached;
 }).finally(() => {
   flight = null;
 }));

package/dist/server.cjs

@@ -302,6 +302,7 @@ var require_settings = __commonJS({
       }
       for (const [uid, schema] of Object.entries(config.schemas || {})) {
         const entry = entries[uid] ||= {};
+        for (const [key, value] of Object.entries(config.blocks?.[uid] || {})) if (entry[key] === void 0) entry[key] = value;
         entry.facets = facetsOf(uid, schema, config.schemas);
         entry.typology ||= guessTypology(uid, schema?.info?.displayName);
         entry.tags ||= [];
@@ -473,6 +474,70 @@ var require_settings = __commonJS({
       }
       return out;
     }
+    var str = (max) => (value) => typeof value === "string" && value.trim() !== "" && value.length <= max;
+    var BLOCK_META = { label: str(80), typology: (value) => TYPOLOGIES2.includes(value), tags: validTags, keywords: str(500), image: (value) => safeUrl2(value) !== void 0 };
+    var localize = (holder, key, source, locale, text2) => {
+      holder[key] = { ...plain(holder[key]) ? holder[key] : { en: holder[key] ?? source }, [locale]: text2 };
+    };
+    function schemaMetadata2(schemas = {}, translations = null, notes = []) {
+      const blocks = {}, fields = {};
+      const own = (holder, where) => {
+        const value = holder?.pluginOptions?.blockscene;
+        if (value === void 0 || plain(value)) return value || {};
+        notes.push(`${where}: pluginOptions.blockscene must be an object`);
+        return {};
+      };
+      for (const [uid, schema] of Object.entries(schemas)) {
+        if (!uid.includes("::")) {
+          const block = {};
+          for (const [key, value] of Object.entries(own(schema, uid))) {
+            if (!Object.hasOwn(BLOCK_META, key)) notes.push(`${uid}: unknown key "${key}"`);
+            else if (!BLOCK_META[key](value)) notes.push(`${uid}: invalid ${key}`);
+            else block[key] = key === "tags" ? cleanTags(value) : value;
+          }
+          if (typeof schema?.info?.description === "string" && schema.info.description.trim()) block.description = schema.info.description;
+          if (Object.keys(block).length) blocks[uid] = block;
+        }
+        for (const [name, attr] of Object.entries(schema?.attributes || {})) {
+          const texts = {};
+          for (const [key, value] of Object.entries(own(attr, `${uid}.${name}`))) {
+            if (!Object.hasOwn(FIELD_TEXT, key)) notes.push(`${uid}.${name}: unknown key "${key}"`);
+            else if (!str(FIELD_TEXT[key])(value)) notes.push(`${uid}.${name}: ${key} must be a string of 1 to ${FIELD_TEXT[key]} characters`);
+            else texts[key] = value;
+          }
+          if (Object.keys(texts).length) (fields[uid] ||= {})[name] = texts;
+        }
+      }
+      if (translations != null && !plain(translations)) {
+        notes.push('translations must be { "<locale>": { "<key>": text } }');
+        translations = null;
+      }
+      const stale = [];
+      for (const [locale, entries] of Object.entries(translations || {})) {
+        if (!LOCALE.test(locale) || !plain(entries) || JSON.stringify(entries).length > 256 * 1024) {
+          notes.push(`translations "${locale}" ignored: expected a locale code with a flat { "<key>": text } map under 256 KB`);
+          continue;
+        }
+        for (const [key, text2] of Object.entries(entries)) {
+          const uid = Object.keys(schemas).find((uid2) => key === uid2 || key.startsWith(`${uid2}.`));
+          const [name, part = "label", extra] = uid ? key.slice(uid.length + 1).split(".") : [];
+          const block = uid && !uid.includes("::");
+          const target = block && key === uid ? [blocks[uid] ||= {}, "label", schemas[uid]?.info?.displayName || uid, 80] : block && key === `${uid}.description` ? [blocks[uid] ||= {}, "description", null, 300] : uid && Object.hasOwn(schemas[uid]?.attributes || {}, name) && Object.hasOwn(FIELD_TEXT, part) && extra === void 0 ? [null, part, null, FIELD_TEXT[part]] : null;
+          if (!target) {
+            stale.push(`${locale} "${key}"`);
+            continue;
+          }
+          const [holder, field, source, max] = target;
+          if (!str(max)(text2)) {
+            notes.push(`translations ${locale} "${key}": a string of 1 to ${max} characters`);
+            continue;
+          }
+          localize(holder || ((fields[uid] ||= {})[name] ||= {}), field, source, locale, text2);
+        }
+      }
+      if (stale.length) notes.push(`translation keys naming no block or field were skipped: ${stale.slice(0, 20).join(", ")}${stale.length > 20 ? ` and ${stale.length - 20} more` : ""}`);
+      return { blocks, fields };
+    }
     var VARIANT = { id: /^[a-z0-9][a-z0-9_-]{0,39}$/, perComponent: 12, bytes: 16 * 1024, total: 256 * 1024, items: 100 };
     var text = (value) => typeof value === "string";
     var finite = (value) => typeof value === "number" && Number.isFinite(value);
@@ -566,7 +631,7 @@ var require_settings = __commonJS({
       return out;
     }
     var mergePrefs2 = (saved, componentUids2) => Object.fromEntries(Object.entries(PREFS).map(([key, max]) => [key, Array.isArray(saved?.[key]) ? [...new Set(saved[key].filter((uid) => componentUids2.includes(uid)))].slice(0, max) : []]));
-    module2.exports = { PLUGIN: PLUGIN2, HIDDEN_MODES, TEMPLATES: TEMPLATES2, TYPOLOGIES: TYPOLOGIES2, guessTypology, facetsOf, validatePrefs: validatePrefs2, mergePrefs: mergePrefs2, ICONS, DEFAULTS: DEFAULTS2, catalog: catalog2, validateSettings: validateSettings2, validateFields: validateFields2, validateVariants: validateVariants2, mergeSaved: mergeSaved2, layer: layer2, overrides: overrides2, safeUrl: safeUrl2, fail: fail2 };
+    module2.exports = { PLUGIN: PLUGIN2, HIDDEN_MODES, TEMPLATES: TEMPLATES2, TYPOLOGIES: TYPOLOGIES2, guessTypology, facetsOf, validatePrefs: validatePrefs2, mergePrefs: mergePrefs2, ICONS, DEFAULTS: DEFAULTS2, catalog: catalog2, validateSettings: validateSettings2, validateFields: validateFields2, validateVariants: validateVariants2, schemaMetadata: schemaMetadata2, mergeSaved: mergeSaved2, layer: layer2, overrides: overrides2, safeUrl: safeUrl2, fail: fail2 };
   }
 });
 
@@ -594,6 +659,22 @@ var require_hidden = __commonJS({
       }
       return { added, skipped };
     }
+    function hideFromBuilder2(services, uids, name) {
+      const has = new Set(uids);
+      const drop = (attributes) => Array.isArray(attributes) ? attributes.filter((attr) => attr?.name !== name) : attributes && typeof attributes === "object" ? Object.fromEntries(Object.entries(attributes).filter(([key]) => key !== name)) : attributes;
+      const extend = (uid, wrap) => {
+        if (services?.get?.(uid)) services.extend(uid, wrap);
+      };
+      extend("plugin::content-type-builder.components", (service) => ({ ...service, formatComponent(component, ...rest) {
+        const out = service.formatComponent(component, ...rest);
+        return has.has(component?.uid) && out?.schema ? { ...out, schema: { ...out.schema, attributes: drop(out.schema.attributes) } } : out;
+      } }));
+      extend("plugin::content-type-builder.schema", (service) => ({ ...service, async getSchema(...args) {
+        const out = await service.getSchema(...args);
+        for (const uid of has) if (out?.components?.[uid]) out.components[uid] = { ...out.components[uid], attributes: drop(out.components[uid].attributes) };
+        return out;
+      } }));
+    }
     function stripHidden(data, schema, schemaOf, name, depth = 0) {
       if (!data || typeof data !== "object" || !schema || depth > 20) return data;
       if (Array.isArray(data)) {
@@ -652,7 +733,7 @@ var require_hidden = __commonJS({
         }
       }));
     }
-    module2.exports = { DEFAULT_NAME, hiddenName: hiddenName2, zoneComponents, injectHidden: injectHidden2, stripHidden, registerHiddenStrip: registerHiddenStrip2 };
+    module2.exports = { DEFAULT_NAME, hiddenName: hiddenName2, zoneComponents, injectHidden: injectHidden2, hideFromBuilder: hideFromBuilder2, stripHidden, registerHiddenStrip: registerHiddenStrip2 };
   }
 });
 
@@ -1604,12 +1685,13 @@ var require_history = __commonJS({
 });
 
 // server/index.js
-var { PLUGIN, TEMPLATES, TYPOLOGIES, DEFAULTS, catalog, validateSettings, validateFields, validateVariants, mergeSaved, layer, overrides, validatePrefs, mergePrefs, safeUrl, fail } = require_settings();
+var { PLUGIN, TEMPLATES, TYPOLOGIES, DEFAULTS, catalog, validateSettings, validateFields, validateVariants, schemaMetadata, mergeSaved, layer, overrides, validatePrefs, mergePrefs, safeUrl, fail } = require_settings();
 var { safeGroups, validateGroups, layoutFields } = require_groups();
-var { hiddenName, injectHidden, registerHiddenStrip } = require_hidden();
+var { hiddenName, injectHidden, hideFromBuilder, registerHiddenStrip } = require_hidden();
 var { CRON, covers, eventContentType, historyService, historyController, registerHistory, registerPurge } = require_history();
 var { trashContentType, trashService, trashController } = require_trash();
 var STRAPI5 = true;
+var withHidden = [];
 var store = (strapi) => strapi.store({ type: "plugin", name: PLUGIN });
 var LEGACY_PLUGIN = "block-picker";
 async function readSettings(strapi) {
@@ -1730,6 +1812,9 @@ module.exports = {
       settings: null,
       // Edit view field texts from code (never stored): { uid: { attribute: { label, description, placeholder } } }. See README "Field labels".
       fields: null,
+      // Other languages for the schema metadata (pluginOptions.blockscene, info.description), one flat map per locale:
+      // { 'pt-BR': require('./blockscene/pt-BR.json') }. See README "Describing blocks and fields in the schema".
+      translations: null,
       // "Hide on the site": boolean attribute added to every Dynamic Zone component (a DB column); false adds nothing.
       hiddenAttribute: "bsHidden"
     },
@@ -1739,9 +1824,11 @@ module.exports = {
   register({ strapi }) {
     const plugin = strapi.plugin(PLUGIN);
     const name = hiddenName(plugin.config("hiddenAttribute"));
+    withHidden = [];
     if (name === null) strapi.log.warn(`[${PLUGIN}] "hiddenAttribute" config ignored: expected a name like "bsHidden" or false. Hiding blocks is off.`);
     if (!name) return;
-    const { skipped } = injectHidden(strapi.components, strapi.contentTypes, name);
+    const { added, skipped } = injectHidden(strapi.components, strapi.contentTypes, name);
+    withHidden = added;
     if (skipped.length) strapi.log.warn(`[${PLUGIN}] "${name}" already exists with another type on ${skipped.join(", ")}; those blocks cannot be hidden.`);
   },
   async bootstrap({ strapi }) {
@@ -1761,6 +1848,7 @@ module.exports = {
     strapi.plugin(PLUGIN).service("settings").variants();
     registerPublishGuard(strapi);
     registerHiddenStrip(strapi, hiddenName(strapi.plugin(PLUGIN).config("hiddenAttribute")), strapi.plugin(PLUGIN));
+    if (withHidden.length) hideFromBuilder(typeof strapi.get === "function" ? strapi.get("services") : strapi.container.get("services"), withHidden, hiddenName(strapi.plugin(PLUGIN).config("hiddenAttribute")));
     if (STRAPI5) {
       registerHistory(strapi);
       registerPurge(strapi);
@@ -1784,18 +1872,28 @@ module.exports = {
       }
       return project;
     };
+    let meta;
+    const schemaMeta = () => {
+      if (meta !== void 0) return meta;
+      const notes = [];
+      meta = schemaMetadata({ ...strapi.contentTypes, ...strapi.components }, strapi.plugin(PLUGIN).config("translations"), notes);
+      if (notes.length) strapi.log?.warn(`[${PLUGIN}] schema metadata left out: ${notes.slice(0, 20).join("; ")}${notes.length > 20 ? `; and ${notes.length - 20} more` : ""}.`);
+      return meta;
+    };
     let fields;
     const fieldTexts = () => {
       if (fields !== void 0) return fields;
       const schemas = Object.fromEntries(Object.entries({ ...strapi.contentTypes, ...strapi.components }).map(([uid, schema]) => [uid, Object.keys(schema?.attributes || {})]));
       const stale = [];
+      let code = {};
       try {
-        fields = validateFields(strapi.plugin(PLUGIN).config("fields"), schemas, stale);
+        code = validateFields(strapi.plugin(PLUGIN).config("fields"), schemas, stale);
       } catch (error) {
-        fields = {};
-        strapi.log?.warn(`[${PLUGIN}] "fields" config ignored: ${error.message}. Field labels fall back to the Content Manager's own.`);
+        strapi.log?.warn(`[${PLUGIN}] "fields" config ignored: ${error.message}. Field labels fall back to the schema metadata and the Content Manager's own.`);
       }
       if (stale.length) strapi.log?.warn(`[${PLUGIN}] "fields" entries for fields the schema no longer has were skipped: ${stale.slice(0, 20).join(", ")}${stale.length > 20 ? ` and ${stale.length - 20} more` : ""}.`);
+      fields = structuredClone(schemaMeta().fields);
+      for (const [uid, entries] of Object.entries(code)) for (const [name, entry] of Object.entries(entries)) (fields[uid] ||= {})[name] = { ...fields[uid][name], ...entry };
       return fields;
     };
     let variants;
@@ -1811,6 +1909,7 @@ module.exports = {
       projectDefaults,
       get,
       fields: fieldTexts,
+      schema: schemaMeta,
       variants: insertVariants,
       async set(value) {
         const next = validateSettings(value, componentUids(strapi), contentTypeUids(strapi), apiUids(strapi), strapi.components);
@@ -1840,7 +1939,8 @@ module.exports = {
           blockPreview: plugin.config("blockPreview"),
           groups: plugin.config("groups"),
           componentUids: componentUids(strapi),
-          schemas: strapi.components
+          schemas: strapi.components,
+          blocks: plugin.service("settings").schema().blocks
         });
         const settings = await plugin.service("settings").get();
         const media = await resolveMedia(strapi, settings);
@@ -1874,7 +1974,7 @@ module.exports = {
     settings: ({ strapi }) => ({
       async find(ctx) {
         const settings = await strapi.plugin(PLUGIN).service("settings").get();
-        const auto = catalog({ components: strapi.plugin(PLUGIN).config("components"), schemas: strapi.components }).components;
+        const auto = catalog({ components: strapi.plugin(PLUGIN).config("components"), schemas: strapi.components, blocks: strapi.plugin(PLUGIN).service("settings").schema().blocks }).components;
         const components = Object.entries(strapi.components || {}).map(([uid, schema]) => ({
           uid,
           displayName: schema.info?.displayName || uid,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aduptive/strapi-blockscene",
-  "version": "2.0.0-alpha.8",
+  "version": "2.0.0-alpha.9",
   "description": "Visual component gallery for native Strapi dynamic zones.",
   "license": "MIT",
   "author": "Andrea Scarpello <aduptive@gmail.com>",