@michaelthielemann/kestrel 4.1.3 → 5.0.0

package/scripts/typecheck.mjs

@@ -1,62 +0,0 @@
-// Typecheck gate. vitest/esbuild and `nuxt build` do NOT typecheck, so real type errors slip through
-// every other gate — this is the one that catches them. It typechecks the PLAYGROUND, which composes
-// the engine layers + both galleries extensions + a real consumer app/server, so this single run covers
-// app, `.vue`, modules, config AND server code.
-//
-// Two passes, because Nuxt 4 splits the tsconfig by environment:
-//   1. `tsc` over the Nitro server project (the app aggregator EXCLUDES server dirs).
-//   2. `vue-tsc` (via `nuxt typecheck`) over the app/`.vue`/modules/config aggregator.
-// Both exclude `*.test.ts` (vitest covers those at runtime) via the nuxt.config `typescript.tsConfig.exclude`
-// and the derived server config below.
-import { execFileSync } from 'node:child_process'
-import { readFileSync, writeFileSync } from 'node:fs'
-import { dirname, join } from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-const root = join(dirname(fileURLToPath(import.meta.url)), '..')
-const playground = join(root, 'playground')
-const bin = (name) => join(root, 'node_modules', '.bin', name)
-const env = { ...process.env, CI: 'true', NUXT_TELEMETRY_DISABLED: '1' }
-
-// 1. (Re)generate the Nuxt/Nitro tsconfigs for the playground.
-execFileSync(bin('nuxt'), ['prepare'], { cwd: playground, stdio: 'inherit', env })
-
-// 2. Server (Nitro) project — derive a test-excluding config alongside the generated one so its relative
-//    include/paths still resolve.
-const generated = join(playground, '.nuxt', 'tsconfig.server.json')
-const cfg = JSON.parse(readFileSync(generated, 'utf8'))
-cfg.exclude = [...(cfg.exclude ?? []), '../../**/*.test.ts', '../**/*.test.ts']
-const gateConfig = join(playground, '.nuxt', 'tsconfig.typecheck.json')
-writeFileSync(gateConfig, JSON.stringify(cfg, null, 2))
-// Both passes always run, and the gate fails at the END: aborting on the first one hides every error of
-// the other, and the two cover disjoint file sets — a red server pass would report zero app errors.
-const failed = []
-function pass(label, cmd, args) {
-  console.log(`› typechecking ${label}…`)
-  try {
-    execFileSync(bin(cmd), args, { cwd: playground, stdio: 'inherit', env })
-  } catch {
-    failed.push(label)
-  }
-}
-
-pass('server (Nitro) project', 'tsc', ['--noEmit', '-p', gateConfig])
-// 3. App / `.vue` / modules / config — vue-tsc via `nuxt typecheck` (needs the committed root tsconfig.json).
-pass('app + .vue (vue-tsc)', 'nuxt', ['typecheck'])
-
-// 4. Standalone workspace packages have their own tsconfig, outside the playground project. Globbed by
-// pnpm's own filter (topological order, every current and future `@michaelthielemann/kestrel-*` package, `create-kestrel`
-// excluded by name) rather than a hand-written list per package — the class of drift a hand list invites
-// (a package silently missing from this one script) is the exact failure mode this rail exists to avoid.
-console.log('› typechecking packages (@michaelthielemann/kestrel-*)…')
-try {
-  execFileSync('pnpm', ['--filter', '@michaelthielemann/kestrel-*', '-r', 'typecheck'], { cwd: root, stdio: 'inherit', env })
-} catch {
-  failed.push('packages (@michaelthielemann/kestrel-*)')
-}
-
-if (failed.length) {
-  console.error(`\n✗ typecheck failed: ${failed.join(', ')}`)
-  process.exit(1)
-}
-console.log('\n✓ typecheck passed (app + .vue + server; *.test.ts excluded)')

package/templates/starter/README.md

