@appland/telemetry 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# [@appland/telemetry-v1.1.0](https://github.com/getappmap/appmap-js/compare/@appland/telemetry-v1.0.0...@appland/telemetry-v1.1.0) (2025-10-07)
+
+
+### Bug Fixes
+
+* `git status` is now run with the porcelain flag ([#1328](https://github.com/getappmap/appmap-js/issues/1328)) ([c16eb48](https://github.com/getappmap/appmap-js/commit/c16eb48c293d49c06c0c4a3bb91c9a070e991831))
+* Don't hang when git is not found ([d2faa86](https://github.com/getappmap/appmap-js/commit/d2faa861b64b9ade63e729f894838fcf1efc8b2c))
+* Include contributor counts in `scan` ([1c5de40](https://github.com/getappmap/appmap-js/commit/1c5de40410ae2e1794509fb29e9ba128eaac18c0))
+* Include git contributor count in OpenAPI event ([4c9ee2c](https://github.com/getappmap/appmap-js/commit/4c9ee2c419d95ef0d09f5a12c90712bab890a8b7))
+* Prevent `git status` from potentially hanging ([41f4a08](https://github.com/getappmap/appmap-js/commit/41f4a087d382e1f3ef7d942c4dd83df1cd75585f))
+* Report git state ([a5d3797](https://github.com/getappmap/appmap-js/commit/a5d3797815b283ed114a57351067ed911ca36fa2))
+* **telemetry:** Minor UX and correctness improvements in telemetry ([c41bfca](https://github.com/getappmap/appmap-js/commit/c41bfca46fd8897d828ba9fce51a883d873cfc1f))
+* The Git proxy no longer alters the return type ([3c2be34](https://github.com/getappmap/appmap-js/commit/3c2be342dfc4548d96f7f3342b3146c058691143))
+
+
+### Features
+
+* Add event usage updates to `appmap index` ([dd5dfdb](https://github.com/getappmap/appmap-js/commit/dd5dfdb10c906546bf750a382a1387ccaf14df14))
+* **cli:** Use a configurable telemetry endpoint ([3de5d9f](https://github.com/getappmap/appmap-js/commit/3de5d9f1a322e6414d80d41f124f2e1d8995cc06))
+* Report env var names ([6264cb6](https://github.com/getappmap/appmap-js/commit/6264cb6c73927a90fc350bfb1531d3a8dd97df69))
+* Send git repository URL in appmap:openapi telemetry ([61de641](https://github.com/getappmap/appmap-js/commit/61de641ae05bdfb60558cfd91b69a5a15a6f0c98))
+* **telemetry:** Add an additional telemetry backend ([52d561e](https://github.com/getappmap/appmap-js/commit/52d561ea978f3369b3a6e59f9141debd1bf9bc46))
+* **telemetry:** Release @appland/telemetry as a package ([e001e9b](https://github.com/getappmap/appmap-js/commit/e001e9b2516b0e3c3d130be2dbe71d98e1849da7))

package/LICENSE.txt

@@ -0,0 +1,25 @@
+The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights under the License will not include,
+and the License does not grant to you, the right to Sell the Software.
+
+For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties,
+for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software),
+a product or service whose value derives, entirely or substantially, from the functionality of the Software.
+Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+
+Software: @appland/telemetry
+
+License: MIT License
+
+Copyright 2025, AppLand Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# AppMap Telemetry
+
+This package provides a shared telemetry client for AppMap projects. It supports multiple backends and offers flexible configuration options.
+
+## Usage
+
+```typescript
+import { Telemetry } from '@appland/telemetry';
+
+const telemetry = new Telemetry();
+
+telemetry.configure({
+  product: {
+    name: 'My App',
+    version: '1.0.0',
+  },
+});
+
+telemetry.sendEvent({
+  name: 'my-event',
+  properties: {
+    'my-property': 'my-value',
+  },
+  metrics: {
+    'my-metric': 123,
+  },
+});
+```
+
+## Configuration
+
+The telemetry client can be configured using environment variables.
+
+### General Configuration
+
+*   `APPMAP_TELEMETRY_DISABLED`: Set to `1`, `true`, or `yes` to disable telemetry.
+*   `APPMAP_TELEMETRY_DEBUG`: Set to `1`, `true`, or `yes` to enable debug logging, which will print telemetry events to the console.
+*   `APPMAP_TELEMETRY_BACKEND`: Specifies the telemetry backend to use. Supported values are `application-insights` (default) and `splunk`.
+
+### Splunk Backend
+
+When `APPMAP_TELEMETRY_BACKEND` is set to `splunk`, the following environment variables are used:
+
+*   `SPLUNK_TOKEN`: **(Required)** The Splunk HTTP Event Collector (HEC) token.
+*   `SPLUNK_URL`: **(Required)** The Splunk HEC URL.
+*   `SPLUNK_CA_CERT`: Used to configure TLS verification and custom Certificate Authorities (CAs).
+    *   **Not set (default):** TLS verification is disabled (`rejectUnauthorized: false`). This allows the use of self-signed certificates, which is common in Splunk deployments.
+    *   `system`: Use the system's trusted Certificate Authorities. TLS verification is enabled.
+    *   `@/path/to/ca.pem`: Use the specified file as the Certificate Authority. The path must be prefixed with `@`. TLS verification is enabled.
+    *   `<certificate content>`: Use the value of the environment variable as the Certificate Authority. TLS verification is enabled.
+
+### Application Insights Backend
+
+When `APPMAP_TELEMETRY_BACKEND` is set to `application-insights`, the client will use a default instrumentation key. This can be overridden by providing an `instrumentationKey` in the configuration:
+
+```typescript
+telemetry.configure({
+  // ...
+  backend: {
+    type: 'application-insights',
+    instrumentationKey: 'YOUR_INSTRUMENTATION_KEY',
+  },
+});
+```

package/dist/backends/application-insights.d.ts

@@ -0,0 +1,8 @@
+import { ApplicationInsightsBackendConfiguration, FlushCallback, TelemetryBackend, TelemetryData } from '../types';
+export declare class ApplicationInsightsBackend implements TelemetryBackend {
+    private readonly config;
+    private readonly client;
+    constructor(userId: string, sessionId: string, productName: string, config: ApplicationInsightsBackendConfiguration);
+    sendEvent(event: TelemetryData): void;
+    flush(callback?: FlushCallback): void;
+}

package/dist/backends/application-insights.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationInsightsBackend = void 0;
+const applicationinsights_1 = require("applicationinsights");
+// This key is meant to be publically shared. However, I'm adding a simple
+// obfuscation to mitigate key scraping bots on GitHub. The key is split on
+// hypens and base64 encoded without padding.
+// key.split('-').map((x) => x.toString('base64').replace(/=*/, ''))
+const INSTRUMENTATION_KEY = ['NTBjMWE1YzI', 'NDliNA', 'NDkxMw', 'YjdjYw', 'ODZhNzhkNDA3NDVm']
+    .map((x) => Buffer.from(x, 'base64').toString('utf8'))
+    .join('-');
+class ApplicationInsightsBackend {
+    constructor(userId, sessionId, productName, config) {
+        this.config = config;
+        process.env.APPLICATION_INSIGHTS_NO_STATSBEAT = '1';
+        const instrumentationKey = this.config.instrumentationKey || INSTRUMENTATION_KEY;
+        // Disable everything we can, we don't any additional collection from Application Insights.
+        (0, applicationinsights_1.setup)(instrumentationKey)
+            .setAutoCollectRequests(false)
+            .setAutoCollectPerformance(false)
+            .setAutoCollectExceptions(false)
+            .setAutoCollectDependencies(false)
+            .setAutoCollectHeartbeat(false)
+            .setAutoDependencyCorrelation(false)
+            .setAutoCollectConsole(false)
+            .setInternalLogging(false, false)
+            .setSendLiveMetrics(false)
+            .setUseDiskRetryCaching(true);
+        const client = new applicationinsights_1.TelemetryClient(instrumentationKey);
+        client.context.tags[client.context.keys.userId] = userId;
+        client.context.tags[client.context.keys.sessionId] = sessionId;
+        client.context.tags[client.context.keys.cloudRole] = productName;
+        client.setAutoPopulateAzureProperties(false);
+        this.client = client;
+    }
+    sendEvent(event) {
+        this.client.trackEvent(event);
+        this.client.flush();
+    }
+    flush(callback) {
+        this.client.flush();
+        callback === null || callback === void 0 ? void 0 : callback();
+    }
+}
+exports.ApplicationInsightsBackend = ApplicationInsightsBackend;
+//# sourceMappingURL=application-insights.js.map

package/dist/backends/application-insights.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-insights.js","sourceRoot":"","sources":["../../src/backends/application-insights.ts"],"names":[],"mappings":";;;AAMA,6DAAsF;AAEtF,0EAA0E;AAC1E,2EAA2E;AAC3E,6CAA6C;AAC7C,oEAAoE;AACpE,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC;KAC1F,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACrD,IAAI,CAAC,GAAG,CAAC,CAAC;AAEb,MAAa,0BAA0B;IAGrC,YACE,MAAc,EACd,SAAiB,EACjB,WAAmB,EACF,MAA+C;QAA/C,WAAM,GAAN,MAAM,CAAyC;QAEhE,OAAO,CAAC,GAAG,CAAC,iCAAiC,GAAG,GAAG,CAAC;QAEpD,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,IAAI,mBAAmB,CAAC;QACjF,2FAA2F;QAC3F,IAAA,2BAAW,EAAC,kBAAkB,CAAC;aAC5B,sBAAsB,CAAC,KAAK,CAAC;aAC7B,yBAAyB,CAAC,KAAK,CAAC;aAChC,wBAAwB,CAAC,KAAK,CAAC;aAC/B,0BAA0B,CAAC,KAAK,CAAC;aACjC,uBAAuB,CAAC,KAAK,CAAC;aAC9B,4BAA4B,CAAC,KAAK,CAAC;aACnC,qBAAqB,CAAC,KAAK,CAAC;aAC5B,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC;aAChC,kBAAkB,CAAC,KAAK,CAAC;aACzB,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAEhC,MAAM,MAAM,GAAG,IAAI,qCAAM,CAAC,kBAAkB,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;QACzD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;QAC/D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;QACjE,MAAM,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,SAAS,CAAC,KAAoB;QAC5B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,QAAwB;QAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,EAAI,CAAC;IACf,CAAC;CACF;AA3CD,gEA2CC"}

package/dist/backends/splunk.d.ts

@@ -0,0 +1,9 @@
+import type { SplunkBackendConfiguration, TelemetryBackend, TelemetryData, FlushCallback } from '../types';
+export declare class SplunkBackend implements TelemetryBackend {
+    private readonly config;
+    private readonly httpAgent;
+    private pendingRequests;
+    constructor(config?: Partial<SplunkBackendConfiguration>);
+    sendEvent(event: TelemetryData): void;
+    flush(callback?: FlushCallback): void;
+}

package/dist/backends/splunk.js

@@ -0,0 +1,153 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplunkBackend = void 0;
+const http = __importStar(require("node:http"));
+const https = __importStar(require("node:https"));
+const node_url_1 = require("node:url");
+const fs = __importStar(require("node:fs"));
+const DefaultSplunkPath = '/services/collector/event';
+const MaxFlushTime = 5000; // 5 seconds
+class SplunkBackend {
+    constructor(config = {}) {
+        var _a, _b;
+        this.pendingRequests = 0;
+        const token = (_a = config.token) !== null && _a !== void 0 ? _a : process.env.SPLUNK_TOKEN;
+        const url = (_b = config.url) !== null && _b !== void 0 ? _b : process.env.SPLUNK_URL;
+        if (!token) {
+            throw new Error('SPLUNK_TOKEN is required');
+        }
+        if (!url) {
+            throw new Error('SPLUNK_URL is required');
+        }
+        this.config = {
+            type: 'splunk',
+            token: token,
+            url: url,
+        };
+        const parsedUrl = new node_url_1.URL(this.config.url);
+        const isHttps = parsedUrl.protocol === 'https:';
+        if (isHttps) {
+            const splunkCaCert = process.env.SPLUNK_CA_CERT;
+            let httpsAgentOptions = {
+                rejectUnauthorized: false, // Self-signed certs are common in Splunk
+            };
+            if (splunkCaCert) {
+                if (splunkCaCert === 'system') {
+                    httpsAgentOptions = {
+                        rejectUnauthorized: true,
+                    };
+                }
+                else if (splunkCaCert.startsWith('@')) {
+                    const caPath = splunkCaCert.substring(1);
+                    httpsAgentOptions = {
+                        rejectUnauthorized: true,
+                        ca: fs.readFileSync(caPath),
+                    };
+                }
+                else {
+                    httpsAgentOptions = {
+                        rejectUnauthorized: true,
+                        ca: splunkCaCert,
+                    };
+                }
+            }
+            this.httpAgent = new https.Agent(httpsAgentOptions);
+        }
+        else {
+            this.httpAgent = new http.Agent();
+        }
+    }
+    sendEvent(event) {
+        this.pendingRequests++;
+        const parsedUrl = new node_url_1.URL(this.config.url);
+        const path = parsedUrl.pathname === '/' ? DefaultSplunkPath : parsedUrl.pathname;
+        const payload = JSON.stringify({ event });
+        const options = {
+            hostname: parsedUrl.hostname,
+            port: parsedUrl.port ? parseInt(parsedUrl.port, 10) : (parsedUrl.protocol === 'https:' ? 443 : 8088),
+            path: path,
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Content-Length': Buffer.byteLength(payload),
+                Authorization: `Splunk ${this.config.token}`,
+            },
+            agent: this.httpAgent,
+        };
+        const req = (parsedUrl.protocol === 'https:' ? https : http).request(options, (res) => {
+            let responseBody = '';
+            res.on('data', (chunk) => {
+                responseBody += chunk;
+            });
+            res.on('end', () => {
+                this.pendingRequests--;
+                if (res.statusCode && (res.statusCode < 200 || res.statusCode >= 300)) {
+                    console.warn(`SplunkBackend: Failed to send telemetry event. Status: ${res.statusCode}, Response: ${responseBody}`);
+                }
+            });
+        });
+        req.on('error', (e) => {
+            this.pendingRequests--;
+            console.warn(`SplunkBackend: Connectivity error sending telemetry event: ${e.message}`);
+        });
+        req.write(payload);
+        req.end();
+    }
+    flush(callback) {
+        const startTime = process.hrtime.bigint();
+        const checkPending = () => {
+            if (this.pendingRequests === 0) {
+                if (callback) {
+                    callback();
+                }
+                return;
+            }
+            const elapsedNs = process.hrtime.bigint() - startTime;
+            const elapsedMs = Number(elapsedNs / BigInt(1000000));
+            if (elapsedMs > MaxFlushTime) {
+                console.warn(`SplunkBackend: Flush timed out after ${MaxFlushTime}ms`);
+                if (callback) {
+                    callback();
+                }
+                return;
+            }
+            setTimeout(checkPending, 10); // Check again in 10ms
+        };
+        checkPending();
+    }
+}
+exports.SplunkBackend = SplunkBackend;
+//# sourceMappingURL=splunk.js.map

package/dist/backends/splunk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"splunk.js","sourceRoot":"","sources":["../../src/backends/splunk.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAkC;AAClC,kDAAoC;AACpC,uCAA+B;AAC/B,4CAA8B;AAS9B,MAAM,iBAAiB,GAAG,2BAA2B,CAAC;AACtD,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,YAAY;AAEvC,MAAa,aAAa;IAKxB,YAAY,SAA8C,EAAE;;QAFpD,oBAAe,GAAG,CAAC,CAAC;QAG1B,MAAM,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;QACvD,MAAM,GAAG,GAAG,MAAA,MAAM,CAAC,GAAG,mCAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;QAEjD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,KAAK;YACZ,GAAG,EAAE,GAAG;SACT,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,cAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,KAAK,QAAQ,CAAC;QAEhD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAChD,IAAI,iBAAiB,GAAuB;gBAC1C,kBAAkB,EAAE,KAAK,EAAE,yCAAyC;aACrE,CAAC;YAEF,IAAI,YAAY,EAAE,CAAC;gBACjB,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;oBAC9B,iBAAiB,GAAG;wBAClB,kBAAkB,EAAE,IAAI;qBACzB,CAAC;gBACJ,CAAC;qBAAM,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxC,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBACzC,iBAAiB,GAAG;wBAClB,kBAAkB,EAAE,IAAI;wBACxB,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC;qBAC5B,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,iBAAiB,GAAG;wBAClB,kBAAkB,EAAE,IAAI;wBACxB,EAAE,EAAE,YAAY;qBACjB,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IAED,SAAS,CAAC,KAAoB;QAC5B,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,IAAI,cAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC;QAEjF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAE1C,MAAM,OAAO,GAAwB;YACnC,QAAQ,EAAE,SAAS,CAAC,QAAQ;YAC5B,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;YACpG,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5C,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;aAC7C;YACD,KAAK,EAAE,IAAI,CAAC,SAAS;SACtB,CAAC;QAEF,MAAM,GAAG,GAAG,CAAC,SAAS,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACpF,IAAI,YAAY,GAAG,EAAE,CAAC;YACtB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACvB,YAAY,IAAI,KAAK,CAAC;YACxB,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,IAAI,CAAC,eAAe,EAAE,CAAC;gBACvB,IAAI,GAAG,CAAC,UAAU,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,GAAG,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,EAAE,CAAC;oBACtE,OAAO,CAAC,IAAI,CACV,0DAA0D,GAAG,CAAC,UAAU,eAAe,YAAY,EAAE,CACtG,CAAC;gBACJ,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnB,GAAG,CAAC,GAAG,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,QAAwB;QAC5B,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAE1C,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,IAAI,IAAI,CAAC,eAAe,KAAK,CAAC,EAAE,CAAC;gBAC/B,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,EAAE,CAAC;gBACb,CAAC;gBACD,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC;YACtD,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAEtD,IAAI,SAAS,GAAG,YAAY,EAAE,CAAC;gBAC7B,OAAO,CAAC,IAAI,CAAC,wCAAwC,YAAY,IAAI,CAAC,CAAC;gBACvE,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,EAAE,CAAC;gBACb,CAAC;gBACD,OAAO;YACT,CAAC;YAED,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,sBAAsB;QACtD,CAAC,CAAC;QAEF,YAAY,EAAE,CAAC;IACjB,CAAC;CACF;AA9HD,sCA8HC"}

package/dist/client.d.ts

@@ -0,0 +1,17 @@
+import type { FlushCallback, ITelemetryClient, TelemetryConfiguration, TelemetryData, TelemetryOptions } from './types';
+export declare class TelemetryClient implements ITelemetryClient {
+    private telemetryConfig?;
+    private backend?;
+    private userConfig?;
+    debug: boolean;
+    private session?;
+    enabled: boolean;
+    readonly machineId: string;
+    get sessionId(): string;
+    constructor(config?: Partial<TelemetryConfiguration>);
+    configure(config?: Partial<TelemetryConfiguration>): void;
+    sendEvent(data: TelemetryData, options?: TelemetryOptions): void;
+    flush(callback?: FlushCallback): void;
+}
+declare const defaultClient: TelemetryClient;
+export default defaultClient;

package/dist/client.js

@@ -0,0 +1,229 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetryClient = void 0;
+const conf_1 = __importDefault(require("conf"));
+const os = __importStar(require("os"));
+const identity_1 = require("./identity");
+const session_1 = require("./session");
+const read_pkg_up_1 = require("read-pkg-up");
+const path_1 = __importDefault(require("path"));
+const application_insights_1 = require("./backends/application-insights");
+const splunk_1 = require("./backends/splunk");
+/**
+ * Append the prefix to the name of each property and drop undefined values
+ */
+const transformProps = (obj, propPrefix) => {
+    const result = {};
+    for (const [k, v] of Object.entries(obj)) {
+        if (v === undefined)
+            continue;
+        if (k.includes('.')) {
+            result[k] = v;
+            continue;
+        }
+        const prefixedKey = k.startsWith(propPrefix) ? k : `${propPrefix}${k}`;
+        result[prefixedKey] = v;
+    }
+    return result;
+};
+function resolvePackageJson() {
+    var _a;
+    try {
+        let myPath = __dirname;
+        // If we're in a node_modules directory, go up to the consuming package root
+        const nodeModuleIndex = myPath.indexOf(`${path_1.default.sep}node_modules${path_1.default.sep}`);
+        if (nodeModuleIndex !== -1) {
+            myPath = myPath.substring(0, nodeModuleIndex);
+        }
+        const result = (_a = (0, read_pkg_up_1.sync)({ cwd: myPath })) === null || _a === void 0 ? void 0 : _a.packageJson;
+        if (result) {
+            return {
+                name: result.name,
+                version: result.version,
+            };
+        }
+    }
+    catch (error) {
+        console.error('Error resolving package.json:', error);
+        return undefined;
+    }
+}
+function defaultBackend() {
+    switch (process.env.APPMAP_TELEMETRY_BACKEND) {
+        case 'application-insights':
+        case 'splunk':
+            return {
+                type: process.env.APPMAP_TELEMETRY_BACKEND
+            };
+    }
+    // Default to application insights if no backend is specified
+    // or if the specified backend is not recognized.
+    // This is to maintain backward compatibility.
+    return { type: 'application-insights' };
+}
+function buildDefaultConfiguration(base = {}) {
+    const product = Object.assign({ name: '', version: '' }, base.product);
+    if (!product.name || !product.version) {
+        const pkg = resolvePackageJson();
+        product.name || (product.name = (pkg === null || pkg === void 0 ? void 0 : pkg.name) || 'unknown');
+        product.version || (product.version = (pkg === null || pkg === void 0 ? void 0 : pkg.version) || '0.0.0');
+    }
+    // By default, the prop prefix will be the product name with non-word characters replaced by dots.
+    const propPrefix = base.propPrefix || product.name.replace(/\W/g, '.').replace(/^\./, '') + '.';
+    return Object.assign({ product,
+        propPrefix, backend: defaultBackend() }, base);
+}
+/** Interpret a boolean as coming from an environment variable.
+ * If the value is undefined, return the defaultValue.
+ * If the value is '1', 'true', or 'yes' (case insensitive), return true.
+ * If the value is '0', 'false', or 'no' (case insensitive), return false.
+ * Otherwise, return the defaultValue.
+ */
+function stringToBool(value, defaultValue = false) {
+    if (value === undefined)
+        return defaultValue;
+    switch (value.toLowerCase()) {
+        case '1':
+        case 'true':
+        case 'yes':
+            return true;
+        case '0':
+        case 'false':
+        case 'no':
+            return false;
+        default:
+            return defaultValue;
+    }
+}
+class TelemetryClient {
+    get sessionId() {
+        if (!this.session) {
+            throw new Error('Session is not initialized');
+        }
+        return this.session.id;
+    }
+    constructor(config) {
+        this.debug = stringToBool(process.env.APPMAP_TELEMETRY_DEBUG);
+        this.enabled = !stringToBool(process.env.APPMAP_TELEMETRY_DISABLED);
+        this.machineId = (0, identity_1.getMachineId)();
+        if (config)
+            this.configure(config);
+    }
+    configure(config = {}) {
+        if (this.telemetryConfig) {
+            throw new Error('Telemetry client is already configured');
+        }
+        this.telemetryConfig = buildDefaultConfiguration(config);
+        this.userConfig = new conf_1.default({
+            projectName: this.telemetryConfig.product.name,
+            projectVersion: '0.0.1', // note this is actually config version
+        });
+        this.session = new session_1.Session(this.userConfig);
+        // Construct additional backends here as needed.
+        switch (this.telemetryConfig.backend.type) {
+            case 'application-insights':
+                this.backend = new application_insights_1.ApplicationInsightsBackend(this.machineId, this.session.id, this.telemetryConfig.product.name, this.telemetryConfig.backend);
+                break;
+            case 'custom':
+                this.backend = this.telemetryConfig.backend;
+                break;
+            case 'splunk':
+                this.backend = new splunk_1.SplunkBackend(this.telemetryConfig.backend);
+                break;
+        }
+        if (this.debug) {
+            console.warn('Telemetry configuration:', this.telemetryConfig);
+        }
+    }
+    sendEvent(data, options = { includeEnvironment: false }) {
+        if (!this.backend)
+            this.configure();
+        if (!this.backend || !this.telemetryConfig || !this.session)
+            throw new Error('Telemetry client is not configured');
+        try {
+            const { propPrefix } = this.telemetryConfig;
+            const { name, version } = this.telemetryConfig.product;
+            const transformedProperties = transformProps(Object.assign({ version: version, args: process.argv.slice(1).join(' ') }, data.properties), propPrefix);
+            const transformedMetrics = transformProps(data.metrics || {}, propPrefix);
+            const properties = Object.assign({ 'common.source': name, 'common.os': os.platform(), 'common.platformversion': os.release(), 'common.arch': os.arch(), 'appmap.cli.machineId': this.machineId, 'appmap.cli.sessionId': this.session.id }, transformedProperties);
+            if (options.includeEnvironment) {
+                properties['common.environmentVariables'] = Object.keys(process.env).sort().join(',');
+            }
+            const event = {
+                name: `${name}/${data.name}`,
+                measurements: transformedMetrics,
+                properties,
+            };
+            if (this.debug) {
+                console.warn(JSON.stringify(event, null, 2));
+            }
+            if (this.enabled) {
+                this.backend.sendEvent(event);
+                this.session.touch();
+                this.backend.flush();
+            }
+        }
+        catch (e) {
+            // Don't let telemetry fail the entire command
+            // Do nothing other than log for now, we can't do anything about it
+            if (this.debug) {
+                if (e instanceof Error) {
+                    console.error(e.stack);
+                }
+                else {
+                    console.error(e);
+                }
+            }
+        }
+    }
+    flush(callback) {
+        var _a;
+        if (this.enabled) {
+            (_a = this.backend) === null || _a === void 0 ? void 0 : _a.flush(callback);
+        }
+        else {
+            if (callback)
+                callback();
+        }
+    }
+}
+exports.TelemetryClient = TelemetryClient;
+const defaultClient = new TelemetryClient();
+exports.default = defaultClient;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,uCAAyB;AACzB,yCAA0C;AAC1C,uCAAoC;AACpC,6CAAwD;AAYxD,gDAAwB;AACxB,0EAA6E;AAC7E,8CAAkD;AAElD;;GAEG;AACH,MAAM,cAAc,GAAG,CACrB,GAAkC,EAClC,UAAkB,EACC,EAAE;IACrB,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,KAAK,SAAS;YAAE,SAAS;QAC9B,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACd,SAAS;QACX,CAAC;QACD,MAAM,WAAW,GAAG,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC;QACvE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,SAAS,kBAAkB;;IACzB,IAAI,CAAC;QACH,IAAI,MAAM,GAAG,SAAS,CAAC;QAEvB,4EAA4E;QAC5E,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,cAAI,CAAC,GAAG,eAAe,cAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC7E,IAAI,eAAe,KAAK,CAAC,CAAC,EAAE,CAAC;YAC3B,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,MAAM,GAAG,MAAA,IAAA,kBAAiB,EAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,0CAAE,WAAW,CAAC;QAC/D,IAAI,MAAM,EAAE,CAAC;YACX,OAAO;gBACL,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;QACtD,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,cAAc;IACrB,QAAQ,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,CAAC;QAC7C,KAAK,sBAAsB,CAAC;QAC5B,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB;aAC3C,CAAC;IACN,CAAC;IACD,6DAA6D;IAC7D,iDAAiD;IACjD,8CAA8C;IAC9C,OAAO,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC;AAC1C,CAAC;AAED,SAAS,yBAAyB,CAChC,OAAwC,EAAE;IAE1C,MAAM,OAAO,mBAAqC,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,IAAK,IAAI,CAAC,OAAO,CAAE,CAAC;IAC3F,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,kBAAkB,EAAE,CAAC;QACjC,OAAO,CAAC,IAAI,KAAZ,OAAO,CAAC,IAAI,GAAK,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,KAAI,SAAS,EAAC;QACxC,OAAO,CAAC,OAAO,KAAf,OAAO,CAAC,OAAO,GAAK,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,KAAI,OAAO,EAAC;IAC9C,CAAC;IAED,kGAAkG;IAClG,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC;IAEhG,uBACE,OAAO;QACP,UAAU,EACV,OAAO,EAAE,cAAc,EAAE,IACtB,IAAI,EACP;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,KAAyB,EAAE,YAAY,GAAG,KAAK;IACnE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,YAAY,CAAC;IAC7C,QAAQ,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QAC5B,KAAK,GAAG,CAAC;QACT,KAAK,MAAM,CAAC;QACZ,KAAK,KAAK;YACR,OAAO,IAAI,CAAC;QACd,KAAK,GAAG,CAAC;QACT,KAAK,OAAO,CAAC;QACb,KAAK,IAAI;YACP,OAAO,KAAK,CAAC;QACf;YACE,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC;AAED,MAAa,eAAe;IAS1B,IAAW,SAAS;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,YAAY,MAAwC;QAZ7C,UAAK,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAGzD,YAAO,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACtD,cAAS,GAAG,IAAA,uBAAY,GAAE,CAAC;QASzC,IAAI,MAAM;YAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAEM,SAAS,CAAC,SAA0C,EAAE;QAC3D,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC,eAAe,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,IAAI,cAAI,CAAC;YACzB,WAAW,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI;YAC9C,cAAc,EAAE,OAAO,EAAE,uCAAuC;SACjE,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE5C,gDAAgD;QAChD,QAAQ,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC1C,KAAK,sBAAsB;gBACzB,IAAI,CAAC,OAAO,GAAG,IAAI,iDAA0B,CAC3C,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,OAAO,CAAC,EAAE,EACf,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EACjC,IAAI,CAAC,eAAe,CAAC,OAAO,CAC7B,CAAC;gBACF,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;gBAC5C,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAa,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;gBAC/D,MAAM;QACV,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,SAAS,CAAC,IAAmB,EAAE,UAA4B,EAAE,kBAAkB,EAAE,KAAK,EAAE;QACtF,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,OAAO;YACzD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAExD,IAAI,CAAC;YACH,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC;YAC5C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;YACvD,MAAM,qBAAqB,GAAG,cAAc,iBAExC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAClC,IAAI,CAAC,UAAU,GAEpB,UAAU,CACX,CAAC;YACF,MAAM,kBAAkB,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;YAC1E,MAAM,UAAU,mBACd,eAAe,EAAE,IAAI,EACrB,WAAW,EAAE,EAAE,CAAC,QAAQ,EAAE,EAC1B,wBAAwB,EAAE,EAAE,CAAC,OAAO,EAAE,EACtC,aAAa,EAAE,EAAE,CAAC,IAAI,EAAE,EACxB,sBAAsB,EAAE,IAAI,CAAC,SAAS,EACtC,sBAAsB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IACpC,qBAAqB,CACzB,CAAC;YAEF,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;gBAC/B,UAAU,CAAC,6BAA6B,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxF,CAAC;YAED,MAAM,KAAK,GAAG;gBACZ,IAAI,EAAE,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;gBAC5B,YAAY,EAAE,kBAAkB;gBAChC,UAAU;aACX,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC/C,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC9B,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,8CAA8C;YAC9C,mEAAmE;YACnE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;oBACvB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBACzB,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAwB;;QAC5B,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAA,IAAI,CAAC,OAAO,0CAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ;gBAAE,QAAQ,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AAzHD,0CAyHC;AAED,MAAM,aAAa,GAAG,IAAI,eAAe,EAAE,CAAC;AAC5C,kBAAe,aAAa,CAAC"}

package/dist/git.d.ts

@@ -0,0 +1,34 @@
+import { PathLike } from 'fs';
+export declare enum GitState {
+    NotInstalled = 0,// The git cli was not found.
+    NoRepository = 1,// Git is installed but no repository was found.
+    Ok = 2
+}
+export declare const GitRepositoryEnvKeys: readonly ["GITHUB_REPOSITORY", "CIRCLE_REPOSITORY_URL", "GIT_URL", "CI_REPOSITORY_URL"];
+export declare const GitBranchEnvKeys: readonly ["GITHUB_REF_NAME", "CIRCLE_BRANCH", "GIT_BRANCH", "TRAVIS_BRANCH", "CI_COMMIT_REF_NAME"];
+export declare const GitCommitEnvKeys: readonly ["GITHUB_SHA", "CIRCLE_SHA1", "GIT_COMMIT", "TRAVIS_COMMIT", "CI_COMMIT_SHA"];
+/**
+ * This is a wrapper around `execFile` that returns a promise containing the stdout. `execFile` will
+ * not spawn a shell, so it is less likely to be vulnerable to shell injection attacks.
+ *
+ * @param {string} command - The command to execute. This should be resolvable via `PATH`, and contain no arguments.
+ * @param {string[]} args - The arguments to pass to the command.
+ * @param {object} [options] - Options to pass to `execFile`.
+ * @returns {Promise<string>} A promise containing the stdout of the command.
+ * @throws {Error} If the command fails with a non-zero (or anything other than the specified) exit code.
+ */
+export declare const execute: (command: string, args: string[], options?: {
+    cwd?: string;
+    exitCode?: number;
+    timeout?: number;
+}) => Promise<string>;
+declare class GitProperties {
+    static contributors(sinceDaysAgo: number, cwd?: PathLike): Promise<Array<string>>;
+    static repository(cwd?: PathLike): Promise<string | undefined>;
+    static branch(cwd?: PathLike): Promise<string | undefined>;
+    static commit(cwd?: PathLike): Promise<string | undefined>;
+    static state(cwd?: PathLike): Promise<GitState>;
+    static clearCache(): void;
+}
+export declare const Git: typeof GitProperties;
+export {};

package/dist/git.js

@@ -0,0 +1,211 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Git = exports.execute = exports.GitCommitEnvKeys = exports.GitBranchEnvKeys = exports.GitRepositoryEnvKeys = exports.GitState = void 0;
+const child_process_1 = require("child_process");
+var GitState;
+(function (GitState) {
+    GitState[GitState["NotInstalled"] = 0] = "NotInstalled";
+    GitState[GitState["NoRepository"] = 1] = "NoRepository";
+    GitState[GitState["Ok"] = 2] = "Ok";
+})(GitState || (exports.GitState = GitState = {}));
+exports.GitRepositoryEnvKeys = [
+    'GITHUB_REPOSITORY', // GitHub
+    'CIRCLE_REPOSITORY_URL', // CircleCI
+    'GIT_URL', // Jenkins
+    'CI_REPOSITORY_URL', // GitLab
+];
+exports.GitBranchEnvKeys = [
+    'GITHUB_REF_NAME', // GitHub
+    'CIRCLE_BRANCH', // CircleCI
+    'GIT_BRANCH', // Jenkins
+    'TRAVIS_BRANCH', // TravisCI
+    'CI_COMMIT_REF_NAME', // GitLab
+];
+exports.GitCommitEnvKeys = [
+    'GITHUB_SHA', // GitHub
+    'CIRCLE_SHA1', // CircleCI
+    'GIT_COMMIT', // Jenkins
+    'TRAVIS_COMMIT', // TravisCI
+    'CI_COMMIT_SHA', // GitLab
+];
+/**
+ * This is a wrapper around `execFile` that returns a promise containing the stdout. `execFile` will
+ * not spawn a shell, so it is less likely to be vulnerable to shell injection attacks.
+ *
+ * @param {string} command - The command to execute. This should be resolvable via `PATH`, and contain no arguments.
+ * @param {string[]} args - The arguments to pass to the command.
+ * @param {object} [options] - Options to pass to `execFile`.
+ * @returns {Promise<string>} A promise containing the stdout of the command.
+ * @throws {Error} If the command fails with a non-zero (or anything other than the specified) exit code.
+ */
+const execute = (command, args, options) => new Promise((resolve, reject) => {
+    var _a, _b, _c, _d;
+    const child = (0, child_process_1.execFile)(command, args, Object.assign({}, (options !== null && options !== void 0 ? options : {})));
+    let stdout = '';
+    (_a = child.stdout) === null || _a === void 0 ? void 0 : _a.setEncoding('utf8');
+    (_b = child.stdout) === null || _b === void 0 ? void 0 : _b.on('data', (data) => {
+        stdout += data.toString();
+    });
+    let stderr = '';
+    (_c = child.stderr) === null || _c === void 0 ? void 0 : _c.setEncoding('utf8');
+    (_d = child.stderr) === null || _d === void 0 ? void 0 : _d.on('data', (data) => {
+        stderr += data.toString();
+    });
+    child.on('close', (code) => {
+        var _a;
+        if (code === ((_a = options === null || options === void 0 ? void 0 : options.exitCode) !== null && _a !== void 0 ? _a : 0))
+            resolve(stdout);
+        else
+            reject(new Error(stderr));
+    });
+});
+exports.execute = execute;
+class GitProperties {
+    static contributors(sinceDaysAgo, cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const unixTimeNow = Math.floor(Number(new Date()) / 1000);
+            const unixTimeAgo = unixTimeNow - sinceDaysAgo * 24 * 60 * 60;
+            try {
+                const args = ['--no-pager', 'log', `--since=${unixTimeAgo}`, '--format="%ae"'];
+                if (cwd)
+                    args.unshift('-C', cwd.toString());
+                const stdout = yield (0, exports.execute)('git', args);
+                return [
+                    ...stdout
+                        .trim()
+                        .split('\n')
+                        .reduce((acc, email) => {
+                        acc.add(email);
+                        return acc;
+                    }, new Set()),
+                ];
+            }
+            catch (_a) {
+                return [];
+            }
+        });
+    }
+    // Returns the repository URL, first by checking the environment, then by
+    // shelling out to git.
+    static repository(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitRepositoryEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const args = ['config', '--get', 'remote.origin.url'];
+                if (cwd)
+                    args.unshift('-C', cwd.toString());
+                const stdout = yield (0, exports.execute)('git', args);
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
+    // Returns the branch, first by checking the environment, then by
+    // shelling out to git.
+    static branch(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitBranchEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const args = ['rev-parse', '--abbrev-ref', 'HEAD'];
+                if (cwd)
+                    args.unshift('-C', cwd.toString());
+                const stdout = yield (0, exports.execute)('git', args);
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
+    // Returns the commit SHA, first by checking the environment, then by
+    // shelling out to git.
+    static commit(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitCommitEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const args = ['rev-parse', 'HEAD'];
+                if (cwd)
+                    args.unshift('-C', cwd.toString());
+                const stdout = yield (0, exports.execute)('git', args);
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
+    static state(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve) => {
+                try {
+                    const commandProcess = (0, child_process_1.spawn)('git', ['status', '--porcelain'], {
+                        shell: true,
+                        cwd: cwd === null || cwd === void 0 ? void 0 : cwd.toString(),
+                        stdio: 'ignore',
+                        timeout: 2000,
+                    });
+                    commandProcess.on('exit', (code) => {
+                        switch (code) {
+                            case 127:
+                                return resolve(GitState.NotInstalled);
+                            case 128:
+                                return resolve(GitState.NoRepository);
+                            default:
+                                return resolve(GitState.Ok);
+                        }
+                    });
+                    commandProcess.on('error', () => resolve(GitState.NotInstalled));
+                }
+                catch (_a) {
+                    resolve(GitState.NotInstalled);
+                }
+            });
+        });
+    }
+    static clearCache() {
+        gitCache.clear();
+    }
+}
+const gitCache = new Map();
+const noCacheList = ['clearCache'];
+// GitProperties is available externally as Git.
+// This export provides a simple caching layer around GitProperties to avoid
+// excessive shelling out to git.
+exports.Git = new Proxy(GitProperties, {
+    get(target, prop) {
+        if (!noCacheList.includes(prop.toString()) &&
+            typeof target[prop] === 'function') {
+            return new Proxy(target[prop], {
+                apply(target, thisArg, argArray) {
+                    const cacheKey = `${prop.toString()}(${JSON.stringify(argArray)})`;
+                    if (gitCache.has(cacheKey)) {
+                        return gitCache.get(cacheKey);
+                    }
+                    /* eslint-disable-next-line @typescript-eslint/no-unsafe-function-type */
+                    const result = Reflect.apply(target, thisArg, argArray);
+                    gitCache.set(cacheKey, result);
+                    return result;
+                },
+            });
+        }
+        return Reflect.get(target, prop);
+    },
+});
+//# sourceMappingURL=git.js.map

package/dist/git.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"git.js","sourceRoot":"","sources":["../src/git.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAAgD;AAGhD,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,uDAAY,CAAA;IACZ,uDAAY,CAAA;IACZ,mCAAE,CAAA;AACJ,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAEY,QAAA,oBAAoB,GAAG;IAClC,mBAAmB,EAAE,SAAS;IAC9B,uBAAuB,EAAE,WAAW;IACpC,SAAS,EAAE,UAAU;IACrB,mBAAmB,EAAE,SAAS;CACtB,CAAC;AAEE,QAAA,gBAAgB,GAAG;IAC9B,iBAAiB,EAAE,SAAS;IAC5B,eAAe,EAAE,WAAW;IAC5B,YAAY,EAAE,UAAU;IACxB,eAAe,EAAE,WAAW;IAC5B,oBAAoB,EAAE,SAAS;CACvB,CAAC;AAEE,QAAA,gBAAgB,GAAG;IAC9B,YAAY,EAAE,SAAS;IACvB,aAAa,EAAE,WAAW;IAC1B,YAAY,EAAE,UAAU;IACxB,eAAe,EAAE,WAAW;IAC5B,eAAe,EAAE,SAAS;CAClB,CAAC;AAEX;;;;;;;;;GASG;AACI,MAAM,OAAO,GAAG,CACrB,OAAe,EACf,IAAc,EACd,OAA+D,EAC9C,EAAE,CACnB,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;IACtC,MAAM,KAAK,GAAG,IAAA,wBAAQ,EAAC,OAAO,EAAE,IAAI,oBAAO,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,EAAG,CAAC;IAE9D,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAA,KAAK,CAAC,MAAM,0CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,MAAA,KAAK,CAAC,MAAM,0CAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;QACxC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAA,KAAK,CAAC,MAAM,0CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,MAAA,KAAK,CAAC,MAAM,0CAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;QACxC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;;QACzB,IAAI,IAAI,KAAK,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,CAAC,CAAC;YAAE,OAAO,CAAC,MAAM,CAAC,CAAC;;YAClD,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAxBQ,QAAA,OAAO,WAwBf;AAEL,MAAM,aAAa;IACjB,MAAM,CAAO,YAAY,CAAC,YAAoB,EAAE,GAAc;;YAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1D,MAAM,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;YAC9D,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,CAAC,YAAY,EAAE,KAAK,EAAE,WAAW,WAAW,EAAE,EAAE,gBAAgB,CAAC,CAAC;gBAC/E,IAAI,GAAG;oBAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAE5C,MAAM,MAAM,GAAG,MAAM,IAAA,eAAO,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,OAAO;oBACL,GAAG,MAAM;yBACN,IAAI,EAAE;yBACN,KAAK,CAAC,IAAI,CAAC;yBACX,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;wBACrB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;wBACf,OAAO,GAAG,CAAC;oBACb,CAAC,EAAE,IAAI,GAAG,EAAU,CAAC;iBACxB,CAAC;YACJ,CAAC;YAAC,WAAM,CAAC;gBACP,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;KAAA;IAED,yEAAyE;IACzE,uBAAuB;IACvB,MAAM,CAAO,UAAU,CAAC,GAAc;;YACpC,MAAM,MAAM,GAAG,4BAAoB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YACpE,IAAI,MAAM;gBAAE,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAEvC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC;gBACtD,IAAI,GAAG;oBAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAE5C,MAAM,MAAM,GAAG,MAAM,IAAA,eAAO,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;YACvB,CAAC;YAAC,WAAM,CAAC;gBACP,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;KAAA;IAED,iEAAiE;IACjE,uBAAuB;IACvB,MAAM,CAAO,MAAM,CAAC,GAAc;;YAChC,MAAM,MAAM,GAAG,wBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAChE,IAAI,MAAM;gBAAE,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAEvC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;gBACnD,IAAI,GAAG;oBAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAE5C,MAAM,MAAM,GAAG,MAAM,IAAA,eAAO,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;YACvB,CAAC;YAAC,WAAM,CAAC;gBACP,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;KAAA;IAED,qEAAqE;IACrE,uBAAuB;IACvB,MAAM,CAAO,MAAM,CAAC,GAAc;;YAChC,MAAM,MAAM,GAAG,wBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAChE,IAAI,MAAM;gBAAE,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAEvC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACnC,IAAI,GAAG;oBAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAE5C,MAAM,MAAM,GAAG,MAAM,IAAA,eAAO,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;YACvB,CAAC;YAAC,WAAM,CAAC;gBACP,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;KAAA;IAED,MAAM,CAAO,KAAK,CAAC,GAAc;;YAC/B,OAAO,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,EAAE;gBACvC,IAAI,CAAC;oBACH,MAAM,cAAc,GAAG,IAAA,qBAAK,EAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE;wBAC7D,KAAK,EAAE,IAAI;wBACX,GAAG,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ,EAAE;wBACpB,KAAK,EAAE,QAAQ;wBACf,OAAO,EAAE,IAAI;qBACd,CAAC,CAAC;oBACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;wBACjC,QAAQ,IAAI,EAAE,CAAC;4BACb,KAAK,GAAG;gCACN,OAAO,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;4BACxC,KAAK,GAAG;gCACN,OAAO,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;4BACxC;gCACE,OAAO,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;wBAChC,CAAC;oBACH,CAAC,CAAC,CAAC;oBACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;gBACnE,CAAC;gBAAC,WAAM,CAAC;oBACP,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAED,MAAM,CAAC,UAAU;QACf,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACF;AAED,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA4B,CAAC;AACrD,MAAM,WAAW,GAAsC,CAAC,YAAY,CAAC,CAAC;AAEtE,gDAAgD;AAChD,4EAA4E;AAC5E,iCAAiC;AACpB,QAAA,GAAG,GAAG,IAAI,KAAK,CAAC,aAAa,EAAE;IAC1C,GAAG,CAAC,MAAM,EAAE,IAAI;QAEd,IACE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAgB,CAAC;YACpD,OAAO,MAAM,CAAC,IAAkB,CAAC,KAAK,UAAU,EAChD,CAAC;YACD,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,IAAkB,CAAC,EAAE;gBAC3C,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ;oBAC7B,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;oBACnE,IAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC3B,OAAO,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBAChC,CAAC;oBACD,yEAAyE;oBACzE,MAAM,MAAM,GAAY,OAAO,CAAC,KAAK,CAAC,MAAkB,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAC7E,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBAC/B,OAAO,MAAM,CAAC;gBAChB,CAAC;aACF,CAAY,CAAC;QAChB,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAY,CAAC;IAC9C,CAAC;CACF,CAAC,CAAC"}

package/dist/identity.d.ts

@@ -0,0 +1,2 @@
+import type Conf from 'conf';
+export declare function getMachineId(config?: Conf): string;

package/dist/identity.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMachineId = getMachineId;
+const os_1 = require("os");
+const crypto_1 = require("crypto");
+const invalidMacAddresses = new Set([
+    '00:00:00:00:00:00',
+    'ff:ff:ff:ff:ff:ff',
+    'ac:de:48:00:11:22',
+]);
+function getMachineId(config) {
+    const machineId = config === null || config === void 0 ? void 0 : config.get('machineId');
+    if (machineId) {
+        return machineId;
+    }
+    let machineIdSource;
+    // Derive a machine ID from the first network interface
+    machineIdSource = Object.values((0, os_1.networkInterfaces)())
+        .flat()
+        .map((iface) => iface === null || iface === void 0 ? void 0 : iface.mac)
+        .filter((mac) => mac && !invalidMacAddresses.has(mac))
+        .shift();
+    if (!machineIdSource) {
+        // Fallback to a random string
+        machineIdSource = (0, crypto_1.randomBytes)(32);
+    }
+    const machineIdHash = (0, crypto_1.createHash)('sha256')
+        .update(machineIdSource)
+        .digest('hex');
+    config === null || config === void 0 ? void 0 : config.set('machineId', machineIdHash);
+    return machineIdHash;
+}
+//# sourceMappingURL=identity.js.map

package/dist/identity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity.js","sourceRoot":"","sources":["../src/identity.ts"],"names":[],"mappings":";;AAUA,oCA2BC;AArCD,2BAAuC;AACvC,mCAA6D;AAG7D,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC;IAClC,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;CACpB,CAAC,CAAC;AAEH,SAAgB,YAAY,CAAC,MAAa;IACxC,MAAM,SAAS,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,WAAW,CAAuB,CAAC;IACjE,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,eAAuC,CAAC;IAE5C,uDAAuD;IACvD,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,IAAA,sBAAiB,GAAE,CAAC;SACjD,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,CAAC;SAC1B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACrD,KAAK,EAAE,CAAC;IAEX,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,8BAA8B;QAC9B,eAAe,GAAG,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,aAAa,GAAG,IAAA,mBAAU,EAAC,QAAQ,CAAC;SACvC,MAAM,CAAC,eAA6B,CAAC;SACrC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEjB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAExC,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { default as Telemetry } from './client';
+export * from './types';
+export * from './client';
+export * from './git';

package/dist/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Telemetry = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "Telemetry", { enumerable: true, get: function () { return __importDefault(client_1).default; } });
+__exportStar(require("./types"), exports);
+__exportStar(require("./client"), exports);
+__exportStar(require("./git"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,mCAAgD;AAAvC,oHAAA,OAAO,OAAa;AAC7B,0CAAwB;AACxB,2CAAyB;AACzB,wCAAsB"}

package/dist/session.d.ts

@@ -0,0 +1,16 @@
+import type Conf from 'conf';
+export declare class Session {
+    private readonly config;
+    private _id?;
+    private _expiration?;
+    get id(): string;
+    get expiration(): number;
+    get valid(): boolean;
+    constructor(config: Conf);
+    static beyondExpiration(expiration: number): boolean;
+    static expirationFromNow(): number;
+    static newSessionId(): string;
+    private load;
+    renew(): void;
+    touch(): void;
+}

package/dist/session.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Session = void 0;
+const crypto_1 = require("crypto");
+const SESSION_EXPIRATION = 1000 * 60 * 30; // 30 minutes
+class Session {
+    get id() {
+        if (!this.valid)
+            this.renew();
+        if (!this._id)
+            throw new Error('Session ID is not set');
+        return this._id;
+    }
+    get expiration() {
+        if (!this.valid)
+            this.renew();
+        if (!this._expiration)
+            throw new Error('Session expiration is not set');
+        return this._expiration;
+    }
+    get valid() {
+        return (this._id !== undefined &&
+            this._expiration !== undefined &&
+            !Session.beyondExpiration(this._expiration));
+    }
+    constructor(config) {
+        this.config = config;
+        this.load();
+    }
+    static beyondExpiration(expiration) {
+        return expiration <= Date.now();
+    }
+    static expirationFromNow() {
+        return Date.now() + SESSION_EXPIRATION;
+    }
+    static newSessionId() {
+        return (0, crypto_1.createHash)('sha256').update((0, crypto_1.randomBytes)(32)).digest('hex');
+    }
+    load() {
+        this._id = this.config.get('sessionId');
+        this._expiration = this.config.get('sessionExpiration');
+    }
+    renew() {
+        this._id = Session.newSessionId();
+        this._expiration = Session.expirationFromNow();
+        this.config.set('sessionId', this._id);
+        this.config.set('sessionExpiration', this._expiration);
+    }
+    touch() {
+        this._expiration = Session.expirationFromNow();
+        this.config.set('sessionExpiration', this.expiration);
+    }
+}
+exports.Session = Session;
+//# sourceMappingURL=session.js.map

package/dist/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../src/session.ts"],"names":[],"mappings":";;;AACA,mCAAiD;AAEjD,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;AAExD,MAAa,OAAO;IAIlB,IAAI,EAAE;QACJ,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAI,UAAU;QACZ,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,CACL,IAAI,CAAC,GAAG,KAAK,SAAS;YACtB,IAAI,CAAC,WAAW,KAAK,SAAS;YAC9B,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAC5C,CAAC;IACJ,CAAC;IAED,YAA6B,MAAY;QAAZ,WAAM,GAAN,MAAM,CAAM;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QACxC,OAAO,UAAU,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,iBAAiB;QACtB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,kBAAkB,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,YAAY;QACjB,OAAO,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IAEO,IAAI;QACV,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAuB,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAuB,CAAC;IAChF,CAAC;IAED,KAAK;QACH,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;QAClC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACzD,CAAC;IAED,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACxD,CAAC;CACF;AAxDD,0BAwDC"}

package/dist/types.d.ts

@@ -0,0 +1,48 @@
+export interface TelemetryData {
+    name: string;
+    properties?: Record<string, string | undefined>;
+    metrics?: Record<string, number | undefined>;
+}
+export interface TelemetryOptions {
+    includeEnvironment: boolean;
+}
+export type FlushCallback = () => void;
+export interface ITelemetryClient {
+    enabled: boolean;
+    machineId: Readonly<string>;
+    sessionId: Readonly<string>;
+    configure(config: Partial<TelemetryConfiguration>): void;
+    sendEvent(data: TelemetryData, options?: TelemetryOptions): void;
+    flush(callback?: FlushCallback): void;
+}
+export interface TelemetryBackend {
+    sendEvent(event: TelemetryData): void;
+    flush(callback?: FlushCallback): void;
+}
+export type BaseBackendConfiguration = {
+    type: string;
+};
+export type ProductConfiguration = {
+    name: string;
+    version: string;
+};
+export interface TelemetryConfiguration {
+    product: ProductConfiguration;
+    propPrefix: string;
+    backend: BackendConfiguration;
+}
+export interface SplunkBackendConfiguration extends BaseBackendConfiguration {
+    type: 'splunk';
+    token?: string;
+    url?: string;
+}
+export interface ApplicationInsightsBackendConfiguration extends BaseBackendConfiguration {
+    type: 'application-insights';
+    instrumentationKey?: string;
+}
+export interface CustomBackendConfiguration extends BaseBackendConfiguration, TelemetryBackend {
+    type: 'custom';
+    sendEvent: (event: TelemetryData) => void;
+    flush: (callback?: FlushCallback) => void;
+}
+export type BackendConfiguration = CustomBackendConfiguration | ApplicationInsightsBackendConfiguration | SplunkBackendConfiguration;

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@appland/telemetry",
+  "version": "1.1.0",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest",
+    "build": "tsc",
+    "lint": "eslint src --ext .ts",
+    "pre-commit": "lint-staged"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json",
+    "LICENSE.txt"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "**/*": "prettier --write --ignore-unknown"
+  },
+  "dependencies": {
+    "applicationinsights": "^2.1.4",
+    "conf": "<11",
+    "read-pkg-up": "^7.0.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.4.1",
+    "@types/node": "^22",
+    "@typescript-eslint/eslint-plugin": "^8.38.0",
+    "@typescript-eslint/parser": "^8.38.0",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "jest": "^29.5.0",
+    "lint-staged": "^10.5.4",
+    "prettier": "^2.7.1",
+    "sinon": "^13.0.1",
+    "ts-jest": "^29.0.5",
+    "typescript": "^5.8.3"
+  }
+}