@hivemagnus/magnus 0.0.0-stage → 1.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,86 @@
-# Temporary Holding Version
+# @hivemagnus/magnus
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Install, upgrade and roll back a [Magnus](https://github.com/ChefTaco/magnus) server and console
+with one command.
+
+```bash
+npx @hivemagnus/magnus init       # create and start a project in ~/.magnus
+magnus upgrade                    # newest release of the current major, with backup and auto-revert
+magnus rollback                   # back to the previous version
+magnus status                     # versions, health, history, available updates
+```
+
+Each release of this package pins exact, tested versions of `@hivemagnus/magnus-server`,
+`@hivemagnus/magnus-ui` and `@hivemagnus/magnus-contracts`, together with the matching agent
+version. The pins and release notes ship as `magnusRelease` in `package.json`.
+
+## `magnus init`
+
+`init` creates a managed project: the configuration, the installed versions and the units that run
+them.
+
+```
+~/.magnus/
+  magnus-project.json            project state and history
+  package.json, package-lock.json  exact pins of the serving release
+  config/magnus-server.env       generated secrets (0600)
+  config/magnus-ui.env
+  config/tls/                    self-signed certificate (unless --tls-cert/--tls-key)
+  data/                          server data (MAGNUS_HOME: audit logs, rotation state)
+  versions/1.1.0/                one npm install per release
+  current -> versions/1.1.0      what the services run
+  backups/                       pre-migration database dumps
+  units/                         the generated systemd units
+  deps.compose.yml               PostgreSQL and Redis, when no --database-url/--redis-url is given
+```
+
+| Option | Meaning |
+|---|---|
+| `--system --service-user NAME` | System units in `/opt/magnus` (run as root) instead of user units |
+| `--database-url URL --redis-url URL` | Use your own PostgreSQL and Redis instead of the bundled compose file |
+| `--version X.Y.Z` | Install a specific release |
+| `--public-host NAME` | Host name for URLs and the certificate |
+| `--admin-user`, `--admin-password` | Console login (the password is generated and printed once by default) |
+| `--no-ui`, `--no-start`, `--no-auto-migrate` | Server only; configure without starting; keep `MAGNUS_AUTO_MIGRATE=false` |
+| `--supervisor none` | Write everything, but start the processes yourself |
+
+User services start at boot only with lingering enabled (`loginctl enable-linger $USER`).
+
+## `magnus upgrade`
+
+```bash
+magnus upgrade --dry-run     # releases, notes, new settings and migrations, without changing anything
+magnus upgrade [--to X.Y.Z] [--yes] [--generate-secrets] [--allow-major] [--source DIR]
+```
+
+An upgrade:
+
+1. Checks the registry and the Node.js engines.
+2. Refuses a downgrade or a major-version change (unless `--allow-major`).
+3. Checks for new required settings.
+4. Installs the release into `versions/<X>`.
+5. Dumps PostgreSQL, migrates and checks.
+6. Switches `./current`, restarts and waits for the new version to serve.
+7. If the new version is unhealthy, switches back and prints the database restore command.
+
+Slow or one-way migrations need `--yes`.
+
+`magnus-server upgrade` hands the same command to the project it was installed into.
+
+## `magnus adopt`
+
+Turns an existing npm install into a managed project without touching what runs:
+
+```bash
+npx @hivemagnus/magnus adopt --server-env-file /etc/magnus/server.env --ui-env-file /etc/magnus/ui.env
+```
+
+See [UPGRADING.md](https://github.com/ChefTaco/magnus/blob/main/UPGRADING.md) for every upgrade
+path, agent upgrades and the switches that turn automation off.
+
+Requires Node.js `^24.22.1` or `^26.13.0`, npm, systemd (or `--supervisor none`), and `openssl` for
+the self-signed certificate.
+
+## License
+
+Apache-2.0

package/dist/adopt.d.ts

@@ -0,0 +1,15 @@
+import type { Io } from './io.js';
+import { type Supervisor } from './project.js';
+export interface AdoptOptions {
+    dir?: string;
+    serverEnvFile: string;
+    uiEnvFile?: string;
+    version?: string;
+    system: boolean;
+    serviceUser?: string;
+    supervisor: Supervisor;
+    installUnits: boolean;
+    source?: string;
+    registry: string;
+}
+export declare function adopt(io: Io, options: AdoptOptions): Promise<number>;

package/dist/adopt.js

@@ -0,0 +1,98 @@
+/**
+ * `magnus adopt`: turn an existing npm install (1.0.x or later) into a
+ * managed project so `magnus upgrade` can take over. The env files stay where
+ * they are; the same version is installed under versions/ and new units point
+ * at ./current. Nothing running is touched unless --install-units is given.
+ */
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
+import { join, resolve } from 'node:path';
+import { isVersion } from '@hivemagnus/magnus-contracts';
+import { readEnvFile } from './env-file.js';
+import { installVersion, publishPins } from './install.js';
+import { acquireLock, Project } from './project.js';
+import { releaseFor } from './release.js';
+import { enableServices, unitDirectory } from './supervisor.js';
+import { serverUnit, uiUnit } from './templates.js';
+import { loadCatalog, UpgradeError } from './upgrade.js';
+import { defaultProjectDir } from './init.js';
+async function detectVersion(io) {
+    const result = await io.run('magnus-server', ['--version'], { capture: true }).catch(() => null);
+    const version = result?.code === 0 ? result.stdout.trim() : '';
+    return isVersion(version) ? version : null;
+}
+export async function adopt(io, options) {
+    if (options.system && !options.serviceUser)
+        throw new UpgradeError('--system needs --service-user <account the services run as>.');
+    const serverEnvFile = resolve(options.serverEnvFile);
+    if (!existsSync(serverEnvFile))
+        throw new UpgradeError(`--server-env-file ${serverEnvFile} does not exist`);
+    const uiEnvFile = options.uiEnvFile ? resolve(options.uiEnvFile) : undefined;
+    if (uiEnvFile && !existsSync(uiEnvFile))
+        throw new UpgradeError(`--ui-env-file ${uiEnvFile} does not exist`);
+    const dir = resolve(options.dir ?? defaultProjectDir(io, options.system));
+    if (Project.exists(dir))
+        throw new UpgradeError(`${dir} already holds a Magnus project.`);
+    const version = options.version ?? await detectVersion(io);
+    if (!version)
+        throw new UpgradeError('Could not detect the installed version; pass --version X.Y.Z (the output of `magnus-server --version`).');
+    const serverEnv = readEnvFile(serverEnvFile);
+    const uiEnv = uiEnvFile ? readEnvFile(uiEnvFile) : {};
+    const components = uiEnvFile ? ['server', 'ui'] : ['server'];
+    const state = {
+        schema: 1,
+        createdAt: io.now().toISOString(),
+        supervisor: options.supervisor,
+        scope: options.system ? 'system' : 'user',
+        components,
+        units: { server: 'magnus-server', ui: 'magnus-ui' },
+        envFiles: { server: serverEnvFile, ui: uiEnvFile ?? join('config', 'magnus-ui.env') },
+        database: { kind: 'external' },
+        ports: { server: Number(serverEnv['CONTROL_API_PORT'] ?? 4000), ui: Number(uiEnv['PORT'] ?? 3000) },
+        current: null,
+        previous: null,
+        keepVersions: 3,
+        history: [],
+    };
+    mkdirSync(dir, { recursive: true });
+    const project = new Project(dir, state);
+    const release = acquireLock(project.path('run', 'upgrade.lock'));
+    try {
+        for (const sub of ['backups', 'run', 'versions', 'units', 'ui-data'])
+            mkdirSync(project.path(sub), { recursive: true, mode: 0o750 });
+        const catalog = await loadCatalog(io, options);
+        io.log(`Adopting Magnus ${version} into ${dir} (env files stay in place)`);
+        await installVersion(io, project, releaseFor(catalog, version), catalog);
+        project.switchCurrent(version);
+        project.state.current = version;
+        project.record({ action: 'adopt', from: null, to: version, at: io.now().toISOString(), result: 'ok', migrations: [] });
+        publishPins(project, version);
+        project.save();
+        const unitOptions = { project, nodePath: process.execPath, serviceUser: options.serviceUser, afterUnits: [] };
+        const units = { 'magnus-server.service': serverUnit(unitOptions) };
+        if (uiEnvFile)
+            units['magnus-ui.service'] = uiUnit(unitOptions);
+        for (const [name, content] of Object.entries(units))
+            writeFileSync(project.path('units', name), content);
+        const target = unitDirectory(project, io.env);
+        if (options.installUnits && options.supervisor === 'systemd') {
+            mkdirSync(target, { recursive: true });
+            for (const [name, content] of Object.entries(units))
+                writeFileSync(join(target, name), content);
+            await enableServices(io, project);
+            io.log(`Installed ${Object.keys(units).join(', ')} into ${target}. Stop and disable your old units, then: systemctl ${options.system ? '' : '--user '}restart ${Object.keys(units).join(' ')}`);
+        }
+        else {
+            io.log([
+                `Generated units in ${project.path('units')}. To switch over:`,
+                '  1. stop and disable the units that run your current install',
+                `  2. copy ${project.path('units')}/*.service to ${target}/ and run: systemctl ${options.system ? '' : '--user '}daemon-reload`,
+                `  3. systemctl ${options.system ? '' : '--user '}enable --now ${Object.keys(units).join(' ')}`,
+                `Then upgrade with: magnus upgrade --dir ${dir}`,
+            ].join('\n'));
+        }
+        return 0;
+    }
+    finally {
+        release();
+    }
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+/** Entry point of the `magnus` command; see main.ts for the commands. */
+import { systemIo } from './io.js';
+import { ArgsError, run } from './main.js';
+run(systemIo(), process.argv.slice(2)).then((code) => process.exit(code), (error) => {
+    if (error instanceof ArgsError) {
+        console.error(`magnus: ${error.message}. Run \`magnus --help\` for usage.`);
+        process.exit(2);
+    }
+    console.error(`magnus: ${error instanceof Error ? error.message : String(error)}`);
+    if (process.env['MAGNUS_DEBUG'] && error instanceof Error)
+        console.error(error.stack);
+    process.exit(1);
+});

package/dist/database.d.ts

@@ -0,0 +1,15 @@
+import { type Io } from './io.js';
+import type { Project } from './project.js';
+export interface Backup {
+    file: string;
+    restoreCommand: string;
+}
+export declare function restoreCommandFor(project: Project, file: string): string;
+/**
+ * Dump before migrating. Compose databases are dumped with the container's own
+ * pg_dump (always the server's version); external ones through the target
+ * server's `magnus-server backup`, which checks the pg_dump version.
+ */
+export declare function backupDatabase(io: Io, project: Project, version: string, label: string): Promise<Backup>;
+/** Restore a dump. The services must be stopped first. */
+export declare function restoreDatabase(io: Io, project: Project, file: string): Promise<void>;

package/dist/database.js

@@ -0,0 +1,72 @@
+/** Pre-migration dumps and restores for both database kinds a project can use. */
+import { closeSync, chmodSync, mkdirSync, openSync, statSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { readEnvFile } from './env-file.js';
+import { mustRun } from './io.js';
+import { serverCli } from './install.js';
+function shellQuote(value) {
+    return `'${value.replace(/'/g, `'\\''`)}'`;
+}
+function composeArgs(project) {
+    const db = project.state.database;
+    if (db.kind !== 'compose')
+        throw new Error('not a compose database');
+    return ['compose', '-f', project.path(db.composeFile), '--env-file', project.path('config', 'deps.env')];
+}
+export function restoreCommandFor(project, file) {
+    const db = project.state.database;
+    if (db.kind === 'compose') {
+        return `docker ${composeArgs(project).map(shellQuote).join(' ')} exec -T ${db.service} pg_restore --clean --if-exists --no-owner -U ${db.user} -d ${db.database} < ${shellQuote(file)}`;
+    }
+    return `pg_restore --clean --if-exists --no-owner -d "$DATABASE_URL" ${shellQuote(file)}`;
+}
+/**
+ * Dump before migrating. Compose databases are dumped with the container's own
+ * pg_dump (always the server's version); external ones through the target
+ * server's `magnus-server backup`, which checks the pg_dump version.
+ */
+export async function backupDatabase(io, project, version, label) {
+    const db = project.state.database;
+    if (db.kind === 'external') {
+        const { stdout } = await serverCli(io, project, version, ['backup', '--label', label], { capture: true });
+        const result = JSON.parse(stdout.trim().split('\n').pop() ?? '{}');
+        if (!result.file)
+            throw new Error('magnus-server backup did not report a dump file');
+        return { file: result.file, restoreCommand: restoreCommandFor(project, result.file) };
+    }
+    const dir = project.path('backups');
+    mkdirSync(dir, { recursive: true, mode: 0o700 });
+    const file = join(dir, `${io.now().toISOString().replace(/[:.]/g, '-')}-${label.replace(/[^A-Za-z0-9._-]+/g, '_')}.dump`);
+    const fd = openSync(file, 'w', 0o600);
+    try {
+        await mustRun(io, 'docker', [...composeArgs(project), 'exec', '-T', db.service, 'pg_dump', '--format=custom', '--no-owner', '-U', db.user, '-d', db.database], { stdoutFd: fd, capture: false });
+    }
+    finally {
+        closeSync(fd);
+    }
+    if (statSync(file).size === 0)
+        throw new Error(`pg_dump wrote nothing to ${file}`);
+    chmodSync(file, 0o600);
+    const restoreCommand = restoreCommandFor(project, file);
+    writeFileSync(`${file}.json`, `${JSON.stringify({ createdAt: io.now().toISOString(), label, restoreCommand }, null, 2)}\n`, { mode: 0o600 });
+    return { file, restoreCommand };
+}
+/** Restore a dump. The services must be stopped first. */
+export async function restoreDatabase(io, project, file) {
+    const db = project.state.database;
+    if (db.kind === 'compose') {
+        const fd = openSync(file, 'r');
+        try {
+            await mustRun(io, 'docker', [...composeArgs(project), 'exec', '-T', db.service, 'pg_restore', '--clean', '--if-exists', '--no-owner', '-U', db.user, '-d', db.database], { stdinFd: fd });
+        }
+        finally {
+            closeSync(fd);
+        }
+        return;
+    }
+    const url = new URL(readEnvFile(project.envFile('server'))['DATABASE_URL'] ?? '');
+    // Keep the password out of the process list.
+    const password = decodeURIComponent(url.password);
+    url.password = '';
+    await mustRun(io, 'pg_restore', ['--clean', '--if-exists', '--no-owner', '-d', url.toString(), file], { env: { ...io.env, ...(password ? { PGPASSWORD: password } : {}) } });
+}

package/dist/env-file.d.ts

@@ -0,0 +1,14 @@
+export declare function readEnvFile(path: string): Record<string, string>;
+/** 64 hex characters: comfortably above every 32-character secret minimum. */
+export declare function generateSecret(): string;
+export interface EnvEntry {
+    name: string;
+    value: string;
+    comment?: string;
+}
+export declare function renderEnv(header: string, sections: Array<{
+    title: string;
+    entries: EnvEntry[];
+}>): string;
+/** Append entries whose names are not already present; existing values are never changed. */
+export declare function appendMissing(path: string, entries: EnvEntry[], note: string): string[];

package/dist/env-file.js

@@ -0,0 +1,42 @@
+/** Minimal env-file handling: read, append missing keys, generate secrets. */
+import { randomBytes } from 'node:crypto';
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { parseEnv } from 'node:util';
+export function readEnvFile(path) {
+    if (!existsSync(path))
+        return {};
+    return parseEnv(readFileSync(path, 'utf8'));
+}
+/** 64 hex characters: comfortably above every 32-character secret minimum. */
+export function generateSecret() {
+    return randomBytes(32).toString('hex');
+}
+function quote(value) {
+    return /^[A-Za-z0-9_./:@%+,=-]*$/.test(value) ? value : `'${value.replace(/'/g, '')}'`;
+}
+export function renderEnv(header, sections) {
+    const lines = header.split('\n').map((line) => `# ${line}`.trimEnd());
+    for (const section of sections) {
+        lines.push('', `# ── ${section.title} ──`);
+        for (const entry of section.entries) {
+            if (entry.comment)
+                lines.push(`# ${entry.comment}`);
+            lines.push(`${entry.name}=${quote(entry.value)}`);
+        }
+    }
+    return `${lines.join('\n')}\n`;
+}
+/** Append entries whose names are not already present; existing values are never changed. */
+export function appendMissing(path, entries, note) {
+    const existing = readEnvFile(path);
+    const missing = entries.filter((entry) => existing[entry.name] === undefined);
+    if (missing.length === 0)
+        return [];
+    const block = [`\n# ${note}`, ...missing.flatMap((entry) => [
+            ...(entry.comment ? [`# ${entry.comment}`] : []),
+            `${entry.name}=${quote(entry.value)}`,
+        ])].join('\n');
+    const current = existsSync(path) ? readFileSync(path, 'utf8') : '';
+    writeFileSync(path, `${current.replace(/\n*$/, '\n')}${block}\n`, { mode: 0o600 });
+    return missing.map((entry) => entry.name);
+}

package/dist/health.d.ts

@@ -0,0 +1,23 @@
+import type { Io } from './io.js';
+import type { Project } from './project.js';
+export interface RuntimeInfo {
+    version: string;
+    pid: number;
+    port: number;
+    startedAt: string;
+}
+export declare function runtimeFile(project: Project): string;
+export declare function readRuntime(project: Project): RuntimeInfo | null;
+export interface WaitOptions {
+    version: string;
+    /** The runtime file must name a process started after this instant. */
+    startedAfter: Date;
+    timeoutMs: number;
+}
+export interface HealthResult {
+    ok: boolean;
+    detail: string;
+}
+/** First server release that writes run/server-runtime.json. */
+export declare const RUNTIME_FILE_SINCE = "1.1.0";
+export declare function waitForHealthy(io: Io, project: Project, options: WaitOptions): Promise<HealthResult>;