- Security fix: 'extPath', 'imgPath', 'extIconsPath', 'canvgPath', 'langPath', 'jGraduatePath', and 'jspdfPath' were not being prevented

- Breaking change: Rename "svgutils.js" to "utilities.js" (make in conformity with JSDoc module naming convention)
- Breaking change: Rename "svgedit.js" to "namespaces.js" (to make clear purpose and avoid confusing with editor)
- Breaking change: Rename "jquery-svg.js" to "jQuery.attr.js"
- Breaking change: Rename "jquery.contextMenu.js" to "jQuery.contextMenu.js"
- Breaking change: Rename "jquery.jpicker.js" to "jQuery.jPicker.js"
- Breaking change: Rename "JQuerySpinBtn.css" to "jQuery.SpinButton.css"
- Breaking change: Rename "JQuerySpinBtn.js" to "jQuery.SpinButton.js" (to have file name more closely reflect name)
- Breaking change: Rename "jquery.svgicons.js" to "jQuery.svgIcons.js"
- Breaking change: Rename "jquery.jgraduate.js" to "jQuery.jGraduate.js"
- Breaking change: Rename "pathseg.js" to "svgpathseg.js" (as it is a poyfill of SVGPathSeg)
- Breaking change: Rename `addSvgElementFromJson()` to `addSVGElementFromJson` for consistency
- Breaking change: Rename `changeSvgContent()` to `changeSVGContent()` for consistency
- Breaking change: Have `exportPDF` resolve with `output` and `outputType` rather than `dataurlstring` (as type may vary)
- Breaking change: Rename `extensions/mathjax/MathJax.js` to `extensions/mathjax/MathJax.min.js`
- Breaking change: Avoid recent change to have editor ready callbacks return Promises (we're not using and advantageous to keep sequential)
- Breaking change: Avoid recent addition of locale-side function in ext-imagelib for l10n
- Breaking change: Change name of ext-arrows.js from `Arrows` to `arrows` for sake of file path (not localized anyways).
- Breaking change: Change `addlangData` extension event to `addLangData` for consistency with method name
- Breaking change: Have `readLang`  return lang and data but do not call `setLang`
- Fix: Have general locales load first so extensions may use
- Fix: Provide `importLocale` to extensions `init` so it may delay adding of the extension until locale data loaded
- Fix: Ensure call to `rasterExport` without `imgType` properly sets MIME type to PNG
- Fix: Wrong name for moinsave
- Update: Update WebAppFind per new API changes
- Enhancement: Make `setStrings` public on editor for late setting (used
  by `ext-shapes.js`)
- Enhancement: Add `extensions_added` event
- Enhancement: Add `message` event (Relay messages including those which
  have been been received prior to extension load)
- Enhancement: Allow SVGEdit to work out of the box--avoid need for copying sample config file. Should also help with Github-based file servers
- Enhancement: Allow avoiding "name" in extension export (just extract out of file name)
- Enhancement: Add stack blur to canvg by default (and refactoring it)
- Enhancement: Return `Promise` for `embedImage` (as with some other loading methods)
- Enhancement: Supply `importLocale` to `langReady` to facilitate extension locale loading
- Enhancement: Recover if an extension fails to load (just log and otherwise ignore)
- Enhancement: More i18n of extensions (also fixed issue with some console warnings about missing locale strings); i18nize Hello World too
- Enhancement: Allowing importing of locales within `addLangData`
- npm: Update devDeps
- Docs: Migrate copies of all old wiki pages to docs/from-old-wiki folder; intended for a possible move to Markdown, so raw HTML (with formatting) was not preserved, though named links had their absolute URL links preserved
- Docs: Begin deleting `SvgCanvas.md` as ensuring jsdoc has replacements
- Docs: Add Edtior doc file for help to general users
- Docs: Clarify/simplify install instructions
- npm/Docs (JSDoc): Add script to check for overly generic types
- Docs (JSDoc): For config/prefs and extension creating, link to tutorials (moved tutorials to own directory to avoid recursion problems by jsdoc)
- Docs (JSDoc): Add modules (upper case for usual main entrance files or regular names)
- Docs (JSDoc): Fill out missing areas; indicate return of `undefined`; consistency with `@returns`
- Docs (JSDoc): Add our own layout template to support overflow
- Docs (JSDoc): Use cleverLinks and disallow unknown tags
- Docs (JSDoc): Insist on "pedantic" flag; put output directory in config
- Docs (JSDoc): Use more precise Integer/Float over number, the specific type of array/function/object
- Docs (JSDoc): Use `@throws`, `@enum`, `@event`/`@fires`/`@listens`
- Docs: Generally update/improve docs (fixes #92)
- Docs: Update links to `latest` path (Avoid needing to update such references upon each release)
- Docs: 80 chars max
- Refactoring: Drop code for extension as function (already requiring export to be an object)
- Refactoring: Object destructuring, `Object.entries`, Object shorthand, array extras, more camelCase variable names
- Refactoring: Add a `Command` base class
- Refactoring: Simplify svgicons `callback` ready detection
- Refactoring: Put `let` or `const` closer to scope
- Refactoring: Remove unneeded `delimiter` from regex escaping utility
- Refactoring: Clearer variable names
- Refactoring: Use (non-deprecated) Event constructors
- Testing: Use new Sinon

editor/units.js

@@ -1,13 +1,12 @@
 /**
- * Package: svgedit.units
+ * Tools for working with units
+ * @module units
+ * @license MIT
  *
- * Licensed under the MIT License
- *
- * Copyright(c) 2010 Alexis Deveria
- * Copyright(c) 2010 Jeff Schiller
+ * @copyright 2010 Alexis Deveria, 2010 Jeff Schiller
  */
 
-import {NS} from './svgedit.js';
+import {NS} from './namespaces.js';
 
 const wAttrs = ['x', 'x1', 'cx', 'rx', 'width'];
 const hAttrs = ['y', 'y1', 'cy', 'ry', 'height'];
@@ -29,25 +28,52 @@ const unitNumMap = {
 // Container of elements.
 let elementContainer_;
 
-/**
- * Stores mapping of unit type to user coordinates.
- */
+// Stores mapping of unit type to user coordinates.
 let typeMap_ = {};
 
 /**
- * ElementContainer interface
- *
- * function getBaseUnit() - Returns a string of the base unit type of the container ('em')
- * function getElement() - Returns an element in the container given an id
- * function getHeight() - Returns the container's height
- * function getWidth() - Returns the container's width
- * function getRoundDigits() - Returns the number of digits number should be rounded to
+ * @interface module:units.ElementContainer
+ */
+/**
+ * @function module:units.ElementContainer#getBaseUnit
+ * @returns {string} The base unit type of the container ('em')
+ */
+/**
+ * @function module:units.ElementContainer#getElement
+ * @returns {Element} An element in the container given an id
+ */
+/**
+ * @function module:units.ElementContainer#getHeight
+ * @returns {Float} The container's height
+ */
+/**
+ * @function module:units.ElementContainer#getWidth
+ * @returns {Float} The container's width
+ */
+/**
+ * @function module:units.ElementContainer#getRoundDigits
+ * @returns {Integer} The number of digits number should be rounded to
+ */
+
+/**
+ * @typedef {PlainObject} module:units.TypeMap
+ * @property {Float} em
+ * @property {Float} ex
+ * @property {Float} in
+ * @property {Float} cm
+ * @property {Float} mm
+ * @property {Float} pt
+ * @property {Float} pc
+ * @property {Integer} px
+ * @property {0} %
  */
 
 /**
  * Initializes this module.
  *
- * @param elementContainer - An object implementing the ElementContainer interface.
+ * @function module:units.init
+ * @param {module:units.ElementContainer} elementContainer - An object implementing the ElementContainer interface.
+ * @returns {undefined}
  */
 export const init = function (elementContainer) {
   elementContainer_ = elementContainer;
@@ -82,19 +108,27 @@ export const init = function (elementContainer) {
 */
 
 /**
-* @returns The unit object with values for each unit
+ * @function module:units.getTypeMap
+ * @returns {module:units.TypeMap} The unit object with values for each unit
 */
 export const getTypeMap = function () {
   return typeMap_;
 };
 
 /**
-* Rounds a given value to a float with number of digits defined in save_options
+* @typedef {GenericArray} module:units.CompareNumbers
+* @property {Integer} length 2
+* @property {Float} 0
+* @property {Float} 1
+*/
+
+/**
+* Rounds a given value to a float with number of digits defined in
+* `round_digits` of `saveOptions`
 *
-* @param val - The value as a String, Number or Array of two numbers to be rounded
-*
-* @returns
-* If a string/number was given, returns a Float. If an array, return a string
+* @function module:units.shortFloat
+* @param {string|Float|module:units.CompareNumbers} val - The value (or Array of two numbers) to be rounded
+* @returns {Float|string} If a string/number was given, returns a Float. If an array, return a string
 * with comma-separated floats
 */
 export const shortFloat = function (val) {
@@ -111,7 +145,8 @@ export const shortFloat = function (val) {
 
 /**
 * Converts the number to given unit or baseUnit
-* @returns {number}
+* @function module:units.convertUnit
+* @returns {Float}
 */
 export const convertUnit = function (val, unit) {
   unit = unit || elementContainer_.getBaseUnit();
@@ -124,9 +159,11 @@ export const convertUnit = function (val, unit) {
 /**
 * Sets an element's attribute based on the unit in its current value.
 *
-* @param elem - DOM element to be changed
-* @param attr - String with the name of the attribute associated with the value
-* @param val - String with the attribute value to convert
+* @function module:units.setUnitAttr
+* @param {Element} elem - DOM element to be changed
+* @param {string} attr - Name of the attribute associated with the value
+* @param {string} val - Attribute value to convert
+* @returns {undefined}
 */
 export const setUnitAttr = function (elem, attr, val) {
   //  if (!isNaN(val)) {
@@ -176,7 +213,9 @@ const attrsToConvert = {
 
 /**
 * Converts all applicable attributes to the configured baseUnit
-* @param element - A DOM element whose attributes should be converted
+* @function module:units.convertAttrs
+* @param {Element} element - A DOM element whose attributes should be converted
+* @returns {undefined}
 */
 export const convertAttrs = function (element) {
   const elName = element.tagName;
@@ -203,8 +242,10 @@ export const convertAttrs = function (element) {
 * Converts given values to numbers. Attributes must be supplied in
 * case a percentage is given
 *
-* @param attr - String with the name of the attribute associated with the value
-* @param val - String with the attribute value to convert
+* @function module:units.convertToNum
+* @param {string} attr - Name of the attribute associated with the value
+* @param {string} val - Attribute value to convert
+* @returns {Float} The converted number
 */
 export const convertToNum = function (attr, val) {
   // Return a number if that's what it already is
@@ -231,8 +272,10 @@ export const convertToNum = function (attr, val) {
 
 /**
 * Check if an attribute's value is in a valid format
-* @param attr - String with the name of the attribute associated with the value
-* @param val - String with the attribute value to check
+* @function module:units.isValidUnit
+* @param {string} attr - The name of the attribute associated with the value
+* @param {string} val - The attribute value to check
+* @returns {boolean} Whether the unit is valid
 */
 export const isValidUnit = function (attr, val, selectedElement) {
   if (unitAttrs.includes(attr)) {