@flytedesk/app-kit 0.7.1 → 1.0.0

package/dist/spa-server/index.d.ts

@@ -0,0 +1,53 @@
+/**
+ * A small, dependency-light static file server for a built single-page app — AK-18.
+ * Generalizes media-planner's `apps/web/server.mjs` (the one that actually has the
+ * fix: hashed assets served immutable with a year-long max-age, `index.html` and every
+ * SPA-fallback route served `no-cache`) so every `@flytedesk/app-kit` consumer's web
+ * Docker image runs THIS, instead of each one hand-rolling — or, worse, silently
+ * dropping — the same ~25 lines. sms-app's own `apps/web/server.mjs` is exactly that:
+ * a copy created without the Cache-Control fix, which is the real stale-bundle bug
+ * media-planner's version exists to prevent (a user saw a broken login button keep
+ * loading a stale bundle across a same-day deploy until a hard refresh).
+ *
+ * Uses `sirv` (the library, not `sirv-cli`) for the same reason media-planner's version
+ * does: `sirv-cli`'s flags can't express a DIFFERENT Cache-Control per path, only one
+ * value for the whole tree.
+ */
+import { type Server } from "node:http";
+export interface SpaServerOptions {
+    /** Directory containing the built SPA (e.g. Vite's "dist"). */
+    dir: string;
+    /** Path prefix under which Vite (or an equivalent bundler) content-hashes every
+     *  filename — those never need revalidating, since a new build produces new
+     *  filenames instead of overwriting these. Default "/assets/" (Vite's own default
+     *  output directory). Everything else — `index.html`, and every SPA-fallback route
+     *  that resolves to it — is served `no-cache`: its own filename never changes
+     *  between deploys, so without this, browsers' heuristic caching can keep serving a
+     *  stale HTML shell (and the old JS bundle it references) long after a new deploy
+     *  has shipped. This is not a hypothetical: it is the exact bug media-planner hit in
+     *  production, which is why this rule exists at all. */
+    assetPrefix?: string;
+}
+/** Builds the request handler — everything BUT actually binding a port, so a consumer
+ *  that already owns an HTTP server (or wants to compose this behind its own routing)
+ *  can still get the same Cache-Control behaviour. `serveSpa` (below) is the one-call
+ *  version for a consumer that just wants a running server. */
+export declare function createSpaServer(options: SpaServerOptions): Server;
+export interface ServeSpaOptions extends SpaServerOptions {
+    /** Default 8080 (Cloud Run's own default, and every @flytedesk app's web image's
+     *  current EXPOSE). */
+    port?: number;
+    /** Default "0.0.0.0" — every @flytedesk app's web image runs this inside a
+     *  container, where the request arrives on the container's external interface, not
+     *  loopback. */
+    host?: string;
+    /** Called once the server is actually listening, with the resolved port — e.g. to
+     *  log it. Default: logs "web listening on :{port}" to stdout, matching what every
+     *  @flytedesk app's web image already logs today. */
+    onListening?: (port: number) => void;
+}
+/** The one-call version: builds the server (see createSpaServer) and starts it
+ *  listening. An app's web Docker image's ENTIRE runtime CMD is calling this (or the
+ *  CLI wrapper, ./cli.js) — no per-app server.mjs to keep in sync with the Cache-Control
+ *  fix any more. */
+export declare function serveSpa(options: ServeSpaOptions): Server;

package/dist/spa-server/index.js

