@forumone/create-throughline 1.0.2-next-0ecb757 → 1.0.2-next-7b3e9c1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @forumone/create-throughline
 
-## 1.0.2-next-0ecb757
+## 1.0.2-next-7b3e9c1
 
 ### Patch Changes
 

package/README.md

@@ -1,6 +1,6 @@
 # @forumone/create-throughline
 
-Scaffolder for new Throughline projects (Payload CMS + MCP servers + Inngest workflows).
+Scaffolder for new Throughline projects: Payload CMS, the Throughline suite registered by one `throughline()` call and served over MCP at `/api/mcp`, and an Inngest endpoint for its jobs.
 
 ## Usage
 
@@ -14,28 +14,32 @@ Or with npm:
 npm create @forumone/throughline@latest my-client-site
 ```
 
-The scaffolder asks a small set of questions, then generates a ready-to-run
-pnpm monorepo with Payload, all Throughline plugins, and an Inngest endpoint
-already wired. After scaffolding you'll need to fill in environment variables,
-implement client-specific resolvers (users, groups, approvers), and replace
-the example content model with your own.
+The scaffolder asks a small set of questions, then generates a pnpm monorepo
+with Payload, `@forumone/throughline` and an Inngest endpoint already wired,
+plus CI and an agent `CLAUDE.md`. After scaffolding you'll need to fill in
+environment variables, create and apply the first migration, implement
+client-specific resolvers (users, groups, approvers), and replace the example
+content model with your own.
 
 ## What you get
 
 ```
 my-client-site/
 ├── apps/
-│   └── web/                 # Next.js + Payload with all plugins wired
-├── packages/
-│   ├── design-system/       # Reference DS (or placeholder for your own)
-│   ├── content/             # Client-specific collections & blocks
-│   └── brand/               # Brand tokens + email theme
+│   └── web/                 # Next.js + Payload, throughline() in payload.config.ts
+├── design-system/           # the reference design system, or a placeholder for your own
+├── scripts/                 # workspace gates: single instances, tested packages, audit
+├── .claude/                 # agent settings and a Stop-hook gate
+├── .github/                 # CI: fast and verify tiers
 ├── .env.example
+├── CLAUDE.md
 ├── pnpm-workspace.yaml
 ├── turbo.json
 └── README.md
 ```
 
+The full list is in the [reference](https://github.com/forumone/throughline/blob/main/docs/reference/create-throughline.md).
+
 ## After scaffolding
 
 Read the generated `README.md` for full setup instructions. Expect 1–2 hours

package/dist/templates/base/.env.example

@@ -35,9 +35,9 @@ APPROVAL_TOKEN_SECRET=
 
 # --- MCP ---
 # No keys here. Every Throughline tool is served on one /api/mcp by
-# @payloadcms/plugin-mcp; create a key in the admin under MCP -> Payload MCP
-# API Keys and give it to your MCP client, not to this file. Scheduled
-# publishes run in process and need no key either.
+# @payloadcms/plugin-mcp; create a key in the admin under MCP -> API Keys and
+# give it to your MCP client, not to this file. Scheduled publishes run in
+# process and need no key either.
 
 # --- Optional: error reporting ---
 # Where unhandled request errors, workflows that ran out of retries and failing
@@ -48,6 +48,7 @@ APPROVAL_TOKEN_SECRET=
 ERROR_WEBHOOK_URL=
 
 # --- Optional: storage ---
-# Vercel Blob token if deploying to Vercel; remove this and the storage
-# adapter from payload.config.ts if you're using a different provider.
+# payload.config.ts registers no storage adapter, so nothing reads this yet.
+# Set it when you add one: the Vercel Blob token, if you add
+# @payloadcms/storage-vercel-blob to deploy on Vercel.
 BLOB_READ_WRITE_TOKEN=

package/dist/templates/base/CLAUDE.md

@@ -21,10 +21,14 @@ pnpm install --frozen-lockfile \
   && pnpm typecheck && pnpm lint \
   && pnpm check:instances && pnpm check:tested && pnpm check:migrations \
   && pnpm validate \
+  && pnpm --filter ./design-system run --if-present build \
   && bash .github/scripts/check-generated.sh \
   && pnpm test
 ```
 
+`fast` then runs `pnpm check:audit`, which reports advisories without failing
+the job.
+
 `--frozen-lockfile` leads because a lockfile missing an entry passes every
 other gate locally and fails in CI. `check-generated.sh` needs the environment
 `payload.config.ts` validates; the placeholders at the top of
@@ -75,8 +79,8 @@ and demands `--confirm` before overwriting.
 
 ## The design system reaches the CMS through its manifest
 
