@argon-router/paths 0.6.0 → 0.6.1

package/README.md

@@ -3,7 +3,7 @@
 Exteremly customizable paths without a headache
 
 > [!WARNING]
-> argon-router is extermely unstable & maybe buggy. DO NOT USE IN PRODUCTION!
+> 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
 
@@ -13,6 +13,7 @@ For additional information, guides and api reference visit [documentation site](
 
 - [@argon-router/core](https://www.npmjs.com/package/@argon-router/core)
 - [@argon-router/react](https://www.npmjs.com/package/@argon-router/react)
+- [@argon-router/paths](https://www.npmjs.com/package/@argon-router/paths)
 
 ## Installation
 
@@ -64,7 +65,7 @@ npm i @argon-router/paths
 '/:id<hello|world>'; // same as '/hello', '/world' and not '/test'
 ```
 
-- Length for parameter
+- Ranges for parameter
 
 ```ts
 '/:id{2,3}'; // same as '/test/test', '/test/test/test' and not '/test'

package/dist/index.d.ts

@@ -1,77 +1,101 @@
 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
+/**
+ * @param path Route path
+ * @description compiles route and give two functions: build (from params to string) & parse (validate from string and get params)
+ * @returns { build: Builder<Params>; parse: Parser<Params>; }
+     * @example ```ts
+     * import { compile } from '@argon-router/paths';
+     *
+     * // without params
+     * const { parse, build } = compile('/profile');
+     *
+     * console.log(parse('/profile')) // { path: '/profile', params: null }
+     * console.log(parse('/test')) // null
+     *
+     * console.log(build()) // '/profile'
+     *
+     * // with params
+     * const { parse, build } = compile('/:id');
+     *
+     * console.log(parse('/movpushmov')) // { path: '/profile', params: { id: 'movpushmov' } }
+     * console.log(parse('/')) // null
+     *
+     * console.log(build({ id: 'movpushmov' })) // '/movpushmov'
+     * ```
      */
-    build: Builder<Params>;
-};
+ 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 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;
-};
+ declare type Parameter<Name extends string, Payload> = {
+     [k in Name]: Payload;
+ };
 
-export declare type Parser<T> = (path: string) => {
-    path: string;
-    params: T;
-} | null;
+ 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>>;
+ /**
+  * @description Extracts the parameters from a URL string.
+  * @example ```ts
+  * 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 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 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 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 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 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;
+ 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 { }
+ export { }

package/package.json

@@ -5,7 +5,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "private": false,
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Paths with power of effector",
   "keywords": [
     "paths",
@@ -41,5 +41,5 @@
   "bugs": {
     "url": "https://github.com/movpushmov/argon-router/issues"
   },
-  "gitHead": "02a833234ffa6ca8a6d4704634f73d2451e573d0"
+  "gitHead": "7f4fbed2048af77d3087cc608fb2fe30c9991d9b"
 }