fix: update dependency typings (#474)

Author: wkillerud

fixup.sh

@@ -4,7 +4,7 @@
 cat >> types/layout.d.ts <<!EOF
 declare global {
   namespace Express {
-    interface Response {
+    export interface Response {
       podiumSend(fragment: string, ...args: unknown[]): Response;
     }
   }

lib/layout.js

@@ -5,13 +5,9 @@
 
 import {
     HttpIncoming,
-    // @ts-ignore
     template,
-    // @ts-ignore
     isFunction,
-    // @ts-ignore
     pathnameBuilder,
-    // @ts-ignore
     uriIsRelative,
     AssetCss,
     AssetJs,
@@ -40,10 +36,10 @@ const pkg = JSON.parse(pkgJson);
  * @typedef {Object} LayoutOptions
  * @property {string} name - (required) layout name
  * @property {string} pathname - (required) layout pathname
- * @property {Console | import('abslog').AbstractLogger} [logger] - A logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided. (default null)
+ * @property {import('abslog').AbstractLoggerOptions} [logger] - A logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided. (default null)
  * @property {LayoutContext} [context] - Options to be passed on to the internal `@podium/context` constructor. See that module for details. (default null)
  * @property {LayoutClientOptions} [client] - Options to be passed on to the internal `@podium/client` constructor. See that module for details. (default null)
- * @property {import("@podium/proxy").default.PodiumProxyOptions} [proxy] - Options to be passed on to the internal `@podium/proxy` constructor. See that module for details. (default null)
+ * @property {import('@podium/proxy').PodiumProxyOptions} [proxy] - Options to be passed on to the internal `@podium/proxy` constructor. See that module for details. (default null)
  *
  *
  * @typedef {Object} LayoutContext
@@ -116,7 +112,7 @@ export default class PodiumLayout {
      * layout.log.fatal('fatal log to the console')
      * ```
      *
-     * @type {import('abslog').AbstractLogger}
+     * @type {import('abslog').ValidLogger}
      */
     log;
 
@@ -147,7 +143,7 @@ export default class PodiumLayout {
      * @see https://podium-lib.io/docs/layout/context
      * @see https://podium-lib.io/docs/podlet/context
      *
-     * @type {LayoutContext}
+     * @type {Context}
      */
     context;
 
@@ -294,14 +290,11 @@ export default class PodiumLayout {
 
         // Join metric streams
         this.httpProxy.metrics.pipe(this.metrics);
-        // @ts-ignore
         this.context.metrics.pipe(this.metrics);
         this.client.metrics.pipe(this.metrics);
 
         // Register proxy endpoints
-        // @ts-ignore
         this.client.registry.on('set', (key, item) => {
-            // @ts-ignore
             this.httpProxy.register(key, item.newVal);
         });
     }
@@ -561,7 +554,6 @@ export default class PodiumLayout {
         incoming.css = [...this.cssRoute];
         incoming.js = [...this.jsRoute];
 
-        // @ts-ignore
         if (context) await this.context.process(incoming);
         if (proxy) await this.httpProxy.process(incoming);
 
@@ -587,7 +579,7 @@ export default class PodiumLayout {
     middleware() {
         return async (req, res, next) => {
             const incoming = new HttpIncoming(req, res, res.locals);
-            // @ts-ignore
+            // @ts-expect-error The API here is a bit odd. You assign a string, but the `set` constructs a URL from it.
             incoming.url = `${req.protocol}://${req.get('host')}${
                 req.originalUrl
             }`;
@@ -660,11 +652,7 @@ export default class PodiumLayout {
     #sanitize(uri, prefix = false) {
         const pathname = prefix ? this.#pathname : '';
         if (uri) {
-            // @ts-ignore
-            return uriIsRelative(uri)
-                ? // @ts-ignore
-                  pathnameBuilder(pathname, uri)
-                : uri;
+            return uriIsRelative(uri) ? pathnameBuilder(pathname, uri) : uri;
         }
         return uri;
     }

package.json

@@ -32,25 +32,25 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "test": "tap --disable-coverage --allow-empty-coverage",
+    "test": "tap --disable-coverage --allow-empty-coverage && tsc --project tsconfig.test.json",
     "test:snapshots": "tap --snapshot --disable-coverage --allow-empty-coverage",
     "types": "tsc --declaration --emitDeclarationOnly && ./fixup.sh"
   },
   "dependencies": {
     "@metrics/client": "2.5.2",
-    "@podium/client": "5.0.10",
-    "@podium/context": "5.0.4",
-    "@podium/proxy": "5.0.8",
-    "@podium/schemas": "5.0.0",
-    "@podium/utils": "5.0.3",
-    "abslog": "2.4.2",
+    "@podium/client": "5.0.21",
+    "@podium/context": "5.0.13",
+    "@podium/proxy": "5.0.16",
+    "@podium/schemas": "5.0.2",
+    "@podium/utils": "5.0.6",
+    "abslog": "2.4.4",
     "ajv": "8.12.0",
     "lodash.merge": "4.6.2",
     "objobj": "1.0.0"
   },
   "devDependencies": {
     "@babel/eslint-parser": "7.23.3",
-    "@podium/podlet": "5.1.2",
+    "@podium/podlet": "5.1.4",
     "@podium/test-utils": "2.5.2",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/commit-analyzer": "11.1.0",

tap-snapshots/tests/layout.js.test.cjs tap-snapshots/tests/layout.test.js.test.cjs

@@ -5,7 +5,7 @@
  * Make sure to inspect the output below.  Do not ignore changes!
  */
 'use strict'
-exports[`tests/layout.js > TAP > Layout() - rendering using a string - with assets > must match snapshot 1`] = `
+exports[`tests/layout.test.js > TAP > Layout() - rendering using a string - with assets > must match snapshot 1`] = `
 <!doctype html>
 <html lang="en-US">
     <head>
@@ -25,6 +25,6 @@ exports[`tests/layout.js > TAP > Layout() - rendering using a string - with asse
 </html>
 `
 
-exports[`tests/layout.js > TAP > Layout() - setting a custom view template > must match snapshot 1`] = `
+exports[`tests/layout.test.js > TAP > Layout() - setting a custom view template > must match snapshot 1`] = `
 <html><head>extra head stuff</head><body><div>should be wrapped in a doc</div></body></html>
 `

tests/layout.js tests/layout.test.js

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 /* eslint-disable no-param-reassign */
 
 import tap from 'tap';
@@ -244,6 +242,7 @@ tap.test('Layout() - metrics properly decorated', (t) => {
 tap.test('.css() - call method with no arguments - should throw', (t) => {
     const layout = new Layout(DEFAULT_OPTIONS);
     t.throws(() => {
+        // @ts-expect-error Testing bad input
         layout.css();
     }, 'Value for argument variable "value", "undefined", is not valid');
     t.end();
@@ -458,6 +457,7 @@ tap.test(
             {
                 value: '/foo/bar',
                 data: {
+                    // @ts-expect-error Testing conversion from older format
                     bar: 'a',
                     foo: 'b',
                 },

tsconfig.test.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["./tests/**/*.js"],
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "noEmit": true
+  }
+}