@dicebear/open-peeps 4.10.2 → 5.0.0-alpha.11

package/lib/index.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Open Peeps (@dicebear/open-peeps)
+ *
+ * Code licensed under MIT License.
+ * Copyright (c) 2021 Florian Körner
+ *
+ * Design "Open Peeps" by Pablo Stanley licensed under CC0 1.0.
+ * Source: https://www.openpeeps.com/
+ * License: https://creativecommons.org/publicdomain/zero/1.0/
+ */
+declare const create: import("@dicebear/core").StyleCreate<import("./types.js").Options>, preview: import("@dicebear/core").StylePreview<import("./types.js").Options> | undefined, meta: import("@dicebear/core").StyleMeta, schema: import("json-schema").JSONSchema7;
+export { create, preview, meta, schema };
+export type { Options } from './types.js';

package/lib/index.js

@@ -0,0 +1,13 @@
+/*!
+ * Open Peeps (@dicebear/open-peeps)
+ *
+ * Code licensed under MIT License.
+ * Copyright (c) 2021 Florian Körner
+ *
+ * Design "Open Peeps" by Pablo Stanley licensed under CC0 1.0.
+ * Source: https://www.openpeeps.com/
+ * License: https://creativecommons.org/publicdomain/zero/1.0/
+ */
+import { style } from './core.js';
+const { create, preview, meta, schema } = style;
+export { create, preview, meta, schema };

package/lib/meta/components.d.ts

@@ -0,0 +1,4 @@
+export declare const dimensions: Record<string, {
+    width: number;
+    height: number;
+}>;

package/lib/meta/components.js

@@ -0,0 +1,22 @@
+export const dimensions = {
+    head: {
+        width: 474,
+        height: 567,
+    },
+    face: {
+        width: 289,
+        height: 293,
+    },
+    facialHair: {
+        width: 280,
+        height: 230,
+    },
+    mask: {
+        width: 397,
+        height: 228,
+    },
+    accessories: {
+        width: 392,
+        height: 138,
+    },
+};

package/lib/schema.d.ts

@@ -0,0 +1,2 @@
+import type { StyleSchema } from '@dicebear/core';
+export declare const schema: StyleSchema;

package/lib/schema.js

