blockly 9.0.0-beta.0 → 9.0.0-beta.1

package/core/utils/colour.d.ts

@@ -5,13 +5,15 @@
  */
 /**
  * Get the richness of block colours, regardless of the hue.
+ *
  * @alias Blockly.utils.colour.getHsvSaturation
- * @return The current richness.
+ * @returns The current richness.
  * @internal
  */
 export declare function getHsvSaturation(): number;
 /**
  * Set the richness of block colours, regardless of the hue.
+ *
  * @param newSaturation The new richness, in the range of  0 (inclusive) to 1
  *     (exclusive)
  * @alias Blockly.utils.colour.setHsvSaturation
@@ -20,13 +22,15 @@ export declare function getHsvSaturation(): number;
 export declare function setHsvSaturation(newSaturation: number): void;
 /**
  * Get the intensity of block colours, regardless of the hue.
+ *
  * @alias Blockly.utils.colour.getHsvValue
- * @return The current intensity.
+ * @returns The current intensity.
  * @internal
  */
 export declare function getHsvValue(): number;
 /**
  * Set the intensity of block colours, regardless of the hue.
+ *
  * @param newValue The new intensity, in the range of  0 (inclusive) to 1
  *     (exclusive)
  * @alias Blockly.utils.colour.setHsvValue
@@ -35,51 +39,56 @@ export declare function getHsvValue(): number;
 export declare function setHsvValue(newValue: number): void;
 /**
  * Parses a colour from a string.
- * .parse('red') -> '#ff0000'
- * .parse('#f00') -> '#ff0000'
- * .parse('#ff0000') -> '#ff0000'
- * .parse('0xff0000') -> '#ff0000'
- * .parse('rgb(255, 0, 0)') -> '#ff0000'
+ * .parse('red') = '#ff0000'
+ * .parse('#f00') = '#ff0000'
+ * .parse('#ff0000') = '#ff0000'
+ * .parse('0xff0000') = '#ff0000'
+ * .parse('rgb(255, 0, 0)') = '#ff0000'
+ *
  * @param str Colour in some CSS format.
- * @return A string containing a hex representation of the colour, or null if
+ * @returns A string containing a hex representation of the colour, or null if
  *     can't be parsed.
  * @alias Blockly.utils.colour.parse
  */
 export declare function parse(str: string | number): string | null;
 /**
  * Converts a colour from RGB to hex representation.
+ *
  * @param r Amount of red, int between 0 and 255.
  * @param g Amount of green, int between 0 and 255.
  * @param b Amount of blue, int between 0 and 255.
- * @return Hex representation of the colour.
+ * @returns Hex representation of the colour.
  * @alias Blockly.utils.colour.rgbToHex
  */
 export declare function rgbToHex(r: number, g: number, b: number): string;
 /**
  * Converts a colour to RGB.
+ *
  * @param colour String representing colour in any colour format ('#ff0000',
  *     'red', '0xff000', etc).
- * @return RGB representation of the colour.
+ * @returns RGB representation of the colour.
  * @alias Blockly.utils.colour.hexToRgb
  */
 export declare function hexToRgb(colour: string): number[];
 /**
  * Converts an HSV triplet to hex representation.
+ *
  * @param h Hue value in [0, 360].
  * @param s Saturation value in [0, 1].
  * @param v Brightness in [0, 255].
- * @return Hex representation of the colour.
+ * @returns Hex representation of the colour.
  * @alias Blockly.utils.colour.hsvToHex
  */
 export declare function hsvToHex(h: number, s: number, v: number): string;
 /**
  * Blend two colours together, using the specified factor to indicate the
  * weight given to the first colour.
+ *
  * @param colour1 First colour.
  * @param colour2 Second colour.
  * @param factor The weight to be given to colour1 over colour2.
  *     Values should be in the range [0, 1].
- * @return Combined colour represented in hex.
+ * @returns Combined colour represented in hex.
  * @alias Blockly.utils.colour.blend
  */
 export declare function blend(colour1: string, colour2: string, factor: number): string | null;
@@ -96,8 +105,10 @@ export declare const names: {
 };
 /**
  * Convert a hue (HSV model) into an RGB hex triplet.
+ *
  * @param hue Hue on a colour wheel (0-360).
- * @return RGB code, e.g. '#5ba65b'.
+ * @returns RGB code, e.g. '#5ba65b'.
  * @alias Blockly.utils.colour.hueToHex
  */
 export declare function hueToHex(hue: number): string;
