blockly 12.4.0 → 12.5.0

package/core/block_animations.ts

@@ -1,233 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.blockAnimations
-
-import type {BlockSvg} from './block_svg.js';
-import * as dom from './utils/dom.js';
-import {Svg} from './utils/svg.js';
-
-/** A bounding box for a cloned block. */
-interface CloneRect {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-}
-
-/** PID of disconnect UI animation.  There can only be one at a time. */
-let disconnectPid: ReturnType<typeof setTimeout> | null = null;
-
-/** The wobbling block.  There can only be one at a time. */
-let wobblingBlock: BlockSvg | null = null;
-
-/**
- * Play some UI effects (sound, animation) when disposing of a block.
- *
- * @param block The block being disposed of.
- * @internal
- */
-export function disposeUiEffect(block: BlockSvg) {
-  // Disposing is going to take so long the animation won't play anyway.
-  if (block.getDescendants(false).length > 100) return;
-
-  const workspace = block.workspace;
-  const svgGroup = block.getSvgRoot();
-  workspace.getAudioManager().play('delete');
-
-  const xy = block.getRelativeToSurfaceXY();
-  // Deeply clone the current block.
-  const clone: SVGGElement = svgGroup.cloneNode(true) as SVGGElement;
-  clone.setAttribute('transform', 'translate(' + xy.x + ',' + xy.y + ')');
-  workspace.getLayerManager()?.appendToAnimationLayer({
-    getSvgRoot: () => {
-      return clone;
-    },
-  });
-  const cloneRect = {
-    'x': xy.x,
-    'y': xy.y,
-    'width': block.width,
-    'height': block.height,
-  };
-  disposeUiStep(clone, cloneRect, workspace.RTL, new Date());
-}
-/**
- * Animate a cloned block and eventually dispose of it.
- * This is a class method, not an instance method since the original block has
- * been destroyed and is no longer accessible.
- *
- * @param clone SVG element to animate and dispose of.
- * @param rect Starting rect of the clone.
- * @param rtl True if RTL, false if LTR.
- * @param start Date of animation's start.
- */
-function disposeUiStep(
-  clone: Element,
-  rect: CloneRect,
-  rtl: boolean,
-  start: Date,
-) {
-  const ms = new Date().getTime() - start.getTime();
-  const percent = ms / 150;
-  if (percent > 1) {
-    dom.removeNode(clone);
-  } else {
-    const x = rect.x + (((rtl ? -1 : 1) * rect.width) / 2) * percent;
-    const y = rect.y + (rect.height / 2) * percent;
-    const scale = 1 - percent;
-    clone.setAttribute(
-      'transform',
-      'translate(' + x + ',' + y + ')' + ' scale(' + scale + ')',
-    );
-    setTimeout(disposeUiStep, 10, clone, rect, rtl, start);
-  }
-}
-
-/**
- * Play some UI effects (sound, ripple) after a connection has been established.
- *
- * @param block The block being connected.
- * @internal
- */
-export function connectionUiEffect(block: BlockSvg) {
-  const workspace = block.workspace;
-  const scale = workspace.scale;
-  workspace.getAudioManager().play('click');
-  if (scale < 1) {
-    return; // Too small to care about visual effects.
-  }
-  // Determine the absolute coordinates of the inferior block.
-  const xy = workspace.getSvgXY(block.getSvgRoot());
-  // Offset the coordinates based on the two connection types, fix scale.
-  if (block.outputConnection) {
-    xy.x += (block.RTL ? 3 : -3) * scale;
-    xy.y += 13 * scale;
-  } else if (block.previousConnection) {
-    xy.x += (block.RTL ? -23 : 23) * scale;
-    xy.y += 3 * scale;
-  }
-  const ripple = dom.createSvgElement(
-    Svg.CIRCLE,
-    {
-      'cx': xy.x,
-      'cy': xy.y,
-      'r': 0,
-      'fill': 'none',
-      'stroke': '#888',
-      'stroke-width': 10,
-    },
-    workspace.getParentSvg(),
-  );
-
-  const scaleAnimation = dom.createSvgElement(
-    Svg.ANIMATE,
-    {
-      'id': 'animationCircle',
-      'begin': 'indefinite',
-      'attributeName': 'r',
-      'dur': '150ms',
-      'from': 0,
-      'to': 25 * scale,
-    },
-    ripple,
-  );
-  const opacityAnimation = dom.createSvgElement(
-    Svg.ANIMATE,
-    {
-      'id': 'animationOpacity',
-      'begin': 'indefinite',
-      'attributeName': 'opacity',
-      'dur': '150ms',
-      'from': 1,
-      'to': 0,
-    },
-    ripple,
-  );
-
-  scaleAnimation.beginElement();
-  opacityAnimation.beginElement();
-
-  setTimeout(() => void dom.removeNode(ripple), 150);
-}
-
-/**
- * Play some UI effects (sound, animation) when disconnecting a block.
- *
- * @param block The block being disconnected.
- * @internal
- */
-export function disconnectUiEffect(block: BlockSvg) {
-  disconnectUiStop();
-  block.workspace.getAudioManager().play('disconnect');
-  if (block.workspace.scale < 1) {
-    return; // Too small to care about visual effects.
-  }
-  // Horizontal distance for bottom of block to wiggle.
-  const DISPLACEMENT = 10;
-  // Scale magnitude of skew to height of block.
-  const height = block.getHeightWidth().height;
-  let magnitude = (Math.atan(DISPLACEMENT / height) / Math.PI) * 180;
-  if (!block.RTL) {
-    magnitude *= -1;
-  }
-  // Start the animation.
-  wobblingBlock = block;
-  disconnectUiStep(block, magnitude, new Date(), 0);
-}
-
-/**
- * Animate a brief wiggle of a disconnected block.
- *
- * @param block Block to animate.
- * @param magnitude Maximum degrees skew (reversed for RTL).
- * @param start Date of animation's start for deciding when to stop.
- * @param step Which step of the animation we're on.
- */
-function disconnectUiStep(
-  block: BlockSvg,
-  magnitude: number,
-  start: Date,
-  step: number,
-) {
-  const DURATION = 200; // Milliseconds.
-  const WIGGLES = [0.66, 1, 0.66, 0, -0.66, -1, -0.66, 0]; // Single cycle
-
-  let skew = '';
-  if (start.getTime() + DURATION > new Date().getTime()) {
-    const val = Math.round(WIGGLES[step % WIGGLES.length] * magnitude);
-    skew = `skewX(${val})`;
-    disconnectPid = setTimeout(
-      disconnectUiStep,
-      15,
-      block,
-      magnitude,
-      start,
-      step + 1,
-    );
-  }
-
-  block
-    .getSvgRoot()
-    .setAttribute('transform', `${block.getTranslation()} ${skew}`);
-}
-
-/**
- * Stop the disconnect UI animation immediately.
- *
- * @internal
- */
-export function disconnectUiStop() {
-  if (!wobblingBlock) return;
-  if (disconnectPid) {
-    clearTimeout(disconnectPid);
-    disconnectPid = null;
-  }
-  wobblingBlock
-    .getSvgRoot()
-    .setAttribute('transform', wobblingBlock.getTranslation());
-  wobblingBlock = null;
-}

