blockly 8.0.5 → 9.0.0-beta.0

package/core/utils/idgenerator.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare const TEST_ONLY: {};
+/**
+ * Generate the next unique element IDs.
+ * IDs are compatible with the HTML4 id attribute restrictions:
+ * Use only ASCII letters, digits, '_', '-' and '.'
+ *
+ * For UUIDs use genUid (below) instead; this ID generator should
+ * primarily be used for IDs that end up in the DOM.
+ *
+ * @return The next unique identifier.
+ * @alias Blockly.utils.idGenerator.getNextUniqueId
+ */
+export declare function getNextUniqueId(): string;
+/**
+ * Generate a random unique ID.
+ * @see internal.genUid
+ * @return A globally unique ID string.
+ * @alias Blockly.utils.idGenerator.genUid
+ */
+export declare function genUid(): string;

package/core/utils/{idgenerator.js → idgenerator.ts}

@@ -7,13 +7,13 @@
 /**
  * @fileoverview Generators for unique IDs.
  */
-'use strict';
 
 /**
  * Generators for unique IDs.
  * @namespace Blockly.utils.idGenerator
  */
-goog.module('Blockly.utils.idGenerator');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.idGenerator');
 
 
 /**
@@ -22,12 +22,9 @@ goog.module('Blockly.utils.idGenerator');
  * @ignore
  */
 const internal = {};
-exports.TEST_ONLY = internal;
+export const TEST_ONLY = internal;
 
-/**
- * Next unique ID to use.
- * @type {number}
- */
+/** Next unique ID to use. */
 let nextId = 0;
 
 /**
@@ -38,13 +35,12 @@ let nextId = 0;
  * For UUIDs use genUid (below) instead; this ID generator should
  * primarily be used for IDs that end up in the DOM.
  *
- * @return {string} The next unique identifier.
+ * @return The next unique identifier.
  * @alias Blockly.utils.idGenerator.getNextUniqueId
  */
-const getNextUniqueId = function() {
+export function getNextUniqueId(): string {
   return 'blockly-' + (nextId++).toString(36);
-};
-exports.getNextUniqueId = getNextUniqueId;
+}
 
 /**
  * Legal characters for the universally unique IDs.  Should be all on
@@ -59,9 +55,10 @@ const soup = '!#$%()*+,-./:;=?@[]^_`{|}~' +
 /**
  * Generate a random unique ID.  This should be globally unique.
  * 87 characters ^ 20 length > 128 bits (better than a UUID).
- * @return {string} A globally unique ID string.
+ * @return A globally unique ID string.
  */