@@ -0,0 +1,457 @@
+export const schema = {
+    title: 'Options',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    properties: {
+        accessories: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: [
+                    'eyepatch',
+                    'glasses',
+                    'glasses2',
+                    'glasses3',
+                    'glasses4',
+                    'glasses5',
+                    'sunglasses',
+                    'sunglasses2',
+                ],
+            },
+            default: [
+                'eyepatch',
+                'glasses',
+                'glasses2',
+                'glasses3',
+                'glasses4',
+                'glasses5',
+                'sunglasses',
+                'sunglasses2',
+            ],
+            examples: [
+                ['eyepatch'],
+                ['glasses'],
+                ['glasses2'],
+                ['glasses3'],
+                ['glasses4'],
+                ['glasses5'],
+                ['sunglasses'],
+                ['sunglasses2'],
+            ],
+        },
+        accessoriesProbability: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 100,
+            default: 20,
+        },
+        clothingColor: {
+            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: [
+                'red01',
+                'orange01',
+                'yellow01',
+                'green01',
+                'tail01',
+                'blue01',
+                'pink01',
+            ],
+            examples: [
+                ['red01'],
+                ['orange01'],
+                ['yellow01'],
+                ['green01'],
+                ['tail01'],
+                ['blue01'],
+                ['pink01'],
+            ],
+        },
+        face: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: [
+                    'angryWithFang',
+                    'awe',
+                    'blank',
+                    'calm',
+                    'cheeky',
+                    'concerned',
+                    'concernedFear',
+                    'contempt',
+                    'cute',
+                    'cyclops',
+                    'driven',
+                    'eatingHappy',
+                    'explaining',
+                    'eyesClosed',
+                    'fear',
+                    'hectic',
+                    'lovingGrin1',
+                    'lovingGrin2',
+                    'monster',
+                    'old',
+                    'rage',
+                    'serious',
+                    'smile',
+                    'smileBig',
+                    'smileLOL',
+                    'smileTeethGap',
+                    'solemn',
+                    'suspicious',
+                    'tired',
+                    'veryAngry',
+                ],
+            },
+            default: [
+                'angryWithFang',
+                'awe',
+                'blank',
+                'calm',
+                'cheeky',
+                'concerned',
+                'concernedFear',
+                'contempt',
+                'cute',
+                'cyclops',
+                'driven',
+                'eatingHappy',
+                'explaining',
+                'eyesClosed',
+                'fear',
+                'hectic',
+                'lovingGrin1',
+                'lovingGrin2',
+                'monster',
+                'old',
+                'rage',
+                'serious',
+                'smile',
+                'smileBig',
+                'smileLOL',
+                'smileTeethGap',
+                'solemn',
+                'suspicious',
+                'tired',
+                'veryAngry',
+            ],
+            examples: [
+                ['angryWithFang'],
+                ['awe'],
+                ['blank'],
+                ['calm'],
+                ['cheeky'],
+                ['concerned'],
+                ['concernedFear'],
+                ['contempt'],
+                ['cute'],
+                ['cyclops'],
+                ['driven'],
+                ['eatingHappy'],
+                ['explaining'],
+                ['eyesClosed'],
+                ['fear'],
+                ['hectic'],
+                ['lovingGrin1'],
+                ['lovingGrin2'],
+                ['monster'],
+                ['old'],
+                ['rage'],
+                ['serious'],
+                ['smile'],
+                ['smileBig'],
+                ['smileLOL'],
+                ['smileTeethGap'],
+                ['solemn'],
+                ['suspicious'],
+                ['tired'],
+                ['veryAngry'],
+            ],
+        },
+        facialHair: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: [
+                    'chin',
+                    'full',
+                    'full2',
+                    'full3',
+                    'full4',
+                    'goatee1',
+                    'goatee2',
+                    'moustache1',
+                    'moustache2',
+                    'moustache3',
+                    'moustache4',
+                    'moustache5',
+                    'moustache6',
+                    'moustache7',
+                    'moustache8',
+                    'moustache9',
+                ],
+            },
+            default: [
+                'chin',
+                'full',
+                'full2',
+                'full3',
+                'full4',
+                'goatee1',
+                'goatee2',
+                'moustache1',
+                'moustache2',
+                'moustache3',
+                'moustache4',
+                'moustache5',
+                'moustache6',
+                'moustache7',
+                'moustache8',
+                'moustache9',
+            ],
+            examples: [
+                ['chin'],
+                ['full'],
+                ['full2'],
+                ['full3'],
+                ['full4'],
+                ['goatee1'],
+                ['goatee2'],
+                ['moustache1'],
+                ['moustache2'],
+                ['moustache3'],
+                ['moustache4'],
+                ['moustache5'],
+                ['moustache6'],
+                ['moustache7'],
+                ['moustache8'],
+                ['moustache9'],
+            ],
+        },
+        facialHairProbability: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 100,
+            default: 10,
+        },
+        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: [
+                'variant01',
+                'variant02',
+                'variant03',
+                'variant04',
+                'variant05',
+                'variant06',
+                'variant07',
+                'variant08',
+                'variant09',
+                'variant10',
+            ],
+            examples: [
+                ['variant01'],
+                ['variant02'],
+                ['variant03'],
+                ['variant04'],
+                ['variant05'],
+                ['variant06'],
+                ['variant07'],
+                ['variant08'],
+                ['variant09'],
+                ['variant10'],
+            ],
+        },
+        head: {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: [
+                    'afro',
+                    'bangs',
+                    'bangs2',
+                    'bantuKnots',
+                    'bear',
+                    'bun',
+                    'bun2',
+                    'buns',
+                    'cornrows',
+                    'cornrows2',
+                    'dreads1',
+                    'dreads2',
+                    'flatTop',
+                    'flatTopLong',
+                    'grayBun',
+                    'grayMedium',
+                    'grayShort',
+                    'hatBeanie',
+                    'hatHip',
+                    'hijab',
+                    'long',
+                    'longAfro',
+                    'longBangs',
+                    'longCurly',
+                    'medium1',
+                    'medium2',
+                    'medium3',
+                    'mediumBangs',
+                    'mediumBangs2',
+                    'mediumBangs3',
+                    'mediumStraight',
+                    'mohawk',
+                    'mohawk2',
+                    'noHair1',
+                    'noHair2',
+                    'noHair3',
+                    'pomp',
+                    'shaved1',
+                    'shaved2',
+                    'shaved3',
+                    'short1',
+                    'short2',
+                    'short3',
+                    'short4',
+                    'short5',
+                    'turban',
+                    'twists',
+                    'twists2',
+                ],
+            },
+            default: [
+                'afro',
+                'bangs',
+                'bangs2',
+                'bantuKnots',
+                'bear',
+                'bun',
+                'bun2',
+                'buns',
+                'cornrows',
+                'cornrows2',
+                'dreads1',
+                'dreads2',
+                'flatTop',
+                'flatTopLong',
+                'grayBun',
+                'grayMedium',
+                'grayShort',
+                'hatBeanie',
+                'hatHip',
+                'hijab',
+                'long',
+                'longAfro',
+                'longBangs',
+                'longCurly',
+                'medium1',
+                'medium2',
+                'medium3',
+                'mediumBangs',
+                'mediumBangs2',
+                'mediumBangs3',
+                'mediumStraight',
+                'mohawk',
+                'mohawk2',
+                'noHair1',
+                'noHair2',
+                'noHair3',
+                'pomp',
+                'shaved1',
+                'shaved2',
+                'shaved3',
+                'short1',
+                'short2',
+                'short3',
+                'short4',
+                'short5',
+                'turban',
+                'twists',
+                'twists2',
+            ],
+            examples: [
+                ['afro'],
+                ['bangs'],
+                ['bangs2'],
+                ['bantuKnots'],
+                ['bear'],
+                ['bun'],
+                ['bun2'],
+                ['buns'],
+                ['cornrows'],
+                ['cornrows2'],
+                ['dreads1'],
+                ['dreads2'],
+                ['flatTop'],
+                ['flatTopLong'],
+                ['grayBun'],
+                ['grayMedium'],
+                ['grayShort'],
+                ['hatBeanie'],
+                ['hatHip'],
+                ['hijab'],
+                ['long'],
+                ['longAfro'],
+                ['longBangs'],
+                ['longCurly'],
+                ['medium1'],
+                ['medium2'],
+                ['medium3'],
+                ['mediumBangs'],
+                ['mediumBangs2'],
+                ['mediumBangs3'],
+                ['mediumStraight'],
+                ['mohawk'],
+                ['mohawk2'],
+                ['noHair1'],
+                ['noHair2'],
+                ['noHair3'],
+                ['pomp'],
+                ['shaved1'],
+                ['shaved2'],
+                ['shaved3'],
+                ['short1'],
+                ['short2'],
+                ['short3'],
+                ['short4'],
+                ['short5'],
+                ['turban'],
+                ['twists'],
+                ['twists2'],
+            ],
+        },
+        mask: {
+            type: 'array',
+            items: { type: 'string', enum: ['medicalMask', 'respirator'] },
+            default: ['medicalMask', 'respirator'],
+            examples: [['medicalMask'], ['respirator']],
+        },
+        maskProbability: { type: 'integer', minimum: 0, maximum: 100, default: 5 },
+        skinColor: {
+            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: [
+                'variant01',
+                'variant02',
+                'variant03',
+                'variant04',
+                'variant05',
+            ],
+            examples: [
+                ['variant01'],
+                ['variant02'],
+                ['variant03'],
+                ['variant04'],
+                ['variant05'],
+            ],
+        },
+    },
+    additionalProperties: false,
+};

