@ministryofjustice/hmpps-digital-prison-reporting-frontend 4.28.8 → 4.29.0

package/dpr/utils/TemplateBuilder/SectionedDataHelper/SectionedDataHelper.js

@@ -0,0 +1,202 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var SectionedDataHelper_exports = {};
+__export(SectionedDataHelper_exports, {
+  SectionedDataHelper: () => SectionedDataHelper
+});
+module.exports = __toCommonJS(SectionedDataHelper_exports);
+var import_definitionUtils = require("../../definitionUtils");
+class SectionedDataHelper {
+  sections = [];
+  data = [];
+  fields = [];
+  summariesData = [];
+  sectionedDataArray = [];
+  sectionedData;
+  reportQuery;
+  createSectionKey(row) {
+    const keyObj = this.sections.map((col) => ({
+      name: col,
+      value: row[col] ?? ""
+    }));
+    const keyValues = keyObj.map((v) => v.value).join("");
+    const key = keyValues !== "" ? JSON.stringify(keyObj) : "mainSection";
+    return {
+      keyObj: key === "mainSection" ? [] : keyObj,
+      key
+    };
+  }
+  createSectionTitle(keyObj, fields) {
+    return keyObj.map((column) => {
+      const fieldName = (0, import_definitionUtils.getFieldDisplayName)(fields, column.name);
+      return `${fieldName}: ${column.value}`;
+    }).join(", ");
+  }
+  /**
+   * Groups the data into sections
+   *
+   * @return {*}  {SectionedData}
+   * @memberof SectionedDataBuilder
+   */
+  groupBySections(data, fields, summary) {
+    const sectionMap = data.reduce((acc, row) => {
+      const { key, keyObj } = this.createSectionKey(row);
+      const title = this.createSectionTitle(keyObj, fields);
+      if (!acc[key]) {
+        acc[key] = {
+          title,
+          count: 0,
+          key,
+          keyObj,
+          summaries: [],
+          data: []
+        };
+      }
+      const section = acc[key];
+      if (summary) {
+        const { id, template } = summary;
+        const existingSummary = section.summaries.find((s) => s.template === template);
+        if (existingSummary) {
+          existingSummary.data.push(row);
+        } else {
+          section.summaries.push({
+            id,
+            template,
+            fields,
+            data: [row]
+          });
+        }
+      } else {
+        section.data.push(row);
+        section.count += 1;
+      }
+      return acc;
+    }, {});
+    this.sectionedDataArray.push({
+      sections: Object.values(sectionMap)
+    });
+  }
+  createSummarySections() {
+    this.summariesData.forEach((summaryData) => {
+      const { fields, id, template, data } = summaryData;
+      this.groupBySections(data, fields, { id, template });
+    });
+  }
+  mergeSections() {
+    return {
+      sections: this.sectionedDataArray.flatMap((input) => input.sections).reduce((acc, section) => {
+        const { key, keyObj } = section;
+        const existing = acc.find((s) => s.key === key);
+        if (!existing) {
+          return acc.concat({
+            key: section.key || "",
+            keyObj: keyObj || [],
+            title: section.title || "",
+            count: section.count,
+            summaries: section.summaries ? [...section.summaries] : [],
+            data: section.data ? [...section.data] : []
+          });
+        }
+        const updated = acc.map(
+          (s) => s.key === key ? {
+            ...s,
+            count: s.count + section.count,
+            summaries: (s.summaries ?? []).concat(section.summaries ?? []),
+            data: (s.data ?? []).concat(section.data ?? [])
+          } : s
+        );
+        return updated;
+      }, [])
+    };
+  }
+  getSortField() {
+    const { sortColumn } = this.reportQuery;
+    return sortColumn && this.sections.includes(sortColumn) ? [sortColumn] : [];
+  }
+  /**
+   * Sorts sections based on keyObj values using an optional nameOrder override.
+   * - nameOrder can be partial; unspecified names fall back to default order
+   * - Default order is derived from the first section's keyObj sequence
+   */
+  sortSections(sectionedData) {
+    const nameOrder = this.getSortField();
+    const { sections } = sectionedData;
+    if (sections.length === 0) return sectionedData;
+    const defaultOrder = sections[0].keyObj.map((k) => k.name);
+    const finalOrder = nameOrder.filter((name) => defaultOrder.includes(name)).concat(defaultOrder.filter((name) => !nameOrder.includes(name)));
+    const buildMap = (keyObj) => keyObj.reduce((acc, ko) => ({ ...acc, [ko.name]: ko.value }), {});
+    const sortedSections = [...sections].sort((a, b) => {
+      const aMap = buildMap(a.keyObj);
+      const bMap = buildMap(b.keyObj);
+      const comparisons = finalOrder.map((name) => {
+        const aVal = aMap[name] ?? "";
+        const bVal = bMap[name] ?? "";
+        return aVal.localeCompare(bVal, void 0, { numeric: true });
+      });
+      return comparisons.find((x) => x !== 0) ?? 0;
+    });
+    return {
+      sections: sortedSections
+    };
+  }
+  withSections(sections) {
+    this.sections = sections || [];
+    return this;
+  }
+  withFields(fields) {
+    this.fields = (0, import_definitionUtils.getFieldsByName)(this.sections, fields);
+    return this;
+  }
+  withData(data) {
+    this.data = data;
+    return this;
+  }
+  withSummaries(summaryData) {
+    this.summariesData = summaryData || [];
+    return this;
+  }
+  withReportQuery(reportQuery) {
+    this.reportQuery = reportQuery;
+    return this;
+  }
+  build() {
+    let sections;
+    if (this.sections.length) {
+      this.groupBySections(this.data, this.fields);
+      this.createSummarySections();
+      sections = this.mergeSections();
+      sections = this.sortSections(sections);
+    } else {
+      const singleSection = {
+        key: "",
+        keyObj: [],
+        data: this.data,
+        count: this.data.length,
+        summaries: this.summariesData
+      };
+      sections = { sections: [singleSection] };
+    }
+    return sections;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SectionedDataHelper
+});
+//# sourceMappingURL=SectionedDataHelper.js.map

