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

package/core/interfaces/i_ast_node_location.ts

@@ -1,23 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an AST node location.
- */
-
-/**
- * The interface for an AST node location.
- * @namespace Blockly.IASTNodeLocation
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IASTNodeLocation');
-
-
-/**
- * An AST node location interface.
- * @alias Blockly.IASTNodeLocation
- */
-export interface IASTNodeLocation {}

package/core/interfaces/i_ast_node_location_svg.ts

@@ -1,37 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an AST node location SVG.
- */
-
-/**
- * The interface for an AST node location SVG.
- * @namespace Blockly.IASTNodeLocationSvg
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IASTNodeLocationSvg');
-
-import type {IASTNodeLocation} from './i_ast_node_location.js';
-
-
-/**
- * An AST node location SVG interface.
- * @alias Blockly.IASTNodeLocationSvg
- */
-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;
-}

package/core/interfaces/i_ast_node_location_with_block.ts

@@ -1,38 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an AST node location that has an associated
- * block.
- */
-
-/**
- * The interface for an AST node location that has an associated
- * block.
- * @namespace Blockly.IASTNodeLocationWithBlock
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IASTNodeLocationWithBlock');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../block.js';
-
-import type {IASTNodeLocation} from './i_ast_node_location.js';
-import type {Block} from '../block.js';
-
-
-/**
- * An AST node location that has an associated block.
- * @alias Blockly.IASTNodeLocationWithBlock
- */
-export interface IASTNodeLocationWithBlock extends IASTNodeLocation {
-  /**
-   * Get the source block associated with this node.
-   * @return The source block.
-   */
-  getSourceBlock(): Block;
-}

package/core/interfaces/i_autohideable.ts

@@ -1,34 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a component that is automatically hidden
- * when WorkspaceSvg.hideChaff is called.
- */
-
-/**
- * The interface for a component that is automatically hidden
- * when WorkspaceSvg.hideChaff is called.
- * @namespace Blockly.IAutoHideable
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IAutoHideable');
-
-import type {IComponent} from './i_component.js';
-
-
-/**
- * Interface for a component that can be automatically hidden.
- * @alias Blockly.IAutoHideable
- */
-export interface IAutoHideable extends IComponent {
-  /**
-   * Hides the component. Called in WorkspaceSvg.hideChaff.
-   * @param onlyClosePopups Whether only popups should be closed.
-   *   Flyouts should not be closed if this is true.
-   */
-  autoHide(onlyClosePopups: boolean): void;
-}

package/core/interfaces/i_block_dragger.ts

@@ -1,67 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a block dragger.
- */
-
-/**
- * The interface for a block dragger.
- * @namespace Blockly.IBlockDragger
- */
-import * as goog from '../../closure/goog/goog.js';
-import type {Coordinate} from '../utils/coordinate.js';
-import type {BlockSvg} from '../block_svg.js';
-goog.declareModuleId('Blockly.IBlockDragger');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../block_svg.js';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/coordinate.js';
-
-
-/**
- * A block dragger interface.
- * @alias Blockly.IBlockDragger
- */
-export interface IBlockDragger {
-  /**
-   * Start dragging a block.  This includes moving it to the drag surface.
-   * @param currentDragDeltaXY How far the pointer has moved from the position
-   *     at mouse down, in pixel units.
-   * @param healStack Whether or not to heal the stack after disconnecting.
-   */
-  startDrag(currentDragDeltaXY: Coordinate, healStack: boolean): void;
-
-  /**
-   * Execute a step of block dragging, based on the given event.  Update the
-   * display accordingly.
-   * @param e The most recent move event.
-   * @param currentDragDeltaXY How far the pointer has moved from the position
-   *     at the start of the drag, in pixel units.
-   */
-  drag(e: Event, currentDragDeltaXY: Coordinate): void;
-
-  /**
-   * Finish a block drag and put the block back on the workspace.
-   * @param e The mouseup/touchend event.
-   * @param currentDragDeltaXY How far the pointer has moved from the position
-   *     at the start of the drag, in pixel units.
-   */
-  endDrag(e: Event, currentDragDeltaXY: Coordinate): void;
-
-  /**
-   * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
-   * or 2 insertion markers.
-   * @return A possibly empty list of insertion marker blocks.
-   */
-  getInsertionMarkers(): BlockSvg[];
-
-  /** Sever all links from this object and do any necessary cleanup. */
-  dispose(): void;
-}

