@openstatus/health-posthog 0.1.4-dev.0

package/README.md

@@ -0,0 +1,79 @@
+# @openstatus/health-posthog
+
+[PostHog](https://posthog.com/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Sends
+`GET {baseUrl}/api/projects/@current/` with a personal API key as a bearer
+header, so it proves both that the PostHog API answers and that the key is
+valid — with `fetch` alone, on every runtime.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-posthog
+npm install @openstatus/health @openstatus/health-posthog
+```
+
+```ts
+import { createHealthHandler, readEnv } from "@openstatus/health";
+import { posthogProbe } from "@openstatus/health-posthog";
+
+const personalApiKey = readEnv("POSTHOG_PERSONAL_API_KEY");
+
+Deno.serve(
+  createHealthHandler({
+    probes: [
+      // the factory validates `personalApiKey` at construction, so pass a
+      // placeholder and let `skip` keep the unconfigured check from running.
+      posthogProbe({
+        personalApiKey: personalApiKey || "unconfigured",
+        skip: () => !personalApiKey,
+      }),
+    ],
+  }),
+);
+```
+
+`personalApiKey` is a `phx_…` personal API key with the `project:read` scope —
+not the `phc_…` project token the browser SDK uses, which cannot call the
+private API. Reading the current project is a cheap read with no side effects,
+so the probe can run on every health request. `baseUrl` defaults to
+`https://us.posthog.com`; pass `https://eu.posthog.com` for EU Cloud or the
+URL of a self-hosted instance. Like every probe here, this one never reads the
+environment itself — pass the values in, and use `skip` for environments where
+PostHog is not configured.
+
+This proves the API your server calls for feature-flag definitions and queries
+is reachable. Event capture goes to the ingestion host (`us.i.posthog.com` /
+`eu.i.posthog.com`), which the SDKs buffer and retry on their own.
+
+```ts
+posthogProbe({
+  personalApiKey,
+  // optional overrides from the Probe contract
+  name: "analytics",
+  critical: true,
+  timeoutMs: 2000,
+  skip: () => !personalApiKey,
+});
+```
+
+Non-critical by default: analytics and feature flags are evaluated from cached
+definitions, so an outage degrades the report instead of taking the service
+out of rotation. Set `critical: true` when requests block on a live flag
+evaluation.
+
+## 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 posthogDefaultBaseUrl = "https://us.posthog.com";
+/** Probe name when `name` is unset. */
+const posthogDefaultName = "posthog";
+/** A probe that expects 2xx from `GET {baseUrl}/api/projects/@current/` with `personalApiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `personalApiKey` or an invalid `baseUrl`. */
+function posthogProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	const url = (0, __openstatus_health.probeUrl)({
+		probe: "posthogProbe",
+		field: "baseUrl",
+		value: options.baseUrl ?? posthogDefaultBaseUrl,
+		path: "/api/projects/@current/"
+	});
+	if (typeof options.personalApiKey !== "string" || options.personalApiKey.length === 0) throw new __openstatus_health.ProbeConfigError("posthogProbe", "personalApiKey", typeof options.personalApiKey !== "string" ? `must be a string, got ${String(options.personalApiKey)}` : "must not be empty");
+	const headers = { authorization: `Bearer ${options.personalApiKey}` };
+	return {
+		name: options.name ?? posthogDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: (signal) => (0, __openstatus_health.expectOk)(doFetch(url, {
+			method: "GET",
+			headers,
+			signal
+		}))
+	};
+}
+
+//#endregion
+exports.posthogDefaultBaseUrl = posthogDefaultBaseUrl;
+exports.posthogDefaultName = posthogDefaultName;
+exports.posthogProbe = posthogProbe;

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 posthogDefaultBaseUrl = "https://us.posthog.com";
+/** Probe name when `name` is unset. */
+declare const posthogDefaultName = "posthog";
+/** Options for `posthogProbe()`. */
+interface PosthogProbeOptions extends ProbeOverrides {
+  /** A personal API key (`phx_…`) with `project:read` scope. */
+  readonly personalApiKey: string;
+  /** API host. Default `posthogDefaultBaseUrl`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/api/projects/@current/` with `personalApiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `personalApiKey` or an invalid `baseUrl`. */
+declare function posthogProbe(options: PosthogProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PosthogProbeOptions, posthogDefaultBaseUrl, posthogDefaultName, posthogProbe };
+//# 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":";;;;;AAoCsC,cAfzB,qBAAA,GAeyB,wBAAA;;AAA2B,cAbpD,kBAAA,GAaoD,SAAA;;UAVhD,mBAAA,SAA4B;;;;8BAIf;;0BAEJ;;;iBAIV,YAAA,UAAsB,sBAAsB"}

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 posthogDefaultBaseUrl = "https://us.posthog.com";
+/** Probe name when `name` is unset. */
+declare const posthogDefaultName = "posthog";
+/** Options for `posthogProbe()`. */
+interface PosthogProbeOptions extends ProbeOverrides {
+  /** A personal API key (`phx_…`) with `project:read` scope. */
+  readonly personalApiKey: string;
+  /** API host. Default `posthogDefaultBaseUrl`. */
+  readonly baseUrl?: string | URL;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects 2xx from `GET {baseUrl}/api/projects/@current/` with `personalApiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `personalApiKey` or an invalid `baseUrl`. */
+declare function posthogProbe(options: PosthogProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PosthogProbeOptions, posthogDefaultBaseUrl, posthogDefaultName, posthogProbe };
+//# 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":";;;;;AAoCsC,cAfzB,qBAAA,GAeyB,wBAAA;;AAA2B,cAbpD,kBAAA,GAaoD,SAAA;;UAVhD,mBAAA,SAA4B;;;;8BAIf;;0BAEJ;;;iBAIV,YAAA,UAAsB,sBAAsB"}

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

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: PosthogProbeOptions"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * PostHog reachability probe for `@openstatus/health`, against `/api/projects/@current/`.\n *\n * ```ts\n * import { posthogProbe } from \"@openstatus/health-posthog\";\n *\n * const probe = posthogProbe({ personalApiKey: env.POSTHOG_PERSONAL_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 posthogDefaultBaseUrl = \"https://us.posthog.com\";\n/** Probe name when `name` is unset. */\nexport const posthogDefaultName = \"posthog\";\n\n/** Options for `posthogProbe()`. */\nexport interface PosthogProbeOptions extends ProbeOverrides {\n  /** A personal API key (`phx_…`) with `project:read` scope. */\n  readonly personalApiKey: string;\n  /** API host. Default `posthogDefaultBaseUrl`. */\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}/api/projects/@current/` with `personalApiKey` as a bearer token; non-critical by default. Throws `ProbeConfigError` for an empty `personalApiKey` or an invalid `baseUrl`. */\nexport function posthogProbe(options: PosthogProbeOptions): Probe {\n  const doFetch = options.fetch ?? globalThis.fetch;\n  const url = probeUrl({\n    probe: \"posthogProbe\",\n    field: \"baseUrl\",\n    value: options.baseUrl ?? posthogDefaultBaseUrl,\n    path: \"/api/projects/@current/\",\n  });\n  if (\n    typeof options.personalApiKey !== \"string\" ||\n    options.personalApiKey.length === 0\n  ) {\n    throw new ProbeConfigError(\n      \"posthogProbe\",\n      \"personalApiKey\",\n      typeof options.personalApiKey !== \"string\"\n        ? `must be a string, got ${String(options.personalApiKey)}`\n        : \"must not be empty\",\n    );\n  }\n  const headers = { authorization: `Bearer ${options.personalApiKey}` };\n  return {\n    name: options.name ?? posthogDefaultName,\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,wBAAwB;;AAErC,MAAa,qBAAqB;;AAalC,SAAgB,aAAaA,SAAqC;CAChE,MAAM,UAAU,QAAQ,SAAS,WAAW;CAC5C,MAAM,MAAM,SAAS;EACnB,OAAO;EACP,OAAO;EACP,OAAO,QAAQ,WAAW;EAC1B,MAAM;CACP,EAAC;AACF,YACS,QAAQ,mBAAmB,YAClC,QAAQ,eAAe,WAAW,EAElC,OAAM,IAAI,iBACR,gBACA,yBACO,QAAQ,mBAAmB,YAC7B,wBAAwB,OAAO,QAAQ,eAAe,CAAC,IACxD;CAGR,MAAM,UAAU,EAAE,gBAAgB,SAAS,QAAQ,eAAe,EAAG;AACrE,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-posthog",
+  "version": "0.1.4-dev.0",
+  "description": "PostHog API probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "posthog",
+    "analytics",
+    "feature-flags"
+  ],
+  "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/posthog/"
+  },
+  "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"
+  }
+}