@ministryofjustice/hmpps-digital-prison-reporting-frontend 5.2.3 → 5.2.4

package/README.md

@@ -21,12 +21,35 @@ Both tasks use the `package` directory.
 
 ## Test Application
 
-To start the Test Application, run: `npm run start-test-app`. This builds the NPM package and starts the server at http://localhost:3010.
+To start the Test Application, run: `npm run start:dev:noMockClients` as well as `npm run wiremock` in a separate tab. This builds the NPM package and starts the server at http://localhost:3010.
 
 The Test Application is used both for visually checking components, and also by the integration tests (run using Cypress).
 
-## Running and testing local builds
-To run the app in dev mode, use `start:dev` for the test app, and `docs:local` for the docs. To run the production build of docs, you should run `npm run docs`, then you'll need to configure a reverse proxy - nginx is the easiest. Install it through homebrew `brew install nginx`, then ensure it's running by running `brew services start nginx`. then run `sudo nginx -t` and you should see it's got a default config at `/opt/homebrew/etc/nginx/nginx.conf` - if it isn't there, just use whatever path it gives back, then add a new file into `/opt/homebrew/etc/nginx/servers/dev.conf` with this content:
+## Running and testing local builds
+To run the main suite of browser-based tests, start up the main app by running `npm run start:dev:noMockClients` then `npm run int-test` or `npm run int-test-ui` for getting the cypress UI up to choose individual tests to run.
+
+There are also a few jest tests - you can run these plus the small docs tests by running `npm run test`.
+
+We also have a small number of visual regression tests using Playwright that are **only** for our chart based pages - you can run these with `npm run int-test-visual` which will start up the server and mocks itself. Please ensure any other running server processes are stopped before running this!
+
+### How to update and create new visual regression tests
+There may ocassionally be the need to create new visual regression tests, again, only for our charting based pages. To do this, you should develop the test as normal, but use `npm run int-test-visual-ui` which will allow you to see what the test is doing in the UI. Once you have the test on the page you want to capture a screenshot of for comparison, use
+
+```typescript
+await expect(page).toHaveScreenshot({
+    fullPage: true,
+  })
+```
+
+and then run your test. It will fail locally on this last step, which is expected, as you are not creating screenshots. These will be created by CI as screenshots on different OSes can have slightly different pixel values. You should push this branch and make a PR, which will set off the CI run, and if all is well, create the screenshots as an artifact of the CI run in GitHub Actions (but fail the run). You should create a folder based on the name of the file running the test - if the file is called `some-chart-test.spec.ts`, create a folder called `some-chart-test.spec.ts-screenshots/` and download the screenshots artifact and put the new screenshots in there. You should then double check these to ensure no sensitive data is being captured, then commit and push them up. This time, the CI run should use these screenshots and pass. If they do not, some common pitfalls include:
+
+- Animations: Ideally set or disable animations so the snapshot isn't capturing charts, CSS animations etc half way through loading.
+- Noise: Things like "Last Updated" timestamps can be very annoying and will break the test every time the clock ticks. You should mask those bits out so Playwright ignores them.
+- As a last resort, look at having some **small** pixel tolerances - no more than 1 or 2% - on the `toHaveScreenshot` call - use `maxDiffPixelRatio` which has a range from 0-1, so no more than 0.01-0.02 here.
+
+### Running the app in dev mode
+
+To run the app in dev mode, use `start:dev:noMockClients` for the test app, and `docs:local` for the docs. To run the production build of docs, you should run `npm run docs`, then you'll need to configure a reverse proxy - nginx is the easiest. Install it through homebrew `brew install nginx`, then ensure it's running by running `brew services start nginx`. then run `sudo nginx -t` and you should see it's got a default config at `/opt/homebrew/etc/nginx/nginx.conf` - if it isn't there, just use whatever path it gives back, then add a new file into `/opt/homebrew/etc/nginx/servers/dev.conf` with this content:
 
 ```
 server {

package/_networkMocks/dashboard/definitions/visualisations/complete-dataset/list/definition-invalid-vis-defs.d.ts

@@ -0,0 +1,2 @@
+import { components } from '../../../../../../src/dpr/types/api';
+export declare const definition: components['schemas']['DashboardDefinition'];

package/_networkMocks/dashboard/definitions/visualisations/complete-dataset/list/definition-invalid.d.ts

@@ -0,0 +1,2 @@
+import { components } from '../../../../../../src/dpr/types/api';
+export declare const definition: components['schemas']['DashboardDefinition'];

package/_networkMocks/dashboard/definitions/visualisations/complete-dataset/list/vis-definitions/invalid.d.ts

@@ -0,0 +1,2 @@
+import { components } from '../../../../../../../src/dpr/types/api';
+export declare const invalidDefinition: components['schemas']['DashboardVisualisationDefinition'];

package/_networkMocks/dashboard/definitions/visualisations/mocks.d.ts

@@ -66,6 +66,40 @@ export declare const listPartialDatasetHistoricMock: {
         fixedDelayMilliseconds: number;
     };
 };
+export declare const listInvalidVisDefMock: {
+    priority: number;
+    request: {
+        method: "GET" | "POST" | "DELETE" | "PUT" | "OPTIONS";
+        queryParameters?: object | undefined;
+        bodyPatterns?: Array<object> | undefined;
+        urlPathPattern: string;
+    };
+    response: {
+        status: number;
+        headers: {
+            "Content-Type": "application/json;charset=UTF-8";
+        };
+        jsonBody: object;
+        fixedDelayMilliseconds: number;
+    };
+};
+export declare const listInvalidDefMock: {
+    priority: number;
+    request: {
+        method: "GET" | "POST" | "DELETE" | "PUT" | "OPTIONS";
+        queryParameters?: object | undefined;
+        bodyPatterns?: Array<object> | undefined;
+        urlPathPattern: string;
+    };
+    response: {
+        status: number;
+        headers: {
+            "Content-Type": "application/json;charset=UTF-8";
+        };
+        jsonBody: object;
+        fixedDelayMilliseconds: number;
+    };
+};
 export declare const scorecardsCompleteDatasetMock: {
     priority: number;
     request: {

package/_networkMocks/report/mocks.d.ts

@@ -99,6 +99,21 @@ export declare const getAsyncReportDownloadMock: {
         body: string;
     };
 };
+export declare const getSyncReportDownloadMock: {
+    priority: number;
+    request: {
+        method: string;
+        urlPathPattern: string;
+    };
+    response: {
+        status: number;
+        headers: {
+            'Content-Type': string;
+            'Content-Disposition': string;
+        };
+        body: string;
+    };
+};
 export declare const reportsFinishedStatusMock: {
     priority: number;
     request: {

package/cjs/dpr/components/_dashboards/dashboard-list/utils.js

@@ -3,8 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var datasetHelper = require('../../../utils/datasetHelper.js');
+var validate = require('./validate.js');
 
 const createList = (listDefinition, dashboardData) => {
+    validate.ListSchema.parse(listDefinition);
     const { columns, options } = listDefinition;
     const listOptions = options;
     const showLatest = listOptions?.showLatest !== undefined ? listOptions.showLatest : true;

package/cjs/dpr/components/_dashboards/dashboard-list/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sources":["../../../../../../../../../../../src/dpr/components/_dashboards/dashboard-list/utils.ts"],"sourcesContent":["/* eslint-disable no-param-reassign */\nimport { DashboardDataResponse } from '../../../types/Metrics'\nimport {\n  ListDashboardVisualisationOptions,\n  MoJTable,\n  MoJTableHead,\n  MoJTableRow,\n} from '../dashboard-visualisation/types'\nimport DatasetHelper from '../../../utils/datasetHelper'\nimport { components } from '../../../types/api'\n\nexport const createList = (\n  listDefinition: components['schemas']['DashboardVisualisationDefinition'],\n  dashboardData: DashboardDataResponse[],\n): { table: MoJTable; ts: string } => {\n  const { columns, options } = listDefinition\n  const listOptions = <ListDashboardVisualisationOptions>options\n  const showLatest = listOptions?.showLatest !== undefined ? listOptions.showLatest : true\n  const columnsAsList = listOptions?.columnsAsList\n  const { measures, keys } = columns\n  const showAllData = (!measures && !keys) || (!measures.length && !keys)\n\n  let datasetData: DashboardDataResponse[] = [...dashboardData]\n  if (showLatest) {\n    datasetData = DatasetHelper.getLastestDataset(datasetData)\n  }\n\n  let head\n  let rows\n  let ts\n\n  if (showAllData) {\n    ;({ head, rows, ts } = createFullList(datasetData))\n  } else if (columnsAsList) {\n    ;({ head, rows, ts } = createListFromColumns(listDefinition, datasetData))\n  } else {\n    ;({ head, rows, ts } = creatListFromRows(listDefinition, datasetData))\n  }\n\n  if (rows.length && measures) rows = sumColumns(rows, measures)\n\n  return {\n    table: {\n      head,\n      rows,\n    },\n    ts,\n  }\n}\n\nconst createListFromColumns = (\n  listDefinition: components['schemas']['DashboardVisualisationDefinition'],\n  dashboardData: DashboardDataResponse[],\n) => {\n  const { columns } = listDefinition\n  const { keys, measures } = columns\n  const groupKey = DatasetHelper.getGroupKey(dashboardData, keys || [])\n\n  const timestampData = dashboardData[0]?.['ts']?.raw\n  const ts = timestampData ? `${timestampData}` : ''\n\n  const head: MoJTableHead[] = []\n  head.push({ text: '' })\n  dashboardData.forEach((row) => {\n    head.push({\n      text: groupKey ? `${row[groupKey.id].raw}` : '',\n    })\n  })\n\n  const rows: MoJTableRow[][] = []\n  measures.forEach((measure) => {\n    rows.push([{ text: measure.display }] as MoJTableRow[])\n  })\n\n  measures.forEach((measure, index) => {\n    dashboardData.forEach((row) => {\n      rows[index].push({ text: `${row[measure.id].raw}` })\n    })\n  })\n\n  return {\n    rows,\n    head,\n    ts,\n  }\n}\n\nexport const createTableRows = (\n  data: DashboardDataResponse[],\n  measures?: components['schemas']['DashboardVisualisationColumnDefinition'][],\n): MoJTableRow[][] => {\n  return data.map((dataRow) => {\n    const row: MoJTableRow[] = measures?.length ? Array(measures.length) : Array(Object.keys(data[0]).length)\n    Object.keys(dataRow).forEach((key, index) => {\n      const headIndex = measures?.length ? measures.findIndex((m) => m.id === key) : index\n      const text = dataRow[key].raw\n      row.splice(headIndex, 1, { text } as MoJTableRow)\n    })\n\n    return row\n  })\n}\n\nconst creatListFromRows = (\n  listDefinition: components['schemas']['DashboardVisualisationDefinition'],\n  dashboardData: DashboardDataResponse[],\n) => {\n  const { measures } = listDefinition.columns\n\n  const head: MoJTableHead[] = measures.map((column) => {\n    return { text: column.display || '' }\n  })\n\n  const dataSetRows = DatasetHelper.getDatasetRows(listDefinition, dashboardData)\n  const displayRows = DatasetHelper.filterRowsByDisplayColumns(listDefinition, dataSetRows)\n  const rows = createTableRows(displayRows, measures)\n\n  const timestampData = dataSetRows[0]?.['ts']?.raw\n  const ts = timestampData ? `${timestampData}` : ''\n\n  return {\n    head,\n    rows,\n    ts,\n  }\n}\n\nconst createFullList = (dashboardData: DashboardDataResponse[]) => {\n  const head: MoJTableHead[] = Object.keys(dashboardData[0]).map((key) => {\n    return { text: key || '' }\n  })\n  const rows = createTableRows(dashboardData)\n\n  const latestData = DatasetHelper.getLastestDataset(dashboardData)\n  const timestampData = latestData[0]?.['ts']?.raw\n  const ts = timestampData ? `${timestampData}` : ''\n\n  return {\n    head,\n    rows,\n    ts,\n  }\n}\n\nconst sumColumns = (\n  rowsData: MoJTableRow[][],\n  measures: components['schemas']['DashboardVisualisationColumnDefinition'][],\n) => {\n  const sumColumnIndexes: number[] = measures.flatMap((col, idx) => (col.aggregate ? [idx] : []))\n\n  if (sumColumnIndexes.length) {\n    const sumRow: MoJTableRow[] = [{ html: `<strong>Total<strong>` }]\n    for (let index = 1; index < measures.length; index += 1) {\n      sumRow[index] = { text: '' }\n    }\n\n    rowsData.push(sumRow)\n    sumColumnIndexes.forEach((index) => {\n      const total = rowsData.reduce((acc, row) => {\n        const rowIndex = row[index]\n        if (rowIndex && rowIndex.text) {\n          acc += Number(rowIndex.text)\n        }\n        return acc\n      }, 0)\n      rowsData[rowsData.length - 1][index] = {\n        html: `<strong>${total}<strong>`,\n      }\n    })\n  }\n\n  return rowsData\n}\n\nexport default {\n  createList,\n  createTableRows,\n}\n"],"names":["DatasetHelper"],"mappings":";;;;;;MAWa,UAAU,GAAG,CACxB,cAAyE,EACzE,aAAsC,KACH;AACnC,IAAA,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc;IAC3C,MAAM,WAAW,GAAsC,OAAO;AAC9D,IAAA,MAAM,UAAU,GAAG,WAAW,EAAE,UAAU,KAAK,SAAS,GAAG,WAAW,CAAC,UAAU,GAAG,IAAI;AACxF,IAAA,MAAM,aAAa,GAAG,WAAW,EAAE,aAAa;AAChD,IAAA,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO;AAClC,IAAA,MAAM,WAAW,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC;AAEvE,IAAA,IAAI,WAAW,GAA4B,CAAC,GAAG,aAAa,CAAC;IAC7D,IAAI,UAAU,EAAE;AACd,QAAA,WAAW,GAAGA,qBAAa,CAAC,iBAAiB,CAAC,WAAW,CAAC;IAC5D;AAEA,IAAA,IAAI,IAAI;AACR,IAAA,IAAI,IAAI;AACR,IAAA,IAAI,EAAE;IAEN,IAAI,WAAW,EAAE;AACd,QAAA,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,cAAc,CAAC,WAAW,CAAC;IACpD;SAAO,IAAI,aAAa,EAAE;AACvB,QAAA,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,qBAAqB,CAAC,cAAc,EAAE,WAAW,CAAC;IAC3E;SAAO;AACJ,QAAA,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,iBAAiB,CAAC,cAAc,EAAE,WAAW,CAAC;IACvE;AAEA,IAAA,IAAI,IAAI,CAAC,MAAM,IAAI,QAAQ;AAAE,QAAA,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC;IAE9D,OAAO;AACL,QAAA,KAAK,EAAE;YACL,IAAI;YACJ,IAAI;AACL,SAAA;QACD,EAAE;KACH;AACH;AAEA,MAAM,qBAAqB,GAAG,CAC5B,cAAyE,EACzE,aAAsC,KACpC;AACF,IAAA,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc;AAClC,IAAA,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO;AAClC,IAAA,MAAM,QAAQ,GAAGA,qBAAa,CAAC,WAAW,CAAC,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC;AAErE,IAAA,MAAM,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG;AACnD,IAAA,MAAM,EAAE,GAAG,aAAa,GAAG,CAAA,EAAG,aAAa,CAAA,CAAE,GAAG,EAAE;IAElD,MAAM,IAAI,GAAmB,EAAE;IAC/B,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AACvB,IAAA,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,KAAI;QAC5B,IAAI,CAAC,IAAI,CAAC;AACR,YAAA,IAAI,EAAE,QAAQ,GAAG,CAAA,EAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE;AAChD,SAAA,CAAC;AACJ,IAAA,CAAC,CAAC;IAEF,MAAM,IAAI,GAAoB,EAAE;AAChC,IAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,KAAI;AAC3B,QAAA,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,CAAkB,CAAC;AACzD,IAAA,CAAC,CAAC;IAEF,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;AAClC,QAAA,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,KAAI;YAC5B,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA,EAAG,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAA,CAAE,EAAE,CAAC;AACtD,QAAA,CAAC,CAAC;AACJ,IAAA,CAAC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,EAAE;KACH;AACH,CAAC;MAEY,eAAe,GAAG,CAC7B,IAA6B,EAC7B,QAA4E,KACzD;AACnB,IAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,KAAI;AAC1B,QAAA,MAAM,GAAG,GAAkB,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACzG,QAAA,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,KAAI;YAC1C,MAAM,SAAS,GAAG,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,GAAG,KAAK;YACpF,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG;YAC7B,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,IAAI,EAAiB,CAAC;AACnD,QAAA,CAAC,CAAC;AAEF,QAAA,OAAO,GAAG;AACZ,IAAA,CAAC,CAAC;AACJ;AAEA,MAAM,iBAAiB,GAAG,CACxB,cAAyE,EACzE,aAAsC,KACpC;AACF,IAAA,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC,OAAO;IAE3C,MAAM,IAAI,GAAmB,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,KAAI;QACnD,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE;AACvC,IAAA,CAAC,CAAC;IAEF,MAAM,WAAW,GAAGA,qBAAa,CAAC,cAAc,CAAC,cAAc,EAAE,aAAa,CAAC;IAC/E,MAAM,WAAW,GAAGA,qBAAa,CAAC,0BAA0B,CAAC,cAAc,EAAE,WAAW,CAAC;IACzF,MAAM,IAAI,GAAG,eAAe,CAAC,WAAW,EAAE,QAAQ,CAAC;AAEnD,IAAA,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG;AACjD,IAAA,MAAM,EAAE,GAAG,aAAa,GAAG,CAAA,EAAG,aAAa,CAAA,CAAE,GAAG,EAAE;IAElD,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,EAAE;KACH;AACH,CAAC;AAED,MAAM,cAAc,GAAG,CAAC,aAAsC,KAAI;AAChE,IAAA,MAAM,IAAI,GAAmB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAI;AACrE,QAAA,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;AAC5B,IAAA,CAAC,CAAC;AACF,IAAA,MAAM,IAAI,GAAG,eAAe,CAAC,aAAa,CAAC;IAE3C,MAAM,UAAU,GAAGA,qBAAa,CAAC,iBAAiB,CAAC,aAAa,CAAC;AACjE,IAAA,MAAM,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG;AAChD,IAAA,MAAM,EAAE,GAAG,aAAa,GAAG,CAAA,EAAG,aAAa,CAAA,CAAE,GAAG,EAAE;IAElD,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,EAAE;KACH;AACH,CAAC;AAED,MAAM,UAAU,GAAG,CACjB,QAAyB,EACzB,QAA2E,KACzE;AACF,IAAA,MAAM,gBAAgB,GAAa,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,GAAG,CAAC,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;AAE/F,IAAA,IAAI,gBAAgB,CAAC,MAAM,EAAE;QAC3B,MAAM,MAAM,GAAkB,CAAC,EAAE,IAAI,EAAE,CAAA,qBAAA,CAAuB,EAAE,CAAC;AACjE,QAAA,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE;YACvD,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE;QAC9B;AAEA,QAAA,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;AACrB,QAAA,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,KAAI;YACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAI;AACzC,gBAAA,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC;AAC3B,gBAAA,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE;AAC7B,oBAAA,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC9B;AACA,gBAAA,OAAO,GAAG;YACZ,CAAC,EAAE,CAAC,CAAC;YACL,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG;gBACrC,IAAI,EAAE,CAAA,QAAA,EAAW,KAAK,CAAA,QAAA,CAAU;aACjC;AACH,QAAA,CAAC,CAAC;IACJ;AAEA,IAAA,OAAO,QAAQ;AACjB,CAAC;AAED,yBAAe;IACb,UAAU;IACV,eAAe;CAChB;;;;;;"}
+{"version":3,"file":"utils.js","sources":["../../../../../../../../../../../src/dpr/components/_dashboards/dashboard-list/utils.ts"],"sourcesContent":["/* eslint-disable no-param-reassign */\nimport { DashboardDataResponse } from '../../../types/Metrics'\nimport {\n  ListDashboardVisualisationOptions,\n  MoJTable,\n  MoJTableHead,\n  MoJTableRow,\n} from '../dashboard-visualisation/types'\nimport DatasetHelper from '../../../utils/datasetHelper'\nimport { components } from '../../../types/api'\nimport ListVisSchemas from './validate'\n\nexport const createList = (\n  listDefinition: components['schemas']['DashboardVisualisationDefinition'],\n  dashboardData: DashboardDataResponse[],\n): { table: MoJTable; ts: string } => {\n  ListVisSchemas.ListSchema.parse(listDefinition)\n  const { columns, options } = listDefinition\n  const listOptions = <ListDashboardVisualisationOptions>options\n  const showLatest = listOptions?.showLatest !== undefined ? listOptions.showLatest : true\n  const columnsAsList = listOptions?.columnsAsList\n  const { measures, keys } = columns\n  const showAllData = (!measures && !keys) || (!measures.length && !keys)\n\n  let datasetData: DashboardDataResponse[] = [...dashboardData]\n  if (showLatest) {\n    datasetData = DatasetHelper.getLastestDataset(datasetData)\n  }\n\n  let head\n  let rows\n  let ts\n\n  if (showAllData) {\n    ;({ head, rows, ts } = createFullList(datasetData))\n  } else if (columnsAsList) {\n    ;({ head, rows, ts } = createListFromColumns(listDefinition, datasetData))\n  } else {\n    ;({ head, rows, ts } = creatListFromRows(listDefinition, datasetData))\n  }\n\n  if (rows.length && measures) rows = sumColumns(rows, measures)\n\n  return {\n    table: {\n      head,\n      rows,\n    },\n    ts,\n  }\n}\n\nconst createListFromColumns = (\n  listDefinition: components['schemas']['DashboardVisualisationDefinition'],\n  dashboardData: DashboardDataResponse[],\n) => {\n  const { columns } = listDefinition\n  const { keys, measures } = columns\n  const groupKey = DatasetHelper.getGroupKey(dashboardData, keys || [])\n\n  const timestampData = dashboardData[0]?.['ts']?.raw\n  const ts = timestampData ? `${timestampData}` : ''\n\n  const head: MoJTableHead[] = []\n  head.push({ text: '' })\n  dashboardData.forEach((row) => {\n    head.push({\n      text: groupKey ? `${row[groupKey.id].raw}` : '',\n    })\n  })\n\n  const rows: MoJTableRow[][] = []\n  measures.forEach((measure) => {\n    rows.push([{ text: measure.display }] as MoJTableRow[])\n  })\n\n  measures.forEach((measure, index) => {\n    dashboardData.forEach((row) => {\n      rows[index].push({ text: `${row[measure.id].raw}` })\n    })\n  })\n\n  return {\n    rows,\n    head,\n    ts,\n  }\n}\n\nexport const createTableRows = (\n  data: DashboardDataResponse[],\n  measures?: components['schemas']['DashboardVisualisationColumnDefinition'][],\n): MoJTableRow[][] => {\n  return data.map((dataRow) => {\n    const row: MoJTableRow[] = measures?.length ? Array(measures.length) : Array(Object.keys(data[0]).length)\n    Object.keys(dataRow).forEach((key, index) => {\n      const headIndex = measures?.length ? measures.findIndex((m) => m.id === key) : index\n      const text = dataRow[key].raw\n      row.splice(headIndex, 1, { text } as MoJTableRow)\n    })\n\n    return row\n  })\n}\n\nconst creatListFromRows = (\n  listDefinition: components['schemas']['DashboardVisualisationDefinition'],\n  dashboardData: DashboardDataResponse[],\n) => {\n  const { measures } = listDefinition.columns\n\n  const head: MoJTableHead[] = measures.map((column) => {\n    return { text: column.display || '' }\n  })\n\n  const dataSetRows = DatasetHelper.getDatasetRows(listDefinition, dashboardData)\n  const displayRows = DatasetHelper.filterRowsByDisplayColumns(listDefinition, dataSetRows)\n  const rows = createTableRows(displayRows, measures)\n\n  const timestampData = dataSetRows[0]?.['ts']?.raw\n  const ts = timestampData ? `${timestampData}` : ''\n\n  return {\n    head,\n    rows,\n    ts,\n  }\n}\n\nconst createFullList = (dashboardData: DashboardDataResponse[]) => {\n  const head: MoJTableHead[] = Object.keys(dashboardData[0]).map((key) => {\n    return { text: key || '' }\n  })\n  const rows = createTableRows(dashboardData)\n\n  const latestData = DatasetHelper.getLastestDataset(dashboardData)\n  const timestampData = latestData[0]?.['ts']?.raw\n  const ts = timestampData ? `${timestampData}` : ''\n\n  return {\n    head,\n    rows,\n    ts,\n  }\n}\n\nconst sumColumns = (\n  rowsData: MoJTableRow[][],\n  measures: components['schemas']['DashboardVisualisationColumnDefinition'][],\n) => {\n  const sumColumnIndexes: number[] = measures.flatMap((col, idx) => (col.aggregate ? [idx] : []))\n\n  if (sumColumnIndexes.length) {\n    const sumRow: MoJTableRow[] = [{ html: `<strong>Total<strong>` }]\n    for (let index = 1; index < measures.length; index += 1) {\n      sumRow[index] = { text: '' }\n    }\n\n    rowsData.push(sumRow)\n    sumColumnIndexes.forEach((index) => {\n      const total = rowsData.reduce((acc, row) => {\n        const rowIndex = row[index]\n        if (rowIndex && rowIndex.text) {\n          acc += Number(rowIndex.text)\n        }\n        return acc\n      }, 0)\n      rowsData[rowsData.length - 1][index] = {\n        html: `<strong>${total}<strong>`,\n      }\n    })\n  }\n\n  return rowsData\n}\n\nexport default {\n  createList,\n  createTableRows,\n}\n"],"names":["ListVisSchemas","DatasetHelper"],"mappings":";;;;;;;MAYa,UAAU,GAAG,CACxB,cAAyE,EACzE,aAAsC,KACH;AACnC,IAAAA,QAAc,CAAC,UAAU,CAAC,KAAK,CAAC,cAAc,CAAC;AAC/C,IAAA,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc;IAC3C,MAAM,WAAW,GAAsC,OAAO;AAC9D,IAAA,MAAM,UAAU,GAAG,WAAW,EAAE,UAAU,KAAK,SAAS,GAAG,WAAW,CAAC,UAAU,GAAG,IAAI;AACxF,IAAA,MAAM,aAAa,GAAG,WAAW,EAAE,aAAa;AAChD,IAAA,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO;AAClC,IAAA,MAAM,WAAW,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC;AAEvE,IAAA,IAAI,WAAW,GAA4B,CAAC,GAAG,aAAa,CAAC;IAC7D,IAAI,UAAU,EAAE;AACd,QAAA,WAAW,GAAGC,qBAAa,CAAC,iBAAiB,CAAC,WAAW,CAAC;IAC5D;AAEA,IAAA,IAAI,IAAI;AACR,IAAA,IAAI,IAAI;AACR,IAAA,IAAI,EAAE;IAEN,IAAI,WAAW,EAAE;AACd,QAAA,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,cAAc,CAAC,WAAW,CAAC;IACpD;SAAO,IAAI,aAAa,EAAE;AACvB,QAAA,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,qBAAqB,CAAC,cAAc,EAAE,WAAW,CAAC;IAC3E;SAAO;AACJ,QAAA,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,iBAAiB,CAAC,cAAc,EAAE,WAAW,CAAC;IACvE;AAEA,IAAA,IAAI,IAAI,CAAC,MAAM,IAAI,QAAQ;AAAE,QAAA,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC;IAE9D,OAAO;AACL,QAAA,KAAK,EAAE;YACL,IAAI;YACJ,IAAI;AACL,SAAA;QACD,EAAE;KACH;AACH;AAEA,MAAM,qBAAqB,GAAG,CAC5B,cAAyE,EACzE,aAAsC,KACpC;AACF,IAAA,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc;AAClC,IAAA,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO;AAClC,IAAA,MAAM,QAAQ,GAAGA,qBAAa,CAAC,WAAW,CAAC,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC;AAErE,IAAA,MAAM,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG;AACnD,IAAA,MAAM,EAAE,GAAG,aAAa,GAAG,CAAA,EAAG,aAAa,CAAA,CAAE,GAAG,EAAE;IAElD,MAAM,IAAI,GAAmB,EAAE;IAC/B,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AACvB,IAAA,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,KAAI;QAC5B,IAAI,CAAC,IAAI,CAAC;AACR,YAAA,IAAI,EAAE,QAAQ,GAAG,CAAA,EAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE;AAChD,SAAA,CAAC;AACJ,IAAA,CAAC,CAAC;IAEF,MAAM,IAAI,GAAoB,EAAE;AAChC,IAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,KAAI;AAC3B,QAAA,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,CAAkB,CAAC;AACzD,IAAA,CAAC,CAAC;IAEF,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;AAClC,QAAA,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,KAAI;YAC5B,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA,EAAG,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAA,CAAE,EAAE,CAAC;AACtD,QAAA,CAAC,CAAC;AACJ,IAAA,CAAC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,EAAE;KACH;AACH,CAAC;MAEY,eAAe,GAAG,CAC7B,IAA6B,EAC7B,QAA4E,KACzD;AACnB,IAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,KAAI;AAC1B,QAAA,MAAM,GAAG,GAAkB,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACzG,QAAA,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,KAAI;YAC1C,MAAM,SAAS,GAAG,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,GAAG,KAAK;YACpF,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG;YAC7B,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,IAAI,EAAiB,CAAC;AACnD,QAAA,CAAC,CAAC;AAEF,QAAA,OAAO,GAAG;AACZ,IAAA,CAAC,CAAC;AACJ;AAEA,MAAM,iBAAiB,GAAG,CACxB,cAAyE,EACzE,aAAsC,KACpC;AACF,IAAA,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC,OAAO;IAE3C,MAAM,IAAI,GAAmB,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,KAAI;QACnD,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE;AACvC,IAAA,CAAC,CAAC;IAEF,MAAM,WAAW,GAAGA,qBAAa,CAAC,cAAc,CAAC,cAAc,EAAE,aAAa,CAAC;IAC/E,MAAM,WAAW,GAAGA,qBAAa,CAAC,0BAA0B,CAAC,cAAc,EAAE,WAAW,CAAC;IACzF,MAAM,IAAI,GAAG,eAAe,CAAC,WAAW,EAAE,QAAQ,CAAC;AAEnD,IAAA,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG;AACjD,IAAA,MAAM,EAAE,GAAG,aAAa,GAAG,CAAA,EAAG,aAAa,CAAA,CAAE,GAAG,EAAE;IAElD,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,EAAE;KACH;AACH,CAAC;AAED,MAAM,cAAc,GAAG,CAAC,aAAsC,KAAI;AAChE,IAAA,MAAM,IAAI,GAAmB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAI;AACrE,QAAA,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;AAC5B,IAAA,CAAC,CAAC;AACF,IAAA,MAAM,IAAI,GAAG,eAAe,CAAC,aAAa,CAAC;IAE3C,MAAM,UAAU,GAAGA,qBAAa,CAAC,iBAAiB,CAAC,aAAa,CAAC;AACjE,IAAA,MAAM,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG;AAChD,IAAA,MAAM,EAAE,GAAG,aAAa,GAAG,CAAA,EAAG,aAAa,CAAA,CAAE,GAAG,EAAE;IAElD,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,EAAE;KACH;AACH,CAAC;AAED,MAAM,UAAU,GAAG,CACjB,QAAyB,EACzB,QAA2E,KACzE;AACF,IAAA,MAAM,gBAAgB,GAAa,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,GAAG,CAAC,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;AAE/F,IAAA,IAAI,gBAAgB,CAAC,MAAM,EAAE;QAC3B,MAAM,MAAM,GAAkB,CAAC,EAAE,IAAI,EAAE,CAAA,qBAAA,CAAuB,EAAE,CAAC;AACjE,QAAA,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE;YACvD,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE;QAC9B;AAEA,QAAA,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;AACrB,QAAA,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,KAAI;YACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAI;AACzC,gBAAA,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC;AAC3B,gBAAA,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE;AAC7B,oBAAA,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC9B;AACA,gBAAA,OAAO,GAAG;YACZ,CAAC,EAAE,CAAC,CAAC;YACL,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG;gBACrC,IAAI,EAAE,CAAA,QAAA,EAAW,KAAK,CAAA,QAAA,CAAU;aACjC;AACH,QAAA,CAAC,CAAC;IACJ;AAEA,IAAA,OAAO,QAAQ;AACjB,CAAC;AAED,yBAAe;IACb,UAAU;IACV,eAAe;CAChB;;;;;;"}

package/cjs/dpr/components/_dashboards/dashboard-list/validate.js

@@ -0,0 +1,23 @@
+'use strict';
+
+var z = require('zod');
+var Validate = require('../dashboard-visualisation/Validate.js');
+
+const ListOptions = z.z.object({
+    showLatest: z.z.boolean().default(true),
+    columnsAsList: z.z.boolean().optional(),
+});
+const ListSchema = z.z.object({
+    ...Validate.DashboardVisualisationSchema.shape,
+    type: z.z.literal('list'),
+    options: z.z.object(ListOptions.shape).optional(),
+    columns: z.z.object({
+        ...Validate.DashboardColumns.shape,
+        measures: z.z.array(Validate.DashboardVisualisationMeasureSchema),
+    }),
+});
+const ListSchemas = {
+    ListSchema};
+
+module.exports = ListSchemas;
+//# sourceMappingURL=validate.js.map

package/cjs/dpr/components/_dashboards/dashboard-list/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sources":["../../../../../../../../../../../src/dpr/components/_dashboards/dashboard-list/validate.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  DashboardVisualisationSchema,\n  DashboardColumns,\n  DashboardVisualisationMeasureSchema,\n} from '../dashboard-visualisation/Validate'\n\nconst ListOptions = z.object({\n  showLatest: z.boolean().default(true),\n  columnsAsList: z.boolean().optional(),\n})\n\nconst ListSchema = z.object({\n  ...DashboardVisualisationSchema.shape,\n  type: z.literal('list'),\n  options: z.object(ListOptions.shape).optional(),\n  columns: z.object({\n    ...DashboardColumns.shape,\n    measures: z.array(DashboardVisualisationMeasureSchema),\n  }),\n})\n\nconst ListSchemas = {\n  ListSchema,\n  ListOptions,\n}\n\nexport default ListSchemas\n"],"names":["z","DashboardVisualisationSchema","DashboardColumns","DashboardVisualisationMeasureSchema"],"mappings":";;;;;AAOA,MAAM,WAAW,GAAGA,GAAC,CAAC,MAAM,CAAC;IAC3B,UAAU,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;AACrC,IAAA,aAAa,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;AACtC,CAAA,CAAC;AAEF,MAAM,UAAU,GAAGA,GAAC,CAAC,MAAM,CAAC;IAC1B,GAAGC,qCAA4B,CAAC,KAAK;AACrC,IAAA,IAAI,EAAED,GAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,OAAO,EAAEA,GAAC,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;AAC/C,IAAA,OAAO,EAAEA,GAAC,CAAC,MAAM,CAAC;QAChB,GAAGE,yBAAgB,CAAC,KAAK;AACzB,QAAA,QAAQ,EAAEF,GAAC,CAAC,KAAK,CAACG,4CAAmC,CAAC;KACvD,CAAC;AACH,CAAA,CAAC;AAEF,MAAM,WAAW,GAAG;IAClB;;;;"}

package/cjs/dpr/components/_dashboards/dashboard-visualisation/Validate.js

@@ -1,5 +1,7 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var z = require('zod');
 
 const dashboardBucket = z.z.object({
@@ -28,13 +30,17 @@ const DashboardVisualisationMeasureSchema = z.z.object({
     aggregate: z.z.enum(['sum', 'average']).optional(),
 });
 const DashboardColumns = z.z.object({
-    keys: z.z.array(DashboardVisualisationKeySchema),
-    measures: z.z.array(DashboardVisualisationMeasureSchema).length(1, 'Measure must contain a single item'),
+    keys: z.z.array(DashboardVisualisationKeySchema).optional(),
+    measures: z.z.array(DashboardVisualisationMeasureSchema, {
+        error: (issue) => issue.input === undefined
+            ? 'Dashboard visualisation definition: measures is required'
+            : 'Dashboard visualisation definition: measures must be an array',
+    }),
     filters: z.z.array(dashboardVisFilter).min(1).optional(),
     expectNulls: z.z.boolean().default(false),
 });
 const dashboardOptions = z.z.object({
-    ...dashboardBucket.shape,
+    ...BucketOptionsSchema.shape,
     showLatest: z.z.boolean().default(true),
     columnsAsList: z.z.boolean().optional(),
 });
@@ -53,12 +59,15 @@ const DashboardVisualisationSchema = z.z.object({
     ]),
     display: z.z.string().optional(),
     description: z.z.string().optional(),
-    options: z.z.object(dashboardOptions.shape),
+    options: z.z.object(dashboardOptions.shape).optional(),
     columns: z.z.object(DashboardColumns.shape),
 });
+const DashboardVisualisationSchemas = {
+    DashboardVisualisationSchema};
 
 exports.BucketOptionsSchema = BucketOptionsSchema;
 exports.DashboardColumns = DashboardColumns;
 exports.DashboardVisualisationMeasureSchema = DashboardVisualisationMeasureSchema;
 exports.DashboardVisualisationSchema = DashboardVisualisationSchema;
+exports.default = DashboardVisualisationSchemas;
 //# sourceMappingURL=Validate.js.map

package/cjs/dpr/components/_dashboards/dashboard-visualisation/Validate.js.map

@@ -1 +1 @@
-{"version":3,"file":"Validate.js","sources":["../../../../../../../../../../../src/dpr/components/_dashboards/dashboard-visualisation/Validate.ts"],"sourcesContent":["import { z } from 'zod'\n\nconst dashboardBucket = z.object({\n  min: z.number().optional(),\n  max: z.number().optional(),\n  hexColour: z.string().optional(),\n})\n\nexport const BucketOptionsSchema = z.object({\n  useRagColour: z.boolean().default(false),\n  buckets: z.array(dashboardBucket).default([]),\n  baseColour: z.string().regex(/^#/).optional(),\n})\n\nconst dashboardVisFilter = z.object({\n  id: z.string(),\n  equals: z.string().nullable(),\n})\n\nconst DashboardVisualisationKeySchema = z.object({\n  id: z.string(),\n  display: z.string().optional(),\n  optional: z.boolean().default(false),\n})\n\nexport const DashboardVisualisationMeasureSchema = z.object({\n  id: z.string(),\n  display: z.string().optional(),\n  unit: z.enum(['NUMBER', 'PERCENTAGE']).optional(),\n  aggregate: z.enum(['sum', 'average']).optional(),\n})\n\nexport const DashboardColumns = z.object({\n  keys: z.array(DashboardVisualisationKeySchema),\n  measures: z.array(DashboardVisualisationMeasureSchema).length(1, 'Measure must contain a single item'),\n  filters: z.array(dashboardVisFilter).min(1).optional(),\n  expectNulls: z.boolean().default(false),\n})\n\nconst dashboardOptions = z.object({\n  ...dashboardBucket.shape,\n  showLatest: z.boolean().default(true),\n  columnsAsList: z.boolean().optional(),\n})\n\nexport const DashboardVisualisationSchema = z.object({\n  id: z.string(),\n  type: z.enum([\n    'list',\n    'doughnut',\n    'bar',\n    'bar-timeseries',\n    'line',\n    'scorecard',\n    'scorecard-group',\n    'matrix-timeseries',\n    'line-timeseries',\n  ]),\n  display: z.string().optional(),\n  description: z.string().optional(),\n  options: z.object(dashboardOptions.shape),\n  columns: z.object(DashboardColumns.shape),\n})\n\nconst DashboardVisualisationSchemas = {\n  DashboardVisualisationSchema,\n  DashboardVisualisationMeasureSchema,\n  DashboardVisualisationKeySchema,\n}\n\nexport default DashboardVisualisationSchemas\n"],"names":["z"],"mappings":";;;;AAEA,MAAM,eAAe,GAAGA,GAAC,CAAC,MAAM,CAAC;AAC/B,IAAA,GAAG,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC1B,IAAA,GAAG,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC1B,IAAA,SAAS,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AACjC,CAAA,CAAC;AAEK,MAAM,mBAAmB,GAAGA,GAAC,CAAC,MAAM,CAAC;IAC1C,YAAY,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACxC,OAAO,EAAEA,GAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;AAC7C,IAAA,UAAU,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;AAC9C,CAAA;AAED,MAAM,kBAAkB,GAAGA,GAAC,CAAC,MAAM,CAAC;AAClC,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,MAAM,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC9B,CAAA,CAAC;AAEF,MAAM,+BAA+B,GAAGA,GAAC,CAAC,MAAM,CAAC;AAC/C,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,OAAO,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;AACrC,CAAA,CAAC;AAEK,MAAM,mCAAmC,GAAGA,GAAC,CAAC,MAAM,CAAC;AAC1D,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,OAAO,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC9B,IAAA,IAAI,EAAEA,GAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE;AACjD,IAAA,SAAS,EAAEA,GAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;AACjD,CAAA;AAEM,MAAM,gBAAgB,GAAGA,GAAC,CAAC,MAAM,CAAC;AACvC,IAAA,IAAI,EAAEA,GAAC,CAAC,KAAK,CAAC,+BAA+B,CAAC;AAC9C,IAAA,QAAQ,EAAEA,GAAC,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,oCAAoC,CAAC;AACtG,IAAA,OAAO,EAAEA,GAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtD,WAAW,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;AACxC,CAAA;AAED,MAAM,gBAAgB,GAAGA,GAAC,CAAC,MAAM,CAAC;IAChC,GAAG,eAAe,CAAC,KAAK;IACxB,UAAU,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;AACrC,IAAA,aAAa,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;AACtC,CAAA,CAAC;AAEK,MAAM,4BAA4B,GAAGA,GAAC,CAAC,MAAM,CAAC;AACnD,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,IAAI,EAAEA,GAAC,CAAC,IAAI,CAAC;QACX,MAAM;QACN,UAAU;QACV,KAAK;QACL,gBAAgB;QAChB,MAAM;QACN,WAAW;QACX,iBAAiB;QACjB,mBAAmB;QACnB,iBAAiB;KAClB,CAAC;AACF,IAAA,OAAO,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC9B,IAAA,WAAW,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAEA,GAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC;IACzC,OAAO,EAAEA,GAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC;AAC1C,CAAA;;;;;;;"}
+{"version":3,"file":"Validate.js","sources":["../../../../../../../../../../../src/dpr/components/_dashboards/dashboard-visualisation/Validate.ts"],"sourcesContent":["import { z } from 'zod'\n\nconst dashboardBucket = z.object({\n  min: z.number().optional(),\n  max: z.number().optional(),\n  hexColour: z.string().optional(),\n})\n\nexport const BucketOptionsSchema = z.object({\n  useRagColour: z.boolean().default(false),\n  buckets: z.array(dashboardBucket).default([]),\n  baseColour: z.string().regex(/^#/).optional(),\n})\n\nconst dashboardVisFilter = z.object({\n  id: z.string(),\n  equals: z.string().nullable(),\n})\n\nconst DashboardVisualisationKeySchema = z.object({\n  id: z.string(),\n  display: z.string().optional(),\n  optional: z.boolean().default(false),\n})\n\nexport const DashboardVisualisationMeasureSchema = z.object({\n  id: z.string(),\n  display: z.string().optional(),\n  unit: z.enum(['NUMBER', 'PERCENTAGE']).optional(),\n  aggregate: z.enum(['sum', 'average']).optional(),\n})\n\nexport const DashboardColumns = z.object({\n  keys: z.array(DashboardVisualisationKeySchema).optional(),\n  measures: z.array(DashboardVisualisationMeasureSchema, {\n    error: (issue) =>\n      issue.input === undefined\n        ? 'Dashboard visualisation definition: measures is required'\n        : 'Dashboard visualisation definition: measures must be an array',\n  }),\n  filters: z.array(dashboardVisFilter).min(1).optional(),\n  expectNulls: z.boolean().default(false),\n})\n\nconst dashboardOptions = z.object({\n  ...BucketOptionsSchema.shape,\n  showLatest: z.boolean().default(true),\n  columnsAsList: z.boolean().optional(),\n})\n\nexport const DashboardVisualisationSchema = z.object({\n  id: z.string(),\n  type: z.enum([\n    'list',\n    'doughnut',\n    'bar',\n    'bar-timeseries',\n    'line',\n    'scorecard',\n    'scorecard-group',\n    'matrix-timeseries',\n    'line-timeseries',\n  ]),\n  display: z.string().optional(),\n  description: z.string().optional(),\n  options: z.object(dashboardOptions.shape).optional(),\n  columns: z.object(DashboardColumns.shape),\n})\n\nconst DashboardVisualisationSchemas = {\n  DashboardVisualisationSchema,\n  DashboardVisualisationMeasureSchema,\n  DashboardVisualisationKeySchema,\n}\n\nexport default DashboardVisualisationSchemas\n"],"names":["z"],"mappings":";;;;;;AAEA,MAAM,eAAe,GAAGA,GAAC,CAAC,MAAM,CAAC;AAC/B,IAAA,GAAG,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC1B,IAAA,GAAG,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC1B,IAAA,SAAS,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AACjC,CAAA,CAAC;AAEK,MAAM,mBAAmB,GAAGA,GAAC,CAAC,MAAM,CAAC;IAC1C,YAAY,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACxC,OAAO,EAAEA,GAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;AAC7C,IAAA,UAAU,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;AAC9C,CAAA;AAED,MAAM,kBAAkB,GAAGA,GAAC,CAAC,MAAM,CAAC;AAClC,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,MAAM,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC9B,CAAA,CAAC;AAEF,MAAM,+BAA+B,GAAGA,GAAC,CAAC,MAAM,CAAC;AAC/C,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,OAAO,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;AACrC,CAAA,CAAC;AAEK,MAAM,mCAAmC,GAAGA,GAAC,CAAC,MAAM,CAAC;AAC1D,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,OAAO,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC9B,IAAA,IAAI,EAAEA,GAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE;AACjD,IAAA,SAAS,EAAEA,GAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;AACjD,CAAA;AAEM,MAAM,gBAAgB,GAAGA,GAAC,CAAC,MAAM,CAAC;IACvC,IAAI,EAAEA,GAAC,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,QAAQ,EAAE;AACzD,IAAA,QAAQ,EAAEA,GAAC,CAAC,KAAK,CAAC,mCAAmC,EAAE;QACrD,KAAK,EAAE,CAAC,KAAK,KACX,KAAK,CAAC,KAAK,KAAK;AACd,cAAE;AACF,cAAE,+DAA+D;KACtE,CAAC;AACF,IAAA,OAAO,EAAEA,GAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtD,WAAW,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;AACxC,CAAA;AAED,MAAM,gBAAgB,GAAGA,GAAC,CAAC,MAAM,CAAC;IAChC,GAAG,mBAAmB,CAAC,KAAK;IAC5B,UAAU,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;AACrC,IAAA,aAAa,EAAEA,GAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;AACtC,CAAA,CAAC;AAEK,MAAM,4BAA4B,GAAGA,GAAC,CAAC,MAAM,CAAC;AACnD,IAAA,EAAE,EAAEA,GAAC,CAAC,MAAM,EAAE;AACd,IAAA,IAAI,EAAEA,GAAC,CAAC,IAAI,CAAC;QACX,MAAM;QACN,UAAU;QACV,KAAK;QACL,gBAAgB;QAChB,MAAM;QACN,WAAW;QACX,iBAAiB;QACjB,mBAAmB;QACnB,iBAAiB;KAClB,CAAC;AACF,IAAA,OAAO,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC9B,IAAA,WAAW,EAAEA,GAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAEA,GAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;IACpD,OAAO,EAAEA,GAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC;AAC1C,CAAA;AAED,MAAM,6BAA6B,GAAG;IACpC;;;;;;;;"}

package/cjs/dpr/data/reportingClient.js

@@ -109,6 +109,14 @@ class ReportingClient {
             token,
         }, res);
     }
+    downloadSyncReport(token, resourceName, reportQuery, res) {
+        this.logInfo('Streaming download data', { resourceName });
+        return this.restClient.getStream({
+            path: `/${resourceName}/download`,
+            query: reportQuery.toRecordWithFilterPrefix(true),
+            token,
+        }, res);
+    }
     getAsyncReport(token, reportId, variantId, tableId, query) {
         this.logInfo('Get Data', { reportId, variantId, tableId });
         return this.restClient

package/cjs/dpr/data/reportingClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"reportingClient.js","sources":["../../../../../../../../../src/dpr/data/reportingClient.ts"],"sourcesContent":["import { Response } from 'express'\nimport ReportQuery from '../types/ReportQuery'\nimport logger from '../utils/logger'\nimport RestClient from './restClient'\nimport Dict = NodeJS.Dict\nimport { components, operations } from '../types/api'\nimport { ApiConfig, Count, ListWithWarnings } from './types'\nimport type { ResultWithHeaders } from './restClient'\n\nclass ReportingClient {\n  restClient: RestClient\n\n  constructor(config: ApiConfig) {\n    this.restClient = new RestClient('Reporting API Client', config)\n  }\n\n  getCount(resourceName: string, token: string, countRequest: ReportQuery): Promise<number> {\n    logger.info(`Reporting client: Get count. { resourceName: ${resourceName} }`)\n\n    return this.restClient\n      .get({\n        path: `/${resourceName}/count`,\n        query: countRequest.toRecordWithFilterPrefix(true),\n        token,\n      })\n      .then((response) => (<Count>response).count)\n  }\n\n  getList(resourceName: string, token: string, listRequest: ReportQuery): Promise<Array<Dict<string>>> {\n    return this.getListWithWarnings(resourceName, token, listRequest).then((response) => response.data)\n  }\n\n  getListWithWarnings(resourceName: string, token: string, listRequest: ReportQuery): Promise<ListWithWarnings> {\n    logger.info(`Reporting client: Get list. { resourceName: ${resourceName} }`)\n\n    return this.restClient\n      .getWithHeaders<Array<Dict<string>>>({\n        path: `/${resourceName}`,\n        query: listRequest.toRecordWithFilterPrefix(true),\n        token,\n      })\n      .then((response: ResultWithHeaders<Array<Dict<string>>>) => ({\n        data: response.data,\n        warnings: {\n          noDataAvailable: response.headers['x-no-data-warning'],\n        },\n      }))\n  }\n\n  getDefinitionSummary(\n    token: string,\n    reportId: string,\n    definitionsPath?: string,\n  ): Promise<components['schemas']['ReportDefinitionSummary']> {\n    this.logInfo('Get definition summary', { reportId })\n\n    const queryParams: operations['definitionSummary']['parameters']['query'] = {\n      ...(definitionsPath && { dataProductDefinitionsPath: definitionsPath }),\n    }\n\n    return this.restClient\n      .get({\n        path: `/definitions/${reportId}`,\n        query: queryParams,\n        token,\n      })\n      .then((response) => <components['schemas']['ReportDefinitionSummary']>response)\n  }\n\n  getDefinitions(\n    token: string,\n    definitionsPath?: string,\n  ): Promise<Array<components['schemas']['ReportDefinitionSummary']>> {\n    this.logInfo('Get definitions')\n\n    const queryParams: operations['definitions_1']['parameters']['query'] = {\n      renderMethod: 'HTML',\n      ...(definitionsPath && { dataProductDefinitionsPath: definitionsPath }),\n    }\n\n    return this.restClient\n      .get({\n        path: '/definitions',\n        query: queryParams,\n        token,\n      })\n      .then((response) => <Array<components['schemas']['ReportDefinitionSummary']>>response)\n  }\n\n  getDefinition(\n    token: string,\n    reportId: string,\n    variantId: string,\n    definitionsPath?: string,\n    queryData?: Dict<string | string[]>,\n  ): Promise<components['schemas']['SingleVariantReportDefinition']> {\n    const query = {\n      ...queryData,\n      dataProductDefinitionsPath: definitionsPath,\n    }\n\n    this.logInfo('Get definition', { reportId, variantId, ...query })\n\n    return this.restClient\n      .get({\n        path: `/definitions/${reportId}/${variantId}`,\n        query,\n        token,\n      })\n      .then((response) => <components['schemas']['SingleVariantReportDefinition']>response)\n  }\n\n  requestAsyncReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    query: Record<string, string | boolean | number>,\n  ): Promise<Dict<string>> {\n    this.logInfo('Request report', { reportId, variantId })\n\n    return this.restClient\n      .get({\n        path: `/async/reports/${reportId}/${variantId}`,\n        token,\n        query,\n      })\n      .then((response) => <Dict<string>>response)\n  }\n\n  cancelAsyncRequest(\n    token: string,\n    reportId: string,\n    variantId: string,\n    executionId: string,\n    dataProductDefinitionsPath?: string,\n  ): Promise<Dict<string>> {\n    this.logInfo('Cancel Request', { reportId, variantId, executionId })\n\n    return this.restClient\n      .delete({\n        path: `/reports/${reportId}/${variantId}/statements/${executionId}`,\n        token,\n        query: {\n          dataProductDefinitionsPath,\n        },\n      })\n      .then((response) => <Dict<string>>response)\n  }\n\n  downloadAsyncReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    tableId: string,\n    query: Record<string, string | string[]>,\n    res: Response,\n  ): Promise<void> {\n    this.logInfo('Streaming download data', { reportId, variantId, tableId })\n\n    return this.restClient.getStream(\n      {\n        path: `/reports/${reportId}/${variantId}/tables/${tableId}/download`,\n        query,\n        token,\n      },\n      res,\n    )\n  }\n\n  getAsyncReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    tableId: string,\n    query: Record<string, string | string[]>,\n  ): Promise<Array<Record<string, string>>> {\n    this.logInfo('Get Data', { reportId, variantId, tableId })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${variantId}/tables/${tableId}/result`,\n        token,\n        query,\n      })\n      .then((response) => <Array<Record<string, string>>>response)\n  }\n\n  getAsyncSummaryReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    tableId: string,\n    summaryId: string,\n    query: Dict<string | number>,\n  ): Promise<Array<Record<string, string>>> {\n    this.logInfo('Get summary data', { reportId, variantId, tableId, summaryId })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${variantId}/tables/${tableId}/result/summary/${summaryId}`,\n        token,\n        query,\n      })\n      .then((response) => <Array<Record<string, string>>>response)\n  }\n\n  getAsyncReportStatus(\n    token: string,\n    reportId: string,\n    variantId: string,\n    executionId: string,\n    dataProductDefinitionsPath?: string,\n    tableId?: string,\n  ): Promise<components['schemas']['StatementExecutionStatus']> {\n    this.logInfo('Get status', { reportId, variantId, tableId, executionId })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${variantId}/statements/${executionId}/status`,\n        token,\n        query: {\n          dataProductDefinitionsPath,\n          tableId,\n        },\n      })\n      .then((response) => <components['schemas']['StatementExecutionStatus']>response)\n  }\n\n  getAsyncCount(token: string, tableId: string, dataProductDefinitionsPath?: string): Promise<number> {\n    this.logInfo('Get count', { tableId })\n\n    return this.restClient\n      .get({\n        path: `/report/tables/${tableId}/count`,\n        token,\n        query: {\n          dataProductDefinitionsPath,\n        },\n      })\n      .then((response) => (<Count>response).count)\n  }\n\n  getAsyncInteractiveCount(\n    token: string,\n    tableId: string,\n    reportId: string,\n    id: string,\n    filters: ReportQuery,\n  ): Promise<number> {\n    this.logInfo('Get interactive count', { tableId, reportId, id })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${id}/tables/${tableId}/count`,\n        token,\n        query: filters.toRecordWithFilterPrefix(true),\n      })\n      .then((response) => (<Count>response).count)\n  }\n\n  logInfo(title: string, args?: Dict<string>) {\n    logger.info(`Reporting Client: ${title}:`)\n    if (args && Object.keys(args).length) logger.info(JSON.stringify(args, null, 2))\n  }\n}\n\nexport { ReportingClient }\nexport default ReportingClient\n"],"names":["RestClient","logger"],"mappings":";;;;;;;AASA,MAAM,eAAe,CAAA;AACnB,IAAA,UAAU;AAEV,IAAA,WAAA,CAAY,MAAiB,EAAA;QAC3B,IAAI,CAAC,UAAU,GAAG,IAAIA,qBAAU,CAAC,sBAAsB,EAAE,MAAM,CAAC;IAClE;AAEA,IAAA,QAAQ,CAAC,YAAoB,EAAE,KAAa,EAAE,YAAyB,EAAA;AACrE,QAAAC,cAAM,CAAC,IAAI,CAAC,gDAAgD,YAAY,CAAA,EAAA,CAAI,CAAC;QAE7E,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,CAAA,CAAA,EAAI,YAAY,CAAA,MAAA,CAAQ;AAC9B,YAAA,KAAK,EAAE,YAAY,CAAC,wBAAwB,CAAC,IAAI,CAAC;YAClD,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAa,QAAS,CAAC,KAAK,CAAC;IAChD;AAEA,IAAA,OAAO,CAAC,YAAoB,EAAE,KAAa,EAAE,WAAwB,EAAA;QACnE,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,IAAI,CAAC;IACrG;AAEA,IAAA,mBAAmB,CAAC,YAAoB,EAAE,KAAa,EAAE,WAAwB,EAAA;AAC/E,QAAAA,cAAM,CAAC,IAAI,CAAC,+CAA+C,YAAY,CAAA,EAAA,CAAI,CAAC;QAE5E,OAAO,IAAI,CAAC;AACT,aAAA,cAAc,CAAsB;YACnC,IAAI,EAAE,CAAA,CAAA,EAAI,YAAY,CAAA,CAAE;AACxB,YAAA,KAAK,EAAE,WAAW,CAAC,wBAAwB,CAAC,IAAI,CAAC;YACjD,KAAK;SACN;AACA,aAAA,IAAI,CAAC,CAAC,QAAgD,MAAM;YAC3D,IAAI,EAAE,QAAQ,CAAC,IAAI;AACnB,YAAA,QAAQ,EAAE;AACR,gBAAA,eAAe,EAAE,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC;AACvD,aAAA;AACF,SAAA,CAAC,CAAC;IACP;AAEA,IAAA,oBAAoB,CAClB,KAAa,EACb,QAAgB,EAChB,eAAwB,EAAA;QAExB,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,QAAQ,EAAE,CAAC;AAEpD,QAAA,MAAM,WAAW,GAA2D;YAC1E,IAAI,eAAe,IAAI,EAAE,0BAA0B,EAAE,eAAe,EAAE,CAAC;SACxE;QAED,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,CAAA,aAAA,EAAgB,QAAQ,CAAA,CAAE;AAChC,YAAA,KAAK,EAAE,WAAW;YAClB,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAuD,QAAQ,CAAC;IACnF;IAEA,cAAc,CACZ,KAAa,EACb,eAAwB,EAAA;AAExB,QAAA,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;AAE/B,QAAA,MAAM,WAAW,GAAuD;AACtE,YAAA,YAAY,EAAE,MAAM;YACpB,IAAI,eAAe,IAAI,EAAE,0BAA0B,EAAE,eAAe,EAAE,CAAC;SACxE;QAED,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,cAAc;AACpB,YAAA,KAAK,EAAE,WAAW;YAClB,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAA8D,QAAQ,CAAC;IAC1F;IAEA,aAAa,CACX,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,eAAwB,EACxB,SAAmC,EAAA;AAEnC,QAAA,MAAM,KAAK,GAAG;AACZ,YAAA,GAAG,SAAS;AACZ,YAAA,0BAA0B,EAAE,eAAe;SAC5C;AAED,QAAA,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,CAAC;QAEjE,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,aAAA,EAAgB,QAAQ,CAAA,CAAA,EAAI,SAAS,CAAA,CAAE;YAC7C,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAA6D,QAAQ,CAAC;IACzF;AAEA,IAAA,kBAAkB,CAChB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,KAAgD,EAAA;QAEhD,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;QAEvD,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,eAAA,EAAkB,QAAQ,CAAA,CAAA,EAAI,SAAS,CAAA,CAAE;YAC/C,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAmB,QAAQ,CAAC;IAC/C;IAEA,kBAAkB,CAChB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,WAAmB,EACnB,0BAAmC,EAAA;AAEnC,QAAA,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC;QAEpE,OAAO,IAAI,CAAC;AACT,aAAA,MAAM,CAAC;AACN,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,YAAA,EAAe,WAAW,CAAA,CAAE;YACnE,KAAK;AACL,YAAA,KAAK,EAAE;gBACL,0BAA0B;AAC3B,aAAA;SACF;aACA,IAAI,CAAC,CAAC,QAAQ,KAAmB,QAAQ,CAAC;IAC/C;IAEA,mBAAmB,CACjB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,OAAe,EACf,KAAwC,EACxC,GAAa,EAAA;AAEb,QAAA,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;AAEzE,QAAA,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAC9B;AACE,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,QAAA,EAAW,OAAO,CAAA,SAAA,CAAW;YACpE,KAAK;YACL,KAAK;SACN,EACD,GAAG,CACJ;IACH;IAEA,cAAc,CACZ,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,OAAe,EACf,KAAwC,EAAA;AAExC,QAAA,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;QAE1D,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,QAAA,EAAW,OAAO,CAAA,OAAA,CAAS;YAClE,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAoC,QAAQ,CAAC;IAChE;IAEA,qBAAqB,CACnB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,OAAe,EACf,SAAiB,EACjB,KAA4B,EAAA;AAE5B,QAAA,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;QAE7E,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,YAAY,QAAQ,CAAA,CAAA,EAAI,SAAS,CAAA,QAAA,EAAW,OAAO,CAAA,gBAAA,EAAmB,SAAS,CAAA,CAAE;YACvF,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAoC,QAAQ,CAAC;IAChE;IAEA,oBAAoB,CAClB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,WAAmB,EACnB,0BAAmC,EACnC,OAAgB,EAAA;AAEhB,QAAA,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QAEzE,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,YAAA,EAAe,WAAW,CAAA,OAAA,CAAS;YAC1E,KAAK;AACL,YAAA,KAAK,EAAE;gBACL,0BAA0B;gBAC1B,OAAO;AACR,aAAA;SACF;aACA,IAAI,CAAC,CAAC,QAAQ,KAAwD,QAAQ,CAAC;IACpF;AAEA,IAAA,aAAa,CAAC,KAAa,EAAE,OAAe,EAAE,0BAAmC,EAAA;QAC/E,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC;QAEtC,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,CAAA,eAAA,EAAkB,OAAO,CAAA,MAAA,CAAQ;YACvC,KAAK;AACL,YAAA,KAAK,EAAE;gBACL,0BAA0B;AAC3B,aAAA;SACF;aACA,IAAI,CAAC,CAAC,QAAQ,KAAa,QAAS,CAAC,KAAK,CAAC;IAChD;IAEA,wBAAwB,CACtB,KAAa,EACb,OAAe,EACf,QAAgB,EAChB,EAAU,EACV,OAAoB,EAAA;AAEpB,QAAA,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAEhE,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,EAAE,CAAA,QAAA,EAAW,OAAO,CAAA,MAAA,CAAQ;YAC1D,KAAK;AACL,YAAA,KAAK,EAAE,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC;SAC9C;aACA,IAAI,CAAC,CAAC,QAAQ,KAAa,QAAS,CAAC,KAAK,CAAC;IAChD;IAEA,OAAO,CAAC,KAAa,EAAE,IAAmB,EAAA;AACxC,QAAAA,cAAM,CAAC,IAAI,CAAC,qBAAqB,KAAK,CAAA,CAAA,CAAG,CAAC;QAC1C,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM;AAAE,YAAAA,cAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAClF;AACD;;;;;"}
+{"version":3,"file":"reportingClient.js","sources":["../../../../../../../../../src/dpr/data/reportingClient.ts"],"sourcesContent":["import { Response } from 'express'\nimport ReportQuery from '../types/ReportQuery'\nimport logger from '../utils/logger'\nimport RestClient from './restClient'\nimport Dict = NodeJS.Dict\nimport { components, operations } from '../types/api'\nimport { ApiConfig, Count, ListWithWarnings } from './types'\nimport type { ResultWithHeaders } from './restClient'\n\nclass ReportingClient {\n  restClient: RestClient\n\n  constructor(config: ApiConfig) {\n    this.restClient = new RestClient('Reporting API Client', config)\n  }\n\n  getCount(resourceName: string, token: string, countRequest: ReportQuery): Promise<number> {\n    logger.info(`Reporting client: Get count. { resourceName: ${resourceName} }`)\n\n    return this.restClient\n      .get({\n        path: `/${resourceName}/count`,\n        query: countRequest.toRecordWithFilterPrefix(true),\n        token,\n      })\n      .then((response) => (<Count>response).count)\n  }\n\n  getList(resourceName: string, token: string, listRequest: ReportQuery): Promise<Array<Dict<string>>> {\n    return this.getListWithWarnings(resourceName, token, listRequest).then((response) => response.data)\n  }\n\n  getListWithWarnings(resourceName: string, token: string, listRequest: ReportQuery): Promise<ListWithWarnings> {\n    logger.info(`Reporting client: Get list. { resourceName: ${resourceName} }`)\n\n    return this.restClient\n      .getWithHeaders<Array<Dict<string>>>({\n        path: `/${resourceName}`,\n        query: listRequest.toRecordWithFilterPrefix(true),\n        token,\n      })\n      .then((response: ResultWithHeaders<Array<Dict<string>>>) => ({\n        data: response.data,\n        warnings: {\n          noDataAvailable: response.headers['x-no-data-warning'],\n        },\n      }))\n  }\n\n  getDefinitionSummary(\n    token: string,\n    reportId: string,\n    definitionsPath?: string,\n  ): Promise<components['schemas']['ReportDefinitionSummary']> {\n    this.logInfo('Get definition summary', { reportId })\n\n    const queryParams: operations['definitionSummary']['parameters']['query'] = {\n      ...(definitionsPath && { dataProductDefinitionsPath: definitionsPath }),\n    }\n\n    return this.restClient\n      .get({\n        path: `/definitions/${reportId}`,\n        query: queryParams,\n        token,\n      })\n      .then((response) => <components['schemas']['ReportDefinitionSummary']>response)\n  }\n\n  getDefinitions(\n    token: string,\n    definitionsPath?: string,\n  ): Promise<Array<components['schemas']['ReportDefinitionSummary']>> {\n    this.logInfo('Get definitions')\n\n    const queryParams: operations['definitions_1']['parameters']['query'] = {\n      renderMethod: 'HTML',\n      ...(definitionsPath && { dataProductDefinitionsPath: definitionsPath }),\n    }\n\n    return this.restClient\n      .get({\n        path: '/definitions',\n        query: queryParams,\n        token,\n      })\n      .then((response) => <Array<components['schemas']['ReportDefinitionSummary']>>response)\n  }\n\n  getDefinition(\n    token: string,\n    reportId: string,\n    variantId: string,\n    definitionsPath?: string,\n    queryData?: Dict<string | string[]>,\n  ): Promise<components['schemas']['SingleVariantReportDefinition']> {\n    const query = {\n      ...queryData,\n      dataProductDefinitionsPath: definitionsPath,\n    }\n\n    this.logInfo('Get definition', { reportId, variantId, ...query })\n\n    return this.restClient\n      .get({\n        path: `/definitions/${reportId}/${variantId}`,\n        query,\n        token,\n      })\n      .then((response) => <components['schemas']['SingleVariantReportDefinition']>response)\n  }\n\n  requestAsyncReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    query: Record<string, string | boolean | number>,\n  ): Promise<Dict<string>> {\n    this.logInfo('Request report', { reportId, variantId })\n\n    return this.restClient\n      .get({\n        path: `/async/reports/${reportId}/${variantId}`,\n        token,\n        query,\n      })\n      .then((response) => <Dict<string>>response)\n  }\n\n  cancelAsyncRequest(\n    token: string,\n    reportId: string,\n    variantId: string,\n    executionId: string,\n    dataProductDefinitionsPath?: string,\n  ): Promise<Dict<string>> {\n    this.logInfo('Cancel Request', { reportId, variantId, executionId })\n\n    return this.restClient\n      .delete({\n        path: `/reports/${reportId}/${variantId}/statements/${executionId}`,\n        token,\n        query: {\n          dataProductDefinitionsPath,\n        },\n      })\n      .then((response) => <Dict<string>>response)\n  }\n\n  downloadAsyncReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    tableId: string,\n    query: Record<string, string | string[]>,\n    res: Response,\n  ): Promise<void> {\n    this.logInfo('Streaming download data', { reportId, variantId, tableId })\n\n    return this.restClient.getStream(\n      {\n        path: `/reports/${reportId}/${variantId}/tables/${tableId}/download`,\n        query,\n        token,\n      },\n      res,\n    )\n  }\n\n  downloadSyncReport(token: string, resourceName: string, reportQuery: ReportQuery, res: Response): Promise<void> {\n    this.logInfo('Streaming download data', { resourceName })\n\n    return this.restClient.getStream(\n      {\n        path: `/${resourceName}/download`,\n        query: reportQuery.toRecordWithFilterPrefix(true),\n        token,\n      },\n      res,\n    )\n  }\n\n  getAsyncReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    tableId: string,\n    query: Record<string, string | string[]>,\n  ): Promise<Array<Record<string, string>>> {\n    this.logInfo('Get Data', { reportId, variantId, tableId })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${variantId}/tables/${tableId}/result`,\n        token,\n        query,\n      })\n      .then((response) => <Array<Record<string, string>>>response)\n  }\n\n  getAsyncSummaryReport(\n    token: string,\n    reportId: string,\n    variantId: string,\n    tableId: string,\n    summaryId: string,\n    query: Dict<string | number>,\n  ): Promise<Array<Record<string, string>>> {\n    this.logInfo('Get summary data', { reportId, variantId, tableId, summaryId })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${variantId}/tables/${tableId}/result/summary/${summaryId}`,\n        token,\n        query,\n      })\n      .then((response) => <Array<Record<string, string>>>response)\n  }\n\n  getAsyncReportStatus(\n    token: string,\n    reportId: string,\n    variantId: string,\n    executionId: string,\n    dataProductDefinitionsPath?: string,\n    tableId?: string,\n  ): Promise<components['schemas']['StatementExecutionStatus']> {\n    this.logInfo('Get status', { reportId, variantId, tableId, executionId })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${variantId}/statements/${executionId}/status`,\n        token,\n        query: {\n          dataProductDefinitionsPath,\n          tableId,\n        },\n      })\n      .then((response) => <components['schemas']['StatementExecutionStatus']>response)\n  }\n\n  getAsyncCount(token: string, tableId: string, dataProductDefinitionsPath?: string): Promise<number> {\n    this.logInfo('Get count', { tableId })\n\n    return this.restClient\n      .get({\n        path: `/report/tables/${tableId}/count`,\n        token,\n        query: {\n          dataProductDefinitionsPath,\n        },\n      })\n      .then((response) => (<Count>response).count)\n  }\n\n  getAsyncInteractiveCount(\n    token: string,\n    tableId: string,\n    reportId: string,\n    id: string,\n    filters: ReportQuery,\n  ): Promise<number> {\n    this.logInfo('Get interactive count', { tableId, reportId, id })\n\n    return this.restClient\n      .get({\n        path: `/reports/${reportId}/${id}/tables/${tableId}/count`,\n        token,\n        query: filters.toRecordWithFilterPrefix(true),\n      })\n      .then((response) => (<Count>response).count)\n  }\n\n  logInfo(title: string, args?: Dict<string>) {\n    logger.info(`Reporting Client: ${title}:`)\n    if (args && Object.keys(args).length) logger.info(JSON.stringify(args, null, 2))\n  }\n}\n\nexport { ReportingClient }\nexport default ReportingClient\n"],"names":["RestClient","logger"],"mappings":";;;;;;;AASA,MAAM,eAAe,CAAA;AACnB,IAAA,UAAU;AAEV,IAAA,WAAA,CAAY,MAAiB,EAAA;QAC3B,IAAI,CAAC,UAAU,GAAG,IAAIA,qBAAU,CAAC,sBAAsB,EAAE,MAAM,CAAC;IAClE;AAEA,IAAA,QAAQ,CAAC,YAAoB,EAAE,KAAa,EAAE,YAAyB,EAAA;AACrE,QAAAC,cAAM,CAAC,IAAI,CAAC,gDAAgD,YAAY,CAAA,EAAA,CAAI,CAAC;QAE7E,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,CAAA,CAAA,EAAI,YAAY,CAAA,MAAA,CAAQ;AAC9B,YAAA,KAAK,EAAE,YAAY,CAAC,wBAAwB,CAAC,IAAI,CAAC;YAClD,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAa,QAAS,CAAC,KAAK,CAAC;IAChD;AAEA,IAAA,OAAO,CAAC,YAAoB,EAAE,KAAa,EAAE,WAAwB,EAAA;QACnE,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,IAAI,CAAC;IACrG;AAEA,IAAA,mBAAmB,CAAC,YAAoB,EAAE,KAAa,EAAE,WAAwB,EAAA;AAC/E,QAAAA,cAAM,CAAC,IAAI,CAAC,+CAA+C,YAAY,CAAA,EAAA,CAAI,CAAC;QAE5E,OAAO,IAAI,CAAC;AACT,aAAA,cAAc,CAAsB;YACnC,IAAI,EAAE,CAAA,CAAA,EAAI,YAAY,CAAA,CAAE;AACxB,YAAA,KAAK,EAAE,WAAW,CAAC,wBAAwB,CAAC,IAAI,CAAC;YACjD,KAAK;SACN;AACA,aAAA,IAAI,CAAC,CAAC,QAAgD,MAAM;YAC3D,IAAI,EAAE,QAAQ,CAAC,IAAI;AACnB,YAAA,QAAQ,EAAE;AACR,gBAAA,eAAe,EAAE,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC;AACvD,aAAA;AACF,SAAA,CAAC,CAAC;IACP;AAEA,IAAA,oBAAoB,CAClB,KAAa,EACb,QAAgB,EAChB,eAAwB,EAAA;QAExB,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,QAAQ,EAAE,CAAC;AAEpD,QAAA,MAAM,WAAW,GAA2D;YAC1E,IAAI,eAAe,IAAI,EAAE,0BAA0B,EAAE,eAAe,EAAE,CAAC;SACxE;QAED,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,CAAA,aAAA,EAAgB,QAAQ,CAAA,CAAE;AAChC,YAAA,KAAK,EAAE,WAAW;YAClB,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAuD,QAAQ,CAAC;IACnF;IAEA,cAAc,CACZ,KAAa,EACb,eAAwB,EAAA;AAExB,QAAA,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;AAE/B,QAAA,MAAM,WAAW,GAAuD;AACtE,YAAA,YAAY,EAAE,MAAM;YACpB,IAAI,eAAe,IAAI,EAAE,0BAA0B,EAAE,eAAe,EAAE,CAAC;SACxE;QAED,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,cAAc;AACpB,YAAA,KAAK,EAAE,WAAW;YAClB,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAA8D,QAAQ,CAAC;IAC1F;IAEA,aAAa,CACX,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,eAAwB,EACxB,SAAmC,EAAA;AAEnC,QAAA,MAAM,KAAK,GAAG;AACZ,YAAA,GAAG,SAAS;AACZ,YAAA,0BAA0B,EAAE,eAAe;SAC5C;AAED,QAAA,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,CAAC;QAEjE,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,aAAA,EAAgB,QAAQ,CAAA,CAAA,EAAI,SAAS,CAAA,CAAE;YAC7C,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAA6D,QAAQ,CAAC;IACzF;AAEA,IAAA,kBAAkB,CAChB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,KAAgD,EAAA;QAEhD,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;QAEvD,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,eAAA,EAAkB,QAAQ,CAAA,CAAA,EAAI,SAAS,CAAA,CAAE;YAC/C,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAmB,QAAQ,CAAC;IAC/C;IAEA,kBAAkB,CAChB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,WAAmB,EACnB,0BAAmC,EAAA;AAEnC,QAAA,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC;QAEpE,OAAO,IAAI,CAAC;AACT,aAAA,MAAM,CAAC;AACN,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,YAAA,EAAe,WAAW,CAAA,CAAE;YACnE,KAAK;AACL,YAAA,KAAK,EAAE;gBACL,0BAA0B;AAC3B,aAAA;SACF;aACA,IAAI,CAAC,CAAC,QAAQ,KAAmB,QAAQ,CAAC;IAC/C;IAEA,mBAAmB,CACjB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,OAAe,EACf,KAAwC,EACxC,GAAa,EAAA;AAEb,QAAA,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;AAEzE,QAAA,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAC9B;AACE,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,QAAA,EAAW,OAAO,CAAA,SAAA,CAAW;YACpE,KAAK;YACL,KAAK;SACN,EACD,GAAG,CACJ;IACH;AAEA,IAAA,kBAAkB,CAAC,KAAa,EAAE,YAAoB,EAAE,WAAwB,EAAE,GAAa,EAAA;QAC7F,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,YAAY,EAAE,CAAC;AAEzD,QAAA,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAC9B;YACE,IAAI,EAAE,CAAA,CAAA,EAAI,YAAY,CAAA,SAAA,CAAW;AACjC,YAAA,KAAK,EAAE,WAAW,CAAC,wBAAwB,CAAC,IAAI,CAAC;YACjD,KAAK;SACN,EACD,GAAG,CACJ;IACH;IAEA,cAAc,CACZ,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,OAAe,EACf,KAAwC,EAAA;AAExC,QAAA,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;QAE1D,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,QAAA,EAAW,OAAO,CAAA,OAAA,CAAS;YAClE,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAoC,QAAQ,CAAC;IAChE;IAEA,qBAAqB,CACnB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,OAAe,EACf,SAAiB,EACjB,KAA4B,EAAA;AAE5B,QAAA,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;QAE7E,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,YAAY,QAAQ,CAAA,CAAA,EAAI,SAAS,CAAA,QAAA,EAAW,OAAO,CAAA,gBAAA,EAAmB,SAAS,CAAA,CAAE;YACvF,KAAK;YACL,KAAK;SACN;aACA,IAAI,CAAC,CAAC,QAAQ,KAAoC,QAAQ,CAAC;IAChE;IAEA,oBAAoB,CAClB,KAAa,EACb,QAAgB,EAChB,SAAiB,EACjB,WAAmB,EACnB,0BAAmC,EACnC,OAAgB,EAAA;AAEhB,QAAA,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QAEzE,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,SAAS,CAAA,YAAA,EAAe,WAAW,CAAA,OAAA,CAAS;YAC1E,KAAK;AACL,YAAA,KAAK,EAAE;gBACL,0BAA0B;gBAC1B,OAAO;AACR,aAAA;SACF;aACA,IAAI,CAAC,CAAC,QAAQ,KAAwD,QAAQ,CAAC;IACpF;AAEA,IAAA,aAAa,CAAC,KAAa,EAAE,OAAe,EAAE,0BAAmC,EAAA;QAC/E,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC;QAEtC,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;YACH,IAAI,EAAE,CAAA,eAAA,EAAkB,OAAO,CAAA,MAAA,CAAQ;YACvC,KAAK;AACL,YAAA,KAAK,EAAE;gBACL,0BAA0B;AAC3B,aAAA;SACF;aACA,IAAI,CAAC,CAAC,QAAQ,KAAa,QAAS,CAAC,KAAK,CAAC;IAChD;IAEA,wBAAwB,CACtB,KAAa,EACb,OAAe,EACf,QAAgB,EAChB,EAAU,EACV,OAAoB,EAAA;AAEpB,QAAA,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAEhE,OAAO,IAAI,CAAC;AACT,aAAA,GAAG,CAAC;AACH,YAAA,IAAI,EAAE,CAAA,SAAA,EAAY,QAAQ,IAAI,EAAE,CAAA,QAAA,EAAW,OAAO,CAAA,MAAA,CAAQ;YAC1D,KAAK;AACL,YAAA,KAAK,EAAE,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC;SAC9C;aACA,IAAI,CAAC,CAAC,QAAQ,KAAa,QAAS,CAAC,KAAK,CAAC;IAChD;IAEA,OAAO,CAAC,KAAa,EAAE,IAAmB,EAAA;AACxC,QAAAA,cAAM,CAAC,IAAI,CAAC,qBAAqB,KAAK,CAAA,CAAA,CAAG,CAAC;QAC1C,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM;AAAE,YAAAA,cAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAClF;AACD;;;;;"}

