chore: migrate to TypeScript 5.5

Now that we've got manual type declarations we can _finally_ safely
migrate to TypeScript 5.5. Phew.

Author: rowanmanning

package-lock.json

@@ -36,14 +36,14 @@
     "@types/jest": "^29.5.12",
     "@types/node": "^20.12.7",
     "eslint": "^8.57.0",
-    "eslint-plugin-jsdoc": "^48.2.1",
+    "eslint-plugin-jsdoc": "^48.5.0",
     "eslint-plugin-prettier": "^5.1.3",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
     "lint-staged": "^15.2.2",
     "prettier": "^3.2.5",
     "release-please": "^16.10.1",
-    "typescript": "^5.3.3"
+    "typescript": "^5.5.2"
   },
   "engines": {
     "node": "18.x || 20.x || 22.x",

package.json

@@ -1,6 +1,10 @@
 const path = require('node:path');
 const { randomUUID } = require('node:crypto');
 
+/**
+ * @import { SemanticConventions } from '@dotcom-reliability-kit/app-info'
+ */
+
 // This package relies on Heroku and AWS Lambda environment variables.
 // Documentation for these variables is available here:
 //
@@ -159,7 +163,7 @@ exports.herokuDynoId = process.env.HEROKU_DYNO_ID || null;
 exports.instanceId = randomUUID();
 
 /**
- * @type {import('@dotcom-reliability-kit/app-info').SemanticConventions}
+ * @type {SemanticConventions}
  */
 exports.semanticConventions = {
 	cloud: {

packages/app-info/lib/index.js

@@ -3,10 +3,14 @@ const {
 	logUnhandledError
 } = require('@dotcom-reliability-kit/log-error');
 
+/**
+ * @import { CrashHandlerOptions } from '@dotcom-reliability-kit/crash-handler'
+ */
+
 /**
  * Register a crash handler on a process.
  *
- * @param {import('@dotcom-reliability-kit/crash-handler').CrashHandlerOptions} [options]
+ * @param {CrashHandlerOptions} [options]
  */
 function registerCrashHandler(options = {}) {
 	const process = options.process || global.process;

packages/crash-handler/lib/index.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@dotcom-reliability-kit/errors').BaseErrorData} ErrorData
+ * @import { BaseError as BaseErrorType, BaseErrorData as ErrorData } from '@dotcom-reliability-kit/errors'
  */
 
 /**
@@ -9,39 +9,39 @@ class BaseError extends Error {
 	/**
 	 * @override
 	 * @readonly
-	 * @type {import('@dotcom-reliability-kit/errors').BaseError['name']}
+	 * @type {BaseErrorType['name']}
 	 */
 	name = 'BaseError';
 
 	/**
 	 * Whether the error is operational.
 	 *
 	 * @readonly
-	 * @type {import('@dotcom-reliability-kit/errors').BaseError['isOperational']}
+	 * @type {BaseErrorType['isOperational']}
 	 */
 	isOperational = false;
 
 	/**
 	 * A machine-readable error code which identifies the specific type of error.
 	 *
 	 * @readonly
-	 * @type {import('@dotcom-reliability-kit/errors').BaseError['code']}
+	 * @type {BaseErrorType['code']}
 	 */
 	code = BaseError.defaultCode;
 
 	/**
 	 * The root cause error instance.
 	 *
 	 * @readonly
-	 * @type {import('@dotcom-reliability-kit/errors').BaseError['cause']}
+	 * @type {BaseErrorType['cause']}
 	 */
 	cause = null;
 
 	/**
 	 * Additional error information.
 	 *
 	 * @readonly
-	 * @type {import('@dotcom-reliability-kit/errors').BaseError['data']}
+	 * @type {BaseErrorType['data']}
 	 */
 	data = {};
 
@@ -119,7 +119,7 @@ class BaseError extends Error {
 	static defaultMessage = 'An error occurred';
 
 	/**
-	 * @type {(typeof import('@dotcom-reliability-kit/errors').BaseError)['isErrorMarkedAsOperational']}
+	 * @type {(typeof BaseErrorType)['isErrorMarkedAsOperational']}
 	 */
 	static isErrorMarkedAsOperational(error) {
 		// @ts-ignore Error.prototype.isOperational does not exist, but it's OK to check in this

packages/errors/lib/base-error.js

@@ -1,13 +1,17 @@
 const OperationalError = require('./operational-error');
 
+/**
+ * @import { DataStoreError as DataStoreErrorType } from '@dotcom-reliability-kit/errors'
+ */
+
 /**
  * Class representing an error in an application's data store.
  */
 class DataStoreError extends OperationalError {
 	/**
 	 * @override
 	 * @readonly
-	 * @type {import('@dotcom-reliability-kit/errors').DataStoreError['name']}
+	 * @type {DataStoreErrorType['name']}
 	 */
 	name = 'DataStoreError';
 }