blockly 10.2.0-beta.1 → 10.2.0-beta.3

package/core/generator.d.ts

@@ -3,6 +3,12 @@
  * Copyright 2012 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Utility functions for generating executable code from
+ * Blockly code.
+ *
+ * @class
+ */
 import type { Block } from './block.js';
 import { Names } from './names.js';
 import type { Workspace } from './workspace.js';
@@ -85,7 +91,7 @@ export declare class CodeGenerator {
         [key: string]: string;
     };
     /** A database of variable and procedure names. */
-    protected nameDB_?: Names;
+    nameDB_?: Names;
     /** @param name Language name of this generator. */
     constructor(name: string);
     /**
@@ -192,6 +198,28 @@ export declare class CodeGenerator {
      *     desiredName if the former has already been taken by the user.
      */
     provideFunction_(desiredName: string, code: string[] | string): string;
+    /**
+     * Gets a unique, legal name for a user-defined variable.
+     * Before calling this method, the `nameDB_` property of the class
+     * must have been initialized already. This is typically done in
+     * the `init` function of the code generator class.
+     *
+     * @param nameOrId The ID of the variable to get a name for,
+     *    or the proposed name for a variable not associated with an id.
+     * @returns A unique, legal name for the variable.
+     */
+    getVariableName(nameOrId: string): string;
+    /**
+     * Gets a unique, legal name for a user-defined procedure.
+     * Before calling this method, the `nameDB_` property of the class
+     * must have been initialized already. This is typically done in
+     * the `init` function of the code generator class.
+     *
+     * @param name The proposed name for a procedure.
+     * @returns A unique, legal name for the procedure.
+     */
+    getProcedureName(name: string): string;
+    private getName;
     /**
      * Hook for code to run before code generation starts.
      * Subclasses may override this, e.g. to initialise the database of variable

package/core/gesture.d.ts

@@ -3,6 +3,12 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * The class representing an in-progress gesture, e.g. a drag,
+ * tap, or pinch to zoom.
+ *
+ * @class
+ */
 import './events/events_click.js';
 import type { BlockSvg } from './block_svg.js';
 import { BubbleDragger } from './bubble_dragger.js';

package/core/icons/mutator_icon.d.ts

