@puckeditor/cli 0.24.0-canary.301a0304

package/dist/templates/next/app/puck/[...puckPath]/page.tsx

@@ -0,0 +1,55 @@
+/**
+ * This file implements a *magic* catch-all route that renders the Puck editor.
+ *
+ * This route exposes /puck/[...puckPath], but is disabled by middleware.ts. The middleware
+ * then rewrites all URL requests ending in `/edit` to this route, allowing you to visit any
+ * page in your application and add /edit to the end to spin up a Puck editor.
+ *
+ * This approach enables public pages to be statically rendered whilst the /puck route can
+ * remain dynamic.
+ *
+ * NB this route is public, and you will need to add authentication
+ */
+
+import "@puckeditor/core/puck.css";
+import type { Data } from "@puckeditor/core";
+import { Metadata } from "next";
+import { Client } from "./client";
+import { getPage } from "../../../lib/get-page";
+
+// Empty data for new pages.
+const EMPTY_PAGE_DATA: Data = {
+  content: [],
+  root: {
+    props: {
+      title: "",
+    },
+  },
+};
+
+export async function generateMetadata({
+  params,
+}: {
+  params: Promise<{ puckPath: string[] }>;
+}): Promise<Metadata> {
+  const { puckPath = [] } = await params;
+  const path = `/${puckPath.join("/")}`;
+
+  return {
+    title: "Puck: " + path,
+  };
+}
+
+export default async function Page({
+  params,
+}: {
+  params: Promise<{ puckPath: string[] }>;
+}) {
+  const { puckPath = [] } = await params;
+  const path = `/${puckPath.join("/")}`;
+  const data = getPage(path);
+
+  return <Client path={path} data={data || EMPTY_PAGE_DATA} />;
+}
+
+export const dynamic = "force-dynamic";

package/dist/templates/next/app/puck/api/route.ts

@@ -0,0 +1,25 @@
+import { revalidatePath } from "next/cache";
+import { NextResponse } from "next/server";
+import fs from "fs";
+
+export async function POST(request: Request) {
+  const payload = await request.json();
+
+  const existingData = JSON.parse(
+    fs.existsSync("database.json")
+      ? fs.readFileSync("database.json", "utf-8")
+      : "{}"
+  );
+
+  const updatedData = {
+    ...existingData,
+    [payload.path]: payload.data,
+  };
+
+  fs.writeFileSync("database.json", JSON.stringify(updatedData));
+
+  // Purge Next.js cache
+  revalidatePath(payload.path);
+
+  return NextResponse.json({ status: "ok" });
+}

package/dist/templates/next/app/puck/page.tsx

@@ -0,0 +1,3 @@
+export { default, generateMetadata } from "./[...puckPath]/page";
+
+export const dynamic = "force-dynamic";

package/dist/templates/next/app/styles.css

@@ -0,0 +1,3 @@
+body {
+  margin: 0;
+}

package/dist/templates/next/database.json

@@ -0,0 +1 @@
+{"/":{"content":[{"type":"HeadingBlock","props":{"title":"Edit this page by adding /edit to the end of the URL","id":"HeadingBlock-1694032984497"}}],"root":{"props": {"title":""}}}}

package/dist/templates/next/lib/get-page.ts

@@ -0,0 +1,11 @@
+import { Data } from "@puckeditor/core";
+import fs from "fs";
+
+// Replace with call to your database
+export const getPage = (path: string) => {
+  const allData: Record<string, Data> | null = fs.existsSync("database.json")
+    ? JSON.parse(fs.readFileSync("database.json", "utf-8"))
+    : null;
+
+  return allData ? allData[path] : null;
+};

package/dist/templates/next/next.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  reactStrictMode: true,
+};

package/dist/templates/next/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "next-recipe",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev --turbo",
+    "build": "next build",
+    "start": "next start",
+    "lint": "eslint"
+  },
+  "dependencies": {
+    "@puckeditor/core": "workspace:*",
+    "classnames": "^2.3.2",
+    "next": "^16.2.11",
+    "react": "^19.2.1",
+    "react-dom": "^19.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.12",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "eslint-config-custom": "workspace:*",
+    "typescript": "^5.5.4"
+  }
+}

