@isoftdata/utility-dashboard-backend 4.2.2 → 4.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -7,7 +7,7 @@ import type { DashboardReportParameter, DashboardReportParameterInput } from './
7
7
  import type { Session, SiteType } from './types/session.js';
8
8
  import type { MultiSeriesOptions, Formatting, Chart, Table, GoogleDataTable, ProcessedFormatting, ChartJson } from './types/chart.js';
9
9
  import type { Report, ReportInput } from './types/report.js';
10
- import type { PartialDeep } from 'type-fest';
10
+ import type { DistributedOmit, PartialDeep } from 'type-fest';
11
11
  export * as formatterTemplates from './formatting-templates.js';
12
12
  export { handleFormattingTemplates } from './chart-helper.js';
13
13
  export type CustomDataSourceFunction = (query: string, values?: unknown[]) => Promise<{
@@ -85,4 +85,4 @@ export type FormatChartDataForReportOptions = {
85
85
  siteNameColumn?: string;
86
86
  customDataSource?: CustomDataSourceFunction | null;
87
87
  };
88
- export declare function formatChartDataForReport(mysqlConnection: DatabaseConnectionInterface, { reportParameters, chart, reportChart, parameterSelectionList, session, site, siteIdColumn, siteNameColumn, customDataSource, }: FormatChartDataForReportOptions): Promise<Omit<Chart, 'query'>>;
88
+ export declare function formatChartDataForReport(mysqlConnection: DatabaseConnectionInterface, { reportParameters, chart, reportChart, parameterSelectionList, session, site, siteIdColumn, siteNameColumn, customDataSource, }: FormatChartDataForReportOptions): Promise<DistributedOmit<Chart, 'query'>>;
@@ -1,4 +1,5 @@
1
1
  import type { NamedDateRange } from '@isoftdata/utility-date-time';
2
+ import type { DistributedOmit } from 'type-fest';
2
3
  type MaybeArray<T> = T | T[];
3
4
  export interface OptionListEntry {
4
5
  id: string;
@@ -39,6 +40,5 @@ export interface DashboardReportSessionParameter extends DashboardReportBasePara
39
40
  type: 'session';
40
41
  }
41
42
  export type DashboardReportParameter = DashboardReportDateParameter | DashboardReportSelectionParameter | DashboardReportSiteSelectionParameter | DashboardReportDateRangeParameter | DashboardReportSessionParameter;
42
- type OmitOutputProperties<T extends DashboardReportBaseParameter> = Omit<T, 'value' | 'queryValues' | 'dates'>;
43
- export type DashboardReportParameterInput = OmitOutputProperties<DashboardReportDateParameter> | OmitOutputProperties<DashboardReportSelectionParameter> | OmitOutputProperties<DashboardReportSiteSelectionParameter> | OmitOutputProperties<DashboardReportDateRangeParameter> | OmitOutputProperties<DashboardReportSessionParameter>;
43
+ export type DashboardReportParameterInput = DistributedOmit<DashboardReportDateParameter | DashboardReportSelectionParameter | DashboardReportSiteSelectionParameter | DashboardReportDateRangeParameter | DashboardReportSessionParameter, 'value' | 'queryValues' | 'dates'>;
44
44
  export {};
@@ -11,6 +11,7 @@ export interface Report {
11
11
  autoRefreshInterval: number | null;
12
12
  hideParameters?: boolean;
13
13
  bodyStyle?: ReportBodyStyleOptions;
14
+ backgroundFileId?: number | null;
14
15
  }
15
16
  export interface ReportInput {
16
17
  dashboardReportId: number;
@@ -23,6 +24,7 @@ export interface ReportInput {
23
24
  autoRefreshInterval: number | null;
24
25
  parameters: DashboardReportParameter[];
25
26
  bodyStyle?: ReportBodyStyleOptions;
27
+ backgroundFileId?: number | null;
26
28
  }
27
29
  export type ShareType = 'everyone' | 'store' | 'user' | 'group';
28
30
  export type ReportBodyStyleOptions = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@isoftdata/utility-dashboard-backend",
3
- "version": "4.2.2",
3
+ "version": "4.2.4",
4
4
  "description": "A utility for formatting chart and report data to be usable by the frontend dashboard component.",
5
5
  "main": "dist/index.js",
6
6
  "type": "module",