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

package/core/variable_map.d.ts

@@ -12,6 +12,7 @@ import type { Workspace } from './workspace.js';
  * Class for a variable map.  This contains a dictionary data structure with
  * variable types as keys and lists of variables as values.  The list of
  * variables are the type indicated by the key.
+ *
  * @alias Blockly.VariableMap
  */
 export declare class VariableMap {
@@ -28,6 +29,7 @@ export declare class VariableMap {
     clear(): void;
     /**
      * Rename the given variable by updating its name in the variable map.
+     *
      * @param variable Variable to rename.
      * @param newName New variable name.
      * @internal
@@ -36,6 +38,7 @@ export declare class VariableMap {
     /**
      * 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.
      */
@@ -43,6 +46,7 @@ export declare class VariableMap {
     /**
      * Update the name of the given variable and refresh all references to it.
      * The new name must not conflict with any existing variable names.
+     *
      * @param variable Variable to rename.
      * @param newName New variable name.
      * @param blocks The list of all blocks in the workspace.
@@ -53,6 +57,7 @@ export declare class VariableMap {
      * variable.  The two variables are coalesced into a single variable with the
      * ID of the existing variable that was already using newName. Refresh all
      * references to the variable.
+     *
      * @param variable Variable to rename.
      * @param newName New variable name.
      * @param conflictVar The variable that was already using newName.
@@ -61,29 +66,33 @@ export declare class VariableMap {
     private renameVariableWithConflict_;
     /**
      * 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;
     /**
      * Delete a variable.
+     *
      * @param variable Variable to delete.
      */
     deleteVariable(variable: VariableModel): void;
     /**
      * 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;
     /**
      * Deletes a variable and all of its uses from this workspace without asking
      * the user for confirmation.
+     *
      * @param variable Variable to delete.
      * @param uses An array of uses of the variable.
      * @internal
@@ -92,50 +101,58 @@ export declare class VariableMap {
     /**
      * Find the variable by the given name and type and return it.  Return null if
      *     it is 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, or null if it was not found.
+     * @returns The variable with the given name, or null if it was not found.
      */
     getVariable(name: string, opt_type?: string | null): 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;
     /**
      * Get a list containing all of the variables of a 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 and potential variable types.  This list always
      * contains the empty string.
+     *
      * @param ws The workspace used to look for potential variables. This can be
      *     different than the workspace stored on this object if the passed in ws
      *     is a flyout workspace.
-     * @return List of variable types.
+     * @returns List of variable types.
      * @internal
      */
     getVariableTypes(ws: Workspace | null): string[];
     /**
      * Return all variables of all types.
-     * @return List of variable models.
+     *
+     * @returns List of variable models.
      */
     getAllVariables(): VariableModel[];
     /**
      * Returns all of the variable names of all types.
-     * @return All of the variable names of all types.
+     *
+     * @returns All of the variable names of all types.
      */
     getAllVariableNames(): string[];
     /**
      * Find all the uses of a named variable.
+     *
      * @param id ID of the variable to find.
-     * @return Array of block usages.
+     * @returns Array of block usages.
      */
     getVariableUsesById(id: string): Block[];
 }
+//# sourceMappingURL=variable_map.d.ts.map

package/core/variable_model.d.ts

@@ -8,6 +8,7 @@ import type { Workspace } from './workspace.js';
 /**
  * Class for a variable model.
  * Holds information for the variable including name, ID, and type.
+ *
  * @see {Blockly.FieldVariable}
  * @alias Blockly.VariableModel
  */
@@ -26,15 +27,17 @@ export declare class VariableModel {
      * @param opt_id The unique ID of the variable. This will default to a UUID.
      */
     constructor(workspace: Workspace, name: string, opt_type?: string, opt_id?: string);
-    /** @return The ID for the variable. */
+    /** @returns The ID for the variable. */
     getId(): string;
     /**
      * A custom compare function for the VariableModel objects.
+     *
      * @param var1 First variable to compare.
      * @param var2 Second variable to compare.
-     * @return -1 if name of var1 is less than name of var2, 0 if equal, and 1 if
+     * @returns -1 if name of var1 is less than name of var2, 0 if equal, and 1 if
      *     greater.
      * @internal
      */
     static compareByName(var1: VariableModel, var2: VariableModel): number;
 }
+//# sourceMappingURL=variable_model.d.ts.map

package/core/variables.d.ts

@@ -12,6 +12,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * variable blocks.
  * See also Blockly.Procedures.CATEGORY_NAME and
  * Blockly.VariablesDynamic.CATEGORY_NAME.
+ *
  * @alias Blockly.Variables.CATEGORY_NAME
  */
 export declare const CATEGORY_NAME = "VARIABLE";
@@ -20,8 +21,9 @@ export declare const CATEGORY_NAME = "VARIABLE";
  * For use by generators.
  * To get a list of all variables on a workspace, including unused variables,
  * call Workspace.getAllVariables.
+ *
  * @param ws The workspace to search for variables.
- * @return Array of variable models.
+ * @returns Array of variable models.
  * @alias Blockly.Variables.allUsedVarModels
  */
 export declare function allUsedVarModels(ws: Workspace): VariableModel[];
@@ -32,23 +34,26 @@ export declare function allUsedVarModels(ws: Workspace): VariableModel[];
  * To declare developer variables, define the getDeveloperVariables function on
  * your block and return a list of variable names.
  * For use by generators.
+ *
  * @param workspace The workspace to search.
- * @return A list of non-duplicated variable names.
+ * @returns A list of non-duplicated variable names.
  * @alias Blockly.Variables.allDeveloperVariables
  */
 export declare function allDeveloperVariables(workspace: Workspace): string[];
 /**
  * Construct the elements (blocks and button) required by the flyout for the
  * variable category.
+ *
  * @param workspace The workspace containing variables.
- * @return Array of XML elements.
+ * @returns Array of XML elements.
  * @alias Blockly.Variables.flyoutCategory
  */
 export declare function flyoutCategory(workspace: WorkspaceSvg): Element[];
 /**
  * Construct the blocks required by the flyout for the variable category.
+ *
  * @param workspace The workspace containing variables.
- * @return Array of XML block elements.
+ * @returns Array of XML block elements.
  * @alias Blockly.Variables.flyoutCategoryBlocks
  */
 export declare function flyoutCategoryBlocks(workspace: Workspace): Element[];
@@ -59,8 +64,9 @@ export declare const VAR_LETTER_OPTIONS = "ijkmnopqrstuvwxyzabcdefgh";
  * generate single letter variable names in the range 'i' to 'z' to start with.
  * If no unique name is located it will try 'i' to 'z', 'a' to 'h',
  * then 'i2' to 'z2' etc.  Skip 'l'.
+ *
  * @param workspace The workspace to be unique in.
- * @return New variable name.
+ * @returns New variable name.
  * @alias Blockly.Variables.generateUniqueName
  */
 export declare function generateUniqueName(workspace: Workspace): string;
@@ -70,11 +76,12 @@ export declare function generateUniqueName(workspace: Workspace): string;
 declare function generateUniqueNameInternal(workspace: Workspace): string;
 /**
  * Returns a unique name that is not present in the usedNames array. This
- * will try to generate single letter names in the range a -> z (skip l). It
+ * will try to generate single letter names in the range a - z (skip l). It
  * will start with the character passed to startChar.
+ *
  * @param startChar The character to start the search at.
  * @param usedNames A list of all of the used names.
- * @return A unique name that is not present in the usedNames array.
+ * @returns A unique name that is not present in the usedNames array.
  * @alias Blockly.Variables.generateUniqueNameFromOptions
  */
 export declare function generateUniqueNameFromOptions(startChar: string, usedNames: string[]): string;
@@ -95,11 +102,12 @@ export declare function generateUniqueNameFromOptions(startChar: string, usedNam
  *     will default to '', which is a specific type.
  * @alias Blockly.Variables.createVariableButtonHandler
  */
-export declare function createVariableButtonHandler(workspace: Workspace, opt_callback?: (p1?: string | null) => any, opt_type?: string): void;
+export declare function createVariableButtonHandler(workspace: Workspace, opt_callback?: (p1?: string | null) => void, opt_type?: string): void;
 /**
  * Opens a prompt that allows the user to enter a new name for a variable.
  * Triggers a rename if the new name is valid. Or re-prompts if there is a
  * collision.
+ *
  * @param workspace The workspace on which to rename the variable.
  * @param variable Variable to rename.
  * @param opt_callback A callback. It will be passed an acceptable new variable
@@ -107,40 +115,44 @@ export declare function createVariableButtonHandler(workspace: Workspace, opt_ca
  *     an existing variable was chosen.
  * @alias Blockly.Variables.renameVariable
  */
-export declare function renameVariable(workspace: Workspace, variable: VariableModel, opt_callback?: (p1?: string | null) => any): void;
+export declare function renameVariable(workspace: Workspace, variable: VariableModel, opt_callback?: (p1?: string | null) => void): void;
 /**
  * Prompt the user for a new variable name.
+ *
  * @param promptText The string of the prompt.
  * @param defaultText The default value to show in the prompt's field.
- * @param callback A callback. It will return the new variable name, or null if
- *     the user picked something illegal.
+ * @param callback A callback. It will be passed the new variable name, or null
+ *     if the user picked something illegal.
  * @alias Blockly.Variables.promptName
  */
-export declare function promptName(promptText: string, defaultText: string, callback: (p1: string | null) => any): void;
+export declare function promptName(promptText: string, defaultText: string, callback: (p1: string | null) => void): void;
 /**
  * Check whether there exists a variable with the given name of any type.
+ *
  * @param name The name to search for.
  * @param workspace The workspace to search for the variable.
- * @return The variable with the given name, or null if none was found.
+ * @returns The variable with the given name, or null if none was found.
  * @alias Blockly.Variables.nameUsedWithAnyType
  */
 export declare function nameUsedWithAnyType(name: string, workspace: Workspace): VariableModel | null;
 /**
  * Generate DOM objects representing a variable field.
+ *
  * @param variableModel The variable model to represent.
- * @return The generated DOM.
+ * @returns The generated DOM.
  * @alias Blockly.Variables.generateVariableFieldDom
  */
-export declare function generateVariableFieldDom(variableModel: VariableModel): Element | null;
+export declare function generateVariableFieldDom(variableModel: VariableModel): Element;
 /**
  * Helper function to look up or create a variable on the given workspace.
  * If no variable exists, creates and returns it.
+ *
  * @param workspace The workspace to search for the variable.  It may be a
  *     flyout workspace or main workspace.
  * @param id The ID to use to look up or create the variable, or null.
  * @param opt_name The string to use to look up or create the variable.
  * @param opt_type The type to use to look up or create the variable.
- * @return The variable corresponding to the given ID or name + type
+ * @returns The variable corresponding to the given ID or name + type
  *     combination.
  * @alias Blockly.Variables.getOrCreateVariablePackage
  */
@@ -149,6 +161,7 @@ export declare function getOrCreateVariablePackage(workspace: Workspace, id: str
  * Look up  a variable on the given workspace.
  * Always looks in the main workspace before looking in the flyout workspace.
  * Always prefers lookup by ID to lookup by name + type.
+ *
  * @param workspace The workspace to search for the variable.  It may be a
  *     flyout workspace or main workspace.
  * @param id The ID to use to look up the variable, or null.
@@ -156,7 +169,7 @@ export declare function getOrCreateVariablePackage(workspace: Workspace, id: str
  *     Only used if lookup by ID fails.
  * @param opt_type The type to use to look up the variable.
  *     Only used if lookup by ID fails.
- * @return The variable corresponding to the given ID or name + type
+ * @returns The variable corresponding to the given ID or name + type
  *     combination, or null if not found.
  * @alias Blockly.Variables.getVariable
  */
@@ -165,10 +178,11 @@ export declare function getVariable(workspace: Workspace, id: string | null, opt
  * Helper function to get the list of variables that have been added to the
  * workspace after adding a new block, using the given list of variables that
  * were in the workspace before the new block was added.
+ *
  * @param workspace The workspace to inspect.
  * @param originalVariables The array of variables that existed in the workspace
  *     before adding the new block.
- * @return The new array of variables that were freshly added to the workspace
+ * @returns The new array of variables that were freshly added to the workspace
  *     after creating the new block, or [] if no new variables were added to the
  *     workspace.
  * @alias Blockly.Variables.getAddedVariables
@@ -179,3 +193,4 @@ export declare const TEST_ONLY: {
     generateUniqueNameInternal: typeof generateUniqueNameInternal;
 };
 export {};
+//# sourceMappingURL=variables.d.ts.map

package/core/variables_dynamic.d.ts

@@ -5,34 +5,54 @@
  */
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
+import type { FlyoutButton } from './flyout_button.js';
 /**
  * String for use in the "custom" attribute of a category in toolbox XML.
  * This string indicates that the category should be dynamically populated with
  * variable blocks.
  * See also Blockly.Variables.CATEGORY_NAME and
  * Blockly.Procedures.CATEGORY_NAME.
+ *
  * @alias Blockly.VariablesDynamic.CATEGORY_NAME
  */
 export declare const CATEGORY_NAME = "VARIABLE_DYNAMIC";
-declare function stringButtonClickHandler(button: any): void;
+/**
+ * Click handler for a button that creates String variables.
+ *
+ * @param button
+ */
+declare function stringButtonClickHandler(button: FlyoutButton): void;
 export declare const onCreateVariableButtonClick_String: typeof stringButtonClickHandler;
-declare function numberButtonClickHandler(button: any): void;
+/**
+ * Click handler for a button that creates Number variables.
+ *
+ * @param button
+ */
+declare function numberButtonClickHandler(button: FlyoutButton): void;
 export declare const onCreateVariableButtonClick_Number: typeof numberButtonClickHandler;
-declare function colourButtonClickHandler(button: any): void;
+/**
+ * Click handler for a button that creates Colour variables.
+ *
+ * @param button
+ */
+declare function colourButtonClickHandler(button: FlyoutButton): void;
 export declare const onCreateVariableButtonClick_Colour: typeof colourButtonClickHandler;
 /**
  * Construct the elements (blocks and button) required by the flyout for the
  * variable category.
+ *
  * @param workspace The workspace containing variables.
- * @return Array of XML elements.
+ * @returns Array of XML elements.
  * @alias Blockly.VariablesDynamic.flyoutCategory
  */
 export declare function flyoutCategory(workspace: WorkspaceSvg): Element[];
 /**
  * Construct the blocks required by the flyout for the variable category.
+ *
  * @param workspace The workspace containing variables.
- * @return Array of XML block elements.
+ * @returns Array of XML block elements.
  * @alias Blockly.VariablesDynamic.flyoutCategoryBlocks
  */
 export declare function flyoutCategoryBlocks(workspace: Workspace): Element[];
 export {};
+//# sourceMappingURL=variables_dynamic.d.ts.map

package/core/warning.d.ts

@@ -8,24 +8,26 @@ import type { BlockSvg } from './block_svg.js';
 import { Icon } from './icon.js';
 /**
  * Class for a warning.
+ *
  * @alias Blockly.Warning
  */
 export declare class Warning extends Icon {
-    text_: any;
+    private text_;
     /** The top-level node of the warning text, or null if not created. */
     private paragraphElement_;
     /** Does this icon get hidden when the block is collapsed? */
     collapseHidden: boolean;
-    bubble_: any;
     /** @param block The block associated with this warning. */
     constructor(block: BlockSvg);
     /**
      * Draw the warning icon.
+     *
      * @param group The icon group.
      */
     protected drawIcon_(group: Element): void;
     /**
      * Show or hide the warning bubble.
+     *
      * @param visible True if the bubble should be visible.
      */
     setVisible(visible: boolean): void;
@@ -35,6 +37,7 @@ export declare class Warning extends Icon {
     private disposeBubble_;
     /**
      * Set this warning's text.
+     *
      * @param text Warning text (or '' to delete). This supports linebreaks.
      * @param id An ID for this text entry to be able to maintain multiple
      *     warnings.
@@ -42,9 +45,11 @@ export declare class Warning extends Icon {
     setText(text: string, id: string): void;
     /**
      * Get this warning's texts.
-     * @return All texts concatenated into one string.
+     *
+     * @returns All texts concatenated into one string.
      */
     getText(): string;
     /** Dispose of this warning. */
     dispose(): void;
 }
+//# sourceMappingURL=warning.d.ts.map

package/core/widgetdiv.d.ts

@@ -7,54 +7,62 @@ import type { Rect } from './utils/rect.js';
 import type { Size } from './utils/size.js';
 /**
  * Returns the HTML container for editor widgets.
- * @return The editor widget container.
+ *
+ * @returns The editor widget container.
  * @alias Blockly.WidgetDiv.getDiv
  */
 export declare function getDiv(): HTMLDivElement | null;
 /**
- * Allows unit tests to reset the div.
+ * Allows unit tests to reset the div. Do not use outside of tests.
+ *
  * @param newDiv The new value for the DIV field.
  * @alias Blockly.WidgetDiv.testOnly_setDiv
- * @ignore
+ * @internal
  */
 export declare function testOnly_setDiv(newDiv: HTMLDivElement | null): void;
 /**
  * Create the widget div and inject it onto the page.
+ *
  * @alias Blockly.WidgetDiv.createDom
  */
 export declare function createDom(): void;
 /**
  * Initialize and display the widget div.  Close the old one if needed.
+ *
  * @param newOwner The object that will be using this container.
  * @param rtl Right-to-left (true) or left-to-right (false).
  * @param newDispose Optional cleanup function to be run when the widget is
  *     closed.
  * @alias Blockly.WidgetDiv.show
  */
-export declare function show(newOwner: any, rtl: boolean, newDispose: Function): void;
+export declare function show(newOwner: unknown, rtl: boolean, newDispose: () => void): void;
 /**
  * Destroy the widget and hide the div.
+ *
  * @alias Blockly.WidgetDiv.hide
  */
 export declare function hide(): void;
 /**
  * Is the container visible?
- * @return True if visible.
+ *
+ * @returns True if visible.
  * @alias Blockly.WidgetDiv.isVisible
  */
 export declare function isVisible(): boolean;
 /**
  * Destroy the widget and hide the div if it is being used by the specified
  * object.
+ *
  * @param oldOwner The object that was using this container.
  * @alias Blockly.WidgetDiv.hideIfOwner
  */
-export declare function hideIfOwner(oldOwner: any): void;
+export declare function hideIfOwner(oldOwner: unknown): void;
 /**
  * Position the widget div based on an anchor rectangle.
  * The widget should be placed adjacent to but not overlapping the anchor
  * rectangle.  The preferred position is directly below and aligned to the left
  * (LTR) or right (RTL) side of the anchor.
+ *
  * @param viewportBBox The bounding rectangle of the current viewport, in window
  *     coordinates.
  * @param anchorBBox The bounding rectangle of the anchor, in window
@@ -67,3 +75,4 @@ export declare function hideIfOwner(oldOwner: any): void;
  * @internal
  */
 export declare function positionWithAnchor(viewportBBox: Rect, anchorBBox: Rect, widgetSize: Size, rtl: boolean): void;
+//# sourceMappingURL=widgetdiv.d.ts.map