@neurodevs/ndx-native 0.2.0 → 1.0.0

package/.regressionproof.json

@@ -0,0 +1,7 @@
+{
+  "version": "0.9.4",
+  "projectName": "ndx-native",
+  "remote": {
+    "url": "https://git.regressionproof.ai/liquidg3/ndx-native.git"
+  }
+}

package/.vscode/launch.json

@@ -1,58 +1,53 @@
 {
-	"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": "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"
+    }
+  ]
+}

package/.vscode/settings.json

@@ -1,67 +1,63 @@
 {
-	"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.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",
+    ".spruce"
+  ],
+  "cSpell.words": ["arkit", "autogenerated", "scrollable", "serializable"]
+}

package/.vscode/tasks.json

@@ -1,130 +1,124 @@
 {
-    "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",
+      "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"
+    }
+  ]
+}

package/README.md

@@ -1,2 +1,3 @@
 # ndx-native
+
 Native Node.js adapters for LSL, XDF, and LabRecorder

package/build/.spruce/settings.json

@@ -2,10 +2,10 @@
   "scriptUpdater": {
     "skipped": []
   },
-  "skipped": [
-    "skill"
-  ],
-  "installed": [
-    "test"
-  ]
-}
+  "skipped": ["skill"],
+  "installed": ["test"],
+  "regressionproof": {
+    "enabled": true,
+    "projectName": "ndx-native"
+  }
+}

package/build/__tests__/AbstractPackageTest.d.ts

@@ -3,5 +3,6 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     protected static readonly channelNames: string[];
     protected static readonly channelCount: number;
     protected static readonly chunkSize = 2;
+    protected static readonly fakeErrorMessage = "Fake error message!";
     protected static beforeEach(): Promise<void>;
 }

package/build/__tests__/AbstractPackageTest.js

@@ -7,6 +7,7 @@ export default class AbstractPackageTest extends AbstractModuleTest {
     ];
     static channelCount = this.channelNames.length;
     static chunkSize = 2;
+    static fakeErrorMessage = 'Fake error message!';
     static async beforeEach() {
         await super.beforeEach();
     }

package/build/__tests__/AbstractPackageTest.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractPackageTest.js","sourceRoot":"","sources":["../../src/__tests__/AbstractPackageTest.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,qBAAqB,CAAA;AAEpD,MAAM,CAAC,OAAO,OAAgB,mBAAoB,SAAQ,kBAAkB;IAC9D,MAAM,CAAU,YAAY,GAAG;QACrC,IAAI,CAAC,UAAU,EAAE;QACjB,IAAI,CAAC,UAAU,EAAE;QACjB,IAAI,CAAC,UAAU,EAAE;KACpB,CAAA;IAES,MAAM,CAAU,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAA;IACvD,MAAM,CAAU,SAAS,GAAG,CAAC,CAAA;IAE7B,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;IAC5B,CAAC"}
+{"version":3,"file":"AbstractPackageTest.js","sourceRoot":"","sources":["../../src/__tests__/AbstractPackageTest.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,qBAAqB,CAAA;AAEpD,MAAM,CAAC,OAAO,OAAgB,mBAAoB,SAAQ,kBAAkB;IAC9D,MAAM,CAAU,YAAY,GAAG;QACrC,IAAI,CAAC,UAAU,EAAE;QACjB,IAAI,CAAC,UAAU,EAAE;QACjB,IAAI,CAAC,UAAU,EAAE;KACpB,CAAA;IAES,MAAM,CAAU,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAA;IACvD,MAAM,CAAU,SAAS,GAAG,CAAC,CAAA;IAE7B,MAAM,CAAU,gBAAgB,GAAG,qBAAqB,CAAA;IAExD,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;IAC5B,CAAC"}

package/build/__tests__/impl/LabrecorderAdapter.test.d.ts

@@ -10,7 +10,7 @@ export default class LabrecorderAdapterTest extends AbstractPackageTest {
     private static readonly filename;
     private static readonly watchFor;
     protected static beforeEach(): Promise<void>;
-    protected static canCreateLabrecorderAdapter(): Promise<void>;
+    protected static createsInstance(): Promise<void>;
     protected static callsFfiRsOpenWithRequiredOptions(): Promise<void>;
     protected static callsFfiRsDefineWithRequiredOptions(): Promise<void>;
     protected static createRecordingCallsBindings(): Promise<void>;

package/build/__tests__/impl/LabrecorderAdapter.test.js

@@ -26,14 +26,14 @@ export default class LabrecorderAdapterTest extends AbstractPackageTest {
         this.fakeFfiRsDefine();
         this.instance = this.LabrecorderAdapter();
     }
-    static async canCreateLabrecorderAdapter() {
-        assert.isTruthy(this.instance, 'Should create an instance!');
+    static async createsInstance() {
+        assert.isTruthy(this.instance, 'Failed to create instance!');
     }
     static async callsFfiRsOpenWithRequiredOptions() {
         assert.isEqualDeep(this.ffiRsOpenOptions, {
             library: 'labrecorder',
             path: this.labrecorderPath,
-        });
+        }, 'Did not pass valid options to ffiRsOpen!');
     }
     static async callsFfiRsDefineWithRequiredOptions() {
         this.LabrecorderAdapter();
@@ -61,7 +61,7 @@ export default class LabrecorderAdapterTest extends AbstractPackageTest {
                     DataType.External, // Pointer to the recording object
                 ],
             },
-        }, 'Please pass valid options to ffiRsDefine!');
+        }, 'Did not pass valid options to ffiRsDefine!');
     }
     static async createRecordingCallsBindings() {
         this.createRecording();
@@ -69,22 +69,22 @@ export default class LabrecorderAdapterTest extends AbstractPackageTest {
             filename: this.filename,
             watchFor: this.watchFor,
             watchForCount: this.watchFor.length,
-        }, 'Should create a recording!');
+        }, 'Did not create a recording!');
     }
     static async defaultsToMacOsPath() {
         const defaultLabrecorderPath = '/opt/local/lib/liblabrecorder.dylib';
         LabrecorderAdapter.Create();
         const { path } = this.ffiRsOpenOptions ?? {};
-        assert.isEqual(path, defaultLabrecorderPath);
+        assert.isEqual(path, defaultLabrecorderPath, 'Did not use default macOS path!');
     }
     static async stopRecordingCallsBindings() {
         const recording = this.createRecording();
         this.stopRecording(recording);
-        assert.isEqualDeep(this.callsToRecordingStop[0], recording);
+        assert.isEqualDeep(this.callsToRecordingStop[0], recording, 'Did not stop recording!');
     }
     static async deleteRecordingCallsBindings() {
         const recording = this.createAndDeleteRecording();
-        assert.isEqualDeep(this.callsToRecordingDelete[0], recording);
+        assert.isEqualDeep(this.callsToRecordingDelete[0], recording, 'Did not delete recording!');
     }
     static createAndDeleteRecording() {
         const recording = this.createRecording();
@@ -142,7 +142,7 @@ export default class LabrecorderAdapterTest extends AbstractPackageTest {
 }
 __decorate([
     test()
-], LabrecorderAdapterTest, "canCreateLabrecorderAdapter", null);
+], LabrecorderAdapterTest, "createsInstance", null);
 __decorate([
     test()
 ], LabrecorderAdapterTest, "callsFfiRsOpenWithRequiredOptions", null);