@gjermundgaraba/clankerbox-sdk 0.13.0 → 0.14.0

package/dist/{client-mIuehl40.d.mts → client-D63Z17YP.d.mts}

@@ -161,6 +161,22 @@ declare const Host: Schema.Struct<{
   readonly bases: Schema.$Array<Schema.String>;
 }>;
 type Host = typeof Host.Type;
+/**
+ * One limit a host's `Capacity` refusals come from, and how much of it is in use, counted as
+ * the refusal counts it, so `used` needn't match the host's own machines. Read from the runtime,
+ * never stored.
+ */
+declare const Limit: Schema.Struct<{
+  readonly host: Schema.String;
+  /**
+   * `ramMib`: smolvm's RAM budget. `runningVms`: Tart's, Apple's two VMs per Mac.
+   * `activeSandboxes` and the `starts` of each rolling window: the boat account's.
+   */
+  readonly resource: Schema.Literals<readonly ["ramMib", "runningVms", "activeSandboxes", "startsPerMinute", "startsPerHour", "startsPerDay"]>;
+  readonly limit: Schema.Int;
+  readonly used: Schema.Int;
+}>;
+type Limit = typeof Limit.Type;
 /** A setup script and how long it may run. Nothing logs the script: it can carry secrets. */
 declare const Setup: Schema.Struct<{
   readonly script: Schema.String;
@@ -261,6 +277,8 @@ interface Interface {
   readonly hosts: Effect.Effect<Gathered<Host>>;
   readonly machines: Effect.Effect<Gathered<Machine>>;
   readonly checkpoints: Effect.Effect<Gathered<Checkpoint>>;
+  /** Every host's limits; a host whose runtime couldn't be read is among the unreachable. */
+  readonly capacity: Effect.Effect<Gathered<Limit>>;
   readonly machine: (id: string) => Effect.Effect<Machine, ClankerboxError>;
   readonly checkpoint: (id: string) => Effect.Effect<Checkpoint, ClankerboxError>;
   /**
@@ -286,4 +304,4 @@ declare class Client extends Client_base {}
  */
 declare const make: (hosts: ReadonlyArray<HostEntry>, options?: Options) => Effect.Effect<Interface, Invalid, HttpClient.HttpClient>;
 //#endregion
-export { hostErrors as A, HostError as C, NotFound as D, Invalid as E, Precondition as O, ErrorTag as S, Internal as T, version as _, ActionName as a, Conflict as b, CreateRequest as c, MachineSpec as d, Profile as f, release as g, SshEndpoint as h, client_d_exports as i, Unavailable as k, Host as l, Setup as m, HostEntry as n, ActionRecord as o, Runtime as p, Options as r, Checkpoint as s, Client as t, Machine as u, Capacity as v, HostErrorTag as w, ConflictKind as x, ClankerboxError as y };
+export { Unavailable as A, ErrorTag as C, Invalid as D, Internal as E, NotFound as O, ConflictKind as S, HostErrorTag as T, release as _, ActionName as a, ClankerboxError as b, CreateRequest as c, Machine as d, MachineSpec as f, SshEndpoint as g, Setup as h, client_d_exports as i, hostErrors as j, Precondition as k, Host as l, Runtime as m, HostEntry as n, ActionRecord as o, Profile as p, Options as r, Checkpoint as s, Client as t, Limit as u, version as v, HostError as w, Conflict as x, Capacity as y };

package/dist/{client-Bb5qTz-i.mjs → client-DSd3saH0.mjs}

@@ -129,7 +129,7 @@ const formatId = (host, name) => {
 };
 //#endregion
 //#region package.json
-var version$1 = "0.13.0";
+var version$1 = "0.14.0";
 //#endregion
 //#region src/resources.ts
 /** The resources a host reports: machines, checkpoints and the host itself. */
@@ -225,6 +225,28 @@ const Host = Schema.Struct({
 	runtimeVersion: Schema.String,
 	bases: Schema.Array(Schema.String)
 }).annotate({ identifier: "Host" });
+/**
+* One limit a host's `Capacity` refusals come from, and how much of it is in use, counted as
+* the refusal counts it, so `used` needn't match the host's own machines. Read from the runtime,
+* never stored.
+*/
+const Limit = Schema.Struct({
+	host: HostId,
+	/**
+	* `ramMib`: smolvm's RAM budget. `runningVms`: Tart's, Apple's two VMs per Mac.
+	* `activeSandboxes` and the `starts` of each rolling window: the boat account's.
+	*/
+	resource: Schema.Literals([
+		"ramMib",
+		"runningVms",
+		"activeSandboxes",
+		"startsPerMinute",
+		"startsPerHour",
+		"startsPerDay"
+	]),
+	limit: Schema.Int,
+	used: Schema.Int
+}).annotate({ identifier: "Limit" });
 /** A setup script and how long it may run. Nothing logs the script: it can carry secrets. */
 const Setup = Schema.Struct({
 	script: Schema.String,
@@ -383,6 +405,11 @@ const Http = ActionHttp.make([
 		...read,
 		description: "Read the host: its runtime, versions and bases.",
 		success: Host
+	}),
+	Action.make("getCapacity", {
+		...read,
+		description: "Read the host's limits and how much of each is in use. It fails when the runtime can't be read.",
+		success: Schema.Array(Limit)
 	})
 ], { prefix: "/api" });
 //#endregion
@@ -559,6 +586,7 @@ const make = (hosts, options) => Effect.gen(function* () {
 		hosts: gather((route) => Effect.map(readHost(route), (host) => [host])),
 		machines: gather((route) => ask(route, actions.listMachines, "list machines", (api) => api.listMachines())),
 		checkpoints: gather((route) => ask(route, actions.listCheckpoints, "list checkpoints", (api) => api.listCheckpoints())),
+		capacity: gather((route) => ask(route, actions.getCapacity, "get capacity", (api) => api.getCapacity())),
 		machine: (id) => byId(id, actions.getMachine, `get ${id}`, (api) => api.getMachine({ id })),
 		checkpoint: (id) => byId(id, actions.getCheckpoint, `get ${id}`, (api) => api.getCheckpoint({ id })),
 		create,
@@ -581,4 +609,4 @@ const make = (hosts, options) => Effect.gen(function* () {
 	};
 });
 //#endregion
-export { HostErrorTag as A, formatId as C, Conflict as D, Capacity as E, Unavailable as F, hostErrors as I, Invalid as M, NotFound as N, ConflictKind as O, Precondition as P, Name as S, parseName as T, SshEndpoint as _, readTimeout as a, HostId as b, ActionRecord as c, Host as d, Machine as f, Setup as g, Runtime as h, Http as i, Internal as j, ErrorTag as k, Checkpoint as l, Profile as m, client_exports as n, versionHeader as o, MachineSpec as p, make as r, ActionName as s, Client as t, CreateRequest as u, release as v, parseId as w, Id as x, version as y };
+export { ErrorTag as A, Name as C, Capacity as D, parseName as E, Precondition as F, Unavailable as I, hostErrors as L, Internal as M, Invalid as N, Conflict as O, NotFound as P, Id as S, parseId as T, Setup as _, readTimeout as a, version as b, ActionRecord as c, Host as d, Limit as f, Runtime as g, Profile as h, Http as i, HostErrorTag as j, ConflictKind 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, formatId as w, HostId as x, release as y };

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { A as hostErrors, C as HostError, D as NotFound, E as Invalid, O as Precondition, S as ErrorTag, T as Internal, _ as version, a as ActionName, b as Conflict, c as CreateRequest, d as MachineSpec, f as Profile, g as release, h as SshEndpoint, i as client_d_exports, k as Unavailable, l as Host, m as Setup, o as ActionRecord, p as Runtime, s as Checkpoint, u as Machine, v as Capacity, w as HostErrorTag, x as ConflictKind, y as ClankerboxError } from "./client-mIuehl40.mjs";
+import { A as Unavailable, C as ErrorTag, D as Invalid, E as Internal, O as NotFound, S as ConflictKind, T as HostErrorTag, _ as release, a as ActionName, b as ClankerboxError, c as CreateRequest, d as Machine, f as MachineSpec, g as SshEndpoint, h as Setup, i as client_d_exports, j as hostErrors, k as Precondition, l as Host, m as Runtime, o as ActionRecord, p as Profile, s as Checkpoint, u as Limit, v as version, w as HostError, x as Conflict, y as Capacity } from "./client-D63Z17YP.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";
@@ -268,7 +268,12 @@ export declare const Http: ActionHttp.Binding<readonly [Action.Action<"listMachi
   readonly version: Schema.String;
   readonly runtimeVersion: Schema.String;
   readonly bases: Schema.$Array<Schema.String>;
-}>, readonly (typeof Invalid | typeof NotFound | typeof Conflict | typeof Precondition | typeof Capacity | typeof Internal)[], true, typeof Action.Anyone>], [], undefined>;
+}>, readonly (typeof Invalid | typeof NotFound | typeof Conflict | typeof Precondition | typeof Capacity | typeof Internal)[], true, typeof Action.Anyone>, Action.Action<"getCapacity", Schema.$Record<Schema.String, Schema.Never>, Schema.$Array<Schema.Struct<{
+  readonly host: Schema.String;
+  readonly resource: Schema.Literals<readonly ["ramMib", "runningVms", "activeSandboxes", "startsPerMinute", "startsPerHour", "startsPerDay"]>;
+  readonly limit: Schema.Int;
+  readonly used: Schema.Int;
+}>>, readonly (typeof Invalid | typeof NotFound | typeof Conflict | typeof Precondition | typeof Capacity | typeof Internal)[], true, typeof Action.Anyone>], [], undefined>;
 //#endregion
 //#region src/ids.d.ts
 /** A host's part of every ID it holds. */
