@m1kad0/hannah-proto 3.0.0 → 3.1.0

package/dist/compat_interceptor.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Per-message compatibility check (hannah-proto#9, hannah#217).
+ *
+ * DRAFT / template — not wired into anything consuming it yet, needs
+ * review before use. See python/hannah_proto/compat_interceptor.py for the
+ * full design rationale (kept there as the canonical explanation, not
+ * repeated here to avoid drift between copies).
+ *
+ * REQUIRED_COMPAT_VERSIONS comes from generated `./compat_versions`
+ * (scripts/gen-compat-versions.js, run by generate.sh) rather than from
+ * runtime reflection on the generated message types — ts-proto is
+ * configured without `outputSchema`, so there is no descriptor/options
+ * data available on the generated types to read compat_version off of
+ * directly (unlike the Python/Go versions). See gen-compat-versions.js's
+ * header comment for what's unverified there.
+ */
+import type { Interceptor } from "@grpc/grpc-js";
+import { DEFAULT_COMPAT_VERSION } from "./compat_versions";
+export declare const COMPAT_VERSION_METADATA_KEY = "x-compat-version";
+export { DEFAULT_COMPAT_VERSION };
+/**
+ * grpc-js client interceptor: attaches x-compat-version metadata to every
+ * outgoing call, derived from the RPC method being invoked — so the server
+ * only has to reject calls genuinely affected by a breaking change, not
+ * every call after any unrelated schema change anywhere (see
+ * hannah-proto#9, the SetGroupRooms incident).
+ */
+export declare const compatVersionInterceptor: Interceptor;

package/dist/compat_interceptor.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compatVersionInterceptor = exports.DEFAULT_COMPAT_VERSION = exports.COMPAT_VERSION_METADATA_KEY = void 0;
+const grpc_js_1 = require("@grpc/grpc-js");
+const compat_versions_1 = require("./compat_versions");
+Object.defineProperty(exports, "DEFAULT_COMPAT_VERSION", { enumerable: true, get: function () { return compat_versions_1.DEFAULT_COMPAT_VERSION; } });
+exports.COMPAT_VERSION_METADATA_KEY = "x-compat-version";
+/** `methodName` is the bare RPC name (e.g. "SubmitText"), matching the keys
+ * gen-compat-versions.js writes into REQUIRED_COMPAT_VERSIONS. */
+function getRequiredCompatVersion(methodName) {
+    return compat_versions_1.REQUIRED_COMPAT_VERSIONS[methodName] ?? compat_versions_1.DEFAULT_COMPAT_VERSION;
+}
+/**
+ * grpc-js client interceptor: attaches x-compat-version metadata to every
+ * outgoing call, derived from the RPC method being invoked — so the server
+ * only has to reject calls genuinely affected by a breaking change, not
+ * every call after any unrelated schema change anywhere (see
+ * hannah-proto#9, the SetGroupRooms incident).
+ */
+const compatVersionInterceptor = (options, nextCall) => {
+    const methodName = options.method_definition.path.split("/").pop() ?? "";
+    const required = getRequiredCompatVersion(methodName);
+    return new grpc_js_1.InterceptingCall(nextCall(options), {
+        start(metadata, listener, next) {
+            metadata.set(exports.COMPAT_VERSION_METADATA_KEY, String(required));
+            next(metadata, listener);
+        },
+    });
+};
+exports.compatVersionInterceptor = compatVersionInterceptor;

package/dist/compat_versions.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_COMPAT_VERSION = 1;
+export declare const REQUIRED_COMPAT_VERSIONS: Record<string, number>;

package/dist/compat_versions.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUIRED_COMPAT_VERSIONS = exports.DEFAULT_COMPAT_VERSION = void 0;
+// Generated by scripts/gen-compat-versions.js — do not edit by hand.
+exports.DEFAULT_COMPAT_VERSION = 1;
+exports.REQUIRED_COMPAT_VERSIONS = {
+    "GetUsers": 1,
+    "GetUser": 1,
+    "LinkAccount": 1,
+    "UnlinkAccount": 1,
+    "SetTrustLevel": 1,
+    "SetSystemMessages": 1,
+    "SetAutomation": 1,
+    "Login": 1,
+    "CreateUser": 1,
+    "UpdateUser": 1,
+    "DeleteUser": 1,
+    "GetResidents": 1,
+    "GetDevices": 1,
+    "ControlDevice": 1,
+    "SubmitText": 1,
+    "SubmitVoice": 1,
+    "Announce": 1,
+    "Notify": 1,
+    "GetSatellites": 1,
+    "SetSatelliteRoom": 1,
+    "SetSatelliteDisplayName": 1,
+    "SetSatelliteOwner": 1,
+    "SetSatelliteSmalltalkFollowup": 1,
+    "DeleteSatellite": 1,
+    "GetRooms": 1,
+    "GetGroups": 1,
+    "CreateGroup": 1,
+    "UpdateGroup": 1,
+    "DeleteGroup": 1,
+    "SetGroupSatellites": 1,
+    "GetTriggers": 1,
+    "CreateTrigger": 1,
+    "UpdateTrigger": 1,
+    "DeleteTrigger": 1,
+    "GetAlarms": 1,
+    "CreateAlarm": 1,
+    "UpdateAlarm": 1,
+    "DeleteAlarm": 1,
+    "GetSettings": 1,
+    "UpdateConfig": 1,
+    "GetBleTags": 1,
+    "CreateBleTag": 1,
+    "UpdateBleTag": 1,
+    "DeleteBleTag": 1,
+    "GetCars": 1,
+    "CreateCar": 1,
+    "UpdateCar": 1,
+    "DeleteCar": 1,
+    "GetCarState": 1,
+    "GetAllCarStates": 1,
+    "SubscribeEvents": 1,
+    "TriggerFirmwareUpdate": 1,
+    "TriggerSatelliteRestart": 1,
+    "RequestSatelliteCapture": 1,
+    "ReleaseSatelliteCapture": 1,
+    "StreamSatelliteAudio": 1,
+    "TriggerPlink": 1,
+    "RegisterProxy": 1,
+    "SubmitSatelliteAudio": 1,
+    "NotifySatelliteRegistered": 1,
+    "NotifySatelliteGone": 1,
+    "ProvisionSatellite": 1,
+    "EnrollVoiceprint": 1,
+    "TimerConnect": 1,
+    "GetTimers": 1,
+    "DeleteTimer": 1,
+    "AgentConnect": 1,
+    "AutomationConnect": 1
+};

package/dist/index.d.ts

@@ -2,6 +2,8 @@ export * from './version';
 export * as agent from './agent';
 export * as automation from './automation';
 export * as car_state from './car_state';
+export * as compat_interceptor from './compat_interceptor';
+export * as compat_versions from './compat_versions';
 export * as control from './control';
 export * as device_control_menu from './device_control_menu';
 export * as event_stream from './event_stream';

package/dist/index.js

@@ -36,11 +36,13 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.weather = exports.wakeword_capture = exports.user_registry = exports.timer_service = exports.timer_admin = exports.speaker_enrollment = exports.shared = exports.satellite_proxy = exports.satellite_provisioning = exports.satellite = exports.options = exports.hannah = exports.event_stream = exports.device_control_menu = exports.control = exports.car_state = exports.automation = exports.agent = void 0;
+exports.weather = exports.wakeword_capture = exports.user_registry = exports.timer_service = exports.timer_admin = exports.speaker_enrollment = exports.shared = exports.satellite_proxy = exports.satellite_provisioning = exports.satellite = exports.options = exports.hannah = exports.event_stream = exports.device_control_menu = exports.control = exports.compat_versions = exports.compat_interceptor = exports.car_state = exports.automation = exports.agent = void 0;
 __exportStar(require("./version"), exports);
 exports.agent = __importStar(require("./agent"));
 exports.automation = __importStar(require("./automation"));
 exports.car_state = __importStar(require("./car_state"));
+exports.compat_interceptor = __importStar(require("./compat_interceptor"));
+exports.compat_versions = __importStar(require("./compat_versions"));
 exports.control = __importStar(require("./control"));
 exports.device_control_menu = __importStar(require("./device_control_menu"));
 exports.event_stream = __importStar(require("./event_stream"));

package/package.json

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