@the-smithy/hearth 0.25.0 → 0.26.0

package/README.md

@@ -52,6 +52,11 @@ curl -H "Authorization: Bearer $HEARTH_API_KEY" https://hearth.thesmithy.io/admi
 
 Keep `hearth-api.md` out of git, and the key out of chat: the agent only needs it in `.env.local`.
 
+## Hosting
+
+Netlify and Vercel both work with no host-specific code. Sites made from the starter have a guide to each in
+`HOSTING.md`, and `llms.md` has the short version.
+
 ## Documentation
 
 Once you have developer access, the full documentation (every method, Next.js helpers, rendering blocks,

package/dist/next.d.ts

@@ -5,6 +5,11 @@ import { Metadata, MetadataRoute } from 'next';
 
 /** Holds the preview token while Next.js draft mode is on. */
 declare const PREVIEW_COOKIE = "hearth-preview";
+/**
+ * The visitor's IP. Netlify's own header only counts on Netlify, whose functions always have SITE_ID: anywhere else a
+ * visitor could send it themselves to get round the rate limits. Vercel overwrites x-forwarded-for, so it's safe there.
+ */
+declare const clientIp: (h: Headers) => string | null;
 /**
  * Whether this deploy is a preview or branch deploy (Netlify's CONTEXT, Vercel's VERCEL_ENV), which search engines
  * shouldn't index: only the production deploy is the real site.
@@ -285,4 +290,4 @@ declare function createHearthNext(client: HearthCore, { tag, revalidate }?: Hear
     submitFormAction: (formKey: string) => (_prev: FormResult | null, formData: FormData) => Promise<FormResult>;
 };
 
-export { type HearthNextOptions, PREVIEW_COOKIE, createHearthNext, isNonProductionDeploy, metadataFromMeta, siteBaseUrl, siteLang };
+export { type HearthNextOptions, PREVIEW_COOKIE, clientIp, createHearthNext, isNonProductionDeploy, metadataFromMeta, siteBaseUrl, siteLang };

package/dist/next.js

@@ -18,7 +18,7 @@ async function previewToken() {
   if (!(await draftMode()).isEnabled) return void 0;
   return (await cookies()).get(PREVIEW_COOKIE)?.value;
 }
-var clientIp = (h) => h.get("x-nf-client-connection-ip") ?? h.get("x-forwarded-for")?.split(",")[0]?.trim() ?? h.get("x-real-ip");
+var clientIp = (h) => (process.env.SITE_ID ? h.get("x-nf-client-connection-ip") : null) ?? h.get("x-forwarded-for")?.split(",")[0]?.trim() ?? h.get("x-real-ip");
 var safePath = (path) => path && path.startsWith("/") && !path.startsWith("//") ? path : "/";
 var isNonProductionDeploy = () => {
   const netlify = process.env.CONTEXT;
@@ -332,6 +332,7 @@ function createHearthNext(client, { tag = "hearth", revalidate = 3600 } = {}) {
 }
 export {
   PREVIEW_COOKIE,
+  clientIp,
   createHearthNext,
   isNonProductionDeploy,
   metadataFromMeta,

package/llms.md

@@ -6,7 +6,7 @@ client components: the API key is secret.
 ## Setup
 - Sites made with `pnpm create @the-smithy/hearth-site` already have all of this, and every block, page and form,
   in `src/hearth/` (the client is `@/hearth/client`). Don't rebuild them: style the site in `src/theme/` (tokens,
-  and Tailwind classes per slot; `src/hearth/theme/defaults.ts` lists the slots) and read the site's `CLAUDE.md`.
+  and Tailwind classes per slot; `src/hearth/theme/defaults.ts` lists the slots) and read the site's `AGENTS.md`.
   `pnpm hearth:update` brings in new releases. The rest of this section is for other Next.js apps.
 - `pnpm add @the-smithy/hearth` (public on npm; no registry config or token needed). It's useless without a
   Hearth site's API key. The full guide is in Hearth under API docs (Markdown download).
@@ -114,6 +114,11 @@ client components: the API key is secret.
   how-to guides (a "guides" collection) read inside The Smithy's products. Same blocks and structure everywhere;
   each product passes its own class names (`GuideTheme`) and Markdown renderer. No CSS ships with it.
 
+## Hosting
+Netlify and Vercel both work with no host-specific code. Set `HEARTH_SITE` and `HEARTH_API_KEY` at the host before the
+first build, since it reads Hearth. Point the publish webhook at `https://<primary domain>/api/revalidate` and set
+`HEARTH_WEBHOOK_SECRET`, then deploy again. Sites from the starter have the full guide in `HOSTING.md`.
+
 ## Other entry points
 - `@the-smithy/hearth/webhooks`: `verifyWebhook(raw, header, secret)`, `parseWebhook(request, secret)`,
   `tagsForWebhook(payload)`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@the-smithy/hearth",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "Typed client for the Hearth Delivery API: content, SEO, forms and publish webhooks.",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -49,7 +49,7 @@
     "llms.md"
   ],
   "dependencies": {
-    "@the-smithy/hearth-schema": "^0.25.0"
+    "@the-smithy/hearth-schema": "^0.26.0"
   },
   "peerDependencies": {
     "next": ">=15",