@bison-lab/payload-blocks 2.0.0

package/dist/types-BvRvDCDT.d.mts

@@ -0,0 +1,307 @@
+
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+import { ComponentType, ReactElement } from "react";
+//#region src/image.d.ts
+/**
+ * The image injection point.
+ *
+ * The package deliberately does not depend on `next` — a Payload site is not
+ * necessarily a Next.js site, and `next/image` needs per-site configuration
+ * (`remotePatterns` for the media route) that a package cannot supply. So
+ * renderers never construct an image element themselves; they render the
+ * component they were handed. A Next site writes one adapter around
+ * `next/image` and every block gets optimisation from it.
+ *
+ * This is a *component type*, not a render function, on purpose: a Server
+ * Component may pass a client component reference across the boundary, but not
+ * a closure. `imageComponent` therefore survives the trip from a server page
+ * into these client renderers, where a `renderImage` callback would not.
+ */
+interface BlockImageProps {
+  src: string;
+  /** Always a string — see `resolveMedia`. Empty means decorative. */
+  alt: string;
+  width?: number;
+  height?: number;
+  className?: string;
+  /** Passed through to `next/image`'s `sizes`; ignored by the default. */
+  sizes?: string;
+  /** Set on the one image above the fold, typically the hero's. */
+  priority?: boolean;
+}
+type BlockImageComponent = ComponentType<BlockImageProps>;
+/**
+ * The fallback when no `imageComponent` is supplied: a plain `<img>`. Correct
+ * everywhere and optimised nowhere, which is the right default for a package
+ * that cannot know what framework it landed in.
+ */
+declare function DefaultBlockImage({
+  src,
+  alt,
+  width,
+  height,
+  className,
+  sizes,
+  priority
+}: BlockImageProps): react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/render-blocks.d.ts
+/** The minimum a row must be for the dispatch to place it. */
+interface BlockLike {
+  blockType: string;
+  id?: string | null;
+}
+/**
+ * What every renderer is handed.
+ *
+ * The neighbour props let a block adapt to what sits around it: `prevType` to
+ * close a seam against the block above, `runIndex` to alternate surfaces across
+ * back-to-back blocks of one type, `isLast` because the final block sits
+ * against the site footer.
+ *
+ * `containerClassName` and `imageComponent` are the two things a package block
+ * cannot decide for itself — the site's page measure, and how an image gets
+ * optimised. Both arrive already defaulted, so a renderer never checks them.
+ */
+interface BlockRendererProps<B extends BlockLike = BlockLike> {
+  block: B;
+  /** Position on the page, hero included. */
+  index: number;
+  /** The type of the block before this one; absent on the first block. */
+  prevType?: string;
+  /** Position within a run of consecutive same-type blocks, from 0. */
+  runIndex: number;
+  isLast: boolean;
+  /** The site's page measure, for the band wrapper. */
+  containerClassName: string;
+  /** How this block turns a resolved image into an element. */
+  imageComponent: BlockImageComponent;
+}
+/**
+ * One renderer per block type, each typed to its own block.
+ *
+ * Written as a mapped type over the union so `hero` gets `HeroBlockData`, not
+ * the whole union. A site writes `satisfies BlockRegistryFor<AnyBlock>` where
+ * `AnyBlock` comes off its *generated* `Page` type — that is the compile-time
+ * layout lock, and it has to stay in the site, because only the site has
+ * generated types. The registry is a parameter here for exactly that reason.
+ */
+type BlockRegistryFor<B extends BlockLike> = { [K in B["blockType"]]: ComponentType<BlockRendererProps<Extract<B, {
+  blockType: K;
+}>>> };
+/** Fallback page measure for a site that does not pass its own. */
+declare const DEFAULT_CONTAINER = "mx-auto w-full max-w-7xl px-6";
+interface RenderBlocksProps<B extends BlockLike> {
+  /** Pass `[...page.hero, ...page.layout]`, so the hero counts as index 0. */
+  blocks: B[];
+  registry: BlockRegistryFor<B>;
+  /** The site's page measure. Defaults to `DEFAULT_CONTAINER`. */
+  containerClassName?: string;
+  /** Defaults to a plain `<img>`; a Next site passes a `next/image` adapter. */
+  imageComponent?: BlockImageComponent;
+}
+/**
+ * Renders a page's blocks in order through the registry. A Server Component:
+ * it only maps and looks up, and each renderer decides its own nature.
+ */
+declare function RenderBlocks<B extends BlockLike>({
+  blocks,
+  registry,
+  containerClassName,
+  imageComponent
+}: RenderBlocksProps<B>): ReactElement;
+//#endregion
+//#region src/fields/link.d.ts
+/** The shape `linkField`/`linkFields` produce once Payload generates types. */
+interface LinkValue {
+  label?: string | null;
+  href?: string | null;
+  newTab?: boolean | null;
+}
+//#endregion
+//#region src/media.d.ts
+/**
+ * The upload side of the boundary.
+ *
+ * A Payload upload field holds either the row's id or, once depth resolves it,
+ * the whole document. Neither shape can be imported from here: `Media` is
+ * generated per site, and this package must never reach for a site's
+ * `payload-types`. So the doc is described structurally, and every renderer
+ * goes through `resolveMedia` rather than reading `.url` itself.
+ */
+/**
+ * The subset of a Payload upload document a block renderer actually reads.
+ * Every site's generated `Media` interface is assignable to this, whatever
+ * else it carries.
+ *
+ * Deliberately no index signature: TypeScript refuses to assign an interface
+ * to a type with one, and a site's generated `Media` is always an interface.
+ * An index signature here would break exactly the structural match this type
+ * exists to provide.
+ */
+interface MediaDoc {
+  url?: string | null;
+  alt?: string | null;
+  width?: number | null;
+  height?: number | null;
+}
+/** What an upload field holds before and after `depth` populates it. */
+type MediaValue = number | string | MediaDoc | null | undefined;
+//#endregion
+//#region src/types.d.ts
+/**
+ * The data shape of every block in this package, hand-written.
+ *
+ * A package cannot import a site's `payload-types`: those are generated per
+ * site, from that site's own config. So each block's row shape is written out
+ * here to match what Payload generates from the config next to it, and a
+ * site's generated types then match *structurally* — no import, no adapter.
+ *
+ * Two conventions make that match reliable:
+ *
+ * 1. **Everything is optional and nullable**, `blockType` aside. A generated
+ *    `title: string` is assignable to `title?: string | null`, never the other
+ *    way round, so the permissive direction is the only safe one. It is also
+ *    the honest one: Payload skips validation on draft saves, so a live-preview
+ *    render genuinely can receive a row with its required fields still empty.
+ *    Renderers guard rather than assume.
+ * 2. **No index signatures.** TypeScript will not assign an interface to a type
+ *    that has one, and a generated block type is always an interface.
+ *
+ * The field-name lists in `src/__tests__/configs.test.ts` are the lock between
+ * a config and its interface here: rename a field and that test fails.
+ */
+/** The tail Payload appends to every block row. */
+interface BlockRow<T extends string> {
+  id?: string | null;
+  blockName?: string | null;
+  blockType: T;
+}
+/**
+ * A Lexical document, structurally. The generated type carries an index
+ * signature and a narrower `format` union; both are assignable to this.
+ */
+interface RichTextContent {
+  root: {
+    type: string;
+    children: unknown[];
+    direction: ("ltr" | "rtl") | null;
+    format: string;
+    indent: number;
+    version: number;
+  };
+}
+interface HeroBlockData extends BlockRow<"hero"> {
+  eyebrow?: string | null;
+  heading?: string | null;
+  body?: string | null;
+  tone?: ("sweep" | "dark" | "light") | null;
+  image?: MediaValue;
+  links?: LinkValue[] | null;
+}
+interface RichTextBlockData extends BlockRow<"richText"> {
+  content?: RichTextContent | null;
+}
+interface ShowcasePanelsItemData {
+  title?: string | null;
+  summary?: string | null;
+  image?: MediaValue;
+  href?: string | null;
+  numeral?: string | null;
+  id?: string | null;
+}
+interface ShowcasePanelsBlockData extends BlockRow<"showcasePanels"> {
+  items?: ShowcasePanelsItemData[] | null;
+  watermark?: string | null;
+  spineVariant?: ("numbered" | "volume" | "minimal") | null;
+  defaultActiveIndex?: number | null;
+  ariaLabel?: string | null;
+  labels?: {
+    selected?: string | null;
+    preview?: string | null;
+  };
+}
+interface ProcessStepsItemData {
+  title?: string | null;
+  description?: string | null;
+  image?: MediaValue;
+  step?: number | null;
+  id?: string | null;
+}
+interface ProcessStepsBlockData extends BlockRow<"processSteps"> {
+  items?: ProcessStepsItemData[] | null;
+  defaultActiveIndex?: number | null;
+  autoAdvance?: boolean | null;
+  autoAdvanceDuration?: number | null;
+  pauseOnHover?: boolean | null;
+  ariaLabel?: string | null;
+  labels?: {
+    pause?: string | null;
+    resume?: string | null;
+  };
+}
+interface FaqColumnsItemData {
+  question?: string | null;
+  /** A textarea, not a Lexical document — see the block's config for why. */
+  answer?: string | null;
+  id?: string | null;
+}
+interface FaqColumnsBlockData extends BlockRow<"faqColumns"> {
+  eyebrow?: string | null;
+  title?: string | null;
+  description?: string | null;
+  items?: FaqColumnsItemData[] | null;
+  cta?: {
+    title?: string | null;
+    linkText?: string | null;
+    href?: string | null;
+    newTab?: boolean | null;
+  };
+  sticky?: boolean | null;
+  type?: ("single" | "multiple") | null;
+  collapsible?: boolean | null;
+}
+interface TestimonialMasonryItemData {
+  content?: string | null;
+  author?: {
+    name?: string | null;
+    title?: string | null;
+    avatar?: MediaValue;
+  };
+  id?: string | null;
+}
+interface TestimonialMasonryBlockData extends BlockRow<"testimonialMasonry"> {
+  eyebrow?: string | null;
+  title?: string | null;
+  description?: string | null;
+  items?: TestimonialMasonryItemData[] | null;
+  link?: LinkValue;
+  minItemsForFade?: number | null;
+  maxVisibleRows?: number | null;
+}
+interface NapDepartmentData {
+  name?: string | null;
+  departmentType?: string | null;
+  phoneE164?: string | null;
+  phoneDisplay?: string | null;
+  id?: string | null;
+}
+interface NapBlockData extends BlockRow<"nap"> {
+  businessName?: string | null;
+  businessType?: string | null;
+  address?: {
+    streetAddress?: string | null;
+    addressLocality?: string | null;
+    addressRegion?: string | null;
+    postalCode?: string | null;
+    addressCountry?: string | null;
+  };
+  departments?: NapDepartmentData[] | null;
+  url?: string | null;
+  showName?: boolean | null;
+  headingLevel?: ("h2" | "h3" | "h4") | null;
+  emitJsonLd?: boolean | null;
+}
+//#endregion
+export { RichTextBlockData as a, BlockLike as c, DEFAULT_CONTAINER as d, RenderBlocks as f, DefaultBlockImage as g, BlockImageProps as h, ProcessStepsBlockData as i, BlockRegistryFor as l, BlockImageComponent as m, HeroBlockData as n, ShowcasePanelsBlockData as o, RenderBlocksProps as p, NapBlockData as r, TestimonialMasonryBlockData as s, FaqColumnsBlockData as t, BlockRendererProps as u };
+//# sourceMappingURL=types-BvRvDCDT.d.mts.map

