@puckeditor/cli 0.24.0-canary.301a0304

package/dist/templates/vinext-ai/_gitignore

@@ -0,0 +1,33 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# vinext
+/dist/
+
+# 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/vinext-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/vinext-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/vinext-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/vinext-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/vinext-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/vinext-ai/app/page.tsx

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

package/dist/templates/vinext-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 }),
+        });
+      }}
+    />
+  );
+}

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

@@ -0,0 +1,57 @@
+/**
+ * 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 "@puckeditor/plugin-ai/styles.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/vinext-ai/app/puck/page.tsx

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

package/dist/templates/vinext-ai/app/styles.css

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

package/dist/templates/vinext-ai/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/vinext-ai/lib/get-page.ts

@@ -0,0 +1,11 @@
+import { Data } from "@puckeditor/core";
+import fs from "fs";
+
+// Replace with a 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/vinext-ai/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "vinext-ai-recipe",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vinext dev",
+    "build": "vinext build",
+    "start": "vinext start",
+    "lint": "eslint"
+  },
+  "dependencies": {
+    "@puckeditor/cloud-client": "^0",
+    "@puckeditor/core": "workspace:*",
+    "@puckeditor/plugin-ai": "^0",
+    "classnames": "^2.3.2",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "react-server-dom-webpack": "^19.2.6",
+    "vinext": "^1.0.0-beta.13"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^6.0.0",
+    "@vitejs/plugin-rsc": "^0.5.34",
+    "eslint-config-custom": "workspace:*",
+    "typescript": "^5.5.4",
+    "vite": "^8.0.0"
+  }
+}

package/dist/templates/vinext-ai/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/vinext-ai/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/vinext-ai/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "types": [
+      "vinext/types"
+    ]
+  },
+  "include": [
+    "**/*.ts",
+    "**/*.tsx"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/dist/templates/vinext-ai/vite.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from "vite";
+import vinext from "vinext";
+
+export default defineConfig({
+  plugins: [vinext()],
+  ssr: {
+    external: ["@vercel/oidc"],
+  },
+});

package/dist/templates/vite/README.md

