@jxsuite/site 2.4.0 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jxsuite/site",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "What a Jx project's page at a route consists of — routing, layout, context, head and the document that boots it",
   "license": "MIT",
   "repository": {
@@ -32,7 +32,7 @@
     "test:coverage": "bun test --isolate --coverage"
   },
   "dependencies": {
-    "@jxsuite/runtime": "^6.2.0",
-    "@jxsuite/schema": "^5.3.0"
+    "@jxsuite/runtime": "^6.2.1",
+    "@jxsuite/schema": "^5.4.0"
   }
 }

package/src/compose.ts

@@ -32,7 +32,7 @@ import { isNonNullObject, isString } from "@jxsuite/schema/guards";
 import { localeDirection, localeOfRoute, resolveI18n } from "@jxsuite/schema/locale";
 import { isNativeDocumentPath, parseNativeDocument } from "@jxsuite/schema/jxn";
 import type { JxDocument, JxElement, JxHeadEntry, ProjectConfig } from "@jxsuite/schema/types";
-import { PROJECT_FILE_NAME } from "@jxsuite/schema/project-file";
+import { PROJECT_FILE_NAMES, parseProjectSource } from "@jxsuite/schema/project-file";
 
 /** Everything the composer settled about a page before a renderer sees it. */
 export interface ComposedPage {
@@ -95,17 +95,28 @@ async function readDocument(io: SiteIO, path: string): Promise<JxDocument | null
   return io.parse ? ((await io.parse(path, text)) ?? null) : null;
 }
 
-/** The project's configuration, or an empty one when it has none this host can read. */
+/**
+ * The project's configuration, or an empty one when it has none this host can read.
+ *
+ * Both names are read, because a host that can only fetch has no other way to know which one a
+ * project has. A project with both has neither, as it has everywhere else (`site-architecture.md`
+ * §2.3).
+ */
 export async function readProjectConfig(io: SiteIO): Promise<ProjectConfig> {
-  const text = await io.read(PROJECT_FILE_NAME);
-  if (text === null) {
+  const texts = await Promise.all(PROJECT_FILE_NAMES.map((name) => io.read(name)));
+  const found = PROJECT_FILE_NAMES.flatMap((name, index) => {
+    const text = texts[index];
+    return text === null || text === undefined ? [] : [{ name, text }];
+  });
+  const [only] = found;
+  if (!only || found.length > 1) {
     return {};
   }
   try {
-    /* SAFETY: only the syntax is checked here, deliberately: every ProjectConfig member is
-       optional, and shape checking is `validateProject`'s job against the per-project schema,
-       which `jx build` runs and a live preview of a half-edited config must not refuse over. */
-    return JSON.parse(text) as ProjectConfig;
+    /* Only the syntax is checked here, deliberately: every ProjectConfig member is optional, and
+       shape checking is `validateProject`'s job against the per-project schema, which `jx build`
+       runs and a live preview of a half-edited config must not refuse over. */
+    return parseProjectSource(only.text, only.name);
   } catch {
     /* A project whose config does not parse still has pages, and refusing to render any of them
        would hide the one error the author can act on behind a blank origin. */

package/src/paths.ts

@@ -1,4 +1,4 @@
-import { PROJECT_FILE_NAME } from "@jxsuite/schema/project-file";
+import { PROJECT_FILE_NAMES } from "@jxsuite/schema/project-file";
 /**
  * What a site origin serves, and — the part that matters — what it refuses.
  *
@@ -42,7 +42,7 @@ export const SERVABLE_ROOTS: readonly string[] = [
  * them twice is nothing.
  */
 export const NEVER_SERVABLE: ReadonlySet<string> = new Set([
-  PROJECT_FILE_NAME,
+  ...PROJECT_FILE_NAMES,
   "package.json",
   "package-lock.json",
   "bun.lock",

package/src/serve.ts

@@ -149,15 +149,24 @@ export async function serveSite(
  *
  * The runtime fetches a `$ref` and calls `res.json()`, on any origin, so answering JSON here keeps
  * a KDL parser out of every page. A file that does not read answers 422 with the reason, because
- * the runtime reports a failed fetch by its status and this one is the author's to fix.
+ * the runtime reports a failed fetch by its status and this one is the author's to fix. The dev
+ * server's canvas origin answers the same way, with its own headers.
+ *
+ * @param bytes The file.
+ * @param path Its path, which names it in an error.
+ * @param headers The headers for a response of a media type.
  */
-function jxnAsJson(bytes: Uint8Array<ArrayBuffer>, path: string): Response {
+export function jxnAsJson(
+  bytes: Uint8Array<ArrayBuffer>,
+  path: string,
+  headers: (type: string) => HeadersInit = siteHeaders,
+): Response {
   try {
     const document = parseJxn(new TextDecoder().decode(bytes), path);
-    return Response.json(document, { headers: siteHeaders("application/json;charset=utf-8") });
+    return Response.json(document, { headers: headers("application/json;charset=utf-8") });
   } catch (error) {
     return new Response(errorMessage(error), {
-      headers: siteHeaders("text/plain;charset=utf-8"),
+      headers: headers("text/plain;charset=utf-8"),
       status: 422,
     });
   }