@jdg-keyforge/protocol 0.12.0 → 0.12.1

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.
Files changed (9) hide show
  1. package/dist/common.d.ts +1 -1
  2. package/dist/methods/delete_profile.d.ts +1 -1
  3. package/dist/methods/get_auto_switch.d.ts +1 -1
  4. package/dist/methods/set_auto_switch.d.ts +2 -2
  5. package/package.json +1 -1
  6. package/src/common.ts +1 -1
  7. package/src/methods/delete_profile.ts +1 -1
  8. package/src/methods/get_auto_switch.ts +1 -1
  9. package/src/methods/set_auto_switch.ts +2 -2
package/dist/common.d.ts CHANGED
@@ -292,7 +292,7 @@ export interface AutoSwitchRule {
292
292
  */
293
293
  app: string;
294
294
  /**
295
- * Identifier of the profile to activate when this app is frontmost.
295
+ * Identifier of the profile to activate when this app is frontmost. Must reference an existing profile: set_auto_switch rejects unknown ids with PROFILE_NOT_FOUND, and delete_profile removes the rules pointing to the deleted profile.
296
296
  */
297
297
  profile_id: string;
298
298
  }
package/dist/methods/delete_profile.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * and run json-schema-to-typescript to regenerate this file.
5
5
  */
6
6
  /**
7
- * Deletes a profile. The daemon never deletes the last remaining profile. Deleting the active profile reassigns the active one, so the resulting active profile id is always returned.
7
+ * Deletes a profile. The daemon never deletes the last remaining profile. Deleting the active profile reassigns the active one, so the resulting active profile id is always returned. Auto-switch rules whose profile_id points to the deleted profile are deleted with it, so the stored rule set never references a missing profile.
8
8
  */
9
9
  export interface MethodDeleteProfile {
10
10
  params: {
package/dist/methods/get_auto_switch.d.ts CHANGED
@@ -31,7 +31,7 @@ export interface AutoSwitchRule {
31
31
  */
32
32
  app: string;
33
33
  /**
34
- * Identifier of the profile to activate when this app is frontmost.
34
+ * Identifier of the profile to activate when this app is frontmost. Must reference an existing profile: set_auto_switch rejects unknown ids with PROFILE_NOT_FOUND, and delete_profile removes the rules pointing to the deleted profile.
35
35
  */
36
36
  profile_id: string;
37
37
  }
package/dist/methods/set_auto_switch.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * and run json-schema-to-typescript to regenerate this file.
5
5
  */
6
6
  /**
7
- * Replaces the entire auto-switch configuration in one shot (bulk set, not per-rule CRUD): the master toggle and the full rule set. The result echoes the persisted state.
7
+ * Replaces the entire auto-switch configuration in one shot (bulk set, not per-rule CRUD): the master toggle and the full rule set. The result echoes the persisted state. The daemon rejects the whole request with error code PROFILE_NOT_FOUND if any rule's profile_id does not exist; nothing is persisted in that case.
8
8
  */
9
9
  export interface MethodSetAutoSwitch {
10
10
  params: {
@@ -37,7 +37,7 @@ export interface AutoSwitchRule {
37
37
  */
38
38
  app: string;
39
39
  /**
40
- * Identifier of the profile to activate when this app is frontmost.
40
+ * Identifier of the profile to activate when this app is frontmost. Must reference an existing profile: set_auto_switch rejects unknown ids with PROFILE_NOT_FOUND, and delete_profile removes the rules pointing to the deleted profile.
41
41
  */
42
42
  profile_id: string;
43
43
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jdg-keyforge/protocol",
3
- "version": "0.12.0",
3
+ "version": "0.12.1",
4
4
  "description": "TypeScript types for the KeyForge WebSocket protocol, generated from the canonical JSON Schema contracts.",
5
5
  "keywords": ["keyforge", "protocol", "types", "json-schema", "websocket"],
6
6
  "license": "Apache-2.0",
package/src/common.ts CHANGED
@@ -295,7 +295,7 @@ export interface AutoSwitchRule {
295
295
  */
296
296
  app: string;
297
297
  /**
298
- * Identifier of the profile to activate when this app is frontmost.
298
+ * Identifier of the profile to activate when this app is frontmost. Must reference an existing profile: set_auto_switch rejects unknown ids with PROFILE_NOT_FOUND, and delete_profile removes the rules pointing to the deleted profile.
299
299
  */
300
300
  profile_id: string;
301
301
  }
package/src/methods/delete_profile.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  */
7
7
 
8
8
  /**
9
- * Deletes a profile. The daemon never deletes the last remaining profile. Deleting the active profile reassigns the active one, so the resulting active profile id is always returned.
9
+ * Deletes a profile. The daemon never deletes the last remaining profile. Deleting the active profile reassigns the active one, so the resulting active profile id is always returned. Auto-switch rules whose profile_id points to the deleted profile are deleted with it, so the stored rule set never references a missing profile.
10
10
  */
11
11
  export interface MethodDeleteProfile {
12
12
  params: {
package/src/methods/get_auto_switch.ts CHANGED
@@ -33,7 +33,7 @@ export interface AutoSwitchRule {
33
33
  */
34
34
  app: string;
35
35
  /**
36
- * Identifier of the profile to activate when this app is frontmost.
36
+ * Identifier of the profile to activate when this app is frontmost. Must reference an existing profile: set_auto_switch rejects unknown ids with PROFILE_NOT_FOUND, and delete_profile removes the rules pointing to the deleted profile.
37
37
  */
38
38
  profile_id: string;
39
39
  }
package/src/methods/set_auto_switch.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  */
7
7
 
8
8
  /**
9
- * Replaces the entire auto-switch configuration in one shot (bulk set, not per-rule CRUD): the master toggle and the full rule set. The result echoes the persisted state.
9
+ * Replaces the entire auto-switch configuration in one shot (bulk set, not per-rule CRUD): the master toggle and the full rule set. The result echoes the persisted state. The daemon rejects the whole request with error code PROFILE_NOT_FOUND if any rule's profile_id does not exist; nothing is persisted in that case.
10
10
  */
11
11
  export interface MethodSetAutoSwitch {
12
12
  params: {
@@ -39,7 +39,7 @@ export interface AutoSwitchRule {
39
39
  */
40
40
  app: string;
41
41
  /**
42
- * Identifier of the profile to activate when this app is frontmost.
42
+ * Identifier of the profile to activate when this app is frontmost. Must reference an existing profile: set_auto_switch rejects unknown ids with PROFILE_NOT_FOUND, and delete_profile removes the rules pointing to the deleted profile.
43
43
  */
44
44
  profile_id: string;
45
45
  }