bsmnt 0.13.1 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/dist/modules/features/cms/sanity-pagebuilder/config.d.ts.map +1 -1
  2. package/dist/modules/features/cms/sanity-pagebuilder/config.js +1 -0
  3. package/dist/modules/features/cms/sanity-pagebuilder/config.js.map +1 -1
  4. package/dist/modules/features/cms/sanity-pagebuilder-cache/config.d.ts.map +1 -1
  5. package/dist/modules/features/cms/sanity-pagebuilder-cache/config.js +1 -0
  6. package/dist/modules/features/cms/sanity-pagebuilder-cache/config.js.map +1 -1
  7. package/package.json +1 -1
  8. package/src/agent-skills/ashby-pagebuilder-block/SKILL.md +29 -11
  9. package/src/agent-skills/hubspot-pagebuilder-block/SKILL.md +31 -12
  10. package/src/agent-skills/page-builder-block/SKILL.md +26 -13
  11. package/src/modules/features/cms/sanity-pagebuilder/files/app/api/revalidate/route.ts +2 -2
  12. package/src/modules/features/cms/sanity-pagebuilder/files/components/sanity/rich-text.tsx +1 -1
  13. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/components/block-actions-item.tsx +2 -2
  14. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/components/component-preview-frame.tsx +124 -0
  15. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/components/component-preview-pane.tsx +25 -0
  16. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/components/page-builder-input.tsx +3 -26
  17. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/components/page-builder-insert-menu.tsx +121 -93
  18. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/icons.ts +2 -2
  19. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/page-builder-config.ts +21 -49
  20. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/presentation.ts +1 -50
  21. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/queries.ts +56 -64
  22. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/sanity.config.ts +4 -8
  23. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/components/index.ts +0 -1
  24. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/index.ts +1 -4
  25. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/shared/block.ts +4 -4
  26. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/shared/page-builder.ts +4 -18
  27. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/shared/page.ts +11 -37
  28. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/singletons.ts +0 -16
  29. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/structure.ts +36 -34
  30. package/src/modules/features/cms/sanity-pagebuilder/files/lib/utils/studio-embed.ts +22 -0
  31. package/src/modules/features/cms/sanity-pagebuilder-cache/files/app/api/revalidate/route.ts +2 -2
  32. package/src/modules/features/cms/sanity-pagebuilder-cache/files/components/sanity/rich-text.tsx +1 -1
  33. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/components/block-actions-item.tsx +2 -2
  34. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/components/component-preview-frame.tsx +124 -0
  35. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/components/component-preview-pane.tsx +25 -0
  36. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/components/page-builder-input.tsx +3 -26
  37. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/components/page-builder-insert-menu.tsx +121 -93
  38. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/icons.ts +2 -2
  39. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/page-builder-config.ts +21 -49
  40. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/presentation.ts +1 -50
  41. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/queries.ts +56 -64
  42. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/sanity.config.ts +4 -8
  43. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/schemas/components/index.ts +0 -1
  44. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/schemas/index.ts +1 -4
  45. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/schemas/shared/block.ts +4 -4
  46. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/schemas/shared/page-builder.ts +4 -18
  47. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/schemas/shared/page.ts +11 -37
  48. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/singletons.ts +0 -16
  49. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/structure.ts +36 -34
  50. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/utils/studio-embed.ts +22 -0
  51. package/src/modules/features/forms/hubspot/files/_sanity-adapter/form-block.ts +4 -10
  52. package/src/modules/features/forms/hubspot/files/lib/integrations/hubspot/README.md +10 -5
  53. package/src/modules/features/jobs/ashby/files/_sanity-adapter/job-board-block.ts +0 -7
  54. package/src/modules/features/jobs/ashby/files/lib/integrations/ashby/README.md +11 -5
  55. package/src/templates/next-pagebuilder/AGENTS.md +19 -7
  56. package/src/templates/next-pagebuilder/README.md +15 -3
  57. package/src/templates/next-pagebuilder/app/actions/unlock-gated-content.ts +5 -4
  58. package/src/templates/next-pagebuilder/app/components/page.tsx +81 -0
  59. package/src/templates/next-pagebuilder/components/page-builder/components/gated-content/index.tsx +8 -3
  60. package/src/templates/next-pagebuilder/components/page-builder/library.ts +183 -0
  61. package/src/templates/next-pagebuilder/components/page-builder/registry.tsx +4 -1
  62. package/src/templates/next-pagebuilder/components/page-builder/renderer.tsx +3 -1
  63. package/src/templates/next-pagebuilder/components/page-builder/stage.tsx +10 -0
  64. package/src/templates/next-pagebuilder/components/page-document/index.tsx +1 -0
  65. package/src/templates/next-pagebuilder/lib/integrations/sanity/sanity.types.ts +139 -271
  66. package/src/templates/next-pagebuilder-cache/AGENTS.md +19 -7
  67. package/src/templates/next-pagebuilder-cache/README.md +15 -3
  68. package/src/templates/next-pagebuilder-cache/app/actions/unlock-gated-content.ts +5 -4
  69. package/src/templates/next-pagebuilder-cache/app/components/page.tsx +91 -0
  70. package/src/templates/next-pagebuilder-cache/components/page-builder/components/gated-content/index.tsx +8 -3
  71. package/src/templates/next-pagebuilder-cache/components/page-builder/library.ts +183 -0
  72. package/src/templates/next-pagebuilder-cache/components/page-builder/registry.tsx +4 -1
  73. package/src/templates/next-pagebuilder-cache/components/page-builder/renderer.tsx +3 -1
  74. package/src/templates/next-pagebuilder-cache/components/page-builder/stage.tsx +10 -0
  75. package/src/templates/next-pagebuilder-cache/components/page-document/index.tsx +1 -0
  76. package/src/templates/next-pagebuilder-cache/lib/integrations/sanity/sanity.types.ts +139 -271
  77. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/components/use-studio-preview-urls.ts +0 -62
  78. package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/components/studio-preview.ts +0 -37
  79. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/components/use-studio-preview-urls.ts +0 -62
  80. package/src/modules/features/cms/sanity-pagebuilder-cache/files/lib/integrations/sanity/schemas/components/studio-preview.ts +0 -37
