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/component_manager.ts

@@ -8,59 +8,70 @@
  * @fileoverview Manager for all items registered with the workspace.
  */
 
-'use strict';
-
 /**
  * Manager for all items registered with the workspace.
  * @class
  */
-goog.module('Blockly.ComponentManager');
+import * as goog from '../closure/goog/goog.js';
+goog.declareModuleId('Blockly.ComponentManager');
 
-const arrayUtils = goog.require('Blockly.utils.array');
-/* eslint-disable-next-line no-unused-vars */
-const {IAutoHideable} = goog.requireType('Blockly.IAutoHideable');
-/* eslint-disable-next-line no-unused-vars */
-const {IComponent} = goog.requireType('Blockly.IComponent');
-/* eslint-disable-next-line no-unused-vars */
-const {IDeleteArea} = goog.requireType('Blockly.IDeleteArea');
-/* eslint-disable-next-line no-unused-vars */
-const {IDragTarget} = goog.requireType('Blockly.IDragTarget');
-/* eslint-disable-next-line no-unused-vars */
-const {IPositionable} = goog.requireType('Blockly.IPositionable');
+import type {IAutoHideable} from './interfaces/i_autohideable.js';
+import type {IComponent} from './interfaces/i_component.js';
+import type {IDeleteArea} from './interfaces/i_delete_area.js';
+import type {IDragTarget} from './interfaces/i_drag_target.js';
+import type {IPositionable} from './interfaces/i_positionable.js';
+import * as arrayUtils from './utils/array.js';
 
 
+class Capability<T> {
+  static POSITIONABLE = new Capability<IPositionable>('positionable');
+  static DRAG_TARGET = new Capability<IDragTarget>('drag_target');
+  static DELETE_AREA = new Capability<IDeleteArea>('delete_area');
+  static AUTOHIDEABLE = new Capability<IAutoHideable>('autohideable');
+  private readonly name_: string;
+  /** @param name The name of the component capability. */
+  constructor(name: string) {
+    this.name_ = name;
+  }
+
+  /**
+   * Returns the name of the capability.
+   * @return The name.
+   */
+  toString(): string {
+    return this.name_;
+  }
+}
+
 /**
  * Manager for all items registered with the workspace.
  * @alias Blockly.ComponentManager
  */
