@uxf/router 2.1.2 → 2.2.0-beta.2

package/README.md

@@ -5,43 +5,36 @@
 ```
 yarn add @uxf/router
 ```
-or
-```
-npm install @uxf/router --save
-```
 
 - Create `routes` directory
 - Create `routes.ts` and `index.ts` inside `routes` directory:
 
 ```ts
 // routes/routes.ts
-import { Router as UxfRouter } from "@uxf/router";
 
-export interface RouteList {
+import { createRouter } from "@uxf/router";
+
+interface RouteList {
     index: null;
-    "blog": null;
-    "blog-article": { articleId: string };
+    "admin/index": { param1?: number };
+    "blog/detail": { id: number };
 }
 
-export const router = new UxfRouter<RouteList>({
+const router = createRouter<RouteList>({
     index: "/",
-    "blog": "/blog",
-    "blog-article": "/blog/[articleId]",
+    "admin/index": "/admin",
+    "blog/detail": "/blog/[id]",
 });
+
+export const { route, routeToUrl, sitemapGenerator } = router;
 ```
 
 ```ts
 // routes/index.ts
-import { RouteList, router } from "./routes";
-import { PropsGenerator, FunctionParametersGenerator, UxfNextPage } from "@uxf/router";
-
-export const Link = router.getLink();
-export const useRouter = router.getUseRouter();
-export const Router = router.getSingletonRouter();
 
-export type RouteProps = PropsGenerator<RouteList>;
-export type RouteParams = FunctionParametersGenerator<RouteList>;
-export type NextPage<Route extends keyof RouteList, IP = Record<string, any>, P = IP> = UxfNextPage<RouteList, Route, IP, P>;
+export * from "./routes"
+export type GetServerSideProps<Route extends keyof RouteList> = UxfGetServerSideProps<RouteList, Route>;
+export type GetStaticProps<Route extends keyof RouteList> = UxfGetStaticProps<RouteList, Route>;
 ```
 
 Add configuration to `tsconfig.json`
@@ -59,39 +52,105 @@ Add configuration to `tsconfig.json`
 }
 ```
 
-## Typings
+## Next Link
 
-### Function
+```tsx
+// pages/index.js
+import Link from "next/link";
+import { route } from "@app-routes";
 
-```ts
-import { RouteList } from "@app-routes";
-import { FunctionParametersGenerator } from "@uxf/router";
+export default () => (
+    <Link href={route("blog/detail", { id: 12 })}>
+      Hello world
+    </Link>
+)
+```
+
+## GetStaticProps
 
