blockly 8.20220331.0-beta.0 → 9.0.0-beta.1

package/core/events/events.js

@@ -1,147 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of actions in Blockly's editor.
- */
-'use strict';
-
-/**
- * Events fired as a result of actions in Blockly's editor.
- * @namespace Blockly.Events
- */
-goog.module('Blockly.Events');
-
-const deprecation = goog.require('Blockly.utils.deprecation');
-const eventUtils = goog.require('Blockly.Events.utils');
-const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
-const {BlockBase} = goog.require('Blockly.Events.BlockBase');
-const {BlockChange} = goog.require('Blockly.Events.BlockChange');
-const {BlockCreate} = goog.require('Blockly.Events.BlockCreate');
-const {BlockDelete} = goog.require('Blockly.Events.BlockDelete');
-const {BlockDrag} = goog.require('Blockly.Events.BlockDrag');
-const {BlockMove} = goog.require('Blockly.Events.BlockMove');
-const {BubbleOpen} = goog.require('Blockly.Events.BubbleOpen');
-const {Click} = goog.require('Blockly.Events.Click');
-const {CommentBase} = goog.require('Blockly.Events.CommentBase');
-const {CommentChange} = goog.require('Blockly.Events.CommentChange');
-const {CommentCreate} = goog.require('Blockly.Events.CommentCreate');
-const {CommentDelete} = goog.require('Blockly.Events.CommentDelete');
-const {CommentMove} = goog.require('Blockly.Events.CommentMove');
-const {FinishedLoading} = goog.require('Blockly.Events.FinishedLoading');
-const {MarkerMove} = goog.require('Blockly.Events.MarkerMove');
-const {Selected} = goog.require('Blockly.Events.Selected');
-const {ThemeChange} = goog.require('Blockly.Events.ThemeChange');
-const {ToolboxItemSelect} = goog.require('Blockly.Events.ToolboxItemSelect');
-const {TrashcanOpen} = goog.require('Blockly.Events.TrashcanOpen');
-const {UiBase} = goog.require('Blockly.Events.UiBase');
-const {Ui} = goog.require('Blockly.Events.Ui');
-const {VarBase} = goog.require('Blockly.Events.VarBase');
-const {VarCreate} = goog.require('Blockly.Events.VarCreate');
-const {VarDelete} = goog.require('Blockly.Events.VarDelete');
-const {VarRename} = goog.require('Blockly.Events.VarRename');
-const {ViewportChange} = goog.require('Blockly.Events.ViewportChange');
-
-
-// Events.
-exports.Abstract = AbstractEvent;
-exports.BubbleOpen = BubbleOpen;
-exports.BlockBase = BlockBase;
-exports.BlockChange = BlockChange;
-exports.BlockCreate = BlockCreate;
-exports.BlockDelete = BlockDelete;
-exports.BlockDrag = BlockDrag;
-exports.BlockMove = BlockMove;
-exports.Click = Click;
-exports.CommentBase = CommentBase;
-exports.CommentChange = CommentChange;
-exports.CommentCreate = CommentCreate;
-exports.CommentDelete = CommentDelete;
-exports.CommentMove = CommentMove;
-exports.FinishedLoading = FinishedLoading;
-exports.MarkerMove = MarkerMove;
-exports.Selected = Selected;
-exports.ThemeChange = ThemeChange;
-exports.ToolboxItemSelect = ToolboxItemSelect;
-exports.TrashcanOpen = TrashcanOpen;
-exports.Ui = Ui;
-exports.UiBase = UiBase;
-exports.VarBase = VarBase;
-exports.VarCreate = VarCreate;
-exports.VarDelete = VarDelete;
-exports.VarRename = VarRename;
-exports.ViewportChange = ViewportChange;
-
-// Event types.
-exports.BLOCK_CHANGE = eventUtils.BLOCK_CHANGE;
-exports.BLOCK_CREATE = eventUtils.BLOCK_CREATE;
-exports.BLOCK_DELETE = eventUtils.BLOCK_DELETE;
-exports.BLOCK_DRAG = eventUtils.BLOCK_DRAG;
-exports.BLOCK_MOVE = eventUtils.BLOCK_MOVE;
-exports.BUBBLE_OPEN = eventUtils.BUBBLE_OPEN;
-exports.BumpEvent = eventUtils.BumpEvent;
-exports.BUMP_EVENTS = eventUtils.BUMP_EVENTS;
-exports.CHANGE = eventUtils.CHANGE;
-exports.CLICK = eventUtils.CLICK;
-exports.COMMENT_CHANGE = eventUtils.COMMENT_CHANGE;
-exports.COMMENT_CREATE = eventUtils.COMMENT_CREATE;
-exports.COMMENT_DELETE = eventUtils.COMMENT_DELETE;
-exports.COMMENT_MOVE = eventUtils.COMMENT_MOVE;
-exports.CREATE = eventUtils.CREATE;
-exports.DELETE = eventUtils.DELETE;
-exports.FINISHED_LOADING = eventUtils.FINISHED_LOADING;
-exports.MARKER_MOVE = eventUtils.MARKER_MOVE;
-exports.MOVE = eventUtils.MOVE;
-exports.SELECTED = eventUtils.SELECTED;
-exports.THEME_CHANGE = eventUtils.THEME_CHANGE;
-exports.TOOLBOX_ITEM_SELECT = eventUtils.TOOLBOX_ITEM_SELECT;
-exports.TRASHCAN_OPEN = eventUtils.TRASHCAN_OPEN;
-exports.UI = eventUtils.UI;
-exports.VAR_CREATE = eventUtils.VAR_CREATE;
-exports.VAR_DELETE = eventUtils.VAR_DELETE;
-exports.VAR_RENAME = eventUtils.VAR_RENAME;
-exports.VIEWPORT_CHANGE = eventUtils.VIEWPORT_CHANGE;
-
-// Event utils.
-exports.clearPendingUndo = eventUtils.clearPendingUndo;
-exports.disable = eventUtils.disable;
-exports.enable = eventUtils.enable;
-exports.filter = eventUtils.filter;
-exports.fire = eventUtils.fire;
-exports.fromJson = eventUtils.fromJson;
-exports.getDescendantIds = eventUtils.getDescendantIds;
-exports.get = eventUtils.get;
-exports.getGroup = eventUtils.getGroup;
-exports.getRecordUndo = eventUtils.getRecordUndo;
-exports.isEnabled = eventUtils.isEnabled;
-exports.setGroup = eventUtils.setGroup;
-exports.setRecordUndo = eventUtils.setRecordUndo;
-exports.disableOrphans = eventUtils.disableOrphans;
-
-Object.defineProperties(exports, {
-  /**
-   * Sets whether the next event should be added to the undo stack.
-   * @name Blockly.Evenents.recordUndo
-   * @type {boolean}
-   * @deprecated Use Blockly.Events.getRecordUndo() and
-   *     .setRecordUndo().  (September 2021)
-   * @suppress {checkTypes}
-   */
-  recordUndo: {
-    get: function() {
-      deprecation.warn(
-          'Blockly.Events.recordUndo', 'September 2021', 'September 2022',
-          'Blockly.Events.getRecordUndo()');
-      return eventUtils.getRecordUndo();
-    },
-    set: function(record) {
-      deprecation.warn(
-          'Blockly.Events.recordUndo', 'September 2021', 'September 2022',
-          'Blockly.Events.setRecordUndo()');
-      eventUtils.setRecordUndo(record);
-    },
-  },
-});

