@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/type/parseTypeString.js

@@ -0,0 +1,135 @@
+import mapDeep from '../object/mapDeep.js';
+import parse from '../string/parse.js';
+function parseSingleTypeString(typeString) {
+    let ofStr = '', typeStr = typeString, ofTypes = [];
+    // string value
+    if (typeStr.match(/^['"`]/)) {
+        return {
+            type: 'string',
+            of: undefined,
+            value: typeStr.replace(/^['"`]/, '').replace(/['"`]$/, ''),
+        };
+    }
+    // number value
+    const autoCastedValue = parse(typeStr);
+    if (typeof autoCastedValue === 'number') {
+        return {
+            type: 'number',
+            of: undefined,
+            value: autoCastedValue,
+        };
+    }
+    // handle type<...>
+    typeStr = typeStr.trim().replace(/^([a-zA-Z0-9-_]+)\[\]$/, 'array<$1>');
+    const ofPartsString = typeStr.match(/<(.+)>$/gm);
+    if (ofPartsString && ofPartsString.length) {
+        ofStr = ofPartsString[0].replace('<', '').replace('>', '');
+    }
+    if (ofStr !== '') {
+        typeStr = typeStr.replace(`<${ofStr}>`, '');
+    }
+    // handle the "of" part
+    // @ts-ignore
+    ofTypes = ofStr !== '' ? [ofStr] : undefined;
+    if (ofStr !== undefined && ofStr.includes('|')) {
+        ofTypes = ofStr.split('|').map((t) => t.trim());
+    }
+    // values in "of"
+    // ofStr.split('|').forEach((of) => {
+    //     if (typeof parse(of) !== 'string') {
+    //         console.log('NO string', of);
+    //     }
+    // });
+    // values = typeString.split(/\|/).map((v) => parse(v));
+    const result = {
+        type: typeStr,
+        of: ofTypes,
+    };
+    // @ts-ignore
+    Object.defineProperty(result, 'toString', {
+        get() {
+            return () => typeString;
+        },
+    });
+    return result;
+}
+export default function parseTypeString(typeString) {
+    const originalTypeString = typeString;
+    typeString = typeString.trim();
+    // remove starting { and ending }
+    typeString = typeString.replace(/^\{/, '').replace(/\}$/, '');
+    let isArray = false;
+    if (typeString.match(/\)\[\]$/)) {
+        isArray = true;
+        typeString = typeString.replace(/\)\[\]$/, '').replace(/^\(/, '');
+    }
+    const firstTypes = [];
+    let inSubLevel = 0, typeStr = '', areSubLevels = false;
+    // split types
+    for (let i = 0; i < typeString.length; i++) {
+        const char = typeString[i];
+        if (['(', '<'].includes(char)) {
+            inSubLevel++;
+            areSubLevels = true;
+            typeStr += '^';
+        }
+        else if ([')', '>'].includes(char)) {
+            inSubLevel--;
+            typeStr += '$';
+            // typeStr += char;
+        }
+        else if (char === '|' && inSubLevel === 0) {
+            firstTypes.push({
+                areSubLevels,
+                type: typeStr,
+            });
+            typeStr = '';
+        }
+        else {
+            typeStr += char;
+        }
+        if (inSubLevel < 0) {
+            throw new Error(`It seems that your type string "${typeString}" is not valid...`);
+        }
+    }
+    firstTypes.push({
+        areSubLevels,
+        type: typeStr,
+    });
+    let finalTypes = [];
+    firstTypes.forEach((type) => {
+        if (type.areSubLevels) {
+            finalTypes = [...finalTypes, ...parseTypeString(type.type)];
+        }
+        else {
+            finalTypes.push(parseSingleTypeString(type.type.replace('^', '<').replace('$', '>')));
+        }
+    });
+    if (isArray) {
+        const result = [
+            {
+                type: 'array',
+                of: finalTypes,
+            },
+        ];
+        // @ts-ignore
+        result.__proto__.toString = () => originalTypeString;
+        // @ts-ignore
+        return result;
+    }
+    finalTypes = mapDeep(finalTypes, ({ object, prop, value, path }) => {
+        if (typeof value === 'string') {
+            value = value.replace(/^\./, '').trim();
+        }
+        return value;
+    });
+    // @ts-ignore
+    Object.defineProperty(finalTypes, 'toString', {
+        get() {
+            return () => originalTypeString;
+        },
+    });
+    // @ts-ignore
+    return finalTypes;
+}
+//# sourceMappingURL=parseTypeString.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parseTypeString.js","sourceRoot":"","sources":["../../../src/shared/type/parseTypeString.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,sBAAsB,CAAC;AAC3C,OAAO,KAAK,MAAM,oBAAoB,CAAC;AAyCvC,SAAS,qBAAqB,CAAC,UAAkB;IAC/C,IAAI,KAAK,GAAG,EAAE,EACZ,OAAO,GAAW,UAAU,EAC5B,OAAO,GAAa,EAAE,CAAC;IAEzB,eAAe;IACf,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SAC3D,CAAC;IACJ,CAAC;IACD,eAAe;IACf,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAED,mBAAmB;IACnB,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,wBAAwB,EAAE,WAAW,CAAC,CAAC;IAExE,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QAC1C,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QACjB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;IAC9C,CAAC;IACD,uBAAuB;IACvB,aAAa;IACb,OAAO,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,iBAAiB;IACjB,qCAAqC;IACrC,2CAA2C;IAC3C,wCAAwC;IACxC,QAAQ;IACR,MAAM;IACN,wDAAwD;IAExD,MAAM,MAAM,GAAG;QACb,IAAI,EAAE,OAAO;QACb,EAAE,EAAE,OAAO;KACZ,CAAC;IACF,aAAa;IACb,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE;QACxC,GAAG;YACD,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC;QAC1B,CAAC;KACF,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,CAAC,OAAO,UAAU,eAAe,CACrC,UAAkB;IAElB,MAAM,kBAAkB,GAAG,UAAU,CAAC;IAEtC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;IAC/B,iCAAiC;IACjC,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE9D,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,OAAO,GAAG,IAAI,CAAC;QACf,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,UAAU,GAAU,EAAE,CAAC;IAC7B,IAAI,UAAU,GAAG,CAAC,EAChB,OAAO,GAAG,EAAE,EACZ,YAAY,GAAG,KAAK,CAAC;IACvB,cAAc;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,UAAU,EAAE,CAAC;YACb,YAAY,GAAG,IAAI,CAAC;YACpB,OAAO,IAAI,GAAG,CAAC;QACjB,CAAC;aAAM,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,UAAU,EAAE,CAAC;YACb,OAAO,IAAI,GAAG,CAAC;YACf,mBAAmB;QACrB,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;YAC5C,UAAU,CAAC,IAAI,CAAC;gBACd,YAAY;gBACZ,IAAI,EAAE,OAAO;aACd,CAAC,CAAC;YACH,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,IAAI,CAAC;QAClB,CAAC;QACD,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,mCAAmC,UAAU,mBAAmB,CACjE,CAAC;QACJ,CAAC;IACH,CAAC;IACD,UAAU,CAAC,IAAI,CAAC;QACd,YAAY;QACZ,IAAI,EAAE,OAAO;KACd,CAAC,CAAC;IAEH,IAAI,UAAU,GAAsC,EAAE,CAAC;IACvD,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,UAAU,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9D,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CACb,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CACrE,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,MAAM,GAAG;YACb;gBACE,IAAI,EAAE,OAAO;gBACb,EAAE,EAAE,UAAU;aACf;SACF,CAAC;QACF,aAAa;QACb,MAAM,CAAC,SAAS,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,kBAAkB,CAAC;QACrD,aAAa;QACb,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,UAAU,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,aAAa;IACb,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,EAAE;QAC5C,GAAG;YACD,OAAO,GAAG,EAAE,CAAC,kBAAkB,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;IACH,aAAa;IACb,OAAO,UAAU,CAAC;AACpB,CAAC"}

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

@@ -0,0 +1,5 @@
+import __gravatarUrl from './gravatarUrl.js';
+import __parseSchema from './parseSchema.js';
+import __queryStringToObject from './queryStringToObject.js';
+import __urlFromString from './urlFromString.js';
+export { __gravatarUrl, __parseSchema, __queryStringToObject, __urlFromString };

package/dist/shared/url/_exports.js

@@ -0,0 +1,6 @@
+import __gravatarUrl from './gravatarUrl.js';
+import __parseSchema from './parseSchema.js';
+import __queryStringToObject from './queryStringToObject.js';
+import __urlFromString from './urlFromString.js';
+export { __gravatarUrl, __parseSchema, __queryStringToObject, __urlFromString };
+//# sourceMappingURL=_exports.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/url/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAC7D,OAAO,eAAe,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,qBAAqB,EAAE,eAAe,EAAE,CAAC"}

package/dist/shared/url/gravatarUrl.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                gravatarUrl
+ * @namespace           shared.url
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Return a gravatar url depending on the passed user email and size
+ *
+ * @param           {String}            email             The user email
+ * @param           {Number}            [size=200]        The wanted image size. From 1 to 2048
+ * @return          {String}                              The generated gravatar url
+ *
+ * @todo      tests
+ *
+ * @snippet         gravatarUrl($1)
+ *
+ * @example       js
+ * import { gravatarUrl } from '@blackbyte/sugar/url';
+ * gravatarUrl('olivier.bossel@gmail.com'); // https://www.gravatar.com/avatar/b5df60055b6287bb7c90c0078ce20a5f
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function gravatarUrl(email: string, size?: number): string;

package/dist/shared/url/gravatarUrl.js

@@ -0,0 +1,30 @@
+import md5 from '../../shared/crypto/md5.js';
+/**
+ * @name                gravatarUrl
+ * @namespace           shared.url
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Return a gravatar url depending on the passed user email and size
+ *
+ * @param           {String}            email             The user email
+ * @param           {Number}            [size=200]        The wanted image size. From 1 to 2048
+ * @return          {String}                              The generated gravatar url
+ *
+ * @todo      tests
+ *
+ * @snippet         gravatarUrl($1)
+ *
+ * @example       js
+ * import { gravatarUrl } from '@blackbyte/sugar/url';
+ * gravatarUrl('olivier.bossel@gmail.com'); // https://www.gravatar.com/avatar/b5df60055b6287bb7c90c0078ce20a5f
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function gravatarUrl(email, size = 200) {
+    return `https://www.gravatar.com/avatar/${md5.encrypt(email)}?s=${size}`;
+}
+//# sourceMappingURL=gravatarUrl.js.map

package/dist/shared/url/gravatarUrl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gravatarUrl.js","sourceRoot":"","sources":["../../../src/shared/url/gravatarUrl.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,4BAA4B,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,KAAa,EAAE,OAAe,GAAG;IACnE,OAAO,mCAAmC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC;AAC3E,CAAC"}

package/dist/shared/url/parseSchema.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @name                            parseSchema
+ * @namespace                       shared.url
+ * @type                            Function
+ * @platform                        js
+ * @platform                        node
+ * @status                          beta
+ * @private
+ *
+ * This function take two arguments. The first one is the url to parse and the second is a schema to scan the url with.
+ * The schema describe the pathname of an url and tell's how to analyze it.
+ * Here's a little description with some example of schemas:
+ * - "{param1}/{param2}/{param3}": This schema describe that your Url must have 3 "values" named param1, param2 and param3
+ *    - If my Url is "something.com/hello/world/plop", my schema is respected and I can have access to the values through the "schema.params.param1", "schema.params.param2", etc...
+ * - "{hello:string}/{world:number}/{?idx:number}": This schema describe that the Url can have 3 "values" but the last one is optional
+ *    - If my Url is "something.com/plop/3/1", my schema is respected
+ *    - If my Url is "something.com/plop/2", my schema is respected
+ *    - If my Url is "something.com/plop/hello/2", my schema is not respected due to the fact that the param named "world" has to be a number
+ *
+ * @param         {String}              url                 The url to parse
+ * @param         {String}              schema              The schema with the one we will analyze the url
+ * @return        {Object}                                  An object that describe our parsing process result. Here's the structure of the returned object:
+ * - errors (null) {Object}: An object with all the params in error with the description of the error for each
+ * - params (null) {Object}: An object containing every params grabed from the url with their values for each
+ * - match (true) {Object}: A boolean that tells you if the parsed url match the passed schema or not
+ *
+ * @todo      tests
+ *
+ * @example       js
+ * import { parseSchema } from '@blackbyte/sugar/url';
+ * parseSchema('https://github.com/myApp/main/3', '{project:string}/{?branch:string}/{?idx:number}');
+ * // {
+ * //   url: 'https://github.com/myApp/main/3',
+ * //   schema: '{project:string}/{?branch:string}/{?idx:number}',
+ * //   match: true,
+ * //   errors: null,
+ * //   params: {
+ * //     project: {
+ * //       optional: false,
+ * //       raw: '{project:string}',
+ * //       type: 'string',
+ * //       value: 'myApp'
+ * //     },
+ * //     branch: {
+ * //       optional: true,
+ * //       raw: '{?branch:string},
+ * //       type: 'string',
+ * //       value: 'master'
+ * //     },
+ * //     idx: {
+ * //       optional: true,
+ * //       raw: '{?idx:number}',
+ * //       type: 'number',
+ * //       value: 3
+ * //     }
+ * //   }
+ * // }
+ *
+ * @since       1.0.0
+ * @author 		Olivier Bossel<olivier.bossel@gmail.com>
+ */
+export default function parseSchema(url: string, schema: string): any;

package/dist/shared/url/parseSchema.js

@@ -0,0 +1,183 @@
+// @ts-nocheck
+import parseString from '../string/parse.js';
+/**
+ * @name                            parseSchema
+ * @namespace                       shared.url
+ * @type                            Function
+ * @platform                        js
+ * @platform                        node
+ * @status                          beta
+ * @private
+ *
+ * This function take two arguments. The first one is the url to parse and the second is a schema to scan the url with.
+ * The schema describe the pathname of an url and tell's how to analyze it.
+ * Here's a little description with some example of schemas:
+ * - "{param1}/{param2}/{param3}": This schema describe that your Url must have 3 "values" named param1, param2 and param3
+ *    - If my Url is "something.com/hello/world/plop", my schema is respected and I can have access to the values through the "schema.params.param1", "schema.params.param2", etc...
+ * - "{hello:string}/{world:number}/{?idx:number}": This schema describe that the Url can have 3 "values" but the last one is optional
+ *    - If my Url is "something.com/plop/3/1", my schema is respected
+ *    - If my Url is "something.com/plop/2", my schema is respected
+ *    - If my Url is "something.com/plop/hello/2", my schema is not respected due to the fact that the param named "world" has to be a number
+ *
+ * @param         {String}              url                 The url to parse
+ * @param         {String}              schema              The schema with the one we will analyze the url
+ * @return        {Object}                                  An object that describe our parsing process result. Here's the structure of the returned object:
+ * - errors (null) {Object}: An object with all the params in error with the description of the error for each
+ * - params (null) {Object}: An object containing every params grabed from the url with their values for each
+ * - match (true) {Object}: A boolean that tells you if the parsed url match the passed schema or not
+ *
+ * @todo      tests
+ *
+ * @example       js
+ * import { parseSchema } from '@blackbyte/sugar/url';
+ * parseSchema('https://github.com/myApp/main/3', '{project:string}/{?branch:string}/{?idx:number}');
+ * // {
+ * //   url: 'https://github.com/myApp/main/3',
+ * //   schema: '{project:string}/{?branch:string}/{?idx:number}',
+ * //   match: true,
+ * //   errors: null,
+ * //   params: {
+ * //     project: {
+ * //       optional: false,
+ * //       raw: '{project:string}',
+ * //       type: 'string',
+ * //       value: 'myApp'
+ * //     },
+ * //     branch: {
+ * //       optional: true,
+ * //       raw: '{?branch:string},
+ * //       type: 'string',
+ * //       value: 'master'
+ * //     },
+ * //     idx: {
+ * //       optional: true,
+ * //       raw: '{?idx:number}',
+ * //       type: 'number',
+ * //       value: 3
+ * //     }
+ * //   }
+ * // }
+ *
+ * @since       1.0.0
+ * @author 		Olivier Bossel<olivier.bossel@gmail.com>
+ */
+export default function parseSchema(url, schema) {
+    const rawSchemaString = schema;
+    const rawUrlString = url;
+    // remove query string
+    url = url.split('?')[0];
+    // get the pathname of the url
+    let pathname;
+    try {
+        pathname = new URL(url).pathname;
+    }
+    catch (e) {
+        pathname = url;
+    }
+    if (pathname.slice(0, 1) === '/')
+        pathname = pathname.slice(1);
+    // init the params object
+    const params = {};
+    const errors = {};
+    let match = true;
+    // split the schema
+    let schemaParts = schema.split('/');
+    // analyze all the schema parts
+    schemaParts = schemaParts
+        .map((part) => {
+        // check if is a param
+        if (part.slice(0, 1) === '{' && part.slice(-1) === '}') {
+            const isOptional = part.slice(0, 2) === '{?' || part.slice(-2) === '?}';
+            const isType = part.indexOf(':') !== -1;
+            let type = null;
+            let name = null;
+            if (isType) {
+                name = part.split(':')[0].slice(1);
+                type = part.split(':')[1].slice(0, -1);
+                if (name.slice(0, 1) === '?')
+                    name = name.slice(1);
+                if (type.slice(-1) === '?')
+                    type = type.slice(0, -1);
+            }
+            else {
+                name = part.slice(1, -1);
+                if (name.slice(-1) === '?')
+                    name = name.slice(0, -1);
+                if (name.slice(0, 1) === '?')
+                    name = name.slice(1);
+            }
+            return {
+                name,
+                type,
+                raw: part,
+                optional: isOptional,
+            };
+        }
+        // this is not a parameter so return as is
+        return part;
+    })
+        .filter((l) => l !== '');
+    schemaParts.forEach((part) => {
+        if (!part.name)
+            return;
+        params[part.name] = Object.assign({}, part);
+        delete params[part.name].name;
+    });
+    // loop on the schema to get the params values
+    // const pathname = url.pathname.slice(1);
+    const splitedPathname = pathname.split('/');
+    for (let i = 0; i < schemaParts.length; i++) {
+        // get the schema for this part
+        const schema = schemaParts[i];
+        // get the part to check
+        const part = splitedPathname[i];
+        // if it's not an object, mean that it's a simple string part
+        if (typeof schema !== 'object') {
+            if (part !== schema)
+                match = false;
+            continue;
+        }
+        if (!part && !schema.optional) {
+            const errorObj = {
+                type: 'optional',
+                description: `This param "${schema.name}" cannot be null...`,
+            };
+            errors[schema.name] = errorObj;
+            params[schema.name].error = errorObj;
+            match = false;
+            continue;
+        }
+        else if (!part && schema.optional) {
+            params[schema.name].value = null;
+            continue;
+        }
+        // check that all correspond to the schema
+        if (schema.type) {
+            const type = schema.type;
+            if (type !== typeof parseString(part)) {
+                match = false;
+                const errorObj = {
+                    type: 'type',
+                    requested: type,
+                    passed: typeof parseString(part),
+                    description: `This param "${schema.name}" has to be a "${type}" but he's a "${typeof parseString(part)}"...`,
+                };
+                errors[schema.name] = errorObj;
+                params[schema.name].error = errorObj;
+                params[schema.name].value = parseString(part);
+                continue;
+            }
+        }
+        // this part match the schema so we add it to the params
+        params[schema.name].value = parseString(part);
+    }
+    // return the schema result
+    return {
+        errors: !Object.keys(errors).length ? null : errors,
+        params: !Object.keys(params).length ? null : params,
+        match,
+        schema: rawSchemaString,
+        url: rawUrlString,
+    };
+}
+//# sourceMappingURL=parseSchema.js.map

package/dist/shared/url/parseSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseSchema.js","sourceRoot":"","sources":["../../../src/shared/url/parseSchema.ts"],"names":[],"mappings":"AAAA,cAAc;AAEd,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,GAAW,EAAE,MAAc;IAC7D,MAAM,eAAe,GAAG,MAAM,CAAC;IAC/B,MAAM,YAAY,GAAG,GAAG,CAAC;IAEzB,sBAAsB;IACtB,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAExB,8BAA8B;IAC9B,IAAI,QAAQ,CAAC;IACb,IAAI,CAAC;QACH,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,QAAQ,GAAG,GAAG,CAAC;IACjB,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG;QAAE,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/D,yBAAyB;IACzB,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,IAAI,KAAK,GAAG,IAAI,CAAC;IAEjB,mBAAmB;IACnB,IAAI,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEpC,+BAA+B;IAC/B,WAAW,GAAG,WAAW;SACtB,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;QACpB,sBAAsB;QACtB,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACvD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;YACxE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;YAExC,IAAI,IAAI,GAAG,IAAI,CAAC;YAChB,IAAI,IAAI,GAAG,IAAI,CAAC;YAChB,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACvC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG;oBAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnD,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG;oBAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACzB,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG;oBAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrD,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG;oBAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACrD,CAAC;YAED,OAAO;gBACL,IAAI;gBACJ,IAAI;gBACJ,GAAG,EAAE,IAAI;gBACT,QAAQ,EAAE,UAAU;aACrB,CAAC;QACJ,CAAC;QAED,0CAA0C;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAEnC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;QAChC,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,OAAO;QACvB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,qBACZ,IAAI,CACR,CAAC;QACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,8CAA8C;IAC9C,0CAA0C;IAC1C,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5C,+BAA+B;QAC/B,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAE9B,wBAAwB;QACxB,MAAM,IAAI,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;QAEhC,6DAA6D;QAC7D,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,IAAI,IAAI,KAAK,MAAM;gBAAE,KAAK,GAAG,KAAK,CAAC;YACnC,SAAS;QACX,CAAC;QAED,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAG;gBACf,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,eAAe,MAAM,CAAC,IAAI,qBAAqB;aAC7D,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;YACrC,KAAK,GAAG,KAAK,CAAC;YACd,SAAS;QACX,CAAC;aAAM,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC;YACjC,SAAS;QACX,CAAC;QAED,0CAA0C;QAC1C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACzB,IAAI,IAAI,KAAK,OAAO,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM,QAAQ,GAAG;oBACf,IAAI,EAAE,MAAM;oBACZ,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,OAAO,WAAW,CAAC,IAAI,CAAC;oBAChC,WAAW,EAAE,eACX,MAAM,CAAC,IACT,kBAAkB,IAAI,iBAAiB,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM;iBACtE,CAAC;gBACF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;gBAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC9C,SAAS;YACX,CAAC;QACH,CAAC;QAED,wDAAwD;QACxD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IACD,2BAA2B;IAC3B,OAAO;QACL,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;QACnD,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;QACnD,KAAK;QACL,MAAM,EAAE,eAAe;QACvB,GAAG,EAAE,YAAY;KAClB,CAAC;AACJ,CAAC"}

package/dist/shared/url/queryStringToObject.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                queryStringToObject
+ * @namespace           shared.url
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Transform a query string into his object (key => pairs) representation
+ *
+ * @param 	{String}  	queryString  	The query string to process
+ * @return 	{Object} 					The object representation of the query string
+ *
+ * @todo      tests
+ *
+ * @snippet         queryStringToObject($1)
+ *
+ * @example    js
+ * import { queryStringToObject } from '@blackbyte/sugar/url'
+ * queryStringToObject('?var1=value1&var2=value2') // { var1: 'value1', var2: 'value2' }
+ *
+ * @see  	http://stackoverflow.com/questions/8648892/convert-url-parameters-to-a-javascript-object
+ * @since     1.0.0
+ * @author 	Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function queryStringToObject(str: string): any;

package/dist/shared/url/queryStringToObject.js

@@ -0,0 +1,47 @@
+import ltrim from '../string/ltrim.js';
+/**
+ * @name                queryStringToObject
+ * @namespace           shared.url
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Transform a query string into his object (key => pairs) representation
+ *
+ * @param 	{String}  	queryString  	The query string to process
+ * @return 	{Object} 					The object representation of the query string
+ *
+ * @todo      tests
+ *
+ * @snippet         queryStringToObject($1)
+ *
+ * @example    js
+ * import { queryStringToObject } from '@blackbyte/sugar/url'
+ * queryStringToObject('?var1=value1&var2=value2') // { var1: 'value1', var2: 'value2' }
+ *
+ * @see  	http://stackoverflow.com/questions/8648892/convert-url-parameters-to-a-javascript-object
+ * @since     1.0.0
+ * @author 	Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function queryStringToObject(str) {
+    str = ltrim(str, '?');
+    str = str.replace(/%20/gm, ' ');
+    str = decodeURIComponent(str);
+    let chunks = str.split('&');
+    const obj = {};
+    chunks = chunks.filter((ch) => {
+        return ch !== '';
+    });
+    for (let c = 0; c < chunks.length; c++) {
+        const split = chunks[c].split('=', 2);
+        if (split[1] !== undefined) {
+            obj[split[0]] = split[1];
+        }
+        else {
+            obj[split[0]] = true;
+        }
+    }
+    return obj;
+}
+//# sourceMappingURL=queryStringToObject.js.map

package/dist/shared/url/queryStringToObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryStringToObject.js","sourceRoot":"","sources":["../../../src/shared/url/queryStringToObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,oBAAoB,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,GAAW;IACrD,GAAG,GAAG,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACtB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAChC,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,GAAG,GAAQ,EAAE,CAAC;IACpB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;QAC5B,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACtC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/shared/url/urlFromString.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name            urlFromString
+ * @namespace       shared.url
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @platform         ts
+ * @status          stable
+ *
+ * Simple function that take a string as parameter and returns you a valid
+ * url ready one
+ *
+ * @todo            tests
+ *
+ * @snippet         urlFromString($1)
+ *
+ * @example             js
+ * import { urlFromString } from '@blackbyte/sugar/url';
+ * urlFromString('Sir James Paul McCartney MBE is an English singer-songwriter');
+ * // sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter
+ *
+ * @see             https://www.npmjs.com/package/url-slug
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function urlFromString(string: string): string;

package/dist/shared/url/urlFromString.js

@@ -0,0 +1,36 @@
+import urlSlug from 'url';
+/**
+ * @name            urlFromString
+ * @namespace       shared.url
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @platform         ts
+ * @status          stable
+ *
+ * Simple function that take a string as parameter and returns you a valid
+ * url ready one
+ *
+ * @todo            tests
+ *
+ * @snippet         urlFromString($1)
+ *
+ * @example             js
+ * import { urlFromString } from '@blackbyte/sugar/url';
+ * urlFromString('Sir James Paul McCartney MBE is an English singer-songwriter');
+ * // sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter
+ *
+ * @see             https://www.npmjs.com/package/url-slug
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function urlFromString(string) {
+    return string
+        .split('/')
+        .map((l) => {
+        // @ts-ignore
+        return urlSlug(l.trim());
+    })
+        .join('/');
+}
+//# sourceMappingURL=urlFromString.js.map

package/dist/shared/url/urlFromString.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlFromString.js","sourceRoot":"","sources":["../../../src/shared/url/urlFromString.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,KAAK,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,MAAc;IAClD,OAAO,MAAM;SACV,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,aAAa;QACb,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC"}

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

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

package/dist/shared/utils/_exports.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/utils/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAE,MAAM,IAAI,QAAQ,EAAE,MAAM,EAAE,CAAC"}

package/dist/shared/utils/assert.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @name           assert
+ * @namespace      shared.utils
+ * @type           Function
+ * @platform       js
+ * @platform       node
+ * @status         stable
+ *
+ * Checks a condition and throws an error if the condition is not met
+ *
+ * @param       {boolean}           condition            The condition to check
+ * @param       {string}            message              The error message to display if the condition fails
+ *
+ * @throws {Error} - Throws an error if the condition is not met
+ *
+ * @since       1.0.0
+ * @author 		Olivier Bossel<olivier.bossel@gmail.com>
+ */
+export default function assert(condition: any, message: string): void;