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

package/core/events/events_block_delete.ts

@@ -1,126 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for a block delete event.
- */
-
-/**
- * Class for a block delete event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.BlockDelete');
-
-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.
- * @alias Blockly.Events.BlockDelete
- */
-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. */
-    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.');
-    }
-    if (opt_block.isShadow()) {
-      // Respawning shadow blocks is handled via disconnection.
-      this.recordUndo = false;
-    }
-
-    this.oldXml = Xml.blockToDomWithXY(opt_block);
-    this.ids = eventUtils.getDescendantIds(opt_block);
-
-    /** Was the block that was just deleted a shadow? */
-    this.wasShadow = opt_block.isShadow();
-
-    /** 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 JSON representation.
-   */
-  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;
-    if (!this.recordUndo) {
-      json['recordUndo'] = this.recordUndo;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  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 = json['oldJson'] as blocks.State;
-    if (json['recordUndo'] !== undefined) {
-      this.recordUndo = json['recordUndo'];
-    }
-  }
-
-  /**
-   * Run a deletion event.
-   * @param forward True if run forward, false if run backward (undo).
-   */
-  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);
-        } else if (id === this.blockId) {
-          // Only complain about root-level block.
-          console.warn('Can\'t delete non-existent block: ' + id);
-        }
-      }
-    } else {
-      blocks.append(this.oldJson, workspace);
-    }
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.DELETE, BlockDelete);

package/core/events/events_block_drag.ts

