blockly 9.1.1 → 9.2.0

package/core/insertion_marker_manager.d.ts

@@ -14,49 +14,60 @@ import type { Coordinate } from './utils/coordinate.js';
  * @alias Blockly.InsertionMarkerManager
  */
 export declare class InsertionMarkerManager {
-    private readonly topBlock_;
-    private readonly workspace_;
+    /**
+     * The top block in the stack being dragged.
+     * Does not change during a drag.
+     */
+    private readonly topBlock;
+    /**
+     * The workspace on which these connections are being dragged.
+     * Does not change during a drag.
+     */
+    private readonly workspace;
     /**
      * The last connection on the stack, if it's not the last connection on the
      * first block.
      * Set in initAvailableConnections, if at all.
      */
-    private lastOnStack_;
+    private lastOnStack;
     /**
      * The insertion marker corresponding to the last block in the stack, if
      * that's not the same as the first block in the stack.
      * Set in initAvailableConnections, if at all
      */
-    private lastMarker_;
-    private firstMarker_;
+    private lastMarker;
     /**
-     * The connection that this block would connect to if released immediately.
-     * Updated on every mouse move.
-     * This is not on any of the blocks that are being dragged.
+     * The insertion marker that shows up between blocks to show where a block
+     * would go if dropped immediately.
      */
-    private closestConnection_;
+    private firstMarker;
     /**
-     * The connection that would connect to this.closestConnection_ if this
-     * block were released immediately. Updated on every mouse move. This is on
-     * the top block that is being dragged or the last block in the dragging
-     * stack.
+     * Information about the connection that would be made if the dragging block
+     * were released immediately. Updated on every mouse move.
      */
-    private localConnection_;
+    private activeCandidate;
     /**
      * Whether the block would be deleted if it were dropped immediately.
      * Updated on every mouse move.
+     *
+     * @internal
      */
-    private wouldDeleteBlock_;
+    wouldDeleteBlock: boolean;
     /**
      * Connection on the insertion marker block that corresponds to
-     * this.localConnection_ on the currently dragged block.
+     * the active candidate's local connection on the currently dragged block.
      */
-    private markerConnection_;
+    private markerConnection;
     /** The block that currently has an input being highlighted, or null. */
-    private highlightedBlock_;
+    private highlightedBlock;
     /** The block being faded to indicate replacement, or null. */
-    private fadedBlock_;
-    private availableConnections_;
+    private fadedBlock;
+    /**
+     * The connections on the dragging blocks that are available to connect to
+     * other blocks.  This includes all open connections on the top block, as
+     * well as the last connection on the block stack.
+     */
+    private availableConnections;
     /** @param block The top block in the stack being dragged. */
     constructor(block: BlockSvg);
     /**
@@ -72,14 +83,6 @@ export declare class InsertionMarkerManager {
      * @internal
      */
     updateAvailableConnections(): void;
-    /**
-     * Return whether the block would be deleted if dropped immediately, based on
-     * information from the most recent move event.
-     *
-     * @returns True if the block would be deleted if dropped immediately.
-     * @internal
-     */
-    wouldDeleteBlock(): boolean;
     /**
      * Return whether the block would be connected if dropped immediately, based
      * on information from the most recent move event.
@@ -109,26 +112,26 @@ export declare class InsertionMarkerManager {
      * @param sourceBlock The block that the insertion marker will represent.
      * @returns The insertion marker that represents the given block.
      */
-    private createMarkerBlock_;
+    private createMarkerBlock;
     /**
      * Populate the list of available connections on this block stack.  This
      * should only be called once, at the beginning of a drag. If the stack has
-     * more than one block, this function will populate lastOnStack_ and create
+     * more than one block, this function will populate lastOnStack and create
      * the corresponding insertion marker.
      *
      * @returns A list of available connections.
      */
-    private initAvailableConnections_;
+    private initAvailableConnections;
     /**
      * Whether the previews (insertion marker and replacement marker) should be
      * updated based on the closest candidate and the current drag distance.
      *
-     * @param candidate An object containing a local connection, a closest
-     *     connection, and a radius.  Returned by getCandidate_.
+     * @param newCandidate A new candidate connection that may replace the current
+     *     best candidate.
      * @param dxy Position relative to drag start, in workspace units.
      * @returns Whether the preview should be updated.
      */
-    private shouldUpdatePreviews_;
+    private shouldUpdatePreviews;
     /**
      * Find the nearest valid connection, which may be the same as the current
      * closest connection.
@@ -137,74 +140,88 @@ export declare class InsertionMarkerManager {
      * @returns An object containing a local connection, a closest connection, and
      *     a radius.
      */
-    private getCandidate_;
+    private getCandidate;
     /**
      * Decide the radius at which to start searching for the closest connection.
      *
      * @returns The radius at which to start the search for the closest
      *     connection.
      */
-    private getStartRadius_;
+    private getStartRadius;
     /**
      * Whether ending the drag would delete the block.
      *
-     * @param candidate An object containing a local connection, a closest
-     *     connection, and a radius.
+     * @param newCandidate Whether there is a candidate connection that the
+     *     block could connect to if the drag ended immediately.
      * @param dragTarget The drag target that the block is currently over.
      * @returns Whether dropping the block immediately would delete the block.
      */
-    private shouldDelete_;
+    private shouldDelete;
     /**
      * Show an insertion marker or replacement highlighting during a drag, if
      * needed.
-     * At the beginning of this function, this.localConnection_ and
-     * this.closestConnection_ should both be null.
+     * At the beginning of this function, this.activeConnection should be null.
      *
-     * @param candidate An object containing a local connection, a closest
-     *     connection, and a radius.
+     * @param newCandidate A new candidate connection that may replace the current
+     *     best candidate.
      */
-    private maybeShowPreview_;
+    private maybeShowPreview;
     /**
      * A preview should be shown.  This function figures out if it should be a
      * block highlight or an insertion marker, and shows the appropriate one.
+     *
+     * @param activeCandidate The connection that will be made if the drag ends
+     *     immediately.
      */
-    private showPreview_;
+    private showPreview;
     /**
-     * Show an insertion marker or replacement highlighting during a drag, if
+     * Hide an insertion marker or replacement highlighting during a drag, if
      * needed.
-     * At the end of this function, this.localConnection_ and
-     * this.closestConnection_ should both be null.
+     * At the end of this function, this.activeCandidate will be null.
      *
-     * @param candidate An object containing a local connection, a closest
-     *     connection, and a radius.
+     * @param newCandidate A new candidate connection that may replace the current
+     *     best candidate.
      */
-    private maybeHidePreview_;
+    private maybeHidePreview;
     /**
-     * A preview should be hidden.  This function figures out if it is a block
-     *  highlight or an insertion marker, and hides the appropriate one.
+     * A preview should be hidden. Loop through all possible preview modes
+     * and hide everything.
      */
-    private hidePreview_;
+    private hidePreview;
     /**
      * Shows an insertion marker connected to the appropriate blocks (based on
      * manager state).
+     *
+     * @param activeCandidate The connection that will be made if the drag ends
+     *     immediately.
      */
-    private showInsertionMarker_;
+    private showInsertionMarker;
     /**
      * Disconnects and hides the current insertion marker. Should return the
      * blocks to their original state.
      */
-    private hideInsertionMarker_;
-    /** Shows an outline around the input the closest connection belongs to. */
-    private showInsertionInputOutline_;
+    private hideInsertionMarker;
+    /**
+     * Shows an outline around the input the closest connection belongs to.
+     *
+     * @param activeCandidate The connection that will be made if the drag ends
+     *     immediately.
+     */
+    private showInsertionInputOutline;
     /** Hides any visible input outlines. */
-    private hideInsertionInputOutline_;
+    private hideInsertionInputOutline;
     /**
      * Shows a replacement fade affect on the closest connection's target block
      * (the block that is currently connected to it).
+     *
+     * @param activeCandidate The connection that will be made if the drag ends
+     *     immediately.
+     */
+    private showReplacementFade;
+    /**
+     * Hides/Removes any visible fade affects.
      */
-    private showReplacementFade_;
-    /** Hides/Removes any visible fade affects. */
-    private hideReplacementFade_;
+    private hideReplacementFade;
     /**
      * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
      * or 2 insertion markers.
@@ -225,6 +242,6 @@ export declare namespace InsertionMarkerManager {
         REPLACEMENT_FADE = 2
     }
 }
-export declare type PreviewType = InsertionMarkerManager.PREVIEW_TYPE;
+export type PreviewType = InsertionMarkerManager.PREVIEW_TYPE;
 export declare const PreviewType: typeof InsertionMarkerManager.PREVIEW_TYPE;
 //# sourceMappingURL=insertion_marker_manager.d.ts.map

package/core/interfaces/i_copyable.d.ts

@@ -22,5 +22,5 @@ export declare namespace ICopyable {
         typeCounts: Object | null;
     }
 }
-export declare type CopyData = ICopyable.CopyData;
+export type CopyData = ICopyable.CopyData;
 //# sourceMappingURL=i_copyable.d.ts.map

package/core/interfaces/i_observable.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * An object that fires events optionally.
+ *
+ * @internal
+ */
+export interface IObservable {
+    startPublishing(): void;
+    stopPublishing(): void;
+}
+/**
+ * Type guard for checking if an object fulfills IObservable.
+ *
+ * @internal
+ */
+export declare function isObservable(obj: any): obj is IObservable;
+//# sourceMappingURL=i_observable.d.ts.map

package/core/interfaces/i_parameter_model.d.ts

@@ -3,11 +3,7 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/**
- * The interface for the data model of a procedure parameter.
- *
- * @namespace Blockly.IParameterModel
- */
+import { IProcedureModel } from './i_procedure_model';
 /**
  * A data model for a procedure.
  */
@@ -35,5 +31,7 @@ export interface IParameterModel {
      * over time.
      */
     getId(): string;
+    /** Sets the procedure model this parameter is associated with. */
+    setProcedureModel(model: IProcedureModel): this;
 }
 //# sourceMappingURL=i_parameter_model.d.ts.map

package/core/keyboard_nav/ast_node.d.ts

@@ -262,5 +262,5 @@ export declare namespace ASTNode {
         WORKSPACE = "workspace"
     }
 }
