blockly 8.0.5 → 9.0.0-beta.0

package/core/events/events.d.ts

@@ -0,0 +1,102 @@
+/**
+ * @license
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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';
+export declare const Abstract: typeof 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 };
+export declare const BLOCK_CHANGE = "change";
+export declare const BLOCK_CREATE = "create";
+export declare const BLOCK_DELETE = "delete";
+export declare const BLOCK_DRAG = "drag";
+export declare const BLOCK_MOVE = "move";
+export declare const BUBBLE_OPEN = "bubble_open";
+export declare type BumpEvent = eventUtils.BumpEvent;
+export declare const BUMP_EVENTS: string[];
+export declare const CHANGE = "change";
+export declare const CLICK = "click";
+export declare const COMMENT_CHANGE = "comment_change";
+export declare const COMMENT_CREATE = "comment_create";
+export declare const COMMENT_DELETE = "comment_delete";
+export declare const COMMENT_MOVE = "comment_move";
+export declare const CREATE = "create";
+export declare const DELETE = "delete";
+export declare const FINISHED_LOADING = "finished_loading";
+export declare const MARKER_MOVE = "marker_move";
+export declare const MOVE = "move";
+export declare const SELECTED = "selected";
+export declare const THEME_CHANGE = "theme_change";
+export declare const TOOLBOX_ITEM_SELECT = "toolbox_item_select";
+export declare const TRASHCAN_OPEN = "trashcan_open";
+export declare const UI = "ui";
+export declare const VAR_CREATE = "var_create";
+export declare const VAR_DELETE = "var_delete";
+export declare const VAR_RENAME = "var_rename";
+export declare const VIEWPORT_CHANGE = "viewport_change";
+export declare const clearPendingUndo: typeof eventUtils.clearPendingUndo;
+export declare const disable: typeof eventUtils.disable;
+export declare const enable: typeof eventUtils.enable;
+export declare const filter: typeof eventUtils.filter;
+export declare const fire: typeof eventUtils.fire;
+export declare const fromJson: typeof eventUtils.fromJson;
+export declare const getDescendantIds: typeof eventUtils.getDescendantIds;
+export declare const get: typeof eventUtils.get;
+export declare const getGroup: typeof eventUtils.getGroup;
+export declare const getRecordUndo: typeof eventUtils.getRecordUndo;
+export declare const isEnabled: typeof eventUtils.isEnabled;
+export declare const setGroup: typeof eventUtils.setGroup;
+export declare const setRecordUndo: typeof eventUtils.setRecordUndo;
+export declare const disableOrphans: typeof eventUtils.disableOrphans;

package/core/events/events.ts

@@ -0,0 +1,123 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Workspace } from '../workspace.js';
+/**
+ * Abstract class for an event.
+ * @alias Blockly.Events.Abstract
+ */
+export declare abstract class Abstract {
+    /** Whether or not the event is blank (to be populated by fromJson). */
+    isBlank: boolean | null;
+    /** The workspace identifier for this event. */
+    workspaceId?: string;
+    group: string;
+    recordUndo: boolean;
+    /** Whether or not the event is a UI event. */
+    isUiEvent: boolean;
+    /** Type of this event. */
+    type?: string;
+    /** @alias Blockly.Events.Abstract */
+    constructor();
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Does this event record any change of state?
+     * @return True if null, false if something changed.
+     */
+    isNull(): boolean;
+    /**
+     * Run an event.
+     * @param _forward True if run forward, false if run backward (undo).
+     */
+    run(_forward: boolean): void;
+    /**
+     * Get workspace the event belongs to.
+     * @return The workspace the event belongs to.
+     * @throws {Error} if workspace is null.
+     * @internal
+     */
+    getEventWorkspace_(): Workspace;
+}

package/core/events/events_abstract.ts

@@ -0,0 +1,112 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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 declare class BlockBase extends AbstractEvent {
+    isBlank: any;
+    blockId: string;
+    workspaceId: string;
+    /**
+     * @param opt_block The block this event corresponds to.
+     *     Undefined for a blank event.
+     */
+    constructor(opt_block?: Block);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+}

package/core/events/events_block_base.ts

@@ -0,0 +1,65 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from '../block.js';
+import type { BlockSvg } from '../block_svg.js';
+import { BlockBase } from './events_block_base.js';
+/**
+ * Class for a block change event.
+ * @alias Blockly.Events.BlockChange
+ */
+export declare class BlockChange extends BlockBase {
+    type: string;
+    element: string;
+    name: string | null;
+    oldValue: any;
+    newValue: any;
+    /**
+     * @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?: any, opt_newValue?: any);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Does this event record any change of state?
+     * @return False if something changed.
+     */
+    isNull(): boolean;
+    /**
+     * Run a change event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+    /**
+     * 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;
+}