blockly 7.20211209.2 → 8.0.0

package/core/common.js

@@ -17,7 +17,8 @@
  */
 goog.module('Blockly.common');
 
-const {Blocks} = goog.require('Blockly.blocks');
+/* eslint-disable-next-line no-unused-vars */
+const {BlockDefinition, Blocks} = goog.require('Blockly.blocks');
 /* eslint-disable-next-line no-unused-vars */
 const {Connection} = goog.requireType('Blockly.Connection');
 /* eslint-disable-next-line no-unused-vars */
@@ -210,27 +211,55 @@ const jsonInitFactory = function(jsonDef) {
  * @alias Blockly.common.defineBlocksWithJsonArray
  */
 const defineBlocksWithJsonArray = function(jsonArray) {
+  defineBlocks(createBlockDefinitionsFromJsonArray(jsonArray));
+};
+exports.defineBlocksWithJsonArray = defineBlocksWithJsonArray;
+
+/**
+ * Define blocks from an array of JSON block definitions, as might be generated
+ * by the Blockly Developer Tools.
+ * @param {!Array<!Object>} jsonArray An array of JSON block definitions.
+ * @return {!Object<string, !BlockDefinition>} A map of the block
+ *     definitions created.
+ * @alias Blockly.common.defineBlocksWithJsonArray
+ */
+const createBlockDefinitionsFromJsonArray = function(jsonArray) {
+  const /** @type {!Object<string,!BlockDefinition>} */ blocks = {};
   for (let i = 0; i < jsonArray.length; i++) {
     const elem = jsonArray[i];
     if (!elem) {
+      console.warn(`Block definition #${i} in JSON array is ${elem}. Skipping`);
+      continue;
+    }
+    const type = elem.type;
+    if (!type) {
       console.warn(
-          'Block definition #' + i + ' in JSON array is ' + elem + '. ' +
+          `Block definition #${i} in JSON array is missing a type attribute. ` +
           'Skipping.');
-    } else {
-      const typename = elem.type;
-      if (!typename) {
-        console.warn(
-            'Block definition #' + i +
-            ' in JSON array is missing a type attribute. Skipping.');
-      } else {
-        if (Blocks[typename]) {
-          console.warn(
-              'Block definition #' + i + ' in JSON array' +
-              ' overwrites prior definition of "' + typename + '".');
-        }
-        Blocks[typename] = {init: jsonInitFactory(elem)};
-      }
+      continue;
     }
+    blocks[type] = {init: jsonInitFactory(elem)};
   }
+  return blocks;
 };
-exports.defineBlocksWithJsonArray = defineBlocksWithJsonArray;
+exports.createBlockDefinitionsFromJsonArray =
+    createBlockDefinitionsFromJsonArray;
+
+/**
+ * Add the specified block definitions to the block definitions
+ * dictionary (Blockly.Blocks).
+ * @param {!Object<string,!BlockDefinition>} blocks A map of block
+ *     type names to block definitions.
+ * @alias Blockly.common.defineBlocks
+ */
+const defineBlocks = function(blocks) {
+  // Iterate over own enumerable properties.
+  for (const type of Object.keys(blocks)) {
+    const definition = blocks[type];
+    if (type in Blocks) {
+      console.warn(`Block definiton "${type}" overwrites previous definition.`);
+    }
+    Blocks[type] = definition;
+  }
+};
+exports.defineBlocks = defineBlocks;

package/core/component_manager.js

@@ -31,210 +31,217 @@ const {IPositionable} = goog.requireType('Blockly.IPositionable');
 
 /**
  * Manager for all items registered with the workspace.
- * @constructor
  * @alias Blockly.ComponentManager
  */
-const ComponentManager = function() {
+class ComponentManager {
   /**
-   * A map of the components registered with the workspace, mapped to id.
-   * @type {!Object<string, !ComponentManager.ComponentDatum>}
-   * @private
+   * Creates a new ComponentManager instance.
    */
-  this.componentData_ = Object.create(null);
+  constructor() {
+    /**
+     * A map of the components registered with the workspace, mapped to id.
+     * @type {!Object<string, !ComponentManager.ComponentDatum>}
+     * @private
+     */
+    this.componentData_ = Object.create(null);
+
+    /**
+     * A map of capabilities to component IDs.
+     * @type {!Object<string, !Array<string>>}
+     * @private
+     */
+    this.capabilityToComponentIds_ = Object.create(null);
+  }
 
   /**
-   * A map of capabilities to component IDs.
-   * @type {!Object<string, !Array<string>>}
-   * @private
+   * Adds a component.
+   * @param {!ComponentManager.ComponentDatum} componentInfo The data for
+   *   the component to register.
+   * @param {boolean=} opt_allowOverrides True to prevent an error when
+   *     overriding an already registered item.
    */
-  this.capabilityToComponentIds_ = Object.create(null);
-};
-
-/**
- * An object storing component information.
- * @typedef {{
- *    component: !IComponent,
- *    capabilities: (
- *     !Array<string|!ComponentManager.Capability<!IComponent>>
- *       ),
- *    weight: number
- *  }}
- */
-ComponentManager.ComponentDatum;
-
-/**
- * Adds a component.
- * @param {!ComponentManager.ComponentDatum} componentInfo The data for
- *   the component to register.
- * @param {boolean=} opt_allowOverrides True to prevent an error when overriding
- *     an already registered item.
- */
-ComponentManager.prototype.addComponent = function(
-    componentInfo, opt_allowOverrides) {
-  // Don't throw an error if opt_allowOverrides is true.
-  const id = componentInfo.component.id;
-  if (!opt_allowOverrides && this.componentData_[id]) {
-    throw Error(
-        'Plugin "' + id + '" with capabilities "' +
-        this.componentData_[id].capabilities + '" already added.');
+  addComponent(componentInfo, opt_allowOverrides) {
+    // Don't throw an error if opt_allowOverrides is true.
+    const id = componentInfo.component.id;
+    if (!opt_allowOverrides && this.componentData_[id]) {
+      throw Error(
+          'Plugin "' + id + '" with capabilities "' +
+          this.componentData_[id].capabilities + '" already added.');
+    }
+    this.componentData_[id] = componentInfo;
+    const stringCapabilities = [];
+    for (let i = 0; i < componentInfo.capabilities.length; i++) {
+      const capability = String(componentInfo.capabilities[i]).toLowerCase();
+      stringCapabilities.push(capability);
+      if (this.capabilityToComponentIds_[capability] === undefined) {
+        this.capabilityToComponentIds_[capability] = [id];
+      } else {
+        this.capabilityToComponentIds_[capability].push(id);
+      }
+    }
+    this.componentData_[id].capabilities = stringCapabilities;
   }
-  this.componentData_[id] = componentInfo;
-  const stringCapabilities = [];
-  for (let i = 0; i < componentInfo.capabilities.length; i++) {
-    const capability = String(componentInfo.capabilities[i]).toLowerCase();
-    stringCapabilities.push(capability);
-    if (this.capabilityToComponentIds_[capability] === undefined) {
-      this.capabilityToComponentIds_[capability] = [id];
-    } else {
-      this.capabilityToComponentIds_[capability].push(id);
+
+  /**
+   * Removes a component.
+   * @param {string} id The ID of the component to remove.
+   */
+  removeComponent(id) {
+    const componentInfo = this.componentData_[id];
+    if (!componentInfo) {
+      return;
+    }
+    for (let i = 0; i < componentInfo.capabilities.length; i++) {
+      const capability = String(componentInfo.capabilities[i]).toLowerCase();
+      arrayUtils.removeElem(this.capabilityToComponentIds_[capability], id);
     }
+    delete this.componentData_[id];
   }
-  this.componentData_[id].capabilities = stringCapabilities;
-};
 
-/**
- * Removes a component.
- * @param {string} id The ID of the component to remove.
- */
-ComponentManager.prototype.removeComponent = function(id) {
-  const componentInfo = this.componentData_[id];
-  if (!componentInfo) {
-    return;
+  /**
+   * Adds a capability to a existing registered component.
+   * @param {string} id The ID of the component to add the capability to.
+   * @param {string|!ComponentManager.Capability<T>} capability The
+   *     capability to add.
+   * @template T
+   */
+  addCapability(id, capability) {
+    if (!this.getComponent(id)) {
+      throw Error(
+          'Cannot add capability, "' + capability + '". Plugin "' + id +
+          '" has not been added to the ComponentManager');
+    }
+    if (this.hasCapability(id, capability)) {
+      console.warn(
+          'Plugin "' + id + 'already has capability "' + capability + '"');
+      return;
+    }
+    capability = String(capability).toLowerCase();
+    this.componentData_[id].capabilities.push(capability);
+    this.capabilityToComponentIds_[capability].push(id);
   }
-  for (let i = 0; i < componentInfo.capabilities.length; i++) {
-    const capability = String(componentInfo.capabilities[i]).toLowerCase();
+
+  /**
+   * Removes a capability from an existing registered component.
+   * @param {string} id The ID of the component to remove the capability from.
+   * @param {string|!ComponentManager.Capability<T>} capability The
+   *     capability to remove.
+   * @template T
+   */
+  removeCapability(id, capability) {
+    if (!this.getComponent(id)) {
+      throw Error(
+          'Cannot remove capability, "' + capability + '". Plugin "' + id +
+          '" has not been added to the ComponentManager');
+    }
+    if (!this.hasCapability(id, capability)) {
+      console.warn(
+          'Plugin "' + id + 'doesn\'t have capability "' + capability +
+          '" to remove');
+      return;
+    }
+    capability = String(capability).toLowerCase();
+    arrayUtils.removeElem(this.componentData_[id].capabilities, capability);
     arrayUtils.removeElem(this.capabilityToComponentIds_[capability], id);
   }
-  delete this.componentData_[id];
-};
 
-/**
- * Adds a capability to a existing registered component.
- * @param {string} id The ID of the component to add the capability to.
- * @param {string|!ComponentManager.Capability<T>} capability The
- *     capability to add.
- * @template T
- */
-ComponentManager.prototype.addCapability = function(id, capability) {
-  if (!this.getComponent(id)) {
-    throw Error(
-        'Cannot add capability, "' + capability + '". Plugin "' + id +
-        '" has not been added to the ComponentManager');
-  }
-  if (this.hasCapability(id, capability)) {
-    console.warn(
-        'Plugin "' + id + 'already has capability "' + capability + '"');
-    return;
+  /**
+   * Returns whether the component with this id has the specified capability.
+   * @param {string} id The ID of the component to check.
+   * @param {string|!ComponentManager.Capability<T>} capability The
+   *     capability to check for.
+   * @return {boolean} Whether the component has the capability.
+   * @template T
+   */
+  hasCapability(id, capability) {
+    capability = String(capability).toLowerCase();
+    return this.componentData_[id].capabilities.indexOf(capability) !== -1;
   }
-  capability = String(capability).toLowerCase();
-  this.componentData_[id].capabilities.push(capability);
-  this.capabilityToComponentIds_[capability].push(id);
-};
 
-/**
- * Removes a capability from an existing registered component.
- * @param {string} id The ID of the component to remove the capability from.
- * @param {string|!ComponentManager.Capability<T>} capability The
- *     capability to remove.
- * @template T
- */
-ComponentManager.prototype.removeCapability = function(id, capability) {
-  if (!this.getComponent(id)) {
-    throw Error(
-        'Cannot remove capability, "' + capability + '". Plugin "' + id +
-        '" has not been added to the ComponentManager');
-  }
-  if (!this.hasCapability(id, capability)) {
-    console.warn(
-        'Plugin "' + id + 'doesn\'t have capability "' + capability +
-        '" to remove');
-    return;
+  /**
+   * Gets the component with the given ID.
+   * @param {string} id The ID of the component to get.
+   * @return {!IComponent|undefined} The component with the given name
+   *    or undefined if not found.
+   */
+  getComponent(id) {
+    return this.componentData_[id] && this.componentData_[id].component;
   }
-  capability = String(capability).toLowerCase();
-  arrayUtils.removeElem(this.componentData_[id].capabilities, capability);
-  arrayUtils.removeElem(this.capabilityToComponentIds_[capability], id);
-};
-
-/**
- * Returns whether the component with this id has the specified capability.
- * @param {string} id The ID of the component to check.
- * @param {string|!ComponentManager.Capability<T>} capability The
- *     capability to check for.
- * @return {boolean} Whether the component has the capability.
- * @template T
- */
-ComponentManager.prototype.hasCapability = function(id, capability) {
-  capability = String(capability).toLowerCase();
-  return this.componentData_[id].capabilities.indexOf(capability) !== -1;
-};
 
-/**
- * Gets the component with the given ID.
- * @param {string} id The ID of the component to get.
- * @return {!IComponent|undefined} The component with the given name
- *    or undefined if not found.
- */
-ComponentManager.prototype.getComponent = function(id) {
-  return this.componentData_[id] && this.componentData_[id].component;
-};
+  /**
+   * Gets all the components with the specified capability.
+   * @param {string|!ComponentManager.Capability<T>
+   *   } capability The capability of the component.
+   * @param {boolean} sorted Whether to return list ordered by weights.
+   * @return {!Array<T>} The components that match the specified capability.
+   * @template T
+   */
+  getComponents(capability, sorted) {
+    capability = String(capability).toLowerCase();
+    const componentIds = this.capabilityToComponentIds_[capability];
+    if (!componentIds) {
+      return [];
+    }
+    const components = [];
+    if (sorted) {
+      const componentDataList = [];
+      const componentData = this.componentData_;
+      componentIds.forEach(function(id) {
+        componentDataList.push(componentData[id]);
+      });
+      componentDataList.sort(function(a, b) {
+        return a.weight - b.weight;
+      });
+      componentDataList.forEach(function(ComponentDatum) {
+        components.push(ComponentDatum.component);
+      });
+    } else {
+      const componentData = this.componentData_;
+      componentIds.forEach(function(id) {
+        components.push(componentData[id].component);
+      });
+    }
+    return components;
+  }
+}
 
 /**
- * Gets all the components with the specified capability.
- * @param {string|!ComponentManager.Capability<T>
- *   } capability The capability of the component.
- * @param {boolean} sorted Whether to return list ordered by weights.
- * @return {!Array<T>} The components that match the specified capability.
- * @template T
+ * An object storing component information.
+ * @typedef {{
+ *    component: !IComponent,
+ *    capabilities: (
+ *     !Array<string|!ComponentManager.Capability<!IComponent>>
+ *       ),
+ *    weight: number
+ *  }}
  */
-ComponentManager.prototype.getComponents = function(capability, sorted) {
-  capability = String(capability).toLowerCase();
-  const componentIds = this.capabilityToComponentIds_[capability];
-  if (!componentIds) {
-    return [];
-  }
-  const components = [];
-  if (sorted) {
-    const componentDataList = [];
-    const componentData = this.componentData_;
-    componentIds.forEach(function(id) {
-      componentDataList.push(componentData[id]);
-    });
-    componentDataList.sort(function(a, b) {
-      return a.weight - b.weight;
-    });
-    componentDataList.forEach(function(ComponentDatum) {
-      components.push(ComponentDatum.component);
-    });
-  } else {
-    const componentData = this.componentData_;
-    componentIds.forEach(function(id) {
-      components.push(componentData[id].component);
-    });
-  }
-  return components;
-};
+ComponentManager.ComponentDatum;
 
 /**
  * A name with the capability of the element stored in the generic.
- * @param {string} name The name of the component capability.
- * @constructor
  * @template T
+ * @alias Blockly.ComponentManager.Capability
  */
-ComponentManager.Capability = function(name) {
+ComponentManager.Capability = class {
   /**
-   * @type {string}
-   * @private
+   * @param {string} name The name of the component capability.
    */
-  this.name_ = name;
-};
+  constructor(name) {
+    /**
+     * @type {string}
+     * @private
+     */
+    this.name_ = name;
+  }
 
-/**
- * Returns the name of the capability.
- * @return {string} The name.
- * @override
- */
-ComponentManager.Capability.prototype.toString = function() {
-  return this.name_;
+  /**
+   * Returns the name of the capability.
+   * @return {string} The name.
+   * @override
+   */
+  toString() {
+    return this.name_;
+  }
 };
 
 /** @type {!ComponentManager.Capability<!IPositionable>} */

package/core/config.js

@@ -0,0 +1,87 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview All the values that we expect developers to be able to change
+ * before injecting Blockly. Changing these values during run time is not
+ * generally recommended.
+ */
+'use strict';
+
+/**
+ * All the values that we expect developers to be able to change
+ * before injecting Blockly. Changing these values during run time is not
+ * generally recommended.
+ * @namespace Blockly.config
+ */
+goog.module('Blockly.config');
+
+
+/**
+ * All the values that we expect developers to be able to change
+ * before injecting Blockly.
+ * @typedef {{
+ *      dragRadius: number,
+ *      flyoutDragRadius: number,
+ *      snapRadius: number,
+ *      currentConnectionPreference: number,
+ *      bumpDelay: number,
+ *      connectingSnapRadius: number
+ *    }}
+ */
+let Config;  // eslint-disable-line no-unused-vars
+
+/**
+ * Default snap radius.
+ * @type {number}
+ */
+const DEFAULT_SNAP_RADIUS = 28;
+
+/**
+ * Object holding all the values on Blockly that we expect developers to be
+ * able to change.
+ * @type {Config}
+ */
+const config = {
+  /**
+   * Number of pixels the mouse must move before a drag starts.
+   * @alias Blockly.config.dragRadius
+   */
+  dragRadius: 5,
+  /**
+   * Number of pixels the mouse must move before a drag/scroll starts from the
+   * flyout.  Because the drag-intention is determined when this is reached, it
+   * is larger than dragRadius so that the drag-direction is clearer.
+   * @alias Blockly.config.flyoutDragRadius
+   */
+  flyoutDragRadius: 10,
+  /**
+   * Maximum misalignment between connections for them to snap together.
+   * @alias Blockly.config.snapRadius
+   */
+  snapRadius: DEFAULT_SNAP_RADIUS,
+  /**
+   * Maximum misalignment between connections for them to snap together.
+   * This should be the same as the snap radius.
+   * @alias Blockly.config.connectingSnapRadius
+   */
+  connectingSnapRadius: DEFAULT_SNAP_RADIUS,
+  /**
+   * How much to prefer staying connected to the current connection over moving
+   * to a new connection.  The current previewed connection is considered to be
+   * this much closer to the matching connection on the block than it actually
+   * is.
+   * @alias Blockly.config.currentConnectionPreference
+   */
+  currentConnectionPreference: 8,
+  /**
+   * Delay in ms between trigger and bumping unconnected block out of alignment.
+   * @alias Blockly.config.bumpDelay
+   */
+  bumpDelay: 250,
+};
+
+exports.config = config;