@dicebear/core 5.0.0-alpha.3 → 5.0.0-alpha.32

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Florian Körner
+Copyright (c) 2022 Florian Körner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/core.d.ts

@@ -0,0 +1,2 @@
+import type { Result, Style, StyleOptions } from './types.js';
+export declare function createAvatar<O extends {}>(style: Style<O>, options?: StyleOptions<O>): Result;

package/lib/core.js

@@ -0,0 +1,50 @@
+import * as svgUtils from './utils/svg.js';
+import { merge as mergeOptions } from './utils/options.js';
+import { create as createPrng } from './utils/prng.js';
+import * as license from './utils/license.js';
+import { toFormat } from '@dicebear/converter';
+export function createAvatar(style, options = {}) {
+    var _a, _b;
+    options = mergeOptions(style, options);
+    const prng = createPrng(options.seed);
+    const result = style.create({ prng: prng, options });
+    const backgroundColor = prng.pick((_a = options.backgroundColor) !== null && _a !== void 0 ? _a : []);
+    if (options.size) {
+        result.attributes.width = options.size.toString();
+        result.attributes.height = options.size.toString();
+    }
+    if (options.scale !== undefined && options.scale !== 100) {
+        result.body = svgUtils.addScale(result, options.scale);
+    }
+    if (options.flip) {
+        result.body = svgUtils.addFlip(result);
+    }
+    if (options.rotate) {
+        result.body = svgUtils.addRotate(result, options.rotate);
+    }
+    if (options.translateX || options.translateY) {
+        result.body = svgUtils.addTranslate(result, options.translateX, options.translateY);
+    }
+    if (backgroundColor && backgroundColor !== 'transparent') {
+        result.body = svgUtils.addBackgroundColor(result, backgroundColor);
+    }
+    if (options.radius || options.clip) {
+        result.body = svgUtils.addViewboxMask(result, (_b = options.radius) !== null && _b !== void 0 ? _b : 0);
+    }
+    // Reduces the occurrence of ID collisions when rendering multiple avatars on one HTML page.
+    result.body = svgUtils.randomizeIds(result, prng.seed);
+    const attributes = svgUtils.createAttrString(result);
+    const metadata = license.xml(style);
+    const exif = license.exif(style);
+    const avatar = `<svg ${attributes}>${metadata}${result.body}</svg>`;
+    return {
+        toString: () => avatar,
+        ...toFormat(avatar, 'svg'),
+        png: ({ includeExif = false } = {}) => {
+            return toFormat(avatar, 'png', includeExif ? exif : undefined);
+        },
+        jpeg: ({ includeExif = false } = {}) => {
+            return toFormat(avatar, 'jpeg', includeExif ? exif : undefined);
+        },
+    };
+}

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * DiceBear (@dicebear/core)
+ *
+ * Code licensed under MIT (https://github.com/dicebear/dicebear/blob/main/LICENSE)
+ * Copyright (c) 2022 Florian Körner
+ */
+export * from './core.js';
+export * from './schema.js';
+export * as license from './utils/license.js';
+export * as escape from './utils/escape.js';
+export * from './types.js';

package/lib/index.js

@@ -0,0 +1,11 @@
+/*!
+ * DiceBear (@dicebear/core)
+ *
+ * Code licensed under MIT (https://github.com/dicebear/dicebear/blob/main/LICENSE)
+ * Copyright (c) 2022 Florian Körner
+ */
+export * from './core.js';
+export * from './schema.js';
+export * as license from './utils/license.js';
+export * as escape from './utils/escape.js';
+export * from './types.js';

package/lib/schema.d.ts

@@ -0,0 +1,2 @@
+import { JSONSchema7 } from 'json-schema';
+export declare const schema: JSONSchema7;

package/lib/schema.js

@@ -0,0 +1,71 @@
+export const schema = {
+    type: 'object',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Options',
+    properties: {
+        seed: {
+            type: 'string',
+            examples: ['Jane Doe', 'John Doe'],
+        },
+        flip: {
+            type: 'boolean',
+            default: false,
+            examples: [true, false],
+        },
+        rotate: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 360,
+            default: 0,
+            examples: [0, 45, 90, 135, 180, 225, 270, 315],
+        },
+        scale: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 200,
+            default: 100,
+            examples: [50, 100, 150],
+        },
+        radius: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 50,
+            default: 0,
+            examples: [0, 10, 20, 30, 40, 50],
+        },
+        size: {
+            type: 'integer',
+            minimum: 1,
+            examples: [128, 256, 512, 1024],
+        },
+        backgroundColor: {
+            type: 'array',
+            uniqueItems: true,
+            items: {
+                type: 'string',
+                pattern: '^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$',
+            },
+            examples: ['ffd5dc', 'ffdfbf', 'c0eade', 'b6e3f4', 'd1d4f9'],
+        },
+        translateX: {
+            type: 'integer',
+            minimum: -100,
+            maximum: 100,
+            default: 0,
+            examples: [-50, -25, 0, 25, 50],
+        },
+        translateY: {
+            type: 'integer',
+            minimum: -100,
+            maximum: 100,
+            default: 0,
+            examples: [-50, -25, 0, 25, 50],
+        },
+        clip: {
+            type: 'boolean',
+            default: true,
+            examples: [true, false],
+        },
+    },
+    additionalProperties: false,
+};