package/dpr/utils/TemplateBuilder/SectionedDataHelper/SectionedDataHelper.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../dpr/utils/TemplateBuilder/SectionedDataHelper/SectionedDataHelper.ts"],
+  "sourcesContent": ["import ReportQuery from '../../../types/ReportQuery'\nimport { SummaryTemplate } from '../../../types/Templates'\nimport { AsyncSummary } from '../../../types/UserReports'\nimport { components } from '../../../types/api'\nimport { getFieldsByName, getFieldDisplayName } from '../../definitionUtils'\nimport { SectionData, SectionedData, SectionKey } from './types'\n\nexport class SectionedDataHelper {\n  sections: Array<string> = []\n\n  data: Array<Record<string, string>> = []\n\n  fields: components['schemas']['FieldDefinition'][] = []\n\n  summariesData: AsyncSummary[] = []\n\n  sectionedDataArray: SectionedData[] = []\n\n  sectionedData!: SectionedData\n\n  reportQuery!: ReportQuery\n\n  createSectionKey(row: Record<string, string>): { keyObj: SectionKey[]; key: string } {\n    // Build structured entries with column names + values\n    const keyObj: SectionKey[] = this.sections.map((col) => ({\n      name: col,\n      value: row[col] ?? '',\n    }))\n    const keyValues = keyObj.map((v) => v.value).join('')\n    const key = keyValues !== '' ? JSON.stringify(keyObj) : 'mainSection'\n\n    return {\n      keyObj: key === 'mainSection' ? [] : keyObj,\n      key,\n    }\n  }\n\n  createSectionTitle(\n    keyObj: SectionKey[],\n    fields: components['schemas']['FieldDefinition'][] | components['schemas']['SummaryField'][],\n  ) {\n    return keyObj\n      .map((column) => {\n        const fieldName = getFieldDisplayName(fields, column.name)\n        return `${fieldName}: ${column.value}`\n      })\n      .join(', ')\n  }\n\n  /**\n   * Groups the data into sections\n   *\n   * @return {*}  {SectionedData}\n   * @memberof SectionedDataBuilder\n   */\n  groupBySections(\n    data: Array<Record<string, string>>,\n    fields: components['schemas']['FieldDefinition'][] | components['schemas']['SummaryField'][],\n    summary?: {\n      template: SummaryTemplate\n      id: string\n    },\n  ) {\n    const sectionMap = data.reduce<Record<string, SectionData>>((acc, row) => {\n      const { key, keyObj } = this.createSectionKey(row)\n      const title = this.createSectionTitle(keyObj, fields)\n\n      // Create the section if needed\n      if (!acc[key]) {\n        acc[key] = {\n          title,\n          count: 0,\n          key,\n          keyObj,\n          summaries: [],\n          data: <Array<Record<string, string>>>[],\n        }\n      }\n\n      const section = acc[key]\n\n      if (summary) {\n        const { id, template } = summary\n        const existingSummary = section.summaries.find((s) => s.template === template)\n        if (existingSummary) {\n          existingSummary.data.push(row)\n        } else {\n          section.summaries.push({\n            id,\n            template,\n            fields,\n            data: [row],\n          })\n        }\n      } else {\n        section.data.push(row)\n        section.count += 1\n      }\n\n      return acc\n    }, {})\n\n    this.sectionedDataArray.push({\n      sections: Object.values(sectionMap),\n    })\n  }\n\n  createSummarySections() {\n    this.summariesData.forEach((summaryData) => {\n      const { fields, id, template, data } = summaryData\n      this.groupBySections(<Array<Record<string, string>>>data, fields, { id, template })\n    })\n  }\n\n  mergeSections(): SectionedData {\n    return {\n      sections: this.sectionedDataArray\n        .flatMap((input) => input.sections)\n        .reduce<SectionData[]>((acc, section) => {\n          const { key, keyObj } = section\n          const existing = acc.find((s) => s.key === key)\n\n          // If section doesn't exist yet \u2192 add fresh copy\n          if (!existing) {\n            return acc.concat({\n              key: section.key || '',\n              keyObj: keyObj || [],\n              title: section.title || '',\n              count: section.count,\n              summaries: section.summaries ? [...section.summaries] : [],\n              data: section.data ? [...section.data] : [],\n            })\n          }\n\n          // If exists \u2192 update it by concatenating data & summaries\n          const updated = acc.map((s) =>\n            s.key === key\n              ? {\n                  ...s,\n                  count: s.count + section.count,\n                  summaries: (s.summaries ?? []).concat(section.summaries ?? []),\n                  data: (s.data ?? []).concat(section.data ?? []),\n                }\n              : s,\n          )\n\n          return updated\n        }, []),\n    }\n  }\n\n  getSortField() {\n    const { sortColumn } = this.reportQuery\n    return sortColumn && this.sections.includes(sortColumn) ? [sortColumn] : []\n  }\n\n  /**\n   * Sorts sections based on keyObj values using an optional nameOrder override.\n   * - nameOrder can be partial; unspecified names fall back to default order\n   * - Default order is derived from the first section's keyObj sequence\n   */\n  sortSections(sectionedData: SectionedData): SectionedData {\n    const nameOrder = this.getSortField()\n    const { sections } = sectionedData\n    if (sections.length === 0) return sectionedData\n\n    // Default order is the order of the keyObj.name fields in the first section\n    const defaultOrder = sections[0].keyObj.map((k) => k.name)\n\n    // Merge partial nameOrder with default order\n    const finalOrder = nameOrder\n      // 1. start with user-specified names\n      .filter((name) => defaultOrder.includes(name))\n      // 2. append missing names in default order\n      .concat(defaultOrder.filter((name) => !nameOrder.includes(name)))\n\n    // Build map for fast comparison\n    const buildMap = (keyObj: SectionKey[]) =>\n      keyObj.reduce<Record<string, string>>((acc, ko) => ({ ...acc, [ko.name]: ko.value }), {})\n\n    const sortedSections = [...sections].sort((a, b) => {\n      const aMap = buildMap(a.keyObj)\n      const bMap = buildMap(b.keyObj)\n\n      // Compare using final order\n      const comparisons = finalOrder.map((name) => {\n        const aVal = aMap[name] ?? ''\n        const bVal = bMap[name] ?? ''\n        return aVal.localeCompare(bVal, undefined, { numeric: true })\n      })\n\n      // Return first non-zero comparison\n      return comparisons.find((x) => x !== 0) ?? 0\n    })\n\n    return {\n      sections: sortedSections,\n    }\n  }\n\n  withSections(sections: string[]) {\n    this.sections = sections || []\n    return this\n  }\n\n  withFields(fields: components['schemas']['FieldDefinition'][]) {\n    this.fields = getFieldsByName(this.sections, fields)\n    return this\n  }\n\n  withData(data: Array<Record<string, string>>) {\n    this.data = data\n    return this\n  }\n\n  withSummaries(summaryData: Array<AsyncSummary>) {\n    this.summariesData = summaryData || []\n    return this\n  }\n\n  withReportQuery(reportQuery: ReportQuery) {\n    this.reportQuery = reportQuery\n    return this\n  }\n\n  build(): SectionedData {\n    let sections: SectionedData\n    if (this.sections.length) {\n      this.groupBySections(this.data, this.fields)\n      this.createSummarySections()\n      sections = this.mergeSections()\n      sections = this.sortSections(sections)\n    } else {\n      const singleSection: SectionData = {\n        key: '',\n        keyObj: [],\n        data: this.data,\n        count: this.data.length,\n        summaries: this.summariesData,\n      }\n      sections = { sections: [singleSection] }\n    }\n\n    return sections\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,6BAAqD;AAG9C,MAAM,oBAAoB;AAAA,EAC/B,WAA0B,CAAC;AAAA,EAE3B,OAAsC,CAAC;AAAA,EAEvC,SAAqD,CAAC;AAAA,EAEtD,gBAAgC,CAAC;AAAA,EAEjC,qBAAsC,CAAC;AAAA,EAEvC;AAAA,EAEA;AAAA,EAEA,iBAAiB,KAAoE;AAEnF,UAAM,SAAuB,KAAK,SAAS,IAAI,CAAC,SAAS;AAAA,MACvD,MAAM;AAAA,MACN,OAAO,IAAI,GAAG,KAAK;AAAA,IACrB,EAAE;AACF,UAAM,YAAY,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;AACpD,UAAM,MAAM,cAAc,KAAK,KAAK,UAAU,MAAM,IAAI;AAExD,WAAO;AAAA,MACL,QAAQ,QAAQ,gBAAgB,CAAC,IAAI;AAAA,MACrC;AAAA,IACF;AAAA,EACF;AAAA,EAEA,mBACE,QACA,QACA;AACA,WAAO,OACJ,IAAI,CAAC,WAAW;AACf,YAAM,gBAAY,4CAAoB,QAAQ,OAAO,IAAI;AACzD,aAAO,GAAG,SAAS,KAAK,OAAO,KAAK;AAAA,IACtC,CAAC,EACA,KAAK,IAAI;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,gBACE,MACA,QACA,SAIA;AACA,UAAM,aAAa,KAAK,OAAoC,CAAC,KAAK,QAAQ;AACxE,YAAM,EAAE,KAAK,OAAO,IAAI,KAAK,iBAAiB,GAAG;AACjD,YAAM,QAAQ,KAAK,mBAAmB,QAAQ,MAAM;AAGpD,UAAI,CAAC,IAAI,GAAG,GAAG;AACb,YAAI,GAAG,IAAI;AAAA,UACT;AAAA,UACA,OAAO;AAAA,UACP;AAAA,UACA;AAAA,UACA,WAAW,CAAC;AAAA,UACZ,MAAqC,CAAC;AAAA,QACxC;AAAA,MACF;AAEA,YAAM,UAAU,IAAI,GAAG;AAEvB,UAAI,SAAS;AACX,cAAM,EAAE,IAAI,SAAS,IAAI;AACzB,cAAM,kBAAkB,QAAQ,UAAU,KAAK,CAAC,MAAM,EAAE,aAAa,QAAQ;AAC7E,YAAI,iBAAiB;AACnB,0BAAgB,KAAK,KAAK,GAAG;AAAA,QAC/B,OAAO;AACL,kBAAQ,UAAU,KAAK;AAAA,YACrB;AAAA,YACA;AAAA,YACA;AAAA,YACA,MAAM,CAAC,GAAG;AAAA,UACZ,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,gBAAQ,KAAK,KAAK,GAAG;AACrB,gBAAQ,SAAS;AAAA,MACnB;AAEA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAEL,SAAK,mBAAmB,KAAK;AAAA,MAC3B,UAAU,OAAO,OAAO,UAAU;AAAA,IACpC,CAAC;AAAA,EACH;AAAA,EAEA,wBAAwB;AACtB,SAAK,cAAc,QAAQ,CAAC,gBAAgB;AAC1C,YAAM,EAAE,QAAQ,IAAI,UAAU,KAAK,IAAI;AACvC,WAAK,gBAA+C,MAAM,QAAQ,EAAE,IAAI,SAAS,CAAC;AAAA,IACpF,CAAC;AAAA,EACH;AAAA,EAEA,gBAA+B;AAC7B,WAAO;AAAA,MACL,UAAU,KAAK,mBACZ,QAAQ,CAAC,UAAU,MAAM,QAAQ,EACjC,OAAsB,CAAC,KAAK,YAAY;AACvC,cAAM,EAAE,KAAK,OAAO,IAAI;AACxB,cAAM,WAAW,IAAI,KAAK,CAAC,MAAM,EAAE,QAAQ,GAAG;AAG9C,YAAI,CAAC,UAAU;AACb,iBAAO,IAAI,OAAO;AAAA,YAChB,KAAK,QAAQ,OAAO;AAAA,YACpB,QAAQ,UAAU,CAAC;AAAA,YACnB,OAAO,QAAQ,SAAS;AAAA,YACxB,OAAO,QAAQ;AAAA,YACf,WAAW,QAAQ,YAAY,CAAC,GAAG,QAAQ,SAAS,IAAI,CAAC;AAAA,YACzD,MAAM,QAAQ,OAAO,CAAC,GAAG,QAAQ,IAAI,IAAI,CAAC;AAAA,UAC5C,CAAC;AAAA,QACH;AAGA,cAAM,UAAU,IAAI;AAAA,UAAI,CAAC,MACvB,EAAE,QAAQ,MACN;AAAA,YACE,GAAG;AAAA,YACH,OAAO,EAAE,QAAQ,QAAQ;AAAA,YACzB,YAAY,EAAE,aAAa,CAAC,GAAG,OAAO,QAAQ,aAAa,CAAC,CAAC;AAAA,YAC7D,OAAO,EAAE,QAAQ,CAAC,GAAG,OAAO,QAAQ,QAAQ,CAAC,CAAC;AAAA,UAChD,IACA;AAAA,QACN;AAEA,eAAO;AAAA,MACT,GAAG,CAAC,CAAC;AAAA,IACT;AAAA,EACF;AAAA,EAEA,eAAe;AACb,UAAM,EAAE,WAAW,IAAI,KAAK;AAC5B,WAAO,cAAc,KAAK,SAAS,SAAS,UAAU,IAAI,CAAC,UAAU,IAAI,CAAC;AAAA,EAC5E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,eAA6C;AACxD,UAAM,YAAY,KAAK,aAAa;AACpC,UAAM,EAAE,SAAS,IAAI;AACrB,QAAI,SAAS,WAAW,EAAG,QAAO;AAGlC,UAAM,eAAe,SAAS,CAAC,EAAE,OAAO,IAAI,CAAC,MAAM,EAAE,IAAI;AAGzD,UAAM,aAAa,UAEhB,OAAO,CAAC,SAAS,aAAa,SAAS,IAAI,CAAC,EAE5C,OAAO,aAAa,OAAO,CAAC,SAAS,CAAC,UAAU,SAAS,IAAI,CAAC,CAAC;AAGlE,UAAM,WAAW,CAAC,WAChB,OAAO,OAA+B,CAAC,KAAK,QAAQ,EAAE,GAAG,KAAK,CAAC,GAAG,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,CAAC;AAE1F,UAAM,iBAAiB,CAAC,GAAG,QAAQ,EAAE,KAAK,CAAC,GAAG,MAAM;AAClD,YAAM,OAAO,SAAS,EAAE,MAAM;AAC9B,YAAM,OAAO,SAAS,EAAE,MAAM;AAG9B,YAAM,cAAc,WAAW,IAAI,CAAC,SAAS;AAC3C,cAAM,OAAO,KAAK,IAAI,KAAK;AAC3B,cAAM,OAAO,KAAK,IAAI,KAAK;AAC3B,eAAO,KAAK,cAAc,MAAM,QAAW,EAAE,SAAS,KAAK,CAAC;AAAA,MAC9D,CAAC;AAGD,aAAO,YAAY,KAAK,CAAC,MAAM,MAAM,CAAC,KAAK;AAAA,IAC7C,CAAC;AAED,WAAO;AAAA,MACL,UAAU;AAAA,IACZ;AAAA,EACF;AAAA,EAEA,aAAa,UAAoB;AAC/B,SAAK,WAAW,YAAY,CAAC;AAC7B,WAAO;AAAA,EACT;AAAA,EAEA,WAAW,QAAoD;AAC7D,SAAK,aAAS,wCAAgB,KAAK,UAAU,MAAM;AACnD,WAAO;AAAA,EACT;AAAA,EAEA,SAAS,MAAqC;AAC5C,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA,EAEA,cAAc,aAAkC;AAC9C,SAAK,gBAAgB,eAAe,CAAC;AACrC,WAAO;AAAA,EACT;AAAA,EAEA,gBAAgB,aAA0B;AACxC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA,EAEA,QAAuB;AACrB,QAAI;AACJ,QAAI,KAAK,SAAS,QAAQ;AACxB,WAAK,gBAAgB,KAAK,MAAM,KAAK,MAAM;AAC3C,WAAK,sBAAsB;AAC3B,iBAAW,KAAK,cAAc;AAC9B,iBAAW,KAAK,aAAa,QAAQ;AAAA,IACvC,OAAO;AACL,YAAM,gBAA6B;AAAA,QACjC,KAAK;AAAA,QACL,QAAQ,CAAC;AAAA,QACT,MAAM,KAAK;AAAA,QACX,OAAO,KAAK,KAAK;AAAA,QACjB,WAAW,KAAK;AAAA,MAClB;AACA,iBAAW,EAAE,UAAU,CAAC,aAAa,EAAE;AAAA,IACzC;AAEA,WAAO;AAAA,EACT;AACF;",
+  "names": []
+}

