nylorun 0.12.0-beta → 0.12.1-beta

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # nylorun
 
+## 0.12.1-beta
+
+### Patch Changes
+
+- 7780b2f: **One client and connection layer.** The Project link and credentials are read one way, and every Runtime client shares one `/health` probe.
+
+  - `@nylorun/core`: `@nylorun/core/project` (Node only, the one Core subpath that imports Node modules) reads the Nylorun home, a local Tenant's Host root (`tenantHostRoot`), the Project root (`findProjectRoot`) and the Project link and credentials (`findLinkedProject`, `readProjectLink`, `readCredentialsFile`), validated with `ProjectLinkFileSchema` and `ProjectCredentialsFileSchema`; a broken or newer file throws `ProjectFileError`. `@nylorun/core/transport` (browser-safe) holds the `/health` compatibility probe (`checkHealth`), `parseProtocolRange` (on `ProtocolRangeSchema`, ignoring fields a newer Host adds), `describeIncompatibility`, `requestHeaders` and `readBody`.
+  - `@nylorun/agents`: `resolveConnection` and `createClient()` find the Project as every reader does: the nearest directory with `.nylorun/` from `cwd` upwards, never the home directory or above it (they used to walk to the filesystem root, and past a `.nylorun/` without a link). A link without `credentials.json`, or a link or credentials file that does not validate, is now `connection_missing` naming the file and `npx nylorun start`, instead of a raw file-system or parse error. `@nylorun/agents/client` loads the link reader only when `createClient()` resolves a connection, so it imports no Node module. The root entry re-exports `checkHealth`, `describeIncompatibility` and `parseProtocolRange`.
+  - `@nylorun/admin`: `createAdmin` reads the Project link with the same reader. A link that does not validate is now refused like one from an older nylorun (when nothing else names the Host root), and a linked Project's `credentials.json` that does not validate is `connection_missing` instead of being skipped. `@nylorun/admin/project` re-exports `@nylorun/core/project` for tools that depend on this package. The `/health` check and request headers come from `@nylorun/core/transport`.
+  - `nylorun`: reads the Project link and credentials with `@nylorun/core/project`; a credentials file whose keys are not 64 hex characters is replaced by `start`, as an unreadable one was. No command changes.
+  - `@nylorun/cli`: `nylo` reads the Project root, link and credentials through `@nylorun/admin/project` instead of its own copies, with the same messages. No command changes.
+  - `@nylorun/studio`: the server's Runtime compatibility probe is `checkHealth` from `@nylorun/agents`.
+
+- Pin core to the tested release.
+- Pin runtime to the tested release.
+- Pin studio to the tested release.
+- Updated dependencies [7780b2f]
+- Updated dependencies [070674d]
+  - @nylorun/core@0.18.0-beta
+
 ## 0.12.0-beta
 
 ### Major Changes

package/dist/project/link.d.ts

@@ -1,19 +1,12 @@
+import { projectCredentialsPath, projectLinkPath, type ProjectLink } from "@nylorun/core/project";
 /**
  * The Project link (`.nylorun/link.json`) and credentials (`.nylorun/credentials.json`).
  * `nylorun start` writes both, format 3: the local Tenant's name, its URL and Host id, and
  * the Tenant id as information (nothing in a request selects a Tenant). `start` replaces a link
- * of an older format.
+ * of an older format. Reading is `@nylorun/core/project`'s, which every client shares.
  */
