blockly 9.0.0-beta.0 → 9.0.0-beta.1

package/core/interfaces/i_drag_target.ts

@@ -1,84 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a component that has a handler for when a
- * block is dropped on top of it.
- */
-
-/**
- * The interface for a component that has a handler for when a
- * block is dropped on top of it.
- * @namespace Blockly.IDragTarget
- */
-import * as goog from '../../closure/goog/goog.js';
-import {Rect} from '../utils/rect.js';
-
-import {IDraggable} from './i_draggable.js';
-
-goog.declareModuleId('Blockly.IDragTarget');
-
-/* 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';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/rect.js';
-
-import type {IComponent} from './i_component.js';
-
-
-/**
- * Interface for a component with custom behaviour when a block or bubble is
- * dragged over or dropped on top of it.
- * @alias Blockly.IDragTarget
- */
-export interface IDragTarget extends IComponent {
-  /**
-   * Returns the bounding rectangle of the drag target area in pixel units
-   * relative to viewport.
-   * @return The component's bounding box. Null if drag target area should be
-   *     ignored.
-   */
-  getClientRect(): Rect|null;
-
-  /**
-   * Handles when a cursor with a block or bubble enters this drag target.
-   * @param dragElement The block or bubble currently being dragged.
-   */
-  onDragEnter(dragElement: IDraggable): void;
-
-  /**
-   * Handles when a cursor with a block or bubble is dragged over this drag
-   * target.
-   * @param dragElement The block or bubble currently being dragged.
-   */
-  onDragOver(dragElement: IDraggable): void;
-
-  /**
-   * Handles when a cursor with a block or bubble exits this drag target.
-   * @param dragElement The block or bubble currently being dragged.
-   */
-  onDragExit(dragElement: IDraggable): void;
-
-  /**
-   * Handles when a block or bubble is dropped on this component.
-   * Should not handle delete here.
-   * @param dragElement The block or bubble currently being dragged.
-   */
-  onDrop(dragElement: IDraggable): void;
-
-  /**
-   * Returns whether the provided block or bubble should not be moved after
-   * being dropped on this component. If true, the element will return to where
-   * it was when the drag started.
-   * @param dragElement The block or bubble currently being dragged.
-   * @return Whether the block or bubble provided should be returned to drag
-   *     start.
-   */
-  shouldPreventMove(dragElement: IDraggable): boolean;
-}

package/core/interfaces/i_draggable.ts

@@ -1,25 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that is draggable.
- */
-
-/**
- * The interface for an object that is draggable.
- * @namespace Blockly.IDraggable
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IDraggable');
-
-import type {IDeletable} from './i_deletable.js';
-
-
-/**
- * The interface for an object that can be dragged.
- * @alias Blockly.IDraggable
- */
-export interface IDraggable extends IDeletable {}

package/core/interfaces/i_flyout.ts

