@isoftdata/utility-dashboard-backend 1.3.0 → 1.4.1

package/chart-helper.js

@@ -1,254 +1,254 @@
-const { formatterTemplates } = require('./formatter-templates.json')
-const toSnakeCase = require('to-snake-case')
-const mysqlDataTypes = require('mysql/lib/protocol/constants/types')
-const klona = require('klona')
-
-const mysqlToGoogleChartsDataTypeMap = mysqlDataType => {
-	switch (mysqlDataType) {
-		case 'VAR_STRING':
-		case 'STRING':
-		case 'ENUM':
-		case 'VARCHAR':
-			return 'string'
-		case 'DECIMAL':
-		case 'NEWDECIMAL':
-		case 'BIT':
-		case 'TINY':
-		case 'SHORT':
-		case 'LONG':
-		case 'FLOAT':
-		case 'DOUBLE':
-		case 'LONGLONG':
-		case 'INT24':
-		case 'YEAR':
-			return 'number'
-		case 'TIMESTAMP':
-		case 'DATETIME':
-		case 'TIMESTAMP2':
-		case 'DATETIME2':
-			return 'datetime'
-		case 'DATE':
-		case 'NEWDATE':
-			return 'date'
-		case 'TIME':
-		case 'TIME2':
-			return 'timeofday'
-		default:
-			return 'string'
-	}
-}
-
-const makeDataTableCol = (key, fields, role = null) => {
-	return {
-		id: toSnakeCase(key).toLowerCase(),
-		label: key,
-		type: mysqlToGoogleChartsDataTypeMap(fields[key]),
-		role,
-	}
-}
-
-module.exports = {
-	queryWithFields: (connection, query) => { // the only function here that talks to the server at all
-		return new Promise((resolve, reject) => {
-			connection.query(query, (err, results, fields) => {
-				if (err) {
-					reject(err)
-				} else {
-					resolve({
-						results,
-						fields: fields.reduce((sum, field) => {
-							return {
-								...sum,
-								[field.name]: mysqlDataTypes[field.type] || field.type,
-							}
-						}, {}),
-					})
-				}
-			})
-		})
-	},
-	getMultiSeriesData: ({ data: queryResult, seriesOptions, formatting, fields }) => {
-		const { groupXAxisBy, series, value, tooltip } = seriesOptions
-		//Get an array of all of the keys for the series
-		const allOfTheKeysInTheSeries = new Set(queryResult.map(row => row[series]))
-
-		let objectOfAllKeysWithNullValues = {}
-		for (const key of allOfTheKeysInTheSeries) {
-			objectOfAllKeysWithNullValues[key] = null
-			//add in a spot for the tooltips for each column to go
-			if (tooltip) {
-				objectOfAllKeysWithNullValues[`${tooltip} ${key}`] = null
-			}
-		}
-
-		let grouped = {}
-
-		//create objects for each thing they're grouping by
-		// console.time(`create objects for each thing they're grouping by`)
-		for (const row of queryResult) {
-			//if we don't yet have a prop for what we're grouping by, then we need to initialize an object of all null values for it
-			if (!grouped[row[groupXAxisBy]]) {
-				grouped[row[groupXAxisBy]] = klona(objectOfAllKeysWithNullValues) //give nulls for all values by default
-			}
-
-			grouped[row[groupXAxisBy]][row[series]] = row[value]
-			// add the tooltips for each series in each row
-			if (tooltip) {
-				grouped[row[groupXAxisBy]][`${tooltip} ${row[series]}`] = row[tooltip]
-			}
-		}
-		// console.timeEnd(`create objects for each thing they're grouping by`)
-
-		//The mysql field types need to map to our output data
-		let seriesFields = { [groupXAxisBy]: fields[groupXAxisBy] }
-		let seriesFormatting = {}
-		for (const key of allOfTheKeysInTheSeries) {
-			seriesFields[key] = fields[value]
-			//add tooltips here, so a tooltip column is created for every series column
-			if (tooltip) {
-				seriesFields[`${tooltip} ${key}`] = fields[tooltip]
-			}
-			//If there is any formatting applied to the value, we need to apply it to all of the other keys
-			if (formatting && value in formatting) {
-				seriesFormatting[key] = formatting[value]
-			}
-		}
-
-		//turn it back to an array and make sure the grouping column is first as required by a pie chart(at least)
-		// console.time(`group it back together`)
-		let multiSeriesData = []
-		for (const key in grouped) {
-			multiSeriesData.push({
-				[groupXAxisBy]: key,
-				...grouped[key],
-			})
-		}
-		// console.timeEnd(`group it back together`)
-		// console.log(`${multiSeriesData.length} rows with ${Object.keys(multiSeriesData[0]).length} props each.`)
-		return {
-			data: multiSeriesData,
-			formatting: {
-				...formatting,
-				...seriesFormatting,
-			},
-			fields: seriesFields,
-		}
-	},
-	makeNegativeNumbericValuesZero: resultSet => {
-		const numberCols = Object.keys(resultSet[0]).filter(key => typeof resultSet[0][key] === 'number')
-
-		return resultSet.map(row => {
-			numberCols.forEach(col => {
-				if (row[col] < 0) {
-					row[col] = 0
-				}
-			})
-
-			return row
-		})
-	},
-	coerceNullColumn: (columnProp, data, destinationType) => {
-		const hasNullValue = data.find(row => row[columnProp] === null)
-
-		if (hasNullValue) {
-			const rowWithValidValue = data.find(row => row[columnProp] !== null)
-			let nullReplacement = ''
-
-			if ((destinationType && destinationType === 'number') || (typeof rowWithValidValue[columnProp] === 'number')) {
-				nullReplacement = 0
-			}
-
-			return data.map(row => {
-				return {
-					...row,
-					[columnProp]: row[columnProp] ?? nullReplacement,
-				}
-			})
-		} else {
-			return data
-		}
-	},
-	handleFormattingTemplates: formatting => {
-		if (formatting && typeof formatting === 'object') {
-			for (const key in formatting) {
-				if (typeof formatting[key].format === 'string') {
-					if (formatting[key].format in formatterTemplates) {
-						formatting[key].format = formatterTemplates[formatting[key].format]
-					} else {
-						formatting[key].format = {}
-					}
-				}
-			}
-		}
-
-		return formatting
-	},
-	getDataTableFormat: (data, fields, multiSeries) => {
-		let cols = []
-		// domain column for multiseries charts
-		if (multiSeries) {
-			cols = [ makeDataTableCol(multiSeries.groupXAxisBy, fields) ]
-		}
-		// All other columns (including domain for non multiseries charts)
-		for (const key in fields) {
-			if (!multiSeries || key !== multiSeries.groupXAxisBy) {
-				if (multiSeries && multiSeries.tooltip && key.includes(multiSeries.tooltip)) {
-					// If it's a tooltip, set the column's role exlicitly
-					cols.push(makeDataTableCol(key, fields, 'tooltip'))
-				} else {
-					// Otherwise, role is implicitly assigned
-					cols.push(makeDataTableCol(key, fields))
-				}
-			}
-		}
-
-		const rows = data.map(row => {
-			let items = []
-
-			for (const column in row) {
-				items.push({ v: row[column] })
-			}
-
-			return {
-				c: items,
-			}
-		})
-
-		return { cols, rows }
-	},
-	makeDataCumulative: dataTable => {
-		dataTable.rows.forEach((row, rowIndex) => {
-			if (rowIndex > 0) {
-				row.c.forEach((col, colIndex) => {
-					if (colIndex > 0 && col.v == null) {
-						col.v = dataTable.rows[rowIndex - 1].c[colIndex].v
-					} else if (colIndex > 0) {
-						col.v = col.v + dataTable.rows[rowIndex - 1].c[colIndex].v
-					}
-				})
-			}
-		})
-		return dataTable
-	},
-	getRactiveTableDataFormat: (data, fields, formatting) => {
-		const columns = Object.keys(fields).map(field => {
-			// right align currency values
-			if (formatting[field]?.type === 'NumberFormat' && formatting?.[field].format.prefix === '$') {
-				return {
-					property: field,
-					name: field,
-					class: 'text-right',
-				}
-			}
-			return {
-				property: field,
-				name: field,
-			}
-		})
-		return {
-			columns,
-			rows: data,
-			sortedRows: [],
-		}
-	},
-}
+const { formatterTemplates } = require('./formatter-templates.json')
+const toSnakeCase = require('to-snake-case')
+const mysqlDataTypes = require('mysql/lib/protocol/constants/types')
+const klona = require('klona')
+
+const mysqlToGoogleChartsDataTypeMap = mysqlDataType => {
+	switch (mysqlDataType) {
+		case 'VAR_STRING':
+		case 'STRING':
+		case 'ENUM':
+		case 'VARCHAR':
+			return 'string'
+		case 'DECIMAL':
+		case 'NEWDECIMAL':
+		case 'BIT':
+		case 'TINY':
+		case 'SHORT':
+		case 'LONG':
+		case 'FLOAT':
+		case 'DOUBLE':
+		case 'LONGLONG':
+		case 'INT24':
+		case 'YEAR':
+			return 'number'
+		case 'TIMESTAMP':
+		case 'DATETIME':
+		case 'TIMESTAMP2':
+		case 'DATETIME2':
+			return 'datetime'
+		case 'DATE':
+		case 'NEWDATE':
+			return 'date'
+		case 'TIME':
+		case 'TIME2':
+			return 'timeofday'
+		default:
+			return 'string'
+	}
+}
+
+const makeDataTableCol = (key, fields, role = null) => {
+	return {
+		id: toSnakeCase(key).toLowerCase(),
+		label: key,
+		type: mysqlToGoogleChartsDataTypeMap(fields[key]),
+		role,
+	}
+}
+
+module.exports = {
+	queryWithFields: (connection, query) => { // the only function here that talks to the server at all
+		return new Promise((resolve, reject) => {
+			connection.query(query, (err, results, fields) => {
+				if (err) {
+					reject(err)
+				} else {
+					resolve({
+						results,
+						fields: fields.reduce((sum, field) => {
+							return {
+								...sum,
+								[field.name]: mysqlDataTypes[field.type] || field.type,
+							}
+						}, {}),
+					})
+				}
+			})
+		})
+	},
+	getMultiSeriesData: ({ data: queryResult, seriesOptions, formatting, fields }) => {
+		const { groupXAxisBy, series, value, tooltip } = seriesOptions
+		//Get an array of all of the keys for the series
+		const allOfTheKeysInTheSeries = new Set(queryResult.map(row => row[series]))
+
+		let objectOfAllKeysWithNullValues = {}
+		for (const key of allOfTheKeysInTheSeries) {
+			objectOfAllKeysWithNullValues[key] = null
+			//add in a spot for the tooltips for each column to go
+			if (tooltip) {
+				objectOfAllKeysWithNullValues[`${tooltip} ${key}`] = null
+			}
+		}
+
+		let grouped = {}
+
+		//create objects for each thing they're grouping by
+		// console.time(`create objects for each thing they're grouping by`)
+		for (const row of queryResult) {
+			//if we don't yet have a prop for what we're grouping by, then we need to initialize an object of all null values for it
+			if (!grouped[row[groupXAxisBy]]) {
+				grouped[row[groupXAxisBy]] = klona(objectOfAllKeysWithNullValues) //give nulls for all values by default
+			}
+
+			grouped[row[groupXAxisBy]][row[series]] = row[value]
+			// add the tooltips for each series in each row
+			if (tooltip) {
+				grouped[row[groupXAxisBy]][`${tooltip} ${row[series]}`] = row[tooltip]
+			}
+		}
+		// console.timeEnd(`create objects for each thing they're grouping by`)
+
+		//The mysql field types need to map to our output data
+		let seriesFields = { [groupXAxisBy]: fields[groupXAxisBy] }
+		let seriesFormatting = {}
+		for (const key of allOfTheKeysInTheSeries) {
+			seriesFields[key] = fields[value]
+			//add tooltips here, so a tooltip column is created for every series column
+			if (tooltip) {
+				seriesFields[`${tooltip} ${key}`] = fields[tooltip]
+			}
+			//If there is any formatting applied to the value, we need to apply it to all of the other keys
+			if (formatting && value in formatting) {
+				seriesFormatting[key] = formatting[value]
+			}
+		}
+
+		//turn it back to an array and make sure the grouping column is first as required by a pie chart(at least)
+		// console.time(`group it back together`)
+		let multiSeriesData = []
+		for (const key in grouped) {
+			multiSeriesData.push({
+				[groupXAxisBy]: key,
+				...grouped[key],
+			})
+		}
+		// console.timeEnd(`group it back together`)
+		// console.log(`${multiSeriesData.length} rows with ${Object.keys(multiSeriesData[0]).length} props each.`)
+		return {
+			data: multiSeriesData,
+			formatting: {
+				...formatting,
+				...seriesFormatting,
+			},
+			fields: seriesFields,
+		}
+	},
+	makeNegativeNumbericValuesZero: resultSet => {
+		const numberCols = Object.keys(resultSet[0]).filter(key => typeof resultSet[0][key] === 'number')
+
+		return resultSet.map(row => {
+			numberCols.forEach(col => {
+				if (row[col] < 0) {
+					row[col] = 0
+				}
+			})
+
+			return row
+		})
+	},
+	coerceNullColumn: (columnProp, data, destinationType) => {
+		const hasNullValue = data.find(row => row[columnProp] === null)
+
+		if (hasNullValue) {
+			const rowWithValidValue = data.find(row => row[columnProp] !== null)
+			let nullReplacement = ''
+
+			if ((destinationType && destinationType === 'number') || (typeof rowWithValidValue[columnProp] === 'number')) {
+				nullReplacement = 0
+			}
+
+			return data.map(row => {
+				return {
+					...row,
+					[columnProp]: row[columnProp] ?? nullReplacement,
+				}
+			})
+		} else {
+			return data
+		}
+	},
+	handleFormattingTemplates: formatting => {
+		if (formatting && typeof formatting === 'object') {
+			for (const key in formatting) {
+				if (typeof formatting[key].format === 'string') {
+					if (formatting[key].format in formatterTemplates) {
+						formatting[key].format = formatterTemplates[formatting[key].format]
+					} else {
+						formatting[key].format = {}
+					}
+				}
+			}
+		}
+
+		return formatting
+	},
+	getDataTableFormat: (data, fields, multiSeries) => {
+		let cols = []
+		// domain column for multiseries charts
+		if (multiSeries) {
+			cols = [ makeDataTableCol(multiSeries.groupXAxisBy, fields) ]
+		}
+		// All other columns (including domain for non multiseries charts)
+		for (const key in fields) {
+			if (!multiSeries || key !== multiSeries.groupXAxisBy) {
+				if (multiSeries && multiSeries.tooltip && key.includes(multiSeries.tooltip)) {
+					// If it's a tooltip, set the column's role exlicitly
+					cols.push(makeDataTableCol(key, fields, 'tooltip'))
+				} else {
+					// Otherwise, role is implicitly assigned
+					cols.push(makeDataTableCol(key, fields))
+				}
+			}
+		}
+
+		const rows = data.map(row => {
+			let items = []
+
+			for (const column in row) {
+				items.push({ v: row[column] })
+			}
+
+			return {
+				c: items,
+			}
+		})
+
+		return { cols, rows }
+	},
+	makeDataCumulative: dataTable => {
+		dataTable.rows.forEach((row, rowIndex) => {
+			if (rowIndex > 0) {
+				row.c.forEach((col, colIndex) => {
+					if (colIndex > 0 && col.v == null) {
+						col.v = Number(dataTable.rows[rowIndex - 1].c[colIndex].v)
+					} else if (colIndex > 0) {
+						col.v = Number(col.v) + Number(dataTable.rows[rowIndex - 1].c[colIndex].v)
+					}
+				})
+			}
+		})
+		return dataTable
+	},
+	getRactiveTableDataFormat: (data, fields, formatting) => {
+		const columns = Object.keys(fields).map(field => {
+			// right align currency values
+			if (formatting[field]?.type === 'NumberFormat' && formatting?.[field].format.prefix === '$') {
+				return {
+					property: field,
+					name: field,
+					class: 'text-right',
+				}
+			}
+			return {
+				property: field,
+				name: field,
+			}
+		})
+		return {
+			columns,
+			rows: data,
+			sortedRows: [],
+		}
+	},
+}

package/formatter-templates.json

@@ -1,9 +1,15 @@
-{
-	"formatterTemplates": {
-		"CURRENCY": {
-			"prefix": "$",
-			"fractionDigits": 2,
-			"groupingSymbol": ","
-		}
-	}
+{
+	"formatterTemplates": {
+		"CURRENCY": {
+			"prefix": "$",
+			"fractionDigits": 2,
+			"groupingSymbol": ","
+		},
+		"MEDIUMDATE": {
+			"format": "medium"
+		},
+		"LONGDATE": {
+			"format": "long"
+		}
+	}
 }