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

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

@@ -0,0 +1,627 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/webrtc/v1/management.proto (package kusinta.iot.webrtc.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { DeviceOwnershipType, SpaceType } from "../../common/v1/types_pb.js";
+import type { DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
+import type { Space } from "../../space/v1/space_pb.js";
+import type { LinkFunction, LinkMode, LinkSettings } from "../../link/v1/link_pb.js";
+
+/**
+ * Describes the file kusinta/iot/webrtc/v1/management.proto.
+ */
+export declare const file_kusinta_iot_webrtc_v1_management: GenFile;
+
+/**
+ * Creates a space. A space with no parent_space_id is top level, which is a
+ * stronger request than it looks: there is no parent whose reach could authorize
+ * it, so it is reserved to the gateway's administrator.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.CreateSpace
+ */
+export declare type CreateSpace = Message<"kusinta.iot.webrtc.v1.CreateSpace"> & {
+  /**
+   * @generated from field: kusinta.iot.common.v1.SpaceType space_type = 1;
+   */
+  spaceType: SpaceType;
+
+  /**
+   * @generated from field: string name = 2;
+   */
+  name: string;
+
+  /**
+   * @generated from field: string description = 3;
+   */
+  description: string;
+
+  /**
+   * meaningful for FLOOR type
+   *
+   * @generated from field: int32 floor = 4;
+   */
+  floor: number;
+
+  /**
+   * unset = top level
+   *
+   * @generated from field: kusinta.iot.identity.v1.SpaceId parent_space_id = 5;
+   */
+  parentSpaceId?: SpaceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.CreateSpace.
+ * Use `create(CreateSpaceSchema)` to create a new message.
+ */
+export declare const CreateSpaceSchema: GenMessage<CreateSpace>;
+
+/**
+ * Changes a space in place. Every descriptive field carries explicit presence:
+ * absent means leave it alone, present means set it to this — including to the
+ * empty string, which is how a description is cleared.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.UpdateSpace
+ */
+export declare type UpdateSpace = Message<"kusinta.iot.webrtc.v1.UpdateSpace"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: optional kusinta.iot.common.v1.SpaceType space_type = 2;
+   */
+  spaceType?: SpaceType | undefined;
+
+  /**
+   * @generated from field: optional string name = 3;
+   */
+  name?: string | undefined;
+
+  /**
+   * @generated from field: optional string description = 4;
+   */
+  description?: string | undefined;
+
+  /**
+   * @generated from field: optional int32 floor = 5;
+   */
+  floor?: number | undefined;
+
+  /**
+   * Reparenting needs three states, not two: leave the parent alone, move to a
+   * new one, or become top level. A bare optional parent_space_id can only
+   * express the first two, so detaching gets its own case rather than being
+   * spelled as an empty id.
+   *
+   * @generated from oneof kusinta.iot.webrtc.v1.UpdateSpace.parent_change
+   */
+  parentChange: {
+    /**
+     * @generated from field: kusinta.iot.identity.v1.SpaceId parent_space_id = 6;
+     */
+    value: SpaceId;
+    case: "parentSpaceId";
+  } | {
+    /**
+     * @generated from field: bool detach = 7;
+     */
+    value: boolean;
+    case: "detach";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.UpdateSpace.
+ * Use `create(UpdateSpaceSchema)` to create a new message.
+ */
+export declare const UpdateSpaceSchema: GenMessage<UpdateSpace>;
+
+/**
+ * Deletes a space. Refused if the space still holds devices or sub-spaces unless
+ * cascade is set, so that emptying a building is always something the caller
+ * asked for rather than something a stale client did by accident.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.DeleteSpace
+ */
+export declare type DeleteSpace = Message<"kusinta.iot.webrtc.v1.DeleteSpace"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: bool cascade = 2;
+   */
+  cascade: boolean;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.DeleteSpace.
+ * Use `create(DeleteSpaceSchema)` to create a new message.
+ */
+export declare const DeleteSpaceSchema: GenMessage<DeleteSpace>;
+
+/**
+ * Adds a user to a space, granting them reach of it and everything beneath it.
+ * The user need not be known to the gateway beforehand — identities are minted by
+ * the token issuer, and this records that one of them belongs here.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.AssignUserToSpace
+ */
+export declare type AssignUserToSpace = Message<"kusinta.iot.webrtc.v1.AssignUserToSpace"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.UserId user_id = 2;
+   */
+  userId?: UserId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.AssignUserToSpace.
+ * Use `create(AssignUserToSpaceSchema)` to create a new message.
+ */
+export declare const AssignUserToSpaceSchema: GenMessage<AssignUserToSpace>;
+
+/**
+ * Removes a user's membership of a space. Losing reach also drops whatever the
+ * user was streaming from it, announced by LivePermissionUpdate.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.RemoveUserFromSpace
+ */
+export declare type RemoveUserFromSpace = Message<"kusinta.iot.webrtc.v1.RemoveUserFromSpace"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.UserId user_id = 2;
+   */
+  userId?: UserId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.RemoveUserFromSpace.
+ * Use `create(RemoveUserFromSpaceSchema)` to create a new message.
+ */
+export declare const RemoveUserFromSpaceSchema: GenMessage<RemoveUserFromSpace>;
+
+/**
+ * Files a device into a space. A device may sit in several spaces at once; this
+ * is additive, and filing a device where it already sits is a no-op.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.PlaceDeviceInSpace
+ */
+export declare type PlaceDeviceInSpace = Message<"kusinta.iot.webrtc.v1.PlaceDeviceInSpace"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
+   */
+  deviceId?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 2;
+   */
+  spaceId?: SpaceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.PlaceDeviceInSpace.
+ * Use `create(PlaceDeviceInSpaceSchema)` to create a new message.
+ */
+export declare const PlaceDeviceInSpaceSchema: GenMessage<PlaceDeviceInSpace>;
+
+/**
+ * Takes a device out of one space, leaving any others intact. A device in no
+ * space and with no owner is unfiled, and visible only to the administrator.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.RemoveDeviceFromSpace
+ */
+export declare type RemoveDeviceFromSpace = Message<"kusinta.iot.webrtc.v1.RemoveDeviceFromSpace"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
+   */
+  deviceId?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 2;
+   */
+  spaceId?: SpaceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.RemoveDeviceFromSpace.
+ * Use `create(RemoveDeviceFromSpaceSchema)` to create a new message.
+ */
+export declare const RemoveDeviceFromSpaceSchema: GenMessage<RemoveDeviceFromSpace>;
+
+/**
+ * Takes ownership of a device. Ownership is reach in its own right: an owner may
+ * see and control their device whatever their gateway-wide role permits, and may
+ * file it into spaces they belong to.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ClaimDevice
+ */
+export declare type ClaimDevice = Message<"kusinta.iot.webrtc.v1.ClaimDevice"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
+   */
+  deviceId?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.common.v1.DeviceOwnershipType ownership = 2;
+   */
+  ownership: DeviceOwnershipType;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId initial_space_id = 3;
+   */
+  initialSpaceId?: SpaceId | undefined;
+
+  /**
+   * Evidence the claimant is standing at the device: the identifier printed on it,
+   * matched against DeviceDescriptor.serial_number.
+   *
+   * The match is by SUFFIX, because what a connector announces is not always the whole
+   * of what is printed and the announced value is commonly the tail of the printed one.
+   * Both sides are normalised first — lowercased, with whitespace and ASCII hyphens
+   * removed, since a label prints the value in groups and a scan does not — and the proof
+   * is accepted when what remains ends with the announced serial. Spelled out because two
+   * gateways normalising differently would accept different proofs for the same device.
+   *
+   * A serial shorter than eight characters cannot be proved at all: under a suffix rule a
+   * short one is proved by almost anything ending with it. Required precisely when the
+   * caller cannot already reach the device, which is the ordinary case for a
+   * resident claiming something they just bought — an unfiled device is invisible
+   * to them, so possession is the only thing left that can distinguish them from
+   * someone guessing ids. The administrator, who can already reach it, needs no
+   * proof. A device whose connector reports no serial can only be claimed by the
+   * administrator.
+   *
+   * @generated from field: string possession_proof = 4;
+   */
+  possessionProof: string;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ClaimDevice.
+ * Use `create(ClaimDeviceSchema)` to create a new message.
+ */
+export declare const ClaimDeviceSchema: GenMessage<ClaimDevice>;
+
+/**
+ * Gives up ownership. The device keeps whatever space filing it has; if it has
+ * none it becomes unfiled.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ReleaseDevice
+ */
+export declare type ReleaseDevice = Message<"kusinta.iot.webrtc.v1.ReleaseDevice"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
+   */
+  deviceId?: DeviceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ReleaseDevice.
+ * Use `create(ReleaseDeviceSchema)` to create a new message.
+ */
+export declare const ReleaseDeviceSchema: GenMessage<ReleaseDevice>;
+
+/**
+ * Asks for the spaces the caller can reach. Unset root_space_id means all of
+ * them, which for most users is one apartment and for an administrator is the
+ * building.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ListSpaces
+ */
+export declare type ListSpaces = Message<"kusinta.iot.webrtc.v1.ListSpaces"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId root_space_id = 1;
+   */
+  rootSpaceId?: SpaceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ListSpaces.
+ * Use `create(ListSpacesSchema)` to create a new message.
+ */
+export declare const ListSpacesSchema: GenMessage<ListSpaces>;
+
+/**
+ * The spaces themselves, flat: each Space carries its own parent_space_id, so the
+ * structure travels with the elements and a client rebuilds the tree from them.
+ * A flat list also degrades honestly when it is truncated — a partial tree with
+ * dangling parents is still readable, where a nested one would lose whole
+ * subtrees.
+ *
+ * device_ids on each Space are filtered to what the caller may see. An
+ * unfiltered tree would list every device on the gateway by id, which is the
+ * enumeration channel the snapshot filter exists to close.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.SpaceTree
+ */
+export declare type SpaceTree = Message<"kusinta.iot.webrtc.v1.SpaceTree"> & {
+  /**
+   * @generated from field: repeated kusinta.iot.space.v1.Space spaces = 1;
+   */
+  spaces: Space[];
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.SpaceTree.
+ * Use `create(SpaceTreeSchema)` to create a new message.
+ */
+export declare const SpaceTreeSchema: GenMessage<SpaceTree>;
+
+/**
+ * The answer to an operation that changes something and has nothing to return.
+ * Deliberately empty: ManagementResult.in_reply_to says which request succeeded,
+ * and what the change did to the caller's reach arrives on LivePermissionUpdate
+ * rather than here.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ManagementAck
+ */
+export declare type ManagementAck = Message<"kusinta.iot.webrtc.v1.ManagementAck"> & {
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ManagementAck.
+ * Use `create(ManagementAckSchema)` to create a new message.
+ */
+export declare const ManagementAckSchema: GenMessage<ManagementAck>;
+
+/**
+ * A single filing operation, app → gateway. One wrapper rather than ten payload
+ * cases on AppMessage: authorization for filing depends on the target, not on the
+ * message kind, so these can never be gated by a table keyed on the envelope case
+ * the way device messages are. Keeping them behind one case means one place that
+ * must authorize, and one refusal path that must not leak whether a target exists.
+ * Links one device to another, so the sender leads the receiver. The gateway
+ * resolves which underlying connections that needs and asks the connector for
+ * them; a caller names two devices and what the link is for.
+ *
+ * Authorized against both ends, and not symmetrically. Leading a device is a
+ * standing grant of control over it, so the receiver requires ownership or a
+ * servicing role. The sender's requirement depends on the mode: a gateway-kept
+ * link only reads what the caller can already see, while a device-to-device one
+ * writes configuration to the sender and spends its battery, which is a change
+ * to someone else's hardware.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.CreateDeviceLink
+ */
+export declare type CreateDeviceLink = Message<"kusinta.iot.webrtc.v1.CreateDeviceLink"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId sender = 1;
+   */
+  sender?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId receiver = 2;
+   */
+  receiver?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.link.v1.LinkFunction function = 3;
+   */
+  function: LinkFunction;
+
+  /**
+   * Unset lets the gateway choose, which prefers a device-to-device link where
+   * one can be brokered: it survives a gateway outage and runs at the devices'
+   * own rate. Name one to override that.
+   *
+   * @generated from field: kusinta.iot.link.v1.LinkMode mode = 4;
+   */
+  mode: LinkMode;
+
+  /**
+   * How a gateway-kept link is to behave, set as it is made. Carried here as
+   * well as on UpdateDeviceLink so that a link does not have to exist in a
+   * configured-by-nobody state first — a soft climate link created without a
+   * target is one that holds the room at nothing until a second request
+   * arrives, and every reader would have to handle that transient forever.
+   *
+   * Unset is still allowed and still means unconfigured, since a hard link has
+   * nothing to configure and a caller may genuinely not know the target yet.
+   *
+   * @generated from field: kusinta.iot.link.v1.LinkSettings settings = 5;
+   */
+  settings?: LinkSettings | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.CreateDeviceLink.
+ * Use `create(CreateDeviceLinkSchema)` to create a new message.
+ */
+export declare const CreateDeviceLinkSchema: GenMessage<CreateDeviceLink>;
+
+/**
+ * Removes a link. Note that on at least one vendor, removing a link disturbs the
+ * receiver's own settings and the connector must repair them, so this is not the
+ * no-op it appears to be.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.RemoveDeviceLink
+ */
+export declare type RemoveDeviceLink = Message<"kusinta.iot.webrtc.v1.RemoveDeviceLink"> & {
+  /**
+   * @generated from field: string link_id = 1;
+   */
+  linkId: string;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.RemoveDeviceLink.
+ * Use `create(RemoveDeviceLinkSchema)` to create a new message.
+ */
+export declare const RemoveDeviceLinkSchema: GenMessage<RemoveDeviceLink>;
+
+/**
+ * Changes how a gateway-kept link behaves — for a climate lead, the temperature
+ * it is to hold.
+ *
+ * Refused on a link that has nothing to configure — see LinkSettings — rather
+ * than accepted as a no-op, so that a caller who has mistaken which link they
+ * are holding is told.
+ *
+ * Authorized against both ends, as creating and removing the link are: deciding
+ * what temperature a room is held at is directing a device, not adjusting one,
+ * so it takes ownership of the ends or a servicing role, not the permission to
+ * turn a thermostat up.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.UpdateDeviceLink
+ */
+export declare type UpdateDeviceLink = Message<"kusinta.iot.webrtc.v1.UpdateDeviceLink"> & {
+  /**
+   * @generated from field: string link_id = 1;
+   */
+  linkId: string;
+
+  /**
+   * Replaces the link's settings rather than patching them: the settings of one
+   * function are few and are set together, so there is no half-update worth
+   * expressing. This is why it does not follow UpdateSpace's per-field optional
+   * shape, which exists for a message whose fields genuinely move alone.
+   *
+   * Unset is refused rather than being given a meaning. It would have to mean
+   * either "leave everything alone", making the request a no-op, or "clear the
+   * settings", which is the one thing that reads like an accident — and the
+   * wire cannot tell those two callers apart.
+   *
+   * @generated from field: kusinta.iot.link.v1.LinkSettings settings = 2;
+   */
+  settings?: LinkSettings | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.UpdateDeviceLink.
+ * Use `create(UpdateDeviceLinkSchema)` to create a new message.
+ */
+export declare const UpdateDeviceLinkSchema: GenMessage<UpdateDeviceLink>;
+
+/**
+ * Lists links. Unset device_id lists every link among devices the caller can
+ * reach; naming one narrows it to that device's own, in either direction.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ListDeviceLinks
+ */
+export declare type ListDeviceLinks = Message<"kusinta.iot.webrtc.v1.ListDeviceLinks"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
+   */
+  deviceId?: DeviceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ListDeviceLinks.
+ * Use `create(ListDeviceLinksSchema)` to create a new message.
+ */
+export declare const ListDeviceLinksSchema: GenMessage<ListDeviceLinks>;
+
+/**
+ * @generated from message kusinta.iot.webrtc.v1.ManagementRequest
+ */
+export declare type ManagementRequest = Message<"kusinta.iot.webrtc.v1.ManagementRequest"> & {
+  /**
+   * @generated from oneof kusinta.iot.webrtc.v1.ManagementRequest.request
+   */
+  request: {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.CreateSpace create_space = 1;
+     */
+    value: CreateSpace;
+    case: "createSpace";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.UpdateSpace update_space = 2;
+     */
+    value: UpdateSpace;
+    case: "updateSpace";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.DeleteSpace delete_space = 3;
+     */
+    value: DeleteSpace;
+    case: "deleteSpace";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.AssignUserToSpace assign_user_to_space = 4;
+     */
+    value: AssignUserToSpace;
+    case: "assignUserToSpace";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.RemoveUserFromSpace remove_user_from_space = 5;
+     */
+    value: RemoveUserFromSpace;
+    case: "removeUserFromSpace";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.PlaceDeviceInSpace place_device_in_space = 6;
+     */
+    value: PlaceDeviceInSpace;
+    case: "placeDeviceInSpace";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.RemoveDeviceFromSpace remove_device_from_space = 7;
+     */
+    value: RemoveDeviceFromSpace;
+    case: "removeDeviceFromSpace";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.ClaimDevice claim_device = 8;
+     */
+    value: ClaimDevice;
+    case: "claimDevice";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.ReleaseDevice release_device = 9;
+     */
+    value: ReleaseDevice;
+    case: "releaseDevice";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.ListSpaces list_spaces = 10;
+     */
+    value: ListSpaces;
+    case: "listSpaces";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.CreateDeviceLink create_device_link = 11;
+     */
+    value: CreateDeviceLink;
+    case: "createDeviceLink";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.RemoveDeviceLink remove_device_link = 12;
+     */
+    value: RemoveDeviceLink;
+    case: "removeDeviceLink";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.ListDeviceLinks list_device_links = 13;
+     */
+    value: ListDeviceLinks;
+    case: "listDeviceLinks";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.webrtc.v1.UpdateDeviceLink update_device_link = 14;
+     */
+    value: UpdateDeviceLink;
+    case: "updateDeviceLink";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ManagementRequest.
+ * Use `create(ManagementRequestSchema)` to create a new message.
+ */
+export declare const ManagementRequestSchema: GenMessage<ManagementRequest>;
+