@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/string/crop.js

@@ -0,0 +1,107 @@
+import countLineChars from './countLineChars.js';
+export default function crop(text, length, settings = {}) {
+    var _a, _b, _c, _d, _e;
+    settings = Object.assign({ chars: '...', splitWords: false }, settings);
+    text = text.replace(/\s/gm, '¯');
+    // split the text on spaces or every characters if the splitWords settings is to true
+    const splitReg = /(<([^>]+)>|\S|\s)/gm;
+    const parts = text
+        .split(splitReg)
+        .filter((c) => {
+        return (c !== undefined &&
+            c !== ' ' &&
+            c !== '' &&
+            (c.length === 1 || c.match(/^</)));
+    })
+        .map((c) => {
+        if (c === '¯')
+            return ' ';
+        return c;
+    });
+    // init the result text
+    let result = '';
+    let currentWord = '';
+    let currentLength = 0;
+    const openedHtmlTagsArray = [];
+    for (let i = 0; i < parts.length; i++) {
+        const c = parts[i];
+        if (c.length === 1) {
+            if (settings.splitWords) {
+                // @ts-ignore
+                if (currentLength + 1 + settings.chars.length <= length) {
+                    result += c;
+                    currentLength += 1;
+                }
+                else {
+                    result += settings.chars;
+                    // @ts-ignore
+                    currentLength += settings.chars.length;
+                    break;
+                }
+            }
+            else {
+                if (c !== ' ') {
+                    currentWord += c;
+                }
+                else {
+                    if (countLineChars(result) +
+                        countLineChars(currentWord) +
+                        // @ts-ignore
+                        countLineChars(settings.chars) <=
+                        length) {
+                        result += currentWord;
+                    }
+                    else {
+                        result = result.trim();
+                        result += settings.chars;
+                        break; // stop the loop execution...
+                    }
+                    // add the space
+                    result += ' ';
+                    // reset currentWord
+                    currentWord = '';
+                }
+            }
+            // if it's not a character of 1 letter
+            // meaning that it's surely an html tag
+        }
+        else {
+            if (currentWord !== '') {
+                result += currentWord;
+                currentWord = '';
+            }
+            // preparing the match regexp
+            const closingHtmlTagMatch = c.match(/^<\//);
+            const openingHtmlTagMatch = c.match(/^<[a-zA-Z]+.*>$/);
+            const singleHtmlTagMatch = c.match(/^<[a-zA-Z]+.*\/>$/);
+            // if it's a closing html tag
+            if (singleHtmlTagMatch) {
+                // we just add the single tag in the result
+                result += singleHtmlTagMatch.input;
+            }
+            else if (closingHtmlTagMatch) {
+                const tagName = (_b = (_a = closingHtmlTagMatch === null || closingHtmlTagMatch === void 0 ? void 0 : closingHtmlTagMatch.input) === null || _a === void 0 ? void 0 : _a.match(/^<\/(.*)>$/)) === null || _b === void 0 ? void 0 : _b[1];
+                // check if this tag has been opened
+                if (tagName && openedHtmlTagsArray.indexOf(tagName) !== -1) {
+                    // the tag has been opened so we add it to the close
+                    result += closingHtmlTagMatch.input;
+                    // remove the tag from the opened array
+                    openedHtmlTagsArray.splice(openedHtmlTagsArray.indexOf(tagName), 1);
+                }
+            }
+            else if (openingHtmlTagMatch) {
+                const tagName = (_e = (_d = (_c = openingHtmlTagMatch === null || openingHtmlTagMatch === void 0 ? void 0 : openingHtmlTagMatch.input) === null || _c === void 0 ? void 0 : _c.match) === null || _d === void 0 ? void 0 : _d.call(_c, /^<([a-zA-Z]+).*>$/)) === null || _e === void 0 ? void 0 : _e[1];
+                // add the tag in the result
+                result += openingHtmlTagMatch.input;
+                // add the tag to the openedTagArray
+                tagName && openedHtmlTagsArray.push(tagName);
+            }
+        }
+    }
+    // if we take care of html, make sure the opened tags are closed
+    openedHtmlTagsArray.forEach((tag) => {
+        result += `</${tag}>`;
+    });
+    return result;
+}
+//# sourceMappingURL=crop.js.map

package/dist/shared/string/crop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crop.js","sourceRoot":"","sources":["../../../src/shared/string/crop.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAuCjD,MAAM,CAAC,OAAO,UAAU,IAAI,CAC1B,IAAY,EACZ,MAAc,EACd,WAA0B,EAAE;;IAE5B,QAAQ,mBACN,KAAK,EAAE,KAAK,EACZ,UAAU,EAAE,KAAK,IACd,QAAQ,CACZ,CAAC;IAEF,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEjC,qFAAqF;IACrF,MAAM,QAAQ,GAAG,qBAAqB,CAAC;IACvC,MAAM,KAAK,GAAG,IAAI;SACf,KAAK,CAAC,QAAQ,CAAC;SACf,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACZ,OAAO,CACL,CAAC,KAAK,SAAS;YACf,CAAC,KAAK,GAAG;YACT,CAAC,KAAK,EAAE;YACR,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAClC,CAAC;IACJ,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,IAAI,CAAC,KAAK,GAAG;YAAE,OAAO,GAAG,CAAC;QAC1B,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;IAEL,uBAAuB;IACvB,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,MAAM,mBAAmB,GAAa,EAAE,CAAC;IAEzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEnB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnB,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACxB,aAAa;gBACb,IAAI,aAAa,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;oBACxD,MAAM,IAAI,CAAC,CAAC;oBACZ,aAAa,IAAI,CAAC,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,QAAQ,CAAC,KAAK,CAAC;oBACzB,aAAa;oBACb,aAAa,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;oBACvC,MAAM;gBACR,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;oBACd,WAAW,IAAI,CAAC,CAAC;gBACnB,CAAC;qBAAM,CAAC;oBACN,IACE,cAAc,CAAC,MAAM,CAAC;wBACpB,cAAc,CAAC,WAAW,CAAC;wBAC3B,aAAa;wBACb,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC;wBAChC,MAAM,EACN,CAAC;wBACD,MAAM,IAAI,WAAW,CAAC;oBACxB,CAAC;yBAAM,CAAC;wBACN,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;wBACvB,MAAM,IAAI,QAAQ,CAAC,KAAK,CAAC;wBACzB,MAAM,CAAC,6BAA6B;oBACtC,CAAC;oBAED,gBAAgB;oBAChB,MAAM,IAAI,GAAG,CAAC;oBAEd,oBAAoB;oBACpB,WAAW,GAAG,EAAE,CAAC;gBACnB,CAAC;YACH,CAAC;YAED,sCAAsC;YACtC,uCAAuC;QACzC,CAAC;aAAM,CAAC;YACN,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;gBACvB,MAAM,IAAI,WAAW,CAAC;gBACtB,WAAW,GAAG,EAAE,CAAC;YACnB,CAAC;YAED,6BAA6B;YAC7B,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC5C,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACvD,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;YAExD,6BAA6B;YAC7B,IAAI,kBAAkB,EAAE,CAAC;gBACvB,2CAA2C;gBAC3C,MAAM,IAAI,kBAAkB,CAAC,KAAK,CAAC;YACrC,CAAC;iBAAM,IAAI,mBAAmB,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAG,MAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,KAAK,0CAAE,KAAK,CAAC,YAAY,CAAC,0CAAG,CAAC,CAAC,CAAC;gBACrE,oCAAoC;gBACpC,IAAI,OAAO,IAAI,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;oBAC3D,oDAAoD;oBACpD,MAAM,IAAI,mBAAmB,CAAC,KAAK,CAAC;oBACpC,uCAAuC;oBACvC,mBAAmB,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;gBACtE,CAAC;YACH,CAAC;iBAAM,IAAI,mBAAmB,EAAE,CAAC;gBAC/B,MAAM,OAAO,GACX,MAAA,MAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,KAAK,0CAAE,KAAK,mDAAG,mBAAmB,CAAC,0CAAG,CAAC,CAAC,CAAC;gBAChE,4BAA4B;gBAC5B,MAAM,IAAI,mBAAmB,CAAC,KAAK,CAAC;gBACpC,oCAAoC;gBACpC,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAED,gEAAgE;IAChE,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,MAAM,IAAI,KAAK,GAAG,GAAG,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/string/dashCase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                dashCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Dash case a string
+ *
+ * @param         {String}          text        The string to dashCase
+ * @return        {String}                      The dashCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         dashCase($1)
+ *
+ * @example     js
+ * import { dashCase } from '@blackbyte/sugar/string';
+ * dashCase('hello world'); // => hello-world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __dashCase(text: string): string;

package/dist/shared/string/dashCase.js

@@ -0,0 +1,30 @@
+import { kebabCase } from 'change-case';
+/**
+ * @name                dashCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Dash case a string
+ *
+ * @param         {String}          text        The string to dashCase
+ * @return        {String}                      The dashCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         dashCase($1)
+ *
+ * @example     js
+ * import { dashCase } from '@blackbyte/sugar/string';
+ * dashCase('hello world'); // => hello-world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __dashCase(text) {
+    return kebabCase(text);
+}
+//# sourceMappingURL=dashCase.js.map

package/dist/shared/string/dashCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashCase.js","sourceRoot":"","sources":["../../../src/shared/string/dashCase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,IAAY;IAC7C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}

package/dist/shared/string/dotCase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                dotCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         dotCase($1)
+ *
+ * @example     js
+ * import { dotCase } from '@blackbyte/sugar/string';
+ * dotCase('hello world'); // => hello.world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __dotCase(text: string): string;

package/dist/shared/string/dotCase.js

@@ -0,0 +1,30 @@
+import { dotCase } from 'change-case';
+/**
+ * @name                dotCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         dotCase($1)
+ *
+ * @example     js
+ * import { dotCase } from '@blackbyte/sugar/string';
+ * dotCase('hello world'); // => hello.world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __dotCase(text) {
+    return dotCase(text);
+}
+//# sourceMappingURL=dotCase.js.map

package/dist/shared/string/dotCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dotCase.js","sourceRoot":"","sources":["../../../src/shared/string/dotCase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,IAAY;IAC5C,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC"}

package/dist/shared/string/escapeRegexChars.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @name                escapeRegexChars
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Escape regex special characters from a string
+ *
+ * @param         {String}          str        The string to escape regex characters from
+ * @return        {String}                      The escaped string
+ *
+ * @todo      tests
+ *
+ * @snippet         escapeRegexChars($1)
+ *
+ * @example     js
+ * import { escapeRegexChars } from '@blackbyte/sugar/string';
+ * escapeRegexChars('/hello()'); // => \/hello\(\)
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function escapeRegexChars(str: string): string;

package/dist/shared/string/escapeRegexChars.js

@@ -0,0 +1,28 @@
+/**
+ * @name                escapeRegexChars
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Escape regex special characters from a string
+ *
+ * @param         {String}          str        The string to escape regex characters from
+ * @return        {String}                      The escaped string
+ *
+ * @todo      tests
+ *
+ * @snippet         escapeRegexChars($1)
+ *
+ * @example     js
+ * import { escapeRegexChars } from '@blackbyte/sugar/string';
+ * escapeRegexChars('/hello()'); // => \/hello\(\)
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function escapeRegexChars(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+//# sourceMappingURL=escapeRegexChars.js.map

package/dist/shared/string/escapeRegexChars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"escapeRegexChars.js","sourceRoot":"","sources":["../../../src/shared/string/escapeRegexChars.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,GAAW;IAClD,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC"}

package/dist/shared/string/extractSame.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @name                    extractSame
+ * @namespace               shared.string
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * This function return you what has been find the same in the two passed string.
+ * It will return you either an array of same string parts or a simple string
+ * representing the first same part found.
+ *
+ * @param         {String}            string1         The string 1 to compare
+ * @param         {String}            string2         The string 2 to compare
+ * @param         {Boolean}           [multiple=false]      Specify if you want to get back multiple same string if exists as an array
+ * @return      {String|Array}                      The same string part(s) found
+ *
+ * @todo      tests
+ *
+ * @snippet             extractSame($1)
+ *
+ * @example       js
+ * import { extractSame } from '@blackbyte/sugar/string';
+ * extractSame('Hello world', 'Hello plop'); // => 'Hello '
+ *
+ * @since       1.0.0
+ * @author 	Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function extractSame(string1: string, string2: string, multiple?: boolean): string[];

package/dist/shared/string/extractSame.js

@@ -0,0 +1,52 @@
+/**
+ * @name                    extractSame
+ * @namespace               shared.string
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * This function return you what has been find the same in the two passed string.
+ * It will return you either an array of same string parts or a simple string
+ * representing the first same part found.
+ *
+ * @param         {String}            string1         The string 1 to compare
+ * @param         {String}            string2         The string 2 to compare
+ * @param         {Boolean}           [multiple=false]      Specify if you want to get back multiple same string if exists as an array
+ * @return      {String|Array}                      The same string part(s) found
+ *
+ * @todo      tests
+ *
+ * @snippet             extractSame($1)
+ *
+ * @example       js
+ * import { extractSame } from '@blackbyte/sugar/string';
+ * extractSame('Hello world', 'Hello plop'); // => 'Hello '
+ *
+ * @since       1.0.0
+ * @author 	Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function extractSame(string1, string2, multiple = false) {
+    // compare letter by letter
+    const extractedArray = [''];
+    const chars = string1.split('');
+    const chars2 = string2.split('');
+    for (let i = 0; i < chars.length; i++) {
+        const char = chars[i];
+        const char2 = chars2[i];
+        if (i > chars2.length - 1)
+            break;
+        if (char === char2) {
+            extractedArray[extractedArray.length - 1] += char;
+        }
+        else if (multiple) {
+            if (extractedArray[extractedArray.length - 1] !== '')
+                extractedArray.push('');
+        }
+        else {
+            break;
+        }
+    }
+    return extractedArray;
+}
+//# sourceMappingURL=extractSame.js.map

package/dist/shared/string/extractSame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractSame.js","sourceRoot":"","sources":["../../../src/shared/string/extractSame.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,OAAe,EACf,OAAe,EACf,WAAoB,KAAK;IAEzB,2BAA2B;IAC3B,MAAM,cAAc,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM;QACjC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;QACpD,CAAC;aAAM,IAAI,QAAQ,EAAE,CAAC;YACpB,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE;gBAClD,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC"}

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

@@ -0,0 +1,38 @@
+import { format } from 'fecha';
+/**
+ * @name                format
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Format the passed string using the requested format. Available formats are:
+ * - isoDate
+ * - isoDateTime
+ * - isoTime
+ * - integer
+ * - number
+ * - alphanum
+ * - hex
+ * - hexa
+ * - creditCard
+ *
+ * @param       {String}    string    The string to format
+ * @param       {String}        format      The format to use
+ * @return      {String}    The formatted value
+ *
+ * @todo      tests
+ *
+ * @snippet         format($1, $2)
+ *
+ * @example    js
+ * import { format } from '@blackbyte/sugar/string'
+ *
+ * @see       https://www.npmjs.com/package/fecha
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFormat = 'isoDate' | 'isoDateTime' | 'isoTime' | 'integer' | 'number' | 'alphanum' | 'hex' | 'hexa' | 'creditCard';
+declare function format(string: string, format: TFormat): string;
+export default format;

package/dist/shared/string/format.js

@@ -0,0 +1,140 @@
+function format(string, format) {
+    var _a;
+    let schema = [];
+    switch (format) {
+        case 'isoDate':
+            schema = [
+                '\\d',
+                '\\d',
+                '\\d',
+                '\\d',
+                '-',
+                '\\d',
+                '\\d',
+                '-',
+                '\\d',
+                '\\d',
+            ];
+            break;
+        case 'isoDateTime':
+            schema = [
+                '\\d',
+                '\\d',
+                '\\d',
+                '\\d',
+                '-',
+                '\\d',
+                '\\d',
+                '-',
+                '\\d',
+                '\\d',
+                ' ',
+                '\\d',
+                '\\d',
+                ':',
+                '\\d',
+                '\\d',
+                ':',
+                '\\d',
+                '\\d',
+            ];
+            break;
+        case 'isoTime':
+            schema = ['\\d', '\\d', ':', '\\d', '\\d', ':', '\\d', '\\d'];
+            break;
+        case 'hex':
+            schema = ['#', '\\w', '\\w', '\\w', '\\w', '\\w', '\\w'];
+            break;
+        case 'hexa':
+            schema = ['#', '\\w', '\\w', '\\w', '\\w', '\\w', '\\w', '\\w', '\\w'];
+            break;
+        case 'integer':
+            return string.replace(/^[0-9]+$/i, '');
+            break;
+        case 'number':
+            return string.replace(/^[0-9\.]+$/i, '');
+            break;
+        case 'alphanum':
+            return string.replace(/^[a-z0-9]+$/i, '');
+            break;
+        case 'creditCard':
+            schema = [
+                '\\d',
+                '\\d',
+                '\\d',
+                '\\d',
+                ' ',
+                '\\d',
+                '\\d',
+                '\\d',
+                '\\d',
+                ' ',
+                '\\d',
+                '\\d',
+                '\\d',
+                '\\d',
+                ' ',
+                '\\d',
+                '\\d',
+                '\\d',
+                '\\d',
+            ];
+            break;
+        default:
+            return string;
+            break;
+    }
+    let newValue = '';
+    const loopOn = string.length > schema.length ? string : schema;
+    let schemaCharI = 0;
+    for (let i = 0; i < loopOn.length; i++) {
+        const schemaChar = schema[schemaCharI], char = (_a = string[i]) !== null && _a !== void 0 ? _a : '';
+        // end of characters
+        if (!schemaChar || !char || i >= string.length) {
+            break;
+        }
+        if (schemaChar === char) {
+            newValue += char;
+            schemaCharI++;
+        }
+        else if (schemaChar.match(/^\\d/)) {
+            if (char.match(/^\d$/)) {
+                newValue += char;
+                schemaCharI++;
+            }
+            else {
+                // schemaCharI++;
+            }
+        }
+        else if (schemaChar.match(/^\\w/)) {
+            if (char.match(/^\w$/)) {
+                newValue += char;
+                schemaCharI++;
+            }
+            else {
+                // schemaCharI++;
+            }
+        }
+        else if (schemaChar !== char) {
+            newValue += schemaChar;
+            i--;
+            schemaCharI++;
+        }
+        else {
+        }
+    }
+    return newValue;
+}
+format.formats = [
+    'isoDate',
+    'isoDateTime',
+    'isoTime',
+    'integer',
+    'number',
+    'alphanum',
+    'hex',
+    'hexa',
+    'creditCard',
+];
+export default format;
+//# sourceMappingURL=format.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/shared/string/format.ts"],"names":[],"mappings":"AAgDA,SAAS,MAAM,CAAC,MAAc,EAAE,MAAe;;IAC7C,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,SAAS;YACZ,MAAM,GAAG;gBACP,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;aACN,CAAC;YACF,MAAM;QACR,KAAK,aAAa;YAChB,MAAM,GAAG;gBACP,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;aACN,CAAC;YACF,MAAM;QACR,KAAK,SAAS;YACZ,MAAM,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YAC9D,MAAM;QACR,KAAK,KAAK;YACR,MAAM,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACzD,MAAM;QACR,KAAK,MAAM;YACT,MAAM,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACvE,MAAM;QACR,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACvC,MAAM;QACR,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YACzC,MAAM;QACR,KAAK,UAAU;YACb,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAC1C,MAAM;QACR,KAAK,YAAY;YACf,MAAM,GAAG;gBACP,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,KAAK;gBACL,KAAK;aACN,CAAC;YACF,MAAM;QACR;YACE,OAAO,MAAM,CAAC;YACd,MAAM;IACV,CAAC;IAED,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;IAE/D,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,EACpC,IAAI,GAAG,MAAA,MAAM,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;QAEzB,oBAAoB;QACpB,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAC/C,MAAM;QACR,CAAC;QAED,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,QAAQ,IAAI,IAAI,CAAC;YACjB,WAAW,EAAE,CAAC;QAChB,CAAC;aAAM,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvB,QAAQ,IAAI,IAAI,CAAC;gBACjB,WAAW,EAAE,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,iBAAiB;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvB,QAAQ,IAAI,IAAI,CAAC;gBACjB,WAAW,EAAE,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,iBAAiB;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YAC/B,QAAQ,IAAI,UAAU,CAAC;YACvB,CAAC,EAAE,CAAC;YACJ,WAAW,EAAE,CAAC;QAChB,CAAC;aAAM,CAAC;QACR,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AACD,MAAM,CAAC,OAAO,GAAG;IACf,SAAS;IACT,aAAa;IACb,SAAS;IACT,SAAS;IACT,QAAQ;IACR,UAAU;IACV,KAAK;IACL,MAAM;IACN,YAAY;CACb,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/shared/string/highlightText.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name            highlightText
+ * @namespace       shared.string
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to highlight some text in a string or in an HTMLElement
+ *
+ * @param      {String|HTMLElement}          ctx         The string or HTMLElement in which to highlight the text
+ * @param      {String|String[]|RegExp}      search      The text to highlight
+ * @return      {String|HTMLElement}                    The processed string or HTMLElement
+ *
+ * @snippet         highlightText($1, $2)
+ *
+ * @todo      tests
+ *
+ * @example         php
+ * import { highlightText } from '@blackbyte/sugar/string';
+ * highlightText('Hello world', 'llo'); // => He<span class="-highlight">llo</span> world
+ *
+ * @see         https://markjs.io
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type THighlightTextSettings = {
+    class: string;
+};
+export default function highlightText<T>(ctx: T, search: string | string[] | typeof RegExp, settings?: Partial<THighlightTextSettings>): T;

package/dist/shared/string/highlightText.js

@@ -0,0 +1,28 @@
+import Mark from 'mark.js';
+export default function highlightText(ctx, search, settings) {
+    const finalSettings = Object.assign({ class: '-highlight' }, (settings !== null && settings !== void 0 ? settings : {}));
+    let resType, internalCtx;
+    if (typeof ctx === 'string') {
+        internalCtx = document.createElement('div');
+        internalCtx.innerHTML = ctx;
+        resType = 'string';
+    }
+    else if (ctx instanceof HTMLElement) {
+        internalCtx = ctx;
+        resType = 'element';
+    }
+    const mark = new Mark(internalCtx), markOptions = {
+        className: finalSettings.class,
+    };
+    if (search instanceof RegExp) {
+        mark.markRegExp(search, markOptions);
+    }
+    else if (Array.isArray(search) || typeof search === 'string') {
+        mark.mark(search, markOptions);
+    }
+    if (resType === 'string') {
+        return internalCtx.innerHTML;
+    }
+    return internalCtx;
+}
+//# sourceMappingURL=highlightText.js.map

package/dist/shared/string/highlightText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlightText.js","sourceRoot":"","sources":["../../../src/shared/string/highlightText.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,SAAS,CAAC;AAiC3B,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,GAAM,EACN,MAAyC,EACzC,QAA0C;IAE1C,MAAM,aAAa,mBACjB,KAAK,EAAE,YAAY,IAChB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IACF,IAAI,OAAO,EAAE,WAAW,CAAC;IAEzB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5C,WAAW,CAAC,SAAS,GAAG,GAAG,CAAC;QAC5B,OAAO,GAAG,QAAQ,CAAC;IACrB,CAAC;SAAM,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;QACtC,WAAW,GAAG,GAAG,CAAC;QAClB,OAAO,GAAG,SAAS,CAAC;IACtB,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,EAChC,WAAW,GAAG;QACZ,SAAS,EAAE,aAAa,CAAC,KAAK;KAC/B,CAAC;IAEJ,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC7B,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/D,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACzB,OAAO,WAAW,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/shared/string/idCompliant.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name            idCompliant
+ * @namespace       shared.string
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This function take a string and return a version of it that you can safely use
+ * in html id for example. It replace spaces with '-' as well as all the special characters
+ * with their simple version like "à" will be replaces by "a"
+ *
+ * @param       {String}        string         The string to process
+ * @return      {String}                        The processed string
+ *
+ * @snippet         idCompliant($1)
+ *
+ * @todo      tests
+ *
+ * @example         php
+ * import { idCompliant } from '@blackbyte/sugar/string';
+ * idCompliant('Hello world'); // => hello-world
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TIdCompliantSettings = {
+    exclude: string[];
+};
+export default function idCompliant(str: string, settings?: TIdCompliantSettings): string;