@neurodevs/node-lsl 10.1.4 → 10.2.0

package/build/testDoubles/SpyLslStreamInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpyLslStreamInfo.js","sourceRoot":"","sources":["../../src/testDoubles/SpyLslStreamInfo.ts"],"names":[],"mappings":";;;;;AAAA,gFAA8E;AAE9E,MAAqB,gBAAiB,SAAQ,uBAAa;IACvD,YAAmB,OAA0B;QACzC,KAAK,CAAC,OAAO,CAAC,CAAA;IAClB,CAAC;IAEM,aAAa;QAChB,OAAO,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAEM,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;CACJ;AAxBD,mCAwBC"}

package/build/testDoubles/SpyTimeMarkerOutlet.d.ts

@@ -1,8 +1,9 @@
-import { LslOutletOptions } from '../implementations/LslOutlet';
-import TimeMarkerOutletImpl from '../implementations/TimeMarkerOutlet';
+import { LslOutletOptions } from '../components/LslOutlet';
+import { StreamInfo } from '../components/LslStreamInfo';
+import TimeMarkerOutletImpl from '../components/TimeMarkerOutlet';
 export default class SpyTimeMarkerOutlet extends TimeMarkerOutletImpl {
     passedOptions: LslOutletOptions;
     totalWaitTimeMs: number;
-    constructor(options: LslOutletOptions);
+    constructor(info: StreamInfo, options: LslOutletOptions);
     wait(durationMs: number): Promise<void>;
 }

package/build/testDoubles/SpyTimeMarkerOutlet.js

