blockly 8.0.5 → 9.0.0-beta.0

package/core/contextmenu_registry.js

@@ -1,178 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Registry for context menu option items.
- */
-'use strict';
-
-/**
- * Registry for context menu option items.
- * @class
- */
-goog.module('Blockly.ContextMenuRegistry');
-
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
-
-
-/**
- * Class for the registry of context menu items. This is intended to be a
- * singleton. You should not create a new instance, and only access this class
- * from ContextMenuRegistry.registry.
- * @alias Blockly.ContextMenuRegistry
- */
-class ContextMenuRegistry {
-  /**
-   * Resets the existing singleton instance of ContextMenuRegistry.
-   */
-  constructor() {
-    this.reset();
-  }
-
-  /**
-   * Clear and recreate the registry.
-   */
-  reset() {
-    /**
-     * Registry of all registered RegistryItems, keyed by ID.
-     * @type {!Object<string, !ContextMenuRegistry.RegistryItem>}
-     * @private
-     */
-    this.registry_ = Object.create(null);
-  }
-
-  /**
-   * Registers a RegistryItem.
-   * @param {!ContextMenuRegistry.RegistryItem} item Context menu item to
-   *     register.
-   * @throws {Error} if an item with the given ID already exists.
-   */
-  register(item) {
-    if (this.registry_[item.id]) {
-      throw Error('Menu item with ID "' + item.id + '" is already registered.');
-    }
-    this.registry_[item.id] = item;
-  }
-
-  /**
-   * Unregisters a RegistryItem with the given ID.
-   * @param {string} id The ID of the RegistryItem to remove.
-   * @throws {Error} if an item with the given ID does not exist.
-   */
-  unregister(id) {
-    if (!this.registry_[id]) {
-      throw new Error('Menu item with ID "' + id + '" not found.');
-    }
-    delete this.registry_[id];
-  }
-
-  /**
-   * @param {string} id The ID of the RegistryItem to get.
-   * @return {?ContextMenuRegistry.RegistryItem} RegistryItem or null if not
-   *     found
-   */
-  getItem(id) {
-    return this.registry_[id] || null;
-  }
-
-  /**
-   * Gets the valid context menu options for the given scope type (e.g. block or
-   * workspace) and scope. Blocks are only shown if the preconditionFn shows
-   * they should not be hidden.
-   * @param {!ContextMenuRegistry.ScopeType} scopeType Type of scope where menu
-   *     should be shown (e.g. on a block or on a workspace)
-   * @param {!ContextMenuRegistry.Scope} scope Current scope of context menu
-   *     (i.e., the exact workspace or block being clicked on)
-   * @return {!Array<!ContextMenuRegistry.ContextMenuOption>} the list of
-   *     ContextMenuOptions
-   */
-  getContextMenuOptions(scopeType, scope) {
-    const menuOptions = [];
-    const registry = this.registry_;
-    Object.keys(registry).forEach(function(id) {
-      const item = registry[id];
-      if (scopeType === item.scopeType) {
-        const precondition = item.preconditionFn(scope);
-        if (precondition !== 'hidden') {
-          const displayText = typeof item.displayText === 'function' ?
-              item.displayText(scope) :
-              item.displayText;
-          /** @type {!ContextMenuRegistry.ContextMenuOption} */
-          const menuOption = {
-            text: displayText,
-            enabled: (precondition === 'enabled'),
-            callback: item.callback,
-            scope: scope,
-            weight: item.weight,
-          };
-          menuOptions.push(menuOption);
-        }
-      }
-    });
-    menuOptions.sort(function(a, b) {
-      return a.weight - b.weight;
-    });
-    return menuOptions;
-  }
-}
-
-/**
- * Where this menu item should be rendered. If the menu item should be rendered
- * in multiple scopes, e.g. on both a block and a workspace, it should be
- * registered for each scope.
- * @enum {string}
- */
-ContextMenuRegistry.ScopeType = {
-  BLOCK: 'block',
-  WORKSPACE: 'workspace',
-};
-
-/**
- * The actual workspace/block where the menu is being rendered. This is passed
- * to callback and displayText functions that depend on this information.
- * @typedef {{
- *    block: (BlockSvg|undefined),
- *    workspace: (WorkspaceSvg|undefined)
- * }}
- */
-ContextMenuRegistry.Scope;
-
-/**
- * A menu item as entered in the registry.
- * @typedef {{
- *    callback: function(!ContextMenuRegistry.Scope),
- *    scopeType: !ContextMenuRegistry.ScopeType,
- *    displayText: ((function(!ContextMenuRegistry.Scope):string)|string),
- *    preconditionFn: function(!ContextMenuRegistry.Scope):string,
- *    weight: number,
- *    id: string
- * }}
- */
-ContextMenuRegistry.RegistryItem;
-
-/**
- * A menu item as presented to contextmenu.js.
- * @typedef {{
- *    text: string,
- *    enabled: boolean,
- *    callback: function(!ContextMenuRegistry.Scope),
- *    scope: !ContextMenuRegistry.Scope,
- *    weight: number
- * }}
- */
-ContextMenuRegistry.ContextMenuOption;
-
-/**
- * Singleton instance of this class. All interactions with this class should be
- * done on this object.
- * @type {!ContextMenuRegistry}
- */
-ContextMenuRegistry.registry = new ContextMenuRegistry();
-
-exports.ContextMenuRegistry = ContextMenuRegistry;

