blockly 12.4.0 → 12.4.1

package/core/utils/size.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Utility methods for size calculation.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ *
+ * @class
+ */
+/**
+ * Class for representing sizes consisting of a width and height.
+ */
+export declare class Size {
+    width: number;
+    height: number;
+    /**
+     * @param width Width.
+     * @param height Height.
+     */
+    constructor(width: number, height: number);
+    /**
+     * Compares sizes for equality.
+     *
+     * @param a A Size.
+     * @param b A Size.
+     * @returns True iff the sizes have equal widths and equal heights, or if both
+     *     are null.
+     */
+    static equals(a?: Size | null, b?: Size | null): boolean;
+    /**
+     * Returns a new size with the maximum width and height values out of both
+     * sizes.
+     */
+    static max(a: Size, b: Size): Size;
+    /**
+     * Returns a new size with the minimum width and height values out of both
+     * sizes.
+     */
+    static min(a: Size, b: Size): Size;
+}
+//# sourceMappingURL=size.d.ts.map

package/core/utils/string.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Given an array of strings, return the length of the shortest one.
+ *
+ * @param array Array of strings.
+ * @returns Length of shortest string.
+ */
+export declare function shortestStringLength(array: string[]): number;
+/**
+ * Given an array of strings, return the length of the common prefix.
+ * Words may not be split.  Any space after a word is included in the length.
+ *
+ * @param array Array of strings.
+ * @param opt_shortest Length of shortest string.
+ * @returns Length of common prefix.
+ */
+export declare function commonWordPrefix(array: string[], opt_shortest?: number): number;
+/**
+ * Given an array of strings, return the length of the common suffix.
+ * Words may not be split.  Any space after a word is included in the length.
+ *
+ * @param array Array of strings.
+ * @param opt_shortest Length of shortest string.
+ * @returns Length of common suffix.
+ */
+export declare function commonWordSuffix(array: string[], opt_shortest?: number): number;
+/**
+ * Wrap text to the specified width.
+ *
+ * @param text Text to wrap.
+ * @param limit Width to wrap each line.
+ * @returns Wrapped text.
+ */
+export declare function wrap(text: string, limit: number): string;
+/**
+ * Is the given string a number (includes negative and decimals).
+ *
+ * @param str Input string.
+ * @returns True if number, false otherwise.
+ */
+export declare function isNumber(str: string): boolean;
+//# sourceMappingURL=string.d.ts.map

package/core/utils/style.d.ts

@@ -0,0 +1,89 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Coordinate } from './coordinate.js';
+import { Rect } from './rect.js';
+import { Size } from './size.js';
+/**
+ * Gets the height and width of an element.
+ * Similar to Closure's goog.style.getSize
+ *
+ * @param element Element to get size of.
+ * @returns Object with width/height properties.
+ */
+export declare function getSize(element: Element): Size;
+/**
+ * Private version of getSize for stubbing in tests.
+ */
+declare function getSizeInternal(element: Element): Size;
+/**
+ * Retrieves a computed style value of a node. It returns empty string
+ * if the property requested is an SVG one and it has not been
+ * explicitly set (firefox and webkit).
+ *
+ * Copied from Closure's goog.style.getComputedStyle
+ *
+ * @param element Element to get style of.
+ * @param property Property to get (camel-case).
+ * @returns Style value.
+ */
+export declare function getComputedStyle(element: Element, property: string): string;
+/**
+ * Returns a Coordinate object relative to the top-left of the HTML document.
+ * Similar to Closure's goog.style.getPageOffset
+ *
+ * @param el Element to get the page offset for.
+ * @returns The page offset.
+ */
+export declare function getPageOffset(el: Element): Coordinate;
+/**
+ * Calculates the viewport coordinates relative to the document.
+ * Similar to Closure's goog.style.getViewportPageOffset
+ *
+ * @returns The page offset of the viewport.
+ */
+export declare function getViewportPageOffset(): Coordinate;
+/**
+ * Gets the computed border widths (on all sides) in pixels
+ * Copied from Closure's goog.style.getBorderBox
+ *
+ * @param element  The element to get the border widths for.
+ * @returns The computed border widths.
+ */
+export declare function getBorderBox(element: Element): Rect;
+/**
+ * Changes the scroll position of `container` with the minimum amount so
+ * that the content and the borders of the given `element` become visible.
+ * If the element is bigger than the container, its top left corner will be
+ * aligned as close to the container's top left corner as possible.
+ * Copied from Closure's goog.style.scrollIntoContainerView
+ *
+ * @param element The element to make visible.
+ * @param container The container to scroll. If not set, then the document
+ *     scroll element will be used.
+ * @param opt_center Whether to center the element in the container.
+ *     Defaults to false.
+ */
+export declare function scrollIntoContainerView(element: Element, container: Element, opt_center?: boolean): void;
+/**
+ * Calculate the scroll position of `container` with the minimum amount so
+ * that the content and the borders of the given `element` become visible.
+ * If the element is bigger than the container, its top left corner will be
+ * aligned as close to the container's top left corner as possible.
+ * Copied from Closure's goog.style.getContainerOffsetToScrollInto
+ *
+ * @param element The element to make visible.
+ * @param container The container to scroll. If not set, then the document
+ *     scroll element will be used.
+ * @param opt_center Whether to center the element in the container.
+ *     Defaults to false.
+ * @returns The new scroll position of the container.
+ */
+export declare function getContainerOffsetToScrollInto(element: Element, container: Element, opt_center?: boolean): Coordinate;
+export declare const TEST_ONLY: {
+    getSizeInternal: typeof getSizeInternal;
+};
+export {};
+//# sourceMappingURL=style.d.ts.map

