@healthzkit/elasticsearch 0.0.1

package/README.md

@@ -0,0 +1,122 @@
+# @healthzkit/elasticsearch
+
+Elasticsearch health adapters for [healthzkit](https://healthzkit.dev). The adapter calls **`cluster.health()`** and maps cluster status to probe status: **`green`** → `ok`, **`yellow`** → `degraded`, **`red`** → `fail`.
+
+Install **`@elastic/elasticsearch`** as a peer dependency (v8 or v9).
+
+## Install
+
+```bash
+npm install healthzkit @healthzkit/elasticsearch @elastic/elasticsearch
+```
+
+The package is ESM-only (`"type": "module"`).
+
+## Quick start
+
+```ts
+import { createHealthKit } from "healthzkit";
+import { elasticsearchAdapter } from "@healthzkit/elasticsearch";
+
+const kit = createHealthKit({
+  checks: [
+    {
+      name: "elasticsearch",
+      type: ["readiness"],
+      adapter: elasticsearchAdapter({
+        config: { node: process.env.ELASTICSEARCH_URL! },
+      }),
+    },
+  ],
+});
+```
+
+Use a subpath import when you want a dedicated entry for bundlers:
+
+| Import                                    | Exports                |
+| ----------------------------------------- | ---------------------- |
+| `@healthzkit/elasticsearch`               | `elasticsearchAdapter` |
+| `@healthzkit/elasticsearch/elasticsearch` | `elasticsearchAdapter` |
+
+Both resolve to the same factory.
+
+## `elasticsearchAdapter`
+
+**Peer:** `@elastic/elasticsearch` >= 8 or >= 9.
+
+Each check runs **`client.cluster.health()`** and records round-trip latency.
+
+### Config
+
+Pass **`config`** as [`ClientOptions`](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html) for the official client. The adapter lazily imports **`@elastic/elasticsearch`**, creates a shared **`Client`**, and reuses it across checks. When **`config`** is omitted, the default node is **`http://localhost:9200`**.
+
+```ts
+import { elasticsearchAdapter } from "@healthzkit/elasticsearch";
+
+const adapter = elasticsearchAdapter({
+  config: {
+    node: process.env.ELASTICSEARCH_URL ?? "http://localhost:9200",
+  },
+});
+```
+
+### Existing client
+
+Pass **`client`** as an existing **`Client`** instance. The adapter reuses that client across checks (no internal lifecycle management).
+
+```ts
+import { Client } from "@elastic/elasticsearch";
+import { elasticsearchAdapter } from "@healthzkit/elasticsearch/elasticsearch";
+
+const client = new Client({ node: process.env.ELASTICSEARCH_URL! });
+
+const adapter = elasticsearchAdapter({
+  client,
+  metadata: async (c) => {
+    const info = await c.info();
+    return { version: info.version.number };
+  },
+});
+```
+
+Provide **`config`** or **`client`**, not both.
+
+## Options
+
+| Option         | Description                                                                                           |
+| -------------- | ----------------------------------------------------------------------------------------------------- |
+| **`config`**   | `ClientOptions` for a lazily created client. Default node: `http://localhost:9200`.                   |
+| **`client`**   | Existing `@elastic/elasticsearch` `Client`.                                                           |
+| **`metadata`** | Optional `(client) => Record<string, unknown>` (sync or async) merged into metadata with `latencyMs`. |
+
+## Check result
+
+On success (cluster status **`green`**):
+
+```json
+{
+  "status": "ok",
+  "metadata": {
+    "latencyMs": 18,
+    "clusterStatus": "green",
+    "clusterName": "docker-cluster",
+    "numberOfNodes": 3
+  }
+}
+```
+
+When the cluster reports **`yellow`**, the check status is **`degraded`** (metadata still includes `clusterStatus`, `clusterName`, and `numberOfNodes`). When the cluster is **`red`**, the check status is **`fail`**.
+
+On transport or API errors, `status` is **`fail`** and `error` is set (see [healthzkit](https://healthzkit.dev) for how that rolls up into probe responses).
+
+## Development (this repo)
+
+From the package directory:
+
+```bash
+vp install
+vp test
+vp pack
+```
+
+See the repo root `AGENTS.md` for Vite+ / `vp` conventions.

package/dist/elasticsearch-1igrfgjc.mjs

@@ -0,0 +1 @@
+function e(e){return{status:`fail`,error:e instanceof Error?e:Error(String(e))}}function t(t){let n=null,r=null;async function i(){return`client`in t&&t.client?t.client:n||(r||=(async()=>{try{let{Client:e}=await import(`@elastic/elasticsearch`),r=new e(t.config??{node:`http://localhost:9200`});return n=r,r}finally{r=null}})(),r)}return{async check(){try{let e=await i(),n=Date.now(),r=await e.cluster.health(),a=Date.now()-n,o=r.status,s=o===`red`?`fail`:o===`yellow`?`degraded`:`ok`,c=t.metadata?t.metadata(e):void 0,l=c instanceof Promise?await c:c;return{status:s,metadata:{latencyMs:a,clusterStatus:o,clusterName:r.cluster_name,numberOfNodes:r.number_of_data_nodes,...l}}}catch(t){return e(t)}}}}export{t};

package/dist/elasticsearch-Cp7sTdkM.d.mts

@@ -0,0 +1,27 @@
+import { Client } from "@elastic/elasticsearch";
+import { ClientOptions } from "@elastic/elasticsearch/lib/client";
+import { HealthAdapter } from "healthzkit";
+
+//#region src/shared.d.ts
+type MetadataFn<TClient> = (client: TClient) => Promise<Record<string, unknown>> | Record<string, unknown>;
+interface BaseElasticsearchOptions<TClient> {
+  /**
+   * Optional function to populate metadata in the check result.
+   * Receives the resolved client so you can run additional operations.
+   */
+  metadata?: MetadataFn<TClient>;
+}
+//#endregion
+//#region src/elasticsearch.d.ts
+interface ElasticsearchAdapterOptionsWithClient extends BaseElasticsearchOptions<Client> {
+  client: Client;
+  config?: never;
+}
+interface ElasticsearchAdapterOptionsWithConfig extends BaseElasticsearchOptions<Client> {
+  config?: ClientOptions;
+  client?: never;
+}
+type ElasticsearchAdapterOptions = ElasticsearchAdapterOptionsWithClient | ElasticsearchAdapterOptionsWithConfig;
+declare function elasticsearchAdapter(options: ElasticsearchAdapterOptions): HealthAdapter;
+//#endregion
+export { elasticsearchAdapter as i, ElasticsearchAdapterOptionsWithClient as n, ElasticsearchAdapterOptionsWithConfig as r, ElasticsearchAdapterOptions as t };

package/dist/elasticsearch.d.mts

@@ -0,0 +1,2 @@
+import { i as elasticsearchAdapter, n as ElasticsearchAdapterOptionsWithClient, r as ElasticsearchAdapterOptionsWithConfig, t as ElasticsearchAdapterOptions } from "./elasticsearch-Cp7sTdkM.mjs";
+export { ElasticsearchAdapterOptions, ElasticsearchAdapterOptionsWithClient, ElasticsearchAdapterOptionsWithConfig, elasticsearchAdapter };

package/dist/elasticsearch.mjs

@@ -0,0 +1 @@
+import{t as e}from"./elasticsearch-1igrfgjc.mjs";export{e as elasticsearchAdapter};

package/dist/index.d.mts

@@ -0,0 +1,2 @@
+import { i as elasticsearchAdapter, t as ElasticsearchAdapterOptions } from "./elasticsearch-Cp7sTdkM.mjs";
+export { type ElasticsearchAdapterOptions, elasticsearchAdapter };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{t as e}from"./elasticsearch-1igrfgjc.mjs";export{e as elasticsearchAdapter};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@healthzkit/elasticsearch",
+  "version": "0.0.1",
+  "license": "AGPL-3.0-only",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alasti-company/healthzkit.dev",
+    "directory": "packages/elasticsearch"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./elasticsearch": "./dist/elasticsearch.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"
+  },
+  "devDependencies": {
+    "@elastic/elasticsearch": "^9.4.1",
+    "@types/node": "^25.6.2",
+    "@typescript/native-preview": "7.0.0-dev.20260509.2",
+    "bumpp": "^11.1.0",
+    "healthzkit": "workspace:*",
+    "typescript": "^6.0.3",
+    "vite-plus": "^0.1.20"
+  },
+  "peerDependencies": {
+    "@elastic/elasticsearch": ">=9.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@elastic/elasticsearch": {
+      "optional": true
+    }
+  }
+}