-internal.genUid = function() {
+// AnyDuringMigration because:  Property 'genUid' does not exist on type '{}'.
+(internal as AnyDuringMigration).genUid = function(): string {
   const length = 20;
   const soupLength = soup.length;
   const id = [];
@@ -74,10 +71,10 @@ internal.genUid = function() {
 /**
  * Generate a random unique ID.
  * @see internal.genUid
- * @return {string} A globally unique ID string.
+ * @return A globally unique ID string.
  * @alias Blockly.utils.idGenerator.genUid
  */
-const genUid = function() {
-  return internal.genUid();
-};
-exports.genUid = genUid;
+export function genUid(): string {
+  // AnyDuringMigration because:  Property 'genUid' does not exist on type '{}'.
+  return (internal as AnyDuringMigration).genUid();
+}

package/core/utils/keycodes.d.ts

@@ -0,0 +1,137 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Key codes for common characters.
+ *
+ * Copied from Closure's goog.events.KeyCodes
+ *
+ * This list is not localized and therefore some of the key codes are not
+ * correct for non US keyboard layouts. See comments below.
+ *
+ * @alias Blockly.utils.KeyCodes
+ */
+export declare enum KeyCodes {
+    WIN_KEY_FF_LINUX = 0,
+    MAC_ENTER = 3,
+    BACKSPACE = 8,
+    TAB = 9,
+    NUM_CENTER = 12,
+    ENTER = 13,
+    SHIFT = 16,
+    CTRL = 17,
+    ALT = 18,
+    PAUSE = 19,
+    CAPS_LOCK = 20,
+    ESC = 27,
+    SPACE = 32,
+    PAGE_UP = 33,
+    PAGE_DOWN = 34,
+    END = 35,
+    HOME = 36,
+    LEFT = 37,
+    UP = 38,
+    RIGHT = 39,
+    DOWN = 40,
+    PLUS_SIGN = 43,
+    PRINT_SCREEN = 44,
+    INSERT = 45,
+    DELETE = 46,
+    ZERO = 48,
+    ONE = 49,
+    TWO = 50,
+    THREE = 51,
+    FOUR = 52,
+    FIVE = 53,
+    SIX = 54,
+    SEVEN = 55,
+    EIGHT = 56,
+    NINE = 57,
+    FF_SEMICOLON = 59,
+    FF_EQUALS = 61,
+    FF_DASH = 173,
+    FF_HASH = 163,
+    QUESTION_MARK = 63,
+    AT_SIGN = 64,
+    A = 65,
+    B = 66,
+    C = 67,
+    D = 68,
+    E = 69,
+    F = 70,
+    G = 71,
+    H = 72,
+    I = 73,
+    J = 74,
+    K = 75,
+    L = 76,
+    M = 77,
+    N = 78,
+    O = 79,
+    P = 80,
+    Q = 81,
+    R = 82,
+    S = 83,
+    T = 84,
+    U = 85,
+    V = 86,
+    W = 87,
+    X = 88,
+    Y = 89,
+    Z = 90,
+    META = 91,
+    WIN_KEY_RIGHT = 92,
+    CONTEXT_MENU = 93,
+    NUM_ZERO = 96,
+    NUM_ONE = 97,
+    NUM_TWO = 98,
+    NUM_THREE = 99,
+    NUM_FOUR = 100,
+    NUM_FIVE = 101,
+    NUM_SIX = 102,
+    NUM_SEVEN = 103,
+    NUM_EIGHT = 104,
+    NUM_NINE = 105,
+    NUM_MULTIPLY = 106,
+    NUM_PLUS = 107,
+    NUM_MINUS = 109,
+    NUM_PERIOD = 110,
+    NUM_DIVISION = 111,
+    F1 = 112,
+    F2 = 113,
+    F3 = 114,
+    F4 = 115,
+    F5 = 116,
+    F6 = 117,
+    F7 = 118,
+    F8 = 119,
+    F9 = 120,
+    F10 = 121,
+    F11 = 122,
+    F12 = 123,
+    NUMLOCK = 144,
+    SCROLL_LOCK = 145,
+    FIRST_MEDIA_KEY = 166,
+    LAST_MEDIA_KEY = 183,
+    SEMICOLON = 186,
+    DASH = 189,
+    EQUALS = 187,
+    COMMA = 188,
+    PERIOD = 190,
+    SLASH = 191,
+    APOSTROPHE = 192,
+    TILDE = 192,
+    SINGLE_QUOTE = 222,
+    OPEN_SQUARE_BRACKET = 219,
+    BACKSLASH = 220,
+    CLOSE_SQUARE_BRACKET = 221,
+    WIN_KEY = 224,
+    MAC_FF_META = 224,
+    MAC_WK_CMD_LEFT = 91,
+    MAC_WK_CMD_RIGHT = 93,
+    WIN_IME = 229,
+    VK_NONAME = 252,
+    PHANTOM = 255
+}

package/core/utils/keycodes.ts

@@ -0,0 +1,169 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Constant declarations for common key codes.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ */
+
+/**
+ * Constant declarations for common key codes.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ * @namespace Blockly.utils.KeyCodes
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.KeyCodes');
+
+
+/**
+ * Key codes for common characters.
+ *
+ * Copied from Closure's goog.events.KeyCodes
+ *
+ * This list is not localized and therefore some of the key codes are not
+ * correct for non US keyboard layouts. See comments below.
+ *
+ * @alias Blockly.utils.KeyCodes
+ */
+export enum KeyCodes {
+  WIN_KEY_FF_LINUX = 0,
+  MAC_ENTER = 3,
+  BACKSPACE = 8,
+  TAB = 9,
+  NUM_CENTER = 12,  // NUMLOCK on FF/Safari Mac
+  ENTER = 13,
+  SHIFT = 16,
+  CTRL = 17,
+  ALT = 18,
+  PAUSE = 19,
+  CAPS_LOCK = 20,
+  ESC = 27,
+  SPACE = 32,
+  PAGE_UP = 33,    // also NUM_NORTH_EAST
+  PAGE_DOWN = 34,  // also NUM_SOUTH_EAST
+  END = 35,        // also NUM_SOUTH_WEST
+  HOME = 36,       // also NUM_NORTH_WEST
+  LEFT = 37,       // also NUM_WEST
+  UP = 38,         // also NUM_NORTH
+  RIGHT = 39,      // also NUM_EAST
+  DOWN = 40,       // also NUM_SOUTH
+  PLUS_SIGN = 43,  // NOT numpad plus
+  PRINT_SCREEN = 44,
+  INSERT = 45,  // also NUM_INSERT
+  DELETE = 46,  // also NUM_DELETE
+  ZERO = 48,
+  ONE = 49,
+  TWO = 50,
+  THREE = 51,
+  FOUR = 52,
+  FIVE = 53,
+  SIX = 54,
+  SEVEN = 55,
+  EIGHT = 56,
+  NINE = 57,
+  FF_SEMICOLON = 59,  // Firefox (Gecko) fires this for semicolon instead of 186
+  FF_EQUALS = 61,     // Firefox (Gecko) fires this for equals instead of 187
+  FF_DASH = 173,      // Firefox (Gecko) fires this for dash instead of 189
+  // Firefox (Gecko) fires this for # on UK keyboards, rather than
+  // Shift+SINGLE_QUOTE.
+  FF_HASH = 163,
+  QUESTION_MARK = 63,  // needs localization
+  AT_SIGN = 64,
+  A = 65,
+  B = 66,
+  C = 67,
+  D = 68,
+  E = 69,
+  F = 70,
+  G = 71,
+  H = 72,
+  I = 73,
+  J = 74,
+  K = 75,
+  L = 76,
+  M = 77,
+  N = 78,
+  O = 79,
+  P = 80,
+  Q = 81,
+  R = 82,
+  S = 83,
+  T = 84,
+  U = 85,
+  V = 86,
+  W = 87,
+  X = 88,
+  Y = 89,
+  Z = 90,
+  META = 91,  // WIN_KEY_LEFT
+  WIN_KEY_RIGHT = 92,
+  CONTEXT_MENU = 93,
+  NUM_ZERO = 96,
+  NUM_ONE = 97,
+  NUM_TWO = 98,
+  NUM_THREE = 99,
+  NUM_FOUR = 100,
+  NUM_FIVE = 101,
+  NUM_SIX = 102,
+  NUM_SEVEN = 103,
+  NUM_EIGHT = 104,
+  NUM_NINE = 105,
+  NUM_MULTIPLY = 106,
+  NUM_PLUS = 107,
+  NUM_MINUS = 109,
+  NUM_PERIOD = 110,
+  NUM_DIVISION = 111,
+  F1 = 112,
+  F2 = 113,
+  F3 = 114,
+  F4 = 115,
+  F5 = 116,
+  F6 = 117,
+  F7 = 118,
+  F8 = 119,
+  F9 = 120,
+  F10 = 121,
+  F11 = 122,
+  F12 = 123,
+  NUMLOCK = 144,
+  SCROLL_LOCK = 145,
+
+  // OS-specific media keys like volume controls and browser controls.
+  FIRST_MEDIA_KEY = 166,
+  LAST_MEDIA_KEY = 183,
+
+  SEMICOLON = 186,             // needs localization
+  DASH = 189,                  // needs localization
+  EQUALS = 187,                // needs localization
+  COMMA = 188,                 // needs localization
+  PERIOD = 190,                // needs localization
+  SLASH = 191,                 // needs localization
+  APOSTROPHE = 192,            // needs localization
+  TILDE = 192,                 // needs localization
+  SINGLE_QUOTE = 222,          // needs localization
+  OPEN_SQUARE_BRACKET = 219,   // needs localization
+  BACKSLASH = 220,             // needs localization
+  CLOSE_SQUARE_BRACKET = 221,  // needs localization
+  WIN_KEY = 224,
+  MAC_FF_META =
+      224,  // Firefox (Gecko) fires this for the meta key instead of 91
+  MAC_WK_CMD_LEFT = 91,   // WebKit Left Command key fired, same as META
+  MAC_WK_CMD_RIGHT = 93,  // WebKit Right Command key fired, different from META
+  WIN_IME = 229,
+
+  // "Reserved for future use". Some programs (e.g. the SlingPlayer 2.4 ActiveX
+  // control) fire this as a hacky way to disable screensavers.
+  VK_NONAME = 252,
+
+  // We've seen users whose machines fire this keycode at regular one
+  // second intervals. The common thread among these users is that
+  // they're all using Dell Inspiron laptops, so we suspect that this
+  // indicates a hardware/bios problem.
+  // http://en.community.dell.com/support-forums/laptop/f/3518/p/19285957/19523128.aspx
+  PHANTOM = 255,
+}

package/core/utils/math.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Converts degrees to radians.
+ * Copied from Closure's goog.math.toRadians.
+ * @param angleDegrees Angle in degrees.
+ * @return Angle in radians.
+ * @alias Blockly.utils.math.toRadians
+ */
+export declare function toRadians(angleDegrees: number): number;
+/**
+ * Converts radians to degrees.
+ * Copied from Closure's goog.math.toDegrees.
+ * @param angleRadians Angle in radians.
+ * @return Angle in degrees.
+ * @alias Blockly.utils.math.toDegrees
+ */
+export declare function toDegrees(angleRadians: number): number;
+/**
+ * Clamp the provided number between the lower bound and the upper bound.
+ * @param lowerBound The desired lower bound.
+ * @param number The number to clamp.
+ * @param upperBound The desired upper bound.
+ * @return The clamped number.
+ * @alias Blockly.utils.math.clamp
+ */
+export declare function clamp(lowerBound: number, number: number, upperBound: number): number;

package/core/utils/{math.js → math.ts}

@@ -9,7 +9,6 @@
  * These methods are not specific to Blockly, and could be factored out into
  * a JavaScript framework such as Closure.
  */
-'use strict';
 
 /**
  * Utility methods for math.
@@ -17,47 +16,46 @@
  * a JavaScript framework such as Closure.
  * @namespace Blockly.utils.math
  */
-goog.module('Blockly.utils.math');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.math');
 
 
 /**
  * Converts degrees to radians.
  * Copied from Closure's goog.math.toRadians.
- * @param {number} angleDegrees Angle in degrees.
- * @return {number} Angle in radians.
+ * @param angleDegrees Angle in degrees.
+ * @return Angle in radians.
  * @alias Blockly.utils.math.toRadians
  */
-const toRadians = function(angleDegrees) {
+export function toRadians(angleDegrees: number): number {
   return angleDegrees * Math.PI / 180;
-};
-exports.toRadians = toRadians;
+}
 
 /**
  * Converts radians to degrees.
  * Copied from Closure's goog.math.toDegrees.
- * @param {number} angleRadians Angle in radians.
- * @return {number} Angle in degrees.
+ * @param angleRadians Angle in radians.
+ * @return Angle in degrees.
  * @alias Blockly.utils.math.toDegrees
  */
-const toDegrees = function(angleRadians) {
+export function toDegrees(angleRadians: number): number {
   return angleRadians * 180 / Math.PI;
-};
-exports.toDegrees = toDegrees;
+}
 
 /**
  * Clamp the provided number between the lower bound and the upper bound.
- * @param {number} lowerBound The desired lower bound.
- * @param {number} number The number to clamp.
- * @param {number} upperBound The desired upper bound.
- * @return {number} The clamped number.
+ * @param lowerBound The desired lower bound.
+ * @param number The number to clamp.
+ * @param upperBound The desired upper bound.
+ * @return The clamped number.
  * @alias Blockly.utils.math.clamp
  */
-const clamp = function(lowerBound, number, upperBound) {
+export function clamp(
+    lowerBound: number, number: number, upperBound: number): number {
   if (upperBound < lowerBound) {
     const temp = upperBound;
     upperBound = lowerBound;
     lowerBound = temp;
   }
   return Math.max(lowerBound, Math.min(number, upperBound));
-};
-exports.clamp = clamp;
+}

package/core/utils/metrics.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** @alias Blockly.utils.Metrics */
+export interface Metrics {
+    /** Height of the visible portion of the workspace. */
+    viewHeight: number;
+    /** Width of the visible portion of the workspace. */
+    viewWidth: number;
+    /** Height of the content. */
+    contentHeight: number;
+    /** Width of the content. */
+    contentWidth: number;
+    /** Height of the scroll area. */
+    scrollHeight: number;
+    /** Width of the scroll area. */
+    scrollWidth: number;
+    /**
+     * Top-edge of the visible portion of the workspace, relative to the workspace
+     * origin.
+     */
+    viewTop: number;
+    /**
+     * Left-edge of the visible portion of the workspace, relative to the
+     * workspace origin.
+     */
+    viewLeft: number;
+    /** Top-edge of the content, relative to the workspace origin. */
+    contentTop: number;
+    /** Left-edge of the content relative to the workspace origin. */
+    contentLeft: number;
+    /** Top-edge of the scroll area, relative to the workspace origin. */
+    scrollTop: number;
+    /** Left-edge of the scroll area relative to the workspace origin. */
+    scrollLeft: number;
+    /**
+     * Top-edge of the visible portion of the workspace, relative to the
+     * blocklyDiv.
+     */
+    absoluteTop: number;
+    /**
+     * Left-edge of the visible portion of the workspace, relative to the
+     * blocklyDiv.
+     */
+    absoluteLeft: number;
+    /**
+     * Height of the Blockly div (the view + the toolbox, simple of otherwise).
+     */
+    svgHeight: number;
+    /** Width of the Blockly div (the view + the toolbox, simple or otherwise). */
+    svgWidth: number;
+    /** Width of the toolbox, if it exists.  Otherwise zero. */
+    toolboxWidth: number;
+    /** Height of the toolbox, if it exists.  Otherwise zero. */
+    toolboxHeight: number;
+    /** Top, bottom, left or right. Use TOOLBOX_AT constants to compare. */
+    toolboxPosition: number;
+    /** Width of the flyout if it is always open.  Otherwise zero. */
+    flyoutWidth: number;
+    /** Height of the flyout if it is always open.  Otherwise zero. */
+    flyoutHeight: number;
+}

package/core/utils/metrics.ts

@@ -0,0 +1,97 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Workspace metrics definitions.
+ */
+
+/**
+ * Workspace metrics definitions.
+ * @namespace Blockly.utils.Metrics
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.Metrics');
+
+
+/** @alias Blockly.utils.Metrics */
+export interface Metrics {
+  /** Height of the visible portion of the workspace. */
+  viewHeight: number;
+
+  /** Width of the visible portion of the workspace. */
+  viewWidth: number;
+
+  /** Height of the content. */
+  contentHeight: number;
+
+  /** Width of the content. */
+  contentWidth: number;
+
+  /** Height of the scroll area. */
+  scrollHeight: number;
+
+  /** Width of the scroll area. */
+  scrollWidth: number;
+
+  /**
+   * Top-edge of the visible portion of the workspace, relative to the workspace
+   * origin.
+   */
+  viewTop: number;
+
+  /**
+   * Left-edge of the visible portion of the workspace, relative to the
+   * workspace origin.
+   */
+  viewLeft: number;
+
+  /** Top-edge of the content, relative to the workspace origin. */
+  contentTop: number;
+
+  /** Left-edge of the content relative to the workspace origin. */
+  contentLeft: number;
+
+  /** Top-edge of the scroll area, relative to the workspace origin. */
+  scrollTop: number;
+
+  /** Left-edge of the scroll area relative to the workspace origin. */
+  scrollLeft: number;
+
+  /**
+   * Top-edge of the visible portion of the workspace, relative to the
+   * blocklyDiv.
+   */
+  absoluteTop: number;
+
+  /**
+   * Left-edge of the visible portion of the workspace, relative to the
+   * blocklyDiv.
+   */
+  absoluteLeft: number;
+
+  /**
+   * Height of the Blockly div (the view + the toolbox, simple of otherwise).
+   */
+  svgHeight: number;
+
+  /** Width of the Blockly div (the view + the toolbox, simple or otherwise). */
+  svgWidth: number;
+
+  /** Width of the toolbox, if it exists.  Otherwise zero. */
+  toolboxWidth: number;
+
+  /** Height of the toolbox, if it exists.  Otherwise zero. */
+  toolboxHeight: number;
+
+  /** Top, bottom, left or right. Use TOOLBOX_AT constants to compare. */
+  toolboxPosition: number;
+
+  /** Width of the flyout if it is always open.  Otherwise zero. */
+  flyoutWidth: number;
+
+  /** Height of the flyout if it is always open.  Otherwise zero. */
+  flyoutHeight: number;
+}