blockly 8.0.5 → 9.0.0-beta.0

package/core/interfaces/i_ast_node_location.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * An AST node location interface.
+ * @alias Blockly.IASTNodeLocation
+ */
+export interface IASTNodeLocation {
+}

package/core/interfaces/{i_ast_node_location.js → i_ast_node_location.ts}

@@ -8,19 +8,16 @@
  * @fileoverview The interface for an AST node location.
  */
 
-'use strict';
-
 /**
  * The interface for an AST node location.
  * @namespace Blockly.IASTNodeLocation
  */
-goog.module('Blockly.IASTNodeLocation');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.IASTNodeLocation');
+
 
 /**
  * An AST node location interface.
- * @interface
  * @alias Blockly.IASTNodeLocation
  */
-const IASTNodeLocation = function() {};
-
-exports.IASTNodeLocation = IASTNodeLocation;
+export interface IASTNodeLocation {}

package/core/interfaces/i_ast_node_location_svg.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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.
+ * @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_svg.ts

@@ -0,0 +1,37 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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_ast_node_location_with_block.ts

@@ -0,0 +1,38 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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_autohideable.ts

@@ -0,0 +1,34 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Coordinate } from '../utils/coordinate.js';
+import type { BlockSvg } from '../block_svg.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_block_dragger.ts

@@ -0,0 +1,67 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Rect } from '../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_bounded_element.ts

@@ -0,0 +1,42 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Coordinate } from '../utils/coordinate.js';
+import type { BlockDragSurfaceSvg } from '../block_drag_surface.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_bubble.ts

@@ -0,0 +1,88 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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_collapsible_toolbox_item.ts

@@ -0,0 +1,47 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * 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_component.js → i_component.ts}

@@ -9,29 +9,24 @@
  * the ComponentManager.
  */
 
-'use strict';
-
 /**
  * Interface for a workspace component that can be registered with
  * the ComponentManager.
  * @namespace Blockly.IComponent
  */
-goog.module('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.
- * @interface
  * @alias Blockly.IComponent
  */
-const IComponent = function() {};
-
-/**
- * The unique id for this component that is used to register with the
- * ComponentManager.
- * @type {string}
- */
-IComponent.id;
-
-exports.IComponent = IComponent;
+export interface IComponent {
+  /**
+   * The unique id for this component that is used to register with the
+   * ComponentManager.
+   */
+  id: string;
+}