-class ComponentManager {
-  /**
-   * Creates a new ComponentManager instance.
-   */
+export class ComponentManager {
+  static Capability = Capability;
+
+  // static Capability: AnyDuringMigration;
+  private readonly componentData_: {[key: string]: ComponentDatum};
+  private readonly capabilityToComponentIds_: {[key: string]: string[]};
+
+  /** Creates a new ComponentManager instance. */
   constructor() {
     /**
      * A map of the components registered with the workspace, mapped to id.
-     * @type {!Object<string, !ComponentManager.ComponentDatum>}
-     * @private
      */
     this.componentData_ = Object.create(null);
 
-    /**
-     * A map of capabilities to component IDs.
-     * @type {!Object<string, !Array<string>>}
-     * @private
-     */
+    /** A map of capabilities to component IDs. */
     this.capabilityToComponentIds_ = Object.create(null);
   }
 
   /**
    * Adds a component.
-   * @param {!ComponentManager.ComponentDatum} componentInfo The data for
-   *   the component to register.
-   * @param {boolean=} opt_allowOverrides True to prevent an error when
-   *     overriding an already registered item.
+   * @param componentInfo The data for the component to register.
+   * @param opt_allowOverrides True to prevent an error when overriding an
+   *     already registered item.
    */
-  addComponent(componentInfo, opt_allowOverrides) {
+  addComponent(componentInfo: ComponentDatum, opt_allowOverrides?: boolean) {
     // Don't throw an error if opt_allowOverrides is true.
     const id = componentInfo.component.id;
     if (!opt_allowOverrides && this.componentData_[id]) {
@@ -84,9 +95,9 @@ class ComponentManager {
 
   /**
    * Removes a component.
-   * @param {string} id The ID of the component to remove.
+   * @param id The ID of the component to remove.
    */
-  removeComponent(id) {
+  removeComponent(id: string) {
     const componentInfo = this.componentData_[id];
     if (!componentInfo) {
       return;
@@ -100,12 +111,10 @@ class ComponentManager {
 
   /**
    * Adds a capability to a existing registered component.
-   * @param {string} id The ID of the component to add the capability to.
-   * @param {string|!ComponentManager.Capability<T>} capability The
-   *     capability to add.
-   * @template T
+   * @param id The ID of the component to add the capability to.
+   * @param capability The capability to add.
    */
-  addCapability(id, capability) {
+  addCapability<T>(id: string, capability: string|Capability<T>) {
     if (!this.getComponent(id)) {
       throw Error(
           'Cannot add capability, "' + capability + '". Plugin "' + id +
@@ -123,12 +132,10 @@ class ComponentManager {
 
   /**
    * Removes a capability from an existing registered component.
-   * @param {string} id The ID of the component to remove the capability from.
-   * @param {string|!ComponentManager.Capability<T>} capability The
-   *     capability to remove.
-   * @template T
+   * @param id The ID of the component to remove the capability from.
+   * @param capability The capability to remove.
    */
-  removeCapability(id, capability) {
+  removeCapability<T>(id: string, capability: string|Capability<T>) {
     if (!this.getComponent(id)) {
       throw Error(
           'Cannot remove capability, "' + capability + '". Plugin "' + id +
@@ -147,44 +154,39 @@ class ComponentManager {
 
   /**
    * Returns whether the component with this id has the specified capability.
-   * @param {string} id The ID of the component to check.
-   * @param {string|!ComponentManager.Capability<T>} capability The
-   *     capability to check for.
-   * @return {boolean} Whether the component has the capability.
-   * @template T
+   * @param id The ID of the component to check.
+   * @param capability The capability to check for.
+   * @return Whether the component has the capability.
    */
-  hasCapability(id, capability) {
+  hasCapability<T>(id: string, capability: string|Capability<T>): boolean {
     capability = String(capability).toLowerCase();
     return this.componentData_[id].capabilities.indexOf(capability) !== -1;
   }
 
   /**
    * Gets the component with the given ID.
-   * @param {string} id The ID of the component to get.
-   * @return {!IComponent|undefined} The component with the given name
-   *    or undefined if not found.
+   * @param id The ID of the component to get.
+   * @return The component with the given name or undefined if not found.
    */
-  getComponent(id) {
+  getComponent(id: string): IComponent|undefined {
     return this.componentData_[id] && this.componentData_[id].component;
   }
 
   /**
    * Gets all the components with the specified capability.
-   * @param {string|!ComponentManager.Capability<T>
-   *   } capability The capability of the component.
-   * @param {boolean} sorted Whether to return list ordered by weights.
-   * @return {!Array<T>} The components that match the specified capability.
-   * @template T
+   * @param capability The capability of the component.
+   * @param sorted Whether to return list ordered by weights.
+   * @return The components that match the specified capability.
    */
-  getComponents(capability, sorted) {
+  getComponents<T>(capability: string|Capability<T>, sorted: boolean): T[] {
     capability = String(capability).toLowerCase();
     const componentIds = this.capabilityToComponentIds_[capability];
     if (!componentIds) {
       return [];
     }
-    const components = [];
+    const components: AnyDuringMigration[] = [];
     if (sorted) {
-      const componentDataList = [];
+      const componentDataList: AnyDuringMigration[] = [];
       const componentData = this.componentData_;
       componentIds.forEach(function(id) {
         componentDataList.push(componentData[id]);
@@ -205,59 +207,13 @@ class ComponentManager {
   }
 }
 
-/**
- * An object storing component information.
- * @typedef {{
- *    component: !IComponent,
- *    capabilities: (
- *     !Array<string|!ComponentManager.Capability<!IComponent>>
- *       ),
- *    weight: number
- *  }}
- */
-ComponentManager.ComponentDatum;
-
-/**
- * A name with the capability of the element stored in the generic.
- * @template T
- * @alias Blockly.ComponentManager.Capability
- */
-ComponentManager.Capability = class {
-  /**
-   * @param {string} name The name of the component capability.
-   */
-  constructor(name) {
-    /**
-     * @type {string}
-     * @private
-     */
-    this.name_ = name;
+export namespace ComponentManager {
+  /** An object storing component information. */
+  export interface ComponentDatum {
+    component: IComponent;
+    capabilities: Array<string|Capability<IComponent>>;
+    weight: number;
   }
+}
 
-  /**
-   * Returns the name of the capability.
-   * @return {string} The name.
-   * @override
-   */
-  toString() {
-    return this.name_;
-  }
-};
-
-/** @type {!ComponentManager.Capability<!IPositionable>} */
-ComponentManager.Capability.POSITIONABLE =
-    new ComponentManager.Capability('positionable');
-
-/** @type {!ComponentManager.Capability<!IDragTarget>} */
-ComponentManager.Capability.DRAG_TARGET =
-    new ComponentManager.Capability('drag_target');
-
-/** @type {!ComponentManager.Capability<!IDeleteArea>} */
-ComponentManager.Capability.DELETE_AREA =
-    new ComponentManager.Capability('delete_area');
-
-/** @type {!ComponentManager.Capability<!IAutoHideable>} */
-ComponentManager.Capability.AUTOHIDEABLE =
-    new ComponentManager.Capability('autohideable');
-
-exports.ComponentManager = ComponentManager;
+export type ComponentDatum = ComponentManager.ComponentDatum;