rankrunners-cms 0.0.15 → 0.0.17

package/README.md

@@ -130,7 +130,45 @@ export const Heading: ComponentConfig<HeadingProps> = {
 
 ---
 
-## 6. Developer Checklist
+## 6. Sitemap & Robots.txt Support
+
+To add support for these, you need to create the following server-side routes in your TanStack Router setup.
+
+### Sitemap Support
+Create a file called `src/routes/$sitemap.xml.tsx`:
+
+```tsx
+import { createFileRoute } from '@tanstack/react-router'
+import { downloadSitemapAsResponse } from 'rankrunners-cms/src/api/client/sitemap'
+
+export const Route = createFileRoute('/$sitemap.xml')({
+  server: {
+    handlers: {
+      GET: ({ params }) => downloadSitemapAsResponse(params['sitemap.xml']),
+    },
+  },
+})
+```
+
+### Robots.txt Support
+Create a file called `src/routes/robots[.]txt.tsx`:
+
+```tsx
+import { createFileRoute } from '@tanstack/react-router'
+import { downloadSitemapAsResponse } from 'rankrunners-cms/src/api/client/sitemap'
+
+export const Route = createFileRoute('/robots.txt')({
+  server: {
+    handlers: {
+      GET: () => downloadSitemapAsResponse('robots.txt'),
+    },
+  },
+})
+```
+
+---
+
+## 7. Developer Checklist
 
 Use this checklist to ensure a complete and correct integration:
 
@@ -155,9 +193,8 @@ Use this checklist to ensure a complete and correct integration:
 - [ ] Register all blocks in `src/editor/index.tsx`.
 - [ ] Organize blocks into `categories` within the config.
 
-### Persistence & Deployment
-- [ ] Implement `onPublish` logic in the editor route.
-- [ ] (Optional) Set up `server.tsx` blocks for optimal SSR performance.
-- [ ] Verify that `@puckeditor/core/no-external.css` is imported in the editor route.
+### Sitemap & Robots.txt
+- [ ] Add `src/routes/$sitemap.xml.tsx` for dynamic sitemap support.
+- [ ] Add `src/routes/robots.txt.tsx` for `robots.txt` support.
 
 ---

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rankrunners-cms",
   "type": "module",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "peerDependencies": {
     "@puckeditor/core": "^0.21.0",
     "next": "^16.1.2",
@@ -34,7 +34,7 @@
     "typescript": "^5.9.3",
     "@tanstack/router-core": "^1.150.0",
     "@tanstack/react-router": "^1.150.0",
-    "next": "^16.1.2",
+    "next": "^16.1.3",
     "valibot": "^1.2.0",
     "lucide-react": "^0.562.0",
     "react": "^19.2.3"

package/src/api/client/sitemap.ts

@@ -3,7 +3,7 @@ import { CMS_BASE_URL, SITE_ID } from "../constants";
 
 export const downloadSitemap = async (sitemap: string): Promise<string> => {
   const response = await fetchWithCache(
-    `${CMS_BASE_URL}/sites/${SITE_ID}/sitemaps/${sitemap}`
+    `${CMS_BASE_URL}/sites/${SITE_ID}/sitemaps/${sitemap}`,
   );
 
   if (!response.ok) {
@@ -13,3 +13,20 @@ export const downloadSitemap = async (sitemap: string): Promise<string> => {
   const content = await response.text();
   return content;
 };
+
+export const downloadSitemapAsResponse = async (
+  sitemap: string,
+): Promise<Response> => {
+  const sitemapData = await downloadSitemap(sitemap);
+
+  const contentType = sitemap.endsWith(".xml")
+    ? "application/xml"
+    : "text/plain";
+
+  return new Response(sitemapData, {
+    status: 200,
+    headers: {
+      "Content-Type": contentType,
+    },
+  });
+};

package/src/editor/render/PageRendererContent.tsx

@@ -1,4 +1,4 @@
-import { useState } from "react";
+import { useEffect, useState } from "react";
 import type { CMSUserData } from "../types";
 import { Render, type Config } from "@puckeditor/core";
 import { CMS_BASE_URL, SITE_ID } from "../../api";
@@ -6,7 +6,7 @@ import { fetchWithCache } from "../../libs";
 
 const getPageContents = async (
   pathname: string,
-  allPageData: Record<string, CMSUserData<any>>
+  allPageData: Record<string, CMSUserData<any>>,
 ) => {
   // remove trailing (left and right) slashes
   pathname = pathname.replace(/^\/+|\/+$/g, "");
@@ -18,13 +18,10 @@ const getPageContents = async (
         headers: {
           "Content-Type": "application/json",
         },
-      }
+      },
     );
 
     if (res.ok) {
-      //  console.error("Failed to fetch page data from CMS");
-      //  throw new Error("Failed to fetch page data from CMS");
-      //}
       const json = (await res.json()) as { content?: string };
 
       if (json.content) {
@@ -68,13 +65,13 @@ export const PageRendererContent = ({
 }: PageRendererContentProps) => {
   const [data, setData] = useState<CMSUserData<any> | null>(null);
 
-  useState(() => {
+  useEffect(() => {
     const fetchData = async () => {
       const pageData = await getPageContents(pathname, allPageData);
       setData(pageData);
     };
     fetchData();
-  });
+  }, [pathname]);
 
   if (!data) {
     return (

package/src/tanstack/editor/PageRenderer.tsx

@@ -0,0 +1,30 @@
+import type { Config } from "@puckeditor/core";
+import { PageRendererContent } from "../../editor";
+import { EditorTanstack } from ".";
+import { usePathnameTanstack, useSearchParamsTanstack } from "../hooks";
+import type { CMSUserData } from "../../editor";
+
+export type PageRendererTanstackInitializerProps = {
+  config: Config;
+  allPageData: Record<string, CMSUserData<any>>;
+};
+
+export const PageRendererTanstack =
+  ({ config, allPageData }: PageRendererTanstackInitializerProps) =>
+  () => {
+    const pathname = usePathnameTanstack();
+    const searchParams = useSearchParamsTanstack();
+    const previewToken = searchParams.get("preview");
+
+    if (previewToken) {
+      return <EditorTanstack config={config} allPageData={allPageData} />;
+    }
+
+    return (
+      <PageRendererContent
+        config={config}
+        allPageData={allPageData}
+        pathname={pathname}
+      />
+    );
+  };

package/src/tanstack/editor/index.ts

@@ -1 +1,2 @@
 export * from "./Editor";
+export * from "./PageRenderer";