@@ -1,65 +0,0 @@
-# {{name}}
-
-A [Kestrel](https://github.com/MichaelThielemann/kestrel) site — a collection-driven CMS that renders
-published content to static HTML.
-
-```bash
-pnpm install
-pnpm dev
-```
-
-Admin: <http://localhost:3000/admin> — sign in with the password you chose while scaffolding.
-Forgot it? `pnpm hash-password` prints a fresh hash for `KESTREL_ADMIN_PASSWORD_HASH` in `.env`.
-
-## What is here
-
-| Path | What it does |
-| --- | --- |
-| `nuxt.config.ts` | Composes Kestrel (`extends`) and holds every non-secret setting under `kestrel: {}` |
-| `.env` | Session secret + admin password hash. **Never commit it** — `.env.example` is the committed copy |
-| `app/app.vue` | The app root. Keep `<NuxtLayout>` and `<NuxtPage />` or the admin stops rendering |
-| `app/layouts/default.vue` | Your public site frame — header, nav, footer |
-| `app/blocks/Prose.vue` | One block type for the page builder: schema and display in a single file |
-| `.data/` | The SQLite database, uploads and published output. Gitignored |
-
-## Add a collection
-
-Drop a file in `server/collections/`; the table is created on the next dev start and the collection
-shows up in the admin. Nothing to register.
-
-```ts
-// server/collections/posts.ts
-export default defineCollection({
-  name: 'posts',
-  mode: 'multi',
-  pageLike: true,          // gives records a `path` so they render to static HTML
-  status: true,            // draft / published
-  seo: true,
-  blocks: { enabled: true },
-  fields: { title: { type: 'text', required: true } },
-})
-```
-
-## Publish
-
-Run `pnpm dev` at least once first: the database schema is derived from your collections and created on
-a dev boot, and a production build never touches it. Generating against a database that does not exist
-yet succeeds but emits an empty site plus `no such table` errors.
-
-There are two ways to get static files out, and this project has **both** enabled:
-
-- **One-shot:** `pnpm generate` renders everything published into `.output/public/`.
-- **Incremental (the default at runtime):** a production run (`pnpm build && pnpm preview`) publishes on
-  boot and re-renders only the pages each content write affects, into `.data/published/`. Turn it off with
-  `kestrel: { output: { auto: false } }` in `nuxt.config.ts` if you only want the one-shot flow.
-
-Either way, serve the resulting directory from any static host. The editing origin is not meant to be
-public. Set `siteUrl` in `nuxt.config.ts` to the real public origin first — it is baked into canonical
-URLs, `sitemap.xml` and `llms.txt` at build time.
-
-## Health check
-
-`pnpm doctor` checks this project for the things that silently break a Kestrel site: a missing
-`extends`, an `app.vue` that renders no pages, unset auth env.
-
-Full documentation: <https://github.com/MichaelThielemann/kestrel#documentation>

package/templates/starter/_env.example

@@ -1,17 +0,0 @@
-# Auth/session is env-only — secrets never belong in a committed config file. `.env.example` is the
-# committed copy of this template; `.env` holds the real values and is gitignored.
-#
-# The two below are read per request. Every other KESTREL_* var is read once when the app is BUILT
-# (dev start / build / generate) and frozen into runtimeConfig — see docs/configuration.md.
-
-# Session signing secret, >= 32 bytes. Required in production. Generate: kestrel secret
-KESTREL_SESSION_SECRET=
-
-# Admin password hash. Without it /admin renders but sign-in answers 503. Generate: kestrel hash-password
-KESTREL_ADMIN_PASSWORD_HASH=
-
-# Drops the __Host- cookie prefix and the Secure flag. Plain-HTTP localhost ONLY; rejected in production.
-KESTREL_SECURE_COOKIES=false
-
-# Optional: session lifetime in seconds (default 604800 = 7 days)
-# KESTREL_SESSION_MAX_AGE=604800

package/templates/starter/_gitignore

@@ -1,26 +0,0 @@
-# Dependencies
-node_modules
-
-# Nuxt / Nitro build output
-.nuxt
-.nitro
-.cache
-.output
-dist
-
-# Secrets
-.env
-.env.*
-!.env.example
-
-# Runtime database, uploads and published output
-.data
-*.sqlite
-*.sqlite-shm
-*.sqlite-wal
-
-# Logs
-*.log
-
-# OS / editor
-.DS_Store

package/templates/starter/_package.json

@@ -1,22 +0,0 @@
-{
-  "name": "{{name}}",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
-    "preview": "nuxt preview",
-    "generate": "nuxt generate",
-    "typecheck": "nuxt prepare && nuxt typecheck && tsc -p .nuxt/tsconfig.server.json --noEmit",
-    "hash-password": "kestrel hash-password",
-    "doctor": "kestrel doctor"
-  },
-  "dependencies": {
-    "@michaelthielemann/kestrel": "{{version}}"
-  },
-  "devDependencies": {
-    "nuxt": "{{nuxtVersion}}",
-    "typescript": "{{typescriptVersion}}",
-    "vue-tsc": "{{vueTscVersion}}"
-  }
-}

