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

package/dist/shared/string/extractSame/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/extractSame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractSame.js","sourceRoot":"","sources":["../../../../src/shared/string/extractSame/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/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/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/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../../src/shared/string/format/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/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/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/highlightText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlightText.js","sourceRoot":"","sources":["../../../../src/shared/string/highlightText/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/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;

package/dist/shared/string/idCompliant/idCompliant.js

@@ -0,0 +1,55 @@
+import simplifySpecialChars from '../simplifySpecialChars/simplifySpecialChars.js';
+export default function idCompliant(str, settings) {
+    settings = Object.assign({ exclude: [] }, (settings !== null && settings !== void 0 ? settings : {}));
+    // spaces
+    str = str.replace(/\s/gm, '-');
+    // special characters
+    str = simplifySpecialChars(str);
+    // replace characters like /, etc...
+    const dict = {
+        '/': '-',
+        '@': '',
+        '.': '-',
+        ',': '-',
+        '\\': '-',
+        '(': '-',
+        ')': '-',
+        '{': '-',
+        '}': '-',
+        '[': '-',
+        ']': '-',
+        '=': '-',
+        '?': '-',
+        '!': '-',
+        '&': '-',
+        '%': '-',
+        '*': '-',
+        '"': '-',
+        "'": '-',
+        '`': '-',
+        '+': '-',
+        '°': '-',
+        $: '-',
+        '<': '-',
+        '>': '-',
+        ':': '-',
+        '#': '-',
+    };
+    settings.exclude.forEach((char) => {
+        delete dict[char];
+    });
+    Object.keys(dict).forEach((char) => {
+        str = str.split(char).join(dict[char]);
+    });
+    // first and last characters + multiple ---
+    str = str.replace(/\.{2,999}/gm, '.');
+    str = str.replace(/^-{1,999}/gm, '');
+    str = str.replace(/-{1,999}$/gm, '');
+    str = str.replace(/-{2,999}/gm, '-');
+    str = str.replace(/[^a-zA-Z0-9]{1,999}$/, '');
+    str = str.replace(/^[^a-zA-Z0-9]{1,999}/, '');
+    // lowercase
+    str = str.toLowerCase();
+    return str;
+}
+//# sourceMappingURL=idCompliant.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"idCompliant.js","sourceRoot":"","sources":["../../../../src/shared/string/idCompliant/idCompliant.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,MAAM,iDAAiD,CAAC;AAiCnF,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,GAAW,EACX,QAA+B;IAE/B,QAAQ,mBACN,OAAO,EAAE,EAAE,IACR,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,SAAS;IACT,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,qBAAqB;IACrB,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAChC,oCAAoC;IACpC,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,IAAI,EAAE,GAAG;QACT,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,CAAC,EAAE,GAAG;QACN,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;KACT,CAAC;IAEF,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,2CAA2C;IAC3C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;IACtC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACrC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACrC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IACrC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAC9C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAC9C,YAAY;IACZ,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;IAExB,OAAO,GAAG,CAAC;AACb,CAAC"}

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