package/core/interfaces/i_bounded_element.ts

@@ -1,42 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a bounded element.
- */
-
-/**
- * The interface for a bounded element.
- * @namespace Blockly.IBoundedElement
- */
-import * as goog from '../../closure/goog/goog.js';
-import type {Rect} from '../utils/rect.js';
-goog.declareModuleId('Blockly.IBoundedElement');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/rect.js';
-
-
-/**
- * A bounded element interface.
- * @alias Blockly.IBoundedElement
- */
-export interface IBoundedElement {
-  /**
-   * Returns the coordinates of a bounded element describing the dimensions of
-   * the element. Coordinate system: workspace coordinates.
-   * @return Object with coordinates of the bounded element.
-   */
-  getBoundingRectangle(): Rect;
-
-  /**
-   * Move the element by a relative offset.
-   * @param dx Horizontal offset in workspace units.
-   * @param dy Vertical offset in workspace units.
-   */
-  moveBy(dx: number, dy: number): void;
-}

package/core/interfaces/i_bubble.ts

@@ -1,88 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a bubble.
- */
-
-/**
- * The interface for a bubble.
- * @namespace Blockly.IBubble
- */
-import * as goog from '../../closure/goog/goog.js';
-import type {Coordinate} from '../utils/coordinate.js';
-import type {BlockDragSurfaceSvg} from '../block_drag_surface.js';
-goog.declareModuleId('Blockly.IBubble');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../block_drag_surface.js';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/coordinate.js';
-
-import type {IContextMenu} from './i_contextmenu.js';
-import type {IDraggable} from './i_draggable.js';
-
-
-/**
- * A bubble interface.
- * @alias Blockly.IBubble
- */
-export interface IBubble extends IDraggable, IContextMenu {
-  /**
-   * Return the coordinates of the top-left corner of this bubble's body
-   * relative to the drawing surface's origin (0,0), in workspace units.
-   * @return Object with .x and .y properties.
-   */
-  getRelativeToSurfaceXY(): Coordinate;
-
-  /**
-   * Return the root node of the bubble's SVG group.
-   * @return The root SVG node of the bubble's group.
-   */
-  getSvgRoot(): SVGElement;
-
-  /**
-   * Set whether auto-layout of this bubble is enabled.  The first time a bubble
-   * is shown it positions itself to not cover any blocks.  Once a user has
-   * dragged it to reposition, it renders where the user put it.
-   * @param enable True if auto-layout should be enabled, false otherwise.
-   */
-  setAutoLayout(enable: boolean): void;
-
-  /**
-   * Sets whether or not this bubble is being dragged.
-   * @param adding True if dragging, false otherwise.
-   */
-  setDragging(dragging: boolean): void;
-
-  /**
-   * Move this bubble during a drag, taking into account whether or not there is
-   * a drag surface.
-   * @param dragSurface The surface that carries rendered items during a drag,
-   *     or null if no drag surface is in use.
-   * @param newLoc The location to translate to, in workspace coordinates.
-   */
-  moveDuringDrag(dragSurface: BlockDragSurfaceSvg|null, newLoc: Coordinate):
-      void;
-
-  /**
-   * Move the bubble to the specified location in workspace coordinates.
-   * @param x The x position to move to.
-   * @param y The y position to move to.
-   */
-  moveTo(x: number, y: number): void;
-
-  /**
-   * Update the style of this bubble when it is dragged over a delete area.
-   * @param enable True if the bubble is about to be deleted, false otherwise.
-   */
-  setDeleteStyle(enable: boolean): void;
-
-  /** Dispose of this bubble. */
-  dispose(): void;
-}

