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

package/core/touch.d.ts

@@ -23,6 +23,7 @@ export declare const TOUCH_ENABLED: boolean;
 /**
  * The TOUCH_MAP lookup dictionary specifies additional touch events to fire,
  * in conjunction with mouse events.
+ *
  * @alias Blockly.Touch.TOUCH_MAP
  */
 export declare const TOUCH_MAP: {
@@ -34,6 +35,7 @@ export declare const TOUCH_MAP: {
  * by Chrome.  This function is fired on any touchstart event, queues a task,
  * which after about a second opens the context menu.  The tasks is killed
  * if the touch event terminates early.
+ *
  * @param e Touch start event.
  * @param gesture The gesture that triggered this longStart.
  * @alias Blockly.Touch.longStart
@@ -43,6 +45,7 @@ export declare function longStart(e: Event, gesture: Gesture): void;
 /**
  * Nope, that's not a long-press.  Either touchend or touchcancel was fired,
  * or a drag hath begun.  Kill the queued long-press task.
+ *
  * @alias Blockly.Touch.longStop
  * @internal
  */
@@ -51,6 +54,7 @@ export declare function longStop(): void;
  * Clear the touch identifier that tracks which touch stream to pay attention
  * to.  This ends the current drag/gesture and allows other pointers to be
  * captured.
+ *
  * @alias Blockly.Touch.clearTouchIdentifier
  */
 export declare function clearTouchIdentifier(): void;
@@ -58,8 +62,9 @@ export declare function clearTouchIdentifier(): void;
  * Decide whether Blockly should handle or ignore this event.
  * Mouse and touch events require special checks because we only want to deal
  * with one touch stream at a time.  All other events should always be handled.
+ *
  * @param e The event to check.
- * @return True if this event should be passed through to the registered
+ * @returns True if this event should be passed through to the registered
  *     handler; false if it should be blocked.
  * @alias Blockly.Touch.shouldHandleEvent
  */
@@ -67,8 +72,9 @@ export declare function shouldHandleEvent(e: Event | PseudoEvent): boolean;
 /**
  * Get the touch identifier from the given event.  If it was a mouse event, the
  * identifier is the string 'mouse'.
+ *
  * @param e Mouse event or touch event.
- * @return The touch identifier from the first changed touch, if defined.
+ * @returns The touch identifier from the first changed touch, if defined.
  *     Otherwise 'mouse'.
  * @alias Blockly.Touch.getTouchIdentifierFromEvent
  */
@@ -81,8 +87,9 @@ export declare function getTouchIdentifierFromEvent(e: Event | PseudoEvent): str
  * If the current identifier was unset, save the identifier from the
  * event.  This starts a drag/gesture, during which touch events with other
  * identifiers will be silently ignored.
+ *
  * @param e Mouse event or touch event.
- * @return Whether the identifier on the event matches the current saved
+ * @returns Whether the identifier on the event matches the current saved
  *     identifier.
  * @alias Blockly.Touch.checkTouchIdentifier
  */
@@ -90,32 +97,37 @@ export declare function checkTouchIdentifier(e: Event | PseudoEvent): boolean;
 /**
  * Set an event's clientX and clientY from its first changed touch.  Use this to
  * make a touch event work in a mouse event handler.
+ *
  * @param e A touch event.
  * @alias Blockly.Touch.setClientFromTouch
  */
 export declare function setClientFromTouch(e: Event | PseudoEvent): void;
 /**
  * Check whether a given event is a mouse, touch, or pointer event.
+ *
  * @param e An event.
- * @return True if it is a mouse, touch, or pointer event; false otherwise.
+ * @returns True if it is a mouse, touch, or pointer event; false otherwise.
  * @alias Blockly.Touch.isMouseOrTouchEvent
  */
 export declare function isMouseOrTouchEvent(e: Event | PseudoEvent): boolean;
 /**
  * Check whether a given event is a touch event or a pointer event.
+ *
  * @param e An event.
- * @return True if it is a touch or pointer event; false otherwise.
+ * @returns True if it is a touch or pointer event; false otherwise.
  * @alias Blockly.Touch.isTouchEvent
  */
 export declare function isTouchEvent(e: Event | PseudoEvent): boolean;
 /**
  * Split an event into an array of events, one per changed touch or mouse
  * point.
+ *
  * @param e A mouse event or a touch event with one or more changed touches.
- * @return An array of events or pseudo events.
+ * @returns An array of events or pseudo events.
  *     Each pseudo-touch event will have exactly one changed touch and there
  * will be no real touch events.
  * @alias Blockly.Touch.splitEventByTouches
  */
 export declare function splitEventByTouches(e: Event): Array<Event | PseudoEvent>;
 export {};
+//# sourceMappingURL=touch.d.ts.map

package/core/touch_gesture.d.ts

@@ -3,10 +3,12 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import * as browserEvents from './browser_events.js';
 import { Gesture } from './gesture.js';
 import { Coordinate } from './utils/coordinate.js';
 /**
  * Class for one gesture.
+ *
  * @alias Blockly.TouchGesture
  */
 export declare class TouchGesture extends Gesture {
@@ -31,11 +33,12 @@ export declare class TouchGesture extends Gesture {
     private onStartWrapper_;
     /** Boolean for whether or not the workspace supports pinch-zoom. */
     private isPinchZoomEnabled_;
-    onMoveWrapper_: any;
-    onUpWrapper_: any;
+    onMoveWrapper_: browserEvents.Data | null;
+    onUpWrapper_: browserEvents.Data | null;
     /**
      * Start a gesture: update the workspace to indicate that a gesture is in
      * progress and bind mousemove and mouseup handlers.
+     *
      * @param e A mouse down, touch start or pointer down event.
      * @internal
      */
@@ -47,42 +50,49 @@ export declare class TouchGesture extends Gesture {
      * opt_noCaptureIdentifier.
      * In addition, binding a second mouse down event to detect multi-touch
      * events.
+     *
      * @param e A mouse down or touch start event.
      * @internal
      */
     bindMouseEvents(e: Event): void;
     /**
      * Handle a mouse down, touch start, or pointer down event.
+     *
      * @param e A mouse down, touch start, or pointer down event.
      * @internal
      */
     handleStart(e: Event): void;
     /**
      * Handle a mouse move, touch move, or pointer move event.
+     *
      * @param e A mouse move, touch move, or pointer move event.
      * @internal
      */
     handleMove(e: MouseEvent): void;
     /**
      * Handle a mouse up, touch end, or pointer up event.
+     *
      * @param e A mouse up, touch end, or pointer up event.
      * @internal
      */
     handleUp(e: Event): void;
     /**
      * Whether this gesture is part of a multi-touch gesture.
-     * @return Whether this gesture is part of a multi-touch gesture.
+     *
+     * @returns Whether this gesture is part of a multi-touch gesture.
      * @internal
      */
     isMultiTouch(): boolean;
     /**
      * Sever all links from this object.
+     *
      * @internal
      */
     dispose(): void;
     /**
      * Handle a touch start or pointer down event and keep track of current
      * pointers.
+     *
      * @param e A touch start, or pointer down event.
      * @internal
      */
@@ -90,26 +100,31 @@ export declare class TouchGesture extends Gesture {
     /**
      * Handle a touch move or pointer move event and zoom in/out if two pointers
      * are on the screen.
+     *
      * @param e A touch move, or pointer move event.
      * @internal
      */
     handleTouchMove(e: MouseEvent): void;
     /**
      * Handle pinch zoom gesture.
+     *
      * @param e A touch move, or pointer move event.
      */
     private handlePinch_;
     /**
      * Handle a touch end or pointer end event and end the gesture.
+     *
      * @param e A touch end, or pointer end event.
      * @internal
      */
     handleTouchEnd(e: Event): void;
     /**
      * Helper function returning the current touch point coordinate.
+     *
      * @param e A touch or pointer event.
-     * @return The current touch point coordinate
+     * @returns The current touch point coordinate
      * @internal
      */
     getTouchPoint(e: Event): Coordinate | null;
 }
+//# sourceMappingURL=touch_gesture.d.ts.map

package/core/trashcan.d.ts

@@ -14,6 +14,7 @@ import { Rect } from './utils/rect.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a trash can.
+ *
  * @alias Blockly.Trashcan
  */
 export declare class Trashcan extends DeleteArea implements IAutoHideable, IPositionable {
@@ -29,6 +30,7 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     private readonly contents_;
     /**
      * The trashcan flyout.
+     *
      * @internal
      */
     flyout: IFlyout | null;
@@ -57,7 +59,8 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     constructor(workspace: WorkspaceSvg);
     /**
      * Create the trash can elements.
-     * @return The trash can's SVG group.
+     *
+     * @returns The trash can's SVG group.
      */
     createDom(): SVGElement;
     /** Initializes the trash can. */
@@ -65,17 +68,20 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     /**
      * Dispose of this trash can.
      * Unlink from all DOM elements to prevent memory leaks.
+     *
      * @suppress {checkTypes}
      */
     dispose(): void;
     /**
      * Whether the trashcan has contents.
-     * @return True if the trashcan has contents.
+     *
+     * @returns True if the trashcan has contents.
      */
     private hasContents_;
     /**
      * Returns true if the trashcan contents-flyout is currently open.
-     * @return True if the trashcan contents-flyout is currently open.
+     *
+     * @returns True if the trashcan contents-flyout is currently open.
      */
     contentsIsOpen(): boolean;
     /** Opens the trashcan flyout. */
@@ -84,6 +90,7 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     closeFlyout(): void;
     /**
      * Hides the component. Called in WorkspaceSvg.hideChaff.
+     *
      * @param onlyClosePopups Whether only popups should be closed.
      *     Flyouts should not be closed if this is true.
      */
@@ -97,6 +104,7 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
      * Positions the trashcan.
      * It is positioned in the opposite corner to the corner the
      * categories/toolbox starts at.
+     *
      * @param metrics The workspace metrics.
      * @param savedPositions List of rectangles that are already on the workspace.
      */
@@ -104,36 +112,42 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     /**
      * Returns the bounding rectangle of the UI element in pixel units relative to
      * the Blockly injection div.
-     * @return The UI elements's bounding box. Null if bounding box should be
+     *
+     * @returns The UI elements's bounding box. Null if bounding box should be
      *     ignored by other UI elements.
      */
     getBoundingRectangle(): Rect | null;
     /**
      * Returns the bounding rectangle of the drag target area in pixel units
      * relative to viewport.
-     * @return The component's bounding box. Null if drag target area should be
+     *
+     * @returns The component's bounding box. Null if drag target area should be
      *     ignored.
      */
     getClientRect(): Rect | null;
     /**
      * Handles when a cursor with a block or bubble is dragged over this drag
      * target.
+     *
      * @param _dragElement The block or bubble currently being dragged.
      */
     onDragOver(_dragElement: IDraggable): void;
     /**
      * Handles when a cursor with a block or bubble exits this drag target.
+     *
      * @param _dragElement The block or bubble currently being dragged.
      */
     onDragExit(_dragElement: IDraggable): void;
     /**
      * Handles when a block or bubble is dropped on this component.
      * Should not handle delete here.
+     *
      * @param _dragElement The block or bubble currently being dragged.
      */
     onDrop(_dragElement: IDraggable): void;
     /**
      * Flip the lid open or shut.
+     *
      * @param state True if open.
      * @internal
      */
@@ -142,12 +156,14 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     private animateLid_;
     /**
      * Set the angle of the trashcan's lid.
+     *
      * @param lidAngle The angle at which to set the lid.
      */
     private setLidAngle_;
     /**
      * Sets the minimum openness of the trashcan lid. If the lid is currently
      * closed, this will update lid's position.
+     *
      * @param newMin The new minimum openness of the lid. Should be between 0
      *     and 1.
      */
@@ -161,11 +177,13 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     click(): void;
     /**
      * Fires a UI event for trashcan flyout open or close.
+     *
      * @param trashcanOpen Whether the flyout is opening.
      */
     private fireUiEvent_;
     /**
      * Prevents a workspace scroll and click event if the trashcan has blocks.
+     *
      * @param e A mouse down event.
      */
     private blockMouseDownWhenOpenable_;
@@ -181,15 +199,18 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     /**
      * Handle a BLOCK_DELETE event. Adds deleted blocks oldXml to the content
      * array.
+     *
      * @param event Workspace event.
      */
     private onDelete_;
     /**
      * Converts JSON representing a block into text that can be stored in the
      * content array.
+     *
      * @param json A JSON representation of a block's state.
-     * @return A BlockInfo object corresponding to the JSON, cleaned of all
+     * @returns A BlockInfo object corresponding to the JSON, cleaned of all
      *     unnecessary attributes.
      */
     private cleanBlockJson_;
 }
+//# sourceMappingURL=trashcan.d.ts.map

package/core/utils/aria.d.ts

@@ -6,6 +6,7 @@
 /**
  * ARIA role values.
  * Copied from Closure's goog.a11y.aria.Role
+ *
  * @alias Blockly.utils.aria.Role
  */
 export declare enum Role {
@@ -25,6 +26,7 @@ export declare enum Role {
 /**
  * ARIA states and properties.
  * Copied from Closure's goog.a11y.aria.State
+ *
  * @alias Blockly.utils.aria.State
  */
 export declare enum State {
@@ -57,6 +59,7 @@ export declare function setRole(element: Element, roleName: Role): void;
 /**
  * Sets the state or property of an element.
  * Copied from Closure's goog.a11y.aria
+ *
  * @param element DOM node where we set state.
  * @param stateName State attribute being set.
  *     Automatically adds prefix 'aria-' to the state name if the attribute is
@@ -65,3 +68,4 @@ export declare function setRole(element: Element, roleName: Role): void;
  * @alias Blockly.utils.aria.setState
  */
 export declare function setState(element: Element, stateName: State, value: string | boolean | number | string[]): void;
+//# sourceMappingURL=aria.d.ts.map

package/core/utils/array.d.ts

@@ -5,10 +5,12 @@
  */
 /**
  * Removes the first occurrence of a particular value from an array.
+ *
  * @param arr Array from which to remove value.
  * @param value Value to remove.
- * @return True if an element was removed.
+ * @returns True if an element was removed.
  * @alias Blockly.array.removeElem
  * @internal
  */
-export declare function removeElem(arr: any[], value: any): boolean;
+export declare function removeElem<T>(arr: Array<T>, value: T): boolean;
+//# sourceMappingURL=array.d.ts.map

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;
+    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