@hmcts/opal-frontend-common 0.0.90 → 0.0.92

package/types/hmcts-opal-frontend-common-components-abstract-abstract-report-summary-list-base.d.ts

@@ -0,0 +1,198 @@
+import * as _angular_core from '@angular/core';
+import { DateService } from '@hmcts/opal-frontend-common/services/date-service';
+import { IAbstractFormBaseFormErrorSummaryMessage } from '@hmcts/opal-frontend-common/components/abstract/interfaces';
+import { AbstractReportSummaryListDateFilter as AbstractReportSummaryListDateFilter$1 } from '@hmcts/opal-frontend-common/components/abstract/abstract-report-summary-list-base/types';
+
+interface IAbstractReportSummaryListDateFieldIds {
+    days: string;
+    dateFrom: string;
+    dateTo: string;
+}
+
+interface IAbstractReportSummaryListDateFormats {
+    input: string;
+    output: string;
+}
+
+interface IAbstractReportSummaryListDateValidationMessages {
+    customDaysRequired: string;
+    dateRangeRequired: string;
+    invalidDate: string;
+    futureDate: string;
+    dateFromAfterDateTo: string;
+}
+
+interface IAbstractReportSummaryListFilterState {
+    dateFilter: AbstractReportSummaryListDateFilter$1;
+    days: string;
+    dateFrom: string;
+    dateTo: string;
+}
+
+interface IAbstractReportSummaryListQueryState {
+    fromDate: string | null;
+    toDate: string | null;
+}
+
+type AbstractReportSummaryListDateFilter = 'last7Days' | 'customDays' | 'dateRange';
+
+declare abstract class AbstractReportSummaryListBaseComponent<TFilterForm = unknown> {
+    protected readonly dateService: DateService;
+    protected readonly fieldErrors: _angular_core.WritableSignal<Record<string, string>>;
+    protected abstract readonly dateValidationMessages: IAbstractReportSummaryListDateValidationMessages;
+    protected readonly dateFormats: IAbstractReportSummaryListDateFormats;
+    readonly dateFilterLast7Days = "last7Days";
+    readonly dateFilterCustomDays = "customDays";
+    readonly dateFilterDateRange = "dateRange";
+    readonly dateFilter: _angular_core.WritableSignal<AbstractReportSummaryListDateFilter>;
+    readonly errorSummaryMessages: _angular_core.Signal<IAbstractFormBaseFormErrorSummaryMessage[]>;
+    /**
+     * Builds the default report query for the last 7 days.
+     *
+     * @param dateService - The date service used to calculate and format the date range.
+     * @param dateFormats - The input and output date formats used by the consuming application.
+     * @returns A report query state with a last 7 days date range.
+     */
+    static getDefaultReportQuery(dateService: DateService, dateFormats?: IAbstractReportSummaryListDateFormats): IAbstractReportSummaryListQueryState;
+    /**
+     * Builds a report query from the selected report filter state.
+     *
+     * @param filters - The selected report filter state.
+     * @param dateService - The date service used to calculate and format date values.
+     * @param dateFormats - The input and output date formats used by the consuming application.
+     * @returns A report query state suitable for report instance API requests.
+     */
+    static getReportQueryFromFilters(filters: IAbstractReportSummaryListFilterState, dateService: DateService, dateFormats?: IAbstractReportSummaryListDateFormats): IAbstractReportSummaryListQueryState;
+    /**
+     * Gets the display status for a report instance.
+     *
+     * @param status - The report instance status code.
+     * @param records - The number of records in the report instance, where available.
+     * @param displayName - The API-provided status display name, where available.
+     * @returns The display status for the report instance.
+     */
+    static getReportInstanceDisplayStatus(status: string, records?: number | null, displayName?: string | null): string;
+    /**
+     * Converts a report status code into title case display text.
+     *
+     * @param status - The report status code to convert.
+     * @returns A display-friendly status value.
+     */
+    static toReportDisplayStatus(status: string): string;
+    /**
+     * Builds the default report query for the current component instance.
+     *
+     * @returns A report query state with a last 7 days date range.
+     */
+    protected getDefaultReportQuery(): IAbstractReportSummaryListQueryState;
+    /**
+     * Builds a report query from the selected report filter state for the current component instance.
+     *
+     * @param filters - The selected report filter state.
+     * @returns A report query state suitable for report instance API requests.
+     */
+    protected getReportQueryFromFilters(filters: IAbstractReportSummaryListFilterState): IAbstractReportSummaryListQueryState;
+    /**
+     * Reads the consuming application's report filter form into a normalized filter state object.
+     *
+     * @param filtersForm - The consuming application's report filter form to read from.
+     * @returns A normalized report filter state.
+     */
+    protected abstract getFiltersFromForm(filtersForm: TFilterForm): IAbstractReportSummaryListFilterState;
+    /**
+     * Clears consuming application form fields that do not apply to the selected date filter.
+     *
+     * @param filtersForm - The consuming application's report filter form to update.
+     * @param dateFilter - The selected date filter.
+     */
+    protected abstract clearInactiveDateFilterFields(filtersForm: TFilterForm, dateFilter: AbstractReportSummaryListDateFilter | null): void;
+    /**
+     * Builds validation messages for the active report date filter fields.
+     *
+     * @param filters - The selected report filter state.
+     * @param fieldIds - The field ids used by the consuming application template.
+     * @returns A field error map keyed by field id.
+     */
+    protected buildReportDateFieldErrors(filters: IAbstractReportSummaryListFilterState, fieldIds: IAbstractReportSummaryListDateFieldIds): Record<string, string>;
+    /**
+     * Builds validation messages for the custom days report date filter.
+     *
+     * @param filters - The selected report filter state.
+     * @param fieldIds - The field ids used by the consuming application template.
+     * @returns A field error map keyed by field id.
+     */
+    protected buildCustomDaysFieldErrors(filters: IAbstractReportSummaryListFilterState, fieldIds: IAbstractReportSummaryListDateFieldIds): Record<string, string>;
+    /**
+     * Builds validation messages for the date range report date filter.
+     *
+     * @param filters - The selected report filter state.
+     * @param fieldIds - The field ids used by the consuming application template.
+     * @returns A field error map keyed by field id.
+     */
+    protected buildDateRangeFieldErrors(filters: IAbstractReportSummaryListFilterState, fieldIds: IAbstractReportSummaryListDateFieldIds): Record<string, string>;
+    /**
+     * Adds a validation message when no date range boundary has been entered.
+     *
+     * @param errors - The field error map to update.
+     * @param filters - The selected report filter state.
+     * @param fieldIds - The field ids used by the consuming application template.
+     */
+    protected addRequiredDateRangeError(errors: Record<string, string>, filters: IAbstractReportSummaryListFilterState, fieldIds: IAbstractReportSummaryListDateFieldIds): void;
+    /**
+     * Adds validation messages for date values with an invalid format.
+     *
+     * @param errors - The field error map to update.
+     * @param filters - The selected report filter state.
+     * @param fieldIds - The field ids used by the consuming application template.
+     */
+    protected addDateFormatErrors(errors: Record<string, string>, filters: IAbstractReportSummaryListFilterState, fieldIds: IAbstractReportSummaryListDateFieldIds): void;
+    /**
+     * Adds validation messages for date values in the future.
+     *
+     * @param errors - The field error map to update.
+     * @param filters - The selected report filter state.
+     * @param fieldIds - The field ids used by the consuming application template.
+     */
+    protected addFutureDateErrors(errors: Record<string, string>, filters: IAbstractReportSummaryListFilterState, fieldIds: IAbstractReportSummaryListDateFieldIds): void;
+    /**
+     * Adds a validation message when date from is after date to.
+     *
+     * @param errors - The field error map to update.
+     * @param filters - The selected report filter state.
+     * @param fieldIds - The field ids used by the consuming application template.
+     */
+    protected addDateOrderError(errors: Record<string, string>, filters: IAbstractReportSummaryListFilterState, fieldIds: IAbstractReportSummaryListDateFieldIds): void;
+    /**
+     * Checks whether a report date string is invalid.
+     *
+     * @param value - The date value to validate.
+     * @returns True when the date value is invalid, otherwise false.
+     */
+    protected isReportDateInvalid(value: string): boolean;
+    /**
+     * Checks whether a report date string is in the future.
+     *
+     * @param value - The date value to validate.
+     * @returns True when the date value is valid and in the future, otherwise false.
+     */
+    protected isReportDateInFuture(value: string): boolean;
+    /**
+     * Checks whether the report date from value is after the report date to value.
+     *
+     * @param dateFrom - The start date value.
+     * @param dateTo - The end date value.
+     * @returns True when both dates are valid and date from is after date to, otherwise false.
+     */
+    protected isReportDateFromAfterDateTo(dateFrom: string, dateTo: string): boolean;
+    /**
+     * Returns the current validation message for a field.
+     *
+     * @param fieldId - The field id to get an error for.
+     * @returns The field error message, or null when there is no error.
+     */
+    getFieldError(fieldId: string): string | null;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AbstractReportSummaryListBaseComponent<any>, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AbstractReportSummaryListBaseComponent<any>, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
+export { AbstractReportSummaryListBaseComponent };

package/types/hmcts-opal-frontend-common-components-abstract-abstract-sortable-table-pagination.d.ts

@@ -4,6 +4,10 @@ import * as _angular_core from '@angular/core';
 import { AbstractSortableTableComponent } from '@hmcts/opal-frontend-common/components/abstract/abstract-sortable-table';
 
 declare abstract class AbstractSortableTablePaginationComponent extends AbstractSortableTableComponent {
+    /**
+     * Keeps the current page within the available range when the data set or page size changes.
+     */
+    private readonly clampCurrentPageEffect;
     currentPageSignal: _angular_core.WritableSignal<number>;
     itemsPerPageSignal: _angular_core.WritableSignal<number>;
     startIndexComputed: _angular_core.Signal<number>;

package/types/hmcts-opal-frontend-common-services-opal-user-service.d.ts

@@ -26,28 +26,80 @@ interface IOpalUserState {
 declare class OpalUserService {
     private readonly http;
     private readonly globalStore;
+    private inFlightUserState$?;
+    private userStateRequestGeneration;
+    private userStateCacheExpiresAtMilliseconds;
+    /**
+     * Converts the user-state API status into the service domain status.
+     *
+     * @param status - The status value returned by the user-state API.
+     * @returns The mapped domain status, or null when the API status is null.
+     */
     private toOpalUserStatus;
+    /**
+     * Gets the configured user-state domain from the global store.
+     *
+     * @returns The trimmed user-state domain.
+     * @throws When no non-blank user-state domain has been configured.
+     */
     private getUserStateDomain;
     /**
      * Maps the Redis-backed user state response into the existing domain-specific user state shape.
+     *
+     * @param userState - The raw user-state API response.
+     * @returns The mapped user state for the configured domain.
+     * @throws When the response does not include the configured domain.
      */
     private toOpalUserState;
+    /**
+     * Extracts the body from the observed user-state HTTP response.
+     *
+     * @param response - The full HTTP response from the user-state endpoint.
+     * @returns The response body.
+     * @throws When the response body is empty.
+     */
+    private getUserStateResponseBody;
+    /**
+     * Checks whether a user state can be used as a cached logged-in user.
+     *
+     * @param userState - The user state currently held in the global store.
+     * @returns True when the user state contains a positive numeric user ID.
+     */
+    private isValidCachedUserState;
+    /**
+     * Gets the current cached user state when it is populated and unexpired.
+     *
+     * @returns The cached user state, or null when the cache is empty or expired.
+     */
+    private getCachedUserState;
+    /**
+     * Calculates the local cache TTL from the response header and configured maximum TTL.
+     *
+     * @param response - The full HTTP response from the user-state endpoint.
+     * @returns The TTL in milliseconds. A zero response header expires the local cache immediately.
+     */
+    private getUserStateCacheTtlMilliseconds;
+    /**
+     * Invalidates local cache controls and marks existing in-flight requests as stale.
+     */
+    private clearLocalUserStateCache;
     /**
      * Retrieves the logged-in user's state as an observable.
      *
-     * The frontend user-state endpoint is backed by Redis, so this service does not maintain its own cache.
+     * Uses the global store as a local cache until the effective user-state TTL expires, shares concurrent HTTP
+     * requests, and ignores stale responses after the local cache has been invalidated.
      *
      * @returns {Observable<IOpalUserState>} An observable that emits the logged-in user's state.
      */
     getLoggedInUserState(): Observable<IOpalUserState>;
     /**
-     * Resets the global store user to an empty object.
+     * Clears the global store user state and invalidates local user-state cache controls.
      *
-     * Useful for logout/identity switches to avoid reusing stale state.
+     * Useful for logout and identity switches to avoid reusing stale state or accepting stale in-flight responses.
      */
     clearUserStateCache(): void;
     /**
-     * Fetches the latest user state from the Redis-backed frontend endpoint.
+     * Fetches the latest user state from the Redis-backed frontend endpoint, bypassing the current local cache.
      *
      * @returns An Observable that emits the current {@link IOpalUserState}.
      */