blockly 8.0.5 → 9.0.0-beta.0

package/core/events/events_marker_move.ts

@@ -0,0 +1,99 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Events fired as a result of a marker move.
+ */
+
+/**
+ * Events fired as a result of a marker move.
+ * @class
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.MarkerMove');
+
+import type {Block} from '../block.js';
+import {ASTNode} from '../keyboard_nav/ast_node.js';
+import * as registry from '../registry.js';
+import type {Workspace} from '../workspace.js';
+
+import {UiBase} from './events_ui_base.js';
+import * as eventUtils from './utils.js';
+
+
+/**
+ * Class for a marker move event.
+ * @alias Blockly.Events.MarkerMove
+ */
+export class MarkerMove extends UiBase {
+  blockId: string|null;
+  oldNode?: ASTNode|null;
+  newNode?: ASTNode;
+  isCursor?: boolean;
+  override type: string;
+
+  /**
+   * @param opt_block The affected block. Null if current node is of type
+   *     workspace. Undefined for a blank event.
+   * @param isCursor Whether this is a cursor event. Undefined for a blank
+   *     event.
+   * @param opt_oldNode The old node the marker used to be on.
+   *    Undefined for a blank event.
+   * @param opt_newNode The new node the marker is now on.
+   *    Undefined for a blank event.
+   */
+  constructor(
+      opt_block?: Block|null, isCursor?: boolean, opt_oldNode?: ASTNode|null,
+      opt_newNode?: ASTNode) {
+    let workspaceId = opt_block ? opt_block.workspace.id : undefined;
+    if (opt_newNode && opt_newNode.getType() === ASTNode.types.WORKSPACE) {
+      workspaceId = (opt_newNode.getLocation() as Workspace).id;
+    }
+    super(workspaceId);
+
+    /** The workspace identifier for this event. */
+    this.blockId = opt_block ? opt_block.id : null;
+
+    /** The old node the marker used to be on. */
+    this.oldNode = opt_oldNode;
+
+    /** The new node the  marker is now on. */
+    this.newNode = opt_newNode;
+
+    /** Whether this is a cursor event. */
+    this.isCursor = isCursor;
+
+    /** Type of this event. */
+    this.type = eventUtils.MARKER_MOVE;
+  }
+
+  /**
+   * Encode the event as JSON.
+   * @return JSON representation.
+   */
+  override toJson(): AnyDuringMigration {
+    const json = super.toJson();
+    json['isCursor'] = this.isCursor;
+    json['blockId'] = this.blockId;
+    json['oldNode'] = this.oldNode;
+    json['newNode'] = this.newNode;
+    return json;
+  }
+
+  /**
+   * Decode the JSON event.
+   * @param json JSON representation.
+   */
+  override fromJson(json: AnyDuringMigration) {
+    super.fromJson(json);
+    this.isCursor = json['isCursor'];
+    this.blockId = json['blockId'];
+    this.oldNode = json['oldNode'];
+    this.newNode = json['newNode'];
+  }
+}
+
+registry.register(registry.Type.EVENT, eventUtils.MARKER_MOVE, MarkerMove);

