@the-smithy/hearth 0.15.0 → 0.17.0

package/dist/{chunk-4VLAG4JX.js → chunk-G3UBVAQY.js}

@@ -29,6 +29,7 @@ function tagsForWebhook(payload, base = "hearth") {
   if (payload.kind === "event" || payload.kind === "scheduled") tags.push(`${base}:events`);
   if (payload.kind === "settings") tags.push(`${base}:site`);
   if (payload.kind === "giving") tags.push(`${base}:giving`);
+  if (payload.kind === "redirects") tags.push(`${base}:redirects`);
   return tags;
 }
 

package/dist/{chunk-ZK7X4FDQ.js → chunk-RYCXMQM2.js}

@@ -34,6 +34,19 @@ async function errorFromResponse(res) {
 // src/client.ts
 var DEFAULT_BASE_URL = "https://hearth.thesmithy.io";
 var sleep = (ms) => new Promise((r) => setTimeout(r, ms));
+function findRedirect(redirects, path) {
+  let p = Array.isArray(path) ? `/${path.join("/")}` : path ?? "/";
+  p = p.split(/[?#]/)[0];
+  try {
+    p = decodeURI(p);
+  } catch {
+  }
+  if (!p.startsWith("/")) p = `/${p}`;
+  p = p.replace(/\/{2,}/g, "/");
+  if (p.length > 1) p = p.replace(/\/+$/, "");
+  p = p.toLowerCase();
+  return redirects.find((r) => r.from === p) ?? null;
+}
 function normalizeSlug(slug) {
   const joined = Array.isArray(slug) ? slug.join("/") : slug ?? "";
   const clean = joined.split("/").map((s) => s.trim()).filter(Boolean).join("/").toLowerCase();
@@ -128,7 +141,7 @@ function createCore(options) {
     if (!options.validate || !value) return value;
     const { blockSchema, blockTypes } = await import("@the-smithy/hearth-schema");
     const blocks = value.blocks ?? [];
-    const problems = blocks.filter((b) => blockTypes.includes(b.type) && b.type !== "upcomingEvents" && b.type !== "eventSpotlight").map((b) => ({ b, r: blockSchema.safeParse(b) })).filter((x) => !x.r.success);
+    const problems = blocks.filter((b) => blockTypes.includes(b.type) && b.type !== "upcomingEvents" && b.type !== "pastEvents" && b.type !== "eventSpotlight").map((b) => ({ b, r: blockSchema.safeParse(b) })).filter((x) => !x.r.success);
     if (problems.length) {
       const message = `Hearth ${kind} has ${problems.length} block(s) that don't match the schema: ${problems.map((p) => p.b.type).join(", ")}`;
       if (options.validate === "warn") console.warn(message);
@@ -204,6 +217,10 @@ function createCore(options) {
       }
     },
     sitemap: (o = {}) => request("/sitemap", { ...o, resource: "sitemap" }),
+    redirects: {
+      /** Every redirect on the site (old addresses and where they go now). Empty from Hearth versions without them. */
+      list: async (o = {}) => await maybe("/redirects", { ...o, resource: "redirects.list" }) ?? []
+    },
     fundraisers: {
       /** Fundraisers with progress (sites with Giving). `category` is "group/category". */
       list: (opts = {}, o = {}) => {
@@ -279,6 +296,7 @@ export {
   HearthError,
   isHearthError,
   DEFAULT_BASE_URL,
+  findRedirect,
   normalizeSlug,
   createCore
 };

package/dist/{client-DCiaDdvu.d.ts → client-CnIniG4N.d.ts}

@@ -1,4 +1,4 @@
-import { Collection, CollectionEntry, HearthEvent, Site, PageSummary, Page, HearthEventDetail, RegistrationInput, RegistrationResult, CategoryGroup, SitemapEntry, Fundraiser, FundraiserDetail, DonationInput, DonationCheckout, HearthForm } from '@the-smithy/hearth-schema';
+import { Collection, CollectionEntry, HearthEvent, Site, PageSummary, Page, HearthEventDetail, RegistrationInput, RegistrationResult, CategoryGroup, SitemapEntry, Redirect, Fundraiser, FundraiserDetail, DonationInput, DonationCheckout, HearthForm } from '@the-smithy/hearth-schema';
 
 type HearthErrorCode = "unauthorized" | "not_found" | "bad_request" | "feature_disabled" | "rate_limited" | "server_error" | "network" | "timeout" | "invalid_response";
 /** Any failure talking to Hearth. Messages never contain the API key. */
@@ -101,6 +101,11 @@ type RequestOptions = CallOptions & {
     resource?: string;
 };
 /** "home", "about/team", ["about", "team"], "/about/" → "about/team"-style slug; empty means "home". */
+/**
+ * The redirect for a requested path, if any: matched like Hearth stores them (lowercase, no trailing slash, no query).
+ * `path` is a URL path ("/About/") or a catch-all slug (["about"]).
+ */
+declare function findRedirect(redirects: Redirect[], path: string | string[] | undefined | null): Redirect | null;
 declare function normalizeSlug(slug: string | string[] | undefined | null): string;
 declare function createCore(options: HearthClientOptions): {
     /** The site's address in Hearth. */
@@ -158,6 +163,10 @@ declare function createCore(options: HearthClientOptions): {
         }, o?: CallOptions) => Promise<CollectionPage | EventCollectionPage | null>;
     };
     sitemap: (o?: CallOptions) => Promise<SitemapEntry[]>;
+    redirects: {
+        /** Every redirect on the site (old addresses and where they go now). Empty from Hearth versions without them. */
+        list: (o?: CallOptions) => Promise<Redirect[]>;
+    };
     fundraisers: {
         /** Fundraisers with progress (sites with Giving). `category` is "group/category". */
         list: (opts?: {
@@ -335,4 +344,4 @@ declare function createCore(options: HearthClientOptions): {
 };
 type HearthCore = ReturnType<typeof createCore>;
 
-export { type CallOptions as C, DEFAULT_BASE_URL as D, type EventCollectionPage as E, type FormResult as F, type HearthCore as H, type NextFetchOptions as N, type PreviewSession as P, type RequestContext as R, type HearthClientOptions as a, type CollectionPage as b, type FormValues as c, HearthError as d, type HearthErrorCode as e, type HearthHooks as f, type RequestOptions as g, isHearthError as i, normalizeSlug as n };
+export { type CallOptions as C, DEFAULT_BASE_URL as D, type EventCollectionPage as E, type FormResult as F, type HearthCore as H, type NextFetchOptions as N, type PreviewSession as P, type RequestContext as R, type HearthClientOptions as a, type CollectionPage as b, type FormValues as c, HearthError as d, type HearthErrorCode as e, type HearthHooks as f, type RequestOptions as g, findRedirect as h, isHearthError as i, normalizeSlug as n };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { H as HearthCore, a as HearthClientOptions } from './client-DCiaDdvu.js';
-export { C as CallOptions, b as CollectionPage, D as DEFAULT_BASE_URL, E as EventCollectionPage, F as FormResult, c as FormValues, d as HearthError, e as HearthErrorCode, f as HearthHooks, N as NextFetchOptions, P as PreviewSession, R as RequestContext, g as RequestOptions, i as isHearthError, n as normalizeSlug } from './client-DCiaDdvu.js';
-export { Block, BlockOf, CategoryGroup, CategoryRef, Collection, CollectionEntry, CollectionRef, DonationCheckout, DonationInput, EntryDetails, EventCustomFields, EventRegistration, EventTicket, Fundraiser, FundraiserDetail, HearthEvent, HearthEventDetail, KnownBlock, Page, PageMeta, PageSummary, RegistrationInput, RegistrationResult, ResolvedBlock, Site, SiteSettings, SitemapEntry, UnknownBlock, WebhookPayload, videoEmbedUrl } from '@the-smithy/hearth-schema';
+import { H as HearthCore, a as HearthClientOptions } from './client-CnIniG4N.js';
+export { C as CallOptions, b as CollectionPage, D as DEFAULT_BASE_URL, E as EventCollectionPage, F as FormResult, c as FormValues, d as HearthError, e as HearthErrorCode, f as HearthHooks, N as NextFetchOptions, P as PreviewSession, R as RequestContext, g as RequestOptions, h as findRedirect, i as isHearthError, n as normalizeSlug } from './client-CnIniG4N.js';
+export { Block, BlockOf, CategoryGroup, CategoryRef, Collection, CollectionEntry, CollectionRef, DonationCheckout, DonationInput, EntryDetails, EventCustomFields, EventRegistration, EventTicket, Fundraiser, FundraiserDetail, HearthEvent, HearthEventDetail, KnownBlock, Page, PageMeta, PageSummary, Redirect, RegistrationInput, RegistrationResult, ResolvedBlock, Site, SiteSettings, SitemapEntry, UnknownBlock, WebhookPayload, videoEmbedUrl } from '@the-smithy/hearth-schema';
 
 /** A plugin adds resources (and can use the core's `request`) under its own names. */
 type HearthPlugin<T extends object = object> = {

package/dist/index.js

@@ -2,9 +2,10 @@ import {
   DEFAULT_BASE_URL,
   HearthError,
   createCore,
+  findRedirect,
   isHearthError,
   normalizeSlug
-} from "./chunk-ZK7X4FDQ.js";
+} from "./chunk-RYCXMQM2.js";
 
 // src/index.ts
 import { videoEmbedUrl } from "@the-smithy/hearth-schema";
@@ -26,6 +27,7 @@ export {
   HearthError,
   createHearthClient,
   definePlugin,
+  findRedirect,
   isHearthError,
   normalizeSlug,
   videoEmbedUrl

package/dist/next.d.ts

@@ -1,10 +1,19 @@
-import { H as HearthCore, b as CollectionPage, E as EventCollectionPage, F as FormResult, c as FormValues } from './client-DCiaDdvu.js';
+import { H as HearthCore, b as CollectionPage, E as EventCollectionPage, F as FormResult, c as FormValues } from './client-CnIniG4N.js';
 import * as _the_smithy_hearth_schema from '@the-smithy/hearth-schema';
-import { PageMeta } from '@the-smithy/hearth-schema';
+import { Site, PageMeta } from '@the-smithy/hearth-schema';
 import { Metadata, MetadataRoute } from 'next';
 
 /** Holds the preview token while Next.js draft mode is on. */
 declare const PREVIEW_COOKIE = "hearth-preview";
+/**
+ * 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.
+ */
+declare const isNonProductionDeploy: () => boolean;
+/** The site's https:// address from its domain in Hearth, or null before one is set. */
+declare const siteBaseUrl: (site: Pick<Site, "domain">) => string | null;
+/** The page's lang attribute from the site's language in Hearth ("en_US" → "en-US"). */
+declare const siteLang: (site: Pick<Site, "settings">) => string;
 /** Next.js metadata from a page's or event's `meta`. */
 declare function metadataFromMeta(meta: PageMeta): Metadata;
 type HearthNextOptions = {
@@ -21,7 +30,7 @@ type HearthNextOptions = {
  * what changed), metadata, sitemap, the revalidation route, and form submission.
  */
 declare function createHearthNext(client: HearthCore, { tag, revalidate }?: HearthNextOptions): {
-    getSite: () => Promise<_the_smithy_hearth_schema.Site>;
+    getSite: () => Promise<Site>;
     getPages: () => Promise<_the_smithy_hearth_schema.PageSummary[]>;
     getPage: (slug?: string | string[] | null) => Promise<_the_smithy_hearth_schema.Page | null>;
     getEvents: (opts?: {
@@ -209,8 +218,34 @@ declare function createHearthNext(client: HearthCore, { tag, revalidate }?: Hear
     exitPreviewHandler(): (request: Request) => Promise<never>;
     /** For `generateMetadata`: the page's title, description, canonical, robots and share tags ({} when not found). */
     generatePageMetadata(slug?: string | string[] | null): Promise<Metadata>;
+    /**
+     * The root layout's `generateMetadata`: what every page starts from. Full links (metadataBase), the title pattern and
+     * default description, the default share image, the site's language, Google and Bing verification, and keeping
+     * search engines away from preview deploys and a site hidden in Hearth. Pages from Hearth override what they set.
+     *   export const generateMetadata = () => hearthNext.siteMetadata();
+     */
+    siteMetadata(): Promise<Metadata>;
+    /**
+     * `export default` from app/robots.ts. Keeps every crawler out until the site has a domain in Hearth, while it's
+     * hidden from search engines there, and on preview deploys; otherwise allows all and points at the sitemap.
+     */
+    robots(): Promise<MetadataRoute.Robots>;
+    /** Every redirect on the site (old addresses and where they go now), cached and refreshed on publish. */
+    getRedirects: () => Promise<_the_smithy_hearth_schema.Redirect[]>;
+    /**
+     * Instead of `notFound()` when a path has no page: follows the site's redirect for it (301, or 307 for a temporary
+     * one), else shows the 404. Old addresses keep working after a page is renamed or a site is migrated.
+     *   if (!page) await hearthNext.redirectOrNotFound(slug);
+     */
+    redirectOrNotFound(path: string | string[] | undefined | null): Promise<never>;
     /** `export default sitemap` from app/sitemap.ts. */
     sitemap(): Promise<MetadataRoute.Sitemap>;
+    /**
+     * Hearth's sitemap plus pages the site's own code serves (an events calendar, a donate page), skipping any
+     * Hearth already lists:
+     *   export default hearthNext.sitemapWith(["/events", "/fundraisers"]);
+     */
+    sitemapWith(paths: string[]): () => Promise<MetadataRoute.Sitemap>;
     /**
      * POST handler for the site's revalidation webhook (app/api/revalidate/route.ts):
      *   export const POST = hearthNext.revalidateHandler();
@@ -232,4 +267,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, metadataFromMeta };
+export { type HearthNextOptions, PREVIEW_COOKIE, createHearthNext, isNonProductionDeploy, metadataFromMeta, siteBaseUrl, siteLang };

package/dist/next.js

@@ -1,16 +1,17 @@
 import {
+  findRedirect,
   isHearthError,
   normalizeSlug
-} from "./chunk-ZK7X4FDQ.js";
+} from "./chunk-RYCXMQM2.js";
 import {
   parseWebhook,
   tagsForWebhook
-} from "./chunk-4VLAG4JX.js";
+} from "./chunk-G3UBVAQY.js";
 
 // src/next.ts
 import { revalidateTag } from "next/cache";
 import { cookies, draftMode, headers } from "next/headers";
-import { redirect } from "next/navigation";
+import { notFound, permanentRedirect, redirect } from "next/navigation";
 var PREVIEW_COOKIE = "hearth-preview";
 var DRAFT_COOKIE = "__prerender_bypass";
 async function previewToken() {
@@ -19,6 +20,13 @@ async function previewToken() {
 }
 var clientIp = (h) => h.get("x-nf-client-connection-ip") ?? 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;
+  const vercel = process.env.VERCEL_ENV;
+  return Boolean(netlify && netlify !== "production" || vercel && vercel !== "production");
+};
+var siteBaseUrl = (site) => site.domain ? `https://${site.domain.replace(/^https?:\/\//, "").replace(/\/+$/, "")}` : null;
+var siteLang = (site) => (site.settings.seo.locale ?? "en_US").replace("_", "-");
 function metadataFromMeta(meta) {
   const description = meta.description ?? void 0;
   return {
@@ -181,13 +189,73 @@ function createHearthNext(client, { tag = "hearth", revalidate = 3600 } = {}) {
     /** For `generateMetadata`: the page's title, description, canonical, robots and share tags ({} when not found). */
     async generatePageMetadata(slug) {
       const page = await getPage(slug);
-      return page ? metadataFromMeta(page.meta) : {};
+      if (!page) return {};
+      const metadata = metadataFromMeta(page.meta);
+      return await previewToken() ? { ...metadata, robots: { index: false, follow: false } } : metadata;
+    },
+    /**
+     * The root layout's `generateMetadata`: what every page starts from. Full links (metadataBase), the title pattern and
+     * default description, the default share image, the site's language, Google and Bing verification, and keeping
+     * search engines away from preview deploys and a site hidden in Hearth. Pages from Hearth override what they set.
+     *   export const generateMetadata = () => hearthNext.siteMetadata();
+     */
+    async siteMetadata() {
+      const site = await client.site.get(tags(`${tag}:site`));
+      const seo = site.settings.seo;
+      const base = siteBaseUrl(site);
+      const hidden = Boolean(seo.noIndex) || isNonProductionDeploy() || !base;
+      const image = seo.image?.src ? [{ url: seo.image.src, alt: seo.image.alt || site.name }] : void 0;
+      return {
+        ...base ? { metadataBase: new URL(base) } : {},
+        title: { default: site.name, template: seo.titleTemplate?.includes("%s") ? seo.titleTemplate : `%s | ${site.name}` },
+        ...seo.description ? { description: seo.description } : {},
+        ...hidden ? { robots: { index: false, follow: false } } : {},
+        openGraph: { siteName: site.name, locale: seo.locale ?? "en_US", type: "website", ...seo.description ? { description: seo.description } : {}, ...image ? { images: image } : {} },
+        twitter: { card: "summary_large_image", ...seo.twitterHandle ? { site: seo.twitterHandle } : {}, ...image ? { images: image.map((i) => i.url) } : {} },
+        ...seo.verification?.google || seo.verification?.bing ? { verification: { ...seo.verification.google ? { google: seo.verification.google } : {}, ...seo.verification.bing ? { other: { "msvalidate.01": seo.verification.bing } } : {} } } : {}
+      };
+    },
+    /**
+     * `export default` from app/robots.ts. Keeps every crawler out until the site has a domain in Hearth, while it's
+     * hidden from search engines there, and on preview deploys; otherwise allows all and points at the sitemap.
+     */
+    async robots() {
+      const site = await client.site.get(tags(`${tag}:site`));
+      const base = siteBaseUrl(site);
+      if (!base || site.settings.seo.noIndex || isNonProductionDeploy()) return { rules: { userAgent: "*", disallow: "/" } };
+      return { rules: { userAgent: "*", allow: "/", disallow: "/api/" }, sitemap: `${base}/sitemap.xml` };
+    },
+    /** Every redirect on the site (old addresses and where they go now), cached and refreshed on publish. */
+    getRedirects: () => client.redirects.list(tags(`${tag}:redirects`)),
+    /**
+     * Instead of `notFound()` when a path has no page: follows the site's redirect for it (301, or 307 for a temporary
+     * one), else shows the 404. Old addresses keep working after a page is renamed or a site is migrated.
+     *   if (!page) await hearthNext.redirectOrNotFound(slug);
+     */
+    async redirectOrNotFound(path) {
+      const match = findRedirect(await client.redirects.list(tags(`${tag}:redirects`)), path);
+      if (match) (match.permanent ? permanentRedirect : redirect)(match.to);
+      notFound();
     },
     /** `export default sitemap` from app/sitemap.ts. */
     async sitemap() {
       const entries = await client.sitemap(tags(`${tag}:pages`, `${tag}:events`));
       return entries.map((e) => ({ url: e.url, ...e.lastModified ? { lastModified: e.lastModified } : {}, priority: e.priority }));
     },
+    /**
+     * Hearth's sitemap plus pages the site's own code serves (an events calendar, a donate page), skipping any
+     * Hearth already lists:
+     *   export default hearthNext.sitemapWith(["/events", "/fundraisers"]);
+     */
+    sitemapWith(paths) {
+      return async () => {
+        const [entries, site] = await Promise.all([client.sitemap(tags(`${tag}:pages`, `${tag}:events`)), client.site.get(tags(`${tag}:site`))]);
+        const base = siteBaseUrl(site) ?? "";
+        const listed = new Set(entries.map((e) => e.path));
+        const extra = site.settings.seo.noIndex ? [] : paths.filter((p) => !listed.has(p)).map((p) => ({ url: `${base}${p}`, priority: 0.6 }));
+        return [...entries.map((e) => ({ url: e.url, ...e.lastModified ? { lastModified: e.lastModified } : {}, priority: e.priority })), ...extra];
+      };
+    },
     /**
      * POST handler for the site's revalidation webhook (app/api/revalidate/route.ts):
      *   export const POST = hearthNext.revalidateHandler();
@@ -221,5 +289,8 @@ function createHearthNext(client, { tag = "hearth", revalidate = 3600 } = {}) {
 export {
   PREVIEW_COOKIE,
   createHearthNext,
-  metadataFromMeta
+  isNonProductionDeploy,
+  metadataFromMeta,
+  siteBaseUrl,
+  siteLang
 };

package/dist/testing.d.ts

@@ -1,10 +1,11 @@
-import { Site, Page, HearthEvent, HearthEventDetail, SitemapEntry, Collection, CollectionEntry, CategoryGroup, Fundraiser, FundraiserDetail, HearthForm } from '@the-smithy/hearth-schema';
+import { Site, Page, HearthEvent, HearthEventDetail, SitemapEntry, Redirect, Collection, CollectionEntry, CategoryGroup, Fundraiser, FundraiserDetail, HearthForm } from '@the-smithy/hearth-schema';
 
 type MockHearthData = {
     site?: Partial<Site>;
     pages?: Page[];
     events?: (HearthEvent | HearthEventDetail)[];
     sitemap?: SitemapEntry[];
+    redirects?: Redirect[];
     /** Collections, with their entries (page collections) keyed by collection slug. */
     collections?: Collection[];
     entries?: Record<string, CollectionEntry[]>;

package/dist/testing.js

@@ -46,6 +46,7 @@ function createMockHearth(data = {}) {
       return event ? json({ data: event }) : notFound();
     }
     if (rest === "/sitemap") return json({ data: data.sitemap ?? [] });
+    if (rest === "/redirects") return json({ data: data.redirects ?? [] });
     if (rest === "/fundraisers" || rest.startsWith("/fundraisers?")) {
       const status = url.searchParams.get("status") ?? "active";
       return json({ data: (data.fundraisers ?? []).filter((f) => status === "all" || f.status === status) });

package/dist/webhooks.js

@@ -2,7 +2,7 @@ import {
   parseWebhook,
   tagsForWebhook,
   verifyWebhook
-} from "./chunk-4VLAG4JX.js";
+} from "./chunk-G3UBVAQY.js";
 export {
   parseWebhook,
   tagsForWebhook,

package/package.json

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