blockly 12.0.0-beta.5 → 12.0.0-beta.7

package/core/toolbox/toolbox_item.d.ts

@@ -103,5 +103,7 @@ export declare class ToolboxItem implements IToolboxItem {
     onNodeFocus(): void;
     /** See IFocusableNode.onNodeBlur. */
     onNodeBlur(): void;
+    /** See IFocusableNode.canBeFocused. */
+    canBeFocused(): boolean;
 }
 //# sourceMappingURL=toolbox_item.d.ts.map

package/core/utils/object.d.ts

@@ -6,6 +6,9 @@
 /**
  * Complete a deep merge of all members of a source object with a target object.
  *
+ * N.B. This is not a very sophisticated merge algorithm and does not
+ * handle complex cases. Use with caution.
+ *
  * @param target Target.
  * @param source Source.
  * @returns The resulting object.

package/core/variable_map.d.ts

@@ -21,14 +21,19 @@ import type { Workspace } from './workspace.js';
  */
 export declare class VariableMap implements IVariableMap<IVariableModel<IVariableState>> {
     workspace: Workspace;
+    potentialMap: boolean;
     /**
      * A map from variable type to map of IDs to variables. The maps contain
      * all of the named variables in the workspace, including variables that are
      * not currently in use.
      */
     private variableMap;
-    /** @param workspace The workspace this map belongs to. */
-    constructor(workspace: Workspace);
+    /**
+     * @param workspace The workspace this map belongs to.
+     * @param potentialMap True if this holds variables that don't exist in the
+     *  workspace yet.
+     */
+    constructor(workspace: Workspace, potentialMap?: boolean);
     /** Clear the variable map.  Fires events for every deletion. */
     clear(): void;
     /**

package/core/widgetdiv.d.ts

@@ -31,8 +31,13 @@ export declare function createDom(): void;
  * @param newDispose Optional cleanup function to be run when the widget is
  *     closed.
  * @param workspace The workspace associated with the widget owner.
+ * @param manageEphemeralFocus Whether ephemeral focus should be managed
+ *     according to the widget div's lifetime. Note that if a false value is
+ *     passed in here then callers should manage ephemeral focus directly
+ *     otherwise focus may not properly restore when the widget closes. Defaults
+ *     to true.
  */
-export declare function show(newOwner: unknown, rtl: boolean, newDispose: () => void, workspace?: WorkspaceSvg | null): void;
+export declare function show(newOwner: unknown, rtl: boolean, newDispose: () => void, workspace?: WorkspaceSvg | null, manageEphemeralFocus?: boolean): void;
 /**
  * Destroy the widget and hide the div.
  */

package/core/workspace.d.ts

@@ -13,7 +13,6 @@ import type { Block } from './block.js';
 import { WorkspaceComment } from './comments/workspace_comment.js';
 import type { ConnectionDB } from './connection_db.js';
 import type { Abstract } from './events/events_abstract.js';
-import type { IASTNodeLocation } from './interfaces/i_ast_node_location.js';
 import type { IConnectionChecker } from './interfaces/i_connection_checker.js';
 import { IProcedureMap } from './interfaces/i_procedure_map.js';
 import type { IVariableMap } from './interfaces/i_variable_map.js';
@@ -24,7 +23,7 @@ import type * as toolbox from './utils/toolbox.js';
  * Class for a workspace.  This is a data structure that contains blocks.
  * There is no UI, and can be created headlessly.
  */
-export declare class Workspace implements IASTNodeLocation {
+export declare class Workspace {
     /**
      * Angle away from the horizontal to sweep for blocks.  Order of execution is
      * generally top to bottom, but a small angle changes the scan to give a bit

package/core/workspace_dragger.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Methods for dragging a workspace visually.
+ *
+ * @class
+ */
 import { Coordinate } from './utils/coordinate.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**

package/core/workspace_svg.d.ts

@@ -20,7 +20,6 @@ import { ContextMenuOption } from './contextmenu_registry.js';
 import type { FlyoutButton } from './flyout_button.js';
 import { Gesture } from './gesture.js';
 import { Grid } from './grid.js';
-import type { IASTNodeLocationSvg } from './interfaces/i_ast_node_location_svg.js';
 import type { IBoundedElement } from './interfaces/i_bounded_element.js';
 import { IContextMenu } from './interfaces/i_contextmenu.js';
 import type { IDragTarget } from './interfaces/i_drag_target.js';
@@ -28,7 +27,6 @@ import type { IFlyout } from './interfaces/i_flyout.js';
 import { type IFocusableNode } from './interfaces/i_focusable_node.js';
 import type { IFocusableTree } from './interfaces/i_focusable_tree.js';
 import type { IMetricsManager } from './interfaces/i_metrics_manager.js';
-import type { INavigable } from './interfaces/i_navigable.js';
 import type { IToolbox } from './interfaces/i_toolbox.js';
 import type { LineCursor } from './keyboard_nav/line_cursor.js';
 import type { Marker } from './keyboard_nav/marker.js';
@@ -54,7 +52,7 @@ import { ZoomControls } from './zoom_controls.js';
  * Class for a workspace.  This is an onscreen area with optional trashcan,
  * scrollbars, bubbles, and dragging.
  */
-export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationSvg, IContextMenu, IFocusableNode, IFocusableTree, INavigable<WorkspaceSvg> {
+export declare class WorkspaceSvg extends Workspace implements IContextMenu, IFocusableNode, IFocusableTree {
     /**
      * A wrapper function called when a resize event occurs.
      * You can pass the result to `eventHandling.unbind`.
@@ -1043,6 +1041,8 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     onNodeFocus(): void;
     /** See IFocusableNode.onNodeBlur. */
     onNodeBlur(): void;
+    /** See IFocusableNode.canBeFocused. */
+    canBeFocused(): boolean;
     /** See IFocusableTree.getRootFocusableNode. */
     getRootFocusableNode(): IFocusableNode;
     /** See IFocusableTree.getRestoredFocusableNode. */
@@ -1055,18 +1055,6 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     onTreeFocus(_node: IFocusableNode, _previousTree: IFocusableTree | null): void;
     /** See IFocusableTree.onTreeBlur. */
     onTreeBlur(nextTree: IFocusableTree | null): void;
-    /**
-     * Returns the class of this workspace.
-     *
-     * @returns WorkspaceSvg.
-     */
-    getClass(): typeof WorkspaceSvg;
-    /**
-     * Returns whether or not this workspace is keyboard-navigable.
-     *
-     * @returns True.
-     */
-    isNavigable(): boolean;
     /**
      * Returns an object responsible for coordinating movement of focus between
      * items on this workspace in response to keyboard navigation commands.
@@ -1074,6 +1062,13 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * @returns This workspace's Navigator instance.
      */
     getNavigator(): Navigator;
+    /**
+     * Sets the Navigator instance used by this workspace.
+     *
+     * @param newNavigator A Navigator object to coordinate movement between
+     *     elements on the workspace.
+     */
+    setNavigator(newNavigator: Navigator): void;
 }
 /**
  * Size the workspace when the contents change.  This also updates

package/index.mjs

@@ -1,6 +1,5 @@
 import Blockly from './index.js';
 export const {
-  ASTNode,
   Block,
   BlockFlyoutInflater,
   BlockNavigationPolicy,
@@ -44,6 +43,7 @@ export const {
   FlyoutItem,
   FlyoutMetricsManager,
   FlyoutNavigationPolicy,
+  FlyoutNavigator,
   FlyoutSeparator,
   FlyoutSeparatorNavigationPolicy,
   FocusManager,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockly",
-  "version": "12.0.0-beta.5",
+  "version": "12.0.0-beta.7",
   "description": "Blockly is a library for building visual programming editors.",
   "keywords": [
     "blockly"

package/core/events/events_marker_move.d.ts

@@ -1,69 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Events fired as a result of a marker move.
- *
- * @class
- */
-import type { Block } from '../block.js';
-import { ASTNode } from '../keyboard_nav/ast_node.js';
-import type { Workspace } from '../workspace.js';
-import { AbstractEventJson } from './events_abstract.js';
-import { UiBase } from './events_ui_base.js';
-import { EventType } from './type.js';
-/**
- * Notifies listeners that a marker (used for keyboard navigation) has
- * moved.
- */
-export declare class MarkerMove extends UiBase {
-    /** The ID of the block the marker is now on, if any. */
-    blockId?: string;
-    /** The old node the marker used to be on, if any. */
-    oldNode?: ASTNode;
-    /** The new node the marker is now on. */
-    newNode?: ASTNode;
-    /**
-     * True if this is a cursor event, false otherwise.
-     * For information about cursors vs markers see {@link
-     * https://blocklycodelabs.dev/codelabs/keyboard-navigation/index.html?index=..%2F..index#1}.
-     */
-    isCursor?: boolean;
-    type: EventType;
-    /**
-     * @param opt_block The affected block. Null if current node is of type
-     *     workspace. Undefined for a blank event.
-     * @param isCursor Whether this is a cursor event. Undefined for a blank
-     *     event.
-     * @param opt_oldNode The old node the marker used to be on.
-     *    Undefined for a blank event.
-     * @param opt_newNode The new node the marker is now on.
-     *    Undefined for a blank event.
-     */
-    constructor(opt_block?: Block | null, isCursor?: boolean, opt_oldNode?: ASTNode | null, opt_newNode?: ASTNode);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): MarkerMoveJson;
-    /**
-     * Deserializes the JSON event.
-     *
-     * @param event The event to append new properties to. Should be a subclass
-     *     of MarkerMove, but we can't specify that due to the fact that
-     *     parameters to static methods in subclasses must be supertypes of
-     *     parameters to static methods in superclasses.
-     * @internal
-     */
-    static fromJson(json: MarkerMoveJson, workspace: Workspace, event?: any): MarkerMove;
-}
-export interface MarkerMoveJson extends AbstractEventJson {
-    isCursor: boolean;
-    blockId?: string;
-    oldNode?: ASTNode;
-    newNode: ASTNode;
-}
-//# sourceMappingURL=events_marker_move.d.ts.map

package/core/interfaces/i_ast_node_location.d.ts

@@ -1,11 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * An AST node location interface.
- */
-export interface IASTNodeLocation {
-}
-//# sourceMappingURL=i_ast_node_location.d.ts.map

package/core/interfaces/i_ast_node_location_svg.d.ts

@@ -1,12 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { IASTNodeLocation } from './i_ast_node_location.js';
-/**
- * An AST node location SVG interface.
- */
-export interface IASTNodeLocationSvg extends IASTNodeLocation {
-}
-//# sourceMappingURL=i_ast_node_location_svg.d.ts.map

package/core/interfaces/i_ast_node_location_with_block.d.ts

@@ -1,19 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Block } from '../block.js';
-import type { IASTNodeLocation } from './i_ast_node_location.js';
-/**
- * An AST node location that has an associated block.
- */
-export interface IASTNodeLocationWithBlock extends IASTNodeLocation {
-    /**
-     * Get the source block associated with this node.
-     *
-     * @returns The source block.
-     */
-    getSourceBlock(): Block | null;
-}
-//# sourceMappingURL=i_ast_node_location_with_block.d.ts.map

package/core/interfaces/i_navigable.d.ts

@@ -1,30 +0,0 @@
-/**
- * @license
- * Copyright 2025 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Represents a UI element which can be navigated to using the keyboard.
- */
-export interface INavigable<T> {
-    /**
-     * Returns whether or not this specific instance should be reachable via
-     * keyboard navigation.
-     *
-     * Implementors should generally return true, unless there are circumstances
-     * under which this item should be skipped while using keyboard navigation.
-     * Common examples might include being disabled, invalid, readonly, or purely
-     * a visual decoration. For example, while Fields are navigable, non-editable
-     * fields return false, since they cannot be interacted with when focused.
-     *
-     * @returns True if this element should be included in keyboard navigation.
-     */
-    isNavigable(): boolean;
-    /**
-     * Returns the class of this instance.
-     *
-     * @returns This object's class.
-     */
-    getClass(): new (...args: any) => T;
-}
-//# sourceMappingURL=i_navigable.d.ts.map

package/core/keyboard_nav/ast_node.d.ts

@@ -1,185 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * The class representing an AST node.
- * Used to traverse the Blockly AST.
- *
- * @class
- */
-import { Block } from '../block.js';
-import type { Connection } from '../connection.js';
-import type { Field } from '../field.js';
-import { FlyoutButton } from '../flyout_button.js';
-import type { Input } from '../inputs/input.js';
-import type { IASTNodeLocation } from '../interfaces/i_ast_node_location.js';
-import { Coordinate } from '../utils/coordinate.js';
-import type { Workspace } from '../workspace.js';
-/**
- * Class for an AST node.
- * It is recommended that you use one of the createNode methods instead of
- * creating a node directly.
- */
-export declare class ASTNode {
-    /**
-     * True to navigate to all fields. False to only navigate to clickable fields.
-     */
-    static NAVIGATE_ALL_FIELDS: boolean;
-    /**
-     * The default y offset to use when moving the cursor from a stack to the
-     * workspace.
-     */
-    private static readonly DEFAULT_OFFSET_Y;
-    private readonly type;
-    private readonly isConnectionLocation;
-    private readonly location;
-    /** The coordinate on the workspace. */
-    private wsCoordinate;
-    /**
-     * @param type The type of the location.
-     *     Must be in ASTNode.types.
-     * @param location The position in the AST.
-     * @param opt_params Optional dictionary of options.
-     */
-    constructor(type: string, location: IASTNodeLocation, opt_params?: Params);
-    /**
-     * Parse the optional parameters.
-     *
-     * @param params The user specified parameters.
-     */
-    private processParams;
-    /**
-     * Gets the value pointed to by this node.
-     * It is the callers responsibility to check the node type to figure out what
-     * type of object they get back from this.
-     *
-     * @returns The current field, connection, workspace, or block the cursor is
-     *     on.
-     */
-    getLocation(): IASTNodeLocation;
-    /**
-     * The type of the current location.
-     * One of ASTNode.types
-     *
-     * @returns The type of the location.
-     */
-    getType(): string;
-    /**
-     * The coordinate on the workspace.
-     *
-     * @returns The workspace coordinate or null if the location is not a
-     *     workspace.
-     */
-    getWsCoordinate(): Coordinate | null;
-    /**
-     * Whether the node points to a connection.
-     *
-     * @returns [description]
-     * @internal
-     */
-    isConnection(): boolean;
-    private getVisibleInputs;
-    /**
-     * Finds the source block of the location of this node.
-     *
-     * @returns The source block of the location, or null if the node is of type
-     *     workspace or button.
-     */
-    getSourceBlock(): Block | null;
-    /**
-     * Whether an AST node of the given type points to a connection.
-     *
-     * @param type The type to check.  One of ASTNode.types.
-     * @returns True if a node of the given type points to a connection.
-     */
-    private static isConnectionType;
-    /**
-     * Create an AST node pointing to a field.
-     *
-     * @param field The location of the AST node.
-     * @returns An AST node pointing to a field.
-     */
-    static createFieldNode(field: Field): ASTNode;
-    /**
-     * Creates an AST node pointing to a connection. If the connection has a
-     * parent input then create an AST node of type input that will hold the
-     * connection.
-     *
-     * @param connection This is the connection the node will point to.
-     * @returns An AST node pointing to a connection.
-     */
-    static createConnectionNode(connection: Connection): ASTNode | null;
-    /**
-     * Creates an AST node pointing to an input. Stores the input connection as
-     * the location.
-     *
-     * @param input The input used to create an AST node.
-     * @returns An AST node pointing to a input.
-     */
-    static createInputNode(input: Input): ASTNode | null;
-    /**
-     * Creates an AST node pointing to a block.
-     *
-     * @param block The block used to create an AST node.
-     * @returns An AST node pointing to a block.
-     */
-    static createBlockNode(block: Block): ASTNode;
-    /**
-     * Create an AST node of type stack. A stack, represented by its top block, is
-     *     the set of all blocks connected to a top block, including the top
-     * block.
-     *
-     * @param topBlock A top block has no parent and can be found in the list
-     *     returned by workspace.getTopBlocks().
-     * @returns An AST node of type stack that points to the top block on the
-     *     stack.
-     */
-    static createStackNode(topBlock: Block): ASTNode;
-    /**
-     * Create an AST node of type button. A button in this case refers
-     * specifically to a button in a flyout.
-     *
-     * @param button A top block has no parent and can be found in the list
-     *     returned by workspace.getTopBlocks().
-     * @returns An AST node of type stack that points to the top block on the
-     *     stack.
-     */
-    static createButtonNode(button: FlyoutButton): ASTNode;
-    /**
-     * Creates an AST node pointing to a workspace.
-     *
-     * @param workspace The workspace that we are on.
-     * @param wsCoordinate The position on the workspace for this node.
-     * @returns An AST node pointing to a workspace and a position on the
-     *     workspace.
-     */
-    static createWorkspaceNode(workspace: Workspace, wsCoordinate: Coordinate): ASTNode;
-    /**
-     * Creates an AST node for the top position on a block.
-     * This is either an output connection, previous connection, or block.
-     *
-     * @param block The block to find the top most AST node on.
-     * @returns The AST node holding the top most position on the block.
-     */
-    static createTopNode(block: Block): ASTNode | null;
-}
-export declare namespace ASTNode {
-    interface Params {
-        wsCoordinate: Coordinate;
-    }
-    enum types {
-        FIELD = "field",
-        BLOCK = "block",
-        INPUT = "input",
-        OUTPUT = "output",
-        NEXT = "next",
-        PREVIOUS = "previous",
-        STACK = "stack",
-        WORKSPACE = "workspace",
-        BUTTON = "button"
-    }
-}
-export type Params = ASTNode.Params;
-//# sourceMappingURL=ast_node.d.ts.map