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

package/core/events/events_comment_change.ts

@@ -1,108 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for comment change event.
- */
-
-/**
- * Class for comment change event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.CommentChange');
-
-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.
- * @alias Blockly.Events.CommentChange
- */
-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 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) {
-    super(opt_comment);
-
-    /** Type of this event. */
-    this.type = eventUtils.COMMENT_CHANGE;
-
-    if (!opt_comment) {
-      return;  // Blank event to be populated by fromJson.
-    }
-
-    this.oldContents_ =
-        typeof opt_oldContents === 'undefined' ? '' : opt_oldContents;
-    this.newContents_ =
-        typeof opt_newContents === 'undefined' ? '' : opt_newContents;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['oldContents'] = this.oldContents_;
-    json['newContents'] = this.newContents_;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.oldContents_ = json['oldContents'];
-    this.newContents_ = json['newContents'];
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return False if something changed.
-   */
-  override isNull(): boolean {
-    return this.oldContents_ === this.newContents_;
-  }
-
-  /**
-   * Run a change event.
-   * @param forward True if run forward, false if run backward (undo).
-   */
-  override run(forward: boolean) {
-    const workspace = this.getEventWorkspace_();
-    const comment = workspace.getCommentById(this.commentId);
-    if (!comment) {
-      console.warn('Can\'t change non-existent comment: ' + this.commentId);
-      return;
-    }
-    const contents = forward ? this.newContents_ : this.oldContents_;
-
-    comment.setContent(contents);
-  }
-}
-
-registry.register(
-    registry.Type.EVENT, eventUtils.COMMENT_CHANGE, CommentChange);

package/core/events/events_comment_create.ts