-`payload.config.ts` hands the design system's manifest to `componentsPlugin`,
-and that manifest is how the CMS knows which components exist and how they may
+`payload.config.ts` hands the design system's manifest to the `components` key
+of its `throughline()` call, and that manifest is how the CMS knows which components exist and how they may
 be composed. It is built from a `<Name>.contract.ts` beside every component.
 {{#if useReferenceDs}}
 - **A new component needs a contract.** `build:manifest` refuses a component
@@ -86,8 +90,9 @@ be composed. It is built from a `<Name>.contract.ts` beside every component.
   that is not there.
 {{else}}
 The design system here is a placeholder. When you build it, give every
-component a contract, publish a manifest, and point `componentsPlugin` at it —
-see `@forumone/throughline-design-system` in the Throughline repository.
+component a contract, publish a manifest, and point `components.manifest` in
+`throughline()` at it — see `@forumone/throughline-design-system` in the
+Throughline repository.
 {{/if}}
 ## Tests
 
@@ -101,7 +106,7 @@ refused. A new collection fails it until you add it to a bucket. Decide which,
 and don't open a collection to anonymous reads to make the test pass. More good
 first tests need no database: field validations, and hooks as functions.
 
-`pnpm test:smoke` runs the Playwright smoke pack in `e2e/` against
+`pnpm --dir apps/web test:smoke` runs the Playwright smoke pack in `e2e/` against
 `next start`, so build first, or against a deployed site when `E2E_BASE_URL`
 is set. Every check is a GET. CI runs it in `verify`, after the production
 build. Add routes to `e2e/site.ts` as the site gains them.

package/dist/templates/base/README.md

@@ -2,7 +2,7 @@
 
 Generated by [`@forumone/create-throughline`](https://github.com/forumone/throughline/tree/main/packages/create-throughline).
 
-This is a Throughline project: a Payload CMS application wired with the Throughline plugin suite (audit, components, publishing, approvals, audit-query, integrations, email) plus an Inngest endpoint that runs the workflow functions.
+This is a Throughline project: a Payload CMS application with the Throughline suite registered by one `throughline()` call in `apps/web/src/payload.config.ts` (audit, components, publishing, approvals, audit queries, integrations, email and a healthcheck), its MCP tools served at `/api/mcp`, plus an Inngest endpoint that runs the suite's jobs.
 
 ## Prerequisites
 
@@ -21,7 +21,8 @@ pnpm install
 # 2. Copy the env template
 cp .env.example apps/web/.env.local   # apps/web: `next dev` reads env files from there
 
-# 3. Generate secrets (run each three times for the three secret slots)
+# 3. Generate the two secrets, PAYLOAD_SECRET and APPROVAL_TOKEN_SECRET (run it
+#    once for each)
 openssl rand -base64 48
 
 # 4. Edit apps/web/.env.local and fill in:
@@ -56,7 +57,7 @@ pnpm dev
 
 ## After admin signup
 
-1. In the Payload admin, open **MCP → Payload MCP API Keys** and create one key. Pick a **User** — required; the key inherits that user's access control — tick **Enable API Key**, save, and copy the key. It is shown once, and it does not go in `.env.local`.
+1. In the Payload admin, open **MCP → API Keys** and create one key. Only an admin can. The key is bound to you, its creator: it inherits your access control, and every tool logs you as the actor. Give it a **Label**, tick **Enable API Key**, save, and copy the key. It does not go in `.env.local`.
 
 2. **Plug it into Claude (or your MCP client).** One endpoint carries every server's tools:
 

package/dist/templates/with-reference-ds/design-system/README.md

@@ -22,7 +22,7 @@ pnpm --filter "./design-system" validate          # lint contracts + cross-check
 pnpm --filter "./design-system" test              # component tests (vitest + testing-library)
 ```
 
-The web app imports `./manifest` (the built `dist/manifest.json`) and feeds it to the Components MCP server. The root `pnpm dev` builds the design system first so the manifest exists.
+The web app imports `./manifest` (the built `dist/manifest.json`) and passes it to `components.manifest` in the `throughline()` call in `apps/web/src/payload.config.ts`, which serves it over MCP. The root `pnpm dev` builds the design system first so the manifest exists.
 
 ## Branding
 

package/dist/templates/without-reference-ds/design-system/README.md

@@ -17,4 +17,4 @@ pnpm --filter "./design-system" build-storybook   # static Storybook
 pnpm --filter "./design-system" typecheck
 ```
 
-Point the Components MCP server at your manifest in `apps/web/src/payload.config.ts` (`componentsPlugin({ manifest })`) once you generate one. For a worked starting point, re-scaffold with the reference design system.
+Point `components.manifest` in the `throughline()` call in `apps/web/src/payload.config.ts` at your manifest once you generate one; until then it names a placeholder URL. For a worked starting point, re-scaffold with the reference design system.

package/dist/versions.json

@@ -1,4 +1,4 @@
 {
-  "@forumone/throughline-design-system": "1.0.2-next-0ecb757",
-  "@forumone/throughline": "1.0.2-next-0ecb757"
+  "@forumone/throughline-design-system": "1.0.2-next-7b3e9c1",
+  "@forumone/throughline": "1.0.2-next-7b3e9c1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@forumone/create-throughline",
-  "version": "1.0.2-next-0ecb757",
-  "description": "Scaffolder for new Throughline projects (Payload CMS + MCP servers + Inngest workflows).",
+  "version": "1.0.2-next-7b3e9c1",
+  "description": "Scaffolder for new Throughline projects: Payload CMS with the Throughline suite, served over MCP, and its jobs on Inngest.",
   "type": "module",
   "bin": {
     "create-throughline": "./dist/bin.js"