@healthzkit/minio 0.0.1

package/README.md

@@ -0,0 +1,132 @@
+# @healthzkit/minio
+
+MinIO health adapters for [healthzkit](https://healthzkit.dev). The adapter calls **`listBuckets()`** on the official **[`minio`](https://github.com/minio/minio-js)** client and returns **`ok`** with round-trip latency on success.
+
+Install **`minio`** as a peer dependency (v7.1+ or v8).
+
+## Install
+
+```bash
+npm install healthzkit @healthzkit/minio minio
+```
+
+The package is ESM-only (`"type": "module"`).
+
+## Quick start
+
+```ts
+import { createHealthKit } from "healthzkit";
+import { minioAdapter } from "@healthzkit/minio";
+
+const kit = createHealthKit({
+  checks: [
+    {
+      name: "minio",
+      type: ["readiness"],
+      adapter: minioAdapter({
+        config: {
+          endPoint: process.env.MINIO_ENDPOINT ?? "localhost",
+          port: Number(process.env.MINIO_PORT ?? 9000),
+          useSSL: process.env.MINIO_USE_SSL === "true",
+          accessKey: process.env.MINIO_ACCESS_KEY!,
+          secretKey: process.env.MINIO_SECRET_KEY!,
+        },
+      }),
+    },
+  ],
+});
+```
+
+Use a subpath import when you want a dedicated entry for bundlers:
+
+| Import                    | Exports        |
+| ------------------------- | -------------- |
+| `@healthzkit/minio`       | `minioAdapter` |
+| `@healthzkit/minio/minio` | `minioAdapter` |
+
+Both resolve to the same factory.
+
+## `minioAdapter`
+
+**Peer:** `minio` >= 7.1.0 or >= 8.0.0.
+
+Each check runs **`client.listBuckets()`** and records round-trip latency in **`metadata.latencyMs`**.
+
+### Config
+
+Pass **`config`** as [`ClientOptions`](https://github.com/minio/minio-js/blob/master/docs/API.md#new-clientendpoint-port-usessl-accesskey-secretkey-region-transport-sessiontoken-partsize) for the official client. The adapter lazily imports **`minio`**, creates a shared **`Client`**, and reuses it across checks.
+
+```ts
+import { minioAdapter } from "@healthzkit/minio";
+
+const adapter = minioAdapter({
+  config: {
+    endPoint: "localhost",
+    port: 9000,
+    useSSL: false,
+    accessKey: "minioadmin",
+    secretKey: "minioadmin",
+  },
+});
+```
+
+### Existing client
+
+Pass **`client`** as an existing **`Client`** instance. The adapter reuses that client across checks (no internal lifecycle management).
+
+```ts
+import { Client } from "minio";
+import { minioAdapter } from "@healthzkit/minio/minio";
+
+const client = new Client({
+  endPoint: process.env.MINIO_ENDPOINT!,
+  port: 9000,
+  useSSL: false,
+  accessKey: process.env.MINIO_ACCESS_KEY!,
+  secretKey: process.env.MINIO_SECRET_KEY!,
+});
+
+const adapter = minioAdapter({
+  client,
+  metadata: () => ({ endpoint: process.env.MINIO_ENDPOINT }),
+});
+```
+
+Provide **`config`** or **`client`**, not both.
+
+## Options
+
+| Option         | Description                                                                                           |
+| -------------- | ----------------------------------------------------------------------------------------------------- |
+| **`config`**   | `ClientOptions` for a lazily created client.                                                          |
+| **`client`**   | Existing `minio` `Client`.                                                                            |
+| **`metadata`** | Optional `(client) => Record<string, unknown>` (sync or async) merged into metadata with `latencyMs`. |
+
+## Check result
+
+On success:
+
+```json
+{
+  "status": "ok",
+  "metadata": { "latencyMs": 24 }
+}
+```
+
+On failure, `status` is **`fail`** and `error` is set (see [healthzkit](https://healthzkit.dev) for how that rolls up into probe responses).
+
+## Scheduling
+
+For object storage that should not be queried on every probe, pair this adapter with a **`schedule`** on the check so readiness reads cached results. See the **Scheduling** section in the `healthzkit` README.
+
+## 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/index.d.mts

@@ -0,0 +1,2 @@
+import { i as minioAdapter, t as MinioAdapterOptions } from "./minio-CA-ZkiEM.mjs";
+export { type MinioAdapterOptions, minioAdapter };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{t as e}from"./minio-DICU8kyF.mjs";export{e as minioAdapter};

package/dist/minio-CA-ZkiEM.d.mts

@@ -0,0 +1,26 @@
+import { Client, ClientOptions } from "minio";
+import { HealthAdapter } from "healthzkit";
+
+//#region src/shared.d.ts
+type MetadataFn<TClient> = (client: TClient) => Promise<Record<string, unknown>> | Record<string, unknown>;
+interface BaseMinioOptions<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/minio.d.ts
+interface MinioAdapterOptionsWithClient extends BaseMinioOptions<Client> {
+  client: Client;
+  config?: never;
+}
+interface MinioAdapterOptionsWithConfig extends BaseMinioOptions<Client> {
+  config: ClientOptions;
+  client?: never;
+}
+type MinioAdapterOptions = MinioAdapterOptionsWithClient | MinioAdapterOptionsWithConfig;
+declare function minioAdapter(options: MinioAdapterOptions): HealthAdapter;
+//#endregion
+export { minioAdapter as i, MinioAdapterOptionsWithClient as n, MinioAdapterOptionsWithConfig as r, MinioAdapterOptions as t };

package/dist/minio-DICU8kyF.mjs

@@ -0,0 +1 @@
+function e(e,t){return{status:`ok`,metadata:{...t,latencyMs:e}}}function t(e){return{status:`fail`,error:e instanceof Error?e:Error(String(e))}}function n(n){let r=null,i=null;async function a(){return`client`in n&&n.client?n.client:r||(i||=(async()=>{try{let{Client:e}=await import(`minio`),t=new e(n.config);return r=t,t}finally{i=null}})(),i)}return{async check(){try{let t=await a(),r=Date.now();await t.listBuckets();let i=Date.now()-r,o=n.metadata?n.metadata(t):void 0;return e(i,o instanceof Promise?await o:o)}catch(e){return t(e)}}}}export{n as t};

package/dist/minio.d.mts

@@ -0,0 +1,2 @@
+import { i as minioAdapter, n as MinioAdapterOptionsWithClient, r as MinioAdapterOptionsWithConfig, t as MinioAdapterOptions } from "./minio-CA-ZkiEM.mjs";
+export { MinioAdapterOptions, MinioAdapterOptionsWithClient, MinioAdapterOptionsWithConfig, minioAdapter };

package/dist/minio.mjs

@@ -0,0 +1 @@
+import{t as e}from"./minio-DICU8kyF.mjs";export{e as minioAdapter};

package/package.json

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