@@ -1,82 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for comment creation event.
- */
-
-/**
- * Class for comment creation event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.CommentCreate');
-
-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.
- * @alias Blockly.Events.CommentCreate
- */
-export class CommentCreate extends CommentBase {
-  override type: string;
-
-  xml: AnyDuringMigration;
-
-  /**
-   * @param opt_comment The created comment.
-   *     Undefined for a blank event.
-   */
-  constructor(opt_comment?: WorkspaceComment) {
-    super(opt_comment);
-
-    /** Type of this event. */
-    this.type = eventUtils.COMMENT_CREATE;
-
-    if (!opt_comment) {
-      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 JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['xml'] = Xml.domToText(this.xml);
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.xml = Xml.textToDom(json['xml']);
-  }
-
-  /**
-   * Run a creation event.
-   * @param forward True if run forward, false if run backward (undo).
-   */
-  override run(forward: boolean) {
-    CommentBase.CommentCreateDeleteHelper(this, forward);
-  }
-}
-
-registry.register(
-    registry.Type.EVENT, eventUtils.COMMENT_CREATE, CommentCreate);

package/core/events/events_comment_delete.ts

@@ -1,77 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for comment deletion event.
- */
-
-/**
- * Class for comment deletion event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.CommentDelete');
-
-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.
- * @alias Blockly.Events.CommentDelete
- */
-export class CommentDelete extends CommentBase {
-  override type: string;
-  xml: AnyDuringMigration;
-
-  /**
-   * @param opt_comment The deleted comment.
-   *     Undefined for a blank event.
-   */
-  constructor(opt_comment?: WorkspaceComment) {
-    super(opt_comment);
-
-    /** Type of this event. */
-    this.type = eventUtils.COMMENT_DELETE;
-
-    if (!opt_comment) {
-      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 JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-  }
-
-  /**
-   * Run a creation event.
-   * @param forward True if run forward, false if run backward (undo).
-   */
-  override run(forward: boolean) {
-    CommentBase.CommentCreateDeleteHelper(this, !forward);
-  }
-}
-
-registry.register(
-    registry.Type.EVENT, eventUtils.COMMENT_DELETE, CommentDelete);

package/core/events/events_comment_move.ts

@@ -1,154 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for comment move event.
- */
-
-/**
- * Class for comment move event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.CommentMove');
-
-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.
- * @alias Blockly.Events.CommentMove
- */
-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 opt_comment The comment that is being moved.  Undefined for a blank
-   *     event.
-   */
-  constructor(opt_comment?: WorkspaceComment) {
-    super(opt_comment);
-
-    /** Type of this event. */
-    this.type = eventUtils.COMMENT_MOVE;
-
-    if (!opt_comment) {
-      return;  // Blank event to be populated by fromJson.
-    }
-
-    /**
-     * The comment that is being moved.  Will be cleared after recording the new
-     * location.
-     */
-    this.comment_ = opt_comment;
-
-    /** The location before the move, in workspace coordinates. */
-    this.oldCoordinate_ = opt_comment.getXY();
-  }
-
-  /**
-   * Record the comment's new location.  Called after the move.  Can only be
-   * called once.
-   */
-  recordNew() {
-    if (!this.comment_) {
-      throw Error(
-          'Tried to record the new position of a comment on the ' +
-          'same event twice.');
-    }
-    this.newCoordinate_ = this.comment_.getXY();
-    // 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 xy The location before the move, in workspace coordinates.
-   */
-  setOldCoordinate(xy: Coordinate) {
-    this.oldCoordinate_ = xy;
-  }
-
-  // TODO (#1266): "Full" and "minimal" serialization.
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    if (this.oldCoordinate_) {
-      json['oldCoordinate'] = Math.round(this.oldCoordinate_.x) + ',' +
-          Math.round(this.oldCoordinate_.y);
-    }
-    if (this.newCoordinate_) {
-      json['newCoordinate'] = Math.round(this.newCoordinate_.x) + ',' +
-          Math.round(this.newCoordinate_.y);
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-
-    if (json['oldCoordinate']) {
-      const xy = json['oldCoordinate'].split(',');
-      this.oldCoordinate_ = new Coordinate(Number(xy[0]), Number(xy[1]));
-    }
-    if (json['newCoordinate']) {
-      const xy = json['newCoordinate'].split(',');
-      this.newCoordinate_ = new Coordinate(Number(xy[0]), Number(xy[1]));
-    }
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return False if something changed.
-   */
-  override isNull(): boolean {
-    return Coordinate.equals(this.oldCoordinate_, this.newCoordinate_);
-  }
-
-  /**
-   * Run a move event.
-   * @param forward True if run forward, false if run backward (undo).
-   */
-  override run(forward: boolean) {
-    const workspace = this.getEventWorkspace_();
-    const comment = workspace.getCommentById(this.commentId);
-    if (!comment) {
-      console.warn('Can\'t move non-existent comment: ' + this.commentId);
-      return;
-    }
-
-    const target = forward ? this.newCoordinate_ : this.oldCoordinate_;
-    // TODO: Check if the comment is being dragged, and give up if so.
-    const current = comment.getXY();
-    comment.moveBy(target.x - current.x, target.y - current.y);
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.COMMENT_MOVE, CommentMove);

package/core/events/events_marker_move.ts

@@ -1,99 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of a marker move.
- */
-
-/**
- * Events fired as a result of a marker move.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.MarkerMove');
-
-import type {Block} from '../block.js';
-import {ASTNode} from '../keyboard_nav/ast_node.js';
-import * as registry from '../registry.js';
-import type {Workspace} from '../workspace.js';
-
-import {UiBase} from './events_ui_base.js';
-import * as eventUtils from './utils.js';
-
-
-/**
- * Class for a marker move event.
- * @alias Blockly.Events.MarkerMove
- */
-export class MarkerMove extends UiBase {
-  blockId: string|null;
-  oldNode?: ASTNode|null;
-  newNode?: ASTNode;
-  isCursor?: boolean;
-  override 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) {
-    let workspaceId = opt_block ? opt_block.workspace.id : undefined;
-    if (opt_newNode && opt_newNode.getType() === ASTNode.types.WORKSPACE) {
-      workspaceId = (opt_newNode.getLocation() as Workspace).id;
-    }
-    super(workspaceId);
-
-    /** The workspace identifier for this event. */
-    this.blockId = opt_block ? opt_block.id : null;
-
-    /** The old node the marker used to be on. */
-    this.oldNode = opt_oldNode;
-
-    /** The new node the  marker is now on. */
-    this.newNode = opt_newNode;
-
-    /** Whether this is a cursor event. */
-    this.isCursor = isCursor;
-
-    /** Type of this event. */
-    this.type = eventUtils.MARKER_MOVE;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['isCursor'] = this.isCursor;
-    json['blockId'] = this.blockId;
-    json['oldNode'] = this.oldNode;
-    json['newNode'] = this.newNode;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.isCursor = json['isCursor'];
-    this.blockId = json['blockId'];
-    this.oldNode = json['oldNode'];
-    this.newNode = json['newNode'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.MARKER_MOVE, MarkerMove);

package/core/events/events_selected.ts

@@ -1,78 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of element select action.
- */
-
-/**
- * Events fired as a result of element select action.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.Selected');
-
-import * as registry from '../registry.js';
-
-import {UiBase} from './events_ui_base.js';
-import * as eventUtils from './utils.js';
-
-
-/**
- * Class for a selected event.
- * @alias Blockly.Events.Selected
- */
-export class Selected extends UiBase {
-  oldElementId?: string|null;
-  newElementId?: string|null;
-  override type: string;
-
-  /**
-   * @param opt_oldElementId The ID of the previously selected element. Null if
-   *     no element last selected. Undefined for a blank event.
-   * @param opt_newElementId The ID of the selected element. Null if no element
-   *     currently selected (deselect). Undefined for a blank event.
-   * @param opt_workspaceId The workspace identifier for this event.
-   *    Null if no element previously selected. Undefined for a blank event.
-   */
-  constructor(
-      opt_oldElementId?: string|null, opt_newElementId?: string|null,
-      opt_workspaceId?: string) {
-    super(opt_workspaceId);
-
-    /** The id of the last selected element. */
-    this.oldElementId = opt_oldElementId;
-
-    /** The id of the selected element. */
-    this.newElementId = opt_newElementId;
-
-    /** Type of this event. */
-    this.type = eventUtils.SELECTED;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['oldElementId'] = this.oldElementId;
-    json['newElementId'] = this.newElementId;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.oldElementId = json['oldElementId'];
-    this.newElementId = json['newElementId'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.SELECTED, Selected);

package/core/events/events_theme_change.ts

@@ -1,67 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of a theme update.
- */
-
-/**
- * Events fired as a result of a theme update.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.ThemeChange');
-
-import * as registry from '../registry.js';
-
-import {UiBase} from './events_ui_base.js';
-import * as eventUtils from './utils.js';
-
-
-/**
- * Class for a theme change event.
- * @alias Blockly.Events.ThemeChange
- */
-export class ThemeChange extends UiBase {
-  themeName?: string;
-  override type: string;
-
-  /**
-   * @param opt_themeName The theme name. Undefined for a blank event.
-   * @param opt_workspaceId The workspace identifier for this event.
-   *    event. Undefined for a blank event.
-   */
-  constructor(opt_themeName?: string, opt_workspaceId?: string) {
-    super(opt_workspaceId);
-
-    /** The theme name. */
-    this.themeName = opt_themeName;
-
-    /** Type of this event. */
-    this.type = eventUtils.THEME_CHANGE;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['themeName'] = this.themeName;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.themeName = json['themeName'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.THEME_CHANGE, ThemeChange);