- Build: Update with recent jsdoc changes

- npm: Update devDeps

dist/index-es.js

@@ -29089,6 +29089,7 @@ function getImportLocale(_ref) {
 
 /**
 * Store and retrieve preferences.
+* @function module:SVGEditor.pref
 * @param {string} key The preference name to be retrieved or set
 * @param {string} [val] The value. If the value supplied is missing or falsey, no change to the preference will
 * be made unless `mayBeEmpty` is set.
@@ -29135,6 +29136,7 @@ editor.setStrings = setStrings;
 *  storage. This will override URL settings (for security reasons) but
 *  not `svgedit-config-iife.js` configuration (unless initial user
 *  overriding is explicitly permitted there via `allowInitialUserOverride`).
+* @function module:SVGEditor.loadContentAndPrefs
 * @todo Split `allowInitialUserOverride` into `allowOverrideByURL` and
 *  `allowOverrideByUserStorage` so `svgedit-config-iife.js` can disallow some
 *  individual items for URL setting but allow for user storage AND/OR
@@ -29181,6 +29183,7 @@ editor.loadContentAndPrefs = function () {
 };
 /**
 * Allows setting of preferences or configuration (including extensions).
+* @function module:SVGEditor.setConfig
 * @param {module:SVGEditor.Config|module:SVGEditor.Prefs} opts The preferences or configuration (including extensions). See the tutorial on {@tutorial ConfigOptions} for info on config and preferences.
 * @param {PlainObject} [cfgCfg] Describes configuration which applies to the
 *    particular batch of supplied options
@@ -29325,6 +29328,7 @@ editor.setConfig = function (opts, cfgCfg) {
 /**
 * Allows one to override default SVGEdit `open`, `save`, and
 * `export` editor behaviors.
+* @function module:SVGEditor.setCustomHandlers
 * @param {module:SVGEditor.CustomHandler} opts Extension mechanisms may call `setCustomHandlers` with three functions: `opts.open`, `opts.save`, and `opts.exportImage`
 * @returns {Promise<void>}
 */
@@ -29355,9 +29359,10 @@ editor.setCustomHandlers = function (opts) {
   });
 };
 /**
-* @param {boolean} arg
+ * @function module:SVGEditor.randomizeIds
-* @returns {void}
+ * @param {boolean} arg
-*/
+ * @returns {void}
+ */
 
 
 editor.randomizeIds = function (arg) {
@@ -29365,6 +29370,7 @@ editor.randomizeIds = function (arg) {
 };
 /**
 * Auto-run after a Promise microtask.
+* @function module:SVGEditor.init
 * @returns {void}
 */
 
@@ -29530,6 +29536,7 @@ editor.init = function () {
   setupCurPrefs();
   /**
   * Called internally.
+  * @function module:SVGEditor.setIcon
   * @param {string|Element|external:jQuery} elem
   * @param {string|external:jQuery} iconId
   * @param {Float} forcedSize Not in use
@@ -29800,6 +29807,7 @@ editor.init = function () {
   };
   /**
   * Called internally.
+  * @function module:SVGEditor.setIconSize
   * @param {module:SVGEditor.IconSize} size
   * @returns {void}
   */
@@ -30658,7 +30666,7 @@ editor.init = function () {
   * - Removes the `tool_button_current` class from whatever tool currently has it.
   * - Hides any flyouts.
   * - Adds the `tool_button_current` class to the button passed in.
-  * @function module:SVGEDitor.toolButtonClick
+  * @function module:SVGEditor.toolButtonClick
   * @param {string|Element} button The DOM element or string selector representing the toolbar button
   * @param {boolean} noHiding Whether not to hide any flyouts
   * @returns {boolean} Whether the button was disabled or not
@@ -32929,9 +32937,10 @@ editor.init = function () {
       }
     });
     /**
-    * @param {boolean} active
+     * @function module:SVGEditor.setPanning
-    * @returns {void}
+     * @param {boolean} active
-    */
+     * @returns {void}
+     */
 
     editor.setPanning = function (active) {
       svgCanvas.spaceKey = keypan = active;
@@ -33028,6 +33037,7 @@ editor.init = function () {
   */
 
   /**
+   * @function module:SVGEditor.addDropDown
    * @param {Element|string} elem DOM Element or selector
    * @param {module:SVGEditor.DropDownCallback} callback Mouseup callback
    * @param {boolean} dropUp
@@ -35923,9 +35933,10 @@ editor.init = function () {
     return uiStrings$1;
   };
   /**
-  * @returns {Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
+   * @function module:SVGEditor.openPrep
-  *  and `false` after the user confirms.
+   * @returns {boolean|Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
-  */
+   *  and `false` after the user confirms.
+   */
 
 
   editor.openPrep = function () {
@@ -36335,6 +36346,7 @@ editor.init = function () {
 * Queues a callback to be invoked when the editor is ready (or
 *   to be invoked immediately if it is already ready--i.e.,
 *   if `runCallbacks` has been run).
+* @function module:SVGEditor.ready
 * @param {module:SVGEditor.ReadyCallback} cb Callback to be queued to invoke
 * @returns {Promise<ArbitraryCallbackResult>} Resolves when all callbacks, including the supplied have resolved
 */
@@ -36355,6 +36367,7 @@ editor.ready = function (cb) {
 };
 /**
 * Invokes the callbacks previous set by `svgEditor.ready`
+* @function module:SVGEditor.runCallbacks
 * @returns {Promise<void>} Resolves to `undefined` if all callbacks succeeded and rejects otherwise
 */
 
@@ -36405,11 +36418,12 @@ editor.runCallbacks = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRu
   }, _callee20, null, [[0, 5]]);
 }));
 /**
-* @param {string} str The SVG string to load
+ * @function module:SVGEditor.loadFromString
-* @param {PlainObject} [opts={}]
+ * @param {string} str The SVG string to load
-* @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
+ * @param {PlainObject} [opts={}]
-* @returns {Promise<void>}
+ * @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
-*/
+ * @returns {Promise<void>}
+ */
 
 editor.loadFromString = function (str) {
   var _ref36 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
@@ -36451,6 +36465,7 @@ editor.loadFromString = function (str) {
 };
 /**
 * Not presently in use.
+* @function module:SVGEditor.disableUI
 * @param {PlainObject} featList
 * @returns {void}
 */
@@ -36468,14 +36483,15 @@ editor.disableUI = function (featList) {// $(function () {
  */
 
 /**
-* @param {string} url URL from which to load an SVG string via Ajax
+ * @function module:SVGEditor.loadFromURL
-* @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
+ * @param {string} url URL from which to load an SVG string via Ajax
-* @param {boolean} [opts.cache]
+ * @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
-* @param {boolean} [opts.noAlert]
+ * @param {boolean} [opts.cache]
-* @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
+ * @param {boolean} [opts.noAlert]
-*   the SVG (or upon failure to parse the loaded string) when `noAlert` is
+ * @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
-*   enabled
+ *   the SVG (or upon failure to parse the loaded string) when `noAlert` is
-*/
+ *   enabled
+ */
 
 
 editor.loadFromURL = function (url) {
@@ -36522,6 +36538,7 @@ editor.loadFromURL = function (url) {
   });
 };
 /**
+* @function module:SVGEditor.loadFromDataURI
 * @param {string} str The Data URI to base64-decode (if relevant) and load
 * @param {PlainObject} [opts={}]
 * @param {boolean} [opts.noAlert]
@@ -36554,6 +36571,7 @@ editor.loadFromDataURI = function (str) {
   });
 };
 /**
+ * @function module:SVGEditor.addExtension
  * @param {string} name Used internally; no need for i18n.
  * @param {module:svgcanvas.ExtensionInitCallback} init Config to be invoked on this module
  * @param {module:svgcanvas.ExtensionInitArgs} initArgs

dist/index-umd.js

@@ -29095,6 +29095,7 @@
 
   /**
   * Store and retrieve preferences.
+  * @function module:SVGEditor.pref
   * @param {string} key The preference name to be retrieved or set
   * @param {string} [val] The value. If the value supplied is missing or falsey, no change to the preference will
   * be made unless `mayBeEmpty` is set.
@@ -29141,6 +29142,7 @@
   *  storage. This will override URL settings (for security reasons) but
   *  not `svgedit-config-iife.js` configuration (unless initial user
   *  overriding is explicitly permitted there via `allowInitialUserOverride`).
+  * @function module:SVGEditor.loadContentAndPrefs
   * @todo Split `allowInitialUserOverride` into `allowOverrideByURL` and
   *  `allowOverrideByUserStorage` so `svgedit-config-iife.js` can disallow some
   *  individual items for URL setting but allow for user storage AND/OR
@@ -29187,6 +29189,7 @@
   };
   /**
   * Allows setting of preferences or configuration (including extensions).
+  * @function module:SVGEditor.setConfig
   * @param {module:SVGEditor.Config|module:SVGEditor.Prefs} opts The preferences or configuration (including extensions). See the tutorial on {@tutorial ConfigOptions} for info on config and preferences.
   * @param {PlainObject} [cfgCfg] Describes configuration which applies to the
   *    particular batch of supplied options
@@ -29331,6 +29334,7 @@
   /**
   * Allows one to override default SVGEdit `open`, `save`, and
   * `export` editor behaviors.
+  * @function module:SVGEditor.setCustomHandlers
   * @param {module:SVGEditor.CustomHandler} opts Extension mechanisms may call `setCustomHandlers` with three functions: `opts.open`, `opts.save`, and `opts.exportImage`
   * @returns {Promise<void>}
   */
@@ -29361,9 +29365,10 @@
     });
   };
   /**
-  * @param {boolean} arg
+   * @function module:SVGEditor.randomizeIds
-  * @returns {void}
+   * @param {boolean} arg
-  */
+   * @returns {void}
+   */
 
 
   editor.randomizeIds = function (arg) {
@@ -29371,6 +29376,7 @@
   };
   /**
   * Auto-run after a Promise microtask.
+  * @function module:SVGEditor.init
   * @returns {void}
   */
 
