blockly 9.3.0-beta.0 → 9.3.1

package/core/interfaces/i_autohideable.d.ts

@@ -6,8 +6,6 @@
 import type { IComponent } from './i_component.js';
 /**
  * Interface for a component that can be automatically hidden.
- *
- * @alias Blockly.IAutoHideable
  */
 export interface IAutoHideable extends IComponent {
     /**

package/core/interfaces/i_block_dragger.d.ts

@@ -7,12 +7,10 @@ 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.
+     * 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.

package/core/interfaces/i_bounded_element.d.ts

@@ -6,8 +6,6 @@
 import type { Rect } from '../utils/rect.js';
 /**
  * A bounded element interface.
- *
- * @alias Blockly.IBoundedElement
  */
 export interface IBoundedElement {
     /**

package/core/interfaces/i_bubble.d.ts

@@ -4,12 +4,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Coordinate } from '../utils/coordinate.js';
+import type { BlockDragSurfaceSvg } from '../block_drag_surface.js';
 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 {
     /**
@@ -40,11 +39,14 @@ export interface IBubble extends IDraggable, IContextMenu {
      */
     setDragging(dragging: boolean): void;
     /**
-     * Move this bubble during a drag.
+     * 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.
      */
-    moveDuringDrag(newLoc: Coordinate): void;
+    moveDuringDrag(dragSurface: BlockDragSurfaceSvg | null, newLoc: Coordinate): void;
     /**
      * Move the bubble to the specified location in workspace coordinates.
      *

package/core/interfaces/i_collapsible_toolbox_item.d.ts

@@ -7,8 +7,6 @@ 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 {
     /**

package/core/interfaces/i_component.d.ts

@@ -6,8 +6,6 @@
 /**
  * The interface for a workspace component that can be registered with the
  * ComponentManager.
- *
- * @alias Blockly.IComponent
  */
 export interface IComponent {
     /**

package/core/interfaces/i_connection_checker.d.ts

@@ -7,8 +7,6 @@ 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 {
     /**

package/core/interfaces/i_contextmenu.d.ts

@@ -3,7 +3,6 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/** @alias Blockly.IContextMenu */
 export interface IContextMenu {
     /**
      * Show the context menu for this object.

package/core/interfaces/i_copyable.d.ts

@@ -5,7 +5,6 @@
  */
 import type { WorkspaceSvg } from '../workspace_svg.js';
 import type { ISelectable } from './i_selectable.js';
-/** @alias Blockly.ICopyable */
 export interface ICopyable extends ISelectable {
     /**
      * Encode for copying.
@@ -19,7 +18,9 @@ export declare namespace ICopyable {
     interface CopyData {
         saveInfo: Object | Element;
         source: WorkspaceSvg;
-        typeCounts: Object | null;
+        typeCounts: {
+            [key: string]: number;
+        } | null;
     }
 }
 export type CopyData = ICopyable.CopyData;

package/core/interfaces/i_deletable.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * The interface for an object that can be deleted.
- *
- * @alias Blockly.IDeletable
  */
 export interface IDeletable {
     /**

package/core/interfaces/i_delete_area.d.ts

@@ -8,8 +8,6 @@ import type { IDraggable } from './i_draggable.js';
 /**
  * Interface for a component that can delete a block or bubble that is dropped
  * on top of it.
- *
- * @alias Blockly.IDeleteArea
  */
 export interface IDeleteArea extends IDragTarget {
     /**

package/core/interfaces/i_drag_target.d.ts

@@ -9,8 +9,6 @@ import type { IComponent } from './i_component.js';
 /**
  * Interface for a component with custom behaviour when a block or bubble is
  * dragged over or dropped on top of it.
- *
- * @alias Blockly.IDragTarget
  */
 export interface IDragTarget extends IComponent {
     /**

package/core/interfaces/i_draggable.d.ts

@@ -6,8 +6,6 @@
 import type { IDeletable } from './i_deletable.js';
 /**
  * The interface for an object that can be dragged.
- *
- * @alias Blockly.IDraggable
  */
 export interface IDraggable extends IDeletable {
 }

package/core/interfaces/i_flyout.d.ts

@@ -11,8 +11,6 @@ import type { Svg } from '../utils/svg.js';
 import type { IRegistrable } from './i_registrable.js';
 /**
  * Interface for a flyout.
- *
- * @alias Blockly.IFlyout
  */
 export interface IFlyout extends IRegistrable {
     /** Whether the flyout is laid out horizontally or not. */

package/core/interfaces/i_keyboard_accessible.d.ts

@@ -6,8 +6,6 @@
 import { KeyboardShortcut } from '../shortcut_registry.js';
 /**
  * An interface for an object that handles keyboard shortcuts.
- *
- * @alias Blockly.IKeyboardAccessible
  */
 export interface IKeyboardAccessible {
     /**

package/core/interfaces/i_legacy_procedure_blocks.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Legacy means of representing a procedure signature. The elements are
+ * respectively: name, parameter names, and whether it has a return value.
+ */
+export type ProcedureTuple = [string, string[], boolean];
+/**
+ * Procedure block type.
+ *
+ * @internal
+ */
+export interface ProcedureBlock {
+    getProcedureCall: () => string;
+    renameProcedure: (p1: string, p2: string) => void;
+    getProcedureDef: () => ProcedureTuple;
+}
+/** @internal */
+export interface LegacyProcedureDefBlock {
+    getProcedureDef: () => ProcedureTuple;
+}
+/** @internal */
+export declare function isLegacyProcedureDefBlock(block: Object): block is LegacyProcedureDefBlock;
+/** @internal */
+export interface LegacyProcedureCallBlock {
+    getProcedureCall: () => string;
+    renameProcedure: (p1: string, p2: string) => void;
+}
+/** @internal */
+export declare function isLegacyProcedureCallBlock(block: Object): block is LegacyProcedureCallBlock;
+//# sourceMappingURL=i_legacy_procedure_blocks.d.ts.map

package/core/interfaces/i_metrics_manager.d.ts

@@ -8,8 +8,6 @@ import type { Size } from '../utils/size.js';
 import type { Metrics } from '../utils/metrics.js';
 /**
  * Interface for a metrics manager.
- *
- * @alias Blockly.IMetricsManager
  */
 export interface IMetricsManager {
     /**

package/core/interfaces/i_movable.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * The interface for an object that is movable.
- *
- * @alias Blockly.IMovable
  */
 export interface IMovable {
     /**

package/core/interfaces/i_positionable.d.ts

@@ -8,8 +8,6 @@ import type { UiMetrics } from '../metrics_manager.js';
 import type { IComponent } from './i_component.js';
 /**
  * Interface for a component that is positioned on top of the workspace.
- *
- * @alias Blockly.IPositionable
  */
 export interface IPositionable extends IComponent {
     /**

package/core/interfaces/i_procedure_model.d.ts

@@ -3,11 +3,6 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/**
- * The interface for the data model of a procedure.
- *
- * @namespace Blockly.IProcedureModel
- */
 import { IParameterModel } from './i_parameter_model.js';
 /**
  * A data model for a procedure.

package/core/interfaces/i_registrable.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * The interface for a Blockly component that can be registered.
- *
- * @alias Blockly.IRegistrable
  */
 export interface IRegistrable {
 }

package/core/interfaces/i_selectable.d.ts

@@ -7,8 +7,6 @@ import type { IDeletable } from './i_deletable.js';
 import type { IMovable } from './i_movable.js';
 /**
  * The interface for an object that is selectable.
- *
- * @alias Blockly.ISelectable
  */
 export interface ISelectable extends IDeletable, IMovable {
     id: string;

package/core/interfaces/i_selectable_toolbox_item.d.ts

@@ -7,8 +7,6 @@ import type { FlyoutItemInfoArray } from '../utils/toolbox';
 import type { IToolboxItem } from './i_toolbox_item.js';
 /**
  * Interface for an item in the toolbox that can be selected.
- *
- * @alias Blockly.ISelectableToolboxItem
  */
 export interface ISelectableToolboxItem extends IToolboxItem {
     /**
@@ -46,4 +44,8 @@ export interface ISelectableToolboxItem extends IToolboxItem {
      */
     onClick(_e: Event): void;
 }
+/**
+ * Type guard that checks whether an IToolboxItem is an ISelectableToolboxItem.
+ */
+export declare function isSelectableToolboxItem(toolboxItem: IToolboxItem): toolboxItem is ISelectableToolboxItem;
 //# sourceMappingURL=i_selectable_toolbox_item.d.ts.map

package/core/interfaces/i_serializer.d.ts

@@ -6,8 +6,6 @@
 import type { Workspace } from '../workspace.js';
 /**
  * Serializes and deserializes a plugin or system.
- *
- * @alias Blockly.serialization.ISerializer.ISerializer
  */
 export interface ISerializer {
     /**

package/core/interfaces/i_styleable.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * Interface for an object that a style can be added to.
- *
- * @alias Blockly.IStyleable
  */
 export interface IStyleable {
     /**

package/core/interfaces/i_toolbox.d.ts

@@ -10,8 +10,6 @@ import type { IFlyout } from './i_flyout.js';
 import type { WorkspaceSvg } from '../workspace_svg.js';
 /**
  * Interface for a toolbox.
- *
- * @alias Blockly.IToolbox
  */
 export interface IToolbox extends IRegistrable {
     /** Initializes the toolbox. */

package/core/interfaces/i_toolbox_item.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * Interface for an item in the toolbox.
- *
- * @alias Blockly.IToolboxItem
  */
 export interface IToolboxItem {
     /**

package/core/interfaces/i_variable_backed_parameter_model.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { VariableModel } from '../variable_model.js';
+import { IParameterModel } from './i_parameter_model.js';
+/** Interface for a parameter model that holds a variable model. */
+export interface IVariableBackedParameterModel extends IParameterModel {
+    /** Returns the variable model held by this type. */
+    getVariableModel(): VariableModel;
+}
+/**
+ * Returns whether the given object is a variable holder or not.
+ */
+export declare function isVariableBackedParameterModel(param: IParameterModel): param is IVariableBackedParameterModel;
+//# sourceMappingURL=i_variable_backed_parameter_model.d.ts.map

package/core/internal_constants.d.ts

@@ -6,7 +6,6 @@
 /**
  * Number of characters to truncate a collapsed block to.
  *
- * @alias Blockly.internalConstants.COLLAPSE_CHARS
  * @internal
  */
 export declare const COLLAPSE_CHARS = 30;
@@ -14,14 +13,12 @@ export declare const COLLAPSE_CHARS = 30;
  * When dragging a block out of a stack, split the stack in two (true), or drag
  * out the block healing the stack (false).
  *
- * @alias Blockly.internalConstants.DRAG_STACK
  * @internal
  */
 export declare const DRAG_STACK = true;
 /**
  * Lookup table for determining the opposite type of a connection.
  *
- * @alias Blockly.internalConstants.OPPOSITE_TYPE
  * @internal
  */
 export declare const OPPOSITE_TYPE: number[];
@@ -30,7 +27,6 @@ export declare const OPPOSITE_TYPE: number[];
  * This string indicates that this option in the dropdown is 'Rename
  * variable...' and if selected, should trigger the prompt to rename a variable.
  *
- * @alias Blockly.internalConstants.RENAME_VARIABLE_ID
  * @internal
  */
 export declare const RENAME_VARIABLE_ID = "RENAME_VARIABLE_ID";
@@ -39,7 +35,6 @@ export declare const RENAME_VARIABLE_ID = "RENAME_VARIABLE_ID";
  * This string indicates that this option in the dropdown is 'Delete the "%1"
  * variable' and if selected, should trigger the prompt to delete a variable.
  *
- * @alias Blockly.internalConstants.DELETE_VARIABLE_ID
  * @internal
  */
 export declare const DELETE_VARIABLE_ID = "DELETE_VARIABLE_ID";

package/core/keyboard_nav/ast_node.d.ts

@@ -14,8 +14,6 @@ import type { Workspace } from '../workspace.js';
  * Class for an AST node.
  * It is recommended that you use one of the createNode methods instead of
  * creating a node directly.
- *
- * @alias Blockly.ASTNode
  */
 export declare class ASTNode {
     /**
@@ -37,7 +35,6 @@ export declare class ASTNode {
      *     Must be in ASTNode.types.
      * @param location The position in the AST.
      * @param opt_params Optional dictionary of options.
-     * @alias Blockly.ASTNode
      */
     constructor(type: string, location: IASTNodeLocation, opt_params?: Params);
     /**

package/core/keyboard_nav/basic_cursor.d.ts

@@ -9,13 +9,10 @@ import { Cursor } from './cursor.js';
  * Class for a basic cursor.
  * This will allow the user to get to all nodes in the AST by hitting next or
  * previous.
- *
- * @alias Blockly.BasicCursor
  */
 export declare class BasicCursor extends Cursor {
     /** Name used for registering a basic cursor. */
     static readonly registrationName = "basicCursor";
-    /** @alias Blockly.BasicCursor */
     constructor();
     /**
      * Find the next node in the pre order traversal.

package/core/keyboard_nav/cursor.d.ts

@@ -8,12 +8,9 @@ import { Marker } from './marker.js';
 /**
  * Class for a cursor.
  * A cursor controls how a user navigates the Blockly AST.
- *
- * @alias Blockly.Cursor
  */
 export declare class Cursor extends Marker {
     type: string;
-    /** @alias Blockly.Cursor */
     constructor();
     /**
      * Find the next connection, field, or block.

package/core/keyboard_nav/marker.d.ts

@@ -8,8 +8,6 @@ import type { ASTNode } from './ast_node.js';
 /**
  * Class for a marker.
  * This is used in keyboard navigation to save a location in the Blockly AST.
- *
- * @alias Blockly.Marker
  */
 export declare class Marker {
     /** The colour of the marker. */

package/core/keyboard_nav/tab_navigate_cursor.d.ts

@@ -7,8 +7,6 @@ import { ASTNode } from './ast_node.js';
 import { BasicCursor } from './basic_cursor.js';
 /**
  * A cursor for navigating between tab navigable fields.
- *
- * @alias Blockly.TabNavigateCursor
  */
 export declare class TabNavigateCursor extends BasicCursor {
     /**

package/core/marker_manager.d.ts

@@ -8,8 +8,6 @@ import type { Marker } from './keyboard_nav/marker.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class to manage the multiple markers and the cursor on a workspace.
- *
- * @alias Blockly.MarkerManager
  */
 export declare class MarkerManager {
     private readonly workspace;

package/core/menu.d.ts

@@ -9,8 +9,6 @@ import { Coordinate } from './utils/coordinate.js';
 import type { Size } from './utils/size.js';
 /**
  * A basic menu class.
- *
- * @alias Blockly.Menu
  */
 export declare class Menu {
     /**

package/core/menuitem.d.ts

@@ -6,8 +6,6 @@
 import * as aria from './utils/aria.js';
 /**
  * Class representing an item in a menu.
- *
- * @alias Blockly.MenuItem
  */
 export declare class MenuItem {
     private readonly content;

package/core/metrics_manager.d.ts

@@ -12,8 +12,6 @@ import * as toolboxUtils from './utils/toolbox.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * The manager for all workspace metrics calculations.
- *
- * @alias Blockly.MetricsManager
  */
 export declare class MetricsManager implements IMetricsManager {
     /** The workspace to calculate metrics for. */

package/core/mutator.d.ts

@@ -13,8 +13,6 @@ import { Options } from './options.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a mutator dialog.
- *
- * @alias Blockly.Mutator
  */
 export declare class Mutator extends Icon {
     private quarkNames;

package/core/names.d.ts

@@ -7,8 +7,6 @@ import type { VariableMap } from './variable_map.js';
 import type { Workspace } from './workspace.js';
 /**
  * Class for a database of entity names (variables, procedures, etc).
- *
- * @alias Blockly.Names
  */
 export declare class Names {
     static DEVELOPER_VARIABLE_TYPE: NameType;
@@ -123,7 +121,6 @@ export declare namespace Names {
      * getName('foo', 'VARIABLE') = 'foo'
      * getName('foo', 'PROCEDURE') = 'foo2'
      *
-     * @alias Blockly.Names.NameType
      */
     enum NameType {
         DEVELOPER_VARIABLE = "DEVELOPER_VARIABLE",

package/core/options.d.ts

@@ -11,8 +11,6 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Parse the user-specified options, using reasonable defaults where behaviour
  * is unspecified.
- *
- * @alias Blockly.Options
  */
 export declare class Options {
     RTL: boolean;

package/core/positionable_helpers.d.ts

@@ -10,7 +10,6 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Enum for vertical positioning.
  *
- * @alias Blockly.uiPosition.verticalPosition
  * @internal
  */
 export declare enum verticalPosition {
@@ -20,7 +19,6 @@ export declare enum verticalPosition {
 /**
  * Enum for horizontal positioning.
  *
- * @alias Blockly.uiPosition.horizontalPosition
  * @internal
  */
 export declare enum horizontalPosition {
@@ -30,7 +28,6 @@ export declare enum horizontalPosition {
 /**
  * An object defining a horizontal and vertical positioning.
  *
- * @alias Blockly.uiPosition.Position
  * @internal
  */
 export interface Position {
@@ -40,7 +37,6 @@ export interface Position {
 /**
  * Enum for bump rules to use for dealing with collisions.
  *
- * @alias Blockly.uiPosition.bumpDirection
  * @internal
  */
 export declare enum bumpDirection {
@@ -60,7 +56,6 @@ export declare enum bumpDirection {
  * @param metrics The workspace UI metrics.
  * @param workspace The workspace.
  * @returns The suggested start position.
- * @alias Blockly.uiPosition.getStartPositionRect
  * @internal
  */
 export declare function getStartPositionRect(position: Position, size: Size, horizontalPadding: number, verticalPadding: number, metrics: UiMetrics, workspace: WorkspaceSvg): Rect;
@@ -73,7 +68,6 @@ export declare function getStartPositionRect(position: Position, size: Size, hor
  * @param workspace The workspace.
  * @param metrics The workspace metrics.
  * @returns The suggested corner position.
- * @alias Blockly.uiPosition.getCornerOppositeToolbox
  * @internal
  */
 export declare function getCornerOppositeToolbox(workspace: WorkspaceSvg, metrics: UiMetrics): Position;
@@ -89,7 +83,6 @@ export declare function getCornerOppositeToolbox(workspace: WorkspaceSvg, metric
  * @param savedPositions List of rectangles that represent the positions of UI
  *     elements already placed.
  * @returns The suggested position rectangle.
- * @alias Blockly.uiPosition.bumpPositionRect
  * @internal
  */
 export declare function bumpPositionRect(startRect: Rect, margin: number, bumpDir: bumpDirection, savedPositions: Rect[]): Rect;