package/core/utils/svg.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Defines the Svg class. Its constants enumerate
+ * all SVG tag names used by Blockly.
+ *
+ * @class
+ */
+/**
+ * A name with the type of the SVG element stored in the generic.
+ */
+export declare class Svg<_T> {
+    private readonly tagName;
+    /** @internal */
+    static ANIMATE: Svg<SVGAnimateElement>;
+    /** @internal */
+    static CIRCLE: Svg<SVGCircleElement>;
+    /** @internal */
+    static CLIPPATH: Svg<SVGClipPathElement>;
+    /** @internal */
+    static DEFS: Svg<SVGDefsElement>;
+    /** @internal */
+    static FECOMPOSITE: Svg<SVGFECompositeElement>;
+    /** @internal */
+    static FECOMPONENTTRANSFER: Svg<SVGFEComponentTransferElement>;
+    /** @internal */
+    static FEFLOOD: Svg<SVGFEFloodElement>;
+    /** @internal */
+    static FEFUNCA: Svg<SVGFEFuncAElement>;
+    /** @internal */
+    static FEGAUSSIANBLUR: Svg<SVGFEGaussianBlurElement>;
+    /** @internal */
+    static FEPOINTLIGHT: Svg<SVGFEPointLightElement>;
+    /** @internal */
+    static FESPECULARLIGHTING: Svg<SVGFESpecularLightingElement>;
+    /** @internal */
+    static FILTER: Svg<SVGFilterElement>;
+    /** @internal */
+    static FOREIGNOBJECT: Svg<SVGForeignObjectElement>;
+    /** @internal */
+    static G: Svg<SVGGElement>;
+    /** @internal */
+    static IMAGE: Svg<SVGImageElement>;
+    /** @internal */
+    static LINE: Svg<SVGLineElement>;
+    /** @internal */
+    static PATH: Svg<SVGPathElement>;
+    /** @internal */
+    static PATTERN: Svg<SVGPatternElement>;
+    /** @internal */
+    static POLYGON: Svg<SVGPolygonElement>;
+    /** @internal */
+    static RECT: Svg<SVGRectElement>;
+    /** @internal */
+    static SVG: Svg<SVGSVGElement>;
+    /** @internal */
+    static TEXT: Svg<SVGTextElement>;
+    /** @internal */
+    static TSPAN: Svg<SVGTSpanElement>;
+    /**
+     * @param tagName The SVG element tag name.
+     * @internal
+     */
+    constructor(tagName: string);
+    /**
+     * Returns the SVG element tag name.
+     *
+     * @returns The name.
+     */
+    toString(): string;
+}
+//# sourceMappingURL=svg.d.ts.map

