blockly 12.0.0-beta.0 → 12.0.0-beta.1

package/core/block.d.ts

@@ -540,6 +540,12 @@ export declare class Block implements IASTNodeLocation {
      * @returns Named field, or null if field does not exist.
      */
     getField(name: string): Field | null;
+    /**
+     * Returns a generator that provides every field on the block.
+     *
+     * @yields A generator that can be used to iterate the fields on the block.
+     */
+    getFields(): Generator<Field>;
     /**
      * Return all variables referenced by this block.
      *
@@ -641,9 +647,8 @@ export declare class Block implements IASTNodeLocation {
      * @returns True if enabled.
      */
     isEnabled(): boolean;
-    /** @deprecated v11 - Get whether the block is manually disabled. */
+    /** @deprecated v11 - Get or sets whether the block is manually disabled. */
     private get disabled();
-    /** @deprecated v11 - Set whether the block is manually disabled. */
     private set disabled(value);
     /**
      * @deprecated v11 - Set whether the block is manually enabled or disabled.
@@ -999,7 +1004,7 @@ export declare class Block implements IASTNodeLocation {
      *
      * Intended to on be used in console logs and errors. If you need a string
      * that uses the user's native language (including block text, field values,
-     * and child blocks), use [toString()]{@link Block#toString}.
+     * and child blocks), use {@link (Block:class).toString | toString()}.
      *
      * @returns The description.
      */

package/core/block_flyout_inflater.d.ts

@@ -5,7 +5,7 @@
  */
 import { BlockSvg } from './block_svg.js';
 import * as browserEvents from './browser_events.js';
-import type { IBoundedElement } from './interfaces/i_bounded_element.js';
+import { FlyoutItem } from './flyout_item.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { IFlyoutInflater } from './interfaces/i_flyout_inflater.js';
 import type { BlockInfo } from './utils/toolbox.js';
@@ -30,7 +30,7 @@ export declare class BlockFlyoutInflater implements IFlyoutInflater {
      * @param flyoutWorkspace The workspace to create the block on.
      * @returns A newly created block.
      */
-    load(state: object, flyoutWorkspace: WorkspaceSvg): IBoundedElement;
+    load(state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
     /**
      * Creates a block on the given workspace.
      *
@@ -46,13 +46,13 @@ export declare class BlockFlyoutInflater implements IFlyoutInflater {
      * @param defaultGap The default spacing for flyout items.
      * @returns The amount of space that should follow this block.
      */
-    gapForElement(state: object, defaultGap: number): number;
+    gapForItem(state: object, defaultGap: number): number;
     /**
      * Disposes of the given block.
      *
-     * @param element The flyout block to dispose of.
+     * @param item The flyout block to dispose of.
      */
-    disposeElement(element: IBoundedElement): void;
+    disposeItem(item: FlyoutItem): void;
     /**
      * Removes event listeners for the block with the given ID.
      *
@@ -85,5 +85,11 @@ export declare class BlockFlyoutInflater implements IFlyoutInflater {
      * @param event The event that triggered this update.
      */
     private filterFlyoutBasedOnCapacity;
+    /**
+     * Returns the type of items this inflater is responsible for creating.
+     *
+     * @returns An identifier for the type of items this inflater creates.
+     */
+    getType(): string;
 }
 //# sourceMappingURL=block_flyout_inflater.d.ts.map

package/core/block_svg.d.ts

@@ -132,13 +132,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      *
      * @returns #RRGGBB string.
      */
-    getColourSecondary(): string | undefined;
+    getColourSecondary(): string;
     /**
      * Get the tertiary colour of a block.
      *
      * @returns #RRGGBB string.
      */
-    getColourTertiary(): string | undefined;
+    getColourTertiary(): string;
     /** Selects this block. Highlights the block visually. */
     select(): void;
     /** Unselects this block. Unhighlights the block visually. */
@@ -470,6 +470,12 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @throws {Error} if the block style does not exist.
      */
     setStyle(blockStyleName: string): void;
+    /**
+     * Returns the BlockStyle object used to style this block.
+     *
+     * @returns This block's style object.
+     */
+    getStyle(): BlockStyle;
     /**
      * Move this block to the front of the visible workspace.
      * <g> tags do not respect z-index so SVG renders them in the

package/core/blockly.d.ts

@@ -48,9 +48,10 @@ import { FieldNumber, FieldNumberConfig, FieldNumberFromJsonConfig, FieldNumberV
 import * as fieldRegistry from './field_registry.js';
 import { FieldTextInput, FieldTextInputConfig, FieldTextInputFromJsonConfig, FieldTextInputValidator } from './field_textinput.js';
 import { FieldVariable, FieldVariableConfig, FieldVariableFromJsonConfig, FieldVariableValidator } from './field_variable.js';
-import { Flyout, FlyoutItem } from './flyout_base.js';
+import { Flyout } from './flyout_base.js';
 import { FlyoutButton } from './flyout_button.js';
 import { HorizontalFlyout } from './flyout_horizontal.js';
+import { FlyoutItem } from './flyout_item.js';
 import { FlyoutMetricsManager } from './flyout_metrics_manager.js';
 import { FlyoutSeparator } from './flyout_separator.js';
 import { VerticalFlyout } from './flyout_vertical.js';

package/core/button_flyout_inflater.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { IBoundedElement } from './interfaces/i_bounded_element.js';
+import { FlyoutItem } from './flyout_item.js';
 import type { IFlyoutInflater } from './interfaces/i_flyout_inflater.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
@@ -17,7 +17,7 @@ export declare class ButtonFlyoutInflater implements IFlyoutInflater {
      * @param flyoutWorkspace The workspace to create the button on.
      * @returns A newly created FlyoutButton.
      */
-    load(state: object, flyoutWorkspace: WorkspaceSvg): IBoundedElement;
+    load(state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
     /**
      * Returns the amount of space that should follow this button.
      *
@@ -25,12 +25,18 @@ export declare class ButtonFlyoutInflater implements IFlyoutInflater {
      * @param defaultGap The default spacing for flyout items.
      * @returns The amount of space that should follow this button.
      */
-    gapForElement(state: object, defaultGap: number): number;
+    gapForItem(state: object, defaultGap: number): number;
     /**
      * Disposes of the given button.
      *
-     * @param element The flyout button to dispose of.
+     * @param item The flyout button to dispose of.
      */
-    disposeElement(element: IBoundedElement): void;
+    disposeItem(item: FlyoutItem): void;
+    /**
+     * Returns the type of items this inflater is responsible for creating.
+     *
+     * @returns An identifier for the type of items this inflater creates.
+     */
+    getType(): string;
 }
 //# sourceMappingURL=button_flyout_inflater.d.ts.map

package/core/connection.d.ts

@@ -216,7 +216,7 @@ export declare class Connection implements IASTNodeLocationWithBlock {
      *
      * Headless configurations (the default) do not have neighboring connection,
      * and always return an empty list (the default).
-     * {@link RenderedConnection#neighbours} overrides this behavior with a list
+     * {@link (RenderedConnection:class).neighbours} overrides this behavior with a list
      * computed from the rendered positioning.
      *
      * @param _maxLimit The maximum radius to another connection.

package/core/events/events_var_delete.d.ts

@@ -9,8 +9,6 @@ import { VarBase, VarBaseJson } from './events_var_base.js';
 import { EventType } from './type.js';
 /**
  * Notifies listeners that a variable model has been deleted.
- *
- * @class
  */
 export declare class VarDelete extends VarBase {
     type: EventType;

package/core/events/events_var_rename.d.ts

@@ -9,8 +9,6 @@ import { VarBase, VarBaseJson } from './events_var_base.js';
 import { EventType } from './type.js';
 /**
  * Notifies listeners that a variable model was renamed.
- *
- * @class
  */
 export declare class VarRename extends VarBase {
     type: EventType;

package/core/flyout_base.d.ts

@@ -10,8 +10,8 @@
  */
 import { BlockSvg } from './block_svg.js';
 import { DeleteArea } from './delete_area.js';
+import { FlyoutItem } from './flyout_item.js';
 import { IAutoHideable } from './interfaces/i_autohideable.js';
-import type { IBoundedElement } from './interfaces/i_bounded_element.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { IFlyoutInflater } from './interfaces/i_flyout_inflater.js';
 import type { Options } from './options.js';
@@ -400,11 +400,4 @@ export declare abstract class Flyout extends DeleteArea implements IAutoHideable
      */
     protected getInflaterForType(type: string): IFlyoutInflater | null;
 }
-/**
- * A flyout content item.
- */
-export interface FlyoutItem {
-    type: string;
-    element: IBoundedElement;
-}
 //# sourceMappingURL=flyout_base.d.ts.map

package/core/flyout_horizontal.d.ts

@@ -3,7 +3,8 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Flyout, FlyoutItem } from './flyout_base.js';
+import { Flyout } from './flyout_base.js';
+import type { FlyoutItem } from './flyout_item.js';
 import type { Options } from './options.js';
 import type { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';

package/core/flyout_item.d.ts

@@ -0,0 +1,32 @@
+import type { IBoundedElement } from './interfaces/i_bounded_element.js';
+/**
+ * Representation of an item displayed in a flyout.
+ */
+export declare class FlyoutItem {
+    private element;
+    private type;
+    private focusable;
+    /**
+     * Creates a new FlyoutItem.
+     *
+     * @param element The element that will be displayed in the flyout.
+     * @param type The type of element. Should correspond to the type of the
+     *     flyout inflater that created this object.
+     * @param focusable True if the element should be allowed to be focused by
+     *     e.g. keyboard navigation in the flyout.
+     */
+    constructor(element: IBoundedElement, type: string, focusable: boolean);
+    /**
+     * Returns the element displayed in the flyout.
+     */
+    getElement(): IBoundedElement;
+    /**
+     * Returns the type of flyout element this item represents.
+     */
+    getType(): string;
+    /**
+     * Returns whether or not the flyout element can receive focus.
+     */
+    isFocusable(): boolean;
+}
+//# sourceMappingURL=flyout_item.d.ts.map

package/core/flyout_vertical.d.ts

@@ -3,7 +3,8 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Flyout, FlyoutItem } from './flyout_base.js';
+import { Flyout } from './flyout_base.js';
+import type { FlyoutItem } from './flyout_item.js';
 import type { Options } from './options.js';
 import type { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';

package/core/interfaces/i_flyout.d.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { BlockSvg } from '../block_svg.js';
-import { FlyoutItem } from '../flyout_base.js';
+import type { FlyoutItem } from '../flyout_item.js';
 import type { Coordinate } from '../utils/coordinate.js';
 import type { Svg } from '../utils/svg.js';
 import type { FlyoutDefinition } from '../utils/toolbox.js';

package/core/interfaces/i_flyout_inflater.d.ts

@@ -1,5 +1,5 @@
+import type { FlyoutItem } from '../flyout_item.js';
 import type { WorkspaceSvg } from '../workspace_svg.js';
-import type { IBoundedElement } from './i_bounded_element.js';
 export interface IFlyoutInflater {
     /**
      * Loads the object represented by the given state onto the workspace.
@@ -15,7 +15,7 @@ export interface IFlyoutInflater {
      *    element, however.
      * @returns The newly inflated flyout element.
      */
-    load(state: object, flyoutWorkspace: WorkspaceSvg): IBoundedElement;
+    load(state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
     /**
      * Returns the amount of spacing that should follow the element corresponding
      * to the given JSON representation.
@@ -24,7 +24,7 @@ export interface IFlyoutInflater {
      * @param defaultGap The default gap for elements in this flyout.
      * @returns The gap that should follow the given element.
      */
-    gapForElement(state: object, defaultGap: number): number;
+    gapForItem(state: object, defaultGap: number): number;
     /**
      * Disposes of the given element.
      *
@@ -34,6 +34,15 @@ export interface IFlyoutInflater {
      *
      * @param element The flyout element to dispose of.
      */
-    disposeElement(element: IBoundedElement): void;
+    disposeItem(item: FlyoutItem): void;
+    /**
+     * Returns the type of items that this inflater is responsible for inflating.
+     * This should be the same as the name under which this inflater registers
+     * itself, as well as the value returned by `getType()` on the `FlyoutItem`
+     * objects returned by `load()`.
+     *
+     * @returns The type of items this inflater creates.
+     */
+    getType(): string;
 }
 //# sourceMappingURL=i_flyout_inflater.d.ts.map

package/core/interfaces/i_metrics_manager.d.ts

@@ -47,7 +47,7 @@ export interface IMetricsManager {
      * Gets the width, height and position of the toolbox on the workspace in
      * pixel coordinates. Returns 0 for the width and height if the workspace has
      * a simple toolbox instead of a category toolbox. To get the width and height
-     * of a simple toolbox, see {@link IMetricsManager#getFlyoutMetrics}.
+     * of a simple toolbox, see {@link IMetricsManager.getFlyoutMetrics}.
      *
      * @returns The object with the width, height and position of the toolbox.
      */

package/core/interfaces/i_rendered_element.d.ts

@@ -3,17 +3,14 @@
  * Copyright 2023 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/** @internal */
 export interface IRenderedElement {
     /**
-     * @returns The root SVG element of htis rendered element.
+     * @returns The root SVG element of this rendered element.
      */
     getSvgRoot(): SVGElement;
 }
 /**
  * @returns True if the given object is an IRenderedElement.
- *
- * @internal
  */
 export declare function isRenderedElement(obj: any): obj is IRenderedElement;
 //# sourceMappingURL=i_rendered_element.d.ts.map

package/core/label_flyout_inflater.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { IBoundedElement } from './interfaces/i_bounded_element.js';
+import { FlyoutItem } from './flyout_item.js';
 import type { IFlyoutInflater } from './interfaces/i_flyout_inflater.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
@@ -17,7 +17,7 @@ export declare class LabelFlyoutInflater implements IFlyoutInflater {
      * @param flyoutWorkspace The workspace to create the label on.
      * @returns A FlyoutButton configured as a label.
      */
-    load(state: object, flyoutWorkspace: WorkspaceSvg): IBoundedElement;
+    load(state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
     /**
      * Returns the amount of space that should follow this label.
      *
@@ -25,12 +25,18 @@ export declare class LabelFlyoutInflater implements IFlyoutInflater {
      * @param defaultGap The default spacing for flyout items.
      * @returns The amount of space that should follow this label.
      */
-    gapForElement(state: object, defaultGap: number): number;
+    gapForItem(state: object, defaultGap: number): number;
     /**
      * Disposes of the given label.
      *
-     * @param element The flyout label to dispose of.
+     * @param item The flyout label to dispose of.
      */
-    disposeElement(element: IBoundedElement): void;
+    disposeItem(item: FlyoutItem): void;
+    /**
+     * Returns the type of items this inflater is responsible for creating.
+     *
+     * @returns An identifier for the type of items this inflater creates.
+     */
+    getType(): string;
 }
 //# sourceMappingURL=label_flyout_inflater.d.ts.map

package/core/menu.d.ts

@@ -148,9 +148,7 @@ export declare class Menu {
      */
     private handleMouseLeave;
     /**
-     * Attempts to handle a keyboard event, if the menu item is enabled, by
-     * calling
-     * {@link Menu#handleKeyEventInternal_}.
+     * Attempts to handle a keyboard event.
      *
      * @param e Key event to handle.
      */

package/core/metrics_manager.d.ts

@@ -48,7 +48,7 @@ export declare class MetricsManager implements IMetricsManager {
      * Gets the width, height and position of the toolbox on the workspace in
      * pixel coordinates. Returns 0 for the width and height if the workspace has
      * a simple toolbox instead of a category toolbox. To get the width and height
-     * of a simple toolbox, see {@link MetricsManager#getFlyoutMetrics}.
+     * of a simple toolbox, see {@link (MetricsManager:class).getFlyoutMetrics}.
      *
      * @returns The object with the width, height and position of the toolbox.
      */

package/core/procedures.d.ts

@@ -13,6 +13,7 @@ import { IProcedureBlock, isProcedureBlock } from './interfaces/i_procedure_bloc
 import { IProcedureMap } from './interfaces/i_procedure_map.js';
 import { IProcedureModel } from './interfaces/i_procedure_model.js';
 import { ObservableProcedureMap } from './observable_procedure_map.js';
+import type { FlyoutItemInfo } from './utils/toolbox.js';
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
@@ -64,12 +65,14 @@ export declare function isNameUsed(name: string, workspace: Workspace, opt_exclu
  */
 export declare function rename(this: Field, name: string): string;
 /**
- * Construct the blocks required by the flyout for the procedure category.
+ * Internal wrapper that returns the contents of the procedure category.
  *
- * @param workspace The workspace containing procedures.
- * @returns Array of XML block elements.
+ * @internal
+ * @param workspace The workspace to populate procedure blocks for.
  */
-export declare function flyoutCategory(workspace: WorkspaceSvg): Element[];
+export declare function internalFlyoutCategory(workspace: WorkspaceSvg): FlyoutItemInfo[];
+export declare function flyoutCategory(workspace: WorkspaceSvg, useXml: true): Element[];
+export declare function flyoutCategory(workspace: WorkspaceSvg, useXml: false): FlyoutItemInfo[];
 /**
  * Listens for when a procedure mutator is opened. Then it triggers a flyout
  * update and adds a mutator change listener to the mutator workspace.

package/core/renderers/common/renderer.d.ts

@@ -47,7 +47,7 @@ export declare class Renderer implements IRegistrable {
     /**
      * Create any DOM elements that this renderer needs.
      * If you need to create additional DOM elements, override the
-     * {@link ConstantProvider#createDom} method instead.
+     * {@link blockRendering#ConstantProvider.createDom} method instead.
      *
      * @param svg The root of the workspace's SVG.
      * @param theme The workspace theme object.

package/core/renderers/measurables/in_row_spacer.d.ts

@@ -10,6 +10,7 @@ import { Measurable } from './base.js';
  * row.
  */
 export declare class InRowSpacer extends Measurable {
+    private inRowSpacer;
     /**
      * @param constants The rendering constants provider.
      * @param width The width of the spacer.

package/core/renderers/measurables/jagged_edge.d.ts

@@ -10,6 +10,7 @@ import { Measurable } from './base.js';
  * collapsed block takes up during rendering.
  */
 export declare class JaggedEdge extends Measurable {
+    private jaggedEdge;
     /**
      * @param constants The rendering constants provider.
      */

package/core/renderers/measurables/next_connection.d.ts

@@ -11,6 +11,7 @@ import { Connection } from './connection.js';
  * up during rendering.
  */
 export declare class NextConnection extends Connection {
+    private nextConnection;
     /**
      * @param constants The rendering constants provider.
      * @param connectionModel The connection object on the block that this

package/core/renderers/measurables/previous_connection.d.ts

@@ -11,6 +11,7 @@ import { Connection } from './connection.js';
  * up during rendering.
  */
 export declare class PreviousConnection extends Connection {
+    private previousConnection;
     /**
      * @param constants The rendering constants provider.
      * @param connectionModel The connection object on the block that this

package/core/renderers/measurables/round_corner.d.ts

@@ -10,6 +10,7 @@ import { Measurable } from './base.js';
  * during rendering.
  */
 export declare class RoundCorner extends Measurable {
+    private roundCorner;
     /**
      * @param constants The rendering constants provider.
      * @param opt_position The position of this corner.

package/core/renderers/measurables/square_corner.d.ts

@@ -10,6 +10,7 @@ import { Measurable } from './base.js';
  * during rendering.
  */
 export declare class SquareCorner extends Measurable {
+    private squareCorner;
     /**
      * @param constants The rendering constants provider.
      * @param opt_position The position of this corner.

package/core/renderers/measurables/statement_input.d.ts

@@ -11,6 +11,7 @@ import { InputConnection } from './input_connection.js';
  * during rendering
  */
 export declare class StatementInput extends InputConnection {
+    private statementInput;
     /**
      * @param constants The rendering constants provider.
      * @param input The statement input to measure and store information for.