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

package/core/interfaces/i_toolbox_item.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Interface for an item in the toolbox.
+ *
  * @alias Blockly.IToolboxItem
  */
 export interface IToolboxItem {
@@ -16,47 +17,56 @@ export interface IToolboxItem {
     init(): void;
     /**
      * Gets the div for the toolbox item.
-     * @return The div for the toolbox item.
+     *
+     * @returns The div for the toolbox item.
      */
     getDiv(): Element | null;
     /**
      * Gets a unique identifier for this toolbox item.
-     * @return The ID for the toolbox item.
+     *
+     * @returns The ID for the toolbox item.
      */
     getId(): string;
     /**
      * Gets the parent if the toolbox item is nested.
-     * @return The parent toolbox item, or null if this toolbox item is not
+     *
+     * @returns The parent toolbox item, or null if this toolbox item is not
      *     nested.
      */
     getParent(): IToolboxItem | null;
     /**
      * Gets the nested level of the category.
-     * @return The nested level of the category.
+     *
+     * @returns The nested level of the category.
      * @internal
      */
     getLevel(): number;
     /**
      * Whether the toolbox item is selectable.
-     * @return True if the toolbox item can be selected.
+     *
+     * @returns True if the toolbox item can be selected.
      */
     isSelectable(): boolean;
     /**
      * Whether the toolbox item is collapsible.
-     * @return True if the toolbox item is collapsible.
+     *
+     * @returns True if the toolbox item is collapsible.
      */
     isCollapsible(): boolean;
     /** Dispose of this toolbox item. No-op by default. */
     dispose(): void;
     /**
      * Gets the HTML element that is clickable.
-     * @return The HTML element that receives clicks.
+     *
+     * @returns The HTML element that receives clicks.
      */
     getClickTarget(): Element | null;
     /**
      * Sets whether the category is visible or not.
      * For a category to be visible its parent category must also be expanded.
+     *
      * @param isVisible True if category should be visible.
      */
     setVisible_(isVisible: boolean): void;
 }
+//# sourceMappingURL=i_toolbox_item.d.ts.map

package/core/internal_constants.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Number of characters to truncate a collapsed block to.
+ *
  * @alias Blockly.internalConstants.COLLAPSE_CHARS
  * @internal
  */
@@ -12,12 +13,14 @@ 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
  */
@@ -26,6 +29,7 @@ export declare const OPPOSITE_TYPE: number[];
  * String for use in the dropdown created in field_variable.
  * 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
  */
@@ -34,7 +38,9 @@ export declare const RENAME_VARIABLE_ID = "RENAME_VARIABLE_ID";
  * String for use in the dropdown created in field_variable.
  * 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";
+//# sourceMappingURL=internal_constants.d.ts.map

package/core/keyboard_nav/ast_node.d.ts

@@ -14,6 +14,7 @@ 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 {
@@ -41,6 +42,7 @@ export declare class ASTNode {
     constructor(type: string, location: IASTNodeLocation, opt_params?: Params);
     /**
      * Parse the optional parameters.
+     *
      * @param params The user specified parameters.
      */
     private processParams_;
@@ -48,25 +50,29 @@ export declare class ASTNode {
      * Gets the value pointed to by this node.
      * It is the callers responsibility to check the node type to figure out what
      * type of object they get back from this.
-     * @return The current field, connection, workspace, or block the cursor is
+     *
+     * @returns The current field, connection, workspace, or block the cursor is
      *     on.
      */
     getLocation(): IASTNodeLocation;
     /**
      * The type of the current location.
      * One of ASTNode.types
-     * @return The type of the location.
+     *
+     * @returns The type of the location.
      */
     getType(): string;
     /**
      * The coordinate on the workspace.
-     * @return The workspace coordinate or null if the location is not a
+     *
+     * @returns The workspace coordinate or null if the location is not a
      *     workspace.
      */
     getWsCoordinate(): Coordinate;
     /**
      * Whether the node points to a connection.
-     * @return [description]
+     *
+     * @returns [description]
      * @internal
      */
     isConnection(): boolean;
@@ -74,14 +80,16 @@ export declare class ASTNode {
      * Given an input find the next editable field or an input with a non null
      * connection in the same block. The current location must be an input
      * connection.
-     * @return The AST node holding the next field or connection or null if there
+     *
+     * @returns The AST node holding the next field or connection or null if there
      *     is no editable field or input connection after the given input.
      */
     private findNextForInput_;
     /**
      * Given a field find the next editable field or an input with a non null
      * connection in the same block. The current location must be a field.
-     * @return The AST node pointing to the next field or connection or null if
+     *
+     * @returns The AST node pointing to the next field or connection or null if
      *     there is no editable field or input connection after the given input.
      */
     private findNextForField_;
@@ -89,135 +97,153 @@ export declare class ASTNode {
      * Given an input find the previous editable field or an input with a non null
      * connection in the same block. The current location must be an input
      * connection.
-     * @return The AST node holding the previous field or connection.
+     *
+     * @returns The AST node holding the previous field or connection.
      */
     private findPrevForInput_;
     /**
      * Given a field find the previous editable field or an input with a non null
      * connection in the same block. The current location must be a field.
-     * @return The AST node holding the previous input or field.
+     *
+     * @returns The AST node holding the previous input or field.
      */
     private findPrevForField_;
     /**
      * Navigate between stacks of blocks on the workspace.
+     *
      * @param forward True to go forward. False to go backwards.
-     * @return The first block of the next stack or null if there are no blocks on
-     *     the workspace.
+     * @returns The first block of the next stack or null if there are no blocks
+     *     on the workspace.
      */
     private navigateBetweenStacks_;
     /**
      * Finds the top most AST node for a given block.
      * This is either the previous connection, output connection or block
      * depending on what kind of connections the block has.
+     *
      * @param block The block that we want to find the top connection on.
-     * @return The AST node containing the top connection.
+     * @returns The AST node containing the top connection.
      */
     private findTopASTNodeForBlock_;
     /**
      * Get the AST node pointing to the input that the block is nested under or if
      * the block is not nested then get the stack AST node.
+     *
      * @param block The source block of the current location.
-     * @return The AST node pointing to the input connection or the top block of
+     * @returns The AST node pointing to the input connection or the top block of
      *     the stack this block is in.
      */
     private getOutAstNodeForBlock_;
     /**
      * Find the first editable field or input with a connection on a given block.
+     *
      * @param block The source block of the current location.
-     * @return An AST node pointing to the first field or input.
+     * @returns An AST node pointing to the first field or input.
      * Null if there are no editable fields or inputs with connections on the
      * block.
      */
     private findFirstFieldOrInput_;
     /**
      * Finds the source block of the location of this node.
-     * @return The source block of the location, or null if the node is of type
+     *
+     * @returns The source block of the location, or null if the node is of type
      *     workspace.
      */
     getSourceBlock(): Block | null;
     /**
      * Find the element to the right of the current element in the AST.
-     * @return An AST node that wraps the next field, connection, block, or
+     *
+     * @returns An AST node that wraps the next field, connection, block, or
      *     workspace. Or null if there is no node to the right.
      */
     next(): ASTNode | null;
     /**
      * Find the element one level below and all the way to the left of the current
      * location.
-     * @return An AST node that wraps the next field, connection, workspace, or
+     *
+     * @returns An AST node that wraps the next field, connection, workspace, or
      *     block. Or null if there is nothing below this node.
      */
     in(): ASTNode | null;
     /**
      * Find the element to the left of the current element in the AST.
-     * @return An AST node that wraps the previous field, connection, workspace or
-     *     block. Or null if no node exists to the left.
-     * null.
+     *
+     * @returns An AST node that wraps the previous field, connection, workspace
+     *     or block. Or null if no node exists to the left. null.
      */
     prev(): ASTNode | null;
     /**
      * Find the next element that is one position above and all the way to the
      * left of the current location.
-     * @return An AST node that wraps the next field, connection, workspace or
+     *
+     * @returns An AST node that wraps the next field, connection, workspace or
      *     block. Or null if we are at the workspace level.
      */
     out(): ASTNode | null;
     /**
      * Whether an AST node of the given type points to a connection.
+     *
      * @param type The type to check.  One of ASTNode.types.
-     * @return True if a node of the given type points to a connection.
+     * @returns True if a node of the given type points to a connection.
      */
     private static isConnectionType_;
     /**
      * Create an AST node pointing to a field.
+     *
      * @param field The location of the AST node.
-     * @return An AST node pointing to a field.
+     * @returns An AST node pointing to a field.
      */
     static createFieldNode(field: Field): ASTNode | null;
     /**
      * Creates an AST node pointing to a connection. If the connection has a
      * parent input then create an AST node of type input that will hold the
      * connection.
+     *
      * @param connection This is the connection the node will point to.
-     * @return An AST node pointing to a connection.
+     * @returns An AST node pointing to a connection.
      */
     static createConnectionNode(connection: Connection): ASTNode | null;
     /**
      * Creates an AST node pointing to an input. Stores the input connection as
      * the location.
+     *
      * @param input The input used to create an AST node.
-     * @return An AST node pointing to a input.
+     * @returns An AST node pointing to a input.
      */
     static createInputNode(input: Input): ASTNode | null;
     /**
      * Creates an AST node pointing to a block.
+     *
      * @param block The block used to create an AST node.
-     * @return An AST node pointing to a block.
+     * @returns An AST node pointing to a block.
      */
     static createBlockNode(block: Block): ASTNode | null;
     /**
      * Create an AST node of type stack. A stack, represented by its top block, is
      *     the set of all blocks connected to a top block, including the top
      * block.
+     *
      * @param topBlock A top block has no parent and can be found in the list
      *     returned by workspace.getTopBlocks().
-     * @return An AST node of type stack that points to the top block on the
+     * @returns An AST node of type stack that points to the top block on the
      *     stack.
      */
     static createStackNode(topBlock: Block): ASTNode | null;
     /**
      * Creates an AST node pointing to a workspace.
+     *
      * @param workspace The workspace that we are on.
      * @param wsCoordinate The position on the workspace for this node.
-     * @return An AST node pointing to a workspace and a position on the
+     * @returns An AST node pointing to a workspace and a position on the
      *     workspace.
      */
     static createWorkspaceNode(workspace: Workspace | null, wsCoordinate: Coordinate | null): ASTNode | null;
     /**
      * Creates an AST node for the top position on a block.
      * This is either an output connection, previous connection, or block.
+     *
      * @param block The block to find the top most AST node on.
-     * @return The AST node holding the top most position on the block.
+     * @returns The AST node holding the top most position on the block.
      */
     static createTopNode(block: Block): ASTNode | null;
 }
@@ -237,3 +263,4 @@ export declare namespace ASTNode {
     }
 }
 export declare type Params = ASTNode.Params;
+//# sourceMappingURL=ast_node.d.ts.map

package/core/keyboard_nav/basic_cursor.d.ts

@@ -9,6 +9,7 @@ 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 {
@@ -18,7 +19,8 @@ export declare class BasicCursor extends Cursor {
     constructor();
     /**
      * Find the next node in the pre order traversal.
-     * @return The next node, or null if the current node is not set or there is
+     *
+     * @returns The next node, or null if the current node is not set or there is
      *     no next value.
      */
     next(): ASTNode | null;
@@ -26,13 +28,15 @@ export declare class BasicCursor extends Cursor {
      * For a basic cursor we only have the ability to go next and previous, so
      * in will also allow the user to get to the next node in the pre order
      * traversal.
-     * @return The next node, or null if the current node is not set or there is
+     *
+     * @returns The next node, or null if the current node is not set or there is
      *     no next value.
      */
     in(): ASTNode | null;
     /**
      * Find the previous node in the pre order traversal.
-     * @return The previous node, or null if the current node is not set or there
+     *
+     * @returns The previous node, or null if the current node is not set or there
      *     is no previous value.
      */
     prev(): ASTNode | null;
@@ -40,7 +44,8 @@ export declare class BasicCursor extends Cursor {
      * For a basic cursor we only have the ability to go next and previous, so
      * out will allow the user to get to the previous node in the pre order
      * traversal.
-     * @return The previous node, or null if the current node is not set or there
+     *
+     * @returns The previous node, or null if the current node is not set or there
      *     is no previous value.
      */
     out(): ASTNode | null;
@@ -48,41 +53,47 @@ export declare class BasicCursor extends Cursor {
      * Uses pre order traversal to navigate the Blockly AST. This will allow
      * a user to easily navigate the entire Blockly AST without having to go in
      * and out levels on the tree.
+     *
      * @param node The current position in the AST.
      * @param isValid A function true/false depending on whether the given node
      *     should be traversed.
-     * @return The next node in the traversal.
+     * @returns The next node in the traversal.
      */
     protected getNextNode_(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean): ASTNode | null;
     /**
      * Reverses the pre order traversal in order to find the previous node. This
      * will allow a user to easily navigate the entire Blockly AST without having
      * to go in and out levels on the tree.
+     *
      * @param node The current position in the AST.
      * @param isValid A function true/false depending on whether the given node
      *     should be traversed.
-     * @return The previous node in the traversal or null if no previous node
+     * @returns The previous node in the traversal or null if no previous node
      *     exists.
      */
     protected getPreviousNode_(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean): ASTNode | null;
     /**
      * Decides what nodes to traverse and which ones to skip. Currently, it
      * skips output, stack and workspace nodes.
+     *
      * @param node The AST node to check whether it is valid.
-     * @return True if the node should be visited, false otherwise.
+     * @returns True if the node should be visited, false otherwise.
      */
     protected validNode_(node: ASTNode | null): boolean;
     /**
      * From the given node find either the next valid sibling or parent.
+     *
      * @param node The current position in the AST.
-     * @return The parent AST node or null if there are no valid parents.
+     * @returns The parent AST node or null if there are no valid parents.
      */
     private findSiblingOrParent_;
     /**
      * Get the right most child of a node.
+     *
      * @param node The node to find the right most child of.
-     * @return The right most child of the given node, or the node if no child
+     * @returns The right most child of the given node, or the node if no child
      *     exists.
      */
     private getRightMostChild_;
 }
+//# sourceMappingURL=basic_cursor.d.ts.map

package/core/keyboard_nav/cursor.d.ts

@@ -8,6 +8,7 @@ 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 {
@@ -16,26 +17,31 @@ export declare class Cursor extends Marker {
     constructor();
     /**
      * Find the next connection, field, or block.
-     * @return The next element, or null if the current node is not set or there
+     *
+     * @returns The next element, or null if the current node is not set or there
      *     is no next value.
      */
     next(): ASTNode | null;
     /**
      * Find the in connection or field.
-     * @return The in element, or null if the current node is not set or there is
+     *
+     * @returns The in element, or null if the current node is not set or there is
      *     no in value.
      */
     in(): ASTNode | null;
     /**
      * Find the previous connection, field, or block.
-     * @return The previous element, or null if the current node is not set or
+     *
+     * @returns The previous element, or null if the current node is not set or
      *     there is no previous value.
      */
     prev(): ASTNode | null;
     /**
      * Find the out connection, field, or block.
-     * @return The out element, or null if the current node is not set or there is
-     *     no out value.
+     *
+     * @returns The out element, or null if the current node is not set or there
+     *     is no out value.
      */
     out(): ASTNode | null;
 }
+//# sourceMappingURL=cursor.d.ts.map

package/core/keyboard_nav/marker.d.ts

@@ -8,6 +8,7 @@ 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 {
@@ -26,28 +27,33 @@ export declare class Marker {
     constructor();
     /**
      * Sets the object in charge of drawing the marker.
+     *
      * @param drawer The object in charge of drawing the marker.
      */
     setDrawer(drawer: MarkerSvg): void;
     /**
      * Get the current drawer for the marker.
-     * @return The object in charge of drawing the marker.
+     *
+     * @returns The object in charge of drawing the marker.
      */
     getDrawer(): MarkerSvg;
     /**
      * Gets the current location of the marker.
-     * @return The current field, connection, or block the marker is on.
+     *
+     * @returns The current field, connection, or block the marker is on.
      */
     getCurNode(): ASTNode;
     /**
      * Set the location of the marker and call the update method.
      * Setting isStack to true will only work if the newLocation is the top most
      * output or previous connection on a stack.
+     *
      * @param newNode The new location of the marker.
      */
     setCurNode(newNode: ASTNode): void;
     /**
      * Redraw the current marker.
+     *
      * @internal
      */
     draw(): void;
@@ -56,3 +62,4 @@ export declare class Marker {
     /** Dispose of this marker. */
     dispose(): void;
 }
+//# sourceMappingURL=marker.d.ts.map

package/core/keyboard_nav/tab_navigate_cursor.d.ts

@@ -7,13 +7,16 @@ 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 {
     /**
      * Skip all nodes except for tab navigable fields.
+     *
      * @param node The AST node to check whether it is valid.
-     * @return True if the node should be visited, false otherwise.
+     * @returns True if the node should be visited, false otherwise.
      */
     validNode_(node: ASTNode | null): boolean;
 }
+//# sourceMappingURL=tab_navigate_cursor.d.ts.map

package/core/main.d.ts

@@ -9,3 +9,4 @@ declare const common: any;
 declare const deprecation: any;
 declare const dialog: any;
 declare const eventUtils: any;
+//# sourceMappingURL=main.d.ts.map

package/core/marker_manager.d.ts

@@ -8,6 +8,7 @@ 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 {
@@ -29,35 +30,41 @@ export declare class MarkerManager {
     constructor(workspace: WorkspaceSvg);
     /**
      * Register the marker by adding it to the map of markers.
+     *
      * @param id A unique identifier for the marker.
      * @param marker The marker to register.
      */
     registerMarker(id: string, marker: Marker): void;
     /**
      * Unregister the marker by removing it from the map of markers.
+     *
      * @param id The ID of the marker to unregister.
      */
     unregisterMarker(id: string): void;
     /**
      * Get the cursor for the workspace.
-     * @return The cursor for this workspace.
+     *
+     * @returns The cursor for this workspace.
      */
     getCursor(): Cursor | null;
     /**
      * Get a single marker that corresponds to the given ID.
+     *
      * @param id A unique identifier for the marker.
-     * @return The marker that corresponds to the given ID, or null if none
+     * @returns The marker that corresponds to the given ID, or null if none
      *     exists.
      */
     getMarker(id: string): Marker | null;
     /**
      * Sets the cursor and initializes the drawer for use with keyboard
      * navigation.
+     *
      * @param cursor The cursor used to move around this workspace.
      */
     setCursor(cursor: Cursor): void;
     /**
      * Add the cursor SVG to this workspace SVG group.
+     *
      * @param cursorSvg The SVG root of the cursor to be added to the workspace
      *     SVG group.
      * @internal
@@ -65,6 +72,7 @@ export declare class MarkerManager {
     setCursorSvg(cursorSvg: SVGElement | null): void;
     /**
      * Add the marker SVG to this workspaces SVG group.
+     *
      * @param markerSvg The SVG root of the marker to be added to the workspace
      *     SVG group.
      * @internal
@@ -72,14 +80,17 @@ export declare class MarkerManager {
     setMarkerSvg(markerSvg: SVGElement | null): void;
     /**
      * Redraw the attached cursor SVG if needed.
+     *
      * @internal
      */
     updateMarkers(): void;
     /**
      * Dispose of the marker manager.
      * Go through and delete all markers associated with this marker manager.
+     *
      * @suppress {checkTypes}
      * @internal
      */
     dispose(): void;
 }
+//# sourceMappingURL=marker_manager.d.ts.map