blockly 12.3.1 → 12.4.0

package/core/events/events_comment_move.d.ts

@@ -1,93 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Class for comment move event.
- *
- * @class
- */
-import type { WorkspaceComment } from '../comments/workspace_comment.js';
-import { Coordinate } from '../utils/coordinate.js';
-import type { Workspace } from '../workspace.js';
-import { CommentBase, CommentBaseJson } from './events_comment_base.js';
-import { EventType } from './type.js';
-/**
- * Notifies listeners that a workspace comment has moved.
- */
-export declare class CommentMove extends CommentBase {
-    type: EventType;
-    /** The comment that is being moved. */
-    comment_?: WorkspaceComment;
-    /** The location of the comment before the move, in workspace coordinates. */
-    oldCoordinate_?: Coordinate;
-    /** The location of the comment after the move, in workspace coordinates. */
-    newCoordinate_?: Coordinate;
-    /**
-     * An explanation of what this move is for.  Known values include:
-     *  'drag' -- A drag operation completed.
-     *  'snap' -- Comment got shifted to line up with the grid.
-     *  'inbounds' -- Block got pushed back into a non-scrolling workspace.
-     *  'create' -- Block created via deserialization.
-     *  'cleanup' -- Workspace aligned top-level blocks.
-     * Event merging may create multiple reasons: ['drag', 'inbounds', 'snap'].
-     */
-    reason?: string[];
-    /**
-     * @param opt_comment The comment that is being moved.  Undefined for a blank
-     *     event.
-     */
-    constructor(opt_comment?: WorkspaceComment);
-    /**
-     * Record the comment's new location.  Called after the move.  Can only be
-     * called once.
-     */
-    recordNew(): void;
-    /**
-     * Sets the reason for a move event.
-     *
-     * @param reason Why is this move happening?  'drag', 'bump', 'snap', ...
-     */
-    setReason(reason: string[]): void;
-    /**
-     * Override the location before the move.  Use this if you don't create the
-     * event until the end of the move, but you know the original location.
-     *
-     * @param xy The location before the move, in workspace coordinates.
-     */
-    setOldCoordinate(xy: Coordinate): void;
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): CommentMoveJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of CommentMove, 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: CommentMoveJson, workspace: Workspace, event?: any): CommentMove;
-    /**
-     * Does this event record any change of state?
-     *
-     * @returns False if something changed.
-     */
-    isNull(): boolean;
-    /**
-     * Run a move event.
-     *
-     * @param forward True if run forward, false if run backward (undo).
-     */
-    run(forward: boolean): void;
-}
-export interface CommentMoveJson extends CommentBaseJson {
-    oldCoordinate: string;
-    newCoordinate: string;
-}
-//# sourceMappingURL=events_comment_move.d.ts.map

package/core/events/events_comment_resize.d.ts

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

package/core/events/events_selected.d.ts

@@ -1,53 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Workspace } from '../workspace.js';
-import { AbstractEventJson } from './events_abstract.js';
-import { UiBase } from './events_ui_base.js';
-import { EventType } from './type.js';
-/**
- * Class for a selected event.
- * Notifies listeners that a new element has been selected.
- */
-export declare class Selected extends UiBase {
-    /** The id of the last selected selectable element. */
-    oldElementId?: string;
-    /**
-     * The id of the newly selected selectable element,
-     * or undefined if unselected.
-     */
-    newElementId?: string;
-    type: EventType;
-    /**
-     * @param opt_oldElementId The ID of the previously selected element. Null if
-     *     no element last selected. Undefined for a blank event.
-     * @param opt_newElementId The ID of the selected element. Null if no element
-     *     currently selected (deselect). Undefined for a blank event.
-     * @param opt_workspaceId The workspace identifier for this event.
-     *    Null if no element previously selected. Undefined for a blank event.
-     */
-    constructor(opt_oldElementId?: string | null, opt_newElementId?: string | null, opt_workspaceId?: string);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): SelectedJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of Selected, 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: SelectedJson, workspace: Workspace, event?: any): Selected;
-}
-export interface SelectedJson extends AbstractEventJson {
-    oldElementId?: string;
-    newElementId?: string;
-}
-//# sourceMappingURL=events_selected.d.ts.map

