blockly 8.0.5 → 9.0.0-beta.0

package/core/{metrics_manager.js → metrics_manager.ts}

@@ -7,58 +7,45 @@
 /**
  * @fileoverview Calculates and reports workspace metrics.
  */
-'use strict';
 
 /**
  * Calculates and reports workspace metrics.
  * @class
  */
-goog.module('Blockly.MetricsManager');
-
-const registry = goog.require('Blockly.registry');
-const toolboxUtils = goog.require('Blockly.utils.toolbox');
-/* eslint-disable-next-line no-unused-vars */
-const {IFlyout} = goog.requireType('Blockly.IFlyout');
-/* eslint-disable-next-line no-unused-vars */
-const {IMetricsManager} = goog.require('Blockly.IMetricsManager');
-/* eslint-disable-next-line no-unused-vars */
-const {IToolbox} = goog.requireType('Blockly.IToolbox');
-/* eslint-disable-next-line no-unused-vars */
-const {Metrics} = goog.requireType('Blockly.utils.Metrics');
-const {Size} = goog.require('Blockly.utils.Size');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
+import * as goog from '../closure/goog/goog.js';
+goog.declareModuleId('Blockly.MetricsManager');
+
+import type {IFlyout} from './interfaces/i_flyout.js';
+import type {IMetricsManager} from './interfaces/i_metrics_manager.js';
+import type {IToolbox} from './interfaces/i_toolbox.js';
+import * as registry from './registry.js';
+import type {Metrics} from './utils/metrics.js';
+import {Size} from './utils/size.js';
+import * as toolboxUtils from './utils/toolbox.js';
+import type {WorkspaceSvg} from './workspace_svg.js';
 
 
 /**
  * The manager for all workspace metrics calculations.
- * @implements {IMetricsManager}
  * @alias Blockly.MetricsManager
  */
