blockly 9.0.1 → 9.1.0-beta.0

package/core/serialization/procedures.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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 { ObservableProcedureModel } from '../procedures/observable_procedure_model.js';
+import { ObservableParameterModel } from '../procedures/observable_parameter_model.js';
+import type { Workspace } from '../workspace.js';
+/**
+ * Representation of a procedure data model.
+ */
+export interface State {
+    id: string;
+    name: string;
+    returnTypes: string[] | null;
+    parameters?: ParameterState[];
+}
+/**
+ * Representation of a parameter data model.
+ */
+export interface ParameterState {
+    id: string;
+    name: string;
+    types?: string[];
+}
+/**
+ * A newable signature for an IProcedureModel.
+ *
+ * Refer to
+ * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
+ * for what is going on with this.
+ */
+declare 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/2/generics.html#using-class-types-in-generics
+ * for what is going on with this.
+ */
+declare type ParameterModelConstructor<ParameterModel extends IParameterModel> = new (workspace: Workspace, name: string, id: string) => ParameterModel;
+/** Serializer for saving and loading procedure state. */
+export declare class ProcedureSerializer<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel> implements ISerializer {
+    private readonly procedureModelClass;
+    private readonly parameterModelClass;
+    priority: number;
+    /**
+     * Constructs the procedure serializer.
+     *
+     * Example usage:
+     *   new ProcedureSerializer(MyProcedureModelClass, MyParameterModelClass)
+     *
+     * @param procedureModelClass The class (implementing IProcedureModel) that
+     *     you want this serializer to deserialize.
+     * @param parameterModelClass The class (implementing IParameterModel) that
+     *     you want this serializer to deserialize.
+     */
+    constructor(procedureModelClass: ProcedureModelConstructor<ProcedureModel>, parameterModelClass: ParameterModelConstructor<ParameterModel>);
+    /** Serializes the procedure models of the given workspace. */
+    save(workspace: Workspace): State[] | null;
+    /**
+     * Deserializes the procedures models defined by the given state into the
+     * workspace.
+     */
+    load(state: State[], workspace: Workspace): void;
+    /** Disposes of any procedure models that exist on the workspace. */
+    clear(workspace: Workspace): void;
+}
+/**
+ * A ProcedureSerializer that deserializes to create the built-in
+ * ObservableProcedureModels and ObservableParameterModels.
+ */
+export declare const observableProcedureSerializer: ProcedureSerializer<ObservableProcedureModel, ObservableParameterModel>;
+export {};
+//# sourceMappingURL=procedures.d.ts.map

package/core/serialization/variables.d.ts

@@ -3,6 +3,8 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { ISerializer } from '../interfaces/i_serializer.js';
+import type { Workspace } from '../workspace.js';
 /**
  * Represents the state of a given variable.
  *
@@ -13,4 +15,35 @@ export interface State {
     id: string;
     type: string | undefined;
 }
+/**
+ * Serializer for saving and loading variable state.
+ *
+ * @alias Blockly.serialization.variables.VariableSerializer
+ */
+export declare class VariableSerializer implements ISerializer {
+    priority: number;
+    constructor();
+    /**
+     * Serializes the variables of the given workspace.
+     *
+     * @param workspace The workspace to save the variables of.
+     * @returns The state of the workspace's variables, or null if there are no
+     *     variables.
+     */
+    save(workspace: Workspace): State[] | null;
+    /**
+     * Deserializes the variable defined by the given state into the given
+     * workspace.
+     *
+     * @param state The state of the variables to deserialize.
+     * @param workspace The workspace to deserialize into.
+     */
+    load(state: State[], workspace: Workspace): void;
+    /**
+     * Disposes of any variables that exist on the workspace.
+     *
+     * @param workspace The workspace to clear the variables of.
+     */
+    clear(workspace: Workspace): void;
+}
 //# sourceMappingURL=variables.d.ts.map

package/core/serialization.d.ts

@@ -6,9 +6,10 @@
 import * as blocks from './serialization/blocks.js';
 import * as exceptions from './serialization/exceptions.js';
 import * as priorities from './serialization/priorities.js';
+import * as procedures from './serialization/procedures.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, };
+export { blocks, exceptions, priorities, procedures, registry, variables, workspaces, ISerializer, };
 //# sourceMappingURL=serialization.d.ts.map

package/core/theme.d.ts

