blockly 11.1.1 → 11.2.0-beta.1

package/core/events/events_comment_delete.d.ts

@@ -3,15 +3,21 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Class for comment deletion event.
+ *
+ * @class
+ */
 import type { WorkspaceComment } from '../comments/workspace_comment.js';
 import * as comments from '../serialization/workspace_comments.js';
-import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
+import { CommentBase, CommentBaseJson } from './events_comment_base.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that a workspace comment has been deleted.
  */
 export declare class CommentDelete extends CommentBase {
-    type: string;
+    type: EventType;
     /** The XML representation of the deleted workspace comment. */
     xml?: Element;
     /** The JSON representation of the created workspace comment. */

package/core/events/events_comment_drag.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Events fired when a workspace comment is dragged.
+ */
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
+import { Workspace } from '../workspace.js';
+import { AbstractEventJson } from './events_abstract.js';
+import { UiBase } from './events_ui_base.js';
+import { EventType } from './type.js';
+/**
+ * Notifies listeners when a comment is being manually dragged/dropped.
+ */
+export declare class CommentDrag extends UiBase {
+    /** The ID of the top-level comment being dragged. */
+    commentId?: string;
+    /** True if this is the start of a drag, false if this is the end of one. */
+    isStart?: boolean;
+    type: EventType;
+    /**
+     * @param opt_comment The comment that is being dragged.
+     *     Undefined for a blank event.
+     * @param opt_isStart Whether this is the start of a comment drag.
+     *    Undefined for a blank event.
+     */
+    constructor(opt_comment?: WorkspaceComment, opt_isStart?: boolean);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): CommentDragJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of CommentDrag, but we can't specify that due to the fact that parameters
+     *     to static methods in subclasses must be supertypes of parameters to
+     *     static methods in superclasses.
+     * @internal
+     */
+    static fromJson(json: CommentDragJson, workspace: Workspace, event?: any): CommentDrag;
+}
+export interface CommentDragJson extends AbstractEventJson {
+    isStart: boolean;
+    commentId: string;
+}
+//# sourceMappingURL=events_comment_drag.d.ts.map

package/core/events/events_comment_move.d.ts

@@ -3,15 +3,21 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Coordinate } from '../utils/coordinate.js';
+/**
+ * Class for comment move event.
+ *
+ * @class
+ */
 import type { WorkspaceComment } from '../comments/workspace_comment.js';
-import { CommentBase, CommentBaseJson } from './events_comment_base.js';
+import { Coordinate } from '../utils/coordinate.js';
 import type { Workspace } from '../workspace.js';
