@openstatus/health-algolia 0.1.4-dev.0

package/README.md

@@ -0,0 +1,79 @@
+# @openstatus/health-algolia
+
+[Algolia](https://www.algolia.com/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Sends
+`GET /1/isalive` to your application's DSN host with the application ID and
+an API key in the Algolia headers, so it proves both that the search API
+answers and that the key is valid — with `fetch` alone, on every runtime.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-algolia
+npm install @openstatus/health @openstatus/health-algolia
+```
+
+```ts
+import { createHealthHandler, readEnv } from "@openstatus/health";
+import { algoliaProbe } from "@openstatus/health-algolia";
+
+const appId = readEnv("ALGOLIA_APP_ID");
+const apiKey = readEnv("ALGOLIA_SEARCH_KEY");
+
+Deno.serve(
+  createHealthHandler({
+    probes: [
+      // the factory validates `appId` and `apiKey` at construction, so pass
+      // placeholders and let `skip` keep the unconfigured check from running.
+      algoliaProbe({
+        appId: appId || "unconfigured",
+        apiKey: apiKey || "unconfigured",
+        skip: () => !appId || !apiKey,
+      }),
+    ],
+  }),
+);
+```
+
+`appId` is the application ID and `apiKey` any key of that application —
+the search-only key is enough and is the least privilege that still
+authenticates. The request goes to `https://{appId}-dsn.algolia.net`, the
+DSN host that fans out across the application's cluster and the same one the
+search client uses; pass `baseUrl` to target a specific replica instead.
+`/1/isalive` is the endpoint Algolia documents for exactly this and has no
+side effects, so the probe can run on every health request. Like every
+probe here, this one never reads the environment itself — pass the values
+in, and use `skip` for environments where Algolia is not configured.
+
+```ts
+algoliaProbe({
+  appId: appId || "unconfigured",
+  apiKey: apiKey || "unconfigured",
+  // optional overrides from the Probe contract
+  name: "algolia",
+  critical: true,
+  timeoutMs: 1000,
+  skip: () => !appId || !apiKey,
+});
+```
+
+Non-critical by default: search is usually one feature of a service rather
+than its request path, so an outage degrades the report instead of taking
+the service out of rotation. Set `critical: true` when requests cannot be
+served without it.
+
+## 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,45 @@
+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 algoliaDefaultName = "search";
+/** The DSN host for an application, used when `baseUrl` is unset. */
+function algoliaDsnUrl(appId) {
+	return `https://${appId.toLowerCase()}-dsn.algolia.net`;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/1/isalive` with the application headers; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey`, an `appId` that is not alphanumeric, or an invalid `baseUrl`. */
+function algoliaProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	for (const field of ["appId", "apiKey"]) {
+		const value = options[field];
+		if (typeof value !== "string" || value.length === 0) throw new __openstatus_health.ProbeConfigError("algoliaProbe", field, typeof value !== "string" ? `must be a string, got ${String(value)}` : "must not be empty");
+	}
+	if (!/^[A-Za-z0-9]+$/.test(options.appId)) throw new __openstatus_health.ProbeConfigError("algoliaProbe", "appId", `must be alphanumeric, got ${JSON.stringify(options.appId)}`);
+	const url = (0, __openstatus_health.probeUrl)({
+		probe: "algoliaProbe",
+		field: "baseUrl",
+		value: options.baseUrl ?? algoliaDsnUrl(options.appId),
+		path: "/1/isalive"
+	});
+	const headers = {
+		"x-algolia-application-id": options.appId,
+		"x-algolia-api-key": options.apiKey
+	};
+	return {
+		name: options.name ?? algoliaDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: (signal) => (0, __openstatus_health.expectOk)(doFetch(url, {
+			method: "GET",
+			headers,
+			signal
+		}))
+	};
+}
+
+//#endregion
+exports.algoliaDefaultName = algoliaDefaultName;
+exports.algoliaDsnUrl = algoliaDsnUrl;
+exports.algoliaProbe = algoliaProbe;

package/dist/mod.d.cts

@@ -0,0 +1,25 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const algoliaDefaultName = "search";
+/** The DSN host for an application, used when `baseUrl` is unset. */
+declare function algoliaDsnUrl(appId: string): string;
+/** Options for `algoliaProbe()`. */
+interface AlgoliaProbeOptions extends ProbeOverrides {
+  /** The application ID. */
+  readonly appId: string;
+  /** Any API key of the application; a search-only key is enough. */
+  readonly apiKey: string;
+  /** API host. Default `algoliaDsnUrl(appId)`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/1/isalive` with the application headers; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey`, an `appId` that is not alphanumeric, or an invalid `baseUrl`. */
+declare function algoliaProbe(options: AlgoliaProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { AlgoliaProbeOptions, algoliaDefaultName, algoliaDsnUrl, algoliaProbe };
+//# 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":";;;;;AA0C4D,cApB/C,kBAAA,GAoB+C,QAAA;AAAK;iBAjBjD,aAAA;;UAKC,mBAAA,SAA4B;;;;;;8BAMf;;0BAEJ;;;iBAIV,YAAA,UAAsB,sBAAsB"}

package/dist/mod.d.ts

@@ -0,0 +1,25 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const algoliaDefaultName = "search";
+/** The DSN host for an application, used when `baseUrl` is unset. */
+declare function algoliaDsnUrl(appId: string): string;
+/** Options for `algoliaProbe()`. */
+interface AlgoliaProbeOptions extends ProbeOverrides {
+  /** The application ID. */
+  readonly appId: string;
+  /** Any API key of the application; a search-only key is enough. */
+  readonly apiKey: string;
+  /** API host. Default `algoliaDsnUrl(appId)`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/1/isalive` with the application headers; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey`, an `appId` that is not alphanumeric, or an invalid `baseUrl`. */
+declare function algoliaProbe(options: AlgoliaProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { AlgoliaProbeOptions, algoliaDefaultName, algoliaDsnUrl, algoliaProbe };
+//# 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":";;;;;AA0C4D,cApB/C,kBAAA,GAoB+C,QAAA;AAAK;iBAjBjD,aAAA;;UAKC,mBAAA,SAA4B;;;;;;8BAMf;;0BAEJ;;;iBAIV,YAAA,UAAsB,sBAAsB"}

package/dist/mod.js

@@ -0,0 +1,43 @@
+import { ProbeConfigError, expectOk, probeUrl } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const algoliaDefaultName = "search";
+/** The DSN host for an application, used when `baseUrl` is unset. */
+function algoliaDsnUrl(appId) {
+	return `https://${appId.toLowerCase()}-dsn.algolia.net`;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/1/isalive` with the application headers; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey`, an `appId` that is not alphanumeric, or an invalid `baseUrl`. */
+function algoliaProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	for (const field of ["appId", "apiKey"]) {
+		const value = options[field];
+		if (typeof value !== "string" || value.length === 0) throw new ProbeConfigError("algoliaProbe", field, typeof value !== "string" ? `must be a string, got ${String(value)}` : "must not be empty");
+	}
+	if (!/^[A-Za-z0-9]+$/.test(options.appId)) throw new ProbeConfigError("algoliaProbe", "appId", `must be alphanumeric, got ${JSON.stringify(options.appId)}`);
+	const url = probeUrl({
+		probe: "algoliaProbe",
+		field: "baseUrl",
+		value: options.baseUrl ?? algoliaDsnUrl(options.appId),
+		path: "/1/isalive"
+	});
+	const headers = {
+		"x-algolia-application-id": options.appId,
+		"x-algolia-api-key": options.apiKey
+	};
+	return {
+		name: options.name ?? algoliaDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: (signal) => expectOk(doFetch(url, {
+			method: "GET",
+			headers,
+			signal
+		}))
+	};
+}
+
+//#endregion
+export { algoliaDefaultName, algoliaDsnUrl, algoliaProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["appId: string","options: AlgoliaProbeOptions"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Algolia reachability probe for `@openstatus/health`, against `/1/isalive`\n * on the application's DSN host.\n *\n * ```ts\n * import { algoliaProbe } from \"@openstatus/health-algolia\";\n *\n * const probe = algoliaProbe({ appId: env.ALGOLIA_APP_ID, apiKey: env.ALGOLIA_SEARCH_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/** Probe name when `name` is unset. */\nexport const algoliaDefaultName = \"search\";\n\n/** The DSN host for an application, used when `baseUrl` is unset. */\nexport function algoliaDsnUrl(appId: string): string {\n  return `https://${appId.toLowerCase()}-dsn.algolia.net`;\n}\n\n/** Options for `algoliaProbe()`. */\nexport interface AlgoliaProbeOptions extends ProbeOverrides {\n  /** The application ID. */\n  readonly appId: string;\n  /** Any API key of the application; a search-only key is enough. */\n  readonly apiKey: string;\n  /** API host. Default `algoliaDsnUrl(appId)`. */\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}/1/isalive` with the application headers; non-critical by default. Throws `ProbeConfigError` for an empty `apiKey`, an `appId` that is not alphanumeric, or an invalid `baseUrl`. */\nexport function algoliaProbe(options: AlgoliaProbeOptions): Probe {\n  const doFetch = options.fetch ?? globalThis.fetch;\n  for (const field of [\"appId\", \"apiKey\"] as const) {\n    const value = options[field];\n    if (typeof value !== \"string\" || value.length === 0) {\n      throw new ProbeConfigError(\n        \"algoliaProbe\",\n        field,\n        typeof value !== \"string\"\n          ? `must be a string, got ${String(value)}`\n          : \"must not be empty\",\n      );\n    }\n  }\n  if (!/^[A-Za-z0-9]+$/.test(options.appId)) {\n    throw new ProbeConfigError(\n      \"algoliaProbe\",\n      \"appId\",\n      `must be alphanumeric, got ${JSON.stringify(options.appId)}`,\n    );\n  }\n  const url = probeUrl({\n    probe: \"algoliaProbe\",\n    field: \"baseUrl\",\n    value: options.baseUrl ?? algoliaDsnUrl(options.appId),\n    path: \"/1/isalive\",\n  });\n  const headers = {\n    \"x-algolia-application-id\": options.appId,\n    \"x-algolia-api-key\": options.apiKey,\n  };\n  return {\n    name: options.name ?? algoliaDefaultName,\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":";;;;AAsBA,MAAa,qBAAqB;;AAGlC,SAAgB,cAAcA,OAAuB;AACnD,SAAQ,UAAU,MAAM,aAAa,CAAC;AACvC;;AAeD,SAAgB,aAAaC,SAAqC;CAChE,MAAM,UAAU,QAAQ,SAAS,WAAW;AAC5C,MAAK,MAAM,SAAS,CAAC,SAAS,QAAS,GAAW;EAChD,MAAM,QAAQ,QAAQ;AACtB,aAAW,UAAU,YAAY,MAAM,WAAW,EAChD,OAAM,IAAI,iBACR,gBACA,cACO,UAAU,YACZ,wBAAwB,OAAO,MAAM,CAAC,IACvC;CAGT;AACD,MAAK,iBAAiB,KAAK,QAAQ,MAAM,CACvC,OAAM,IAAI,iBACR,gBACA,UACC,4BAA4B,KAAK,UAAU,QAAQ,MAAM,CAAC;CAG/D,MAAM,MAAM,SAAS;EACnB,OAAO;EACP,OAAO;EACP,OAAO,QAAQ,WAAW,cAAc,QAAQ,MAAM;EACtD,MAAM;CACP,EAAC;CACF,MAAM,UAAU;EACd,4BAA4B,QAAQ;EACpC,qBAAqB,QAAQ;CAC9B;AACD,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,60 @@
+{
+  "name": "@openstatus/health-algolia",
+  "version": "0.1.4-dev.0",
+  "description": "Algolia probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "algolia",
+    "search"
+  ],
+  "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/algolia/"
+  },
+  "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"
+  }
+}