@the-smithy/hearth 0.22.0 → 0.24.0

package/dist/{chunk-RZNKY7HG.js → chunk-GTKPZN53.js}

@@ -297,6 +297,16 @@ function createCore(options) {
       /** Check a preview token from a Hearth preview link. Throws (unauthorized) if it's expired or for another site. */
       verify: (token, o = {}) => request("/preview", { ...o, preview: token, resource: "preview.verify" })
     },
+    globalBlocks: {
+      /**
+       * Every published global block on the site (Global blocks in Hearth), resolved, with what it is and where editors
+       * placed it: pop-ups (`popup` set), menu dropdowns (`usedOn.menuItems`), pages. Place any of them anywhere.
+       * Empty from Hearth versions without them.
+       */
+      list: async (o = {}) => await maybe("/global-blocks", { ...o, resource: "globalBlocks.list" }) ?? [],
+      /** One global block by its key ("contact") or id, or null if there's none or it isn't published. */
+      get: (ref, o = {}) => maybe(`/global-blocks/${encodeURIComponent(ref)}`, { ...o, resource: "globalBlocks.get" })
+    },
     customBlocks: {
       /** The site's own block types (Custom blocks in Hearth): each one's key, name and fields, for rendering `custom` blocks. */
       list: (o = {}) => request("/custom-blocks", { ...o, resource: "customBlocks.list" })

package/dist/{client-BXkB1aKA.d.ts → client-E1ie4g_L.d.ts}

@@ -1,4 +1,4 @@
-import { Collection, CollectionEntry, HearthEvent, Site, PageSummary, Page, HearthEventDetail, RegistrationInput, RegistrationResult, VolunteerInput, VolunteerResult, CategoryGroup, SitemapEntry, Redirect, AnalyticsReport, Fundraiser, FundraiserDetail, DonationInput, DonationCheckout, HearthForm } from '@the-smithy/hearth-schema';
+import { Collection, CollectionEntry, HearthEvent, Site, PageSummary, Page, HearthEventDetail, RegistrationInput, RegistrationResult, VolunteerInput, VolunteerResult, CategoryGroup, SitemapEntry, Redirect, AnalyticsReport, Fundraiser, FundraiserDetail, DonationInput, DonationCheckout, GlobalBlock, 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. */
@@ -227,6 +227,16 @@ declare function createCore(options: HearthClientOptions): {
         /** Check a preview token from a Hearth preview link. Throws (unauthorized) if it's expired or for another site. */
         verify: (token: string, o?: Omit<CallOptions, "preview">) => Promise<PreviewSession>;
     };
+    globalBlocks: {
+        /**
+         * Every published global block on the site (Global blocks in Hearth), resolved, with what it is and where editors
+         * placed it: pop-ups (`popup` set), menu dropdowns (`usedOn.menuItems`), pages. Place any of them anywhere.
+         * Empty from Hearth versions without them.
+         */
+        list: (o?: CallOptions) => Promise<GlobalBlock[]>;
+        /** One global block by its key ("contact") or id, or null if there's none or it isn't published. */
+        get: (ref: string, o?: CallOptions) => Promise<GlobalBlock | null>;
+    };
     customBlocks: {
         /** The site's own block types (Custom blocks in Hearth): each one's key, name and fields, for rendering `custom` blocks. */
         list: (o?: CallOptions) => Promise<{

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { H as HearthCore, a as HearthClientOptions } from './client-BXkB1aKA.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-BXkB1aKA.js';
-export { AnalyticsReport, AnalyticsRow, Block, BlockOf, CategoryGroup, CategoryRef, Collection, CollectionEntry, CollectionRef, DonationCheckout, DonationInput, EntryDetails, EventCustomFields, EventRegistration, EventTicket, EventVolunteerShift, EventVolunteering, Fundraiser, FundraiserDetail, HearthEvent, HearthEventDetail, ImageRef, KnownBlock, Page, PageMeta, PageSummary, Position, Redirect, RegistrationInput, RegistrationResult, ResolvedBlock, Site, SiteAnalytics, SiteSettings, SitemapEntry, UnknownBlock, VolunteerInput, VolunteerResult, WebhookPayload, directionsUrl, focalPosition, pinned, videoEmbedUrl } from '@the-smithy/hearth-schema';
+import { H as HearthCore, a as HearthClientOptions } from './client-E1ie4g_L.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-E1ie4g_L.js';
+export { AnalyticsReport, AnalyticsRow, Block, BlockOf, CategoryGroup, CategoryRef, Collection, CollectionEntry, CollectionRef, DonationCheckout, DonationInput, EntryDetails, EventCustomFields, EventRegistration, EventTicket, EventVolunteerShift, EventVolunteering, Fundraiser, FundraiserDetail, GlobalBlock, GlobalPopup, HearthEvent, HearthEventDetail, ImageRef, KnownBlock, Page, PageMeta, PageSummary, Position, Redirect, RegistrationInput, RegistrationResult, ResolvedBlock, SharedFrom, Site, SiteAnalytics, SiteSettings, SitemapEntry, UnknownBlock, VolunteerInput, VolunteerResult, WebhookPayload, directionsUrl, focalPosition, pinned, 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

@@ -5,7 +5,7 @@ import {
   findRedirect,
   isHearthError,
   normalizeSlug
-} from "./chunk-RZNKY7HG.js";
+} from "./chunk-GTKPZN53.js";
 
 // src/index.ts
 import { videoEmbedUrl } from "@the-smithy/hearth-schema";

package/dist/next.d.ts

@@ -1,4 +1,4 @@
-import { H as HearthCore, b as CollectionPage, E as EventCollectionPage, F as FormResult, c as FormValues } from './client-BXkB1aKA.js';
+import { H as HearthCore, b as CollectionPage, E as EventCollectionPage, F as FormResult, c as FormValues } from './client-E1ie4g_L.js';
 import * as _the_smithy_hearth_schema from '@the-smithy/hearth-schema';
 import { Site, PageMeta } from '@the-smithy/hearth-schema';
 import { Metadata, MetadataRoute } from 'next';
@@ -170,6 +170,10 @@ declare function createHearthNext(client: HearthCore, { tag, revalidate }?: Hear
             optional?: boolean | undefined;
         })[];
     }[]>;
+    /** Every global block (to place anywhere, and for pop-ups and menu dropdowns); drafts while previewing. */
+    getGlobalBlocks: () => Promise<_the_smithy_hearth_schema.GlobalBlock[]>;
+    /** One global block by key or id, or null; its draft while previewing. */
+    getGlobalBlock: (ref: string) => Promise<_the_smithy_hearth_schema.GlobalBlock | null>;
     getCollections: () => Promise<_the_smithy_hearth_schema.Collection[]>;
     getCollection: (slug: string, opts?: {
         limit?: number;

package/dist/next.js

@@ -2,7 +2,7 @@ import {
   findRedirect,
   isHearthError,
   normalizeSlug
-} from "./chunk-RZNKY7HG.js";
+} from "./chunk-GTKPZN53.js";
 import {
   parseWebhook,
   tagsForWebhook
@@ -60,6 +60,10 @@ function createHearthNext(client, { tag = "hearth", revalidate = 3600 } = {}) {
     getEvents: (opts) => client.events.list(opts, tags(`${tag}:events`)),
     getCategories: () => client.categories.list(tags(`${tag}:site`)),
     getCustomBlocks: () => client.customBlocks.list(tags(`${tag}:site`)),
+    /** Every global block (to place anywhere, and for pop-ups and menu dropdowns); drafts while previewing. */
+    getGlobalBlocks: async () => client.globalBlocks.list(await read(`${tag}:global`)),
+    /** One global block by key or id, or null; its draft while previewing. */
+    getGlobalBlock: async (ref) => client.globalBlocks.get(ref, await read(`${tag}:global`)),
     getCollections: () => client.collections.list(tags(`${tag}:site`, `${tag}:pages`)),
     getCollection: (slug, opts) => client.collections.get(slug, opts, tags(`${tag}:pages`, `${tag}:events`)),
     getEvent: async (slug) => client.events.get(slug, await read(`${tag}:events`)),

package/dist/testing.d.ts

@@ -1,4 +1,4 @@
-import { Site, Page, HearthEvent, HearthEventDetail, SitemapEntry, Redirect, Collection, CollectionEntry, CategoryGroup, Fundraiser, FundraiserDetail, HearthForm } from '@the-smithy/hearth-schema';
+import { Site, Page, HearthEvent, HearthEventDetail, SitemapEntry, Redirect, GlobalBlock, Collection, CollectionEntry, CategoryGroup, Fundraiser, FundraiserDetail, HearthForm } from '@the-smithy/hearth-schema';
 
 type MockHearthData = {
     site?: Partial<Site>;
@@ -8,6 +8,8 @@ type MockHearthData = {
     /** The site's llms.txt; null (the default) is a site without one. */
     llmsTxt?: string | null;
     redirects?: Redirect[];
+    /** The site's global blocks (pop-ups, menu dropdowns). */
+    globalBlocks?: GlobalBlock[];
     /** Collections, with their entries (page collections) keyed by collection slug. */
     collections?: Collection[];
     entries?: Record<string, CollectionEntry[]>;

package/dist/testing.js

@@ -48,6 +48,12 @@ function createMockHearth(data = {}) {
     if (rest === "/sitemap") return json({ data: data.sitemap ?? [] });
     if (rest === "/llms") return json({ data: data.llmsTxt ?? null });
     if (rest === "/redirects") return json({ data: data.redirects ?? [] });
+    if (rest === "/global-blocks") return json({ data: data.globalBlocks ?? [] });
+    if (rest.startsWith("/global-blocks/")) {
+      const ref = decodeURIComponent(rest.slice(15));
+      const block = (data.globalBlocks ?? []).find((g) => g.key === ref || g.id === ref);
+      return block ? json({ data: block }) : notFound();
+    }
     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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@the-smithy/hearth",
-  "version": "0.22.0",
+  "version": "0.24.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.22.0"
+    "@the-smithy/hearth-schema": "^0.24.0"
   },
   "peerDependencies": {
     "next": ">=15",