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

package/core/utils/dom.d.ts

@@ -6,22 +6,26 @@
 import type { Svg } from './svg.js';
 /**
  * Required name space for SVG elements.
+ *
  * @alias Blockly.utils.dom.SVG_NS
  */
 export declare const SVG_NS = "http://www.w3.org/2000/svg";
 /**
  * Required name space for HTML elements.
+ *
  * @alias Blockly.utils.dom.HTML_NS
  */
 export declare const HTML_NS = "http://www.w3.org/1999/xhtml";
 /**
  * Required name space for XLINK elements.
+ *
  * @alias Blockly.utils.dom.XLINK_NS
  */
 export declare const XLINK_NS = "http://www.w3.org/1999/xlink";
 /**
  * Node type constants.
  * https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeType
+ *
  * @alias Blockly.utils.dom.NodeType
  */
 export declare enum NodeType {
@@ -32,24 +36,28 @@ export declare enum NodeType {
 }
 /**
  * Helper method for creating SVG elements.
+ *
  * @param name Element's tag name.
  * @param attrs Dictionary of attribute names and values.
  * @param opt_parent Optional parent on which to append the element.
- * @return if name is a string or a more specific type if it a member of Svg.
+ * @returns if name is a string or a more specific type if it a member of Svg.
  * @alias Blockly.utils.dom.createSvgElement
  */
-export declare function createSvgElement<T extends SVGElement>(name: string | Svg<T>, attrs: any, opt_parent?: Element): T;
+export declare function createSvgElement<T extends SVGElement>(name: string | Svg<T>, attrs: {
+    [key: string]: string | number;
+}, opt_parent?: Element | null): T;
 /**
  * Add a CSS class to a element.
- * Similar to Closure's goog.dom.classes.add, except it handles SVG elements.
+ *
  * @param element DOM element to add class to.
  * @param className Name of class to add.
- * @return True if class was added, false if already present.
+ * @returns True if class was added, false if already present.
  * @alias Blockly.utils.dom.addClass
  */
 export declare function addClass(element: Element, className: string): boolean;
 /**
  * Removes multiple calsses from an element.
+ *
  * @param element DOM element to remove classes from.
  * @param classNames A string of one or multiple class names for an element.
  * @alias Blockly.utils.dom.removeClasses
@@ -57,32 +65,34 @@ export declare function addClass(element: Element, className: string): boolean;
 export declare function removeClasses(element: Element, classNames: string): void;
 /**
  * Remove a CSS class from a element.
- * Similar to Closure's goog.dom.classes.remove, except it handles SVG elements.
+ *
  * @param element DOM element to remove class from.
  * @param className Name of class to remove.
- * @return True if class was removed, false if never present.
+ * @returns True if class was removed, false if never present.
  * @alias Blockly.utils.dom.removeClass
  */
 export declare function removeClass(element: Element, className: string): boolean;
 /**
  * Checks if an element has the specified CSS class.
- * Similar to Closure's goog.dom.classes.has, except it handles SVG elements.
+ *
  * @param element DOM element to check.
  * @param className Name of class to check.
- * @return True if class exists, false otherwise.
+ * @returns True if class exists, false otherwise.
  * @alias Blockly.utils.dom.hasClass
  */
 export declare function hasClass(element: Element, className: string): boolean;
 /**
  * Removes a node from its parent. No-op if not attached to a parent.
+ *
  * @param node The node to remove.
- * @return The node removed if removed; else, null.
+ * @returns The node removed if removed; else, null.
  * @alias Blockly.utils.dom.removeNode
  */
 export declare function removeNode(node: Node | null): Node | null;
 /**
  * Insert a node after a reference node.
  * Contrast with node.insertBefore function.
+ *
  * @param newNode New element to insert.
  * @param refNode Existing element to precede new node.
  * @alias Blockly.utils.dom.insertAfter
@@ -90,9 +100,10 @@ export declare function removeNode(node: Node | null): Node | null;
 export declare function insertAfter(newNode: Element, refNode: Element): void;
 /**
  * Whether a node contains another node.
+ *
  * @param parent The node that should contain the other node.
  * @param descendant The node to test presence of.
- * @return Whether the parent node contains the descendant node.
+ * @returns Whether the parent node contains the descendant node.
  * @alias Blockly.utils.dom.containsNode
  */
 export declare function containsNode(parent: Node, descendant: Node): boolean;
@@ -100,27 +111,31 @@ export declare function containsNode(parent: Node, descendant: Node): boolean;
  * Sets the CSS transform property on an element. This function sets the
  * non-vendor-prefixed and vendor-prefixed versions for backwards compatibility
  * with older browsers. See https://caniuse.com/#feat=transforms2d
+ *
  * @param element Element to which the CSS transform will be applied.
  * @param transform The value of the CSS `transform` property.
  * @alias Blockly.utils.dom.setCssTransform
  */
-export declare function setCssTransform(element: Element, transform: string): void;
+export declare function setCssTransform(element: HTMLElement | SVGElement, transform: string): void;
 /**
  * Start caching text widths. Every call to this function MUST also call
  * stopTextWidthCache. Caches must not survive between execution threads.
+ *
  * @alias Blockly.utils.dom.startTextWidthCache
  */
 export declare function startTextWidthCache(): void;
 /**
  * Stop caching field widths. Unless caching was already on when the
  * corresponding call to startTextWidthCache was made.
+ *
  * @alias Blockly.utils.dom.stopTextWidthCache
  */
 export declare function stopTextWidthCache(): void;
 /**
  * Gets the width of a text element, caching it in the process.
+ *
  * @param textElement An SVG 'text' element.
- * @return Width of element.
+ * @returns Width of element.
  * @alias Blockly.utils.dom.getTextWidth
  */
 export declare function getTextWidth(textElement: SVGTextElement): number;
@@ -128,38 +143,42 @@ export declare function getTextWidth(textElement: SVGTextElement): number;
  * Gets the width of a text element using a faster method than `getTextWidth`.
  * This method requires that we know the text element's font family and size in
  * advance. Similar to `getTextWidth`, we cache the width we compute.
+ *
  * @param textElement An SVG 'text' element.
  * @param fontSize The font size to use.
  * @param fontWeight The font weight to use.
  * @param fontFamily The font family to use.
- * @return Width of element.
+ * @returns Width of element.
  * @alias Blockly.utils.dom.getFastTextWidth
  */
-export declare function getFastTextWidth(textElement: Element, fontSize: number, fontWeight: string, fontFamily: string): number;
+export declare function getFastTextWidth(textElement: SVGTextElement, fontSize: number, fontWeight: string, fontFamily: string): number;
 /**
  * Gets the width of a text element using a faster method than `getTextWidth`.
  * This method requires that we know the text element's font family and size in
  * advance. Similar to `getTextWidth`, we cache the width we compute.
- * This method is similar to ``getFastTextWidth`` but expects the font size
+ * This method is similar to `getFastTextWidth` but expects the font size
  * parameter to be a string.
+ *
  * @param textElement An SVG 'text' element.
  * @param fontSize The font size to use.
  * @param fontWeight The font weight to use.
  * @param fontFamily The font family to use.
- * @return Width of element.
+ * @returns Width of element.
  * @alias Blockly.utils.dom.getFastTextWidthWithSizeString
  */
-export declare function getFastTextWidthWithSizeString(textElement: Element, fontSize: string, fontWeight: string, fontFamily: string): number;
+export declare function getFastTextWidthWithSizeString(textElement: SVGTextElement, fontSize: string, fontWeight: string, fontFamily: string): number;
 /**
  * Measure a font's metrics. The height and baseline values.
+ *
  * @param text Text to measure the font dimensions of.
  * @param fontSize The font size to use.
  * @param fontWeight The font weight to use.
  * @param fontFamily The font family to use.
- * @return Font measurements.
+ * @returns Font measurements.
  * @alias Blockly.utils.dom.measureFontMetrics
  */
 export declare function measureFontMetrics(text: string, fontSize: string, fontWeight: string, fontFamily: string): {
     height: number;
     baseline: number;
 };
+//# sourceMappingURL=dom.d.ts.map

package/core/utils/idgenerator.d.ts

@@ -3,23 +3,33 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-export declare const TEST_ONLY: {};
+export declare const TEST_ONLY: {
+    /**
+     * Generate a random unique ID.  This should be globally unique.
+     * 87 characters ^ 20 length is greater than 128 bits (better than a UUID).
+     *
+     * @returns A globally unique ID string.
+     */
+    genUid: () => string;
+};
 /**
  * Generate the next unique element IDs.
- * IDs are compatible with the HTML4 id attribute restrictions:
+ * IDs are compatible with the HTML4 'id' attribute restrictions:
  * Use only ASCII letters, digits, '_', '-' and '.'
  *
  * For UUIDs use genUid (below) instead; this ID generator should
  * primarily be used for IDs that end up in the DOM.
  *
- * @return The next unique identifier.
+ * @returns The next unique identifier.
  * @alias Blockly.utils.idGenerator.getNextUniqueId
  */
 export declare function getNextUniqueId(): string;
 /**
  * Generate a random unique ID.
+ *
  * @see internal.genUid
- * @return A globally unique ID string.
+ * @returns A globally unique ID string.
  * @alias Blockly.utils.idGenerator.genUid
  */
 export declare function genUid(): string;
+//# sourceMappingURL=idgenerator.d.ts.map

package/core/utils/keycodes.d.ts

@@ -135,3 +135,4 @@ export declare enum KeyCodes {
     VK_NONAME = 252,
     PHANTOM = 255
 }
+//# sourceMappingURL=keycodes.d.ts.map

package/core/utils/math.d.ts

@@ -6,25 +6,29 @@
 /**
  * Converts degrees to radians.
  * Copied from Closure's goog.math.toRadians.
+ *
  * @param angleDegrees Angle in degrees.
- * @return Angle in radians.
+ * @returns Angle in radians.
  * @alias Blockly.utils.math.toRadians
  */
 export declare function toRadians(angleDegrees: number): number;
 /**
  * Converts radians to degrees.
  * Copied from Closure's goog.math.toDegrees.
+ *
  * @param angleRadians Angle in radians.
- * @return Angle in degrees.
+ * @returns Angle in degrees.
  * @alias Blockly.utils.math.toDegrees
  */
 export declare function toDegrees(angleRadians: number): number;
 /**
  * Clamp the provided number between the lower bound and the upper bound.
+ *
  * @param lowerBound The desired lower bound.
  * @param number The number to clamp.
  * @param upperBound The desired upper bound.
- * @return The clamped number.
+ * @returns The clamped number.
  * @alias Blockly.utils.math.clamp
  */
 export declare function clamp(lowerBound: number, number: number, upperBound: number): number;
+//# sourceMappingURL=math.d.ts.map

package/core/utils/metrics.d.ts

@@ -62,3 +62,4 @@ export interface Metrics {
     /** Height of the flyout if it is always open.  Otherwise zero. */
     flyoutHeight: number;
 }
+//# sourceMappingURL=metrics.d.ts.map

package/core/utils/object.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Inherit the prototype methods from one constructor into another.
+ *
  * @param childCtor Child class.
  * @param parentCtor Parent class.
  * @suppress {strictMissingProperties} superClass_ is not defined on Function.
@@ -13,6 +14,7 @@
 export declare function inherits(childCtor: Function, parentCtor: Function): void;
 /**
  * Copies all the members of a source object to a target object.
+ *
  * @param target Target.
  * @param source Source.
  * @alias Blockly.utils.object.mixin
@@ -20,16 +22,19 @@ export declare function inherits(childCtor: Function, parentCtor: Function): voi
 export declare function mixin(target: any, source: any): void;
 /**
  * Complete a deep merge of all members of a source object with a target object.
+ *
  * @param target Target.
  * @param source Source.
- * @return The resulting object.
+ * @returns The resulting object.
  * @alias Blockly.utils.object.deepMerge
  */
 export declare function deepMerge(target: any, source: any): any;
 /**
  * Returns an array of a given object's own enumerable property values.
+ *
  * @param obj Object containing values.
- * @return Array of values.
+ * @returns Array of values.
  * @alias Blockly.utils.object.values
  */
 export declare function values(obj: any): any[];
+//# sourceMappingURL=object.d.ts.map

package/core/utils/parsing.d.ts

@@ -9,9 +9,10 @@
  * %{BKY_MY_MSG} will both be replaced with the value in
  * Msg['MY_MSG']). Percentage sign characters '%' may be self-escaped
  * (e.g., '%%').
