@kusinta/iot-schema 0.2.0-beta.42 → 0.2.0-beta.44

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kusinta/iot-schema",
3
- "version": "0.2.0-beta.42",
3
+ "version": "0.2.0-beta.44",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "files": ["src"],
@@ -544,6 +544,14 @@ export declare const CommissioningProfileSchema: GenMessage<CommissioningProfile
544
544
  * a renovation. Binding a new output, or a new device, is what it can show. All the owner
545
545
  * organisation learns of a home's commissioning.
546
546
  *
547
+ * The REQUIRED keys are those this file marks REQUIRED (HOUSEHOLD QUESTIONS) and no other, so
548
+ * that set_up means the same on every gateway. A home with no room is not set up. Once a
549
+ * home has been set up, its facts count neither way, whatever changes since — a room
550
+ * created, an answer removed, a key a later release of this schema marks REQUIRED: only an
551
+ * output bound since without a pass on the device it is bound to makes it not set up. A
552
+ * household handover does not reset it: the home stays set up for the next household, so
553
+ * that set_up tells the owner organisation nothing of who moved in or out.
554
+ *
547
555
  * @generated from message kusinta.iot.commissioning.v1.HomeSetup
548
556
  */
549
557
  export declare type HomeSetup = Message<"kusinta.iot.commissioning.v1.HomeSetup"> & {
@@ -260,6 +260,28 @@ export declare type HouseholdHandover = Message<"kusinta.iot.webrtc.v1.Household
260
260
  * @generated from field: bool vacated = 10;
261
261
  */
262
262
  vacated: boolean;
263
+
264
+ /**
265
+ * Set by the gateway per session: the session's user is a member of the household the
266
+ * handover is about — the home's residents while it is not vacated, the departing household
267
+ * (VACANCY) while it is. Someone who is both staff and in that household is told both, so a
268
+ * client offers them the household's export, and with recipient_household_admin its
269
+ * confirmation, as well as what staff may do, rather than guessing from roles which of the
270
+ * two they are.
271
+ *
272
+ * @generated from field: bool recipient_in_household = 11;
273
+ */
274
+ recipientInHousehold: boolean;
275
+
276
+ /**
277
+ * Set by the gateway per session: the session's user may confirm the handover as a household
278
+ * admin — a household admin of the home now, or, for a vacated one, one of the departing
279
+ * household's admins (VACANCY). A client offers confirmation on this, not on
280
+ * recipient_in_household, which a plain resident holds too.
281
+ *
282
+ * @generated from field: bool recipient_household_admin = 12;
283
+ */
284
+ recipientHouseholdAdmin: boolean;
263
285
  };
264
286
 
265
287
  /**
@@ -476,7 +498,9 @@ export enum HouseholdHandoverState {
476
498
  CANCELLED = 2,
477
499
 
478
500
  /**
479
- * Confirmed, or the last residency of the home ended while it was pending.
501
+ * Confirmed, or, for a vacated one, its notice passed with nobody living in the home; the wipe
502
+ * has run. The last residency ending while one is pending makes it vacated, not done
503
+ * (VACANCY).
480
504
  *
481
505
  * @generated from enum value: HOUSEHOLD_HANDOVER_STATE_DONE = 3;
482
506
  */
@@ -13,7 +13,7 @@ import { file_kusinta_iot_identity_v1_identity } from "../../identity/v1/identit
13
13
  * Describes the file kusinta/iot/webrtc/v1/household.proto.
14
14
  */
15
15
  export const file_kusinta_iot_webrtc_v1_household = /*@__PURE__*/
