@kusinta/iot-schema 0.2.0-beta.48 → 0.2.0-beta.49

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.48",
3
+ "version": "0.2.0-beta.49",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "files": ["src"],
@@ -95,7 +95,20 @@ export declare const CreateSpaceSchema: GenMessage<CreateSpace>;
95
95
  * filed on the apartment, where it was in it — and any link it would carry across a
96
96
  * boundary is removed. Changing the type of a space that has members needs
97
97
  * ROLE_PROPERTY_OWNER or ROLE_GATEWAY_ADMIN, who see them, and is refused if it would
98
- * leave a RESIDENT membership on a room.
98
+ * leave a RESIDENT membership on a room, as INVALID_REQUEST with metadata
99
+ * {"reason": "resident_on_room"}.
100
+ *
101
+ * An apartment keeps its type while its household data is there. A change of an apartment's
102
+ * type is refused as FAILED_PRECONDITION with metadata {"reason": "handover_pending"} while a
103
+ * handover of the home is under way: pending (household.proto, HANDOVER, VACANCY), confirmed
104
+ * but its wipe not yet done, or its last residency ended and no handover recorded yet. It is
105
+ * refused as FAILED_PRECONDITION with metadata {"reason": "home_occupied"} while any residency
106
+ * of the home names someone: a current resident, or a past household whose data has not been
107
+ * wiped. The home's household data goes by a handover first (household.proto, HANDOVER, WIPE),
108
+ * never by a retype away and back. Neither refuses a change that leaves the type as it is, a
109
+ * rename among them. Every other check is made first — who may make the change, and the
110
+ * refusals of its shape as INVALID_REQUEST, "resident_on_room" among them — and
111
+ * "handover_pending" before "home_occupied".
99
112
  *
100
113
  * The name of an apartment is the building's identifier for it (space.v1.Space.name), and is
101
114
  * changed only by the property owner or the gateway's administrators: from anyone else, a
@@ -182,6 +195,11 @@ export declare const UpdateSpaceSchema: GenMessage<UpdateSpace>;
182
195
  * anything in one, is guarded as UpdateSpace is, heating records included
183
196
  * (HEATING ACROSS A HOME).
184
197
  *
198
+ * Refused as FAILED_PRECONDITION with metadata {"reason": "handover_pending"}, cascade or not,
199
+ * while a handover is under way, as UpdateSpace has it, of the home deleted or of any home
200
+ * beneath the space: a household's records go by its wipe (household.proto, WIPE), never by a
201
+ * deletion.
202
+ *
185
203
  * @generated from message kusinta.iot.webrtc.v1.DeleteSpace
186
204
  */
187
205
  export declare type DeleteSpace = Message<"kusinta.iot.webrtc.v1.DeleteSpace"> & {
@@ -1787,6 +1805,16 @@ export declare const SetHomeTemplateSchema: GenMessage<SetHomeTemplate>;
1787
1805
  *
1788
1806
  * FAILED_PRECONDITION
1789
1807
  * "TEST_RUNNING" a test already drives one of its outputs.
1808
+ * "SG_READY_ORDER" OUTPUT_LEASE on one SG Ready input while a running test drives the
1809
+ * other input of the same plant, in either order: both held away from
1810
+ * rest is a state of the heat pump no test asks for. metadata "field"
1811
+ * names the input the running test drives.
1812
+ * "LAST_HEATING_ZONE" OUTPUT_LEASE or ZONE_EFFECT on a floor zone's output that would leave
1813
+ * its circuit no zone heating: the zone is the circuit's only one, or
1814
+ * every other zone of the circuit has its output driven by a running
1815
+ * test. A zone with no bound output counts as heating. Not refused once
1816
+ * the circuit's "floor.pump_tolerates_all_zones_off" is true
1817
+ * (commissioning.v1). metadata "record_id" names the zone.
1790
1818
  * "NEEDS_PASS" ZONE_EFFECT or PUMP_ALL_ZONES_OFF on outputs without a current
1791
1819
  * OUTPUT_LEASE pass; metadata "record_id" names one.
1792
1820
  * "OUTPUT_NOT_LEASED" an output its producer does not state as leased, with a lapse value