package/dist/types-BvRvDCDT.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-BvRvDCDT.d.mts","names":[],"sources":["../src/image.tsx","../src/render-blocks.tsx","../src/fields/link.ts","../src/media.ts","../src/types.ts"],"mappings":";;;;;;;;AAkBA;;;;;;;;;;;UAAiB,eAAA;EACf,GAAA;EAYU;EAVV,GAAA;EACA,KAAA;EACA,MAAA;EACA,SAAA;EAcc;EAZd,KAAA;;EAEA,QAAA;AAAA;AAAA,KAGU,mBAAA,GAAsB,aAAA,CAAc,eAAA;;;;;;iBAOhC,iBAAA,CAAA;EACd,GAAA;EACA,GAAA;EACA,KAAA;EACA,MAAA;EACA,SAAA;EACA,KAAA;EACA;AAAA,GACC,eAAA,GAAe,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;UCzCD,SAAA;EACf,SAAA;EACA,EAAA;AAAA;;;;;;;;;;;;ADwBF;UCTiB,kBAAA,WAA6B,SAAA,GAAY,SAAA;EACxD,KAAA,EAAO,CAAA;EDQyB;ECNhC,KAAA;EDac;ECXd,QAAA;;EAEA,QAAA;EACA,MAAA;EDWA;ECTA,kBAAA;EDWA;ECTA,cAAA,EAAgB,mBAAA;AAAA;;;;;;;;;;KAYN,gBAAA,WAA2B,SAAA,YAC/B,CAAA,gBAAiB,aAAA,CACrB,kBAAA,CAAmB,OAAA,CAAQ,CAAA;EAAK,SAAA,EAAW,CAAA;AAAA;;cAKlC,iBAAA;AAAA,UAkCI,iBAAA,WAA4B,SAAA;ED1C3C;EC4CA,MAAA,EAAQ,CAAA;EACR,QAAA,EAAU,gBAAA,CAAiB,CAAA;ED5CX;EC8ChB,kBAAA;ED9CgB;ECgDhB,cAAA,GAAiB,mBAAA;AAAA;;AAzFnB;;;iBAgGgB,YAAA,WAAuB,SAAA,CAAA,CAAA;EACrC,MAAA;EACA,QAAA;EACA,kBAAA;EACA;AAAA,GACC,iBAAA,CAAkB,CAAA,IAAK,YAAA;;;;UCtCT,SAAA;EACf,KAAA;EACA,IAAA;EACA,MAAA;AAAA;;;;;;;;AFrDF;;;;;;;;;;;;;AAaA;UGXiB,QAAA;EACf,GAAA;EACA,GAAA;EACA,KAAA;EACA,MAAA;AAAA;;KAIU,UAAA,qBAA+B,QAAA;;;;;;AHV3C;;;;;;;;;;;;;AAaA;;;;;AAOA;;UIXU,QAAA;EACR,EAAA;EACA,SAAA;EACA,SAAA,EAAW,CAAA;AAAA;;;;;UAOI,eAAA;EACf,IAAA;IACE,IAAA;IACA,QAAA;IACA,SAAA;IACA,MAAA;IACA,MAAA;IACA,OAAA;EAAA;AAAA;AAAA,UAIa,aAAA,SAAsB,QAAA;EACrC,OAAA;EACA,OAAA;EACA,IAAA;EACA,IAAA;EACA,KAAA,GAAQ,UAAA;EACR,KAAA,GAAQ,SAAA;AAAA;AAAA,UAGO,iBAAA,SAA0B,QAAA;EACzC,OAAA,GAAU,eAAA;AAAA;AAAA,UAGK,sBAAA;EACf,KAAA;EACA,OAAA;EACA,KAAA,GAAQ,UAAA;EACR,IAAA;EACA,OAAA;EACA,EAAA;AAAA;AAAA,UAGe,uBAAA,SAAgC,QAAA;EAC/C,KAAA,GAAQ,sBAAA;EACR,SAAA;EACA,YAAA;EACA,kBAAA;EACA,SAAA;EACA,MAAA;IACE,QAAA;IACA,OAAA;EAAA;AAAA;AAAA,UAIa,oBAAA;EACf,KAAA;EACA,WAAA;EACA,KAAA,GAAQ,UAAA;EACR,IAAA;EACA,EAAA;AAAA;AAAA,UAGe,qBAAA,SAA8B,QAAA;EAC7C,KAAA,GAAQ,oBAAA;EACR,kBAAA;EACA,WAAA;EACA,mBAAA;EACA,YAAA;EACA,SAAA;EACA,MAAA;IACE,KAAA;IACA,MAAA;EAAA;AAAA;AAAA,UAIa,kBAAA;EACf,QAAA;EHxDE;EG0DF,MAAA;EACA,EAAA;AAAA;AAAA,UAGe,mBAAA,SAA4B,QAAA;EAC3C,OAAA;EACA,KAAA;EACA,WAAA;EACA,KAAA,GAAQ,kBAAA;EACR,GAAA;IACE,KAAA;IACA,QAAA;IACA,IAAA;IACA,MAAA;EAAA;EAEF,MAAA;EACA,IAAA;EACA,WAAA;AAAA;AAAA,UAGe,0BAAA;EACf,OAAA;EACA,MAAA;IACE,IAAA;IACA,KAAA;IACA,MAAA,GAAS,UAAA;EAAA;EAEX,EAAA;AAAA;AAAA,UAGe,2BAAA,SACP,QAAA;EACR,OAAA;EACA,KAAA;EACA,WAAA;EACA,KAAA,GAAQ,0BAAA;EACR,IAAA,GAAO,SAAA;EACP,eAAA;EACA,cAAA;AAAA;AAAA,UAGe,iBAAA;EACf,IAAA;EACA,cAAA;EACA,SAAA;EACA,YAAA;EACA,EAAA;AAAA;AAAA,UAGe,YAAA,SAAqB,QAAA;EACpC,YAAA;EACA,YAAA;EACA,OAAA;IACE,aAAA;IACA,eAAA;IACA,aAAA;IACA,UAAA;IACA,cAAA;EAAA;EAEF,WAAA,GAAc,iBAAA;EACd,GAAA;EACA,QAAA;EACA,YAAA;EACA,UAAA;AAAA"}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@bison-lab/payload-blocks",
+  "version": "2.0.0",
+  "description": "Payload CMS block configs and renderers for the Bison Lab marketing blocks",
+  "homepage": "https://components.bisonlab.ai",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Bison-Lab-LLC/bisonlab-component-library.git",
+    "directory": "packages/payload-blocks"
+  },
+  "bugs": {
+    "url": "https://github.com/Bison-Lab-LLC/bisonlab-component-library/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    },
+    "./react": {
+      "import": "./dist/react.mjs",
+      "types": "./dist/react.d.mts"
+    },
+    "./rich-text": {
+      "import": "./dist/rich-text.mjs",
+      "types": "./dist/rich-text.d.mts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@bison-lab/ui": "^2.0.0",
+    "@payloadcms/richtext-lexical": "^3.0.0",
+    "payload": "^3.0.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@bison-lab/ui": {
+      "optional": true
+    },
+    "@payloadcms/richtext-lexical": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@payloadcms/richtext-lexical": "^3.88.0",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "jsdom": "^29.0.1",
+    "payload": "^3.88.0",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "tsdown": "^0.21.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.2",
+    "@bison-lab/ui": "2.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}