From 35af12aac2fd06bfc0bb805a41a5b4a71fe75a8a Mon Sep 17 00:00:00 2001 From: Aric Camarata Date: Tue, 30 Jun 2026 14:59:56 -0400 Subject: [PATCH] add opt-in telemetry via @acamarata/telemetry (off by default) --- TELEMETRY.md | 8 ++++++++ package.json | 3 ++- src/index.ts | 11 +++++++++++ 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 TELEMETRY.md diff --git a/TELEMETRY.md b/TELEMETRY.md new file mode 100644 index 0000000..99cfaa4 --- /dev/null +++ b/TELEMETRY.md @@ -0,0 +1,8 @@ +# Telemetry Disclosure + +This package supports opt-in anonymous usage telemetry via [`@acamarata/telemetry`](https://github.com/acamarata/telemetry). + +Telemetry is **off by default**. No data is sent unless you set `ACAMARATA_TELEMETRY=1`. + +Full disclosure (what is sent, where it goes, how to disable): +[github.com/acamarata/telemetry/blob/main/TELEMETRY.md](https://github.com/acamarata/telemetry/blob/main/TELEMETRY.md) diff --git a/package.json b/package.json index f4855ff..bc0cf37 100644 --- a/package.json +++ b/package.json @@ -58,7 +58,8 @@ "typedoc": "^0.28.19", "typedoc-plugin-markdown": "^4.11.0", "typescript": "^5.9.3", - "typescript-eslint": "^8.56.1" + "typescript-eslint": "^8.56.1", + "@acamarata/telemetry": "^0.1.0" }, "publishConfig": { "access": "public", diff --git a/src/index.ts b/src/index.ts index a6366b1..9769f02 100644 --- a/src/index.ts +++ b/src/index.ts @@ -72,3 +72,14 @@ export { ODEH_DESCRIPTIONS, WGS84, } from "./types.js"; + +// ── Opt-in anonymous telemetry ──────────────────────────────────────────────── +// Off by default. Enable: ACAMARATA_TELEMETRY=1 +// What is sent + how to disable: https://github.com/acamarata/telemetry/blob/main/TELEMETRY.md +import('@acamarata/telemetry') + .then(({ track }) => + track('load', { package: 'moon-sighting', version: '1.1.2' }), + ) + .catch(() => { + // telemetry not installed or disabled — that's fine + });