create-shapio 0.3.0 → 0.4.0

package/dist/index.js

@@ -75,6 +75,10 @@ export const config = defineConfig({
   // ['star-rating.js']. The admin loads them at runtime; installing one is a file copy plus a restart.
   editors: [],
 
+  // Admin colour themes, listed after the built-in ones. Each variant sets every UI token; see
+  // documentation/extensions.md (Admin themes) and examples/extension/extensions/sepiaTheme.ts.
+  // themes: [{ key: 'acme', name: 'Acme', dark: { background: '#101014', foreground: '#f4f4f5', ... } }],
+
   // Custom Fastify routes, mounted at /api/ext/<prefix>. Mutating routes must declare config.audit.
   // routes: [{ prefix: 'acme', plugin: async (app) => { app.get('/ping', async () => ({ ok: true })); } }],
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/templates.ts","../src/scaffold.ts","../src/starters.ts","../src/site.ts","../src/main.ts","../src/index.ts"],"sourcesContent":["export type TemplateInput = {\n  projectName: string;\n  shapioSpec: string;\n  databaseUrl: string;\n  sessionSecret: string;\n};\n\nconst packageJson = ({ projectName, shapioSpec }: TemplateInput) =>\n  `${JSON.stringify(\n    {\n      name: projectName,\n      private: true,\n      type: 'module',\n      engines: { node: '>=24' },\n      scripts: {\n        start: 'shapio start',\n        migrate: 'shapio migrate',\n        worker: 'shapio worker',\n        status: 'shapio status',\n      },\n      dependencies: { '@shapio/cms': shapioSpec },\n    },\n    null,\n    2,\n  )}\\n`;\n\nconst env = ({ databaseUrl, sessionSecret }: TemplateInput) =>\n  [\n    '# Shapio configuration. Every setting is an environment variable; the `shapio` command loads this file.',\n    '# Real environment variables override values here.',\n    'NODE_ENV=production',\n    'HOST=127.0.0.1',\n    'PORT=4300',\n    'LOG_LEVEL=info',\n    '',\n    '# The origin people reach Shapio at; every absolute URL is built from it. Change it when you deploy.',\n    'PUBLIC_URL=http://localhost:4300',\n    '# BASE_PATH=/cms',\n    '',\n    '# HTTPS without a reverse proxy: set PUBLIC_URL=https://your.domain and PORT=443, and point these at your',\n    '# certificate and key (PEM). Renewed files are picked up without a restart. HTTP_PORT=80 redirects to HTTPS.',\n    '# TLS_CERT_FILE=/etc/shapio/tls/fullchain.pem',\n    '# TLS_KEY_FILE=/etc/shapio/tls/privkey.pem',\n    '# HTTP_PORT=80',\n    '',\n    '# PostgreSQL >= 16, or sqlite:<path> for a single-process install',\n    `DATABASE_URL=${databaseUrl}`,\n    'MIGRATE_ON_START=true',\n    '',\n    '# Signs preview links, private-media URLs and app-user tokens, and encrypts stored secrets.',\n    '# Generated for this project; keep it secret, and back it up with the database.',\n    `SESSION_SECRET=${sessionSecret}`,\n    '',\n    '# SETUP_REQUIRE_TOKEN=true  # require the logged one-time token for first-run setup (for installs exposed before setup)',\n    '',\n    '# inline: jobs run inside the server process. dedicated: run `npm run worker` as a second process.',\n    'WORKER_MODE=inline',\n    '',\n    'MEDIA_PATH=./media',\n    '',\n  ].join('\\n');\n\nconst shapioConfig =\n  () => `// Project configuration for Shapio: code extensions (hooks, custom routes, services, jobs) and custom\n// field editors. Content models are NOT configured here; they are created live in the admin UI and synced\n// with \\`shapio schema pull\\` / \\`shapio schema apply\\`. This file is code: changing it, or anything in\n// ./extensions, needs a restart (never a rebuild). Check it with \\`npx shapio extensions check\\`.\n// TypeScript works as is (erasable syntax only: no enums or namespaces). Guide: documentation/extensions.md in Shapio's repository.\nimport { defineConfig } from '@shapio/cms/config';\n\nexport const config = defineConfig({\n  // Lifecycle hooks by model API ID ('*' = every model). before* hooks run inside the write's transaction\n  // and may reject it (422 HOOK_REJECTED); after* hooks run after commit, as retried jobs.\n  hooks: {\n    // article: {\n    //   beforePublish: ({ data, reject }) => {\n    //     if (!data?.cover) reject('An article needs a cover image');\n    //   },\n    // },\n  },\n\n  // Custom React field editors: file names of ES modules built into ./extensions/editors/, e.g.\n  // ['star-rating.js']. The admin loads them at runtime; installing one is a file copy plus a restart.\n  editors: [],\n\n  // Custom Fastify routes, mounted at /api/ext/<prefix>. Mutating routes must declare config.audit.\n  // routes: [{ prefix: 'acme', plugin: async (app) => { app.get('/ping', async () => ({ ok: true })); } }],\n\n  // Services constructed once at startup and shared by hooks, routes and jobs.\n  // services: { stats: ({ services }) => ({ articles: () => services.content.count('article') }) },\n\n  // Background jobs, registered as ext.<name>; enqueue with services.jobs.enqueue('<name>', payload).\n  // jobs: { nightlyReport: async ({ services, logger }) => { logger.info('report'); } },\n});\n`;\n\nconst gitignore = () => `node_modules/\n.env\nmedia/*\n!media/.gitkeep\n`;\n\nconst pm2Ecosystem = ({ projectName }: TemplateInput) => `// PM2 process file: pm2 start ecosystem.config.cjs\n// One instance in fork mode, the simplest setup. Several instances on one database are supported too: use the\n// cluster variant below.\nmodule.exports = {\n  apps: [\n    {\n      name: ${JSON.stringify(projectName)},\n      script: 'node_modules/@shapio/cms/dist/cli.js',\n      args: 'start',\n      exec_mode: 'fork',\n      instances: 1,\n      kill_timeout: 20000,\n      env: { NODE_ENV: 'production' },\n    },\n    // Cluster variant (replace the app above): two processes sharing the port, each with its inline worker.\n    // { name: ${JSON.stringify(projectName)}, script: 'node_modules/@shapio/cms/dist/cli.js', args: 'start', exec_mode: 'cluster', instances: 2, kill_timeout: 20000, env: { NODE_ENV: 'production' } },\n  ],\n};\n`;\n\nconst readme = ({ projectName }: TemplateInput) =>\n  `# ${projectName}\n\nA [Shapio](https://github.com/mybrokengnome/shapio) project.\n\n1. Set \\`DATABASE_URL\\` in \\`.env\\` to a PostgreSQL (>= 16) database, or to \\`sqlite:<path>\\` for a\n   single-process install.\n2. \\`npm run start\\`. Migrations run on start. The first boot logs where to create the owner account: open\n   \\`/admin/\\`; the first person to complete Setup becomes the owner.\n3. Under PM2: \\`pm2 start ecosystem.config.cjs\\`.\n\nContent models are edited live in the admin; no restart is needed for modelling. Changing \\`shapio.config.ts\\`\nor \\`extensions/\\` (code) needs a restart; \\`npx shapio extensions check\\` validates them.\n`;\n\n/** Files to write, relative to the project directory. */\nexport const renderTemplates = (input: TemplateInput): ReadonlyArray<[path: string, content: string]> => [\n  ['package.json', packageJson(input)],\n  ['.env', env(input)],\n  [\n    '.env.example',\n    env({ ...input, databaseUrl: 'postgres://user:password@localhost:5432/shapio', sessionSecret: '' }),\n  ],\n  ['shapio.config.ts', shapioConfig()],\n  ['.gitignore', gitignore()],\n  ['ecosystem.config.cjs', pm2Ecosystem(input)],\n  ['README.md', readme(input)],\n  ['extensions/.gitkeep', ''],\n  ['extensions/editors/.gitkeep', ''],\n  ['media/.gitkeep', ''],\n];\n","import { randomBytes } from 'node:crypto';\nimport { existsSync, mkdirSync, readdirSync, writeFileSync } from 'node:fs';\nimport { basename, dirname, join, resolve } from 'node:path';\nimport { renderTemplates } from './templates.js';\n\nexport type ScaffoldOptions = {\n  directory: string;\n  shapioSpec: string;\n  databaseUrl?: string;\n};\n\nexport class ScaffoldError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'ScaffoldError';\n  }\n}\n\n/** npm package names: lowercase, URL-safe. Derived from the directory name. */\nexport const toPackageName = (directory: string): string =>\n  basename(resolve(directory))\n    .toLowerCase()\n    .replace(/[^a-z0-9._-]+/g, '-')\n    .replace(/^[._-]+|[-.]+$/g, '') || 'shapio-project';\n\n/** Writes the project files. Refuses to touch a non-empty directory. Returns the absolute project path. */\nexport const scaffoldProject = ({ directory, shapioSpec, databaseUrl }: ScaffoldOptions): string => {\n  const root = resolve(directory);\n  if (existsSync(root) && readdirSync(root).length > 0) {\n    throw new ScaffoldError(`${root} exists and is not empty`);\n  }\n  const projectName = toPackageName(root);\n  const files = renderTemplates({\n    projectName,\n    shapioSpec,\n    databaseUrl:\n      databaseUrl ?? `postgres://postgres:postgres@localhost:5432/${projectName.replace(/[^a-z0-9_]/g, '_')}`,\n    sessionSecret: randomBytes(32).toString('base64url'),\n  });\n  for (const [path, content] of files) {\n    const target = join(root, path);\n    mkdirSync(dirname(target), { recursive: true });\n    writeFileSync(target, content, { flag: 'wx' });\n  }\n  return root;\n};\n","/** The site starters `create-shapio --site` scaffolds (examples/<name> in the repository). */\nexport const SITE_STARTERS = ['astro', 'next', 'sveltekit'] as const;\n\nexport type SiteStarter = (typeof SITE_STARTERS)[number];\n\nexport const isSiteStarter = (value: string): value is SiteStarter =>\n  (SITE_STARTERS as readonly string[]).includes(value);\n\n/** npm leaves `.gitignore` out of published packages, so templates carry it under this name. */\nexport const PACKED_GITIGNORE = 'gitignore';\n","import { cpSync, existsSync, readdirSync, readFileSync, renameSync, writeFileSync } from 'node:fs';\nimport { join, resolve } from 'node:path';\nimport { ScaffoldError, toPackageName } from './scaffold.js';\nimport { PACKED_GITIGNORE, type SiteStarter } from './starters.js';\n\nexport type ScaffoldSiteOptions = {\n  directory: string;\n  site: SiteStarter;\n  /** The packed templates (templates/ next to dist/ in the published package). */\n  templatesDir: string;\n};\n\n/**\n * Writes a standalone site project from a starter template: the framework app, the blog's model files in\n * shapio/, and the seed and smoke scripts. Refuses to touch a non-empty directory. Returns the project path.\n */\nexport const scaffoldSite = ({ directory, site, templatesDir }: ScaffoldSiteOptions): string => {\n  const root = resolve(directory);\n  if (existsSync(root) && readdirSync(root).length > 0) {\n    throw new ScaffoldError(`${root} exists and is not empty`);\n  }\n  const template = join(templatesDir, site);\n  if (!existsSync(join(template, 'package.json'))) {\n    throw new ScaffoldError(\n      `The ${site} template is missing from ${templatesDir}; build create-shapio first`,\n    );\n  }\n  cpSync(template, root, { recursive: true });\n  if (existsSync(join(root, PACKED_GITIGNORE))) {\n    renameSync(join(root, PACKED_GITIGNORE), join(root, '.gitignore'));\n  }\n  const packagePath = join(root, 'package.json');\n  const packageJson = JSON.parse(readFileSync(packagePath, 'utf8')) as Record<string, unknown>;\n  writeFileSync(\n    packagePath,\n    `${JSON.stringify({ ...packageJson, name: toPackageName(root), version: '0.1.0' }, null, 2)}\\n`,\n  );\n  return root;\n};\n","import { spawnSync } from 'node:child_process';\nimport { readFileSync } from 'node:fs';\nimport { fileURLToPath } from 'node:url';\nimport { parseArgs } from 'node:util';\nimport { scaffoldProject, ScaffoldError } from './scaffold.js';\nimport { scaffoldSite } from './site.js';\nimport { isSiteStarter, SITE_STARTERS, type SiteStarter } from './starters.js';\n\nconst USAGE = `Usage: npx create-shapio <directory> [options]\n\nWithout --site: a Shapio project (the CMS server). With --site: a website that reads content from Shapio.\n\nOptions:\n  --site <${SITE_STARTERS.join('|')}>  Create a site starter instead (a blog: pages, articles, authors)\n  --database-url <url>   Database URL to put in .env (PostgreSQL, or sqlite:<path> for a single-process\n                         install; CMS project only)\n  --shapio-spec <spec>   Dependency spec for shapio (default: ^<this version>; a tarball path works too)\n  --no-install           Skip npm install\n  -h, --help             Show this help\n`;\n\n/** Packed from the repository's examples/ when create-shapio is built (templates/ beside dist/). */\nconst TEMPLATES_DIR = fileURLToPath(new URL('../templates/', import.meta.url));\n\nconst ownVersion = (): string => {\n  const packageJson = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')) as {\n    version: string;\n  };\n  return packageJson.version;\n};\n\ntype Output = { out: (text: string) => void; err: (text: string) => void };\n\n/** Returns the exit code. */\nexport const main = (argv: readonly string[], { out, err }: Output): number => {\n  const { values, positionals } = parseArgs({\n    args: [...argv],\n    allowPositionals: true,\n    allowNegative: true,\n    options: {\n      'database-url': { type: 'string' },\n      'shapio-spec': { type: 'string' },\n      site: { type: 'string' },\n      install: { type: 'boolean', default: true },\n      help: { type: 'boolean', short: 'h' },\n    },\n  });\n  const [directory] = positionals;\n  if (values.help || !directory) {\n    (directory ? out : err)(USAGE);\n    return values.help ? 0 : 1;\n  }\n  const site = values.site;\n  if (site !== undefined && !isSiteStarter(site)) {\n    err(`create-shapio: --site must be one of ${SITE_STARTERS.join(', ')}\\n`);\n    return 1;\n  }\n  if (site !== undefined && (values['database-url'] || values['shapio-spec'])) {\n    err('create-shapio: --database-url and --shapio-spec are for a CMS project, not --site\\n');\n    return 1;\n  }\n  let root: string;\n  try {\n    root = site\n      ? scaffoldSite({ directory, site, templatesDir: TEMPLATES_DIR })\n      : scaffoldProject({\n          directory,\n          shapioSpec: values['shapio-spec'] ?? `^${ownVersion()}`,\n          ...(values['database-url'] ? { databaseUrl: values['database-url'] } : {}),\n        });\n  } catch (error) {\n    if (error instanceof ScaffoldError) {\n      err(`create-shapio: ${error.message}\\n`);\n      return 1;\n    }\n    throw error;\n  }\n  out(`Created a ${site ? `${site} site` : 'Shapio project'} in ${root}\\n`);\n  if (values.install) {\n    out('Installing dependencies with npm...\\n');\n    const result = spawnSync('npm', ['install'], { cwd: root, stdio: 'inherit' });\n    if (result.status !== 0) {\n      err('create-shapio: npm install failed; run it yourself in the project directory\\n');\n      return 1;\n    }\n  }\n  out(\n    site\n      ? siteNextSteps(directory, site)\n      : `\\nNext:\\n  cd ${directory}\\n  edit .env (DATABASE_URL)\\n  npm run start\\n`,\n  );\n  return 0;\n};\n\nconst SERVE_COMMAND: Record<SiteStarter, string> = {\n  astro: 'npm run preview',\n  next: 'npm run start',\n  sveltekit: 'npm run preview',\n};\n\nconst siteNextSteps = (directory: string, site: SiteStarter) =>\n  [\n    '',\n    'Next (with a running Shapio; README.md has the details):',\n    `  cd ${directory}`,\n    '  SHAPIO_URL=http://localhost:4300 SHAPIO_ADMIN_EMAIL=you@example.com SHAPIO_ADMIN_PASSWORD=... npm run seed',\n    '  npm run build',\n    `  ${SERVE_COMMAND[site]}`,\n    '',\n  ].join('\\n');\n","#!/usr/bin/env node\nimport { main } from './main.js';\n\nprocess.exitCode = main(process.argv.slice(2), {\n  out: (text) => process.stdout.write(text),\n  err: (text) => process.stderr.write(text),\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,eAAe,EAAE,aAAa,iBAClC,GAAG,KAAK,UACN;CACE,MAAM;CACN,SAAS;CACT,MAAM;CACN,SAAS,EAAE,MAAM,OAAO;CACxB,SAAS;EACP,OAAO;EACP,SAAS;EACT,QAAQ;EACR,QAAQ;CACV;CACA,cAAc,EAAE,eAAe,WAAW;AAC5C,GACA,MACA,CACF,EAAE;AAEJ,MAAM,OAAO,EAAE,aAAa,oBAC1B;CACE;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA,gBAAgB;CAChB;CACA;CACA;CACA;CACA,kBAAkB;CAClB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC,CAAC,KAAK,IAAI;AAEb,MAAM,qBACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCR,MAAM,kBAAkB;;;;;AAMxB,MAAM,gBAAgB,EAAE,kBAAiC;;;;;;cAM3C,KAAK,UAAU,WAAW,EAAE;;;;;;;;;iBASzB,KAAK,UAAU,WAAW,EAAE;;;;AAK7C,MAAM,UAAU,EAAE,kBAChB,KAAK,YAAY;;;;;;;;;;;;;;AAenB,MAAa,mBAAmB,UAAyE;CACvG,CAAC,gBAAgB,YAAY,KAAK,CAAC;CACnC,CAAC,QAAQ,IAAI,KAAK,CAAC;CACnB,CACE,gBACA,IAAI;EAAE,GAAG;EAAO,aAAa;EAAkD,eAAe;CAAG,CAAC,CACpG;CACA,CAAC,oBAAoB,aAAa,CAAC;CACnC,CAAC,cAAc,UAAU,CAAC;CAC1B,CAAC,wBAAwB,aAAa,KAAK,CAAC;CAC5C,CAAC,aAAa,OAAO,KAAK,CAAC;CAC3B,CAAC,uBAAuB,EAAE;CAC1B,CAAC,+BAA+B,EAAE;CAClC,CAAC,kBAAkB,EAAE;AACvB;;;AC7IA,IAAa,gBAAb,cAAmC,MAAM;CACvC,YAAY,SAAiB;EAC3B,MAAM,OAAO;EACb,KAAK,OAAO;CACd;AACF;;AAGA,MAAa,iBAAiB,cAC5B,SAAS,QAAQ,SAAS,CAAC,CAAC,CACzB,YAAY,CAAC,CACb,QAAQ,kBAAkB,GAAG,CAAC,CAC9B,QAAQ,mBAAmB,EAAE,KAAK;;AAGvC,MAAa,mBAAmB,EAAE,WAAW,YAAY,kBAA2C;CAClG,MAAM,OAAO,QAAQ,SAAS;CAC9B,IAAI,WAAW,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,SAAS,GACjD,MAAM,IAAI,cAAc,GAAG,KAAK,yBAAyB;CAE3D,MAAM,cAAc,cAAc,IAAI;CACtC,MAAM,QAAQ,gBAAgB;EAC5B;EACA;EACA,aACE,eAAe,+CAA+C,YAAY,QAAQ,eAAe,GAAG;EACtG,eAAe,YAAY,EAAE,CAAC,CAAC,SAAS,WAAW;CACrD,CAAC;CACD,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO;EACnC,MAAM,SAAS,KAAK,MAAM,IAAI;EAC9B,UAAU,QAAQ,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;EAC9C,cAAc,QAAQ,SAAS,EAAE,MAAM,KAAK,CAAC;CAC/C;CACA,OAAO;AACT;;;;AC5CA,MAAa,gBAAgB;CAAC;CAAS;CAAQ;AAAW;AAI1D,MAAa,iBAAiB,UAC3B,cAAoC,SAAS,KAAK;;AAGrD,MAAa,mBAAmB;;;;;;;ACOhC,MAAa,gBAAgB,EAAE,WAAW,MAAM,mBAAgD;CAC9F,MAAM,OAAO,QAAQ,SAAS;CAC9B,IAAI,WAAW,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,SAAS,GACjD,MAAM,IAAI,cAAc,GAAG,KAAK,yBAAyB;CAE3D,MAAM,WAAW,KAAK,cAAc,IAAI;CACxC,IAAI,CAAC,WAAW,KAAK,UAAU,cAAc,CAAC,GAC5C,MAAM,IAAI,cACR,OAAO,KAAK,4BAA4B,aAAa,4BACvD;CAEF,OAAO,UAAU,MAAM,EAAE,WAAW,KAAK,CAAC;CAC1C,IAAI,WAAW,KAAK,MAAA,WAAsB,CAAC,GACzC,WAAW,KAAK,MAAM,gBAAgB,GAAG,KAAK,MAAM,YAAY,CAAC;CAEnE,MAAM,cAAc,KAAK,MAAM,cAAc;CAC7C,MAAM,cAAc,KAAK,MAAM,aAAa,aAAa,MAAM,CAAC;CAChE,cACE,aACA,GAAG,KAAK,UAAU;EAAE,GAAG;EAAa,MAAM,cAAc,IAAI;EAAG,SAAS;CAAQ,GAAG,MAAM,CAAC,EAAE,GAC9F;CACA,OAAO;AACT;;;AC9BA,MAAM,QAAQ;;;;;YAKF,cAAc,KAAK,GAAG,EAAE;;;;;;;;AASpC,MAAM,gBAAgB,cAAc,IAAI,IAAI,iBAAiB,YAAY,GAAG,CAAC;AAE7E,MAAM,mBAA2B;CAI/B,OAHoB,KAAK,MAAM,aAAa,IAAI,IAAI,mBAAmB,YAAY,GAAG,GAAG,MAAM,CAG9E,CAAC,CAAC;AACrB;;AAKA,MAAa,QAAQ,MAAyB,EAAE,KAAK,UAA0B;CAC7E,MAAM,EAAE,QAAQ,gBAAgB,UAAU;EACxC,MAAM,CAAC,GAAG,IAAI;EACd,kBAAkB;EAClB,eAAe;EACf,SAAS;GACP,gBAAgB,EAAE,MAAM,SAAS;GACjC,eAAe,EAAE,MAAM,SAAS;GAChC,MAAM,EAAE,MAAM,SAAS;GACvB,SAAS;IAAE,MAAM;IAAW,SAAS;GAAK;GAC1C,MAAM;IAAE,MAAM;IAAW,OAAO;GAAI;EACtC;CACF,CAAC;CACD,MAAM,CAAC,aAAa;CACpB,IAAI,OAAO,QAAQ,CAAC,WAAW;EAC7B,CAAC,YAAY,MAAM,IAAA,CAAK,KAAK;EAC7B,OAAO,OAAO,OAAO,IAAI;CAC3B;CACA,MAAM,OAAO,OAAO;CACpB,IAAI,SAAS,KAAA,KAAa,CAAC,cAAc,IAAI,GAAG;EAC9C,IAAI,wCAAwC,cAAc,KAAK,IAAI,EAAE,GAAG;EACxE,OAAO;CACT;CACA,IAAI,SAAS,KAAA,MAAc,OAAO,mBAAmB,OAAO,iBAAiB;EAC3E,IAAI,qFAAqF;EACzF,OAAO;CACT;CACA,IAAI;CACJ,IAAI;EACF,OAAO,OACH,aAAa;GAAE;GAAW;GAAM,cAAc;EAAc,CAAC,IAC7D,gBAAgB;GACd;GACA,YAAY,OAAO,kBAAkB,IAAI,WAAW;GACpD,GAAI,OAAO,kBAAkB,EAAE,aAAa,OAAO,gBAAgB,IAAI,CAAC;EAC1E,CAAC;CACP,SAAS,OAAO;EACd,IAAI,iBAAiB,eAAe;GAClC,IAAI,kBAAkB,MAAM,QAAQ,GAAG;GACvC,OAAO;EACT;EACA,MAAM;CACR;CACA,IAAI,aAAa,OAAO,GAAG,KAAK,SAAS,iBAAiB,MAAM,KAAK,GAAG;CACxE,IAAI,OAAO,SAAS;EAClB,IAAI,uCAAuC;EAE3C,IADe,UAAU,OAAO,CAAC,SAAS,GAAG;GAAE,KAAK;GAAM,OAAO;EAAU,CAClE,CAAC,CAAC,WAAW,GAAG;GACvB,IAAI,+EAA+E;GACnF,OAAO;EACT;CACF;CACA,IACE,OACI,cAAc,WAAW,IAAI,IAC7B,iBAAiB,UAAU,gDACjC;CACA,OAAO;AACT;AAEA,MAAM,gBAA6C;CACjD,OAAO;CACP,MAAM;CACN,WAAW;AACb;AAEA,MAAM,iBAAiB,WAAmB,SACxC;CACE;CACA;CACA,QAAQ;CACR;CACA;CACA,KAAK,cAAc;CACnB;AACF,CAAC,CAAC,KAAK,IAAI;;;AC1Gb,QAAQ,WAAW,KAAK,QAAQ,KAAK,MAAM,CAAC,GAAG;CAC7C,MAAM,SAAS,QAAQ,OAAO,MAAM,IAAI;CACxC,MAAM,SAAS,QAAQ,OAAO,MAAM,IAAI;AAC1C,CAAC"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/templates.ts","../src/scaffold.ts","../src/starters.ts","../src/site.ts","../src/main.ts","../src/index.ts"],"sourcesContent":["export type TemplateInput = {\n  projectName: string;\n  shapioSpec: string;\n  databaseUrl: string;\n  sessionSecret: string;\n};\n\nconst packageJson = ({ projectName, shapioSpec }: TemplateInput) =>\n  `${JSON.stringify(\n    {\n      name: projectName,\n      private: true,\n      type: 'module',\n      engines: { node: '>=24' },\n      scripts: {\n        start: 'shapio start',\n        migrate: 'shapio migrate',\n        worker: 'shapio worker',\n        status: 'shapio status',\n      },\n      dependencies: { '@shapio/cms': shapioSpec },\n    },\n    null,\n    2,\n  )}\\n`;\n\nconst env = ({ databaseUrl, sessionSecret }: TemplateInput) =>\n  [\n    '# Shapio configuration. Every setting is an environment variable; the `shapio` command loads this file.',\n    '# Real environment variables override values here.',\n    'NODE_ENV=production',\n    'HOST=127.0.0.1',\n    'PORT=4300',\n    'LOG_LEVEL=info',\n    '',\n    '# The origin people reach Shapio at; every absolute URL is built from it. Change it when you deploy.',\n    'PUBLIC_URL=http://localhost:4300',\n    '# BASE_PATH=/cms',\n    '',\n    '# HTTPS without a reverse proxy: set PUBLIC_URL=https://your.domain and PORT=443, and point these at your',\n    '# certificate and key (PEM). Renewed files are picked up without a restart. HTTP_PORT=80 redirects to HTTPS.',\n    '# TLS_CERT_FILE=/etc/shapio/tls/fullchain.pem',\n    '# TLS_KEY_FILE=/etc/shapio/tls/privkey.pem',\n    '# HTTP_PORT=80',\n    '',\n    '# PostgreSQL >= 16, or sqlite:<path> for a single-process install',\n    `DATABASE_URL=${databaseUrl}`,\n    'MIGRATE_ON_START=true',\n    '',\n    '# Signs preview links, private-media URLs and app-user tokens, and encrypts stored secrets.',\n    '# Generated for this project; keep it secret, and back it up with the database.',\n    `SESSION_SECRET=${sessionSecret}`,\n    '',\n    '# SETUP_REQUIRE_TOKEN=true  # require the logged one-time token for first-run setup (for installs exposed before setup)',\n    '',\n    '# inline: jobs run inside the server process. dedicated: run `npm run worker` as a second process.',\n    'WORKER_MODE=inline',\n    '',\n    'MEDIA_PATH=./media',\n    '',\n  ].join('\\n');\n\nconst shapioConfig =\n  () => `// Project configuration for Shapio: code extensions (hooks, custom routes, services, jobs) and custom\n// field editors. Content models are NOT configured here; they are created live in the admin UI and synced\n// with \\`shapio schema pull\\` / \\`shapio schema apply\\`. This file is code: changing it, or anything in\n// ./extensions, needs a restart (never a rebuild). Check it with \\`npx shapio extensions check\\`.\n// TypeScript works as is (erasable syntax only: no enums or namespaces). Guide: documentation/extensions.md in Shapio's repository.\nimport { defineConfig } from '@shapio/cms/config';\n\nexport const config = defineConfig({\n  // Lifecycle hooks by model API ID ('*' = every model). before* hooks run inside the write's transaction\n  // and may reject it (422 HOOK_REJECTED); after* hooks run after commit, as retried jobs.\n  hooks: {\n    // article: {\n    //   beforePublish: ({ data, reject }) => {\n    //     if (!data?.cover) reject('An article needs a cover image');\n    //   },\n    // },\n  },\n\n  // Custom React field editors: file names of ES modules built into ./extensions/editors/, e.g.\n  // ['star-rating.js']. The admin loads them at runtime; installing one is a file copy plus a restart.\n  editors: [],\n\n  // Admin colour themes, listed after the built-in ones. Each variant sets every UI token; see\n  // documentation/extensions.md (Admin themes) and examples/extension/extensions/sepiaTheme.ts.\n  // themes: [{ key: 'acme', name: 'Acme', dark: { background: '#101014', foreground: '#f4f4f5', ... } }],\n\n  // Custom Fastify routes, mounted at /api/ext/<prefix>. Mutating routes must declare config.audit.\n  // routes: [{ prefix: 'acme', plugin: async (app) => { app.get('/ping', async () => ({ ok: true })); } }],\n\n  // Services constructed once at startup and shared by hooks, routes and jobs.\n  // services: { stats: ({ services }) => ({ articles: () => services.content.count('article') }) },\n\n  // Background jobs, registered as ext.<name>; enqueue with services.jobs.enqueue('<name>', payload).\n  // jobs: { nightlyReport: async ({ services, logger }) => { logger.info('report'); } },\n});\n`;\n\nconst gitignore = () => `node_modules/\n.env\nmedia/*\n!media/.gitkeep\n`;\n\nconst pm2Ecosystem = ({ projectName }: TemplateInput) => `// PM2 process file: pm2 start ecosystem.config.cjs\n// One instance in fork mode, the simplest setup. Several instances on one database are supported too: use the\n// cluster variant below.\nmodule.exports = {\n  apps: [\n    {\n      name: ${JSON.stringify(projectName)},\n      script: 'node_modules/@shapio/cms/dist/cli.js',\n      args: 'start',\n      exec_mode: 'fork',\n      instances: 1,\n      kill_timeout: 20000,\n      env: { NODE_ENV: 'production' },\n    },\n    // Cluster variant (replace the app above): two processes sharing the port, each with its inline worker.\n    // { name: ${JSON.stringify(projectName)}, script: 'node_modules/@shapio/cms/dist/cli.js', args: 'start', exec_mode: 'cluster', instances: 2, kill_timeout: 20000, env: { NODE_ENV: 'production' } },\n  ],\n};\n`;\n\nconst readme = ({ projectName }: TemplateInput) =>\n  `# ${projectName}\n\nA [Shapio](https://github.com/mybrokengnome/shapio) project.\n\n1. Set \\`DATABASE_URL\\` in \\`.env\\` to a PostgreSQL (>= 16) database, or to \\`sqlite:<path>\\` for a\n   single-process install.\n2. \\`npm run start\\`. Migrations run on start. The first boot logs where to create the owner account: open\n   \\`/admin/\\`; the first person to complete Setup becomes the owner.\n3. Under PM2: \\`pm2 start ecosystem.config.cjs\\`.\n\nContent models are edited live in the admin; no restart is needed for modelling. Changing \\`shapio.config.ts\\`\nor \\`extensions/\\` (code) needs a restart; \\`npx shapio extensions check\\` validates them.\n`;\n\n/** Files to write, relative to the project directory. */\nexport const renderTemplates = (input: TemplateInput): ReadonlyArray<[path: string, content: string]> => [\n  ['package.json', packageJson(input)],\n  ['.env', env(input)],\n  [\n    '.env.example',\n    env({ ...input, databaseUrl: 'postgres://user:password@localhost:5432/shapio', sessionSecret: '' }),\n  ],\n  ['shapio.config.ts', shapioConfig()],\n  ['.gitignore', gitignore()],\n  ['ecosystem.config.cjs', pm2Ecosystem(input)],\n  ['README.md', readme(input)],\n  ['extensions/.gitkeep', ''],\n  ['extensions/editors/.gitkeep', ''],\n  ['media/.gitkeep', ''],\n];\n","import { randomBytes } from 'node:crypto';\nimport { existsSync, mkdirSync, readdirSync, writeFileSync } from 'node:fs';\nimport { basename, dirname, join, resolve } from 'node:path';\nimport { renderTemplates } from './templates.js';\n\nexport type ScaffoldOptions = {\n  directory: string;\n  shapioSpec: string;\n  databaseUrl?: string;\n};\n\nexport class ScaffoldError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'ScaffoldError';\n  }\n}\n\n/** npm package names: lowercase, URL-safe. Derived from the directory name. */\nexport const toPackageName = (directory: string): string =>\n  basename(resolve(directory))\n    .toLowerCase()\n    .replace(/[^a-z0-9._-]+/g, '-')\n    .replace(/^[._-]+|[-.]+$/g, '') || 'shapio-project';\n\n/** Writes the project files. Refuses to touch a non-empty directory. Returns the absolute project path. */\nexport const scaffoldProject = ({ directory, shapioSpec, databaseUrl }: ScaffoldOptions): string => {\n  const root = resolve(directory);\n  if (existsSync(root) && readdirSync(root).length > 0) {\n    throw new ScaffoldError(`${root} exists and is not empty`);\n  }\n  const projectName = toPackageName(root);\n  const files = renderTemplates({\n    projectName,\n    shapioSpec,\n    databaseUrl:\n      databaseUrl ?? `postgres://postgres:postgres@localhost:5432/${projectName.replace(/[^a-z0-9_]/g, '_')}`,\n    sessionSecret: randomBytes(32).toString('base64url'),\n  });\n  for (const [path, content] of files) {\n    const target = join(root, path);\n    mkdirSync(dirname(target), { recursive: true });\n    writeFileSync(target, content, { flag: 'wx' });\n  }\n  return root;\n};\n","/** The site starters `create-shapio --site` scaffolds (examples/<name> in the repository). */\nexport const SITE_STARTERS = ['astro', 'next', 'sveltekit'] as const;\n\nexport type SiteStarter = (typeof SITE_STARTERS)[number];\n\nexport const isSiteStarter = (value: string): value is SiteStarter =>\n  (SITE_STARTERS as readonly string[]).includes(value);\n\n/** npm leaves `.gitignore` out of published packages, so templates carry it under this name. */\nexport const PACKED_GITIGNORE = 'gitignore';\n","import { cpSync, existsSync, readdirSync, readFileSync, renameSync, writeFileSync } from 'node:fs';\nimport { join, resolve } from 'node:path';\nimport { ScaffoldError, toPackageName } from './scaffold.js';\nimport { PACKED_GITIGNORE, type SiteStarter } from './starters.js';\n\nexport type ScaffoldSiteOptions = {\n  directory: string;\n  site: SiteStarter;\n  /** The packed templates (templates/ next to dist/ in the published package). */\n  templatesDir: string;\n};\n\n/**\n * Writes a standalone site project from a starter template: the framework app, the blog's model files in\n * shapio/, and the seed and smoke scripts. Refuses to touch a non-empty directory. Returns the project path.\n */\nexport const scaffoldSite = ({ directory, site, templatesDir }: ScaffoldSiteOptions): string => {\n  const root = resolve(directory);\n  if (existsSync(root) && readdirSync(root).length > 0) {\n    throw new ScaffoldError(`${root} exists and is not empty`);\n  }\n  const template = join(templatesDir, site);\n  if (!existsSync(join(template, 'package.json'))) {\n    throw new ScaffoldError(\n      `The ${site} template is missing from ${templatesDir}; build create-shapio first`,\n    );\n  }\n  cpSync(template, root, { recursive: true });\n  if (existsSync(join(root, PACKED_GITIGNORE))) {\n    renameSync(join(root, PACKED_GITIGNORE), join(root, '.gitignore'));\n  }\n  const packagePath = join(root, 'package.json');\n  const packageJson = JSON.parse(readFileSync(packagePath, 'utf8')) as Record<string, unknown>;\n  writeFileSync(\n    packagePath,\n    `${JSON.stringify({ ...packageJson, name: toPackageName(root), version: '0.1.0' }, null, 2)}\\n`,\n  );\n  return root;\n};\n","import { spawnSync } from 'node:child_process';\nimport { readFileSync } from 'node:fs';\nimport { fileURLToPath } from 'node:url';\nimport { parseArgs } from 'node:util';\nimport { scaffoldProject, ScaffoldError } from './scaffold.js';\nimport { scaffoldSite } from './site.js';\nimport { isSiteStarter, SITE_STARTERS, type SiteStarter } from './starters.js';\n\nconst USAGE = `Usage: npx create-shapio <directory> [options]\n\nWithout --site: a Shapio project (the CMS server). With --site: a website that reads content from Shapio.\n\nOptions:\n  --site <${SITE_STARTERS.join('|')}>  Create a site starter instead (a blog: pages, articles, authors)\n  --database-url <url>   Database URL to put in .env (PostgreSQL, or sqlite:<path> for a single-process\n                         install; CMS project only)\n  --shapio-spec <spec>   Dependency spec for shapio (default: ^<this version>; a tarball path works too)\n  --no-install           Skip npm install\n  -h, --help             Show this help\n`;\n\n/** Packed from the repository's examples/ when create-shapio is built (templates/ beside dist/). */\nconst TEMPLATES_DIR = fileURLToPath(new URL('../templates/', import.meta.url));\n\nconst ownVersion = (): string => {\n  const packageJson = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')) as {\n    version: string;\n  };\n  return packageJson.version;\n};\n\ntype Output = { out: (text: string) => void; err: (text: string) => void };\n\n/** Returns the exit code. */\nexport const main = (argv: readonly string[], { out, err }: Output): number => {\n  const { values, positionals } = parseArgs({\n    args: [...argv],\n    allowPositionals: true,\n    allowNegative: true,\n    options: {\n      'database-url': { type: 'string' },\n      'shapio-spec': { type: 'string' },\n      site: { type: 'string' },\n      install: { type: 'boolean', default: true },\n      help: { type: 'boolean', short: 'h' },\n    },\n  });\n  const [directory] = positionals;\n  if (values.help || !directory) {\n    (directory ? out : err)(USAGE);\n    return values.help ? 0 : 1;\n  }\n  const site = values.site;\n  if (site !== undefined && !isSiteStarter(site)) {\n    err(`create-shapio: --site must be one of ${SITE_STARTERS.join(', ')}\\n`);\n    return 1;\n  }\n  if (site !== undefined && (values['database-url'] || values['shapio-spec'])) {\n    err('create-shapio: --database-url and --shapio-spec are for a CMS project, not --site\\n');\n    return 1;\n  }\n  let root: string;\n  try {\n    root = site\n      ? scaffoldSite({ directory, site, templatesDir: TEMPLATES_DIR })\n      : scaffoldProject({\n          directory,\n          shapioSpec: values['shapio-spec'] ?? `^${ownVersion()}`,\n          ...(values['database-url'] ? { databaseUrl: values['database-url'] } : {}),\n        });\n  } catch (error) {\n    if (error instanceof ScaffoldError) {\n      err(`create-shapio: ${error.message}\\n`);\n      return 1;\n    }\n    throw error;\n  }\n  out(`Created a ${site ? `${site} site` : 'Shapio project'} in ${root}\\n`);\n  if (values.install) {\n    out('Installing dependencies with npm...\\n');\n    const result = spawnSync('npm', ['install'], { cwd: root, stdio: 'inherit' });\n    if (result.status !== 0) {\n      err('create-shapio: npm install failed; run it yourself in the project directory\\n');\n      return 1;\n    }\n  }\n  out(\n    site\n      ? siteNextSteps(directory, site)\n      : `\\nNext:\\n  cd ${directory}\\n  edit .env (DATABASE_URL)\\n  npm run start\\n`,\n  );\n  return 0;\n};\n\nconst SERVE_COMMAND: Record<SiteStarter, string> = {\n  astro: 'npm run preview',\n  next: 'npm run start',\n  sveltekit: 'npm run preview',\n};\n\nconst siteNextSteps = (directory: string, site: SiteStarter) =>\n  [\n    '',\n    'Next (with a running Shapio; README.md has the details):',\n    `  cd ${directory}`,\n    '  SHAPIO_URL=http://localhost:4300 SHAPIO_ADMIN_EMAIL=you@example.com SHAPIO_ADMIN_PASSWORD=... npm run seed',\n    '  npm run build',\n    `  ${SERVE_COMMAND[site]}`,\n    '',\n  ].join('\\n');\n","#!/usr/bin/env node\nimport { main } from './main.js';\n\nprocess.exitCode = main(process.argv.slice(2), {\n  out: (text) => process.stdout.write(text),\n  err: (text) => process.stderr.write(text),\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,eAAe,EAAE,aAAa,iBAClC,GAAG,KAAK,UACN;CACE,MAAM;CACN,SAAS;CACT,MAAM;CACN,SAAS,EAAE,MAAM,OAAO;CACxB,SAAS;EACP,OAAO;EACP,SAAS;EACT,QAAQ;EACR,QAAQ;CACV;CACA,cAAc,EAAE,eAAe,WAAW;AAC5C,GACA,MACA,CACF,EAAE;AAEJ,MAAM,OAAO,EAAE,aAAa,oBAC1B;CACE;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA,gBAAgB;CAChB;CACA;CACA;CACA;CACA,kBAAkB;CAClB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC,CAAC,KAAK,IAAI;AAEb,MAAM,qBACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCR,MAAM,kBAAkB;;;;;AAMxB,MAAM,gBAAgB,EAAE,kBAAiC;;;;;;cAM3C,KAAK,UAAU,WAAW,EAAE;;;;;;;;;iBASzB,KAAK,UAAU,WAAW,EAAE;;;;AAK7C,MAAM,UAAU,EAAE,kBAChB,KAAK,YAAY;;;;;;;;;;;;;;AAenB,MAAa,mBAAmB,UAAyE;CACvG,CAAC,gBAAgB,YAAY,KAAK,CAAC;CACnC,CAAC,QAAQ,IAAI,KAAK,CAAC;CACnB,CACE,gBACA,IAAI;EAAE,GAAG;EAAO,aAAa;EAAkD,eAAe;CAAG,CAAC,CACpG;CACA,CAAC,oBAAoB,aAAa,CAAC;CACnC,CAAC,cAAc,UAAU,CAAC;CAC1B,CAAC,wBAAwB,aAAa,KAAK,CAAC;CAC5C,CAAC,aAAa,OAAO,KAAK,CAAC;CAC3B,CAAC,uBAAuB,EAAE;CAC1B,CAAC,+BAA+B,EAAE;CAClC,CAAC,kBAAkB,EAAE;AACvB;;;ACjJA,IAAa,gBAAb,cAAmC,MAAM;CACvC,YAAY,SAAiB;EAC3B,MAAM,OAAO;EACb,KAAK,OAAO;CACd;AACF;;AAGA,MAAa,iBAAiB,cAC5B,SAAS,QAAQ,SAAS,CAAC,CAAC,CACzB,YAAY,CAAC,CACb,QAAQ,kBAAkB,GAAG,CAAC,CAC9B,QAAQ,mBAAmB,EAAE,KAAK;;AAGvC,MAAa,mBAAmB,EAAE,WAAW,YAAY,kBAA2C;CAClG,MAAM,OAAO,QAAQ,SAAS;CAC9B,IAAI,WAAW,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,SAAS,GACjD,MAAM,IAAI,cAAc,GAAG,KAAK,yBAAyB;CAE3D,MAAM,cAAc,cAAc,IAAI;CACtC,MAAM,QAAQ,gBAAgB;EAC5B;EACA;EACA,aACE,eAAe,+CAA+C,YAAY,QAAQ,eAAe,GAAG;EACtG,eAAe,YAAY,EAAE,CAAC,CAAC,SAAS,WAAW;CACrD,CAAC;CACD,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO;EACnC,MAAM,SAAS,KAAK,MAAM,IAAI;EAC9B,UAAU,QAAQ,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;EAC9C,cAAc,QAAQ,SAAS,EAAE,MAAM,KAAK,CAAC;CAC/C;CACA,OAAO;AACT;;;;AC5CA,MAAa,gBAAgB;CAAC;CAAS;CAAQ;AAAW;AAI1D,MAAa,iBAAiB,UAC3B,cAAoC,SAAS,KAAK;;AAGrD,MAAa,mBAAmB;;;;;;;ACOhC,MAAa,gBAAgB,EAAE,WAAW,MAAM,mBAAgD;CAC9F,MAAM,OAAO,QAAQ,SAAS;CAC9B,IAAI,WAAW,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,SAAS,GACjD,MAAM,IAAI,cAAc,GAAG,KAAK,yBAAyB;CAE3D,MAAM,WAAW,KAAK,cAAc,IAAI;CACxC,IAAI,CAAC,WAAW,KAAK,UAAU,cAAc,CAAC,GAC5C,MAAM,IAAI,cACR,OAAO,KAAK,4BAA4B,aAAa,4BACvD;CAEF,OAAO,UAAU,MAAM,EAAE,WAAW,KAAK,CAAC;CAC1C,IAAI,WAAW,KAAK,MAAA,WAAsB,CAAC,GACzC,WAAW,KAAK,MAAM,gBAAgB,GAAG,KAAK,MAAM,YAAY,CAAC;CAEnE,MAAM,cAAc,KAAK,MAAM,cAAc;CAC7C,MAAM,cAAc,KAAK,MAAM,aAAa,aAAa,MAAM,CAAC;CAChE,cACE,aACA,GAAG,KAAK,UAAU;EAAE,GAAG;EAAa,MAAM,cAAc,IAAI;EAAG,SAAS;CAAQ,GAAG,MAAM,CAAC,EAAE,GAC9F;CACA,OAAO;AACT;;;AC9BA,MAAM,QAAQ;;;;;YAKF,cAAc,KAAK,GAAG,EAAE;;;;;;;;AASpC,MAAM,gBAAgB,cAAc,IAAI,IAAI,iBAAiB,YAAY,GAAG,CAAC;AAE7E,MAAM,mBAA2B;CAI/B,OAHoB,KAAK,MAAM,aAAa,IAAI,IAAI,mBAAmB,YAAY,GAAG,GAAG,MAAM,CAG9E,CAAC,CAAC;AACrB;;AAKA,MAAa,QAAQ,MAAyB,EAAE,KAAK,UAA0B;CAC7E,MAAM,EAAE,QAAQ,gBAAgB,UAAU;EACxC,MAAM,CAAC,GAAG,IAAI;EACd,kBAAkB;EAClB,eAAe;EACf,SAAS;GACP,gBAAgB,EAAE,MAAM,SAAS;GACjC,eAAe,EAAE,MAAM,SAAS;GAChC,MAAM,EAAE,MAAM,SAAS;GACvB,SAAS;IAAE,MAAM;IAAW,SAAS;GAAK;GAC1C,MAAM;IAAE,MAAM;IAAW,OAAO;GAAI;EACtC;CACF,CAAC;CACD,MAAM,CAAC,aAAa;CACpB,IAAI,OAAO,QAAQ,CAAC,WAAW;EAC7B,CAAC,YAAY,MAAM,IAAA,CAAK,KAAK;EAC7B,OAAO,OAAO,OAAO,IAAI;CAC3B;CACA,MAAM,OAAO,OAAO;CACpB,IAAI,SAAS,KAAA,KAAa,CAAC,cAAc,IAAI,GAAG;EAC9C,IAAI,wCAAwC,cAAc,KAAK,IAAI,EAAE,GAAG;EACxE,OAAO;CACT;CACA,IAAI,SAAS,KAAA,MAAc,OAAO,mBAAmB,OAAO,iBAAiB;EAC3E,IAAI,qFAAqF;EACzF,OAAO;CACT;CACA,IAAI;CACJ,IAAI;EACF,OAAO,OACH,aAAa;GAAE;GAAW;GAAM,cAAc;EAAc,CAAC,IAC7D,gBAAgB;GACd;GACA,YAAY,OAAO,kBAAkB,IAAI,WAAW;GACpD,GAAI,OAAO,kBAAkB,EAAE,aAAa,OAAO,gBAAgB,IAAI,CAAC;EAC1E,CAAC;CACP,SAAS,OAAO;EACd,IAAI,iBAAiB,eAAe;GAClC,IAAI,kBAAkB,MAAM,QAAQ,GAAG;GACvC,OAAO;EACT;EACA,MAAM;CACR;CACA,IAAI,aAAa,OAAO,GAAG,KAAK,SAAS,iBAAiB,MAAM,KAAK,GAAG;CACxE,IAAI,OAAO,SAAS;EAClB,IAAI,uCAAuC;EAE3C,IADe,UAAU,OAAO,CAAC,SAAS,GAAG;GAAE,KAAK;GAAM,OAAO;EAAU,CAClE,CAAC,CAAC,WAAW,GAAG;GACvB,IAAI,+EAA+E;GACnF,OAAO;EACT;CACF;CACA,IACE,OACI,cAAc,WAAW,IAAI,IAC7B,iBAAiB,UAAU,gDACjC;CACA,OAAO;AACT;AAEA,MAAM,gBAA6C;CACjD,OAAO;CACP,MAAM;CACN,WAAW;AACb;AAEA,MAAM,iBAAiB,WAAmB,SACxC;CACE;CACA;CACA,QAAQ;CACR;CACA;CACA,KAAK,cAAc;CACnB;AACF,CAAC,CAAC,KAAK,IAAI;;;AC1Gb,QAAQ,WAAW,KAAK,QAAQ,KAAK,MAAM,CAAC,GAAG;CAC7C,MAAM,SAAS,QAAQ,OAAO,MAAM,IAAI;CACxC,MAAM,SAAS,QAAQ,OAAO,MAAM,IAAI;AAC1C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-shapio",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Scaffold a new Shapio project (npx create-shapio my-cms) or a site starter (--site astro|next|sveltekit)",
   "license": "Apache-2.0",
   "homepage": "https://shapio.dev",

package/templates/astro/.env.example

@@ -8,3 +8,5 @@ SHAPIO_DELIVERY_TOKEN=
 # SHAPIO_SITE=marketing
 # Optional: the origin the browser calls for draft previews (defaults to SHAPIO_URL).
 # PUBLIC_SHAPIO_URL=https://cms.example.com
+# Optional: this site's public origin; pages then carry a canonical URL and og:url.
+# SITE_URL=https://www.example.com

package/templates/astro/package.json

@@ -19,8 +19,8 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "dependencies": {
-    "@shapio/client": "^0.3.0",
-    "@shapio/visual": "^0.3.0",
+    "@shapio/client": "^0.4.0",
+    "@shapio/visual": "^0.4.0",
     "astro": "7.3.5"
   },
   "devDependencies": {

package/templates/astro/scripts/lib/content.ts

@@ -448,15 +448,56 @@ export type EntrySpec = {
   publish: boolean;
 };
 
+/**
+ * The SEO fields of one locale (the built-in `seo` component, per locale): a page describes itself with its
+ * description, an article with its excerpt and its cover (a shared field, so it comes from the English data).
+ * The title stays empty: `?seo=resolved` falls back to the entry's own title, through the site's template.
+ */
+const seoOf = (data: Record<string, unknown>, shared: Record<string, unknown>) => ({
+  description: data.excerpt ?? data.description ?? null,
+  image: shared.cover ?? null,
+});
+
+const withSeo = (content: Localized<Record<string, unknown>>): Localized<Record<string, unknown>> => ({
+  en: { ...content.en, seo: seoOf(content.en, content.en) },
+  fr: { ...content.fr, seo: seoOf(content.fr, content.en) },
+});
+
 export const entries = (media: MediaIds, authorId: string): EntrySpec[] => [
-  { model: 'page', slug: 'home', content: home(media), publish: true },
-  { model: 'page', slug: 'about', content: about(), publish: true },
+  { model: 'page', slug: 'home', content: withSeo(home(media)), publish: true },
+  { model: 'page', slug: 'about', content: withSeo(about()), publish: true },
   {
     model: 'article',
     slug: 'modelling-without-a-deploy',
-    content: modelling(media, authorId),
+    content: withSeo(modelling(media, authorId)),
+    publish: true,
+  },
+  {
+    model: 'article',
+    slug: 'why-builds-pin-a-snapshot',
+    content: withSeo(snapshots(media, authorId)),
     publish: true,
   },
-  { model: 'article', slug: 'why-builds-pin-a-snapshot', content: snapshots(media, authorId), publish: true },
-  { model: 'article', slug: 'winter-projects', content: draft(media, authorId), publish: false },
+  { model: 'article', slug: 'winter-projects', content: withSeo(draft(media, authorId)), publish: false },
 ];
+
+/**
+ * The site's SEO defaults (Settings → SEO; `PUT /api/admin/site/seo`): the name and template match the
+ * siteSettings singleton's site name, the description its tagline; the hero image is the default social image.
+ */
+export const seoDefaults = (media: MediaIds) => ({
+  locales: {
+    en: {
+      siteName: String(SITE_SETTINGS.en.siteName),
+      titleTemplate: `%s · ${String(SITE_SETTINGS.en.siteName)}`,
+      description: String(SITE_SETTINGS.en.tagline),
+    },
+    fr: {
+      siteName: String(SITE_SETTINGS.fr.siteName),
+      titleTemplate: `%s · ${String(SITE_SETTINGS.fr.siteName)}`,
+      description: String(SITE_SETTINGS.fr.tagline),
+    },
+  },
+  imageId: media.hero,
+  twitterHandle: '@northwindstudio',
+});

package/templates/astro/scripts/seed.ts

@@ -4,6 +4,7 @@ import { setTimeout as delay } from 'node:timers/promises';
 import { parseArgs } from 'node:util';
 import {
   buildUploadForm,
+  SEO_COMPONENT_ID,
   ShapioApiError,
   type MediaAsset,
   type SchemaApplyInput,
@@ -15,6 +16,7 @@ import {
   AUTHOR,
   entries,
   IMAGES,
+  seoDefaults,
   SITE_SETTINGS,
   type EntrySpec,
   type ImageSpec,
@@ -29,8 +31,9 @@ import { createPng } from './lib/png.js';
  * 2. the models and components in shapio/ through the schema apply API (live, no restart; the same planner
  *    as `shapio schema apply` and the admin), as the site's own (SHAPIO_SITE, else the token's site, else the
  *    primary): a starter's schema belongs to the first site it is seeded on;
+ *    The built-in SEO component (components/seo.json) is the exception: it is always shared with every site;
  * 3. placeholder images, an author, the site settings, pages and articles in English and French, published
- *    per locale;
+ *    per locale, and the site's SEO defaults (Settings → SEO);
  * 4. a deployment connection named "Preview" whose preview URL opens this starter's /preview/ page (the
  *    entry document's Preview pane and visual editing; it triggers no builds). The site's URL is SITE_URL, else
  *    the starter's `--site-url` (its local dev server);
@@ -50,6 +53,8 @@ const PREVIEW_PATH = '/preview/?model={modelKey}&id={entryId}&locale={locale}#to
 /** A placeholder build hook: the connection has no triggers, so nothing is ever sent to it. */
 const PREVIEW_BUILD_HOOK = 'https://build.invalid/shapio-starter';
 const REVALIDATE_WEBHOOK_NAME = 'Site revalidation';
+/** The request's site's SEO defaults (`site.settings`). */
+const SEO_DEFAULTS_PATH = '/api/admin/site/seo';
 /** The events that change what a published site shows (the starter's route ignores any others). */
 const REVALIDATE_EVENTS = [
   'entry.published',
@@ -58,6 +63,8 @@ const REVALIDATE_EVENTS = [
   'change_set.shipped',
   'schema.activated',
   'schema.deleted',
+  // The site's SEO defaults changed: every page's head shows them.
+  'site.updated',
 ];
 /** A local site needs Shapio's OUTBOUND_PRIVATE_NETWORK_ALLOWLIST too; the webhook opts in for loopback only. */
 const LOOPBACK_HOSTS = new Set(['localhost', '127.0.0.1', '[::1]']);
@@ -129,8 +136,11 @@ const applySchema = async (client: ShapioClient) => {
   try {
     response = await client.admin.schema.apply({
       definitions,
-      // Every definition is the site's own (sites/<key>/ in a pulled tree), never shared by default.
-      scopes: definitions.map(() => 'site' as const),
+      // Every definition is the site's own (sites/<key>/ in a pulled tree), never shared by default, except
+      // the built-in SEO component: Shapio knows it by its fixed ID, so one shared copy serves every site.
+      scopes: definitions.map((definition) =>
+        (definition as { id?: unknown }).id === SEO_COMPONENT_ID ? ('network' as const) : ('site' as const),
+      ),
       base: FIRST_APPLY_BASE,
       prune: false,
       dryRun: false,
@@ -143,7 +153,8 @@ const applySchema = async (client: ShapioClient) => {
         "This starter's schema already belongs to another site of this instance: a starter's schema belongs " +
           'to the first site it is seeded on. To reuse it on this site, share it with all sites ' +
           'with a network admin token (`shapio schema scope <apiKey> --shared --site <that site>` for each ' +
-          'component, then author, page, article and siteSettings) and seed again, or seed a separate instance.',
+          'component, then author, page, article and siteSettings) and seed again, or seed a separate instance. ' +
+          'The SEO component is always shared; a site that keeps its own copy of it blocks the others.',
         { cause: error },
       );
     }
@@ -259,6 +270,16 @@ const ensureSiteSettings = async (client: ShapioClient) => {
   log('Published siteSettings (en, fr)');
 };
 
+/** The site's SEO defaults: the texts per locale, the default social image and the Twitter handle. */
+const ensureSeoDefaults = async (client: ShapioClient, media: MediaIds) => {
+  const current = await client.request<{ version: number }>(SEO_DEFAULTS_PATH);
+  await client.request(SEO_DEFAULTS_PATH, {
+    method: 'PUT',
+    body: { expectedVersion: current.version, seo: seoDefaults(media) },
+  });
+  log('Set the SEO defaults (en, fr)');
+};
+
 const upsertEntry = async (client: ShapioClient, spec: EntrySpec) => {
   const found = await client.admin.content.list(spec.model, {
     filters: { slug: { $eq: spec.slug } },
@@ -413,6 +434,7 @@ const main = async () => {
     await applySchema(admin.client);
     const media = await ensureMedia(admin.client);
     await ensureSiteSettings(admin.client);
+    await ensureSeoDefaults(admin.client, media);
     const authorId = await ensureAuthor(admin.client, media.avatar);
     for (const spec of entries(media, authorId)) {
       await upsertEntry(admin.client, spec);

package/templates/astro/scripts/smoke.ts

@@ -62,6 +62,19 @@ const checkBuild = async () => {
   check(articleEn.includes('<table>') && articleEn.includes('With Shapio'), 'EN article: rich-text table');
   check(articleEn.includes('Ada Moreau'), 'EN article: populated author');
   check(articleFr.includes('Modéliser du contenu sans déploiement'), 'FR article: title');
+  check(
+    articleEn.includes('<title>Modelling content without a deploy · Northwind Studio</title>'),
+    'EN article: SEO title through the site template',
+  );
+  check(
+    articleEn.includes('property="og:image"') &&
+      articleEn.includes('name="twitter:site" content="@northwindstudio"'),
+    'EN article: Open Graph image and Twitter handle from the SEO fields and defaults',
+  );
+  check(
+    articleFr.includes('<title>Modéliser du contenu sans déploiement · Studio Northwind</title>'),
+    'FR article: SEO title through the French template',
+  );
   check((await html('fr/about/index.html')).includes('À propos du studio'), 'FR about page');
   check(
     (await html('en/colophon/index.html')).includes('pinned to one publication snapshot per build'),

package/templates/astro/scripts/smokeHttp.ts

@@ -5,7 +5,8 @@ import { parseArgs } from 'node:util';
  * `npm run smoke`, after `npm run seed`, `npm run build` and starting the built site (`npm run start` or
  * `npm run preview`): fetches the site's pages over HTTP and checks the seeded content in English and French,
  * the site settings singleton, rich text, media variants and the author, that the draft article is not
- * served, that content carries the visual-editing attributes (@shapio/visual's `shapioAttr`), and that the
+ * served, that content carries the visual-editing attributes (@shapio/visual's `shapioAttr`), that pages carry
+ * their SEO tags (the entry's SEO fields with the site's defaults: title template, Open Graph, Twitter), and that the
  * preview page is served with a `frame-ancestors` policy. The same checks run against every starter, so all
  * three render the same blog.
  *
@@ -28,6 +29,9 @@ const PAGES: readonly PageCheck[] = [
       ['.webp', 'responsive image variants'],
       ['Northwind Studio', 'site name from the siteSettings singleton'],
       ['Built with Shapio', 'footer from the siteSettings singleton'],
+      ['<title>Home · Northwind Studio</title>', 'title through the SEO title template'],
+      ['property="og:image"', 'og:image (the default social image)'],
+      ['name="twitter:site" content="@northwindstudio"', 'twitter:site from the SEO defaults'],
     ],
   },
   {
@@ -36,6 +40,7 @@ const PAGES: readonly PageCheck[] = [
       ['Un contenu qui évolue aussi vite que votre produit', 'hero heading'],
       ['lang="fr"', 'lang="fr"'],
       ['Studio Northwind', 'site name from the siteSettings singleton'],
+      ['<title>Accueil · Studio Northwind</title>', 'title through the French SEO title template'],
     ],
   },
   {
@@ -43,6 +48,7 @@ const PAGES: readonly PageCheck[] = [
     expect: [
       ['Modelling content without a deploy', 'article list'],
       ['Why our builds pin a snapshot', 'second article'],
+      ['<title>Journal · Northwind Studio</title>', 'a page without an entry: title through the template'],
     ],
   },
   {
@@ -55,6 +61,10 @@ const PAGES: readonly PageCheck[] = [
       ['data-shapio-entry="', 'visual-editing entry attribute'],
       ['data-shapio-path="title"', 'visual-editing attribute on the title'],
       ['data-shapio-path="body"', 'visual-editing attribute on the body'],
+      ['<title>Modelling content without a deploy · Northwind Studio</title>', 'SEO title (resolved)'],
+      ['property="og:type" content="article"', 'og:type article'],
+      ['Nothing restarted.', 'SEO description from the entry'],
+      ['name="twitter:card" content="summary_large_image"', 'twitter:card with the cover image'],
     ],
   },
   { path: `/fr/articles/${ARTICLE}/`, expect: [['Modéliser du contenu sans déploiement', 'title']] },

package/templates/astro/shapio/components/seo.json

@@ -0,0 +1,114 @@
+{
+  "apiKey": "seo",
+  "category": "Built-in",
+  "description": "Search and social metadata: title, description, image, canonical URL and indexing.",
+  "display": {
+    "titleFieldId": "3fe294a9-6af9-4019-8b32-43010822e45a"
+  },
+  "fields": [
+    {
+      "apiKey": "title",
+      "deprecated": false,
+      "editor": {
+        "id": "textInput",
+        "options": {}
+      },
+      "filterable": false,
+      "id": "3fe294a9-6af9-4019-8b32-43010822e45a",
+      "label": "Title",
+      "localized": false,
+      "public": true,
+      "required": false,
+      "settings": {},
+      "sortable": false,
+      "type": "string",
+      "unique": false
+    },
+    {
+      "apiKey": "description",
+      "deprecated": false,
+      "editor": {
+        "id": "textarea",
+        "options": {}
+      },
+      "filterable": false,
+      "id": "6d1917f3-94a2-4391-ba1f-a98d14577b93",
+      "label": "Description",
+      "localized": false,
+      "public": true,
+      "required": false,
+      "settings": {},
+      "sortable": false,
+      "type": "text",
+      "unique": false
+    },
+    {
+      "apiKey": "image",
+      "deprecated": false,
+      "editor": {
+        "id": "mediaPicker",
+        "options": {}
+      },
+      "filterable": false,
+      "id": "d27c9354-4afc-4583-93b4-367214a7714a",
+      "label": "Social image",
+      "localized": false,
+      "public": true,
+      "required": false,
+      "settings": {
+        "allowedKinds": [
+          "image"
+        ],
+        "multiple": false
+      },
+      "sortable": false,
+      "type": "media",
+      "unique": false
+    },
+    {
+      "apiKey": "canonical",
+      "deprecated": false,
+      "editor": {
+        "id": "textInput",
+        "options": {}
+      },
+      "filterable": false,
+      "id": "17b374b6-cd85-444e-8403-20c7458ed29e",
+      "label": "Canonical URL",
+      "localized": false,
+      "public": true,
+      "required": false,
+      "settings": {
+        "protocols": [
+          "https",
+          "http"
+        ]
+      },
+      "sortable": false,
+      "type": "url",
+      "unique": false
+    },
+    {
+      "apiKey": "noindex",
+      "deprecated": false,
+      "editor": {
+        "id": "toggle",
+        "options": {}
+      },
+      "filterable": false,
+      "id": "e8346f99-dc3c-4b5c-906f-4854e03c9a57",
+      "label": "Hide from search engines",
+      "localized": false,
+      "public": true,
+      "required": false,
+      "settings": {},
+      "sortable": false,
+      "type": "boolean",
+      "unique": false
+    }
+  ],
+  "icon": "search",
+  "id": "f3905a00-d2a3-4c62-899a-c894bfd6cb9b",
+  "kind": "component",
+  "label": "SEO"
+}

package/templates/astro/shapio/models/article.json

@@ -140,6 +140,27 @@
       "sortable": true,
       "type": "date",
       "unique": false
+    },
+    {
+      "apiKey": "seo",
+      "deprecated": false,
+      "editor": {
+        "id": "seoEditor",
+        "options": {}
+      },
+      "filterable": false,
+      "id": "a3f1c0de-7b52-4e0a-9d1e-5c2b8e4f6a01",
+      "label": "SEO",
+      "localized": true,
+      "public": true,
+      "required": false,
+      "settings": {
+        "component": "f3905a00-d2a3-4c62-899a-c894bfd6cb9b",
+        "repeatable": false
+      },
+      "sortable": false,
+      "type": "component",
+      "unique": false
     }
   ],
   "id": "1679d89c-747f-4dfc-955f-7d47bd5e4f6b",

package/templates/astro/shapio/models/page.json

@@ -83,6 +83,27 @@
       "sortable": false,
       "type": "dynamiczone",
       "unique": false
+    },
+    {
+      "apiKey": "seo",
+      "deprecated": false,
+      "editor": {
+        "id": "seoEditor",
+        "options": {}
+      },
+      "filterable": false,
+      "id": "b7e2d1af-3c64-4f1b-8e2a-6d3c9f5a7b02",
+      "label": "SEO",
+      "localized": true,
+      "public": true,
+      "required": false,
+      "settings": {
+        "component": "f3905a00-d2a3-4c62-899a-c894bfd6cb9b",
+        "repeatable": false
+      },
+      "sortable": false,
+      "type": "component",
+      "unique": false
     }
   ],
   "id": "4c09af05-f302-4d8f-ba03-bb838d3afbd2",

package/templates/astro/src/layouts/Base.astro

@@ -1,23 +1,49 @@
 ---
 import '../styles/site.css';
-import { getSiteSettings } from '../lib/shapio.js';
-import { articlesPath, colophonPath, HOME_SLUG, otherLocale, pagePath, stringsFor, type Locale } from '../lib/site.js';
+import type { SeoResolved } from '@shapio/client';
+import { seoHead, type SeoHead } from '../lib/seo.js';
+import { getSite, getSiteSettings } from '../lib/shapio.js';
+import {
+  articlesPath,
+  colophonPath,
+  DEFAULT_LOCALE,
+  HOME_SLUG,
+  otherLocale,
+  pagePath,
+  stringsFor,
+  type Locale,
+} from '../lib/site.js';
 
 type Props = {
+  /** The page's own title; entry pages pass their SEO fields too, which win. */
   title: string;
-  description?: string | null;
+  /** The entry's SEO fields, read with `seo=resolved`. */
+  seo?: SeoResolved | null;
+  type?: SeoHead['type'];
   locale: Locale;
   /** This page in the other locale. */
   alternatePath?: string;
   noindex?: boolean;
 };
 
-const { title, description, locale, alternatePath, noindex = false } = Astro.props;
+const { title, seo, type, locale, alternatePath, noindex = false } = Astro.props;
 const strings = stringsFor(locale);
 const other = otherLocale(locale);
 // The name, tagline and footer come from the siteSettings singleton (the built-in strings until it is published).
 const settings = await getSiteSettings(locale);
 const siteName = settings?.siteName ?? strings.siteName;
+// Title, description, social tags and canonical: the entry's SEO fields over the site's SEO defaults.
+const head = seoHead({
+  seo: seo ?? null,
+  site: await getSite(),
+  locale,
+  localeChain: [locale, DEFAULT_LOCALE],
+  title,
+  path: Astro.url.pathname,
+  siteUrl: Astro.site?.href,
+  ...(type ? { type } : {}),
+});
+const robotsNoindex = noindex || head.noindex;
 ---
 
 <!doctype html>
@@ -25,9 +51,25 @@ const siteName = settings?.siteName ?? strings.siteName;
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <title>{title} · {siteName}</title>
-    {description ? <meta name="description" content={description} /> : null}
-    {noindex ? <meta name="robots" content="noindex" /> : null}
+    <title>{head.title}</title>
+    {head.description ? <meta name="description" content={head.description} /> : null}
+    {robotsNoindex ? <meta name="robots" content="noindex" /> : null}
+    {head.canonical ? <link rel="canonical" href={head.canonical} /> : null}
+    <meta property="og:type" content={head.type} />
+    <meta property="og:title" content={head.title} />
+    <meta property="og:locale" content={head.locale} />
+    {head.siteName ? <meta property="og:site_name" content={head.siteName} /> : null}
+    {head.description ? <meta property="og:description" content={head.description} /> : null}
+    {head.canonical ? <meta property="og:url" content={head.canonical} /> : null}
+    {head.image ? <meta property="og:image" content={head.image.url} /> : null}
+    {head.image?.width ? <meta property="og:image:width" content={String(head.image.width)} /> : null}
+    {head.image?.height ? <meta property="og:image:height" content={String(head.image.height)} /> : null}
+    {head.image?.alt ? <meta property="og:image:alt" content={head.image.alt} /> : null}
+    <meta name="twitter:card" content={head.image ? 'summary_large_image' : 'summary'} />
+    {head.twitterHandle ? <meta name="twitter:site" content={head.twitterHandle} /> : null}
+    <meta name="twitter:title" content={head.title} />
+    {head.description ? <meta name="twitter:description" content={head.description} /> : null}
+    {head.image ? <meta name="twitter:image" content={head.image.url} /> : null}
     {alternatePath ? <link rel="alternate" hreflang={other} href={alternatePath} /> : null}
     <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
   </head>

package/templates/astro/src/lib/preview.ts

@@ -44,6 +44,7 @@ export const loadPreview = async (
   const client = createClient({ baseUrl: shapioUrl, token: request.token });
   const params = new URLSearchParams({
     locale: request.locale,
+    richText: 'html',
     ...(request.modelKey === 'articles' ? { populate: 'author' } : {}),
   });
   const { data } = await client.request<DeliveryItem<Page | Article>>(