-export declare type Params = ASTNode.Params;
+export type Params = ASTNode.Params;
 //# sourceMappingURL=ast_node.d.ts.map

package/core/metrics_manager.d.ts

@@ -208,9 +208,9 @@ export declare namespace MetricsManager {
         toolboxMetrics: ToolboxMetrics;
     }
 }
-export declare type ToolboxMetrics = MetricsManager.ToolboxMetrics;
-export declare type AbsoluteMetrics = MetricsManager.AbsoluteMetrics;
-export declare type ContainerRegion = MetricsManager.ContainerRegion;
-export declare type FixedEdges = MetricsManager.FixedEdges;
-export declare type UiMetrics = MetricsManager.UiMetrics;
+export type ToolboxMetrics = MetricsManager.ToolboxMetrics;
+export type AbsoluteMetrics = MetricsManager.AbsoluteMetrics;
+export type ContainerRegion = MetricsManager.ContainerRegion;
+export type FixedEdges = MetricsManager.FixedEdges;
+export type UiMetrics = MetricsManager.UiMetrics;
 //# sourceMappingURL=metrics_manager.d.ts.map

package/core/mutator.d.ts

@@ -77,7 +77,7 @@ export declare class Mutator extends Icon {
      *
      * @param e Mouse click event.
      */
-    protected iconClick_(e: MouseEvent): void;
+    protected iconClick_(e: PointerEvent): void;
     /**
      * Create the editor for the mutator's bubble.
      *

package/core/names.d.ts

@@ -131,6 +131,6 @@ export declare namespace Names {
         PROCEDURE = "PROCEDURE"
     }
 }
-export declare type NameType = Names.NameType;
+export type NameType = Names.NameType;
 export declare const NameType: typeof Names.NameType;
 //# sourceMappingURL=names.d.ts.map

package/core/options.d.ts

@@ -25,6 +25,7 @@ export declare class Options {
     maxInstances: {
         [key: string]: number;
     } | null;
+    modalInputs: boolean;
     pathToMedia: string;
     hasCategories: boolean;
     moveOptions: MoveOptions;
@@ -136,8 +137,8 @@ export declare namespace Options {
         wheel: boolean;
     }
 }
-export declare type GridOptions = Options.GridOptions;
-export declare type MoveOptions = Options.MoveOptions;
-export declare type ScrollbarOptions = Options.ScrollbarOptions;
-export declare type ZoomOptions = Options.ZoomOptions;
+export type GridOptions = Options.GridOptions;
+export type MoveOptions = Options.MoveOptions;
+export type ScrollbarOptions = Options.ScrollbarOptions;
+export type ZoomOptions = Options.ZoomOptions;
 //# sourceMappingURL=options.d.ts.map

package/core/procedures/observable_parameter_model.d.ts

@@ -4,12 +4,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { IParameterModel } from '../interfaces/i_parameter_model.js';
+import type { IProcedureModel } from '../interfaces/i_procedure_model';
 import type { VariableModel } from '../variable_model.js';
 import type { Workspace } from '../workspace.js';
 export declare class ObservableParameterModel implements IParameterModel {
     private readonly workspace;
     private id;
     private variable;
+    private shouldFireEvents;
+    private procedureModel;
     constructor(workspace: Workspace, name: string, id?: string);
     /**
      * Sets the name of this parameter to the given name.
@@ -41,5 +44,19 @@ export declare class ObservableParameterModel implements IParameterModel {
     getId(): string;
     /** Returns the variable model associated with the parameter model. */
     getVariableModel(): VariableModel;
+    /**
+     * Tells the parameter model it should fire events.
+     *
+     * @internal
+     */
+    startPublishing(): void;
+    /**
+     * Tells the parameter model it should not fire events.
+     *
+     * @internal
+     */
+    stopPublishing(): void;
+    /** Sets the procedure model this parameter is a part of. */
+    setProcedureModel(model: IProcedureModel): this;
 }
 //# sourceMappingURL=observable_parameter_model.d.ts.map

