blockly 11.0.0-beta.7 → 11.0.0-beta.9

package/core/block.d.ts

@@ -123,7 +123,7 @@ export declare class Block implements IASTNodeLocation {
     inputList: Input[];
     inputsInline?: boolean;
     icons: IIcon[];
-    private disabled;
+    private disabledReasons;
     tooltip: Tooltip.TipInfo;
     contextMenu: boolean;
     protected parentBlock_: this | null;
@@ -627,17 +627,44 @@ export declare class Block implements IASTNodeLocation {
      */
     getOutputShape(): number | null;
     /**
-     * Get whether this block is enabled or not.
+     * Get whether this block is enabled or not. A block is considered enabled
+     * if there aren't any reasons why it would be disabled. A block may still
+     * be disabled for other reasons even if the user attempts to manually
+     * enable it, such as when the block is in an invalid location.
      *
      * @returns True if enabled.
      */
     isEnabled(): boolean;
-    /**
-     * Set whether the block is enabled or not.
+    /** @deprecated v11 - Get whether the block is manually disabled. */
+    private get disabled();
+    /** @deprecated v11 - Set whether the block is manually disabled. */
+    private set disabled(value);
+    /**
+     * @deprecated v11 - Set whether the block is manually enabled or disabled.
+     * The user can toggle whether a block is disabled from a context menu
+     * option. A block may still be disabled for other reasons even if the user
+     * attempts to manually enable it, such as when the block is in an invalid
+     * location. This method is deprecated and setDisabledReason should be used
+     * instead.
      *
      * @param enabled True if enabled.
      */
     setEnabled(enabled: boolean): void;
+    /**
+     * Add or remove a reason why the block might be disabled. If a block has
+     * any reasons to be disabled, then the block itself will be considered
+     * disabled. A block could be disabled for multiple independent reasons
+     * simultaneously, such as when the user manually disables it, or the block
+     * is invalid.
+     *
+     * @param disabled If true, then the block should be considered disabled for
+     *     at least the provided reason, otherwise the block is no longer disabled
+     *     for that reason.
+     * @param reason A language-neutral identifier for a reason why the block
+     *     could be disabled. Call this method again with the same identifier to
+     *     update whether the block is currently disabled for this reason.
+     */
+    setDisabledReason(disabled: boolean, reason: string): void;
     /**
      * Get whether the block is disabled or not due to parents.
      * The block's own disabled property is not considered.
@@ -645,6 +672,21 @@ export declare class Block implements IASTNodeLocation {
      * @returns True if disabled.
      */
     getInheritedDisabled(): boolean;
+    /**
+     * Get whether the block is currently disabled for the provided reason.
+     *
+     * @param reason A language-neutral identifier for a reason why the block
+     *     could be disabled.
+     * @returns Whether the block is disabled for the provided reason.
+     */
+    hasDisabledReason(reason: string): boolean;
+    /**
+     * Get a set of reasons why the block is currently disabled, if any. If the
+     * block is enabled, this set will be empty.
+     *
+     * @returns The set of reasons why the block is disabled, if any.
+     */
+    getDisabledReasons(): ReadonlySet<string>;
     /**
      * Get whether the block is collapsed or not.
      *

package/core/block_svg.d.ts

@@ -238,7 +238,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @param e Mouse event.
      * @internal
      */
-    showContextMenu(e: Event): void;
+    showContextMenu(e: PointerEvent): void;
     /**
      * Updates the locations of any parts of the block that need to know where
      * they are (e.g. connections, icons).
@@ -356,11 +356,31 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     private createIconPointerDownListener;
     removeIcon(type: IconType<IIcon>): boolean;
     /**
-     * Set whether the block is enabled or not.
+     * @deprecated v11 - Set whether the block is manually enabled or disabled.
+     * The user can toggle whether a block is disabled from a context menu
+     * option. A block may still be disabled for other reasons even if the user
+     * attempts to manually enable it, such as when the block is in an invalid
+     * location. This method is deprecated and setDisabledReason should be used
+     * instead.
      *
      * @param enabled True if enabled.
      */
     setEnabled(enabled: boolean): void;
+    /**
+     * Add or remove a reason why the block might be disabled. If a block has
+     * any reasons to be disabled, then the block itself will be considered
+     * disabled. A block could be disabled for multiple independent reasons
+     * simultaneously, such as when the user manually disables it, or the block
+     * is invalid.
+     *
+     * @param disabled If true, then the block should be considered disabled for
+     *     at least the provided reason, otherwise the block is no longer disabled
+     *     for that reason.
+     * @param reason A language-neutral identifier for a reason why the block
+     *     could be disabled. Call this method again with the same identifier to
+     *     update whether the block is currently disabled for this reason.
+     */
+    setDisabledReason(disabled: boolean, reason: string): void;
     /**
      * Set whether the block is highlighted or not.  Block highlighting is
      * often used to visually mark blocks currently being executed.
@@ -659,6 +679,6 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Returns a representation of this block that can be displayed in a flyout.
      */
-    toFlyoutData(): FlyoutItemInfo[];
+    toFlyoutInfo(): FlyoutItemInfo[];
 }
 //# sourceMappingURL=block_svg.d.ts.map

package/core/blockly.d.ts

@@ -30,7 +30,7 @@ import * as comments from './comments.js';
 import * as Css from './css.js';
 import { DeleteArea } from './delete_area.js';
 import * as dialog from './dialog.js';
-import { Dragger } from './dragging/dragger.js';
+import * as dragging from './dragging.js';
 import { DragTarget } from './drag_target.js';
 import * as dropDownDiv from './dropdowndiv.js';
 import * as Events from './events/events.js';
@@ -70,11 +70,12 @@ import { IComponent } from './interfaces/i_component.js';
 import { IConnectionChecker } from './interfaces/i_connection_checker.js';
 import { IConnectionPreviewer } from './interfaces/i_connection_previewer.js';
 import { IContextMenu } from './interfaces/i_contextmenu.js';
-import { ICopyable, isCopyable } from './interfaces/i_copyable.js';
+import { ICopyable, isCopyable, ICopyData } from './interfaces/i_copyable.js';
 import { IDeletable, isDeletable } from './interfaces/i_deletable.js';
 import { IDeleteArea } from './interfaces/i_delete_area.js';
 import { IDragTarget } from './interfaces/i_drag_target.js';
-import { IDraggable, isDraggable } from './interfaces/i_draggable.js';
+import { IDragger } from './interfaces/i_dragger.js';
+import { IDraggable, isDraggable, IDragStrategy } from './interfaces/i_draggable.js';
 import { IFlyout } from './interfaces/i_flyout.js';
 import { IHasBubble, hasBubble } from './interfaces/i_has_bubble.js';
 import { IIcon, isIcon } from './interfaces/i_icon.js';
@@ -85,6 +86,7 @@ import { IObservable, isObservable } from './interfaces/i_observable.js';
 import { IPaster, isPaster } from './interfaces/i_paster.js';
 import { IPositionable } from './interfaces/i_positionable.js';
 import { IRegistrable } from './interfaces/i_registrable.js';
+import { IRenderedElement, isRenderedElement } from './interfaces/i_rendered_element.js';
 import { ISelectable, isSelectable } from './interfaces/i_selectable.js';
 import { ISelectableToolboxItem } from './interfaces/i_selectable_toolbox_item.js';
 import { ISerializable, isSerializable } from './interfaces/i_serializable.js';
@@ -98,6 +100,7 @@ import { Cursor } from './keyboard_nav/cursor.js';
 import { Marker } from './keyboard_nav/marker.js';
 import { TabNavigateCursor } from './keyboard_nav/tab_navigate_cursor.js';
 import { MarkerManager } from './marker_manager.js';
+import type { LayerManager } from './layer_manager.js';
 import { Menu } from './menu.js';
 import { MenuItem } from './menuitem.js';
 import { MetricsManager } from './metrics_manager.js';
@@ -138,8 +141,6 @@ import * as VariablesDynamic from './variables_dynamic.js';
 import * as WidgetDiv from './widgetdiv.js';
 import { Workspace } from './workspace.js';
 import { WorkspaceAudio } from './workspace_audio.js';
-import { WorkspaceComment } from './workspace_comment.js';
-import { WorkspaceCommentSvg } from './workspace_comment_svg.js';
 import { WorkspaceDragger } from './workspace_dragger.js';
 import { WorkspaceSvg } from './workspace_svg.js';
 import * as Xml from './xml.js';
@@ -307,7 +308,7 @@ export { ContextMenuRegistry };
 export { comments };
 export { Cursor };
 export { DeleteArea };
-export { Dragger };
+export { dragging };
 export { DragTarget };
 export declare const DropDownDiv: typeof dropDownDiv;
 export { Field, FieldConfig, FieldValidator, UnattachedFieldError };
@@ -339,11 +340,12 @@ export { IConnectionChecker };
 export { IConnectionPreviewer };
 export { IContextMenu };
 export { icons };
-export { ICopyable, isCopyable };
+export { ICopyable, isCopyable, ICopyData };
 export { IDeletable, isDeletable };
 export { IDeleteArea };
 export { IDragTarget };
-export { IDraggable, isDraggable };
+export { IDragger };
+export { IDraggable, isDraggable, IDragStrategy };
 export { IFlyout };
 export { IHasBubble, hasBubble };
 export { IIcon, isIcon };
@@ -358,6 +360,7 @@ export { IObservable, isObservable };
 export { IPaster, isPaster };
 export { IPositionable };
 export { IRegistrable };
+export { IRenderedElement, isRenderedElement };
 export { ISelectable, isSelectable };
 export { ISelectableToolboxItem };
 export { ISerializable, isSerializable };
@@ -367,6 +370,7 @@ export { IToolboxItem };
 export { IVariableBackedParameterModel, isVariableBackedParameterModel };
 export { Marker };
 export { MarkerManager };
+export { LayerManager };
 export { Menu };
 export { MenuItem };
 export { MetricsManager };
@@ -391,8 +395,6 @@ export { VariableModel };
 export { VerticalFlyout };
 export { Workspace };
 export { WorkspaceAudio };
-export { WorkspaceComment };
-export { WorkspaceCommentSvg };
 export { WorkspaceDragger };
 export { WorkspaceSvg };
 export { ZoomControls };

package/core/clipboard/workspace_comment_paster.d.ts

@@ -7,12 +7,13 @@ import { IPaster } from '../interfaces/i_paster.js';
 import { ICopyData } from '../interfaces/i_copyable.js';
 import { Coordinate } from '../utils/coordinate.js';
 import { WorkspaceSvg } from '../workspace_svg.js';
-import { WorkspaceCommentSvg } from '../workspace_comment_svg.js';
-export declare class WorkspaceCommentPaster implements IPaster<WorkspaceCommentCopyData, WorkspaceCommentSvg> {
+import * as commentSerialiation from '../serialization/workspace_comments.js';
+import { RenderedWorkspaceComment } from '../comments/rendered_workspace_comment.js';
+export declare class WorkspaceCommentPaster implements IPaster<WorkspaceCommentCopyData, RenderedWorkspaceComment> {
     static TYPE: string;
-    paste(copyData: WorkspaceCommentCopyData, workspace: WorkspaceSvg, coordinate?: Coordinate): WorkspaceCommentSvg;
+    paste(copyData: WorkspaceCommentCopyData, workspace: WorkspaceSvg, coordinate?: Coordinate): RenderedWorkspaceComment | null;
 }
 export interface WorkspaceCommentCopyData extends ICopyData {
-    commentState: Element;
+    commentState: commentSerialiation.State;
 }
 //# sourceMappingURL=workspace_comment_paster.d.ts.map

package/core/comments/comment_view.d.ts

@@ -11,6 +11,10 @@ export declare class CommentView implements IRenderedElement {
     private readonly workspace;
     /** The root group element of the comment view. */
     private svgRoot;
+    /**
+     * The svg rect element that we use to create a hightlight around the comment.
+     */
+    private highlightRect;
     /** The group containing all of the top bar elements. */
     private topBarGroup;
     /** The rect background for the top bar. */
@@ -62,6 +66,10 @@ export declare class CommentView implements IRenderedElement {
     /** Whether this comment view has been disposed or not. */
     private disposed;
     constructor(workspace: WorkspaceSvg);
+    /**
+     * Creates the rect we use for highlighting the comment when it's selected.
+     */
+    private createHighlightRect;
     /**
      * Creates the top bar and the elements visually within it.
      * Registers event listeners.
@@ -95,6 +103,8 @@ export declare class CommentView implements IRenderedElement {
     private calcDeleteMargin;
     /** Calculates the margin that should exist around the foldout icon. */
     private calcFoldoutMargin;
+    /** Updates the size of the highlight rect to reflect the new size. */
+    private updateHighlightRect;
     /** Updates the size of the top bar to reflect the new size. */
     private updateTopBarSize;
     /** Updates the size of the text area elements to reflect the new size. */

package/core/comments/rendered_workspace_comment.d.ts

@@ -12,7 +12,11 @@ import { IBoundedElement } from '../interfaces/i_bounded_element.js';
 import { IRenderedElement } from '../interfaces/i_rendered_element.js';
 import { IDraggable } from '../interfaces/i_draggable.js';
 import { ISelectable } from '../interfaces/i_selectable.js';
-export declare class RenderedWorkspaceComment extends WorkspaceComment implements IBoundedElement, IRenderedElement, IDraggable, ISelectable {
+import { IDeletable } from '../interfaces/i_deletable.js';
+import { ICopyable } from '../interfaces/i_copyable.js';
+import { WorkspaceCommentCopyData } from '../clipboard/workspace_comment_paster.js';
+import { IContextMenu } from '../interfaces/i_contextmenu.js';
+export declare class RenderedWorkspaceComment extends WorkspaceComment implements IBoundedElement, IRenderedElement, IDraggable, ISelectable, IDeletable, ICopyable<WorkspaceCommentCopyData>, IContextMenu {
     /** The class encompassing the svg elements making up the workspace comment. */
     private view;
     readonly workspace: WorkspaceSvg;
@@ -59,6 +63,8 @@ export declare class RenderedWorkspaceComment extends WorkspaceComment implement
      * (that wasn't otherwise gobbled up, e.g. by resizing).
      */
     private startGesture;
+    /** Visually indicates that this comment would be deleted if dropped. */
+    setDeleteStyle(wouldDelete: boolean): void;
     /** Returns whether this comment is movable or not. */
     isMovable(): boolean;
     /** Starts a drag on the comment. */
@@ -69,7 +75,16 @@ export declare class RenderedWorkspaceComment extends WorkspaceComment implement
     endDrag(): void;
     /** Moves the comment back to where it was at the start of a drag. */
     revertDrag(): void;
+    /** Visually highlights the comment. */
     select(): void;
+    /** Visually unhighlights the comment. */
     unselect(): void;
+    /**
+     * Returns a JSON serializable representation of this comment's state that
+     * can be used for pasting.
+     */
+    toCopyData(): WorkspaceCommentCopyData | null;
+    /** Show a context menu for this comment. */
+    showContextMenu(e: PointerEvent): void;
 }
 //# sourceMappingURL=rendered_workspace_comment.d.ts.map

package/core/constants.d.ts

@@ -11,4 +11,9 @@ export declare const COLLAPSED_INPUT_NAME = "_TEMP_COLLAPSED_INPUT";
  * The language-neutral ID given to the collapsed field.
  */
 export declare const COLLAPSED_FIELD_NAME = "_TEMP_COLLAPSED_FIELD";
+/**
+ * The language-neutral ID for when the reason why a block is disabled is
+ * because the user manually disabled it, such as via the context menu.
+ */
+export declare const MANUALLY_DISABLED = "MANUALLY_DISABLED";
 //# sourceMappingURL=constants.d.ts.map

package/core/contextmenu.d.ts

@@ -7,8 +7,6 @@ import type { Block } from './block.js';
 import type { BlockSvg } from './block_svg.js';
 import type { ContextMenuOption, LegacyContextMenuOption } from './contextmenu_registry.js';
 import * as serializationBlocks from './serialization/blocks.js';
-import { WorkspaceCommentSvg } from './workspace_comment_svg.js';
-import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Gets the block the context menu is currently attached to.
  *
@@ -28,7 +26,7 @@ export declare function setCurrentBlock(block: Block | null): void;
  * @param options Array of menu options.
  * @param rtl True if RTL, false if LTR.
  */
-export declare function show(e: Event, options: (ContextMenuOption | LegacyContextMenuOption)[], rtl: boolean): void;
+export declare function show(e: PointerEvent, options: (ContextMenuOption | LegacyContextMenuOption)[], rtl: boolean): void;
 /**
  * Hide the context menu.
  */
@@ -46,35 +44,4 @@ export declare function dispose(): void;
  * @returns Function that creates a block.
  */
 export declare function callbackFactory(block: Block, state: Element | serializationBlocks.State): () => BlockSvg;
-/**
- * Make a context menu option for deleting the current workspace comment.
- *
- * @param comment The workspace comment where the
- *     right-click originated.
- * @returns A menu option,
- *     containing text, enabled, and a callback.
- * @internal
- */
-export declare function commentDeleteOption(comment: WorkspaceCommentSvg): LegacyContextMenuOption;
-/**
- * Make a context menu option for duplicating the current workspace comment.
- *
- * @param comment The workspace comment where the
- *     right-click originated.
- * @returns A menu option,
- *     containing text, enabled, and a callback.
- * @internal
- */
-export declare function commentDuplicateOption(comment: WorkspaceCommentSvg): LegacyContextMenuOption;
-/**
- * Make a context menu option for adding a comment on the workspace.
- *
- * @param ws The workspace where the right-click
- *     originated.
- * @param e The right-click mouse event.
- * @returns A menu option, containing text, enabled, and a callback.
- *     comments are not bundled in.
- * @internal
- */
-export declare function workspaceCommentOption(ws: WorkspaceSvg, e: Event): ContextMenuOption;
 //# sourceMappingURL=contextmenu.d.ts.map

package/core/contextmenu_items.d.ts

@@ -55,6 +55,14 @@ export declare function registerDelete(): void;
  * Option to open help for a block.
  */
 export declare function registerHelp(): void;
+/** Registers an option for deleting a workspace comment. */
+export declare function registerCommentDelete(): void;
+/** Registers an option for duplicating a workspace comment. */
+export declare function registerCommentDuplicate(): void;
+/** Registers an option for adding a workspace comment to the workspace. */
+export declare function registerCommentCreate(): void;
+/** Registers all workspace comment related menu items. */
+export declare function registerCommentOptions(): void;
 /**
  * Registers all default context menu items. This should be called once per
  * instance of ContextMenuRegistry.

package/core/contextmenu_registry.d.ts

@@ -9,6 +9,7 @@
  * @class
  */
 import type { BlockSvg } from './block_svg.js';
+import { RenderedWorkspaceComment } from './comments/rendered_workspace_comment.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for the registry of context menu items. This is intended to be a
@@ -63,7 +64,8 @@ export declare namespace ContextMenuRegistry {
      */
     enum ScopeType {
         BLOCK = "block",
-        WORKSPACE = "workspace"
+        WORKSPACE = "workspace",
+        COMMENT = "comment"
     }
     /**
      * The actual workspace/block where the menu is being rendered. This is passed
@@ -72,12 +74,19 @@ export declare namespace ContextMenuRegistry {
     interface Scope {
         block?: BlockSvg;
         workspace?: WorkspaceSvg;
+        comment?: RenderedWorkspaceComment;
     }
     /**
      * A menu item as entered in the registry.
      */
     interface RegistryItem {
-        callback: (p1: Scope) => void;
+        /**
+         * @param scope Object that provides a reference to the thing that had its
+         *     context menu opened.
+         * @param e The original event that triggered the context menu to open. Not
+         *     the event that triggered the click on the option.
+         */
+        callback: (scope: Scope, e: PointerEvent) => void;
         scopeType: ScopeType;
         displayText: ((p1: Scope) => string | HTMLElement) | string | HTMLElement;
         preconditionFn: (p1: Scope) => string;
@@ -90,7 +99,13 @@ export declare namespace ContextMenuRegistry {
     interface ContextMenuOption {
         text: string | HTMLElement;
         enabled: boolean;
-        callback: (p1: Scope) => void;
+        /**
+         * @param scope Object that provides a reference to the thing that had its
+         *     context menu opened.
+         * @param e The original event that triggered the context menu to open. Not
+         *     the event that triggered the click on the option.
+         */
+        callback: (scope: Scope, e: PointerEvent) => void;
         scope: Scope;
         weight: number;
     }

package/core/dragging/comment_drag_strategy.d.ts

@@ -15,6 +15,7 @@ export declare class CommentDragStrategy implements IDragStrategy {
     startDrag(): void;
     drag(newLoc: Coordinate): void;
     endDrag(): void;
+    private fireMoveEvent;
     revertDrag(): void;
 }
 //# sourceMappingURL=comment_drag_strategy.d.ts.map

package/core/dragging/dragger.d.ts

@@ -3,16 +3,17 @@
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { IDragTarget } from '../interfaces/i_drag_target.js';
 import { IDeletable } from '../interfaces/i_deletable.js';
 import { IDragger } from '../interfaces/i_dragger.js';
 import { IDraggable } from '../interfaces/i_draggable.js';
 import { Coordinate } from '../utils/coordinate.js';
 import { WorkspaceSvg } from '../workspace_svg.js';
 export declare class Dragger implements IDragger {
-    private draggable;
-    private workspace;
-    private startLoc;
-    private dragTarget;
+    protected draggable: IDraggable;
+    protected workspace: WorkspaceSvg;
+    protected startLoc: Coordinate;
+    protected dragTarget: IDragTarget | null;
     constructor(draggable: IDraggable, workspace: WorkspaceSvg);
     /** Handles any drag startup. */
     onDragStart(e: PointerEvent): void;

package/core/dragging.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Dragger } from './dragging/dragger.js';
+import { BlockDragStrategy } from './dragging/block_drag_strategy.js';
+import { BubbleDragStrategy } from './dragging/bubble_drag_strategy.js';
+import { CommentDragStrategy } from './dragging/comment_drag_strategy.js';
+export { Dragger, BlockDragStrategy, BubbleDragStrategy, CommentDragStrategy };
+//# sourceMappingURL=dragging.d.ts.map

package/core/events/events_block_change.d.ts

@@ -29,6 +29,11 @@ export declare class BlockChange extends BlockBase {
     oldValue: unknown;
     /** The new value of the element. */
     newValue: unknown;
+    /**
+     * If element is 'disabled', this is the language-neutral identifier of the
+     * reason why the block was or was not disabled.
+     */
+    private disabledReason?;
     /**
      * @param opt_block The changed block.  Undefined for a blank event.
      * @param opt_element One of 'field', 'comment', 'disabled', etc.
@@ -53,6 +58,15 @@ export declare class BlockChange extends BlockBase {
      * @internal
      */
     static fromJson(json: BlockChangeJson, workspace: Workspace, event?: any): BlockChange;
+    /**
+     * Set the language-neutral identifier for the reason why the block was or was
+     * not disabled. This is only valid for events where element is 'disabled'.
+     * Defaults to 'MANUALLY_DISABLED'.
+     *
+     * @param disabledReason The identifier of the reason why the block was or was
+     *     not disabled.
+     */
+    setDisabledReason(disabledReason: string): void;
     /**
      * Does this event record any change of state?
      *
@@ -80,5 +94,6 @@ export interface BlockChangeJson extends BlockBaseJson {
     name?: string;
     newValue: unknown;
     oldValue: unknown;
+    disabledReason?: string;
 }
 //# sourceMappingURL=events_block_change.d.ts.map

package/core/events/utils.d.ts

@@ -231,10 +231,8 @@ export declare function fromJson(json: any, workspace: Workspace): Abstract;
  */
 export declare function get(eventType: string): new (...p1: any[]) => Abstract;
 /**
- * Enable/disable a block depending on whether it is properly connected.
+ * Set if a block is disabled depending on whether it is properly connected.
  * Use this on applications where all blocks should be connected to a top block.
- * Recommend setting the 'disable' option to 'false' in the config so that
- * users don't try to re-enable disabled orphan blocks.
  *
  * @param event Custom data for event.
  */

package/core/gesture.d.ts

@@ -15,8 +15,10 @@ import type { Field } from './field.js';
 import type { IBubble } from './interfaces/i_bubble.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import { Coordinate } from './utils/coordinate.js';
+import { WorkspaceDragger } from './workspace_dragger.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 import type { IIcon } from './interfaces/i_icon.js';
+import { IDragger } from './interfaces/i_dragger.js';
 import { RenderedWorkspaceComment } from './comments.js';
 /**
  * Class for one gesture.
@@ -398,6 +400,7 @@ export declare class Gesture {
      * @returns Whether this gesture was a click on a bubble.
      */
     private isBubbleClick;
+    private isCommentClick;
     /**
      * Whether this gesture is a click on a block.  This should only be called
      * when ending a gesture (pointerup).
@@ -421,6 +424,8 @@ export declare class Gesture {
      * @returns Whether this gesture was a click on a workspace.
      */
     private isWorkspaceClick;
+    /** Returns the current dragger if the gesture is a drag. */
+    getCurrentDragger(): WorkspaceDragger | IDragger | null;
     /**
      * Whether this gesture is a drag of either a workspace or block.
      * This function is called externally to block actions that cannot be taken

package/core/registry.d.ts

@@ -58,7 +58,11 @@ export declare class Type<_T> {
     static FLYOUTS_VERTICAL_TOOLBOX: Type<IFlyout>;
     static FLYOUTS_HORIZONTAL_TOOLBOX: Type<IFlyout>;
     static METRICS_MANAGER: Type<IMetricsManager>;
-    static DRAGGER: Type<IDragger>;
+    /**
+     * Type for an IDragger. Formerly behavior was mostly covered by
+     * BlockDraggeers, which is why the name is inaccurate.
+     */
+    static BLOCK_DRAGGER: Type<IDragger>;
     /** @internal */
     static SERIALIZER: Type<ISerializer>;
     /** @internal */

package/core/serialization/blocks.d.ts

@@ -27,6 +27,7 @@ export interface State {
     movable?: boolean;
     editable?: boolean;
     enabled?: boolean;
+    disabledReasons?: string[];
     inline?: boolean;
     data?: string;
     extraState?: any;

package/core/serialization/workspace_comments.d.ts

@@ -5,7 +5,7 @@
  */
 import { ISerializer } from '../interfaces/i_serializer.js';
 import { Workspace } from '../workspace.js';
-import { WorkspaceComment } from '../comments/workspace_comment.js';
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
 export interface State {
     id?: string;
     text?: string;

package/core/utils/toolbox.d.ts

@@ -16,6 +16,7 @@ export interface BlockInfo {
     type?: string;
     gap?: string | number;
     disabled?: string | boolean;
+    disabledReasons?: string[];
     enabled?: boolean;
     id?: string;
     x?: number;

package/core/workspace.d.ts

@@ -18,7 +18,7 @@ import { Options } from './options.js';
 import type * as toolbox from './utils/toolbox.js';
 import { VariableMap } from './variable_map.js';
 import type { VariableModel } from './variable_model.js';
-import type { WorkspaceComment } from './workspace_comment.js';
+import { WorkspaceComment } from './comments/workspace_comment.js';
 import { IProcedureMap } from './interfaces/i_procedure_map.js';
 /**
  * Class for a workspace.  This is a data structure that contains blocks.
@@ -279,6 +279,14 @@ export declare class Workspace implements IASTNodeLocation {
      * @returns The created block.
      */
     newBlock(prototypeName: string, opt_id?: string): Block;
+    /**
+     * Obtain a newly created comment.
+     *
+     * @param id Optional ID.  Use this ID if provided, otherwise create a new
+     *     ID.
+     * @returns The created comment.
+     */
+    newComment(id?: string): WorkspaceComment;
     /**
      * The number of blocks that may be added to the workspace before reaching
      *     the maxBlocks.