@@ -29536,6 +29542,7 @@
     setupCurPrefs();
     /**
     * Called internally.
+    * @function module:SVGEditor.setIcon
     * @param {string|Element|external:jQuery} elem
     * @param {string|external:jQuery} iconId
     * @param {Float} forcedSize Not in use
@@ -29806,6 +29813,7 @@
     };
     /**
     * Called internally.
+    * @function module:SVGEditor.setIconSize
     * @param {module:SVGEditor.IconSize} size
     * @returns {void}
     */
@@ -30664,7 +30672,7 @@
     * - Removes the `tool_button_current` class from whatever tool currently has it.
     * - Hides any flyouts.
     * - Adds the `tool_button_current` class to the button passed in.
-    * @function module:SVGEDitor.toolButtonClick
+    * @function module:SVGEditor.toolButtonClick
     * @param {string|Element} button The DOM element or string selector representing the toolbar button
     * @param {boolean} noHiding Whether not to hide any flyouts
     * @returns {boolean} Whether the button was disabled or not
@@ -32935,9 +32943,10 @@
         }
       });
       /**
-      * @param {boolean} active
+       * @function module:SVGEditor.setPanning
-      * @returns {void}
+       * @param {boolean} active
-      */
+       * @returns {void}
+       */
 
       editor.setPanning = function (active) {
         svgCanvas.spaceKey = keypan = active;
@@ -33034,6 +33043,7 @@
     */
 
     /**
+     * @function module:SVGEditor.addDropDown
      * @param {Element|string} elem DOM Element or selector
      * @param {module:SVGEditor.DropDownCallback} callback Mouseup callback
      * @param {boolean} dropUp
@@ -35929,9 +35939,10 @@
       return uiStrings$1;
     };
     /**
-    * @returns {Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
+     * @function module:SVGEditor.openPrep
-    *  and `false` after the user confirms.
+     * @returns {boolean|Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
-    */
+     *  and `false` after the user confirms.
+     */
 
 
     editor.openPrep = function () {
@@ -36341,6 +36352,7 @@
   * Queues a callback to be invoked when the editor is ready (or
   *   to be invoked immediately if it is already ready--i.e.,
   *   if `runCallbacks` has been run).
+  * @function module:SVGEditor.ready
   * @param {module:SVGEditor.ReadyCallback} cb Callback to be queued to invoke
   * @returns {Promise<ArbitraryCallbackResult>} Resolves when all callbacks, including the supplied have resolved
   */
@@ -36361,6 +36373,7 @@
   };
   /**
   * Invokes the callbacks previous set by `svgEditor.ready`
+  * @function module:SVGEditor.runCallbacks
   * @returns {Promise<void>} Resolves to `undefined` if all callbacks succeeded and rejects otherwise
   */
 
@@ -36411,11 +36424,12 @@
     }, _callee20, null, [[0, 5]]);
   }));
   /**
-  * @param {string} str The SVG string to load
+   * @function module:SVGEditor.loadFromString
-  * @param {PlainObject} [opts={}]
+   * @param {string} str The SVG string to load
-  * @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
+   * @param {PlainObject} [opts={}]
-  * @returns {Promise<void>}
+   * @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
-  */
+   * @returns {Promise<void>}
+   */
 
   editor.loadFromString = function (str) {
     var _ref36 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
@@ -36457,6 +36471,7 @@
   };
   /**
   * Not presently in use.
+  * @function module:SVGEditor.disableUI
   * @param {PlainObject} featList
   * @returns {void}
   */
