@dicebear/core 10.2.0 → 10.3.0

package/README.md

@@ -1,11 +1,11 @@
 <h1><img src="https://www.dicebear.com/logo-readme.svg" width="28" /> DiceBear Core (JavaScript)</h1>
 
-JavaScript implementation of the DiceBear avatar library. Generates deterministic
-SVG avatars from style definitions and a seed string.
+JavaScript implementation of the DiceBear avatar library. Generates
+deterministic SVG avatars from style definitions and a seed string.
 
 DiceBear is available for multiple languages. All implementations share the same
 PRNG and rendering pipeline, producing identical SVG output for the same seed,
-style, and options — regardless of the language used.
+style, and options, regardless of the language used.
 
 [Playground](https://www.dicebear.com/playground) |
 [Documentation](https://www.dicebear.com/how-to-use/js-library/)
@@ -31,7 +31,7 @@ const avatar = new Avatar(definition, {
   size: 128,
 });
 
-avatar.toString();  // SVG string
+avatar.toString(); // SVG string
 avatar.toDataUri(); // data:image/svg+xml;charset=utf-8,...
 ```
 

package/lib/Avatar.d.ts

@@ -13,6 +13,11 @@ interface AvatarJson<D = unknown> {
  */
 export declare class Avatar<D = unknown> {
     #private;
+    /**
+     * Pass a {@link Style} instance. Passing a raw style definition is
+     * deprecated and will be removed in v11; wrap it with `new Style(...)` and
+     * reuse the instance across avatars.
+     */
     constructor(styleInput: D, optionsInput?: StyleOptions<UnwrapStyle<D>>);
     /**
      * Returns the rendered SVG markup.

package/lib/Avatar.js

@@ -14,6 +14,10 @@ import { Style } from './Style.js';
 import { Options } from './Options.js';
 import { Resolver } from './Resolver.js';
 import { Renderer } from './Renderer.js';
+// Emitted at most once per process: passing a raw definition is deprecated, but
+// it was the documented usage for a long time, so a per-call warning would be
+// noisy.
+let definitionInputWarned = false;
 /**
  * Top-level entry point for rendering an avatar from a style and options.
  *
@@ -21,9 +25,20 @@ import { Renderer } from './Renderer.js';
  * accessor methods return different serializations of that result.
  */
 export class Avatar {
+    /**
+     * Pass a {@link Style} instance. Passing a raw style definition is
+     * deprecated and will be removed in v11; wrap it with `new Style(...)` and
+     * reuse the instance across avatars.
+     */
     constructor(styleInput, optionsInput) {
         _Avatar_svg.set(this, void 0);
         _Avatar_resolvedOptions.set(this, void 0);
+        if (!(styleInput instanceof Style) && !definitionInputWarned) {
+            definitionInputWarned = true;
+            console.warn('[DiceBear] Passing a style definition to `new Avatar()` is deprecated ' +
+                'and will be removed in v11. Wrap it in a Style first: ' +
+                '`new Avatar(new Style(definition), options)`.');
+        }
         const style = styleInput instanceof Style ? styleInput : new Style(styleInput);
         const options = new Options(optionsInput);
         const resolver = new Resolver(style, options);

package/lib/Renderer.js

@@ -72,7 +72,7 @@ export class Renderer {
             attrs.push(`width="${sizeValue}"`, `height="${sizeValue}"`);
         }
         const titleElement = escapedTitle !== undefined ? `<title>${escapedTitle}</title>` : '';
-        let svg = `<svg ${attrs.join(' ')}>${metadata}${defs}${titleElement}${body}</svg>`;
+        let svg = `<svg ${attrs.join(' ')}><!-- Generated by DiceBear (https://dicebear.com) -->${metadata}${defs}${titleElement}${body}</svg>`;
         if (__classPrivateFieldGet(this, _Renderer_resolver, "f").idRandomization()) {
             svg = __classPrivateFieldGet(this, _Renderer_instances, "m", _Renderer_randomizeIds).call(this, svg);
         }
@@ -299,7 +299,7 @@ _Renderer_style = new WeakMap(), _Renderer_resolver = new WeakMap(), _Renderer_d
         case 'initial': {
             // charAt(0) would return a lone surrogate (ill-formed XML) for
             // supplementary-plane initials; take the full first code point
-            // instead, like the PHP/Python/Rust/Go ports.
+            // instead, like the PHP/Python/Rust/Go/Dart ports.
             const first = __classPrivateFieldGet(this, _Renderer_instances, "m", _Renderer_initials).call(this).codePointAt(0);
             return first !== undefined ? String.fromCodePoint(first) : '';
         }

package/lib/Utils/Number.d.ts

@@ -2,10 +2,11 @@
  * Formats a number for SVG output, rounded to at most 5 decimal places.
  *
  * Rounding to a fixed precision keeps the output bounded and identical across
- * the JS, PHP, and Python ports: every value becomes a multiple of 1e-5 in the
- * SVG coordinate range, which has no exponential form, so the result is built
- * from integer arithmetic (no locale- or language-specific float stringifying).
- * Five decimals is far below sub-pixel precision for any realistic canvas.
+ * the JS, PHP, Python, Rust, Go, and Dart ports: every value becomes a
+ * multiple of 1e-5 in the SVG coordinate range, which has no exponential form,
+ * so the result is built from integer arithmetic (no locale- or
+ * language-specific float stringifying). Five decimals is far below sub-pixel
+ * precision for any realistic canvas.
  */
 export declare class Number {
     static format(value: number): string;

package/lib/Utils/Number.js

@@ -2,10 +2,11 @@
  * Formats a number for SVG output, rounded to at most 5 decimal places.
  *
  * Rounding to a fixed precision keeps the output bounded and identical across
- * the JS, PHP, and Python ports: every value becomes a multiple of 1e-5 in the
- * SVG coordinate range, which has no exponential form, so the result is built
- * from integer arithmetic (no locale- or language-specific float stringifying).
- * Five decimals is far below sub-pixel precision for any realistic canvas.
+ * the JS, PHP, Python, Rust, Go, and Dart ports: every value becomes a
+ * multiple of 1e-5 in the SVG coordinate range, which has no exponential form,
+ * so the result is built from integer arithmetic (no locale- or
+ * language-specific float stringifying). Five decimals is far below sub-pixel
+ * precision for any realistic canvas.
  */
 export class Number {
     static format(value) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dicebear/core",
-  "version": "10.2.0",
+  "version": "10.3.0",
   "description": "Unique avatars from dozens of styles — deterministic, customizable, vector-based.",
   "keywords": [
     "avatar",