@@ -1,82 +0,0 @@
-/**
- * @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);

package/core/events/events_block_move.ts

@@ -1,206 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for a block move event.
- */
-
-/**
- * Class for a block move event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.BlockMove');
-
-import type {Block} from '../block.js';
-import {ConnectionType} from '../connection_type.js';
-import * as registry from '../registry.js';
-import {Coordinate} from '../utils/coordinate.js';
-
-import {BlockBase} from './events_block_base.js';
-import * as eventUtils from './utils.js';
-
-
-interface BlockLocation {
-  parentId: string;
-  inputName: string;
-  coordinate: Coordinate|null;
-}  // eslint-disable-line no-unused-vars
-
-/**
- * Class for a block move event.  Created before the move.
- * @alias Blockly.Events.BlockMove
- */
-export class BlockMove extends BlockBase {
-  override type: string;
-  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
-  oldParentId!: string;
-  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
-  oldInputName!: string;
-  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
-  oldCoordinate!: Coordinate|null;
-
-  newParentId: string|null = null;
-  newInputName: string|null = null;
-  newCoordinate: Coordinate|null = null;
-
-  /** @param opt_block The moved block.  Undefined for a blank event. */
-  constructor(opt_block?: Block) {
-    super(opt_block);
-
-    /** Type of this event. */
-    this.type = eventUtils.BLOCK_MOVE;
-
-    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;
-    }
-
-    const location = this.currentLocation_();
-    this.oldParentId = location.parentId;
-    this.oldInputName = location.inputName;
-    this.oldCoordinate = location.coordinate;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    if (this.newParentId) {
-      json['newParentId'] = this.newParentId;
-    }
-    if (this.newInputName) {
-      json['newInputName'] = this.newInputName;
-    }
-    if (this.newCoordinate) {
-      json['newCoordinate'] = Math.round(this.newCoordinate.x) + ',' +
-          Math.round(this.newCoordinate.y);
-    }
-    if (!this.recordUndo) {
-      json['recordUndo'] = this.recordUndo;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.newParentId = json['newParentId'];
-    this.newInputName = json['newInputName'];
-    if (json['newCoordinate']) {
-      const xy = json['newCoordinate'].split(',');
-      this.newCoordinate = new Coordinate(Number(xy[0]), Number(xy[1]));
-    }
-    if (json['recordUndo'] !== undefined) {
-      this.recordUndo = json['recordUndo'];
-    }
-  }
-
-  /** Record the block's new location.  Called after the move. */
-  recordNew() {
-    const location = this.currentLocation_();
-    this.newParentId = location.parentId;
-    this.newInputName = location.inputName;
-    this.newCoordinate = location.coordinate;
-  }
-
-  /**
-   * Returns the parentId and input if the block is connected,
-   *   or the XY location if disconnected.
-   * @return Collection of location info.
-   */
-  private currentLocation_(): BlockLocation {
-    const workspace = this.getEventWorkspace_();
-    const block = workspace.getBlockById(this.blockId);
-    const location = {} as BlockLocation;
-    const parent = block!.getParent();
-    if (parent) {
-      location.parentId = parent.id;
-      // AnyDuringMigration because:  Argument of type 'Block | null' is not
-      // assignable to parameter of type 'Block'.
-      const input = parent.getInputWithBlock(block as AnyDuringMigration);
-      if (input) {
-        location.inputName = input.name;
-      }
-    } else {
-      location.coordinate = block!.getRelativeToSurfaceXY();
-    }
-    return location;
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return False if something changed.
-   */
-  override isNull(): boolean {
-    return this.oldParentId === this.newParentId &&
-        this.oldInputName === this.newInputName &&
-        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 block = workspace.getBlockById(this.blockId);
-    if (!block) {
-      console.warn('Can\'t move non-existent block: ' + this.blockId);
-      return;
-    }
-    const parentId = forward ? this.newParentId : this.oldParentId;
-    const inputName = forward ? this.newInputName : this.oldInputName;
-    const coordinate = forward ? this.newCoordinate : this.oldCoordinate;
-    let parentBlock: Block|null;
-    if (parentId) {
-      parentBlock = workspace.getBlockById(parentId);
-      if (!parentBlock) {
-        console.warn('Can\'t connect to non-existent block: ' + parentId);
-        return;
-      }
-    }
-    if (block.getParent()) {
-      block.unplug();
-    }
-    if (coordinate) {
-      const xy = block.getRelativeToSurfaceXY();
-      block.moveBy(coordinate.x - xy.x, coordinate.y - xy.y);
-    } else {
-      let blockConnection = block.outputConnection;
-      if (!blockConnection ||
-          block.previousConnection && block.previousConnection.isConnected()) {
-        blockConnection = block.previousConnection;
-      }
-      let parentConnection;
-      const connectionType = blockConnection.type;
-      if (inputName) {
-        const input = parentBlock!.getInput(inputName);
-        if (input) {
-          parentConnection = input.connection;
-        }
-      } else if (connectionType === ConnectionType.PREVIOUS_STATEMENT) {
-        parentConnection = parentBlock!.nextConnection;
-      }
-      if (parentConnection) {
-        blockConnection.connect(parentConnection);
-      } else {
-        console.warn('Can\'t connect to non-existent input: ' + inputName);
-      }
-    }
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.MOVE, BlockMove);

package/core/events/events_bubble_open.ts

@@ -1,82 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of bubble open.
- */
-
-/**
- * Events fired as a result of bubble open.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.BubbleOpen');
-
-import type {BlockSvg} from '../block_svg.js';
-import * as registry from '../registry.js';
-
-import {UiBase} from './events_ui_base.js';
-import * as eventUtils from './utils.js';
-
-
-/**
- * Class for a bubble open event.
- * @alias Blockly.Events.BubbleOpen
- */
-export class BubbleOpen extends UiBase {
-  blockId: string|null;
-  isOpen?: boolean;
-  bubbleType?: string;
-  override type: string;
-
-  /**
-   * @param opt_block The associated block. Undefined for a blank event.
-   * @param opt_isOpen Whether the bubble is opening (false if closing).
-   *     Undefined for a blank event.
-   * @param opt_bubbleType The type of bubble. One of 'mutator', 'comment' or
-   *     'warning'. Undefined for a blank event.
-   */
-  constructor(
-      opt_block: BlockSvg, opt_isOpen?: boolean, opt_bubbleType?: string) {
-    const workspaceId = opt_block ? opt_block.workspace.id : undefined;
-    super(workspaceId);
-    this.blockId = opt_block ? opt_block.id : null;
-
-    /** Whether the bubble is opening (false if closing). */
-    this.isOpen = opt_isOpen;
-
-    /** The type of bubble. One of 'mutator', 'comment', or 'warning'. */
-    this.bubbleType = opt_bubbleType;
-
-    /** Type of this event. */
-    this.type = eventUtils.BUBBLE_OPEN;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['isOpen'] = this.isOpen;
-    json['bubbleType'] = this.bubbleType;
-    json['blockId'] = this.blockId;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.isOpen = json['isOpen'];
-    this.bubbleType = json['bubbleType'];
-    this.blockId = json['blockId'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.BUBBLE_OPEN, BubbleOpen);

package/core/events/events_click.ts

@@ -1,84 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of UI click in Blockly's editor.
- */
-
-/**
- * Events fired as a result of UI click in Blockly's editor.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.Click');
-
-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 click event.
- * @alias Blockly.Events.Click
- */
-export class Click extends UiBase {
-  blockId: AnyDuringMigration;
-  targetType?: string;
-  override type: string;
-
-  /**
-   * @param opt_block The affected block. Null for click events that do not have
-   *     an associated block (i.e. workspace click). Undefined for a blank
-   *     event.
-   * @param opt_workspaceId The workspace identifier for this event.
-   *    Not used if block is passed. Undefined for a blank event.
-   * @param opt_targetType The type of element targeted by this click event.
-   *     Undefined for a blank event.
-   */
-  constructor(
-      opt_block?: Block|null, opt_workspaceId?: string|null,
-      opt_targetType?: string) {
-    let workspaceId = opt_block ? opt_block.workspace.id : opt_workspaceId;
-    if (workspaceId === null) {
-      workspaceId = undefined;
-    }
-    super(workspaceId);
-    this.blockId = opt_block ? opt_block.id : null;
-
-    /** The type of element targeted by this click event. */
-    this.targetType = opt_targetType;
-
-    /** Type of this event. */
-    this.type = eventUtils.CLICK;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['targetType'] = this.targetType;
-    if (this.blockId) {
-      json['blockId'] = this.blockId;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.targetType = json['targetType'];
-    this.blockId = json['blockId'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.CLICK, Click);

package/core/events/events_comment_base.ts

@@ -1,107 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base class for comment events.
- */
-
-/**
- * Base class for comment events.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.CommentBase');
-
-import * as utilsXml from '../utils/xml.js';
-import type {WorkspaceComment} from '../workspace_comment.js';
-import * as Xml from '../xml.js';
-
-import {Abstract as AbstractEvent} from './events_abstract.js';
-import type {CommentCreate} from './events_comment_create.js';
-import type {CommentDelete} from './events_comment_delete.js';
-import * as eventUtils from './utils.js';
-
-
-/**
- * Abstract class for a comment event.
- * @alias Blockly.Events.CommentBase
- */
-export class CommentBase extends AbstractEvent {
-  override isBlank: boolean;
-  commentId: string;
-  override workspaceId: string;
-
-  /**
-   * @param opt_comment The comment this event corresponds to.  Undefined for a
-   *     blank event.
-   */
-  constructor(opt_comment?: WorkspaceComment) {
-    super();
-    /** Whether or not an event is blank. */
-    this.isBlank = typeof opt_comment === 'undefined';
-
-    /** The ID of the comment this event pertains to. */
-    this.commentId = this.isBlank ? '' : opt_comment!.id;
-
-    /** The workspace identifier for this event. */
-    this.workspaceId = this.isBlank ? '' : opt_comment!.workspace.id;
-
-    /**
-     * The event group id for the group this event belongs to. Groups define
-     * events that should be treated as an single action from the user's
-     * perspective, and should be undone together.
-     */
-    this.group = eventUtils.getGroup();
-
-    /** Sets whether the event should be added to the undo stack. */
-    this.recordUndo = eventUtils.getRecordUndo();
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    if (this.commentId) {
-      json['commentId'] = this.commentId;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.commentId = json['commentId'];
-  }
-
-  /**
-   * Helper function for Comment[Create|Delete]
-   * @param event The event to run.
-   * @param create if True then Create, if False then Delete
-   */
-  static CommentCreateDeleteHelper(
-      event: CommentCreate|CommentDelete, create: boolean) {
-    const workspace = event.getEventWorkspace_();
-    if (create) {
-      const xmlElement = utilsXml.createElement('xml');
-      xmlElement.appendChild(event.xml);
-      Xml.domToWorkspace(xmlElement, workspace);
-    } else {
-      const comment = workspace.getCommentById(event.commentId);
-      if (comment) {
-        comment.dispose();
-      } else {
-        // Only complain about root-level block.
-        console.warn(
-            'Can\'t uncreate non-existent comment: ' + event.commentId);
-      }
-    }
-  }
-}