package/core/events/events_selected.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a selected event.
+ * @alias Blockly.Events.Selected
+ */
+export declare class Selected extends UiBase {
+    oldElementId?: string | null;
+    newElementId?: string | null;
+    type: string;
+    /**
+     * @param opt_oldElementId The ID of the previously selected element. Null if
+     *     no element last selected. Undefined for a blank event.
+     * @param opt_newElementId The ID of the selected element. Null if no element
+     *     currently selected (deselect). Undefined for a blank event.
+     * @param opt_workspaceId The workspace identifier for this event.
+     *    Null if no element previously selected. Undefined for a blank event.
+     */
+    constructor(opt_oldElementId?: string | null, opt_newElementId?: string | null, opt_workspaceId?: string);
+    /**
+     * 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_selected.ts

@@ -0,0 +1,78 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Events fired as a result of element select action.
+ */
+
+/**
+ * Events fired as a result of element select action.
+ * @class
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.Selected');
+
+import * as registry from '../registry.js';
+
+import {UiBase} from './events_ui_base.js';
+import * as eventUtils from './utils.js';
+
+
+/**
+ * Class for a selected event.
+ * @alias Blockly.Events.Selected
+ */
+export class Selected extends UiBase {
+  oldElementId?: string|null;
+  newElementId?: string|null;
+  override type: string;
+
+  /**
+   * @param opt_oldElementId The ID of the previously selected element. Null if
+   *     no element last selected. Undefined for a blank event.
+   * @param opt_newElementId The ID of the selected element. Null if no element
+   *     currently selected (deselect). Undefined for a blank event.
+   * @param opt_workspaceId The workspace identifier for this event.
+   *    Null if no element previously selected. Undefined for a blank event.
+   */
+  constructor(
+      opt_oldElementId?: string|null, opt_newElementId?: string|null,
+      opt_workspaceId?: string) {
+    super(opt_workspaceId);
+
+    /** The id of the last selected element. */
+    this.oldElementId = opt_oldElementId;
+
+    /** The id of the selected element. */
+    this.newElementId = opt_newElementId;
+
+    /** Type of this event. */
+    this.type = eventUtils.SELECTED;
+  }
+
+  /**
+   * Encode the event as JSON.
+   * @return JSON representation.
+   */
+  override toJson(): AnyDuringMigration {
+    const json = super.toJson();
+    json['oldElementId'] = this.oldElementId;
+    json['newElementId'] = this.newElementId;
+    return json;
+  }
+
+  /**
+   * Decode the JSON event.
+   * @param json JSON representation.
+   */
+  override fromJson(json: AnyDuringMigration) {
+    super.fromJson(json);
+    this.oldElementId = json['oldElementId'];
+    this.newElementId = json['newElementId'];
+  }
+}
+
+registry.register(registry.Type.EVENT, eventUtils.SELECTED, Selected);

package/core/events/events_theme_change.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a theme change event.
+ * @alias Blockly.Events.ThemeChange
+ */
+export declare class ThemeChange extends UiBase {
+    themeName?: string;
+    type: string;
+    /**
+     * @param opt_themeName The theme name. Undefined for a blank event.
+     * @param opt_workspaceId The workspace identifier for this event.
+     *    event. Undefined for a blank event.
+     */
+    constructor(opt_themeName?: string, opt_workspaceId?: string);
+    /**
+     * 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_theme_change.js → events_theme_change.ts}

@@ -7,51 +7,48 @@
 /**
  * @fileoverview Events fired as a result of a theme update.
  */
-'use strict';
 
 /**
  * Events fired as a result of a theme update.
  * @class
  */
-goog.module('Blockly.Events.ThemeChange');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.ThemeChange');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {UiBase} = goog.require('Blockly.Events.UiBase');
+import * as registry from '../registry.js';
+
+import {UiBase} from './events_ui_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a theme change event.
- * @extends {UiBase}
  * @alias Blockly.Events.ThemeChange
  */
-class ThemeChange extends UiBase {
+export class ThemeChange extends UiBase {
+  themeName?: string;
+  override type: string;
+
   /**
-   * @param {string=} opt_themeName The theme name. Undefined for a blank event.
-   * @param {string=} opt_workspaceId The workspace identifier for this event.
+   * @param opt_themeName The theme name. Undefined for a blank event.
+   * @param opt_workspaceId The workspace identifier for this event.
    *    event. Undefined for a blank event.
    */
-  constructor(opt_themeName, opt_workspaceId) {
+  constructor(opt_themeName?: string, opt_workspaceId?: string) {
     super(opt_workspaceId);
 
-    /**
-     * The theme name.
-     * @type {string|undefined}
-     */
+    /** The theme name. */
     this.themeName = opt_themeName;
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.THEME_CHANGE;
   }
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['themeName'] = this.themeName;
     return json;
@@ -59,14 +56,12 @@ class ThemeChange extends UiBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.themeName = json['themeName'];
   }
 }
 
 registry.register(registry.Type.EVENT, eventUtils.THEME_CHANGE, ThemeChange);
-
-exports.ThemeChange = ThemeChange;

package/core/events/events_toolbox_item_select.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a toolbox item select event.
+ * @alias Blockly.Events.ToolboxItemSelect
+ */
+export declare class ToolboxItemSelect extends UiBase {
+    oldItem?: string | null;
+    newItem?: string | null;
+    type: string;
+    /**
+     * @param opt_oldItem The previously selected toolbox item.
+     *     Undefined for a blank event.
+     * @param opt_newItem The newly selected toolbox item. Undefined for a blank
+     *     event.
+     * @param opt_workspaceId The workspace identifier for this event.
+     *    Undefined for a blank event.
+     */
+    constructor(opt_oldItem?: string | null, opt_newItem?: string | null, opt_workspaceId?: string);
+    /**
+     * 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_toolbox_item_select.ts

@@ -0,0 +1,79 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Events fired as a result of selecting an item on the toolbox.
+ */
+
+/**
+ * Events fired as a result of selecting an item on the toolbox.
+ * @class
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.ToolboxItemSelect');
+
+import * as registry from '../registry.js';
+
+import {UiBase} from './events_ui_base.js';
+import * as eventUtils from './utils.js';
+
+
+/**
+ * Class for a toolbox item select event.
+ * @alias Blockly.Events.ToolboxItemSelect
+ */
+export class ToolboxItemSelect extends UiBase {
+  oldItem?: string|null;
+  newItem?: string|null;
+  override type: string;
+
+  /**
+   * @param opt_oldItem The previously selected toolbox item.
+   *     Undefined for a blank event.
+   * @param opt_newItem The newly selected toolbox item. Undefined for a blank
+   *     event.
+   * @param opt_workspaceId The workspace identifier for this event.
+   *    Undefined for a blank event.
+   */
+  constructor(
+      opt_oldItem?: string|null, opt_newItem?: string|null,
+      opt_workspaceId?: string) {
+    super(opt_workspaceId);
+
+    /** The previously selected toolbox item. */
+    this.oldItem = opt_oldItem;
+
+    /** The newly selected toolbox item. */
+    this.newItem = opt_newItem;
+
+    /** Type of this event. */
+    this.type = eventUtils.TOOLBOX_ITEM_SELECT;
+  }
+
+  /**
+   * Encode the event as JSON.
+   * @return JSON representation.
+   */
+  override toJson(): AnyDuringMigration {
+    const json = super.toJson();
+    json['oldItem'] = this.oldItem;
+    json['newItem'] = this.newItem;
+    return json;
+  }
+
+  /**
+   * Decode the JSON event.
+   * @param json JSON representation.
+   */
+  override fromJson(json: AnyDuringMigration) {
+    super.fromJson(json);
+    this.oldItem = json['oldItem'];
+    this.newItem = json['newItem'];
+  }
+}
+
+registry.register(
+    registry.Type.EVENT, eventUtils.TOOLBOX_ITEM_SELECT, ToolboxItemSelect);

package/core/events/events_trashcan_open.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a trashcan open event.
+ * @alias Blockly.Events.TrashcanOpen
+ */
+export declare class TrashcanOpen extends UiBase {
+    isOpen?: boolean;
+    type: string;
+    /**
+     * @param opt_isOpen Whether the trashcan flyout is opening (false if
+     *     opening). Undefined for a blank event.
+     * @param opt_workspaceId The workspace identifier for this event.
+     *    Undefined for a blank event.
+     */
+    constructor(opt_isOpen?: boolean, opt_workspaceId?: string);
+    /**
+     * 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_trashcan_open.ts

@@ -0,0 +1,68 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Events fired as a result of trashcan flyout open and close.
+ */
+
+/**
+ * Events fired as a result of trashcan flyout open and close.
+ * @class
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.TrashcanOpen');
+
+import * as registry from '../registry.js';
+
+import {UiBase} from './events_ui_base.js';
+import * as eventUtils from './utils.js';
+
+
+/**
+ * Class for a trashcan open event.
+ * @alias Blockly.Events.TrashcanOpen
+ */
+export class TrashcanOpen extends UiBase {
+  isOpen?: boolean;
+  override type: string;
+
+  /**
+   * @param opt_isOpen Whether the trashcan flyout is opening (false if
+   *     opening). Undefined for a blank event.
+   * @param opt_workspaceId The workspace identifier for this event.
+   *    Undefined for a blank event.
+   */
+  constructor(opt_isOpen?: boolean, opt_workspaceId?: string) {
+    super(opt_workspaceId);
+
+    /** Whether the trashcan flyout is opening (false if closing). */
+    this.isOpen = opt_isOpen;
+
+    /** Type of this event. */
+    this.type = eventUtils.TRASHCAN_OPEN;
+  }
+
+  /**
+   * Encode the event as JSON.
+   * @return JSON representation.
+   */
+  override toJson(): AnyDuringMigration {
+    const json = super.toJson();
+    json['isOpen'] = this.isOpen;
+    return json;
+  }
+
+  /**
+   * Decode the JSON event.
+   * @param json JSON representation.
+   */
+  override fromJson(json: AnyDuringMigration) {
+    super.fromJson(json);
+    this.isOpen = json['isOpen'];
+  }
+}
+
+registry.register(registry.Type.EVENT, eventUtils.TRASHCAN_OPEN, TrashcanOpen);

package/core/events/events_ui.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from '../block.js';
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a UI event.
+ * @deprecated December 2020. Instead use a more specific UI event.
+ * @alias Blockly.Events.Ui
+ */
+export declare class Ui extends UiBase {
+    blockId: any;
+    element: any;
+    oldValue: any;
+    newValue: any;
+    type: string;
+    /**
+     * @param opt_block The affected block.  Null for UI events that do not have
+     *     an associated block.  Undefined for a blank event.
+     * @param opt_element One of 'selected', 'comment', 'mutatorOpen', etc.
+     * @param opt_oldValue Previous value of element.
+     * @param opt_newValue New value of element.
+     */
+    constructor(opt_block?: Block | null, opt_element?: string, 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;
+}

package/core/events/{events_ui.js → events_ui.ts}

@@ -8,38 +8,44 @@
  * @fileoverview (Deprecated) Events fired as a result of UI actions in
  * Blockly's editor.
  */
-'use strict';
 
 /**
  * (Deprecated) Events fired as a result of UI actions in
  * Blockly's editor.
  * @class
  */
-goog.module('Blockly.Events.Ui');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.Ui');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-const {UiBase} = goog.require('Blockly.Events.UiBase');
+import type {Block} from '../block.js';
+import * as registry from '../registry.js';
+
+import {UiBase} from './events_ui_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a UI event.
- * @extends {UiBase}
  * @deprecated December 2020. Instead use a more specific UI event.
  * @alias Blockly.Events.Ui
  */
-class Ui extends UiBase {
+export class Ui extends UiBase {
+  blockId: AnyDuringMigration;
+  element: AnyDuringMigration;
+  oldValue: AnyDuringMigration;
+  newValue: AnyDuringMigration;
+  override type: string;
+
   /**
-   * @param {?Block=} opt_block The affected block.  Null for UI events
-   *     that do not have an associated block.  Undefined for a blank event.
-   * @param {string=} opt_element One of 'selected', 'comment', 'mutatorOpen',
-   *     etc.
-   * @param {*=} opt_oldValue Previous value of element.
-   * @param {*=} opt_newValue New value of element.
+   * @param opt_block The affected block.  Null for UI events that do not have
+   *     an associated block.  Undefined for a blank event.
+   * @param opt_element One of 'selected', 'comment', 'mutatorOpen', etc.
+   * @param opt_oldValue Previous value of element.
+   * @param opt_newValue New value of element.
    */
-  constructor(opt_block, opt_element, opt_oldValue, opt_newValue) {
+  constructor(
+      opt_block?: Block|null, opt_element?: string,
+      opt_oldValue?: AnyDuringMigration, opt_newValue?: AnyDuringMigration) {
     const workspaceId = opt_block ? opt_block.workspace.id : undefined;
     super(workspaceId);
 
@@ -48,18 +54,15 @@ class Ui extends UiBase {
     this.oldValue = typeof opt_oldValue === 'undefined' ? '' : opt_oldValue;
     this.newValue = typeof opt_newValue === 'undefined' ? '' : opt_newValue;
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.UI;
   }
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['element'] = this.element;
     if (this.newValue !== undefined) {
@@ -73,9 +76,9 @@ class Ui extends UiBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.element = json['element'];
     this.newValue = json['newValue'];
@@ -84,5 +87,3 @@ class Ui extends UiBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.UI, Ui);
-
-exports.Ui = Ui;