@openfn/language-varo 1.0.2 → 1.1.0

package/dist/index.js

@@ -9,6 +9,8 @@ var Adaptor_exports = {};
 __export(Adaptor_exports, {
   alterState: () => alterState,
   combine: () => combine,
+  convertItemsToReports: () => convertItemsToReports,
+  convertReportsToMessageContents: () => convertReportsToMessageContents,
   convertToEms: () => convertToEms,
   cursor: () => cursor,
   dataPath: () => dataPath,
@@ -29,21 +31,258 @@ import { expandReferences } from "@openfn/language-common/util";
 // src/Utils.js
 function parseMetadata(message) {
   var _a;
-  if (!((_a = message.metadata) == null ? void 0 : _a.content)) {
+  const content = (_a = message.metadata) == null ? void 0 : _a.content;
+  if (!content) {
     console.error("No metadata supplied.");
     return null;
   }
   try {
-    return JSON.parse(message.metadata.content);
+    return JSON.parse(content);
   } catch (error) {
     console.error("Invalid metadata JSON.", error);
     return null;
   }
 }
+function removeNullProps(obj) {
+  for (const key in obj) {
+    if (obj[key] == null) {
+      delete obj[key];
+    }
+  }
+  return obj;
+}
+function deepEqual(a, b) {
+  if (a === b)
+    return true;
+  if (typeof a !== "object" || typeof b !== "object" || a === null || b === null)
+    return false;
+  const aKeys = Object.keys(a);
+  const bKeys = Object.keys(b);
+  if (aKeys.length !== bKeys.length)
+    return false;
+  for (const key of aKeys) {
+    if (!bKeys.includes(key) || !deepEqual(a[key], b[key]))
+      return false;
+  }
+  return true;
+}
+function formatDeviceInfo(data) {
+  function formatType(label, mfr, mod, ser) {
+    let output2 = "";
+    if (mfr || mod || ser) {
+      output2 += `${label}
+`;
+      if (mfr) {
+        output2 += `  Manufacturer: ${mfr}
+`;
+      }
+      if (mod) {
+        output2 += `  Model: ${mod}
+`;
+      }
+      if (ser) {
+        output2 += `  Serial Number: ${ser}
+`;
+      }
+      output2 += "\n";
+    }
+    return output2;
+  }
+  let output = "";
+  output += formatType("Appliance", data.AMFR, data.AMOD, data.ASER);
+  output += formatType("Logger", data.LMFR, data.LMOD, data.LSER);
+  output += formatType("EMD", data.EMFR, data.EMOD, data.ESER);
+  return output || "No valid data found";
+}
+
+// src/StreamingUtils.js
+function parseRtmdCollectionToReports(collection) {
+  if (!Array.isArray(collection) || collection.length === 0) {
+    console.error("No records to process for report.");
+    return null;
+  }
+  return groupDifferencesAndMergeRecords(collection, "ESER", "ABST");
+}
+function parseFlatRecordsToReports(collection, reqReport, reqRecord) {
+  if (!Array.isArray(collection) || collection.length === 0) {
+    console.error("No records to process for report.");
+    return null;
+  }
+  const reports = [];
+  const groups = groupByProperty(collection, "LSER");
+  for (const key in groups) {
+    const records = groups[key];
+    const reportRecord = records[0];
+    const report = mapProperties(reportRecord, records, reqReport, reqRecord);
+    promoteDeviceProperties(report, "E");
+    reports.push(report);
+  }
+  return reports;
+}
+function groupDifferencesAndMergeRecords(collection, reportsGroupKey, recordsGroupKey) {
+  const groups = groupByProperty(collection, reportsGroupKey);
+  const reports = [];
+  for (const key in groups) {
+    const rawReports = groups[key];
+    const report = { ...rawReports[0] };
+    removeNullProps(report);
+    const allRecords = rawReports.flatMap((r) => r.records || []);
+    const mergedRecords = mergeRecords(allRecords, recordsGroupKey);
+    const allProps = getAllProps(rawReports, [reportsGroupKey, "records"]);
+    const differingProps = getDifferingProps(rawReports, allProps);
+    const differences = buildDifferences(rawReports, report, differingProps);
+    report["records"] = mergedRecords;
+    report["zDifferences"] = differences;
+    promoteDeviceProperties(report, "L");
+    reports.push(report);
+  }
+  return reports;
+}
+function groupByProperty(collection, property) {
+  return collection.reduce((acc, item) => {
+    const key = item[property];
+    if (!acc[key]) {
+      acc[key] = [];
+    }
+    acc[key].push(item);
+    return acc;
+  }, {});
+}
+function mergeRecords(records, groupKey) {
+  const grouped = groupByProperty(records, groupKey);
+  const merged = [];
+  for (const key in grouped) {
+    const group = grouped[key];
+    const mergedRecord = {};
+    let tvcAlrm = null;
+    let tambAlrm = null;
+    for (const record of group) {
+      Object.assign(mergedRecord, record);
+      const alrm = record["ALRM"];
+      if (alrm != null) {
+        if ("TVC" in record)
+          tvcAlrm = alrm;
+        if ("TAMB" in record)
+          tambAlrm = alrm;
+      }
+    }
+    if (tambAlrm != null) {
+      mergedRecord["zTambAlrm"] = tambAlrm;
+      mergedRecord["ALRM"] = tambAlrm;
+    }
+    if (tvcAlrm != null) {
+      mergedRecord["zTvcAlrm"] = tvcAlrm;
+      mergedRecord["ALRM"] = tvcAlrm;
+    }
+    removeNullProps(mergedRecord);
+    merged.push(mergedRecord);
+  }
+  return merged;
+}
+function getAllProps(collection, excludedProps = []) {
+  const props = /* @__PURE__ */ new Set();
+  for (const item of collection) {
+    for (const prop in item) {
+      if (excludedProps.includes(prop))
+        continue;
+      if (item[prop] === null)
+        continue;
+      props.add(prop);
+    }
+  }
+  return Array.from(props);
+}
+function getDifferingProps(records, props) {
+  const differing = [];
+  for (const prop of props) {
+    const firstValue = records[0][prop];
+    const isDifferent = records.some((r) => !deepEqual(r[prop], firstValue));
+    if (isDifferent) {
+      differing.push(prop);
+    }
+  }
+  return differing;
+}
+function buildDifferences(records, base, differingProps) {
+  const uniqueSet = /* @__PURE__ */ new Set();
+  return records.map((record) => {
+    const diff = {};
+    for (const prop of differingProps) {
+      if (!deepEqual(record[prop], base[prop])) {
+        diff[prop] = record[prop];
+      }
+    }
+    const sortedDiff = Object.keys(diff).sort().reduce((acc, key2) => {
+      acc[key2] = diff[key2];
+      return acc;
+    }, {});
+    const key = JSON.stringify(sortedDiff);
+    if (Object.keys(diff).length > 0 && !uniqueSet.has(key)) {
+      uniqueSet.add(key);
+      return sortedDiff;
+    }
+    return null;
+  }).filter(Boolean);
+}
+var defs = {
+  report: "ACAT,ADOP,AID,AMFR,AMID,AMOD,APQS,ASER,CDAT,CDAT2,CID,CNAM,CNAM2,CSER,CSER2,CSOF,CSOF2,DLST,DNAM,EDOP,EID,EMFR,EMOD,EMSV,EPQS,ESER,FID,FNAM,LACC,LAT,LDOP,LID,LMFR,LMOD,LNG,LPQS,LSER,LSV,RNAM,SIGN".split(","),
+  record: "ABST,ACCD,ACSV,ALRM,BEMD,BLOG,CMPR,CMPR2,CMPS,CMPS2,CSOF,CSOF2,DCCD,DCSV,DORF,DORV,DRCF,DRCV,EERR,FANS,HAMB,HCOM,HOLD,IDRF,IDRV,LERR,MSW,SVA,TAMB,TCON,TCON2,TFRZ,TPCB,TPCB2,TVC".split(",")
+};
+function mapProperties(report, records, reqReport, reqRecord) {
+  function resolveReqKeys(option, defaults) {
+    if (option === true)
+      return defaults;
+    if (typeof option === "string" && option.trim()) {
+      return option.split(",").map((k) => k.trim());
+    }
+    return [];
+  }
+  function extract(source, keys, reqKeys) {
+    const result = {};
+    for (const key of keys) {
+      if (key in source && source[key] !== null) {
+        result[key] = source[key];
+      } else if (reqKeys.includes(key)) {
+        result[key] = null;
+      }
+    }
+    return result;
+  }
+  if (!report)
+    return null;
+  const reqReportKeys = resolveReqKeys(reqReport, defs.report);
+  const reqRecordKeys = resolveReqKeys(reqRecord, defs.record);
+  const reportKeys = [.../* @__PURE__ */ new Set([...defs.report, ...reqReportKeys])];
+  const recordKeys = [.../* @__PURE__ */ new Set([...defs.record, ...reqRecordKeys])];
+  const reportResult = extract(report, reportKeys, reqReportKeys);
+  const recordResults = (records == null ? void 0 : records.map((record) => extract(record, recordKeys, reqRecordKeys)).filter((record) => Object.keys(record).length > 0)) ?? [];
+  return {
+    ...reportResult,
+    records: recordResults
+  };
+}
+function promoteDeviceProperties(source, destination) {
+  const keyPairs = [
+    ["LID", "EID"],
+    ["LMFR", "EMFR"],
+    ["LMOD", "EMOD"],
+    ["LSER", "ESER"],
+    ["LDOP", "EDOP"],
+    ["LSV", "EMSV"],
+    ["LPQS", "EPQS"]
+  ];
+  for (const [lKey, eKey] of keyPairs) {
+    const [fromKey, toKey] = destination === "E" ? [lKey, eKey] : [eKey, lKey];
+    if (source[toKey] != null)
+      continue;
+    if (source[fromKey] != null)
+      source[toKey] = source[fromKey];
+  }
+}
 
 // src/VaroEmsUtils.js
-function parseVaroEmsToEms(metadata, data, dataPath2) {
-  const result = {
+function parseVaroEmsToReport(metadata, data, dataPath2) {
+  const report = {
     CID: null,
     LAT: metadata.location.used.latitude,
     LNG: metadata.location.used.longitude,
@@ -86,9 +325,9 @@ function parseVaroEmsToEms(metadata, data, dataPath2) {
       TAMB: item.TAMB,
       TVC: item.TVC
     };
-    result.records.push(record);
+    report.records.push(record);
   }
-  return result;
+  return report;
 }
 function parseRelativeDateFromUsbPluggedInfo(path) {
   const regex = /_CURRENT_DATA_(?<duration>\w+?)_(?<date>\w+?)\.json$/;
@@ -150,42 +389,44 @@ function parseIsoToAbbreviatedIso(iso) {
 }
 
 // src/FridgeTagUtils.js
-function parseFridgeTagToEms(metadata, nodes) {
-  const result = {
-    records: [],
-    reports: []
-  };
-  applyMetadataToResult();
-  applyNodesToResult();
-  function applyMetadataToResult() {
+function parseFridgeTagToReport(metadata, nodes) {
+  const report = {};
+  const records = [];
+  const zReports = [];
+  applyMetadataToReport();
+  applyNodesToReport();
+  report.records = records;
+  report.zReports = zReports;
+  return report;
+  function applyMetadataToReport() {
     var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
-    applyPropertyToResult("AMFR", (_a = metadata == null ? void 0 : metadata.refrigerator) == null ? void 0 : _a.manufacturer);
-    applyPropertyToResult("AMOD", (_b = metadata == null ? void 0 : metadata.refrigerator) == null ? void 0 : _b.model);
-    applyPropertyToResult("LMFR", (_c = metadata == null ? void 0 : metadata.refrigerator) == null ? void 0 : _c.deviceManufacturer);
-    applyPropertyToResult("CID", (_d = metadata == null ? void 0 : metadata.facility) == null ? void 0 : _d.country);
-    applyPropertyToResult("LAT", (_f = (_e = metadata == null ? void 0 : metadata.location) == null ? void 0 : _e.used) == null ? void 0 : _f.latitude);
-    applyPropertyToResult("LNG", (_h = (_g = metadata == null ? void 0 : metadata.location) == null ? void 0 : _g.used) == null ? void 0 : _h.longitude);
-    applyPropertyToResult("LACC", (_j = (_i = metadata == null ? void 0 : metadata.location) == null ? void 0 : _i.used) == null ? void 0 : _j.accuracy);
+    applyPropertyToReport("AMFR", (_a = metadata == null ? void 0 : metadata.refrigerator) == null ? void 0 : _a.manufacturer);
+    applyPropertyToReport("AMOD", (_b = metadata == null ? void 0 : metadata.refrigerator) == null ? void 0 : _b.model);
+    applyPropertyToReport("LMFR", (_c = metadata == null ? void 0 : metadata.refrigerator) == null ? void 0 : _c.deviceManufacturer);
+    applyPropertyToReport("CID", (_d = metadata == null ? void 0 : metadata.facility) == null ? void 0 : _d.country);
+    applyPropertyToReport("LAT", (_f = (_e = metadata == null ? void 0 : metadata.location) == null ? void 0 : _e.used) == null ? void 0 : _f.latitude);
+    applyPropertyToReport("LNG", (_h = (_g = metadata == null ? void 0 : metadata.location) == null ? void 0 : _g.used) == null ? void 0 : _h.longitude);
+    applyPropertyToReport("LACC", (_j = (_i = metadata == null ? void 0 : metadata.location) == null ? void 0 : _i.used) == null ? void 0 : _j.accuracy);
   }
-  function applyNodesToResult() {
+  function applyNodesToReport() {
     var _a, _b, _c;
-    applyPropertyToResult("LMOD", nodes["Device"]);
-    applyPropertyToResult("LSER", (_a = nodes["Conf"]) == null ? void 0 : _a["Serial"]);
-    applyPropertyToResult("LSV", nodes["Fw Vers"]);
+    applyPropertyToReport("LMOD", nodes["Device"]);
+    applyPropertyToReport("LSER", (_a = nodes["Conf"]) == null ? void 0 : _a["Serial"]);
+    applyPropertyToReport("LSV", nodes["Fw Vers"]);
     let productionDate = (_b = nodes["Conf"]) == null ? void 0 : _b["Test TS"];
     productionDate = productionDate ? new Date(productionDate) : null;
-    applyPropertyToResult("LDOP", productionDate);
+    applyPropertyToReport("LDOP", productionDate);
     let dayIndex = 1;
     let dayNode;
     while ((dayNode = (_c = nodes["Hist"]) == null ? void 0 : _c[dayIndex++]) !== void 0) {
       applyDayToRecords(dayNode);
-      applyDayToReports(dayNode);
+      applyDayToZReports(dayNode);
     }
   }
-  function applyPropertyToResult(property, text) {
+  function applyPropertyToReport(property, text) {
     if (!text)
       return;
-    result[property] = text;
+    report[property] = text;
   }
   function applyDayToRecords(dayNode) {
     applyNodeToRecords(dayNode, "TS Min T", "Min T", "0", "FRZE");
@@ -200,11 +441,11 @@ function parseFridgeTagToEms(metadata, nodes) {
         (_a = dayNode2["Alarm"]) == null ? void 0 : _a[alarmField],
         alarmDescription
       );
-      result.records.push({
+      records.push({
         ABST: dateTime,
         TVC: temp,
         ALRM: alarm,
-        description: date + " " + tempField
+        zdescription: date + " " + tempField
       });
       function parseAlarm(alarmNode, description) {
         if (alarmNode["t Acc"] === "0")
@@ -213,17 +454,17 @@ function parseFridgeTagToEms(metadata, nodes) {
       }
     }
   }
-  function applyDayToReports(dayNode) {
-    const report = {
+  function applyDayToZReports(dayNode) {
+    const report2 = {
       date: new Date(dayNode["Date"]),
       duration: "1D",
       alarms: [],
       aggregates: []
     };
-    applyAlarmsToReport(dayNode);
-    applyAggregatesToReport(dayNode);
-    result.reports.push(report);
-    function applyAlarmsToReport(dayNode2) {
+    applyAlarmsToZReport(dayNode);
+    applyAggregatesToZReport(dayNode);
+    zReports.push(report2);
+    function applyAlarmsToZReport(dayNode2) {
       var _a, _b;
       const date = dayNode2["Date"];
       applyAlarmToAlarms((_a = dayNode2["Alarm"]) == null ? void 0 : _a["0"], "FRZE");
@@ -246,13 +487,13 @@ function parseFridgeTagToEms(metadata, nodes) {
         if (count) {
           alarm.count = count;
         }
-        report.alarms.push(alarm);
+        report2.alarms.push(alarm);
       }
     }
-    function applyAggregatesToReport(dayNode2) {
+    function applyAggregatesToZReport(dayNode2) {
       applyTvcToAggregates(dayNode2);
       function applyTvcToAggregates(dayNode3) {
-        report.aggregates.push({
+        report2.aggregates.push({
           id: "TVC",
           min: parseFloat(dayNode3["Min T"]),
           max: parseFloat(dayNode3["Max T"]),
@@ -261,7 +502,6 @@ function parseFridgeTagToEms(metadata, nodes) {
       }
     }
   }
-  return result;
 }
 function parseFridgeTag(text) {
   const result = {};
@@ -320,7 +560,7 @@ function convertToEms(messageContents) {
   return async (state) => {
     var _a, _b;
     const [resolvedMessageContents] = expandReferences(state, messageContents);
-    const results = [];
+    const reports = [];
     console.log("Incoming message contents", resolvedMessageContents.length);
     for (const content of resolvedMessageContents) {
       if ((_a = content.fridgeTag) == null ? void 0 : _a.content) {
@@ -328,8 +568,8 @@ function convertToEms(messageContents) {
         if (!metadata)
           continue;
         const fridgeTagNodes = parseFridgeTag(content.fridgeTag.content);
-        const result = parseFridgeTagToEms(metadata, fridgeTagNodes);
-        results.push(result);
+        const result = parseFridgeTagToReport(metadata, fridgeTagNodes);
+        reports.push(result);
         continue;
       }
       if ((_b = content.data) == null ? void 0 : _b.content) {
@@ -338,16 +578,60 @@ function convertToEms(messageContents) {
           continue;
         const data = JSON.parse(content.data.content);
         const dataPath2 = content.data.filename;
-        const result = parseVaroEmsToEms(metadata, data, dataPath2);
-        results.push(result);
+        const result = parseVaroEmsToReport(metadata, data, dataPath2);
+        reports.push(result);
         continue;
       }
       console.error(
         `Insufficient content found for MessageID: ${content.messageId}`
       );
     }
-    console.log("Converted message contents", results.length);
-    return { ...composeNextState(state, results) };
+    console.log("Converted message contents", reports.length);
+    return { ...composeNextState(state, reports) };
+  };
+}
+function convertItemsToReports(items, reportType = "unknown") {
+  return async (state) => {
+    const [resolvedRecords, resolvedReportType] = expandReferences(
+      state,
+      items,
+      reportType
+    );
+    const reportParsers = {
+      ems: parseFlatRecordsToReports,
+      rtmd: parseRtmdCollectionToReports
+    };
+    const parser = reportParsers[resolvedReportType];
+    if (!parser) {
+      throw new Error(`Report type not supported: ${resolvedReportType}`);
+    }
+    const reports = parser(resolvedRecords);
+    return { ...composeNextState(state, reports) };
+  };
+}
+function convertReportsToMessageContents(reports, reportType = "unknown") {
+  return async (state) => {
+    const [resolvedReports, resolvedReportType] = expandReferences(
+      state,
+      reports,
+      reportType
+    );
+    const messageContents = [];
+    for (const report of resolvedReports) {
+      report["zReportType"] = resolvedReportType;
+      report["zGeneratedTimestamp"] = new Date().toISOString();
+      const serialNumber = report["ESER"] || report["LSER"] || report["ASER"];
+      const messageContent = {
+        subject: `OpenFn | ${resolvedReportType.toUpperCase()} | ${serialNumber}`,
+        body: formatDeviceInfo(report),
+        data: {
+          filename: "data.json",
+          content: JSON.stringify(report, null, 4)
+        }
+      };
+      messageContents.push(messageContent);
+    }
+    return { ...composeNextState(state, messageContents) };
   };
 }
 
@@ -356,6 +640,8 @@ var src_default = Adaptor_exports;
 export {
   alterState,
   combine,
+  convertItemsToReports,
+  convertReportsToMessageContents,
   convertToEms,
   cursor,
   dataPath,

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@openfn/language-varo",
-  "version": "1.0.2",
+  "label": "Varo",
+  "version": "1.1.0",
   "description": "OpenFn varo adaptor",
   "type": "module",
   "exports": {
@@ -20,13 +21,12 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "2.3.3"
+    "@openfn/language-common": "2.4.0"
   },
   "devDependencies": {
     "assertion-error": "2.0.0",
     "chai": "4.3.6",
     "deep-eql": "4.1.1",
-    "esno": "^0.16.3",
     "rimraf": "3.0.2",
     "undici": "^5.22.1"
   },

package/types/Adaptor.d.ts

@@ -16,4 +16,45 @@
  * );
  */
 export function convertToEms(messageContents: any[]): Operation;
+/**
+ * Read a collection of EMS-like data records and convert them to a standard EMS report/record format.
+ * Systematically separates report properties from record properties.
+ * @public
+ * @function
+ * @param {Array} items - Array of EMS-like JSON objects.
+ * @param {string} [reportType='unknown'] - Optional. Source of the report, e.g., "ems" or "rtmd".
+ * @state {Array} data - The converted, EMS-compliant report with records.
+ * @returns {Operation}
+ * @example <caption>Convert data to EMS-compliant data.</caption>
+ * convertItemsToReport(
+ *   [
+ *     { "ASER": "BJBC 08 30", "ABST": "20241205T004440Z", "TVC": 5.0 },
+ *     { "ASER": "BJBC 08 30", "ABST": "20241205T005440Z", "TVC": 5.2 },
+ *   ]
+ * );
+ *
+ * state.data becomes:
+ * {
+ *   "ASER": "BJBC 08 30",
+ *   records: [
+ *     { "ABST": "20241205T004440Z", "TVC": 5.0 },
+ *     { "ABST": "20241205T005440Z", "TVC": 5.2 },
+ *   ],
+ * }
+ */
+export function convertItemsToReports(items: any[], reportType?: string): Operation;
+/**
+ * Converts an EMS-compliant report into Varo-compatible message components.
+ *
+ * @public
+ * @function
+ * @param {Object} reports - EMS-compliant report objects.
+ * @param {string} [reportType='unknown'] - Optional. Source of the report, e.g., "ems" or "rtmd".
+ * @returns {Function} An operation function that receives `state` and returns updated message content.
+ *
+ * @example
+ * // Convert EMS-compliant reports to Varo message components.
+ * convertReportsToMessageContents(emsReports, "ems");
+ */
+export function convertReportsToMessageContents(reports: any, reportType?: string): Function;
 export { alterState, combine, cursor, dataPath, dataValue, each, field, fields, fn, fnIf, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";

package/types/FridgeTagUtils.d.ts

@@ -1,5 +1,5 @@
-export function parseFridgeTagToEms(metadata: any, nodes: any): {
+export function parseFridgeTagToReport(metadata: any, nodes: any): {
     records: any[];
-    reports: any[];
+    zReports: any[];
 };
 export function parseFridgeTag(text: any): {};

package/types/StreamingUtils.d.ts

@@ -0,0 +1,4 @@
+export function parseRtmdCollectionToReports(collection: any): any[];
+export function parseFlatRecordsToReports(collection: any, reqReport: any, reqRecord: any): {
+    records: any;
+}[];

package/types/Utils.d.ts

@@ -1 +1,4 @@
 export function parseMetadata(message: any): any;
+export function removeNullProps(obj: any): any;
+export function deepEqual(a: any, b: any): boolean;
+export function formatDeviceInfo(data: any): string;

package/types/VaroEmsUtils.d.ts

@@ -1,4 +1,4 @@
-export function parseVaroEmsToEms(metadata: any, data: any, dataPath: any): {
+export function parseVaroEmsToReport(metadata: any, data: any, dataPath: any): {
     CID: any;
     LAT: any;
     LNG: any;