blockly 9.3.2 → 10.0.0-beta.0

package/core/interfaces/i_serializable.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export interface ISerializable {
+    /**
+     * @param doFullSerialization If true, this signals that any backing data
+     *     structures used by this ISerializable should also be serialized. This
+     *     is used for copy-paste.
+     * @returns a JSON serializable value that records the ISerializable's state.
+     */
+    saveState(doFullSerialization: boolean): any;
+    /**
+     * Takes in a JSON serializable value and sets the ISerializable's state
+     * based on that.
+     *
+     * @param state The state to apply to the ISerializable.
+     */
+    loadState(state: any): void;
+}
+/** Type guard that checks whether the given object is a ISerializable. */
+export declare function isSerializable(obj: any): obj is ISerializable;
+//# sourceMappingURL=i_serializable.d.ts.map

package/core/keyboard_nav/ast_node.d.ts

@@ -6,7 +6,7 @@
 import type { Block } from '../block.js';
 import type { Connection } from '../connection.js';
 import type { Field } from '../field.js';
-import type { Input } from '../input.js';
+import type { Input } from '../inputs/input.js';
 import type { IASTNodeLocation } from '../interfaces/i_ast_node_location.js';
 import { Coordinate } from '../utils/coordinate.js';
 import type { Workspace } from '../workspace.js';
@@ -25,11 +25,11 @@ export declare class ASTNode {
      * workspace.
      */
     private static readonly DEFAULT_OFFSET_Y;
-    private readonly type_;
-    private readonly isConnection_;
-    private readonly location_;
+    private readonly type;
+    private readonly isConnectionLocation;
+    private readonly location;
     /** The coordinate on the workspace. */
-    private wsCoordinate_;
+    private wsCoordinate;
     /**
      * @param type The type of the location.
      *     Must be in ASTNode.types.
@@ -42,7 +42,7 @@ export declare class ASTNode {
      *
      * @param params The user specified parameters.
      */
-    private processParams_;
+    private processParams;
     /**
      * Gets the value pointed to by this node.
      * It is the callers responsibility to check the node type to figure out what
@@ -81,7 +81,7 @@ export declare class ASTNode {
      * @returns The AST node holding the next field or connection or null if there
      *     is no editable field or input connection after the given input.
      */
-    private findNextForInput_;
+    private findNextForInput;
     /**
      * Given a field find the next editable field or an input with a non null
      * connection in the same block. The current location must be a field.
@@ -89,7 +89,7 @@ export declare class ASTNode {
      * @returns The AST node pointing to the next field or connection or null if
      *     there is no editable field or input connection after the given input.
      */
-    private findNextForField_;
+    private findNextForField;
     /**
      * Given an input find the previous editable field or an input with a non null
      * connection in the same block. The current location must be an input
@@ -97,14 +97,14 @@ export declare class ASTNode {
      *
      * @returns The AST node holding the previous field or connection.
      */
-    private findPrevForInput_;
+    private findPrevForInput;
     /**
      * Given a field find the previous editable field or an input with a non null
      * connection in the same block. The current location must be a field.
      *
      * @returns The AST node holding the previous input or field.
      */
-    private findPrevForField_;
+    private findPrevForField;
     /**
      * Navigate between stacks of blocks on the workspace.
      *
@@ -112,7 +112,7 @@ export declare class ASTNode {
      * @returns The first block of the next stack or null if there are no blocks
      *     on the workspace.
      */
-    private navigateBetweenStacks_;
+    private navigateBetweenStacks;
     /**
      * Finds the top most AST node for a given block.
      * This is either the previous connection, output connection or block
@@ -121,7 +121,7 @@ export declare class ASTNode {
      * @param block The block that we want to find the top connection on.
      * @returns The AST node containing the top connection.
      */
-    private findTopASTNodeForBlock_;
+    private findTopASTNodeForBlock;
     /**
      * Get the AST node pointing to the input that the block is nested under or if
      * the block is not nested then get the stack AST node.
@@ -130,7 +130,7 @@ export declare class ASTNode {
      * @returns The AST node pointing to the input connection or the top block of
      *     the stack this block is in.
      */
-    private getOutAstNodeForBlock_;
+    private getOutAstNodeForBlock;
     /**
      * Find the first editable field or input with a connection on a given block.
      *
@@ -139,7 +139,7 @@ export declare class ASTNode {
      * Null if there are no editable fields or inputs with connections on the
      * block.
      */
-    private findFirstFieldOrInput_;
+    private findFirstFieldOrInput;
     /**
      * Finds the source block of the location of this node.
      *
@@ -183,7 +183,7 @@ export declare class ASTNode {
      * @param type The type to check.  One of ASTNode.types.
      * @returns True if a node of the given type points to a connection.
      */
-    private static isConnectionType_;
+    private static isConnectionType;
     /**
      * Create an AST node pointing to a field.
      *

package/core/keyboard_nav/basic_cursor.d.ts

@@ -83,7 +83,7 @@ export declare class BasicCursor extends Cursor {
      * @param node The current position in the AST.
      * @returns The parent AST node or null if there are no valid parents.
      */
-    private findSiblingOrParent_;
+    private findSiblingOrParent;
     /**
      * Get the right most child of a node.
      *
@@ -91,6 +91,6 @@ export declare class BasicCursor extends Cursor {
      * @returns The right most child of the given node, or the node if no child
      *     exists.
      */
-    private getRightMostChild_;
+    private getRightMostChild;
 }
 //# sourceMappingURL=basic_cursor.d.ts.map

