@dispatchcms/next 0.0.4 → 0.0.5

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @dispatchcms/next@0.0.4 build /Users/jamescalmus/Documents/dispatch/packages/next
+> @dispatchcms/next@0.0.5 build /Users/jamescalmus/Documents/dispatch/packages/next
 > tsup
 
 CLI Building entry: src/index.ts
@@ -11,13 +11,13 @@
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.mjs     2.04 KB
-ESM dist/index.mjs.map 4.20 KB
-ESM ⚡️ Build success in 7ms
 CJS dist/index.js     3.18 KB
 CJS dist/index.js.map 4.45 KB
-CJS ⚡️ Build success in 7ms
+CJS ⚡️ Build success in 13ms
+ESM dist/index.mjs     2.04 KB
+ESM dist/index.mjs.map 4.20 KB
+ESM ⚡️ Build success in 13ms
 DTS Build start
-DTS ⚡️ Build success in 329ms
+DTS ⚡️ Build success in 365ms
 DTS dist/index.d.ts  938.00 B
 DTS dist/index.d.mts 938.00 B

package/README.md

@@ -65,11 +65,20 @@ Returns a single post by its preview token (draft or published). Use this in you
 
 Exportable types:
 
-- **`Post`** – A post from the CMS. Main fields: `id`, `title`, `slug`, `content` (TipTap JSON), `excerpt`, `featured_image`, `published`, `published_at`, `created_at`, `updated_at`, `site_id`.
+- **`Post`** – A post from the CMS. Main fields: `id`, `title`, `slug`, `content` (TipTap/ProseMirror JSON), `excerpt`, `featured_image`, `published`, `published_at`, `created_at`, `updated_at`, `site_id`. See **Rendering content** below for how to render `content`.
 - **`DispatchConfig`** – Options for `initDispatch`: `{ siteKey: string }`.
 
 Use your editor’s type hints or the generated `.d.ts` for the full shape.
 
+## Rendering content
+
+Post `content` is TipTap (ProseMirror) JSON. Render it with TipTap’s static renderer so formatting, links, and images match the CMS:
+
+- **Server Components:** Use `renderToHTMLString` from `@tiptap/static-renderer/pm/html-string` with the same extensions as the CMS (e.g. Document, Paragraph, Heading, Bold, Italic, Blockquote, BulletList, ListItem, Link, Image), then render the HTML in a wrapper `div` (the output is safe TipTap-generated HTML).
+- **Client:** Use `renderToReactElement` from `@tiptap/static-renderer/pm/react` for a React node with no `dangerouslySetInnerHTML`.
+
+Use the same extensions as the CMS editor for full parity. See [TipTap static renderer docs](https://tiptap.dev/docs/editor/api/utilities/static-renderer).
+
 ## Example (Next.js App Router)
 
 **List posts (Server Component):**
@@ -106,7 +115,7 @@ export default async function PostPage({ params }: { params: { slug: string } })
     <article>
       <h1>{post.title}</h1>
       {post.excerpt && <p>{post.excerpt}</p>}
-      {/* Render post.content (TipTap JSON) with your editor/renderer */}
+      {/* Render post.content with TipTap: renderToHTMLString(extensions, post.content) then a div, or use renderToReactElement in a client component */}
     </article>
   );
 }
@@ -137,7 +146,7 @@ export default async function PreviewPage({
       <p className="text-sm text-muted-foreground">Preview</p>
       <h1>{post.title}</h1>
       {post.excerpt && <p>{post.excerpt}</p>}
-      {/* Render post.content the same way as your live post page */}
+      {/* Render post.content with TipTap (same as your live post page) */}
     </article>
   );
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dispatchcms/next",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Fetch published posts from a Dispatch CMS in Next.js",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",