blockly 8.0.5 → 9.0.0-beta.0

package/core/events/events_comment_change.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { WorkspaceComment } from '../workspace_comment.js';
+import { CommentBase } from './events_comment_base.js';
+/**
+ * Class for a comment change event.
+ * @alias Blockly.Events.CommentChange
+ */
+export declare class CommentChange extends CommentBase {
+    type: string;
+    oldContents_: string;
+    newContents_: string;
+    /**
+     * @param opt_comment The comment that is being changed.  Undefined for a
+     *     blank event.
+     * @param opt_oldContents Previous contents of the comment.
+     * @param opt_newContents New contents of the comment.
+     */
+    constructor(opt_comment?: WorkspaceComment, opt_oldContents?: string, opt_newContents?: string);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Does this event record any change of state?
+     * @return False if something changed.
+     */
+    isNull(): boolean;
+    /**
+     * Run a change event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}

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

@@ -7,40 +7,45 @@
 /**
  * @fileoverview Class for comment change event.
  */
-'use strict';
 
 /**
  * Class for comment change event.
  * @class
  */
-goog.module('Blockly.Events.CommentChange');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.CommentChange');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {CommentBase} = goog.require('Blockly.Events.CommentBase');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
+import * as registry from '../registry.js';
+import type {WorkspaceComment} from '../workspace_comment.js';
+
+import {CommentBase} from './events_comment_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a comment change event.
- * @extends {CommentBase}
  * @alias Blockly.Events.CommentChange
  */
-class CommentChange extends CommentBase {
+export class CommentChange extends CommentBase {
+  override type: string;
+
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  oldContents_!: string;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  newContents_!: string;
+
   /**
-   * @param {!WorkspaceComment=} opt_comment The comment that is being
-   *     changed.  Undefined for a blank event.
-   * @param {string=} opt_oldContents Previous contents of the comment.
-   * @param {string=} opt_newContents New contents of the comment.
+   * @param opt_comment The comment that is being changed.  Undefined for a
+   *     blank event.
+   * @param opt_oldContents Previous contents of the comment.
+   * @param opt_newContents New contents of the comment.
    */
-  constructor(opt_comment, opt_oldContents, opt_newContents) {
+  constructor(
+      opt_comment?: WorkspaceComment, opt_oldContents?: string,
+      opt_newContents?: string) {
     super(opt_comment);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.COMMENT_CHANGE;
 
     if (!opt_comment) {
@@ -55,9 +60,9 @@ class CommentChange extends CommentBase {
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['oldContents'] = this.oldContents_;
     json['newContents'] = this.newContents_;
@@ -66,9 +71,9 @@ class CommentChange extends CommentBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.oldContents_ = json['oldContents'];
     this.newContents_ = json['newContents'];
@@ -76,17 +81,17 @@ class CommentChange extends CommentBase {
 
   /**
    * 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.oldContents_ === this.newContents_;
   }
 
   /**
    * 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 comment = workspace.getCommentById(this.commentId);
     if (!comment) {
@@ -101,5 +106,3 @@ class CommentChange extends CommentBase {
 
 registry.register(
     registry.Type.EVENT, eventUtils.COMMENT_CHANGE, CommentChange);
-
-exports.CommentChange = CommentChange;

package/core/events/events_comment_create.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { WorkspaceComment } from '../workspace_comment.js';
+import { CommentBase } from './events_comment_base.js';
+/**
+ * Class for a comment creation event.
+ * @alias Blockly.Events.CommentCreate
+ */
+export declare class CommentCreate extends CommentBase {
+    type: string;
+    xml: any;
+    /**
+     * @param opt_comment The created comment.
+     *     Undefined for a blank event.
+     */
+    constructor(opt_comment?: WorkspaceComment);
+    /**
+     * 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_comment_create.js → events_comment_create.ts}

@@ -7,54 +7,54 @@
 /**
  * @fileoverview Class for comment creation event.
  */
-'use strict';
 
 /**
  * Class for comment creation event.
  * @class
  */
-goog.module('Blockly.Events.CommentCreate');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.CommentCreate');
 
-const Xml = goog.require('Blockly.Xml');
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {CommentBase} = goog.require('Blockly.Events.CommentBase');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
+import * as registry from '../registry.js';
+import type {WorkspaceComment} from '../workspace_comment.js';
+import * as Xml from '../xml.js';
+
+import {CommentBase} from './events_comment_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a comment creation event.
- * @extends {CommentBase}
  * @alias Blockly.Events.CommentCreate
  */
-class CommentCreate extends CommentBase {
+export class CommentCreate extends CommentBase {
+  override type: string;
+
+  xml: AnyDuringMigration;
+
   /**
-   * @param {!WorkspaceComment=} opt_comment The created comment.
+   * @param opt_comment The created comment.
    *     Undefined for a blank event.
    */
-  constructor(opt_comment) {
+  constructor(opt_comment?: WorkspaceComment) {
     super(opt_comment);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.COMMENT_CREATE;
 
     if (!opt_comment) {
-      return;  // Blank event to be populated by fromJson.
+      return;
     }
-
+    // Blank event to be populated by fromJson.
     this.xml = opt_comment.toXmlWithXY();
   }
 
   // TODO (#1266): "Full" and "minimal" serialization.
   /**
    * 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);
     return json;
@@ -62,23 +62,21 @@ class CommentCreate extends CommentBase {
 
   /**
    * 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']);
   }
 
   /**
    * 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) {
     CommentBase.CommentCreateDeleteHelper(this, forward);
   }
 }
 
 registry.register(
     registry.Type.EVENT, eventUtils.COMMENT_CREATE, CommentCreate);
-
-exports.CommentCreate = CommentCreate;

package/core/events/events_comment_delete.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { WorkspaceComment } from '../workspace_comment.js';
+import { CommentBase } from './events_comment_base.js';
+/**
+ * Class for a comment deletion event.
+ * @alias Blockly.Events.CommentDelete
+ */
+export declare class CommentDelete extends CommentBase {
+    type: string;
+    xml: any;
+    /**
+     * @param opt_comment The deleted comment.
+     *     Undefined for a blank event.
+     */
+    constructor(opt_comment?: WorkspaceComment);
+    /**
+     * 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_comment_delete.js → events_comment_delete.ts}

@@ -7,38 +7,37 @@
 /**
  * @fileoverview Class for comment deletion event.
  */
-'use strict';
 
 /**
  * Class for comment deletion event.
  * @class
  */
-goog.module('Blockly.Events.CommentDelete');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.CommentDelete');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {CommentBase} = goog.require('Blockly.Events.CommentBase');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
+import * as registry from '../registry.js';
+import type {WorkspaceComment} from '../workspace_comment.js';
+
+import {CommentBase} from './events_comment_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a comment deletion event.
- * @extends {CommentBase}
  * @alias Blockly.Events.CommentDelete
  */
-class CommentDelete extends CommentBase {
+export class CommentDelete extends CommentBase {
+  override type: string;
+  xml: AnyDuringMigration;
+
   /**
-   * @param {!WorkspaceComment=} opt_comment The deleted comment.
+   * @param opt_comment The deleted comment.
    *     Undefined for a blank event.
    */
-  constructor(opt_comment) {
+  constructor(opt_comment?: WorkspaceComment) {
     super(opt_comment);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.COMMENT_DELETE;
 
     if (!opt_comment) {
@@ -47,35 +46,32 @@ class CommentDelete extends CommentBase {
 
     this.xml = opt_comment.toXmlWithXY();
   }
-
   // TODO (#1266): "Full" and "minimal" serialization.
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     return json;
   }
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
   }
 
   /**
    * 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) {
     CommentBase.CommentCreateDeleteHelper(this, !forward);
   }
 }
 
 registry.register(
     registry.Type.EVENT, eventUtils.COMMENT_DELETE, CommentDelete);
-
-exports.CommentDelete = CommentDelete;

package/core/events/events_comment_move.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Coordinate } from '../utils/coordinate.js';
+import type { WorkspaceComment } from '../workspace_comment.js';
+import { CommentBase } from './events_comment_base.js';
+/**
+ * Class for a comment move event.  Created before the move.
+ * @alias Blockly.Events.CommentMove
+ */
+export declare class CommentMove extends CommentBase {
+    type: string;
+    comment_: WorkspaceComment;
+    oldCoordinate_: Coordinate;
+    /** The location after the move, in workspace coordinates. */
+    newCoordinate_: Coordinate;
+    /**
+     * @param opt_comment The comment that is being moved.  Undefined for a blank
+     *     event.
+     */
+    constructor(opt_comment?: WorkspaceComment);
+    /**
+     * Record the comment's new location.  Called after the move.  Can only be
+     * called once.
+     */
+    recordNew(): void;
+    /**
+     * Override the location before the move.  Use this if you don't create the
+     * event until the end of the move, but you know the original location.
+     * @param xy The location before the move, in workspace coordinates.
+     */
+    setOldCoordinate(xy: Coordinate): void;
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Does this event record any change of state?
+     * @return False if something changed.
+     */
+    isNull(): boolean;
+    /**
+     * Run a move event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}

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

@@ -7,39 +7,47 @@
 /**
  * @fileoverview Class for comment move event.
  */
-'use strict';
 
 /**
  * Class for comment move event.
  * @class
  */
-goog.module('Blockly.Events.CommentMove');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.CommentMove');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {CommentBase} = goog.require('Blockly.Events.CommentBase');
-const {Coordinate} = goog.require('Blockly.utils.Coordinate');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
+import * as registry from '../registry.js';
+import {Coordinate} from '../utils/coordinate.js';
+import type {WorkspaceComment} from '../workspace_comment.js';
+
+import {CommentBase} from './events_comment_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a comment move event.  Created before the move.
- * @extends {CommentBase}
  * @alias Blockly.Events.CommentMove
  */
-class CommentMove extends CommentBase {
+export class CommentMove extends CommentBase {
+  override type: string;
+
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  comment_!: WorkspaceComment;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  oldCoordinate_!: Coordinate;
+
+  /** The location after the move, in workspace coordinates. */
+  // AnyDuringMigration because:  Type 'null' is not assignable to type
+  // 'Coordinate'.
+  newCoordinate_: Coordinate = null as AnyDuringMigration;
+
   /**
-   * @param {!WorkspaceComment=} opt_comment The comment that is being
-   *     moved.  Undefined for a blank event.
+   * @param opt_comment The comment that is being moved.  Undefined for a blank
+   *     event.
    */
-  constructor(opt_comment) {
+  constructor(opt_comment?: WorkspaceComment) {
     super(opt_comment);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.COMMENT_MOVE;
 
     if (!opt_comment) {
@@ -49,21 +57,11 @@ class CommentMove extends CommentBase {
     /**
      * The comment that is being moved.  Will be cleared after recording the new
      * location.
-     * @type {WorkspaceComment}
      */
     this.comment_ = opt_comment;
 
-    /**
-     * The location before the move, in workspace coordinates.
-     * @type {!Coordinate}
-     */
+    /** The location before the move, in workspace coordinates. */
     this.oldCoordinate_ = opt_comment.getXY();
-
-    /**
-     * The location after the move, in workspace coordinates.
-     * @type {Coordinate}
-     */
-    this.newCoordinate_ = null;
   }
 
   /**
@@ -77,25 +75,26 @@ class CommentMove extends CommentBase {
           'same event twice.');
     }
     this.newCoordinate_ = this.comment_.getXY();
-    this.comment_ = null;
+    // AnyDuringMigration because:  Type 'null' is not assignable to type
+    // 'WorkspaceComment'.
+    this.comment_ = null as AnyDuringMigration;
   }
 
   /**
    * Override the location before the move.  Use this if you don't create the
    * event until the end of the move, but you know the original location.
-   * @param {!Coordinate} xy The location before the move,
-   *     in workspace coordinates.
+   * @param xy The location before the move, in workspace coordinates.
    */
-  setOldCoordinate(xy) {
+  setOldCoordinate(xy: Coordinate) {
     this.oldCoordinate_ = xy;
   }
 
   // TODO (#1266): "Full" and "minimal" serialization.
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     if (this.oldCoordinate_) {
       json['oldCoordinate'] = Math.round(this.oldCoordinate_.x) + ',' +
@@ -110,9 +109,9 @@ class CommentMove extends CommentBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
 
     if (json['oldCoordinate']) {
@@ -127,17 +126,17 @@ class CommentMove extends CommentBase {
 
   /**
    * Does this event record any change of state?
-   * @return {boolean} False if something changed.
+   * @return False if something changed.
    */
-  isNull() {
+  override isNull(): boolean {
     return Coordinate.equals(this.oldCoordinate_, this.newCoordinate_);
   }
 
   /**
    * Run a move 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 comment = workspace.getCommentById(this.commentId);
     if (!comment) {
@@ -153,5 +152,3 @@ class CommentMove extends CommentBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.COMMENT_MOVE, CommentMove);
-
-exports.CommentMove = CommentMove;

package/core/events/events_marker_move.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from '../block.js';
+import { ASTNode } from '../keyboard_nav/ast_node.js';
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a marker move event.
+ * @alias Blockly.Events.MarkerMove
+ */
+export declare class MarkerMove extends UiBase {
+    blockId: string | null;
+    oldNode?: ASTNode | null;
+    newNode?: ASTNode;
+    isCursor?: boolean;
+    type: string;
+    /**
+     * @param opt_block The affected block. Null if current node is of type
+     *     workspace. Undefined for a blank event.
+     * @param isCursor Whether this is a cursor event. Undefined for a blank
+     *     event.
+     * @param opt_oldNode The old node the marker used to be on.
+     *    Undefined for a blank event.
+     * @param opt_newNode The new node the marker is now on.
+     *    Undefined for a blank event.
+     */
+    constructor(opt_block?: Block | null, isCursor?: boolean, opt_oldNode?: ASTNode | null, opt_newNode?: ASTNode);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+}