create-avocado-site 0.9.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Avocado Studio Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,65 @@
+# create-avocado-site
+
+Bootstrap a runnable [Avocado Studio](https://docs.avocadostudio.dev) demo — or
+wire Avocado into a Next.js project you already have.
+
+## See the demo
+
+```bash
+npm create avocado-site@latest my-demo
+cd my-demo
+npm run dev
+```
+
+That is the whole of it. The command creates the project, installs it, and
+`npm run dev` starts both halves and opens the editor.
+
+You get the **Avocado Hub**: nine pages, sixty blocks, every built-in block
+type — a real site to talk to, rather than a placeholder to look at. The
+orchestrator runs inside the Next app at `/api/avocado`, so there is no third
+service to start and nothing to deploy.
+
+| | |
+|---|---|
+| Editor | `http://localhost:4100/?siteId=my-demo&session=dev` |
+| Site | `http://localhost:3000` |
+
+Both ports are chosen at scaffold time from what is actually free, so this
+works next to whatever else you have running.
+
+### No API key needed to look
+
+The pages render, click-to-select works, and the property panel edits real
+fields with no key configured at all. Chat is the one thing that needs a model:
+put `ANTHROPIC_API_KEY`, `OPENAI_API_KEY` or `GOOGLE_GENAI_API_KEY` in
+`.env.local` and restart. Avocado runs on your key and never resells tokens.
+
+## Wire it into an existing project
+
+```bash
+cd my-existing-next-app
+npm create avocado-site@latest
+```
+
+With no directory argument the CLI asks what you want. Choose **Wire Avocado
+into this project** and it writes the editor API route, the page routes, the
+block manifest and the request rewrite — `proxy.ts` on Next 16, `middleware.ts`
+on 15 — and touches nothing it did not create. Sanity, Contentful and Strapi
+templates are included; so is a plain JSON file.
+
+It then prints the handful of things it will not do to your repository: the
+install command, the `withAvocado` wrapper for your Next config, and the
+stylesheet import.
+
+For an existing site of any size this is the smaller half of the job. The
+larger half — your components, your content model, your CMS — is at
+[docs.avocadostudio.dev/sites](https://docs.avocadostudio.dev/sites).
+
+## Requirements
+
+- Node.js 22+
+- For the integrate path, a Next.js 15 or 16 project on the App Router
+
+## License
+
+Apache-2.0.

package/assets/logos/avocado-hub.svg

@@ -0,0 +1,7 @@
+<svg width="128" height="128" viewBox="0 0 128 128" fill="none" xmlns="http://www.w3.org/2000/svg" role="img" aria-labelledby="title desc">
+  <title id="title">The Avocado Hub logo</title>
+  <desc id="desc">Stylized avocado mark — dark green shell, light green flesh, brown pit.</desc>
+  <path d="M64 8C88 8 112 40 112 72C112 104 88 120 64 120C40 120 16 104 16 72C16 40 40 8 64 8Z" fill="#1F7A3A"/>
+  <path d="M64 18C82 18 100 44 100 72C100 100 82 110 64 110C46 110 28 100 28 72C28 44 46 18 64 18Z" fill="#7ED957"/>
+  <circle cx="64" cy="72" r="20" fill="#8B5E3C"/>
+</svg>

package/dist/cms-config.d.ts

@@ -0,0 +1,34 @@
+import type { CmsChoice } from "./types.js";
+export type CmsDescriptor = {
+    /** Import statement for the publish handler */
+    publishImport: string;
+    /** Import statement for getPages */
+    getPagesImport: string;
+    /** Expression for onPublish in createEditorApiHandler */
+    onPublish: string;
+    /** Expression for getPages in createEditorApiHandler */
+    getPages: string;
+    /** Import for page component (getPage, getSlugs, getSiteConfig) */
+    pageImport: string;
+    /** Function names for createSitePage */
+    getPage: string;
+    getSlugs: string;
+    getSiteConfig: string | null;
+    /** Revalidation config */
+    revalidate: {
+        secretEnvVar: string;
+        secretHeader: string | null;
+        extractSlug: string;
+        getPagesImport: string;
+        getPagesFn: string;
+    } | null;
+    /** Env var template */
+    envVars: string;
+    /** Additional npm dependencies */
+    npmDeps: string;
+    /** Additional next.config image hostname */
+    imageHostname: string | null;
+    /** Additional next.config compiler options */
+    compilerConfig: string;
+};
+export declare const CMS_CONFIGS: Record<CmsChoice, CmsDescriptor>;

package/dist/cms-config.js

@@ -0,0 +1,103 @@
+export const CMS_CONFIGS = {
+    sanity: {
+        publishImport: `import { createSanityPublishHandler } from "../../../../lib/publish"`,
+        getPagesImport: `import { getSanityPages } from "../../../../lib/sanity.fetch"`,
+        onPublish: `createSanityPublishHandler()`,
+        getPages: `() => getSanityPages()`,
+        pageImport: `import { getSanityPage, getSanitySlugs, getSanitySiteConfig } from "../../lib/sanity.fetch"`,
+        getPage: "getSanityPage",
+        getSlugs: "getSanitySlugs",
+        getSiteConfig: "getSanitySiteConfig",
+        revalidate: {
+            secretEnvVar: "SANITY_WEBHOOK_SECRET",
+            secretHeader: `["query:secret", "x-sanity-webhook-secret"]`,
+            extractSlug: `(body) => (body as { slug?: { current?: string } })?.slug?.current ?? null`,
+            getPagesImport: `import { getSanityPages } from "../../../lib/sanity.fetch"`,
+            getPagesFn: "getSanityPages",
+        },
+        envVars: `# Sanity
+NEXT_PUBLIC_SANITY_PROJECT_ID=
+NEXT_PUBLIC_SANITY_DATASET=production
+SANITY_API_TOKEN=
+SANITY_WEBHOOK_SECRET=`,
+        npmDeps: " @sanity/client @sanity/image-url groq",
+        imageHostname: "cdn.sanity.io",
+        compilerConfig: `  compiler: { styledComponents: true },\n`,
+    },
+    contentful: {
+        publishImport: `import { createContentfulPublishHandler } from "../../../../lib/publish"`,
+        getPagesImport: `import { getContentfulPages } from "../../../../lib/contentful"`,
+        onPublish: `createContentfulPublishHandler({
+    spaceId: process.env.CONTENTFUL_SPACE_ID!,
+    managementToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN!,
+    environmentId: process.env.CONTENTFUL_ENVIRONMENT ?? "master",
+  })`,
+        getPages: `() => getContentfulPages()`,
+        pageImport: `import { getContentfulPage, getContentfulSlugs, getContentfulSiteConfig } from "../../lib/contentful"`,
+        getPage: "getContentfulPage",
+        getSlugs: "getContentfulSlugs",
+        getSiteConfig: "getContentfulSiteConfig",
+        revalidate: {
+            secretEnvVar: "REVALIDATION_SECRET",
+            secretHeader: null,
+            extractSlug: `(body) =>\n    (body as { fields?: { slug?: { "en-US"?: string } } })?.fields?.slug?.["en-US"] ?? null`,
+            getPagesImport: `import { getContentfulPages } from "../../../lib/contentful"`,
+            getPagesFn: "getContentfulPages",
+        },
+        envVars: `# Contentful
+CONTENTFUL_SPACE_ID=
+CONTENTFUL_ENVIRONMENT=master
+CONTENTFUL_DELIVERY_TOKEN=
+CONTENTFUL_MANAGEMENT_TOKEN=
+REVALIDATION_SECRET=`,
+        npmDeps: " contentful contentful-management",
+        imageHostname: "images.ctfassets.net",
+        compilerConfig: "",
+    },
+    strapi: {
+        publishImport: `import { createStrapiPublishHandler } from "../../../../lib/publish"`,
+        getPagesImport: `import { getStrapiPages } from "../../../../lib/strapi.fetch"`,
+        onPublish: `createStrapiPublishHandler()`,
+        getPages: `() => getStrapiPages()`,
+        pageImport: `import { getStrapiPage, getStrapiSlugs, getStrapiSiteConfig } from "../../lib/strapi.fetch"`,
+        getPage: "getStrapiPage",
+        getSlugs: "getStrapiSlugs",
+        getSiteConfig: "getStrapiSiteConfig",
+        revalidate: {
+            secretEnvVar: "STRAPI_WEBHOOK_SECRET",
+            secretHeader: null,
+            extractSlug: `(body) =>\n    (body as { entry?: { slug?: string } })?.entry?.slug ?? null`,
+            getPagesImport: `import { getStrapiPages } from "../../../lib/strapi.fetch"`,
+            getPagesFn: "getStrapiPages",
+        },
+        envVars: `# Strapi
+STRAPI_URL=http://localhost:1337
+STRAPI_API_TOKEN=
+STRAPI_WEBHOOK_SECRET=`,
+        npmDeps: "",
+        imageHostname: null,
+        compilerConfig: "",
+    },
+    none: {
+        publishImport: `import { createJsonFilePublishHandler } from "@avocadostudio-ai/site-sdk/publish-handlers/json-file"
+import { resolve } from "node:path"`,
+        /*
+         * This was `() => Promise.resolve([])` — a literal empty array, in the one
+         * call the editor uses to discover what pages a site has. The scaffold
+         * rendered nine pages and reported none of them, and because the preview
+         * pane showed the site correctly the failure read as an editor bug.
+         */
+        getPagesImport: `import { getPages } from "../../../../lib/content"`,
+        onPublish: `createJsonFilePublishHandler(resolve(process.cwd(), "content/pages.json"))`,
+        getPages: `() => getPages()`,
+        pageImport: `import { getPage, getSlugs, getSiteConfig } from "../../lib/content"`,
+        getPage: "getPage",
+        getSlugs: "getSlugs",
+        getSiteConfig: "getSiteConfig",
+        revalidate: null,
+        envVars: "",
+        npmDeps: "",
+        imageHostname: null,
+        compilerConfig: "",
+    },
+};

package/dist/generator.d.ts

@@ -0,0 +1,22 @@
+import type { ScaffoldConfig, GeneratedFile } from "./types.js";
+/**
+ * A whole project, not a patch to one.
+ *
+ * The distinction from `collectFiles` is what it is allowed to own. This path
+ * creates an empty directory and fills it, so it writes the package manifest,
+ * the Next config, the root layout and the stylesheet — files that in the
+ * integrate path belong to the host app and must not be touched.
+ *
+ * It also scaffolds `mode: "auto"`: one route file that decides published
+ * versus editor per request. That removes the proxy (or middleware), the
+ * second `preview-draft` route, and the class of failure where the two route
+ * files drift apart — at the cost of static rendering, which a local demo does
+ * not have and does not want.
+ */
+export declare function collectDemoFiles(config: ScaffoldConfig): GeneratedFile[];
+/** Wiring for a Next.js app that already exists. Touches nothing it did not create. */
+export declare function collectFiles(config: ScaffoldConfig): GeneratedFile[];
+export declare function generateFiles(cwd: string, files: GeneratedFile[]): Promise<{
+    written: string[];
+    skipped: string[];
+}>;

package/dist/generator.js

@@ -0,0 +1,92 @@
+import { constants, copyFile, mkdir, writeFile } from "node:fs/promises";
+import { dirname, join } from "node:path";
+import { editorApiRoute, revalidateRoute, manifestFile, pageFile, middlewareFile, proxyFile, notFoundFile, envExample, } from "./templates/common.js";
+import { demoAppTemplates } from "./templates/demo-app.js";
+import { demoAssets } from "./templates/assets.js";
+import { sanityTemplates } from "./templates/sanity.js";
+import { contentfulTemplates } from "./templates/contentful.js";
+import { strapiTemplates } from "./templates/strapi.js";
+import { staticTemplates } from "./templates/static.js";
+function cmsTemplates(config) {
+    switch (config.cms) {
+        case "sanity": return sanityTemplates(config);
+        case "contentful": return contentfulTemplates(config);
+        case "strapi": return strapiTemplates(config);
+        case "none": return staticTemplates(config);
+    }
+}
+/**
+ * A whole project, not a patch to one.
+ *
+ * The distinction from `collectFiles` is what it is allowed to own. This path
+ * creates an empty directory and fills it, so it writes the package manifest,
+ * the Next config, the root layout and the stylesheet — files that in the
+ * integrate path belong to the host app and must not be touched.
+ *
+ * It also scaffolds `mode: "auto"`: one route file that decides published
+ * versus editor per request. That removes the proxy (or middleware), the
+ * second `preview-draft` route, and the class of failure where the two route
+ * files drift apart — at the cost of static rendering, which a local demo does
+ * not have and does not want.
+ */
+export function collectDemoFiles(config) {
+    return [
+        ...demoAppTemplates(config),
+        ...demoAssets(),
+        { path: "app/[[...slug]]/page.tsx", content: pageFile(config, "auto") },
+        { path: "app/not-found.tsx", content: notFoundFile() },
+        { path: "app/api/editor/[...path]/route.ts", content: editorApiRoute(config) },
+        { path: "lib/manifest.ts", content: manifestFile(config) },
+        ...cmsTemplates(config),
+    ];
+}
+/** Wiring for a Next.js app that already exists. Touches nothing it did not create. */
+export function collectFiles(config) {
+    const files = [];
+    files.push({ path: "app/api/editor/[...path]/route.ts", content: editorApiRoute(config) });
+    const revalidate = revalidateRoute(config);
+    if (revalidate)
+        files.push({ path: "app/api/revalidate/route.ts", content: revalidate });
+    files.push({ path: "lib/manifest.ts", content: manifestFile(config) });
+    files.push({ path: "app/[[...slug]]/page.tsx", content: pageFile(config, "static") });
+    files.push({ path: "app/preview-draft/[[...slug]]/page.tsx", content: pageFile(config, "preview") });
+    files.push({ path: "app/not-found.tsx", content: notFoundFile() });
+    // Next.js 16 renamed `middleware` to `proxy`; older majors keep middleware.ts.
+    files.push((config.nextMajor ?? 15) >= 16
+        ? { path: "proxy.ts", content: proxyFile() }
+        : { path: "middleware.ts", content: middlewareFile() });
+    files.push({ path: ".env.local.example", content: envExample(config) });
+    files.push(...cmsTemplates(config));
+    return files;
+}
+export async function generateFiles(cwd, files) {
+    const written = [];
+    const skipped = [];
+    // Create all unique directories upfront
+    const dirs = new Set(files.map((f) => dirname(join(cwd, f.path))));
+    await Promise.all([...dirs].map((d) => mkdir(d, { recursive: true })));
+    for (const file of files) {
+        const fullPath = join(cwd, file.path);
+        try {
+            // Never clobber, either way. The integrate path writes into somebody's
+            // repository, and a scaffolder that overwrites an existing route file is
+            // a scaffolder that destroys work. `wx` and `COPYFILE_EXCL` are the same
+            // promise for the two kinds of file.
+            if (file.source !== undefined) {
+                await copyFile(file.source, fullPath, constants.COPYFILE_EXCL);
+            }
+            else {
+                await writeFile(fullPath, file.content ?? "", { encoding: "utf-8", flag: "wx" });
+            }
+            written.push(file.path);
+        }
+        catch (err) {
+            if (err && typeof err === "object" && "code" in err && err.code === "EEXIST") {
+                skipped.push(file.path);
+                continue;
+            }
+            throw err;
+        }
+    }
+    return { written, skipped };
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};