blockly 12.0.0-beta.4 → 12.0.0-beta.6

package/core/interfaces/i_ast_node_location_svg.d.ts

@@ -1,24 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { IASTNodeLocation } from './i_ast_node_location.js';
-/**
- * An AST node location SVG interface.
- */
-export interface IASTNodeLocationSvg extends IASTNodeLocation {
-    /**
-     * Add the marker SVG to this node's SVG group.
-     *
-     * @param markerSvg The SVG root of the marker to be added to the SVG group.
-     */
-    setMarkerSvg(markerSvg: SVGElement | null): void;
-    /**
-     * Add the cursor SVG to this node's SVG group.
-     *
-     * @param cursorSvg The SVG root of the cursor to be added to the SVG group.
-     */
-    setCursorSvg(cursorSvg: SVGElement | null): void;
-}
-//# sourceMappingURL=i_ast_node_location_svg.d.ts.map

package/core/interfaces/i_ast_node_location_with_block.d.ts

@@ -1,19 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Block } from '../block.js';
-import type { IASTNodeLocation } from './i_ast_node_location.js';
-/**
- * An AST node location that has an associated block.
- */
-export interface IASTNodeLocationWithBlock extends IASTNodeLocation {
-    /**
-     * Get the source block associated with this node.
-     *
-     * @returns The source block.
-     */
-    getSourceBlock(): Block | null;
-}
-//# sourceMappingURL=i_ast_node_location_with_block.d.ts.map

package/core/keyboard_nav/ast_node.d.ts

