@uxf/router 3.0.0-beta.2 → 3.0.0-beta.3

package/README.md

@@ -20,21 +20,33 @@ interface RouteList {
     "blog/detail": { id: number };
 }
 
-const router = createRouter<RouteList>({
+export default createRouter<RouteList>({
     index: "/",
     "admin/index": "/admin",
     "blog/detail": "/blog/[id]",
 });
-
-export const { route, routeToUrl, sitemapGenerator } = router;
 ```
 
 ```ts
 // routes/index.ts
 
-export * from "./routes"
-export type GetServerSideProps<Route extends keyof RouteList> = UxfGetServerSideProps<RouteList, Route>;
-export type GetStaticProps<Route extends keyof RouteList> = UxfGetStaticProps<RouteList, Route>;
+import router, { RouteList } from "./routes";
+import { UxfGetServerSideProps, UxfGetStaticProps } from "@uxf/router";
+import { PreviewData as NextPreviewData } from "next/types";
+
+export const { route, routeToUrl, sitemapGenerator } = router;
+
+export type GetStaticProps<
+    Route extends keyof RouteList,
+    Props extends { [key: string]: any } = { [key: string]: any },
+    PreviewData extends NextPreviewData = NextPreviewData,
+    > = UxfGetStaticProps<RouteList, Route, Props, PreviewData>;
+
+export type GetServerSideProps<
+    Route extends keyof RouteList,
+    Props extends { [key: string]: any } = { [key: string]: any },
+    PreviewData extends NextPreviewData = NextPreviewData,
+    > = UxfGetServerSideProps<RouteList, Route, Props, PreviewData>;
 ```
 
 Add configuration to `tsconfig.json`
@@ -56,6 +68,7 @@ Add configuration to `tsconfig.json`
 
 ```tsx
 // pages/index.js
+
 import Link from "next/link";
 import { route } from "@app-routes";
 

package/helper.d.ts

@@ -1,2 +1,8 @@
-export declare const queryParamToString: (param?: string | string[]) => string;
-export declare const queryParamToNumber: (param?: string | string[]) => number;
+type ParamType = string | string[] | undefined;
+export declare function queryParamToString(param: ParamType): string | undefined;
+export declare function queryParamToStringStrict(param: ParamType): string;
+export declare function queryParamToBoolean(param: ParamType): boolean | undefined;
+export declare function queryParamToBooleanStrict(param: ParamType): boolean;
+export declare function queryParamToNumber(param: ParamType): number | undefined;
+export declare function queryParamToNumberStrict(param: ParamType): number;
+export {};

package/helper.js

@@ -1,10 +1,54 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryParamToNumber = exports.queryParamToString = void 0;
-var queryParamToString = function (param) { return (typeof param === "string" ? param : ""); };
+exports.queryParamToNumberStrict = exports.queryParamToNumber = exports.queryParamToBooleanStrict = exports.queryParamToBoolean = exports.queryParamToStringStrict = exports.queryParamToString = void 0;
+function queryParamToString(param) {
+    if (Array.isArray(param))
+        throw new Error("Query parameter is array. Should be string.");
+    return param;
+}
 exports.queryParamToString = queryParamToString;
-var queryParamToNumber = function (param) {
-    return typeof param === "string" ? parseInt(param, 10) : 0;
-};
+function queryParamToStringStrict(param) {
+    var paramOrUndefined = queryParamToString(param);
+    if (paramOrUndefined === undefined)
+        throw new Error("Parameter not found.");
+    return paramOrUndefined;
+}
+exports.queryParamToStringStrict = queryParamToStringStrict;
+function queryParamToBoolean(param) {
+    if (Array.isArray(param))
+        throw new Error("Query parameter is array. Should be string.");
+    if (param === undefined)
+        return undefined;
+    if (param === "true")
+        return true;
+    if (param === "false")
+        return false;
+    throw new Error("Parameter should be boolean (true|false). Given '".concat(param, "'."));
+}
+exports.queryParamToBoolean = queryParamToBoolean;
+function queryParamToBooleanStrict(param) {
+    var paramOrUndefined = queryParamToBoolean(param);
+    if (paramOrUndefined === undefined)
+        throw new Error("Parameter not found.");
+    return paramOrUndefined;
+}
+exports.queryParamToBooleanStrict = queryParamToBooleanStrict;
+function queryParamToNumber(param) {
+    if (Array.isArray(param))
+        throw new Error("Query parameter is array. Should be number.");
+    if (param === undefined)
+        return undefined;
+    var numberParam = Number.parseInt(param, 10);
+    if (Number.isNaN(numberParam))
+        throw new Error("Query parameter is NaN. Should be number.");
+    return numberParam;
+}
 exports.queryParamToNumber = queryParamToNumber;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2hlbHBlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBTyxJQUFNLGtCQUFrQixHQUFHLFVBQUMsS0FBeUIsSUFBYSxPQUFBLENBQUMsT0FBTyxLQUFLLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUF4QyxDQUF3QyxDQUFDO0FBQXJHLFFBQUEsa0JBQWtCLHNCQUFtRjtBQUUzRyxJQUFNLGtCQUFrQixHQUFHLFVBQUMsS0FBeUI7SUFDeEQsT0FBQSxPQUFPLEtBQUssS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFBbkQsQ0FBbUQsQ0FBQztBQUQzQyxRQUFBLGtCQUFrQixzQkFDeUIifQ==
+function queryParamToNumberStrict(param) {
+    var paramOrUndefined = queryParamToNumber(param);
+    if (paramOrUndefined === undefined)
+        throw new Error("Parameter not found.");
+    return paramOrUndefined;
+}
+exports.queryParamToNumberStrict = queryParamToNumberStrict;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2hlbHBlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQSxTQUFnQixrQkFBa0IsQ0FBQyxLQUFnQjtJQUMvQyxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDO1FBQUUsTUFBTSxJQUFJLEtBQUssQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO0lBRXpGLE9BQU8sS0FBSyxDQUFDO0FBQ2pCLENBQUM7QUFKRCxnREFJQztBQUVELFNBQWdCLHdCQUF3QixDQUFDLEtBQWdCO0lBQ3JELElBQU0sZ0JBQWdCLEdBQUcsa0JBQWtCLENBQUMsS0FBSyxDQUFDLENBQUM7SUFFbkQsSUFBSSxnQkFBZ0IsS0FBSyxTQUFTO1FBQUUsTUFBTSxJQUFJLEtBQUssQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDO0lBRTVFLE9BQU8sZ0JBQWdCLENBQUM7QUFDNUIsQ0FBQztBQU5ELDREQU1DO0FBRUQsU0FBZ0IsbUJBQW1CLENBQUMsS0FBZ0I7SUFDaEQsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQztRQUFFLE1BQU0sSUFBSSxLQUFLLENBQUMsNkNBQTZDLENBQUMsQ0FBQztJQUV6RixJQUFJLEtBQUssS0FBSyxTQUFTO1FBQUUsT0FBTyxTQUFTLENBQUM7SUFDMUMsSUFBSSxLQUFLLEtBQUssTUFBTTtRQUFFLE9BQU8sSUFBSSxDQUFDO0lBQ2xDLElBQUksS0FBSyxLQUFLLE9BQU87UUFBRSxPQUFPLEtBQUssQ0FBQztJQUVwQyxNQUFNLElBQUksS0FBSyxDQUFDLDJEQUFvRCxLQUFLLE9BQUksQ0FBQyxDQUFDO0FBQ25GLENBQUM7QUFSRCxrREFRQztBQUVELFNBQWdCLHlCQUF5QixDQUFDLEtBQWdCO0lBQ3RELElBQU0sZ0JBQWdCLEdBQUcsbUJBQW1CLENBQUMsS0FBSyxDQUFDLENBQUM7SUFFcEQsSUFBSSxnQkFBZ0IsS0FBSyxTQUFTO1FBQUUsTUFBTSxJQUFJLEtBQUssQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDO0lBRTVFLE9BQU8sZ0JBQWdCLENBQUM7QUFDNUIsQ0FBQztBQU5ELDhEQU1DO0FBRUQsU0FBZ0Isa0JBQWtCLENBQUMsS0FBZ0I7SUFDL0MsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQztRQUFFLE1BQU0sSUFBSSxLQUFLLENBQUMsNkNBQTZDLENBQUMsQ0FBQztJQUV6RixJQUFJLEtBQUssS0FBSyxTQUFTO1FBQUUsT0FBTyxTQUFTLENBQUM7SUFFMUMsSUFBTSxXQUFXLEdBQUcsTUFBTSxDQUFDLFFBQVEsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFFL0MsSUFBSSxNQUFNLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQztRQUFFLE1BQU0sSUFBSSxLQUFLLENBQUMsMkNBQTJDLENBQUMsQ0FBQztJQUU1RixPQUFPLFdBQVcsQ0FBQztBQUN2QixDQUFDO0FBVkQsZ0RBVUM7QUFFRCxTQUFnQix3QkFBd0IsQ0FBQyxLQUFnQjtJQUNyRCxJQUFNLGdCQUFnQixHQUFHLGtCQUFrQixDQUFDLEtBQUssQ0FBQyxDQUFDO0lBRW5ELElBQUksZ0JBQWdCLEtBQUssU0FBUztRQUFFLE1BQU0sSUFBSSxLQUFLLENBQUMsc0JBQXNCLENBQUMsQ0FBQztJQUU1RSxPQUFPLGdCQUFnQixDQUFDO0FBQzVCLENBQUM7QUFORCw0REFNQyJ9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uxf/router",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.3",
   "description": "UXF Router",
   "author": "UXFans <dev@uxf.cz>",
   "homepage": "https://gitlab.com/uxf-npm/router#readme",
@@ -51,7 +51,7 @@
     "eslint-plugin-prettier": "^4.0.0"
   },
   "peerDependencies": {
-    "react": "^18",
-    "react-dom": "^18"
+    "react": "17 - 18",
+    "react-dom": "17 - 18"
   }
 }

