blockly 11.2.0 → 12.0.0-beta.1

package/core/block.d.ts

@@ -20,10 +20,10 @@ import type { MutatorIcon } from './icons/mutator_icon.js';
 import { Input } from './inputs/input.js';
 import type { IASTNodeLocation } from './interfaces/i_ast_node_location.js';
 import { type IIcon } from './interfaces/i_icon.js';
+import type { IVariableModel, IVariableState } from './interfaces/i_variable_model.js';
 import * as Tooltip from './tooltip.js';
 import { Coordinate } from './utils/coordinate.js';
 import { Size } from './utils/size.js';
-import type { VariableModel } from './variable_model.js';
 import type { Workspace } from './workspace.js';
 /**
  * Class for one block.
@@ -540,6 +540,12 @@ export declare class Block implements IASTNodeLocation {
      * @returns Named field, or null if field does not exist.
      */
     getField(name: string): Field | null;
+    /**
+     * Returns a generator that provides every field on the block.
+     *
+     * @yields A generator that can be used to iterate the fields on the block.
+     */
+    getFields(): Generator<Field>;
     /**
      * Return all variables referenced by this block.
      *
@@ -552,7 +558,7 @@ export declare class Block implements IASTNodeLocation {
      * @returns List of variable models.
      * @internal
      */
-    getVarModels(): VariableModel[];
+    getVarModels(): IVariableModel<IVariableState>[];
     /**
      * Notification that a variable is renaming but keeping the same ID.  If the
      * variable is in use on this block, rerender to show the new name.
@@ -560,7 +566,7 @@ export declare class Block implements IASTNodeLocation {
      * @param variable The variable being renamed.
      * @internal
      */
-    updateVarName(variable: VariableModel): void;
+    updateVarName(variable: IVariableModel<IVariableState>): void;
     /**
      * Notification that a variable is renaming.
      * If the ID matches one of this block's variables, rename it.
@@ -641,9 +647,8 @@ export declare class Block implements IASTNodeLocation {
      * @returns True if enabled.
      */
     isEnabled(): boolean;
-    /** @deprecated v11 - Get whether the block is manually disabled. */
+    /** @deprecated v11 - Get or sets 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.
@@ -999,7 +1004,7 @@ export declare class Block implements IASTNodeLocation {
      *
      * Intended to on be used in console logs and errors. If you need a string
      * that uses the user's native language (including block text, field values,
-     * and child blocks), use [toString()]{@link Block#toString}.
+     * and child blocks), use {@link (Block:class).toString | toString()}.
      *
      * @returns The description.
      */

package/core/block_flyout_inflater.d.ts