@@ -311,4 +316,4 @@ 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
-export { ActionName, ActionRecord, Capacity, Checkpoint, ClankerboxError, client_d_exports as Client, Conflict, ConflictKind, CreateRequest, ErrorTag, Host, HostError, HostErrorTag, Internal, Invalid, Machine, MachineSpec, NotFound, Precondition, Profile, Runtime, Setup, SshEndpoint, Unavailable, hostErrors, release, version };
+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, Unavailable, hostErrors, release, version };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { A as HostErrorTag, C as formatId, D as Conflict, E as Capacity, F as Unavailable, I as hostErrors, M as Invalid, N as NotFound, O as ConflictKind, P as Precondition, S as Name, T as parseName, _ as SshEndpoint, a as readTimeout, b as HostId, c as ActionRecord, d as Host, f as Machine, g as Setup, h as Runtime, i as Http, j as Internal, k as ErrorTag, l as Checkpoint, m as Profile, n as client_exports, o as versionHeader, p as MachineSpec, s as ActionName, u as CreateRequest, v as release, w as parseId, x as Id, y as version } from "./client-Bb5qTz-i.mjs";
+import { A as ErrorTag, C as Name, D as Capacity, E as parseName, F as Precondition, I as Unavailable, L as hostErrors, M as Internal, N as Invalid, O as Conflict, P as NotFound, S as Id, T as parseId, _ as Setup, a as readTimeout, b as version, c as ActionRecord, d as Host, f as Limit, g as Runtime, h as Profile, i as Http, j as HostErrorTag, k as ConflictKind, 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 formatId, x as HostId, y as release } from "./client-DSd3saH0.mjs";
 import { Effect, FileSystem, Path, Predicate, Schema, Stream } from "effect";
 import { ChildProcess, ChildProcessSpawner } from "effect/process";
 //#region src/profile.ts