-class MetricsManager {
-  /**
-   * @param {!WorkspaceSvg} workspace The workspace to calculate metrics
-   *     for.
-   */
-  constructor(workspace) {
-    /**
-     * The workspace to calculate metrics for.
-     * @type {!WorkspaceSvg}
-     * @protected
-     */
+export class MetricsManager implements IMetricsManager {
+  /** The workspace to calculate metrics for. */
+  protected readonly workspace_: WorkspaceSvg;
+
+  /** @param workspace The workspace to calculate metrics for. */
+  constructor(workspace: WorkspaceSvg) {
     this.workspace_ = workspace;
   }
 
   /**
    * Gets the dimensions of the given workspace component, in pixel coordinates.
-   * @param {?IToolbox|?IFlyout} elem The element to get the
-   *     dimensions of, or null.  It should be a toolbox or flyout, and should
-   *     implement getWidth() and getHeight().
-   * @return {!Size} An object containing width and height
-   *     attributes, which will both be zero if elem did not exist.
-   * @protected
+   * @param elem The element to get the dimensions of, or null.  It should be a
+   *     toolbox or flyout, and should implement getWidth() and getHeight().
+   * @return An object containing width and height attributes, which will both
+   *     be zero if elem did not exist.
    */
-  getDimensionsPx_(elem) {
+  protected getDimensionsPx_(elem: IToolbox|null|IFlyout): Size {
     let width = 0;
     let height = 0;
     if (elem) {
@@ -72,13 +59,10 @@ class MetricsManager {
    * 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 {boolean=} opt_own Whether to only return the workspace's own
-   *     flyout.
-   * @return {!MetricsManager.ToolboxMetrics} The width and height of the
-   *     flyout.
-   * @public
+   * @param opt_own Whether to only return the workspace's own flyout.
+   * @return The width and height of the flyout.
    */
-  getFlyoutMetrics(opt_own) {
+  getFlyoutMetrics(opt_own?: boolean): ToolboxMetrics {
     const flyoutDimensions =
         this.getDimensionsPx_(this.workspace_.getFlyout(opt_own));
     return {
@@ -94,11 +78,9 @@ class MetricsManager {
    * a simple toolbox instead of a category toolbox. To get the width and height
    * of a
    * simple toolbox @see {@link getFlyoutMetrics}.
-   * @return {!MetricsManager.ToolboxMetrics} The object with the width,
-   *     height and position of the toolbox.
-   * @public
+   * @return The object with the width, height and position of the toolbox.
    */
-  getToolboxMetrics() {
+  getToolboxMetrics(): ToolboxMetrics {
     const toolboxDimensions =
         this.getDimensionsPx_(this.workspace_.getToolbox());
 
@@ -112,11 +94,9 @@ class MetricsManager {
   /**
    * 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 {!Size} The width and height of the workspace's parent
-   *     SVG element.
-   * @public
+   * @return The width and height of the workspace's parent SVG element.
    */
-  getSvgMetrics() {
+  getSvgMetrics(): Size {
     return this.workspace_.getCachedParentSvgSize();
   }
 
@@ -124,11 +104,9 @@ class MetricsManager {
    * Gets the absolute left and absolute top in pixel coordinates.
    * This is where the visible workspace starts in relation to the SVG
    * container.
-   * @return {!MetricsManager.AbsoluteMetrics} The absolute metrics for
-   *     the workspace.
-   * @public
+   * @return The absolute metrics for the workspace.
    */
-  getAbsoluteMetrics() {
+  getAbsoluteMetrics(): AbsoluteMetrics {
     let absoluteLeft = 0;
     const toolboxMetrics = this.getToolboxMetrics();
     const flyoutMetrics = this.getFlyoutMetrics(true);
@@ -160,14 +138,12 @@ class MetricsManager {
   /**
    * Gets the metrics for the visible workspace in either pixel or workspace
    * coordinates. The visible workspace does not include the toolbox or flyout.
-   * @param {boolean=} opt_getWorkspaceCoordinates True to get the view metrics
-   *     in workspace coordinates, false to get them in pixel coordinates.
-   * @return {!MetricsManager.ContainerRegion} The width, height, top and
-   *     left of the viewport in either workspace coordinates or pixel
-   *     coordinates.
-   * @public
+   * @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) {
+  getViewMetrics(opt_getWorkspaceCoordinates?: boolean): ContainerRegion {
     const scale = opt_getWorkspaceCoordinates ? this.workspace_.scale : 1;
     const svgMetrics = this.getSvgMetrics();
     const toolboxMetrics = this.getToolboxMetrics();
@@ -207,16 +183,12 @@ class MetricsManager {
    * 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 {boolean=} opt_getWorkspaceCoordinates True to get the content
-   *     metrics in workspace coordinates, false to get them in pixel
-   *     coordinates.
-   * @return {!MetricsManager.ContainerRegion} The
-   *     metrics for the content container.
-   * @public
+   * @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) {
+  getContentMetrics(opt_getWorkspaceCoordinates?: boolean): ContainerRegion {
     const scale = opt_getWorkspaceCoordinates ? 1 : this.workspace_.scale;
-
     // Block bounding box is in workspace coordinates.
     const blockBox = this.workspace_.getBlocksBoundingBox();
 
@@ -230,10 +202,10 @@ class MetricsManager {
 
   /**
    * Returns whether the scroll area has fixed edges.
-   * @return {boolean} Whether the scroll area has fixed edges.
-   * @package
+   * @return Whether the scroll area has fixed edges.
+   * @internal
    */
-  hasFixedEdges() {
+  hasFixedEdges(): boolean {
     // This exists for optimization of bump logic.
     return !this.workspace_.isMovableHorizontally() ||
         !this.workspace_.isMovableVertically();
@@ -241,14 +213,13 @@ class MetricsManager {
 
   /**
    * Computes the fixed edges of the scroll area.
-   * @param {!MetricsManager.ContainerRegion=} 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.
-   * @return {!MetricsManager.FixedEdges} The fixed edges of the scroll
-   *     area.
-   * @protected
+   * @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.
+   * @return The fixed edges of the scroll area.
    */
-  getComputedFixedEdges_(opt_viewMetrics) {
+  protected getComputedFixedEdges_(opt_viewMetrics?: ContainerRegion):
+      FixedEdges {
     if (!this.hasFixedEdges()) {
       // Return early if there are no edges.
       return {};
@@ -259,7 +230,7 @@ class MetricsManager {
 
     const viewMetrics = opt_viewMetrics || this.getViewMetrics(false);
 
-    const edges = {};
+    const edges = {} as FixedEdges;
     if (!vScrollEnabled) {
       edges.top = viewMetrics.top;
       edges.bottom = viewMetrics.top + viewMetrics.height;
@@ -273,15 +244,13 @@ class MetricsManager {
 
   /**
    * Returns the content area with added padding.
-   * @param {!MetricsManager.ContainerRegion} viewMetrics The view
-   *     metrics.
-   * @param {!MetricsManager.ContainerRegion} contentMetrics The content
-   *     metrics.
-   * @return {{top: number, bottom: number, left: number, right: number}} The
-   *     padded content area.
-   * @protected
+   * @param viewMetrics The view metrics.
+   * @param contentMetrics The content metrics.
+   * @return The padded content area.
    */
-  getPaddedContent_(viewMetrics, contentMetrics) {
+  protected getPaddedContent_(
+      viewMetrics: ContainerRegion, contentMetrics: ContainerRegion):
+      {top: number, bottom: number, left: number, right: number} {
     const contentBottom = contentMetrics.top + contentMetrics.height;
     const contentRight = contentMetrics.left + contentMetrics.width;
 
@@ -301,25 +270,24 @@ class MetricsManager {
     const right =
         Math.max(contentRight + halfWidth, contentMetrics.left + viewWidth);
 
-    return {top: top, bottom: bottom, left: left, right: right};
+    return {top, bottom, left, right};
   }
 
   /**
    * Returns the metrics for the scroll area of the workspace.
-   * @param {boolean=} opt_getWorkspaceCoordinates True to get the scroll
-   *     metrics in workspace coordinates, false to get them in pixel
-   *     coordinates.
-   * @param {!MetricsManager.ContainerRegion=} 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 {!MetricsManager.ContainerRegion=} 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 {!MetricsManager.ContainerRegion} The metrics for the scroll
-   *    container.
+   * @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, opt_viewMetrics, opt_contentMetrics) {
+      opt_getWorkspaceCoordinates?: boolean, opt_viewMetrics?: ContainerRegion,
+      opt_contentMetrics?: ContainerRegion): ContainerRegion {
     const scale = opt_getWorkspaceCoordinates ? this.workspace_.scale : 1;
     const viewMetrics = opt_viewMetrics || this.getViewMetrics(false);
     const contentMetrics = opt_contentMetrics || this.getContentMetrics();
@@ -348,9 +316,9 @@ class MetricsManager {
 
   /**
    * Returns common metrics used by UI elements.
-   * @return {!MetricsManager.UiMetrics} The UI metrics.
+   * @return The UI metrics.
    */
-  getUiMetrics() {
+  getUiMetrics(): UiMetrics {
     return {
       viewMetrics: this.getViewMetrics(),
       absoluteMetrics: this.getAbsoluteMetrics(),
@@ -390,11 +358,9 @@ class MetricsManager {
    * .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 {!Metrics} Contains size and position metrics of a top
-   *     level workspace.
-   * @public
+   * @return Contains size and position metrics of a top level workspace.
    */
-  getMetrics() {
+  getMetrics(): Metrics {
     const toolboxMetrics = this.getToolboxMetrics();
     const flyoutMetrics = this.getFlyoutMetrics(true);
     const svgMetrics = this.getSvgMetrics();
@@ -436,60 +402,55 @@ class MetricsManager {
   }
 }
 
-/**
- * Describes the width, height and location of the toolbox on the main
- * workspace.
- * @typedef {{
- *            width: number,
- *            height: number,
- *            position: !toolboxUtils.Position
- *          }}
- */
-MetricsManager.ToolboxMetrics;
+export namespace MetricsManager {
+  /**
+   * Describes the width, height and location of the toolbox on the main
+   * workspace.
+   */
+  export interface ToolboxMetrics {
+    width: number;
+    height: number;
+    position: toolboxUtils.Position;
+  }
 
-/**
- * Describes where the viewport starts in relation to the workspace SVG.
- * @typedef {{
- *            left: number,
- *            top: number
- *          }}
- */
-MetricsManager.AbsoluteMetrics;
+  /** Describes where the viewport starts in relation to the workspace SVG. */
+  export interface AbsoluteMetrics {
+    left: number;
+    top: number;
+  }
 
-/**
- * All the measurements needed to describe the size and location of a
- * container.
- * @typedef {{
- *            height: number,
- *            width: number,
- *            top: number,
- *            left: number
- *          }}
- */
-MetricsManager.ContainerRegion;
+  /**
+   * All the measurements needed to describe the size and location of a
+   * container.
+   */
+  export interface ContainerRegion {
+    height: number;
+    width: number;
+    top: number;
+    left: number;
+  }
 
-/**
- * Describes fixed edges of the workspace.
- * @typedef {{
- *            top: (number|undefined),
- *            bottom: (number|undefined),
- *            left: (number|undefined),
- *            right: (number|undefined)
- *          }}
- */
-MetricsManager.FixedEdges;
+  /** Describes fixed edges of the workspace. */
+  export interface FixedEdges {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+  }
 
-/**
- * Common metrics used for UI elements.
- * @typedef {{
- *            viewMetrics: !MetricsManager.ContainerRegion,
- *            absoluteMetrics: !MetricsManager.AbsoluteMetrics,
- *            toolboxMetrics: !MetricsManager.ToolboxMetrics
- *          }}
- */
-MetricsManager.UiMetrics;
+  /** Common metrics used for UI elements. */
+  export interface UiMetrics {
+    viewMetrics: ContainerRegion;
+    absoluteMetrics: AbsoluteMetrics;
+    toolboxMetrics: ToolboxMetrics;
+  }
+}
+
+export type ToolboxMetrics = MetricsManager.ToolboxMetrics;
+export type AbsoluteMetrics = MetricsManager.AbsoluteMetrics;
+export type ContainerRegion = MetricsManager.ContainerRegion;
+export type FixedEdges = MetricsManager.FixedEdges;
+export type UiMetrics = MetricsManager.UiMetrics;
 
 registry.register(
     registry.Type.METRICS_MANAGER, registry.DEFAULT, MetricsManager);
-
-exports.MetricsManager = MetricsManager;

package/core/msg.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright 2013 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** A dictionary of localised messages. */
+export declare const Msg: {
+    [key: string]: string;
+};

package/core/{msg.js → msg.ts}

@@ -7,18 +7,14 @@
 /**
  * @fileoverview Empty name space for the Message singleton.
  */
-'use strict';
 
 /**
  * Empty name space for the Message singleton.
  * @namespace Blockly.Msg
  */
-goog.module('Blockly.Msg');
+import * as goog from '../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Msg');
 
 
-/**
- * A dictionary of localised messages.
- * @type {!Object<string>}
- */
-const Msg = Object.create(null);
-exports.Msg = Msg;
+/** A dictionary of localised messages. */
+export const Msg: {[key: string]: string} = Object.create(null);

package/core/mutator.d.ts

@@ -0,0 +1,128 @@
+/**
+ * @license
+ * Copyright 2012 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import './events/events_bubble_open.js';
+import type { Block } from './block.js';
+import type { BlockSvg } from './block_svg.js';
+import type { Connection } from './connection.js';
+import type { Abstract } from './events/events_abstract.js';
+import { Icon } from './icon.js';
+import { Options } from './options.js';
+import type { WorkspaceSvg } from './workspace_svg.js';
+/**
+ * Class for a mutator dialog.
+ * @alias Blockly.Mutator
+ */
+export declare class Mutator extends Icon {
+    quarkNames_: any;
+    /** Workspace in the mutator's bubble. */
+    private workspace_;
+    /** Width of workspace. */
+    private workspaceWidth_;
+    /** Height of workspace. */
+    private workspaceHeight_;
+    /**
+     * The SVG element that is the parent of the mutator workspace, or null if
+     * not created.
+     */
+    private svgDialog_;
+    /**
+     * The root block of the mutator workspace, created by decomposing the
+     * source block.
+     */
+    private rootBlock_;
+    /**
+     * Function registered on the main workspace to update the mutator contents
+     * when the main workspace changes.
+     */
+    private sourceListener_;
+    /**
+     * The PID associated with the updateWorkpace_ timeout, or 0 if no timeout
+     * is currently running.
+     */
+    private updateWorkspacePid_;
+    /** @param quarkNames List of names of sub-blocks for flyout. */
+    constructor(block: BlockSvg, quarkNames: string[]);
+    /**
+     * Set the block this mutator is associated with.
+     * @param block The block associated with this mutator.
+     * @internal
+     */
+    setBlock(block: BlockSvg): void;
+    /**
+     * Returns the workspace inside this mutator icon's bubble.
+     * @return The workspace inside this mutator icon's bubble or null if the
+     *     mutator isn't open.
+     * @internal
+     */
+    getWorkspace(): WorkspaceSvg | null;
+    /**
+     * Draw the mutator icon.
+     * @param group The icon group.
+     */
+    protected drawIcon_(group: Element): void;
+    /**
+     * Clicking on the icon toggles if the mutator bubble is visible.
+     * Disable if block is uneditable.
+     * @param e Mouse click event.
+     */
+    protected iconClick_(e: MouseEvent): void;
+    /**
+     * Create the editor for the mutator's bubble.
+     * @return The top-level node of the editor.
+     */
+    private createEditor_;
+    /**
+     * @internal
+     */
+    newWorkspaceSvg(options: Options): WorkspaceSvg;
+    /** Add or remove the UI indicating if this icon may be clicked or not. */
+    updateEditable(): void;
+    /** Resize the bubble to match the size of the workspace. */
+    private resizeBubble_;
+    /** A method handler for when the bubble is moved. */
+    private onBubbleMove_;
+    /**
+     * Show or hide the mutator bubble.
+     * @param visible True if the bubble should be visible.
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * Fired whenever a change is made to the mutator's workspace.
+     * @param e Custom data for event.
+     */
+    private workspaceChanged_;
+    /**
+     * Returns whether the given event in the mutator workspace should be ignored
+     * when deciding whether to update the workspace and compose the block or not.
+     * @param e The event.
+     * @return Whether to ignore the event or not.
+     */
+    shouldIgnoreMutatorEvent_(e: Abstract): boolean;
+    /**
+     * Updates the source block when the mutator's blocks are changed.
+     * Bump down any block that's too high.
+     */
+    private updateWorkspace_;
+    /** Dispose of this mutator. */
+    dispose(): void;
+    /** Update the styles on all blocks in the mutator. */
+    updateBlockStyle(): void;
+    /**
+     * Reconnect an block to a mutated input.
+     * @param connectionChild Connection on child block.
+     * @param block Parent block.
+     * @param inputName Name of input on parent block.
+     * @return True iff a reconnection was made, false otherwise.
+     */
+    static reconnect(connectionChild: Connection, block: Block, inputName: string): boolean;
+    /**
+     * Get the parent workspace of a workspace that is inside a mutator, taking
+     * into account whether it is a flyout.
+     * @param workspace The workspace that is inside a mutator.
+     * @return The mutator's parent workspace or null.
+     */
+    static findParentWs(workspace: WorkspaceSvg): WorkspaceSvg | null;
+}