@gjermundgaraba/clankerbox-sdk 0.18.3 → 0.20.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { t as __exportAll } from "./rolldown-runtime-D7D4PA-g.mjs";
-import { A as parseId, B as NotFound, C as Usage, D as Id, E as HostId, F as ConflictKind, G as Refused, H as NotOffered, I as HostError, J as Unsizable, K as ScriptFailed, L as Internal, M as Capacity, N as ClankerboxError, O as Name, P as Conflict, R as Invalid, S as SshLogin, T as stateLabel, U as NotReady, V as NotMade, W as PinMismatch, X as hostErrors, Y as WrongState, Z as retryable, _ as Machine, a as release, b as Setup, c as Http, d as ActionName, f as ActionRecord, g as Host, h as CreateRequest, i as describeIssues, j as parseName, k as formatId, l as actionsByName, m as Checkpoint, o as version, p as ActionStatus, q as Unavailable, r as describeFileError, s as versionHeader, t as client_exports, u as readTimeout, v as MachineSpec, w as isReady, x as SshEndpoint, y as Runtime, z as Missing } from "./client-DHNZ57xn.mjs";
+import { A as Name, B as Missing, C as SshEndpoint, D as stateLabel, E as Usage, F as ClankerboxError, G as Refused, H as NotMade, I as Conflict, J as Unavailable, K as ScriptFailed, L as HostError, M as parseId, N as parseName, O as HostId, P as Capacity, Q as retryable, R as Internal, S as Setup, T as TailnetStatus, U as NotOffered, V as NotFound, W as PinMismatch, X as WrongState, Y as Unsizable, Z as hostErrors, _ as Phase, a as release, b as PublicKeys, c as Http, d as Checkpoint, f as CreateRequest, g as MachineSpec, h as Machine, i as describeIssues, j as formatId, k as Id, l as actionsByName, m as Host, o as version, p as Desired, q as Superseded, r as describeFileError, s as versionHeader, t as client_exports, u as readTimeout, v as PrebuildRequest, w as SshLogin, x as Runtime, y as Prebuilt, z as Invalid } from "./client-S3cTnrsp.mjs";
 import { Effect, FileSystem, Option, Path, Predicate, Record, Schema } from "effect";
 import { Base64, Hex } from "effect/encoding";
 //#region src/prebuild.ts
@@ -10,10 +10,9 @@ var prebuild_exports = /* @__PURE__ */ __exportAll({
 });
 const prefix = "prebuilt-";
 const digestDigits = 12;
-const builderBytes = 8;
 /**
-* A digest of the spec's label, base, sizes, setup script as sent, and the host's runtime
-* version: a `ram` checkpoint restores only under the release that saved it, so after a runtime
+* A digest of the spec's label, base, sizes, setup script as sent, authorized keys, and the host's
+* runtime version: a `ram` checkpoint restores only under the release that saved it, so after a runtime
 * bump a create misses the old prebuild instead of failing to restore it. The setup's timeout and
 * the base's image are no part of it.
 */
