@kusinta/iot-schema 0.2.0-beta.5 → 0.2.0-beta.50

package/src/kusinta/iot/common/v1/types_pb.d.ts

@@ -4,12 +4,67 @@
 
 import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
+import type { SpaceId } from "../../identity/v1/identity_pb.js";
 
 /**
  * Describes the file kusinta/iot/common/v1/types.proto.
  */
 export declare const file_kusinta_iot_common_v1_types: GenFile;
 
+/**
+ * Who owns one of the building's own devices as an asset: who paid for it, for billing and
+ * for what becomes of it when a household or the gateway's owner changes. Distinct from
+ * DeviceOwnershipType, which says whether a person owns a device outright; a device a person
+ * owns has no asset owner.
+ *
+ * VISIBILITY NEVER FOLLOWS IT. What anyone sees of a device, or may do to it, is decided by
+ * the space it is filed in and how they stand to that space (access.v1.MembershipRelation),
+ * never by its asset owner: a device the organisation owns in someone's home is seen by the
+ * organisation's people as service and no more, and a device a household owns gives that
+ * household nothing beyond what living in the home gives it. Setting or changing an asset
+ * owner changes no one's access.
+ *
+ * IT DECIDES ONE THING: whether a room's outer limits can bind the device
+ * (climate.v1.OuterRoomLimits, WHAT THEY BIND). It still decides nothing about who sees what.
+ *
+ * Unset: not recorded. On a device whose ownership is COMPANY, anything that depends on it
+ * reads an unset owner as owner_organisation; a device a person owns has none, and is theirs.
+ *
+ * @generated from message kusinta.iot.common.v1.AssetOwner
+ */
+export declare type AssetOwner = Message<"kusinta.iot.common.v1.AssetOwner"> & {
+  /**
+   * @generated from oneof kusinta.iot.common.v1.AssetOwner.owner
+   */
+  owner: {
+    /**
+     * The organisation that owns the gateway (signaling.v1.GatewayStreamOpened, OWNER OF
+     * RECORD), whichever that is: such an asset goes with the gateway when it moves to
+     * another organisation. Only true is sent; false is refused.
+     *
+     * @generated from field: bool owner_organisation = 1;
+     */
+    value: boolean;
+    case: "ownerOrganisation";
+  } | {
+    /**
+     * The household of a home, named by the home's apartment. Keyed to the home, never to a
+     * person: when the household changes, the asset stays with the home for the next one
+     * (webrtc.v1 household.proto, HANDOVER).
+     *
+     * @generated from field: kusinta.iot.identity.v1.SpaceId household_home_id = 2;
+     */
+    value: SpaceId;
+    case: "householdHomeId";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message kusinta.iot.common.v1.AssetOwner.
+ * Use `create(AssetOwnerSchema)` to create a new message.
+ */
+export declare const AssetOwnerSchema: GenMessage<AssetOwner>;
+
 /**
  * @generated from message kusinta.iot.common.v1.ErrorDetail
  */
@@ -36,6 +91,37 @@ export declare type ErrorDetail = Message<"kusinta.iot.common.v1.ErrorDetail"> &
  */
 export declare const ErrorDetailSchema: GenMessage<ErrorDetail>;
 
+/**
+ * A connector's backend health, as both legs carry it: connector to gateway inside
+ * connector.v1.BackendHealthReport, and gateway to app on webrtc.v1.ConnectorDescriptor.
+ *
+ * Deliberately state and category only. A connector's free-text detail travels beside this,
+ * on the connector leg alone, and is for the gateway's logs: it may name hosts, addresses or
+ * accounts, and it never reaches the app or the cloud. Carrying only this type on the app
+ * leg is what keeps it there.
+ *
+ * @generated from message kusinta.iot.common.v1.BackendHealth
+ */
+export declare type BackendHealth = Message<"kusinta.iot.common.v1.BackendHealth"> & {
+  /**
+   * @generated from field: kusinta.iot.common.v1.BackendHealthState state = 1;
+   */
+  state: BackendHealthState;
+
+  /**
+   * Why, when state is FAILING. UNSPECIFIED otherwise, and ignored when state is not FAILING.
+   *
+   * @generated from field: kusinta.iot.common.v1.BackendFailureReason reason = 2;
+   */
+  reason: BackendFailureReason;
+};
+
+/**
+ * Describes the message kusinta.iot.common.v1.BackendHealth.
+ * Use `create(BackendHealthSchema)` to create a new message.
+ */
+export declare const BackendHealthSchema: GenMessage<BackendHealth>;
+
 /**
  * @generated from enum kusinta.iot.common.v1.SpaceType
  */
@@ -77,6 +163,11 @@ export enum SpaceType {
 export declare const SpaceTypeSchema: GenEnum<SpaceType>;
 
 /**
+ * Whether a person owns a device outright. COMPANY: no person does; it is one of the
+ * building's own devices. RESIDENT: a person does (device.v1.DeviceDescriptor.owner_user_id),
+ * for a device of their own that they may take with them. Who paid for one of the
+ * building's own devices is a separate question, answered by AssetOwner.
+ *
  * @generated from enum kusinta.iot.common.v1.DeviceOwnershipType
  */
 export enum DeviceOwnershipType {
@@ -161,3 +252,147 @@ export enum ConnectorTransport {
  */
 export declare const ConnectorTransportSchema: GenEnum<ConnectorTransport>;
 
+/**
+ * What technology a connector speaks, for an interface to pick an icon or an
+ * explanatory phrase. Presentation only, and never a behaviour gate: what a
+ * connector can do is stated by the capability booleans on ConnectorInfo
+ * (supports_pairing, supports_provisioning, brokers_links), and branching on the
+ * kind instead would hardcode vendor knowledge and force a client change for every
+ * new technology. A proto3 open enum: a reader given a value its schema predates
+ * keeps UNSPECIFIED's fallback rather than failing, which is exactly why the kind
+ * may never decide anything that matters.
+ *
+ * @generated from enum kusinta.iot.common.v1.ConnectorKind
+ */
+export enum ConnectorKind {
+  /**
+   * @generated from enum value: CONNECTOR_KIND_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: CONNECTOR_KIND_HOMEMATIC_IP = 1;
+   */
+  HOMEMATIC_IP = 1,
+
+  /**
+   * @generated from enum value: CONNECTOR_KIND_LORAWAN = 2;
+   */
+  LORAWAN = 2,
+}
+
+/**
+ * Describes the enum kusinta.iot.common.v1.ConnectorKind.
+ */
+export declare const ConnectorKindSchema: GenEnum<ConnectorKind>;
+
+/**
+ * Whether the backend a connector drives is working: the radio central, the network server,
+ * whatever the connector talks to on the far side from the gateway. Distinct from whether
+ * the connector itself is connected — that is the gateway↔connector stream, and a connector
+ * whose stream is down states nothing at all.
+ *
+ * Open, like every proto3 enum: a reader given a value its schema predates holds the number.
+ * Every reader treats anything but FAILING as healthy, so a state added later must be one an
+ * older reader may safely take for OK. A new way of failing is a new BackendFailureReason
+ * under FAILING, never a new state.
+ *
+ * @generated from enum kusinta.iot.common.v1.BackendHealthState
+ */
+export enum BackendHealthState {
+  /**
+   * No statement. Read as OK: a connector that predates backend health, or one whose backend
+   * is still in doubt as it handshakes (see connector.v1.BackendHealthReport), has said
+   * nothing is wrong.
+   *
+   * @generated from enum value: BACKEND_HEALTH_STATE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The backend is reachable and answering.
+   *
+   * @generated from enum value: BACKEND_HEALTH_STATE_OK = 1;
+   */
+  OK = 1,
+
+  /**
+   * The backend is failing, and not for a single dropped call: it has been in doubt for 60
+   * seconds within the last 120 (see connector.v1.BackendHealthReport), or the connector's own
+   * retries are used up, or a requested re-initialisation
+   * left it failing (see connector.v1.BackendHealthReport). The connector stays connected to
+   * the gateway.
+   *
+   * @generated from enum value: BACKEND_HEALTH_STATE_FAILING = 2;
+   */
+  FAILING = 2,
+}
+
+/**
+ * Describes the enum kusinta.iot.common.v1.BackendHealthState.
+ */
+export declare const BackendHealthStateSchema: GenEnum<BackendHealthState>;
+
+/**
+ * Why a backend is failing, or why a re-initialisation could not be attempted. Coarse on
+ * purpose: each value answers "what should someone do now?", and the specifics belong in a
+ * connector's log-only detail, never here.
+ *
+ * Shared rather than mirrored, for the reason PairingError gives: the connector produces it
+ * and the gateway passes it through unchanged.
+ *
+ * @generated from enum kusinta.iot.common.v1.BackendFailureReason
+ */
+export enum BackendFailureReason {
+  /**
+   * Not stated, or a value this reader's schema does not know. Read as BACKEND_ERROR.
+   *
+   * @generated from enum value: BACKEND_FAILURE_REASON_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The backend cannot be reached: no route, connection refused, no answer. Often a power or
+   * network fault at the backend's side; a re-initialisation may help once that is fixed.
+   *
+   * @generated from enum value: BACKEND_FAILURE_REASON_UNREACHABLE = 1;
+   */
+  UNREACHABLE = 1,
+
+  /**
+   * The backend answered and refused the connector's credentials. Retrying the same
+   * credentials will not help; someone must change them.
+   *
+   * @generated from enum value: BACKEND_FAILURE_REASON_AUTH_FAILED = 2;
+   */
+  AUTH_FAILED = 2,
+
+  /**
+   * The backend is reached and authenticated, but answers with errors or not as the connector
+   * expects: a fault on the backend's side, or a version the connector does not understand.
+   *
+   * @generated from enum value: BACKEND_FAILURE_REASON_BACKEND_ERROR = 3;
+   */
+  BACKEND_ERROR = 3,
+
+  /**
+   * The connector lacks what it needs to reach the backend at all: an address, credentials.
+   * Needs an installer, not a retry.
+   *
+   * @generated from enum value: BACKEND_FAILURE_REASON_MISCONFIGURED = 4;
+   */
+  MISCONFIGURED = 4,
+
+  /**
+   * A fault in the connector itself, not in the backend.
+   *
+   * @generated from enum value: BACKEND_FAILURE_REASON_INTERNAL = 5;
+   */
+  INTERNAL = 5,
+}
+
+/**
+ * Describes the enum kusinta.iot.common.v1.BackendFailureReason.
+ */
+export declare const BackendFailureReasonSchema: GenEnum<BackendFailureReason>;
+

package/src/kusinta/iot/common/v1/types_pb.js

@@ -3,19 +3,34 @@
 /* eslint-disable */
 
 import { enumDesc, fileDesc, messageDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
+import { file_kusinta_iot_identity_v1_identity } from "../../identity/v1/identity_pb.js";
 
 /**
  * Describes the file kusinta/iot/common/v1/types.proto.
  */
 export const file_kusinta_iot_common_v1_types = /*@__PURE__*/
-  fileDesc("CiFrdXNpbnRhL2lvdC9jb21tb24vdjEvdHlwZXMucHJvdG8SFWt1c2ludGEuaW90LmNvbW1vbi52MSKhAQoLRXJyb3JEZXRhaWwSDAoEY29kZRgBIAEoCRIPCgdtZXNzYWdlGAIgASgJEkIKCG1ldGFkYXRhGAMgAygLMjAua3VzaW50YS5pb3QuY29tbW9uLnYxLkVycm9yRGV0YWlsLk1ldGFkYXRhRW50cnkaLwoNTWV0YWRhdGFFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBKqEBCglTcGFjZVR5cGUSGgoWU1BBQ0VfVFlQRV9VTlNQRUNJRklFRBAAEhcKE1NQQUNFX1RZUEVfQlVJTERJTkcQARIUChBTUEFDRV9UWVBFX0ZMT09SEAISGAoUU1BBQ0VfVFlQRV9BUEFSVE1FTlQQAxITCg9TUEFDRV9UWVBFX1JPT00QBBIaChZTUEFDRV9UWVBFX0NPTU1PTl9BUkVBEAUqgwEKE0RldmljZU93bmVyc2hpcFR5cGUSJQohREVWSUNFX09XTkVSU0hJUF9UWVBFX1VOU1BFQ0lGSUVEEAASIQodREVWSUNFX09XTkVSU0hJUF9UWVBFX0NPTVBBTlkQARIiCh5ERVZJQ0VfT1dORVJTSElQX1RZUEVfUkVTSURFTlQQAirhAQoURGV2aWNlTGlmZWN5Y2xlU3RhdGUSJgoiREVWSUNFX0xJRkVDWUNMRV9TVEFURV9VTlNQRUNJRklFRBAAEigKJERFVklDRV9MSUZFQ1lDTEVfU1RBVEVfUEVORElOR19DTEFJTRABEiAKHERFVklDRV9MSUZFQ1lDTEVfU1RBVEVfT1dORUQQAhIrCidERVZJQ0VfTElGRUNZQ0xFX1NUQVRFX1BFTkRJTkdfVFJBTlNGRVIQAxIoCiRERVZJQ0VfTElGRUNZQ0xFX1NUQVRFX0JVSUxESU5HX1BPT0wQBCqAAQoSQ29ubmVjdG9yVHJhbnNwb3J0EiMKH0NPTk5FQ1RPUl9UUkFOU1BPUlRfVU5TUEVDSUZJRUQQABIjCh9DT05ORUNUT1JfVFJBTlNQT1JUX1VOSVhfU09DS0VUEAESIAocQ09OTkVDVE9SX1RSQU5TUE9SVF9NVExTX1RDUBACQgJIAWIGcHJvdG8z");
+  fileDesc("CiFrdXNpbnRhL2lvdC9jb21tb24vdjEvdHlwZXMucHJvdG8SFWt1c2ludGEuaW90LmNvbW1vbi52MSJyCgpBc3NldE93bmVyEhwKEm93bmVyX29yZ2FuaXNhdGlvbhgBIAEoCEgAEj0KEWhvdXNlaG9sZF9ob21lX2lkGAIgASgLMiAua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuU3BhY2VJZEgAQgcKBW93bmVyIqEBCgtFcnJvckRldGFpbBIMCgRjb2RlGAEgASgJEg8KB21lc3NhZ2UYAiABKAkSQgoIbWV0YWRhdGEYAyADKAsyMC5rdXNpbnRhLmlvdC5jb21tb24udjEuRXJyb3JEZXRhaWwuTWV0YWRhdGFFbnRyeRovCg1NZXRhZGF0YUVudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEihgEKDUJhY2tlbmRIZWFsdGgSOAoFc3RhdGUYASABKA4yKS5rdXNpbnRhLmlvdC5jb21tb24udjEuQmFja2VuZEhlYWx0aFN0YXRlEjsKBnJlYXNvbhgCIAEoDjIrLmt1c2ludGEuaW90LmNvbW1vbi52MS5CYWNrZW5kRmFpbHVyZVJlYXNvbiqhAQoJU3BhY2VUeXBlEhoKFlNQQUNFX1RZUEVfVU5TUEVDSUZJRUQQABIXChNTUEFDRV9UWVBFX0JVSUxESU5HEAESFAoQU1BBQ0VfVFlQRV9GTE9PUhACEhgKFFNQQUNFX1RZUEVfQVBBUlRNRU5UEAMSEwoPU1BBQ0VfVFlQRV9ST09NEAQSGgoWU1BBQ0VfVFlQRV9DT01NT05fQVJFQRAFKoMBChNEZXZpY2VPd25lcnNoaXBUeXBlEiUKIURFVklDRV9PV05FUlNISVBfVFlQRV9VTlNQRUNJRklFRBAAEiEKHURFVklDRV9PV05FUlNISVBfVFlQRV9DT01QQU5ZEAESIgoeREVWSUNFX09XTkVSU0hJUF9UWVBFX1JFU0lERU5UEAIq4QEKFERldmljZUxpZmVjeWNsZVN0YXRlEiYKIkRFVklDRV9MSUZFQ1lDTEVfU1RBVEVfVU5TUEVDSUZJRUQQABIoCiRERVZJQ0VfTElGRUNZQ0xFX1NUQVRFX1BFTkRJTkdfQ0xBSU0QARIgChxERVZJQ0VfTElGRUNZQ0xFX1NUQVRFX09XTkVEEAISKwonREVWSUNFX0xJRkVDWUNMRV9TVEFURV9QRU5ESU5HX1RSQU5TRkVSEAMSKAokREVWSUNFX0xJRkVDWUNMRV9TVEFURV9CVUlMRElOR19QT09MEAQqgAEKEkNvbm5lY3RvclRyYW5zcG9ydBIjCh9DT05ORUNUT1JfVFJBTlNQT1JUX1VOU1BFQ0lGSUVEEAASIwofQ09OTkVDVE9SX1RSQU5TUE9SVF9VTklYX1NPQ0tFVBABEiAKHENPTk5FQ1RPUl9UUkFOU1BPUlRfTVRMU19UQ1AQAipsCg1Db25uZWN0b3JLaW5kEh4KGkNPTk5FQ1RPUl9LSU5EX1VOU1BFQ0lGSUVEEAASHwobQ09OTkVDVE9SX0tJTkRfSE9NRU1BVElDX0lQEAESGgoWQ09OTkVDVE9SX0tJTkRfTE9SQVdBThACKnkKEkJhY2tlbmRIZWFsdGhTdGF0ZRIkCiBCQUNLRU5EX0hFQUxUSF9TVEFURV9VTlNQRUNJRklFRBAAEhsKF0JBQ0tFTkRfSEVBTFRIX1NUQVRFX09LEAESIAocQkFDS0VORF9IRUFMVEhfU1RBVEVfRkFJTElORxACKocCChRCYWNrZW5kRmFpbHVyZVJlYXNvbhImCiJCQUNLRU5EX0ZBSUxVUkVfUkVBU09OX1VOU1BFQ0lGSUVEEAASJgoiQkFDS0VORF9GQUlMVVJFX1JFQVNPTl9VTlJFQUNIQUJMRRABEiYKIkJBQ0tFTkRfRkFJTFVSRV9SRUFTT05fQVVUSF9GQUlMRUQQAhIoCiRCQUNLRU5EX0ZBSUxVUkVfUkVBU09OX0JBQ0tFTkRfRVJST1IQAxIoCiRCQUNLRU5EX0ZBSUxVUkVfUkVBU09OX01JU0NPTkZJR1VSRUQQBBIjCh9CQUNLRU5EX0ZBSUxVUkVfUkVBU09OX0lOVEVSTkFMEAVCAkgBYgZwcm90bzM", [file_kusinta_iot_identity_v1_identity]);
+
+/**
+ * Describes the message kusinta.iot.common.v1.AssetOwner.
+ * Use `create(AssetOwnerSchema)` to create a new message.
+ */
+export const AssetOwnerSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_common_v1_types, 0);
 
 /**
  * Describes the message kusinta.iot.common.v1.ErrorDetail.
  * Use `create(ErrorDetailSchema)` to create a new message.
  */
 export const ErrorDetailSchema = /*@__PURE__*/
-  messageDesc(file_kusinta_iot_common_v1_types, 0);
+  messageDesc(file_kusinta_iot_common_v1_types, 1);
+
+/**
+ * Describes the message kusinta.iot.common.v1.BackendHealth.
+ * Use `create(BackendHealthSchema)` to create a new message.
+ */
+export const BackendHealthSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_common_v1_types, 2);
 
 /**
  * Describes the enum kusinta.iot.common.v1.SpaceType.
@@ -36,6 +51,11 @@ export const DeviceOwnershipTypeSchema = /*@__PURE__*/
   enumDesc(file_kusinta_iot_common_v1_types, 1);
 
 /**
+ * Whether a person owns a device outright. COMPANY: no person does; it is one of the
+ * building's own devices. RESIDENT: a person does (device.v1.DeviceDescriptor.owner_user_id),
+ * for a device of their own that they may take with them. Who paid for one of the
+ * building's own devices is a separate question, answered by AssetOwner.
+ *
  * @generated from enum kusinta.iot.common.v1.DeviceOwnershipType
  */
 export const DeviceOwnershipType = /*@__PURE__*/
@@ -65,3 +85,65 @@ export const ConnectorTransportSchema = /*@__PURE__*/
 export const ConnectorTransport = /*@__PURE__*/
   tsEnum(ConnectorTransportSchema);
 
+/**
+ * Describes the enum kusinta.iot.common.v1.ConnectorKind.
+ */
+export const ConnectorKindSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_common_v1_types, 4);
+
+/**
+ * What technology a connector speaks, for an interface to pick an icon or an
+ * explanatory phrase. Presentation only, and never a behaviour gate: what a
+ * connector can do is stated by the capability booleans on ConnectorInfo
+ * (supports_pairing, supports_provisioning, brokers_links), and branching on the
+ * kind instead would hardcode vendor knowledge and force a client change for every
+ * new technology. A proto3 open enum: a reader given a value its schema predates
+ * keeps UNSPECIFIED's fallback rather than failing, which is exactly why the kind
+ * may never decide anything that matters.
+ *
+ * @generated from enum kusinta.iot.common.v1.ConnectorKind
+ */
+export const ConnectorKind = /*@__PURE__*/
+  tsEnum(ConnectorKindSchema);
+
+/**
+ * Describes the enum kusinta.iot.common.v1.BackendHealthState.
+ */
+export const BackendHealthStateSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_common_v1_types, 5);
+
+/**
+ * Whether the backend a connector drives is working: the radio central, the network server,
+ * whatever the connector talks to on the far side from the gateway. Distinct from whether
+ * the connector itself is connected — that is the gateway↔connector stream, and a connector
+ * whose stream is down states nothing at all.
+ *
+ * Open, like every proto3 enum: a reader given a value its schema predates holds the number.
+ * Every reader treats anything but FAILING as healthy, so a state added later must be one an
+ * older reader may safely take for OK. A new way of failing is a new BackendFailureReason
+ * under FAILING, never a new state.
+ *
+ * @generated from enum kusinta.iot.common.v1.BackendHealthState
+ */
+export const BackendHealthState = /*@__PURE__*/
+  tsEnum(BackendHealthStateSchema);
+
+/**
+ * Describes the enum kusinta.iot.common.v1.BackendFailureReason.
+ */
+export const BackendFailureReasonSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_common_v1_types, 6);
+
+/**
+ * Why a backend is failing, or why a re-initialisation could not be attempted. Coarse on
+ * purpose: each value answers "what should someone do now?", and the specifics belong in a
+ * connector's log-only detail, never here.
+ *
+ * Shared rather than mirrored, for the reason PairingError gives: the connector produces it
+ * and the gateway passes it through unchanged.
+ *
+ * @generated from enum kusinta.iot.common.v1.BackendFailureReason
+ */
+export const BackendFailureReason = /*@__PURE__*/
+  tsEnum(BackendFailureReasonSchema);
+