StardewValley
/
jsoneditor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Partial refactor to ES modules

This commit is contained in:
jos 2019-08-29 17:03:09 +02:00
parent a7d501fe3c
commit be61222225
27 changed files with 268 additions and 248 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.babelrc Normal file
View File

@ -0,0 +1,5 @@
{
"presets": [
["@babel/preset-env"]
]
}

5
gulpfile.js
View File

@ -40,10 +40,7 @@ var webpackConfigModule = {
test: /\.m?js$/,
exclude: /node_modules/,
use: {
loader: 'babel-loader',
options: {
presets: ['@babel/preset-env']
}
loader: 'babel-loader'
}
}
]

35
package-lock.json generated
View File

@ -758,6 +758,20 @@
"semver": "^5.5.0"
}
},
"@babel/register": {
"version": "7.5.5",
"resolved": "https://registry.npmjs.org/@babel/register/-/register-7.5.5.tgz",
"integrity": "sha512-pdd5nNR+g2qDkXZlW1yRCWFlNrAn2PPdnZUB72zjX4l1Vv4fMRRLwyf+n/idFCLI1UgVGboUU8oVziwTBiyNKQ==",
"dev": true,
"requires": {
"core-js": "^3.0.0",
"find-cache-dir": "^2.0.0",
"lodash": "^4.17.13",
"mkdirp": "^0.5.1",
"pirates": "^4.0.0",
"source-map-support": "^0.5.9"
}
},
"@babel/template": {
"version": "7.4.4",
"resolved": "https://registry.npmjs.org/@babel/template/-/template-7.4.4.tgz",
@ -2233,6 +2247,12 @@
"is-plain-object": "^2.0.1"
}
},
"core-js": {
"version": "3.2.1",
"resolved": "https://registry.npmjs.org/core-js/-/core-js-3.2.1.tgz",
"integrity": "sha512-Qa5XSVefSVPRxy2XfUC13WbvqkxhkwB3ve+pgCQveNgYzbM/UxZeu1dcOX/xr4UmfUd+muuvsaxilQzCyUurMw==",
"dev": true
},
"core-js-compat": {
"version": "3.2.1",
"resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.2.1.tgz",
@ -6569,6 +6589,12 @@
}
}
},
"node-modules-regexp": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/node-modules-regexp/-/node-modules-regexp-1.0.0.tgz",
"integrity": "sha1-jZ2+KJZKSsVxLpExZCEHxx6Q7EA=",
"dev": true
},
"node-releases": {
"version": "1.1.28",
"resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.28.tgz",
@ -7216,6 +7242,15 @@
"pinkie": "^2.0.0"
}
},
"pirates": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.1.tgz",
"integrity": "sha512-WuNqLTbMI3tmfef2TKxlQmAiLHKtFhlsCZnPIpuv2Ow0RDVO8lfy1Opf4NUzlMXLjPl+Men7AuVdX6TA+s+uGA==",
"dev": true,
"requires": {
"node-modules-regexp": "^1.0.0"
}
},
"pkg-conf": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/pkg-conf/-/pkg-conf-3.1.0.tgz",

3
package.json
View File

