@biffo/cli 0.306.0 → 0.307.0

package/_skeletons/plugin-template/README.md

@@ -127,6 +127,46 @@ runtime config rather than tenant-scoped table rows:
 > [ADR-0011](https://github.com/keiranholloway/biffo-template/blob/main/docs/ADR/0011-authorization-is-a-core-concern.md)
 > (authorization is a Core concern, not a plugin) and no longer exists.
 
+## User-facing frontend: the `user_frontend` contract (ADR-0021 §2)
+
+If your plugin ships a founder-facing UI, it declares a `user_frontend` block
+in `biffo.plugin.json`:
+
+```json
+"user_frontend": {
+  "dir": "web/dist",
+  "required_group": "founder"
+}
+```
+
+and ships **`web/` and nothing else** — a built static bundle (`index.html`
+plus hashed `assets/*`, the ordinary Vite build-output shape) at the
+repo-relative path `dir` names. That is the entire contract. In particular a
+`user_frontend` plugin ships **no** `terraform/` frontend resources and
+**no** `deploy-frontend.yml` workflow of its own.
+
+**Who serves it, and why there is nothing to provision.** The shared plugin
+host serves the bundle directly — `GET /api/v1/plugins/<name>/ui` and
+`GET /api/v1/plugins/<name>/ui/{proxy+}` on the API Gateway routes every
+installed plugin already shares — the same way it already serves
+`admin_ingress`'s admin shell. There is no per-plugin S3 origin, no per-plugin
+CloudFront behaviour, and nothing for `biffo plugin install` to provision:
+committing `web/dist/` is the whole deploy. See
+[ADR-0021](../../docs/ADR/0021-shared-plugin-hosting.md) section 2 for the
+full design and why this superseded the older, per-plugin hosting model.
+
+**This retires ADR-0018 section 2's per-plugin frontend shape** — a dedicated
+`aws_s3_bucket` behind the shared CloudFront distribution, wired through a
+`cdn_distribution_arn` module variable and a `frontend_bucket_*` output. That
+shape is fail-closed at install time: `biffo plugin install` and
+`biffo plugin upgrade` **refuse** a plugin whose `terraform/` declares it —
+an `aws_s3_bucket` whose name interpolates `-plugin-…-web`, an output named
+`frontend_bucket_*`, or a `cdn_distribution_arn` variable — with an error
+naming ADR-0021 section 2 and this contract. If you are updating an older
+plugin that still ships one of these, delete `terraform/`'s frontend
+resources (and `deploy-frontend.yml`, if present) and adopt `user_frontend`
+above instead; there is nothing left to provision once you do.
+
 ## Standalone repo, not a monorepo package
 
 Unlike biffo-template's own in-monorepo plugins (e.g. `services/_plugins/orchestrator/`,

package/dist/index.js

@@ -3504,6 +3504,45 @@ function declaredOutputs(moduleDir) {
   }
   return names;
 }
+var RETIRED_FRONTEND_BUCKET_PATTERN = /bucket\s*=\s*"[^"]*-plugin-[^"]*-web"/;
+function declaresRetiredFrontendBucket(moduleDir) {
+  let entries;
+  try {
+    entries = readdirSync3(moduleDir, { withFileTypes: true });
+  } catch {
+    return false;
+  }
+  for (const entry of entries) {
+    if (!entry.isFile() || !entry.name.endsWith(".tf")) continue;
+    let contents;
+    try {
+      contents = readFileSync10(join13(moduleDir, entry.name), "utf8");
+    } catch {
+      continue;
+    }
+    if (RETIRED_FRONTEND_BUCKET_PATTERN.test(contents)) return true;
+  }
+  return false;
+}
+function findRetiredFrontendShape(terraformDir) {
+  const reasons = [];
+  if (!existsSync12(terraformDir)) return reasons;
+  if (declaresRetiredFrontendBucket(terraformDir)) {
+    reasons.push('an aws_s3_bucket whose name interpolates "-plugin-...-web"');
+  }
+  for (const name of [...declaredOutputs(terraformDir)].sort()) {
+    if (name.startsWith("frontend_bucket")) {
+      reasons.push(`an output named "${name}"`);
+    }
+  }
+  if (declaredVariables(terraformDir).has("cdn_distribution_arn")) {
+    reasons.push('a "cdn_distribution_arn" variable');
+  }
+  return reasons;
+}
+function retiredFrontendShapeError(pluginName, reasons) {
+  return `Plugin '${pluginName}' ships a terraform/ frontend on the retired ADR-0018 \xA72 per-plugin hosting shape: it declares ${reasons.join(", ")}. ADR-0021 \xA72 replaced this \u2014 a user-facing plugin's frontend is served by the shared plugin host directly from the manifest's \`user_frontend\` field (\`{ dir, required_group }\`); it ships \`web/\` and nothing else, with no terraform/ frontend and no deploy-frontend.yml. Update the plugin to the \`user_frontend\` contract (see _skeletons/plugin-template/README.md) before installing it here.`;
+}
 function renderArguments(args, indent) {
   const width = Math.max(...args.map(([key]) => key.length));
   return args.map(([key, value]) => `${indent}${key.padEnd(width)} = ${value}`).join("\n");
@@ -9488,6 +9527,10 @@ async function runPluginInstall(target, options, deps) {
     log.success(
       `Manifest valid \u2014 ${manifest.tables.length} table(s), ${manifest.api_routes.length} route(s)`
     );
+    const retiredShapeReasons = findRetiredFrontendShape(join33(source.sourceDir, "terraform"));
+    if (retiredShapeReasons.length > 0) {
+      throw new Error(retiredFrontendShapeError(pluginName, retiredShapeReasons));
+    }
     if (inTreeSource) {
       log.info(`${relTargetDir}/ is already in this checkout \u2014 installing in place.`);
     } else {
@@ -10256,6 +10299,10 @@ async function runPluginUpgrade(target, options, deps) {
     log.success(
       `Manifest valid \u2014 ${manifest.tables.length} table(s), ${manifest.api_routes.length} route(s)`
     );
+    const retiredShapeReasons = findRetiredFrontendShape(join38(tmpDir, "terraform"));
+    if (retiredShapeReasons.length > 0) {
+      throw new Error(retiredFrontendShapeError(entry.name, retiredShapeReasons));
+    }
     if (!existsSync36(join38(tmpDir, "terraform"))) {
       refuseIfModuleStillReferenced(options.cwd, modulesDir, entry.name);
     }
@@ -10370,6 +10417,10 @@ async function runLocalPluginRefresh(localPath, options, deps) {
     log.success(
       `Manifest valid \u2014 ${manifest.tables.length} table(s), ${manifest.api_routes.length} route(s)`
     );
+    const retiredShapeReasons = findRetiredFrontendShape(join38(source.sourceDir, "terraform"));
+    if (retiredShapeReasons.length > 0) {
+      throw new Error(retiredFrontendShapeError(source.name, retiredShapeReasons));
+    }
     if (!existsSync36(join38(source.sourceDir, "terraform"))) {
       refuseIfModuleStillReferenced(options.cwd, modulesDir, source.name);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biffo/cli",
-  "version": "0.306.0",
+  "version": "0.307.0",
   "description": "Biffo project scaffolding CLI",
   "license": "MIT",
   "type": "module",