blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/events/events_var_delete.d.ts

@@ -4,32 +4,41 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { VariableModel } from '../variable_model.js';
-import { VarBase } from './events_var_base.js';
+import { VarBase, VarBaseJson } from './events_var_base.js';
 /**
  * Class for a variable deletion event.
+ *
  * @alias Blockly.Events.VarDelete
  */
 export declare class VarDelete extends VarBase {
     type: string;
-    varType: string;
-    varName: string;
+    varType?: string;
+    varName?: string;
     /**
      * @param opt_variable The deleted variable. Undefined for a blank event.
      */
     constructor(opt_variable?: VariableModel);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): VarDeleteJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: VarDeleteJson): void;
     /**
      * Run a variable deletion event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+export interface VarDeleteJson extends VarBaseJson {
+    varType: string;
+    varName: string;
+}
+//# sourceMappingURL=events_var_delete.d.ts.map

package/core/events/events_var_rename.d.ts

@@ -4,15 +4,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { VariableModel } from '../variable_model.js';
-import { VarBase } from './events_var_base.js';
+import { VarBase, VarBaseJson } from './events_var_base.js';
 /**
  * Class for a variable rename event.
+ *
  * @alias Blockly.Events.VarRename
  */
 export declare class VarRename extends VarBase {
     type: string;
-    oldName: string;
-    newName: string;
+    oldName?: string;
+    newName?: string;
     /**
      * @param opt_variable The renamed variable. Undefined for a blank event.
      * @param newName The new name the variable will be changed to.
@@ -20,17 +21,25 @@ export declare class VarRename extends VarBase {
     constructor(opt_variable?: VariableModel, newName?: string);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): VarRenameJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: VarRenameJson): void;
     /**
      * Run a variable rename event.
+     *
      * @param forward True if run forward, false if run backward (undo).
      */
     run(forward: boolean): void;
 }
+export interface VarRenameJson extends VarBaseJson {
+    oldName: string;
+    newName: string;
+}
+//# sourceMappingURL=events_var_rename.d.ts.map

package/core/events/events_viewport.d.ts

@@ -3,9 +3,11 @@
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
  * Class for a viewport change event.
+ *
  * @alias Blockly.Events.ViewportChange
  */
 export declare class ViewportChange extends UiBase {
@@ -28,12 +30,21 @@ export declare class ViewportChange extends UiBase {
     constructor(opt_top?: number, opt_left?: number, opt_scale?: number, opt_workspaceId?: string, opt_oldScale?: number);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): ViewportChangeJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: ViewportChangeJson): void;
 }
+export interface ViewportChangeJson extends AbstractEventJson {
+    viewTop: number;
+    viewLeft: number;
+    scale: number;
+    oldScale: number;
+}
+//# sourceMappingURL=events_viewport.d.ts.map

package/core/events/utils.d.ts

