@neurodevs/node-lsl 11.4.2 → 12.0.1

package/.vscode/tasks.json

@@ -39,7 +39,7 @@
             },
             "presentation": {
                 "reveal": "always",
-                "panel": "dedicated",
+                "panel": "dedicated"
             },
             "problemMatcher": []
         },
@@ -87,6 +87,18 @@
                 "panel": "new",
                 "clear": false
             }
+        },
+        {
+            "label": "ndx",
+            "type": "shell",
+            "command": "ndx ${input:ndxCommand}",
+            "problemMatcher": [],
+            "presentation": {
+                "reveal": "always",
+                "focus": true,
+                "panel": "new",
+                "clear": false
+            }
         }
     ],
     "inputs": [
@@ -107,6 +119,12 @@
             "description": "optionsCommand",
             "default": "add",
             "type": "promptString"
+        },
+        {
+            "id": "ndxCommand",
+            "description": "ndx command",
+            "default": "create.module",
+            "type": "promptString"
         }
     ]
 }

package/README.md

@@ -6,7 +6,7 @@ Lab Streaming Layer (LSL) for synchronized streaming of multi-modal, time-series
 - [Installation](#installation)
 - [Usage](#usage)
   - [LslStreamOutlet](#lslstreamoutlet)
-  - [EventMarkerOutlet](#eventmarkeroutlet) 
+  - [LslEventMarkerOutlet](#lsleventmarkeroutlet) 
 - [Test Doubles](#test-doubles)
 
 ## Overview
@@ -66,15 +66,15 @@ main().catch((error) => {
 })
 ```
 
-### EventMarkerOutlet
+### LslEventMarkerOutlet
 
 LSL is also often used to push event markers that mark different phases of an experiment or session. The `pushMarkers` method pushes an event marker, waits for a specified duration, then pushes the next marker. I recommend that each event marker has a duration of at least 100 ms so that LSL receives the markers in the right order.
 
 ```typescript
-import EventMarkerOutlet from '../modules/EventMarkerOutlet'
+import { LslEventMarkerOutlet } from '@neurodevs/node-lsl'
 
 async function main() {
-    const outlet = await EventMarkerOutlet.Create()
+    const outlet = await LslEventMarkerOutlet.Create()
 
     const markers = [
         { name: 'phase-1-begin', durationMs: 1000 },
@@ -94,23 +94,22 @@ async function main() {
 main().catch((error) => {
     console.error('Error in main:', error)
 })
-
 ```
 
 ## Test Doubles
 
 This package was developed using test-driven development (TDD). If you also follow TDD, you'll likely want test doubles to fake or mock certain behaviors for these classes.
 
-For example, the `MockMarkerOutlet` class lets you test whether your application appropriately calls its methods without actually doing anything. Set this mock in your test code like this:
+For example, the `MockEventMarkerOutlet` class lets you test whether your application appropriately calls its methods without actually doing anything. Set this mock in your test code like this:
 
 ```typescript
-import { EventMarkerOutlet, MockMarkerOutlet } from '@neurodevs/node-lsl'
+import { LslEventMarkerOutlet, MockEventMarkerOutlet } from '@neurodevs/node-lsl'
 
 // In your tests / beforeEach
-EventMarkerOutlet.Class = MockMarkerOutlet
+LslEventMarkerOutlet.Class = MockEventMarkerOutlet
 
 // Must be in async
-const mock = await EventMarkerOutlet.Create()
+const mock = await LslEventMarkerOutlet.Create()
 
 // Do something in your application that should start the outlet
 

package/build/__tests__/{AbstractLslTest.d.ts → AbstractPackageTest.d.ts}

@@ -1,14 +1,15 @@
-import AbstractSpruceTest from '@sprucelabs/test-utils';
-import FakeLiblsl from '../testDoubles/Liblsl/FakeLiblsl';
-export default class AbstractLslTest extends AbstractSpruceTest {
+import AbstractModuleTest from '@neurodevs/node-tdd';
+import FakeLiblsl from '../testDoubles/Liblsl/FakeLiblsl.js';
+export default class AbstractPackageTest extends AbstractModuleTest {
     protected static fakeLiblsl: FakeLiblsl;
     protected static beforeEach(): Promise<void>;
     protected static setFakeLiblsl(): void;
     protected static setSpyStreamInfo(): void;
     protected static setFakeStreamInfo(): void;
-    protected static setSpyLslInlet(): void;
-    protected static setFakeLslOutlet(): void;
-    protected static setSpyMarkerOutlet(): void;
+    protected static setSpyStreamInlet(): void;
+    protected static setFakeStreamOutlet(): void;
+    protected static setSpyEventMarkerOutlet(): void;
+    protected static generateId(): string;
     protected static readonly name_: string;
     protected static readonly type: string;
     protected static readonly sourceId: string;

package/build/__tests__/AbstractPackageTest.js

@@ -0,0 +1,53 @@
+import generateId from '@neurodevs/generate-id';
+import AbstractModuleTest from '@neurodevs/node-tdd';
+import LiblslAdapter from '../impl/LiblslAdapter.js';
+import LslEventMarkerOutlet from '../impl/LslEventMarkerOutlet.js';
+import LslStreamInfo from '../impl/LslStreamInfo.js';
+import LslStreamInlet from '../impl/LslStreamInlet.js';
+import LslStreamOutlet from '../impl/LslStreamOutlet.js';
+import SpyEventMarkerOutlet from '../testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js';
+import FakeLiblsl from '../testDoubles/Liblsl/FakeLiblsl.js';
+import FakeStreamInfo from '../testDoubles/StreamInfo/FakeStreamInfo.js';
+import SpyStreamInfo from '../testDoubles/StreamInfo/SpyStreamInfo.js';
+import { SpyStreamInlet } from '../testDoubles/StreamInlet/SpyStreamInlet.js';
+import FakeStreamOutlet from '../testDoubles/StreamOutlet/FakeStreamOutlet.js';
+export default class AbstractPackageTest extends AbstractModuleTest {
+    static fakeLiblsl;
+    static async beforeEach() {
+        await super.beforeEach();
+        this.setFakeLiblsl();
+    }
+    static setFakeLiblsl() {
+        this.fakeLiblsl = new FakeLiblsl();
+        LiblslAdapter.setInstance(this.fakeLiblsl);
+    }
+    static setSpyStreamInfo() {
+        LslStreamInfo.Class = SpyStreamInfo;
+    }
+    static setFakeStreamInfo() {
+        LslStreamInfo.Class = FakeStreamInfo;
+        FakeStreamInfo.resetTestDouble();
+    }
+    static setSpyStreamInlet() {
+        LslStreamInlet.Class = SpyStreamInlet;
+    }
+    static setFakeStreamOutlet() {
+        LslStreamOutlet.Class = FakeStreamOutlet;
+        FakeStreamOutlet.resetTestDouble();
+    }
+    static setSpyEventMarkerOutlet() {
+        LslEventMarkerOutlet.Class = SpyEventMarkerOutlet;
+    }
+    static generateId() {
+        return generateId();
+    }
+    static name_ = generateId();
+    static type = generateId();
+    static sourceId = generateId();
+    static units = generateId();
+    static channelNames = [generateId(), generateId()];
+    static chunkSize = Math.floor(Math.random() * 100);
+    static maxBuffered = Math.floor(Math.random() * 100);
+    static sampleRate = Math.floor(Math.random() * 100);
+}
+//# sourceMappingURL=AbstractPackageTest.js.map

package/build/__tests__/AbstractPackageTest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractPackageTest.js","sourceRoot":"","sources":["../../src/__tests__/AbstractPackageTest.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,wBAAwB,CAAA;AAC/C,OAAO,kBAAkB,MAAM,qBAAqB,CAAA;AAEpD,OAAO,aAAa,MAAM,0BAA0B,CAAA;AACpD,OAAO,oBAAoB,MAAM,iCAAiC,CAAA;AAClE,OAAO,aAAa,MAAM,0BAA0B,CAAA;AACpD,OAAO,cAAc,MAAM,2BAA2B,CAAA;AAEtD,OAAO,eAAe,MAAM,4BAA4B,CAAA;AACxD,OAAO,oBAAoB,MAAM,0DAA0D,CAAA;AAC3F,OAAO,UAAU,MAAM,qCAAqC,CAAA;AAC5D,OAAO,cAAc,MAAM,6CAA6C,CAAA;AACxE,OAAO,aAAa,MAAM,4CAA4C,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,8CAA8C,CAAA;AAC7E,OAAO,gBAAgB,MAAM,iDAAiD,CAAA;AAE9E,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,kBAAkB;IACrD,MAAM,CAAC,UAAU,CAAY;IAE7B,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;QAExB,IAAI,CAAC,aAAa,EAAE,CAAA;IACxB,CAAC;IAES,MAAM,CAAC,aAAa;QAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,EAAE,CAAA;QAClC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC9C,CAAC;IAES,MAAM,CAAC,gBAAgB;QAC7B,aAAa,CAAC,KAAK,GAAG,aAAa,CAAA;IACvC,CAAC;IAES,MAAM,CAAC,iBAAiB;QAC9B,aAAa,CAAC,KAAK,GAAG,cAAc,CAAA;QACpC,cAAc,CAAC,eAAe,EAAE,CAAA;IACpC,CAAC;IAES,MAAM,CAAC,iBAAiB;QAC9B,cAAc,CAAC,KAAK,GAAG,cAAc,CAAA;IACzC,CAAC;IAES,MAAM,CAAC,mBAAmB;QAChC,eAAe,CAAC,KAAK,GAAG,gBAAgB,CAAA;QACxC,gBAAgB,CAAC,eAAe,EAAE,CAAA;IACtC,CAAC;IAES,MAAM,CAAC,uBAAuB;QACpC,oBAAoB,CAAC,KAAK,GAAG,oBAAoB,CAAA;IACrD,CAAC;IAES,MAAM,CAAC,UAAU;QACvB,OAAO,UAAU,EAAE,CAAA;IACvB,CAAC;IAES,MAAM,CAAU,KAAK,GAAG,UAAU,EAAE,CAAA;IACpC,MAAM,CAAU,IAAI,GAAG,UAAU,EAAE,CAAA;IACnC,MAAM,CAAU,QAAQ,GAAG,UAAU,EAAE,CAAA;IACvC,MAAM,CAAU,KAAK,GAAG,UAAU,EAAE,CAAA;IACpC,MAAM,CAAU,YAAY,GAAG,CAAC,UAAU,EAAE,EAAE,UAAU,EAAE,CAAC,CAAA;IAC3D,MAAM,CAAU,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAA;IAC3D,MAAM,CAAU,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAA;IAC7D,MAAM,CAAU,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAA"}

package/build/__tests__/{modules → impl}/LiblslAdapter.test.d.ts

@@ -1,6 +1,6 @@
-import AbstractLslTest from '../AbstractLslTest';
-export default class LiblslAdapterTest extends AbstractLslTest {
-    private static lsl;
+import AbstractPackageTest from '../AbstractPackageTest.js';
+export default class LiblslAdapterTest extends AbstractPackageTest {
+    private static instance;
     private static libraryPath?;
     private static libraryOptions?;
     private static fakeBindings;
@@ -14,6 +14,7 @@ export default class LiblslAdapterTest extends AbstractLslTest {
     private static createOutletParams?;
     private static destroyOutletParams?;
     private static createInletParams?;
+    private static flushInletParams?;
     private static destroyInletParams?;
     private static localClockParams?;
     private static pushSampleFloatTimestampParams?;
@@ -26,6 +27,7 @@ export default class LiblslAdapterTest extends AbstractLslTest {
     private static ffiRsOpenOptions?;
     private static ffiRsDefineOptions;
     protected static beforeEach(): Promise<void>;
+    protected static createsInstance(): Promise<void>;
     protected static throwsWhenBindingsFailToLoad(): Promise<void>;
     protected static callsOpenOnFfiRs(): Promise<void>;
     protected static worksAsASingleton(): Promise<void>;
@@ -43,6 +45,7 @@ export default class LiblslAdapterTest extends AbstractLslTest {
     protected static localClockBindingReceivesEmptyArray(): Promise<void>;
     protected static defaultsToMacOsPath(): Promise<void>;
     protected static canCreateInletWithRequiredParams(): Promise<void>;
+    protected static flushInletCallsBinding(): Promise<void>;
     private static createRandomStreamInfo;
     private static createRandomOutlet;
     private static createRandomInlet;