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

package/core/events/events_viewport.ts

@@ -1,100 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of a viewport change.
- */
-
-/**
- * Events fired as a result of a viewport change.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.ViewportChange');
-
-import * as registry from '../registry.js';
-
-import {UiBase} from './events_ui_base.js';
-import * as eventUtils from './utils.js';
-
-
-/**
- * Class for a viewport change event.
- * @alias Blockly.Events.ViewportChange
- */
-export class ViewportChange extends UiBase {
-  viewTop?: number;
-  viewLeft?: number;
-  scale?: number;
-  oldScale?: number;
-  override type: string;
-
-  /**
-   * @param opt_top Top-edge of the visible portion of the workspace, relative
-   *     to the workspace origin. Undefined for a blank event.
-   * @param opt_left Left-edge of the visible portion of the workspace relative
-   *     to the workspace origin. Undefined for a blank event.
-   * @param opt_scale The scale of the workspace. Undefined for a blank event.
-   * @param opt_workspaceId The workspace identifier for this event.
-   *    Undefined for a blank event.
-   * @param opt_oldScale The old scale of the workspace. Undefined for a blank
-   *     event.
-   */
-  constructor(
-      opt_top?: number, opt_left?: number, opt_scale?: number,
-      opt_workspaceId?: string, opt_oldScale?: number) {
-    super(opt_workspaceId);
-
-    /**
-     * Top-edge of the visible portion of the workspace, relative to the
-     * workspace origin.
-     */
-    this.viewTop = opt_top;
-
-    /**
-     * Left-edge of the visible portion of the workspace, relative to the
-     * workspace origin.
-     */
-    this.viewLeft = opt_left;
-
-    /** The scale of the workspace. */
-    this.scale = opt_scale;
-
-    /** The old scale of the workspace. */
-    this.oldScale = opt_oldScale;
-
-    /** Type of this event. */
-    this.type = eventUtils.VIEWPORT_CHANGE;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = super.toJson();
-    json['viewTop'] = this.viewTop;
-    json['viewLeft'] = this.viewLeft;
-    json['scale'] = this.scale;
-    json['oldScale'] = this.oldScale;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    super.fromJson(json);
-    this.viewTop = json['viewTop'];
-    this.viewLeft = json['viewLeft'];
-    this.scale = json['scale'];
-    this.oldScale = json['oldScale'];
-  }
-}
-
-registry.register(
-    registry.Type.EVENT, eventUtils.VIEWPORT_CHANGE, ViewportChange);

package/core/events/utils.ts

