@openstatus/health-clerk 0.1.4-dev.0

package/README.md

@@ -0,0 +1,77 @@
+# @openstatus/health-clerk
+
+[Clerk](https://clerk.com/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Sends
+`GET {baseUrl}/v1/users?limit=1` to the Clerk Backend API with your secret key
+as a bearer header, so it proves both that Clerk answers and that the key is
+valid — with `fetch` alone, on every runtime.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-clerk
+npm install @openstatus/health @openstatus/health-clerk
+```
+
+```ts
+import { createHealthHandler, readEnv } from "@openstatus/health";
+import { clerkProbe } from "@openstatus/health-clerk";
+
+const secretKey = readEnv("CLERK_SECRET_KEY");
+
+Deno.serve(
+  createHealthHandler({
+    probes: [
+      // the factory validates `secretKey` at construction, so pass a
+      // placeholder and let `skip` keep the unconfigured check from running.
+      clerkProbe({
+        secretKey: secretKey || "unconfigured",
+        skip: () => !secretKey,
+      }),
+    ],
+  }),
+);
+```
+
+`secretKey` is the `CLERK_SECRET_KEY` of the instance (`sk_live_…` or
+`sk_test_…`). Listing one user is the cheapest authenticated read on the
+Backend API and has no side effects, so the probe can run on every health
+request. `baseUrl` defaults to `https://api.clerk.com`. Like every probe here,
+this one never reads the environment itself — pass the values in, and use
+`skip` for environments where Clerk is not configured.
+
+This checks the Backend API your server calls to verify sessions and read
+users; the Frontend API your browser code talks to is a separate host with its
+own status.
+
+```ts
+clerkProbe({
+  secretKey,
+  // optional overrides from the Probe contract
+  name: "auth",
+  critical: true,
+  timeoutMs: 2000,
+  skip: () => !secretKey,
+});
+```
+
+Non-critical by default, since Clerk's session tokens are verified locally
+with the instance's JWKS and most requests never call the Backend API. Set
+`critical: true` when requests cannot be served without it — sign-up, user
+management or organization lookups on every request.
+
+## 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 clerkDefaultBaseUrl = "https://api.clerk.com";
+/** Probe name when `name` is unset. */
+const clerkDefaultName = "clerk";
+/** A probe that expects 2xx from `GET {baseUrl}/v1/users?limit=1` with `secretKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `secretKey` or an invalid `baseUrl`. */
+function clerkProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	const url = (0, __openstatus_health.probeUrl)({
+		probe: "clerkProbe",
+		field: "baseUrl",
+		value: options.baseUrl ?? clerkDefaultBaseUrl,
+		path: "/v1/users?limit=1"
+	});
+	if (typeof options.secretKey !== "string" || options.secretKey.length === 0) throw new __openstatus_health.ProbeConfigError("clerkProbe", "secretKey", typeof options.secretKey !== "string" ? `must be a string, got ${String(options.secretKey)}` : "must not be empty");
+	const headers = { authorization: `Bearer ${options.secretKey}` };
+	return {
+		name: options.name ?? clerkDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: (signal) => (0, __openstatus_health.expectOk)(doFetch(url, {
+			method: "GET",
+			headers,
+			signal
+		}))
+	};
+}
+
+//#endregion
+exports.clerkDefaultBaseUrl = clerkDefaultBaseUrl;
+exports.clerkDefaultName = clerkDefaultName;
+exports.clerkProbe = clerkProbe;

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 clerkDefaultBaseUrl = "https://api.clerk.com";
+/** Probe name when `name` is unset. */
+declare const clerkDefaultName = "clerk";
+/** Options for `clerkProbe()`. */
+interface ClerkProbeOptions extends ProbeOverrides {
+  /** The `CLERK_SECRET_KEY` of the instance (`sk_live_…` / `sk_test_…`). */
+  readonly secretKey: string;
+  /** API host. Default `clerkDefaultBaseUrl`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/v1/users?limit=1` with `secretKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `secretKey` or an invalid `baseUrl`. */
+declare function clerkProbe(options: ClerkProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { ClerkProbeOptions, clerkDefaultBaseUrl, clerkDefaultName, clerkProbe };
+//# 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":";;;;;AAoCoC,cAfvB,mBAAA,GAeuB,uBAAA;;AAAyB,cAbhD,gBAAA,GAagD,OAAA;;UAV5C,iBAAA,SAA0B;;;;8BAIb;;0BAEJ;;;iBAIV,UAAA,UAAoB,oBAAoB"}

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 clerkDefaultBaseUrl = "https://api.clerk.com";
+/** Probe name when `name` is unset. */
+declare const clerkDefaultName = "clerk";
+/** Options for `clerkProbe()`. */
+interface ClerkProbeOptions extends ProbeOverrides {
+  /** The `CLERK_SECRET_KEY` of the instance (`sk_live_…` / `sk_test_…`). */
+  readonly secretKey: string;
+  /** API host. Default `clerkDefaultBaseUrl`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/v1/users?limit=1` with `secretKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `secretKey` or an invalid `baseUrl`. */
+declare function clerkProbe(options: ClerkProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { ClerkProbeOptions, clerkDefaultBaseUrl, clerkDefaultName, clerkProbe };
+//# 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":";;;;;AAoCoC,cAfvB,mBAAA,GAeuB,uBAAA;;AAAyB,cAbhD,gBAAA,GAagD,OAAA;;UAV5C,iBAAA,SAA0B;;;;8BAIb;;0BAEJ;;;iBAIV,UAAA,UAAoB,oBAAoB"}

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 clerkDefaultBaseUrl = "https://api.clerk.com";
+/** Probe name when `name` is unset. */
+const clerkDefaultName = "clerk";
+/** A probe that expects 2xx from `GET {baseUrl}/v1/users?limit=1` with `secretKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `secretKey` or an invalid `baseUrl`. */
+function clerkProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	const url = probeUrl({
+		probe: "clerkProbe",
+		field: "baseUrl",
+		value: options.baseUrl ?? clerkDefaultBaseUrl,
+		path: "/v1/users?limit=1"
+	});
+	if (typeof options.secretKey !== "string" || options.secretKey.length === 0) throw new ProbeConfigError("clerkProbe", "secretKey", typeof options.secretKey !== "string" ? `must be a string, got ${String(options.secretKey)}` : "must not be empty");
+	const headers = { authorization: `Bearer ${options.secretKey}` };
+	return {
+		name: options.name ?? clerkDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: (signal) => expectOk(doFetch(url, {
+			method: "GET",
+			headers,
+			signal
+		}))
+	};
+}
+
+//#endregion
+export { clerkDefaultBaseUrl, clerkDefaultName, clerkProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: ClerkProbeOptions"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Clerk reachability probe for `@openstatus/health`, against `/v1/users?limit=1`.\n *\n * ```ts\n * import { clerkProbe } from \"@openstatus/health-clerk\";\n *\n * const probe = clerkProbe({ secretKey: env.CLERK_SECRET_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 clerkDefaultBaseUrl = \"https://api.clerk.com\";\n/** Probe name when `name` is unset. */\nexport const clerkDefaultName = \"clerk\";\n\n/** Options for `clerkProbe()`. */\nexport interface ClerkProbeOptions extends ProbeOverrides {\n  /** The `CLERK_SECRET_KEY` of the instance (`sk_live_…` / `sk_test_…`). */\n  readonly secretKey: string;\n  /** API host. Default `clerkDefaultBaseUrl`. */\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/users?limit=1` with `secretKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `secretKey` or an invalid `baseUrl`. */\nexport function clerkProbe(options: ClerkProbeOptions): Probe {\n  const doFetch = options.fetch ?? globalThis.fetch;\n  const url = probeUrl({\n    probe: \"clerkProbe\",\n    field: \"baseUrl\",\n    value: options.baseUrl ?? clerkDefaultBaseUrl,\n    path: \"/v1/users?limit=1\",\n  });\n  if (typeof options.secretKey !== \"string\" || options.secretKey.length === 0) {\n    throw new ProbeConfigError(\n      \"clerkProbe\",\n      \"secretKey\",\n      typeof options.secretKey !== \"string\"\n        ? `must be a string, got ${String(options.secretKey)}`\n        : \"must not be empty\",\n    );\n  }\n  const headers = { authorization: `Bearer ${options.secretKey}` };\n  return {\n    name: options.name ?? clerkDefaultName,\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,sBAAsB;;AAEnC,MAAa,mBAAmB;;AAahC,SAAgB,WAAWA,SAAmC;CAC5D,MAAM,UAAU,QAAQ,SAAS,WAAW;CAC5C,MAAM,MAAM,SAAS;EACnB,OAAO;EACP,OAAO;EACP,OAAO,QAAQ,WAAW;EAC1B,MAAM;CACP,EAAC;AACF,YAAW,QAAQ,cAAc,YAAY,QAAQ,UAAU,WAAW,EACxE,OAAM,IAAI,iBACR,cACA,oBACO,QAAQ,cAAc,YACxB,wBAAwB,OAAO,QAAQ,UAAU,CAAC,IACnD;CAGR,MAAM,UAAU,EAAE,gBAAgB,SAAS,QAAQ,UAAU,EAAG;AAChE,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-clerk",
+  "version": "0.1.4-dev.0",
+  "description": "Clerk Backend API probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "clerk",
+    "auth",
+    "authentication"
+  ],
+  "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/clerk/"
+  },
+  "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"
+  }
+}