+ *
  * @param message Text which might contain string table references and
  *     interpolation tokens.
- * @return Array of strings and numbers.
+ * @returns Array of strings and numbers.
  * @alias Blockly.utils.parsing.tokenizeInterpolation
  */
 export declare function tokenizeInterpolation(message: string): (string | number)[];
@@ -19,17 +20,19 @@ export declare function tokenizeInterpolation(message: string): (string | number
  * Replaces string table references in a message, if the message is a string.
  * For example, "%{bky_my_msg}" and "%{BKY_MY_MSG}" will both be replaced with
  * the value in Msg['MY_MSG'].
+ *
  * @param message Message, which may be a string that contains
  *     string table references.
- * @return String with message references replaced.
+ * @returns String with message references replaced.
  * @alias Blockly.utils.parsing.replaceMessageReferences
  */
 export declare function replaceMessageReferences(message: string | any): string;
 /**
  * Validates that any %{MSG_KEY} references in the message refer to keys of
  * the Msg string table.
+ *
  * @param message Text which might contain string table references.
- * @return True if all message references have matching values.
+ * @returns True if all message references have matching values.
  *     Otherwise, false.
  * @alias Blockly.utils.parsing.checkMessageReferences
  */
@@ -37,9 +40,10 @@ export declare function checkMessageReferences(message: string): boolean;
 /**
  * Parse a block colour from a number or string, as provided in a block
  * definition.
+ *
  * @param colour HSV hue value (0 to 360), #RRGGBB string,
  *     or a message reference string pointing to one of those two values.
- * @return An object containing the colour as
+ * @returns An object containing the colour as
  *     a #RRGGBB string, and the hue if the input was an HSV hue value.
  * @throws {Error} If the colour cannot be parsed.
  * @alias Blockly.utils.parsing.parseBlockColour
@@ -48,3 +52,4 @@ export declare function parseBlockColour(colour: number | string): {
     hue: number | null;
     hex: string;
 };
+//# sourceMappingURL=parsing.d.ts.map

package/core/utils/rect.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Class for representing rectangular regions.
+ *
  * @alias Blockly.utils.Rect
  */
 export declare class Rect {
@@ -17,7 +18,6 @@ export declare class Rect {
      * @param bottom Bottom.
      * @param left Left.
      * @param right Right.
-     * @struct
      */
     constructor(top: number, bottom: number, left: number, right: number);
     /**
@@ -25,14 +25,16 @@ export declare class Rect {
      *
      * @param x The x coordinate to test for containment.
      * @param y The y coordinate to test for containment.
-     * @return Whether this rectangle contains given coordinate.
+     * @returns Whether this rectangle contains given coordinate.
      */
     contains(x: number, y: number): boolean;
     /**
      * Tests whether this rectangle intersects the provided rectangle.
      * Assumes that the coordinate system increases going down and left.
+     *
      * @param other The other rectangle to check for intersection with.
-     * @return Whether this rectangle intersects the provided rectangle.
+     * @returns Whether this rectangle intersects the provided rectangle.
      */
     intersects(other: Rect): boolean;
 }
+//# sourceMappingURL=rect.d.ts.map

package/core/utils/sentinel.d.ts

@@ -5,7 +5,9 @@
  */
 /**
  * A type used to create flag values.
+ *
  * @alias Blockly.utils.Sentinel
  */
 export declare class Sentinel {
 }
+//# sourceMappingURL=sentinel.d.ts.map

package/core/utils/size.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Class for representing sizes consisting of a width and height.
+ *
  * @alias Blockly.utils.Size
  */
 export declare class Size {
@@ -13,15 +14,16 @@ export declare class Size {
     /**
      * @param width Width.
      * @param height Height.
-     * @struct
      */
     constructor(width: number, height: number);
     /**
      * Compares sizes for equality.
+     *
      * @param a A Size.
      * @param b A Size.
-     * @return True iff the sizes have equal widths and equal heights, or if both
+     * @returns True iff the sizes have equal widths and equal heights, or if both
      *     are null.
      */
     static equals(a: Size | null, b: Size | null): boolean;
 }
+//# sourceMappingURL=size.d.ts.map

package/core/utils/string.d.ts

@@ -6,50 +6,57 @@
 /**
  * Fast prefix-checker.
  * Copied from Closure's goog.string.startsWith.
+ *
  * @param str The string to check.
  * @param prefix A string to look for at the start of `str`.
- * @return True if `str` begins with `prefix`.
+ * @returns True if `str` begins with `prefix`.
  * @alias Blockly.utils.string.startsWith
  * @deprecated April 2022. Use built-in string.startsWith.
  */
 export declare function startsWith(str: string, prefix: string): boolean;
 /**
  * Given an array of strings, return the length of the shortest one.
+ *
  * @param array Array of strings.
- * @return Length of shortest string.
+ * @returns Length of shortest string.
  * @alias Blockly.utils.string.shortestStringLength
  */
 export declare function shortestStringLength(array: string[]): number;
 /**
  * Given an array of strings, return the length of the common prefix.
  * Words may not be split.  Any space after a word is included in the length.
+ *
  * @param array Array of strings.
  * @param opt_shortest Length of shortest string.
- * @return Length of common prefix.
+ * @returns Length of common prefix.
  * @alias Blockly.utils.string.commonWordPrefix
  */
 export declare function commonWordPrefix(array: string[], opt_shortest?: number): number;
 /**
  * Given an array of strings, return the length of the common suffix.
  * Words may not be split.  Any space after a word is included in the length.
+ *
  * @param array Array of strings.
  * @param opt_shortest Length of shortest string.
- * @return Length of common suffix.
+ * @returns Length of common suffix.
  * @alias Blockly.utils.string.commonWordSuffix
  */
 export declare function commonWordSuffix(array: string[], opt_shortest?: number): number;
 /**
  * Wrap text to the specified width.
+ *
  * @param text Text to wrap.
  * @param limit Width to wrap each line.
- * @return Wrapped text.
+ * @returns Wrapped text.
  * @alias Blockly.utils.string.wrap
  */
 export declare function wrap(text: string, limit: number): string;
 /**
  * Is the given string a number (includes negative and decimals).
+ *
  * @param str Input string.
- * @return True if number, false otherwise.
+ * @returns True if number, false otherwise.
  * @alias Blockly.utils.string.isNumber
  */
 export declare function isNumber(str: string): boolean;
+//# sourceMappingURL=string.d.ts.map

package/core/utils/style.d.ts

@@ -9,8 +9,9 @@ import { Size } from './size.js';
 /**
  * Gets the height and width of an element.
  * Similar to Closure's goog.style.getSize
+ *
  * @param element Element to get size of.
- * @return Object with width/height properties.
+ * @returns Object with width/height properties.
  * @alias Blockly.utils.style.getSize
  */
 export declare function getSize(element: Element): Size;
@@ -19,16 +20,15 @@ export declare function getSize(element: Element): Size;
  */
 declare function getSizeInternal(element: Element): Size;
 /**
- * Retrieves a computed style value of a node. It returns empty string if the
- * value cannot be computed (which will be the case in Internet Explorer) or
- * "none" if the property requested is an SVG one and it has not been
+ * Retrieves a computed style value of a node. It returns empty string
+ * if the property requested is an SVG one and it has not been
  * explicitly set (firefox and webkit).
  *
  * Copied from Closure's goog.style.getComputedStyle
  *
  * @param element Element to get style of.
  * @param property Property to get (camel-case).
- * @return Style value.
+ * @returns Style value.
  * @alias Blockly.utils.style.getComputedStyle
  */
 export declare function getComputedStyle(element: Element, property: string): string;
@@ -40,53 +40,33 @@ export declare function getComputedStyle(element: Element, property: string): st
  *
  * @param element Element to get style of.
  * @param style Property to get (camel-case).
- * @return Style value.
+ * @returns Style value.
  * @alias Blockly.utils.style.getCascadedStyle
  */
 export declare function getCascadedStyle(element: Element, style: string): string;
 /**
  * Returns a Coordinate object relative to the top-left of the HTML document.
  * Similar to Closure's goog.style.getPageOffset
+ *
  * @param el Element to get the page offset for.
- * @return The page offset.
+ * @returns The page offset.
  * @alias Blockly.utils.style.getPageOffset
  */
 export declare function getPageOffset(el: Element): Coordinate;
 /**
  * Calculates the viewport coordinates relative to the document.
  * Similar to Closure's goog.style.getViewportPageOffset
- * @return The page offset of the viewport.
+ *
+ * @returns The page offset of the viewport.
  * @alias Blockly.utils.style.getViewportPageOffset
  */
 export declare function getViewportPageOffset(): Coordinate;
-/**
- * Shows or hides an element from the page. Hiding the element is done by
- * setting the display property to "none", removing the element from the
- * rendering hierarchy so it takes up no space. To show the element, the default
- * inherited display property is restored (defined either in stylesheets or by
- * the browser's default style rules).
- * Copied from Closure's goog.style.getViewportPageOffset
- *
- * @param el Element to show or hide.
- * @param isShown True to render the element in its default style, false to
- *     disable rendering the element.
- * @alias Blockly.utils.style.setElementShown
- */
-export declare function setElementShown(el: Element, isShown: any): void;
-/**
- * Returns true if the element is using right to left (RTL) direction.
- * Copied from Closure's goog.style.isRightToLeft
- *
- * @param el The element to test.
- * @return True for right to left, false for left to right.
- * @alias Blockly.utils.style.isRightToLeft
- */
-export declare function isRightToLeft(el: Element): boolean;
 /**
  * Gets the computed border widths (on all sides) in pixels
  * Copied from Closure's goog.style.getBorderBox
+ *
  * @param element  The element to get the border widths for.
- * @return The computed border widths.
+ * @returns The computed border widths.
  * @alias Blockly.utils.style.getBorderBox
  */
 export declare function getBorderBox(element: Element): Rect;
@@ -117,7 +97,7 @@ export declare function scrollIntoContainerView(element: Element, container: Ele
  *     scroll element will be used.
  * @param opt_center Whether to center the element in the container.
  *     Defaults to false.
- * @return The new scroll position of the container.
+ * @returns The new scroll position of the container.
  * @alias Blockly.utils.style.getContainerOffsetToScrollInto
  */
 export declare function getContainerOffsetToScrollInto(element: Element, container: Element, opt_center?: boolean): Coordinate;
@@ -125,3 +105,4 @@ export declare const TEST_ONLY: {
     getSizeInternal: typeof getSizeInternal;
 };
 export {};
+//# sourceMappingURL=style.d.ts.map

package/core/utils/svg.d.ts

@@ -5,9 +5,10 @@
  */
 /**
  * A name with the type of the SVG element stored in the generic.
+ *
  * @alias Blockly.utils.Svg
  */
-export declare class Svg<T> {
+export declare class Svg<_T> {
     private readonly tagName;
     /** @internal */
     static ANIMATE: Svg<SVGAnimateElement>;
@@ -62,7 +63,9 @@ export declare class Svg<T> {
     constructor(tagName: string);
     /**
      * Returns the SVG element tag name.
-     * @return The name.
+     *
+     * @returns The name.
      */
     toString(): string;
 }
+//# sourceMappingURL=svg.d.ts.map