package/dpr/utils/TemplateBuilder/SectionedDataHelper/SectionedDataHelper.ts

@@ -0,0 +1,246 @@
+import ReportQuery from '../../../types/ReportQuery'
+import { SummaryTemplate } from '../../../types/Templates'
+import { AsyncSummary } from '../../../types/UserReports'
+import { components } from '../../../types/api'
+import { getFieldsByName, getFieldDisplayName } from '../../definitionUtils'
+import { SectionData, SectionedData, SectionKey } from './types'
+
+export class SectionedDataHelper {
+  sections: Array<string> = []
+
+  data: Array<Record<string, string>> = []
+
+  fields: components['schemas']['FieldDefinition'][] = []
+
+  summariesData: AsyncSummary[] = []
+
+  sectionedDataArray: SectionedData[] = []
+
+  sectionedData!: SectionedData
+
+  reportQuery!: ReportQuery
+
+  createSectionKey(row: Record<string, string>): { keyObj: SectionKey[]; key: string } {
+    // Build structured entries with column names + values
+    const keyObj: SectionKey[] = this.sections.map((col) => ({
+      name: col,
+      value: row[col] ?? '',
+    }))
+    const keyValues = keyObj.map((v) => v.value).join('')
+    const key = keyValues !== '' ? JSON.stringify(keyObj) : 'mainSection'
+
+    return {
+      keyObj: key === 'mainSection' ? [] : keyObj,
+      key,
+    }
+  }
+
+  createSectionTitle(
+    keyObj: SectionKey[],
+    fields: components['schemas']['FieldDefinition'][] | components['schemas']['SummaryField'][],
+  ) {
+    return keyObj
+      .map((column) => {
+        const fieldName = getFieldDisplayName(fields, column.name)
+        return `${fieldName}: ${column.value}`
+      })
+      .join(', ')
+  }
+
+  /**
+   * Groups the data into sections
+   *
+   * @return {*}  {SectionedData}
+   * @memberof SectionedDataBuilder
+   */
+  groupBySections(
+    data: Array<Record<string, string>>,
+    fields: components['schemas']['FieldDefinition'][] | components['schemas']['SummaryField'][],
+    summary?: {
+      template: SummaryTemplate
+      id: string
+    },
+  ) {
+    const sectionMap = data.reduce<Record<string, SectionData>>((acc, row) => {
+      const { key, keyObj } = this.createSectionKey(row)
+      const title = this.createSectionTitle(keyObj, fields)
+
+      // Create the section if needed
+      if (!acc[key]) {
+        acc[key] = {
+          title,
+          count: 0,
+          key,
+          keyObj,
+          summaries: [],
+          data: <Array<Record<string, string>>>[],
+        }
+      }
+
+      const section = acc[key]
+
+      if (summary) {
+        const { id, template } = summary
+        const existingSummary = section.summaries.find((s) => s.template === template)
+        if (existingSummary) {
+          existingSummary.data.push(row)
+        } else {
+          section.summaries.push({
+            id,
+            template,
+            fields,
+            data: [row],
+          })
+        }
+      } else {
+        section.data.push(row)
+        section.count += 1
+      }
+
+      return acc
+    }, {})
+
+    this.sectionedDataArray.push({
+      sections: Object.values(sectionMap),
+    })
+  }
+
+  createSummarySections() {
+    this.summariesData.forEach((summaryData) => {
+      const { fields, id, template, data } = summaryData
+      this.groupBySections(<Array<Record<string, string>>>data, fields, { id, template })
+    })
+  }
+
+  mergeSections(): SectionedData {
+    return {
+      sections: this.sectionedDataArray
+        .flatMap((input) => input.sections)
+        .reduce<SectionData[]>((acc, section) => {
+          const { key, keyObj } = section
+          const existing = acc.find((s) => s.key === key)
+
+          // If section doesn't exist yet → add fresh copy
+          if (!existing) {
+            return acc.concat({
+              key: section.key || '',
+              keyObj: keyObj || [],
+              title: section.title || '',
+              count: section.count,
+              summaries: section.summaries ? [...section.summaries] : [],
+              data: section.data ? [...section.data] : [],
+            })
+          }
+
+          // If exists → update it by concatenating data & summaries
+          const updated = acc.map((s) =>
+            s.key === key
+              ? {
+                  ...s,
+                  count: s.count + section.count,
+                  summaries: (s.summaries ?? []).concat(section.summaries ?? []),
+                  data: (s.data ?? []).concat(section.data ?? []),
+                }
+              : s,
+          )
+
+          return updated
+        }, []),
+    }
+  }
+
+  getSortField() {
+    const { sortColumn } = this.reportQuery
+    return sortColumn && this.sections.includes(sortColumn) ? [sortColumn] : []
+  }
+
+  /**
+   * Sorts sections based on keyObj values using an optional nameOrder override.
+   * - nameOrder can be partial; unspecified names fall back to default order
+   * - Default order is derived from the first section's keyObj sequence
+   */
+  sortSections(sectionedData: SectionedData): SectionedData {
+    const nameOrder = this.getSortField()
+    const { sections } = sectionedData
+    if (sections.length === 0) return sectionedData
+
+    // Default order is the order of the keyObj.name fields in the first section
+    const defaultOrder = sections[0].keyObj.map((k) => k.name)
+
+    // Merge partial nameOrder with default order
+    const finalOrder = nameOrder
+      // 1. start with user-specified names
+      .filter((name) => defaultOrder.includes(name))
+      // 2. append missing names in default order
+      .concat(defaultOrder.filter((name) => !nameOrder.includes(name)))
+
+    // Build map for fast comparison
+    const buildMap = (keyObj: SectionKey[]) =>
+      keyObj.reduce<Record<string, string>>((acc, ko) => ({ ...acc, [ko.name]: ko.value }), {})
+
+    const sortedSections = [...sections].sort((a, b) => {
+      const aMap = buildMap(a.keyObj)
+      const bMap = buildMap(b.keyObj)
+
+      // Compare using final order
+      const comparisons = finalOrder.map((name) => {
+        const aVal = aMap[name] ?? ''
+        const bVal = bMap[name] ?? ''
+        return aVal.localeCompare(bVal, undefined, { numeric: true })
+      })
+
+      // Return first non-zero comparison
+      return comparisons.find((x) => x !== 0) ?? 0
+    })
+
+    return {
+      sections: sortedSections,
+    }
+  }
+
+  withSections(sections: string[]) {
+    this.sections = sections || []
+    return this
+  }
+
+  withFields(fields: components['schemas']['FieldDefinition'][]) {
+    this.fields = getFieldsByName(this.sections, fields)
+    return this
+  }
+
+  withData(data: Array<Record<string, string>>) {
+    this.data = data
+    return this
+  }
+
+  withSummaries(summaryData: Array<AsyncSummary>) {
+    this.summariesData = summaryData || []
+    return this
+  }
+
+  withReportQuery(reportQuery: ReportQuery) {
+    this.reportQuery = reportQuery
+    return this
+  }
+
+  build(): SectionedData {
+    let sections: SectionedData
+    if (this.sections.length) {
+      this.groupBySections(this.data, this.fields)
+      this.createSummarySections()
+      sections = this.mergeSections()
+      sections = this.sortSections(sections)
+    } else {
+      const singleSection: SectionData = {
+        key: '',
+        keyObj: [],
+        data: this.data,
+        count: this.data.length,
+        summaries: this.summariesData,
+      }
+      sections = { sections: [singleSection] }
+    }
+
+    return sections
+  }
+}