@@ -0,0 +1,95 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BlockSvg } from './block_svg.js';
+import * as browserEvents from './browser_events.js';
+import { FlyoutItem } from './flyout_item.js';
+import type { IFlyout } from './interfaces/i_flyout.js';
+import type { IFlyoutInflater } from './interfaces/i_flyout_inflater.js';
+import type { BlockInfo } from './utils/toolbox.js';
+import type { WorkspaceSvg } from './workspace_svg.js';
+/**
+ * Class responsible for creating blocks for flyouts.
+ */
+export declare class BlockFlyoutInflater implements IFlyoutInflater {
+    protected permanentlyDisabledBlocks: Set<BlockSvg>;
+    protected listeners: Map<string, browserEvents.Data[]>;
+    protected flyoutWorkspace?: WorkspaceSvg;
+    protected flyout?: IFlyout;
+    private capacityWrapper;
+    /**
+     * Creates a new BlockFlyoutInflater instance.
+     */
+    constructor();
+    /**
+     * Inflates a flyout block from the given state and adds it to the flyout.
+     *
+     * @param state A JSON representation of a flyout block.
+     * @param flyoutWorkspace The workspace to create the block on.
+     * @returns A newly created block.
+     */
+    load(state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
+    /**
+     * Creates a block on the given workspace.
+     *
+     * @param blockDefinition A JSON representation of the block to create.
+     * @param workspace The workspace to create the block on.
+     * @returns The newly created block.
+     */
+    createBlock(blockDefinition: BlockInfo, workspace: WorkspaceSvg): BlockSvg;
+    /**
+     * Returns the amount of space that should follow this block.
+     *
+     * @param state A JSON representation of a flyout block.
+     * @param defaultGap The default spacing for flyout items.
+     * @returns The amount of space that should follow this block.
+     */
+    gapForItem(state: object, defaultGap: number): number;
+    /**
+     * Disposes of the given block.
+     *
+     * @param item The flyout block to dispose of.
+     */
+    disposeItem(item: FlyoutItem): void;
+    /**
+     * Removes event listeners for the block with the given ID.
+     *
+     * @param blockId The ID of the block to remove event listeners from.
+     */
+    protected removeListeners(blockId: string): void;
+    /**
+     * Updates this inflater's flyout workspace.
+     *
+     * @param workspace The workspace of the flyout that owns this inflater.
+     */
+    protected setFlyoutWorkspace(workspace: WorkspaceSvg): void;
+    /**
+     * Updates the enabled state of the given block based on the capacity of the
+     * workspace.
+     *
+     * @param block The block to update the enabled/disabled state of.
+     */
+    private updateStateBasedOnCapacity;
+    /**
+     * Add listeners to a block that has been added to the flyout.
+     *
+     * @param block The block to add listeners for.
+     */
+    protected addBlockListeners(block: BlockSvg): void;
+    /**
+     * Updates the state of blocks in our owning flyout to be disabled/enabled
+     * based on the capacity of the workspace for more blocks of that type.
+     *
+     * @param event The event that triggered this update.
+     */
+    private filterFlyoutBasedOnCapacity;
+    /**
+     * Returns the type of items this inflater is responsible for creating.
+     *
+     * @returns An identifier for the type of items this inflater creates.
+     */
+    getType(): string;
+}
+//# sourceMappingURL=block_flyout_inflater.d.ts.map

package/core/block_svg.d.ts

@@ -132,13 +132,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      *
      * @returns #RRGGBB string.
      */
-    getColourSecondary(): string | undefined;
+    getColourSecondary(): string;
     /**
      * Get the tertiary colour of a block.
      *
      * @returns #RRGGBB string.
      */
-    getColourTertiary(): string | undefined;
+    getColourTertiary(): string;
     /** Selects this block. Highlights the block visually. */
     select(): void;
     /** Unselects this block. Unhighlights the block visually. */
@@ -275,6 +275,18 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     private updateConnectionLocations;
     private updateIconLocations;
     private updateFieldLocations;
+    /**
+     * Add a CSS class to the SVG group of this block.
+     *
+     * @param className
+     */
+    addClass(className: string): void;
+    /**
+     * Remove a CSS class from the SVG group of this block.
+     *
+     * @param className
+     */
+    removeClass(className: string): void;
     /**
      * Recursively adds or removes the dragging class to this node and its
      * children.
@@ -406,6 +418,11 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      *     update whether the block is currently disabled for this reason.
      */
     setDisabledReason(disabled: boolean, reason: string): void;
+    /**
+     * Add blocklyNotDeletable class when block is not deletable
+     * Or remove class when block is deletable
+     */
+    setDeletable(deletable: boolean): void;
     /**
      * Set whether the block is highlighted or not.  Block highlighting is
      * often used to visually mark blocks currently being executed.
@@ -453,6 +470,12 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @throws {Error} if the block style does not exist.
      */
     setStyle(blockStyleName: string): void;
+    /**
+     * Returns the BlockStyle object used to style this block.
+     *
+     * @returns This block's style object.
+     */
+    getStyle(): BlockStyle;
     /**
      * Move this block to the front of the visible workspace.
      * <g> tags do not respect z-index so SVG renders them in the
@@ -706,5 +729,6 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Returns a representation of this block that can be displayed in a flyout.
      */
     toFlyoutInfo(): FlyoutItemInfo[];
+    jsonInit(json: any): void;
 }
 //# sourceMappingURL=block_svg.d.ts.map

package/core/blockly.d.ts

