wehub-resource-sync
223 lines
11 KiB
Markdown
223 lines
11 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
and this project adheres to
|
|
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
## [10.3.0] - 2026-06-13
|
|
|
|
### Added
|
|
|
|
- **Core:** Every rendered SVG now starts with the generator comment
|
|
`<!-- Generated by DiceBear (https://dicebear.com) -->` as the first child of
|
|
the root `<svg>` element. The comment is byte-identical across the JavaScript,
|
|
PHP, Python, Rust, Go, and Dart libraries. The byte output of every avatar
|
|
changes as a result, including data URIs and content hashes, so consumers that
|
|
compare rendered SVGs against stored snapshots need to update them. SVG
|
|
optimizers that strip comments (e.g. SVGO with default settings) remove it
|
|
again.
|
|
- **Dart library:** A new Dart implementation (the
|
|
[`dicebear_core`](https://pub.dev/packages/dicebear_core) package) that
|
|
produces identical output to the JavaScript library when given the same styles
|
|
and options. It validates style definitions and options against the shared
|
|
schemas (via `dicebear_schema`) and pairs with the `dicebear_styles` package.
|
|
- **Core (PHP, Python):** Added `Style::fromJson()` (PHP) and
|
|
`Style.from_json()` (Python) to build a style from a raw JSON string without a
|
|
separate `json_decode(..., true)` / `json.loads(...)` call. Malformed JSON
|
|
raises the language's native parse error (`JsonException` /
|
|
`json.JSONDecodeError`); an invalid definition raises the usual
|
|
`StyleValidationError`. Mirrors `Style::from_str` (Rust) and `Style.parse`
|
|
(Dart); the existing array/dict constructor is unchanged.
|
|
|
|
### Deprecated
|
|
|
|
- **Core (JS, PHP, Python):** Passing a raw style definition to `Avatar` is
|
|
deprecated; pass a `Style` instead
|
|
(`new Avatar(new Style(definition), options)`), which also lets you reuse one
|
|
parsed style across many avatars. The definition still works for now and
|
|
renders identically, but emits a deprecation warning (a one-time
|
|
`console.warn` in JS, `E_USER_DEPRECATED` in PHP, `DeprecationWarning` in
|
|
Python) and will be removed in v11. The Dart, Rust and Go libraries already
|
|
require a `Style`, so this brings every port to the same `Avatar(style, …)`
|
|
call.
|
|
|
|
## [10.2.0] - 2026-06-10
|
|
|
|
### Added
|
|
|
|
- **Go library:** A new Go implementation (the
|
|
`github.com/dicebear/dicebear-go/v10` module) that produces identical output
|
|
to the JavaScript library when given the same styles and options.
|
|
|
|
### Fixed
|
|
|
|
- **Core:** `Color.luminance()` now derives the sRGB linearization from a
|
|
precomputed lookup table (one entry per 8-bit channel value) instead of
|
|
calling `pow` at runtime. `pow` is not required to be correctly rounded and
|
|
produced last-ULP differences between JS engines (V8 vs. others), the C math
|
|
library (PHP, Python, Rust), and Go's pure-Go implementation, so luminance
|
|
values, and in contrived cases contrast-based color ordering, could diverge
|
|
across languages and even across browsers. The table holds the values the
|
|
JavaScript reference produces today, so JavaScript output is unchanged; the
|
|
other libraries move by at most one ULP. The Go library additionally forces
|
|
intermediate rounding in the weighted sum, which the compiler could otherwise
|
|
fuse into FMA instructions on arm64. Rendered SVGs are unaffected.
|
|
- **Core (PHP):** `Avatar::toDataUri()` now percent-encodes exactly like
|
|
JavaScript's `encodeURIComponent`. Previously the PHP library used plain
|
|
`rawurlencode`, which additionally escapes `!*'()`, characters that occur in
|
|
every rendered SVG (e.g. `url(#…)` references and `translate(…)` transforms),
|
|
so the data URI diverged byte-wise from the JavaScript, Python, Rust, and Go
|
|
libraries. The decoded SVG was unaffected.
|
|
- **Core (JS):** The `initial` style variable now resolves to the full first
|
|
code point of the initials. Previously the JavaScript library emitted a lone
|
|
UTF-16 surrogate (ill-formed XML) when the initials started with a character
|
|
outside the Basic Multilingual Plane (e.g. an emoji). The PHP, Python, Rust,
|
|
and Go libraries already returned the full character; all libraries are now
|
|
byte-identical for such seeds.
|
|
- **Core (Rust):** `Avatar.to_json()` now records `size` before `title` in the
|
|
resolved-options snapshot, matching the JavaScript, PHP, and Python libraries.
|
|
The rendered SVG was unaffected; only consumers comparing or hashing the
|
|
serialized options JSON across languages were affected.
|
|
- **Core (Python):** `Avatar.to_json()` now serializes whole-number floats in
|
|
the resolved-options snapshot as integers (`1`, not `1.0`), matching the
|
|
JavaScript, Rust, and PHP libraries. Previously snapshot values such as
|
|
`scale`, `rotate`, `translateX`/`translateY`, `borderRadius`, color angles,
|
|
and per-component transforms were emitted as `1.0`/`0.0`, so the serialized
|
|
JSON diverged from the other ports. The rendered SVG was unaffected. The
|
|
values were already numerically equal, so only consumers comparing or hashing
|
|
the serialized options JSON across languages were affected.
|
|
|
|
## [10.2.0-rc.1] - 2026-06-07
|
|
|
|
### Added
|
|
|
|
- **Rust library:** A new Rust implementation (the `dicebear-core` crate) that
|
|
produces identical output to the JavaScript library when given the same styles
|
|
and options.
|
|
|
|
### Fixed
|
|
|
|
- **Core:** Initials now discard everything from the first `@` to the end of the
|
|
seed (e.g. an email domain). Previously the strip stopped at the first line
|
|
terminator (at a line feed in PHP and Python, and additionally at a carriage
|
|
return or `U+2028`/`U+2029` in JavaScript), so a seed with a line break after
|
|
the `@` kept the trailing text as a second word, and the libraries could even
|
|
diverge from each other. All language libraries now produce byte-identical
|
|
initials for such seeds.
|
|
|
|
## [10.1.0] - 2026-06-06
|
|
|
|
### Changed
|
|
|
|
- **Schema:** Bumped the bundled `@dicebear/schema` to `1.1.0` across the
|
|
JavaScript, PHP, and Python libraries. It adds an upper bound of `1000000` to
|
|
the canvas and component `width`/`height`, preventing the language ports'
|
|
number-to-string formatting from diverging at extreme values. Official styles
|
|
use ~100, so no real avatar is affected.
|
|
- **Styles:** Bumped `@dicebear/styles` to `10.1.0`. Lorelei's mouth is now
|
|
visible through `beard` variants (the overlaying mask was previously rendered
|
|
at `0` opacity), and all style definitions now reference
|
|
`@dicebear/schema@1.1.0`.
|
|
|
|
## [10.1.0-rc.1] - 2026-06-02
|
|
|
|
### Added
|
|
|
|
- **Python library:** A new Python implementation that produces identical output
|
|
to the JavaScript library when given the same styles and options.
|
|
|
|
## [10.0.2] - 2026-06-02
|
|
|
|
### Fixed
|
|
|
|
- **Core:** Numeric values in rendered SVGs are now consistently rounded to at
|
|
most 5 decimal places, so the JavaScript and PHP libraries produce
|
|
byte-identical output for every input. Previously, fractional or very
|
|
small/large values (e.g. a fractional `borderRadius` or `translateX`,
|
|
component transforms, or gradient stop offsets) could be stringified
|
|
differently between languages (scientific notation, differing precision).
|
|
Avatars built from whole-number options are unaffected.
|
|
- **Core (PHP):** `Prng::float` now rounds halves toward +Infinity (matching the
|
|
JavaScript reference's `Math.round`) instead of PHP's native `round()`, which
|
|
rounds halves away from zero. The two diverged for negative values landing
|
|
exactly on a `.5` boundary, so a PHP-rendered avatar could differ from the
|
|
JavaScript one by `0.0001` in a rotate/translate transform or color angle for
|
|
certain seeds. Output is now byte-identical across languages.
|
|
- **Core (PHP):** Initials are now derived correctly from seeds containing
|
|
multibyte letters such as `ü` or `ô`. The quote-stripping step was missing the
|
|
`/u` (Unicode) flag, so it removed raw UTF-8 bytes and corrupted those
|
|
letters: e.g. `über` and `côté` produced wrong or empty initials instead of
|
|
`ÜB` / `CÔ`. The PHP output now matches the JavaScript reference.
|
|
- **Core:** Range options (`scale`, `borderRadius`, `rotate`,
|
|
`translateX`/`translateY`, and per-color angle/fill-stops) given as a
|
|
single-element array `[n]` are now treated as the fixed value `n` (identical
|
|
to the scalar `n`), and an empty array `[]` falls back to the option's
|
|
default. Both forms are permitted by the schema. Previously the behaviour
|
|
diverged: the JavaScript library emitted `NaN` (e.g. `scale(NaN)`), while PHP
|
|
dropped `[n]` to the default. All three now agree.
|
|
|
|
## [10.0.1] - 2026-05-29
|
|
|
|
### Fixed
|
|
|
|
- **CLI:** `dicebear --version` and `dicebear --help` no longer fail by trying
|
|
to read a file named `--version`/`--help`. The definition path is now resolved
|
|
via the argument parser, so flags (and the values they consume) before the
|
|
path are handled correctly, e.g. `dicebear --json my-style.json` and
|
|
`dicebear --count 2 my-style.json`.
|
|
|
|
## [10.0.0] - 2026-05-27
|
|
|
|
See the
|
|
[v10.0.0 release notes](https://github.com/dicebear/dicebear/releases/tag/v10.0.0).
|
|
|
|
### Added
|
|
|
|
- **6 new avatar styles:** Disco, Glyphs, Initial Face, Shape Grid, Stripes, and
|
|
Triangles.
|
|
- **PHP library:** A new PHP implementation that produces identical output to
|
|
the JavaScript library when given the same styles and options.
|
|
- **CLI support for custom styles:** Generate avatars from a JSON style
|
|
definition, e.g. `dicebear ./path/to/style.json --seed test --format svg`.
|
|
- **Weighted variants:** Assign weights to component variants to control how
|
|
frequently each appears.
|
|
- **Gradient support:** Colors can be defined as gradients, including an angle
|
|
parameter.
|
|
- **Integrated validation:** Built-in validation for avatar styles and options.
|
|
- **Redesigned playground:** Adjust options, upload custom styles, batch
|
|
download avatars, and view the number of possible combinations.
|
|
- **New tools:** WCAG Contrast Picker and Bundle Size Estimator.
|
|
- Reorganized and improved documentation, with better style docs and component
|
|
previews.
|
|
|
|
### Changed
|
|
|
|
- Each avatar style is now stored as a JSON definition file instead of
|
|
JavaScript code, separating licensing concerns from implementation.
|
|
- Styles are now distributed via `@dicebear/styles` as JSON definitions.
|
|
- The JavaScript API now uses `Style` and `Avatar` classes together with
|
|
definition imports.
|
|
- **BREAKING:** Component options are now suffixed with `Variant` (e.g.
|
|
`eyesVariant` instead of `eyes`).
|
|
|
|
### Removed
|
|
|
|
- **BREAKING:** Individual style packages (e.g. `@dicebear/initials`) have been
|
|
removed in favor of `@dicebear/styles`.
|
|
|
|
[Unreleased]: https://github.com/dicebear/dicebear/compare/v10.3.0...HEAD
|
|
[10.3.0]: https://github.com/dicebear/dicebear/compare/v10.2.0...v10.3.0
|
|
[10.2.0]: https://github.com/dicebear/dicebear/compare/v10.2.0-rc.1...v10.2.0
|
|
[10.2.0-rc.1]:
|
|
https://github.com/dicebear/dicebear/compare/v10.1.0...v10.2.0-rc.1
|
|
[10.1.0]: https://github.com/dicebear/dicebear/compare/v10.1.0-rc.1...v10.1.0
|
|
[10.1.0-rc.1]:
|
|
https://github.com/dicebear/dicebear/compare/v10.0.2...v10.1.0-rc.1
|
|
[10.0.2]: https://github.com/dicebear/dicebear/compare/v10.0.1...v10.0.2
|
|
[10.0.1]: https://github.com/dicebear/dicebear/compare/v10.0.0...v10.0.1
|
|
[10.0.0]: https://github.com/dicebear/dicebear/releases/tag/v10.0.0
|