@neurodevs/node-lsl 17.1.1 → 18.1.0

package/.claude/settings.local.json

@@ -0,0 +1,10 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(yarn build.dev)",
+      "Bash(yarn test:*)",
+      "Bash(NODE_OPTIONS=--experimental-vm-modules yarn test:*)",
+      "Bash(tsc:*)"
+    ]
+  }
+}

package/.vscode/launch.json

@@ -1,58 +1,55 @@
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"type": "node",
-			"request": "attach",
-			"name": "attach.tests",
-			"port": 5200,
-			"restart": true,
-			"timeout": 10000
-		},
-		{
-			"type": "node",
-			"request": "launch",
-			"name": "test.file",
-			"runtimeExecutable": "node",
-			"runtimeArgs": [
-				"--inspect-brk",
-				"--trace-warnings",
-				"${workspaceFolder}/node_modules/.bin/jest",
-				"${fileBasenameNoExtension}",
-				"--detectOpenHandles"
-			],
-			"cwd": "${workspaceFolder}",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen"
-		},
-		{
-			"type": "node",
-			"request": "launch",
-			"name": "test.all",
-			"runtimeExecutable": "node",
-			"runtimeArgs": [
-				"--inspect-brk",
-				"--trace-warnings",
-				"${workspaceFolder}/node_modules/.bin/jest"
-			],
-			"cwd": "${workspaceFolder}",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen"
-		},
-		{
-			"type": "node",
-			"request": "launch",
-			"name": "boot",
-			"runtimeExecutable": "yarn",
-			"runtimeArgs": [
-				"run",
-				"--inspect-brk",
-				"--trace-warnings",
-				"boot"
-			],
-			"cwd": "${workspaceFolder}",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen"
-		}
-	]
-}
+  "version": "1.0.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "attach.tests",
+      "port": 5200,
+      "restart": true,
+      "timeout": 10000
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "test.file",
+      "runtimeExecutable": "node",
+      "runtimeArgs": [
+        "--inspect-brk",
+        "--trace-warnings",
+        "--experimental-vm-modules",
+        "${workspaceFolder}/node_modules/.bin/jest",
+        "${fileBasenameNoExtension}",
+        "--detectOpenHandles"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "test.all",
+      "runtimeExecutable": "node",
+      "runtimeArgs": [
+        "--inspect-brk",
+        "--trace-warnings",
+        "--experimental-vm-modules",
+        "${workspaceFolder}/node_modules/.bin/jest"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "boot",
+      "runtimeExecutable": "yarn",
+      "runtimeArgs": ["run", "--inspect-brk", "--trace-warnings", "boot"],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    }
+  ]
+}

package/.vscode/settings.json