@@ -1,186 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a flyout.
- */
-
-/**
- * The interface for a flyout.
- * @namespace Blockly.IFlyout
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IFlyout');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/toolbox.js';
-/* 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';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/svg.js';
-
-import type {WorkspaceSvg} from '../workspace_svg.js';
-import type {BlockSvg} from '../block_svg.js';
-import type {Coordinate} from '../utils/coordinate.js';
-import type {FlyoutDefinition} from '../utils/toolbox.js';
-import type {Svg} from '../utils/svg.js';
-import type {IRegistrable} from './i_registrable.js';
-
-
-/**
- * Interface for a flyout.
- * @alias Blockly.IFlyout
- */
-export interface IFlyout extends IRegistrable {
-  /** Whether the flyout is laid out horizontally or not. */
-  horizontalLayout: boolean;
-
-  /** Is RTL vs LTR. */
-  RTL: boolean;
-
-  /** The target workspace */
-  targetWorkspace: WorkspaceSvg|null;
-
-  /** Margin around the edges of the blocks in the flyout. */
-  readonly MARGIN: number;
-
-  /** Does the flyout automatically close when a block is created? */
-  autoClose: boolean;
-
-  /** Corner radius of the flyout background. */
-  readonly CORNER_RADIUS: number;
-
-  /**
-   * Creates the flyout's DOM.  Only needs to be called once.  The flyout can
-   * either exist as its own svg element or be a g element nested inside a
-   * separate svg element.
-   * @param tagName The type of tag to put the flyout in. This should be <svg>
-   *     or <g>.
-   * @return The flyout's SVG group.
-   */
-  createDom(tagName: string|Svg<SVGSVGElement>|Svg<SVGGElement>): SVGElement;
-
-  /**
-   * Initializes the flyout.
-   * @param targetWorkspace The workspace in which to create new blocks.
-   */
-  init(targetWorkspace: WorkspaceSvg): void;
-
-  /**
-   * Dispose of this flyout.
-   * Unlink from all DOM elements to prevent memory leaks.
-   */
-  dispose(): void;
-
-  /**
-   * Get the width of the flyout.
-   * @return The width of the flyout.
-   */
-  getWidth(): number;
-
-  /**
-   * Get the height of the flyout.
-   * @return The height of the flyout.
-   */
-  getHeight(): number;
-
-  /**
-   * Get the workspace inside the flyout.
-   * @return The workspace inside the flyout.
-   */
-  getWorkspace(): WorkspaceSvg;
-
-  /**
-   * Is the flyout visible?
-   * @return True if visible.
-   */
-  isVisible(): boolean;
-
-  /**
-   * Set whether the flyout is visible. A value of true does not necessarily
-   * mean that the flyout is shown. It could be hidden because its container is
-   * hidden.
-   * @param visible True if visible.
-   */
-  setVisible(visible: boolean): void;
-
-  /**
-   * Set whether this flyout's container is visible.
-   * @param visible Whether the container is visible.
-   */
-  setContainerVisible(visible: boolean): void;
-
-  /** Hide and empty the flyout. */
-  hide(): void;
-
-  /**
-   * Show and populate the flyout.
-   * @param flyoutDef Contents to display in the flyout. This is either an array
-   *     of Nodes, a NodeList, a toolbox definition, or a string with the name
-   *     of the dynamic category.
-   */
-  show(flyoutDef: FlyoutDefinition|string): void;
-
-  /**
-   * Create a copy of this block on the workspace.
-   * @param originalBlock The block to copy from the flyout.
-   * @return The newly created block.
-   * @throws {Error} if something went wrong with deserialization.
-   */
-  createBlock(originalBlock: BlockSvg): BlockSvg;
-
-  /** Reflow blocks and their mats. */
-  reflow(): void;
-
-  /**
-   * @return True if this flyout may be scrolled with a scrollbar or by
-   *     dragging.
-   */
-  isScrollable(): boolean;
-
-  /**
-   * Calculates the x coordinate for the flyout position.
-   * @return X coordinate.
-   */
-  getX(): number;
-
-  /**
-   * Calculates the y coordinate for the flyout position.
-   * @return Y coordinate.
-   */
-  getY(): number;
-
-  /** Position the flyout. */
-  position(): void;
-
-  /**
-   * Determine if a drag delta is toward the workspace, based on the position
-   * and orientation of the flyout. This is used in determineDragIntention_ to
-   * determine if a new block should be created or if the flyout should scroll.
-   * @param currentDragDeltaXY How far the pointer has moved from the position
-   *     at mouse down, in pixel units.
-   * @return True if the drag is toward the workspace.
-   */
-  isDragTowardWorkspace(currentDragDeltaXY: Coordinate): boolean;
-
-  /**
-   * Does this flyout allow you to create a new instance of the given block?
-   * Used for deciding if a block can be "dragged out of" the flyout.
-   * @param block The block to copy from the flyout.
-   * @return True if you can create a new instance of the block, false
-   *     otherwise.
-   */
-  isBlockCreatable(block: BlockSvg): boolean;
-
-  /** Scroll the flyout to the beginning of its contents. */
-  scrollToStart(): void;
-}

package/core/interfaces/i_keyboard_accessible.ts

@@ -1,35 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for objects that handle keyboard shortcuts.
- */
-
-/**
- * The interface for objects that handle keyboard shortcuts.
- * @namespace Blockly.IKeyboardAccessible
- */
-import * as goog from '../../closure/goog/goog.js';
-import {KeyboardShortcut} from '../shortcut_registry.js';
-goog.declareModuleId('Blockly.IKeyboardAccessible');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../shortcut_registry.js';
-
-
-/**
- * An interface for an object that handles keyboard shortcuts.
- * @alias Blockly.IKeyboardAccessible
- */
-export interface IKeyboardAccessible {
-  /**
-   * Handles the given keyboard shortcut.
-   * @param shortcut The shortcut to be handled.
-   * @return True if the shortcut has been handled, false otherwise.
-   */
-  onShortcut(shortcut: KeyboardShortcut): boolean;
-}

package/core/interfaces/i_metrics_manager.ts