package/templates/starter/app/app.vue

@@ -1,7 +0,0 @@
-<template>
-  <!-- Both wrappers are load-bearing: without <NuxtPage /> no route renders, without <NuxtLayout /> the
-       admin loses its shell. Delete this file to fall back to the one Kestrel ships. -->
-  <NuxtLayout>
-    <NuxtPage />
-  </NuxtLayout>
-</template>

package/templates/starter/app/blocks/Prose.vue

@@ -1,13 +0,0 @@
-<script setup lang="ts">
-// One SFC is one block type: the filename names it, defineProps is its schema. Add a sibling to add one.
-defineProps({
-  body: richtextField({ required: true }),
-})
-defineBlock({ label: { en: 'Prose' }, icon: 'file-text' })
-</script>
-
-<template>
-  <!-- richtext is sanitized server-side on write -->
-  <!-- eslint-disable-next-line vue/no-v-html -- sanitized via sanitizeRichtext (sanitize-html allowlist) in packages/kestrel-fields/src/server/field-registry/index.ts -->
-  <div class="block-prose" v-html="body" />
-</template>

package/templates/starter/app/layouts/default.vue

@@ -1,6 +0,0 @@
-<template>
-  <!-- The public site's frame. The admin uses its own layout and is unaffected by anything here. -->
-  <main>
-    <slot />
-  </main>
-</template>

package/templates/starter/nuxt.config.ts

@@ -1,23 +0,0 @@
-export default defineNuxtConfig({
-  compatibilityDate: '2026-06-02',
-  future: { compatibilityVersion: 4 },
-  // This one line composes the whole CMS. Opt-in extension layers go after it.
-  extends: ['@michaelthielemann/kestrel'],
-  // Not inherited from an extended layer, so it has to be repeated here.
-  typescript: { tsConfig: { compilerOptions: { noUncheckedIndexedAccess: false } } },
-  nitro: { typescript: { tsConfig: { compilerOptions: { noUncheckedIndexedAccess: false } } } },
-  // Auth/session is env-only, see `.env`. Every key here is optional.
-  kestrel: {
-    db: '.data/db.sqlite',
-    // Baked into canonical URLs, hreflang, sitemap.xml and llms.txt at build time. Set it to the public
-    // origin before the first real deploy — or leave it to KESTREL_SITE_URL per environment.
-    siteUrl: 'http://localhost:3000',
-    siteName: '{{name}}',
-    media: { uploadDir: '.data/uploads' },
-    // locales: ['en', 'de'],
-    // collections: { pages: false },
-    // Answer-engine extras, both off until you opt in: articleMeta publishes author/date/keywords,
-    // llmsFull serves /llms-full.txt (every published page's full body in one file).
-    // seo: { articleMeta: true, llmsFull: true },
-  },
-})

package/templates/starter/pnpm-workspace.yaml

@@ -1,8 +0,0 @@
-# pnpm blocks dependency build scripts unless they are listed here, and Kestrel's SQLite driver and image
-# pipeline are native — without this `pnpm install` completes but the app cannot start. Delete this file
-# if you use npm or yarn. (`pnpm.onlyBuiltDependencies` in package.json is silently ignored on pnpm 11.)
-allowBuilds:
-  '@parcel/watcher': true
-  better-sqlite3: true
-  esbuild: true
-  sharp: true

package/templates/starter/tsconfig.json

@@ -1,3 +0,0 @@
-{
-  "extends": "./.nuxt/tsconfig.json"
-}