blockly 9.0.0-beta.0 → 9.0.0-beta.1

package/core/field_number.ts

@@ -1,327 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Number input field
- */
-
-/**
- * Number input field
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.FieldNumber');
-
-import {Field} from './field.js';
-import * as fieldRegistry from './field_registry.js';
-import {FieldTextInputConfig, FieldTextInput} from './field_textinput.js';
-import * as aria from './utils/aria.js';
-import type {Sentinel} from './utils/sentinel.js';
-
-
-/**
- * Class for an editable number field.
- * @alias Blockly.FieldNumber
- */
-export class FieldNumber extends FieldTextInput {
-  /** The minimum value this number field can contain. */
-  protected min_: number = -Infinity;
-
-  /** The maximum value this number field can contain. */
-  protected max_: number = Infinity;
-
-  /** The multiple to which this fields value is rounded. */
-  protected precision_ = 0;
-
-  /**
-   * The number of decimal places to allow, or null to allow any number of
-   * decimal digits.
-   */
-  private decimalPlaces_: number|null = null;
-
-  /**
-   * Serializable fields are saved by the serializer, non-serializable fields
-   * are not. Editable fields should also be serializable.
-   */
-  override SERIALIZABLE = true;
-
-  /**
-   * @param opt_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
-   *     provided.
-   * @param opt_max Maximum value. Will only be used if opt_config is not
-   *     provided.
-   * @param opt_precision Precision for value. Will only be used if opt_config
-   *     is not provided.
-   * @param opt_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.
-   *     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?: Function|null, opt_config?: FieldNumberConfig) {
-    // Pass SENTINEL so that we can define properties before value validation.
-    super(Field.SKIP_SETUP);
-
-    if (opt_value === Field.SKIP_SETUP) {
-      return;
-    }
-    if (opt_config) {
-      this.configure_(opt_config);
-    } else {
-      this.setConstraints(opt_min, opt_max, opt_precision);
-    }
-    this.setValue(opt_value);
-    if (opt_validator) {
-      this.setValidator(opt_validator);
-    }
-  }
-
-  /**
-   * Configure the field based on the given map of options.
-   * @param config A map of options to configure the field based on.
-   */
-  protected override configure_(config: FieldNumberConfig) {
-    super.configure_(config);
-    this.setMinInternal_(config.min);
-    this.setMaxInternal_(config.max);
-    this.setPrecisionInternal_(config.precision);
-  }
-
-  /**
-   * Set the maximum, minimum and precision constraints on this field.
-   * Any of these properties may be undefined or NaN to be disabled.
-   * Setting precision (usually a power of 10) enforces a minimum step between
-   * values. That is, the user's value will rounded to the closest multiple of
-   * precision. The least significant digit place is inferred from the
-   * precision. Integers values can be enforces by choosing an integer
-   * precision.
-   * @param min Minimum value.
-   * @param max Maximum value.
-   * @param precision Precision for value.
-   */
-  setConstraints(
-      min: number|string|undefined|null, max: number|string|undefined|null,
-      precision: number|string|undefined|null) {
-    this.setMinInternal_(min);
-    this.setMaxInternal_(max);
-    this.setPrecisionInternal_(precision);
-    this.setValue(this.getValue());
-  }
-
-  /**
-   * Sets the minimum value this field can contain. Updates the value to
-   * reflect.
-   * @param min Minimum value.
-   */
-  setMin(min: number|string|undefined|null) {
-    this.setMinInternal_(min);
-    this.setValue(this.getValue());
-  }
-
-  /**
-   * Sets the minimum value this field can contain. Called internally to avoid
-   * value updates.
-   * @param min Minimum value.
-   */
-  private setMinInternal_(min: number|string|undefined|null) {
-    if (min == null) {
-      this.min_ = -Infinity;
-    } else {
-      min = Number(min);
-      if (!isNaN(min)) {
-        this.min_ = min;
-      }
-    }
-  }
-
-  /**
-   * Returns the current minimum value this field can contain. Default is
-   * -Infinity.
-   * @return The current minimum value this field can contain.
-   */
-  getMin(): number {
-    return this.min_;
-  }
-
-  /**
-   * Sets the maximum value this field can contain. Updates the value to
-   * reflect.
-   * @param max Maximum value.
-   */
-  setMax(max: number|string|undefined|null) {
-    this.setMaxInternal_(max);
-    this.setValue(this.getValue());
-  }
-
-  /**
-   * Sets the maximum value this field can contain. Called internally to avoid
-   * value updates.
-   * @param max Maximum value.
-   */
-  private setMaxInternal_(max: number|string|undefined|null) {
-    if (max == null) {
-      this.max_ = Infinity;
-    } else {
-      max = Number(max);
-      if (!isNaN(max)) {
-        this.max_ = max;
-      }
-    }
-  }
-
-  /**
-   * Returns the current maximum value this field can contain. Default is
-   * Infinity.
-   * @return The current maximum value this field can contain.
-   */
-  getMax(): number {
-    return this.max_;
-  }
-
-  /**
-   * Sets the precision of this field's value, i.e. the number to which the
-   * value is rounded. Updates the field to reflect.
-   * @param precision The number to which the field's value is rounded.
-   */
-  setPrecision(precision: number|string|undefined|null) {
-    this.setPrecisionInternal_(precision);
-    this.setValue(this.getValue());
-  }
-
-  /**
-   * Sets the precision of this field's value. Called internally to avoid
-   * value updates.
-   * @param precision The number to which the field's value is rounded.
-   */
-  private setPrecisionInternal_(precision: number|string|undefined|null) {
-    this.precision_ = Number(precision) || 0;
-    let precisionString = String(this.precision_);
-    if (precisionString.indexOf('e') !== -1) {
-      // String() is fast.  But it turns .0000001 into '1e-7'.
-      // Use the much slower toLocaleString to access all the digits.
-      precisionString =
-          this.precision_.toLocaleString('en-US', {maximumFractionDigits: 20});
-    }
-    const decimalIndex = precisionString.indexOf('.');
-    if (decimalIndex === -1) {
-      // If the precision is 0 (float) allow any number of decimals,
-      // otherwise allow none.
-      this.decimalPlaces_ = precision ? 0 : null;
-    } else {
-      this.decimalPlaces_ = precisionString.length - decimalIndex - 1;
-    }
-  }
-
-  /**
-   * Returns the current precision of this field. The precision being the
-   * number to which the field's value is rounded. A precision of 0 means that
-   * the value is not rounded.
-   * @return The number to which this field's value is rounded.
-   */
-  getPrecision(): number {
-    return this.precision_;
-  }
-
-  /**
-   * Ensure that the input value is a valid number (must fulfill the
-   * constraints placed on the field).
-   * @param opt_newValue The input value.
-   * @return A valid number, or null if invalid.
-   */
-  protected override doClassValidation_(opt_newValue?: AnyDuringMigration):
-      number|null {
-    if (opt_newValue === null) {
-      return null;
-    }
-    // Clean up text.
-    let newValue = String(opt_newValue);
-    // TODO: Handle cases like 'ten', '1.203,14', etc.
-    // 'O' is sometimes mistaken for '0' by inexperienced users.
-    newValue = newValue.replace(/O/ig, '0');
-    // Strip out thousands separators.
-    newValue = newValue.replace(/,/g, '');
-    // Ignore case of 'Infinity'.
-    newValue = newValue.replace(/infinity/i, 'Infinity');
-
-    // Clean up number.
-    let n = Number(newValue || 0);
-    if (isNaN(n)) {
-      // Invalid number.
-      return null;
-    }
-    // Get the value in range.
-    n = Math.min(Math.max(n, this.min_), this.max_);
-    // Round to nearest multiple of precision.
-    if (this.precision_ && isFinite(n)) {
-      n = Math.round(n / this.precision_) * this.precision_;
-    }
-    // Clean up floating point errors.
-    if (this.decimalPlaces_ !== null) {
-      n = Number(n.toFixed(this.decimalPlaces_));
-    }
-    return n;
-  }
-
-  /**
-   * Create the number input editor widget.
-   * @return The newly created number input editor.
-   */
-  protected override widgetCreate_(): HTMLElement {
-    const htmlInput = super.widgetCreate_();
-
-    // Set the accessibility state
-    if (this.min_ > -Infinity) {
-      aria.setState(htmlInput, aria.State.VALUEMIN, this.min_);
-    }
-    if (this.max_ < Infinity) {
-      aria.setState(htmlInput, aria.State.VALUEMAX, this.max_);
-    }
-    return htmlInput;
-  }
-
-  /**
-   * Construct a FieldNumber from a JSON arg object.
-   * @param options A JSON object with options (value, min, max, and precision).
-   * @return The new field instance.
-   * @nocollapse
-   * @internal
-   */
-  static override fromJson(options: FieldNumberFromJsonConfig): FieldNumber {
-    // `this` might be a subclass of FieldNumber if that class doesn't override
-    // the static fromJson method.
-    return new this(
-        options.value, undefined, undefined, undefined, undefined, options);
-  }
-}
-
-fieldRegistry.register('field_number', FieldNumber);
-
-(FieldNumber.prototype as AnyDuringMigration).DEFAULT_VALUE = 0;
-
-/**
- * Config options for the number field.
- */
-export interface FieldNumberConfig extends FieldTextInputConfig {
-  min?: number;
-  max?: number;
-  precision?: number;
-}
-
-/**
- * fromJson config options for the number field.
- */
-export interface FieldNumberFromJsonConfig extends FieldNumberConfig {
-  value?: number;
-}

