@firebreak/vitals 1.0.3 → 1.2.0

package/dist/checks/databricks.cjs

@@ -0,0 +1,57 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/checks/databricks.ts
+var databricks_exports = {};
+__export(databricks_exports, {
+  databricksCheck: () => databricksCheck
+});
+module.exports = __toCommonJS(databricks_exports);
+
+// src/types.ts
+var Status = {
+  HEALTHY: 2,
+  DEGRADED: 1,
+  OUTAGE: 0
+};
+
+// src/checks/databricks.ts
+function databricksCheck(client) {
+  return async () => {
+    let session;
+    let op;
+    try {
+      session = await client.openSession();
+      op = await session.executeStatement("SELECT 1");
+      return { status: Status.HEALTHY, message: "" };
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      return { status: Status.OUTAGE, message };
+    } finally {
+      op?.close().catch(() => {
+      });
+      session?.close().catch(() => {
+      });
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  databricksCheck
+});

package/dist/checks/databricks.d.cts

@@ -0,0 +1,23 @@
+import { A as AsyncCheckFn } from '../core-BJ2Z0rRi.cjs';
+
+/**
+ * Minimal interface for a connected Databricks SQL client.
+ * Avoids a hard dependency on `@databricks/sql`.
+ */
+interface DatabricksClient {
+    openSession(): Promise<DatabricksSession>;
+}
+interface DatabricksSession {
+    executeStatement(statement: string, options?: Record<string, unknown>): Promise<DatabricksOperation>;
+    close(): Promise<void>;
+}
+interface DatabricksOperation {
+    close(): Promise<void>;
+}
+/**
+ * Creates a healthcheck function that opens a session on an existing
+ * Databricks SQL client, runs `SELECT 1`, and closes the session.
+ */
+declare function databricksCheck(client: DatabricksClient): AsyncCheckFn;
+
+export { AsyncCheckFn, type DatabricksClient, type DatabricksOperation, type DatabricksSession, databricksCheck };

package/dist/checks/databricks.d.ts

@@ -0,0 +1,23 @@
+import { A as AsyncCheckFn } from '../core-BJ2Z0rRi.js';
+
+/**
+ * Minimal interface for a connected Databricks SQL client.
+ * Avoids a hard dependency on `@databricks/sql`.
+ */
+interface DatabricksClient {
+    openSession(): Promise<DatabricksSession>;
+}
+interface DatabricksSession {
+    executeStatement(statement: string, options?: Record<string, unknown>): Promise<DatabricksOperation>;
+    close(): Promise<void>;
+}
+interface DatabricksOperation {
+    close(): Promise<void>;
+}
+/**
+ * Creates a healthcheck function that opens a session on an existing
+ * Databricks SQL client, runs `SELECT 1`, and closes the session.
+ */
+declare function databricksCheck(client: DatabricksClient): AsyncCheckFn;
+
+export { AsyncCheckFn, type DatabricksClient, type DatabricksOperation, type DatabricksSession, databricksCheck };

package/dist/checks/databricks.mjs

@@ -0,0 +1,30 @@
+// src/types.ts
+var Status = {
+  HEALTHY: 2,
+  DEGRADED: 1,
+  OUTAGE: 0
+};
+
+// src/checks/databricks.ts
+function databricksCheck(client) {
+  return async () => {
+    let session;
+    let op;
+    try {
+      session = await client.openSession();
+      op = await session.executeStatement("SELECT 1");
+      return { status: Status.HEALTHY, message: "" };
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      return { status: Status.OUTAGE, message };
+    } finally {
+      op?.close().catch(() => {
+      });
+      session?.close().catch(() => {
+      });
+    }
+  };
+}
+export {
+  databricksCheck
+};

package/dist/{handler-Bccbso4b.d.cts → handler-Bvf66wzh.d.cts}

@@ -4,22 +4,23 @@ interface HealthcheckHandlerOptions {
     registry: HealthcheckRegistry;
     token?: string | null;
     queryParamName?: string;
+    metadata?: Record<string, string | number | boolean>;
 }
 interface HealthcheckRequest {
     queryParams?: Record<string, string | string[] | undefined>;
     authorizationHeader?: string | null;
 }
+interface ShallowResponseJson {
+    status: 'ok';
+    timestamp: string;
+    [key: string]: string | number | boolean;
+}
 interface HealthcheckHandlerResult {
     status: number;
-    body: HealthcheckResponseJson | {
+    body: HealthcheckResponseJson | ShallowResponseJson | {
         error: string;
     };
 }
-/**
- * Framework-agnostic healthcheck handler. Takes a simple request object
- * and returns a status code + JSON body. Framework integrations (Express,
- * Next.js, etc.) are thin wrappers around this function.
- */
 declare function createHealthcheckHandler(options: HealthcheckHandlerOptions): (req: HealthcheckRequest) => Promise<HealthcheckHandlerResult>;
 
-export { type HealthcheckHandlerOptions as H, type HealthcheckHandlerResult as a, type HealthcheckRequest as b, createHealthcheckHandler as c };
+export { type HealthcheckHandlerOptions as H, type ShallowResponseJson as S, type HealthcheckHandlerResult as a, type HealthcheckRequest as b, createHealthcheckHandler as c };

package/dist/{handler-D0nYVQvu.d.ts → handler-R2U3ygLo.d.ts}

@@ -4,22 +4,23 @@ interface HealthcheckHandlerOptions {
     registry: HealthcheckRegistry;
     token?: string | null;
     queryParamName?: string;
+    metadata?: Record<string, string | number | boolean>;
 }
 interface HealthcheckRequest {
     queryParams?: Record<string, string | string[] | undefined>;
     authorizationHeader?: string | null;
 }
+interface ShallowResponseJson {
+    status: 'ok';
+    timestamp: string;
+    [key: string]: string | number | boolean;
+}
 interface HealthcheckHandlerResult {
     status: number;
-    body: HealthcheckResponseJson | {
+    body: HealthcheckResponseJson | ShallowResponseJson | {
         error: string;
     };
 }
-/**
- * Framework-agnostic healthcheck handler. Takes a simple request object
- * and returns a status code + JSON body. Framework integrations (Express,
- * Next.js, etc.) are thin wrappers around this function.
- */
 declare function createHealthcheckHandler(options: HealthcheckHandlerOptions): (req: HealthcheckRequest) => Promise<HealthcheckHandlerResult>;
 
-export { type HealthcheckHandlerOptions as H, type HealthcheckHandlerResult as a, type HealthcheckRequest as b, createHealthcheckHandler as c };
+export { type HealthcheckHandlerOptions as H, type ShallowResponseJson as S, type HealthcheckHandlerResult as a, type HealthcheckRequest as b, createHealthcheckHandler as c };

package/dist/index.cjs

@@ -189,8 +189,14 @@ function extractToken(options) {
 }
 
 // src/handler.ts
+var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks"];
 function createHealthcheckHandler(options) {
-  const { registry, token = null, queryParamName = "token" } = options;
+  const { registry, token = null, queryParamName = "token", 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.`);
+    }
+  }
   return async (req) => {
     if (token !== null) {
       const provided = extractToken({
@@ -198,14 +204,22 @@ function createHealthcheckHandler(options) {
         authorizationHeader: req.authorizationHeader,
         queryParamName
       });
-      if (provided === null || !verifyToken(provided, token)) {
+      if (provided === null) {
+        const body = {
+          status: "ok",
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          ...metadata
+        };
+        return { status: 200, body };
+      }
+      if (!verifyToken(provided, token)) {
         return { status: 403, body: { error: "Forbidden" } };
       }
     }
     const response = await registry.run();
     return {
       status: httpStatusCode(response.status),
-      body: toJson(response)
+      body: { ...metadata, ...toJson(response) }
     };
   };
 }

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 export { A as AsyncCheckFn, C as CheckInput, a as CheckResult, H as HealthcheckRegistry, b as HealthcheckResponse, c as HealthcheckResponseJson, 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-BJ2Z0rRi.cjs';
-export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, b as HealthcheckRequest, c as createHealthcheckHandler } from './handler-Bccbso4b.cjs';
+export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, b as HealthcheckRequest, S as ShallowResponseJson, c as createHealthcheckHandler } from './handler-Bvf66wzh.cjs';
 
 declare function verifyToken(provided: string, expected: string): boolean;
 declare function extractToken(options: {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { A as AsyncCheckFn, C as CheckInput, a as CheckResult, H as HealthcheckRegistry, b as HealthcheckResponse, c as HealthcheckResponseJson, 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-BJ2Z0rRi.js';
-export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, b as HealthcheckRequest, c as createHealthcheckHandler } from './handler-D0nYVQvu.js';
+export { H as HealthcheckHandlerOptions, a as HealthcheckHandlerResult, b as HealthcheckRequest, S as ShallowResponseJson, c as createHealthcheckHandler } from './handler-R2U3ygLo.js';
 
 declare function verifyToken(provided: string, expected: string): boolean;
 declare function extractToken(options: {

package/dist/index.mjs

@@ -154,8 +154,14 @@ function extractToken(options) {
 }
 
 // src/handler.ts
+var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks"];
 function createHealthcheckHandler(options) {
-  const { registry, token = null, queryParamName = "token" } = options;
+  const { registry, token = null, queryParamName = "token", 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.`);
+    }
+  }
   return async (req) => {
     if (token !== null) {
       const provided = extractToken({
@@ -163,14 +169,22 @@ function createHealthcheckHandler(options) {
         authorizationHeader: req.authorizationHeader,
         queryParamName
       });
-      if (provided === null || !verifyToken(provided, token)) {
+      if (provided === null) {
+        const body = {
+          status: "ok",
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          ...metadata
+        };
+        return { status: 200, body };
+      }
+      if (!verifyToken(provided, token)) {
         return { status: 403, body: { error: "Forbidden" } };
       }
     }
     const response = await registry.run();
     return {
       status: httpStatusCode(response.status),
-      body: toJson(response)
+      body: { ...metadata, ...toJson(response) }
     };
   };
 }

package/dist/integrations/express.cjs

@@ -77,8 +77,14 @@ function httpStatusCode(status) {
 }
 
 // src/handler.ts
+var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks"];
 function createHealthcheckHandler(options) {
-  const { registry, token = null, queryParamName = "token" } = options;
+  const { registry, token = null, queryParamName = "token", 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.`);
+    }
+  }
   return async (req) => {
     if (token !== null) {
       const provided = extractToken({
@@ -86,14 +92,22 @@ function createHealthcheckHandler(options) {
         authorizationHeader: req.authorizationHeader,
         queryParamName
       });
-      if (provided === null || !verifyToken(provided, token)) {
+      if (provided === null) {
+        const body = {
+          status: "ok",
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          ...metadata
+        };
+        return { status: 200, body };
+      }
+      if (!verifyToken(provided, token)) {
         return { status: 403, body: { error: "Forbidden" } };
       }
     }
     const response = await registry.run();
     return {
       status: httpStatusCode(response.status),
-      body: toJson(response)
+      body: { ...metadata, ...toJson(response) }
     };
   };
 }

package/dist/integrations/express.d.cts

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

package/dist/integrations/express.d.ts

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

package/dist/integrations/express.mjs

@@ -51,8 +51,14 @@ function httpStatusCode(status) {
 }
 
 // src/handler.ts
+var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks"];
 function createHealthcheckHandler(options) {
-  const { registry, token = null, queryParamName = "token" } = options;
+  const { registry, token = null, queryParamName = "token", 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.`);
+    }
+  }
   return async (req) => {
     if (token !== null) {
       const provided = extractToken({
@@ -60,14 +66,22 @@ function createHealthcheckHandler(options) {
         authorizationHeader: req.authorizationHeader,
         queryParamName
       });
-      if (provided === null || !verifyToken(provided, token)) {
+      if (provided === null) {
+        const body = {
+          status: "ok",
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          ...metadata
+        };
+        return { status: 200, body };
+      }
+      if (!verifyToken(provided, token)) {
         return { status: 403, body: { error: "Forbidden" } };
       }
     }
     const response = await registry.run();
     return {
       status: httpStatusCode(response.status),
-      body: toJson(response)
+      body: { ...metadata, ...toJson(response) }
     };
   };
 }

package/dist/integrations/next.cjs

@@ -77,8 +77,14 @@ function httpStatusCode(status) {
 }
 
 // src/handler.ts
+var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks"];
 function createHealthcheckHandler(options) {
-  const { registry, token = null, queryParamName = "token" } = options;
+  const { registry, token = null, queryParamName = "token", 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.`);
+    }
+  }
   return async (req) => {
     if (token !== null) {
       const provided = extractToken({
@@ -86,14 +92,22 @@ function createHealthcheckHandler(options) {
         authorizationHeader: req.authorizationHeader,
         queryParamName
       });
-      if (provided === null || !verifyToken(provided, token)) {
+      if (provided === null) {
+        const body = {
+          status: "ok",
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          ...metadata
+        };
+        return { status: 200, body };
+      }
+      if (!verifyToken(provided, token)) {
         return { status: 403, body: { error: "Forbidden" } };
       }
     }
     const response = await registry.run();
     return {
       status: httpStatusCode(response.status),
-      body: toJson(response)
+      body: { ...metadata, ...toJson(response) }
     };
   };
 }

package/dist/integrations/next.d.cts

@@ -1,4 +1,4 @@
-import { H as HealthcheckHandlerOptions } from '../handler-Bccbso4b.cjs';
+import { H as HealthcheckHandlerOptions } from '../handler-Bvf66wzh.cjs';
 import '../core-BJ2Z0rRi.cjs';
 
 type NextHealthcheckOptions = HealthcheckHandlerOptions;

package/dist/integrations/next.d.ts

@@ -1,4 +1,4 @@
-import { H as HealthcheckHandlerOptions } from '../handler-D0nYVQvu.js';
+import { H as HealthcheckHandlerOptions } from '../handler-R2U3ygLo.js';
 import '../core-BJ2Z0rRi.js';
 
 type NextHealthcheckOptions = HealthcheckHandlerOptions;

package/dist/integrations/next.mjs

@@ -51,8 +51,14 @@ function httpStatusCode(status) {
 }
 
 // src/handler.ts
+var RESERVED_METADATA_KEYS = ["status", "timestamp", "checks"];
 function createHealthcheckHandler(options) {
-  const { registry, token = null, queryParamName = "token" } = options;
+  const { registry, token = null, queryParamName = "token", 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.`);
+    }
+  }
   return async (req) => {
     if (token !== null) {
       const provided = extractToken({
@@ -60,14 +66,22 @@ function createHealthcheckHandler(options) {
         authorizationHeader: req.authorizationHeader,
         queryParamName
       });
-      if (provided === null || !verifyToken(provided, token)) {
+      if (provided === null) {
+        const body = {
+          status: "ok",
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          ...metadata
+        };
+        return { status: 200, body };
+      }
+      if (!verifyToken(provided, token)) {
         return { status: 403, body: { error: "Forbidden" } };
       }
     }
     const response = await registry.run();
     return {
       status: httpStatusCode(response.status),
-      body: toJson(response)
+      body: { ...metadata, ...toJson(response) }
     };
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebreak/vitals",
-  "version": "1.0.3",
+  "version": "1.2.0",
   "description": "Deep healthcheck endpoints following the HEALTHCHECK_SPEC format",
   "type": "module",
   "exports": {
@@ -34,6 +34,16 @@
         "default": "./dist/checks/http.cjs"
       }
     },
+    "./checks/databricks": {
+      "import": {
+        "types": "./dist/checks/databricks.d.ts",
+        "default": "./dist/checks/databricks.mjs"
+      },
+      "require": {
+        "types": "./dist/checks/databricks.d.cts",
+        "default": "./dist/checks/databricks.cjs"
+      }
+    },
     "./checks/redis": {
       "import": {
         "types": "./dist/checks/redis.d.ts",
@@ -109,5 +119,5 @@
   "engines": {
     "node": ">=20.0.0"
   },
-  "license": "UNLICENSED"
+  "license": "MIT"
 }