@zgeoff/imp-client 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -1,6 +1,21 @@
 import { ORPCError, isDefinedError, safe } from "@orpc/client";
 import * as z from "zod";
 import { ContractRouterClient } from "@orpc/contract";
+//#region ../api/src/api-call-schema.d.ts
+declare const ApiCallSchema: z.ZodObject<{
+  at: z.ZodDate;
+  procedure: z.ZodString;
+  actor: z.ZodEnum<{
+    dashboard: "dashboard";
+    ssh: "ssh";
+    token: "token";
+  }>;
+  imp: z.ZodOptional<z.ZodString>;
+  outcome: z.ZodString;
+  durationMs: z.ZodInt;
+}, z.core.$strip>;
+type ApiCall = z.infer<typeof ApiCallSchema>;
+//#endregion
 //#region ../api/src/checkpoint-schema.d.ts
 declare const CheckpointSchema: z.ZodObject<{
   id: z.ZodString;
@@ -14,6 +29,181 @@ type Checkpoint = z.infer<typeof CheckpointSchema>;
 declare const DETACH_REASONS: readonly ['taken_over', 'slow', 'lost'];
 type DetachReason = (typeof DETACH_REASONS)[number];
 //#endregion
+//#region ../api/src/event-schema.d.ts
+declare const ImpEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  v: z.ZodLiteral<1>;
+  at: z.ZodDate;
+  ev: z.ZodLiteral<"ImpAdded">;
+  reason: z.ZodEnum<{
+    created: "created";
+    snapshot: "snapshot";
+  }>;
+  imp: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    image: z.ZodString;
+    state: z.ZodEnum<{
+      creating: "creating";
+      error: "error";
+      running: "running";
+      sleeping: "sleeping";
+      stopped: "stopped";
+    }>;
+    vcpus: z.ZodInt;
+    memoryMib: z.ZodInt;
+    ip: z.ZodIPv4;
+    slot: z.ZodInt;
+    port: z.ZodInt;
+    httpPort: z.ZodInt;
+    url: z.ZodURL;
+    createdAt: z.ZodDate;
+    lastActiveAt: z.ZodDate;
+    ramMib: z.ZodOptional<z.ZodInt>;
+    rssMib: z.ZodOptional<z.ZodInt>;
+    sleptAt: z.ZodOptional<z.ZodDate>;
+    holdUntil: z.ZodOptional<z.ZodDate>;
+    error: z.ZodOptional<z.ZodString>;
+    sessions: z.ZodOptional<z.ZodInt>;
+    coldBootReason: z.ZodOptional<z.ZodString>;
+    outdated: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+      agent: "agent";
+      firecracker: "firecracker";
+      impd: "impd";
+      kernel: "kernel";
+    }>>>>;
+  }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+  v: z.ZodLiteral<1>;
+  at: z.ZodDate;
+  ev: z.ZodLiteral<"ImpChanged">;
+  reason: z.ZodEnum<{
+    adopted: "adopted";
+    booted: "booted";
+    failed: "failed";
+    held: "held";
+    repaired: "repaired";
+    restored: "restored";
+    slept: "slept";
+    stopped: "stopped";
+    woke: "woke";
+  }>;
+  imp: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    image: z.ZodString;
+    state: z.ZodEnum<{
+      creating: "creating";
+      error: "error";
+      running: "running";
+      sleeping: "sleeping";
+      stopped: "stopped";
+    }>;
+    vcpus: z.ZodInt;
+    memoryMib: z.ZodInt;
+    ip: z.ZodIPv4;
+    slot: z.ZodInt;
+    port: z.ZodInt;
+    httpPort: z.ZodInt;
+    url: z.ZodURL;
+    createdAt: z.ZodDate;
+    lastActiveAt: z.ZodDate;
+    ramMib: z.ZodOptional<z.ZodInt>;
+    rssMib: z.ZodOptional<z.ZodInt>;
+    sleptAt: z.ZodOptional<z.ZodDate>;
+    holdUntil: z.ZodOptional<z.ZodDate>;
+    error: z.ZodOptional<z.ZodString>;
+    sessions: z.ZodOptional<z.ZodInt>;
+    coldBootReason: z.ZodOptional<z.ZodString>;
+    outdated: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+      agent: "agent";
+      firecracker: "firecracker";
+      impd: "impd";
+      kernel: "kernel";
+    }>>>>;
+  }, z.core.$strip>;
+  detail: z.ZodOptional<z.ZodReadonly<z.ZodObject<{
+    durationMs: z.ZodOptional<z.ZodInt>;
+    trigger: z.ZodOptional<z.ZodString>;
+    coldBootReason: z.ZodOptional<z.ZodString>;
+    steps: z.ZodOptional<z.ZodReadonly<z.ZodRecord<z.ZodString, z.ZodInt>>>;
+  }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+  v: z.ZodLiteral<1>;
+  at: z.ZodDate;
+  ev: z.ZodLiteral<"ImpRemoved">;
+  imp: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    image: z.ZodString;
+    state: z.ZodEnum<{
+      creating: "creating";
+      error: "error";
+      running: "running";
+      sleeping: "sleeping";
+      stopped: "stopped";
+    }>;
+    vcpus: z.ZodInt;
+    memoryMib: z.ZodInt;
+    ip: z.ZodIPv4;
+    slot: z.ZodInt;
+    port: z.ZodInt;
+    httpPort: z.ZodInt;
+    url: z.ZodURL;
+    createdAt: z.ZodDate;
+    lastActiveAt: z.ZodDate;
+    ramMib: z.ZodOptional<z.ZodInt>;
+    rssMib: z.ZodOptional<z.ZodInt>;
+    sleptAt: z.ZodOptional<z.ZodDate>;
+    holdUntil: z.ZodOptional<z.ZodDate>;
+    error: z.ZodOptional<z.ZodString>;
+    sessions: z.ZodOptional<z.ZodInt>;
+    coldBootReason: z.ZodOptional<z.ZodString>;
+    outdated: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+      agent: "agent";
+      firecracker: "firecracker";
+      impd: "impd";
+      kernel: "kernel";
+    }>>>>;
+  }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+  v: z.ZodLiteral<1>;
+  at: z.ZodDate;
+  ev: z.ZodLiteral<"CheckpointAdded">;
+  name: z.ZodString;
+  checkpoint: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodDate;
+    sizeBytes: z.ZodOptional<z.ZodInt>;
+  }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+  v: z.ZodLiteral<1>;
+  at: z.ZodDate;
+  ev: z.ZodLiteral<"CheckpointRemoved">;
+  name: z.ZodString;
+  checkpoint: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodDate;
+    sizeBytes: z.ZodOptional<z.ZodInt>;
+  }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+  v: z.ZodLiteral<1>;
+  at: z.ZodDate;
+  ev: z.ZodLiteral<"GovernorDecision">;
+  decision: z.ZodEnum<{
+    admitted: "admitted";
+    refused: "refused";
+    slept: "slept";
+  }>;
+  name: z.ZodString;
+  trigger: z.ZodString;
+  usedMib: z.ZodInt;
+  budgetMib: z.ZodInt;
+  reserveMib: z.ZodOptional<z.ZodInt>;
+}, z.core.$strip>], "ev">;
+type ImpEvent = z.infer<typeof ImpEventSchema>;
+//#endregion
 //#region ../api/src/image-schema.d.ts
 declare const ImageSchema: z.ZodObject<{
   id: z.ZodString;
@@ -3078,6 +3268,412 @@ declare const impContract: {
         readonly status: 409;
       };
     }>, Record<never, never>>;