16
- fileDesc("CiVrdXNpbnRhL2lvdC93ZWJydGMvdjEvaG91c2Vob2xkLnByb3RvEhVrdXNpbnRhLmlvdC53ZWJydGMudjEiewoURGVtb3RlSG91c2Vob2xkQWRtaW4SMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQSMAoHdXNlcl9pZBgCIAEoCzIfLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlVzZXJJZCL7AQoQU3RhZmZBcHBvaW50bWVudBIyCglhcHBvaW50ZWUYASABKAsyHy5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5Vc2VySWQSNQoMYXBwb2ludGVkX2J5GAIgASgLMh8ua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuVXNlcklkEhkKEWFwcG9pbnRlZF9ieV9uYW1lGAMgASgJEiYKAmF0GAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBI5CgRraW5kGAUgASgOMisua3VzaW50YS5pb3Qud2VicnRjLnYxLlN0YWZmQXBwb2ludG1lbnRLaW5kIksKFlN0YXJ0SG91c2Vob2xkSGFuZG92ZXISMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQiLwoYQ29uZmlybUhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJIi4KF0NhbmNlbEhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJIlEKFkxpc3RIb3VzZWhvbGRIYW5kb3ZlcnMSNwoNcm9vdF9zcGFjZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQirAMKEUhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJEjEKB2hvbWVfaWQYAiABKAsyIC5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5TcGFjZUlkEjwKBXN0YXRlGAMgASgOMi0ua3VzaW50YS5pb3Qud2VicnRjLnYxLkhvdXNlaG9sZEhhbmRvdmVyU3RhdGUSMwoKc3RhcnRlZF9ieRgEIAEoCzIfLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlVzZXJJZBIXCg9zdGFydGVkX2J5X25hbWUYBSABKAkSGAoQc3RhcnRlZF9ieV9zdGFmZhgGIAEoCBIuCgpzdGFydGVkX2F0GAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBI6ChZzdGFmZl9jb25maXJtYWJsZV9mcm9tGAggASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIsCghlbmRlZF9hdBgJIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASDwoHdmFjYXRlZBgKIAEoCCJOCgtTZXRIb21lTmFtZRIxCgdob21lX2lkGAEgASgLMiAua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuU3BhY2VJZBIMCgRuYW1lGAIgASgJIlEKEkhvdXNlaG9sZEhhbmRvdmVycxI7CgloYW5kb3ZlcnMYASADKAsyKC5rdXNpbnRhLmlvdC53ZWJydGMudjEuSG91c2Vob2xkSGFuZG92ZXIiXAoTRXhwb3J0SG91c2Vob2xkRGF0YRIxCgdob21lX2lkGAEgASgLMiAua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuU3BhY2VJZBISCgpwYXJ0X3Rva2VuGAIgASgJIrcDCg9Ib3VzZWhvbGRFeHBvcnQSMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQSQAoNcm9vbV9jbGltYXRlcxgCIAEoCzInLmt1c2ludGEuaW90LmNsaW1hdGUudjEuUm9vbUNsaW1hdGVMaXN0SAASOwoMcm9vbV9oaXN0b3J5GAMgASgLMiMua3VzaW50YS5pb3QuY2xpbWF0ZS52MS5Sb29tSGlzdG9yeUgAEkoKD2NsaW1hdGVfc3VtbWFyeRgEIAEoCzIvLmt1c2ludGEuaW90LmNsaW1hdGUudjEuQXBhcnRtZW50Q2xpbWF0ZVN1bW1hcnlIABJLCg1jb21taXNzaW9uaW5nGAUgASgLMjIua3VzaW50YS5pb3QuY29tbWlzc2lvbmluZy52MS5Db21taXNzaW9uaW5nUHJvZmlsZUgAEjgKB2hlYXRpbmcYBiABKAsyJS5rdXNpbnRhLmlvdC5oZWF0aW5nLnYxLkhlYXRpbmdMYXlvdXRIABIXCg9uZXh0X3BhcnRfdG9rZW4YByABKAlCBgoEcGFydCqHAQoUU3RhZmZBcHBvaW50bWVudEtpbmQSJgoiU1RBRkZfQVBQT0lOVE1FTlRfS0lORF9VTlNQRUNJRklFRBAAEiEKHVNUQUZGX0FQUE9JTlRNRU5UX0tJTkRfSU5WSVRFEAESJAogU1RBRkZfQVBQT0lOVE1FTlRfS0lORF9QUk9NT1RJT04QAiqzAQoWSG91c2Vob2xkSGFuZG92ZXJTdGF0ZRIoCiRIT1VTRUhPTERfSEFORE9WRVJfU1RBVEVfVU5TUEVDSUZJRUQQABIkCiBIT1VTRUhPTERfSEFORE9WRVJfU1RBVEVfUEVORElORxABEiYKIkhPVVNFSE9MRF9IQU5ET1ZFUl9TVEFURV9DQU5DRUxMRUQQAhIhCh1IT1VTRUhPTERfSEFORE9WRVJfU1RBVEVfRE9ORRADQgJIAWIGcHJvdG8z", [file_google_protobuf_timestamp, file_kusinta_iot_climate_v1_climate, file_kusinta_iot_commissioning_v1_commissioning, file_kusinta_iot_heating_v1_heating, file_kusinta_iot_identity_v1_identity]);
16
+ fileDesc("CiVrdXNpbnRhL2lvdC93ZWJydGMvdjEvaG91c2Vob2xkLnByb3RvEhVrdXNpbnRhLmlvdC53ZWJydGMudjEiewoURGVtb3RlSG91c2Vob2xkQWRtaW4SMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQSMAoHdXNlcl9pZBgCIAEoCzIfLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlVzZXJJZCL7AQoQU3RhZmZBcHBvaW50bWVudBIyCglhcHBvaW50ZWUYASABKAsyHy5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5Vc2VySWQSNQoMYXBwb2ludGVkX2J5GAIgASgLMh8ua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuVXNlcklkEhkKEWFwcG9pbnRlZF9ieV9uYW1lGAMgASgJEiYKAmF0GAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBI5CgRraW5kGAUgASgOMisua3VzaW50YS5pb3Qud2VicnRjLnYxLlN0YWZmQXBwb2ludG1lbnRLaW5kIksKFlN0YXJ0SG91c2Vob2xkSGFuZG92ZXISMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQiLwoYQ29uZmlybUhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJIi4KF0NhbmNlbEhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJIlEKFkxpc3RIb3VzZWhvbGRIYW5kb3ZlcnMSNwoNcm9vdF9zcGFjZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQi7wMKEUhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJEjEKB2hvbWVfaWQYAiABKAsyIC5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5TcGFjZUlkEjwKBXN0YXRlGAMgASgOMi0ua3VzaW50YS5pb3Qud2VicnRjLnYxLkhvdXNlaG9sZEhhbmRvdmVyU3RhdGUSMwoKc3RhcnRlZF9ieRgEIAEoCzIfLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlVzZXJJZBIXCg9zdGFydGVkX2J5X25hbWUYBSABKAkSGAoQc3RhcnRlZF9ieV9zdGFmZhgGIAEoCBIuCgpzdGFydGVkX2F0GAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBI6ChZzdGFmZl9jb25maXJtYWJsZV9mcm9tGAggASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIsCghlbmRlZF9hdBgJIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASDwoHdmFjYXRlZBgKIAEoCBIeChZyZWNpcGllbnRfaW5faG91c2Vob2xkGAsgASgIEiEKGXJlY2lwaWVudF9ob3VzZWhvbGRfYWRtaW4YDCABKAgiTgoLU2V0SG9tZU5hbWUSMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQSDAoEbmFtZRgCIAEoCSJRChJIb3VzZWhvbGRIYW5kb3ZlcnMSOwoJaGFuZG92ZXJzGAEgAygLMigua3VzaW50YS5pb3Qud2VicnRjLnYxLkhvdXNlaG9sZEhhbmRvdmVyIlwKE0V4cG9ydEhvdXNlaG9sZERhdGESMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQSEgoKcGFydF90b2tlbhgCIAEoCSK3AwoPSG91c2Vob2xkRXhwb3J0EjEKB2hvbWVfaWQYASABKAsyIC5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5TcGFjZUlkEkAKDXJvb21fY2xpbWF0ZXMYAiABKAsyJy5rdXNpbnRhLmlvdC5jbGltYXRlLnYxLlJvb21DbGltYXRlTGlzdEgAEjsKDHJvb21faGlzdG9yeRgDIAEoCzIjLmt1c2ludGEuaW90LmNsaW1hdGUudjEuUm9vbUhpc3RvcnlIABJKCg9jbGltYXRlX3N1bW1hcnkYBCABKAsyLy5rdXNpbnRhLmlvdC5jbGltYXRlLnYxLkFwYXJ0bWVudENsaW1hdGVTdW1tYXJ5SAASSwoNY29tbWlzc2lvbmluZxgFIAEoCzIyLmt1c2ludGEuaW90LmNvbW1pc3Npb25pbmcudjEuQ29tbWlzc2lvbmluZ1Byb2ZpbGVIABI4CgdoZWF0aW5nGAYgASgLMiUua3VzaW50YS5pb3QuaGVhdGluZy52MS5IZWF0aW5nTGF5b3V0SAASFwoPbmV4dF9wYXJ0X3Rva2VuGAcgASgJQgYKBHBhcnQqhwEKFFN0YWZmQXBwb2ludG1lbnRLaW5kEiYKIlNUQUZGX0FQUE9JTlRNRU5UX0tJTkRfVU5TUEVDSUZJRUQQABIhCh1TVEFGRl9BUFBPSU5UTUVOVF9LSU5EX0lOVklURRABEiQKIFNUQUZGX0FQUE9JTlRNRU5UX0tJTkRfUFJPTU9USU9OEAIqswEKFkhvdXNlaG9sZEhhbmRvdmVyU3RhdGUSKAokSE9VU0VIT0xEX0hBTkRPVkVSX1NUQVRFX1VOU1BFQ0lGSUVEEAASJAogSE9VU0VIT0xEX0hBTkRPVkVSX1NUQVRFX1BFTkRJTkcQARImCiJIT1VTRUhPTERfSEFORE9WRVJfU1RBVEVfQ0FOQ0VMTEVEEAISIQodSE9VU0VIT0xEX0hBTkRPVkVSX1NUQVRFX0RPTkUQA0ICSAFiBnByb3RvMw", [file_google_protobuf_timestamp, file_kusinta_iot_climate_v1_climate, file_kusinta_iot_commissioning_v1_commissioning, file_kusinta_iot_heating_v1_heating, file_kusinta_iot_identity_v1_identity]);
17
17
 