@@ -1,151 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a metrics manager.
- */
-
-/**
- * The interface for a metrics manager.
- * @namespace Blockly.IMetricsManager
- */
-import * as goog from '../../closure/goog/goog.js';
-import type {ContainerRegion, ToolboxMetrics, AbsoluteMetrics, UiMetrics} from '../metrics_manager.js';
-import type {Size} from '../utils/size.js';
-import type {Metrics} from '../utils/metrics.js';
-goog.declareModuleId('Blockly.IMetricsManager');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../metrics_manager.js';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/metrics.js';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/size.js';
-
-
-/**
- * Interface for a metrics manager.
- * @alias Blockly.IMetricsManager
- */
-export interface IMetricsManager {
-  /**
-   * Returns whether the scroll area has fixed edges.
-   * @return Whether the scroll area has fixed edges.
-   * @internal
-   */
-  hasFixedEdges(): boolean;
-
-  /**
-   * Returns the metrics for the scroll area of the workspace.
-   * @param opt_getWorkspaceCoordinates True to get the scroll metrics in
-   *     workspace coordinates, false to get them in pixel coordinates.
-   * @param opt_viewMetrics The view metrics if they have been previously
-   *     computed. Passing in null may cause the view metrics to be computed
-   *     again, if it is needed.
-   * @param opt_contentMetrics The content metrics if they have been previously
-   *     computed. Passing in null may cause the content metrics to be computed
-   *     again, if it is needed.
-   * @return The metrics for the scroll container
-   */
-  getScrollMetrics(
-      opt_getWorkspaceCoordinates?: boolean, opt_viewMetrics?: ContainerRegion,
-      opt_contentMetrics?: ContainerRegion): ContainerRegion;
-
-  /**
-   * Gets the width and the height of the flyout on the workspace in pixel
-   * coordinates. Returns 0 for the width and height if the workspace has a
-   * category toolbox instead of a simple toolbox.
-   * @param opt_own Whether to only return the workspace's own flyout.
-   * @return The width and height of the flyout.
-   */
-  getFlyoutMetrics(opt_own?: boolean): ToolboxMetrics;
-
-  /**
-   * Gets the width, height and position of the toolbox on the workspace in
-   * pixel coordinates. Returns 0 for the width and height if the workspace has
-   * a simple toolbox instead of a category toolbox. To get the width and height
-   * of a
-   * simple toolbox @see {@link getFlyoutMetrics}.
-   * @return The object with the width, height and position of the toolbox.
-   */
-  getToolboxMetrics(): ToolboxMetrics;
-
-  /**
-   * Gets the width and height of the workspace's parent SVG element in pixel
-   * coordinates. This area includes the toolbox and the visible workspace area.
-   * @return The width and height of the workspace's parent SVG element.
-   */
-  getSvgMetrics(): Size;
-
-  /**
-   * Gets the absolute left and absolute top in pixel coordinates.
-   * This is where the visible workspace starts in relation to the SVG
-   * container.
-   * @return The absolute metrics for the workspace.
-   */
-  getAbsoluteMetrics(): AbsoluteMetrics;
-
-  /**
-   * Gets the metrics for the visible workspace in either pixel or workspace
-   * coordinates. The visible workspace does not include the toolbox or flyout.
-   * @param opt_getWorkspaceCoordinates True to get the view metrics in
-   *     workspace coordinates, false to get them in pixel coordinates.
-   * @return The width, height, top and left of the viewport in either workspace
-   *     coordinates or pixel coordinates.
-   */
-  getViewMetrics(opt_getWorkspaceCoordinates?: boolean): ContainerRegion;
-
-  /**
-   * Gets content metrics in either pixel or workspace coordinates.
-   * The content area is a rectangle around all the top bounded elements on the
-   * workspace (workspace comments and blocks).
-   * @param opt_getWorkspaceCoordinates True to get the content metrics in
-   *     workspace coordinates, false to get them in pixel coordinates.
-   * @return The metrics for the content container.
-   */
-  getContentMetrics(opt_getWorkspaceCoordinates?: boolean): ContainerRegion;
-
-  /**
-   * Returns an object with all the metrics required to size scrollbars for a
-   * top level workspace.  The following properties are computed:
-   * Coordinate system: pixel coordinates, -left, -up, +right, +down
-   * .viewHeight: Height of the visible portion of the workspace.
-   * .viewWidth: Width of the visible portion of the workspace.
-   * .contentHeight: Height of the content.
-   * .contentWidth: Width of the content.
-   * .svgHeight: Height of the Blockly div (the view + the toolbox,
-   *    simple or otherwise),
-   * .svgWidth: Width of the Blockly div (the view + the toolbox,
-   *    simple or otherwise),
-   * .viewTop: Top-edge of the visible portion of the workspace, relative to
-   *     the workspace origin.
-   * .viewLeft: Left-edge of the visible portion of the workspace, relative to
-   *     the workspace origin.
-   * .contentTop: Top-edge of the content, relative to the workspace origin.
-   * .contentLeft: Left-edge of the content relative to the workspace origin.
-   * .absoluteTop: Top-edge of the visible portion of the workspace, relative
-   *     to the blocklyDiv.
-   * .absoluteLeft: Left-edge of the visible portion of the workspace, relative
-   *     to the blocklyDiv.
-   * .toolboxWidth: Width of the toolbox, if it exists.  Otherwise zero.
-   * .toolboxHeight: Height of the toolbox, if it exists.  Otherwise zero.
-   * .flyoutWidth: Width of the flyout if it is always open.  Otherwise zero.
-   * .flyoutHeight: Height of the flyout if it is always open.  Otherwise zero.
-   * .toolboxPosition: Top, bottom, left or right. Use TOOLBOX_AT constants to
-   *     compare.
-   * @return Contains size and position metrics of a top level workspace.
-   */
-  getMetrics(): Metrics;
-
-  /**
-   * Returns common metrics used by UI elements.
-   * @return The UI metrics.
-   */
-  getUiMetrics(): UiMetrics;
-}

