@dicebear/core 10.0.0-rc.1 → 10.0.0-rc.3

package/lib/Utils/Initials.js

@@ -1,7 +1,14 @@
-// @see https://www.regular-expressions.info/unicode.html
+/**
+ * Derives display initials from a seed string.
+ *
+ * @see https://www.regular-expressions.info/unicode.html
+ */
 export class Initials {
-    // Strips '@...' so email addresses yield a single initial instead
-    // of being treated as two words.
+    /**
+     * Returns one or two uppercase initials for the given seed. By default
+     * strips `@...` so email addresses yield a single initial instead of being
+     * treated as two words.
+     */
     static fromSeed(seed, discardAtSymbol = true) {
         let input = seed;
         if (discardAtSymbol) {

package/lib/Utils/License.d.ts

@@ -1,5 +1,19 @@
 import type { Meta } from '../Style/Meta.js';
+/**
+ * Builds attribution strings and embedded RDF/Dublin Core metadata from a
+ * style's {@link Meta} block.
+ */
 export declare class License {
+    /**
+     * Returns a single-line attribution string suitable for `<title>` or
+     * `<desc>` content. Returns an empty string when no attribution data is
+     * available.
+     */
     static text(meta: Meta): string;
+    /**
+     * Builds an embedded `<metadata>` block with Dublin Core terms describing
+     * the style's source, creator, license, and rights statement. Returns an
+     * empty string when no metadata fields are populated.
+     */
     static xml(meta: Meta): string;
 }

package/lib/Utils/License.js

@@ -1,5 +1,14 @@
 import { Xml } from './Xml.js';
+/**
+ * Builds attribution strings and embedded RDF/Dublin Core metadata from a
+ * style's {@link Meta} block.
+ */
 export class License {
+    /**
+     * Returns a single-line attribution string suitable for `<title>` or
+     * `<desc>` content. Returns an empty string when no attribution data is
+     * available.
+     */
     static text(meta) {
         const sourceName = meta.source().name();
         const sourceUrl = meta.source().url();
@@ -28,6 +37,11 @@ export class License {
         }
         return result;
     }
+    /**
+     * Builds an embedded `<metadata>` block with Dublin Core terms describing
+     * the style's source, creator, license, and rights statement. Returns an
+     * empty string when no metadata fields are populated.
+     */
     static xml(meta) {
         const title = meta.source().name();
         const creatorName = meta.creator().name();

package/lib/Utils/Xml.d.ts

@@ -1,4 +1,10 @@
+/**
+ * Minimal XML escaping helper for SVG/XML text and attribute content.
+ */
 export declare class Xml {
     #private;
+    /**
+     * Returns `value` with the five XML predefined entities escaped.
+     */
     static escape(value: string): string;
 }

package/lib/Utils/Xml.js

@@ -4,7 +4,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _a, _Xml_entities, _Xml_pattern;
+/**
+ * Minimal XML escaping helper for SVG/XML text and attribute content.
+ */
 export class Xml {
+    /**
+     * Returns `value` with the five XML predefined entities escaped.
+     */
     static escape(value) {
         return value.replace(__classPrivateFieldGet(_a, _a, "f", _Xml_pattern), (ch) => __classPrivateFieldGet(_a, _a, "f", _Xml_entities)[ch]);
     }