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

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

@@ -3,61 +3,87 @@
  * Copyright 2016 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Abstract as AbstractEvent } from './events_abstract.js';
-import { BlockBase } from './events_block_base.js';
-import { BlockChange } from './events_block_change.js';
-import { BlockCreate } from './events_block_create.js';
-import { BlockDelete } from './events_block_delete.js';
-import { BlockDrag } from './events_block_drag.js';
-import { BlockMove } from './events_block_move.js';
-import { BubbleOpen } from './events_bubble_open.js';
-import { Click } from './events_click.js';
-import { CommentBase } from './events_comment_base.js';
-import { CommentChange } from './events_comment_change.js';
-import { CommentCreate } from './events_comment_create.js';
+import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
+import { BlockBase, BlockBaseJson } from './events_block_base.js';
+import { BlockChange, BlockChangeJson } from './events_block_change.js';
+import { BlockCreate, BlockCreateJson } from './events_block_create.js';
+import { BlockDelete, BlockDeleteJson } from './events_block_delete.js';
+import { BlockDrag, BlockDragJson } from './events_block_drag.js';
+import { BlockMove, BlockMoveJson } from './events_block_move.js';
+import { BubbleOpen, BubbleOpenJson, BubbleType } from './events_bubble_open.js';
+import { Click, ClickJson, ClickTarget } from './events_click.js';
+import { CommentBase, CommentBaseJson } from './events_comment_base.js';
+import { CommentChange, CommentChangeJson } from './events_comment_change.js';
+import { CommentCreate, CommentCreateJson } from './events_comment_create.js';
 import { CommentDelete } from './events_comment_delete.js';
-import { CommentMove } from './events_comment_move.js';
-import { MarkerMove } from './events_marker_move.js';
-import { Selected } from './events_selected.js';
-import { ThemeChange } from './events_theme_change.js';
-import { ToolboxItemSelect } from './events_toolbox_item_select.js';
-import { TrashcanOpen } from './events_trashcan_open.js';
+import { CommentMove, CommentMoveJson } from './events_comment_move.js';
+import { MarkerMove, MarkerMoveJson } from './events_marker_move.js';
+import { Selected, SelectedJson } from './events_selected.js';
+import { ThemeChange, ThemeChangeJson } from './events_theme_change.js';
+import { ToolboxItemSelect, ToolboxItemSelectJson } from './events_toolbox_item_select.js';
+import { TrashcanOpen, TrashcanOpenJson } from './events_trashcan_open.js';
 import { Ui } from './events_ui.js';
 import { UiBase } from './events_ui_base.js';
-import { VarBase } from './events_var_base.js';
-import { VarCreate } from './events_var_create.js';
-import { VarDelete } from './events_var_delete.js';
-import { VarRename } from './events_var_rename.js';
-import { ViewportChange } from './events_viewport.js';
+import { VarBase, VarBaseJson } from './events_var_base.js';
+import { VarCreate, VarCreateJson } from './events_var_create.js';
+import { VarDelete, VarDeleteJson } from './events_var_delete.js';
+import { VarRename, VarRenameJson } from './events_var_rename.js';
+import { ViewportChange, ViewportChangeJson } from './events_viewport.js';
 import * as eventUtils from './utils.js';
-import { FinishedLoading } from './workspace_events.js';
+import { FinishedLoading, FinishedLoadingJson } from './workspace_events.js';
 export declare const Abstract: typeof AbstractEvent;
+export { AbstractEventJson };
 export { BubbleOpen };
+export { BubbleOpenJson };
+export { BubbleType };
 export { BlockBase };
+export { BlockBaseJson };
 export { BlockChange };
+export { BlockChangeJson };
 export { BlockCreate };
+export { BlockCreateJson };
 export { BlockDelete };
+export { BlockDeleteJson };
 export { BlockDrag };
+export { BlockDragJson };
 export { BlockMove };
+export { BlockMoveJson };
 export { Click };
+export { ClickJson };
+export { ClickTarget };
 export { CommentBase };
+export { CommentBaseJson };
 export { CommentChange };
+export { CommentChangeJson };
 export { CommentCreate };
+export { CommentCreateJson };
 export { CommentDelete };
 export { CommentMove };
