👮 Type check and type alignment (#2561)

Author: stevejpurves

.changeset/shaggy-zebras-repair.md

@@ -0,0 +1,5 @@
+---
+'myst-cli': patch
+---
+
+Update `ws` version in package to match actual and align types.

.changeset/wild-rice-pump.md

@@ -0,0 +1,5 @@
+---
+'myst-to-docx': patch
+---
+
+Removing `@ts-expect` rules in favour of typed checks

package-lock.json

@@ -109,7 +109,7 @@
     "uuid": "^8.3.2",
     "vfile": "^5.3.5",
     "which": "^3.0.1",
-    "ws": "^8.9.0",
+    "ws": "^8.18.1",
     "xml-js": "^1.6.11",
     "zod": "^3.23.8"
   },
@@ -124,7 +124,7 @@
     "@types/picomatch": "^4.0.2",
     "@types/uuid": "^8.3.4",
     "@types/which": "^3.0.0",
-    "@types/ws": "^8.5.5",
+    "@types/ws": "^8.18.1",
     "concurrently": "^8.2.0"
   }
 }

packages/myst-cli/package.json

@@ -63,7 +63,7 @@ export async function startContentServer(session: ISession, opts?: ServerOptions
     noServer: true,
     path: '/socket',
   });
-  const connections: Record<string, WebSocket.WebSocket> = {};
+  const connections: Record<string, WebSocket> = {};
 
   wss.on('connection', function connection(ws) {
     const id = nanoid();

packages/myst-cli/src/build/site/start.ts

@@ -11,8 +11,7 @@ export const plugin: Plugin<[Options], Root, VFile> = function (opts) {
     const state = new DocxSerializer(file, opts);
     state.renderChildren(node);
     const doc = createDocFromState(state);
-    // @ts-expect-error document is not defined in node
-    if (typeof document === 'undefined') {
+    if (typeof (globalThis as any).document === 'undefined') {
       file.result = Packer.toBuffer(doc);
     } else {
       file.result = Packer.toBlob(doc);

packages/myst-to-docx/src/plugin.ts

@@ -96,11 +96,9 @@ export function getImageWidth(width?: number | string, maxWidth = MAX_DOCX_IMAGE
 async function getImageDimensions(
   file: Blob | Buffer,
 ): Promise<{ width: number; height: number } | undefined> {
-  // @ts-expect-error Image is not defined
-  if (typeof Image === 'undefined') return undefined;
+  if (typeof (globalThis as any).Image === 'undefined') return undefined;
   return new Promise((resolve, reject) => {
-    // @ts-expect-error Image not defined
-    const img = new Image();
+    const img = new (globalThis as any).Image();
     // the following handler will fire after a successful loading of the image
     img.onload = () => {
       const { naturalWidth: width, naturalHeight: height } = img;