@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/string/trimLines.js

@@ -0,0 +1,55 @@
+/**
+ * @name                trimLines
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function take a string and trim each lines
+ *
+ * @param       {String}        string        The string to trim lines of
+ * @param       {Object}        [settings={}]     An object settings. Here's the object properties:
+ * @return     {String}                      The processed string
+ *
+ * @setting      {Number}       [leftPadding=0]       Specify a left padding to set. 1 padding represent 1 space character
+ * @setting      {Number}       [rightPadding=0]      Specify a right padding to set.
+ * @setting      {Boolean}      [keepEmptyLines=true]      Specify if you want to keep empty lines or not
+ *
+ * @todo      tests
+ *
+ * @snippet         trimLines($1)
+ *
+ * @example         js
+ * import { trimLines } from '@blackbyte/sugar/string';
+ * trimLines(`my cool lines
+ *      that have some lines to trim
+ * and some not...`);
+ * // my cool lines
+ * // that have some lines to trim
+ * // and some not...
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function trimLines(string, settings = {}) {
+    settings = Object.assign({ leftPadding: 0, rightPadding: 0, keepEmptyLines: true }, settings);
+    string = string
+        .split('\n')
+        .map((line) => {
+        line = line.trim();
+        if (!settings.keepEmptyLines) {
+            if (line === '')
+                return -1;
+        }
+        if (settings.leftPadding)
+            line = `${' '.repeat(settings.leftPadding)}${line}`;
+        if (settings.rightPadding)
+            line = `${line}${' '.repeat(settings.rightPadding)}`;
+        return line;
+    })
+        .filter((line) => line !== -1)
+        .join('\n');
+    return string;
+}
+//# sourceMappingURL=trimLines.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trimLines.js","sourceRoot":"","sources":["../../../src/shared/string/trimLines.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAQH,MAAM,CAAC,OAAO,UAAU,SAAS,CAC/B,MAAc,EACd,WAA+B,EAAE;IAEjC,QAAQ,mBACN,WAAW,EAAE,CAAC,EACd,YAAY,EAAE,CAAC,EACf,cAAc,EAAE,IAAI,IACjB,QAAQ,CACZ,CAAC;IAEF,MAAM,GAAG,MAAM;SACZ,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC7B,IAAI,IAAI,KAAK,EAAE;gBAAE,OAAO,CAAC,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,QAAQ,CAAC,WAAW;YACtB,IAAI,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,EAAE,CAAC;QACtD,IAAI,QAAQ,CAAC,YAAY;YACvB,IAAI,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;SAC7B,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,32 @@
+/**
+ * @name            truncate
+ * @namespace       shared.string
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * Truncate a string to a specific length and add an ellipsis at the end
+ *
+ * @param       {String}        str         The string to truncate
+ * @param       {Number}        length      The length to truncate to
+ * @param       {Partial<TTruncateSettings>}      [settings={}]       Some settings to configure your truncate process
+ * @return     {String}                    The truncated string
+ *
+ * @setting     {String}        [ellipsis='...']       The ellipsis to add at the end of the truncated string
+ *
+ * @todo      tests
+ *
+ * @snippet         truncate($1, $2, $3)
+ *
+ * @example    js
+ * import truncate from '@blackbyte/sugar/string';
+ * truncate('Hello world', 5); // => Hello...
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TTruncateSettings = {
+    ellipsis: string;
+};
+export default function truncate(str: string, length: number, settings?: Partial<TTruncateSettings>): string;

package/dist/shared/string/truncate.js

@@ -0,0 +1,36 @@
+/**
+ * @name            truncate
+ * @namespace       shared.string
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * Truncate a string to a specific length and add an ellipsis at the end
+ *
+ * @param       {String}        str         The string to truncate
+ * @param       {Number}        length      The length to truncate to
+ * @param       {Partial<TTruncateSettings>}      [settings={}]       Some settings to configure your truncate process
+ * @return     {String}                    The truncated string
+ *
+ * @setting     {String}        [ellipsis='...']       The ellipsis to add at the end of the truncated string
+ *
+ * @todo      tests
+ *
+ * @snippet         truncate($1, $2, $3)
+ *
+ * @example    js
+ * import truncate from '@blackbyte/sugar/string';
+ * truncate('Hello world', 5); // => Hello...
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function truncate(str, length, settings) {
+    const finalSettings = Object.assign({ ellipsis: '...' }, (settings !== null && settings !== void 0 ? settings : {}));
+    if (str.length > length) {
+        return `${str.substring(0, length - finalSettings.ellipsis.length)}${finalSettings.ellipsis}`;
+    }
+    return str;
+}
+//# sourceMappingURL=truncate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"truncate.js","sourceRoot":"","sources":["../../../src/shared/string/truncate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAMH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,GAAW,EACX,MAAc,EACd,QAAqC;IAErC,MAAM,aAAa,mBACjB,QAAQ,EAAE,KAAK,IACZ,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IACF,IAAI,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,GAChE,aAAa,CAAC,QAChB,EAAE,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

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

@@ -0,0 +1,26 @@
+/**
+ * @name                uncamelize
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Uncamelize a string
+ *
+ * @param    {String}    string    The string to uncamelize
+ * @param    {String}    [separator='-']    The separator to use
+ * @return    {String}    The uncamelized string
+ *
+ * @todo      tests
+ *
+ * @snippet         uncamelize($1)
+ *
+ * @example    js
+ * import { uncamelize } from '@blackbyte/sugar/string'
+ * uncamelize('helloWorldAndUniverse') // hello-world-and-universe
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function uncamelize(text: string, separator?: string): string;

package/dist/shared/string/uncamelize.js

@@ -0,0 +1,37 @@
+/**
+ * @name                uncamelize
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Uncamelize a string
+ *
+ * @param    {String}    string    The string to uncamelize
+ * @param    {String}    [separator='-']    The separator to use
+ * @return    {String}    The uncamelized string
+ *
+ * @todo      tests
+ *
+ * @snippet         uncamelize($1)
+ *
+ * @example    js
+ * import { uncamelize } from '@blackbyte/sugar/string'
+ * uncamelize('helloWorldAndUniverse') // hello-world-and-universe
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function uncamelize(text, separator = '-') {
+    // Replace all capital letters by separator followed by lowercase one
+    let res = '';
+    res = text.replace(/[A-Z]/g, function (letter) {
+        return separator + letter.toLowerCase();
+    });
+    // Remove first separator (to avoid _hello_world name)
+    if (res.slice(0, 1) === separator)
+        res = res.slice(1);
+    return res;
+}
+//# sourceMappingURL=uncamelize.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"uncamelize.js","sourceRoot":"","sources":["../../../src/shared/string/uncamelize.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,IAAY,EACZ,YAAoB,GAAG;IAEvB,qEAAqE;IACrE,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,MAAM;QAC3C,OAAO,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,sDAAsD;IACtD,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS;QAAE,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEtD,OAAO,GAAG,CAAC;AACb,CAAC"}

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

@@ -0,0 +1,31 @@
+/**
+ * @name                unquote
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Remove the quotes of a string
+ * Types of quotes removed :
+ * - `"`, `'`, `”`, '`'
+ *
+ * @param    {String}    string    The string to process
+ * @param    {TUnquoteSettings}    [settings={}]    Some settings to configure your unquoting process
+ * @return    {String}    The unquoted string
+ *
+ * @todo      tests
+ *
+ * @snippet         unquote($1)
+ *
+ * @example    js
+ * import { unquote } from '@blackbyte/sugar/string'
+ * unquote("'Hello world'") // "Hello world"
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TUnquoteSettings = {
+    quotesToRemove: string[];
+};
+export default function unquote(string: string, settings?: Partial<TUnquoteSettings>): string;

package/dist/shared/string/unquote.js

@@ -0,0 +1,44 @@
+/**
+ * @name                unquote
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Remove the quotes of a string
+ * Types of quotes removed :
+ * - `"`, `'`, `”`, '`'
+ *
+ * @param    {String}    string    The string to process
+ * @param    {TUnquoteSettings}    [settings={}]    Some settings to configure your unquoting process
+ * @return    {String}    The unquoted string
+ *
+ * @todo      tests
+ *
+ * @snippet         unquote($1)
+ *
+ * @example    js
+ * import { unquote } from '@blackbyte/sugar/string'
+ * unquote("'Hello world'") // "Hello world"
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function unquote(string, settings) {
+    const finalSettings = Object.assign({ quotesToRemove: ['"', "'", '”', '`'] }, (settings !== null && settings !== void 0 ? settings : {}));
+    // trim the string just in case
+    string = string.trim();
+    // loop on each quotes to remove
+    finalSettings.quotesToRemove.forEach((quote) => {
+        if (string.substr(0, 1) === quote && string.substr(-1) === quote) {
+            string = string.substr(1);
+            string = string.substr(0, string.length - 1);
+            // break the loop to avoid unquoting multiple levels
+            return;
+        }
+    });
+    // return the processed string
+    return string;
+}
+//# sourceMappingURL=unquote.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"unquote.js","sourceRoot":"","sources":["../../../src/shared/string/unquote.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAMH,MAAM,CAAC,OAAO,UAAU,OAAO,CAC7B,MAAc,EACd,QAAoC;IAEpC,MAAM,aAAa,mBACjB,cAAc,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IACjC,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,+BAA+B;IAC/B,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,gCAAgC;IAChC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACjE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC7C,oDAAoD;YACpD,OAAO;QACT,CAAC;IACH,CAAC,CAAC,CAAC;IACH,8BAA8B;IAC9B,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

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

package/dist/shared/string/upperFirst.js

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

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

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

@@ -0,0 +1,30 @@
+/**
+ * @name            urlCompliant
+ * @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
+ * in url 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         urlCompliant($1)
+ *
+ * @todo        tests
+ *
+ * @example         php
+ * import { urlCompliant } from '@blackbyte/sugar/string';
+ * urlCompliant('Hello world'); // => hello-world
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TUrlCompliantSettings = {
+    exclude: string[];
+};
+export default function urlCompliant(str: string, settings?: TUrlCompliantSettings): string;

package/dist/shared/string/urlCompliant.js

@@ -0,0 +1,34 @@
+import __simplifySpecialChars from './simplifySpecialChars.js';
+export default function urlCompliant(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, '-');
+    // lowercase
+    str = str.toLowerCase();
+    return str;
+}
+//# sourceMappingURL=urlCompliant.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"urlCompliant.js","sourceRoot":"","sources":["../../../src/shared/string/urlCompliant.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,MAAM,2BAA2B,CAAC;AAgC/D,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,GAAW,EACX,QAAgC;IAEhC,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;IAE/B,qBAAqB;IACrB,GAAG,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;IAClC,oCAAoC;IACpC,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,GAAG;QACT,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,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;IAErC,YAAY;IACZ,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;IAExB,OAAO,GAAG,CAAC;AACb,CAAC"}

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

@@ -0,0 +1,3 @@
+import convert12To24 from './convert12To24.js';
+import convert24To12 from './convert24To12.js';
+export { convert12To24 as __convert12To24, convert24To12 as __convert24To12, convert12To24, convert24To12, };

package/dist/shared/time/_exports.js

@@ -0,0 +1,4 @@
+import convert12To24 from './convert12To24.js';
+import convert24To12 from './convert24To12.js';
+export { convert12To24 as __convert12To24, convert24To12 as __convert24To12, convert12To24, convert24To12, };
+//# sourceMappingURL=_exports.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/time/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EACL,aAAa,IAAI,eAAe,EAChC,aAAa,IAAI,eAAe,EAChC,aAAa,EACb,aAAa,GACd,CAAC"}

package/dist/shared/time/convert12To24.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @name                 convert12To24
+ * @namespace            shared.time
+ * @type                 Function
+ * @platform             js
+ * @platform             node
+ * @status               stable
+ *
+ * Convert a 12 hours time to a 24 hours time
+ *
+ * @param       {String|Number}        time        The 12 hours time to convert formatted like "12pm" or "12:30am"
+ * @return      {String}                    The 24 hours time like "23:00"
+ *
+ * @todo      tests
+ *
+ * @snippet         convert12To24($1)
+ *
+ * @example    js
+ * import { convert12To24 } from '@blackbyte/sugar/time'
+ * convert12To24('12pm') // => '12:00'
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function convert12To24(time: string): string;

package/dist/shared/time/convert12To24.js

@@ -0,0 +1,43 @@
+import { pad } from '@blackbyte/sugar/number';
+/**
+ * @name                 convert12To24
+ * @namespace            shared.time
+ * @type                 Function
+ * @platform             js
+ * @platform             node
+ * @status               stable
+ *
+ * Convert a 12 hours time to a 24 hours time
+ *
+ * @param       {String|Number}        time        The 12 hours time to convert formatted like "12pm" or "12:30am"
+ * @return      {String}                    The 24 hours time like "23:00"
+ *
+ * @todo      tests
+ *
+ * @snippet         convert12To24($1)
+ *
+ * @example    js
+ * import { convert12To24 } from '@blackbyte/sugar/time'
+ * convert12To24('12pm') // => '12:00'
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function convert12To24(time) {
+    var _a;
+    if (typeof time !== 'string' ||
+        !time.match(/^[01]?[0-9]\:?([012345][0-9])?(am|pm)$/)) {
+        throw new Error('[convert12To24] Invalid time format. Must be a string like "12pm" or "12:30am"');
+    }
+    const suffix = (_a = time.match(/(am|pm)/g)) === null || _a === void 0 ? void 0 : _a[0];
+    const [hours, minutes] = time.replace(suffix, '').split(':');
+    let finalHours, finalMinutes = parseInt(minutes) || 0;
+    if (suffix === 'pm') {
+        finalHours = parseInt(hours) + 12;
+    }
+    else {
+        finalHours = parseInt(hours);
+    }
+    return `${pad(finalHours, 2)}:${pad(finalMinutes, 2)}`;
+}
+//# sourceMappingURL=convert12To24.js.map

package/dist/shared/time/convert12To24.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert12To24.js","sourceRoot":"","sources":["../../../src/shared/time/convert12To24.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,IAAY;;IAChD,IACE,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,IAAI,CAAC,KAAK,CAAC,wCAAwC,CAAC,EACrD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,0CAAG,CAAC,CAAW,CAAC;IACrD,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE7D,IAAI,UAAkB,EACpB,YAAY,GAAW,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC;AACzD,CAAC"}

package/dist/shared/time/convert24To12.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @name                 convert24To12
+ * @namespace            shared.time
+ * @type                 Function
+ * @platform             js
+ * @platform             node
+ * @status               stable
+ *
+ * Convert a 24 hours time to a 12 hours time format
+ *
+ * @param       {String}                    time              The 24 hours time like "23:00"
+ * @return    {String}                                      The 12 hours time like "11:00pm"
+ *
+ * @todo      tests
+ *
+ * @snippet         convert24To12($1)
+ *
+ * @example    js
+ * import { convert24To12 } from '@blackbyte/sugar/time'
+ * convert24To12('23:12') // => '11:12pm'
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TConvert24To12Settings = {
+    keepLeadingZero?: boolean;
+    keepZeroMinute?: boolean;
+};
+export default function convert24To12(time: string, settings?: TConvert24To12Settings): string;

package/dist/shared/time/convert24To12.js

@@ -0,0 +1,17 @@
+import { pad } from '@blackbyte/sugar/number';
+export default function convert24To12(time, settings) {
+    const finalSettings = Object.assign({ keepZeroMinute: false, keepLeadingZero: false }, (settings !== null && settings !== void 0 ? settings : {}));
+    if (typeof time !== 'string' || !time.match(/^[012][0-9]\:[012345][0-9]$/)) {
+        throw new Error('[convert24To12] Invalid time format. Must be a string like "23:00"');
+    }
+    let [hours, minutes] = time.split(':');
+    let finalHours = parseInt(hours, 10);
+    let finalMinutes = parseInt(minutes, 10);
+    let suffix = finalHours > 12 || finalHours === 0 ? 'pm' : 'am';
+    let finalHoursStr = pad(finalHours > 12 ? finalHours - 12 : finalHours === 0 ? 12 : finalHours, finalSettings.keepLeadingZero ? 2 : 1);
+    let finalMinutesStr = finalMinutes === 0 && !finalSettings.keepZeroMinute
+        ? ''
+        : `:${pad(finalMinutes, 2)}`;
+    return `${finalHoursStr}${finalMinutesStr}${suffix}`;
+}
+//# sourceMappingURL=convert24To12.js.map

package/dist/shared/time/convert24To12.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert24To12.js","sourceRoot":"","sources":["../../../src/shared/time/convert24To12.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AAgC9C,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,IAAY,EACZ,QAAiC;IAEjC,MAAM,aAAa,mBACjB,cAAc,EAAE,KAAK,EACrB,eAAe,EAAE,KAAK,IACnB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,UAAU,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,YAAY,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACzC,IAAI,MAAM,GAAG,UAAU,GAAG,EAAE,IAAI,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAE/D,IAAI,aAAa,GAAG,GAAG,CACrB,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,EACtE,aAAa,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACtC,CAAC;IACF,IAAI,eAAe,GACjB,YAAY,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc;QACjD,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC;IAEjC,OAAO,GAAG,aAAa,GAAG,eAAe,GAAG,MAAM,EAAE,CAAC;AACvD,CAAC"}

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

@@ -0,0 +1,2 @@
+import parseTypeString from './parseTypeString.js';
+export { parseTypeString as __parseTypeString, parseTypeString };

package/dist/shared/type/_exports.js

@@ -0,0 +1,3 @@
+import parseTypeString from './parseTypeString.js';
+export { parseTypeString as __parseTypeString, parseTypeString };
+//# sourceMappingURL=_exports.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/type/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD,OAAO,EAAE,eAAe,IAAI,iBAAiB,EAAE,eAAe,EAAE,CAAC"}

package/dist/shared/type/parseTypeString.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @name            parseTypeString
+ * @namespace       shared.type
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          beta
+ *
+ * This method simply parse the passed typeString like "string | number", or "string & path", etc... and return
+ * an object defining this type string
+ *
+ * @param     {String}        typeString      The type string to parse
+ * @return    {TTypeStringObject[]}             An array of object(s) describing the type string passed
+ *
+ * @snippet         parseTypeString($1)
+ *
+ * @example       js
+ * import { parseTypeString } from '@blackbyte/sugar/type';
+ * parseTypeString('string|number');
+ * //[{
+ * //   type: 'string',
+ * //   of: undefined,
+ * //}, {
+ * //   type: 'number',
+ * //   of: undefined,
+ * //}]
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com>
+ */
+export type TTypeStringObject = {
+    type: string;
+    of: string[] | undefined;
+    value?: any;
+};
+export type TParseTypeStringSingleResultObj = {};
+export default function parseTypeString(typeString: string): TTypeStringObject[];