@isoftdata/utility-dashboard-backend 1.4.7 → 1.5.0

package/chart-helper.js

@@ -233,7 +233,7 @@ module.exports = {
 	getRactiveTableDataFormat: (data, fields, formatting) => {
 		const columns = Object.keys(fields).map(field => {
 			// right align currency values
-			if (formatting[field]?.type === 'NumberFormat' && formatting?.[field].format.prefix === '$') {
+			if (formatting?.[field]?.type === 'NumberFormat' && formatting?.[field].format.prefix === '$') {
 				return {
 					property: field,
 					name: field,

package/index.js

@@ -10,6 +10,7 @@ const {
 	getRactiveTableDataFormat: getRactiveTableDataFormat } = require('./chart-helper.js')
 const { datesFromRange } = require('@isoftdata/utility-date-time')
 const formatDate = require('date-fns/format')
+const camelcase = require('camelcase')
 
 const handleChartTypeSpecificQuirks = (chartType, resultSet) => {
 	if (resultSet.length) {
@@ -102,7 +103,7 @@ const loadOptionList = async(mysqlConnection, optionListQuery, optionList = [])
 	]
 }
 
-const loadOutputParameterValues = async(mysqlConnection, { definitionList = [], selectionList = [], forClient = false }) => {
+const loadOutputParameterValues = async(mysqlConnection, { definitionList = [], selectionList = [], forClient = false, session = {} }) => {
 	let parameterValues = []
 
 	// If definitionList is not an Array, there are no parameters, so just return []
@@ -148,6 +149,16 @@ const loadOutputParameterValues = async(mysqlConnection, { definitionList = [],
 					[parameter.name]: parameter.value,
 				}
 			}
+		} else if (definition.type === 'session') {
+			// I think 'name' is the internal name of the parameter, and we should be able to expect that to be the name of the session variable
+			// Or we could have a separate value for the name of the session variable
+			// Might need to make this more complicated to handle nested variables
+			parameter.value = session[camelcase(definition.name)]
+			if (!forClient) {
+				parameter.queryValues = {
+					[parameter.name]: parameter.value,
+				}
+			}
 		}
 
 		parameterValues.push(parameter)
@@ -156,6 +167,12 @@ const loadOutputParameterValues = async(mysqlConnection, { definitionList = [],
 	return parameterValues
 }
 
+/**
+ *
+ * @param {string} query - unparameterized query, with ${placeholders} for parameters
+ * @param {Array<Object>} parameterValues - Parameter values to be plugged into the query
+ * @returns {{sql: string, values: Array}}
+ */
 const parameterizeQuery = (query, parameterValues) => {
 	const queryParameterValues = parameterValues.reduce((acc, val) => {
 		return val.queryValues ? {
@@ -179,9 +196,9 @@ const parameterizeQuery = (query, parameterValues) => {
 }
 
 module.exports = {
-	formatReportMetadata: async(mysqlConnection, { report, chartsInReport }) => {
+	formatReportMetadata: async(mysqlConnection, { report, chartsInReport, session = {} }) => {
 		try {
-			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: report.parameters, forClient: true })
+			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: report.parameters, forClient: true, session })
 
 			return {
 				dashboardReportId: report.dashboardReportId,
@@ -197,9 +214,9 @@ module.exports = {
 			throw err
 		}
 	},
-	formatChartDataForReport: async(mysqlConnection, { reportParameters, chart, reportChart, parameterSelectionList }) => {
+	formatChartDataForReport: async(mysqlConnection, { reportParameters, chart, reportChart, parameterSelectionList, session = {} }) => {
 		try {
-			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: reportParameters, selectionList: parameterSelectionList })
+			const parameterValues = await loadOutputParameterValues(mysqlConnection, { definitionList: reportParameters, selectionList: parameterSelectionList, session })
 			if (reportChart?.jsonOverride?.chartWrapper?.dataTable) {
 				const { dataTable, ...chartWrapper } = reportChart.jsonOverride.chartWrapper
 				reportChart.jsonOverride.chartWrapper = chartWrapper

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@isoftdata/utility-dashboard-backend",
-	"version": "1.4.7",
+	"version": "1.5.0",
 	"description": "A utility for formatting chart and report data to be usable by the frontend dashboard component.",
 	"main": "index.js",
 	"scripts": {
@@ -14,6 +14,7 @@
 		"date-fns": "^2.23.0",
 		"klona": "^1.1.2",
 		"mysql": "^2.18.1",
-		"to-snake-case": "^1.0.0"
+		"to-snake-case": "^1.0.0",
+		"camelcase": "^5.3.1"
 	}
 }

package/schema.md

@@ -15,28 +15,28 @@ share_type | `Enum` | Controls access to reports within the dashboard. Possible
 share_id | `Unsigned integer` | Used in conjunction with `share_type` to control access to reports. When `share_type` is 'everyone', this field is null. Otherwise, it contains the id of the user, group, or store to share the report with. Defaults to `NULL`.
 owner_id | `Unsigned integer` | The `user_account_id` of the user who created the report in the dashboard. This user will always have access to the given report, regardless of its sharing settings, and will be shown as the report owner on the configuration screen. Defaults to `NULL`, which designates it as a default report.
 
-#### Parameter Object
+#### Base Parameter Object
 Property | Type | Description
 ---- | ---- | -----------
 name | `String` | **Required** - a unique name for the parameter. This name is also used to reference param in a query.
 title | `String` | This is used to label the parameter for the user.
 type | `String` | Can be one of `dateRange`, `date`, or `selection`. See the tables below for parameter-type-specific properties
 
-##### `dateRange` Type Properties
+##### `dateRange` Type Parameters
 > In the UI, the user will see a dropdown with the possible date range values(see `default` description below).
 
 Property | Type | Description
 ---- | ---- | -----------
 default | `String` | One of the following values: `'Today'`, `'Yesterday'`, `'Last 7 Days'`, `'Last 30 Days'`, `'Last 90 Days'`, `'Last 365 Days'`, `'This Week'`, `'This Month'`, `'This Quarter'`, `'This Year'`, `'Previous Week'`, `'Previous Month'`, `'Previous Quarter'`, or `'Previous Year'`. If the `default` property is omitted or [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy), `'Last 30 Days'` will be used.
 
-##### `date` Type Properties
+##### `date` Type Parameters
 > In the UI, the user will see a dropdown with a date picker.
 
 Property | Type | Description
 ---- | ---- | -----------
 default | `String` | Can be an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string(eg. `'2021-01-13'`). If the `default` property is omitted or [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy), the today's date will be used.
 
-##### `selection` Type properties
+##### `selection` Type Parameters
 > In the UI, the user will see a dropdown with the `optionList` values(if any) and the values returned from the `optionListQuery`(if any).
 
 Property | Type | Description
@@ -45,6 +45,11 @@ default | `String` | The `id` of the option you'd like to be selected by default
 optionList | `Object` | Each object should have an `id`, and `name`. `id` is the value that will be given to you at query time and `name` is what will be displayed in the dropdown to the user.
 optionListQuery | `String` | A query that selects 2 columns `id` and `name`. The results of this query will be merged with `optionList` and put in the dropdown for the user.
 
+##### `session` Type Parameters
+> These parameters are not shown in the UI since they do not require or allow user input.
+
+The `name` property is camel cased and used to access the variable from the session object.
+
 #### Example
 'dashboard_report_id' | 'report_name' | 'report_title' | 'json' | 'share_type' | 'share_id' | 'owner_id'
 -- | ---- | ---- | ------- | -- | -- | --