package/core/interfaces/i_movable.ts

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

package/core/interfaces/i_positionable.ts

@@ -1,50 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a positionable UI element.
- */
-
-/**
- * The interface for a positionable UI element.
- * @namespace Blockly.IPositionable
- */
-import * as goog from '../../closure/goog/goog.js';
-import type {Rect} from '../utils/rect.js';
-import type {UiMetrics} from '../metrics_manager.js';
-goog.declareModuleId('Blockly.IPositionable');
-
-/* eslint-disable-next-line no-unused-vars */
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../metrics_manager.js';
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../utils/rect.js';
-
-import type {IComponent} from './i_component.js';
-
-
-/**
- * Interface for a component that is positioned on top of the workspace.
- * @alias Blockly.IPositionable
- */
-export interface IPositionable extends IComponent {
-  /**
-   * Positions the element. Called when the window is resized.
-   * @param metrics The workspace metrics.
-   * @param savedPositions List of rectangles that are already on the workspace.
-   */
-  position(metrics: UiMetrics, savedPositions: Rect[]): void;
-
-  /**
-   * Returns the bounding rectangle of the UI element in pixel units relative to
-   * the Blockly injection div.
-   * @return The UI elements's bounding box. Null if bounding box should be
-   *     ignored by other UI elements.
-   */
-  getBoundingRectangle(): Rect|null;
-}

package/core/interfaces/i_registrable.ts

@@ -1,25 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a Blockly component that can be registered.
- *    (Ex. Toolbox, Fields, Renderers)
- */
-
-/**
- * The interface for a Blockly component that can be registered.
- *    (Ex. Toolbox, Fields, Renderers)
- * @namespace Blockly.IRegistrable
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IRegistrable');
-
-
-/**
- * The interface for a Blockly component that can be registered.
- * @alias Blockly.IRegistrable
- */
-export interface IRegistrable {}

package/core/interfaces/i_registrable_field.ts

@@ -1,31 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a Blockly field that can be registered.
- */
-
-/**
- * The interface for a Blockly field that can be registered.
- * @namespace Blockly.IRegistrableField
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.IRegistrableField');
-
-import type {Field} from '../field.js';
-
-
-type fromJson = (p1: object) => Field;
-
-/**
- * A registrable field.
- * Note: We are not using an interface here as we are interested in defining the
- * static methods of a field rather than the instance methods.
- * @alias Blockly.IRegistrableField
- */
-export interface IRegistrableField {
-  fromJson: fromJson;
-}

package/core/interfaces/i_selectable.ts

@@ -1,34 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that is selectable.
- */
-
-/**
- * The interface for an object that is selectable.
- * @namespace Blockly.ISelectable
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.ISelectable');
-
-import type {IDeletable} from './i_deletable.js';
-import type {IMovable} from './i_movable.js';
-
-
-/**
- * The interface for an object that is selectable.
- * @alias Blockly.ISelectable
- */
-export interface ISelectable extends IDeletable, IMovable {
-  id: string;
-
-  /** Select this.  Highlight it visually. */
-  select(): void;
-
-  /** Unselect this.  Unhighlight it visually. */
-  unselect(): void;
-}