@@ -3,10 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const TimeMarkerOutlet_1 = __importDefault(require("../implementations/TimeMarkerOutlet"));
+const TimeMarkerOutlet_1 = __importDefault(require("../components/TimeMarkerOutlet"));
 class SpyTimeMarkerOutlet extends TimeMarkerOutlet_1.default {
-    constructor(options) {
-        super(options);
+    constructor(info, options) {
+        super(info, options);
         this.passedOptions = options;
         this.totalWaitTimeMs = 0;
     }

package/build/testDoubles/SpyTimeMarkerOutlet.js.map

@@ -1 +1 @@
-{"version":3,"file":"SpyTimeMarkerOutlet.js","sourceRoot":"","sources":["../../src/testDoubles/SpyTimeMarkerOutlet.ts"],"names":[],"mappings":";;;;;AACA,2FAAsE;AAEtE,MAAqB,mBAAoB,SAAQ,0BAAoB;IAIjE,YAAmB,OAAyB;QACxC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,IAAI,CAAC,eAAe,GAAG,CAAC,CAAA;IAC5B,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,UAAkB;QAChC,IAAI,CAAC,eAAe,IAAI,UAAU,CAAA;QAClC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC5B,CAAC;CACJ;AAdD,sCAcC"}
+{"version":3,"file":"SpyTimeMarkerOutlet.js","sourceRoot":"","sources":["../../src/testDoubles/SpyTimeMarkerOutlet.ts"],"names":[],"mappings":";;;;;AAEA,sFAAiE;AAEjE,MAAqB,mBAAoB,SAAQ,0BAAoB;IAIjE,YAAmB,IAAgB,EAAE,OAAyB;QAC1D,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,IAAI,CAAC,eAAe,GAAG,CAAC,CAAA;IAC5B,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,UAAkB;QAChC,IAAI,CAAC,eAAe,IAAI,UAAU,CAAA;QAClC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC5B,CAAC;CACJ;AAdD,sCAcC"}

package/build/testDoubles/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../../src/testDoubles/consts.ts"],"names":[],"mappings":";;;AAAa,QAAA,8BAA8B,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAA;AAE/D,QAAA,gCAAgC,GAAG;IAC5C,WAAW;IACX,UAAU;IACV,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;CACD,CAAA;AAEG,QAAA,oBAAoB,GAAG;IAChC,WAAW;IACX,SAAS;IACT,UAAU;IACV,QAAQ;IACR,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;CACD,CAAA;AAEG,QAAA,wBAAwB,GAAG;IACpC,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/{__tests__/support → testDoubles}/generateRandomOutletOptions.d.ts

@@ -1,2 +1,2 @@
-import { LslOutletOptions } from '../../implementations/LslOutlet';
+import { LslOutletOptions } from '../components/LslOutlet';
 export default function generateRandomOutletOptions(): LslOutletOptions;

package/build/testDoubles/generateRandomOutletOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateRandomOutletOptions.js","sourceRoot":"","sources":["../../src/testDoubles/generateRandomOutletOptions.ts"],"names":[],"mappings":";;AAKA,8CAeC;AApBD,mCAAkC;AAClC,uDAAmD;AAEnD,qCAAyD;AAEzD,SAAwB,2BAA2B;IAC/C,MAAM,gBAAgB,GAAG,IAAA,kBAAS,EAAC,uCAA8B,CAAC,MAAM,CAAC,CAAA;IAEzE,OAAO;QACH,IAAI,EAAE,IAAA,uBAAU,GAAE;QAClB,IAAI,EAAE,IAAA,uBAAU,GAAE;QAClB,YAAY,EAAE,IAAI,KAAK,CAAC,IAAA,kBAAS,EAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAA,uBAAU,GAAE,CAAC;QAC5D,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;QAC9B,aAAa,EAAE,uCAA8B,CAAC,gBAAgB,CAAC;QAC/D,QAAQ,EAAE,IAAA,uBAAU,GAAE;QACtB,YAAY,EAAE,IAAA,uBAAU,GAAE;QAC1B,IAAI,EAAE,IAAA,uBAAU,GAAE;QAClB,SAAS,EAAE,IAAA,kBAAS,EAAC,CAAC,EAAE,EAAE,CAAC;QAC3B,WAAW,EAAE,IAAA,kBAAS,EAAC,CAAC,EAAE,EAAE,CAAC;KACZ,CAAA;AACzB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neurodevs/node-lsl",
-  "version": "10.1.4",
+  "version": "10.2.0",
   "main": "build/index.js",
   "repository": {
     "type": "git",

package/src/__tests__/AbstractNodeLslTest.ts

@@ -0,0 +1,50 @@
+import AbstractSpruceTest, { generateId } from '@sprucelabs/test-utils'
+import LiblslImpl from '../components/Liblsl'
+import LslInlet from '../components/LslInlet'
+import LslStreamInfo from '../components/LslStreamInfo'
+import TimeMarkerOutletImpl from '../components/TimeMarkerOutlet'
+import FakeLiblsl from '../testDoubles/FakeLiblsl'
+import FakeStreamInfo from '../testDoubles/FakeStreamInfo'
+import { SpyLslInlet } from '../testDoubles/SpyLslInlet'
+import SpyLslStreamInfo from '../testDoubles/SpyLslStreamInfo'
+import SpyTimeMarkerOutlet from '../testDoubles/SpyTimeMarkerOutlet'
+
+export default class AbstractNodeLslTest extends AbstractSpruceTest {
+    protected static fakeLiblsl: FakeLiblsl
+
+    protected static async beforeEach() {
+        await super.beforeEach()
+
+        this.setFakeLiblsl()
+    }
+
+    protected static setFakeLiblsl() {
+        this.fakeLiblsl = new FakeLiblsl()
+        LiblslImpl.setInstance(this.fakeLiblsl)
+    }
+
+    protected static setSpyLslStreamInfo() {
+        LslStreamInfo.Class = SpyLslStreamInfo
+    }
+
+    protected static setFakeStreamInfo() {
+        LslStreamInfo.Class = FakeStreamInfo
+        FakeStreamInfo.resetTestDouble()
+    }
+
+    protected static setSpyLslInlet() {
+        LslInlet.Class = SpyLslInlet
+    }
+
+    protected static setSpyTimeMarkerOutlet() {
+        TimeMarkerOutletImpl.Class = SpyTimeMarkerOutlet
+    }
+
+    protected static readonly channelNames = [generateId(), generateId()]
+    protected static readonly infoName = generateId()
+    protected static readonly type = generateId()
+    protected static readonly sourceId = generateId()
+    protected static readonly units = generateId()
+    protected static readonly chunkSize = Math.floor(Math.random() * 100)
+    protected static readonly maxBuffered = Math.floor(Math.random() * 100)
+}

package/src/__tests__/{implementation/Liblsl.test.ts → Liblsl.test.ts}

@@ -6,18 +6,19 @@ import AbstractSpruceTest, {
     generateId,
 } from '@sprucelabs/test-utils'
 import { DataType, OpenParams } from 'ffi-rs'
-import LiblslImpl from '../../implementations/Liblsl'
+import LiblslImpl from '../components/Liblsl'
 import {
     BoundChild,
     BoundDescription,
+    BoundInlet,
     BoundOutlet,
     BoundStreamInfo,
     FfiRsDefineOptions,
     Liblsl,
     LiblslBindings,
     LslChannel,
-} from '../../nodeLsl.types'
-import FakeLiblsl from '../../testDoubles/FakeLiblsl'
+} from '../nodeLsl.types'
+import FakeLiblsl from '../testDoubles/FakeLiblsl'
 
 export default class LiblslTest extends AbstractSpruceTest {
     private static lsl: Liblsl
@@ -26,12 +27,15 @@ export default class LiblslTest extends AbstractSpruceTest {
     private static fakeBindings: LiblslBindings
     private static fakeStreamInfo: BoundStreamInfo
     private static fakeOutlet: BoundOutlet
+    private static fakeInlet: BoundInlet
     private static fakeDesc: BoundDescription
     private static fakeChildNamedChannels: BoundChild
     private static createStreamInfoParams?: any[]
     private static appendChildParams: any[] = []
     private static createOutletParams?: any[]
     private static destroyOutletParams?: any[]
+    private static createInletParams?: any[]
+    private static destroyInletParams?: any[]
     private static localClockParams?: any[]
     private static pushSampleFloatTimestampParams?: any[]
     private static pushSampleStringTimestampParams?: any[]
@@ -51,6 +55,8 @@ export default class LiblslTest extends AbstractSpruceTest {
         delete this.createStreamInfoParams
         delete this.createOutletParams
         delete this.destroyOutletParams
+        delete this.createInletParams
+        delete this.destroyInletParams
         delete this.pushSampleFloatTimestampParams
         delete this.getDescriptionParams
         this.appendChildParams = []
@@ -203,6 +209,16 @@ export default class LiblslTest extends AbstractSpruceTest {
                 retType: DataType.Void,
                 paramsType: [DataType.External],
             },
+            lsl_create_inlet: {
+                library: 'lsl',
+                retType: DataType.External,
+                paramsType: [DataType.External, DataType.I32, DataType.I32],
+            },
+            lsl_destroy_inlet: {
+                library: 'lsl',
+                retType: DataType.Void,
+                paramsType: [DataType.External],
+            },
             lsl_local_clock: {
                 library: 'lsl',
                 retType: DataType.Double,
@@ -395,6 +411,13 @@ export default class LiblslTest extends AbstractSpruceTest {
         )
     }
 
+    @test()
+    protected static async canCreateInletWithRequiredParams() {
+        const { options, inlet } = this.createRandomInlet()
+        assert.isEqualDeep(this.createInletParams, Object.values(options))
+        assert.isEqual(inlet, this.fakeInlet)
+    }
+
     private static createRandomStreamInfo() {
         return this.lsl.createStreamInfo(
             this.generateRandomCreateStreamInfoOptions()
@@ -402,14 +425,25 @@ export default class LiblslTest extends AbstractSpruceTest {
     }
 
     private static createRandomOutlet() {
+        const options = this.createRandomOptions()
+        const outlet = this.lsl.createOutlet(options)
+        return { options, outlet }
+    }
+
+    private static createRandomInlet() {
+        const options = this.createRandomOptions()
+        const inlet = this.lsl.createInlet(options)
+        return { options, inlet }
+    }
+
+    private static createRandomOptions() {
         const info = this.createRandomStreamInfo()
         const options = {
             info,
             chunkSize: randomInt(10),
             maxBuffered: randomInt(10),
         }
-        const outlet = this.lsl.createOutlet(options)
-        return { options, outlet }
+        return options
     }
 
     private static generateRandomChannelValues() {
@@ -441,15 +475,22 @@ export default class LiblslTest extends AbstractSpruceTest {
                 this.createOutletParams = params
                 return this.fakeOutlet
             },
-            lsl_destroy_outlet: (params: any[]) => {
-                this.destroyOutletParams = params
-            },
             lsl_push_sample_ft: (params: any[]) => {
                 this.pushSampleFloatTimestampParams = params
             },
             lsl_push_sample_strt: (params: any[]) => {
                 this.pushSampleStringTimestampParams = params
             },
+            lsl_destroy_outlet: (params: any[]) => {
+                this.destroyOutletParams = params
+            },
+            lsl_create_inlet: (params: any[]) => {
+                this.createInletParams = params
+                return this.fakeInlet
+            },
+            lsl_destroy_inlet: (params: any[]) => {
+                this.destroyInletParams = params
+            },
             lsl_local_clock: (params: []) => {
                 this.localClockParams = params
                 return new Date().getTime()

package/src/__tests__/LslInlet.test.ts

@@ -0,0 +1,99 @@
+import { test, assert, errorAssert } from '@sprucelabs/test-utils'
+import LslInlet, { LslInletOptions } from '../components/LslInlet'
+import FakeStreamInfo from '../testDoubles/FakeStreamInfo'
+import { SpyLslInlet } from '../testDoubles/SpyLslInlet'
+import AbstractNodeLslTest from './AbstractNodeLslTest'
+
+export default class LslInletTest extends AbstractNodeLslTest {
+    private static instance: SpyLslInlet
+
+    protected static async beforeEach() {
+        await super.beforeEach()
+
+        this.setSpyLslInlet()
+        this.setFakeStreamInfo()
+
+        this.instance = this.LslInlet()
+    }
+
+    @test()
+    protected static async canCreateLslInlet() {
+        assert.isTruthy(this.instance, 'Instance should be created!')
+    }
+
+    @test()
+    protected static async throwsWithMissingRequiredOptions() {
+        const err = assert.doesThrow(
+            // @ts-ignore
+            () => LslInlet.Create()
+        )
+        errorAssert.assertError(err, 'MISSING_PARAMETERS', {
+            parameters: [
+                'channelNames',
+                'channelFormat',
+                'sampleRate',
+                'chunkSize',
+                'maxBuffered',
+            ],
+        })
+    }
+
+    @test()
+    protected static async createsStreamInfoWithExpectedOptions() {
+        assert.isEqualDeep(
+            FakeStreamInfo.callsToConstructor[0],
+            {
+                channelNames: this.channelNames,
+                channelFormat: 'float32',
+                sampleRate: 0,
+                name: this.infoName,
+                type: this.type,
+                sourceId: this.sourceId,
+            },
+            'Stream info should have expected options!'
+        )
+    }
+
+    @test()
+    protected static async uniqueNameHasSetPrefix() {
+        const instance = this.LslInlet({ name: undefined })
+
+        assert.doesInclude(
+            instance.getName(),
+            'lsl-inlet-',
+            'Name should have set prefix!'
+        )
+    }
+
+    @test()
+    protected static async callsBindingsToCreateLslInlet() {
+        const fakeInfo = this.instance.getStreamInfo()
+
+        assert.isTruthy(fakeInfo, 'Should have created stream info!')
+
+        assert.isEqualDeep(
+            this.fakeLiblsl.lastCreateInletOptions,
+            {
+                info: fakeInfo.boundStreamInfo,
+                chunkSize: this.chunkSize,
+                maxBuffered: this.maxBuffered,
+            },
+            'Should have called createInlet!'
+        )
+    }
+
+    private static LslInlet(options?: Partial<LslInletOptions>) {
+        const defaultOptions = {
+            channelNames: this.channelNames,
+            channelFormat: 'float32',
+            sampleRate: 0,
+            name: this.infoName,
+            type: this.type,
+            sourceId: this.sourceId,
+            chunkSize: this.chunkSize,
+            maxBuffered: this.maxBuffered,
+            ...options,
+        } as LslInletOptions
+        return LslInlet.Create(defaultOptions) as SpyLslInlet
+    }
+}

package/src/__tests__/{behavioral/LslOutlet.test.ts → LslOutlet.test.ts}

@@ -1,38 +1,29 @@
-import AbstractSpruceTest, {
-    test,
-    assert,
-    errorAssert,
-    generateId,
-} from '@sprucelabs/test-utils'
-import LiblslImpl from '../../implementations/Liblsl'
-import LslOutletImpl, {
-    LslOutletOptions,
-} from '../../implementations/LslOutlet'
-import { LslSample } from '../../nodeLsl.types'
-import FakeLiblsl from '../../testDoubles/FakeLiblsl'
+import { test, assert, errorAssert, generateId } from '@sprucelabs/test-utils'
+import LslOutletImpl, { LslOutletOptions } from '../components/LslOutlet'
+import { StreamInfo } from '../components/LslStreamInfo'
+import { LslSample } from '../nodeLsl.types'
 import {
-    TEST_CHANNEL_FORMATS_MAP,
     TEST_SUPPORTED_CHANNEL_FORMATS,
     TEST_UNSUPPORTED_CHANNEL_FORMATS,
     TestChannelFormat,
-} from '../support/consts'
-import generateRandomOutletOptions from '../support/generateRandomOutletOptions'
+} from '../testDoubles/consts'
 
-export default class LslOutletTest extends AbstractSpruceTest {
-    private static fakeLiblsl: FakeLiblsl
+import FakeStreamInfo from '../testDoubles/FakeStreamInfo'
+import generateRandomOutletOptions from '../testDoubles/generateRandomOutletOptions'
+import AbstractNodeLslTest from './AbstractNodeLslTest'
+
+export default class LslOutletTest extends AbstractNodeLslTest {
     private static randomOutletOptions: LslOutletOptions
-    private static channelFormatIdx: number
 
     protected static async beforeEach() {
         await super.beforeEach()
+
         delete LslOutletImpl.Class
-        this.randomOutletOptions = generateRandomOutletOptions()
 
-        const channelFormat = this.randomOutletOptions.channelFormat
-        this.channelFormatIdx = TEST_CHANNEL_FORMATS_MAP[channelFormat]
-        this.fakeLiblsl = new FakeLiblsl()
+        this.randomOutletOptions = generateRandomOutletOptions()
 
-        LiblslImpl.setInstance(this.fakeLiblsl)
+        this.setFakeLiblsl()
+        this.setFakeStreamInfo()
     }
 
     @test()
@@ -45,14 +36,14 @@ export default class LslOutletTest extends AbstractSpruceTest {
             parameters: [
                 'name',
                 'type',
+                'sourceId',
                 'channelNames',
-                'sampleRate',
                 'channelFormat',
-                'sourceId',
-                'manufacturer',
-                'unit',
+                'sampleRate',
                 'chunkSize',
                 'maxBuffered',
+                'manufacturer',
+                'unit',
             ],
         })
     }
@@ -183,19 +174,14 @@ export default class LslOutletTest extends AbstractSpruceTest {
     protected static async constructionCreatesStreamInfo() {
         await this.Outlet()
 
-        const { ...options } = this.randomOutletOptions as any
-
-        options.channelCount = options.channelNames.length
-
-        delete options.manufacturer
-        delete options.unit
-        delete options.chunkSize
-        delete options.maxBuffered
-        delete options.channelNames
-
-        assert.isEqualDeep(this.fakeLiblsl.lastCreateStreamInfoOptions, {
-            ...options,
-            channelFormat: this.channelFormatIdx,
+        assert.isEqualDeep(FakeStreamInfo.callsToConstructor[0], {
+            channelNames: this.randomOutletOptions.channelNames,
+            channelFormat: this.randomOutletOptions.channelFormat,
+            sampleRate: this.randomOutletOptions.sampleRate,
+            name: this.randomOutletOptions.name,
+            type: this.randomOutletOptions.type,
+            sourceId: this.randomOutletOptions.sourceId,
+            units: this.randomOutletOptions.unit,
         })
     }
 
@@ -207,27 +193,6 @@ export default class LslOutletTest extends AbstractSpruceTest {
         assert.isInstanceOf(instance, CheckingOutlet)
     }
 
-    @test('can add one label to channels', [generateId()])
-    @test('can add two labels to channels', [generateId(), generateId()])
-    protected static async appendsChannelsBasedOnCount(labels: string[]) {
-        const type = generateId()
-        const unit = generateId()
-
-        await this.Outlet({ channelNames: labels, type, unit })
-
-        assert.isEqualDeep(
-            this.fakeLiblsl.lastAppendChannelsToStreamInfoOptions,
-            {
-                info: this.fakeLiblsl.streamInfo,
-                channels: labels.map((label) => ({
-                    label,
-                    type,
-                    unit,
-                })),
-            }
-        )
-    }
-
     @test()
     protected static async canDestroyOutlet() {
         const outlet = await this.Outlet()
@@ -243,7 +208,7 @@ export default class LslOutletTest extends AbstractSpruceTest {
         outlet.pushSample([2.0])
         outlet.pushSample([3.0])
 
-        assert.isEqual(this.fakeLiblsl.createStreamInfoHitCount, 1)
+        assert.isEqual(this.fakeLiblsl.createOutletHitCount, 1)
     }
 
     @test()
@@ -309,7 +274,7 @@ export default class LslOutletTest extends AbstractSpruceTest {
 }
 
 class CheckingOutlet extends LslOutletImpl {
-    public constructor(options: LslOutletOptions) {
-        super(options)
+    public constructor(info: StreamInfo, options: LslOutletOptions) {
+        super(info, options)
     }
 }