@isoftdata/utility-dashboard-backend 1.3.0 → 1.4.1

package/index.js

@@ -1,208 +1,208 @@
-const db = require('@isoftdata/utility-db')
-const {
-	getMultiSeriesData,
-	makeNegativeNumbericValuesZero,
-	coerceNullColumn,
-	handleFormattingTemplates,
-	getDataTableFormat,
-	queryWithFields,
-	makeDataCumulative,
-	getRactiveTableDataFormat: getRactiveTableDataFormat } = require('./chart-helper.js')
-const { datesFromRange } = require('@isoftdata/utility-date-time')
-const formatDate = require('date-fns/format')
-
-const handleChartTypeSpecificQuirks = (chartType, resultSet) => {
-	if (resultSet.length) {
-		switch (chartType) {
-			case 'PieChart':
-				//PieCharts error if you have negative numbers, so we'll just set those to 0
-				resultSet = makeNegativeNumbericValuesZero(resultSet)
-				break
-			case 'TreeMap':
-				//tree charts need the 2nd columns to be not null
-				resultSet = coerceNullColumn(Object.keys(resultSet[0])[1], resultSet)
-				break
-			default:
-				//all charts need the first column to be not null
-				resultSet = coerceNullColumn(Object.keys(resultSet[0])[0], resultSet)
-		}
-	}
-
-	return resultSet
-}
-
-const loadChartData = async (mysqlConnection, { name, query: queryObject, formatting, chartWrapper, multiSeries, parameters, ...theRest }) => { // needs database connection
-	const dataTable = await loadDataTable(mysqlConnection, { query: queryObject, multiSeries, formatting, chartType: chartWrapper.chartType })
-
-	const proccessedFormatting = handleFormattingTemplates(formatting)
-
-	if (chartWrapper.chartType === 'Table') {
-		return {
-			...theRest,
-			chartWrapper,
-			table: dataTable,
-			formatting: proccessedFormatting,
-		}
-	}
-	return {
-		...theRest,
-		chartWrapper: {
-			...chartWrapper,
-			dataTable,
-		},
-		formatting: proccessedFormatting,
-	}
-}
-/*
-*	Returns only the data needed to render out the chart. If chartType is 'Table', it will return it in the format consumed by the ractive table component.
-*	Otherwise, it will return data in the google chart Datatable object literal format.
-*	multiSeries, formatting properties should be deconstructed from the chart object, chartType should be deconstructed from the chart's chartWrapper property
-*/
-const loadDataTable = async (mysqlConnection, { query: queryObject, multiSeries, formatting, chartType }) => {
-	let { results: queryResultSet, fields } = (queryObject && queryObject.sql) ? await queryWithFields(mysqlConnection, queryObject) : { fields: [], results: [] }
-	let data = handleChartTypeSpecificQuirks(chartType, queryResultSet)
-
-	if (chartType.toLowerCase() === 'table') {
-		return getRactiveTableDataFormat(data, fields, formatting)
-	}
-
-	if (multiSeries) {
-		({ data, formatting, fields } = getMultiSeriesData({
-			data,
-			seriesOptions: multiSeries,
-			formatting,
-			fields,
-		}))
-	}
-
-	let dataTable = getDataTableFormat(data, fields, multiSeries) //per the Google Charts docs, the DataTable object literal format is the most performant, so we'll turn it into that format before returning
-
-	// Stacked area charts will have holes / jagged lines if there are nulls in the middle of a column
-	// Presumably we'll also want to be able to have non-cumulative area charts at some point
-	if (chartType === 'AreaChart') {
-		dataTable = makeDataCumulative(dataTable)
-	}
-
-	return dataTable
-}
-
-const loadOptionList = async (mysqlConnection, optionListQuery, optionList = []) => {
-	return [
-		...optionList,
-		// ...(optionListQuery && await query(mysqlConnection, optionListQuery)) || [],
-		...(optionListQuery && await db.query(mysqlConnection, optionListQuery)) || [],
-
-	]
-}
-
-const loadOutputParameterValues = async (mysqlConnection, { definitionList, selectionList = [], forClient = false }) => {
-	let parameterValues = []
-
-	for (const definition of definitionList) {
-		const matchingParameterSelection = selectionList.find(param => param.name === definition.name)
-
-		let parameter = {
-			name: definition.name,
-			type: definition.type,
-			title: definition.title || definition.name,
-			default: definition.default,
-			value: (matchingParameterSelection && matchingParameterSelection.value) || definition.default,
-			queryValues: {},
-		}
-
-		if (definition.type === 'dateRange') {
-			parameter.dates = matchingParameterSelection?.dates || { to: null, from: null }
-			parameter.value = parameter.value || 'Last 30 Days'
-			if (parameter.value !== 'Custom') {
-				parameter.dates = datesFromRange(parameter.value)
-			}
-			if (!forClient) {
-				parameter.queryValues = {
-					[`${parameter.name}_start_date`]: parameter.dates.from,
-					[`${parameter.name}_end_date`]: parameter.dates.to,
-				}
-			}
-		} else if (definition.type === 'selection') {
-			parameter.optionList = await loadOptionList(mysqlConnection, definition.optionListQuery, definition.optionList) // queries db
-			if (!forClient) {
-				parameter.queryValues = {
-					[parameter.name]: parameter.value,
-				}
-			}
-		} else if (definition.type === 'date') {
-			parameter.value = parameter.value || formatDate(new Date(), 'yyyy-MM-dd')
-			if (!forClient) {
-				parameter.queryValues = {
-					[parameter.name]: parameter.value,
-				}
-			}
-		}
-
-		parameterValues.push(parameter)
-	}
-
-	return parameterValues
-}
-
-const parameterizeQuery = (query, parameterValues) => {
-	const queryParameterValues = parameterValues.reduce((acc, val) => {
-		return val.queryValues ? {
-			...acc,
-			...val.queryValues,
-		} : acc
-	}, {})
-
-	//match on a token that starts with ${ and ends with a closing }.
-	//Then include a capture group to get the inner part of that to use as a key
-	const regexp = /\${([^}]+)}/g
-
-	const queryParameterKeys = [...query.matchAll(regexp)].map(([fullToken, insideToken]) => insideToken.trim())
-	//if they put a token in the query that isn't one of the defined parameters of the report, just return null?
-	const queryParameters = queryParameterKeys.map(key => queryParameterValues[key] || null)
-
-	return {
-		sql: query.replace(regexp, '?'),
-		values: queryParameters,
-	}
-}
-
-module.exports = {
-	formatReportMetadata: async (mysqlConnection, { report, chartsInReport }) => {
-		try {
-			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: report.parameters, forClient: true })
-
-			return {
-				dashboardReportId: report.dashboardReportId,
-				name: report.reportName,
-				title: report.reportTitle,
-				charts: chartsInReport,
-				parameterValues,
-				ownerId: report.ownerId,
-			}
-		} catch (err) {
-			console.error(err)
-			throw err
-		}
-	},
-	formatChartDataForReport: async (mysqlConnection, { reportParameters, chart, reportChart, parameterSelectionList }) => {
-		try {
-			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: reportParameters, selectionList: parameterSelectionList })
-			if (reportChart?.jsonOverride?.chartWrapper?.dataTable) {
-				const { dataTable, ...chartWrapper } = reportChart.jsonOverride.chartWrapper
-				reportChart.jsonOverride.chartWrapper = chartWrapper
-			}
-			return await loadChartData(mysqlConnection, {
-				...chart,
-				reportChartId: reportChart.reportChartId,
-				...reportChart.jsonOverride, // overwrites whole chart wrapper :\
-				query: parameterizeQuery(chart.query, parameterValues),
-			})
-		} catch (err) {
-			console.error(err)
-			throw err
-		}
-	},
-	loadOutputParameterValues,
-	loadDataTable,
-	parameterizeQuery,
-}
+const db = require('@isoftdata/utility-db')
+const {
+	getMultiSeriesData,
+	makeNegativeNumbericValuesZero,
+	coerceNullColumn,
+	handleFormattingTemplates,
+	getDataTableFormat,
+	queryWithFields,
+	makeDataCumulative,
+	getRactiveTableDataFormat: getRactiveTableDataFormat } = require('./chart-helper.js')
+const { datesFromRange } = require('@isoftdata/utility-date-time')
+const formatDate = require('date-fns/format')
+
+const handleChartTypeSpecificQuirks = (chartType, resultSet) => {
+	if (resultSet.length) {
+		switch (chartType) {
+			case 'PieChart':
+				//PieCharts error if you have negative numbers, so we'll just set those to 0
+				resultSet = makeNegativeNumbericValuesZero(resultSet)
+				break
+			case 'TreeMap':
+				//tree charts need the 2nd columns to be not null
+				resultSet = coerceNullColumn(Object.keys(resultSet[0])[1], resultSet)
+				break
+			default:
+				//all charts need the first column to be not null
+				resultSet = coerceNullColumn(Object.keys(resultSet[0])[0], resultSet)
+		}
+	}
+
+	return resultSet
+}
+
+const loadChartData = async (mysqlConnection, { name, query: queryObject, formatting, chartWrapper, multiSeries, parameters, ...theRest }) => { // needs database connection
+	const dataTable = await loadDataTable(mysqlConnection, { query: queryObject, multiSeries, formatting, chartType: chartWrapper.chartType })
+
+	const proccessedFormatting = handleFormattingTemplates(formatting)
+
+	if (chartWrapper.chartType === 'Table') {
+		return {
+			...theRest,
+			chartWrapper,
+			table: dataTable,
+			formatting: proccessedFormatting,
+		}
+	}
+	return {
+		...theRest,
+		chartWrapper: {
+			...chartWrapper,
+			dataTable,
+		},
+		formatting: proccessedFormatting,
+	}
+}
+/*
+*	Returns only the data needed to render out the chart. If chartType is 'Table', it will return it in the format consumed by the ractive table component.
+*	Otherwise, it will return data in the google chart Datatable object literal format.
+*	multiSeries, formatting properties should be deconstructed from the chart object, chartType should be deconstructed from the chart's chartWrapper property
+*/
+const loadDataTable = async (mysqlConnection, { query: queryObject, multiSeries, formatting, chartType }) => {
+	let { results: queryResultSet, fields } = (queryObject && queryObject.sql) ? await queryWithFields(mysqlConnection, queryObject) : { fields: [], results: [] }
+	let data = handleChartTypeSpecificQuirks(chartType, queryResultSet)
+
+	if (chartType.toLowerCase() === 'table') {
+		return getRactiveTableDataFormat(data, fields, formatting)
+	}
+
+	if (multiSeries) {
+		({ data, formatting, fields } = getMultiSeriesData({
+			data,
+			seriesOptions: multiSeries,
+			formatting,
+			fields,
+		}))
+	}
+
+	let dataTable = getDataTableFormat(data, fields, multiSeries) //per the Google Charts docs, the DataTable object literal format is the most performant, so we'll turn it into that format before returning
+
+	// Stacked area charts will have holes / jagged lines if there are nulls in the middle of a column
+	// Presumably we'll also want to be able to have non-cumulative area charts at some point
+	if (chartType === 'AreaChart') {
+		dataTable = makeDataCumulative(dataTable)
+	}
+
+	return dataTable
+}
+
+const loadOptionList = async (mysqlConnection, optionListQuery, optionList = []) => {
+	return [
+		...optionList,
+		// ...(optionListQuery && await query(mysqlConnection, optionListQuery)) || [],
+		...(optionListQuery && await db.query(mysqlConnection, optionListQuery)) || [],
+
+	]
+}
+
+const loadOutputParameterValues = async (mysqlConnection, { definitionList, selectionList = [], forClient = false }) => {
+	let parameterValues = []
+
+	for (const definition of definitionList) {
+		const matchingParameterSelection = selectionList.find(param => param.name === definition.name)
+
+		let parameter = {
+			name: definition.name,
+			type: definition.type,
+			title: definition.title || definition.name,
+			default: definition.default,
+			value: (matchingParameterSelection && matchingParameterSelection.value) || definition.default,
+			queryValues: {},
+		}
+
+		if (definition.type === 'dateRange') {
+			parameter.dates = matchingParameterSelection?.dates || { to: null, from: null }
+			parameter.value = parameter.value || 'Last 30 Days'
+			if (parameter.value !== 'Custom') {
+				parameter.dates = datesFromRange(parameter.value)
+			}
+			if (!forClient) {
+				parameter.queryValues = {
+					[`${parameter.name}_start_date`]: parameter.dates.from,
+					[`${parameter.name}_end_date`]: parameter.dates.to,
+				}
+			}
+		} else if (definition.type === 'selection') {
+			parameter.optionList = await loadOptionList(mysqlConnection, definition.optionListQuery, definition.optionList) // queries db
+			if (!forClient) {
+				parameter.queryValues = {
+					[parameter.name]: parameter.value,
+				}
+			}
+		} else if (definition.type === 'date') {
+			parameter.value = parameter.value || formatDate(new Date(), 'yyyy-MM-dd')
+			if (!forClient) {
+				parameter.queryValues = {
+					[parameter.name]: parameter.value,
+				}
+			}
+		}
+
+		parameterValues.push(parameter)
+	}
+
+	return parameterValues
+}
+
+const parameterizeQuery = (query, parameterValues) => {
+	const queryParameterValues = parameterValues.reduce((acc, val) => {
+		return val.queryValues ? {
+			...acc,
+			...val.queryValues,
+		} : acc
+	}, {})
+
+	//match on a token that starts with ${ and ends with a closing }.
+	//Then include a capture group to get the inner part of that to use as a key
+	const regexp = /\${([^}]+)}/g
+
+	const queryParameterKeys = [...query.matchAll(regexp)].map(([fullToken, insideToken]) => insideToken.trim())
+	//if they put a token in the query that isn't one of the defined parameters of the report, just return null?
+	const queryParameters = queryParameterKeys.map(key => queryParameterValues[key] || null)
+
+	return {
+		sql: query.replace(regexp, '?'),
+		values: queryParameters,
+	}
+}
+
+module.exports = {
+	formatReportMetadata: async (mysqlConnection, { report, chartsInReport }) => {
+		try {
+			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: report.parameters, forClient: true })
+
+			return {
+				dashboardReportId: report.dashboardReportId,
+				name: report.reportName,
+				title: report.reportTitle,
+				charts: chartsInReport,
+				parameterValues,
+				ownerId: report.ownerId,
+			}
+		} catch (err) {
+			console.error(err)
+			throw err
+		}
+	},
+	formatChartDataForReport: async (mysqlConnection, { reportParameters, chart, reportChart, parameterSelectionList }) => {
+		try {
+			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: reportParameters, selectionList: parameterSelectionList })
+			if (reportChart?.jsonOverride?.chartWrapper?.dataTable) {
+				const { dataTable, ...chartWrapper } = reportChart.jsonOverride.chartWrapper
+				reportChart.jsonOverride.chartWrapper = chartWrapper
+			}
+			return await loadChartData(mysqlConnection, {
+				...chart,
+				reportChartId: reportChart.reportChartId,
+				...reportChart.jsonOverride, // overwrites whole chart wrapper :\
+				query: parameterizeQuery(chart.query, parameterValues),
+			})
+		} catch (err) {
+			console.error(err)
+			throw err
+		}
+	},
+	loadOutputParameterValues,
+	loadDataTable,
+	parameterizeQuery,
+}