package/dpr/utils/TemplateBuilder/SectionedDataHelper/types.js

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);
+//# sourceMappingURL=types.js.map

package/dpr/utils/TemplateBuilder/SectionedDataHelper/types.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../dpr/utils/TemplateBuilder/SectionedDataHelper/types.ts"],
+  "sourcesContent": ["import { AsyncSummary } from '../../../types/UserReports'\nimport { SummaryTemplate } from '../../../types/Templates'\nimport { ListSectionTableData } from '../ReportBuilder/types'\nimport { ParentChildTableData } from '../ParentChildDataBuilder/types'\nimport { DataTable } from '../../DataTableBuilder/types'\n\nexport interface SectionedData {\n  sections: SectionData[]\n}\n\nexport interface ReportTemplateData {\n  rowCount: number\n  summaries?: Record<string, DataTable[]>\n  sections: SectionDataResult[]\n}\n\nexport interface SectionSummary {\n  template: SummaryTemplate\n  data: ListSectionTableData // TODO: fix this\n}\n\nexport interface SectionKey {\n  name: string\n  value: string\n}\n\nexport interface SectionData {\n  key?: string\n  keyObj: SectionKey[]\n  title?: string\n  count: number\n  summaries: AsyncSummary[]\n  data: Array<Record<string, string>>\n}\n\nexport interface SectionDataResult {\n  title?: string\n  count: number\n  summaries: Record<string, DataTable[]>\n  data: Array<Record<string, string>> | ParentChildTableData[] | ListSectionTableData\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;AAAA;AAAA;",
+  "names": []
+}

