@sylphx/sdk 0.13.9 → 0.15.0

package/dist/health/index.d.ts

@@ -455,8 +455,34 @@ interface HealthScore {
      * `health.signal.factor`.
      */
     readonly signalFactors?: Record<string, number>;
+    /**
+     * Non-secret release/deployment identity for live-build verification.
+     *
+     * Additive to the ADR-111 wire shape: probe sidecars ignore it, while
+     * operators and deployment monitors can prove which immutable build is
+     * answering `/healthz` without needing access to the deploy control plane.
+     */
+    readonly release?: HealthRelease;
     readonly lastTickAt: string;
 }
+/**
+ * Public, non-secret release identity attached to a health response.
+ *
+ * These fields intentionally mirror platform-injected runtime identity
+ * variables (`SYLPHX_*`) instead of arbitrary metadata. Health endpoints are
+ * commonly public, so this surface must stay provenance-focused and must not
+ * become a general key/value bag that can accidentally expose secrets.
+ */
+interface HealthRelease {
+    readonly version?: string | null;
+    readonly commitSha?: string | null;
+    readonly imageDigest?: string | null;
+    readonly imageTag?: string | null;
+    readonly deploymentId?: string | null;
+    readonly buildId?: string | null;
+    readonly replicaId?: string | null;
+}
+type HealthReleaseInput = HealthRelease | (() => HealthRelease | null | undefined);
 /**
  * Wire format the sidecar's `app-poll.ts::parseAppHealthBody` consumes.
  *
@@ -543,6 +569,14 @@ interface SylphxHealthOptions {
      * adapter; the interface is public and stable so any backend works.
      */
     readonly history?: HistoryOption;
