scratch-blocks 2.0.0-beta.1 → 2.0.0-beta.2

package/blockly-rc/core/events/events.ts

@@ -1,163 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.Events
-
-import {Abstract, AbstractEventJson} from './events_abstract.js';
-import {BlockBase, BlockBaseJson} from './events_block_base.js';
-import {BlockChange, BlockChangeJson} from './events_block_change.js';
-import {BlockCreate, BlockCreateJson} from './events_block_create.js';
-import {BlockDelete, BlockDeleteJson} from './events_block_delete.js';
-import {BlockDrag, BlockDragJson} from './events_block_drag.js';
-import {
-  BlockFieldIntermediateChange,
-  BlockFieldIntermediateChangeJson,
-} from './events_block_field_intermediate_change.js';
-import {BlockMove, BlockMoveJson} from './events_block_move.js';
-import {BubbleOpen, BubbleOpenJson, BubbleType} from './events_bubble_open.js';
-import {Click, ClickJson, ClickTarget} from './events_click.js';
-import {CommentBase, CommentBaseJson} from './events_comment_base.js';
-import {CommentChange, CommentChangeJson} from './events_comment_change.js';
-import {CommentCreate, CommentCreateJson} from './events_comment_create.js';
-import {CommentDelete} from './events_comment_delete.js';
-import {CommentMove, CommentMoveJson} from './events_comment_move.js';
-import {CommentResize, CommentResizeJson} from './events_comment_resize.js';
-import {CommentDrag, CommentDragJson} from './events_comment_drag.js';
-import {
-  CommentCollapse,
-  CommentCollapseJson,
-} from './events_comment_collapse.js';
-import {MarkerMove, MarkerMoveJson} from './events_marker_move.js';
-import {Selected, SelectedJson} from './events_selected.js';
-import {ThemeChange, ThemeChangeJson} from './events_theme_change.js';
-import {
-  ToolboxItemSelect,
-  ToolboxItemSelectJson,
-} from './events_toolbox_item_select.js';
-import {TrashcanOpen, TrashcanOpenJson} from './events_trashcan_open.js';
-import {UiBase} from './events_ui_base.js';
-import {VarBase, VarBaseJson} from './events_var_base.js';
-import {VarCreate, VarCreateJson} from './events_var_create.js';
-import {VarDelete, VarDeleteJson} from './events_var_delete.js';
-import {VarRename, VarRenameJson} from './events_var_rename.js';
-import {VarTypeChange, VarTypeChangeJson} from './events_var_type_change.js';
-import {ViewportChange, ViewportChangeJson} from './events_viewport.js';
-import * as eventUtils from './utils.js';
-import {FinishedLoading} from './workspace_events.js';
-
-// Events.
-export {Abstract};
-export {AbstractEventJson};
-export {BubbleOpen};
-export {BubbleOpenJson};
-export {BubbleType};
-export {BlockBase};
-export {BlockBaseJson};
-export {BlockChange};
-export {BlockChangeJson};
-export {BlockCreate};
-export {BlockCreateJson};
-export {BlockDelete};
-export {BlockDeleteJson};
-export {BlockDrag};
-export {BlockDragJson};
-export {BlockFieldIntermediateChange};
-export {BlockFieldIntermediateChangeJson};
-export {BlockMove};
-export {BlockMoveJson};
-export {Click};
-export {ClickJson};
-export {ClickTarget};
-export {CommentBase};
-export {CommentBaseJson};
-export {CommentChange};
-export {CommentChangeJson};
-export {CommentCreate};
-export {CommentCreateJson};
-export {CommentDelete};
-export {CommentMove};
-export {CommentMoveJson};
-export {CommentResize};
-export {CommentResizeJson};
-export {CommentDrag};
-export {CommentDragJson};
-export {CommentCollapse};
-export {CommentCollapseJson};
-export {FinishedLoading};
-export {MarkerMove};
-export {MarkerMoveJson};
-export {Selected};
-export {SelectedJson};
-export {ThemeChange};
-export {ThemeChangeJson};
-export {ToolboxItemSelect};
-export {ToolboxItemSelectJson};
-export {TrashcanOpen};
-export {TrashcanOpenJson};
-export {UiBase};
-export {VarBase};
-export {VarBaseJson};
-export {VarCreate};
-export {VarCreateJson};
-export {VarDelete};
-export {VarDeleteJson};
-export {VarRename};
-export {VarRenameJson};
-export {VarTypeChange};
-export {VarTypeChangeJson};
-export {ViewportChange};
-export {ViewportChangeJson};
-
-// 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 BLOCK_FIELD_INTERMEDIATE_CHANGE =
-  eventUtils.BLOCK_FIELD_INTERMEDIATE_CHANGE;
-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 COMMENT_RESIZE = eventUtils.COMMENT_RESIZE;
-export const COMMENT_DRAG = eventUtils.COMMENT_DRAG;
-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 VAR_TYPE_CHAGE = eventUtils.VAR_TYPE_CHANGE;
-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/blockly-rc/core/events/events_abstract.ts

