@uxf/router 11.78.0 → 11.80.2

package/README.md

@@ -52,7 +52,7 @@ export default createRouter(
 // routes/index.ts
 
 import router from "./routes";
-import { UxfGetServerSideProps, UxfGetStaticProps } from "@uxf/router";
+import { UxfGetServerSideProps, UxfGetStaticProps, ExtractSchema } from "@uxf/router";
 import { PreviewData as NextPreviewData } from "next/types";
 
 export const {
@@ -62,6 +62,8 @@ export const {
     useQueryParamsStatic 
 } = router;
 
+export type GetRouteSchema<K extends keyof RouteList> = ExtractSchema<RouteList[K]>;
+
 export type GetStaticProps<
     Route extends keyof RouteList,
     Props extends { [key: string]: any } = { [key: string]: any },
@@ -175,6 +177,16 @@ const routeMatcher = mergeRouteMatchers([
 ]);
 ```
 
+## Type-safe route params
+
+```tsx
+import { GetRouteSchema } from "@app-routes";
+
+const blogProps: GetRouteSchema<"blog/detail"> = {
+    id: 1,
+}
+```
+
 ## GetStaticProps
 
 ```tsx

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uxf/router",
-    "version": "11.78.0",
+    "version": "11.80.2",
     "description": "UXF Router",
     "author": "UXFans <dev@uxf.cz>",
     "homepage": "https://gitlab.com/uxf-npm/router#readme",

package/{router.d.ts → router/router.d.ts}

@@ -3,7 +3,13 @@ import { NextRouter } from "next/router";
 import { Infer, Struct } from "superstruct";
 import { SitemapGeneratorOptions, SitemapGeneratorType, SitemapRouteResolvers } from "./sitemap-generator";
 import { QueryParams, RoutesDefinition } from "./types";
-type ExtractSchema<T> = T extends {
+interface TransitionOptions {
+    shallow?: boolean;
+    locale?: string | false;
+    scroll?: boolean;
+    unstable_skipClientCache?: boolean;
+}
+export type ExtractSchema<T> = T extends {
     schema: Struct<infer U, any>;
 } ? U : null;
 type Options = {
@@ -23,8 +29,8 @@ type RouteToUrlFunction<Locales extends string[], RouteList extends RoutesDefini
 type QueryParamsResult<Nullable extends boolean, T extends keyof RouteList, Locales extends string[], RouteList extends RoutesDefinition<Locales>> = [
     Nullable extends true ? Infer<NonNullable<RouteList[T]["schema"]>> | null : Infer<NonNullable<RouteList[T]["schema"]>>,
     {
-        push: (params: Infer<NonNullable<RouteList[T]["schema"]>>) => Promise<boolean>;
-        replace: (params: Infer<NonNullable<RouteList[T]["schema"]>>) => Promise<boolean>;
+        push: (params: Infer<NonNullable<RouteList[T]["schema"]>>, options?: TransitionOptions) => Promise<boolean>;
+        replace: (params: Infer<NonNullable<RouteList[T]["schema"]>>, options?: TransitionOptions) => Promise<boolean>;
     }
 ];
 type SimplyNextRouter = Pick<NextRouter, "pathname" | "query" | "isReady">;

package/{router.js → router/router.js}

@@ -126,8 +126,8 @@ function createRouter(routes, routerOptions) {
             return [
                 (0, superstruct_1.mask)(router.query, schema),
                 {
-                    push: (params) => router.push(routeToUrl(routeName, params, {})),
-                    replace: (params) => router.replace(routeToUrl(routeName, params, {})),
+                    push: (params, options) => router.push(routeToUrl(routeName, params, {}), undefined, options),
+                    replace: (params, options) => router.replace(routeToUrl(routeName, params, {}), undefined, options),
                 },
             ];
         },

package/router/routes-check/__test__/app/app-directory/[param]/page.js

@@ -0,0 +1 @@
+"use strict";

package/router/routes-check/__test__/app/app-directory/page.js

@@ -0,0 +1 @@
+"use strict";

package/router/routes-check/__test__/pages/index.js

@@ -0,0 +1 @@
+"use strict";

package/router/routes-check/__test__/pages/product/[id].js

@@ -0,0 +1 @@
+"use strict";

package/router/routes-check/__test__/pages/product/edit.js

@@ -0,0 +1 @@
+"use strict";

package/router/routes-check/__test__/pages/product/index.js

@@ -0,0 +1 @@
+"use strict";

package/router/routes-check/__test__/pages/product-2/[id]/index.js

@@ -0,0 +1 @@
+"use strict";