@kusinta/iot-schema 0.1.0-beta.9 → 0.2.0-beta.10

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

@@ -0,0 +1,201 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/common/v1/pairing.proto (package kusinta.iot.common.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file kusinta/iot/common/v1/pairing.proto.
+ */
+export declare const file_kusinta_iot_common_v1_pairing: GenFile;
+
+/**
+ * A pairing failure and what can be said about it, the pairing counterpart of CommandError.
+ *
+ * The message matters more here than elsewhere: DEVICE_UNUSABLE is the code a user is most
+ * likely to see and least able to act on, and naming the device that joined is the whole
+ * difference between "something went wrong" and "this hub does not support that model yet".
+ *
+ * @generated from message kusinta.iot.common.v1.PairingErrorDetail
+ */
+export declare type PairingErrorDetail = Message<"kusinta.iot.common.v1.PairingErrorDetail"> & {
+  /**
+   * @generated from field: kusinta.iot.common.v1.PairingError code = 1;
+   */
+  code: PairingError;
+
+  /**
+   * human-readable; may name the device, its model, or the fault
+   *
+   * @generated from field: string message = 2;
+   */
+  message: string;
+};
+
+/**
+ * Describes the message kusinta.iot.common.v1.PairingErrorDetail.
+ * Use `create(PairingErrorDetailSchema)` to create a new message.
+ */
+export declare const PairingErrorDetailSchema: GenMessage<PairingErrorDetail>;
+
+/**
+ * How long a hub accepts new devices, and which it will take.
+ *
+ * One message on both legs rather than the same three fields declared twice: the clamp rule
+ * and the meaning of a hint are the sort of thing that is written once and then diverges,
+ * and the two copies had already begun to.
+ *
+ * @generated from message kusinta.iot.common.v1.PairingWindow
+ */
+export declare type PairingWindow = Message<"kusinta.iot.common.v1.PairingWindow"> & {
+  /**
+   * How long to accept arrivals. Whoever forwards this clamps it, and so does whoever acts
+   * on it: a window is an interval during which anything nearby can join, so its length is a
+   * security parameter rather than purely the caller's to choose.
+   *
+   * Absent means "no preference, use the default" — distinct from a caller asking for zero.
+   *
+   * @generated from field: optional uint32 duration_seconds = 1;
+   */
+  durationSeconds?: number | undefined;
+
+  /**
+   * The identifier printed on the device being paired, where the technology has one that is
+   * legible and the person is holding it. Free-form: what is printed differs per technology,
+   * and nothing between the app and the hub interprets it.
+   *
+   * Setting it changes the mechanism, not just the accuracy. The hub is restricted to that
+   * device and the arrival is verified against this value, so an arrival is attributed on
+   * identity. Leaving it empty opens the window to anything nearby, and attribution falls
+   * back to the arrival being the only one — which is why one window may be open at a time.
+   *
+   * Verification is not optional where this is set. A restriction can silently fail to take,
+   * and an arrival attributed on a restriction that did not hold is the wrong device in
+   * someone's home.
+   *
+   * @generated from field: string device_hint = 2;
+   */
+  deviceHint: string;
+
+  /**
+   * How many arrivals this one window may attribute. Absent means one.
+   *
+   * A batch suits commissioning, where devices are paired in a row and become a building's
+   * rather than any person's. It does not suit a caller whose pairing mints personal
+   * ownership.
+   *
+   * Ignored where device_hint is set, and narrowed to one rather than refused: a hint names
+   * one device, so a window restricted to it can never produce a second arrival to attribute.
+   * The combination is meaningless rather than dangerous, and there is no honest code in
+   * PairingError for "your request contradicted itself" — refusing it would mean answering a
+   * malformed request with an entitlement decision that was never made.
+   *
+   * @generated from field: optional uint32 max_devices = 3;
+   */
+  maxDevices?: number | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.common.v1.PairingWindow.
+ * Use `create(PairingWindowSchema)` to create a new message.
+ */
+export declare const PairingWindowSchema: GenMessage<PairingWindow>;
+
+/**
+ * Why a pairing attempt did not produce a device, in one vocabulary both the app and a
+ * connector speak.
+ *
+ * Shared rather than mirrored, for the reason CommandError's comment gives: mirrored enums
+ * leave every connector inventing its own spellings and something in the middle keeping a
+ * translation table that silently falls behind. A connector produces the subset it can
+ * observe; the gateway produces the rest and passes a connector's value through unchanged.
+ *
+ * Every value answers one question: *what should the client do now?* A code that does not
+ * change the answer does not need to exist, which is why "the device is on the hub and
+ * unusable" is one value and not two.
+ *
+ * @generated from enum kusinta.iot.common.v1.PairingError
+ */
+export enum PairingError {
+  /**
+   * Sender set no code, or sent one this client's schema does not know.
+   *
+   * This must stay the safe reading. A client decodes every value added after its build as
+   * UNSPECIFIED, so the sensible handling is "it did not work, offering a retry is
+   * reasonable" — and no value below is so dangerous that reading it this way misleads.
+   *
+   * @generated from enum value: PAIRING_ERROR_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The caller may not pair here. Permanent for this caller: stop, and say so.
+   *
+   * @generated from enum value: PAIRING_ERROR_NOT_ENTITLED = 1;
+   */
+  NOT_ENTITLED = 1,
+
+  /**
+   * A pairing window is already open, and only one may be. Retrying after it closes is the
+   * right response; retrying at once is not.
+   *
+   * The exclusivity is not incidental. Where a request names no device, the only thing
+   * attributing an arrival to a requester is that theirs was the one window open.
+   *
+   * @generated from enum value: PAIRING_ERROR_ALREADY_IN_PROGRESS = 2;
+   */
+  ALREADY_IN_PROGRESS = 2,
+
+  /**
+   * The connector could not be reached, or refused to open its window. Transient.
+   *
+   * @generated from enum value: PAIRING_ERROR_CONNECTOR_UNAVAILABLE = 3;
+   */
+  CONNECTOR_UNAVAILABLE = 3,
+
+  /**
+   * The window closed with nothing paired: no device was put into pairing mode, or it was
+   * out of range, or its batteries are flat. The ordinary outcome of a user who walked away,
+   * so the useful response is to say what to do and offer another go, not to report a fault.
+   *
+   * @generated from enum value: PAIRING_ERROR_NO_DEVICE_APPEARED = 4;
+   */
+  NO_DEVICE_APPEARED = 4,
+
+  /**
+   * A device joined the hub and cannot be presented — the connector has no model for it, or
+   * could not assemble a complete description of it.
+   *
+   * One value rather than two, because the client does the same thing either way: stop, do
+   * not retry, and tell the user there is now an unusable device on their hub. Which of the
+   * two it was belongs in PairingErrorDetail.message, where it can name the device.
+   *
+   * It stays joined deliberately. A later connector release that models it adopts it with
+   * nobody returning to the hardware, where removing it would need someone standing there.
+   *
+   * @generated from enum value: PAIRING_ERROR_DEVICE_UNUSABLE = 5;
+   */
+  DEVICE_UNUSABLE = 5,
+
+  /**
+   * A device joined that is not the one the request named. The connector checked the arrival
+   * against the identifier it was given and they did not match, so it was not attributed.
+   *
+   * @generated from enum value: PAIRING_ERROR_WRONG_DEVICE = 6;
+   */
+  WRONG_DEVICE = 6,
+
+  /**
+   * A fault on the gateway's or the connector's own side. Not the caller's doing.
+   *
+   * @generated from enum value: PAIRING_ERROR_INTERNAL = 7;
+   */
+  INTERNAL = 7,
+}
+
+/**
+ * Describes the enum kusinta.iot.common.v1.PairingError.
+ */
+export declare const PairingErrorSchema: GenEnum<PairingError>;
+

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

@@ -0,0 +1,50 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/common/v1/pairing.proto (package kusinta.iot.common.v1, syntax proto3)
+/* eslint-disable */
+
+import { enumDesc, fileDesc, messageDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
+
+/**
+ * Describes the file kusinta/iot/common/v1/pairing.proto.
+ */
+export const file_kusinta_iot_common_v1_pairing = /*@__PURE__*/
+  fileDesc("CiNrdXNpbnRhL2lvdC9jb21tb24vdjEvcGFpcmluZy5wcm90bxIVa3VzaW50YS5pb3QuY29tbW9uLnYxIlgKElBhaXJpbmdFcnJvckRldGFpbBIxCgRjb2RlGAEgASgOMiMua3VzaW50YS5pb3QuY29tbW9uLnYxLlBhaXJpbmdFcnJvchIPCgdtZXNzYWdlGAIgASgJIoIBCg1QYWlyaW5nV2luZG93Eh0KEGR1cmF0aW9uX3NlY29uZHMYASABKA1IAIgBARITCgtkZXZpY2VfaGludBgCIAEoCRIYCgttYXhfZGV2aWNlcxgDIAEoDUgBiAEBQhMKEV9kdXJhdGlvbl9zZWNvbmRzQg4KDF9tYXhfZGV2aWNlcyqiAgoMUGFpcmluZ0Vycm9yEh0KGVBBSVJJTkdfRVJST1JfVU5TUEVDSUZJRUQQABIeChpQQUlSSU5HX0VSUk9SX05PVF9FTlRJVExFRBABEiUKIVBBSVJJTkdfRVJST1JfQUxSRUFEWV9JTl9QUk9HUkVTUxACEicKI1BBSVJJTkdfRVJST1JfQ09OTkVDVE9SX1VOQVZBSUxBQkxFEAMSJAogUEFJUklOR19FUlJPUl9OT19ERVZJQ0VfQVBQRUFSRUQQBBIhCh1QQUlSSU5HX0VSUk9SX0RFVklDRV9VTlVTQUJMRRAFEh4KGlBBSVJJTkdfRVJST1JfV1JPTkdfREVWSUNFEAYSGgoWUEFJUklOR19FUlJPUl9JTlRFUk5BTBAHQgJIAWIGcHJvdG8z");
+
+/**
+ * Describes the message kusinta.iot.common.v1.PairingErrorDetail.
+ * Use `create(PairingErrorDetailSchema)` to create a new message.
+ */
+export const PairingErrorDetailSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_common_v1_pairing, 0);
+
+/**
+ * Describes the message kusinta.iot.common.v1.PairingWindow.
+ * Use `create(PairingWindowSchema)` to create a new message.
+ */
+export const PairingWindowSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_common_v1_pairing, 1);
+
+/**
+ * Describes the enum kusinta.iot.common.v1.PairingError.
+ */
+export const PairingErrorSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_common_v1_pairing, 0);
+
+/**
+ * Why a pairing attempt did not produce a device, in one vocabulary both the app and a
+ * connector speak.
+ *
+ * Shared rather than mirrored, for the reason CommandError's comment gives: mirrored enums
+ * leave every connector inventing its own spellings and something in the middle keeping a
+ * translation table that silently falls behind. A connector produces the subset it can
+ * observe; the gateway produces the rest and passes a connector's value through unchanged.
+ *
+ * Every value answers one question: *what should the client do now?* A code that does not
+ * change the answer does not need to exist, which is why "the device is on the hub and
+ * unusable" is one value and not two.
+ *
+ * @generated from enum kusinta.iot.common.v1.PairingError
+ */
+export const PairingError = /*@__PURE__*/
+  tsEnum(PairingErrorSchema);
+