+    calls: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      name: z.ZodOptional<z.ZodString>;
+      limit: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+      at: z.ZodDate;
+      procedure: z.ZodString;
+      actor: z.ZodEnum<{
+        dashboard: "dashboard";
+        ssh: "ssh";
+        token: "token";
+      }>;
+      imp: z.ZodOptional<z.ZodString>;
+      outcome: z.ZodString;
+      durationMs: z.ZodInt;
+    }, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      NOT_FOUND: {
+        readonly message: "Not found";
+        readonly data: z.ZodObject<{
+          kind: z.ZodEnum<{
+            backup: "backup";
+            checkpoint: "checkpoint";
+            grant: "grant";
+            image: "image";
+            imp: "imp";
+            secret: "secret";
+            session: "session";
+          }>;
+          name: z.ZodString;
+        }, z.core.$strip>;
+      };
+      CONFLICT: {
+        readonly message: "Already exists";
+        readonly data: z.ZodObject<{
+          kind: z.ZodEnum<{
+            backup: "backup";
+            checkpoint: "checkpoint";
+            grant: "grant";
+            image: "image";
+            imp: "imp";
+            secret: "secret";
+            session: "session";
+          }>;
+          name: z.ZodString;
+        }, z.core.$strip>;
+      };
+      FORBIDDEN: {
+        readonly message: "Not allowed";
+      };
+      PRECONDITION_FAILED: {
+        readonly message: "Not possible on this host";
+      };
+      RAM_BUDGET_EXCEEDED: {
+        readonly message: "Not enough RAM budget, even after sleeping idle imps";
+        readonly status: 503;
+        readonly data: z.ZodObject<{
+          budgetMib: z.ZodInt;
+          usedMib: z.ZodInt;
+          requestedMib: z.ZodInt;
+        }, z.core.$strip>;
+      };
+      SERVICE_UNAVAILABLE: {
+        readonly message: "impd is stopping";
+      };
+      INVALID_STATE: {
+        readonly message: "The imp is not in a state that allows this";
+        readonly status: 409;
+        readonly data: z.ZodObject<{
+          state: z.ZodEnum<{
+            creating: "creating";
+            error: "error";
+            running: "running";
+            sleeping: "sleeping";
+            stopped: "stopped";
+          }>;
+          allowed: z.ZodArray<z.ZodEnum<{
+            creating: "creating";
+            error: "error";
+            running: "running";
+            sleeping: "sleeping";
+            stopped: "stopped";
+          }>>;
+        }, z.core.$strip>;
+      };
+      AGENT_OUTDATED: {
+        readonly message: "The imp's agent is too old for this";
+        readonly status: 409;
+      };
+    }>, Record<never, never>>;
+  };
+  events: {
+    stream: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, import("@orpc/contract").Schema<AsyncIteratorObject<{
+      v: 1;
+      at: Date;
+      ev: "ImpAdded";
+      reason: "created" | "snapshot";
+      imp: {
+        id: string;
+        name: string;
+        image: string;
+        state: "creating" | "error" | "running" | "sleeping" | "stopped";
+        vcpus: number;
+        memoryMib: number;
+        ip: string;
+        slot: number;
+        port: number;
+        httpPort: number;
+        url: string;
+        createdAt: Date;
+        lastActiveAt: Date;
+        ramMib?: number | undefined;
+        rssMib?: number | undefined;
+        sleptAt?: Date | undefined;
+        holdUntil?: Date | undefined;
+        error?: string | undefined;
+        sessions?: number | undefined;
+        coldBootReason?: string | undefined;
+        outdated?: readonly ("agent" | "firecracker" | "impd" | "kernel")[] | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "ImpChanged";
+      reason: "adopted" | "booted" | "failed" | "held" | "repaired" | "restored" | "slept" | "stopped" | "woke";
+      imp: {
+        id: string;
+        name: string;
+        image: string;
+        state: "creating" | "error" | "running" | "sleeping" | "stopped";
+        vcpus: number;
+        memoryMib: number;
+        ip: string;
+        slot: number;
+        port: number;
+        httpPort: number;
+        url: string;
+        createdAt: Date;
+        lastActiveAt: Date;
+        ramMib?: number | undefined;
+        rssMib?: number | undefined;
+        sleptAt?: Date | undefined;
+        holdUntil?: Date | undefined;
+        error?: string | undefined;
+        sessions?: number | undefined;
+        coldBootReason?: string | undefined;
+        outdated?: readonly ("agent" | "firecracker" | "impd" | "kernel")[] | undefined;
+      };
+      detail?: Readonly<{
+        durationMs?: number | undefined;
+        trigger?: string | undefined;
+        coldBootReason?: string | undefined;
+        steps?: Readonly<Record<string, number>> | undefined;
+      }> | undefined;
+    } | {
+      v: 1;
+      at: Date;
+      ev: "ImpRemoved";
+      imp: {
+        id: string;
+        name: string;
+        image: string;
+        state: "creating" | "error" | "running" | "sleeping" | "stopped";
+        vcpus: number;
+        memoryMib: number;
+        ip: string;
+        slot: number;
+        port: number;
+        httpPort: number;
+        url: string;
+        createdAt: Date;
+        lastActiveAt: Date;
+        ramMib?: number | undefined;
+        rssMib?: number | undefined;
+        sleptAt?: Date | undefined;
+        holdUntil?: Date | undefined;
+        error?: string | undefined;
+        sessions?: number | undefined;
+        coldBootReason?: string | undefined;
+        outdated?: readonly ("agent" | "firecracker" | "impd" | "kernel")[] | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "CheckpointAdded";
+      name: string;
+      checkpoint: {
+        id: string;
+        label?: string | undefined;
+        createdAt: Date;
+        sizeBytes?: number | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "CheckpointRemoved";
+      name: string;
+      checkpoint: {
+        id: string;
+        label?: string | undefined;
+        createdAt: Date;
+        sizeBytes?: number | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "GovernorDecision";
+      decision: "admitted" | "refused" | "slept";
+      name: string;
+      trigger: string;
+      usedMib: number;
+      budgetMib: number;
+      reserveMib?: number | undefined;
+    }, unknown, void>, import("@orpc/client").AsyncIteratorClass<{
+      v: 1;
+      at: Date;
+      ev: "ImpAdded";
+      reason: "created" | "snapshot";
+      imp: {
+        id: string;
+        name: string;
+        image: string;
+        state: "creating" | "error" | "running" | "sleeping" | "stopped";
+        vcpus: number;
+        memoryMib: number;
+        ip: string;
+        slot: number;
+        port: number;
+        httpPort: number;
+        url: string;
+        createdAt: Date;
+        lastActiveAt: Date;
+        ramMib?: number | undefined;
+        rssMib?: number | undefined;
+        sleptAt?: Date | undefined;
+        holdUntil?: Date | undefined;
+        error?: string | undefined;
+        sessions?: number | undefined;
+        coldBootReason?: string | undefined;
+        outdated?: readonly ("agent" | "firecracker" | "impd" | "kernel")[] | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "ImpChanged";
+      reason: "adopted" | "booted" | "failed" | "held" | "repaired" | "restored" | "slept" | "stopped" | "woke";
+      imp: {
+        id: string;
+        name: string;
+        image: string;
+        state: "creating" | "error" | "running" | "sleeping" | "stopped";
+        vcpus: number;
+        memoryMib: number;
+        ip: string;
+        slot: number;
+        port: number;
+        httpPort: number;
+        url: string;
+        createdAt: Date;
+        lastActiveAt: Date;
+        ramMib?: number | undefined;
+        rssMib?: number | undefined;
+        sleptAt?: Date | undefined;
+        holdUntil?: Date | undefined;
+        error?: string | undefined;
+        sessions?: number | undefined;
+        coldBootReason?: string | undefined;
+        outdated?: readonly ("agent" | "firecracker" | "impd" | "kernel")[] | undefined;
+      };
+      detail?: Readonly<{
+        durationMs?: number | undefined;
+        trigger?: string | undefined;
+        coldBootReason?: string | undefined;
+        steps?: Readonly<Record<string, number>> | undefined;
+      }> | undefined;
+    } | {
+      v: 1;
+      at: Date;
+      ev: "ImpRemoved";
+      imp: {
+        id: string;
+        name: string;
+        image: string;
+        state: "creating" | "error" | "running" | "sleeping" | "stopped";
+        vcpus: number;
+        memoryMib: number;
+        ip: string;
+        slot: number;
+        port: number;
+        httpPort: number;
+        url: string;
+        createdAt: Date;
+        lastActiveAt: Date;
+        ramMib?: number | undefined;
+        rssMib?: number | undefined;
+        sleptAt?: Date | undefined;
+        holdUntil?: Date | undefined;
+        error?: string | undefined;
+        sessions?: number | undefined;
+        coldBootReason?: string | undefined;
+        outdated?: readonly ("agent" | "firecracker" | "impd" | "kernel")[] | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "CheckpointAdded";
+      name: string;
+      checkpoint: {
+        id: string;
+        label?: string | undefined;
+        createdAt: Date;
+        sizeBytes?: number | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "CheckpointRemoved";
+      name: string;
+      checkpoint: {
+        id: string;
+        label?: string | undefined;
+        createdAt: Date;
+        sizeBytes?: number | undefined;
+      };
+    } | {
+      v: 1;
+      at: Date;
+      ev: "GovernorDecision";
+      decision: "admitted" | "refused" | "slept";
+      name: string;
+      trigger: string;
+      usedMib: number;
+      budgetMib: number;
+      reserveMib?: number | undefined;
+    }, unknown, void>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      NOT_FOUND: {
+        readonly message: "Not found";
+        readonly data: z.ZodObject<{
+          kind: z.ZodEnum<{
+            backup: "backup";
+            checkpoint: "checkpoint";
+            grant: "grant";
+            image: "image";
+            imp: "imp";
+            secret: "secret";
+            session: "session";
+          }>;
+          name: z.ZodString;
+        }, z.core.$strip>;
+      };
+      CONFLICT: {
+        readonly message: "Already exists";
+        readonly data: z.ZodObject<{
+          kind: z.ZodEnum<{
+            backup: "backup";
+            checkpoint: "checkpoint";
+            grant: "grant";
+            image: "image";
+            imp: "imp";
+            secret: "secret";
+            session: "session";
+          }>;
+          name: z.ZodString;
+        }, z.core.$strip>;
+      };
+      FORBIDDEN: {
+        readonly message: "Not allowed";
+      };
+      PRECONDITION_FAILED: {
+        readonly message: "Not possible on this host";
+      };
+      RAM_BUDGET_EXCEEDED: {
+        readonly message: "Not enough RAM budget, even after sleeping idle imps";
+        readonly status: 503;
+        readonly data: z.ZodObject<{
+          budgetMib: z.ZodInt;
+          usedMib: z.ZodInt;
+          requestedMib: z.ZodInt;
+        }, z.core.$strip>;
+      };
+      SERVICE_UNAVAILABLE: {
+        readonly message: "impd is stopping";
+      };
+      INVALID_STATE: {
+        readonly message: "The imp is not in a state that allows this";
+        readonly status: 409;
+        readonly data: z.ZodObject<{
+          state: z.ZodEnum<{
+            creating: "creating";
+            error: "error";
+            running: "running";
+            sleeping: "sleeping";
+            stopped: "stopped";
+          }>;
+          allowed: z.ZodArray<z.ZodEnum<{
+            creating: "creating";
+            error: "error";
+            running: "running";
+            sleeping: "sleeping";
+            stopped: "stopped";
+          }>>;
+        }, z.core.$strip>;
+      };
+      AGENT_OUTDATED: {
+        readonly message: "The imp's agent is too old for this";
+        readonly status: 409;
+      };
+    }>, Record<never, never>>;
   };
   system: {
     info: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
@@ -3463,4 +4059,4 @@ export declare class ExecError extends Error {
   }>);
 }
 //#endregion
-export { type AttachOptions, type Checkpoint, type ConsoleOptions, type DetachReason, type ExecClientErrorCode, type ExecExit, type ExecHandle, type ExecOptions, type ExecOutcome, type ExecSession, type ExecSessionOptions, type ExecStarted, type Image, type Imp, type ImpClient, type ImpClientOptions, type ImpState, ORPCError, type RequireAwakeOptions, type RunOptions, type RunResult, type ServerCheck, type Session, type SystemInfo, isDefinedError, safe };
+export { type ApiCall, type AttachOptions, type Checkpoint, type ConsoleOptions, type DetachReason, type ExecClientErrorCode, type ExecExit, type ExecHandle, type ExecOptions, type ExecOutcome, type ExecSession, type ExecSessionOptions, type ExecStarted, type Image, type Imp, type ImpClient, type ImpClientOptions, type ImpEvent, type ImpState, ORPCError, type RequireAwakeOptions, type RunOptions, type RunResult, type ServerCheck, type Session, type SystemInfo, isDefinedError, safe };

package/dist/index.js

@@ -3,7 +3,7 @@ import { RPCLink } from "@orpc/client/fetch";
 import * as z from "zod";
 //#endregion
 //#region src/check-server.ts
-const CLIENT_VERSION = "0.3.0";
+const CLIENT_VERSION = "0.4.0";
 async function checkServer(rpc) {
 	const info = await rpc.system.info();
 	return {
@@ -663,6 +663,7 @@ function createImpClient(options) {
 		secrets: rpc.secrets,
 		grants: rpc.grants,
 		audit: rpc.audit,
+		events: rpc.events,
 		system: rpc.system
 	};
 	const execDeps = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zgeoff/imp-client",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Typed client for impd, the imp host daemon: imps, checkpoints, images and exec",
   "license": "MIT",
   "repository": {