@m1kad0/hannah-proto 4.5.0 → 4.6.1

package/dist/v1/control.d.ts

@@ -0,0 +1,383 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "hannah.v1";
+export interface SubmitTextRequest {
+    text: string;
+    /**
+     * Identifies the calling service and its user, so Hannah can look up
+     * the corresponding roomie via linked_accounts.
+     */
+    sourceService: string;
+    /** e.g. Telegram chat_id as string */
+    sourceUserId: string;
+}
+export interface SubmitTextResponse {
+    /** text to send back to the user */
+    answer: string;
+    /** e.g. "WeatherQuery", "TurnOn", "Unknown" */
+    intentName: string;
+}
+export interface SubmitVoiceRequest {
+    /** OGG/Opus audio bytes (from Telegram voice message) */
+    audio: Uint8Array;
+    /** e.g. "telegram" */
+    sourceService: string;
+    /** e.g. Telegram chat_id as string */
+    sourceUserId: string;
+}
+export interface SubmitVoiceResponse {
+    /** STT result (for display / caption) */
+    transcript: string;
+    /** text answer from Hannah */
+    answer: string;
+    /** e.g. "CarQuery" — caller may enrich the text reply */
+    intentName: string;
+    /** OGG/Opus TTS response (empty if TTS disabled or failed) */
+    audioOgg: Uint8Array;
+}
+export interface AnnounceRequest {
+    text: string;
+    /** satellite device name, or "all" for broadcast — legacy path, ignored if room_id or user_id is set */
+    device: string;
+    /**
+     * #31: target by room and/or Person (User) instead of a specific device. Both set = AND
+     * (only the satellite that is both in that room AND owned by that Person), not OR.
+     */
+    roomId: string;
+    /** 0 = not set */
+    userId: number;
+}
+export interface Room {
+    roomId: string;
+    displayName: string;
+}
+export interface GetRoomsResponse {
+    rooms: Room[];
+}
+/**
+ * GroupSatellite ist eine schlanke DTO-Projektion (device_id/display_name/room_id),
+ * bewusst nicht die volle Satellite-Message: die trägt Live-Verbindungsstatus, den
+ * GetGroups nicht braucht und der Server nicht ohne live verbundene Satelliten
+ * befüllen kann. Analog zu Room{room_id, display_name} vor #56/hannah-proto#7.
+ */
+export interface GroupSatellite {
+    deviceId: string;
+    /** "" falls nicht provisioniert */
+    displayName: string;
+    /** "" falls unzugewiesen — Anzeige-Kontext fürs Admin-UI */
+    roomId: string;
+}
+export interface Group {
+    groupId: string;
+    displayName: string;
+    /** #56/hannah-proto#7: war "repeated Room rooms" — Gruppen referenzieren Satelliten direkt statt Räume */
+    satellites: GroupSatellite[];
+}
+export interface GetGroupsResponse {
+    groups: Group[];
+}
+export interface CreateGroupRequest {
+    groupId: string;
+    displayName: string;
+}
+export interface UpdateGroupRequest {
+    groupId: string;
+    displayName: string;
+}
+export interface DeleteGroupRequest {
+    groupId: string;
+}
+export interface SetGroupSatellitesRequest {
+    groupId: string;
+    deviceIds: string[];
+}
+export interface Trigger {
+    /** client-assigned slug, e.g. "aussentuer_abend" */
+    id: string;
+    /** JSON condition object or list (OR'd), see trigger_engine.py */
+    whenJson: string;
+    /** JSON condition object, "" = none */
+    cancelWhenJson: string;
+    /** JSON list of response rules, "" = none */
+    onResponseJson: string;
+    /** legacy single announcement, "" once actions_json is used */
+    say: string;
+    ask: string;
+    rephrase: boolean;
+    /** was "room" (hannah-proto#5) */
+    target: string;
+    cooldown: number;
+    /** duration string e.g. "5h"/"30m"/"90s", "" = none */
+    delay: string;
+    /** JSON list[{say,target} | {set_state:{id,value}}], "" = none (falls back to say) */
+    actionsJson: string;
+}
+export interface GetTriggersResponse {
+    triggers: Trigger[];
+}
+export interface CreateTriggerRequest {
+    id: string;
+    whenJson: string;
+    cancelWhenJson: string;
+    onResponseJson: string;
+    say: string;
+    ask: string;
+    rephrase: boolean;
+    /** was "room" (hannah-proto#5) */
+    target: string;
+    cooldown: number;
+    delay: string;
+    actionsJson: string;
+}
+export interface UpdateTriggerRequest {
+    id: string;
+    whenJson: string;
+    cancelWhenJson: string;
+    onResponseJson: string;
+    say: string;
+    ask: string;
+    rephrase: boolean;
+    /** was "room" (hannah-proto#5) */
+    target: string;
+    cooldown: number;
+    delay: string;
+    actionsJson: string;
+}
+export interface DeleteTriggerRequest {
+    id: string;
+}
+export interface Alarm {
+    id: number;
+    satelliteId: string;
+    /** "HH:MM" */
+    time: string;
+    /** 0=Mo..6=So; leer = One-off */
+    weekdays: number[];
+    /** ISO-Daten, aus einer wiederkehrenden Serie ausgeschlossen */
+    skipDates: string[];
+    /** ISO-Datum; nur relevant wenn weekdays leer ist */
+    oneShotDate: string;
+    enabled: boolean;
+    label: string;
+    userId: number;
+}
+export interface GetAlarmsResponse {
+    alarms: Alarm[];
+}
+export interface CreateAlarmRequest {
+    satelliteId: string;
+    time: string;
+    weekdays: number[];
+    oneShotDate: string;
+    label: string;
+    userId: number;
+}
+export interface CreateAlarmResponse {
+    ok: boolean;
+    id: number;
+    message: string;
+}
+export interface UpdateAlarmRequest {
+    id: number;
+    satelliteId: string;
+    time: string;
+    weekdays: number[];
+    skipDates: string[];
+    oneShotDate: string;
+    enabled: boolean;
+    label: string;
+}
+export interface DeleteAlarmRequest {
+    id: number;
+}
+export interface Category {
+    id: number;
+    /** voller Punkt-Pfad, z.B. "ble.tags" */
+    name: string;
+    /** 0 = keine Eltern-Kategorie (Root) */
+    parentId: number;
+}
+export interface Setting {
+    id: number;
+    categoryId: number;
+    name: string;
+    /** JSON-encoded */
+    value: string;
+}
+export interface GetSettingsResponse {
+    categories: Category[];
+    settings: Setting[];
+}
+export interface SettingUpdate {
+    settingId: number;
+    /** JSON-encoded */
+    value: string;
+}
+export interface UpdateConfigRequest {
+    updates: SettingUpdate[];
+}
+export interface BleTag {
+    id: number;
+    macAddress: string;
+    label: string;
+    /** 0 = kein Owner zugeordnet */
+    userId: number;
+}
+export interface GetBleTagsResponse {
+    tags: BleTag[];
+}
+export interface CreateBleTagRequest {
+    macAddress: string;
+    label: string;
+    userId: number;
+}
+export interface CreateBleTagResponse {
+    ok: boolean;
+    id: number;
+    message: string;
+}
+export interface UpdateBleTagRequest {
+    id: number;
+    macAddress: string;
+    label: string;
+    userId: number;
+}
+export interface DeleteBleTagRequest {
+    id: number;
+}
+export interface PresenceSource {
+    id: number;
+    userId: number;
+    /** "iobroker_state" | "ble_tag" */
+    sourceType: string;
+    /** state_id (iobroker_state) bzw. BleTag-Referenz (ble_tag) */
+    reference: string;
+    /** 0.0-1.0 */
+    homeConfidence: number;
+    /** 0.0-1.0 */
+    awayConfidence: number;
+    enabled: boolean;
+}
+export interface GetPresenceSourcesResponse {
+    presenceSources: PresenceSource[];
+}
+export interface CreatePresenceSourceRequest {
+    userId: number;
+    sourceType: string;
+    reference: string;
+    homeConfidence: number;
+    awayConfidence: number;
+    enabled: boolean;
+}
+export interface CreatePresenceSourceResponse {
+    ok: boolean;
+    id: number;
+    message: string;
+}
+export interface UpdatePresenceSourceRequest {
+    id: number;
+    userId: number;
+    sourceType: string;
+    reference: string;
+    homeConfidence: number;
+    awayConfidence: number;
+    enabled: boolean;
+}
+export interface DeletePresenceSourceRequest {
+    id: number;
+}
+export interface Car {
+    id: number;
+    topicPrefix: string;
+    homeAddress: string;
+    ownerUserIds: number[];
+    name: string;
+}
+export interface GetCarsResponse {
+    cars: Car[];
+}
+export interface CreateCarRequest {
+    topicPrefix: string;
+    homeAddress: string;
+    ownerUserIds: number[];
+    name: string;
+}
+export interface CreateCarResponse {
+    ok: boolean;
+    id: number;
+    message: string;
+}
+export interface UpdateCarRequest {
+    id: number;
+    topicPrefix: string;
+    homeAddress: string;
+    ownerUserIds: number[];
+    name: string;
+}
+export interface DeleteCarRequest {
+    id: number;
+}
+export declare const SubmitTextRequest: MessageFns<SubmitTextRequest>;
+export declare const SubmitTextResponse: MessageFns<SubmitTextResponse>;
+export declare const SubmitVoiceRequest: MessageFns<SubmitVoiceRequest>;
+export declare const SubmitVoiceResponse: MessageFns<SubmitVoiceResponse>;
+export declare const AnnounceRequest: MessageFns<AnnounceRequest>;
+export declare const Room: MessageFns<Room>;
+export declare const GetRoomsResponse: MessageFns<GetRoomsResponse>;
+export declare const GroupSatellite: MessageFns<GroupSatellite>;
+export declare const Group: MessageFns<Group>;
+export declare const GetGroupsResponse: MessageFns<GetGroupsResponse>;
+export declare const CreateGroupRequest: MessageFns<CreateGroupRequest>;
+export declare const UpdateGroupRequest: MessageFns<UpdateGroupRequest>;
+export declare const DeleteGroupRequest: MessageFns<DeleteGroupRequest>;
+export declare const SetGroupSatellitesRequest: MessageFns<SetGroupSatellitesRequest>;
+export declare const Trigger: MessageFns<Trigger>;
+export declare const GetTriggersResponse: MessageFns<GetTriggersResponse>;
+export declare const CreateTriggerRequest: MessageFns<CreateTriggerRequest>;
+export declare const UpdateTriggerRequest: MessageFns<UpdateTriggerRequest>;
+export declare const DeleteTriggerRequest: MessageFns<DeleteTriggerRequest>;
+export declare const Alarm: MessageFns<Alarm>;
+export declare const GetAlarmsResponse: MessageFns<GetAlarmsResponse>;
+export declare const CreateAlarmRequest: MessageFns<CreateAlarmRequest>;
+export declare const CreateAlarmResponse: MessageFns<CreateAlarmResponse>;
+export declare const UpdateAlarmRequest: MessageFns<UpdateAlarmRequest>;
+export declare const DeleteAlarmRequest: MessageFns<DeleteAlarmRequest>;
+export declare const Category: MessageFns<Category>;
+export declare const Setting: MessageFns<Setting>;
+export declare const GetSettingsResponse: MessageFns<GetSettingsResponse>;
+export declare const SettingUpdate: MessageFns<SettingUpdate>;
+export declare const UpdateConfigRequest: MessageFns<UpdateConfigRequest>;
+export declare const BleTag: MessageFns<BleTag>;
+export declare const GetBleTagsResponse: MessageFns<GetBleTagsResponse>;
+export declare const CreateBleTagRequest: MessageFns<CreateBleTagRequest>;
+export declare const CreateBleTagResponse: MessageFns<CreateBleTagResponse>;
+export declare const UpdateBleTagRequest: MessageFns<UpdateBleTagRequest>;
+export declare const DeleteBleTagRequest: MessageFns<DeleteBleTagRequest>;
+export declare const PresenceSource: MessageFns<PresenceSource>;
+export declare const GetPresenceSourcesResponse: MessageFns<GetPresenceSourcesResponse>;
+export declare const CreatePresenceSourceRequest: MessageFns<CreatePresenceSourceRequest>;
+export declare const CreatePresenceSourceResponse: MessageFns<CreatePresenceSourceResponse>;
+export declare const UpdatePresenceSourceRequest: MessageFns<UpdatePresenceSourceRequest>;
+export declare const DeletePresenceSourceRequest: MessageFns<DeletePresenceSourceRequest>;
+export declare const Car: MessageFns<Car>;
+export declare const GetCarsResponse: MessageFns<GetCarsResponse>;
+export declare const CreateCarRequest: MessageFns<CreateCarRequest>;
+export declare const CreateCarResponse: MessageFns<CreateCarResponse>;
+export declare const UpdateCarRequest: MessageFns<UpdateCarRequest>;
+export declare const DeleteCarRequest: MessageFns<DeleteCarRequest>;
+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 {};