Files
blockly/scripts/migration/renamings.js
Beka Westberg f77526e558 Move browser event utils from utils.js to browser_events.js (#5464)
* fix: move browser event utils to browserEvents

* fix: mark browser event utils in utils as deprecated

* fix: move uses of browser event funcs to browserEvents

* fix: remove browserEvents definition of noEvent

* fix: add renames for browser event utils

* docs: add suggested alternatives for browser event utils

* fix: change deprecations to stubs

* fix: PR comments
2021-09-17 14:49:01 -07:00

143 lines
4.1 KiB
JavaScript

/**
* @license
* Copyright 2021 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Collected information about modules and module
* exports that have been renamed between versions.
*
* For now this is a node module, not a goog.module.
*/
'use strict';
/**
* Map from Blockly core version number to table of renamings made
* *since* that version was released (since we don't know for sure
* what the version number of the release that will incorporate those
* renamings will be yet).
* @type {Object<string, ?>}
*/
const renamings = {
'4.20201217.0': {
'Blockly': {
exports: {
// bind/unbind events functions. See PR #4642
EventData: {module: 'Blockly.eventHandling', export: 'Data'},
bindEvent_: {module: 'Blockly.browserEvents', export: 'bind'},
unbindEvent_: {module: 'Blockly.browserEvents', export: 'unbind'},
bindEventWithChecks_: {
module: 'Blockly.browserEvents',
export: 'conditionalBind',
},
},
},
},
'6.20210701.0': {
'Blockly': {
exports: {
// Clipboard. See PR #5237.
clipboardXml_: {module: 'Blockly.clipboard', export: 'xml'},
clipboardSource_: {module: 'Blockly.clipboard', export: 'source'},
clipboardTypeCounts_: {
module: 'Blockly.clipboard',
export: 'typeCounts',
},
copy: {module: 'Blockly.clipboard'},
paste: {module: 'Blockly.clipboard'},
duplicate: {module: 'Blockly.clipboard'},
// mainWorkspace. See PR #5244.
mainWorkspace: {
module: 'Blockly.common',
get: 'getMainWorkspace',
set: 'setMainWorkspace',
},
getMainWorkspace: {module: 'Blockly.common'},
// parentContainer, draggingConnections. See PR #5262.
parentContainer: {
module: 'Blockly.common',
get: 'getParentContainer',
set: 'setParentContainer',
},
setParentContainer: {module: 'Blockly.common'},
draggingConnections: {module: 'Blockly.common'},
// Dialogs. See PR #5457.
alert: {
module: 'Blockly.dialog',
export: 'alert',
set: 'setAlert',
},
confirm: {
module: 'Blockly.dialog',
export: 'confirm',
set: 'setConfirm',
},
prompt: {
module: 'Blockly.dialog',
export: 'prompt',
set: 'setPrompt',
},
// hueToHex. See PR #5462.
hueToHex: {module: 'Blockly.utils.colour'},
// Blockly.hideChaff() became
// Blockly.common.getMainWorkspace().hideChaff(). See PR #5460.
// selected. See PR #5489.
selected: {
module: 'Blockly.common',
get: 'getSelected',
set: 'setSelected',
},
},
},
'Blockly.ContextMenu': {
exports: {
currentBlock: {get: 'getCurrentBlock', set: 'setCurrentBlock'},
},
},
'Blockly.Events': {
exports: {
recordUndo: {get: 'getRecordUndo', set: 'setRecordUndo'},
},
},
'Blockly.Tooltip': {
exports: {
DIV: {get: 'getDiv', set: 'setDiv'},
visible: {get: 'isVisible'},
},
},
'Blockly.WidgetDiv': {
exports: {
DIV: {get: 'getDiv'},
},
},
'Blockly.utils': {
exports: {
genUid: {module: 'Blockly.utils.idGenerator'},
getScrollDelta: {module: 'Blockly.utils.browserEvents'},
isTargetInput: {module: 'Blockly.utils.browserEvents'},
isRightButton: {module: 'Blockly.utils.browserEvents'},
mouseToSvg: {module: 'Blockly.utils.browserEvents'},
},
},
'Blockly.utils.global': {
export: 'globalThis', // Previous default export now named.
},
'Blockly.utils.IdGenerator': {
module: 'Blockly.utils.idGenerator',
},
'Blockly.utils.xml': {
exports: {
// document was a function before, too - not a static property
// or get accessor.
document: {export: 'getDocument'},
},
},
},
};
exports.renamings = renamings;