@gjermundgaraba/clankerbox-sdk 0.15.0 → 0.15.2

package/dist/{client-VNMPU7ER.mjs → client-cFk3r2_1.mjs}

@@ -1,7 +1,7 @@
 import { t as __exportAll } from "./rolldown-runtime-D7D4PA-g.mjs";
 import * as Action from "@gjermundgaraba/effect-actions/Action";
 import * as ActionHttp from "@gjermundgaraba/effect-actions/ActionHttp";
-import { Context, Duration, Effect, Fiber, Match, Predicate, Result, Schema } from "effect";
+import { Context, Duration, Effect, Fiber, Match, Predicate, Result, Schema, SchemaIssue } from "effect";
 import { HttpClient, HttpClientRequest } from "effect/http";
 //#region src/errors.ts
 /**
@@ -129,7 +129,7 @@ const formatId = (host, name) => {
 };
 //#endregion
 //#region package.json
-var version$1 = "0.15.0";
+var version$1 = "0.15.2";
 //#endregion
 //#region src/resources.ts
 /** The resources a host reports: machines, checkpoints and the host itself. */
@@ -426,6 +426,41 @@ const Http = ActionHttp.make([
 	})
 ], { prefix: "/api" });
 //#endregion
+//#region src/text.ts
+/** How sizes, decode failures and file failures read in a message or a table cell. */
+const mibPerGib = 1024;
+/**
+* A RAM size, exactly, as a size flag takes one: GiB when it is whole or half GiB, `32G` or
+* `1.5G`, and MiB when it isn't, `512M` or `1500M`.
+*/
+const formatMib = (mib) => mib >= mibPerGib && mib % (mibPerGib / 2) === 0 ? `${mib / mibPerGib}G` : `${mib}M`;
+/**
+* Where a decode failed, as a JSON path: `hosts[0].id`. `names` gives a top-level field the
+* name its caller knows it by.
+*/
+const jsonPath = (path, names) => path.map((key, index) => {
+	if (Number.isInteger(key)) return `[${String(key)}]`;
+	return index === 0 ? names?.get(key) ?? String(key) : `.${String(key)}`;
+}).join("");
+const flatten = SchemaIssue.makeFormatterStandardSchemaV1({ leafHook: (issue) => Match.value(issue).pipe(Match.tag("MissingKey", () => "missing"), Match.tag("UnexpectedKey", () => "not a known field"), Match.orElse(SchemaIssue.defaultLeafHook)) });
+/**
+* Everything a decode refused, on one line, each under its JSON path: `cpu: missing; ram: not a
+* known field`. `names` renames top-level fields, as when a flag set each: `--cpu: missing`.
+*/
+const describeIssues = (error, names) => flatten(error.issue).issues.map(({ path = [], message }) => {
+	const keys = path.map((segment) => Predicate.isPropertyKey(segment) ? segment : segment.key);
+	return keys.length === 0 ? message : `${jsonPath(keys, names)}: ${message}`;
+}).join("; ");
+/**
+* Why a file couldn't be read, without the platform call that met it. Node describes a failure
+* only in its cause, so what has no wording here reads as the system's own.
+*/
+const describeFileError = ({ reason }) => {
+	if (Predicate.isTagged(reason, "NotFound")) return "no such file or directory";
+	if (Predicate.isTagged(reason, "PermissionDenied")) return "permission denied";
+	return reason.description ?? (reason.cause instanceof Error ? reason.cause.message : reason._tag);
+};
+//#endregion
 //#region src/client.ts
 /**
 * The client library: a host list in placement order, routing by ID, list fan-out and
@@ -497,7 +532,7 @@ const decodeHosts = Schema.decodeUnknownEffect(Schema.Array(HostEntry));
 */
 const make = (hosts, options) => Effect.gen(function* () {
 	if (hosts.length === 0) return yield* new Invalid({ message: "the host list is empty: a client needs a host" });
-	yield* decodeHosts(hosts).pipe(Effect.mapError((error) => new Invalid({ message: `host list: ${error.message}` })));
+	yield* decodeHosts(hosts, { errors: "all" }).pipe(Effect.mapError((error) => new Invalid({ message: `host list: ${describeIssues(error)}` })));
 	const twice = hosts.find(({ id }, index) => hosts.findIndex((other) => other.id === id) < index);
 	if (twice !== void 0) return yield* new Invalid({ message: `host ${twice.id} appears twice in the host list` });
 	const routed = yield* Effect.forEach(hosts, (entry) => Effect.map(makeHostApi(entry), (api) => ({
@@ -575,7 +610,7 @@ const make = (hosts, options) => Effect.gen(function* () {
 			const result = yield* Fiber.join(fiber);
 			if (Result.isFailure(result)) {
 				noReply ||= Predicate.isTagged(result.failure, "Unavailable");
-				misses.push(`${host} failed: ${result.failure._tag}: ${result.failure.message}`);
+				misses.push(`${host} failed: ${result.failure.message}`);
 			} else if (result.success.bases.includes(base)) return host;
 			else {
 				const { bases } = result.success;
@@ -622,4 +657,4 @@ const make = (hosts, options) => Effect.gen(function* () {
 	};
 });
 //#endregion
-export { ConflictKind as A, Id as C, parseName as D, parseId as E, NotFound as F, Precondition as I, Unavailable as L, HostErrorTag as M, Internal as N, Capacity as O, Invalid as P, hostErrors as R, HostId as S, formatId as T, Setup as _, readTimeout as a, release as b, ActionRecord as c, Host as d, Limit as f, Runtime as g, Profile as h, Http as i, ErrorTag as j, Conflict as k, Checkpoint as l, MachineSpec as m, client_exports as n, versionHeader as o, Machine as p, make as r, ActionName as s, Client as t, CreateRequest as u, SshEndpoint as v, Name as w, version as x, SshLogin as y };
+export { parseName as A, Unavailable as B, release as C, Name as D, Id as E, HostErrorTag as F, Internal as I, Invalid as L, Conflict as M, ConflictKind as N, formatId as O, ErrorTag as P, NotFound as R, SshLogin as S, HostId as T, hostErrors as V, MachineSpec as _, describeIssues as a, Setup as b, readTimeout as c, ActionRecord as d, Checkpoint as f, Machine as g, Limit as h, describeFileError as i, Capacity as j, parseId as k, versionHeader as l, Host as m, client_exports as n, formatMib as o, CreateRequest as p, make as r, Http as s, Client as t, ActionName as u, Profile as v, version as w, SshEndpoint as x, Runtime as y, Precondition as z };

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { A as Precondition, C as ConflictKind, D as Internal, E as HostErrorTag, M as hostErrors, O as Invalid, S as Conflict, T as HostError, _ as SshLogin, a as ActionName, b as Capacity, c as CreateRequest, d as Machine, f as MachineSpec, g as SshEndpoint, h as Setup, i as client_d_exports, j as Unavailable, k as NotFound, l as Host, m as Runtime, o as ActionRecord, p as Profile, s as Checkpoint, u as Limit, v as release, w as ErrorTag, x as ClankerboxError, y as version } from "./client-SX6jTU1R.mjs";
 import * as Action from "@gjermundgaraba/effect-actions/Action";
 import * as ActionHttp from "@gjermundgaraba/effect-actions/ActionHttp";
-import { Duration, Effect, FileSystem, Path, Schema } from "effect";
+import { Duration, Effect, FileSystem, Path, PlatformError, Schema } from "effect";
 import { ChildProcessSpawner } from "effect/process";
 //#region src/api.d.ts
 /**
@@ -330,4 +330,21 @@ export declare const packRecipe: (directory: string) => Effect.Effect<string, In
 /** Reads a setup: a script file's text, or a recipe directory packed into one script. */
 export declare const readSetup: (path: string) => Effect.Effect<string, Invalid, FileSystem.FileSystem | ChildProcessSpawner.ChildProcessSpawner>;
 //#endregion
+//#region src/text.d.ts
+/**
+ * A RAM size, exactly, as a size flag takes one: GiB when it is whole or half GiB, `32G` or
+ * `1.5G`, and MiB when it isn't, `512M` or `1500M`.
+ */
+export declare const formatMib: (mib: number) => string;
+/**
+ * Everything a decode refused, on one line, each under its JSON path: `cpu: missing; ram: not a
+ * known field`. `names` renames top-level fields, as when a flag set each: `--cpu: missing`.
+ */
+export declare const describeIssues: (error: Schema.SchemaError, names?: ReadonlyMap<PropertyKey, string>) => string;
+/**
+ * Why a file couldn't be read, without the platform call that met it. Node describes a failure
+ * only in its cause, so what has no wording here reads as the system's own.
+ */
+export declare const describeFileError: ({ reason }: PlatformError.PlatformError) => string;
+//#endregion
 export { ActionName, ActionRecord, Capacity, Checkpoint, ClankerboxError, client_d_exports as Client, Conflict, ConflictKind, CreateRequest, ErrorTag, Host, HostError, HostErrorTag, Internal, Invalid, Limit, Machine, MachineSpec, NotFound, Precondition, Profile, Runtime, Setup, SshEndpoint, SshLogin, Unavailable, hostErrors, release, version };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { A as ConflictKind, C as Id, D as parseName, E as parseId, F as NotFound, I as Precondition, L as Unavailable, M as HostErrorTag, N as Internal, O as Capacity, P as Invalid, R as hostErrors, S as HostId, T as formatId, _ as Setup, a as readTimeout, b as release, c as ActionRecord, d as Host, f as Limit, g as Runtime, h as Profile, i as Http, j as ErrorTag, k as Conflict, l as Checkpoint, m as MachineSpec, n as client_exports, o as versionHeader, p as Machine, s as ActionName, u as CreateRequest, v as SshEndpoint, w as Name, x as version, y as SshLogin } from "./client-VNMPU7ER.mjs";
+import { A as parseName, B as Unavailable, C as release, D as Name, E as Id, F as HostErrorTag, I as Internal, L as Invalid, M as Conflict, N as ConflictKind, O as formatId, P as ErrorTag, R as NotFound, S as SshLogin, T as HostId, V as hostErrors, _ as MachineSpec, a as describeIssues, b as Setup, c as readTimeout, d as ActionRecord, f as Checkpoint, g as Machine, h as Limit, i as describeFileError, j as Capacity, k as parseId, l as versionHeader, m as Host, n as client_exports, o as formatMib, p as CreateRequest, s as Http, u as ActionName, v as Profile, w as version, x as SshEndpoint, y as Runtime, z as Precondition } from "./client-cFk3r2_1.mjs";
 import { Effect, FileSystem, Path, Predicate, Schema, Stream } from "effect";
 import { ChildProcess, ChildProcessSpawner } from "effect/process";
 //#region src/profile.ts
@@ -13,8 +13,11 @@ const decodeProfile = Schema.decodeUnknownEffect(Schema.fromJsonString(Profile))
 const loadProfile = (file) => Effect.gen(function* () {
 	const fs = yield* FileSystem.FileSystem;
 	const path = yield* Path.Path;
-	const text = yield* fs.readFileString(file).pipe(Effect.mapError((error) => new Invalid({ message: `couldn't read profile ${file}: ${error.message}` })));
-	const profile = yield* decodeProfile(text, { onExcessProperty: "error" }).pipe(Effect.mapError((error) => new Invalid({ message: `profile ${file}: ${error.message}` })));
+	const text = yield* fs.readFileString(file).pipe(Effect.mapError((error) => new Invalid({ message: `couldn't read profile ${file}: ${describeFileError(error)}` })));
+	const profile = yield* decodeProfile(text, {
+		onExcessProperty: "error",
+		errors: "all"
+	}).pipe(Effect.mapError((error) => new Invalid({ message: `profile ${file}: ${describeIssues(error)}` })));
 	const label = path.basename(file, ".json");
 	return profile.setup === void 0 ? {
 		...profile,
@@ -95,12 +98,12 @@ const packRecipe = (directory) => Effect.gen(function* () {
 	], { concurrency: "unbounded" });
 	if (code !== 0) return yield* new Invalid({ message: `tar couldn't pack recipe ${directory} (exit ${code}): ${errors.trim()}` });
 	return selfExtracting(Buffer.from(archive.buffer, archive.byteOffset, archive.byteLength).toString("base64"));
-}).pipe(Effect.scoped, Effect.catchTag("PlatformError", (error) => Effect.fail(new Invalid({ message: `couldn't pack recipe ${directory}: ${error.message}` }))));
+}).pipe(Effect.scoped, Effect.catchTag("PlatformError", (error) => Effect.fail(new Invalid({ message: `couldn't pack recipe ${directory}: ${describeFileError(error)}` }))));
 /** Reads a setup: a script file's text, or a recipe directory packed into one script. */
 const readSetup = (path) => Effect.gen(function* () {
 	const fs = yield* FileSystem.FileSystem;
 	if ((yield* fs.stat(path)).type === "Directory") return yield* packRecipe(path);
 	return yield* fs.readFileString(path);
-}).pipe(Effect.catchTag("PlatformError", (error) => Effect.fail(new Invalid({ message: `couldn't read setup ${path}: ${error.message}` }))));
+}).pipe(Effect.catchTag("PlatformError", (error) => Effect.fail(new Invalid({ message: `couldn't read setup ${path}: ${describeFileError(error)}` }))));
 //#endregion
-export { ActionName, ActionRecord, Capacity, Checkpoint, client_exports as Client, Conflict, ConflictKind, CreateRequest, ErrorTag, Host, HostErrorTag, HostId, Http, Id, Internal, Invalid, Limit, Machine, MachineSpec, Name, NotFound, Precondition, Profile, Runtime, Setup, SshEndpoint, SshLogin, Unavailable, formatId, hostErrors, loadProfile, packRecipe, parseId, parseName, readSetup, readTimeout, release, version, versionHeader };
+export { ActionName, ActionRecord, Capacity, Checkpoint, client_exports as Client, Conflict, ConflictKind, CreateRequest, ErrorTag, Host, HostErrorTag, HostId, Http, Id, Internal, Invalid, Limit, Machine, MachineSpec, Name, NotFound, Precondition, Profile, Runtime, Setup, SshEndpoint, SshLogin, Unavailable, describeFileError, describeIssues, formatId, formatMib, hostErrors, loadProfile, packRecipe, parseId, parseName, readSetup, readTimeout, release, version, versionHeader };

package/dist/node.mjs

@@ -1,4 +1,4 @@
-import { r as make, t as Client } from "./client-VNMPU7ER.mjs";
+import { r as make, t as Client } from "./client-cFk3r2_1.mjs";
 import { Layer } from "effect";
 import * as NodeHttpClient from "@effect/platform-node/NodeHttpClient";
 //#region src/node.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gjermundgaraba/clankerbox-sdk",
-  "version": "0.15.0",
+  "version": "0.15.2",
   "description": "clankerbox's API contract and client library, for Effect",
   "license": "MIT",
   "repository": {