blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/inject.d.ts

@@ -7,9 +7,11 @@ import type { BlocklyOptions } from './blockly_options.js';
 import { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Inject a Blockly editor into the specified container element (usually a div).
+ *
  * @param container Containing element, or its ID, or a CSS selector.
  * @param opt_options Optional dictionary of options.
- * @return Newly created main workspace.
+ * @returns Newly created main workspace.
  * @alias Blockly.inject
  */
 export declare function inject(container: Element | string, opt_options?: BlocklyOptions): WorkspaceSvg;
+//# sourceMappingURL=inject.d.ts.map

package/core/input.d.ts

@@ -10,6 +10,7 @@ import type { Connection } from './connection.js';
 import type { Field } from './field.js';
 /**
  * Class for an input with an optional field.
+ *
  * @alias Blockly.Input
  */
 export declare class Input {
@@ -31,84 +32,96 @@ export declare class Input {
     constructor(type: number, name: string, block: Block, connection: Connection | null);
     /**
      * Get the source block for this input.
-     * @return The source block, or null if there is none.
+     *
+     * @returns The source block, or null if there is none.
      */
     getSourceBlock(): Block;
     /**
      * Add a field (or label from string), and all prefix and suffix fields, to
      * the end of the input's field row.
+     *
      * @param field Something to add as a field.
      * @param opt_name Language-neutral identifier which may used to find this
      *     field again.  Should be unique to the host block.
-     * @return The input being append to (to allow chaining).
+     * @returns The input being append to (to allow chaining).
      */
     appendField(field: string | Field, opt_name?: string): Input;
     /**
      * Inserts a field (or label from string), and all prefix and suffix fields,
      * at the location of the input's field row.
+     *
      * @param index The index at which to insert field.
      * @param field Something to add as a field.
      * @param opt_name Language-neutral identifier which may used to find this
      *     field again.  Should be unique to the host block.
-     * @return The index following the last inserted field.
+     * @returns The index following the last inserted field.
      */
     insertFieldAt(index: number, field: string | Field, opt_name?: string): number;
     /**
      * Remove a field from this input.
+     *
      * @param name The name of the field.
      * @param opt_quiet True to prevent an error if field is not present.
-     * @return True if operation succeeds, false if field is not present and
+     * @returns True if operation succeeds, false if field is not present and
      *     opt_quiet is true.
      * @throws {Error} if the field is not present and opt_quiet is false.
      */
     removeField(name: string, opt_quiet?: boolean): boolean;
     /**
      * Gets whether this input is visible or not.
-     * @return True if visible.
+     *
+     * @returns True if visible.
      */
     isVisible(): boolean;
     /**
      * Sets whether this input is visible or not.
      * Should only be used to collapse/uncollapse a block.
+     *
      * @param visible True if visible.
-     * @return List of blocks to render.
+     * @returns List of blocks to render.
      * @internal
      */
     setVisible(visible: boolean): BlockSvg[];
     /**
      * Mark all fields on this input as dirty.
+     *
      * @internal
      */
     markDirty(): void;
     /**
      * Change a connection's compatibility.
+     *
      * @param check Compatible value type or list of value types.  Null if all
      *     types are compatible.
-     * @return The input being modified (to allow chaining).
+     * @returns The input being modified (to allow chaining).
      */
     setCheck(check: string | string[] | null): Input;
     /**
      * Change the alignment of the connection's field(s).
+     *
      * @param align One of the values of Align.  In RTL mode directions
      *     are reversed, and Align.RIGHT aligns to the left.
-     * @return The input being modified (to allow chaining).
+     * @returns The input being modified (to allow chaining).
      */
     setAlign(align: Align): Input;
     /**
      * Changes the connection's shadow block.
+     *
      * @param shadow DOM representation of a block or null.
-     * @return The input being modified (to allow chaining).
+     * @returns The input being modified (to allow chaining).
      */
     setShadowDom(shadow: Element | null): Input;
     /**
      * Returns the XML representation of the connection's shadow block.
-     * @return Shadow DOM representation of a block or null.
+     *
+     * @returns Shadow DOM representation of a block or null.
      */
     getShadowDom(): Element | null;
     /** Initialize the fields on this input. */
     init(): void;
     /**
      * Sever all links to this input.
+     *
      * @suppress {checkTypes}
      */
     dispose(): void;
@@ -116,6 +129,7 @@ export declare class Input {
 export declare namespace Input {
     /**
      * Enum for alignment of inputs.
+     *
      * @alias Blockly.Input.Align
      */
     enum Align {
@@ -126,3 +140,4 @@ export declare namespace Input {
 }
 export declare type Align = Input.Align;
 export declare const Align: typeof Input.Align;
+//# sourceMappingURL=input.d.ts.map

package/core/input_types.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Enum for the type of a connection or input.
+ *
  * @alias Blockly.inputTypes
  */
 export declare enum inputTypes {
@@ -12,3 +13,4 @@ export declare enum inputTypes {
     STATEMENT = 3,
     DUMMY = 5
 }
+//# sourceMappingURL=input_types.d.ts.map

package/core/insertion_marker_manager.d.ts

@@ -10,6 +10,7 @@ import type { Coordinate } from './utils/coordinate.js';
  * Class that controls updates to connections during drags.  It is primarily
  * responsible for finding the closest eligible connection and highlighting or
  * unhighlighting it as needed during a drag.
+ *
  * @alias Blockly.InsertionMarkerManager
  */
 export declare class InsertionMarkerManager {
@@ -60,37 +61,43 @@ export declare class InsertionMarkerManager {
     constructor(block: BlockSvg);
     /**
      * Sever all links from this object.
+     *
      * @internal
      */
     dispose(): void;
     /**
      * Update the available connections for the top block. These connections can
      * change if a block is unplugged and the stack is healed.
+     *
      * @internal
      */
     updateAvailableConnections(): void;
     /**
      * Return whether the block would be deleted if dropped immediately, based on
      * information from the most recent move event.
-     * @return True if the block would be deleted if dropped immediately.
+     *
+     * @returns True if the block would be deleted if dropped immediately.
      * @internal
      */
     wouldDeleteBlock(): boolean;
     /**
      * Return whether the block would be connected if dropped immediately, based
      * on information from the most recent move event.
-     * @return True if the block would be connected if dropped immediately.
+     *
+     * @returns True if the block would be connected if dropped immediately.
      * @internal
      */
     wouldConnectBlock(): boolean;
     /**
      * Connect to the closest connection and render the results.
      * This should be called at the end of a drag.
+     *
      * @internal
      */
     applyConnections(): void;
     /**
      * Update connections based on the most recent move location.
+     *
      * @param dxy Position relative to drag start, in workspace units.
      * @param dragTarget The drag target that the block is currently over.
      * @internal
@@ -98,8 +105,9 @@ export declare class InsertionMarkerManager {
     update(dxy: Coordinate, dragTarget: IDragTarget | null): void;
     /**
      * Create an insertion marker that represents the given block.
+     *
      * @param sourceBlock The block that the insertion marker will represent.
-     * @return The insertion marker that represents the given block.
+     * @returns The insertion marker that represents the given block.
      */
     private createMarkerBlock_;
     /**
@@ -107,37 +115,43 @@ export declare class InsertionMarkerManager {
      * should only be called once, at the beginning of a drag. If the stack has
      * more than one block, this function will populate lastOnStack_ and create
      * the corresponding insertion marker.
-     * @return A list of available connections.
+     *
+     * @returns A list of available connections.
      */
     private initAvailableConnections_;
     /**
      * Whether the previews (insertion marker and replacement marker) should be
      * updated based on the closest candidate and the current drag distance.
+     *
      * @param candidate An object containing a local connection, a closest
      *     connection, and a radius.  Returned by getCandidate_.
      * @param dxy Position relative to drag start, in workspace units.
-     * @return Whether the preview should be updated.
+     * @returns Whether the preview should be updated.
      */
     private shouldUpdatePreviews_;
     /**
      * Find the nearest valid connection, which may be the same as the current
      * closest connection.
+     *
      * @param dxy Position relative to drag start, in workspace units.
-     * @return An object containing a local connection, a closest connection, and
+     * @returns An object containing a local connection, a closest connection, and
      *     a radius.
      */
     private getCandidate_;
     /**
      * Decide the radius at which to start searching for the closest connection.
-     * @return The radius at which to start the search for the closest connection.
+     *
+     * @returns The radius at which to start the search for the closest
+     *     connection.
      */
     private getStartRadius_;
     /**
      * Whether ending the drag would delete the block.
+     *
      * @param candidate An object containing a local connection, a closest
      *     connection, and a radius.
      * @param dragTarget The drag target that the block is currently over.
-     * @return Whether dropping the block immediately would delete the block.
+     * @returns Whether dropping the block immediately would delete the block.
      */
     private shouldDelete_;
     /**
@@ -145,6 +159,7 @@ export declare class InsertionMarkerManager {
      * needed.
      * At the beginning of this function, this.localConnection_ and
      * this.closestConnection_ should both be null.
+     *
      * @param candidate An object containing a local connection, a closest
      *     connection, and a radius.
      */
@@ -159,6 +174,7 @@ export declare class InsertionMarkerManager {
      * needed.
      * At the end of this function, this.localConnection_ and
      * this.closestConnection_ should both be null.
+     *
      * @param candidate An object containing a local connection, a closest
      *     connection, and a radius.
      */
@@ -192,7 +208,8 @@ export declare class InsertionMarkerManager {
     /**
      * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
      * or 2 insertion markers.
-     * @return A possibly empty list of insertion marker blocks.
+     *
+     * @returns A possibly empty list of insertion marker blocks.
      * @internal
      */
     getInsertionMarkers(): BlockSvg[];
@@ -210,3 +227,4 @@ export declare namespace InsertionMarkerManager {
 }
 export declare type PreviewType = InsertionMarkerManager.PREVIEW_TYPE;
 export declare const PreviewType: typeof InsertionMarkerManager.PREVIEW_TYPE;
+//# sourceMappingURL=insertion_marker_manager.d.ts.map

package/core/interfaces/i_ast_node_location.d.ts

@@ -5,7 +5,9 @@
  */
 /**
  * An AST node location interface.
+ *
  * @alias Blockly.IASTNodeLocation
  */
 export interface IASTNodeLocation {
 }
+//# sourceMappingURL=i_ast_node_location.d.ts.map

package/core/interfaces/i_ast_node_location_svg.d.ts

@@ -6,17 +6,21 @@
 import type { IASTNodeLocation } from './i_ast_node_location.js';
 /**
  * An AST node location SVG interface.
+ *
  * @alias Blockly.IASTNodeLocationSvg
  */
 export interface IASTNodeLocationSvg extends IASTNodeLocation {
     /**
      * Add the marker SVG to this node's SVG group.
+     *
      * @param markerSvg The SVG root of the marker to be added to the SVG group.
      */
     setMarkerSvg(markerSvg: SVGElement | null): void;
     /**
      * Add the cursor SVG to this node's SVG group.
+     *
      * @param cursorSvg The SVG root of the cursor to be added to the SVG group.
      */
     setCursorSvg(cursorSvg: SVGElement | null): void;
 }
+//# sourceMappingURL=i_ast_node_location_svg.d.ts.map

package/core/interfaces/i_ast_node_location_with_block.d.ts

@@ -7,12 +7,15 @@ import type { IASTNodeLocation } from './i_ast_node_location.js';
 import type { Block } from '../block.js';
 /**
  * An AST node location that has an associated block.
+ *
  * @alias Blockly.IASTNodeLocationWithBlock
  */
 export interface IASTNodeLocationWithBlock extends IASTNodeLocation {
     /**
      * Get the source block associated with this node.
-     * @return The source block.
+     *
+     * @returns The source block.
      */
     getSourceBlock(): Block;
 }
+//# sourceMappingURL=i_ast_node_location_with_block.d.ts.map

package/core/interfaces/i_autohideable.d.ts

@@ -6,13 +6,16 @@
 import type { IComponent } from './i_component.js';
 /**
  * Interface for a component that can be automatically hidden.
+ *
  * @alias Blockly.IAutoHideable
  */
 export interface IAutoHideable extends IComponent {
     /**
      * Hides the component. Called in WorkspaceSvg.hideChaff.
+     *
      * @param onlyClosePopups Whether only popups should be closed.
      *   Flyouts should not be closed if this is true.
      */
     autoHide(onlyClosePopups: boolean): void;
 }
+//# sourceMappingURL=i_autohideable.d.ts.map

package/core/interfaces/i_block_dragger.d.ts

@@ -7,11 +7,13 @@ import type { Coordinate } from '../utils/coordinate.js';
 import type { BlockSvg } from '../block_svg.js';
 /**
  * A block dragger interface.
+ *
  * @alias Blockly.IBlockDragger
  */
 export interface IBlockDragger {
     /**
      * Start dragging a block.  This includes moving it to the drag surface.
+     *
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at mouse down, in pixel units.
      * @param healStack Whether or not to heal the stack after disconnecting.
@@ -20,6 +22,7 @@ export interface IBlockDragger {
     /**
      * Execute a step of block dragging, based on the given event.  Update the
      * display accordingly.
+     *
      * @param e The most recent move event.
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at the start of the drag, in pixel units.
@@ -27,6 +30,7 @@ export interface IBlockDragger {
     drag(e: Event, currentDragDeltaXY: Coordinate): void;
     /**
      * Finish a block drag and put the block back on the workspace.
+     *
      * @param e The mouseup/touchend event.
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at the start of the drag, in pixel units.
@@ -35,9 +39,11 @@ export interface IBlockDragger {
     /**
      * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
      * or 2 insertion markers.
-     * @return A possibly empty list of insertion marker blocks.
+     *
+     * @returns A possibly empty list of insertion marker blocks.
      */
     getInsertionMarkers(): BlockSvg[];
     /** Sever all links from this object and do any necessary cleanup. */
     dispose(): void;
 }
+//# sourceMappingURL=i_block_dragger.d.ts.map

package/core/interfaces/i_bounded_element.d.ts

@@ -6,19 +6,23 @@
 import type { Rect } from '../utils/rect.js';
 /**
  * A bounded element interface.
+ *
  * @alias Blockly.IBoundedElement
  */
 export interface IBoundedElement {
     /**
      * Returns the coordinates of a bounded element describing the dimensions of
      * the element. Coordinate system: workspace coordinates.
-     * @return Object with coordinates of the bounded element.
+     *
+     * @returns Object with coordinates of the bounded element.
      */
     getBoundingRectangle(): Rect;
     /**
      * Move the element by a relative offset.
+     *
      * @param dx Horizontal offset in workspace units.
      * @param dy Vertical offset in workspace units.
      */
     moveBy(dx: number, dy: number): void;
 }
+//# sourceMappingURL=i_bounded_element.d.ts.map

package/core/interfaces/i_bubble.d.ts

@@ -9,35 +9,41 @@ import type { IContextMenu } from './i_contextmenu.js';
 import type { IDraggable } from './i_draggable.js';
 /**
  * A bubble interface.
+ *
  * @alias Blockly.IBubble
  */
 export interface IBubble extends IDraggable, IContextMenu {
     /**
      * Return the coordinates of the top-left corner of this bubble's body
      * relative to the drawing surface's origin (0,0), in workspace units.
-     * @return Object with .x and .y properties.
+     *
+     * @returns Object with .x and .y properties.
      */
     getRelativeToSurfaceXY(): Coordinate;
     /**
      * Return the root node of the bubble's SVG group.
-     * @return The root SVG node of the bubble's group.
+     *
+     * @returns The root SVG node of the bubble's group.
      */
     getSvgRoot(): SVGElement;
     /**
      * Set whether auto-layout of this bubble is enabled.  The first time a bubble
      * is shown it positions itself to not cover any blocks.  Once a user has
      * dragged it to reposition, it renders where the user put it.
+     *
      * @param enable True if auto-layout should be enabled, false otherwise.
      */
     setAutoLayout(enable: boolean): void;
     /**
      * Sets whether or not this bubble is being dragged.
+     *
      * @param adding True if dragging, false otherwise.
      */
     setDragging(dragging: boolean): void;
     /**
      * Move this bubble during a drag, taking into account whether or not there is
      * a drag surface.
+     *
      * @param dragSurface The surface that carries rendered items during a drag,
      *     or null if no drag surface is in use.
      * @param newLoc The location to translate to, in workspace coordinates.
@@ -45,15 +51,18 @@ export interface IBubble extends IDraggable, IContextMenu {
     moveDuringDrag(dragSurface: BlockDragSurfaceSvg | null, newLoc: Coordinate): void;
     /**
      * Move the bubble to the specified location in workspace coordinates.
+     *
      * @param x The x position to move to.
      * @param y The y position to move to.
      */
     moveTo(x: number, y: number): void;
     /**
      * Update the style of this bubble when it is dragged over a delete area.
+     *
      * @param enable True if the bubble is about to be deleted, false otherwise.
      */
     setDeleteStyle(enable: boolean): void;
     /** Dispose of this bubble. */
     dispose(): void;
 }
+//# sourceMappingURL=i_bubble.d.ts.map

package/core/interfaces/i_collapsible_toolbox_item.d.ts

@@ -7,20 +7,24 @@ import type { ISelectableToolboxItem } from './i_selectable_toolbox_item.js';
 import type { IToolboxItem } from './i_toolbox_item.js';
 /**
  * Interface for an item in the toolbox that can be collapsed.
+ *
  * @alias Blockly.ICollapsibleToolboxItem
  */
 export interface ICollapsibleToolboxItem extends ISelectableToolboxItem {
     /**
      * Gets any children toolbox items. (ex. Gets the subcategories)
-     * @return The child toolbox items.
+     *
+     * @returns The child toolbox items.
      */
     getChildToolboxItems(): IToolboxItem[];
     /**
      * Whether the toolbox item is expanded to show its child subcategories.
-     * @return True if the toolbox item shows its children, false if it is
+     *
+     * @returns True if the toolbox item shows its children, false if it is
      *     collapsed.
      */
     isExpanded(): boolean;
     /** Toggles whether or not the toolbox item is expanded. */
     toggleExpanded(): void;
 }
+//# sourceMappingURL=i_collapsible_toolbox_item.d.ts.map

package/core/interfaces/i_component.d.ts

@@ -6,12 +6,14 @@
 /**
  * The interface for a workspace component that can be registered with the
  * ComponentManager.
+ *
  * @alias Blockly.IComponent
  */
 export interface IComponent {
     /**
-     * The unique id for this component that is used to register with the
+     * The unique ID for this component that is used to register with the
      * ComponentManager.
      */
     id: string;
 }
+//# sourceMappingURL=i_component.d.ts.map

package/core/interfaces/i_connection_checker.d.ts

@@ -7,63 +7,71 @@ import type { Connection } from '../connection.js';
 import type { RenderedConnection } from '../rendered_connection.js';
 /**
  * Class for connection type checking logic.
+ *
  * @alias Blockly.IConnectionChecker
  */
 export interface IConnectionChecker {
     /**
      * Check whether the current connection can connect with the target
      * connection.
+     *
      * @param a Connection to check compatibility with.
      * @param b Connection to check compatibility with.
      * @param isDragging True if the connection is being made by dragging a block.
      * @param opt_distance The max allowable distance between the connections for
      *     drag checks.
-     * @return Whether the connection is legal.
+     * @returns Whether the connection is legal.
      */
     canConnect(a: Connection | null, b: Connection | null, isDragging: boolean, opt_distance?: number): boolean;
     /**
      * Checks whether the current connection can connect with the target
      * connection, and return an error code if there are problems.
+     *
      * @param a Connection to check compatibility with.
      * @param b Connection to check compatibility with.
      * @param isDragging True if the connection is being made by dragging a block.
      * @param opt_distance The max allowable distance between the connections for
      *     drag checks.
-     * @return Connection.CAN_CONNECT if the connection is legal, an error code
+     * @returns Connection.CAN_CONNECT if the connection is legal, an error code
      *     otherwise.
      */
     canConnectWithReason(a: Connection | null, b: Connection | null, isDragging: boolean, opt_distance?: number): number;
     /**
      * Helper method that translates a connection error code into a string.
+     *
      * @param errorCode The error code.
      * @param a One of the two connections being checked.
      * @param b The second of the two connections being checked.
-     * @return A developer-readable error string.
+     * @returns A developer-readable error string.
      */
     getErrorMessage(errorCode: number, a: Connection | null, b: Connection | null): string;
     /**
      * Check that connecting the given connections is safe, meaning that it would
      * not break any of Blockly's basic assumptions (e.g. no self connections).
+     *
      * @param a The first of the connections to check.
      * @param b The second of the connections to check.
-     * @return An enum with the reason this connection is safe or unsafe.
+     * @returns An enum with the reason this connection is safe or unsafe.
      */
     doSafetyChecks(a: Connection | null, b: Connection | null): number;
     /**
      * Check whether this connection is compatible with another connection with
      * respect to the value type system.  E.g. square_root("Hello") is not
      * compatible.
+     *
      * @param a Connection to compare.
      * @param b Connection to compare against.
-     * @return True if the connections share a type.
+     * @returns True if the connections share a type.
      */
     doTypeChecks(a: Connection, b: Connection): boolean;
     /**
      * Check whether this connection can be made by dragging.
+     *
      * @param a Connection to compare.
      * @param b Connection to compare against.
      * @param distance The maximum allowable distance between connections.
-     * @return True if the connection is allowed during a drag.
+     * @returns True if the connection is allowed during a drag.
      */
     doDragChecks(a: RenderedConnection, b: RenderedConnection, distance: number): boolean;
 }
+//# sourceMappingURL=i_connection_checker.d.ts.map

package/core/interfaces/i_contextmenu.d.ts

@@ -7,7 +7,9 @@
 export interface IContextMenu {
     /**
      * Show the context menu for this object.
+     *
      * @param e Mouse event.
      */
     showContextMenu(e: Event): void;
 }
+//# sourceMappingURL=i_contextmenu.d.ts.map

package/core/interfaces/i_copyable.d.ts

@@ -9,7 +9,8 @@ import type { ISelectable } from './i_selectable.js';
 export interface ICopyable extends ISelectable {
     /**
      * Encode for copying.
-     * @return Copy metadata.
+     *
+     * @returns Copy metadata.
      * @internal
      */
     toCopyData(): CopyData | null;
@@ -22,3 +23,4 @@ export declare namespace ICopyable {
     }
 }
 export declare type CopyData = ICopyable.CopyData;
+//# sourceMappingURL=i_copyable.d.ts.map

package/core/interfaces/i_deletable.d.ts

@@ -5,12 +5,15 @@
  */
 /**
  * The interface for an object that can be deleted.
+ *
  * @alias Blockly.IDeletable
  */
 export interface IDeletable {
     /**
      * Get whether this object is deletable or not.
-     * @return True if deletable.
+     *
+     * @returns True if deletable.
      */
     isDeletable(): boolean;
 }
+//# sourceMappingURL=i_deletable.d.ts.map