package/dist/templates/next/proxy.ts

@@ -0,0 +1,27 @@
+import { NextResponse } from "next/server";
+
+import type { NextRequest } from "next/server";
+
+export async function proxy(req: NextRequest) {
+  const res = NextResponse.next({ request: req });
+
+  if (req.method === "GET") {
+    // Rewrite routes that match "/[...puckPath]/edit" to "/puck/[...puckPath]"
+    if (req.nextUrl.pathname.endsWith("/edit")) {
+      const pathWithoutEdit = req.nextUrl.pathname.slice(
+        0,
+        req.nextUrl.pathname.length - 5
+      );
+      const pathWithEditPrefix = `/puck${pathWithoutEdit}`;
+
+      return NextResponse.rewrite(new URL(pathWithEditPrefix, req.url));
+    }
+
+    // Disable "/puck/[...puckPath]"
+    if (req.nextUrl.pathname.startsWith("/puck")) {
+      return NextResponse.redirect(new URL("/", req.url));
+    }
+  }
+
+  return res;
+}

package/dist/templates/next/puck.config.tsx

@@ -0,0 +1,25 @@
+import type { Config } from "@puckeditor/core";
+
+type Props = {
+  HeadingBlock: { title: string };
+};
+
+export const config: Config<Props> = {
+  components: {
+    HeadingBlock: {
+      fields: {
+        title: { type: "text" },
+      },
+      defaultProps: {
+        title: "Heading",
+      },
+      render: ({ title }) => (
+        <div style={{ padding: 64 }}>
+          <h1>{title}</h1>
+        </div>
+      ),
+    },
+  },
+};
+
+export default config;

package/dist/templates/next/tsconfig/base.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Default",
+  "compilerOptions": {
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true
+  },
+  "exclude": ["node_modules"]
+}

package/dist/templates/next/tsconfig/nextjs.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Next.js",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "plugins": [{ "name": "next" }],
+    "allowJs": true,
+    "declaration": false,
+    "declarationMap": false,
+    "incremental": true,
+    "jsx": "preserve",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "module": "esnext",
+    "noEmit": true,
+    "resolveJsonModule": true,
+    "strict": false,
+    "target": "es5"
+  },
+  "include": ["src", "next-env.d.ts"],
+  "exclude": ["node_modules"]
+}