package/core/procedures/observable_procedure_map.d.ts

@@ -3,9 +3,9 @@
  * 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';
 export declare class ObservableProcedureMap extends Map<string, IProcedureModel> implements IProcedureMap {
     private readonly workspace;
     constructor(workspace: Workspace);

package/core/procedures/observable_procedure_model.d.ts

@@ -13,6 +13,7 @@ export declare class ObservableProcedureModel implements IProcedureModel {
     private parameters;
     private returnTypes;
     private enabled;
+    private shouldFireEvents;
     constructor(workspace: Workspace, name: string, id?: string);
     /** Sets the human-readable name of the procedure. */
     setName(name: string): this;
@@ -58,5 +59,17 @@ export declare class ObservableProcedureModel implements IProcedureModel {
      * disabled, all procedure caller blocks should be disabled as well.
      */
     getEnabled(): boolean;
+    /**
+     * Tells the procedure model it should fire events.
+     *
+     * @internal
+     */
+    startPublishing(): void;
+    /**
+     * Tells the procedure model it should not fire events.
+     *
+     * @internal
+     */
+    stopPublishing(): void;
 }
 //# sourceMappingURL=observable_procedure_model.d.ts.map

package/core/procedures.d.ts

@@ -28,7 +28,7 @@ export declare const CATEGORY_NAME = "PROCEDURE";
  * @alias Blockly.Procedures.DEFAULT_ARG
  */
 export declare const DEFAULT_ARG = "x";
-export declare type ProcedureTuple = [string, string[], boolean];
+export type ProcedureTuple = [string, string[], boolean];
 /**
  * Procedure block type.
  *

package/core/registry.d.ts

@@ -47,7 +47,7 @@ export declare class Type<_T> {
     static CONNECTION_CHECKER: Type<IConnectionChecker>;
     static CURSOR: Type<Cursor>;
     static EVENT: Type<Abstract>;
-    static FIELD: Type<Field>;
+    static FIELD: Type<Field<any>>;
     static RENDERER: Type<Renderer>;
     static TOOLBOX: Type<IToolbox>;
     static THEME: Type<Theme>;

package/core/rendered_connection.d.ts

@@ -208,6 +208,6 @@ export declare namespace RenderedConnection {
         TRACKED = 1
     }
 }
-export declare type TrackedState = RenderedConnection.TrackedState;
+export type TrackedState = RenderedConnection.TrackedState;
 export declare const TrackedState: typeof RenderedConnection.TrackedState;
 //# sourceMappingURL=rendered_connection.d.ts.map

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

@@ -51,13 +51,13 @@ export interface JaggedTeeth {
     width: number;
     path: string;
 }
-export declare type BaseShape = {
+export type BaseShape = {
     type: number;
     width: number;
     height: number;
 };
 /** An object containing sizing and type information about a dynamic shape. */
-export declare type DynamicShape = {
+export type DynamicShape = {
     type: number;
     width: (p1: number) => number;
     height: (p1: number) => number;
@@ -70,7 +70,7 @@ export declare type DynamicShape = {
     pathRightUp: (p1: number) => string;
 };
 /** An object containing sizing and type information about a shape. */
-export declare type Shape = BaseShape | DynamicShape;
+export type Shape = BaseShape | DynamicShape;
 /**
  * Returns whether the shape is dynamic or not.
  *

package/core/serialization/procedures.d.ts

@@ -33,7 +33,7 @@ export interface ParameterState {
  * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
  * for what is going on with this.
  */
-declare type ProcedureModelConstructor<ProcedureModel extends IProcedureModel> = new (workspace: Workspace, name: string, id: string) => ProcedureModel;
+type ProcedureModelConstructor<ProcedureModel extends IProcedureModel> = new (workspace: Workspace, name: string, id: string) => ProcedureModel;
 /**
  * A newable signature for an IParameterModel.
  *
@@ -41,7 +41,31 @@ declare type ProcedureModelConstructor<ProcedureModel extends IProcedureModel> =
  * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
  * for what is going on with this.
  */
-declare type ParameterModelConstructor<ParameterModel extends IParameterModel> = new (workspace: Workspace, name: string, id: string) => ParameterModel;
+type ParameterModelConstructor<ParameterModel extends IParameterModel> = new (workspace: Workspace, name: string, id: string) => ParameterModel;
+/**
+ * Serializes the given IProcedureModel to JSON.
+ *
+ * @internal
+ */
+export declare function saveProcedure(proc: IProcedureModel): State;
+/**
+ * Serializes the given IParameterModel to JSON.
+ *
+ * @internal
+ */
+export declare function saveParameter(param: IParameterModel): ParameterState;
+/**
+ * Deserializes the given procedure model State from JSON.
+ *
+ * @internal
+ */
+export declare function loadProcedure<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel>(procedureModelClass: ProcedureModelConstructor<ProcedureModel>, parameterModelClass: ParameterModelConstructor<ParameterModel>, state: State, workspace: Workspace): ProcedureModel;
+/**
+ * Deserializes the given ParameterState from JSON.
+ *
+ * @internal
+ */
+export declare function loadParameter<ParameterModel extends IParameterModel>(parameterModelClass: ParameterModelConstructor<ParameterModel>, state: ParameterState, workspace: Workspace): ParameterModel;
 /** Serializer for saving and loading procedure state. */
 export declare class ProcedureSerializer<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel> implements ISerializer {
     private readonly procedureModelClass;

package/core/shortcut_registry.d.ts

@@ -163,5 +163,5 @@ export declare namespace ShortcutRegistry {
         Meta = 91
     }
 }
-export declare type KeyboardShortcut = ShortcutRegistry.KeyboardShortcut;
+export type KeyboardShortcut = ShortcutRegistry.KeyboardShortcut;
 //# sourceMappingURL=shortcut_registry.d.ts.map

package/core/theme.d.ts

@@ -146,8 +146,8 @@ export declare namespace Theme {
         size?: number;
     }
 }
-export declare type BlockStyle = Theme.BlockStyle;
-export declare type CategoryStyle = Theme.CategoryStyle;
-export declare type ComponentStyle = Theme.ComponentStyle;
-export declare type FontStyle = Theme.FontStyle;
+export type BlockStyle = Theme.BlockStyle;
+export type CategoryStyle = Theme.CategoryStyle;
+export type ComponentStyle = Theme.ComponentStyle;
+export type FontStyle = Theme.FontStyle;
 //# sourceMappingURL=theme.d.ts.map

package/core/theme_manager.d.ts

@@ -86,5 +86,5 @@ export declare namespace ThemeManager {
         propertyName: string;
     }
 }
-export declare type Component = ThemeManager.Component;
+export type Component = ThemeManager.Component;
 //# sourceMappingURL=theme_manager.d.ts.map

package/core/toolbox/category.d.ts

@@ -263,5 +263,5 @@ export declare namespace ToolboxCategory {
         closedicon?: string;
     }
 }
-export declare type CssConfig = ToolboxCategory.CssConfig;
+export type CssConfig = ToolboxCategory.CssConfig;
 //# sourceMappingURL=category.d.ts.map

package/core/toolbox/collapsible_category.d.ts

@@ -94,5 +94,5 @@ export declare namespace CollapsibleToolboxCategory {
         contents: string | null;
     }
 }
