@openstatus/health-cloudflare-d1 0.1.4-dev.0

package/README.md

@@ -0,0 +1,78 @@
+# @openstatus/health-cloudflare-d1
+
+[Cloudflare D1](https://developers.cloudflare.com/d1/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Runs `select 1`
+through the `D1Database` binding of a Worker and fails the check when the
+statement does.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-cloudflare-d1
+npm install @openstatus/health @openstatus/health-cloudflare-d1
+```
+
+```ts
+import { createLazyHealthHandler } from "@openstatus/health";
+import { d1Probe } from "@openstatus/health-cloudflare-d1";
+
+interface Env {
+  DB: D1Database;
+}
+
+export default {
+  fetch: createLazyHealthHandler<Request, Env>((env) => ({
+    path: "/health",
+    probes: [d1Probe({ db: env.DB })],
+  })),
+};
+```
+
+Bindings only exist inside `fetch(request, env)` in Workers, but the handler
+must be built once or every request gets a fresh cache and the probe runs on
+every poll. `createLazyHealthHandler` runs your callback on the first request
+and reuses the handler it builds; with Hono, build the probe once inside a
+route handler that receives `c.env` and memoise it the same way. The probe
+calls `db.prepare("select 1").first()`, which round-trips to the D1 storage
+and needs no table. For the colo and version the response came from, add
+`@openstatus/health-cloudflare`'s `extend` hook.
+
+```ts
+d1Probe({
+  db: env.DB,
+  // optional overrides from the Probe contract
+  name: "d1",
+  critical: false,
+  timeoutMs: 1000,
+  skip: () => env.HEALTH_SKIP_D1 === "true",
+});
+```
+
+The factory validates `db` when it is called, before `skip` is ever
+consulted, so `skip` cannot stand in for a missing binding; leave the probe
+out of `probes` instead when the Worker may run without D1.
+
+Critical by default: a D1 that does not answer usually means requests cannot
+be served, so the report turns `unhealthy`. Set `critical: false` when the
+Worker can serve without it.
+
+The binding is typed structurally as `{ prepare(query): { first() } }`, so
+the package has no dependency on `@cloudflare/workers-types` and works with
+the types `wrangler types` generates. The factory throws `ProbeConfigError`
+at construction when the binding has no `prepare()`.
+
+## 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,30 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const __openstatus_health = require_rolldown_runtime.__toESM(require("@openstatus/health"));
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const d1DefaultName = "database";
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `prepare()`. */
+function d1Probe(options) {
+	const db = options.db;
+	if (typeof db?.prepare !== "function") throw new __openstatus_health.ProbeConfigError("d1Probe", "db", `must expose prepare(), got ${describe(db)}`);
+	return {
+		name: options.name ?? d1DefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await db.prepare("select 1").first();
+		}
+	};
+}
+function describe(db) {
+	if (db == null) return String(db);
+	if (typeof db !== "object") return typeof db;
+	const keys = Object.keys(db);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+exports.d1DefaultName = d1DefaultName;
+exports.d1Probe = d1Probe;

package/dist/mod.d.cts

@@ -0,0 +1,27 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const d1DefaultName = "database";
+/** The subset of a `D1PreparedStatement` the probe uses. */
+interface D1LikeStatement {
+  /** Run the statement and resolve with the first row. */
+  first(): PromiseLike<ProbeResult>;
+}
+/** The subset of a `D1Database` binding the probe uses. */
+interface D1LikeDatabase {
+  /** Prepare one statement. */
+  prepare(query: string): D1LikeStatement;
+}
+/** Options for `d1Probe()`. */
+interface D1ProbeOptions extends ProbeOverrides {
+  /** The `D1Database` binding from `env`. */
+  readonly db: D1LikeDatabase;
+}
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `prepare()`. */
+declare function d1Probe(options: D1ProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { D1LikeDatabase, D1LikeStatement, D1ProbeOptions, d1DefaultName, d1Probe };
+//# 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":";;;;;AA+CuD,cArB1C,aAAA,GAqB0C,UAAA;;UAlBtC,eAAA;;WAEN,YAAY;;;UAIN,cAAA;;0BAES;;;UAIT,cAAA,SAAuB;;eAEzB;;;iBAIC,OAAA,UAAiB,iBAAiB"}

package/dist/mod.d.ts

@@ -0,0 +1,27 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const d1DefaultName = "database";
+/** The subset of a `D1PreparedStatement` the probe uses. */
+interface D1LikeStatement {
+  /** Run the statement and resolve with the first row. */
+  first(): PromiseLike<ProbeResult>;
+}
+/** The subset of a `D1Database` binding the probe uses. */
+interface D1LikeDatabase {
+  /** Prepare one statement. */
+  prepare(query: string): D1LikeStatement;
+}
+/** Options for `d1Probe()`. */
+interface D1ProbeOptions extends ProbeOverrides {
+  /** The `D1Database` binding from `env`. */
+  readonly db: D1LikeDatabase;
+}
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `prepare()`. */
+declare function d1Probe(options: D1ProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { D1LikeDatabase, D1LikeStatement, D1ProbeOptions, d1DefaultName, d1Probe };
+//# 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":";;;;;AA+CuD,cArB1C,aAAA,GAqB0C,UAAA;;UAlBtC,eAAA;;WAEN,YAAY;;;UAIN,cAAA;;0BAES;;;UAIT,cAAA,SAAuB;;eAEzB;;;iBAIC,OAAA,UAAiB,iBAAiB"}

package/dist/mod.js

@@ -0,0 +1,29 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const d1DefaultName = "database";
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `prepare()`. */
+function d1Probe(options) {
+	const db = options.db;
+	if (typeof db?.prepare !== "function") throw new ProbeConfigError("d1Probe", "db", `must expose prepare(), got ${describe(db)}`);
+	return {
+		name: options.name ?? d1DefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await db.prepare("select 1").first();
+		}
+	};
+}
+function describe(db) {
+	if (db == null) return String(db);
+	if (typeof db !== "object") return typeof db;
+	const keys = Object.keys(db);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+export { d1DefaultName, d1Probe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: D1ProbeOptions","db: D1LikeDatabase"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Cloudflare D1 probe for `@openstatus/health`: runs `select 1` through a\n * Workers `D1Database` binding.\n *\n * ```ts\n * import { createLazyHealthHandler } from \"@openstatus/health\";\n * import { d1Probe } from \"@openstatus/health-cloudflare-d1\";\n *\n * export default {\n *   fetch: createLazyHealthHandler<Request, Env>((env) => ({\n *     probes: [d1Probe({ db: env.DB })],\n *   })),\n * };\n * ```\n *\n * @module\n */\n\nimport {\n  type Probe,\n  ProbeConfigError,\n  type ProbeOverrides,\n  type ProbeResult,\n} from \"@openstatus/health\";\n\n/** Probe name when `name` is unset. */\nexport const d1DefaultName = \"database\";\n\n/** The subset of a `D1PreparedStatement` the probe uses. */\nexport interface D1LikeStatement {\n  /** Run the statement and resolve with the first row. */\n  first(): PromiseLike<ProbeResult>;\n}\n\n/** The subset of a `D1Database` binding the probe uses. */\nexport interface D1LikeDatabase {\n  /** Prepare one statement. */\n  prepare(query: string): D1LikeStatement;\n}\n\n/** Options for `d1Probe()`. */\nexport interface D1ProbeOptions extends ProbeOverrides {\n  /** The `D1Database` binding from `env`. */\n  readonly db: D1LikeDatabase;\n}\n\n/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `prepare()`. */\nexport function d1Probe(options: D1ProbeOptions): Probe {\n  const db = options.db;\n  if (typeof db?.prepare !== \"function\") {\n    throw new ProbeConfigError(\n      \"d1Probe\",\n      \"db\",\n      `must expose prepare(), got ${describe(db)}`,\n    );\n  }\n  return {\n    name: options.name ?? d1DefaultName,\n    critical: options.critical ?? true,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async () => {\n      await db.prepare(\"select 1\").first();\n    },\n  };\n}\n\nfunction describe(db: D1LikeDatabase): string {\n  if (db == null) return String(db);\n  if (typeof db !== \"object\") return typeof db;\n  const keys = Object.keys(db);\n  return keys.length === 0\n    ? \"an object with no keys\"\n    : `an object with keys ${keys.slice(0, 8).join(\", \")}`;\n}\n"],"mappings":";;;;AA0BA,MAAa,gBAAgB;;AAqB7B,SAAgB,QAAQA,SAAgC;CACtD,MAAM,KAAK,QAAQ;AACnB,YAAW,IAAI,YAAY,WACzB,OAAM,IAAI,iBACR,WACA,OACC,6BAA6B,SAAS,GAAG,CAAC;AAG/C,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,YAAY;AACf,SAAM,GAAG,QAAQ,WAAW,CAAC,OAAO;EACrC;CACF;AACF;AAED,SAAS,SAASC,IAA4B;AAC5C,KAAI,MAAM,KAAM,QAAO,OAAO,GAAG;AACjC,YAAW,OAAO,SAAU,eAAc;CAC1C,MAAM,OAAO,OAAO,KAAK,GAAG;AAC5B,QAAO,KAAK,WAAW,IACnB,4BACC,sBAAsB,KAAK,MAAM,GAAG,EAAE,CAAC,KAAK,KAAK,CAAC;AACxD"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@openstatus/health-cloudflare-d1",
+  "version": "0.1.4-dev.0",
+  "description": "Cloudflare D1 probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "cloudflare",
+    "d1",
+    "workers",
+    "sqlite",
+    "database"
+  ],
+  "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/cloudflare-d1/"
+  },
+  "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"
+  }
+}