-export interface ProjectLink {
-    format: 0 | 1 | 2 | 3;
-    /** The local Tenant's name (format 3). */
-    tenant?: string;
-    hostUrl: string;
-    hostId: string;
-    tenantId?: string;
-}
-export declare function linkPath(projectRoot: string): string;
-export declare function credentialsPath(projectRoot: string): string;
+export type { ProjectLink };
+export { projectLinkPath as linkPath, projectCredentialsPath as credentialsPath };
 /** The Project's link, or undefined when it has none. An unreadable link is an error. */
 export declare function readProjectLink(projectRoot: string): Promise<ProjectLink | undefined>;
 export declare function writeProjectLink(projectRoot: string, link: {
@@ -37,9 +30,8 @@ export interface KeyCredentials {
 /** The Project's keys, or undefined when absent or unreadable. */
 export declare function readProjectCredentials(projectRoot: string): Promise<KeyCredentials | undefined>;
 /**
- * A credentials file (`{ format: 1, applicationKey, principalId, managementKey?,
- * managementPrincipalId? }`): the Project's, or one the nylorun commands keep in the Host root.
- * Undefined when absent or unreadable.
+ * A credentials file (format 0 or 1): the Project's, or one the nylorun commands keep in the
+ * Host root. Undefined when absent or unreadable, so `start` replaces it.
  */
 export declare function readCredentialsFile(path: string): Promise<KeyCredentials | undefined>;
 /** `.nylorun/credentials.json` (format 1, mode 0600). */

package/dist/project/link.js

@@ -1,43 +1,19 @@
 import { randomBytes } from "node:crypto";
-import { chmod, mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
+import { chmod, mkdir, rename, rm, writeFile } from "node:fs/promises";
 import { join } from "node:path";
-import { ProjectLinkFileSchema } from "@nylorun/core/contracts";
+import { ProjectFileError, projectCredentialsPath, projectLinkPath, readCredentialsFile as readCredentials, readProjectLink as readLink, } from "@nylorun/core/project";
 import { CliError } from "../errors.js";
-export function linkPath(projectRoot) {
-    return join(projectRoot, ".nylorun", "link.json");
-}
-export function credentialsPath(projectRoot) {
-    return join(projectRoot, ".nylorun", "credentials.json");
-}
+export { projectLinkPath as linkPath, projectCredentialsPath as credentialsPath };
 /** The Project's link, or undefined when it has none. An unreadable link is an error. */
 export async function readProjectLink(projectRoot) {
-    let text;
     try {
-        text = await readFile(linkPath(projectRoot), "utf8");
+        return readLink(projectRoot);
     }
     catch (error) {
-        if (error.code === "ENOENT")
-            return undefined;
+        if (error instanceof ProjectFileError)
+            throw new CliError(`Invalid or newer Project link at ${error.path}. Upgrade nylorun, or remove the file and run "npx nylorun start" again.`, 1);
         throw error;
     }
-    let value;
-    try {
-        value = JSON.parse(text);
-    }
-    catch {
-        value = undefined;
-    }
-    const parsed = ProjectLinkFileSchema.safeParse(value);
-    if (!parsed.success)
-        throw new CliError(`Invalid or newer Project link at ${linkPath(projectRoot)}. Upgrade nylorun, or remove the file and run "npx nylorun start" again.`, 1);
-    const link = parsed.data;
-    return {
-        format: link.format,
-        ...(link.format === 3 && link.tenant ? { tenant: link.tenant } : {}),
-        hostUrl: link.hostUrl.replace(/\/$/, ""),
-        hostId: link.hostId,
-        ...(link.tenantId ? { tenantId: link.tenantId } : {}),
-    };
 }
 async function writePrivate(path, value) {
     const temporary = `${path}.${randomBytes(8).toString("hex")}.tmp`;
@@ -59,7 +35,7 @@ async function ensureProjectDir(projectRoot) {
 }
 export async function writeProjectLink(projectRoot, link) {
     await ensureProjectDir(projectRoot);
-    await writePrivate(linkPath(projectRoot), {
+    await writePrivate(projectLinkPath(projectRoot), {
         format: 3,
         tenant: link.tenant,
         hostUrl: link.hostUrl.replace(/\/$/, ""),
@@ -69,34 +45,34 @@ export async function writeProjectLink(projectRoot, link) {
 }
 /** The Project's keys, or undefined when absent or unreadable. */
 export async function readProjectCredentials(projectRoot) {
-    return await readCredentialsFile(credentialsPath(projectRoot));
+    return await readCredentialsFile(projectCredentialsPath(projectRoot));
 }
 /**
- * A credentials file (`{ format: 1, applicationKey, principalId, managementKey?,
- * managementPrincipalId? }`): the Project's, or one the nylorun commands keep in the Host root.
- * Undefined when absent or unreadable.
+ * A credentials file (format 0 or 1): the Project's, or one the nylorun commands keep in the
+ * Host root. Undefined when absent or unreadable, so `start` replaces it.
  */
 export async function readCredentialsFile(path) {
+    let value;
     try {
-        const value = JSON.parse(await readFile(path, "utf8"));
-        if (typeof value.applicationKey !== "string" || typeof value.principalId !== "string")
-            return undefined;
-        return {
-            applicationKey: value.applicationKey,
-            principalId: value.principalId,
-            ...(typeof value.managementKey === "string" && typeof value.managementPrincipalId === "string"
-                ? { management: { key: value.managementKey, principalId: value.managementPrincipalId } }
-                : {}),
-        };
+        value = readCredentials(path);
     }
     catch {
         return undefined;
     }
+    if (!value)
+        return undefined;
+    return {
+        applicationKey: value.applicationKey,
+        principalId: value.principalId,
+        ...(value.managementKey && value.managementPrincipalId
+            ? { management: { key: value.managementKey, principalId: value.managementPrincipalId } }
+            : {}),
+    };
 }
 /** `.nylorun/credentials.json` (format 1, mode 0600). */
 export async function writeProjectCredentials(projectRoot, credentials) {
     await ensureProjectDir(projectRoot);
-    await writeCredentialsFile(credentialsPath(projectRoot), credentials);
+    await writeCredentialsFile(projectCredentialsPath(projectRoot), credentials);
 }
 /** A credentials file (format 1), written atomically with mode 0600. */
 export async function writeCredentialsFile(path, credentials) {

package/dist/stack/commands.js

@@ -2,9 +2,9 @@ import { existsSync } from "node:fs";
 import { mkdir, readFile, rm } from "node:fs/promises";
 import { basename, resolve } from "node:path";
 import { compareVersions } from "@nylorun/core/compatibility";
+import { findProjectRoot } from "@nylorun/core/project";
 import { CliError } from "../errors.js";
 import { credentialsPath, readCredentialsFile, readProjectCredentials, readProjectLink, writeProjectCredentials, writeProjectLink, } from "../project/link.js";
-import { findProjectRoot } from "../project/root.js";
 import { seedTenant } from "../project/seed.js";
 import { readTelemetry, STUDIO_ANALYTICS_ID, TELEMETRY_NOTICE, telemetryDecision, writeTelemetry, } from "../telemetry.js";
 import { dockerPreflight, formatBytes, parseComposePs, tenantMemory, } from "./docker.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylorun",
-  "version": "0.12.0-beta",
+  "version": "0.12.1-beta",
   "type": "module",
   "license": "Apache-2.0",
   "description": "Set up and run local Nylorun Tenants (Runtime and Studio) with Docker Compose",
@@ -30,7 +30,7 @@
     "prepack": "npm run build"
   },
   "dependencies": {
-    "@nylorun/core": "0.17.0-beta"
+    "@nylorun/core": "0.18.0-beta"
   },
   "devDependencies": {
     "typescript": "npm:@typescript/typescript6@^6.0.2",
@@ -41,7 +41,7 @@
     "nylorun": "dist/cli.js"
   },
   "nylorun": {
-    "runtime": "0.21.0-beta",
-    "studio": "0.23.0-beta"
+    "runtime": "0.21.1-beta",
+    "studio": "0.23.1-beta"
   }
 }

package/dist/home.d.ts

@@ -1,6 +0,0 @@
-/**
- * The Host root: an explicit home, `NYLORUN_HOME`, or `~/.nylorun`. Compose
- * bind-mounts it into the Runtime and Studio containers, and `@nylorun/admin`
- * reads `host.json` and the admin key from it.
- */
-export declare function resolveHome(home?: string, env?: Readonly<Record<string, string | undefined>>): string;

package/dist/home.js

@@ -1,15 +0,0 @@
-import { homedir } from "node:os";
-import { join, resolve } from "node:path";
-/**
- * The Host root: an explicit home, `NYLORUN_HOME`, or `~/.nylorun`. Compose
- * bind-mounts it into the Runtime and Studio containers, and `@nylorun/admin`
- * reads `host.json` and the admin key from it.
- */
-export function resolveHome(home, env = process.env) {
-    if (home !== undefined && home.trim() !== "")
-        return resolve(home);
-    const fromEnv = env.NYLORUN_HOME?.trim();
-    if (fromEnv)
-        return resolve(fromEnv);
-    return resolve(join(homedir(), ".nylorun"));
-}

package/dist/project/root.d.ts

@@ -1,7 +0,0 @@
-/**
- * The nearest `.nylorun` wins so an initialised Project keeps working from a
- * subdirectory; otherwise the nearest package.json defines the Project. The
- * walk stops at the home directory because `~/.nylorun` is the Host root, never
- * a Project root.
- */
-export declare function findProjectRoot(cwd?: string): string | undefined;

package/dist/project/root.js

@@ -1,44 +0,0 @@
-import { existsSync, realpathSync } from "node:fs";
-import { homedir } from "node:os";
-import { dirname, join, parse, resolve } from "node:path";
-/**
- * The nearest `.nylorun` wins so an initialised Project keeps working from a
- * subdirectory; otherwise the nearest package.json defines the Project. The
- * walk stops at the home directory because `~/.nylorun` is the Host root, never
- * a Project root.
- */
-export function findProjectRoot(cwd = process.cwd()) {
-    const stop = (() => {
-        try {
-            return realpathSync(homedir());
-        }
-        catch {
-            return homedir();
-        }
-    })();
-    let directory = resolve(cwd);
-    try {
-        directory = realpathSync(directory);
-    }
-    catch {
-        /* unresolvable cwd falls through */
-    }
-    const root = parse(directory).root;
-    let fallback;
-    for (;;) {
-        // The home directory is never a Project, but a package.json below it is.
-        if (directory === stop)
-            return fallback;
-        if (existsSync(join(directory, ".nylorun")))
-            return directory;
-        if (!fallback && existsSync(join(directory, "package.json")))
-            fallback = directory;
-        if (directory === root)
-            break;
-        const parent = dirname(directory);
-        if (parent === directory)
-            break;
-        directory = parent;
-    }
-    return fallback;
-}