package/{dist → lib}/types.d.ts

@@ -1,54 +1,63 @@
-import type { JSONSchema7 } from 'json-schema';
-import type { Options } from './options';
-export interface Prng {
-    seed: string;
-    bool(likelihood?: number): boolean;
-    integer(min: number, max: number): number;
-    pick<T>(arr: T[]): T;
-}
-export declare type StyleSchema = JSONSchema7;
-export declare type StyleOptions<O extends {}> = Partial<O & Options>;
-export interface StyleCreateProps<O> {
-    prng: Prng;
-    options: StyleOptions<O>;
-}
-export declare type StyleCreate<O extends {}> = (props: StyleCreateProps<O>) => StyleCreateResult;
-export interface StyleCreateResultAttributes {
-    viewBox: string;
-    [key: string]: string;
-}
-export interface StyleCreateResult {
-    attributes: StyleCreateResultAttributes;
-    body: string;
-}
-export interface StylePreviewProps<O> {
-    prng: Prng;
-    options: StyleOptions<O>;
-    property: keyof StyleOptions<O>;
-}
-export declare type StylePreview<O extends {}> = (props: StylePreviewProps<O>) => StylePreviewResult;
-export interface StylePreviewResultAttributes {
-    viewBox: string;
-    [key: string]: string;
-}
-export declare type StylePreviewResult = undefined | {
-    attributes: StyleCreateResultAttributes;
-    head?: string;
-    body: string;
-};
-export interface StyleMeta {
-    title?: string;
-    creator?: string | string[];
-    source?: string;
-    license?: {
-        name: string;
-        url: string;
-    };
-    contributor?: string | string[];
-}
-export interface Style<O extends {}> {
-    meta: StyleMeta;
-    schema: StyleSchema;
-    create: StyleCreate<O>;
-    preview?: StylePreview<O>;
-}
+import type { JSONSchema7 } from 'json-schema';
+import type { Result as ConverterResult } from '@dicebear/converter';
+export interface ResultConvertOptions {
+    includeExif?: boolean;
+}
+export interface Result extends ConverterResult {
+    png(options?: ResultConvertOptions): ConverterResult;
+    jpeg(options?: ResultConvertOptions): ConverterResult;
+    toString(): string;
+}
+export interface Options {
+    seed?: string;
+    flip?: boolean;
+    rotate?: number;
+    scale?: number;
+    radius?: number;
+    size?: number;
+    backgroundColor?: string[];
+    translateX?: number;
+    translateY?: number;
+    clip?: boolean;
+}
+export interface Exif {
+    [key: string]: string;
+}
+export declare type SchemaDefaults = Record<string, unknown>;
+export interface Prng {
+    seed: string;
+    bool(likelihood?: number): boolean;
+    integer(min: number, max: number): number;
+    pick<T>(arr: T[]): T | undefined;
+    string(length: number, characters?: string): string;
+}
+export declare type StyleSchema = JSONSchema7;
+export declare type StyleOptions<O extends {}> = Partial<O & Options>;
+export interface StyleCreateProps<O> {
+    prng: Prng;
+    options: StyleOptions<O>;
+}
+export declare type StyleCreate<O extends {}> = (props: StyleCreateProps<O>) => StyleCreateResult;
+export interface StyleCreateResultAttributes {
+    viewBox: string;
+    [key: string]: string;
+}
+export interface StyleCreateResult {
+    attributes: StyleCreateResultAttributes;
+    body: string;
+}
+export interface StyleMeta {
+    title?: string;
+    source?: string;
+    creator?: string;
+    homepage?: string;
+    license?: {
+        name: string;
+        url: string;
+    };
+}
+export interface Style<O extends {}> {
+    meta: StyleMeta;
+    schema: StyleSchema;
+    create: StyleCreate<O>;
+}

package/lib/types.js

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

package/lib/utils/escape.d.ts

@@ -0,0 +1 @@
+export declare function xml(content: string): string;

