fix: add type declarations for the logger

This is the final package we need to add manual type declarations for,
it's also the most complex but I decided to just replicate the existing
generated types.

Because we no longer need a build step I'm removing all of the
build-related tooling and updating the documentation accordingly.

Resolves #946

Author: rowanmanning

.circleci/config.yml

@@ -126,9 +126,6 @@ jobs:
           name: Set npm auth token
           command: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" >
             ${HOME}/.npmrc
-      - run:
-          name: Build packages
-          command: npm run build
       - run:
           name: NPM publish
           command: ./scripts/circleci-publish.sh
@@ -141,9 +138,6 @@ jobs:
           name: Set npm auth token
           command: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" >
             ${HOME}/.npmrc
-      - run:
-          name: Build packages
-          command: npm run build
       - run:
           name: NPM publish
           command: ./scripts/circleci-publish.sh --tag=prerelease

.gitignore

@@ -1,5 +1,4 @@
 .husky/_
-packages/logger/**/*.d.*
 coverage
 node_modules/
 resources/logos/dist

docs/contributing.md

@@ -26,7 +26,6 @@ We're glad you want to contribute to Reliability Kit!
     * [Pull request scope](#pull-request-scope)
     * [Merging pull requests](#merging-pull-requests)
   * [Releasing](#releasing)
-    * [Generated files](#generated-files)
     * [Hard-coding the release version](#hard-coding-the-release-version)
     * [Correcting releases](#correcting-releases)
   * [Issue management](#issue-management)
@@ -174,7 +173,7 @@ The linters are also run on pull requests and linting errors will block merging,
 
 ### Type safety
 
-We do not write TypeScript in this project, but we _do_ write [thorough JSDoc](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) and test against it which gives us all the benefits of TypeScript ([more info](./design.md#languages)).
+We do not write TypeScript code, but we _do_ write [thorough JSDoc](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) and publish type declarations, then test against it which gives us all the benefits of TypeScript ([more info](./design.md#languages)).
 
 We do not compile the code in our packages, but we do check that all variables are set to the correct types. If there are any type errors then you should see these in your editor if you're using VS Code. Otherwise type checking can be manually run as part of linting:
 
@@ -269,16 +268,6 @@ If the PR is left alone, it will continue to be updated with new releases as mor
 
 Before approving and merging the release PR, make sure you review it. You need to check the package versions that it updates to make sure you’re only releasing the things you expect.
 
-### Generated files
-
-Before publishing npm packages we do generate TypeScript type declaration files (`.d.ts`) so that TypeScript-based projects which use Reliability Kit will get correct type hinting.
-
-If a release has caused issues with Type hinting or TypeScript-based projects compiling, then you can inspect the generated files by running the build command locally and viewing the `.d.ts` files in your editor:
-
-```
-npm run build
-```
-
 ### Hard-coding the release version
 
 Sometimes it's necessary to hard-code a release version, for example if commits have been pushed to `main` which don't match our [commit format](#commit-type-prefixes). A more common reason to do this is when you want to publish a prerelease package to experiment before marking it as stable (e.g. publishing a `v0.1.0` before `v1.0.0`).

docs/design.md

@@ -27,7 +27,7 @@ The combination of the above allows us to work on and publish the packages in th
 
 In terms of TypeScript, the key benefits are having type safety and type hinting in your editor. We can achieve both of these without writing TypeScript. Using [JavaScript with JSDoc comments to document types](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html), VSCode (used by the majority of our engineers) offers the same level of type hinting as it does with TypeScript. It's also possible to run the TypeScript type checker against JavaScript code to verify that everything is type safe (e.g. using `tsc --checkJS`).
 
-In order to be useful for TypeScript projects, we do still need to publish our modules with TypeScript type declaration files (`.d.ts`). We made this an automated step during publishing and when authoring modules you should still write JavaScript and JSDoc.
+In order to be useful for TypeScript projects, we do still need to publish our modules with TypeScript type declaration files (`.d.ts`).
 
 ### CommonJS
 

jsconfig.build.json

@@ -20,14 +20,10 @@
     "create-package": "./scripts/create-package.js",
     "lint": "npm run lint:eslint && npm run lint:tsc",
     "lint:eslint": "eslint .",
-    "lint:tsc": "npm run clean && tsc --project ./jsconfig.json",
-    "clean": "npm run clean:types",
-    "clean:types": "./scripts/clean-generated-types.sh",
-    "build": "npm run clean && npm run build:types",
-    "build:types": "tsc --project ./jsconfig.build.json",
+    "lint:tsc": "tsc --project ./jsconfig.json",
     "test": "npm run test:jest && npm run test:modules",
     "test:jest": "jest --silent",
-    "test:modules": "npm run build && npm run test --workspaces --if-present",
+    "test:modules": "npm run test --workspaces --if-present",
     "prepare": "husky",
     "postinstall": "npm run build:logos"
   },

package.json

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

packages/logger/.npmignore

@@ -2,17 +2,8 @@ const Logger = require('./logger');
 const legacyMask = require('./transforms/legacy-mask');
 
 /**
- * @typedef {object} Transforms
- * @property {legacyMask} legacyMask
- *     The legacy mask logger.
- */
-
-/**
- * @typedef {object} DefaultLogger
- * @property {typeof Logger} Logger
- *     The Logger class.
- * @property {Transforms} transforms
- *     Built-in log transforms.
+ * @typedef {import('@dotcom-reliability-kit/logger').DefaultLogger} DefaultLogger
+ * @typedef {import('@dotcom-reliability-kit/logger').Transforms} Transforms
  */
 
 /** @type {Transforms} */