@@ -1,67 +1,62 @@
 {
-	"debug.node.autoAttach": "on",
-	"git.ignoreLimitWarning": true,
-	"javascript.validate.enable": false,
-	"files.watcherExclude": {
-		"**/.git/objects/**": true,
-		"**/.git/subtree-cache/**": true,
-		"**/build/**": true,
-		"**/node_modules/**": true,
-	},
-	"search.exclude": {
-		"**/build/**": true,
-		"**/node_modules/**": true,
-		"**/.next/**": true
-	},
-	"editor.maxTokenizationLineLength": 20000000,
-	"[javascript]": {
-		"editor.formatOnSave": false
-	},
-	"[javascriptreact]": {
-		"editor.formatOnSave": false
-	},
-	"[typescript]": {
-		"editor.formatOnSave": false
-	},
-	"[typescriptreact]": {
-		"editor.formatOnSave": false
-	},
-	"[handlebars]": {
-		"editor.formatOnSave": false
-	},
-	"typescript.tsdk": "node_modules/typescript/lib",
-	"cSpell.ignorePaths": [
-		"**/package-lock.json",
-		"**/node_modules/**",
-		"**/build/**",
-		"**/vscode-extension/**",
-		"**/.git/objects/**",
-		".vscode",
-		".spruce"
-	],
-	"cSpell.words": [
-		"arkit",
-		"autogenerated",
-		"scrollable",
-		"serializable"
-	],
-	"debug.javascript.unmapMissingSources": true,
-	"javascript.preferences.importModuleSpecifier": "relative",
-	"typescript.preferences.importModuleSpecifier": "relative",
-	"eslint.experimental.useFlatConfig": true,
-	"eslint.enable": true,
-	"eslint.validate": [
-		"javascript",
-		"javascriptreact",
-		"typescript",
-		"typescriptreact"
-	],
-	"eslint.workingDirectories": [
-		"./"
-	],
-	"typescript.validate.enable": true,
-	"editor.formatOnSave": false,
-	"editor.codeActionsOnSave": {
-		"source.fixAll.eslint": "always"
-	}
-}
+  "debug.node.autoAttach": "on",
+  "git.ignoreLimitWarning": true,
+  "javascript.validate.enable": false,
+  "files.watcherExclude": {
+    "**/.git/objects/**": true,
+    "**/.git/subtree-cache/**": true,
+    "**/build/**": true,
+    "**/node_modules/**": true
+  },
+  "search.exclude": {
+    "**/build/**": true,
+    "**/node_modules/**": true,
+    "**/.next/**": true
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always"
+  },
+  "editor.formatOnSave": true,
+  "editor.formatOnSaveMode": "file",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.maxTokenizationLineLength": 20000000,
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "eslint.enable": true,
+  "eslint.useFlatConfig": true,
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "eslint.workingDirectories": ["./"],
+  "debug.javascript.unmapMissingSources": true,
+  "javascript.preferences.importModuleSpecifier": "relative",
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.validate.enable": true,
+  "cSpell.ignorePaths": [
+    "**/package-lock.json",
+    "**/node_modules/**",
+    "**/build/**",
+    "**/vscode-extension/**",
+    "**/.git/objects/**",
+    ".vscode"
+  ],
+  "cSpell.words": ["arkit", "autogenerated", "scrollable", "serializable"]
+}

package/.vscode/tasks.json