+    /**
+     * Optional non-secret release identity to include in every HealthSnapshot.
+     *
+     * Accepts a static object or a synchronous resolver. Resolver failures are
+     * swallowed: release metadata must never block the load-bearing health
+     * response.
+     */
+    readonly release?: HealthReleaseInput;
 }
 
 /**
@@ -1354,4 +1388,4 @@ interface SylphxHealth extends HealthEvaluator {
 }
 declare function sylphxHealth(opts?: SylphxHealthOptions): SylphxHealth;
 
-export { type AsyncSignal, BAGGAGE_KEY_CAUSE, BAGGAGE_KEY_CHAIN, type CausalityHandle, type CausalityOption, type CausalityOptions, DEFAULT_CAUSE_THRESHOLD, DEFAULT_HISTORY_CAPACITY, type DependencyPingOptions, type ErrorRateOptions, type ErrorRateSignalHandle, type EventLoopLagOptions, type ExpressHealthMiddleware, type ExpressNextLike, type ExpressRequestLike, type ExpressResponseLike, type FastifyHealthPlugin, type FastifyInstanceLike, type FastifyReplyLike, type FetchHealthHandler, GENESIS_PREV_HASH, HealthError, type HealthEvaluator, type HealthScore, type HealthSnapshot, type HistoryEntry, type HistoryOption, type HistoryQuery, type HistoryRecorder, type HistoryRecorderOptions, type HistoryStore, type HonoContextLike, type HonoHealthMiddleware, type HonoNextLike, type InMemoryHistoryStoreOptions, MAX_CHAIN_LENGTH, type MemoryPressureOptions, EVENT_NAMES as OTEL_EVENT_NAMES, METRIC_NAMES as OTEL_METRIC_NAMES, SPAN_ATTRIBUTES as OTEL_SPAN_ATTRIBUTES, type OtelEmitter, type OtelEmitterOptions, type OtelOption, type OtelStaticAttributes, type PingSignalOptions, type QueueDepthOptions, type ScoringStrategy, type Signal, type SignalBase, type SignalReading, type SylphxHealth, type SylphxHealthOptions, type SyncSignal, type UnixSocketServerHandle, type UnixSocketServerOptions, type UpstreamCause, type VerificationResult, type WithHealthOptions, canonicalizeSignals, createCausalityHandle, createHistoryRecorder, createInMemoryHistoryStore, createNodeHandler, createOtelEmitter, createWebHandler, databaseSignal, defaultScoringStrategy, errorRateSignal, eventLoopLagSignal, memoryPressureSignal, pingSignal, queueDepthSignal, redisSignal, sylphxHealth, verifyChain, weightedProduct, withHealth };
+export { type AsyncSignal, BAGGAGE_KEY_CAUSE, BAGGAGE_KEY_CHAIN, type CausalityHandle, type CausalityOption, type CausalityOptions, DEFAULT_CAUSE_THRESHOLD, DEFAULT_HISTORY_CAPACITY, type DependencyPingOptions, type ErrorRateOptions, type ErrorRateSignalHandle, type EventLoopLagOptions, type ExpressHealthMiddleware, type ExpressNextLike, type ExpressRequestLike, type ExpressResponseLike, type FastifyHealthPlugin, type FastifyInstanceLike, type FastifyReplyLike, type FetchHealthHandler, GENESIS_PREV_HASH, HealthError, type HealthEvaluator, type HealthRelease, type HealthReleaseInput, type HealthScore, type HealthSnapshot, type HistoryEntry, type HistoryOption, type HistoryQuery, type HistoryRecorder, type HistoryRecorderOptions, type HistoryStore, type HonoContextLike, type HonoHealthMiddleware, type HonoNextLike, type InMemoryHistoryStoreOptions, MAX_CHAIN_LENGTH, type MemoryPressureOptions, EVENT_NAMES as OTEL_EVENT_NAMES, METRIC_NAMES as OTEL_METRIC_NAMES, SPAN_ATTRIBUTES as OTEL_SPAN_ATTRIBUTES, type OtelEmitter, type OtelEmitterOptions, type OtelOption, type OtelStaticAttributes, type PingSignalOptions, type QueueDepthOptions, type ScoringStrategy, type Signal, type SignalBase, type SignalReading, type SylphxHealth, type SylphxHealthOptions, type SyncSignal, type UnixSocketServerHandle, type UnixSocketServerOptions, type UpstreamCause, type VerificationResult, type WithHealthOptions, canonicalizeSignals, createCausalityHandle, createHistoryRecorder, createInMemoryHistoryStore, createNodeHandler, createOtelEmitter, createWebHandler, databaseSignal, defaultScoringStrategy, errorRateSignal, eventLoopLagSignal, memoryPressureSignal, pingSignal, queueDepthSignal, redisSignal, sylphxHealth, verifyChain, weightedProduct, withHealth };

package/dist/health/index.mjs

@@ -1207,6 +1207,35 @@ function clampHealthFactor(value) {
   if (value > 1) return 1;
   return value;
 }
+var HEALTH_RELEASE_KEYS = [
+  "version",
+  "commitSha",
+  "imageDigest",
+  "imageTag",
+  "deploymentId",
+  "buildId",
+  "replicaId"
+];
+function resolveHealthRelease(input) {
+  if (!input) return void 0;
+  try {
+    const value = typeof input === "function" ? input() : input;
+    if (!value) return void 0;
+    const release = {};
+    for (const key of HEALTH_RELEASE_KEYS) {
+      const raw = value[key];
+      if (raw === null) {
+        release[key] = null;
+      } else if (typeof raw === "string") {
+        const trimmed = raw.trim();
+        if (trimmed.length > 0) release[key] = trimmed;
+      }
+    }
+    return Object.keys(release).length > 0 ? release : void 0;
+  } catch {
+    return void 0;
+  }
+}
 function sylphxHealth(opts = {}) {
   const signals = opts.signals && opts.signals.length > 0 ? [...opts.signals] : [eventLoopLagSignal({ degradedMs: 5e3, deadMs: 3e4, weight: 1 })];
   const scoringStrategy = opts.scoringStrategy ?? defaultScoringStrategy();
@@ -1234,10 +1263,12 @@ function sylphxHealth(opts = {}) {
       signalsMap[signal.name] = reading.value;
       signalFactors[signal.name] = reading.unknown === true ? 1 : clampHealthFactor(reading.healthFactor);
     }
+    const release = resolveHealthRelease(opts.release);
     const result = {
       score,
       signals: signalsMap,
       signalFactors,
+      ...release ? { release } : {},
       lastTickAt: now().toISOString()
     };
     lastScore = result;