blockly 9.0.0-beta.0 → 9.0.0-beta.2

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

@@ -56,6 +56,7 @@ export declare type BaseShape = {
     width: number;
     height: number;
 };
+/** An object containing sizing and type information about a dynamic shape. */
 export declare type DynamicShape = {
     type: number;
     width: (p1: number) => number;
@@ -70,9 +71,16 @@ export declare type DynamicShape = {
 };
 /** An object containing sizing and type information about a shape. */
 export declare type Shape = BaseShape | DynamicShape;
-/** An object containing sizing and type information about a dynamic shape. */
+/**
+ * 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.
+ *
  * @alias Blockly.blockRendering.ConstantProvider
  */
 export declare class ConstantProvider {
@@ -140,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. */
@@ -153,12 +161,12 @@ export declare class ConstantProvider {
     FIELD_TEXT_FONTFAMILY: string;
     /**
      * Height of text.  This constant is dynamically set in
-     * ``setFontConstants_`` to be the height of the text based on the font
+     * `setFontConstants_` to be the height of the text based on the font
      * used.
      */
     FIELD_TEXT_HEIGHT: number;
     /**
-     * Text baseline.  This constant is dynamically set in ``setFontConstants_``
+     * Text baseline.  This constant is dynamically set in `setFontConstants_`
      * to be the baseline of the text based on the font used.
      */
     FIELD_TEXT_BASELINE: number;
@@ -172,6 +180,7 @@ 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;
@@ -216,6 +225,7 @@ export declare class ConstantProvider {
     private defs_;
     /**
      * The ID of the emboss filter, or the empty string if no filter is set.
+     *
      * @internal
      */
     embossFilterId: string;
@@ -223,6 +233,7 @@ export declare class ConstantProvider {
     private embossFilter_;
     /**
      * The ID of the disabled pattern, or the empty string if no pattern is set.
+     *
      * @internal
      */
     disabledPatternId: string;
@@ -242,52 +253,62 @@ 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;
@@ -308,35 +329,41 @@ export declare class ConstantProvider {
     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;
     /**
      * Sets dynamic properties that depend on other values or theme properties.
+     *
      * @param theme The current workspace theme.
      */
     protected setDynamicProperties_(theme: Theme): void;
     /**
      * Set constants related to fonts.
+     *
      * @param theme The current workspace theme.
      */
     protected setFontConstants_(theme: Theme): void;
     /**
      * Set constants from a theme's component styles.
+     *
      * @param theme The current workspace theme.
      */
     protected setComponentConstants_(theme: Theme): void;
     /**
      * Get or create a block style based on a single colour value.  Generate a
      * name for the style based on the colour.
+     *
      * @param colour #RRGGBB colour string.
-     * @return An object containing the style and an autogenerated name for that
+     * @returns An object containing the style and an autogenerated name for that
      *     style.
      * @internal
      */
@@ -346,22 +373,25 @@ export declare class ConstantProvider {
     };
     /**
      * Gets the BlockStyle for the given block style name.
+     *
      * @param blockStyleName The name of the block style.
-     * @return The named block style, or a default style if no style with the
+     * @returns The named block style, or a default style if no style with the
      *     given name was found.
      */
     getBlockStyle(blockStyleName: string | null): BlockStyle;
     /**
      * Create a block style object based on the given colour.
+     *
      * @param colour #RRGGBB colour string.
-     * @return A populated block style based on the given colour.
+     * @returns A populated block style based on the given colour.
      */
     protected createBlockStyle_(colour: string): BlockStyle;
     /**
      * Get a full block style object based on the input style object.  Populate
      * any missing values.
+     *
      * @param blockStyle A full or partial block style object.
-     * @return A full block style object, with all required properties populated.
+     * @returns A full block style object, with all required properties populated.
      */
     protected validatedBlockStyle_(blockStyle: {
         colourPrimary: string;
@@ -371,51 +401,55 @@ export declare class ConstantProvider {
     }): BlockStyle;
     /**
      * Generate a secondary colour from the passed in primary colour.
+     *
      * @param inputColour Primary colour.
-     * @return The generated secondary colour.
+     * @returns The generated secondary colour.
      */
     protected generateSecondaryColour_(inputColour: string): string;
     /**
      * Generate a tertiary colour from the passed in primary colour.
+     *
      * @param inputColour Primary colour.
-     * @return The generated tertiary colour.
+     * @returns The generated tertiary colour.
      */
     protected generateTertiaryColour_(inputColour: string): string;
     /**
      * Dispose of this constants provider.
      * Delete all DOM elements that this provider created.
+     *
      * @internal
      */
     dispose(): void;
     /**
-     * @return An object containing sizing and path information about collapsed
+     * @returns An object containing sizing and path information about collapsed
      *     block indicators.
      * @internal
      */
     makeJaggedTeeth(): JaggedTeeth;
     /**
-     * @return An object containing sizing and path information about start hats.
+     * @returns An object containing sizing and path information about start hats.
      * @internal
      */
     makeStartHat(): StartHat;
     /**
-     * @return An object containing sizing and path information about puzzle tabs.
+     * @returns An object containing sizing and path information about puzzle
+     *     tabs.
      * @internal
      */
     makePuzzleTab(): PuzzleTab;
     /**
-     * @return An object containing sizing and path information about notches.
+     * @returns An object containing sizing and path information about notches.
      * @internal
      */
     makeNotch(): Notch;
     /**
-     * @return An object containing sizing and path information about inside
+     * @returns An object containing sizing and path information about inside
      *     corners.
      * @internal
      */
     makeInsideCorners(): InsideCorners;
     /**
-     * @return An object containing sizing and path information about outside
+     * @returns An object containing sizing and path information about outside
      *     corners.
      * @internal
      */
@@ -423,13 +457,15 @@ export declare class ConstantProvider {
     /**
      * 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
-     * @return The shape object for the connection.
+     * @returns The shape object for the connection.
      * @internal
      */
     shapeFor(connection: RenderedConnection): Shape;
     /**
      * Create any DOM elements that this renderer needs (filters, patterns, etc).
+     *
      * @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.
@@ -445,14 +481,17 @@ export declare class ConstantProvider {
     private createDebugFilter;
     /**
      * Inject renderer specific CSS into the page.
+     *
      * @param tagName The name of the style tag to use.
      * @param selector The CSS selector to use.
      */
     protected injectCSS_(tagName: string, selector: string): void;
     /**
      * Get any renderer specific CSS to inject when the renderer is initialized.
+     *
      * @param selector CSS selector to use.
-     * @return Array of CSS strings.
+     * @returns Array of CSS strings.
      */
     protected getCSS_(selector: string): string[];
 }
+//# sourceMappingURL=constants.d.ts.map

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

@@ -5,13 +5,15 @@
  */
 /**
  * Returns whether the debugger is turned on.
- * @return 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.
@@ -20,9 +22,11 @@ export declare function isDebuggerEnabled(): boolean;
 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
  */
 export declare function stopDebugger(): void;
+//# sourceMappingURL=debug.d.ts.map

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

@@ -12,6 +12,7 @@ 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 {
@@ -19,7 +20,6 @@ export declare class Debug {
     /**
      * Configuration object containing booleans to enable and disable debug
      * rendering of specific rendering components.
-     * @struct
      */
     static config: {
         rowSpacers: boolean;
@@ -46,11 +46,13 @@ export declare class Debug {
     constructor(constants: ConstantProvider);
     /**
      * Remove all elements the this object created on the last pass.
+     *
      * @internal
      */
     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.
@@ -59,6 +61,7 @@ export declare class Debug {
     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.
@@ -67,6 +70,7 @@ export declare class Debug {
     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
@@ -76,6 +80,7 @@ export declare class Debug {
      * 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
      * a connected pair will look like a bullseye.
+     *
      * @param conn The connection to circle.
      * @suppress {visibility} Suppress visibility of conn.offsetInBlock_ since
      * this is a debug module.
@@ -84,6 +89,7 @@ export declare class Debug {
     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.
@@ -92,6 +98,7 @@ export declare class Debug {
     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.
@@ -100,12 +107,14 @@ export declare class Debug {
     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;
     /**
      * 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
@@ -113,8 +122,10 @@ export declare class Debug {
     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;
 }
+//# sourceMappingURL=debugger.d.ts.map

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';
@@ -12,12 +13,13 @@ 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_: any;
-    info_: any;
-    topLeft_: any;
+    block_: BlockSvg;
+    info_: RenderInfo;
+    topLeft_: Coordinate;
     outlinePath_: string;
     inlinePath_: string;
     protected constants_: ConstantProvider;
@@ -36,6 +38,7 @@ 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;
@@ -57,23 +60,27 @@ export declare class Drawer {
     protected drawTop_(): void;
     /**
      * Add steps for the jagged edge of a row on a collapsed block.
+     *
      * @param row The row to draw the side of.
      */
     protected drawJaggedEdge_(row: Row): void;
     /**
      * Add steps for an external value input, rendered as a notch in the side
      * of the block.
+     *
      * @param row The row that this input belongs to.
      */
     protected drawValueInput_(row: Row): void;
     /**
      * Add steps for a statement input.
+     *
      * @param row The row that this input belongs to.
      */
     protected drawStatementInput_(row: Row): void;
     /**
      * Add steps for the right side of a row that does not have value or
      * statement input connections.
+     *
      * @param row The row to draw the side of.
      */
     protected drawRightSideRow_(row: Row): void;
@@ -94,11 +101,13 @@ export declare class Drawer {
     protected drawInternals_(): void;
     /**
      * Push a field or icon's new position to its SVG root.
+     *
      * @param fieldInfo The rendering information for the field or icon.
      */
     protected layoutField_(fieldInfo: Icon | Field): void;
     /**
      * Add steps for an inline input.
+     *
      * @param input The information about the input to render.
      */
     protected drawInlineInput_(input: InlineInput): void;
@@ -106,6 +115,7 @@ export declare class Drawer {
      * Position the connection on an inline value input, taking into account
      * RTL and the small gap between the parent block and child block which lets
      * the parent block's dark path show through.
+     *
      * @param input The information about the input that the connection is on.
      */
     protected positionInlineInputConnection_(input: InlineInput): void;
@@ -113,6 +123,7 @@ export declare class Drawer {
      * Position the connection on a statement input, taking into account
      * RTL and the small gap between the parent block and child block which lets
      * the parent block's dark path show through.
+     *
      * @param row The row that the connection is on.
      */
     protected positionStatementInputConnection_(row: Row): void;
@@ -120,6 +131,7 @@ export declare class Drawer {
      * Position the connection on an external value input, taking into account
      * RTL and the small gap between the parent block and child block which lets
      * the parent block's dark path show through.
+     *
      * @param row The row that the connection is on.
      */
     protected positionExternalValueConnection_(row: Row): void;
@@ -130,3 +142,4 @@ export declare class Drawer {
     /** Position the output connection on a block. */
     protected positionOutputConnection_(): void;
 }
+//# sourceMappingURL=drawer.d.ts.map

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

@@ -4,15 +4,22 @@
  * 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.
+ *
  * @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. */
+    /**
+     * The primary path of the block.
+     *
+     * @internal
+     */
     svgPath: SVGElement;
     /** The renderer's constant provider. */
     constants: ConstantProvider;
@@ -22,96 +29,110 @@ 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.
+     *
      * @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.
+     *
      * @param cursorSvg The SVG root of the cursor to be added to the block SVG
      *     group.
      * @internal
      */
-    setCursorSvg: any;
+    setCursorSvg(cursorSvg: SVGElement): void;
     /**
      * Add the marker SVG to this block's SVG group.
+     *
      * @param markerSvg The SVG root of the marker to be added to the block SVG
      *     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.
+     *
      * @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.
+     *
      * @param enable True if the block is being dragged over a delete area, false
      *     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.
      * Otherwise it will bump.
+     *
      * @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.
+     *
      * @param conn The connection on the input to highlight.
      * @param enable True if styling should be added.
      * @internal
      */
-    updateShapeForInputHighlight: any;
+    updateShapeForInputHighlight(conn: RenderedConnection, enable: boolean): void;
 }
+//# sourceMappingURL=i_path_object.d.ts.map