+//# sourceMappingURL=colour.d.ts.map

package/core/utils/coordinate.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Class for representing coordinates and positions.
+ *
  * @alias Blockly.utils.Coordinate
  */
 export declare class Coordinate {
@@ -17,56 +18,65 @@ export declare class Coordinate {
     constructor(x: number, y: number);
     /**
      * Creates a new copy of this coordinate.
-     * @return A copy of this coordinate.
+     *
+     * @returns A copy of this coordinate.
      */
     clone(): Coordinate;
     /**
      * Scales this coordinate by the given scale factor.
+     *
      * @param s The scale factor to use for both x and y dimensions.
-     * @return This coordinate after scaling.
+     * @returns This coordinate after scaling.
      */
     scale(s: number): Coordinate;
     /**
      * Translates this coordinate by the given offsets.
      * respectively.
+     *
      * @param tx The value to translate x by.
      * @param ty The value to translate y by.
-     * @return This coordinate after translating.
+     * @returns This coordinate after translating.
      */
     translate(tx: number, ty: number): Coordinate;
     /**
      * Compares coordinates for equality.
+     *
      * @param a A Coordinate.
      * @param b A Coordinate.
-     * @return True iff the coordinates are equal, or if both are null.
+     * @returns True iff the coordinates are equal, or if both are null.
      */
     static equals(a: Coordinate | null, b: Coordinate | null): boolean;
     /**
      * Returns the distance between two coordinates.
+     *
      * @param a A Coordinate.
      * @param b A Coordinate.
-     * @return The distance between `a` and `b`.
+     * @returns The distance between `a` and `b`.
      */
     static distance(a: Coordinate, b: Coordinate): number;
     /**
      * Returns the magnitude of a coordinate.
+     *
      * @param a A Coordinate.
-     * @return The distance between the origin and `a`.
+     * @returns The distance between the origin and `a`.
      */
     static magnitude(a: Coordinate): number;
     /**
      * Returns the difference between two coordinates as a new
      * Coordinate.
+     *
      * @param a An x/y coordinate.
      * @param b An x/y coordinate.
-     * @return A Coordinate representing the difference between `a` and `b`.
+     * @returns A Coordinate representing the difference between `a` and `b`.
      */
     static difference(a: Coordinate | SVGPoint, b: Coordinate | SVGPoint): Coordinate;
     /**
      * Returns the sum of two coordinates as a new Coordinate.
+     *
      * @param a An x/y coordinate.
      * @param b An x/y coordinate.
-     * @return A Coordinate representing the sum of the two coordinates.
+     * @returns A Coordinate representing the sum of the two coordinates.
      */
     static sum(a: Coordinate | SVGPoint, b: Coordinate | SVGPoint): Coordinate;
 }
+//# sourceMappingURL=coordinate.d.ts.map

package/core/utils/deprecation.d.ts

@@ -5,13 +5,15 @@
  */
 /**
  * Warn developers that a function or property is deprecated.
+ *
  * @param name The name of the function or property.
- * @param deprecationDate The date of deprecation.
- *     Prefer 'month yyyy' or 'quarter yyyy' format.
- * @param deletionDate The date of deletion, in the same format as the
- *     deprecation date.
+ * @param deprecationDate The date of deprecation. Prefer 'version n.0.0'
+ *     format, and fall back to 'month yyyy' or 'quarter yyyy' format.
+ * @param deletionDate The date of deletion. Prefer 'version n.0.0'
+ *     format, and fall back to 'month yyyy' or 'quarter yyyy' format.
  * @param opt_use The name of a function or property to use instead, if any.
  * @alias Blockly.utils.deprecation.warn
  * @internal
  */
 export declare function warn(name: string, deprecationDate: string, deletionDate: string, opt_use?: string): void;
+//# sourceMappingURL=deprecation.d.ts.map

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,27 @@ 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: any, 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
@@ -58,31 +65,35 @@ export declare function removeClasses(element: Element, classNames: string): voi
 /**
  * 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 +101,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,6 +112,7 @@ 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
@@ -108,19 +121,22 @@ export declare function setCssTransform(element: Element, transform: string): vo
 /**
  * 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,11 +144,12 @@ 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;
@@ -140,26 +157,29 @@ export declare function getFastTextWidth(textElement: Element, fontSize: 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;
 /**
  * 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,7 +3,15 @@
  * 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:
@@ -12,14 +20,16 @@ export declare const TEST_ONLY: {};
  * 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