blockly 9.0.0-beta.0 → 9.0.0-beta.1

package/core/dropdowndiv.d.ts

@@ -50,24 +50,28 @@ export interface PositionMetrics {
 }
 /**
  * Create and insert the DOM element for this div.
+ *
  * @internal
  */
 export declare function createDom(): void;
 /**
  * Set an element to maintain bounds within. Drop-downs will appear
  * within the box of this element if possible.
+ *
  * @param boundsElem Element to bind drop-down to.
  */
 export declare function setBoundsElement(boundsElem: Element | null): void;
 /**
  * Provide the div for inserting content into the drop-down.
- * @return Div to populate with content.
+ *
+ * @returns Div to populate with content.
  */
 export declare function getContentDiv(): Element;
 /** Clear the content of the drop-down. */
 export declare function clearContent(): void;
 /**
  * Set the colour for the drop-down.
+ *
  * @param backgroundColour Any CSS colour for the background.
  * @param borderColour Any CSS colour for the border.
  */
@@ -77,11 +81,12 @@ export declare function setColour(backgroundColour: string, borderColour: string
  * by a particular block. The primary position will be below the block,
  * and the secondary position above the block. Drop-down will be
  * constrained to the block's workspace.
+ *
  * @param field The field showing the drop-down.
  * @param block Block to position the drop-down around.
  * @param opt_onHide Optional callback for when the drop-down is hidden.
  * @param opt_secondaryYOffset Optional Y offset for above-block positioning.
- * @return True if the menu rendered below block; false if above.
+ * @returns True if the menu rendered below block; false if above.
  */
 export declare function showPositionedByBlock(field: Field, block: BlockSvg, opt_onHide?: Function, opt_secondaryYOffset?: number): boolean;
 /**
@@ -89,10 +94,11 @@ export declare function showPositionedByBlock(field: Field, block: BlockSvg, opt
  * by a particular field. The primary position will be below the field,
  * and the secondary position above the field. Drop-down will be
  * constrained to the block's workspace.
+ *
  * @param field The field to position the dropdown against.
  * @param opt_onHide Optional callback for when the drop-down is hidden.
  * @param opt_secondaryYOffset Optional Y offset for above-block positioning.
- * @return True if the menu rendered below block; false if above.
+ * @returns True if the menu rendered below block; false if above.
  */
 export declare function showPositionedByField(field: Field, opt_onHide?: Function, opt_secondaryYOffset?: number): boolean;
 /**
@@ -103,6 +109,7 @@ export declare function showPositionedByField(field: Field, opt_onHide?: Functio
  * will point there, and the container will be positioned below it.
  * If we can't maintain the container bounds at the primary point, fall-back to
  * the secondary point and position above.
+ *
  * @param newOwner The object showing the drop-down
  * @param rtl Right-to-left (true) or left-to-right (false).
  * @param primaryX Desired origin point x, in absolute px.
@@ -110,18 +117,19 @@ export declare function showPositionedByField(field: Field, opt_onHide?: Functio
  * @param secondaryX Secondary/alternative origin point x, in absolute px.
  * @param secondaryY Secondary/alternative origin point y, in absolute px.
  * @param opt_onHide Optional callback for when the drop-down is hidden.
- * @return True if the menu rendered at the primary origin point.
+ * @returns True if the menu rendered at the primary origin point.
  * @internal
  */
-export declare function show(newOwner: any | null, rtl: boolean, primaryX: number, primaryY: number, secondaryX: number, secondaryY: number, opt_onHide?: Function): boolean;
+export declare function show(newOwner: Field, rtl: boolean, primaryX: number, primaryY: number, secondaryX: number, secondaryY: number, opt_onHide?: Function): boolean;
 /**
  * Get the x positions for the left side of the DropDownDiv and the arrow,
  * accounting for the bounds of the workspace.
+ *
  * @param sourceX Desired origin point x, in absolute px.
  * @param boundsLeft The left edge of the bounding element, in absolute px.
  * @param boundsRight The right edge of the bounding element, in absolute px.
  * @param divWidth The width of the div in px.
- * @return An object containing metrics for the x positions of the left side of
+ * @returns An object containing metrics for the x positions of the left side of
  *     the DropDownDiv and the arrow.
  * @internal
  */
@@ -131,17 +139,19 @@ export declare function getPositionX(sourceX: number, boundsLeft: number, bounds
 };
 /**
  * Is the container visible?
- * @return True if visible.
+ *
+ * @returns True if visible.
  */
 export declare function isVisible(): boolean;
 /**
  * Hide the menu only if it is owned by the provided object.
+ *
  * @param divOwner Object which must be owning the drop-down to hide.
  * @param opt_withoutAnimation True if we should hide the dropdown without
  *     animating.
- * @return True if hidden.
+ * @returns True if hidden.
  */
-export declare function hideIfOwner(divOwner: any | null, opt_withoutAnimation?: boolean): boolean;
+export declare function hideIfOwner(divOwner: Field, opt_withoutAnimation?: boolean): boolean;
 /** Hide the menu, triggering animation. */
 export declare function hide(): void;
 /** Hide the menu, without animation. */
@@ -149,7 +159,29 @@ export declare function hideWithoutAnimation(): void;
 /**
  * Repositions the dropdownDiv on window resize. If it doesn't know how to
  * calculate the new position, it will just hide it instead.
+ *
  * @internal
  */
 export declare function repositionForWindowResize(): void;
-export declare const TEST_ONLY: {};
+export declare const TEST_ONLY: {
+    /**
+     * Get sizing info about the bounding element.
+     *
+     * @returns An object containing size information about the bounding element
+     *     (bounding box and width/height).
+     */
+    getBoundsInfo: () => BoundsInfo;
+    /**
+     * Helper to position the drop-down and the arrow, maintaining bounds.
+     * See explanation of origin points in show.
+     *
+     * @param primaryX Desired origin point x, in absolute px.
+     * @param primaryY Desired origin point y, in absolute px.
+     * @param secondaryX Secondary/alternative origin point x, in absolute px.
+     * @param secondaryY Secondary/alternative origin point y, in absolute px.
+     * @returns Various final metrics, including rendered positions for drop-down
+     *     and arrow.
+     */
+    getPositionMetrics: (primaryX: number, primaryY: number, secondaryX: number, secondaryY: number) => PositionMetrics;
+};
+//# sourceMappingURL=dropdowndiv.d.ts.map

package/core/events/events.d.ts

@@ -100,3 +100,4 @@ export declare const isEnabled: typeof eventUtils.isEnabled;
 export declare const setGroup: typeof eventUtils.setGroup;
 export declare const setRecordUndo: typeof eventUtils.setRecordUndo;
 export declare const disableOrphans: typeof eventUtils.disableOrphans;
+//# sourceMappingURL=events.d.ts.map

package/core/events/events_abstract.d.ts

@@ -6,6 +6,7 @@
 import type { Workspace } from '../workspace.js';
 /**
  * Abstract class for an event.
+ *
  * @alias Blockly.Events.Abstract
  */
 export declare abstract class Abstract {
@@ -23,29 +24,35 @@ export declare abstract class Abstract {
     constructor();
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Does this event record any change of state?
-     * @return True if null, false if something changed.
+     *
+     * @returns True if null, false if something changed.
      */
     isNull(): boolean;
     /**
      * Run an event.
+     *
      * @param _forward True if run forward, false if run backward (undo).
      */
     run(_forward: boolean): void;
     /**
      * Get workspace the event belongs to.
-     * @return The workspace the event belongs to.
+     *
+     * @returns The workspace the event belongs to.
      * @throws {Error} if workspace is null.
      * @internal
      */
     getEventWorkspace_(): Workspace;
 }
+//# sourceMappingURL=events_abstract.d.ts.map

package/core/events/events_block_base.d.ts

@@ -7,6 +7,7 @@ import type { Block } from '../block.js';
 import { Abstract as AbstractEvent } from './events_abstract.js';
 /**
  * Abstract class for a block event.
+ *
  * @alias Blockly.Events.BlockBase
  */
 export declare class BlockBase extends AbstractEvent {
@@ -20,12 +21,15 @@ export declare class BlockBase extends AbstractEvent {
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
 }
+//# sourceMappingURL=events_block_base.d.ts.map

package/core/events/events_block_change.d.ts

@@ -8,6 +8,7 @@ import type { BlockSvg } from '../block_svg.js';
 import { BlockBase } from './events_block_base.js';
 /**
  * Class for a block change event.
+ *
  * @alias Blockly.Events.BlockChange
  */
 export declare class BlockChange extends BlockBase {
@@ -26,30 +27,36 @@ export declare class BlockChange extends BlockBase {
     constructor(opt_block?: Block, opt_element?: string, opt_name?: string | null, opt_oldValue?: any, opt_newValue?: any);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Does this event record any change of state?
-     * @return False if something changed.
+     *
+     * @returns False if something changed.
      */
     isNull(): boolean;
     /**
      * Run a change event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
     /**
      * Returns the extra state of the given block (either as XML or a JSO,
      * depending on the block's definition).
+     *
      * @param block The block to get the extra state of.
-     * @return A stringified version of the extra state of the given block.
+     * @returns A stringified version of the extra state of the given block.
      * @internal
      */
     static getExtraBlockState_(block: BlockSvg): string;
 }
+//# sourceMappingURL=events_block_change.d.ts.map

package/core/events/events_block_create.d.ts

@@ -8,6 +8,7 @@ import * as blocks from '../serialization/blocks.js';
 import { BlockBase } from './events_block_base.js';
 /**
  * Class for a block creation event.
+ *
  * @alias Blockly.Events.BlockCreate
  */
 export declare class BlockCreate extends BlockBase {
@@ -19,17 +20,21 @@ export declare class BlockCreate extends BlockBase {
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Run a creation event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+//# sourceMappingURL=events_block_create.d.ts.map

package/core/events/events_block_delete.d.ts

@@ -8,6 +8,7 @@ import * as blocks from '../serialization/blocks.js';
 import { BlockBase } from './events_block_base.js';
 /**
  * Class for a block deletion event.
+ *
  * @alias Blockly.Events.BlockDelete
  */
 export declare class BlockDelete extends BlockBase {
@@ -20,17 +21,21 @@ export declare class BlockDelete extends BlockBase {
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Run a deletion event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+//# sourceMappingURL=events_block_delete.d.ts.map

package/core/events/events_block_drag.d.ts

@@ -7,6 +7,7 @@ import type { Block } from '../block.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a block drag event.
+ *
  * @alias Blockly.Events.BlockDrag
  */
 export declare class BlockDrag extends UiBase {
@@ -25,12 +26,15 @@ export declare class BlockDrag extends UiBase {
     constructor(opt_block?: Block, opt_isStart?: boolean, opt_blocks?: Block[]);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
 }
+//# sourceMappingURL=events_block_drag.d.ts.map

package/core/events/events_block_move.d.ts

@@ -8,6 +8,7 @@ import { Coordinate } from '../utils/coordinate.js';
 import { BlockBase } from './events_block_base.js';
 /**
  * Class for a block move event.  Created before the move.
+ *
  * @alias Blockly.Events.BlockMove
  */
 export declare class BlockMove extends BlockBase {
@@ -22,11 +23,13 @@ export declare class BlockMove extends BlockBase {
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
@@ -35,17 +38,21 @@ export declare class BlockMove extends BlockBase {
     /**
      * Returns the parentId and input if the block is connected,
      *   or the XY location if disconnected.
-     * @return Collection of location info.
+     *
+     * @returns Collection of location info.
      */
     private currentLocation_;
     /**
      * Does this event record any change of state?
-     * @return False if something changed.
+     *
+     * @returns False if something changed.
      */
     isNull(): boolean;
     /**
      * Run a move event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+//# sourceMappingURL=events_block_move.d.ts.map

package/core/events/events_bubble_open.d.ts

@@ -7,6 +7,7 @@ import type { BlockSvg } from '../block_svg.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a bubble open event.
+ *
  * @alias Blockly.Events.BubbleOpen
  */
 export declare class BubbleOpen extends UiBase {
@@ -21,15 +22,18 @@ export declare class BubbleOpen extends UiBase {
      * @param opt_bubbleType The type of bubble. One of 'mutator', 'comment' or
      *     'warning'. Undefined for a blank event.
      */
-    constructor(opt_block: BlockSvg, opt_isOpen?: boolean, opt_bubbleType?: string);
+    constructor(opt_block?: BlockSvg, opt_isOpen?: boolean, opt_bubbleType?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
 }
+//# sourceMappingURL=events_bubble_open.d.ts.map

package/core/events/events_click.d.ts

@@ -7,6 +7,7 @@ import type { Block } from '../block.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a click event.
+ *
  * @alias Blockly.Events.Click
  */
 export declare class Click extends UiBase {
@@ -25,12 +26,15 @@ export declare class Click extends UiBase {
     constructor(opt_block?: Block | null, opt_workspaceId?: string | null, opt_targetType?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
 }
+//# sourceMappingURL=events_click.d.ts.map

package/core/events/events_comment_base.d.ts

@@ -9,6 +9,7 @@ import type { CommentCreate } from './events_comment_create.js';
 import type { CommentDelete } from './events_comment_delete.js';
 /**
  * Abstract class for a comment event.
+ *
  * @alias Blockly.Events.CommentBase
  */
 export declare class CommentBase extends AbstractEvent {
@@ -22,18 +23,22 @@ export declare class CommentBase extends AbstractEvent {
     constructor(opt_comment?: WorkspaceComment);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Helper function for Comment[Create|Delete]
+     *
      * @param event The event to run.
      * @param create if True then Create, if False then Delete
      */
     static CommentCreateDeleteHelper(event: CommentCreate | CommentDelete, create: boolean): void;
 }
+//# sourceMappingURL=events_comment_base.d.ts.map

package/core/events/events_comment_change.d.ts

@@ -7,6 +7,7 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase } from './events_comment_base.js';
 /**
  * Class for a comment change event.
+ *
  * @alias Blockly.Events.CommentChange
  */
 export declare class CommentChange extends CommentBase {
@@ -22,22 +23,27 @@ export declare class CommentChange extends CommentBase {
     constructor(opt_comment?: WorkspaceComment, opt_oldContents?: string, opt_newContents?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Does this event record any change of state?
-     * @return False if something changed.
+     *
+     * @returns False if something changed.
      */
     isNull(): boolean;
     /**
      * Run a change event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+//# sourceMappingURL=events_comment_change.d.ts.map

package/core/events/events_comment_create.d.ts

@@ -7,6 +7,7 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase } from './events_comment_base.js';
 /**
  * Class for a comment creation event.
+ *
  * @alias Blockly.Events.CommentCreate
  */
 export declare class CommentCreate extends CommentBase {
@@ -19,17 +20,21 @@ export declare class CommentCreate extends CommentBase {
     constructor(opt_comment?: WorkspaceComment);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Run a creation event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+//# sourceMappingURL=events_comment_create.d.ts.map

package/core/events/events_comment_delete.d.ts

@@ -7,6 +7,7 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase } from './events_comment_base.js';
 /**
  * Class for a comment deletion event.
+ *
  * @alias Blockly.Events.CommentDelete
  */
 export declare class CommentDelete extends CommentBase {
@@ -19,17 +20,21 @@ export declare class CommentDelete extends CommentBase {
     constructor(opt_comment?: WorkspaceComment);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Run a creation event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+//# sourceMappingURL=events_comment_delete.d.ts.map

package/core/events/events_comment_move.d.ts

@@ -8,6 +8,7 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase } from './events_comment_base.js';
 /**
  * Class for a comment move event.  Created before the move.
+ *
  * @alias Blockly.Events.CommentMove
  */
 export declare class CommentMove extends CommentBase {
@@ -29,27 +30,33 @@ export declare class CommentMove extends CommentBase {
     /**
      * Override the location before the move.  Use this if you don't create the
      * event until the end of the move, but you know the original location.
+     *
      * @param xy The location before the move, in workspace coordinates.
      */
     setOldCoordinate(xy: Coordinate): void;
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
     /**
      * Does this event record any change of state?
-     * @return False if something changed.
+     *
+     * @returns False if something changed.
      */
     isNull(): boolean;
     /**
      * Run a move event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+//# sourceMappingURL=events_comment_move.d.ts.map

package/core/events/events_marker_move.d.ts

@@ -8,6 +8,7 @@ import { ASTNode } from '../keyboard_nav/ast_node.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a marker move event.
+ *
  * @alias Blockly.Events.MarkerMove
  */
 export declare class MarkerMove extends UiBase {
@@ -29,12 +30,15 @@ export declare class MarkerMove extends UiBase {
     constructor(opt_block?: Block | null, isCursor?: boolean, opt_oldNode?: ASTNode | null, opt_newNode?: ASTNode);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
     toJson(): any;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
     fromJson(json: any): void;
 }
+//# sourceMappingURL=events_marker_move.d.ts.map