+import { CommentBase, CommentBaseJson } from './events_comment_base.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that a workspace comment has moved.
  */
 export declare class CommentMove extends CommentBase {
-    type: string;
+    type: EventType;
     /** The comment that is being moved. */
     comment_?: WorkspaceComment;
     /** The location of the comment before the move, in workspace coordinates. */

package/core/events/events_comment_resize.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Class for comment resize event.
+ */
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
+import { Size } from '../utils/size.js';
+import type { Workspace } from '../workspace.js';
+import { CommentBase, CommentBaseJson } from './events_comment_base.js';
+import { EventType } from './type.js';
+/**
+ * Notifies listeners that a workspace comment has resized.
+ */
+export declare class CommentResize extends CommentBase {
+    type: EventType;
+    /** The size of the comment before the resize. */
+    oldSize?: Size;
+    /** The size of the comment after the resize. */
+    newSize?: Size;
+    /**
+     * @param opt_comment The comment that is being resized. Undefined for a blank
+     *     event.
+     */
+    constructor(opt_comment?: WorkspaceComment);
+    /**
+     * Record the comment's new size. Called after the resize. Can only be
+     * called once.
+     */
+    recordCurrentSizeAsNewSize(): void;
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): CommentResizeJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of CommentResize, but we can't specify that due to the fact that
+     *     parameters to static methods in subclasses must be supertypes of
+     *     parameters to static methods in superclasses.
+     * @internal
+     */
+    static fromJson(json: CommentResizeJson, workspace: Workspace, event?: any): CommentResize;
+    /**
+     * Does this event record any change of state?
+     *
+     * @returns False if something changed.
+     */
+    isNull(): boolean;
+    /**
+     * Run a resize event.
+     *
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}
+export interface CommentResizeJson extends CommentBaseJson {
+    oldWidth: number;
+    oldHeight: number;
+    newWidth: number;
+    newHeight: number;
+}
+//# sourceMappingURL=events_comment_resize.d.ts.map

package/core/events/events_marker_move.d.ts

@@ -13,6 +13,7 @@ import { ASTNode } from '../keyboard_nav/ast_node.js';
 import type { Workspace } from '../workspace.js';
 import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that a marker (used for keyboard navigation) has
  * moved.
@@ -30,7 +31,7 @@ export declare class MarkerMove extends UiBase {
      * https://blocklycodelabs.dev/codelabs/keyboard-navigation/index.html?index=..%2F..index#1}.
      */
     isCursor?: boolean;
-    type: string;
+    type: EventType;
     /**
      * @param opt_block The affected block. Null if current node is of type
      *     workspace. Undefined for a blank event.

package/core/events/events_selected.d.ts

@@ -3,9 +3,10 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { Workspace } from '../workspace.js';
 import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
-import type { Workspace } from '../workspace.js';
+import { EventType } from './type.js';
 /**
  * Class for a selected event.
  * Notifies listeners that a new element has been selected.
@@ -18,7 +19,7 @@ export declare class Selected extends UiBase {
      * or undefined if unselected.
      */
     newElementId?: string;
-    type: string;
+    type: EventType;
     /**
      * @param opt_oldElementId The ID of the previously selected element. Null if
      *     no element last selected. Undefined for a blank event.

package/core/events/events_theme_change.d.ts

@@ -3,16 +3,17 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { Workspace } from '../workspace.js';
 import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
-import type { Workspace } from '../workspace.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that the workspace theme has changed.
  */
 export declare class ThemeChange extends UiBase {
     /** The name of the new theme that has been set. */
     themeName?: string;
-    type: string;
+    type: EventType;
     /**
      * @param opt_themeName The theme name. Undefined for a blank event.
      * @param opt_workspaceId The workspace identifier for this event.

package/core/events/events_toolbox_item_select.d.ts

@@ -3,9 +3,10 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { Workspace } from '../workspace.js';
 import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
-import type { Workspace } from '../workspace.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that a toolbox item has been selected.
  */
@@ -14,7 +15,7 @@ export declare class ToolboxItemSelect extends UiBase {
     oldItem?: string;
     /** The newly selected toolbox item. */
     newItem?: string;
-    type: string;
+    type: EventType;
     /**
      * @param opt_oldItem The previously selected toolbox item.
      *     Undefined for a blank event.

package/core/events/events_trashcan_open.d.ts

@@ -3,9 +3,10 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { Workspace } from '../workspace.js';
 import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
-import type { Workspace } from '../workspace.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners when the trashcan is opening or closing.
  */
@@ -15,7 +16,7 @@ export declare class TrashcanOpen extends UiBase {
      * False if it is currently closing (previously open).
      */
     isOpen?: boolean;
-    type: string;
+    type: EventType;
     /**
      * @param opt_isOpen Whether the trashcan flyout is opening (false if
      *     opening). Undefined for a blank event.

package/core/events/events_var_base.d.ts

@@ -9,8 +9,8 @@
  * @class
  */
 import type { VariableModel } from '../variable_model.js';
-import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 import type { Workspace } from '../workspace.js';
+import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 /**
  * Abstract class for a variable event.
  */

package/core/events/events_var_create.d.ts

@@ -4,13 +4,14 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { VariableModel } from '../variable_model.js';
-import { VarBase, VarBaseJson } from './events_var_base.js';
 import type { Workspace } from '../workspace.js';
+import { VarBase, VarBaseJson } from './events_var_base.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that a variable model has been created.
  */
 export declare class VarCreate extends VarBase {
-    type: string;
+    type: EventType;
     /** The type of the variable that was created. */
     varType?: string;
     /** The name of the variable that was created. */

package/core/events/events_var_delete.d.ts

@@ -4,15 +4,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { VariableModel } from '../variable_model.js';
-import { VarBase, VarBaseJson } from './events_var_base.js';
 import type { Workspace } from '../workspace.js';
+import { VarBase, VarBaseJson } from './events_var_base.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that a variable model has been deleted.
  *
  * @class
  */
 export declare class VarDelete extends VarBase {
-    type: string;
+    type: EventType;
     /** The type of the variable that was deleted. */
     varType?: string;
     /** The name of the variable that was deleted. */

package/core/events/events_var_rename.d.ts

@@ -4,15 +4,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { VariableModel } from '../variable_model.js';
-import { VarBase, VarBaseJson } from './events_var_base.js';
 import type { Workspace } from '../workspace.js';
+import { VarBase, VarBaseJson } from './events_var_base.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that a variable model was renamed.
  *
  * @class
  */
 export declare class VarRename extends VarBase {
-    type: string;
+    type: EventType;
     /** The previous name of the variable. */
     oldName?: string;
     /** The new name of the variable. */

package/core/events/events_viewport.d.ts

@@ -3,9 +3,10 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { Workspace } from '../workspace.js';
 import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
-import type { Workspace } from '../workspace.js';
+import { EventType } from './type.js';
 /**
  * Notifies listeners that the workspace surface's position or scale has
  * changed.
@@ -27,7 +28,7 @@ export declare class ViewportChange extends UiBase {
     scale?: number;
     /** The previous scale of the workspace. */
     oldScale?: number;
-    type: string;
+    type: EventType;
     /**
      * @param opt_top Top-edge of the visible portion of the workspace, relative
      *     to the workspace origin. Undefined for a blank event.

package/core/events/predicates.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @file Predicates for testing Abstract event subclasses based on
+ * their .type properties.  These are useful because there are places
+ * where it is not possible to use instanceof <ClassConstructor> tests
+ * for type narrowing due to load ordering issues that would be caused
+ * by the need to import (rather than just import type) the class
+ * constructors in question.
+ */
+import type { Abstract } from './events_abstract.js';
+import type { BlockChange } from './events_block_change.js';
+import type { BlockCreate } from './events_block_create.js';
+import type { BlockDelete } from './events_block_delete.js';
+import type { BlockDrag } from './events_block_drag.js';
+import type { BlockFieldIntermediateChange } from './events_block_field_intermediate_change.js';
+import type { BlockMove } from './events_block_move.js';
+import type { BubbleOpen } from './events_bubble_open.js';
+import type { Click } from './events_click.js';
+import type { CommentChange } from './events_comment_change.js';
+import type { CommentCollapse } from './events_comment_collapse.js';
+import type { CommentCreate } from './events_comment_create.js';
+import type { CommentDelete } from './events_comment_delete.js';
+import type { CommentDrag } from './events_comment_drag.js';
+import type { CommentMove } from './events_comment_move.js';
+import type { CommentResize } from './events_comment_resize.js';
+import type { MarkerMove } from './events_marker_move.js';
+import type { Selected } from './events_selected.js';
+import type { ThemeChange } from './events_theme_change.js';
+import type { ToolboxItemSelect } from './events_toolbox_item_select.js';
+import type { TrashcanOpen } from './events_trashcan_open.js';
+import type { VarCreate } from './events_var_create.js';
+import type { VarDelete } from './events_var_delete.js';
+import type { VarRename } from './events_var_rename.js';
+import type { ViewportChange } from './events_viewport.js';
+import type { FinishedLoading } from './workspace_events.js';
+/** @returns true iff event.type is EventType.BLOCK_CREATE */
+export declare function isBlockCreate(event: Abstract): event is BlockCreate;
+/** @returns true iff event.type is EventType.BLOCK_DELETE */
+export declare function isBlockDelete(event: Abstract): event is BlockDelete;
+/** @returns true iff event.type is EventType.BLOCK_CHANGE */
+export declare function isBlockChange(event: Abstract): event is BlockChange;
+/** @returns true iff event.type is EventType.BLOCK_FIELD_INTERMEDIATE_CHANGE */
+export declare function isBlockFieldIntermediateChange(event: Abstract): event is BlockFieldIntermediateChange;
+/** @returns true iff event.type is EventType.BLOCK_MOVE */
+export declare function isBlockMove(event: Abstract): event is BlockMove;
+/** @returns true iff event.type is EventType.VAR_CREATE */
+export declare function isVarCreate(event: Abstract): event is VarCreate;
+/** @returns true iff event.type is EventType.VAR_DELETE */
+export declare function isVarDelete(event: Abstract): event is VarDelete;
+/** @returns true iff event.type is EventType.VAR_RENAME */
+export declare function isVarRename(event: Abstract): event is VarRename;
+/** @returns true iff event.type is EventType.BLOCK_DRAG */
+export declare function isBlockDrag(event: Abstract): event is BlockDrag;
+/** @returns true iff event.type is EventType.SELECTED */
+export declare function isSelected(event: Abstract): event is Selected;
+/** @returns true iff event.type is EventType.CLICK */
+export declare function isClick(event: Abstract): event is Click;
+/** @returns true iff event.type is EventType.MARKER_MOVE */
+export declare function isMarkerMove(event: Abstract): event is MarkerMove;
+/** @returns true iff event.type is EventType.BUBBLE_OPEN */
+export declare function isBubbleOpen(event: Abstract): event is BubbleOpen;
+/** @returns true iff event.type is EventType.TRASHCAN_OPEN */
+export declare function isTrashcanOpen(event: Abstract): event is TrashcanOpen;
+/** @returns true iff event.type is EventType.TOOLBOX_ITEM_SELECT */
+export declare function isToolboxItemSelect(event: Abstract): event is ToolboxItemSelect;
+/** @returns true iff event.type is EventType.THEME_CHANGE */
+export declare function isThemeChange(event: Abstract): event is ThemeChange;
+/** @returns true iff event.type is EventType.VIEWPORT_CHANGE */
+export declare function isViewportChange(event: Abstract): event is ViewportChange;
+/** @returns true iff event.type is EventType.COMMENT_CREATE */
+export declare function isCommentCreate(event: Abstract): event is CommentCreate;
+/** @returns true iff event.type is EventType.COMMENT_DELETE */
+export declare function isCommentDelete(event: Abstract): event is CommentDelete;
+/** @returns true iff event.type is EventType.COMMENT_CHANGE */
+export declare function isCommentChange(event: Abstract): event is CommentChange;
+/** @returns true iff event.type is EventType.COMMENT_MOVE */
+export declare function isCommentMove(event: Abstract): event is CommentMove;
+/** @returns true iff event.type is EventType.COMMENT_RESIZE */
+export declare function isCommentResize(event: Abstract): event is CommentResize;
+/** @returns true iff event.type is EventType.COMMENT_DRAG */
+export declare function isCommentDrag(event: Abstract): event is CommentDrag;
+/** @returns true iff event.type is EventType.COMMENT_COLLAPSE */
+export declare function isCommentCollapse(event: Abstract): event is CommentCollapse;
+/** @returns true iff event.type is EventType.FINISHED_LOADING */
+export declare function isFinishedLoading(event: Abstract): event is FinishedLoading;
+//# sourceMappingURL=predicates.d.ts.map

package/core/events/type.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Enum of values for the .type property for event classes (concrete subclasses
+ * of Abstract).
+ */
+export declare enum EventType {
+    /** Type of event that creates a block. */
+    BLOCK_CREATE = "create",
+    /** Type of event that deletes a block. */
+    BLOCK_DELETE = "delete",
+    /** Type of event that changes a block. */
+    BLOCK_CHANGE = "change",
+    /**
+     * Type of event representing an in-progress change to a field of a
+     * block, which is expected to be followed by a block change event.
+     */
+    BLOCK_FIELD_INTERMEDIATE_CHANGE = "block_field_intermediate_change",
+    /** Type of event that moves a block. */
+    BLOCK_MOVE = "move",
+    /** Type of event that creates a variable. */
+    VAR_CREATE = "var_create",
+    /** Type of event that deletes a variable. */
+    VAR_DELETE = "var_delete",
+    /** Type of event that renames a variable. */
+    VAR_RENAME = "var_rename",
+    /**
+     * Type of generic event that records a UI change.
+     *
+     * @deprecated Was only ever intended for internal use.
+     */
+    UI = "ui",
+    /** Type of event that drags a block. */
+    BLOCK_DRAG = "drag",
+    /** Type of event that records a change in selected element. */
+    SELECTED = "selected",
+    /** Type of event that records a click. */
+    CLICK = "click",
+    /** Type of event that records a marker move. */
+    MARKER_MOVE = "marker_move",
+    /** Type of event that records a bubble open. */
+    BUBBLE_OPEN = "bubble_open",
+    /** Type of event that records a trashcan open. */
+    TRASHCAN_OPEN = "trashcan_open",
+    /** Type of event that records a toolbox item select. */
+    TOOLBOX_ITEM_SELECT = "toolbox_item_select",
+    /** Type of event that records a theme change. */
+    THEME_CHANGE = "theme_change",
+    /** Type of event that records a viewport change. */
+    VIEWPORT_CHANGE = "viewport_change",
+    /** Type of event that creates a comment. */
+    COMMENT_CREATE = "comment_create",
+    /** Type of event that deletes a comment. */
+    COMMENT_DELETE = "comment_delete",
+    /** Type of event that changes a comment. */
+    COMMENT_CHANGE = "comment_change",
+    /** Type of event that moves a comment. */
+    COMMENT_MOVE = "comment_move",
+    /** Type of event that resizes a comment. */
+    COMMENT_RESIZE = "comment_resize",
+    /**  Type of event that drags a comment. */
+    COMMENT_DRAG = "comment_drag",
+    /** Type of event that collapses a comment. */
+    COMMENT_COLLAPSE = "comment_collapse",
+    /** Type of event that records a workspace load. */
+    FINISHED_LOADING = "finished_loading"
+}
+/**
+ * List of events that cause objects to be bumped back into the visible
+ * portion of the workspace.
+ *
+ * Not to be confused with bumping so that disconnected connections do not
+ * appear connected.
+ */
+export declare const BUMP_EVENTS: string[];
+//# sourceMappingURL=type.d.ts.map