blockly 11.0.0-beta.4 → 11.0.0-beta.5

package/core/interfaces/i_parameter_model.d.ts

@@ -3,7 +3,6 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { ParameterState } from '../serialization/procedures';
 import { IProcedureModel } from './i_procedure_model';
 /**
  * A data model for a procedure.
@@ -34,11 +33,5 @@ export interface IParameterModel {
     getId(): string;
     /** Sets the procedure model this parameter is associated with. */
     setProcedureModel(model: IProcedureModel): this;
-    /**
-     * Serializes the state of the parameter to JSON.
-     *
-     * @returns JSON serializable state of the parameter.
-     */
-    saveState(): ParameterState;
 }
 //# sourceMappingURL=i_parameter_model.d.ts.map

package/core/interfaces/i_procedure_model.d.ts

@@ -3,7 +3,6 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { State } from '../serialization/procedures.js';
 import { IParameterModel } from './i_parameter_model.js';
 /**
  * A data model for a procedure.
@@ -49,11 +48,5 @@ export interface IProcedureModel {
      * disabled, all procedure caller blocks should be disabled as well.
      */
     getEnabled(): boolean;
-    /**
-     * Serializes the state of the procedure to JSON.
-     *
-     * @returns JSON serializable state of the procedure.
-     */
-    saveState(): State;
 }
 //# sourceMappingURL=i_procedure_model.d.ts.map

package/core/options.d.ts

