@neurodevs/ndx-native 0.2.0 → 1.0.0

package/src/impl/LibndxAdapter.ts

@@ -0,0 +1,204 @@
+import { DataType, define, open } from 'ffi-rs'
+
+export default class LibndxAdapter implements Libndx {
+    public static Class?: LibndxConstructor
+    public static ffiRsOpen = open
+    public static ffiRsDefine = define
+
+    private static instance?: Libndx
+
+    private libndxPath: string
+    private bindings!: LibndxBindings
+
+    protected constructor(options?: LibndxAdapterOptions) {
+        const { libndxPath = '' } = options ?? {}
+
+        this.libndxPath = libndxPath
+
+        this.tryToLoadBindings()
+    }
+
+    public static getInstance(options?: LibndxAdapterOptions) {
+        if (!this.instance) {
+            this.setInstance(new this(options))
+        }
+        return this.instance!
+    }
+
+    public static setInstance(instance: Libndx) {
+        this.instance = instance
+    }
+
+    public static resetInstance() {
+        delete this.instance
+    }
+
+    private tryToLoadBindings() {
+        try {
+            this.openLibndx()
+            this.defineBindings()
+        } catch (err: unknown) {
+            this.throwFailedToLoadLibndx(err as Error)
+        }
+    }
+
+    private openLibndx() {
+        this.ffiRsOpen({
+            library: 'ndx',
+            path: this.libndxPath,
+        })
+    }
+
+    private defineBindings() {
+        this.bindings = this.ffiRsDefine({
+            create_ble_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+            start_ble_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+            stop_ble_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+            destroy_ble_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+            create_ftdi_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+            start_ftdi_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+            stop_ftdi_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+            destroy_ftdi_backend: {
+                library: 'ndx',
+                retType: DataType.String,
+                paramsType: [DataType.String],
+            },
+        }) as LibndxBindings
+    }
+
+    private throwFailedToLoadLibndx(err: Error) {
+        throw new Error(
+            `
+            \n -----------------------------------
+            \n Failed to load libndx! Tried to load from: 
+            \n     ${this.libndxPath}
+            \n Instructions to save your day (on MacOS):
+            \n     1. git clone https://github.com/neurodevs/libndx.git
+            \n     2. cd libndx && cmake -S . -B build && cmake --build build
+            \n     3. sudo cp build/libndx.dylib /opt/local/lib/
+            \n     4. Try whatever you were doing again!
+            \n Modify step 3 for your OS if you are not on MacOS.
+            \n If you're still unsure, ask an LLM with this error and your OS. 
+            \n You could also post an issue on the repo:
+            \n     https://github.com/neurodevs/ndx-native/issues
+            \n Good luck!
+            \n @ericthecurious
+            \n -----------------------------------
+            \n Original error: ${err.message}
+            \n
+        `.replace(/\s+/g, '')
+        )
+    }
+
+    public createBleBackend(options: BleBackendOptions) {
+        const { deviceUuid } = options
+        return this.bindings.create_ble_backend([deviceUuid])
+    }
+
+    public startBleBackend(options: BleBackendOptions) {
+        const { deviceUuid } = options
+        return this.bindings.start_ble_backend([deviceUuid])
+    }
+
+    public stopBleBackend(options: BleBackendOptions) {
+        const { deviceUuid } = options
+        return this.bindings.stop_ble_backend([deviceUuid])
+    }
+
+    public destroyBleBackend(options: BleBackendOptions) {
+        const { deviceUuid } = options
+        return this.bindings.destroy_ble_backend([deviceUuid])
+    }
+
+    public createFtdiBackend(options: FtdiBackendOptions) {
+        const { serialNumber } = options
+        return this.bindings.create_ftdi_backend([serialNumber])
+    }
+
+    public startFtdiBackend(options: FtdiBackendOptions) {
+        const { serialNumber } = options
+        return this.bindings.start_ftdi_backend([serialNumber])
+    }
+
+    public stopFtdiBackend(options: FtdiBackendOptions) {
+        const { serialNumber } = options
+        return this.bindings.stop_ftdi_backend([serialNumber])
+    }
+
+    public destroyFtdiBackend(options: FtdiBackendOptions) {
+        const { serialNumber } = options
+        return this.bindings.destroy_ftdi_backend([serialNumber])
+    }
+
+    private get ffiRsOpen() {
+        return LibndxAdapter.ffiRsOpen
+    }
+
+    private get ffiRsDefine() {
+        return LibndxAdapter.ffiRsDefine
+    }
+}
+
+export interface Libndx {
+    createBleBackend(options: BleBackendOptions): string
+    startBleBackend(options: BleBackendOptions): string
+    stopBleBackend(options: BleBackendOptions): string
+    destroyBleBackend(options: BleBackendOptions): string
+    createFtdiBackend(options: FtdiBackendOptions): string
+    startFtdiBackend(options: FtdiBackendOptions): string
+    stopFtdiBackend(options: FtdiBackendOptions): string
+    destroyFtdiBackend(options: FtdiBackendOptions): string
+}
+
+export type LibndxConstructor = new (options?: LibndxAdapterOptions) => Libndx
+
+export interface LibndxAdapterOptions {
+    libndxPath?: string
+}
+
+export interface BleBackendOptions {
+    deviceUuid: string
+}
+
+export interface FtdiBackendOptions {
+    serialNumber: string
+}
+
+export interface LibndxBindings {
+    create_ble_backend(args: [string]): string
+    start_ble_backend(args: [string]): string
+    stop_ble_backend(args: [string]): string
+    destroy_ble_backend(args: [string]): string
+    create_ftdi_backend(args: [string]): string
+    start_ftdi_backend(args: [string]): string
+    stop_ftdi_backend(args: [string]): string
+    destroy_ftdi_backend(args: [string]): string
+}

