blockly 11.0.0-beta.5 → 11.0.0-beta.6

package/core/block.d.ts

@@ -18,7 +18,7 @@ import type { Field } from './field.js';
 import { Input } from './inputs/input.js';
 import type { IASTNodeLocation } from './interfaces/i_ast_node_location.js';
 import type { IDeletable } from './interfaces/i_deletable.js';
-import type { IIcon } from './interfaces/i_icon.js';
+import { type IIcon } from './interfaces/i_icon.js';
 import type { MutatorIcon } from './icons/mutator_icon.js';
 import * as Tooltip from './tooltip.js';
 import { Coordinate } from './utils/coordinate.js';
@@ -138,7 +138,13 @@ export declare class Block implements IASTNodeLocation, IDeletable {
     /**
      * Is the current block currently in the process of being disposed?
      */
-    private disposing;
+    protected disposing: boolean;
+    /**
+     * Has this block been fully initialized? E.g. all fields initailized.
+     *
+     * @internal
+     */
+    initialized: boolean;
     private readonly xy_;
     isInFlyout: boolean;
     isInMutator: boolean;
@@ -147,7 +153,8 @@ export declare class Block implements IASTNodeLocation, IDeletable {
     protected isInsertionMarker_: boolean;
     /** Name of the type of hat. */
     hat?: string;
-    rendered: boolean | null;
+    /** Is this block a BlockSVG? */
+    readonly rendered: boolean;
     /**
      * String for block help, or function that returns a URL. Null for no help.
      */

package/core/block_dragger.d.ts

@@ -31,11 +31,13 @@ export declare class BlockDragger implements IBlockDragger {
     /** Whether the block would be deleted if dropped immediately. */
     protected wouldDeleteBlock_: boolean;
     protected startXY_: Coordinate;
+    /** The parent block at the start of the drag. */
+    private startParentConn;
     /**
-     * @deprecated To be removed in v11. Updating icons is now handled by the
-     *     block's `moveDuringDrag` method.
+     * The child block at the start of the drag. Only gets set if
+     * `healStack` is true.
      */
-    protected dragIconData_: IconPositionData[];
+    private startChildConn;
     /**
      * @param block The block to drag.
      * @param workspace The workspace to drag on.
@@ -137,6 +139,11 @@ export declare class BlockDragger implements IBlockDragger {
      *     at the start of the drag, in pixel units.
      */
     endDrag(e: PointerEvent, currentDragDeltaXY: Coordinate): void;
+    /**
+     * Moves the dragged block back to its original position before the start of
+     * the drag. Reconnects any parent and child blocks.
+     */
+    private moveToOriginalPosition;
     /**
      * Calculates the drag delta and new location values after a block is dragged.
      *
@@ -189,13 +196,6 @@ export declare class BlockDragger implements IBlockDragger {
      * @returns The input coordinate divided by the workspace scale.
      */
     protected pixelsToWorkspaceUnits_(pixelCoord: Coordinate): Coordinate;
-    /**
-     * Move all of the icons connected to this drag.
-     *
-     * @deprecated To be removed in v11. This is now handled by the block's
-     *     `moveDuringDrag` method.
-     */
-    protected dragIcons_(): void;
     /**
      * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
      * or 2 insertion markers.

package/core/block_svg.d.ts

@@ -10,7 +10,6 @@
  */
 import './events/events_selected.js';
 import { Block } from './block.js';
-import { CommentIcon } from './icons/comment_icon.js';
 import type { Connection } from './connection.js';
 import { ConnectionType } from './connection_type.js';
 import { ContextMenuOption, LegacyContextMenuOption } from './contextmenu_registry.js';
@@ -27,7 +26,6 @@ import type { IPathObject } from './renderers/common/i_path_object.js';
 import type { BlockStyle } from './theme.js';
 import { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';
-import { WarningIcon } from './icons/warning_icon.js';
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 import { IconType } from './icons/icon_types.js';
@@ -68,17 +66,12 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     private warningTextDb;
     /** Block's mutator icon (if any). */
     mutator: MutatorIcon | null;
-    /**
-     * Block's warning icon (if any).
-     *
-     * @deprecated Use `setWarningText` to modify warnings on this block.
-     */
-    warning: WarningIcon | null;
     private svgGroup_;
     style: BlockStyle;
     /** @internal */
     pathObject: IPathObject;
-    rendered: boolean;
+    /** Is this block a BlockSVG? */
+    readonly rendered = true;
     private visuallyDisabled;
     /**
      * Is this block currently rendering? Used to stop recursive render calls
@@ -92,11 +85,6 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     nextConnection: RenderedConnection;
     previousConnection: RenderedConnection;
     private translation;
-    /**
-     * The ID of the setTimeout callback for bumping neighbours, or 0 if no bump
-     * is currently scheduled.
-     */
-    private bumpNeighboursPid;
     /** Whether this block is currently being dragged. */
     private dragging;
     /**
@@ -349,14 +337,6 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @internal
      */
     updateDisabled(): void;
-    /**
-     * Get the comment icon attached to this block, or null if the block has no
-     * comment.
-     *
-     * @returns The comment icon attached to this block, or null.
-     * @deprecated Use getIcon. To be remove in v11.
-     */
-    getCommentIcon(): CommentIcon | null;
     /**
      * Set this block's warning text.
      *
@@ -506,8 +486,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Returns connections originating from this block.
      *
      * @param all If true, return all connections even hidden ones.
-     *     Otherwise, for a non-rendered block return an empty list, and for a
-     *     collapsed block don't return inputs connections.
+     *     Otherwise, for a collapsed block don't return inputs connections.
      * @returns Array of connections.
      * @internal
      */
@@ -562,14 +541,8 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      */
     bumpNeighbours(): void;
     /**
-     * Bumps unconnected blocks out of alignment.
-     */
-    private bumpNeighboursInternal;
-    /**
-     * Schedule snapping to grid and bumping neighbours to occur after a brief
-     * delay.
-     *
-     * @internal
+     * Snap to grid, and then bump neighbouring blocks away at the end of the next
+     * render.
      */
     scheduleSnapAndBump(): void;
     /**

package/core/blockly.d.ts

@@ -14,7 +14,6 @@ import { BlockSvg } from './block_svg.js';
 import { BlocklyOptions } from './blockly_options.js';
 import { Blocks } from './blocks.js';
 import * as browserEvents from './browser_events.js';
-import { Bubble } from './bubbles/bubble.js';
 import * as bubbles from './bubbles.js';
 import { BubbleDragger } from './bubble_dragger.js';
 import * as bumpObjects from './bump_objects.js';
@@ -29,6 +28,7 @@ import { ConnectionType } from './connection_type.js';
 import * as ContextMenu from './contextmenu.js';
 import * as ContextMenuItems from './contextmenu_items.js';
 import { ContextMenuRegistry } from './contextmenu_registry.js';
+import * as comments from './comments.js';
 import * as Css from './css.js';
 import { DeleteArea } from './delete_area.js';
 import * as dialog from './dialog.js';
@@ -37,14 +37,11 @@ import * as dropDownDiv from './dropdowndiv.js';
 import * as Events from './events/events.js';
 import * as Extensions from './extensions.js';
 import { Field, FieldConfig, FieldValidator, UnattachedFieldError } from './field.js';
-import { FieldAngle, FieldAngleConfig, FieldAngleFromJsonConfig, FieldAngleValidator } from './field_angle.js';
 import { FieldCheckbox, FieldCheckboxConfig, FieldCheckboxFromJsonConfig, FieldCheckboxValidator } from './field_checkbox.js';
-import { FieldColour, FieldColourConfig, FieldColourFromJsonConfig, FieldColourValidator } from './field_colour.js';
 import { FieldDropdown, FieldDropdownConfig, FieldDropdownFromJsonConfig, FieldDropdownValidator, MenuGenerator, MenuGeneratorFunction, MenuOption } from './field_dropdown.js';
 import { FieldImage, FieldImageConfig, FieldImageFromJsonConfig } from './field_image.js';
 import { FieldLabel, FieldLabelConfig, FieldLabelFromJsonConfig } from './field_label.js';
 import { FieldLabelSerializable } from './field_label_serializable.js';
-import { FieldMultilineInput, FieldMultilineInputConfig, FieldMultilineInputFromJsonConfig, FieldMultilineInputValidator } from './field_multilineinput.js';
 import { FieldNumber, FieldNumberConfig, FieldNumberFromJsonConfig, FieldNumberValidator } from './field_number.js';
 import * as fieldRegistry from './field_registry.js';
 import { FieldTextInput, FieldTextInputConfig, FieldTextInputFromJsonConfig, FieldTextInputValidator } from './field_textinput.js';
@@ -59,12 +56,10 @@ import { Gesture } from './gesture.js';
 import { Grid } from './grid.js';
 import * as icons from './icons.js';
 import { inject } from './inject.js';
-import { Align } from './inputs/align.js';
 import { Input } from './inputs/input.js';
-import { inputTypes } from './inputs/input_types.js';
 import * as inputs from './inputs.js';
 import { InsertionMarkerManager } from './insertion_marker_manager.js';
-import { InsertionMarkerPreviewer } from './connection_previewers/insertion_marker_previewer.js';
+import { InsertionMarkerPreviewer } from './insertion_marker_previewer.js';
 import { IASTNodeLocation } from './interfaces/i_ast_node_location.js';
 import { IASTNodeLocationSvg } from './interfaces/i_ast_node_location_svg.js';
 import { IASTNodeLocationWithBlock } from './interfaces/i_ast_node_location_with_block.js';
@@ -119,7 +114,6 @@ import * as renderManagement from './render_management.js';
 import * as blockRendering from './renderers/common/block_rendering.js';
 import * as constants from './constants.js';
 import * as geras from './renderers/geras/geras.js';
-import * as minimalist from './renderers/minimalist/minimalist.js';
 import * as thrasos from './renderers/thrasos/thrasos.js';
 import * as zelos from './renderers/zelos/zelos.js';
 import { Scrollbar } from './scrollbar.js';
@@ -163,21 +157,6 @@ import { ZoomControls } from './zoom_controls.js';
  * @define {string}
  */
 export declare const VERSION = "uncompiled";
-/**
- * @see Blockly.Input.Align.LEFT
- * @deprecated Use `Blockly.inputs.Align.LEFT`. To be removed in v11.
- */
-export declare const ALIGN_LEFT = Align.LEFT;
-/**
- * @see Blockly.Input.Align.CENTRE
- * @deprecated Use `Blockly.inputs.Align.CENTER`. To be removed in v11.
- */
-export declare const ALIGN_CENTRE = Align.CENTRE;
-/**
- * @see Blockly.Input.Align.RIGHT
- * @deprecated Use `Blockly.inputs.Align.RIGHT`. To be removed in v11.
- */
-export declare const ALIGN_RIGHT = Align.RIGHT;
 /**
  * @see ConnectionType.INPUT_VALUE
  */
@@ -194,11 +173,6 @@ export declare const NEXT_STATEMENT = ConnectionType.NEXT_STATEMENT;
  * @see ConnectionType.PREVIOUS_STATEMENT
  */
 export declare const PREVIOUS_STATEMENT = ConnectionType.PREVIOUS_STATEMENT;
-/**
- * @see inputTypes.DUMMY_INPUT
- * @deprecated Use `Blockly.inputs.inputTypes.DUMMY`. To be removed in v11.
- */
-export declare const DUMMY_INPUT = inputTypes.DUMMY;
 /** Aliases for toolbox positions. */
 /**
  * @see toolbox.Position.TOP
@@ -314,7 +288,6 @@ export { constants };
 export { dialog };
 export { fieldRegistry };
 export { geras };
-export { minimalist };
 export { registry };
 export { thrasos };
 export { uiPosition };
@@ -328,8 +301,6 @@ export { BlockDragger };
 export { BlockSvg };
 export { Blocks };
 export { bubbles };
-/** @deprecated Use Blockly.bubbles.Bubble instead. To be removed in v11. */
-export { Bubble };
 export { BubbleDragger };
 export { CollapsibleToolboxCategory };
 export { ComponentManager };
@@ -338,19 +309,17 @@ export { ConnectionType };
 export { ConnectionChecker };
 export { ConnectionDB };
 export { ContextMenuRegistry };
+export { comments };
 export { Cursor };
 export { DeleteArea };
 export { DragTarget };
 export declare const DropDownDiv: typeof dropDownDiv;
 export { Field, FieldConfig, FieldValidator, UnattachedFieldError };
-export { FieldAngle, FieldAngleConfig, FieldAngleFromJsonConfig, FieldAngleValidator, };
 export { FieldCheckbox, FieldCheckboxConfig, FieldCheckboxFromJsonConfig, FieldCheckboxValidator, };
-export { FieldColour, FieldColourConfig, FieldColourFromJsonConfig, FieldColourValidator, };
 export { FieldDropdown, FieldDropdownConfig, FieldDropdownFromJsonConfig, FieldDropdownValidator, MenuGenerator, MenuGeneratorFunction, MenuOption, };
 export { FieldImage, FieldImageConfig, FieldImageFromJsonConfig };
 export { FieldLabel, FieldLabelConfig, FieldLabelFromJsonConfig };
 export { FieldLabelSerializable };
-export { FieldMultilineInput, FieldMultilineInputConfig, FieldMultilineInputFromJsonConfig, FieldMultilineInputValidator, };
 export { FieldNumber, FieldNumberConfig, FieldNumberFromJsonConfig, FieldNumberValidator, };
 export { FieldTextInput, FieldTextInputConfig, FieldTextInputFromJsonConfig, FieldTextInputValidator, };
 export { FieldVariable, FieldVariableConfig, FieldVariableFromJsonConfig, FieldVariableValidator, };
@@ -433,10 +402,6 @@ export { WorkspaceDragger };
 export { WorkspaceSvg };
 export { ZoomControls };
 export { config };
-/** @deprecated Use Blockly.ConnectionType instead. */
-export declare const connectionTypes: typeof ConnectionType;
 export { inject };
-/** @deprecated Use Blockly.inputs.inputTypes instead. To be removed in v11. */
-export { inputTypes };
 export { serialization };
 //# sourceMappingURL=blockly.d.ts.map

package/core/clipboard.d.ts

@@ -8,14 +8,6 @@ import { BlockPaster } from './clipboard/block_paster.js';
 import { WorkspaceSvg } from './workspace_svg.js';
 import * as registry from './clipboard/registry.js';
 import { Coordinate } from './utils/coordinate.js';
-/**
- * Copy a copyable element onto the local clipboard.
- *
- * @param toCopy The copyable element to be copied.
- * @deprecated v11. Use `myCopyable.toCopyData()` instead. To be removed v12.
- * @internal
- */
-export declare function copy<T extends ICopyData>(toCopy: ICopyable<T>): T | null;
 /**
  * Private version of copy for stubbing in tests.
  */
@@ -35,17 +27,6 @@ export declare function paste<T extends ICopyData>(copyData: T, workspace: Works
  * @returns the pasted thing if the paste was successful, null otherwise.
  */
 export declare function paste(): ICopyable<ICopyData> | null;
-/**
- * Duplicate this copy-paste-able element.
- *
- * @param toDuplicate The element to be duplicated.
- * @returns The element that was duplicated, or null if the duplication failed.
- * @deprecated v11. Use
- *     `Blockly.clipboard.paste(myCopyable.toCopyData(), myWorkspace)` instead.
- *     To be removed v12.
- * @internal
- */
-export declare function duplicate<U extends ICopyData, T extends ICopyable<U> & IHasWorkspace>(toDuplicate: T): T | null;
 /**
  * Private version of duplicate for stubbing in tests.
  */

package/core/comments/comment_view.d.ts

@@ -0,0 +1,201 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IRenderedElement } from '../interfaces/i_rendered_element.js';
+import { WorkspaceSvg } from '../workspace_svg.js';
+import { Coordinate } from '../utils/coordinate.js';
+import { Size } from '../utils/size.js';
+export declare class CommentView implements IRenderedElement {
+    private readonly workspace;
+    /** The root group element of the comment view. */
+    private svgRoot;
+    /** The rect background for the top bar. */
+    private topBar;
+    /** The delete icon that goes in the top bar. */
+    private deleteIcon;
+    /** The foldout icon that goes in the top bar. */
+    private foldoutIcon;
+    /** The text element that goes in the top bar. */
+    private textPreview;
+    /** The actual text node in the text preview. */
+    private textPreviewNode;
+    /** The resize handle element. */
+    private resizeHandle;
+    /** The foreignObject containing the HTML text area. */
+    private foreignObject;
+    /** The text area where the user can type. */
+    private textArea;
+    /** The current size of the comment in workspace units. */
+    private size;
+    /** Whether the comment is collapsed or not. */
+    private collapsed;
+    /** Whether the comment is editable or not. */
+    private editable;
+    /** The current location of the comment in workspace coordinates. */
+    private location;
+    /** The current text of the comment. Updates on  text area change. */
+    private text;
+    /** Listeners for changes to text. */
+    private textChangeListeners;
+    /** Listeners for changes to size. */
+    private sizeChangeListeners;
+    /** Listeners for disposal. */
+    private disposeListeners;
+    /** Listeners for collapsing. */
+    private collapseChangeListeners;
+    /**
+     * Event data for the pointer up event on the resize handle. Used to
+     * unregister the listener.
+     */
+    private resizePointerUpListener;
+    /**
+     * Event data for the pointer move event on the resize handle. Used to
+     * unregister the listener.
+     */
+    private resizePointerMoveListener;
+    /** Whether this comment view is currently being disposed or not. */
+    private disposing;
+    /** Whether this comment view has been disposed or not. */
+    private disposed;
+    constructor(workspace: WorkspaceSvg);
+    /**
+     * Creates the top bar and the elements visually within it.
+     * Registers event listeners.
+     */
+    private createTopBar;
+    /**
+     * Creates the text area where users can type. Registers event listeners.
+     */
+    private createTextArea;
+    /** Creates the DOM elements for the comment resize handle. */
+    private createResizeHandle;
+    /** Returns the root SVG group element of the comment view. */
+    getSvgRoot(): SVGGElement;
+    /** Returns the current size of the comment in workspace units. */
+    getSize(): Size;
+    /**
+     * Sets the size of the comment in workspace units, and updates the view
+     * elements to reflect the new size.
+     */
+    setSize(size: Size): void;
+    /**
+     * Calculates the minimum size for the uncollapsed comment based on text
+     * size and visible icons.
+     *
+     * The minimum width is based on the width of the truncated preview text.
+     *
+     * The minimum height is based on the height of the top bar.
+     */
+    private calcMinSize;
+    /** Calculates the margin that should exist around the delete icon. */
+    private calcDeleteMargin;
+    /** Calculates the margin that should exist around the foldout icon. */
+    private calcFoldoutMargin;
+    /** Updates the size of the text area elements to reflect the new size. */
+    private updateTextAreaSize;
+    /**
+     * Updates the position of the delete icon elements to reflect the new size.
+     */
+    private updateDeleteIconPosition;
+    /**
+     * Updates the position of the foldout icon elements to reflect the new size.
+     */
+    private updateFoldoutIconPosition;
+    /**
+     * Updates the size and position of the text preview elements to reflect the new size.
+     */
+    private updateTextPreviewSize;
+    /**
+     * Triggers listeners when the size of the comment changes, either
+     * progrmatically or manually by the user.
+     */
+    private onSizeChange;
+    /**
+     * Registers a callback that listens for size changes.
+     *
+     * @param listener Receives callbacks when the size of the comment changes.
+     *     The new and old size are in workspace units.
+     */
+    addSizeChangeListener(listener: (oldSize: Size, newSize: Size) => void): void;
+    /** Removes the given listener from the list of size change listeners. */
+    removeSizeChangeListener(listener: () => void): void;
+    /**
+     * Handles starting an interaction with the resize handle to resize the
+     * comment.
+     */
+    private onResizePointerDown;
+    /** Ends an interaction with the resize handle. */
+    private onResizePointerUp;
+    /** Resizes the comment in response to a drag on the resize handle. */
+    private onResizePointerMove;
+    /** Returns true if the comment is currently collapsed. */
+    isCollapsed(): boolean;
+    /** Sets whether the comment is currently collapsed or not. */
+    setCollapsed(collapsed: boolean): void;
+    /**
+     * Triggers listeners when the collapsed-ness of the comment changes, either
+     * progrmatically or manually by the user.
+     */
+    private onCollapse;
+    /** Registers a callback that listens for collapsed-ness changes. */
+    addOnCollapseListener(listener: (newCollapse: boolean) => void): void;
+    /** Removes the given listener from the list of on collapse listeners. */
+    removeOnCollapseListener(listener: () => void): void;
+    /**
+     * Toggles the collapsedness of the block when we receive a pointer down
+     * event on the foldout icon.
+     */
+    private onFoldoutDown;
+    /** Returns true if the comment is currently editable. */
+    isEditable(): boolean;
+    /** Sets the editability of the comment. */
+    setEditable(editable: boolean): void;
+    /** Returns the current location of the comment in workspace coordinates. */
+    getRelativeToSurfaceXY(): Coordinate;
+    /**
+     * Moves the comment view to the given location.
+     *
+     * @param location The location to move to in workspace coordinates.
+     */
+    moveTo(location: Coordinate): void;
+    /** Retursn the current text of the comment. */
+    getText(): string;
+    /** Sets the current text of the comment. */
+    setText(text: string): void;
+    /** Registers a callback that listens for text changes. */
+    addTextChangeListener(listener: (oldText: string, newText: string) => void): void;
+    /** Removes the given listener from the list of text change listeners. */
+    removeTextChangeListener(listener: () => void): void;
+    /**
+     * Triggers listeners when the text of the comment changes, either
+     * progrmatically or manually by the user.
+     */
+    private onTextChange;
+    /** Updates the preview text element to reflect the given text. */
+    private updateTextPreview;
+    /** Truncates the text to fit within the top view. */
+    private truncateText;
+    /** Brings the workspace comment to the front of its layer. */
+    private bringToFront;
+    /**
+     * Handles disposing of the comment when we get a pointer down event on the
+     * delete icon.
+     */
+    private onDeleteDown;
+    /** Disposes of this comment view. */
+    dispose(): void;
+    /** Returns whether this comment view has been disposed or not. */
+    isDisposed(): boolean;
+    /**
+     * Returns true if this comment view is currently being disposed or has
+     * already been disposed.
+     */
+    isDeadOrDying(): boolean;
+    /** Registers a callback that listens for disposal of this view. */
+    addDisposeListener(listener: () => void): void;
+    /** Removes the given listener from the list of disposal listeners. */
+    removeDisposeListener(listener: () => void): void;
+}
+//# sourceMappingURL=comment_view.d.ts.map

package/core/comments/rendered_workspace_comment.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { WorkspaceComment } from './workspace_comment.js';
+import { WorkspaceSvg } from '../workspace_svg.js';
+import { Coordinate } from '../utils/coordinate.js';
+import { Rect } from '../utils/rect.js';
+import { Size } from '../utils/size.js';
+import { IBoundedElement } from '../interfaces/i_bounded_element.js';
+import { IRenderedElement } from '../interfaces/i_rendered_element.js';
+export declare class RenderedWorkspaceComment extends WorkspaceComment implements IBoundedElement, IRenderedElement {
+    /** The class encompassing the svg elements making up the workspace comment. */
+    private view;
+    /** Constructs the workspace comment, including the view. */
+    constructor(workspace: WorkspaceSvg, id?: string);
+    /**
+     * Adds listeners to the view that updates the model (i.e. the superclass)
+     * when changes are made to the view.
+     */
+    private addModelUpdateBindings;
+    /** Sets the text of the comment. */
+    setText(text: string): void;
+    /** Sets the size of the comment. */
+    setSize(size: Size): void;
+    /** Sets whether the comment is collapsed or not. */
+    setCollapsed(collapsed: boolean): void;
+    /** Sets whether the comment is editable or not. */
+    setEditable(editable: boolean): void;
+    /** Returns the root SVG element of this comment. */
+    getSvgRoot(): SVGElement;
+    /** Returns the bounding rectangle of this comment in workspace coordinates. */
+    getBoundingRectangle(): Rect;
+    /** Move the comment by the given amounts in workspace coordinates. */
+    moveBy(dx: number, dy: number, _reason?: string[] | undefined): void;
+    /** Moves the comment to the given location in workspace coordinates. */
+    moveTo(location: Coordinate): void;
+    /** Disposes of the view. */
+    dispose(): void;
+}
+//# sourceMappingURL=rendered_workspace_comment.d.ts.map

package/core/comments/workspace_comment.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Workspace } from '../workspace.js';
+import { Size } from '../utils/size.js';
+import { Coordinate } from '../utils/coordinate.js';
+export declare class WorkspaceComment {
+    protected readonly workspace: Workspace;
+    /** The unique identifier for this comment. */
+    readonly id: string;
+    /** The text of the comment. */
+    private text;
+    /** The size of the comment in workspace units. */
+    private size;
+    /** Whether the comment is collapsed or not. */
+    private collapsed;
+    /** Whether the comment is editable or not. */
+    private editable;
+    /** Whether the comment is movable or not. */
+    private movable;
+    /** Whether the comment is deletable or not. */
+    private deletable;
+    /** The location of the comment in workspace coordinates. */
+    private location;
+    /** Whether this comment has been disposed or not. */
+    protected disposed: boolean;
+    /** Whether this comment is being disposed or not. */
+    protected disposing: boolean;
+    /**
+     * Constructs the comment.
+     *
+     * @param workspace The workspace to construct the comment in.
+     * @param id An optional ID to give to the comment. If not provided, one will
+     *     be generated.
+     */
+    constructor(workspace: Workspace, id?: string);
+    /** Sets the text of the comment. */
+    setText(text: string): void;
+    /** Returns the text of the comment. */
+    getText(): string;
+    /** Sets the comment's size in workspace units. */
+    setSize(size: Size): void;
+    /** Returns the comment's size in workspace units. */
+    getSize(): Size;
+    /** Sets whether the comment is collapsed or not. */
+    setCollapsed(collapsed: boolean): void;
+    /** Returns whether the comment is collapsed or not. */
+    isCollapsed(): boolean;
+    /** Sets whether the comment is editable or not. */
+    setEditable(editable: boolean): void;
+    /**
+     * Returns whether the comment is editable or not, respecting whether the
+     * workspace is read-only.
+     */
+    isEditable(): boolean;
+    /**
+     * Returns whether the comment is editable or not, only examining its own
+     * state and ignoring the state of the workspace.
+     */
+    isOwnEditable(): boolean;
+    /** Sets whether the comment is movable or not. */
+    setMovable(movable: boolean): void;
+    /**
+     * Returns whether the comment is movable or not, respecting whether the
+     * workspace is read-only.
+     */
+    isMovable(): boolean;
+    /**
+     * Returns whether the comment is movable or not, only examining its own
+     * state and ignoring the state of the workspace.
+     */
+    isOwnMovable(): boolean;
+    /** Sets whether the comment is deletable or not. */
+    setDeletable(deletable: boolean): void;
+    /**
+     * Returns whether the comment is deletable or not, respecting whether the
+     * workspace is read-only.
+     */
+    isDeletable(): boolean;
+    /**
+     * Returns whether the comment is deletable or not, only examining its own
+     * state and ignoring the state of the workspace.
+     */
+    isOwnDeletable(): boolean;
+    /** Moves the comment to the given location in workspace coordinates. */
+    moveTo(location: Coordinate): void;
+    /** Returns the position of the comment in workspace coordinates. */
+    getRelativeToSurfaceXY(): Coordinate;
+    /** Disposes of this comment. */
+    dispose(): void;
+    /** Returns whether the comment has been disposed or not. */
+    isDisposed(): boolean;
+    /**
+     * Returns true if this comment view is currently being disposed or has
+     * already been disposed.
+     */
+    isDeadOrDying(): boolean;
+}
+//# sourceMappingURL=workspace_comment.d.ts.map