@kusinta/iot-schema 0.2.0-beta.3 → 0.2.0-beta.31

package/src/kusinta/iot/webrtc/v1/permission_push_pb.d.ts

@@ -5,7 +5,8 @@
 import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 import type { EffectivePermissions } from "../../access/v1/acl_pb.js";
-import type { DeviceId } from "../../identity/v1/identity_pb.js";
+import type { DeviceId, SpaceId } from "../../identity/v1/identity_pb.js";
+import type { Role } from "../../access/v1/roles_pb.js";
 
 /**
  * Describes the file kusinta/iot/webrtc/v1/permission_push.proto.
@@ -13,8 +14,21 @@ import type { DeviceId } from "../../identity/v1/identity_pb.js";
 export declare const file_kusinta_iot_webrtc_v1_permission_push: GenFile;
 
 /**
- * Pushed to the app whenever the user's effective permissions change.
- * change_reason values: "DEVICE_ASSIGNED", "DEVICE_UNASSIGNED", "RESIDENT_CHANGED", "CONSTRAINT_UPDATED"
+ * Pushed to the app whenever the user's effective permissions change, as they change. A
+ * change that takes away what the user may see or do takes effect and is sent at once; what
+ * a user newly sees of a home as service — a device filed into it, a home newly reached —
+ * is sent as it happens too, with new_permissions.valid_at the moment it took effect. A
+ * resident who becomes service loses the resident view at once — the home's devices are
+ * listed in removed_devices, so the app drops what it holds of them — and gains the service
+ * view at once, in a push that follows, where they come back in added_devices as service
+ * and their stretch of seeing the home as service begins. A member who becomes a resident
+ * gains the resident view at once: the home's devices come again in added_devices, each
+ * with a DeviceAdded carrying its full Device, and the app drops the ServiceStatus it held
+ * of them until their next one. A push that brings a home newly seen as service lists it in
+ * reset_spaces, so the app reads its rooms and links then.
+ * change_reason values: "DEVICE_ASSIGNED", "DEVICE_UNASSIGNED", "RESIDENT_CHANGED",
+ * "CONSTRAINT_UPDATED"; empty whenever the change concerns a home the user sees, or saw, as
+ * service, so that no push says why a home changed.
  *
  * @generated from message kusinta.iot.webrtc.v1.LivePermissionUpdate
  */
@@ -34,7 +48,8 @@ export declare type LivePermissionUpdate = Message<"kusinta.iot.webrtc.v1.LivePe
 
   /**
    * Devices the user may no longer see. The gateway has already dropped these from
-   * the app's interest set — no property events follow, and no unsubscribe is needed.
+   * the app's interest set — no property events follow, and no unsubscribe is needed. The
+   * app drops what it holds of them, their ServiceStatus included.
    *
    * @generated from field: repeated kusinta.iot.identity.v1.DeviceId removed_devices = 3;
    */
@@ -44,6 +59,28 @@ export declare type LivePermissionUpdate = Message<"kusinta.iot.webrtc.v1.LivePe
    * @generated from field: string change_reason = 4;
    */
   changeReason: string;
+
+  /**
+   * Spaces whose climate, modes and links the user sees differently from now — whenever how
+   * they see a home changes: they moved in or out, became service or resident, lost the
+   * space, or newly see it as service. The app drops everything it holds of each and of the
+   * spaces beneath it, and reads them again (ListSpaces, ListRoomClimates, ListDeviceLinks)
+   * if it may.
+   * Each is sent as the change happens: a loss, a wider view as a resident and a home newly
+   * seen as service alike.
+   *
+   * @generated from field: repeated kusinta.iot.identity.v1.SpaceId reset_spaces = 5;
+   */
+  resetSpaces: SpaceId[];
+
+  /**
+   * The roles the session holds once this change has taken effect, as in
+   * DeviceStateSnapshot.session_roles. Set on every update, a change of role alone included,
+   * so that a promotion or demotion reaches an open app at once.
+   *
+   * @generated from field: kusinta.iot.webrtc.v1.SessionRoles session_roles = 6;
+   */
+  sessionRoles?: SessionRoles | undefined;
 };
 
 /**
@@ -52,3 +89,28 @@ export declare type LivePermissionUpdate = Message<"kusinta.iot.webrtc.v1.LivePe
  */
 export declare const LivePermissionUpdateSchema: GenMessage<LivePermissionUpdate>;
 
