blockly 9.0.0-beta.1 → 9.0.0-beta.2

package/core/block.d.ts

@@ -121,6 +121,10 @@ export declare class Block implements IASTNodeLocation, IDeletable {
     private isShadow_;
     protected collapsed_: boolean;
     protected outputShape_: number | null;
+    /**
+     * Is the current block currently in the process of being disposed?
+     */
+    private disposing;
     /**
      * A string representing the comment attached to this block.
      *
@@ -173,6 +177,13 @@ export declare class Block implements IASTNodeLocation, IDeletable {
      * @suppress {checkTypes}
      */
     dispose(healStack: boolean): void;
+    /**
+     * Returns true if the block is either in the process of being disposed, or
+     * is disposed.
+     *
+     * @internal
+     */
+    isDeadOrDying(): boolean;
     /**
      * Call initModel on all fields on the block.
      * May be called more than once.

package/core/block_svg.d.ts

@@ -108,13 +108,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      *
      * @returns #RRGGBB string.
      */
-    getColourSecondary(): string | null;
+    getColourSecondary(): string | undefined;
     /**
      * Get the tertiary colour of a block.
      *
      * @returns #RRGGBB string.
      */
-    getColourTertiary(): string | null;
+    getColourTertiary(): string | undefined;
     /**
      * Selects this block. Highlights the block visually and fires a select event
      * if the block is not already selected.
@@ -651,6 +651,6 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @param add True if highlighting should be added.
      * @internal
      */
-    highlightShapeForInput(conn: Connection, add: boolean): void;
+    highlightShapeForInput(conn: RenderedConnection, add: boolean): void;
 }
 //# sourceMappingURL=block_svg.d.ts.map

package/core/blockly.d.ts

@@ -102,7 +102,7 @@ import { MarkerManager } from './marker_manager.js';
 import { Menu } from './menu.js';
 import { MenuItem } from './menuitem.js';
 import { MetricsManager } from './metrics_manager.js';
-import { Msg } from './msg.js';
+import { Msg, setLocale } from './msg.js';
 import { Mutator } from './mutator.js';
 import { Names } from './names.js';
 import { Options } from './options.js';
@@ -538,7 +538,7 @@ export { Menu };
 export { MenuItem };
 export { MetricsManager };
 export { Mutator };
-export { Msg };
+export { Msg, setLocale };
 export { Names };
 export { Options };
 export { RenderedConnection };

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";

package/core/events/events_abstract.d.ts

@@ -11,7 +11,7 @@ import type { Workspace } from '../workspace.js';
  */
 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;
@@ -19,7 +19,7 @@ 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();
     /**
@@ -27,13 +27,13 @@ export declare abstract class Abstract {
      *
      * @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?
      *
@@ -55,4 +55,8 @@ export declare abstract class Abstract {
      */
     getEventWorkspace_(): Workspace;
 }
+export interface AbstractEventJson {
+    type: string;
+    group: string;
+}
 //# sourceMappingURL=events_abstract.d.ts.map

package/core/events/events_block_base.d.ts

@@ -4,16 +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.
@@ -24,12 +23,15 @@ export declare class BlockBase extends AbstractEvent {
      *
      * @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,7 +5,7 @@
  */
 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.
  *
@@ -13,10 +13,10 @@ import { BlockBase } from './events_block_base.js';
  */
 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.
@@ -24,19 +24,19 @@ 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.
      *
      * @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?
      *
@@ -59,4 +59,10 @@ export declare class BlockChange extends BlockBase {
      */
     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,7 +5,7 @@
  */
 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.
  *
@@ -13,9 +13,9 @@ import { BlockBase } from './events_block_base.js';
  */
 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);
     /**
@@ -23,13 +23,13 @@ export declare class BlockCreate extends BlockBase {
      *
      * @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.
      *
@@ -37,4 +37,10 @@ export declare class BlockCreate extends BlockBase {
      */
     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,18 +5,18 @@
  */
 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);
     /**
@@ -24,13 +24,13 @@ export declare class BlockDelete extends BlockBase {
      *
      * @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.
      *
@@ -38,4 +38,11 @@ export declare class BlockDelete extends BlockBase {
      */
     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,6 +4,7 @@
  * 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.
@@ -11,7 +12,7 @@ import { UiBase } from './events_ui_base.js';
  * @alias Blockly.Events.BlockDrag
  */
 export declare class BlockDrag extends UiBase {
-    blockId: any;
+    blockId?: string;
     isStart?: boolean;
     blocks?: Block[];
     type: string;
@@ -29,12 +30,17 @@ export declare class BlockDrag extends UiBase {
      *
      * @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,7 +5,7 @@
  */
 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.
  *
@@ -13,12 +13,12 @@ import { BlockBase } from './events_block_base.js';
  */
 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);
     /**
@@ -26,13 +26,13 @@ export declare class BlockMove extends BlockBase {
      *
      * @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;
     /**
@@ -55,4 +55,10 @@ export declare class BlockMove extends BlockBase {
      */
     run(forward: boolean): void;
 }
