blockly 8.0.5 → 9.0.0-beta.0

package/core/utils/useragent.ts

@@ -0,0 +1,135 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Useragent detection.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ */
+
+/**
+ * Useragent detection.
+ * These methods are not specific to Blockly, and could be factored out into
+ * a JavaScript framework such as Closure.
+ * @namespace Blockly.utils.userAgent
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.userAgent');
+
+
+/** The raw useragent string. */
+let rawUserAgent: string;
+
+let isIe: boolean;
+
+let isEdge: boolean;
+
+let isJavaFx: boolean;
+
+let isChrome: boolean;
+
+let isWebKit: boolean;
+
+let isGecko: boolean;
+
+let isAndroid: boolean;
+
+let isIPad: boolean;
+
+let isIPod: boolean;
+
+let isIPhone: boolean;
+
+let isMac: boolean;
+
+let isTablet: boolean;
+
+let isMobile: boolean;
+
+(function(raw) {
+rawUserAgent = raw;
+const rawUpper = rawUserAgent.toUpperCase();
+/**
+ * Case-insensitive test of whether name is in the useragent string.
+ * @param name Name to test.
+ * @return True if name is present.
+ */
+function has(name: string): boolean {
+  return rawUpper.indexOf(name.toUpperCase()) !== -1;
+}
+
+// Browsers.  Logic from:
+// https://github.com/google/closure-library/blob/master/closure/goog/labs/useragent/browser.js
+isIe = has('Trident') || has('MSIE');
+isEdge = has('Edge');
+// Useragent for JavaFX:
+// Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.44
+//     (KHTML, like Gecko) JavaFX/8.0 Safari/537.44
+isJavaFx = has('JavaFX');
+isChrome = (has('Chrome') || has('CriOS')) && !isEdge;
+
+// Engines.  Logic from:
+// https://github.com/google/closure-library/blob/master/closure/goog/labs/useragent/engine.js
+isWebKit = has('WebKit') && !isEdge;
+isGecko = has('Gecko') && !isWebKit && !isIe && !isEdge;
+
+// Platforms.  Logic from:
+// https://github.com/google/closure-library/blob/master/closure/goog/labs/useragent/platform.js
+// and
+// https://github.com/google/closure-library/blob/master/closure/goog/labs/useragent/extra.js
+isAndroid = has('Android');
+const maxTouchPoints =
+    globalThis['navigator'] && globalThis['navigator']['maxTouchPoints'];
+isIPad = has('iPad') || has('Macintosh') && maxTouchPoints > 0;
+isIPod = has('iPod');
+isIPhone = has('iPhone') && !isIPad && !isIPod;
+isMac = has('Macintosh');
+
+// Devices.  Logic from:
+// https://github.com/google/closure-library/blob/master/closure/goog/labs/useragent/device.js
+isTablet = isIPad || isAndroid && !has('Mobile') || has('Silk');
+isMobile = !isTablet && (isIPod || isIPhone || isAndroid || has('IEMobile'));
+})(globalThis['navigator'] && globalThis['navigator']['userAgent'] || '');
+
+/** @alias Blockly.utils.userAgent.raw */
+export const raw: string = rawUserAgent;
+
+/** @alias Blockly.utils.userAgent.IE */
+export const IE: boolean = isIe;
+
+/** @alias Blockly.utils.userAgent.EDGE */
+export const EDGE: boolean = isEdge;
+
+/** @alias Blockly.utils.userAgent.JavaFx */
+export const JavaFx: boolean = isJavaFx;
+
+/** @alias Blockly.utils.userAgent.CHROME */
+export const CHROME: boolean = isChrome;
+
+/** @alias Blockly.utils.userAgent.WEBKIT */
+export const WEBKIT: boolean = isWebKit;
+/** @alias Blockly.utils.userAgent.GECKO */
+export const GECKO: boolean = isGecko;
+
+/** @alias Blockly.utils.userAgent.ANDROID */
+export const ANDROID: boolean = isAndroid;
+
+/** @alias Blockly.utils.userAgent.IPAD */
+export const IPAD: boolean = isIPad;
+/** @alias Blockly.utils.userAgent.IPOD */
+export const IPOD: boolean = isIPod;
+
+/** @alias Blockly.utils.userAgent.IPHONE */
+export const IPHONE: boolean = isIPhone;
+
+/** @alias Blockly.utils.userAgent.MAC */
+export const MAC: boolean = isMac;
+
+/** @alias Blockly.utils.userAgent.TABLET */
+export const TABLET: boolean = isTablet;
+
+/** @alias Blockly.utils.userAgent.MOBILE */
+export const MOBILE: boolean = isMobile;

