@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/faker/richText.js

@@ -0,0 +1,126 @@
+import { faker } from '@faker-js/faker';
+export default function richText(settings) {
+    const str = [];
+    const finalSettings = Object.assign({ p: faker.datatype.boolean(), ul: faker.datatype.boolean(), ol: faker.datatype.boolean(), dl: faker.datatype.boolean(), strong: faker.datatype.boolean(), em: faker.datatype.boolean(), sup: faker.datatype.boolean(), sub: faker.datatype.boolean(), small: faker.datatype.boolean(), code: faker.datatype.boolean(), a: faker.datatype.boolean(), blockquote: faker.datatype.boolean(), h1: faker.datatype.boolean(), h2: faker.datatype.boolean(), h3: faker.datatype.boolean(), h4: faker.datatype.boolean(), h5: faker.datatype.boolean(), h6: faker.datatype.boolean() }, (settings !== null && settings !== void 0 ? settings : {}));
+    if (finalSettings.h1) {
+        str.push('<h1>I am an H1 heading</h1>');
+    }
+    if (finalSettings.h2) {
+        str.push('<h2>I am an H2 heading</h2>');
+    }
+    if (finalSettings.h3) {
+        str.push('<h3>I am an H3 heading</h3>');
+    }
+    if (finalSettings.h4) {
+        str.push('<h4>I am an H4 heading</h4>');
+    }
+    if (finalSettings.h5) {
+        str.push('<h5>I am an H5 heading</h5>');
+    }
+    if (finalSettings.h6) {
+        str.push('<h6>I am an H6 heading</h6>');
+    }
+    if (finalSettings.p) {
+        for (let i = 0; i < Math.round(Math.random() * 5); i++) {
+            str.push(`<p>${faker.lorem.paragraph({
+                min: 1,
+                max: 3,
+            })}</p>`);
+        }
+    }
+    if (finalSettings.ul) {
+        function _ul(level = 0) {
+            const ul = [];
+            ul.push('<ul>');
+            for (let i = 0; i < Math.round(Math.random() * 5); i++) {
+                ul.push('<li>');
+                ul.push(faker.lorem.sentence({
+                    min: 1,
+                    max: 3,
+                }));
+                if (faker.datatype.boolean() && level === 0) {
+                    ul.push(_ul(level + 1));
+                }
+                ul.push('</li>');
+            }
+            ul.push('</ul>');
+            return ul.join('\n');
+        }
+        str.push(_ul());
+    }
+    if (finalSettings.ol) {
+        function _ol(level = 0) {
+            const ol = [];
+            ol.push('<ol>');
+            for (let i = 0; i < Math.round(Math.random() * 5); i++) {
+                ol.push('<li>');
+                ol.push(faker.lorem.sentence({
+                    min: 1,
+                    max: 3,
+                }));
+                if (faker.datatype.boolean() && level === 0) {
+                    ol.push(_ol(level + 1));
+                }
+                ol.push('</li>');
+            }
+            ol.push('</ol>');
+            return ol.join('\n');
+        }
+        str.push(_ol());
+    }
+    if (finalSettings.dl) {
+        function _dl(level = 0) {
+            const dl = [];
+            dl.push('<dl>');
+            for (let i = 0; i < Math.round(Math.random() * 5); i++) {
+                dl.push('<dt>');
+                dl.push(faker.lorem.sentence({
+                    min: 1,
+                    max: 3,
+                }));
+                dl.push('</dt>');
+                dl.push('<dd>');
+                dl.push(faker.lorem.sentence({
+                    min: 1,
+                    max: 3,
+                }));
+                if (faker.datatype.boolean() && level === 0) {
+                    dl.push(_dl(level + 1));
+                }
+                dl.push('</dd>');
+            }
+            dl.push('</dl>');
+            return dl.join('\n');
+        }
+        str.push(_dl());
+    }
+    if (finalSettings.strong) {
+        str.push('<p>I am a <strong>strong</strong> example</p>');
+    }
+    if (finalSettings.em) {
+        str.push('<p>I am an <em>emphasized</em> example</p>');
+    }
+    if (finalSettings.sup) {
+        str.push('<p>I am a <sup>superscript</sup> example</p>');
+    }
+    if (finalSettings.sub) {
+        str.push('<p>I am a <sub>subscript</sub> example</p>');
+    }
+    if (finalSettings.small) {
+        str.push('<p>I am a <small>small</small> example</p>');
+    }
+    if (finalSettings.code) {
+        str.push('<p>I am a <code>code</code> example</p>');
+    }
+    if (finalSettings.a) {
+        str.push(`<p>I am a <a href="${faker.lorem.slug}">link</a> example</p>`);
+    }
+    if (finalSettings.blockquote) {
+        str.push(`<blockquote>${faker.lorem.sentence({
+            min: 1,
+            max: 3,
+        })}</blockquote>`);
+    }
+    return str.join('\n');
+}
+//# sourceMappingURL=richText.js.map