package/core/keyboard_nav/marker.d.ts

@@ -13,12 +13,12 @@ export declare class Marker {
     /** The colour of the marker. */
     colour: string | null;
     /** The current location of the marker. */
-    private curNode_;
+    private curNode;
     /**
      * The object in charge of drawing the visual representation of the current
      * node.
      */
-    private drawer_;
+    private drawer;
     /** The type of the marker. */
     type: string;
     /** Constructs a new Marker instance. */

package/core/main.d.ts

@@ -1,12 +1,2 @@
-declare const Blockly: any;
-declare const ContextMenu: any;
-declare const Events: any;
 declare const Msg: any;
-declare const Tooltip: any;
-declare const WidgetDiv: any;
-declare const colour: any;
-declare const common: any;
-declare const deprecation: any;
-declare const dialog: any;
-declare const eventUtils: any;
 //# sourceMappingURL=main.d.ts.map

package/core/marker_manager.d.ts

@@ -86,7 +86,6 @@ export declare class MarkerManager {
      * Dispose of the marker manager.
      * Go through and delete all markers associated with this marker manager.
      *
-     * @suppress {checkTypes}
      * @internal
      */
     dispose(): void;

package/core/names.d.ts

@@ -10,7 +10,7 @@ import type { Workspace } from './workspace.js';
  */
 export declare class Names {
     static DEVELOPER_VARIABLE_TYPE: NameType;
-    private readonly variablePrefix_;
+    private readonly variablePrefix;
     /** A set of reserved words. */
     private readonly reservedWords;
     /**
@@ -23,7 +23,7 @@ export declare class Names {
     /**
      * The variable map from the workspace, containing Blockly variable models.
      */
-    private variableMap_;
+    private variableMap;
     /**
      * @param reservedWordsList A comma-separated string of words that are illegal
      *     for use as names in a language (e.g. 'new,if,this,...').
@@ -49,7 +49,7 @@ export declare class Names {
      * @returns The name of the referenced variable, or null if there was no
      *     variable map or the variable was not found in the map.
      */
-    private getNameForUserVariable_;
+    private getNameForUserVariable;
     /**
      * Generate names for user variables, but only ones that are being used.
      *
@@ -99,7 +99,7 @@ export declare class Names {
      * @param name Potentially illegal entity name.
      * @returns Safe entity name.
      */
-    private safeName_;
+    private safeName;
     /**
      * Do the given two entity names refer to the same entity?
      * Blockly names are case-insensitive.

package/core/options.d.ts

@@ -58,15 +58,15 @@ export declare class Options {
      *     argument Contains an x and/or y property which is a float between 0
      *     and 1 specifying the degree of scrolling.
      */
-    setMetrics?: ((p1: {
+    setMetrics?: (p1: {
         x?: number;
         y?: number;
-    }) => void);
+    }) => void;
     /**
      * A function that returns a metrics
      *     object that describes the current workspace.
      */
-    getMetrics?: (() => Metrics);
+    getMetrics?: () => Metrics;
     /**
      * @param options Dictionary of options.
      *     Specification:

package/core/procedures.d.ts

@@ -35,10 +35,7 @@ export declare const DEFAULT_ARG = "x";
  *     variables, the second with. Each procedure is defined by a three-element
  *     list of name, parameter list, and return value boolean.
  */
-export declare function allProcedures(root: Workspace): [
-    ProcedureTuple[],
-    ProcedureTuple[]
-];
+export declare function allProcedures(root: Workspace): [ProcedureTuple[], ProcedureTuple[]];
 /**
  * Ensure two identically-named procedures don't exist.
  * Take the proposed procedure name, and return a legal name i.e. one that

package/core/registry.d.ts

@@ -9,6 +9,8 @@ import type { IBlockDragger } from './interfaces/i_block_dragger.js';
 import type { IConnectionChecker } from './interfaces/i_connection_checker.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { IMetricsManager } from './interfaces/i_metrics_manager.js';
+import type { IIcon } from './interfaces/i_icon.js';
+import type { Input } from './inputs/input.js';
 import type { ISerializer } from './interfaces/i_serializer.js';
 import type { IToolbox } from './interfaces/i_toolbox.js';
 import type { Cursor } from './keyboard_nav/cursor.js';
@@ -44,6 +46,7 @@ export declare class Type<_T> {
     static CURSOR: Type<Cursor>;
     static EVENT: Type<Abstract>;
     static FIELD: Type<Field<any>>;
+    static INPUT: Type<Input>;
     static RENDERER: Type<Renderer>;
     static TOOLBOX: Type<IToolbox>;
     static THEME: Type<Theme>;
@@ -54,6 +57,8 @@ export declare class Type<_T> {
     static BLOCK_DRAGGER: Type<IBlockDragger>;
     /** @internal */
     static SERIALIZER: Type<ISerializer>;
+    /** @internal */
+    static ICON: Type<IIcon>;
 }
 /**
  * Registers a class based on a type and name.

package/core/render_management.d.ts

@@ -9,7 +9,15 @@ import { BlockSvg } from './block_svg.js';
  * and registers a callback to do so after a delay, to allowf or batching.
  *
  * @param block The block to rerender.
+ * @returns A promise that resolves after the currently queued renders have been
+ *     completed. Used for triggering other behavior that relies on updated
+ *     size/position location for the block.
  * @internal
  */
-export declare function queueRender(block: BlockSvg): void;
+export declare function queueRender(block: BlockSvg): Promise<void>;
+/**
+ * @returns A promise that resolves after the currently queued renders have
+ *     been completed.
+ */
+export declare function finishQueuedRenders(): Promise<void>;
 //# sourceMappingURL=render_management.d.ts.map

package/core/rendered_connection.d.ts

@@ -12,10 +12,10 @@ import { Coordinate } from './utils/coordinate.js';
  */
 export declare class RenderedConnection extends Connection {
     sourceBlock_: BlockSvg;
-    private readonly db_;
-    private readonly dbOpposite_;
-    private readonly offsetInBlock_;
-    private trackedState_;
+    private readonly db;
+    private readonly dbOpposite;
+    private readonly offsetInBlock;
+    private trackedState;
     private highlightPath;
     /** Connection this connection connects to.  Null if not connected. */
     targetConnection: RenderedConnection | null;
@@ -64,7 +64,7 @@ export declare class RenderedConnection extends Connection {
      *
      * @param x New absolute x coordinate, in workspace coordinates.
      * @param y New absolute y coordinate, in workspace coordinates.
-     * @return True if the position of the connection in the connection db
+     * @returns True if the position of the connection in the connection db
      *     was updated.
      */
     moveTo(x: number, y: number): boolean;
@@ -73,7 +73,7 @@ export declare class RenderedConnection extends Connection {
      *
      * @param dx Change to x coordinate, in workspace units.
      * @param dy Change to y coordinate, in workspace units.
-     * @return True if the position of the connection in the connection db
+     * @returns True if the position of the connection in the connection db
      *     was updated.
      */
     moveBy(dx: number, dy: number): boolean;
@@ -83,7 +83,7 @@ export declare class RenderedConnection extends Connection {
      *
      * @param blockTL The location of the top left corner of the block, in
      *     workspace coordinates.
-     * @return True if the position of the connection in the connection db
+     * @returns True if the position of the connection in the connection db
      *     was updated.
      */
     moveToOffset(blockTL: Coordinate): boolean;

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

@@ -27,7 +27,6 @@ import { StatementInput } from '../measurables/statement_input.js';
 import { TopRow } from '../measurables/top_row.js';
 import { Types } from '../measurables/types.js';
 import { ConstantProvider } from './constants.js';
-import { Debug } from './debugger.js';
 import { Drawer } from './drawer.js';
 import type { IPathObject } from './i_path_object.js';
 import { RenderInfo } from './info.js';
@@ -48,14 +47,6 @@ export declare function register(name: string, rendererClass: Function): void;
  * @param name The name of the renderer.
  */
 export declare function unregister(name: string): void;
-/**
- * Turn off the blocks debugger.
- *
- * @deprecated Use the debug renderer in **\@blockly/dev-tools** (See {@link
- *     https://www.npmjs.com/package/@blockly/dev-tools}.)
- * @internal
- */
-export declare function stopDebugger(): void;
 /**
  * Initialize anything needed for rendering (constants, etc).
  *
@@ -72,7 +63,6 @@ export declare function init(name: string, theme: Theme, opt_rendererOverrides?:
 export { BottomRow };
 export { Connection };
 export { ConstantProvider };
-export { Debug };
 export { Drawer };
 export { ExternalValueInput };
 export { Field };

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

@@ -217,13 +217,13 @@ export declare class ConstantProvider {
      * The defs tag that contains all filters and patterns for this Blockly
      * instance.
      */
-    private defs_;
+    private defs;
     /**
      * The ID of the emboss filter, or the empty string if no filter is set.
      */
     embossFilterId: string;
     /** The <filter> element to use for highlighting, or null if not set. */
-    private embossFilter_;
+    private embossFilter;
     /**
      * The ID of the disabled pattern, or the empty string if no pattern is set.
      */
@@ -231,7 +231,7 @@ export declare class ConstantProvider {
     /**
      * The <pattern> element to use for disabled blocks, or null if not set.
      */
-    private disabledPattern_;
+    private disabledPattern;
     /**
      * The ID of the debug filter, or the empty string if no pattern is set.
      */
@@ -239,9 +239,9 @@ export declare class ConstantProvider {
     /**
      * The <filter> element to use for a debug highlight, or null if not set.
      */
-    private debugFilter_;
+    private debugFilter;
     /** The <style> element to use for injecting renderer specific CSS. */
-    private cssNode_;
+    private cssNode;
     /**
      * Cursor colour.
      */
@@ -420,8 +420,6 @@ export declare class ConstantProvider {
      * @param svg The root of the workspace's SVG.
      * @param tagName The name to use for the CSS style tag.
      * @param selector The CSS selector to use.
-     * @suppress {strictModuleDepCheck} Debug renderer only included in
-     * playground.
      */
     createDom(svg: SVGElement, tagName: string, selector: string): void;
     /**

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

@@ -37,6 +37,13 @@ export declare class Drawer {
      * required.
      */
     draw(): void;
+    /**
+     * Hide icons that were marked as hidden.
+     *
+     * @deprecated Manually hiding icons is no longer necessary. To be removed
+     *     in v11.
+     */
+    protected hideHiddenIcons_(): void;
     /**
      * Save sizing information back to the block
      * Most of the rendering information can be thrown away at the end of the
@@ -44,8 +51,6 @@ export declare class Drawer {
      * function.
      */
     protected recordSizeOnBlock_(): void;
-    /** Hide icons that were marked as hidden. */
-    protected hideHiddenIcons_(): void;
     /** Create the outline of the block.  This is a single continuous path. */
     protected drawOutline_(): void;
     /**

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

@@ -4,10 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockSvg } from '../../block_svg.js';
-import { Input } from '../../input.js';
+import { Input } from '../../inputs/input.js';
 import type { Measurable } from '../measurables/base.js';
 import { BottomRow } from '../measurables/bottom_row.js';
-import { Icon } from '../measurables/icon.js';
 import { InputRow } from '../measurables/input_row.js';
 import { OutputConnection } from '../measurables/output_connection.js';
 import type { Row } from '../measurables/row.js';
@@ -46,8 +45,6 @@ export declare class RenderInfo {
     rows: Row[];
     /** An array of input rows on the block. */
     inputRows: InputRow[];
-    /** An array of measurable objects containing hidden icons. */
-    hiddenIcons: Icon[];
     topRow: TopRow;
     bottomRow: BottomRow;
     startX: number;

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

@@ -21,7 +21,7 @@ export declare class MarkerSvg {
      * The workspace, field, or block that the marker SVG element should be
      * attached to.
      */
-    private parent_;
+    private parent;
     /** The current SVG element for the marker. */
     currentMarkerSvg: SVGElement | null;
     colour_: string;
@@ -94,7 +94,7 @@ export declare class MarkerSvg {
      *
      * @param curNode The node to draw the marker for.
      */
-    private showWithBlockPrevOutput_;
+    private showWithBlockPrevOutput;
     /**
      * Position and display the marker for a block.
      *
@@ -213,7 +213,7 @@ export declare class MarkerSvg {
      *
      * @param markerSvg The marker that we want to flip.
      */
-    private flipRtl_;
+    private flipRtl;
     /** Hide the marker. */
     hide(): void;
     /**
@@ -222,7 +222,7 @@ export declare class MarkerSvg {
      * @param oldNode The old node the marker used to be on.
      * @param curNode The new node the marker is currently on.
      */
-    private fireMarkerEvent_;
+    private fireMarkerEvent;
     /**
      * Get the properties to make a marker blink.
      *

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

@@ -12,7 +12,6 @@ import type { RenderedConnection } from '../../rendered_connection.js';
 import type { BlockStyle, Theme } from '../../theme.js';
 import type { WorkspaceSvg } from '../../workspace_svg.js';
 import { ConstantProvider } from './constants.js';
-import { Debug } from './debugger.js';
 import { Drawer } from './drawer.js';
 import type { IPathObject } from './i_path_object.js';
 import { RenderInfo } from './info.js';
@@ -91,14 +90,6 @@ export declare class Renderer implements IRegistrable {
      * @returns The drawer.
      */
     protected makeDrawer_(block: BlockSvg, info: RenderInfo): Drawer;
-    /**
-     * Create a new instance of the renderer's debugger.
-     *
-     * @returns The renderer debugger.
-     * @suppress {strictModuleDepCheck} Debug renderer only included in
-     * playground.
-     */
-    protected makeDebugger_(): Debug;
     /**
      * Create a new instance of the renderer's marker drawer.
      *

package/core/renderers/geras/highlighter.d.ts

@@ -28,7 +28,7 @@ export declare class Highlighter {
     RTL_: boolean;
     constants_: ConstantProvider;
     highlightConstants_: HighlightConstantProvider;
-    private readonly highlightOffset_;
+    private readonly highlightOffset;
     outsideCornerPaths_: OutsideCorner;
     insideCornerPaths_: InsideCorner;
     puzzleTabPaths_: PuzzleTab;

package/core/renderers/geras/info.d.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockSvg } from '../../block_svg.js';
-import type { Input } from '../../input.js';
+import type { Input } from '../../inputs/input.js';
 import { RenderInfo as BaseRenderInfo } from '../common/info.js';
 import type { Measurable } from '../measurables/base.js';
 import type { Row } from '../measurables/row.js';

package/core/renderers/geras/measurables/inline_input.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Input } from '../../../input.js';
+import type { Input } from '../../../inputs/input.js';
 import type { ConstantProvider as BaseConstantProvider } from '../../../renderers/common/constants.js';
 import { InlineInput as BaseInlineInput } from '../../../renderers/measurables/inline_input.js';
 import type { ConstantProvider as GerasConstantProvider } from '../constants.js';

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

@@ -3,7 +3,7 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Input } from '../../../input.js';
+import type { Input } from '../../../inputs/input.js';
 import type { ConstantProvider as BaseConstantProvider } from '../../../renderers/common/constants.js';
 import { StatementInput as BaseStatementInput } from '../../../renderers/measurables/statement_input.js';
 import type { ConstantProvider as GerasConstantProvider } from '../constants.js';

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

@@ -22,7 +22,7 @@ import { PathObject } from './path_object.js';
  */
 export declare class Renderer extends BaseRenderer {
     /** The renderer's highlight constant provider. */
-    private highlightConstants_;
+    private highlightConstants;
     /**
      * @param name The renderer name.
      */

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

@@ -3,7 +3,7 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Input } from '../../input.js';
+import type { Input } from '../../inputs/input.js';
 import type { ConstantProvider } from '../common/constants.js';
 import { InputConnection } from './input_connection.js';
 /**

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

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Field as BlocklyField } from '../../field.js';
-import type { Input } from '../../input.js';
+import type { Input } from '../../inputs/input.js';
 import type { ConstantProvider } from '../common/constants.js';
 import { Measurable } from './base.js';
 /**

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

@@ -3,7 +3,7 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Icon as BlocklyIcon } from '../../icon.js';
+import type { IIcon as BlocklyIcon } from '../../interfaces/i_icon.js';
 import type { ConstantProvider } from '../common/constants.js';
 import { Measurable } from './base.js';
 /**
@@ -12,6 +12,10 @@ import { Measurable } from './base.js';
  */
 export declare class Icon extends Measurable {
     icon: BlocklyIcon;
+    /**
+     * @deprecated Will be removed in v11. Create a subclass of the Icon
+     *     measurable if this data is necessary for you.
+     */
     isVisible: boolean;
     flipRtl: boolean;
     /**

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

@@ -3,7 +3,7 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Input } from '../../input.js';
+import type { Input } from '../../inputs/input.js';
 import type { ConstantProvider } from '../common/constants.js';
 import { InputConnection } from './input_connection.js';
 /**

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

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockSvg } from '../../block_svg.js';
-import type { Input } from '../../input.js';
+import type { Input } from '../../inputs/input.js';
 import type { ConstantProvider } from '../common/constants.js';
 import { Connection } from './connection.js';
 /**

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

@@ -3,7 +3,7 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Input } from '../../input.js';
+import type { Input } from '../../inputs/input.js';
 import type { ConstantProvider } from '../common/constants.js';
 import { InputConnection } from './input_connection.js';
 /**