@@ -9,12 +9,14 @@ import './events/events_ui_base.js';
 import './events/events_var_create.js';
 import { Block } from './block.js';
 import * as blockAnimations from './block_animations.js';
+import { BlockFlyoutInflater } from './block_flyout_inflater.js';
 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 * as bubbles from './bubbles.js';
 import * as bumpObjects from './bump_objects.js';
+import { ButtonFlyoutInflater } from './button_flyout_inflater.js';
 import * as clipboard from './clipboard.js';
 import * as comments from './comments.js';
 import * as common from './common.js';
@@ -38,7 +40,7 @@ import * as Events from './events/events.js';
 import * as Extensions from './extensions.js';
 import { Field, FieldConfig, FieldValidator, UnattachedFieldError } from './field.js';
 import { FieldCheckbox, FieldCheckboxConfig, FieldCheckboxFromJsonConfig, FieldCheckboxValidator } from './field_checkbox.js';
-import { FieldDropdown, FieldDropdownConfig, FieldDropdownFromJsonConfig, FieldDropdownValidator, MenuGenerator, MenuGeneratorFunction, MenuOption } from './field_dropdown.js';
+import { FieldDropdown, FieldDropdownConfig, FieldDropdownFromJsonConfig, FieldDropdownValidator, ImageProperties, 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';
@@ -49,7 +51,9 @@ import { FieldVariable, FieldVariableConfig, FieldVariableFromJsonConfig, FieldV
 import { Flyout } from './flyout_base.js';
 import { FlyoutButton } from './flyout_button.js';
 import { HorizontalFlyout } from './flyout_horizontal.js';
+import { FlyoutItem } from './flyout_item.js';
 import { FlyoutMetricsManager } from './flyout_metrics_manager.js';
+import { FlyoutSeparator } from './flyout_separator.js';
 import { VerticalFlyout } from './flyout_vertical.js';
 import { CodeGenerator } from './generator.js';
 import { Gesture } from './gesture.js';
@@ -57,8 +61,10 @@ import { Grid } from './grid.js';
 import * as icons from './icons.js';
 import { inject } from './inject.js';
 import * as inputs from './inputs.js';
+import { IFlyoutInflater } from './interfaces/i_flyout_inflater.js';
+import { LabelFlyoutInflater } from './label_flyout_inflater.js';
+import { SeparatorFlyoutInflater } from './separator_flyout_inflater.js';
 import { Input } from './inputs/input.js';
-import { InsertionMarkerManager } from './insertion_marker_manager.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';
@@ -95,6 +101,8 @@ import { IStyleable } from './interfaces/i_styleable.js';
 import { IToolbox } from './interfaces/i_toolbox.js';
 import { IToolboxItem } from './interfaces/i_toolbox_item.js';
 import { IVariableBackedParameterModel, isVariableBackedParameterModel } from './interfaces/i_variable_backed_parameter_model.js';
+import { IVariableMap } from './interfaces/i_variable_map.js';
+import { IVariableModel, IVariableState } from './interfaces/i_variable_model.js';
 import { ASTNode } from './keyboard_nav/ast_node.js';
 import { BasicCursor } from './keyboard_nav/basic_cursor.js';
 import { Cursor } from './keyboard_nav/cursor.js';
@@ -264,5 +272,5 @@ export declare const VARIABLE_DYNAMIC_CATEGORY_NAME: string;
 export declare const PROCEDURE_CATEGORY_NAME: string;
 export { ASTNode, BasicCursor, Block, BlockSvg, BlocklyOptions, Blocks, CollapsibleToolboxCategory, ComponentManager, Connection, ConnectionChecker, ConnectionDB, ConnectionType, ContextMenu, ContextMenuItems, ContextMenuRegistry, Css, Cursor, DeleteArea, DragTarget, Events, Extensions, Procedures, ShortcutItems, Themes, Tooltip, Touch, Variables, VariablesDynamic, WidgetDiv, Xml, blockAnimations, blockRendering, browserEvents, bubbles, bumpObjects, clipboard, comments, common, constants, dialog, dragging, fieldRegistry, geras, Procedures as procedures, registry, thrasos, uiPosition, utils, zelos, };
 export declare const DropDownDiv: typeof dropDownDiv;
-export { CodeGenerator, Field, FieldCheckbox, FieldCheckboxConfig, FieldCheckboxFromJsonConfig, FieldCheckboxValidator, FieldConfig, FieldDropdown, FieldDropdownConfig, FieldDropdownFromJsonConfig, FieldDropdownValidator, FieldImage, FieldImageConfig, FieldImageFromJsonConfig, FieldLabel, FieldLabelConfig, FieldLabelFromJsonConfig, FieldLabelSerializable, FieldNumber, FieldNumberConfig, FieldNumberFromJsonConfig, FieldNumberValidator, FieldTextInput, FieldTextInputConfig, FieldTextInputFromJsonConfig, FieldTextInputValidator, FieldValidator, FieldVariable, FieldVariableConfig, FieldVariableFromJsonConfig, FieldVariableValidator, Flyout, FlyoutButton, FlyoutMetricsManager, CodeGenerator as Generator, Gesture, Grid, HorizontalFlyout, IASTNodeLocation, IASTNodeLocationSvg, IASTNodeLocationWithBlock, IAutoHideable, IBoundedElement, IBubble, ICollapsibleToolboxItem, IComponent, IConnectionChecker, IConnectionPreviewer, IContextMenu, ICopyData, ICopyable, IDeletable, IDeleteArea, IDragStrategy, IDragTarget, IDraggable, IDragger, IFlyout, IHasBubble, IIcon, IKeyboardAccessible, IMetricsManager, IMovable, IObservable, IPaster, IPositionable, IRegistrable, IRenderedElement, ISelectable, ISelectableToolboxItem, ISerializable, IStyleable, IToolbox, IToolboxItem, IVariableBackedParameterModel, Input, InsertionMarkerManager, InsertionMarkerPreviewer, LayerManager, Marker, MarkerManager, Menu, MenuGenerator, MenuGeneratorFunction, MenuItem, MenuOption, MetricsManager, Msg, Names, Options, RenderedConnection, Scrollbar, ScrollbarPair, ShortcutRegistry, TabNavigateCursor, Theme, ThemeManager, Toolbox, ToolboxCategory, ToolboxItem, ToolboxSeparator, Trashcan, UnattachedFieldError, VariableMap, VariableModel, VerticalFlyout, Workspace, WorkspaceAudio, WorkspaceDragger, WorkspaceSvg, ZoomControls, config, hasBubble, icons, inject, inputs, isCopyable, isDeletable, isDraggable, isIcon, isObservable, isPaster, isRenderedElement, isSelectable, isSerializable, isVariableBackedParameterModel, layers, renderManagement, serialization, setLocale, };
+export { BlockFlyoutInflater, ButtonFlyoutInflater, CodeGenerator, Field, FieldCheckbox, FieldCheckboxConfig, FieldCheckboxFromJsonConfig, FieldCheckboxValidator, FieldConfig, FieldDropdown, FieldDropdownConfig, FieldDropdownFromJsonConfig, FieldDropdownValidator, FieldImage, FieldImageConfig, FieldImageFromJsonConfig, FieldLabel, FieldLabelConfig, FieldLabelFromJsonConfig, FieldLabelSerializable, FieldNumber, FieldNumberConfig, FieldNumberFromJsonConfig, FieldNumberValidator, FieldTextInput, FieldTextInputConfig, FieldTextInputFromJsonConfig, FieldTextInputValidator, FieldValidator, FieldVariable, FieldVariableConfig, FieldVariableFromJsonConfig, FieldVariableValidator, Flyout, FlyoutButton, FlyoutItem, FlyoutMetricsManager, FlyoutSeparator, CodeGenerator as Generator, Gesture, Grid, HorizontalFlyout, IASTNodeLocation, IASTNodeLocationSvg, IASTNodeLocationWithBlock, IAutoHideable, IBoundedElement, IBubble, ICollapsibleToolboxItem, IComponent, IConnectionChecker, IConnectionPreviewer, IContextMenu, ICopyData, ICopyable, IDeletable, IDeleteArea, IDragStrategy, IDragTarget, IDraggable, IDragger, IFlyout, IFlyoutInflater, IHasBubble, IIcon, IKeyboardAccessible, IMetricsManager, IMovable, IObservable, IPaster, IPositionable, IRegistrable, IRenderedElement, ISelectable, ISelectableToolboxItem, ISerializable, IStyleable, IToolbox, IToolboxItem, IVariableBackedParameterModel, IVariableMap, IVariableModel, IVariableState, ImageProperties, Input, InsertionMarkerPreviewer, LabelFlyoutInflater, LayerManager, Marker, MarkerManager, Menu, MenuGenerator, MenuGeneratorFunction, MenuItem, MenuOption, MetricsManager, Msg, Names, Options, RenderedConnection, Scrollbar, ScrollbarPair, SeparatorFlyoutInflater, ShortcutRegistry, TabNavigateCursor, Theme, ThemeManager, Toolbox, ToolboxCategory, ToolboxItem, ToolboxSeparator, Trashcan, UnattachedFieldError, VariableMap, VariableModel, VerticalFlyout, Workspace, WorkspaceAudio, WorkspaceDragger, WorkspaceSvg, ZoomControls, config, hasBubble, icons, inject, inputs, isCopyable, isDeletable, isDraggable, isIcon, isObservable, isPaster, isRenderedElement, isSelectable, isSerializable, isVariableBackedParameterModel, layers, renderManagement, serialization, setLocale, };
 //# sourceMappingURL=blockly.d.ts.map

package/core/bubbles/textinput_bubble.d.ts

@@ -36,6 +36,8 @@ export declare class TextInputBubble extends Bubble {
     private textChangeListeners;
     /** Functions listening for changes to the size of this bubble. */
     private sizeChangeListeners;
+    /** Functions listening for changes to the location of this bubble. */
+    private locationChangeListeners;
     /** The text of this bubble. */
     private text;
     /** The default size of this bubble, including borders. */
@@ -63,6 +65,8 @@ export declare class TextInputBubble extends Bubble {
     addTextChangeListener(listener: () => void): void;
     /** Adds a change listener to be notified when this bubble's size changes. */
     addSizeChangeListener(listener: () => void): void;
+    /** Adds a change listener to be notified when this bubble's location changes. */
+    addLocationChangeListener(listener: () => void): void;
     /** Creates the editor UI for this bubble. */
     private createEditor;
     /** Binds events to the text area element. */
@@ -80,6 +84,9 @@ export declare class TextInputBubble extends Bubble {
     setSize(size: Size, relayout?: boolean): void;
     /** @returns the size of this bubble. */
     getSize(): Size;
+    moveDuringDrag(newLoc: Coordinate): void;
+    setPositionRelativeToAnchor(left: number, top: number): void;
+    protected positionByRect(rect?: Rect): void;
     /** Handles mouse down events on the resize target. */
     private onResizePointerDown;
     /** Handles pointer up events on the resize target. */
@@ -94,5 +101,7 @@ export declare class TextInputBubble extends Bubble {
     private onTextChange;
     /** Handles a size change event for the text area. Calls event listeners. */
     private onSizeChange;
+    /** Handles a location change event for the text area. Calls event listeners. */
+    private onLocationChange;
 }
 //# sourceMappingURL=textinput_bubble.d.ts.map

package/core/button_flyout_inflater.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { FlyoutItem } from './flyout_item.js';
+import type { IFlyoutInflater } from './interfaces/i_flyout_inflater.js';
+import type { WorkspaceSvg } from './workspace_svg.js';
+/**
+ * Class responsible for creating buttons for flyouts.
+ */
+export declare class ButtonFlyoutInflater implements IFlyoutInflater {
+    /**
+     * Inflates a flyout button from the given state and adds it to the flyout.
+     *
+     * @param state A JSON representation of a flyout button.
+     * @param flyoutWorkspace The workspace to create the button on.
+     * @returns A newly created FlyoutButton.
+     */
+    load(state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
+    /**
+     * Returns the amount of space that should follow this button.
+     *
+     * @param state A JSON representation of a flyout button.
+     * @param defaultGap The default spacing for flyout items.
+     * @returns The amount of space that should follow this button.
+     */
+    gapForItem(state: object, defaultGap: number): number;
+    /**
+     * Disposes of the given button.
+     *
+     * @param item The flyout button to dispose of.
+     */
+    disposeItem(item: FlyoutItem): void;
+    /**
+     * Returns the type of items this inflater is responsible for creating.
+     *
+     * @returns An identifier for the type of items this inflater creates.
+     */
+    getType(): string;
+}
+//# sourceMappingURL=button_flyout_inflater.d.ts.map

package/core/clipboard.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { BlockPaster } from './clipboard/block_paster.js';
+import { BlockCopyData, BlockPaster } from './clipboard/block_paster.js';
 import * as registry from './clipboard/registry.js';
 import type { ICopyData, ICopyable } from './interfaces/i_copyable.js';
 import { Coordinate } from './utils/coordinate.js';
@@ -38,5 +38,5 @@ export declare const TEST_ONLY: {
     duplicateInternal: typeof duplicateInternal;
     copyInternal: typeof copyInternal;
 };
-export { BlockPaster, registry };
+export { BlockCopyData, BlockPaster, registry };
 //# sourceMappingURL=clipboard.d.ts.map

package/core/comments/comment_view.d.ts

@@ -67,6 +67,8 @@ export declare class CommentView implements IRenderedElement {
     private disposed;
     /** Size of this comment when the resize drag was initiated. */
     private preResizeSize?;
+    /** The default size of newly created comments. */
+    static defaultCommentSize: Size;
     constructor(workspace: WorkspaceSvg);
     /**
      * Creates the rect we use for highlighting the comment when it's selected.
@@ -190,6 +192,8 @@ export declare class CommentView implements IRenderedElement {
     getText(): string;
     /** Sets the current text of the comment. */
     setText(text: string): void;
+    /** Sets the placeholder text displayed for an empty comment. */
+    setPlaceholderText(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. */

package/core/comments/rendered_workspace_comment.d.ts

@@ -30,6 +30,8 @@ export declare class RenderedWorkspaceComment extends WorkspaceComment implement
     private addModelUpdateBindings;
     /** Sets the text of the comment. */
     setText(text: string): void;
+    /** Sets the placeholder text displayed if the comment is empty. */
+    setPlaceholderText(text: string): void;
     /** Sets the size of the comment. */
     setSize(size: Size): void;
     /** Sets whether the comment is collapsed or not. */

package/core/connection.d.ts

@@ -216,7 +216,7 @@ export declare class Connection implements IASTNodeLocationWithBlock {
      *
      * Headless configurations (the default) do not have neighboring connection,
      * and always return an empty list (the default).
-     * {@link RenderedConnection#neighbours} overrides this behavior with a list
+     * {@link (RenderedConnection:class).neighbours} overrides this behavior with a list
      * computed from the rendered positioning.
      *
      * @param _maxLimit The maximum radius to another connection.

package/core/dropdowndiv.d.ts

@@ -75,7 +75,7 @@ export declare function getOwner(): Field | null;
  *
  * @returns Div to populate with content.
  */
-export declare function getContentDiv(): Element;
+export declare function getContentDiv(): HTMLDivElement;
 /** Clear the content of the drop-down. */
 export declare function clearContent(): void;
 /**

package/core/events/events.d.ts

@@ -32,6 +32,7 @@ export { VarBase, VarBaseJson } from './events_var_base.js';
 export { VarCreate, VarCreateJson } from './events_var_create.js';
 export { VarDelete, VarDeleteJson } from './events_var_delete.js';
 export { VarRename, VarRenameJson } from './events_var_rename.js';
+export { VarTypeChange, VarTypeChangeJson } from './events_var_type_change.js';
 export { ViewportChange, ViewportChangeJson } from './events_viewport.js';
 export { FinishedLoading } from './workspace_events.js';
 export type { BumpEvent } from './utils.js';

package/core/events/events_var_base.d.ts

@@ -8,7 +8,7 @@
  *
  * @class
  */
-import type { VariableModel } from '../variable_model.js';
+import type { IVariableModel, IVariableState } from '../interfaces/i_variable_model.js';
 import type { Workspace } from '../workspace.js';
 import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 /**
@@ -22,7 +22,7 @@ export declare class VarBase extends AbstractEvent {
      * @param opt_variable The variable this event corresponds to.  Undefined for
      *     a blank event.
      */
-    constructor(opt_variable?: VariableModel);
+    constructor(opt_variable?: IVariableModel<IVariableState>);
     /**
      * Encode the event as JSON.
      *

package/core/events/events_var_create.d.ts

@@ -3,7 +3,12 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { VariableModel } from '../variable_model.js';
+/**
+ * Class for a variable creation event.
+ *
+ * @class
+ */
+import type { IVariableModel, IVariableState } from '../interfaces/i_variable_model.js';
 import type { Workspace } from '../workspace.js';
 import { VarBase, VarBaseJson } from './events_var_base.js';
 import { EventType } from './type.js';
@@ -19,7 +24,7 @@ export declare class VarCreate extends VarBase {
     /**
      * @param opt_variable The created variable. Undefined for a blank event.
      */
-    constructor(opt_variable?: VariableModel);
+    constructor(opt_variable?: IVariableModel<IVariableState>);
     /**
      * Encode the event as JSON.
      *

package/core/events/events_var_delete.d.ts

@@ -3,14 +3,12 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { VariableModel } from '../variable_model.js';
+import type { IVariableModel, IVariableState } from '../interfaces/i_variable_model.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: EventType;
@@ -21,7 +19,7 @@ export declare class VarDelete extends VarBase {
     /**
      * @param opt_variable The deleted variable. Undefined for a blank event.
      */
-    constructor(opt_variable?: VariableModel);
+    constructor(opt_variable?: IVariableModel<IVariableState>);
     /**
      * Encode the event as JSON.
      *

package/core/events/events_var_rename.d.ts

@@ -3,14 +3,12 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { VariableModel } from '../variable_model.js';
+import type { IVariableModel, IVariableState } from '../interfaces/i_variable_model.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: EventType;
@@ -22,7 +20,7 @@ export declare class VarRename extends VarBase {
      * @param opt_variable The renamed variable. Undefined for a blank event.
      * @param newName The new name the variable will be changed to.
      */
-    constructor(opt_variable?: VariableModel, newName?: string);
+    constructor(opt_variable?: IVariableModel<IVariableState>, newName?: string);
     /**
      * Encode the event as JSON.
      *

package/core/events/events_var_type_change.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Class for a variable type change event.
+ *
+ * @class
+ */
+import type { IVariableModel, IVariableState } from '../interfaces/i_variable_model.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's type has changed.
+ */
+export declare class VarTypeChange extends VarBase {
+    oldType?: string | undefined;
+    newType?: string | undefined;
+    type: EventType;
+    /**
+     * @param variable The variable whose type changed. Undefined for a blank event.
+     * @param oldType The old type of the variable. Undefined for a blank event.
+     * @param newType The new type of the variable. Undefined for a blank event.
+     */
+    constructor(variable?: IVariableModel<IVariableState>, oldType?: string | undefined, newType?: string | undefined);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): VarTypeChangeJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of VarTypeChange, 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: VarTypeChangeJson, workspace: Workspace, event?: any): VarTypeChange;
+    /**
+     * Run a variable type change event.
+     *
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}
+export interface VarTypeChangeJson extends VarBaseJson {
+    oldType: string;
+    newType: string;
+}
+//# sourceMappingURL=events_var_type_change.d.ts.map

package/core/events/type.d.ts

@@ -27,6 +27,8 @@ export declare enum EventType {
     VAR_DELETE = "var_delete",
     /** Type of event that renames a variable. */
     VAR_RENAME = "var_rename",
+    /** Type of event that changes the type of a variable. */
+    VAR_TYPE_CHANGE = "var_type_change",
     /**
      * Type of generic event that records a UI change.
      *