@@ -1,529 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Helper methods for events that are fired as a result of
- * actions in Blockly's editor.
- */
-
-/**
- * Helper methods for events that are fired as a result of
- * actions in Blockly's editor.
- * @namespace Blockly.Events.utils
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.utils');
-
-import type {Block} from '../block.js';
-import * as common from '../common.js';
-import * as registry from '../registry.js';
-import * as idGenerator from '../utils/idgenerator.js';
-import type {Workspace} from '../workspace.js';
-import type {WorkspaceSvg} from '../workspace_svg.js';
-
-import type {Abstract} from './events_abstract.js';
-import type {BlockChange} from './events_block_change.js';
-import type {BlockCreate} from './events_block_create.js';
-import type {BlockMove} from './events_block_move.js';
-import type {CommentCreate} from './events_comment_create.js';
-import type {CommentMove} from './events_comment_move.js';
-import type {ViewportChange} from './events_viewport.js';
-
-
-/** Group ID for new events.  Grouped events are indivisible. */
-let group = '';
-
-/** Sets whether the next event should be added to the undo stack. */
-let recordUndo = true;
-
-/**
- * Sets whether events should be added to the undo stack.
- * @param newValue True if events should be added to the undo stack.
- * @alias Blockly.Events.utils.setRecordUndo
- */
-export function setRecordUndo(newValue: boolean) {
-  recordUndo = newValue;
-}
-
-/**
- * Returns whether or not events will be added to the undo stack.
- * @returns True if events will be added to the undo stack.
- * @alias Blockly.Events.utils.getRecordUndo
- */
-export function getRecordUndo(): boolean {
-  return recordUndo;
-}
-
-/** Allow change events to be created and fired. */
-let disabled = 0;
-
-/**
- * Name of event that creates a block. Will be deprecated for BLOCK_CREATE.
- * @alias Blockly.Events.utils.CREATE
- */
-export const CREATE = 'create';
-
-/**
- * Name of event that creates a block.
- * @alias Blockly.Events.utils.BLOCK_CREATE
- */
-export const BLOCK_CREATE = CREATE;
-
-/**
- * Name of event that deletes a block. Will be deprecated for BLOCK_DELETE.
- * @alias Blockly.Events.utils.DELETE
- */
-export const DELETE = 'delete';
-
-/**
- * Name of event that deletes a block.
- * @alias Blockly.Events.utils.BLOCK_DELETE
- */
-export const BLOCK_DELETE = DELETE;
-
-/**
- * Name of event that changes a block. Will be deprecated for BLOCK_CHANGE.
- * @alias Blockly.Events.utils.CHANGE
- */
-export const CHANGE = 'change';
-
-/**
- * Name of event that changes a block.
- * @alias Blockly.Events.utils.BLOCK_CHANGE
- */
-export const BLOCK_CHANGE = CHANGE;
-
-/**
- * Name of event that moves a block. Will be deprecated for BLOCK_MOVE.
- * @alias Blockly.Events.utils.MOVE
- */
-export const MOVE = 'move';
-
-/**
- * Name of event that moves a block.
- * @alias Blockly.Events.utils.BLOCK_MOVE
- */
-export const BLOCK_MOVE = MOVE;
-
-/**
- * Name of event that creates a variable.
- * @alias Blockly.Events.utils.VAR_CREATE
- */
-export const VAR_CREATE = 'var_create';
-
-/**
- * Name of event that deletes a variable.
- * @alias Blockly.Events.utils.VAR_DELETE
- */
-export const VAR_DELETE = 'var_delete';
-
-/**
- * Name of event that renames a variable.
- * @alias Blockly.Events.utils.VAR_RENAME
- */
-export const VAR_RENAME = 'var_rename';
-
-/**
- * Name of generic event that records a UI change.
- * @alias Blockly.Events.utils.UI
- */
-export const UI = 'ui';
-
-/**
- * Name of event that record a block drags a block.
- * @alias Blockly.Events.utils.BLOCK_DRAG
- */
-export const BLOCK_DRAG = 'drag';
-
-/**
- * Name of event that records a change in selected element.
- * @alias Blockly.Events.utils.SELECTED
- */
-export const SELECTED = 'selected';
-
-/**
- * Name of event that records a click.
- * @alias Blockly.Events.utils.CLICK
- */
-export const CLICK = 'click';
-
-/**
- * Name of event that records a marker move.
- * @alias Blockly.Events.utils.MARKER_MOVE
- */
-export const MARKER_MOVE = 'marker_move';
-
-/**
- * Name of event that records a bubble open.
- * @alias Blockly.Events.utils.BUBBLE_OPEN
- */
-export const BUBBLE_OPEN = 'bubble_open';
-
-/**
- * Name of event that records a trashcan open.
- * @alias Blockly.Events.utils.TRASHCAN_OPEN
- */
-export const TRASHCAN_OPEN = 'trashcan_open';
-
-/**
- * Name of event that records a toolbox item select.
- * @alias Blockly.Events.utils.TOOLBOX_ITEM_SELECT
- */
-export const TOOLBOX_ITEM_SELECT = 'toolbox_item_select';
-
-/**
- * Name of event that records a theme change.
- * @alias Blockly.Events.utils.THEME_CHANGE
- */
-export const THEME_CHANGE = 'theme_change';
-
-/**
- * Name of event that records a viewport change.
- * @alias Blockly.Events.utils.VIEWPORT_CHANGE
- */
-export const VIEWPORT_CHANGE = 'viewport_change';
-
-/**
- * Name of event that creates a comment.
- * @alias Blockly.Events.utils.COMMENT_CREATE
- */
-export const COMMENT_CREATE = 'comment_create';
-
-/**
- * Name of event that deletes a comment.
- * @alias Blockly.Events.utils.COMMENT_DELETE
- */
-export const COMMENT_DELETE = 'comment_delete';
-
-/**
- * Name of event that changes a comment.
- * @alias Blockly.Events.utils.COMMENT_CHANGE
- */
-export const COMMENT_CHANGE = 'comment_change';
-
-/**
- * Name of event that moves a comment.
- * @alias Blockly.Events.utils.COMMENT_MOVE
- */
-export const COMMENT_MOVE = 'comment_move';
-
-/**
- * Name of event that records a workspace load.
- * @alias Blockly.Events.utils.FINISHED_LOADING
- */
-export const FINISHED_LOADING = 'finished_loading';
-
-/**
- * Type of events that cause objects to be bumped back into the visible
- * portion of the workspace.
- *
- * Not to be confused with bumping so that disconnected connections do not
- * appear connected.
- * @alias Blockly.Events.utils.BumpEvent
- */
-export type BumpEvent = BlockCreate|BlockMove|CommentCreate|CommentMove;
-
-/**
- * List of events that cause objects to be bumped back into the visible
- * portion of the workspace.
- *
- * Not to be confused with bumping so that disconnected connections do not
- * appear connected.
- * @alias Blockly.Events.utils.BUMP_EVENTS
- */
-export const BUMP_EVENTS: string[] =
-    [BLOCK_CREATE, BLOCK_MOVE, COMMENT_CREATE, COMMENT_MOVE];
-
-/** List of events queued for firing. */
-const FIRE_QUEUE: Abstract[] = [];
-
-/**
- * Create a custom event and fire it.
- * @param event Custom data for event.
- * @alias Blockly.Events.utils.fire
- */
-export function fire(event: Abstract) {
-  TEST_ONLY.fireInternal(event);
-}
-
-/**
- * Private version of fireInternal for stubbing in tests.
- */
-function fireInternal(event: Abstract) {
-  if (!isEnabled()) {
-    return;
-  }
-  if (!FIRE_QUEUE.length) {
-    // First event added; schedule a firing of the event queue.
-    setTimeout(fireNow, 0);
-  }
-  FIRE_QUEUE.push(event);
-}
-
-
-/** Fire all queued events. */
-function fireNow() {
-  const queue = filter(FIRE_QUEUE, true);
-  FIRE_QUEUE.length = 0;
-  for (let i = 0, event; event = queue[i]; i++) {
-    if (!event.workspaceId) {
-      continue;
-    }
-    const eventWorkspace = common.getWorkspaceById(event.workspaceId);
-    if (eventWorkspace) {
-      eventWorkspace.fireChangeListener(event);
-    }
-  }
-}
-
-/**
- * Filter the queued events and merge duplicates.
- * @param queueIn Array of events.
- * @param forward True if forward (redo), false if backward (undo).
- * @return Array of filtered events.
- * @alias Blockly.Events.utils.filter
- */
-export function filter(queueIn: Abstract[], forward: boolean): Abstract[] {
-  let queue = queueIn.slice();
-  // Shallow copy of queue.
-  if (!forward) {
-    // Undo is merged in reverse order.
-    queue.reverse();
-  }
-  const mergedQueue = [];
-  const hash = Object.create(null);
-  // Merge duplicates.
-  for (let i = 0, event; event = queue[i]; i++) {
-    if (!event.isNull()) {
-      // Treat all UI events as the same type in hash table.
-      const eventType = event.isUiEvent ? UI : event.type;
-      // TODO(#5927): Check whether `blockId` exists before accessing it.
-      const blockId = (event as AnyDuringMigration).blockId;
-      const key = [eventType, blockId, event.workspaceId].join(' ');
-
-      const lastEntry = hash[key];
-      const lastEvent = lastEntry ? lastEntry.event : null;
-      if (!lastEntry) {
-        // Each item in the hash table has the event and the index of that event
-        // in the input array.  This lets us make sure we only merge adjacent
-        // move events.
-        hash[key] = {event, index: i};
-        mergedQueue.push(event);
-      } else if (event.type === MOVE && lastEntry.index === i - 1) {
-        const moveEvent = event as BlockMove;
-        // Merge move events.
-        lastEvent.newParentId = moveEvent.newParentId;
-        lastEvent.newInputName = moveEvent.newInputName;
-        lastEvent.newCoordinate = moveEvent.newCoordinate;
-        lastEntry.index = i;
-      } else if (
-          event.type === CHANGE &&
-          (event as BlockChange).element === lastEvent.element &&
-          (event as BlockChange).name === lastEvent.name) {
-        const changeEvent = event as BlockChange;
-        // Merge change events.
-        lastEvent.newValue = changeEvent.newValue;
-      } else if (event.type === VIEWPORT_CHANGE) {
-        const viewportEvent = event as ViewportChange;
-        // Merge viewport change events.
-        lastEvent.viewTop = viewportEvent.viewTop;
-        lastEvent.viewLeft = viewportEvent.viewLeft;
-        lastEvent.scale = viewportEvent.scale;
-        lastEvent.oldScale = viewportEvent.oldScale;
-      } else if (event.type === CLICK && lastEvent.type === BUBBLE_OPEN) {
-        // Drop click events caused by opening/closing bubbles.
-      } else {
-        // Collision: newer events should merge into this event to maintain
-        // order.
-        hash[key] = {event, index: i};
-        mergedQueue.push(event);
-      }
-    }
-  }
-  // Filter out any events that have become null due to merging.
-  queue = mergedQueue.filter(function(e) {
-    return !e.isNull();
-  });
-  if (!forward) {
-    // Restore undo order.
-    queue.reverse();
-  }
-  // Move mutation events to the top of the queue.
-  // Intentionally skip first event.
-  for (let i = 1, event; event = queue[i]; i++) {
-    // AnyDuringMigration because:  Property 'element' does not exist on type
-    // 'Abstract'.
-    if (event.type === CHANGE &&
-        (event as AnyDuringMigration).element === 'mutation') {
-      queue.unshift(queue.splice(i, 1)[0]);
-    }
-  }
-  return queue;
-}
-
-/**
- * Modify pending undo events so that when they are fired they don't land
- * in the undo stack.  Called by Workspace.clearUndo.
- * @alias Blockly.Events.utils.clearPendingUndo
- */
-export function clearPendingUndo() {
-  for (let i = 0, event; event = FIRE_QUEUE[i]; i++) {
-    event.recordUndo = false;
-  }
-}
-
-/**
- * Stop sending events.  Every call to this function MUST also call enable.
- * @alias Blockly.Events.utils.disable
- */
-export function disable() {
-  disabled++;
-}
-
-/**
- * Start sending events.  Unless events were already disabled when the
- * corresponding call to disable was made.
- * @alias Blockly.Events.utils.enable
- */
-export function enable() {
-  disabled--;
-}
-
-/**
- * Returns whether events may be fired or not.
- * @return True if enabled.
- * @alias Blockly.Events.utils.isEnabled
- */
-export function isEnabled(): boolean {
-  return disabled === 0;
-}
-
-/**
- * Current group.
- * @return ID string.
- * @alias Blockly.Events.utils.getGroup
- */
-export function getGroup(): string {
-  return group;
-}
-
-/**
- * Start or stop a group.
- * @param state True to start new group, false to end group.
- *   String to set group explicitly.
- * @alias Blockly.Events.utils.setGroup
- */
-export function setGroup(state: boolean|string) {
-  TEST_ONLY.setGroupInternal(state);
-}
-
-/**
- * Private version of setGroup for stubbing in tests.
- */
-function setGroupInternal(state: boolean|string) {
-  if (typeof state === 'boolean') {
-    group = state ? idGenerator.genUid() : '';
-  } else {
-    group = state;
-  }
-}
-
-/**
- * Compute a list of the IDs of the specified block and all its descendants.
- * @param block The root block.
- * @return List of block IDs.
- * @alias Blockly.Events.utils.getDescendantIds
- * @internal
- */
-export function getDescendantIds(block: Block): string[] {
-  const ids = [];
-  const descendants = block.getDescendants(false);
-  for (let i = 0, descendant; descendant = descendants[i]; i++) {
-    ids[i] = descendant.id;
-  }
-  return ids;
-}
-
-/**
- * Decode the JSON into an event.
- * @param json JSON representation.
- * @param workspace Target workspace for event.
- * @return The event represented by the JSON.
- * @throws {Error} if an event type is not found in the registry.
- * @alias Blockly.Events.utils.fromJson
- */
-export function fromJson(
-    json: AnyDuringMigration, workspace: Workspace): Abstract {
-  const eventClass = get(json['type']);
-  if (!eventClass) {
-    throw Error('Unknown event type.');
-  }
-  const event = new eventClass();
-  event.fromJson(json);
-  event.workspaceId = workspace.id;
-  return event;
-}
-
-/**
- * Gets the class for a specific event type from the registry.
- * @param eventType The type of the event to get.
- * @return The event class with the given type or null if none exists.
- * @alias Blockly.Events.utils.get
- */
-export function get(eventType: string):
-    (new (...p1: AnyDuringMigration[]) => Abstract)|null {
-  return registry.getClass(registry.Type.EVENT, eventType);
-}
-
-/**
- * Enable/disable a block depending on whether it is properly connected.
- * Use this on applications where all blocks should be connected to a top block.
- * Recommend setting the 'disable' option to 'false' in the config so that
- * users don't try to re-enable disabled orphan blocks.
- * @param event Custom data for event.
- * @alias Blockly.Events.utils.disableOrphans
- */
-export function disableOrphans(event: Abstract) {
-  if (event.type === MOVE || event.type === CREATE) {
-    const blockEvent = event as BlockMove | BlockCreate;
-    if (!blockEvent.workspaceId) {
-      return;
-    }
-    const eventWorkspace =
-        common.getWorkspaceById(blockEvent.workspaceId) as WorkspaceSvg;
-    let block = eventWorkspace.getBlockById(blockEvent.blockId);
-    if (block) {
-      // Changing blocks as part of this event shouldn't be undoable.
-      const initialUndoFlag = recordUndo;
-      try {
-        recordUndo = false;
-        const parent = block.getParent();
-        if (parent && parent.isEnabled()) {
-          const children = block.getDescendants(false);
-          for (let i = 0, child; child = children[i]; i++) {
-            child.setEnabled(true);
-          }
-        } else if (
-            (block.outputConnection || block.previousConnection) &&
-            !eventWorkspace.isDragging()) {
-          do {
-            block.setEnabled(false);
-            block = block.getNextBlock();
-          } while (block);
-        }
-      } finally {
-        recordUndo = initialUndoFlag;
-      }
-    }
-  }
-}
-
-export const TEST_ONLY = {
-  FIRE_QUEUE,
-  fireNow,
-  fireInternal,
-  setGroupInternal,
-};