@@ -0,0 +1,56 @@
+# Puck + Vite recipe
+
+[Puck](https://puckeditor.com) is the open-source visual editor for React.
+
+This recipe adds Puck to a [Vite](https://vite.dev) React app. A small [Hono](https://hono.dev) server in `server/` stores pages. Vite runs it in development with [`@hono/vite-dev-server`](https://github.com/honojs/vite-plugins/tree/main/packages/dev-server), and `npm start` serves it with the built app in production.
+
+## Run the recipe
+
+### 1. Start the development server
+
+Run:
+
+```sh
+npm run dev
+```
+
+Once the server is running, navigate to [http://localhost:5173](http://localhost:5173) to view the home page, or [http://localhost:5173/edit](http://localhost:5173/edit) to edit it with Puck.
+
+### 2. Publish a page
+
+Open the `Blocks` tab in the left sidebar and drag components onto the canvas. Once your page is ready, select **Publish** in the header to save it, then navigate to [http://localhost:5173](http://localhost:5173) to view it.
+
+You can also create a page at any path by navigating to `/your/path/edit` and publishing it.
+
+## How it works
+
+`PuckRoot` (`src/puck/root.tsx`) wraps the app in `src/main.tsx`. When a URL ends in `/edit`, it renders the editor for that path instead of the app. The editor is loaded on demand, so it stays out of the app's bundle.
+
+Selecting **Publish** sends the page to `POST /api/pages`, which writes it to `database.json`. `<PuckPage>` (`src/puck/page.tsx`) loads a published page from `GET /api/pages` and renders it with [`<Render>`](https://puckeditor.com/docs/api-reference/components/render). Put it wherever your app renders pages; this recipe's `App` renders it for every URL.
+
+| File                   | Purpose                                                                                            |
+| ---------------------- | -------------------------------------------------------------------------------------------------- |
+| `src/puck.config.tsx`  | Defines the components, fields, and default props available to Puck. Add your own components here. |
+| `src/puck/root.tsx`    | Renders the editor at `/edit` URLs, and your app everywhere else.                                  |
+| `src/puck/editor.tsx`  | Loads the page being edited and publishes changes.                                                 |
+| `src/puck/page.tsx`    | Loads and renders a published page.                                                                |
+| `src/puck/pages.ts`    | Calls the pages API.                                                                               |
+| `server/index.ts`      | The Hono app serving Puck's APIs.                                                                  |
+| `server/puck/pages.ts` | Reads and writes page data in `database.json`. Replace this with your own database.                |
+| `server/prod.ts`       | Serves the built app and the APIs in production.                                                   |
+| `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` routes and `/api/pages` route are public by default. Add authentication and authorization.
+- **Add your component library.** Replace the example `HeadingBlock` in `src/puck.config.tsx` with the components and fields your users need.
+- **Use a real database.** Replace `database.json` and `server/puck/pages.ts`. Local files are not reliable across server instances or serverless deployments.
+
+## Learn more
+
+- [Puck documentation](https://puckeditor.com/docs)
+- [Integrating Puck](https://puckeditor.com/docs/integrating-puck/component-configuration)
+- [Vite](https://vite.dev)
+- [Puck Discord](https://discord.gg/D9e4E3MQVZ)

package/dist/templates/vite/_gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

package/dist/templates/vite/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/vite/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Puck + Vite</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/dist/templates/vite/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "vite-recipe",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "preview": "vite preview",
+    "start": "tsx server/prod.ts"
+  },
+  "dependencies": {
+    "@hono/node-server": "^2.1.1",
+    "@puckeditor/core": "workspace:*",
+    "hono": "^4.13.9",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
+  },
+  "devDependencies": {
+    "@hono/vite-dev-server": "^0.26.1",
+    "@types/node": "^22.10.2",
+    "@types/react": "^19.2.0",
+    "@types/react-dom": "^19.2.0",
+    "@vitejs/plugin-react": "^6.0.1",
+    "tsx": "^4.23.0",
+    "typescript": "^5.9.3",
+    "vite": "^8.0.0"
+  }
+}

package/dist/templates/vite/server/index.ts

@@ -0,0 +1,13 @@
+// Puck's APIs, served by Vite in development and by server/prod.ts in production
+import fs from "node:fs";
+import { Hono } from "hono";
+import { puckPages } from "./puck/pages.js";
+
+// Vite doesn't give server code .env.local, which holds PUCK_API_KEY
+if (fs.existsSync(".env.local")) process.loadEnvFile(".env.local");
+
+const app = new Hono();
+
+app.route("/", puckPages);
+
+export default app;

package/dist/templates/vite/server/prod.ts

@@ -0,0 +1,18 @@
+// Serves the built app and Puck's APIs in production
+import { serve } from "@hono/node-server";
+import { serveStatic } from "@hono/node-server/serve-static";
+import { Hono } from "hono";
+import api from "./index.js";
+
+const app = new Hono();
+
+app.route("/", api);
+app.use("/*", serveStatic({ root: "./dist" }));
+// Every other path loads the app, which decides what to render
+app.get("*", serveStatic({ path: "./dist/index.html" }));
+
+const port = Number(process.env.PORT ?? 3000);
+
+serve({ fetch: app.fetch, port }, () => {
+  console.log(`Server is running on http://localhost:${port}`);
+});

package/dist/templates/vite/server/puck/pages.ts

@@ -0,0 +1,32 @@
+// Loads and saves Puck pages for the editor
+// Learn more: https://puckeditor.com/docs/cli
+import fs from "node:fs/promises";
+import { Hono } from "hono";
+
+// Replace this with your own database
+const databasePath = "database.json";
+
+const readPages = async (): Promise<Record<string, unknown>> => {
+  try {
+    return JSON.parse(await fs.readFile(databasePath, "utf-8"));
+  } catch {
+    return {};
+  }
+};
+
+export const puckPages = new Hono()
+  .get("/api/pages", async (c) => {
+    const pages = await readPages();
+    const page = pages[c.req.query("path") ?? "/"];
+
+    return page ? c.json(page) : c.json({ error: "Not found" }, 404);
+  })
+  .post("/api/pages", async (c) => {
+    const { path, data } = await c.req.json();
+    const pages = await readPages();
+
+    pages[path] = data;
+    await fs.writeFile(databasePath, JSON.stringify(pages));
+
+    return c.json({ status: "ok" });
+  });

package/dist/templates/vite/src/App.tsx

@@ -0,0 +1,11 @@
+import { PuckPage } from "./puck/page";
+
+// Renders the Puck page published at this URL
+export default function App() {
+  return (
+    <PuckPage
+      path={window.location.pathname}
+      fallback={<h1>Page not found</h1>}
+    />
+  );
+}

package/dist/templates/vite/src/main.tsx

@@ -0,0 +1,12 @@
+import { StrictMode } from "react";
+import { createRoot } from "react-dom/client";
+import App from "./App.tsx";
+import { PuckRoot } from "./puck/root";
+
+createRoot(document.getElementById("root")!).render(
+  <StrictMode>
+    <PuckRoot>
+      <App />
+    </PuckRoot>
+  </StrictMode>
+);