@m1kad0/hannah-proto 5.1.0 → 5.3.0

package/dist/compat_versions.js

@@ -177,6 +177,7 @@ exports.REQUIRED_COMPAT_VERSIONS = {
     "/hannah.v2.HannahService/CreateMessage": 1,
     "/hannah.v2.HannahService/ListMessages": 1,
     "/hannah.v2.HannahService/DeleteMessage": 1,
+    "/hannah.v2.HannahService/Heartbeat": 1,
     "/hannah.v2.LogService/Ship": 1,
     "/hannah.v2.LogService/GetSources": 1,
     "/hannah.v2.LogService/Export": 1

package/dist/v2/agent.d.ts

@@ -100,13 +100,15 @@ export interface CaptureControl {
 }
 /**
  * A state change event for a state Hannah asked to watch (AgentWatchMore), e.g. the
- * trigger engine's conditions. Devices are not reported this way, they use SlotUpdate.
+ * trigger engine's conditions. `state_id` is the identifier the adapter uses for the value
+ * (for ioBroker the state ID, the same as `Slot.identifier` for a slot of a device). Devices
+ * report their changes as SlotUpdate; a value that is both a slot and watched gets both.
  * ack=true means the device confirmed the value (as opposed to ack=false which is the
  * "desired" value). Hannah uses this to verify that a SetState command was executed
- * successfully.
+ * successfully. The value is the raw one of that state, not normalized to a slot scale.
  */
 export interface AgentStateUpdate {
-    /** full ioBroker state ID, e.g. "0_userdata.0.feeded" */
+    /** identifier of the value, for ioBroker the full state ID, e.g. "0_userdata.0.feeded" */
     stateId: string;
     /** JSON-encoded value: "true", "42", "\"text\"" */
     value: string;
@@ -114,6 +116,13 @@ export interface AgentStateUpdate {
     ack: boolean;
     /** Unix timestamp in milliseconds */
     ts: bigint;
+    /**
+     * Field 5 is deliberately unused: in hannah.v1 it was `canonical_key`, a different type.
+     * true = the current value the adapter sends when it starts watching a state (its answer to
+     * AgentWatchMore), not a change. Hannah Core uses it to prefill the trigger engine's cache
+     * silently, without firing triggers: an update from "unknown" to a value is not a transition.
+     */
+    initial: boolean;
 }
 /** The text-command state in ioBroker changed — treat as a SubmitText call. */
 export interface AgentTextCommand {
@@ -183,15 +192,16 @@ export interface AgentFirmwareEvent {
  * confirms execution back to Hannah.
  */
 export interface AgentSetState {
-    /** ioBroker state ID to write */
+    /** identifier of the value to write, for ioBroker the state ID */
     stateId: string;
     /** JSON-encoded value */
     value: string;
 }
 /**
- * Hannah requests additional state IDs to be included in the AgentStateUpdate stream.
- * Used by the trigger engine at runtime when triggers reference arbitrary state IDs
- * (e.g. unless.state: "0_userdata.0.feeded") that aren't covered by enum discovery.
+ * Hannah requests additional identifiers (for ioBroker state IDs) to be included in the
+ * AgentStateUpdate stream. Used by the trigger engine at runtime when triggers reference
+ * arbitrary values (e.g. unless.state: "0_userdata.0.feeded") that aren't covered by enum
+ * discovery. The adapter answers every new one with its current raw value, `initial` = true.
  */
 export interface AgentWatchMore {
     stateIds: string[];

package/dist/v2/agent.js

@@ -476,7 +476,7 @@ exports.CaptureControl = {
     },
 };
 function createBaseAgentStateUpdate() {
-    return { stateId: "", value: "", ack: false, ts: 0n };
+    return { stateId: "", value: "", ack: false, ts: 0n, initial: false };
 }
 exports.AgentStateUpdate = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -495,6 +495,9 @@ exports.AgentStateUpdate = {
             }
             writer.uint32(32).int64(message.ts);
         }
+        if (message.initial !== false) {
+            writer.uint32(48).bool(message.initial);
+        }
         return writer;
     },
     decode(input, length) {
@@ -538,6 +541,13 @@ exports.AgentStateUpdate = {
                         message.ts = reader.int64();
                         continue;
                     }
+                    case 6: {
+                        if (tag !== 48) {
+                            break;
+                        }
+                        message.initial = reader.bool();
+                        continue;
+                    }
                 }
                 if ((tag & 7) === 4 || tag === 0) {
                     break;
@@ -559,6 +569,7 @@ exports.AgentStateUpdate = {
         message.value = object.value ?? "";
         message.ack = object.ack ?? false;
         message.ts = (object.ts !== undefined && object.ts !== null) ? BigInt(object.ts) : 0n;
+        message.initial = object.initial ?? false;
         return message;
     },
 };

package/dist/v2/device_model.d.ts

@@ -163,6 +163,14 @@ export interface Slot {
      * honestly when a device cannot do what was asked.
      */
     options: string[];
+    /**
+     * How a trigger (and any client building triggers) refers to the value behind this slot: the
+     * identifier the adapter uses for it, for ioBroker the state ID. Opaque to Hannah Core, which
+     * only passes it through (AgentWatchMore, AgentSetState, AgentStateUpdate, trigger conditions
+     * and actions). Empty = not addressable by triggers. Triggers compare against the raw value
+     * of the identified state (and its own scale), not against the normalized `value` above.
+     */
+    identifier: string;
 }
 /** A device, as the adapter derived it from the ioBroker objects (grouping, class, slots). */
 export interface TypedDevice {

package/dist/v2/device_model.js

@@ -230,6 +230,7 @@ function createBaseSlot() {
         label: "",
         requiredTrustLevel: undefined,
         options: [],
+        identifier: "",
     };
 }
 exports.Slot = {
@@ -258,6 +259,9 @@ exports.Slot = {
         for (const v of message.options) {
             writer.uint32(66).string(v);
         }
+        if (message.identifier !== "") {
+            writer.uint32(74).string(message.identifier);
+        }
         return writer;
     },
     decode(input, length) {
@@ -329,6 +333,13 @@ exports.Slot = {
                         message.options.push(reader.string());
                         continue;
                     }
+                    case 9: {
+                        if (tag !== 74) {
+                            break;
+                        }
+                        message.identifier = reader.string();
+                        continue;
+                    }
                 }
                 if ((tag & 7) === 4 || tag === 0) {
                     break;
@@ -356,6 +367,7 @@ exports.Slot = {
         message.label = object.label ?? "";
         message.requiredTrustLevel = object.requiredTrustLevel ?? undefined;
         message.options = object.options?.map((e) => e) || [];
+        message.identifier = object.identifier ?? "";
         return message;
     },
 };

package/dist/v2/hannah.d.ts

@@ -1,3 +1,4 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import { type CallOptions, type ChannelCredentials, Client, type ClientDuplexStream, type ClientOptions, type ClientReadableStream, type ClientUnaryCall, type handleBidiStreamingCall, type handleServerStreamingCall, type handleUnaryCall, type Metadata, type ServiceError, type UntypedServiceImplementation } from "@grpc/grpc-js";
 import { ActivityAudioChunk, ListActivityLogRequest, ListActivityLogResponse, StreamActivityAudioRequest } from "./activity_log";
 import { AgentCommand, AgentMessage, AgentNotification } from "./agent";
@@ -19,6 +20,12 @@ import { TimerCommand, TimerMessage } from "./timer_service";
 import { CreateLinkTokenRequest, CreateLinkTokenResponse, CreateUserRequest, CreateUserResponse, DeleteUserRequest, GetResidentsResponse, GetUserRequest, GetUsersRequest, GetUsersResponse, LinkAccountRequest, LoginRequest, SetAutomationRequest, SetSystemMessagesRequest, SetTrustLevelRequest, UnlinkAccountRequest, UpdateUserRequest, UserResponse } from "./user_registry";
 import { CaptureCommand, CollectorMessage, SatelliteAudioChunk, SatelliteCaptureRequest, SatelliteCaptureResponse, TriggerPlinkRequest } from "./wakeword_capture";
 export declare const protobufPackage = "hannah.v2";
+export interface HeartbeatRequest {
+}
+export interface HeartbeatResponse {
+}
+export declare const HeartbeatRequest: MessageFns<HeartbeatRequest>;
+export declare const HeartbeatResponse: MessageFns<HeartbeatResponse>;
 export type HannahServiceService = typeof HannahServiceService;
 export declare const HannahServiceService: {
     /** --- User Registry --- */
@@ -956,6 +963,19 @@ export declare const HannahServiceService: {
         readonly responseSerialize: (value: StatusResponse) => Buffer;
         readonly responseDeserialize: (value: Buffer) => StatusResponse;
     };
+    /**
+     * Liveness signal from a component. The component names itself in the call metadata
+     * (x-component, x-component-version, x-component-id), the message carries nothing yet.
+     */
+    readonly heartbeat: {
+        readonly path: "/hannah.v2.HannahService/Heartbeat";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: HeartbeatRequest) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => HeartbeatRequest;
+        readonly responseSerialize: (value: HeartbeatResponse) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => HeartbeatResponse;
+    };
 };
 export interface HannahServiceServer extends UntypedServiceImplementation {
     /** --- User Registry --- */
@@ -1213,6 +1233,11 @@ export interface HannahServiceServer extends UntypedServiceImplementation {
     createMessage: handleUnaryCall<CreateMessageRequest, StatusResponse>;
     listMessages: handleUnaryCall<ListMessagesRequest, ListMessagesResponse>;
     deleteMessage: handleUnaryCall<DeleteMessageRequest, StatusResponse>;
+    /**
+     * Liveness signal from a component. The component names itself in the call metadata
+     * (x-component, x-component-version, x-component-id), the message carries nothing yet.
+     */
+    heartbeat: handleUnaryCall<HeartbeatRequest, HeartbeatResponse>;
 }
 export interface HannahServiceClient extends Client {
     /** --- User Registry --- */
@@ -1636,9 +1661,33 @@ export interface HannahServiceClient extends Client {
     deleteMessage(request: DeleteMessageRequest, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     deleteMessage(request: DeleteMessageRequest, metadata: Metadata, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     deleteMessage(request: DeleteMessageRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
+    /**
+     * Liveness signal from a component. The component names itself in the call metadata
+     * (x-component, x-component-version, x-component-id), the message carries nothing yet.
+     */
+    heartbeat(request: HeartbeatRequest, callback: (error: ServiceError | null, response: HeartbeatResponse) => void): ClientUnaryCall;
+    heartbeat(request: HeartbeatRequest, metadata: Metadata, callback: (error: ServiceError | null, response: HeartbeatResponse) => void): ClientUnaryCall;
+    heartbeat(request: HeartbeatRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: HeartbeatResponse) => void): ClientUnaryCall;
 }
 export declare const HannahServiceClient: {
     new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): HannahServiceClient;
     service: typeof HannahServiceService;
     serviceName: string;
 };
+type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
+export type DeepPartial<T> = T extends bigint ? string | number | bigint : T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};

package/dist/v2/hannah.js

@@ -5,8 +5,9 @@
 //   protoc               unknown
 // source: hannah/v2/hannah.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HannahServiceClient = exports.HannahServiceService = exports.protobufPackage = void 0;
+exports.HannahServiceClient = exports.HannahServiceService = exports.HeartbeatResponse = exports.HeartbeatRequest = exports.protobufPackage = void 0;
 /* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
 const grpc_js_1 = require("@grpc/grpc-js");
 const activity_log_1 = require("./activity_log");
 const agent_1 = require("./agent");
@@ -28,6 +29,86 @@ const timer_service_1 = require("./timer_service");
 const user_registry_1 = require("./user_registry");
 const wakeword_capture_1 = require("./wakeword_capture");
 exports.protobufPackage = "hannah.v2";
+function createBaseHeartbeatRequest() {
+    return {};
+}
+exports.HeartbeatRequest = {
+    encode(_, writer = new wire_1.BinaryWriter()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const previousRecursionDepth = reader.__tsProtoDecodeDepth ?? 0;
+        if (previousRecursionDepth >= 100) {
+            throw new globalThis.Error("protobuf decode recursion limit exceeded");
+        }
+        reader.__tsProtoDecodeDepth = previousRecursionDepth + 1;
+        try {
+            const end = length === undefined ? reader.len : reader.pos + length;
+            const message = createBaseHeartbeatRequest();
+            while (reader.pos < end) {
+                const tag = reader.uint32();
+                switch (tag >>> 3) {
+                }
+                if ((tag & 7) === 4 || tag === 0) {
+                    break;
+                }
+                reader.skip(tag & 7);
+            }
+            return message;
+        }
+        finally {
+            reader.__tsProtoDecodeDepth = previousRecursionDepth;
+        }
+    },
+    create(base) {
+        return exports.HeartbeatRequest.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseHeartbeatRequest();
+        return message;
+    },
+};
+function createBaseHeartbeatResponse() {
+    return {};
+}
+exports.HeartbeatResponse = {
+    encode(_, writer = new wire_1.BinaryWriter()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const previousRecursionDepth = reader.__tsProtoDecodeDepth ?? 0;
+        if (previousRecursionDepth >= 100) {
+            throw new globalThis.Error("protobuf decode recursion limit exceeded");
+        }
+        reader.__tsProtoDecodeDepth = previousRecursionDepth + 1;
+        try {
+            const end = length === undefined ? reader.len : reader.pos + length;
+            const message = createBaseHeartbeatResponse();
+            while (reader.pos < end) {
+                const tag = reader.uint32();
+                switch (tag >>> 3) {
+                }
+                if ((tag & 7) === 4 || tag === 0) {
+                    break;
+                }
+                reader.skip(tag & 7);
+            }
+            return message;
+        }
+        finally {
+            reader.__tsProtoDecodeDepth = previousRecursionDepth;
+        }
+    },
+    create(base) {
+        return exports.HeartbeatResponse.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseHeartbeatResponse();
+        return message;
+    },
+};
 exports.HannahServiceService = {
     /** --- User Registry --- */
     getUsers: {
@@ -964,5 +1045,18 @@ exports.HannahServiceService = {
         responseSerialize: (value) => Buffer.from(shared_1.StatusResponse.encode(value).finish()),
         responseDeserialize: (value) => shared_1.StatusResponse.decode(value),
     },
+    /**
+     * Liveness signal from a component. The component names itself in the call metadata
+     * (x-component, x-component-version, x-component-id), the message carries nothing yet.
+     */
+    heartbeat: {
+        path: "/hannah.v2.HannahService/Heartbeat",
+        requestStream: false,
+        responseStream: false,
+        requestSerialize: (value) => Buffer.from(exports.HeartbeatRequest.encode(value).finish()),
+        requestDeserialize: (value) => exports.HeartbeatRequest.decode(value),
+        responseSerialize: (value) => Buffer.from(exports.HeartbeatResponse.encode(value).finish()),
+        responseDeserialize: (value) => exports.HeartbeatResponse.decode(value),
+    },
 };
 exports.HannahServiceClient = (0, grpc_js_1.makeGenericClientConstructor)(exports.HannahServiceService, "hannah.v2.HannahService");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m1kad0/hannah-proto",
-  "version": "5.1.0",
+  "version": "5.3.0",
   "description": "Generated TypeScript gRPC-js client stubs for the Hannah voice assistant proto schema",
   "license": "UNLICENSED",
   "main": "dist/index.js",