@isoftdata/utility-dashboard-backend 3.2.21 → 3.2.22

package/README.md

@@ -1,4 +1,5 @@
 # utility-dashboard-backend
+
  A backend utility for formatting and loading dashboard chart and report data to be usable by the [frontend dashboard component](https://github.com/ISoft-Data-Systems/ractive-component-web-dashboard).
 
 ## Installation
@@ -10,7 +11,9 @@ npm i @isoftdata/utility-dashboard-backend
 > Breaking change in version 3: ESM style exports
 
 ## Prerequisites
+>
 > Version 3.Y.Z of the frontend component is required for use with version 2.Y.Z of the backend component.
+
 * A MySQL database schema as outlined in [schema.md](schema.md)
 * A backend that can fetches rows from the chart, report, and report chart tables from the database with their primary keys. Any json columns should be parsed as objects.
 * A connection or pool of connections from the `mysql` NPM module for running the charts' queries
@@ -32,13 +35,14 @@ async formatReportMetadata(mysqlConnection, { report, chartsInReport, session })
 
 ```js
 async function loadReportMetadata({ dashboardReportId, chartId, session }) {
-	const report = await db.dashboardReport.loadById({ dashboardReportId }) // gets a report by its id
-	const chartsInReport = await db.dashboardChart.loadByReport({ dashboardReportId, chartId }) // gets all charts for a specified report, or if `chartId` is specified, only gets that chart for that report.
-	return await formatReportMetadata(db.pool, { report, chartsInReport, session })
+ const report = await db.dashboardReport.loadById({ dashboardReportId }) // gets a report by its id
+ const chartsInReport = await db.dashboardChart.loadByReport({ dashboardReportId, chartId }) // gets all charts for a specified report, or if `chartId` is specified, only gets that chart for that report.
+ return await formatReportMetadata(db.pool, { report, chartsInReport, session })
 }
 ```
 
 #### mysqlConnection
+
 A connection or pool of connections from the `mysql` npm module.
 
 #### report
@@ -102,13 +106,19 @@ Example:
 ```
 
 #### session
+
 Session object from the Auth Module
 
 #### site (optional)
+
 The 'type' of site for the product this is used in. Determines the MySQL table to query for site selection parameters, and used to calculate `siteIdColumn` if that is not specified.
+
 #### siteIdColumn (optional)
+
 The name of the column that stores the site id in the site table. Defaults to `${site}id`.
+
 #### siteNameColumn (optional)
+
 The store name column.
 
 ### formatChartDataForReport
@@ -125,32 +135,37 @@ async formatChartDataForReport(mysqlConnection, { reportParameters, chart, repor
 
 ```js
 async function loadChartDataForReport ({ dashboardReportId, chartId, parameterSelectionList, session }) {
-	const report = await db.dashboardReport.loadById({ dashboardReportId }) // get the report object
-	const chart = await db.dashboardChart.loadById({ chartId }) // get the chart object
-	const reportChart = await db.dashboardReportChart.loadByReportAndChartId({ chartId, dashboardReportId }) // get the report chart for the rank/overrides
-	try {
-		const chartData = await formatChartDataForReport(db.pool, { reportParameters: report.parameters, chart, reportChart, parameterSelectionList, session })
-		return chartData
-	} catch (err) {
-		console.error(err)
-		return { isErrored: true }
-	}
+ const report = await db.dashboardReport.loadById({ dashboardReportId }) // get the report object
+ const chart = await db.dashboardChart.loadById({ chartId }) // get the chart object
+ const reportChart = await db.dashboardReportChart.loadByReportAndChartId({ chartId, dashboardReportId }) // get the report chart for the rank/overrides
+ try {
+  const chartData = await formatChartDataForReport(db.pool, { reportParameters: report.parameters, chart, reportChart, parameterSelectionList, session })
+  return chartData
+ } catch (err) {
+  console.error(err)
+  return { isErrored: true }
+ }
 }
 ```
 
 #### mysqlConnection
+
 A connection or pool of connections from the `mysql` npm module.
 
 #### reportParameters
+
 The `parameters` array from a report object.
 
 #### chartId
+
 The id of a chart row in `wa_dashboard_chart`.
 
 #### parameterSelectionList
+
 The array of selected parameters sent from the client dashboard.
 
 #### session
+
 Session object from the Auth Module
 
 ### loadOutputParameterValues
@@ -166,6 +181,7 @@ async function loadOutputParameterValues(mysqlConnection, { definitionList, sele
 #### Example Usage
 
 #### mysqlConnection
+
 A connection or pool of connections from the `mysql` npm module.
 
 #### definitionList

package/dist/types/parameter.d.ts

@@ -1,7 +1,7 @@
 import type { NamedDateRange } from '@isoftdata/utility-date-time';
 type MaybeArray<T> = T | T[];
 export interface OptionListEntry {
-    id: number | string;
+    id: string;
     name: string;
     rawSql?: boolean;
     fromQuery?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isoftdata/utility-dashboard-backend",
-  "version": "3.2.21",
+  "version": "3.2.22",
   "description": "A utility for formatting chart and report data to be usable by the frontend dashboard component.",
   "main": "dist/index.js",
   "type": "module",