@sjolystinnovation/app-kit 0.9.0 → 0.10.0

package/README.md

@@ -309,6 +309,45 @@ export const POST = createRevalidateRoute({
 });
 ```
 
+### `@sjolystinnovation/app-kit/next-config`
+
+For `next.config.ts`. It imports nothing but Next's types, so Next loads it with no build step.
+
+`defineAppConfig(options, extra?)` gives the config every app shares: the standalone build, app-kit
+in `transpilePackages`, no `X-Powered-By`, `expireTime` of five minutes, image qualities 75 and 100,
+the incremental cache in memory, and the security headers on every page. `extra` is merged over it,
+with `transpilePackages`, `images`, `headers` and `rewrites` combined rather than replaced.
+
+```ts
+// next.config.ts
+import { defineAppConfig } from "@sjolystinnovation/app-kit/next-config";
+
+export default defineAppConfig({
+  apiUrl: process.env.NEXT_PUBLIC_API_URL,
+  dev: process.env.NODE_ENV !== "production",
+  contentImages: true,
+});
+```
+
+| Option | Type | Description |
+| --- | --- | --- |
+| `apiUrl` | `string \| undefined` | The API URL. Its origin is allowed in `connect-src`. |
+| `dev` | `boolean` | Development builds also allow `'unsafe-eval'`, which hot reload needs. |
+| `websocket` | `boolean` | Also allow `ws:` and `wss:` to the API origin, for SignalR. |
+| `imgFromApi` | `boolean` | Also allow images from the API origin. Not needed with `contentImages`. |
+| `contentImages` | `boolean` | Proxy `/content-images/*` to the API's `/content-images/*`, so the browser never contacts the API host. |
+| `connectSrc`, `imgSrc` | `string[]` | Extra sources for those directives. |
+| `frameSrc`, `objectSrc` | `string[]` | Sources for those directives. Both default to `'none'`. |
+| `pathHeaders` | `{ source, headers }[]` | Headers for particular paths, such as a file download. They come after the page headers and replace a page header of the same name. Every path keeps the rest. |
+| `permissionsPolicy` | `string` | Replaces `camera=(), microphone=(), geolocation=()`. |
+| `expireTime` | `number` | Seconds a cache may serve a stale page. Defaults to 300. Next's default is a year. |
+| `isrFlushToDisk` | `boolean` | Write revalidated pages to disk. Off by default, for a read-only root filesystem. |
+
+The pieces are exported too: `securityHeaders(options)`, `contentSecurityPolicy(options)`,
+`contentImagesRewrite(apiUrl, { source?, upstreamPath? })`, `apiOrigin(apiUrl)` and
+`apiBaseUrl(apiUrl)`. Scripts allow `'unsafe-inline'`, since a nonce would make every statically
+rendered page dynamic.
+
 ### `@sjolystinnovation/app-kit/session`
 
 Decides when a user has to sign in again. Safe to import from server code, such as the next-auth

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sjolystinnovation/app-kit",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Building blocks for Next.js apps that sign in against a JWT API through next-auth",
   "license": "Apache-2.0",
   "author": "Sjølyst Innovation AS",
@@ -25,6 +25,7 @@
     "./ui": "./src/ui/index.ts",
     "./toast": "./src/toast/index.ts",
     "./validation": "./src/validation/index.ts",
+    "./next-config": "./src/next-config/index.ts",
     "./styles.css": "./src/styles.css"
   },
   "files": [

package/src/next-config/index.ts

@@ -0,0 +1,154 @@
+import type { NextConfig } from "next";
+
+/** A response header, as `next.config.ts` lists them. */
+export interface Header {
+  key: string;
+  value: string;
+}
+
+/** The API's origin, such as `https://api.example.com`. Empty when the URL is missing or invalid. */
+export function apiOrigin(apiUrl: string | undefined): string {
+  if (!apiUrl) return "";
+  try {
+    return new URL(apiUrl).origin;
+  } catch {
+    return "";
+  }
+}
+
+/** The API's base URL with its path, such as `https://api.example.com/api`, without a trailing slash. Empty when missing or invalid. */
+export function apiBaseUrl(apiUrl: string | undefined): string {
+  if (!apiUrl) return "";
+  try {
+    return new URL(apiUrl).toString().replace(/\/$/, "");
+  } catch {
+    return "";
+  }
+}
+
+export interface CspOptions {
+  /** The app's API URL, usually `process.env.NEXT_PUBLIC_API_URL`. Its origin may be fetched from. */
+  apiUrl: string | undefined;
+  /** Development builds also allow `'unsafe-eval'`, which hot reload needs. */
+  dev: boolean;
+  /** Also allow `ws:` and `wss:` to the API, for a WebSocket such as SignalR. */
+  websocket?: boolean | undefined;
+  /** Also allow images from the API origin. Not needed when images go through the content images rewrite. */
+  imgFromApi?: boolean | undefined;
+  /** Extra sources for `connect-src`. */
+  connectSrc?: readonly string[] | undefined;
+  /** Extra sources for `img-src`. */
+  imgSrc?: readonly string[] | undefined;
+  /** Sources for `frame-src`. Defaults to `'none'`, since no page embeds a frame. */
+  frameSrc?: readonly string[] | undefined;
+  /** Sources for `object-src`. Defaults to `'none'`, since no page embeds an object. */
+  objectSrc?: readonly string[] | undefined;
+}
+
+const sources = (list: readonly (string | false | undefined)[]) => list.filter(Boolean).join(" ");
+
+/**
+ * The Content-Security-Policy for an app's pages. Scripts allow `'unsafe-inline'`, because a nonce
+ * would make every statically rendered page dynamic.
+ */
+export function contentSecurityPolicy(o: CspOptions): string {
+  const origin = apiOrigin(o.apiUrl);
+  const wsOrigin = o.websocket ? origin.replace(/^https:/, "wss:").replace(/^http:/, "ws:") : "";
+  return [
+    "default-src 'self'",
+    o.dev ? "script-src 'self' 'unsafe-eval' 'unsafe-inline'" : "script-src 'self' 'unsafe-inline'",
+    "style-src 'self' 'unsafe-inline'",
+    `img-src ${sources(["'self'", o.imgFromApi && origin, "data:", "blob:", ...(o.imgSrc ?? [])])}`,
+    `connect-src ${sources(["'self'", origin, wsOrigin, ...(o.connectSrc ?? [])])}`,
+    `frame-src ${sources(o.frameSrc ?? ["'none'"])}`,
+    `object-src ${sources(o.objectSrc ?? ["'none'"])}`,
+    "font-src 'self'",
+    "base-uri 'self'",
+    "form-action 'self'",
+    "frame-ancestors 'none'",
+    "upgrade-insecure-requests",
+  ].join("; ");
+}
+
+/** The security headers for an app's pages, including the Content-Security-Policy. */
+export function securityHeaders(o: CspOptions & { permissionsPolicy?: string | undefined }): Header[] {
+  return [
+    { key: "X-Content-Type-Options", value: "nosniff" },
+    { key: "X-Frame-Options", value: "DENY" },
+    { key: "Referrer-Policy", value: "strict-origin-when-cross-origin" },
+    { key: "X-DNS-Prefetch-Control", value: "on" },
+    { key: "Permissions-Policy", value: o.permissionsPolicy ?? "camera=(), microphone=(), geolocation=()" },
+    { key: "Strict-Transport-Security", value: "max-age=31536000; includeSubDomains" },
+    { key: "Content-Security-Policy", value: contentSecurityPolicy(o) },
+  ];
+}
+
+/**
+ * Content images, proxied so the browser never contacts the API host. A rewrite rather than a route
+ * handler, so the query string and the Accept header, which webp needs, pass through. No rewrite
+ * when the API URL is missing or invalid.
+ */
+export function contentImagesRewrite(apiUrl: string | undefined, o: { source?: string | undefined; upstreamPath?: string | undefined } = {}) {
+  const base = apiBaseUrl(apiUrl);
+  if (!base) return [];
+  const source = o.source ?? "/content-images";
+  const upstream = o.upstreamPath ?? "/content-images";
+  return [{ source: `${source}/:path*`, destination: `${base}${upstream}/:path*` }];
+}
+
+export interface AppConfigOptions extends CspOptions {
+  /** Proxy `/content-images/*` to the API. See `contentImagesRewrite`. */
+  contentImages?: boolean | undefined;
+  /**
+   * Headers for particular paths. Every path gets the page headers, and these come after them, so
+   * they replace a page header of the same name.
+   */
+  pathHeaders?: readonly { source: string; headers: Header[] }[] | undefined;
+  /** Replaces the default Permissions-Policy. */
+  permissionsPolicy?: string | undefined;
+  /**
+   * Seconds a cache may go on serving a page after it goes stale. Next's default is a year, long
+   * enough for a browser to hand back an old page and fetch the current one behind it. Defaults to
+   * 300, matching the client router cache's stale time.
+   */
+  expireTime?: number | undefined;
+  /**
+   * Write revalidated pages to disk. Off by default: with a read-only root filesystem Next cannot
+   * write to `.next/server/app`, so the incremental cache stays in memory.
+   */
+  isrFlushToDisk?: boolean | undefined;
+}
+
+/**
+ * The shared Next config for an app: the standalone build, app-kit transpiled, no `X-Powered-By`,
+ * the security headers on every page, and optionally the content images rewrite. `extra` is merged
+ * over it, with `transpilePackages` and `images` combined.
+ */
+export function defineAppConfig(o: AppConfigOptions, extra: NextConfig = {}): NextConfig {
+  const pageHeaders = securityHeaders(o);
+  const paths = o.pathHeaders ?? [];
+
+  const { transpilePackages, images, experimental, headers: extraHeaders, rewrites: extraRewrites, ...rest } = extra;
+  return {
+    output: "standalone",
+    poweredByHeader: false,
+    expireTime: o.expireTime ?? 300,
+    ...rest,
+    transpilePackages: [...new Set(["@sjolystinnovation/app-kit", ...(transpilePackages ?? [])])],
+    images: { qualities: [75, 100], ...images },
+    experimental: { isrFlushToDisk: o.isrFlushToDisk ?? false, ...experimental },
+    async headers() {
+      // Every path gets the page headers. Next lets a later rule replace a header of the same name,
+      // so a path's own headers come after them.
+      const own = [{ source: "/:path*", headers: pageHeaders }, ...paths.map(p => ({ source: p.source, headers: p.headers }))];
+      return [...own, ...((await extraHeaders?.()) ?? [])];
+    },
+    async rewrites() {
+      const own = o.contentImages ? contentImagesRewrite(o.apiUrl) : [];
+      const more = await extraRewrites?.();
+      if (!more) return own;
+      if (Array.isArray(more)) return [...own, ...more];
+      return { ...more, afterFiles: [...own, ...(more.afterFiles ?? [])] };
+    },
+  };
+}