@neurodevs/node-lsl 18.1.0 → 20.0.0

package/src/testDoubles/{StreamInfo/FakeStreamInfo.ts → LslInfo/FakeLslInfo.ts}

@@ -1,10 +1,10 @@
 import generateId from '@neurodevs/generate-id'
 import { InfoHandle } from '@neurodevs/ndx-native'
 
-import { StreamInfo, StreamInfoOptions } from '../../impl/LslStreamInfo.js'
+import { LslInfo, LslInfoOptions } from '../../impl/LslStreamInfo.js'
 
-export default class FakeStreamInfo implements StreamInfo {
-    public static callsToConstructor: (StreamInfoOptions | undefined)[] = []
+export default class FakeLslInfo implements LslInfo {
+    public static callsToConstructor: (LslInfoOptions | undefined)[] = []
     public static numCallsToDestroy = 0
 
     public static infoHandle = {} as InfoHandle
@@ -17,12 +17,12 @@ export default class FakeStreamInfo implements StreamInfo {
     public sampleRateHz = 0
     public units = 'N/A'
 
-    public constructor(options?: StreamInfoOptions) {
-        FakeStreamInfo.callsToConstructor.push(options)
+    public constructor(options?: LslInfoOptions) {
+        FakeLslInfo.callsToConstructor.push(options)
     }
 
     public destroy() {
-        FakeStreamInfo.numCallsToDestroy++
+        FakeLslInfo.numCallsToDestroy++
     }
 
     public get channelCount() {
@@ -30,11 +30,11 @@ export default class FakeStreamInfo implements StreamInfo {
     }
 
     public get infoHandle() {
-        return FakeStreamInfo.infoHandle
+        return FakeLslInfo.infoHandle
     }
 
     public static resetTestDouble() {
-        FakeStreamInfo.callsToConstructor = []
-        FakeStreamInfo.numCallsToDestroy = 0
+        FakeLslInfo.callsToConstructor = []
+        FakeLslInfo.numCallsToDestroy = 0
     }
 }

package/src/testDoubles/{StreamInfo/SpyStreamInfo.ts → LslInfo/SpyLslInfo.ts}

@@ -1,11 +1,11 @@
-import LslStreamInfo, { StreamInfoOptions } from '../../impl/LslStreamInfo.js'
+import LslStreamInfo, { LslInfoOptions } from '../../impl/LslStreamInfo.js'
 
-export default class SpyStreamInfo extends LslStreamInfo {
+export default class SpyLslInfo extends LslStreamInfo {
     public static numCallsToConstructor = 0
 
-    public constructor(options: StreamInfoOptions) {
+    public constructor(options: LslInfoOptions) {
         super(options)
-        SpyStreamInfo.numCallsToConstructor++
+        SpyLslInfo.numCallsToConstructor++
     }
 
     public getName() {
@@ -25,6 +25,6 @@ export default class SpyStreamInfo extends LslStreamInfo {
     }
 
     public static resetTestDouble() {
-        SpyStreamInfo.numCallsToConstructor = 0
+        SpyLslInfo.numCallsToConstructor = 0
     }
 }

package/src/testDoubles/{StreamInlet/FakeStreamInlet.ts → LslInlet/FakeLslInlet.ts}

@@ -1,12 +1,12 @@
 import {
     OnDataCallback,
-    StreamInlet,
-    StreamInletOptions,
+    LslInlet,
+    LslInletOptions,
 } from '../../impl/LslStreamInlet.js'
 
-export default class FakeStreamInlet implements StreamInlet {
+export default class FakeLslInlet implements LslInlet {
     public static callsToConstructor: {
-        options?: StreamInletOptions
+        options?: LslInletOptions
         onData?: OnDataCallback
     }[] = []
 
@@ -19,37 +19,38 @@ export default class FakeStreamInlet implements StreamInlet {
 
     protected onData!: OnDataCallback
 
-    public constructor(options?: StreamInletOptions, onData?: OnDataCallback) {
+    public constructor(options?: LslInletOptions, onData?: OnDataCallback) {
         this.onData = onData ?? (() => {})
 
-        FakeStreamInlet.callsToConstructor.push({
+        FakeLslInlet.callsToConstructor.push({
             options,
             onData: this.onData,
         })
     }
 
     public async startPulling() {
-        FakeStreamInlet.numCallsToStartPulling++
+        FakeLslInlet.numCallsToStartPulling++
         this.isRunning = true
     }
 
     public stopPulling() {
-        FakeStreamInlet.numCallsToStopPulling++
+        FakeLslInlet.numCallsToStopPulling++
         this.isRunning = false
     }
 
     public flushInlet() {
-        FakeStreamInlet.numCallsToFlushInlet++
+        FakeLslInlet.numCallsToFlushInlet++
     }
 
     public destroy() {
-        FakeStreamInlet.numCallsToDestroy++
+        FakeLslInlet.numCallsToDestroy++
     }
 
     public static resetTestDouble() {
-        FakeStreamInlet.callsToConstructor = []
-        FakeStreamInlet.numCallsToStartPulling = 0
-        FakeStreamInlet.numCallsToFlushInlet = 0
-        FakeStreamInlet.numCallsToDestroy = 0
+        this.callsToConstructor = []
+        this.numCallsToStartPulling = 0
+        this.numCallsToStopPulling = 0
+        this.numCallsToFlushInlet = 0
+        this.numCallsToDestroy = 0
     }
 }

package/src/testDoubles/LslInlet/SpyLslInlet.ts

@@ -0,0 +1,10 @@
+import LslStreamInlet, {
+    OnDataCallback,
+    LslInletOptions,
+} from '../../impl/LslStreamInlet.js'
+
+export default class SpyLslInlet extends LslStreamInlet {
+    public constructor(options: LslInletOptions, onData: OnDataCallback) {
+        super(options, onData)
+    }
+}

package/src/testDoubles/{StreamOutlet/FakeStreamOutlet.ts → LslOutlet/FakeLslOutlet.ts}

@@ -3,13 +3,10 @@ import { randomInt } from 'node:crypto'
 import generateId from '@neurodevs/generate-id'
 import { LslSample } from '@neurodevs/ndx-native'
 
-import {
-    StreamOutlet,
-    StreamOutletOptions,
-} from '../../impl/LslStreamOutlet.js'
+import { LslOutlet, LslOutletOptions } from '../../impl/LslStreamOutlet.js'
 
-export default class FakeStreamOutlet implements StreamOutlet {
-    public static callsToConstructor: (StreamOutletOptions | undefined)[] = []
+export default class FakeLslOutlet implements LslOutlet {
+    public static callsToConstructor: (LslOutletOptions | undefined)[] = []
 
     public static callsToPushSample: {
         sample: LslSample
@@ -18,19 +15,19 @@ export default class FakeStreamOutlet implements StreamOutlet {
 
     public static numCallsToDestroy = 0
 
-    public options?: StreamOutletOptions
+    public options?: LslOutletOptions
 
-    public constructor(options?: StreamOutletOptions) {
-        FakeStreamOutlet.callsToConstructor.push(options)
+    public constructor(options?: LslOutletOptions) {
+        FakeLslOutlet.callsToConstructor.push(options)
         this.options = options
     }
 
     public destroy() {
-        FakeStreamOutlet.numCallsToDestroy++
+        FakeLslOutlet.numCallsToDestroy++
     }
 
     public pushSample(sample: LslSample, timestampSec?: number) {
-        FakeStreamOutlet.callsToPushSample.push({
+        FakeLslOutlet.callsToPushSample.push({
             sample,
             timestampSec,
         })
@@ -81,8 +78,8 @@ export default class FakeStreamOutlet implements StreamOutlet {
     }
 
     public static resetTestDouble() {
-        FakeStreamOutlet.callsToConstructor = []
-        FakeStreamOutlet.callsToPushSample = []
-        FakeStreamOutlet.numCallsToDestroy = 0
+        FakeLslOutlet.callsToConstructor = []
+        FakeLslOutlet.callsToPushSample = []
+        FakeLslOutlet.numCallsToDestroy = 0
     }
 }

package/src/testDoubles/{WebSocketBridge/FakeWebSocketBridge.ts → LslWsBridge/FakeLslWsBridge.ts}

@@ -1,45 +1,34 @@
 import WebSocket, { WebSocketServer } from 'ws'
 import LslWebSocketBridge, {
-    WebSocketBridge,
-    WebSocketBridgeConstructorOptions,
+    LslWsBridge,
+    LslWsBridgeConstructorOptions,
 } from '../../impl/LslWebSocketBridge.js'
 import FakeWebSocket from '../WebSockets/FakeWebSocket.js'
 import FakeWebSocketServer from '../WebSockets/FakeWebSocketServer.js'
 
-export default class FakeWebSocketBridge implements WebSocketBridge {
+export default class FakeLslWsBridge implements LslWsBridge {
     public static callsToConstructor: (
-        | WebSocketBridgeConstructorOptions
-        | undefined
+        LslWsBridgeConstructorOptions | undefined
     )[] = []
 
     public static numCallsToActivate = 0
     public static numCallsToDeactivate = 0
     public static numCallsToDestroy = 0
 
-    public constructor(options?: WebSocketBridgeConstructorOptions) {
-        FakeWebSocketBridge.callsToConstructor.push(options)
+    public constructor(options?: LslWsBridgeConstructorOptions) {
+        FakeLslWsBridge.callsToConstructor.push(options)
     }
 
     public async activate() {
-        FakeWebSocketBridge.numCallsToActivate++
+        FakeLslWsBridge.numCallsToActivate++
     }
 
     public deactivate() {
-        FakeWebSocketBridge.numCallsToDeactivate++
+        FakeLslWsBridge.numCallsToDeactivate++
     }
 
     public destroy() {
-        FakeWebSocketBridge.numCallsToDestroy++
-    }
-
-    public static resetTestDouble() {
-        this.callsToConstructor = []
-        this.numCallsToActivate = 0
-        this.numCallsToDeactivate = 0
-        this.numCallsToDestroy = 0
-
-        this.setFakeWebSocket()
-        this.setFakeWebSocketServer()
+        FakeLslWsBridge.numCallsToDestroy++
     }
 
     private static setFakeWebSocket() {
@@ -52,4 +41,14 @@ export default class FakeWebSocketBridge implements WebSocketBridge {
             FakeWebSocketServer as unknown as typeof WebSocketServer
         FakeWebSocketServer.resetTestDouble()
     }
+
+    public static resetTestDouble() {
+        this.callsToConstructor = []
+        this.numCallsToActivate = 0
+        this.numCallsToDeactivate = 0
+        this.numCallsToDestroy = 0
+
+        this.setFakeWebSocket()
+        this.setFakeWebSocketServer()
+    }
 }

package/src/testDoubles/LslWsBridge/SpyLslWsBridge.ts

@@ -0,0 +1,9 @@
+import LslWebSocketBridge, {
+    LslWsBridgeConstructorOptions,
+} from '../../impl/LslWebSocketBridge.js'
+
+export default class SpyLslWsBridge extends LslWebSocketBridge {
+    public constructor(options: LslWsBridgeConstructorOptions) {
+        super(options)
+    }
+}

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/consts.ts

@@ -1,3 +1,5 @@
+import { ChannelFormat } from '@neurodevs/ndx-native'
+
 export const TEST_SUPPORTED_CHANNEL_FORMATS = ['float32', 'string'] as const
 
 export const TEST_UNSUPPORTED_CHANNEL_FORMATS = [
@@ -9,26 +11,4 @@ export const TEST_UNSUPPORTED_CHANNEL_FORMATS = [
     'int64',
 ] as const
 
-export const TEST_CHANNEL_FORMATS = [
-    'undefined',
-    'float32',
-    'double64',
-    'string',
-    'int32',
-    'int16',
-    'int8',
-    'int64',
-] as const
-
-export const TEST_CHANNEL_FORMATS_MAP = {
-    undefined: 0,
-    float32: 1,
-    double64: 2,
-    string: 3,
-    int32: 4,
-    int16: 5,
-    int8: 6,
-    int64: 7,
-}
-
-export type TestChannelFormat = (typeof TEST_CHANNEL_FORMATS)[number]
+export type TestChannelFormat = ChannelFormat

package/src/testDoubles/generateRandomOutletOptions.ts

@@ -2,7 +2,7 @@ import { randomInt } from 'node:crypto'
 
 import generateId from '@neurodevs/generate-id'
 
-import { StreamOutletOptions } from '../impl/LslStreamOutlet.js'
+import { LslOutletOptions } from '../impl/LslStreamOutlet.js'
 import { TEST_SUPPORTED_CHANNEL_FORMATS } from './consts.js'
 
 export default function generateRandomOutletOptions() {
@@ -19,5 +19,5 @@ export default function generateRandomOutletOptions() {
         units: generateId(),
         chunkSize: randomInt(0, 10),
         maxBufferedMs: randomInt(0, 10),
-    } as StreamOutletOptions
+    } as LslOutletOptions
 }

package/build/consts.d.ts

@@ -1,11 +0,0 @@
-export declare const CHANNEL_FORMATS: readonly ["undefined", "float32", "double64", "string", "int32", "int16", "int8", "int64"];
-export declare const CHANNEL_FORMATS_MAP: {
-    undefined: number;
-    float32: number;
-    double64: number;
-    string: number;
-    int32: number;
-    int16: number;
-    int8: number;
-    int64: number;
-};

package/build/consts.js

@@ -1,21 +0,0 @@
-export const CHANNEL_FORMATS = [
-    'undefined',
-    'float32',
-    'double64',
-    'string',
-    'int32',
-    'int16',
-    'int8',
-    'int64',
-];
-export const CHANNEL_FORMATS_MAP = {
-    undefined: 0,
-    float32: 1,
-    double64: 2,
-    string: 3,
-    int32: 4,
-    int16: 5,
-    int8: 6,
-    int64: 7,
-};
-//# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG;IAC3B,WAAW;IACX,SAAS;IACT,UAAU;IACV,QAAQ;IACR,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;CACD,CAAA;AAEV,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAC/B,SAAS,EAAE,CAAC;IACZ,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,CAAC;IACX,MAAM,EAAE,CAAC;IACT,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;CACX,CAAA"}

package/build/impl/workers/inlet/LslStreamInlet.worker.d.ts

@@ -1,22 +0,0 @@
-export type InletMessage = {
-    type: 'createInlet';
-    payload: CreateInletPayload;
-} | {
-    type: 'startPulling';
-} | {
-    type: 'flushInlet';
-} | {
-    type: 'stopPulling';
-} | {
-    type: 'destroyInlet';
-};
-export interface CreateInletPayload {
-    sourceId: string;
-    chunkSize: number;
-    maxBufferedMs: number;
-    openStreamTimeoutMs: number;
-    waitAfterOpenStreamMs: number;
-    pullTimeoutMs: number;
-    waitBetweenPullsMs: number;
-    flushInletOnStop: boolean;
-}

package/build/impl/workers/inlet/LslStreamInlet.worker.js

@@ -1,42 +0,0 @@
-import { parentPort } from 'node:worker_threads';
-import StreamInletWorker from './StreamInletWorker.js';
-const worker = new StreamInletWorker();
-parentPort?.on('message', async (msg) => {
-    try {
-        switch (msg.type) {
-            case 'createInlet':
-                const { payload } = msg;
-                await worker.createInlet(payload);
-                parentPort?.postMessage({ type: 'ready' });
-                break;
-            case 'startPulling':
-                worker.startPulling((samples, timestamps) => {
-                    parentPort?.postMessage({
-                        type: 'data',
-                        payload: {
-                            samples,
-                            timestamps,
-                        },
-                    });
-                });
-                break;
-            case 'stopPulling':
-                worker.stopPulling();
-                break;
-            case 'flushInlet':
-                worker.flushInlet();
-                break;
-            case 'destroyInlet':
-                worker.destroyInlet();
-                parentPort?.close();
-                break;
-        }
-    }
-    catch (err) {
-        parentPort?.postMessage({
-            type: 'error',
-            error: err instanceof Error ? err.message : String(err),
-        });
-    }
-});
-//# sourceMappingURL=LslStreamInlet.worker.js.map

package/build/impl/workers/inlet/LslStreamInlet.worker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LslStreamInlet.worker.js","sourceRoot":"","sources":["../../../../src/impl/workers/inlet/LslStreamInlet.worker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,iBAAiB,MAAM,wBAAwB,CAAA;AAEtD,MAAM,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAA;AAEtC,UAAU,EAAE,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,GAAiB,EAAE,EAAE;IAClD,IAAI,CAAC;QACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,aAAa;gBACd,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAAA;gBACvB,MAAM,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;gBACjC,UAAU,EAAE,WAAW,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;gBAC1C,MAAK;YAET,KAAK,cAAc;gBACf,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE;oBACxC,UAAU,EAAE,WAAW,CAAC;wBACpB,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE;4BACL,OAAO;4BACP,UAAU;yBACb;qBACJ,CAAC,CAAA;gBACN,CAAC,CAAC,CAAA;gBACF,MAAK;YAET,KAAK,aAAa;gBACd,MAAM,CAAC,WAAW,EAAE,CAAA;gBACpB,MAAK;YACT,KAAK,YAAY;gBACb,MAAM,CAAC,UAAU,EAAE,CAAA;gBACnB,MAAK;YAET,KAAK,cAAc;gBACf,MAAM,CAAC,YAAY,EAAE,CAAA;gBACrB,UAAU,EAAE,KAAK,EAAE,CAAA;gBACnB,MAAK;QACb,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,UAAU,EAAE,WAAW,CAAC;YACpB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SAC1D,CAAC,CAAA;IACN,CAAC;AACL,CAAC,CAAC,CAAA"}

package/build/impl/workers/inlet/StreamInletWorker.d.ts

@@ -1,73 +0,0 @@
-import { handleLslError, InfoHandle, InletHandle } from '@neurodevs/ndx-native';
-import { freePointer } from 'ffi-rs';
-import { OnDataCallback } from '../../LslStreamInlet.js';
-import { CreateInletPayload } from './LslStreamInlet.worker.js';
-export default class StreamInletWorker {
-    static lsl: import("@neurodevs/ndx-native").Liblsl;
-    static handleLslError: typeof handleLslError;
-    static freePointer: typeof freePointer;
-    private sourceId;
-    private chunkSize;
-    private maxBufferedMs;
-    private openStreamTimeoutMs;
-    private waitAfterOpenStreamMs;
-    private waitBetweenPullsMs;
-    private pullTimeoutMs;
-    private flushInletOnStop;
-    private pullMethod;
-    protected infoHandle: InfoHandle;
-    protected inletHandle: InletHandle;
-    private channelCount;
-    private sampleBuffer;
-    private sampleBufferRef;
-    private sampleBufferPtr;
-    private timestampBuffer;
-    private timestampBufferRef;
-    private timestampBufferPtr;
-    private pullErrorBuffer;
-    private pullErrorBufferRef;
-    private pullErrorBufferPtr;
-    private openStreamErrorBuffer;
-    private openStreamErrorBufferRef;
-    private openStreamErrorBufferPtr;
-    private onData;
-    private readonly bytesPerFloat;
-    private readonly bytesPerDouble;
-    private readonly bytesPerI32;
-    private isRunning;
-    createInlet(payload: CreateInletPayload): Promise<void>;
-    private resolveInfoHandle;
-    private resolveByProp;
-    private throwNoStreamFound;
-    private warnMultipleStreamsFound;
-    private doCreateInlet;
-    private getChannelCount;
-    private allocateWritableBuffers;
-    private allocateDataBuffer;
-    private allocateTimestampBuffer;
-    private allocatePullErrorBuffer;
-    private allocateOpenStreamErrorBuffer;
-    private setPullMethod;
-    private pullSample;
-    private doPullsample;
-    private readSamplesFromBuffer;
-    private pullChunk;
-    private doPullChunk;
-    private readTimestampsFromBuffer;
-    private openStream;
-    private waitForSetup;
-    startPulling(onData: OnDataCallback): void;
-    private pullLoop;
-    private pullDataOnce;
-    private handleLslErrorIfPresent;
-    private waitBetweenPulls;
-    flushInlet(): void;
-    stopPulling(): void;
-    private closeStream;
-    destroyInlet(): void;
-    private doDestroyInlet;
-    private freeNativePointers;
-    private get lsl();
-    private get handleLslError();
-    private get freePointer();
-}