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

package/core/comment.d.ts

@@ -10,6 +10,7 @@ import { Icon } from './icon.js';
 import type { Size } from './utils/size.js';
 /**
  * Class for a comment.
+ *
  * @alias Blockly.Comment
  */
 export declare class Comment extends Icon {
@@ -35,17 +36,18 @@ export declare class Comment extends Icon {
     private textarea_;
     /** The top-level node of the comment text, or null if not created. */
     private paragraphElement_;
-    bubble_: any;
     /** @param block The block associated with this comment. */
     constructor(block: BlockSvg);
     /**
      * Draw the comment icon.
+     *
      * @param group The icon group.
      */
     protected drawIcon_(group: Element): void;
     /**
      * Create the editor for the comment's bubble.
-     * @return The top-level node of the editor.
+     *
+     * @returns The top-level node of the editor.
      */
     private createEditor_;
     /** Add or remove editability of the comment. */
@@ -62,6 +64,7 @@ export declare class Comment extends Icon {
     private resizeTextarea_;
     /**
      * Show or hide the comment bubble.
+     *
      * @param visible True if the bubble should be visible.
      */
     setVisible(visible: boolean): void;
@@ -71,11 +74,13 @@ export declare class Comment extends Icon {
     private createEditableBubble_;
     /**
      * Show a non-editable bubble.
+     *
      * @suppress {checkTypes} Suppress `this` type mismatch.
      */
     private createNonEditableBubble_;
     /**
      * Dispose of the bubble.
+     *
      * @suppress {checkTypes} Suppress `this` type mismatch.
      */
     private disposeBubble_;
@@ -84,22 +89,26 @@ export declare class Comment extends Icon {
      *
      * Bring the comment to the top of the stack when clicked on. Also cache the
      * current text so it can be used to fire a change event.
+     *
      * @param _e Mouse up event.
      */
     private startEdit_;
     /**
      * Get the dimensions of this comment's bubble.
-     * @return Object with width and height properties.
+     *
+     * @returns Object with width and height properties.
      */
     getBubbleSize(): Size;
     /**
      * Size this comment's bubble.
+     *
      * @param width Width of the bubble.
      * @param height Height of the bubble.
      */
     setBubbleSize(width: number, height: number): void;
     /**
      * Update the comment's view to match the model.
+     *
      * @internal
      */
     updateText(): void;
@@ -111,3 +120,4 @@ export declare class Comment extends Icon {
      */
     dispose(): void;
 }
+//# sourceMappingURL=comment.d.ts.map

package/core/common.d.ts

@@ -11,33 +11,48 @@ import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Find the workspace with the specified ID.
+ *
  * @param id ID of workspace to find.
- * @return The sought after workspace or null if not found.
+ * @returns The sought after workspace or null if not found.
  */
 export declare function getWorkspaceById(id: string): Workspace | null;
 /**
  * Find all workspaces.
- * @return Array of workspaces.
+ *
+ * @returns Array of workspaces.
  */
 export declare function getAllWorkspaces(): Workspace[];
+/**
+ * Register a workspace in the workspace db.
+ *
+ * @param workspace
+ */
 export declare function registerWorkspace(workspace: Workspace): void;
+/**
+ * Unregister a workspace from the workspace db.
+ *
+ * @param workspace
+ */
 export declare function unregisterWorkpace(workspace: Workspace): void;
 /**
  * Returns the last used top level workspace (based on focus).  Try not to use
  * this function, particularly if there are multiple Blockly instances on a
  * page.
- * @return The main workspace.
+ *
+ * @returns The main workspace.
  * @alias Blockly.common.getMainWorkspace
  */
 export declare function getMainWorkspace(): Workspace;
 /**
  * Sets last used main workspace.
+ *
  * @param workspace The most recently used top level workspace.
  * @alias Blockly.common.setMainWorkspace
  */
 export declare function setMainWorkspace(workspace: Workspace): void;
 /**
  * Returns the currently selected copyable object.
+ *
  * @alias Blockly.common.getSelected
  */
 export declare function getSelected(): ICopyable | null;
@@ -45,15 +60,17 @@ export declare function getSelected(): ICopyable | null;
  * Sets the currently selected block. This function does not visually mark the
  * block as selected or fire the required events. If you wish to
  * programmatically select a block, use `BlockSvg#select`.
+ *
  * @param newSelection The newly selected block.
  * @alias Blockly.common.setSelected
  * @internal
  */
 export declare function setSelected(newSelection: ICopyable | null): void;
 /**
- * Get the container element in which to render the WidgetDiv, DropDownDiv and\
+ * Get the container element in which to render the WidgetDiv, DropDownDiv and
  * Tooltip.
- * @return The parent container.
+ *
+ * @returns The parent container.
  * @alias Blockly.common.getParentContainer
  */
 export declare function getParentContainer(): Element | null;
@@ -61,7 +78,8 @@ export declare function getParentContainer(): Element | null;
  * Set the parent container.  This is the container element that the WidgetDiv,
  * DropDownDiv, and Tooltip are rendered into the first time `Blockly.inject`
  * is called.
- * This method is a NOP if called after the first ``Blockly.inject``.
+ * This method is a NOP if called after the first `Blockly.inject`.
+ *
  * @param newParent The container element.
  * @alias Blockly.common.setParentContainer
  */
@@ -72,6 +90,7 @@ export declare function setParentContainer(newParent: Element): void;
  * See workspace.resizeContents to resize the workspace when the contents
  * change (e.g. when a block is added or removed).
  * Record the height/width of the SVG image.
+ *
  * @param workspace Any workspace in the SVG.
  * @alias Blockly.common.svgResize
  */
@@ -83,17 +102,21 @@ export declare const draggingConnections: Connection[];
 /**
  * Get a map of all the block's descendants mapping their type to the number of
  *    children with that type.
+ *
  * @param block The block to map.
  * @param opt_stripFollowing Optionally ignore all following
  *    statements (blocks that are not inside a value or statement input
  *    of the block).
- * @return Map of types to type counts for descendants of the bock.
+ * @returns Map of types to type counts for descendants of the bock.
  * @alias Blockly.common.getBlockTypeCounts
  */
-export declare function getBlockTypeCounts(block: Block, opt_stripFollowing?: boolean): any;
+export declare function getBlockTypeCounts(block: Block, opt_stripFollowing?: boolean): {
+    [key: string]: number;
+};
 /**
  * Define blocks from an array of JSON block definitions, as might be generated
  * by the Blockly Developer Tools.
+ *
  * @param jsonArray An array of JSON block definitions.
  * @alias Blockly.common.defineBlocksWithJsonArray
  */
@@ -105,8 +128,9 @@ declare function defineBlocksWithJsonArrayInternal(jsonArray: any[]): void;
 /**
  * Define blocks from an array of JSON block definitions, as might be generated
  * by the Blockly Developer Tools.
+ *
  * @param jsonArray An array of JSON block definitions.
- * @return A map of the block
+ * @returns A map of the block
  *     definitions created.
  * @alias Blockly.common.defineBlocksWithJsonArray
  */
@@ -116,6 +140,7 @@ export declare function createBlockDefinitionsFromJsonArray(jsonArray: any[]): {
 /**
  * Add the specified block definitions to the block definitions
  * dictionary (Blockly.Blocks).
+ *
  * @param blocks A map of block
  *     type names to block definitions.
  * @alias Blockly.common.defineBlocks
@@ -127,3 +152,4 @@ export declare const TEST_ONLY: {
     defineBlocksWithJsonArrayInternal: typeof defineBlocksWithJsonArrayInternal;
 };
 export {};
+//# sourceMappingURL=common.d.ts.map

package/core/component_manager.d.ts

@@ -8,7 +8,7 @@ import type { IComponent } from './interfaces/i_component.js';
 import type { IDeleteArea } from './interfaces/i_delete_area.js';
 import type { IDragTarget } from './interfaces/i_drag_target.js';
 import type { IPositionable } from './interfaces/i_positionable.js';
-declare class Capability<T> {
+declare class Capability<_T> {
     static POSITIONABLE: Capability<IPositionable>;
     static DRAG_TARGET: Capability<IDragTarget>;
     static DELETE_AREA: Capability<IDeleteArea>;
@@ -18,12 +18,14 @@ declare class Capability<T> {
     constructor(name: string);
     /**
      * Returns the name of the capability.
-     * @return The name.
+     *
+     * @returns The name.
      */
     toString(): string;
 }
 /**
  * Manager for all items registered with the workspace.
+ *
  * @alias Blockly.ComponentManager
  */
 export declare class ComponentManager {
@@ -36,6 +38,7 @@ export declare class ComponentManager {
     private readonly capabilityToComponentIds;
     /**
      * Adds a component.
+     *
      * @param componentInfo The data for the component to register.
      * @param opt_allowOverrides True to prevent an error when overriding an
      *     already registered item.
@@ -43,41 +46,47 @@ export declare class ComponentManager {
     addComponent(componentInfo: ComponentDatum, opt_allowOverrides?: boolean): void;
     /**
      * Removes a component.
+     *
      * @param id The ID of the component to remove.
      */
     removeComponent(id: string): void;
     /**
      * Adds a capability to a existing registered component.
+     *
      * @param id The ID of the component to add the capability to.
      * @param capability The capability to add.
      */
     addCapability<T>(id: string, capability: string | Capability<T>): void;
     /**
      * Removes a capability from an existing registered component.
+     *
      * @param id The ID of the component to remove the capability from.
      * @param capability The capability to remove.
      */
     removeCapability<T>(id: string, capability: string | Capability<T>): void;
     /**
      * Returns whether the component with this id has the specified capability.
+     *
      * @param id The ID of the component to check.
      * @param capability The capability to check for.
-     * @return Whether the component has the capability.
+     * @returns Whether the component has the capability.
      */
     hasCapability<T>(id: string, capability: string | Capability<T>): boolean;
     /**
      * Gets the component with the given ID.
+     *
      * @param id The ID of the component to get.
-     * @return The component with the given name or undefined if not found.
+     * @returns The component with the given name or undefined if not found.
      */
     getComponent(id: string): IComponent | undefined;
     /**
      * Gets all the components with the specified capability.
+     *
      * @param capability The capability of the component.
      * @param sorted Whether to return list ordered by weights.
-     * @return The components that match the specified capability.
+     * @returns The components that match the specified capability.
      */
-    getComponents<T>(capability: string | Capability<T>, sorted: boolean): T[];
+    getComponents<T extends IComponent>(capability: string | Capability<T>, sorted: boolean): T[];
 }
 export declare namespace ComponentManager {
     /** An object storing component information. */
@@ -89,3 +98,4 @@ export declare namespace ComponentManager {
 }
 export declare type ComponentDatum = ComponentManager.ComponentDatum;
 export {};
+//# sourceMappingURL=component_manager.d.ts.map

package/core/config.d.ts

@@ -21,3 +21,4 @@ interface Config {
  */
 export declare const config: Config;
 export {};
+//# sourceMappingURL=config.d.ts.map

package/core/connection.d.ts

@@ -10,6 +10,7 @@ import type { IConnectionChecker } from './interfaces/i_connection_checker.js';
 import * as blocks from './serialization/blocks.js';
 /**
  * Class for a connection between blocks.
+ *
  * @alias Blockly.Connection
  */
 export declare class Connection implements IASTNodeLocationWithBlock {
@@ -29,6 +30,7 @@ export declare class Connection implements IASTNodeLocationWithBlock {
     targetConnection: Connection | null;
     /**
      * Has this connection been disposed of?
+     *
      * @internal
      */
     disposed: boolean;
@@ -38,11 +40,13 @@ export declare class Connection implements IASTNodeLocationWithBlock {
     private shadowDom_;
     /**
      * Horizontal location of this connection.
+     *
      * @internal
      */
     x: number;
     /**
      * Vertical location of this connection.
+     *
      * @internal
      */
     y: number;
@@ -55,39 +59,46 @@ export declare class Connection implements IASTNodeLocationWithBlock {
     /**
      * Connect two connections together.  This is the connection on the superior
      * block.
+     *
      * @param childConnection Connection on inferior block.
      */
     protected connect_(childConnection: Connection): void;
     /**
      * Dispose of this connection and deal with connected blocks.
+     *
      * @internal
      */
     dispose(): void;
     /**
      * Get the source block for this connection.
-     * @return The source block.
+     *
+     * @returns The source block.
      */
     getSourceBlock(): Block;
     /**
      * Does the connection belong to a superior block (higher in the source
      * stack)?
-     * @return True if connection faces down or right.
+     *
+     * @returns True if connection faces down or right.
      */
     isSuperior(): boolean;
     /**
      * Is the connection connected?
-     * @return True if connection is connected to another connection.
+     *
+     * @returns True if connection is connected to another connection.
      */
     isConnected(): boolean;
     /**
      * Get the workspace's connection type checker object.
-     * @return The connection type checker for the source block's workspace.
+     *
+     * @returns The connection type checker for the source block's workspace.
      * @internal
      */
     getConnectionChecker(): IConnectionChecker;
     /**
      * Called when an attempted connection fails. NOP by default (i.e. for
      * headless workspaces).
+     *
      * @param _otherConnection Connection that this connection failed to connect
      *     to.
      * @internal
@@ -95,14 +106,16 @@ export declare class Connection implements IASTNodeLocationWithBlock {
     onFailedConnect(_otherConnection: Connection): void;
     /**
      * Connect this connection to another connection.
+     *
      * @param otherConnection Connection to connect to.
-     * @return Whether the the blocks are now connected or not.
+     * @returns Whether the the blocks are now connected or not.
      */
     connect(otherConnection: Connection): boolean;
     /** Disconnect this connection. */
     disconnect(): void;
     /**
      * Disconnect two blocks that are connected by this connection.
+     *
      * @param parentBlock The superior block.
      * @param childBlock The inferior block.
      */
@@ -113,7 +126,8 @@ export declare class Connection implements IASTNodeLocationWithBlock {
     protected respawnShadow_(): void;
     /**
      * Returns the block that this connection connects to.
-     * @return The connected block or null if none is connected.
+     *
+     * @returns The connected block or null if none is connected.
      */
     targetBlock(): Block | null;
     /**
@@ -122,44 +136,50 @@ export declare class Connection implements IASTNodeLocationWithBlock {
     protected onCheckChanged_(): void;
     /**
      * Change a connection's compatibility.
+     *
      * @param check Compatible value type or list of value types. Null if all
      *     types are compatible.
-     * @return The connection being modified (to allow chaining).
+     * @returns The connection being modified (to allow chaining).
      */
     setCheck(check: string | string[] | null): Connection;
     /**
      * Get a connection's compatibility.
-     * @return List of compatible value types.
+     *
+     * @returns List of compatible value types.
      *     Null if all types are compatible.
      */
     getCheck(): string[] | null;
     /**
      * Changes the connection's shadow block.
+     *
      * @param shadowDom DOM representation of a block or null.
      */
     setShadowDom(shadowDom: Element | null): void;
     /**
      * Returns the xml representation of the connection's shadow block.
+     *
      * @param returnCurrent If true, and the shadow block is currently attached to
      *     this connection, this serializes the state of that block and returns it
      *     (so that field values are correct). Otherwise the saved shadowDom is
      *     just returned.
-     * @return Shadow DOM representation of a block or null.
+     * @returns Shadow DOM representation of a block or null.
      */
     getShadowDom(returnCurrent?: boolean): Element | null;
     /**
      * Changes the connection's shadow block.
+     *
      * @param shadowState An state represetation of the block or null.
      */
     setShadowState(shadowState: blocks.State | null): void;
     /**
      * Returns the serialized object representation of the connection's shadow
      * block.
+     *
      * @param returnCurrent If true, and the shadow block is currently attached to
      *     this connection, this serializes the state of that block and returns it
      *     (so that field values are correct). Otherwise the saved state is just
      *     returned.
-     * @return Serialized object representation of the block, or null.
+     * @returns Serialized object representation of the block, or null.
      */
     getShadowState(returnCurrent?: boolean): blocks.State | null;
     /**
@@ -168,16 +188,18 @@ export declare class Connection implements IASTNodeLocationWithBlock {
      *
      * Headless configurations (the default) do not have neighboring connection,
      * and always return an empty list (the default).
-     * {@link Blockly.RenderedConnection} overrides this behavior with a list
+     * {@link RenderedConnection#neighbours} overrides this behavior with a list
      * computed from the rendered positioning.
+     *
      * @param _maxLimit The maximum radius to another connection.
-     * @return List of connections.
+     * @returns List of connections.
      * @internal
      */
     neighbours(_maxLimit: number): Connection[];
     /**
      * Get the parent input of a connection.
-     * @return The input that the connection belongs to or null if no parent
+     *
+     * @returns The input that the connection belongs to or null if no parent
      *     exists.
      * @internal
      */
@@ -185,38 +207,44 @@ export declare class Connection implements IASTNodeLocationWithBlock {
     /**
      * This method returns a string describing this Connection in developer terms
      * (English only). Intended to on be used in console logs and errors.
-     * @return The description.
+     *
+     * @returns The description.
      */
     toString(): string;
     /**
      * Returns the state of the shadowDom_ and shadowState_ properties, then
      * temporarily sets those properties to null so no shadow respawns.
-     * @return The state of both the shadowDom_ and shadowState_ properties.
+     *
+     * @returns The state of both the shadowDom_ and shadowState_ properties.
      */
     private stashShadowState_;
     /**
      * Reapplies the stashed state of the shadowDom_ and shadowState_ properties.
+     *
      * @param param0 The state to reapply to the shadowDom_ and shadowState_
      *     properties.
      */
     private applyShadowState_;
     /**
      * Sets the state of the shadow of this connection.
+     *
      * @param param0 The state to set the shadow of this connection to.
      */
     private setShadowStateInternal_;
     /**
      * Creates a shadow block based on the current shadowState_ or shadowDom_.
      * shadowState_ gets priority.
+     *
      * @param attemptToConnect Whether to try to connect the shadow block to this
      *     connection or not.
-     * @return The shadow block that was created, or null if both the shadowState_
-     *     and shadowDom_ are null.
+     * @returns The shadow block that was created, or null if both the
+     *     shadowState_ and shadowDom_ are null.
      */
     private createShadowBlock_;
     /**
      * Saves the given shadow block to both the shadowDom_ and shadowState_
      * properties, in their respective serialized forms.
+     *
      * @param shadow The shadow to serialize, or null.
      */
     private serializeShadow_;
@@ -224,9 +252,11 @@ export declare class Connection implements IASTNodeLocationWithBlock {
      * Returns the connection (starting at the startBlock) which will accept
      * the given connection. This includes compatible connection types and
      * connection checks.
+     *
      * @param startBlock The block on which to start the search.
      * @param orphanConnection The connection that is looking for a home.
-     * @return The suitable connection point on the chain of blocks, or null.
+     * @returns The suitable connection point on the chain of blocks, or null.
      */
     static getConnectionForOrphanedConnection(startBlock: Block, orphanConnection: Connection): Connection | null;
 }
+//# sourceMappingURL=connection.d.ts.map

package/core/connection_checker.d.ts

@@ -8,71 +8,80 @@ import type { IConnectionChecker } from './interfaces/i_connection_checker.js';
 import type { RenderedConnection } from './rendered_connection.js';
 /**
  * Class for connection type checking logic.
+ *
  * @alias Blockly.ConnectionChecker
  */
 export declare class ConnectionChecker implements 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;
     /**
      * Helper function for drag checking.
+     *
      * @param a The connection to check, which must be a statement input or next
      *     connection.
      * @param b A nearby connection to check, which must be a previous connection.
-     * @return True if the connection is allowed, false otherwise.
+     * @returns True if the connection is allowed, false otherwise.
      */
     protected canConnectToPrevious_(a: Connection, b: Connection): boolean;
 }
+//# sourceMappingURL=connection_checker.d.ts.map