blockly 8.0.5 → 9.0.0-beta.0

package/core/events/events_ui_base.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Abstract as AbstractEvent } from './events_abstract.js';
+/**
+ * Base class for a UI event.
+ * UI events are events that don't need to be sent over the wire for multi-user
+ * editing to work (e.g. scrolling the workspace, zooming, opening toolbox
+ * categories).
+ * UI events do not undo or redo.
+ * @alias Blockly.Events.UiBase
+ */
+export declare class UiBase extends AbstractEvent {
+    isBlank: boolean;
+    workspaceId: string;
+    recordUndo: boolean;
+    /** Whether or not the event is a UI event. */
+    isUiEvent: boolean;
+    /**
+     * @param opt_workspaceId The workspace identifier for this event.
+     *    Undefined for a blank event.
+     */
+    constructor(opt_workspaceId?: string);
+}

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

@@ -8,16 +8,16 @@
  * @fileoverview Base class for events fired as a result of UI actions in
  * Blockly's editor.
  */
-'use strict';
 
 /**
  * Base class for events fired as a result of UI actions in
  * Blockly's editor.
  * @class
  */
-goog.module('Blockly.Events.UiBase');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.UiBase');
 
-const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
+import {Abstract as AbstractEvent} from './events_abstract.js';
 
 
 /**
@@ -26,38 +26,29 @@ const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
  * editing to work (e.g. scrolling the workspace, zooming, opening toolbox
  * categories).
  * UI events do not undo or redo.
- * @extends {AbstractEvent}
  * @alias Blockly.Events.UiBase
  */
