@openstatus/health-openai 0.1.4-dev.0

package/README.md

@@ -0,0 +1,79 @@
+# @openstatus/health-openai
+
+[OpenAI](https://openai.com/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Sends
+`GET {baseUrl}/v1/models` with your API key as a bearer header, so it proves
+both that the API answers and that the key is valid — with `fetch` alone, on
+every runtime, and without spending a single token.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-openai
+npm install @openstatus/health @openstatus/health-openai
+```
+
+```ts
+import { createHealthHandler, readEnv } from "@openstatus/health";
+import { openaiProbe } from "@openstatus/health-openai";
+
+const apiKey = readEnv("OPENAI_API_KEY");
+
+Deno.serve(
+  createHealthHandler({
+    probes: [
+      // the factory validates `apiKey` at construction, so pass a
+      // placeholder and let `skip` keep the unconfigured check from running.
+      openaiProbe({
+        apiKey: apiKey || "unconfigured",
+        skip: () => !apiKey,
+      }),
+    ],
+  }),
+);
+```
+
+`apiKey` is the `sk-…` key from the OpenAI dashboard; a project key with the
+`Models` read permission is enough. Listing models is a free read with no side
+effects and no rate-limit cost worth mentioning, so the probe can run on every
+health request. `baseUrl` defaults to `https://api.openai.com` and takes the
+origin of any OpenAI-compatible server — Azure OpenAI, a gateway or a local
+model server — as long as it serves `/v1/models`. Like every probe here, this
+one never reads the environment itself — pass the values in, and use `skip`
+for environments where OpenAI is not configured.
+
+A 2xx here means the API is up and the key authenticates. It does not prove
+that a specific model is available or that completions are within their rate
+limit; a model-level outage shows up in your request errors before it shows up
+here.
+
+```ts
+openaiProbe({
+  apiKey: apiKey || "unconfigured",
+  // optional overrides from the Probe contract
+  name: "llm",
+  critical: true,
+  timeoutMs: 2000,
+  skip: () => !apiKey,
+});
+```
+
+Non-critical by default: most services can answer without a model call, so an
+outage degrades the report instead of taking the service out of rotation. Set
+`critical: true` for a service whose every request is an inference.
+
+## About openstatus
+
+[openstatus](https://www.openstatus.dev/) is the open-source uptime monitoring
+and status page platform. This package is part of
+[`@openstatus/health`](https://github.com/openstatusHQ/health), the `/health`
+endpoints behind openstatus's own services, extracted so any JavaScript server
+can expose one. Point an
+[openstatus monitor](https://www.openstatus.dev/docs/reference/http-monitor)
+at the endpoint and assert on `status` in the body to be alerted on
+`degraded` before it becomes `unhealthy`.
+
+Source: [github.com/openstatusHQ/health](https://github.com/openstatusHQ/health).
+Issues and PRs welcome.
+
+## License
+
+[MIT](https://github.com/openstatusHQ/health/blob/main/LICENSE)

package/dist/_virtual/rolldown_runtime.cjs

@@ -0,0 +1,30 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});

package/dist/mod.cjs

@@ -0,0 +1,36 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const __openstatus_health = require_rolldown_runtime.__toESM(require("@openstatus/health"));
+
+//#region src/mod.ts
+/** API base URL when `baseUrl` is unset. */
+const openaiDefaultBaseUrl = "https://api.openai.com";
+/** Probe name when `name` is unset. */
+const openaiDefaultName = "openai";
+/** A probe that expects 2xx from `GET {baseUrl}/v1/models` with `apiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey` or an invalid `baseUrl`. */
+function openaiProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	const url = (0, __openstatus_health.probeUrl)({
+		probe: "openaiProbe",
+		field: "baseUrl",
+		value: options.baseUrl ?? openaiDefaultBaseUrl,
+		path: "/v1/models"
+	});
+	if (typeof options.apiKey !== "string" || options.apiKey.length === 0) throw new __openstatus_health.ProbeConfigError("openaiProbe", "apiKey", typeof options.apiKey !== "string" ? `must be a string, got ${String(options.apiKey)}` : "must not be empty");
+	const headers = { authorization: `Bearer ${options.apiKey}` };
+	return {
+		name: options.name ?? openaiDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: (signal) => (0, __openstatus_health.expectOk)(doFetch(url, {
+			method: "GET",
+			headers,
+			signal
+		}))
+	};
+}
+
+//#endregion
+exports.openaiDefaultBaseUrl = openaiDefaultBaseUrl;
+exports.openaiDefaultName = openaiDefaultName;
+exports.openaiProbe = openaiProbe;

package/dist/mod.d.cts

@@ -0,0 +1,23 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** API base URL when `baseUrl` is unset. */
+declare const openaiDefaultBaseUrl = "https://api.openai.com";
+/** Probe name when `name` is unset. */
+declare const openaiDefaultName = "openai";
+/** Options for `openaiProbe()`. */
+interface OpenaiProbeOptions extends ProbeOverrides {
+  /** An OpenAI API key (`sk-…`). */
+  readonly apiKey: string;
+  /** API host. Default `openaiDefaultBaseUrl`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/v1/models` with `apiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey` or an invalid `baseUrl`. */
+declare function openaiProbe(options: OpenaiProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { OpenaiProbeOptions, openaiDefaultBaseUrl, openaiDefaultName, openaiProbe };
+//# sourceMappingURL=mod.d.cts.map

package/dist/mod.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.cts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;AAoCqC,cAfxB,oBAAA,GAewB,wBAAA;;AAA0B,cAblD,iBAAA,GAakD,QAAA;;UAV9C,kBAAA,SAA2B;;;;8BAId;;0BAEJ;;;iBAIV,WAAA,UAAqB,qBAAqB"}

package/dist/mod.d.ts

@@ -0,0 +1,23 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** API base URL when `baseUrl` is unset. */
+declare const openaiDefaultBaseUrl = "https://api.openai.com";
+/** Probe name when `name` is unset. */
+declare const openaiDefaultName = "openai";
+/** Options for `openaiProbe()`. */
+interface OpenaiProbeOptions extends ProbeOverrides {
+  /** An OpenAI API key (`sk-…`). */
+  readonly apiKey: string;
+  /** API host. Default `openaiDefaultBaseUrl`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/v1/models` with `apiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey` or an invalid `baseUrl`. */
+declare function openaiProbe(options: OpenaiProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { OpenaiProbeOptions, openaiDefaultBaseUrl, openaiDefaultName, openaiProbe };
+//# sourceMappingURL=mod.d.ts.map

package/dist/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;AAoCqC,cAfxB,oBAAA,GAewB,wBAAA;;AAA0B,cAblD,iBAAA,GAakD,QAAA;;UAV9C,kBAAA,SAA2B;;;;8BAId;;0BAEJ;;;iBAIV,WAAA,UAAqB,qBAAqB"}

package/dist/mod.js

@@ -0,0 +1,34 @@
+import { ProbeConfigError, expectOk, probeUrl } from "@openstatus/health";
+
+//#region src/mod.ts
+/** API base URL when `baseUrl` is unset. */
+const openaiDefaultBaseUrl = "https://api.openai.com";
+/** Probe name when `name` is unset. */
+const openaiDefaultName = "openai";
+/** A probe that expects 2xx from `GET {baseUrl}/v1/models` with `apiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey` or an invalid `baseUrl`. */
+function openaiProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	const url = probeUrl({
+		probe: "openaiProbe",
+		field: "baseUrl",
+		value: options.baseUrl ?? openaiDefaultBaseUrl,
+		path: "/v1/models"
+	});
+	if (typeof options.apiKey !== "string" || options.apiKey.length === 0) throw new ProbeConfigError("openaiProbe", "apiKey", typeof options.apiKey !== "string" ? `must be a string, got ${String(options.apiKey)}` : "must not be empty");
+	const headers = { authorization: `Bearer ${options.apiKey}` };
+	return {
+		name: options.name ?? openaiDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: (signal) => expectOk(doFetch(url, {
+			method: "GET",
+			headers,
+			signal
+		}))
+	};
+}
+
+//#endregion
+export { openaiDefaultBaseUrl, openaiDefaultName, openaiProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: OpenaiProbeOptions"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * OpenAI reachability probe for `@openstatus/health`, against `/v1/models`.\n *\n * ```ts\n * import { openaiProbe } from \"@openstatus/health-openai\";\n *\n * const probe = openaiProbe({ apiKey: env.OPENAI_API_KEY });\n * ```\n *\n * @module\n */\n\nimport {\n  expectOk,\n  type Probe,\n  ProbeConfigError,\n  type ProbeOverrides,\n  probeUrl,\n} from \"@openstatus/health\";\n\n/** API base URL when `baseUrl` is unset. */\nexport const openaiDefaultBaseUrl = \"https://api.openai.com\";\n/** Probe name when `name` is unset. */\nexport const openaiDefaultName = \"openai\";\n\n/** Options for `openaiProbe()`. */\nexport interface OpenaiProbeOptions extends ProbeOverrides {\n  /** An OpenAI API key (`sk-…`). */\n  readonly apiKey: string;\n  /** API host. Default `openaiDefaultBaseUrl`. */\n  readonly baseUrl?: string | URL;\n  /** Replacement `fetch`, for tests. */\n  readonly fetch?: typeof fetch;\n}\n\n/** A probe that expects 2xx from `GET {baseUrl}/v1/models` with `apiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey` or an invalid `baseUrl`. */\nexport function openaiProbe(options: OpenaiProbeOptions): Probe {\n  const doFetch = options.fetch ?? globalThis.fetch;\n  const url = probeUrl({\n    probe: \"openaiProbe\",\n    field: \"baseUrl\",\n    value: options.baseUrl ?? openaiDefaultBaseUrl,\n    path: \"/v1/models\",\n  });\n  if (typeof options.apiKey !== \"string\" || options.apiKey.length === 0) {\n    throw new ProbeConfigError(\n      \"openaiProbe\",\n      \"apiKey\",\n      typeof options.apiKey !== \"string\"\n        ? `must be a string, got ${String(options.apiKey)}`\n        : \"must not be empty\",\n    );\n  }\n  const headers = { authorization: `Bearer ${options.apiKey}` };\n  return {\n    name: options.name ?? openaiDefaultName,\n    critical: options.critical ?? false,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: (signal) => expectOk(doFetch(url, { method: \"GET\", headers, signal })),\n  };\n}\n"],"mappings":";;;;AAqBA,MAAa,uBAAuB;;AAEpC,MAAa,oBAAoB;;AAajC,SAAgB,YAAYA,SAAoC;CAC9D,MAAM,UAAU,QAAQ,SAAS,WAAW;CAC5C,MAAM,MAAM,SAAS;EACnB,OAAO;EACP,OAAO;EACP,OAAO,QAAQ,WAAW;EAC1B,MAAM;CACP,EAAC;AACF,YAAW,QAAQ,WAAW,YAAY,QAAQ,OAAO,WAAW,EAClE,OAAM,IAAI,iBACR,eACA,iBACO,QAAQ,WAAW,YACrB,wBAAwB,OAAO,QAAQ,OAAO,CAAC,IAChD;CAGR,MAAM,UAAU,EAAE,gBAAgB,SAAS,QAAQ,OAAO,EAAG;AAC7D,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,CAAC,WAAW,SAAS,QAAQ,KAAK;GAAE,QAAQ;GAAO;GAAS;EAAQ,EAAC,CAAC;CAC5E;AACF"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@openstatus/health-openai",
+  "version": "0.1.4-dev.0",
+  "description": "OpenAI API probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "openai",
+    "llm",
+    "ai"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "openstatus",
+    "url": "https://www.openstatus.dev/"
+  },
+  "homepage": "https://github.com/openstatusHQ/health",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openstatusHQ/health.git",
+    "directory": "packages/openai/"
+  },
+  "bugs": {
+    "url": "https://github.com/openstatusHQ/health/issues"
+  },
+  "type": "module",
+  "module": "./dist/mod.js",
+  "main": "./dist/mod.cjs",
+  "types": "./dist/mod.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/mod.d.ts",
+        "require": "./dist/mod.d.cts"
+      },
+      "import": "./dist/mod.js",
+      "require": "./dist/mod.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "peerDependencies": {
+    "@openstatus/health": "^0.1.4-dev.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}