package/core/events/workspace_events.ts

@@ -1,86 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class for a finished loading workspace event.
- */
-
-/**
- * Class for a finished loading workspace event.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Events.FinishedLoading');
-
-import * as registry from '../registry.js';
-import type {Workspace} from '../workspace.js';
-
-import {Abstract as AbstractEvent} from './events_abstract.js';
-import * as eventUtils from './utils.js';
-
-
-/**
- * Class for a finished loading event.
- * Used to notify the developer when the workspace has finished loading (i.e
- * domToWorkspace).
- * Finished loading events do not record undo or redo.
- * @alias Blockly.Events.FinishedLoading
- */
-export class FinishedLoading extends AbstractEvent {
-  override isBlank: boolean;
-  override workspaceId: string;
-
-  // Workspace events do not undo or redo.
-  override recordUndo = false;
-  override type: string;
-  override group: AnyDuringMigration;
-
-  /**
-   * @param opt_workspace The workspace that has finished loading.  Undefined
-   *     for a blank event.
-   */
-  constructor(opt_workspace?: Workspace) {
-    super();
-    /** Whether or not the event is blank (to be populated by fromJson). */
-    this.isBlank = typeof opt_workspace === 'undefined';
-
-    /** The workspace identifier for this event. */
-    this.workspaceId = opt_workspace ? opt_workspace.id : '';
-
-    /** Type of this event. */
-    this.type = eventUtils.FINISHED_LOADING;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return JSON representation.
-   */
-  override toJson(): AnyDuringMigration {
-    const json = {
-      'type': this.type,
-    };
-    if (this.group) {
-      (json as AnyDuringMigration)['group'] = this.group;
-    }
-    if (this.workspaceId) {
-      (json as AnyDuringMigration)['workspaceId'] = this.workspaceId;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param json JSON representation.
-   */
-  override fromJson(json: AnyDuringMigration) {
-    this.isBlank = false;
-    this.workspaceId = json['workspaceId'];
-    this.group = json['group'];
-  }
-}
-
-registry.register(
-    registry.Type.EVENT, eventUtils.FINISHED_LOADING, FinishedLoading);