@@ -1,297 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * The class representing an AST node.
- * Used to traverse the Blockly AST.
- *
- * @class
- */
-import { Block } from '../block.js';
-import type { Connection } from '../connection.js';
-import type { Field } from '../field.js';
-import { FlyoutButton } from '../flyout_button.js';
-import type { Input } from '../inputs/input.js';
-import type { IASTNodeLocation } from '../interfaces/i_ast_node_location.js';
-import { Coordinate } from '../utils/coordinate.js';
-import type { Workspace } from '../workspace.js';
-/**
- * Class for an AST node.
- * It is recommended that you use one of the createNode methods instead of
- * creating a node directly.
- */
-export declare class ASTNode {
-    /**
-     * True to navigate to all fields. False to only navigate to clickable fields.
-     */
-    static NAVIGATE_ALL_FIELDS: boolean;
-    /**
-     * The default y offset to use when moving the cursor from a stack to the
-     * workspace.
-     */
-    private static readonly DEFAULT_OFFSET_Y;
-    private readonly type;
-    private readonly isConnectionLocation;
-    private readonly location;
-    /** The coordinate on the workspace. */
-    private wsCoordinate;
-    /**
-     * @param type The type of the location.
-     *     Must be in ASTNode.types.
-     * @param location The position in the AST.
-     * @param opt_params Optional dictionary of options.
-     */
-    constructor(type: string, location: IASTNodeLocation, opt_params?: Params);
-    /**
-     * Parse the optional parameters.
-     *
-     * @param params The user specified parameters.
-     */
-    private processParams;
-    /**
-     * Gets the value pointed to by this node.
-     * It is the callers responsibility to check the node type to figure out what
-     * type of object they get back from this.
-     *
-     * @returns The current field, connection, workspace, or block the cursor is
-     *     on.
-     */
-    getLocation(): IASTNodeLocation;
-    /**
-     * The type of the current location.
-     * One of ASTNode.types
-     *
-     * @returns The type of the location.
-     */
-    getType(): string;
-    /**
-     * The coordinate on the workspace.
-     *
-     * @returns The workspace coordinate or null if the location is not a
-     *     workspace.
-     */
-    getWsCoordinate(): Coordinate | null;
-    /**
-     * Whether the node points to a connection.
-     *
-     * @returns [description]
-     * @internal
-     */
-    isConnection(): boolean;
-    /**
-     * Given an input find the next editable field or an input with a non null
-     * connection in the same block. The current location must be an input
-     * connection.
-     *
-     * @returns The AST node holding the next field or connection or null if there
-     *     is no editable field or input connection after the given input.
-     */
-    private findNextForInput;
-    /**
-     * Given a field find the next editable field or an input with a non null
-     * connection in the same block. The current location must be a field.
-     *
-     * @returns The AST node pointing to the next field or connection or null if
-     *     there is no editable field or input connection after the given input.
-     */
-    private findNextForField;
-    /**
-     * Given an input find the previous editable field or an input with a non null
-     * connection in the same block. The current location must be an input
-     * connection.
-     *
-     * @returns The AST node holding the previous field or connection.
-     */
-    private findPrevForInput;
-    /**
-     * Given a field find the previous editable field or an input with a non null
-     * connection in the same block. The current location must be a field.
-     *
-     * @returns The AST node holding the previous input or field.
-     */
-    private findPrevForField;
-    /**
-     * Navigate between stacks of blocks on the workspace.
-     *
-     * @param forward True to go forward. False to go backwards.
-     * @returns The first block of the next stack or null if there are no blocks
-     *     on the workspace.
-     */
-    private navigateBetweenStacks;
-    /**
-     * Navigate between buttons and stacks of blocks on the flyout workspace.
-     *
-     * @param forward True to go forward. False to go backwards.
-     * @returns The next button, or next stack's first block, or null
-     */
-    private navigateFlyoutContents;
-    /**
-     * Finds the next (or previous if navigating backward) item in the flyout that should be navigated to.
-     *
-     * @param flyoutContents Contents of the current flyout.
-     * @param currentLocation Current ASTNode location.
-     * @param forward True if we're navigating forward, else false.
-     * @returns The next (or previous) FlyoutItem, or null if there is none.
-     */
-    private findNextLocationInFlyout;
-    /**
-     * Finds the top most AST node for a given block.
-     * This is either the previous connection, output connection or block
-     * depending on what kind of connections the block has.
-     *
-     * @param block The block that we want to find the top connection on.
-     * @returns The AST node containing the top connection.
-     */
-    private findTopASTNodeForBlock;
-    /**
-     * Get the AST node pointing to the input that the block is nested under or if
-     * the block is not nested then get the stack AST node.
-     *
-     * @param block The source block of the current location.
-     * @returns The AST node pointing to the input connection or the top block of
-     *     the stack this block is in.
-     */
-    private getOutAstNodeForBlock;
-    /**
-     * Find the first editable field or input with a connection on a given block.
-     *
-     * @param block The source block of the current location.
-     * @returns An AST node pointing to the first field or input.
-     * Null if there are no editable fields or inputs with connections on the
-     * block.
-     */
-    private findFirstFieldOrInput;
-    /**
-     * Finds the source block of the location of this node.
-     *
-     * @returns The source block of the location, or null if the node is of type
-     *     workspace or button.
-     */
-    getSourceBlock(): Block | null;
-    /**
-     * Find the element to the right of the current element in the AST.
-     *
-     * @returns An AST node that wraps the next field, connection, block, or
-     *     workspace. Or null if there is no node to the right.
-     */
-    next(): ASTNode | null;
-    /**
-     * Find the element one level below and all the way to the left of the current
-     * location.
-     *
-     * @returns An AST node that wraps the next field, connection, workspace, or
-     *     block. Or null if there is nothing below this node.
-     */
-    in(): ASTNode | null;
-    /**
-     * Find the element to the left of the current element in the AST.
-     *
-     * @returns An AST node that wraps the previous field, connection, workspace
-     *     or block. Or null if no node exists to the left. null.
-     */
-    prev(): ASTNode | null;
-    /**
-     * Find the next element that is one position above and all the way to the
-     * left of the current location.
-     *
-     * @returns An AST node that wraps the next field, connection, workspace or
-     *     block. Or null if we are at the workspace level.
-     */
-    out(): ASTNode | null;
-    /**
-     * Whether an AST node of the given type points to a connection.
-     *
-     * @param type The type to check.  One of ASTNode.types.
-     * @returns True if a node of the given type points to a connection.
-     */
-    private static isConnectionType;
-    /**
-     * Create an AST node pointing to a field.
-     *
-     * @param field The location of the AST node.
-     * @returns An AST node pointing to a field.
-     */
-    static createFieldNode(field: Field): ASTNode;
-    /**
-     * Creates an AST node pointing to a connection. If the connection has a
-     * parent input then create an AST node of type input that will hold the
-     * connection.
-     *
-     * @param connection This is the connection the node will point to.
-     * @returns An AST node pointing to a connection.
-     */
-    static createConnectionNode(connection: Connection): ASTNode | null;
-    /**
-     * Creates an AST node pointing to an input. Stores the input connection as
-     * the location.
-     *
-     * @param input The input used to create an AST node.
-     * @returns An AST node pointing to a input.
-     */
-    static createInputNode(input: Input): ASTNode | null;
-    /**
-     * Creates an AST node pointing to a block.
-     *
-     * @param block The block used to create an AST node.
-     * @returns An AST node pointing to a block.
-     */
-    static createBlockNode(block: Block): ASTNode;
-    /**
-     * Create an AST node of type stack. A stack, represented by its top block, is
-     *     the set of all blocks connected to a top block, including the top
-     * block.
-     *
-     * @param topBlock A top block has no parent and can be found in the list
-     *     returned by workspace.getTopBlocks().
-     * @returns An AST node of type stack that points to the top block on the
-     *     stack.
-     */
-    static createStackNode(topBlock: Block): ASTNode;
-    /**
-     * Create an AST node of type button. A button in this case refers
-     * specifically to a button in a flyout.
-     *
-     * @param button A top block has no parent and can be found in the list
-     *     returned by workspace.getTopBlocks().
-     * @returns An AST node of type stack that points to the top block on the
-     *     stack.
-     */
-    static createButtonNode(button: FlyoutButton): ASTNode;
-    /**
-     * Creates an AST node pointing to a workspace.
-     *
-     * @param workspace The workspace that we are on.
-     * @param wsCoordinate The position on the workspace for this node.
-     * @returns An AST node pointing to a workspace and a position on the
-     *     workspace.
-     */
-    static createWorkspaceNode(workspace: Workspace, wsCoordinate: Coordinate): ASTNode;
-    /**
-     * Creates an AST node for the top position on a block.
-     * This is either an output connection, previous connection, or block.
-     *
-     * @param block The block to find the top most AST node on.
-     * @returns The AST node holding the top most position on the block.
-     */
-    static createTopNode(block: Block): ASTNode | null;
-}
-export declare namespace ASTNode {
-    interface Params {
-        wsCoordinate: Coordinate;
-    }
-    enum types {
-        FIELD = "field",
-        BLOCK = "block",
-        INPUT = "input",
-        OUTPUT = "output",
-        NEXT = "next",
-        PREVIOUS = "previous",
-        STACK = "stack",
-        WORKSPACE = "workspace",
-        BUTTON = "button"
-    }
-}
-export type Params = ASTNode.Params;
-//# sourceMappingURL=ast_node.d.ts.map

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