-export declare type CssConfig = CollapsibleToolboxCategory.CssConfig;
+export type CssConfig = CollapsibleToolboxCategory.CssConfig;
 //# sourceMappingURL=collapsible_category.d.ts.map

package/core/toolbox/separator.d.ts

@@ -38,5 +38,5 @@ export declare namespace ToolboxSeparator {
         container: string | undefined;
     }
 }
-export declare type CssConfig = ToolboxSeparator.CssConfig;
+export type CssConfig = ToolboxSeparator.CssConfig;
 //# sourceMappingURL=separator.d.ts.map

package/core/toolbox/toolbox.d.ts

@@ -107,7 +107,7 @@ export declare class Toolbox extends DeleteArea implements IAutoHideable, IKeybo
      *
      * @param e Click event to handle.
      */
-    protected onClick_(e: MouseEvent): void;
+    protected onClick_(e: PointerEvent): void;
     /**
      * Handles key down events for the toolbox.
      *

package/core/tooltip.d.ts

@@ -11,7 +11,7 @@
  *
  * @alias Blockly.Tooltip.TipInfo
  */
-export declare type TipInfo = string | {
+export type TipInfo = string | {
     tooltip: any;
 } | (() => TipInfo | string | Function);
 /**
@@ -22,7 +22,7 @@ export declare type TipInfo = string | {
  *
  * @alias Blockly.Tooltip.CustomTooltip
  */
-export declare type CustomTooltip = (p1: Element, p2: Element) => any;
+export type CustomTooltip = (p1: Element, p2: Element) => any;
 /**
  * Sets a custom function that will be called if present instead of the default
  * tooltip UI.