package/dpr/utils/TemplateBuilder/SectionedDataHelper/types.ts

@@ -0,0 +1,41 @@
+import { AsyncSummary } from '../../../types/UserReports'
+import { SummaryTemplate } from '../../../types/Templates'
+import { ListSectionTableData } from '../ReportBuilder/types'
+import { ParentChildTableData } from '../ParentChildDataBuilder/types'
+import { DataTable } from '../../DataTableBuilder/types'
+
+export interface SectionedData {
+  sections: SectionData[]
+}
+
+export interface ReportTemplateData {
+  rowCount: number
+  summaries?: Record<string, DataTable[]>
+  sections: SectionDataResult[]
+}
+
+export interface SectionSummary {
+  template: SummaryTemplate
+  data: ListSectionTableData // TODO: fix this
+}
+
+export interface SectionKey {
+  name: string
+  value: string
+}
+
+export interface SectionData {
+  key?: string
+  keyObj: SectionKey[]
+  title?: string
+  count: number
+  summaries: AsyncSummary[]
+  data: Array<Record<string, string>>
+}
+
+export interface SectionDataResult {
+  title?: string
+  count: number
+  summaries: Record<string, DataTable[]>
+  data: Array<Record<string, string>> | ParentChildTableData[] | ListSectionTableData
+}