@@ -32,7 +32,6 @@ export declare class Options {
     pathToMedia: string;
     hasCategories: boolean;
     moveOptions: MoveOptions;
-    /** @deprecated  January 2019 */
     hasScrollbars: boolean;
     hasTrashcan: boolean;
     maxTrashcanContents: number;

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

@@ -38,6 +38,13 @@ export declare class Drawer {
      * required.
      */
     draw(): void;
+    /**
+     * Hide icons that were marked as hidden.
+     *
+     * @deprecated Manually hiding icons is no longer necessary. To be removed
+     *     in v11.
+     */
+    protected hideHiddenIcons_(): void;
     /**
      * Save sizing information back to the block
      * Most of the rendering information can be thrown away at the end of the

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

@@ -12,6 +12,11 @@ import { Measurable } from './base.js';
  */
 export declare class Icon extends Measurable {
     icon: BlocklyIcon;
+    /**
+     * @deprecated Will be removed in v11. Create a subclass of the Icon
+     *     measurable if this data is necessary for you.
+     */
+    isVisible: boolean;
     flipRtl: boolean;
     /**
      * An object containing information about the space an icon takes up during

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

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ConstantProvider as BaseConstantProvider } from '../common/constants.js';
+/**
+ * An object that provides constants for rendering blocks in the minimalist
+ * renderer.
+ *
+ * @deprecated Use Blockly.blockRendering.ConstantProvider instead.
+ *     To be removed in v11.
+ */
+export declare class ConstantProvider extends BaseConstantProvider {
+    /**
+     * @deprecated Use Blockly.blockRendering.ConstantProvider instead.
+     *     To be removed in v11.
+     */
+    constructor();
+}
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import { Drawer as BaseDrawer } from '../common/drawer.js';
+import type { RenderInfo } from './info.js';
+/**
+ * An object that draws a block based on the given rendering information.
+ *
+ * @deprecated Use Blockly.blockRendering.Drawer instead.
+ *     To be removed in v11.
+ */
+export declare class Drawer extends BaseDrawer {
+    /**
+     * @param block The block to render.
+     * @param info An object containing all information needed to render this
+     *     block.
+     *
+     * @deprecated Use Blockly.blockRendering.Drawer instead.
+     *     To be removed in v11.
+     */
+    constructor(block: BlockSvg, info: RenderInfo);
+}
+//# sourceMappingURL=drawer.d.ts.map

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

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import { RenderInfo as BaseRenderInfo } from '../common/info.js';
+import type { Renderer } from './renderer.js';
+/**
+ * An object containing all sizing information needed to draw this block.
+ *
+ * This measure pass does not propagate changes to the block (although fields
+ * may choose to rerender when getSize() is called).  However, calling it
+ * repeatedly may be expensive.
+ *
+ * @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
+ *     in v11.
+ */
+export declare class RenderInfo extends BaseRenderInfo {
+    protected renderer_: Renderer;
+    /**
+     * @param renderer The renderer in use.
+     * @param block The block to measure.
+     * @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
+     *     in v11.
+     */
+    constructor(renderer: Renderer, block: BlockSvg);
+    /**
+     * Get the block renderer in use.
+     *
+     * @returns The block renderer in use.
+     */
+    getRenderer(): Renderer;
+}
+//# sourceMappingURL=info.d.ts.map

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

@@ -0,0 +1,12 @@
+/** @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';
+import { Renderer } from './renderer.js';
+export { ConstantProvider, Drawer, Renderer, RenderInfo };
+//# sourceMappingURL=minimalist.d.ts.map

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

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import type { RenderInfo as BaseRenderInfo } from '../common/info.js';
+import { Renderer as BaseRenderer } from '../common/renderer.js';
+import { ConstantProvider } from './constants.js';
+import { Drawer } from './drawer.js';
+import { RenderInfo } from './info.js';
+/**
+ * The minimalist renderer.
+ *
+ * @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
+ *     in v11.
+ */
+export declare class Renderer extends BaseRenderer {
+    /**
+     * @param name The renderer name.
+     * @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
+     *     in v11.
+     */
+    constructor(name: string);
+    /**
+     * Create a new instance of the renderer's constant provider.
+     *
+     * @returns The constant provider.
+     */
+    protected makeConstants_(): ConstantProvider;
+    /**
+     * Create a new instance of the renderer's render info object.
+     *
+     * @param block The block to measure.
+     * @returns The render info object.
+     */
+    protected makeRenderInfo_(block: BlockSvg): RenderInfo;
+    /**
+     * Create a new instance of the renderer's drawer.
+     *
+     * @param block The block to render.
+     * @param info An object containing all information needed to render this
+     *     block.
+     * @returns The drawer.
+     */
+    protected makeDrawer_(block: BlockSvg, info: BaseRenderInfo): Drawer;
+}
+//# sourceMappingURL=renderer.d.ts.map

package/core/serialization/procedures.d.ts

@@ -7,65 +7,63 @@ import { IParameterModel } from '../interfaces/i_parameter_model.js';
 import { IProcedureModel } from '../interfaces/i_procedure_model.js';
 import type { ISerializer } from '../interfaces/i_serializer.js';
 import type { Workspace } from '../workspace.js';
-/** Represents the state of a procedure model. */
+/**
+ * Representation of a procedure data model.
+ */
 export interface State {
     id: string;
     name: string;
     returnTypes: string[] | null;
     parameters?: ParameterState[];
-    [key: string]: unknown;
 }
-/** Represents the state of a parameter model. */
+/**
+ * Representation of a parameter data model.
+ */
 export interface ParameterState {
     id: string;
     name: string;
     types?: string[];
-    [key: string]: unknown;
 }
 /**
  * A newable signature for an IProcedureModel.
  *
  * Refer to
- * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes
+ * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
  * for what is going on with this.
  */
-interface ProcedureModelConstructor<ProcedureModel extends IProcedureModel> {
-    new (workspace: Workspace, name: string, id: string): ProcedureModel;
-    /**
-     * Deserializes the JSON state and returns a procedure model.
-     *
-     * @param state The state to deserialize.
-     * @param workspace The workspace to load the procedure model into.
-     * @returns The constructed procedure model.
-     */
-    loadState(state: Object, workspace: Workspace): ProcedureModel;
-}
+type ProcedureModelConstructor<ProcedureModel extends IProcedureModel> = new (workspace: Workspace, name: string, id: string) => ProcedureModel;
 /**
  * A newable signature for an IParameterModel.
  *
  * Refer to
- * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes
+ * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
  * for what is going on with this.
  */
-interface ParameterModelConstructor<ParameterModel extends IParameterModel> {
-    new (workspace: Workspace, name: string, id: string): ParameterModel;
-    /**
-     * Deserializes the JSON state and returns a parameter model.
-     *
-     * @param state The state to deserialize.
-     * @param workspace The workspace to load the parameter model into.
-     * @returns The constructed parameter model.
-     */
-    loadState(state: Object, workspace: Workspace): ParameterModel;
-}
+type ParameterModelConstructor<ParameterModel extends IParameterModel> = new (workspace: Workspace, name: string, id: string) => ParameterModel;
 /**
  * Serializes the given IProcedureModel to JSON.
+ *
+ * @internal
  */
 export declare function saveProcedure(proc: IProcedureModel): State;
+/**
+ * Serializes the given IParameterModel to JSON.
+ *
+ * @internal
+ */
+export declare function saveParameter(param: IParameterModel): ParameterState;
 /**
  * Deserializes the given procedure model State from JSON.
+ *
+ * @internal
  */
 export declare function loadProcedure<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel>(procedureModelClass: ProcedureModelConstructor<ProcedureModel>, parameterModelClass: ParameterModelConstructor<ParameterModel>, state: State, workspace: Workspace): ProcedureModel;
+/**
+ * Deserializes the given ParameterState from JSON.
+ *
+ * @internal
+ */
+export declare function loadParameter<ParameterModel extends IParameterModel>(parameterModelClass: ParameterModelConstructor<ParameterModel>, state: ParameterState, workspace: Workspace): ParameterModel;
 /** Serializer for saving and loading procedure state. */
 export declare class ProcedureSerializer<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel> implements ISerializer {
     private readonly procedureModelClass;

package/core/utils/dom.d.ts

@@ -86,6 +86,15 @@ export declare function removeNode(node: Node | null): Node | null;
  * @param refNode Existing element to precede new node.
  */
 export declare function insertAfter(newNode: Element, refNode: Element): void;
+/**
+ * Whether a node contains another node.
+ *
+ * @param parent The node that should contain the other node.
+ * @param descendant The node to test presence of.
+ * @returns Whether the parent node contains the descendant node.
+ * @deprecated Use native 'contains' DOM method.
+ */
+export declare function containsNode(parent: Node, descendant: Node): boolean;
 /**
  * Sets the CSS transform property on an element. This function sets the
  * non-vendor-prefixed and vendor-prefixed versions for backwards compatibility

package/core/utils/keycodes.d.ts

@@ -16,7 +16,7 @@ export declare enum KeyCodes {
     MAC_ENTER = 3,
     BACKSPACE = 8,
     TAB = 9,
-    NUM_CENTER = 12,// NUMLOCK on FF/Safari Mac
+    NUM_CENTER = 12,
     ENTER = 13,
     SHIFT = 16,
     CTRL = 17,
@@ -25,18 +25,18 @@ export declare enum KeyCodes {
     CAPS_LOCK = 20,
     ESC = 27,
     SPACE = 32,
-    PAGE_UP = 33,// also NUM_NORTH_EAST
-    PAGE_DOWN = 34,// also NUM_SOUTH_EAST
-    END = 35,// also NUM_SOUTH_WEST
-    HOME = 36,// also NUM_NORTH_WEST
-    LEFT = 37,// also NUM_WEST
-    UP = 38,// also NUM_NORTH
-    RIGHT = 39,// also NUM_EAST
-    DOWN = 40,// also NUM_SOUTH
-    PLUS_SIGN = 43,// NOT numpad plus
+    PAGE_UP = 33,
+    PAGE_DOWN = 34,
+    END = 35,
+    HOME = 36,
+    LEFT = 37,
+    UP = 38,
+    RIGHT = 39,
+    DOWN = 40,
+    PLUS_SIGN = 43,
     PRINT_SCREEN = 44,
-    INSERT = 45,// also NUM_INSERT
-    DELETE = 46,// also NUM_DELETE
+    INSERT = 45,
+    DELETE = 46,
     ZERO = 48,
     ONE = 49,
     TWO = 50,
@@ -47,11 +47,11 @@ export declare enum KeyCodes {
     SEVEN = 55,
     EIGHT = 56,
     NINE = 57,
-    FF_SEMICOLON = 59,// Firefox (Gecko) fires this for semicolon instead of 186
-    FF_EQUALS = 61,// Firefox (Gecko) fires this for equals instead of 187
-    FF_DASH = 173,// Firefox (Gecko) fires this for dash instead of 189
+    FF_SEMICOLON = 59,
+    FF_EQUALS = 61,
+    FF_DASH = 173,
     FF_HASH = 163,
-    QUESTION_MARK = 63,// needs localization
+    QUESTION_MARK = 63,
     AT_SIGN = 64,
     A = 65,
     B = 66,
@@ -79,7 +79,7 @@ export declare enum KeyCodes {
     X = 88,
     Y = 89,
     Z = 90,
-    META = 91,// WIN_KEY_LEFT
+    META = 91,
     WIN_KEY_RIGHT = 92,
     CONTEXT_MENU = 93,
     NUM_ZERO = 96,
@@ -113,22 +113,22 @@ export declare enum KeyCodes {
     SCROLL_LOCK = 145,
     FIRST_MEDIA_KEY = 166,
     LAST_MEDIA_KEY = 183,
-    SEMICOLON = 186,// needs localization
-    DASH = 189,// needs localization
-    EQUALS = 187,// needs localization
-    COMMA = 188,// needs localization
-    PERIOD = 190,// needs localization
-    SLASH = 191,// needs localization
-    APOSTROPHE = 192,// needs localization
-    TILDE = 192,// needs localization
-    SINGLE_QUOTE = 222,// needs localization
-    OPEN_SQUARE_BRACKET = 219,// needs localization
-    BACKSLASH = 220,// needs localization
-    CLOSE_SQUARE_BRACKET = 221,// needs localization
+    SEMICOLON = 186,
+    DASH = 189,
+    EQUALS = 187,
+    COMMA = 188,
+    PERIOD = 190,
+    SLASH = 191,
+    APOSTROPHE = 192,
+    TILDE = 192,
+    SINGLE_QUOTE = 222,
+    OPEN_SQUARE_BRACKET = 219,
+    BACKSLASH = 220,
+    CLOSE_SQUARE_BRACKET = 221,
     WIN_KEY = 224,
-    MAC_FF_META = 224,// Firefox (Gecko) fires this for the meta key instead of 91
-    MAC_WK_CMD_LEFT = 91,// WebKit Left Command key fired, same as META
-    MAC_WK_CMD_RIGHT = 93,// WebKit Right Command key fired, different from META
+    MAC_FF_META = 224,
+    MAC_WK_CMD_LEFT = 91,
+    MAC_WK_CMD_RIGHT = 93,
     WIN_IME = 229,
     VK_NONAME = 252,
     PHANTOM = 255

package/core/utils/size.d.ts

@@ -30,15 +30,5 @@ export declare class Size {
      *     are null.
      */
     static equals(a: Size | null, b: Size | null): boolean;
-    /**
-     * Returns a new size with the maximum width and height values out of both
-     * sizes.
-     */
-    static max(a: Size, b: Size): Size;
-    /**
-     * Returns a new size with the minimum width and height values out of both
-     * sizes.
-     */
-    static min(a: Size, b: Size): Size;
 }
 //# sourceMappingURL=size.d.ts.map

package/core/utils/string.d.ts

@@ -3,6 +3,16 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Fast prefix-checker.
+ * Copied from Closure's goog.string.startsWith.
+ *
+ * @param str The string to check.
+ * @param prefix A string to look for at the start of `str`.
+ * @returns True if `str` begins with `prefix`.
+ * @deprecated Use built-in **string.startsWith** instead.
+ */
+export declare function startsWith(str: string, prefix: string): boolean;
 /**
  * Given an array of strings, return the length of the shortest one.
  *

package/core/workspace_svg.d.ts

@@ -20,6 +20,7 @@ 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 type { ICopyData, ICopyable } from './interfaces/i_copyable.js';
 import type { IDragTarget } from './interfaces/i_drag_target.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { IMetricsManager } from './interfaces/i_metrics_manager.js';
@@ -575,6 +576,32 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      *     highlight/unhighlight the specified block.
      */
     highlightBlock(id: string | null, opt_state?: boolean): void;
+    /**
+     * Pastes the provided block or workspace comment onto the workspace.
+     * Does not check whether there is remaining capacity for the object, that
+     * should be done before calling this method.
+     *
+     * @param state The representation of the thing to paste.
+     * @returns The pasted thing, or null if the paste was not successful.
+     * @deprecated v10. Use `Blockly.clipboard.paste` instead. To be removed in
+     *     v11.
+     */
+    paste(state: any | Element | DocumentFragment): ICopyable<ICopyData> | null;
+    /**
+     * Paste the provided block onto the workspace.
+     *
+     * @param xmlBlock XML block element.
+     * @param jsonBlock JSON block representation.
+     * @returns The pasted block.
+     */
+    private pasteBlock_;
+    /**
+     * Paste the provided comment onto the workspace.
+     *
+     * @param xmlComment XML workspace comment element.
+     * @returns The pasted workspace comment.
+     */
+    private pasteWorkspaceComment_;
     /**
      * Refresh the toolbox unless there's a drag in progress.
      *

package/core-browser.js

@@ -0,0 +1,26 @@
+/* eslint-disable */
+;(function(root, factory) {
+  if (typeof define === 'function' && define.amd) { // AMD
+    define(['./blockly'], factory);
+  } else if (typeof exports === 'object') { // Node.js
+    module.exports = factory(require('./blockly'));
+  } else { // Browser
+    root.Blockly = factory(root.Blockly);
+  }
+}(this, function(Blockly) {
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Blockly core module for the browser. It includes blockly.js
+ *               and adds a helper method for setting the locale.
+ */
+
+/* eslint-disable */
+'use strict';
+
+return Blockly;
+}));

package/core.js

@@ -0,0 +1,26 @@
+/* eslint-disable */
+(function (Blockly){
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Blockly core module for Node. It includes blockly-node.js
+ *               and adds a helper method for setting the locale.
+ */
+
+/* eslint-disable */
+'use strict';
+
+// Override textToDomDocument and provide Node.js alternatives to DOMParser and
+// XMLSerializer.
+if (typeof globalThis.document !== 'object') {
+  const {JSDOM} = require('jsdom');
+  const {window} = new JSDOM(`<!DOCTYPE html>`);
+  Blockly.utils.xml.injectDependencies(window);
+}
+
+module.exports = Blockly;
+})(require('./blockly'));

package/dart.d.ts

@@ -4,4 +4,27 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export * from './generators/dart';
+export enum Order {
+  ATOMIC = 0,         // 0 "" ...
+  UNARY_POSTFIX = 1,  // expr++ expr-- () [] . ?.
+  UNARY_PREFIX = 2,   // -expr !expr ~expr ++expr --expr
+  MULTIPLICATIVE = 3, // * / % ~/
+  ADDITIVE = 4,       // + -
+  SHIFT = 5,          // << >>
+  BITWISE_AND = 6,    // &
+  BITWISE_XOR = 7,    // ^
+  BITWISE_OR = 8,     // |
+  RELATIONAL = 9,     // >= > <= < as is is!
+  EQUALITY = 10,      // == !=
+  LOGICAL_AND = 11,   // &&
+  LOGICAL_OR = 12,    // ||
+  IF_NULL = 13,       // ??
+  CONDITIONAL = 14,   // expr ? expr : expr
+  CASCADE = 15,       // ..
+  ASSIGNMENT = 16,    // = *= /= ~/= %= += -= <<= >>= &= ^= |=
+  NONE = 99,          // (...)
+}
+
+export declare const dartGenerator: any;
+
+export {DartGenerator} from './generators/dart';

package/dart.js

@@ -0,0 +1,22 @@
+/* eslint-disable */
+;(function(root, factory) {
+  if (typeof define === 'function' && define.amd) { // AMD
+    define(['./core', './dart_compressed.js'], factory);
+  } else if (typeof exports === 'object') { // Node.js
+    module.exports = factory(require('./core'), require('./dart_compressed.js'));
+  } else { // Browser
+    root.BlocklyDart = factory(root.Blockly, root.BlocklyDart);
+  }
+}(this, function(Blockly, BlocklyDart) {
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Dart generator module; just a wrapper for dart_compressed.js.
+ */
+
+return BlocklyDart;
+}));