@dicebear/core 5.0.0-alpha.16 → 5.0.0-alpha.21

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

@@ -1,3 +1,2 @@
-import type { Style, StyleOptions } from './types.js';
-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;
+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

@@ -1,7 +1,8 @@
 import * as svgUtils from './utils/svg.js';
 import { merge as mergeOptions } from './utils/options.js';
 import { create as createPrng } from './utils/prng.js';
-import { convertToDataUri } from './utils/svg.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);
@@ -30,41 +31,19 @@ export function createAvatar(style, options = {}) {
     if (options.radius || options.clip) {
         result.body = svgUtils.addViewboxMask(result, (_b = options.radius) !== null && _b !== void 0 ? _b : 0);
     }
-    let avatar = `<svg ${svgUtils.createAttrString(result.attributes)}>` +
-        `${svgUtils.getMetadata(style)}` +
-        `${result.body}` +
-        `</svg>`;
-    return options.dataUri ? convertToDataUri(avatar) : avatar;
-}
-export function createPreview(style, options, property) {
-    var _a, _b;
-    options = mergeOptions(style, options);
-    const prng = createPrng(options.seed);
-    let result = (_a = style.preview) === null || _a === void 0 ? void 0 : _a.call(style, { prng, options, property });
-    const backgroundColor = prng.pick((_b = options.backgroundColor) !== null && _b !== void 0 ? _b : []);
-    const hasBackgroundColor = backgroundColor && backgroundColor !== 'transparent';
-    const isBackgroundVisible = property === 'backgroundColor';
-    if (undefined === result) {
-        if (hasBackgroundColor && isBackgroundVisible) {
-            result = {
-                attributes: {
-                    viewBox: `0 0 1 1`,
-                    fill: 'none',
-                    'shape-rendering': 'auto',
-                },
-                body: ``,
-            };
-        }
-        else {
-            return undefined;
-        }
-    }
-    if (hasBackgroundColor && isBackgroundVisible) {
-        result.body = svgUtils.addBackgroundColor(result, backgroundColor);
-    }
-    let avatar = `<svg ${svgUtils.createAttrString(result.attributes)}>` +
-        `${svgUtils.getMetadata(style)}` +
-        `${result.body}` +
-        `</svg>`;
-    return options.dataUri ? convertToDataUri(avatar) : avatar;
+    const attributes = svgUtils.createAttrString(result.attributes);
+    const description = '<desc>Created with dicebear.com</desc>';
+    const metadata = license.xml(style);
+    const exif = license.exif(style);
+    const avatar = `<svg ${attributes}>${description}${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

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

package/lib/index.js

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

package/lib/schema.js

@@ -7,11 +7,6 @@ export const schema = {
             type: 'string',
             examples: ['Jane Doe', 'John Doe'],
         },
-        dataUri: {
-            type: 'boolean',
-            default: false,
-            examples: [true, false],
-        },
         flip: {
             type: 'boolean',
             default: false,

package/lib/types.d.ts

@@ -1,7 +1,15 @@
-import { JSONSchema7 } from 'json-schema';
+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;
-    dataUri?: boolean;
     flip?: boolean;
     rotate?: number;
     scale?: number;
@@ -12,6 +20,10 @@ export interface Options {
     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;
@@ -33,34 +45,18 @@ 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;
+    creator?: string;
+    homepage?: string;
     license?: {
         name: string;
         url: string;
     };
-    contributor?: string | string[];
 }
 export interface Style<O extends {}> {
     meta: StyleMeta;
     schema: StyleSchema;
     create: StyleCreate<O>;
-    preview?: StylePreview<O>;
 }

package/lib/utils/escape.d.ts

@@ -1 +1,2 @@
-export declare function xml(attr: string): string;
+export declare function xml(content: string): string;
+export declare function md(content: string): string;

package/lib/utils/escape.js

@@ -1,8 +1,12 @@
-export function xml(attr) {
-    return attr
+export function xml(content) {
+    return content
         .replace(/&/g, '&')
         .replace(/'/g, ''')
         .replace(/"/g, '"')
         .replace(/</g, '&lt;')
         .replace(/>/g, '&gt;');
 }
+export function md(content) {
+    const result = content.replace(/([\\`*_{}[\]()#+-.!])/g, '\\$1');
+    return xml(result);
+}

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,51 @@
+import * as _ from './escape.js';
+export function xml(style) {
+    var _a, _b, _c, _d;
+    const xmlTitle = `<dc:title>${_.xml((_a = style.meta.title) !== null && _a !== void 0 ? _a : 'Unnamed')}</dc:title>`;
+    const xmlCreator = '<dc:creator>' +
+        `<cc:Agent rdf:about="${_.xml((_b = style.meta.homepage) !== null && _b !== void 0 ? _b : '')}">` +
+        `<dc:title>${_.xml((_c = style.meta.creator) !== null && _c !== void 0 ? _c : 'Unknown')}</dc:title>` +
+        '</cc:Agent>' +
+        '</dc:creator>';
+    const xmlSource = style.meta.source
+        ? `<dc:source>${_.xml(style.meta.source)}</dc:source>`
+        : '';
+    const xmlLicense = ((_d = style.meta.license) === null || _d === void 0 ? void 0 : _d.url)
+        ? `<cc:license rdf:resource="${_.xml(style.meta.license.url)}" />`
+        : '';
+    return ('<metadata' +
+        ' id="license"' +
+        ' 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 += ` is licensed under "${style.meta.license.name}".`;
+    }
+    const exif = {
+        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

@@ -1,3 +1,3 @@
-import type { Style, StyleOptions, StyleSchema } from '../types.js';
-export declare function defaults(schema: StyleSchema): Record<string, unknown>;
+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/svg.d.ts

@@ -1,25 +1,10 @@
-import type { Options, Style, StyleCreateResult, StyleCreateResultAttributes } from '../types.js';
+import type { StyleCreateResult, StyleCreateResultAttributes } from '../types.js';
 declare type CreateGroupProps = {
     children: string;
     x: number;
     y: number;
 };
 export declare function createGroup({ children, x, y }: CreateGroupProps): string;
-export declare function getXmlnsAttributes(): {
-    'xmlns:dc': string;
-    'xmlns:cc': string;
-    'xmlns:rdf': string;
-    'xmlns:svg': string;
-    xmlns: string;
-};
-export declare function getMetadata<O extends Options>(style: Style<O>): string;
-export declare function getMetadataWorkTitle<O extends Options>(style: Style<O>): string;
-export declare function getMetadataWorkCreator<O extends Options>(style: Style<O>): string;
-export declare function getMetadataWorkSource<O extends Options>(style: Style<O>): string;
-export declare function getMetadataWorkLicense<O extends Options>(style: Style<O>): string;
-export declare function getMetadataWorkContributor<O extends Options>(style: Style<O>): string;
-export declare function getMetadataWorkAgents(agents: string[]): string[];
-export declare function getMetadataLicense<O extends Options>(style: Style<O>): string;
 export declare function getViewBox(result: StyleCreateResult): {
     x: number;
     y: number;
@@ -33,5 +18,4 @@ export declare function addRotate(result: StyleCreateResult, rotate: number): st
 export declare function addFlip(result: StyleCreateResult): string;
 export declare function addViewboxMask(result: StyleCreateResult, radius: number): string;
 export declare function createAttrString(attributes: StyleCreateResultAttributes): string;
-export declare function convertToDataUri(svg: string): string;
 export {};

package/lib/utils/svg.js

@@ -1,125 +1,7 @@
 import * as escape from './escape.js';
-const ccLicenses = {
-    by: {
-        permits: ['Reproduction', 'Distribution', 'DerivativeWorks'],
-        requires: ['Notice', 'Attribution'],
-        prohibits: [],
-    },
-    'by-sa': {
-        permits: ['Reproduction', 'Distribution', 'DerivativeWorks'],
-        requires: ['Notice', 'Attribution', 'ShareAlike'],
-        prohibits: [],
-    },
-    'by-nd': {
-        permits: ['Reproduction', 'Distribution'],
-        requires: ['Notice', 'Attribution'],
-        prohibits: [],
-    },
-    'by-nc': {
-        permits: ['Reproduction', 'Distribution', 'DerivativeWorks'],
-        requires: ['Notice', 'Attribution'],
-        prohibits: ['CommercialUse'],
-    },
-    'by-nc-sa': {
-        permits: ['Reproduction', 'Distribution', 'DerivativeWorks'],
-        requires: ['Notice', 'Attribution', 'ShareAlike'],
-        prohibits: ['CommercialUse'],
-    },
-    'by-nc-nd': {
-        permits: ['Reproduction', 'Distribution'],
-        requires: ['Notice', 'Attribution'],
-        prohibits: ['CommercialUse'],
-    },
-    zero: {
-        permits: ['Reproduction', 'Distribution', 'DerivativeWorks'],
-        requires: [],
-        prohibits: [],
-    },
-};
 export function createGroup({ children, x, y }) {
     return `<g transform="translate(${x}, ${y})">${children}</g>`;
 }
-export function getXmlnsAttributes() {
-    return {
-        '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#',
-        'xmlns:svg': 'http://www.w3.org/2000/svg',
-        xmlns: 'http://www.w3.org/2000/svg',
-    };
-}
-export function getMetadata(style) {
-    return (`<metadata>` +
-        `<rdf:RDF>` +
-        `<cc:Work>` +
-        `<dc:format>image/svg+xml</dc:format>` +
-        `<dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage" />` +
-        `${getMetadataWorkTitle(style)}` +
-        `${getMetadataWorkCreator(style)}` +
-        `${getMetadataWorkSource(style)}` +
-        `${getMetadataWorkLicense(style)}` +
-        `${getMetadataWorkContributor(style)}` +
-        `</cc:Work>` +
-        `${getMetadataLicense(style)}` +
-        `</rdf:RDF>` +
-        `</metadata>`);
-}
-export function getMetadataWorkTitle(style) {
-    if (style.meta.title) {
-        return `<dc:title>${style.meta.title}</dc:title>`;
-    }
-    return '';
-}
-export function getMetadataWorkCreator(style) {
-    if (style.meta.creator) {
-        let creators = Array.isArray(style.meta.creator) ? style.meta.creator : [style.meta.creator];
-        return `<dc:creator>${getMetadataWorkAgents(creators)}</dc:creator>`;
-    }
-    return '';
-}
-export function getMetadataWorkSource(style) {
-    if (style.meta.source) {
-        return `<dc:source>${style.meta.source}</dc:source>`;
-    }
-    return '';
-}
-export function getMetadataWorkLicense(style) {
-    if (style.meta.license) {
-        return `<cc:license rdf:resource="${style.meta.license.url}" />`;
-    }
-    return '';
-}
-export function getMetadataWorkContributor(style) {
-    if (style.meta.contributor) {
-        let contributors = Array.isArray(style.meta.contributor) ? style.meta.contributor : [style.meta.contributor];
-        return `<dc:contributor>${getMetadataWorkAgents(contributors)}</dc:contributor>`;
-    }
-    return '';
-}
-export function getMetadataWorkAgents(agents) {
-    return agents.map((agent) => `<cc:Agent><dc:title>${agent}</dc:title></cc:Agent>`);
-}
-export function getMetadataLicense(style) {
-    var _a, _b;
-    let match = (_a = style.meta.license) === null || _a === void 0 ? void 0 : _a.url.match(/^https?:\/\/creativecommons.org\/(?:licenses|publicdomain)\/([a-z\-]+)\/\d.\d\//);
-    if (match) {
-        let license = ccLicenses[match[1]];
-        if (license) {
-            let result = ``;
-            license.permits.forEach((permits) => {
-                result += `<cc:permits rdf:resource="https://creativecommons.org/ns#${permits}" />`;
-            });
-            license.requires.forEach((requires) => {
-                result += `<cc:requires rdf:resource="https://creativecommons.org/ns#${requires}" />`;
-            });
-            license.prohibits.forEach((prohibits) => {
-                result += `<cc:prohibits rdf:resource="https://creativecommons.org/ns#${prohibits}" />`;
-            });
-            return `<cc:License rdf:about="${(_b = style.meta.license) === null || _b === void 0 ? void 0 : _b.url}">${result}</cc:License>`;
-        }
-    }
-    return '';
-}
 export function getViewBox(result) {
     let viewBox = result.attributes['viewBox'].split(' ');
     let x = parseInt(viewBox[0]);
@@ -168,11 +50,8 @@ export function addViewboxMask(result, radius) {
         `<g mask="url(#viewboxMask)">${result.body}</g>`);
 }
 export function createAttrString(attributes) {
-    attributes = { ...getXmlnsAttributes(), ...attributes };
+    attributes = { xmlns: 'http://www.w3.org/2000/svg', ...attributes };
     return Object.keys(attributes)
         .map((attr) => `${escape.xml(attr)}="${escape.xml(attributes[attr])}"`)
         .join(' ');
 }
-export function convertToDataUri(svg) {
-    return `data:image/svg+xml;utf8,${encodeURIComponent(svg)}`;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dicebear/core",
-  "version": "5.0.0-alpha.16",
+  "version": "5.0.0-alpha.21",
   "description": "An avatar library for designers and developers.",
   "keywords": [
     "avatar",
@@ -31,20 +31,20 @@
     "test": "uvu tests"
   },
   "dependencies": {
+    "@dicebear/converter": "^5.0.0-alpha.21",
     "@types/json-schema": "^7.0.7"
   },
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.0",
-    "@types/jest": "^26.0.22",
+    "@tsconfig/recommended": "^1.0.1",
     "del-cli": "^4.0.1",
-    "typescript": "^4.5.2",
-    "uvu": "^0.5.2"
+    "typescript": "^4.6.3",
+    "uvu": "^0.5.3"
   },
   "engines": {
-    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+    "node": "^14.13.1 || >=16.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "149a4a22c3a4d48dd5552bd22a49db0f853e0b5e"
+  "gitHead": "40b7190a19ba3c6c355178f1ae6c422229634e06"
 }