package/core/block_flyout_inflater.ts

@@ -1,283 +0,0 @@
-/**
- * @license
- * Copyright 2024 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {BlockSvg} from './block_svg.js';
-import * as browserEvents from './browser_events.js';
-import * as common from './common.js';
-import {MANUALLY_DISABLED} from './constants.js';
-import type {Abstract as AbstractEvent} from './events/events_abstract.js';
-import {EventType} from './events/type.js';
-import {FlyoutItem} from './flyout_item.js';
-import type {IFlyout} from './interfaces/i_flyout.js';
-import type {IFlyoutInflater} from './interfaces/i_flyout_inflater.js';
-import * as registry from './registry.js';
-import * as blocks from './serialization/blocks.js';
-import type {BlockInfo} from './utils/toolbox.js';
-import * as utilsXml from './utils/xml.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-import * as Xml from './xml.js';
-
-/**
- * The language-neutral ID for when the reason why a block is disabled is
- * because the workspace is at block capacity.
- */
-const WORKSPACE_AT_BLOCK_CAPACITY_DISABLED_REASON =
-  'WORKSPACE_AT_BLOCK_CAPACITY';
-
-const BLOCK_TYPE = 'block';
-
-/**
- * Class responsible for creating blocks for flyouts.
- */
-export class BlockFlyoutInflater implements IFlyoutInflater {
-  protected permanentlyDisabledBlocks = new Set<BlockSvg>();
-  protected listeners = new Map<string, browserEvents.Data[]>();
-  protected flyout?: IFlyout;
-  private capacityWrapper: (event: AbstractEvent) => void;
-
-  /**
-   * Creates a new BlockFlyoutInflater instance.
-   */
-  constructor() {
-    this.capacityWrapper = this.filterFlyoutBasedOnCapacity.bind(this);
-  }
-
-  /**
-   * Inflates a flyout block from the given state and adds it to the flyout.
-   *
-   * @param state A JSON representation of a flyout block.
-   * @param flyout The flyout to create the block on.
-   * @returns A newly created block.
-   */
-  load(state: object, flyout: IFlyout): FlyoutItem {
-    this.setFlyout(flyout);
-    const block = this.createBlock(state as BlockInfo, flyout.getWorkspace());
-
-    if (!block.isEnabled()) {
-      // Record blocks that were initially disabled.
-      // Do not enable these blocks as a result of capacity filtering.
-      this.permanentlyDisabledBlocks.add(block);
-    } else {
-      this.updateStateBasedOnCapacity(block);
-    }
-
-    // Mark blocks as being inside a flyout.  This is used to detect and
-    // prevent the closure of the flyout if the user right-clicks on such
-    // a block.
-    block.getDescendants(false).forEach((b) => (b.isInFlyout = true));
-    this.addBlockListeners(block);
-
-    return new FlyoutItem(block, BLOCK_TYPE);
-  }
-
-  /**
-   * Creates a block on the given workspace.
-   *
-   * @param blockDefinition A JSON representation of the block to create.
-   * @param workspace The workspace to create the block on.
-   * @returns The newly created block.
-   */
-  createBlock(blockDefinition: BlockInfo, workspace: WorkspaceSvg): BlockSvg {
-    let block;
-    if (blockDefinition['blockxml']) {
-      const xml = (
-        typeof blockDefinition['blockxml'] === 'string'
-          ? utilsXml.textToDom(blockDefinition['blockxml'])
-          : blockDefinition['blockxml']
-      ) as Element;
-      block = Xml.domToBlockInternal(xml, workspace);
-    } else {
-      if (blockDefinition['enabled'] === undefined) {
-        blockDefinition['enabled'] =
-          blockDefinition['disabled'] !== 'true' &&
-          blockDefinition['disabled'] !== true;
-      }
-      if (
-        blockDefinition['disabledReasons'] === undefined &&
-        blockDefinition['enabled'] === false
-      ) {
-        blockDefinition['disabledReasons'] = [MANUALLY_DISABLED];
-      }
-      // These fields used to be allowed and may still be present, but are
-      // ignored here since everything in the flyout should always be laid out
-      // linearly.
-      if ('x' in blockDefinition) {
-        delete blockDefinition['x'];
-      }
-      if ('y' in blockDefinition) {
-        delete blockDefinition['y'];
-      }
-      block = blocks.appendInternal(blockDefinition as blocks.State, workspace);
-    }
-
-    return block as BlockSvg;
-  }
-
-  /**
-   * Returns the amount of space that should follow this block.
-   *
-   * @param state A JSON representation of a flyout block.
-   * @param defaultGap The default spacing for flyout items.
-   * @returns The amount of space that should follow this block.
-   */
-  gapForItem(state: object, defaultGap: number): number {
-    const blockState = state as BlockInfo;
-    let gap;
-    if (blockState['gap']) {
-      gap = parseInt(String(blockState['gap']));
-    } else if (blockState['blockxml']) {
-      const xml = (
-        typeof blockState['blockxml'] === 'string'
-          ? utilsXml.textToDom(blockState['blockxml'])
-          : blockState['blockxml']
-      ) as Element;
-      gap = parseInt(xml.getAttribute('gap')!);
-    }
-
-    return !gap || isNaN(gap) ? defaultGap : gap;
-  }
-
-  /**
-   * Disposes of the given block.
-   *
-   * @param item The flyout block to dispose of.
-   */
-  disposeItem(item: FlyoutItem): void {
-    const element = item.getElement();
-    if (!(element instanceof BlockSvg)) return;
-    this.removeListeners(element.id);
-    element.dispose(false, false);
-  }
-
-  /**
-   * Removes event listeners for the block with the given ID.
-   *
-   * @param blockId The ID of the block to remove event listeners from.
-   */
-  protected removeListeners(blockId: string) {
-    const blockListeners = this.listeners.get(blockId) ?? [];
-    blockListeners.forEach((l) => browserEvents.unbind(l));
-    this.listeners.delete(blockId);
-  }
-
-  /**
-   * Updates this inflater's flyout.
-   *
-   * @param flyout The flyout that owns this inflater.
-   */
-  protected setFlyout(flyout: IFlyout) {
-    if (this.flyout === flyout) return;
-
-    if (this.flyout) {
-      this.flyout.targetWorkspace?.removeChangeListener(this.capacityWrapper);
-    }
-    this.flyout = flyout;
-    this.flyout.targetWorkspace?.addChangeListener(this.capacityWrapper);
-  }
-
-  /**
-   * Updates the enabled state of the given block based on the capacity of the
-   * workspace.
-   *
-   * @param block The block to update the enabled/disabled state of.
-   */
-  private updateStateBasedOnCapacity(block: BlockSvg) {
-    const enable = this.flyout?.targetWorkspace?.isCapacityAvailable(
-      common.getBlockTypeCounts(block),
-    );
-    let currentBlock: BlockSvg | null = block;
-    while (currentBlock) {
-      currentBlock.setDisabledReason(
-        !enable,
-        WORKSPACE_AT_BLOCK_CAPACITY_DISABLED_REASON,
-      );
-      currentBlock = currentBlock.getNextBlock();
-    }
-  }
-
-  /**
-   * Add listeners to a block that has been added to the flyout.
-   *
-   * @param block The block to add listeners for.
-   */
-  protected addBlockListeners(block: BlockSvg) {
-    const blockListeners = [];
-
-    blockListeners.push(
-      browserEvents.conditionalBind(
-        block.getSvgRoot(),
-        'pointerdown',
-        block,
-        (e: PointerEvent) => {
-          const gesture = this.flyout?.targetWorkspace?.getGesture(e);
-          if (gesture && this.flyout) {
-            gesture.setStartBlock(block);
-            gesture.handleFlyoutStart(e, this.flyout);
-          }
-        },
-      ),
-    );
-
-    blockListeners.push(
-      browserEvents.bind(block.getSvgRoot(), 'pointermove', null, () => {
-        if (!this.flyout?.targetWorkspace?.isDragging()) {
-          block.addSelect();
-        }
-      }),
-    );
-    blockListeners.push(
-      browserEvents.bind(block.getSvgRoot(), 'pointerleave', null, () => {
-        if (!this.flyout?.targetWorkspace?.isDragging()) {
-          block.removeSelect();
-        }
-      }),
-    );
-
-    this.listeners.set(block.id, blockListeners);
-  }
-
-  /**
-   * Updates the state of blocks in our owning flyout to be disabled/enabled
-   * based on the capacity of the workspace for more blocks of that type.
-   *
-   * @param event The event that triggered this update.
-   */
-  private filterFlyoutBasedOnCapacity(event: AbstractEvent) {
-    if (
-      !this.flyout ||
-      (event &&
-        !(
-          event.type === EventType.BLOCK_CREATE ||
-          event.type === EventType.BLOCK_DELETE
-        ))
-    )
-      return;
-
-    this.flyout
-      .getWorkspace()
-      .getTopBlocks(false)
-      .forEach((block) => {
-        if (!this.permanentlyDisabledBlocks.has(block)) {
-          this.updateStateBasedOnCapacity(block);
-        }
-      });
-  }
-
-  /**
-   * Returns the type of items this inflater is responsible for creating.
-   *
-   * @returns An identifier for the type of items this inflater creates.
-   */
-  getType() {
-    return BLOCK_TYPE;
-  }
-}
-
-registry.register(
-  registry.Type.FLYOUT_INFLATER,
-  BLOCK_TYPE,
-  BlockFlyoutInflater,
-);