@neurodevs/node-lsl 23.1.0 → 23.1.2

package/build/testDoubles/BleGatt/SpyBleGatt.js.map

@@ -1 +1 @@
-{"version":3,"file":"SpyBleGatt.js","sourceRoot":"","sources":["../../../src/testDoubles/BleGatt/SpyBleGatt.ts"],"names":[],"mappings":"AAAA,OAAO,iBAEN,MAAM,6CAA6C,CAAA;AAEpD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,iBAAiB;IAC9C,QAAQ,GAAa,EAAE,CAAA;IACvB,QAAQ,GAAa,EAAE,CAAA;IACvB,SAAS,GAAa,EAAE,CAAA;IAE/B,YAAmB,OAAuB;QACtC,KAAK,CAAC,OAAO,CAAC,CAAA;IAClB,CAAC;IAEM,0BAA0B;QAC7B,OAAO,IAAI,CAAC,aAAa,CAAA;IAC7B,CAAC;IAEM,iBAAiB;QACpB,OAAO,IAAI,CAAC,cAAc,CAAA;IAC9B,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,SAAS,CAAA;IACzB,CAAC;IAEM,aAAa;QAChB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC3B,OAAO,OAAO,CAAA;QAClB,CAAC,CAAA;IACL,CAAC;IAEM,aAAa;QAChB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC3B,OAAO,OAAO,CAAA;QAClB,CAAC,CAAA;IACL,CAAC;IAEM,cAAc;QACjB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QAEnB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC5B,OAAO,OAAO,CAAA;QAClB,CAAC,CAAA;IACL,CAAC;IAEM,eAAe;QAClB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;IACvB,CAAC;CACJ"}
+{"version":3,"file":"SpyBleGatt.js","sourceRoot":"","sources":["../../../src/testDoubles/BleGatt/SpyBleGatt.ts"],"names":[],"mappings":"AAAA,OAAO,iBAEN,MAAM,6CAA6C,CAAA;AAEpD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,iBAAiB;IAC9C,QAAQ,GAAa,EAAE,CAAA;IACvB,QAAQ,GAAa,EAAE,CAAA;IACvB,SAAS,GAAa,EAAE,CAAA;IAE/B,YAAmB,OAAuB;QACtC,KAAK,CAAC,OAAO,CAAC,CAAA;IAClB,CAAC;IAEM,0BAA0B;QAC7B,OAAO,IAAI,CAAC,aAAa,CAAA;IAC7B,CAAC;IAEM,iBAAiB;QACpB,OAAO,IAAI,CAAC,cAAc,CAAA;IAC9B,CAAC;IAEM,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAEM,aAAa;QAChB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC3B,OAAO,OAAO,CAAA;QAClB,CAAC,CAAA;IACL,CAAC;IAEM,aAAa;QAChB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC3B,OAAO,OAAO,CAAA;QAClB,CAAC,CAAA;IACL,CAAC;IAEM,cAAc;QACjB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QAEnB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC5B,OAAO,OAAO,CAAA;QAClB,CAAC,CAAA;IACL,CAAC;IAEM,eAAe;QAClB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;IACvB,CAAC;CACJ"}

package/build/testDoubles/LslOutlet/FakeLslOutlet.d.ts