+export interface BlockMoveJson extends BlockBaseJson {
+    newParentId?: string;
+    newInputName?: string;
+    newCoordinate?: string;
+    recordUndo?: boolean;
+}
 //# sourceMappingURL=events_block_move.d.ts.map

package/core/events/events_bubble_open.d.ts

@@ -3,6 +3,7 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { AbstractEventJson } from './events_abstract.js';
 import type { BlockSvg } from '../block_svg.js';
 import { UiBase } from './events_ui_base.js';
 /**
@@ -11,9 +12,9 @@ import { UiBase } from './events_ui_base.js';
  * @alias Blockly.Events.BubbleOpen
  */
 export declare class BubbleOpen extends UiBase {
-    blockId: string | null;
+    blockId?: string;
     isOpen?: boolean;
-    bubbleType?: string;
+    bubbleType?: BubbleType;
     type: string;
     /**
      * @param opt_block The associated block. Undefined for a blank event.
@@ -22,18 +23,28 @@ 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?: BubbleType);
     /**
      * Encode the event as JSON.
      *
      * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): BubbleOpenJson;
     /**
      * Decode the JSON event.
      *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: BubbleOpenJson): void;
+}
+export declare enum BubbleType {
+    MUTATOR = "mutator",
+    COMMENT = "comment",
+    WARNING = "warning"
+}
+export interface BubbleOpenJson extends AbstractEventJson {
+    isOpen: boolean;
+    bubbleType: BubbleType;
+    blockId: string;
 }
 //# sourceMappingURL=events_bubble_open.d.ts.map

package/core/events/events_click.d.ts

@@ -4,6 +4,7 @@
  * 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 click event.
@@ -11,8 +12,8 @@ import { UiBase } from './events_ui_base.js';
  * @alias Blockly.Events.Click
  */
 export declare class Click extends UiBase {
-    blockId: any;
-    targetType?: string;
+    blockId?: string;
+    targetType?: ClickTarget;
     type: string;
     /**
      * @param opt_block The affected block. Null for click events that do not have
@@ -23,18 +24,27 @@ export declare class Click extends UiBase {
      * @param opt_targetType The type of element targeted by this click event.
      *     Undefined for a blank event.
      */
-    constructor(opt_block?: Block | null, opt_workspaceId?: string | null, opt_targetType?: string);
+    constructor(opt_block?: Block | null, opt_workspaceId?: string | null, opt_targetType?: ClickTarget);
     /**
      * Encode the event as JSON.
      *
      * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): ClickJson;
     /**
      * Decode the JSON event.
      *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: ClickJson): void;
+}
+export declare enum ClickTarget {
+    BLOCK = "block",
+    WORKSPACE = "workspace",
+    ZOOM_CONTROLS = "zoom_controls"
+}
+export interface ClickJson extends AbstractEventJson {
+    targetType: ClickTarget;
+    blockId?: string;
 }
 //# sourceMappingURL=events_click.d.ts.map

package/core/events/events_comment_base.d.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { WorkspaceComment } from '../workspace_comment.js';
-import { Abstract as AbstractEvent } from './events_abstract.js';
+import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 import type { CommentCreate } from './events_comment_create.js';
 import type { CommentDelete } from './events_comment_delete.js';
 /**
@@ -14,8 +14,7 @@ import type { CommentDelete } from './events_comment_delete.js';
  */
 export declare class CommentBase extends AbstractEvent {
     isBlank: boolean;
-    commentId: string;
-    workspaceId: string;
+    commentId?: string;
     /**
      * @param opt_comment The comment this event corresponds to.  Undefined for a
      *     blank event.
@@ -26,13 +25,13 @@ export declare class CommentBase extends AbstractEvent {
      *
      * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): CommentBaseJson;
     /**
      * Decode the JSON event.
      *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: CommentBaseJson): void;
     /**
      * Helper function for Comment[Create|Delete]
      *
@@ -41,4 +40,7 @@ export declare class CommentBase extends AbstractEvent {
      */
     static CommentCreateDeleteHelper(event: CommentCreate | CommentDelete, create: boolean): void;
 }
+export interface CommentBaseJson extends AbstractEventJson {
+    commentId: string;
+}
 //# sourceMappingURL=events_comment_base.d.ts.map