package/src/impl/LibxdfAdapter.ts

@@ -3,7 +3,7 @@ import {
     MangledNameExtractor,
     MangledNameMap,
 } from '@neurodevs/node-mangled-names'
-import { DataType, define, FieldType, FuncObj, open } from 'ffi-rs'
+import { DataType, define, open } from 'ffi-rs'
 
 export default class LibxdfAdapter implements Libxdf {
     public static Class?: LibxdfConstructor
@@ -37,19 +37,15 @@ export default class LibxdfAdapter implements Libxdf {
 
     private tryToLoadBindings() {
         try {
-            this.bindings = this.loadBindings()
+            this.openLibxdf()
+            this.bindings = this.defineBindings()
         } catch (err: unknown) {
             this.throwFailedToLoadLiblsl(err)
         }
     }
 
-    private loadBindings() {
-        this.openLibxdf()
-        return this.defineBindings()
-    }
-
     private openLibxdf() {
-        LibxdfAdapter.ffiRsOpen({
+        this.ffiRsOpen({
             library: 'xdf',
             path: this.libxdfPath,
         })
@@ -68,7 +64,7 @@ export default class LibxdfAdapter implements Libxdf {
             return acc
         }, {})
 
-        return LibxdfAdapter.ffiRsDefine(funcs)
+        return this.ffiRsDefine(funcs)
     }
 
     private throwFailedToLoadLiblsl(err: unknown) {
@@ -126,6 +122,14 @@ export default class LibxdfAdapter implements Libxdf {
         return LibxdfAdapter.loadXdfName
     }
 
+    private get ffiRsOpen() {
+        return LibxdfAdapter.ffiRsOpen
+    }
+
+    private get ffiRsDefine() {
+        return LibxdfAdapter.ffiRsDefine
+    }
+
     private static generateFailedMessage(libxdfPath: string) {
         return `
 			\n -----------------------------------
@@ -171,12 +175,6 @@ export type LibxdfBindings = Record<string, (path: string[]) => string>
 
 export type LibxdfStatusCode = 0 | Exclude<number, 0>
 
-export type FfiRsDefineOptions = FuncObj<
-    FieldType,
-    boolean | undefined,
-    boolean | undefined
->
-
 export interface XdfFile {
     path: string
     streams: XdfStream[]

package/src/index.ts

@@ -14,6 +14,14 @@ export * from './impl/LiblslAdapter.js'
 export { default as FakeLiblsl } from './testDoubles/Liblsl/FakeLiblsl.js'
 export * from './testDoubles/Liblsl/FakeLiblsl.js'
 
+// Libndx
+
+export { default as LibndxAdapter } from './impl/LibndxAdapter.js'
+export * from './impl/LibndxAdapter.js'
+
+export { default as FakeLibndx } from './testDoubles/Libndx/FakeLibndx.js'
+export * from './testDoubles/Libndx/FakeLibndx.js'
+
 // Libxdf
 
 export { default as LibxdfAdapter } from './impl/LibxdfAdapter.js'
@@ -25,10 +33,10 @@ export * from './testDoubles/Libxdf/FakeLibxdf.js'
 export { default as SpyLibxdf } from './testDoubles/Libxdf/SpyLibxdf.js'
 export * from './testDoubles/Libxdf/SpyLibxdf.js'
 
-// handleError
+// handleLslError
 
-export { default as handleError } from './lib/handleError.js'
-export * from './lib/handleError.js'
+export { default as handleLslError } from './lib/handleLslError.js'
+export * from './lib/handleLslError.js'
 
 // consts
 

package/src/lib/{handleError.ts → handleLslError.ts}

@@ -1,4 +1,4 @@
-export default function handleError(errorCode: number) {
+export default function handleLslError(errorCode: number) {
     switch (errorCode) {
         case 0:
             return

package/src/testDoubles/Libndx/FakeLibndx.ts

@@ -0,0 +1,74 @@
+import {
+    BleBackendOptions,
+    FtdiBackendOptions,
+    Libndx,
+    LibndxAdapterOptions,
+} from '../../impl/LibndxAdapter.js'
+
+export default class FakeLibndx implements Libndx {
+    public static callsToConstructor: (LibndxAdapterOptions | undefined)[] = []
+    public static callsToCreateBleBackend: BleBackendOptions[] = []
+    public static callsToStartBleBackend: BleBackendOptions[] = []
+    public static callsToStopBleBacked: BleBackendOptions[] = []
+    public static callsToDestroyBleBackend: BleBackendOptions[] = []
+    public static callsToCreateFtdiBackend: FtdiBackendOptions[] = []
+    public static callsToStartFtdiBackend: FtdiBackendOptions[] = []
+    public static callsToStopFtdiBackend: FtdiBackendOptions[] = []
+    public static callsToDestroyFtdiBackend: FtdiBackendOptions[] = []
+
+    public constructor(options?: LibndxAdapterOptions) {
+        FakeLibndx.callsToConstructor.push(options)
+    }
+
+    public createBleBackend(options: BleBackendOptions) {
+        FakeLibndx.callsToCreateBleBackend.push(options)
+        return ''
+    }
+
+    public startBleBackend(options: BleBackendOptions) {
+        FakeLibndx.callsToStartBleBackend.push(options)
+        return ''
+    }
+
+    public stopBleBackend(options: BleBackendOptions) {
+        FakeLibndx.callsToStopBleBacked.push(options)
+        return ''
+    }
+
+    public destroyBleBackend(options: BleBackendOptions) {
+        FakeLibndx.callsToDestroyBleBackend.push(options)
+        return ''
+    }
+
+    public createFtdiBackend(options: FtdiBackendOptions) {
+        FakeLibndx.callsToCreateFtdiBackend.push(options)
+        return ''
+    }
+
+    public startFtdiBackend(options: FtdiBackendOptions) {
+        FakeLibndx.callsToStartFtdiBackend.push(options)
+        return ''
+    }
+
+    public stopFtdiBackend(options: FtdiBackendOptions) {
+        FakeLibndx.callsToStopFtdiBackend.push(options)
+        return ''
+    }
+
+    public destroyFtdiBackend(options: FtdiBackendOptions) {
+        FakeLibndx.callsToDestroyFtdiBackend.push(options)
+        return ''
+    }
+
+    public static resetTestDouble() {
+        FakeLibndx.callsToConstructor = []
+        FakeLibndx.callsToCreateBleBackend = []
+        FakeLibndx.callsToStartBleBackend = []
+        FakeLibndx.callsToStopBleBacked = []
+        FakeLibndx.callsToDestroyBleBackend = []
+        FakeLibndx.callsToCreateFtdiBackend = []
+        FakeLibndx.callsToStartFtdiBackend = []
+        FakeLibndx.callsToStopFtdiBackend = []
+        FakeLibndx.callsToDestroyFtdiBackend = []
+    }
+}

package/src/types.ts

@@ -0,0 +1,7 @@
+import { FuncObj, FieldType } from 'ffi-rs'
+
+export type FfiRsDefineOptions = FuncObj<
+    FieldType,
+    boolean | undefined,
+    boolean | undefined
+>

package/tsconfig.json

@@ -1,28 +1,25 @@
 {
-	"compilerOptions": {
-		"module": "nodenext",
-		"moduleResolution": "nodenext",
-		"target": "ES2022",
-		"lib": ["ES2022"],
-		"types": ["node"],
-		"baseUrl": "src",
-		"outDir": "build",
-		"sourceMap": false,
-		"strict": true,
-		"noImplicitAny": true,
-		"noImplicitReturns": true,
-		"noUnusedLocals": true,
-		"forceConsistentCasingInFileNames": true,
-		"declaration": true,
-		"skipLibCheck": true,
-		"esModuleInterop": true,
-		"moduleDetection": "force",
-		"allowJs": true,
-		"resolveJsonModule": true,
-		"experimentalDecorators": true
-	},
-	"include": [
-		"src/*.ts",
-		"src/**/*.ts"
-	]
-}
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "types": ["node"],
+    "baseUrl": "src",
+    "outDir": "build",
+    "sourceMap": false,
+    "strict": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "moduleDetection": "force",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true
+  },
+  "include": ["src/*.ts", "src/**/*.ts"]
+}

package/build/lib/handleError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"handleError.js","sourceRoot":"","sources":["../../src/lib/handleError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,SAAiB;IACjD,QAAQ,SAAS,EAAE,CAAC;QAChB,KAAK,CAAC;YACF,OAAM;QACV,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QACpE,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACvD,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QACnE,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;QAC7D;YACI,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;IAChE,CAAC;AACL,CAAC;AAED,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACpB,2CAAM,CAAA;IACN,sDAAY,CAAA;IACZ,gDAAS,CAAA;IACT,8DAAgB,CAAA;IAChB,kEAAkB,CAAA;AACtB,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}

package/eslint.config.mjs

@@ -1,3 +0,0 @@
-import eslintConfigSpruce from 'eslint-config-spruce'
-
-export default eslintConfigSpruce