@sandboxsonny/ace-kit 0.12.0 → 0.12.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @sandboxsonny/ace-kit
 
+## 0.12.1
+
+### Patch Changes
+
+- ea4efe1: Fix the addresses in `sitemap.xml` and `robots.txt` on a site behind a proxy. They were built from the address the server was reached at, which behind a proxy such as Railway is the server's own internal address (`http://localhost:8080`). They now use the site's domain in the CMS (`ACE_SITE_DOMAIN`) over https, and fall back to the request's address only for a site on `localhost` or a `.test` domain. Also adds `client.siteDomain`.
+
 ## 0.12.0
 
 ### Minor Changes

package/dist/astro.d.ts

@@ -147,6 +147,7 @@ type AcePage<Values = Record<string, unknown>> =
 
 /** The client for this site, made from the integration's settings. Most pages only need the functions below. */
 declare const ace: {
+    siteDomain: string;
     getEntry<Handle extends AceContentTypeHandle>(contentTypeHandle: Handle, handle: string, options?: {
         previewToken?: string | null;
     }): Promise<AceEntry<AceValuesOf<Handle>> | null>;
@@ -211,7 +212,7 @@ declare function getPage<Values = Record<string, unknown>>(astro: {
  *     import { getSitemapResponse } from "@sandboxsonny/ace-kit/astro";
  *     export const GET = ({ url }) => getSitemapResponse({ url });
  *
- * The addresses use https unless the site is on localhost; pass `{ origin: "https://example.com" }` to choose.
+ * The addresses are the site's domain (`ACE_SITE_DOMAIN`) over https, or the address of the request for a site on localhost; pass `{ origin: "https://example.com" }` to choose.
  */
 declare const getSitemapResponse: (astro: {
     url: URL;

package/dist/astro.js

@@ -1,4 +1,4 @@
-import { createAceClient, loadMenuLinks, loadPage, sitemapResponse, robotsResponse } from './chunk-AJLQFATM.js';
+import { createAceClient, loadMenuLinks, loadPage, sitemapResponse, robotsResponse } from './chunk-RW4CVLES.js';
 import './chunk-M5WR5TCR.js';
 import './chunk-YLO6IAXF.js';
 import { ACE_SITE_DOMAIN, ACE_API_URL } from 'astro:env/server';
@@ -22,6 +22,6 @@ async function getPage(astro) {
   return page;
 }
 var getSitemapResponse = (astro, options = {}) => sitemapResponse(ace, astro.url, options);
-var getRobotsResponse = (astro, options = {}) => robotsResponse(astro.url, options);
+var getRobotsResponse = (astro, options = {}) => robotsResponse(astro.url, options, ace.siteDomain);
 
 export { ace, applyPage, getEntries, getEntry, getMenu, getMenuLinks, getPage, getRobotsResponse, getSite, getSitemapResponse };

package/dist/{chunk-AJLQFATM.js → chunk-RW4CVLES.js}

@@ -67,6 +67,8 @@ function createAceClient({
     return value;
   }
   return {
+    /** The domain of the site this client reads, as the CMS knows it. */
+    siteDomain,
     /**
      * One live entry of a content type, by its handle; null if the site has no such entry. With a preview token the
      * entry the token was made for comes back with its draft applied (never cached); a token that has run out throws
@@ -175,9 +177,11 @@ async function notFoundOrRedirect(client, url, previewToken, headers) {
 
 // src/helpers/sitemap.ts
 var escapeXml = (text) => text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
-function publicOrigin(url) {
-  const local = url.hostname === "localhost" || url.hostname.endsWith(".localhost") || /^[\d.]+$|:/.test(url.hostname);
-  return local ? url.origin : `https://${url.host}`;
+var isLocalHost = (host) => host === "localhost" || /\.(localhost|test|local)$/.test(host) || /^[\d.]+$|:/.test(host);
+function publicOrigin(url, siteDomain) {
+  const domain = siteDomain?.trim().toLowerCase();
+  if (domain && !isLocalHost(domain)) return `https://${domain}`;
+  return isLocalHost(url.hostname) ? url.origin : `https://${url.host}`;
 }
 function sitemapXml(entries, origin) {
   const base = origin.replace(/\/+$/, "");
@@ -204,7 +208,7 @@ Sitemap: ${origin.replace(/\/+$/, "")}/sitemap.xml
 async function sitemapResponse(client, url, options = {}) {
   try {
     const entries = await client.getSitemap();
-    return new Response(sitemapXml(entries, options.origin ?? publicOrigin(url)), {
+    return new Response(sitemapXml(entries, options.origin ?? publicOrigin(url, client.siteDomain)), {
       headers: { "Content-Type": "application/xml; charset=utf-8", "Cache-Control": "public, max-age=300" }
     });
   } catch (error) {
@@ -216,10 +220,13 @@ async function sitemapResponse(client, url, options = {}) {
     });
   }
 }
-function robotsResponse(url, options = {}) {
-  return new Response(robotsTxt({ origin: options.origin ?? publicOrigin(url), disallowAll: options.disallowAll }), {
-    headers: { "Content-Type": "text/plain; charset=utf-8", "Cache-Control": "public, max-age=3600" }
-  });
+function robotsResponse(url, options = {}, siteDomain) {
+  return new Response(
+    robotsTxt({ origin: options.origin ?? publicOrigin(url, siteDomain), disallowAll: options.disallowAll }),
+    {
+      headers: { "Content-Type": "text/plain; charset=utf-8", "Cache-Control": "public, max-age=3600" }
+    }
+  );
 }
 
 export { AcePreviewExpiredError, AceUnavailableError, createAceClient, isCurrentPage, linksFromMenu, loadMenuLinks, loadPage, publicOrigin, robotsResponse, robotsTxt, sitemapResponse, sitemapXml };

package/dist/cli.js

@@ -9,8 +9,8 @@ if (major < 22 || major === 22 && minor < 12) {
   process.exit(1);
 }
 try {
-  const { createRealEnvironment } = await import("./environment-4FBNWIHO.js");
-  const { runCli } = await import("./main-4QMQF3L3.js");
+  const { createRealEnvironment } = await import("./environment-CXO6CVNR.js");
+  const { runCli } = await import("./main-4TEJQB6N.js");
   const environment = await createRealEnvironment();
   process.exit(await runCli(process.argv.slice(2), environment));
 } catch (error) {

package/dist/{environment-4FBNWIHO.js → environment-CXO6CVNR.js}

@@ -145,7 +145,7 @@ function createLastApiUrl(path) {
 }
 
 // src/cli/version.ts
-var aceKitVersion = true ? "0.12.0" : "development";
+var aceKitVersion = true ? "0.12.1" : "development";
 
 // src/cli/environment.ts
 var runCommand = (command, commandArguments, input) => new Promise((resolve, reject) => {

package/dist/index.d.ts

@@ -147,6 +147,8 @@ type AceSitemapEntry = {
  * is sent too, for an API that predates the first (some platforms' proxies rewrite X-Forwarded-Host on the way in).
  */
 declare function createAceClient({ apiUrl, siteDomain, cacheSeconds, fetchImplementation, now, }: AceClientOptions): {
+    /** The domain of the site this client reads, as the CMS knows it. */
+    siteDomain: string;
     /**
      * One live entry of a content type, by its handle; null if the site has no such entry. With a preview token the
      * entry the token was made for comes back with its draft applied (never cached); a token that has run out throws
@@ -562,11 +564,12 @@ type AceSeoProperties = {
 declare function seoProperties(options: AceSeoOptions): AceSeoProperties;
 
 /**
- * The address a visitor reached the site at, for the full addresses in a sitemap. A site on a real domain is served
- * over https, but behind a proxy the server often sees plain http, so anything that isn't `localhost` or an IP address
- * is given https. Pass `origin` to the response helpers to choose it yourself.
+ * The address the site's pages are at, for the full addresses in a sitemap. It is the site's domain in the CMS
+ * (`ACE_SITE_DOMAIN`) over https, because behind a proxy the server only sees its own internal address
+ * (`localhost:8080` on Railway), so the request can't say. For a site on `localhost` (or a `.test` domain), which
+ * has no public address, it is the address the request came to. Pass `origin` to the response helpers to choose it.
  */
-declare function publicOrigin(url: URL): string;
+declare function publicOrigin(url: URL, siteDomain?: string): string;
 /** The sitemap file for a site: one `<url>` per page, with when it last changed. `origin` is e.g. `https://example.com`. */
 declare function sitemapXml(entries: AceSitemapEntry[], origin: string): string;
 type RobotsOptions = {
@@ -588,7 +591,7 @@ declare function sitemapResponse(client: AceClient, url: URL, options?: {
     origin?: string;
 }): Promise<Response>;
 /** The response for `/robots.txt`. */
-declare function robotsResponse(url: URL, options?: RobotsOptions): Response;
+declare function robotsResponse(url: URL, options?: RobotsOptions, siteDomain?: string): Response;
 
 /**
  * A text area field's text as HTML. With `multiline` (the default) blank lines start new paragraphs (`<p>`) and a

package/dist/index.js

@@ -1,7 +1,7 @@
 export { pageNotices } from './chunk-XPZY5R5A.js';
 export { headingLevel, imageAttributes, isInternalPath, linkAddress, linkAttributes, listStart, renderRichText, renderTextArea, richTextImageSizes } from './chunk-FVR55GIU.js';
 export { listenForPreviewRefresh, refreshPageContent } from './chunk-YN7LJWGI.js';
-export { AcePreviewExpiredError, AceUnavailableError, createAceClient, isCurrentPage, linksFromMenu, loadMenuLinks, loadPage, publicOrigin, robotsResponse, robotsTxt, sitemapResponse, sitemapXml } from './chunk-AJLQFATM.js';
+export { AcePreviewExpiredError, AceUnavailableError, createAceClient, isCurrentPage, linksFromMenu, loadMenuLinks, loadPage, publicOrigin, robotsResponse, robotsTxt, sitemapResponse, sitemapXml } from './chunk-RW4CVLES.js';
 export { addressFromPath, homeAddress, isHomeAddress, pathOfAddress, visitablePath } from './chunk-M5WR5TCR.js';
 export { addFramingPolicy, framingPolicy, isRefreshRequest, originOf, previewHeaders, previewParameter, previewTokenFrom, refreshMessageType, swapPageContent } from './chunk-YLO6IAXF.js';
 

package/dist/{main-4QMQF3L3.js → main-4TEJQB6N.js}

@@ -1345,6 +1345,8 @@ function createAceClient({
     return value;
   }
   return {
+    /** The domain of the site this client reads, as the CMS knows it. */
+    siteDomain,
     /**
      * One live entry of a content type, by its handle; null if the site has no such entry. With a preview token the
      * entry the token was made for comes back with its draft applied (never cached); a token that has run out throws

package/dist/react-router-server.d.ts

@@ -150,6 +150,8 @@ type AceSitemapEntry = {
  * is sent too, for an API that predates the first (some platforms' proxies rewrite X-Forwarded-Host on the way in).
  */
 declare function createAceClient({ apiUrl, siteDomain, cacheSeconds, fetchImplementation, now, }: AceClientOptions): {
+    /** The domain of the site this client reads, as the CMS knows it. */
+    siteDomain: string;
     /**
      * One live entry of a content type, by its handle; null if the site has no such entry. With a preview token the
      * entry the token was made for comes back with its draft applied (never cached); a token that has run out throws
@@ -252,7 +254,7 @@ declare function createPageLoader<Values = Record<string, unknown>>(): ({ reques
  *
  *     export { sitemapLoader as loader } from "@sandboxsonny/ace-kit/react-router/server";
  *
- * It uses https unless the site is on localhost; for another address use `createSitemapLoader({ origin })`.
+ * It uses the site's domain (`ACE_SITE_DOMAIN`) over https, or the address of the request for a site on localhost; for another address use `createSitemapLoader({ origin })`.
  */
 declare const createSitemapLoader: (options?: {
     origin?: string;

package/dist/react-router-server.js

@@ -1,4 +1,4 @@
-import { createAceClient, loadMenuLinks, loadPage, sitemapResponse, robotsResponse } from './chunk-AJLQFATM.js';
+import { createAceClient, loadMenuLinks, loadPage, sitemapResponse, robotsResponse } from './chunk-RW4CVLES.js';
 import './chunk-M5WR5TCR.js';
 import { hostedAdminOrigin, hostedApiUrl } from './chunk-N5DIMG3X.js';
 import { previewTokenFrom, addFramingPolicy } from './chunk-YLO6IAXF.js';
@@ -48,7 +48,7 @@ var createSitemapLoader = (options = {}) => function loader2({ request }) {
 };
 var sitemapLoader = createSitemapLoader();
 var createRobotsLoader = (options = {}) => function loader2({ request }) {
-  return robotsResponse(new URL(request.url), options);
+  return robotsResponse(new URL(request.url), options, getAceClient().siteDomain);
 };
 var robotsLoader = createRobotsLoader();
 var loader = createPageLoader();

package/docs/astro.md

@@ -64,7 +64,7 @@ import { getRobotsResponse } from "@sandboxsonny/ace-kit/astro";
 export const GET = ({ url }) => getRobotsResponse({ url });
 ```
 
-Addresses in the sitemap use `https` unless the site is on `localhost`; pass `{ origin: "https://www.example.com" }` to either to choose. `getRobotsResponse({ url }, { disallowAll: true })` asks crawlers to stay away, for a site that isn't live yet. Delete any `robots.txt` in `public/`, which would take its place.
+Addresses in the sitemap are your site's domain (`ACE_SITE_DOMAIN`) over `https`, or the address of the request when the site is on `localhost`; pass `{ origin: "https://www.example.com" }` to either to choose. `getRobotsResponse({ url }, { disallowAll: true })` asks crawlers to stay away, for a site that isn't live yet. Delete any `robots.txt` in `public/`, which would take its place.
 
 ## Reading content
 

package/docs/react-router.md

@@ -116,7 +116,7 @@ export { sitemapLoader as loader } from "@sandboxsonny/ace-kit/react-router/serv
 export { robotsLoader as loader } from "@sandboxsonny/ace-kit/react-router/server";
 ```
 
-The sitemap lists the live pages from the CMS (only the content types that have "Entries have their own pages" ticked), with when each last changed. Addresses use `https` unless the site is on `localhost`. For another address, or to keep crawlers away from a site that isn't live yet, use `createSitemapLoader({ origin })` and `createRobotsLoader({ origin, disallowAll })`.
+The sitemap lists the live pages from the CMS (only the content types that have "Entries have their own pages" ticked), with when each last changed. Addresses are your site's domain (`ACE_SITE_DOMAIN`) over `https`, or the address of the request when the site is on `localhost`. For another address, or to keep crawlers away from a site that isn't live yet, use `createSitemapLoader({ origin })` and `createRobotsLoader({ origin, disallowAll })`.
 
 ## Reading content in your own loaders
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sandboxsonny/ace-kit",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "Everything a website needs to use CMS Ace: a typed client, addressing, images, menus, rich text, live preview, and Astro and React adapters.",
   "keywords": [
     "cms",