package/core/events/events_abstract.js

@@ -1,133 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Abstract class for events fired as a result of actions in
- * Blockly's editor.
- */
-'use strict';
-
-/**
- * Abstract class for events fired as a result of actions in
- * Blockly's editor.
- * @class
- */
-goog.module('Blockly.Events.Abstract');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-/* eslint-disable-next-line no-unused-vars */
-const {Workspace} = goog.requireType('Blockly.Workspace');
-
-
-/**
- * Abstract class for an event.
- * @abstract
- * @alias Blockly.Events.Abstract
- */
-class Abstract {
-  /**
-   * @alias Blockly.Events.Abstract
-   */
-  constructor() {
-    /**
-     * Whether or not the event is blank (to be populated by fromJson).
-     * @type {?boolean}
-     */
-    this.isBlank = null;
-
-    /**
-     * The workspace identifier for this event.
-     * @type {string|undefined}
-     */
-    this.workspaceId = undefined;
-
-    /**
-     * The event group id for the group this event belongs to. Groups define
-     * events that should be treated as an single action from the user's
-     * perspective, and should be undone together.
-     * @type {string}
-     */
-    this.group = eventUtils.getGroup();
-
-    /**
-     * Sets whether the event should be added to the undo stack.
-     * @type {boolean}
-     */
-    this.recordUndo = eventUtils.getRecordUndo();
-
-    /**
-     * Whether or not the event is a UI event.
-     * @type {boolean}
-     */
-    this.isUiEvent = false;
-
-    /**
-     * Type of this event.
-     * @type {string|undefined}
-     */
-    this.type = undefined;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = {'type': this.type};
-    if (this.group) {
-      json['group'] = this.group;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    this.isBlank = false;
-    this.group = json['group'];
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return {boolean} True if null, false if something changed.
-   */
-  isNull() {
-    return false;
-  }
-
-  /**
-   * Run an event.
-   * @param {boolean} _forward True if run forward, false if run backward
-   *     (undo).
-   */
-  run(_forward) {
-    // Defined by subclasses.
-  }
-
-  /**
-   * Get workspace the event belongs to.
-   * @return {!Workspace} The workspace the event belongs to.
-   * @throws {Error} if workspace is null.
-   * @protected
-   */
-  getEventWorkspace_() {
-    let workspace;
-    if (this.workspaceId) {
-      const {Workspace} = goog.module.get('Blockly.Workspace');
-      workspace = Workspace.getById(this.workspaceId);
-    }
-    if (!workspace) {
-      throw Error(
-          'Workspace is null. Event must have been generated from real' +
-          ' Blockly events.');
-    }
-    return workspace;
-  }
-}
-
-exports.Abstract = Abstract;

package/core/events/events_block_base.js

@@ -1,70 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base class for all types of block events.
- */
-'use strict';
-
-/**
- * Base class for all types of block events.
- * @class
- */
-goog.module('Blockly.Events.BlockBase');
-
-const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-
-
-/**
- * Abstract class for a block event.
- * @extends {AbstractEvent}
- * @alias Blockly.Events.BlockBase
- */
-class BlockBase extends AbstractEvent {
-  /**
-   * @param {!Block=} opt_block The block this event corresponds to.
-   *     Undefined for a blank event.
-   */
-  constructor(opt_block) {
-    super();
-    this.isBlank = typeof opt_block === 'undefined';
-
-    /**
-     * The block ID for the block this event pertains to
-     * @type {string}
-     */
-    this.blockId = this.isBlank ? '' : opt_block.id;
-
-    /**
-     * The workspace identifier for this event.
-     * @type {string}
-     */
-    this.workspaceId = this.isBlank ? '' : opt_block.workspace.id;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['blockId'] = this.blockId;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.blockId = json['blockId'];
-  }
-}
-
-exports.BlockBase = BlockBase;

package/core/events/events_block_change.js

@@ -1,179 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for a block change event.
- */
-'use strict';
-
-/**
- * Class for a block change event.
- * @class
- */
-goog.module('Blockly.Events.BlockChange');
-
-const Xml = goog.require('Blockly.Xml');
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {BlockBase} = goog.require('Blockly.Events.BlockBase');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-
-
-/**
- * Class for a block change event.
- * @extends {BlockBase}
- * @alias Blockly.Events.BlockChange
- */
-class BlockChange extends BlockBase {
-  /**
-   * @param {!Block=} opt_block The changed block.  Undefined for a blank
-   *     event.
-   * @param {string=} opt_element One of 'field', 'comment', 'disabled', etc.
-   * @param {?string=} opt_name Name of input or field affected, or null.
-   * @param {*=} opt_oldValue Previous value of element.
-   * @param {*=} opt_newValue New value of element.
-   */
-  constructor(opt_block, opt_element, opt_name, opt_oldValue, opt_newValue) {
-    super(opt_block);
-
-    /**
-     * Type of this event.
-     * @type {string}
-     */
-    this.type = eventUtils.BLOCK_CHANGE;
-
-    if (!opt_block) {
-      return;  // Blank event to be populated by fromJson.
-    }
-    this.element = typeof opt_element === 'undefined' ? '' : opt_element;
-    this.name = typeof opt_name === 'undefined' ? '' : opt_name;
-    this.oldValue = typeof opt_oldValue === 'undefined' ? '' : opt_oldValue;
-    this.newValue = typeof opt_newValue === 'undefined' ? '' : opt_newValue;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['element'] = this.element;
-    if (this.name) {
-      json['name'] = this.name;
-    }
-    json['oldValue'] = this.oldValue;
-    json['newValue'] = this.newValue;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.element = json['element'];
-    this.name = json['name'];
-    this.oldValue = json['oldValue'];
-    this.newValue = json['newValue'];
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return {boolean} False if something changed.
-   */
-  isNull() {
-    return this.oldValue === this.newValue;
-  }
-
-  /**
-   * Run a change event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
-   */
-  run(forward) {
-    const workspace = this.getEventWorkspace_();
-    const block = workspace.getBlockById(this.blockId);
-    if (!block) {
-      console.warn('Can\'t change non-existent block: ' + this.blockId);
-      return;
-    }
-
-    // Assume the block is rendered so that then we can check.
-    const blockSvg = /** @type {!BlockSvg} */ (block);
-    if (blockSvg.mutator) {
-      // Close the mutator (if open) since we don't want to update it.
-      blockSvg.mutator.setVisible(false);
-    }
-    const value = forward ? this.newValue : this.oldValue;
-    switch (this.element) {
-      case 'field': {
-        const field = block.getField(this.name);
-        if (field) {
-          field.setValue(value);
-        } else {
-          console.warn('Can\'t set non-existent field: ' + this.name);
-        }
-        break;
-      }
-      case 'comment':
-        block.setCommentText(/** @type {string} */ (value) || null);
-        break;
-      case 'collapsed':
-        block.setCollapsed(!!value);
-        break;
-      case 'disabled':
-        block.setEnabled(!value);
-        break;
-      case 'inline':
-        block.setInputsInline(!!value);
-        break;
-      case 'mutation': {
-        const oldState = BlockChange.getExtraBlockState_(
-            /** @type {!BlockSvg} */ (block));
-        if (block.loadExtraState) {
-          block.loadExtraState(
-              JSON.parse(/** @type {string} */ (value) || '{}'));
-        } else if (block.domToMutation) {
-          block.domToMutation(
-              Xml.textToDom(/** @type {string} */ (value) || '<mutation/>'));
-        }
-        eventUtils.fire(
-            new BlockChange(block, 'mutation', null, oldState, value));
-        break;
-      }
-      default:
-        console.warn('Unknown change type: ' + this.element);
-    }
-  }
-
-  // TODO (#5397): Encapsulate this in the BlocklyMutationChange event when
-  //    refactoring change events.
-  /**
-   * Returns the extra state of the given block (either as XML or a JSO,
-   * depending on the block's definition).
-   * @param {!BlockSvg} block The block to get the extra state of.
-   * @return {string} A stringified version of the extra state of the given
-   *     block.
-   * @package
-   */
-  static getExtraBlockState_(block) {
-    if (block.saveExtraState) {
-      const state = block.saveExtraState();
-      return state ? JSON.stringify(state) : '';
-    } else if (block.mutationToDom) {
-      const state = block.mutationToDom();
-      return state ? Xml.domToText(state) : '';
-    }
-    return '';
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.CHANGE, BlockChange);
-
-exports.BlockChange = BlockChange;

package/core/events/events_block_create.js

@@ -1,127 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for a block creation event.
- */
-'use strict';
-
-/**
- * Class for a block creation event.
- * @class
- */
-goog.module('Blockly.Events.BlockCreate');
-
-const Xml = goog.require('Blockly.Xml');
-const blocks = goog.require('Blockly.serialization.blocks');
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {BlockBase} = goog.require('Blockly.Events.BlockBase');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-
-
-/**
- * Class for a block creation event.
- * @extends {BlockBase}
- * @alias Blockly.Events.BlockCreate
- */
-class BlockCreate extends BlockBase {
-  /**
-   * @param {!Block=} opt_block The created block.  Undefined for a blank
-   *     event.
-   */
-  constructor(opt_block) {
-    super(opt_block);
-
-    /**
-     * Type of this event.
-     * @type {string}
-     */
-    this.type = eventUtils.BLOCK_CREATE;
-
-    if (!opt_block) {
-      return;  // Blank event to be populated by fromJson.
-    }
-    if (opt_block.isShadow()) {
-      // Moving shadow blocks is handled via disconnection.
-      this.recordUndo = false;
-    }
-
-    this.xml = Xml.blockToDomWithXY(opt_block);
-    this.ids = eventUtils.getDescendantIds(opt_block);
-
-    /**
-     * Play UI effects (sound and animation)?
-     * @type {boolean}
-     */
-    this.ui = true;
-
-    /**
-     * JSON representation of the block that was just created.
-     * @type {!blocks.State}
-     */
-    this.json = /** @type {!blocks.State} */ (
-        blocks.save(opt_block, {addCoordinates: true}));
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['xml'] = Xml.domToText(this.xml);
-    json['ids'] = this.ids;
-    json['json'] = this.json;
-    json['ui'] = this.ui;
-    if (!this.recordUndo) {
-      json['recordUndo'] = this.recordUndo;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.xml = Xml.textToDom(json['xml']);
-    this.ids = json['ids'];
-    this.json = /** @type {!blocks.State} */ (json['json']);
-    this.ui = !!json['ui'];
-    if (json['recordUndo'] !== undefined) {
-      this.recordUndo = json['recordUndo'];
-    }
-  }
-
-  /**
-   * Run a creation event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
-   */
-  run(forward) {
-    const workspace = this.getEventWorkspace_();
-    if (forward) {
-      blocks.append(this.json, workspace);
-    } else {
-      for (let i = 0; i < this.ids.length; i++) {
-        const id = this.ids[i];
-        const block = workspace.getBlockById(id);
-        if (block) {
-          block.dispose(false, this.ui);
-        } else if (id === this.blockId) {
-          // Only complain about root-level block.
-          console.warn('Can\'t uncreate non-existent block: ' + id);
-        }
-      }
-    }
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.CREATE, BlockCreate);
-
-exports.BlockCreate = BlockCreate;