- Breaking change: loadSvgString now returns a Promise rather than accepting a callback

- Breaking change: Treat callbacks to `editor.ready` as Promises, only resolving after all resolve
- Breaking change: Make `editor.runCallbacks` return a `Promise` which resolves upon all callbacks resolving
- Breaking change: Require `npx` (used with `babel-node`) to allow Node files
  for HTML building and JSDoc type checking to be expressed as ESM.
- Breaking change: `addExtension` now throws upon a repeated attempt to add an already-added extension
- Breaking change (storage preference cookies): Namespace the cookie as "svgeditstore" instead of just "store"
- Breaking change (API): Remove `svgCanvas.rasterExport` fourth (callback) argument, collapsing fifth (options) to fourth
- Breaking change (API): Remove `svgCanvas.exportPDF` third (callback) argument
- Breaking change (API): `editor/contextmenu.js` `add` now throws instead of giving a console error only upon detecting a bad menuitem or preexisting context menu
- Breaking change (API): Remove `svgCanvas.embedImage` second (callback) argument
- Breaking change (API): Make `getHelpXML` a class instead of instance method of `RGBColor`
- Breaking change (internal API): Refactor `dbox` (and `alert`/`confirm`/`process`/`prompt`/`select`) to avoid a callback argument in favor of return a Promise
- Fix: Avoid running in extension `langReady` multiple times or serially
- Enhancement (API): Add svgCanvas.runExtension to run just one extension and add `nameFilter` callback to `runExtensions`
- Enhancement (API): Supply `$` (our wrapped jQuery) to extensions so can use its plugins, e.g., dbox with its `alert`
- Enhancement: Use alert dialog in place of `alert` in webappfind
- Enhancement: `editor.ready` now returns a Promise resolving when all callbacks have resolved
- Enhancement: Allow `noAlert` option as part of second argument to `loadSvgString` (and `loadFromURL` and `loadFromDataURI`) to avoid UI alert (and trigger promise rejection)
- Enhancement: Make `dbox` as a separate module for alert, prompt, etc. dialogs
- Refactoring: Internal `PaintBox` as class; other misc. tweaks; no bitwise in canvg
- Linting (ESLint): Further linting changes (for editor); rename `.eslintrc` -> `.eslintrc.json` per recommendation
- Optimization: Recompress images (imageoptim-cli updated)
- npm: Update devDeps
- npm: Bump to 4.0.0

editor/embedapi-dom.js

@@ -10,23 +10,42 @@ const $ = jQuery;
 
 let svgCanvas = null;
 
+/**
+* @param {string} data
+* @param {string} error
+* @returns {undefined}
+*/
 function handleSvgData (data, error) {
   if (error) {
-    alert('error ' + error);
+    // Todo: This should be replaced with a general purpose dialog alert library call
+    alert('error ' + error); // eslint-disable-line no-alert
   } else {
-    alert('Congratulations. Your SVG string is back in the host page, do with it what you will\n\n' + data);
+    // Todo: This should be replaced with a general purpose dialog alert library call
+    alert('Congratulations. Your SVG string is back in the host page, do with it what you will\n\n' + data); // eslint-disable-line no-alert
   }
 }
 
+/**
+* Set the canvas with an example SVG string.
+* @returns {undefined}
+*/
 function loadSvg () {
   const svgexample = '<svg width="640" height="480" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg"><g><title>Layer 1</title><rect stroke-width="5" stroke="#000000" fill="#FF0000" id="svg_1" height="35" width="51" y="35" x="32"/><ellipse ry="15" rx="24" stroke-width="5" stroke="#000000" fill="#0000ff" id="svg_2" cy="60" cx="66"/></g></svg>';
   svgCanvas.setSvgString(svgexample);
 }
 
+/**
+*
+* @returns {undefined}
+*/
 function saveSvg () {
   svgCanvas.getSvgString()(handleSvgData);
 }
 
+/**
+* Perform a PNG export.
+* @returns {undefined}
+*/
 function exportPNG () {
   svgCanvas.getUIStrings()(function (uiStrings) {
     const str = uiStrings.notification.loadingImage;
@@ -41,6 +60,10 @@ function exportPNG () {
   });
 }
 
+/**
+* Perform a PDF export.
+* @returns {undefined}
+*/
 function exportPDF () {
   svgCanvas.getUIStrings()(function (uiStrings) {
     const str = uiStrings.notification.loadingImage;
@@ -83,7 +106,7 @@ iframe[0].addEventListener('load', function () {
   try {
     doc = frame.contentDocument || frame.contentWindow.document;
   } catch (err) {
-    console.log('Blocked from accessing document', err);
+    console.log('Blocked from accessing document', err); // eslint-disable-line no-console
   }
   if (doc) {
     // Todo: Provide a way to get this to occur by `postMessage`