package/core/delete_area.js

@@ -1,87 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The abstract class for a component that can delete a block or
- * bubble that is dropped on top of it.
- */
-
-'use strict';
-
-/**
- * The abstract class for a component that can delete a block or
- * bubble that is dropped on top of it.
- * @class
- */
-goog.module('Blockly.DeleteArea');
-
-const {BlockSvg} = goog.require('Blockly.BlockSvg');
-const {DragTarget} = goog.require('Blockly.DragTarget');
-/* eslint-disable-next-line no-unused-vars */
-const {IDeleteArea} = goog.require('Blockly.IDeleteArea');
-/* eslint-disable-next-line no-unused-vars */
-const {IDraggable} = goog.requireType('Blockly.IDraggable');
-
-
-/**
- * Abstract class for a component that can delete a block or bubble that is
- * dropped on top of it.
- * @extends {DragTarget}
- * @implements {IDeleteArea}
- * @alias Blockly.DeleteArea
- */
-class DeleteArea extends DragTarget {
-  /**
-   * Constructor for DeleteArea. Should not be called directly, only by a
-   * subclass.
-   */
-  constructor() {
-    super();
-
-    /**
-     * Whether the last block or bubble dragged over this delete area would be
-     * deleted if dropped on this component.
-     * This property is not updated after the block or bubble is deleted.
-     * @type {boolean}
-     * @protected
-     */
-    this.wouldDelete_ = false;
-  }
-
-  /**
-   * Returns whether the provided block or bubble would be deleted if dropped on
-   * this area.
-   * This method should check if the element is deletable and is always called
-   * before onDragEnter/onDragOver/onDragExit.
-   * @param {!IDraggable} element The block or bubble currently being
-   *   dragged.
-   * @param {boolean} couldConnect Whether the element could could connect to
-   *     another.
-   * @return {boolean} Whether the element provided would be deleted if dropped
-   *     on this area.
-   */
-  wouldDelete(element, couldConnect) {
-    if (element instanceof BlockSvg) {
-      const block = /** @type {BlockSvg} */ (element);
-      const couldDeleteBlock = !block.getParent() && block.isDeletable();
-      this.updateWouldDelete_(couldDeleteBlock && !couldConnect);
-    } else {
-      this.updateWouldDelete_(element.isDeletable());
-    }
-    return this.wouldDelete_;
-  }
-
-  /**
-   * Updates the internal wouldDelete_ state.
-   * @param {boolean} wouldDelete The new value for the wouldDelete state.
-   * @protected
-   */
-  updateWouldDelete_(wouldDelete) {
-    this.wouldDelete_ = wouldDelete;
-  }
-}
-
-exports.DeleteArea = DeleteArea;

package/core/dialog.js

