blockly 9.2.1 → 9.3.0

package/core/rendered_connection.d.ts

@@ -9,8 +9,6 @@ import { Connection } from './connection.js';
 import { Coordinate } from './utils/coordinate.js';
 /**
  * Class for a connection between blocks that may be rendered on screen.
- *
- * @alias Blockly.RenderedConnection
  */
 export declare class RenderedConnection extends Connection {
     sourceBlock_: BlockSvg;
@@ -66,23 +64,29 @@ 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
+     *     was updated.
      */
-    moveTo(x: number, y: number): void;
+    moveTo(x: number, y: number): boolean;
     /**
      * Change the connection's coordinates.
      *
      * @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
+     *     was updated.
      */
-    moveBy(dx: number, dy: number): void;
+    moveBy(dx: number, dy: number): boolean;
     /**
      * Move this connection to the location given by its offset within the block
      * and the location of the block's top left corner.
      *
      * @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
+     *     was updated.
      */
-    moveToOffset(blockTL: Coordinate): void;
+    moveToOffset(blockTL: Coordinate): boolean;
     /**
      * Set the offset of this connection relative to the top left of its block.
      *
@@ -103,6 +107,13 @@ export declare class RenderedConnection extends Connection {
      * @internal
      */
     tighten(): void;
+    /**
+     * Moves the blocks on either side of this connection right next to
+     * each other, based on their local offsets, not global positions.
+     *
+     * @internal
+     */
+    tightenEfficiently(): void;
     /**
      * Find the closest compatible connection to this connection.
      * All parameters are in workspace units.
@@ -147,7 +158,7 @@ export declare class RenderedConnection extends Connection {
      */
     startTrackingAll(): Block[];
     /**
-     * Behavior after a connection attempt fails.
+     * Behaviour after a connection attempt fails.
      * Bumps this connection away from the other connection. Called when an
      * attempted connection fails.
      *
@@ -159,10 +170,12 @@ export declare class RenderedConnection extends Connection {
     /**
      * Disconnect two blocks that are connected by this connection.
      *
-     * @param parentBlock The superior block.
-     * @param childBlock The inferior block.
+     * @param setParent Whether to set the parent of the disconnected block or
+     *     not, defaults to true.
+     *     If you do not set the parent, ensure that a subsequent action does,
+     *     otherwise the view and model will be out of sync.
      */
-    protected disconnectInternal_(parentBlock: Block, childBlock: Block): void;
+    disconnectInternal(setParent?: boolean): void;
     /**
      * Respawn the shadow block if there was one connected to the this connection.
      * Render/rerender blocks as needed.

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

@@ -46,13 +46,11 @@ export declare function register(name: string, rendererClass: Function): void;
  * Unregisters the renderer registered with the given name.
  *
  * @param name The name of the renderer.
- * @alias Blockly.blockRendering.unregister
  */
 export declare function unregister(name: string): void;
 /**
  * Turn off the blocks debugger.
  *
- * @alias Blockly.blockRendering.stopDebugger
  * @deprecated Use the debug renderer in **\@blockly/dev-tools** (See {@link
  *     https://www.npmjs.com/package/@blockly/dev-tools}.)
  * @internal
@@ -66,7 +64,6 @@ export declare function stopDebugger(): void;
  * @param opt_rendererOverrides Rendering constant overrides.
  * @returns The new instance of a renderer.
  *     Already initialized.
- * @alias Blockly.blockRendering.init
  * @internal
  */
 export declare function init(name: string, theme: Theme, opt_rendererOverrides?: {

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

@@ -80,8 +80,6 @@ export type Shape = BaseShape | DynamicShape;
 export declare function isDynamicShape(shape: Shape): shape is DynamicShape;
 /**
  * An object that provides constants for rendering blocks.
- *
- * @alias Blockly.blockRendering.ConstantProvider
  */
 export declare class ConstantProvider {
     /** The size of an empty spacer. */
@@ -180,8 +178,6 @@ export declare class ConstantProvider {
     FIELD_BORDER_RECT_Y_PADDING: number;
     /**
      * The backing colour of a field's border rect.
-     *
-     * @internal
      */
     FIELD_BORDER_RECT_COLOUR: string;
     FIELD_TEXT_BASELINE_CENTER: boolean;
@@ -216,7 +212,6 @@ export declare class ConstantProvider {
     FIELD_COLOUR_DEFAULT_WIDTH: number;
     FIELD_COLOUR_DEFAULT_HEIGHT: number;
     FIELD_CHECKBOX_X_OFFSET: number;
-    /** @internal */
     randomIdentifier: string;
     /**
      * The defs tag that contains all filters and patterns for this Blockly
@@ -225,16 +220,12 @@ export declare class ConstantProvider {
     private defs_;
     /**
      * The ID of the emboss filter, or the empty string if no filter is set.
-     *
-     * @internal
      */
     embossFilterId: string;
     /** The <filter> element to use for highlighting, or null if not set. */
     private embossFilter_;
     /**
      * The ID of the disabled pattern, or the empty string if no pattern is set.
-     *
-     * @internal
      */
     disabledPatternId: string;
     /**
@@ -253,63 +244,43 @@ export declare class ConstantProvider {
     private cssNode_;
     /**
      * Cursor colour.
-     *
-     * @internal
      */
     CURSOR_COLOUR: string;
     /**
      * Immovable marker colour.
-     *
-     * @internal
      */
     MARKER_COLOUR: string;
     /**
      * Width of the horizontal cursor.
-     *
-     * @internal
      */
     CURSOR_WS_WIDTH: number;
     /**
      * Height of the horizontal cursor.
-     *
-     * @internal
      */
     WS_CURSOR_HEIGHT: number;
     /**
      * Padding around a stack.
-     *
-     * @internal
      */
     CURSOR_STACK_PADDING: number;
     /**
      * Padding around a block.
-     *
-     * @internal
      */
     CURSOR_BLOCK_PADDING: number;
     /**
      * Stroke of the cursor.
-     *
-     * @internal
      */
     CURSOR_STROKE_WIDTH: number;
     /**
      * Whether text input and colour fields fill up the entire source block.
-     *
-     * @internal
      */
     FULL_BLOCK_FIELDS: boolean;
     /**
      * The main colour of insertion markers, in hex.  The block is rendered a
      * transparent grey by changing the fill opacity in CSS.
-     *
-     * @internal
      */
     INSERTION_MARKER_COLOUR: string;
     /**
      * The insertion marker opacity.
-     *
-     * @internal
      */
     INSERTION_MARKER_OPACITY: number;
     SHAPES: {
@@ -321,23 +292,18 @@ export declare class ConstantProvider {
     PUZZLE_TAB: PuzzleTab;
     INSIDE_CORNERS: InsideCorners;
     OUTSIDE_CORNERS: OutsideCorners;
-    /** @internal */
     blockStyles: {
         [key: string]: BlockStyle;
     };
-    /** @internal */
     constructor();
     /**
      * Initialize shape objects based on the constants set in the constructor.
-     *
-     * @internal
      */
     init(): void;
     /**
      * Refresh constants properties that depend on the theme.
      *
      * @param theme The current workspace theme.
-     * @internal
      */
     setTheme(theme: Theme): void;
     /**
@@ -365,7 +331,6 @@ export declare class ConstantProvider {
      * @param colour #RRGGBB colour string.
      * @returns An object containing the style and an autogenerated name for that
      *     style.
-     * @internal
      */
     getBlockStyleForColour(colour: string): {
         style: BlockStyle;
@@ -411,51 +376,42 @@ export declare class ConstantProvider {
     /**
      * Dispose of this constants provider.
      * Delete all DOM elements that this provider created.
-     *
-     * @internal
      */
     dispose(): void;
     /**
      * @returns An object containing sizing and path information about collapsed
      *     block indicators.
-     * @internal
      */
-    makeJaggedTeeth(): JaggedTeeth;
+    protected makeJaggedTeeth(): JaggedTeeth;
     /**
      * @returns An object containing sizing and path information about start hats.
-     * @internal
      */
-    makeStartHat(): StartHat;
+    protected makeStartHat(): StartHat;
     /**
      * @returns An object containing sizing and path information about puzzle
      *     tabs.
-     * @internal
      */
-    makePuzzleTab(): PuzzleTab;
+    protected makePuzzleTab(): PuzzleTab;
     /**
      * @returns An object containing sizing and path information about notches.
-     * @internal
      */
-    makeNotch(): Notch;
+    protected makeNotch(): Notch;
     /**
      * @returns An object containing sizing and path information about inside
      *     corners.
-     * @internal
      */
-    makeInsideCorners(): InsideCorners;
+    protected makeInsideCorners(): InsideCorners;
     /**
      * @returns An object containing sizing and path information about outside
      *     corners.
-     * @internal
      */
-    makeOutsideCorners(): OutsideCorners;
+    protected makeOutsideCorners(): OutsideCorners;
     /**
      * Get an object with connection shape and sizing information based on the
      * type of the connection.
      *
      * @param connection The connection to find a shape object for
      * @returns The shape object for the connection.
-     * @internal
      */
     shapeFor(connection: RenderedConnection): Shape;
     /**
@@ -466,7 +422,6 @@ export declare class ConstantProvider {
      * @param selector The CSS selector to use.
      * @suppress {strictModuleDepCheck} Debug renderer only included in
      * playground.
-     * @internal
      */
     createDom(svg: SVGElement, tagName: string, selector: string): void;
     /**

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

@@ -7,14 +7,12 @@
  * Returns whether the debugger is turned on.
  *
  * @returns Whether the debugger is turned on.
- * @alias Blockly.blockRendering.debug.isDebuggerEnabled
  * @internal
  */
 export declare function isDebuggerEnabled(): boolean;
 /**
  * Turn on the blocks debugger.
  *
- * @alias Blockly.blockRendering.debug.startDebugger
  * @deprecated March 2022. Use the rendering debugger in @blockly/dev-tools.
  * See https://www.npmjs.com/package/@blockly/dev-tools for more information.
  * @internal
@@ -23,7 +21,6 @@ export declare function startDebugger(): void;
 /**
  * Turn off the blocks debugger.
  *
- * @alias Blockly.blockRendering.debug.stopDebugger
  * @deprecated March 2022. Use the rendering debugger in @blockly/dev-tools.
  * See https://www.npmjs.com/package/@blockly/dev-tools for more information.
  * @internal

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

@@ -12,8 +12,6 @@ import type { ConstantProvider } from './constants.js';
 import type { RenderInfo } from './info.js';
 /**
  * An object that renders rectangles and dots for debugging rendering code.
- *
- * @alias Blockly.blockRendering.Debug
  */
 export declare class Debug {
     private readonly constants;
@@ -41,41 +39,35 @@ export declare class Debug {
     private randomColour_;
     /**
      * @param constants The renderer's constants.
-     * @internal
      */
     constructor(constants: ConstantProvider);
     /**
      * Remove all elements the this object created on the last pass.
-     *
-     * @internal
      */
-    clearElems(): void;
+    protected clearElems(): void;
     /**
      * Draw a debug rectangle for a spacer (empty) row.
      *
      * @param row The row to render.
      * @param cursorY The y position of the top of the row.
      * @param isRtl Whether the block is rendered RTL.
-     * @internal
      */
-    drawSpacerRow(row: Row, cursorY: number, isRtl: boolean): void;
+    protected drawSpacerRow(row: Row, cursorY: number, isRtl: boolean): void;
     /**
      * Draw a debug rectangle for a horizontal spacer.
      *
      * @param elem The spacer to render.
      * @param rowHeight The height of the container row.
      * @param isRtl Whether the block is rendered RTL.
-     * @internal
      */
-    drawSpacerElem(elem: InRowSpacer, rowHeight: number, isRtl: boolean): void;
+    protected drawSpacerElem(elem: InRowSpacer, rowHeight: number, isRtl: boolean): void;
     /**
      * Draw a debug rectangle for an in-row element.
      *
      * @param elem The element to render.
      * @param isRtl Whether the block is rendered RTL.
-     * @internal
      */
-    drawRenderedElem(elem: Measurable, isRtl: boolean): void;
+    protected drawRenderedElem(elem: Measurable, isRtl: boolean): void;
     /**
      * Draw a circle at the location of the given connection.  Inputs and outputs
      * share the same colours, as do previous and next.  When positioned correctly
@@ -84,48 +76,42 @@ export declare class Debug {
      * @param conn The connection to circle.
      * @suppress {visibility} Suppress visibility of conn.offsetInBlock_ since
      * this is a debug module.
-     * @internal
      */
-    drawConnection(conn: RenderedConnection): void;
+    protected drawConnection(conn: RenderedConnection): void;
     /**
      * Draw a debug rectangle for a non-empty row.
      *
      * @param row The non-empty row to render.
      * @param cursorY The y position of the top of the row.
      * @param isRtl Whether the block is rendered RTL.
-     * @internal
      */
-    drawRenderedRow(row: Row, cursorY: number, isRtl: boolean): void;
+    protected drawRenderedRow(row: Row, cursorY: number, isRtl: boolean): void;
     /**
      * Draw debug rectangles for a non-empty row and all of its subcomponents.
      *
      * @param row The non-empty row to render.
      * @param cursorY The y position of the top of the row.
      * @param isRtl Whether the block is rendered RTL.
-     * @internal
      */
-    drawRowWithElements(row: Row, cursorY: number, isRtl: boolean): void;
+    protected drawRowWithElements(row: Row, cursorY: number, isRtl: boolean): void;
     /**
      * Draw a debug rectangle around the entire block.
      *
      * @param info Rendering information about the block to debug.
-     * @internal
      */
-    drawBoundingBox(info: RenderInfo): void;
+    protected drawBoundingBox(info: RenderInfo): void;
     /**
      * Do all of the work to draw debug information for the whole block.
      *
      * @param block The block to draw debug information for.
      * @param info Rendering information about the block to debug.
-     * @internal
      */
     drawDebug(block: BlockSvg, info: RenderInfo): void;
     /**
      * Show a debug filter to highlight that a block has been rendered.
      *
      * @param svgPath The block's SVG path.
-     * @internal
      */
-    drawRender(svgPath: SVGElement): void;
+    protected drawRender(svgPath: SVGElement): void;
 }
 //# sourceMappingURL=debugger.d.ts.map

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

@@ -13,8 +13,6 @@ import type { ConstantProvider } from './constants.js';
 import type { RenderInfo } from './info.js';
 /**
  * An object that draws a block based on the given rendering information.
- *
- * @alias Blockly.blockRendering.Drawer
  */
 export declare class Drawer {
     block_: BlockSvg;
@@ -27,7 +25,6 @@ export declare class Drawer {
      * @param block The block to render.
      * @param info An object containing all information needed to render this
      *     block.
-     * @internal
      */
     constructor(block: BlockSvg, info: RenderInfo);
     /**
@@ -38,8 +35,6 @@ export declare class Drawer {
      * joined with spaces and set directly on the block.  This guarantees that
      * the steps are separated by spaces for improved readability, but isn't
      * required.
-     *
-     * @internal
      */
     draw(): void;
     /**

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

@@ -12,13 +12,10 @@ import { RenderedConnection } from '../../rendered_connection.js';
  *
  * @param _root The root SVG element.
  * @param _constants The renderer's constants.
- * @alias Blockly.blockRendering.IPathObject
  */
 export interface IPathObject {
     /**
      * The primary path of the block.
-     *
-     * @internal
      */
     svgPath: SVGElement;
     /** The renderer's constant provider. */
@@ -39,7 +36,6 @@ export interface IPathObject {
      * Set the path generated by the renderer onto the respective SVG element.
      *
      * @param pathString The path.
-     * @internal
      */
     setPath(pathString: string): void;
     /**
@@ -47,20 +43,16 @@ export interface IPathObject {
      * the paths belong to a shadow block.
      *
      * @param block The source block.
-     * @internal
      */
     applyColour(block: BlockSvg): void;
     /**
      * Update the style.
      *
      * @param blockStyle The block style to use.
-     * @internal
      */
     setStyle(blockStyle: BlockStyle): void;
     /**
      * Flip the SVG paths in RTL.
-     *
-     * @internal
      */
     flipRTL(): void;
     /**
@@ -68,7 +60,6 @@ export interface IPathObject {
      *
      * @param cursorSvg The SVG root of the cursor to be added to the block SVG
      *     group.
-     * @internal
      */
     setCursorSvg(cursorSvg: SVGElement): void;
     /**
@@ -76,7 +67,6 @@ export interface IPathObject {
      *
      * @param markerSvg The SVG root of the marker to be added to the block SVG
      *     group.
-     * @internal
      */
     setMarkerSvg(markerSvg: SVGElement): void;
     /**
@@ -84,14 +74,12 @@ export interface IPathObject {
      * often used to visually mark blocks currently being executed.
      *
      * @param highlighted True if highlighted.
-     * @internal
      */
     updateHighlighted(highlighted: boolean): void;
     /**
      * Add or remove styling showing that a block is selected.
      *
      * @param enable True if selection is enabled, false otherwise.
-     * @internal
      */
     updateSelected(enabled: boolean): void;
     /**
@@ -99,21 +87,18 @@ export interface IPathObject {
      *
      * @param enable True if the block is being dragged over a delete area, false
      *     otherwise.
-     * @internal
      */
     updateDraggingDelete(enabled: boolean): void;
     /**
      * Add or remove styling showing that a block is an insertion marker.
      *
      * @param enable True if the block is an insertion marker, false otherwise.
-     * @internal
      */
     updateInsertionMarker(enabled: boolean): void;
     /**
      * Add or remove styling showing that a block is movable.
      *
      * @param enable True if the block is movable, false otherwise.
-     * @internal
      */
     updateMovable(enabled: boolean): void;
     /**
@@ -122,7 +107,6 @@ export interface IPathObject {
      * Otherwise it will bump.
      *
      * @param enable True if styling should be added.
-     * @internal
      */
     updateReplacementFade(enabled: boolean): void;
     /**
@@ -131,7 +115,6 @@ export interface IPathObject {
      *
      * @param conn The connection on the input to highlight.
      * @param enable True if styling should be added.
-     * @internal
      */
     updateShapeForInputHighlight(conn: RenderedConnection, enable: boolean): void;
 }

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

@@ -21,8 +21,6 @@ import type { Renderer } from './renderer.js';
  * This measure pass does not propagate changes to the block (although fields
  * may choose to rerender when getSize() is called).  However, calling it
  * repeatedly may be expensive.
- *
- * @alias Blockly.blockRendering.RenderInfo
  */
 export declare class RenderInfo {
     block_: BlockSvg;
@@ -57,14 +55,12 @@ export declare class RenderInfo {
     /**
      * @param renderer The renderer in use.
      * @param block The block to measure.
-     * @internal
      */
     constructor(renderer: Renderer, block: BlockSvg);
     /**
      * Get the block renderer in use.
      *
      * @returns The block renderer in use.
-     * @internal
      */
     getRenderer(): Renderer;
     /**
@@ -74,8 +70,6 @@ export declare class RenderInfo {
      * This measure pass does not propagate changes to the block (although fields
      * may choose to rerender when getSize() is called).  However, calling it
      * repeatedly may be expensive.
-     *
-     * @internal
      */
     measure(): void;
     /**
@@ -85,16 +79,12 @@ export declare class RenderInfo {
     protected createRows_(): void;
     /**
      * Create all non-spacer elements that belong on the top row.
-     *
-     * @internal
      */
-    populateTopRow_(): void;
+    protected populateTopRow_(): void;
     /**
      * Create all non-spacer elements that belong on the bottom row.
-     *
-     * @internal
      */
-    populateBottomRow_(): void;
+    protected populateBottomRow_(): void;
     /**
      * Add an input element to the active row, if needed, and record the type of
      * the input on the row.

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

@@ -11,9 +11,8 @@ import type { RenderedConnection } from '../../rendered_connection.js';
 import type { WorkspaceSvg } from '../../workspace_svg.js';
 import type { ConstantProvider, Notch, PuzzleTab } from './constants.js';
 /**
- * Class for a marker.
- *
- * @alias Blockly.blockRendering.MarkerSvg
+ * Class for a marker, containing methods for graphically rendering a marker as
+ * SVG.
  */
 export declare class MarkerSvg {
     private readonly workspace;
@@ -64,7 +63,6 @@ export declare class MarkerSvg {
      * Create the DOM element for the marker.
      *
      * @returns The marker controls SVG group.
-     * @internal
      */
     createDom(): SVGElement;
     /**