Upgrade jdenticon: 2.2.0 → 3.0.1 (major)

[depfu]

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ jdenticon (2.2.0 → 3.0.1) · Repo

Release Notes

3.0.1

Fixes in TypeScript typings:

• Allow using the Jdenticon package without adding "dom" to "lib" in tsconfig.json.
• Node typings do no longer leak from the Jdenticon package.

3.0.0

Breaking changes

• The exported file for bundlers does no longer automatically render icons at startup. You need to call any of the update methods from your code to render icons. You can also choose to import "jdenticon/standalone" instead of "jdenticon" to keep the old behavior. If you are importing jdenticon.js or jdenticon.min.js you donät have to do anything.
• The default padding of drawIcon is now 0.08 from the previous default 0. This was changed to remove code for backward compatibility, and to harmonize the API.

Changes

• New methods updateSvg() and updateCanvas(). These only contain references to the logics needed for each element type, providing better code optimization opportunities. They are now preferred over update() where the element type is known.
• An ES bundle is now provided. Just import the "jdenticon" package and the bundler will choose the ES bundle when possible. This will improve code optimizations hopefully causing smaller builds.
• configure() is a new method for providing a default style configuration. This plays nicer when imported as an ES module, than the old config property, which was made read-only by the ES import statement.
• jdenticon.config is deprecated. Use the global jdenticon_config variable or jdenticon.configure() method instead.

Bug fixes

• The typings of the update() method were incorrectly only accepting HTMLElement. An <svg> element (SVGSVGElement) is not an HTMLElement. Now Element is accepted.
• update() incorrectly rendered SVG data in any element with a tag name containing svg, instead of being exactly svg.

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 70 commits:

• Bumped version.
• Removed enormous license banners.
• Removed @types/node dependency and instead added empty Buffer interface declaration to ensure Node typings does not leak to the user code base.
• Added empty interface definition for Element to be able to use Jdenticon without the "dom" lib (#38)
• Added more type tests (#38).
• Added links to React and Angular wrapper.
• Changed badge style.
• Replaced GitHub's own badge with Shields.io to get the same style as the other badges.
• Bumped version.
• Added Node bundles to release zip.
• Bug fix: center shape 13 was not rendered correctly.
• Typings: added `updateCanvas` and `updateSvg` to UMD typings.
• Typings: an SVG element could not be passed to `update` since the `SVGSVGElement` interface does not derive from `HTMLElement`.
• Node tests also performed on Node 14.
• Changed quotation marks.
• Added types test for testing when the UMD bundle is imported as a module.
• Added tests of `standalone` entry point.
• Removed semicolon between badges.
• Renamed `index.js` to `canvasRenderer.js`.
• Added package-lock.json.
• Added `engines` field to package.json.
• Buble before replacing variables to keep the source maps as accurate as possible.
• Added jsDelivr badge.
• Replaced build status badge with Github Actions
• Added minification of properties only to allow better compression ratios when people are packaging Jdenticon using a bundler without property mangling enabled.
• Replaced `gulp-wrap` and `gulp-replace-with-sourcemaps` with an own implementation snce both plugins caused corrupt source maps.
• Lowered error threshold in visual browser tests.
• Removed `preserveAspectRatio="xMidYMid meet"` from SVG export since it is the default value.
• Improved minification.
• Renamed properties with names that prevented them from being minified.
• Bug fix: SVG renderer failed when the object prototype was extended.
• Updated canvas-renderer dependency to version 2.2.0.
• Updated warning message.
• Typo.
• Added e2e package.json to ensure Node ESM loader looked in our synthetic node_modules folder.
• Migrated from Travis to GitHub Actions for CI.
• Defined `updateSvg` and `updateCanvas` as `update` in UMD builds, since the tree-shaking argument does not apply to UMD builds. This removes two API definitions from the UMD bundle.
• Optimized shape definitions for JS minimizers.
• Changed default padding value in `drawIcon` to 0.08 to harmonize with other methods.
• Deprecation warning is no longer shown in browser builds for the `jdenticon.config` property. This was done to minimize bundle size, and the usage of `jdenticon.config` is discouraged in browsers since before.
• Removed unnecessary parameters to `iconGenerator`. Icon is always rendered at position 0,0, and the size is known by the renderer.
• Prevent inlining attribute name constants to minimize bundle size.
• Moved unit tests to `unit` folder.
• Browser tests now use `dist` from local `node_modules` folder instead of the package root `dist` folder. This removes some `../` from paths and simplifies artifacts handling in CI.
• Moved icons test to e2e folder.
• Added README to dist folder.
• Implemented automatic browser tests using Selenium.
• Added tests for testing the resulting Jdenticon package with Node, Webpack and Rollup.
• Moved type=module from root package.json to src/package.json.
• Node 14.x did not like the import of canvas-renderer.
• Refactored global configuration to avoid duplicated code for global variable detection.
• Fixed broken TypeScript tests.
• Fixed typos.
• Refactored entry point files. Added configure() function to support global configuration when using ES modules.
• Fixed IE9 issues in browser tests.
• Made sha1 function more compact.
• Src folder removed from NPM packages since the source is no longer used. Bundles are used instead, even for Node.
• Run lint on test.
• Update year and version in README and LICENSE on release.
• Include content in Closure source maps.
• Updated build templates.
• Bug fix: warning was shown when invoking jdenticon with command line options `-v`/`--version` or `-h`/`--help`.
• Replaced jslint with eslint and fixed lint errors.
• Changed Node detection to not depend on CommonJS functions and properties.
• Added module bundle without side effects (#37). This will improve tree-shaking performance on Jdenticon.
• Fixed unit tests after ESNext migration.
• Replaced custom bundling with Rollup.
• Converted code to ESNext (#37).
• Added updateSvg and updateCanvas public API methods.
• Corrected homepage in package.json.

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)