@@ -103,4 +103,4 @@ const readSetup = (path) => Effect.gen(function* () {
 	return yield* fs.readFileString(path);
 }).pipe(Effect.catchTag("PlatformError", (error) => Effect.fail(new Invalid({ message: `couldn't read setup ${path}: ${error.message}` }))));
 //#endregion
-export { ActionName, ActionRecord, Capacity, Checkpoint, client_exports as Client, Conflict, ConflictKind, CreateRequest, ErrorTag, Host, HostErrorTag, HostId, Http, Id, Internal, Invalid, Machine, MachineSpec, Name, NotFound, Precondition, Profile, Runtime, Setup, SshEndpoint, 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, Unavailable, formatId, hostErrors, loadProfile, packRecipe, parseId, parseName, readSetup, readTimeout, release, version, versionHeader };

package/dist/node.d.mts

@@ -1,4 +1,4 @@
-import { E as Invalid, n as HostEntry, r as Options, t as Client } from "./client-mIuehl40.mjs";
+import { D as Invalid, n as HostEntry, r as Options, t as Client } from "./client-D63Z17YP.mjs";
 import { Layer } from "effect";
 //#region src/node.d.ts
 /** Node's `http` module sets no timeout of its own: a mutation can run for hours. */

package/dist/node.mjs

@@ -1,4 +1,4 @@
-import { r as make, t as Client } from "./client-Bb5qTz-i.mjs";
+import { r as make, t as Client } from "./client-DSd3saH0.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.13.0",
+  "version": "0.14.0",
   "description": "clankerbox's API contract and client library, for Effect",
   "license": "MIT",
   "repository": {