blockly 9.2.1 → 9.3.0

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

@@ -11,49 +11,36 @@ import type { IPathObject } from './i_path_object.js';
 /**
  * An object that handles creating and setting each of the SVG elements
  * used by the renderer.
- *
- * @alias Blockly.blockRendering.PathObject
  */
 export declare class PathObject implements IPathObject {
     svgRoot: SVGElement;
-    /** @internal */
     svgPath: SVGElement;
     /**
      * Holds the cursors svg element when the cursor is attached to the block.
      * This is null if there is no cursor on the block.
-     *
-     * @internal
      */
     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 | null;
-    /** @internal */
     constants: ConstantProvider;
-    /** @internal */
     style: BlockStyle;
     /**
      * @param root The root SVG element.
      * @param style The style object to use for colouring.
      * @param constants The renderer's constants.
-     * @internal
      */
     constructor(root: SVGElement, style: BlockStyle, constants: ConstantProvider);
     /**
      * Set the path generated by the renderer onto the respective SVG element.
      *
      * @param pathString The path.
-     * @internal
      */
     setPath(pathString: string): void;
     /**
      * Flip the SVG paths in RTL.
-     *
-     * @internal
      */
     flipRTL(): void;
     /**
@@ -61,7 +48,6 @@ export declare class PathObject implements IPathObject {
      *
      * @param cursorSvg The SVG root of the cursor to be added to the block SVG
      *     group.
-     * @internal
      */
     setCursorSvg(cursorSvg: SVGElement): void;
     /**
@@ -69,7 +55,6 @@ export declare class PathObject implements IPathObject {
      *
      * @param markerSvg The SVG root of the marker to be added to the block SVG
      *     group.
-     * @internal
      */
     setMarkerSvg(markerSvg: SVGElement): void;
     /**
@@ -77,14 +62,12 @@ export declare class PathObject implements IPathObject {
      * the paths belong to a shadow block.
      *
      * @param block The source block.
-     * @internal
      */
     applyColour(block: BlockSvg): void;
     /**
      * Set the style.
      *
      * @param blockStyle The block style to use.
-     * @internal
      */
     setStyle(blockStyle: BlockStyle): void;
     /**
@@ -100,7 +83,6 @@ export declare class PathObject implements IPathObject {
      * often used to visually mark blocks currently being executed.
      *
      * @param enable True if highlighted.
-     * @internal
      */
     updateHighlighted(enable: boolean): void;
     /**
@@ -119,7 +101,6 @@ export declare class PathObject implements IPathObject {
      * Add or remove styling showing that a block is selected.
      *
      * @param enable True if selection is enabled, false otherwise.
-     * @internal
      */
     updateSelected(enable: boolean): void;
     /**
@@ -127,21 +108,18 @@ export declare class PathObject implements IPathObject {
      *
      * @param enable True if the block is being dragged over a delete area, false
      *     otherwise.
-     * @internal
      */
     updateDraggingDelete(enable: 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(enable: boolean): void;
     /**
      * Add or remove styling showing that a block is movable.
      *
      * @param enable True if the block is movable, false otherwise.
-     * @internal
      */
     updateMovable(enable: boolean): void;
     /**
@@ -150,7 +128,6 @@ export declare class PathObject implements IPathObject {
      * Otherwise it will bump.
      *
      * @param enable True if styling should be added.
-     * @internal
      */
     updateReplacementFade(enable: boolean): void;
     /**
@@ -159,7 +136,6 @@ export declare class PathObject implements IPathObject {
      *
      * @param _conn The connection on the input to highlight.
      * @param _enable True if styling should be added.
-     * @internal
      */
     updateShapeForInputHighlight(_conn: Connection, _enable: boolean): void;
 }

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

@@ -19,30 +19,23 @@ import { RenderInfo } from './info.js';
 import { MarkerSvg } from './marker_svg.js';
 /**
  * The base class for a block renderer.
- *
- * @alias Blockly.blockRendering.Renderer
  */
 export declare class Renderer implements IRegistrable {
     /** The renderer's constant provider. */
     protected constants_: ConstantProvider;
-    /** @internal */
-    name: string;
+    protected name: string;
     /**
      * Rendering constant overrides, passed in through options.
-     *
-     * @internal
      */
-    overrides: object | null;
+    protected overrides: object | null;
     /**
      * @param name The renderer name.
-     * @internal
      */
     constructor(name: string);
     /**
      * Gets the class name that identifies this renderer.
      *
      * @returns The CSS class name.
-     * @internal
      */
     getClassName(): string;
     /**
@@ -50,13 +43,14 @@ export declare class Renderer implements IRegistrable {
      *
      * @param theme The workspace theme object.
      * @param opt_rendererOverrides Rendering constant overrides.
-     * @internal
      */
     init(theme: Theme, opt_rendererOverrides?: {
         [rendererConstant: string]: any;
     }): void;
     /**
      * Create any DOM elements that this renderer needs.
+     * If you need to create additional DOM elements, override the
+     * {@link ConstantProvider#createDom} method instead.
      *
      * @param svg The root of the workspace's SVG.
      * @param theme The workspace theme object.
@@ -68,14 +62,11 @@ export declare class Renderer implements IRegistrable {
      *
      * @param svg The root of the workspace's SVG.
      * @param theme The workspace theme object.
-     * @internal
      */
     refreshDom(svg: SVGElement, theme: Theme): void;
     /**
      * Dispose of this renderer.
      * Delete all DOM elements that this renderer and its constants created.
-     *
-     * @internal
      */
     dispose(): void;
     /**
@@ -114,7 +105,6 @@ export declare class Renderer implements IRegistrable {
      * @param workspace The workspace the marker belongs to.
      * @param marker The marker.
      * @returns The object in charge of drawing the marker.
-     * @internal
      */
     makeMarkerDrawer(workspace: WorkspaceSvg, marker: Marker): MarkerSvg;
     /**
@@ -123,7 +113,6 @@ export declare class Renderer implements IRegistrable {
      * @param root The root SVG element.
      * @param style The style object to use for colouring.
      * @returns The renderer path object.
-     * @internal
      */
     makePathObject(root: SVGElement, style: BlockStyle): IPathObject;
     /**
@@ -131,7 +120,6 @@ export declare class Renderer implements IRegistrable {
      * called, the renderer has already been initialized.
      *
      * @returns The constant provider.
-     * @internal
      */
     getConstants(): ConstantProvider;
     /**
@@ -139,7 +127,6 @@ export declare class Renderer implements IRegistrable {
      *
      * @param _conn The connection to determine whether or not to highlight.
      * @returns True if we should highlight the connection.
-     * @internal
      */
     shouldHighlightConnection(_conn: Connection): boolean;
     /**
@@ -153,9 +140,8 @@ export declare class Renderer implements IRegistrable {
      * @param orphanBlock The orphan block that wants to find a home.
      * @param localType The type of the connection being dragged.
      * @returns Whether there is a home for the orphan or not.
-     * @internal
      */
-    orphanCanConnectAtEnd(topBlock: BlockSvg, orphanBlock: BlockSvg, localType: number): boolean;
+    protected orphanCanConnectAtEnd(topBlock: BlockSvg, orphanBlock: BlockSvg, localType: number): boolean;
     /**
      * Chooses a connection preview method based on the available connection, the
      * current dragged connection, and the block being dragged.
@@ -164,7 +150,6 @@ export declare class Renderer implements IRegistrable {
      * @param local The connection currently being dragged.
      * @param topBlock The block currently being dragged.
      * @returns The preview type to display.
-     * @internal
      */
     getConnectionPreviewMethod(closest: RenderedConnection, local: RenderedConnection, topBlock: BlockSvg): PreviewType;
     /**

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

@@ -6,8 +6,6 @@
 import { ConstantProvider as BaseConstantProvider } from '../common/constants.js';
 /**
  * An object that provides constants for rendering blocks in Geras mode.
- *
- * @alias Blockly.geras.ConstantProvider
  */
 export declare class ConstantProvider extends BaseConstantProvider {
     FIELD_TEXT_BASELINE_CENTER: boolean;
@@ -18,9 +16,6 @@ export declare class ConstantProvider extends BaseConstantProvider {
      */
     MAX_BOTTOM_WIDTH: number;
     STATEMENT_BOTTOM_SPACER: number;
-    /**
-     * @internal
-     */
     constructor();
     getCSS_(selector: string): string[];
 }

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

@@ -11,9 +11,8 @@ import { Highlighter } from './highlighter.js';
 import type { RenderInfo } from './info.js';
 import type { InlineInput } from './measurables/inline_input.js';
 /**
- * An object that draws a block based on the given rendering information.
- *
- * @alias Blockly.geras.Drawer
+ * An object that draws a block based on the given rendering information,
+ * customized for the geras renderer.
  */
 export declare class Drawer extends BaseDrawer {
     highlighter_: Highlighter;
@@ -22,7 +21,6 @@ export declare class Drawer extends BaseDrawer {
      * @param block The block to render.
      * @param info An object containing all information needed to render this
      *     block.
-     * @internal
      */
     constructor(block: BlockSvg, info: RenderInfo);
     draw(): void;

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

@@ -46,8 +46,6 @@ export interface JaggedTeeth {
  * Some highlights are simple offsets of the parent paths and can be generated
  * programmatically.  Others, especially on curves, are just made out of piles
  * of constants and are hard to tweak.
- *
- * @alias Blockly.geras.HighlightConstantProvider
  */
 export declare class HighlightConstantProvider {
     constantProvider: ConstantProvider;
@@ -62,50 +60,41 @@ export declare class HighlightConstantProvider {
     START_HAT: StartHat;
     /**
      * @param constants The rendering constants provider.
-     * @internal
      */
     constructor(constants: ConstantProvider);
     /**
      * Initialize shape objects based on the constants set in the constructor.
-     *
-     * @internal
      */
     init(): void;
     /**
      * @returns An object containing sizing and path information about inside
      *     corner highlights.
-     * @internal
      */
-    makeInsideCorner(): InsideCorner;
+    protected makeInsideCorner(): InsideCorner;
     /**
      * @returns An object containing sizing and path information about outside
      *     corner highlights.
-     * @internal
      */
-    makeOutsideCorner(): OutsideCorner;
+    protected makeOutsideCorner(): OutsideCorner;
     /**
      * @returns An object containing sizing and path information about puzzle tab
      *     highlights.
-     * @internal
      */
-    makePuzzleTab(): PuzzleTab;
+    protected makePuzzleTab(): PuzzleTab;
     /**
      * @returns An object containing sizing and path information about notch
      *     highlights.
-     * @internal
      */
-    makeNotch(): Notch;
+    protected makeNotch(): Notch;
     /**
      * @returns An object containing sizing and path information about collapsed
      *     block edge highlights.
-     * @internal
      */
-    makeJaggedTeeth(): JaggedTeeth;
+    protected makeJaggedTeeth(): JaggedTeeth;
     /**
      * @returns An object containing sizing and path information about start
      *     highlights.
-     * @internal
      */
-    makeStartHat(): StartHat;
+    protected makeStartHat(): StartHat;
 }
 //# sourceMappingURL=highlight_constants.d.ts.map

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

@@ -20,8 +20,6 @@ import type { InlineInput } from './measurables/inline_input.js';
  * position of each part of the block.  The resulting paths are not continuous
  * or closed paths.  The highlights for tabs and notches are loosely based on
  * tab and notch shapes, but are not exactly the same.
- *
- * @alias Blockly.geras.Highlighter
  */
 export declare class Highlighter {
     info_: RenderInfo;
@@ -40,69 +38,58 @@ export declare class Highlighter {
     /**
      * @param info An object containing all information needed to render this
      *     block.
-     * @internal
      */
     constructor(info: RenderInfo);
     /**
      * Get the steps for the highlight path.
      *
      * @returns The steps for the highlight path.
-     * @internal
      */
     getPath(): string;
     /**
      * Add a highlight to the top corner of a block.
      *
      * @param row The top row of the block.
-     * @internal
      */
     drawTopCorner(row: TopRow): void;
     /**
      * Add a highlight on a jagged edge for a collapsed block.
      *
      * @param row  The row to highlight.
-     * @internal
      */
     drawJaggedEdge_(row: Row): void;
     /**
      * Add a highlight on a value input.
      *
      * @param row The row the input belongs to.
-     * @internal
      */
     drawValueInput(row: Row): void;
     /**
      * Add a highlight on a statement input.
      *
      * @param row The row to highlight.
-     * @internal
      */
     drawStatementInput(row: Row): void;
     /**
      * Add a highlight on the right side of a row.
      *
      * @param row The row to highlight.
-     * @internal
      */
     drawRightSideRow(row: Row): void;
     /**
      * Add a highlight to the bottom row.
      *
      * @param row The row to highlight.
-     * @internal
      */
     drawBottomRow(row: BottomRow): void;
     /**
      * Draw the highlight on the left side of the block.
-     *
-     * @internal
      */
     drawLeft(): void;
     /**
      * Add a highlight to an inline input.
      *
      * @param input The input to highlight.
-     * @internal
      */
     drawInlineInput(input: InlineInput): void;
 }

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

@@ -11,13 +11,12 @@ import type { Row } from '../measurables/row.js';
 import type { ConstantProvider } from './constants.js';
 import type { Renderer } from './renderer.js';
 /**
- * An object containing all sizing information needed to draw this block.
+ * An object containing all sizing information needed to draw this block,
+ * customized for the geras renderer.
  *
  * 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.geras.RenderInfo
  */
 export declare class RenderInfo extends BaseRenderInfo {
     constants_: ConstantProvider;
@@ -25,14 +24,12 @@ export declare class RenderInfo extends BaseRenderInfo {
     /**
      * @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;
     populateBottomRow_(): void;

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

@@ -10,15 +10,12 @@ import type { ConstantProvider as GerasConstantProvider } from '../constants.js'
 /**
  * An object containing information about the space an inline input takes up
  * during rendering.
- *
- * @alias Blockly.geras.InlineInput
  */
 export declare class InlineInput extends BaseInlineInput {
     constants_: GerasConstantProvider;
     /**
      * @param constants The rendering constants provider.
      * @param input The inline input to measure and store information for.
-     * @internal
      */
     constructor(constants: BaseConstantProvider, input: Input);
 }

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

@@ -10,15 +10,12 @@ import type { ConstantProvider as GerasConstantProvider } from '../constants.js'
 /**
  * An object containing information about the space a statement input takes up
  * during rendering.
- *
- * @alias Blockly.geras.StatementInput
  */
 export declare class StatementInput extends BaseStatementInput {
     constants_: GerasConstantProvider;
     /**
      * @param constants The rendering constants provider.
      * @param input The statement input to measure and store information for.
-     * @internal
      */
     constructor(constants: BaseConstantProvider, input: Input);
 }

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

@@ -10,26 +10,19 @@ import type { ConstantProvider } from './constants.js';
 /**
  * An object that handles creating and setting each of the SVG elements
  * used by the renderer.
- *
- * @alias Blockly.geras.PathObject
  */
 export declare class PathObject extends BasePathObject {
     constants: ConstantProvider;
-    /** @internal */
     svgPathDark: SVGElement;
-    /** @internal */
     svgPathLight: SVGElement;
     /**
      * The colour of the dark path on the block in '#RRGGBB' format.
-     *
-     * @internal
      */
     colourDark: string;
     /**
      * @param root The root SVG element.
      * @param style The style object to use for colouring.
      * @param constants The renderer's constants.
-     * @internal
      */
     constructor(root: SVGElement, style: BlockStyle, constants: ConstantProvider);
     setPath(mainPath: string): void;
@@ -37,7 +30,6 @@ export declare class PathObject extends BasePathObject {
      * Set the highlight path generated by the renderer onto the SVG element.
      *
      * @param highlightPath The highlight path.
-     * @internal
      */
     setHighlightPath(highlightPath: string): void;
     flipRTL(): void;

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

@@ -13,23 +13,23 @@ import { HighlightConstantProvider } from './highlight_constants.js';
 import { RenderInfo } from './info.js';
 import { PathObject } from './path_object.js';
 /**
- * The geras renderer.
+ * The geras renderer. This renderer was designed to be backwards compatible
+ * with pre-2019 Blockly. Newer projects that are not constrained by backwards
+ * compatibility should use thrasos, which is a more modern take on this
+ * renderer.
  *
- * @alias Blockly.geras.Renderer
+ * Geras is the ancient Greek spirit of old age.
  */
 export declare class Renderer extends BaseRenderer {
     /** The renderer's highlight constant provider. */
     private highlightConstants_;
     /**
      * @param name The renderer name.
-     * @internal
      */
     constructor(name: string);
     /**
      * Initialize the renderer.  Geras has a highlight provider in addition to
      * the normal constant provider.
-     *
-     * @internal
      */
     init(theme: Theme, opt_rendererOverrides?: {
         [rendererConstant: string]: any;
@@ -58,7 +58,6 @@ export declare class Renderer extends BaseRenderer {
      * @param root The root SVG element.
      * @param style The style object to use for colouring.
      * @returns The renderer path object.
-     * @internal
      */
     makePathObject(root: SVGElement, style: BlockStyle): PathObject;
     /**
@@ -72,7 +71,6 @@ export declare class Renderer extends BaseRenderer {
      * is called, the renderer has already been initialized.
      *
      * @returns The highlight constant provider.
-     * @internal
      */
     getHighlightConstants(): HighlightConstantProvider;
 }

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

@@ -8,8 +8,6 @@ import type { ConstantProvider } from '../common/constants.js';
  * The base class to represent a part of a block that takes up space during
  * rendering.  The constructor for each non-spacer Measurable records the size
  * of the block element (e.g. field, statement input).
- *
- * @alias Blockly.blockRendering.Measurable
  */
 export declare class Measurable {
     width: number;
@@ -22,7 +20,6 @@ export declare class Measurable {
     protected readonly constants_: ConstantProvider;
     /**
      * @param constants The rendering constants provider.
-     * @internal
      */
     constructor(constants: ConstantProvider);
 }

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

@@ -12,28 +12,20 @@ import { Row } from './row.js';
  * a block as well as spacing information for the bottom row.
  * Elements in a bottom row can consist of corners, spacers and next
  * connections.
- *
- * @alias Blockly.blockRendering.BottomRow
  */
 export declare class BottomRow extends Row {
     /**
      * Whether this row has a next connection.
-     *
-     * @internal
      */
     hasNextConnection: boolean;
     /**
      * The next connection on the row, if any.
-     *
-     * @internal
      */
     connection: NextConnection | null;
     /**
      * The amount that the bottom of the block extends below the horizontal
      * edge, e.g. because of a next connection.  Must be non-negative (see
      * #2820).
-     *
-     * @internal
      */
     descenderHeight: number;
     /**
@@ -43,7 +35,6 @@ export declare class BottomRow extends Row {
     baseline: number;
     /**
      * @param constants The rendering constants provider.
-     * @internal
      */
     constructor(constants: ConstantProvider);
     /**

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

@@ -9,8 +9,6 @@ import { Measurable } from './base.js';
 /**
  * The base class to represent a connection and the space that it takes up on
  * the block.
- *
- * @alias Blockly.blockRendering.Connection
  */
 export declare class Connection extends Measurable {
     connectionModel: RenderedConnection;
@@ -20,7 +18,6 @@ export declare class Connection extends Measurable {
      * @param constants The rendering constants provider.
      * @param connectionModel The connection object on the block that this
      *     represents.
-     * @internal
      */
     constructor(constants: ConstantProvider, connectionModel: RenderedConnection);
 }

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

@@ -9,8 +9,6 @@ import { InputConnection } from './input_connection.js';
 /**
  * An object containing information about the space an external value input
  * takes up during rendering
- *
- * @alias Blockly.blockRendering.ExternalValueInput
  */
 export declare class ExternalValueInput extends InputConnection {
     height: number;
@@ -21,7 +19,6 @@ export declare class ExternalValueInput extends InputConnection {
     /**
      * @param constants The rendering constants provider.
      * @param input The external value input to measure and store information for.
-     * @internal
      */
     constructor(constants: ConstantProvider, input: Input);
 }

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

@@ -10,8 +10,6 @@ import { Measurable } from './base.js';
 /**
  * An object containing information about the space a field takes up during
  * rendering
- *
- * @alias Blockly.blockRendering.Field
  */
 export declare class Field extends Measurable {
     field: BlocklyField;
@@ -24,7 +22,6 @@ export declare class Field extends Measurable {
      * @param constants The rendering constants provider.
      * @param field The field to measure and store information for.
      * @param parentInput The parent input for the field.
-     * @internal
      */
     constructor(constants: ConstantProvider, field: BlocklyField, parentInput: Input);
 }