@@ -36474,14 +36489,15 @@
    */
 
   /**
-  * @param {string} url URL from which to load an SVG string via Ajax
+   * @function module:SVGEditor.loadFromURL
-  * @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
+   * @param {string} url URL from which to load an SVG string via Ajax
-  * @param {boolean} [opts.cache]
+   * @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
-  * @param {boolean} [opts.noAlert]
+   * @param {boolean} [opts.cache]
-  * @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
+   * @param {boolean} [opts.noAlert]
-  *   the SVG (or upon failure to parse the loaded string) when `noAlert` is
+   * @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
-  *   enabled
+   *   the SVG (or upon failure to parse the loaded string) when `noAlert` is
-  */
+   *   enabled
+   */
 
 
   editor.loadFromURL = function (url) {
@@ -36528,6 +36544,7 @@
     });
   };
   /**
+  * @function module:SVGEditor.loadFromDataURI
   * @param {string} str The Data URI to base64-decode (if relevant) and load
   * @param {PlainObject} [opts={}]
   * @param {boolean} [opts.noAlert]
@@ -36560,6 +36577,7 @@
     });
   };
   /**
+   * @function module:SVGEditor.addExtension
    * @param {string} name Used internally; no need for i18n.
    * @param {module:svgcanvas.ExtensionInitCallback} init Config to be invoked on this module
    * @param {module:svgcanvas.ExtensionInitArgs} initArgs

package-lock.json

@@ -1752,9 +1752,9 @@
       }
     },
     "@cypress/fiddle": {
-      "version": "1.18.1",
+      "version": "1.18.2",
-      "resolved": "https://registry.npmjs.org/@cypress/fiddle/-/fiddle-1.18.1.tgz",
+      "resolved": "https://registry.npmjs.org/@cypress/fiddle/-/fiddle-1.18.2.tgz",
-      "integrity": "sha512-hNsfLi6GFgaTkkphfU8OmVA1Seja3lX2W9uiK7GlPQeQ7LFjxOCxh+aHMLL/Wzq2qXfs8DZqQYod4TUhi6OT+A==",
+      "integrity": "sha512-VmKFgETN9oGOaAOY7OoSwLCsM5rILfOyGH0D1MS+U8v3EkAh0I7hhzzu2hCBmVqERmqftnjmm/Avrec8aGFPBg==",
       "dev": true,
       "requires": {
         "@cypress/browserify-preprocessor": "2.1.4",
@@ -1855,9 +1855,9 @@
           },
           "dependencies": {
             "@babel/plugin-proposal-object-rest-spread": {
-              "version": "7.9.5",
+              "version": "7.9.6",
-              "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.9.5.tgz",
+              "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.9.6.tgz",
-              "integrity": "sha512-VP2oXvAf7KCYTthbUHwBlewbl1Iq059f6seJGsxMizaCdgHIeczOr7FBqELhSqfkIl04Fi8okzWzl63UKbQmmg==",
+              "integrity": "sha512-Ga6/fhGqA9Hj+y6whNpPv8psyaK5xzrQwSPsGPloVkvmH+PqW1ixdnfJ9uIO06OjQNYol3PMnfmJ8vfZtkzF+A==",
               "dev": true,
               "requires": {
                 "@babel/helper-plugin-utils": "^7.8.3",
@@ -3900,9 +3900,9 @@
       "dev": true
     },
     "comment-parser": {
-      "version": "0.7.2",
+      "version": "0.7.4",
-      "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-0.7.2.tgz",
+      "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-0.7.4.tgz",
-      "integrity": "sha512-4Rjb1FnxtOcv9qsfuaNuVsmmVn4ooVoBHzYfyKteiXwIU84PClyGA5jASoFMwPV93+FPh9spwueXauxFJZkGAg==",
+      "integrity": "sha512-Nnl77/mt6sj1BiYSVMeMWzvD0183F2MFOJyFRmZHimUVDYS9J40AvXpiFA7RpU5pQH+HkvYc0dnsHpwW2xmbyQ==",
       "dev": true
     },
     "common-tags": {
@@ -4270,9 +4270,9 @@
       "dev": true
     },
     "cssstyle": {
-      "version": "2.2.0",
+      "version": "2.3.0",
-      "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-2.2.0.tgz",
+      "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-2.3.0.tgz",
-      "integrity": "sha512-sEb3XFPx3jNnCAMtqrXPDeSgQr+jojtCeNf8cvMNMh1cG970+lljssvQDzPq6lmmJu2Vhqood/gtEomBiHOGnA==",
+      "integrity": "sha512-AZL67abkUzIuvcHqk7c09cezpGNcxUxU4Ioi/05xHk4DQeTkWmGYftIE6ctU6AEt+Gn4n1lDStOtj7FKycP71A==",
       "dev": true,
       "requires": {
         "cssom": "~0.3.6"
@@ -5553,12 +5553,12 @@
       }
     },
     "eslint-plugin-jsdoc": {
-      "version": "24.0.2",
+      "version": "24.0.5",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-24.0.2.tgz",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-24.0.5.tgz",
-      "integrity": "sha512-tvk/jPpIP6MBVZETYnurKL/VGKzSinSbhpz1x+CzDOX20bmhRnCiexrgre4xF0WD/feg7ARKTVLCygVB3pfG5Q==",
+      "integrity": "sha512-H//NC6Wsxt9J1RbV64nvD38mlT1NbGIpHclet5m//Belz5uLlqcE126E1Thnu87fVQSF8gElgQWUjGGtQSNyfQ==",
       "dev": true,
       "requires": {
-        "comment-parser": "^0.7.2",
+        "comment-parser": "^0.7.4",
         "debug": "^4.1.1",
         "jsdoctypeparser": "^6.1.0",
         "lodash": "^4.17.15",
@@ -5623,9 +5623,9 @@
       }
     },
     "eslint-plugin-no-unsanitized": {
-      "version": "3.1.0",
+      "version": "3.1.1",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-no-unsanitized/-/eslint-plugin-no-unsanitized-3.1.0.tgz",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-no-unsanitized/-/eslint-plugin-no-unsanitized-3.1.1.tgz",
-      "integrity": "sha512-4gOd6Genbs1iN2rk+Duw/AZHglBvl6htbZZyDPUX7YdjWSu1D/iOGq7EtomDZ6VjzHKRo32042JciX+PPDrZgQ==",
+      "integrity": "sha512-JP8GPvpWUDAv2UVsOpKLeup94orazjtMRDDxDcak3JEQX1iAYnzCtH7quIB4WmDU8fAbvzPKEFVkzxYzWCYLvg==",
       "dev": true
     },
     "eslint-plugin-no-use-extend-native": {
@@ -12504,9 +12504,9 @@
       }
     },
     "rollup": {
-      "version": "2.7.6",
+      "version": "2.8.0",
-      "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.7.6.tgz",
+      "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.8.0.tgz",
-      "integrity": "sha512-AdHosxHBKyBsdtbT1/AqbWNQ87O4SSxS4N9iMwEpoCDAT6e4Du3uJSy83mp3ckgmCxly5VeXGx0WHsm21Djytg==",
+      "integrity": "sha512-hyjpreMA0BTNrO68o4wCtcktwYTK8o1UtauOqsPniwDGzN2PvNaKmwa/RHmjNHJMrt6ItY2C7XjpT7TDf6WmJw==",
       "dev": true,
       "requires": {
         "fsevents": "~2.1.2"

package.json

@@ -147,7 +147,7 @@
     "@babel/preset-env": "^7.9.6",
     "@babel/register": "^7.9.0",
     "@cypress/code-coverage": "^3.7.0",
-    "@cypress/fiddle": "^1.18.1",
+    "@cypress/fiddle": "^1.18.2",
     "@fintechstudios/eslint-plugin-chai-as-promised": "^3.0.2",
     "@mysticatea/eslint-plugin": "^13.0.0",
     "babel-plugin-transform-object-rest-spread": "^7.0.0-beta.3",
@@ -171,11 +171,11 @@
     "eslint-plugin-eslint-comments": "^3.1.2",
     "eslint-plugin-html": "^6.0.2",
     "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-jsdoc": "^24.0.2",
+    "eslint-plugin-jsdoc": "^24.0.5",
     "eslint-plugin-markdown": "^1.0.2",
     "eslint-plugin-mocha": "^6.3.0",
     "eslint-plugin-mocha-cleanup": "^1.8.0",
-    "eslint-plugin-no-unsanitized": "^3.1.0",
+    "eslint-plugin-no-unsanitized": "^3.1.1",
     "eslint-plugin-no-use-extend-native": "^0.5.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.2.1",
@@ -206,7 +206,7 @@
     "remark-cli": "^8.0.0",
     "remark-lint-ordered-list-marker-value": "^2.0.0",
     "rimraf": "^3.0.2",
-    "rollup": "2.7.6",
+    "rollup": "2.8.0",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-re": "^1.0.7",
     "rollup-plugin-terser": "^5.3.0",