blockly 9.0.0 → 9.0.1

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/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/package.json

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