@neurodevs/node-lsl 18.0.0 → 19.0.0

package/src/testDoubles/BleController/SpyBleController.ts

@@ -0,0 +1,61 @@
+import BleDeviceController, {
+    BleControllerOptions,
+} from '../../impl/controllers/BleDeviceController.js'
+
+export default class SpyBleController extends BleDeviceController {
+    public infoLogs: string[] = []
+    public warnLogs: string[] = []
+    public errorLogs: string[] = []
+
+    public constructor(options: BleControllerOptions) {
+        super(options)
+    }
+
+    public getCharacteristicCallbacks() {
+        return this.charCallbacks
+    }
+
+    public getRssiIntervalMs() {
+        return this.rssiIntervalMs
+    }
+
+    public getConnected() {
+        return this.connected
+    }
+
+    public setLogInfoSpy() {
+        this.infoLogs = []
+
+        this.log.info = (...args: unknown[]) => {
+            const message = args.join(' ')
+            this.infoLogs.push(message)
+            return message
+        }
+    }
+
+    public setLogWarnSpy() {
+        this.warnLogs = []
+
+        this.log.warn = (...args: unknown[]) => {
+            const message = args.join(' ')
+            this.warnLogs.push(message)
+            return message
+        }
+    }
+
+    public setLogErrorSpy() {
+        this.errorLogs = []
+
+        this.log.error = (...args: unknown[]) => {
+            const message = args.join(' ')
+            this.errorLogs.push(message)
+            return message
+        }
+    }
+
+    public resetTestDouble() {
+        this.infoLogs = []
+        this.warnLogs = []
+        this.errorLogs = []
+    }
+}

package/src/testDoubles/ClockRegressor/FakeClockRegressor.ts

@@ -0,0 +1,46 @@
+import {
+    ClockRegressor,
+    WindowedClockRegressorOptions,
+} from '../../impl/WindowedClockRegressor.js'
+
+export default class FakeClockRegressor implements ClockRegressor {
+    public static callsToConstructor: {
+        nominalHz: number
+        options?: WindowedClockRegressorOptions
+    }[] = []
+    public static callsToDeriveTimestamps: {
+        deviceTime: number
+        earliestLslTime: number
+        chunkSize: number
+    }[] = []
+
+    public static fakeResultValue = 0
+
+    public readonly nominalHz: number
+
+    public constructor(
+        nominalHz: number,
+        options?: WindowedClockRegressorOptions
+    ) {
+        FakeClockRegressor.callsToConstructor.push({ nominalHz, options })
+        this.nominalHz = nominalHz
+    }
+
+    public deriveTimestamps(
+        deviceTime: number,
+        earliestLslTime: number,
+        chunkSize: number
+    ) {
+        FakeClockRegressor.callsToDeriveTimestamps.push({
+            deviceTime,
+            earliestLslTime,
+            chunkSize,
+        })
+        return Array(chunkSize).fill(FakeClockRegressor.fakeResultValue)
+    }
+
+    public static resetTestDouble() {
+        FakeClockRegressor.callsToConstructor = []
+        FakeClockRegressor.callsToDeriveTimestamps = []
+    }
+}

package/src/testDoubles/StreamOutlet/FakeStreamOutlet.ts

