Merge pull request #1819 from counterfact/copilot/remove-gui-client

Remove the client (GUI)

Author: pmcelhaney

.changeset/remove-gui-client.md

@@ -0,0 +1,5 @@
+---
+"counterfact": minor
+---
+
+Remove the built-in GUI client (dashboard and RapiDoc pages) from src/client and the Handlebars dependency. The Swagger UI at /counterfact/swagger remains available. Navigating to /counterfact now redirects to /counterfact/swagger.

package.json

@@ -67,7 +67,7 @@
     "test": "yarn node --experimental-vm-modules ./node_modules/jest-cli/bin/jest --testPathIgnorePatterns=black-box",
     "test:black-box": "rimraf dist && yarn build && python3 -m pytest test-black-box/ -v",
     "test:tsd": "tsd --typings ./dist/server/counterfact-types/index.ts --files ./test/**/*.test-d.ts",
-    "build": "rm -rf dist && tsc && copyfiles -f \"src/client/**\" dist/client && copyfiles -f \"src/counterfact-types/*.ts\" dist/server/counterfact-types && copyfiles -f \"src/server/*.cjs\" dist/server",
+    "build": "rm -rf dist && tsc && copyfiles -f \"src/counterfact-types/*.ts\" dist/server/counterfact-types && copyfiles -f \"src/server/*.cjs\" dist/server",
     "prepack": "yarn build",
     "release": "npx changeset publish",
     "prepare": "husky install",
@@ -131,7 +131,6 @@
     "commander": "14.0.3",
     "debug": "4.4.3",
     "fs-extra": "11.3.4",
-    "handlebars": "4.7.9",
     "http-terminator": "3.2.0",
     "js-yaml": "4.1.1",
     "json-schema-faker": "0.6.0",

src/client/README.md

@@ -1,5 +1,3 @@
-import { pathToFileURL } from "node:url";
-
 import createDebug from "debug";
 import Koa from "koa";
 import bodyParser from "koa-bodyparser";
@@ -9,7 +7,6 @@ import { adminApiMiddleware } from "./admin-api-middleware.js";
 import type { Config } from "./config.js";
 import type { ContextRegistry } from "./context-registry.js";
 import { openapiMiddleware } from "./openapi-middleware.js";
-import { pageMiddleware } from "./page-middleware.js";
 import type { Registry } from "./registry.js";
 
 const debug = createDebug("counterfact:server:create-koa-app");
@@ -46,43 +43,16 @@ export function createKoaApp(
   debug("basePath: %s", config.basePath);
   debug("routes", registry.routes);
 
-  app.use(
-    pageMiddleware("/counterfact/", "index", {
-      basePath: config.basePath,
-      methods: ["get", "post", "put", "delete", "patch"],
-
-      openApiHref: config.openApiPath.includes("://")
-        ? config.openApiPath
-        : pathToFileURL(config.openApiPath).href,
-
-      openApiPath: config.openApiPath,
-
-      get routes() {
-        return registry.routes;
-      },
-    }),
-  );
-
   app.use(async (ctx, next) => {
     if (ctx.URL.pathname === "/counterfact") {
-      ctx.redirect("/counterfact/");
+      ctx.redirect("/counterfact/swagger");
 
       return;
     }
 
     await next();
   });
 
-  app.use(
-    pageMiddleware("/counterfact/rapidoc", "rapi-doc", {
-      basePath: config.basePath,
-
-      get routes() {
-        return registry.routes;
-      },
-    }),
-  );
-
   app.use(bodyParser());
 
   app.use(async (ctx, next) => {