@olenbetong/appframe-core 2.11.9 → 2.12.0

package/src/report/types.ts

@@ -0,0 +1,135 @@
+/**
+ * Report metadata — the shape of a report and its parameters, as the Windows
+ * report launcher understands them.
+ *
+ * The loading lives in `useReport` in `@olenbetong/appframe-react`; everything
+ * here is pure.
+ */
+
+/**
+ * The parameter types `sviw_WinClient_ReportsParameters.DataType` uses. The
+ * Windows launcher creates a text edit, a numeric edit, a date edit or a check
+ * edit from this, unless the parameter has a lookup or a fixed item list.
+ */
+export type ReportParameterType = "String" | "Integer" | "Double" | "Date" | "Boolean";
+
+/** How a parameter should be edited. Derived from the metadata, not stored. */
+export type ReportParameterEditor = "text" | "number" | "date" | "boolean" | "select" | "lookup";
+
+/** A column selected by an `afRecordSource`. */
+export type ReportRecordSourceColumn = {
+	name: string;
+	/** The field type the web data API expects, mapped from the CLR type. */
+	type: "string" | "number" | "boolean" | "date";
+};
+
+/** A lookup source parsed out of a parameter's `afRecordSource` XML. */
+export type ReportRecordSource = {
+	viewName: string;
+	/** The columns the record source selects, in order. */
+	columns: ReportRecordSourceColumn[];
+	whereClause: string | null;
+	filterString: string | null;
+	maxRecords: number | null;
+};
+
+/** A report parameter, ready to be rendered. */
+export type ReportParameter = {
+	name: string;
+	/** Label shown next to the editor. Falls back to the name. */
+	label: string;
+	/** Help text for the editor. */
+	description: string | null;
+	type: ReportParameterType;
+	editor: ReportParameterEditor;
+	/**
+	 * The raw default. A value matching `^[a-z]stp_` names a stored procedure
+	 * that produces the default; see `isProcedureDefault`.
+	 */
+	defaultValue: string | null;
+	/** Fixed list of choices, one per line in `Items`. */
+	items: string[];
+	/** Lookup source, when the parameter is backed by a view. */
+	recordSource: ReportRecordSource | null;
+	/** The lookup column holding the value to send to the report. */
+	valueMember: string | null;
+	/** The lookup column to show. The first column that is not the value member. */
+	displayMember: string | null;
+	sortOrder: number;
+	/** Preferred size of the lookup popup, in pixels. */
+	lookupWidth: number | null;
+	lookupHeight: number | null;
+};
+
+/** A raw `sviw_WinClient_ReportsParameters` record. */
+export type ReportParameterRecord = {
+	Name?: string | null;
+	Label?: string | null;
+	Description?: string | null;
+	DataType?: string | null;
+	DefaultValue?: string | null;
+	Items?: string | null;
+	RecordSource?: string | null;
+	ValueMember?: string | null;
+	ValueListViewName?: string | null;
+	SortOrder?: number | null;
+	LookupWidth?: number | null;
+	LookupHeight?: number | null;
+};
+
+/** Output formats a report can be rendered to. */
+export type ReportFormat = "PDF" | "XLSX" | "XLS" | "CSV" | "HTML" | "RTF" | "MHT" | "TEXT" | "IMAGE";
+
+/** A report, as the launcher needs it. */
+export type Report = {
+	reportId: string;
+	/**
+	 * The report's number, which is what users refer to a report by — it is
+	 * printed in the footer of every report.
+	 */
+	shortId: number | null;
+	title: string | null;
+	description: string | null;
+	/** The view the report reads, resolved from its record source. */
+	viewName: string | null;
+	/**
+	 * The filter the report is designed with. Used unless the launcher is opened
+	 * with an explicit filter.
+	 */
+	initialFilter: string | null;
+	/** True when the report has a title band the user may override. */
+	hasTitle: boolean;
+	/** True when the report has a header band the user may fill in. */
+	hasHeader: boolean;
+	/** The formats the report may be rendered to, in the order they are offered. */
+	formats: ReportFormat[];
+	timeout: number | null;
+};
+
+/**
+ * A raw `sviw_WinClient_MyReports` record, optionally merged with the
+ * `HasTitle` / `HasHeader` columns from `sviw_WinClient_ReportsWeb`.
+ */
+export type ReportRecord = {
+	ReportID?: string | null;
+	ShortID?: number | null;
+	Title?: string | null;
+	Description?: string | null;
+	RecordSource?: string | null;
+	FormatPDF?: boolean | number | null;
+	FormatCSV?: boolean | number | null;
+	FormatHTML?: boolean | number | null;
+	FormatRTF?: boolean | number | null;
+	FormatMHT?: boolean | number | null;
+	FormatTEXT?: boolean | number | null;
+	FormatIMAGE?: boolean | number | null;
+	HasTitle?: boolean | number | null;
+	HasHeader?: boolean | number | null;
+	Timeout?: number | null;
+};
+
+/** A parameter value, as sent to the render endpoint. */
+export type ReportParameterValue = string | number | boolean | null;
+
+/** Parameter values by parameter name. */
+export type ReportParameterValues = Record<string, ReportParameterValue>;