@@ -1,130 +1,99 @@
 {
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "type": "npm",
-            "script": "watch.build.dev",
-            "group": "build",
-            "label": "watch.build.dev & problem.watcher",
-            "isBackground": true,
-            "runOptions": {
-                "runOn": "folderOpen"
-            },
-            "promptOnClose": false,
-            "presentation": {
-                "focus": false,
-                "reveal": "never"
-            },
-            "problemMatcher": {
-                "base": "$tsc-watch",
-                "applyTo": "allDocuments"
-            }
-        },
-        {
-            "label": "test.file",
-            "command": "spruce",
-            "args": [
-                "test",
-                "--inspect",
-                "5200",
-                "--pattern",
-                "${fileBasenameNoExtension}",
-                "--watchMode",
-                "standard"
-            ],
-            "promptOnClose": false,
-            "group": {
-                "kind": "test",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always",
-                "panel": "dedicated"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "test.reporter",
-            "command": "spruce",
-            "args": [
-                "test",
-                "--shouldHoldAtStart",
-                "true",
-                "--watchMode",
-                "smart"
-            ],
-            "promptOnClose": false,
-            "group": "test",
-            "runOptions": {
-                "runOn": "folderOpen"
-            },
-            "presentation": {
-                "panel": "shared",
-                "focus": true,
-                "reveal": "always"
-            }
-        },
-        {
-            "label": "spruce",
-            "type": "shell",
-            "command": "spruce ${input:spruceCommand}",
-            "problemMatcher": [],
-            "presentation": {
-                "reveal": "always",
-                "focus": true,
-                "panel": "new",
-                "clear": false
-            }
-        },
-        {
-            "label": "shell",
-            "type": "shell",
-            "command": "${input:command} ${input:optionsCommand}",
-            "problemMatcher": [],
-            "presentation": {
-                "reveal": "always",
-                "focus": true,
-                "panel": "new",
-                "clear": false
-            }
-        },
-        {
-            "label": "ndx",
-            "type": "shell",
-            "command": "ndx ${input:ndxCommand}",
-            "problemMatcher": [],
-            "presentation": {
-                "reveal": "always",
-                "focus": true,
-                "panel": "new",
-                "clear": false
-            }
-        }
-    ],
-    "inputs": [
-        {
-            "id": "spruceCommand",
-            "description": "spruce command",
-            "default": "create.test",
-            "type": "promptString"
-        },
-        {
-            "id": "command",
-            "description": "command",
-            "default": "yarn",
-            "type": "promptString"
-        },
-        {
-            "id": "optionsCommand",
-            "description": "optionsCommand",
-            "default": "add",
-            "type": "promptString"
-        },
-        {
-            "id": "ndxCommand",
-            "description": "ndx command",
-            "default": "create.module",
-            "type": "promptString"
-        }
-    ]
-}
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "watch.build.dev",
+      "group": "build",
+      "label": "watch.build.dev & problem.watcher",
+      "isBackground": true,
+      "runOptions": {
+        "runOn": "folderOpen"
+      },
+      "promptOnClose": false,
+      "presentation": {
+        "focus": false,
+        "reveal": "never"
+      },
+      "problemMatcher": {
+        "base": "$tsc-watch",
+        "applyTo": "allDocuments"
+      }
+    },
+    {
+      "label": "test.file",
+      "type": "shell",
+      "command": "node node_modules/@neurodevs/node-tdd/build/workspace/testRunner.cli.js --pattern \"${fileBasenameNoExtension}\" --watchMode standard --inspect 5200",
+      "promptOnClose": false,
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "presentation": {
+        "reveal": "always",
+        "panel": "dedicated"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "test.reporter",
+      "type": "shell",
+      "command": "node node_modules/@neurodevs/node-tdd/build/workspace/testRunner.cli.js --watchMode standard",
+      "promptOnClose": false,
+      "group": "test",
+      "runOptions": {
+        "runOn": "folderOpen"
+      },
+      "presentation": {
+        "panel": "shared",
+        "focus": true,
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "shell",
+      "type": "shell",
+      "command": "${input:command} ${input:optionsCommand}",
+      "problemMatcher": [],
+      "presentation": {
+        "reveal": "always",
+        "focus": true,
+        "panel": "new",
+        "clear": false
+      }
+    },
+    {
+      "label": "ndx",
+      "type": "shell",
+      "command": "ndx ${input:ndxCommand}",
+      "problemMatcher": [],
+      "presentation": {
+        "reveal": "always",
+        "focus": true,
+        "panel": "new",
+        "clear": false
+      }
+    }
+  ],
+  "inputs": [
+    {
+      "id": "command",
+      "description": "command",
+      "default": "yarn",
+      "type": "promptString"
+    },
+    {
+      "id": "optionsCommand",
+      "description": "optionsCommand",
+      "default": "add",
+      "type": "promptString"
+    },
+    {
+      "id": "ndxCommand",
+      "description": "ndx command",
+      "default": "create.module",
+      "type": "promptString"
+    }
+  ]
+}

package/README.md

@@ -1,12 +1,14 @@
 # node-lsl
+
 Lab Streaming Layer (LSL) for synchronized streaming of multi-modal, time-series data over a network.
 
 ## Table of Contents
