@kusinta/iot-schema 0.2.0-beta.45 → 0.2.0-beta.47

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.45",
3
+ "version": "0.2.0-beta.47",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "files": ["src"],
@@ -447,7 +447,10 @@ export enum ServiceSignal {
447
447
 
448
448
  /**
449
449
  * How the home is set up: the apartment and its rooms, their names and descriptions, the
450
- * rooms' limits, and the building's sensors in them.
450
+ * rooms' outer limits with when each was set, and the role that set each save an installer
451
+ * under a grant — never the household's inner limits — and the building's sensors in them.
452
+ * While the home stood empty, before anyone moved in, its property owner and gateway
453
+ * administrators saw its rooms and modes in full (webrtc.v1 household.proto, EMPTY HOME).
451
454
  *
452
455
  * @generated from enum value: SERVICE_SIGNAL_ROOM_SETUP = 7;
453
456
  */
@@ -223,7 +223,9 @@ export declare const PermissionActionSchema: GenEnum<PermissionAction>;
223
223
  * operate none of them. Of what they reach of the home — from the room they are filed
224
224
  * on, or all of it — they see how its rooms are set up, with
225
225
  * RoomClimate.state_withheld marking what is not shown, and its links with
226
- * DeviceLink.details_withheld; modes on a home are not sent to them at all. Service
226
+ * DeviceLink.details_withheld; modes on a home are not sent to them at all — save that the
227
+ * property owner and the gateway administrators are sent an empty home's rooms and modes
228
+ * in full (webrtc.v1 household.proto, EMPTY HOME). Service
227
229
  * that reaches the apartment itself also gets its climate summary over the disclosed
228
230
  * period. What they newly see of the home reaches them as it happens; what they lose,
229
231
  * at once.
@@ -127,7 +127,9 @@ export const MembershipRelationSchema = /*@__PURE__*/
127
127
  * operate none of them. Of what they reach of the home — from the room they are filed
128
128
  * on, or all of it — they see how its rooms are set up, with
129
129
  * RoomClimate.state_withheld marking what is not shown, and its links with
130
- * DeviceLink.details_withheld; modes on a home are not sent to them at all. Service
130
+ * DeviceLink.details_withheld; modes on a home are not sent to them at all — save that the
131
+ * property owner and the gateway administrators are sent an empty home's rooms and modes
132
+ * in full (webrtc.v1 household.proto, EMPTY HOME). Service
131
133
  * that reaches the apartment itself also gets its climate summary over the disclosed
132
134
  * period. What they newly see of the home reaches them as it happens; what they lose,
133
135
  * at once.
@@ -395,6 +395,13 @@ export declare const TokenRefreshedSchema: GenMessage<TokenRefreshed>;
395
395
  * and it outlives a household handover's wipe and a gateway-wide wipe, which delete the
396
396
  * grant itself: it is the only means left of ending the link at the service.
397
397
  *
398
+ * A service with no means of revoking a grant is answered REJECTED by the api-server without
399
+ * asking the service. The gateway drops the token as for any REJECTED, and the grant stays
400
+ * valid at the service until it expires or the account holder removes the access there. So an
401
+ * app never tells the household that the service revoked the access, only that the home no
402
+ * longer holds it; where the service has no revocation, it may say that the access is removed
403
+ * at the service by the account holder.
404
+ *
398
405
  * @generated from message kusinta.iot.accountlink.v1.RevokeToken
399
406
  */
400
407
  export declare type RevokeToken = Message<"kusinta.iot.accountlink.v1.RevokeToken"> & {
@@ -434,8 +441,9 @@ export declare type TokenRevoked = Message<"kusinta.iot.accountlink.v1.TokenRevo
434
441
  requestId: string;
435
442
 
436
443
  /**
437
- * OK: revoked. REJECTED: the service no longer knew the token, which is as good.
438
- * UNAVAILABLE: ask again after retry_after.
444
+ * OK: revoked. REJECTED: the service no longer knew the token, which is as good — or it has
445
+ * no means of revoking one, which the api-server answers without asking it (RevokeToken);
446
+ * either way the gateway drops the token. UNAVAILABLE: ask again after retry_after.
439
447
  *
440
448
  * @generated from field: kusinta.iot.accountlink.v1.TokenOutcome outcome = 2;
441
449
  */