@wordpress/blocks/build-module/store/process-block-type.js

Block API for WordPress.

// packages/blocks/src/store/process-block-type.js
import { isPlainObject } from "is-plain-object";
import { isValidElementType } from "react-is";
import deprecated from "@wordpress/deprecated";
import { applyFilters } from "@wordpress/hooks";
import warning from "@wordpress/warning";
import { isValidIcon, normalizeIconObject, omit } from "../api/utils";
import { BLOCK_ICON_DEFAULT, DEPRECATED_ENTRY_KEYS } from "../api/constants";
var LEGACY_CATEGORY_MAPPING = {
  common: "text",
  formatting: "text",
  layout: "design"
};
function mergeBlockVariations(bootstrappedVariations = [], clientVariations = []) {
  const result = [...bootstrappedVariations];
  clientVariations.forEach((clientVariation) => {
    const index = result.findIndex(
      (bootstrappedVariation) => bootstrappedVariation.name === clientVariation.name
    );
    if (index !== -1) {
      result[index] = { ...result[index], ...clientVariation };
    } else {
      result.push(clientVariation);
    }
  });
  return result;
}
var processBlockType = (name, blockSettings) => ({ select }) => {
  const bootstrappedBlockType = select.getBootstrappedBlockType(name);
  const blockType = {
    apiVersion: 1,
    name,
    icon: BLOCK_ICON_DEFAULT,
    keywords: [],
    attributes: {},
    providesContext: {},
    usesContext: [],
    selectors: {},
    supports: {},
    styles: [],
    blockHooks: {},
    save: () => null,
    ...bootstrappedBlockType,
    ...blockSettings,
    // blockType.variations can be defined as a filePath.
    variations: mergeBlockVariations(
      Array.isArray(bootstrappedBlockType?.variations) ? bootstrappedBlockType.variations : [],
      Array.isArray(blockSettings?.variations) ? blockSettings.variations : []
    )
  };
  if (!blockType.attributes || typeof blockType.attributes !== "object") {
    warning(
      'The block "' + name + '" is registering attributes as `null` or `undefined`. Use an empty object (`attributes: {}`) or exclude the `attributes` key.'
    );
    blockType.attributes = {};
  }
  const settings = applyFilters(
    "blocks.registerBlockType",
    blockType,
    name,
    null
  );
  if (settings.apiVersion <= 2) {
    warning(
      `The block "${name}" is registered with API version 2 or lower. This means that the post editor may work as a non-iframe editor.
Since all editors are planned to work as iframes in the future, set the \`apiVersion\` field to 3 and test the block inside the iframe editor.
See: https://developer.wordpress.org/block-editor/reference-guides/block-api/block-api-versions/#version-3-wordpress-6-3`
    );
  }
  if (settings.description && typeof settings.description !== "string") {
    deprecated("Declaring non-string block descriptions", {
      since: "6.2"
    });
  }
  if (settings.deprecated) {
    settings.deprecated = settings.deprecated.map(
      (deprecation) => Object.fromEntries(
        Object.entries(
          // Only keep valid deprecation keys.
          applyFilters(
            "blocks.registerBlockType",
            // Merge deprecation keys with pre-filter settings
            // so that filters that depend on specific keys being
            // present don't fail.
            {
              // Omit deprecation keys here so that deprecations
              // can opt out of specific keys like "supports".
              ...omit(blockType, DEPRECATED_ENTRY_KEYS),
              ...deprecation
            },
            blockType.name,
            deprecation
          )
        ).filter(
          ([key]) => DEPRECATED_ENTRY_KEYS.includes(key)
        )
      )
    );
  }
  if (!isPlainObject(settings)) {
    warning("Block settings must be a valid object.");
    return;
  }
  if (typeof settings.save !== "function") {
    warning('The "save" property must be a valid function.');
    return;
  }
  if ("edit" in settings && !isValidElementType(settings.edit)) {
    warning('The "edit" property must be a valid component.');
    return;
  }
  if (LEGACY_CATEGORY_MAPPING.hasOwnProperty(settings.category)) {
    settings.category = LEGACY_CATEGORY_MAPPING[settings.category];
  }
  if ("category" in settings && !select.getCategories().some(({ slug }) => slug === settings.category)) {
    warning(
      'The block "' + name + '" is registered with an invalid category "' + settings.category + '".'
    );
    delete settings.category;
  }
  if (!("title" in settings) || settings.title === "") {
    warning('The block "' + name + '" must have a title.');
    return;
  }
  if (typeof settings.title !== "string") {
    warning("Block titles must be strings.");
    return;
  }
  settings.icon = normalizeIconObject(settings.icon);
  if (!isValidIcon(settings.icon.src)) {
    warning(
      "The icon passed is invalid. The icon should be a string, an element, a function, or an object following the specifications documented in https://developer.wordpress.org/block-editor/developers/block-api/block-registration/#icon-optional"
    );
    return;
  }
  if (typeof settings?.parent === "string" || settings?.parent instanceof String) {
    settings.parent = [settings.parent];
    warning(
      "Parent must be undefined or an array of strings (block types), but it is a string."
    );
  }
  if (!Array.isArray(settings?.parent) && settings?.parent !== void 0) {
    warning(
      "Parent must be undefined or an array of block types, but it is ",
      settings.parent
    );
    return;
  }
  if (1 === settings?.parent?.length && name === settings.parent[0]) {
    warning(
      'Block "' + name + '" cannot be a parent of itself. Please remove the block name from the parent list.'
    );
    return;
  }
  return settings;
};
export {
  processBlockType
};
//# sourceMappingURL=process-block-type.js.map