@blackbyte/sugar 1.0.0-beta.29 → 1.0.0-beta.30

package/dist/shared/object/sort.js

@@ -1,71 +0,0 @@
-/**
- * @name                    sort
- * @namespace               shared.object
- * @type                    Function
- * @platform                js
- * @platform                node
- * @status                  stable
- *
- * Sort an object properties the same way as the Array.sort do it.
- * The "a" and "b" argument passed to your sort function will have these properties:
- * - key: The key of the object
- * - value: The actual value of the object property
- *
- * @param                 {Object}                  object                The object to sort
- * @param                 {Function}                [sort=null]                  The sort function to use. If not specified, will sort the items by key alphabetically
- * @return                {Object}                                        The sorted object
- *
- * @todo      tests
- *
- * @snippet         sort($1, $2)
- * sort($1, (a, b) => {
- *      // a.key - a.value | b.key - b.value
- *      $2
- * })
- *
- * @example               js
- * import { sort } from '@blackbyte/sugar/object';
- * sort({
- *    coco: { weight: 10 },
- *    lolo: { weight: 2 },
- *    plop: { weight: 5 }
- * }, (a, b) => {
- *   return a.value.weight - b.value.weight;
- * });
- * // {
- * //   lolo: { weight: 2 },
- * //   plop: { weight: 5 },
- * //   coco: { weight: 10 }
- * // }
- *
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function sort(object, sort) {
-    // get the object keys
-    const keys = Object.keys(object);
-    // sort the keys
-    const sortedKeys = keys.sort((a, b) => {
-        if (!sort) {
-            if (a < b) {
-                return -1;
-            }
-            if (a > b) {
-                return 1;
-            }
-            return 0;
-        }
-        // call the sort function passed as parameter
-        return sort({ key: a, value: object[a] }, { key: b, value: object[b] });
-    });
-    // create the new sorted object
-    const resultObj = {};
-    // loop on each sorted keys
-    sortedKeys.forEach((k) => {
-        // add the property key with the object value
-        resultObj[k] = object[k];
-    });
-    // return the result sorted object
-    return resultObj;
-}
-//# sourceMappingURL=sort.js.map

package/dist/shared/object/sort.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../../src/shared/object/sort.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH,MAAM,CAAC,OAAO,UAAU,IAAI,CAC1B,MAAW,EACX,IASW;IAEX,sBAAsB;IACtB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEjC,gBAAgB;IAChB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACpC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACV,OAAO,CAAC,CAAC,CAAC;YACZ,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACV,OAAO,CAAC,CAAC;YACX,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC;QAED,6CAA6C;QAC7C,OAAO,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,+BAA+B;IAC/B,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,2BAA2B;IAC3B,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACvB,6CAA6C;QAC7C,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,kCAAkC;IAClC,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/shared/object/sortDeep.d.ts

@@ -1,54 +0,0 @@
-/**
- * @name                                sortDeep
- * @namespace                           shared.object
- * @type                                Function
- * @platform                            js
- * @platform                            node
- * @status                              stable
- *
- * Sort an object properties the same way as the Array.sort do it but will do it recusrively to sort the object deeply.
- *
- * @param                 {Object}                  object                The object to sort
- * @param                 {Function}                sort                  The sort function to use
- * @return                {Object}                                        The sorted object
- *
- * @todo      tests
- *
- * @snippet         sortDeep($1, $2)
- * sortDeep($1, (a, b) => {
- *      $2
- * })
- *
- * @example               js
- * import { sortDeep } from '@blackbyte/sugar/object';
- * sortDeep({
- *    lolo: { weight: 2 },
- *    coco: { weight: 10 },
- *    plop: { weight: 5 },
- *    aha: {
- *      hello: 'world',
- *      coco: 'plop'
- *    }
- * }, (a, b) => {
- *    return a.key.localeCompare(b.key);
- * });
- * // {
- * //   aha: {
- * //      coco: 'plop',
- * //      hello: 'world'
- * //   }
- * //   coco: { weight: 10 }
- * //   lolo: { weight: 2 },
- * //   plop: { weight: 5 },
- * // }
- *
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function sortDeep(object: any, sort: (a: {
-    key: string;
-    value: any;
-}, b: {
-    key: string;
-    value: any;
-}) => number): any;

package/dist/shared/object/sortDeep.js

@@ -1,61 +0,0 @@
-import isPlainObject from '../is/isPlainObject.js';
-import __sort from './sort.js';
-/**
- * @name                                sortDeep
- * @namespace                           shared.object
- * @type                                Function
- * @platform                            js
- * @platform                            node
- * @status                              stable
- *
- * Sort an object properties the same way as the Array.sort do it but will do it recusrively to sort the object deeply.
- *
- * @param                 {Object}                  object                The object to sort
- * @param                 {Function}                sort                  The sort function to use
- * @return                {Object}                                        The sorted object
- *
- * @todo      tests
- *
- * @snippet         sortDeep($1, $2)
- * sortDeep($1, (a, b) => {
- *      $2
- * })
- *
- * @example               js
- * import { sortDeep } from '@blackbyte/sugar/object';
- * sortDeep({
- *    lolo: { weight: 2 },
- *    coco: { weight: 10 },
- *    plop: { weight: 5 },
- *    aha: {
- *      hello: 'world',
- *      coco: 'plop'
- *    }
- * }, (a, b) => {
- *    return a.key.localeCompare(b.key);
- * });
- * // {
- * //   aha: {
- * //      coco: 'plop',
- * //      hello: 'world'
- * //   }
- * //   coco: { weight: 10 }
- * //   lolo: { weight: 2 },
- * //   plop: { weight: 5 },
- * // }
- *
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function sortDeep(object, sort) {
-    // sort passed object
-    const sortedObject = __sort(object, sort);
-    // go deep to sort lower levels
-    for (let [key, value] of Object.entries(sortedObject)) {
-        if (isPlainObject(value)) {
-            sortedObject[key] = sortDeep(sortedObject[key], sort);
-        }
-    }
-    return sortedObject;
-}
-//# sourceMappingURL=sortDeep.js.map

package/dist/shared/object/sortDeep.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sortDeep.js","sourceRoot":"","sources":["../../../src/shared/object/sortDeep.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,MAAM,MAAM,WAAW,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,MAAW,EACX,IAGW;IAEX,qBAAqB;IACrB,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC1C,+BAA+B;IAC/B,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QACtD,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,YAAY,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/dist/shared/object/toJson.d.ts

@@ -1,27 +0,0 @@
-/**
- * @name                    toJson
- * @namespace               shared.object
- * @type                    Function
- * @platform                js
- * @platform                node
- * @status                  stable
- *
- * Convert class instances to plain JSON object
- *
- * @param       {Any}           object      The object to convert
- * @return      {Any}                       The converted object
- *
- * @snippet         toJson($1)
- *
- * @example         js
- * import { toJson } from '@blackbyte/sugar/object';
- * class MyClass {
- *      hello = 'world';
- *      something() {}
- * }
- * toJson(new MyClass()); // => { hello: 'world' }
- *
- * @since       1.0.0
- * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function toJson(object: any): any;

package/dist/shared/object/toJson.js

@@ -1,40 +0,0 @@
-import mapDeep from './mapDeep.js';
-import set from './set.js';
-/**
- * @name                    toJson
- * @namespace               shared.object
- * @type                    Function
- * @platform                js
- * @platform                node
- * @status                  stable
- *
- * Convert class instances to plain JSON object
- *
- * @param       {Any}           object      The object to convert
- * @return      {Any}                       The converted object
- *
- * @snippet         toJson($1)
- *
- * @example         js
- * import { toJson } from '@blackbyte/sugar/object';
- * class MyClass {
- *      hello = 'world';
- *      something() {}
- * }
- * toJson(new MyClass()); // => { hello: 'world' }
- *
- * @since       1.0.0
- * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function toJson(object) {
-    const newObj = {};
-    mapDeep(object, ({ value, path }) => {
-        set(newObj, path, value);
-        return value;
-    }, {
-        privateProps: false,
-        classInstances: true,
-    });
-    return newObj;
-}
-//# sourceMappingURL=toJson.js.map

package/dist/shared/object/toJson.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toJson.js","sourceRoot":"","sources":["../../../src/shared/object/toJson.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,GAAG,MAAM,UAAU,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,MAAW;IACxC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,OAAO,CACL,MAAM,EACN,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QAClB,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC,EACD;QACE,YAAY,EAAE,KAAK;QACnB,cAAc,EAAE,IAAI;KACrB,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/object/toPlainObject.d.ts

@@ -1,29 +0,0 @@
-/**
- * @name                        toPlainObject
- * @namespace                   shared.object
- * @type                        Function
- * @platform                    js
- * @platform                    node
- * @status                      stable
- *
- * This function take an object as parameter and return a new one that does not have getters, setters, etc...
- *
- * @param           {Object}            object
- * @param           {Object}            [settings={}]       Some settings to configure your process
- * @return          {Object}                              The new simple object
- *
- * @todo      tests
- *
- * @snippet         toPlainObject($1)
- *
- * @example           js
- * import { toPlainObject } from '@blackbyte/sugar/object';
- * toPlainObject({ something: 'cool' });
- *
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export type TToPlainObjectSettings = {
-    deep: boolean;
-};
-export default function toPlainObject(object: any, settings?: Partial<TToPlainObjectSettings>): any;

package/dist/shared/object/toPlainObject.js

@@ -1,17 +0,0 @@
-import isPlainObject from '../is/isPlainObject.js';
-export default function toPlainObject(object, settings) {
-    const finalSettings = Object.assign({ deep: true }, (settings !== null && settings !== void 0 ? settings : {}));
-    function clean(obj) {
-        const newObj = Object.assign({}, obj);
-        for (let [key, value] of Object.entries(newObj)) {
-            newObj[key] = value;
-            if (finalSettings.deep && isPlainObject(newObj[key])) {
-                newObj[key] = clean(newObj[key]);
-            }
-        }
-        return newObj;
-    }
-    const newObj = clean(object);
-    return newObj;
-}
-//# sourceMappingURL=toPlainObject.js.map

package/dist/shared/object/toPlainObject.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toPlainObject.js","sourceRoot":"","sources":["../../../src/shared/object/toPlainObject.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AA8BnD,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,MAAW,EACX,QAA0C;IAE1C,MAAM,aAAa,mBACjB,IAAI,EAAE,IAAI,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,SAAS,KAAK,CAAC,GAAG;QAChB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACtC,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACpB,IAAI,aAAa,CAAC,IAAI,IAAI,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACrD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/object/toQueryString.d.ts

@@ -1,31 +0,0 @@
-/**
- * @name                toQueryString
- * @namespace           shared.object
- * @type                Function
- * @platform            js
- * @platform            node
- * @status              stable
- *
- * Transform an object (key => pairs) to a query string like "?var1=value1&var2"
- *
- * @param 		{Object} 		obj 		The object to serialize
- * @return 		{String} 					The query string
- *
- * @todo      tests
- *
- * @snippet         toQueryString($1)
- *
- * @example 	js
- * import { toQueryString } from '@blackbyte/sugar/object'
- * console.log(toQueryString({
- * 	value1 : 'coco',
- * 	value1 : 'plop'
- * }));
- * // => ?value1=coco&value2=plop
- *
- * @changelog     1.0.0-beta.17           Added null/undefined value check
- *
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function toQueryString(obj: any): string;

package/dist/shared/object/toQueryString.js

@@ -1,44 +0,0 @@
-// @ts-nocheck
-/**
- * @name                toQueryString
- * @namespace           shared.object
- * @type                Function
- * @platform            js
- * @platform            node
- * @status              stable
- *
- * Transform an object (key => pairs) to a query string like "?var1=value1&var2"
- *
- * @param 		{Object} 		obj 		The object to serialize
- * @return 		{String} 					The query string
- *
- * @todo      tests
- *
- * @snippet         toQueryString($1)
- *
- * @example 	js
- * import { toQueryString } from '@blackbyte/sugar/object'
- * console.log(toQueryString({
- * 	value1 : 'coco',
- * 	value1 : 'plop'
- * }));
- * // => ?value1=coco&value2=plop
- *
- * @changelog     1.0.0-beta.17           Added null/undefined value check
- *
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function toQueryString(obj) {
-    return ('?' +
-        Object.keys(obj)
-            .reduce(function (a, k) {
-            if (obj[k] === undefined || obj[k] === null) {
-                return a;
-            }
-            a.push(k + '=' + encodeURIComponent(obj[k]));
-            return a;
-        }, [])
-            .join('&'));
-}
-//# sourceMappingURL=toQueryString.js.map

package/dist/shared/object/toQueryString.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toQueryString.js","sourceRoot":"","sources":["../../../src/shared/object/toQueryString.ts"],"names":[],"mappings":"AAAA,cAAc;AAEd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,GAAQ;IAC5C,OAAO,CACL,GAAG;QACH,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;aACb,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACpB,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC5C,OAAO,CAAC,CAAC;YACX,CAAC;YACD,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,OAAO,CAAC,CAAC;QACX,CAAC,EAAE,EAAE,CAAC;aACL,IAAI,CAAC,GAAG,CAAC,CACb,CAAC;AACJ,CAAC"}

package/dist/shared/object/unflatten.d.ts

@@ -1,42 +0,0 @@
-/**
- * @name            unflatten
- * @namespace       shared.object
- * @type            Function
- * @platform        js
- * @platform        node
- * @status          stable
- *
- * This function simply take an object like this one:
- *
- * ```js
- * {
- *    'something.cool': 'hello'
- * }
- * ```
- *
- * and convert it to something like this:
- *
- * ```js
- * {
- *    something: {
- *      cool: 'hello'
- *    }
- * }
- * ```
- *
- * @param       {Object}        object        The object to convert
- * @return      {Object}                      The converted object
- *
- * @todo      tests
- *
- * @snippet         unflatten($1)
- *
- * @example       js
- * import { unflatten } from '@blackbyte/sugar/object';
- * unflatten({ 'something.cool': 'hello' }); // => { something: { cool: 'hello' } }
- *
- * @see       https://www.npmjs.com/package/flat
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function unflatten(object: any): any;

package/dist/shared/object/unflatten.js

@@ -1,46 +0,0 @@
-import { inflate } from 'flattenjs';
-/**
- * @name            unflatten
- * @namespace       shared.object
- * @type            Function
- * @platform        js
- * @platform        node
- * @status          stable
- *
- * This function simply take an object like this one:
- *
- * ```js
- * {
- *    'something.cool': 'hello'
- * }
- * ```
- *
- * and convert it to something like this:
- *
- * ```js
- * {
- *    something: {
- *      cool: 'hello'
- *    }
- * }
- * ```
- *
- * @param       {Object}        object        The object to convert
- * @return      {Object}                      The converted object
- *
- * @todo      tests
- *
- * @snippet         unflatten($1)
- *
- * @example       js
- * import { unflatten } from '@blackbyte/sugar/object';
- * unflatten({ 'something.cool': 'hello' }); // => { something: { cool: 'hello' } }
- *
- * @see       https://www.npmjs.com/package/flat
- * @since       1.0.0
- * @author  Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function unflatten(object) {
-    return inflate(object);
-}
-//# sourceMappingURL=unflatten.js.map

package/dist/shared/object/unflatten.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"unflatten.js","sourceRoot":"","sources":["../../../src/shared/object/unflatten.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,MAAW;IAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC"}

package/dist/shared/package/formatPackageJson.d.ts

@@ -1,38 +0,0 @@
-/**
- * @name                    formatPackageJson
- * @namespace               shared.package
- * @type                    Function
- * @platform                js
- * @platform                node
- * @status                  stable
- *
- * This function simply take a package.json JSON formatted object and standardize
- * some fields like the "author" one to be sure it is an object at the end,
- * the "contributors" array the same way as the "author" one, etc... Here's the list
- * of processed actions:
- * 1. Transform the string version of the "author" field into an object with the properties "name", "email" and "url"
- * 2. Transform the string version of the "contributors" field into an object with the properties "name", "email" and "url"
- *
- * @param       {Object}        json        The json to process
- * @return      {Object}                    The standardized json
- *
- * @todo      tests
- *
- * @snippet         formatPackageJson($1)
- *
- * @example       js
- * import { formatPackageJson } from '@blackbyte/sugar/package';
- * formatPackageJson({
- *    "author": "Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)"
- * }); // => {
- *    "author": {
- *      "name": "Olivier Bossel",
- *      "email": "olivier.bossel@gmail.com",
- *      "url": "https://olivierbossel.com"
- *    }
- * }
- *
- * @since       1.0.0
- * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function formatPackageJson(json: any): any;

package/dist/shared/package/formatPackageJson.js

@@ -1,66 +0,0 @@
-import parseAuthorString from './parseAuthorString.js';
-/**
- * @name                    formatPackageJson
- * @namespace               shared.package
- * @type                    Function
- * @platform                js
- * @platform                node
- * @status                  stable
- *
- * This function simply take a package.json JSON formatted object and standardize
- * some fields like the "author" one to be sure it is an object at the end,
- * the "contributors" array the same way as the "author" one, etc... Here's the list
- * of processed actions:
- * 1. Transform the string version of the "author" field into an object with the properties "name", "email" and "url"
- * 2. Transform the string version of the "contributors" field into an object with the properties "name", "email" and "url"
- *
- * @param       {Object}        json        The json to process
- * @return      {Object}                    The standardized json
- *
- * @todo      tests
- *
- * @snippet         formatPackageJson($1)
- *
- * @example       js
- * import { formatPackageJson } from '@blackbyte/sugar/package';
- * formatPackageJson({
- *    "author": "Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)"
- * }); // => {
- *    "author": {
- *      "name": "Olivier Bossel",
- *      "email": "olivier.bossel@gmail.com",
- *      "url": "https://olivierbossel.com"
- *    }
- * }
- *
- * @since       1.0.0
- * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function formatPackageJson(json) {
-    // author
-    if (json.author && typeof json.author === 'string') {
-        json.author = parseAuthorString(json.author);
-    }
-    else if (json.author && Array.isArray(json.author)) {
-        json.author = json.author.map((string) => {
-            if (typeof string === 'string') {
-                return parseAuthorString(string);
-            }
-            return string;
-        });
-    }
-    // contributors
-    if (json.contributors && typeof json.contributors === 'string') {
-        json.contributors = parseAuthorString(json.contributors);
-    }
-    else if (json.contributors && Array.isArray(json.contributors)) {
-        json.contributors = json.contributors.map((string) => {
-            if (typeof string === 'string') {
-                return parseAuthorString(string);
-            }
-            return string;
-        });
-    }
-    return json;
-}
-//# sourceMappingURL=formatPackageJson.js.map

package/dist/shared/package/formatPackageJson.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatPackageJson.js","sourceRoot":"","sources":["../../../src/shared/package/formatPackageJson.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,wBAAwB,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,IAAS;IACjD,SAAS;IACT,IAAI,IAAI,CAAC,MAAM,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;SAAM,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACvC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,eAAe;IACf,IAAI,IAAI,CAAC,YAAY,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC/D,IAAI,CAAC,YAAY,GAAG,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;SAAM,IAAI,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACjE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACnD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/shared/package/parseAuthorString.d.ts

@@ -1,36 +0,0 @@
-/**
- * @name                    parseAuthorString
- * @namespace               shared.package
- * @type                    Function
- * @platform                js
- * @platform                node
- * @status                  stable
- *
- * This function simply take an author string like "Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)" and
- * transform it into a plain object with these properties: name, email and url
- *
- * @param       {String}          string          The string to parse
- * @return      {Object}                          The plain object version of the string
- *
- * @todo      tests
- *
- * @snippet         parseAuthorString($1)
- *
- * @example       js
- * import { parseAuthorString } from '@blackbyte/sugar/package';
- *  parseAuthorString("Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)")
- * // => {
- *   "name": "Olivier Bossel",
- *   "email": "olivier.bossel@gmail.com",
- *   "url": "https://olivierbossel.com"
- * }
- *
- * @since       1.0.0
- * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export type TParseAuthorStringResult = {
-    name: string;
-    email: string;
-    url: string;
-};
-export default function parseAuthorString(string: string): TParseAuthorStringResult;

package/dist/shared/package/parseAuthorString.js

@@ -1,12 +0,0 @@
-export default function parseAuthorString(string) {
-    var _a, _b, _c, _d, _e, _f;
-    const reg = /(.*)\s?<(.*)>\s?\((.*)\)/gm;
-    const matches = reg.exec(string.trim());
-    const authorObj = {
-        name: (_b = (_a = matches === null || matches === void 0 ? void 0 : matches[1]) === null || _a === void 0 ? void 0 : _a.trim()) !== null && _b !== void 0 ? _b : '',
-        email: (_d = (_c = matches === null || matches === void 0 ? void 0 : matches[2]) === null || _c === void 0 ? void 0 : _c.trim()) !== null && _d !== void 0 ? _d : '',
-        url: (_f = (_e = matches === null || matches === void 0 ? void 0 : matches[3]) === null || _e === void 0 ? void 0 : _e.trim()) !== null && _f !== void 0 ? _f : '',
-    };
-    return authorObj;
-}
-//# sourceMappingURL=parseAuthorString.js.map

package/dist/shared/package/parseAuthorString.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parseAuthorString.js","sourceRoot":"","sources":["../../../src/shared/package/parseAuthorString.ts"],"names":[],"mappings":"AAoCA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAc;;IAEd,MAAM,GAAG,GAAG,4BAA4B,CAAC;IACzC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACxC,MAAM,SAAS,GAA6B;QAC1C,IAAI,EAAE,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,CAAC,CAAC,0CAAE,IAAI,EAAE,mCAAI,EAAE;QAChC,KAAK,EAAE,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,CAAC,CAAC,0CAAE,IAAI,EAAE,mCAAI,EAAE;QACjC,GAAG,EAAE,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,CAAC,CAAC,0CAAE,IAAI,EAAE,mCAAI,EAAE;KAChC,CAAC;IACF,OAAO,SAAS,CAAC;AACnB,CAAC"}