blockly 11.0.0-beta.5 → 11.0.0-beta.7

package/core/field_colour.d.ts

@@ -1,243 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Colour input field.
- *
- * @class
- */
-import './events/events_block_change.js';
-import { Field, FieldConfig, FieldValidator } from './field.js';
-import { Size } from './utils/size.js';
-/**
- * Class for a colour input field.
- */
-export declare class FieldColour extends Field<string> {
-    /**
-     * An array of colour strings for the palette.
-     * Copied from goog.ui.ColorPicker.SIMPLE_GRID_COLORS
-     * All colour pickers use this unless overridden with setColours.
-     */
-    static COLOURS: string[];
-    /**
-     * An array of tooltip strings for the palette.  If not the same length as
-     * COLOURS, the colour's hex code will be used for any missing titles.
-     * All colour pickers use this unless overridden with setColours.
-     */
-    static TITLES: string[];
-    /**
-     * Number of columns in the palette.
-     * All colour pickers use this unless overridden with setColumns.
-     */
-    static COLUMNS: number;
-    /** The field's colour picker element. */
-    private picker;
-    /** Index of the currently highlighted element. */
-    private highlightedIndex;
-    /**
-     * Array holding info needed to unbind events.
-     * Used for disposing.
-     * Ex: [[node, name, func], [node, name, func]].
-     */
-    private boundEvents;
-    /**
-     * Serializable fields are saved by the serializer, non-serializable fields
-     * are not. Editable fields should also be serializable.
-     */
-    SERIALIZABLE: boolean;
-    /** Mouse cursor style when over the hotspot that initiates the editor. */
-    CURSOR: string;
-    /**
-     * Used to tell if the field needs to be rendered the next time the block is
-     * rendered. Colour fields are statically sized, and only need to be
-     * rendered at initialization.
-     */
-    protected isDirty_: boolean;
-    /** Array of colours used by this field.  If null, use the global list. */
-    private colours;
-    /**
-     * Array of colour tooltips used by this field.  If null, use the global
-     * list.
-     */
-    private titles;
-    /**
-     * Number of colour columns used by this field.  If 0, use the global
-     * setting. By default use the global constants for columns.
-     */
-    private columns;
-    /**
-     * @param value The initial value of the field. Should be in '#rrggbb'
-     *     format. Defaults to the first value in the default colour array. 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 colour string & returns a validated colour
-     *     string ('#rrggbb' format), 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/colour}
-     * for a list of properties this parameter supports.
-     */
-    constructor(value?: string | typeof Field.SKIP_SETUP, validator?: FieldColourValidator, config?: FieldColourConfig);
-    /**
-     * 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: FieldColourConfig): void;
-    /**
-     * Create the block UI for this colour field.
-     */
-    initView(): void;
-    protected isFullBlockField(): boolean;
-    /**
-     * Updates text field to match the colour/style of the block.
-     */
-    applyColour(): void;
-    /**
-     * Returns the height and width of the field.
-     *
-     * This should *in general* be the only place render_ gets called from.
-     *
-     * @returns Height and width.
-     */
-    getSize(): Size;
-    /**
-     * Updates the colour of the block to reflect whether this is a full
-     * block field or not.
-     */
-    protected render_(): void;
-    /**
-     * Updates the size of the field based on whether it is a full block field
-     * or not.
-     *
-     * @param margin margin to use when positioning the field.
-     */
-    protected updateSize_(margin?: number): void;
-    /**
-     * Ensure that the input value is a valid colour.
-     *
-     * @param newValue The input value.
-     * @returns A valid colour, or null if invalid.
-     */
-    protected doClassValidation_(newValue?: any): string | null;
-    /**
-     * Get the text for this field.  Used when the block is collapsed.
-     *
-     * @returns Text representing the value of this field.
-     */
-    getText(): string;
-    /**
-     * Set a custom colour grid for this field.
-     *
-     * @param colours Array of colours for this block, or null to use default
-     *     (FieldColour.COLOURS).
-     * @param titles Optional array of colour tooltips, or null to use default
-     *     (FieldColour.TITLES).
-     * @returns Returns itself (for method chaining).
-     */
-    setColours(colours: string[], titles?: string[]): FieldColour;
-    /**
-     * Set a custom grid size for this field.
-     *
-     * @param columns Number of columns for this block, or 0 to use default
-     *     (FieldColour.COLUMNS).
-     * @returns Returns itself (for method chaining).
-     */
-    setColumns(columns: number): FieldColour;
-    /** Create and show the colour field's editor. */
-    protected showEditor_(): void;
-    /**
-     * Handle a click on a colour cell.
-     *
-     * @param e Mouse event.
-     */
-    private onClick;
-    /**
-     * Handle a key down event. Navigate around the grid with the
-     * arrow keys. Enter selects the highlighted colour.
-     *
-     * @param e Keyboard event.
-     */
-    private onKeyDown;
-    /**
-     * Move the currently highlighted position by dx and dy.
-     *
-     * @param dx Change of x.
-     * @param dy Change of y.
-     */
-    private moveHighlightBy;
-    /**
-     * Handle a mouse move event. Highlight the hovered colour.
-     *
-     * @param e Mouse event.
-     */
-    private onMouseMove;
-    /** Handle a mouse enter event. Focus the picker. */
-    private onMouseEnter;
-    /**
-     * Handle a mouse leave event. Blur the picker and unhighlight
-     * the currently highlighted colour.
-     */
-    private onMouseLeave;
-    /**
-     * Returns the currently highlighted item (if any).
-     *
-     * @returns Highlighted item (null if none).
-     */
-    private getHighlighted;
-    /**
-     * Update the currently highlighted cell.
-     *
-     * @param cell The new cell to highlight.
-     * @param index The index of the new cell.
-     */
-    private setHighlightedCell;
-    /** Create a colour picker dropdown editor. */
-    private dropdownCreate;
-    /** Disposes of events and DOM-references belonging to the colour editor. */
-    private dropdownDispose;
-    /**
-     * Construct a FieldColour from a JSON arg object.
-     *
-     * @param options A JSON object with options (colour).
-     * @returns The new field instance.
-     * @nocollapse
-     * @internal
-     */
-    static fromJson(options: FieldColourFromJsonConfig): FieldColour;
-}
-/**
- * Config options for the colour field.
- */
-export interface FieldColourConfig extends FieldConfig {
-    colourOptions?: string[];
-    colourTitles?: string[];
-    columns?: number;
-}
-/**
- * fromJson config options for the colour field.
- */
-export interface FieldColourFromJsonConfig extends FieldColourConfig {
-    colour?: 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 FieldColourValidator = FieldValidator<string>;
-//# sourceMappingURL=field_colour.d.ts.map

package/core/field_multilineinput.d.ts

@@ -1,182 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { Field } from './field.js';
-import { FieldTextInput, FieldTextInputConfig, FieldTextInputValidator } from './field_textinput.js';
-/**
- * Class for an editable text area field.
- */
-export declare class FieldMultilineInput extends FieldTextInput {
-    /**
-     * The SVG group element that will contain a text element for each text row
-     *     when initialized.
-     */
-    textGroup: SVGGElement | null;
-    /**
-     * Defines the maximum number of lines of field.
-     * If exceeded, scrolling functionality is enabled.
-     */
-    protected maxLines_: number;
-    /** Whether Y overflow is currently occurring. */
-    protected isOverflowedY_: boolean;
-    /**
-     * @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 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 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(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.
-     *
-     * @param fieldElement The element to populate with info about the field's
-     *     state.
-     * @returns The element containing info about the field's state.
-     * @internal
-     */
-    toXml(fieldElement: Element): Element;
-    /**
-     * Sets the field's value based on the given XML element. Should only be
-     * called by Blockly.Xml.
-     *
-     * @param fieldElement The element containing info about the field's state.
-     * @internal
-     */
-    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
-     */
-    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
-     */
-    loadState(state: any): void;
-    /**
-     * Create the block UI for this field.
-     */
-    initView(): void;
-    /**
-     * Get the text from this field as displayed on screen.  May differ from
-     * getText due to ellipsis, and other formatting.
-     *
-     * @returns Currently displayed text.
-     */
-    protected getDisplayText_(): string;
-    /**
-     * Called by setValue if the text input is valid. Updates the value of the
-     * field, and updates the text of the field if it is not currently being
-     * edited (i.e. handled by the htmlInput_). Is being redefined here to update
-     * overflow state of the field.
-     *
-     * @param newValue The value to be saved. The default validator guarantees
-     *     that this is a string.
-     */
-    protected doValueUpdate_(newValue: string): void;
-    /** Updates the text of the textElement. */
-    protected render_(): void;
-    /** Updates the size of the field based on the text. */
-    protected updateSize_(): void;
-    /**
-     * Show the inline free-text editor on top of the text.
-     * Overrides the default behaviour to force rerender in order to
-     * correct block size, based on editor text.
-     *
-     * @param e Optional mouse event that triggered the field to open, or
-     *     undefined if triggered programmatically.
-     * @param quietInput True if editor should be created without focus.
-     *     Defaults to false.
-     */
-    showEditor_(e?: Event, quietInput?: boolean): void;
-    /**
-     * Create the text input editor widget.
-     *
-     * @returns The newly created text input editor.
-     */
-    protected widgetCreate_(): HTMLTextAreaElement;
-    /**
-     * Sets the maxLines config for this field.
-     *
-     * @param maxLines Defines the maximum number of lines allowed, before
-     *     scrolling functionality is enabled.
-     */
-    setMaxLines(maxLines: number): void;
-    /**
-     * Returns the maxLines config of this field.
-     *
-     * @returns The maxLines config value.
-     */
-    getMaxLines(): number;
-    /**
-     * Handle key down to the editor. Override the text input definition of this
-     * so as to not close the editor when enter is typed in.
-     *
-     * @param e Keyboard event.
-     */
-    protected onHtmlInputKeyDown_(e: KeyboardEvent): void;
-    /**
-     * Construct a FieldMultilineInput 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 fromJson(options: FieldMultilineInputFromJsonConfig): FieldMultilineInput;
-}
-/**
- * Config options for the multiline input field.
- */
-export interface FieldMultilineInputConfig extends FieldTextInputConfig {
-    maxLines?: number;
-}
-/**
- * fromJson config options for the multiline input field.
- */
-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/interfaces/i_block_dragger.d.ts

@@ -1,47 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { Coordinate } from '../utils/coordinate.js';
-import type { BlockSvg } from '../block_svg.js';
-/**
- * A block dragger interface.
- */
-export interface IBlockDragger {
-    /**
-     * Start dragging a block.
-     *
-     * @param currentDragDeltaXY How far the pointer has moved from the position
-     *     at mouse down, in pixel units.
-     * @param healStack Whether or not to heal the stack after disconnecting.
-     */
-    startDrag(currentDragDeltaXY: Coordinate, healStack: boolean): void;
-    /**
-     * Execute a step of block dragging, based on the given event.  Update the
-     * display accordingly.
-     *
-     * @param e The most recent move event.
-     * @param currentDragDeltaXY How far the pointer has moved from the position
-     *     at the start of the drag, in pixel units.
-     */
-    drag(e: Event, currentDragDeltaXY: Coordinate): void;
-    /**
-     * Finish a block drag and put the block back on the workspace.
-     *
-     * @param e The mouseup/touchend event.
-     * @param currentDragDeltaXY How far the pointer has moved from the position
-     *     at the start of the drag, in pixel units.
-     */
-    endDrag(e: Event, currentDragDeltaXY: Coordinate): void;
-    /**
-     * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
-     * or 2 insertion markers.
-     *
-     * @returns A possibly empty list of insertion marker blocks.
-     */
-    getInsertionMarkers(): BlockSvg[];
-    /** Sever all links from this object and do any necessary cleanup. */
-    dispose(): void;
-}
-//# sourceMappingURL=i_block_dragger.d.ts.map

package/core/renderers/minimalist/constants.d.ts

@@ -1,21 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { ConstantProvider as BaseConstantProvider } from '../common/constants.js';
-/**
- * An object that provides constants for rendering blocks in the minimalist
- * renderer.
- *
- * @deprecated Use Blockly.blockRendering.ConstantProvider instead.
- *     To be removed in v11.
- */
-export declare class ConstantProvider extends BaseConstantProvider {
-    /**
-     * @deprecated Use Blockly.blockRendering.ConstantProvider instead.
-     *     To be removed in v11.
-     */
-    constructor();
-}
-//# sourceMappingURL=constants.d.ts.map

package/core/renderers/minimalist/drawer.d.ts

@@ -1,26 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { BlockSvg } from '../../block_svg.js';
-import { Drawer as BaseDrawer } from '../common/drawer.js';
-import type { RenderInfo } from './info.js';
-/**
- * An object that draws a block based on the given rendering information.
- *
- * @deprecated Use Blockly.blockRendering.Drawer instead.
- *     To be removed in v11.
- */
-export declare class Drawer extends BaseDrawer {
-    /**
-     * @param block The block to render.
-     * @param info An object containing all information needed to render this
-     *     block.
-     *
-     * @deprecated Use Blockly.blockRendering.Drawer instead.
-     *     To be removed in v11.
-     */
-    constructor(block: BlockSvg, info: RenderInfo);
-}
-//# sourceMappingURL=drawer.d.ts.map

package/core/renderers/minimalist/info.d.ts

@@ -1,35 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { BlockSvg } from '../../block_svg.js';
-import { RenderInfo as BaseRenderInfo } from '../common/info.js';
-import type { Renderer } from './renderer.js';
-/**
- * An object containing all sizing information needed to draw this block.
- *
- * This measure pass does not propagate changes to the block (although fields
- * may choose to rerender when getSize() is called).  However, calling it
- * repeatedly may be expensive.
- *
- * @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
- *     in v11.
- */
-export declare class RenderInfo extends BaseRenderInfo {
-    protected renderer_: Renderer;
-    /**
-     * @param renderer The renderer in use.
-     * @param block The block to measure.
-     * @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
-     *     in v11.
-     */
-    constructor(renderer: Renderer, block: BlockSvg);
-    /**
-     * Get the block renderer in use.
-     *
-     * @returns The block renderer in use.
-     */
-    getRenderer(): Renderer;
-}
-//# sourceMappingURL=info.d.ts.map

package/core/renderers/minimalist/minimalist.d.ts

@@ -1,12 +0,0 @@
-/** @file Re-exports of Blockly.minimalist.* modules. */
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { ConstantProvider } from './constants.js';
-import { Drawer } from './drawer.js';
-import { RenderInfo } from './info.js';
-import { Renderer } from './renderer.js';
-export { ConstantProvider, Drawer, Renderer, RenderInfo };
-//# sourceMappingURL=minimalist.d.ts.map

package/core/renderers/minimalist/renderer.d.ts

@@ -1,48 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import type { BlockSvg } from '../../block_svg.js';
-import type { RenderInfo as BaseRenderInfo } from '../common/info.js';
-import { Renderer as BaseRenderer } from '../common/renderer.js';
-import { ConstantProvider } from './constants.js';
-import { Drawer } from './drawer.js';
-import { RenderInfo } from './info.js';
-/**
- * The minimalist renderer.
- *
- * @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
- *     in v11.
- */
-export declare class Renderer extends BaseRenderer {
-    /**
-     * @param name The renderer name.
-     * @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
-     *     in v11.
-     */
-    constructor(name: string);
-    /**
-     * Create a new instance of the renderer's constant provider.
-     *
-     * @returns The constant provider.
-     */
-    protected makeConstants_(): ConstantProvider;
-    /**
-     * Create a new instance of the renderer's render info object.
-     *
-     * @param block The block to measure.
-     * @returns The render info object.
-     */
-    protected makeRenderInfo_(block: BlockSvg): RenderInfo;
-    /**
-     * Create a new instance of the renderer's drawer.
-     *
-     * @param block The block to render.
-     * @param info An object containing all information needed to render this
-     *     block.
-     * @returns The drawer.
-     */
-    protected makeDrawer_(block: BlockSvg, info: BaseRenderInfo): Drawer;
-}
-//# sourceMappingURL=renderer.d.ts.map

package/core-browser.js

@@ -1,26 +0,0 @@
-/* eslint-disable */
-;(function(root, factory) {
-  if (typeof define === 'function' && define.amd) { // AMD
-    define(['./blockly'], factory);
-  } else if (typeof exports === 'object') { // Node.js
-    module.exports = factory(require('./blockly'));
-  } else { // Browser
-    root.Blockly = factory(root.Blockly);
-  }
-}(this, function(Blockly) {
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Blockly core module for the browser. It includes blockly.js
- *               and adds a helper method for setting the locale.
- */
-
-/* eslint-disable */
-'use strict';
-
-return Blockly;
-}));

package/core.js

@@ -1,26 +0,0 @@
-/* eslint-disable */
-(function (Blockly){
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Blockly core module for Node. It includes blockly-node.js
- *               and adds a helper method for setting the locale.
- */
-
-/* eslint-disable */
-'use strict';
-
-// Override textToDomDocument and provide Node.js alternatives to DOMParser and
-// XMLSerializer.
-if (typeof globalThis.document !== 'object') {
-  const {JSDOM} = require('jsdom');
-  const {window} = new JSDOM(`<!DOCTYPE html>`);
-  Blockly.utils.xml.injectDependencies(window);
-}
-
-module.exports = Blockly;
-})(require('./blockly'));