package/lib/utils/escape.js

@@ -0,0 +1,8 @@
+export function xml(content) {
+    return content
+        .replace(/&/g, '&')
+        .replace(/'/g, ''')
+        .replace(/"/g, '"')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;');
+}

package/lib/utils/license.d.ts

@@ -0,0 +1,3 @@
+import { Exif, Style } from '../types';
+export declare function xml(style: Style<any>): string;
+export declare function exif(style: Style<any>): Exif;

package/lib/utils/license.js

@@ -0,0 +1,60 @@
+import * as _ from './escape.js';
+export function xml(style) {
+    var _a, _b, _c, _d, _e;
+    const title = (_a = style.meta.title) !== null && _a !== void 0 ? _a : 'Unnamed';
+    const creator = (_b = style.meta.creator) !== null && _b !== void 0 ? _b : 'Unknown';
+    let description = `"${title}" by "${creator}"`;
+    if ((_c = style.meta.license) === null || _c === void 0 ? void 0 : _c.name) {
+        description += `, licensed under "${style.meta.license.name}".`;
+    }
+    description += ' / Remix of the original. - Created with dicebear.com';
+    const xmlTitle = `<dc:title>${_.xml(title)}</dc:title>`;
+    const xmlCreator = '<dc:creator>' +
+        `<cc:Agent rdf:about="${_.xml((_d = style.meta.homepage) !== null && _d !== void 0 ? _d : '')}">` +
+        `<dc:title>${_.xml(creator)}</dc:title>` +
+        '</cc:Agent>' +
+        '</dc:creator>';
+    const xmlSource = style.meta.source
+        ? `<dc:source>${_.xml(style.meta.source)}</dc:source>`
+        : '';
+    const xmlLicense = ((_e = style.meta.license) === null || _e === void 0 ? void 0 : _e.url)
+        ? `<cc:license rdf:resource="${_.xml(style.meta.license.url)}" />`
+        : '';
+    return (`<desc>${description}</desc>` +
+        '<metadata' +
+        ' xmlns:dc="http://purl.org/dc/elements/1.1/"' +
+        ' xmlns:cc="http://creativecommons.org/ns#"' +
+        ' xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">' +
+        '<rdf:RDF>' +
+        '<cc:Work>' +
+        xmlTitle +
+        xmlCreator +
+        xmlSource +
+        xmlLicense +
+        '</cc:Work>' +
+        '</rdf:RDF>' +
+        '</metadata>');
+}
+export function exif(style) {
+    var _a, _b, _c, _d;
+    const title = (_a = style.meta.title) !== null && _a !== void 0 ? _a : 'Unnamed';
+    const creator = (_b = style.meta.creator) !== null && _b !== void 0 ? _b : 'Unknown';
+    let copyright = `"${title}" by "${creator}"`;
+    if ((_c = style.meta.license) === null || _c === void 0 ? void 0 : _c.name) {
+        copyright += `, licensed under "${style.meta.license.name}".`;
+    }
+    copyright += ' / Remix of the original.';
+    const exif = {
+        ImageDescription: `${copyright} - Created with dicebear.com`,
+        Copyright: copyright,
+        'XMP-dc:Title': title,
+        'XMP-dc:Creator': creator,
+    };
+    if (style.meta.source) {
+        exif['XMP-dc:Source'] = style.meta.source;
+    }
+    if ((_d = style.meta.license) === null || _d === void 0 ? void 0 : _d.url) {
+        exif['XMP-cc:License'] = style.meta.license.url;
+    }
+    return exif;
+}

package/lib/utils/options.d.ts

@@ -0,0 +1,3 @@
+import type { SchemaDefaults, Style, StyleOptions, StyleSchema } from '../types.js';
+export declare function defaults(schema: StyleSchema): SchemaDefaults;
+export declare function merge<O extends {}>(style: Style<O>, options: StyleOptions<O>): StyleOptions<O>;

package/lib/utils/options.js

@@ -0,0 +1,34 @@
+import { schema } from '../schema.js';
+export function defaults(schema) {
+    var _a;
+    let result = {};
+    let props = (_a = schema.properties) !== null && _a !== void 0 ? _a : {};
+    Object.keys(props).forEach((key) => {
+        let val = props[key];
+        if (typeof val === 'object' && undefined !== val.default) {
+            if (Array.isArray(val.default)) {
+                result[key] = [...val.default];
+            }
+            else if (typeof val.default === 'object') {
+                result[key] = { ...val.default };
+            }
+            else {
+                result[key] = val.default;
+            }
+        }
+    });
+    return result;
+}
+export function merge(style, options) {
+    let result = {
+        ...{
+            seed: Math.random().toString(),
+        },
+        ...defaults(schema),
+        ...defaults(style.schema),
+        ...options,
+    };
+    // Return a complete copy because the styles could partially customize the
+    // options and thus modify nested objects and arrays.
+    return JSON.parse(JSON.stringify(result));
+}

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