-const navigate: (...attrs: FunctionParametersGenerator<RouteList>) => void = (route, params = undefined) => {
-    // implement me
+```tsx
+import { GetStaticProps } from "@app-routes";
+import { queryParamToNumber } from "@uxf/router";
+
+export const getStaticProps: GetStaticProps<"blog/detail"> = (context) => {
+    const id = queryParamToNumber(context.params?.id); // context.params is of type { id: number } | undefined
 }
 ```
 
-### Component
+## GetServerSideProps
 
-```ts
-import { RouteList } from "@app-routes";
-import { PropsGenerator } from "@uxf/router";
+```tsx
+import { GetServerSideProps } from "@app-routes";
+import { queryParamToNumber } from "@uxf/router";
 
-const SomeComponent: React.FC<PropsGenerator<RouteList>> = (props) => {
-    // implement me
+export const getServerSideProps: GetServerSideProps<"blog/detail"> = (context) => {
+    const id = queryParamToNumber(context.params?.id); // context.params is of type { id: number } | undefined
 }
 ```
 
-## How to use Link?
+## Sitemap
+
+Create sitemap items
 
 ```tsx
-// pages/index.js
-import { Link } from '@app-routes'
+// sitemap-items.ts in @app-routes
+
+import { sitemapGenerator } from "@app-routes";
+
+export const sitemapItems = sitemapGenerator
+    .add("index", async () => ({ loc: "http://localhost", lastmod: "2021-01-01", priority: 1 }))
+    .add("blog/detail", async () => [
+        { loc: "http://localhost/bolg/1", priority: 2 },
+        { loc: "http://localhost/bolg/2", priority: 2 },
+    ])
+    .skip("admin/index")
+    .exhaustive();
+```
 
-export default () => (
-    <Link route='blog-article' params={{ articleId: 12 }}>
-      <a>Hello world</a>
-    </Link>
-)
+#### sitemap.xml
+
+```tsx
+// pages/sitemap.xml.tsx
+
+import React from "react";
+import { NextPage } from "next";
+import { sitemapItems } from "@app-routes";
+
+const Page: NextPage = () => null;
+
+Page.getInitialProps = async (ctx) => {
+    if (ctx.res) {
+        ctx.res.setHeader("Content-Type", "text/xml");
+        ctx.res.write(await sitemapItems.toXml());
+        ctx.res.end();
+    }
+
+    return {};
+};
+
+export default Page;
+```
+
+#### sitemap.json
+
+```tsx
+// pages/sitemap.json.tsx
+
+import React from "react";
+import { NextPage } from "next";
+import { sitemapItems } from "@app-routes";
+
+const Page: NextPage = () => null;
+
+Page.getInitialProps = async (ctx) => {
+    if (ctx.res) {
+        ctx.res.setHeader("Content-Type", "text/json");
+        ctx.res.write(await sitemapItems.toJson());
+        ctx.res.end();
+    }
+
+    return {};
+};
+
+export default Page;
 ```

package/helper.d.ts

@@ -1,2 +1,2 @@
-export declare const queryParamToString: (param?: string | string[] | undefined) => string;
-export declare const queryParamToNumber: (param?: string | string[] | undefined) => number;
+export declare const queryParamToString: (param?: string | string[]) => string;
+export declare const queryParamToNumber: (param?: string | string[]) => number;

package/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./Router";
+export * from "./router";
 export * from "./types";
 export * from "./helper";

package/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Router"), exports);
+__exportStar(require("./router"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./helper"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsMkNBQXlCO0FBQ3pCLDBDQUF3QjtBQUN4QiwyQ0FBeUIifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDJDQUF5QjtBQUN6QiwwQ0FBd0I7QUFDeEIsMkNBQXlCIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uxf/router",
-  "version": "2.1.2",
+  "version": "2.2.0-beta.2",
   "description": "UXF Router",
   "author": "UXFans <dev@uxf.cz>",
   "homepage": "https://gitlab.com/uxf-npm/router#readme",
@@ -35,13 +35,13 @@
     "@types/jest": "^27.4.0",
     "@types/node": "^17.0.10",
     "@types/qs": "^6.9.7",
-    "@types/react": "^17.0.38",
-    "@types/react-dom": "^17.0.11",
+    "@types/react": "^18.0.26",
+    "@types/react-dom": "^18.0.9",
     "jest": "^27.4.7",
-    "next": "^12.0.8",
+    "next": "^13.0.7",
     "prettier": "^2.5.1",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "ts-jest": "^27.1.3",
     "typescript": "^4.5.4",
     "@typescript-eslint/eslint-plugin": "^5.11.0",
@@ -51,7 +51,7 @@
     "eslint-plugin-prettier": "^4.0.0"
   },
   "peerDependencies": {
-    "react": "^16 || ^17",
-    "react-dom": "^16 || ^17"
+    "react": "^18",
+    "react-dom": "^18"
   }
 }

package/router.d.ts

@@ -0,0 +1,16 @@
+import { LinkProps } from "next/link";
+import { SitemapGeneratorType } from "@uxf/router/sitemapGenerator";
+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 Router<T> = {
+    route: RouteFunction<T>;
+    routeToUrl: RouteToUrlFunction<T>;
+    sitemapGenerator: SitemapGeneratorType<T>;
+};
+export declare function createRouter<RouteList>(routes: {
+    [key in keyof RouteList]: string;
+}): Router<RouteList>;
+export {};

package/router.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRouter = void 0;
+var qs_1 = require("qs");
+var sitemapGenerator_1 = require("@uxf/router/sitemapGenerator");
+function createRouter(routes) {
+    return {
+        route: function (route, params) {
+            if (params === void 0) { params = undefined; }
+            return ({
+                pathname: routes[route],
+                query: params !== null && params !== void 0 ? params : null,
+            });
+        },
+        routeToUrl: function (route, params) {
+            if (params === void 0) { params = undefined; }
+            var pathname = routes[route];
+            var restParams = {};
+            Object.keys(params !== null && params !== void 0 ? params : {}).forEach(function (key) {
+                var value = params[key];
+                if (pathname.includes("[".concat(key, "]"))) {
+                    pathname = pathname.replace("[".concat(key, "]"), value);
+                }
+                else {
+                    restParams[key] = value;
+                }
+            });
+            if (Object.keys(restParams).length > 0) {
+                pathname = "".concat(pathname, "?").concat((0, qs_1.stringify)(restParams));
+            }
+            return pathname;
+        },
+        sitemapGenerator: (0, sitemapGenerator_1.createSitemapGenerator)(),
+    };
+}
+exports.createRouter = createRouter;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3JvdXRlci50c3giXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEseUJBQStCO0FBRS9CLGlFQUE0RjtBQWU1RixTQUFnQixZQUFZLENBQVksTUFBNEM7SUFDaEYsT0FBTztRQUNILEtBQUssRUFBRSxVQUFDLEtBQUssRUFBRSxNQUFrQjtZQUFsQix1QkFBQSxFQUFBLGtCQUFrQjtZQUFLLE9BQUEsQ0FBQztnQkFDbkMsUUFBUSxFQUFFLE1BQU0sQ0FBQyxLQUFLLENBQUM7Z0JBQ3ZCLEtBQUssRUFBRSxNQUFNLGFBQU4sTUFBTSxjQUFOLE1BQU0sR0FBSSxJQUFJO2FBQ3hCLENBQUM7UUFIb0MsQ0FHcEM7UUFDRixVQUFVLEVBQUUsVUFBQyxLQUFLLEVBQUUsTUFBa0I7WUFBbEIsdUJBQUEsRUFBQSxrQkFBa0I7WUFDbEMsSUFBSSxRQUFRLEdBQUcsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO1lBQzdCLElBQU0sVUFBVSxHQUFRLEVBQUUsQ0FBQztZQUMzQixNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sYUFBTixNQUFNLGNBQU4sTUFBTSxHQUFJLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxVQUFDLEdBQUc7Z0JBQ2xDLElBQU0sS0FBSyxHQUFJLE1BQWMsQ0FBQyxHQUFHLENBQUMsQ0FBQztnQkFDbkMsSUFBSSxRQUFRLENBQUMsUUFBUSxDQUFDLFdBQUksR0FBRyxNQUFHLENBQUMsRUFBRTtvQkFDL0IsUUFBUSxHQUFHLFFBQVEsQ0FBQyxPQUFPLENBQUMsV0FBSSxHQUFHLE1BQUcsRUFBRSxLQUFLLENBQUMsQ0FBQztpQkFDbEQ7cUJBQU07b0JBQ0gsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEtBQUssQ0FBQztpQkFDM0I7WUFDTCxDQUFDLENBQUMsQ0FBQztZQUNILElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO2dCQUNwQyxRQUFRLEdBQUcsVUFBRyxRQUFRLGNBQUksSUFBQSxjQUFTLEVBQUMsVUFBVSxDQUFDLENBQUUsQ0FBQzthQUNyRDtZQUNELE9BQU8sUUFBUSxDQUFDO1FBQ3BCLENBQUM7UUFDRCxnQkFBZ0IsRUFBRSxJQUFBLHlDQUFzQixHQUFFO0tBQzdDLENBQUM7QUFDTixDQUFDO0FBeEJELG9DQXdCQyJ9

package/sitemapGenerator.d.ts

@@ -0,0 +1,20 @@
+export type SitemapItem = {
+    loc: string;
+    priority: number;
+    lastmod?: string | null;
+};
+type RouteResolverResult = SitemapItem | SitemapItem[];
+type RouteResolver<Route> = (route: Route) => Promise<RouteResolverResult>;
+type MissingRoutesError<Routes> = {
+    __nonExhaustive: never;
+    missingRoutes: Routes;
+};
+export type SitemapGeneratorType<RouteList> = {
+    add: <Route extends keyof RouteList>(route: Route, resolver: RouteResolver<Route>) => SitemapGeneratorType<Omit<RouteList, Route>>;
+    skip: <Route extends keyof RouteList>(route: Route) => SitemapGeneratorType<Omit<RouteList, Route>>;
+    exhaustive: keyof RouteList extends never ? () => SitemapGeneratorType<RouteList> : MissingRoutesError<keyof RouteList>;
+    toXml: keyof RouteList extends never ? () => Promise<string> : MissingRoutesError<keyof RouteList>;
+    toJson: keyof RouteList extends never ? () => Promise<any> : MissingRoutesError<keyof RouteList>;
+};
+export declare const createSitemapGenerator: <RouteList>() => SitemapGeneratorType<RouteList>;
+export {};

package/sitemapGenerator.js

@@ -0,0 +1,112 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSitemapGenerator = void 0;
+var SitemapGenerator = /** @class */ (function () {
+    function SitemapGenerator() {
+        var _this = this;
+        this.routeResolvers = {};
+        this.exhaustive = function () { return _this; };
+        this.toXml = function () {
+            return _this.getSitemapItems().then(function (sitemapItems) {
+                return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n        <urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd\">\n            ".concat(sitemapItems
+                    .map(function (item) { return "<url>\n                        <loc>".concat(item.loc, "</loc>\n                            <priority>").concat(item.priority, "</priority>\n                            ").concat(item.lastmod ? "<lastmod>".concat(item.lastmod, "</lastmod>") : "<changefreq>monthly</changefreq>", "\n                        </url>"); })
+                    .join(""), "\n        </urlset>");
+            });
+        };
+        this.toJson = function () { return _this.getSitemapItems().then(JSON.stringify); };
+    }
+    SitemapGenerator.prototype.getSitemapItems = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var routes;
+            var _this = this;
+            return __generator(this, function (_a) {
+                routes = Object.keys(this.routeResolvers);
+                return [2 /*return*/, Promise.all(routes.map(function (route) { var _a, _b; return (_b = (_a = _this.routeResolvers)[route]) === null || _b === void 0 ? void 0 : _b.call(_a, route); })).then(function (resolverResults) {
+                        var sitemapItems = [];
+                        resolverResults.forEach(function (result) {
+                            if (!result)
+                                return;
+                            if (Array.isArray(result)) {
+                                sitemapItems.push.apply(sitemapItems, __spreadArray([], __read(result), false));
+                                return;
+                            }
+                            sitemapItems.push(result);
+                        });
+                        return sitemapItems;
+                    })];
+            });
+        });
+    };
+    SitemapGenerator.prototype.add = function (route, resolver) {
+        this.routeResolvers[route] = resolver;
+        return this;
+    };
+    SitemapGenerator.prototype.skip = function () {
+        return this;
+    };
+    return SitemapGenerator;
+}());
+var createSitemapGenerator = function () { return new SitemapGenerator(); };
+exports.createSitemapGenerator = createSitemapGenerator;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2l0ZW1hcEdlbmVyYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9zaXRlbWFwR2VuZXJhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUF3QkE7SUFBQTtRQUFBLGlCQXdEQztRQXZEVyxtQkFBYyxHQUE4RCxFQUFFLENBQUM7UUFtQ2hGLGVBQVUsR0FBUSxjQUFNLE9BQUEsS0FBSSxFQUFKLENBQUksQ0FBQztRQUU3QixVQUFLLEdBQVE7WUFDaEIsT0FBTyxLQUFJLENBQUMsZUFBZSxFQUFFLENBQUMsSUFBSSxDQUFDLFVBQUMsWUFBWTtnQkFDNUMsT0FBTyw2VEFFTCxZQUFZO3FCQUNULEdBQUcsQ0FDQSxVQUFDLElBQUksSUFBSyxPQUFBLDhDQUNDLElBQUksQ0FBQyxHQUFHLDJEQUNDLElBQUksQ0FBQyxRQUFRLHNEQUN2QixJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxtQkFBWSxJQUFJLENBQUMsT0FBTyxlQUFZLENBQUMsQ0FBQyxDQUFDLGtDQUFrQyxxQ0FDdkYsRUFKRCxDQUlDLENBQ2Q7cUJBQ0EsSUFBSSxDQUFDLEVBQUUsQ0FBQyx3QkFDUCxDQUFDO1lBQ1gsQ0FBQyxDQUFDLENBQUM7UUFDUCxDQUFDLENBQUM7UUFFSyxXQUFNLEdBQVEsY0FBTSxPQUFBLEtBQUksQ0FBQyxlQUFlLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxFQUEzQyxDQUEyQyxDQUFDO0lBQzNFLENBQUM7SUFyRGlCLDBDQUFlLEdBQTdCOzs7OztnQkFDVSxNQUFNLEdBQTJCLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBUSxDQUFDO2dCQUUvRSxzQkFBTyxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsVUFBQyxLQUFLLGdCQUFLLE9BQUEsTUFBQSxNQUFBLEtBQUksQ0FBQyxjQUFjLEVBQUMsS0FBSyxDQUFDLG1EQUFHLEtBQUssQ0FBQyxDQUFBLEVBQUEsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFVBQUMsZUFBZTt3QkFDaEcsSUFBTSxZQUFZLEdBQWtCLEVBQUUsQ0FBQzt3QkFFdkMsZUFBZSxDQUFDLE9BQU8sQ0FBQyxVQUFDLE1BQU07NEJBQzNCLElBQUksQ0FBQyxNQUFNO2dDQUFFLE9BQU87NEJBRXBCLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsRUFBRTtnQ0FDdkIsWUFBWSxDQUFDLElBQUksT0FBakIsWUFBWSwyQkFBUyxNQUFNLFdBQUU7Z0NBQzdCLE9BQU87NkJBQ1Y7NEJBRUQsWUFBWSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQzt3QkFDOUIsQ0FBQyxDQUFDLENBQUM7d0JBRUgsT0FBTyxZQUFZLENBQUM7b0JBQ3hCLENBQUMsQ0FBQyxFQUFDOzs7S0FDTjtJQUVNLDhCQUFHLEdBQVYsVUFDSSxLQUFZLEVBQ1osUUFBOEI7UUFFOUIsSUFBSSxDQUFDLGNBQWMsQ0FBQyxLQUFLLENBQUMsR0FBRyxRQUFRLENBQUM7UUFDdEMsT0FBTyxJQUFvRCxDQUFDO0lBQ2hFLENBQUM7SUFFTSwrQkFBSSxHQUFYO1FBQ0ksT0FBTyxJQUFvRCxDQUFDO0lBQ2hFLENBQUM7SUFzQkwsdUJBQUM7QUFBRCxDQUFDLEFBeERELElBd0RDO0FBRU0sSUFBTSxzQkFBc0IsR0FBRyxjQUFrRCxPQUFBLElBQUksZ0JBQWdCLEVBQUUsRUFBdEIsQ0FBc0IsQ0FBQztBQUFsRyxRQUFBLHNCQUFzQiwwQkFBNEUifQ==

package/types.d.ts

@@ -1,42 +1,15 @@
-import { LinkProps as NextLinkProps } from "next/link";
-import { NextRouter, SingletonRouter } from "next/router";
-import { NextComponentType, NextPageContext } from "next";
-import { ReactNode } from "react";
-export interface Options {
-    anchor?: string;
-    shallow?: boolean;
+import { GetStaticProps, GetServerSideProps, PreviewData as NextPreviewData } from "next";
+type QueryParams<RouteList, Route extends keyof RouteList> = RouteList[Route] extends null ? never : {
+    [key in keyof RouteList[Route]]: string | string[] | undefined;
+};
+export type UxfGetStaticProps<RouteList, Route extends keyof RouteList, Props extends {
     [key: string]: any;
-}
-export declare type LinkProps<RouteList> = {
-    children?: ReactNode;
-} & Omit<NextLinkProps, "as" | "href"> & PropsGenerator<RouteList>;
-export interface UxfRouter<T> extends Omit<NextRouter, "push" | "replace" | "route"> {
-    route: keyof T | null;
-    push: (...attr: FunctionParametersWithOptionsGenerator<T>) => Promise<boolean>;
-    replace: (...attr: FunctionParametersWithOptionsGenerator<T>) => Promise<boolean>;
-}
-export interface UxfSingletonRouter<T> extends Omit<SingletonRouter, "push" | "replace"> {
-    push: (...attr: FunctionParametersWithOptionsGenerator<T>) => Promise<boolean>;
-    replace: (...attr: FunctionParametersWithOptionsGenerator<T>) => Promise<boolean>;
-}
-export declare type PropsGenerator<Routes> = {
-    [K in keyof Routes]: Routes[K] extends null ? {
-        route: K;
-        params?: never;
-    } : {
-        route: K;
-        params: Routes[K];
-    };
-}[keyof Routes];
-export declare type FunctionParametersGenerator<Routes> = {
-    [K in keyof Routes]: Routes[K] extends null ? [K] : [K, Routes[K]];
-}[keyof Routes];
-export declare type FunctionParametersWithOptionsGenerator<Routes> = {
-    [K in keyof Routes]: Routes[K] extends null ? [K] | [K, Options] : [K, Routes[K]] | [K, Routes[K], Options];
-}[keyof Routes];
-export interface UxfPageContext<Routes, T extends keyof Routes> extends Omit<NextPageContext, "query"> {
-    query: Routes[T] extends null ? Record<string, any> : {
-        [key in keyof Routes[T]]: string | string[] | undefined;
-    };
-}
-export declare type UxfNextPage<Routes, Route extends keyof Routes, IP = Record<string, any>, P = IP> = NextComponentType<UxfPageContext<Routes, Route>, IP, P>;
+} = {
+    [key: string]: any;
+}, PreviewData extends NextPreviewData = NextPreviewData> = GetStaticProps<Props, QueryParams<RouteList, Route>, PreviewData>;
+export type UxfGetServerSideProps<RouteList, Route extends keyof RouteList, Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}, PreviewData extends NextPreviewData = NextPreviewData> = GetServerSideProps<Props, QueryParams<RouteList, Route>, PreviewData>;
+export {};

package/Router.d.ts

@@ -1,13 +0,0 @@
-import React from "react";
-import { FunctionParametersGenerator, LinkProps, UxfRouter, UxfSingletonRouter } from "./types";
-export declare class Router<T> {
-    private routes;
-    constructor(routes: {
-        [key in keyof T]: string;
-    });
-    private getRouteByPathname;
-    getLink: () => React.FC<LinkProps<T>>;
-    getUseRouter: () => () => UxfRouter<T>;
-    getSingletonRouter: () => UxfSingletonRouter<T>;
-    getUrlByRoute: (...attrs: FunctionParametersGenerator<T>) => string;
-}

package/Router.js

@@ -1,109 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Router = void 0;
-var link_1 = __importDefault(require("next/link"));
-var router_1 = __importStar(require("next/router"));
-var react_1 = __importDefault(require("react"));
-var qs_1 = require("qs");
-// TODO Vejvis: fix eslint ignores
-var Router = /** @class */ (function () {
-    function Router(routes) {
-        var _this = this;
-        this.getRouteByPathname = function (pathname) {
-            return Object.keys(_this.routes).find(function (route) { return _this.routes[route] === pathname; });
-        };
-        this.getLink = function () { return function (props) {
-            var route = props.route, params = props.params, linkProps = __rest(props, ["route", "params"]);
-            return react_1.default.createElement(link_1.default, __assign({ href: { pathname: _this.routes[route], query: params } }, linkProps));
-        }; };
-        this.getUseRouter = function () { return function () {
-            var router = (0, router_1.useRouter)();
-            return __assign(__assign({}, router), { route: _this.getRouteByPathname(router.pathname), push: function (route, params, options) {
-                    if (params === void 0) { params = undefined; }
-                    if (options === void 0) { options = undefined; }
-                    return router.push({ pathname: _this.routes[route], query: params }, undefined, options);
-                }, replace: function (route, params, options) {
-                    if (params === void 0) { params = undefined; }
-                    if (options === void 0) { options = undefined; }
-                    return router.replace({ pathname: _this.routes[route], query: params }, undefined, options);
-                } });
-        }; };
-        this.getSingletonRouter = function () {
-            return __assign(__assign({}, router_1.default), { push: function (route, params, options) {
-                    if (params === void 0) { params = undefined; }
-                    if (options === void 0) { options = undefined; }
-                    return router_1.default.push({ pathname: _this.routes[route], query: params }, undefined, options);
-                }, replace: function (route, params, options) {
-                    if (params === void 0) { params = undefined; }
-                    if (options === void 0) { options = undefined; }
-                    return router_1.default.replace({ pathname: _this.routes[route], query: params }, undefined, options);
-                } });
-        };
-        this.getUrlByRoute = function (route, params) {
-            if (params === void 0) { params = undefined; }
-            var pathname = _this.routes[route];
-            var restParams = {};
-            Object.keys(params !== null && params !== void 0 ? params : {}).forEach(function (key) {
-                var value = params[key];
-                if (pathname.includes("[".concat(key, "]"))) {
-                    pathname = pathname.replace("[".concat(key, "]"), value);
-                }
-                else {
-                    restParams[key] = value;
-                }
-            });
-            if (Object.keys(restParams).length > 0) {
-                pathname = "".concat(pathname, "?").concat((0, qs_1.stringify)(restParams));
-            }
-            return pathname;
-        };
-        this.routes = routes;
-    }
-    return Router;
-}());
-exports.Router = Router;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUm91dGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL1JvdXRlci50c3giXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxtREFBaUM7QUFDakMsb0RBQThFO0FBQzlFLGdEQUEwQjtBQUUxQix5QkFBK0I7QUFFL0Isa0NBQWtDO0FBQ2xDO0lBR0ksZ0JBQVksTUFBb0M7UUFBaEQsaUJBRUM7UUFFTyx1QkFBa0IsR0FBRyxVQUFDLFFBQWdCO1lBQzFDLE9BQU8sTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxDQUFDLFVBQUMsS0FBSyxJQUFLLE9BQUMsS0FBSSxDQUFDLE1BQWMsQ0FBQyxLQUFLLENBQUMsS0FBSyxRQUFRLEVBQXhDLENBQXdDLENBQVEsQ0FBQztRQUNyRyxDQUFDLENBQUM7UUFFSyxZQUFPLEdBQUcsY0FBOEIsT0FBQSxVQUFDLEtBQUs7WUFDekMsSUFBQSxLQUFLLEdBQTJCLEtBQUssTUFBaEMsRUFBRSxNQUFNLEdBQW1CLEtBQUssT0FBeEIsRUFBSyxTQUFTLFVBQUssS0FBSyxFQUF2QyxtQkFBK0IsQ0FBRixDQUFXO1lBQzlDLE9BQU8sOEJBQUMsY0FBUSxhQUFDLElBQUksRUFBRSxFQUFFLFFBQVEsRUFBRSxLQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxFQUFFLEtBQUssRUFBRSxNQUFhLEVBQUUsSUFBTSxTQUFTLEVBQUksQ0FBQztRQUNyRyxDQUFDLEVBSDhDLENBRzlDLENBQUM7UUFFSyxpQkFBWSxHQUFHLGNBQU0sT0FBQTtZQUN4QixJQUFNLE1BQU0sR0FBRyxJQUFBLGtCQUFhLEdBQUUsQ0FBQztZQUUvQiw2QkFDTyxNQUFNLEtBQ1QsS0FBSyxFQUFFLEtBQUksQ0FBQyxrQkFBa0IsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLEVBQy9DLElBQUksRUFBRSxVQUFDLEtBQUssRUFBRSxNQUFrQixFQUFFLE9BQW1CO29CQUF2Qyx1QkFBQSxFQUFBLGtCQUFrQjtvQkFBRSx3QkFBQSxFQUFBLG1CQUFtQjtvQkFDakQsT0FBTyxNQUFNLENBQUMsSUFBSSxDQUFDLEVBQUUsUUFBUSxFQUFFLEtBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsS0FBSyxFQUFFLE1BQWEsRUFBRSxFQUFFLFNBQVMsRUFBRSxPQUFPLENBQUMsQ0FBQztnQkFDbkcsQ0FBQyxFQUNELE9BQU8sRUFBRSxVQUFDLEtBQUssRUFBRSxNQUFrQixFQUFFLE9BQW1CO29CQUF2Qyx1QkFBQSxFQUFBLGtCQUFrQjtvQkFBRSx3QkFBQSxFQUFBLG1CQUFtQjtvQkFDcEQsT0FBTyxNQUFNLENBQUMsT0FBTyxDQUFDLEVBQUUsUUFBUSxFQUFFLEtBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsS0FBSyxFQUFFLE1BQWEsRUFBRSxFQUFFLFNBQVMsRUFBRSxPQUFPLENBQUMsQ0FBQztnQkFDdEcsQ0FBQyxJQUNIO1FBQ04sQ0FBQyxFQWIyQixDQWEzQixDQUFDO1FBRUssdUJBQWtCLEdBQUc7WUFDeEIsNkJBQ08sZ0JBQW1CLEtBQ3RCLElBQUksRUFBRSxVQUFDLEtBQUssRUFBRSxNQUFrQixFQUFFLE9BQW1CO29CQUF2Qyx1QkFBQSxFQUFBLGtCQUFrQjtvQkFBRSx3QkFBQSxFQUFBLG1CQUFtQjtvQkFDakQsT0FBTyxnQkFBbUIsQ0FBQyxJQUFJLENBQzNCLEVBQUUsUUFBUSxFQUFFLEtBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsS0FBSyxFQUFFLE1BQWEsRUFBRSxFQUN0RCxTQUFTLEVBQ1QsT0FBTyxDQUNWLENBQUM7Z0JBQ04sQ0FBQyxFQUNELE9BQU8sRUFBRSxVQUFDLEtBQUssRUFBRSxNQUFrQixFQUFFLE9BQW1CO29CQUF2Qyx1QkFBQSxFQUFBLGtCQUFrQjtvQkFBRSx3QkFBQSxFQUFBLG1CQUFtQjtvQkFDcEQsT0FBTyxnQkFBbUIsQ0FBQyxPQUFPLENBQzlCLEVBQUUsUUFBUSxFQUFFLEtBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsS0FBSyxFQUFFLE1BQWEsRUFBRSxFQUN0RCxTQUFTLEVBQ1QsT0FBTyxDQUNWLENBQUM7Z0JBQ04sQ0FBQyxJQUNIO1FBQ04sQ0FBQyxDQUFDO1FBRUssa0JBQWEsR0FBeUQsVUFBQyxLQUFLLEVBQUUsTUFBa0I7WUFBbEIsdUJBQUEsRUFBQSxrQkFBa0I7WUFDbkcsSUFBSSxRQUFRLEdBQUcsS0FBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUNsQyxJQUFNLFVBQVUsR0FBUSxFQUFFLENBQUM7WUFDM0IsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLGFBQU4sTUFBTSxjQUFOLE1BQU0sR0FBSSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsVUFBQyxHQUFHO2dCQUNsQyxJQUFNLEtBQUssR0FBSSxNQUFjLENBQUMsR0FBRyxDQUFDLENBQUM7Z0JBQ25DLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxXQUFJLEdBQUcsTUFBRyxDQUFDLEVBQUU7b0JBQy9CLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDLFdBQUksR0FBRyxNQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7aUJBQ2xEO3FCQUFNO29CQUNILFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxLQUFLLENBQUM7aUJBQzNCO1lBQ0wsQ0FBQyxDQUFDLENBQUM7WUFDSCxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtnQkFDcEMsUUFBUSxHQUFHLFVBQUcsUUFBUSxjQUFJLElBQUEsY0FBUyxFQUFDLFVBQVUsQ0FBQyxDQUFFLENBQUM7YUFDckQ7WUFDRCxPQUFPLFFBQVEsQ0FBQztRQUNwQixDQUFDLENBQUM7UUE5REUsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7SUFDekIsQ0FBQztJQThETCxhQUFDO0FBQUQsQ0FBQyxBQW5FRCxJQW1FQztBQW5FWSx3QkFBTSJ9

package/Router.test.d.ts

@@ -1 +0,0 @@
-export {};

package/Router.test.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var Router_1 = require("./Router");
-var router = new Router_1.Router({
-    index: "/",
-    form: "/form/[id]",
-    "form-field": "/form/[formId]/field/[fieldId]",
-});
-test("getUrlByRoute", function () {
-    expect(router.getUrlByRoute("form", { id: 12, attr: "abc" })).toBe("/form/12?attr=abc");
-    expect(router.getUrlByRoute("form-field", { formId: 33, fieldId: "aaa", param1: "ano" })).toBe("/form/33/field/aaa?param1=ano");
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUm91dGVyLnRlc3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvUm91dGVyLnRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxtQ0FBa0M7QUFFbEMsSUFBTSxNQUFNLEdBQUcsSUFBSSxlQUFNLENBQUM7SUFDdEIsS0FBSyxFQUFFLEdBQUc7SUFDVixJQUFJLEVBQUUsWUFBWTtJQUNsQixZQUFZLEVBQUUsZ0NBQWdDO0NBQ2pELENBQUMsQ0FBQztBQUVILElBQUksQ0FBQyxlQUFlLEVBQUU7SUFDbEIsTUFBTSxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUMsTUFBTSxFQUFFLEVBQUUsRUFBRSxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO0lBQ3hGLE1BQU0sQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDLFlBQVksRUFBRSxFQUFFLE1BQU0sRUFBRSxFQUFFLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FDMUYsK0JBQStCLENBQ2xDLENBQUM7QUFDTixDQUFDLENBQUMsQ0FBQyJ9