feat: Add associations.events.sidecar

Author: effigies

src/schema/associations.ts

@@ -5,16 +5,26 @@ import type { BIDSFile } from '../types/filetree.ts'
 import type { BIDSContext } from './context.ts'
 import { loadTSV } from '../files/tsv.ts'
 import { parseBvalBvec } from '../files/dwi.ts'
-import { walkBack } from '../files/inheritance.ts'
+import { readSidecars, walkBack } from '../files/inheritance.ts'
 import { evalCheck } from './applyRules.ts'
 import { expressionFunctions } from './expressionLanguage.ts'
 
 import { readText } from '../files/access.ts'
 
+interface WithSidecar {
+  sidecar: Record<string, unknown>
+}
+
 function defaultAssociation(file: BIDSFile, _options: any): Promise<{ path: string }> {
   return Promise.resolve({ path: file.path })
 }
 
+async function constructSidecar(file: BIDSFile): Promise<Record<string, unknown>> {
+  const sidecars = await readSidecars(file)
+  // Note ordering here gives precedence to the more specific sidecar
+  return sidecars.values().reduce((acc, json) => ({ ...json, ...acc }), {})
+}
+
 /**
  * This object describes lookup functions for files associated to data files in a bids dataset.
  * For any given data file we iterate over the associations defined schema.meta.associations.
@@ -24,14 +34,15 @@ function defaultAssociation(file: BIDSFile, _options: any): Promise<{ path: stri
  * Many associations only consist of a path; this object is for more complex associations.
  */
 const associationLookup = {
-  events: async (file: BIDSFile, options: { maxRows: number }): Promise<Events> => {
+  events: async (file: BIDSFile, options: { maxRows: number }): Promise<Events & WithSidecar> => {
     const columns = await loadTSV(file, options.maxRows)
       .catch((e) => {
         return new Map()
       })
     return {
       path: file.path,
       onset: columns.get('onset') || [],
+      sidecar: await constructSidecar(file),
     }
   },
   aslcontext: async (