package/core/events/events_theme_change.d.ts

@@ -1,43 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Workspace } from '../workspace.js';
-import { AbstractEventJson } from './events_abstract.js';
-import { UiBase } from './events_ui_base.js';
-import { EventType } from './type.js';
-/**
- * Notifies listeners that the workspace theme has changed.
- */
-export declare class ThemeChange extends UiBase {
-    /** The name of the new theme that has been set. */
-    themeName?: string;
-    type: EventType;
-    /**
-     * @param opt_themeName The theme name. Undefined for a blank event.
-     * @param opt_workspaceId The workspace identifier for this event.
-     *    event. Undefined for a blank event.
-     */
-    constructor(opt_themeName?: string, opt_workspaceId?: string);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): ThemeChangeJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of ThemeChange, 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: ThemeChangeJson, workspace: Workspace, event?: any): ThemeChange;
-}
-export interface ThemeChangeJson extends AbstractEventJson {
-    themeName: string;
-}
-//# sourceMappingURL=events_theme_change.d.ts.map

package/core/events/events_toolbox_item_select.d.ts

@@ -1,49 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Workspace } from '../workspace.js';
-import { AbstractEventJson } from './events_abstract.js';
-import { UiBase } from './events_ui_base.js';
-import { EventType } from './type.js';
-/**
- * Notifies listeners that a toolbox item has been selected.
- */
-export declare class ToolboxItemSelect extends UiBase {
-    /** The previously selected toolbox item. */
-    oldItem?: string;
-    /** The newly selected toolbox item. */
-    newItem?: string;
-    type: EventType;
-    /**
-     * @param opt_oldItem The previously selected toolbox item.
-     *     Undefined for a blank event.
-     * @param opt_newItem The newly selected toolbox item. Undefined for a blank
-     *     event.
-     * @param opt_workspaceId The workspace identifier for this event.
-     *    Undefined for a blank event.
-     */
-    constructor(opt_oldItem?: string | null, opt_newItem?: string | null, opt_workspaceId?: string);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): ToolboxItemSelectJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of ToolboxItemSelect, 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: ToolboxItemSelectJson, workspace: Workspace, event?: any): ToolboxItemSelect;
-}
-export interface ToolboxItemSelectJson extends AbstractEventJson {
-    oldItem?: string;
-    newItem?: string;
-}
-//# sourceMappingURL=events_toolbox_item_select.d.ts.map

package/core/events/events_trashcan_open.d.ts

@@ -1,47 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Workspace } from '../workspace.js';
-import { AbstractEventJson } from './events_abstract.js';
-import { UiBase } from './events_ui_base.js';
-import { EventType } from './type.js';
-/**
- * Notifies listeners when the trashcan is opening or closing.
- */
-export declare class TrashcanOpen extends UiBase {
-    /**
-     * True if the trashcan is currently opening (previously closed).
-     * False if it is currently closing (previously open).
-     */
-    isOpen?: boolean;
-    type: EventType;
-    /**
-     * @param opt_isOpen Whether the trashcan flyout is opening (false if
-     *     opening). Undefined for a blank event.
-     * @param opt_workspaceId The workspace identifier for this event.
-     *    Undefined for a blank event.
-     */
-    constructor(opt_isOpen?: boolean, opt_workspaceId?: string);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): TrashcanOpenJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of TrashcanOpen, 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: TrashcanOpenJson, workspace: Workspace, event?: any): TrashcanOpen;
-}
-export interface TrashcanOpenJson extends AbstractEventJson {
-    isOpen: boolean;
-}
-//# sourceMappingURL=events_trashcan_open.d.ts.map

package/core/events/events_ui_base.d.ts

