blockly 7.20210930.0-beta.2 → 7.20211209.0-beta.1

package/blockly.d.ts

@@ -6,7 +6,6 @@
 
 /**
  * @fileoverview Type definitions for Blockly.
- * @author samelh@google.com (Sam El-Husseini)
  */
 
 export = Blockly;
@@ -124,21 +123,6 @@ declare module Block {
 }
 
 
-declare module exports {
-
-    /** @package */
-    var disposeUiEffect: any /*missing*/;
-
-    /** @package */
-    var connectionUiEffect: any /*missing*/;
-
-    /** @package */
-    var disconnectUiEffect: any /*missing*/;
-
-    /** @package */
-    var disconnectUiStop: any /*missing*/;
-}
-
 
 
 
@@ -176,6 +160,15 @@ declare module exports {
      */
     var VERSION: any /*missing*/;
 
+    /**
+     * Returns the dimensions of the specified SVG image.
+     * @param {!SVGElement} svg SVG image.
+     * @return {!Size} Contains width and height properties.
+     * @deprecated Use workspace.setCachedParentSvgSize. (2021 March 5)
+     * @alias Blockly.svgSize
+     */
+    function svgSize(svg: SVGElement): Size;
+
     /**
      * Copy a block or workspace comment onto the local clipboard.
      * @param {!ICopyable} toCopy Block or Workspace Comment to be copied.
@@ -210,6 +203,14 @@ declare module exports {
      */
     function getMainWorkspace(): Workspace;
 
+    /**
+     * 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.
+     * @alias Blockly.defineBlocksWithJsonArray
+     */
+    function defineBlocksWithJsonArray(jsonArray: Object[]): void;
+
     /**
      * Set the parent container.  This is the container element that the WidgetDiv,
      * DropDownDiv, and Tooltip are rendered into the first time `Blockly.inject`
@@ -229,31 +230,37 @@ declare module exports {
 
     /**
      * @see browserEvents.bind
+     * @alias Blockly.bindEvent_
      */
     var bindEvent_: any /*missing*/;
 
     /**
      * @see browserEvents.unbind
+     * @alias Blockly.unbindEvent_
      */
     var unbindEvent_: any /*missing*/;
 
     /**
      * @see browserEvents.conditionalBind
+     * @alias Blockly.bindEventWithChecks_
      */
     var bindEventWithChecks_: any /*missing*/;
 
     /**
      * @see constants.ALIGN.LEFT
+     * @alias Blockly.ALIGN_LEFT
      */
     var ALIGN_LEFT: any /*missing*/;
 
     /**
      * @see constants.ALIGN.CENTRE
+     * @alias Blockly.ALIGN_CENTRE
      */
     var ALIGN_CENTRE: any /*missing*/;
 
     /**
      * @see constants.ALIGN.RIGHT
+     * @alias Blockly.ALIGN_RIGHT
      */
     var ALIGN_RIGHT: any /*missing*/;
 
@@ -263,49 +270,61 @@ declare module exports {
     var svgResize: any /*missing*/;
 
     /**
-     * @see connectionTypes.INPUT_VALUE
+     * @see ConnectionType.INPUT_VALUE
+     * @alias Blockly.INPUT_VALUE
      */
     var INPUT_VALUE: any /*missing*/;
 
     /**
-     * @see connectionTypes.OUTPUT_VALUE
+     * @see ConnectionType.OUTPUT_VALUE
+     * @alias Blockly.OUTPUT_VALUE
      */
     var OUTPUT_VALUE: any /*missing*/;
 
     /**
-     * @see connectionTypes.NEXT_STATEMENT
+     * @see ConnectionType.NEXT_STATEMENT
+     * @alias Blockly.NEXT_STATEMENT
      */
     var NEXT_STATEMENT: any /*missing*/;
 
     /**
-     * @see connectionTypes.PREVIOUS_STATEMENT
+     * @see ConnectionType.PREVIOUS_STATEMENT
+     * @alias Blockly.PREVIOUS_STATEMENT
      */
     var PREVIOUS_STATEMENT: any /*missing*/;
 
     /**
      * @see inputTypes.DUMMY_INPUT
+     * @alias Blockly.DUMMY_INPUT
      */
     var DUMMY_INPUT: any /*missing*/;
 
     /**
      * @see toolbox.Position.TOP
+     * @alias Blockly.TOOLBOX_AT_TOP
      */
     var TOOLBOX_AT_TOP: any /*missing*/;
 
     /**
      * @see toolbox.Position.BOTTOM
+     * @alias Blockly.TOOLBOX_AT_BOTTOM
      */
     var TOOLBOX_AT_BOTTOM: any /*missing*/;
 
     /**
      * @see toolbox.Position.LEFT
+     * @alias Blockly.TOOLBOX_AT_LEFT
      */
     var TOOLBOX_AT_LEFT: any /*missing*/;
 
     /**
      * @see toolbox.Position.RIGHT
+     * @alias Blockly.TOOLBOX_AT_RIGHT
      */
     var TOOLBOX_AT_RIGHT: any /*missing*/;
+
+    /** @deprecated Use Blockly.ConnectionType instead. */
+    var connectionTypes: any /*missing*/;
 }
 
 
@@ -363,18 +382,6 @@ declare module Bubble {
 
 
 
-declare module exports {
-
-    /** @package */
-    var copy: any /*missing*/;
-
-    /** @package */
-    var paste: any /*missing*/;
-
-    /** @package */
-    var duplicate: any /*missing*/;
-}
-
 
 
 declare module exports {
@@ -473,18 +480,6 @@ declare module ConnectionDB {
 
 
 
-declare module exports {
-
-    /** @package */
-    var commentDeleteOption: any /*missing*/;
-
-    /** @package */
-    var commentDuplicateOption: any /*missing*/;
-
-    /** @package */
-    var workspaceCommentOption: any /*missing*/;
-}
-
 
 
 declare module ContextMenuRegistry {
@@ -813,87 +808,16 @@ declare module Field {
 }
 
 
-declare module Blockly {
-
-    class FieldAngle extends FieldAngle__Class { }
-    /** Fake class which should be extended to avoid inheriting static properties */
-    class FieldAngle__Class extends Blockly.FieldTextInput__Class  { 
-    
-            /**
-             * Class for an editable angle field.
-             * @param {string|number=} opt_value The initial value of the field. Should cast
-             *    to a number. Defaults to 0.
-             * @param {Function=} opt_validator A function that is called to validate
-             *    changes to the field's value. Takes in a number & returns a
-             *    validated number, or null to abort the change.
-             * @param {Object=} opt_config A map of options used to configure the field.
-             *    See the [field creation documentation]{@link https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/angle#creation}
-             *    for a list of properties this parameter supports.
-             * @extends {Blockly.FieldTextInput}
-             * @constructor
-             */
-            constructor(opt_value?: string|number, opt_validator?: Function, opt_config?: Object);
-    
-            /**
-             * The angle picker's gauge path depending on the value.
-             * @type {?SVGElement}
-             */
-            gauge_: SVGElement;
-    
-            /**
-             * The angle picker's line drawn representing the value's angle.
-             * @type {?SVGElement}
-             */
-            line_: SVGElement;
-    
-            /**
-             * The default value for this field.
-             * @type {*}
-             * @protected
-             */
-            DEFAULT_VALUE: any;
-    
-            /**
-             * Serializable fields are saved by the XML renderer, non-serializable fields
-             * are not. Editable fields should also be serializable.
-             * @type {boolean}
-             */
-            SERIALIZABLE: boolean;
-    
-            /**
-             * Create the block UI for this field.
-             * @package
-             */
-            initView(): void;
-    
-            /**
-             * Create and show the angle field's editor.
-             * @param {Event=} opt_e Optional mouse event that triggered the field to open,
-             *     or undefined if triggered programmatically.
-             * @protected
-             */
-            showEditor_(opt_e?: Event): void;
-    
-            /**
-             * Set the angle to match the mouse's position.
-             * @param {!Event} e Mouse move event.
-             * @protected
-             */
-            onMouseMove_(e: Event): void;
-    } 
-    
-}
-
-declare module Blockly.FieldAngle {
+declare module FieldAngle {
 
     /**
      * Construct a FieldAngle from a JSON arg object.
      * @param {!Object} options A JSON object with options (angle).
-     * @return {!Blockly.FieldAngle} The new field instance.
+     * @return {!FieldAngle} The new field instance.
      * @package
      * @nocollapse
      */
-    function fromJson(options: Object): Blockly.FieldAngle;
+    function fromJson(options: Object): FieldAngle;
 
     /**
      * The default amount to round angles to when using a mouse or keyboard nav
@@ -1120,12 +1044,6 @@ declare module FieldNumber {
 }
 
 
-declare module exports {
-
-    /** @package */
-    var fromJson: any /*missing*/;
-}
-
 
 declare module FieldTextInput {
 
@@ -1256,12 +1174,6 @@ declare module MarkerManager {
     var LOCAL_MARKER: string;
 }
 
-declare module  {
-
-    /** @package */
-    var exports: any /*missing*/;
-}
-
 
 
 
@@ -1454,36 +1366,6 @@ declare module Options {
 }
 
 
-declare module exports {
-
-    /** @package */
-    var verticalPosition: any /*missing*/;
-
-    /** @package */
-    var horizontalPosition: any /*missing*/;
-
-    /** @package */
-    var Position: any /*missing*/;
-
-    /** @package */
-    var bumpDirection: any /*missing*/;
-
-    /** @package */
-    var getStartPositionRect: any /*missing*/;
-
-    /** @package */
-    var getCornerOppositeToolbox: any /*missing*/;
-
-    /** @package */
-    var bumpPositionRect: any /*missing*/;
-}
-
-
-declare module exports {
-
-    /** @package */
-    var mutatorOpenListener: any /*missing*/;
-}
 
 
 declare module Type {
@@ -1571,12 +1453,6 @@ declare module Scrollbar {
 
 
 
-declare module exports {
-
-    /** @package */
-    var registerDefaultShortcuts: any /*missing*/;
-}
-
 
 declare module ShortcutRegistry {
 
@@ -1713,33 +1589,6 @@ declare module ThemeManager {
 }
 
 
-declare module exports {
-
-    /** @deprecated September 2021 */
-    var visible: any /*missing*/;
-
-    /** @deprecated September 2021 */
-    var DIV: any /*missing*/;
-
-    /** @package */
-    var dispose: any /*missing*/;
-
-    /** @package */
-    var block: any /*missing*/;
-
-    /** @package */
-    var unblock: any /*missing*/;
-}
-
-
-declare module exports {
-
-    /** @package */
-    var longStart: any /*missing*/;
-
-    /** @package */
-    var longStop: any /*missing*/;
-}
 
 
 declare module TouchGesture {
@@ -1759,18 +1608,6 @@ declare module TouchGesture {
 
 
 
-declare module exports {
-
-    /** @package */
-    var getViewportBBox: any /*missing*/;
-
-    /** @package */
-    var arrayRemove: any /*missing*/;
-
-    /** @package */
-    var screenToWsCoordinates: any /*missing*/;
-}
-
 
 
 declare module VariableModel {
@@ -1787,23 +1624,8 @@ declare module VariableModel {
 }
 
 
-declare module exports {
-
-    /** @package */
-    var getAddedVariables: any /*missing*/;
-}
-
-
-
-
-declare module exports {
 
-    /** @deprecated September 2021 */
-    var DIV: any /*missing*/;
 
-    /** @package */
-    var positionWithAnchor: any /*missing*/;
-}
 
 
 declare module Workspace {
@@ -1889,15 +1711,6 @@ declare module WorkspaceCommentSvg {
 
 
 
-declare module exports {
-
-    /** @deprecated September 2021 */
-    var recordUndo: any /*missing*/;
-
-    /** @package */
-    var getDescendantIds: any /*missing*/;
-}
-
 
 
 
@@ -1924,11 +1737,11 @@ declare module CommentBase {
 
     /**
      * Helper function for Comment[Create|Delete]
-     * @param {!Events.CommentCreate|!Events.CommentDelete} event
+     * @param {!CommentCreate|!CommentDelete} event
      *     The event to run.
      * @param {boolean} create if True then Create, if False then Delete
      */
-    function CommentCreateDeleteHelper(event: Events.CommentCreate|Events.CommentDelete, create: boolean): void;
+    function CommentCreateDeleteHelper(event: CommentCreate|CommentDelete, create: boolean): void;
 }
 
 
@@ -1955,6 +1768,7 @@ declare module CommentBase {
 
 
 
+
 
 
 declare module IComponent {
@@ -2115,6 +1929,32 @@ declare module BasicCursor {
 
 
 
+
+
+
+declare module exports {
+
+    /**
+     * The priority for deserializing variables.
+     * @type {number}
+     * @const
+     * @alias Blockly.serialization.priorities.VARIABLES
+     */
+    var VARIABLES: number;
+
+    /**
+     * The priority for deserializing blocks.
+     * @type {number}
+     * @const
+     * @alias Blockly.serialization.priorities.BLOCKS
+     */
+    var BLOCKS: number;
+}
+
+
+
+
+
 declare module ToolboxCategory {
 
     /**
@@ -2227,36 +2067,6 @@ declare module ToolboxSeparator {
 
 
 
-declare module exports {
-
-    /** @package */
-    var appendInternal: any /*missing*/;
-}
-
-
-
-declare module exports {
-
-    /**
-     * The priority for deserializing variables.
-     * @type {number}
-     * @const
-     * @alias Blockly.serialization.priorities.VARIABLES
-     */
-    var VARIABLES: number;
-
-    /**
-     * The priority for deserializing blocks.
-     * @type {number}
-     * @const
-     * @alias Blockly.serialization.priorities.BLOCKS
-     */
-    var BLOCKS: number;
-}
-
-
-
-
 
 
 
@@ -2306,12 +2116,6 @@ declare module Coordinate {
 }
 
 
-declare module exports {
-
-    /** @package */
-    var warn: any /*missing*/;
-}
-
 
 
 declare module exports {
@@ -2342,6 +2146,7 @@ declare module internal {
 
 
 
+
 declare module Size {
 
     /**
@@ -2500,90 +2305,90 @@ declare module Svg {
 
 
 
-declare module exports {
-
-    /** @package */
-    var convertToolboxDefToJson: any /*missing*/;
-
-    /** @package */
-    var convertFlyoutDefToJsonArray: any /*missing*/;
-
-    /** @package */
-    var hasCategories: any /*missing*/;
-
-    /** @package */
-    var isCategoryCollapsible: any /*missing*/;
-}
 
 
 declare module exports {
 
-    /** @const {string}
+    /**
+     * @const {string}
      * @alias Blockly.utils.userAgent.raw
      */
     var raw: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.IE
      */
     var IE: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.EDGE
      */
     var EDGE: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.JavaFx
      */
     var JavaFx: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.CHROME
      */
     var CHROME: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.WEBKIT
      */
     var WEBKIT: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.GECKO
      */
     var GECKO: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.ANDROID
      */
     var ANDROID: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.IPAD
      */
     var IPAD: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.IPOD
      */
     var IPOD: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.IPHONE
      */
     var IPHONE: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.MAC
      */
     var MAC: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.TABLET
      */
     var TABLET: any /*missing*/;
 
-    /** @const {boolean}
+    /**
+     * @const {boolean}
      * @alias Blockly.utils.userAgent.MOBILE
      */
     var MOBILE: any /*missing*/;
@@ -2591,20 +2396,6 @@ declare module exports {
 
 
 
-declare module exports {
-
-    /** @package */
-    var isDebuggerEnabled: any /*missing*/;
-
-    /** @package */
-    var startDebugger: any /*missing*/;
-
-    /** @package */
-    var stopDebugger: any /*missing*/;
-
-    /** @package */
-    var init: any /*missing*/;
-}
 
 
 
@@ -3186,45 +2977,6 @@ declare module Blockly.Msg {
     /** @type {string} */
     var CONTROLS_IF_ELSE_TOOLTIP: string;
 
-    /** @type {string} */
-    var IOS_OK: string;
-
-    /** @type {string} */
-    var IOS_CANCEL: string;
-
-    /** @type {string} */
-    var IOS_ERROR: string;
-
-    /** @type {string} */
-    var IOS_PROCEDURES_INPUTS: string;
-
-    /** @type {string} */
-    var IOS_PROCEDURES_ADD_INPUT: string;
-
-    /** @type {string} */
-    var IOS_PROCEDURES_ALLOW_STATEMENTS: string;
-
-    /** @type {string} */
-    var IOS_PROCEDURES_DUPLICATE_INPUTS_ERROR: string;
-
-    /** @type {string} */
-    var IOS_VARIABLES_ADD_VARIABLE: string;
-
-    /** @type {string} */
-    var IOS_VARIABLES_ADD_BUTTON: string;
-
-    /** @type {string} */
-    var IOS_VARIABLES_RENAME_BUTTON: string;
-
-    /** @type {string} */
-    var IOS_VARIABLES_DELETE_BUTTON: string;
-
-    /** @type {string} */
-    var IOS_VARIABLES_VARIABLE_NAME: string;
-
-    /** @type {string} */
-    var IOS_VARIABLES_EMPTY_NAME_ERROR: string;
-
     /** @type {string} */
     var LOGIC_COMPARE_HELPURL: string;