+export { CommentMoveJson };
 export { FinishedLoading };
+export { FinishedLoadingJson };
 export { MarkerMove };
+export { MarkerMoveJson };
 export { Selected };
+export { SelectedJson };
 export { ThemeChange };
+export { ThemeChangeJson };
 export { ToolboxItemSelect };
+export { ToolboxItemSelectJson };
 export { TrashcanOpen };
+export { TrashcanOpenJson };
 export { Ui };
 export { UiBase };
 export { VarBase };
+export { VarBaseJson };
 export { VarCreate };
+export { VarCreateJson };
 export { VarDelete };
+export { VarDeleteJson };
 export { VarRename };
+export { VarRenameJson };
 export { ViewportChange };
+export { ViewportChangeJson };
 export declare const BLOCK_CHANGE = "change";
 export declare const BLOCK_CREATE = "create";
 export declare const BLOCK_DELETE = "delete";
@@ -100,3 +126,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,11 +6,12 @@
 import type { Workspace } from '../workspace.js';
 /**
  * Abstract class for an event.
+ *
  * @alias Blockly.Events.Abstract
  */
 export declare abstract class Abstract {
     /** Whether or not the event is blank (to be populated by fromJson). */
-    isBlank: boolean | null;
+    abstract isBlank: boolean;
     /** The workspace identifier for this event. */
     workspaceId?: string;
     group: string;
@@ -18,34 +19,44 @@ export declare abstract class Abstract {
     /** Whether or not the event is a UI event. */
     isUiEvent: boolean;
     /** Type of this event. */
-    type?: string;
+    type: string;
     /** @alias Blockly.Events.Abstract */
     constructor();
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): AbstractEventJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: AbstractEventJson): 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;
 }
+export interface AbstractEventJson {
+    type: string;
+    group: string;
+}
+//# sourceMappingURL=events_abstract.d.ts.map

package/core/events/events_block_base.d.ts

@@ -4,15 +4,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Block } from '../block.js';
-import { Abstract as AbstractEvent } from './events_abstract.js';
+import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 /**
  * Abstract class for a block event.
+ *
  * @alias Blockly.Events.BlockBase
  */
 export declare class BlockBase extends AbstractEvent {
-    isBlank: any;
-    blockId: string;
-    workspaceId: string;
+    isBlank: boolean;
+    blockId?: string;
     /**
      * @param opt_block The block this event corresponds to.
      *     Undefined for a blank event.
@@ -20,12 +20,18 @@ export declare class BlockBase extends AbstractEvent {
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): AbstractEventJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: BlockBaseJson): void;
+}
+export interface BlockBaseJson extends AbstractEventJson {
+    blockId: string;
 }
+//# sourceMappingURL=events_block_base.d.ts.map

package/core/events/events_block_change.d.ts

@@ -5,17 +5,18 @@
  */
 import type { Block } from '../block.js';
 import type { BlockSvg } from '../block_svg.js';
-import { BlockBase } from './events_block_base.js';
+import { BlockBase, BlockBaseJson } from './events_block_base.js';
 /**
  * Class for a block change event.
+ *
  * @alias Blockly.Events.BlockChange
  */
 export declare class BlockChange extends BlockBase {
     type: string;
-    element: string;
-    name: string | null;
-    oldValue: any;
-    newValue: any;
+    element?: string;
+    name?: string;
+    oldValue: unknown;
+    newValue: unknown;
     /**
      * @param opt_block The changed block.  Undefined for a blank event.
      * @param opt_element One of 'field', 'comment', 'disabled', etc.
@@ -23,33 +24,45 @@ export declare class BlockChange extends BlockBase {
      * @param opt_oldValue Previous value of element.
      * @param opt_newValue New value of element.
      */
-    constructor(opt_block?: Block, opt_element?: string, opt_name?: string | null, opt_oldValue?: any, opt_newValue?: any);
+    constructor(opt_block?: Block, opt_element?: string, opt_name?: string | null, opt_oldValue?: unknown, opt_newValue?: unknown);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): BlockChangeJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: BlockChangeJson): 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;
 }
+export interface BlockChangeJson extends BlockBaseJson {
+    element: string;
+    name?: string;
+    newValue: unknown;
+    oldValue: unknown;
+}
+//# sourceMappingURL=events_block_change.d.ts.map

