@m1kad0/hannah-proto 3.4.0 → 3.5.0

package/dist/compat_versions.js

@@ -61,6 +61,7 @@ exports.REQUIRED_COMPAT_VERSIONS = {
     "ReleaseSatelliteCapture": 1,
     "StreamSatelliteAudio": 1,
     "TriggerPlink": 1,
+    "CollectorConnect": 1,
     "RegisterProxy": 1,
     "SubmitSatelliteAudio": 1,
     "NotifySatelliteRegistered": 1,

package/dist/hannah.d.ts

@@ -14,7 +14,7 @@ import { EnrollVoiceprintRequest } from "./speaker_enrollment";
 import { DeleteTimerRequest, GetTimersRequest, GetTimersResponse } from "./timer_admin";
 import { TimerCommand, TimerMessage } from "./timer_service";
 import { CreateUserRequest, CreateUserResponse, DeleteUserRequest, GetResidentsResponse, GetUserRequest, GetUsersRequest, GetUsersResponse, LinkAccountRequest, LoginRequest, SetAutomationRequest, SetSystemMessagesRequest, SetTrustLevelRequest, UnlinkAccountRequest, UpdateUserRequest, UserResponse } from "./user_registry";
-import { SatelliteAudioChunk, SatelliteCaptureRequest, SatelliteCaptureResponse, TriggerPlinkRequest } from "./wakeword_capture";
+import { CaptureCommand, CollectorMessage, SatelliteAudioChunk, SatelliteCaptureRequest, SatelliteCaptureResponse, TriggerPlinkRequest } from "./wakeword_capture";
 export declare const protobufPackage = "hannah";
 export type HannahServiceService = typeof HannahServiceService;
 export declare const HannahServiceService: {
@@ -604,6 +604,20 @@ export declare const HannahServiceService: {
         readonly responseSerialize: (value: StatusResponse) => Buffer;
         readonly responseDeserialize: (value: Buffer) => StatusResponse;
     };
+    /**
+     * Bidirectional stream between the Collector and Hannah Core, analogous to TimerConnect.
+     * The Collector initiates and holds the connection open; Hannah pushes CaptureCommands
+     * down to start/stop satellite captures instead of the Collector polling for them.
+     */
+    readonly collectorConnect: {
+        readonly path: "/hannah.HannahService/CollectorConnect";
+        readonly requestStream: true;
+        readonly responseStream: true;
+        readonly requestSerialize: (value: CollectorMessage) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => CollectorMessage;
+        readonly responseSerialize: (value: CaptureCommand) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => CaptureCommand;
+    };
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS
@@ -908,6 +922,12 @@ export interface HannahServiceServer extends UntypedServiceImplementation {
      * Returns after PTT is released — Collector calls this in a loop for guided hey-hannah collection.
      */
     triggerPlink: handleUnaryCall<TriggerPlinkRequest, StatusResponse>;
+    /**
+     * Bidirectional stream between the Collector and Hannah Core, analogous to TimerConnect.
+     * The Collector initiates and holds the connection open; Hannah pushes CaptureCommands
+     * down to start/stop satellite captures instead of the Collector polling for them.
+     */
+    collectorConnect: handleBidiStreamingCall<CollectorMessage, CaptureCommand>;
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS
@@ -1220,6 +1240,14 @@ export interface HannahServiceClient extends Client {
     triggerPlink(request: TriggerPlinkRequest, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     triggerPlink(request: TriggerPlinkRequest, metadata: Metadata, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     triggerPlink(request: TriggerPlinkRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
+    /**
+     * Bidirectional stream between the Collector and Hannah Core, analogous to TimerConnect.
+     * The Collector initiates and holds the connection open; Hannah pushes CaptureCommands
+     * down to start/stop satellite captures instead of the Collector polling for them.
+     */
+    collectorConnect(): ClientDuplexStream<CollectorMessage, CaptureCommand>;
+    collectorConnect(options: Partial<CallOptions>): ClientDuplexStream<CollectorMessage, CaptureCommand>;
+    collectorConnect(metadata: Metadata, options?: Partial<CallOptions>): ClientDuplexStream<CollectorMessage, CaptureCommand>;
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS

package/dist/hannah.js

@@ -612,6 +612,20 @@ exports.HannahServiceService = {
         responseSerialize: (value) => Buffer.from(shared_1.StatusResponse.encode(value).finish()),
         responseDeserialize: (value) => shared_1.StatusResponse.decode(value),
     },
+    /**
+     * Bidirectional stream between the Collector and Hannah Core, analogous to TimerConnect.
+     * The Collector initiates and holds the connection open; Hannah pushes CaptureCommands
+     * down to start/stop satellite captures instead of the Collector polling for them.
+     */
+    collectorConnect: {
+        path: "/hannah.HannahService/CollectorConnect",
+        requestStream: true,
+        responseStream: true,
+        requestSerialize: (value) => Buffer.from(wakeword_capture_1.CollectorMessage.encode(value).finish()),
+        requestDeserialize: (value) => wakeword_capture_1.CollectorMessage.decode(value),
+        responseSerialize: (value) => Buffer.from(wakeword_capture_1.CaptureCommand.encode(value).finish()),
+        responseDeserialize: (value) => wakeword_capture_1.CaptureCommand.decode(value),
+    },
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS

package/dist/wakeword_capture.d.ts

@@ -1,5 +1,12 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 export declare const protobufPackage = "hannah";
+export declare enum CaptureMode {
+    CAPTURE_MODE_UNSPECIFIED = 0,
+    CAPTURE_MODE_MANUAL = 1,
+    CAPTURE_MODE_PTT = 2,
+    CAPTURE_MODE_PLINK = 3,
+    UNRECOGNIZED = -1
+}
 export interface SatelliteCaptureRequest {
     deviceId: string;
     /**
@@ -32,10 +39,50 @@ export interface SatelliteAudioChunk {
     /** true = PTT released, utterance boundary */
     endOfUtterance: boolean;
 }
+/**
+ * Sent by Hannah Core over the CollectorConnect stream to start or stop a
+ * satellite capture — the Collector-side counterpart to RequestSatelliteCapture/
+ * ReleaseSatelliteCapture, pushed proactively instead of polled.
+ * capture_mode is only meaningful when sample_type is hey_hannah.
+ */
+export interface CaptureCommand {
+    deviceId: string;
+    sampleType: SampleType | undefined;
+    captureMode: CaptureMode;
+    stop: boolean;
+}
+/**
+ * Deliberately a oneof of (currently empty) payload messages rather than a plain
+ * enum — leaves room to attach per-sample-type data later without a breaking change.
+ */
+export interface SampleType {
+    noise?: NoiseSample | undefined;
+    heyHannah?: HeyHannahSample | undefined;
+}
+export interface NoiseSample {
+}
+export interface HeyHannahSample {
+}
+/** Sent by the Collector over the CollectorConnect stream. */
+export interface CollectorMessage {
+    /** initial confirmation when stream is established */
+    ack?: CollectorAck | undefined;
+}
+/** Sent once by the Collector after the CollectorConnect stream is established. */
+export interface CollectorAck {
+    /** human-readable status */
+    message: string;
+}
 export declare const SatelliteCaptureRequest: MessageFns<SatelliteCaptureRequest>;
 export declare const TriggerPlinkRequest: MessageFns<TriggerPlinkRequest>;
 export declare const SatelliteCaptureResponse: MessageFns<SatelliteCaptureResponse>;
 export declare const SatelliteAudioChunk: MessageFns<SatelliteAudioChunk>;
+export declare const CaptureCommand: MessageFns<CaptureCommand>;
+export declare const SampleType: MessageFns<SampleType>;
+export declare const NoiseSample: MessageFns<NoiseSample>;
+export declare const HeyHannahSample: MessageFns<HeyHannahSample>;
+export declare const CollectorMessage: MessageFns<CollectorMessage>;
+export declare const CollectorAck: MessageFns<CollectorAck>;
 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]>;

package/dist/wakeword_capture.js

@@ -5,10 +5,18 @@
 //   protoc               unknown
 // source: hannah/wakeword_capture.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SatelliteAudioChunk = exports.SatelliteCaptureResponse = exports.TriggerPlinkRequest = exports.SatelliteCaptureRequest = exports.protobufPackage = void 0;
+exports.CollectorAck = exports.CollectorMessage = exports.HeyHannahSample = exports.NoiseSample = exports.SampleType = exports.CaptureCommand = exports.SatelliteAudioChunk = exports.SatelliteCaptureResponse = exports.TriggerPlinkRequest = exports.SatelliteCaptureRequest = exports.CaptureMode = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 exports.protobufPackage = "hannah";
+var CaptureMode;
+(function (CaptureMode) {
+    CaptureMode[CaptureMode["CAPTURE_MODE_UNSPECIFIED"] = 0] = "CAPTURE_MODE_UNSPECIFIED";
+    CaptureMode[CaptureMode["CAPTURE_MODE_MANUAL"] = 1] = "CAPTURE_MODE_MANUAL";
+    CaptureMode[CaptureMode["CAPTURE_MODE_PTT"] = 2] = "CAPTURE_MODE_PTT";
+    CaptureMode[CaptureMode["CAPTURE_MODE_PLINK"] = 3] = "CAPTURE_MODE_PLINK";
+    CaptureMode[CaptureMode["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(CaptureMode || (exports.CaptureMode = CaptureMode = {}));
 function createBaseSatelliteCaptureRequest() {
     return { deviceId: "", sampleType: "" };
 }
@@ -228,3 +236,277 @@ exports.SatelliteAudioChunk = {
         return message;
     },
 };
+function createBaseCaptureCommand() {
+    return { deviceId: "", sampleType: undefined, captureMode: 0, stop: false };
+}
+exports.CaptureCommand = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.deviceId !== "") {
+            writer.uint32(10).string(message.deviceId);
+        }
+        if (message.sampleType !== undefined) {
+            exports.SampleType.encode(message.sampleType, writer.uint32(18).fork()).join();
+        }
+        if (message.captureMode !== 0) {
+            writer.uint32(24).int32(message.captureMode);
+        }
+        if (message.stop !== false) {
+            writer.uint32(32).bool(message.stop);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCaptureCommand();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.deviceId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.sampleType = exports.SampleType.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.captureMode = reader.int32();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.stop = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.CaptureCommand.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCaptureCommand();
+        message.deviceId = object.deviceId ?? "";
+        message.sampleType = (object.sampleType !== undefined && object.sampleType !== null)
+            ? exports.SampleType.fromPartial(object.sampleType)
+            : undefined;
+        message.captureMode = object.captureMode ?? 0;
+        message.stop = object.stop ?? false;
+        return message;
+    },
+};
+function createBaseSampleType() {
+    return { noise: undefined, heyHannah: undefined };
+}
+exports.SampleType = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.noise !== undefined) {
+            exports.NoiseSample.encode(message.noise, writer.uint32(10).fork()).join();
+        }
+        if (message.heyHannah !== undefined) {
+            exports.HeyHannahSample.encode(message.heyHannah, writer.uint32(18).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseSampleType();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.noise = exports.NoiseSample.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.heyHannah = exports.HeyHannahSample.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.SampleType.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSampleType();
+        message.noise = (object.noise !== undefined && object.noise !== null)
+            ? exports.NoiseSample.fromPartial(object.noise)
+            : undefined;
+        message.heyHannah = (object.heyHannah !== undefined && object.heyHannah !== null)
+            ? exports.HeyHannahSample.fromPartial(object.heyHannah)
+            : undefined;
+        return message;
+    },
+};
+function createBaseNoiseSample() {
+    return {};
+}
+exports.NoiseSample = {
+    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 end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseNoiseSample();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.NoiseSample.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseNoiseSample();
+        return message;
+    },
+};
+function createBaseHeyHannahSample() {
+    return {};
+}
+exports.HeyHannahSample = {
+    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 end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseHeyHannahSample();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.HeyHannahSample.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseHeyHannahSample();
+        return message;
+    },
+};
+function createBaseCollectorMessage() {
+    return { ack: undefined };
+}
+exports.CollectorMessage = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.ack !== undefined) {
+            exports.CollectorAck.encode(message.ack, writer.uint32(10).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCollectorMessage();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.ack = exports.CollectorAck.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.CollectorMessage.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCollectorMessage();
+        message.ack = (object.ack !== undefined && object.ack !== null) ? exports.CollectorAck.fromPartial(object.ack) : undefined;
+        return message;
+    },
+};
+function createBaseCollectorAck() {
+    return { message: "" };
+}
+exports.CollectorAck = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.message !== "") {
+            writer.uint32(10).string(message.message);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCollectorAck();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.message = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.CollectorAck.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCollectorAck();
+        message.message = object.message ?? "";
+        return message;
+    },
+};

package/package.json

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