package/core/utils/svg_math.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { WorkspaceSvg } from '../workspace_svg.js';
+import { Coordinate } from './coordinate.js';
+import { Rect } from './rect.js';
+/**
+ * Return the coordinates of the top-left corner of this element relative to
+ * its parent.  Only for SVG elements and children (e.g. rect, g, path).
+ *
+ * @param element SVG element to find the coordinates of.
+ * @returns Object with .x and .y properties.
+ */
+export declare function getRelativeXY(element: Element): Coordinate;
+/**
+ * Return the coordinates of the top-left corner of this element relative to
+ * the div Blockly was injected into.
+ *
+ * @param element SVG element to find the coordinates of. If this is not a child
+ *     of the div Blockly was injected into, the behaviour is undefined.
+ * @returns Object with .x and .y properties.
+ */
+export declare function getInjectionDivXY(element: Element): Coordinate;
+/**
+ * Get the position of the current viewport in window coordinates.  This takes
+ * scroll into account.
+ *
+ * @returns An object containing window width, height, and scroll position in
+ *     window coordinates.
+ * @internal
+ */
+export declare function getViewportBBox(): Rect;
+/**
+ * Gets the document scroll distance as a coordinate object.
+ * Copied from Closure's goog.dom.getDocumentScroll.
+ *
+ * @returns Object with values 'x' and 'y'.
+ */
+export declare function getDocumentScroll(): Coordinate;
+/**
+ * Converts screen coordinates to workspace coordinates.
+ *
+ * @param ws The workspace to find the coordinates on.
+ * @param screenCoordinates The screen coordinates to be converted to workspace
+ *     coordinates
+ * @returns The workspace coordinates.
+ */
+export declare function screenToWsCoordinates(ws: WorkspaceSvg, screenCoordinates: Coordinate): Coordinate;
+/**
+ * Converts workspace coordinates to screen coordinates.
+ *
+ * @param ws The workspace to get the coordinates out of.
+ * @param workspaceCoordinates  The workspace coordinates to be converted
+ *     to screen coordinates.
+ * @returns The screen coordinates.
+ */
+export declare function wsToScreenCoordinates(ws: WorkspaceSvg, workspaceCoordinates: Coordinate): Coordinate;
+export declare const TEST_ONLY: {
+    XY_REGEX: RegExp;
+    XY_STYLE_REGEX: RegExp;
+};
+//# sourceMappingURL=svg_math.d.ts.map

package/core/utils/svg_paths.d.ts