18
18
  /**
19
19
  * Describes the message kusinta.iot.webrtc.v1.DemoteHouseholdAdmin.
@@ -979,8 +979,8 @@ export declare type PrivacyDisclosure = Message<"kusinta.iot.webrtc.v1.PrivacyDi
979
979
  * role the gateway has not yet learnt, counts as ROLE_UNSPECIFIED. ROLE_GATEWAY_ADMIN is
980
980
  * always listed, and ROLE_PROPERTY_OWNER whenever anyone holds it, wherever they are
981
981
  * filed: both may file themselves on the home. So the list reads the same whether or not
982
- * anyone lives in the home, and never understates who has reach or what they see. Devices a resident
983
- * owns are not shown to service at all.
982
+ * anyone lives in the home, and never understates who has reach or what they see. Devices a
983
+ * resident owns are not shown to service at all.
984
984
  *
985
985
  * @generated from field: repeated kusinta.iot.webrtc.v1.ServiceParty service_parties = 5;
986
986
  */
@@ -1424,7 +1424,10 @@ export declare const SetComfortWindowsSchema: GenMessage<SetComfortWindows>;
1424
1424
  * (accountlink.v1.AccountLinkNonce). Only a household admin of the home
1425
1425
  * (access.v1.MEMBERSHIP_RELATION_HOUSEHOLD_ADMIN) is issued one; anyone else is refused as