package/router.d.ts

@@ -4,7 +4,7 @@ export type FunctionParametersGenerator<RouteList> = {
     [K in keyof RouteList]: RouteList[K] extends null ? [K] : [K, RouteList[K]];
 }[keyof RouteList];
 type RouteFunction<RouteList> = (...args: FunctionParametersGenerator<RouteList>) => LinkProps["href"];
-type RouteToUrlFunction<RouteList> = (...args: FunctionParametersGenerator<RouteList>) => string | null;
+type RouteToUrlFunction<RouteList> = (...args: FunctionParametersGenerator<RouteList>) => string;
 type Router<RouteList> = {
     route: RouteFunction<RouteList>;
     routeToUrl: RouteToUrlFunction<RouteList>;

package/router.js

@@ -15,6 +15,9 @@ function createRouter(routes) {
         routeToUrl: function (route, params) {
             if (params === void 0) { params = undefined; }
             var pathname = routes[route];
+            if (!pathname) {
+                throw new Error("Route '".concat(String(route), "' not found."));
+            }
             var restParams = {};
             Object.keys(params !== null && params !== void 0 ? params : {}).forEach(function (key) {
                 var value = params[key];
@@ -35,4 +38,4 @@ function createRouter(routes) {
     };
 }
 exports.createRouter = createRouter;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3JvdXRlci50c3giXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEseUJBQStCO0FBRS9CLHVEQUFrRjtBQWdCbEYsU0FBZ0IsWUFBWSxDQUFZLE1BQTRDO0lBQ2hGLE9BQU87UUFDSCxLQUFLLEVBQUUsVUFBQyxLQUFLLEVBQUUsTUFBa0I7WUFBbEIsdUJBQUEsRUFBQSxrQkFBa0I7WUFBSyxPQUFBLENBQUM7Z0JBQ25DLFFBQVEsRUFBRSxNQUFNLENBQUMsS0FBSyxDQUFDO2dCQUN2QixLQUFLLEVBQUUsTUFBTSxhQUFOLE1BQU0sY0FBTixNQUFNLEdBQUksSUFBSTthQUN4QixDQUFDO1FBSG9DLENBR3BDO1FBQ0YsVUFBVSxFQUFFLFVBQUMsS0FBSyxFQUFFLE1BQWtCO1lBQWxCLHVCQUFBLEVBQUEsa0JBQWtCO1lBQ2xDLElBQUksUUFBUSxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUM3QixJQUFNLFVBQVUsR0FBUSxFQUFFLENBQUM7WUFDM0IsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLGFBQU4sTUFBTSxjQUFOLE1BQU0sR0FBSSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsVUFBQyxHQUFHO2dCQUNsQyxJQUFNLEtBQUssR0FBSSxNQUFjLENBQUMsR0FBRyxDQUFDLENBQUM7Z0JBQ25DLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxXQUFJLEdBQUcsTUFBRyxDQUFDLEVBQUU7b0JBQy9CLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDLFdBQUksR0FBRyxNQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7aUJBQ2xEO3FCQUFNO29CQUNILFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxLQUFLLENBQUM7aUJBQzNCO1lBQ0wsQ0FBQyxDQUFDLENBQUM7WUFDSCxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtnQkFDcEMsUUFBUSxHQUFHLFVBQUcsUUFBUSxjQUFJLElBQUEsY0FBUyxFQUFDLFVBQVUsQ0FBQyxDQUFFLENBQUM7YUFDckQ7WUFDRCxPQUFPLFFBQVEsQ0FBQztRQUNwQixDQUFDO1FBQ0QsZ0JBQWdCLEVBQUUsSUFBQSx5Q0FBc0IsR0FBRTtRQUMxQyxNQUFNLFFBQUE7S0FDVCxDQUFDO0FBQ04sQ0FBQztBQXpCRCxvQ0F5QkMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3JvdXRlci50c3giXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEseUJBQStCO0FBRS9CLHVEQUFrRjtBQWdCbEYsU0FBZ0IsWUFBWSxDQUFZLE1BQTRDO0lBQ2hGLE9BQU87UUFDSCxLQUFLLEVBQUUsVUFBQyxLQUFLLEVBQUUsTUFBa0I7WUFBbEIsdUJBQUEsRUFBQSxrQkFBa0I7WUFBSyxPQUFBLENBQUM7Z0JBQ25DLFFBQVEsRUFBRSxNQUFNLENBQUMsS0FBSyxDQUFDO2dCQUN2QixLQUFLLEVBQUUsTUFBTSxhQUFOLE1BQU0sY0FBTixNQUFNLEdBQUksSUFBSTthQUN4QixDQUFDO1FBSG9DLENBR3BDO1FBQ0YsVUFBVSxFQUFFLFVBQUMsS0FBSyxFQUFFLE1BQWtCO1lBQWxCLHVCQUFBLEVBQUEsa0JBQWtCO1lBQ2xDLElBQUksUUFBUSxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUU3QixJQUFJLENBQUMsUUFBUSxFQUFFO2dCQUNYLE1BQU0sSUFBSSxLQUFLLENBQUMsaUJBQVUsTUFBTSxDQUFDLEtBQUssQ0FBQyxpQkFBYyxDQUFDLENBQUM7YUFDMUQ7WUFFRCxJQUFNLFVBQVUsR0FBUSxFQUFFLENBQUM7WUFDM0IsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLGFBQU4sTUFBTSxjQUFOLE1BQU0sR0FBSSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsVUFBQyxHQUFHO2dCQUNsQyxJQUFNLEtBQUssR0FBSSxNQUFjLENBQUMsR0FBRyxDQUFDLENBQUM7Z0JBQ25DLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxXQUFJLEdBQUcsTUFBRyxDQUFDLEVBQUU7b0JBQy9CLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDLFdBQUksR0FBRyxNQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7aUJBQ2xEO3FCQUFNO29CQUNILFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxLQUFLLENBQUM7aUJBQzNCO1lBQ0wsQ0FBQyxDQUFDLENBQUM7WUFDSCxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtnQkFDcEMsUUFBUSxHQUFHLFVBQUcsUUFBUSxjQUFJLElBQUEsY0FBUyxFQUFDLFVBQVUsQ0FBQyxDQUFFLENBQUM7YUFDckQ7WUFDRCxPQUFPLFFBQVEsQ0FBQztRQUNwQixDQUFDO1FBQ0QsZ0JBQWdCLEVBQUUsSUFBQSx5Q0FBc0IsR0FBRTtRQUMxQyxNQUFNLFFBQUE7S0FDVCxDQUFDO0FBQ04sQ0FBQztBQTlCRCxvQ0E4QkMifQ==