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

package/core/events/events.ts

@@ -1,123 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of actions in Blockly's editor.
- */
-
-/**
- * Events fired as a result of actions in Blockly's editor.
- * @namespace Blockly.Events
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events');
-
-import * as deprecation from '../utils/deprecation.js';
-
-import {Abstract as AbstractEvent} from './events_abstract.js';
-import {BlockBase} from './events_block_base.js';
-import {BlockChange} from './events_block_change.js';
-import {BlockCreate} from './events_block_create.js';
-import {BlockDelete} from './events_block_delete.js';
-import {BlockDrag} from './events_block_drag.js';
-import {BlockMove} from './events_block_move.js';
-import {BubbleOpen} from './events_bubble_open.js';
-import {Click} from './events_click.js';
-import {CommentBase} from './events_comment_base.js';
-import {CommentChange} from './events_comment_change.js';
-import {CommentCreate} from './events_comment_create.js';
-import {CommentDelete} from './events_comment_delete.js';
-import {CommentMove} from './events_comment_move.js';
-import {MarkerMove} from './events_marker_move.js';
-import {Selected} from './events_selected.js';
-import {ThemeChange} from './events_theme_change.js';
-import {ToolboxItemSelect} from './events_toolbox_item_select.js';
-import {TrashcanOpen} from './events_trashcan_open.js';
-import {Ui} from './events_ui.js';
-import {UiBase} from './events_ui_base.js';
-import {VarBase} from './events_var_base.js';
-import {VarCreate} from './events_var_create.js';
-import {VarDelete} from './events_var_delete.js';
-import {VarRename} from './events_var_rename.js';
-import {ViewportChange} from './events_viewport.js';
-import * as eventUtils from './utils.js';
-import {FinishedLoading} from './workspace_events.js';
-
-
-// Events.
-export const Abstract = AbstractEvent;
-export {BubbleOpen};
-export {BlockBase};
-export {BlockChange};
-export {BlockCreate};
-export {BlockDelete};
-export {BlockDrag};
-export {BlockMove};
-export {Click};
-export {CommentBase};
-export {CommentChange};
-export {CommentCreate};
-export {CommentDelete};
-export {CommentMove};
-export {FinishedLoading};
-export {MarkerMove};
-export {Selected};
-export {ThemeChange};
-export {ToolboxItemSelect};
-export {TrashcanOpen};
-export {Ui};
-export {UiBase};
-export {VarBase};
-export {VarCreate};
-export {VarDelete};
-export {VarRename};
-export {ViewportChange};
-
-// Event types.
-export const BLOCK_CHANGE = eventUtils.BLOCK_CHANGE;
-export const BLOCK_CREATE = eventUtils.BLOCK_CREATE;
-export const BLOCK_DELETE = eventUtils.BLOCK_DELETE;
-export const BLOCK_DRAG = eventUtils.BLOCK_DRAG;
-export const BLOCK_MOVE = eventUtils.BLOCK_MOVE;
-export const BUBBLE_OPEN = eventUtils.BUBBLE_OPEN;
-export type BumpEvent = eventUtils.BumpEvent;
-export const BUMP_EVENTS = eventUtils.BUMP_EVENTS;
-export const CHANGE = eventUtils.CHANGE;
-export const CLICK = eventUtils.CLICK;
-export const COMMENT_CHANGE = eventUtils.COMMENT_CHANGE;
-export const COMMENT_CREATE = eventUtils.COMMENT_CREATE;
-export const COMMENT_DELETE = eventUtils.COMMENT_DELETE;
-export const COMMENT_MOVE = eventUtils.COMMENT_MOVE;
-export const CREATE = eventUtils.CREATE;
-export const DELETE = eventUtils.DELETE;
-export const FINISHED_LOADING = eventUtils.FINISHED_LOADING;
-export const MARKER_MOVE = eventUtils.MARKER_MOVE;
-export const MOVE = eventUtils.MOVE;
-export const SELECTED = eventUtils.SELECTED;
-export const THEME_CHANGE = eventUtils.THEME_CHANGE;
-export const TOOLBOX_ITEM_SELECT = eventUtils.TOOLBOX_ITEM_SELECT;
-export const TRASHCAN_OPEN = eventUtils.TRASHCAN_OPEN;
-export const UI = eventUtils.UI;
-export const VAR_CREATE = eventUtils.VAR_CREATE;
-export const VAR_DELETE = eventUtils.VAR_DELETE;
-export const VAR_RENAME = eventUtils.VAR_RENAME;
-export const VIEWPORT_CHANGE = eventUtils.VIEWPORT_CHANGE;
-
-// Event utils.
-export const clearPendingUndo = eventUtils.clearPendingUndo;
-export const disable = eventUtils.disable;
-export const enable = eventUtils.enable;
-export const filter = eventUtils.filter;
-export const fire = eventUtils.fire;
-export const fromJson = eventUtils.fromJson;
-export const getDescendantIds = eventUtils.getDescendantIds;
-export const get = eventUtils.get;
-export const getGroup = eventUtils.getGroup;
-export const getRecordUndo = eventUtils.getRecordUndo;
-export const isEnabled = eventUtils.isEnabled;
-export const setGroup = eventUtils.setGroup;
-export const setRecordUndo = eventUtils.setRecordUndo;
-export const disableOrphans = eventUtils.disableOrphans;

package/core/events/events_abstract.ts

@@ -1,112 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Abstract class for events fired as a result of actions in
- * Blockly's editor.
- */
-
-/**
- * Abstract class for events fired as a result of actions in
- * Blockly's editor.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.Abstract');
-
-import * as common from '../common.js';
-import type {Workspace} from '../workspace.js';
-
-import * as eventUtils from './utils.js';
-
-
-/**
- * Abstract class for an event.
- * @alias Blockly.Events.Abstract
- */
-export abstract class Abstract {
-  /** Whether or not the event is blank (to be populated by fromJson). */
-  isBlank: boolean|null = null;
-
-  /** The workspace identifier for this event. */
-  workspaceId?: string = undefined;
-  group: string;
-  recordUndo: boolean;
-
-  /** Whether or not the event is a UI event. */
-  isUiEvent = false;
-
-  /** Type of this event. */
-  type?: string = undefined;
-
-  /** @alias Blockly.Events.Abstract */
-  constructor() {
-    /**
-     * 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.
-   */
-  toJson(): AnyDuringMigration {
-    const json = {'type': this.type};
-    if (this.group) {
-      (json as AnyDuringMigration)['group'] = this.group;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  fromJson(json: AnyDuringMigration) {
-    this.isBlank = false;
-    this.group = json['group'];
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return True if null, false if something changed.
-   */
-  isNull(): boolean {
-    return false;
-  }
-
-  /**
-   * Run an event.
-   * @param _forward True if run forward, false if run backward (undo).
-   */
-  run(_forward: boolean) {}
-  // Defined by subclasses.
-
-  /**
-   * Get workspace the event belongs to.
-   * @return The workspace the event belongs to.
-   * @throws {Error} if workspace is null.
-   * @internal
-   */
-  getEventWorkspace_(): Workspace {
-    let workspace;
-    if (this.workspaceId) {
-      workspace = common.getWorkspaceById(this.workspaceId);
-    }
-    if (!workspace) {
-      throw Error(
-          'Workspace is null. Event must have been generated from real' +
-          ' Blockly events.');
-    }
-    return workspace;
-  }
-}

package/core/events/events_block_base.ts

@@ -1,65 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base class for all types of block events.
- */
-
-/**
- * Base class for all types of block events.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.BlockBase');
-
-import type {Block} from '../block.js';
-
-import {Abstract as AbstractEvent} from './events_abstract.js';
-
-
-/**
- * Abstract class for a block event.
- * @alias Blockly.Events.BlockBase
- */
-export class BlockBase extends AbstractEvent {
-  override isBlank: AnyDuringMigration;
-  blockId: string;
-  override workspaceId: string;
-
-  /**
-   * @param opt_block The block this event corresponds to.
-   *     Undefined for a blank event.
-   */
-  constructor(opt_block?: Block) {
-    super();
-    this.isBlank = typeof opt_block === 'undefined';
-
-    /** The block ID for the block this event pertains to */
-    this.blockId = this.isBlank ? '' : opt_block!.id;
-
-    /** The workspace identifier for this event. */
-    this.workspaceId = this.isBlank ? '' : opt_block!.workspace.id;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['blockId'] = this.blockId;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.blockId = json['blockId'];
-  }
-}

package/core/events/events_block_change.ts

@@ -1,176 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for a block change event.
- */
-
-/**
- * Class for a block change event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.BlockChange');
-
-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.
- * @alias Blockly.Events.BlockChange
- */
-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 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?: Block, opt_element?: string, opt_name?: string|null,
-      opt_oldValue?: AnyDuringMigration, opt_newValue?: AnyDuringMigration) {
-    super(opt_block);
-
-    /** Type of this event. */
-    this.type = eventUtils.BLOCK_CHANGE;
-
-    if (!opt_block) {
-      return;  // Blank event to be populated by fromJson.
-    }
-    this.element = typeof opt_element === 'undefined' ? '' : opt_element;
-    this.name = typeof opt_name === 'undefined' ? '' : opt_name;
-    this.oldValue = typeof opt_oldValue === 'undefined' ? '' : opt_oldValue;
-    this.newValue = typeof opt_newValue === 'undefined' ? '' : opt_newValue;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['element'] = this.element;
-    if (this.name) {
-      json['name'] = this.name;
-    }
-    json['oldValue'] = this.oldValue;
-    json['newValue'] = this.newValue;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.element = json['element'];
-    this.name = json['name'];
-    this.oldValue = json['oldValue'];
-    this.newValue = json['newValue'];
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return False if something changed.
-   */
-  override isNull(): boolean {
-    return this.oldValue === this.newValue;
-  }
-
-  /**
-   * Run a change 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 change non-existent block: ' + this.blockId);
-      return;
-    }
-    // Assume the block is rendered so that then we can check.
-    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);
-    }
-    const value = forward ? this.newValue : this.oldValue;
-    switch (this.element) {
-      case 'field': {
-        const field = block.getField(this.name!);
-        if (field) {
-          field.setValue(value);
-        } else {
-          console.warn('Can\'t set non-existent field: ' + this.name);
-        }
-        break;
-      }
-      case 'comment':
-        block.setCommentText(value as string || null);
-        break;
-      case 'collapsed':
-        block.setCollapsed(!!value);
-        break;
-      case 'disabled':
-        block.setEnabled(!value);
-        break;
-      case 'inline':
-        block.setInputsInline(!!value);
-        break;
-      case 'mutation': {
-        const oldState = BlockChange.getExtraBlockState_(block as BlockSvg);
-        if (block.loadExtraState) {
-          block.loadExtraState(JSON.parse(value as string || '{}'));
-        } else if (block.domToMutation) {
-          block.domToMutation(Xml.textToDom(value as string || '<mutation/>'));
-        }
-        eventUtils.fire(
-            new BlockChange(block, 'mutation', null, oldState, value));
-        break;
-      }
-      default:
-        console.warn('Unknown change type: ' + this.element);
-    }
-  }
-
-  // TODO (#5397): Encapsulate this in the BlocklyMutationChange event when
-  //    refactoring change events.
-  /**
-   * Returns the extra state of the given block (either as XML or a JSO,
-   * depending on the block's definition).
-   * @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: BlockSvg): string {
-    if (block.saveExtraState) {
-      const state = block.saveExtraState();
-      return state ? JSON.stringify(state) : '';
-    } else if (block.mutationToDom) {
-      const state = block.mutationToDom();
-      return state ? Xml.domToText(state) : '';
-    }
-    return '';
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.CHANGE, BlockChange);

package/core/events/events_block_create.ts

@@ -1,114 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for a block creation event.
- */
-
-/**
- * Class for a block creation event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.BlockCreate');
-
-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.
- * @alias Blockly.Events.BlockCreate
- */
-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. */
-    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;
-    }
-
-    this.xml = Xml.blockToDomWithXY(opt_block);
-    this.ids = eventUtils.getDescendantIds(opt_block);
-
-    /** 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 JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['xml'] = Xml.domToText(this.xml);
-    json['ids'] = this.ids;
-    json['json'] = this.json;
-    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.xml = Xml.textToDom(json['xml']);
-    this.ids = json['ids'];
-    this.json = json['json'] as blocks.State;
-    if (json['recordUndo'] !== undefined) {
-      this.recordUndo = json['recordUndo'];
-    }
-  }
-
-  /**
-   * Run a creation event.
-   * @param forward True if run forward, false if run backward (undo).
-   */
-  override run(forward: boolean) {
-    const workspace = this.getEventWorkspace_();
-    if (forward) {
-      blocks.append(this.json, workspace);
-    } else {
-      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 uncreate non-existent block: ' + id);
-        }
-      }
-    }
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.CREATE, BlockCreate);