package/core/utils/xml.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Namespace for Blockly's XML.
+ * @alias Blockly.utils.xml.NAME_SPACE
+ */
+export declare const NAME_SPACE = "https://developers.google.com/blockly/xml";
+/**
+ * Get the document object to use for XML serialization.
+ * @return The document object.
+ * @alias Blockly.utils.xml.getDocument
+ */
+export declare function getDocument(): Document;
+/**
+ * Get the document object to use for XML serialization.
+ * @param document The document object to use.
+ * @alias Blockly.utils.xml.setDocument
+ */
+export declare function setDocument(document: Document): void;
+/**
+ * Create DOM element for XML.
+ * @param tagName Name of DOM element.
+ * @return New DOM element.
+ * @alias Blockly.utils.xml.createElement
+ */
+export declare function createElement(tagName: string): Element;
+/**
+ * Create text element for XML.
+ * @param text Text content.
+ * @return New DOM text node.
+ * @alias Blockly.utils.xml.createTextNode
+ */
+export declare function createTextNode(text: string): Text;
+/**
+ * Converts an XML string into a DOM tree.
+ * @param text XML string.
+ * @return The DOM document.
+ * @throws if XML doesn't parse.
+ * @alias Blockly.utils.xml.textToDomDocument
+ */
+export declare function textToDomDocument(text: string): Document;
+/**
+ * Converts a DOM structure into plain text.
+ * Currently the text format is fairly ugly: all one line with no whitespace.
+ * @param dom A tree of XML nodes.
+ * @return Text representation.
+ * @alias Blockly.utils.xml.domToText
+ */
+export declare function domToText(dom: Node): string;

package/core/utils/{xml.js → xml.ts}

@@ -9,7 +9,6 @@
  * These methods are not specific to Blockly, and could be factored out into
  * a JavaScript framework such as Closure.
  */
-'use strict';
 
 /**
  * XML element manipulation.
@@ -17,91 +16,82 @@
  * a JavaScript framework such as Closure.
  * @namespace Blockly.utils.xml
  */
-goog.module('Blockly.utils.xml');
-
-const {globalThis} = goog.require('Blockly.utils.global');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.xml');
 
 
 /**
  * Namespace for Blockly's XML.
  * @alias Blockly.utils.xml.NAME_SPACE
  */
-const NAME_SPACE = 'https://developers.google.com/blockly/xml';
-exports.NAME_SPACE = NAME_SPACE;
+export const NAME_SPACE = 'https://developers.google.com/blockly/xml';
 
 /**
  * The Document object to use.  By default this is just document, but
  * the Node.js build of Blockly (see scripts/package/node/core.js)
  * calls setDocument to supply a Document implementation from the
  * jsdom package instead.
- * @type {!Document}
  */
-let xmlDocument = globalThis['document'];
+let xmlDocument: Document = globalThis['document'];
 
 /**
  * Get the document object to use for XML serialization.
- * @return {!Document} The document object.
+ * @return The document object.
  * @alias Blockly.utils.xml.getDocument
  */
-const getDocument = function() {
+export function getDocument(): Document {
   return xmlDocument;
-};
-exports.getDocument = getDocument;
+}
 
 /**
  * Get the document object to use for XML serialization.
- * @param {!Document} document The document object to use.
+ * @param document The document object to use.
  * @alias Blockly.utils.xml.setDocument
  */
-const setDocument = function(document) {
+export function setDocument(document: Document) {
   xmlDocument = document;
-};
-exports.setDocument = setDocument;
+}
 
 /**
  * Create DOM element for XML.
- * @param {string} tagName Name of DOM element.
- * @return {!Element} New DOM element.
+ * @param tagName Name of DOM element.
+ * @return New DOM element.
  * @alias Blockly.utils.xml.createElement
  */
-const createElement = function(tagName) {
+export function createElement(tagName: string): Element {
   return xmlDocument.createElementNS(NAME_SPACE, tagName);
-};
-exports.createElement = createElement;
+}
 
 /**
  * Create text element for XML.
- * @param {string} text Text content.
- * @return {!Text} New DOM text node.
+ * @param text Text content.
+ * @return New DOM text node.
  * @alias Blockly.utils.xml.createTextNode
  */
-const createTextNode = function(text) {
+export function createTextNode(text: string): Text {
   return xmlDocument.createTextNode(text);
-};
-exports.createTextNode = createTextNode;
+}
 
 /**
  * Converts an XML string into a DOM tree.
- * @param {string} text XML string.
- * @return {Document} The DOM document.
+ * @param text XML string.
+ * @return The DOM document.
  * @throws if XML doesn't parse.
  * @alias Blockly.utils.xml.textToDomDocument
  */