@@ -7,9 +7,10 @@ import {
7
7
  import { hubspotFormField } from "./form-field"
8
8
 
9
9
  /**
10
- * Sample reusable HubSpot form block. Register it in your schema's document
11
- * list (and page-builder config, if you use one), then render its `form` with
12
- * <HubSpotForm /> from the integration core:
10
+ * Sample HubSpot form block. Register it in your schema's type list, then render
11
+ * its `form` with <HubSpotForm /> from the integration core. In a page-builder
12
+ * project re-declare it through `defineBlock` so it becomes an inline block —
13
+ * the `hubspot-pagebuilder-block` skill walks through it:
13
14
  *
14
15
  * @example
15
16
  * import { HubSpotForm } from "@/lib/integrations/hubspot/form"
@@ -51,10 +52,3 @@ export const hubspotFormBlock = defineType({
51
52
  },
52
53
  },
53
54
  })
54
-
55
- export const hubspotFormBlockReference = defineType({
56
- name: "hubspotFormBlockReference",
57
- title: "HubSpot Form Block",
58
- type: "reference",
59
- to: [{ type: "hubspotFormBlock" }],
60
- })
@@ -105,10 +105,15 @@ selectable block. Adding this integration installs the
105
105
  HubSpot form into the page builder" and it makes the edits and verifies the
106
106
  typecheck. To do it by hand:
107
107
 
108
- 1. `schemas/index.ts` — import `hubspotFormBlock`, add it to `schema.types`
108
+ 1. `schemas/components/reusable/hubspot-form.ts` — re-declare the adapter
109
+ through `defineBlock`, so the block is an inline object with Anchor ID and
110
+ Presentation Mode; export it from `schemas/components/index.ts` and add it to
111
+ `schema.types` in `schemas/index.ts`
109
112
  2. `page-builder-config.ts` — add `"hubspotFormBlock"` to
110
- `PageBuilderDocumentType` and a `hubspotFormBlockReference` member
111
- 3. `structure.ts` — add `S.documentTypeListItem("hubspotFormBlock")`
112
- 4. `components/page-builder/renderer.tsx` — add a `case "hubspotFormBlock"` that
113
- decodes `block.form` and renders `<HubSpotForm />`
113
+ `PageBuilderDocumentType` and a `pageBuilderBlockMembers` entry with
114
+ `pageTypes` and `category`
115
+ 3. `components/page-builder/registry.tsx` — one entry keyed `hubspotFormBlock`
116
+ that decodes `block.form` and renders `<HubSpotForm />`
117
+ 4. `components/page-builder/library.ts` — a fixture entry, which is what the
118
+ insert menu, Studio → Components and `/components` render
114
119
  5. `bun run sanity:typegen && bun typecheck`
@@ -44,10 +44,3 @@ export const ashbyJobBoardBlock = defineType({
44
44
  },
45
45
  },
46
46
  })
47
-
48
- export const ashbyJobBoardBlockReference = defineType({
49
- name: "ashbyJobBoardBlockReference",
50
- title: "Ashby Job Board",
51
- type: "reference",
52
- to: [{ type: "ashbyJobBoardBlock" }],
53
- })
@@ -125,10 +125,16 @@ selectable block. Adding this integration installs the
125
125
  Ashby job board into the page builder" and it makes the edits and verifies the
126
126
  typecheck. To do it by hand:
127
127
 
128
- 1. `schemas/index.ts` — import `ashbyJobBoardBlock`, add it to `schema.types`
128
+ 1. `schemas/components/reusable/ashby-job-board.ts` — re-declare the adapter
129
+ through `defineBlock`, so the block is an inline object with Anchor ID and
130
+ Presentation Mode; export it from `schemas/components/index.ts` and add it to
131
+ `schema.types` in `schemas/index.ts`
129
132
  2. `page-builder-config.ts` — add `"ashbyJobBoardBlock"` to
130
- `PageBuilderDocumentType` and an `ashbyJobBoardBlockReference` member
131
- 3. `structure.ts` — add `S.documentTypeListItem("ashbyJobBoardBlock")`
132
- 4. `components/page-builder/renderer.tsx` — add a `case "ashbyJobBoardBlock"`
133
- that awaits `getCareerJobs(block.boardName)` and renders the list
133
+ `PageBuilderDocumentType` and a `pageBuilderBlockMembers` entry with
134
+ `pageTypes` and `category`
135
+ 3. `components/page-builder/registry.tsx` — one entry keyed
136
+ `ashbyJobBoardBlock` that awaits `getCareerJobs(block.boardName)` and renders
137
+ the list
138
+ 4. `components/page-builder/library.ts` — a fixture entry, which is what the
139
+ insert menu, Studio → Components and `/components` render
134
140
  5. `bun run sanity:typegen && bun typecheck`
@@ -11,14 +11,24 @@ page.
11
11
  Studio with a slug, not a directory. `app/(content)/[[...slug]]/page.tsx`
12
12
  resolves every one of them; a hand-written route shadows that resolver and
13
13
  becomes a URL no editor can see, move or delete. The only things that belong in
14
- `app/` are non-page endpoints — the Studio, API handlers, sitemap, feed.
14
+ `app/` are non-page endpoints — the Studio, API handlers, sitemap, feed, and
15
+ `app/components`, the Studio's live block preview: it renders fixtures rather
16
+ than content, is gated to Studio embeds by `isStudioEmbed()` and is `noindex`.
15
17
 
16
18
  ## Page-builder blocks
17
19
 
20
+ **Blocks are inline objects, never documents.** A placement belongs to exactly
21
+ one page, so the page's `pageBuilder` array stores the block itself and nothing
22
+ is dereferenced at read time. Don't reintroduce a block-as-document with a
23
+ reference member — that model was removed deliberately: no block was ever
24
+ reused, and it cost a hop on every read plus a second id to address.
25
+
18
26
  **A block is `defineBlock` + a registry entry.** Define the schema with
19
27
  `defineBlock` (`lib/integrations/sanity/schemas/shared/block.ts`), never
20
- `defineType` — it implies `type: "document"` and appends **Anchor ID** and
21
- **Presentation Mode** for you. Register the component in
28
+ `defineType` — it implies `type: "object"` and appends **Anchor ID** and
29
+ **Presentation Mode** for you. The array member's type name *is* the block's
30
+ `_type`, so the registry, the insert menu and the fixture library all key off
31
+ the same string. Register the component in
22
32
  `components/page-builder/registry.tsx`; the renderer is driven by that map, so
23
33
  there is no switch to extend.
24
34
 
@@ -33,10 +43,12 @@ that was never registered — is a typecheck error.
33
43
  drives the insert menu; `misc` only when nothing else fits). Never collapse them
34
44
  into one field: that is what made the menu a single flat list.
35
45
 
36
- **And a preview image.** The insert menu renders one tile per block from a
37
- `studioPreview` document (Components → Component Previews) keyed
38
- `block.<memberName>`. A block without one falls back to its schema icon, which
39
- is what made the old menu unreadable.
46
+ **And a fixture.** A block isn't done until `components/page-builder/library.ts`
47
+ has an entry for it: a stand-in value typed as the block's query result, plus a
48
+ one-line note. That entry is the block's preview everywhere — the live pane in
49
+ the insert menu, its row in Studio → Components, and the `/components` route,
50
+ all rendered by the production renderer. Without one the picker just says the
51
+ component has no preview.
40
52
 
41
53
  **Never hardcode vertical padding in a block component.** The renderer wraps
42
54
  each block in `<Section>` (`components/page-builder/section.tsx`), which owns
@@ -18,14 +18,18 @@ bun dev
18
18
 
19
19
  ## Page-builder blocks
20
20
 
21
- A block is two halves — a schema document and a React component — and each half
22
- has one place that makes it a block rather than an ordinary document or a loose
21
+ A block is two halves — a schema type and a React component — and each half has
22
+ one place that makes it a block rather than an ordinary object type or a loose
23
23
  component. Use them and Anchor ID, Presentation Mode and the spacing scale come
24
24
  for free.
25
25
 
26
+ Blocks are **inline objects** in the page's `pageBuilder` array, never documents
27
+ and never referenced: a placement belongs to exactly one page, so the block
28
+ lives on that page and nothing is dereferenced at read time.
29
+
26
30
  **Define the schema with `defineBlock`, never `defineType`**
27
31
  (`lib/integrations/sanity/schemas/shared/block.ts`). It implies
28
- `type: "document"` and appends two fields to every block:
32
+ `type: "object"` and appends two fields to every block:
29
33
 
30
34
  - **Anchor ID** — optional. Left empty, the anchor is generated from the block's
31
35
  own title at render time (`headline` / `heading` / `teaserHeading` / `title` /
@@ -54,6 +58,14 @@ block in `<Section>` (`components/page-builder/section.tsx`), which owns the
54
58
  component returns its content only — no outer `<section>`, no `py-*` / `pt-*` /
55
59
  `pb-*` on its root. Internal gaps between a block's own parts are fine.
56
60
 
61
+ **Every block ships a fixture in `components/page-builder/library.ts`**: a
62
+ stand-in value typed as the block's query result, plus a one-line note. It is
63
+ the block's only preview, and it is rendered by the production renderer at
64
+ `/components` — a route the Studio embeds in an iframe, so the insert menu and
65
+ **Components** in the Studio show the real block rather than a screenshot. The
66
+ route is gated to Studio embeds and `noindex`; a block with no entry simply has
67
+ no preview.
68
+
57
69
  ### The spacing scale is content, not code
58
70
 
59
71
  Editors own it at **Layout → Spacing Scale**: a list of steps, each with a name
@@ -10,13 +10,14 @@ export type UnlockResult =
10
10
  | { ok: true; payload: GatedContentPayload }
11
11
  | { ok: false; error: string }
12
12
 
13
- type UnlockInput = { documentId: string; email: string }
13
+ type UnlockInput = { pageId: string; blockKey: string; email: string }
14
14
 
15
15
  export async function unlockGatedContent({
16
- documentId,
16
+ pageId,
17
+ blockKey,
17
18
  email,
18
19
  }: UnlockInput): Promise<UnlockResult> {
19
- if (!documentId) return { ok: false, error: "Missing content id." }
20
+ if (!(pageId && blockKey)) return { ok: false, error: "Missing content id." }
20
21
  if (!/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email)) {
21
22
  return { ok: false, error: "Enter a valid email address." }
22
23
  }
@@ -27,7 +28,7 @@ export async function unlockGatedContent({
27
28
 
28
29
  const { data } = await fetchSanity<GATED_CONTENT_QUERY_RESULT>({
29
30
  query: GATED_CONTENT_QUERY,
30
- params: { id: documentId },
31
+ params: { pageId, blockKey },
31
32
  // stega must stay off: it injects invisible characters into strings, which
32
33
  // would corrupt the asset URLs returned for download/playback.
33
34
  stega: false,
@@ -0,0 +1,81 @@
1
+ import type { Metadata } from "next"
2
+ import { notFound } from "next/navigation"
3
+ import { SpacingScale } from "@/components/layout/spacing-scale"
4
+ import {
5
+ COMPONENT_LIBRARY,
6
+ COMPONENT_PREVIEW_PARAM,
7
+ getLibraryEntry,
8
+ type LibraryEntry,
9
+ } from "@/components/page-builder/library"
10
+ import { Renderer } from "@/components/page-builder/renderer"
11
+ import { Stage } from "@/components/page-builder/stage"
12
+ import { isStudioEmbed } from "@/lib/utils/studio-embed"
13
+
14
+ export const metadata: Metadata = {
15
+ title: "Components",
16
+ robots: { index: false, follow: false, nocache: true },
17
+ }
18
+
19
+ type Props = {
20
+ searchParams: Promise<Record<string, string | string[] | undefined>>
21
+ }
22
+
23
+ const firstValue = (value: string | string[] | undefined) =>
24
+ Array.isArray(value) ? value[0] : value
25
+
26
+ const PREVIEW_PAGE_ID = "component-preview"
27
+
28
+ const EntryHeader = ({ entry }: { entry: LibraryEntry }) => (
29
+ <header className="sticky top-0 z-10 flex items-baseline gap-3 border-neutral-200 border-b bg-white/85 px-6 py-3 backdrop-blur">
30
+ <h2 className="font-mono text-neutral-900 text-xs uppercase">
31
+ {entry.title}
32
+ </h2>
33
+ <p className="text-neutral-500 text-xs">{entry.notes}</p>
34
+ </header>
35
+ )
36
+
37
+ const PreviewStage = ({ entry }: { entry: LibraryEntry }) => (
38
+ <Stage background={entry.background}>
39
+ <Renderer
40
+ blocks={[entry.block]}
41
+ pageId={PREVIEW_PAGE_ID}
42
+ pinnedCategory={null}
43
+ searchParams={undefined}
44
+ />
45
+ </Stage>
46
+ )
47
+
48
+ const Page = async ({ searchParams }: Props) => {
49
+ const [params, embedded] = await Promise.all([searchParams, isStudioEmbed()])
50
+
51
+ if (!embedded) notFound()
52
+
53
+ const requested = firstValue(params[COMPONENT_PREVIEW_PARAM])
54
+ const entry = getLibraryEntry(requested)
55
+
56
+ if (requested && !entry) notFound()
57
+
58
+ // Outside the `(content)` group, so `<SpacingScale />` is on this route.
59
+ if (entry) {
60
+ return (
61
+ <main className="flex flex-col">
62
+ <SpacingScale />
63
+ <PreviewStage entry={entry} />
64
+ </main>
65
+ )
66
+ }
67
+
68
+ return (
69
+ <main className="flex flex-col">
70
+ <SpacingScale />
71
+ {COMPONENT_LIBRARY.map((item) => (
72
+ <section key={item.documentType}>
73
+ <EntryHeader entry={item} />
74
+ <PreviewStage entry={item} />
75
+ </section>
76
+ ))}
77
+ </main>
78
+ )
79
+ }
80
+
81
+ export default Page
@@ -13,14 +13,15 @@ type GatedContentBlock = Extract<PageBuilderBlock, { _type: "gatedContent" }>
13
13
 
14
14
  type GatedContentProps = {
15
15
  block: GatedContentBlock
16
+ pageId: string
16
17
  }
17
18
 
18
19
  type GateState = "locked" | "loading" | "unlocked"
19
20
 
20
21
  const STORAGE_PREFIX = "gated-content:"
21
22
 
22
- export function GatedContent({ block }: GatedContentProps) {
23
- const storageKey = `${STORAGE_PREFIX}${block._id}`
23
+ export function GatedContent({ block, pageId }: GatedContentProps) {
24
+ const storageKey = `${STORAGE_PREFIX}${pageId}:${block._key}`
24
25
  const [state, setState] = useState<GateState>("locked")
25
26
  const [payload, setPayload] = useState<GatedContentPayload | null>(null)
26
27
  const [error, setError] = useState<string | null>(null)
@@ -33,7 +34,11 @@ export function GatedContent({ block }: GatedContentProps) {
33
34
  setState("loading")
34
35
  setError(null)
35
36
 
36
- const result = await unlockGatedContent({ documentId: block._id, email })
37
+ const result = await unlockGatedContent({
38
+ pageId,
39
+ blockKey: block._key,
40
+ email,
41
+ })
37
42
 
38
43
  if (!result.ok) {
39
44
  setError(result.error)
@@ -0,0 +1,183 @@
1
+ import type { PageBuilderDocumentType } from "@/lib/integrations/sanity/page-builder-config"
2
+ import type { PageBuilderBlock } from "./types"
3
+
4
+ /** One block's stand-in value, rendered by `/components` through `Renderer`. */
5
+ export type LibraryEntry = {
6
+ documentType: PageBuilderDocumentType
7
+ title: string
8
+ notes: string
9
+ background: string
10
+ block: PageBuilderBlock
11
+ }
12
+
13
+ type BlockOf<T extends PageBuilderDocumentType> = Extract<
14
+ PageBuilderBlock,
15
+ { _type: T }
16
+ >
17
+
18
+ const span = (key: string, text: string) => ({
19
+ _type: "span" as const,
20
+ _key: key,
21
+ text,
22
+ marks: [],
23
+ })
24
+
25
+ const paragraph = (key: string, text: string) => ({
26
+ _type: "block" as const,
27
+ _key: key,
28
+ style: "normal" as const,
29
+ markDefs: [],
30
+ children: [span(`${key}-span`, text)],
31
+ })
32
+
33
+ const heading = (key: string, text: string) => ({
34
+ ...paragraph(key, text),
35
+ style: "h2" as const,
36
+ })
37
+
38
+ const PLACEHOLDER_KEY = "placeholder"
39
+
40
+ const hero: BlockOf<"hero"> = {
41
+ _key: PLACEHOLDER_KEY,
42
+ _type: "hero",
43
+ headline: "A heading that says what this page is for.",
44
+ }
45
+
46
+ const description: BlockOf<"description"> = {
47
+ _key: PLACEHOLDER_KEY,
48
+ _type: "description",
49
+ description:
50
+ "One paragraph of standfirst copy under a heading — long enough to set up the page, short enough that nobody skips it.",
51
+ }
52
+
53
+ const richTextBlock: BlockOf<"richTextBlock"> = {
54
+ _key: PLACEHOLDER_KEY,
55
+ _type: "richTextBlock",
56
+ content: [
57
+ heading("rt-head", "What long-form copy looks like here"),
58
+ paragraph(
59
+ "rt-one",
60
+ "Rich Text is the block for body copy: headings, paragraphs, lists, links and quotes, all authored in the Studio and rendered with the site's own typography."
61
+ ),
62
+ paragraph(
63
+ "rt-two",
64
+ "Because it is Portable Text rather than HTML, the same content renders in the page, in the markdown route and in the feed without a second template."
65
+ ),
66
+ ],
67
+ }
68
+
69
+ const gatedContent: BlockOf<"gatedContent"> = {
70
+ _key: PLACEHOLDER_KEY,
71
+ _type: "gatedContent",
72
+ internalTitle: "Gated guide",
73
+ teaserHeading: "A guide worth an email address",
74
+ teaserBody: [
75
+ paragraph(
76
+ "gc-teaser",
77
+ "The teaser is public. The payload — rich text, a file or a video — is withheld from the page query until a visitor submits the form."
78
+ ),
79
+ ],
80
+ gateType: "form",
81
+ gateHeadline: "Read the full guide",
82
+ gateDescription: "We'll email you a copy as well.",
83
+ submitLabel: "Get the guide",
84
+ successMessage: "Sent — it's on its way.",
85
+ kind: "richText",
86
+ anchorId: null,
87
+ presentation: null,
88
+ }
89
+
90
+ const blogCollection: BlockOf<"blogCollection"> = {
91
+ _key: PLACEHOLDER_KEY,
92
+ _type: "blogCollection",
93
+ subtitle: "Everything else we've written",
94
+ }
95
+
96
+ const blogContent: BlockOf<"blogContent"> = {
97
+ _key: PLACEHOLDER_KEY,
98
+ _type: "blogContent",
99
+ title: "How this starter renders a blog post",
100
+ categories: [],
101
+ date: "2026-02-11",
102
+ author: {
103
+ _id: "placeholder-author",
104
+ name: "Jane Doe",
105
+ avatar: null,
106
+ role: "Engineer",
107
+ },
108
+ body: [
109
+ paragraph(
110
+ "bc-one",
111
+ "A blog post is an ordinary page whose page builder holds a Blog Posts block: byline, date, categories and body all live on the block."
112
+ ),
113
+ heading("bc-head", "One block, one article"),
114
+ paragraph(
115
+ "bc-two",
116
+ "The collection block reads the same fields, so an article added in the Studio shows up in the index without touching code."
117
+ ),
118
+ ],
119
+ relatedPosts: [],
120
+ }
121
+
122
+ export const COMPONENT_LIBRARY: LibraryEntry[] = [
123
+ {
124
+ documentType: "hero",
125
+ title: "Heading",
126
+ notes: "The page's opening statement. Headline only, no media.",
127
+ background: "bg-white",
128
+ block: hero,
129
+ },
130
+ {
131
+ documentType: "description",
132
+ title: "Description",
133
+ notes: "A single paragraph of standfirst copy under a heading.",
134
+ background: "bg-white",
135
+ block: description,
136
+ },
137
+ {
138
+ documentType: "richTextBlock",
139
+ title: "Rich Text",
140
+ notes: "Long-form body copy — headings, lists, links and quotes.",
141
+ background: "bg-white",
142
+ block: richTextBlock,
143
+ },
144
+ {
145
+ documentType: "gatedContent",
146
+ title: "Gated Content",
147
+ notes:
148
+ "A teaser with an email gate. The payload is withheld until a visitor submits, so the preview shows the locked state.",
149
+ background: "bg-white",
150
+ block: gatedContent,
151
+ },
152
+ {
153
+ documentType: "blogCollection",
154
+ title: "Blog Collection",
155
+ notes:
156
+ "The full article index with search and category filters. Reads real posts.",
157
+ background: "bg-white",
158
+ block: blogCollection,
159
+ },
160
+ {
161
+ documentType: "blogContent",
162
+ title: "Blog Posts",
163
+ notes:
164
+ "The body of an article — byline, date, categories and rich text. Only valid on a blog entry page.",
165
+ background: "bg-white",
166
+ block: blogContent,
167
+ },
168
+ ]
169
+
170
+ export const getLibraryEntry = (documentType: string | undefined) =>
171
+ documentType
172
+ ? (COMPONENT_LIBRARY.find((entry) => entry.documentType === documentType) ??
173
+ null)
174
+ : null
175
+
176
+ export const COMPONENT_PREVIEW_PATH = "/components"
177
+
178
+ export const COMPONENT_PREVIEW_PARAM = "component"
179
+
180
+ export const getComponentPreviewPath = (documentType?: string) =>
181
+ documentType
182
+ ? `${COMPONENT_PREVIEW_PATH}?${COMPONENT_PREVIEW_PARAM}=${encodeURIComponent(documentType)}`
183
+ : COMPONENT_PREVIEW_PATH
@@ -13,6 +13,7 @@ import { RichTextBlock } from "./components/rich-text-block"
13
13
  import type { PageBuilderBlock } from "./types"
14
14
 
15
15
  export type BlockContext = {
16
+ pageId: string
16
17
  searchParams: ContentCollectionSearchParams
17
18
  pinnedCategory: PinnedCollectionCategory
18
19
  }
@@ -48,7 +49,9 @@ const blockRegistry: {
48
49
  isEmpty: (block) => !block.description,
49
50
  },
50
51
  gatedContent: {
51
- render: (block) => <GatedContent block={block} />,
52
+ render: (block, { pageId }) => (
53
+ <GatedContent block={block} pageId={pageId} />
54
+ ),
52
55
  },
53
56
  hero: {
54
57
  render: (block) => <Hero block={block} />,
@@ -12,18 +12,20 @@ import type { PageBuilderBlock, PageBuilderBlocks } from "./types"
12
12
 
13
13
  type RendererProps = {
14
14
  blocks: PageBuilderBlocks
15
+ pageId: string
15
16
  searchParams: ContentCollectionSearchParams
16
17
  pinnedCategory: PinnedCollectionCategory
17
18
  }
18
19
 
19
20
  export function Renderer({
20
21
  blocks,
22
+ pageId,
21
23
  searchParams,
22
24
  pinnedCategory,
23
25
  }: RendererProps) {
24
26
  if (!blocks?.length) return null
25
27
 
26
- const context: BlockContext = { searchParams, pinnedCategory }
28
+ const context: BlockContext = { pageId, searchParams, pinnedCategory }
27
29
 
28
30
  const reservedAnchorIds = reserveAnchorIds(blocks)
29
31
  const takenAnchorIds = new Set<string>()
@@ -0,0 +1,10 @@
1
+ import type { PropsWithChildren } from "react"
2
+ import { cn } from "@/lib/styles/cn"
3
+
4
+ type StageProps = PropsWithChildren<{ background?: string }>
5
+
6
+ export const Stage = ({ background, children }: StageProps) => (
7
+ <div className={cn("grid min-h-svh content-center", background)}>
8
+ {children}
9
+ </div>
10
+ )
@@ -31,6 +31,7 @@ export const getPageSections = (
31
31
  <Renderer
32
32
  key="page-builder"
33
33
  blocks={page.pageBuilder}
34
+ pageId={page._id}
34
35
  searchParams={searchParams}
35
36
  pinnedCategory={stegaClean(page.collectionCategory)}
36
37
  />,