package/dpr/utils/{CollatedSummaryBuilder/CollatedSummaryBuilder.js → TemplateBuilder/SummaryDataHelper/SummaryDataHelper.js}

@@ -26,13 +26,12 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var CollatedSummaryBuilder_exports = {};
-__export(CollatedSummaryBuilder_exports, {
-  CollatedSummaryBuilder: () => CollatedSummaryBuilder,
-  default: () => CollatedSummaryBuilder_default
+var SummaryDataHelper_exports = {};
+__export(SummaryDataHelper_exports, {
+  CollatedSummaryBuilder: () => CollatedSummaryBuilder
 });
-module.exports = __toCommonJS(CollatedSummaryBuilder_exports);
-var import_SummaryDataTableBuilder = __toESM(require("../SummaryDataTableBuilder/SummaryDataTableBuilder"));
+module.exports = __toCommonJS(SummaryDataHelper_exports);
+var import_SummaryDataTableBuilder = __toESM(require("../../SummaryDataTableBuilder/SummaryDataTableBuilder"));
 class CollatedSummaryBuilder {
   summaries;
   specification;
@@ -84,9 +83,8 @@ class CollatedSummaryBuilder {
     return dataTables;
   }
 }
-var CollatedSummaryBuilder_default = CollatedSummaryBuilder;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CollatedSummaryBuilder
 });