package/core/interfaces/i_collapsible_toolbox_item.ts

@@ -1,47 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a collapsible toolbox item.
- */
-
-/**
- * The interface for a collapsible toolbox item.
- * @namespace Blockly.ICollapsibleToolboxItem
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.ICollapsibleToolboxItem');
-
-/* eslint-disable-next-line no-unused-vars */
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './i_toolbox_item.js';
-
-import type {ISelectableToolboxItem} from './i_selectable_toolbox_item.js';
-import type {IToolboxItem} from './i_toolbox_item.js';
-
-
-/**
- * Interface for an item in the toolbox that can be collapsed.
- * @alias Blockly.ICollapsibleToolboxItem
- */
-export interface ICollapsibleToolboxItem extends ISelectableToolboxItem {
-  /**
-   * Gets any children toolbox items. (ex. Gets the subcategories)
-   * @return The child toolbox items.
-   */
-  getChildToolboxItems(): IToolboxItem[];
-
-  /**
-   * Whether the toolbox item is expanded to show its child subcategories.
-   * @return True if the toolbox item shows its children, false if it is
-   *     collapsed.
-   */
-  isExpanded(): boolean;
-
-  /** Toggles whether or not the toolbox item is expanded. */
-  toggleExpanded(): void;
-}

package/core/interfaces/i_component.ts

@@ -1,32 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Interface for a workspace component that can be registered with
- * the ComponentManager.
- */
-
-/**
- * Interface for a workspace component that can be registered with
- * the ComponentManager.
- * @namespace Blockly.IComponent
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IComponent');
-
-
-/**
- * The interface for a workspace component that can be registered with the
- * ComponentManager.
- * @alias Blockly.IComponent
- */
-export interface IComponent {
-  /**
-   * The unique id for this component that is used to register with the
-   * ComponentManager.
-   */
-  id: string;
-}

package/core/interfaces/i_connection_checker.ts

@@ -1,102 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that encapsulates logic for
- * checking whether a potential connection is safe and valid.
- */
-
-/**
- * The interface for an object that encapsulates logic for
- * checking whether a potential connection is safe and valid.
- * @namespace Blockly.IConnectionChecker
- */
-import * as goog from '../../closure/goog/goog.js';
-import type {Connection} from '../connection.js';
-import type {RenderedConnection} from '../rendered_connection.js';
-goog.declareModuleId('Blockly.IConnectionChecker');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../connection.js';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../rendered_connection.js';
-
-
-/**
- * Class for connection type checking logic.
- * @alias Blockly.IConnectionChecker
- */
-export interface IConnectionChecker {
-  /**
-   * Check whether the current connection can connect with the target
-   * connection.
-   * @param a Connection to check compatibility with.
-   * @param b Connection to check compatibility with.
-   * @param isDragging True if the connection is being made by dragging a block.
-   * @param opt_distance The max allowable distance between the connections for
-   *     drag checks.
-   * @return Whether the connection is legal.
-   */
-  canConnect(
-      a: Connection|null, b: Connection|null, isDragging: boolean,
-      opt_distance?: number): boolean;
-
-  /**
-   * Checks whether the current connection can connect with the target
-   * connection, and return an error code if there are problems.
-   * @param a Connection to check compatibility with.
-   * @param b Connection to check compatibility with.
-   * @param isDragging True if the connection is being made by dragging a block.
-   * @param opt_distance The max allowable distance between the connections for
-   *     drag checks.
-   * @return Connection.CAN_CONNECT if the connection is legal, an error code
-   *     otherwise.
-   */
-  canConnectWithReason(
-      a: Connection|null, b: Connection|null, isDragging: boolean,
-      opt_distance?: number): number;
-
-  /**
-   * Helper method that translates a connection error code into a string.
-   * @param errorCode The error code.
-   * @param a One of the two connections being checked.
-   * @param b The second of the two connections being checked.
-   * @return A developer-readable error string.
-   */
-  getErrorMessage(errorCode: number, a: Connection|null, b: Connection|null):
-      string;
-
-  /**
-   * Check that connecting the given connections is safe, meaning that it would
-   * not break any of Blockly's basic assumptions (e.g. no self connections).
-   * @param a The first of the connections to check.
-   * @param b The second of the connections to check.
-   * @return An enum with the reason this connection is safe or unsafe.
-   */
-  doSafetyChecks(a: Connection|null, b: Connection|null): number;
-
-  /**
-   * Check whether this connection is compatible with another connection with
-   * respect to the value type system.  E.g. square_root("Hello") is not
-   * compatible.
-   * @param a Connection to compare.
-   * @param b Connection to compare against.
-   * @return True if the connections share a type.
-   */
-  doTypeChecks(a: Connection, b: Connection): boolean;
-
-  /**
-   * Check whether this connection can be made by dragging.
-   * @param a Connection to compare.
-   * @param b Connection to compare against.
-   * @param distance The maximum allowable distance between connections.
-   * @return True if the connection is allowed during a drag.
-   */
-  doDragChecks(a: RenderedConnection, b: RenderedConnection, distance: number):
-      boolean;
-}

