- 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/extensions/ext-server_opensave.js

@@ -1,4 +1,3 @@
-/* globals jQuery */
 /**
  * ext-server_opensave.js
  *
@@ -11,19 +10,35 @@ import {canvg} from '../canvg/canvg.js';
 
 export default {
   name: 'server_opensave',
-  async init ({decode64, encode64, importLocale}) {
+  async init ({$, decode64, encode64, importLocale}) {
     const strings = await importLocale();
     const svgEditor = this;
-    const $ = jQuery;
     const svgCanvas = svgEditor.canvas;
+    /**
+     *
+     * @returns {string}
+     */
     function getFileNameFromTitle () {
       const title = svgCanvas.getDocumentTitle();
       // We convert (to underscore) only those disallowed Win7 file name characters
       return title.trim().replace(/[/\\:*?"<>|]/g, '_');
     }
+    /**
+     * Escapes XML predefined entities for quoted attributes.
+     * @param {string} str
+     * @returns {string}
+     */
     function xhtmlEscape (str) {
       return str.replace(/&(?!amp;)/g, '&amp;').replace(/"/g, '&quot;').replace(/</g, '&lt;'); // < is actually disallowed above anyways
     }
+
+    /**
+     *
+     * @param {string} [filename='image']
+     * @param {string} suffix To add to file name
+     * @param {string} uri
+     * @returns {boolean}
+     */
     function clientDownloadSupport (filename, suffix, uri) {
       const support = $('<a>')[0].download === '';
       let a;
@@ -35,6 +50,7 @@ export default {
         a[0].click();
         return true;
       }
+      return false;
     }
     const
       saveSvgAction = svgEditor.curConfig.extPath + 'filesave.php',
@@ -101,7 +117,7 @@ export default {
         }
 
         if (note.length) {
-          alert(note);
+          await $.alert(note);
         }
 
         const filename = getFileNameFromTitle();
@@ -178,36 +194,45 @@ export default {
 
     // It appears necessary to rebuild this input every time a file is
     // selected so the same file can be picked and the change event can fire.
+
+    /**
+     *
+     * @param {external:jQuery} form
+     * @returns {undefined}
+     */
     function rebuildInput (form) {
       form.empty();
       const inp = $('<input type="file" name="svg_file">').appendTo(form);
 
-      function submit () {
-        // This submits the form, which returns the file data using svgEditor.processFile()
+      /**
+       * Submit the form, empty its contents for reuse and show
+       *   uploading message.
+       * @returns {undefined}
+       */
+      async function submit () {
+        // This submits the form, which returns the file data using `svgEditor.processFile()`
         form.submit();
 
         rebuildInput(form);
-        $.process_cancel(strings.uploading, function () {
-          cancelled = true;
-          $('#dialog_box').hide();
-        });
+        await $.process_cancel(strings.uploading);
+        cancelled = true;
+        $('#dialog_box').hide();
       }
 
       if (form[0] === openSvgForm[0]) {
-        inp.change(function () {
+        inp.change(async function () {
           // This takes care of the "are you sure" dialog box
-          svgEditor.openPrep(function (ok) {
-            if (!ok) {
-              rebuildInput(form);
-              return;
-            }
-            submit();
-          });
+          const ok = await svgEditor.openPrep();
+          if (!ok) {
+            rebuildInput(form);
+            return;
+          }
+          await submit();
         });
       } else {
-        inp.change(function () {
+        inp.change(async function () {
           // This submits the form, which returns the file data using svgEditor.processFile()
-          submit();
+          await submit();
         });
       }
     }