@argon-router/paths 0.11.0 → 1.0.0-rc.0

package/README.md

@@ -2,9 +2,6 @@
 
 Exteremly customizable paths without a headache
 
-> [!WARNING]
-> argon-router is not production ready yet and still may have bugs and unstable API. If you found bug — please report it on GitHub.
-
 ## Documentation
 
 For additional information, guides and api reference visit [documentation site](https://movpushmov.dev/argon-router/)

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";function e(e){return r=>{const n=r.split("/").map(e=>e.trim()).filter(e=>""!==e);let t=null;function a(e,r){t||(t={}),t[e]=r}if(0===e.length)return 0===n.length?{path:r,params:null}:null;for(let i=0;i<e.length;i++){const r=e[i];switch(r.type){case"const":if(r.name!==n.shift())return null;continue;case"parameter":{const{arrayProps:t,genericProps:o,required:s}=r.payload;if(t){const s=[];let l;for(;l=n.shift(),l;){switch(null==o?void 0:o.type){case"number":if(isNaN(+l))return null;s.push(+l);break;case"union":if(!o.items.includes(l))return null;s.push(l);break;default:s.push(l)}if(s.length>=(t.max??1/0))break}if(s.length<(t.min??0))return null;if(n.length>0&&!e[i+1])return null;a(r.name,s);break}const l=n.shift();if(s&&!l)return null;if(!l){a(r.name,void 0);continue}switch(null==o?void 0:o.type){case"number":if(isNaN(+l))return null;a(r.name,+l);break;case"union":if(!o.items.includes(l))return null;a(r.name,l);break;default:a(r.name,l)}}}}return n.length>0?null:{path:r,params:t}}}function r(e){if(!e)return null;const r=e[1];let n,t,a;for(const i of e.slice(2))i&&(i.includes("<")?n=i.replaceAll(/\s/g,"").replace("<","").replace(">",""):(i.includes("{")&&(t=i.replace("{","").replace("}","").split(",").map(e=>parseInt(e))),["*","?","+"].includes(i)&&(a=i)));return{name:r,genericProps:n,arrayProps:t,modificator:a}}function n(e){return r=>{const n=[];if(0===e.length)return"/";for(const t of e)switch(t.type){case"const":n.push(t.name);break;case"parameter":if(!r[t.name])continue;if(Array.isArray(r[t.name]))for(const e of r[t.name])n.push(e.toString());else n.push(r[t.name].toString())}return`/${n.join("/")}`}}Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"}),exports.compile=function(t){const a=[],i=/:(\w+)(<[\s?\w|]+>)?({\d+\,\d+})?([+*?])?/,o=t.split("/").filter(Boolean);for(let e=0;e<o.length;e++){const n=o[e];if(!n)continue;const s=r(n.match(i));if(!s){a.push({type:"const",name:n,payload:void 0});continue}const{arrayProps:l,genericProps:u,modificator:c,name:p}=s;if(!p)throw new Error(`Invalid path: "${t}". Name for argument must be provided`);const f={type:"parameter",name:p,payload:{required:!0}};switch(u&&"number"===u&&(f.payload.genericProps={type:"number"}),u&&u.includes("|")&&(f.payload.genericProps={type:"union",items:u.split("|")}),c){case"*":f.payload.arrayProps={};break;case"+":f.payload.arrayProps={min:1};break;case"?":f.payload.required=!1}l&&(f.payload.arrayProps={...f.payload.arrayProps,min:l[0],max:l[1]}),a.push(f)}return{parse:e(a),build:n(a)}};
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function g(e){return r=>{const t=r.split("/").map(c=>c.trim()).filter(c=>c!=="");let n=null;function i(c,a){n||(n={}),n[c]=a}if(e.length===0)return t.length===0?{path:r,params:null}:null;for(let c=0;c<e.length;c++){const a=e[c];switch(a.type){case"const":{if(a.name!==t.shift())return null;continue}case"parameter":{const{arrayProps:m,genericProps:u,required:s}=a.payload;if(m){var o;const d=[];let f;for(;;){var l;if(f=t.shift(),!f)break;switch(u?.type){case"number":{if(isNaN(+f))return null;d.push(+f);break}case"union":{if(!u.items.includes(f))return null;d.push(f);break}default:{d.push(f);break}}if(d.length>=((l=m.max)!==null&&l!==void 0?l:1/0))break}if(d.length<((o=m.min)!==null&&o!==void 0?o:0)||t.length>0&&!e[c+1])return null;i(a.name,d);break}const p=t.shift();if(s&&!p)return null;if(!p){i(a.name,void 0);continue}switch(u?.type){case"number":{if(isNaN(+p))return null;i(a.name,+p);break}case"union":{if(!u.items.includes(p))return null;i(a.name,p);break}default:{i(a.name,p);break}}}}}return t.length>0?null:{path:r,params:n}}}function h(e){if(!e)return null;const r=e[1];let t,n,i;for(const o of e.slice(2))if(o){if(o.includes("<")){t=o.replaceAll(/\s/g,"").replace("<","").replace(">","");continue}if(o.includes("{")&&(n=o.replace("{","").replace("}","").split(",").map(l=>parseInt(l))),["*","?","+"].includes(o)){i=o;continue}}return{name:r,genericProps:t,arrayProps:n,modificator:i}}function v(e){return r=>{const t=[];if(e.length===0)return"/";for(const n of e)switch(n.type){case"const":{t.push(n.name);break}case"parameter":{if(!r[n.name])continue;if(Array.isArray(r[n.name]))for(const i of r[n.name])t.push(i.toString());else t.push(r[n.name].toString());break}}return"/".concat(t.join("/"))}}function y(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter(function(i){return Object.getOwnPropertyDescriptor(e,i).enumerable})),t.push.apply(t,n)}return t}function b(e){for(var r=1;r<arguments.length;r++){var t=arguments[r]!=null?arguments[r]:{};r%2?y(Object(t),!0).forEach(function(n){P(e,n,t[n])}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):y(Object(t)).forEach(function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))})}return e}function P(e,r,t){return(r=w(r))in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function w(e){var r=k(e,"string");return typeof r=="symbol"?r:r+""}function k(e,r){if(typeof e!="object"||!e)return e;var t=e[Symbol.toPrimitive];if(t!==void 0){var n=t.call(e,r);if(typeof n!="object")return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return(r==="string"?String:Number)(e)}function O(e){const r=[],t=/:(\w+)(<[\s?\w|]+>)?({\d+,\d+})?([+*?])?/,n=e.split("/").filter(Boolean);for(let i=0;i<n.length;i++){const o=n[i];if(!o)continue;const l=h(o.match(t));if(!l){r.push({type:"const",name:o,payload:void 0});continue}const{arrayProps:c,genericProps:a,modificator:m,name:u}=l;if(!u)throw new Error('Invalid path: "'.concat(e,'". Name for argument must be provided'));const s={type:"parameter",name:u,payload:{required:!0}};switch(a&&a==="number"&&(s.payload.genericProps={type:"number"}),a&&a.includes("|")&&(s.payload.genericProps={type:"union",items:a.split("|")}),m){case"*":{s.payload.arrayProps={};break}case"+":{s.payload.arrayProps={min:1};break}case"?":{s.payload.required=!1;break}}c&&(s.payload.arrayProps=b(b({},s.payload.arrayProps),{},{min:c[0],max:c[1]})),r.push(s)}return{parse:g(r),build:v(r)}}const j={express:[[/:id<.+>/g,":id"],[/:id\+/g,"*id"],[/:id\*/g,"*id"],[/:id\{.+\}/g,"*id"],[/([a-zA-Z0-9:/_.]+)\/([*:])id\?/g,"$1{/$2id}"],[/([*:])id\?/g,"{$1id}"]]};function S(e,r){switch(r){case"express":{let t=e;for(const[n,i]of j.express)t.match(n)&&(t=t.replace(n,i));return t}}}exports.compile=O;exports.convertPath=S;

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export declare type Builder<T> = (params: T) => string;
 
+declare type CompabilityMode = 'express';
+
 /**
  * @param path Route path
  * @description compiles route and give two functions: build (from params to string) & parse (validate from string and get params)
@@ -37,6 +39,8 @@ export declare type Builder<T> = (params: T) => string;
      build: Builder<Params>;
  };
 
+ export declare function convertPath(path: string, mode: CompabilityMode): string;
+
  declare type GenericType<T extends string> = ReplaceAll<T, ' ', ''> extends infer Trimmed ? Trimmed extends `number` ? number : Trimmed extends `${infer A}|${infer B}` ? Union<Trimmed> : Trimmed : never;
 
  declare type Join<T extends any[]> = T['length'] extends 0 ? never : T extends [infer F, ...infer Rest] ? Join<Rest> extends infer Tail ? [Tail] extends [never] ? `${F & string}` : `${F & string}/${Tail & string}` : never : never;
@@ -115,7 +119,7 @@ export declare type Builder<T> = (params: T) => string;
  infer TokenReplacer
  ] ? ['invalid', JoinPath<[...Res, TokenReplacer, ...Rest]>] : ValidateTokens<Path, Rest, [...Res, Token & string]> : Path;
 
- declare type ValidateTypes<GenTypes> = GenTypes extends 'number' ? 'valid' : GenTypes extends '' ? ['invalid', `<number,union>`] : GenTypes extends string | `${string}|${string}` ? 'valid' : ['invalid', `<number,union>`];
+ declare type ValidateTypes<GenTypes> = GenTypes extends 'number' ? 'valid' : GenTypes extends '' ? ['invalid', `<number,union>`] : GenTypes extends `${string}|${string}` | string ? 'valid' : ['invalid', `<number,union>`];
 
  declare type WithModificator<Type, T extends string> = T extends `${infer K}{${infer Start},${infer End}}+` ? Type[] : T extends `${infer K}{${infer Start},${infer End}}*` ? Type[] : T extends `${infer K}{${infer Start},${infer End}}?` ? Type[] | undefined : T extends `${infer K}{${infer Start},${infer End}}` ? Type[] : T extends `${infer K}+` ? Type[] : T extends `${infer K}*` ? Type[] : T extends `${infer K}?` ? Type | undefined : Type;
 

package/dist/index.js

@@ -1,259 +1,266 @@
-function prepareParser(tokens) {
-  return (input) => {
-    const rawTokens = input.split("/").map((part) => part.trim()).filter((part) => part !== "");
-    let params = null;
-    function setKey(key, value) {
-      if (!params) {
-        params = {};
-      }
-      params[key] = value;
+function g(e) {
+  return (r) => {
+    const t = r.split("/").map((c) => c.trim()).filter((c) => c !== "");
+    let n = null;
+    function i(c, o) {
+      n || (n = {}), n[c] = o;
     }
-    if (tokens.length === 0) {
-      return rawTokens.length === 0 ? {
-        path: input,
+    if (e.length === 0)
+      return t.length === 0 ? {
+        path: r,
         params: null
       } : null;
-    }
-    for (let i = 0; i < tokens.length; i++) {
-      const token = tokens[i];
-      switch (token.type) {
+    for (let c = 0; c < e.length; c++) {
+      const o = e[c];
+      switch (o.type) {
         case "const": {
-          if (token.name !== rawTokens.shift()) {
+          if (o.name !== t.shift())
             return null;
-          }
           continue;
         }
         case "parameter": {
           const {
-            arrayProps,
-            genericProps,
-            required
-          } = token.payload;
-          if (arrayProps) {
-            const array = [];
-            let rawToken2;
-            while (true) {
-              rawToken2 = rawTokens.shift();
-              if (!rawToken2) {
+            arrayProps: m,
+            genericProps: u,
+            required: s
+          } = o.payload;
+          if (m) {
+            var a;
+            const d = [];
+            let f;
+            for (; ; ) {
+              var l;
+              if (f = t.shift(), !f)
                 break;
-              }
-              switch (genericProps == null ? void 0 : genericProps.type) {
+              switch (u?.type) {
                 case "number": {
-                  if (isNaN(+rawToken2)) {
+                  if (isNaN(+f))
                     return null;
-                  }
-                  array.push(+rawToken2);
+                  d.push(+f);
                   break;
                 }
                 case "union": {
-                  if (!genericProps.items.includes(rawToken2)) {
+                  if (!u.items.includes(f))
                     return null;
-                  }
-                  array.push(rawToken2);
+                  d.push(f);
                   break;
                 }
                 default: {
-                  array.push(rawToken2);
+                  d.push(f);
                   break;
                 }
               }
-              if (array.length >= (arrayProps.max ?? Infinity)) {
+              if (d.length >= ((l = m.max) !== null && l !== void 0 ? l : 1 / 0))
                 break;
-              }
             }
-            if (array.length < (arrayProps.min ?? 0)) {
+            if (d.length < ((a = m.min) !== null && a !== void 0 ? a : 0) || t.length > 0 && !e[c + 1])
               return null;
-            }
-            if (rawTokens.length > 0 && !tokens[i + 1]) {
-              return null;
-            }
-            setKey(token.name, array);
+            i(o.name, d);
             break;
           }
-          const rawToken = rawTokens.shift();
-          if (required && !rawToken) {
+          const p = t.shift();
+          if (s && !p)
             return null;
-          }
-          if (!rawToken) {
-            setKey(token.name, void 0);
+          if (!p) {
+            i(o.name, void 0);
             continue;
           }
-          switch (genericProps == null ? void 0 : genericProps.type) {
+          switch (u?.type) {
             case "number": {
-              if (isNaN(+rawToken)) {
+              if (isNaN(+p))
                 return null;
-              }
-              setKey(token.name, +rawToken);
+              i(o.name, +p);
               break;
             }
             case "union": {
-              if (!genericProps.items.includes(rawToken)) {
+              if (!u.items.includes(p))
                 return null;
-              }
-              setKey(token.name, rawToken);
+              i(o.name, p);
               break;
             }
             default: {
-              setKey(token.name, rawToken);
+              i(o.name, p);
               break;
             }
           }
         }
       }
     }
-    if (rawTokens.length > 0) {
-      return null;
-    }
-    return {
-      path: input,
-      params
+    return t.length > 0 ? null : {
+      path: r,
+      params: n
     };
   };
 }
-function getTokenParameters(params) {
-  if (!params) {
+function h(e) {
+  if (!e)
     return null;
-  }
-  const name = params[1];
-  let genericProps;
-  let arrayProps;
-  let modificator;
-  for (const parameter of params.slice(2)) {
-    if (!parameter) {
-      continue;
-    }
-    if (parameter.includes("<")) {
-      genericProps = parameter.replaceAll(/\s/g, "").replace("<", "").replace(">", "");
-      continue;
-    }
-    if (parameter.includes("{")) {
-      arrayProps = parameter.replace("{", "").replace("}", "").split(",").map((item) => parseInt(item));
-    }
-    if (["*", "?", "+"].includes(parameter)) {
-      modificator = parameter;
-      continue;
+  const r = e[1];
+  let t, n, i;
+  for (const a of e.slice(2))
+    if (a) {
+      if (a.includes("<")) {
+        t = a.replaceAll(/\s/g, "").replace("<", "").replace(">", "");
+        continue;
+      }
+      if (a.includes("{") && (n = a.replace("{", "").replace("}", "").split(",").map((l) => parseInt(l))), ["*", "?", "+"].includes(a)) {
+        i = a;
+        continue;
+      }
     }
-  }
   return {
-    name,
-    genericProps,
-    arrayProps,
-    modificator
+    name: r,
+    genericProps: t,
+    arrayProps: n,
+    modificator: i
   };
 }
-function prepareBuilder(tokens) {
-  return (params) => {
-    const result = [];
-    if (tokens.length === 0) {
+function v(e) {
+  return (r) => {
+    const t = [];
+    if (e.length === 0)
       return "/";
-    }
-    for (const token of tokens) {
-      switch (token.type) {
+    for (const n of e)
+      switch (n.type) {
         case "const": {
-          result.push(token.name);
+          t.push(n.name);
           break;
         }
         case "parameter": {
-          if (!params[token.name]) {
+          if (!r[n.name])
             continue;
-          }
-          if (Array.isArray(params[token.name])) {
-            for (const param of params[token.name]) {
-              result.push(param.toString());
-            }
-          } else {
-            result.push(params[token.name].toString());
-          }
+          if (Array.isArray(r[n.name]))
+            for (const i of r[n.name])
+              t.push(i.toString());
+          else
+            t.push(r[n.name].toString());
           break;
         }
       }
-    }
-    return `/${result.join("/")}`;
+    return "/".concat(t.join("/"));
   };
 }
-function compile(path) {
-  const tokens = [];
-  const regexp = /:(\w+)(<[\s?\w|]+>)?({\d+\,\d+})?([+*?])?/;
-  const parsedTokens = path.split("/").filter(Boolean);
-  for (let i = 0; i < parsedTokens.length; i++) {
-    const parsedToken = parsedTokens[i];
-    if (!parsedToken) {
+function y(e, r) {
+  var t = Object.keys(e);
+  if (Object.getOwnPropertySymbols) {
+    var n = Object.getOwnPropertySymbols(e);
+    r && (n = n.filter(function(i) {
+      return Object.getOwnPropertyDescriptor(e, i).enumerable;
+    })), t.push.apply(t, n);
+  }
+  return t;
+}
+function b(e) {
+  for (var r = 1; r < arguments.length; r++) {
+    var t = arguments[r] != null ? arguments[r] : {};
+    r % 2 ? y(Object(t), !0).forEach(function(n) {
+      P(e, n, t[n]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : y(Object(t)).forEach(function(n) {
+      Object.defineProperty(e, n, Object.getOwnPropertyDescriptor(t, n));
+    });
+  }
+  return e;
+}
+function P(e, r, t) {
+  return (r = w(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e;
+}
+function w(e) {
+  var r = k(e, "string");
+  return typeof r == "symbol" ? r : r + "";
+}
+function k(e, r) {
+  if (typeof e != "object" || !e) return e;
+  var t = e[Symbol.toPrimitive];
+  if (t !== void 0) {
+    var n = t.call(e, r);
+    if (typeof n != "object") return n;
+    throw new TypeError("@@toPrimitive must return a primitive value.");
+  }
+  return (r === "string" ? String : Number)(e);
+}
+function j(e) {
+  const r = [], t = /:(\w+)(<[\s?\w|]+>)?({\d+,\d+})?([+*?])?/, n = e.split("/").filter(Boolean);
+  for (let i = 0; i < n.length; i++) {
+    const a = n[i];
+    if (!a)
       continue;
-    }
-    const parameters = getTokenParameters(parsedToken.match(regexp));
-    if (!parameters) {
-      tokens.push({
+    const l = h(a.match(t));
+    if (!l) {
+      r.push({
         type: "const",
-        name: parsedToken,
+        name: a,
         payload: void 0
       });
       continue;
     }
     const {
-      arrayProps,
-      genericProps,
-      modificator,
-      name
-    } = parameters;
-    if (!name) {
-      throw new Error(`Invalid path: "${path}". Name for argument must be provided`);
-    }
-    const token = {
+      arrayProps: c,
+      genericProps: o,
+      modificator: m,
+      name: u
+    } = l;
+    if (!u)
+      throw new Error('Invalid path: "'.concat(e, '". Name for argument must be provided'));
+    const s = {
       type: "parameter",
-      name,
+      name: u,
       payload: {
-        required: true
+        required: !0
       }
     };
-    if (genericProps && genericProps === "number") {
-      token.payload.genericProps = {
-        type: "number"
-      };
-    }
-    if (genericProps && genericProps.includes("|")) {
-      token.payload.genericProps = {
-        type: "union",
-        items: genericProps.split("|")
-      };
-    }
-    switch (modificator) {
+    switch (o && o === "number" && (s.payload.genericProps = {
+      type: "number"
+    }), o && o.includes("|") && (s.payload.genericProps = {
+      type: "union",
+      items: o.split("|")
+    }), m) {
       case "*": {
-        token.payload.arrayProps = {};
+        s.payload.arrayProps = {};
         break;
       }
       case "+": {
-        token.payload.arrayProps = {
+        s.payload.arrayProps = {
           min: 1
         };
         break;
       }
       case "?": {
-        token.payload.required = false;
+        s.payload.required = !1;
         break;
       }
     }
-    if (arrayProps) {
-      token.payload.arrayProps = {
-        ...token.payload.arrayProps,
-        min: arrayProps[0],
-        max: arrayProps[1]
-      };
-    }
-    tokens.push(token);
+    c && (s.payload.arrayProps = b(b({}, s.payload.arrayProps), {}, {
+      min: c[0],
+      max: c[1]
+    })), r.push(s);
   }
   return {
     /**
      * @param input Input path
      * @returns `{ path: string; params: Params }` | `null`
      */
-    parse: prepareParser(tokens),
+    parse: g(r),
     /**
      * @param params Route parameters
      * @returns string
      */
-    build: prepareBuilder(tokens)
+    build: v(r)
   };
 }