@@ -1,107 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Wrapper functions around JS functions for showing
- * alert/confirmation dialogs.
- */
-
-'use strict';
-
-/**
- * Wrapper functions around JS functions for showing alert/confirmation dialogs.
- * @namespace Blockly.dialog
- */
-goog.module('Blockly.dialog');
-
-let alertImplementation = function(message, opt_callback) {
-  window.alert(message);
-  if (opt_callback) {
-    opt_callback();
-  }
-};
-
-let confirmImplementation = function(message, callback) {
-  callback(window.confirm(message));
-};
-
-let promptImplementation = function(message, defaultValue, callback) {
-  callback(window.prompt(message, defaultValue));
-};
-
-/**
- * Wrapper to window.alert() that app developers may override via setAlert to
- * provide alternatives to the modal browser window.
- * @param {string} message The message to display to the user.
- * @param {function()=} opt_callback The callback when the alert is dismissed.
- * @alias Blockly.dialog.alert
- */
-const alert = function(message, opt_callback) {
-  alertImplementation(message, opt_callback);
-};
-exports.alert = alert;
-
-/**
- * Sets the function to be run when Blockly.dialog.alert() is called.
- * @param {!function(string, function()=)} alertFunction The function to be run.
- * @see Blockly.dialog.alert
- * @alias Blockly.dialog.setAlert
- */
-const setAlert = function(alertFunction) {
-  alertImplementation = alertFunction;
-};
-exports.setAlert = setAlert;
-
-/**
- * Wrapper to window.confirm() that app developers may override via setConfirm
- * to provide alternatives to the modal browser window.
- * @param {string} message The message to display to the user.
- * @param {!function(boolean)} callback The callback for handling user response.
- * @alias Blockly.dialog.confirm
- */
-const confirm = function(message, callback) {
-  confirmImplementation(message, callback);
-};
-exports.confirm = confirm;
-
-/**
- * Sets the function to be run when Blockly.dialog.confirm() is called.
- * @param {!function(string, !function(boolean))} confirmFunction The function
- *    to be run.
- * @see Blockly.dialog.confirm
- * @alias Blockly.dialog.setConfirm
- */
-const setConfirm = function(confirmFunction) {
-  confirmImplementation = confirmFunction;
-};
-exports.setConfirm = setConfirm;
-
-/**
- * Wrapper to window.prompt() that app developers may override via setPrompt to
- * provide alternatives to the modal browser window. Built-in browser prompts
- * are often used for better text input experience on mobile device. We strongly
- * recommend testing mobile when overriding this.
- * @param {string} message The message to display to the user.
- * @param {string} defaultValue The value to initialize the prompt with.
- * @param {!function(?string)} callback The callback for handling user response.
- * @alias Blockly.dialog.prompt
- */
-const prompt = function(message, defaultValue, callback) {
-  promptImplementation(message, defaultValue, callback);
-};
-exports.prompt = prompt;
-
-/**
- * Sets the function to be run when Blockly.dialog.prompt() is called.
- * @param {!function(string, string, !function(?string))} promptFunction The
- *    function to be run.
- * @see Blockly.dialog.prompt
- * @alias Blockly.dialog.setPrompt
- */
-const setPrompt = function(promptFunction) {
-  promptImplementation = promptFunction;
-};
-exports.setPrompt = setPrompt;

package/core/drag_target.js

@@ -1,98 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The abstract class for a component with custom behaviour when a
- * block or bubble is dragged over or dropped on top of it.
- */
-
-'use strict';
-
-/**
- * The abstract class for a component with custom behaviour when a
- * block or bubble is dragged over or dropped on top of it.
- * @class
- */
-goog.module('Blockly.DragTarget');
-
-/* eslint-disable-next-line no-unused-vars */
-const {IDragTarget} = goog.require('Blockly.IDragTarget');
-/* eslint-disable-next-line no-unused-vars */
-const {IDraggable} = goog.requireType('Blockly.IDraggable');
-/* eslint-disable-next-line no-unused-vars */
-const {Rect} = goog.requireType('Blockly.utils.Rect');
-
-
-/**
- * Abstract class for a component with custom behaviour when a block or bubble
- * is dragged over or dropped on top of it.
- * @implements {IDragTarget}
- * @alias Blockly.DragTarget
- */
-class DragTarget {
-  /**
-   * Handles when a cursor with a block or bubble enters this drag target.
-   * @param {!IDraggable} _dragElement The block or bubble currently being
-   *   dragged.
-   */
-  onDragEnter(_dragElement) {
-    // no-op
-  }
-
-  /**
-   * Handles when a cursor with a block or bubble is dragged over this drag
-   * target.
-   * @param {!IDraggable} _dragElement The block or bubble currently being
-   *   dragged.
-   */
-  onDragOver(_dragElement) {
-    // no-op
-  }
-
-  /**
-   * Handles when a cursor with a block or bubble exits this drag target.
-   * @param {!IDraggable} _dragElement The block or bubble currently being
-   *   dragged.
-   */
-  onDragExit(_dragElement) {
-    // no-op
-  }
-
-  /**
-   * Handles when a block or bubble is dropped on this component.
-   * Should not handle delete here.
-   * @param {!IDraggable} _dragElement The block or bubble currently being
-   *   dragged.
-   */
-  onDrop(_dragElement) {
-    // no-op
-  }
-
-  /**
-   * Returns the bounding rectangle of the drag target area in pixel units
-   * relative to the Blockly injection div.
-   * @return {?Rect} The component's bounding box. Null if drag
-   *   target area should be ignored.
-   */
-  getClientRect() {
-    return null;
-  }
-
-  /**
-   * Returns whether the provided block or bubble should not be moved after
-   * being dropped on this component. If true, the element will return to where
-   * it was when the drag started.
-   * @param {!IDraggable} _dragElement The block or bubble currently being
-   *   dragged.
-   * @return {boolean} Whether the block or bubble provided should be returned
-   *     to drag start.
-   */
-  shouldPreventMove(_dragElement) {
-    return false;
-  }
-}
-
-exports.DragTarget = DragTarget;

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);
-    },
-  },
-});