1426
1426
  * NOT_ENTITLED, as is a home the caller cannot reach. A service this gateway does not
1427
- * support is refused as INVALID_REQUEST.
1427
+ * support is refused as INVALID_REQUEST. A gateway that cannot hold linked accounts right now
1428
+ * — its key for sealing them is missing or is not the one its stored links were sealed with —
1429
+ * refuses as UNAVAILABLE with metadata {"reason": "account_links_off"}; nothing is linked until
1430
+ * that is put right on the gateway.
1428
1431
  *
1429
1432
  * @generated from message kusinta.iot.webrtc.v1.RequestAccountLinkNonce
1430
1433
  */
@@ -1448,7 +1451,8 @@ export declare const RequestAccountLinkNonceSchema: GenMessage<RequestAccountLin
1448
1451
 
1449
1452
  /**
1450
1453
  * Lists a home's linked accounts and their status, answered with an AccountLinks. Given to
1451
- * the home's residents; anyone else is refused as NOT_ENTITLED.
1454
+ * the home's residents, and to the departing household while a vacated handover of the home is
1455
+ * pending (household.proto, VACANCY); anyone else is refused as NOT_ENTITLED.
1452
1456
  *
1453
1457
  * @generated from message kusinta.iot.webrtc.v1.ListAccountLinks
1454
1458
  */
@@ -1518,8 +1522,9 @@ export declare const ListCommissioningSchema: GenMessage<ListCommissioning>;
1518
1522
  *
1519
1523
  * INVALID_REQUEST
1520
1524
  * "UNKNOWN_KEY" a key the gateway's catalogue does not hold.
1521
- * "VALUE_TYPE" a value of another type than the key takes, a string outside the
1522
- * key's closed list, unknown false, or no answer.
1525
+ * "VALUE_TYPE" a value of another type than the key takes, a value outside the
1526
+ * key's closed list or range or listed twice, unknown false, or no
1527
+ * answer.
1523
1528
  * "SUBJECT" a record_id that is not a heating record within space_id, or a key
1524
1529
  * that is not about that kind of space or record.
1525
1530
  * "ANSWERER" a key the caller's party does not answer.