heim 0.1.0-alpha.2 → 0.1.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/gen/heim.d.ts DELETED
@@ -1,266 +0,0 @@
1
- /* eslint-disable */
2
- /**
3
- * This file was automatically generated by json-schema-to-typescript.
4
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
5
- * and run json-schema-to-typescript to regenerate this file.
6
- */
7
-
8
- /**
9
- * This json schema defines common types used in the Go CLI and the TypeScript library.
10
- */
11
- export interface HeimTypes {
12
- /**
13
- * The manifest of the heim app.
14
- */
15
- manifest: {
16
- /**
17
- * Part of the id of the app. It needs to be unique within one namespace.
18
- */
19
- name: string;
20
- /**
21
- * The version of the app, must be a valid semver version.
22
- */
23
- version: string;
24
- /**
25
- * Display name shown in the UI.
26
- */
27
- title: LocalizedString | string;
28
- /**
29
- * A short description of the app.
30
- */
31
- tagline: LocalizedString1 | string;
32
- /**
33
- * The description of the app. It needs to be a markdown file.
34
- */
35
- readme?: LocalizedString2 | string;
36
- /**
37
- * The category of the app.
38
- */
39
- category:
40
- | "books"
41
- | "medical"
42
- | "business"
43
- | "music"
44
- | "developer-tools"
45
- | "navigation"
46
- | "education"
47
- | "news"
48
- | "entertainment"
49
- | "photo-and-video"
50
- | "finance"
51
- | "productivity"
52
- | "food-and-drink"
53
- | "reference"
54
- | "games"
55
- | "graphics-and-design"
56
- | "shopping"
57
- | "health-and-fitness"
58
- | "social-networking"
59
- | "lifestyle"
60
- | "sports"
61
- | "kids"
62
- | "travel"
63
- | "magazines-and-newspapers"
64
- | "utilities"
65
- | "weather";
66
- /**
67
- * The developer (individual person or company) of the app. This is either you or the original developer of the software.
68
- */
69
- developer: string;
70
- /**
71
- * The icon of the app. It needs to be an SVG file.
72
- */
73
- icon?: string;
74
- /**
75
- * A list of images that showcase the app.
76
- */
77
- galleryImages?: string[] | LocalizedString3;
78
- /**
79
- * The website of the app.
80
- */
81
- website?: string;
82
- /**
83
- * The version control repository of the app (e.g. GitHub).
84
- */
85
- repository?: string;
86
- /**
87
- * The support website of the app.
88
- */
89
- support?: string;
90
- /**
91
- * The license file of the app.
92
- */
93
- license?: LocalizedString4 | string;
94
- };
95
- /**
96
- * The http(s) configuration of the user interface for the app.
97
- */
98
- ui?: {
99
- /**
100
- * The name of the compose service that provides the user interface.
101
- */
102
- service: string;
103
- /**
104
- * The port of the compose service that provides the user interface. Note that this port does NOT need to be exposed by the container runtime.
105
- */
106
- port: number;
107
- /**
108
- * The url path of the compose service that provides the user interface.
109
- */
110
- path?: string;
111
- /**
112
- * Whether the user interface of this app has an auth in front of it. Can be 'true' if the app itself provides an authentication mechanism or is intended to be public.
113
- */
114
- hasAuth?: boolean;
115
- };
116
- /**
117
- * The backup configuration of the app.
118
- */
119
- backup?: {
120
- volumes?: {
121
- /**
122
- * A list of volume names to include in the backup. If neither this list nor the exclude list is set, all volumes will be included. If both lists are set, only the volumes in the include list that are not in the exclude list will be included.
123
- */
124
- include?: string[];
125
- /**
126
- * A list of volume names to exclude from the backup. If neither this list nor the include list is set, all volumes will be included. If both lists are set, only the volumes in the include list that are not in the exclude list will be included.
127
- */
128
- exclude?: string[];
129
- };
130
- /**
131
- * The command to run before backing up the app.
132
- */
133
- beforeBackup?: {
134
- /**
135
- * The name of the compose service to run the command in.
136
- */
137
- service?: string;
138
- /**
139
- * The command to run before backing up the app.
140
- */
141
- command?: string;
142
- };
143
- /**
144
- * The command to run after backing up the app.
145
- */
146
- afterBackup?: {
147
- /**
148
- * The name of the compose service to run the command in.
149
- */
150
- service?: string;
151
- /**
152
- * The command to run after backing up the app.
153
- */
154
- command?: string;
155
- };
156
- /**
157
- * The command to run before restoring the app.
158
- */
159
- beforeRestore?: {
160
- /**
161
- * The name of the compose service to run the command in.
162
- */
163
- service?: string;
164
- /**
165
- * The command to run before restoring the app.
166
- */
167
- command?: string;
168
- };
169
- /**
170
- * The command to run after restoring the app.
171
- */
172
- afterRestore?: {
173
- /**
174
- * The name of the compose service to run the command in.
175
- */
176
- service?: string;
177
- /**
178
- * The command to run after restoring the app.
179
- */
180
- command?: string;
181
- };
182
- };
183
- /**
184
- * The hooks configuration of the app.
185
- */
186
- hooks?: {
187
- /**
188
- * The command to run before installing the app.
189
- */
190
- preInstall?: string;
191
- /**
192
- * The command to run after installing the app.
193
- */
194
- postInstall?: string;
195
- /**
196
- * The command to run before updating the app.
197
- */
198
- preUpdate?: string;
199
- /**
200
- * The command to run after updating the app.
201
- */
202
- postUpdate?: string;
203
- /**
204
- * The command to run before uninstalling the app.
205
- */
206
- preUninstall?: string;
207
- /**
208
- * The command to run after uninstalling the app.
209
- */
210
- postUninstall?: string;
211
- /**
212
- * The command to run before backing up the app.
213
- */
214
- preBackup?: string;
215
- /**
216
- * The command to run after backing up the app.
217
- */
218
- postBackup?: string;
219
- /**
220
- * The command to run before restoring the app.
221
- */
222
- preRestore?: string;
223
- /**
224
- * The command to run after restoring the app.
225
- */
226
- postRestore?: string;
227
- };
228
- }
229
- /**
230
- * A string that is translated in different languages.
231
- */
232
- export interface LocalizedString {
233
- en: string[] | string;
234
- [k: string]: string;
235
- }
236
- /**
237
- * A string that is translated in different languages.
238
- */
239
- export interface LocalizedString1 {
240
- en: string[] | string;
241
- [k: string]: string;
242
- }
243
- /**
244
- * A string that is translated in different languages.
245
- */
246
- export interface LocalizedString2 {
247
- en: string[] | string;
248
- [k: string]: string;
249
- }
250
- /**
251
- * A string that is translated in different languages.
252
- */
253
- export interface LocalizedString3 {
254
- en: string[] | string;
255
- /**
256
- * @maxItems 10
257
- */
258
- [k: string]: string[];
259
- }
260
- /**
261
- * A string that is translated in different languages.
262
- */
263
- export interface LocalizedString4 {
264
- en: string[] | string;
265
- [k: string]: string;
266
- }