2e5c7557a9
- 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
52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
# Version 4.0.0
|
|
|
|
This version introduces a number of breaking changes, a number being
|
|
required to move to a more Promise-based API and one where problems are
|
|
detected early at run-time by throwing rather than logging.
|
|
|
|
Some API changes also involve switching to class methods over instance
|
|
methods, though these were private/internally used APIs.
|
|
|
|
Please see the CHANGES file (or the Git history or Github tracker) for
|
|
fixes and enhancements.
|
|
|
|
## Breaking changes
|
|
|
|
- The cookie to track storage preferences is now namespaced as
|
|
"svgeditstore" instead of just "store".
|
|
- Require `npx` (used with `babel-node`) to allow Node files for HTML
|
|
building and JSDoc type checking to be expressed as ESM.
|
|
|
|
### Breaking changes (public API)
|
|
|
|
#### Callback-to-Promise changes
|
|
|
|
- `loadSvgString` now returns a `Promise` rather than accepting a callback.
|
|
- Callbacks to `editor.ready` are treated as Promises, only resolving after
|
|
all resolve. May require no changes unless for timing.
|
|
- `editor.runCallbacks` now returns a `Promise` which resolves upon all
|
|
callbacks resolving.
|
|
- Removed `svgCanvas.rasterExport` fourth (callback) argument, collapsing
|
|
fifth (options) to fourth
|
|
- Removed `svgCanvas.exportPDF` third (callback) argument
|
|
- Removed `svgCanvas.embedImage` second (callback) argument
|
|
- Made `getHelpXML` a class instead of instance method of `RGBColor`.
|
|
|
|
#### Throwing bad arguments instead of mere logging
|
|
|
|
- `editor/contextmenu.js` `add` now throws instead
|
|
of giving a console error only upon detecting a bad menuitem or
|
|
preexisting context menu
|
|
- `addExtension` now throws upon a repeated attempt to add an
|
|
already-added extension
|
|
|
|
### Breaking changes (internal API)
|
|
|
|
- Refactor `dbox` (and
|
|
`alert`/`confirm`/`process`/`prompt`/`select`) to avoid a callback argument
|
|
in favor of returning a Promise
|
|
- `updateGripCursor` moved to be class method
|
|
of Selector rather than instance method
|
|
- `subpathIsClosed` moved to be class method
|
|
of `Path` rather than instance method
|