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

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

@@ -4,7 +4,24 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Measurable } from './base.js';
+import type { BottomRow } from './bottom_row.js';
+import type { ExternalValueInput } from './external_value_input.js';
+import type { Field } from './field.js';
+import type { Hat } from './hat.js';
+import type { Icon } from './icon.js';
+import type { InRowSpacer } from './in_row_spacer.js';
+import type { InlineInput } from './inline_input.js';
+import type { InputConnection } from './input_connection.js';
+import type { InputRow } from './input_row.js';
+import type { JaggedEdge } from './jagged_edge.js';
+import type { NextConnection } from './next_connection.js';
+import type { PreviousConnection } from './previous_connection.js';
+import type { RoundCorner } from './round_corner.js';
 import type { Row } from './row.js';
+import type { SpacerRow } from './spacer_row.js';
+import type { SquareCorner } from './square_corner.js';
+import type { StatementInput } from './statement_input.js';
+import type { TopRow } from './top_row.js';
 /**
  * Types of rendering elements.
  */
@@ -63,77 +80,84 @@ declare class TypesContainer {
      * @param elem The element to check.
      * @returns 1 if the object stores information about a field.
      */
-    isField(elem: Measurable): number;
+    isField(elem: Measurable): elem is Field;
     /**
      * Whether a measurable stores information about a hat.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a hat.
      */
-    isHat(elem: Measurable): number;
+    isHat(elem: Measurable): elem is Hat;
     /**
      * Whether a measurable stores information about an icon.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an icon.
      */
-    isIcon(elem: Measurable): number;
+    isIcon(elem: Measurable): elem is Icon;
     /**
      * Whether a measurable stores information about a spacer.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a spacer.
      */
-    isSpacer(elem: Measurable | Row): number;
+    isSpacer(elem: Measurable | Row): elem is SpacerRow | InRowSpacer;
     /**
      * Whether a measurable stores information about an in-row spacer.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an in-row spacer.
      */
-    isInRowSpacer(elem: Measurable): number;
+    isInRowSpacer(elem: Measurable): elem is InRowSpacer;
+    /**
+     * Whether a row is a spacer row.
+     *
+     * @param row The row to check.
+     * @returns True if the row is a spacer row.
+     */
+    isSpacerRow(row: Row): row is SpacerRow;
     /**
      * Whether a measurable stores information about an input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an input.
      */
-    isInput(elem: Measurable): number;
+    isInput(elem: Measurable): elem is InputConnection;
     /**
      * Whether a measurable stores information about an external input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an external input.
      */
-    isExternalInput(elem: Measurable): number;
+    isExternalInput(elem: Measurable): elem is ExternalValueInput;
     /**
      * Whether a measurable stores information about an inline input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about an inline input.
      */
-    isInlineInput(elem: Measurable): number;
+    isInlineInput(elem: Measurable): elem is InlineInput;
     /**
      * Whether a measurable stores information about a statement input.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a statement input.
      */
-    isStatementInput(elem: Measurable): number;
+    isStatementInput(elem: Measurable): elem is StatementInput;
     /**
      * Whether a measurable stores information about a previous connection.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a previous connection.
      */
-    isPreviousConnection(elem: Measurable): number;
+    isPreviousConnection(elem: Measurable): elem is PreviousConnection;
     /**
      * Whether a measurable stores information about a next connection.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a next connection.
      */
-    isNextConnection(elem: Measurable): number;
+    isNextConnection(elem: Measurable): elem is NextConnection;
     /**
      * Whether a measurable stores information about a previous or next
      * connection.
@@ -142,91 +166,92 @@ declare class TypesContainer {
      * @returns 1 if the object stores information about a previous or next
      *     connection.
      */
-    isPreviousOrNextConnection(elem: Measurable): number;
+    isPreviousOrNextConnection(elem: Measurable): elem is PreviousConnection | NextConnection;
+    isRoundCorner(elem: Measurable): elem is RoundCorner;
     /**
      * Whether a measurable stores information about a left round corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a left round corner.
      */
-    isLeftRoundedCorner(elem: Measurable): number;
+    isLeftRoundedCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a right round corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a right round corner.
      */
-    isRightRoundedCorner(elem: Measurable): number;
+    isRightRoundedCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a left square corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a left square corner.
      */
-    isLeftSquareCorner(elem: Measurable): number;
+    isLeftSquareCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a right square corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a right square corner.
      */
-    isRightSquareCorner(elem: Measurable): number;
+    isRightSquareCorner(elem: Measurable): boolean;
     /**
      * Whether a measurable stores information about a corner.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a corner.
      */
-    isCorner(elem: Measurable): number;
+    isCorner(elem: Measurable): elem is SquareCorner | RoundCorner;
     /**
      * Whether a measurable stores information about a jagged edge.
      *
      * @param elem The element to check.
      * @returns 1 if the object stores information about a jagged edge.
      */
-    isJaggedEdge(elem: Measurable): number;
+    isJaggedEdge(elem: Measurable): elem is JaggedEdge;
     /**
      * Whether a measurable stores information about a row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a row.
      */
-    isRow(row: Row): number;
+    isRow(row: Row): row is Row;
     /**
      * Whether a measurable stores information about a between-row spacer.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a between-row spacer.
      */
-    isBetweenRowSpacer(row: Row): number;
+    isBetweenRowSpacer(row: Row): row is SpacerRow;
     /**
      * Whether a measurable stores information about a top row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a top row.
      */
-    isTopRow(row: Row): number;
+    isTopRow(row: Row): row is TopRow;
     /**
      * Whether a measurable stores information about a bottom row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a bottom row.
      */
-    isBottomRow(row: Row): number;
+    isBottomRow(row: Row): row is BottomRow;
     /**
      * Whether a measurable stores information about a top or bottom row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about a top or bottom row.
      */
-    isTopOrBottomRow(row: Row): number;
+    isTopOrBottomRow(row: Row): row is TopRow | BottomRow;
     /**
      * Whether a measurable stores information about an input row.
      *
      * @param row The row to check.
      * @returns 1 if the object stores information about an input row.
      */
-    isInputRow(row: Row): number;
+    isInputRow(row: Row): row is InputRow;
 }
 export declare const Types: TypesContainer;
 export {};