package/dist/shared/faker/richText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"richText.js","sourceRoot":"","sources":["../../../src/shared/faker/richText.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AA4CxC,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,QAA4B;IAC3D,MAAM,GAAG,GAAa,EAAE,CAAC;IAEzB,MAAM,aAAa,mBACjB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC3B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAChC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC7B,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC7B,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC/B,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC9B,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC3B,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EACpC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAC5B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IACzB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC;QACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACvD,GAAG,CAAC,IAAI,CACN,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;gBAC1B,GAAG,EAAE,CAAC;gBACN,GAAG,EAAE,CAAC;aACP,CAAC,MAAM,CACT,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,SAAS,GAAG,CAAC,KAAK,GAAG,CAAC;YACpB,MAAM,EAAE,GAAa,EAAE,CAAC;YACxB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEhB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvD,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhB,EAAE,CAAC,IAAI,CACL,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBACnB,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,CAAC;iBACP,CAAC,CACH,CAAC;gBAEF,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAC5C,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC1B,CAAC;gBAED,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;YACD,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEjB,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,SAAS,GAAG,CAAC,KAAK,GAAG,CAAC;YACpB,MAAM,EAAE,GAAa,EAAE,CAAC;YACxB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvD,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhB,EAAE,CAAC,IAAI,CACL,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBACnB,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,CAAC;iBACP,CAAC,CACH,CAAC;gBAEF,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAC5C,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC1B,CAAC;gBACD,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;YACD,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjB,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,SAAS,GAAG,CAAC,KAAK,GAAG,CAAC;YACpB,MAAM,EAAE,GAAa,EAAE,CAAC;YACxB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvD,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhB,EAAE,CAAC,IAAI,CACL,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBACnB,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,CAAC;iBACP,CAAC,CACH,CAAC;gBAEF,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACjB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAChB,EAAE,CAAC,IAAI,CACL,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBACnB,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,CAAC;iBACP,CAAC,CACH,CAAC;gBAEF,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAC5C,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC1B,CAAC;gBAED,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;YACD,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjB,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QACzB,GAAG,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC;QACtB,GAAG,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC;QACtB,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;QACxB,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC;QACpB,GAAG,CAAC,IAAI,CAAC,sBAAsB,KAAK,CAAC,KAAK,CAAC,IAAI,wBAAwB,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,aAAa,CAAC,UAAU,EAAE,CAAC;QAC7B,GAAG,CAAC,IAAI,CACN,eAAe,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YAClC,GAAG,EAAE,CAAC;YACN,GAAG,EAAE,CAAC;SACP,CAAC,eAAe,CAClB,CAAC;IACJ,CAAC;IAED,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC"}

package/dist/shared/format/_exports.d.ts

@@ -0,0 +1,3 @@
+import formatFileSize from './formatFileSize.js';
+import formatDuration from './formatDuration.js';
+export { formatFileSize as __formatFileSize, formatFileSize, formatDuration as __formatDuration, formatDuration, };

package/dist/shared/format/_exports.js

@@ -0,0 +1,4 @@
+import formatFileSize from './formatFileSize.js';
+import formatDuration from './formatDuration.js';
+export { formatFileSize as __formatFileSize, formatFileSize, formatDuration as __formatDuration, formatDuration, };
+//# sourceMappingURL=_exports.js.map

