blockly 8.20220331.0-beta.1 → 9.0.0-beta.0

package/core/events/{events_block_change.js → events_block_change.ts}

@@ -7,45 +7,49 @@
 /**
  * @fileoverview Class for a block change event.
  */
-'use strict';
 
 /**
  * Class for a block change event.
  * @class
  */
-goog.module('Blockly.Events.BlockChange');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.BlockChange');
 
-const Xml = goog.require('Blockly.Xml');
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {BlockBase} = goog.require('Blockly.Events.BlockBase');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
+import type {Block} from '../block.js';
+import type {BlockSvg} from '../block_svg.js';
+import * as registry from '../registry.js';
+import * as Xml from '../xml.js';
+
+import {BlockBase} from './events_block_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a block change event.
- * @extends {BlockBase}
  * @alias Blockly.Events.BlockChange
  */
-class BlockChange extends BlockBase {
+export class BlockChange extends BlockBase {
+  override type: string;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  element!: string;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  name!: string|null;
+  oldValue: AnyDuringMigration;
+  newValue: AnyDuringMigration;
+
   /**
-   * @param {!Block=} opt_block The changed block.  Undefined for a blank
-   *     event.
-   * @param {string=} opt_element One of 'field', 'comment', 'disabled', etc.
-   * @param {?string=} opt_name Name of input or field affected, or null.
-   * @param {*=} opt_oldValue Previous value of element.
-   * @param {*=} opt_newValue New value of element.
+   * @param opt_block The changed block.  Undefined for a blank event.
+   * @param opt_element One of 'field', 'comment', 'disabled', etc.
+   * @param opt_name Name of input or field affected, or null.
+   * @param opt_oldValue Previous value of element.
+   * @param opt_newValue New value of element.
    */
-  constructor(opt_block, opt_element, opt_name, opt_oldValue, opt_newValue) {
+  constructor(
+      opt_block?: Block, opt_element?: string, opt_name?: string|null,
+      opt_oldValue?: AnyDuringMigration, opt_newValue?: AnyDuringMigration) {
     super(opt_block);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.BLOCK_CHANGE;
 
     if (!opt_block) {
@@ -59,9 +63,9 @@ class BlockChange extends BlockBase {
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['element'] = this.element;
     if (this.name) {
@@ -74,9 +78,9 @@ class BlockChange extends BlockBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.element = json['element'];
     this.name = json['name'];
@@ -86,26 +90,25 @@ class BlockChange extends BlockBase {
 
   /**
    * Does this event record any change of state?
-   * @return {boolean} False if something changed.
+   * @return False if something changed.
    */
-  isNull() {
+  override isNull(): boolean {
     return this.oldValue === this.newValue;
   }
 
   /**
    * Run a change event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
+   * @param forward True if run forward, false if run backward (undo).
    */
-  run(forward) {
+  override run(forward: boolean) {
     const workspace = this.getEventWorkspace_();
     const block = workspace.getBlockById(this.blockId);
     if (!block) {
       console.warn('Can\'t change non-existent block: ' + this.blockId);
       return;
     }
-
     // Assume the block is rendered so that then we can check.
-    const blockSvg = /** @type {!BlockSvg} */ (block);
+    const blockSvg = block as BlockSvg;
     if (blockSvg.mutator) {
       // Close the mutator (if open) since we don't want to update it.
       blockSvg.mutator.setVisible(false);
@@ -113,7 +116,7 @@ class BlockChange extends BlockBase {
     const value = forward ? this.newValue : this.oldValue;
     switch (this.element) {
       case 'field': {
-        const field = block.getField(this.name);
+        const field = block.getField(this.name!);
         if (field) {
           field.setValue(value);
         } else {
@@ -122,7 +125,7 @@ class BlockChange extends BlockBase {
         break;
       }
       case 'comment':
-        block.setCommentText(/** @type {string} */ (value) || null);
+        block.setCommentText(value as string || null);
         break;
       case 'collapsed':
         block.setCollapsed(!!value);
@@ -134,14 +137,11 @@ class BlockChange extends BlockBase {
         block.setInputsInline(!!value);
         break;
       case 'mutation': {
-        const oldState = BlockChange.getExtraBlockState_(
-            /** @type {!BlockSvg} */ (block));
+        const oldState = BlockChange.getExtraBlockState_(block as BlockSvg);
         if (block.loadExtraState) {
-          block.loadExtraState(
-              JSON.parse(/** @type {string} */ (value) || '{}'));
+          block.loadExtraState(JSON.parse(value as string || '{}'));
         } else if (block.domToMutation) {
-          block.domToMutation(
-              Xml.textToDom(/** @type {string} */ (value) || '<mutation/>'));
+          block.domToMutation(Xml.textToDom(value as string || '<mutation/>'));
         }
         eventUtils.fire(
             new BlockChange(block, 'mutation', null, oldState, value));
@@ -157,12 +157,11 @@ class BlockChange extends BlockBase {
   /**
    * Returns the extra state of the given block (either as XML or a JSO,
    * depending on the block's definition).
-   * @param {!BlockSvg} block The block to get the extra state of.
-   * @return {string} A stringified version of the extra state of the given
-   *     block.
-   * @package
+   * @param block The block to get the extra state of.
+   * @return A stringified version of the extra state of the given block.
+   * @internal
    */
-  static getExtraBlockState_(block) {
+  static getExtraBlockState_(block: BlockSvg): string {
     if (block.saveExtraState) {
       const state = block.saveExtraState();
       return state ? JSON.stringify(state) : '';
@@ -175,5 +174,3 @@ class BlockChange extends BlockBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.CHANGE, BlockChange);
-
-exports.BlockChange = BlockChange;

package/core/events/events_block_create.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from '../block.js';
+import * as blocks from '../serialization/blocks.js';
+import { BlockBase } from './events_block_base.js';
+/**
+ * Class for a block creation event.
+ * @alias Blockly.Events.BlockCreate
+ */
+export declare class BlockCreate extends BlockBase {
+    type: string;
+    xml: any;
+    ids: string[];
+    json: blocks.State;
+    /** @param opt_block The created block.  Undefined for a blank event. */
+    constructor(opt_block?: Block);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Run a creation event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}

package/core/events/{events_block_create.js → events_block_create.ts}

@@ -7,45 +7,46 @@
 /**
  * @fileoverview Class for a block creation event.
  */
-'use strict';
 
 /**
  * Class for a block creation event.
  * @class
  */
-goog.module('Blockly.Events.BlockCreate');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.BlockCreate');
 
-const Xml = goog.require('Blockly.Xml');
-const blocks = goog.require('Blockly.serialization.blocks');
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {BlockBase} = goog.require('Blockly.Events.BlockBase');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
+import type {Block} from '../block.js';
+import * as registry from '../registry.js';
+import * as blocks from '../serialization/blocks.js';
+import * as Xml from '../xml.js';
+
+import {BlockBase} from './events_block_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a block creation event.
- * @extends {BlockBase}
  * @alias Blockly.Events.BlockCreate
  */
-class BlockCreate extends BlockBase {
-  /**
-   * @param {!Block=} opt_block The created block.  Undefined for a blank
-   *     event.
-   */
-  constructor(opt_block) {
+export class BlockCreate extends BlockBase {
+  override type: string;
+  xml: AnyDuringMigration;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  ids!: string[];
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  json!: blocks.State;
+
+  /** @param opt_block The created block.  Undefined for a blank event. */
+  constructor(opt_block?: Block) {
     super(opt_block);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.BLOCK_CREATE;
 
     if (!opt_block) {
       return;  // Blank event to be populated by fromJson.
     }
+
     if (opt_block.isShadow()) {
       // Moving shadow blocks is handled via disconnection.
       this.recordUndo = false;
@@ -54,30 +55,19 @@ class BlockCreate extends BlockBase {
     this.xml = Xml.blockToDomWithXY(opt_block);
     this.ids = eventUtils.getDescendantIds(opt_block);
 
-    /**
-     * Play UI effects (sound and animation)?
-     * @type {boolean}
-     */
-    this.ui = true;
-
-    /**
-     * JSON representation of the block that was just created.
-     * @type {!blocks.State}
-     */
-    this.json = /** @type {!blocks.State} */ (
-        blocks.save(opt_block, {addCoordinates: true}));
+    /** JSON representation of the block that was just created. */
+    this.json = blocks.save(opt_block, {addCoordinates: true}) as blocks.State;
   }
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['xml'] = Xml.domToText(this.xml);
     json['ids'] = this.ids;
     json['json'] = this.json;
-    json['ui'] = this.ui;
     if (!this.recordUndo) {
       json['recordUndo'] = this.recordUndo;
     }
@@ -86,14 +76,13 @@ class BlockCreate extends BlockBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.xml = Xml.textToDom(json['xml']);
     this.ids = json['ids'];
-    this.json = /** @type {!blocks.State} */ (json['json']);
-    this.ui = !!json['ui'];
+    this.json = json['json'] as blocks.State;
     if (json['recordUndo'] !== undefined) {
       this.recordUndo = json['recordUndo'];
     }
@@ -101,9 +90,9 @@ class BlockCreate extends BlockBase {
 
   /**
    * Run a creation event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
+   * @param forward True if run forward, false if run backward (undo).
    */
-  run(forward) {
+  override run(forward: boolean) {
     const workspace = this.getEventWorkspace_();
     if (forward) {
       blocks.append(this.json, workspace);
@@ -112,7 +101,7 @@ class BlockCreate extends BlockBase {
         const id = this.ids[i];
         const block = workspace.getBlockById(id);
         if (block) {
-          block.dispose(false, this.ui);
+          block.dispose(false);
         } else if (id === this.blockId) {
           // Only complain about root-level block.
           console.warn('Can\'t uncreate non-existent block: ' + id);
@@ -123,5 +112,3 @@ class BlockCreate extends BlockBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.CREATE, BlockCreate);
-
-exports.BlockCreate = BlockCreate;

package/core/events/events_block_delete.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from '../block.js';
+import * as blocks from '../serialization/blocks.js';
+import { BlockBase } from './events_block_base.js';
+/**
+ * Class for a block deletion event.
+ * @alias Blockly.Events.BlockDelete
+ */
+export declare class BlockDelete extends BlockBase {
+    type: string;
+    oldXml: any;
+    ids: string[];
+    wasShadow: boolean;
+    oldJson: blocks.State;
+    /** @param opt_block The deleted block.  Undefined for a blank event. */
+    constructor(opt_block?: Block);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Run a deletion event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}

package/core/events/{events_block_delete.js → events_block_delete.ts}

@@ -7,45 +7,48 @@
 /**
  * @fileoverview Class for a block delete event.
  */
-'use strict';
 
 /**
  * Class for a block delete event.
  * @class
  */
-goog.module('Blockly.Events.BlockDelete');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.BlockDelete');
 
-const Xml = goog.require('Blockly.Xml');
-const blocks = goog.require('Blockly.serialization.blocks');
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {BlockBase} = goog.require('Blockly.Events.BlockBase');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
+import type {Block} from '../block.js';
+import * as registry from '../registry.js';
+import * as blocks from '../serialization/blocks.js';
+import * as Xml from '../xml.js';
+
+import {BlockBase} from './events_block_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a block deletion event.
- * @extends {BlockBase}
  * @alias Blockly.Events.BlockDelete
  */
-class BlockDelete extends BlockBase {
-  /**
-   * @param {!Block=} opt_block The deleted block.  Undefined for a blank
-   *     event.
-   */
-  constructor(opt_block) {
+export class BlockDelete extends BlockBase {
+  override type: string;
+  oldXml: AnyDuringMigration;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  ids!: string[];
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  wasShadow!: boolean;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  oldJson!: blocks.State;
+
+  /** @param opt_block The deleted block.  Undefined for a blank event. */
+  constructor(opt_block?: Block) {
     super(opt_block);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.BLOCK_DELETE;
 
     if (!opt_block) {
       return;  // Blank event to be populated by fromJson.
     }
+
     if (opt_block.getParent()) {
       throw Error('Connected blocks cannot be deleted.');
     }
@@ -57,37 +60,24 @@ class BlockDelete extends BlockBase {
     this.oldXml = Xml.blockToDomWithXY(opt_block);
     this.ids = eventUtils.getDescendantIds(opt_block);
 
-    /**
-     * Was the block that was just deleted a shadow?
-     * @type {boolean}
-     */
+    /** Was the block that was just deleted a shadow? */
     this.wasShadow = opt_block.isShadow();
 
-    /**
-     * Play UI effects (sound and animation)?
-     * @type {boolean}
-     */
-    this.ui = true;
-
-    /**
-     * JSON representation of the block that was just deleted.
-     * @type {!blocks.State}
-     */
-    this.oldJson = /** @type {!blocks.State} */ (
-        blocks.save(opt_block, {addCoordinates: true}));
+    /** JSON representation of the block that was just deleted. */
+    this.oldJson =
+        blocks.save(opt_block, {addCoordinates: true}) as blocks.State;
   }
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['oldXml'] = Xml.domToText(this.oldXml);
     json['ids'] = this.ids;
     json['wasShadow'] = this.wasShadow;
     json['oldJson'] = this.oldJson;
-    json['ui'] = this.ui;
     if (!this.recordUndo) {
       json['recordUndo'] = this.recordUndo;
     }
@@ -96,16 +86,15 @@ class BlockDelete extends BlockBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.oldXml = Xml.textToDom(json['oldXml']);
     this.ids = json['ids'];
     this.wasShadow =
         json['wasShadow'] || this.oldXml.tagName.toLowerCase() === 'shadow';
-    this.oldJson = /** @type {!blocks.State} */ (json['oldJson']);
-    this.ui = !!json['ui'];
+    this.oldJson = json['oldJson'] as blocks.State;
     if (json['recordUndo'] !== undefined) {
       this.recordUndo = json['recordUndo'];
     }
@@ -113,16 +102,16 @@ class BlockDelete extends BlockBase {
 
   /**
    * Run a deletion event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
+   * @param forward True if run forward, false if run backward (undo).
    */
-  run(forward) {
+  override run(forward: boolean) {
     const workspace = this.getEventWorkspace_();
     if (forward) {
       for (let i = 0; i < this.ids.length; i++) {
         const id = this.ids[i];
         const block = workspace.getBlockById(id);
         if (block) {
-          block.dispose(false, this.ui);
+          block.dispose(false);
         } else if (id === this.blockId) {
           // Only complain about root-level block.
           console.warn('Can\'t delete non-existent block: ' + id);
@@ -135,5 +124,3 @@ class BlockDelete extends BlockBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.DELETE, BlockDelete);
-
-exports.BlockDelete = BlockDelete;

package/core/events/events_block_drag.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from '../block.js';
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a block drag event.
+ * @alias Blockly.Events.BlockDrag
+ */
+export declare class BlockDrag extends UiBase {
+    blockId: any;
+    isStart?: boolean;
+    blocks?: Block[];
+    type: string;
+    /**
+     * @param opt_block The top block in the stack that is being dragged.
+     *     Undefined for a blank event.
+     * @param opt_isStart Whether this is the start of a block drag.
+     *    Undefined for a blank event.
+     * @param opt_blocks The blocks affected by this drag. Undefined for a blank
+     *     event.
+     */
+    constructor(opt_block?: Block, opt_isStart?: boolean, opt_blocks?: Block[]);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+}

package/core/events/events_block_drag.ts

@@ -0,0 +1,82 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Events fired as a block drag.
+ */
+
+/**
+ * Events fired as a block drag.
+ * @class
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.BlockDrag');
+
+import type {Block} from '../block.js';
+import * as registry from '../registry.js';
+
+import {UiBase} from './events_ui_base.js';
+import * as eventUtils from './utils.js';
+
+
+/**
+ * Class for a block drag event.
+ * @alias Blockly.Events.BlockDrag
+ */
+export class BlockDrag extends UiBase {
+  blockId: AnyDuringMigration;
+  isStart?: boolean;
+  blocks?: Block[];
+  override type: string;
+
+  /**
+   * @param opt_block The top block in the stack that is being dragged.
+   *     Undefined for a blank event.
+   * @param opt_isStart Whether this is the start of a block drag.
+   *    Undefined for a blank event.
+   * @param opt_blocks The blocks affected by this drag. Undefined for a blank
+   *     event.
+   */
+  constructor(opt_block?: Block, opt_isStart?: boolean, opt_blocks?: Block[]) {
+    const workspaceId = opt_block ? opt_block.workspace.id : undefined;
+    super(workspaceId);
+    this.blockId = opt_block ? opt_block.id : null;
+
+    /** Whether this is the start of a block drag. */
+    this.isStart = opt_isStart;
+
+    /** The blocks affected by this drag event. */
+    this.blocks = opt_blocks;
+
+    /** Type of this event. */
+    this.type = eventUtils.BLOCK_DRAG;
+  }
+
+  /**
+   * Encode the event as JSON.
+   * @return JSON representation.
+   */
+  override toJson(): AnyDuringMigration {
+    const json = super.toJson();
+    json['isStart'] = this.isStart;
+    json['blockId'] = this.blockId;
+    json['blocks'] = this.blocks;
+    return json;
+  }
+
+  /**
+   * Decode the JSON event.
+   * @param json JSON representation.
+   */
+  override fromJson(json: AnyDuringMigration) {
+    super.fromJson(json);
+    this.isStart = json['isStart'];
+    this.blockId = json['blockId'];
+    this.blocks = json['blocks'];
+  }
+}
+
+registry.register(registry.Type.EVENT, eventUtils.BLOCK_DRAG, BlockDrag);