-class UiBase extends AbstractEvent {
+export class UiBase extends AbstractEvent {
+  override isBlank: boolean;
+  override workspaceId: string;
+
+  // UI events do not undo or redo.
+  override recordUndo = false;
+
+  /** Whether or not the event is a UI event. */
+  override isUiEvent = true;
+
   /**
-   * @param {string=} opt_workspaceId The workspace identifier for this event.
+   * @param opt_workspaceId The workspace identifier for this event.
    *    Undefined for a blank event.
    */
-  constructor(opt_workspaceId) {
+  constructor(opt_workspaceId?: string) {
     super();
 
-    /**
-     * Whether or not the event is blank (to be populated by fromJson).
-     * @type {boolean}
-     */
+    /** Whether or not the event is blank (to be populated by fromJson). */
     this.isBlank = typeof opt_workspaceId === 'undefined';
 
-    /**
-     * The workspace identifier for this event.
-     * @type {string}
-     */
+    /** The workspace identifier for this event. */
     this.workspaceId = opt_workspaceId ? opt_workspaceId : '';
-
-    // UI events do not undo or redo.
-    this.recordUndo = false;
-
-    /**
-     * Whether or not the event is a UI event.
-     * @type {boolean}
-     */
-    this.isUiEvent = true;
   }
 }
-
-exports.UiBase = UiBase;

package/core/events/events_var_base.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { VariableModel } from '../variable_model.js';
+import { Abstract as AbstractEvent } from './events_abstract.js';
+/**
+ * Abstract class for a variable event.
+ * @alias Blockly.Events.VarBase
+ */
+export declare class VarBase extends AbstractEvent {
+    isBlank: any;
+    varId: string;
+    workspaceId: string;
+    /**
+     * @param opt_variable The variable this event corresponds to.  Undefined for
+     *     a blank event.
+     */
+    constructor(opt_variable?: VariableModel);
+    /**
+     * 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_var_base.ts

@@ -0,0 +1,65 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Abstract class for a variable event.
+ */
+
+/**
+ * Abstract class for a variable event.
+ * @class
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.VarBase');
+
+import type {VariableModel} from '../variable_model.js';
+
+import {Abstract as AbstractEvent} from './events_abstract.js';
+
+
+/**
+ * Abstract class for a variable event.
+ * @alias Blockly.Events.VarBase
+ */
+export class VarBase extends AbstractEvent {
+  override isBlank: AnyDuringMigration;
+  varId: string;
+  override workspaceId: string;
+
+  /**
+   * @param opt_variable The variable this event corresponds to.  Undefined for
+   *     a blank event.
+   */
+  constructor(opt_variable?: VariableModel) {
+    super();
+    this.isBlank = typeof opt_variable === 'undefined';
+
+    /** The variable id for the variable this event pertains to. */
+    this.varId = this.isBlank ? '' : opt_variable!.getId();
+
+    /** The workspace identifier for this event. */
+    this.workspaceId = this.isBlank ? '' : opt_variable!.workspace.id;
+  }
+
+  /**
+   * Encode the event as JSON.
+   * @return JSON representation.
+   */
+  override toJson(): AnyDuringMigration {
+    const json = super.toJson();
+    json['varId'] = this.varId;
+    return json;
+  }
+
+  /**
+   * Decode the JSON event.
+   * @param json JSON representation.
+   */
+  override fromJson(json: AnyDuringMigration) {
+    super.fromJson(json);
+    this.varId = json['varId'];
+  }
+}

package/core/events/events_var_create.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { VariableModel } from '../variable_model.js';
+import { VarBase } from './events_var_base.js';
+/**
+ * Class for a variable creation event.
+ * @alias Blockly.Events.VarCreate
+ */
+export declare class VarCreate extends VarBase {
+    type: string;
+    varType: string;
+    varName: string;
+    /**
+     * @param opt_variable The created variable. Undefined for a blank event.
+     */
+    constructor(opt_variable?: VariableModel);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Run a variable creation event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}

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

@@ -7,53 +7,54 @@
 /**
  * @fileoverview Class for a variable creation event.
  */
-'use strict';
 
 /**
  * Class for a variable creation event.
  * @class
  */
-goog.module('Blockly.Events.VarCreate');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.VarCreate');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {VarBase} = goog.require('Blockly.Events.VarBase');
-/* eslint-disable-next-line no-unused-vars */
-const {VariableModel} = goog.requireType('Blockly.VariableModel');
+import * as registry from '../registry.js';
+import type {VariableModel} from '../variable_model.js';
+
+import {VarBase} from './events_var_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a variable creation event.
- * @extends {VarBase}
  * @alias Blockly.Events.VarCreate
  */
-class VarCreate extends VarBase {
+export class VarCreate extends VarBase {
+  override type: string;
+
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  varType!: string;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  varName!: string;
+
   /**
-   * @param {!VariableModel=} opt_variable The created variable. Undefined
-   *     for a blank event.
+   * @param opt_variable The created variable. Undefined for a blank event.
    */
-  constructor(opt_variable) {
+  constructor(opt_variable?: VariableModel) {
     super(opt_variable);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.VAR_CREATE;
 
     if (!opt_variable) {
       return;  // Blank event to be populated by fromJson.
     }
-
     this.varType = opt_variable.type;
     this.varName = opt_variable.name;
   }
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['varType'] = this.varType;
     json['varName'] = this.varName;
@@ -62,9 +63,9 @@ class VarCreate extends VarBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.varType = json['varType'];
     this.varName = json['varName'];
@@ -72,9 +73,9 @@ class VarCreate extends VarBase {
 
   /**
    * Run a variable creation event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
+   * @param forward True if run forward, false if run backward (undo).
    */
-  run(forward) {
+  override run(forward: boolean) {
     const workspace = this.getEventWorkspace_();
     if (forward) {
       workspace.createVariable(this.varName, this.varType, this.varId);
@@ -85,5 +86,3 @@ class VarCreate extends VarBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.VAR_CREATE, VarCreate);
-
-exports.VarCreate = VarCreate;

package/core/events/events_var_delete.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { VariableModel } from '../variable_model.js';
+import { VarBase } from './events_var_base.js';
+/**
+ * Class for a variable deletion event.
+ * @alias Blockly.Events.VarDelete
+ */
+export declare class VarDelete extends VarBase {
+    type: string;
+    varType: string;
+    varName: string;
+    /**
+     * @param opt_variable The deleted variable. Undefined for a blank event.
+     */
+    constructor(opt_variable?: VariableModel);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Run a variable deletion event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}

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

@@ -7,53 +7,54 @@
 /**
  * @fileoverview Classes for all types of variable events.
  */
-'use strict';
 
 /**
  * Classes for all types of variable events.
  * @class
  */
-goog.module('Blockly.Events.VarDelete');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.VarDelete');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {VarBase} = goog.require('Blockly.Events.VarBase');
-/* eslint-disable-next-line no-unused-vars */
-const {VariableModel} = goog.requireType('Blockly.VariableModel');
+import * as registry from '../registry.js';
+import type {VariableModel} from '../variable_model.js';
+
+import {VarBase} from './events_var_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a variable deletion event.
- * @extends {VarBase}
  * @alias Blockly.Events.VarDelete
  */
-class VarDelete extends VarBase {
+export class VarDelete extends VarBase {
+  override type: string;
+
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  varType!: string;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  varName!: string;
+
   /**
-   * @param {!VariableModel=} opt_variable The deleted variable. Undefined
-   *     for a blank event.
+   * @param opt_variable The deleted variable. Undefined for a blank event.
    */
-  constructor(opt_variable) {
+  constructor(opt_variable?: VariableModel) {
     super(opt_variable);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.VAR_DELETE;
 
     if (!opt_variable) {
       return;  // Blank event to be populated by fromJson.
     }
-
     this.varType = opt_variable.type;
     this.varName = opt_variable.name;
   }
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['varType'] = this.varType;
     json['varName'] = this.varName;
@@ -62,9 +63,9 @@ class VarDelete extends VarBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.varType = json['varType'];
     this.varName = json['varName'];
@@ -72,9 +73,9 @@ class VarDelete extends VarBase {
 
   /**
    * Run a variable deletion event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
+   * @param forward True if run forward, false if run backward (undo).
    */
-  run(forward) {
+  override run(forward: boolean) {
     const workspace = this.getEventWorkspace_();
     if (forward) {
       workspace.deleteVariableById(this.varId);
@@ -85,5 +86,3 @@ class VarDelete extends VarBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.VAR_DELETE, VarDelete);
-
-exports.VarDelete = VarDelete;

package/core/events/events_var_rename.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { VariableModel } from '../variable_model.js';
+import { VarBase } from './events_var_base.js';
+/**
+ * Class for a variable rename event.
+ * @alias Blockly.Events.VarRename
+ */
+export declare class VarRename extends VarBase {
+    type: string;
+    oldName: string;
+    newName: string;
+    /**
+     * @param opt_variable The renamed variable. Undefined for a blank event.
+     * @param newName The new name the variable will be changed to.
+     */
+    constructor(opt_variable?: VariableModel, newName?: string);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+    /**
+     * Run a variable rename event.
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}

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

@@ -7,54 +7,55 @@
 /**
  * @fileoverview Class for a variable rename event.
  */
-'use strict';
 
 /**
  * Class for a variable rename event.
  * @class
  */
-goog.module('Blockly.Events.VarRename');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.Events.VarRename');
 
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {VarBase} = goog.require('Blockly.Events.VarBase');
-/* eslint-disable-next-line no-unused-vars */
-const {VariableModel} = goog.requireType('Blockly.VariableModel');
+import * as registry from '../registry.js';
+import type {VariableModel} from '../variable_model.js';
+
+import {VarBase} from './events_var_base.js';
+import * as eventUtils from './utils.js';
 
 
 /**
  * Class for a variable rename event.
- * @extends {VarBase}
  * @alias Blockly.Events.VarRename
  */
-class VarRename extends VarBase {
+export class VarRename extends VarBase {
+  override type: string;
+
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  oldName!: string;
+  // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
+  newName!: string;
+
   /**
-   * @param {!VariableModel=} opt_variable The renamed variable. Undefined
-   *     for a blank event.
-   * @param {string=} newName The new name the variable will be changed to.
+   * @param opt_variable The renamed variable. Undefined for a blank event.
+   * @param newName The new name the variable will be changed to.
    */
-  constructor(opt_variable, newName) {
+  constructor(opt_variable?: VariableModel, newName?: string) {
     super(opt_variable);
 
-    /**
-     * Type of this event.
-     * @type {string}
-     */
+    /** Type of this event. */
     this.type = eventUtils.VAR_RENAME;
 
     if (!opt_variable) {
       return;  // Blank event to be populated by fromJson.
     }
-
     this.oldName = opt_variable.name;
     this.newName = typeof newName === 'undefined' ? '' : newName;
   }
 
   /**
    * Encode the event as JSON.
-   * @return {!Object} JSON representation.
+   * @return JSON representation.
    */
-  toJson() {
+  override toJson(): AnyDuringMigration {
     const json = super.toJson();
     json['oldName'] = this.oldName;
     json['newName'] = this.newName;
@@ -63,9 +64,9 @@ class VarRename extends VarBase {
 
   /**
    * Decode the JSON event.
-   * @param {!Object} json JSON representation.
+   * @param json JSON representation.
    */
-  fromJson(json) {
+  override fromJson(json: AnyDuringMigration) {
     super.fromJson(json);
     this.oldName = json['oldName'];
     this.newName = json['newName'];
@@ -73,9 +74,9 @@ class VarRename extends VarBase {
 
   /**
    * Run a variable rename event.
-   * @param {boolean} forward True if run forward, false if run backward (undo).
+   * @param forward True if run forward, false if run backward (undo).
    */
-  run(forward) {
+  override run(forward: boolean) {
     const workspace = this.getEventWorkspace_();
     if (forward) {
       workspace.renameVariableById(this.varId, this.newName);
@@ -86,5 +87,3 @@ class VarRename extends VarBase {
 }
 
 registry.register(registry.Type.EVENT, eventUtils.VAR_RENAME, VarRename);
-
-exports.VarRename = VarRename;

package/core/events/events_viewport.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { UiBase } from './events_ui_base.js';
+/**
+ * Class for a viewport change event.
+ * @alias Blockly.Events.ViewportChange
+ */
+export declare class ViewportChange extends UiBase {
+    viewTop?: number;
+    viewLeft?: number;
+    scale?: number;
+    oldScale?: number;
+    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);
+    /**
+     * Encode the event as JSON.
+     * @return JSON representation.
+     */
+    toJson(): any;
+    /**
+     * Decode the JSON event.
+     * @param json JSON representation.
+     */
+    fromJson(json: any): void;
+}