Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

feat: Sitemap endpoint support (#2565)

Ivan Starkov3eba3e1edea2
diff --git a/fixtures/webstudio-custom-template/app/__generated__/[sitemap.xml].ts b/fixtures/webstudio-custom-template/app/__generated__/[sitemap.xml].ts
new file mode 100644
index 0000000000..419fc83e31
--- /dev/null
+++ b/fixtures/webstudio-custom-template/app/__generated__/[sitemap.xml].ts
@@ -0,0 +1,7 @@
+export const sitemap = {
+ pages: [
+ {
+ path: "",
+ },
+ ],
+};
diff --git a/fixtures/webstudio-custom-template/app/routes/[sitemap.xml].tsx b/fixtures/webstudio-custom-template/app/routes/[sitemap.xml].tsx
new file mode 100644
index 0000000000..43782d0c18
--- /dev/null
+++ b/fixtures/webstudio-custom-template/app/routes/[sitemap.xml].tsx
@@ -0,0 +1,25 @@
+import type { LoaderArgs } from "@remix-run/server-runtime";
+
+export const loader = (arg: LoaderArgs) => {
+ const host =
+ arg.request.headers.get("x-forwarded-host") ||
+ arg.request.headers.get("host") ||
+ "";
+
+ return new Response(
+ `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+ <url>
+ <loc>https://${host}/</loc>
+ <lastmod>2023-11-05</lastmod>
+ </url>
+</urlset>
+ `,
+ {
+ headers: {
+ "Content-Type": "application/xml",
+ },
+ status: 200,
+ }
+ );
+};
diff --git a/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/[sitemap.xml].ts b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/[sitemap.xml].ts
new file mode 100644
index 0000000000..419fc83e31
--- /dev/null
+++ b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/[sitemap.xml].ts
@@ -0,0 +1,7 @@
+export const sitemap = {
+ pages: [
+ {
+ path: "",
+ },
+ ],
+};
diff --git a/fixtures/webstudio-remix-netlify-edge-functions/app/routes/[sitemap.xml].tsx b/fixtures/webstudio-remix-netlify-edge-functions/app/routes/[sitemap.xml].tsx
new file mode 100644
index 0000000000..43782d0c18
--- /dev/null
+++ b/fixtures/webstudio-remix-netlify-edge-functions/app/routes/[sitemap.xml].tsx
@@ -0,0 +1,25 @@
+import type { LoaderArgs } from "@remix-run/server-runtime";
+
+export const loader = (arg: LoaderArgs) => {
+ const host =
+ arg.request.headers.get("x-forwarded-host") ||
+ arg.request.headers.get("host") ||
+ "";
+
+ return new Response(
+ `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+ <url>
+ <loc>https://${host}/</loc>
+ <lastmod>2023-11-05</lastmod>
+ </url>
+</urlset>
+ `,
+ {
+ headers: {
+ "Content-Type": "application/xml",
+ },
+ status: 200,
+ }
+ );
+};
diff --git a/fixtures/webstudio-remix-netlify-functions/app/__generated__/[sitemap.xml].ts b/fixtures/webstudio-remix-netlify-functions/app/__generated__/[sitemap.xml].ts
new file mode 100644
index 0000000000..419fc83e31
--- /dev/null
+++ b/fixtures/webstudio-remix-netlify-functions/app/__generated__/[sitemap.xml].ts
@@ -0,0 +1,7 @@
+export const sitemap = {
+ pages: [
+ {
+ path: "",
+ },
+ ],
+};
diff --git a/fixtures/webstudio-remix-netlify-functions/app/routes/[sitemap.xml].tsx b/fixtures/webstudio-remix-netlify-functions/app/routes/[sitemap.xml].tsx
new file mode 100644
index 0000000000..43782d0c18
--- /dev/null
+++ b/fixtures/webstudio-remix-netlify-functions/app/routes/[sitemap.xml].tsx
@@ -0,0 +1,25 @@
+import type { LoaderArgs } from "@remix-run/server-runtime";
+
+export const loader = (arg: LoaderArgs) => {
+ const host =
+ arg.request.headers.get("x-forwarded-host") ||
+ arg.request.headers.get("host") ||
+ "";
+
+ return new Response(
+ `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+ <url>
+ <loc>https://${host}/</loc>
+ <lastmod>2023-11-05</lastmod>
+ </url>
+</urlset>
+ `,
+ {
+ headers: {
+ "Content-Type": "application/xml",
+ },
+ status: 200,
+ }
+ );
+};
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[sitemap.xml].ts b/fixtures/webstudio-remix-vercel/app/__generated__/[sitemap.xml].ts
new file mode 100644
index 0000000000..378018b587
--- /dev/null
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[sitemap.xml].ts
@@ -0,0 +1,19 @@
+export const sitemap = {
+ pages: [
+ {
+ path: "",
+ },
+ {
+ path: "/radix",
+ },
+ {
+ path: "/_route_with_symbols_",
+ },
+ {
+ path: "/form",
+ },
+ {
+ path: "/heading-with-id",
+ },
+ ],
+};
diff --git a/fixtures/webstudio-remix-vercel/app/routes/[sitemap.xml].tsx b/fixtures/webstudio-remix-vercel/app/routes/[sitemap.xml].tsx
new file mode 100644
index 0000000000..43782d0c18
--- /dev/null
+++ b/fixtures/webstudio-remix-vercel/app/routes/[sitemap.xml].tsx
@@ -0,0 +1,25 @@
+import type { LoaderArgs } from "@remix-run/server-runtime";
+
+export const loader = (arg: LoaderArgs) => {
+ const host =
+ arg.request.headers.get("x-forwarded-host") ||
+ arg.request.headers.get("host") ||
+ "";
+
+ return new Response(
+ `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+ <url>
+ <loc>https://${host}/</loc>
+ <lastmod>2023-11-05</lastmod>
+ </url>
+</urlset>
+ `,
+ {
+ headers: {
+ "Content-Type": "application/xml",
+ },
+ status: 200,
+ }
+ );
+};
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index fbecb41e14..2e5b58687d 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -307,6 +307,7 @@ export const prebuild = async (options: {
assets: new Map(siteData.assets.map((asset) => [asset.id, asset])),
pages: new Map(siteData.pages.map((page) => [page.id, page])),
});
+
const props: [Prop["id"], Prop][] = [];
for (const prop of normalizedProps) {
if (pageInstanceSet.has(prop.instanceId)) {
@@ -560,6 +561,22 @@ ${utilsExport}
);
await ensureFileInPath(join(generatedDir, "index.css"), cssText);
+ await writeFile(
+ join(generatedDir, "[sitemap.xml].ts"),
+ `
+ export const sitemap = ${JSON.stringify(
+ {
+ pages: siteData.pages.map((page) => ({
+ path: page.path,
+ lastModified: siteData.build.updatedAt,
+ })),
+ },
+ null,
+ 2
+ )};
+ `
+ );
+
spinner.text = "Downloading fonts and images";
await Promise.all(assetsToDownload);
diff --git a/packages/cli/templates/defaults/app/__generated__/[sitemap.xml].ts b/packages/cli/templates/defaults/app/__generated__/[sitemap.xml].ts
new file mode 100644
index 0000000000..cd4c7ff537
--- /dev/null
+++ b/packages/cli/templates/defaults/app/__generated__/[sitemap.xml].ts
@@ -0,0 +1,4 @@
+/**
+ * The only intent of this file is to support typings inside ../routes/[sitemap.xml].tsx for easier development.
+ **/
+export const sitemap = {};
diff --git a/packages/cli/templates/defaults/app/routes/[sitemap.xml].tsx b/packages/cli/templates/defaults/app/routes/[sitemap.xml].tsx
new file mode 100644
index 0000000000..43782d0c18
--- /dev/null
+++ b/packages/cli/templates/defaults/app/routes/[sitemap.xml].tsx
@@ -0,0 +1,25 @@
+import type { LoaderArgs } from "@remix-run/server-runtime";
+
+export const loader = (arg: LoaderArgs) => {
+ const host =
+ arg.request.headers.get("x-forwarded-host") ||
+ arg.request.headers.get("host") ||
+ "";
+
+ return new Response(
+ `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+ <url>
+ <loc>https://${host}/</loc>
+ <lastmod>2023-11-05</lastmod>
+ </url>
+</urlset>
+ `,
+ {
+ headers: {
+ "Content-Type": "application/xml",
+ },
+ status: 200,
+ }
+ );
+};
diff --git a/packages/http-client/src/index.ts b/packages/http-client/src/index.ts
index 64ea165cea..7467d674a9 100644
--- a/packages/http-client/src/index.ts
+++ b/packages/http-client/src/index.ts
@@ -21,6 +21,7 @@ export type Data = {
projectId: string;
version: number;
createdAt: string;
+ updatedAt: string;
pages: Pages;
breakpoints: [Breakpoint["id"], Breakpoint][];
styles: [StyleDeclKey, StyleDecl][];
diff --git a/packages/project-build/package.json b/packages/project-build/package.json
index 9bc7a1dba7..3701b145c9 100644
--- a/packages/project-build/package.json
+++ b/packages/project-build/package.json
@@ -41,6 +41,7 @@
},
"devDependencies": {
"@jest/globals": "^29.7.0",
+ "@webstudio-is/http-client": "workspace:*",
"@webstudio-is/jest-config": "workspace:*",
"@webstudio-is/tsconfig": "workspace:*",
"type-fest": "^4.3.1",
diff --git a/packages/project-build/src/db/build.ts b/packages/project-build/src/db/build.ts
index 8223c137eb..a9c0754cef 100644
--- a/packages/project-build/src/db/build.ts
+++ b/packages/project-build/src/db/build.ts
@@ -25,6 +25,7 @@ import { parseProps } from "./props";
import { parseDataSources } from "./data-sources";
import { parseInstances, serializeInstances } from "./instances";
import { parseDeployment, serializeDeployment } from "./deployment";
+import type { Data } from "@webstudio-is/http-client";
const parseBuild = async (build: DbBuild): Promise<Build> => {
// eslint-disable-next-line no-console
@@ -43,11 +44,12 @@ const parseBuild = async (build: DbBuild): Promise<Build> => {
const deployment = parseDeployment(build.deployment);
- return {
+ const result: Build = {
id: build.id,
projectId: build.projectId,
version: build.version,
createdAt: build.createdAt.toISOString(),
+ updatedAt: build.updatedAt.toISOString(),
pages,
breakpoints,
styles,
@@ -57,7 +59,9 @@ const parseBuild = async (build: DbBuild): Promise<Build> => {
dataSources,
instances,
deployment,
- };
+ } satisfies Data["build"];
+
+ return result;
} finally {
// eslint-disable-next-line no-console
console.timeEnd("parseBuild");
diff --git a/packages/project-build/src/types.ts b/packages/project-build/src/types.ts
index f98091b811..55c0ff4c02 100644
--- a/packages/project-build/src/types.ts
+++ b/packages/project-build/src/types.ts
@@ -16,6 +16,7 @@ export type Build = {
projectId: string;
version: number;
createdAt: string;
+ updatedAt: string;
pages: Pages;
breakpoints: [Breakpoint["id"], Breakpoint][];
styles: [StyleDeclKey, StyleDecl][];
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index ea43647220..335ffe308c 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1541,6 +1541,9 @@ importers:
'@jest/globals':
specifier: ^29.7.0
version: 29.7.0
+ '@webstudio-is/http-client':
+ specifier: workspace:*
+ version: link:../http-client
'@webstudio-is/jest-config':
specifier: workspace:*
version: link:../jest-config