package/cjs/dpr/routes/journeys/download-report/utils.js

@@ -2,69 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var json2Csv = require('json-2-csv');
 var UserReports = require('../../../types/UserReports.js');
 var localsHelper = require('../../../utils/localsHelper.js');
 var ReportQuery = require('../../../types/ReportQuery.js');
 var logger = require('../../../utils/logger.js');
 
-const convertToCsv = (reportData, options) => {
-    const csvData = json2Csv.json2csv(reportData, options);
-    return csvData;
-};
-const getKeys = (reportData, fields) => {
-    const keys = [];
-    const keyNames = [];
-    reportData.forEach((row) => {
-        Object.keys(row).forEach((key) => {
-            const field = fields.find((f) => f.name === key);
-            if (field && !keyNames.includes(key)) {
-                keyNames.push(key);
-                keys.push({
-                    field: key,
-                    title: field.display,
-                });
-            }
-        });
-    });
-    return keys;
-};
-const applyColumnsAndSort = (data, columns) => {
-    return data.map((row) => {
-        return Object.keys(row)
-            .filter((key) => columns.includes(key))
-            .reduce((obj, key) => {
-            // eslint-disable-next-line no-param-reassign
-            obj[key] = row[key];
-            return obj;
-        }, {});
-    });
-};
-const removeHtmlTags = (reportData, reportDefinition) => {
-    // Find HMTL field + name
-    const { specification } = reportDefinition.variant;
-    if (specification) {
-        const { fields } = specification;
-        const htmlFields = fields.filter((field) => {
-            return field.type === 'HTML';
-        });
-        if (htmlFields.length) {
-            reportData.map((d) => {
-                htmlFields.forEach((field) => {
-                    const { name } = field;
-                    const colValue = d[name];
-                    if (colValue) {
-                        const innerText = /target="_blank">(.*?)<\/a>/g.exec(colValue);
-                        // eslint-disable-next-line prefer-destructuring, no-param-reassign
-                        d[name] = innerText ? innerText[1] : colValue;
-                    }
-                });
-                return d;
-            });
-        }
-    }
-    return reportData;
-};
 const streamDownloadAsyncData = async (args) => {
     const { token, services, tableId, reportId, id, queryParams, res } = args;
     const query = {
@@ -72,75 +14,51 @@ const streamDownloadAsyncData = async (args) => {
     };
     return services.reportingService.downloadAsyncReport(token, reportId, id, tableId, query, res);
 };
-const downloadSyncData = async (args) => {
-    const { token, services, queryParams, definition } = args;
+const streamDownloadSyncData = async (args) => {
+    const { token, services, queryParams, definition, res } = args;
     const { variant } = definition;
     const { resourceName, specification } = variant;
-    let data = [];
-    if (specification) {
-        const countReportQuery = new ReportQuery.ReportQuery({
-            fields: specification.fields,
-            template: specification.template,
-            queryParams,
-            definitionsPath: queryParams.dataProductDefinitionsPath,
-        });
-        const count = await services.reportingService.getCount(resourceName, token, countReportQuery);
-        const dataReportQuery = new ReportQuery.ReportQuery({
-            fields: specification.fields,
-            template: specification.template,
-            queryParams: {
-                ...queryParams,
-                pageSize: count.toString(),
-            },
-            definitionsPath: queryParams.dataProductDefinitionsPath,
-        });
-        const reportData = await services.reportingService.getListWithWarnings(resourceName, token, dataReportQuery);
-        data = reportData.data;
+    if (!specification) {
+        logger.default.error(`No specification found for definition ID: ${definition.id} variant ID: ${variant.id}`);
+        throw new Error(`No specification found for definition ID: ${definition.id} variant ID: ${variant.id}`);
     }
-    return data;
+    const reportQuery = new ReportQuery.ReportQuery({
+        fields: specification.fields,
+        template: specification.template,
+        queryParams: {
+            ...queryParams,
+        },
+        definitionsPath: queryParams.dataProductDefinitionsPath,
+    });
+    return services.reportingService.downloadSyncReport(token, resourceName, reportQuery, res);
 };
 const downloadReport = async ({ req, services, res, redirect, loadType, }) => {
     const { dprUser, token } = localsHelper.default.getValues(res);
-    const { reportId, id, tableId, dataProductDefinitionsPath, reportName, name, cols: columns, sortedAsc, sortColumn, } = req.body;
+    const { reportId, id, tableId, dataProductDefinitionsPath, cols: columns, sortedAsc, sortColumn } = req.body;
     const { downloadPermissionService } = services;
     const canDownloadReport = await downloadPermissionService.downloadEnabledForReport(dprUser.id, reportId, id);
     if (!canDownloadReport) {
         res.redirect(redirect);
     }
     else {
-        const definition = await services.reportingService.getDefinition(token, reportId, id, dataProductDefinitionsPath);
-        const queryParams = {
+        const streamDownloadQueryParams = {
             dataProductDefinitionsPath,
+            ...(columns && { columns: JSON.parse(columns) }),
             ...(sortedAsc && { sortedAsc }),
             ...(sortColumn && { sortColumn }),
         };
-        let reportData;
+        const definition = await services.reportingService.getDefinition(token, reportId, id, dataProductDefinitionsPath);
+        logger.default.info(`Initiating streaming...`);
         if (loadType === UserReports.LoadType.SYNC) {
-            reportData = await downloadSyncData({
+            await streamDownloadSyncData({
                 definition,
                 services,
                 token,
-                queryParams,
+                queryParams: streamDownloadQueryParams,
+                res,
             });
-            if (columns) {
-                reportData = applyColumnsAndSort(reportData, JSON.parse(columns));
-            }
-            reportData = removeHtmlTags(reportData, definition);
-            const fields = definition.variant.specification?.fields || [];
-            const keys = getKeys(reportData, fields);
-            const csvData = convertToCsv(reportData, { keys, emptyFieldValue: '' });
-            res.setHeader('Content-Type', 'application/json');
-            res.setHeader('Content-disposition', `attachment; filename=${reportName}-${name}-${new Date().toISOString()}.csv`);
-            res.end(csvData);
         }
         else {
-            logger.default.info(`Initiating streaming...`);
-            const streamDownloadQueryParams = {
-                dataProductDefinitionsPath,
-                ...(columns && { columns: JSON.parse(columns) }),
-                ...(sortedAsc && { sortedAsc }),
-                ...(sortColumn && { sortColumn }),
-            };
             await streamDownloadAsyncData({
                 services,
                 token,
@@ -155,10 +73,8 @@ const downloadReport = async ({ req, services, res, redirect, loadType, }) => {
 };
 var DownloadUtils = {
     downloadReport,
-    getKeys,
 };
 
 exports.default = DownloadUtils;
 exports.downloadReport = downloadReport;
-exports.getKeys = getKeys;
 //# sourceMappingURL=utils.js.map

package/cjs/dpr/routes/journeys/download-report/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sources":["../../../../../../../../../../../src/dpr/routes/journeys/download-report/utils.ts"],"sourcesContent":["import { Response, Request } from 'express'\nimport { json2csv, Json2CsvOptions } from 'json-2-csv'\nimport { KeysList } from 'json-2-csv/lib/types'\nimport { Services } from '../../../types/Services'\nimport Dict = NodeJS.Dict\nimport { LoadType } from '../../../types/UserReports'\nimport { components } from '../../../types/api'\nimport LocalsHelper from '../../../utils/localsHelper'\nimport { Template } from '../../../types/Templates'\nimport ReportQuery from '../../../types/ReportQuery'\nimport logger from '../../../utils/logger'\n\nconst convertToCsv = (reportData: Dict<string>[], options: Json2CsvOptions) => {\n  const csvData = json2csv(reportData, options)\n  return csvData\n}\n\nexport const getKeys = (reportData: Dict<string>[], fields: components['schemas']['FieldDefinition'][]): KeysList => {\n  const keys: KeysList = []\n  const keyNames: string[] = []\n  reportData.forEach((row) => {\n    Object.keys(row).forEach((key) => {\n      const field = fields.find((f) => f.name === key)\n      if (field && !keyNames.includes(key)) {\n        keyNames.push(key)\n        keys.push({\n          field: key,\n          title: field.display,\n        })\n      }\n    })\n  })\n  return keys\n}\n\nconst applyColumnsAndSort = (data: Dict<string>[], columns: string[]) => {\n  return data.map((row) => {\n    return Object.keys(row)\n      .filter((key) => columns.includes(key))\n      .reduce((obj: Dict<string>, key) => {\n        // eslint-disable-next-line no-param-reassign\n        obj[key] = row[key]\n        return obj\n      }, {})\n  })\n}\n\nconst removeHtmlTags = (\n  reportData: Dict<string>[],\n  reportDefinition: components['schemas']['SingleVariantReportDefinition'],\n) => {\n  // Find HMTL field + name\n  const { specification } = reportDefinition.variant\n  if (specification) {\n    const { fields } = specification\n    const htmlFields = fields.filter((field) => {\n      return field.type === 'HTML'\n    })\n\n    if (htmlFields.length) {\n      reportData.map((d) => {\n        htmlFields.forEach((field) => {\n          const { name } = field\n          const colValue = d[name]\n          if (colValue) {\n            const innerText = /target=\"_blank\">(.*?)<\\/a>/g.exec(colValue)\n            // eslint-disable-next-line prefer-destructuring, no-param-reassign\n            d[name] = innerText ? innerText[1] : colValue\n          }\n        })\n        return d\n      })\n    }\n  }\n  return reportData\n}\n\nconst streamDownloadAsyncData = async (args: {\n  services: Services\n  token: string\n  tableId: string\n  reportId: string\n  id: string\n  queryParams: {\n    dataProductDefinitionsPath: string\n    columns: string[]\n    sortedAsc?: string\n    sortColumn?: string\n  }\n  res: Response\n}) => {\n  const { token, services, tableId, reportId, id, queryParams, res } = args\n  const query: Record<string, string | string[]> = {\n    ...queryParams,\n  }\n  return services.reportingService.downloadAsyncReport(token, reportId, id, tableId, query, res)\n}\n\nconst downloadSyncData = async (args: {\n  definition: components['schemas']['SingleVariantReportDefinition']\n  services: Services\n  token: string\n  queryParams: {\n    dataProductDefinitionsPath: string\n    sortedAsc?: string\n    sortColumn?: string\n  }\n}) => {\n  const { token, services, queryParams, definition } = args\n  const { variant } = definition\n  const { resourceName, specification } = variant\n  let data: Dict<string>[] = []\n\n  if (specification) {\n    const countReportQuery = new ReportQuery({\n      fields: specification.fields,\n      template: specification.template as Template,\n      queryParams,\n      definitionsPath: <string>queryParams.dataProductDefinitionsPath,\n    })\n    const count = await services.reportingService.getCount(resourceName, token, countReportQuery)\n\n    const dataReportQuery = new ReportQuery({\n      fields: specification.fields,\n      template: specification.template as Template,\n      queryParams: {\n        ...queryParams,\n        pageSize: count.toString(),\n      },\n      definitionsPath: <string>queryParams.dataProductDefinitionsPath,\n    })\n    const reportData = await services.reportingService.getListWithWarnings(resourceName, token, dataReportQuery)\n    data = reportData.data\n  }\n\n  return data\n}\n\nexport const downloadReport = async ({\n  req,\n  services,\n  res,\n  redirect,\n  loadType,\n}: {\n  req: Request\n  services: Services\n  res: Response\n  redirect: string\n  loadType?: LoadType\n}) => {\n  const { dprUser, token } = LocalsHelper.getValues(res)\n  const {\n    reportId,\n    id,\n    tableId,\n    dataProductDefinitionsPath,\n    reportName,\n    name,\n    cols: columns,\n    sortedAsc,\n    sortColumn,\n  } = req.body\n  const { downloadPermissionService } = services\n  const canDownloadReport = await downloadPermissionService.downloadEnabledForReport(dprUser.id, reportId, id)\n\n  if (!canDownloadReport) {\n    res.redirect(redirect)\n  } else {\n    const definition = await services.reportingService.getDefinition(token, reportId, id, dataProductDefinitionsPath)\n    const queryParams = {\n      dataProductDefinitionsPath,\n      ...(sortedAsc && { sortedAsc }),\n      ...(sortColumn && { sortColumn }),\n    }\n\n    let reportData\n    if (loadType === LoadType.SYNC) {\n      reportData = await downloadSyncData({\n        definition,\n        services,\n        token,\n        queryParams,\n      })\n      if (columns) {\n        reportData = applyColumnsAndSort(reportData, JSON.parse(columns))\n      }\n      reportData = removeHtmlTags(reportData, definition)\n      const fields = definition.variant.specification?.fields || []\n      const keys: KeysList = getKeys(reportData, fields)\n      const csvData = convertToCsv(reportData, { keys, emptyFieldValue: '' })\n\n      res.setHeader('Content-Type', 'application/json')\n      res.setHeader('Content-disposition', `attachment; filename=${reportName}-${name}-${new Date().toISOString()}.csv`)\n      res.end(csvData)\n    } else {\n      logger.info(`Initiating streaming...`)\n      const streamDownloadQueryParams = {\n        dataProductDefinitionsPath,\n        ...(columns && { columns: JSON.parse(columns) }),\n        ...(sortedAsc && { sortedAsc }),\n        ...(sortColumn && { sortColumn }),\n      }\n      await streamDownloadAsyncData({\n        services,\n        token,\n        reportId,\n        id,\n        tableId,\n        queryParams: streamDownloadQueryParams,\n        res,\n      })\n    }\n  }\n}\n\nexport default {\n  downloadReport,\n  getKeys,\n}\n"],"names":["json2csv","ReportQuery","LocalsHelper","LoadType","logger"],"mappings":";;;;;;;;;;AAYA,MAAM,YAAY,GAAG,CAAC,UAA0B,EAAE,OAAwB,KAAI;IAC5E,MAAM,OAAO,GAAGA,iBAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;AAC7C,IAAA,OAAO,OAAO;AAChB,CAAC;MAEY,OAAO,GAAG,CAAC,UAA0B,EAAE,MAAkD,KAAc;IAClH,MAAM,IAAI,GAAa,EAAE;IACzB,MAAM,QAAQ,GAAa,EAAE;AAC7B,IAAA,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,KAAI;QACzB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,KAAI;AAC/B,YAAA,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC;YAChD,IAAI,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AACpC,gBAAA,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;gBAClB,IAAI,CAAC,IAAI,CAAC;AACR,oBAAA,KAAK,EAAE,GAAG;oBACV,KAAK,EAAE,KAAK,CAAC,OAAO;AACrB,iBAAA,CAAC;YACJ;AACF,QAAA,CAAC,CAAC;AACJ,IAAA,CAAC,CAAC;AACF,IAAA,OAAO,IAAI;AACb;AAEA,MAAM,mBAAmB,GAAG,CAAC,IAAoB,EAAE,OAAiB,KAAI;AACtE,IAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAAI;AACtB,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG;AACnB,aAAA,MAAM,CAAC,CAAC,GAAG,KAAK,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;AACrC,aAAA,MAAM,CAAC,CAAC,GAAiB,EAAE,GAAG,KAAI;;YAEjC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC;AACnB,YAAA,OAAO,GAAG;QACZ,CAAC,EAAE,EAAE,CAAC;AACV,IAAA,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,cAAc,GAAG,CACrB,UAA0B,EAC1B,gBAAwE,KACtE;;AAEF,IAAA,MAAM,EAAE,aAAa,EAAE,GAAG,gBAAgB,CAAC,OAAO;IAClD,IAAI,aAAa,EAAE;AACjB,QAAA,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa;QAChC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,KAAI;AACzC,YAAA,OAAO,KAAK,CAAC,IAAI,KAAK,MAAM;AAC9B,QAAA,CAAC,CAAC;AAEF,QAAA,IAAI,UAAU,CAAC,MAAM,EAAE;AACrB,YAAA,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,KAAI;AACnB,gBAAA,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,KAAI;AAC3B,oBAAA,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK;AACtB,oBAAA,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC;oBACxB,IAAI,QAAQ,EAAE;wBACZ,MAAM,SAAS,GAAG,6BAA6B,CAAC,IAAI,CAAC,QAAQ,CAAC;;AAE9D,wBAAA,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,QAAQ;oBAC/C;AACF,gBAAA,CAAC,CAAC;AACF,gBAAA,OAAO,CAAC;AACV,YAAA,CAAC,CAAC;QACJ;IACF;AACA,IAAA,OAAO,UAAU;AACnB,CAAC;AAED,MAAM,uBAAuB,GAAG,OAAO,IAatC,KAAI;AACH,IAAA,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,IAAI;AACzE,IAAA,MAAM,KAAK,GAAsC;AAC/C,QAAA,GAAG,WAAW;KACf;AACD,IAAA,OAAO,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC;AAChG,CAAC;AAED,MAAM,gBAAgB,GAAG,OAAO,IAS/B,KAAI;IACH,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI;AACzD,IAAA,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU;AAC9B,IAAA,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,OAAO;IAC/C,IAAI,IAAI,GAAmB,EAAE;IAE7B,IAAI,aAAa,EAAE;AACjB,QAAA,MAAM,gBAAgB,GAAG,IAAIC,uBAAW,CAAC;YACvC,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,QAAQ,EAAE,aAAa,CAAC,QAAoB;YAC5C,WAAW;YACX,eAAe,EAAU,WAAW,CAAC,0BAA0B;AAChE,SAAA,CAAC;AACF,QAAA,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,YAAY,EAAE,KAAK,EAAE,gBAAgB,CAAC;AAE7F,QAAA,MAAM,eAAe,GAAG,IAAIA,uBAAW,CAAC;YACtC,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,QAAQ,EAAE,aAAa,CAAC,QAAoB;AAC5C,YAAA,WAAW,EAAE;AACX,gBAAA,GAAG,WAAW;AACd,gBAAA,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE;AAC3B,aAAA;YACD,eAAe,EAAU,WAAW,CAAC,0BAA0B;AAChE,SAAA,CAAC;AACF,QAAA,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,YAAY,EAAE,KAAK,EAAE,eAAe,CAAC;AAC5G,QAAA,IAAI,GAAG,UAAU,CAAC,IAAI;IACxB;AAEA,IAAA,OAAO,IAAI;AACb,CAAC;AAEM,MAAM,cAAc,GAAG,OAAO,EACnC,GAAG,EACH,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,QAAQ,GAOT,KAAI;AACH,IAAA,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAGC,oBAAY,CAAC,SAAS,CAAC,GAAG,CAAC;IACtD,MAAM,EACJ,QAAQ,EACR,EAAE,EACF,OAAO,EACP,0BAA0B,EAC1B,UAAU,EACV,IAAI,EACJ,IAAI,EAAE,OAAO,EACb,SAAS,EACT,UAAU,GACX,GAAG,GAAG,CAAC,IAAI;AACZ,IAAA,MAAM,EAAE,yBAAyB,EAAE,GAAG,QAAQ;AAC9C,IAAA,MAAM,iBAAiB,GAAG,MAAM,yBAAyB,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;IAE5G,IAAI,CAAC,iBAAiB,EAAE;AACtB,QAAA,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACxB;SAAO;AACL,QAAA,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,0BAA0B,CAAC;AACjH,QAAA,MAAM,WAAW,GAAG;YAClB,0BAA0B;AAC1B,YAAA,IAAI,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC;AAC/B,YAAA,IAAI,UAAU,IAAI,EAAE,UAAU,EAAE,CAAC;SAClC;AAED,QAAA,IAAI,UAAU;AACd,QAAA,IAAI,QAAQ,KAAKC,oBAAQ,CAAC,IAAI,EAAE;YAC9B,UAAU,GAAG,MAAM,gBAAgB,CAAC;gBAClC,UAAU;gBACV,QAAQ;gBACR,KAAK;gBACL,WAAW;AACZ,aAAA,CAAC;YACF,IAAI,OAAO,EAAE;AACX,gBAAA,UAAU,GAAG,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnE;AACA,YAAA,UAAU,GAAG,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC;YACnD,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,IAAI,EAAE;YAC7D,MAAM,IAAI,GAAa,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC;AAClD,YAAA,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;AAEvE,YAAA,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC;AACjD,YAAA,GAAG,CAAC,SAAS,CAAC,qBAAqB,EAAE,CAAA,qBAAA,EAAwB,UAAU,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA,IAAA,CAAM,CAAC;AAClH,YAAA,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;QAClB;aAAO;AACL,YAAAC,cAAM,CAAC,IAAI,CAAC,CAAA,uBAAA,CAAyB,CAAC;AACtC,YAAA,MAAM,yBAAyB,GAAG;gBAChC,0BAA0B;AAC1B,gBAAA,IAAI,OAAO,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;AAChD,gBAAA,IAAI,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC;AAC/B,gBAAA,IAAI,UAAU,IAAI,EAAE,UAAU,EAAE,CAAC;aAClC;AACD,YAAA,MAAM,uBAAuB,CAAC;gBAC5B,QAAQ;gBACR,KAAK;gBACL,QAAQ;gBACR,EAAE;gBACF,OAAO;AACP,gBAAA,WAAW,EAAE,yBAAyB;gBACtC,GAAG;AACJ,aAAA,CAAC;QACJ;IACF;AACF;AAEA,oBAAe;IACb,cAAc;IACd,OAAO;CACR;;;;;;"}
+{"version":3,"file":"utils.js","sources":["../../../../../../../../../../../src/dpr/routes/journeys/download-report/utils.ts"],"sourcesContent":["import { Response, Request } from 'express'\nimport { Services } from '../../../types/Services'\nimport { LoadType } from '../../../types/UserReports'\nimport { components } from '../../../types/api'\nimport LocalsHelper from '../../../utils/localsHelper'\nimport { Template } from '../../../types/Templates'\nimport ReportQuery from '../../../types/ReportQuery'\nimport logger from '../../../utils/logger'\n\nconst streamDownloadAsyncData = async (args: {\n  services: Services\n  token: string\n  tableId: string\n  reportId: string\n  id: string\n  queryParams: {\n    dataProductDefinitionsPath: string\n    columns: string[]\n    sortedAsc?: string\n    sortColumn?: string\n  }\n  res: Response\n}) => {\n  const { token, services, tableId, reportId, id, queryParams, res } = args\n  const query: Record<string, string | string[]> = {\n    ...queryParams,\n  }\n  return services.reportingService.downloadAsyncReport(token, reportId, id, tableId, query, res)\n}\n\nconst streamDownloadSyncData = async (args: {\n  definition: components['schemas']['SingleVariantReportDefinition']\n  services: Services\n  token: string\n  queryParams: {\n    dataProductDefinitionsPath: string\n    sortedAsc?: string\n    sortColumn?: string\n    columns: string\n  }\n  res: Response\n}) => {\n  const { token, services, queryParams, definition, res } = args\n  const { variant } = definition\n  const { resourceName, specification } = variant\n  if (!specification) {\n    logger.error(`No specification found for definition ID: ${definition.id} variant ID: ${variant.id}`)\n    throw new Error(`No specification found for definition ID: ${definition.id} variant ID: ${variant.id}`)\n  }\n  const reportQuery = new ReportQuery({\n    fields: specification.fields,\n    template: specification.template as Template,\n    queryParams: {\n      ...queryParams,\n    },\n    definitionsPath: <string>queryParams.dataProductDefinitionsPath,\n  })\n  return services.reportingService.downloadSyncReport(token, resourceName, reportQuery, res)\n}\n\nexport const downloadReport = async ({\n  req,\n  services,\n  res,\n  redirect,\n  loadType,\n}: {\n  req: Request\n  services: Services\n  res: Response\n  redirect: string\n  loadType?: LoadType\n}) => {\n  const { dprUser, token } = LocalsHelper.getValues(res)\n  const { reportId, id, tableId, dataProductDefinitionsPath, cols: columns, sortedAsc, sortColumn } = req.body\n  const { downloadPermissionService } = services\n  const canDownloadReport = await downloadPermissionService.downloadEnabledForReport(dprUser.id, reportId, id)\n\n  if (!canDownloadReport) {\n    res.redirect(redirect)\n  } else {\n    const streamDownloadQueryParams = {\n      dataProductDefinitionsPath,\n      ...(columns && { columns: JSON.parse(columns) }),\n      ...(sortedAsc && { sortedAsc }),\n      ...(sortColumn && { sortColumn }),\n    }\n    const definition = await services.reportingService.getDefinition(token, reportId, id, dataProductDefinitionsPath)\n    logger.info(`Initiating streaming...`)\n    if (loadType === LoadType.SYNC) {\n      await streamDownloadSyncData({\n        definition,\n        services,\n        token,\n        queryParams: streamDownloadQueryParams,\n        res,\n      })\n    } else {\n      await streamDownloadAsyncData({\n        services,\n        token,\n        reportId,\n        id,\n        tableId,\n        queryParams: streamDownloadQueryParams,\n        res,\n      })\n    }\n  }\n}\n\nexport default {\n  downloadReport,\n}\n"],"names":["logger","ReportQuery","LocalsHelper","LoadType"],"mappings":";;;;;;;;;AASA,MAAM,uBAAuB,GAAG,OAAO,IAatC,KAAI;AACH,IAAA,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,IAAI;AACzE,IAAA,MAAM,KAAK,GAAsC;AAC/C,QAAA,GAAG,WAAW;KACf;AACD,IAAA,OAAO,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC;AAChG,CAAC;AAED,MAAM,sBAAsB,GAAG,OAAO,IAWrC,KAAI;AACH,IAAA,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI;AAC9D,IAAA,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU;AAC9B,IAAA,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,OAAO;IAC/C,IAAI,CAAC,aAAa,EAAE;AAClB,QAAAA,cAAM,CAAC,KAAK,CAAC,CAAA,0CAAA,EAA6C,UAAU,CAAC,EAAE,CAAA,aAAA,EAAgB,OAAO,CAAC,EAAE,CAAA,CAAE,CAAC;AACpG,QAAA,MAAM,IAAI,KAAK,CAAC,CAAA,0CAAA,EAA6C,UAAU,CAAC,EAAE,CAAA,aAAA,EAAgB,OAAO,CAAC,EAAE,CAAA,CAAE,CAAC;IACzG;AACA,IAAA,MAAM,WAAW,GAAG,IAAIC,uBAAW,CAAC;QAClC,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,QAAQ,EAAE,aAAa,CAAC,QAAoB;AAC5C,QAAA,WAAW,EAAE;AACX,YAAA,GAAG,WAAW;AACf,SAAA;QACD,eAAe,EAAU,WAAW,CAAC,0BAA0B;AAChE,KAAA,CAAC;AACF,IAAA,OAAO,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,CAAC;AAC5F,CAAC;AAEM,MAAM,cAAc,GAAG,OAAO,EACnC,GAAG,EACH,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,QAAQ,GAOT,KAAI;AACH,IAAA,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAGC,oBAAY,CAAC,SAAS,CAAC,GAAG,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,IAAI;AAC5G,IAAA,MAAM,EAAE,yBAAyB,EAAE,GAAG,QAAQ;AAC9C,IAAA,MAAM,iBAAiB,GAAG,MAAM,yBAAyB,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;IAE5G,IAAI,CAAC,iBAAiB,EAAE;AACtB,QAAA,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACxB;SAAO;AACL,QAAA,MAAM,yBAAyB,GAAG;YAChC,0BAA0B;AAC1B,YAAA,IAAI,OAAO,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;AAChD,YAAA,IAAI,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC;AAC/B,YAAA,IAAI,UAAU,IAAI,EAAE,UAAU,EAAE,CAAC;SAClC;AACD,QAAA,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,0BAA0B,CAAC;AACjH,QAAAF,cAAM,CAAC,IAAI,CAAC,CAAA,uBAAA,CAAyB,CAAC;AACtC,QAAA,IAAI,QAAQ,KAAKG,oBAAQ,CAAC,IAAI,EAAE;AAC9B,YAAA,MAAM,sBAAsB,CAAC;gBAC3B,UAAU;gBACV,QAAQ;gBACR,KAAK;AACL,gBAAA,WAAW,EAAE,yBAAyB;gBACtC,GAAG;AACJ,aAAA,CAAC;QACJ;aAAO;AACL,YAAA,MAAM,uBAAuB,CAAC;gBAC5B,QAAQ;gBACR,KAAK;gBACL,QAAQ;gBACR,EAAE;gBACF,OAAO;AACP,gBAAA,WAAW,EAAE,yBAAyB;gBACtC,GAAG;AACJ,aAAA,CAAC;QACJ;IACF;AACF;AAEA,oBAAe;IACb,cAAc;CACf;;;;;"}

package/cjs/dpr/routes/journeys/view-report/async/dashboard/utils.js

@@ -18,6 +18,7 @@ var localsHelper = require('../../../../../utils/localsHelper.js');
 var filtersTypeEnum = require('../../../../../components/_filters/filtersTypeEnum.js');
 var _enum = require('../../../../../components/_filters/filter-input/enum.js');
 var featureFlagsHelper = require('../../../../../utils/featureFlagsHelper.js');
+var validate = require('./validate.js');
 
 const setDashboardActions = (dashboardDefinition, reportDefinition, requestData) => {
     const reportName = reportDefinition.name;
@@ -54,6 +55,8 @@ const getDefinitionData = async ({ req, res, services, queryData, }) => {
     const dataProductDefinitionsPath = req.query['dataProductDefinitionsPath'];
     // Dashboard Definition,
     const dashboardDefinition = await services.dashboardService.getDefinition(token, reportId, id, dataProductDefinitionsPath, queryData);
+    // Validate definition
+    validate.DashboardSchema.parse(dashboardDefinition);
     // Report summary data
     const reportDefinition = await definitionUtils.default.getReportSummary(reportId, services.reportingService, token, dataProductDefinitionsPath);
     // Get the filters