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

@@ -1,57 +1,48 @@
-/*
-Embedded SVG-edit API
-
-General usage:
-- Have an iframe somewhere pointing to a version of svg-edit > r1000
-- Initialize the magic with:
-const svgCanvas = new EmbeddedSVGEdit(window.frames.svgedit);
-- Pass functions in this format:
-svgCanvas.setSvgString('string')
-- Or if a callback is needed:
-svgCanvas.setSvgString('string')(function(data, error){
-  if (error){
-  // There was an error
-  } else{
-  // Handle data
-  }
-})
-
-Everything is done with the same API as the real svg-edit,
-and all documentation is unchanged.
-
-However, this file depends on the postMessage API which
-can only support JSON-serializable arguments and
-return values, so, for example, arguments whose value is
-'undefined', a function, a non-finite number, or a built-in
-object like Date(), RegExp(), etc. will most likely not behave
-as expected. In such a case one may need to host
-the SVG editor on the same domain and reference the
-JavaScript methods on the frame itself.
-
-The only other difference is
-when handling returns: the callback notation is used instead.
-
-const blah = new EmbeddedSVGEdit(window.frames.svgedit);
-blah.clearSelection('woot', 'blah', 1337, [1, 2, 3, 4, 5, 'moo'], -42, {a: 'tree',b:6, c: 9})(function(){console.log('GET DATA',arguments)})
+/**
+* Handles underlying communication between the embedding window and the editor frame
+* @module EmbeddedSVGEdit
 */
+
 let cbid = 0;
 
-function getCallbackSetter (d) {
-  return function () {
-    const t = this, // New callback
-      args = [].slice.call(arguments),
-      cbid = t.send(d, args, function () {}); // The callback (currently it's nothing, but will be set later)
+/**
+* @callback module:EmbeddedSVGEdit.GenericCallback
+* @param {...*} args Signature dependent on the function
+* @returns {*} Return dependent on the function
+*/
+/**
+* @callback module:EmbeddedSVGEdit.CallbackSetter
+* @param {module:EmbeddedSVGEdit.GenericCallback} newCallback Callback to be stored (signature dependent on function)
+* @returns {undefined}
+*/
+/**
+* @callback module:EmbeddedSVGEdit.CallbackSetGetter
+* @param {...*} args Signature dependent on the function
+* @returns {module:EmbeddedSVGEdit.CallbackSetter}
+*/
 
-    return function (newcallback) {
-      t.callbacks[cbid] = newcallback; // Set callback
+/**
+* @param {string} d
+* @returns {module:EmbeddedSVGEdit.CallbackSetGetter}
+*/
+function getCallbackSetter (funcName) {
+  return function (...args) {
+    const t = this, // New callback
+      cbid = t.send(funcName, args, function () {}); // The callback (currently it's nothing, but will be set later)
+
+    return function (newCallback) {
+      t.callbacks[cbid] = newCallback; // Set callback
     };
   };
 }
 
-/*
+/**
 * Having this separate from messageListener allows us to
 * avoid using JSON parsing (and its limitations) in the case
 * of same domain control
+* @param {module:EmbeddedSVGEdit.EmbeddedSVGEdit} t The `this` value
+* @param {JSON} data
+* @returns {undefined}
 */
 function addCallback (t, data) {
   const result = data.result || data.error,
@@ -65,6 +56,10 @@ function addCallback (t, data) {
   }
 }
 
+/**
+* @param {Event} e
+* @returns {undefined}
+*/
 function messageListener (e) {
   // We accept and post strings as opposed to objects for the sake of IE9 support; this
   //   will most likely be changed in the future
@@ -82,6 +77,15 @@ function messageListener (e) {
   addCallback(this, data);
 }
 
+/**
+* @callback module:EmbeddedSVGEdit.MessageListener
+* @param {MessageEvent} e
+* @returns {undefined}
+*/
+/**
+* @param {module:EmbeddedSVGEdit.EmbeddedSVGEdit} t The `this` value
+* @returns {module:EmbeddedSVGEdit.MessageListener} Event listener
+*/
 function getMessageListener (t) {
   return function (e) {
     messageListener.call(t, e);
@@ -89,13 +93,52 @@ function getMessageListener (t) {
 }
 
 /**
-* @param {HTMLIFrameElement} frame
-* @param {array} [allowedOrigins=[]] Array of origins from which incoming
-*   messages will be allowed when same origin is not used; defaults to none.
-*   If supplied, it should probably be the same as svgEditor's allowedOrigins
-*/
+* Embedded SVG-edit API
+* General usage:
+- Have an iframe somewhere pointing to a version of svg-edit > r1000
+* @example
 
+// Initialize the magic with:
+const svgCanvas = new EmbeddedSVGEdit(window.frames.svgedit);
+
+// Pass functions in this format:
+svgCanvas.setSvgString('string');
+
+// Or if a callback is needed:
+svgCanvas.setSvgString('string')(function(data, error){
+  if (error){
+  // There was an error
+  } else{
+  // Handle data
+  }
+});
+
+// Everything is done with the same API as the real svg-edit,
+// and all documentation is unchanged.
+
+// However, this file depends on the postMessage API which
+// can only support JSON-serializable arguments and
+// return values, so, for example, arguments whose value is
+// 'undefined', a function, a non-finite number, or a built-in
+// object like Date(), RegExp(), etc. will most likely not behave
+// as expected. In such a case one may need to host
+// the SVG editor on the same domain and reference the
+// JavaScript methods on the frame itself.
+
+// The only other difference is
+// when handling returns: the callback notation is used instead.
+const blah = new EmbeddedSVGEdit(window.frames.svgedit);
+blah.clearSelection('woot', 'blah', 1337, [1, 2, 3, 4, 5, 'moo'], -42, {a: 'tree',b:6, c: 9})(function(){console.log('GET DATA',arguments)})
+*
+* @memberof module:EmbeddedSVGEdit
+*/
 class EmbeddedSVGEdit {
+  /**
+  * @param {HTMLIFrameElement} frame
+  * @param {string[]} [allowedOrigins=[]] Array of origins from which incoming
+  *   messages will be allowed when same origin is not used; defaults to none.
+  *   If supplied, it should probably be the same as svgEditor's allowedOrigins
+  */
   constructor (frame, allowedOrigins) {
     const t = this;
     this.allowedOrigins = allowedOrigins || [];
@@ -118,7 +161,7 @@ class EmbeddedSVGEdit {
     // Run in svgedit itself
     const functions = [
       'addExtension',
-      'addSvgElementFromJson',
+      'addSVGElementFromJson',
       'addToSelection',
       'alignSelectedElements',
       'assignAttributes',
@@ -292,6 +335,11 @@ class EmbeddedSVGEdit {
     });
   }
 
+  /**
+  * @param {string} name
+  * @param {ArgumentsArray} args Signature dependent on function
+  * @param {module:EmbeddedSVGEdit.GenericCallback} callback
+  */
   send (name, args, callback) {
     const t = this;
     cbid++;