homeio

1import type { AppConditionSummary } from "@/lib/shared/app-condition";
2
3export type ContainerStats = {
4  id: string;
5  name: string;
6  state: string;
7  cpuPercent: number;
8  memoryUsed: number;
9  memoryLimit: number;
10  memoryPercent: number;
11  networkRx: number;
12  networkTx: number;
13  blockRead: number;
14  blockWrite: number;
15};
16
17/** Shape returned by both the REST endpoint and the SSE "stats.updated" event. */
18export type DockerStatsPayload = {
19  containers: ContainerStats[];
20  /** false when the Docker daemon socket is unreachable. */
21  daemonAvailable: boolean;
22};
23
24export type DockerStatsResponse = {
25  data: DockerStatsPayload;
26};
27
28export type DockerStatsStreamEvent = {
29  type: "stats.updated" | "heartbeat";
30  data: DockerStatsPayload | { timestamp: string };
31};
32
33/** Engine-level metadata returned by GET /api/v1/docker/info */
34export type DockerInfo = {
35  engineVersion: string;
36  composeVersion: string;
37  storageDriver: string;
38  cgroupDriver: string;
39  images: number;
40};
41
42export type DockerInfoResponse = {
43  data: DockerInfo;
44};
45
46/** A container running on this host that Homeio did not deploy. */
47export type UnmanagedContainer = {
48  id: string;
49  name: string;
50  image: string;
51  /** Docker's own state: running, exited, paused, restarting, ... */
52  state: string;
53  /** Docker's human status line, e.g. "Up 3 days". */
54  status: string;
55  /** What the container is doing, read from state and status line. */
56  condition: AppConditionSummary;
57  composeProject: string | null;
58  /** Name the operator gave it in Homeio; the Docker name when null. */
59  displayName: string | null;
60  /** Icon the operator picked; the default container icon when null. */
61  iconUrl: string | null;
62  /** Link "Open Dashboard" goes to; disabled when null. */
63  dashboardUrl: string | null;
64};
65
66/** What an operator can change about a container Homeio did not deploy. */
67export type ContainerCustomization = {
68  displayName: string | null;
69  iconUrl: string | null;
70  dashboardUrl: string | null;
71};
72