dicebear 10.0.0-rc.2 → 10.0.0-rc.3

package/lib/utils/addStyleCommand.d.ts

@@ -1,3 +1,7 @@
 import type { Style } from '@dicebear/core';
 import yargs from 'yargs';
-export declare function addStyleCommand(cli: yargs.Argv<{}>, name: string, style: Style): yargs.Argv<{}>;
+/**
+ * Registers a `<name> [outputPath]` subcommand on the given yargs instance,
+ * wired up to render avatars for the given style.
+ */
+export declare function addStyleCommand(cli: yargs.Argv<Record<string, unknown>>, name: string, style: Style): yargs.Argv<Record<string, unknown>>;

package/lib/utils/addStyleCommand.js

@@ -1,6 +1,10 @@
 import chalk from 'chalk';
 import { getStyleCommandOptions } from './getStyleCommandOptions.js';
 import { handleStyleCommand } from './handleStyleCommand.js';
+/**
+ * Registers a `<name> [outputPath]` subcommand on the given yargs instance,
+ * wired up to render avatars for the given style.
+ */
 export function addStyleCommand(cli, name, style) {
     const options = getStyleCommandOptions(style);
     return cli.command({

package/lib/utils/createRandomSeed.d.ts

@@ -1 +1,6 @@
+/**
+ * Returns a short, base-36-encoded random string suitable as an ad-hoc avatar
+ * seed. Uses `Math.random()` — not cryptographically secure, but sufficient
+ * for generating distinct sample avatars from the CLI.
+ */
 export declare function createRandomSeed(): string;

package/lib/utils/createRandomSeed.js

@@ -1,3 +1,8 @@
+/**
+ * Returns a short, base-36-encoded random string suitable as an ad-hoc avatar
+ * seed. Uses `Math.random()` — not cryptographically secure, but sufficient
+ * for generating distinct sample avatars from the CLI.
+ */
 export function createRandomSeed() {
     return Math.random().toString(36).substring(2);
 }

package/lib/utils/extractStyleOptions.d.ts

@@ -1,2 +1,8 @@
 import { Style } from '@dicebear/core';
+/**
+ * Extracts only the style-relevant options from the yargs argv object,
+ * filtering out CLI-specific keys (`_`, `$0`, `outputPath`, `count`,
+ * `format`, etc.) and converting weighted/range values into the shapes the
+ * core resolver expects.
+ */
 export declare function extractStyleOptions(argv: Record<string, unknown>, style: Style): Record<string, unknown>;

package/lib/utils/extractStyleOptions.js

@@ -1,5 +1,9 @@
 import { OptionsDescriptor } from '@dicebear/core';
-// Parses ['variant01:2', 'variant03:1'] (array from yargs) into { variant01: 2, variant03: 1 }
+/**
+ * Parses `['variant01:2', 'variant03:1']` (yargs array form) into a
+ * `{ variant01: 2, variant03: 1 }` weight map. Entries without a colon
+ * default to weight `1`.
+ */
 function parseWeightedValue(value) {
     const result = {};
     for (const pair of value) {
@@ -10,7 +14,11 @@ function parseWeightedValue(value) {
     }
     return result;
 }
-// Parses "10,50" into [10, 50] for range values
+/**
+ * Parses a comma-separated string like `"10,50"` into a `[min, max]` tuple
+ * for range options. Passes the value through unchanged when it does not
+ * match the two-number form.
+ */
 function parseRangeValue(value) {
     if (typeof value === 'string' && value.includes(',')) {
         const parts = value.split(',').map(Number);
@@ -20,8 +28,12 @@ function parseRangeValue(value) {
     }
     return value;
 }
-// Extracts only the style-relevant options from the yargs argv object,
-// filtering out CLI-specific keys (_, $0, outputPath, count, format, etc.).
+/**
+ * Extracts only the style-relevant options from the yargs argv object,
+ * filtering out CLI-specific keys (`_`, `$0`, `outputPath`, `count`,
+ * `format`, etc.) and converting weighted/range values into the shapes the
+ * core resolver expects.
+ */
 export function extractStyleOptions(argv, style) {
     const descriptor = new OptionsDescriptor(style).toJSON();
     const result = {};

package/lib/utils/getPackageJson.d.ts

@@ -1,2 +1,6 @@
 import type { Package } from 'update-notifier';
+/**
+ * Reads the CLI's own `package.json` from disk. Used by `update-notifier` to
+ * compare the running version against the latest published one.
+ */
 export declare function getPackageJson(): Promise<Package>;

package/lib/utils/getPackageJson.js

@@ -1,4 +1,8 @@
 import fs from 'fs-extra';
+/**
+ * Reads the CLI's own `package.json` from disk. Used by `update-notifier` to
+ * compare the running version against the latest published one.
+ */
 export function getPackageJson() {
     const packageJson = new URL('../../package.json', import.meta.url).pathname;
     return fs.readJson(packageJson);

package/lib/utils/getStyleCommandOptions.d.ts

@@ -1,3 +1,8 @@
 import { Style } from '@dicebear/core';
 import type { Options } from 'yargs';
+/**
+ * Builds the yargs options map for a single style command. Combines the
+ * shared CLI flags (`count`, `format`, `exif`, `json`) with one entry per
+ * field returned by the style's {@link OptionsDescriptor}.
+ */
 export declare function getStyleCommandOptions(style: Style): Record<string, Options>;

package/lib/utils/getStyleCommandOptions.js

@@ -1,4 +1,9 @@
 import { OptionsDescriptor } from '@dicebear/core';
+/**
+ * Builds the yargs options map for a single style command. Combines the
+ * shared CLI flags (`count`, `format`, `exif`, `json`) with one entry per
+ * field returned by the style's {@link OptionsDescriptor}.
+ */
 export function getStyleCommandOptions(style) {
     const descriptor = new OptionsDescriptor(style).toJSON();
     const result = {

package/lib/utils/handleStyleCommand.d.ts

@@ -1,3 +1,8 @@
 import { Style } from '@dicebear/core';
 import type { ArgumentsCamelCase } from 'yargs';
-export declare function handleStyleCommand(argv: ArgumentsCamelCase<{}>, name: string, style: Style): Promise<void>;
+/**
+ * Handles a single style subcommand: renders the requested number of avatars
+ * in the chosen format, writes them to the output directory, and reports
+ * progress on a CLI progress bar.
+ */
+export declare function handleStyleCommand(argv: ArgumentsCamelCase<Record<string, unknown>>, name: string, style: Style): Promise<void>;

package/lib/utils/handleStyleCommand.js

@@ -10,6 +10,11 @@ import { extractStyleOptions } from './extractStyleOptions.js';
 import { outputStyleLicenseBanner } from './outputStyleLicenseBanner.js';
 import { createRandomSeed } from './createRandomSeed.js';
 import { writeFile } from './writeFile.js';
+/**
+ * Handles a single style subcommand: renders the requested number of avatars
+ * in the chosen format, writes them to the output directory, and reports
+ * progress on a CLI progress bar.
+ */
 export async function handleStyleCommand(argv, name, style) {
     var _a, _b, _c, _d;
     const bar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic);

package/lib/utils/loadDefinition.d.ts

@@ -1,4 +1,9 @@
 import { Style } from '@dicebear/core';
+/**
+ * Reads a style definition JSON file from disk, validates it via {@link Style},
+ * and returns the wrapped style together with a name derived from the file
+ * basename.
+ */
 export declare function loadDefinition(filePath: string): {
     style: Style;
     name: string;

package/lib/utils/loadDefinition.js

@@ -1,6 +1,11 @@
 import { Style } from '@dicebear/core';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
+/**
+ * Reads a style definition JSON file from disk, validates it via {@link Style},
+ * and returns the wrapped style together with a name derived from the file
+ * basename.
+ */
 export function loadDefinition(filePath) {
     const definitionPath = path.resolve(process.cwd(), filePath);
     const definition = JSON.parse(fs.readFileSync(definitionPath, 'utf-8'));

package/lib/utils/loadStyles.d.ts

@@ -1,2 +1,6 @@
 import { Style } from '@dicebear/core';
+/**
+ * Loads every minified definition shipped by `@dicebear/definitions`, wraps
+ * each in a {@link Style}, and returns them keyed by style name.
+ */
 export declare function loadStyles(): Map<string, Style>;

package/lib/utils/loadStyles.js

@@ -3,6 +3,10 @@ import { createRequire } from 'node:module';
 import * as path from 'node:path';
 import * as fs from 'node:fs';
 const require = createRequire(import.meta.url);
+/**
+ * Loads every minified definition shipped by `@dicebear/definitions`, wraps
+ * each in a {@link Style}, and returns them keyed by style name.
+ */
 export function loadStyles() {
     const definitionsDir = path.dirname(require.resolve('@dicebear/definitions/initials.json'));
     const styles = new Map();

package/lib/utils/outputStyleLicenseBanner.d.ts

@@ -1,2 +1,6 @@
 import type { Style } from '@dicebear/core';
+/**
+ * Prints a colorized attribution banner with the style's source, creator,
+ * and license info to stdout. Skipped sections are omitted silently.
+ */
 export declare function outputStyleLicenseBanner(name: string, style: Style): void;

package/lib/utils/outputStyleLicenseBanner.js

@@ -1,5 +1,9 @@
 import chalk from 'chalk';
 import chalkTemplate from 'chalk-template';
+/**
+ * Prints a colorized attribution banner with the style's source, creator,
+ * and license info to stdout. Skipped sections are omitted silently.
+ */
 export function outputStyleLicenseBanner(name, style) {
     const meta = style.meta();
     const sourceName = meta.source().name();

package/lib/utils/writeFile.d.ts

@@ -1 +1,5 @@
+/**
+ * Writes a string or binary buffer to disk, refusing to overwrite an
+ * existing file. Creates intermediate directories as needed.
+ */
 export declare function writeFile(filePath: string, content: string | ArrayBufferLike): Promise<void>;

package/lib/utils/writeFile.js

@@ -1,5 +1,9 @@
 import fs from 'fs-extra';
 import path from 'node:path';
+/**
+ * Writes a string or binary buffer to disk, refusing to overwrite an
+ * existing file. Creates intermediate directories as needed.
+ */
 export async function writeFile(filePath, content) {
     if (fs.existsSync(filePath)) {
         throw new Error(`File already exists at ${filePath}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dicebear",
-  "version": "10.0.0-rc.2",
+  "version": "10.0.0-rc.3",
   "private": false,
   "description": "CLI for DiceBear — unique avatars from dozens of styles.",
   "homepage": "https://github.com/dicebear/dicebear",
@@ -25,9 +25,9 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@dicebear/converter": "10.0.0-rc.2",
-    "@dicebear/core": "10.0.0-rc.2",
-    "@dicebear/definitions": "^0.1.0",
+    "@dicebear/converter": "10.0.0-rc.3",
+    "@dicebear/core": "10.0.0-rc.3",
+    "@dicebear/definitions": "^10.0.0-rc.6",
     "ajv": "^8.17.1",
     "chalk": "^5.4.1",
     "chalk-template": "^1.1.2",