blockly 9.0.0-beta.1 → 9.0.0-beta.3

package/core/menu.d.ts

@@ -57,8 +57,9 @@ export declare class Menu {
      * Creates the menu DOM.
      *
      * @param container Element upon which to append this menu.
+     * @returns The menu's root DOM element.
      */
-    render(container: Element): void;
+    render(container: Element): HTMLDivElement;
     /**
      * Gets the menu's element.
      *

package/core/msg.d.ts

@@ -7,4 +7,18 @@
 export declare const Msg: {
     [key: string]: string;
 };
+/**
+ * Sets the locale (i.e. the localized messages/block-text/etc) to the given
+ * locale.
+ *
+ * This is not useful/necessary when loading from a script tag, because the
+ * messages are automatically cluged into the Blockly.Msg object. But we provide
+ * it in both the script-tag and non-script-tag contexts so that the tscompiler
+ * can properly create our type definition files.
+ *
+ * @param locale An object defining the messages for a given language.
+ */
+export declare const setLocale: (locale: {
+    [key: string]: string;
+}) => void;
 //# sourceMappingURL=msg.d.ts.map

package/core/mutator.d.ts

@@ -45,7 +45,7 @@ export declare class Mutator extends Icon {
      */
     private updateWorkspacePid_;
     /** @param quarkNames List of names of sub-blocks for flyout. */
-    constructor(block: BlockSvg, quarkNames: string[]);
+    constructor(quarkNames: string[], block?: BlockSvg);
     /**
      * Set the block this mutator is associated with.
      *

package/core/rendered_connection.d.ts

@@ -18,6 +18,7 @@ export declare class RenderedConnection extends Connection {
     private readonly dbOpposite_;
     private readonly offsetInBlock_;
     private trackedState_;
+    private highlightPath;
     /** Connection this connection connects to.  Null if not connected. */
     targetConnection: RenderedConnection | null;
     /**

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

@@ -71,6 +71,13 @@ export declare type DynamicShape = {
 };
 /** An object containing sizing and type information about a shape. */
 export declare type Shape = BaseShape | DynamicShape;
+/**
+ * Returns whether the shape is dynamic or not.
+ *
+ * @param shape The shape to check for dynamic-ness.
+ * @returns Whether the shape is a dynamic shape or not.
+ */
+export declare function isDynamicShape(shape: Shape): shape is DynamicShape;
 /**
  * An object that provides constants for rendering blocks.
  *
@@ -141,7 +148,7 @@ export declare class ConstantProvider {
     EMPTY_INLINE_INPUT_HEIGHT: number;
     EXTERNAL_VALUE_INPUT_PADDING: number;
     EMPTY_STATEMENT_INPUT_HEIGHT: number;
-    START_POINT: any;
+    START_POINT: string;
     /** Height of SVG path for jagged teeth at the end of collapsed blocks. */
     JAGGED_TEETH_HEIGHT: number;
     /** Width of SVG path for jagged teeth at the end of collapsed blocks. */

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

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockSvg } from '../../block_svg.js';
+import { Coordinate } from '../../utils.js';
 import type { Field } from '../measurables/field.js';
 import type { Icon } from '../measurables/icon.js';
 import type { InlineInput } from '../measurables/inline_input.js';
@@ -16,9 +17,9 @@ import type { RenderInfo } from './info.js';
  * @alias Blockly.blockRendering.Drawer
  */
 export declare class Drawer {
-    block_: any;
-    info_: any;
-    topLeft_: any;
+    block_: BlockSvg;
+    info_: RenderInfo;
+    topLeft_: Coordinate;
     outlinePath_: string;
     inlinePath_: string;
     protected constants_: ConstantProvider;

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

@@ -4,7 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockStyle } from '../../theme.js';
+import type { BlockSvg } from '../../block_svg.js';
 import type { ConstantProvider } from './constants.js';
+import { RenderedConnection } from '../../rendered_connection.js';
 /**
  * An interface for a block's path object.
  *
@@ -13,7 +15,11 @@ import type { ConstantProvider } from './constants.js';
  * @alias Blockly.blockRendering.IPathObject
  */
 export interface IPathObject {
-    /** The primary path of the block. */
+    /**
+     * The primary path of the block.
+     *
+     * @internal
+     */
     svgPath: SVGElement;
     /** The renderer's constant provider. */
     constants: ConstantProvider;
@@ -23,19 +29,19 @@ export interface IPathObject {
      * Holds the cursors SVG element when the cursor is attached to the block.
      * This is null if there is no cursor on the block.
      */
-    cursorSvg: SVGElement;
+    cursorSvg: SVGElement | null;
     /**
      * Holds the markers SVG element when the marker is attached to the block.
      * This is null if there is no marker on the block.
      */
-    markerSvg: SVGElement;
+    markerSvg: SVGElement | null;
     /**
      * Set the path generated by the renderer onto the respective SVG element.
      *
      * @param pathString The path.
      * @internal
      */
-    setPath: any;
+    setPath(pathString: string): void;
     /**
      * Apply the stored colours to the block's path, taking into account whether
      * the paths belong to a shadow block.
@@ -43,20 +49,20 @@ export interface IPathObject {
      * @param block The source block.
      * @internal
      */
-    applyColour: any;
+    applyColour(block: BlockSvg): void;
     /**
      * Update the style.
      *
      * @param blockStyle The block style to use.
      * @internal
      */
-    setStyle: any;
+    setStyle(blockStyle: BlockStyle): void;
     /**
      * Flip the SVG paths in RTL.
      *
      * @internal
      */
-    flipRTL: () => void;
+    flipRTL(): void;
     /**
      * Add the cursor SVG to this block's SVG group.
      *
@@ -64,7 +70,7 @@ export interface IPathObject {
      *     group.
      * @internal
      */
-    setCursorSvg: any;
+    setCursorSvg(cursorSvg: SVGElement): void;
     /**
      * Add the marker SVG to this block's SVG group.
      *
@@ -72,7 +78,7 @@ export interface IPathObject {
      *     group.
      * @internal
      */
-    setMarkerSvg: any;
+    setMarkerSvg(markerSvg: SVGElement): void;
     /**
      * Set whether the block shows a highlight or not.  Block highlighting is
      * often used to visually mark blocks currently being executed.
@@ -80,14 +86,14 @@ export interface IPathObject {
      * @param highlighted True if highlighted.
      * @internal
      */
-    updateHighlighted: any;
+    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: any;
+    updateSelected(enabled: boolean): void;
     /**
      * Add or remove styling showing that a block is dragged over a delete area.
      *
@@ -95,21 +101,21 @@ export interface IPathObject {
      *     otherwise.
      * @internal
      */
-    updateDraggingDelete: any;
+    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: any;
+    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: any;
+    updateMovable(enabled: boolean): void;
     /**
      * Add or remove styling that shows that if the dragging block is dropped,
      * this block will be replaced.  If a shadow block, it will disappear.
@@ -118,7 +124,7 @@ export interface IPathObject {
      * @param enable True if styling should be added.
      * @internal
      */
-    updateReplacementFade: any;
+    updateReplacementFade(enabled: boolean): void;
     /**
      * Add or remove styling that shows that if the dragging block is dropped,
      * this block will be connected to the input.
@@ -127,6 +133,6 @@ export interface IPathObject {
      * @param enable True if styling should be added.
      * @internal
      */
-    updateShapeForInputHighlight: any;
+    updateShapeForInputHighlight(conn: RenderedConnection, enable: boolean): void;
 }
 //# sourceMappingURL=i_path_object.d.ts.map

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

@@ -25,9 +25,9 @@ import type { Renderer } from './renderer.js';
  * @alias Blockly.blockRendering.RenderInfo
  */
 export declare class RenderInfo {
-    block_: any;
+    block_: BlockSvg;
     protected constants_: ConstantProvider;
-    outputConnection: OutputConnection;
+    outputConnection: OutputConnection | null;
     isInline: boolean;
     isCollapsed: boolean;
     isInsertionMarker: boolean;
@@ -110,7 +110,7 @@ export declare class RenderInfo {
      * @param lastInput The input that follows.
      * @returns True if the next input should be rendered on a new row.
      */
-    protected shouldStartNewRow_(input: Input, lastInput: Input): boolean;
+    protected shouldStartNewRow_(input: Input, lastInput?: Input): boolean;
     /** Add horizontal spacing between and around elements within each row. */
     protected addElemSpacing_(): void;
     /**

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

@@ -24,7 +24,7 @@ export declare class MarkerSvg {
      */
     private parent_;
     /** The current SVG element for the marker. */
-    currentMarkerSvg: Element | null;
+    currentMarkerSvg: SVGElement | null;
     colour_: string;
     /** The root SVG group containing the marker. */
     protected markerSvg_: SVGGElement | null;
@@ -46,7 +46,7 @@ export declare class MarkerSvg {
      *
      * @returns The root SVG node.
      */
-    getSvgRoot(): SVGElement;
+    getSvgRoot(): SVGElement | null;
     /**
      * Get the marker.
      *
@@ -188,7 +188,7 @@ export declare class MarkerSvg {
      * @param height The height of the block.
      * @param connectionShape The shape object for the connection.
      */
-    protected positionOutput_(width: number, height: number, connectionShape: Notch | PuzzleTab): void;
+    protected positionOutput_(width: number, height: number, connectionShape: PuzzleTab): void;
     /**
      * Position the marker for a previous connection.
      * Displays a half rectangle with a notch in the top to represent the previous
@@ -199,7 +199,7 @@ export declare class MarkerSvg {
      * @param markerHeight The height of the marker.
      * @param connectionShape The shape object for the connection.
      */
-    protected positionPrevious_(width: number, markerOffset: number, markerHeight: number, connectionShape: Notch | PuzzleTab): void;
+    protected positionPrevious_(width: number, markerOffset: number, markerHeight: number, connectionShape: Notch): void;
     /**
      * Move and show the marker at the specified coordinate in workspace units.
      * Displays a filled in rectangle.
@@ -230,7 +230,9 @@ export declare class MarkerSvg {
      *
      * @returns The object holding attributes to make the marker blink.
      */
-    protected getBlinkProperties_(): any;
+    protected getBlinkProperties_(): {
+        [key: string]: string;
+    };
     /**
      * Create the marker SVG.
      *

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

@@ -15,7 +15,7 @@ import type { IPathObject } from './i_path_object.js';
  * @alias Blockly.blockRendering.PathObject
  */
 export declare class PathObject implements IPathObject {
-    svgRoot: any;
+    svgRoot: SVGElement;
     /** @internal */
     svgPath: SVGElement;
     /**
@@ -24,14 +24,14 @@ export declare class PathObject implements IPathObject {
      *
      * @internal
      */
-    cursorSvg: SVGElement;
+    cursorSvg: SVGElement | null;
     /**
      * Holds the markers svg element when the marker is attached to the block.
      * This is null if there is no marker on the block.
      *
      * @internal
      */
-    markerSvg: SVGElement;
+    markerSvg: SVGElement | null;
     /** @internal */
     constants: ConstantProvider;
     /** @internal */

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

@@ -17,8 +17,10 @@ export declare class ConstantProvider extends BaseConstantProvider {
      * inputs inline.
      */
     MAX_BOTTOM_WIDTH: number;
-    STATEMENT_BOTTOM_SPACER: any;
-    /** @internal */
+    STATEMENT_BOTTOM_SPACER: number;
+    /**
+     * @internal
+     */
     constructor();
     getCSS_(selector: string): string[];
 }

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

@@ -7,6 +7,7 @@ import type { BlockSvg } from '../../block_svg.js';
 import { Drawer as BaseDrawer } from '../common/drawer.js';
 import type { Row } from '../measurables/row.js';
 import type { ConstantProvider } from './constants.js';
+import { Highlighter } from './highlighter.js';
 import type { RenderInfo } from './info.js';
 import type { InlineInput } from './measurables/inline_input.js';
 /**
@@ -15,7 +16,7 @@ import type { InlineInput } from './measurables/inline_input.js';
  * @alias Blockly.geras.Drawer
  */
 export declare class Drawer extends BaseDrawer {
-    highlighter_: any;
+    highlighter_: Highlighter;
     constants_: ConstantProvider;
     /**
      * @param block The block to render.

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

@@ -25,7 +25,6 @@ export declare class PathObject extends BasePathObject {
      * @internal
      */
     colourDark: string;
-    style: any;
     /**
      * @param root The root SVG element.
      * @param style The style object to use for colouring.

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

@@ -15,6 +15,7 @@ import { Measurable } from './base.js';
 export declare class Icon extends Measurable {
     icon: BlocklyIcon;
     isVisible: boolean;
+    flipRtl: boolean;
     /**
      * An object containing information about the space an icon takes up during
      * rendering

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

@@ -124,7 +124,7 @@ export declare class Row {
      * @returns The last input on the row, or null.
      * @internal
      */
-    getLastInput(): InputConnection;
+    getLastInput(): InputConnection | null;
     /**
      * Inspect all subcomponents and populate all size properties on the row.
      *
@@ -151,13 +151,13 @@ export declare class Row {
      * @returns The first spacer element on this row.
      * @internal
      */
-    getFirstSpacer(): InRowSpacer;
+    getFirstSpacer(): InRowSpacer | null;
     /**
      * Convenience method to get the last spacer element on this row.
      *
      * @returns The last spacer element on this row.
      * @internal
      */
-    getLastSpacer(): InRowSpacer;
+    getLastSpacer(): InRowSpacer | null;
 }
 //# sourceMappingURL=row.d.ts.map

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

@@ -32,7 +32,6 @@ export declare class TopRow extends Row {
     hasPreviousConnection: boolean;
     /** The previous connection on the block, if any. */
     connection: PreviousConnection | null;
-    widthWithConnectedBlocks: any;
     /**
      * @param constants The rendering constants provider.
      * @internal

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

@@ -16,6 +16,7 @@ import type { Renderer } from './renderer.js';
  * @alias Blockly.minimalist.RenderInfo
  */
 export declare class RenderInfo extends BaseRenderInfo {
+    protected renderer_: Renderer;
     /**
      * @param renderer The renderer in use.
      * @param block The block to measure.

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

@@ -18,9 +18,7 @@ import type { Renderer } from './renderer.js';
  * @alias Blockly.thrasos.RenderInfo
  */
 export declare class RenderInfo extends BaseRenderInfo {
-    widthWithChildren: any;
-    height: any;
-    startY: any;
+    protected renderer_: Renderer;
     /**
      * @param renderer The renderer in use.
      * @param block The block to measure.

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

@@ -25,31 +25,7 @@ export interface InsideCorners {
  */
 export declare class ConstantProvider extends BaseConstantProvider {
     GRID_UNIT: number;
-    SMALL_PADDING: any;
-    MEDIUM_PADDING: any;
-    MEDIUM_LARGE_PADDING: any;
-    LARGE_PADDING: any;
-    CORNER_RADIUS: any;
-    NOTCH_WIDTH: any;
-    NOTCH_HEIGHT: any;
-    NOTCH_OFFSET_LEFT: any;
-    STATEMENT_INPUT_NOTCH_OFFSET: any;
-    MIN_BLOCK_WIDTH: any;
-    MIN_BLOCK_HEIGHT: any;
-    EMPTY_STATEMENT_INPUT_HEIGHT: any;
-    TAB_OFFSET_FROM_TOP: number;
-    TOP_ROW_MIN_HEIGHT: any;
-    TOP_ROW_PRECEDES_STATEMENT_MIN_HEIGHT: any;
-    BOTTOM_ROW_MIN_HEIGHT: any;
-    BOTTOM_ROW_AFTER_STATEMENT_MIN_HEIGHT: any;
-    STATEMENT_BOTTOM_SPACER: any;
     STATEMENT_INPUT_SPACER_MIN_WIDTH: number;
-    STATEMENT_INPUT_PADDING_LEFT: any;
-    EMPTY_INLINE_INPUT_PADDING: any;
-    EMPTY_INLINE_INPUT_HEIGHT: any;
-    DUMMY_INPUT_MIN_HEIGHT: any;
-    DUMMY_INPUT_SHADOW_MIN_HEIGHT: any;
-    CURSOR_WS_WIDTH: any;
     CURSOR_COLOUR: string;
     /**
      * Radius of the cursor for input and output connections.
@@ -68,25 +44,28 @@ export declare class ConstantProvider extends BaseConstantProvider {
         PUZZLE: number;
         NOTCH: number;
     };
-    SHAPE_IN_SHAPE_PADDING: any;
+    /**
+     * Map of output/input shapes and the amount they should cause a block to be
+     * padded. Outer key is the outer shape, inner key is the inner shape.
+     * When a block with the outer shape contains an input block with the inner
+     * shape on its left or right edge, the block elements are aligned such that
+     * the padding specified is reached.
+     *
+     * @internal
+     */
+    SHAPE_IN_SHAPE_PADDING: {
+        [key: number]: {
+            [key: number]: number;
+        };
+    };
     FULL_BLOCK_FIELDS: boolean;
-    FIELD_TEXT_FONTSIZE: any;
     FIELD_TEXT_FONTWEIGHT: string;
     FIELD_TEXT_FONTFAMILY: string;
-    FIELD_BORDER_RECT_RADIUS: any;
-    FIELD_BORDER_RECT_X_PADDING: any;
-    FIELD_BORDER_RECT_Y_PADDING: any;
-    FIELD_BORDER_RECT_HEIGHT: any;
-    FIELD_DROPDOWN_BORDER_RECT_HEIGHT: any;
     FIELD_DROPDOWN_NO_BORDER_RECT_SHADOW: boolean;
     FIELD_DROPDOWN_COLOURED_DIV: boolean;
     FIELD_DROPDOWN_SVG_ARROW: boolean;
-    FIELD_DROPDOWN_SVG_ARROW_PADDING: any;
     FIELD_TEXTINPUT_BOX_SHADOW: boolean;
     FIELD_COLOUR_FULL_BLOCK: boolean;
-    FIELD_COLOUR_DEFAULT_WIDTH: any;
-    FIELD_COLOUR_DEFAULT_HEIGHT: any;
-    FIELD_CHECKBOX_X_OFFSET: any;
     MAX_DYNAMIC_CONNECTION_SHAPE_WIDTH: number;
     /** The selected glow colour. */
     SELECTED_GLOW_COLOUR: string;
@@ -171,18 +150,18 @@ export declare class ConstantProvider extends BaseConstantProvider {
     shapeFor(connection: RenderedConnection): Shape;
     makeNotch(): {
         type: number;
-        width: any;
-        height: any;
+        width: number;
+        height: number;
         pathLeft: string;
         pathRight: string;
     };
     makeInsideCorners(): {
-        width: any;
-        height: any;
+        width: number;
+        height: number;
         pathTop: string;
         pathBottom: string;
-        rightWidth: any;
-        rightHeight: any;
+        rightWidth: number;
+        rightHeight: number;
         pathTopRight: string;
         pathBottomRight: string;
     };

package/core/renderers/zelos/measurables/inputs.d.ts

@@ -14,7 +14,6 @@ import { StatementInput as BaseStatementInput } from '../../../renderers/measura
  */
 export declare class StatementInput extends BaseStatementInput {
     connectedBottomNextConnection: boolean;
-    height: any;
     /**
      * @param constants The rendering constants provider.
      * @param input The statement input to measure and store information for.

package/core/renderers/zelos/path_object.d.ts

@@ -30,7 +30,7 @@ export declare class PathObject extends BasePathObject {
      * The type of block's output connection shape.  This is set when a block
      * with an output connection is drawn.
      */
-    outputShapeType: null;
+    outputShapeType: number | null;
     /** @internal */
     constants: ConstantProvider;
     /**

package/core/theme.d.ts

@@ -4,15 +4,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 export interface ITheme {
-    blockStyles: {
+    blockStyles?: {
         [key: string]: BlockStyle;
     };
-    categoryStyles: {
+    categoryStyles?: {
         [key: string]: CategoryStyle;
     };
-    componentStyles: ComponentStyle;
-    fontStyle: FontStyle;
-    startHats: boolean | null;
+    componentStyles?: ComponentStyle;
+    fontStyle?: FontStyle;
+    startHats?: boolean;
     base?: string | Theme;
     name: string;
 }
@@ -41,7 +41,7 @@ export declare class Theme implements ITheme {
      *
      * @internal
      */
-    startHats: boolean | null;
+    startHats?: boolean;
     /**
      * @param name Theme name.
      * @param opt_blockStyles A map from style names (strings) to objects with
@@ -115,35 +115,35 @@ export declare class Theme implements ITheme {
 export declare namespace Theme {
     interface BlockStyle {
         colourPrimary: string;
-        colourSecondary: string;
-        colourTertiary: string;
+        colourSecondary?: string;
+        colourTertiary?: string;
         hat?: string;
     }
     interface CategoryStyle {
         colour: string;
     }
     interface ComponentStyle {
-        workspaceBackgroundColour: string | null;
-        toolboxBackgroundColour: string | null;
-        toolboxForegroundColour: string | null;
-        flyoutBackgroundColour: string | null;
-        flyoutForegroundColour: string | null;
-        flyoutOpacity: number | null;
-        scrollbarColour: string | null;
-        scrollbarOpacity: number | null;
-        insertionMarkerColour: string | null;
-        insertionMarkerOpacity: number | null;
-        markerColour: string | null;
-        cursorColour: string | null;
-        selectedGlowColour: string | null;
-        selectedGlowOpacity: number | null;
-        replacementGlowColour: string | null;
-        replacementGlowOpacity: number | null;
+        workspaceBackgroundColour?: string;
+        toolboxBackgroundColour?: string;
+        toolboxForegroundColour?: string;
+        flyoutBackgroundColour?: string;
+        flyoutForegroundColour?: string;
+        flyoutOpacity?: number;
+        scrollbarColour?: string;
+        scrollbarOpacity?: number;
+        insertionMarkerColour?: string;
+        insertionMarkerOpacity?: number;
+        markerColour?: string;
+        cursorColour?: string;
+        selectedGlowColour?: string;
+        selectedGlowOpacity?: number;
+        replacementGlowColour?: string;
+        replacementGlowOpacity?: number;
     }
     interface FontStyle {
-        family: string | null;
-        weight: string | null;
-        size: number | null;
+        family?: string;
+        weight?: string;
+        size?: number;
     }
 }
 export declare type BlockStyle = Theme.BlockStyle;