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

package/core/connection_db.d.ts

@@ -10,6 +10,7 @@ import type { Coordinate } from './utils/coordinate.js';
  * Database of connections.
  * Connections are stored in order of their vertical component.  This way
  * connections in an area may be looked up quickly using a binary search.
+ *
  * @alias Blockly.ConnectionDB
  */
 export declare class ConnectionDB {
@@ -23,6 +24,7 @@ export declare class ConnectionDB {
     constructor(connectionChecker: IConnectionChecker);
     /**
      * Add a connection to the database. Should not already exist in the database.
+     *
      * @param connection The connection to be added.
      * @param yPos The y position used to decide where to insert the connection.
      * @internal
@@ -33,19 +35,23 @@ export declare class ConnectionDB {
      *
      * Starts by doing a binary search to find the approximate location, then
      * linearly searches nearby for the exact connection.
+     *
      * @param conn The connection to find.
      * @param yPos The y position used to find the index of the connection.
-     * @return The index of the connection, or -1 if the connection was not found.
+     * @returns The index of the connection, or -1 if the connection was not
+     *     found.
      */
     private findIndexOfConnection_;
     /**
      * Finds the correct index for the given y position.
+     *
      * @param yPos The y position used to decide where to insert the connection.
-     * @return The candidate index.
+     * @returns The candidate index.
      */
     private calculateIndexForYPos_;
     /**
      * Remove a connection from the database.  Must already exist in DB.
+     *
      * @param connection The connection to be removed.
      * @param yPos The y position used to find the index of the connection.
      * @throws {Error} If the connection cannot be found in the database.
@@ -54,27 +60,30 @@ export declare class ConnectionDB {
     /**
      * Find all nearby connections to the given connection.
      * Type checking does not apply, since this function is used for bumping.
+     *
      * @param connection The connection whose neighbours should be returned.
      * @param maxRadius The maximum radius to another connection.
-     * @return List of connections.
+     * @returns List of connections.
      */
     getNeighbours(connection: RenderedConnection, maxRadius: number): RenderedConnection[];
     /**
      * Is the candidate connection close to the reference connection.
      * Extremely fast; only looks at Y distance.
+     *
      * @param index Index in database of candidate connection.
      * @param baseY Reference connection's Y value.
      * @param maxRadius The maximum radius to another connection.
-     * @return True if connection is in range.
+     * @returns True if connection is in range.
      */
     private isInYRange_;
     /**
      * Find the closest compatible connection to this connection.
+     *
      * @param conn The connection searching for a compatible mate.
      * @param maxRadius The maximum radius to another connection.
      * @param dxy Offset between this connection's location in the database and
      *     the current location (as a result of dragging).
-     * @return Contains two properties: 'connection' which is either another
+     * @returns Contains two properties: 'connection' which is either another
      *     connection or null, and 'radius' which is the distance.
      */
     searchForClosest(conn: RenderedConnection, maxRadius: number, dxy: Coordinate): {
@@ -83,9 +92,11 @@ export declare class ConnectionDB {
     };
     /**
      * Initialize a set of connection DBs for a workspace.
+     *
      * @param checker The workspace's connection checker, used to decide if
      *     connections are valid during a drag.
-     * @return Array of databases.
+     * @returns Array of databases.
      */
     static init(checker: IConnectionChecker): ConnectionDB[];
 }
+//# sourceMappingURL=connection_db.d.ts.map

package/core/connection_type.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Enum for the type of a connection or input.
+ *
  * @alias Blockly.ConnectionType
  */
 export declare enum ConnectionType {
@@ -13,3 +14,4 @@ export declare enum ConnectionType {
     NEXT_STATEMENT = 3,
     PREVIOUS_STATEMENT = 4
 }
+//# sourceMappingURL=connection_type.d.ts.map

package/core/constants.d.ts

@@ -5,11 +5,14 @@
  */
 /**
  * The language-neutral ID given to the collapsed input.
+ *
  * @alias Blockly.constants.COLLAPSED_INPUT_NAME
  */
 export declare const COLLAPSED_INPUT_NAME = "_TEMP_COLLAPSED_INPUT";
 /**
  * The language-neutral ID given to the collapsed field.
+ *
  * @alias Blockly.constants.COLLAPSED_FIELD_NAME
  */
 export declare const COLLAPSED_FIELD_NAME = "_TEMP_COLLAPSED_FIELD";
+//# sourceMappingURL=constants.d.ts.map

package/core/contextmenu.d.ts

@@ -9,18 +9,21 @@ import { WorkspaceCommentSvg } from './workspace_comment_svg.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Gets the block the context menu is currently attached to.
- * @return The block the context menu is attached to.
+ *
+ * @returns The block the context menu is attached to.
  * @alias Blockly.ContextMenu.getCurrentBlock
  */
 export declare function getCurrentBlock(): Block | null;
 /**
  * Sets the block the context menu is currently attached to.
+ *
  * @param block The block the context menu is attached to.
  * @alias Blockly.ContextMenu.setCurrentBlock
  */
 export declare function setCurrentBlock(block: Block | null): void;
 /**
  * Construct the menu based on the list of options and show the menu.
+ *
  * @param e Mouse event.
  * @param options Array of menu options.
  * @param rtl True if RTL, false if LTR.
@@ -29,28 +32,32 @@ export declare function setCurrentBlock(block: Block | null): void;
 export declare function show(e: Event, options: (ContextMenuOption | LegacyContextMenuOption)[], rtl: boolean): void;
 /**
  * Hide the context menu.
+ *
  * @alias Blockly.ContextMenu.hide
  */
 export declare function hide(): void;
 /**
  * Dispose of the menu.
+ *
  * @alias Blockly.ContextMenu.dispose
  */
 export declare function dispose(): void;
 /**
  * Create a callback function that creates and configures a block,
  *   then places the new block next to the original.
+ *
  * @param block Original block.
  * @param xml XML representation of new block.
- * @return Function that creates a block.
+ * @returns Function that creates a block.
  * @alias Blockly.ContextMenu.callbackFactory
  */
 export declare function callbackFactory(block: Block, xml: Element): Function;
 /**
  * Make a context menu option for deleting the current workspace comment.
+ *
  * @param comment The workspace comment where the
  *     right-click originated.
- * @return A menu option,
+ * @returns A menu option,
  *     containing text, enabled, and a callback.
  * @alias Blockly.ContextMenu.commentDeleteOption
  * @internal
@@ -58,9 +65,10 @@ export declare function callbackFactory(block: Block, xml: Element): Function;
 export declare function commentDeleteOption(comment: WorkspaceCommentSvg): LegacyContextMenuOption;
 /**
  * Make a context menu option for duplicating the current workspace comment.
+ *
  * @param comment The workspace comment where the
  *     right-click originated.
- * @return A menu option,
+ * @returns A menu option,
  *     containing text, enabled, and a callback.
  * @alias Blockly.ContextMenu.commentDuplicateOption
  * @internal
@@ -68,13 +76,15 @@ export declare function commentDeleteOption(comment: WorkspaceCommentSvg): Legac
 export declare function commentDuplicateOption(comment: WorkspaceCommentSvg): LegacyContextMenuOption;
 /**
  * Make a context menu option for adding a comment on the workspace.
+ *
  * @param ws The workspace where the right-click
  *     originated.
  * @param e The right-click mouse event.
- * @return A menu option, containing text, enabled, and a callback.
+ * @returns A menu option, containing text, enabled, and a callback.
  * @suppress {strictModuleDepCheck,checkTypes} Suppress checks while workspace
  *     comments are not bundled in.
  * @alias Blockly.ContextMenu.workspaceCommentOption
  * @internal
  */
 export declare function workspaceCommentOption(ws: WorkspaceSvg, e: Event): ContextMenuOption;
+//# sourceMappingURL=contextmenu.d.ts.map

package/core/contextmenu_items.d.ts

@@ -5,73 +5,88 @@
  */
 /**
  * Option to undo previous action.
+ *
  * @alias Blockly.ContextMenuItems.registerUndo
  */
 export declare function registerUndo(): void;
 /**
  * Option to redo previous action.
+ *
  * @alias Blockly.ContextMenuItems.registerRedo
  */
 export declare function registerRedo(): void;
 /**
  * Option to clean up blocks.
+ *
  * @alias Blockly.ContextMenuItems.registerCleanup
  */
 export declare function registerCleanup(): void;
 /**
  * Option to collapse all blocks.
+ *
  * @alias Blockly.ContextMenuItems.registerCollapse
  */
 export declare function registerCollapse(): void;
 /**
  * Option to expand all blocks.
+ *
  * @alias Blockly.ContextMenuItems.registerExpand
  */
 export declare function registerExpand(): void;
 /**
  * Option to delete all blocks.
+ *
  * @alias Blockly.ContextMenuItems.registerDeleteAll
  */
 export declare function registerDeleteAll(): void;
 /**
  * Option to duplicate a block.
+ *
  * @alias Blockly.ContextMenuItems.registerDuplicate
  */
 export declare function registerDuplicate(): void;
 /**
  * Option to add or remove block-level comment.
+ *
  * @alias Blockly.ContextMenuItems.registerComment
  */
 export declare function registerComment(): void;
 /**
  * Option to inline variables.
+ *
  * @alias Blockly.ContextMenuItems.registerInline
  */
 export declare function registerInline(): void;
 /**
  * Option to collapse or expand a block.
+ *
  * @alias Blockly.ContextMenuItems.registerCollapseExpandBlock
  */
 export declare function registerCollapseExpandBlock(): void;
 /**
  * Option to disable or enable a block.
+ *
  * @alias Blockly.ContextMenuItems.registerDisable
  */
 export declare function registerDisable(): void;
 /**
  * Option to delete a block.
+ *
  * @alias Blockly.ContextMenuItems.registerDelete
  */
 export declare function registerDelete(): void;
 /**
  * Option to open help for a block.
+ *
  * @alias Blockly.ContextMenuItems.registerHelp
  */
 export declare function registerHelp(): void;
 /**
  * Registers all default context menu items. This should be called once per
  * instance of ContextMenuRegistry.
+ *
  * @alias Blockly.ContextMenuItems.registerDefaultOptions
  * @internal
  */
 export declare function registerDefaultOptions(): void;
+//# sourceMappingURL=contextmenu_items.d.ts.map

package/core/contextmenu_registry.d.ts

@@ -9,6 +9,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * 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
  */
 export declare class ContextMenuRegistry {
@@ -21,30 +22,33 @@ export declare class ContextMenuRegistry {
     reset(): void;
     /**
      * Registers a RegistryItem.
+     *
      * @param item Context menu item to register.
      * @throws {Error} if an item with the given ID already exists.
      */
     register(item: RegistryItem): void;
     /**
      * Unregisters a RegistryItem with the given ID.
+     *
      * @param id The ID of the RegistryItem to remove.
      * @throws {Error} if an item with the given ID does not exist.
      */
     unregister(id: string): void;
     /**
      * @param id The ID of the RegistryItem to get.
-     * @return RegistryItem or null if not found
+     * @returns RegistryItem or null if not found
      */
     getItem(id: string): RegistryItem | 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 scopeType Type of scope where menu should be shown (e.g. on a block
      *     or on a workspace)
      * @param scope Current scope of context menu (i.e., the exact workspace or
      *     block being clicked on)
-     * @return the list of ContextMenuOptions
+     * @returns the list of ContextMenuOptions
      */
     getContextMenuOptions(scopeType: ScopeType, scope: Scope): ContextMenuOption[];
 }
@@ -63,14 +67,14 @@ export declare namespace ContextMenuRegistry {
      * to callback and displayText functions that depend on this information.
      */
     interface Scope {
-        block: BlockSvg | undefined;
-        workspace: WorkspaceSvg | undefined;
+        block?: BlockSvg;
+        workspace?: WorkspaceSvg;
     }
     /**
      * A menu item as entered in the registry.
      */
     interface RegistryItem {
-        callback: (p1: Scope) => any;
+        callback: (p1: Scope) => void;
         scopeType: ScopeType;
         displayText: ((p1: Scope) => string) | string;
         preconditionFn: (p1: Scope) => string;
@@ -83,7 +87,7 @@ export declare namespace ContextMenuRegistry {
     interface ContextMenuOption {
         text: string;
         enabled: boolean;
-        callback: (p1: Scope) => any;
+        callback: (p1: Scope) => void;
         scope: Scope;
         weight: number;
     }
@@ -94,7 +98,7 @@ export declare namespace ContextMenuRegistry {
     interface LegacyContextMenuOption {
         text: string;
         enabled: boolean;
-        callback: (p1: Scope) => any;
+        callback: (p1: Scope) => void;
     }
 }
 export declare type ScopeType = ContextMenuRegistry.ScopeType;
@@ -103,3 +107,4 @@ export declare type Scope = ContextMenuRegistry.Scope;
 export declare type RegistryItem = ContextMenuRegistry.RegistryItem;
 export declare type ContextMenuOption = ContextMenuRegistry.ContextMenuOption;
 export declare type LegacyContextMenuOption = ContextMenuRegistry.LegacyContextMenuOption;
+//# sourceMappingURL=contextmenu_registry.d.ts.map

package/core/css.d.ts

@@ -6,6 +6,7 @@
 /**
  * Add some CSS to the blob that will be injected later.  Allows optional
  * components such as fields and the toolbox to store separate CSS.
+ *
  * @param cssContent Multiline CSS string or an array of single lines of CSS.
  * @alias Blockly.Css.register
  */
@@ -16,9 +17,11 @@ export declare function register(cssContent: string | string[]): void;
  * a) It loads synchronously and doesn't force a redraw later.
  * b) It speeds up loading by not blocking on a separate HTTP transfer.
  * c) The CSS content may be made dynamic depending on init options.
+ *
  * @param hasCss If false, don't inject CSS (providing CSS becomes the
  *     document's responsibility).
  * @param pathToMedia Path from page to the Blockly media directory.
  * @alias Blockly.Css.inject
  */
 export declare function inject(hasCss: boolean, pathToMedia: string): void;
+//# sourceMappingURL=css.d.ts.map

package/core/delete_area.d.ts

@@ -9,6 +9,7 @@ import type { IDraggable } from './interfaces/i_draggable.js';
 /**
  * Abstract class for a component that can delete a block or bubble that is
  * dropped on top of it.
+ *
  * @alias Blockly.DeleteArea
  */
 export declare class DeleteArea extends DragTarget implements IDeleteArea {
@@ -33,15 +34,18 @@ export declare class DeleteArea extends DragTarget implements IDeleteArea {
      * this area.
      * This method should check if the element is deletable and is always called
      * before onDragEnter/onDragOver/onDragExit.
+     *
      * @param element The block or bubble currently being dragged.
      * @param couldConnect Whether the element could could connect to another.
-     * @return Whether the element provided would be deleted if dropped on this
+     * @returns Whether the element provided would be deleted if dropped on this
      *     area.
      */
     wouldDelete(element: IDraggable, couldConnect: boolean): boolean;
     /**
      * Updates the internal wouldDelete_ state.
+     *
      * @param wouldDelete The new value for the wouldDelete state.
      */
     protected updateWouldDelete_(wouldDelete: boolean): void;
 }
+//# sourceMappingURL=delete_area.d.ts.map

package/core/dialog.d.ts

@@ -6,56 +6,63 @@
 /**
  * Wrapper to window.alert() that app developers may override via setAlert to
  * provide alternatives to the modal browser window.
+ *
  * @param message The message to display to the user.
  * @param opt_callback The callback when the alert is dismissed.
  * @alias Blockly.dialog.alert
  */
-export declare function alert(message: string, opt_callback?: () => any): void;
+export declare function alert(message: string, opt_callback?: () => void): void;
 /**
  * Sets the function to be run when Blockly.dialog.alert() is called.
+ *
  * @param alertFunction The function to be run.
  * @see Blockly.dialog.alert
  * @alias Blockly.dialog.setAlert
  */
-export declare function setAlert(alertFunction: (p1: string, p2?: () => any) => any): void;
+export declare function setAlert(alertFunction: (p1: string, p2?: () => void) => void): void;
 /**
  * Wrapper to window.confirm() that app developers may override via setConfirm
  * to provide alternatives to the modal browser window.
+ *
  * @param message The message to display to the user.
  * @param callback The callback for handling user response.
  * @alias Blockly.dialog.confirm
  */
-export declare function confirm(message: string, callback: (p1: boolean) => any): void;
+export declare function confirm(message: string, callback: (p1: boolean) => void): void;
 /**
  * Private version of confirm for stubbing in tests.
  */
-declare function confirmInternal(message: string, callback: (p1: boolean) => any): void;
+declare function confirmInternal(message: string, callback: (p1: boolean) => void): void;
 /**
  * Sets the function to be run when Blockly.dialog.confirm() is called.
+ *
  * @param confirmFunction The function to be run.
  * @see Blockly.dialog.confirm
  * @alias Blockly.dialog.setConfirm
  */
-export declare function setConfirm(confirmFunction: (p1: string, p2: (p1: boolean) => any) => any): void;
+export declare function setConfirm(confirmFunction: (p1: string, p2: (p1: boolean) => void) => void): void;
 /**
  * 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 message The message to display to the user.
  * @param defaultValue The value to initialize the prompt with.
  * @param callback The callback for handling user response.
  * @alias Blockly.dialog.prompt
  */
-export declare function prompt(message: string, defaultValue: string, callback: (p1: string | null) => any): void;
+export declare function prompt(message: string, defaultValue: string, callback: (p1: string | null) => void): void;
 /**
  * Sets the function to be run when Blockly.dialog.prompt() is called.
+ *
  * @param promptFunction The function to be run.
  * @see Blockly.dialog.prompt
  * @alias Blockly.dialog.setPrompt
  */
-export declare function setPrompt(promptFunction: (p1: string, p2: string, p3: (p1: string | null) => any) => any): void;
+export declare function setPrompt(promptFunction: (p1: string, p2: string, p3: (p1: string | null) => void) => void): void;
 export declare const TEST_ONLY: {
     confirmInternal: typeof confirmInternal;
 };
 export {};
+//# sourceMappingURL=dialog.d.ts.map

package/core/drag_target.d.ts

@@ -9,6 +9,7 @@ import type { Rect } from './utils/rect.js';
 /**
  * Abstract class for a component with custom behaviour when a block or bubble
  * is dragged over or dropped on top of it.
+ *
  * @alias Blockly.DragTarget
  */
 export declare class DragTarget implements IDragTarget {
@@ -24,30 +25,35 @@ export declare class DragTarget implements IDragTarget {
     constructor();
     /**
      * Handles when a cursor with a block or bubble enters this drag target.
+     *
      * @param _dragElement The block or bubble currently being dragged.
      */
     onDragEnter(_dragElement: IDraggable): void;
     /**
      * Handles when a cursor with a block or bubble is dragged over this drag
      * target.
+     *
      * @param _dragElement The block or bubble currently being dragged.
      */
     onDragOver(_dragElement: IDraggable): void;
     /**
      * Handles when a cursor with a block or bubble exits this drag target.
+     *
      * @param _dragElement The block or bubble currently being dragged.
      */
     onDragExit(_dragElement: IDraggable): void;
     /**
      * Handles when a block or bubble is dropped on this component.
      * Should not handle delete here.
+     *
      * @param _dragElement The block or bubble currently being dragged.
      */
     onDrop(_dragElement: IDraggable): void;
     /**
      * Returns the bounding rectangle of the drag target area in pixel units
      * relative to the Blockly injection div.
-     * @return The component's bounding box. Null if drag target area should be
+     *
+     * @returns The component's bounding box. Null if drag target area should be
      *     ignored.
      */
     getClientRect(): Rect | null;
@@ -55,9 +61,11 @@ export declare class DragTarget implements IDragTarget {
      * 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 _dragElement The block or bubble currently being dragged.
-     * @return Whether the block or bubble provided should be returned to drag
+     * @returns Whether the block or bubble provided should be returned to drag
      *     start.
      */
     shouldPreventMove(_dragElement: IDraggable): boolean;
 }
+//# sourceMappingURL=drag_target.d.ts.map