fix: add type declarations for log-error

Author: rowanmanning

.gitignore

@@ -1,7 +1,6 @@
 .husky/_
 packages/errors/**/*.d.*
 packages/fetch-error-handler/**/*.d.*
-packages/log-error/**/*.d.*
 packages/logger/**/*.d.*
 packages/middleware-log-errors/**/*.d.*
 packages/middleware-render-error-info/**/*.d.*

jsconfig.build.json

@@ -10,7 +10,6 @@
 	"include": [
 		"packages/errors/**/*.js",
 		"packages/fetch-error-handler/**/*.js",
-		"packages/log-error/**/*.js",
 		"packages/logger/**/*.js",
 		"packages/middleware-log-errors/**/*.js",
 		"packages/middleware-render-error-info/**/*.js"

packages/log-error/.npmignore

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

packages/log-error/lib/index.js

@@ -4,44 +4,14 @@ const serializeError = require('@dotcom-reliability-kit/serialize-error');
 const serializeRequest = require('@dotcom-reliability-kit/serialize-request');
 
 /**
- * @typedef {(...logData: any) => any} LogMethod
- */
-
-/**
- * @typedef {object} Logger
- * @property {LogMethod} error
- *     A function to log an error.
- * @property {LogMethod} [fatal]
- *     A function to log a fatal error.
- * @property {LogMethod} warn
- *     A function to log a warning.
- */
-
-/**
- * @typedef {object} ErrorLoggingOptions
- * @property {(string | Error & Record<string, any>)} error
- *     The error to log.
- * @property {string[]} [includeHeaders]
- *     An array of request headers to include in the log.
- * @property {Logger & {[key: string]: any}} [logger]
- *     The logger to use to output errors. Defaults to Reliability Kit logger.
- * @property {(string | import('@dotcom-reliability-kit/serialize-request').Request)} [request]
- *     An request object to include in the log.
- */
-
-/**
- * @typedef {object} InternalErrorLoggingOptions
- * @property {string} event
- *     The event to log.
- * @property {("error" | "fatal" | "warn")} level
- *     The log level to use. One of "error", "fatal", or "warn".
+ * @typedef {import('@dotcom-reliability-kit/log-error').ErrorLoggingOptions} ErrorLoggingOptions
  */
 
 /**
  * Log an error object with optional request information.
  *
  * @private
- * @param {ErrorLoggingOptions & InternalErrorLoggingOptions} options
+ * @param {ErrorLoggingOptions & {event: string, level: 'error' | 'fatal' | 'warn'}} options
  *     The data to log.
  * @returns {void}
  */
@@ -110,10 +80,7 @@ function extractErrorMessage(serializedError) {
 /**
  * Log a handled error.
  *
- * @public
- * @param {ErrorLoggingOptions} options
- *     The data to log.
- * @returns {void}
+ * @type {typeof import('@dotcom-reliability-kit/log-error').logHandledError}
  */
 function logHandledError({ error, includeHeaders, logger, request }) {
 	logError({
@@ -129,10 +96,7 @@ function logHandledError({ error, includeHeaders, logger, request }) {
 /**
  * Log a recoverable error.
  *
- * @public
- * @param {ErrorLoggingOptions} options
- *     The data to log.
- * @returns {void}
+ * @type {typeof import('@dotcom-reliability-kit/log-error').logHandledError}
  */
 function logRecoverableError({ error, includeHeaders, logger, request }) {
 	logError({
@@ -148,10 +112,7 @@ function logRecoverableError({ error, includeHeaders, logger, request }) {
 /**
  * Log an unhandled error.
  *
- * @public
- * @param {ErrorLoggingOptions} options
- *     The data to log.
- * @returns {void}
+ * @type {typeof import('@dotcom-reliability-kit/log-error').logHandledError}
  */
 function logUnhandledError({ error, includeHeaders, logger, request }) {
 	logError({

packages/log-error/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/logger": "^3.1.2",

packages/log-error/types/index.d.ts

@@ -0,0 +1,24 @@
+import { Request } from '@dotcom-reliability-kit/serialize-request';
+
+declare module '@dotcom-reliability-kit/log-error' {
+	type LogMethod = (...logData: any) => any;
+
+	export type Logger = {
+		error: LogMethod;
+		fatal?: LogMethod;
+		warn: LogMethod;
+	};
+
+	export type ErrorLoggingOptions = {
+		error: string | (Error & Record<string, any>);
+		includeHeaders?: string[];
+		logger?: Logger & { [key: string]: any };
+		request?: string | Request;
+	};
+
+	export function logHandledError(options: ErrorLoggingOptions): void;
+
+	export function logRecoverableError(options: ErrorLoggingOptions): void;
+
+	export function logUnhandledError(options: ErrorLoggingOptions): void;
+}

scripts/clean-generated-types.sh

@@ -2,7 +2,6 @@
 
 find ./packages/errors -name "*.d.ts*" | xargs -r rm
 find ./packages/fetch-error-handler -name "*.d.ts*" | xargs -r rm
-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