@domicile-desktop/sdk 0.0.0-alpha-6bc638ea9e65 → 0.0.0-alpha-e25345856a61
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/config.schema.json +10 -8
- package/dist/config.d.ts +17 -26
- package/package.json +1 -1
package/config.schema.json
CHANGED
|
@@ -169,7 +169,7 @@
|
|
|
169
169
|
},
|
|
170
170
|
"IdleConfig": {
|
|
171
171
|
"additionalProperties": false,
|
|
172
|
-
"description": "When an idle desktop turns its screens off.\n\nAbsent means
|
|
172
|
+
"description": "When an idle desktop turns its screens off, and when it locks.\n\nAbsent means neither, and that is the default: a blank screen looks like a\ncrash, so a shell must opt in. The two timeouts run on separate clocks\nfrom the same input and inhibitors, so either may be the shorter. See\n`docs/IDLE.md`.\n\nThe unit is in the key name because a generator writes this file.",
|
|
173
173
|
"properties": {
|
|
174
174
|
"blank_after_seconds": {
|
|
175
175
|
"default": null,
|
|
@@ -178,6 +178,13 @@
|
|
|
178
178
|
"minimum": 0,
|
|
179
179
|
"type": ["integer", "null"]
|
|
180
180
|
},
|
|
181
|
+
"lock_after_seconds": {
|
|
182
|
+
"default": null,
|
|
183
|
+
"description": "Seconds without input before the desktop locks.\n\nAbsent means the desktop locks only when its shell asks. Zero is\nrefused.",
|
|
184
|
+
"format": "uint64",
|
|
185
|
+
"minimum": 0,
|
|
186
|
+
"type": ["integer", "null"]
|
|
187
|
+
},
|
|
181
188
|
"warn_before_seconds": {
|
|
182
189
|
"default": null,
|
|
183
190
|
"description": "Seconds before the screens go dark that the shell is warned, so it can\ndim or count down. Input in that time calls the blanking off.\n\nAbsent means no warning. It must be at least 1 and less than\n`blank_after_seconds`.",
|
|
@@ -230,16 +237,11 @@
|
|
|
230
237
|
},
|
|
231
238
|
"LockConfig": {
|
|
232
239
|
"additionalProperties": false,
|
|
233
|
-
"description": "What unlocks this desk
|
|
240
|
+
"description": "What unlocks this desk: the user's password, checked by PAM.\n\nIf `/etc/pam.d` lacks the service, the desk still locks, and nothing\nunlocks it until the file is added. See `docs/LOCK.md#verifiers`.",
|
|
234
241
|
"properties": {
|
|
235
242
|
"pam_service": {
|
|
236
243
|
"default": null,
|
|
237
|
-
"description": "The PAM service the desk's user authenticates against.\n\
|
|
238
|
-
"type": ["string", "null"]
|
|
239
|
-
},
|
|
240
|
-
"passphrase_hash": {
|
|
241
|
-
"default": null,
|
|
242
|
-
"description": "The crypt(3) hash of the passphrase that unlocks this desk, as\n`mkpasswd` prints. An empty string is refused.",
|
|
244
|
+
"description": "The PAM service the desk's user authenticates against.\n\nAbsent means `\"domicile\"`, which the NixOS module and the distribution\npackages declare.",
|
|
243
245
|
"type": ["string", "null"]
|
|
244
246
|
}
|
|
245
247
|
},
|
package/dist/config.d.ts
CHANGED
|
@@ -138,11 +138,12 @@ export type FilesConfig = {
|
|
|
138
138
|
*/
|
|
139
139
|
export type FilesOmit = string[];
|
|
140
140
|
/**
|
|
141
|
-
* When an idle desktop turns its screens off.
|
|
141
|
+
* When an idle desktop turns its screens off, and when it locks.
|
|
142
142
|
*
|
|
143
|
-
* Absent means
|
|
144
|
-
* crash, so a shell must opt in.
|
|
145
|
-
*
|
|
143
|
+
* Absent means neither, and that is the default: a blank screen looks like a
|
|
144
|
+
* crash, so a shell must opt in. The two timeouts run on separate clocks
|
|
145
|
+
* from the same input and inhibitors, so either may be the shorter. See
|
|
146
|
+
* `docs/IDLE.md`.
|
|
146
147
|
*
|
|
147
148
|
* The unit is in the key name because a generator writes this file.
|
|
148
149
|
*/
|
|
@@ -153,6 +154,13 @@ export type IdleConfig = {
|
|
|
153
154
|
* Absent means never. Zero is refused.
|
|
154
155
|
*/
|
|
155
156
|
blank_after_seconds?: number | null;
|
|
157
|
+
/**
|
|
158
|
+
* Seconds without input before the desktop locks.
|
|
159
|
+
*
|
|
160
|
+
* Absent means the desktop locks only when its shell asks. Zero is
|
|
161
|
+
* refused.
|
|
162
|
+
*/
|
|
163
|
+
lock_after_seconds?: number | null;
|
|
156
164
|
/**
|
|
157
165
|
* Seconds before the screens go dark that the shell is warned, so it can
|
|
158
166
|
* dim or count down. Input in that time calls the blanking off.
|
|
@@ -181,36 +189,19 @@ export type KeyboardConfig = {
|
|
|
181
189
|
xkb_variant?: string;
|
|
182
190
|
};
|
|
183
191
|
/**
|
|
184
|
-
* What unlocks this desk.
|
|
185
|
-
*
|
|
186
|
-
* Absent means the desk never locks, and that is the default: a locked desk
|
|
187
|
-
* with no verifier cannot be unlocked. Such a desk never sends
|
|
188
|
-
* `HostMessage::Locked`.
|
|
192
|
+
* What unlocks this desk: the user's password, checked by PAM.
|
|
189
193
|
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
* - `passphrase_hash` is for machines without a PAM service. The file is
|
|
193
|
-
* generated, often into the world-readable Nix store, so it holds a hash
|
|
194
|
-
* rather than the passphrase.
|
|
195
|
-
*
|
|
196
|
-
* A config with both is refused, so a passphrase is never mistaken for a PAM
|
|
197
|
-
* fallback. A PAM service that does not exist, or a hash the machine's
|
|
198
|
-
* libcrypt will not take, stops the compositor from starting. See
|
|
199
|
-
* `docs/LOCK.md#verifiers`.
|
|
194
|
+
* If `/etc/pam.d` lacks the service, the desk still locks, and nothing
|
|
195
|
+
* unlocks it until the file is added. See `docs/LOCK.md#verifiers`.
|
|
200
196
|
*/
|
|
201
197
|
export type LockConfig = {
|
|
202
198
|
/**
|
|
203
199
|
* The PAM service the desk's user authenticates against.
|
|
204
200
|
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
201
|
+
* Absent means `"domicile"`, which the NixOS module and the distribution
|
|
202
|
+
* packages declare.
|
|
207
203
|
*/
|
|
208
204
|
pam_service?: string | null;
|
|
209
|
-
/**
|
|
210
|
-
* The crypt(3) hash of the passphrase that unlocks this desk, as
|
|
211
|
-
* `mkpasswd` prints. An empty string is refused.
|
|
212
|
-
*/
|
|
213
|
-
passphrase_hash?: string | null;
|
|
214
205
|
};
|
|
215
206
|
/**
|
|
216
207
|
* What applications are told not to do, through the
|
package/package.json
CHANGED