@@ -1,2 +1,2 @@
-import type { Prng } from '../types';
-export declare function create(seed?: string): Prng;
+import type { Prng } from '../types.js';
+export declare function create(seed?: string): Prng;

package/lib/utils/prng.js

@@ -0,0 +1,46 @@
+const MIN = -2147483648;
+const MAX = 2147483647;
+function xorshift(value) {
+    value ^= value << 13;
+    value ^= value >> 17;
+    value ^= value << 5;
+    return value;
+}
+function hashSeed(seed) {
+    let hash = 0;
+    for (let i = 0; i < seed.length; i++) {
+        hash = ((hash << 5) - hash + seed.charCodeAt(i)) | 0;
+        hash = xorshift(hash);
+    }
+    return hash;
+}
+function randomSeed() {
+    return MIN + Math.floor((MAX - MIN) * Math.random()).toString();
+}
+export function create(seed) {
+    seed = seed !== null && seed !== void 0 ? seed : randomSeed();
+    let value = hashSeed(seed) || 1;
+    const next = () => (value = xorshift(value));
+    const integer = (min, max) => {
+        return Math.floor(((next() - MIN) / (MAX - MIN)) * (max + 1 - min) + min);
+    };
+    return {
+        seed,
+        bool(likelihood = 50) {
+            return integer(0, 100) <= likelihood;
+        },
+        integer(min, max) {
+            return integer(min, max);
+        },
+        pick(arr) {
+            return arr.length > 0 ? arr[integer(0, arr.length - 1)] : undefined;
+        },
+        string(length, characters = 'abcdefghijklmnopqrstuvwxyz1234567890') {
+            let str = '';
+            for (let i = 0; i < length; i++) {
+                str += characters[integer(0, characters.length - 1)];
+            }
+            return str;
+        },
+    };
+}

package/lib/utils/svg.d.ts

@@ -0,0 +1,15 @@
+import type { StyleCreateResult } from '../types.js';
+export declare function getViewBox(result: StyleCreateResult): {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export declare function addBackgroundColor(result: StyleCreateResult, backgroundColor: string): string;
+export declare function addScale(result: StyleCreateResult, scale: number): string;
+export declare function addTranslate(result: StyleCreateResult, x?: number, y?: number): string;
+export declare function addRotate(result: StyleCreateResult, rotate: number): string;
+export declare function addFlip(result: StyleCreateResult): string;
+export declare function addViewboxMask(result: StyleCreateResult, radius: number): string;
+export declare function createAttrString(result: StyleCreateResult): string;
+export declare function randomizeIds(result: StyleCreateResult, seed: string): string;

package/lib/utils/svg.js

@@ -0,0 +1,71 @@
+import * as escape from './escape.js';
+import { create as createPrng } from './prng.js';
+export function getViewBox(result) {
+    let viewBox = result.attributes['viewBox'].split(' ');
+    let x = parseInt(viewBox[0]);
+    let y = parseInt(viewBox[1]);
+    let width = parseInt(viewBox[2]);
+    let height = parseInt(viewBox[3]);
+    return {
+        x,
+        y,
+        width,
+        height,
+    };
+}
+export function addBackgroundColor(result, backgroundColor) {
+    let { width, height, x, y } = getViewBox(result);
+    backgroundColor =
+        backgroundColor[0] === '#' ? backgroundColor : `#${backgroundColor}`;
+    return `<rect fill="${backgroundColor}" width="${width}" height="${height}" x="${x}" y="${y}" />${result.body}`;
+}
+export function addScale(result, scale) {
+    let { width, height, x, y } = getViewBox(result);
+    let percent = scale ? (scale - 100) / 100 : 0;
+    let translateX = (width / 2 + x) * percent * -1;
+    let translateY = (height / 2 + y) * percent * -1;
+    return `<g transform="translate(${translateX} ${translateY}) scale(${scale / 100})">${result.body}</g>`;
+}
+export function addTranslate(result, x, y) {
+    let viewBox = getViewBox(result);
+    let translateX = (viewBox.width + viewBox.x * 2) * ((x !== null && x !== void 0 ? x : 0) / 100);
+    let translateY = (viewBox.height + viewBox.y * 2) * ((y !== null && y !== void 0 ? y : 0) / 100);
+    return `<g transform="translate(${translateX} ${translateY})">${result.body}</g>`;
+}
+export function addRotate(result, rotate) {
+    let { width, height, x, y } = getViewBox(result);
+    return `<g transform="rotate(${rotate}, ${width / 2 + x}, ${height / 2 + y})">${result.body}</g>`;
+}
+export function addFlip(result) {
+    let { width, x } = getViewBox(result);
+    return `<g transform="scale(-1 1) translate(${width * -1 - x * 2} 0)">${result.body}</g>`;
+}
+export function addViewboxMask(result, radius) {
+    let { width, height, x, y } = getViewBox(result);
+    let rx = radius ? (width * radius) / 100 : 0;
+    let ry = radius ? (height * radius) / 100 : 0;
+    return (`<mask id="viewboxMask">` +
+        `<rect width="${width}" height="${height}" rx="${rx}" ry="${ry}" x="${x}" y="${y}" fill="#fff" />` +
+        `</mask>` +
+        `<g mask="url(#viewboxMask)">${result.body}</g>`);
+}
+export function createAttrString(result) {
+    const attributes = {
+        xmlns: 'http://www.w3.org/2000/svg',
+        ...result.attributes,
+    };
+    return Object.keys(attributes)
+        .map((attr) => `${escape.xml(attr)}="${escape.xml(attributes[attr])}"`)
+        .join(' ');
+}
+export function randomizeIds(result, seed) {
+    const prng = createPrng(JSON.stringify({
+        attributes: result.attributes,
+        seed,
+    }));
+    const ids = {};
+    return result.body.replace(/(id="|url\(#)([a-z0-9-_]+)([")])/gi, (match, m1, m2, m3) => {
+        ids[m2] = ids[m2] || prng.string(8);
+        return `${m1}${ids[m2]}${m3}`;
+    });
+}