package/core/separator_flyout_inflater.d.ts

@@ -3,9 +3,13 @@
  * 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';
+/**
+ * @internal
+ */
+export declare const SEPARATOR_TYPE = "sep";
 /**
  * Class responsible for creating separators for flyouts.
  */
@@ -28,7 +32,7 @@ export declare class SeparatorFlyoutInflater implements IFlyoutInflater {
      * @param flyoutWorkspace The workspace the separator belongs to.
      * @returns A newly created FlyoutSeparator.
      */
-    load(_state: object, flyoutWorkspace: WorkspaceSvg): IBoundedElement;
+    load(_state: object, flyoutWorkspace: WorkspaceSvg): FlyoutItem;
     /**
      * Returns the size of the separator. See `load` for more details.
      *
@@ -36,12 +40,18 @@ export declare class SeparatorFlyoutInflater implements IFlyoutInflater {
      * @param defaultGap The default spacing for flyout items.
      * @returns The desired size of the separator.
      */
-    gapForElement(state: object, defaultGap: number): number;
+    gapForItem(state: object, defaultGap: number): number;
     /**
      * Disposes of the given separator. Intentional no-op.
      *
-     * @param _element The flyout separator to dispose of.
+     * @param _item The flyout separator to dispose of.
+     */
+    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.
      */
-    disposeElement(_element: IBoundedElement): void;
+    getType(): string;
 }
 //# sourceMappingURL=separator_flyout_inflater.d.ts.map

package/core/variables.d.ts

@@ -5,6 +5,7 @@
  */
 import type { Block } from './block.js';
 import { IVariableModel, IVariableState } from './interfaces/i_variable_model.js';
+import type { BlockInfo, FlyoutItemInfo } from './utils/toolbox.js';
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
@@ -38,13 +39,26 @@ export declare function allUsedVarModels(ws: Workspace): IVariableModel<IVariabl
  */
 export declare function allDeveloperVariables(workspace: Workspace): string[];
 /**
- * Construct the elements (blocks and button) required by the flyout for the
- * variable category.
+ * Internal wrapper that returns the contents of the variables category.
  *
+ * @internal
+ * @param workspace The workspace to populate variable blocks for.
+ */
+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[];
+/**
+ * Construct the blocks required by the flyout for the variable category.
+ *
+ * @internal
  * @param workspace The workspace containing variables.
- * @returns Array of XML elements.
+ * @param variables List of variables to create blocks for.
+ * @param includeChangeBlocks True to include `change x by _` blocks.
+ * @param getterType The type of the variable getter block to generate.
+ * @param setterType The type of the variable setter block to generate.
+ * @returns JSON list of blocks.
  */
-export declare function flyoutCategory(workspace: WorkspaceSvg): Element[];
+export declare function jsonFlyoutCategoryBlocks(workspace: Workspace, variables: IVariableModel<IVariableState>[], includeChangeBlocks: boolean, getterType?: string, setterType?: string): BlockInfo[];
 /**
  * Construct the blocks required by the flyout for the variable category.
  *

package/core/variables_dynamic.d.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { FlyoutButton } from './flyout_button.js';
+import type { FlyoutItemInfo } from './utils/toolbox.js';
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
@@ -36,13 +37,14 @@ export declare const onCreateVariableButtonClick_Number: typeof numberButtonClic
 declare function colourButtonClickHandler(button: FlyoutButton): void;
 export declare const onCreateVariableButtonClick_Colour: typeof colourButtonClickHandler;
 /**
- * Construct the elements (blocks and button) required by the flyout for the
- * variable category.
+ * Internal wrapper that returns the contents of the dynamic variables category.
  *
- * @param workspace The workspace containing variables.
- * @returns Array of XML elements.
+ * @internal
+ * @param workspace The workspace to populate variable 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[];
 /**
  * Construct the blocks required by the flyout for the variable category.
  *

package/core/workspace_svg.d.ts

@@ -495,6 +495,7 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     updateScreenCalculationsIfScrolled(): void;
     /**
      * @returns The layer manager for this workspace.
+     * @internal
      */
     getLayerManager(): LayerManager | null;
     /**

package/index.mjs

@@ -39,6 +39,7 @@ export const {
   FieldVariable,
   Flyout,
   FlyoutButton,
+  FlyoutItem,
   FlyoutMetricsManager,
   FlyoutSeparator,
   Generator,

package/package.json

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