@@ -5,7 +5,7 @@
  */
 export interface ITheme {
     blockStyles?: {
-        [key: string]: BlockStyle;
+        [key: string]: Partial<BlockStyle>;
     };
     categoryStyles?: {
         [key: string]: CategoryStyle;
@@ -51,7 +51,7 @@ export declare class Theme implements ITheme {
      * @param opt_componentStyles A map of Blockly component names to style value.
      */
     constructor(name: string, opt_blockStyles?: {
-        [key: string]: BlockStyle;
+        [key: string]: Partial<BlockStyle>;
     }, opt_categoryStyles?: {
         [key: string]: CategoryStyle;
     }, opt_componentStyles?: ComponentStyle);
@@ -115,9 +115,9 @@ export declare class Theme implements ITheme {
 export declare namespace Theme {
     interface BlockStyle {
         colourPrimary: string;
-        colourSecondary?: string;
-        colourTertiary?: string;
-        hat?: string;
+        colourSecondary: string;
+        colourTertiary: string;
+        hat: string;
     }
     interface CategoryStyle {
         colour: string;

package/core/warning.d.ts

@@ -12,9 +12,9 @@ import { Icon } from './icon.js';
  * @alias Blockly.Warning
  */
 export declare class Warning extends Icon {
-    private text_;
+    private text;
     /** The top-level node of the warning text, or null if not created. */
-    private paragraphElement_;
+    private paragraphElement;
     /** Does this icon get hidden when the block is collapsed? */
     collapseHidden: boolean;
     /** @param block The block associated with this warning. */
@@ -32,9 +32,9 @@ export declare class Warning extends Icon {
      */
     setVisible(visible: boolean): void;
     /** Show the bubble. */
-    private createBubble_;
+    private createBubble;
     /** Dispose of the bubble and references to it. */
-    private disposeBubble_;
+    private disposeBubble;
     /**
      * Set this warning's text.
      *

package/core/workspace.d.ts

@@ -14,6 +14,7 @@ import type * as toolbox from './utils/toolbox.js';
 import { VariableMap } from './variable_map.js';
 import type { VariableModel } from './variable_model.js';
 import type { WorkspaceComment } from './workspace_comment.js';
+import { IProcedureMap } from './interfaces/i_procedure_map.js';
 /**
  * Class for a workspace.  This is a data structure that contains blocks.
  * There is no UI, and can be created headlessly.
@@ -68,15 +69,16 @@ export declare class Workspace implements IASTNodeLocation {
     /** Set of databases for rapid lookup of connection locations. */
     connectionDBList: ConnectionDB[];
     connectionChecker: IConnectionChecker;
-    private readonly topBlocks_;
-    private readonly topComments_;
+    private readonly topBlocks;
+    private readonly topComments;
     private readonly commentDB;
-    private readonly listeners_;
+    private readonly listeners;
     protected undoStack_: Abstract[];
     protected redoStack_: Abstract[];
     private readonly blockDB;
     private readonly typedBlocksDB;
-    private variableMap_;
+    private variableMap;
+    private procedureMap;
     /**
      * Blocks in the flyout can refer to variables that don't exist in the main
      * workspace.  For instance, the "get item in list" block refers to an
@@ -85,7 +87,7 @@ export declare class Workspace implements IASTNodeLocation {
      * these by tracking "potential" variables in the flyout.  These variables
      * become real when references to them are dragged into the main workspace.
      */
-    private potentialVariableMap_;
+    private potentialVariableMap;
     /** @param opt_options Dictionary of options. */
     constructor(opt_options?: Options);
     /**
@@ -419,6 +421,8 @@ export declare class Workspace implements IASTNodeLocation {
      * @internal
      */
     setVariableMap(variableMap: VariableMap): void;
+    /** Returns the map of all procedures on the workpace. */
+    getProcedureMap(): IProcedureMap;
     /**
      * Find the workspace with the specified ID.
      *

package/core/workspace_svg.d.ts

@@ -54,7 +54,7 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * A wrapper function called when a resize event occurs.
      * You can pass the result to `eventHandling.unbind`.
      */
-    private resizeHandlerWrapper_;
+    private resizeHandlerWrapper;
     /**
      * The render status of an SVG workspace.
      * Returns `false` for headless workspaces and true for instances of
@@ -70,7 +70,7 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * Whether this workspace has resizes enabled.
      * Disable during batch operations for a performance improvement.
      */
-    private resizesEnabled_;
+    private resizesEnabled;
     /**
      * Current horizontal scrolling offset in pixel units, relative to the
      * workspace origin.
@@ -138,15 +138,15 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     /** Vertical scroll value when scrolling started in pixel units. */
     startScrollY: number;
     /** Distance from mouse to object being dragged. */
-    private dragDeltaXY_;
+    private dragDeltaXY;
     /** Current scale. */
     scale: number;
     /** Cached scale value. Used to detect changes in viewport. */
-    private oldScale_;
+    private oldScale;
     /** Cached viewport top value. Used to detect changes in viewport. */
-    private oldTop_;
+    private oldTop;
     /** Cached viewport left value. Used to detect changes in viewport. */
-    private oldLeft_;
+    private oldLeft;
     /** The workspace's trashcan (if any). */
     trashcan: Trashcan | null;
     /** This workspace's scrollbars, if they exist. */
@@ -154,7 +154,7 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     /**
      * Fixed flyout providing blocks which may be dragged into this workspace.
      */
-    private flyout_;
+    private flyout;
     /**
      * Category-based toolbox providing blocks which may be dragged into this
      * workspace.
@@ -167,32 +167,32 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      */
     currentGesture_: TouchGesture | null;
     /** This workspace's surface for dragging blocks, if it exists. */
-    private readonly blockDragSurface_;
+    private readonly blockDragSurface;
     /** This workspace's drag surface, if it exists. */
-    private readonly workspaceDragSurface_;
+    private readonly workspaceDragSurface;
     /**
      * Whether to move workspace to the drag surface when it is dragged.
      * True if it should move, false if it should be translated directly.
      */
-    private readonly useWorkspaceDragSurface_;
+    private readonly useWorkspaceDragSurface;
     /**
      * Whether the drag surface is actively in use. When true, calls to
      * translate will translate the drag surface instead of the translating the
      * workspace directly.
      * This is set to true in setupDragSurface and to false in resetDragSurface.
      */
-    private isDragSurfaceActive_;
+    private isDragSurfaceActive;
     /**
      * The first parent div with 'injectionDiv' in the name, or null if not set.
      * Access this with getInjectionDiv.
      */
-    private injectionDiv_;
+    private injectionDiv;
     /**
      * Last known position of the page scroll.
      * This is used to determine whether we have recalculated screen coordinate
      * stuff since the page scrolled.
      */
-    private lastRecordedPageScroll_;
+    private lastRecordedPageScroll;
     /**
      * Developers may define this function to add custom menu options to the
      * workspace's context menu or edit the workspace-created set of menu
@@ -210,10 +210,10 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      */
     targetWorkspace: WorkspaceSvg | null;
     /** Inverted screen CTM, for use in mouseToSvg. */
-    private inverseScreenCTM_;
+    private inverseScreenCTM;
     /** Inverted screen CTM is dirty, recalculate it. */
-    private inverseScreenCTMDirty_;
-    private metricsManager_;
+    private inverseScreenCTMDirty;
+    private metricsManager;
     /** @internal */
     getMetrics: () => Metrics;
     /** @internal */
@@ -221,15 +221,15 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
         x?: number;
         y?: number;
     }) => void;
-    private readonly componentManager_;
+    private readonly componentManager;
     /**
      * List of currently highlighted blocks.  Block highlighting is often used
      * to visually mark blocks currently being executed.
      */
-    private readonly highlightedBlocks_;
-    private audioManager_;
-    private grid_;
-    private markerManager_;
+    private readonly highlightedBlocks;
+    private audioManager;
+    private grid;
+    private markerManager;
     /**
      * Map from function names to callbacks, for deciding what to do when a
      * custom toolbox category is opened.
@@ -241,16 +241,16 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      */
     private flyoutButtonCallbacks;
     protected themeManager_: ThemeManager;
-    private readonly renderer_;
+    private readonly renderer;
     /** Cached parent SVG. */
-    private cachedParentSvg_;
+    private cachedParentSvg;
     /** True if keyboard accessibility mode is on, false otherwise. */
     keyboardAccessibilityMode: boolean;
     /** The list of top-level bounded elements on the workspace. */
-    private topBoundedElements_;
+    private topBoundedElements;
     /** The recorded drag targets. */
-    private dragTargetAreas_;
-    private readonly cachedParentSvgSize_;
+    private dragTargetAreas;
+    private readonly cachedParentSvgSize;
     svgGroup_: SVGElement;
     svgBackground_: SVGElement;
     svgBlockCanvas_: SVGElement;

package/core/zoom_controls.d.ts

@@ -24,17 +24,17 @@ export declare class ZoomControls implements IPositionable {
      * A handle to use to unbind the mouse down event handler for zoom reset
      *    button. Opaque data returned from browserEvents.conditionalBind.
      */
-    private onZoomResetWrapper_;
+    private onZoomResetWrapper;
     /**
      * A handle to use to unbind the mouse down event handler for zoom in
      * button. Opaque data returned from browserEvents.conditionalBind.
      */
-    private onZoomInWrapper_;
+    private onZoomInWrapper;
     /**
      * A handle to use to unbind the mouse down event handler for zoom out
      * button. Opaque data returned from browserEvents.conditionalBind.
      */
-    private onZoomOutWrapper_;
+    private onZoomOutWrapper;
     /** The zoom in svg <g> element. */
     private zoomInGroup;
     /** The zoom out svg <g> element. */
@@ -42,27 +42,27 @@ export declare class ZoomControls implements IPositionable {
     /** The zoom reset svg <g> element. */
     private zoomResetGroup;
     /** Width of the zoom controls. */
-    private readonly WIDTH_;
+    private readonly WIDTH;
     /** Height of each zoom control. */
-    private readonly HEIGHT_;
+    private readonly HEIGHT;
     /** Small spacing used between the zoom in and out control, in pixels. */
-    private readonly SMALL_SPACING_;
+    private readonly SMALL_SPACING;
     /**
      * Large spacing used between the zoom in and reset control, in pixels.
      */
-    private readonly LARGE_SPACING_;
+    private readonly LARGE_SPACING;
     /** Distance between zoom controls and bottom or top edge of workspace. */
-    private readonly MARGIN_VERTICAL_;
+    private readonly MARGIN_VERTICAL;
     /** Distance between zoom controls and right or left edge of workspace. */
-    private readonly MARGIN_HORIZONTAL_;
+    private readonly MARGIN_HORIZONTAL;
     /** The SVG group containing the zoom controls. */
     private svgGroup;
     /** Left coordinate of the zoom controls. */
-    private left_;
+    private left;
     /** Top coordinate of the zoom controls. */
-    private top_;
+    private top;
     /** Whether this has been initialized. */
-    private initialized_;
+    private initialized;
     /** @param workspace The workspace to sit in. */
     constructor(workspace: WorkspaceSvg);
     /**
@@ -102,7 +102,7 @@ export declare class ZoomControls implements IPositionable {
      *     These IDs must be unique in case there are multiple Blockly instances
      *     on the same page.
      */
-    private createZoomOutSvg_;
+    private createZoomOutSvg;
     /**
      * Create the zoom out icon and its event handler.
      *
@@ -110,7 +110,7 @@ export declare class ZoomControls implements IPositionable {
      *     These IDs must be unique in case there are multiple Blockly instances
      *     on the same page.
      */
-    private createZoomInSvg_;
+    private createZoomInSvg;
     /**
      * Handles a mouse down event on the zoom in or zoom out buttons on the
      *    workspace.
@@ -119,7 +119,7 @@ export declare class ZoomControls implements IPositionable {
      *     positive amount values zoom in.
      * @param e A mouse down event.
      */
-    private zoom_;
+    private zoom;
     /**
      * Create the zoom reset icon and its event handler.
      *
@@ -127,14 +127,14 @@ export declare class ZoomControls implements IPositionable {
      *     These IDs must be unique in case there are multiple Blockly instances
      *     on the same page.
      */
-    private createZoomResetSvg_;
+    private createZoomResetSvg;
     /**
      * Handles a mouse down event on the reset zoom button on the workspace.
      *
      * @param e A mouse down event.
      */
-    private resetZoom_;
+    private resetZoom;
     /** Fires a zoom control UI event. */
-    private fireZoomEvent_;
+    private fireZoomEvent;
 }
 //# sourceMappingURL=zoom_controls.d.ts.map

package/core-browser.js

@@ -24,4 +24,4 @@
 
 
 return Blockly;
-})); 
+}));

package/core.js

@@ -27,4 +27,4 @@ if (typeof globalThis.document !== 'object') {
 }
 
 module.exports = Blockly;
-})(require('./blockly')); 
+})(require('./blockly'));