package/core/field_registry.ts

@@ -1,87 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Fields can be created based on a JSON definition. This file
- *    contains methods for registering those JSON definitions, and building the
- *    fields based on JSON.
- */
-
-/**
- * Fields can be created based on a JSON definition. This file
- *    contains methods for registering those JSON definitions, and building the
- *    fields based on JSON.
- * @namespace Blockly.fieldRegistry
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.fieldRegistry');
-
-import type {Field} from './field.js';
-import type {IRegistrableField} from './interfaces/i_registrable_field.js';
-import * as registry from './registry.js';
-
-
-/**
- * Registers a field type.
- * fieldRegistry.fromJson uses this registry to
- * find the appropriate field type.
- * @param type The field type name as used in the JSON definition.
- * @param fieldClass The field class containing a fromJson function that can
- *     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 function register(type: string, fieldClass: IRegistrableField) {
-  registry.register(registry.Type.FIELD, type, fieldClass);
-}
-
-/**
- * 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 function unregister(type: string) {
-  registry.unregister(registry.Type.FIELD, type);
-}
-
-/**
- * Construct a Field from a JSON arg object.
- * Finds the appropriate registered field by the type name as registered using
- * fieldRegistry.register.
- * @param options A JSON object with a type and options specific to the field
- *     type.
- * @return The new field instance or null if a field wasn't found with the given
- *     type name
- * @alias Blockly.fieldRegistry.fromJson
- * @internal
- */
-export function fromJson(options: AnyDuringMigration): Field|null {
-  return TEST_ONLY.fromJsonInternal(options);
-}
-
-/**
- * Private version of fromJson for stubbing in tests.
- */
-function fromJsonInternal(options: AnyDuringMigration): Field|null {
-  const fieldObject =
-      registry.getObject(registry.Type.FIELD, options['type']) as
-          IRegistrableField |
-      null;
-  if (!fieldObject) {
-    console.warn(
-        'Blockly could not create a field of type ' + options['type'] +
-        '. The field is probably not being registered. This could be because' +
-        ' the file is not loaded, the field does not register itself (Issue' +
-        ' #1584), or the registration is not being reached.');
-    return null;
-  }
-  return fieldObject.fromJson(options);
-}
-
-export const TEST_ONLY = {
-  fromJsonInternal,
-}