@@ -1,32 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Base class for events fired as a result of UI actions in
- * Blockly's editor.
- *
- * @class
- */
-import { Abstract as AbstractEvent } from './events_abstract.js';
-/**
- * Base class for a UI event.
- * UI events are events that don't need to be sent over the wire for multi-user
- * editing to work (e.g. scrolling the workspace, zooming, opening toolbox
- * categories).
- * UI events do not undo or redo.
- */
-export declare class UiBase extends AbstractEvent {
-    isBlank: boolean;
-    workspaceId: string;
-    recordUndo: boolean;
-    /** Whether or not the event is a UI event. */
-    isUiEvent: boolean;
-    /**
-     * @param opt_workspaceId The workspace identifier for this event.
-     *    Undefined for a blank event.
-     */
-    constructor(opt_workspaceId?: string);
-}
-//# sourceMappingURL=events_ui_base.d.ts.map

package/core/events/events_var_base.d.ts

@@ -1,46 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Abstract class for a variable event.
- *
- * @class
- */
-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';
-/**
- * Abstract class for a variable event.
- */
-export declare class VarBase extends AbstractEvent {
-    isBlank: boolean;
-    /** The ID of the variable this event references. */
-    varId?: string;
-    /**
-     * @param opt_variable The variable this event corresponds to.  Undefined for
-     *     a blank event.
-     */
-    constructor(opt_variable?: IVariableModel<IVariableState>);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): VarBaseJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of VarBase, 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: VarBaseJson, workspace: Workspace, event?: any): VarBase;
-}
-export interface VarBaseJson extends AbstractEventJson {
-    varId: string;
-}
-//# sourceMappingURL=events_var_base.d.ts.map

package/core/events/events_var_create.d.ts

@@ -1,55 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * 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';
-/**
- * Notifies listeners that a variable model has been created.
- */
-export declare class VarCreate extends VarBase {
-    type: EventType;
-    /** The type of the variable that was created. */
-    varType?: string;
-    /** The name of the variable that was created. */
-    varName?: string;
-    /**
-     * @param opt_variable The created variable. Undefined for a blank event.
-     */
-    constructor(opt_variable?: IVariableModel<IVariableState>);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): VarCreateJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of VarCreate, 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: VarCreateJson, workspace: Workspace, event?: any): VarCreate;
-    /**
-     * Run a variable creation event.
-     *
-     * @param forward True if run forward, false if run backward (undo).
-     */
-    run(forward: boolean): void;
-}
-export interface VarCreateJson extends VarBaseJson {
-    varType: string;
-    varName: string;
-}
-//# sourceMappingURL=events_var_create.d.ts.map

package/core/events/events_var_delete.d.ts

@@ -1,50 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-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.
- */
-export declare class VarDelete extends VarBase {
-    type: EventType;
-    /** The type of the variable that was deleted. */
-    varType?: string;
-    /** The name of the variable that was deleted. */
-    varName?: string;
-    /**
-     * @param opt_variable The deleted variable. Undefined for a blank event.
-     */
-    constructor(opt_variable?: IVariableModel<IVariableState>);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): VarDeleteJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of VarDelete, 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: VarDeleteJson, workspace: Workspace, event?: any): VarDelete;
-    /**
-     * Run a variable deletion event.
-     *
-     * @param forward True if run forward, false if run backward (undo).
-     */
-    run(forward: boolean): void;
-}
-export interface VarDeleteJson extends VarBaseJson {
-    varType: string;
-    varName: string;
-}
-//# sourceMappingURL=events_var_delete.d.ts.map

package/core/events/events_var_rename.d.ts

@@ -1,51 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-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.
- */
-export declare class VarRename extends VarBase {
-    type: EventType;
-    /** The previous name of the variable. */
-    oldName?: string;
-    /** The new name of the variable. */
-    newName?: string;
-    /**
-     * @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?: IVariableModel<IVariableState>, newName?: string);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): VarRenameJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of VarRename, 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: VarRenameJson, workspace: Workspace, event?: any): VarRename;
-    /**
-     * Run a variable rename event.
-     *
-     * @param forward True if run forward, false if run backward (undo).
-     */
-    run(forward: boolean): void;
-}
-export interface VarRenameJson extends VarBaseJson {
-    oldName: string;
-    newName: string;
-}
-//# sourceMappingURL=events_var_rename.d.ts.map

package/core/events/events_var_type_change.d.ts

@@ -1,55 +0,0 @@
-/**
- * @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