package/core/interfaces/i_contextmenu.ts

@@ -1,26 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that supports a right-click.
- */
-
-/**
- * The interface for an object that supports a right-click.
- * @namespace Blockly.IContextMenu
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IContextMenu');
-
-
-/** @alias Blockly.IContextMenu */
-export interface IContextMenu {
-  /**
-   * Show the context menu for this object.
-   * @param e Mouse event.
-   */
-  showContextMenu(e: Event): void;
-}

package/core/interfaces/i_copyable.ts

@@ -1,40 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that is copyable.
- */
-
-/**
- * The interface for an object that is copyable.
- * @namespace Blockly.ICopyable
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.ICopyable');
-
-import type {WorkspaceSvg} from '../workspace_svg.js';
-import type {ISelectable} from './i_selectable.js';
-
-
-/** @alias Blockly.ICopyable */
-export interface ICopyable extends ISelectable {
-  /**
-   * Encode for copying.
-   * @return Copy metadata.
-   * @internal
-   */
-  toCopyData(): CopyData|null;
-}
-
-export namespace ICopyable {
-  export interface CopyData {
-    saveInfo: Object|Element;
-    source: WorkspaceSvg;
-    typeCounts: Object|null;
-  }
-}
-
-export type CopyData = ICopyable.CopyData;

package/core/interfaces/i_deletable.ts

@@ -1,29 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that is deletable.
- */
-
-/**
- * The interface for an object that is deletable.
- * @namespace Blockly.IDeletable
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IDeletable');
-
-
-/**
- * The interface for an object that can be deleted.
- * @alias Blockly.IDeletable
- */
-export interface IDeletable {
-  /**
-   * Get whether this object is deletable or not.
-   * @return True if deletable.
-   */
-  isDeletable(): boolean;
-}

package/core/interfaces/i_delete_area.ts

@@ -1,46 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a component that can delete a block or bubble
- * that is dropped on top of it.
- */
-
-/**
- * The interface for a component that can delete a block or bubble
- * that is dropped on top of it.
- * @namespace Blockly.IDeleteArea
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IDeleteArea');
-
-/* eslint-disable-next-line no-unused-vars */
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './i_draggable.js';
-
-import type {IDragTarget} from './i_drag_target.js';
-import type {IDraggable} from './i_draggable.js';
-
-
-/**
- * Interface for a component that can delete a block or bubble that is dropped
- * on top of it.
- * @alias Blockly.IDeleteArea
- */
-export interface IDeleteArea extends IDragTarget {
-  /**
-   * Returns whether the provided block or bubble would be deleted if dropped on
-   * this area.
-   * This method should check if the element is deletable and is always called
-   * before onDragEnter/onDragOver/onDragExit.
-   * @param element The block or bubble currently being dragged.
-   * @param couldConnect Whether the element could could connect to another.
-   * @return Whether the element provided would be deleted if dropped on this
-   *     area.
-   */
-  wouldDelete(element: IDraggable, couldConnect: boolean): boolean;
-}