scratch-blocks 2.0.0-spork.1 → 2.0.0-spork.3

package/src/blocks/{data.js → data.ts}

@@ -19,17 +19,17 @@
  */
 
 import * as Blockly from "blockly/core";
-import { Categories } from "../categories.js";
-import * as Constants from "../constants.js";
-import * as scratchBlocksUtils from "../scratch_blocks_utils.js";
-import { renameVariable } from "../variables.js";
+import * as Constants from "../constants";
+import * as scratchBlocksUtils from "../scratch_blocks_utils";
+import { renameVariable } from "../variables";
+import type { ScratchFieldVariable } from "../fields/scratch_field_variable";
+import type { ScratchVariableModel } from "../scratch_variable_model";
 
 Blockly.Blocks["data_variable"] = {
   /**
    * Block of Variables
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: "%1",
       lastDummyAlign0: "CENTRE",
@@ -40,7 +40,6 @@ Blockly.Blocks["data_variable"] = {
           allowedVariableType: Constants.SCALAR_VARIABLE_TYPE,
         },
       ],
-      category: Categories.data,
       extensions: [
         "contextMenu_getVariableBlock",
         "colours_data",
@@ -54,9 +53,8 @@ Blockly.Blocks["data_variable"] = {
 Blockly.Blocks["data_setvariableto"] = {
   /**
    * Block to set variable to a certain value
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_SETVARIABLETO,
       args0: [
@@ -71,7 +69,6 @@ Blockly.Blocks["data_setvariableto"] = {
           name: "VALUE",
         },
       ],
-      category: Categories.data,
       extensions: ["colours_data", "shape_statement"],
     });
   },
@@ -80,9 +77,8 @@ Blockly.Blocks["data_setvariableto"] = {
 Blockly.Blocks["data_changevariableby"] = {
   /**
    * Block to change variable by a certain value
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_CHANGEVARIABLEBY,
       args0: [
@@ -97,7 +93,6 @@ Blockly.Blocks["data_changevariableby"] = {
           name: "VALUE",
         },
       ],
-      category: Categories.data,
       extensions: ["colours_data", "shape_statement"],
     });
   },
@@ -106,9 +101,8 @@ Blockly.Blocks["data_changevariableby"] = {
 Blockly.Blocks["data_showvariable"] = {
   /**
    * Block to show a variable
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_SHOWVARIABLE,
       args0: [
@@ -121,7 +115,6 @@ Blockly.Blocks["data_showvariable"] = {
       ],
       previousStatement: null,
       nextStatement: null,
-      category: Categories.data,
       extensions: ["colours_data"],
     });
   },
@@ -130,9 +123,8 @@ Blockly.Blocks["data_showvariable"] = {
 Blockly.Blocks["data_hidevariable"] = {
   /**
    * Block to hide a variable
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_HIDEVARIABLE,
       args0: [
@@ -145,7 +137,6 @@ Blockly.Blocks["data_hidevariable"] = {
       ],
       previousStatement: null,
       nextStatement: null,
-      category: Categories.data,
       extensions: ["colours_data"],
     });
   },
@@ -154,9 +145,8 @@ Blockly.Blocks["data_hidevariable"] = {
 Blockly.Blocks["data_listcontents"] = {
   /**
    * List reporter.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: "%1",
       args0: [
@@ -166,7 +156,6 @@ Blockly.Blocks["data_listcontents"] = {
           allowedVariableType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: [
         "contextMenu_getListBlock",
         "colours_data_lists",
@@ -180,9 +169,8 @@ Blockly.Blocks["data_listcontents"] = {
 Blockly.Blocks["data_listindexall"] = {
   /**
    * List index menu, with all option.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: "%1",
       args0: [
@@ -199,7 +187,6 @@ Blockly.Blocks["data_listindexall"] = {
           ],
         },
       ],
-      category: Categories.data,
       extensions: ["colours_textfield", "output_string"],
     });
   },
@@ -208,9 +195,8 @@ Blockly.Blocks["data_listindexall"] = {
 Blockly.Blocks["data_listindexrandom"] = {
   /**
    * List index menu, with random option.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: "%1",
       args0: [
@@ -227,7 +213,6 @@ Blockly.Blocks["data_listindexrandom"] = {
           ],
         },
       ],
-      category: Categories.data,
       extensions: ["colours_textfield", "output_string"],
     });
   },
@@ -236,9 +221,8 @@ Blockly.Blocks["data_listindexrandom"] = {
 Blockly.Blocks["data_addtolist"] = {
   /**
    * Block to add item to list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_ADDTOLIST,
       args0: [
@@ -253,7 +237,6 @@ Blockly.Blocks["data_addtolist"] = {
           defaultType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "shape_statement"],
     });
   },
@@ -262,9 +245,8 @@ Blockly.Blocks["data_addtolist"] = {
 Blockly.Blocks["data_deleteoflist"] = {
   /**
    * Block to delete item from list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_DELETEOFLIST,
       args0: [
@@ -279,7 +261,6 @@ Blockly.Blocks["data_deleteoflist"] = {
           defaultType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "shape_statement"],
     });
   },
@@ -288,9 +269,8 @@ Blockly.Blocks["data_deleteoflist"] = {
 Blockly.Blocks["data_deletealloflist"] = {
   /**
    * Block to delete all items from list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_DELETEALLOFLIST,
       args0: [
@@ -301,7 +281,6 @@ Blockly.Blocks["data_deletealloflist"] = {
           defaultType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "shape_statement"],
     });
   },
@@ -310,9 +289,8 @@ Blockly.Blocks["data_deletealloflist"] = {
 Blockly.Blocks["data_insertatlist"] = {
   /**
    * Block to insert item to list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_INSERTATLIST,
       args0: [
@@ -331,7 +309,6 @@ Blockly.Blocks["data_insertatlist"] = {
           defaultType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "shape_statement"],
     });
   },
@@ -340,9 +317,8 @@ Blockly.Blocks["data_insertatlist"] = {
 Blockly.Blocks["data_replaceitemoflist"] = {
   /**
    * Block to insert item to list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_REPLACEITEMOFLIST,
       args0: [
@@ -361,7 +337,6 @@ Blockly.Blocks["data_replaceitemoflist"] = {
           name: "ITEM",
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "shape_statement"],
     });
   },
@@ -370,9 +345,8 @@ Blockly.Blocks["data_replaceitemoflist"] = {
 Blockly.Blocks["data_itemoflist"] = {
   /**
    * Block for reporting item of list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_ITEMOFLIST,
       args0: [
@@ -388,7 +362,6 @@ Blockly.Blocks["data_itemoflist"] = {
         },
       ],
       output: null,
-      category: Categories.dataLists,
       extensions: ["colours_data_lists"],
       outputShape: Constants.OUTPUT_SHAPE_ROUND,
     });
@@ -398,9 +371,8 @@ Blockly.Blocks["data_itemoflist"] = {
 Blockly.Blocks["data_itemnumoflist"] = {
   /**
    * Block for reporting the item # of a string in a list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_ITEMNUMOFLIST,
       args0: [
@@ -416,7 +388,6 @@ Blockly.Blocks["data_itemnumoflist"] = {
         },
       ],
       output: null,
-      category: Categories.dataLists,
       extensions: ["colours_data_lists"],
       outputShape: Constants.OUTPUT_SHAPE_ROUND,
     });
@@ -426,9 +397,8 @@ Blockly.Blocks["data_itemnumoflist"] = {
 Blockly.Blocks["data_lengthoflist"] = {
   /**
    * Block for reporting length of list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_LENGTHOFLIST,
       args0: [
@@ -439,7 +409,6 @@ Blockly.Blocks["data_lengthoflist"] = {
           defaultType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "output_number"],
     });
   },
@@ -448,9 +417,8 @@ Blockly.Blocks["data_lengthoflist"] = {
 Blockly.Blocks["data_listcontainsitem"] = {
   /**
    * Block to report whether list contains item.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_LISTCONTAINSITEM,
       args0: [
@@ -465,7 +433,6 @@ Blockly.Blocks["data_listcontainsitem"] = {
           name: "ITEM",
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "output_boolean"],
     });
   },
@@ -474,9 +441,8 @@ Blockly.Blocks["data_listcontainsitem"] = {
 Blockly.Blocks["data_showlist"] = {
   /**
    * Block to show a list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_SHOWLIST,
       args0: [
@@ -487,7 +453,6 @@ Blockly.Blocks["data_showlist"] = {
           defaultType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "shape_statement"],
     });
   },
@@ -496,9 +461,8 @@ Blockly.Blocks["data_showlist"] = {
 Blockly.Blocks["data_hidelist"] = {
   /**
    * Block to hide a list.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.DATA_HIDELIST,
       args0: [
@@ -509,7 +473,6 @@ Blockly.Blocks["data_hidelist"] = {
           defaultType: Constants.LIST_VARIABLE_TYPE,
         },
       ],
-      category: Categories.dataLists,
       extensions: ["colours_data_lists", "shape_statement"],
     });
   },
@@ -518,51 +481,57 @@ Blockly.Blocks["data_hidelist"] = {
 /**
  * Mixin to add a context menu for a data_variable block.  It adds one item for
  * each variable defined on the workspace.
- * @mixin
- * @augments Blockly.Block
- * @package
- * @readonly
  */
 const CUSTOM_CONTEXT_MENU_GET_VARIABLE_MIXIN = {
   /**
    * Add context menu option to change the selected variable.
-   * @param {!Array} options List of menu options to add to.
-   * @this Blockly.Block
+   *
+   * @param options List of menu options to add to.
    */
-  customContextMenu: function (options) {
-    var fieldName = "VARIABLE";
+  customContextMenu: function (
+    this: Blockly.Block,
+    options: Array<
+      | Blockly.ContextMenuRegistry.ContextMenuOption
+      | Blockly.ContextMenuRegistry.LegacyContextMenuOption
+    >
+  ) {
+    const fieldName = "VARIABLE";
     if (this.isCollapsed()) {
       return;
     }
-    var currentVarName = this.getField(fieldName).getVariable().getName();
+    const currentVarName = (this.getField(fieldName) as ScratchFieldVariable)
+      .getVariable()
+      .getName();
     if (!this.isInFlyout) {
-      var variablesList = this.workspace.getVariablesOfType(
-        Constants.SCALAR_VARIABLE_TYPE
-      );
-      variablesList.sort(function (a, b) {
-        return scratchBlocksUtils.compareStrings(a.getName(), b.getName());
-      });
-      for (var i = 0; i < variablesList.length; i++) {
-        var varName = variablesList[i].getName();
-        if (varName == currentVarName) continue;
+      this.workspace
+        .getVariablesOfType(Constants.SCALAR_VARIABLE_TYPE)
+        .sort(function (
+          a: Blockly.IVariableModel<Blockly.IVariableState>,
+          b: Blockly.IVariableModel<Blockly.IVariableState>
+        ) {
+          return scratchBlocksUtils.compareStrings(a.getName(), b.getName());
+        })
+        .forEach((variable: Blockly.IVariableModel<Blockly.IVariableState>) => {
+          const varName = variable.getName();
+          if (varName === currentVarName) return;
 
-        var option = { enabled: true };
-        option.text = varName;
-
-        option.callback = VARIABLE_OPTION_CALLBACK_FACTORY(
-          this,
-          variablesList[i].getId(),
-          fieldName
-        );
-        options.push(option);
-      }
+          options.push({
+            enabled: true,
+            text: varName,
+            callback: VARIABLE_OPTION_CALLBACK_FACTORY(
+              this,
+              variable.getId(),
+              fieldName
+            ),
+          });
+        });
     } else {
-      var renameOption = {
+      const renameOption = {
         text: Blockly.Msg.RENAME_VARIABLE,
         enabled: true,
         callback: RENAME_OPTION_CALLBACK_FACTORY(this, fieldName),
       };
-      var deleteOption = {
+      const deleteOption = {
         text: Blockly.Msg.DELETE_VARIABLE.replace("%1", currentVarName),
         enabled: true,
         callback: DELETE_OPTION_CALLBACK_FACTORY(this, fieldName),
@@ -581,51 +550,57 @@ Blockly.Extensions.registerMixin(
 /**
  * Mixin to add a context menu for a data_listcontents block.  It adds one item for
  * each list defined on the workspace.
- * @mixin
- * @augments Blockly.Block
- * @package
- * @readonly
  */
 const CUSTOM_CONTEXT_MENU_GET_LIST_MIXIN = {
   /**
    * Add context menu option to change the selected list.
-   * @param {!Array} options List of menu options to add to.
-   * @this Blockly.Block
+   *
+   * @param options List of menu options to add to.
    */
-  customContextMenu: function (options) {
-    var fieldName = "LIST";
+  customContextMenu: function (
+    this: Blockly.Block,
+    options: Array<
+      | Blockly.ContextMenuRegistry.ContextMenuOption
+      | Blockly.ContextMenuRegistry.LegacyContextMenuOption
+    >
+  ) {
+    const fieldName = "LIST";
     if (this.isCollapsed()) {
       return;
     }
-    var currentVarName = this.getField(fieldName).getVariable().getName();
+    const currentVarName = (this.getField(fieldName) as ScratchFieldVariable)
+      .getVariable()
+      .getName();
     if (!this.isInFlyout) {
-      var variablesList = this.workspace.getVariablesOfType(
-        Constants.LIST_VARIABLE_TYPE
-      );
-      variablesList.sort(function (a, b) {
-        return scratchBlocksUtils.compareStrings(a.getName(), b.getName());
-      });
-      for (var i = 0; i < variablesList.length; i++) {
-        var varName = variablesList[i].getName();
-        if (varName == currentVarName) continue;
-
-        var option = { enabled: true };
-        option.text = varName;
+      this.workspace
+        .getVariablesOfType(Constants.LIST_VARIABLE_TYPE)
+        .sort(function (
+          a: Blockly.IVariableModel<Blockly.IVariableState>,
+          b: Blockly.IVariableModel<Blockly.IVariableState>
+        ) {
+          return scratchBlocksUtils.compareStrings(a.getName(), b.getName());
+        })
+        .forEach((variable: Blockly.IVariableModel<Blockly.IVariableState>) => {
+          const varName = variable.getName();
+          if (varName === currentVarName) return;
 
-        option.callback = VARIABLE_OPTION_CALLBACK_FACTORY(
-          this,
-          variablesList[i].getId(),
-          fieldName
-        );
-        options.push(option);
-      }
+          options.push({
+            enabled: true,
+            text: varName,
+            callback: VARIABLE_OPTION_CALLBACK_FACTORY(
+              this,
+              variable.getId(),
+              fieldName
+            ),
+          });
+        });
     } else {
-      var renameOption = {
+      const renameOption = {
         text: Blockly.Msg.RENAME_LIST,
         enabled: true,
         callback: RENAME_OPTION_CALLBACK_FACTORY(this, fieldName),
       };
-      var deleteOption = {
+      const deleteOption = {
         text: Blockly.Msg.DELETE_LIST.replace("%1", currentVarName),
         enabled: true,
         callback: DELETE_OPTION_CALLBACK_FACTORY(this, fieldName),
@@ -645,14 +620,19 @@ Blockly.Extensions.registerMixin(
  * block.  Each variable on the workspace gets its own item in the dropdown
  * menu, and clicking on that item changes the text of the field on the source
  * block.
- * @param {!Blockly.Block} block The block to update.
- * @param {string} id The id of the variable to set on this block.
- * @param {string} fieldName The name of the field to update on the block.
- * @return {!function()} A function that updates the block with the new name.
+ *
+ * @param block The block to update.
+ * @param id The id of the variable to set on this block.
+ * @param fieldName The name of the field to update on the block.
+ * @returns A function that updates the block with the new name.
  */
-const VARIABLE_OPTION_CALLBACK_FACTORY = function (block, id, fieldName) {
-  return function () {
-    var variableField = block.getField(fieldName);
+const VARIABLE_OPTION_CALLBACK_FACTORY = function (
+  block: Blockly.Block,
+  id: string,
+  fieldName: string
+): () => void {
+  return () => {
+    const variableField = block.getField(fieldName);
     if (!variableField) {
       console.log("Tried to get a variable field on the wrong type of block.");
     }
@@ -663,28 +643,40 @@ const VARIABLE_OPTION_CALLBACK_FACTORY = function (block, id, fieldName) {
 /**
  * Callback for rename variable dropdown menu option associated with a
  * variable getter block.
- * @param {!Blockly.Block} block The block with the variable to rename.
- * @param {string} fieldName The name of the field to inspect on the block.
- * @return {!function()} A function that renames the variable.
+ *
+ * @param block The block with the variable to rename.
+ * @param fieldName The name of the field to inspect on the block.
+ * @returns A function that renames the variable.
  */
-const RENAME_OPTION_CALLBACK_FACTORY = function (block, fieldName) {
-  return function () {
-    var workspace = block.workspace;
-    var variable = block.getField(fieldName).getVariable();
-    renameVariable(workspace, variable);
+const RENAME_OPTION_CALLBACK_FACTORY = function (
+  block: Blockly.Block,
+  fieldName: string
+): () => void {
+  return () => {
+    const workspace = block.workspace;
+    const variable = (
+      block.getField(fieldName) as ScratchFieldVariable
+    ).getVariable() as ScratchVariableModel;
+    renameVariable(workspace as Blockly.WorkspaceSvg, variable);
   };
 };
 
 /**
  * Callback for delete variable dropdown menu option associated with a
  * variable getter block.
- * @param {!Blockly.Block} block The block with the variable to delete.
- * @param {string} fieldName The name of the field to inspect on the block.
- * @return {!function()} A function that deletes the variable.
+ *
+ * @param block The block with the variable to delete.
+ * @param fieldName The name of the field to inspect on the block.
+ * @return A function that deletes the variable.
  */
-const DELETE_OPTION_CALLBACK_FACTORY = function (block, fieldName) {
-  return function () {
-    const variable = block.getField(fieldName).getVariable();
+const DELETE_OPTION_CALLBACK_FACTORY = function (
+  block: Blockly.Block,
+  fieldName: string
+): () => void {
+  return () => {
+    const variable = (
+      block.getField(fieldName) as ScratchFieldVariable
+    ).getVariable();
     Blockly.Variables.deleteVariable(variable.getWorkspace(), variable, block);
   };
 };