@uxf/router 10.0.0-beta.16 → 10.0.0-beta.18

package/README.md

@@ -119,13 +119,13 @@ Create sitemap items
 ```tsx
 // sitemap-items.ts in @app-routes
 
-import { sitemapGenerator } from "@app-routes";
+import { createSitemapGenerator, routeToUrl } 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 },
+export const sitemapItems = createSitemapGenerator({baseUrl: 'http://localhost:3000', defaultPriority: 1})
+    .add("index", async (route) => ({ loc: routeToUrl(route) }))
+    .add("blog/detail", async (route) => [
+        { loc: routeToUrl(route, {id: 1}), priority: 2 },
+        { loc: routeToUrl(route, {id: 2}), priority: 2 },
     ])
     .skip("admin/index")
     .exhaustive();

package/package.json

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

package/router.d.ts

@@ -1,5 +1,5 @@
 import { LinkProps } from "next/link";
-import { SitemapGeneratorType } from "./sitemapGenerator";
+import { SitemapGeneratorOptions, SitemapGeneratorType } from "./sitemapGenerator";
 import { QueryParams } from "./types";
 export type FunctionParametersGenerator<RouteList> = {
     [K in keyof RouteList]: RouteList[K] extends null ? [K] : [K, RouteList[K]];
@@ -9,7 +9,7 @@ type RouteToUrlFunction<RouteList> = (...args: FunctionParametersGenerator<Route
 type Router<RouteList> = {
     route: RouteFunction<RouteList>;
     routeToUrl: RouteToUrlFunction<RouteList>;
-    sitemapGenerator: SitemapGeneratorType<RouteList>;
+    createSitemapGenerator: (options?: SitemapGeneratorOptions) => SitemapGeneratorType<RouteList>;
     routes: {
         [key in keyof RouteList]: string;
     };

package/router.js

@@ -70,7 +70,7 @@ function createRouter(routes) {
             }
             return activeRoute;
         },
-        sitemapGenerator: (0, sitemapGenerator_1.createSitemapGenerator)(),
+        createSitemapGenerator: sitemapGenerator_1.createSitemapGenerator,
         routes,
         useQueryParams: () => (0, router_1.useRouter)().query,
     };

package/sitemapGenerator.d.ts

@@ -1,7 +1,9 @@
+type ChangeFrequency = "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never";
 export type SitemapItem = {
     loc: string;
-    priority: number;
+    priority?: number;
     lastmod?: string | null;
+    changefreq?: ChangeFrequency;
 };
 type RouteResolverResult = null | undefined | SitemapItem | Array<SitemapItem | null | undefined>;
 type RouteResolver<Route> = (route: Route) => Promise<RouteResolverResult>;
@@ -16,5 +18,10 @@ export type SitemapGeneratorType<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 type SitemapGeneratorOptions = {
+    baseUrl?: string;
+    defaultPriority?: number;
+    defaultChangeFreq?: ChangeFrequency;
+};
+export declare const createSitemapGenerator: <RouteList>(options?: SitemapGeneratorOptions) => SitemapGeneratorType<RouteList>;
 export {};

package/sitemapGenerator.js

@@ -5,28 +5,34 @@ function filterNullish(val) {
     return val.filter((item) => item !== null && item !== undefined);
 }
 class SitemapGenerator {
-    constructor() {
+    constructor(options) {
         this.routeResolvers = {};
+        this.options = null;
         this.exhaustive = () => this;
         this.toXml = () => {
             return this.getSitemapItems().then((sitemapItems) => {
                 return `<?xml version="1.0" encoding="UTF-8"?>
         <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">
             ${sitemapItems
-                    .map((item) => `<url>
-                        <loc>${item.loc}</loc>
-                            <priority>${item.priority}</priority>
-                            ${item.lastmod ? `<lastmod>${item.lastmod}</lastmod>` : "<changefreq>monthly</changefreq>"}
-                        </url>`)
+                    .map((item) => {
+                    var _a, _b;
+                    return `<url>
+                        <loc>${(_b = (_a = this.options) === null || _a === void 0 ? void 0 : _a.baseUrl) !== null && _b !== void 0 ? _b : ""}${item.loc}</loc>
+                            ${item.priority ? `<priority>${item.priority}</priority>` : ""}
+                            ${item.lastmod ? `<lastmod>${item.lastmod}</lastmod>` : ""}
+                            ${item.changefreq ? `<changefreq>${item.changefreq}</changefreq>` : ""}
+                        </url>`;
+                })
                     .join("")}
         </urlset>`;
             });
         };
         this.toJson = () => this.getSitemapItems().then(JSON.stringify);
+        this.options = options !== null && options !== void 0 ? options : null;
     }
     async getSitemapItems() {
         const routes = Object.keys(this.routeResolvers);
-        return Promise.all(routes.map((route) => { var _a, _b; return (_b = (_a = this.routeResolvers)[route]) === null || _b === void 0 ? void 0 : _b.call(_a, route); })).then((resolverResults) => {
+        const allSitemapItems = await Promise.all(routes.map((route) => { var _a, _b; return (_b = (_a = this.routeResolvers)[route]) === null || _b === void 0 ? void 0 : _b.call(_a, route); })).then((resolverResults) => {
             const sitemapItems = [];
             resolverResults.forEach((result) => {
                 if (!result) {
@@ -40,6 +46,14 @@ class SitemapGenerator {
             });
             return sitemapItems;
         });
+        return allSitemapItems.map((sitemapItem) => {
+            var _a, _b;
+            return ({
+                ...sitemapItem,
+                changefreq: sitemapItem.changefreq !== undefined ? sitemapItem.changefreq : (_a = this.options) === null || _a === void 0 ? void 0 : _a.defaultChangeFreq,
+                priority: sitemapItem.priority !== undefined ? sitemapItem.priority : (_b = this.options) === null || _b === void 0 ? void 0 : _b.defaultPriority,
+            });
+        });
     }
     add(route, resolver) {
         this.routeResolvers[route] = resolver;
@@ -49,5 +63,5 @@ class SitemapGenerator {
         return this;
     }
 }
-const createSitemapGenerator = () => new SitemapGenerator();
+const createSitemapGenerator = (options) => new SitemapGenerator(options);
 exports.createSitemapGenerator = createSitemapGenerator;