@neurodevs/node-lsl 17.1.1 → 18.0.0

package/build/testDoubles/WebSocketBridge/FakeWebSocketBridge.js

@@ -9,7 +9,7 @@ export default class FakeWebSocketBridge {
     constructor(options) {
         FakeWebSocketBridge.callsToConstructor.push(options);
     }
-    activate() {
+    async activate() {
         FakeWebSocketBridge.numCallsToActivate++;
     }
     deactivate() {

package/build/testDoubles/WebSocketBridge/FakeWebSocketBridge.js.map

@@ -1 +1 @@
-{"version":3,"file":"FakeWebSocketBridge.js","sourceRoot":"","sources":["../../../src/testDoubles/WebSocketBridge/FakeWebSocketBridge.ts"],"names":[],"mappings":"AACA,OAAO,kBAGN,MAAM,kCAAkC,CAAA;AACzC,OAAO,aAAa,MAAM,gCAAgC,CAAA;AAC1D,OAAO,mBAAmB,MAAM,sCAAsC,CAAA;AAEtE,MAAM,CAAC,OAAO,OAAO,mBAAmB;IAC7B,MAAM,CAAC,kBAAkB,GAG1B,EAAE,CAAA;IAED,MAAM,CAAC,kBAAkB,GAAG,CAAC,CAAA;IAC7B,MAAM,CAAC,oBAAoB,GAAG,CAAC,CAAA;IAC/B,MAAM,CAAC,iBAAiB,GAAG,CAAC,CAAA;IAEnC,YAAmB,OAA2C;QAC1D,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAEM,QAAQ;QACX,mBAAmB,CAAC,kBAAkB,EAAE,CAAA;IAC5C,CAAC;IAEM,UAAU;QACb,mBAAmB,CAAC,oBAAoB,EAAE,CAAA;IAC9C,CAAC;IAEM,OAAO;QACV,mBAAmB,CAAC,iBAAiB,EAAE,CAAA;IAC3C,CAAC;IAEM,MAAM,CAAC,eAAe;QACzB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAA;QAC7B,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAA;QAE1B,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,IAAI,CAAC,sBAAsB,EAAE,CAAA;IACjC,CAAC;IAEO,MAAM,CAAC,gBAAgB;QAC3B,kBAAkB,CAAC,EAAE,GAAG,aAA4C,CAAA;QACpE,aAAa,CAAC,eAAe,EAAE,CAAA;IACnC,CAAC;IAEO,MAAM,CAAC,sBAAsB;QACjC,kBAAkB,CAAC,GAAG;YAClB,mBAAwD,CAAA;QAC5D,mBAAmB,CAAC,eAAe,EAAE,CAAA;IACzC,CAAC"}
+{"version":3,"file":"FakeWebSocketBridge.js","sourceRoot":"","sources":["../../../src/testDoubles/WebSocketBridge/FakeWebSocketBridge.ts"],"names":[],"mappings":"AACA,OAAO,kBAGN,MAAM,kCAAkC,CAAA;AACzC,OAAO,aAAa,MAAM,gCAAgC,CAAA;AAC1D,OAAO,mBAAmB,MAAM,sCAAsC,CAAA;AAEtE,MAAM,CAAC,OAAO,OAAO,mBAAmB;IAC7B,MAAM,CAAC,kBAAkB,GAG1B,EAAE,CAAA;IAED,MAAM,CAAC,kBAAkB,GAAG,CAAC,CAAA;IAC7B,MAAM,CAAC,oBAAoB,GAAG,CAAC,CAAA;IAC/B,MAAM,CAAC,iBAAiB,GAAG,CAAC,CAAA;IAEnC,YAAmB,OAA2C;QAC1D,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAEM,KAAK,CAAC,QAAQ;QACjB,mBAAmB,CAAC,kBAAkB,EAAE,CAAA;IAC5C,CAAC;IAEM,UAAU;QACb,mBAAmB,CAAC,oBAAoB,EAAE,CAAA;IAC9C,CAAC;IAEM,OAAO;QACV,mBAAmB,CAAC,iBAAiB,EAAE,CAAA;IAC3C,CAAC;IAEM,MAAM,CAAC,eAAe;QACzB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAA;QAC7B,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAA;QAE1B,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,IAAI,CAAC,sBAAsB,EAAE,CAAA;IACjC,CAAC;IAEO,MAAM,CAAC,gBAAgB;QAC3B,kBAAkB,CAAC,EAAE,GAAG,aAA4C,CAAA;QACpE,aAAa,CAAC,eAAe,EAAE,CAAA;IACnC,CAAC;IAEO,MAAM,CAAC,sBAAsB;QACjC,kBAAkB,CAAC,GAAG;YAClB,mBAAwD,CAAA;QAC5D,mBAAmB,CAAC,eAAe,EAAE,CAAA;IACzC,CAAC"}

package/build/testDoubles/WorkerThreads/FakeWorker.d.ts

@@ -0,0 +1,27 @@
+import { WorkerOptions } from 'node:worker_threads';
+import { OnDataCallback } from '../../impl/LslStreamInlet.js';
+import StreamInletWorker from '../../impl/workers/inlet/StreamInletWorker.js';
+export default class FakeWorker {
+    static callsToConstructor: {
+        filename: string | URL;
+        options?: WorkerOptions;
+    }[];
+    static callsToPostMessage: WorkerMessage[];
+    static callsToOn: {
+        type: string;
+        listener: (...args: unknown[]) => void;
+    }[];
+    static inletWorker: StreamInletWorker;
+    static fakeOnData: OnDataCallback;
+    createInletPromise?: Promise<void>;
+    constructor(filename: string | URL, options?: WorkerOptions);
+    postMessage(msg: WorkerMessage): void;
+    on(type: string, listener: (...args: unknown[]) => void): void;
+    private get inletWorker();
+    private get fakeOnData();
+    static resetTestDoubles(): void;
+}
+export interface WorkerMessage {
+    type: string;
+    payload?: Record<string, unknown>[];
+}

package/build/testDoubles/WorkerThreads/FakeWorker.js

@@ -0,0 +1,67 @@
+import StreamInletWorker from '../../impl/workers/inlet/StreamInletWorker.js';
+import { createOutlet, destroyOutlet, pushSample, } from '../../impl/workers/outlet/LslStreamOutlet.worker.js';
+export default class FakeWorker {
+    static callsToConstructor = [];
+    static callsToPostMessage = [];
+    static callsToOn = [];
+    static inletWorker = new StreamInletWorker();
+    static fakeOnData;
+    createInletPromise;
+    constructor(filename, options) {
+        FakeWorker.callsToConstructor.push({ filename, options });
+    }
+    postMessage(msg) {
+        FakeWorker.callsToPostMessage.push(msg);
+        const { type } = msg;
+        switch (type) {
+            case 'createOutlet': {
+                createOutlet(msg);
+                break;
+            }
+            case 'pushSample': {
+                pushSample(msg);
+                break;
+            }
+            case 'destroyOutlet': {
+                destroyOutlet();
+                break;
+            }
+            case 'createInlet': {
+                const { payload } = msg;
+                this.createInletPromise = this.inletWorker.createInlet(payload);
+                break;
+            }
+            case 'startPulling': {
+                this.inletWorker.startPulling(this.fakeOnData);
+                break;
+            }
+            case 'flushInlet': {
+                this.inletWorker.flushInlet();
+                break;
+            }
+            case 'stopPulling': {
+                this.inletWorker.stopPulling();
+                break;
+            }
+            case 'destroyInlet': {
+                this.inletWorker.destroyInlet();
+                break;
+            }
+        }
+    }
+    on(type, listener) {
+        FakeWorker.callsToOn.push({ type, listener });
+    }
+    get inletWorker() {
+        return FakeWorker.inletWorker;
+    }
+    get fakeOnData() {
+        return FakeWorker.fakeOnData;
+    }
+    static resetTestDoubles() {
+        this.callsToConstructor = [];
+        this.callsToPostMessage = [];
+        this.callsToOn = [];
+    }
+}
+//# sourceMappingURL=FakeWorker.js.map

package/build/testDoubles/WorkerThreads/FakeWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FakeWorker.js","sourceRoot":"","sources":["../../../src/testDoubles/WorkerThreads/FakeWorker.ts"],"names":[],"mappings":"AAGA,OAAO,iBAAiB,MAAM,+CAA+C,CAAA;AAC7E,OAAO,EACH,YAAY,EACZ,aAAa,EACb,UAAU,GACb,MAAM,qDAAqD,CAAA;AAE5D,MAAM,CAAC,OAAO,OAAO,UAAU;IACpB,MAAM,CAAC,kBAAkB,GAG1B,EAAE,CAAA;IAED,MAAM,CAAC,kBAAkB,GAAoB,EAAE,CAAA;IAE/C,MAAM,CAAC,SAAS,GAGjB,EAAE,CAAA;IAED,MAAM,CAAC,WAAW,GAAG,IAAI,iBAAiB,EAAE,CAAA;IAC5C,MAAM,CAAC,UAAU,CAAgB;IAEjC,kBAAkB,CAAgB;IAEzC,YAAmB,QAAsB,EAAE,OAAuB;QAC9D,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAA;IAC7D,CAAC;IAEM,WAAW,CAAC,GAAkB;QACjC,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvC,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAA;QAEpB,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,cAAc,CAAC,CAAC,CAAC;gBAClB,YAAY,CAAC,GAAU,CAAC,CAAA;gBACxB,MAAK;YACT,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAChB,UAAU,CAAC,GAAU,CAAC,CAAA;gBACtB,MAAK;YACT,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACnB,aAAa,EAAE,CAAA;gBACf,MAAK;YACT,CAAC;YACD,KAAK,aAAa,CAAC,CAAC,CAAC;gBACjB,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAAA;gBACvB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAClD,OAAc,CACjB,CAAA;gBACD,MAAK;YACT,CAAC;YACD,KAAK,cAAc,CAAC,CAAC,CAAC;gBAClB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBAC9C,MAAK;YACT,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAChB,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAA;gBAC7B,MAAK;YACT,CAAC;YACD,KAAK,aAAa,CAAC,CAAC,CAAC;gBACjB,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAA;gBAC9B,MAAK;YACT,CAAC;YACD,KAAK,cAAc,CAAC,CAAC,CAAC;gBAClB,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAA;gBAC/B,MAAK;YACT,CAAC;QACL,CAAC;IACL,CAAC;IAEM,EAAE,CAAC,IAAY,EAAE,QAAsC;QAC1D,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAA;IACjD,CAAC;IAED,IAAY,WAAW;QACnB,OAAO,UAAU,CAAC,WAAW,CAAA;IACjC,CAAC;IAED,IAAY,UAAU;QAClB,OAAO,UAAU,CAAC,UAAU,CAAA;IAChC,CAAC;IAEM,MAAM,CAAC,gBAAgB;QAC1B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;IACvB,CAAC"}

package/build/validations.js

@@ -5,11 +5,9 @@ export function isGreaterThanOrEqualToZero(value) {
     return value >= 0;
 }
 export function isPositiveInteger(value) {
-    //@ts-ignore
     return Number.isInteger(value) && value > 0;
 }
 export function isPositiveIntegerOrZero(value) {
-    //@ts-ignore
     return Number.isInteger(value) && value >= 0;
 }
 //# sourceMappingURL=validations.js.map

package/build/validations.js.map

@@ -1 +1 @@
-{"version":3,"file":"validations.js","sourceRoot":"","sources":["../src/validations.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,KAAwB;IACnE,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;AACtC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,KAAa;IACpD,OAAO,KAAK,IAAI,CAAC,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC3C,YAAY;IACZ,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAA;AAC/C,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAa;IACjD,YAAY;IACZ,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AAChD,CAAC"}
+{"version":3,"file":"validations.js","sourceRoot":"","sources":["../src/validations.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,KAAwB;IACnE,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;AACtC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,KAAa;IACpD,OAAO,KAAK,IAAI,CAAC,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC3C,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAA;AAC/C,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAa;IACjD,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AAChD,CAAC"}

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "@neurodevs/node-lsl",
-  "version": "17.1.1",
+  "version": "18.0.0",
   "description": "Lab Streaming Layer (LSL) bindings for Node",
   "type": "module",
   "keywords": [
     "nodejs",
     "typescript",
-    "tdd"
+    "tdd",
+    "lsl",
+    "lab streaming layer",
+    "neurotech",
+    "bci",
+    "brain-computer interface"
   ],
   "license": "MIT",
   "author": "Eric Yates <hello@ericthecurious.com>",
@@ -36,7 +41,7 @@
     "rebuild": "yarn run clean.all && yarn install && yarn run build.dev",
     "update.dependencies": "yarn run clean.dependencies && yarn",
     "resolve-paths.lint": "yarn run build.resolve-paths ; yarn run lint",
-    "test": "jest",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "watch.build.dev": "tsc-watch --sourceMap --onCompilationComplete 'yarn run post.watch.build'",
     "watch.lint": "concurrently 'yarn lint' \"chokidar 'src/**/*' -c 'yarn lint.tsc'\"",
     "watch.rebuild": "yarn run clean.all && yarn install && yarn run watch.build.dev",
@@ -44,7 +49,8 @@
     "test.rs": "node build/test.js"
   },
   "dependencies": {
-    "@neurodevs/generate-id": "^1.0.9",
+    "@neurodevs/generate-id": "^1.1.2",
+    "@neurodevs/ndx-native": "^0.2.0",
     "ffi-rs": "^1.3.1",
     "node-gyp": "^12.1.0",
     "ref-array-napi": "^1.2.2",
@@ -52,13 +58,15 @@
     "ws": "^8.18.3"
   },
   "devDependencies": {
-    "@neurodevs/node-tdd": "^0.2.3",
+    "@neurodevs/node-tdd": "0.2.5",
+    "@regressionproof/cli": "^0.8.0",
+    "@regressionproof/jest-reporter": "^0.8.0",
     "@types/ffi-napi": "^4.0.10",
     "@types/node": "^25.0.2",
     "@types/ws": "^8.18.1",
     "chokidar-cli": "^3.0.0",
     "concurrently": "^9.2.1",
-    "eslint": "^9.39.2",
+    "eslint": "8.57.0",
     "eslint-config-spruce": "^11.2.26",
     "jest": "^30.2.0",
     "jest-circus": "^30.2.0",
@@ -72,6 +80,10 @@
     "maxWorkers": 4,
     "testTimeout": 120000,
     "testEnvironment": "node",
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "transform": {},
     "testPathIgnorePatterns": [
       "<rootDir>/tmp/",
       "<rootDir>/src/",
@@ -83,7 +95,11 @@
     ],
     "moduleNameMapper": {
       "^#spruce/(.*)$": "<rootDir>/build/.spruce/$1"
-    }
+    },
+    "reporters": [
+      "default",
+      "@regressionproof/jest-reporter"
+    ]
   },
   "skill": {
     "namespace": "node-lsl",

package/src/.spruce/settings.json

@@ -7,5 +7,9 @@
   ],
   "installed": [
     "test"
-  ]
+  ],
+  "regressionproof": {
+    "enabled": true,
+    "projectName": "node-lsl"
+  }
 }

package/src/__tests__/AbstractPackageTest.ts

@@ -1,8 +1,8 @@
+import { FakeLiblsl, InfoHandle, LiblslAdapter } from '@neurodevs/ndx-native'
 import AbstractModuleTest from '@neurodevs/node-tdd'
 import WebSocket, { Server } from 'ws'
 
-import LiblslAdapter from '../impl/LiblslAdapter.js'
-import LslEventMarkerOutlet from '../impl/LslEventMarkerOutlet.js'
+import LslEventMarkerEmitter from '../impl/LslEventMarkerEmitter.js'
 import LslStreamInfo from '../impl/LslStreamInfo.js'
 import LslStreamInlet, {
     OnDataCallback,
@@ -10,9 +10,7 @@ import LslStreamInlet, {
 } from '../impl/LslStreamInlet.js'
 import LslStreamOutlet from '../impl/LslStreamOutlet.js'
 import LslWebSocketBridge from '../impl/LslWebSocketBridge.js'
-
-import SpyEventMarkerOutlet from '../testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js'
-import FakeLiblsl from '../testDoubles/Liblsl/FakeLiblsl.js'
+import SpyEventMarkerEmitter from '../testDoubles/EventMarkerEmitter/SpyEventMarkerEmitter.js'
 import FakeStreamInfo from '../testDoubles/StreamInfo/FakeStreamInfo.js'
 import SpyStreamInfo from '../testDoubles/StreamInfo/SpyStreamInfo.js'
 import FakeStreamInlet from '../testDoubles/StreamInlet/FakeStreamInlet.js'
@@ -34,6 +32,7 @@ export default class AbstractPackageTest extends AbstractModuleTest {
         LiblslAdapter.setInstance(this.fakeLiblsl)
 
         FakeLiblsl.fakeErrorCode = 0
+        FakeLiblsl.fakeInfoHandles = [{} as InfoHandle]
     }
 
     protected static setSpyStreamInfo() {
@@ -60,8 +59,8 @@ export default class AbstractPackageTest extends AbstractModuleTest {
         FakeStreamOutlet.resetTestDouble()
     }
 
-    protected static setSpyEventMarkerOutlet() {
-        LslEventMarkerOutlet.Class = SpyEventMarkerOutlet
+    protected static setSpyEventMarkerEmitter() {
+        LslEventMarkerEmitter.Class = SpyEventMarkerEmitter
     }
 
     protected static setSpyLslWebSocketBridge() {
@@ -78,7 +77,8 @@ export default class AbstractPackageTest extends AbstractModuleTest {
         FakeWebSocketServer.resetTestDouble()
     }
 
-    protected static readonly info = new FakeStreamInfo()
+    protected static readonly fakeStreamInfo = new FakeStreamInfo()
+
     protected static readonly name_ = this.generateId()
     protected static readonly type = this.generateId()
     protected static readonly sourceId = this.generateId()
@@ -90,9 +90,7 @@ export default class AbstractPackageTest extends AbstractModuleTest {
         this.generateId(),
     ]
 
-    protected static get channelCount() {
-        return this.channelNames.length
-    }
+    protected static readonly channelCount = this.channelNames.length
 
     protected static readonly chunkSize = 2
     protected static readonly sampleRateHz = Math.floor(Math.random() * 100)
@@ -102,12 +100,12 @@ export default class AbstractPackageTest extends AbstractModuleTest {
         options: Partial<StreamInletOptions>,
         onData: OnDataCallback
     ) {
-        const defaultOptions = {
-            info: this.info,
+        const defaultOptions: StreamInletOptions = {
+            sourceId: this.sourceId,
             chunkSize: this.chunkSize,
             maxBufferedMs: this.maxBufferedMs,
             ...options,
-        } as StreamInletOptions
+        }
 
         return LslStreamInlet.Create(defaultOptions, onData)
     }

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

@@ -0,0 +1,25 @@
+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/__tests__/impl/LslEventMarkerEmitter.test.ts

@@ -0,0 +1,322 @@
+import { randomInt } from 'crypto'
+import { assert, test } from '@neurodevs/node-tdd'
+
+import LslEventMarkerEmitter, {
+    EventMarkerOptions,
+} from '../../impl/LslEventMarkerEmitter.js'
+import { StreamOutletOptions } from '../../impl/LslStreamOutlet.js'
+import SpyEventMarkerEmitter from '../../testDoubles/EventMarkerEmitter/SpyEventMarkerEmitter.js'
+import generateRandomOutletOptions from '../../testDoubles/generateRandomOutletOptions.js'
+import FakeStreamOutlet from '../../testDoubles/StreamOutlet/FakeStreamOutlet.js'
+import AbstractPackageTest from '../AbstractPackageTest.js'
+
+export default class EventMarkerEmitterTest extends AbstractPackageTest {
+    private static instance: SpyEventMarkerEmitter
+
+    protected static async beforeEach() {
+        await super.beforeEach()
+
+        this.setFakeLiblsl()
+        this.setFakeStreamOutlet()
+        this.setSpyEventMarkerEmitter()
+
+        this.instance = await this.LslEventMarkerEmitter()
+    }
+
+    private static readonly markerName = this.generateId()
+
+    @test()
+    protected static async createsInstance() {
+        assert.isTruthy(this.instance, 'Failed to create instance!')
+    }
+
+    @test()
+    protected static async loadsWithEventMarkerSpecificOptions() {
+        assert.isEqualDeep(
+            {
+                ...FakeStreamOutlet.callsToConstructor[0],
+                name: undefined,
+                sourceId: undefined,
+            },
+            {
+                name: undefined,
+                type: 'Markers',
+                sourceId: undefined,
+                channelNames: ['Markers'],
+                channelFormat: 'string',
+                sampleRateHz: 0,
+                chunkSize: 1,
+            }
+        )
+
+        assert.isTrue(
+            FakeStreamOutlet.callsToConstructor[0]?.sourceId.startsWith(
+                'event-markers-'
+            ),
+            'Source ID was not generated uniquely!'
+        )
+
+        assert.isTrue(
+            FakeStreamOutlet.callsToConstructor[0]?.name.startsWith(
+                'Event markers ('
+            ),
+            'Name was not generated uniquely!'
+        )
+    }
+
+    @test()
+    protected static async canOverrideDefaultOptions() {
+        const options = generateRandomOutletOptions()
+        await this.LslEventMarkerEmitter(options)
+
+        assert.isEqualDeep(FakeStreamOutlet.callsToConstructor[1], options)
+    }
+
+    @test()
+    protected static async emittingSingleMarkerIncrementsHitCountAndWaitTime() {
+        const markers = [this.generateEventMarker()]
+        await this.instance.emitMany(markers)
+
+        const marker = markers[0]
+
+        assert.isEqual(
+            FakeStreamOutlet.callsToPushSample[0]?.sample[0],
+            marker.name,
+            'Pushed the wrong marker!'
+        )
+
+        assert.isEqual(this.instance.totalwaitAfterMs, marker.waitAfterMs)
+    }
+
+    @test()
+    protected static async emittingTwoMarkersIncrementsHitCountAndWaitTimeTwice() {
+        const markers = await this.emitManyFor(2)
+
+        assert.isEqual(FakeStreamOutlet.callsToPushSample.length, 2)
+
+        assert.isEqual(
+            this.instance.totalwaitAfterMs,
+            markers[0].waitAfterMs + markers[1].waitAfterMs
+        )
+    }
+
+    @test('interrupts on first marker', 1)
+    @test('interrupts on second marker', 2)
+    @test('interrupts on third marker', 3)
+    protected static async emitterIsInterruptable(bailIdx: number) {
+        let hitCount = 0
+
+        this.streamOutlet.pushSample = () => {
+            hitCount += 1
+            if (hitCount === bailIdx) {
+                this.interrupt()
+            }
+        }
+
+        await this.emitManyFor(10)
+
+        assert.isEqual(hitCount, bailIdx)
+    }
+
+    @test()
+    protected static async canStartAgainAfterInterrupting() {
+        this.interrupt()
+
+        let hitCount = 0
+
+        this.streamOutlet.pushSample = () => {
+            hitCount++
+        }
+
+        await this.emitManyFor(10)
+
+        assert.isEqual(hitCount, 10)
+    }
+
+    @test()
+    protected static async doesNotWaitIfInterrupted() {
+        await this.setupOutlet()
+
+        const startMs = Date.now()
+        const promise = this.emitManyFor(2, 1000)
+        this.interrupt()
+        await promise
+        const endMs = Date.now()
+
+        assert.isBelow(endMs - startMs, 10)
+    }
+
+    @test()
+    protected static async clearsTimeoutOnInterrupt() {
+        void this.emitManyFor(2, 100)
+        this.interrupt()
+
+        this.streamOutlet.pushSample = () =>
+            assert.fail('Should not have been called')
+    }
+
+    @test()
+    protected static async emitCallsPushSampleOnStreamOutlet() {
+        const markerName = this.generateId()
+        await this.emit(markerName)
+
+        assert.isEqualDeep(
+            FakeStreamOutlet.callsToPushSample[0]?.sample,
+            [markerName],
+            'Pushed the wrong sample!'
+        )
+    }
+
+    @test()
+    protected static async emitWaitsForMsIfPassed() {
+        SpyEventMarkerEmitter.shouldCallWaitOnSuper = true
+
+        const waitAfterMs = 10
+
+        const startMs = Date.now()
+        await this.instance.emit(this.markerName, { waitAfterMs })
+        const endMs = Date.now()
+
+        assert.isAbove(
+            endMs - startMs,
+            0.8 * waitAfterMs,
+            'Did not wait for the specified time!'
+        )
+    }
+
+    @test()
+    protected static async destroyCallsDestroyOnInternalStreamOutlet() {
+        this.destroy()
+
+        assert.isEqual(
+            FakeStreamOutlet.numCallsToDestroy,
+            1,
+            'Did not call destroy on outlet!'
+        )
+    }
+
+    @test()
+    protected static async destroyInterruptsIfRunning() {
+        let wasHit = false
+
+        const original = this.instance.interrupt.bind(this.instance)
+
+        this.instance.interrupt = () => {
+            wasHit = true
+            original()
+        }
+
+        const promise = this.emitManyFor(5, 10)
+        this.destroy()
+
+        assert.isTrue(wasHit, 'Did not call interrupt on destroy!')
+
+        await promise
+    }
+
+    @test()
+    protected static async sourceIdIsUniqueAcrossInstances() {
+        const instance = await this.LslEventMarkerEmitter()
+
+        assert.isNotEqual(
+            instance['outlet'].sourceId,
+            this.instance['outlet'].sourceId,
+            'Source IDs are not unique!'
+        )
+    }
+
+    @test()
+    protected static async emitThrowsIfCalledWhileAlreadyRunning() {
+        void this.instance.emit(this.markerName, { waitAfterMs: 10 })
+
+        await assert.doesThrowAsync(async () => {
+            await this.emit(this.generateId())
+        }, 'Cannot call emit while already running!')
+    }
+
+    @test()
+    protected static async emitManyThrowsIfCalledWhileAlreadyRunning() {
+        void EventMarkerEmitterTest.emitManyOnce()
+
+        await assert.doesThrowAsync(async () => {
+            await this.emitManyFor(5, 1)
+        }, 'Cannot call emitMany while already running!')
+    }
+
+    @test()
+    protected static async emitSetsIsRunningFalseOnceDone() {
+        await this.emitOnce()
+
+        assert.isFalse(
+            this.instance['isRunning'],
+            'emit did not set isRunning to false once done!'
+        )
+    }
+
+    @test()
+    protected static async emitManySetsIsRunningFalseOnceDone() {
+        await this.emitManyOnce()
+
+        assert.isFalse(
+            this.instance['isRunning'],
+            'emitMany did not set isRunning to false once done! '
+        )
+    }
+
+    private static async emitOnce() {
+        await this.emit(this.markerName)
+    }
+
+    private static async emit(
+        markerName: string,
+        options?: EventMarkerOptions
+    ) {
+        return this.instance.emit(markerName, options)
+    }
+
+    private static async emitManyOnce() {
+        return this.emitManyFor(5, 1)
+    }
+
+    private static async emitManyFor(total: number, waitAfterMs?: number) {
+        const markers = new Array(total)
+            .fill(null)
+            .map(() => this.generateEventMarker(waitAfterMs))
+
+        await this.instance.emitMany(markers)
+
+        return markers
+    }
+
+    private static generateEventMarker(waitAfterMs?: number) {
+        return {
+            name: this.generateId(),
+            waitAfterMs: waitAfterMs ?? randomInt(100, 1000),
+        }
+    }
+
+    private static interrupt() {
+        this.instance.interrupt()
+    }
+
+    private static destroy() {
+        this.instance.destroy()
+    }
+
+    private static get streamOutlet() {
+        return this.instance.getStreamOutlet()
+    }
+
+    private static async setupOutlet() {
+        LslEventMarkerEmitter.Class = LslEventMarkerEmitter as any
+        this.instance = await this.LslEventMarkerEmitter()
+    }
+
+    private static async LslEventMarkerEmitter(
+        options?: Partial<StreamOutletOptions>
+    ) {
+        return (await LslEventMarkerEmitter.Create(
+            options
+        )) as SpyEventMarkerEmitter
+    }
+}