@@ -0,0 +1,50 @@
+/**
+ * A small, dependency-light static file server for a built single-page app — AK-18.
+ * Generalizes media-planner's `apps/web/server.mjs` (the one that actually has the
+ * fix: hashed assets served immutable with a year-long max-age, `index.html` and every
+ * SPA-fallback route served `no-cache`) so every `@flytedesk/app-kit` consumer's web
+ * Docker image runs THIS, instead of each one hand-rolling — or, worse, silently
+ * dropping — the same ~25 lines. sms-app's own `apps/web/server.mjs` is exactly that:
+ * a copy created without the Cache-Control fix, which is the real stale-bundle bug
+ * media-planner's version exists to prevent (a user saw a broken login button keep
+ * loading a stale bundle across a same-day deploy until a hard refresh).
+ *
+ * Uses `sirv` (the library, not `sirv-cli`) for the same reason media-planner's version
+ * does: `sirv-cli`'s flags can't express a DIFFERENT Cache-Control per path, only one
+ * value for the whole tree.
+ */
+import { createServer } from "node:http";
+import sirv from "sirv";
+/** Builds the request handler — everything BUT actually binding a port, so a consumer
+ *  that already owns an HTTP server (or wants to compose this behind its own routing)
+ *  can still get the same Cache-Control behaviour. `serveSpa` (below) is the one-call
+ *  version for a consumer that just wants a running server. */
+export function createSpaServer(options) {
+    const assetPrefix = options.assetPrefix ?? "/assets/";
+    const serve = sirv(options.dir, {
+        single: true,
+        etag: true,
+        setHeaders(res, pathname) {
+            res.setHeader("Cache-Control", pathname.startsWith(assetPrefix) ? "public, max-age=31536000, immutable" : "no-cache");
+        },
+    });
+    return createServer((req, res) => {
+        serve(req, res, () => {
+            res.statusCode = 404;
+            res.end("Not found");
+        });
+    });
+}
+/** The one-call version: builds the server (see createSpaServer) and starts it
+ *  listening. An app's web Docker image's ENTIRE runtime CMD is calling this (or the
+ *  CLI wrapper, ./cli.js) — no per-app server.mjs to keep in sync with the Cache-Control
+ *  fix any more. */
+export function serveSpa(options) {
+    const server = createSpaServer(options);
+    const port = options.port ?? 8080;
+    const host = options.host ?? "0.0.0.0";
+    const onListening = options.onListening ?? ((p) => console.log(`web listening on :${p}`));
+    server.listen(port, host, () => onListening(port));
+    return server;
+}
+//# sourceMappingURL=index.js.map

package/dist/spa-server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/spa-server/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,YAAY,EAA0D,MAAM,WAAW,CAAC;AACjG,OAAO,IAAI,MAAM,MAAM,CAAC;AAiBxB;;;+DAG+D;AAC/D,MAAM,UAAU,eAAe,CAAC,OAAyB;IACvD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,UAAU,CAAC;IACtD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;QAC9B,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,IAAI;QACV,UAAU,CAAC,GAAG,EAAE,QAAQ;YACtB,GAAG,CAAC,SAAS,CACX,eAAe,EACf,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,qCAAqC,CAAC,CAAC,CAAC,UAAU,CACtF,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;IACH,OAAO,YAAY,CAAC,CAAC,GAAoB,EAAE,GAAmB,EAAE,EAAE;QAChE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;YACnB,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAgBD;;;oBAGoB;AACpB,MAAM,UAAU,QAAQ,CAAC,OAAwB;IAC/C,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,SAAS,CAAC;IACvC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC;IAClG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flytedesk/app-kit",
-  "version": "0.7.1",
+  "version": "1.0.0",
   "description": "Shared platform kit for flytedesk apps: flytedesk-id auth (BFF/OIDC client) and a Postgres-native trace/audit layer.",
   "type": "module",
   "license": "UNLICENSED",
@@ -30,13 +30,18 @@
   "bin": {
     "trace-sync": "./dist/cli/trace-sync.js",
     "profile-sync": "./dist/cli/profile-sync.js",
-    "flags-sync": "./dist/cli/flags-sync.js"
+    "flags-sync": "./dist/cli/flags-sync.js",
+    "spa-server": "./dist/spa-server/cli.js"
   },
   "exports": {
     "./auth": {
       "types": "./dist/auth/index.d.ts",
       "import": "./dist/auth/index.js"
     },
+    "./auth/plugin": {
+      "types": "./dist/auth/plugin.d.ts",
+      "import": "./dist/auth/plugin.js"
+    },
     "./auth/testing": {
       "types": "./dist/auth/testing/index.d.ts",
       "import": "./dist/auth/testing/index.js"
@@ -68,6 +73,10 @@
     "./chat": {
       "types": "./dist/chat/index.d.ts",
       "import": "./dist/chat/index.js"
+    },
+    "./spa-server": {
+      "types": "./dist/spa-server/index.d.ts",
+      "import": "./dist/spa-server/index.js"
     }
   },
   "scripts": {
@@ -131,12 +140,14 @@
     "testcontainers": "^12.1.0",
     "typescript": "^7.0.2",
     "typescript-eslint": "^8.69.0",
+    "undici": "^8.11.2",
     "vitest": "^4.1.11"
   },
   "dependencies": {
     "@fastify/cookie": "^11.0.1",
     "cross-spawn": "^7.0.6",
     "fastify-plugin": "^6.0.0",
-    "jose": "^6.2.10"
+    "jose": "^6.2.10",
+    "sirv": "^3.0.2"
   }
 }