@@ -14,7 +14,7 @@ export default class FakeLslOutlet implements LslOutlet {
     get name(): string;
     get type(): string;
     get sourceId(): string;
-    get channelNames(): string[];
+    get channelNames(): readonly string[];
     get channelCount(): number;
     get channelFormat(): "string" | "undefined" | "float32" | "double64" | "int32" | "int16" | "int8" | "int64";
     get sampleRateHz(): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neurodevs/node-lsl",
-  "version": "23.1.0",
+  "version": "23.1.2",
   "description": "Lab Streaming Layer (LSL) bindings for Node",
   "type": "module",
   "keywords": [
@@ -42,12 +42,11 @@
   },
   "dependencies": {
     "@neurodevs/generate-id": "^1.1.3",
-    "@neurodevs/ndx-native": "^9.0.0",
-    "ffi-rs": "^1.3.1",
+    "@neurodevs/ndx-native": "^10.0.0",
     "ws": "^8.18.3"
   },
   "devDependencies": {
-    "@neurodevs/eslint-config-ndx": "2.0.0",
+    "@neurodevs/eslint-config-ndx": "2.0.3",
     "@neurodevs/node-tdd": "^3.0.3",
     "@neurodevs/prettier-config-ndx": "^1.0.2",
     "@types/ws": "^8.18.1",

package/src/__tests__/AbstractPackageTest.ts

@@ -100,8 +100,6 @@ export default class AbstractPackageTest extends AbstractModuleTest {
 
         FakeLibndx.resetTestDouble()
         FakeLibndx.fakeResult = { status: 200 }
-
-        BleGattController.ndx = this.fakeLibndx
     }
 
     protected static setSpyLslInfo() {

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

@@ -21,6 +21,8 @@ export default class BleGattControllerTest extends AbstractPackageTest {
     private static readonly fakeError = this.generateId()
     private static readonly fake400Error = `400 error: ${this.fakeError}`
     private static readonly fake500Error = `500 error: ${this.fakeError}`
+    private static readonly uuidNotResolvedError =
+        'Device uuid is not resolved yet! Must either pass as option to Create or call connect() first.'
 
     private static readonly charCallbacks = [
         {
@@ -93,7 +95,7 @@ export default class BleGattControllerTest extends AbstractPackageTest {
 
     @test()
     protected static async discoversUuidWhenDeviceUuidNotProvided() {
-        const instance = await this.BleGattControllerWithPrefix()
+        const instance = this.BleGattControllerWithPrefix()
 
         await this.connectWithDiscovery(instance)
 
@@ -124,7 +126,7 @@ export default class BleGattControllerTest extends AbstractPackageTest {
 
     @test()
     protected static async usesDiscoveredUuidToCreateBleBackend() {
-        const instance = await this.BleGattControllerWithPrefix()
+        const instance = this.BleGattControllerWithPrefix()
 
         await this.connectWithDiscovery(instance)
 
@@ -139,7 +141,7 @@ export default class BleGattControllerTest extends AbstractPackageTest {
 
     @test()
     protected static async usesDiscoveredUuidToStartBleBackend() {
-        const instance = await this.BleGattControllerWithPrefix()
+        const instance = this.BleGattControllerWithPrefix()
 
         await this.connectWithDiscovery(instance)
 
@@ -152,7 +154,7 @@ export default class BleGattControllerTest extends AbstractPackageTest {
 
     @test()
     protected static async exposesDiscoveredUuid() {
-        const instance = await this.BleGattControllerWithPrefix()
+        const instance = this.BleGattControllerWithPrefix()
 
         await this.connectWithDiscovery(instance)
 
@@ -406,8 +408,8 @@ export default class BleGattControllerTest extends AbstractPackageTest {
         await this.connect()
         await this.disconnect()
 
-        assert.isFalse(
-            this.instance.getConnected(),
+        assert.isTrue(
+            this.instance.getState().status === 'disconnected',
             'Did not reset connected flag on disconnect!'
         )
     }
@@ -432,6 +434,46 @@ export default class BleGattControllerTest extends AbstractPackageTest {
         )
     }
 
+    @test()
+    protected static async writeCharacteristicThrowsIfUuidNotResolved() {
+        const instance = this.BleGattControllerWithPrefix()
+
+        await assert.doesThrowAsync(
+            async () =>
+                await instance.writeCharacteristic(
+                    this.charUuid,
+                    this.charValueToWrite
+                ),
+            this.uuidNotResolvedError,
+            'Should not write to a device whose uuid is not resolved!'
+        )
+    }
+
+    @test()
+    protected static async subscribeCharacteristicsThrowsIfUuidNotResolved() {
+        const instance = this.BleGattControllerWithPrefix()
+
+        await assert.doesThrowAsync(
+            async () =>
+                await instance.subscribeCharacteristics(
+                    this.extraCharCallbacks
+                ),
+            this.uuidNotResolvedError,
+            'Should not subscribe to a device whose uuid is not resolved!'
+        )
+    }
+
+    @test()
+    protected static async disconnectThrowsIfUuidNotResolved() {
+        const instance = this.BleGattControllerWithPrefix()
+
+        await assert.doesThrowAsync(
+            async () => await instance.disconnect(),
+            this.uuidNotResolvedError,
+            'Should not disconnect a device whose uuid is not resolved!'
+        )
+    }
+
     @test()
     protected static async throwsWithUnknownErrorIfNoError() {
         this.setFake500ErrorWithoutError()

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

@@ -1,13 +1,5 @@
 import { FakeLiblsl } from '@neurodevs/ndx-native'
 import { test, assert } from '@neurodevs/node-tdd'
-import {
-    createPointer,
-    DataType,
-    FieldType,
-    JsExternal,
-    PointerType,
-    unwrapPointer,
-} from 'ffi-rs'
 
 import LslStreamInlet, { LslInletOptions } from '../../impl/LslStreamInlet.js'
 import SpyLslInlet from '../../testDoubles/LslInlet/SpyLslInlet.js'
@@ -21,27 +13,6 @@ export default class LslStreamInletTest extends AbstractPackageTest {
         timestamps: number[]
     }[]
 
-    private static readonly sampleBufferPtr = unwrapPointer(
-        createPointer({
-            paramsType: [DataType.U8Array],
-            paramsValue: [new Float32Array(this.channelCount * this.chunkSize)],
-        })
-    )[0]
-
-    private static readonly timestampBufferPtr = unwrapPointer(
-        createPointer({
-            paramsType: [DataType.U8Array],
-            paramsValue: [new Float64Array(this.chunkSize)],
-        })
-    )[0]
-
-    private static readonly errorCodePtr = unwrapPointer(
-        createPointer({
-            paramsType: [DataType.U8Array],
-            paramsValue: [new Int32Array(1)],
-        })
-    )[0]
-
     protected static async beforeAll() {
         assert.isEqual(
             LslStreamInlet.waitAfterOpenStreamMs,
@@ -60,7 +31,6 @@ export default class LslStreamInletTest extends AbstractPackageTest {
 
         LslStreamInlet.waitAfterOpenStreamMs = 0
         LslStreamInlet.lsl = this.fakeLiblsl
-        LslStreamInlet.freePointer = () => {}
 
         this.instance = await this.LslStreamInlet()
     }
@@ -81,6 +51,7 @@ export default class LslStreamInletTest extends AbstractPackageTest {
             {
                 infoHandle: this.inletHandle,
                 maxBufferedMs: this.maxBufferedMs,
+                chunkSize: this.chunkSize,
             },
             'Should have called createInlet!'
         )
@@ -101,46 +72,39 @@ export default class LslStreamInletTest extends AbstractPackageTest {
 
     @test()
     protected static async destroyCallsLslBinding() {
-        await this.startPullingThenDestroy()
+        await this.startPulling()
+        const inletHandle = this.inletHandle
 
-        assert.isEqualDeep(
-            this.fakeLiblsl.lastDestroyInletOptions,
-            { inletHandle: this.inletHandle },
+        this.destroy()
+
+        assert.isTrue(
+            inletHandle !== undefined &&
+                this.fakeLiblsl.lastDestroyInletOptions?.inletHandle ===
+                    inletHandle,
             'Did not destroy inlet!'
         )
     }
 
     @test()
-    protected static async destroyFreesAllPointers() {
-        interface FreePointerParams {
-            paramsType: FieldType[]
-            paramsValue: JsExternal[]
-            pointerType: PointerType
-        }
-
-        let calls: FreePointerParams[] = []
+    protected static async destroyDoesNotDestroyInletThatWasNeverCreated() {
+        this.destroy()
 
-        LslStreamInlet.freePointer = (params: FreePointerParams) => {
-            calls.push(params)
-        }
+        assert.isEqual(
+            this.fakeLiblsl.destroyInletHitCount,
+            0,
+            'Should not have destroyed an inlet that was never created!'
+        )
+    }
 
+    @test()
+    protected static async destroyingTwiceDestroysInletOnce() {
         await this.startPullingThenDestroy()
+        this.destroy()
 
-        const { paramsType, pointerType } = calls[0]
-
-        assert.isEqualDeep(
-            { paramsType, pointerType },
-            {
-                paramsType: [
-                    DataType.U8Array,
-                    DataType.U8Array,
-                    DataType.U8Array,
-                    DataType.U8Array,
-                ],
-                pointerType: PointerType.CPointer,
-            },
-
-            'Destroy did not free all pointers!'
+        assert.isEqual(
+            this.fakeLiblsl.destroyInletHitCount,
+            1,
+            'Should have destroyed inlet only once!'
         )
     }
 
@@ -207,7 +171,6 @@ export default class LslStreamInletTest extends AbstractPackageTest {
             {
                 inletHandle: this.inletHandle,
                 timeoutMs: aboutOneYearInMs,
-                errorCodePtr: this.errorCodePtr,
             },
             'Did not open inlet stream!'
         )
@@ -230,7 +193,6 @@ export default class LslStreamInletTest extends AbstractPackageTest {
             {
                 inletHandle: instance['inletHandle'],
                 timeoutMs: openStreamTimeoutMs,
-                errorCodePtr: this.errorCodePtr,
             },
             'Did not open inlet stream with passed timeout!'
         )
@@ -316,13 +278,7 @@ export default class LslStreamInletTest extends AbstractPackageTest {
 
         assert.isEqualDeep(
             this.fakeLiblsl.lastPullSampleOptions,
-            {
-                inletHandle: this.inletHandle,
-                sampleBufferPtr: this.sampleBufferPtr,
-                sampleBufferElements: this.channelCount,
-                timeoutMs: 0,
-                errorCodePtr: this.errorCodePtr,
-            },
+            { inletHandle: this.inletHandle, timeoutMs: 0 },
             'Should have called pullSample!'
         )
     }
@@ -333,33 +289,36 @@ export default class LslStreamInletTest extends AbstractPackageTest {
 
         assert.isEqualDeep(
             this.fakeLiblsl.lastPullChunkOptions,
-            {
-                inletHandle: this.inletHandle,
-                sampleBufferPtr: this.sampleBufferPtr,
-                timestampBufferPtr: this.timestampBufferPtr,
-                sampleBufferElements: this.chunkSize * this.channelCount,
-                timestampBufferElements: this.chunkSize,
-                timeoutMs: 0,
-                errorCodePtr: this.errorCodePtr,
-            },
+            { inletHandle: this.inletHandle, timeoutMs: 0 },
             'Should have called pullChunk!'
         )
     }
 
     @test()
-    protected static async pushSampleHandlesErrorCode() {
-        let passedErrorCode: number | undefined
+    protected static async passesEachPulledSampleToOnData() {
+        await this.runChunkSizeOne()
 
-        LslStreamInlet.handleLslError = (errorCode: number) => {
-            passedErrorCode = errorCode
-        }
+        assert.isEqualDeep(
+            this.callsToOnData,
+            FakeLiblsl.fakeSamples.map((sample) => ({
+                samples: Array.from(sample),
+                timestamps: [FakeLiblsl.fakeSampleTimestampSec],
+            })),
+            'Did not pass each pulled sample to onData!'
+        )
+    }
 
+    @test()
+    protected static async passesEachPulledChunkToOnData() {
         await this.startThenStop()
 
         assert.isEqualDeep(
-            passedErrorCode,
-            FakeLiblsl.fakeErrorCode,
-            'Did not pass the expected error code to handleLslError!'
+            this.callsToOnData,
+            FakeLiblsl.fakeChunks.map((chunk, i) => ({
+                samples: Array.from(chunk),
+                timestamps: Array.from(FakeLiblsl.fakeTimestamps[i]),
+            })),
+            'Did not pass each pulled chunk to onData!'
         )
     }
 

package/src/impl/LslStreamInfo.ts

@@ -12,7 +12,7 @@ export default class LslStreamInfo implements LslInfo {
     public readonly name: string
     public readonly type: string
     public readonly sourceId: string
-    public readonly channelNames: string[]
+    public readonly channelNames: readonly string[]
     public readonly channelCount: number
     public readonly channelFormat: ChannelFormat
     public readonly sampleRateHz: number
@@ -87,7 +87,7 @@ export interface LslInfo {
     readonly type: string
     readonly sourceId: string
     readonly units: string
-    readonly channelNames: string[]
+    readonly channelNames: readonly string[]
     readonly channelCount: number
     readonly channelFormat: ChannelFormat
     readonly sampleRateHz: number
@@ -97,7 +97,7 @@ export interface LslInfo {
 export type LslInfoConstructor = new (options: LslInfoOptions) => LslInfo
 
 export interface LslInfoOptions {
-    channelNames: string[]
+    channelNames: readonly string[]
     channelFormat: ChannelFormat
     sampleRateHz: number
     name?: string