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

package/core/events/events_bubble_open.d.ts

@@ -3,16 +3,18 @@
  * 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';
 /**
  * Class for a bubble open event.
+ *
  * @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.
@@ -21,15 +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.
-     * @return JSON representation.
+     *
+     * @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,14 +4,16 @@
  * 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.
+ *
  * @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
@@ -22,15 +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.
-     * @return JSON representation.
+     *
+     * @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,17 +4,17 @@
  * 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';
 /**
  * Abstract class for a comment event.
+ *
  * @alias Blockly.Events.CommentBase
  */
 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.
@@ -22,18 +22,25 @@ export declare class CommentBase extends AbstractEvent {
     constructor(opt_comment?: WorkspaceComment);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @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]
+     *
      * @param event The event to run.
      * @param create if True then Create, if False then Delete
      */
     static CommentCreateDeleteHelper(event: CommentCreate | CommentDelete, create: boolean): void;
 }
+export interface CommentBaseJson extends AbstractEventJson {
+    commentId: string;
+}
+//# sourceMappingURL=events_comment_base.d.ts.map

package/core/events/events_comment_change.d.ts

@@ -4,15 +4,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { WorkspaceComment } from '../workspace_comment.js';
-import { CommentBase } from './events_comment_base.js';
+import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 /**
  * Class for a comment change event.
+ *
  * @alias Blockly.Events.CommentChange
  */
 export declare class CommentChange extends CommentBase {
     type: string;
-    oldContents_: string;
-    newContents_: string;
+    oldContents_?: string;
+    newContents_?: string;
     /**
      * @param opt_comment The comment that is being changed.  Undefined for a
      *     blank event.
@@ -22,22 +23,31 @@ 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;
+    toJson(): CommentChangeJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: CommentChangeJson): 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;
 }
+export interface CommentChangeJson extends CommentBaseJson {
+    oldContents: string;
+    newContents: string;
+}
+//# sourceMappingURL=events_comment_change.d.ts.map

package/core/events/events_comment_create.d.ts

@@ -4,14 +4,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { WorkspaceComment } from '../workspace_comment.js';
-import { CommentBase } from './events_comment_base.js';
+import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 /**
  * Class for a comment creation event.
+ *
  * @alias Blockly.Events.CommentCreate
  */
 export declare class CommentCreate extends CommentBase {
     type: string;
-    xml: any;
+    xml?: Element | DocumentFragment;
     /**
      * @param opt_comment The created comment.
      *     Undefined for a blank event.
@@ -19,17 +20,24 @@ export declare class CommentCreate extends CommentBase {
     constructor(opt_comment?: WorkspaceComment);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): CommentCreateJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: CommentCreateJson): void;
     /**
      * Run a creation event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+export interface CommentCreateJson extends CommentBaseJson {
+    xml: string;
+}
+//# sourceMappingURL=events_comment_create.d.ts.map

package/core/events/events_comment_delete.d.ts

@@ -7,29 +7,22 @@ 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 {
     type: string;
-    xml: any;
+    xml?: Element;
     /**
      * @param opt_comment The deleted comment.
      *     Undefined for a blank event.
      */
     constructor(opt_comment?: WorkspaceComment);
-    /**
-     * Encode the event as JSON.
-     * @return 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

@@ -5,17 +5,18 @@
  */
 import { Coordinate } from '../utils/coordinate.js';
 import type { WorkspaceComment } from '../workspace_comment.js';
-import { CommentBase } from './events_comment_base.js';
+import { CommentBase, CommentBaseJson } 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 {
     type: string;
-    comment_: WorkspaceComment;
-    oldCoordinate_: Coordinate;
+    comment_?: WorkspaceComment;
+    oldCoordinate_?: Coordinate;
     /** The location after the move, in workspace coordinates. */
-    newCoordinate_: Coordinate;
+    newCoordinate_?: Coordinate;
     /**
      * @param opt_comment The comment that is being moved.  Undefined for a blank
      *     event.
@@ -29,27 +30,37 @@ 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;
+    toJson(): CommentMoveJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: CommentMoveJson): 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;
 }
+export interface CommentMoveJson extends CommentBaseJson {
+    oldCoordinate: string;
+    newCoordinate: string;
+}
+//# sourceMappingURL=events_comment_move.d.ts.map

package/core/events/events_marker_move.d.ts

@@ -5,14 +5,16 @@
  */
 import type { Block } from '../block.js';
 import { ASTNode } from '../keyboard_nav/ast_node.js';
+import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a marker move event.
+ *
  * @alias Blockly.Events.MarkerMove
  */
 export declare class MarkerMove extends UiBase {
-    blockId: string | null;
-    oldNode?: ASTNode | null;
+    blockId?: string;
+    oldNode?: ASTNode;
     newNode?: ASTNode;
     isCursor?: boolean;
     type: string;
@@ -29,12 +31,21 @@ 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;
+    toJson(): MarkerMoveJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: MarkerMoveJson): void;
 }
+export interface MarkerMoveJson extends AbstractEventJson {
+    isCursor: boolean;
+    blockId?: string;
+    oldNode?: ASTNode;
+    newNode: ASTNode;
+}
+//# sourceMappingURL=events_marker_move.d.ts.map

package/core/events/events_selected.d.ts

@@ -3,14 +3,16 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a selected event.
+ *
  * @alias Blockly.Events.Selected
  */
 export declare class Selected extends UiBase {
-    oldElementId?: string | null;
-    newElementId?: string | null;
+    oldElementId?: string;
+    newElementId?: string;
     type: string;
     /**
      * @param opt_oldElementId The ID of the previously selected element. Null if
@@ -23,12 +25,19 @@ export declare class Selected extends UiBase {
     constructor(opt_oldElementId?: string | null, opt_newElementId?: string | null, opt_workspaceId?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): SelectedJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: SelectedJson): void;
 }
+export interface SelectedJson extends AbstractEventJson {
+    oldElementId?: string;
+    newElementId?: string;
+}
+//# sourceMappingURL=events_selected.d.ts.map

package/core/events/events_theme_change.d.ts

@@ -3,9 +3,11 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a theme change event.
+ *
  * @alias Blockly.Events.ThemeChange
  */
 export declare class ThemeChange extends UiBase {
@@ -19,12 +21,18 @@ export declare class ThemeChange extends UiBase {
     constructor(opt_themeName?: string, opt_workspaceId?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): ThemeChangeJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: ThemeChangeJson): void;
 }
+export interface ThemeChangeJson extends AbstractEventJson {
+    themeName: string;
+}
+//# sourceMappingURL=events_theme_change.d.ts.map

package/core/events/events_toolbox_item_select.d.ts

@@ -3,14 +3,16 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a toolbox item select event.
+ *
  * @alias Blockly.Events.ToolboxItemSelect
  */
 export declare class ToolboxItemSelect extends UiBase {
-    oldItem?: string | null;
-    newItem?: string | null;
+    oldItem?: string;
+    newItem?: string;
     type: string;
     /**
      * @param opt_oldItem The previously selected toolbox item.
@@ -23,12 +25,19 @@ export declare class ToolboxItemSelect extends UiBase {
     constructor(opt_oldItem?: string | null, opt_newItem?: string | null, opt_workspaceId?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): ToolboxItemSelectJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: ToolboxItemSelectJson): void;
 }
+export interface ToolboxItemSelectJson extends AbstractEventJson {
+    oldItem?: string;
+    newItem?: string;
+}
+//# sourceMappingURL=events_toolbox_item_select.d.ts.map

package/core/events/events_trashcan_open.d.ts

@@ -3,9 +3,11 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a trashcan open event.
+ *
  * @alias Blockly.Events.TrashcanOpen
  */
 export declare class TrashcanOpen extends UiBase {
@@ -20,12 +22,18 @@ export declare class TrashcanOpen extends UiBase {
     constructor(opt_isOpen?: boolean, opt_workspaceId?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): TrashcanOpenJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: TrashcanOpenJson): void;
 }
+export interface TrashcanOpenJson extends AbstractEventJson {
+    isOpen: boolean;
+}
+//# sourceMappingURL=events_trashcan_open.d.ts.map

package/core/events/events_ui.d.ts

@@ -7,6 +7,7 @@ import type { Block } from '../block.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a UI event.
+ *
  * @deprecated December 2020. Instead use a more specific UI event.
  * @alias Blockly.Events.Ui
  */
@@ -26,12 +27,15 @@ export declare class Ui extends UiBase {
     constructor(opt_block?: Block | null, opt_element?: string, 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;
 }
+//# sourceMappingURL=events_ui.d.ts.map

package/core/events/events_ui_base.d.ts

@@ -10,6 +10,7 @@ import { Abstract as AbstractEvent } from './events_abstract.js';
  * editing to work (e.g. scrolling the workspace, zooming, opening toolbox
  * categories).
  * UI events do not undo or redo.
+ *
  * @alias Blockly.Events.UiBase
  */
 export declare class UiBase extends AbstractEvent {
@@ -24,3 +25,4 @@ export declare class UiBase extends AbstractEvent {
      */
     constructor(opt_workspaceId?: string);
 }
+//# sourceMappingURL=events_ui_base.d.ts.map

package/core/events/events_var_base.d.ts

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

package/core/events/events_var_create.d.ts

@@ -4,32 +4,41 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { VariableModel } from '../variable_model.js';
-import { VarBase } from './events_var_base.js';
+import { VarBase, VarBaseJson } from './events_var_base.js';
 /**
  * Class for a variable creation event.
+ *
  * @alias Blockly.Events.VarCreate
  */
 export declare class VarCreate extends VarBase {
     type: string;
-    varType: string;
-    varName: string;
+    varType?: string;
+    varName?: string;
     /**
      * @param opt_variable The created variable. Undefined for a blank event.
      */
     constructor(opt_variable?: VariableModel);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): VarCreateJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: VarCreateJson): void;
     /**
      * Run a variable creation event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+export interface VarCreateJson extends VarBaseJson {
+    varType: string;
+    varName: string;
+}
+//# sourceMappingURL=events_var_create.d.ts.map