package/dart.js

@@ -19,4 +19,4 @@
  */
 
 return BlocklyDart;
-})); 
+}));

package/dart_compressed.js

@@ -13,8 +13,8 @@
   }
 }(this, function(__parent__) {
 var $=__parent__.__namespace__;
-var module$exports$Blockly$Dart={},module$contents$Blockly$Dart_Variables=$.module$build$src$core$variables,module$contents$Blockly$Dart_stringUtils=$.module$build$src$core$utils$string,module$contents$Blockly$Dart_Generator=$.Generator$$module$build$src$core$generator,module$contents$Blockly$Dart_Names=$.module$build$src$core$names.Names,module$contents$Blockly$Dart_NameType=$.NameType$$module$build$src$core$names,module$contents$Blockly$Dart_inputTypes=$.module$build$src$core$input_types.inputTypes;
-module$exports$Blockly$Dart.dartGenerator=new $.Generator$$module$build$src$core$generator("Dart");module$exports$Blockly$Dart.dartGenerator.addReservedWords("assert,break,case,catch,class,const,continue,default,do,else,enum,extends,false,final,finally,for,if,in,is,new,null,rethrow,return,super,switch,this,throw,true,try,var,void,while,with,print,identityHashCode,identical,BidirectionalIterator,Comparable,double,Function,int,Invocation,Iterable,Iterator,List,Map,Match,num,Pattern,RegExp,Set,StackTrace,String,StringSink,Type,bool,DateTime,Deprecated,Duration,Expando,Null,Object,RuneIterator,Runes,Stopwatch,StringBuffer,Symbol,Uri,Comparator,AbstractClassInstantiationError,ArgumentError,AssertionError,CastError,ConcurrentModificationError,CyclicInitializationError,Error,Exception,FallThroughError,FormatException,IntegerDivisionByZeroException,NoSuchMethodError,NullThrownError,OutOfMemoryError,RangeError,StackOverflowError,StateError,TypeError,UnimplementedError,UnsupportedError");
+var module$exports$Blockly$Dart={},module$contents$Blockly$Dart_Variables=$.module$build$src$core$variables,module$contents$Blockly$Dart_stringUtils=$.module$build$src$core$utils$string,module$contents$Blockly$Dart_CodeGenerator=$.CodeGenerator$$module$build$src$core$generator,module$contents$Blockly$Dart_Names=$.module$build$src$core$names.Names,module$contents$Blockly$Dart_NameType=$.NameType$$module$build$src$core$names,module$contents$Blockly$Dart_inputTypes=$.module$build$src$core$input_types.inputTypes;
+module$exports$Blockly$Dart.dartGenerator=new $.CodeGenerator$$module$build$src$core$generator("Dart");module$exports$Blockly$Dart.dartGenerator.addReservedWords("assert,break,case,catch,class,const,continue,default,do,else,enum,extends,false,final,finally,for,if,in,is,new,null,rethrow,return,super,switch,this,throw,true,try,var,void,while,with,print,identityHashCode,identical,BidirectionalIterator,Comparable,double,Function,int,Invocation,Iterable,Iterator,List,Map,Match,num,Pattern,RegExp,Set,StackTrace,String,StringSink,Type,bool,DateTime,Deprecated,Duration,Expando,Null,Object,RuneIterator,Runes,Stopwatch,StringBuffer,Symbol,Uri,Comparator,AbstractClassInstantiationError,ArgumentError,AssertionError,CastError,ConcurrentModificationError,CyclicInitializationError,Error,Exception,FallThroughError,FormatException,IntegerDivisionByZeroException,NoSuchMethodError,NullThrownError,OutOfMemoryError,RangeError,StackOverflowError,StateError,TypeError,UnimplementedError,UnsupportedError");
 module$exports$Blockly$Dart.dartGenerator.ORDER_ATOMIC=0;module$exports$Blockly$Dart.dartGenerator.ORDER_UNARY_POSTFIX=1;module$exports$Blockly$Dart.dartGenerator.ORDER_UNARY_PREFIX=2;module$exports$Blockly$Dart.dartGenerator.ORDER_MULTIPLICATIVE=3;module$exports$Blockly$Dart.dartGenerator.ORDER_ADDITIVE=4;module$exports$Blockly$Dart.dartGenerator.ORDER_SHIFT=5;module$exports$Blockly$Dart.dartGenerator.ORDER_BITWISE_AND=6;module$exports$Blockly$Dart.dartGenerator.ORDER_BITWISE_XOR=7;
 module$exports$Blockly$Dart.dartGenerator.ORDER_BITWISE_OR=8;module$exports$Blockly$Dart.dartGenerator.ORDER_RELATIONAL=9;module$exports$Blockly$Dart.dartGenerator.ORDER_EQUALITY=10;module$exports$Blockly$Dart.dartGenerator.ORDER_LOGICAL_AND=11;module$exports$Blockly$Dart.dartGenerator.ORDER_LOGICAL_OR=12;module$exports$Blockly$Dart.dartGenerator.ORDER_IF_NULL=13;module$exports$Blockly$Dart.dartGenerator.ORDER_CONDITIONAL=14;module$exports$Blockly$Dart.dartGenerator.ORDER_CASCADE=15;
 module$exports$Blockly$Dart.dartGenerator.ORDER_ASSIGNMENT=16;module$exports$Blockly$Dart.dartGenerator.ORDER_NONE=99;module$exports$Blockly$Dart.dartGenerator.isInitialized=!1;