blockly 11.0.0-beta.0 → 11.0.0-beta.10

package/core/interfaces/i_parameter_model.d.ts

@@ -3,6 +3,7 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { ParameterState } from '../serialization/procedures';
 import { IProcedureModel } from './i_procedure_model';
 /**
  * A data model for a procedure.
@@ -33,5 +34,11 @@ export interface IParameterModel {
     getId(): string;
     /** Sets the procedure model this parameter is associated with. */
     setProcedureModel(model: IProcedureModel): this;
+    /**
+     * Serializes the state of the parameter to JSON.
+     *
+     * @returns JSON serializable state of the parameter.
+     */
+    saveState(): ParameterState;
 }
 //# sourceMappingURL=i_parameter_model.d.ts.map

package/core/interfaces/i_procedure_model.d.ts

@@ -3,6 +3,7 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { State } from '../serialization/procedures.js';
 import { IParameterModel } from './i_parameter_model.js';
 /**
  * A data model for a procedure.
@@ -48,5 +49,11 @@ export interface IProcedureModel {
      * disabled, all procedure caller blocks should be disabled as well.
      */
     getEnabled(): boolean;
+    /**
+     * Serializes the state of the procedure to JSON.
+     *
+     * @returns JSON serializable state of the procedure.
+     */
+    saveState(): State;
 }
 //# sourceMappingURL=i_procedure_model.d.ts.map

package/core/interfaces/i_selectable.d.ts

@@ -3,16 +3,18 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { IDeletable } from './i_deletable.js';
-import type { IMovable } from './i_movable.js';
+import type { Workspace } from '../workspace.js';
 /**
  * The interface for an object that is selectable.
  */
