blockly 8.0.5 → 9.0.0-beta.0

package/core/workspace_audio.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { WorkspaceSvg } from './workspace_svg.js';
+/**
+ * Class for loading, storing, and playing audio for a workspace.
+ * @alias Blockly.WorkspaceAudio
+ */
+export declare class WorkspaceAudio {
+    private parentWorkspace;
+    /** Database of pre-loaded sounds. */
+    private sounds;
+    /** Time that the last sound was played. */
+    private lastSound_;
+    /**
+     * @param parentWorkspace The parent of the workspace this audio object
+     *     belongs to, or null.
+     */
+    constructor(parentWorkspace: WorkspaceSvg);
+    /**
+     * Dispose of this audio manager.
+     * @internal
+     */
+    dispose(): void;
+    /**
+     * Load an audio file.  Cache it, ready for instantaneous playing.
+     * @param filenames List of file types in decreasing order of preference (i.e.
+     *     increasing size).  E.g. ['media/go.mp3', 'media/go.wav'] Filenames
+     *     include path from Blockly's root.  File extensions matter.
+     * @param name Name of sound.
+     */
+    load(filenames: string[], name: string): void;
+    /**
+     * Preload all the audio files so that they play quickly when asked for.
+     * @internal
+     */
+    preload(): void;
+    /**
+     * Play a named sound at specified volume.  If volume is not specified,
+     * use full volume (1).
+     * @param name Name of sound.
+     * @param opt_volume Volume of sound (0-1).
+     */
+    play(name: string, opt_volume?: number): void;
+}

package/core/{workspace_audio.js → workspace_audio.ts}

@@ -8,25 +8,22 @@
  * @fileoverview Object in charge of loading, storing, and playing audio for a
  *     workspace.
  */
-'use strict';
 
 /**
  * Object in charge of loading, storing, and playing audio for a
  *     workspace.
  * @class
  */
-goog.module('Blockly.WorkspaceAudio');
+import * as goog from '../closure/goog/goog.js';
+goog.declareModuleId('Blockly.WorkspaceAudio');
 
-const userAgent = goog.require('Blockly.utils.userAgent');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
-const {globalThis} = goog.require('Blockly.utils.global');
+import * as userAgent from './utils/useragent.js';
+import type {WorkspaceSvg} from './workspace_svg.js';
 
 
 /**
  * Prevent a sound from playing if another sound preceded it within this many
  * milliseconds.
- * @const
  */
 const SOUND_LIMIT = 100;
 
@@ -34,50 +31,39 @@ const SOUND_LIMIT = 100;
  * Class for loading, storing, and playing audio for a workspace.
  * @alias Blockly.WorkspaceAudio
  */
