blockly 9.2.1 → 9.3.0

package/core/interfaces/i_procedure_model.d.ts

@@ -3,11 +3,6 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/**
- * The interface for the data model of a procedure.
- *
- * @namespace Blockly.IProcedureModel
- */
 import { IParameterModel } from './i_parameter_model.js';
 /**
  * A data model for a procedure.

package/core/interfaces/i_registrable.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * The interface for a Blockly component that can be registered.
- *
- * @alias Blockly.IRegistrable
  */
 export interface IRegistrable {
 }

package/core/interfaces/i_selectable.d.ts

@@ -7,8 +7,6 @@ import type { IDeletable } from './i_deletable.js';
 import type { IMovable } from './i_movable.js';
 /**
  * The interface for an object that is selectable.
- *
- * @alias Blockly.ISelectable
  */
 export interface ISelectable extends IDeletable, IMovable {
     id: string;

package/core/interfaces/i_selectable_toolbox_item.d.ts

@@ -7,8 +7,6 @@ import type { FlyoutItemInfoArray } from '../utils/toolbox';
 import type { IToolboxItem } from './i_toolbox_item.js';
 /**
  * Interface for an item in the toolbox that can be selected.
- *
- * @alias Blockly.ISelectableToolboxItem
  */
 export interface ISelectableToolboxItem extends IToolboxItem {
     /**
@@ -46,4 +44,8 @@ export interface ISelectableToolboxItem extends IToolboxItem {
      */
     onClick(_e: Event): void;
 }
+/**
+ * Type guard that checks whether an IToolboxItem is an ISelectableToolboxItem.
+ */
+export declare function isSelectableToolboxItem(toolboxItem: IToolboxItem): toolboxItem is ISelectableToolboxItem;
 //# sourceMappingURL=i_selectable_toolbox_item.d.ts.map

package/core/interfaces/i_serializer.d.ts

@@ -6,8 +6,6 @@
 import type { Workspace } from '../workspace.js';
 /**
  * Serializes and deserializes a plugin or system.
- *
- * @alias Blockly.serialization.ISerializer.ISerializer
  */
 export interface ISerializer {
     /**

package/core/interfaces/i_styleable.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * Interface for an object that a style can be added to.
- *
- * @alias Blockly.IStyleable
  */
 export interface IStyleable {
     /**

package/core/interfaces/i_toolbox.d.ts

@@ -10,8 +10,6 @@ import type { IFlyout } from './i_flyout.js';
 import type { WorkspaceSvg } from '../workspace_svg.js';
 /**
  * Interface for a toolbox.
- *
- * @alias Blockly.IToolbox
  */
 export interface IToolbox extends IRegistrable {
     /** Initializes the toolbox. */

package/core/interfaces/i_toolbox_item.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * Interface for an item in the toolbox.
- *
- * @alias Blockly.IToolboxItem
  */
 export interface IToolboxItem {
     /**

package/core/interfaces/i_variable_backed_parameter_model.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { VariableModel } from '../variable_model.js';
+import { IParameterModel } from './i_parameter_model.js';
+/** Interface for a parameter model that holds a variable model. */
+export interface IVariableBackedParameterModel extends IParameterModel {
+    /** Returns the variable model held by this type. */
+    getVariableModel(): VariableModel;
+}
+/**
+ * Returns whether the given object is a variable holder or not.
+ */
+export declare function isVariableBackedParameterModel(param: IParameterModel): param is IVariableBackedParameterModel;
+//# sourceMappingURL=i_variable_backed_parameter_model.d.ts.map

package/core/internal_constants.d.ts

@@ -6,7 +6,6 @@
 /**
  * Number of characters to truncate a collapsed block to.
  *
- * @alias Blockly.internalConstants.COLLAPSE_CHARS
  * @internal
  */
 export declare const COLLAPSE_CHARS = 30;
@@ -14,14 +13,12 @@ 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).
  *
- * @alias Blockly.internalConstants.DRAG_STACK
  * @internal
  */
 export declare const DRAG_STACK = true;
 /**
  * Lookup table for determining the opposite type of a connection.
  *
- * @alias Blockly.internalConstants.OPPOSITE_TYPE
  * @internal
  */
 export declare const OPPOSITE_TYPE: number[];
@@ -30,7 +27,6 @@ export declare const OPPOSITE_TYPE: number[];
  * This string indicates that this option in the dropdown is 'Rename
  * variable...' and if selected, should trigger the prompt to rename a variable.
  *
- * @alias Blockly.internalConstants.RENAME_VARIABLE_ID
  * @internal
  */
 export declare const RENAME_VARIABLE_ID = "RENAME_VARIABLE_ID";
@@ -39,7 +35,6 @@ export declare const RENAME_VARIABLE_ID = "RENAME_VARIABLE_ID";
  * This string indicates that this option in the dropdown is 'Delete the "%1"
  * variable' and if selected, should trigger the prompt to delete a variable.
  *
- * @alias Blockly.internalConstants.DELETE_VARIABLE_ID
  * @internal
  */
 export declare const DELETE_VARIABLE_ID = "DELETE_VARIABLE_ID";

package/core/keyboard_nav/ast_node.d.ts

@@ -14,8 +14,6 @@ import type { Workspace } from '../workspace.js';
  * Class for an AST node.
  * It is recommended that you use one of the createNode methods instead of
  * creating a node directly.
- *
- * @alias Blockly.ASTNode
  */
 export declare class ASTNode {
     /**
@@ -37,7 +35,6 @@ export declare class ASTNode {
      *     Must be in ASTNode.types.
      * @param location The position in the AST.
      * @param opt_params Optional dictionary of options.
-     * @alias Blockly.ASTNode
      */
     constructor(type: string, location: IASTNodeLocation, opt_params?: Params);
     /**

package/core/keyboard_nav/basic_cursor.d.ts

@@ -9,13 +9,10 @@ import { Cursor } from './cursor.js';
  * Class for a basic cursor.
  * This will allow the user to get to all nodes in the AST by hitting next or
  * previous.
- *
- * @alias Blockly.BasicCursor
  */
 export declare class BasicCursor extends Cursor {
     /** Name used for registering a basic cursor. */
     static readonly registrationName = "basicCursor";
-    /** @alias Blockly.BasicCursor */
     constructor();
     /**
      * Find the next node in the pre order traversal.

package/core/keyboard_nav/cursor.d.ts

@@ -8,12 +8,9 @@ import { Marker } from './marker.js';
 /**
  * Class for a cursor.
  * A cursor controls how a user navigates the Blockly AST.
- *
- * @alias Blockly.Cursor
  */
 export declare class Cursor extends Marker {
     type: string;
-    /** @alias Blockly.Cursor */
     constructor();
     /**
      * Find the next connection, field, or block.

package/core/keyboard_nav/marker.d.ts

@@ -8,8 +8,6 @@ import type { ASTNode } from './ast_node.js';
 /**
  * Class for a marker.
  * This is used in keyboard navigation to save a location in the Blockly AST.
- *
- * @alias Blockly.Marker
  */
 export declare class Marker {
     /** The colour of the marker. */

package/core/keyboard_nav/tab_navigate_cursor.d.ts

@@ -7,8 +7,6 @@ import { ASTNode } from './ast_node.js';
 import { BasicCursor } from './basic_cursor.js';
 /**
  * A cursor for navigating between tab navigable fields.
- *
- * @alias Blockly.TabNavigateCursor
  */
 export declare class TabNavigateCursor extends BasicCursor {
     /**

package/core/marker_manager.d.ts

@@ -8,8 +8,6 @@ import type { Marker } from './keyboard_nav/marker.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class to manage the multiple markers and the cursor on a workspace.
- *
- * @alias Blockly.MarkerManager
  */
 export declare class MarkerManager {
     private readonly workspace;

package/core/menu.d.ts

@@ -9,8 +9,6 @@ import { Coordinate } from './utils/coordinate.js';
 import type { Size } from './utils/size.js';
 /**
  * A basic menu class.
- *
- * @alias Blockly.Menu
  */
 export declare class Menu {
     /**

package/core/menuitem.d.ts

@@ -6,8 +6,6 @@
 import * as aria from './utils/aria.js';
 /**
  * Class representing an item in a menu.
- *
- * @alias Blockly.MenuItem
  */
 export declare class MenuItem {
     private readonly content;

package/core/metrics_manager.d.ts

@@ -12,8 +12,6 @@ import * as toolboxUtils from './utils/toolbox.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * The manager for all workspace metrics calculations.
- *
- * @alias Blockly.MetricsManager
  */
 export declare class MetricsManager implements IMetricsManager {
     /** The workspace to calculate metrics for. */
@@ -30,11 +28,14 @@ export declare class MetricsManager implements IMetricsManager {
      */
     protected getDimensionsPx_(elem: IToolbox | null | IFlyout): Size;
     /**
-     * Gets the width and the height of the flyout on the workspace in pixel
-     * coordinates. Returns 0 for the width and height if the workspace has a
-     * category toolbox instead of a simple toolbox.
+     * Gets the width and the height of the flyout in pixel
+     * coordinates. By default, will get metrics for either a simple flyout (owned
+     * directly by the workspace) or for the flyout owned by the toolbox. If you
+     * pass `opt_own` as `true` then only metrics for the simple flyout will be
+     * returned, and it will return 0 for the width and height if the workspace
+     * has a category toolbox instead of a simple toolbox.
      *
-     * @param opt_own Whether to only return the workspace's own flyout.
+     * @param opt_own Whether to only return the workspace's own flyout metrics.
      * @returns The width and height of the flyout.
      */
     getFlyoutMetrics(opt_own?: boolean): ToolboxMetrics;
@@ -42,8 +43,7 @@ export declare class MetricsManager implements IMetricsManager {
      * Gets the width, height and position of the toolbox on the workspace in
      * pixel coordinates. Returns 0 for the width and height if the workspace has
      * a simple toolbox instead of a category toolbox. To get the width and height
-     * of a
-     * simple toolbox @see {@link MetricsManager#getFlyoutMetrics}.
+     * of a simple toolbox, see {@link MetricsManager#getFlyoutMetrics}.
      *
      * @returns The object with the width, height and position of the toolbox.
      */

package/core/mutator.d.ts

@@ -13,8 +13,6 @@ import { Options } from './options.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a mutator dialog.
- *
- * @alias Blockly.Mutator
  */
 export declare class Mutator extends Icon {
     private quarkNames;

package/core/names.d.ts

@@ -7,8 +7,6 @@ import type { VariableMap } from './variable_map.js';
 import type { Workspace } from './workspace.js';
 /**
  * Class for a database of entity names (variables, procedures, etc).
- *
- * @alias Blockly.Names
  */
 export declare class Names {
     static DEVELOPER_VARIABLE_TYPE: NameType;
@@ -123,7 +121,6 @@ export declare namespace Names {
      * getName('foo', 'VARIABLE') = 'foo'
      * getName('foo', 'PROCEDURE') = 'foo2'
      *
-     * @alias Blockly.Names.NameType
      */
     enum NameType {
         DEVELOPER_VARIABLE = "DEVELOPER_VARIABLE",

package/core/{procedures/observable_procedure_map.d.ts → observable_procedure_map.d.ts}

@@ -3,12 +3,11 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { IProcedureMap } from '../interfaces/i_procedure_map.js';
-import type { IProcedureModel } from '../interfaces/i_procedure_model.js';
-import type { Workspace } from '../workspace.js';
+import { IProcedureMap } from './interfaces/i_procedure_map.js';
+import type { IProcedureModel } from './interfaces/i_procedure_model.js';
 export declare class ObservableProcedureMap extends Map<string, IProcedureModel> implements IProcedureMap {
-    private readonly workspace;
-    constructor(workspace: Workspace);
+    /** @internal */
+    constructor();
     /**
      * Adds the given procedure model to the procedure map.
      */

package/core/options.d.ts

@@ -11,8 +11,6 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Parse the user-specified options, using reasonable defaults where behaviour
  * is unspecified.
- *
- * @alias Blockly.Options
  */
 export declare class Options {
     RTL: boolean;

package/core/positionable_helpers.d.ts

@@ -10,7 +10,6 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Enum for vertical positioning.
  *
- * @alias Blockly.uiPosition.verticalPosition
  * @internal
  */
 export declare enum verticalPosition {
@@ -20,7 +19,6 @@ export declare enum verticalPosition {
 /**
  * Enum for horizontal positioning.
  *
- * @alias Blockly.uiPosition.horizontalPosition
  * @internal
  */
 export declare enum horizontalPosition {
@@ -30,7 +28,6 @@ export declare enum horizontalPosition {
 /**
  * An object defining a horizontal and vertical positioning.
  *
- * @alias Blockly.uiPosition.Position
  * @internal
  */
 export interface Position {
@@ -40,7 +37,6 @@ export interface Position {
 /**
  * Enum for bump rules to use for dealing with collisions.
  *
- * @alias Blockly.uiPosition.bumpDirection
  * @internal
  */
 export declare enum bumpDirection {
@@ -60,7 +56,6 @@ export declare enum bumpDirection {
  * @param metrics The workspace UI metrics.
  * @param workspace The workspace.
  * @returns The suggested start position.
- * @alias Blockly.uiPosition.getStartPositionRect
  * @internal
  */
 export declare function getStartPositionRect(position: Position, size: Size, horizontalPadding: number, verticalPadding: number, metrics: UiMetrics, workspace: WorkspaceSvg): Rect;
@@ -73,7 +68,6 @@ export declare function getStartPositionRect(position: Position, size: Size, hor
  * @param workspace The workspace.
  * @param metrics The workspace metrics.
  * @returns The suggested corner position.
- * @alias Blockly.uiPosition.getCornerOppositeToolbox
  * @internal
  */
 export declare function getCornerOppositeToolbox(workspace: WorkspaceSvg, metrics: UiMetrics): Position;
@@ -89,7 +83,6 @@ export declare function getCornerOppositeToolbox(workspace: WorkspaceSvg, metric
  * @param savedPositions List of rectangles that represent the positions of UI
  *     elements already placed.
  * @returns The suggested position rectangle.
- * @alias Blockly.uiPosition.bumpPositionRect
  * @internal
  */
 export declare function bumpPositionRect(startRect: Rect, margin: number, bumpDir: bumpDirection, savedPositions: Rect[]): Rect;

package/core/procedures.d.ts

@@ -7,9 +7,12 @@ import './events/events_block_change.js';
 import type { Block } from './block.js';
 import type { Abstract } from './events/events_abstract.js';
 import { Field } from './field.js';
-import { ObservableProcedureMap } from './procedures/observable_procedure_map.js';
-import { ObservableProcedureModel } from './procedures/observable_procedure_model.js';
-import { ObservableParameterModel } from './procedures/observable_parameter_model.js';
+import { IParameterModel } from './interfaces/i_parameter_model.js';
+import { IProcedureMap } from './interfaces/i_procedure_map.js';
+import { IProcedureModel } from './interfaces/i_procedure_model.js';
+import { IProcedureBlock, isProcedureBlock } from './interfaces/i_procedure_block.js';
+import { ProcedureTuple } from './interfaces/i_legacy_procedure_blocks.js';
+import { ObservableProcedureMap } from './observable_procedure_map.js';
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
@@ -18,27 +21,12 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * procedure blocks.
  * See also Blockly.Variables.CATEGORY_NAME and
  * Blockly.VariablesDynamic.CATEGORY_NAME.
- *
- * @alias Blockly.Procedures.CATEGORY_NAME
  */
 export declare const CATEGORY_NAME = "PROCEDURE";
 /**
  * The default argument for a procedures_mutatorarg block.
- *
- * @alias Blockly.Procedures.DEFAULT_ARG
  */
 export declare const DEFAULT_ARG = "x";
-export type ProcedureTuple = [string, string[], boolean];
-/**
- * Procedure block type.
- *
- * @alias Blockly.Procedures.ProcedureBlock
- */
-export interface ProcedureBlock {
-    getProcedureCall: () => string;
-    renameProcedure: (p1: string, p2: string) => void;
-    getProcedureDef: () => ProcedureTuple;
-}
 /**
  * Find all user-created procedure definitions in a workspace.
  *
@@ -46,7 +34,6 @@ export interface ProcedureBlock {
  * @returns Pair of arrays, the first contains procedures without return
  *     variables, the second with. Each procedure is defined by a three-element
  *     list of name, parameter list, and return value boolean.
- * @alias Blockly.Procedures.allProcedures
  */
 export declare function allProcedures(root: Workspace): [
     ProcedureTuple[],
@@ -60,7 +47,6 @@ export declare function allProcedures(root: Workspace): [
  * @param name Proposed procedure name.
  * @param block Block to disambiguate.
  * @returns Non-colliding name.
- * @alias Blockly.Procedures.findLegalName
  */
 export declare function findLegalName(name: string, block: Block): string;
 /**
@@ -71,7 +57,6 @@ export declare function findLegalName(name: string, block: Block): string;
  * @param opt_exclude Optional block to exclude from comparisons (one doesn't
  *     want to collide with oneself).
  * @returns True if the name is used, otherwise return false.
- * @alias Blockly.Procedures.isNameUsed
  */
 export declare function isNameUsed(name: string, workspace: Workspace, opt_exclude?: Block): boolean;
 /**
@@ -79,7 +64,6 @@ export declare function isNameUsed(name: string, workspace: Workspace, opt_exclu
  *
  * @param name The proposed new name.
  * @returns The accepted name.
- * @alias Blockly.Procedures.rename
  */
 export declare function rename(this: Field, name: string): string;
 /**
@@ -87,7 +71,6 @@ export declare function rename(this: Field, name: string): string;
  *
  * @param workspace The workspace containing procedures.
  * @returns Array of XML block elements.
- * @alias Blockly.Procedures.flyoutCategory
  */
 export declare function flyoutCategory(workspace: WorkspaceSvg): Element[];
 /**
@@ -95,7 +78,6 @@ export declare function flyoutCategory(workspace: WorkspaceSvg): Element[];
  * update and adds a mutator change listener to the mutator workspace.
  *
  * @param e The event that triggered this listener.
- * @alias Blockly.Procedures.mutatorOpenListener
  * @internal
  */
 export declare function mutatorOpenListener(e: Abstract): void;
@@ -105,7 +87,6 @@ export declare function mutatorOpenListener(e: Abstract): void;
  * @param name Name of procedure.
  * @param workspace The workspace to find callers in.
  * @returns Array of caller blocks.
- * @alias Blockly.Procedures.getCallers
  */
 export declare function getCallers(name: string, workspace: Workspace): Block[];
 /**
@@ -113,7 +94,6 @@ export declare function getCallers(name: string, workspace: Workspace): Block[];
  * callers.
  *
  * @param defBlock Procedure definition block.
- * @alias Blockly.Procedures.mutateCallers
  */
 export declare function mutateCallers(defBlock: Block): void;
 /**
@@ -122,8 +102,7 @@ export declare function mutateCallers(defBlock: Block): void;
  * @param name Name of procedure.
  * @param workspace The workspace to search.
  * @returns The procedure definition block, or null not found.
- * @alias Blockly.Procedures.getDefinition
  */
 export declare function getDefinition(name: string, workspace: Workspace): Block | null;
-export { ObservableProcedureMap, ObservableProcedureModel, ObservableParameterModel, };
+export { ObservableProcedureMap, IParameterModel, IProcedureBlock, isProcedureBlock, IProcedureMap, IProcedureModel, ProcedureTuple, };
 //# sourceMappingURL=procedures.d.ts.map

package/core/registry.d.ts

@@ -25,14 +25,10 @@ export declare const TEST_ONLY: {
 };
 /**
  * The string used to register the default class for a type of plugin.
- *
- * @alias Blockly.registry.DEFAULT
  */
 export declare const DEFAULT = "default";
 /**
  * A name with the type of the element stored in the generic.
- *
- * @alias Blockly.registry.Type
  */
 export declare class Type<_T> {
     private readonly name;
@@ -71,7 +67,6 @@ export declare class Type<_T> {
  * @throws {Error} if the type or name is empty, a name with the given type has
  *     already been registered, or if the given class or object is not valid for
  *     its type.
- * @alias Blockly.registry.register
  */
 export declare function register<T>(type: string | Type<T>, name: string, registryItem: (new (...p1: any[]) => T) | null | any, opt_allowOverrides?: boolean): void;
 /**
@@ -80,7 +75,6 @@ export declare function register<T>(type: string | Type<T>, name: string, regist
  * @param type The type of the plugin.
  *     (e.g. Field, Renderer)
  * @param name The plugin's name. (Ex. field_angle, geras)
- * @alias Blockly.registry.unregister
  */
 export declare function unregister<T>(type: string | Type<T>, name: string): void;
 /**
@@ -92,7 +86,6 @@ export declare function unregister<T>(type: string | Type<T>, name: string): voi
  * @param name The plugin's name. (Ex. field_angle, geras)
  * @returns True if the registry has an item with the given type and name, false
  *     otherwise.
- * @alias Blockly.registry.hasItem
  */
 export declare function hasItem<T>(type: string | Type<T>, name: string): boolean;
 /**
@@ -104,7 +97,6 @@ export declare function hasItem<T>(type: string | Type<T>, name: string): boolea
  * @param opt_throwIfMissing Whether or not to throw an error if we are unable
  *     to find the plugin.
  * @returns The class with the given name and type or null if none exists.
- * @alias Blockly.registry.getClass
  */
 export declare function getClass<T>(type: string | Type<T>, name: string, opt_throwIfMissing?: boolean): (new (...p1: any[]) => T) | null;
 /**
@@ -116,7 +108,6 @@ export declare function getClass<T>(type: string | Type<T>, name: string, opt_th
  * @param opt_throwIfMissing Whether or not to throw an error if we are unable
  *     to find the object.
  * @returns The object with the given name and type or null if none exists.
- * @alias Blockly.registry.getObject
  */
 export declare function getObject<T>(type: string | Type<T>, name: string, opt_throwIfMissing?: boolean): T | null;
 /**
@@ -128,7 +119,6 @@ export declare function getObject<T>(type: string | Type<T>, name: string, opt_t
  * @param opt_throwIfMissing Whether or not to throw an error if we are unable
  *     to find the object. False by default.
  * @returns A map of objects with the given type, or null if none exists.
- * @alias Blockly.registry.getAllItems
  */
 export declare function getAllItems<T>(type: string | Type<T>, opt_cased?: boolean, opt_throwIfMissing?: boolean): {
     [key: string]: T | null | (new (...p1: any[]) => T);
@@ -142,7 +132,6 @@ export declare function getAllItems<T>(type: string | Type<T>, opt_cased?: boole
  * @param opt_throwIfMissing Whether or not to throw an error if we are unable
  *     to find the plugin.
  * @returns The class for the plugin.
- * @alias Blockly.registry.getClassFromOptions
  */
 export declare function getClassFromOptions<T>(type: Type<T>, options: Options, opt_throwIfMissing?: boolean): (new (...p1: any[]) => T) | null;
 //# sourceMappingURL=registry.d.ts.map

package/core/render_management.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BlockSvg } from './block_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.
+ *
+ * @param block The block to rerender.
+ * @internal
+ */
+export declare function queueRender(block: BlockSvg): void;
+//# sourceMappingURL=render_management.d.ts.map