fix: add type declarations for opentelemetry

Author: rowanmanning

.gitignore

@@ -5,7 +5,6 @@ packages/log-error/**/*.d.*
 packages/logger/**/*.d.*
 packages/middleware-log-errors/**/*.d.*
 packages/middleware-render-error-info/**/*.d.*
-packages/opentelemetry/**/*.d.*
 coverage
 node_modules/
 resources/logos/dist

jsconfig.build.json

@@ -13,7 +13,6 @@
 		"packages/log-error/**/*.js",
 		"packages/logger/**/*.js",
 		"packages/middleware-log-errors/**/*.js",
-		"packages/middleware-render-error-info/**/*.js",
-		"packages/opentelemetry/**/*.js"
+		"packages/middleware-render-error-info/**/*.js"
 	]
 }

packages/opentelemetry/.npmignore

@@ -1,5 +1,3 @@
-!*.d.ts
-!*.d.ts.map
 CHANGELOG.md
 docs
 test

packages/opentelemetry/lib/config/metrics.js

@@ -8,18 +8,10 @@ const { PeriodicExportingMetricReader } =
 const logger = require('@dotcom-reliability-kit/logger');
 const { METRICS_USER_AGENT } = require('./user-agents');
 
-/**
- * @typedef {object} MetricsOptions
- * @property {string} [apiGatewayKey]
- *     The API key to send to the metrics collector if you're using the FT's official metrics collector endpoint.
- * @property {string} [endpoint]
- *     The URL to send OpenTelemetry metrics to, for example http://localhost:4318/v1/metrics.
- */
-
 /**
  * Create an OpenTelemetry metrics configuration.
  *
- * @param {MetricsOptions} options
+ * @param {import('@dotcom-reliability-kit/opentelemetry').MetricsOptions} options
  * @returns {Partial<import('@opentelemetry/sdk-node').NodeSDKConfiguration>}
  */
 exports.createMetricsConfig = function createMetricsConfig(options) {

packages/opentelemetry/lib/config/tracing.js

@@ -9,20 +9,10 @@ const { TRACING_USER_AGENT } = require('./user-agents');
 
 const DEFAULT_SAMPLE_PERCENTAGE = 5;
 
-/**
- * @typedef {object} TracingOptions
- * @property {string} [authorizationHeader]
- *     The HTTP `Authorization` header to send with OpenTelemetry tracing requests if you're using the Customer Products trace collector endpoint.
- * @property {string} [endpoint]
- *     The URL to send OpenTelemetry trace segments to, for example http://localhost:4318/v1/traces.
- * @property {number} [samplePercentage]
- *     What percentage of traces should be sent onto the collector.
- */
-
 /**
  * Create an OpenTelemetry tracing configuration.
  *
- * @param {TracingOptions} options
+ * @param {import('@dotcom-reliability-kit/opentelemetry').TracingOptions} options
  * @returns {Partial<import('@opentelemetry/sdk-node').NodeSDKConfiguration>}
  */
 exports.createTracingConfig = function createTracingConfig(options) {

packages/opentelemetry/lib/index.js

@@ -7,29 +7,11 @@ const opentelemetry = require('@opentelemetry/sdk-node');
 const logger = require('@dotcom-reliability-kit/logger');
 
 /**
- * @typedef {import('./config/metrics').MetricsOptions} MetricsOptions
+ * @typedef {import('@dotcom-reliability-kit/opentelemetry').Options} Options
  */
 
 /**
- * @typedef {import('./config/tracing').TracingOptions} TracingOptions
- */
-
-/**
- * @typedef {object} Options
- * @property {string} [authorizationHeader]
- *      [DEPRECATED] The HTTP `Authorization` header to send with OpenTelemetry requests. Use `tracing.authorizationHeader` instead.
- * @property {MetricsOptions} [metrics]
- *      Configuration options for OpenTelemetry metrics.
- * @property {TracingOptions} [tracing]
- *      Configuration options for OpenTelemetry tracing.
- */
-
-/**
- * @typedef {object} Instances
- * @property {opentelemetry.NodeSDK} sdk
- *      A singleton instance of the OpenTelemetry Node SDK.
- * @property {HostMetrics} [hostMetrics]
- *      A singleton instances of the OpenTelemetry host metrics collector.
+ * @typedef {import('@dotcom-reliability-kit/opentelemetry').Instances} Instances
  */
 
 /**
@@ -43,9 +25,7 @@ let instances;
  * Set up OpenTelemetry tracing.
  *
  * @param {Options} [options]
- *      OpenTelemetry configuration options.
  * @returns {Instances}
- *      Returns any created SDK instances.
  */
 function setupOpenTelemetry({
 	authorizationHeader,
@@ -121,13 +101,9 @@ function setupOpenTelemetry({
  * Get a metrics meter from the configured OpenTelemetry SDK.
  *
  * @param {string} name
- *     The meter name.
  * @param {string} [version]
- *     The meter version.
  * @param {opentelemetry.api.MeterOptions} [options]
- *     Additional configuration options for the meter.
  * @returns {opentelemetry.api.Meter}
- *      Returns a metrics meter.
  */
 function getMeter(name, version, options) {
 	if (!instances) {

packages/opentelemetry/package.json

@@ -14,7 +14,8 @@
 		"node": "18.x || 20.x || 22.x",
 		"npm": "8.x || 9.x || 10.x"
 	},
-	"main": "lib",
+	"main": "lib/index.js",
+	"types": "types/index.d.ts",
 	"dependencies": {
 		"@dotcom-reliability-kit/app-info": "^3.2.0",
 		"@dotcom-reliability-kit/errors": "^3.1.0",

packages/opentelemetry/types/index.d.ts

@@ -0,0 +1,38 @@
+import { HostMetrics } from '@opentelemetry/host-metrics';
+import opentelemetry from '@opentelemetry/sdk-node';
+
+declare module '@dotcom-reliability-kit/opentelemetry' {
+	export type MetricsOptions = {
+		apiGatewayKey?: string;
+		endpoint?: string;
+	};
+
+	export type TracingOptions = {
+		authorizationHeader?: string;
+		endpoint?: string;
+		samplePercentage?: number;
+	};
+
+	export type Options = {
+		/** @deprecated */
+		authorizationHeader?: string;
+		metrics?: MetricsOptions;
+		tracing?: TracingOptions;
+	};
+
+	export type Instances = {
+		sdk: opentelemetry.NodeSDK;
+		hostMetrics?: HostMetrics;
+	};
+
+	export function setup(options?: Options): Instances;
+	export function getMeter(
+		name: string,
+		version?: string,
+		options?: opentelemetry.api.MeterOptions
+	): opentelemetry.api.Meter;
+}
+
+declare module '@dotcom-reliability-kit/opentelemetry/setup' {
+	export {};
+}

scripts/clean-generated-types.sh

@@ -6,4 +6,3 @@ find ./packages/log-error -name "*.d.ts*" | xargs -r rm
 find ./packages/logger -name "*.d.ts*" | xargs -r rm
 find ./packages/middleware-log-errors -name "*.d.ts*" | xargs -r rm
 find ./packages/middleware-render-error-info -name "*.d.ts*" | xargs -r rm
-find ./packages/opentelemetry -name "*.d.ts*" | xargs -r rm