@onruntime/next-sitemap 0.2.0 → 0.3.0

package/README.md

@@ -118,6 +118,7 @@ export default nextConfig;
 | `priority` | `number`, `"auto"`, or `function` | `"auto"` | Priority calculation (auto = depth-based) |
 | `changeFreq` | `ChangeFrequency` or `function` | `"weekly"` | Change frequency for entries |
 | `additionalSitemaps` | `string[]` | `[]` | Additional sitemaps to include in index |
+| `debug` | `boolean` | `false` | Enable debug logging to diagnose route discovery issues |
 
 #### Exclude Routes
 
@@ -266,6 +267,78 @@ export async function GET() {
 </urlset>
 ```
 
+## Troubleshooting
+
+### Dynamic routes not included in sitemap
+
+If your dynamic routes (e.g., `/articles/[slug]`) are not appearing in the sitemap, enable debug mode to diagnose:
+
+```typescript
+const { GET } = createSitemapIndexHandler({
+  baseUrl: "https://example.com",
+  pagesContext,
+  debug: true, // Enable debug logging
+});
+```
+
+This will log:
+- All discovered routes and whether `generateStaticParams` was found
+- Number of params returned by each `generateStaticParams` call
+- Any errors that occur during param generation
+
+**Common issues:**
+
+1. **`generateStaticParams` not detected**: Make sure it's exported as a named export at the top level of your page file:
+   ```typescript
+   // ✅ Correct
+   export async function generateStaticParams() { ... }
+
+   // ❌ Wrong - not exported
+   async function generateStaticParams() { ... }
+   ```
+
+2. **Database/API errors**: If `generateStaticParams` fetches data from a database or API, errors are caught and logged. Check the console for error messages.
+
+3. **Empty params returned**: If `generateStaticParams` returns an empty array, no dynamic paths will be generated.
+
+### Recommended approach for API/Database routes
+
+For routes that fetch data from external sources (APIs, databases like Payload CMS), we recommend using `additionalSitemaps` with a custom sitemap route:
+
+```typescript
+// app/sitemap.xml/route.ts
+const { GET } = createSitemapIndexHandler({
+  baseUrl: "https://example.com",
+  pagesContext,
+  additionalSitemaps: ["/articles-sitemap.xml"],
+});
+
+// app/articles-sitemap.xml/route.ts
+import { generateSitemapXml } from "@onruntime/next-sitemap";
+import { getPayload } from "payload";
+
+export async function GET() {
+  const payload = await getPayload({ config: configPromise });
+  const articles = await payload.find({
+    collection: "articles",
+    limit: 1000,
+    select: { slug: true, updatedAt: true },
+  });
+
+  const entries = articles.docs.map((article) => ({
+    url: `https://example.com/articles/${article.slug}`,
+    lastModified: article.updatedAt,
+    priority: 0.7,
+  }));
+
+  return new Response(generateSitemapXml(entries), {
+    headers: { "Content-Type": "application/xml" },
+  });
+}
+```
+
+This approach gives you full control over data fetching and error handling.
+
 ## License
 
 MIT

package/dist/app/index.cjs

@@ -100,8 +100,20 @@ function extractRoutes(pagesContext, localeSegment) {
   for (const key of pagesContext.keys()) {
     if (key.includes("[...")) continue;
     const pageModule = pagesContext(key);
-    let pathname = key.replace("./", "/").replace("/page.tsx", "").replace(new RegExp(`^/${localeSegment.replace(/[[\]]/g, "\\$&")}`), "").replace(/\/\([^)]+\)/g, "") || "/";
-    if (pathname === "") pathname = "/";
+    let pathname = key.replace("./", "/").replace("/page.tsx", "");
+    if (localeSegment) {
+      pathname = pathname.replace(
+        new RegExp(`^/${localeSegment.replace(/[[\]]/g, "\\$&")}`),
+        ""
+      );
+    }
+    pathname = pathname.replace(/\/\([^)]+\)/g, "");
+    if (/(?:^|\/)(src|app)(?:\/|$)/.test(pathname)) continue;
+    if (!pathname || pathname === "") {
+      pathname = "/";
+    } else if (!pathname.startsWith("/")) {
+      pathname = "/" + pathname;
+    }
     const dynamicSegments = pathname.match(/\[([^\]]+)\]/g)?.map((s) => s.slice(1, -1)) || [];
     routes.push({
       pathname,
@@ -111,7 +123,7 @@ function extractRoutes(pagesContext, localeSegment) {
   }
   return routes;
 }
-async function getAllPaths(routes) {
+async function getAllPaths(routes, debug = false) {
   const allPaths = ["/"];
   const seenPaths = /* @__PURE__ */ new Set(["/"]);
   for (const route of routes) {
@@ -121,16 +133,36 @@ async function getAllPaths(routes) {
         seenPaths.add(route.pathname);
       }
     } else if (route.getParams) {
-      const params = await route.getParams();
-      for (const param of params) {
-        let dynamicPath = route.pathname;
-        for (const segment of route.dynamicSegments) {
-          dynamicPath = dynamicPath.replace(`[${segment}]`, param[segment]);
+      try {
+        const params = await route.getParams();
+        if (debug) {
+          console.log(`[next-sitemap] ${route.pathname}: generateStaticParams returned ${params.length} params`);
         }
-        if (!seenPaths.has(dynamicPath)) {
-          allPaths.push(dynamicPath);
-          seenPaths.add(dynamicPath);
+        for (const param of params) {
+          let dynamicPath = route.pathname;
+          for (const segment of route.dynamicSegments) {
+            const value = param[segment];
+            if (value === void 0) {
+              if (debug) {
+                console.warn(`[next-sitemap] ${route.pathname}: missing param "${segment}" in`, param);
+              }
+              continue;
+            }
+            dynamicPath = dynamicPath.replace(`[${segment}]`, value);
+          }
+          if (!seenPaths.has(dynamicPath)) {
+            allPaths.push(dynamicPath);
+            seenPaths.add(dynamicPath);
+          }
         }
+      } catch (error) {
+        console.error(`[next-sitemap] Error calling generateStaticParams for ${route.pathname}:`, error);
+      }
+    } else if (route.dynamicSegments.length > 0) {
+      if (debug) {
+        console.warn(
+          `[next-sitemap] Skipping dynamic route ${route.pathname}: no generateStaticParams exported. Use additionalSitemaps for routes that fetch data at runtime.`
+        );
       }
     }
   }
@@ -160,12 +192,20 @@ function pathsToEntries(paths, config) {
   });
 }
 function createSitemapIndexHandler(options) {
-  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, additionalSitemaps, exclude } = options;
+  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, additionalSitemaps, exclude, debug = false } = options;
   const localeSegment = options.localeSegment ?? (locales.length > 0 || defaultLocale ? "[locale]" : "");
   const routes = extractRoutes(options.pagesContext, localeSegment);
+  if (debug) {
+    console.log(`[next-sitemap] Found ${routes.length} routes:`);
+    routes.forEach((r) => {
+      const hasParams = r.getParams ? "\u2713 generateStaticParams" : "\u2717 no generateStaticParams";
+      const segments = r.dynamicSegments.length > 0 ? ` [${r.dynamicSegments.join(", ")}]` : "";
+      console.log(`  ${r.pathname}${segments} - ${hasParams}`);
+    });
+  }
   return {
     GET: async () => {
-      const allPaths = await getAllPaths(routes);
+      const allPaths = await getAllPaths(routes, debug);
       const filteredPaths = allPaths.filter((pathname) => !shouldExclude(pathname, exclude));
       const sitemapCount = Math.max(1, Math.ceil(filteredPaths.length / urlsPerSitemap));
       const xml = generateSitemapIndexXml(options.baseUrl, sitemapCount, {
@@ -178,11 +218,11 @@ function createSitemapIndexHandler(options) {
   };
 }
 function createSitemapHandler(options) {
-  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, exclude } = options;
+  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, exclude, debug = false } = options;
   const localeSegment = options.localeSegment ?? (locales.length > 0 || defaultLocale ? "[locale]" : "");
   const routes = extractRoutes(options.pagesContext, localeSegment);
   const getFilteredPaths = async () => {
-    const allPaths = await getAllPaths(routes);
+    const allPaths = await getAllPaths(routes, debug);
     return allPaths.filter((pathname) => !shouldExclude(pathname, exclude));
   };
   return {

package/dist/app/index.d.cts

@@ -79,6 +79,12 @@ interface CreateSitemapHandlerOptions extends SitemapConfig {
         keys: () => string[];
         (key: string): PageModule;
     };
+    /**
+     * Enable debug logging to diagnose issues with route discovery
+     * Logs info about generateStaticParams calls and skipped routes
+     * @default false
+     */
+    debug?: boolean;
 }
 /**
  * Create handlers for sitemap index route

package/dist/app/index.d.ts

@@ -79,6 +79,12 @@ interface CreateSitemapHandlerOptions extends SitemapConfig {
         keys: () => string[];
         (key: string): PageModule;
     };
+    /**
+     * Enable debug logging to diagnose issues with route discovery
+     * Logs info about generateStaticParams calls and skipped routes
+     * @default false
+     */
+    debug?: boolean;
 }
 /**
  * Create handlers for sitemap index route

package/dist/app/index.js

@@ -98,8 +98,20 @@ function extractRoutes(pagesContext, localeSegment) {
   for (const key of pagesContext.keys()) {
     if (key.includes("[...")) continue;
     const pageModule = pagesContext(key);
-    let pathname = key.replace("./", "/").replace("/page.tsx", "").replace(new RegExp(`^/${localeSegment.replace(/[[\]]/g, "\\$&")}`), "").replace(/\/\([^)]+\)/g, "") || "/";
-    if (pathname === "") pathname = "/";
+    let pathname = key.replace("./", "/").replace("/page.tsx", "");
+    if (localeSegment) {
+      pathname = pathname.replace(
+        new RegExp(`^/${localeSegment.replace(/[[\]]/g, "\\$&")}`),
+        ""
+      );
+    }
+    pathname = pathname.replace(/\/\([^)]+\)/g, "");
+    if (/(?:^|\/)(src|app)(?:\/|$)/.test(pathname)) continue;
+    if (!pathname || pathname === "") {
+      pathname = "/";
+    } else if (!pathname.startsWith("/")) {
+      pathname = "/" + pathname;
+    }
     const dynamicSegments = pathname.match(/\[([^\]]+)\]/g)?.map((s) => s.slice(1, -1)) || [];
     routes.push({
       pathname,
@@ -109,7 +121,7 @@ function extractRoutes(pagesContext, localeSegment) {
   }
   return routes;
 }
-async function getAllPaths(routes) {
+async function getAllPaths(routes, debug = false) {
   const allPaths = ["/"];
   const seenPaths = /* @__PURE__ */ new Set(["/"]);
   for (const route of routes) {
@@ -119,16 +131,36 @@ async function getAllPaths(routes) {
         seenPaths.add(route.pathname);
       }
     } else if (route.getParams) {
-      const params = await route.getParams();
-      for (const param of params) {
-        let dynamicPath = route.pathname;
-        for (const segment of route.dynamicSegments) {
-          dynamicPath = dynamicPath.replace(`[${segment}]`, param[segment]);
+      try {
+        const params = await route.getParams();
+        if (debug) {
+          console.log(`[next-sitemap] ${route.pathname}: generateStaticParams returned ${params.length} params`);
         }
-        if (!seenPaths.has(dynamicPath)) {
-          allPaths.push(dynamicPath);
-          seenPaths.add(dynamicPath);
+        for (const param of params) {
+          let dynamicPath = route.pathname;
+          for (const segment of route.dynamicSegments) {
+            const value = param[segment];
+            if (value === void 0) {
+              if (debug) {
+                console.warn(`[next-sitemap] ${route.pathname}: missing param "${segment}" in`, param);
+              }
+              continue;
+            }
+            dynamicPath = dynamicPath.replace(`[${segment}]`, value);
+          }
+          if (!seenPaths.has(dynamicPath)) {
+            allPaths.push(dynamicPath);
+            seenPaths.add(dynamicPath);
+          }
         }
+      } catch (error) {
+        console.error(`[next-sitemap] Error calling generateStaticParams for ${route.pathname}:`, error);
+      }
+    } else if (route.dynamicSegments.length > 0) {
+      if (debug) {
+        console.warn(
+          `[next-sitemap] Skipping dynamic route ${route.pathname}: no generateStaticParams exported. Use additionalSitemaps for routes that fetch data at runtime.`
+        );
       }
     }
   }
@@ -158,12 +190,20 @@ function pathsToEntries(paths, config) {
   });
 }
 function createSitemapIndexHandler(options) {
-  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, additionalSitemaps, exclude } = options;
+  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, additionalSitemaps, exclude, debug = false } = options;
   const localeSegment = options.localeSegment ?? (locales.length > 0 || defaultLocale ? "[locale]" : "");
   const routes = extractRoutes(options.pagesContext, localeSegment);
+  if (debug) {
+    console.log(`[next-sitemap] Found ${routes.length} routes:`);
+    routes.forEach((r) => {
+      const hasParams = r.getParams ? "\u2713 generateStaticParams" : "\u2717 no generateStaticParams";
+      const segments = r.dynamicSegments.length > 0 ? ` [${r.dynamicSegments.join(", ")}]` : "";
+      console.log(`  ${r.pathname}${segments} - ${hasParams}`);
+    });
+  }
   return {
     GET: async () => {
-      const allPaths = await getAllPaths(routes);
+      const allPaths = await getAllPaths(routes, debug);
       const filteredPaths = allPaths.filter((pathname) => !shouldExclude(pathname, exclude));
       const sitemapCount = Math.max(1, Math.ceil(filteredPaths.length / urlsPerSitemap));
       const xml = generateSitemapIndexXml(options.baseUrl, sitemapCount, {
@@ -176,11 +216,11 @@ function createSitemapIndexHandler(options) {
   };
 }
 function createSitemapHandler(options) {
-  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, exclude } = options;
+  const { urlsPerSitemap = 5e3, locales = [], defaultLocale, exclude, debug = false } = options;
   const localeSegment = options.localeSegment ?? (locales.length > 0 || defaultLocale ? "[locale]" : "");
   const routes = extractRoutes(options.pagesContext, localeSegment);
   const getFilteredPaths = async () => {
-    const allPaths = await getAllPaths(routes);
+    const allPaths = await getAllPaths(routes, debug);
     return allPaths.filter((pathname) => !shouldExclude(pathname, exclude));
   };
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onruntime/next-sitemap",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Dynamic sitemap generation for Next.js with automatic route discovery",
   "author": "onRuntime Studio <contact@onruntime.com>",
   "repository": {