@healthzkit/cockroach 0.0.0

package/README.md

@@ -0,0 +1,79 @@
+# @healthzkit/cockroach
+
+CockroachDB **healthzkit** `HealthAdapter` helper for **[`pg`](https://node-postgres.com/)** (node-postgres). CockroachDB speaks the PostgreSQL wire protocol, so the adapter runs a lightweight SQL probe (default **`SELECT 1`**) via `client.query`. Successful checks return `ok` with `metadata.latencyMs` plus any fields from an optional `metadata` hook; failures return `fail` with the caught error.
+
+## Install
+
+```bash
+npm install @healthzkit/cockroach healthzkit pg
+```
+
+**Peer:** `pg` ≥ 8.
+
+## Options
+
+`cockroachPgAdapter` accepts `BaseCockroachOptions`:
+
+| Option     | Description                                                                                                                        |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `query`    | SQL executed for the probe. Default `SELECT 1`.                                                                                    |
+| `metadata` | Optional async `(client) => Record<string, unknown>` merged into check metadata with `latencyMs`.                                  |
+| `pgOption` | Optional `pg` `Pool` constructor options (except `connectionString`). Only with `connectionString`. Merged into the internal pool. |
+
+Pass either `connectionString` or `client` (not both).
+
+## Connection string
+
+The adapter maintains an internal `Pool` with `max: 1`, `connect()`s a client for each check, runs `client.query(query)`, then `release()`s the client in a `finally` block.
+
+```ts
+import { createHealthKit } from "healthzkit";
+import { cockroachPgAdapter } from "@healthzkit/cockroach";
+
+const kit = createHealthKit({
+  checks: [
+    {
+      name: "cockroach",
+      type: ["readiness"],
+      adapter: cockroachPgAdapter({
+        connectionString: process.env.DATABASE_URL!,
+      }),
+    },
+  ],
+});
+```
+
+Optional `pgOption` merges into the internal `Pool` constructor (everything except `connectionString`).
+
+## Existing client or pool
+
+Pass `client` as:
+
+- A `Pool`: each check calls `pool.connect()`, runs the query on the `PoolClient`, then releases it.
+- A `PoolClient` or other `ClientBase`: the query runs on that instance; release is a no-op.
+
+```ts
+import { Pool } from "pg";
+import { cockroachPgAdapter } from "@healthzkit/cockroach";
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL! });
+
+const adapter = cockroachPgAdapter({
+  client: pool,
+  query: "SELECT current_database()",
+});
+```
+
+## Scheduling
+
+For busy clusters, pair this adapter with a `schedule` on the check so readiness reads cached results instead of hitting CockroachDB on every probe. See the **Scheduling** section in the `healthzkit` README.
+
+## Development
+
+From the monorepo root:
+
+```bash
+vp install
+vp test --filter @healthzkit/cockroach
+vp pack --filter @healthzkit/cockroach
+```

package/dist/index.d.mts

@@ -0,0 +1,2 @@
+import { i as cockroachPgAdapter, t as CockroachPgAdapterOptions } from "./pg-CgrYo7g9.mjs";
+export { type CockroachPgAdapterOptions, cockroachPgAdapter };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{t as e}from"./pg-iF7bm_uc.mjs";export{e as cockroachPgAdapter};

package/dist/pg-CgrYo7g9.d.mts

@@ -0,0 +1,32 @@
+import { HealthAdapter, MetadataFn } from "@healthzkit/shared";
+import { ClientBase, Pool, PoolClient } from "pg";
+
+//#region src/shared.d.ts
+interface BaseCockroachOptions<TClient> {
+  /**
+   * Query to run as the healthcheck.
+   * @default "SELECT 1"
+   */
+  query?: string;
+  /**
+   * Optional function to populate metadata in the check result.
+   * Receives the resolved client so you can run additional queries.
+   */
+  metadata?: MetadataFn<TClient>;
+}
+//#endregion
+//#region src/pg.d.ts
+interface CockroachPgAdapterOptionsWithClient extends BaseCockroachOptions<ClientBase> {
+  client: Pool | PoolClient | ClientBase;
+  connectionString?: never;
+  pgOption?: never;
+}
+interface CockroachPgAdapterOptionsWithConfig extends BaseCockroachOptions<ClientBase> {
+  connectionString: string;
+  pgOption?: Omit<ConstructorParameters<typeof Pool>[0], "connectionString">;
+  client?: never;
+}
+type CockroachPgAdapterOptions = CockroachPgAdapterOptionsWithClient | CockroachPgAdapterOptionsWithConfig;
+declare function cockroachPgAdapter(options: CockroachPgAdapterOptions): HealthAdapter;
+//#endregion
+export { cockroachPgAdapter as i, CockroachPgAdapterOptionsWithClient as n, CockroachPgAdapterOptionsWithConfig as r, CockroachPgAdapterOptions as t };

package/dist/pg-iF7bm_uc.mjs

@@ -0,0 +1 @@
+import{buildErrorResult as e,buildResult as t}from"@healthzkit/shared";function n(n){let r=null;async function i(){let{Pool:e}=await import(`pg`);if(`connectionString`in n){if(`client`in n)throw Error(`cockroachPgAdapter accepts either connectionString or client, not both`);if(!n.connectionString)throw Error(`cockroachPgAdapter connectionString must be a non-empty string`);r||=new e({connectionString:n.connectionString,max:1,...n.pgOption});let t=await r.connect();return{client:t,release:()=>t.release()}}if(`client`in n){if(n.client instanceof e){let e=await n.client.connect();return{client:e,release:()=>e.release()}}return{client:n.client,release:()=>{}}}throw Error(`cockroachPgAdapter requires either connectionString or client`)}return{async check(){let r=()=>{};try{let e=Date.now(),{client:a,release:o}=await i();r=o,await a.query(n.query??`SELECT 1`);let s=Date.now()-e,c=n.metadata?await n.metadata(a):void 0;return t(s,c instanceof Promise?await c:c)}catch(t){return e(t)}finally{r()}}}}export{n as t};

package/dist/pg.d.mts

@@ -0,0 +1,2 @@
+import { i as cockroachPgAdapter, n as CockroachPgAdapterOptionsWithClient, r as CockroachPgAdapterOptionsWithConfig, t as CockroachPgAdapterOptions } from "./pg-CgrYo7g9.mjs";
+export { CockroachPgAdapterOptions, CockroachPgAdapterOptionsWithClient, CockroachPgAdapterOptionsWithConfig, cockroachPgAdapter };

package/dist/pg.mjs

@@ -0,0 +1 @@
+import{t as e}from"./pg-iF7bm_uc.mjs";export{e as cockroachPgAdapter};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@healthzkit/cockroach",
+  "version": "0.0.0",
+  "license": "AGPL-3.0-only",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alasti-company/healthzkit.dev",
+    "directory": "packages/cockroach"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./pg": "./dist/pg.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "dev": "vp pack --watch",
+    "test": "vp test",
+    "check": "vp check",
+    "prepublishOnly": "vp run build"
+  },
+  "dependencies": {
+    "@healthzkit/shared": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "catalog:",
+    "@types/pg": "^8.2.0",
+    "@typescript/native-preview": "7.0.0-dev.20260509.2",
+    "bumpp": "^11.1.0",
+    "healthzkit": "workspace:*",
+    "pg": "8.21.0",
+    "typescript": "catalog:",
+    "vite-plus": "catalog:"
+  },
+  "peerDependencies": {
+    "pg": ">=8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "pg": {
+      "optional": false
+    }
+  }
+}