@ministryofjustice/hmpps-digital-prison-reporting-frontend
Version:
The Digital Prison Reporting Frontend contains templates and code to help display data effectively in UI applications.
67 lines (66 loc) • 3.3 kB
TypeScript
import { LoadType, ReportType } from '../../../../../types/UserReports';
import { AsyncReportUtilsParams } from '../../../../../types/AsyncReportUtils';
import { components } from '../../../../../types/api';
export declare const renderReport: ({ req, res, services }: AsyncReportUtilsParams) => Promise<{
expired: true;
renderData?: never;
} | {
renderData: {
totals: string;
dataTable: import("../../../../../utils/DataTableBuilder/types").DataTable | import("../../../../../utils/TemplateBuilder/SectionedDataHelper/types").ReportTemplateData;
fields: {
name: string;
display: string;
wordWrap?: "none" | "normal" | "break-words" | null;
filter?: components["schemas"]["FilterDefinition"] | null;
sortable: boolean;
defaultsort: boolean;
sortDirection?: "asc" | "desc" | null;
type: "boolean" | "date" | "double" | "HTML" | "long" | "string" | "time" | "timestamp";
mandatory: boolean;
visible: boolean;
calculated: boolean;
header: boolean;
fieldSource: "specfield" | "paramfield";
}[] | null | undefined;
executionId?: string | undefined;
requestedTimestamp?: string | undefined;
querySummary?: import("../../../../../components/_async/request-details/types").QuerySummaryItem[];
queryData?: NodeJS.Dict<string | string[]> | undefined;
requestUrl?: import("../../../../../types/UserReports").AsyncReportUrlItemData | undefined;
defaultQuery?: string | undefined;
dataProductDefinitionsPath?: string | undefined;
pagination: import("../../../../../components/_reports/report-page/report-template/report-pagination/types").Pagination;
reportName: string;
name: string;
description: string | undefined;
printable: boolean;
schedule?: string | undefined;
classification?: string | undefined;
template?: string;
specification?: components["schemas"]["Specification"];
actions: import("../../../../../components/_reports/report-heading/report-actions/types").ReportAction[];
downloadConfig: import("../../../../../components/_reports/report-heading/report-actions/types").DownloadActionParams | undefined;
bookmarkConfig: {
bookmarkActionEndpoint: string;
showBookmark: boolean;
linkText: string;
linkType: string;
};
subscriptionConfig: import("../../../../../types/AsyncReportUtils").SubscriptionActionConfig | undefined;
feedbackFormHref: string | undefined;
loadType: LoadType;
csrfToken: string;
type: ReportType;
tableId?: string;
id: string;
reportId: string;
count: number;
hasDefaults: boolean | undefined;
saveDefaultsEnabled: boolean;
columns: import("../../../../../components/_reports/report-heading/report-columns/report-columns-form/types").Columns;
filterData: import("../../../../../components/_filters/types").FilterValue[];
appliedFilters: import("../../../../../components/_filters/filters-applied/utils").AppliedFilterChip[];
};
expired?: never;
}>;