@isoftdata/utility-dashboard-backend 2.4.0 → 2.4.1

package/dist/index.d.ts

@@ -1,82 +1,82 @@
-import { QueryFieldsObject } from './chart-helper.js';
-import { DashboardReportParameter } from './types/parameter';
-import { Session, SiteType } from './types/session';
-import { MultiSeriesOptions, Formatting, Chart, Table, GoogleDataTable, ProcessedFormatting } from './types/chart';
-import { Connection, RowDataPacket } from 'mysql';
-import { Report, ReportInput } from './types/report';
-export * as formatterTemplates from './formatting-templates';
-export { handleFormattingTemplates } from './chart-helper.js';
-export type CustomDataSourceFunction = (query: string, values?: unknown[]) => Promise<{
-    results: RowDataPacket[];
-    fields: QueryFieldsObject;
-}>;
-export type LoadDataTableAndProcessedFormattingOptions = {
-    query: {
-        sql: string;
-        values: unknown[];
-    };
-    multiSeries?: MultiSeriesOptions;
-    formatting?: Formatting;
-    chartType: string;
-    cumulative?: boolean;
-    table?: Table;
-    customDataSource?: CustomDataSourceFunction | null;
-};
-export declare function loadDataTableAndProcessedFormatting(mysqlConnection: Connection, { query: queryObject, multiSeries, formatting, chartType, cumulative, table, customDataSource }: LoadDataTableAndProcessedFormattingOptions): Promise<{
-    dataTable: GoogleDataTable | Table;
-    processedFormatting: ProcessedFormatting;
-    fields: QueryFieldsObject;
-}>;
-export type loadDataTableOptions = {
-    query: {
-        sql: string;
-        values: unknown[];
-    };
-    multiSeries: MultiSeriesOptions;
-    formatting: Formatting;
-    chartType: string;
-};
-export declare function loadDataTable(mysqlConnection: Connection, { query: queryObject, multiSeries, formatting, chartType }: loadDataTableOptions): Promise<GoogleDataTable>;
-type loadOutputParameterValuesOptions = {
-    definitionList: DashboardReportParameter[];
-    selectionList?: Array<Partial<DashboardReportParameter> & Pick<DashboardReportParameter, 'name'>>;
-    forClient?: boolean;
-    session: Session;
-    site?: SiteType;
-    siteIdColumn?: string;
-    siteNameColumn?: string;
-};
-export declare function loadOutputParameterValues(mysqlConnection: Connection, { definitionList, selectionList, forClient, session, site, siteIdColumn, siteNameColumn }: loadOutputParameterValuesOptions): Promise<DashboardReportParameter[]>;
-export declare const parameterRegex: RegExp;
-export declare function parameterizeQuery(queryString: string, parameterValues: DashboardReportParameter[]): {
-    sql: string;
-    values: unknown[];
-};
-export declare function parameterizeUrl(url: string, parameterValues: DashboardReportParameter[]): string;
-type FormatReportMetadataOptions = {
-    report: ReportInput;
-    chartsInReport: Chart[];
-    session: Session;
-    site: SiteType;
-    siteIdColumn?: string;
-    siteNameColumn?: string;
-};
-export declare function formatReportMetadata(mysqlConnection: Connection, { report, chartsInReport, session, site, siteIdColumn, siteNameColumn }: FormatReportMetadataOptions): Promise<Report>;
-type FormatChartDataForReportOptions = {
-    reportParameters: DashboardReportParameter[];
-    chart: Chart;
-    reportChart: {
-        chartId: number;
-        dashboardReportId: number;
-        jsonOverride: Partial<Chart>;
-        rank: number;
-        reportChartId: number;
-    };
-    parameterSelectionList: DashboardReportParameter[];
-    session: Session;
-    site: SiteType;
-    siteIdColumn?: string;
-    siteNameColumn?: string;
-    customDataSource?: CustomDataSourceFunction | null;
-};
-export declare function formatChartDataForReport(mysqlConnection: Connection, { reportParameters, chart, reportChart, parameterSelectionList, session, site, siteIdColumn, siteNameColumn, customDataSource }: FormatChartDataForReportOptions): Promise<Omit<Chart, 'query'>>;
+import { QueryFieldsObject } from './chart-helper.js';
+import { DashboardReportParameter } from './types/parameter';
+import { Session, SiteType } from './types/session';
+import { MultiSeriesOptions, Formatting, Chart, Table, GoogleDataTable, ProcessedFormatting } from './types/chart';
+import { Connection, RowDataPacket } from 'mysql';
+import { Report, ReportInput } from './types/report';
+export * as formatterTemplates from './formatting-templates';
+export { handleFormattingTemplates } from './chart-helper.js';
+export type CustomDataSourceFunction = (query: string, values?: unknown[]) => Promise<{
+    results: RowDataPacket[];
+    fields: QueryFieldsObject;
+}>;
+export type LoadDataTableAndProcessedFormattingOptions = {
+    query: {
+        sql: string;
+        values: unknown[];
+    };
+    multiSeries?: MultiSeriesOptions;
+    formatting?: Formatting;
+    chartType: string;
+    cumulative?: boolean;
+    table?: Table;
+    customDataSource?: CustomDataSourceFunction | null;
+};
+export declare function loadDataTableAndProcessedFormatting(mysqlConnection: Connection, { query: queryObject, multiSeries, formatting, chartType, cumulative, table, customDataSource }: LoadDataTableAndProcessedFormattingOptions): Promise<{
+    dataTable: GoogleDataTable | Table;
+    processedFormatting: ProcessedFormatting;
+    fields: QueryFieldsObject;
+}>;
+export type loadDataTableOptions = {
+    query: {
+        sql: string;
+        values: unknown[];
+    };
+    multiSeries: MultiSeriesOptions;
+    formatting: Formatting;
+    chartType: string;
+};
+export declare function loadDataTable(mysqlConnection: Connection, { query: queryObject, multiSeries, formatting, chartType }: loadDataTableOptions): Promise<GoogleDataTable>;
+type loadOutputParameterValuesOptions = {
+    definitionList: DashboardReportParameter[];
+    selectionList?: Array<Partial<DashboardReportParameter> & Pick<DashboardReportParameter, 'name'>>;
+    forClient?: boolean;
+    session: Session;
+    site?: SiteType;
+    siteIdColumn?: string;
+    siteNameColumn?: string;
+};
+export declare function loadOutputParameterValues(mysqlConnection: Connection, { definitionList, selectionList, forClient, session, site, siteIdColumn, siteNameColumn }: loadOutputParameterValuesOptions): Promise<DashboardReportParameter[]>;
+export declare const parameterRegex: RegExp;
+export declare function parameterizeQuery(queryString: string, parameterValues: DashboardReportParameter[]): {
+    sql: string;
+    values: unknown[];
+};
+export declare function parameterizeUrl(url: string, parameterValues: DashboardReportParameter[]): string;
+type FormatReportMetadataOptions = {
+    report: ReportInput;
+    chartsInReport: Chart[];
+    session: Session;
+    site: SiteType;
+    siteIdColumn?: string;
+    siteNameColumn?: string;
+};
+export declare function formatReportMetadata(mysqlConnection: Connection, { report, chartsInReport, session, site, siteIdColumn, siteNameColumn }: FormatReportMetadataOptions): Promise<Report>;
+type FormatChartDataForReportOptions = {
+    reportParameters: DashboardReportParameter[];
+    chart: Chart;
+    reportChart: {
+        chartId: number;
+        dashboardReportId: number;
+        jsonOverride: Partial<Chart>;
+        rank: number;
+        reportChartId: number;
+    };
+    parameterSelectionList: DashboardReportParameter[];
+    session: Session;
+    site: SiteType;
+    siteIdColumn?: string;
+    siteNameColumn?: string;
+    customDataSource?: CustomDataSourceFunction | null;
+};
+export declare function formatChartDataForReport(mysqlConnection: Connection, { reportParameters, chart, reportChart, parameterSelectionList, session, site, siteIdColumn, siteNameColumn, customDataSource }: FormatChartDataForReportOptions): Promise<Omit<Chart, 'query'>>;