Merge pull request #1146 from david-roper/expand-array-export

Expand array export

Author: joshunrau

apps/api/src/instrument-records/instrument-records.service.ts

@@ -5,6 +5,7 @@ import { linearRegression } from '@douglasneuroinformatics/libstats';
 import { BadRequestException, Injectable, NotFoundException, UnprocessableEntityException } from '@nestjs/common';
 import type { Json, ScalarInstrument } from '@opendatacapture/runtime-core';
 import { DEFAULT_GROUP_NAME } from '@opendatacapture/schemas/core';
+import { $RecordArrayFieldValue } from '@opendatacapture/schemas/instrument';
 import type {
   CreateInstrumentRecordData,
   InstrumentRecord,
@@ -26,6 +27,17 @@ import { SubjectsService } from '@/subjects/subjects.service';
 
 import { InstrumentMeasuresService } from './instrument-measures.service';
 
+type ExpandDataType =
+  | {
+      measure: string;
+      measureValue: boolean | Date | number | string | undefined;
+      success: true;
+    }
+  | {
+      message: string;
+      success: false;
+    };
+
 @Injectable()
 export class InstrumentRecordsService {
   constructor(
@@ -153,26 +165,53 @@ export class InstrumentRecordsService {
         instrument = (await this.instrumentsService.findById(record.instrumentId)) as ScalarInstrument;
         instruments.set(record.instrumentId, instrument);
       }
-
       for (const [measureKey, measureValue] of Object.entries(record.computedMeasures)) {
-        data.push({
-          instrumentEdition: instrument.internal.edition,
-          instrumentName: instrument.internal.name,
-          measure: measureKey,
-          sessionDate: record.session.date.toISOString(),
-          sessionId: record.session.id,
-          sessionType: record.session.type,
-          subjectAge: record.subject.dateOfBirth ? yearsPassed(record.subject.dateOfBirth) : null,
-          // eslint-disable-next-line perfectionist/sort-objects
-          groupId: record.subject.groupIds[0] ?? DEFAULT_GROUP_NAME,
-          subjectId: record.subject.id,
-          subjectSex: record.subject.sex,
-          timestamp: record.date.toISOString(),
-          value: measureValue
-        });
+        if (measureValue == null) {
+          continue;
+        }
+
+        if (!Array.isArray(measureValue)) {
+          data.push({
+            groupId: record.subject.groupIds[0] ?? DEFAULT_GROUP_NAME,
+            instrumentEdition: instrument.internal.edition,
+            instrumentName: instrument.internal.name,
+            measure: measureKey,
+            sessionDate: record.session.date.toISOString(),
+            sessionId: record.session.id,
+            sessionType: record.session.type,
+            subjectAge: record.subject.dateOfBirth ? yearsPassed(record.subject.dateOfBirth) : null,
+            subjectId: record.subject.id,
+            subjectSex: record.subject.sex,
+            timestamp: record.date.toISOString(),
+            value: measureValue
+          });
+        }
+
+        if (Array.isArray(measureValue) && measureValue.length < 1) continue;
+
+        if (Array.isArray(measureValue) && measureValue.length >= 1) {
+          const arrayResult = this.expandData(measureValue);
+          arrayResult.forEach((arrayEntry: ExpandDataType) => {
+            if (!arrayEntry.success)
+              throw new Error(`exportRecords: ${instrument.internal.name}.${measureKey} — ${arrayEntry.message}`);
+            data.push({
+              groupId: record.subject.groupIds[0] ?? DEFAULT_GROUP_NAME,
+              instrumentEdition: instrument.internal.edition,
+              instrumentName: instrument.internal.name,
+              measure: `${measureKey} - ${arrayEntry.measure}`,
+              sessionDate: record.session.date.toISOString(),
+              sessionId: record.session.id,
+              sessionType: record.session.type,
+              subjectAge: record.subject.dateOfBirth ? yearsPassed(record.subject.dateOfBirth) : null,
+              subjectId: record.subject.id,
+              subjectSex: record.subject.sex,
+              timestamp: record.date.toISOString(),
+              value: arrayEntry.measureValue
+            });
+          });
+        }
       }
     }
-
     return data;
   }
 
@@ -378,6 +417,30 @@ export class InstrumentRecordsService {
     }
   }
 