package/dist/shared/format/_exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/format/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EACL,cAAc,IAAI,gBAAgB,EAClC,cAAc,EACd,cAAc,IAAI,gBAAgB,EAClC,cAAc,GACf,CAAC"}

package/dist/shared/format/fileSize.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @name                formatFileSize
+ * @namespace           shared.format
+ * @type                Function
+ * @platform            node
+ * @platform            js
+ * @status              stable
+ *
+ * Transform into human readable string a file size from a number (float or integer) or string.
+ * This function use the wonderfull "filesize" npm package under the houd.
+ *
+ * @param               {Number|String}             size              The size to transform in bytes
+ * @param               {Object}                    [settings={}]     The "filesize" settings to customize the output. See [filesize](https://www.npmjs.com/package/filesize) settings
+ * @return              {String}                                      The human readable version of the passed size
+ *
+ * @setting             {Number}                [base=10]              (number) Number base, default is 10
+ * @setting             {Boolean}               [bits=false]           (boolean) Enables `bit` sizes, default is false
+ * @setting             {Number}                [exponent=0]           (number) Specifies the SI suffix via exponent, e.g. 2 is MB for bytes, default is 0
+ * @setting             {Boolean}               [fullform=false]       (boolean) Enables full form of unit of measure, default is false
+ * @setting             {Array}                 [fullforms]            (array) Array of full form overrides, default is []
+ * @setting             {Boolean|String}        [locale=false]         (boolean|string) Localize the output, default is false
+ * @setting             {Boolean}               [pad=false]             (boolean) Should the output be padded to the left, default is false
+ * @setting             {Number}                [precision=2]          (number) The precision to use when outputting decimal values, default is 2
+ * @setting             {Number}                [round=2]              (number) The rounding function, default is 2
+ * @setting             {String}                [separator='.']         (string) Separator of thousands, default is '.'
+ * @setting             {String}                [spacer=' ']            (string) Spacer of the output, default is ' '
+ *
+ * @snippet         formatFileSize($1)
+ *
+ * @todo     tests
+ *
+ * @example             js
+ * import { formatFilesize } from '@blackbyte/sugar/fs';
+ * formatFilesize(163931); // => 326.86 KB
+ *
+ * @see             https://www.npmjs.com/package/filesize
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFormatFileSizeSettings = {
+    base?: number;
+    bits?: boolean;
+    exponent?: number;
+    fullform?: boolean;
+    fullforms?: any[];
+    locale?: boolean | string;
+    pad?: boolean;
+    precision?: number;
+    round?: number;
+    separator?: string;
+    spacer?: string;
+};
+export default function formatFileSize(size: number, settings?: TFormatFileSizeSettings): string | number | import("filesize").FileSizeReturnArray | import("filesize").FileSizeReturnObject;

package/dist/shared/format/fileSize.js

@@ -0,0 +1,6 @@
+import { filesize as __filesize } from 'filesize';
+export default function formatFileSize(size, settings = {}) {
+    // @ts-ignore
+    return __filesize(size, settings);
+}
+//# sourceMappingURL=fileSize.js.map

package/dist/shared/format/fileSize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileSize.js","sourceRoot":"","sources":["../../../src/shared/format/fileSize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAE,MAAM,UAAU,CAAC;AAwDlD,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,IAAY,EACZ,WAAoC,EAAE;IAEtC,aAAa;IACb,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC"}

package/dist/shared/format/formatDuration.d.ts

@@ -0,0 +1,26 @@
+import { formatDuration } from '@blackbyte/sugar/datetime';
+/**
+ * @name                formatDuration
+ * @namespace           shared.format
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function let you pass a duration in ms and get back a formatted estimation like "2.4m", "30s", etc...
+ *
+ * @param         {Number}        duration          The duration in ms to format
+ * @return        {String}                          The formatted estimation duration
+ *
+ * @todo      tests
+ *
+ * @snippet         formatDuration($1)
+ *
+ * @example       js
+ * import { formatDuration } from '@blackbyte/sugar/format';
+ * formatDuration(2000); // => 2s
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default formatDuration;

package/dist/shared/format/formatDuration.js

@@ -0,0 +1,27 @@
+import { formatDuration } from '@blackbyte/sugar/datetime';
+/**
+ * @name                formatDuration
+ * @namespace           shared.format
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function let you pass a duration in ms and get back a formatted estimation like "2.4m", "30s", etc...
+ *
+ * @param         {Number}        duration          The duration in ms to format
+ * @return        {String}                          The formatted estimation duration
+ *
+ * @todo      tests
+ *
+ * @snippet         formatDuration($1)
+ *
+ * @example       js
+ * import { formatDuration } from '@blackbyte/sugar/format';
+ * formatDuration(2000); // => 2s
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default formatDuration;
+//# sourceMappingURL=formatDuration.js.map

package/dist/shared/format/formatDuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatDuration.js","sourceRoot":"","sources":["../../../src/shared/format/formatDuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAe,cAAc,CAAC"}

package/dist/shared/format/formatFileSize.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @name                formatFileSize
+ * @namespace           shared.format
+ * @type                Function
+ * @platform            node
+ * @platform            js
+ * @status              stable
+ *
+ * Transform into human readable string a file size from a number (float or integer) or string.
+ * This function use the wonderfull "filesize" npm package under the houd.
+ *
+ * @param               {Number|String}             size              The size to transform in bytes
+ * @param               {Object}                    [settings={}]     The "filesize" settings to customize the output. See [filesize](https://www.npmjs.com/package/filesize) settings
+ * @return              {String}                                      The human readable version of the passed size
+ *
+ * @setting             {Number}                [base=10]              (number) Number base, default is 10
+ * @setting             {Boolean}               [bits=false]           (boolean) Enables `bit` sizes, default is false
+ * @setting             {Number}                [exponent=0]           (number) Specifies the SI suffix via exponent, e.g. 2 is MB for bytes, default is 0
+ * @setting             {Boolean}               [fullform=false]       (boolean) Enables full form of unit of measure, default is false
+ * @setting             {Array}                 [fullforms]            (array) Array of full form overrides, default is []
+ * @setting             {Boolean|String}        [locale=false]         (boolean|string) Localize the output, default is false
+ * @setting             {Boolean}               [pad=false]             (boolean) Should the output be padded to the left, default is false
+ * @setting             {Number}                [precision=2]          (number) The precision to use when outputting decimal values, default is 2
+ * @setting             {Number}                [round=2]              (number) The rounding function, default is 2
+ * @setting             {String}                [separator='.']         (string) Separator of thousands, default is '.'
+ * @setting             {String}                [spacer=' ']            (string) Spacer of the output, default is ' '
+ *
+ * @snippet         formatFileSize($1)
+ *
+ * @todo     tests
+ *
+ * @example             js
+ * import { formatFilesize } from '@blackbyte/sugar/format';
+ * formatFilesize(163931); // => 326.86 KB
+ *
+ * @see             https://www.npmjs.com/package/filesize
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFormatFileSizeSettings = {
+    base?: number;
+    bits?: boolean;
+    exponent?: number;
+    fullform?: boolean;
+    fullforms?: any[];
+    locale?: boolean | string;
+    pad?: boolean;
+    precision?: number;
+    round?: number;
+    separator?: string;
+    spacer?: string;
+};
+export default function formatFileSize(size: number, settings?: TFormatFileSizeSettings): string | number | import("filesize").FileSizeReturnArray | import("filesize").FileSizeReturnObject;

package/dist/shared/format/formatFileSize.js

@@ -0,0 +1,6 @@
+import { filesize as __filesize } from 'filesize';
+export default function formatFileSize(size, settings = {}) {
+    // @ts-ignore
+    return __filesize(size, settings);
+}
+//# sourceMappingURL=formatFileSize.js.map

package/dist/shared/format/formatFileSize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatFileSize.js","sourceRoot":"","sources":["../../../src/shared/format/formatFileSize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAE,MAAM,UAAU,CAAC;AAwDlD,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,IAAY,EACZ,WAAoC,EAAE;IAEtC,aAAa;IACb,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC"}

package/dist/shared/function/_exports.d.ts

@@ -0,0 +1,7 @@
+import debounce from './debounce.js';
+import easeInterval from './easeInterval.js';
+import getArgsNames from './getArgsNames.js';
+import memoize from './memoize.js';
+import sleep from './sleep.js';
+import throttle from './throttle.js';
+export { debounce as __debounce, easeInterval as __easeInterval, getArgsNames as __getArgsNames, memoize as __memoize, sleep as __sleep, throttle as __throttle, debounce, easeInterval, getArgsNames, memoize, sleep, throttle, };

package/dist/shared/function/_exports.js

@@ -0,0 +1,8 @@
+import debounce from './debounce.js';
+import easeInterval from './easeInterval.js';
+import getArgsNames from './getArgsNames.js';
+import memoize from './memoize.js';
+import sleep from './sleep.js';
+import throttle from './throttle.js';
+export { debounce as __debounce, easeInterval as __easeInterval, getArgsNames as __getArgsNames, memoize as __memoize, sleep as __sleep, throttle as __throttle, debounce, easeInterval, getArgsNames, memoize, sleep, throttle, };
+//# sourceMappingURL=_exports.js.map

package/dist/shared/function/_exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/function/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,QAAQ,MAAM,eAAe,CAAC;AAErC,OAAO,EACL,QAAQ,IAAI,UAAU,EACtB,YAAY,IAAI,cAAc,EAC9B,YAAY,IAAI,cAAc,EAC9B,OAAO,IAAI,SAAS,EACpB,KAAK,IAAI,OAAO,EAChB,QAAQ,IAAI,UAAU,EACtB,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,KAAK,EACL,QAAQ,GACT,CAAC"}

package/dist/shared/function/debounce.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @name                debounce
+ * @namespace           shared.function
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This utils function allows you to make sure that a function that will normally be called
+ * several times, for example during a scroll event, to be called only once after
+ * the delay passed
+ *
+ * @param       {Number}        delay          A delay in ms to wait between two function calls
+ * @param       {Function}      fn              The function to debounce
+ *
+ * @todo      tests
+ *
+ * @snippet         debounce($1, $2)
+ * debounce($1, () => {
+ *      $2
+ * })
+ *
+ * @example 		js
+ * import { debounce } from '@blackbyte/sugar/function';
+ * const myDebouncedFn = debounce(1000, () => {
+ * 		// my function content that will be
+ * 		// executed only once after the 1 second delay
+ * });
+ *
+ * document.addEventListener('scroll', (e) => {
+ * 		// call my debounced function
+ * 		myDebouncedFn();
+ * });
+ *
+ * @since           1.0.0
+ * @author 	        Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function debounce(delay: number, fn: Function): Function;

package/dist/shared/function/debounce.js

@@ -0,0 +1,49 @@
+/**
+ * @name                debounce
+ * @namespace           shared.function
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This utils function allows you to make sure that a function that will normally be called
+ * several times, for example during a scroll event, to be called only once after
+ * the delay passed
+ *
+ * @param       {Number}        delay          A delay in ms to wait between two function calls
+ * @param       {Function}      fn              The function to debounce
+ *
+ * @todo      tests
+ *
+ * @snippet         debounce($1, $2)
+ * debounce($1, () => {
+ *      $2
+ * })
+ *
+ * @example 		js
+ * import { debounce } from '@blackbyte/sugar/function';
+ * const myDebouncedFn = debounce(1000, () => {
+ * 		// my function content that will be
+ * 		// executed only once after the 1 second delay
+ * });
+ *
+ * document.addEventListener('scroll', (e) => {
+ * 		// call my debounced function
+ * 		myDebouncedFn();
+ * });
+ *
+ * @since           1.0.0
+ * @author 	        Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function debounce(delay, fn) {
+    let timer;
+    return function () {
+        // @ts-ignore
+        const context = this, args = arguments;
+        clearTimeout(timer);
+        timer = setTimeout(function () {
+            fn.apply(context, args);
+        }, delay);
+    };
+}
+//# sourceMappingURL=debounce.js.map

package/dist/shared/function/debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../../src/shared/function/debounce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,KAAa,EAAE,EAAY;IAC1D,IAAI,KAAK,CAAC;IACV,OAAO;QACL,aAAa;QACb,MAAM,OAAO,GAAG,IAAI,EAClB,IAAI,GAAG,SAAS,CAAC;QACnB,YAAY,CAAC,KAAK,CAAC,CAAC;QACpB,KAAK,GAAG,UAAU,CAAC;YACjB,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC,CAAC;AACJ,CAAC"}

package/dist/shared/function/easeInterval.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @name                easeInterval
+ * @namespace           shared.function
+ * @type                Function
+ * @platform            js
+ * @status              stable
+ * @async
+ *
+ * This function allows you to call a callback function exactly as the `setInterval` would do but with an easing that you can specify,
+ * as well as an `interval` setting to customize how many time your function will be called.
+ * By default this function will pass the "easedPercent" that represent the percentage of your passed "duration" with the easing applied on it.
+ * With that you can make everything you want inside your callback function.
+ *
+ * @param       {Number}            duration            The duration of your interval process you want
+ * @param       {Function}          [cb=null]           A callback function to call at each interval
+ * @param       {TEaseIntervalSettings}     [settings={}]       Some settings to customize your interval process
+ * @return      {Promise<number>}                        A promise that will be resolved once the process is complete
+ *
+ * @setting         {Number}        [inteval=1000/25]           An interval in ms to call your callback function
+ * @setting         {Function}      [easing=easeInOutQuart]     An easing function that take as parameter a value between 0 and 1
+ * @setting         {Number}        [from=0]                    The value to start with
+ * @setting         {Number}        [to=100]                    The value to end with
+ *
+ * ª@todo      tests
+ *
+ * @snippet         easeInterval($1, $2)
+ * const easeInterval = easeInterval($1, percent => {
+ *      $2
+ * });
+ * // easeInterval.cancel(); // stop the easing process
+ * await easeInterval;
+ *
+ * @example         js
+ * import { easeInterval } from '@blackbyte/sugar/function';
+ * await easeInterval(2000, (easedPercent) => {
+ *      // do something...
+ * }, {
+ *      interval: 1000 / 25 // 25 times by second
+ * });
+ *
+ * @since       1.0.0
+ * @author 		Olivier Bossel<olivier.bossel@gmail.com>
+ */
+export type TEaseIntervalSettings = {
+    interval?: number;
+    easing?: Function;
+    from?: number;
+    to?: number;
+    onEnd?: Function;
+};
+export default function easeInterval(duration: number, cb: Function, settings?: TEaseIntervalSettings): Promise<number>;

package/dist/shared/function/easeInterval.js

@@ -0,0 +1,34 @@
+import easeInOutQuart from '../easing/easeInOutQuart.js';
+export default function easeInterval(duration, cb, settings = {}) {
+    let cleared = false, animationFrame;
+    const pro = new Promise((resolve) => {
+        settings = Object.assign({ interval: 1000 / 25, easing: easeInOutQuart, from: 0, to: 100, onEnd: undefined }, settings);
+        const startTime = Date.now();
+        function animate() {
+            var _a;
+            if (cleared)
+                return;
+            const percent = (100 / duration) * (Date.now() - startTime);
+            // @ts-ignore
+            const easedPercent = settings.easing(percent / 100) * 100;
+            cb(easedPercent);
+            if (percent < 100) {
+                if (cleared)
+                    return;
+                animationFrame = requestAnimationFrame(animate);
+            }
+            else {
+                (_a = settings.onEnd) === null || _a === void 0 ? void 0 : _a.call(settings);
+                resolve(easedPercent);
+            }
+        }
+        animate();
+    });
+    // @ts-ignore
+    pro.cancel = () => {
+        cleared = true;
+        cancelAnimationFrame(animationFrame);
+    };
+    return pro;
+}
+//# sourceMappingURL=easeInterval.js.map

package/dist/shared/function/easeInterval.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"easeInterval.js","sourceRoot":"","sources":["../../../src/shared/function/easeInterval.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,6BAA6B,CAAC;AAsDzD,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,QAAgB,EAChB,EAAY,EACZ,WAAkC,EAAE;IAEpC,IAAI,OAAO,GAAG,KAAK,EACjB,cAAc,CAAC;IAEjB,MAAM,GAAG,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;QAC1C,QAAQ,mBACN,QAAQ,EAAE,IAAI,GAAG,EAAE,EACnB,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,CAAC,EACP,EAAE,EAAE,GAAG,EACP,KAAK,EAAE,SAAS,IACb,QAAQ,CACZ,CAAC;QACF,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,SAAS,OAAO;;YACd,IAAI,OAAO;gBAAE,OAAO;YACpB,MAAM,OAAO,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;YAC5D,aAAa;YACb,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;YAC1D,EAAE,CAAC,YAAY,CAAC,CAAC;YACjB,IAAI,OAAO,GAAG,GAAG,EAAE,CAAC;gBAClB,IAAI,OAAO;oBAAE,OAAO;gBACpB,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,MAAA,QAAQ,CAAC,KAAK,wDAAI,CAAC;gBACnB,OAAO,CAAC,YAAY,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,aAAa;IACb,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE;QAChB,OAAO,GAAG,IAAI,CAAC;QACf,oBAAoB,CAAC,cAAc,CAAC,CAAC;IACvC,CAAC,CAAC;IAEF,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/shared/function/getArgsNames.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                getArgsNames
+ * @namespace           shared.function
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              beta
+ *
+ * Get the arguments names of the passed function. Return an array of the arguments names
+ *
+ * @param             {Function}              func                  The function reference of which get the arguments names
+ * @return            {Array}                                       An array of arguments names
+ *
+ * @todo        tests
+ *
+ * @snippet         getArgsNames($1)
+ *
+ * @example         js
+ * import { getArgsNames } from '@blackbyte/sugar/function';
+ * function hello(world, coco, plop) { }
+ * getArgsNames(hello); // => ['world', 'coco', 'plop']
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function getArgsNames(func: Function): string[];

package/dist/shared/function/getArgsNames.js

@@ -0,0 +1,53 @@
+/**
+ * @name                getArgsNames
+ * @namespace           shared.function
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              beta
+ *
+ * Get the arguments names of the passed function. Return an array of the arguments names
+ *
+ * @param             {Function}              func                  The function reference of which get the arguments names
+ * @return            {Array}                                       An array of arguments names
+ *
+ * @todo        tests
+ *
+ * @snippet         getArgsNames($1)
+ *
+ * @example         js
+ * import { getArgsNames } from '@blackbyte/sugar/function';
+ * function hello(world, coco, plop) { }
+ * getArgsNames(hello); // => ['world', 'coco', 'plop']
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function getArgsNames(func) {
+    // String representaation of the function code
+    let str = func.toString();
+    // Remove comments of the form /* ... */
+    // Removing comments of the form //
+    // Remove body of the function { ... }
+    // removing '=>' if func is arrow function
+    str = str
+        .replace(/\/\*[\s\S]*?\*\//g, '')
+        .replace(/\/\/(.)*/g, '')
+        .replace(/{[\s\S]*}/, '')
+        .replace(/=>/g, '')
+        .trim();
+    // Start parameter names after first '('
+    const start = str.indexOf('(') + 1;
+    // End parameter names is just before last ')'
+    const end = str.length - 1;
+    const result = str.substring(start, end).split(', ');
+    const params = [];
+    result.forEach((element) => {
+        // Removing any default value
+        element = element.replace(/=[\s\S]*/g, '').trim();
+        if (element.length > 0)
+            params.push(element);
+    });
+    return params;
+}
+//# sourceMappingURL=getArgsNames.js.map

package/dist/shared/function/getArgsNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getArgsNames.js","sourceRoot":"","sources":["../../../src/shared/function/getArgsNames.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,IAAc;IACjD,8CAA8C;IAC9C,IAAI,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC1B,wCAAwC;IACxC,mCAAmC;IACnC,sCAAsC;IACtC,0CAA0C;IAC1C,GAAG,GAAG,GAAG;SACN,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC;SAChC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;SAClB,IAAI,EAAE,CAAC;IAEV,wCAAwC;IACxC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAEnC,8CAA8C;IAC9C,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3B,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAErD,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACzB,6BAA6B;QAC7B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAElD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}