@@ -35,6 +35,14 @@ export declare class MutatorIcon extends Icon implements IHasBubble {
     private rootBlock;
     /** The PID tracking updating the workkspace in response to user events. */
     private updateWorkspacePid;
+    /**
+     * The change listener in the main workspace that triggers the saveConnections
+     * method when anything in the main workspace changes.
+     *
+     * Only actually registered to listen for events while the mutator bubble is
+     * open.
+     */
+    private saveConnectionsListener;
     constructor(flyoutBlockTypes: string[], sourceBlock: BlockSvg);
     getType(): IconType<MutatorIcon>;
     initView(pointerdownListener: (e: PointerEvent) => void): void;

package/core/inputs/input.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2012 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing an input (value, statement, or dummy).
+ *
+ * @class
+ */
 import '../field_label.js';
 import type { Block } from '../block.js';
 import type { BlockSvg } from '../block_svg.js';

package/core/keyboard_nav/ast_node.d.ts

@@ -3,6 +3,12 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * The class representing an AST node.
+ * Used to traverse the Blockly AST.
+ *
+ * @class
+ */
 import type { Block } from '../block.js';
 import type { Connection } from '../connection.js';
 import type { Field } from '../field.js';

package/core/keyboard_nav/marker.d.ts

@@ -3,6 +3,12 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * The class representing a marker.
+ * Used primarily for keyboard navigation to show a marked location.
+ *
+ * @class
+ */
 import type { MarkerSvg } from '../renderers/common/marker_svg.js';
 import type { ASTNode } from './ast_node.js';
 /**

package/core/main.d.ts

@@ -1,5 +1,7 @@
-declare const Blockly: any;
-declare const Msg: any;
-declare const colour: any;
-declare const deprecation: any;
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};
 //# sourceMappingURL=main.d.ts.map

package/core/marker_manager.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object in charge of managing markers and the cursor.
+ *
+ * @class
+ */
 import type { Cursor } from './keyboard_nav/cursor.js';
 import type { Marker } from './keyboard_nav/marker.js';
 import type { WorkspaceSvg } from './workspace_svg.js';

package/core/menuitem.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Blockly menu item similar to Closure's goog.ui.MenuItem
+ *
+ * @class
+ */
 import * as aria from './utils/aria.js';
 /**
  * Class representing an item in a menu.

package/core/metrics_manager.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Calculates and reports workspace metrics.
+ *
+ * @class
+ */
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { IMetricsManager } from './interfaces/i_metrics_manager.js';
 import type { IToolbox } from './interfaces/i_toolbox.js';

package/core/options.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2016 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object that controls settings for the workspace.
+ *
+ * @class
+ */
 import type { BlocklyOptions } from './blockly_options.js';
 import { Theme } from './theme.js';
 import type { Metrics } from './utils/metrics.js';

package/core/rendered_connection.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2016 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Components for creating connections between blocks.
+ *
+ * @class
+ */
 import type { Block } from './block.js';
 import type { BlockSvg } from './block_svg.js';
 import { Connection } from './connection.js';

package/core/renderers/geras/geras.d.ts

@@ -1,4 +1,9 @@
 /** @file Re-exports of Blockly.geras.* modules. */
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { ConstantProvider } from './constants.js';
 import { Drawer } from './drawer.js';
 import { HighlightConstantProvider } from './highlight_constants.js';

package/core/renderers/minimalist/minimalist.d.ts

@@ -1,4 +1,9 @@
 /** @file Re-exports of Blockly.minimalist.* modules. */
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { ConstantProvider } from './constants.js';
 import { Drawer } from './drawer.js';
 import { RenderInfo } from './info.js';

package/core/renderers/thrasos/thrasos.d.ts

@@ -1,4 +1,9 @@
 /** @file Re-exports of Blockly.thrasos.* modules. */
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { RenderInfo } from './info.js';
 import { Renderer } from './renderer.js';
 export { Renderer, RenderInfo };

package/core/renderers/zelos/zelos.d.ts

@@ -1,4 +1,9 @@
 /** @file Re-exports of Blockly.zelos.* modules. */
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { ConstantProvider } from './constants.js';
 import { Drawer } from './drawer.js';
 import { RenderInfo } from './info.js';

package/core/scrollbar.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2011 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing a scrollbar.
+ *
+ * @class
+ */
 import * as browserEvents from './browser_events.js';
 import { Coordinate } from './utils/coordinate.js';
 import type { Metrics } from './utils/metrics.js';

package/core/serialization.d.ts

@@ -3,6 +3,9 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Serialization methods.
+ */
 import * as blocks from './serialization/blocks.js';
 import * as exceptions from './serialization/exceptions.js';
 import * as priorities from './serialization/priorities.js';

package/core/shortcut_registry.d.ts

@@ -3,6 +3,12 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * The namespace used to keep track of keyboard shortcuts and the
+ * key codes used to execute those shortcuts.
+ *
+ * @class
+ */
 import { KeyCodes } from './utils/keycodes.js';
 import { WorkspaceSvg } from './workspace_svg.js';
 /**

package/core/theme_manager.d.ts

@@ -3,6 +3,12 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object in charge of storing and updating a workspace theme
+ *     and UI components.
+ *
+ * @class
+ */
 import type { Theme } from './theme.js';
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';

package/core/toolbox/collapsible_category.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * A toolbox category used to organize blocks in the toolbox.
+ *
+ * @class
+ */
 import type { ICollapsibleToolboxItem } from '../interfaces/i_collapsible_toolbox_item.js';
 import type { IToolbox } from '../interfaces/i_toolbox.js';
 import type { IToolboxItem } from '../interfaces/i_toolbox_item.js';

package/core/toolbox/toolbox.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Toolbox from whence to create blocks.
+ *
+ * @class
+ */
 import '../events/events_toolbox_item_select.js';
 import * as browserEvents from '../browser_events.js';
 import { DeleteArea } from '../delete_area.js';

package/core/toolbox/toolbox_item.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * An item in the toolbox.
+ *
+ * @class
+ */
 import type { ICollapsibleToolboxItem } from '../interfaces/i_collapsible_toolbox_item.js';
 import type { IToolbox } from '../interfaces/i_toolbox.js';
 import type { IToolboxItem } from '../interfaces/i_toolbox_item.js';

package/core/trashcan.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2011 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing a trash can icon.
+ *
+ * @class
+ */
 import './events/events_trashcan_open.js';
 import { DeleteArea } from './delete_area.js';
 import type { IAutoHideable } from './interfaces/i_autohideable.js';

package/core/utils/coordinate.d.ts

@@ -3,6 +3,13 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Utility methods for coordinate manipulation.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ *
+ * @class
+ */
 /**
  * Class for representing coordinates and positions.
  */

package/core/utils/rect.d.ts

@@ -3,6 +3,13 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Utility methods for rectangle manipulation.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ *
+ * @class
+ */
 /**
  * Class for representing rectangular regions.
  */

package/core/utils/size.d.ts

@@ -3,6 +3,13 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Utility methods for size calculation.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ *
+ * @class
+ */
 /**
  * Class for representing sizes consisting of a width and height.
  */

package/core/utils/svg.d.ts

@@ -3,6 +3,12 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Defines the Svg class. Its constants enumerate
+ * all SVG tag names used by Blockly.
+ *
+ * @class
+ */
 /**
  * A name with the type of the SVG element stored in the generic.
  */

package/core/variable_map.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing a map of variables and their types.
+ *
+ * @class
+ */
 import './events/events_var_delete.js';
 import './events/events_var_rename.js';
 import type { Block } from './block.js';

package/core/variable_model.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Components for the variable model.
+ *
+ * @class
+ */
 import './events/events_var_create.js';
 import type { Workspace } from './workspace.js';
 /**

package/core/workspace.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2012 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing a workspace.
+ *
+ * @class
+ */
 import './connection_checker.js';
 import type { Block } from './block.js';
 import type { ConnectionDB } from './connection_db.js';
@@ -122,7 +127,7 @@ export declare class Workspace implements IASTNodeLocation {
      * @param ordered Sort the list if true.
      * @returns The top-level block objects.
      */
-    getTopBlocks(ordered: boolean): Block[];
+    getTopBlocks(ordered?: boolean): Block[];
     /**
      * Add a block to the list of blocks keyed by type.
      *
@@ -143,7 +148,7 @@ export declare class Workspace implements IASTNodeLocation {
      * @param ordered Sort the list if true.
      * @returns The blocks of the given type.
      */
-    getBlocksByType(type: string, ordered: boolean): Block[];
+    getBlocksByType(type: string, ordered?: boolean): Block[];
     /**
      * Adds a comment to the list of top comments.
      *
@@ -166,7 +171,7 @@ export declare class Workspace implements IASTNodeLocation {
      * @returns The top-level comment objects.
      * @internal
      */
-    getTopComments(ordered: boolean): WorkspaceComment[];
+    getTopComments(ordered?: boolean): WorkspaceComment[];
     /**
      * Find all blocks in workspace.  Blocks are optionally sorted
      * by position; top to bottom (with slight LTR or RTL bias).
@@ -174,7 +179,7 @@ export declare class Workspace implements IASTNodeLocation {
      * @param ordered Sort the list if true.
      * @returns Array of blocks.
      */
-    getAllBlocks(ordered: boolean): Block[];
+    getAllBlocks(ordered?: boolean): Block[];
     /** Dispose of all blocks and comments in workspace. */
     clear(): void;
     /**

package/core/workspace_comment_svg.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing a code comment on a rendered workspace.
+ *
+ * @class
+ */
 import './events/events_selected.js';
 import type { IBoundedElement } from './interfaces/i_bounded_element.js';
 import type { IBubble } from './interfaces/i_bubble.js';

package/core/workspace_svg.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2014 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing a workspace rendered as SVG.
+ *
+ * @class
+ */
 import './events/events_block_create.js';
 import './events/events_theme_change.js';
 import './events/events_viewport.js';
@@ -384,6 +389,12 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * @internal
      */
     getInjectionDiv(): Element;
+    /**
+     * Returns the SVG group for the workspace.
+     *
+     * @returns The SVG group for the workspace.
+     */
+    getSvgGroup(): Element;
     /**
      * Get the SVG block canvas for the workspace.
      *
@@ -802,7 +813,7 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * @param ordered Sort the list if true.
      * @returns Array of blocks.
      */
-    getAllBlocks(ordered: boolean): BlockSvg[];
+    getAllBlocks(ordered?: boolean): BlockSvg[];
     /**
      * Finds the top-level blocks and returns them.  Blocks are optionally sorted
      * by position; top to bottom (with slight LTR or RTL bias).
@@ -810,7 +821,7 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * @param ordered Sort the list if true.
      * @returns The top-level block objects.
      */
-    getTopBlocks(ordered: boolean): BlockSvg[];
+    getTopBlocks(ordered?: boolean): BlockSvg[];
     /**
      * Adds a block to the list of top blocks.
      *

package/core/zoom_controls.d.ts

@@ -3,6 +3,11 @@
  * Copyright 2015 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Object representing a zoom icons.
+ *
+ * @class
+ */
 import './events/events_click.js';
 import type { IPositionable } from './interfaces/i_positionable.js';
 import type { UiMetrics } from './metrics_manager.js';