+  private expandData(listEntry: any[]): ExpandDataType[] {
+    const validRecordArrayList: ExpandDataType[] = [];
+    if (listEntry.length < 1) {
+      throw new Error('Record Array is Empty');
+    }
+    for (const objectEntry of Object.values(listEntry)) {
+      for (const [dataKey, dataValue] of Object.entries(objectEntry as { [key: string]: any })) {
+        const parseResult = $RecordArrayFieldValue.safeParse(dataValue);
+        if (!parseResult.success) {
+          validRecordArrayList.push({
+            message: `Error interpreting value ${dataValue} and record array key ${dataKey}`,
+            success: false
+          });
+        }
+        validRecordArrayList.push({
+          measure: dataKey,
+          measureValue: parseResult.data,
+          success: true
+        });
+      }
+    }
+    return validRecordArrayList;
+  }
+
   private getInstrumentById(instrumentId: string) {
     return this.instrumentsService
       .findById(instrumentId)

apps/web/src/routes/_app/datahub/index.tsx

@@ -103,7 +103,19 @@ const RouteComponent = () => {
             return download(`${baseFilename}.json`, JSON.stringify(data, null, 2));
         }
       })
-      .catch(console.error);
+      .then(() => {
+        addNotification({
+          message: t({ en: 'Export successful', fr: 'Exportation réussie' }),
+          type: 'success'
+        });
+      })
+      .catch((err) => {
+        console.error(err);
+        addNotification({
+          message: t({ en: 'Export failed', fr: "Échec de l'exportation" }),
+          type: 'error'
+        });
+      });
   };
 
   const lookupSubject = async ({ id }: { id: string }) => {

packages/runtime-core/src/types/instrument.base.ts

@@ -1,3 +1,4 @@
+import type { RecordArrayFieldValue } from '@douglasneuroinformatics/libui-form-types';
 import type { LicenseIdentifier } from '@opendatacapture/licenses';
 import type { ConditionalKeys, Merge, SetRequired } from 'type-fest';
 import type { z as z3 } from 'zod/v3';
@@ -104,7 +105,7 @@ type UnilingualClientInstrumentDetails = ClientInstrumentDetails<Language>;
 type MultilingualClientInstrumentDetails = ClientInstrumentDetails<Language[]>;
 
 /** @public */
-type InstrumentMeasureValue = boolean | Date | number | string | undefined;
+type InstrumentMeasureValue = boolean | Date | number | RecordArrayFieldValue[] | string | undefined;
 
 /** @public */
 type InstrumentMeasureVisibility = 'hidden' | 'visible';

packages/schemas/src/instrument/instrument.base.ts

@@ -92,11 +92,14 @@ const $UnilingualInstrumentDetails = $InstrumentDetails.extend({
 
 const $InstrumentMeasureVisibility: z.ZodType<InstrumentMeasureVisibility> = z.enum(['hidden', 'visible']);
 
+const $RecordArrayFieldValue = z.union([z.string(), z.boolean(), z.number(), z.date(), z.undefined()]);
+
 const $InstrumentMeasureValue: z.ZodType<InstrumentMeasureValue> = z.union([
   z.string(),
   z.boolean(),
   z.number(),
   z.date(),
+  z.array($RecordArrayFieldValue),
   z.undefined()
 ]);
 
@@ -241,6 +244,7 @@ export {
   $InstrumentLanguage,
   $InstrumentMeasureValue,
   $InstrumentValidationSchema,
+  $RecordArrayFieldValue,
   $ScalarInstrument,
   $ScalarInstrumentBundleContainer,
   $ScalarInstrumentInternal,