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

package/README.md

@@ -0,0 +1,80 @@
+# @openstatus/health-cloudflare-r2
+
+[Cloudflare R2](https://developers.cloudflare.com/r2/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Sends a `HEAD`
+for one object through an `R2Bucket` binding and fails the check when the
+request does — a missing object is a healthy answer, only an error is not.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-cloudflare-r2
+npm install @openstatus/health @openstatus/health-cloudflare-r2
+```
+
+```ts
+import { createLazyHealthHandler } from "@openstatus/health";
+import { r2Probe } from "@openstatus/health-cloudflare-r2";
+
+interface Env {
+  UPLOADS: R2Bucket;
+}
+
+export default {
+  fetch: createLazyHealthHandler<Request, Env>((env) => ({
+    path: "/health",
+    probes: [r2Probe({ bucket: env.UPLOADS })],
+  })),
+};
+```
+
+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 `bucket.head("health")`, the cheapest R2 operation that still
+reaches the bucket; pass `key` to check an object your Worker actually
+serves. For an R2 bucket reached over its S3 API from outside Workers, use
+`@openstatus/health-s3` instead.
+
+```ts
+r2Probe({
+  bucket: env.UPLOADS,
+  key: "assets/logo.png",
+  // optional overrides from the Probe contract
+  name: "uploads",
+  critical: true,
+  timeoutMs: 1000,
+  skip: () => env.HEALTH_SKIP_R2 === "true",
+});
+```
+
+The factory validates `bucket` 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 R2.
+
+Non-critical by default: object storage usually backs uploads and assets
+whose outage degrades the report instead of taking the Worker out of
+rotation. Set `critical: true` when requests cannot proceed without it.
+
+The binding is typed structurally as `{ head(key) }`, 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 `head()` or `key` is empty.
+
+## 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,35 @@
+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 r2DefaultName = "storage";
+/** Object key checked when `key` is unset. */
+const r2DefaultKey = "health";
+/** A probe that heads `key`; non-critical by default. Throws `ProbeConfigError` without `head()` or with an empty `key`. */
+function r2Probe(options) {
+	const bucket = options.bucket;
+	if (typeof bucket?.head !== "function") throw new __openstatus_health.ProbeConfigError("r2Probe", "bucket", `must expose head(), got ${describe(bucket)}`);
+	const key = options.key ?? r2DefaultKey;
+	if (typeof key !== "string" || key.length === 0) throw new __openstatus_health.ProbeConfigError("r2Probe", "key", typeof key !== "string" ? `must be a string, got ${String(key)}` : "must not be empty");
+	return {
+		name: options.name ?? r2DefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await bucket.head(key);
+		}
+	};
+}
+function describe(bucket) {
+	if (bucket == null) return String(bucket);
+	if (typeof bucket !== "object") return typeof bucket;
+	const keys = Object.keys(bucket);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+exports.r2DefaultKey = r2DefaultKey;
+exports.r2DefaultName = r2DefaultName;
+exports.r2Probe = r2Probe;

package/dist/mod.d.cts

@@ -0,0 +1,26 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const r2DefaultName = "storage";
+/** Object key checked when `key` is unset. */
+declare const r2DefaultKey = "health";
+/** The subset of an `R2Bucket` binding the probe uses. */
+interface R2LikeBucket {
+  /** Fetch one object's metadata; resolves with `null` when it does not exist. */
+  head(key: string): PromiseLike<object | null>;
+}
+/** Options for `r2Probe()`. */
+interface R2ProbeOptions extends ProbeOverrides {
+  /** The `R2Bucket` binding from `env`. */
+  readonly bucket: R2LikeBucket;
+  /** Object key to `HEAD`. Default `r2DefaultKey`; it does not need to exist. */
+  readonly key?: string;
+}
+/** A probe that heads `key`; non-critical by default. Throws `ProbeConfigError` without `head()` or with an empty `key`. */
+declare function r2Probe(options: R2ProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { R2LikeBucket, R2ProbeOptions, r2DefaultKey, r2DefaultName, r2Probe };
+//# 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":";;;;;cAyBa,aAAA;;cAEA,YAAA;;UAGI,YAAA;;qBAEI;;;UAIJ,cAAA,SAAuB;;mBAErB;;;;;iBAMH,OAAA,UAAiB,iBAAiB"}

package/dist/mod.d.ts

@@ -0,0 +1,26 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const r2DefaultName = "storage";
+/** Object key checked when `key` is unset. */
+declare const r2DefaultKey = "health";
+/** The subset of an `R2Bucket` binding the probe uses. */
+interface R2LikeBucket {
+  /** Fetch one object's metadata; resolves with `null` when it does not exist. */
+  head(key: string): PromiseLike<object | null>;
+}
+/** Options for `r2Probe()`. */
+interface R2ProbeOptions extends ProbeOverrides {
+  /** The `R2Bucket` binding from `env`. */
+  readonly bucket: R2LikeBucket;
+  /** Object key to `HEAD`. Default `r2DefaultKey`; it does not need to exist. */
+  readonly key?: string;
+}
+/** A probe that heads `key`; non-critical by default. Throws `ProbeConfigError` without `head()` or with an empty `key`. */
+declare function r2Probe(options: R2ProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { R2LikeBucket, R2ProbeOptions, r2DefaultKey, r2DefaultName, r2Probe };
+//# 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":";;;;;cAyBa,aAAA;;cAEA,YAAA;;UAGI,YAAA;;qBAEI;;;UAIJ,cAAA,SAAuB;;mBAErB;;;;;iBAMH,OAAA,UAAiB,iBAAiB"}

package/dist/mod.js

@@ -0,0 +1,33 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const r2DefaultName = "storage";
+/** Object key checked when `key` is unset. */
+const r2DefaultKey = "health";
+/** A probe that heads `key`; non-critical by default. Throws `ProbeConfigError` without `head()` or with an empty `key`. */
+function r2Probe(options) {
+	const bucket = options.bucket;
+	if (typeof bucket?.head !== "function") throw new ProbeConfigError("r2Probe", "bucket", `must expose head(), got ${describe(bucket)}`);
+	const key = options.key ?? r2DefaultKey;
+	if (typeof key !== "string" || key.length === 0) throw new ProbeConfigError("r2Probe", "key", typeof key !== "string" ? `must be a string, got ${String(key)}` : "must not be empty");
+	return {
+		name: options.name ?? r2DefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await bucket.head(key);
+		}
+	};
+}
+function describe(bucket) {
+	if (bucket == null) return String(bucket);
+	if (typeof bucket !== "object") return typeof bucket;
+	const keys = Object.keys(bucket);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+export { r2DefaultKey, r2DefaultName, r2Probe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: R2ProbeOptions","bucket: R2LikeBucket"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Cloudflare R2 probe for `@openstatus/health`: sends a `HEAD` for one\n * object through an `R2Bucket` binding.\n *\n * ```ts\n * import { createLazyHealthHandler } from \"@openstatus/health\";\n * import { r2Probe } from \"@openstatus/health-cloudflare-r2\";\n *\n * export default {\n *   fetch: createLazyHealthHandler<Request, Env>((env) => ({\n *     probes: [r2Probe({ bucket: env.UPLOADS })],\n *   })),\n * };\n * ```\n *\n * @module\n */\n\nimport {\n  type Probe,\n  ProbeConfigError,\n  type ProbeOverrides,\n} from \"@openstatus/health\";\n\n/** Probe name when `name` is unset. */\nexport const r2DefaultName = \"storage\";\n/** Object key checked when `key` is unset. */\nexport const r2DefaultKey = \"health\";\n\n/** The subset of an `R2Bucket` binding the probe uses. */\nexport interface R2LikeBucket {\n  /** Fetch one object's metadata; resolves with `null` when it does not exist. */\n  head(key: string): PromiseLike<object | null>;\n}\n\n/** Options for `r2Probe()`. */\nexport interface R2ProbeOptions extends ProbeOverrides {\n  /** The `R2Bucket` binding from `env`. */\n  readonly bucket: R2LikeBucket;\n  /** Object key to `HEAD`. Default `r2DefaultKey`; it does not need to exist. */\n  readonly key?: string;\n}\n\n/** A probe that heads `key`; non-critical by default. Throws `ProbeConfigError` without `head()` or with an empty `key`. */\nexport function r2Probe(options: R2ProbeOptions): Probe {\n  const bucket = options.bucket;\n  if (typeof bucket?.head !== \"function\") {\n    throw new ProbeConfigError(\n      \"r2Probe\",\n      \"bucket\",\n      `must expose head(), got ${describe(bucket)}`,\n    );\n  }\n  const key = options.key ?? r2DefaultKey;\n  if (typeof key !== \"string\" || key.length === 0) {\n    throw new ProbeConfigError(\n      \"r2Probe\",\n      \"key\",\n      typeof key !== \"string\"\n        ? `must be a string, got ${String(key)}`\n        : \"must not be empty\",\n    );\n  }\n  return {\n    name: options.name ?? r2DefaultName,\n    critical: options.critical ?? false,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async () => {\n      await bucket.head(key);\n    },\n  };\n}\n\nfunction describe(bucket: R2LikeBucket): string {\n  if (bucket == null) return String(bucket);\n  if (typeof bucket !== \"object\") return typeof bucket;\n  const keys = Object.keys(bucket);\n  return keys.length === 0\n    ? \"an object with no keys\"\n    : `an object with keys ${keys.slice(0, 8).join(\", \")}`;\n}\n"],"mappings":";;;;AAyBA,MAAa,gBAAgB;;AAE7B,MAAa,eAAe;;AAiB5B,SAAgB,QAAQA,SAAgC;CACtD,MAAM,SAAS,QAAQ;AACvB,YAAW,QAAQ,SAAS,WAC1B,OAAM,IAAI,iBACR,WACA,WACC,0BAA0B,SAAS,OAAO,CAAC;CAGhD,MAAM,MAAM,QAAQ,OAAO;AAC3B,YAAW,QAAQ,YAAY,IAAI,WAAW,EAC5C,OAAM,IAAI,iBACR,WACA,cACO,QAAQ,YACV,wBAAwB,OAAO,IAAI,CAAC,IACrC;AAGR,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,YAAY;AACf,SAAM,OAAO,KAAK,IAAI;EACvB;CACF;AACF;AAED,SAAS,SAASC,QAA8B;AAC9C,KAAI,UAAU,KAAM,QAAO,OAAO,OAAO;AACzC,YAAW,WAAW,SAAU,eAAc;CAC9C,MAAM,OAAO,OAAO,KAAK,OAAO;AAChC,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-r2",
+  "version": "0.1.4-dev.0",
+  "description": "Cloudflare R2 probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "cloudflare",
+    "r2",
+    "workers",
+    "storage",
+    "s3"
+  ],
+  "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-r2/"
+  },
+  "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"
+  }
+}