@@ -1,130 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * Abstract class for events fired as a result of actions in
- * Blockly's editor.
- *
- * @class
- */
-// Former goog.module ID: 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.
- */
-export abstract class Abstract {
-  /**
-   * Whether or not the event was constructed without necessary parameters
-   * (to be populated by fromJson).
-   */
-  abstract isBlank: boolean;
-
-  /** The workspace identifier for this event. */
-  workspaceId?: string = undefined;
-
-  /**
-   * An ID for the group of events this block is associated with.
-   *
-   * Groups define events that should be treated as an single action from the
-   * user's perspective, and should be undone together.
-   */
-  group: string;
-
-  /** Whether this event is undoable or not. */
-  recordUndo: boolean;
-
-  /** Whether or not the event is a UI event. */
-  isUiEvent = false;
-
-  /** Type of this event. */
-  type = '';
-
-  constructor() {
-    this.group = eventUtils.getGroup();
-    this.recordUndo = eventUtils.getRecordUndo();
-  }
-
-  /**
-   * Encode the event as JSON.
-   *
-   * @returns JSON representation.
-   */
-  toJson(): AbstractEventJson {
-    return {
-      'type': this.type,
-      'group': this.group,
-    };
-  }
-
-  /**
-   * Deserializes the JSON event.
-   *
-   * @param event The event to append new properties to. Should be a subclass
-   *     of Abstract (like all events), but we can't specify that due to the
-   *     fact that parameters to static methods in subclasses must be
-   *     supertypes of parameters to static methods in superclasses.
-   * @internal
-   */
-  static fromJson(
-    json: AbstractEventJson,
-    workspace: Workspace,
-    event: any,
-  ): Abstract {
-    event.isBlank = false;
-    event.group = json['group'] || '';
-    event.workspaceId = workspace.id;
-    return event;
-  }
-
-  /**
-   * Does this event record any change of state?
-   *
-   * @returns 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. Cannot be abstract b/c UI events do /not/ define
-    // this.
-  }
-
-  /**
-   * Get workspace the event belongs to.
-   *
-   * @returns The workspace the event belongs to.
-   * @throws {Error} if workspace is null.
-   */
-  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;
-  }
-}
-
-export interface AbstractEventJson {
-  type: string;
-  group: string;
-}

package/blockly-rc/core/events/events_block_base.ts

@@ -1,88 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * Base class for all types of block events.
- *
- * @class
- */
-// Former goog.module ID: Blockly.Events.BlockBase
-
-import type {Block} from '../block.js';
-import type {Workspace} from '../workspace.js';
-
-import {
-  Abstract as AbstractEvent,
-  AbstractEventJson,
-} from './events_abstract.js';
-
-/**
- * Abstract class for any event related to blocks.
- */
-export class BlockBase extends AbstractEvent {
-  override isBlank = true;
-
-  /** The ID of the block associated with this event. */
-  blockId?: string;
-
-  /**
-   * @param opt_block The block this event corresponds to.
-   *     Undefined for a blank event.
-   */
-  constructor(opt_block?: Block) {
-    super();
-    this.isBlank = !opt_block;
-
-    if (!opt_block) return;
-
-    this.blockId = opt_block.id;
-    this.workspaceId = opt_block.workspace.id;
-  }
-
-  /**
-   * Encode the event as JSON.
-   *
-   * @returns JSON representation.
-   */
-  override toJson(): BlockBaseJson {
-    const json = super.toJson() as BlockBaseJson;
-    if (!this.blockId) {
-      throw new Error(
-        'The block ID is undefined. Either pass a block to ' +
-          'the constructor, or call fromJson',
-      );
-    }
-    json['blockId'] = this.blockId;
-    return json;
-  }
-
-  /**
-   * Deserializes the JSON event.
-   *
-   * @param event The event to append new properties to. Should be a subclass
-   *     of BlockBase, but we can't specify that due to the fact that parameters
-   *     to static methods in subclasses must be supertypes of parameters to
-   *     static methods in superclasses.
-   * @internal
-   */
-  static fromJson(
-    json: BlockBaseJson,
-    workspace: Workspace,
-    event?: any,
-  ): BlockBase {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockBase(),
-    ) as BlockBase;
-    newEvent.blockId = json['blockId'];
-    return newEvent;
-  }
-}
-
-export interface BlockBaseJson extends AbstractEventJson {
-  blockId: string;
-}

package/blockly-rc/core/events/events_block_change.ts