-class WorkspaceAudio {
-  /**
-   * @param {WorkspaceSvg} parentWorkspace The parent of the workspace
-   *     this audio object belongs to, or null.
-   */
-  constructor(parentWorkspace) {
-    /**
-     * The parent of the workspace this object belongs to, or null.  May be
-     * checked for sounds that this object can't find.
-     * @type {WorkspaceSvg}
-     * @private
-     */
-    this.parentWorkspace_ = parentWorkspace;
+export class WorkspaceAudio {
+  /** Database of pre-loaded sounds. */
+  private sounds = new Map<string, HTMLAudioElement>();
 
-    /**
-     * Database of pre-loaded sounds.
-     * @private
-     */
-    this.SOUNDS_ = Object.create(null);
+  /** Time that the last sound was played. */
+  // AnyDuringMigration because:  Type 'null' is not assignable to type 'Date'.
+  private lastSound_: Date = null as AnyDuringMigration;
 
-    /**
-     * Time that the last sound was played.
-     * @type {Date}
-     * @private
-     */
-    this.lastSound_ = null;
-  }
+  /**
+   * @param parentWorkspace The parent of the workspace this audio object
+   *     belongs to, or null.
+   */
+  constructor(private parentWorkspace: WorkspaceSvg) {}
 
   /**
    * Dispose of this audio manager.
-   * @package
+   * @internal
    */
   dispose() {
-    this.parentWorkspace_ = null;
-    this.SOUNDS_ = null;
+    // AnyDuringMigration because:  Type 'null' is not assignable to type
+    // 'WorkspaceSvg'.
+    this.parentWorkspace = null as AnyDuringMigration;
+    this.sounds.clear();
   }
+
   /**
    * Load an audio file.  Cache it, ready for instantaneous playing.
-   * @param {!Array<string>} filenames List of file types in decreasing order of
-   *   preference (i.e. increasing size).  E.g. ['media/go.mp3', 'media/go.wav']
-   *   Filenames include path from Blockly's root.  File extensions matter.
-   * @param {string} name Name of sound.
+   * @param filenames List of file types in decreasing order of preference (i.e.
+   *     increasing size).  E.g. ['media/go.mp3', 'media/go.wav'] Filenames
+   *     include path from Blockly's root.  File extensions matter.
+   * @param name Name of sound.
    */
-  load(filenames, name) {
+  load(filenames: string[], name: string) {
     if (!filenames.length) {
       return;
     }
@@ -99,17 +85,17 @@ class WorkspaceAudio {
         break;
       }
     }
-    if (sound && sound.play) {
-      this.SOUNDS_[name] = sound;
+    if (sound) {
+      this.sounds.set(name, sound);
     }
   }
+
   /**
    * Preload all the audio files so that they play quickly when asked for.
-   * @package
+   * @internal
    */
   preload() {
-    for (const name in this.SOUNDS_) {
-      const sound = this.SOUNDS_[name];
+    for (const sound of this.sounds.values()) {
       sound.volume = 0.01;
       const playPromise = sound.play();
       // Edge does not return a promise, so we need to check.
@@ -118,9 +104,10 @@ class WorkspaceAudio {
         // pause() we will get an exception: (DOMException: The play() request
         // was interrupted) See more:
         // https://developers.google.com/web/updates/2017/06/play-request-was-interrupted
-        playPromise.then(sound.pause).catch(function() {
-          // Play without user interaction was prevented.
-        });
+        playPromise.then(sound.pause)
+            .catch(
+                // Play without user interaction was prevented.
+                function() {});
       } else {
         sound.pause();
       }
@@ -133,18 +120,20 @@ class WorkspaceAudio {
       }
     }
   }
+
   /**
    * Play a named sound at specified volume.  If volume is not specified,
    * use full volume (1).
-   * @param {string} name Name of sound.
-   * @param {number=} opt_volume Volume of sound (0-1).
+   * @param name Name of sound.
+   * @param opt_volume Volume of sound (0-1).
    */
-  play(name, opt_volume) {
-    const sound = this.SOUNDS_[name];
+  play(name: string, opt_volume?: number) {
+    const sound = this.sounds.get(name);
     if (sound) {
       // Don't play one sound on top of another.
-      const now = new Date;
-      if (this.lastSound_ !== null && now - this.lastSound_ < SOUND_LIMIT) {
+      const now = new Date();
+      if (this.lastSound_ !== null &&
+          now.getTime() - this.lastSound_.getTime() < SOUND_LIMIT) {
         return;
       }
       this.lastSound_ = now;
@@ -155,15 +144,13 @@ class WorkspaceAudio {
         // node which must be deleted and recreated for each new audio tag.
         mySound = sound;
       } else {
-        mySound = sound.cloneNode();
+        mySound = sound.cloneNode() as HTMLAudioElement;
       }
-      mySound.volume = (opt_volume === undefined ? 1 : opt_volume);
+      mySound.volume = opt_volume === undefined ? 1 : opt_volume;
       mySound.play();
-    } else if (this.parentWorkspace_) {
+    } else if (this.parentWorkspace) {
       // Maybe a workspace on a lower level knows about this sound.
-      this.parentWorkspace_.getAudioManager().play(name, opt_volume);
+      this.parentWorkspace.getAudioManager().play(name, opt_volume);
     }
   }
 }
-
-exports.WorkspaceAudio = WorkspaceAudio;

package/core/workspace_comment.d.ts

@@ -0,0 +1,170 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Coordinate } from './utils/coordinate.js';
+import type { Workspace } from './workspace.js';
+/**
+ * Class for a workspace comment.
+ * @alias Blockly.WorkspaceComment
+ */
+export declare class WorkspaceComment {
+    workspace: Workspace;
+    id: string;
+    protected xy_: Coordinate;
+    protected height_: number;
+    protected width_: number;
+    protected RTL: boolean;
+    private deletable_;
+    private movable_;
+    private editable_;
+    protected content_: string;
+    /** Whether this comment has been disposed. */
+    protected disposed_: boolean;
+    /** @internal */
+    isComment: boolean;
+    /**
+     * @param workspace The block's workspace.
+     * @param content The content of this workspace comment.
+     * @param height Height of the comment.
+     * @param width Width of the comment.
+     * @param opt_id Optional ID.  Use this ID if provided, otherwise create a new
+     *     ID.
+     */
+    constructor(workspace: Workspace, content: string, height: number, width: number, opt_id?: string);
+    /**
+     * Dispose of this comment.
+     * @internal
+     */
+    dispose(): void;
+    /**
+     * Get comment height.
+     * @return Comment height.
+     * @internal
+     */
+    getHeight(): number;
+    /**
+     * Set comment height.
+     * @param height Comment height.
+     * @internal
+     */
+    setHeight(height: number): void;
+    /**
+     * Get comment width.
+     * @return Comment width.
+     * @internal
+     */
+    getWidth(): number;
+    /**
+     * Set comment width.
+     * @param width comment width.
+     * @internal
+     */
+    setWidth(width: number): void;
+    /**
+     * Get stored location.
+     * @return The comment's stored location.
+     *   This is not valid if the comment is currently being dragged.
+     * @internal
+     */
+    getXY(): Coordinate;
+    /**
+     * Move a comment by a relative offset.
+     * @param dx Horizontal offset, in workspace units.
+     * @param dy Vertical offset, in workspace units.
+     * @internal
+     */
+    moveBy(dx: number, dy: number): void;
+    /**
+     * Get whether this comment is deletable or not.
+     * @return True if deletable.
+     * @internal
+     */
+    isDeletable(): boolean;
+    /**
+     * Set whether this comment is deletable or not.
+     * @param deletable True if deletable.
+     * @internal
+     */
+    setDeletable(deletable: boolean): void;
+    /**
+     * Get whether this comment is movable or not.
+     * @return True if movable.
+     * @internal
+     */
+    isMovable(): boolean;
+    /**
+     * Set whether this comment is movable or not.
+     * @param movable True if movable.
+     * @internal
+     */
+    setMovable(movable: boolean): void;
+    /**
+     * Get whether this comment is editable or not.
+     * @return True if editable.
+     */
+    isEditable(): boolean;
+    /**
+     * Set whether this comment is editable or not.
+     * @param editable True if editable.
+     */
+    setEditable(editable: boolean): void;
+    /**
+     * Returns this comment's text.
+     * @return Comment text.
+     * @internal
+     */
+    getContent(): string;
+    /**
+     * Set this comment's content.
+     * @param content Comment content.
+     * @internal
+     */
+    setContent(content: string): void;
+    /**
+     * Encode a comment subtree as XML with XY coordinates.
+     * @param opt_noId True if the encoder should skip the comment ID.
+     * @return Tree of XML elements.
+     * @internal
+     */
+    toXmlWithXY(opt_noId?: boolean): Element;
+    /**
+     * Encode a comment subtree as XML, but don't serialize the XY coordinates.
+     * This method avoids some expensive metrics-related calls that are made in
+     * toXmlWithXY().
+     * @param opt_noId True if the encoder should skip the comment ID.
+     * @return Tree of XML elements.
+     * @internal
+     */
+    toXml(opt_noId?: boolean): Element;
+    /**
+     * Fire a create event for the given workspace comment, if comments are
+     * enabled.
+     * @param comment The comment that was just created.
+     * @internal
+     */
+    static fireCreateEvent(comment: WorkspaceComment): void;
+    /**
+     * Decode an XML comment tag and create a comment on the workspace.
+     * @param xmlComment XML comment element.
+     * @param workspace The workspace.
+     * @return The created workspace comment.
+     * @internal
+     */
+    static fromXml(xmlComment: Element, workspace: Workspace): WorkspaceComment;
+    /**
+     * Decode an XML comment tag and return the results in an object.
+     * @param xml XML comment element.
+     * @return An object containing the id, size, position, and comment string.
+     * @internal
+     */
+    static parseAttributes(xml: Element): {
+        id: string;
+        w: number;
+        h: number;
+        x: number;
+        y: number;
+        content: string;
+    };
+}