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

package/core/generator.d.ts

@@ -8,11 +8,12 @@ import { Names } from './names.js';
 import type { Workspace } from './workspace.js';
 /**
  * Class for a code generator that translates the blocks into a language.
+ *
  * @unrestricted
  * @alias Blockly.Generator
  */
 export declare class Generator {
-    name_: any;
+    name_: string;
     /**
      * This is used as a placeholder in functions defined using
      * Generator.provideFunction_.  It must not be legal code that could
@@ -20,23 +21,23 @@ export declare class Generator {
      * not confuse the regular expression parser.
      */
     protected FUNCTION_NAME_PLACEHOLDER_: string;
-    FUNCTION_NAME_PLACEHOLDER_REGEXP_: any;
+    FUNCTION_NAME_PLACEHOLDER_REGEXP_: RegExp;
     /**
      * Arbitrary code to inject into locations that risk causing infinite loops.
      * Any instances of '%1' will be replaced by the block ID that failed.
-     * E.g. '  checkTimeout(%1);\n'
+     * E.g. `  checkTimeout(%1);\n`
      */
     INFINITE_LOOP_TRAP: string | null;
     /**
      * Arbitrary code to inject before every statement.
      * Any instances of '%1' will be replaced by the block ID of the statement.
-     * E.g. 'highlight(%1);\n'
+     * E.g. `highlight(%1);\n`
      */
     STATEMENT_PREFIX: string | null;
     /**
      * Arbitrary code to inject after every statement.
      * Any instances of '%1' will be replaced by the block ID of the statement.
-     * E.g. 'highlight(%1);\n'
+     * E.g. `highlight(%1);\n`
      */
     STATEMENT_SUFFIX: string | null;
     /**
@@ -61,53 +62,62 @@ export declare class Generator {
     /** Comma-separated list of reserved words. */
     protected RESERVED_WORDS_: string;
     /** A dictionary of definitions to be printed before the code. */
-    protected definitions_?: any;
+    protected definitions_: {
+        [key: string]: string;
+    };
     /**
      * A dictionary mapping desired function names in definitions_ to actual
      * function names (to avoid collisions with user functions).
      */
-    protected functionNames_?: any;
+    protected functionNames_: {
+        [key: string]: string;
+    };
     /** A database of variable and procedure names. */
     protected nameDB_?: Names;
     /** @param name Language name of this generator. */
     constructor(name: string);
     /**
      * Generate code for all blocks in the workspace to the specified language.
+     *
      * @param workspace Workspace to generate code from.
-     * @return Generated code.
+     * @returns Generated code.
      */
     workspaceToCode(workspace?: Workspace): string;
     /**
      * Prepend a common prefix onto each line of code.
      * Intended for indenting code or adding comment markers.
+     *
      * @param text The lines of code.
      * @param prefix The common prefix.
-     * @return The prefixed lines of code.
+     * @returns The prefixed lines of code.
      */
     prefixLines(text: string, prefix: string): string;
     /**
      * Recursively spider a tree of blocks, returning all their comments.
+     *
      * @param block The block from which to start spidering.
-     * @return Concatenated list of comments.
+     * @returns Concatenated list of comments.
      */
     allNestedComments(block: Block): string;
     /**
      * Generate code for the specified block (and attached blocks).
      * The generator must be initialized before calling this function.
+     *
      * @param block The block to generate code for.
      * @param opt_thisOnly True to generate code for only this statement.
-     * @return For statement blocks, the generated code.
+     * @returns For statement blocks, the generated code.
      *     For value blocks, an array containing the generated code and an
      * operator order value.  Returns '' if block is null.
      */
-    blockToCode(block: Block | null, opt_thisOnly?: boolean): string | any[];
+    blockToCode(block: Block | null, opt_thisOnly?: boolean): string | [string, number];
     /**
      * Generate code representing the specified value input.
+     *
      * @param block The block containing the input.
      * @param name The name of the input.
      * @param outerOrder The maximum binding strength (minimum order value) of any
      *     operators adjacent to "block".
-     * @return Generated code or '' if no blocks are connected or the specified
+     * @returns Generated code or '' if no blocks are connected or the specified
      *     input does not exist.
      */
     valueToCode(block: Block, name: string, outerOrder: number): string;
@@ -116,9 +126,10 @@ export declare class Generator {
      * statement input. Indent the code.
      * This is mainly used in generators. When trying to generate code to evaluate
      * look at using workspaceToCode or blockToCode.
+     *
      * @param block The block containing the input.
      * @param name The name of the input.
-     * @return Generated code or '' if no blocks are connected.
+     * @returns Generated code or '' if no blocks are connected.
      */
     statementToCode(block: Block, name: string): string;
     /**
@@ -126,21 +137,24 @@ export declare class Generator {
      * Add statement suffix at the start of the loop block (right after the loop
      * statement executes), and a statement prefix to the end of the loop block
      * (right before the loop statement executes).
+     *
      * @param branch Code for loop contents.
      * @param block Enclosing block.
-     * @return Loop contents, with infinite loop trap added.
+     * @returns Loop contents, with infinite loop trap added.
      */
     addLoopTrap(branch: string, block: Block): string;
     /**
      * Inject a block ID into a message to replace '%1'.
      * Used for STATEMENT_PREFIX, STATEMENT_SUFFIX, and INFINITE_LOOP_TRAP.
+     *
      * @param msg Code snippet with '%1'.
      * @param block Block which has an ID.
-     * @return Code snippet with ID.
+     * @returns Code snippet with ID.
      */
     injectId(msg: string, block: Block): string;
     /**
      * Add one or more words to the list of reserved words for this language.
+     *
      * @param words Comma-separated list of words to add to the list.
      *     No spaces.  Duplicates are ok.
      */
@@ -162,7 +176,7 @@ export declare class Generator {
      * @param desiredName The desired name of the function (e.g. mathIsPrime).
      * @param code A list of statements or one multi-line code string.  Use '  '
      *     for indents (they will be replaced).
-     * @return The actual name of the new function.  This may differ from
+     * @returns The actual name of the new function.  This may differ from
      *     desiredName if the former has already been taken by the user.
      */
     protected provideFunction_(desiredName: string, code: string[] | string): string;
@@ -170,6 +184,7 @@ export declare class Generator {
      * Hook for code to run before code generation starts.
      * Subclasses may override this, e.g. to initialise the database of variable
      * names.
+     *
      * @param _workspace Workspace to generate code from.
      */
     init(_workspace: Workspace): void;
@@ -179,18 +194,20 @@ export declare class Generator {
      * Subclasses may override this, e.g. to generate code for statements
      * following the block, or to handle comments for the specified block and any
      * connected value blocks.
+     *
      * @param _block The current block.
      * @param code The code created for this block.
      * @param _opt_thisOnly True to generate code for only this statement.
-     * @return Code with comments and subsequent blocks added.
+     * @returns Code with comments and subsequent blocks added.
      */
     protected scrub_(_block: Block, code: string, _opt_thisOnly?: boolean): string;
     /**
      * Hook for code to run at end of code generation.
      * Subclasses may override this, e.g. to prepend the generated code with
      * import statements or variable definitions.
+     *
      * @param code Generated code.
-     * @return Completed code.
+     * @returns Completed code.
      */
     finish(code: string): string;
     /**
@@ -198,8 +215,10 @@ export declare class Generator {
      * anything.
      * Subclasses may override this, e.g. if their language does not allow
      * naked values.
+     *
      * @param line Line of generated code.
-     * @return Legal line of code.
+     * @returns Legal line of code.
      */
     scrubNakedValue(line: string): string;
 }
+//# sourceMappingURL=generator.d.ts.map

package/core/gesture.d.ts

@@ -19,6 +19,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  */
 /**
  * Class for one gesture.
+ *
  * @alias Blockly.Gesture
  */
 export declare class Gesture {
@@ -57,19 +58,13 @@ export declare class Gesture {
      * workspaces on a page; this is more accurate than using
      * Blockly.common.getMainWorkspace().
      */
-    protected startWorkspace_: WorkspaceSvg;
+    protected startWorkspace_: WorkspaceSvg | null;
     /**
      * Whether the pointer has at any point moved out of the drag radius.
      * A gesture that exceeds the drag radius is a drag even if it ends exactly
      * at its start point.
      */
     private hasExceededDragRadius_;
-    /** Whether the workspace is currently being dragged. */
-    private isDraggingWorkspace_;
-    /** Whether the block is currently being dragged. */
-    private isDraggingBlock_;
-    /** Whether the bubble is currently being dragged. */
-    private isDraggingBubble_;
     /**
      * A handle to use to unbind a mouse move listener at the end of a drag.
      * Opaque data returned from Blockly.bindEventWithChecks_.
@@ -108,19 +103,22 @@ export declare class Gesture {
     constructor(e: Event, creatorWorkspace: WorkspaceSvg);
     /**
      * Sever all links from this object.
+     *
      * @internal
      */
     dispose(): void;
     /**
      * Update internal state based on an event.
+     *
      * @param e The most recent mouse or touch event.
      */
     private updateFromEvent_;
     /**
      * DO MATH to set currentDragDeltaXY_ based on the most recent mouse position.
+     *
      * @param currentXY The most recent mouse/pointer position, in pixel units,
      *     with (0, 0) at the window's top left corner.
-     * @return True if the drag just exceeded the drag radius for the first time.
+     * @returns True if the drag just exceeded the drag radius for the first time.
      */
     private updateDragDelta_;
     /**
@@ -131,7 +129,8 @@ export declare class Gesture {
      * gesture. If a block should be dragged from the flyout this function creates
      * the new block on the main workspace and updates targetBlock_ and
      * startWorkspace_.
-     * @return True if a block is being dragged from the flyout.
+     *
+     * @returns True if a block is being dragged from the flyout.
      */
     private updateIsDraggingFromFlyout_;
     /**
@@ -140,21 +139,28 @@ export declare class Gesture {
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture. If a bubble should be dragged this function creates the necessary
      * BubbleDragger and starts the drag.
-     * @return True if a bubble is being dragged.
+     *
+     * @returns True if a bubble is being dragged.
      */
     private updateIsDraggingBubble_;
     /**
-     * Update this gesture to record whether a block is being dragged.
+     * Check whether to start a block drag. If a block should be dragged, either
+     * from the flyout or in the workspace, create the necessary BlockDragger and
+     * start the drag.
+     *
      * This function should be called on a mouse/touch move event the first time
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture. If a block should be dragged, either from the flyout or in the
      * workspace, this function creates the necessary BlockDragger and starts the
      * drag.
-     * @return True if a block is being dragged.
+     *
+     * @returns True if a block is being dragged.
      */
     private updateIsDraggingBlock_;
     /**
-     * Update this gesture to record whether a workspace is being dragged.
+     * Check whether to start a workspace drag. If a workspace is being dragged,
+     * create the necessary WorkspaceDragger and start the drag.
+     *
      * This function should be called on a mouse/touch move event the first time
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture. If a workspace is being dragged this function creates the
@@ -175,24 +181,28 @@ export declare class Gesture {
     /**
      * Start a gesture: update the workspace to indicate that a gesture is in
      * progress and bind mousemove and mouseup handlers.
+     *
      * @param e A mouse down or touch start event.
      * @internal
      */
     doStart(e: MouseEvent): void;
     /**
      * Bind gesture events.
+     *
      * @param e A mouse down or touch start event.
      * @internal
      */
     bindMouseEvents(e: Event): void;
     /**
      * Handle a mouse move or touch move event.
+     *
      * @param e A mouse move or touch move event.
      * @internal
      */
     handleMove(e: Event): void;
     /**
      * Handle a mouse up or touch end event.
+     *
      * @param e A mouse up or touch end event.
      * @internal
      */
@@ -200,17 +210,20 @@ export declare class Gesture {
     /**
      * Cancel an in-progress gesture.  If a workspace or block drag is in
      * progress, end the drag at the most recent location.
+     *
      * @internal
      */
     cancel(): void;
     /**
      * Handle a real or faked right-click event by showing a context menu.
+     *
      * @param e A mouse move or touch move event.
      * @internal
      */
     handleRightClick(e: Event): void;
     /**
      * Handle a mousedown/touchstart event on a workspace.
+     *
      * @param e A mouse down or touch start event.
      * @param ws The workspace the event hit.
      * @internal
@@ -218,11 +231,13 @@ export declare class Gesture {
     handleWsStart(e: MouseEvent, ws: WorkspaceSvg): void;
     /**
      * Fires a workspace click event.
+     *
      * @param ws The workspace that a user clicks on.
      */
     private fireWorkspaceClick_;
     /**
      * Handle a mousedown/touchstart event on a flyout.
+     *
      * @param e A mouse down or touch start event.
      * @param flyout The flyout the event hit.
      * @internal
@@ -230,6 +245,7 @@ export declare class Gesture {
     handleFlyoutStart(e: MouseEvent, flyout: IFlyout): void;
     /**
      * Handle a mousedown/touchstart event on a block.
+     *
      * @param e A mouse down or touch start event.
      * @param block The block the event hit.
      * @internal
@@ -237,6 +253,7 @@ export declare class Gesture {
     handleBlockStart(e: Event, block: BlockSvg): void;
     /**
      * Handle a mousedown/touchstart event on a bubble.
+     *
      * @param e A mouse down or touch start event.
      * @param bubble The bubble the event hit.
      * @internal
@@ -251,6 +268,7 @@ export declare class Gesture {
     /**
      * Execute a workspace click. When in accessibility mode shift clicking will
      * move the cursor.
+     *
      * @param _e A mouse up or touch end event.
      */
     private doWorkspaceClick_;
@@ -261,12 +279,14 @@ export declare class Gesture {
     private bringBlockToFront_;
     /**
      * Record the field that a gesture started on.
+     *
      * @param field The field the gesture started on.
      * @internal
      */
     setStartField(field: Field): void;
     /**
      * Record the bubble that a gesture started on
+     *
      * @param bubble The bubble the gesture started on.
      * @internal
      */
@@ -274,6 +294,7 @@ export declare class Gesture {
     /**
      * Record the block that a gesture started on, and set the target block
      * appropriately.
+     *
      * @param block The block the gesture started on.
      * @internal
      */
@@ -282,48 +303,56 @@ export declare class Gesture {
      * Record the block that a gesture targets, meaning the block that will be
      * dragged if this turns into a drag.  If this block is a shadow, that will be
      * its first non-shadow parent.
+     *
      * @param block The block the gesture targets.
      */
     private setTargetBlock_;
     /**
      * Record the workspace that a gesture started on.
+     *
      * @param ws The workspace the gesture started on.
      */
     private setStartWorkspace_;
     /**
      * Record the flyout that a gesture started on.
+     *
      * @param flyout The flyout the gesture started on.
      */
     private setStartFlyout_;
     /**
      * Whether this gesture is a click on a bubble.  This should only be called
      * when ending a gesture (mouse up, touch end).
-     * @return Whether this gesture was a click on a bubble.
+     *
+     * @returns Whether this gesture was a click on a bubble.
      */
     private isBubbleClick_;
     /**
      * Whether this gesture is a click on a block.  This should only be called
      * when ending a gesture (mouse up, touch end).
-     * @return Whether this gesture was a click on a block.
+     *
+     * @returns Whether this gesture was a click on a block.
      */
     private isBlockClick_;
     /**
      * Whether this gesture is a click on a field.  This should only be called
      * when ending a gesture (mouse up, touch end).
-     * @return Whether this gesture was a click on a field.
+     *
+     * @returns Whether this gesture was a click on a field.
      */
     private isFieldClick_;
     /**
      * Whether this gesture is a click on a workspace.  This should only be called
      * when ending a gesture (mouse up, touch end).
-     * @return Whether this gesture was a click on a workspace.
+     *
+     * @returns Whether this gesture was a click on a workspace.
      */
     private isWorkspaceClick_;
     /**
      * Whether this gesture is a drag of either a workspace or block.
      * This function is called externally to block actions that cannot be taken
      * mid-drag (e.g. using the keyboard to delete the selected blocks).
-     * @return True if this gesture is a drag of a workspace or block.
+     *
+     * @returns True if this gesture is a drag of a workspace or block.
      * @internal
      */
     isDragging(): boolean;
@@ -331,27 +360,32 @@ export declare class Gesture {
      * Whether this gesture has already been started.  In theory every mouse down
      * has a corresponding mouse up, but in reality it is possible to lose a
      * mouse up, leaving an in-process gesture hanging.
-     * @return Whether this gesture was a click on a workspace.
+     *
+     * @returns Whether this gesture was a click on a workspace.
      * @internal
      */
     hasStarted(): boolean;
     /**
      * Get a list of the insertion markers that currently exist.  Block drags have
      * 0, 1, or 2 insertion markers.
-     * @return A possibly empty list of insertion marker blocks.
+     *
+     * @returns A possibly empty list of insertion marker blocks.
      * @internal
      */
     getInsertionMarkers(): BlockSvg[];
     /**
      * Gets the current dragger if an item is being dragged. Null if nothing is
      * being dragged.
-     * @return The dragger that is currently in use or null if no drag is in
+     *
+     * @returns The dragger that is currently in use or null if no drag is in
      *     progress.
      */
     getCurrentDragger(): WorkspaceDragger | BubbleDragger | IBlockDragger | null;
     /**
      * Is a drag or other gesture currently in progress on any workspace?
-     * @return True if gesture is occurring.
+     *
+     * @returns True if gesture is occurring.
      */
     static inProgress(): boolean;
 }
+//# sourceMappingURL=gesture.d.ts.map

package/core/grid.d.ts

@@ -3,23 +3,19 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { GridOptions } from './blockly_options.js';
+import { GridOptions } from './options.js';
 /**
  * Class for a workspace's grid.
+ *
  * @alias Blockly.Grid
  */
 export declare class Grid {
     private pattern;
-    /**
-     * The scale of the grid, used to set stroke width on grid lines.
-     * This should always be the same as the workspace scale.
-     */
-    private scale_;
-    private readonly spacing_;
-    private readonly length_;
-    private readonly line1_;
-    private readonly line2_;
-    private readonly snapToGrid_;
+    private readonly spacing;
+    private readonly length;
+    private readonly line1;
+    private readonly line2;
+    private readonly snapToGrid;
     /**
      * @param pattern The grid's SVG pattern, created during injection.
      * @param options A dictionary of normalized options for the grid.
@@ -29,25 +25,29 @@ export declare class Grid {
     constructor(pattern: SVGElement, options: GridOptions);
     /**
      * Whether blocks should snap to the grid, based on the initial configuration.
-     * @return True if blocks should snap, false otherwise.
+     *
+     * @returns True if blocks should snap, false otherwise.
      * @internal
      */
     shouldSnap(): boolean;
     /**
      * Get the spacing of the grid points (in px).
-     * @return The spacing of the grid points.
+     *
+     * @returns The spacing of the grid points.
      * @internal
      */
     getSpacing(): number;
     /**
      * Get the ID of the pattern element, which should be randomized to avoid
      * conflicts with other Blockly instances on the page.
-     * @return The pattern ID.
+     *
+     * @returns The pattern ID.
      * @internal
      */
     getPatternId(): string;
     /**
      * Update the grid with a new scale.
+     *
      * @param scale The new workspace scale.
      * @internal
      */
@@ -55,6 +55,7 @@ export declare class Grid {
     /**
      * Set the attributes on one of the lines in the grid.  Use this to update the
      * length and stroke width of the grid lines.
+     *
      * @param line Which line to update.
      * @param width The new stroke size (in px).
      * @param x1 The new x start position of the line (in px).
@@ -62,10 +63,11 @@ export declare class Grid {
      * @param y1 The new y start position of the line (in px).
      * @param y2 The new y end position of the line (in px).
      */
-    private setLineAttributes_;
+    private setLineAttributes;
     /**
      * Move the grid to a new x and y position, and make sure that change is
      * visible.
+     *
      * @param x The new x position of the grid (in px).
      * @param y The new y position of the grid (in px).
      * @internal
@@ -73,11 +75,13 @@ export declare class Grid {
     moveTo(x: number, y: number): void;
     /**
      * Create the DOM for the grid described by options.
+     *
      * @param rnd A random ID to append to the pattern's ID.
      * @param gridOptions The object containing grid configuration.
      * @param defs The root SVG element for this workspace's defs.
-     * @return The SVG element for the grid pattern.
+     * @returns The SVG element for the grid pattern.
      * @internal
      */
     static createDom(rnd: string, gridOptions: GridOptions, defs: SVGElement): SVGElement;
 }
+//# sourceMappingURL=grid.d.ts.map

package/core/icon.d.ts

@@ -9,10 +9,11 @@ import { Coordinate } from './utils/coordinate.js';
 import { Size } from './utils/size.js';
 /**
  * Class for an icon.
+ *
  * @alias Blockly.Icon
  */
 export declare abstract class Icon {
-    protected block_: BlockSvg;
+    protected block_: BlockSvg | null;
     /** The icon SVG group. */
     iconGroup_: SVGGElement | null;
     /** Whether this icon gets hidden when the block is collapsed. */
@@ -24,7 +25,7 @@ export declare abstract class Icon {
     /** Absolute coordinate of icon's center. */
     protected iconXY_: Coordinate | null;
     /** @param block The block associated with this icon. */
-    constructor(block: BlockSvg);
+    constructor(block: BlockSvg | null);
     /** Create the icon on the block. */
     createIcon(): void;
     /** Dispose of this icon. */
@@ -33,11 +34,13 @@ export declare abstract class Icon {
     updateEditable(): void;
     /**
      * Is the associated bubble visible?
-     * @return True if the bubble is visible.
+     *
+     * @returns True if the bubble is visible.
      */
     isVisible(): boolean;
     /**
      * Clicking on the icon toggles if the bubble is visible.
+     *
      * @param e Mouse click event.
      */
     protected iconClick_(e: MouseEvent): void;
@@ -45,6 +48,7 @@ export declare abstract class Icon {
     applyColour(): void;
     /**
      * Notification that the icon has moved.  Update the arrow accordingly.
+     *
      * @param xy Absolute location in workspace coordinates.
      */
     setIconLocation(xy: Coordinate): void;
@@ -55,24 +59,33 @@ export declare abstract class Icon {
     computeIconLocation(): void;
     /**
      * Returns the center of the block's icon relative to the surface.
-     * @return Object with x and y properties in workspace coordinates.
+     *
+     * @returns Object with x and y properties in workspace coordinates.
      */
     getIconLocation(): Coordinate | null;
     /**
      * Get the size of the icon as used for rendering.
      * This differs from the actual size of the icon, because it bulges slightly
      * out of its row rather than increasing the height of its row.
-     * @return Height and width.
+     *
+     * @returns Height and width.
      */
     getCorrectedSize(): Size;
     /**
      * Draw the icon.
+     *
      * @param _group The icon group.
      */
     protected drawIcon_(_group: Element): void;
     /**
      * Show or hide the icon.
+     *
      * @param _visible True if the icon should be visible.
      */
     setVisible(_visible: boolean): void;
+    /**
+     * Returns the block this icon is attached to.
+     */
+    protected getBlock(): BlockSvg;
 }
+//# sourceMappingURL=icon.d.ts.map