blockly 11.2.0 → 12.0.0-beta.1

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

@@ -10,6 +10,7 @@ import { Measurable } from './base.js';
  * during rendering.
  */
 export declare class RoundCorner extends Measurable {
+    private roundCorner;
     /**
      * @param constants The rendering constants provider.
      * @param opt_position The position of this corner.

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

@@ -10,6 +10,7 @@ import { Measurable } from './base.js';
  * during rendering.
  */
 export declare class SquareCorner extends Measurable {
+    private squareCorner;
     /**
      * @param constants The rendering constants provider.
      * @param opt_position The position of this corner.

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

@@ -11,6 +11,7 @@ import { InputConnection } from './input_connection.js';
  * during rendering
  */
 export declare class StatementInput extends InputConnection {
+    private statementInput;
     /**
      * @param constants The rendering constants provider.
      * @param input The statement input to measure and store information for.

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

@@ -4,7 +4,24 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Measurable } from './base.js';
+import type { BottomRow } from './bottom_row.js';
+import type { ExternalValueInput } from './external_value_input.js';
+import type { Field } from './field.js';
+import type { Hat } from './hat.js';
+import type { Icon } from './icon.js';
+import type { InRowSpacer } from './in_row_spacer.js';
+import type { InlineInput } from './inline_input.js';
+import type { InputConnection } from './input_connection.js';
+import type { InputRow } from './input_row.js';
+import type { JaggedEdge } from './jagged_edge.js';
+import type { NextConnection } from './next_connection.js';
+import type { PreviousConnection } from './previous_connection.js';
+import type { RoundCorner } from './round_corner.js';
 import type { Row } from './row.js';
+import type { SpacerRow } from './spacer_row.js';
+import type { SquareCorner } from './square_corner.js';
+import type { StatementInput } from './statement_input.js';
+import type { TopRow } from './top_row.js';
 /**
  * Types of rendering elements.
  */
@@ -63,77 +80,84 @@ declare class TypesContainer {
      * @param elem The element to check.
      * @returns 1 if the object stores information about a field.
      */
-    isField(elem: Measurable): number;
+    isField(elem: Measurable): elem is Field;
     /**
      * Whether a measurable stores information about a hat.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a hat.
      */
-    isHat(elem: Measurable): number;
+    isHat(elem: Measurable): elem is Hat;
     /**
      * Whether a measurable stores information about an icon.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an icon.
      */
-    isIcon(elem: Measurable): number;
+    isIcon(elem: Measurable): elem is Icon;
     /**
      * Whether a measurable stores information about a spacer.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a spacer.
      */
-    isSpacer(elem: Measurable | Row): number;
+    isSpacer(elem: Measurable | Row): elem is SpacerRow | InRowSpacer;
     /**
      * Whether a measurable stores information about an in-row spacer.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an in-row spacer.
      */
-    isInRowSpacer(elem: Measurable): number;
+    isInRowSpacer(elem: Measurable): elem is InRowSpacer;
+    /**
+     * Whether a row is a spacer row.
+     *
+     * @param row The row to check.
+     * @returns True if the row is a spacer row.
+     */
+    isSpacerRow(row: Row): row is SpacerRow;
     /**
      * Whether a measurable stores information about an input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an input.
      */
-    isInput(elem: Measurable): number;
+    isInput(elem: Measurable): elem is InputConnection;
     /**
      * Whether a measurable stores information about an external input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an external input.
      */
-    isExternalInput(elem: Measurable): number;
+    isExternalInput(elem: Measurable): elem is ExternalValueInput;
     /**
      * Whether a measurable stores information about an inline input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an inline input.
      */
-    isInlineInput(elem: Measurable): number;
+    isInlineInput(elem: Measurable): elem is InlineInput;
     /**
      * Whether a measurable stores information about a statement input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a statement input.
      */
-    isStatementInput(elem: Measurable): number;
+    isStatementInput(elem: Measurable): elem is StatementInput;
     /**
      * Whether a measurable stores information about a previous connection.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a previous connection.
      */
-    isPreviousConnection(elem: Measurable): number;
+    isPreviousConnection(elem: Measurable): elem is PreviousConnection;
     /**
      * Whether a measurable stores information about a next connection.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a next connection.
      */
-    isNextConnection(elem: Measurable): number;
+    isNextConnection(elem: Measurable): elem is NextConnection;
     /**
      * Whether a measurable stores information about a previous or next
      * connection.
@@ -142,91 +166,92 @@ declare class TypesContainer {
      * @returns 1 if the object stores information about a previous or next
      *     connection.
      */
-    isPreviousOrNextConnection(elem: Measurable): number;
+    isPreviousOrNextConnection(elem: Measurable): elem is PreviousConnection | NextConnection;
+    isRoundCorner(elem: Measurable): elem is RoundCorner;
     /**
      * Whether a measurable stores information about a left round corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a left round corner.
      */
-    isLeftRoundedCorner(elem: Measurable): number;
+    isLeftRoundedCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a right round corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a right round corner.
      */
-    isRightRoundedCorner(elem: Measurable): number;
+    isRightRoundedCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a left square corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a left square corner.
      */
-    isLeftSquareCorner(elem: Measurable): number;
+    isLeftSquareCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a right square corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a right square corner.
      */
-    isRightSquareCorner(elem: Measurable): number;
+    isRightSquareCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a corner.
      */
-    isCorner(elem: Measurable): number;
+    isCorner(elem: Measurable): elem is SquareCorner | RoundCorner;
     /**
      * Whether a measurable stores information about a jagged edge.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a jagged edge.
      */
-    isJaggedEdge(elem: Measurable): number;
+    isJaggedEdge(elem: Measurable): elem is JaggedEdge;
     /**
      * Whether a measurable stores information about a row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a row.
      */
-    isRow(row: Row): number;
+    isRow(row: Row): row is Row;
     /**
      * Whether a measurable stores information about a between-row spacer.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a between-row spacer.
      */
-    isBetweenRowSpacer(row: Row): number;
+    isBetweenRowSpacer(row: Row): row is SpacerRow;
     /**
      * Whether a measurable stores information about a top row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a top row.
      */
-    isTopRow(row: Row): number;
+    isTopRow(row: Row): row is TopRow;
     /**
      * Whether a measurable stores information about a bottom row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a bottom row.
      */
-    isBottomRow(row: Row): number;
+    isBottomRow(row: Row): row is BottomRow;
     /**
      * Whether a measurable stores information about a top or bottom row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a top or bottom row.
      */
-    isTopOrBottomRow(row: Row): number;
+    isTopOrBottomRow(row: Row): row is TopRow | BottomRow;
     /**
      * Whether a measurable stores information about an input row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about an input row.
      */
-    isInputRow(row: Row): number;
+    isInputRow(row: Row): row is InputRow;
 }
 export declare const Types: TypesContainer;
 export {};

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

@@ -102,7 +102,13 @@ export declare class ConstantProvider extends BaseConstantProvider {
      * rectangular reporter block. Null before init is called.
      */
     SQUARED: Shape | null;
-    constructor();
+    /**
+     * Creates a new ConstantProvider.
+     *
+     * @param gridUnit If set, defines the base unit used to calculate other
+     *     constants.
+     */
+    constructor(gridUnit?: number);
     setFontConstants_(theme: Theme): void;
     init(): void;
     setDynamicProperties_(theme: Theme): void;
@@ -153,7 +159,7 @@ export declare class ConstantProvider extends BaseConstantProvider {
     };
     generateSecondaryColour_(colour: string): string;
     generateTertiaryColour_(colour: string): string;
-    createDom(svg: SVGElement, tagName: string, selector: string): void;
+    createDom(svg: SVGElement, tagName: string, selector: string, injectionDivIfIsParent?: HTMLElement): void;
     getCSS_(selector: string): string[];
 }
 //# sourceMappingURL=constants.d.ts.map

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

@@ -4,9 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockSvg } from '../../block_svg.js';
-import { InsertionMarkerManager } from '../../insertion_marker_manager.js';
 import type { Marker } from '../../keyboard_nav/marker.js';
-import type { RenderedConnection } from '../../rendered_connection.js';
 import type { BlockStyle } from '../../theme.js';
 import type { WorkspaceSvg } from '../../workspace_svg.js';
 import type { RenderInfo as BaseRenderInfo } from '../common/info.js';
@@ -73,10 +71,5 @@ export declare class Renderer extends BaseRenderer {
      * @returns The constant provider.
      */
     getConstants(): ConstantProvider;
-    /**
-     * @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/separator_flyout_inflater.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @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';
+/**
+ * @internal
+ */
+export declare const SEPARATOR_TYPE = "sep";
+/**
+ * Class responsible for creating separators for flyouts.
+ */
+export declare class SeparatorFlyoutInflater implements IFlyoutInflater {
+    /**
+     * Inflates a dummy flyout separator.
+     *
+     * The flyout automatically creates separators between every element with a
+     * size determined by calling gapForElement on the relevant inflater.
+     * Additionally, users can explicitly add separators in the flyout definition.
+     * When separators (implicitly or explicitly created) follow one another, the
+     * gap of the last one propagates backwards and flattens to one separator.
+     * This flattening is not additive; if there are initially separators of 2, 3,
+     * and 4 pixels, after normalization there will be one separator of 4 pixels.
+     * Therefore, this method returns a zero-width separator, which will be
+     * replaced by the one implicitly created by the flyout based on the value
+     * returned by gapForElement, which knows the default gap, unlike this method.
+     *
+     * @param _state A JSON representation of a flyout separator.
+     * @param flyoutWorkspace The workspace the separator belongs to.
+     * @returns A newly created FlyoutSeparator.
+     */
+    load(_state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
+    /**
+     * Returns the size of the separator. See `load` for more details.
+     *
+     * @param state A JSON representation of a flyout separator.
+     * @param defaultGap The default spacing for flyout items.
+     * @returns The desired size of the separator.
+     */
+    gapForItem(state: object, defaultGap: number): number;
+    /**
+     * Disposes of the given separator. Intentional no-op.
+     *
+     * @param _item The flyout separator 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=separator_flyout_inflater.d.ts.map

package/core/serialization/variables.d.ts

@@ -4,15 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { ISerializer } from '../interfaces/i_serializer.js';
+import type { IVariableState } from '../interfaces/i_variable_model.js';
 import type { Workspace } from '../workspace.js';
-/**
- * Represents the state of a given variable.
- */
-export interface State {
-    name: string;
-    id: string;
-    type: string | undefined;
-}
 /**
  * Serializer for saving and loading variable state.
  */
@@ -26,7 +19,7 @@ export declare class VariableSerializer implements ISerializer {
      * @returns The state of the workspace's variables, or null if there are no
      *     variables.
      */
-    save(workspace: Workspace): State[] | null;
+    save(workspace: Workspace): IVariableState[] | null;
     /**
      * Deserializes the variable defined by the given state into the given
      * workspace.
@@ -34,7 +27,7 @@ export declare class VariableSerializer implements ISerializer {
      * @param state The state of the variables to deserialize.
      * @param workspace The workspace to deserialize into.
      */
-    load(state: State[], workspace: Workspace): void;
+    load(state: IVariableState[], workspace: Workspace): void;
     /**
      * Disposes of any variables that exist on the workspace.
      *

package/core/toolbox/toolbox.d.ts

@@ -36,8 +36,6 @@ export declare class Toolbox extends DeleteArea implements IAutoHideable, IKeybo
     protected contentsDiv_: HTMLDivElement | null;
     /** Whether the Toolbox is visible. */
     protected isVisible_: boolean;
-    /** The list of items in the toolbox. */
-    protected contents_: IToolboxItem[];
     /** The width of the toolbox. */
     protected width_: number;
     /** The height of the toolbox. */
@@ -45,9 +43,8 @@ export declare class Toolbox extends DeleteArea implements IAutoHideable, IKeybo
     RTL: boolean;
     /** The flyout for the toolbox. */
     private flyout;
-    protected contentMap_: {
-        [key: string]: IToolboxItem;
-    };
+    /** Map from ID to the corresponding toolbox item. */
+    protected contents: Map<string, IToolboxItem>;
     toolboxPosition: toolbox.Position;
     /** The currently selected item. */
     protected selectedItem_: ISelectableToolboxItem | null;

package/core/variable_map.d.ts

@@ -11,17 +11,18 @@
 import './events/events_var_delete.js';
 import './events/events_var_rename.js';
 import type { Block } from './block.js';
-import { VariableModel } from './variable_model.js';
+import type { IVariableMap } from './interfaces/i_variable_map.js';
+import { IVariableModel, IVariableState } from './interfaces/i_variable_model.js';
 import type { Workspace } from './workspace.js';
 /**
  * Class for a variable map.  This contains a dictionary data structure with
  * variable types as keys and lists of variables as values.  The list of
  * variables are the type indicated by the key.
  */
-export declare class VariableMap {
+export declare class VariableMap implements IVariableMap<IVariableModel<IVariableState>> {
     workspace: Workspace;
     /**
-     * A map from variable type to list of variable names.  The lists contain
+     * A map from variable type to map of IDs to variables. The maps contain
      * all of the named variables in the workspace, including variables that are
      * not currently in use.
      */
@@ -35,13 +36,15 @@ export declare class VariableMap {
      *
      * @param variable Variable to rename.
      * @param newName New variable name.
-     * @internal
+     * @returns The newly renamed variable.
      */
-    renameVariable(variable: VariableModel, newName: string): void;
+    renameVariable(variable: IVariableModel<IVariableState>, newName: string): IVariableModel<IVariableState>;
+    changeVariableType(variable: IVariableModel<IVariableState>, newType: string): IVariableModel<IVariableState>;
     /**
      * Rename a variable by updating its name in the variable map. Identify the
      * variable to rename with the given ID.
      *
+     * @deprecated v12, use VariableMap.renameVariable.
      * @param id ID of the variable to rename.
      * @param newName New variable name.
      */
@@ -78,29 +81,27 @@ export declare class VariableMap {
      * @param opt_id The unique ID of the variable. This will default to a UUID.
      * @returns The newly created variable.
      */
-    createVariable(name: string, opt_type?: string | null, opt_id?: string | null): VariableModel;
+    createVariable(name: string, opt_type?: string, opt_id?: string): IVariableModel<IVariableState>;
     /**
-     * Delete a variable.
+     * Adds the given variable to this variable map.
+     *
+     * @param variable The variable to add.
+     */
+    addVariable(variable: IVariableModel<IVariableState>): void;
+    /**
+     * Delete a variable and all of its uses without confirmation.
      *
      * @param variable Variable to delete.
      */
-    deleteVariable(variable: VariableModel): void;
+    deleteVariable(variable: IVariableModel<IVariableState>): void;
     /**
      * Delete a variables by the passed in ID and all of its uses from this
      * workspace. May prompt the user for confirmation.
      *
+     * @deprecated v12, use Blockly.Variables.deleteVariable.
      * @param id ID of variable to delete.
      */
     deleteVariableById(id: string): void;
-    /**
-     * Deletes a variable and all of its uses from this workspace without asking
-     * the user for confirmation.
-     *
-     * @param variable Variable to delete.
-     * @param uses An array of uses of the variable.
-     * @internal
-     */
-    deleteVariableInternal(variable: VariableModel, uses: Block[]): void;
     /**
      * Find the variable by the given name and type and return it.  Return null if
      *     it is not found.
@@ -110,14 +111,14 @@ export declare class VariableMap {
      *     the empty string, which is a specific type.
      * @returns The variable with the given name, or null if it was not found.
      */
-    getVariable(name: string, opt_type?: string | null): VariableModel | null;
+    getVariable(name: string, opt_type?: string): IVariableModel<IVariableState> | null;
     /**
      * Find the variable by the given ID and return it.  Return null if not found.
      *
      * @param id The ID to check for.
      * @returns The variable with the given ID.
      */
-    getVariableById(id: string): VariableModel | null;
+    getVariableById(id: string): IVariableModel<IVariableState> | null;
     /**
      * Get a list containing all of the variables of a specified type. If type is
      *     null, return list of variables with empty string type.
@@ -126,33 +127,30 @@ export declare class VariableMap {
      * @returns The sought after variables of the passed in type. An empty array
      *     if none are found.
      */
-    getVariablesOfType(type: string | null): VariableModel[];
+    getVariablesOfType(type: string | null): IVariableModel<IVariableState>[];
     /**
-     * Return all variable and potential variable types.  This list always
-     * contains the empty string.
+     * Returns a list of unique types of variables in this variable map.
      *
-     * @param ws The workspace used to look for potential variables. This can be
-     *     different than the workspace stored on this object if the passed in ws
-     *     is a flyout workspace.
-     * @returns List of variable types.
-     * @internal
+     * @returns A list of unique types of variables in this variable map.
      */
-    getVariableTypes(ws: Workspace | null): string[];
+    getTypes(): string[];
     /**
      * Return all variables of all types.
      *
      * @returns List of variable models.
      */
-    getAllVariables(): VariableModel[];
+    getAllVariables(): IVariableModel<IVariableState>[];
     /**
      * Returns all of the variable names of all types.
      *
+     * @deprecated v12, use Blockly.Variables.getAllVariables.
      * @returns All of the variable names of all types.
      */
     getAllVariableNames(): string[];
     /**
      * Find all the uses of a named variable.
      *
+     * @deprecated v12, use Blockly.Variables.getVariableUsesById.
      * @param id ID of the variable to find.
      * @returns Array of block usages.
      */

package/core/variable_model.d.ts

@@ -9,6 +9,7 @@
  * @class
  */
 import './events/events_var_create.js';
+import { IVariableModel, IVariableState } from './interfaces/i_variable_model.js';
 import type { Workspace } from './workspace.js';
 /**
  * Class for a variable model.
@@ -16,10 +17,10 @@ import type { Workspace } from './workspace.js';
  *
  * @see {Blockly.FieldVariable}
  */
-export declare class VariableModel {
-    workspace: Workspace;
-    name: string;
-    type: string;
+export declare class VariableModel implements IVariableModel<IVariableState> {
+    private readonly workspace;
+    private name;
+    private type;
     private readonly id;
     /**
      * @param workspace The variable's workspace.
@@ -33,15 +34,40 @@ export declare class VariableModel {
     constructor(workspace: Workspace, name: string, opt_type?: string, opt_id?: string);
     /** @returns The ID for the variable. */
     getId(): string;
+    /** @returns The name of this variable. */
+    getName(): string;
     /**
-     * A custom compare function for the VariableModel objects.
+     * Updates the user-visible name of this variable.
      *
-     * @param var1 First variable to compare.
-     * @param var2 Second variable to compare.
-     * @returns -1 if name of var1 is less than name of var2, 0 if equal, and 1 if
-     *     greater.
-     * @internal
+     * @returns The newly-updated variable.
      */
-    static compareByName(var1: VariableModel, var2: VariableModel): number;
+    setName(newName: string): this;
+    /** @returns The type of this variable. */
+    getType(): string;
+    /**
+     * Updates the type of this variable.
+     *
+     * @returns The newly-updated variable.
+     */
+    setType(newType: string): this;
+    /**
+     * Returns the workspace this VariableModel belongs to.
+     *
+     * @returns The workspace this VariableModel belongs to.
+     */
+    getWorkspace(): Workspace;
+    /**
+     * Serializes this VariableModel.
+     *
+     * @returns a JSON representation of this VariableModel.
+     */
+    save(): IVariableState;
+    /**
+     * Loads the persisted state into a new variable in the given workspace.
+     *
+     * @param state The serialized state of a variable model from save().
+     * @param workspace The workspace to create the new variable in.
+     */
+    static load(state: IVariableState, workspace: Workspace): void;
 }
 //# sourceMappingURL=variable_model.d.ts.map