@@ -12,143 +12,171 @@ import type { CommentCreate } from './events_comment_create.js';
 import type { CommentMove } from './events_comment_move.js';
 /**
  * Sets whether events should be added to the undo stack.
+ *
  * @param newValue True if events should be added to the undo stack.
  * @alias Blockly.Events.utils.setRecordUndo
  */
 export declare function setRecordUndo(newValue: boolean): void;
 /**
  * Returns whether or not events will be added to the undo stack.
+ *
  * @returns True if events will be added to the undo stack.
  * @alias Blockly.Events.utils.getRecordUndo
  */
 export declare function getRecordUndo(): boolean;
 /**
  * Name of event that creates a block. Will be deprecated for BLOCK_CREATE.
+ *
  * @alias Blockly.Events.utils.CREATE
  */
 export declare const CREATE = "create";
 /**
  * Name of event that creates a block.
+ *
  * @alias Blockly.Events.utils.BLOCK_CREATE
  */
 export declare const BLOCK_CREATE = "create";
 /**
  * Name of event that deletes a block. Will be deprecated for BLOCK_DELETE.
+ *
  * @alias Blockly.Events.utils.DELETE
  */
 export declare const DELETE = "delete";
 /**
  * Name of event that deletes a block.
+ *
  * @alias Blockly.Events.utils.BLOCK_DELETE
  */
 export declare const BLOCK_DELETE = "delete";
 /**
  * Name of event that changes a block. Will be deprecated for BLOCK_CHANGE.
+ *
  * @alias Blockly.Events.utils.CHANGE
  */
 export declare const CHANGE = "change";
 /**
  * Name of event that changes a block.
+ *
  * @alias Blockly.Events.utils.BLOCK_CHANGE
  */
 export declare const BLOCK_CHANGE = "change";
 /**
  * Name of event that moves a block. Will be deprecated for BLOCK_MOVE.
+ *
  * @alias Blockly.Events.utils.MOVE
  */
 export declare const MOVE = "move";
 /**
  * Name of event that moves a block.
+ *
  * @alias Blockly.Events.utils.BLOCK_MOVE
  */
 export declare const BLOCK_MOVE = "move";
 /**
  * Name of event that creates a variable.
+ *
  * @alias Blockly.Events.utils.VAR_CREATE
  */
 export declare const VAR_CREATE = "var_create";
 /**
  * Name of event that deletes a variable.
+ *
  * @alias Blockly.Events.utils.VAR_DELETE
  */
 export declare const VAR_DELETE = "var_delete";
 /**
  * Name of event that renames a variable.
+ *
  * @alias Blockly.Events.utils.VAR_RENAME
  */
 export declare const VAR_RENAME = "var_rename";
 /**
  * Name of generic event that records a UI change.
+ *
  * @alias Blockly.Events.utils.UI
  */
 export declare const UI = "ui";
 /**
  * Name of event that record a block drags a block.
+ *
  * @alias Blockly.Events.utils.BLOCK_DRAG
  */
 export declare const BLOCK_DRAG = "drag";
 /**
  * Name of event that records a change in selected element.
+ *
  * @alias Blockly.Events.utils.SELECTED
  */
 export declare const SELECTED = "selected";
 /**
  * Name of event that records a click.
+ *
  * @alias Blockly.Events.utils.CLICK
  */
 export declare const CLICK = "click";
 /**
  * Name of event that records a marker move.
+ *
  * @alias Blockly.Events.utils.MARKER_MOVE
  */
 export declare const MARKER_MOVE = "marker_move";
 /**
  * Name of event that records a bubble open.
+ *
  * @alias Blockly.Events.utils.BUBBLE_OPEN
  */
 export declare const BUBBLE_OPEN = "bubble_open";
 /**
  * Name of event that records a trashcan open.
+ *
  * @alias Blockly.Events.utils.TRASHCAN_OPEN
  */
 export declare const TRASHCAN_OPEN = "trashcan_open";
 /**
  * Name of event that records a toolbox item select.
+ *
  * @alias Blockly.Events.utils.TOOLBOX_ITEM_SELECT
  */
 export declare const TOOLBOX_ITEM_SELECT = "toolbox_item_select";
 /**
  * Name of event that records a theme change.
+ *
  * @alias Blockly.Events.utils.THEME_CHANGE
  */
 export declare const THEME_CHANGE = "theme_change";
 /**
  * Name of event that records a viewport change.
+ *
  * @alias Blockly.Events.utils.VIEWPORT_CHANGE
  */
 export declare const VIEWPORT_CHANGE = "viewport_change";
 /**
  * Name of event that creates a comment.
+ *
  * @alias Blockly.Events.utils.COMMENT_CREATE
  */
 export declare const COMMENT_CREATE = "comment_create";
 /**
  * Name of event that deletes a comment.
+ *
  * @alias Blockly.Events.utils.COMMENT_DELETE
  */
 export declare const COMMENT_DELETE = "comment_delete";
 /**
  * Name of event that changes a comment.
+ *
  * @alias Blockly.Events.utils.COMMENT_CHANGE
  */
 export declare const COMMENT_CHANGE = "comment_change";
 /**
  * Name of event that moves a comment.
+ *
  * @alias Blockly.Events.utils.COMMENT_MOVE
  */
 export declare const COMMENT_MOVE = "comment_move";
 /**
  * Name of event that records a workspace load.
+ *
  * @alias Blockly.Events.utils.FINISHED_LOADING
  */
 export declare const FINISHED_LOADING = "finished_loading";
@@ -158,6 +186,7 @@ export declare const FINISHED_LOADING = "finished_loading";
  *
  * Not to be confused with bumping so that disconnected connections do not
  * appear connected.
+ *
  * @alias Blockly.Events.utils.BumpEvent
  */
 export declare type BumpEvent = BlockCreate | BlockMove | CommentCreate | CommentMove;
@@ -167,11 +196,13 @@ export declare type BumpEvent = BlockCreate | BlockMove | CommentCreate | Commen
  *
  * Not to be confused with bumping so that disconnected connections do not
  * appear connected.
+ *
  * @alias Blockly.Events.utils.BUMP_EVENTS
  */
 export declare const BUMP_EVENTS: string[];
 /**
  * Create a custom event and fire it.
+ *
  * @param event Custom data for event.
  * @alias Blockly.Events.utils.fire
  */
