scratch-blocks 2.0.0-spork.2 → 2.0.0-spork.4

package/src/{data_category.js → data_category.ts}

@@ -22,35 +22,31 @@
  * @fileoverview Data Flyout components including variable and list blocks.
  * @author marisaleung@google.com (Marisa Leung)
  */
-"use strict";
 
-/**
- * @name Blockly.DataCategory
- * @namespace
- **/
 import * as Blockly from "blockly/core";
-import { createVariable } from "./variables.js";
-import { LIST_VARIABLE_TYPE, SCALAR_VARIABLE_TYPE } from "./constants.js";
+import { createVariable } from "./variables";
+import { LIST_VARIABLE_TYPE, SCALAR_VARIABLE_TYPE } from "./constants";
 
 /**
  * Construct the blocks required by the flyout for the variable category.
- * @param {!Blockly.Workspace} workspace The workspace containing variables.
- * @return {!Array.<!Element>} Array of XML block elements.
+ *
+ * @param workspace The workspace containing variables.
+ * @returns Array of XML block elements.
  */
-export function getVariablesCategory(workspace) {
-  var variableModelList = workspace.getVariablesOfType(SCALAR_VARIABLE_TYPE);
-  variableModelList.sort(Blockly.Variables.compareByName);
-  var xmlList = [];
+export function getVariablesCategory(
+  workspace: Blockly.WorkspaceSvg
+): Element[] {
+  const scalarVariables = workspace.getVariablesOfType(SCALAR_VARIABLE_TYPE);
+  scalarVariables.sort(Blockly.Variables.compareByName);
+  const xmlList: Element[] = [];
 
   addCreateButton(xmlList, workspace, "VARIABLE");
 
-  for (var i = 0; i < variableModelList.length; i++) {
-    addDataVariable(xmlList, variableModelList[i]);
-  }
+  scalarVariables.forEach((variable) => addDataVariable(xmlList, variable));
 
-  if (variableModelList.length > 0) {
-    xmlList[xmlList.length - 1].setAttribute("gap", 24);
-    var firstVariable = variableModelList[0];
+  if (scalarVariables.length > 0) {
+    xmlList[xmlList.length - 1].setAttribute("gap", "24");
+    const firstVariable = scalarVariables[0];
 
     addSetVariableTo(xmlList, firstVariable);
     addChangeVariableBy(xmlList, firstVariable);
@@ -60,15 +56,13 @@ export function getVariablesCategory(workspace) {
 
   // Now add list variables to the flyout
   addCreateButton(xmlList, workspace, "LIST");
-  variableModelList = workspace.getVariablesOfType(LIST_VARIABLE_TYPE);
-  variableModelList.sort(Blockly.Variables.compareByName);
-  for (var i = 0; i < variableModelList.length; i++) {
-    addDataList(xmlList, variableModelList[i]);
-  }
+  const listVariables = workspace.getVariablesOfType(LIST_VARIABLE_TYPE);
+  listVariables.sort(Blockly.Variables.compareByName);
+  listVariables.forEach((variable) => addDataList(xmlList, variable));
 
-  if (variableModelList.length > 0) {
-    xmlList[xmlList.length - 1].setAttribute("gap", 24);
-    var firstVariable = variableModelList[0];
+  if (listVariables.length > 0) {
+    xmlList[xmlList.length - 1].setAttribute("gap", "24");
+    const firstVariable = listVariables[0];
 
     addAddToList(xmlList, firstVariable);
     addSep(xmlList);
@@ -91,10 +85,14 @@ export function getVariablesCategory(workspace) {
 
 /**
  * Construct and add a data_variable block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addDataVariable(xmlList, variable) {
+function addDataVariable(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block id="variableId" type="data_variable">
   //    <field name="VARIABLE">variablename</field>
   // </block>
@@ -105,10 +103,14 @@ function addDataVariable(xmlList, variable) {
 
 /**
  * Construct and add a data_setvariableto block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addSetVariableTo(xmlList, variable) {
+function addSetVariableTo(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_setvariableto" gap="20">
   //   <value name="VARIABLE">
   //    <shadow type="data_variablemenu"></shadow>
@@ -122,16 +124,20 @@ function addSetVariableTo(xmlList, variable) {
   addBlock(xmlList, variable, "data_setvariableto", "VARIABLE", [
     "VALUE",
     "text",
-    0,
+    "0",
   ]);
 }
 
 /**
  * Construct and add a data_changevariableby block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addChangeVariableBy(xmlList, variable) {
+function addChangeVariableBy(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_changevariableby">
   //   <value name="VARIABLE">
   //    <shadow type="data_variablemenu"></shadow>
@@ -145,16 +151,20 @@ function addChangeVariableBy(xmlList, variable) {
   addBlock(xmlList, variable, "data_changevariableby", "VARIABLE", [
     "VALUE",
     "math_number",
-    1,
+    "1",
   ]);
 }
 
 /**
  * Construct and add a data_showVariable block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addShowVariable(xmlList, variable) {
+function addShowVariable(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_showvariable">
   //   <value name="VARIABLE">
   //     <shadow type="data_variablemenu"></shadow>
@@ -165,10 +175,14 @@ function addShowVariable(xmlList, variable) {
 
 /**
  * Construct and add a data_hideVariable block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addHideVariable(xmlList, variable) {
+function addHideVariable(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_hidevariable">
   //   <value name="VARIABLE">
   //     <shadow type="data_variablemenu"></shadow>
@@ -179,10 +193,14 @@ function addHideVariable(xmlList, variable) {
 
 /**
  * Construct and add a data_listcontents block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addDataList(xmlList, variable) {
+function addDataList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block id="variableId" type="data_listcontents">
   //    <field name="LIST">variablename</field>
   // </block>
@@ -193,10 +211,14 @@ function addDataList(xmlList, variable) {
 
 /**
  * Construct and add a data_addtolist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addAddToList(xmlList, variable) {
+function addAddToList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_addtolist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   //   <value name="ITEM">
@@ -214,10 +236,14 @@ function addAddToList(xmlList, variable) {
 
 /**
  * Construct and add a data_deleteoflist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addDeleteOfList(xmlList, variable) {
+function addDeleteOfList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_deleteoflist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   //   <value name="INDEX">
@@ -229,16 +255,20 @@ function addDeleteOfList(xmlList, variable) {
   addBlock(xmlList, variable, "data_deleteoflist", "LIST", [
     "INDEX",
     "math_integer",
-    1,
+    "1",
   ]);
 }
 
 /**
  * Construct and add a data_deleteoflist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addDeleteAllOfList(xmlList, variable) {
+function addDeleteAllOfList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_deletealloflist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   // </block>
@@ -247,10 +277,14 @@ function addDeleteAllOfList(xmlList, variable) {
 
 /**
  * Construct and add a data_insertatlist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addInsertAtList(xmlList, variable) {
+function addInsertAtList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_insertatlist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   //   <value name="INDEX">
@@ -269,17 +303,21 @@ function addInsertAtList(xmlList, variable) {
     variable,
     "data_insertatlist",
     "LIST",
-    ["INDEX", "math_integer", 1],
+    ["INDEX", "math_integer", "1"],
     ["ITEM", "text", Blockly.Msg.DEFAULT_LIST_ITEM]
   );
 }
 
 /**
  * Construct and add a data_replaceitemoflist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addReplaceItemOfList(xmlList, variable) {
+function addReplaceItemOfList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_replaceitemoflist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   //   <value name="INDEX">
@@ -298,17 +336,21 @@ function addReplaceItemOfList(xmlList, variable) {
     variable,
     "data_replaceitemoflist",
     "LIST",
-    ["INDEX", "math_integer", 1],
+    ["INDEX", "math_integer", "1"],
     ["ITEM", "text", Blockly.Msg.DEFAULT_LIST_ITEM]
   );
 }
 
 /**
  * Construct and add a data_itemoflist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addItemOfList(xmlList, variable) {
+function addItemOfList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_itemoflist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   //   <value name="INDEX">
@@ -320,15 +362,19 @@ function addItemOfList(xmlList, variable) {
   addBlock(xmlList, variable, "data_itemoflist", "LIST", [
     "INDEX",
     "math_integer",
-    1,
+    "1",
   ]);
 }
 
 /** Construct and add a data_itemnumoflist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addItemNumberOfList(xmlList, variable) {
+function addItemNumberOfList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_itemnumoflist">
   //   <value name="ITEM">
   //     <shadow type="text">
@@ -346,10 +392,14 @@ function addItemNumberOfList(xmlList, variable) {
 
 /**
  * Construct and add a data_lengthoflist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addLengthOfList(xmlList, variable) {
+function addLengthOfList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_lengthoflist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   // </block>
@@ -358,10 +408,14 @@ function addLengthOfList(xmlList, variable) {
 
 /**
  * Construct and add a data_listcontainsitem block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addListContainsItem(xmlList, variable) {
+function addListContainsItem(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_listcontainsitem">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   //   <value name="ITEM">
@@ -379,10 +433,14 @@ function addListContainsItem(xmlList, variable) {
 
 /**
  * Construct and add a data_showlist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addShowList(xmlList, variable) {
+function addShowList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_showlist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   // </block>
@@ -391,10 +449,14 @@ function addShowList(xmlList, variable) {
 
 /**
  * Construct and add a data_hidelist block to xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
  */
-function addHideList(xmlList, variable) {
+function addHideList(
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>
+) {
   // <block type="data_hidelist">
   //   <field name="LIST" variabletype="list" id="">variablename</field>
   // </block>
@@ -403,24 +465,29 @@ function addHideList(xmlList, variable) {
 
 /**
  * Construct a create variable button and push it to the xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {Blockly.Workspace} workspace Workspace to register callback to.
- * @param {string} type Type of variable this is for. For example, 'LIST' or
+ *
+ * @param xmlList Array of XML block elements.
+ * @param workspace Workspace to register callback to.
+ * @param type Type of variable this is for. For example, 'LIST' or
  *     'VARIABLE'.
  */
-function addCreateButton(xmlList, workspace, type) {
-  var button = document.createElement("button");
+function addCreateButton(
+  xmlList: Element[],
+  workspace: Blockly.WorkspaceSvg,
+  type: string
+) {
+  const button = document.createElement("button");
   // Set default msg, callbackKey, and callback values for type 'VARIABLE'
-  var msg = Blockly.Msg.NEW_VARIABLE;
-  var callbackKey = "CREATE_VARIABLE";
-  var callback = function (button) {
+  let msg = Blockly.Msg.NEW_VARIABLE;
+  let callbackKey = "CREATE_VARIABLE";
+  let callback = function (button: Blockly.FlyoutButton) {
     createVariable(button.getTargetWorkspace(), null, SCALAR_VARIABLE_TYPE);
   };
 
   if (type === "LIST") {
     msg = Blockly.Msg.NEW_LIST;
     callbackKey = "CREATE_LIST";
-    callback = function (button) {
+    callback = function (button: Blockly.FlyoutButton) {
       createVariable(button.getTargetWorkspace(), null, LIST_VARIABLE_TYPE);
     };
   }
@@ -442,28 +509,28 @@ function addCreateButton(xmlList, workspace, type) {
 /**
  * Construct a variable block with the given variable, blockType, and optional
  *     value tags. Add the variable block to the given xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
- * @param {?Blockly.VariableModel} variable Variable to select in the field.
- * @param {string} blockType Type of block. For example, 'data_hidelist' or
- *     data_showlist'.
- * @param {string} fieldName Name of field in block. For example: 'VARIABLE' or
- *     'LIST'.
- * @param {?Array.<string>} opt_value Optional array containing the value name
- *     and shadow type of value tags.
- * @param {?Array.<string>} opt_secondValue Optional array containing the value
- *     name and shadow type of a second pair of value tags.
+ *
+ * @param xmlList Array of XML block elements.
+ * @param variable Variable to select in the field.
+ * @param blockType Type of block. For example, 'data_hidelist' or
+ *     'data_showlist'.
+ * @param fieldName Name of field in block. For example: 'VARIABLE' or 'LIST'.
+ * @param opt_value Optional array containing the value name and shadow type of
+ *     value tags.
+ * @param opt_secondValue Optional array containing the value name and shadow
+ *     type of a second pair of value tags.
  */
 function addBlock(
-  xmlList,
-  variable,
-  blockType,
-  fieldName,
-  opt_value,
-  opt_secondValue
+  xmlList: Element[],
+  variable: Blockly.IVariableModel<Blockly.IVariableState>,
+  blockType: string,
+  fieldName: string,
+  opt_value?: string[],
+  opt_secondValue?: string[]
 ) {
   if (Blockly.Blocks[blockType]) {
-    var firstValueField;
-    var secondValueField;
+    let firstValueField;
+    let secondValueField;
     if (opt_value) {
       firstValueField = createValue(opt_value[0], opt_value[1], opt_value[2]);
     }
@@ -476,24 +543,30 @@ function addBlock(
     }
 
     var gap = 8;
-    var blockText =
-      "<xml>" +
-      '<block type="' +
-      blockType +
-      '" gap="' +
-      gap +
-      '">' +
-      generateVariableFieldXml(variable, fieldName) +
-      firstValueField +
-      secondValueField +
-      "</block>" +
-      "</xml>";
-    var block = Blockly.utils.xml.textToDom(blockText).firstChild;
+    var blockText = `
+      <xml>
+        <block type="${blockType}" gap="${gap}">
+          ${generateVariableFieldXml(variable, fieldName)}
+          ${firstValueField}
+          ${secondValueField}
+        </block>
+      </xml>`;
+    var block = Blockly.utils.xml.textToDom(blockText).firstElementChild;
     xmlList.push(block);
   }
 }
 
-function generateVariableFieldXml(variableModel, opt_name) {
+/**
+ * Creates XML representing a variable field.
+ *
+ * @param variableModel The variable to represent in the field.
+ * @param opt_name A custom name for the field, if desired.
+ * @returns XML representation of a variable field.
+ */
+function generateVariableFieldXml(
+  variableModel: Blockly.IVariableModel<Blockly.IVariableState>,
+  opt_name?: string
+): string {
   const field = document.createElement("field");
   field.setAttribute("name", opt_name || "VARIABLE");
   field.setAttribute("id", variableModel.getId());
@@ -505,13 +578,14 @@ function generateVariableFieldXml(variableModel, opt_name) {
 /**
  * Create the text representation of a value dom element with a shadow of the
  *     indicated type inside.
- * @param {string} valueName Name of the value tags.
- * @param {string} type The type of the shadow tags.
- * @param {string|number} value The default shadow value.
- * @return {string} The generated dom element in text.
+ *
+ * @param valueName Name of the value tags.
+ * @param type The type of the shadow tags.
+ * @param value The default shadow value.
+ * @returns The generated dom element in text.
  */
-function createValue(valueName, type, value) {
-  var fieldName;
+function createValue(valueName: string, type: string, value: string): string {
+  let fieldName;
   switch (valueName) {
     case "ITEM":
       fieldName = "TEXT";
@@ -527,30 +601,22 @@ function createValue(valueName, type, value) {
       }
       break;
   }
-  var valueField =
-    '<value name="' +
-    valueName +
-    '">' +
-    '<shadow type="' +
-    type +
-    '">' +
-    '<field name="' +
-    fieldName +
-    '">' +
-    value +
-    "</field>" +
-    "</shadow>" +
-    "</value>";
+  const valueField = `
+    <value name="${valueName}">
+      <shadow type="${type}">
+        <field name="${fieldName}">${value}</field>
+      </shadow>
+    </value>`;
   return valueField;
 }
 
 /**
  * Construct a block separator. Add the separator to the given xmlList.
- * @param {!Array.<!Element>} xmlList Array of XML block elements.
+ *
+ * @param xmlList Array of XML block elements.
  */
-function addSep(xmlList) {
-  var gap = 36;
-  var sepText = "<xml>" + '<sep gap="' + gap + '"/>' + "</xml>";
-  var sep = Blockly.utils.xml.textToDom(sepText).firstChild;
+function addSep(xmlList: Element[]) {
+  const sepText = `<xml><sep gap="36"/></xml>`;
+  const sep = Blockly.utils.xml.textToDom(sepText).firstElementChild;
   xmlList.push(sep);
 }

package/src/events/{events_block_comment_base.js → events_block_comment_base.ts}

@@ -5,9 +5,15 @@
  */
 
 import * as Blockly from "blockly/core";
+import type { ScratchCommentBubble } from "../scratch_comment_bubble";
 
 export class BlockCommentBase extends Blockly.Events.Abstract {
-  constructor(opt_blockComment) {
+  isBlank = true;
+  commentId: string;
+  blockId: string;
+  workspaceId: string;
+
+  constructor(opt_blockComment?: ScratchCommentBubble) {
     super();
     this.isBlank = !opt_blockComment;
 
@@ -18,7 +24,7 @@ export class BlockCommentBase extends Blockly.Events.Abstract {
     this.workspaceId = opt_blockComment.getSourceBlock()?.workspace.id;
   }
 
-  toJson() {
+  toJson(): BlockCommentBaseJson {
     return {
       ...super.toJson(),
       commentId: this.commentId,
@@ -26,10 +32,23 @@ export class BlockCommentBase extends Blockly.Events.Abstract {
     };
   }
 
-  static fromJson(json, workspace, event) {
-    const newEvent = super.fromJson(json, workspace, event);
+  static fromJson(
+    json: BlockCommentBaseJson,
+    workspace: Blockly.Workspace,
+    event?: any
+  ): BlockCommentBase {
+    const newEvent = super.fromJson(
+      json,
+      workspace,
+      event ?? new BlockCommentBase()
+    ) as BlockCommentBase;
     newEvent.commentId = json["commentId"];
     newEvent.blockId = json["blockId"];
     return newEvent;
   }
 }
+
+export interface BlockCommentBaseJson extends Blockly.Events.AbstractEventJson {
+  commentId: string;
+  blockId: string;
+}