blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/workspace.d.ts

@@ -17,6 +17,7 @@ import type { WorkspaceComment } from './workspace_comment.js';
 /**
  * Class for a workspace.  This is a data structure that contains blocks.
  * There is no UI, and can be created headlessly.
+ *
  * @alias Blockly.Workspace
  */
 export declare class Workspace implements IASTNodeLocation {
@@ -38,6 +39,7 @@ export declare class Workspace implements IASTNodeLocation {
     rendered: boolean;
     /**
      * Is this workspace the surface for a flyout?
+     *
      * @internal
      */
     internalIsFlyout: boolean;
@@ -45,6 +47,7 @@ export declare class Workspace implements IASTNodeLocation {
     get isFlyout(): boolean;
     /**
      * Is this workspace the surface for a mutator?
+     *
      * @internal
      */
     internalIsMutator: boolean;
@@ -53,6 +56,7 @@ export declare class Workspace implements IASTNodeLocation {
     /**
      * Returns `true` if the workspace is currently in the process of a bulk
      * clear.
+     *
      * @internal
      */
     isClearing: boolean;
@@ -87,61 +91,71 @@ export declare class Workspace implements IASTNodeLocation {
     /**
      * Dispose of this workspace.
      * Unlink from all DOM elements to prevent memory leaks.
+     *
      * @suppress {checkTypes}
      */
     dispose(): void;
     /**
      * Compare function for sorting objects (blocks, comments, etc) by position;
      *    top to bottom (with slight LTR or RTL bias).
+     *
      * @param a The first object to compare.
      * @param b The second object to compare.
-     * @return The comparison value. This tells Array.sort() how to change object
+     * @returns The comparison value. This tells Array.sort() how to change object
      *     a's index.
      */
     private sortObjects_;
     /**
      * Adds a block to the list of top blocks.
+     *
      * @param block Block to add.
      */
     addTopBlock(block: Block): void;
     /**
      * Removes a block from the list of top blocks.
+     *
      * @param block Block to remove.
      */
     removeTopBlock(block: Block): void;
     /**
      * Finds the top-level blocks and returns them.  Blocks are optionally sorted
      * by position; top to bottom (with slight LTR or RTL bias).
+     *
      * @param ordered Sort the list if true.
-     * @return The top-level block objects.
+     * @returns The top-level block objects.
      */
     getTopBlocks(ordered: boolean): Block[];
     /**
      * Add a block to the list of blocks keyed by type.
+     *
      * @param block Block to add.
      */
     addTypedBlock(block: Block): void;
     /**
      * Remove a block from the list of blocks keyed by type.
+     *
      * @param block Block to remove.
      */
     removeTypedBlock(block: Block): void;
     /**
      * Finds the blocks with the associated type and returns them. Blocks are
      * optionally sorted by position; top to bottom (with slight LTR or RTL bias).
+     *
      * @param type The type of block to search for.
      * @param ordered Sort the list if true.
-     * @return The blocks of the given type.
+     * @returns The blocks of the given type.
      */
     getBlocksByType(type: string, ordered: boolean): Block[];
     /**
      * Adds a comment to the list of top comments.
+     *
      * @param comment comment to add.
      * @internal
      */
     addTopComment(comment: WorkspaceComment): void;
     /**
      * Removes a comment from the list of top comments.
+     *
      * @param comment comment to remove.
      * @internal
      */
@@ -149,16 +163,18 @@ export declare class Workspace implements IASTNodeLocation {
     /**
      * Finds the top-level comments and returns them.  Comments are optionally
      * sorted by position; top to bottom (with slight LTR or RTL bias).
+     *
      * @param ordered Sort the list if true.
-     * @return The top-level comment objects.
+     * @returns The top-level comment objects.
      * @internal
      */
     getTopComments(ordered: boolean): WorkspaceComment[];
     /**
      * Find all blocks in workspace.  Blocks are optionally sorted
      * by position; top to bottom (with slight LTR or RTL bias).
+     *
      * @param ordered Sort the list if true.
-     * @return Array of blocks.
+     * @returns Array of blocks.
      */
     getAllBlocks(ordered: boolean): Block[];
     /** Dispose of all blocks and comments in workspace. */
@@ -166,99 +182,113 @@ export declare class Workspace implements IASTNodeLocation {
     /**
      * Rename a variable by updating its name in the variable map. Identify the
      * variable to rename with the given ID.
+     *
      * @param id ID of the variable to rename.
      * @param newName New variable name.
      */
     renameVariableById(id: string, newName: string): void;
     /**
      * Create a variable with a given name, optional type, and optional ID.
+     *
      * @param name The name of the variable. This must be unique across variables
      *     and procedures.
      * @param opt_type The type of the variable like 'int' or 'string'.
      *     Does not need to be unique. Field_variable can filter variables based
      * on their type. This will default to '' which is a specific type.
      * @param opt_id The unique ID of the variable. This will default to a UUID.
-     * @return The newly created variable.
+     * @returns The newly created variable.
      */
     createVariable(name: string, opt_type?: string | null, opt_id?: string | null): VariableModel;
     /**
      * Find all the uses of the given variable, which is identified by ID.
+     *
      * @param id ID of the variable to find.
-     * @return Array of block usages.
+     * @returns Array of block usages.
      */
     getVariableUsesById(id: string): Block[];
     /**
      * Delete a variables by the passed in ID and all of its uses from this
      * workspace. May prompt the user for confirmation.
+     *
      * @param id ID of variable to delete.
      */
     deleteVariableById(id: string): void;
     /**
      * Find the variable by the given name and return it. Return null if not
      * found.
+     *
      * @param name The name to check for.
      * @param opt_type The type of the variable.  If not provided it defaults to
      *     the empty string, which is a specific type.
-     * @return The variable with the given name.
+     * @returns The variable with the given name.
      */
     getVariable(name: string, opt_type?: string): VariableModel | null;
     /**
      * Find the variable by the given ID and return it. Return null if not found.
+     *
      * @param id The ID to check for.
-     * @return The variable with the given ID.
+     * @returns The variable with the given ID.
      */
     getVariableById(id: string): VariableModel | null;
     /**
      * Find the variable with the specified type. If type is null, return list of
      *     variables with empty string type.
+     *
      * @param type Type of the variables to find.
-     * @return The sought after variables of the passed in type. An empty array if
-     *     none are found.
+     * @returns The sought after variables of the passed in type. An empty array
+     *     if none are found.
      */
     getVariablesOfType(type: string | null): VariableModel[];
     /**
      * Return all variable types.
-     * @return List of variable types.
+     *
+     * @returns List of variable types.
      * @internal
      */
     getVariableTypes(): string[];
     /**
      * Return all variables of all types.
-     * @return List of variable models.
+     *
+     * @returns List of variable models.
      */
     getAllVariables(): VariableModel[];
     /**
      * Returns all variable names of all types.
-     * @return List of all variable names of all types.
+     *
+     * @returns List of all variable names of all types.
      */
     getAllVariableNames(): string[];
     /**
      * Returns the horizontal offset of the workspace.
      * Intended for LTR/RTL compatibility in XML.
      * Not relevant for a headless workspace.
-     * @return Width.
+     *
+     * @returns Width.
      */
     getWidth(): number;
     /**
      * Obtain a newly created block.
+     *
      * @param prototypeName Name of the language object containing type-specific
      *     functions for this block.
      * @param opt_id Optional ID.  Use this ID if provided, otherwise create a new
      *     ID.
-     * @return The created block.
+     * @returns The created block.
      */
     newBlock(prototypeName: string, opt_id?: string): Block;
     /**
      * The number of blocks that may be added to the workspace before reaching
      *     the maxBlocks.
-     * @return Number of blocks left.
+     *
+     * @returns Number of blocks left.
      */
     remainingCapacity(): number;
     /**
      * The number of blocks of the given type that may be added to the workspace
      *    before reaching the maxInstances allowed for that type.
+     *
      * @param type Type of block to return capacity for.
-     * @return Number of blocks of type left.
+     * @returns Number of blocks of type left.
      */
     remainingCapacityOfType(type: string): number;
     /**
@@ -266,31 +296,36 @@ export declare class Workspace implements IASTNodeLocation {
      *    created. If the total number of blocks represented by the map is more
      * than the total remaining capacity, it returns false. If a type count is
      * more than the remaining capacity for that type, it returns false.
+     *
      * @param typeCountsMap A map of types to counts (usually representing blocks
      *     to be created).
-     * @return True if there is capacity for the given map, false otherwise.
+     * @returns True if there is capacity for the given map, false otherwise.
      */
     isCapacityAvailable(typeCountsMap: any): boolean;
     /**
      * Checks if the workspace has any limits on the maximum number of blocks,
      *    or the maximum number of blocks of specific types.
-     * @return True if it has block limits, false otherwise.
+     *
+     * @returns True if it has block limits, false otherwise.
      */
     hasBlockLimits(): boolean;
     /**
      * Gets the undo stack for workplace.
-     * @return undo stack
+     *
+     * @returns undo stack
      * @internal
      */
     getUndoStack(): Abstract[];
     /**
      * Gets the redo stack for workplace.
-     * @return redo stack
+     *
+     * @returns redo stack
      * @internal
      */
     getRedoStack(): Abstract[];
     /**
      * Undo or redo the previous action.
+     *
      * @param redo False if undo, true if redo.
      */
     undo(redo: boolean): void;
@@ -301,28 +336,33 @@ export declare class Workspace implements IASTNodeLocation {
      * Note that there may be a few recent events already on the stack.  Thus the
      * new change listener might be called with events that occurred a few
      * milliseconds before the change listener was added.
+     *
      * @param func Function to call.
-     * @return Obsolete return value, ignore.
+     * @returns Obsolete return value, ignore.
      */
     addChangeListener(func: Function): Function;
     /**
      * Stop listening for this workspace's changes.
+     *
      * @param func Function to stop calling.
      */
     removeChangeListener(func: Function): void;
     /**
      * Fire a change event.
+     *
      * @param event Event to fire.
      */
     fireChangeListener(event: Abstract): void;
     /**
      * Find the block on this workspace with the specified ID.
+     *
      * @param id ID of block to find.
-     * @return The sought after block, or null if not found.
+     * @returns The sought after block, or null if not found.
      */
     getBlockById(id: string): Block | null;
     /**
      * Set a block on this workspace with the specified ID.
+     *
      * @param id ID of block to set.
      * @param block The block to set.
      * @internal
@@ -330,57 +370,67 @@ export declare class Workspace implements IASTNodeLocation {
     setBlockById(id: string, block: Block): void;
     /**
      * Delete a block off this workspace with the specified ID.
+     *
      * @param id ID of block to delete.
      * @internal
      */
     removeBlockById(id: string): void;
     /**
      * Find the comment on this workspace with the specified ID.
+     *
      * @param id ID of comment to find.
-     * @return The sought after comment, or null if not found.
+     * @returns The sought after comment, or null if not found.
      * @internal
      */
     getCommentById(id: string): WorkspaceComment | null;
     /**
      * Checks whether all value and statement inputs in the workspace are filled
      * with blocks.
+     *
      * @param opt_shadowBlocksAreFilled An optional argument controlling whether
      *     shadow blocks are counted as filled. Defaults to true.
-     * @return True if all inputs are filled, false otherwise.
+     * @returns True if all inputs are filled, false otherwise.
      */
     allInputsFilled(opt_shadowBlocksAreFilled?: boolean): boolean;
     /**
      * Return the variable map that contains "potential" variables.
      * These exist in the flyout but not in the workspace.
-     * @return The potential variable map.
+     *
+     * @returns The potential variable map.
      * @internal
      */
     getPotentialVariableMap(): VariableMap | null;
     /**
      * Create and store the potential variable map for this workspace.
+     *
      * @internal
      */
     createPotentialVariableMap(): void;
     /**
      * Return the map of all variables on the workspace.
-     * @return The variable map.
+     *
+     * @returns The variable map.
      */
     getVariableMap(): VariableMap;
     /**
      * Set the map of all variables on the workspace.
+     *
      * @param variableMap The variable map.
      * @internal
      */
     setVariableMap(variableMap: VariableMap): void;
     /**
      * Find the workspace with the specified ID.
+     *
      * @param id ID of workspace to find.
-     * @return The sought after workspace or null if not found.
+     * @returns The sought after workspace or null if not found.
      */
     static getById(id: string): Workspace | null;
     /**
      * Find all workspaces.
-     * @return Array of workspaces.
+     *
+     * @returns Array of workspaces.
      */
     static getAll(): Workspace[];
 }
+//# sourceMappingURL=workspace.d.ts.map

package/core/workspace_audio.d.ts

@@ -6,6 +6,7 @@
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for loading, storing, and playing audio for a workspace.
+ *
  * @alias Blockly.WorkspaceAudio
  */
 export declare class WorkspaceAudio {
@@ -21,11 +22,13 @@ export declare class WorkspaceAudio {
     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.
@@ -34,14 +37,17 @@ export declare class WorkspaceAudio {
     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;
 }
+//# sourceMappingURL=workspace_audio.d.ts.map

package/core/workspace_comment.d.ts

@@ -7,6 +7,7 @@ import { Coordinate } from './utils/coordinate.js';
 import type { Workspace } from './workspace.js';
 /**
  * Class for a workspace comment.
+ *
  * @alias Blockly.WorkspaceComment
  */
 export declare class WorkspaceComment {
@@ -35,42 +36,49 @@ export declare class WorkspaceComment {
     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.
+     *
+     * @returns Comment height.
      * @internal
      */
     getHeight(): number;
     /**
      * Set comment height.
+     *
      * @param height Comment height.
      * @internal
      */
     setHeight(height: number): void;
     /**
      * Get comment width.
-     * @return Comment width.
+     *
+     * @returns 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.
+     *
+     * @returns 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
@@ -78,54 +86,63 @@ export declare class WorkspaceComment {
     moveBy(dx: number, dy: number): void;
     /**
      * Get whether this comment is deletable or not.
-     * @return True if deletable.
+     *
+     * @returns 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.
+     *
+     * @returns 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.
+     *
+     * @returns 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.
+     *
+     * @returns 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.
+     * @returns Tree of XML elements.
      * @internal
      */
     toXmlWithXY(opt_noId?: boolean): Element;
@@ -133,30 +150,34 @@ export declare class WorkspaceComment {
      * 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.
+     * @returns 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.
+     * @returns 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.
+     * @returns An object containing the id, size, position, and comment string.
      * @internal
      */
     static parseAttributes(xml: Element): {
@@ -168,3 +189,4 @@ export declare class WorkspaceComment {
         content: string;
     };
 }
+//# sourceMappingURL=workspace_comment.d.ts.map