@dicebear/micah 5.0.0-alpha.2 → 5.0.0-alpha.20

package/lib/schema.js

@@ -0,0 +1,449 @@
+export const schema = {
+    title: 'Options',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    properties: {
+        base: {
+            type: 'array',
+            items: { type: 'string', enum: ['standard'] },
+            default: ['standard'],
+            examples: [['standard']],
+        },
+        baseColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: ['apricot', 'coast', 'topaz'],
+            examples: [
+                ['apricot'],
+                ['coast'],
+                ['topaz'],
+                ['lavender'],
+                ['sky'],
+                ['salmon'],
+                ['canary'],
+                ['calm'],
+                ['azure'],
+                ['seashell'],
+                ['mellow'],
+                ['black'],
+                ['white'],
+            ],
+        },
+        earringColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: [
+                'apricot',
+                'azure',
+                'black',
+                'calm',
+                'canary',
+                'coast',
+                'lavender',
+                'mellow',
+                'salmon',
+                'seashell',
+                'sky',
+                'topaz',
+                'white',
+            ],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+        earrings: {
+            type: 'array',
+            items: { type: 'string', enum: ['hoop', 'stud'] },
+            default: ['hoop', 'stud'],
+            examples: [['hoop'], ['stud']],
+        },
+        earringsProbability: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 100,
+            default: 30,
+        },
+        ears: {
+            type: 'array',
+            items: { type: 'string', enum: ['attached', 'detached'] },
+            default: ['attached', 'detached'],
+            examples: [['attached'], ['detached']],
+        },
+        eyeShadowColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: ['azure', 'calm', 'mellow', 'seashell', 'white'],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+        eyebrows: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: ['up', 'down', 'eyelashesUp', 'eyelashesDown'],
+            },
+            default: ['up', 'down', 'eyelashesUp', 'eyelashesDown'],
+            examples: [['up'], ['down'], ['eyelashesUp'], ['eyelashesDown']],
+        },
+        eyebrowsColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: [
+                'apricot',
+                'azure',
+                'black',
+                'calm',
+                'canary',
+                'coast',
+                'lavender',
+                'mellow',
+                'salmon',
+                'seashell',
+                'sky',
+                'topaz',
+                'white',
+            ],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+        eyes: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: ['eyes', 'round', 'eyesShadow', 'smiling'],
+            },
+            default: ['eyes', 'round', 'eyesShadow', 'smiling'],
+            examples: [['eyes'], ['round'], ['eyesShadow'], ['smiling']],
+        },
+        eyesColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: ['black'],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+        facialHair: {
+            type: 'array',
+            items: { type: 'string', enum: ['beard', 'scruff'] },
+            default: ['beard', 'scruff'],
+            examples: [['beard'], ['scruff']],
+        },
+        facialHairColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: ['topaz'],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+        facialHairProbability: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 100,
+            default: 10,
+        },
+        glasses: {
+            type: 'array',
+            items: { type: 'string', enum: ['round', 'square'] },
+            default: ['round', 'square'],
+            examples: [['round'], ['square']],
+        },
+        glassesColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: [
+                'apricot',
+                'azure',
+                'black',
+                'calm',
+                'canary',
+                'coast',
+                'lavender',
+                'mellow',
+                'salmon',
+                'seashell',
+                'sky',
+                'topaz',
+                'white',
+            ],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+        glassesProbability: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 100,
+            default: 30,
+        },
+        hair: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: [
+                    'fonze',
+                    'mrT',
+                    'dougFunny',
+                    'mrClean',
+                    'dannyPhantom',
+                    'full',
+                    'turban',
+                    'pixie',
+                ],
+            },
+            default: [
+                'fonze',
+                'mrT',
+                'dougFunny',
+                'mrClean',
+                'dannyPhantom',
+                'full',
+                'turban',
+                'pixie',
+            ],
+            examples: [
+                ['fonze'],
+                ['mrT'],
+                ['dougFunny'],
+                ['mrClean'],
+                ['dannyPhantom'],
+                ['full'],
+                ['turban'],
+                ['pixie'],
+            ],
+        },
+        hairColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: [
+                'apricot',
+                'azure',
+                'black',
+                'calm',
+                'canary',
+                'coast',
+                'lavender',
+                'mellow',
+                'salmon',
+                'seashell',
+                'sky',
+                'topaz',
+                'white',
+            ],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+        hairProbability: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 100,
+            default: 100,
+        },
+        mouth: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: [
+                    'surprised',
+                    'laughing',
+                    'nervous',
+                    'smile',
+                    'sad',
+                    'pucker',
+                    'frown',
+                    'smirk',
+                ],
+            },
+            default: [
+                'surprised',
+                'laughing',
+                'nervous',
+                'smile',
+                'sad',
+                'pucker',
+                'frown',
+                'smirk',
+            ],
+            examples: [
+                ['surprised'],
+                ['laughing'],
+                ['nervous'],
+                ['smile'],
+                ['sad'],
+                ['pucker'],
+                ['frown'],
+                ['smirk'],
+            ],
+        },
+        mouthColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: ['black'],
+            examples: [['black']],
+        },
+        nose: {
+            type: 'array',
+            items: { type: 'string', enum: ['curve', 'pointed', 'tound'] },
+            default: ['curve', 'pointed', 'tound'],
+            examples: [['curve'], ['pointed'], ['tound']],
+        },
+        shirt: {
+            type: 'array',
+            items: { type: 'string', enum: ['open', 'crew', 'collared'] },
+            default: ['open', 'crew', 'collared'],
+            examples: [['open'], ['crew'], ['collared']],
+        },
+        shirtColor: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^([0-9a-zA-Z]+|#[a-fA-F0-9]{3}|#[a-fA-F0-9]{4}|#[a-fA-F0-9]{6}|#[a-fA-F0-9]{8})$',
+            },
+            default: [
+                'apricot',
+                'azure',
+                'black',
+                'calm',
+                'canary',
+                'coast',
+                'lavender',
+                'mellow',
+                'salmon',
+                'seashell',
+                'sky',
+                'topaz',
+                'white',
+            ],
+            examples: [
+                ['apricot'],
+                ['azure'],
+                ['black'],
+                ['calm'],
+                ['canary'],
+                ['coast'],
+                ['lavender'],
+                ['mellow'],
+                ['salmon'],
+                ['seashell'],
+                ['sky'],
+                ['topaz'],
+                ['white'],
+            ],
+        },
+    },
+    additionalProperties: false,
+};

