blockly 11.0.0-beta.9 → 11.0.0

package/core/block.d.ts

@@ -320,6 +320,12 @@ export declare class Block implements IASTNodeLocation {
      * @internal
      */
     getTopStackBlock(): this;
+    /**
+     * Returns this block if it is a shadow block, or the first non-shadow parent.
+     *
+     * @internal
+     */
+    getFirstNonShadowBlock(): this;
     /**
      * Find all the blocks that are directly nested inside this one.
      * Includes value and statement inputs, as well as any following statement.

package/core/clipboard/block_paster.d.ts

@@ -20,9 +20,11 @@ export declare class BlockPaster implements IPaster<BlockCopyData, BlockSvg> {
  * Exported for testing.
  *
  * @param block The block to move to an unambiguous location.
+ * @param originalPosition The initial coordinate to start searching from,
+ *    likely the position of the copied block.
  * @internal
  */
-export declare function moveBlockToNotConflict(block: BlockSvg): void;
+export declare function moveBlockToNotConflict(block: BlockSvg, originalPosition: Coordinate): void;
 export interface BlockCopyData extends ICopyData {
     blockState: State;
     typeCounts: {

package/core/comments/comment_view.d.ts

@@ -83,7 +83,10 @@ export declare class CommentView implements IRenderedElement {
     private createResizeHandle;
     /** Returns the root SVG group element of the comment view. */
     getSvgRoot(): SVGGElement;
-    /** Returns the current size of the comment in workspace units. */
+    /**
+     * Returns the current size of the comment in workspace units.
+     * Respects collapsing.
+     */
     getSize(): Size;
     /**
      * Sets the size of the comment in workspace units, and updates the view

package/core/comments/rendered_workspace_comment.d.ts

@@ -38,7 +38,15 @@ export declare class RenderedWorkspaceComment extends WorkspaceComment implement
     setEditable(editable: boolean): void;
     /** Returns the root SVG element of this comment. */
     getSvgRoot(): SVGElement;
-    /** Returns the bounding rectangle of this comment in workspace coordinates. */
+    /**
+     * Returns the comment's size in workspace units.
+     * Does not respect collapsing.
+     */
+    getSize(): Size;
+    /**
+     * Returns the bounding rectangle of this comment in workspace coordinates.
+     * Respects collapsing.
+     */
     getBoundingRectangle(): Rect;
     /** Move the comment by the given amounts in workspace coordinates. */
     moveBy(dx: number, dy: number, reason?: string[] | undefined): void;
@@ -86,5 +94,7 @@ export declare class RenderedWorkspaceComment extends WorkspaceComment implement
     toCopyData(): WorkspaceCommentCopyData | null;
     /** Show a context menu for this comment. */
     showContextMenu(e: PointerEvent): void;
+    /** Snap this comment to the nearest grid point. */
+    snapToGrid(): void;
 }
 //# sourceMappingURL=rendered_workspace_comment.d.ts.map

package/core/dragging/block_drag_strategy.d.ts

@@ -20,11 +20,6 @@ export declare class BlockDragStrategy implements IDragStrategy {
     private connectionCandidate;
     private connectionPreviewer;
     private dragging;
-    /**
-     * If this is a shadow block, the offset between this block and the parent
-     * block, to add to the drag location. In workspace units.
-     */
-    private dragOffset;
     constructor(block: BlockSvg);
     /** Returns true if the block is currently movable. False otherwise. */
     isMovable(): boolean;
@@ -33,8 +28,6 @@ export declare class BlockDragStrategy implements IDragStrategy {
      * from any parent blocks.
      */
     startDrag(e?: PointerEvent): void;
-    /** Starts a drag on a shadow, recording the drag offset. */
-    private startDraggingShadow;
     /**
      * Whether or not we should disconnect the block when a drag is started.
      *
@@ -93,7 +86,7 @@ export declare class BlockDragStrategy implements IDragStrategy {
      * Cleans up any state at the end of the drag. Applies any pending
      * connections.
      */
-    endDrag(e?: PointerEvent): void;
+    endDrag(): void;
     /** Connects the given candidate connections. */
     private applyConnections;
     /**

package/core/field.d.ts

@@ -561,6 +561,7 @@ export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IAS
      *
      * @param newValue New value.
      * @param validatedValue Validated value.
+     * @param fireChangeEvent Whether to fire a change event if the value changes.
      * @returns New value, or an Error object.
      */
     private processValidation_;
@@ -605,8 +606,9 @@ export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IAS
      * No-op by default.
      *
      * @param _invalidValue The input value that was determined to be invalid.
+     * @param _fireChangeEvent Whether to fire a change event if the value changes.
      */
-    protected doValueInvalid_(_invalidValue: any): void;
+    protected doValueInvalid_(_invalidValue: any, _fireChangeEvent?: boolean): void;
     /**
      * Handle a pointerdown event on a field.
      *
@@ -706,6 +708,17 @@ export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IAS
      * @internal
      */
     updateMarkers_(): void;
+    /**
+     * Subclasses should reimplement this method to construct their Field
+     * subclass from a JSON arg object.
+     *
+     * It is an error to attempt to register a field subclass in the
+     * FieldRegistry if that subclass has not overridden this method.
+     *
+     * @param _options JSON configuration object with properties needed
+     *    to configure a specific field.
+     */
+    static fromJson(_options: FieldConfig): Field;
 }
 /**
  * Extra configuration options for the base field.
@@ -714,12 +727,14 @@ export interface FieldConfig {
     tooltip?: string;
 }
 /**
- * For use by Field and descendants of Field. Constructors can change
+ * Represents an object that has all the prototype properties of the `Field`
+ * class. This is necessary because constructors can change
  * in descendants, though they should contain all of Field's prototype methods.
  *
- * @internal
+ * This type should only be used in places where we directly access the prototype
+ * of a Field class or subclass.
  */
-export type FieldProto = Pick<typeof Field, 'prototype'>;
+type FieldProto = Pick<typeof Field, 'prototype'>;
 /**
  * Represents an error where the field is trying to access its block or
  * information about its block before it has actually been attached to said
@@ -729,4 +744,5 @@ export declare class UnattachedFieldError extends Error {
     /** @internal */
     constructor();
 }
+export {};
 //# sourceMappingURL=field.d.ts.map

package/core/field_input.d.ts

@@ -88,10 +88,11 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<str
      * value while allowing the display text to be handled by the htmlInput_.
      *
      * @param _invalidValue The input value that was determined to be invalid.
-     *    This is not used by the text input because its display value is stored
-     * on the htmlInput_.
+     *     This is not used by the text input because its display value is stored
+     *     on the htmlInput_.
+     * @param fireChangeEvent Whether to fire a change event if the value changes.
      */
-    protected doValueInvalid_(_invalidValue: any): void;
+    protected doValueInvalid_(_invalidValue: any, fireChangeEvent?: boolean): void;
     /**
      * Called by setValue if the text input is valid. Updates the value of the
      * field, and updates the text of the field if it is not currently being

package/core/field_registry.d.ts

@@ -3,10 +3,42 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Field, FieldProto } from './field.js';
-interface RegistryOptions {
+import type { Field, FieldConfig } from './field.js';
+/**
+ * When constructing a field from JSON using the registry, the
+ * `fromJson` method in this file is called with an options parameter
+ * object consisting of the "type" which is the name of the field, and
+ * other options that are part of the field's config object.
+ *
+ * These options are then passed to the field's static `fromJson`
+ * method. That method accepts an options parameter with a type that usually
+ * extends from FieldConfig, and may or may not have a "type" attribute (in
+ * fact, it shouldn't, because we'd overwrite it as described above!)
+ *
+ * Unfortunately the registry has no way of knowing the actual Field subclass
+ * that will be returned from passing in the name of the field. Therefore it
+ * also has no way of knowing that the options object not only implements
+ * `FieldConfig`, but it also should satisfy the Config that belongs to that
+ * specific class's `fromJson` method.
+ *
+ * Because of this uncertainty, we just give up on type checking the properties
+ * passed to the `fromJson` method, and allow arbitrary string keys with
+ * unknown types.
+ */
+type RegistryOptions = FieldConfig & {
     type: string;
     [key: string]: unknown;
+};
+/**
+ * Represents the static methods that must be defined on any
+ * field that is registered, i.e. the constructor and fromJson methods.
+ *
+ * Because we don't know which Field subclass will be registered, we
+ * are unable to typecheck the parameters of the constructor.
+ */
+export interface RegistrableField {
+    new (...args: any[]): Field;
+    fromJson(options: FieldConfig): Field;
 }
 /**
  * Registers a field type.
@@ -19,7 +51,7 @@ interface RegistryOptions {
  * @throws {Error} if the type name is empty, the field is already registered,
  *     or the fieldClass is not an object containing a fromJson function.
  */
-export declare function register(type: string, fieldClass: FieldProto): void;
+export declare function register(type: string, fieldClass: RegistrableField): void;
 /**
  * Unregisters the field registered with the given type.
  *

package/core/flyout_base.d.ts

@@ -8,6 +8,7 @@ import { DeleteArea } from './delete_area.js';
 import { FlyoutButton } from './flyout_button.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { Options } from './options.js';
+import * as blocks from './serialization/blocks.js';
 import { Coordinate } from './utils/coordinate.js';
 import { Svg } from './utils/svg.js';
 import * as toolbox from './utils/toolbox.js';
@@ -505,6 +506,13 @@ export declare abstract class Flyout extends DeleteArea implements IAutoHideable
      * @returns The new block in the main workspace.
      */
     private placeNewBlock;
+    /**
+     * Serialize a block to JSON.
+     *
+     * @param block The block to serialize.
+     * @returns A serialized representation of the block.
+     */
+    protected serializeBlock(block: BlockSvg): blocks.State;
     /**
      * Positions a block on the target workspace.
      *

package/core/grid.d.ts

@@ -3,6 +3,7 @@
  * Copyright 2017 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { Coordinate } from './utils/coordinate.js';
 import { GridOptions } from './options.js';
 /**
  * Class for a workspace's grid.
@@ -92,6 +93,14 @@ export declare class Grid {
      * @internal
      */
     moveTo(x: number, y: number): void;
+    /**
+     * Given a coordinate, return the nearest coordinate aligned to the grid.
+     *
+     * @param xy A workspace coordinate.
+     * @returns Workspace coordinate of nearest grid point.
+     *   If there's no change, return the same coordinate object.
+     */
+    alignXY(xy: Coordinate): Coordinate;
     /**
      * Create the DOM for the grid described by options.
      *

package/core/interfaces/i_flyout.d.ts

@@ -9,6 +9,7 @@ import type { Coordinate } from '../utils/coordinate.js';
 import type { FlyoutDefinition } from '../utils/toolbox.js';
 import type { Svg } from '../utils/svg.js';
 import type { IRegistrable } from './i_registrable.js';
+import { FlyoutItem } from '../flyout_base.js';
 /**
  * Interface for a flyout.
  */
@@ -94,6 +95,15 @@ export interface IFlyout extends IRegistrable {
      *     of the dynamic category.
      */
     show(flyoutDef: FlyoutDefinition | string): void;
+    /**
+     * Returns the list of flyout items currently present in the flyout.
+     * The `show` method parses the flyout definition into a list of actual
+     * flyout items. This method should return those concrete items, which
+     * may be used for e.g. keyboard navigation.
+     *
+     * @returns List of flyout items.
+     */
+    getContents(): FlyoutItem[];
     /**
      * Create a copy of this block on the workspace.
      *

package/core/keyboard_nav/ast_node.d.ts

@@ -9,7 +9,7 @@
  *
  * @class
  */
-import type { Block } from '../block.js';
+import { Block } from '../block.js';
 import type { Connection } from '../connection.js';
 import type { Field } from '../field.js';
 import type { Input } from '../inputs/input.js';
@@ -127,6 +127,15 @@ export declare class ASTNode {
      * @returns The next button, or next stack's first block, or null
      */
     private navigateFlyoutContents;
+    /**
+     * Finds the next (or previous if navigating backward) item in the flyout that should be navigated to.
+     *
+     * @param flyoutContents Contents of the current flyout.
+     * @param currentLocation Current ASTNode location.
+     * @param forward True if we're navigating forward, else false.
+     * @returns The next (or previous) FlyoutItem, or null if there is none.
+     */
+    private findNextLocationInFlyout;
     /**
      * Finds the top most AST node for a given block.
      * This is either the previous connection, output connection or block

package/core/layer_manager.d.ts

@@ -11,11 +11,22 @@ export declare class LayerManager {
     private workspace;
     /** The layer elements being dragged are appended to. */
     private dragLayer;
+    /** The layer elements being animated are appended to. */
+    private animationLayer;
     /** The layers elements not being dragged are appended to.  */
     private layers;
     /** @internal */
     constructor(workspace: WorkspaceSvg);
     private createDragLayer;
+    private createAnimationLayer;
+    /**
+     * Appends the element to the animation layer. The animation layer doesn't
+     * move when the workspace moves, so e.g. delete animations don't move
+     * when a block delete triggers a workspace resize.
+     *
+     * @internal
+     */
+    appendToAnimationLayer(elem: IRenderedElement): void;
     /**
      * Translates layers when the workspace is dragged or zoomed.
      *

package/core.js

@@ -0,0 +1,4 @@
+// Shim for backwards-compatibility with bundlers that do not
+// support the 'exports' clause in package.json, to allow them
+// to load the blockly/core submodule entrypoint.
+module.exports = require('./blockly_compressed.js');

package/dart.js

@@ -0,0 +1,4 @@
+// Shim for backwards-compatibility with bundlers that do not
+// support the 'exports' clause in package.json, to allow them
+// to load the blockly/dart submodule entrypoint.
+module.exports = require('./dart_compressed.js');

package/dart.mjs

@@ -0,0 +1,6 @@
+import dart from './dart_compressed.js';
+export const {
+  DartGenerator,
+  Order,
+  dartGenerator,
+} = dart;

package/index.mjs

@@ -0,0 +1,143 @@
+import Blockly from './index.js';
+export const {
+  ASTNode,
+  BasicCursor,
+  Block,
+  BlockSvg,
+  Blocks,
+  COLLAPSED_FIELD_NAME,
+  COLLAPSED_INPUT_NAME,
+  COLLAPSE_CHARS,
+  CodeGenerator,
+  CollapsibleToolboxCategory,
+  ComponentManager,
+  Connection,
+  ConnectionChecker,
+  ConnectionDB,
+  ConnectionType,
+  ContextMenu,
+  ContextMenuItems,
+  ContextMenuRegistry,
+  Css,
+  Cursor,
+  DELETE_VARIABLE_ID,
+  DeleteArea,
+  DragTarget,
+  DropDownDiv,
+  Events,
+  Extensions,
+  Field,
+  FieldCheckbox,
+  FieldDropdown,
+  FieldImage,
+  FieldLabel,
+  FieldLabelSerializable,
+  FieldNumber,
+  FieldTextInput,
+  FieldVariable,
+  Flyout,
+  FlyoutButton,
+  FlyoutMetricsManager,
+  Generator,
+  Gesture,
+  Grid,
+  HorizontalFlyout,
+  INPUT_VALUE,
+  Input,
+  InsertionMarkerManager,
+  InsertionMarkerPreviewer,
+  Marker,
+  MarkerManager,
+  Menu,
+  MenuItem,
+  MetricsManager,
+  Msg,
+  NEXT_STATEMENT,
+  Names,
+  OPPOSITE_TYPE,
+  OUTPUT_VALUE,
+  Options,
+  PREVIOUS_STATEMENT,
+  PROCEDURE_CATEGORY_NAME,
+  Procedures,
+  RENAME_VARIABLE_ID,
+  RenderedConnection,
+  Scrollbar,
+  ScrollbarPair,
+  ShortcutItems,
+  ShortcutRegistry,
+  TOOLBOX_AT_BOTTOM,
+  TOOLBOX_AT_LEFT,
+  TOOLBOX_AT_RIGHT,
+  TOOLBOX_AT_TOP,
+  TabNavigateCursor,
+  Theme,
+  ThemeManager,
+  Themes,
+  Toolbox,
+  ToolboxCategory,
+  ToolboxItem,
+  ToolboxSeparator,
+  Tooltip,
+  Touch,
+  Trashcan,
+  UnattachedFieldError,
+  VARIABLE_CATEGORY_NAME,
+  VARIABLE_DYNAMIC_CATEGORY_NAME,
+  VERSION,
+  VariableMap,
+  VariableModel,
+  Variables,
+  VariablesDynamic,
+  VerticalFlyout,
+  WidgetDiv,
+  Workspace,
+  WorkspaceAudio,
+  WorkspaceDragger,
+  WorkspaceSvg,
+  Xml,
+  ZoomControls,
+  blockAnimations,
+  blockRendering,
+  browserEvents,
+  bubbles,
+  bumpObjects,
+  clipboard,
+  comments,
+  common,
+  config,
+  constants,
+  defineBlocksWithJsonArray,
+  dialog,
+  dragging,
+  fieldRegistry,
+  geras,
+  getMainWorkspace,
+  getSelected,
+  hasBubble,
+  hideChaff,
+  icons,
+  inject,
+  inputs,
+  isCopyable,
+  isDeletable,
+  isDraggable,
+  isIcon,
+  isObservable,
+  isPaster,
+  isRenderedElement,
+  isSelectable,
+  isSerializable,
+  isVariableBackedParameterModel,
+  procedures,
+  registry,
+  renderManagement,
+  serialization,
+  setLocale,
+  setParentContainer,
+  svgResize,
+  thrasos,
+  uiPosition,
+  utils,
+  zelos,
+} = Blockly;

package/javascript.js

@@ -0,0 +1,4 @@
+// Shim for backwards-compatibility with bundlers that do not
+// support the 'exports' clause in package.json, to allow them
+// to load the blockly/javascript submodule entrypoint.
+module.exports = require('./javascript_compressed.js');

package/javascript.mjs

@@ -0,0 +1,6 @@
+import javascript from './javascript_compressed.js';
+export const {
+  JavascriptGenerator,
+  Order,
+  javascriptGenerator,
+} = javascript;

package/lua.js

@@ -0,0 +1,4 @@
+// Shim for backwards-compatibility with bundlers that do not
+// support the 'exports' clause in package.json, to allow them
+// to load the blockly/lua submodule entrypoint.
+module.exports = require('./lua_compressed.js');

package/lua.mjs

@@ -0,0 +1,6 @@
+import lua from './lua_compressed.js';
+export const {
+  LuaGenerator,
+  Order,
+  luaGenerator,
+} = lua;

package/media/resize-handle.svg

@@ -1,3 +1,3 @@
 <svg xmlns="http://www.w3.org/2000/svg" height="8" viewBox="0 0 8 8" width="8" fill="#041E49" stroke="#000">
-<g><line x1="2.6666666666666665" y1="7" x2="7" y2="2.6666666666666665"></line><line x1="5.333333333333333" y1="7" x2="7" y2="5.333333333333333"></line></g>
+<g><line x1="2.67" y1="7" x2="7" y2="2.67"></line><line x1="5.33" y1="7" x2="7" y2="5.33"></line></g>
 </svg>

package/msg/ab.js

@@ -103,6 +103,7 @@ Blockly.Msg["LISTS_GET_INDEX_FROM_END"] = "№ анҵәамнҭа аҟынтәи
 Blockly.Msg["LISTS_GET_INDEX_FROM_START"] = "#";  // untranslated
 Blockly.Msg["LISTS_GET_INDEX_GET"] = "игатәуп";
 Blockly.Msg["LISTS_GET_INDEX_GET_REMOVE"] = "иалхны ианыхтәуп";
+Blockly.Msg["LISTS_GET_INDEX_HELPURL"] = "https://github.com/google/blockly/wiki/Lists#getting-items-from-a-list";  // untranslated
 Blockly.Msg["LISTS_GET_INDEX_LAST"] = "аҵыхәтәантәи";
 Blockly.Msg["LISTS_GET_INDEX_RANDOM"] = "иарбанзаалакь";
 Blockly.Msg["LISTS_GET_INDEX_REMOVE"] = "ианыхтәуп";
@@ -131,7 +132,7 @@ Blockly.Msg["LISTS_GET_SUBLIST_TOOLTIP"] = "Creates a copy of the specified port
 Blockly.Msg["LISTS_INDEX_FROM_END_TOOLTIP"] = "%1 - аҵыхәтәантәи аелемент.";
 Blockly.Msg["LISTS_INDEX_FROM_START_TOOLTIP"] = "%1 - актәи аелемент.";
 Blockly.Msg["LISTS_INDEX_OF_FIRST"] = "find first occurrence of item";  // untranslated
-Blockly.Msg["LISTS_INDEX_OF_HELPURL"] = "https://github.com/google/blockly/wiki/Lists#getting-items-from-a-list";  // untranslated
+Blockly.Msg["LISTS_INDEX_OF_HELPURL"] = "https://github.com/google/blockly/wiki/Lists#finding-items-in-a-list";  // untranslated
 Blockly.Msg["LISTS_INDEX_OF_LAST"] = "find last occurrence of item";  // untranslated
 Blockly.Msg["LISTS_INDEX_OF_TOOLTIP"] = "Returns the index of the first/last occurrence of the item in the list. Returns %1 if item is not found.";  // untranslated
 Blockly.Msg["LISTS_INLIST"] = "ахьӡынҵа аҟны";
@@ -416,7 +417,6 @@ Blockly.Msg["CONTROLS_IF_IF_TITLE_IF"] = Blockly.Msg["CONTROLS_IF_MSG_IF"];
 Blockly.Msg["CONTROLS_IF_MSG_THEN"] = Blockly.Msg["CONTROLS_REPEAT_INPUT_DO"];
 Blockly.Msg["CONTROLS_WHILEUNTIL_INPUT_DO"] = Blockly.Msg["CONTROLS_REPEAT_INPUT_DO"];
 Blockly.Msg["LISTS_CREATE_WITH_ITEM_TITLE"] = Blockly.Msg["VARIABLES_DEFAULT_NAME"];
-Blockly.Msg["LISTS_GET_INDEX_HELPURL"] = Blockly.Msg["LISTS_INDEX_OF_HELPURL"];
 Blockly.Msg["LISTS_GET_INDEX_INPUT_IN_LIST"] = Blockly.Msg["LISTS_INLIST"];
 Blockly.Msg["LISTS_GET_SUBLIST_INPUT_IN_LIST"] = Blockly.Msg["LISTS_INLIST"];
 Blockly.Msg["LISTS_INDEX_OF_INPUT_IN_LIST"] = Blockly.Msg["LISTS_INLIST"];
@@ -429,14 +429,14 @@ Blockly.Msg["PROCEDURES_DEFRETURN_TITLE"] = Blockly.Msg["PROCEDURES_DEFNORETURN_
 Blockly.Msg["TEXT_APPEND_VARIABLE"] = Blockly.Msg["VARIABLES_DEFAULT_NAME"];
 Blockly.Msg["TEXT_CREATE_JOIN_ITEM_TITLE_ITEM"] = Blockly.Msg["VARIABLES_DEFAULT_NAME"];
 
-Blockly.Msg["MATH_HUE"] = "230";
-Blockly.Msg["LOOPS_HUE"] = "120";
+Blockly.Msg["COLOUR_HUE"] = "20";
 Blockly.Msg["LISTS_HUE"] = "260";
 Blockly.Msg["LOGIC_HUE"] = "210";
-Blockly.Msg["VARIABLES_HUE"] = "330";
-Blockly.Msg["TEXTS_HUE"] = "160";
+Blockly.Msg["LOOPS_HUE"] = "120";
+Blockly.Msg["MATH_HUE"] = "230";
 Blockly.Msg["PROCEDURES_HUE"] = "290";
-Blockly.Msg["COLOUR_HUE"] = "20";
+Blockly.Msg["TEXTS_HUE"] = "160";
 Blockly.Msg["VARIABLES_DYNAMIC_HUE"] = "310";
+Blockly.Msg["VARIABLES_HUE"] = "330";
 return Blockly.Msg;
 }));