@intuitionrobotics/thunderstorm 2.0.9 → 2.0.11

package/dist/app-backend/api/v1/utils/health/get.d.ts

@@ -0,0 +1,13 @@
+import { ApiResponse, ServerApi } from "../../../../modules/server/server-api.js";
+import { type ApiTypeBinder } from "../../../../../shared/types.js";
+import { type ExpressRequest } from "../../../../utils/types.js";
+import { type HealthReport } from "../../../../../shared/health.js";
+export declare class ServerApi_Health_Class extends ServerApi<ApiTypeBinder<"health", HealthReport, void, {}>> {
+    private appVersion?;
+    constructor();
+    setVersion(version: string): this;
+    protected process(_request: ExpressRequest, response: ApiResponse): Promise<HealthReport>;
+}
+export declare const ServerApi_Health: ServerApi_Health_Class;
+export default ServerApi_Health;
+//# sourceMappingURL=get.d.ts.map

package/dist/app-backend/api/v1/utils/health/get.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../../../../src/main/app-backend/api/v1/utils/health/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,0CAA0C,CAAC;AAChF,OAAO,EAAC,KAAK,aAAa,EAAa,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAC,KAAK,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAG/D,OAAO,EAEH,KAAK,YAAY,EAIpB,MAAM,iCAAiC,CAAC;AAmBzC,qBAAa,sBACT,SAAQ,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAElE,OAAO,CAAC,UAAU,CAAC,CAAS;;IAO5B,UAAU,CAAC,OAAO,EAAE,MAAM;cAKV,OAAO,CAAC,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;CAoClG;AAED,eAAO,MAAM,gBAAgB,wBAA+B,CAAC;AAC7D,eAAe,gBAAgB,CAAC"}

package/dist/app-backend/api/v1/utils/health/get.js

@@ -0,0 +1,67 @@
+import { ApiResponse, ServerApi } from "../../../../modules/server/server-api.js";
+import { HttpMethod } from "../../../../../shared/types.js";
+import {} from "../../../../utils/types.js";
+import { Storm } from "../../../../core/Storm.js";
+import { currentTimeMillies } from "@intuitionrobotics/ts-common";
+import { isHealthCheckContributor } from "../../../../../shared/health.js";
+const statusRank = { pass: 0, warn: 1, fail: 2 };
+const worse = (a, b) => (statusRank[a] >= statusRank[b] ? a : b);
+// Smart, transparent health endpoint.
+//
+// TRANSPARENT — the framework never injects this for you. Mount it explicitly
+// from your routes file (one visible line), choosing your own path:
+//
+//   import {ServerApi_Health} from "@intuitionrobotics/thunderstorm/backend";
+//   v1.get("/health", ServerApi_Health.handler);                  // or
+//   v1.get("/health", ServerApi_Health.setVersion(version).handler);
+//
+// SMART — it enumerates every loaded Storm module and reports env / node /
+// uptime. Any module implementing HealthCheckContributor (getHealth())
+// contributes real subsystem health; the overall status is the worst of them,
+// and a "fail" is reflected as HTTP 503 so load balancers / uptime probes can
+// gate on it.
+export class ServerApi_Health_Class extends ServerApi {
+    appVersion;
+    constructor() {
+        super(HttpMethod.GET, "health");
+        this.dontPrintResponse();
+    }
+    setVersion(version) {
+        this.appVersion = version;
+        return this;
+    }
+    async process(_request, response) {
+        const storm = Storm.getInstance();
+        const modules = storm ? storm.filterModules(() => true) : [];
+        const moduleHealth = await Promise.all(modules.map(async (module) => {
+            const name = module.getName();
+            if (!isHealthCheckContributor(module))
+                return { name, status: "pass" };
+            try {
+                const contribution = await module.getHealth();
+                return { name, status: contribution.status, detail: contribution.detail };
+            }
+            catch (e) {
+                return { name, status: "fail", detail: e?.message ?? "getHealth() threw" };
+            }
+        }));
+        const status = moduleHealth.reduce((worst, m) => worse(worst, m.status), "pass");
+        const report = {
+            status,
+            env: storm?.getEnvironment() ?? "unknown",
+            node: process.version,
+            uptimeSec: Math.floor(process.uptime()),
+            timestamp: currentTimeMillies(),
+            modules: moduleHealth,
+            version: this.appVersion
+        };
+        // Consuming the response here with 503 is safe: ServerApi.call() checks
+        // isConsumed() before it would otherwise send the 200 itself.
+        if (status === "fail")
+            response.json(503, report);
+        return report;
+    }
+}
+export const ServerApi_Health = new ServerApi_Health_Class();
+export default ServerApi_Health;
+//# sourceMappingURL=get.js.map

