@crossworks/client-types 0.239.20 → 0.239.22
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/package.json +1 -1
- package/src/dto/services.ts +8 -2
package/package.json
CHANGED
package/src/dto/services.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Optional services: the box services an admin can switch on and off from
|
|
3
|
-
* the dashboard (sandboxes, media
|
|
3
|
+
* the dashboard (sandboxes, media, the local embedder and, on a core box,
|
|
4
|
+
* the doc helpers). GET /api/services returns a
|
|
4
5
|
* {@link ServicesView}; POST /api/services/:name {enable} asks the updater
|
|
5
6
|
* sidecar to switch one; GET /api/services/status is the progress poll.
|
|
6
7
|
*/
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
/** Each name is also the service's compose profile. */
|
|
10
|
+
export type OptionalServiceName = 'sandboxes' | 'media' | 'local-embedder' | 'helpers';
|
|
9
11
|
|
|
10
12
|
/**
|
|
11
13
|
* - `off`: the compose profile is not active (the resting state).
|
|
@@ -34,6 +36,10 @@ export type ServiceDescription = {
|
|
|
34
36
|
memoryMaxMb: number;
|
|
35
37
|
/** A security note, when the service carries one. */
|
|
36
38
|
note: string | null;
|
|
39
|
+
/** One line the confirm dialog shows as a warning before the service goes
|
|
40
|
+
* off, when switching it off has a cost the admin must see (new content
|
|
41
|
+
* not searchable, files not read). Absent from older brains. */
|
|
42
|
+
offWarning?: string | null;
|
|
37
43
|
};
|
|
38
44
|
|
|
39
45
|
export type ServiceInfo = {
|