@@ -184,43 +215,50 @@ declare function fireInternal(event: Abstract): void;
 declare function fireNow(): void;
 /**
  * Filter the queued events and merge duplicates.
+ *
  * @param queueIn Array of events.
  * @param forward True if forward (redo), false if backward (undo).
- * @return Array of filtered events.
+ * @returns Array of filtered events.
  * @alias Blockly.Events.utils.filter
  */
 export declare function filter(queueIn: Abstract[], forward: boolean): Abstract[];
 /**
  * Modify pending undo events so that when they are fired they don't land
  * in the undo stack.  Called by Workspace.clearUndo.
+ *
  * @alias Blockly.Events.utils.clearPendingUndo
  */
 export declare function clearPendingUndo(): void;
 /**
  * Stop sending events.  Every call to this function MUST also call enable.
+ *
  * @alias Blockly.Events.utils.disable
  */
 export declare function disable(): void;
 /**
  * Start sending events.  Unless events were already disabled when the
  * corresponding call to disable was made.
+ *
  * @alias Blockly.Events.utils.enable
  */
 export declare function enable(): void;
 /**
  * Returns whether events may be fired or not.
- * @return True if enabled.
+ *
+ * @returns True if enabled.
  * @alias Blockly.Events.utils.isEnabled
  */
 export declare function isEnabled(): boolean;
 /**
  * Current group.
- * @return ID string.
+ *
+ * @returns ID string.
  * @alias Blockly.Events.utils.getGroup
  */
 export declare function getGroup(): string;
 /**
  * Start or stop a group.
+ *
  * @param state True to start new group, false to end group.
  *   String to set group explicitly.
  * @alias Blockly.Events.utils.setGroup
@@ -232,33 +270,37 @@ export declare function setGroup(state: boolean | string): void;
 declare function setGroupInternal(state: boolean | string): void;
 /**
  * Compute a list of the IDs of the specified block and all its descendants.
+ *
  * @param block The root block.
- * @return List of block IDs.
+ * @returns List of block IDs.
  * @alias Blockly.Events.utils.getDescendantIds
  * @internal
  */
 export declare function getDescendantIds(block: Block): string[];
 /**
  * Decode the JSON into an event.
+ *
  * @param json JSON representation.
  * @param workspace Target workspace for event.
- * @return The event represented by the JSON.
+ * @returns The event represented by the JSON.
  * @throws {Error} if an event type is not found in the registry.
  * @alias Blockly.Events.utils.fromJson
  */
 export declare function fromJson(json: any, workspace: Workspace): Abstract;
 /**
  * Gets the class for a specific event type from the registry.
+ *
  * @param eventType The type of the event to get.
- * @return The event class with the given type or null if none exists.
+ * @returns The event class with the given type.
  * @alias Blockly.Events.utils.get
  */
-export declare function get(eventType: string): (new (...p1: any[]) => Abstract) | null;
+export declare function get(eventType: string): (new (...p1: any[]) => Abstract);
 /**
  * Enable/disable a block depending on whether it is properly connected.
  * Use this on applications where all blocks should be connected to a top block.
  * Recommend setting the 'disable' option to 'false' in the config so that
  * users don't try to re-enable disabled orphan blocks.
+ *
  * @param event Custom data for event.
  * @alias Blockly.Events.utils.disableOrphans
  */
@@ -270,3 +312,4 @@ export declare const TEST_ONLY: {
     setGroupInternal: typeof setGroupInternal;
 };
 export {};
+//# sourceMappingURL=utils.d.ts.map

package/core/events/workspace_events.d.ts

@@ -4,20 +4,19 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Workspace } from '../workspace.js';
-import { Abstract as AbstractEvent } from './events_abstract.js';
+import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 /**
  * Class for a finished loading event.
  * Used to notify the developer when the workspace has finished loading (i.e
  * domToWorkspace).
  * Finished loading events do not record undo or redo.
+ *
  * @alias Blockly.Events.FinishedLoading
  */
 export declare class FinishedLoading extends AbstractEvent {
     isBlank: boolean;
-    workspaceId: string;
     recordUndo: boolean;
     type: string;
-    group: any;
     /**
      * @param opt_workspace The workspace that has finished loading.  Undefined
      *     for a blank event.
@@ -25,12 +24,18 @@ export declare class FinishedLoading extends AbstractEvent {
     constructor(opt_workspace?: Workspace);
     /**
      * Encode the event as JSON.
-     * @return JSON representation.
+     *
+     * @returns JSON representation.
      */
-    toJson(): any;
+    toJson(): FinishedLoadingJson;
     /**
      * Decode the JSON event.
+     *
      * @param json JSON representation.
      */
-    fromJson(json: any): void;
+    fromJson(json: FinishedLoadingJson): void;
+}
+export interface FinishedLoadingJson extends AbstractEventJson {
+    workspaceId: string;
 }