-export interface ISelectable extends IDeletable, IMovable {
+export interface ISelectable {
     id: string;
+    workspace: Workspace;
     /** Select this.  Highlight it visually. */
     select(): void;
     /** Unselect this.  Unhighlight it visually. */
     unselect(): void;
 }
+/** Checks whether the given object is an ISelectable. */
+export declare function isSelectable(obj: Object): obj is ISelectable;
 //# sourceMappingURL=i_selectable.d.ts.map

package/core/internal_constants.d.ts

@@ -9,13 +9,6 @@
  * @internal
  */
 export declare const COLLAPSE_CHARS = 30;
-/**
- * When dragging a block out of a stack, split the stack in two (true), or drag
- * out the block healing the stack (false).
- *
- * @internal
- */
-export declare const DRAG_STACK = true;
 /**
  * Lookup table for determining the opposite type of a connection.
  *

package/core/keyboard_nav/ast_node.d.ts

@@ -16,6 +16,7 @@ import type { Input } from '../inputs/input.js';
 import type { IASTNodeLocation } from '../interfaces/i_ast_node_location.js';
 import { Coordinate } from '../utils/coordinate.js';
 import type { Workspace } from '../workspace.js';
+import { FlyoutButton } from '../flyout_button.js';
 /**
  * Class for an AST node.
  * It is recommended that you use one of the createNode methods instead of
@@ -119,6 +120,13 @@ export declare class ASTNode {
      *     on the workspace.
      */
     private navigateBetweenStacks;
+    /**
+     * Navigate between buttons and stacks of blocks on the flyout workspace.
+     *
+     * @param forward True to go forward. False to go backwards.
+     * @returns The next button, or next stack's first block, or null
+     */
+    private navigateFlyoutContents;
     /**
      * Finds the top most AST node for a given block.
      * This is either the previous connection, output connection or block
@@ -150,7 +158,7 @@ export declare class ASTNode {
      * Finds the source block of the location of this node.
      *
      * @returns The source block of the location, or null if the node is of type
-     *     workspace.
+     *     workspace or button.
      */
     getSourceBlock(): Block | null;
     /**
@@ -232,6 +240,16 @@ export declare class ASTNode {
      *     stack.
      */
     static createStackNode(topBlock: Block): ASTNode | null;
+    /**
+     * Create an AST node of type button. A button in this case refers
+     * specifically to a button in a flyout.
+     *
+     * @param button A top block has no parent and can be found in the list
+     *     returned by workspace.getTopBlocks().
+     * @returns An AST node of type stack that points to the top block on the
+     *     stack.
+     */
+    static createButtonNode(button: FlyoutButton): ASTNode | null;
     /**
      * Creates an AST node pointing to a workspace.
      *
@@ -262,7 +280,8 @@ export declare namespace ASTNode {
         NEXT = "next",
         PREVIOUS = "previous",
         STACK = "stack",
-        WORKSPACE = "workspace"
+        WORKSPACE = "workspace",
+        BUTTON = "button"
     }
 }
 export type Params = ASTNode.Params;

package/core/options.d.ts

@@ -32,6 +32,7 @@ export declare class Options {
     pathToMedia: string;
     hasCategories: boolean;
     moveOptions: MoveOptions;
+    /** @deprecated  January 2019 */
     hasScrollbars: boolean;
     hasTrashcan: boolean;
     maxTrashcanContents: number;

package/core/registry.d.ts

@@ -5,7 +5,6 @@
  */
 import type { Abstract } from './events/events_abstract.js';
 import type { Field } from './field.js';
-import type { IBlockDragger } from './interfaces/i_block_dragger.js';
 import type { IConnectionChecker } from './interfaces/i_connection_checker.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { IMetricsManager } from './interfaces/i_metrics_manager.js';
@@ -18,8 +17,10 @@ import type { Options } from './options.js';
 import type { Renderer } from './renderers/common/renderer.js';
 import type { Theme } from './theme.js';
 import type { ToolboxItem } from './toolbox/toolbox_item.js';
-import { IPaster } from './interfaces/i_paster.js';
-import { ICopyable } from './interfaces/i_copyable.js';
+import type { IPaster } from './interfaces/i_paster.js';
+import type { ICopyable } from './interfaces/i_copyable.js';
+import type { IConnectionPreviewer } from './interfaces/i_connection_previewer.js';
+import type { IDragger } from './interfaces/i_dragger.js';
 export declare const TEST_ONLY: {
     typeMap: {
         [key: string]: {
@@ -45,6 +46,7 @@ export declare class Type<_T> {
      */
     toString(): string;
     static CONNECTION_CHECKER: Type<IConnectionChecker>;
+    static CONNECTION_PREVIEWER: Type<IConnectionPreviewer>;
     static CURSOR: Type<Cursor>;
     static EVENT: Type<Abstract>;
     static FIELD: Type<Field<any>>;
@@ -56,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 BLOCK_DRAGGER: Type<IBlockDragger>;
+    /**
+     * 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/render_management.d.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { BlockSvg } from './block_svg.js';
+import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Registers that the given block and all of its parents need to be rerendered,
  * and registers a callback to do so after a delay, to allowf or batching.
@@ -25,7 +26,9 @@ export declare function finishQueuedRenders(): Promise<void>;
  * cases where queueing renders breaks functionality + backwards compatibility
  * (such as rendering icons).
  *
+ * @param workspace If provided, only rerender blocks in this workspace.
+ *
  * @internal
  */
-export declare function triggerQueuedRenders(): void;
+export declare function triggerQueuedRenders(workspace?: WorkspaceSvg): void;
 //# sourceMappingURL=render_management.d.ts.map

package/core/rendered_connection.d.ts

@@ -21,7 +21,7 @@ export declare class RenderedConnection extends Connection {
     private readonly dbOpposite;
     private readonly offsetInBlock;
     private trackedState;
-    private highlightPath;
+    private highlighted;
     /** Connection this connection connects to.  Null if not connected. */
     targetConnection: RenderedConnection | null;
     /**
@@ -130,6 +130,8 @@ export declare class RenderedConnection extends Connection {
     highlight(): void;
     /** Remove the highlighting around this connection. */
     unhighlight(): void;
+    /** Returns true if this connection is highlighted, false otherwise. */
+    isHighlighted(): boolean;
     /**
      * Set whether this connections is tracked in the database or not.
      *

package/core/renderers/common/constants.d.ts

@@ -39,8 +39,8 @@ export interface PuzzleTab {
     type: number;
     width: number;
     height: number;
-    pathDown: string | ((p1: number) => string);
-    pathUp: string | ((p1: number) => string);
+    pathDown: string;
+    pathUp: string;
 }
 /**
  * An object containing sizing and path information about collapsed block
@@ -78,6 +78,10 @@ export type Shape = BaseShape | DynamicShape;
  * @returns Whether the shape is a dynamic shape or not.
  */
 export declare function isDynamicShape(shape: Shape): shape is DynamicShape;
+/** Returns whether the shape is a puzzle tab or not. */
+export declare function isPuzzleTab(shape: Shape): shape is PuzzleTab;
+/** Returns whether the shape is a notch or not. */
+export declare function isNotch(shape: Shape): shape is Notch;
 /**
  * An object that provides constants for rendering blocks.
  */

package/core/renderers/common/drawer.d.ts

@@ -5,6 +5,7 @@
  */
 import type { BlockSvg } from '../../block_svg.js';
 import { Coordinate } from '../../utils.js';
+import { Connection } from '../measurables/connection.js';
 import type { Field } from '../measurables/field.js';
 import type { Icon } from '../measurables/icon.js';
 import type { InlineInput } from '../measurables/inline_input.js';
@@ -37,13 +38,6 @@ export declare class Drawer {
      * required.
      */
     draw(): void;
-    /**
-     * Hide icons that were marked as hidden.
-     *
-     * @deprecated Manually hiding icons is no longer necessary. To be removed
-     *     in v11.
-     */
-    protected hideHiddenIcons_(): void;
     /**
      * Save sizing information back to the block
      * Most of the rendering information can be thrown away at the end of the
@@ -141,5 +135,22 @@ export declare class Drawer {
     protected positionNextConnection_(): void;
     /** Position the output connection on a block. */
     protected positionOutputConnection_(): void;
+    /**
+     * Updates the path object to reflect which connections on the block are
+     * highlighted.
+     */
+    protected updateConnectionHighlights(): void;
+    /** Returns a path to highlight the given connection. */
+    drawConnectionHighlightPath(measurable: Connection): void;
+    /**
+     * Returns a path to highlight the given conneciton, assuming it is an
+     * input or output connection.
+     */
+    private getExpressionConnectionHighlightPath;
+    /**
+     * Returns a path to highlight the given conneciton, assuming it is a
+     * next or previous connection.
+     */
+    private getStatementConnectionHighlightPath;
 }
 //# sourceMappingURL=drawer.d.ts.map

package/core/renderers/common/i_path_object.d.ts

@@ -6,7 +6,8 @@
 import type { BlockStyle } from '../../theme.js';
 import type { BlockSvg } from '../../block_svg.js';
 import type { ConstantProvider } from './constants.js';
-import { RenderedConnection } from '../../rendered_connection.js';
+import type { RenderedConnection } from '../../rendered_connection.js';
+import type { Coordinate } from '../../utils/coordinate.js';
 /**
  * An interface for a block's path object.
  *
@@ -101,21 +102,11 @@ export interface IPathObject {
      * @param enable True if the block is movable, false otherwise.
      */
     updateMovable(enabled: boolean): void;
+    /** Adds the given path as a connection highlight for the given connection. */
+    addConnectionHighlight?(connection: RenderedConnection, connectionPath: string, offset: Coordinate, rtl: boolean): void;
     /**
-     * Add or remove styling that shows that if the dragging block is dropped,
-     * this block will be replaced.  If a shadow block, it will disappear.
-     * Otherwise it will bump.
-     *
-     * @param enable True if styling should be added.
-     */
-    updateReplacementFade(enabled: boolean): void;
-    /**
-     * Add or remove styling that shows that if the dragging block is dropped,
-     * this block will be connected to the input.
-     *
-     * @param conn The connection on the input to highlight.
-     * @param enable True if styling should be added.
+     * Removes any highlight associated with the given connection, if it exists.
      */
-    updateShapeForInputHighlight(conn: RenderedConnection, enable: boolean): void;
+    removeConnectionHighlight?(connection: RenderedConnection): void;
 }
 //# sourceMappingURL=i_path_object.d.ts.map

package/core/renderers/common/info.d.ts

@@ -5,6 +5,7 @@
  */
 import type { BlockSvg } from '../../block_svg.js';
 import { Input } from '../../inputs/input.js';
+import type { RenderedConnection } from '../../rendered_connection.js';
 import type { Measurable } from '../measurables/base.js';
 import { BottomRow } from '../measurables/bottom_row.js';
 import { InputRow } from '../measurables/input_row.js';
@@ -14,6 +15,7 @@ import { SpacerRow } from '../measurables/spacer_row.js';
 import { TopRow } from '../measurables/top_row.js';
 import type { ConstantProvider } from './constants.js';
 import type { Renderer } from './renderer.js';
+import { Connection } from '../measurables/connection.js';
 /**
  * An object containing all sizing information needed to draw this block.
  *
@@ -61,8 +63,7 @@ export declare class RenderInfo {
      */
     getRenderer(): Renderer;
     /**
-     * Populate and return an object containing all sizing information needed to
-     * draw this block.
+     * Populate this object with all sizing information needed to draw the block.
      *
      * This measure pass does not propagate changes to the block (although fields
      * may choose to rerender when getSize() is called).  However, calling it
@@ -194,5 +195,7 @@ export declare class RenderInfo {
      * store the y position of each row, and record the height of the full block.
      */
     protected finalize_(): void;
+    /** Returns the connection measurable associated with the given connection. */
+    getMeasureableForConnection(conn: RenderedConnection): Connection | null;
 }
 //# sourceMappingURL=info.d.ts.map

package/core/renderers/common/marker_svg.d.ts

@@ -148,6 +148,13 @@ export declare class MarkerSvg {
      * @param curNode The node to draw the marker for.
      */
     protected showWithStack_(curNode: ASTNode): void;
+    /**
+     * Position and display the marker for a flyout button.
+     * This is a box with extra padding around the button.
+     *
+     * @param curNode The node to draw the marker for.
+     */
+    protected showWithButton_(curNode: ASTNode): void;
     /** Show the current marker. */
     protected showCurrent_(): void;
     /**************************

package/core/renderers/common/path_object.d.ts

@@ -5,7 +5,9 @@
  */
 import type { BlockSvg } from '../../block_svg.js';
 import type { Connection } from '../../connection.js';
+import { RenderedConnection } from '../../rendered_connection.js';
 import type { BlockStyle } from '../../theme.js';
+import { Coordinate } from '../../utils/coordinate.js';
 import type { ConstantProvider } from './constants.js';
 import type { IPathObject } from './i_path_object.js';
 /**
@@ -27,6 +29,10 @@ export declare class PathObject implements IPathObject {
     markerSvg: SVGElement | null;
     constants: ConstantProvider;
     style: BlockStyle;
+    /** Highlight paths associated with connections. */
+    private connectionHighlights;
+    /** Locations of connection highlights. */
+    private highlightOffsets;
     /**
      * @param root The root SVG element.
      * @param style The style object to use for colouring.
@@ -138,5 +144,12 @@ export declare class PathObject implements IPathObject {
      * @param _enable True if styling should be added.
      */
     updateShapeForInputHighlight(_conn: Connection, _enable: boolean): void;
+    /** Adds the given path as a connection highlight for the given connection. */
+    addConnectionHighlight(connection: RenderedConnection, connectionPath: string, offset: Coordinate, rtl: boolean): void;
+    private currentHighlightMatchesNew;
+    /**
+     * Removes any highlight associated with the given connection, if it exists.
+     */
+    removeConnectionHighlight(connection: RenderedConnection): void;
 }
 //# sourceMappingURL=path_object.d.ts.map

package/core/renderers/common/renderer.d.ts

@@ -141,6 +141,9 @@ export declare class Renderer implements IRegistrable {
      * @param local The connection currently being dragged.
      * @param topBlock The block currently being dragged.
      * @returns The preview type to display.
+     *
+     * @deprecated v10 - This function is no longer respected. A custom
+     *    IConnectionPreviewer may be able to fulfill the functionality.
      */
     getConnectionPreviewMethod(closest: RenderedConnection, local: RenderedConnection, topBlock: BlockSvg): PreviewType;
     /**

package/core/renderers/measurables/connection.d.ts

@@ -14,6 +14,7 @@ export declare class Connection extends Measurable {
     connectionModel: RenderedConnection;
     shape: Shape;
     isDynamicShape: boolean;
+    highlighted: boolean;
     /**
      * @param constants The rendering constants provider.
      * @param connectionModel The connection object on the block that this

package/core/renderers/measurables/icon.d.ts

@@ -12,11 +12,6 @@ import { Measurable } from './base.js';
  */
 export declare class Icon extends Measurable {
     icon: BlocklyIcon;
-    /**
-     * @deprecated Will be removed in v11. Create a subclass of the Icon
-     *     measurable if this data is necessary for you.
-     */
-    isVisible: boolean;
     flipRtl: boolean;
     /**
      * An object containing information about the space an icon takes up during

package/core/renderers/zelos/drawer.d.ts

@@ -5,6 +5,7 @@
  */
 import type { BlockSvg } from '../../block_svg.js';
 import { Drawer as BaseDrawer } from '../common/drawer.js';
+import { Connection } from '../measurables/connection.js';
 import type { InlineInput } from '../measurables/inline_input.js';
 import type { Row } from '../measurables/row.js';
 import type { RenderInfo } from './info.js';
@@ -42,6 +43,9 @@ export declare class Drawer extends BaseDrawer {
     /** Add steps to draw a flat bottom row. */
     protected drawFlatBottom_(): void;
     drawInlineInput_(input: InlineInput): void;
+    private getInlineInputPath;
     drawStatementInput_(row: Row): void;
+    /** Returns a path to highlight the given connection. */
+    drawConnectionHighlightPath(measurable: Connection): void;
 }
 //# sourceMappingURL=drawer.d.ts.map

package/core/renderers/zelos/renderer.d.ts

@@ -4,7 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockSvg } from '../../block_svg.js';
-import type { Connection } from '../../connection.js';
 import { InsertionMarkerManager } from '../../insertion_marker_manager.js';
 import type { Marker } from '../../keyboard_nav/marker.js';
 import type { RenderedConnection } from '../../rendered_connection.js';
@@ -74,7 +73,10 @@ export declare class Renderer extends BaseRenderer {
      * @returns The constant provider.
      */
     getConstants(): ConstantProvider;
-    shouldHighlightConnection(conn: Connection): boolean;
+    /**
+     * @deprecated v10 - This function is no longer respected. A custom
+     *    IConnectionPreviewer may be able to fulfill the functionality.
+     */
     getConnectionPreviewMethod(closest: RenderedConnection, local: RenderedConnection, topBlock: BlockSvg): InsertionMarkerManager.PREVIEW_TYPE;
 }
 //# sourceMappingURL=renderer.d.ts.map

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/priorities.d.ts

@@ -15,4 +15,6 @@ export declare const PROCEDURES = 75;
  * The priority for deserializing blocks.
  */
 export declare const BLOCKS = 50;
+/** The priority for deserializing workspace comments. */
+export declare const WORKSPACE_COMMENTS = 25;
 //# sourceMappingURL=priorities.d.ts.map

package/core/serialization/procedures.d.ts

@@ -7,63 +7,65 @@ import { IParameterModel } from '../interfaces/i_parameter_model.js';
 import { IProcedureModel } from '../interfaces/i_procedure_model.js';
 import type { ISerializer } from '../interfaces/i_serializer.js';
 import type { Workspace } from '../workspace.js';
-/**
- * Representation of a procedure data model.
- */
+/** Represents the state of a procedure model. */
 export interface State {
     id: string;
     name: string;
     returnTypes: string[] | null;
     parameters?: ParameterState[];
+    [key: string]: unknown;
 }
-/**
- * Representation of a parameter data model.
- */
+/** Represents the state of a parameter model. */
 export interface ParameterState {
     id: string;
     name: string;
     types?: string[];
+    [key: string]: unknown;
 }
 /**
  * A newable signature for an IProcedureModel.
  *
  * Refer to
- * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
+ * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes
  * for what is going on with this.
  */
-type ProcedureModelConstructor<ProcedureModel extends IProcedureModel> = new (workspace: Workspace, name: string, id: string) => ProcedureModel;
+interface ProcedureModelConstructor<ProcedureModel extends IProcedureModel> {
+    new (workspace: Workspace, name: string, id: string): ProcedureModel;
+    /**
+     * Deserializes the JSON state and returns a procedure model.
+     *
+     * @param state The state to deserialize.
+     * @param workspace The workspace to load the procedure model into.
+     * @returns The constructed procedure model.
+     */
+    loadState(state: Object, workspace: Workspace): ProcedureModel;
+}
 /**
  * A newable signature for an IParameterModel.
  *
  * Refer to
- * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
+ * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes
  * for what is going on with this.
  */
-type ParameterModelConstructor<ParameterModel extends IParameterModel> = new (workspace: Workspace, name: string, id: string) => ParameterModel;
+interface ParameterModelConstructor<ParameterModel extends IParameterModel> {
+    new (workspace: Workspace, name: string, id: string): ParameterModel;
+    /**
+     * Deserializes the JSON state and returns a parameter model.
+     *
+     * @param state The state to deserialize.
+     * @param workspace The workspace to load the parameter model into.
+     * @returns The constructed parameter model.
+     */
+    loadState(state: Object, workspace: Workspace): ParameterModel;
+}
 /**
  * Serializes the given IProcedureModel to JSON.
- *
- * @internal
  */
 export declare function saveProcedure(proc: IProcedureModel): State;
-/**
- * Serializes the given IParameterModel to JSON.
- *
- * @internal
- */
-export declare function saveParameter(param: IParameterModel): ParameterState;
 /**
  * Deserializes the given procedure model State from JSON.
- *
- * @internal
  */
 export declare function loadProcedure<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel>(procedureModelClass: ProcedureModelConstructor<ProcedureModel>, parameterModelClass: ParameterModelConstructor<ParameterModel>, state: State, workspace: Workspace): ProcedureModel;
-/**
- * Deserializes the given ParameterState from JSON.
- *
- * @internal
- */
-export declare function loadParameter<ParameterModel extends IParameterModel>(parameterModelClass: ParameterModelConstructor<ParameterModel>, state: ParameterState, workspace: Workspace): ParameterModel;
 /** Serializer for saving and loading procedure state. */
 export declare class ProcedureSerializer<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel> implements ISerializer {
     private readonly procedureModelClass;

package/core/serialization/workspace_comments.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ISerializer } from '../interfaces/i_serializer.js';
+import { Workspace } from '../workspace.js';
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
+export interface State {
+    id?: string;
+    text?: string;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    collapsed?: boolean;
+    editable?: boolean;
+    movable?: boolean;
+    deletable?: boolean;
+}
+/** Serializes the state of the given comment to JSON. */
+export declare function save(comment: WorkspaceComment, { addCoordinates, saveIds, }?: {
+    addCoordinates?: boolean;
+    saveIds?: boolean;
+}): State;
+/** Appends the comment defined by the given state to the given workspace. */
+export declare function append(state: State, workspace: Workspace, { recordUndo }?: {
+    recordUndo?: boolean;
+}): WorkspaceComment;
+/** Serializer for saving and loading workspace comment state. */
+export declare class WorkspaceCommentSerializer implements ISerializer {
+    priority: number;
+    /**
+     * Returns the state of all workspace comments in the given workspace.
+     */
+    save(workspace: Workspace): State[] | null;
+    /**
+     * Deserializes the comments defined by the given state into the given
+     * workspace.
+     */
+    load(state: State[], workspace: Workspace): void;
+    /** Disposes of any comments that exist on the given workspace. */
+    clear(workspace: Workspace): void;
+}
+//# sourceMappingURL=workspace_comments.d.ts.map

package/core/serialization.d.ts

@@ -13,6 +13,7 @@ import * as procedures from './serialization/procedures.js';
 import * as registry from './serialization/registry.js';
 import * as variables from './serialization/variables.js';
 import * as workspaces from './serialization/workspaces.js';
+import * as workspaceComments from './serialization/workspace_comments.js';
 import { ISerializer } from './interfaces/i_serializer.js';
-export { blocks, exceptions, priorities, procedures, registry, variables, workspaces, ISerializer, };
+export { blocks, exceptions, priorities, procedures, registry, variables, workspaces, workspaceComments, ISerializer, };
 //# sourceMappingURL=serialization.d.ts.map