@@ -13,7 +13,7 @@ export default class FakeStreamOutlet implements StreamOutlet {
 
     public static callsToPushSample: {
         sample: LslSample
-        timestamp?: number
+        timestampSec?: number
     }[] = []
 
     public static numCallsToDestroy = 0
@@ -29,8 +29,11 @@ export default class FakeStreamOutlet implements StreamOutlet {
         FakeStreamOutlet.numCallsToDestroy++
     }
 
-    public pushSample(sample: LslSample, timestamp?: number) {
-        FakeStreamOutlet.callsToPushSample.push({ sample, timestamp })
+    public pushSample(sample: LslSample, timestampSec?: number) {
+        FakeStreamOutlet.callsToPushSample.push({
+            sample,
+            timestampSec,
+        })
     }
 
     public get name() {

package/src/testDoubles/UsbController/FakeUsbController.ts

@@ -0,0 +1,34 @@
+import {
+    UsbController,
+    UsbControllerOptions,
+} from '../../impl/controllers/UsbDeviceController.js'
+
+export default class FakeUsbController implements UsbController {
+    public static callsToConstructor: (UsbControllerOptions | undefined)[] = []
+    public static numCallsToConnect = 0
+    public static callsToWriteUsb: string[] = []
+    public static numCallsToDisconnect = 0
+
+    public constructor(options?: UsbControllerOptions) {
+        FakeUsbController.callsToConstructor.push(options)
+    }
+
+    public async connect() {
+        FakeUsbController.numCallsToConnect++
+    }
+
+    public async writeUsb(value: string) {
+        FakeUsbController.callsToWriteUsb.push(value)
+    }
+
+    public async disconnect() {
+        FakeUsbController.numCallsToDisconnect++
+    }
+
+    public static resetTestDouble() {
+        FakeUsbController.callsToConstructor.length = 0
+        FakeUsbController.numCallsToConnect = 0
+        FakeUsbController.callsToWriteUsb.length = 0
+        FakeUsbController.numCallsToDisconnect = 0
+    }
+}

package/src/testDoubles/WebSocketBridge/FakeWebSocketBridge.ts

@@ -8,8 +8,7 @@ import FakeWebSocketServer from '../WebSockets/FakeWebSocketServer.js'
 
 export default class FakeWebSocketBridge implements WebSocketBridge {
     public static callsToConstructor: (
-        | WebSocketBridgeConstructorOptions
-        | undefined
+        WebSocketBridgeConstructorOptions | undefined
     )[] = []
 
     public static numCallsToActivate = 0

package/src/testDoubles/generateRandomOutletOptions.ts

@@ -1,4 +1,5 @@
-import { randomInt } from 'crypto'
+import { randomInt } from 'node:crypto'
+
 import generateId from '@neurodevs/generate-id'
 
 import { StreamOutletOptions } from '../impl/LslStreamOutlet.js'

package/tsconfig.json

@@ -1,28 +1,24 @@
 {
-	"compilerOptions": {
-		"module": "nodenext",
-		"moduleResolution": "nodenext",
-		"target": "ES2022",
-		"lib": ["ES2022"],
-		"types": ["node"],
-		"baseUrl": "src",
-		"outDir": "build",
-		"sourceMap": false,
-		"strict": true,
-		"noImplicitAny": true,
-		"noImplicitReturns": true,
-		"noUnusedLocals": true,
-		"forceConsistentCasingInFileNames": true,
-		"declaration": true,
-		"skipLibCheck": true,
-		"esModuleInterop": true,
-		"moduleDetection": "force",
-		"allowJs": true,
-		"resolveJsonModule": true,
-		"experimentalDecorators": true
-	},
-	"include": [
-		"./src/*.ts",
-		"./src/**/*.ts"
-	]
-}
+  "compilerOptions": {
+    "module": "nodenext",
+    "target": "esnext",
+    "lib": ["esnext"],
+    "types": ["node"],
+    "rootDir": "src",
+    "outDir": "build",
+    "sourceMap": false,
+    "strict": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "moduleDetection": "force",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true
+  },
+  "include": ["./src/*.ts", "./src/**/*.ts"]
+}

package/.regressionproof.json

@@ -1,7 +0,0 @@
-{
-  "version": "0.8.0",
-  "projectName": "node-lsl",
-  "remote": {
-    "url": "https://git.regressionproof.ai/liquidg3/node-lsl.git"
-  }
-}

package/build/.spruce/settings.json

@@ -1,15 +0,0 @@
-{
-  "scriptUpdater": {
-    "skipped": []
-  },
-  "skipped": [
-    "skill"
-  ],
-  "installed": [
-    "test"
-  ],
-  "regressionproof": {
-    "enabled": true,
-    "projectName": "node-lsl"
-  }
-}

package/build/__tests__/impl/LslBackpressureMonitor.test.d.ts

@@ -1,7 +0,0 @@
-import AbstractPackageTest from '../AbstractPackageTest.js';
-export default class LslBackpressureMonitorTest extends AbstractPackageTest {
-    private static instance;
-    protected static beforeEach(): Promise<void>;
-    protected static createsInstance(): Promise<void>;
-    private static LslBackpressureMonitor;
-}

package/build/__tests__/impl/LslBackpressureMonitor.test.js

@@ -1,26 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { test, assert } from '@neurodevs/node-tdd';
-import LslBackpressureMonitor from '../../impl/LslBackpressureMonitor.js';
-import AbstractPackageTest from '../AbstractPackageTest.js';
-export default class LslBackpressureMonitorTest extends AbstractPackageTest {
-    static instance;
-    static async beforeEach() {
-        await super.beforeEach();
-        this.instance = this.LslBackpressureMonitor();
-    }
-    static async createsInstance() {
-        assert.isTruthy(this.instance, 'Failed to create instance!');
-    }
-    static LslBackpressureMonitor() {
-        return LslBackpressureMonitor.Create();
-    }
-}
-__decorate([
-    test()
-], LslBackpressureMonitorTest, "createsInstance", null);
-//# sourceMappingURL=LslBackpressureMonitor.test.js.map

package/build/__tests__/impl/LslBackpressureMonitor.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LslBackpressureMonitor.test.js","sourceRoot":"","sources":["../../../src/__tests__/impl/LslBackpressureMonitor.test.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,sBAEN,MAAM,sCAAsC,CAAA;AAC7C,OAAO,mBAAmB,MAAM,2BAA2B,CAAA;AAE3D,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,mBAAmB;IAC/D,MAAM,CAAC,QAAQ,CAAqB;IAElC,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;QAExB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAA;IACjD,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,eAAe;QAClC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAA;IAChE,CAAC;IAEO,MAAM,CAAC,sBAAsB;QACjC,OAAO,sBAAsB,CAAC,MAAM,EAAE,CAAA;IAC1C,CAAC;CACJ;AAP0B;IADtB,IAAI,EAAE;uDAGN"}

package/build/impl/LslBackpressureMonitor.d.ts

@@ -1,8 +0,0 @@
-export default class LslBackpressureMonitor implements BackpressureMonitor {
-    static Class?: BackpressureMonitorConstructor;
-    protected constructor();
-    static Create(): LslBackpressureMonitor;
-}
-export interface BackpressureMonitor {
-}
-export type BackpressureMonitorConstructor = new () => BackpressureMonitor;

package/build/impl/LslBackpressureMonitor.js

@@ -1,8 +0,0 @@
-export default class LslBackpressureMonitor {
-    static Class;
-    constructor() { }
-    static Create() {
-        return new (this.Class ?? this)();
-    }
-}
-//# sourceMappingURL=LslBackpressureMonitor.js.map

package/build/impl/LslBackpressureMonitor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LslBackpressureMonitor.js","sourceRoot":"","sources":["../../src/impl/LslBackpressureMonitor.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,sBAAsB;IAChC,MAAM,CAAC,KAAK,CAAiC;IAEpD,gBAAyB,CAAC;IAEnB,MAAM,CAAC,MAAM;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,CAAA;IACrC,CAAC;CACJ"}

package/build/testDoubles/BackpressureMonitor/FakeBackpressureMonitor.d.ts

@@ -1,6 +0,0 @@
-import { BackpressureMonitor } from '../../impl/LslBackpressureMonitor.js';
-export default class FakeBackpressureMonitor implements BackpressureMonitor {
-    static numCallsToConstructor: number;
-    constructor();
-    static resetTestDouble(): void;
-}

package/build/testDoubles/BackpressureMonitor/FakeBackpressureMonitor.js

@@ -1,10 +0,0 @@
-export default class FakeBackpressureMonitor {
-    static numCallsToConstructor = 0;
-    constructor() {
-        FakeBackpressureMonitor.numCallsToConstructor++;
-    }
-    static resetTestDouble() {
-        FakeBackpressureMonitor.numCallsToConstructor = 0;
-    }
-}
-//# sourceMappingURL=FakeBackpressureMonitor.js.map

package/build/testDoubles/BackpressureMonitor/FakeBackpressureMonitor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FakeBackpressureMonitor.js","sourceRoot":"","sources":["../../../src/testDoubles/BackpressureMonitor/FakeBackpressureMonitor.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,OAAO,uBAAuB;IACjC,MAAM,CAAC,qBAAqB,GAAG,CAAC,CAAA;IAEvC;QACI,uBAAuB,CAAC,qBAAqB,EAAE,CAAA;IACnD,CAAC;IAEM,MAAM,CAAC,eAAe;QACzB,uBAAuB,CAAC,qBAAqB,GAAG,CAAC,CAAA;IACrD,CAAC"}

package/eslint.config.mjs

@@ -1,3 +0,0 @@
-import eslintConfigSpruce from 'eslint-config-spruce'
-
-export default eslintConfigSpruce

package/src/.spruce/settings.json

@@ -1,15 +0,0 @@
-{
-  "scriptUpdater": {
-    "skipped": []
-  },
-  "skipped": [
-    "skill"
-  ],
-  "installed": [
-    "test"
-  ],
-  "regressionproof": {
-    "enabled": true,
-    "projectName": "node-lsl"
-  }
-}

package/src/__tests__/impl/LslBackpressureMonitor.test.ts

@@ -1,25 +0,0 @@
-import { test, assert } from '@neurodevs/node-tdd'
-
-import LslBackpressureMonitor, {
-    BackpressureMonitor,
-} from '../../impl/LslBackpressureMonitor.js'
-import AbstractPackageTest from '../AbstractPackageTest.js'
-
-export default class LslBackpressureMonitorTest extends AbstractPackageTest {
-    private static instance: BackpressureMonitor
-
-    protected static async beforeEach() {
-        await super.beforeEach()
-
-        this.instance = this.LslBackpressureMonitor()
-    }
-
-    @test()
-    protected static async createsInstance() {
-        assert.isTruthy(this.instance, 'Failed to create instance!')
-    }
-
-    private static LslBackpressureMonitor() {
-        return LslBackpressureMonitor.Create()
-    }
-}

package/src/impl/LslBackpressureMonitor.ts

@@ -1,13 +0,0 @@
-export default class LslBackpressureMonitor implements BackpressureMonitor {
-    public static Class?: BackpressureMonitorConstructor
-
-    protected constructor() {}
-
-    public static Create() {
-        return new (this.Class ?? this)()
-    }
-}
-
-export interface BackpressureMonitor {}
-
-export type BackpressureMonitorConstructor = new () => BackpressureMonitor

package/src/testDoubles/BackpressureMonitor/FakeBackpressureMonitor.ts

@@ -1,13 +0,0 @@
-import { BackpressureMonitor } from '../../impl/LslBackpressureMonitor.js'
-
-export default class FakeBackpressureMonitor implements BackpressureMonitor {
-    public static numCallsToConstructor = 0
-
-    public constructor() {
-        FakeBackpressureMonitor.numCallsToConstructor++
-    }
-
-    public static resetTestDouble() {
-        FakeBackpressureMonitor.numCallsToConstructor = 0
-    }
-}