@@ -24,19 +23,20 @@ const nameOf = (spec, host) => Effect.promise(() => globalThis.crypto.subtle.dig
 	spec.ramMib,
 	spec.diskGib,
 	spec.setup?.script ?? null,
+	spec.setup?.authorizedKeys ?? null,
 	host.runtimeVersion
 ])))).pipe(Effect.map((digest) => `${prefix}${Hex.encode(new Uint8Array(digest)).slice(0, digestDigits)}`));
 const lookup = (client, id) => client.getCheckpoint({ id }).pipe(Effect.map(Option.some), Effect.catchTag("NotFound", () => Effect.succeedNone));
 /**
-* `client.create`, restoring the spec's prebuild when the host it is placed on has one whose
-* capture is done, unless `fresh`. A failed restore is the reply.
+* `client.create`, restoring the spec's prebuild when the host it is placed on has one, unless
+* `fresh`. A failed restore is the reply.
 */
 const create = (client, name, spec, options) => Effect.gen(function* () {
 	if (spec.setup === void 0 || options?.fresh === true) return { machine: yield* client.create(name, spec, { host: options?.host }) };
 	const host = yield* client.place(spec.base, options);
 	const id = yield* formatId(host.id, yield* nameOf(spec, host));
 	const found = yield* lookup(client, id);
-	if (Option.isSome(found) && isReady(found.value)) return {
+	if (Option.isSome(found)) return {
 		machine: yield* client.restoreMachine({
 			checkpoint: id,
 			name
@@ -46,47 +46,16 @@ const create = (client, name, spec, options) => Effect.gen(function* () {
 	return { machine: yield* client.create(name, spec, { host: host.id }) };
 });
 /**
-* Builds the spec's prebuild on the host a create of it is placed on, with a machine of its own
-* that it deletes however it ends. A prebuild that is there and done is the answer, one that
-* failed is deleted and built again, and one still running is `Conflict{busy}`, as its capture
-* holds it. Of two builds of one spec at once, the second's capture is `Conflict`, and neither
-* touches the other's machine.
+* Asks the host a create of the spec is placed on for the spec's prebuild, which it builds with a
+* machine of its own unless it has it. Two builds of one spec at once share the host's one build.
 */
 const build = (client, spec, options) => Effect.gen(function* () {
 	const host = yield* client.place(spec.base, options);
-	const name = yield* nameOf(spec, host);
-	const id = yield* formatId(host.id, name);
-	const found = yield* lookup(client, id);
-	if (Option.isSome(found)) {
-		const { action } = found.value;
-		if (isReady(found.value)) return {
-			checkpoint: found.value,
-			built: false
-		};
-		if (action.status === "running") return yield* new Conflict({
-			message: `prebuild ${id} is busy: its ${action.name} is running`,
-			kind: "busy",
-			host: host.id,
-			action: "captureCheckpoint",
-			id
-		});
-		yield* client.deleteCheckpoint({ id });
-	}
-	const builder = `prebuilding-${Hex.encode(globalThis.crypto.getRandomValues(new Uint8Array(builderBytes)))}`;
-	const builderId = yield* formatId(host.id, builder);
-	const removal = client.deleteMachine({ id: builderId });
-	return {
-		checkpoint: yield* Effect.gen(function* () {
-			yield* client.create(builder, spec, { host: host.id });
-			if (host.captureFrom === "stopped") yield* client.stopMachine({ id: builderId });
-			return yield* client.captureCheckpoint({
-				machine: builderId,
-				name
-			});
-		}).pipe(Effect.onError(() => Effect.ignore(removal))),
-		built: true,
-		leftover: yield* removal.pipe(Effect.as(void 0), Effect.catch(() => Effect.succeed(builderId)))
-	};
+	const id = yield* formatId(host.id, yield* nameOf(spec, host));
+	return yield* client.prebuildCheckpoint({
+		id,
+		...spec
+	});
 });
 //#endregion
 //#region src/setup.ts
@@ -163,6 +132,21 @@ const readSetup = (path) => Effect.gen(function* () {
 	message: `couldn't read setup ${path}: ${describeFileError(error)}`,
 	file: path
 }))));
+const decodePublicKeys = Schema.decodeUnknownEffect(PublicKeys);
+/**
+* A public-key file's text, such as `~/.ssh/id_ed25519.pub`'s, for a setup's `authorizedKeys`, with
+* its line endings as `\n`.
+*/
+const readAuthorizedKeys = (path) => Effect.gen(function* () {
+	const text = yield* (yield* FileSystem.FileSystem).readFileString(path).pipe(Effect.mapError((error) => new Invalid({
+		message: `couldn't read authorized keys ${path}: ${describeFileError(error)}`,
+		file: path
+	})));
+	return yield* decodePublicKeys(text.replaceAll("\r\n", "\n")).pipe(Effect.mapError((error) => new Invalid({
+		message: `authorized keys ${path}: ${describeIssues(error)}`,
+		file: path
+	})));
+});
 //#endregion
 //#region src/profile.ts
 /**
@@ -221,16 +205,18 @@ const specRequest = (what, profile, overrides, names) => Effect.gen(function* ()
 	const file = overrides.setup ?? profile?.setup?.path;
 	const timeoutSeconds = overrides.setupTimeoutSeconds ?? profile?.setup?.timeoutSeconds;
 	if (file === void 0 && overrides.setupTimeoutSeconds !== void 0) return yield* new Invalid({ message: `${what}: ${names?.get("setupTimeoutSeconds") ?? "the setup timeout"} needs a setup to time` });
-	const script = file === void 0 ? void 0 : yield* readSetup(file);
+	const keys = overrides.authorizedKeys;
+	const setup = file === void 0 ? void 0 : keys === void 0 ? yield* new Invalid({ message: `${what}: a setup needs ${names?.get("authorizedKeys") ?? "authorizedKeys"}, the public keys the host installs for the login user after it` }) : Record.filter({
+		script: yield* readSetup(file),
+		timeoutSeconds,
+		authorizedKeys: yield* readAuthorizedKeys(keys)
+	}, Predicate.isNotUndefined);
 	const fields = {
 		base: overrides.base ?? profile?.base,
 		cpu: overrides.cpu ?? profile?.cpu,
 		ramMib: overrides.ramMib ?? profile?.ramMib,
 		diskGib: overrides.diskGib ?? profile?.diskGib,
-		setup: script === void 0 ? void 0 : Record.filter({
-			script,
-			timeoutSeconds
-		}, Predicate.isNotUndefined),
+		setup,
 		profile: profile?.label
 	};
 	return {
@@ -248,7 +234,7 @@ const specRequest = (what, profile, overrides, names) => Effect.gen(function* ()
 * either is `WrongState`, naming what it lacks and why.
 */
 const sshTarget = (machine) => {
-	const { id, ssh: login, hostKey, action } = machine;
+	const { id, ssh: login, hostKey } = machine;
 	if (login !== void 0 && hostKey !== void 0) return Effect.succeed({
 		id,
 		login,
@@ -256,7 +242,7 @@ const sshTarget = (machine) => {
 	});
 	const lacks = login === void 0 ? "SSH endpoint" : "SSH host key on record";
 	const state = stateLabel(machine);
-	const message = `${id} has no ${lacks} (${state}, ${action.name} ${action.status}): see clankerbox get ${id}`;
+	const message = `${id} has no ${lacks} (${state}): see clankerbox get ${id}`;
 	return Effect.fail(new WrongState({
 		message,
 		machine: id,
@@ -306,4 +292,4 @@ const formatMib = (mib) => mib >= 1024 && mib % 512 === 0 ? `${mib / mibPerGib}G
 /** As a size flag takes it: `60G`. */
 const formatGib = (gib) => `${gib}G`;
 //#endregion
-export { ActionName, ActionRecord, ActionStatus, Capacity, Checkpoint, ClankerboxError, client_exports as Client, Conflict, ConflictKind, CreateRequest, Host, HostError, HostId, Http, Id, Internal, Invalid, Machine, MachineSpec, Missing, Name, NotFound, NotMade, NotOffered, NotReady, PinMismatch, prebuild_exports as Prebuild, Profile, Refused, Runtime, ScriptFailed, Setup, SshEndpoint, SshLogin, Unavailable, Unsizable, Usage, WrongState, actionsByName, describeFileError, describeIssues, formatGib, formatId, formatMib, hostErrors, isReady, knownHostsLine, loadProfile, mibPerGib, packRecipe, parseId, parseName, pinnedSsh, readSetup, readTimeout, release, retryable, specRequest, sshTarget, stateLabel, version, versionHeader };
+export { Capacity, Checkpoint, ClankerboxError, client_exports as Client, Conflict, CreateRequest, Desired, Host, HostError, HostId, Http, Id, Internal, Invalid, Machine, MachineSpec, Missing, Name, NotFound, NotMade, NotOffered, Phase, PinMismatch, prebuild_exports as Prebuild, PrebuildRequest, Prebuilt, Profile, PublicKeys, Refused, Runtime, ScriptFailed, Setup, SshEndpoint, SshLogin, Superseded, TailnetStatus, Unavailable, Unsizable, Usage, WrongState, actionsByName, describeFileError, describeIssues, formatGib, formatId, formatMib, hostErrors, knownHostsLine, loadProfile, mibPerGib, packRecipe, parseId, parseName, pinnedSsh, readAuthorizedKeys, readSetup, readTimeout, release, retryable, specRequest, sshTarget, stateLabel, version, versionHeader };

package/dist/node.d.mts

@@ -1,4 +1,4 @@
-import { N as Invalid, a as Options, r as HostEntry, t as Client } from "./client-8af586hb.mjs";
+import { P as Invalid, a as Options, r as HostEntry, t as Client } from "./client-Dr3PcuCP.mjs";
 import { Layer } from "effect";
 //#region src/node.d.ts
 /**

package/dist/node.mjs

@@ -1,4 +1,4 @@
-import { n as layer$1 } from "./client-DHNZ57xn.mjs";
+import { n as layer$1 } from "./client-S3cTnrsp.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.18.3",
+  "version": "0.20.0",
   "description": "clankerbox's API contract and client library, for Effect",
   "license": "MIT",
   "repository": {
@@ -27,21 +27,20 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "@gjermundgaraba/effect-actions": "0.17.0"
-  },
   "devDependencies": {
-    "@effect/platform-node": "4.0.4",
-    "@effect/vitest": "4.0.4",
-    "@types/node": "26.6.4",
-    "effect": "4.0.4",
+    "@effect/platform-node": "4.0.5",
+    "@effect/vitest": "4.0.5",
+    "@gjermundgaraba/effect-actions": "0.18.2",
+    "@types/node": "26.6.5",
+    "effect": "4.0.5",
     "typescript": "7.0.2",
-    "vite": "npm:@voidzero-dev/vite-plus-core@1.2.0",
-    "vite-plus": "1.2.0",
-    "vitest": "5.0.4"
+    "vite": "npm:@voidzero-dev/vite-plus-core@1.3.0",
+    "vite-plus": "1.3.0",
+    "vitest": "5.0.5"
   },
   "peerDependencies": {
     "@effect/platform-node": "~4.0.4",
+    "@gjermundgaraba/effect-actions": "^0.18.0",
     "effect": "~4.0.4"
   },
   "peerDependenciesMeta": {