blockly 9.0.0-beta.4 → 9.0.1

package/core/block_drag_surface.d.ts

@@ -33,7 +33,11 @@ export declare class BlockDragSurfaceSvg {
     private readonly childSurfaceXY_;
     /** @param container Containing element. */
     constructor(container: Element);
-    /** Create the drag surface and inject it into the container. */
+    /**
+     * Create the drag surface and inject it into the container.
+     *
+     * @deprecated The DOM is automatically created by the constructor.
+     */
     createDom(): void;
     /**
      * Set the SVG blocks on the drag surface's group and show the surface.

package/core/blockly.d.ts

@@ -282,22 +282,12 @@ export declare const defineBlocksWithJsonArray: typeof common.defineBlocksWithJs
  * @alias Blockly.setParentContainer
  */
 export declare const setParentContainer: typeof common.setParentContainer;
-/**
- * Returns the dimensions of the specified SVG image.
- *
- * @param svg SVG image.
- * @returns Contains width and height properties.
- * @deprecated Use workspace.setCachedParentSvgSize. (2021 March 5)
- * @see Blockly.WorkspaceSvg.setCachedParentSvgSize
- * @alias Blockly.svgSize
- */
-export declare const svgSize: typeof utils.svgMath.svgSize;
 /**
  * Size the workspace when the contents change.  This also updates
  * scrollbars accordingly.
  *
  * @param workspace The workspace to resize.
- * @deprecated Use workspace.resizeContents. (2021 December)
+ * @deprecated Use **workspace.resizeContents** instead.
  * @see Blockly.WorkspaceSvg.resizeContents
  * @alias Blockly.resizeSvgContents
  */
@@ -307,7 +297,7 @@ export declare const resizeSvgContents: typeof resizeSvgContentsLocal;
  * Copy a block or workspace comment onto the local clipboard.
  *
  * @param toCopy Block or Workspace Comment to be copied.
- * @deprecated Use Blockly.clipboard.copy(). (2021 December)
+ * @deprecated Use **Blockly.clipboard.copy** instead.
  * @see Blockly.clipboard.copy
  * @alias Blockly.copy
  */
@@ -316,7 +306,7 @@ export declare function copy(toCopy: ICopyable): void;
  * Paste a block or workspace comment on to the main workspace.
  *
  * @returns True if the paste was successful, false otherwise.
- * @deprecated Use Blockly.clipboard.paste(). (2021 December)
+ * @deprecated Use **Blockly.clipboard.paste** instead.
  * @see Blockly.clipboard.paste
  * @alias Blockly.paste
  */
@@ -325,7 +315,7 @@ export declare function paste(): boolean;
  * Duplicate this block and its children, or a workspace comment.
  *
  * @param toDuplicate Block or Workspace Comment to be copied.
- * @deprecated Use Blockly.clipboard.duplicate(). (2021 December)
+ * @deprecated Use **Blockly.clipboard.duplicate** instead.
  * @see Blockly.clipboard.duplicate
  * @alias Blockly.duplicate
  */
@@ -335,7 +325,7 @@ export declare function duplicate(toDuplicate: ICopyable): void;
  *
  * @param str Input string.
  * @returns True if number, false otherwise.
- * @deprecated Use Blockly.utils.string.isNumber(str). (2021 December)
+ * @deprecated Use **Blockly.utils.string.isNumber** instead.
  * @see Blockly.utils.string.isNumber
  * @alias Blockly.isNumber
  */
@@ -345,7 +335,7 @@ export declare function isNumber(str: string): boolean;
  *
  * @param hue Hue on a colour wheel (0-360).
  * @returns RGB code, e.g. '#5ba65b'.
- * @deprecated Use Blockly.utils.colour.hueToHex(). (2021 December)
+ * @deprecated Use **Blockly.utils.colour.hueToHex** instead.
  * @see Blockly.utils.colour.hueToHex
  * @alias Blockly.hueToHex
  */
@@ -361,7 +351,7 @@ export declare function hueToHex(hue: number): string;
  * @param thisObject The value of 'this' in the function.
  * @param func Function to call when event is triggered.
  * @returns Opaque data that can be passed to unbindEvent_.
- * @deprecated Use Blockly.browserEvents.bind(). (December 2021)
+ * @deprecated Use **Blockly.browserEvents.bind** instead.
  * @see Blockly.browserEvents.bind
  * @alias Blockly.bindEvent_
  */
@@ -372,7 +362,7 @@ export declare function bindEvent_(node: EventTarget, name: string, thisObject:
  * @param bindData Opaque data from bindEvent_.
  *     This list is emptied during the course of calling this function.
  * @returns The function call.
- * @deprecated Use Blockly.browserEvents.unbind(). (December 2021)
+ * @deprecated Use **Blockly.browserEvents.unbind** instead.
  * @see browserEvents.unbind
  * @alias Blockly.unbindEvent_
  */
@@ -394,7 +384,7 @@ export declare function unbindEvent_(bindData: browserEvents.Data): Function;
  *     the default handler.  False by default.  If opt_noPreventDefault is
  *     provided, opt_noCaptureIdentifier must also be provided.
  * @returns Opaque data that can be passed to unbindEvent_.
- * @deprecated Use Blockly.browserEvents.conditionalBind(). (December 2021)
+ * @deprecated Use **Blockly.browserEvents.conditionalBind** instead.
  * @see browserEvents.conditionalBind
  * @alias Blockly.bindEventWithChecks_
  */

package/core/css.d.ts

@@ -10,7 +10,7 @@
  * @param cssContent Multiline CSS string or an array of single lines of CSS.
  * @alias Blockly.Css.register
  */
-export declare function register(cssContent: string | string[]): void;
+export declare function register(cssContent: string): void;
 /**
  * Inject the CSS into the DOM.  This is preferable over using a regular CSS
  * file since:

package/core/field.d.ts

@@ -151,7 +151,7 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * @returns The block containing this field.
      * @throws An error if the source block is not defined.
      */
-    getSourceBlock(): Block;
+    getSourceBlock(): Block | null;
     /**
      * Initialize everything to render this field. Override
      * methods initModel and initView rather than this method.
@@ -615,4 +615,13 @@ export interface FieldConfig {
  * in descendants, though they should contain all of Field's prototype methods.
  */
 export declare 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
+ * block.
+ */
+export declare class UnattachedFieldError extends Error {
+    /** @internal */
+    constructor();
+}
 //# sourceMappingURL=field.d.ts.map

package/core/interfaces/i_ast_node_location_with_block.d.ts

@@ -16,6 +16,6 @@ export interface IASTNodeLocationWithBlock extends IASTNodeLocation {
      *
      * @returns The source block.
      */
-    getSourceBlock(): Block;
+    getSourceBlock(): Block | null;
 }
 //# sourceMappingURL=i_ast_node_location_with_block.d.ts.map

package/core/interfaces/i_parameter_model.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * The interface for the data model of a procedure parameter.
+ *
+ * @namespace Blockly.IParameterModel
+ */
+/**
+ * A data model for a procedure.
+ */
+export interface IParameterModel {
+    /**
+     * Sets the name of this parameter to the given name.
+     */
+    setName(name: string): this;
+    /**
+     * Sets the types of this parameter to the given type.
+     */
+    setTypes(types: string[]): this;
+    /**
+     * Returns the unique language-neutral ID for the parameter.
+     *
+     * This represents the identify of the variable model which does not change
+     * over time.
+     */
+    getId(): string;
+}
+//# sourceMappingURL=i_parameter_model.d.ts.map

package/core/interfaces/i_procedure_model.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * The interface for the data model of a procedure.
+ *
+ * @namespace Blockly.IProcedureModel
+ */
+import { IParameterModel } from './i_parameter_model.js';
+/**
+ * A data model for a procedure.
+ */
+export interface IProcedureModel {
+    /** Sets the human-readable name of the procedure. */
+    setName(name: string): this;
+    /**
+     * Inserts a parameter into the list of parameters.
+     *
+     * To move a parameter, first delete it, and then re-insert.
+     */
+    insertParameter(parameterModel: IParameterModel, index: number): this;
+    /** Removes the parameter at the given index from the parameter list. */
+    deleteParameter(index: number): this;
+    /**
+     * Sets the return type(s) of the procedure.
+     *
+     * Pass null to represent a procedure that does not return.
+     */
+    setReturnTypes(types: string[] | null): this;
+    /**
+     * Sets whether this procedure is enabled/disabled. If a procedure is disabled
+     * all procedure caller blocks should be disabled as well.
+     */
+    setEnabled(enabled: boolean): this;
+    /** Returns the unique language-neutral ID for the procedure. */
+    getId(): string;
+    /** Returns the human-readable name of the procedure. */
+    getName(): string;
+    /** Returns the parameter at the given index in the parameter list. */
+    getParameter(index: number): IParameterModel;
+    /** Returns an array of all of the parameters in the parameter list. */
+    getParameters(): IParameterModel[];
+    /**
+     * Returns the return type(s) of the procedure.
+     *
+     * Null represents a procedure that does not return a value.
+     */
+    getReturnTypes(): string[] | null;
+    /**
+     * Returns whether the procedure is enabled/disabled. If a procedure is
+     * disabled, all procedure caller blocks should be disabled as well.
+     */
+    getEnabled(): boolean;
+}
+//# sourceMappingURL=i_procedure_model.d.ts.map

package/core/procedures/observable_parameter_model.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { IParameterModel } from '../interfaces/i_parameter_model.js';
+import type { VariableModel } from '../variable_model.js';
+import type { Workspace } from '../workspace.js';
+export declare class ObservableParameterModel implements IParameterModel {
+    private readonly workspace;
+    private id;
+    private variable;
+    constructor(workspace: Workspace, name: string, id?: string);
+    /**
+     * Sets the name of this parameter to the given name.
+     */
+    setName(name: string): this;
+    /**
+     * Unimplemented. The built-in ParameterModel does not support typing.
+     * If you want your procedure blocks to have typed parameters, you need to
+     * implement your own ParameterModel.
+     */
+    setTypes(_types: string[]): this;
+    /**
+     * Returns the unique language-neutral ID for the parameter.
+     *
+     * This represents the identify of the variable model which does not change
+     * over time.
+     */
+    getId(): string;
+    /** Returns the variable model associated with the parameter model. */
+    getVariableModel(): VariableModel;
+}
+//# sourceMappingURL=observable_parameter_model.d.ts.map

package/core/procedures/observable_procedure_map.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { IProcedureModel } from '../interfaces/i_procedure_model.js';
+import type { Workspace } from '../workspace.js';
+export declare class ObservableProcedureMap extends Map<string, IProcedureModel> {
+    private readonly workspace;
+    constructor(workspace: Workspace);
+    /**
+     * Adds the given procedure model to the procedure map.
+     */
+    set(id: string, proc: IProcedureModel): this;
+    /**
+     * Deletes the ProcedureModel with the given ID from the procedure map (if it
+     * exists).
+     */
+    delete(id: string): boolean;
+    /**
+     * Removes all ProcedureModels from the procedure map.
+     */
+    clear(): void;
+    /**
+     * Adds the given ProcedureModel to the map of procedure models, so that
+     * blocks can find it.
+     */
+    add(proc: IProcedureModel): this;
+}
+//# sourceMappingURL=observable_procedure_map.d.ts.map

package/core/procedures/observable_procedure_model.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { IParameterModel } from '../interfaces/i_parameter_model.js';
+import type { IProcedureModel } from '../interfaces/i_procedure_model.js';
+import type { Workspace } from '../workspace.js';
+export declare class ObservableProcedureModel implements IProcedureModel {
+    private readonly workspace;
+    private id;
+    private name;
+    private parameters;
+    private returnTypes;
+    private enabled;
+    constructor(workspace: Workspace, id?: string);
+    /** Sets the human-readable name of the procedure. */
+    setName(name: string): this;
+    /**
+     * Inserts a parameter into the list of parameters.
+     *
+     * To move a parameter, first delete it, and then re-insert.
+     */
+    insertParameter(parameterModel: IParameterModel, index: number): this;
+    /** Removes the parameter at the given index from the parameter list. */
+    deleteParameter(index: number): this;
+    /**
+     * Sets the return type(s) of the procedure.
+     *
+     * Pass null to represent a procedure that does not return.
+     */
+    setReturnTypes(types: string[] | null): this;
+    /**
+     * Sets whether this procedure is enabled/disabled. If a procedure is disabled
+     * all procedure caller blocks should be disabled as well.
+     */
+    setEnabled(enabled: boolean): this;
+    /** Returns the unique language-neutral ID for the procedure. */
+    getId(): string;
+    /** Returns the human-readable name of the procedure. */
+    getName(): string;
+    /** Returns the parameter at the given index in the parameter list. */
+    getParameter(index: number): IParameterModel;
+    /** Returns an array of all of the parameters in the parameter list. */
+    getParameters(): IParameterModel[];
+    /**
+     * Returns the return type of the procedure.
+     *
+     * Null represents a procedure that does not return a value.
+     */
+    getReturnTypes(): string[] | null;
+    /**
+     * Returns whether the procedure is enabled/disabled. If a procedure is
+     * disabled, all procedure caller blocks should be disabled as well.
+     */
+    getEnabled(): boolean;
+}
+//# sourceMappingURL=observable_procedure_model.d.ts.map

package/core/procedures.d.ts

@@ -6,7 +6,7 @@
 import './events/events_block_change.js';
 import type { Block } from './block.js';
 import type { Abstract } from './events/events_abstract.js';
-import type { Field } from './field.js';
+import { Field } from './field.js';
 import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**

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

@@ -34,15 +34,6 @@ import { RenderInfo } from './info.js';
 import { MarkerSvg } from './marker_svg.js';
 import { PathObject } from './path_object.js';
 import { Renderer } from './renderer.js';
-/**
- * Returns whether the debugger is turned on.
- *
- * @returns Whether the debugger is turned on.
- * @alias Blockly.blockRendering.isDebuggerEnabled
- * @deprecated
- * @internal
- */
-export declare function isDebuggerEnabled(): boolean;
 /**
  * Registers a new renderer.
  *
@@ -58,19 +49,12 @@ export declare function register(name: string, rendererClass: Function): void;
  * @alias Blockly.blockRendering.unregister
  */
 export declare function unregister(name: string): void;
-/**
- * Turn on the blocks debugger.
- *
- * @alias Blockly.blockRendering.startDebugger
- * @deprecated
- * @internal
- */
-export declare function startDebugger(): void;
 /**
  * Turn off the blocks debugger.
  *
  * @alias Blockly.blockRendering.stopDebugger
- * @deprecated
+ * @deprecated Use the debug renderer in **\@blockly/dev-tools** (See {@link
+ *     https://www.npmjs.com/package/@blockly/dev-tools}.)
  * @internal
  */
 export declare function stopDebugger(): void;

package/core/serialization.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import * as blocks from './serialization/blocks.js';
+import * as exceptions from './serialization/exceptions.js';
+import * as priorities from './serialization/priorities.js';
+import * as registry from './serialization/registry.js';
+import * as variables from './serialization/variables.js';
+import * as workspaces from './serialization/workspaces.js';
+import { ISerializer } from './interfaces/i_serializer.js';
+export { blocks, exceptions, priorities, registry, variables, workspaces, ISerializer, };
+//# sourceMappingURL=serialization.d.ts.map

package/core/touch.d.ts

@@ -73,9 +73,9 @@ export declare function shouldHandleEvent(e: Event | PseudoEvent): boolean;
  * Get the touch identifier from the given event.  If it was a mouse event, the
  * identifier is the string 'mouse'.
  *
- * @param e Mouse event or touch event.
- * @returns The touch identifier from the first changed touch, if defined.
- *     Otherwise 'mouse'.
+ * @param e Pointer event, mouse event, or touch event.
+ * @returns The pointerId, or touch identifier from the first changed touch, if
+ *     defined. Otherwise 'mouse'.
  * @alias Blockly.Touch.getTouchIdentifierFromEvent
  */
 export declare function getTouchIdentifierFromEvent(e: Event | PseudoEvent): string;

package/core/utils/object.d.ts

@@ -9,6 +9,7 @@
  * @param childCtor Child class.
  * @param parentCtor Parent class.
  * @suppress {strictMissingProperties} superClass_ is not defined on Function.
+ * @deprecated No longer provided by Blockly.
  * @alias Blockly.utils.object.inherits
  */
 export declare function inherits(childCtor: Function, parentCtor: Function): void;
@@ -17,6 +18,7 @@ export declare function inherits(childCtor: Function, parentCtor: Function): voi
  *
  * @param target Target.
  * @param source Source.
+ * @deprecated Use the built-in **Object.assign** instead.
  * @alias Blockly.utils.object.mixin
  */
 export declare function mixin(target: any, source: any): void;
@@ -34,6 +36,7 @@ export declare function deepMerge(target: any, source: any): any;
  *
  * @param obj Object containing values.
  * @returns Array of values.
+ * @deprecated Use the built-in **Object.values** instead.
  * @alias Blockly.utils.object.values
  */
 export declare function values(obj: any): any[];

package/core/utils/string.d.ts

@@ -11,7 +11,7 @@
  * @param prefix A string to look for at the start of `str`.
  * @returns True if `str` begins with `prefix`.
  * @alias Blockly.utils.string.startsWith
- * @deprecated April 2022. Use built-in string.startsWith.
+ * @deprecated Use built-in **string.startsWith** instead.
  */
 export declare function startsWith(str: string, prefix: string): boolean;
 /**

package/core/utils/style.d.ts

@@ -41,6 +41,7 @@ export declare function getComputedStyle(element: Element, property: string): st
  * @param element Element to get style of.
  * @param style Property to get (camel-case).
  * @returns Style value.
+ * @deprecated No longer provided by Blockly.
  * @alias Blockly.utils.style.getCascadedStyle
  */
 export declare function getCascadedStyle(element: Element, style: string): string;

package/core/utils/svg_math.d.ts

@@ -6,7 +6,6 @@
 import type { WorkspaceSvg } from '../workspace_svg.js';
 import { Coordinate } from './coordinate.js';
 import { Rect } from './rect.js';
-import { Size } from './size.js';
 /**
  * Return the coordinates of the top-left corner of this element relative to
  * its parent.  Only for SVG elements and children (e.g. rect, g, path).
@@ -31,6 +30,7 @@ export declare function getInjectionDivXY(element: Element): Coordinate;
  * and attempting to set the property.
  *
  * @returns True if 3D transforms are supported.
+ * @deprecated No longer provided by Blockly.
  * @alias Blockly.utils.svgMath.is3dSupported
  */
 export declare function is3dSupported(): boolean;
@@ -62,15 +62,6 @@ export declare function getDocumentScroll(): Coordinate;
  * @alias Blockly.utils.svgMath.screenToWsCoordinates
  */
 export declare function screenToWsCoordinates(ws: WorkspaceSvg, screenCoordinates: Coordinate): Coordinate;
-/**
- * Returns the dimensions of the specified SVG image.
- *
- * @param svg SVG image.
- * @returns Contains width and height properties.
- * @deprecated Use workspace.getCachedParentSvgSize. (2021 March 5)
- * @alias Blockly.utils.svgMath.svgSize
- */
-export declare function svgSize(svg: SVGElement): Size;
 export declare const TEST_ONLY: {
     XY_REGEX: RegExp;
     XY_STYLE_REGEX: RegExp;