feat: Client endpoint for reporting backend API to other instances

package.json

@@ -2,6 +2,9 @@
   "name": "stoat-for-web",
   "version": "0.9.1",
   "description": "Stoat for Web: frontend software for Stoat",
+  "dependencies": {
+    "dotenv": "^17.4.2"
+  },
   "devDependencies": {
     "@eslint/js": "^9.39.1",
     "eslint": "^9.26.0",

packages/client/app-config.plugin.ts

@@ -0,0 +1,39 @@
+import { PluginOption } from "vite";
+
+//Load .env file
+import dotenv from "dotenv";
+dotenv.config({ quiet: true });
+
+import CONFIGURATION, { AppConfig } from "./components/common/lib/env";
+
+//Data for public config endpoint
+const appCfg = JSON.stringify({
+  api: CONFIGURATION.DEFAULT_API_URL,
+  gifbox: CONFIGURATION.DEFAULT_GIFBOX_URL,
+} as AppConfig);
+
+export default function appConfigPlugin(): PluginOption {
+  return {
+    name: "app-config",
+    //For dev / serve mode
+    configureServer(server) {
+      server.middlewares.use("/stoat-config.json", (_, res) => {
+        res.writeHead(200, {
+          "Content-Type": "application/json",
+          "Access-Control-Allow-Origin": "*",
+        });
+        res.end(appCfg);
+      });
+    },
+    //For static build
+    buildStart() {
+      //TODO: This throws warning "context method emitFile() is not supported in serve mode. This plugin is likely not vite-compatible."
+      //Need to add a conditional and detect serve mode somehow
+      this.emitFile({
+        fileName: "stoat-config.json",
+        source: appCfg,
+        type: "asset",
+      });
+    },
+  };
+}

packages/client/components/common/lib/env.ts

@@ -1,7 +1,19 @@
+export const STOAT_API = "https://api.stoat.chat";
+
+//Run in NodeJS mode
+if (!("env" in import.meta))
+  (import.meta as { env: NodeJS.ProcessEnv }).env = process.env;
+
+/** App `/.stoat-config` endpoint response */
+export interface AppConfig {
+  api: string;
+  gifbox: string;
+}
+
 const DEFAULT_API_URL =
   (import.meta.env.DEV ? import.meta.env.VITE_DEV_API_URL : undefined) ??
   (import.meta.env.VITE_API_URL as string) ??
-  "https://stoat.chat/api";
+  STOAT_API;
 
 export default {
   /**
@@ -22,6 +34,7 @@ export default {
     "https://revolt.chat/api",
     // ... and now:
     "https://stoat.chat/api",
+    STOAT_API,
   ].includes(DEFAULT_API_URL),
   /**
    * What WS server to connect to by default.

packages/client/vite.config.ts

@@ -9,6 +9,7 @@ import { VitePWA } from "vite-plugin-pwa";
 import solidPlugin from "vite-plugin-solid";
 import solidSvg from "vite-plugin-solid-svg";
 
+import appConfigPlugin from "./app-config.plugin";
 import codegenPlugin from "./codegen.plugin";
 
 const base = process.env.BASE_PATH ?? "/";
@@ -19,6 +20,7 @@ export default defineConfig({
     Inspect(),
     devtools(),
     codegenPlugin(),
+    appConfigPlugin(),
     babelMacrosPlugin(),
     linguiSolidPlugin(),
     solidPlugin(),