@ministryofjustice/hmpps-digital-prison-reporting-frontend/dpr/types/DprConfig.d.ts

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

interface DprConfig {
    routePrefix?: string;
    dataProductDefinitionsPath?: string;
    /** Interval value in ms
     * - determines how frequently the definitions should be refreshed
     */
    checkDefinitionsInterval?: number;
}
interface ServiceFeatureConfig {
    /** Enable/disable bookmarking
     *  - Bookmark links/buttons will be hidden
     *  - Bookmark service will be disabled
     */
    bookmarking?: boolean;
    /** Enable/disable download
     *  - Download links/buttons will be hidden
     */
    download?: boolean;
    /** Enable/disable feedbackOnDownload
     *  - If disabled, the download functionality will be available immediately
     *  - If enabled, users are required to fill out feedback to gain access to download
     */
    feedbackOnDownload?: boolean;
    /** Enable/disable collections
     *  - collections dropdown will be hidden
     *  - collections service will be disabled
     */
    collections?: boolean;
    /** Enable/disable Missing reports
     *  - Missing reports will be hidden in the report catalogue
     *  - Bookmark service will be disabled
     */
    missingReports?: boolean;
    /** Enable/disable Save defaults
     *  - Save defaults button will be hidden in report filters
     *  - Save defaults service will be disabled
     */
    saveDefaults?: boolean;
    /** Interval value in ms
     * - determines how frequently the definitions should be refreshed
     */
    checkDefinitionsInterval?: number;
    /** Enable/disable subscriptions
     *  - Subscription links/buttons will be hidden
     *  - Subscription service will be disabled
     */
    subscriptions?: boolean;
}

export type { DprConfig, ServiceFeatureConfig };