@@ -1,259 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * Class for a block change event.
- *
- * @class
- */
-// Former goog.module ID: Blockly.Events.BlockChange
-
-import type {Block} from '../block.js';
-import type {BlockSvg} from '../block_svg.js';
-import {IconType} from '../icons/icon_types.js';
-import {hasBubble} from '../interfaces/i_has_bubble.js';
-import {MANUALLY_DISABLED} from '../constants.js';
-import * as registry from '../registry.js';
-import * as utilsXml from '../utils/xml.js';
-import {Workspace} from '../workspace.js';
-import * as Xml from '../xml.js';
-
-import {BlockBase, BlockBaseJson} from './events_block_base.js';
-import * as eventUtils from './utils.js';
-
-/**
- * Notifies listeners when some element of a block has changed (e.g.
- * field values, comments, etc).
- */
-export class BlockChange extends BlockBase {
-  override type = eventUtils.BLOCK_CHANGE;
-  /**
-   * The element that changed; one of 'field', 'comment', 'collapsed',
-   * 'disabled', 'inline', or 'mutation'
-   */
-  element?: string;
-
-  /** The name of the field that changed, if this is a change to a field. */
-  name?: string;
-
-  /** The original value of the element. */
-  oldValue: unknown;
-
-  /** The new value of the element. */
-  newValue: unknown;
-
-  /**
-   * If element is 'disabled', this is the language-neutral identifier of the
-   * reason why the block was or was not disabled.
-   */
-  private disabledReason?: string;
-
-  /**
-   * @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?: unknown,
-    opt_newValue?: unknown,
-  ) {
-    super(opt_block);
-
-    if (!opt_block) {
-      return; // Blank event to be populated by fromJson.
-    }
-    this.element = opt_element;
-    this.name = opt_name || undefined;
-    this.oldValue = opt_oldValue;
-    this.newValue = opt_newValue;
-  }
-
-  /**
-   * Encode the event as JSON.
-   *
-   * @returns JSON representation.
-   */
-  override toJson(): BlockChangeJson {
-    const json = super.toJson() as BlockChangeJson;
-    if (!this.element) {
-      throw new Error(
-        'The changed element is undefined. Either pass an ' +
-          'element to the constructor, or call fromJson',
-      );
-    }
-    json['element'] = this.element;
-    json['name'] = this.name;
-    json['oldValue'] = this.oldValue;
-    json['newValue'] = this.newValue;
-    if (this.disabledReason) {
-      json['disabledReason'] = this.disabledReason;
-    }
-    return json;
-  }
-
-  /**
-   * Deserializes the JSON event.
-   *
-   * @param event The event to append new properties to. Should be a subclass
-   *     of BlockChange, but we can't specify that due to the fact that
-   *     parameters to static methods in subclasses must be supertypes of
-   *     parameters to static methods in superclasses.
-   * @internal
-   */
-  static fromJson(
-    json: BlockChangeJson,
-    workspace: Workspace,
-    event?: any,
-  ): BlockChange {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockChange(),
-    ) as BlockChange;
-    newEvent.element = json['element'];
-    newEvent.name = json['name'];
-    newEvent.oldValue = json['oldValue'];
-    newEvent.newValue = json['newValue'];
-    if (json['disabledReason'] !== undefined) {
-      newEvent.disabledReason = json['disabledReason'];
-    }
-    return newEvent;
-  }
-
-  /**
-   * Set the language-neutral identifier for the reason why the block was or was
-   * not disabled. This is only valid for events where element is 'disabled'.
-   * Defaults to 'MANUALLY_DISABLED'.
-   *
-   * @param disabledReason The identifier of the reason why the block was or was
-   *     not disabled.
-   */
-  setDisabledReason(disabledReason: string) {
-    if (this.element !== 'disabled') {
-      throw new Error(
-        'Cannot set the disabled reason for a BlockChange event if the ' +
-          'element is not "disabled".',
-      );
-    }
-    this.disabledReason = disabledReason;
-  }
-
-  /**
-   * Does this event record any change of state?
-   *
-   * @returns 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_();
-    if (!this.blockId) {
-      throw new Error(
-        'The block ID is undefined. Either pass a block to ' +
-          'the constructor, or call fromJson',
-      );
-    }
-    const block = workspace.getBlockById(this.blockId);
-    if (!block) {
-      throw new Error(
-        'The associated block is undefined. Either pass a ' +
-          'block to the constructor, or call fromJson',
-      );
-    }
-    // Assume the block is rendered so that then we can check.
-    const icon = block.getIcon(IconType.MUTATOR);
-    if (icon && hasBubble(icon) && icon.bubbleIsVisible()) {
-      // Close the mutator (if open) since we don't want to update it.
-      icon.setBubbleVisible(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.setDisabledReason(
-          !!value,
-          this.disabledReason ?? MANUALLY_DISABLED,
-        );
-        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(
-            utilsXml.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.
-   * @returns A stringified version of the extra state of the given block.
-   * @internal
-   */
-  static getExtraBlockState_(block: BlockSvg): string {
-    if (block.saveExtraState) {
-      const state = block.saveExtraState(true);
-      return state ? JSON.stringify(state) : '';
-    } else if (block.mutationToDom) {
-      const state = block.mutationToDom();
-      return state ? Xml.domToText(state) : '';
-    }
-    return '';
-  }
-}
-
-export interface BlockChangeJson extends BlockBaseJson {
-  element: string;
-  name?: string;
-  newValue: unknown;
-  oldValue: unknown;
-  disabledReason?: string;
-}
-
-registry.register(registry.Type.EVENT, eventUtils.CHANGE, BlockChange);