@@ -0,0 +1,103 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Create a string representing the given x, y pair.  It does not matter whether
+ * the coordinate is relative or absolute.  The result has leading
+ * and trailing spaces, and separates the x and y coordinates with a comma but
+ * no space.
+ *
+ * @param x The x coordinate.
+ * @param y The y coordinate.
+ * @returns A string of the format ' x,y '
+ */
+export declare function point(x: number, y: number): string;
+/**
+ * Draw a cubic or quadratic curve.  See
+ * developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d#Cubic_B%C3%A9zier_Curve
+ * These coordinates are unitless and hence in the user coordinate system.
+ *
+ * @param command The command to use.
+ *     Should be one of: c, C, s, S, q, Q.
+ * @param points  An array containing all of the points to pass to the curve
+ *     command, in order.  The points are represented as strings of the format '
+ *     x, y '.
+ * @returns A string defining one or more Bezier curves.  See the MDN
+ *     documentation for exact format.
+ */
+export declare function curve(command: string, points: string[]): string;
+/**
+ * Move the cursor to the given position without drawing a line.
+ * The coordinates are absolute.
+ * These coordinates are unitless and hence in the user coordinate system.
+ * See developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#Line_commands
+ *
+ * @param x The absolute x coordinate.
+ * @param y The absolute y coordinate.
+ * @returns A string of the format ' M x,y '
+ */
+export declare function moveTo(x: number, y: number): string;
+/**
+ * Move the cursor to the given position without drawing a line.
+ * Coordinates are relative.
+ * These coordinates are unitless and hence in the user coordinate system.
+ * See developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#Line_commands
+ *
+ * @param dx The relative x coordinate.
+ * @param dy The relative y coordinate.
+ * @returns A string of the format ' m dx,dy '
+ */
+export declare function moveBy(dx: number, dy: number): string;
+/**
+ * Draw a line from the current point to the end point, which is the current
+ * point shifted by dx along the x-axis and dy along the y-axis.
+ * These coordinates are unitless and hence in the user coordinate system.
+ * See developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#Line_commands
+ *
+ * @param dx The relative x coordinate.
+ * @param dy The relative y coordinate.
+ * @returns A string of the format ' l dx,dy '
+ */
+export declare function lineTo(dx: number, dy: number): string;
+/**
+ * Draw multiple lines connecting all of the given points in order.  This is
+ * equivalent to a series of 'l' commands.
+ * These coordinates are unitless and hence in the user coordinate system.
+ * See developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#Line_commands
+ *
+ * @param points An array containing all of the points to draw lines to, in
+ *     order.  The points are represented as strings of the format ' dx,dy '.
+ * @returns A string of the format ' l (dx,dy)+ '
+ */
+export declare function line(points: string[]): string;
+/**
+ * Draw a horizontal or vertical line.
+ * The first argument specifies the direction and whether the given position is
+ * relative or absolute.
+ * These coordinates are unitless and hence in the user coordinate system.
+ * See developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d#LineTo_path_commands
+ *
+ * @param command The command to prepend to the coordinate.  This should be one
+ *     of: V, v, H, h.
+ * @param val The coordinate to pass to the command.  It may be absolute or
+ *     relative.
+ * @returns A string of the format ' command val '
+ */
+export declare function lineOnAxis(command: string, val: number): string;
+/**
+ * Draw an elliptical arc curve.
+ * These coordinates are unitless and hence in the user coordinate system.
+ * See developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d#Elliptical_Arc_Curve
+ *
+ * @param command The command string.  Either 'a' or 'A'.
+ * @param flags The flag string.  See the MDN documentation for a description
+ *     and examples.
+ * @param radius The radius of the arc to draw.
+ * @param point The point to move the cursor to after drawing the arc, specified
+ *     either in absolute or relative coordinates depending on the command.
+ * @returns A string of the format 'command radius radius flags point'
+ */
+export declare function arc(command: string, flags: string, radius: number, point: string): string;
+//# sourceMappingURL=svg_paths.d.ts.map

package/core/utils/toolbox.d.ts