@@ -1,256 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import '../../events/events_marker_move.js';
-import type { IASTNodeLocationSvg } from '../../interfaces/i_ast_node_location_svg.js';
-import { ASTNode } from '../../keyboard_nav/ast_node.js';
-import type { Marker } from '../../keyboard_nav/marker.js';
-import type { RenderedConnection } from '../../rendered_connection.js';
-import type { WorkspaceSvg } from '../../workspace_svg.js';
-import type { ConstantProvider, Notch, PuzzleTab } from './constants.js';
-/**
- * Class for a marker, containing methods for graphically rendering a marker as
- * SVG.
- */
-export declare class MarkerSvg {
-    protected readonly workspace: WorkspaceSvg;
-    protected readonly marker: Marker;
-    /**
-     * The workspace, field, or block that the marker SVG element should be
-     * attached to.
-     */
-    protected parent: IASTNodeLocationSvg | null;
-    /** The current SVG element for the marker. */
-    currentMarkerSvg: SVGElement | null;
-    colour_: string;
-    /** The root SVG group containing the marker. */
-    protected markerSvg_: SVGGElement | null;
-    protected svgGroup_: SVGGElement | null;
-    protected markerBlock_: SVGPathElement | null;
-    protected markerInput_: SVGPathElement | null;
-    protected markerSvgLine_: SVGRectElement | null;
-    protected markerSvgRect_: SVGRectElement | null;
-    /** The constants necessary to draw the marker. */
-    protected constants_: ConstantProvider;
-    /**
-     * @param workspace The workspace the marker belongs to.
-     * @param constants The constants for the renderer.
-     * @param marker The marker to draw.
-     */
-    constructor(workspace: WorkspaceSvg, constants: ConstantProvider, marker: Marker);
-    /**
-     * Return the root node of the SVG or null if none exists.
-     *
-     * @returns The root SVG node.
-     */
-    getSvgRoot(): SVGElement | null;
-    /**
-     * Get the marker.
-     *
-     * @returns The marker to draw for.
-     */
-    getMarker(): Marker;
-    /**
-     * True if the marker should be drawn as a cursor, false otherwise.
-     * A cursor is drawn as a flashing line. A marker is drawn as a solid line.
-     *
-     * @returns True if the marker is a cursor, false otherwise.
-     */
-    isCursor(): boolean;
-    /**
-     * Create the DOM element for the marker.
-     *
-     * @returns The marker controls SVG group.
-     */
-    createDom(): SVGElement;
-    /**
-     * Attaches the SVG root of the marker to the SVG group of the parent.
-     *
-     * @param newParent The workspace, field, or block that the marker SVG element
-     *     should be attached to.
-     */
-    protected setParent_(newParent: IASTNodeLocationSvg): void;
-    /**
-     * Update the marker.
-     *
-     * @param oldNode The previous node the marker was on or null.
-     * @param curNode The node that we want to draw the marker for.
-     */
-    draw(oldNode: ASTNode | null, curNode: ASTNode | null): void;
-    /**
-     * Update the marker's visible state based on the type of curNode..
-     *
-     * @param curNode The node that we want to draw the marker for.
-     */
-    protected showAtLocation_(curNode: ASTNode): void;
-    /**************************
-     * Display
-     **************************/
-    /**
-     * Show the marker as a combination of the previous connection and block,
-     * the output connection and block, or just the block.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithBlockPrevOutput(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for a block.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithBlock_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for a previous connection.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithPrevious_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for an output connection.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithOutput_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for a workspace coordinate.
-     * This is a horizontal line.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithCoordinates_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for a field.
-     * This is a box around the field.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithField_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for an input.
-     * This is a puzzle piece.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithInput_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for a next connection.
-     * This is a horizontal line.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithNext_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for a stack.
-     * This is a box with extra padding around the entire stack of blocks.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithStack_(curNode: ASTNode): void;
-    /**
-     * Position and display the marker for a flyout button.
-     * This is a box with extra padding around the button.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    protected showWithButton_(curNode: ASTNode): void;
-    /** Show the current marker. */
-    protected showCurrent_(): void;
-    /**************************
-     * Position
-     **************************/
-    /**
-     * Position the marker for a block.
-     * Displays an outline of the top half of a rectangle around a block.
-     *
-     * @param width The width of the block.
-     * @param markerOffset The extra padding for around the block.
-     * @param markerHeight The height of the marker.
-     */
-    protected positionBlock_(width: number, markerOffset: number, markerHeight: number): void;
-    /**
-     * Position the marker for an input connection.
-     * Displays a filled in puzzle piece.
-     *
-     * @param connection The connection to position marker around.
-     */
-    protected positionInput_(connection: RenderedConnection): void;
-    /**
-     * Move and show the marker at the specified coordinate in workspace units.
-     * Displays a horizontal line.
-     *
-     * @param x The new x, in workspace units.
-     * @param y The new y, in workspace units.
-     * @param width The new width, in workspace units.
-     */
-    protected positionLine_(x: number, y: number, width: number): void;
-    /**
-     * Position the marker for an output connection.
-     * Displays a puzzle outline and the top and bottom path.
-     *
-     * @param width The width of the block.
-     * @param height The height of the block.
-     * @param connectionShape The shape object for the connection.
-     */
-    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
-     * connection.
-     *
-     * @param width The width of the block.
-     * @param markerOffset The offset of the marker from around the block.
-     * @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): void;
-    /**
-     * Move and show the marker at the specified coordinate in workspace units.
-     * Displays a filled in rectangle.
-     *
-     * @param x The new x, in workspace units.
-     * @param y The new y, in workspace units.
-     * @param width The new width, in workspace units.
-     * @param height The new height, in workspace units.
-     */
-    protected positionRect_(x: number, y: number, width: number, height: number): void;
-    /**
-     * Flip the SVG paths in RTL.
-     *
-     * @param markerSvg The marker that we want to flip.
-     */
-    private flipRtl;
-    /** Hide the marker. */
-    hide(): void;
-    /**
-     * Fire event for the marker or marker.
-     *
-     * @param oldNode The old node the marker used to be on.
-     * @param curNode The new node the marker is currently on.
-     */
-    protected fireMarkerEvent(oldNode: ASTNode | null, curNode: ASTNode): void;
-    /**
-     * Get the properties to make a marker blink.
-     *
-     * @returns The object holding attributes to make the marker blink.
-     */
-    protected getBlinkProperties_(): {
-        [key: string]: string;
-    };
-    /**
-     * Create the marker SVG.
-     *
-     * @returns The SVG node created.
-     */
-    protected createDomInternal_(): Element;
-    /**
-     * Apply the marker's colour.
-     *
-     * @param _curNode The node that we want to draw the marker for.
-     */
-    protected applyColour_(_curNode: ASTNode): void;
-    /** Dispose of this marker. */
-    dispose(): void;
-}
-//# sourceMappingURL=marker_svg.d.ts.map

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

