@firebreak/vitals 2.0.1 → 2.2.0

package/README.md

@@ -321,7 +321,37 @@ createHealthcheckHandler({
 });
 ```
 
-Metadata values can be `string`, `number`, or `boolean`. Keys `status`, `timestamp`, and `checks` are reserved — passing them throws at handler creation time.
+Metadata values can be `string`, `number`, or `boolean`. Keys `status`, `timestamp`, `checks`, and `cachedAt` are reserved -- passing them throws at handler creation time.
+
+#### `shallowMetadata`
+
+By default, shallow responses include all `metadata` fields. Use `shallowMetadata` to override what appears in shallow responses while keeping `metadata` for deep responses:
+
+```typescript
+createHealthcheckHandler({
+  registry,
+  metadata: {
+    build: 'stg-45d76e5',
+    buildTimestamp: '2025-02-25T19:41:56Z',
+    region: 'us-east-1',
+  },
+  // Shallow responses only include status + timestamp (no build info)
+  shallowMetadata: {},
+});
+```
+
+You can also include a subset of fields:
+
+```typescript
+createHealthcheckHandler({
+  registry,
+  metadata: { build: 'stg-45d76e5', region: 'us-east-1', version: '1.0.0' },
+  // Shallow responses include only version
+  shallowMetadata: { version: '1.0.0' },
+});
+```
+
+When `shallowMetadata` is omitted, shallow responses fall back to using `metadata` (existing behavior).
 
 ### Utilities
 

package/dist/{handler-TZOgZvY7.d.cts → handler-C3eTDuSQ.d.cts}

@@ -5,6 +5,7 @@ interface HealthcheckHandlerOptions {
     registry: HealthcheckRegistry;
     resolveDepth?: ResolveDepthFn;
     metadata?: Record<string, string | number | boolean>;
+    shallowMetadata?: Record<string, string | number | boolean>;
 }
 interface ShallowResponseJson {
     status: 'ok';

package/dist/{handler-BvjN4Ot9.d.ts → handler-DaFJivGK.d.ts}

@@ -5,6 +5,7 @@ interface HealthcheckHandlerOptions {
     registry: HealthcheckRegistry;
     resolveDepth?: ResolveDepthFn;
     metadata?: Record<string, string | number | boolean>;
+    shallowMetadata?: Record<string, string | number | boolean>;
 }
 interface ShallowResponseJson {
     status: 'ok';

package/dist/index.cjs

@@ -220,10 +220,12 @@ function extractToken(options) {
 // src/handler.ts
 var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks", "cachedAt"];
 function createHealthcheckHandler(options) {
-  const { registry, resolveDepth, metadata = {} } = options;
-  for (const key of Object.keys(metadata)) {
-    if (RESERVED_METADATA_KEYS.includes(key)) {
-      throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+  const { registry, resolveDepth, metadata = {}, shallowMetadata } = options;
+  for (const bag of [metadata, shallowMetadata ?? {}]) {
+    for (const key of Object.keys(bag)) {
+      if (RESERVED_METADATA_KEYS.includes(key)) {
+        throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+      }
     }
   }
   return async (req) => {
@@ -247,7 +249,7 @@ function createHealthcheckHandler(options) {
     const body = {
       status: "ok",
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      ...metadata
+      ...shallowMetadata ?? metadata
     };
     return { status: 200, body };
   };

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { H as HealthcheckResponseJson } from './core-Bee03bJm.cjs';
 export { A as AsyncCheckFn, C as CheckInput, a as CheckResult, b as HealthcheckRegistry, c as HealthcheckResponse, S as Status, d as StatusLabel, e as StatusValue, f as SyncCheckFn, h as httpStatusCode, s as statusFromString, g as statusToLabel, i as syncCheck, t as toJson } from './core-Bee03bJm.cjs';
-import { S as ShallowResponseJson } from './handler-TZOgZvY7.cjs';
-export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, R as ResolveDepthFn, c as createHealthcheckHandler } from './handler-TZOgZvY7.cjs';
+import { S as ShallowResponseJson } from './handler-C3eTDuSQ.cjs';
+export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, R as ResolveDepthFn, c as createHealthcheckHandler } from './handler-C3eTDuSQ.cjs';
 
 declare function verifyToken(provided: string, expected: string): boolean;
 declare function extractToken(options: {

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { H as HealthcheckResponseJson } from './core-Bee03bJm.js';
 export { A as AsyncCheckFn, C as CheckInput, a as CheckResult, b as HealthcheckRegistry, c as HealthcheckResponse, S as Status, d as StatusLabel, e as StatusValue, f as SyncCheckFn, h as httpStatusCode, s as statusFromString, g as statusToLabel, i as syncCheck, t as toJson } from './core-Bee03bJm.js';
-import { S as ShallowResponseJson } from './handler-BvjN4Ot9.js';
-export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, R as ResolveDepthFn, c as createHealthcheckHandler } from './handler-BvjN4Ot9.js';
+import { S as ShallowResponseJson } from './handler-DaFJivGK.js';
+export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, R as ResolveDepthFn, c as createHealthcheckHandler } from './handler-DaFJivGK.js';
 
 declare function verifyToken(provided: string, expected: string): boolean;
 declare function extractToken(options: {

package/dist/index.mjs

@@ -184,10 +184,12 @@ function extractToken(options) {
 // src/handler.ts
 var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks", "cachedAt"];
 function createHealthcheckHandler(options) {
-  const { registry, resolveDepth, metadata = {} } = options;
-  for (const key of Object.keys(metadata)) {
-    if (RESERVED_METADATA_KEYS.includes(key)) {
-      throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+  const { registry, resolveDepth, metadata = {}, shallowMetadata } = options;
+  for (const bag of [metadata, shallowMetadata ?? {}]) {
+    for (const key of Object.keys(bag)) {
+      if (RESERVED_METADATA_KEYS.includes(key)) {
+        throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+      }
     }
   }
   return async (req) => {
@@ -211,7 +213,7 @@ function createHealthcheckHandler(options) {
     const body = {
       status: "ok",
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      ...metadata
+      ...shallowMetadata ?? metadata
     };
     return { status: 200, body };
   };

package/dist/integrations/express.cjs

@@ -61,10 +61,12 @@ function httpStatusCode(status) {
 // src/handler.ts
 var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks", "cachedAt"];
 function createHealthcheckHandler(options) {
-  const { registry, resolveDepth, metadata = {} } = options;
-  for (const key of Object.keys(metadata)) {
-    if (RESERVED_METADATA_KEYS.includes(key)) {
-      throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+  const { registry, resolveDepth, metadata = {}, shallowMetadata } = options;
+  for (const bag of [metadata, shallowMetadata ?? {}]) {
+    for (const key of Object.keys(bag)) {
+      if (RESERVED_METADATA_KEYS.includes(key)) {
+        throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+      }
     }
   }
   return async (req) => {
@@ -88,7 +90,7 @@ function createHealthcheckHandler(options) {
     const body = {
       status: "ok",
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      ...metadata
+      ...shallowMetadata ?? metadata
     };
     return { status: 200, body };
   };

package/dist/integrations/express.d.cts

@@ -1,5 +1,5 @@
 import { RequestHandler } from 'express';
-import { H as HealthcheckHandlerOptions } from '../handler-TZOgZvY7.cjs';
+import { H as HealthcheckHandlerOptions } from '../handler-C3eTDuSQ.cjs';
 import '../core-Bee03bJm.cjs';
 
 type HealthcheckMiddlewareOptions = HealthcheckHandlerOptions;

package/dist/integrations/express.d.ts

@@ -1,5 +1,5 @@
 import { RequestHandler } from 'express';
-import { H as HealthcheckHandlerOptions } from '../handler-BvjN4Ot9.js';
+import { H as HealthcheckHandlerOptions } from '../handler-DaFJivGK.js';
 import '../core-Bee03bJm.js';
 
 type HealthcheckMiddlewareOptions = HealthcheckHandlerOptions;

package/dist/integrations/express.mjs

@@ -35,10 +35,12 @@ function httpStatusCode(status) {
 // src/handler.ts
 var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks", "cachedAt"];
 function createHealthcheckHandler(options) {
-  const { registry, resolveDepth, metadata = {} } = options;
-  for (const key of Object.keys(metadata)) {
-    if (RESERVED_METADATA_KEYS.includes(key)) {
-      throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+  const { registry, resolveDepth, metadata = {}, shallowMetadata } = options;
+  for (const bag of [metadata, shallowMetadata ?? {}]) {
+    for (const key of Object.keys(bag)) {
+      if (RESERVED_METADATA_KEYS.includes(key)) {
+        throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+      }
     }
   }
   return async (req) => {
@@ -62,7 +64,7 @@ function createHealthcheckHandler(options) {
     const body = {
       status: "ok",
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      ...metadata
+      ...shallowMetadata ?? metadata
     };
     return { status: 200, body };
   };

package/dist/integrations/next.cjs

@@ -61,10 +61,12 @@ function httpStatusCode(status) {
 // src/handler.ts
 var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks", "cachedAt"];
 function createHealthcheckHandler(options) {
-  const { registry, resolveDepth, metadata = {} } = options;
-  for (const key of Object.keys(metadata)) {
-    if (RESERVED_METADATA_KEYS.includes(key)) {
-      throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+  const { registry, resolveDepth, metadata = {}, shallowMetadata } = options;
+  for (const bag of [metadata, shallowMetadata ?? {}]) {
+    for (const key of Object.keys(bag)) {
+      if (RESERVED_METADATA_KEYS.includes(key)) {
+        throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+      }
     }
   }
   return async (req) => {
@@ -88,7 +90,7 @@ function createHealthcheckHandler(options) {
     const body = {
       status: "ok",
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      ...metadata
+      ...shallowMetadata ?? metadata
     };
     return { status: 200, body };
   };

package/dist/integrations/next.d.cts

@@ -1,4 +1,4 @@
-import { H as HealthcheckHandlerOptions } from '../handler-TZOgZvY7.cjs';
+import { H as HealthcheckHandlerOptions } from '../handler-C3eTDuSQ.cjs';
 import '../core-Bee03bJm.cjs';
 
 type NextHealthcheckOptions = HealthcheckHandlerOptions;

package/dist/integrations/next.d.ts

@@ -1,4 +1,4 @@
-import { H as HealthcheckHandlerOptions } from '../handler-BvjN4Ot9.js';
+import { H as HealthcheckHandlerOptions } from '../handler-DaFJivGK.js';
 import '../core-Bee03bJm.js';
 
 type NextHealthcheckOptions = HealthcheckHandlerOptions;

package/dist/integrations/next.mjs

@@ -35,10 +35,12 @@ function httpStatusCode(status) {
 // src/handler.ts
 var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks", "cachedAt"];
 function createHealthcheckHandler(options) {
-  const { registry, resolveDepth, metadata = {} } = options;
-  for (const key of Object.keys(metadata)) {
-    if (RESERVED_METADATA_KEYS.includes(key)) {
-      throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+  const { registry, resolveDepth, metadata = {}, shallowMetadata } = options;
+  for (const bag of [metadata, shallowMetadata ?? {}]) {
+    for (const key of Object.keys(bag)) {
+      if (RESERVED_METADATA_KEYS.includes(key)) {
+        throw new Error(`Metadata key '${key}' is reserved. Use a different key name.`);
+      }
     }
   }
   return async (req) => {
@@ -62,7 +64,7 @@ function createHealthcheckHandler(options) {
     const body = {
       status: "ok",
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      ...metadata
+      ...shallowMetadata ?? metadata
     };
     return { status: 200, body };
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebreak/vitals",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "Deep healthcheck endpoints following the HEALTHCHECK_SPEC format",
   "type": "module",
   "exports": {
@@ -75,6 +75,28 @@
       }
     }
   },
+  "typesVersions": {
+    "*": {
+      "express": [
+        "./dist/integrations/express.d.ts"
+      ],
+      "next": [
+        "./dist/integrations/next.d.ts"
+      ],
+      "checks/postgres": [
+        "./dist/checks/postgres.d.ts"
+      ],
+      "checks/http": [
+        "./dist/checks/http.d.ts"
+      ],
+      "checks/databricks": [
+        "./dist/checks/databricks.d.ts"
+      ],
+      "checks/redis": [
+        "./dist/checks/redis.d.ts"
+      ]
+    }
+  },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",