chore: Migrate core/ to Typescript, actually (#6299)

* fix: convert files to typescript

* fix: add alias for AnyDuringMigration so that tsc will run

* chore: format

* chore: enable ts for the clang-format workflow (#6233)

* chore: Restore @fileoverview comment locations (#6237)

* chore: add declareModuleId (#6238)

* fix: Revert comment change to app_controller.js (#6241)

* fix: Add missing import goog statements (#6240)

I've added the import statement immediately before the
goog.declareModuleId calls that depend on it.

There is an argument to be made that we should put the import
statement in their normal place amongst any other imports, and
move the declareModuleId statement to below the double blank
line below the imports, but as these are so tightly coupled,
replace the previous goog.module calls, and will both be deleted
at the same time once the transition to TypeScript is fully complete
I think it's fine (and certainly much easier) to do it this way.

* chore: Fix whitespace (#6243)

* fix: Remove spurious blank lines

  Remove extraneous blank lines introduced by deletion of
  'use strict'; pragmas.

  Also fix the location of the goog.declareModuleId call in
  core/utils/array.ts.

* fix: Add missing double-blank-line before body of modules

  Our convention is to have two blank lines between the imports (or
  module ID, if there are no imports) and the beginning of the body
  of the module.  Enforce this.

* fix: one addition format error for PR #6243

* fix(build): Skip npm prepare when running in CI (#6244)

Have npm prepare do nothing when running in CI.

We don't need to do any building, because npm test will build
everything needed in the workflows in which it is run, and we
don't want to build anything in other workflows because a tsc
error would prevent those workflows from completing.

* fix: re-add `@package` annotations as `@internal` annotations (#6232)

* fix: add ~70% of internal attributes

* fix: work on manually adding more @internal annotations

* fix: add more manual internal annotations

* fix: rename package typos to internal

* fix: final manual fixes for internal annotations

* chore: format

* chore: make unnecessary multiline jsdoc a single line

* fix: fix internal tags in serialization exceptions

* fix: tsc errors picked up from develop (#6224)

* fix: relative path for deprecation utils

* fix: checking if properties exist in svg_math

* fix: set all timeout PIDs to AnyDuringMigration

* fix: make nullability errors explicity in block drag surface

* fix: make null check in events_block_change explicit

* fix: make getEventWorkspace_ internal so we can access it from CommentCreateDeleteHelper

* fix: rename DIV -> containerDiv in tooltip

* fix: ignore backwards compat check in category

* fix: set block styles to AnyDuringMigration

* fix: type typo in KeyboardShortcut

* fix: constants name in row measurables

* fix: typecast in mutator

* fix: populateProcedures type of flattened array

* fix: ignore errors related to workspace comment deserialization

* chore: format files

* fix: renaming imports missing file extensions

* fix: remove check for sound.play

* fix: temporarily remove bad requireType.

All `export type` statements are stripped when tsc is run. This means
that when we attempt to require BlockDefinition from the block files, we
get an error because it does not exist.

We decided to temporarily remove the require, because this will no
longer be a problem when we conver the blocks to typescript, and
everything gets compiled together.

* fix: bad jsdoc in array

* fix: silence missing property errors

Closure was complaining about inexistant properties, but they actually
do exist, they're just not being transpiled by tsc in a way that closure
understands.

I.E. if things are initialized in a function called by the constructor,
rather than in a class field or in the custructor itself, closure would
error.

It would also error on enums, because they are transpiled to a weird
IIFE.

* fix: context menu action handler not knowing the type of this.

this: TypeX information gets stripped when tsc is run, so closure could
not know that this was not global. Fixed this by reorganizing to use the
option object directly instead of passing it to onAction to be bound to
this.

* fix: readd getDeveloperVars checks (should not be part of migration)

This was found because ALL_DEVELOPER_VARS_WARNINGS_BY_BLOCK_TYPE was no
longer being accessed.

* fix: silence closure errors about overriding supertype props

We propertly define the overrides in typescript, but these get removed
from the compiled output, so closure doesn't know they exist.

* fix: silence globalThis errors

this: TypeX annotations get stripped from the compiled output, so
closure can't know that we're accessing the correct things. However,
typescript makes sure that this always has the correct properties, so
silencing this should be fine.

* fix: bad jsdoc name

* chore: attempt compiling with blockly.js

* fix: attempt moving the import statement above the namespace line

* chore: add todo comments to block def files

* chore: remove todo from context menu

* chore: add comments abotu disabled errors

* chore: move comments back to their correct positions (#6249)

* fix: work on fixing comments

* chore: finish moving all comments

* chore: format

* chore: move some other messed up comments

* chore: format

* fix: Correct enum formatting, use merged `namespace`s for types that are class static members (#6246)

* fix: formatting of enum KeyCodes

* fix: Use merged namespace for ContextMenuRegistry static types

  - Create a namespace to be merged with the ContextMenuRegistry
    class containing the types that were formerly declared as static
    properties on that class.

  - Use type aliases to export them individually as well, for
    compatibility with the changes made by MigranTS (and/or
    @gonfunko) to how other modules in core/ now import these
    types.

  - Update renamings.json5 to reflect the availability of the
    direct exports for modules that import this module directly
    (though they are not available to, and will not be used by,
    code that imports only via blockly.js/blockly.ts.)

* fix: Use merged namespace for Input.Align

  - Create a merged namespace for the Input.Align enum.

  - Use type/const aliases to export it as Input too.

  - Update renamings.json5 to reflect the availability of the
    direct export.

* fix: Use merged namespace for Names.NameType

  - Create a merged namespace for the Names.NameType enum.

  - Use type/const aliases to export it as NameType too.

  - Update renamings.json5 to reflect the availability of the
    direct export.  (This ought to have happened in an earlier
    version as it was already available by both routes.)

* chore: Fix minor issues for PR #6246

  - Use `Align` instead of `Input.Align` where possible.

* fix(build): Suppress irrelevant JSC_UNUSED_LOCAL_ASSIGNMENT errors

  tsc generates code for merged namespaces that looks like:

      (function (ClassName) {
          let EnumName;
          (function (EnumName) {
              EnumName[EnumNameAlign["v1"] = 0] = "v1";
              // etc.
          })(EnumName = ClassName.EnumName || (ClassName.EnumName = {}));
      })(ClassName || (ClassName = {}));

  and Closure Compiler complains about the fact that the EnumName let
  binding is initialised but never used.  (It exists so that any other
  code that was in the namespace could see the enum.)

  Suppress this message, since it is not actionable and lint and/or tsc
  should tell us if we have actual unused variables in our .ts files.

* chore(build): Suppress spurious warnings from closure-make-deps (#6253)

A little bit of an ugly hack, but it works: pipe stderr through
grep -v to suppress error output starting with "WARNING in".

* fix: remaining enums that weren't properly exported (#6251)

* fix: remaining enums that weren't properly exported

* chore: format

* fix: add enum value exports

* chore: format

* fix: properly export interfaces that were typedefs (#6250)

* fix: properly export interfaces that were typedefs

* fix: allowCollsion -> allowCollision

* fix: convert unconverted enums

* fix: enums that were/are instance properties

* fix: revert changes to property enums

* fix: renamed protected parameter properties (#6252)

* fix: bad protected parameter properties

* chore:format

* fix: gesture constructor

* fix: overridden properties that were renamed

* refactor: Migrate `blockly.js` to TypeScript (#6261)

* chore: Apply changes to blockly.js to blockly.ts

* fix: Build using core/blockly.ts instead of .js

  Compiles and runs in compressed mode correctly!

* fix(build): Don't depend on execSync running bash (#6262)

For some reason on Github CI servers execSync uses /bin/sh, which
is (on Ubuntu) dash rather than bash, and does not understand
the pipefail option.

So remove the grep pipe on stderr and just discard all error output
at all.

This is not ideal as errors in test deps will go unreported AND
not even cause test failure, but it's not clear that it's worth
investing more time to fix this at the moment.

* chore: use `import type` where possible (#6279)

* chore: automatically change imports to import types

* chore: revert changes that actually need to be imports

* chore: format

* chore: add more import type statements based on importsNotUsedAsValues

* chore: fix tsconfig

* chore: add link to compiler issue

* fix: add type information to blockly options (#6283)

* fix: add type information to blockly options

* chore: format

* chore: remove erroneous comment

* fix: bugs revealed by getting the built output working (#6282)

* fix: types of compose and decompose in block

* fix: workspace naming in toolbox

* chore: add jsdoc

* chore: restore registry comments to better positions

* chore: pr comments'

* fix(variables): Revert inadvertent change to allDeveloperVariables (#6290)

It appears that a function call got modified incorrectly (probably
in an effort to fix a typing issue).  This fix trivially reverts
the line in question to match the original JS version from develop.

This causes the generator tests to pass.

* fix: circular dependencies (#6281)

* chore: fix circular dependencies w/ static workspace funcs

* remove preserved imports that aren't currently necessary (probably)

* fix circular dependency with workspaces and block using stub

* fix dependency between variables and xml by moving function to utils

* add stub for trashcan as well

* fix line endings from rebase

* fix goog/base order

* add trashcan patch

* fix: types of compose and decompose in block

* fix: workspace naming in toolbox

* chore: add jsdoc

* chore: restore registry comments to better positions

* chore: remove implementations in goog.js

* chore: fix types of stubs

* chore: remove added AnyDuringMigration casts

* chore: remove modifications to xml and variables

* chore: format

* chore: remove event requirements in workspace comments

* chore: fix circular dependency with xml and workspace comments

* fixup remove ContextMenu import

* chore: fix dependency between mutator and workspace

* chore: break circular dependency between names and procedures

* chore: get tests to run?

* chore: pr comments'

* chore: fix stubbing field registry fromJson

* chore: fix spying on fire

* chore: fix stubbing parts of connection checker

* chore: fix stubbing dialog

* chore: fix stubbing style

* chore: fix spying on duplicate

* chore: fix stubbing variables

* chore: fix stubbing copy

* chore: fix stubbing in workspace

* chore: remove unnecessary stubs

* chore: fix formatting

* chore: fix other formatting

* chore: add backwards compatible static properties to workspace

* chore: move static type properties

* chore: move and comment stubs

* chore: add newlines at EOF

* chore: improve errors for monkey patched functions

* chore: update comment with a pointer to the doc

* chore: update comment with a pointer to the doc

* chore: format

* chore: revert changes to playground used for testing (#6292)

* chore: get mocha tests to pass. (#6291)

* chore: fix undo and empty code blocks

* chore: skip IE test

* chore: fix gesture test

* chore: fix replace message references test

* chore: fix string table interpolation

* chore: skip getById tests

* chore: fix field tests

* chore: fix console errors by making workspace nullable

* chore: format

* chore: fix definition overwrite warning

* chore: update metadata

* chore: temporarily modify the the advanced compile test

* chore: fix gestures by fixing test instead

Co-authored-by: Neil Fraser <fraser@google.com>
Co-authored-by: Christopher Allen <cpcallen+git@google.com>

core/utils/svg_math.ts

@@ -7,22 +7,22 @@
 /**
  * @fileoverview Utility methods for SVG math.
  */
-'use strict';
 
 /**
  * Utility methods realted to figuring out positions of SVG elements.
  * @namespace Blockly.utils.svgMath
  */
-goog.module('Blockly.utils.svgMath');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.svgMath');
 
-const deprecation = goog.require('Blockly.utils.deprecation');
-const style = goog.require('Blockly.utils.style');
-const userAgent = goog.require('Blockly.utils.userAgent');
-const {Coordinate} = goog.require('Blockly.utils.Coordinate');
-const {Rect} = goog.require('Blockly.utils.Rect');
-const {Size} = goog.require('Blockly.utils.Size');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
+import type {WorkspaceSvg} from '../workspace_svg.js';
+
+import {Coordinate} from './coordinate.js';
+import * as deprecation from './deprecation.js';
+import {Rect} from './rect.js';
+import {Size} from './size.js';
+import * as style from './style.js';
+import * as userAgent from './useragent.js';
 
 
 /**
@@ -31,35 +31,32 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
  * 'translate(12, 0)'.
  * Note that IE (9,10) returns 'translate(16 8)' instead of 'translate(16, 8)'.
  * Note that IE has been reported to return scientific notation (0.123456e-42).
- * @type {!RegExp}
  */
-const XY_REGEX = /translate\(\s*([-+\d.e]+)([ ,]\s*([-+\d.e]+)\s*)?/;
+const XY_REGEX: RegExp = /translate\(\s*([-+\d.e]+)([ ,]\s*([-+\d.e]+)\s*)?/;
 
 /**
  * Static regex to pull the x,y values out of a translate() or translate3d()
  * style property.
  * Accounts for same exceptions as XY_REGEX.
- * @type {!RegExp}
  */
-const XY_STYLE_REGEX =
+const XY_STYLE_REGEX: RegExp =
     /transform:\s*translate(?:3d)?\(\s*([-+\d.e]+)\s*px([ ,]\s*([-+\d.e]+)\s*px)?/;
 
-
 /**
  * Return the coordinates of the top-left corner of this element relative to
  * its parent.  Only for SVG elements and children (e.g. rect, g, path).
- * @param {!Element} element SVG element to find the coordinates of.
- * @return {!Coordinate} Object with .x and .y properties.
+ * @param element SVG element to find the coordinates of.
+ * @return Object with .x and .y properties.
  * @alias Blockly.utils.svgMath.getRelativeXY
  */
-const getRelativeXY = function(element) {
+export function getRelativeXY(element: Element): Coordinate {
   const xy = new Coordinate(0, 0);
   // First, check for x and y attributes.
   // Checking for the existence of x/y properties is faster than getAttribute.
   // However, x/y contains an SVGAnimatedLength object, so rely on getAttribute
   // to get the number.
-  const x = element.x && element.getAttribute('x');
-  const y = element.y && element.getAttribute('y');
+  const x = (element as any).x && element.getAttribute('x');
+  const y = (element as any).y && element.getAttribute('y');
   if (x) {
     xy.x = parseInt(x, 10);
   }
@@ -88,19 +85,17 @@ const getRelativeXY = function(element) {
     }
   }
   return xy;
-};
-exports.getRelativeXY = getRelativeXY;
+}
 
 /**
  * Return the coordinates of the top-left corner of this element relative to
  * the div Blockly was injected into.
- * @param {!Element} element SVG element to find the coordinates of. If this is
- *     not a child of the div Blockly was injected into, the behaviour is
- *     undefined.
- * @return {!Coordinate} Object with .x and .y properties.
+ * @param element SVG element to find the coordinates of. If this is not a child
+ *     of the div Blockly was injected into, the behaviour is undefined.
+ * @return Object with .x and .y properties.
  * @alias Blockly.utils.svgMath.getInjectionDivXY
  */
-const getInjectionDivXY = function(element) {
+export function getInjectionDivXY(element: Element): Coordinate {
   let x = 0;
   let y = 0;
   while (element) {
@@ -111,21 +106,24 @@ const getInjectionDivXY = function(element) {
     if ((' ' + classes + ' ').indexOf(' injectionDiv ') !== -1) {
       break;
     }
-    element = /** @type {!Element} */ (element.parentNode);
+    element = element.parentNode as Element;
   }
   return new Coordinate(x, y);
-};
-exports.getInjectionDivXY = getInjectionDivXY;
+}
 
 /**
  * Check if 3D transforms are supported by adding an element
  * and attempting to set the property.
- * @return {boolean} True if 3D transforms are supported.
+ * @return True if 3D transforms are supported.
  * @alias Blockly.utils.svgMath.is3dSupported
  */
-const is3dSupported = function() {
-  if (is3dSupported.cached_ !== undefined) {
-    return is3dSupported.cached_;
+export function is3dSupported(): boolean {
+  // AnyDuringMigration because:  Property 'cached_' does not exist on type '()
+  // => boolean'.
+  if ((is3dSupported as AnyDuringMigration).cached_ !== undefined) {
+    // AnyDuringMigration because:  Property 'cached_' does not exist on type
+    // '() => boolean'.
+    return (is3dSupported as AnyDuringMigration).cached_;
   }
   // CC-BY-SA Lorenzo Polidori
   // stackoverflow.com/questions/5661671/detecting-transform-translate3d-support
@@ -147,8 +145,8 @@ const is3dSupported = function() {
   document.body.insertBefore(el, null);
 
   for (const t in transforms) {
-    if (el.style[t] !== undefined) {
-      el.style[t] = 'translate3d(1px,1px,1px)';
+    if ((el.style as AnyDuringMigration)[t] !== undefined) {
+      (el.style as AnyDuringMigration)[t] = 'translate3d(1px,1px,1px)';
       const computedStyle = globalThis['getComputedStyle'](el);
       if (!computedStyle) {
         // getComputedStyle in Firefox returns null when Blockly is loaded
@@ -160,39 +158,42 @@ const is3dSupported = function() {
         document.body.removeChild(el);
         return false;
       }
-      has3d = computedStyle.getPropertyValue(transforms[t]);
+      has3d =
+          computedStyle.getPropertyValue((transforms as AnyDuringMigration)[t]);
     }
   }
   document.body.removeChild(el);
-  is3dSupported.cached_ = has3d !== 'none';
-  return is3dSupported.cached_;
-};
-exports.is3dSupported = is3dSupported;
+  // AnyDuringMigration because:  Property 'cached_' does not exist on type '()
+  // => boolean'.
+  (is3dSupported as AnyDuringMigration).cached_ = has3d !== 'none';
+  // AnyDuringMigration because:  Property 'cached_' does not exist on type '()
+  // => boolean'.
+  return (is3dSupported as AnyDuringMigration).cached_;
+}
 
 /**
  * Get the position of the current viewport in window coordinates.  This takes
  * scroll into account.
- * @return {!Rect} An object containing window width, height, and
- *     scroll position in window coordinates.
+ * @return An object containing window width, height, and scroll position in
+ *     window coordinates.
  * @alias Blockly.utils.svgMath.getViewportBBox
- * @package
+ * @internal
  */
-const getViewportBBox = function() {
+export function getViewportBBox(): Rect {
   // Pixels, in window coordinates.
   const scrollOffset = style.getViewportPageOffset();
   return new Rect(
       scrollOffset.y, document.documentElement.clientHeight + scrollOffset.y,
       scrollOffset.x, document.documentElement.clientWidth + scrollOffset.x);
-};
-exports.getViewportBBox = getViewportBBox;
+}
 
 /**
  * Gets the document scroll distance as a coordinate object.
  * Copied from Closure's goog.dom.getDocumentScroll.
- * @return {!Coordinate} Object with values 'x' and 'y'.
+ * @return Object with values 'x' and 'y'.
  * @alias Blockly.utils.svgMath.getDocumentScroll
  */
-const getDocumentScroll = function() {
+export function getDocumentScroll(): Coordinate {
   const el = document.documentElement;
   const win = window;
   if (userAgent.IE && win.pageYOffset !== el.scrollTop) {
@@ -203,18 +204,18 @@ const getDocumentScroll = function() {
   }
   return new Coordinate(
       win.pageXOffset || el.scrollLeft, win.pageYOffset || el.scrollTop);
-};
-exports.getDocumentScroll = getDocumentScroll;
+}
 
 /**
  * Converts screen coordinates to workspace coordinates.
- * @param {!WorkspaceSvg} ws The workspace to find the coordinates on.
- * @param {!Coordinate} screenCoordinates The screen coordinates to
- * be converted to workspace coordinates
- * @return {!Coordinate} The workspace coordinates.
+ * @param ws The workspace to find the coordinates on.
+ * @param screenCoordinates The screen coordinates to be converted to workspace
+ *     coordinates
+ * @return The workspace coordinates.
  * @alias Blockly.utils.svgMath.screenToWsCoordinates
  */
-const screenToWsCoordinates = function(ws, screenCoordinates) {
+export function screenToWsCoordinates(
+    ws: WorkspaceSvg, screenCoordinates: Coordinate): Coordinate {
   const screenX = screenCoordinates.x;
   const screenY = screenCoordinates.y;
 
@@ -236,21 +237,19 @@ const screenToWsCoordinates = function(ws, screenCoordinates) {
   // main workspace.
   const finalOffsetPixels =
       Coordinate.difference(clientOffsetPixels, mainOffsetPixels);
-
   // The position in main workspace coordinates.
   const finalOffsetMainWs = finalOffsetPixels.scale(1 / ws.scale);
   return finalOffsetMainWs;
-};
-exports.screenToWsCoordinates = screenToWsCoordinates;
+}
 
 /**
  * Returns the dimensions of the specified SVG image.
- * @param {!SVGElement} svg SVG image.
- * @return {!Size} Contains width and height properties.
+ * @param svg SVG image.
+ * @return Contains width and height properties.
  * @deprecated Use workspace.getCachedParentSvgSize. (2021 March 5)
  * @alias Blockly.utils.svgMath.svgSize
  */
-const svgSize = function(svg) {
+export function svgSize(svg: SVGElement): Size {
   // When removing this function, remove svg.cachedWidth_ and svg.cachedHeight_
   // from setCachedParentSvgSize.
   // The deprecated name is `Blockly.svgSize` because this function used to be
@@ -258,15 +257,13 @@ const svgSize = function(svg) {
   deprecation.warn(
       'Blockly.svgSize', 'March 2021', 'March 2022',
       'workspace.getCachedParentSvgSize');
-  svg = /** @type {?} */ (svg);
+  svg = svg as AnyDuringMigration;
   return new Size(
       Number(svg.getAttribute('data-cached-width')),
       Number(svg.getAttribute('data-cached-height')));
-};
-exports.svgSize = svgSize;
+}
 
-
-exports.TEST_ONLY = {
+export const TEST_ONLY = {
   XY_REGEX,
   XY_STYLE_REGEX,
 };