package/package.json

@@ -1,19 +1,19 @@
-{
-	"name": "@isoftdata/utility-dashboard-backend",
-	"version": "1.3.0",
-	"description": "A utility for formatting chart and report data to be usable by the frontend dashboard component.",
-	"main": "index.js",
-	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
-	},
-	"author": "Charles Kaup",
-	"license": "ISC",
-	"dependencies": {
-		"@isoftdata/utility-date-time": "^2.0.3",
-		"@isoftdata/utility-db": "^1.4.0",
-		"date-fns": "^2.23.0",
-		"klona": "^1.1.2",
-		"mysql": "^2.18.1",
-		"to-snake-case": "^1.0.0"
-	}
-}
+{
+	"name": "@isoftdata/utility-dashboard-backend",
+	"version": "1.4.1",
+	"description": "A utility for formatting chart and report data to be usable by the frontend dashboard component.",
+	"main": "index.js",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"author": "Charles Kaup",
+	"license": "ISC",
+	"dependencies": {
+		"@isoftdata/utility-date-time": "^2.0.3",
+		"@isoftdata/utility-db": "^1.4.0",
+		"date-fns": "^2.23.0",
+		"klona": "^1.1.2",
+		"mysql": "^2.18.1",
+		"to-snake-case": "^1.0.0"
+	}
+}