-//# sourceMappingURL=CollatedSummaryBuilder.js.map
+//# sourceMappingURL=SummaryDataHelper.js.map

package/dpr/utils/TemplateBuilder/SummaryDataHelper/SummaryDataHelper.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../dpr/utils/TemplateBuilder/SummaryDataHelper/SummaryDataHelper.ts"],
+  "sourcesContent": ["import Dict = NodeJS.Dict\nimport { AsyncSummary } from '../../../types/UserReports'\nimport { SummaryTemplate } from '../../../types/Templates'\nimport { components } from '../../../types/api'\nimport { DataTable } from '../../DataTableBuilder/types'\nimport SummaryDataTableBuilder from '../../SummaryDataTableBuilder/SummaryDataTableBuilder'\n\nexport class CollatedSummaryBuilder {\n  private summaries: Array<AsyncSummary>\n\n  private specification: components['schemas']['Specification']\n\n  constructor(specification: components['schemas']['Specification'], summaries: Array<AsyncSummary>) {\n    this.specification = specification\n    this.summaries = summaries\n  }\n\n  pageSummaryTemplates: Array<SummaryTemplate> = ['page-header', 'page-footer']\n\n  dataTableSummaryTemplates: Array<SummaryTemplate> = [\n    'section-footer',\n    'section-header',\n    'table-footer',\n    'table-header',\n  ]\n\n  collatePageSummaries(): Dict<Array<DataTable>> {\n    return this.collateAndMapToDataTable(this.pageSummaryTemplates)\n  }\n\n  collateDataTableSummaries(): Dict<Array<AsyncSummary>> {\n    return this.collate(this.dataTableSummaryTemplates)\n  }\n\n  collateAndMapToDataTable(summaryTemplates: Array<SummaryTemplate> = []): Dict<Array<DataTable>> {\n    const collatedSummaries = this.collate(summaryTemplates)\n\n    return this.mapToDataTables(collatedSummaries)\n  }\n\n  collate(summaryTemplates: Array<SummaryTemplate> = this.pageSummaryTemplates): Dict<Array<AsyncSummary>> {\n    const collatedSummaries: Dict<Array<AsyncSummary>> = {}\n    if (this.summaries) {\n      this.summaries.forEach((summary: AsyncSummary) => {\n        const { template } = summary\n        if (summaryTemplates.includes(template)) {\n          if (!collatedSummaries[template]) {\n            collatedSummaries[template] = []\n          }\n          collatedSummaries[template].push(summary)\n        }\n      })\n    }\n\n    return collatedSummaries\n  }\n\n  private mapToDataTables(summaries: Dict<Array<AsyncSummary>>): Dict<Array<DataTable>> {\n    const dataTables: Dict<Array<DataTable>> = {}\n\n    Object.keys(summaries).forEach((summaryType) => {\n      if (summaries[summaryType]) {\n        dataTables[summaryType] = summaries[summaryType].map((summary) => {\n          return new SummaryDataTableBuilder(summary, this.specification.sections).buildSummaryTable()\n        })\n      }\n    })\n\n    return dataTables\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,qCAAoC;AAE7B,MAAM,uBAAuB;AAAA,EAC1B;AAAA,EAEA;AAAA,EAER,YAAY,eAAuD,WAAgC;AACjG,SAAK,gBAAgB;AACrB,SAAK,YAAY;AAAA,EACnB;AAAA,EAEA,uBAA+C,CAAC,eAAe,aAAa;AAAA,EAE5E,4BAAoD;AAAA,IAClD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA,EAEA,uBAA+C;AAC7C,WAAO,KAAK,yBAAyB,KAAK,oBAAoB;AAAA,EAChE;AAAA,EAEA,4BAAuD;AACrD,WAAO,KAAK,QAAQ,KAAK,yBAAyB;AAAA,EACpD;AAAA,EAEA,yBAAyB,mBAA2C,CAAC,GAA2B;AAC9F,UAAM,oBAAoB,KAAK,QAAQ,gBAAgB;AAEvD,WAAO,KAAK,gBAAgB,iBAAiB;AAAA,EAC/C;AAAA,EAEA,QAAQ,mBAA2C,KAAK,sBAAiD;AACvG,UAAM,oBAA+C,CAAC;AACtD,QAAI,KAAK,WAAW;AAClB,WAAK,UAAU,QAAQ,CAAC,YAA0B;AAChD,cAAM,EAAE,SAAS,IAAI;AACrB,YAAI,iBAAiB,SAAS,QAAQ,GAAG;AACvC,cAAI,CAAC,kBAAkB,QAAQ,GAAG;AAChC,8BAAkB,QAAQ,IAAI,CAAC;AAAA,UACjC;AACA,4BAAkB,QAAQ,EAAE,KAAK,OAAO;AAAA,QAC1C;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AAAA,EAEQ,gBAAgB,WAA8D;AACpF,UAAM,aAAqC,CAAC;AAE5C,WAAO,KAAK,SAAS,EAAE,QAAQ,CAAC,gBAAgB;AAC9C,UAAI,UAAU,WAAW,GAAG;AAC1B,mBAAW,WAAW,IAAI,UAAU,WAAW,EAAE,IAAI,CAAC,YAAY;AAChE,iBAAO,IAAI,+BAAAA,QAAwB,SAAS,KAAK,cAAc,QAAQ,EAAE,kBAAkB;AAAA,QAC7F,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AACF;",
+  "names": ["SummaryDataTableBuilder"]
+}

