@ministryofjustice/hmpps-digital-prison-reporting-frontend/src/dpr/routes/journeys/my-reports/validation.d.ts

The Digital Prison Reporting Frontend contains templates and code to help display data effectively in UI applications.

import { LoadType, ReportType, RequestStatus } from 'src/dpr/types/UserReports';
import { z } from 'zod';
export declare const AsyncReportsTimestampSchema: 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>;
export declare const ParamsConfigSchema: z.ZodObject<{
    data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
    queryString: z.ZodString;
}, z.core.$strip>;
export declare const normalizeStoredReportData: <T extends {
    name?: string | undefined;
    variantName?: string | undefined;
}>(data: T) => T & {
    name: string;
};
export declare const StoredReportDataObjectSchema: 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: RequestStatus.SUBMITTED;
        STARTED: RequestStatus.STARTED;
        PICKED: RequestStatus.PICKED;
        FINISHED: RequestStatus.FINISHED;
        FAILED: RequestStatus.FAILED;
        ABORTED: RequestStatus.ABORTED;
        EXPIRED: RequestStatus.EXPIRED;
        READY: RequestStatus.READY;
        ALL: 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: ReportType.REPORT;
        dashboard: ReportType.DASHBOARD;
    }>;
    loadType: z.ZodOptional<z.ZodEnum<{
        sync: LoadType.SYNC;
        async: 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: RequestStatus.SUBMITTED;
            STARTED: RequestStatus.STARTED;
            PICKED: RequestStatus.PICKED;
            FINISHED: RequestStatus.FINISHED;
            FAILED: RequestStatus.FAILED;
            ABORTED: RequestStatus.ABORTED;
            EXPIRED: RequestStatus.EXPIRED;
            READY: RequestStatus.READY;
            ALL: RequestStatus.ALL;
        }>>;
    }, z.core.$strip>>>;
}, z.core.$strip>;