@ -21,7 +21,7 @@
"build": "gulp",
"minify": "gulp minify",
"start": "gulp watch",
"test": "mocha test",
"test": "mocha test --require @babel/register",
"lint": "standard --env=mocha"
},
"dependencies": {
@ -37,6 +37,7 @@
"devDependencies": {
"@babel/core": "7.5.5",
"@babel/preset-env": "7.5.5",
"@babel/register": "7.5.5",
"babel-loader": "8.0.6",
"date-format": "2.1.0",
"fancy-log": "1.3.3",

18
src/js/ContextMenu.js
View File

@ -1,8 +1,8 @@
'use strict'
const createAbsoluteAnchor = require('./createAbsoluteAnchor').createAbsoluteAnchor
const util = require('./util')
const translate = require('./i18n').translate
import { createAbsoluteAnchor } from './createAbsoluteAnchor'
import { addClassName, getSelection, removeClassName, setSelection } from './util'
import { translate } from './i18n'
/**
* A context menu
@ -13,7 +13,7 @@ const translate = require('./i18n').translate
* context menu is being closed.
* @constructor
*/
function ContextMenu (items, options) {
export function ContextMenu (items, options) {
this.dom = {}
const me = this
@ -241,7 +241,7 @@ ContextMenu.prototype.show = function (anchor, frame, ignoreParent) {
this.dom.absoluteAnchor.appendChild(this.dom.root)
// move focus to the first button in the context menu
this.selection = util.getSelection()
this.selection = getSelection()
this.anchor = anchor
setTimeout(() => {
me.dom.focusButton.focus()
@ -295,7 +295,7 @@ ContextMenu.prototype._onExpandItem = function (domItem) {
setTimeout(() => {
if (me.expandedItem !== expandedItem) {
expandedItem.ul.style.display = ''
util.removeClassName(expandedItem.ul.parentNode, 'jsoneditor-selected')
removeClassName(expandedItem.ul.parentNode, 'jsoneditor-selected')
}
}, 300) // timeout duration must match the css transition duration
this.expandedItem = undefined
@ -316,7 +316,7 @@ ContextMenu.prototype._onExpandItem = function (domItem) {
ul.style.padding = '5px 10px'
}
}, 0)
util.addClassName(ul.parentNode, 'jsoneditor-selected')
addClassName(ul.parentNode, 'jsoneditor-selected')
this.expandedItem = domItem
}
}
@ -337,7 +337,7 @@ ContextMenu.prototype._onKeyDown = function (event) {
// restore previous selection and focus
if (this.selection) {
util.setSelection(this.selection)
setSelection(this.selection)
}
if (this.anchor) {
this.anchor.focus()
@ -424,4 +424,4 @@ ContextMenu.prototype._onKeyDown = function (event) {
}
}
module.exports = ContextMenu
export default ContextMenu;

4
src/js/ErrorTable.js
View File

@ -7,7 +7,7 @@
* @property {function (number)} onChangeHeight
* @constructor
*/
function ErrorTable (config) {
export function ErrorTable (config) {
this.errorTableVisible = config.errorTableVisible
this.onToggleVisibility = config.onToggleVisibility
this.onFocusLine = config.onFocusLine || (() => {})
@ -166,5 +166,3 @@ ErrorTable.prototype.setErrors = function (errors, errorLocations) {
this.dom.parseErrorIndication.style.display = 'none'
}
}
module.exports = ErrorTable

4
src/js/Highlighter.js
View File

@ -5,7 +5,7 @@
* animate the visibility of a context menu.
* @constructor Highlighter
*/
function Highlighter () {
export function Highlighter () {
this.locked = false
}
@ -82,5 +82,3 @@ Highlighter.prototype.lock = function () {
Highlighter.prototype.unlock = function () {
this.locked = false
}
module.exports = Highlighter

4
src/js/History.js
View File

@ -6,7 +6,7 @@
* @param {number} limit Maximum size of all items in history
* @constructor
*/
function History (onChange, calculateItemSize, limit) {
export function History (onChange, calculateItemSize, limit) {
this.onChange = onChange
this.calculateItemSize = calculateItemSize || (() => 1)
this.limit = limit
@ -81,5 +81,3 @@ History.prototype.clear = function () {
this.onChange()
}
module.exports = History

2
src/js/ModeSwitcher.js
View File

@ -1,6 +1,6 @@
'use strict'
const ContextMenu = require('./ContextMenu')
const ContextMenu = require('./ContextMenu').ContextMenu
const translate = require('./i18n').translate
/**

8
src/js/Node.js
View File

@ -3,11 +3,11 @@
const jmespath = require('jmespath')
const naturalSort = require('javascript-natural-sort')
const createAbsoluteAnchor = require('./createAbsoluteAnchor').createAbsoluteAnchor
const ContextMenu = require('./ContextMenu')
const ContextMenu = require('./ContextMenu').ContextMenu
const appendNodeFactory = require('./appendNodeFactory')
const showMoreNodeFactory = require('./showMoreNodeFactory')
const showSortModal = require('./showSortModal')
const showTransformModal = require('./showTransformModal')
const showMoreNodeFactory = require('./showMoreNodeFactory').showMoreNodeFactory
const showSortModal = require('./showSortModal').showSortModal
const showTransformModal = require('./showTransformModal').showTransformModal
const util = require('./util')
const translate = require('./i18n').translate
const DEFAULT_MODAL_ANCHOR = require('./constants').DEFAULT_MODAL_ANCHOR

8
src/js/NodeHistory.js
View File

@ -1,13 +1,13 @@
'use strict'
const util = require('./util')
import { findUniqueName } from './util'
/**
* @constructor History
* Store action history, enables undo and redo
* @param {JSONEditor} editor
*/
function NodeHistory (editor) {
export function NodeHistory (editor) {
this.editor = editor
this.history = []
this.index = -1
@ -125,7 +125,7 @@ function NodeHistory (editor) {
const clone = node.clone()
if (parentNode.type === 'object') {
const existingFieldNames = parentNode.getFieldNames()
clone.field = util.findUniqueName(node.field, existingFieldNames)
clone.field = findUniqueName(node.field, existingFieldNames)
}
parentNode.insertAfter(clone, afterNode)
afterNode = clone
@ -329,5 +329,3 @@ NodeHistory.prototype.destroy = function () {
this.history = []
this.index = -1
}
module.exports = NodeHistory

4
src/js/SearchBox.js
View File

@ -7,7 +7,7 @@
* @param {Element} container HTML container element of where to
* create the search box
*/
function SearchBox (editor, container) {
export function SearchBox (editor, container) {
const searchBox = this
this.editor = editor
@ -319,5 +319,3 @@ SearchBox.prototype.destroy = function () {
this._clearDelay()
}
module.exports = SearchBox

14
src/js/TreePath.js
View File

@ -1,8 +1,8 @@
'use strict'
const ContextMenu = require('./ContextMenu')
const translate = require('./i18n').translate
const util = require('./util')
import { ContextMenu } from './ContextMenu'
import { translate } from './i18n'
import { addClassName, removeClassName } from './util'
/**
* Creates a component that visualize path selection in tree based editors
@ -10,7 +10,7 @@ const util = require('./util')
* @param {HTMLElement} root
* @constructor
*/
function TreePath (container, root) {
export function TreePath (container, root) {
if (container) {
this.root = root
this.path = document.createElement('div')
@ -91,7 +91,7 @@ TreePath.prototype.setPath = function (pathObjs) {
function _onShowAllClick (pathObjs) {
me.contentMenuClicked = false
util.addClassName(me.path, 'show-all')
addClassName(me.path, 'show-all')
me.path.style.width = me.path.parentNode.getBoundingClientRect().width - 10 + 'px'
me.path.onblur = () => {
if (me.contentMenuClicked) {
@ -99,7 +99,7 @@ TreePath.prototype.setPath = function (pathObjs) {
me.path.focus()
return
}
util.removeClassName(me.path, 'show-all')
removeClassName(me.path, 'show-all')
me.path.onblur = undefined
me.path.style.width = ''
me.setPath(pathObjs)
@ -138,5 +138,3 @@ TreePath.prototype.onContextMenuItemSelected = function (callback) {
this.contextMenuCallback = callback
}
}
module.exports = TreePath

2
src/js/appendNodeFactory.js
View File

@ -1,7 +1,7 @@
'use strict'
const util = require('./util')
const ContextMenu = require('./ContextMenu')
const ContextMenu = require('./ContextMenu').ContextMenu
const translate = require('./i18n').translate
/**

4
src/js/autocomplete.js
View File

@ -9,7 +9,7 @@ const defaultFilterFunction = {
}
}
function completely (config) {
export function autocomplete (config) {
config = config || {}
config.filter = config.filter || 'start'
config.trigger = config.trigger || 'keydown'
@ -379,5 +379,3 @@ function completely (config) {
return rs
}
module.exports = completely

10
src/js/constants.js
View File

@ -1,7 +1,5 @@
exports.DEFAULT_MODAL_ANCHOR = document.body
exports.SIZE_LARGE = 10 * 1024 * 1024 // 10 MB
exports.MAX_PREVIEW_CHARACTERS = 20000
exports.PREVIEW_HISTORY_LIMIT = 2 * 1024 * 1024 * 1024 // 2 GB
export var DEFAULT_MODAL_ANCHOR = document.body;
export var SIZE_LARGE = 10 * 1024 * 1024; // 10 MB
export var MAX_PREVIEW_CHARACTERS = 20000;
export var PREVIEW_HISTORY_LIMIT = 2 * 1024 * 1024 * 1024; // 2 GB

14
src/js/createAbsoluteAnchor.js
View File

@ -1,4 +1,4 @@
const util = require('./util')
import { isChildOf, removeEventListener, addEventListener } from './util'
/**
* Create an anchor element absolutely positioned in the `parent`
@ -8,7 +8,7 @@ const util = require('./util')
* @param [onDestroy(function(anchor)] Callback when the anchor is destroyed
* @returns {HTMLElement}
*/
exports.createAbsoluteAnchor = (anchor, parent, onDestroy) => {
export function createAbsoluteAnchor(anchor, parent, onDestroy) {
const root = getRootNode(anchor)
const eventListeners = {}
@ -36,7 +36,7 @@ exports.createAbsoluteAnchor = (anchor, parent, onDestroy) => {
if (hasOwnProperty(eventListeners, name)) {
const fn = eventListeners[name]
if (fn) {
util.removeEventListener(root, name, fn)
removeEventListener(root, name, fn)
}
delete eventListeners[name]
}
@ -51,14 +51,14 @@ exports.createAbsoluteAnchor = (anchor, parent, onDestroy) => {
// create and attach event listeners
const destroyIfOutside = event => {
const target = event.target
if ((target !== absoluteAnchor) && !util.isChildOf(target, absoluteAnchor)) {
if ((target !== absoluteAnchor) && !isChildOf(target, absoluteAnchor)) {
destroy()
}
}
eventListeners.mousedown = util.addEventListener(root, 'mousedown', destroyIfOutside)
eventListeners.mousewheel = util.addEventListener(root, 'mousewheel', destroyIfOutside)
// eventListeners.scroll = util.addEventListener(root, 'scroll', destroyIfOutside);
eventListeners.mousedown = addEventListener(root, 'mousedown', destroyIfOutside)
eventListeners.mousewheel = addEventListener(root, 'mousewheel', destroyIfOutside)
// eventListeners.scroll = addEventListener(root, 'scroll', destroyIfOutside);
absoluteAnchor.destroy = destroy

82
src/js/i18n.js
View File

@ -2,7 +2,7 @@
/* eslint-disable no-template-curly-in-string */
require('./polyfills')
import './polyfills'
const _locales = ['en', 'pt-BR', 'zh-CN', 'tr']
const _defs = {
@ -377,53 +377,45 @@ const _defs = {
}
const _defaultLang = 'en'
let _lang
const userLang = typeof navigator !== 'undefined'
? navigator.language || navigator.userLanguage
: undefined
_lang = _locales.find(l => l === userLang)
if (!_lang) {
_lang = _defaultLang
}
let _lang = _locales.find(l => l === userLang) || _defaultLang
module.exports = {
// supported locales
_locales: _locales,
_defs: _defs,
_lang: _lang,
setLanguage: function (lang) {
if (!lang) {
return
}
const langFound = _locales.find(l => l === lang)
if (langFound) {
_lang = langFound
} else {
console.error('Language not found')
}
},
setLanguages: function (languages) {
if (!languages) {
return
}
for (const key in languages) {
const langFound = _locales.find(l => l === key)
if (!langFound) {
_locales.push(key)
}
_defs[key] = Object.assign({}, _defs[_defaultLang], _defs[key], languages[key])
}
},
translate: function (key, data, lang) {
if (!lang) {
lang = _lang
}
let text = _defs[lang][key]
if (data) {
for (key in data) {
text = text.replace('${' + key + '}', data[key])
}
}
return text || key
export function setLanguage (lang) {
if (!lang) {
return
}
const langFound = _locales.find(l => l === lang)
if (langFound) {
_lang = langFound
} else {
console.error('Language not found')
}
}
export function setLanguages (languages) {
if (!languages) {
return
}
for (const key in languages) {
const langFound = _locales.find(l => l === key)
if (!langFound) {
_locales.push(key)
}
_defs[key] = Object.assign({}, _defs[_defaultLang], _defs[key], languages[key])
}
}
export function translate (key, data, lang) {
if (!lang) {
lang = _lang
}
let text = _defs[lang][key]
if (data) {
for (key in data) {
text = text.replace('${' + key + '}', data[key])
}
}
return text || key
}

7
src/js/jsonUtils.js
View File

@ -21,7 +21,7 @@
*
* @returns {string | undefined} Returns the string representation of the JSON object.
*/
function stringifyPartial (value, space, limit) {
export function stringifyPartial (value, space, limit) {
let _space // undefined by default
if (typeof space === 'number') {
if (space > 10) {
@ -188,13 +188,10 @@ function slice (text, limit) {
* @param {string} jsonText
* @return {boolean}
*/
function containsArray (jsonText) {
export function containsArray (jsonText) {
return /^\s*\[/.test(jsonText)
}
function hasOwnProperty (object, key) {
return Object.prototype.hasOwnProperty.call(object, key)
}
exports.stringifyPartial = stringifyPartial
exports.containsArray = containsArray

11
src/js/previewmode.js
View File

@ -5,14 +5,14 @@ const translate = require('./i18n').translate
const ModeSwitcher = require('./ModeSwitcher')
const ErrorTable = require('./ErrorTable')
const textmode = require('./textmode')[0].mixin
const showSortModal = require('./showSortModal')
const showTransformModal = require('./showTransformModal')
const showSortModal = require('./showSortModal').showSortModal
const showTransformModal = require('./showTransformModal').showTransformModal
const MAX_PREVIEW_CHARACTERS = require('./constants').MAX_PREVIEW_CHARACTERS
const DEFAULT_MODAL_ANCHOR = require('./constants').DEFAULT_MODAL_ANCHOR
const SIZE_LARGE = require('./constants').SIZE_LARGE
const PREVIEW_HISTORY_LIMIT = require('./constants').PREVIEW_HISTORY_LIMIT
const util = require('./util')
const History = require('./History')
const History = require('./History').History
// create a mixin with the functions for text mode
const previewmode = {}
@ -23,10 +23,7 @@ const previewmode = {}
* @param {Object} [options] Object with options. See docs for details.
* @private
*/
previewmode.create = function (container, options) {
// read options
options = options || {}
previewmode.create = function (container, options = {}) {
if (typeof options.statusBar === 'undefined') {
options.statusBar = true
}

6
src/js/showMoreNodeFactory.js
View File

@ -1,12 +1,12 @@
'use strict'
const translate = require('./i18n').translate
import {translate} from './i18n';
/**
* A factory function to create an ShowMoreNode, which depends on a Node
* @param {function} Node
*/
function showMoreNodeFactory (Node) {
export function showMoreNodeFactory (Node) {
/**
* @constructor ShowMoreNode
* @extends Node
@ -152,5 +152,3 @@ function showMoreNodeFactory (Node) {
return ShowMoreNode
}
module.exports = showMoreNodeFactory

14
src/js/showSortModal.js
View File

@ -1,6 +1,6 @@
const picoModal = require('picomodal')
const translate = require('./i18n').translate
const util = require('./util')
import picoModal from 'picomodal';
import {translate} from './i18n';
import { contains, getChildPaths } from './util'
/**
* Show advanced sorting modal
@ -15,11 +15,11 @@ const util = require('./util')
* - {string} path The selected path
* - {'asc' | 'desc'} direction The selected direction
*/
function showSortModal (container, json, onSort, options) {
export function showSortModal (container, json, onSort, options) {
const paths = Array.isArray(json)
? util.getChildPaths(json)
? getChildPaths(json)
: ['']
const selectedPath = options && options.path && util.contains(paths, options.path)
const selectedPath = options && options.path && contains(paths, options.path)
? options.path
: paths[0]
const selectedDirection = (options && options.direction) || 'asc'
@ -129,5 +129,3 @@ function showSortModal (container, json, onSort, options) {
})
.show()
}
module.exports = showSortModal

29
src/js/showTransformModal.js
View File

@ -1,11 +1,10 @@
const jmespath = require('jmespath')
const picoModal = require('picomodal')
const Selectr = require('./assets/selectr/selectr')
const translate = require('./i18n').translate
const stringifyPartial = require('./jsonUtils').stringifyPartial
const util = require('./util')
const MAX_PREVIEW_CHARACTERS = require('./constants').MAX_PREVIEW_CHARACTERS
const debounce = util.debounce
import jmespath from 'jmespath';
import picoModal from 'picomodal';
import Selectr from './assets/selectr/selectr';
import {translate} from './i18n';
import {stringifyPartial} from './jsonUtils';
import { getChildPaths, get, parsePath, parseString, debounce } from './util'
import {MAX_PREVIEW_CHARACTERS} from './constants';
/**
* Show advanced filter and transform modal using JMESPath
@ -15,7 +14,7 @@ const debounce = util.debounce
* @param {function} onTransform Callback invoked with the created
* query as callback
*/
function showTransformModal (container, json, onTransform) {
export function showTransformModal (container, json, onTransform) {
const value = json
const content = '<label class="pico-modal-contents">' +
@ -125,7 +124,7 @@ function showTransformModal (container, json, onTransform) {
wizard.innerHTML = '(wizard not available for objects, only for arrays)'
}
const sortablePaths = util.getChildPaths(json)
const sortablePaths = getChildPaths(json)
sortablePaths.forEach(path => {
const formattedPath = preprocessPath(path)
@ -140,7 +139,7 @@ function showTransformModal (container, json, onTransform) {
sortField.appendChild(sortOption)
})
const selectablePaths = util.getChildPaths(json, true).filter(path => path !== '')
const selectablePaths = getChildPaths(json, true).filter(path => path !== '')
if (selectablePaths.length > 0) {
selectablePaths.forEach(path => {
const formattedPath = preprocessPath(path)
@ -191,12 +190,12 @@ function showTransformModal (container, json, onTransform) {
if (filterField.value && filterRelation.value && filterValue.value) {
const field1 = filterField.value
const examplePath = field1 !== '@'
? ['0'].concat(util.parsePath('.' + field1))
? ['0'].concat(parsePath('.' + field1))
: ['0']
const exampleValue = util.get(value, examplePath)
const exampleValue = get(value, examplePath)
const value1 = typeof exampleValue === 'string'
? filterValue.value
: util.parseString(filterValue.value)
: parseString(filterValue.value)
query.value = '[? ' +
field1 + ' ' +
@ -288,5 +287,3 @@ function showTransformModal (container, json, onTransform) {
})
.show()
}
module.exports = showTransformModal

6
src/js/textmode.js
View File

@ -4,10 +4,10 @@ const ace = require('./ace')
const jmespath = require('jmespath')
const translate = require('./i18n').translate
const ModeSwitcher = require('./ModeSwitcher')
const ErrorTable = require('./ErrorTable')
const ErrorTable = require('./ErrorTable').ErrorTable
const validateCustom = require('./validationUtils').validateCustom
const showSortModal = require('./showSortModal')
const showTransformModal = require('./showTransformModal')
const showSortModal = require('./showSortModal').showSortModal
const showTransformModal = require('./showTransformModal').showTransformModal
const util = require('./util')
const DEFAULT_MODAL_ANCHOR = require('./constants').DEFAULT_MODAL_ANCHOR

12
src/js/treemode.js
View File

@ -1,15 +1,15 @@
'use strict'
const VanillaPicker = require('./vanilla-picker')
const Highlighter = require('./Highlighter')
const NodeHistory = require('./NodeHistory')
const SearchBox = require('./SearchBox')
const ContextMenu = require('./ContextMenu')
const TreePath = require('./TreePath')
const Highlighter = require('./Highlighter').Highlighter
const NodeHistory = require('./NodeHistory').NodeHistory
const SearchBox = require('./SearchBox').SearchBox
const ContextMenu = require('./ContextMenu').ContextMenu
const TreePath = require('./TreePath').TreePath
const Node = require('./Node')
const ModeSwitcher = require('./ModeSwitcher')
const util = require('./util')
const autocomplete = require('./autocomplete')
const autocomplete = require('./autocomplete').autocomplete
const translate = require('./i18n').translate
const setLanguages = require('./i18n').setLanguages
const setLanguage = require('./i18n').setLanguage

195
src/js/util.js
View File

@ -1,10 +1,10 @@
'use strict'
require('./polyfills')
const naturalSort = require('javascript-natural-sort')
const jsonlint = require('./assets/jsonlint/jsonlint')
const jsonMap = require('json-source-map')
const translate = require('./i18n').translate
import './polyfills'
import naturalSort from 'javascript-natural-sort';
import jsonlint from './assets/jsonlint/jsonlint';
import jsonMap from 'json-source-map';
import {translate} from './i18n';
const MAX_ITEMS_FIELDS_COLLECTION = 10000
@ -14,12 +14,12 @@ const MAX_ITEMS_FIELDS_COLLECTION = 10000
* @param {String} jsonString
* @return {JSON} json
*/
exports.parse = function parse (jsonString) {
export function parse(jsonString) {
try {
return JSON.parse(jsonString)
} catch (err) {
// try to throw a more detailed error message using validate
exports.validate(jsonString)
validate(jsonString)
// rethrow the original error
throw err
@ -34,7 +34,7 @@ exports.parse = function parse (jsonString) {
* @param {string} jsString
* @returns {string} json
*/
exports.repair = jsString => {
export function repair(jsString) {
// TODO: refactor this function, it's too large and complicated now
// escape all single and double quotes inside strings
@ -278,13 +278,19 @@ exports.repair = jsString => {
* @param {string} text
* @return {string}
*/
exports.escapeUnicodeChars = text => // see https://www.wikiwand.com/en/UTF-16
// note: we leave surrogate pairs as two individual chars,
// as JSON doesn't interpret them as a single unicode char.
text.replace(
/[\u007F-\uFFFF]/g,
c => '\\u' + ('0000' + c.charCodeAt(0).toString(16)).slice(-4)
)
export function escapeUnicodeChars(
// see https://www.wikiwand.com/en/UTF-16
text
) {
return (
// note: we leave surrogate pairs as two individual chars,
// as JSON doesn't interpret them as a single unicode char.
text.replace(
/[\u007F-\uFFFF]/g,
c => '\\u' + ('0000' + c.charCodeAt(0).toString(16)).slice(-4)
)
);
}
/**
* Validate a string containing a JSON object
@ -293,7 +299,7 @@ exports.escapeUnicodeChars = text => // see https://www.wikiwand.com/en/UTF-16
* @param {String} jsonString String with an (invalid) JSON object
* @throws Error
*/
exports.validate = function validate (jsonString) {
export function validate(jsonString) {
if (typeof (jsonlint) !== 'undefined') {
jsonlint.parse(jsonString)
} else {
@ -307,7 +313,7 @@ exports.validate = function validate (jsonString) {
* @param {Object} b
* @return {Object} a
*/
exports.extend = function extend (a, b) {
export function extend(a, b) {
for (const prop in b) {
if (hasOwnProperty(b, prop)) {
a[prop] = b[prop]
@ -321,7 +327,7 @@ exports.extend = function extend (a, b) {
* @param {Object} a
* @return {Object} a
*/
exports.clear = function clear (a) {
export function clear(a) {
for (const prop in a) {
if (hasOwnProperty(a, prop)) {
delete a[prop]
@ -335,7 +341,7 @@ exports.clear = function clear (a) {
* @param {*} object
* @return {String} type
*/
exports.type = function type (object) {
export function type(object) {
if (object === null) {
return 'null'
}
@ -354,7 +360,7 @@ exports.type = function type (object) {
if (object instanceof RegExp) {
return 'regexp'
}
if (exports.isArray(object)) {
if (isArray(object)) {
return 'array'
}
@ -367,7 +373,8 @@ exports.type = function type (object) {
* @param {String} text
*/
const isUrlRegex = /^https?:\/\/\S+$/
exports.isUrl = function isUrl (text) {
export function isUrl(text) {
return (typeof text === 'string' || text instanceof String) &&
isUrlRegex.test(text)
}
@ -377,7 +384,9 @@ exports.isUrl = function isUrl (text) {
* @param {*} obj
* @returns {boolean} returns true when obj is an array
*/
exports.isArray = obj => Object.prototype.toString.call(obj) === '[object Array]'
export function isArray(obj) {
return Object.prototype.toString.call(obj) === '[object Array]';
}
/**
* Retrieve the absolute left value of a DOM element
@ -385,7 +394,7 @@ exports.isArray = obj => Object.prototype.toString.call(obj) === '[object Array]
* @return {Number} left The absolute left position of this element
* in the browser page.
*/
exports.getAbsoluteLeft = function getAbsoluteLeft (elem) {
export function getAbsoluteLeft(elem) {
const rect = elem.getBoundingClientRect()
return rect.left + window.pageXOffset || document.scrollLeft || 0
}
@ -396,7 +405,7 @@ exports.getAbsoluteLeft = function getAbsoluteLeft (elem) {
* @return {Number} top The absolute top position of this element
* in the browser page.
*/
exports.getAbsoluteTop = function getAbsoluteTop (elem) {
export function getAbsoluteTop(elem) {
const rect = elem.getBoundingClientRect()
return rect.top + window.pageYOffset || document.scrollTop || 0
}
@ -406,7 +415,7 @@ exports.getAbsoluteTop = function getAbsoluteTop (elem) {
* @param {Element} elem
* @param {String} className
*/
exports.addClassName = function addClassName (elem, className) {
export function addClassName(elem, className) {
const classes = elem.className.split(' ')
if (classes.indexOf(className) === -1) {
classes.push(className) // add the class to the array
@ -418,7 +427,7 @@ exports.addClassName = function addClassName (elem, className) {
* remove all classes from the given elements style
* @param {Element} elem
*/
exports.removeAllClassNames = function removeAllClassNames (elem) {
export function removeAllClassNames(elem) {
elem.className = ''
}
@ -427,7 +436,7 @@ exports.removeAllClassNames = function removeAllClassNames (elem) {
* @param {Element} elem
* @param {String} className
*/
exports.removeClassName = function removeClassName (elem, className) {
export function removeClassName(elem, className) {
const classes = elem.className.split(' ')
const index = classes.indexOf(className)
if (index !== -1) {
@ -441,7 +450,7 @@ exports.removeClassName = function removeClassName (elem, className) {
* the formatting from the div itself is not stripped, only from its childs.
* @param {Element} divElement
*/
exports.stripFormatting = function stripFormatting (divElement) {
export function stripFormatting(divElement) {
const childs = divElement.childNodes
for (let i = 0, iMax = childs.length; i < iMax; i++) {
const child = childs[i]
@ -464,7 +473,7 @@ exports.stripFormatting = function stripFormatting (divElement) {
}
// recursively strip childs
exports.stripFormatting(child)
stripFormatting(child)
}
}
@ -475,7 +484,7 @@ exports.stripFormatting = function stripFormatting (divElement) {
* http://stackoverflow.com/questions/1125292/how-to-move-cursor-to-end-of-contenteditable-entity
* @param {Element} contentEditableElement A content editable div
*/
exports.setEndOfContentEditable = function setEndOfContentEditable (contentEditableElement) {
export function setEndOfContentEditable(contentEditableElement) {
let range, selection
if (document.createRange) {
range = document.createRange()// Create a range (a range is a like the selection but invisible)
@ -492,7 +501,7 @@ exports.setEndOfContentEditable = function setEndOfContentEditable (contentEdita
* http://stackoverflow.com/a/3806004/1262753
* @param {Element} contentEditableElement A content editable div
*/
exports.selectContentEditable = function selectContentEditable (contentEditableElement) {
export function selectContentEditable(contentEditableElement) {
if (!contentEditableElement || contentEditableElement.nodeName !== 'DIV') {
return
}
@ -512,7 +521,7 @@ exports.selectContentEditable = function selectContentEditable (contentEditableE
* http://stackoverflow.com/questions/4687808/contenteditable-selected-text-save-and-restore
* @return {Range | TextRange | null} range
*/
exports.getSelection = function getSelection () {
export function getSelection() {
if (window.getSelection) {
const sel = window.getSelection()
if (sel.getRangeAt && sel.rangeCount) {
@ -527,7 +536,7 @@ exports.getSelection = function getSelection () {
* http://stackoverflow.com/questions/4687808/contenteditable-selected-text-save-and-restore
* @param {Range | TextRange | null} range
*/
exports.setSelection = function setSelection (range) {
export function setSelection(range) {
if (range) {
if (window.getSelection) {
const sel = window.getSelection()
@ -546,8 +555,8 @@ exports.setSelection = function setSelection (range) {
* selected text element
* Returns null if no text selection is found
*/
exports.getSelectionOffset = function getSelectionOffset () {
const range = exports.getSelection()
export function getSelectionOffset() {
const range = getSelection()
if (range && 'startOffset' in range && 'endOffset' in range &&
range.startContainer && (range.startContainer === range.endContainer)) {
@ -568,7 +577,7 @@ exports.getSelectionOffset = function getSelectionOffset () {
* {Number} startOffset
* {Number} endOffset
*/
exports.setSelectionOffset = function setSelectionOffset (params) {
export function setSelectionOffset(params) {
if (document.createRange && window.getSelection) {
const selection = window.getSelection()
if (selection) {
@ -583,7 +592,7 @@ exports.setSelectionOffset = function setSelectionOffset (params) {
range.setStart(params.container.firstChild, params.startOffset)
range.setEnd(params.container.firstChild, params.endOffset)
exports.setSelection(range)
setSelection(range)
}
}
}
@ -594,7 +603,7 @@ exports.setSelectionOffset = function setSelectionOffset (params) {
* @param {Object} [buffer]
* @return {String} innerText
*/
exports.getInnerText = function getInnerText (element, buffer) {
export function getInnerText(element, buffer) {
const first = (buffer === undefined)
if (first) {
buffer = {
@ -630,19 +639,19 @@ exports.getInnerText = function getInnerText (element, buffer) {
innerText += '\n'
buffer.flush()
}
innerText += exports.getInnerText(child, buffer)
innerText += getInnerText(child, buffer)
buffer.set('\n')
} else if (child.nodeName === 'BR') {
innerText += buffer.flush()
buffer.set('\n')
} else {
innerText += exports.getInnerText(child, buffer)
innerText += getInnerText(child, buffer)
}
}
return innerText
} else {
if (element.nodeName === 'P' && exports.getInternetExplorerVersion() !== -1) {
if (element.nodeName === 'P' && getInternetExplorerVersion() !== -1) {
// On Internet Explorer, a <p> with hasChildNodes()==false is
// rendered with a new line. Note that a <p> with
// hasChildNodes()==true is rendered without a new line
@ -662,7 +671,7 @@ exports.getInnerText = function getInnerText (element, buffer) {
* @param {Element} parent
* @return {boolean}
*/
exports.hasParentNode = (elem, parent) => {
export function hasParentNode(elem, parent) {
let e = elem ? elem.parentNode : undefined
while (e) {
@ -681,7 +690,7 @@ exports.hasParentNode = (elem, parent) => {
* Source: http://msdn.microsoft.com/en-us/library/ms537509(v=vs.85).aspx
* @return {Number} Internet Explorer version, or -1 in case of an other browser
*/
exports.getInternetExplorerVersion = function getInternetExplorerVersion () {
export function getInternetExplorerVersion() {
if (_ieVersion === -1) {
let rv = -1 // Return value assumes failure.
if (typeof navigator !== 'undefined' && navigator.appName === 'Microsoft Internet Explorer') {
@ -702,7 +711,7 @@ exports.getInternetExplorerVersion = function getInternetExplorerVersion () {
* Test whether the current browser is Firefox
* @returns {boolean} isFirefox
*/
exports.isFirefox = function isFirefox () {
export function isFirefox() {
return (typeof navigator !== 'undefined' && navigator.userAgent.indexOf('Firefox') !== -1)
}
@ -722,11 +731,11 @@ var _ieVersion = -1
* @param {boolean} [useCapture] false by default
* @return {function} the created event listener
*/
exports.addEventListener = function addEventListener (element, action, listener, useCapture) {
export function addEventListener(element, action, listener, useCapture) {
if (element.addEventListener) {
if (useCapture === undefined) { useCapture = false }
if (action === 'mousewheel' && exports.isFirefox()) {
if (action === 'mousewheel' && isFirefox()) {
action = 'DOMMouseScroll' // For Firefox
}
@ -747,11 +756,11 @@ exports.addEventListener = function addEventListener (element, action, listener,
* @param {function} listener The listener function
* @param {boolean} [useCapture] false by default
*/
exports.removeEventListener = function removeEventListener (element, action, listener, useCapture) {
export function removeEventListener(element, action, listener, useCapture) {
if (element.removeEventListener) {
if (useCapture === undefined) { useCapture = false }
if (action === 'mousewheel' && exports.isFirefox()) {
if (action === 'mousewheel' && isFirefox()) {
action = 'DOMMouseScroll' // For Firefox
}
@ -768,7 +777,7 @@ exports.removeEventListener = function removeEventListener (element, action, lis
* @param {Element} parent
* @return {boolean} returns true if elem is a child of the parent
*/
exports.isChildOf = (elem, parent) => {
export function isChildOf(elem, parent) {
let e = elem.parentNode
while (e) {
if (e === parent) {
@ -785,7 +794,7 @@ exports.isChildOf = (elem, parent) => {
* @param {string} jsonPath
* @return {Array}
*/
exports.parsePath = function parsePath (jsonPath) {
export function parsePath(jsonPath) {
const path = []
let i = 0
@ -861,7 +870,7 @@ exports.parsePath = function parsePath (jsonPath) {
* @param {Array.<string | number>} path
* @returns {string}
*/
exports.stringifyPath = function stringifyPath (path) {
export function stringifyPath(path) {
return path
.map(p => {
if (typeof p === 'number') {
@ -880,7 +889,7 @@ exports.stringifyPath = function stringifyPath (path) {
* @param {Object} error
* @return {Object} The error
*/
exports.improveSchemaError = error => {
export function improveSchemaError(error) {
if (error.keyword === 'enum' && Array.isArray(error.schema)) {
let enums = error.schema
if (enums) {
@ -907,16 +916,20 @@ exports.improveSchemaError = error => {
* @param {*} object
* @returns {boolean} Returns true when object is a promise, false otherwise
*/
exports.isPromise = object => object && typeof object.then === 'function' && typeof object.catch === 'function'
export function isPromise(object) {
return object && typeof object.then === 'function' && typeof object.catch === 'function';
}
/**
* Test whether a custom validation error has the correct structure
* @param {*} validationError The error to be checked.
* @returns {boolean} Returns true if the structure is ok, false otherwise
*/
exports.isValidValidationError = validationError => typeof validationError === 'object' &&
Array.isArray(validationError.path) &&
typeof validationError.message === 'string'
export function isValidValidationError(validationError) {
return typeof validationError === 'object' &&
Array.isArray(validationError.path) &&
typeof validationError.message === 'string';
}
/**
* Test whether the child rect fits completely inside the parent rect.
@ -924,7 +937,7 @@ exports.isValidValidationError = validationError => typeof validationError === '
* @param {ClientRect} child
* @param {number} margin
*/
exports.insideRect = (parent, child, margin) => {
export function insideRect(parent, child, margin) {
const _margin = margin !== undefined ? margin : 0
return child.left - _margin >= parent.left &&
child.right + _margin <= parent.right &&
@ -946,7 +959,7 @@ exports.insideRect = (parent, child, margin) => {
* of the trailing.
* @return {function} Return the debounced function
*/
exports.debounce = function debounce (func, wait, immediate) {
export function debounce(func, wait, immediate) {
let timeout
return function () {
const context = this; const args = arguments
@ -969,7 +982,7 @@ exports.debounce = function debounce (func, wait, immediate) {
* @return {{start: number, end: number}} Returns the start and end
* of the changed part in newText.
*/
exports.textDiff = function textDiff (oldText, newText) {
export function textDiff(oldText, newText) {
const len = newText.length
let start = 0
let oldEnd = oldText.length
@ -996,7 +1009,7 @@ exports.textDiff = function textDiff (oldText, newText) {
* @param {DOMElement} el A dom element of a textarea or input text.
* @return {Object} reference Object with 2 properties (start and end) with the identifier of the location of the cursor and selected text.
**/
exports.getInputSelection = el => {
export function getInputSelection(el) {
let startIndex = 0; let endIndex = 0; let normalizedValue; let range; let textInputRange; let len; let endRange
if (typeof el.selectionStart === 'number' && typeof el.selectionEnd === 'number') {
@ -1066,7 +1079,7 @@ exports.getInputSelection = el => {
* @param {Number} column column value, > 0, if exceeds column length - end of column will be returned
* @returns {Number} index of position in text, -1 if not found
*/
exports.getIndexForPosition = (el, row, column) => {
export function getIndexForPosition(el, row, column) {
const text = el.value || ''
if (row > 0 && column > 0) {
const rows = text.split('\n', row)
@ -1084,7 +1097,7 @@ exports.getIndexForPosition = (el, row, column) => {
* @param {Array<String>} paths array of json paths
* @returns {Array<{path: String, line: Number, row: Number}>}
*/
exports.getPositionForPath = function (text, paths) {
export function getPositionForPath(text, paths) {
const me = this
const result = []
let jsmap
@ -1100,7 +1113,7 @@ exports.getPositionForPath = function (text, paths) {
paths.forEach(path => {
const pathArr = me.parsePath(path)
const pointerName = exports.compileJSONPointer(pathArr)
const pointerName = compileJSONPointer(pathArr)
const pointer = jsmap.pointers[pointerName]
if (pointer) {
result.push({
@ -1120,12 +1133,14 @@ exports.getPositionForPath = function (text, paths) {
* @param {Array.<string | number>} path
* @return {string}
*/
exports.compileJSONPointer = path => path
.map(p => ('/' + String(p)
.replace(/~/g, '~0')
.replace(/\//g, '~1')
))
.join('')
export function compileJSONPointer(path) {
return path
.map(p => ('/' + String(p)
.replace(/~/g, '~0')
.replace(/\//g, '~1')
))
.join('');
}
/**
* Get the applied color given a color name or code
@ -1135,7 +1150,7 @@ exports.compileJSONPointer = path => path
* color, and returns null otherwise. Example output:
* 'rgba(255,0,0,0.7)' or 'rgb(255,0,0)'
*/
exports.getColorCSS = color => {
export function getColorCSS(color) {
const ele = document.createElement('div')
ele.style.color = color
return ele.style.color.split(/\s+/).join('').toLowerCase() || null
@ -1146,7 +1161,9 @@ exports.getColorCSS = color => {
* @param {string} color
* @returns {boolean} returns true if a valid color, false otherwise
*/
exports.isValidColor = color => !!exports.getColorCSS(color)
export function isValidColor(color) {
return !!getColorCSS(color);
}
/**
* Make a tooltip for a field based on the field's schema.
@ -1154,7 +1171,7 @@ exports.isValidColor = color => !!exports.getColorCSS(color)
* @param {string} [locale] Locale code (for example, zh-CN)
* @returns {string} Field tooltip, may be empty string if all relevant schema properties are missing
*/
exports.makeFieldTooltip = (schema, locale) => {
export function makeFieldTooltip(schema, locale) {
if (!schema) {
return ''
}
@ -1202,7 +1219,7 @@ exports.makeFieldTooltip = (schema, locale) => {
* @param {string[]} path
* @return {*}
*/
exports.get = (object, path) => {
export function get(object, path) {
let value = object
for (let i = 0; i < path.length && value !== undefined && value !== null; i++) {
@ -1218,7 +1235,7 @@ exports.get = (object, path) => {
* @param {string} name
* @param {Array} existingPropNames Array with existing prop names
*/
exports.findUniqueName = (name, existingPropNames) => {
export function findUniqueName(name, existingPropNames) {
const strippedName = name.replace(/ \(copy( \d+)?\)$/, '')
let validName = strippedName
let i = 1
@ -1238,17 +1255,17 @@ exports.findUniqueName = (name, existingPropNames) => {
* @param {boolean} [includeObjects=false] If true, object and array paths are returned as well
* @return {string[]}
*/
exports.getChildPaths = (json, includeObjects) => {
export function getChildPaths(json, includeObjects) {
const pathsMap = {}
function getObjectChildPaths (json, pathsMap, rootPath, includeObjects) {
const isValue = !Array.isArray(json) && !exports.isObject(json)
const isValue = !Array.isArray(json) && !isObject(json)
if (isValue || includeObjects) {
pathsMap[rootPath || ''] = true
}
if (exports.isObject(json)) {
if (isObject(json)) {
Object.keys(json).forEach(field => {
getObjectChildPaths(json[field], pathsMap, rootPath + '.' + field, includeObjects)
})
@ -1274,14 +1291,14 @@ exports.getChildPaths = (json, includeObjects) => {
* @param {String} [path] JSON pointer
* @param {'asc' | 'desc'} [direction]
*/
exports.sort = (array, path, direction) => {
const parsedPath = path && path !== '.' ? exports.parsePath(path) : []
export function sort(array, path, direction) {
const parsedPath = path && path !== '.' ? parsePath(path) : []
const sign = direction === 'desc' ? -1 : 1
const sortedArray = array.slice()
sortedArray.sort((a, b) => {
const aValue = exports.get(a, parsedPath)
const bValue = exports.get(b, parsedPath)
const aValue = get(a, parsedPath)
const bValue = get(b, parsedPath)
return sign * (aValue > bValue ? 1 : aValue < bValue ? -1 : 0)
})
@ -1294,7 +1311,7 @@ exports.sort = (array, path, direction) => {
* @param {Object} object
* @param {'asc' | 'desc'} [direction]
*/
exports.sortObjectKeys = (object, direction) => {
export function sortObjectKeys(object, direction) {
const sign = (direction === 'desc') ? -1 : 1
const sortedFields = Object.keys(object).sort((a, b) => sign * naturalSort(a, b))
@ -1313,7 +1330,7 @@ exports.sortObjectKeys = (object, direction) => {
* @return {*} castedStr
* @private
*/
exports.parseString = str => {
export function parseString(str) {
const lower = str.toLowerCase()
const num = Number(str) // will nicely fail with '123ab'
const numFloat = parseFloat(str) // will nicely fail with ' '
@ -1339,7 +1356,7 @@ exports.parseString = str => {
* @param {number} size
* @return {string} Returns a human readable size
*/
exports.formatSize = size => {
export function formatSize(size) {
if (size < 900) {
return size.toFixed() + ' B'
}
@ -1370,7 +1387,7 @@ exports.formatSize = size => {
* @return {string} Returns the limited text,
* ending with '...' if the max was exceeded
*/
exports.limitCharacters = (text, maxCharacterCount) => {
export function limitCharacters(text, maxCharacterCount) {
if (text.length <= maxCharacterCount) {
return text
}
@ -1383,7 +1400,9 @@ exports.limitCharacters = (text, maxCharacterCount) => {
* @param {*} value
* @return {boolean}
*/
exports.isObject = value => typeof value === 'object' && value !== null && !Array.isArray(value)
export function isObject(value) {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
/**
* Helper function to test whether an array contains an item
@ -1391,7 +1410,9 @@ exports.isObject = value => typeof value === 'object' && value !== null && !Arra
* @param {*} item
* @return {boolean} Returns true if `item` is in `array`, returns false otherwise.
*/
exports.contains = (array, item) => array.indexOf(item) !== -1
export function contains(array, item) {
return array.indexOf(item) !== -1;
}
function hasOwnProperty (object, key) {
return Object.prototype.hasOwnProperty.call(object, key)

10
src/js/validationUtils.js
View File

@ -1,13 +1,13 @@
const isPromise = require('./util').isPromise
const isValidValidationError = require('./util').isValidValidationError
const stringifyPath = require('./util').stringifyPath
import {isPromise} from './util';
import {isValidValidationError} from './util';
import {stringifyPath} from './util';
/**
* Execute custom validation if configured.
*
* Returns a promise resolving with the custom errors (or an empty array).
*/
function validateCustom (json, onValidate) {
export function validateCustom (json, onValidate) {
if (!onValidate) {
return Promise.resolve([])
}
@ -46,5 +46,3 @@ function validateCustom (json, onValidate) {
return Promise.reject(err)
}
}
exports.validateCustom = validateCustom