blockly 10.0.2 → 10.1.0

package/core/block.d.ts

@@ -287,14 +287,6 @@ export declare class Block implements IASTNodeLocation, IDeletable {
      * @returns The previous statement block or null.
      */
     getPreviousBlock(): Block | null;
-    /**
-     * Return the connection on the first statement input on this block, or null
-     * if there are none.
-     *
-     * @returns The first statement connection or null.
-     * @internal
-     */
-    getFirstStatementConnection(): Connection | null;
     /**
      * Return the top-most block in this block's tree.
      * This will return itself if this block is at the top level.

package/core/block_svg.d.ts

@@ -188,11 +188,6 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @internal
      */
     moveDuringDrag(newLoc: Coordinate): void;
-    /**
-     * Clear the block of transform="..." attributes.
-     * Used when the block is switching from 3d to 2d transform or vice versa.
-     */
-    private clearTransformAttributes_;
     /** Snap this block to the nearest grid point. */
     snapToGrid(): void;
     /**
@@ -575,11 +570,6 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @internal
      */
     positionNearConnection(sourceConnection: RenderedConnection, targetConnection: RenderedConnection): void;
-    /**
-     * @returns The first statement connection or null.
-     * @internal
-     */
-    getFirstStatementConnection(): RenderedConnection | null;
     /**
      * Find all the blocks that are directly nested inside this one.
      * Includes value and statement inputs, as well as any following statement.
@@ -602,11 +592,8 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Immediately lays out and reflows a block based on its contents and
      * settings.
-     *
-     * @param opt_bubble If false, just render this block.
-     *   If true, also render block's parent, grandparent, etc.  Defaults to true.
      */
-    render(opt_bubble?: boolean): void;
+    render(): void;
     /**
      * Renders this block in a way that's compatible with the more efficient
      * render management system.

package/core/field.d.ts

@@ -188,15 +188,11 @@ export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IAS
     init(): void;
     /**
      * Create the block UI for this field.
-     *
-     * @internal
      */
-    initView(): void;
+    protected initView(): void;
     /**
      * Initializes the model of the field after it has been installed on a block.
      * No-op by default.
-     *
-     * @internal
      */
     initModel(): void;
     /**

package/core/field_angle.d.ts

@@ -88,8 +88,6 @@ export declare class FieldAngle extends FieldInput<number> {
     protected configure_(config: FieldAngleConfig): void;
     /**
      * Create the block UI for this field.
-     *
-     * @internal
      */
     initView(): void;
     /** Updates the angle when the field rerenders. */

package/core/field_checkbox.d.ts

@@ -58,8 +58,6 @@ export declare class FieldCheckbox extends Field<CheckboxBool> {
     saveState(): any;
     /**
      * Create the block UI for this checkbox.
-     *
-     * @internal
      */
     initView(): void;
     render_(): void;

package/core/field_colour.d.ts

@@ -84,8 +84,6 @@ export declare class FieldColour extends Field<string> {
     protected configure_(config: FieldColourConfig): void;
     /**
      * Create the block UI for this colour field.
-     *
-     * @internal
      */
     initView(): void;
     /**

package/core/field_dropdown.d.ts

@@ -89,8 +89,6 @@ export declare class FieldDropdown extends Field<string> {
     loadState(state: any): void;
     /**
      * Create the block UI for this dropdown.
-     *
-     * @internal
      */
     initView(): void;
     /**

package/core/field_image.d.ts

@@ -15,11 +15,11 @@ export declare class FieldImage extends Field<string> {
      */
     private static readonly Y_PADDING;
     protected size_: Size;
-    private readonly imageHeight;
+    protected readonly imageHeight: number;
     /** The function to be called when this field is clicked. */
     private clickHandler;
     /** The rendered field's image element. */
-    private imageElement;
+    protected imageElement: SVGImageElement | null;
     /**
      * Editable fields usually show some sort of UI indicating they are
      * editable. This field should not.
@@ -60,8 +60,6 @@ export declare class FieldImage extends Field<string> {
     protected configure_(config: FieldImageConfig): void;
     /**
      * Create the block UI for this image.
-     *
-     * @internal
      */
     initView(): void;
     updateSize_(): void;

package/core/field_input.d.ts

@@ -74,7 +74,6 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<str
      */
     constructor(value?: string | typeof Field.SKIP_SETUP, validator?: FieldInputValidator<T> | null, config?: FieldInputConfig);
     protected configure_(config: FieldInputConfig): void;
-    /** @internal */
     initView(): void;
     /**
      * Called by setValue if the text input is not valid. If the field is

package/core/field_label.d.ts

@@ -33,8 +33,6 @@ export declare class FieldLabel extends Field<string> {
     protected configure_(config: FieldLabelConfig): void;
     /**
      * Create block UI for this label.
-     *
-     * @internal
      */
     initView(): void;
     /**

package/core/field_multilineinput.d.ts

@@ -80,8 +80,6 @@ export declare class FieldMultilineInput extends FieldTextInput {
     loadState(state: any): void;
     /**
      * Create the block UI for this field.
-     *
-     * @internal
      */
     initView(): void;
     /**

package/core/field_variable.d.ts

@@ -62,8 +62,6 @@ export declare class FieldVariable extends FieldDropdown {
      * Initialize the model for this field if it has not already been initialized.
      * If the value has not been set to a variable by the first render, we make up
      * a variable rather than let the value be invalid.
-     *
-     * @internal
      */
     initModel(): void;
     shouldAddBorderRect_(): boolean;

package/core/flyout_horizontal.d.ts

@@ -5,7 +5,7 @@
  */
 import { Flyout, FlyoutItem } from './flyout_base.js';
 import type { Options } from './options.js';
-import type { Coordinate } from './utils/coordinate.js';
+import { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';
 /**
  * Class for a flyout.

package/core/flyout_vertical.d.ts

@@ -5,7 +5,7 @@
  */
 import { Flyout, FlyoutItem } from './flyout_base.js';
 import type { Options } from './options.js';
-import type { Coordinate } from './utils/coordinate.js';
+import { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';
 /**
  * Class for a flyout.

package/core/render_management.d.ts

@@ -20,4 +20,12 @@ export declare function queueRender(block: BlockSvg): Promise<void>;
  *     been completed.
  */
 export declare function finishQueuedRenders(): Promise<void>;
+/**
+ * Triggers an immediate render of all queued renders. Should only be used in
+ * cases where queueing renders breaks functionality + backwards compatibility
+ * (such as rendering icons).
+ *
+ * @internal
+ */
+export declare function triggerQueuedRenders(): void;
 //# sourceMappingURL=render_management.d.ts.map

package/core/rendered_connection.d.ts

@@ -98,7 +98,6 @@ export declare class RenderedConnection extends Connection {
      * Get the offset of this connection relative to the top left of its block.
      *
      * @returns The offset of the connection.
-     * @internal
      */
     getOffsetInBlock(): Coordinate;
     /**
@@ -202,6 +201,15 @@ export declare class RenderedConnection extends Connection {
      * Function to be called when this connection's compatible types have changed.
      */
     protected onCheckChanged_(): void;
+    /**
+     * Change a connection's compatibility.
+     * Rerender blocks as needed.
+     *
+     * @param check Compatible value type or list of value types. Null if all
+     *     types are compatible.
+     * @returns The connection being modified (to allow chaining).
+     */
+    setCheck(check: string | string[] | null): RenderedConnection;
 }
 export declare namespace RenderedConnection {
     /**

package/core/scrollbar.d.ts

@@ -259,6 +259,15 @@ export declare class Scrollbar {
      * @param visible True if visible.
      */
     setVisible(visible: boolean): void;
+    /**
+     * Set whether the scrollbar is visible. Bypasses checking whether this
+     * scrollbar is part of a pair so that it can be toggled by the scrollbar
+     * pair.
+     *
+     * @param visible True if visible.
+     * @internal
+     */
+    setVisibleInternal(visible: boolean): void;
     /**
      * Update visibility of scrollbar based on whether it thinks it should
      * be visible and whether its containing workspace is visible.

package/core/scrollbar_pair.d.ts

@@ -95,6 +95,12 @@ export declare class ScrollbarPair {
      * @returns True if visible.
      */
     isVisible(): boolean;
+    /**
+     * Sets the visibility of any existing scrollbars.
+     *
+     * @param visible True if visible.
+     */
+    setVisible(visible: boolean): void;
     /**
      * Recalculates the scrollbars' locations within their path and length.
      * This should be called when the contents of the workspace have changed.

package/core/toolbox/collapsible_category.d.ts

@@ -47,7 +47,7 @@ export declare class CollapsibleToolboxCategory extends ToolboxCategory implemen
      */
     protected createSubCategoriesDom_(subcategories: IToolboxItem[]): HTMLDivElement;
     /**
-     * Opens or closes the current category.
+     * Opens or closes the current category and the associated flyout.
      *
      * @param isExpanded True to expand the category, false to close.
      */

package/core/utils/svg_math.d.ts

@@ -48,6 +48,15 @@ export declare function getDocumentScroll(): Coordinate;
  * @returns The workspace coordinates.
  */
 export declare function screenToWsCoordinates(ws: WorkspaceSvg, screenCoordinates: Coordinate): Coordinate;
+/**
+ * Converts workspace coordinates to screen coordinates.
+ *
+ * @param ws The workspace to get the coordinates out of.
+ * @param workspaceCoordinates  The workspace coordinates to be converted
+ *     to screen coordinates.
+ * @returns The screen coordinates.
+ */
+export declare function wsToScreenCoordinates(ws: WorkspaceSvg, workspaceCoordinates: Coordinate): Coordinate;
 export declare const TEST_ONLY: {
     XY_REGEX: RegExp;
     XY_STYLE_REGEX: RegExp;

package/core/utils/toolbox.d.ts

@@ -18,8 +18,6 @@ export interface BlockInfo {
     disabled?: string | boolean;
     enabled?: boolean;
     id?: string;
-    x?: number;
-    y?: number;
     collapsed?: boolean;
     inline?: boolean;
     data?: string;

package/core/workspace_comment_svg.d.ts

@@ -329,8 +329,6 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
      * @param height height of the container
      */
     private setSize;
-    /** Dispose of any rendered comment components. */
-    private disposeInternal;
     /**
      * Set the focus on the text area.
      *

package/core/workspace_svg.d.ts

@@ -537,7 +537,9 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * @param isVisible True if workspace should be visible.
      */
     setVisible(isVisible: boolean): void;
-    /** Render all blocks in workspace. */
+    /**
+     * Render all blocks in workspace.
+     */
     render(): void;
     /**
      * Highlight or unhighlight a block in the workspace.  Block highlighting is

package/core/xml.d.ts

@@ -91,6 +91,19 @@ export declare function appendDomToWorkspace(xml: Element, workspace: WorkspaceS
  * @returns The root block created.
  */
 export declare function domToBlock(xmlBlock: Element, workspace: Workspace): Block;
+/**
+ * Decode an XML block tag and create a block (and possibly sub blocks) on the
+ * workspace.
+ *
+ * This is defined internally so that it doesn't trigger an immediate render,
+ * which we do want to happen for external calls.
+ *
+ * @param xmlBlock XML block element.
+ * @param workspace The workspace.
+ * @returns The root block created.
+ * @internal
+ */
+export declare function domToBlockInternal(xmlBlock: Element, workspace: Workspace): Block;
 /**
  * Decode an XML list of variables and add the variables to the workspace.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockly",
-  "version": "10.0.2",
+  "version": "10.1.0",
   "description": "Blockly is a library for building visual programming editors.",
   "keywords": [
     "blockly"
@@ -27,13 +27,13 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@blockly/block-test": "^3.0.0",
-    "@blockly/dev-tools": "^5.0.0",
-    "@blockly/theme-modern": "^3.0.0",
+    "@blockly/block-test": "^5.0.0",
+    "@blockly/dev-tools": "^7.0.2",
+    "@blockly/theme-modern": "^5.0.0",
     "@hyperjump/json-schema": "^1.5.0",
     "@microsoft/api-documenter": "^7.22.4",
     "@microsoft/api-extractor": "^7.29.5",
-    "@typescript-eslint/eslint-plugin": "^5.33.1",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
     "@wdio/selenium-standalone-service": "^8.0.2",
     "async-done": "^2.0.0",
     "chai": "^4.2.0",
@@ -61,7 +61,7 @@
     "markdown-tables-to-json": "^0.1.7",
     "mocha": "^10.0.0",
     "patch-package": "^7.0.0",
-    "prettier": "2.8.8",
+    "prettier": "3.0.0",
     "readline-sync": "^1.4.10",
     "rimraf": "^5.0.0",
     "selenium-standalone": "^8.0.3",

package/core/block_drag_surface.d.ts

@@ -1,135 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { Coordinate } from './utils/coordinate.js';
-/**
- * Class for a drag surface for the currently dragged block. This is a separate
- * SVG that contains only the currently moving block, or nothing.
- *
- * @alias Blockly.BlockDragSurfaceSvg
- */
-export declare class BlockDragSurfaceSvg {
-    private readonly container;
-    /**
-     * The root element of the drag surface.
-     */
-    private svg;
-    /**
-     * This is where blocks live while they are being dragged if the drag
-     * surface is enabled.
-     */
-    private dragGroup;
-    /**
-     * Cached value for the scale of the drag surface.
-     * Used to set/get the correct translation during and after a drag.
-     */
-    private scale;
-    /**
-     * Cached value for the translation of the drag surface.
-     * This translation is in pixel units, because the scale is applied to the
-     * drag group rather than the top-level SVG.
-     */
-    private surfaceXY;
-    /**
-     * Cached value for the translation of the child drag surface in pixel
-     * units. Since the child drag surface tracks the translation of the
-     * workspace this is ultimately the translation of the workspace.
-     */
-    private readonly childSurfaceXY;
-    /** @param container Containing element. */
-    constructor(container: Element);
-    /**
-     * Create the drag surface and inject it into the container.
-     *
-     * @deprecated The DOM is automatically created by the constructor.
-     */
-    createDom(): void;
-    /**
-     * Set the SVG blocks on the drag surface's group and show the surface.
-     * Only one block group should be on the drag surface at a time.
-     *
-     * @param blocks Block or group of blocks to place on the drag surface.
-     */
-    setBlocksAndShow(blocks: SVGElement): void;
-    /**
-     * Translate and scale the entire drag surface group to the given position, to
-     * keep in sync with the workspace.
-     *
-     * @param x X translation in pixel coordinates.
-     * @param y Y translation in pixel coordinates.
-     * @param scale Scale of the group.
-     */
-    translateAndScaleGroup(x: number, y: number, scale: number): void;
-    /**
-     * Translate the drag surface's SVG based on its internal state.
-     *
-     * @internal
-     */
-    translateSurfaceInternal_(): void;
-    /**
-     * Translates the entire surface by a relative offset.
-     *
-     * @param deltaX Horizontal offset in pixel units.
-     * @param deltaY Vertical offset in pixel units.
-     */
-    translateBy(deltaX: number, deltaY: number): void;
-    /**
-     * Translate the entire drag surface during a drag.
-     * We translate the drag surface instead of the blocks inside the surface
-     * so that the browser avoids repainting the SVG.
-     * Because of this, the drag coordinates must be adjusted by scale.
-     *
-     * @param x X translation for the entire surface.
-     * @param y Y translation for the entire surface.
-     */
-    translateSurface(x: number, y: number): void;
-    /**
-     * Reports the surface translation in scaled workspace coordinates.
-     * Use this when finishing a drag to return blocks to the correct position.
-     *
-     * @returns Current translation of the surface.
-     */
-    getSurfaceTranslation(): Coordinate;
-    /**
-     * Provide a reference to the drag group (primarily for
-     * BlockSvg.getRelativeToSurfaceXY).
-     *
-     * @returns Drag surface group element.
-     */
-    getGroup(): SVGElement;
-    /**
-     * Returns the SVG drag surface.
-     *
-     * @returns The SVG drag surface.
-     */
-    getSvgRoot(): SVGElement;
-    /**
-     * Get the current blocks on the drag surface, if any (primarily
-     * for BlockSvg.getRelativeToSurfaceXY).
-     *
-     * @returns Drag surface block DOM element, or null if no blocks exist.
-     */
-    getCurrentBlock(): Element | null;
-    /**
-     * Gets the translation of the child block surface
-     * This surface is in charge of keeping track of how much the workspace has
-     * moved.
-     *
-     * @returns The amount the workspace has been moved.
-     */
-    getWsTranslation(): Coordinate;
-    /**
-     * Clear the group and hide the surface; move the blocks off onto the provided
-     * element.
-     * If the block is being deleted it doesn't need to go back to the original
-     * surface, since it would be removed immediately during dispose.
-     *
-     * @param opt_newSurface Surface the dragging blocks should be moved to, or
-     *     null if the blocks should be removed from this surface without being
-     *     moved to a different surface.
-     */
-    clearAndHide(opt_newSurface?: Element): void;
-}
-//# sourceMappingURL=block_drag_surface.d.ts.map

package/core/workspace_drag_surface_svg.d.ts

@@ -1,74 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Coordinate } from './utils/coordinate.js';
-/**
- * Blocks are moved into this SVG during a drag, improving performance.
- * The entire SVG is translated using CSS transforms instead of SVG so the
- * blocks are never repainted during drag improving performance.
- *
- * @alias Blockly.WorkspaceDragSurfaceSvg
- */
-export declare class WorkspaceDragSurfaceSvg {
-    private readonly container;
-    /**
-     * The SVG drag surface. Set once by WorkspaceDragSurfaceSvg.createDom.
-     */
-    private SVG;
-    /**
-     * The element to insert the block canvas and bubble canvas after when it
-     * goes back in the DOM at the end of a drag.
-     */
-    private previousSibling;
-    /** @param container Containing element. */
-    constructor(container: Element);
-    /** Create the drag surface and inject it into the container. */
-    createDom(): void;
-    /**
-     * Translate the entire drag surface during a drag.
-     * We translate the drag surface instead of the blocks inside the surface
-     * so that the browser avoids repainting the SVG.
-     * Because of this, the drag coordinates must be adjusted by scale.
-     *
-     * @param x X translation for the entire surface
-     * @param y Y translation for the entire surface
-     * @internal
-     */
-    translateSurface(x: number, y: number): void;
-    /**
-     * Reports the surface translation in scaled workspace coordinates.
-     * Use this when finishing a drag to return blocks to the correct position.
-     *
-     * @returns Current translation of the surface
-     * @internal
-     */
-    getSurfaceTranslation(): Coordinate;
-    /**
-     * Move the blockCanvas and bubbleCanvas out of the surface SVG and on to
-     * newSurface.
-     *
-     * @param newSurface The element to put the drag surface contents into.
-     * @internal
-     */
-    clearAndHide(newSurface: SVGElement): void;
-    /**
-     * Set the SVG to have the block canvas and bubble canvas in it and then
-     * show the surface.
-     *
-     * @param blockCanvas The block canvas <g> element from the
-     *     workspace.
-     * @param bubbleCanvas The <g> element that contains the
-       bubbles.
-     * @param previousSibling The element to insert the block canvas and
-             bubble canvas after when it goes back in the DOM at the end of a
-       drag.
-     * @param width The width of the workspace SVG element.
-     * @param height The height of the workspace SVG element.
-     * @param scale The scale of the workspace being dragged.
-     * @internal
-     */
-    setContentsAndShow(blockCanvas: SVGElement, bubbleCanvas: SVGElement, previousSibling: Element, width: number, height: number, scale: number): void;
-}
-//# sourceMappingURL=workspace_drag_surface_svg.d.ts.map