- 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/math.js

@@ -1,21 +1,25 @@
 /**
- * Package: svedit.math
+ * Mathematical utilities
+ * @module math
+ * @license MIT
  *
- * Licensed under the MIT License
- *
- * Copyright(c) 2010 Alexis Deveria
- * Copyright(c) 2010 Jeff Schiller
+ * @copyright 2010 Alexis Deveria, 2010 Jeff Schiller
  */
 
 /**
-* @typedef AngleCoord45
-* @type {Object}
-* @property {number} x - The angle-snapped x value
-* @property {number} y - The angle-snapped y value
-* @property {number} a - The angle at which to snap
+* @typedef {PlainObject} module:math.AngleCoord45
+* @property {Float} x - The angle-snapped x value
+* @property {Float} y - The angle-snapped y value
+* @property {Integer} a - The angle at which to snap
 */
 
-import {NS} from './svgedit.js';
+/**
+* @typedef {PlainObject} module:math.XYObject
+* @property {Float} x
+* @property {Float} y
+*/
+
+import {NS} from './namespaces.js';
 import {getTransformList} from './svgtransformlist.js';
 
 // Constants
@@ -27,10 +31,11 @@ const svg = document.createElementNS(NS.SVG, 'svg');
 /**
  * A (hopefully) quicker function to transform a point by a matrix
  * (this function avoids any DOM calls and just does the math)
- * @param {number} x - Float representing the x coordinate
- * @param {number} y - Float representing the y coordinate
+ * @function module:math.transformPoint
+ * @param {Float} x - Float representing the x coordinate
+ * @param {Float} y - Float representing the y coordinate
  * @param {SVGMatrix} m - Matrix object to transform the point with
- * @returns {Object} An x, y object representing the transformed point
+ * @returns {module:math.XYObject} An x, y object representing the transformed point
 */
 export const transformPoint = function (x, y, m) {
   return {x: m.a * x + m.c * y + m.e, y: m.b * x + m.d * y + m.f};
@@ -39,6 +44,7 @@ export const transformPoint = function (x, y, m) {
 /**
  * Helper function to check if the matrix performs no actual transform
  * (i.e. exists for identity purposes)
+ * @function module:math.isIdentity
  * @param {SVGMatrix} m - The matrix object to check
  * @returns {boolean} Indicates whether or not the matrix is 1,0,0,1,0,0
 */
@@ -47,8 +53,9 @@ export const isIdentity = function (m) {
 };
 
 /**
- * This function tries to return a SVGMatrix that is the multiplication m1*m2.
+ * This function tries to return a `SVGMatrix` that is the multiplication `m1 * m2`.
  * We also round to zero when it's near zero
+ * @function module:math.matrixMultiply
  * @param {...SVGMatrix} args - Matrix objects to multiply
  * @returns {SVGMatrix} The matrix object resulting from the calculation
 */
@@ -69,7 +76,8 @@ export const matrixMultiply = function (...args) {
 
 /**
  * See if the given transformlist includes a non-indentity matrix transform
- * @param {Object} [tlist] - The transformlist to check
+ * @function module:math.hasMatrixTransform
+ * @param {SVGTransformList} [tlist] - The transformlist to check
  * @returns {boolean} Whether or not a matrix transform was found
 */
 export const hasMatrixTransform = function (tlist) {
@@ -82,23 +90,28 @@ export const hasMatrixTransform = function (tlist) {
   return false;
 };
 
+/**
+* @typedef {PlainObject} module:math.TransformedBox An object with the following values
+* @property {module:math.XYObject} tl - The top left coordinate
+* @property {module:math.XYObject} tr - The top right coordinate
+* @property {module:math.XYObject} bl - The bottom left coordinate
+* @property {module:math.XYObject} br - The bottom right coordinate
+* @property {PlainObject} aabox - Object with the following values:
+* @property {Float} aabox.x - Float with the axis-aligned x coordinate
+* @property {Float} aabox.y - Float with the axis-aligned y coordinate
+* @property {Float} aabox.width - Float with the axis-aligned width coordinate
+* @property {Float} aabox.height - Float with the axis-aligned height coordinate
+*/
+
 /**
  * Transforms a rectangle based on the given matrix
- * @param {number} l - Float with the box's left coordinate
- * @param {number} t - Float with the box's top coordinate
- * @param {number} w - Float with the box width
- * @param {number} h - Float with the box height
+ * @function module:math.transformBox
+ * @param {Float} l - Float with the box's left coordinate
+ * @param {Float} t - Float with the box's top coordinate
+ * @param {Float} w - Float with the box width
+ * @param {Float} h - Float with the box height
  * @param {SVGMatrix} m - Matrix object to transform the box by
- * @returns {Object} An object with the following values:
- * tl - The top left coordinate (x,y object)
- * tr - The top right coordinate (x,y object)
- * bl - The bottom left coordinate (x,y object)
- * br - The bottom right coordinate (x,y object)
- * aabox - Object with the following values:
- * x - Float with the axis-aligned x coordinate
- * y - Float with the axis-aligned y coordinate
- * width - Float with the axis-aligned width coordinate
- * height - Float with the axis-aligned height coordinate
+ * @returns {module:math.TransformedBox}
 */
 export const transformBox = function (l, t, w, h, m) {
   const tl = transformPoint(l, t, m),
@@ -127,14 +140,15 @@ export const transformBox = function (l, t, w, h, m) {
 
 /**
  * This returns a single matrix Transform for a given Transform List
- * (this is the equivalent of SVGTransformList.consolidate() but unlike
- * that method, this one does not modify the actual SVGTransformList)
- * This function is very liberal with its min, max arguments
- * @param {Object} tlist - The transformlist object
- * @param {integer} [min=0] - Optional integer indicating start transform position
- * @param {integer} [max] - Optional integer indicating end transform position;
- *   defaults to one less than the tlist's numberOfItems
- * @returns {Object} A single matrix transform object
+ * (this is the equivalent of `SVGTransformList.consolidate()` but unlike
+ * that method, this one does not modify the actual `SVGTransformList`).
+ * This function is very liberal with its `min`, `max` arguments
+ * @function module:math.transformListToTransform
+ * @param {SVGTransformList} tlist - The transformlist object
+ * @param {Integer} [min=0] - Optional integer indicating start transform position
+ * @param {Integer} [max] - Optional integer indicating end transform position;
+ *   defaults to one less than the tlist's `numberOfItems`
+ * @returns {SVGTransform} A single matrix transform object
 */
 export const transformListToTransform = function (tlist, min, max) {
   if (tlist == null) {
@@ -159,6 +173,7 @@ export const transformListToTransform = function (tlist, min, max) {
 
 /**
  * Get the matrix object for a given element
+ * @function module:math.getMatrix
  * @param {Element} elem - The DOM element to check
  * @returns {SVGMatrix} The matrix object associated with the element's transformlist
 */
@@ -170,11 +185,12 @@ export const getMatrix = function (elem) {
 /**
  * Returns a 45 degree angle coordinate associated with the two given
  * coordinates
- * @param {number} x1 - First coordinate's x value
- * @param {number} x2 - Second coordinate's x value
- * @param {number} y1 - First coordinate's y value
- * @param {number} y2 - Second coordinate's y value
- * @returns {AngleCoord45}
+ * @function module:math.snapToAngle
+ * @param {Integer} x1 - First coordinate's x value
+ * @param {Integer} x2 - Second coordinate's x value
+ * @param {Integer} y1 - First coordinate's y value
+ * @param {Integer} y2 - Second coordinate's y value
+ * @returns {module:math.AngleCoord45}
 */
 export const snapToAngle = function (x1, y1, x2, y2) {
   const snap = Math.PI / 4; // 45 degrees
@@ -193,6 +209,7 @@ export const snapToAngle = function (x1, y1, x2, y2) {
 
 /**
  * Check if two rectangles (BBoxes objects) intersect each other
+ * @function module:math.rectsIntersect
  * @param {SVGRect} r1 - The first BBox-like object
  * @param {SVGRect} r2 - The second BBox-like object
  * @returns {boolean} True if rectangles intersect