blockly 9.2.1 → 9.3.0

package/core/field_image.d.ts

@@ -4,12 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { Field, FieldConfig } from './field.js';
-import type { Sentinel } from './utils/sentinel.js';
 import { Size } from './utils/size.js';
 /**
  * Class for an image on a block.
- *
- * @alias Blockly.FieldImage
  */
 export declare class FieldImage extends Field<string> {
     /**
@@ -38,7 +35,6 @@ export declare class FieldImage extends Field<string> {
     private flipRtl_;
     /** Alt text of this image. */
     private altText_;
-    value_: any;
     /**
      * @param src The URL of the image.
      *     Also accepts Field.SKIP_SETUP if you wish to skip setup (only used by
@@ -46,16 +42,16 @@ export declare class FieldImage extends Field<string> {
      * after their own constructors have run).
      * @param width Width of the image.
      * @param height Height of the image.
-     * @param opt_alt Optional alt text for when block is collapsed.
-     * @param opt_onClick Optional function to be called when the image is
-     *     clicked. If opt_onClick is defined, opt_alt must also be defined.
-     * @param opt_flipRtl Whether to flip the icon in RTL.
-     * @param opt_config A map of options used to configure the field.
+     * @param alt Optional alt text for when block is collapsed.
+     * @param onClick Optional function to be called when the image is
+     *     clicked. If onClick is defined, alt must also be defined.
+     * @param flipRtl Whether to flip the icon in RTL.
+     * @param config A map of options used to configure the field.
      *     See the [field creation documentation]{@link
      * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/image#creation}
      * for a list of properties this parameter supports.
      */
-    constructor(src: string | Sentinel, width: string | number, height: string | number, opt_alt?: string, opt_onClick?: (p1: FieldImage) => any, opt_flipRtl?: boolean, opt_config?: FieldImageConfig);
+    constructor(src: string | typeof Field.SKIP_SETUP, width: string | number, height: string | number, alt?: string, onClick?: (p1: FieldImage) => void, flipRtl?: boolean, config?: FieldImageConfig);
     /**
      * Configure the field based on the given map of options.
      *
@@ -72,17 +68,17 @@ export declare class FieldImage extends Field<string> {
     /**
      * Ensure that the input value (the source URL) is a string.
      *
-     * @param opt_newValue The input value.
+     * @param newValue The input value.
      * @returns A string, or null if invalid.
      */
-    protected doClassValidation_(opt_newValue?: any): string | null;
+    protected doClassValidation_(newValue?: any): string | null;
     /**
      * Update the value of this image field, and update the displayed image.
      *
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a string.
      */
-    protected doValueUpdate_(newValue: any): void;
+    protected doValueUpdate_(newValue: string): void;
     /**
      * Get whether to flip this image in RTL
      *
@@ -106,7 +102,7 @@ export declare class FieldImage extends Field<string> {
      * @param func The function that is called when the image is clicked, or null
      *     to remove.
      */
-    setOnClickHandler(func: ((p1: FieldImage) => any) | null): void;
+    setOnClickHandler(func: ((p1: FieldImage) => void) | null): void;
     /**
      * Use the `getText_` developer hook to override the field's text
      * representation.

package/core/field_input.d.ts

@@ -5,16 +5,20 @@
  */
 import './events/events_block_change.js';
 import { Field, FieldConfig, FieldValidator } from './field.js';
-import type { Sentinel } from './utils/sentinel.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
-export type InputTypes = string | number;
-export type FieldInputValidator<T extends InputTypes> = FieldValidator<T>;
 /**
- * Class for an editable text field.
+ * Supported types for FieldInput subclasses.
  *
- * @alias Blockly.FieldInput
+ * @internal
  */
-export declare abstract class FieldInput<T extends InputTypes> extends Field<T> {
+type InputTypes = string | number;
+/**
+ * Abstract class for an editable input field.
+ *
+ * @typeParam T - The value stored on the field.
+ * @internal
+ */
+export declare abstract class FieldInput<T extends InputTypes> extends Field<string | T> {
     /**
      * Pixel size of input border radius.
      * Should match blocklyText's border-radius in CSS.
@@ -48,34 +52,24 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<T>
     SERIALIZABLE: boolean;
     /** Mouse cursor style when over the hotspot that initiates the editor. */
     CURSOR: string;
-    clickTarget_: any;
-    value_: any;
-    isDirty_: any;
     /**
-     * @param opt_value The initial value of the field. Should cast to a string.
+     * @param value The initial value of the field. Should cast to a string.
      *     Defaults to an empty string if null or undefined. Also accepts
      *     Field.SKIP_SETUP if you wish to skip setup (only used by subclasses
      *     that want to handle configuration and setting the field value after
      *     their own constructors have run).
-     * @param opt_validator A function that is called to validate changes to the
+     * @param validator A function that is called to validate changes to the
      *     field's value. Takes in a string & returns a validated string, or null
      *     to abort the change.
-     * @param opt_config A map of options used to configure the field.
+     * @param config A map of options used to configure the field.
      *     See the [field creation documentation]{@link
      * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/text-input#creation}
      * for a list of properties this parameter supports.
      */
-    constructor(opt_value?: string | Sentinel, opt_validator?: FieldInputValidator<T> | null, opt_config?: FieldInputConfig);
+    constructor(value?: string | typeof Field.SKIP_SETUP, validator?: FieldInputValidator<T> | null, config?: FieldInputConfig);
     protected configure_(config: FieldInputConfig): void;
     /** @internal */
     initView(): void;
-    /**
-     * Ensure that the input value casts to a valid string.
-     *
-     * @param opt_newValue The input value.
-     * @returns A valid string, or null if invalid.
-     */
-    protected doClassValidation_(opt_newValue?: any): any;
     /**
      * Called by setValue if the text input is not valid. If the field is
      * currently being edited it reverts value of the field to the previous
@@ -94,7 +88,7 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<T>
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a string.
      */
-    protected doValueUpdate_(newValue: any): void;
+    protected doValueUpdate_(newValue: string | T): void;
     /**
      * Updates text field to match the colour/style of the block.
      *
@@ -118,12 +112,12 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<T>
      * Shows a prompt editor for mobile browsers if the modalInputs option is
      * enabled.
      *
-     * @param _opt_e Optional mouse event that triggered the field to open, or
+     * @param _e Optional mouse event that triggered the field to open, or
      *     undefined if triggered programmatically.
-     * @param opt_quietInput True if editor should be created without focus.
+     * @param quietInput True if editor should be created without focus.
      *     Defaults to false.
      */
-    protected showEditor_(_opt_e?: Event, opt_quietInput?: boolean): void;
+    protected showEditor_(_e?: Event, quietInput?: boolean): void;
     /**
      * Create and show a text input editor that is a prompt (usually a popup).
      * Mobile browsers may have issues with in-line textareas (focus and
@@ -166,7 +160,7 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<T>
      *
      * @param e Keyboard event.
      */
-    protected onHtmlInputKeyDown_(e: Event): void;
+    protected onHtmlInputKeyDown_(e: KeyboardEvent): void;
     /**
      * Handle a change to the editor.
      *
@@ -222,8 +216,28 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<T>
 }
 /**
  * Config options for the input field.
+ *
+ * @internal
  */
 export interface FieldInputConfig extends FieldConfig {
     spellcheck?: boolean;
 }
+/**
+ * A function that is called to validate changes to the field's value before
+ * they are set.
+ *
+ * @see {@link https://developers.google.com/blockly/guides/create-custom-blocks/fields/validators#return_values}
+ * @param newValue The value to be validated.
+ * @returns One of three instructions for setting the new value: `T`, `null`,
+ * or `undefined`.
+ *
+ * - `T` to set this function's returned value instead of `newValue`.
+ *
+ * - `null` to invoke `doValueInvalid_` and not set a value.
+ *
+ * - `undefined` to set `newValue` as is.
+ * @internal
+ */
+export type FieldInputValidator<T extends InputTypes> = FieldValidator<string | T>;
+export {};
 //# sourceMappingURL=field_input.d.ts.map

package/core/field_label.d.ts

@@ -4,14 +4,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { Field, FieldConfig } from './field.js';
-import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for a non-editable, non-serializable text field.
- *
- * @alias Blockly.FieldLabel
  */
 export declare class FieldLabel extends Field<string> {
-    /** The html class name to use for this field. */
+    /** The HTML class name to use for this field. */
     private class_;
     /**
      * Editable fields usually show some sort of UI indicating they are
@@ -19,18 +16,18 @@ export declare class FieldLabel extends Field<string> {
      */
     EDITABLE: boolean;
     /**
-     * @param opt_value The initial value of the field. Should cast to a string.
+     * @param value The initial value of the field. Should cast to a string.
      *     Defaults to an empty string if null or undefined. Also accepts
      *     Field.SKIP_SETUP if you wish to skip setup (only used by subclasses
      *     that want to handle configuration and setting the field value after
      *     their own constructors have run).
-     * @param opt_class Optional CSS class for the field's text.
-     * @param opt_config A map of options used to configure the field.
+     * @param textClass Optional CSS class for the field's text.
+     * @param config A map of options used to configure the field.
      *    See the [field creation documentation]{@link
      * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label#creation}
      * for a list of properties this parameter supports.
      */
-    constructor(opt_value?: string | Sentinel, opt_class?: string, opt_config?: FieldLabelConfig);
+    constructor(value?: string | typeof Field.SKIP_SETUP, textClass?: string, config?: FieldLabelConfig);
     protected configure_(config: FieldLabelConfig): void;
     /**
      * Create block UI for this label.
@@ -41,10 +38,10 @@ export declare class FieldLabel extends Field<string> {
     /**
      * Ensure that the input value casts to a valid string.
      *
-     * @param opt_newValue The input value.
+     * @param newValue The input value.
      * @returns A valid string, or null if invalid.
      */
-    protected doClassValidation_(opt_newValue?: any): string | null;
+    protected doClassValidation_(newValue?: any): string | null;
     /**
      * Set the CSS class applied to the field's textElement_.
      *

package/core/field_label_serializable.d.ts

@@ -6,8 +6,6 @@
 import { FieldLabel, FieldLabelConfig, FieldLabelFromJsonConfig } from './field_label.js';
 /**
  * Class for a non-editable, serializable text field.
- *
- * @alias Blockly.FieldLabelSerializable
  */
 export declare class FieldLabelSerializable extends FieldLabel {
     /**
@@ -22,15 +20,15 @@ export declare class FieldLabelSerializable extends FieldLabel {
      */
     SERIALIZABLE: boolean;
     /**
-     * @param opt_value The initial value of the field. Should cast to a string.
+     * @param value The initial value of the field. Should cast to a string.
      *     Defaults to an empty string if null or undefined.
-     * @param opt_class Optional CSS class for the field's text.
-     * @param opt_config A map of options used to configure the field.
+     * @param textClass Optional CSS class for the field's text.
+     * @param config A map of options used to configure the field.
      *    See the [field creation documentation]{@link
      * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label-serializable#creation}
      * for a list of properties this parameter supports.
      */
-    constructor(opt_value?: string, opt_class?: string, opt_config?: FieldLabelConfig);
+    constructor(value?: string, textClass?: string, config?: FieldLabelConfig);
     /**
      * Construct a FieldLabelSerializable from a JSON arg object,
      * dereferencing any string table references.

package/core/field_multilineinput.d.ts

@@ -3,20 +3,17 @@
  * Copyright 2019 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { Field } from './field.js';
 import { FieldTextInput, FieldTextInputConfig, FieldTextInputValidator } from './field_textinput.js';
-import type { Sentinel } from './utils/sentinel.js';
-export type FieldMultilineInputValidator = FieldTextInputValidator;
 /**
  * Class for an editable text area field.
- *
- * @alias Blockly.FieldMultilineInput
  */
 export declare class FieldMultilineInput extends FieldTextInput {
     /**
      * The SVG group element that will contain a text element for each text row
      *     when initialized.
      */
-    textGroup_: SVGGElement;
+    textGroup: SVGGElement | null;
     /**
      * Defines the maximum number of lines of field.
      * If exceeded, scrolling functionality is enabled.
@@ -25,21 +22,26 @@ export declare class FieldMultilineInput extends FieldTextInput {
     /** Whether Y overflow is currently occurring. */
     protected isOverflowedY_: boolean;
     /**
-     * @param opt_value The initial content of the field. Should cast to a string.
+     * @param value The initial content of the field. Should cast to a string.
      *     Defaults to an empty string if null or undefined. Also accepts
      *     Field.SKIP_SETUP if you wish to skip setup (only used by subclasses
      *     that want to handle configuration and setting the field value after
      *     their own constructors have run).
-     * @param opt_validator An optional function that is called to validate any
+     * @param validator An optional function that is called to validate any
      *     constraints on what the user entered.  Takes the new text as an
      *     argument and returns either the accepted text, a replacement text, or
      *     null to abort the change.
-     * @param opt_config A map of options used to configure the field.
+     * @param config A map of options used to configure the field.
      *     See the [field creation documentation]{@link
      * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/multiline-text-input#creation}
      * for a list of properties this parameter supports.
      */
-    constructor(opt_value?: string | Sentinel, opt_validator?: FieldMultilineInputValidator, opt_config?: FieldMultilineInputConfig);
+    constructor(value?: string | typeof Field.SKIP_SETUP, validator?: FieldMultilineInputValidator, config?: FieldMultilineInputConfig);
+    /**
+     * Configure the field based on the given map of options.
+     *
+     * @param config A map of options to configure the field based on.
+     */
     protected configure_(config: FieldMultilineInputConfig): void;
     /**
      * Serializes this field's value to XML. Should only be called by Blockly.Xml.
@@ -60,6 +62,8 @@ export declare class FieldMultilineInput extends FieldTextInput {
     fromXml(fieldElement: Element): void;
     /**
      * Saves this field's value.
+     * This function only exists for subclasses of FieldMultilineInput which
+     * predate the load/saveState API and only define to/fromXml.
      *
      * @returns The state of this field.
      * @internal
@@ -67,6 +71,8 @@ export declare class FieldMultilineInput extends FieldTextInput {
     saveState(): any;
     /**
      * Sets the field's value based on the given state.
+     * This function only exists for subclasses of FieldMultilineInput which
+     * predate the load/saveState API and only define to/fromXml.
      *
      * @param state The state of the variable to assign to this variable field.
      * @internal
@@ -94,7 +100,7 @@ export declare class FieldMultilineInput extends FieldTextInput {
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a string.
      */
-    protected doValueUpdate_(newValue: any): void;
+    protected doValueUpdate_(newValue: string): void;
     /** Updates the text of the textElement. */
     protected render_(): void;
     /** Updates the size of the field based on the text. */
@@ -104,12 +110,12 @@ export declare class FieldMultilineInput extends FieldTextInput {
      * Overrides the default behaviour to force rerender in order to
      * correct block size, based on editor text.
      *
-     * @param _opt_e Optional mouse event that triggered the field to open, or
+     * @param e Optional mouse event that triggered the field to open, or
      *     undefined if triggered programmatically.
-     * @param opt_quietInput True if editor should be created without focus.
+     * @param quietInput True if editor should be created without focus.
      *     Defaults to false.
      */
-    showEditor_(_opt_e?: Event, opt_quietInput?: boolean): void;
+    showEditor_(e?: Event, quietInput?: boolean): void;
     /**
      * Create the text input editor widget.
      *
@@ -135,7 +141,7 @@ export declare class FieldMultilineInput extends FieldTextInput {
      *
      * @param e Keyboard event.
      */
-    protected onHtmlInputKeyDown_(e: Event): void;
+    protected onHtmlInputKeyDown_(e: KeyboardEvent): void;
     /**
      * Construct a FieldMultilineInput from a JSON arg object,
      * dereferencing any string table references.
@@ -159,4 +165,20 @@ export interface FieldMultilineInputConfig extends FieldTextInputConfig {
 export interface FieldMultilineInputFromJsonConfig extends FieldMultilineInputConfig {
     text?: string;
 }
+/**
+ * A function that is called to validate changes to the field's value before
+ * they are set.
+ *
+ * @see {@link https://developers.google.com/blockly/guides/create-custom-blocks/fields/validators#return_values}
+ * @param newValue The value to be validated.
+ * @returns One of three instructions for setting the new value: `T`, `null`,
+ * or `undefined`.
+ *
+ * - `T` to set this function's returned value instead of `newValue`.
+ *
+ * - `null` to invoke `doValueInvalid_` and not set a value.
+ *
+ * - `undefined` to set `newValue` as is.
+ */
+export type FieldMultilineInputValidator = FieldTextInputValidator;
 //# sourceMappingURL=field_multilineinput.d.ts.map

package/core/field_number.d.ts

@@ -3,13 +3,10 @@
  * Copyright 2016 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { Field } from './field.js';
 import { FieldInput, FieldInputConfig, FieldInputValidator } from './field_input.js';
-import type { Sentinel } from './utils/sentinel.js';
-export type FieldNumberValidator = FieldInputValidator<number>;
 /**
  * Class for an editable number field.
- *
- * @alias Blockly.FieldNumber
  */
 export declare class FieldNumber extends FieldInput<number> {
     /** The minimum value this number field can contain. */
@@ -23,33 +20,28 @@ export declare class FieldNumber extends FieldInput<number> {
      * decimal digits.
      */
     private decimalPlaces_;
-    /**
-     * Serializable fields are saved by the serializer, non-serializable fields
-     * are not. Editable fields should also be serializable.
-     */
-    SERIALIZABLE: boolean;
     /** Don't spellcheck numbers.  Our validator does a better job. */
     protected spellcheck_: boolean;
     /**
-     * @param opt_value The initial value of the field. Should cast to a number.
+     * @param value The initial value of the field. Should cast to a number.
      *     Defaults to 0. Also accepts Field.SKIP_SETUP if you wish to skip setup
      *     (only used by subclasses that want to handle configuration and setting
      *     the field value after their own constructors have run).
-     * @param opt_min Minimum value. Will only be used if opt_config is not
+     * @param min Minimum value. Will only be used if config is not
      *     provided.
-     * @param opt_max Maximum value. Will only be used if opt_config is not
+     * @param max Maximum value. Will only be used if config is not
      *     provided.
-     * @param opt_precision Precision for value. Will only be used if opt_config
+     * @param precision Precision for value. Will only be used if config
      *     is not provided.
-     * @param opt_validator A function that is called to validate changes to the
+     * @param validator A function that is called to validate changes to the
      *     field's value. Takes in a number & returns a validated number, or null
      *     to abort the change.
-     * @param opt_config A map of options used to configure the field.
+     * @param config A map of options used to configure the field.
      *     See the [field creation documentation]{@link
      * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/number#creation}
      * for a list of properties this parameter supports.
      */
-    constructor(opt_value?: string | number | Sentinel, opt_min?: string | number | null, opt_max?: string | number | null, opt_precision?: string | number | null, opt_validator?: FieldNumberValidator | null, opt_config?: FieldNumberConfig);
+    constructor(value?: string | number | typeof Field.SKIP_SETUP, min?: string | number | null, max?: string | number | null, precision?: string | number | null, validator?: FieldNumberValidator | null, config?: FieldNumberConfig);
     /**
      * Configure the field based on the given map of options.
      *
@@ -138,16 +130,16 @@ export declare class FieldNumber extends FieldInput<number> {
      * Ensure that the input value is a valid number (must fulfill the
      * constraints placed on the field).
      *
-     * @param opt_newValue The input value.
+     * @param newValue The input value.
      * @returns A valid number, or null if invalid.
      */
-    protected doClassValidation_(opt_newValue?: any): number | null;
+    protected doClassValidation_(newValue?: any): number | null;
     /**
      * Create the number input editor widget.
      *
      * @returns The newly created number input editor.
      */
-    protected widgetCreate_(): HTMLElement;
+    protected widgetCreate_(): HTMLInputElement;
     /**
      * Construct a FieldNumber from a JSON arg object.
      *
@@ -172,4 +164,20 @@ export interface FieldNumberConfig extends FieldInputConfig {
 export interface FieldNumberFromJsonConfig extends FieldNumberConfig {
     value?: number;
 }
+/**
+ * A function that is called to validate changes to the field's value before
+ * they are set.
+ *
+ * @see {@link https://developers.google.com/blockly/guides/create-custom-blocks/fields/validators#return_values}
+ * @param newValue The value to be validated.
+ * @returns One of three instructions for setting the new value: `T`, `null`,
+ * or `undefined`.
+ *
+ * - `T` to set this function's returned value instead of `newValue`.
+ *
+ * - `null` to invoke `doValueInvalid_` and not set a value.
+ *
+ * - `undefined` to set `newValue` as is.
+ */
+export type FieldNumberValidator = FieldInputValidator<number>;
 //# sourceMappingURL=field_number.d.ts.map

package/core/field_registry.d.ts

@@ -18,14 +18,12 @@ interface RegistryOptions {
  *     construct an instance of the field.
  * @throws {Error} if the type name is empty, the field is already registered,
  *     or the fieldClass is not an object containing a fromJson function.
- * @alias Blockly.fieldRegistry.register
  */
 export declare function register(type: string, fieldClass: FieldProto): void;
 /**
  * Unregisters the field registered with the given type.
  *
  * @param type The field type name as used in the JSON definition.
- * @alias Blockly.fieldRegistry.unregister
  */
 export declare function unregister(type: string): void;
 /**
@@ -37,7 +35,6 @@ export declare function unregister(type: string): void;
  *     type.
  * @returns The new field instance or null if a field wasn't found with the
  *     given type name
- * @alias Blockly.fieldRegistry.fromJson
  * @internal
  */
 export declare function fromJson<T>(options: RegistryOptions): Field<T> | null;

package/core/field_textinput.d.ts

@@ -4,25 +4,34 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import './events/events_block_change.js';
+import { Field } from './field.js';
 import { FieldInput, FieldInputConfig, FieldInputValidator } from './field_input.js';
-import type { Sentinel } from './utils/sentinel.js';
-export type FieldTextInputValidator = FieldInputValidator<string>;
+/**
+ * Class for an editable text field.
+ */
 export declare class FieldTextInput extends FieldInput<string> {
     /**
-     * @param opt_value The initial value of the field. Should cast to a string.
+     * @param value The initial value of the field. Should cast to a string.
      *     Defaults to an empty string if null or undefined. Also accepts
      *     Field.SKIP_SETUP if you wish to skip setup (only used by subclasses
      *     that want to handle configuration and setting the field value after
      *     their own constructors have run).
-     * @param opt_validator A function that is called to validate changes to the
+     * @param validator A function that is called to validate changes to the
      *     field's value. Takes in a string & returns a validated string, or null
      *     to abort the change.
-     * @param opt_config A map of options used to configure the field.
+     * @param config A map of options used to configure the field.
      *     See the [field creation documentation]{@link
      * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/text-input#creation}
      * for a list of properties this parameter supports.
      */
-    constructor(opt_value?: string | Sentinel, opt_validator?: FieldTextInputValidator | null, opt_config?: FieldInputConfig);
+    constructor(value?: string | typeof Field.SKIP_SETUP, validator?: FieldTextInputValidator | null, config?: FieldTextInputConfig);
+    /**
+     * Ensure that the input value casts to a valid string.
+     *
+     * @param newValue The input value.
+     * @returns A valid string, or null if invalid.
+     */
+    protected doClassValidation_(newValue?: any): string | null;
     /**
      * Construct a FieldTextInput from a JSON arg object,
      * dereferencing any string table references.
@@ -34,11 +43,30 @@ export declare class FieldTextInput extends FieldInput<string> {
      */
     static fromJson(options: FieldTextInputFromJsonConfig): FieldTextInput;
 }
+/**
+ *  Config options for the text input field.
+ */
+export type FieldTextInputConfig = FieldInputConfig;
 /**
  * fromJson config options for the text input field.
  */
-export interface FieldTextInputFromJsonConfig extends FieldInputConfig {
+export interface FieldTextInputFromJsonConfig extends FieldTextInputConfig {
     text?: string;
 }
-export { FieldInputConfig as FieldTextInputConfig };
+/**
+ * A function that is called to validate changes to the field's value before
+ * they are set.
+ *
+ * @see {@link https://developers.google.com/blockly/guides/create-custom-blocks/fields/validators#return_values}
+ * @param newValue The value to be validated.
+ * @returns One of three instructions for setting the new value: `T`, `null`,
+ * or `undefined`.
+ *
+ * - `T` to set this function's returned value instead of `newValue`.
+ *
+ * - `null` to invoke `doValueInvalid_` and not set a value.
+ *
+ * - `undefined` to set `newValue` as is.
+ */
+export type FieldTextInputValidator = FieldInputValidator<string>;
 //# sourceMappingURL=field_textinput.d.ts.map