package/lib/types.d.ts

@@ -0,0 +1,29 @@
+export interface Options {
+    head?: ('afro' | 'bangs' | 'bangs2' | 'bantuKnots' | 'bear' | 'bun' | 'bun2' | 'buns' | 'cornrows' | 'cornrows2' | 'dreads1' | 'dreads2' | 'flatTop' | 'flatTopLong' | 'grayBun' | 'grayMedium' | 'grayShort' | 'hatBeanie' | 'hatHip' | 'hijab' | 'long' | 'longAfro' | 'longBangs' | 'longCurly' | 'medium1' | 'medium2' | 'medium3' | 'mediumBangs' | 'mediumBangs2' | 'mediumBangs3' | 'mediumStraight' | 'mohawk' | 'mohawk2' | 'noHair1' | 'noHair2' | 'noHair3' | 'pomp' | 'shaved1' | 'shaved2' | 'shaved3' | 'short1' | 'short2' | 'short3' | 'short4' | 'short5' | 'turban' | 'twists' | 'twists2')[];
+    face?: ('angryWithFang' | 'awe' | 'blank' | 'calm' | 'cheeky' | 'concerned' | 'concernedFear' | 'contempt' | 'cute' | 'cyclops' | 'driven' | 'eatingHappy' | 'explaining' | 'eyesClosed' | 'fear' | 'hectic' | 'lovingGrin1' | 'lovingGrin2' | 'monster' | 'old' | 'rage' | 'serious' | 'smile' | 'smileBig' | 'smileLOL' | 'smileTeethGap' | 'solemn' | 'suspicious' | 'tired' | 'veryAngry')[];
+    facialHair?: ('chin' | 'full' | 'full2' | 'full3' | 'full4' | 'goatee1' | 'goatee2' | 'moustache1' | 'moustache2' | 'moustache3' | 'moustache4' | 'moustache5' | 'moustache6' | 'moustache7' | 'moustache8' | 'moustache9')[];
+    facialHairProbability?: number;
+    mask?: ('medicalMask' | 'respirator')[];
+    maskProbability?: number;
+    accessories?: ('eyepatch' | 'glasses' | 'glasses2' | 'glasses3' | 'glasses4' | 'glasses5' | 'sunglasses' | 'sunglasses2')[];
+    accessoriesProbability?: number;
+    skinColor?: string[];
+    clothingColor?: string[];
+    hairColor?: 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/lib/utils/getColors.d.ts

@@ -0,0 +1,8 @@
+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,20 @@
+import { pickColor } from './pickColor.js';
+export function getColors({ prng, options }) {
+    return {
+        skin: pickColor({
+            prng,
+            group: 'skin',
+            values: options.skinColor,
+        }),
+        clothing: pickColor({
+            prng,
+            group: 'clothing',
+            values: options.clothingColor,
+        }),
+        hair: pickColor({
+            prng,
+            group: 'hair',
+            values: options.hairColor,
+        }),
+    };
+}

package/lib/utils/getComponents.d.ts

@@ -0,0 +1,8 @@
+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,39 @@
+import { pickComponent } from './pickComponent.js';
+export function getComponents({ prng, options, }) {
+    const headComponent = pickComponent({
+        prng,
+        group: 'head',
+        values: options.head,
+    });
+    const faceComponent = pickComponent({
+        prng,
+        group: 'face',
+        values: options.face,
+    });
+    const facialHairComponent = pickComponent({
+        prng,
+        group: 'facialHair',
+        values: options.facialHair,
+    });
+    const maskComponent = pickComponent({
+        prng,
+        group: 'mask',
+        values: options.mask,
+    });
+    const accessoriesComponent = pickComponent({
+        prng,
+        group: 'accessories',
+        values: options.accessories,
+    });
+    return {
+        head: headComponent,
+        face: faceComponent,
+        facialHair: prng.bool(options.facialHairProbability)
+            ? facialHairComponent
+            : undefined,
+        mask: prng.bool(options.maskProbability) ? maskComponent : undefined,
+        accessories: prng.bool(options.accessoriesProbability)
+            ? accessoriesComponent
+            : undefined,
+    };
+}

package/lib/utils/pickColor.d.ts

@@ -0,0 +1,9 @@
+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 {};

package/lib/utils/pickColor.js

@@ -0,0 +1,13 @@
+import * as colors from '../colors/index.js';
+export function pickColor({ prng, group, values = [] }) {
+    var _a;
+    const colorCollection = colors;
+    if (values.length === 0) {
+        values.push('transparent');
+    }
+    const key = prng.pick(values);
+    return {
+        name: key,
+        value: (_a = colorCollection[group][key]) !== null && _a !== void 0 ? _a : key,
+    };
+}

package/lib/utils/pickComponent.d.ts

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

package/lib/utils/pickComponent.js

@@ -0,0 +1,14 @@
+import * as components from '../components/index.js';
+export function pickComponent({ prng, group, values = [], }) {
+    const componentCollection = components;
+    const key = prng.pick(values);
+    if (componentCollection[group][key]) {
+        return {
+            name: key,
+            value: componentCollection[group][key],
+        };
+    }
+    else {
+        return undefined;
+    }
+}