package/dpr/utils/{CollatedSummaryBuilder/CollatedSummaryBuilder.test.ts → TemplateBuilder/SummaryDataHelper/SummaryDataHelper.test.ts}

@@ -1,8 +1,8 @@
 import { expect } from '@jest/globals'
-import { components } from '../../types/api'
-import CollatedSummaryBuilder from './CollatedSummaryBuilder'
-import { AsyncSummary } from '../../types/UserReports'
-import { DataTable } from '../DataTableBuilder/types'
+import { components } from '../../../types/api'
+import { CollatedSummaryBuilder } from './SummaryDataHelper'
+import { AsyncSummary } from '../../../types/UserReports'
+import { DataTable } from '../../DataTableBuilder/types'
 
 const activityField: components['schemas']['FieldDefinition'] = {
   header: false,

package/dpr/utils/{CollatedSummaryBuilder/CollatedSummaryBuilder.ts → TemplateBuilder/SummaryDataHelper/SummaryDataHelper.ts}

@@ -1,11 +1,11 @@
 import Dict = NodeJS.Dict
-import { AsyncSummary } from '../../types/UserReports'
-import { SummaryTemplate } from '../../types/Templates'
-import { components } from '../../types/api'
-import { DataTable } from '../DataTableBuilder/types'
-import SummaryDataTableBuilder from '../SummaryDataTableBuilder/SummaryDataTableBuilder'
+import { AsyncSummary } from '../../../types/UserReports'
+import { SummaryTemplate } from '../../../types/Templates'
+import { components } from '../../../types/api'
+import { DataTable } from '../../DataTableBuilder/types'
+import SummaryDataTableBuilder from '../../SummaryDataTableBuilder/SummaryDataTableBuilder'
 
-class CollatedSummaryBuilder {
+export class CollatedSummaryBuilder {
   private summaries: Array<AsyncSummary>
 
   private specification: components['schemas']['Specification']
@@ -69,6 +69,3 @@ class CollatedSummaryBuilder {
     return dataTables
   }
 }
-
-export { CollatedSummaryBuilder }
-export default CollatedSummaryBuilder