homeio

1import type { AppConditionSummary } from "@/lib/shared/app-condition";
2
3export type StoreOperationAction =
4  | "install"
5  | "update"
6  | "redeploy"
7  | "uninstall"
8  | "start"
9  | "stop"
10  | "restart"
11  | "check-updates";
12
13export type StoreOperationStatus = "queued" | "running" | "success" | "error";
14
15export type StoreOperation = {
16  id: string;
17  appId: string;
18  action: StoreOperationAction;
19  status: StoreOperationStatus;
20  progressPercent: number;
21  currentStep: string;
22  errorMessage: string | null;
23  startedAt: string | null;
24  finishedAt: string | null;
25  updatedAt: string;
26};
27
28export type InstalledAppActiveOperation = Pick<
29  StoreOperation,
30  "id" | "action" | "status" | "progressPercent" | "currentStep" | "updatedAt"
31>;
32
33export type InstalledApp = {
34  id: string;
35  name: string;
36  stackName: string;
37  composePath: string;
38  webUiPort?: number | null;
39  /** Operator-set link for this app. Null means "build the default from the browser location". */
40  webUiUrl?: string | null;
41  containerName?: string | null;
42  logoUrl?: string | null;
43  status: "running" | "partial" | "paused" | "stopped" | "unknown";
44  /** Finer than status: a clean stop vs a crash, a restart loop, a failing health check. */
45  condition?: AppConditionSummary | null;
46  activeOperation?: InstalledAppActiveOperation | null;
47  updatedAt: string;
48};
49
50export type InstalledStackStatus =
51  | "installed"
52  | "not_installed"
53  | "installing"
54  | "error"
55  | "updating"
56  | "uninstalling";
57
58export type StoreAppEnvDefinition = {
59  name: string;
60  label?: string;
61  description?: string;
62  default?: string;
63};
64
65export type StoreCatalogSourceKind = "official" | "remote";
66export type StoreAppSourceKind = StoreCatalogSourceKind | "custom";
67export type StoreCatalogSourceStatus = "ready" | "syncing" | "error";
68
69export type StoreCatalogSource = {
70  id: string;
71  name: string;
72  url: string;
73  kind: StoreCatalogSourceKind;
74  enabled: boolean;
75  status: StoreCatalogSourceStatus;
76  sourcePath: string;
77  suppressedAppIds: string[];
78  addedAt: string;
79  updatedAt: string;
80  lastSyncedAt: string | null;
81  lastError: string | null;
82};
83
84export type StoreCatalogSourceCreateRequest = {
85  url: string;
86  name?: string;
87};
88
89export type StoreCatalogSourceUpdateRequest = {
90  enabled: boolean;
91};
92
93export type StoreAppSummary = {
94  id: string;
95  name: string;
96  description: string;
97  platform: string;
98  categories: string[];
99  logoUrl: string | null;
100  repositoryUrl: string;
101  stackFile: string;
102  status: InstalledStackStatus;
103  webUiPort: number | null;
104  updateAvailable: boolean;
105  installedImage?: string | null;
106  image?: string | null;
107  sourceId: string;
108  sourceName: string;
109  sourceKind: StoreAppSourceKind;
110};
111
112export type StoreAppDetail = StoreAppSummary & {
113  note: string;
114  env: StoreAppEnvDefinition[];
115  screenshots: string[];
116  installedConfig: InstalledStackConfig | null;
117};
118
119export type InstalledStackConfig = {
120  appId: string;
121  templateName: string;
122  stackName: string;
123  composePath: string;
124  status: InstalledStackStatus;
125  webUiPort: number | null;
126  webUiUrl: string | null;
127  tunnelSubdomain: string | null;
128  env: Record<string, string>;
129  displayName: string | null;
130  iconUrl: string | null;
131  installedAt: string | null;
132  updatedAt: string;
133  isUpToDate: boolean;
134  lastUpdateCheck: string | null;
135};
136
137export type DockerPullProgressDetail = {
138  current: number;
139  total: number;
140  percent: number | null;
141};
142
143export type StoreOperationEventType =
144  | "operation.started"
145  | "operation.step"
146  | "operation.pull.progress"
147  | "operation.completed"
148  | "operation.failed";
149
150export type StoreOperationEvent = {
151  type: StoreOperationEventType;
152  operationId: string;
153  appId: string;
154  action: StoreOperationAction;
155  status: StoreOperationStatus;
156  timestamp: string;
157  progressPercent: number;
158  step: string;
159  message?: string;
160  image?: string;
161  dockerStatus?: string;
162  progressDetail?: DockerPullProgressDetail;
163};
164