Add lint-tsc-lib-no-dom.

Author: lgarron

.github/workflows/CI.yml

@@ -25,6 +25,7 @@ jobs:
       - run: make lint-ci
       - run: make lint-tsc-main
       - run: make lint-tsc-lib
+      - run: make lint-tsc-lib-no-dom
       - run: make lint-tsc-bin
       - run: make lint-import-restrictions
       - run: make check-schemas

Makefile

@@ -103,7 +103,7 @@ test-info:
 	@echo ""
 	@echo "Also, if you want to run all possible checks in the project, run:"
 	@echo ""
-	@echo "    make check (≈40s, includes all of the above)"
+	@echo "    make check (≈46s, includes all of the above)"
 	@echo ""
 	@echo "If you want the best \"bang for your buck\" without running everything, run:"
 	@echo ""
@@ -239,7 +239,7 @@ check-engines: update-dependencies
 	@${BUN_RUN} "./script/check-engine-versions.ts"
 
 .PHONY: lint
-lint: lint-biome lint-import-restrictions lint-tsc-main lint-tsc-lib lint-tsc-bin check-schemas
+lint: lint-biome lint-import-restrictions lint-tsc check-schemas
 
 .PHONY: lint-biome
 lint-biome: update-dependencies
@@ -253,6 +253,9 @@ lint-ci: update-dependencies
 lint-import-restrictions: update-dependencies
 	${BUN_RUN} ./script/lint/import-restrictions/main.ts
 
+.PHONY: lint-tsc
+lint-tsc: lint-tsc-main lint-tsc-lib lint-tsc-lib-no-dom lint-tsc-bin
+
 .PHONY: lint-tsc-main
 lint-tsc-main: update-dependencies
 	${BUN_DX} --package typescript tsc -- --project ./tsconfig.json
@@ -261,6 +264,10 @@ lint-tsc-main: update-dependencies
 lint-tsc-lib: update-dependencies
 	${BUN_DX} --package typescript tsc -- --project ./tsconfig.lib.jsonc
 
+.PHONY: lint-tsc-lib-no-dom
+lint-tsc-lib-no-dom: update-dependencies
+	${BUN_DX} --package typescript tsc -- --project ./tsconfig.lib.no-dom.jsonc
+
 .PHONY: lint-tsc-bin
 lint-tsc-bin: update-dependencies
 	${BUN_DX} --package typescript tsc -- --project ./src/bin/tsconfig.json

src/cubing/bluetooth/index.ts

@@ -1,10 +1,11 @@
+// TODO: deprecate these exports?
+export type {
+  ExperimentalAlgLeafEvent as MoveEvent,
+  ExperimentalOrientationEvent as OrientationEvent,
+} from "../stream";
 export { enableDebugLogging } from "./debug";
 export { debugKeyboardConnect, KeyboardPuzzle } from "./keyboard";
-export type {
-  AlgLeafEvent as MoveEvent,
-  BluetoothPuzzle,
-  OrientationEvent,
-} from "./smart-puzzle/bluetooth-puzzle";
+export type { BluetoothPuzzle } from "./smart-puzzle/bluetooth-puzzle";
 export { connectSmartPuzzle } from "./smart-puzzle/connect";
 export { GanCube } from "./smart-puzzle/gan";
 export { GiiKERCube } from "./smart-puzzle/giiker";

src/cubing/bluetooth/smart-puzzle/bluetooth-puzzle.ts

@@ -1,36 +1,15 @@
-import type { AlgLeaf } from "../../alg/alg-nodes/AlgNode";
 import type { KPattern } from "../../kpuzzle/KPattern";
+import type {
+  ExperimentalAlgLeafEvent,
+  ExperimentalOrientationEvent,
+} from "../../stream";
 import {
   BasicRotationTransformer,
   type StreamTransformer,
 } from "../transformer";
 
 /******** BluetoothPuzzle ********/
 