package/dist/app-backend/api/v1/utils/health/get.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../../../../src/main/app-backend/api/v1/utils/health/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,0CAA0C,CAAC;AAChF,OAAO,EAAqB,UAAU,EAAC,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAC,KAAK,EAAC,MAAM,2BAA2B,CAAC;AAChD,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAIH,wBAAwB,EAE3B,MAAM,iCAAiC,CAAC;AAEzC,MAAM,UAAU,GAAoC,EAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAC,CAAC;AAChF,MAAM,KAAK,GAAG,CAAC,CAAe,EAAE,CAAe,EAAgB,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3G,sCAAsC;AACtC,EAAE;AACF,8EAA8E;AAC9E,oEAAoE;AACpE,EAAE;AACF,8EAA8E;AAC9E,wEAAwE;AACxE,qEAAqE;AACrE,EAAE;AACF,2EAA2E;AAC3E,uEAAuE;AACvE,8EAA8E;AAC9E,8EAA8E;AAC9E,cAAc;AACd,MAAM,OAAO,sBACT,SAAQ,SAA0D;IAE1D,UAAU,CAAU;IAE5B;QACI,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAED,UAAU,CAAC,OAAe;QACtB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;QAC1B,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,QAAwB,EAAE,QAAqB;QACnE,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAA4B,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAExF,MAAM,YAAY,GAAmB,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAyB,EAAE;YACvG,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC;gBACjC,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC;YAElC,IAAI,CAAC;gBACD,MAAM,YAAY,GAAuB,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;gBAClE,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,EAAC,CAAC;YAC5E,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBACd,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,IAAI,mBAAmB,EAAC,CAAC;YAC7E,CAAC;QACL,CAAC,CAAC,CAAC,CAAC;QAEJ,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAe,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;QAE/F,MAAM,MAAM,GAAiB;YACzB,MAAM;YACN,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,SAAS;YACzC,IAAI,EAAE,OAAO,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACvC,SAAS,EAAE,kBAAkB,EAAE;YAC/B,OAAO,EAAE,YAAY;YACrB,OAAO,EAAE,IAAI,CAAC,UAAU;SAC3B,CAAC;QAEF,wEAAwE;QACxE,8DAA8D;QAC9D,IAAI,MAAM,KAAK,MAAM;YACjB,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAE/B,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,sBAAsB,EAAE,CAAC;AAC7D,eAAe,gBAAgB,CAAC"}

package/dist/backend.d.ts

@@ -16,4 +16,6 @@ export * from "./app-backend/utils/LogClient_File.js";
 export * from "./app-backend/utils/file.js";
 export * from "./app-backend/exceptions.js";
 export * from "./app-backend/core/Storm.js";
+export * from "./app-backend/api/v1/utils/health/get.js";
+export * from "./shared/health.js";
 //# sourceMappingURL=backend.d.ts.map

package/dist/backend.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../src/main/backend.ts"],"names":[],"mappings":"AAqBA,cAAc,kDAAkD,CAAC;AACjE,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mDAAmD,CAAC;AAClE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAI3D,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAC7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../src/main/backend.ts"],"names":[],"mappings":"AAqBA,cAAc,kDAAkD,CAAC;AACjE,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mDAAmD,CAAC;AAClE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAI3D,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAC7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAE5C,cAAc,0CAA0C,CAAC;AACzD,cAAc,oBAAoB,CAAC"}

package/dist/backend.js

@@ -39,4 +39,7 @@ export * from "./app-backend/utils/LogClient_File.js";
 export * from "./app-backend/utils/file.js";
 export * from "./app-backend/exceptions.js";
 export * from "./app-backend/core/Storm.js";
+// Smart, transparent health endpoint — mount explicitly: `v1.get("/health", ServerApi_Health.handler)`.
+export * from "./app-backend/api/v1/utils/health/get.js";
+export * from "./shared/health.js";
 //# sourceMappingURL=backend.js.map

package/dist/backend.js.map

@@ -1 +1 @@
-{"version":3,"file":"backend.js","sourceRoot":"","sources":["../src/main/backend.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,cAAc,kDAAkD,CAAC;AACjE,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mDAAmD,CAAC;AAClE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAC3D,uDAAuD;AACvD,kFAAkF;AAClF,gCAAgC;AAChC,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAC7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"backend.js","sourceRoot":"","sources":["../src/main/backend.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,cAAc,kDAAkD,CAAC;AACjE,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mDAAmD,CAAC;AAClE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAC3D,uDAAuD;AACvD,kFAAkF;AAClF,gCAAgC;AAChC,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAC7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,wGAAwG;AACxG,cAAc,0CAA0C,CAAC;AACzD,cAAc,oBAAoB,CAAC"}

package/dist/shared/health.d.ts

@@ -0,0 +1,22 @@
+export type HealthStatus = "pass" | "warn" | "fail";
+export type HealthContribution = {
+    status: HealthStatus;
+    detail?: string;
+};
+export type ModuleHealth = HealthContribution & {
+    name: string;
+};
+export type HealthReport = {
+    status: HealthStatus;
+    env: string;
+    node: string;
+    uptimeSec: number;
+    timestamp: number;
+    modules: ModuleHealth[];
+    version?: string;
+};
+export interface HealthCheckContributor {
+    getHealth(): HealthContribution | Promise<HealthContribution>;
+}
+export declare const isHealthCheckContributor: (module: any) => module is HealthCheckContributor;
+//# sourceMappingURL=health.d.ts.map

package/dist/shared/health.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../src/main/shared/health.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAIpD,MAAM,MAAM,kBAAkB,GAAG;IAC7B,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,MAAM,EAAE,YAAY,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACnC,SAAS,IAAI,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjE;AAED,eAAO,MAAM,wBAAwB,GAAI,QAAQ,GAAG,KAAG,MAAM,IAAI,sBACX,CAAC"}

package/dist/shared/health.js

@@ -0,0 +1,9 @@
+// Health-check contract shared by the backend `/health` endpoint.
+//
+// A backend Module opts INTO contributing real subsystem health by
+// implementing HealthCheckContributor. There is no hidden registration — a
+// module shows up as a health contributor only because its own code declares
+// `getHealth()`. Modules that don't implement it are still listed (as a
+// loaded "pass"), so the report always reflects exactly what is running.
+export const isHealthCheckContributor = (module) => !!module && typeof module.getHealth === "function";
+//# sourceMappingURL=health.js.map

package/dist/shared/health.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.js","sourceRoot":"","sources":["../../src/main/shared/health.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,EAAE;AACF,mEAAmE;AACnE,2EAA2E;AAC3E,6EAA6E;AAC7E,wEAAwE;AACxE,yEAAyE;AA6BzE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,MAAW,EAAoC,EAAE,CACtF,CAAC,CAAC,MAAM,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,CAAC"}