@kusinta/iot-schema 0.2.0-beta.4 → 0.2.0-beta.40

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

@@ -36,6 +36,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
  */
@@ -161,3 +192,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

@@ -8,7 +8,7 @@ import { enumDesc, fileDesc, messageDesc, tsEnum } from "@bufbuild/protobuf/code
  * Describes the file kusinta/iot/common/v1/types.proto.
  */
 export const file_kusinta_iot_common_v1_types = /*@__PURE__*/
-  fileDesc("CiFrdXNpbnRhL2lvdC9jb21tb24vdjEvdHlwZXMucHJvdG8SFWt1c2ludGEuaW90LmNvbW1vbi52MSKhAQoLRXJyb3JEZXRhaWwSDAoEY29kZRgBIAEoCRIPCgdtZXNzYWdlGAIgASgJEkIKCG1ldGFkYXRhGAMgAygLMjAua3VzaW50YS5pb3QuY29tbW9uLnYxLkVycm9yRGV0YWlsLk1ldGFkYXRhRW50cnkaLwoNTWV0YWRhdGFFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBKqEBCglTcGFjZVR5cGUSGgoWU1BBQ0VfVFlQRV9VTlNQRUNJRklFRBAAEhcKE1NQQUNFX1RZUEVfQlVJTERJTkcQARIUChBTUEFDRV9UWVBFX0ZMT09SEAISGAoUU1BBQ0VfVFlQRV9BUEFSVE1FTlQQAxITCg9TUEFDRV9UWVBFX1JPT00QBBIaChZTUEFDRV9UWVBFX0NPTU1PTl9BUkVBEAUqgwEKE0RldmljZU93bmVyc2hpcFR5cGUSJQohREVWSUNFX09XTkVSU0hJUF9UWVBFX1VOU1BFQ0lGSUVEEAASIQodREVWSUNFX09XTkVSU0hJUF9UWVBFX0NPTVBBTlkQARIiCh5ERVZJQ0VfT1dORVJTSElQX1RZUEVfUkVTSURFTlQQAirhAQoURGV2aWNlTGlmZWN5Y2xlU3RhdGUSJgoiREVWSUNFX0xJRkVDWUNMRV9TVEFURV9VTlNQRUNJRklFRBAAEigKJERFVklDRV9MSUZFQ1lDTEVfU1RBVEVfUEVORElOR19DTEFJTRABEiAKHERFVklDRV9MSUZFQ1lDTEVfU1RBVEVfT1dORUQQAhIrCidERVZJQ0VfTElGRUNZQ0xFX1NUQVRFX1BFTkRJTkdfVFJBTlNGRVIQAxIoCiRERVZJQ0VfTElGRUNZQ0xFX1NUQVRFX0JVSUxESU5HX1BPT0wQBCqAAQoSQ29ubmVjdG9yVHJhbnNwb3J0EiMKH0NPTk5FQ1RPUl9UUkFOU1BPUlRfVU5TUEVDSUZJRUQQABIjCh9DT05ORUNUT1JfVFJBTlNQT1JUX1VOSVhfU09DS0VUEAESIAocQ09OTkVDVE9SX1RSQU5TUE9SVF9NVExTX1RDUBACQgJIAWIGcHJvdG8z");
+  fileDesc("CiFrdXNpbnRhL2lvdC9jb21tb24vdjEvdHlwZXMucHJvdG8SFWt1c2ludGEuaW90LmNvbW1vbi52MSKhAQoLRXJyb3JEZXRhaWwSDAoEY29kZRgBIAEoCRIPCgdtZXNzYWdlGAIgASgJEkIKCG1ldGFkYXRhGAMgAygLMjAua3VzaW50YS5pb3QuY29tbW9uLnYxLkVycm9yRGV0YWlsLk1ldGFkYXRhRW50cnkaLwoNTWV0YWRhdGFFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBIoYBCg1CYWNrZW5kSGVhbHRoEjgKBXN0YXRlGAEgASgOMikua3VzaW50YS5pb3QuY29tbW9uLnYxLkJhY2tlbmRIZWFsdGhTdGF0ZRI7CgZyZWFzb24YAiABKA4yKy5rdXNpbnRhLmlvdC5jb21tb24udjEuQmFja2VuZEZhaWx1cmVSZWFzb24qoQEKCVNwYWNlVHlwZRIaChZTUEFDRV9UWVBFX1VOU1BFQ0lGSUVEEAASFwoTU1BBQ0VfVFlQRV9CVUlMRElORxABEhQKEFNQQUNFX1RZUEVfRkxPT1IQAhIYChRTUEFDRV9UWVBFX0FQQVJUTUVOVBADEhMKD1NQQUNFX1RZUEVfUk9PTRAEEhoKFlNQQUNFX1RZUEVfQ09NTU9OX0FSRUEQBSqDAQoTRGV2aWNlT3duZXJzaGlwVHlwZRIlCiFERVZJQ0VfT1dORVJTSElQX1RZUEVfVU5TUEVDSUZJRUQQABIhCh1ERVZJQ0VfT1dORVJTSElQX1RZUEVfQ09NUEFOWRABEiIKHkRFVklDRV9PV05FUlNISVBfVFlQRV9SRVNJREVOVBACKuEBChREZXZpY2VMaWZlY3ljbGVTdGF0ZRImCiJERVZJQ0VfTElGRUNZQ0xFX1NUQVRFX1VOU1BFQ0lGSUVEEAASKAokREVWSUNFX0xJRkVDWUNMRV9TVEFURV9QRU5ESU5HX0NMQUlNEAESIAocREVWSUNFX0xJRkVDWUNMRV9TVEFURV9PV05FRBACEisKJ0RFVklDRV9MSUZFQ1lDTEVfU1RBVEVfUEVORElOR19UUkFOU0ZFUhADEigKJERFVklDRV9MSUZFQ1lDTEVfU1RBVEVfQlVJTERJTkdfUE9PTBAEKoABChJDb25uZWN0b3JUcmFuc3BvcnQSIwofQ09OTkVDVE9SX1RSQU5TUE9SVF9VTlNQRUNJRklFRBAAEiMKH0NPTk5FQ1RPUl9UUkFOU1BPUlRfVU5JWF9TT0NLRVQQARIgChxDT05ORUNUT1JfVFJBTlNQT1JUX01UTFNfVENQEAIqbAoNQ29ubmVjdG9yS2luZBIeChpDT05ORUNUT1JfS0lORF9VTlNQRUNJRklFRBAAEh8KG0NPTk5FQ1RPUl9LSU5EX0hPTUVNQVRJQ19JUBABEhoKFkNPTk5FQ1RPUl9LSU5EX0xPUkFXQU4QAip5ChJCYWNrZW5kSGVhbHRoU3RhdGUSJAogQkFDS0VORF9IRUFMVEhfU1RBVEVfVU5TUEVDSUZJRUQQABIbChdCQUNLRU5EX0hFQUxUSF9TVEFURV9PSxABEiAKHEJBQ0tFTkRfSEVBTFRIX1NUQVRFX0ZBSUxJTkcQAiqHAgoUQmFja2VuZEZhaWx1cmVSZWFzb24SJgoiQkFDS0VORF9GQUlMVVJFX1JFQVNPTl9VTlNQRUNJRklFRBAAEiYKIkJBQ0tFTkRfRkFJTFVSRV9SRUFTT05fVU5SRUFDSEFCTEUQARImCiJCQUNLRU5EX0ZBSUxVUkVfUkVBU09OX0FVVEhfRkFJTEVEEAISKAokQkFDS0VORF9GQUlMVVJFX1JFQVNPTl9CQUNLRU5EX0VSUk9SEAMSKAokQkFDS0VORF9GQUlMVVJFX1JFQVNPTl9NSVNDT05GSUdVUkVEEAQSIwofQkFDS0VORF9GQUlMVVJFX1JFQVNPTl9JTlRFUk5BTBAFQgJIAWIGcHJvdG8z");
 
 /**
  * Describes the message kusinta.iot.common.v1.ErrorDetail.
@@ -17,6 +17,13 @@ export const file_kusinta_iot_common_v1_types = /*@__PURE__*/
 export const ErrorDetailSchema = /*@__PURE__*/
   messageDesc(file_kusinta_iot_common_v1_types, 0);
 
+/**
+ * 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, 1);
+
 /**
  * Describes the enum kusinta.iot.common.v1.SpaceType.
  */
@@ -65,3 +72,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);
+