-const textToDomDocument = function(text) {
+export function textToDomDocument(text: string): Document {
   const oParser = new DOMParser();
   return oParser.parseFromString(text, 'text/xml');
-};
-exports.textToDomDocument = textToDomDocument;
+}
 
 /**
  * Converts a DOM structure into plain text.
  * Currently the text format is fairly ugly: all one line with no whitespace.
- * @param {!Node} dom A tree of XML nodes.
- * @return {string} Text representation.
+ * @param dom A tree of XML nodes.
+ * @return Text representation.
  * @alias Blockly.utils.xml.domToText
  */
-const domToText = function(dom) {
+export function domToText(dom: Node): string {
   const oSerializer = new XMLSerializer();
   return oSerializer.serializeToString(dom);
-};
-exports.domToText = domToText;
+}

package/core/utils.d.ts

@@ -0,0 +1,217 @@
+/**
+ * @license
+ * Copyright 2012 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from './block.js';
+import * as browserEvents from './browser_events.js';
+import * as extensions from './extensions.js';
+import * as aria from './utils/aria.js';
+import * as arrayUtils from './utils/array.js';
+import * as colour from './utils/colour.js';
+import { Coordinate } from './utils/coordinate.js';
+import * as deprecation from './utils/deprecation.js';
+import * as dom from './utils/dom.js';
+import * as idGenerator from './utils/idgenerator.js';
+import { KeyCodes } from './utils/keycodes.js';
+import * as math from './utils/math.js';
+import type { Metrics } from './utils/metrics.js';
+import * as object from './utils/object.js';
+import * as parsing from './utils/parsing.js';
+import { Rect } from './utils/rect.js';
+import { Size } from './utils/size.js';
+import * as stringUtils from './utils/string.js';
+import * as style from './utils/style.js';
+import { Svg } from './utils/svg.js';
+import * as svgMath from './utils/svg_math.js';
+import * as svgPaths from './utils/svg_paths.js';
+import * as toolbox from './utils/toolbox.js';
+import * as userAgent from './utils/useragent.js';
+import * as xml from './utils/xml.js';
+import type { WorkspaceSvg } from './workspace_svg.js';
+export { aria, arrayUtils as array, browserEvents, colour, Coordinate, deprecation, dom, extensions, idGenerator, KeyCodes, math, Metrics, object, parsing, Rect, Size, stringUtils as string, style, Svg, svgMath, svgPaths, toolbox, userAgent, xml };
+/**
+ * Halts the propagation of the event without doing anything else.
+ * @param e An event.
+ * @deprecated
+ * @alias Blockly.utils.noEvent
+ */
+export declare function noEvent(e: Event): void;
+/**
+ * Returns true if this event is targeting a text input widget?
+ * @param e An event.
+ * @return True if text input.
+ * @deprecated Use Blockly.browserEvents.isTargetInput instead.
+ * @alias Blockly.utils.isTargetInput
+ */
+export declare function isTargetInput(e: Event): boolean;
+/**
+ * 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.
+ * @return Object with .x and .y properties.
+ * @deprecated
+ * @alias Blockly.utils.getRelativeXY
+ */
+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.
+ * @return Object with .x and .y properties.
+ * @deprecated
+ * @alias Blockly.utils.getInjectionDivXY_
+ */
+declare function getInjectionDivXY(element: Element): Coordinate;
+export declare const getInjectionDivXY_: typeof getInjectionDivXY;
+/**
+ * Returns true this event is a right-click.
+ * @param e Mouse event.
+ * @return True if right-click.
+ * @deprecated Use Blockly.browserEvents.isRightButton instead.
+ * @alias Blockly.utils.isRightButton
+ */
+export declare function isRightButton(e: Event): boolean;
+/**
+ * Returns the converted coordinates of the given mouse event.
+ * The origin (0,0) is the top-left corner of the Blockly SVG.
+ * @param e Mouse event.
+ * @param svg SVG element.
+ * @param matrix Inverted screen CTM to use.
+ * @return Object with .x and .y properties.
+ * @deprecated Use Blockly.browserEvents.mouseToSvg instead;
+ * @alias Blockly.utils.mouseToSvg
+ */
+export declare function mouseToSvg(e: Event, svg: SVGSVGElement, matrix: SVGMatrix | null): SVGPoint;
+/**
+ * Returns the scroll delta of a mouse event in pixel units.
+ * @param e Mouse event.
+ * @return Scroll delta object with .x and .y properties.
+ * @deprecated Use Blockly.browserEvents.getScrollDeltaPixels instead.
+ * @alias Blockly.utils.getScrollDeltaPixels
+ */
+export declare function getScrollDeltaPixels(e: WheelEvent): {
+    x: number;
+    y: number;
+};
+/**
+ * Parse a string with any number of interpolation tokens (%1, %2, ...).
+ * It will also replace string table references (e.g., %{bky_my_msg} and
+ * %{BKY_MY_MSG} will both be replaced with the value in
+ * Msg['MY_MSG']). Percentage sign characters '%' may be self-escaped
+ * (e.g., '%%').
+ * @param message Text which might contain string table references and
+ *     interpolation tokens.
+ * @return Array of strings and numbers.
+ * @deprecated
+ * @alias Blockly.utils.tokenizeInterpolation
+ */
+export declare function tokenizeInterpolation(message: string): Array<string | number>;
+/**
+ * Replaces string table references in a message, if the message is a string.
+ * For example, "%{bky_my_msg}" and "%{BKY_MY_MSG}" will both be replaced with
+ * the value in Msg['MY_MSG'].
+ * @param message Message, which may be a string that contains string table
+ *     references.
+ * @return String with message references replaced.
+ * @deprecated
+ * @alias Blockly.utils.replaceMessageReferences
+ */
+export declare function replaceMessageReferences(message: string | any): string;
+/**
+ * Validates that any %{MSG_KEY} references in the message refer to keys of
+ * the Msg string table.
+ * @param message Text which might contain string table references.
+ * @return True if all message references have matching values.
+ *     Otherwise, false.
+ * @deprecated
+ * @alias Blockly.utils.checkMessageReferences
+ */
+export declare function checkMessageReferences(message: string): boolean;
+/**
+ * Generate a unique ID.
+ * @return A globally unique ID string.
+ * @deprecated Use Blockly.utils.idGenerator.genUid instead.
+ * @alias Blockly.utils.genUid
+ */
+export declare function genUid(): string;
+/**
+ * Check if 3D transforms are supported by adding an element
+ * and attempting to set the property.
+ * @return True if 3D transforms are supported.
+ * @deprecated
+ * @alias Blockly.utils.is3dSupported
+ */
+export declare function is3dSupported(): boolean;
+/**
+ * Get the position of the current viewport in window coordinates.  This takes
+ * scroll into account.
+ * @return An object containing window width, height, and scroll position in
+ *     window coordinates.
+ * @alias Blockly.utils.getViewportBBox
+ * @deprecated
+ * @internal
+ */
+export declare function getViewportBBox(): Rect;
+/**
+ * Removes the first occurrence of a particular value from an array.
+ * @param arr Array from which to remove value.
+ * @param value Value to remove.
+ * @return True if an element was removed.
+ * @alias Blockly.utils.arrayRemove
+ * @deprecated
+ * @internal
+ */
+export declare function arrayRemove(arr: any[], value: any): boolean;
+/**
+ * Gets the document scroll distance as a coordinate object.
+ * Copied from Closure's goog.dom.getDocumentScroll.
+ * @return Object with values 'x' and 'y'.
+ * @deprecated
+ * @alias Blockly.utils.getDocumentScroll
+ */
+export declare function getDocumentScroll(): Coordinate;
+/**
+ * Get a map of all the block's descendants mapping their type to the number of
+ *    children with that type.
+ * @param block The block to map.
+ * @param opt_stripFollowing Optionally ignore all following statements (blocks
+ *     that are not inside a value or statement input of the block).
+ * @return Map of types to type counts for descendants of the bock.
+ * @deprecated
+ * @alias Blockly.utils.getBlockTypeCounts
+ */
+export declare function getBlockTypeCounts(block: Block, opt_stripFollowing?: boolean): any;
+/**
+ * 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
+ * @deprecated
+ * @return The workspace coordinates.
+ */
+export declare function screenToWsCoordinates(ws: WorkspaceSvg, screenCoordinates: Coordinate): Coordinate;
+/**
+ * Parse a block colour from a number or string, as provided in a block
+ * definition.
+ * @param colour HSV hue value (0 to 360), #RRGGBB string, or a message
+ *     reference string pointing to one of those two values.
+ * @return An object containing the colour as a #RRGGBB string, and the hue if
+ *     the input was an HSV hue value.
+ * @throws {Error} If the colour cannot be parsed.
+ * @deprecated
+ * @alias Blockly.utils.parseBlockColour
+ */
+export declare function parseBlockColour(colour: number | string): {
+    hue: number | null;
+    hex: string;
+};
+/**
+ * Calls a function after the page has loaded, possibly immediately.
+ * @param fn Function to run.
+ * @throws Error Will throw if no global document can be found (e.g., Node.js).
+ * @deprecated
+ * @alias Blockly.utils.runAfterPageLoad
+ */
+export declare function runAfterPageLoad(fn: () => any): void;