@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/array/fromQuantifier.js

@@ -0,0 +1,84 @@
+/**
+ * @name                fromQuantifier
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function allows you to generate an array from a certain passed quantifier like "2", "<10", ">10", "9-12", etc...
+ * This is useful to create arrays that are depending on user-friendly quantifier and it's used for example in the
+ * s-postcss-sugar-plugin for the `@s.lod(>2)` mixin.
+ *
+ * @param       {String|Number}                 quantifier          The quantifier to generate
+ * @param       {TFromQuantifierSettings}       [settings={}]       Some settings to configure your array generation
+ * @return      {Array}                                             The generated array
+ *
+ * @setting         {Number}        max             The maximum wanted when using > and >= quantifiers
+ * @setting         {Function}      value           A function that take the current index and that MUST return the value wanted in the generated array
+ *
+ * @snippet         fromQuantifier($1)
+ *
+ * @example    js
+ * import { fromQuantifier } from '@blackbyte/sugar/array'
+ * fromQuantifier(3); // => [0,1,2]
+ * fromQuantifier('3-5'); // => [3,4,5]
+ * fromQuantifier('3-6', {
+ *    value(i) => `c-${i}`
+ * }); // => ['c-3','c-4','c-5','c-6']
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function fromQuantifier(quantifier, settings) {
+    const finalSettings = Object.assign({ action: '<=' }, (settings !== null && settings !== void 0 ? settings : {}));
+    let action = finalSettings.action;
+    const finalArray = [];
+    if (typeof quantifier === 'number') {
+        quantifier = `${action}${quantifier}`;
+    }
+    if (action.startsWith('>') && finalSettings.max === undefined) {
+        throw new Error(`<red>[fromQuantifier]</red> When using the action ">" or ">=", you MUST specify a settings.max value`);
+    }
+    const actionMatch = quantifier.match(/^((>|<)?\=?)/);
+    if (actionMatch === null || actionMatch === void 0 ? void 0 : actionMatch[0]) {
+        // @ts-ignore
+        action = actionMatch[0];
+    }
+    let startLevel, endLevel, levelInt = parseInt(quantifier.replace(/^(>|<)?\=?/, ''));
+    if (quantifier.match(/[0-9]+\-[0-9]+/)) {
+        const parts = quantifier.split('-');
+        startLevel = parseInt(parts[0]);
+        endLevel = parseInt(parts[1]);
+    }
+    else if (action === '>=') {
+        startLevel = levelInt;
+        endLevel = finalSettings.max;
+    }
+    else if (action === '<=') {
+        startLevel = 0;
+        endLevel = levelInt;
+    }
+    else if (action === '=') {
+        startLevel = levelInt;
+        endLevel = levelInt;
+    }
+    else if (action === '<') {
+        startLevel = 0;
+        endLevel = levelInt - 1;
+    }
+    else if (action === '>') {
+        startLevel = levelInt + 1;
+        endLevel = finalSettings.max;
+    }
+    // add the wanted level(s) in the stack
+    for (let i = startLevel; i <= endLevel; i++) {
+        if (finalSettings.value) {
+            finalArray.push(finalSettings.value(i));
+        }
+        else {
+            finalArray.push(i);
+        }
+    }
+    return finalArray;
+}
+//# sourceMappingURL=fromQuantifier.js.map

package/dist/shared/array/fromQuantifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fromQuantifier.js","sourceRoot":"","sources":["../../../src/shared/array/fromQuantifier.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAQH,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,UAA2B,EAC3B,QAA2C;IAE3C,MAAM,aAAa,mBACjB,MAAM,EAAE,IAAI,IACT,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IACF,IAAI,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;IAElC,MAAM,UAAU,GAAU,EAAE,CAAC;IAE7B,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,UAAU,GAAG,GAAG,MAAM,GAAG,UAAU,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACrD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAG,CAAC,CAAC,EAAE,CAAC;QACrB,aAAa;QACb,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,UAAU,EACZ,QAAQ,EACR,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;IAC5D,IAAI,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;SAAM,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAC3B,UAAU,GAAG,QAAQ,CAAC;QACtB,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC;IAC/B,CAAC;SAAM,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAC3B,UAAU,GAAG,CAAC,CAAC;QACf,QAAQ,GAAG,QAAQ,CAAC;IACtB,CAAC;SAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QAC1B,UAAU,GAAG,QAAQ,CAAC;QACtB,QAAQ,GAAG,QAAQ,CAAC;IACtB,CAAC;SAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QAC1B,UAAU,GAAG,CAAC,CAAC;QACf,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC;IAC1B,CAAC;SAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QAC1B,UAAU,GAAG,QAAQ,GAAG,CAAC,CAAC;QAC1B,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC;IAC/B,CAAC;IAED,uCAAuC;IACvC,KAAK,IAAI,CAAC,GAAG,UAAU,EAAE,CAAC,IAAI,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5C,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;YACxB,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/shared/array/intersection.d.ts

@@ -0,0 +1,30 @@
+import sameItems from './sameItems.js';
+/**
+ * @name            intersection
+ * @namespace       shared.array
+ * @type            Function
+ * @platform        node
+ * @platform        js
+ * @status          stable
+ *
+ * This function take two arrays and return all the items that are the same.
+ * You can specify if you want only comparing by reference for object, etc... or if
+ * you want to transform items in hashes and compare that instead.
+ *
+ * @param       {Array}         ...arrays           The arrays you want to compare
+ * @param       {Object}        [settings={}]           Some settings to refine your comparaison process
+ * @return      {Array}                              An array containing all the items that are present in all the passed arrays
+ *
+ * @setting         {Boolean}          [references=true]        Specify if you want to use the references comparaison or not
+ * @setting         {Boolean}           [hash=true]             Specify if you want to allows transforming object etc in to hashes and compare this instead
+ *
+ * @snippet         intersection($1, $2)
+ *
+ * @example         js
+ * import { intersection } from '@blackbyte/sugar/array';
+ * intersection([1,2,3,4], [1,3,5]); // => [1,3]
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default sameItems;

package/dist/shared/array/intersection.js

@@ -0,0 +1,31 @@
+import sameItems from './sameItems.js';
+/**
+ * @name            intersection
+ * @namespace       shared.array
+ * @type            Function
+ * @platform        node
+ * @platform        js
+ * @status          stable
+ *
+ * This function take two arrays and return all the items that are the same.
+ * You can specify if you want only comparing by reference for object, etc... or if
+ * you want to transform items in hashes and compare that instead.
+ *
+ * @param       {Array}         ...arrays           The arrays you want to compare
+ * @param       {Object}        [settings={}]           Some settings to refine your comparaison process
+ * @return      {Array}                              An array containing all the items that are present in all the passed arrays
+ *
+ * @setting         {Boolean}          [references=true]        Specify if you want to use the references comparaison or not
+ * @setting         {Boolean}           [hash=true]             Specify if you want to allows transforming object etc in to hashes and compare this instead
+ *
+ * @snippet         intersection($1, $2)
+ *
+ * @example         js
+ * import { intersection } from '@blackbyte/sugar/array';
+ * intersection([1,2,3,4], [1,3,5]); // => [1,3]
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default sameItems;
+//# sourceMappingURL=intersection.js.map

package/dist/shared/array/intersection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"intersection.js","sourceRoot":"","sources":["../../../src/shared/array/intersection.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAe,SAAS,CAAC"}

package/dist/shared/array/keysFirst.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @name            keysFirst
+ * @namespace       shared.array
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * Make sure the passed array start with the passed keys
+ *
+ * @param    {Array}      array     The array to sort
+ * @param    {Array}      keys      The keys to start the array with
+ * @return    {Array}               The processed array
+ *
+ * @snippet         keysFirst($1, $2)
+ *
+ * @example    js
+ * import { keysFirst } from '@blackbyte/sugar/array'
+ * keysFirst(['a','b','d','g','c'], ['d','g'])
+ * // ['d','g','a','b','c']
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function keysFirst(array: any[], keys: any[]): any[];

package/dist/shared/array/keysFirst.js

@@ -0,0 +1,39 @@
+import unique from './unique.js';
+/**
+ * @name            keysFirst
+ * @namespace       shared.array
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * Make sure the passed array start with the passed keys
+ *
+ * @param    {Array}      array     The array to sort
+ * @param    {Array}      keys      The keys to start the array with
+ * @return    {Array}               The processed array
+ *
+ * @snippet         keysFirst($1, $2)
+ *
+ * @example    js
+ * import { keysFirst } from '@blackbyte/sugar/array'
+ * keysFirst(['a','b','d','g','c'], ['d','g'])
+ * // ['d','g','a','b','c']
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function keysFirst(array, keys) {
+    // all the keys has to exist in the array stack
+    // otherwise we filter it out
+    keys = keys.filter((key) => {
+        return array.indexOf(key) !== -1;
+    });
+    // add the keys at start
+    const empty = [];
+    let res = empty.concat(keys).concat(array);
+    // remove double items
+    res = unique(res);
+    // return the result
+    return res;
+}
+//# sourceMappingURL=keysFirst.js.map

package/dist/shared/array/keysFirst.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keysFirst.js","sourceRoot":"","sources":["../../../src/shared/array/keysFirst.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,KAAY,EAAE,IAAW;IACzD,+CAA+C;IAC/C,6BAA6B;IAC7B,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACzB,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IACH,wBAAwB;IACxB,MAAM,KAAK,GAAU,EAAE,CAAC;IACxB,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3C,sBAAsB;IACtB,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAClB,oBAAoB;IACpB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/shared/array/keysLast.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @name                keysLast
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Make sure the passed array ends with the passed keys
+ *
+ * @param    {Array}    array       The array to process
+ * @param    {Array}    keys        The keys to end the array with
+ * @return   {Array}                The processed array
+ *
+ * @snippet         keysLast($1, $2)
+ *
+ * @example    js
+ * import { keysLast } from '@blackbyte/sugar/array'
+ * keysLast(['a','b','d','g','c'], ['d','g'])
+ * // ['a','b','c','d','g']
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function keysLast(array: any[], keys: any[]): any[];

package/dist/shared/array/keysLast.js

@@ -0,0 +1,42 @@
+import unique from './unique.js';
+/**
+ * @name                keysLast
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Make sure the passed array ends with the passed keys
+ *
+ * @param    {Array}    array       The array to process
+ * @param    {Array}    keys        The keys to end the array with
+ * @return   {Array}                The processed array
+ *
+ * @snippet         keysLast($1, $2)
+ *
+ * @example    js
+ * import { keysLast } from '@blackbyte/sugar/array'
+ * keysLast(['a','b','d','g','c'], ['d','g'])
+ * // ['a','b','c','d','g']
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function keysLast(array, keys) {
+    // all the keys has to exist in the array stack
+    // otherwise we filter it out
+    keys = keys.filter((key) => {
+        return array.indexOf(key) !== -1;
+    });
+    // add the keys at start
+    let res = [].concat(array).concat(keys);
+    // reverse the array
+    res = res.reverse();
+    // remove double items
+    res = unique(res);
+    // reverse back the array
+    res = res.reverse();
+    // return the result
+    return res;
+}
+//# sourceMappingURL=keysLast.js.map

package/dist/shared/array/keysLast.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keysLast.js","sourceRoot":"","sources":["../../../src/shared/array/keysLast.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,KAAY,EAAE,IAAW;IACxD,+CAA+C;IAC/C,6BAA6B;IAC7B,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACzB,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IACH,wBAAwB;IACxB,IAAI,GAAG,GAAgB,EAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACtD,oBAAoB;IACpB,GAAG,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;IACpB,sBAAsB;IACtB,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAClB,yBAAyB;IACzB,GAAG,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;IACpB,oBAAoB;IACpB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/shared/array/moveItem.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @name                moveItem
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function allows you to move an item to another place in the array
+ *
+ * @param    {Array}          array       The array to process
+ * @param    {any|integer}    from        Either the element itself that you want to move, or the index of the element you want to move
+ * @param    {any|integer}    to          Either the element itself where you want to move the first one, or the index of the element you want to move your element to
+ * @return   {Array}                      The processed array
+ *
+ * @snippet         moveItem($1, $2, $3)
+ *
+ * @example    js
+ * import { moveItem } from '@blackbyte/sugar/array';
+ * const myArray = ['hello','world','something'];
+ * moveItem(myArray, 0, 1); // ['world','hello','something']
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function moveItem(arr: any[], from: any | number, to: any | number): any[];

package/dist/shared/array/moveItem.js

@@ -0,0 +1,39 @@
+/**
+ * @name                moveItem
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function allows you to move an item to another place in the array
+ *
+ * @param    {Array}          array       The array to process
+ * @param    {any|integer}    from        Either the element itself that you want to move, or the index of the element you want to move
+ * @param    {any|integer}    to          Either the element itself where you want to move the first one, or the index of the element you want to move your element to
+ * @return   {Array}                      The processed array
+ *
+ * @snippet         moveItem($1, $2, $3)
+ *
+ * @example    js
+ * import { moveItem } from '@blackbyte/sugar/array';
+ * const myArray = ['hello','world','something'];
+ * moveItem(myArray, 0, 1); // ['world','hello','something']
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function moveItem(arr, from, to) {
+    if (typeof from !== 'number') {
+        from = arr.indexOf(from);
+    }
+    if (typeof to !== 'number') {
+        to = arr.indexOf(to);
+    }
+    if (from > to && to < arr.length) {
+        to++;
+    }
+    let item = arr.splice(from, 1)[0];
+    arr.splice(to, 0, item);
+    return arr;
+}
+//# sourceMappingURL=moveItem.js.map

package/dist/shared/array/moveItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moveItem.js","sourceRoot":"","sources":["../../../src/shared/array/moveItem.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,GAAU,EACV,IAAkB,EAClB,EAAgB;IAEhB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC3B,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,IAAI,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;QACjC,EAAE,EAAE,CAAC;IACP,CAAC;IAED,IAAI,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACxB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/shared/array/pickRandom.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @name                pickRandom
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Pick a random item in the passed array
+ *
+ * @param       {Array}         array       The array from which to pick a random item
+ * @return      {Any}                       A random array item
+ *
+ * @snippet         pickRandom($1)
+ *
+ * @example         js
+ * import { pickRandom } from '@blackbyte/sugar/array';
+ * const array = ['hello','world'];
+ * pickRandom(array); // => 'world'
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function pickRandom(array: any[], count?: number): any;

package/dist/shared/array/pickRandom.js

@@ -0,0 +1,47 @@
+import unique from './unique.js';
+/**
+ * @name                pickRandom
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Pick a random item in the passed array
+ *
+ * @param       {Array}         array       The array from which to pick a random item
+ * @return      {Any}                       A random array item
+ *
+ * @snippet         pickRandom($1)
+ *
+ * @example         js
+ * import { pickRandom } from '@blackbyte/sugar/array';
+ * const array = ['hello','world'];
+ * pickRandom(array); // => 'world'
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function pickRandom(array, count = 1) {
+    // make the array unique
+    array = unique(array);
+    const items = [];
+    if (count > 1) {
+        if (count >= array.length) {
+            return array;
+        }
+        for (let i = 0; i < count; i++) {
+            let item = pickRandom(array, 1);
+            while (items.includes(item)) {
+                item = pickRandom(array, 1);
+            }
+            items.push(item);
+        }
+        return items;
+    }
+    else if (count === 1) {
+        return array[Math.round(Math.random() * (array.length - 1))];
+    }
+    return array;
+}
+//# sourceMappingURL=pickRandom.js.map

package/dist/shared/array/pickRandom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickRandom.js","sourceRoot":"","sources":["../../../src/shared/array/pickRandom.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,KAAY,EAAE,QAAgB,CAAC;IAChE,wBAAwB;IACxB,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAEtB,MAAM,KAAK,GAAU,EAAE,CAAC;IACxB,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/B,IAAI,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAChC,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5B,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC9B,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;SAAM,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/shared/array/pickSome.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @name            pickSome
+ * @namespace       shared.array
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This returns you one or more random item of the passed array
+ *
+ * @param       {Any[]}        array            The array in which you want to pick a random item
+ * @param       {Number}       [$min=1]         The minimum number of items to pick
+ * @param       {Number}       [$max=null]      The maximum number of items to pick
+ * @return      {Any}                           The random array item(s)
+ *
+ * @snippet         pickSome($1,$2,$3);
+ *
+ * @example         ts
+ * import { pickSome } from '@blackbyte/sugar/array':
+ * pickSome(['hello','world','test'], 1, 2);
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function pickSome(array: any[], min?: number, max?: number): any[];

package/dist/shared/array/pickSome.js

@@ -0,0 +1,50 @@
+/**
+ * @name            pickSome
+ * @namespace       shared.array
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This returns you one or more random item of the passed array
+ *
+ * @param       {Any[]}        array            The array in which you want to pick a random item
+ * @param       {Number}       [$min=1]         The minimum number of items to pick
+ * @param       {Number}       [$max=null]      The maximum number of items to pick
+ * @return      {Any}                           The random array item(s)
+ *
+ * @snippet         pickSome($1,$2,$3);
+ *
+ * @example         ts
+ * import { pickSome } from '@blackbyte/sugar/array':
+ * pickSome(['hello','world','test'], 1, 2);
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function pickSome(array, min = 1, max) {
+    if (!max) {
+        max = array.length;
+    }
+    const availableIdx = [];
+    for (let i = 0; i < array.length; i++) {
+        availableIdx.push(i);
+    }
+    const picked = [];
+    while (true) {
+        if (picked.length >= max) {
+            break;
+        }
+        if (picked.length >= min && Math.round(Math.random())) {
+            break;
+        }
+        const idx = Math.floor(Math.random() * availableIdx.length);
+        picked.push(array[availableIdx[idx]]);
+        availableIdx.splice(idx, 1);
+        if (availableIdx.length === 0) {
+            break;
+        }
+    }
+    return picked;
+}
+//# sourceMappingURL=pickSome.js.map

package/dist/shared/array/pickSome.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickSome.js","sourceRoot":"","sources":["../../../src/shared/array/pickSome.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,KAAY,EAAE,MAAc,CAAC,EAAE,GAAY;IAC1E,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,MAAM,GAAU,EAAE,CAAC;IACzB,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACzB,MAAM;QACR,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;YACtD,MAAM;QACR,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACtC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5B,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/array/proxyArray.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @name                proxyArray
+ * @namespace           shared.array
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              beta
+ * @private
+ *
+ * This function override the passed array prototype to intercept changes made through
+ *
+ * @param         {Array}           array           The array to proxy
+ * @return        {Array}                           The same array with his prototype proxied
+ *
+ * @todo        tests
+ *
+ * @example       js
+ * import { proxyArray } from '@blackbyte/sugar/array';
+ * const myArray = proxyArray([1,2,3]);
+ * myArray.watch(['push','pop'], (watchObj) => {
+ *    // check the watchObj action
+ *    switch (watchObj.action) {
+ *      case 'push':
+ *        // do something...
+ *      break;
+ *    }
+ * });
+ *
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function proxyArray(array: any): any;