+
 - [Overview](#overview)
 - [Installation](#installation)
 - [Usage](#usage)
   - [LslStreamOutlet](#lslstreamoutlet)
-  - [LslEventMarkerOutlet](#lsleventmarkeroutlet) 
+  - [LslEventMarkerEmitter](#LslEventMarkerEmitter)
 - [Test Doubles](#test-doubles)
 
 ## Overview
@@ -23,9 +25,9 @@ First, you need to install the C++ [liblsl](https://github.com/sccn/liblsl) libr
 
 Then, install the package with your preferred package manager (make sure to be in the right directory for your Node project):
 
-`npm install @neurodevs/node-lsl` 
+`npm install @neurodevs/node-lsl`
 
-or 
+or
 
 `yarn add @neurodevs/node-lsl`
 
@@ -45,59 +47,33 @@ LSL is often used to stream EEG data over a network. For example, to instantiate
 import { LslStreamOutlet } from '@neurodevs/node-lsl'
 
 const outlet = await LslStreamOutlet.Create({
-    name: 'Muse S (2nd gen)',
-    type: 'EEG',
-    sourceId: 'muse-s-eeg',
-    channelNames: ['TP9', 'AF7', 'AF8', 'TP10', 'AUX'],
-    channelFormat: 'float32',
-    sampleRateHz: 256,
-    chunkSize: 12,
+  name: 'Muse S (2nd gen)',
+  type: 'EEG',
+  sourceId: 'muse-s-eeg',
+  channelNames: ['TP9', 'AF7', 'AF8', 'TP10', 'AUX'],
+  channelFormat: 'float32',
+  sampleRateHz: 256,
+  chunkSize: 12,
 })
 
 outlet.pushSample([1, 2, 3, 4, 5])
 ```
 
-### LslEventMarkerOutlet
+### LslEventMarkerEmitter
 
-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.
+LSL is also often used to push event markers that mark different phases of an experiment or session. The `emitMany` method pushes an event marker, waits for a specified duration, then pushes the next marker. From experience, each event marker should have a `waitAfterMs` of at least 100 ms or so to ensure LSL receives the event markers in the right order.
 
 ```typescript
-import { LslEventMarkerOutlet } from '@neurodevs/node-lsl'
+import { LslEventMarkerEmitter } from '@neurodevs/node-lsl'
 
-const outlet = await LslEventMarkerOutlet.Create()
+const emitter = await LslEventMarkerEmitter.Create()
 
 const markers = [
-    { name: 'phase-1-begin', durationMs: 1000 },
-    { name: 'phase-1-end', durationMs: 100 },
+  { name: 'phase-1-begin', waitAfterMs: 5000 },
+  { name: 'phase-1-end', waitAfterMs: 100 },
 ]
 
-// Hangs until complete
-await outlet.pushMarkers(markers)
+const promise = emitter.emitMany(markers)
 
-// Void promise, does not hang
-void outlet.pushMarkers(markers)
-
-// Interrupts the above pushMarkers process
-outlet.stop()
+emitter.interrupt()
 ```
-
-## 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 `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 { LslEventMarkerOutlet, MockEventMarkerOutlet } from '@neurodevs/node-lsl'
-
-// In your tests / beforeEach
-LslEventMarkerOutlet.Class = MockEventMarkerOutlet
-const mock = await LslEventMarkerOutlet.Create()
-
-// Do something in your application that should start the outlet
-
-const expectedMarkers = ['phase-1-begin', ...]
-mock.assertDidPushSamples(expectedMarkers)
-```
-
-Now, you'll have a failing test. There will be a helpful error message to guide you towards the solution. Basically, you just need to call the `pushSample` method in your application with the expected markers. See examples above for how to do so.

package/build/__tests__/AbstractPackageTest.d.ts

@@ -1,27 +1,29 @@
+import { FakeLiblsl, FakeLibndx } from '@neurodevs/ndx-native';
 import AbstractModuleTest from '@neurodevs/node-tdd';
-import { OnDataCallback, StreamInletOptions } from '../impl/LslStreamInlet.js';
-import FakeLiblsl from '../testDoubles/Liblsl/FakeLiblsl.js';
 import FakeStreamInfo from '../testDoubles/StreamInfo/FakeStreamInfo.js';
+import { OnDataCallback, StreamInletOptions } from '../impl/LslStreamInlet.js';
 export default class AbstractPackageTest extends AbstractModuleTest {
     protected static fakeLiblsl: FakeLiblsl;
+    protected static fakeLibndx: FakeLibndx;
     protected static beforeEach(): Promise<void>;
     protected static setFakeLiblsl(): void;
+    protected static setFakeLibndx(): void;
     protected static setSpyStreamInfo(): void;
     protected static setFakeStreamInfo(): void;
     protected static setSpyStreamInlet(): void;
     protected static setFakeStreamInlet(): void;
     protected static setFakeStreamOutlet(): void;
-    protected static setSpyEventMarkerOutlet(): void;
+    protected static setSpyEventMarkerEmitter(): void;
     protected static setSpyLslWebSocketBridge(): void;
     protected static setFakeWebSocket(): void;
     protected static setFakeWebSocketServer(): void;
-    protected static readonly info: FakeStreamInfo;
+    protected static readonly fakeStreamInfo: FakeStreamInfo;
     protected static readonly name_: string;
     protected static readonly type: string;
     protected static readonly sourceId: string;
     protected static readonly units: string;
     protected static readonly channelNames: string[];
-    protected static get channelCount(): number;
+    protected static readonly channelCount: number;
     protected static readonly chunkSize = 2;
     protected static readonly sampleRateHz: number;
     protected static readonly maxBufferedMs: number;