+const O = {
+  express: [[/:id<.+>/g, ":id"], [/:id\+/g, "*id"], [/:id\*/g, "*id"], [/:id\{.+\}/g, "*id"], [/([a-zA-Z0-9:/_.]+)\/([*:])id\?/g, "$1{/$2id}"], [/([*:])id\?/g, "{$1id}"]]
+};
+function S(e, r) {
+  switch (r) {
+    case "express": {
+      let t = e;
+      for (const [n, i] of O.express)
+        t.match(n) && (t = t.replace(n, i));
+      return t;
+    }
+  }
+}
 export {
-  compile
+  j as compile,
+  S as convertPath
 };

package/package.json

@@ -5,7 +5,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "private": false,
-  "version": "0.11.0",
+  "version": "1.0.0-rc.0",
   "description": "Paths with power of effector",
   "keywords": [
     "paths",
@@ -34,12 +34,12 @@
     "type": "git",
     "url": "git+https://github.com/movpushmov/argon-router.git"
   },
-  "scripts": {
-    "build": "vite build",
-    "test": "vitest run"
-  },
   "bugs": {
     "url": "https://github.com/movpushmov/argon-router/issues"
   },
-  "gitHead": "0180f75dbbc73a123e706ff48961f8e57d57ce65"
-}
+  "gitHead": "9832d6cd282d6abd33c26ba4d03b9a1176110fc4",
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest run"
+  }
+}