@lexriver/dome 2.0.4 → 2.0.5

package/README.md

@@ -1507,9 +1507,9 @@ Parameters:
 Where `RouteAction` type is:
 ```typescript
 export type RouteAction = (
-    params:{[key:string]:string|number}, // parameters from url path
-    url:string, // url path without query string
-    scrollToPreviousPositionAsync:()=>Promise<void>, // this function can be called to scroll to previous page position
+    params:{[key:string]:string}, // unannotated parameters from the URL path
+    url:string, // URL path without query string
+    scrollToPreviousPositionAsync:()=>Promise<void>, // call this to scroll to the previous page position
     query:{[key:string]:string} // query parameters from window.location.search
     ) => void|Promise<void>
 ```
@@ -1529,28 +1529,23 @@ DomeRouter.onRoute('/product/:productId', true, (params, url) => {
 })
 ```
 
-A type of parameter can be added, for example :
+For numeric parameters, use `onTypedRoute`. This opt-in API types route values as `string | number`, because TypeScript 3.9 cannot infer parameter types from route-string annotations.
+
 ```typescript
-DomeRouter.onRoute('/product/:productId<number>', true, (params, url) => {
-    // for example for '/product/456' the output will be
-    // 'productId=', 456, number
-    console.log('productId=', params.productId, typeof params.productId) 
+DomeRouter.onTypedRoute('/product/:productId<number>', true, (params, url) => {
+    // For '/product/456', productId is 456 at runtime.
+    if(typeof params.productId === 'number') {
+        console.log('productId=', params.productId)
+    }
 })
 ```
 
-A possible types are:
+The supported numeric annotations are:
 * `int` - uses `parseInt(p)` internally
 * `float` - uses `parseFloat(p)` internally
-* `number` - uses `Number(p)` intrenally
-But there is no validation for paramters, so the result of specified function will be returned.
+* `number` - uses `Number(p)` internally
 
-```typescript
-DomeRouter.onRoute('/product/:productId<int>', true, (params, url) => {
-    // for example for '/product/456' the output will be
-    // 'productId=', 456, number
-    console.log('productId=', params.productId, typeof params.productId) 
-})
-```
+There is no numeric validation, so the result of the corresponding conversion function is returned. Existing unannotated routes should continue using `onRoute`; their parameters remain strings without casts.
 
 <br/>
 

package/out/index.cjs

@@ -887,12 +887,19 @@ var DomeRouter;
     executeAsync(url, getScrollPositionForUrl(url));
   }
   DomeRouter2.resolveUrl = resolveUrl;
-  function onRoute(route, exactMatch, action) {
+  function addRoute(route, exactMatch, action) {
     if (route[0] !== "/") throw new Error("Please provide correct route. route=" + route);
-    let routeSlices = getRouteSlices(route);
+    const routeSlices = getRouteSlices(route);
     allRoutes.push({ routeSlices, exactMatch, action });
   }
+  function onRoute(route, exactMatch, action) {
+    addRoute(route, exactMatch, action);
+  }
   DomeRouter2.onRoute = onRoute;
+  function onTypedRoute(route, exactMatch, action) {
+    addRoute(route, exactMatch, action);
+  }
+  DomeRouter2.onTypedRoute = onTypedRoute;
   function getRouteSlices(route) {
     return route.split("/").map((x) => decodeURIComponent(x));
   }

package/out/index.mjs

@@ -2035,12 +2035,19 @@ var DomeRouter;
     executeAsync(url, getScrollPositionForUrl(url));
   }
   DomeRouter2.resolveUrl = resolveUrl;
-  function onRoute(route, exactMatch, action) {
+  function addRoute(route, exactMatch, action) {
     if (route[0] !== "/") throw new Error("Please provide correct route. route=" + route);
-    let routeSlices = getRouteSlices(route);
+    const routeSlices = getRouteSlices(route);
     allRoutes.push({ routeSlices, exactMatch, action });
   }
+  function onRoute(route, exactMatch, action) {
+    addRoute(route, exactMatch, action);
+  }
   DomeRouter2.onRoute = onRoute;
+  function onTypedRoute(route, exactMatch, action) {
+    addRoute(route, exactMatch, action);
+  }
+  DomeRouter2.onTypedRoute = onTypedRoute;
   function getRouteSlices(route) {
     return route.split("/").map((x) => decodeURIComponent(x));
   }

package/out/src/DomeRouter.d.mts

@@ -1,8 +1,14 @@
-export type RouteAction = (params: {
+export type RouteParameters = {
+    [key: string]: string;
+};
+export type TypedRouteParameters = {
     [key: string]: string | number;
-}, url: string, scrollToPreviousPositionAsync: () => Promise<void>, query: {
+};
+type RouteCallback<Parameters> = (params: Parameters, url: string, scrollToPreviousPositionAsync: () => Promise<void>, query: {
     [key: string]: string;
 }) => void | Promise<void>;
+export type RouteAction = RouteCallback<RouteParameters>;
+export type TypedRouteAction = RouteCallback<TypedRouteParameters>;
 export declare namespace DomeRouter {
     let maxHistoryUrlsCount: number;
     function navigate(url: string): void;
@@ -16,7 +22,10 @@ export declare namespace DomeRouter {
      */
     function getPreviousPageUrl(previousPageIndex?: number): string | undefined;
     function resolveUrl(url?: string, addToHistory?: boolean): void;
+    /** Register a route whose unannotated parameters are strings. */
     function onRoute(route: string, exactMatch: boolean, action: RouteAction): void;
+    /** Register a route using <int>, <float>, or <number> parameter annotations. */
+    function onTypedRoute(route: string, exactMatch: boolean, action: TypedRouteAction): void;
     function onNotFound(action: () => void): void;
     /**
      * Check if url matched route.
@@ -30,3 +39,4 @@ export declare namespace DomeRouter {
      */
     function checkUrlMatchRouteAndGetParameters(url: string, route: string, exactMatch?: boolean): Object | undefined;
 }
+export {};

package/out/src/DomeRouter.d.ts

@@ -1,8 +1,14 @@
-export type RouteAction = (params: {
+export type RouteParameters = {
+    [key: string]: string;
+};
+export type TypedRouteParameters = {
     [key: string]: string | number;
-}, url: string, scrollToPreviousPositionAsync: () => Promise<void>, query: {
+};
+type RouteCallback<Parameters> = (params: Parameters, url: string, scrollToPreviousPositionAsync: () => Promise<void>, query: {
     [key: string]: string;
 }) => void | Promise<void>;
+export type RouteAction = RouteCallback<RouteParameters>;
+export type TypedRouteAction = RouteCallback<TypedRouteParameters>;
 export declare namespace DomeRouter {
     let maxHistoryUrlsCount: number;
     function navigate(url: string): void;
@@ -16,7 +22,10 @@ export declare namespace DomeRouter {
      */
     function getPreviousPageUrl(previousPageIndex?: number): string | undefined;
     function resolveUrl(url?: string, addToHistory?: boolean): void;
+    /** Register a route whose unannotated parameters are strings. */
     function onRoute(route: string, exactMatch: boolean, action: RouteAction): void;
+    /** Register a route using <int>, <float>, or <number> parameter annotations. */
+    function onTypedRoute(route: string, exactMatch: boolean, action: TypedRouteAction): void;
     function onNotFound(action: () => void): void;
     /**
      * Check if url matched route.
@@ -30,3 +39,4 @@ export declare namespace DomeRouter {
      */
     function checkUrlMatchRouteAndGetParameters(url: string, route: string, exactMatch?: boolean): Object | undefined;
 }
+export {};

package/out/src/DomeRouter.mjs

@@ -88,13 +88,22 @@ export var DomeRouter;
         executeAsync(url, getScrollPositionForUrl(url));
     }
     DomeRouter.resolveUrl = resolveUrl;
-    function onRoute(route, exactMatch, action) {
+    function addRoute(route, exactMatch, action) {
         if (route[0] !== '/')
             throw new Error('Please provide correct route. route=' + route);
-        let routeSlices = getRouteSlices(route);
+        const routeSlices = getRouteSlices(route);
         allRoutes.push({ routeSlices, exactMatch, action });
     }
+    /** Register a route whose unannotated parameters are strings. */
+    function onRoute(route, exactMatch, action) {
+        addRoute(route, exactMatch, action);
+    }
     DomeRouter.onRoute = onRoute;
+    /** Register a route using <int>, <float>, or <number> parameter annotations. */
+    function onTypedRoute(route, exactMatch, action) {
+        addRoute(route, exactMatch, action);
+    }
+    DomeRouter.onTypedRoute = onTypedRoute;
     function getRouteSlices(route) {
         //return route.split('/').filter(x => x.length>0).map(x => decodeURIComponent(x))
         return route.split('/').map(x => decodeURIComponent(x));

package/package.json

@@ -1,7 +1,7 @@
 {
     "sideEffects": false,
     "name": "@lexriver/dome",
-    "version": "2.0.4",
+    "version": "2.0.5",
     "description": "DOM manipulator",
     "type": "module",
     "types": "./out/src/index.d.ts",