@@ -0,0 +1,26 @@
+/**
+ * @name                kebabCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Kebab case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         kebabCase($1)
+ *
+ * @example     js
+ * import { kebabCase } from '@blackbyte/sugar/string';
+ * kebabCase('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 __kebabCase(text: string): string;

package/dist/shared/string/kebabCase/kebabCase.js

@@ -0,0 +1,30 @@
+import { kebabCase } from 'change-case';
+/**
+ * @name                kebabCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Kebab case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         kebabCase($1)
+ *
+ * @example     js
+ * import { kebabCase } from '@blackbyte/sugar/string';
+ * kebabCase('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 __kebabCase(text) {
+    return kebabCase(text);
+}
+//# sourceMappingURL=kebabCase.js.map

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

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

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

@@ -0,0 +1,25 @@
+/**
+ * @name                lowerFirst
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Lower first letter
+ *
+ * @param    {String}    string    The string to lower the first letter
+ * @return    {String}    The string with the first letter lowered
+ *
+ * @todo      tests
+ *
+ * @snippet         lowerFirst($1)
+ *
+ * @example    js
+ * import { lowerFirst } from '@blackbyte/sugar/string'
+ * lowerFirst('Hello world') // hello world
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function lowerFirst(string: string): string;

package/dist/shared/string/lowerFirst/lowerFirst.js

@@ -0,0 +1,28 @@
+/**
+ * @name                lowerFirst
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Lower first letter
+ *
+ * @param    {String}    string    The string to lower the first letter
+ * @return    {String}    The string with the first letter lowered
+ *
+ * @todo      tests
+ *
+ * @snippet         lowerFirst($1)
+ *
+ * @example    js
+ * import { lowerFirst } from '@blackbyte/sugar/string'
+ * lowerFirst('Hello world') // hello world
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function lowerFirst(string) {
+    return string.charAt(0).toLowerCase() + string.slice(1);
+}
+//# sourceMappingURL=lowerFirst.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lowerFirst.js","sourceRoot":"","sources":["../../../../src/shared/string/lowerFirst/lowerFirst.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,MAAc;IAC/C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC"}

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

@@ -0,0 +1,27 @@
+/**
+ * @name                ltrim
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Trim left a specified string
+ *
+ * @param    {String}    string    The string to trim
+ * @param    {String}    needle    The string to find an cut out if found
+ * @param    {Boolean}  [trimResult=true]       If you want to trim the resulted ltrim
+ * @return    {String}    The trimed string
+ *
+ * @todo      tests
+ *
+ * @snippet         ltrim($1, $2)
+ *
+ * @example    js
+ * import { ltrim } from '@blackbyte/sugar/string'
+ *  ltrim('Hello World', 'Hello') // World
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function ltrim(string: string, needle: string, trimResult?: boolean): string;

package/dist/shared/string/ltrim/ltrim.js

@@ -0,0 +1,36 @@
+/**
+ * @name                ltrim
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Trim left a specified string
+ *
+ * @param    {String}    string    The string to trim
+ * @param    {String}    needle    The string to find an cut out if found
+ * @param    {Boolean}  [trimResult=true]       If you want to trim the resulted ltrim
+ * @return    {String}    The trimed string
+ *
+ * @todo      tests
+ *
+ * @snippet         ltrim($1, $2)
+ *
+ * @example    js
+ * import { ltrim } from '@blackbyte/sugar/string'
+ *  ltrim('Hello World', 'Hello') // World
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function ltrim(string, needle, trimResult = true) {
+    if (string.substr(0, needle.length) === needle) {
+        return trimResult
+            ? string.substr(needle.length).trim()
+            : string.substr(needle.length);
+    }
+    // nothing to trim
+    return string;
+}
+//# sourceMappingURL=ltrim.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ltrim.js","sourceRoot":"","sources":["../../../../src/shared/string/ltrim/ltrim.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAC3B,MAAc,EACd,MAAc,EACd,aAAsB,IAAI;IAE1B,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,MAAM,EAAE,CAAC;QAC/C,OAAO,UAAU;YACf,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE;YACrC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,kBAAkB;IAClB,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,29 @@
+/**
+ * @name                namespaceCompliant
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              beta
+ *
+ * This function take a string and return a version of it that you can safely use
+ * as a namespace with just dots and non special characters.
+ *
+ * @param       {String}        string         The string to process
+ * @return      {String}                        The processed string
+ *
+ * @snippet         namespaceCompliant($1)
+ *
+ * @todo     tests
+ *
+ * @example         php
+ * import { namespaceCompliant } from '@blackbyte/sugar/string';
+ * namespaceCompliant('Hello world'); // => hello-world
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TNamespaceCompliantSettings = {
+    exclude: string[];
+};
+export default function namespaceCompliant(str: string, settings?: TNamespaceCompliantSettings): string;