@uniflowed/config 0.0.0-alpha.18 → 0.0.0-alpha.20

package/internal/schema.js

@@ -74,7 +74,17 @@ export type PackageManagerPreference =
   | "bun";
 // uf-lint-enable uniflowed/no-npm-script-invocation
 
-export type RuntimeEngine = "uf" | "node" | "deno" | "bun" | "edge" | "serverless" | "container";
+// The runtimes a project may say it is written for, which are the runtimes uf
+// has a host for. It read `"uf" | ... | "edge" | "serverless" | "container"`,
+// and those four are rows `uf_runtime::HOSTS` grades planned with no Flow
+// loader — so a project that named one could not import its own first file
+// there, and every command went on running on Node anyway. uf refuses them at
+// the key that named them now; this type is where a reader finds that out
+// before `uf check` does. See docs/hosts.md and ubugeeei-prod/uf#246.
+//
+// A deployment target is `DeployAdapter`, on `app.runtime.deploy`, and is a
+// different question with a longer list.
+export type RuntimeEngine = "node" | "deno" | "bun";
 
 export type DeployAdapter =
   | "node"
@@ -359,12 +369,34 @@ export type UniflowedConfig = {
       readonly enabled?: boolean,
     },
     readonly rendering?: {
-      readonly modes?: $ReadOnlyArray<"ppr" | "ssr" | "ssg" | "isr">,
+      // `"csr"` is the one value that cannot share the list: it renders every
+      // route in the browser from one shell, where the others write a document
+      // per route, so there is no per-route choice left for the list to hold.
+      // `["csr"]` is a single-page application; see docs/app/guide/rendering.
+      readonly modes?: $ReadOnlyArray<"ppr" | "ssr" | "ssg" | "isr" | "csr">,
+      // What the browser does when a visitor follows a link, which is a
+      // different question from `modes` rather than a fifth value in it:
+      // `modes` says where a document comes from, per route, and this says
+      // what happens once the browser has one. `"document"` is a full document
+      // request — the client router is not installed and `Link` renders an
+      // ordinary anchor. See docs/app/guide/routing/navigation.
+      readonly navigation?: "client" | "document",
       readonly cache?: {
         readonly actions?: boolean,
         readonly data?: boolean,
         readonly fetch?: boolean,
         readonly route?: boolean,
+        // Where cache entries live, and the only thing here that is a *name*
+        // rather than a switch: `"memory"` (the default) is one process,
+        // `"filesystem"` is uf's built-in durable provider, and anything else
+        // is a module specifier exporting `createCacheProvider` — the same
+        // shape `builder.module` has, and for the same red line. Turning this
+        // on caches nothing new: a route still has to state a lifetime.
+        readonly store?: string,
+        // Where `"filesystem"` keeps them. Defaults to `.uf/cache/route` under
+        // the project. A deployment that has one writable directory — `/tmp` on
+        // a Lambda, a mounted volume in a container — names it here.
+        readonly storeDir?: string,
       },
     },
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniflowed/config",
-  "version": "0.0.0-alpha.18",
+  "version": "0.0.0-alpha.20",
   "description": "Flow declarations for @uniflowed/config, part of the Unified Toolchain for Flow.",
   "type": "module",
   "license": "MIT",
@@ -15,6 +15,7 @@
   },
   "files": [
     "index.js",
-    "internal"
+    "internal",
+    "!*.test.js"
   ]
 }