@argon-router/paths 0.6.0

package/LICENSE.MD

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Edward Gigolaev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# ☄️ argon-router/paths
+
+Exteremly customizable paths without a headache
+
+> [!WARNING]
+> argon-router is extermely unstable & maybe buggy. DO NOT USE IN PRODUCTION!
+
+## Documentation
+
+For additional information, guides and api reference visit [documentation site](https://movpushmov.dev/argon-router/)
+
+## Packages
+
+- [@argon-router/core](https://www.npmjs.com/package/@argon-router/core)
+- [@argon-router/react](https://www.npmjs.com/package/@argon-router/react)
+
+## Installation
+
+```
+npm i @argon-router/paths
+```
+
+## Supported types
+
+- String parameter
+
+```ts
+'/:id'; // same as '/something'
+```
+
+- String parameters array
+
+```ts
+'/:id+'; // same as '/something', '/something/went' and etc
+```
+
+- String parameters array with possible zero length
+
+```ts
+'/:id*'; // same as '/', '/something', '/something/went' and etc
+```
+
+- Nullable parameter
+
+```ts
+'/:id?'; // same as '/' and '/test'
+```
+
+- Generic parameter (numbers)
+
+```ts
+'/:id<number>'; // same as '/123' and not '/test'
+```
+
+- Nullable generic parameter (numbers)
+
+```ts
+'/:id<number>?'; // same as '/123', '/' and not '/test'
+```
+
+- Generic parameter (string literals)
+
+```ts
+'/:id<hello|world>'; // same as '/hello', '/world' and not '/test'
+```
+
+- Length for parameter
+
+```ts
+'/:id{2,3}'; // same as '/test/test', '/test/test/test' and not '/test'
+```

package/dist/index.cjs

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

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+export declare type Builder<T> = (params: T) => string;
+
+export declare function compile<T extends string, Params = ParseUrlParams<T>>(path: T): {
+    /**
+     * @param input Input path
+     * @returns `{ path: string; params: Params }` | `null`
+     */
+    parse: Parser<Params>;
+    /**
+     * @param params Route parameters
+     * @returns string
+     */
+    build: Builder<Params>;
+};
+
+declare type GenericType<T extends string> = T extends `number` ? number : T extends `${infer A}|${infer B}` ? Union<T> : T;
+
+declare type Parameter<Name extends string, Payload> = {
+    [k in Name]: Payload;
+};
+
+export declare type Parser<T> = (path: string) => {
+    path: string;
+    params: T;
+} | null;
+
+/**
+ * @description Extracts the parameters from a URL string.
+ * @example
+ *
+ * type Params = ParseUrlParams<'/:id/:name'>;
+ * //      ^----- { id: string, name: string }
+ *
+ * type Params = ParseUrlParams<'/:id+'>;
+ * //      ^----- { id: string[] }
+ *
+ * type Params = ParseUrlParams<'/:id*'>;
+ * //      ^----- { id: string[] }
+ *
+ * type Params = ParseUrlParams<'/:id?'>;
+ * //      ^----- { id?: string }
+ *
+ * type Params = ParseUrlParams<'/:id<number>+'>;
+ * //      ^----- { id: number[] }
+ *
+ * type Params = ParseUrlParams<'/:id<number>*'>;
+ * //      ^----- { id: number[] }
+ *
+ * type Params = ParseUrlParams<'/:id<number>'>;
+ * //      ^----- { id: number }
+ *
+ * type Params = ParseUrlParams<'/:id<hello|world>?'>;
+ * //      ^----- { id?: 'hello' | 'world' }
+ *
+ * type Params = ParseUrlParams<'/:id<hello|world>+'>;
+ * //      ^----- { id: ('hello' | 'world')[] }
+ *
+ * type Params = ParseUrlParams<'/'>;
+ * //      ^----- void
+ */
+export declare type ParseUrlParams<T extends string> = Unwrap<UrlParams<T>>;
+
+declare type Union<T extends string, Result = void> = T extends `${infer Start}|${infer Type}` ? Union<Type, Result extends void ? Start : Result | Start> : Result extends void ? T : Result | T;
+
+declare type Unwrap<Result extends UrlParams<any, void>> = {
+    [k in keyof Result]: Result[k];
+};
+
+declare type UrlParameter<T extends string> = T extends `:${infer Name}<${infer Type}>${infer Modificator}` ? Parameter<WithoutModificator<Name>, WithModificator<GenericType<Type>, T>> : T extends `:${infer Name}<${infer Type}>` ? Parameter<Name, GenericType<Type>> : T extends `:${infer Name}` ? Parameter<WithoutModificator<Name>, WithModificator<string, T>> : never;
+
+declare type UrlParams<T extends string, Result = void> = T extends `/:${infer Parameter}/${infer Route}` ? Result extends void ? UrlParams<`/${Route}`, UrlParameter<`:${Parameter}`>> : UrlParams<`/${Route}`, Result & UrlParameter<`:${Parameter}`>> : T extends `/:${infer Parameter}` ? Result extends void ? UrlParameter<`:${Parameter}`> : Result & UrlParameter<`:${Parameter}`> : T extends `/${infer Static}/${infer Next}` ? UrlParams<`/${Next}`, Result> : Result;
+
+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;
+
+declare type WithoutModificator<T extends string> = T extends `${infer K}{${infer Start},${infer End}}${infer Modificator}` ? K : T extends `${infer K}{${infer Start},${infer End}}` ? K : T extends `${infer K}?` ? K : T extends `${infer K}*` ? K : T extends `${infer K}+` ? K : T;
+
+export { }

package/dist/index.js

@@ -0,0 +1,248 @@
+function b(e) {
+  return (r) => {
+    const n = r.split("/").filter(Boolean);
+    let t = null;
+    function a(l, i) {
+      t || (t = {}), t[l] = i;
+    }
+    if (e.length === 0)
+      return n.length === 0 ? {
+        path: r,
+        params: null
+      } : null;
+    for (let l = 0; l < e.length; l++) {
+      let i = n[l];
+      const c = e[l];
+      switch (c.type) {
+        case "const": {
+          if (i !== c.name)
+            return null;
+          continue;
+        }
+        case "parameter": {
+          const {
+            arrayProps: f,
+            genericProps: o,
+            required: d
+          } = c.payload;
+          if (f) {
+            var u;
+            const p = [];
+            for (; i && p.length < ((s = f.max) !== null && s !== void 0 ? s : 1 / 0); ) {
+              var s;
+              switch (o == null ? void 0 : o.type) {
+                case "number": {
+                  if (isNaN(+i))
+                    return null;
+                  p.push(+i);
+                  break;
+                }
+                case "union": {
+                  if (!o.items.includes(i))
+                    return null;
+                  p.push(i);
+                  break;
+                }
+                default: {
+                  p.push(i);
+                  break;
+                }
+              }
+              i = n[l + p.length];
+            }
+            if (p.length < ((u = f.min) !== null && u !== void 0 ? u : 0) || n[l + p.length] && !e[l + 1])
+              return null;
+            a(c.name, p);
+            break;
+          }
+          if (d && !i)
+            return null;
+          if (!i) {
+            a(c.name, void 0);
+            continue;
+          }
+          switch (o == null ? void 0 : o.type) {
+            case "number": {
+              if (isNaN(+i))
+                return null;
+              a(c.name, +i);
+              break;
+            }
+            case "union": {
+              if (!o.items.includes(i))
+                return null;
+              a(c.name, i);
+              break;
+            }
+            default: {
+              a(c.name, i);
+              break;
+            }
+          }
+        }
+      }
+    }
+    return {
+      path: r,
+      params: t
+    };
+  };
+}
+function g(e) {
+  if (!e)
+    return null;
+  const r = e[1];
+  let n, t, a;
+  for (const u of e.slice(2))
+    if (u) {
+      if (u.includes("<")) {
+        n = u.replace("<", "").replace(">", "");
+        continue;
+      }
+      if (u.includes("{") && (t = u.replace("{", "").replace("}", "").split(",").map((s) => parseInt(s))), ["*", "?", "+"].includes(u)) {
+        a = u;
+        continue;
+      }
+    }
+  return {
+    name: r,
+    genericProps: n,
+    arrayProps: t,
+    modificator: a
+  };
+}
+function h(e) {
+  return (r) => {
+    const n = [];
+    if (e.length === 0)
+      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 a of r[t.name])
+              n.push(a.toString());
+          else
+            n.push(r[t.name].toString());
+          break;
+        }
+      }
+    return "/".concat(n.join("/"));
+  };
+}
+function m(e, r) {
+  var n = Object.keys(e);
+  if (Object.getOwnPropertySymbols) {
+    var t = Object.getOwnPropertySymbols(e);
+    r && (t = t.filter(function(a) {
+      return Object.getOwnPropertyDescriptor(e, a).enumerable;
+    })), n.push.apply(n, t);
+  }
+  return n;
+}
+function y(e) {
+  for (var r = 1; r < arguments.length; r++) {
+    var n = arguments[r] != null ? arguments[r] : {};
+    r % 2 ? m(Object(n), !0).forEach(function(t) {
+      v(e, t, n[t]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(n)) : m(Object(n)).forEach(function(t) {
+      Object.defineProperty(e, t, Object.getOwnPropertyDescriptor(n, t));
+    });
+  }
+  return e;
+}
+function v(e, r, n) {
+  return (r = P(r)) in e ? Object.defineProperty(e, r, { value: n, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = n, e;
+}
+function P(e) {
+  var r = w(e, "string");
+  return typeof r == "symbol" ? r : r + "";
+}
+function w(e, r) {
+  if (typeof e != "object" || !e) return e;
+  var n = e[Symbol.toPrimitive];
+  if (n !== void 0) {
+    var t = n.call(e, r);
+    if (typeof t != "object") return t;
+    throw new TypeError("@@toPrimitive must return a primitive value.");
+  }
+  return (r === "string" ? String : Number)(e);
+}
+function k(e) {
+  const r = [], n = /:(\w+)(<[\w|]+>)?({\d+\,\d+})?([+*?])?/, t = e.split("/").filter(Boolean);
+  for (let a = 0; a < t.length; a++) {
+    const u = t[a];
+    if (!u)
+      continue;
+    const s = g(u.match(n));
+    if (!s) {
+      r.push({
+        type: "const",
+        name: u,
+        payload: void 0
+      });
+      continue;
+    }
+    const {
+      arrayProps: l,
+      genericProps: i,
+      modificator: c,
+      name: f
+    } = s;
+    if (!f)
+      throw new Error('Invalid path: "'.concat(e, '". Name for argument must be provided'));
+    const o = {
+      type: "parameter",
+      name: f,
+      payload: {
+        required: !0
+      }
+    };
+    switch (i && i === "number" && (o.payload.genericProps = {
+      type: "number"
+    }), i && i.includes("|") && (o.payload.genericProps = {
+      type: "union",
+      items: i.split("|")
+    }), c) {
+      case "*": {
+        o.payload.arrayProps = {};
+        break;
+      }
+      case "+": {
+        o.payload.arrayProps = {
+          min: 1
+        };
+        break;
+      }
+      case "?": {
+        o.payload.required = !1;
+        break;
+      }
+    }
+    l && (o.payload.arrayProps = y(y({}, o.payload.arrayProps), {}, {
+      min: l[0],
+      max: l[1]
+    })), r.push(o);
+  }
+  return {
+    /**
+     * @param input Input path
+     * @returns `{ path: string; params: Params }` | `null`
+     */
+    parse: b(r),
+    /**
+     * @param params Route parameters
+     * @returns string
+     */
+    build: h(r)
+  };
+}
+export {
+  k as compile
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@argon-router/paths",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "private": false,
+  "version": "0.6.0",
+  "description": "Paths with power of effector",
+  "keywords": [
+    "paths",
+    "argon",
+    "argon-router"
+  ],
+  "author": "movpushmov",
+  "homepage": "https://github.com/movpushmov/argon-router#readme",
+  "license": "MIT",
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "repository": {
+    "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": "02a833234ffa6ca8a6d4704634f73d2451e573d0"
+}