-// TODO: Use actual `CustomEvent`s?
-// https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent
-/** @category Smart Puzzles */
-export interface AlgLeafEvent {
-  latestAlgLeaf: AlgLeaf;
-  timeStamp: number;
-  debug?: Record<string, unknown>;
-  pattern?: KPattern;
-  quaternion?: any; // TODO: Unused
-}
-
-// TODO: Only use the `quaternion` field in the `AlgLeafEvent`?
-/** @category Smart Puzzles */
-export interface OrientationEvent {
-  quaternion: {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-  };
-  timeStamp: number;
-  debug?: Record<string, unknown>;
-}
-
 export interface BluetoothConfig<T> {
   connect:
     | ((
@@ -52,8 +31,10 @@ export interface BluetoothConfig<T> {
 /** @category Smart Puzzles */
 export abstract class BluetoothPuzzle extends EventTarget {
   public transformers: StreamTransformer[] = [];
-  protected listeners: Array<(e: AlgLeafEvent) => void> = []; // TODO: type
-  protected orientationListeners: Array<(e: OrientationEvent) => void> = []; // TODO: type
+  protected listeners: Array<(e: ExperimentalAlgLeafEvent) => void> = []; // TODO: type
+  protected orientationListeners: Array<
+    (e: ExperimentalOrientationEvent) => void
+  > = []; // TODO: type
 
   public abstract name(): string | undefined;
   public abstract disconnect(): void; // TODO: Can we make this reutrn (async) on success?
@@ -63,19 +44,23 @@ export abstract class BluetoothPuzzle extends EventTarget {
     throw new Error("cannot get pattern");
   }
 
-  public addAlgLeafListener(listener: (e: AlgLeafEvent) => void): void {
+  public addAlgLeafListener(
+    listener: (e: ExperimentalAlgLeafEvent) => void,
+  ): void {
     this.listeners.push(listener);
   }
 
-  public addOrientationListener(listener: (e: OrientationEvent) => void): void {
+  public addOrientationListener(
+    listener: (e: ExperimentalOrientationEvent) => void,
+  ): void {
     this.orientationListeners.push(listener);
   }
 
   public experimentalAddBasicRotationTransformer(): void {
     this.transformers.push(new BasicRotationTransformer());
   }
 
-  protected dispatchAlgLeaf(algLeaf: AlgLeafEvent): void {
+  protected dispatchAlgLeaf(algLeaf: ExperimentalAlgLeafEvent): void {
     for (const transformer of this.transformers) {
       transformer.transformAlgLeaf(algLeaf);
     }
@@ -84,7 +69,9 @@ export abstract class BluetoothPuzzle extends EventTarget {
     }
   }
 
-  protected dispatchOrientation(orientationEvent: OrientationEvent): void {
+  protected dispatchOrientation(
+    orientationEvent: ExperimentalOrientationEvent,
+  ): void {
     for (const transformer of this.transformers) {
       transformer.transformOrientation(orientationEvent);
     }

src/cubing/bluetooth/transformer.ts

@@ -1,16 +1,16 @@
 import { Quaternion } from "three/src/math/Quaternion.js";
 import { Vector3 } from "three/src/math/Vector3.js";
 import type {
-  AlgLeafEvent,
-  OrientationEvent,
-} from "./smart-puzzle/bluetooth-puzzle";
+  ExperimentalAlgLeafEvent,
+  ExperimentalOrientationEvent,
+} from "../stream";
 
 // TODO: Combine orientation and alg leaves into a single event to handle quaternion remapping.
 export interface StreamTransformer {
   // Modifies the input.
-  transformAlgLeaf(algLeafEvent: AlgLeafEvent): void;
+  transformAlgLeaf(algLeafEvent: ExperimentalAlgLeafEvent): void;
   // Modifies the input.
-  transformOrientation(orientationEvent: OrientationEvent): void;
+  transformOrientation(orientationEvent: ExperimentalOrientationEvent): void;
 }
 
 function maxAxis(v: Vector3): string {
@@ -45,11 +45,13 @@ const m: { [s: string]: Quaternion } = {
 export class BasicRotationTransformer implements StreamTransformer {
   // private reorientQuat = new Quaternion();
 
-  public transformAlgLeaf(_algLeafEvent: AlgLeafEvent): void {
+  public transformAlgLeaf(_algLeafEvent: ExperimentalAlgLeafEvent): void {
     // Nothing to do.
   }
 
-  public transformOrientation(orientationEvent: OrientationEvent): void {
+  public transformOrientation(
+    orientationEvent: ExperimentalOrientationEvent,
+  ): void {
     const { x, y, z, w } = orientationEvent.quaternion;
     const quat = new Quaternion(x, y, z, w);
 

src/cubing/search/instantiator.ts

@@ -72,7 +72,7 @@ async function instantiateModuleWorkerAttempt(
       const worker = (await constructWorker(url, {
         type: "module",
       })) as Worker & {
-        nodeWorker?: import("worker_threads").Worker;
+        nodeWorker?: import("node:worker_threads").Worker;
       } & BunWorker;
 
       worker.unref?.(); // Unref in `bun`.

src/cubing/stream/events.ts

@@ -0,0 +1,43 @@
+// TODO: Use actual `CustomEvent`s?
+// https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent
+
+import type { AlgLeaf } from "../alg";
+import type { KPattern } from "../kpuzzle";
+
+/** @category Smart Puzzles */
+export interface AlgLeafEvent {
+  latestAlgLeaf: AlgLeaf;
+  timeStamp: number;
+  debug?: Record<string, unknown>;
+  pattern?: KPattern;
+  quaternion?: any; // TODO: Unused
+}
+
+// TODO: Only use the `quaternion` field in the `AlgLeafEvent`?
+/** @category Smart Puzzles */
+export interface OrientationEvent {
+  quaternion: {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+  };
+  timeStamp: number;
+  debug?: Record<string, unknown>;
+}
+
+export interface ProxyMoveEvent {
+  event: "move";
+  data: AlgLeafEvent;
+}
+export interface ProxyOrientationEvent {
+  event: "orientation";
+  data: OrientationEvent;
+}
+export interface ProxyResetEvent {
+  event: "reset";
+}
+export type ProxyEvent =
+  | ProxyMoveEvent
+  | ProxyOrientationEvent
+  | ProxyResetEvent;

src/cubing/stream/index.ts

@@ -5,11 +5,13 @@
  */
 
 export type {
+  AlgLeafEvent as ExperimentalAlgLeafEvent,
+  OrientationEvent as ExperimentalOrientationEvent,
   ProxyEvent as ExperimentalProxyEvent,
   ProxyMoveEvent as ExperimentalProxyMoveEvent,
   ProxyOrientationEvent as ExperimentalProxyOrientationEvent,
   ProxyResetEvent as ExperimentalProxyResetEvent,
-} from "./proxy-event";
+} from "./events";
 export { TwizzleStreamServer as ExperimentalTwizzleStreamServer } from "./twizzle/TwizzleStream";
 export {
   WebSocketProxyReceiver as ExperimentalWebSocketProxyReceiver,

src/cubing/stream/proxy-event.ts

@@ -1,5 +1,4 @@
-import type { MoveEvent, OrientationEvent } from "../bluetooth";
-import type { ProxyEvent } from "./proxy-event";
+import type { AlgLeafEvent, OrientationEvent, ProxyEvent } from "./events";
 
 export class WebSocketProxySender {
   protected websocket: WebSocket;
@@ -10,7 +9,7 @@ export class WebSocketProxySender {
     this.websocket.onmessage = this.onmessage.bind(this);
   }
 
-  public sendMoveEvent(e: MoveEvent): void {
+  public sendMoveEvent(e: AlgLeafEvent): void {
     (e as any).latestAlgLeaf = e.latestAlgLeaf.toString(); // TODO
     this.sendProxyEvent({
       event: "move",