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

package/core/scrollbar.d.ts

@@ -3,6 +3,7 @@
  * Copyright 2011 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import * as browserEvents from './browser_events.js';
 import { Coordinate } from './utils/coordinate.js';
 import type { Metrics } from './utils/metrics.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
@@ -14,6 +15,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * Class for a pure SVG scrollbar.
  * This technique offers a scrollbar that is guaranteed to work, but may not
  * look or behave like the system's scrollbars.
+ *
  * @alias Blockly.Scrollbar
  */
 export declare class Scrollbar {
@@ -27,6 +29,7 @@ export declare class Scrollbar {
     /**
      * Default margin around the scrollbar (between the scrollbar and the edge of
      * the viewport in pixels).
+     *
      * @internal
      */
     static readonly DEFAULT_SCROLLBAR_MARGIN = 0.5;
@@ -36,6 +39,7 @@ export declare class Scrollbar {
     private oldHostMetrics_;
     /**
      * The ratio of handle position offset to workspace content displacement.
+     *
      * @internal
      */
     ratio: number;
@@ -73,8 +77,10 @@ export declare class Scrollbar {
     position: Coordinate;
     lengthAttribute_: string;
     positionAttribute_: string;
-    onMouseDownBarWrapper_: any;
-    onMouseDownHandleWrapper_: any;
+    onMouseDownBarWrapper_: browserEvents.Data | null;
+    onMouseDownHandleWrapper_: browserEvents.Data | null;
+    onMouseUpWrapper_: browserEvents.Data | null;
+    onMouseMoveWrapper_: browserEvents.Data | null;
     /**
      * @param workspace Workspace to bind the scrollbar to.
      * @param horizontal True if horizontal, false if vertical.
@@ -86,38 +92,44 @@ export declare class Scrollbar {
     /**
      * Dispose of this scrollbar.
      * Unlink from all DOM elements to prevent memory leaks.
+     *
      * @suppress {checkTypes}
      */
     dispose(): void;
     /**
      * Constrain the handle's length within the minimum (0) and maximum
      * (scrollbar background) values allowed for the scrollbar.
+     *
      * @param value Value that is potentially out of bounds, in CSS pixels.
-     * @return Constrained value, in CSS pixels.
+     * @returns Constrained value, in CSS pixels.
      */
     private constrainHandleLength_;
     /**
      * Set the length of the scrollbar's handle and change the SVG attribute
      * accordingly.
+     *
      * @param newLength The new scrollbar handle length in CSS pixels.
      */
     private setHandleLength_;
     /**
      * Constrain the handle's position within the minimum (0) and maximum values
      * allowed for the scrollbar.
+     *
      * @param value Value that is potentially out of bounds, in CSS pixels.
-     * @return Constrained value, in CSS pixels.
+     * @returns Constrained value, in CSS pixels.
      */
     private constrainHandlePosition_;
     /**
      * Set the offset of the scrollbar's handle from the scrollbar's position, and
      * change the SVG attribute accordingly.
+     *
      * @param newPosition The new scrollbar handle offset in CSS pixels.
      */
     setHandlePosition(newPosition: number): void;
     /**
      * Set the size of the scrollbar's background and change the SVG attribute
      * accordingly.
+     *
      * @param newSize The new scrollbar background length in CSS pixels.
      */
     private setScrollbarLength_;
@@ -125,6 +137,7 @@ export declare class Scrollbar {
      * Set the position of the scrollbar's SVG group in CSS pixels relative to the
      * scrollbar's origin.  This sets the scrollbar's location within the
      * workspace.
+     *
      * @param x The new x coordinate.
      * @param y The new y coordinate.
      * @internal
@@ -132,6 +145,7 @@ export declare class Scrollbar {
     setPosition(x: number, y: number): void;
     /**
      * Recalculate the scrollbar's location and its length.
+     *
      * @param opt_metrics A data structure of from the describing all the required
      *     dimensions.  If not provided, it will be fetched from the host object.
      */
@@ -139,13 +153,15 @@ export declare class Scrollbar {
     /**
      * Returns whether the a resizeView is necessary by comparing the passed
      * hostMetrics with cached old host metrics.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
-     * @return Whether a resizeView is necessary.
+     * @returns Whether a resizeView is necessary.
      */
     private requiresViewResize_;
     /**
      * Recalculate a horizontal scrollbar's location and length.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
@@ -154,6 +170,7 @@ export declare class Scrollbar {
      * Recalculate a horizontal scrollbar's location on the screen and path
      * length. This should be called when the layout or size of the window has
      * changed.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
@@ -161,12 +178,14 @@ export declare class Scrollbar {
     /**
      * Recalculate a horizontal scrollbar's location within its path and length.
      * This should be called when the contents of the workspace have changed.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
     resizeContentHorizontal(hostMetrics: Metrics): void;
     /**
      * Recalculate a vertical scrollbar's location and length.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
@@ -174,6 +193,7 @@ export declare class Scrollbar {
     /**
      * Recalculate a vertical scrollbar's location on the screen and path length.
      * This should be called when the layout or size of the window has changed.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
@@ -181,6 +201,7 @@ export declare class Scrollbar {
     /**
      * Recalculate a vertical scrollbar's location within its path and length.
      * This should be called when the contents of the workspace have changed.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
@@ -188,24 +209,28 @@ export declare class Scrollbar {
     /**
      * Create all the DOM elements required for a scrollbar.
      * The resulting widget is not sized.
+     *
      * @param opt_class A class to be applied to this scrollbar.
      */
     private createDom_;
     /**
      * Is the scrollbar visible.  Non-paired scrollbars disappear when they aren't
      * needed.
-     * @return True if visible.
+     *
+     * @returns True if visible.
      */
     isVisible(): boolean;
     /**
      * Set whether the scrollbar's container is visible and update
      * display accordingly if visibility has changed.
+     *
      * @param visible Whether the container is visible
      */
     setContainerVisible(visible: boolean): void;
     /**
      * Set whether the scrollbar is visible.
      * Only applies to non-paired scrollbars.
+     *
      * @param visible True if visible.
      */
     setVisible(visible: boolean): void;
@@ -219,18 +244,21 @@ export declare class Scrollbar {
     /**
      * Scroll by one pageful.
      * Called when scrollbar background is clicked.
+     *
      * @param e Mouse down event.
      */
     private onMouseDownBar_;
     /**
      * Start a dragging operation.
      * Called when scrollbar handle is clicked.
+     *
      * @param e Mouse down event.
      */
     private onMouseDownHandle_;
     /**
      * Drag the scrollbar's handle.
-     * @param e Mouse up event.
+     *
+     * @param e Mouse move event.
      */
     private onMouseMoveHandle_;
     /** Release the scrollbar handle and reset state accordingly. */
@@ -242,7 +270,8 @@ export declare class Scrollbar {
     private cleanUp_;
     /**
      * Helper to calculate the ratio of handle position to scrollbar view size.
-     * @return Ratio.
+     *
+     * @returns Ratio.
      * @internal
      */
     getRatio_(): number;
@@ -253,6 +282,7 @@ export declare class Scrollbar {
     private updateMetrics_;
     /**
      * Set the scrollbar handle's position.
+     *
      * @param value The content displacement, relative to the view in pixels.
      * @param updateMetrics Whether to update metrics on this set call.
      *    Defaults to true.
@@ -263,6 +293,7 @@ export declare class Scrollbar {
      * relative to the injection div origin. This is for times when the scrollbar
      * is used in an object whose origin isn't the same as the main workspace
      * (e.g. in a flyout.)
+     *
      * @param x The x coordinate of the scrollbar's origin, in CSS pixels.
      * @param y The y coordinate of the scrollbar's origin, in CSS pixels.
      */
@@ -271,7 +302,8 @@ export declare class Scrollbar {
      * @param first An object containing computed measurements of a workspace.
      * @param second Another object containing computed measurements of a
      *     workspace.
-     * @return Whether the two sets of metrics are equivalent.
+     * @returns Whether the two sets of metrics are equivalent.
      */
     private static metricsAreEquivalent_;
 }
+//# sourceMappingURL=scrollbar.d.ts.map

package/core/scrollbar_pair.d.ts

@@ -3,17 +3,19 @@
  * Copyright 2011 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { Scrollbar } from './scrollbar.js';
 import type { Metrics } from './utils/metrics.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a pair of scrollbars.  Horizontal and vertical.
+ *
  * @alias Blockly.ScrollbarPair
  */
 export declare class ScrollbarPair {
     private workspace;
-    hScroll: any;
-    vScroll: any;
-    corner_: any;
+    hScroll: Scrollbar | null;
+    vScroll: Scrollbar | null;
+    corner_: SVGRectElement | null;
     /** Previously recorded metrics from the workspace. */
     private oldHostMetrics_;
     /**
@@ -28,6 +30,7 @@ export declare class ScrollbarPair {
     /**
      * Dispose of this pair of scrollbars.
      * Unlink from all DOM elements to prevent memory leaks.
+     *
      * @suppress {checkTypes}
      */
     dispose(): void;
@@ -38,12 +41,14 @@ export declare class ScrollbarPair {
     resize(): void;
     /**
      * Returns whether scrolling horizontally is enabled.
-     * @return True if horizontal scroll is enabled.
+     *
+     * @returns True if horizontal scroll is enabled.
      */
     canScrollHorizontally(): boolean;
     /**
      * Returns whether scrolling vertically is enabled.
-     * @return True if vertical scroll is enabled.
+     *
+     * @returns True if vertical scroll is enabled.
      */
     canScrollVertically(): boolean;
     /**
@@ -51,6 +56,7 @@ export declare class ScrollbarPair {
      * relative to the injection div origin. This is for times when the scrollbar
      * is used in an object whose origin isn't the same as the main workspace
      * (e.g. in a flyout.)
+     *
      * @param x The x coordinate of the scrollbar's origin, in CSS pixels.
      * @param y The y coordinate of the scrollbar's origin, in CSS pixels.
      * @internal
@@ -58,6 +64,7 @@ export declare class ScrollbarPair {
     setOrigin(x: number, y: number): void;
     /**
      * Set the handles of both scrollbars.
+     *
      * @param x The horizontal content displacement, relative to the view in
      *     pixels.
      * @param y The vertical content displacement, relative to the view in pixels.
@@ -68,29 +75,34 @@ export declare class ScrollbarPair {
     /**
      * Set the handle of the horizontal scrollbar to be at a certain position in
      *    CSS pixels relative to its parents.
+     *
      * @param x Horizontal scroll value.
      */
     setX(x: number): void;
     /**
      * Set the handle of the vertical scrollbar to be at a certain position in
      *    CSS pixels relative to its parents.
+     *
      * @param y Vertical scroll value.
      */
     setY(y: number): void;
     /**
      * Set whether this scrollbar's container is visible.
+     *
      * @param visible Whether the container is visible.
      */
     setContainerVisible(visible: boolean): void;
     /**
      * If any of the scrollbars are visible. Non-paired scrollbars may disappear
      * when they aren't needed.
-     * @return True if visible.
+     *
+     * @returns True if visible.
      */
     isVisible(): boolean;
     /**
      * Recalculates the scrollbars' locations within their path and length.
      * This should be called when the contents of the workspace have changed.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
@@ -98,8 +110,10 @@ export declare class ScrollbarPair {
     /**
      * Recalculates the scrollbars' locations on the screen and path length.
      * This should be called when the layout or size of the window has changed.
+     *
      * @param hostMetrics A data structure describing all the required dimensions,
      *     possibly fetched from the host object.
      */
     resizeView(hostMetrics: Metrics): void;
 }
+//# sourceMappingURL=scrollbar_pair.d.ts.map

package/core/serialization/blocks.d.ts

@@ -8,6 +8,7 @@ import type { Connection } from '../connection.js';
 import type { Workspace } from '../workspace.js';
 /**
  * Represents the state of a connection.
+ *
  * @alias Blockly.serialization.blocks.ConnectionState
  */
 export interface ConnectionState {
@@ -16,6 +17,7 @@ export interface ConnectionState {
 }
 /**
  * Represents the state of a given block.
+ *
  * @alias Blockly.serialization.blocks.State
  */
 export interface State {
@@ -41,6 +43,7 @@ export interface State {
 }
 /**
  * Returns the state of the given block as a plain JavaScript object.
+ *
  * @param block The block to serialize.
  * @param param1 addCoordinates: If true, the coordinates of the block are added
  *     to the serialized state. False by default. addinputBlocks: If true,
@@ -52,11 +55,11 @@ export interface State {
  *     instead serialize all of the info about that state. This supports
  *     deserializing the block into a workspace where that state doesn't yet
  *     exist. True by default.
- * @return The serialized state of the block, or null if the block could not be
+ * @returns The serialized state of the block, or null if the block could not be
  *     serialied (eg it was an insertion marker).
  * @alias Blockly.serialization.blocks.save
  */
-export declare function save(block: Block, { addCoordinates, addInputBlocks, addNextBlocks, doFullSerialization }?: {
+export declare function save(block: Block, { addCoordinates, addInputBlocks, addNextBlocks, doFullSerialization, }?: {
     addCoordinates?: boolean;
     addInputBlocks?: boolean;
     addNextBlocks?: boolean;
@@ -64,11 +67,12 @@ export declare function save(block: Block, { addCoordinates, addInputBlocks, add
 }): State | null;
 /**
  * Loads the block represented by the given state into the given workspace.
+ *
  * @param state The state of a block to deserialize into the workspace.
  * @param workspace The workspace to add the block to.
  * @param param1 recordUndo: If true, events triggered by this function will be
  *     undo-able by the user. False by default.
- * @return The block that was just loaded.
+ * @returns The block that was just loaded.
  * @alias Blockly.serialization.blocks.append
  */
 export declare function append(state: State, workspace: Workspace, { recordUndo }?: {
@@ -80,6 +84,7 @@ export declare function append(state: State, workspace: Workspace, { recordUndo
  * external API.
  * But it is exported so that other places within Blockly can call it directly
  * with the extra parameters.
+ *
  * @param state The state of a block to deserialize into the workspace.
  * @param workspace The workspace to add the block to.
  * @param param1 parentConnection: If provided, the system will attempt to
@@ -87,7 +92,7 @@ export declare function append(state: State, workspace: Workspace, { recordUndo
  *     default. isShadow: If true, the block will be set to a shadow block after
  *     it is created. False by default. recordUndo: If true, events triggered by
  *     this function will be undo-able by the user. False by default.
- * @return The block that was just appended.
+ * @returns The block that was just appended.
  * @alias Blockly.serialization.blocks.appendInternal
  * @internal
  */
@@ -96,3 +101,4 @@ export declare function appendInternal(state: State, workspace: Workspace, { par
     isShadow?: boolean;
     recordUndo?: boolean;
 }): Block;
+//# sourceMappingURL=blocks.d.ts.map

package/core/serialization/exceptions.d.ts

@@ -11,6 +11,7 @@ export declare class DeserializationError extends Error {
 /**
  * Represents an error where the serialized state is expected to provide a
  * block type, but it is not provided.
+ *
  * @alias Blockly.serialization.exceptions.MissingBlockType
  */
 export declare class MissingBlockType extends DeserializationError {
@@ -24,6 +25,7 @@ export declare class MissingBlockType extends DeserializationError {
 /**
  * Represents an error where deserialization encountered a block that did
  * not have a connection that was defined in the serialized state.
+ *
  * @alias Blockly.serialization.exceptions.MissingConnection
  */
 export declare class MissingConnection extends DeserializationError {
@@ -41,6 +43,7 @@ export declare class MissingConnection extends DeserializationError {
 /**
  * Represents an error where deserialization tried to connect two connections
  * that were not compatible.
+ *
  * @alias Blockly.serialization.exceptions.BadConnectionCheck
  */
 export declare class BadConnectionCheck extends DeserializationError {
@@ -61,6 +64,7 @@ export declare class BadConnectionCheck extends DeserializationError {
  * was deserializing children of a shadow.
  * This is an error because it is an invariant of Blockly that shadow blocks
  * do not have real children.
+ *
  * @alias Blockly.serialization.exceptions.RealChildOfShadow
  */
 export declare class RealChildOfShadow extends DeserializationError {
@@ -71,3 +75,4 @@ export declare class RealChildOfShadow extends DeserializationError {
      */
     constructor(state: State);
 }
+//# sourceMappingURL=exceptions.d.ts.map

package/core/serialization/priorities.d.ts

@@ -5,11 +5,14 @@
  */
 /**
  * The priority for deserializing variables.
+ *
  * @alias Blockly.serialization.priorities.VARIABLES
  */
 export declare const VARIABLES = 100;
 /**
  * The priority for deserializing blocks.
+ *
  * @alias Blockly.serialization.priorities.BLOCKS
  */
 export declare const BLOCKS = 50;
+//# sourceMappingURL=priorities.d.ts.map

package/core/serialization/registry.d.ts

@@ -7,6 +7,7 @@ import type { ISerializer } from '../interfaces/i_serializer.js';
 /**
  * Registers the given serializer so that it can be used for serialization and
  * deserialization.
+ *
  * @param name The name of the serializer to register.
  * @param serializer The serializer to register.
  * @alias Blockly.serialization.registry.register
@@ -14,7 +15,9 @@ import type { ISerializer } from '../interfaces/i_serializer.js';
 export declare function register(name: string, serializer: ISerializer): void;
 /**
  * Unregisters the serializer associated with the given name.
+ *
  * @param name The name of the serializer to unregister.
  * @alias Blockly.serialization.registry.unregister
  */
 export declare function unregister(name: string): void;
+//# sourceMappingURL=registry.d.ts.map

package/core/serialization/variables.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Represents the state of a given variable.
+ *
  * @alias Blockly.serialization.variables.State
  */
 export interface State {
@@ -12,3 +13,4 @@ export interface State {
     id: string;
     type: string | undefined;
 }
+//# sourceMappingURL=variables.d.ts.map

package/core/serialization/workspaces.d.ts

@@ -6,8 +6,9 @@
 import type { Workspace } from '../workspace.js';
 /**
  * Returns the state of the workspace as a plain JavaScript object.
+ *
  * @param workspace The workspace to serialize.
- * @return The serialized state of the workspace.
+ * @returns The serialized state of the workspace.
  * @alias Blockly.serialization.workspaces.save
  */
 export declare function save(workspace: Workspace): {
@@ -15,6 +16,7 @@ export declare function save(workspace: Workspace): {
 };
 /**
  * Loads the variable represented by the given state into the given workspace.
+ *
  * @param state The state of the workspace to deserialize into the workspace.
  * @param workspace The workspace to add the new state to.
  * @param param1 recordUndo: If true, events triggered by this function will be
@@ -26,3 +28,4 @@ export declare function load(state: {
 }, workspace: Workspace, { recordUndo }?: {
     recordUndo?: boolean;
 }): void;
+//# sourceMappingURL=workspaces.d.ts.map

package/core/shortcut_items.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Object holding the names of the default shortcut items.
+ *
  * @alias Blockly.ShortcutItems.names
  */
 export declare enum names {
@@ -18,44 +19,53 @@ export declare enum names {
 }
 /**
  * Keyboard shortcut to hide chaff on escape.
+ *
  * @alias Blockly.ShortcutItems.registerEscape
  */
 export declare function registerEscape(): void;
 /**
  * Keyboard shortcut to delete a block on delete or backspace
+ *
  * @alias Blockly.ShortcutItems.registerDelete
  */
 export declare function registerDelete(): void;
 /**
  * Keyboard shortcut to copy a block on ctrl+c, cmd+c, or alt+c.
+ *
  * @alias Blockly.ShortcutItems.registerCopy
  */
 export declare function registerCopy(): void;
 /**
  * Keyboard shortcut to copy and delete a block on ctrl+x, cmd+x, or alt+x.
+ *
  * @alias Blockly.ShortcutItems.registerCut
  */
 export declare function registerCut(): void;
 /**
  * Keyboard shortcut to paste a block on ctrl+v, cmd+v, or alt+v.
+ *
  * @alias Blockly.ShortcutItems.registerPaste
  */
 export declare function registerPaste(): void;
 /**
  * Keyboard shortcut to undo the previous action on ctrl+z, cmd+z, or alt+z.
+ *
  * @alias Blockly.ShortcutItems.registerUndo
  */
 export declare function registerUndo(): void;
 /**
  * Keyboard shortcut to redo the previous action on ctrl+shift+z, cmd+shift+z,
  * or alt+shift+z.
+ *
  * @alias Blockly.ShortcutItems.registerRedo
  */
 export declare function registerRedo(): void;
 /**
  * Registers all default keyboard shortcut item. This should be called once per
  * instance of KeyboardShortcutRegistry.
+ *
  * @alias Blockly.ShortcutItems.registerDefaultShortcuts
  * @internal
  */
 export declare function registerDefaultShortcuts(): void;
+//# sourceMappingURL=shortcut_items.d.ts.map