+/**
+ * The roles the gateway holds for a session's user: those it records for them, together
+ * with administration their token vouches for. The app MUST prefer these, while the session
+ * is up, over any other source of the user's roles on this gateway. They decide only what
+ * the app offers; the gateway still decides every request on its own.
+ *
+ * A gateway that sends them sets the field on every DeviceStateSnapshot and
+ * LivePermissionUpdate, so an unset field means a gateway that does not, and an empty list
+ * means the user holds no role.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.SessionRoles
+ */
+export declare type SessionRoles = Message<"kusinta.iot.webrtc.v1.SessionRoles"> & {
+  /**
+   * @generated from field: repeated kusinta.iot.access.v1.Role roles = 1;
+   */
+  roles: Role[];
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.SessionRoles.
+ * Use `create(SessionRolesSchema)` to create a new message.
+ */
+export declare const SessionRolesSchema: GenMessage<SessionRoles>;
+

package/src/kusinta/iot/webrtc/v1/permission_push_pb.js

@@ -3,14 +3,15 @@
 /* eslint-disable */
 
 import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
-import { file_kusinta_iot_identity_v1_identity } from "../../identity/v1/identity_pb.js";
 import { file_kusinta_iot_access_v1_acl } from "../../access/v1/acl_pb.js";
+import { file_kusinta_iot_access_v1_roles } from "../../access/v1/roles_pb.js";
+import { file_kusinta_iot_identity_v1_identity } from "../../identity/v1/identity_pb.js";
 
 /**
  * Describes the file kusinta/iot/webrtc/v1/permission_push.proto.
  */
 export const file_kusinta_iot_webrtc_v1_permission_push = /*@__PURE__*/
-  fileDesc("CitrdXNpbnRhL2lvdC93ZWJydGMvdjEvcGVybWlzc2lvbl9wdXNoLnByb3RvEhVrdXNpbnRhLmlvdC53ZWJydGMudjEi6QEKFExpdmVQZXJtaXNzaW9uVXBkYXRlEkQKD25ld19wZXJtaXNzaW9ucxgBIAEoCzIrLmt1c2ludGEuaW90LmFjY2Vzcy52MS5FZmZlY3RpdmVQZXJtaXNzaW9ucxI4Cg1hZGRlZF9kZXZpY2VzGAIgAygLMiEua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuRGV2aWNlSWQSOgoPcmVtb3ZlZF9kZXZpY2VzGAMgAygLMiEua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuRGV2aWNlSWQSFQoNY2hhbmdlX3JlYXNvbhgEIAEoCUICSAFiBnByb3RvMw", [file_kusinta_iot_identity_v1_identity, file_kusinta_iot_access_v1_acl]);
+  fileDesc("CitrdXNpbnRhL2lvdC93ZWJydGMvdjEvcGVybWlzc2lvbl9wdXNoLnByb3RvEhVrdXNpbnRhLmlvdC53ZWJydGMudjEi3QIKFExpdmVQZXJtaXNzaW9uVXBkYXRlEkQKD25ld19wZXJtaXNzaW9ucxgBIAEoCzIrLmt1c2ludGEuaW90LmFjY2Vzcy52MS5FZmZlY3RpdmVQZXJtaXNzaW9ucxI4Cg1hZGRlZF9kZXZpY2VzGAIgAygLMiEua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuRGV2aWNlSWQSOgoPcmVtb3ZlZF9kZXZpY2VzGAMgAygLMiEua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuRGV2aWNlSWQSFQoNY2hhbmdlX3JlYXNvbhgEIAEoCRI2CgxyZXNldF9zcGFjZXMYBSADKAsyIC5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5TcGFjZUlkEjoKDXNlc3Npb25fcm9sZXMYBiABKAsyIy5rdXNpbnRhLmlvdC53ZWJydGMudjEuU2Vzc2lvblJvbGVzIjoKDFNlc3Npb25Sb2xlcxIqCgVyb2xlcxgBIAMoDjIbLmt1c2ludGEuaW90LmFjY2Vzcy52MS5Sb2xlQgJIAWIGcHJvdG8z", [file_kusinta_iot_access_v1_acl, file_kusinta_iot_access_v1_roles, file_kusinta_iot_identity_v1_identity]);
 
 /**
  * Describes the message kusinta.iot.webrtc.v1.LivePermissionUpdate.
@@ -19,3 +20,10 @@ export const file_kusinta_iot_webrtc_v1_permission_push = /*@__PURE__*/
 export const LivePermissionUpdateSchema = /*@__PURE__*/
   messageDesc(file_kusinta_iot_webrtc_v1_permission_push, 0);
 
+/**
+ * Describes the message kusinta.iot.webrtc.v1.SessionRoles.
+ * Use `create(SessionRolesSchema)` to create a new message.
+ */
+export const SessionRolesSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_permission_push, 1);
+