package/core/events/events_block_create.d.ts

@@ -5,31 +5,42 @@
  */
 import type { Block } from '../block.js';
 import * as blocks from '../serialization/blocks.js';
-import { BlockBase } from './events_block_base.js';
+import { BlockBase, BlockBaseJson } from './events_block_base.js';
 /**
  * Class for a block creation event.
+ *
  * @alias Blockly.Events.BlockCreate
  */
 export declare class BlockCreate extends BlockBase {
     type: string;
-    xml: any;
-    ids: string[];
-    json: blocks.State;
+    xml?: Element | DocumentFragment;
+    ids?: string[];
+    json?: blocks.State;
     /** @param opt_block The created block.  Undefined for a blank event. */
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): BlockCreateJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: BlockCreateJson): void;
     /**
      * Run a creation event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+export interface BlockCreateJson extends BlockBaseJson {
+    xml: string;
+    ids: string[];
+    json: object;
+    recordUndo?: boolean;
+}
+//# sourceMappingURL=events_block_create.d.ts.map

package/core/events/events_block_delete.d.ts

@@ -5,32 +5,44 @@
  */
 import type { Block } from '../block.js';
 import * as blocks from '../serialization/blocks.js';
-import { BlockBase } from './events_block_base.js';
+import { BlockBase, BlockBaseJson } from './events_block_base.js';
 /**
  * Class for a block deletion event.
+ *
  * @alias Blockly.Events.BlockDelete
  */
 export declare class BlockDelete extends BlockBase {
+    oldXml?: Element | DocumentFragment;
+    ids?: string[];
+    wasShadow?: boolean;
+    oldJson?: blocks.State;
     type: string;
-    oldXml: any;
-    ids: string[];
-    wasShadow: boolean;
-    oldJson: blocks.State;
     /** @param opt_block The deleted block.  Undefined for a blank event. */
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): BlockDeleteJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: BlockDeleteJson): void;
     /**
      * Run a deletion event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+export interface BlockDeleteJson extends BlockBaseJson {
+    oldXml: string;
+    ids: string[];
+    wasShadow: boolean;
+    oldJson: blocks.State;
+    recordUndo?: boolean;
+}
+//# sourceMappingURL=events_block_delete.d.ts.map

package/core/events/events_block_drag.d.ts

@@ -4,13 +4,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Block } from '../block.js';
+import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a block drag event.
+ *
  * @alias Blockly.Events.BlockDrag
  */
 export declare class BlockDrag extends UiBase {
-    blockId: any;
+    blockId?: string;
     isStart?: boolean;
     blocks?: Block[];
     type: string;
@@ -25,12 +27,20 @@ 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;
+    toJson(): BlockDragJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: BlockDragJson): void;
 }
+export interface BlockDragJson extends AbstractEventJson {
+    isStart: boolean;
+    blockId: string;
+    blocks?: Block[];
+}
+//# sourceMappingURL=events_block_drag.d.ts.map

package/core/events/events_block_move.d.ts

@@ -5,47 +5,60 @@
  */
 import type { Block } from '../block.js';
 import { Coordinate } from '../utils/coordinate.js';
-import { BlockBase } from './events_block_base.js';
+import { BlockBase, BlockBaseJson } 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 {
     type: string;
-    oldParentId: string;
-    oldInputName: string;
-    oldCoordinate: Coordinate | null;
-    newParentId: string | null;
-    newInputName: string | null;
-    newCoordinate: Coordinate | null;
+    oldParentId?: string;
+    oldInputName?: string;
+    oldCoordinate?: Coordinate;
+    newParentId?: string;
+    newInputName?: string;
+    newCoordinate?: Coordinate;
     /** @param opt_block The moved block.  Undefined for a blank event. */
     constructor(opt_block?: Block);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): BlockMoveJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: BlockMoveJson): void;
     /** Record the block's new location.  Called after the move. */
     recordNew(): void;
     /**
      * 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;
 }
+export interface BlockMoveJson extends BlockBaseJson {
+    newParentId?: string;
+    newInputName?: string;
+    newCoordinate?: string;
+    recordUndo?: boolean;
+}
+//# sourceMappingURL=events_block_move.d.ts.map