package/dist/templates/next/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig/nextjs.json",
+  "compilerOptions": {
+    "plugins": [{ "name": "next" }]
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/dist/templates/next-ai/README.md

@@ -0,0 +1,169 @@
+# Puck AI + Next.js recipe
+
+[Puck](https://puckeditor.com) is the open-source visual editor for React. It lets you create page builders that use your own components.
+
+[Puck AI](https://puckeditor.com/docs/ai/overview) builds on the same principles to let you generate pages by assembling your existing components or creating new ones on the fly, either as a copilot in the editor or headlessly.
+
+This recipe connects Puck and Puck AI to the [Next.js App Router](https://nextjs.org/docs/app), so you can create and edit pages for any route in this app.
+
+## Core concepts
+
+If you're new to Puck, this section introduces the core concepts you need to know.
+
+### Puck
+
+The Puck visual editor has three main parts: a config, the editor, and the renderer.
+
+#### Config
+
+The [config](https://puckeditor.com/docs/integrating-puck/component-configuration) registers the components users can use to build pages in the editor and the fields they can edit.
+
+```tsx
+const config = {
+  components: {
+    HeadingBlock: {
+      fields: {
+        title: { type: "text" },
+      },
+      render: ({ title }) => <h1>{title}</h1>,
+    },
+  },
+};
+```
+
+#### The editor
+
+The [`<Puck>`](https://puckeditor.com/docs/api-reference/components/puck) component renders the editor. It uses a config, exports [pages as JSON](https://puckeditor.com/docs/api-reference/data-model/data), and accepts initial page data for editing existing pages.
+
+```tsx
+<Puck
+  config={config} // The components available to the editor
+  data={data} // The page JSON to edit
+  onPublish={(data) => {
+    // Save data to your database
+  }}
+/>
+```
+
+#### The renderer
+
+The [`<Render>`](https://puckeditor.com/docs/api-reference/components/render) component renders pages. It expects the page JSON and the config used to create that page.
+
+```tsx
+<Render
+  config={config} // The components used to create the page
+  data={data} // The page JSON to render
+/>
+```
+
+### Puck AI
+
+This recipe adds Puck AI as a copilot. It has two parts: the AI plugin (browser) and the Cloud Client (server).
+
+#### The AI plugin
+
+The [AI plugin](https://puckeditor.com/docs/api-reference/ai/ai-plugin/installation) renders the chat in the editor and sends each message to the Cloud Client on your server.
+
+```tsx
+const aiPlugin = createAiPlugin();
+
+function Editor() {
+  return <Puck plugins={[aiPlugin]} config={config} data={data} />;
+}
+```
+
+#### The Cloud Client
+
+The [Cloud Client](https://puckeditor.com/docs/api-reference/ai/cloud-client/installation) provides APIs for connecting your server to the Puck cloud. This recipe uses its [`puckHandler`](https://puckeditor.com/docs/api-reference/ai/cloud-client/puck-handler) API, which receives each chat message, forwards it to the Puck cloud, and streams the response back to the plugin in the browser.
+
+```ts
+const handleRequest = (request: NextRequest) => {
+  return puckHandler(request, {
+    ai: {
+      context: "We are Google. You create Google landing pages.",
+    },
+  });
+};
+
+export const DELETE = handleRequest;
+export const GET = handleRequest;
+export const POST = handleRequest;
+```
+
+#### Puck AI modes
+
+Puck AI can build pages in two ways:
+
+- **Assembly mode** only builds pages using components from your config.
+- **Design mode** can generate new components when needed.
+
+This recipe comes with [Design mode](https://puckeditor.com/docs/api-reference/ai/cloud-client/puck-handler#aidesignmode) enabled out of the box.
+
+## Run the recipe
+
+### 1. Add a Puck API key
+
+Start by creating an account, [generating an API key](https://cloud.puckeditor.com/api-keys), and adding it to a `.env.local` file:
+
+```sh
+PUCK_API_KEY=your-api-key
+```
+
+### 2. Start the development server
+
+Run:
+
+```sh
+npm run dev
+```
+
+Once the server is running, navigate to [http://localhost:3000](http://localhost:3000) to view the home page, or [http://localhost:3000/edit](http://localhost:3000/edit) to edit it with Puck.
+
+### 3. Create a page with Puck AI
+
+Navigate to [http://localhost:3000/edit](http://localhost:3000/edit), click the **AI** button in the left sidebar, enter a prompt, and press Enter.
+
+### 4. Publish the page
+
+Once your page is ready, select **Publish** in the header to save the result, then navigate to [http://localhost:3000](http://localhost:3000) to view the published page.
+
+You can also create a page at any path by navigating to `/your/path/edit` and publishing it. The route `/your/path` will render the page.
+
+## How it works
+
+When a URL ends in `/edit`, [`proxy.ts`](https://nextjs.org/docs/app/api-reference/file-conventions/proxy) sends the request to the Puck editor route (`app/puck/[...puckPath]/page.tsx`). The editor loads the saved page, or starts with an empty page if the path is new.
+
+Selecting **Publish** sends the page data to the `/api/pages` endpoint (`app/api/pages/route.ts`). The handler writes the JSON to `database.json` and clears the Next.js cache for that page. The catch-all route (`app/[...puckPath]/page.tsx`) then loads the same data and renders it with [`<Render>`](https://puckeditor.com/docs/api-reference/components/render).
+
+The table below shows the files that implement this flow.
+
+| File                                | Purpose                                                                                                              |
+| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `puck.config.tsx`                   | Defines the components, fields, and default props available to Puck and Assembly mode. Add your own components here. |
+| `app/puck/[...puckPath]/page.tsx`   | Loads page data for the editor.                                                                                      |
+| `app/puck/[...puckPath]/client.tsx` | Renders the editor with the AI copilot, sends prompts to your server, and publishes changes.                         |
+| `app/[...puckPath]/page.tsx`        | Loads and renders published pages.                                                                                   |
+| `app/api/pages/route.ts`            | Saves published pages.                                                                                               |
+| `app/api/puck/[...all]/route.ts`    | Handles requests from the AI plugin and configures AI generation.                                                    |
+| `proxy.ts`                          | Routes URLs ending in `/edit` to `/puck/[...puckPath]/page.tsx`.                                                     |
+| `lib/get-page.ts`                   | Reads page data from `database.json`. Replace this with your own data fetching logic.                                |
+| `database.json`                     | Acts as a local database. Replace this with your own database solution.                                              |
+
+## Before deploying to production
+
+Before deploying this recipe, make sure to:
+
+- **Protect the editor and APIs.** The `/edit`, `/api/pages`, and `/api/puck` routes are public by default. Add authentication, authorization, and rate limits to protect page data and AI usage.
+- **Add your component library.** Replace the example `HeadingBlock` in `puck.config.tsx` with the components and fields your users need.
+- **Set your business context.** Replace the example Google context in `app/api/puck/[...all]/route.ts` with clear information about your product, audience, and content rules.
+- **Use a real database.** Replace `database.json` in `lib/get-page.ts` and `app/api/pages/route.ts`. Local files are not reliable across server instances or serverless deployments.
+- **Choose a rendering strategy.** `app/[...puckPath]/page.tsx` uses `force-static`. Remove it if a page needs request-time data such as headers, cookies, or user sessions.
+
+## Learn more
+
+- [Puck documentation](https://puckeditor.com/docs)
+- [Getting started with Puck](https://puckeditor.com/docs/getting-started)
+- [Integrating Puck](https://puckeditor.com/docs/integrating-puck/component-configuration)
+- [Puck AI documentation](https://puckeditor.com/docs/ai/overview)
+- [Getting started with Puck AI](https://puckeditor.com/docs/ai/getting-started)
+- [Puck Discord](https://discord.gg/D9e4E3MQVZ)

package/dist/templates/next-ai/_gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+next-env.d.ts
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel

package/dist/templates/next-ai/app/[...puckPath]/client.tsx

@@ -0,0 +1,12 @@
+"use client";
+
+import type { Data } from "@puckeditor/core";
+import { Render } from "@puckeditor/core";
+import { withDynamicConfig } from "@puckeditor/plugin-ai";
+import config from "../../puck.config";
+
+export function Client({ data }: { data: Data }) {
+  const configWithDesignedComponents = withDynamicConfig(config, data);
+
+  return <Render config={configWithDesignedComponents} data={data} />;
+}

package/dist/templates/next-ai/app/[...puckPath]/page.tsx

@@ -0,0 +1,49 @@
+/**
+ * This file implements a catch-all route that renders the user-facing pages
+ * generated by Puck. For any route visited (with exception of other hardcoded
+ * pages in /app), it will check your database (via `getPage`) for a Puck page
+ * and render it using <Render>.
+ *
+ * All routes produced by this page are statically rendered using incremental
+ * static site generation. After the first visit, the page will be cached as
+ * a static file. Subsequent visits will receive the cache. Publishing a page
+ * will invalidate the cache as the page is written in /api/puck/route.ts
+ */
+
+import { Client } from "./client";
+import { notFound } from "next/navigation";
+import { Metadata } from "next";
+import { getPage } from "../../lib/get-page";
+
+export async function generateMetadata({
+  params,
+}: {
+  params: Promise<{ puckPath: string[] }>;
+}): Promise<Metadata> {
+  const { puckPath = [] } = await params;
+  const path = `/${puckPath.join("/")}`;
+
+  return {
+    title: getPage(path)?.root.props?.title,
+  };
+}
+
+export default async function Page({
+  params,
+}: {
+  params: Promise<{ puckPath: string[] }>;
+}) {
+  const { puckPath = [] } = await params;
+  const path = `/${puckPath.join("/")}`;
+  const data = getPage(path);
+
+  if (!data) {
+    return notFound();
+  }
+
+  return <Client data={data} />;
+}
+
+// Force Next.js to produce static pages: https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config#dynamic
+// Delete this if you need dynamic rendering, such as access to headers or cookies
+export const dynamic = "force-static";

package/dist/templates/next-ai/app/api/pages/route.ts

@@ -0,0 +1,26 @@
+import { revalidatePath } from "next/cache";
+import { NextResponse } from "next/server";
+import fs from "fs";
+
+// Saves page data to a JSON file, replace this with your own database logic
+export async function POST(request: Request) {
+  const payload = await request.json();
+
+  const existingData = JSON.parse(
+    fs.existsSync("database.json")
+      ? fs.readFileSync("database.json", "utf-8")
+      : "{}"
+  );
+
+  const updatedData = {
+    ...existingData,
+    [payload.path]: payload.data,
+  };
+
+  fs.writeFileSync("database.json", JSON.stringify(updatedData));
+
+  // Purge Next.js cache
+  revalidatePath(payload.path);
+
+  return NextResponse.json({ status: "ok" });
+}

package/dist/templates/next-ai/app/api/puck/[...all]/route.ts

@@ -0,0 +1,31 @@
+// Handles all requests for Puck AI
+// Learn more: https://puckeditor.com/docs/ai/getting-started
+import type { NextRequest } from "next/server";
+import { puckHandler } from "@puckeditor/cloud-client";
+
+const handleRequest = (request: NextRequest): Promise<Response> => {
+  return puckHandler(request, {
+    ai: {
+      // Replace with your business context
+      context: "We are Google. You create Google landing pages.",
+      designMode: {
+        // Allow AI to generate new components using "design mode"
+        // Learn more: https://puckeditor.com/docs/ai/design-mode
+        allowed: true,
+        // Constrain component generation, replace with your own instructions
+        instructions: `
+        #### Color Palette
+
+        Always use the following colors:
+
+        * Primary: \`#1976d2\`
+        * Secondary: \`#9c27b0\`
+        `,
+      },
+    },
+  });
+};
+
+export const DELETE = handleRequest;
+export const GET = handleRequest;
+export const POST = handleRequest;

package/dist/templates/next-ai/app/layout.tsx

@@ -0,0 +1,13 @@
+import "./styles.css";
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  );
+}

package/dist/templates/next-ai/app/page.tsx

@@ -0,0 +1 @@
+export { default, generateMetadata } from "./[...puckPath]/page";

package/dist/templates/next-ai/app/puck/[...puckPath]/client.tsx

@@ -0,0 +1,38 @@
+"use client";
+
+import type { Data } from "@puckeditor/core";
+import { Puck, blocksPlugin, outlinePlugin } from "@puckeditor/core";
+import { createAiPlugin, withDynamicConfig } from "@puckeditor/plugin-ai";
+
+import config from "../../../puck.config";
+
+const aiPlugin = createAiPlugin({
+  // Allow users to switch between design and assembly mode.
+  // Read more: https://puckeditor.com/docs/ai/design-mode
+  designMode: {
+    visible: true,
+  },
+  // Select design mode by default.
+  defaultMode: "design",
+});
+
+// Place the ai plugin in the first position in the side nav.
+const plugins = [aiPlugin, blocksPlugin(), outlinePlugin()];
+
+export function Client({ path, data }: { path: string; data: Data }) {
+  const configWithDesignedComponents = withDynamicConfig(config, data);
+
+  return (
+    <Puck
+      plugins={plugins}
+      data={data}
+      config={configWithDesignedComponents}
+      onPublish={async (data) => {
+        await fetch("/api/pages", {
+          method: "post",
+          body: JSON.stringify({ data, path }),
+        });
+      }}
+    />
+  );
+}