@ministryofjustice/hmpps-digital-prison-reporting-frontend
Version:
The Digital Prison Reporting Frontend contains templates and code to help display data effectively in UI applications.
508 lines (507 loc) • 20.4 kB
TypeScript
import { z } from 'zod';
export declare const RequestedReportSchema: z.ZodPipe<z.ZodObject<{
reportId: z.ZodString;
variantId: z.ZodOptional<z.ZodString>;
id: z.ZodString;
executionId: z.ZodOptional<z.ZodString>;
tableId: z.ZodOptional<z.ZodString>;
reportName: z.ZodString;
variantName: z.ZodOptional<z.ZodString>;
name: z.ZodOptional<z.ZodString>;
schedule: z.ZodOptional<z.ZodString>;
description: z.ZodString;
status: z.ZodOptional<z.ZodEnum<{
SUBMITTED: import("../../../../types/UserReports").RequestStatus.SUBMITTED;
STARTED: import("../../../../types/UserReports").RequestStatus.STARTED;
PICKED: import("../../../../types/UserReports").RequestStatus.PICKED;
FINISHED: import("../../../../types/UserReports").RequestStatus.FINISHED;
FAILED: import("../../../../types/UserReports").RequestStatus.FAILED;
ABORTED: import("../../../../types/UserReports").RequestStatus.ABORTED;
EXPIRED: import("../../../../types/UserReports").RequestStatus.EXPIRED;
READY: import("../../../../types/UserReports").RequestStatus.READY;
ALL: import("../../../../types/UserReports").RequestStatus.ALL;
}>>;
timestamp: z.ZodObject<{
lastViewed: z.ZodOptional<z.ZodCoercedDate<unknown>>;
requested: z.ZodOptional<z.ZodCoercedDate<unknown>>;
completed: z.ZodOptional<z.ZodCoercedDate<unknown>>;
expired: z.ZodOptional<z.ZodCoercedDate<unknown>>;
failed: z.ZodOptional<z.ZodCoercedDate<unknown>>;
retried: z.ZodOptional<z.ZodCoercedDate<unknown>>;
aborted: z.ZodOptional<z.ZodCoercedDate<unknown>>;
refresh: z.ZodOptional<z.ZodCoercedDate<unknown>>;
}, z.core.$strip>;
dataProductDefinitionsPath: z.ZodOptional<z.ZodString>;
dpdPathFromQuery: z.ZodOptional<z.ZodBoolean>;
query: z.ZodOptional<z.ZodObject<{
data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
summary: z.ZodArray<z.ZodObject<{
name: z.ZodString;
value: z.ZodString;
}, z.core.$catchall<z.ZodUnknown>>>;
}, z.core.$strip>>;
interactiveQuery: z.ZodOptional<z.ZodObject<{
data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
summary: z.ZodArray<z.ZodObject<{
name: z.ZodString;
value: z.ZodString;
}, z.core.$catchall<z.ZodUnknown>>>;
}, z.core.$strip>>;
url: z.ZodOptional<z.ZodObject<{
origin: z.ZodString;
request: z.ZodOptional<z.ZodObject<{
pathname: z.ZodOptional<z.ZodString>;
fullUrl: z.ZodOptional<z.ZodString>;
search: z.ZodOptional<z.ZodString>;
default: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
report: z.ZodOptional<z.ZodObject<{
pathname: z.ZodOptional<z.ZodString>;
fullUrl: z.ZodOptional<z.ZodString>;
search: z.ZodOptional<z.ZodString>;
default: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
polling: z.ZodOptional<z.ZodObject<{
pathname: z.ZodOptional<z.ZodString>;
fullUrl: z.ZodOptional<z.ZodString>;
search: z.ZodOptional<z.ZodString>;
default: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
}, z.core.$strip>>;
type: z.ZodEnum<{
report: import("../../../../types/UserReports").ReportType.REPORT;
dashboard: import("../../../../types/UserReports").ReportType.DASHBOARD;
}>;
loadType: z.ZodOptional<z.ZodEnum<{
sync: import("../../../../types/UserReports").LoadType.SYNC;
async: import("../../../../types/UserReports").LoadType.ASYNC;
}>>;
childExecutionData: z.ZodOptional<z.ZodArray<z.ZodObject<{
variantId: z.ZodString;
executionId: z.ZodOptional<z.ZodString>;
tableId: z.ZodOptional<z.ZodString>;
status: z.ZodOptional<z.ZodEnum<{
SUBMITTED: import("../../../../types/UserReports").RequestStatus.SUBMITTED;
STARTED: import("../../../../types/UserReports").RequestStatus.STARTED;
PICKED: import("../../../../types/UserReports").RequestStatus.PICKED;
FINISHED: import("../../../../types/UserReports").RequestStatus.FINISHED;
FAILED: import("../../../../types/UserReports").RequestStatus.FAILED;
ABORTED: import("../../../../types/UserReports").RequestStatus.ABORTED;
EXPIRED: import("../../../../types/UserReports").RequestStatus.EXPIRED;
READY: import("../../../../types/UserReports").RequestStatus.READY;
ALL: import("../../../../types/UserReports").RequestStatus.ALL;
}>>;
}, z.core.$strip>>>;
errorMessage: z.ZodOptional<z.ZodString>;
filters: z.ZodOptional<z.ZodObject<{
data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
queryString: z.ZodString;
}, z.core.$strip>>;
sortBy: z.ZodOptional<z.ZodObject<{
data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
queryString: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>, z.ZodTransform<{
reportId: string;
id: string;
reportName: string;
description: string;
timestamp: {
lastViewed?: Date | undefined;
requested?: Date | undefined;
completed?: Date | undefined;
expired?: Date | undefined;
failed?: Date | undefined;
retried?: Date | undefined;
aborted?: Date | undefined;
refresh?: Date | undefined;
};
type: import("../../../../types/UserReports").ReportType.REPORT | import("../../../../types/UserReports").ReportType.DASHBOARD;
variantId?: string | undefined;
executionId?: string | undefined;
tableId?: string | undefined;
variantName?: string | undefined;
name?: string | undefined;
schedule?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
dataProductDefinitionsPath?: string | undefined;
dpdPathFromQuery?: boolean | undefined;
query?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
interactiveQuery?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
url?: {
origin: string;
request?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
report?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
polling?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
} | undefined;
loadType?: import("../../../../types/UserReports").LoadType.SYNC | import("../../../../types/UserReports").LoadType.ASYNC | undefined;
childExecutionData?: {
variantId: string;
executionId?: string | undefined;
tableId?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
}[] | undefined;
errorMessage?: string | undefined;
filters?: {
data: Record<string, string>;
queryString: string;
} | undefined;
sortBy?: {
data: Record<string, string>;
queryString: string;
} | undefined;
} & {
name: string;
} & {
name: string;
}, {
reportId: string;
id: string;
reportName: string;
description: string;
timestamp: {
lastViewed?: Date | undefined;
requested?: Date | undefined;
completed?: Date | undefined;
expired?: Date | undefined;
failed?: Date | undefined;
retried?: Date | undefined;
aborted?: Date | undefined;
refresh?: Date | undefined;
};
type: import("../../../../types/UserReports").ReportType.REPORT | import("../../../../types/UserReports").ReportType.DASHBOARD;
variantId?: string | undefined;
executionId?: string | undefined;
tableId?: string | undefined;
variantName?: string | undefined;
name?: string | undefined;
schedule?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
dataProductDefinitionsPath?: string | undefined;
dpdPathFromQuery?: boolean | undefined;
query?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
interactiveQuery?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
url?: {
origin: string;
request?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
report?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
polling?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
} | undefined;
loadType?: import("../../../../types/UserReports").LoadType.SYNC | import("../../../../types/UserReports").LoadType.ASYNC | undefined;
childExecutionData?: {
variantId: string;
executionId?: string | undefined;
tableId?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
}[] | undefined;
errorMessage?: string | undefined;
filters?: {
data: Record<string, string>;
queryString: string;
} | undefined;
sortBy?: {
data: Record<string, string>;
queryString: string;
} | undefined;
}>>;
export declare const RequestedDashboardSchema: z.ZodPipe<z.ZodObject<{
reportId: z.ZodString;
variantId: z.ZodOptional<z.ZodString>;
id: z.ZodString;
executionId: z.ZodOptional<z.ZodString>;
tableId: z.ZodOptional<z.ZodString>;
reportName: z.ZodString;
variantName: z.ZodOptional<z.ZodString>;
name: z.ZodOptional<z.ZodString>;
schedule: z.ZodOptional<z.ZodString>;
description: z.ZodString;
status: z.ZodOptional<z.ZodEnum<{
SUBMITTED: import("../../../../types/UserReports").RequestStatus.SUBMITTED;
STARTED: import("../../../../types/UserReports").RequestStatus.STARTED;
PICKED: import("../../../../types/UserReports").RequestStatus.PICKED;
FINISHED: import("../../../../types/UserReports").RequestStatus.FINISHED;
FAILED: import("../../../../types/UserReports").RequestStatus.FAILED;
ABORTED: import("../../../../types/UserReports").RequestStatus.ABORTED;
EXPIRED: import("../../../../types/UserReports").RequestStatus.EXPIRED;
READY: import("../../../../types/UserReports").RequestStatus.READY;
ALL: import("../../../../types/UserReports").RequestStatus.ALL;
}>>;
timestamp: z.ZodObject<{
lastViewed: z.ZodOptional<z.ZodCoercedDate<unknown>>;
requested: z.ZodOptional<z.ZodCoercedDate<unknown>>;
completed: z.ZodOptional<z.ZodCoercedDate<unknown>>;
expired: z.ZodOptional<z.ZodCoercedDate<unknown>>;
failed: z.ZodOptional<z.ZodCoercedDate<unknown>>;
retried: z.ZodOptional<z.ZodCoercedDate<unknown>>;
aborted: z.ZodOptional<z.ZodCoercedDate<unknown>>;
refresh: z.ZodOptional<z.ZodCoercedDate<unknown>>;
}, z.core.$strip>;
dataProductDefinitionsPath: z.ZodOptional<z.ZodString>;
dpdPathFromQuery: z.ZodOptional<z.ZodBoolean>;
query: z.ZodOptional<z.ZodObject<{
data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
summary: z.ZodArray<z.ZodObject<{
name: z.ZodString;
value: z.ZodString;
}, z.core.$catchall<z.ZodUnknown>>>;
}, z.core.$strip>>;
interactiveQuery: z.ZodOptional<z.ZodObject<{
data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
summary: z.ZodArray<z.ZodObject<{
name: z.ZodString;
value: z.ZodString;
}, z.core.$catchall<z.ZodUnknown>>>;
}, z.core.$strip>>;
url: z.ZodOptional<z.ZodObject<{
origin: z.ZodString;
request: z.ZodOptional<z.ZodObject<{
pathname: z.ZodOptional<z.ZodString>;
fullUrl: z.ZodOptional<z.ZodString>;
search: z.ZodOptional<z.ZodString>;
default: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
report: z.ZodOptional<z.ZodObject<{
pathname: z.ZodOptional<z.ZodString>;
fullUrl: z.ZodOptional<z.ZodString>;
search: z.ZodOptional<z.ZodString>;
default: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
polling: z.ZodOptional<z.ZodObject<{
pathname: z.ZodOptional<z.ZodString>;
fullUrl: z.ZodOptional<z.ZodString>;
search: z.ZodOptional<z.ZodString>;
default: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
}, z.core.$strip>>;
type: z.ZodEnum<{
report: import("../../../../types/UserReports").ReportType.REPORT;
dashboard: import("../../../../types/UserReports").ReportType.DASHBOARD;
}>;
loadType: z.ZodOptional<z.ZodEnum<{
sync: import("../../../../types/UserReports").LoadType.SYNC;
async: import("../../../../types/UserReports").LoadType.ASYNC;
}>>;
childExecutionData: z.ZodOptional<z.ZodArray<z.ZodObject<{
variantId: z.ZodString;
executionId: z.ZodOptional<z.ZodString>;
tableId: z.ZodOptional<z.ZodString>;
status: z.ZodOptional<z.ZodEnum<{
SUBMITTED: import("../../../../types/UserReports").RequestStatus.SUBMITTED;
STARTED: import("../../../../types/UserReports").RequestStatus.STARTED;
PICKED: import("../../../../types/UserReports").RequestStatus.PICKED;
FINISHED: import("../../../../types/UserReports").RequestStatus.FINISHED;
FAILED: import("../../../../types/UserReports").RequestStatus.FAILED;
ABORTED: import("../../../../types/UserReports").RequestStatus.ABORTED;
EXPIRED: import("../../../../types/UserReports").RequestStatus.EXPIRED;
READY: import("../../../../types/UserReports").RequestStatus.READY;
ALL: import("../../../../types/UserReports").RequestStatus.ALL;
}>>;
}, z.core.$strip>>>;
metrics: z.ZodArray<z.ZodObject<{
name: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>, z.ZodTransform<{
reportId: string;
id: string;
reportName: string;
description: string;
timestamp: {
lastViewed?: Date | undefined;
requested?: Date | undefined;
completed?: Date | undefined;
expired?: Date | undefined;
failed?: Date | undefined;
retried?: Date | undefined;
aborted?: Date | undefined;
refresh?: Date | undefined;
};
type: import("../../../../types/UserReports").ReportType.REPORT | import("../../../../types/UserReports").ReportType.DASHBOARD;
metrics: {
name: string;
}[];
variantId?: string | undefined;
executionId?: string | undefined;
tableId?: string | undefined;
variantName?: string | undefined;
name?: string | undefined;
schedule?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
dataProductDefinitionsPath?: string | undefined;
dpdPathFromQuery?: boolean | undefined;
query?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
interactiveQuery?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
url?: {
origin: string;
request?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
report?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
polling?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
} | undefined;
loadType?: import("../../../../types/UserReports").LoadType.SYNC | import("../../../../types/UserReports").LoadType.ASYNC | undefined;
childExecutionData?: {
variantId: string;
executionId?: string | undefined;
tableId?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
}[] | undefined;
} & {
name: string;
}, {
reportId: string;
id: string;
reportName: string;
description: string;
timestamp: {
lastViewed?: Date | undefined;
requested?: Date | undefined;
completed?: Date | undefined;
expired?: Date | undefined;
failed?: Date | undefined;
retried?: Date | undefined;
aborted?: Date | undefined;
refresh?: Date | undefined;
};
type: import("../../../../types/UserReports").ReportType.REPORT | import("../../../../types/UserReports").ReportType.DASHBOARD;
metrics: {
name: string;
}[];
variantId?: string | undefined;
executionId?: string | undefined;
tableId?: string | undefined;
variantName?: string | undefined;
name?: string | undefined;
schedule?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
dataProductDefinitionsPath?: string | undefined;
dpdPathFromQuery?: boolean | undefined;
query?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
interactiveQuery?: {
data: Record<string, string | string[]>;
summary: {
[x: string]: unknown;
name: string;
value: string;
}[];
} | undefined;
url?: {
origin: string;
request?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
report?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
polling?: {
pathname?: string | undefined;
fullUrl?: string | undefined;
search?: string | undefined;
default?: string | undefined;
} | undefined;
} | undefined;
loadType?: import("../../../../types/UserReports").LoadType.SYNC | import("../../../../types/UserReports").LoadType.ASYNC | undefined;
childExecutionData?: {
variantId: string;
executionId?: string | undefined;
tableId?: string | undefined;
status?: import("../../../../types/UserReports").RequestStatus | undefined;
}[] | undefined;
}>>;