blockly 9.0.1 → 9.1.0-beta.0

package/core/interfaces/i_procedure_map.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IProcedureModel } from './i_procedure_model.js';
+export interface IProcedureMap extends Map<string, IProcedureModel> {
+    /**
+     * Adds the given ProcedureModel to the map of procedure models, so that
+     * blocks can find it.
+     */
+    add(proc: IProcedureModel): this;
+    /** Returns all of the procedures stored in this map. */
+    getProcedures(): IProcedureModel[];
+}
+//# sourceMappingURL=i_procedure_map.d.ts.map

package/core/menu.d.ts

@@ -18,7 +18,7 @@ export declare class Menu {
      * (Nulls are never in the array, but typing the array as nullable prevents
      * the compiler from objecting to .indexOf(null))
      */
-    private readonly menuItems_;
+    private readonly menuItems;
     /**
      * Coordinates of the mousedown event that caused this menu to open. Used to
      * prevent the consequent mouseup event due to a simple click from
@@ -29,21 +29,21 @@ export declare class Menu {
      * This is the element that we will listen to the real focus events on.
      * A value of null means no menu item is highlighted.
      */
-    private highlightedItem_;
+    private highlightedItem;
     /** Mouse over event data. */
-    private mouseOverHandler_;
+    private mouseOverHandler;
     /** Click event data. */
-    private clickHandler_;
+    private clickHandler;
     /** Mouse enter event data. */
-    private mouseEnterHandler_;
+    private mouseEnterHandler;
     /** Mouse leave event data. */
-    private mouseLeaveHandler_;
+    private mouseLeaveHandler;
     /** Key down event data. */
-    private onKeyDownHandler_;
+    private onKeyDownHandler;
     /** The menu's root DOM element. */
-    private element_;
+    private element;
     /** ARIA name for this menu. */
-    private roleName_;
+    private roleName;
     /** Constructs a new Menu instance. */
     constructor();
     /**
@@ -74,7 +74,7 @@ export declare class Menu {
      */
     focus(): void;
     /** Blur the menu element. */
-    private blur_;
+    private blur;
     /**
      * Set the menu accessibility role.
      *
@@ -91,7 +91,7 @@ export declare class Menu {
      * @param elem DOM element whose owner is to be returned.
      * @returns Menu item for which the DOM element belongs to.
      */
-    private getMenuItem_;
+    private getMenuItem;
     /**
      * Highlights the given menu item, or clears highlighting if null.
      *
@@ -114,9 +114,9 @@ export declare class Menu {
      */
     highlightPrevious(): void;
     /** Highlights the first highlightable item. */
-    private highlightFirst_;
+    private highlightFirst;
     /** Highlights the last highlightable item. */
-    private highlightLast_;
+    private highlightLast;
     /**
      * Helper function that manages the details of moving the highlight among
      * child menuitems in response to keyboard events.
@@ -124,31 +124,31 @@ export declare class Menu {
      * @param startIndex Start index.
      * @param delta Step direction: 1 to go down, -1 to go up.
      */
-    private highlightHelper_;
+    private highlightHelper;
     /**
      * Handles mouseover events. Highlight menuitems as the user hovers over them.
      *
      * @param e Mouse event to handle.
      */
-    private handleMouseOver_;
+    private handleMouseOver;
     /**
      * Handles click events. Pass the event onto the child menuitem to handle.
      *
      * @param e Click event to handle.
      */
-    private handleClick_;
+    private handleClick;
     /**
      * Handles mouse enter events. Focus the element.
      *
      * @param _e Mouse event to handle.
      */
-    private handleMouseEnter_;
+    private handleMouseEnter;
     /**
      * Handles mouse leave events. Blur and clear highlight.
      *
      * @param _e Mouse event to handle.
      */
-    private handleMouseLeave_;
+    private handleMouseLeave;
     /**
      * Attempts to handle a keyboard event, if the menu item is enabled, by
      * calling
@@ -156,7 +156,7 @@ export declare class Menu {
      *
      * @param e Key event to handle.
      */
-    private handleKeyEvent_;
+    private handleKeyEvent;
     /**
      * Get the size of a rendered menu.
      *

package/core/menuitem.d.ts

@@ -13,21 +13,21 @@ export declare class MenuItem {
     private readonly content;
     private readonly opt_value?;
     /** Is the menu item clickable, as opposed to greyed-out. */
-    private enabled_;
+    private enabled;
     /** The DOM element for the menu item. */
-    private element_;
+    private element;
     /** Whether the menu item is rendered right-to-left. */
-    private rightToLeft_;
+    private rightToLeft;
     /** ARIA name for this menu. */
-    private roleName_;
+    private roleName;
     /** Is this menu item checkable. */
-    private checkable_;
+    private checkable;
     /** Is this menu item currently checked. */
-    private checked_;
+    private checked;
     /** Is this menu item currently highlighted. */
-    private highlight_;
+    private highlight;
     /** Bound function to call when this menu item is clicked. */
-    private actionHandler_;
+    private actionHandler;
     /**
      * @param content Text caption to display as the content of the item, or a
      *     HTML element to display.

package/core/mutator.d.ts

@@ -17,33 +17,33 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * @alias Blockly.Mutator
  */
 export declare class Mutator extends Icon {
-    private quarkNames_;
+    private quarkNames;
     /** Workspace in the mutator's bubble. */
-    private workspace_;
+    private workspace;
     /** Width of workspace. */
-    private workspaceWidth_;
+    private workspaceWidth;
     /** Height of workspace. */
-    private workspaceHeight_;
+    private workspaceHeight;
     /**
      * The SVG element that is the parent of the mutator workspace, or null if
      * not created.
      */
-    private svgDialog_;
+    private svgDialog;
     /**
      * The root block of the mutator workspace, created by decomposing the
      * source block.
      */
-    private rootBlock_;
+    private rootBlock;
     /**
      * Function registered on the main workspace to update the mutator contents
      * when the main workspace changes.
      */
-    private sourceListener_;
+    private sourceListener;
     /**
      * The PID associated with the updateWorkpace_ timeout, or null if no timeout
      * is currently running.
      */
-    private updateWorkspacePid_;
+    private updateWorkspacePid;
     /** @param quarkNames List of names of sub-blocks for flyout. */
     constructor(quarkNames: string[], block?: BlockSvg);
     /**
@@ -79,7 +79,7 @@ export declare class Mutator extends Icon {
      *
      * @returns The top-level node of the editor.
      */
-    private createEditor_;
+    private createEditor;
     /**
      * @internal
      */
@@ -87,9 +87,9 @@ export declare class Mutator extends Icon {
     /** Add or remove the UI indicating if this icon may be clicked or not. */
     updateEditable(): void;
     /** Resize the bubble to match the size of the workspace. */
-    private resizeBubble_;
+    private resizeBubble;
     /** A method handler for when the bubble is moved. */
-    private onBubbleMove_;
+    private onBubbleMove;
     /**
      * Show or hide the mutator bubble.
      *
@@ -101,7 +101,7 @@ export declare class Mutator extends Icon {
      *
      * @param e Custom data for event.
      */
-    private workspaceChanged_;
+    private workspaceChanged;
     /**
      * Returns whether the given event in the mutator workspace should be ignored
      * when deciding whether to update the workspace and compose the block or not.
@@ -114,7 +114,7 @@ export declare class Mutator extends Icon {
      * Updates the source block when the mutator's blocks are changed.
      * Bump down any block that's too high.
      */
-    private updateWorkspace_;
+    private updateWorkspace;
     /** Dispose of this mutator. */
     dispose(): void;
     /** Update the styles on all blocks in the mutator. */

package/core/procedures/observable_parameter_model.d.ts

@@ -19,8 +19,19 @@ export declare class ObservableParameterModel implements IParameterModel {
      * Unimplemented. The built-in ParameterModel does not support typing.
      * If you want your procedure blocks to have typed parameters, you need to
      * implement your own ParameterModel.
+     *
+     * @throws Throws for the ObservableParameterModel specifically because this
+     *     method is unimplemented.
      */
     setTypes(_types: string[]): this;
+    /**
+     * Returns the name of this parameter.
+     */
+    getName(): string;
+    /**
+     * Returns the types of this parameter.
+     */
+    getTypes(): string[];
     /**
      * Returns the unique language-neutral ID for the parameter.
      *

package/core/procedures/observable_procedure_map.d.ts

@@ -5,7 +5,8 @@
  */
 import type { IProcedureModel } from '../interfaces/i_procedure_model.js';
 import type { Workspace } from '../workspace.js';
-export declare class ObservableProcedureMap extends Map<string, IProcedureModel> {
+import { IProcedureMap } from '../interfaces/i_procedure_map.js';
+export declare class ObservableProcedureMap extends Map<string, IProcedureModel> implements IProcedureMap {
     private readonly workspace;
     constructor(workspace: Workspace);
     /**
@@ -26,5 +27,9 @@ export declare class ObservableProcedureMap extends Map<string, IProcedureModel>
      * blocks can find it.
      */
     add(proc: IProcedureModel): this;
+    /**
+     * Returns all of the procedures stored in this map.
+     */
+    getProcedures(): IProcedureModel[];
 }
 //# sourceMappingURL=observable_procedure_map.d.ts.map

package/core/procedures/observable_procedure_model.d.ts

@@ -13,7 +13,7 @@ export declare class ObservableProcedureModel implements IProcedureModel {
     private parameters;
     private returnTypes;
     private enabled;
-    constructor(workspace: Workspace, id?: string);
+    constructor(workspace: Workspace, name: string, id?: string);
     /** Sets the human-readable name of the procedure. */
     setName(name: string): this;
     /**
@@ -25,9 +25,13 @@ export declare class ObservableProcedureModel implements IProcedureModel {
     /** Removes the parameter at the given index from the parameter list. */
     deleteParameter(index: number): this;
     /**
-     * Sets the return type(s) of the procedure.
+     * Sets whether the procedure has a return value (empty array) or no return
+     * value (null).
      *
-     * Pass null to represent a procedure that does not return.
+     * The built-in procedure model does not support procedures that have actual
+     * return types (i.e. non-empty arrays, e.g. ['number']). If you want your
+     * procedure block to have return types, you need to implement your own
+     * procedure model.
      */
     setReturnTypes(types: string[] | null): this;
     /**

package/core/procedures/update_procedures.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Workspace } from '../workspace.js';
+/**
+ * Calls the `doProcedureUpdate` method on all blocks which implement it.
+ *
+ * @internal
+ */
+export declare function triggerProceduresUpdate(workspace: Workspace): void;
+//# sourceMappingURL=update_procedures.d.ts.map

package/core/procedures.d.ts

@@ -7,6 +7,9 @@ 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 type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
@@ -122,4 +125,5 @@ export declare function mutateCallers(defBlock: Block): void;
  * @alias Blockly.Procedures.getDefinition
  */
 export declare function getDefinition(name: string, workspace: Workspace): Block | null;
+export { ObservableProcedureMap, ObservableProcedureModel, ObservableParameterModel, };
 //# sourceMappingURL=procedures.d.ts.map

package/core/rendered_connection.d.ts

@@ -177,7 +177,7 @@ export declare class RenderedConnection extends Connection {
      * @returns List of connections.
      * @internal
      */
-    neighbours(maxLimit: number): Connection[];
+    neighbours(maxLimit: number): RenderedConnection[];
     /**
      * Connect two connections together.  This is the connection on the superior
      * block.  Rerender blocks as needed.

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

@@ -393,12 +393,7 @@ export declare class ConstantProvider {
      * @param blockStyle A full or partial block style object.
      * @returns A full block style object, with all required properties populated.
      */
-    protected validatedBlockStyle_(blockStyle: {
-        colourPrimary: string;
-        colourSecondary?: string;
-        colourTertiary?: string;
-        hat?: string;
-    }): BlockStyle;
+    protected validatedBlockStyle_(blockStyle: Partial<BlockStyle>): BlockStyle;
     /**
      * Generate a secondary colour from the passed in primary colour.
      *

package/core/scrollbar.d.ts

@@ -33,17 +33,28 @@ export declare class Scrollbar {
      * @internal
      */
     static readonly DEFAULT_SCROLLBAR_MARGIN = 0.5;
-    private readonly pair_;
-    private readonly margin_;
+    /** Whether this scrollbar is part of a pair. */
+    private readonly pair;
+    /**
+     * Margin around the scrollbar (between the scrollbar and the edge of the
+     * viewport in pixels).
+     */
+    private readonly margin;
     /** Previously recorded metrics from the workspace. */
-    private oldHostMetrics_;
+    private oldHostMetrics;
     /**
      * The ratio of handle position offset to workspace content displacement.
      *
      * @internal
      */
     ratio: number;
-    private origin_;
+    /**
+     * The location of the origin of the workspace that the scrollbar is in,
+     * measured in CSS pixels relative to the injection div origin.  This is
+     * usually (0, 0).  When the scrollbar is in a flyout it may have a
+     * different origin.
+     */
+    private origin;
     /**
      * The position of the mouse along this scrollbar's major axis at the start
      * of the most recent drag. Units are CSS pixels, with (0, 0) at the top
@@ -51,35 +62,56 @@ export declare class Scrollbar {
      * coordinate of the mouse down event; for a vertical scrollbar it's the y
      * coordinate of the mouse down event.
      */
-    private startDragMouse_;
+    private startDragMouse;
     /**
      * The length of the scrollbars (including the handle and the background),
      * in CSS pixels. This is equivalent to scrollbar background length and the
      * area within which the scrollbar handle can move.
      */
-    private scrollbarLength_;
+    private scrollbarLength;
     /** The length of the scrollbar handle in CSS pixels. */
-    private handleLength_;
+    private handleLength;
     /**
      * The offset of the start of the handle from the scrollbar position, in CSS
      * pixels.
      */
-    private handlePosition_;
+    private handlePosition;
     private startDragHandle;
     /** Whether the scrollbar handle is visible. */
-    private isVisible_;
+    private isHandleVisible;
     /** Whether the workspace containing this scrollbar is visible. */
-    private containerVisible_;
-    private svgBackground_;
-    private svgHandle_;
-    private outerSvg_;
-    private svgGroup_;
+    private containerVisible;
+    /** The transparent background behind the handle. */
+    private svgBackground;
+    /** The visible handle that can be dragged around. */
+    private svgHandle;
+    /** The outermost SVG element, which contains all parts of the scrollbar. */
+    private outerSvg;
+    /**
+     * The upper left corner of the scrollbar's SVG group in CSS pixels relative
+     * to the scrollbar's origin.  This is usually relative to the injection div
+     * origin.
+     *
+     * @internal
+     */
     position: Coordinate;
+    /**
+     * The DOM attribute that controls the length of the scrollbar. Different
+     * for horizontal and vertical scrollbars.
+     */
     lengthAttribute_: string;
+    /**
+     * The DOM attribute that controls the position of the scrollbar.
+     * Different for horizontal and vertical scrollbars.
+     */
     positionAttribute_: string;
-    onMouseDownBarWrapper_: browserEvents.Data | null;
-    onMouseDownHandleWrapper_: browserEvents.Data | null;
+    /** Handler for mouse down events on the background of the scrollbar. */
+    onMouseDownBarWrapper_: browserEvents.Data;
+    /** Handler for mouse down events on the handle of the scrollbar. */
+    onMouseDownHandleWrapper_: browserEvents.Data;
+    /** Handler for mouse move events during scrollbar drags. */
     onMouseUpWrapper_: browserEvents.Data | null;
+    /** Handler for mouse up events to end scrollbar drags. */
     onMouseMoveWrapper_: browserEvents.Data | null;
     /**
      * @param workspace Workspace to bind the scrollbar to.
@@ -90,8 +122,12 @@ export declare class Scrollbar {
      */
     constructor(workspace: WorkspaceSvg, horizontal: boolean, opt_pair?: boolean, opt_class?: string, opt_margin?: number);
     /**
-     * Dispose of this scrollbar.
-     * Unlink from all DOM elements to prevent memory leaks.
+     * Set the size of the scrollbar DOM elements along the minor axis.
+     */
+    private setInitialThickness;
+    /**
+     * Dispose of this scrollbar. Remove DOM elements, event listeners,
+     * and theme subscriptions.
      *
      * @suppress {checkTypes}
      */
@@ -103,14 +139,14 @@ export declare class Scrollbar {
      * @param value Value that is potentially out of bounds, in CSS pixels.
      * @returns Constrained value, in CSS pixels.
      */
-    private constrainHandleLength_;
+    private constrainHandleLength;
     /**
      * Set the length of the scrollbar's handle and change the SVG attribute
      * accordingly.
      *
      * @param newLength The new scrollbar handle length in CSS pixels.
      */
-    private setHandleLength_;
+    private setHandleLength;
     /**
      * Constrain the handle's position within the minimum (0) and maximum values
      * allowed for the scrollbar.
@@ -118,7 +154,7 @@ export declare class Scrollbar {
      * @param value Value that is potentially out of bounds, in CSS pixels.
      * @returns Constrained value, in CSS pixels.
      */
-    private constrainHandlePosition_;
+    private constrainHandlePosition;
     /**
      * Set the offset of the scrollbar's handle from the scrollbar's position, and
      * change the SVG attribute accordingly.
@@ -132,7 +168,7 @@ export declare class Scrollbar {
      *
      * @param newSize The new scrollbar background length in CSS pixels.
      */
-    private setScrollbarLength_;
+    private setScrollbarLength;
     /**
      * Set the position of the scrollbar's SVG group in CSS pixels relative to the
      * scrollbar's origin.  This sets the scrollbar's location within the
@@ -158,14 +194,14 @@ export declare class Scrollbar {
      *     possibly fetched from the host object.
      * @returns Whether a resizeView is necessary.
      */
-    private requiresViewResize_;
+    private requiresViewResize;
     /**
      * Recalculate a horizontal scrollbar's location and length.
      *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
-    private resizeHorizontal_;
+    private resizeHorizontal;
     /**
      * Recalculate a horizontal scrollbar's location on the screen and path
      * length. This should be called when the layout or size of the window has
@@ -189,7 +225,7 @@ export declare class Scrollbar {
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
-    private resizeVertical_;
+    private resizeVertical;
     /**
      * Recalculate a vertical scrollbar's location on the screen and path length.
      * This should be called when the layout or size of the window has changed.
@@ -206,13 +242,6 @@ export declare class Scrollbar {
      *     possibly fetched from the host object.
      */
     resizeContentVertical(hostMetrics: Metrics): void;
-    /**
-     * Create all the DOM elements required for a scrollbar.
-     * The resulting widget is not sized.
-     *
-     * @param opt_class A class to be applied to this scrollbar.
-     */
-    private createDom_;
     /**
      * Is the scrollbar visible.  Non-paired scrollbars disappear when they aren't
      * needed.
@@ -247,27 +276,27 @@ export declare class Scrollbar {
      *
      * @param e Mouse down event.
      */
-    private onMouseDownBar_;
+    private onMouseDownBar;
     /**
      * Start a dragging operation.
      * Called when scrollbar handle is clicked.
      *
      * @param e Mouse down event.
      */
-    private onMouseDownHandle_;
+    private onMouseDownHandle;
     /**
      * Drag the scrollbar's handle.
      *
      * @param e Mouse move event.
      */
-    private onMouseMoveHandle_;
+    private onMouseMoveHandle;
     /** Release the scrollbar handle and reset state accordingly. */
-    private onMouseUpHandle_;
+    private onMouseUpHandle;
     /**
      * Hide chaff and stop binding to mouseup and mousemove events.  Call this to
      * wrap up loose ends associated with the scrollbar.
      */
-    private cleanUp_;
+    private cleanUp;
     /**
      * Helper to calculate the ratio of handle position to scrollbar view size.
      *
@@ -279,7 +308,7 @@ export declare class Scrollbar {
      * Updates workspace metrics based on new scroll ratio. Called when scrollbar
      * is moved.
      */
-    private updateMetrics_;
+    private updateMetrics;
     /**
      * Set the scrollbar handle's position.
      *
@@ -304,6 +333,6 @@ export declare class Scrollbar {
      *     workspace.
      * @returns Whether the two sets of metrics are equivalent.
      */
-    private static metricsAreEquivalent_;
+    private static metricsAreEquivalent;
 }
 //# sourceMappingURL=scrollbar.d.ts.map

package/core/serialization/blocks.d.ts

@@ -5,6 +5,7 @@
  */
 import type { Block } from '../block.js';
 import type { Connection } from '../connection.js';
+import type { ISerializer } from '../interfaces/i_serializer.js';
 import type { Workspace } from '../workspace.js';
 /**
  * Represents the state of a connection.
@@ -101,4 +102,41 @@ export declare function appendInternal(state: State, workspace: Workspace, { par
     isShadow?: boolean;
     recordUndo?: boolean;
 }): Block;
+/**
+ * Serializer for saving and loading block state.
+ *
+ * @alias Blockly.serialization.blocks.BlockSerializer
+ */
+export declare class BlockSerializer implements ISerializer {
+    priority: number;
+    constructor();
+    /**
+     * Serializes the blocks of the given workspace.
+     *
+     * @param workspace The workspace to save the blocks of.
+     * @returns The state of the workspace's blocks, or null if there are no
+     *     blocks.
+     */
+    save(workspace: Workspace): {
+        languageVersion: number;
+        blocks: State[];
+    } | null;
+    /**
+     * Deserializes the blocks defined by the given state into the given
+     * workspace.
+     *
+     * @param state The state of the blocks to deserialize.
+     * @param workspace The workspace to deserialize into.
+     */
+    load(state: {
+        languageVersion: number;
+        blocks: State[];
+    }, workspace: Workspace): void;
+    /**
+     * Disposes of any blocks that exist on the workspace.
+     *
+     * @param workspace The workspace to clear the blocks of.
+     */
+    clear(workspace: Workspace): void;
+}
 //# sourceMappingURL=blocks.d.ts.map

package/core/serialization/priorities.d.ts

@@ -9,6 +9,10 @@
  * @alias Blockly.serialization.priorities.VARIABLES
  */
 export declare const VARIABLES = 100;
+/**
+ * The priority for deserializing variable data.
+ */
+export declare const PROCEDURES = 75;
 /**
  * The priority for deserializing blocks.
  *