package/package.json

@@ -1,52 +1,50 @@
 {
   "name": "@dicebear/core",
-  "version": "5.0.0-alpha.3",
+  "version": "5.0.0-alpha.32",
   "description": "An avatar library for designers and developers.",
   "keywords": [
     "avatar",
     "identicon"
   ],
-  "homepage": "https://github.com/dicebear/dicebear/tree/master/packages/@dicebear/core",
+  "homepage": "https://dicebear.com",
   "bugs": {
     "url": "https://github.com/dicebear/dicebear/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:dicebear/dicebear.git",
-    "directory": "/packages/@dicebear/core"
+    "url": "git+https://github.com/dicebear/dicebear.git"
   },
   "license": "MIT",
   "author": "Florian Körner <contact@florian-koerner.com>",
-  "source": "src/index.ts",
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
-  "browser": "dist/index.umd.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "files": [
     "LICENSE",
-    "dist",
+    "lib",
     "README.md"
   ],
   "scripts": {
-    "test": "jest",
+    "prebuild": "del-cli lib",
+    "build": "tsc",
     "prepublishOnly": "npm run build",
-    "prebuild": "shx rm -rf dist",
-    "build": "dicebear-project build DiceBear"
+    "test": "uvu tests"
   },
   "dependencies": {
+    "@dicebear/converter": "^5.0.0-alpha.32",
     "@types/json-schema": "^7.0.7"
   },
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.0",
-    "@types/jest": "^26.0.22",
-    "dicebear-project": "^5.0.0-alpha.3",
-    "jest": "^26.6.3",
-    "shx": "^0.3.3",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3"
+    "@tsconfig/recommended": "^1.0.1",
+    "del-cli": "^4.0.1",
+    "typescript": "^4.6.3",
+    "uvu": "^0.5.3"
+  },
+  "engines": {
+    "node": "^14.13.1 || >=16.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "58ad93754978edcb8f0928e5cd3af2f4d06186da"
+  "gitHead": "5a4a06cbb8aca42a5d19da8e704b3a7b3a45d755"
 }

package/dist/core.d.ts

@@ -1,3 +0,0 @@
-import type { Style, StyleOptions } from './types';
-export declare function createAvatar<O extends {}>(style: Style<O>, options?: StyleOptions<O>): string;
-export declare function createPreview<O extends {}>(style: Style<O>, options: StyleOptions<O>, property: keyof StyleOptions<O>): string | undefined;

package/dist/index.d.ts

@@ -1,12 +0,0 @@
-/*!
- * DiceBear (@dicebear/core)
- *
- * Code licensed under MIT (https://github.com/dicebear/dicebear/blob/main/LICENSE)
- * Copyright (c) 2021 Florian Körner
- */
-import { JSONSchema7 } from 'json-schema';
-export declare const schema: JSONSchema7;
-export * from './core';
-export * from './types';
-export * from './options';
-export * as utils from './utils';