scratch-blocks 2.0.0-beta.1 → 2.0.0-spork.1

package/blockly-rc/core/field_registry.ts

@@ -1,115 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.fieldRegistry
-
-import type {Field, FieldConfig} from './field.js';
-import * as registry from './registry.js';
-
-/**
- * When constructing a field from JSON using the registry, the
- * `fromJson` method in this file is called with an options parameter
- * object consisting of the "type" which is the name of the field, and
- * other options that are part of the field's config object.
- *
- * These options are then passed to the field's static `fromJson`
- * method. That method accepts an options parameter with a type that usually
- * extends from FieldConfig, and may or may not have a "type" attribute (in
- * fact, it shouldn't, because we'd overwrite it as described above!)
- *
- * Unfortunately the registry has no way of knowing the actual Field subclass
- * that will be returned from passing in the name of the field. Therefore it
- * also has no way of knowing that the options object not only implements
- * `FieldConfig`, but it also should satisfy the Config that belongs to that
- * specific class's `fromJson` method.
- *
- * Because of this uncertainty, we just give up on type checking the properties
- * passed to the `fromJson` method, and allow arbitrary string keys with
- * unknown types.
- */
-type RegistryOptions = FieldConfig & {
-  // The name of the field, e.g. field_dropdown
-  type: string;
-  [key: string]: unknown;
-};
-
-/**
- * Represents the static methods that must be defined on any
- * field that is registered, i.e. the constructor and fromJson methods.
- *
- * Because we don't know which Field subclass will be registered, we
- * are unable to typecheck the parameters of the constructor.
- */
-export interface RegistrableField {
-  new (...args: any[]): Field;
-  fromJson(options: FieldConfig): Field;
-}
-
-/**
- * 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.
- */
-export function register(type: string, fieldClass: RegistrableField) {
-  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.
- */
-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.
- * @returns The new field instance or null if a field wasn't found with the
- *     given type name
- * @internal
- */
-export function fromJson<T>(options: RegistryOptions): Field<T> | null {
-  return TEST_ONLY.fromJsonInternal(options);
-}
-
-/**
- * Private version of fromJson for stubbing in tests.
- *
- * @param options
- */
-function fromJsonInternal<T>(options: RegistryOptions): Field<T> | null {
-  const fieldObject = registry.getObject(
-    registry.Type.FIELD,
-    options.type,
-  ) as unknown as RegistrableField;
-  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,
-};

package/blockly-rc/core/field_textinput.ts

@@ -1,117 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * Text input field.
- *
- * @class
- */
-// Former goog.module ID: Blockly.FieldTextInput
-
-// Unused import preserved for side-effects. Remove if unneeded.
-import './events/events_block_change.js';
-
-import {Field} from './field.js';
-import {
-  FieldInput,
-  FieldInputConfig,
-  FieldInputValidator,
-} from './field_input.js';
-import * as fieldRegistry from './field_registry.js';
-import * as parsing from './utils/parsing.js';
-
-/**
- * Class for an editable text field.
- */
-export class FieldTextInput extends FieldInput<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 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 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(
-    value?: string | typeof Field.SKIP_SETUP,
-    validator?: FieldTextInputValidator | null,
-    config?: FieldTextInputConfig,
-  ) {
-    super(value, validator, config);
-  }
-
-  /**
-   * Ensure that the input value casts to a valid string.
-   *
-   * @param newValue The input value.
-   * @returns A valid string, or null if invalid.
-   */
-  protected override doClassValidation_(
-    newValue?: AnyDuringMigration,
-  ): string | null {
-    if (newValue === undefined) {
-      return null;
-    }
-    return `${newValue}`;
-  }
-
-  /**
-   * Construct a FieldTextInput from a JSON arg object,
-   * dereferencing any string table references.
-   *
-   * @param options A JSON object with options (text, and spellcheck).
-   * @returns The new field instance.
-   * @nocollapse
-   * @internal
-   */
-  static override fromJson(
-    options: FieldTextInputFromJsonConfig,
-  ): FieldTextInput {
-    const text = parsing.replaceMessageReferences(options.text);
-    // `this` might be a subclass of FieldTextInput if that class doesn't
-    // override the static fromJson method.
-    return new this(text, undefined, options);
-  }
-}
-
-fieldRegistry.register('field_input', FieldTextInput);
-
-FieldTextInput.prototype.DEFAULT_VALUE = '';
-
-/**
- *  Config options for the text input field.
- */
-export type FieldTextInputConfig = FieldInputConfig;
-
-/**
- * fromJson config options for the text input field.
- */
-export interface FieldTextInputFromJsonConfig extends FieldTextInputConfig {
-  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 FieldTextInputValidator = FieldInputValidator<string>;