+//# sourceMappingURL=workspace_events.d.ts.map

package/core/extensions.d.ts

@@ -12,6 +12,7 @@ export declare const TEST_ONLY: {
  * initialize blocks, usually adding dynamic behavior such as onchange
  * handlers and mutators. These are applied using Block.applyExtension(), or
  * the JSON "extensions" array attribute.
+ *
  * @param name The name of this extension.
  * @param initFn The function to initialize an extended block.
  * @throws {Error} if the extension name is empty, the extension is already
@@ -21,6 +22,7 @@ export declare const TEST_ONLY: {
 export declare function register(name: string, initFn: Function): void;
 /**
  * Registers a new extension function that adds all key/value of mixinObj.
+ *
  * @param name The name of this extension.
  * @param mixinObj The values to mix in.
  * @throws {Error} if the extension name is empty or the extension is already
@@ -33,6 +35,7 @@ export declare function registerMixin(name: string, mixinObj: any): void;
  * At register time this performs some basic sanity checks on the mutator.
  * The wrapper may also add a mutator dialog to the block, if both compose and
  * decompose are defined on the mixin.
+ *
  * @param name The name of this mutator extension.
  * @param mixinObj The values to mix in.
  * @param opt_helperFn An optional function to apply after mixing in the object.
@@ -44,20 +47,23 @@ export declare function registerMixin(name: string, mixinObj: any): void;
 export declare function registerMutator(name: string, mixinObj: any, opt_helperFn?: () => any, opt_blockList?: string[]): void;
 /**
  * Unregisters the extension registered with the given name.
+ *
  * @param name The name of the extension to unregister.
  * @alias Blockly.Extensions.unregister
  */
 export declare function unregister(name: string): void;
 /**
  * Returns whether an extension is registered with the given name.
+ *
  * @param name The name of the extension to check for.
- * @return True if the extension is registered.  False if it is not registered.
+ * @returns True if the extension is registered.  False if it is not registered.
  * @alias Blockly.Extensions.isRegistered
  */
 export declare function isRegistered(name: string): boolean;
 /**
  * Applies an extension method to a block. This should only be called during
  * block construction.
+ *
  * @param name The name of the extension.
  * @param block The block to apply the named extension to.
  * @param isMutator True if this extension defines a mutator.
@@ -67,11 +73,12 @@ export declare function isRegistered(name: string): boolean;
 export declare function apply(name: string, block: Block, isMutator: boolean): void;
 /**
  * Calls a function after the page has loaded, possibly immediately.
+ *
  * @param fn Function to run.
  * @throws Error Will throw if no global document can be found (e.g., Node.js).
  * @internal
  */
-export declare function runAfterPageLoad(fn: () => any): void;
+export declare function runAfterPageLoad(fn: () => void): void;
 /**
  * Builds an extension function that will map a dropdown value to a tooltip
  * string.
@@ -85,10 +92,11 @@ export declare function runAfterPageLoad(fn: () => any): void;
  * loading the first block of any given type, the extension will validate every
  * dropdown option has a matching tooltip in the lookupTable.  Errors are
  * reported as warnings in the console, and are never fatal.
+ *
  * @param dropdownName The name of the field whose value is the key to the
  *     lookup table.
  * @param lookupTable The table of field values to tooltip text.
- * @return The extension function.
+ * @returns The extension function.
  * @alias Blockly.Extensions.buildTooltipForDropdown
  */
 export declare function buildTooltipForDropdown(dropdownName: string, lookupTable: {
@@ -98,10 +106,12 @@ export declare function buildTooltipForDropdown(dropdownName: string, lookupTabl
  * Builds an extension function that will install a dynamic tooltip. The
  * tooltip message should include the string '%1' and that string will be
  * replaced with the text of the named field.
+ *
  * @param msgTemplate The template form to of the message text, with %1
  *     placeholder.
  * @param fieldName The field with the replacement text.
- * @return The extension function.
+ * @returns The extension function.
  * @alias Blockly.Extensions.buildTooltipWithFieldText
  */
 export declare function buildTooltipWithFieldText(msgTemplate: string, fieldName: string): Function;
+//# sourceMappingURL=extensions.d.ts.map