homeio

1export type DiskMediaType = "ssd" | "hdd" | "nvme" | "removable" | "unknown";
2
3export type DiskPartition = {
4  name: string;
5  device: string;
6  number: number | null;
7  fstype: string | null;
8  label: string | null;
9  uuid: string | null;
10  sizeBytes: number | null;
11  mountpoint: string | null;
12  type: string;
13  ro: boolean;
14};
15
16export type DiskDevice = {
17  name: string;
18  device: string;
19  model: string | null;
20  vendor: string | null;
21  serial: string | null;
22  sizeBytes: number | null;
23  mediaType: DiskMediaType;
24  transport: string | null;
25  isRemovable: boolean;
26  partitions: DiskPartition[];
27};
28
29export type DiskListResponse = {
30  disks: DiskDevice[];
31  /** Why the list is empty when disks could not be read at all; null otherwise. */
32  unavailableReason: string | null;
33  /** In the Docker image disks can be listed but not formatted, partitioned or mounted. */
34  readOnly: boolean;
35};
36
37export const DISK_FILESYSTEMS = ["ext4", "ext3", "btrfs", "xfs", "ntfs", "vfat", "exfat"] as const;
38export type DiskFilesystem = (typeof DISK_FILESYSTEMS)[number];
39
40export type DiskFormatRequest = {
41  device: string;
42  filesystem: DiskFilesystem;
43  label?: string;
44};
45
46export type DiskMountRequest = {
47  device: string;
48  mountPoint: string;
49  addToFstab?: boolean;
50};
51
52export type DiskUnmountRequest = {
53  device: string;
54};
55
56export type DiskCreatePartitionRequest = {
57  disk: string;
58  start: string;
59  end: string;
60  filesystem?: string;
61};
62
63export type DiskDeletePartitionRequest = {
64  device: string;
65};
66
67export type DiskWipeRequest = {
68  disk: string;
69};
70
71export type DiskActionResponse = {
72  accepted: true;
73  action: string;
74};
75
76/** One disk as the Monitor's Disks tab shows it: identity, live throughput and SMART. */
77export type DiskMonitorEntry = {
78  name: string;
79  device: string;
80  model: string | null;
81  vendor: string | null;
82  sizeBytes: number | null;
83  mediaType: DiskMediaType;
84  transport: string | null;
85  isRemovable: boolean;
86  /** Null until a second reading exists, or off Linux. */
87  readBytesPerSec: number | null;
88  writeBytesPerSec: number | null;
89  /** From SMART; null when smartctl has nothing for this disk. */
90  health: "healthy" | "degraded" | "unknown" | null;
91  temperatureCelsius: number | null;
92  powerOnHours: number | null;
93  partitions: Pick<DiskPartition, "name" | "mountpoint" | "fstype" | "sizeBytes">[];
94};
95
96export type DiskMonitorResponse = {
97  disks: DiskMonitorEntry[];
98  /**
99   * In the Docker image lsblk reports the container's own mounts (/etc/hosts…),
100   * so partition mount points are left out rather than shown wrong.
101   */
102  inContainer: boolean;
103  unavailableReason: string | null;
104  sampledAt: string;
105};
106