blockly 9.2.1 → 9.3.0

package/core/utils/keycodes.d.ts

@@ -10,8 +10,6 @@
  *
  * This list is not localized and therefore some of the key codes are not
  * correct for non US keyboard layouts. See comments below.
- *
- * @alias Blockly.utils.KeyCodes
  */
 export declare enum KeyCodes {
     WIN_KEY_FF_LINUX = 0,

package/core/utils/math.d.ts

@@ -9,7 +9,6 @@
  *
  * @param angleDegrees Angle in degrees.
  * @returns Angle in radians.
- * @alias Blockly.utils.math.toRadians
  */
 export declare function toRadians(angleDegrees: number): number;
 /**
@@ -18,7 +17,6 @@ export declare function toRadians(angleDegrees: number): number;
  *
  * @param angleRadians Angle in radians.
  * @returns Angle in degrees.
- * @alias Blockly.utils.math.toDegrees
  */
 export declare function toDegrees(angleRadians: number): number;
 /**
@@ -28,7 +26,6 @@ export declare function toDegrees(angleRadians: number): number;
  * @param number The number to clamp.
  * @param upperBound The desired upper bound.
  * @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

@@ -3,7 +3,6 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/** @alias Blockly.utils.Metrics */
 export interface Metrics {
     /** Height of the visible portion of the workspace. */
     viewHeight: number;

package/core/utils/object.d.ts

@@ -10,7 +10,6 @@
  * @param parentCtor Parent class.
  * @suppress {strictMissingProperties} superClass_ is not defined on Function.
  * @deprecated No longer provided by Blockly.
- * @alias Blockly.utils.object.inherits
  */
 export declare function inherits(childCtor: Function, parentCtor: Function): void;
 /**
@@ -19,7 +18,6 @@ export declare function inherits(childCtor: Function, parentCtor: Function): voi
  * @param target Target.
  * @param source Source.
  * @deprecated Use the built-in **Object.assign** instead.
- * @alias Blockly.utils.object.mixin
  */
 export declare function mixin(target: any, source: any): void;
 /**
@@ -28,7 +26,6 @@ export declare function mixin(target: any, source: any): void;
  * @param target Target.
  * @param source Source.
  * @returns The resulting object.
- * @alias Blockly.utils.object.deepMerge
  */
 export declare function deepMerge(target: any, source: any): any;
 /**
@@ -37,7 +34,6 @@ export declare function deepMerge(target: any, source: any): any;
  * @param obj Object containing values.
  * @returns Array of values.
  * @deprecated Use the built-in **Object.values** instead.
- * @alias Blockly.utils.object.values
  */
 export declare function values(obj: any): any[];
 //# sourceMappingURL=object.d.ts.map

package/core/utils/parsing.d.ts

@@ -13,7 +13,6 @@
  * @param message Text which might contain string table references and
  *     interpolation tokens.
  * @returns Array of strings and numbers.
- * @alias Blockly.utils.parsing.tokenizeInterpolation
  */
 export declare function tokenizeInterpolation(message: string): (string | number)[];
 /**
@@ -24,7 +23,6 @@ export declare function tokenizeInterpolation(message: string): (string | number
  * @param message Message, which may be a string that contains
  *     string table references.
  * @returns String with message references replaced.
- * @alias Blockly.utils.parsing.replaceMessageReferences
  */
 export declare function replaceMessageReferences(message: string | any): string;
 /**
@@ -34,7 +32,6 @@ export declare function replaceMessageReferences(message: string | any): string;
  * @param message Text which might contain string table references.
  * @returns True if all message references have matching values.
  *     Otherwise, false.
- * @alias Blockly.utils.parsing.checkMessageReferences
  */
 export declare function checkMessageReferences(message: string): boolean;
 /**
@@ -46,7 +43,6 @@ export declare function checkMessageReferences(message: string): boolean;
  * @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
  */
 export declare function parseBlockColour(colour: number | string): {
     hue: number | null;

package/core/utils/rect.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * Class for representing rectangular regions.
- *
- * @alias Blockly.utils.Rect
  */
 export declare class Rect {
     top: number;

package/core/utils/size.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * Class for representing sizes consisting of a width and height.
- *
- * @alias Blockly.utils.Size
  */
 export declare class Size {
     width: number;

package/core/utils/string.d.ts

@@ -10,7 +10,6 @@
  * @param str The string to check.
  * @param prefix A string to look for at the start of `str`.
  * @returns True if `str` begins with `prefix`.
- * @alias Blockly.utils.string.startsWith
  * @deprecated Use built-in **string.startsWith** instead.
  */
 export declare function startsWith(str: string, prefix: string): boolean;
@@ -19,7 +18,6 @@ export declare function startsWith(str: string, prefix: string): boolean;
  *
  * @param array Array of strings.
  * @returns Length of shortest string.
- * @alias Blockly.utils.string.shortestStringLength
  */
 export declare function shortestStringLength(array: string[]): number;
 /**
@@ -29,7 +27,6 @@ export declare function shortestStringLength(array: string[]): number;
  * @param array Array of strings.
  * @param opt_shortest Length of shortest string.
  * @returns Length of common prefix.
- * @alias Blockly.utils.string.commonWordPrefix
  */
 export declare function commonWordPrefix(array: string[], opt_shortest?: number): number;
 /**
@@ -39,7 +36,6 @@ export declare function commonWordPrefix(array: string[], opt_shortest?: number)
  * @param array Array of strings.
  * @param opt_shortest Length of shortest string.
  * @returns Length of common suffix.
- * @alias Blockly.utils.string.commonWordSuffix
  */
 export declare function commonWordSuffix(array: string[], opt_shortest?: number): number;
 /**
@@ -48,7 +44,6 @@ export declare function commonWordSuffix(array: string[], opt_shortest?: number)
  * @param text Text to wrap.
  * @param limit Width to wrap each line.
  * @returns Wrapped text.
- * @alias Blockly.utils.string.wrap
  */
 export declare function wrap(text: string, limit: number): string;
 /**
@@ -56,7 +51,6 @@ export declare function wrap(text: string, limit: number): string;
  *
  * @param str Input string.
  * @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

@@ -12,7 +12,6 @@ import { Size } from './size.js';
  *
  * @param element Element to get size of.
  * @returns Object with width/height properties.
- * @alias Blockly.utils.style.getSize
  */
 export declare function getSize(element: Element): Size;
 /**
@@ -29,7 +28,6 @@ declare function getSizeInternal(element: Element): Size;
  * @param element Element to get style of.
  * @param property Property to get (camel-case).
  * @returns Style value.
- * @alias Blockly.utils.style.getComputedStyle
  */
 export declare function getComputedStyle(element: Element, property: string): string;
 /**
@@ -42,7 +40,6 @@ export declare function getComputedStyle(element: Element, property: string): st
  * @param style Property to get (camel-case).
  * @returns Style value.
  * @deprecated No longer provided by Blockly.
- * @alias Blockly.utils.style.getCascadedStyle
  */
 export declare function getCascadedStyle(element: Element, style: string): string;
 /**
@@ -51,7 +48,6 @@ export declare function getCascadedStyle(element: Element, style: string): strin
  *
  * @param el Element to get the page offset for.
  * @returns The page offset.
- * @alias Blockly.utils.style.getPageOffset
  */
 export declare function getPageOffset(el: Element): Coordinate;
 /**
@@ -59,7 +55,6 @@ export declare function getPageOffset(el: Element): Coordinate;
  * Similar to Closure's goog.style.getViewportPageOffset
  *
  * @returns The page offset of the viewport.
- * @alias Blockly.utils.style.getViewportPageOffset
  */
 export declare function getViewportPageOffset(): Coordinate;
 /**
@@ -68,7 +63,6 @@ export declare function getViewportPageOffset(): Coordinate;
  *
  * @param element  The element to get the border widths for.
  * @returns The computed border widths.
- * @alias Blockly.utils.style.getBorderBox
  */
 export declare function getBorderBox(element: Element): Rect;
 /**
@@ -83,7 +77,6 @@ export declare function getBorderBox(element: Element): Rect;
  *     scroll element will be used.
  * @param opt_center Whether to center the element in the container.
  *     Defaults to false.
- * @alias Blockly.utils.style.scrollIntoContainerView
  */
 export declare function scrollIntoContainerView(element: Element, container: Element, opt_center?: boolean): void;
 /**
@@ -99,7 +92,6 @@ export declare function scrollIntoContainerView(element: Element, container: Ele
  * @param opt_center Whether to center the element in the container.
  *     Defaults to false.
  * @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;
 export declare const TEST_ONLY: {

package/core/utils/svg.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * A name with the type of the SVG element stored in the generic.
- *
- * @alias Blockly.utils.Svg
  */
 export declare class Svg<_T> {
     private readonly tagName;

package/core/utils/svg_math.d.ts

@@ -12,7 +12,6 @@ import { Rect } from './rect.js';
  *
  * @param element SVG element to find the coordinates of.
  * @returns Object with .x and .y properties.
- * @alias Blockly.utils.svgMath.getRelativeXY
  */
 export declare function getRelativeXY(element: Element): Coordinate;
 /**
@@ -22,7 +21,6 @@ export declare function getRelativeXY(element: Element): Coordinate;
  * @param element SVG element to find the coordinates of. If this is not a child
  *     of the div Blockly was injected into, the behaviour is undefined.
  * @returns Object with .x and .y properties.
- * @alias Blockly.utils.svgMath.getInjectionDivXY
  */
 export declare function getInjectionDivXY(element: Element): Coordinate;
 /**
@@ -31,7 +29,6 @@ export declare function getInjectionDivXY(element: Element): Coordinate;
  *
  * @returns True if 3D transforms are supported.
  * @deprecated No longer provided by Blockly.
- * @alias Blockly.utils.svgMath.is3dSupported
  */
 export declare function is3dSupported(): boolean;
 /**
@@ -40,7 +37,6 @@ export declare function is3dSupported(): boolean;
  *
  * @returns An object containing window width, height, and scroll position in
  *     window coordinates.
- * @alias Blockly.utils.svgMath.getViewportBBox
  * @internal
  */
 export declare function getViewportBBox(): Rect;
@@ -49,7 +45,6 @@ export declare function getViewportBBox(): Rect;
  * Copied from Closure's goog.dom.getDocumentScroll.
  *
  * @returns Object with values 'x' and 'y'.
- * @alias Blockly.utils.svgMath.getDocumentScroll
  */
 export declare function getDocumentScroll(): Coordinate;
 /**
@@ -59,7 +54,6 @@ export declare function getDocumentScroll(): Coordinate;
  * @param screenCoordinates The screen coordinates to be converted to workspace
  *     coordinates
  * @returns The workspace coordinates.
- * @alias Blockly.utils.svgMath.screenToWsCoordinates
  */
 export declare function screenToWsCoordinates(ws: WorkspaceSvg, screenCoordinates: Coordinate): Coordinate;
 export declare const TEST_ONLY: {

package/core/utils/svg_paths.d.ts

@@ -12,7 +12,6 @@
  * @param x The x coordinate.
  * @param y The y coordinate.
  * @returns A string of the format ' x,y '
- * @alias Blockly.utils.svgPaths.point
  */
 export declare function point(x: number, y: number): string;
 /**
@@ -27,7 +26,6 @@ export declare function point(x: number, y: number): string;
  *     x, y '.
  * @returns A string defining one or more Bezier curves.  See the MDN
  *     documentation for exact format.
- * @alias Blockly.utils.svgPaths.curve
  */
 export declare function curve(command: string, points: string[]): string;
 /**
@@ -39,7 +37,6 @@ export declare function curve(command: string, points: string[]): string;
  * @param x The absolute x coordinate.
  * @param y The absolute y coordinate.
  * @returns A string of the format ' M x,y '
- * @alias Blockly.utils.svgPaths.moveTo
  */
 export declare function moveTo(x: number, y: number): string;
 /**
@@ -51,7 +48,6 @@ export declare function moveTo(x: number, y: number): string;
  * @param dx The relative x coordinate.
  * @param dy The relative y coordinate.
  * @returns A string of the format ' m dx,dy '
- * @alias Blockly.utils.svgPaths.moveBy
  */
 export declare function moveBy(dx: number, dy: number): string;
 /**
@@ -63,7 +59,6 @@ export declare function moveBy(dx: number, dy: number): string;
  * @param dx The relative x coordinate.
  * @param dy The relative y coordinate.
  * @returns A string of the format ' l dx,dy '
- * @alias Blockly.utils.svgPaths.lineTo
  */
 export declare function lineTo(dx: number, dy: number): string;
 /**
@@ -75,7 +70,6 @@ export declare function lineTo(dx: number, dy: number): string;
  * @param points An array containing all of the points to draw lines to, in
  *     order.  The points are represented as strings of the format ' dx,dy '.
  * @returns A string of the format ' l (dx,dy)+ '
- * @alias Blockly.utils.svgPaths.line
  */
 export declare function line(points: string[]): string;
 /**
@@ -90,7 +84,6 @@ export declare function line(points: string[]): string;
  * @param val The coordinate to pass to the command.  It may be absolute or
  *     relative.
  * @returns A string of the format ' command val '
- * @alias Blockly.utils.svgPaths.lineOnAxis
  */
 export declare function lineOnAxis(command: string, val: number): string;
 /**
@@ -105,7 +98,6 @@ export declare function lineOnAxis(command: string, val: number): string;
  * @param point The point to move the cursor to after drawing the arc, specified
  *     either in absolute or relative coordinates depending on the command.
  * @returns A string of the format 'command radius radius flags point'
- * @alias Blockly.utils.svgPaths.arc
  */
 export declare function arc(command: string, flags: string, radius: number, point: string): string;
 //# sourceMappingURL=svg_paths.d.ts.map

package/core/utils/toolbox.d.ts

@@ -9,8 +9,6 @@ import type { CssConfig as SeparatorCssConfig } from '../toolbox/separator.js';
 /**
  * The information needed to create a block in the toolbox.
  * Note that disabled has a different type for backwards compatibility.
- *
- * @alias Blockly.utils.toolbox.BlockInfo
  */
 export interface BlockInfo {
     kind: string;
@@ -39,8 +37,6 @@ export interface BlockInfo {
 }
 /**
  * The information needed to create a separator in the toolbox.
- *
- * @alias Blockly.utils.toolbox.SeparatorInfo
  */
 export interface SeparatorInfo {
     kind: string;
@@ -50,8 +46,6 @@ export interface SeparatorInfo {
 }
 /**
  * The information needed to create a button in the toolbox.
- *
- * @alias Blockly.utils.toolbox.ButtonInfo
  */
 export interface ButtonInfo {
     kind: string;
@@ -60,8 +54,6 @@ export interface ButtonInfo {
 }
 /**
  * The information needed to create a label in the toolbox.
- *
- * @alias Blockly.utils.toolbox.LabelInfo
  */
 export interface LabelInfo {
     kind: string;
@@ -70,14 +62,10 @@ export interface LabelInfo {
 }
 /**
  * The information needed to create either a button or a label in the flyout.
- *
- * @alias Blockly.utils.toolbox.ButtonOrLabelInfo
  */
 export type ButtonOrLabelInfo = ButtonInfo | LabelInfo;
 /**
  * The information needed to create a category in the toolbox.
- *
- * @alias Blockly.utils.toolbox.StaticCategoryInfo
  */
 export interface StaticCategoryInfo {
     kind: string;
@@ -88,11 +76,10 @@ export interface StaticCategoryInfo {
     colour: string | undefined;
     cssconfig: CategoryCssConfig | undefined;
     hidden: string | undefined;
+    expanded?: string | boolean;
 }
 /**
  * The information needed to create a custom category.
- *
- * @alias Blockly.utils.toolbox.DynamicCategoryInfo
  */
 export interface DynamicCategoryInfo {
     kind: string;
@@ -102,29 +89,22 @@ export interface DynamicCategoryInfo {
     colour: string | undefined;
     cssconfig: CategoryCssConfig | undefined;
     hidden: string | undefined;
+    expanded?: string | boolean;
 }
 /**
  * The information needed to create either a dynamic or static category.
- *
- * @alias Blockly.utils.toolbox.CategoryInfo
  */
 export type CategoryInfo = StaticCategoryInfo | DynamicCategoryInfo;
 /**
  * Any information that can be used to create an item in the toolbox.
- *
- * @alias Blockly.utils.toolbox.ToolboxItemInfo
  */
 export type ToolboxItemInfo = FlyoutItemInfo | StaticCategoryInfo;
 /**
  * All the different types that can be displayed in a flyout.
- *
- * @alias Blockly.utils.toolbox.FlyoutItemInfo
  */
 export type FlyoutItemInfo = BlockInfo | SeparatorInfo | ButtonInfo | LabelInfo | DynamicCategoryInfo;
 /**
  * The JSON definition of a toolbox.
- *
- * @alias Blockly.utils.toolbox.ToolboxInfo
  */
 export interface ToolboxInfo {
     kind?: string;
@@ -132,26 +112,18 @@ export interface ToolboxInfo {
 }
 /**
  * An array holding flyout items.
- *
- * @alias Blockly.utils.toolbox.FlyoutItemInfoArray
  */
 export type FlyoutItemInfoArray = FlyoutItemInfo[];
 /**
  * All of the different types that can create a toolbox.
- *
- * @alias Blockly.utils.toolbox.ToolboxDefinition
  */
 export type ToolboxDefinition = Node | ToolboxInfo | string;
 /**
  * All of the different types that can be used to show items in a flyout.
- *
- * @alias Blockly.utils.toolbox.FlyoutDefinition
  */
 export type FlyoutDefinition = FlyoutItemInfoArray | NodeList | ToolboxInfo | Node[];
 /**
  * Position of the toolbox and/or flyout relative to the workspace.
- *
- * @alias Blockly.utils.toolbox.Position
  */
 export declare enum Position {
     TOP = 0,
@@ -164,7 +136,6 @@ export declare enum Position {
  *
  * @param toolboxDef The definition of the toolbox in one of its many forms.
  * @returns Object holding information for creating a toolbox.
- * @alias Blockly.utils.toolbox.convertToolboxDefToJson
  * @internal
  */
 export declare function convertToolboxDefToJson(toolboxDef: ToolboxDefinition | null): ToolboxInfo | null;
@@ -173,7 +144,6 @@ export declare function convertToolboxDefToJson(toolboxDef: ToolboxDefinition |
  *
  * @param flyoutDef The definition of the flyout in one of its many forms.
  * @returns A list of flyout items.
- * @alias Blockly.utils.toolbox.convertFlyoutDefToJsonArray
  * @internal
  */
 export declare function convertFlyoutDefToJsonArray(flyoutDef: FlyoutDefinition | null): FlyoutItemInfoArray;
@@ -182,7 +152,6 @@ export declare function convertFlyoutDefToJsonArray(flyoutDef: FlyoutDefinition
  *
  * @param toolboxJson Object holding information for creating a toolbox.
  * @returns True if the toolbox has categories.
- * @alias Blockly.utils.toolbox.hasCategories
  * @internal
  */
 export declare function hasCategories(toolboxJson: ToolboxInfo | null): boolean;
@@ -195,7 +164,6 @@ declare function hasCategoriesInternal(toolboxJson: ToolboxInfo | null): boolean
  *
  * @param categoryInfo Object holing information for creating a category.
  * @returns True if the category has subcategories.
- * @alias Blockly.utils.toolbox.isCategoryCollapsible
  * @internal
  */
 export declare function isCategoryCollapsible(categoryInfo: CategoryInfo): boolean;
@@ -204,7 +172,6 @@ export declare function isCategoryCollapsible(categoryInfo: CategoryInfo): boole
  *
  * @param toolboxDef DOM tree of blocks, or text representation of same.
  * @returns DOM tree of blocks, or null.
- * @alias Blockly.utils.toolbox.parseToolboxTree
  */
 export declare function parseToolboxTree(toolboxDef: Element | null | string): Element | null;
 export declare const TEST_ONLY: {

package/core/utils/useragent.d.ts

@@ -3,20 +3,12 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/** @alias Blockly.utils.userAgent.raw */
 export declare const raw: string;
-/** @alias Blockly.utils.userAgent.JavaFx */
 export declare const JavaFx: boolean;
-/** @alias Blockly.utils.userAgent.GECKO */
 export declare const GECKO: boolean;
-/** @alias Blockly.utils.userAgent.ANDROID */
 export declare const ANDROID: boolean;
-/** @alias Blockly.utils.userAgent.IPAD */
 export declare const IPAD: boolean;
-/** @alias Blockly.utils.userAgent.IPHONE */
 export declare const IPHONE: boolean;
-/** @alias Blockly.utils.userAgent.MAC */
 export declare const MAC: boolean;
-/** @alias Blockly.utils.userAgent.MOBILE */
 export declare const MOBILE: boolean;
 //# sourceMappingURL=useragent.d.ts.map

package/core/utils/xml.d.ts

@@ -44,8 +44,6 @@ export declare function injectDependencies(dependencies: {
 }): void;
 /**
  * Namespace for Blockly's XML.
- *
- * @alias Blockly.utils.xml.NAME_SPACE
  */
 export declare const NAME_SPACE = "https://developers.google.com/blockly/xml";
 /**
@@ -53,7 +51,6 @@ export declare const NAME_SPACE = "https://developers.google.com/blockly/xml";
  *
  * @returns The document object.
  * @deprecated No longer provided by Blockly.
- * @alias Blockly.utils.xml.getDocument
  */
 export declare function getDocument(): Document;
 /**
@@ -61,7 +58,6 @@ export declare function getDocument(): Document;
  *
  * @param xmlDocument The document object to use.
  * @deprecated No longer provided by Blockly.
- * @alias Blockly.utils.xml.setDocument
  */
 export declare function setDocument(xmlDocument: Document): void;
 /**
@@ -69,7 +65,6 @@ export declare function setDocument(xmlDocument: Document): void;
  *
  * @param tagName Name of DOM element.
  * @returns New DOM element.
- * @alias Blockly.utils.xml.createElement
  */
 export declare function createElement(tagName: string): Element;
 /**
@@ -77,16 +72,23 @@ export declare function createElement(tagName: string): Element;
  *
  * @param text Text content.
  * @returns New DOM text node.
- * @alias Blockly.utils.xml.createTextNode
  */
 export declare function createTextNode(text: string): Text;
+/**
+ * Converts an XML string into a DOM structure.
+ *
+ * @param text An XML string.
+ * @returns A DOM object representing the singular child of the document
+ *     element.
+ * @throws if the text doesn't parse.
+ */
+export declare function textToDom(text: string): Element;
 /**
  * Converts an XML string into a DOM tree.
  *
  * @param text XML string.
  * @returns The DOM document.
  * @throws if XML doesn't parse.
- * @alias Blockly.utils.xml.textToDomDocument
  */
 export declare function textToDomDocument(text: string): Document;
 /**
@@ -95,7 +97,6 @@ export declare function textToDomDocument(text: string): Document;
  *
  * @param dom A tree of XML nodes.
  * @returns Text representation.
- * @alias Blockly.utils.xml.domToText
  */
 export declare function domToText(dom: Node): string;
 export {};