package/lib/types.d.ts

@@ -0,0 +1,43 @@
+export interface Options {
+    base?: ('standard')[];
+    mouth?: ('surprised' | 'laughing' | 'nervous' | 'smile' | 'sad' | 'pucker' | 'frown' | 'smirk')[];
+    eyebrows?: ('up' | 'down' | 'eyelashesUp' | 'eyelashesDown')[];
+    hair?: ('fonze' | 'mrT' | 'dougFunny' | 'mrClean' | 'dannyPhantom' | 'full' | 'turban' | 'pixie')[];
+    hairProbability?: number;
+    eyes?: ('eyes' | 'round' | 'eyesShadow' | 'smiling')[];
+    nose?: ('curve' | 'pointed' | 'tound')[];
+    ears?: ('attached' | 'detached')[];
+    shirt?: ('open' | 'crew' | 'collared')[];
+    earrings?: ('hoop' | 'stud')[];
+    earringsProbability?: number;
+    glasses?: ('round' | 'square')[];
+    glassesProbability?: number;
+    facialHair?: ('beard' | 'scruff')[];
+    facialHairProbability?: number;
+    baseColor?: string[];
+    earringColor?: string[];
+    eyeShadowColor?: string[];
+    eyebrowsColor?: string[];
+    facialHairColor?: string[];
+    glassesColor?: string[];
+    hairColor?: string[];
+    mouthColor?: string[];
+    shirtColor?: string[];
+    eyesColor?: string[];
+}
+export declare type ColorGroup = Record<string, ColorGroupItem>;
+export declare type ColorGroupCollection = Record<string, ColorGroup>;
+export declare type ColorGroupItem = string;
+export declare type ColorPickCollection = Record<string, ColorPick>;
+export declare type ColorPick = {
+    name: string;
+    value: ColorGroupItem;
+};
+export declare type ComponentGroup = Record<string, ComponentGroupItem>;
+export declare type ComponentGroupCollection = Record<string, ComponentGroup>;
+export declare type ComponentGroupItem = (components: ComponentPickCollection, colors: ColorPickCollection) => string;
+export declare type ComponentPickCollection = Record<string, ComponentPick>;
+export declare type ComponentPick = {
+    name: string;
+    value: ComponentGroupItem;
+} | undefined;

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/{dist → lib}/utils/getColors.d.ts

@@ -1,9 +1,8 @@
-import type { Prng } from '@dicebear/core';
-import type { Options } from '../options';
-import type { ColorPickCollection } from '../static-types';
-declare type Props = {
-    prng: Prng;
-    options: Options;
-};
-export declare function getColors({ prng, options }: Props): ColorPickCollection;
-export {};
+import type { Prng } from '@dicebear/core';
+import type { Options, ColorPickCollection } from '../types.js';
+declare type Props = {
+    prng: Prng;
+    options: Options;
+};
+export declare function getColors({ prng, options }: Props): ColorPickCollection;
+export {};

package/lib/utils/getColors.js