@@ -0,0 +1,180 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ConnectionState } from '../serialization/blocks.js';
+import type { CssConfig as CategoryCssConfig } from '../toolbox/category.js';
+import type { CssConfig as SeparatorCssConfig } from '../toolbox/separator.js';
+/**
+ * The information needed to create a block in the toolbox.
+ * Note that disabled has a different type for backwards compatibility.
+ */
+export interface BlockInfo {
+    kind: string;
+    blockxml?: string | Node;
+    type?: string;
+    gap?: string | number;
+    disabled?: string | boolean;
+    disabledReasons?: string[];
+    enabled?: boolean;
+    id?: string;
+    collapsed?: boolean;
+    inline?: boolean;
+    data?: string;
+    extraState?: any;
+    icons?: {
+        [key: string]: any;
+    };
+    fields?: {
+        [key: string]: any;
+    };
+    inputs?: {
+        [key: string]: ConnectionState;
+    };
+    next?: ConnectionState;
+}
+/**
+ * The information needed to create a separator in the toolbox.
+ */
+export interface SeparatorInfo {
+    kind: string;
+    id: string | undefined;
+    gap: number | undefined;
+    cssconfig: SeparatorCssConfig | undefined;
+}
+/**
+ * The information needed to create a button in the toolbox.
+ */
+export interface ButtonInfo {
+    kind: string;
+    text: string;
+    callbackkey: string;
+}
+/**
+ * The information needed to create a label in the toolbox.
+ */
+export interface LabelInfo {
+    kind: string;
+    text: string;
+    id: string | undefined;
+}
+/**
+ * The information needed to create either a button or a label in the flyout.
+ */
+export type ButtonOrLabelInfo = ButtonInfo | LabelInfo;
+/**
+ * The information needed to create a category in the toolbox.
+ */
+export interface StaticCategoryInfo {
+    kind: string;
+    name: string;
+    contents: ToolboxItemInfo[];
+    id: string | undefined;
+    categorystyle: string | undefined;
+    colour: string | undefined;
+    cssconfig: CategoryCssConfig | undefined;
+    hidden: string | undefined;
+    expanded?: string | boolean;
+}
+/**
+ * The information needed to create a custom category.
+ */
+export interface DynamicCategoryInfo {
+    kind: string;
+    custom: string;
+    id: string | undefined;
+    categorystyle: string | undefined;
+    colour: string | undefined;
+    cssconfig: CategoryCssConfig | undefined;
+    hidden: string | undefined;
+    expanded?: string | boolean;
+}
+/**
+ * The information needed to create either a dynamic or static category.
+ */
+export type CategoryInfo = StaticCategoryInfo | DynamicCategoryInfo;
+/**
+ * Any information that can be used to create an item in the toolbox.
+ */
+export type ToolboxItemInfo = FlyoutItemInfo | StaticCategoryInfo;
+/**
+ * All the different types that can be displayed in a flyout.
+ */
+export type FlyoutItemInfo = BlockInfo | SeparatorInfo | ButtonInfo | LabelInfo | DynamicCategoryInfo;
+/**
+ * The JSON definition of a toolbox.
+ */
+export interface ToolboxInfo {
+    kind?: string;
+    contents: ToolboxItemInfo[];
+}
+/**
+ * An array holding flyout items.
+ */
+export type FlyoutItemInfoArray = FlyoutItemInfo[];
+/**
+ * All of the different types that can create a toolbox.
+ */
+export type ToolboxDefinition = Node | ToolboxInfo | string;
+/**
+ * All of the different types that can be used to show items in a flyout.
+ */
+export type FlyoutDefinition = FlyoutItemInfoArray | NodeList | ToolboxInfo | Node[];
+/**
+ * Position of the toolbox and/or flyout relative to the workspace.
+ */
+export declare enum Position {
+    TOP = 0,
+    BOTTOM = 1,
+    LEFT = 2,
+    RIGHT = 3
+}
+/**
+ * Converts the toolbox definition into toolbox JSON.
+ *
+ * @param toolboxDef The definition of the toolbox in one of its many forms.
+ * @returns Object holding information for creating a toolbox.
+ * @internal
+ */
+export declare function convertToolboxDefToJson(toolboxDef: ToolboxDefinition | null): ToolboxInfo | null;
+/**
+ * Converts the flyout definition into a list of flyout items.
+ *
+ * @param flyoutDef The definition of the flyout in one of its many forms.
+ * @returns A list of flyout items.
+ * @internal
+ */
+export declare function convertFlyoutDefToJsonArray(flyoutDef: FlyoutDefinition | null): FlyoutItemInfoArray;
+/**
+ * Whether or not the toolbox definition has categories.
+ *
+ * @param toolboxJson Object holding information for creating a toolbox.
+ * @returns True if the toolbox has categories.
+ * @internal
+ */
+export declare function hasCategories(toolboxJson: ToolboxInfo | null): boolean;
+/**
+ * Private version of hasCategories for stubbing in tests.
+ */
+declare function hasCategoriesInternal(toolboxJson: ToolboxInfo | null): boolean;
+/**
+ * Whether or not the category is collapsible.
+ *
+ * @param categoryInfo Object holing information for creating a category.
+ * @returns True if the category has subcategories.
+ * @internal
+ */
+export declare function isCategoryCollapsible(categoryInfo: CategoryInfo): boolean;
+/**
+ * Parse the provided toolbox tree into a consistent DOM format.
+ *
+ * @param toolboxDef DOM tree of blocks, or text representation of same.
+ * @returns DOM tree of blocks, or null.
+ */
+export declare function parseToolboxTree(toolboxDef: Element | null | string): Element | null;
+export declare const TEST_ONLY: {
+    hasCategoriesInternal: typeof hasCategoriesInternal;
+};
+export {};
+//# sourceMappingURL=toolbox.d.ts.map

package/core/utils/useragent.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare const raw: string;
+export declare const JavaFx: boolean;
+export declare const GECKO: boolean;
+export declare const ANDROID: boolean;
+export declare const IPAD: boolean;
+export declare const IPHONE: boolean;
+export declare const MAC: boolean;
+export declare const MOBILE: boolean;
+//# sourceMappingURL=useragent.d.ts.map