@@ -1,49 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { ASTNode } from '../../keyboard_nav/ast_node.js';
-import type { Marker } from '../../keyboard_nav/marker.js';
-import type { WorkspaceSvg } from '../../workspace_svg.js';
-import type { ConstantProvider as BaseConstantProvider } from '../common/constants.js';
-import { MarkerSvg as BaseMarkerSvg } from '../common/marker_svg.js';
-import type { ConstantProvider as ZelosConstantProvider } from './constants.js';
-/**
- * Class to draw a marker.
- */
-export declare class MarkerSvg extends BaseMarkerSvg {
-    constants_: ZelosConstantProvider;
-    private markerCircle;
-    /**
-     * @param workspace The workspace the marker belongs to.
-     * @param constants The constants for the renderer.
-     * @param marker The marker to draw.
-     */
-    constructor(workspace: WorkspaceSvg, constants: BaseConstantProvider, marker: Marker);
-    /**
-     * Position and display the marker for an input or an output connection.
-     *
-     * @param curNode The node to draw the marker for.
-     */
-    private showWithInputOutput;
-    showWithOutput_(curNode: ASTNode): void;
-    showWithInput_(curNode: ASTNode): void;
-    /**
-     * Draw a rectangle around the block.
-     *
-     * @param curNode The current node of the marker.
-     */
-    showWithBlock_(curNode: ASTNode): void;
-    /**
-     * Position the circle we use for input and output connections.
-     *
-     * @param x The x position of the circle.
-     * @param y The y position of the circle.
-     */
-    private positionCircle;
-    hide(): void;
-    createDomInternal_(): SVGGElement;
-    applyColour_(curNode: ASTNode): void;
-}
-//# sourceMappingURL=marker_svg.d.ts.map