@@ -0,0 +1,55 @@
+import { pickColor } from './pickColor.js';
+export function getColors({ prng, options }) {
+    return {
+        base: pickColor({
+            prng,
+            group: 'base',
+            values: options.baseColor,
+        }),
+        earring: pickColor({
+            prng,
+            group: 'earring',
+            values: options.earringColor,
+        }),
+        eyeShadow: pickColor({
+            prng,
+            group: 'eyeShadow',
+            values: options.eyeShadowColor,
+        }),
+        eyebrows: pickColor({
+            prng,
+            group: 'eyebrows',
+            values: options.eyebrowsColor,
+        }),
+        facialHair: pickColor({
+            prng,
+            group: 'facialHair',
+            values: options.facialHairColor,
+        }),
+        glasses: pickColor({
+            prng,
+            group: 'glasses',
+            values: options.glassesColor,
+        }),
+        hair: pickColor({
+            prng,
+            group: 'hair',
+            values: options.hairColor,
+        }),
+        mouth: pickColor({
+            prng,
+            group: 'mouth',
+            values: options.mouthColor,
+        }),
+        shirt: pickColor({
+            prng,
+            group: 'shirt',
+            values: options.shirtColor,
+        }),
+        eyes: pickColor({
+            prng,
+            group: 'eyes',
+            values: options.eyesColor,
+        }),
+    };
+}

package/{dist → lib}/utils/getComponents.d.ts

@@ -1,9 +1,8 @@
-import type { Prng } from '@dicebear/core';
-import type { Options } from '../options';
-import type { ComponentPickCollection } from '../static-types';
-declare type Props = {
-    prng: Prng;
-    options: Options;
-};
-export declare function getComponents({ prng, options, }: Props): ComponentPickCollection;
-export {};
+import type { Prng } from '@dicebear/core';
+import type { Options, ComponentPickCollection } from '../types.js';
+declare type Props = {
+    prng: Prng;
+    options: Options;
+};
+export declare function getComponents({ prng, options, }: Props): ComponentPickCollection;
+export {};

package/lib/utils/getComponents.js

@@ -0,0 +1,77 @@
+import { pickComponent } from './pickComponent.js';
+export function getComponents({ prng, options, }) {
+    const baseComponent = pickComponent({
+        prng,
+        group: 'base',
+        values: options.base,
+    });
+    const mouthComponent = pickComponent({
+        prng,
+        group: 'mouth',
+        values: options.mouth,
+    });
+    const eyebrowsComponent = pickComponent({
+        prng,
+        group: 'eyebrows',
+        values: options.eyebrows,
+    });
+    const hairComponent = pickComponent({
+        prng,
+        group: 'hair',
+        values: options.hair,
+    });
+    const eyesComponent = pickComponent({
+        prng,
+        group: 'eyes',
+        values: options.eyes,
+    });
+    const noseComponent = pickComponent({
+        prng,
+        group: 'nose',
+        values: options.nose,
+    });
+    const earsComponent = pickComponent({
+        prng,
+        group: 'ears',
+        values: options.ears,
+    });
+    const shirtComponent = pickComponent({
+        prng,
+        group: 'shirt',
+        values: options.shirt,
+    });
+    const earringsComponent = pickComponent({
+        prng,
+        group: 'earrings',
+        values: options.earrings,
+    });
+    const glassesComponent = pickComponent({
+        prng,
+        group: 'glasses',
+        values: options.glasses,
+    });
+    const facialHairComponent = pickComponent({
+        prng,
+        group: 'facialHair',
+        values: options.facialHair,
+    });
+    return {
+        base: baseComponent,
+        mouth: mouthComponent,
+        eyebrows: eyebrowsComponent,
+        hair: prng.bool(options.hairProbability) ? hairComponent : undefined,
+        eyes: eyesComponent,
+        nose: noseComponent,
+        ears: earsComponent,
+        shirt: shirtComponent,
+        earrings: prng.bool(options.earringsProbability)
+            ? earringsComponent
+            : undefined,
+        glasses: prng.bool(options.glassesProbability)
+            ? glassesComponent
+            : undefined,
+        facialHair: prng.bool(options.facialHairProbability)
+            ? facialHairComponent
+            : undefined,
+    };
+}

package/{dist → lib}/utils/pickColor.d.ts

@@ -1,9 +1,9 @@
-import type { Prng } from '@dicebear/core';
-import type { ColorPick } from '../static-types';
-declare type Props = {
-    prng: Prng;
-    group: string;
-    values?: string[];
-};
-export declare function pickColor({ prng, group, values }: Props): ColorPick;
-export {};
+import type { Prng } from '@dicebear/core';
+import type { ColorPick } from '../types.js';
+declare type Props = {
+    prng: Prng;
+    group: string;
+    values?: string[];
+};
+export declare function pickColor({ prng, group, values }: Props): ColorPick;
+export {};