@hmcts/opal-frontend-common 0.0.17 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/opal-frontend-common",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "license": "MIT",
   "peerDependencies": {
     "@angular/common": "^18.2.0 || ^19.0.0",
@@ -269,16 +269,16 @@
       "types": "./components/govuk/helpers/index.d.ts",
       "default": "./fesm2022/hmcts-opal-frontend-common-components-govuk-helpers.mjs"
     },
+    "./components/moj/moj-alert": {
+      "import": "./fesm2022/hmcts-opal-frontend-common-components-moj-moj-alert.mjs",
+      "types": "./components/moj/moj-alert/index.d.ts",
+      "default": "./fesm2022/hmcts-opal-frontend-common-components-moj-moj-alert.mjs"
+    },
     "./components/moj/moj-badge": {
       "import": "./fesm2022/hmcts-opal-frontend-common-components-moj-moj-badge.mjs",
       "types": "./components/moj/moj-badge/index.d.ts",
       "default": "./fesm2022/hmcts-opal-frontend-common-components-moj-moj-badge.mjs"
     },
-    "./components/moj/moj-banner": {
-      "import": "./fesm2022/hmcts-opal-frontend-common-components-moj-moj-banner.mjs",
-      "types": "./components/moj/moj-banner/index.d.ts",
-      "default": "./fesm2022/hmcts-opal-frontend-common-components-moj-moj-banner.mjs"
-    },
     "./components/moj/moj-button-menu": {
       "import": "./fesm2022/hmcts-opal-frontend-common-components-moj-moj-button-menu.mjs",
       "types": "./components/moj/moj-button-menu/index.d.ts",

package/pages/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/pages" />
-export * from './public-api';
+import { Routes } from '@angular/router';
+
+declare const routing: Routes;
+
+export { routing };

package/pages/routing/constants/index.d.ts

@@ -1,5 +1,7 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/pages/routing/constants" />
-export * from './public-api';
+import { IPagesRoutingPaths } from '@hmcts/opal-frontend-common/pages/routing/interfaces';
+
+declare const PAGES_ROUTING_PATHS: IPagesRoutingPaths;
+
+declare const PAGES_ROUTING_TITLES: IPagesRoutingPaths;
+
+export { PAGES_ROUTING_PATHS, PAGES_ROUTING_TITLES };

package/pages/routing/interfaces/index.d.ts

@@ -1,5 +1,28 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/pages/routing/interfaces" />
-export * from './public-api';
+interface IChildRoutingPaths {
+    root: string;
+    children: {
+        [key: string]: string;
+    };
+}
+
+interface INestedRoutes {
+    nextRoute: string;
+    buttonText: string;
+}
+
+interface IParentRoutingPaths {
+    root: string;
+    children: {
+        [key: string]: IChildRoutingPaths;
+    };
+}
+
+interface IPagesRoutingPaths extends IChildRoutingPaths {
+    children: {
+        accessDenied: string;
+        signIn: string;
+        signInStub: string;
+    };
+}
+
+export type { IChildRoutingPaths, INestedRoutes, IPagesRoutingPaths, IParentRoutingPaths };

package/pipes/date-format/index.d.ts

@@ -1,5 +1,13 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/pipes/date-format" />
-export * from './public-api';
+import * as i0 from '@angular/core';
+import { PipeTransform } from '@angular/core';
+import { DateService } from '@hmcts/opal-frontend-common/services/date-service';
+
+declare class DateFormatPipe implements PipeTransform {
+    private readonly dateService;
+    constructor(dateService: DateService);
+    transform(value: string | null | undefined, inputFormat: string, outputFormat: string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DateFormatPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<DateFormatPipe, "dateFormat", true>;
+}
+
+export { DateFormatPipe };

package/pipes/days-ago/index.d.ts

@@ -1,5 +1,10 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/pipes/days-ago" />
-export * from './public-api';
+import * as i0 from '@angular/core';
+import { PipeTransform } from '@angular/core';
+
+declare class DaysAgoPipe implements PipeTransform {
+    transform(value: number): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DaysAgoPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<DaysAgoPipe, "daysAgo", true>;
+}
+
+export { DaysAgoPipe };

package/resolvers/title/index.d.ts

@@ -1,5 +1,13 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/resolvers/title" />
-export * from './public-api';
+import { Resolve, ActivatedRouteSnapshot } from '@angular/router';
+import { Title } from '@angular/platform-browser';
+import * as i0 from '@angular/core';
+
+declare class TitleResolver implements Resolve<void> {
+    private readonly titleService;
+    constructor(titleService: Title);
+    resolve(route: ActivatedRouteSnapshot): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TitleResolver, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TitleResolver>;
+}
+
+export { TitleResolver };

package/resolvers/user-state/index.d.ts

@@ -1,5 +1,10 @@
+import { ResolveFn } from '@angular/router';
+import { ISessionUserState } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+
 /**
- * Generated bundle index. Do not edit.
+ * Resolver function for retrieving the user state.
+ * @returns A promise that resolves to the user state.
  */
-/// <amd-module name="@hmcts/opal-frontend-common/resolvers/user-state" />
-export * from './public-api';
+declare const userStateResolver: ResolveFn<ISessionUserState>;
+
+export { userStateResolver };

package/services/app-initializer-service/index.d.ts

@@ -1,5 +1,28 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/app-initializer-service" />
-export * from './public-api';
+import * as i0 from '@angular/core';
+
+declare class AppInitializerService {
+    private readonly transferStateService;
+    private readonly appInsightsService;
+    /**
+     * Initializes the SSO (Single Sign-On) enabled state.
+     * This method calls the `initializeSsoEnabled` method of the `transferStateService`.
+     */
+    private initializeSsoEnabled;
+    /**
+     * Initializes the LaunchDarkly configuration.
+     */
+    private initializeLaunchDarkly;
+    /**
+     * Initializes the Application Insights configuration.
+     */
+    private initializeAppInsights;
+    /**
+     * Initializes the application.
+     * This method calls the necessary initialization functions.
+     */
+    initializeApp(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AppInitializerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AppInitializerService>;
+}
+
+export { AppInitializerService };

package/services/app-insights-service/index.d.ts

@@ -1,5 +1,17 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/app-insights-service" />
-export * from './public-api';
+import * as i0 from '@angular/core';
+
+declare class AppInsightsService {
+    private appInsights;
+    private isInitialized;
+    private readonly globalStore;
+    private readonly platformId;
+    private initializeAppInsights;
+    private telemetryInitializer;
+    logPageView(name?: string, url?: string): void;
+    logException(exception: Error, severityLevel?: number): void;
+    initialize(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AppInsightsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AppInsightsService>;
+}
+
+export { AppInsightsService };

package/services/auth-service/constants/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/auth-service/constants" />
-export * from './public-api';
+import { ISsoEndpoints } from '@hmcts/opal-frontend-common/services/auth-service/interfaces';
+
+declare const SSO_ENDPOINTS: ISsoEndpoints;
+
+export { SSO_ENDPOINTS };

package/services/auth-service/index.d.ts

@@ -1,5 +1,12 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/auth-service" />
-export * from './public-api';
+import * as rxjs from 'rxjs';
+import * as i0 from '@angular/core';
+
+declare class AuthService {
+    private readonly http;
+    private readonly globalStore;
+    checkAuthenticated(): rxjs.Observable<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AuthService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AuthService>;
+}
+
+export { AuthService };

package/services/auth-service/interfaces/index.d.ts

@@ -1,5 +1,8 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/auth-service/interfaces" />
-export * from './public-api';
+interface ISsoEndpoints {
+    login: string;
+    logout: string;
+    callback: string;
+    authenticated: string;
+}
+
+export type { ISsoEndpoints };

package/services/date-service/index.d.ts

@@ -1,5 +1,147 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/date-service" />
-export * from './public-api';
+import { DateTime, DurationLikeObject } from 'luxon';
+import * as i0 from '@angular/core';
+
+interface IDateRange {
+    to: string;
+    from: string;
+}
+
+declare class DateService {
+    /**
+     * Calculates the difference in minutes between two DateTime objects.
+     * @param startDate The start date and time.
+     * @param endDate The end date and time.
+     * @returns The difference in minutes between the start and end dates.
+     */
+    calculateMinutesDifference(startDate: DateTime, endDate: DateTime): number;
+    /**
+     * Converts milliseconds to minutes.
+     * @param milliseconds - The number of milliseconds to convert.
+     * @returns The equivalent number of minutes.
+     */
+    convertMillisecondsToMinutes(milliseconds: number): number;
+    /**
+     * Calculates the age based on the given date of birth.
+     * @param dateOfBirth - The date of birth to calculate the age from.
+     * @param format - The format of the date of birth. Defaults to 'dd/MM/yyyy'.
+     * @returns The calculated age.
+     */
+    calculateAge(dateOfBirth: DateTime | string, format?: string): number;
+    /**
+     * Checks if a given date is valid.
+     * @param dateInput - The date to be checked. It can be a DateTime object, a string, or null.
+     * @param format - The format of the date string (default: 'dd/MM/yyyy').
+     * @returns A boolean indicating whether the date is valid or not.
+     */
+    isValidDate(dateInput: DateTime | string | null, format?: string): boolean;
+    /**
+     * Returns a string representation of a date subtracted by the given duration.
+     * @param duration A DurationLikeObject representing the amount of time to subtract from the current date.
+     * @returns A string representing the subtracted date in the format specified by the current locale.
+     */
+    getPreviousDate(duration: DurationLikeObject): string;
+    /**
+     * Parses a string value into a DateTime object based on the specified format.
+     * @param value - The string value to parse.
+     * @param format - The format of the string value.
+     * @returns A DateTime object representing the parsed value.
+     */
+    getFromFormat(value: string, format: string): DateTime<true> | DateTime<false>;
+    /**
+     * Parses a string value into a native JavaScript Date object based on the specified format.
+     * @param value - The string value to parse.
+     * @param format - The format of the string value.
+     * @returns A Date object representing the parsed value, or null if parsing fails.
+     */
+    getDateFromFormat(value: string, format: string): Date | null;
+    /**
+     * Converts a DateTime value to a formatted string.
+     *
+     * @param value - The DateTime value to format.
+     * @param format - The format string to apply to the DateTime value.
+     * @returns The formatted string representation of the DateTime value.
+     */
+    toFormat(value: DateTime<true> | DateTime<false>, format: string): string;
+    /**
+     * Converts a given Date object to a formatted string based on the specified format.
+     *
+     * @param value - The Date object to be formatted.
+     * @param format - The string format to apply to the Date object.
+     * @returns The formatted date string.
+     */
+    toDateStringFormat(value: Date, format: string): string;
+    /**
+     * Converts a string in ISO format to a DateTime object.
+     * @param value - The string value in ISO format.
+     * @returns A DateTime object representing the given value.
+     */
+    getFromIso(value: string): DateTime;
+    /**
+     * Returns the current date and time.
+     * @returns {DateTime} The current date and time.
+     */
+    getDateNow(): DateTime;
+    /**
+     * Adds a duration to a given date and returns the result in the specified format.
+     * @param date - The date to which the duration will be added.
+     * @param years - The number of years to add to the date (default: 0).
+     * @param months - The number of months to add to the date (default: 0).
+     * @param weeks - The number of weeks to add to the date (default: 0).
+     * @param days - The number of days to add to the date (default: 0).
+     * @param format - The format in which the resulting date will be returned (default: 'dd/MM/yyyy').
+     * @returns The resulting date in the specified format.
+     */
+    addDurationToDate(date: string, years?: number, months?: number, weeks?: number, days?: number, format?: string): string;
+    /**
+     * Calculates the number of days between two dates.
+     * @param startDate - The start date in the specified format.
+     * @param endDate - The end date in the specified format.
+     * @param format - The format of the dates (default: 'dd/MM/yyyy').
+     * @returns The number of days between the start and end dates.
+     */
+    calculateDaysBetweenDates(startDate: string, endDate: string, format?: string): number;
+    /**
+     * Checks if a given date is in the past.
+     * @param date - The date to check.
+     * @param format - The format of the date string. Defaults to 'dd/MM/yyyy'.
+     * @returns True if the date is in the past, false otherwise.
+     */
+    isDateInThePast(date: string, format?: string): boolean;
+    /**
+     * Checks if a given date is in the future.
+     * @param date - The date to check.
+     * @param yearsInTheFuture - Optional. The number of years in the future to compare against. If not provided, the current date is used.
+     * @param format - Optional. The format of the input date. Defaults to 'dd/MM/yyyy'.
+     * @returns True if the date is in the future, false otherwise.
+     */
+    isDateInTheFuture(date: string, yearsInTheFuture?: number, format?: string): boolean;
+    /**
+     * Converts a date string from one format to another.
+     *
+     * @param date - The date string to be converted.
+     * @param fromFormat - The format of the input date string.
+     * @param toFormat - The desired format of the output date string.
+     * @returns The date string in the desired format.
+     */
+    getFromFormatToFormat(date: string, fromFormat: string, toFormat: string): string;
+    /**
+     * Calculates the number of days between the current date and a given ISO date string.
+     *
+     * @param value - An ISO 8601 formatted date string representing the target date.
+     * @returns The number of days between the current date and the input date.
+     *          Returns 0 if the input date is invalid.
+     */
+    getDaysAgo(value: string): number;
+    /**
+     * Returns a date range object with 'from' and 'to' properties.
+     * @param pastDays - The number of days in the past from today.
+     * @param futureDays - The number of days in the future from today.
+     * @param format - The format for the date strings (default: 'yyyy-MM-dd').
+     * @returns An object containing 'from' and 'to' date strings in the specified format.
+     */
+    getDateRange(pastDays?: number, futureDays?: number, format?: string): IDateRange;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DateService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DateService>;
+}
+
+export { DateService };

package/services/launch-darkly-service/index.d.ts

@@ -1,5 +1,44 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/launch-darkly-service" />
-export * from './public-api';
+import * as i0 from '@angular/core';
+import { OnDestroy } from '@angular/core';
+
+declare class LaunchDarklyService implements OnDestroy {
+    private readonly globalStore;
+    private ldClient;
+    /**
+     * Sets the LaunchDarkly flags by updating the featureFlags in the state service.
+     */
+    private setLaunchDarklyFlags;
+    /**
+     * Formats the LDFlagChangeset into an LDFlagSet.
+     *
+     * @param flags - The LDFlagChangeset to be formatted.
+     * @returns The formatted LDFlagSet.
+     */
+    private formatChangeFlags;
+    /**
+     * Closes the LaunchDarkly client if it is open.
+     */
+    private closeLaunchDarklyClient;
+    /**
+     * Initializes the LaunchDarkly change listener.
+     * This method listens for changes in feature flags and updates the state accordingly.
+     */
+    initializeLaunchDarklyChangeListener(): void;
+    /**
+     * Initializes the LaunchDarkly flags and sets them.
+     * If the LD client is already initialized, it waits for initialization and then sets the flags.
+     * If the LD client is not initialized, it returns a resolved promise.
+     * @returns A promise that resolves when the flags are set.
+     */
+    initializeLaunchDarklyFlags(): Promise<void>;
+    /**
+     * Initializes the LaunchDarkly client.
+     * If a stored LaunchDarkly client ID exists, it initializes the client with the ID and anonymous mode enabled.
+     */
+    initializeLaunchDarklyClient(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LaunchDarklyService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<LaunchDarklyService>;
+}
+
+export { LaunchDarklyService };

package/services/launch-darkly-service/mocks/index.d.ts

@@ -1,5 +1,17 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/launch-darkly-service/mocks" />
-export * from './public-api';
+declare const LAUNCH_DARKLY_CHANGE_FLAGS_MOCK: {
+    flag1: {
+        current: boolean;
+        previous: boolean;
+    };
+    flag2: {
+        current: boolean;
+        previous: boolean;
+    };
+};
+
+declare const LAUNCH_DARKLY_FLAGS_MOCK: {
+    flag1: boolean;
+    flag2: boolean;
+};
+
+export { LAUNCH_DARKLY_CHANGE_FLAGS_MOCK, LAUNCH_DARKLY_FLAGS_MOCK };

package/services/permissions-service/index.d.ts

@@ -1,5 +1,17 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/permissions-service" />
-export * from './public-api';
+import { ISessionUserState, ISessionUserStateRole } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import * as i0 from '@angular/core';
+
+declare class PermissionsService {
+    private storedUniquePermissionIds;
+    /**
+     * Retrieves the unique permission IDs associated with the user.
+     * If the unique permission IDs have not been stored yet, it calculates them based on the user's roles and permissions.
+     * @returns An array of unique permission IDs.
+     */
+    getUniquePermissions(userState: ISessionUserState | null): number[];
+    hasPermissionAccess(permissionId: number, businessUnitId: number, roles: ISessionUserStateRole[]): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PermissionsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PermissionsService>;
+}
+
+export { PermissionsService };

package/services/session-service/constants/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/session-service/constants" />
-export * from './public-api';
+import { ISessionEndpoints } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+
+declare const SESSION_ENDPOINTS: ISessionEndpoints;
+
+export { SESSION_ENDPOINTS };

package/services/session-service/index.d.ts

@@ -1,5 +1,33 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/session-service" />
-export * from './public-api';
+import { Observable } from 'rxjs';
+import { ISessionUserState, ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import * as i0 from '@angular/core';
+
+declare class SessionService {
+    private readonly http;
+    private readonly globalStore;
+    private userStateCache$;
+    private tokenExpiryCache$;
+    private readonly MAX_RETRIES;
+    private readonly RETRY_DELAY_MS;
+    /**
+     * Retrieves the user state from the backend.
+     * If the user state is not available or needs to be refreshed, it makes an HTTP request to fetch the user state.
+     * The user state is then stored in the state service for future use.
+     * The user state is cached using the `shareReplay` operator to avoid unnecessary HTTP requests.
+     * @returns An observable that emits the user state.
+     */
+    getUserState(): Observable<ISessionUserState>;
+    /**
+     * Retrieves the token expiry information from the server.
+     * If the token expiry information is already cached, it returns the cached value.
+     * Otherwise, it makes an HTTP GET request to fetch the token expiry information,
+     * retries the request up to a maximum number of times if it fails, and caches the result.
+     *
+     * @returns {Observable<ISessionTokenExpiry>} An observable that emits the token expiry information.
+     */
+    getTokenExpiry(): Observable<ISessionTokenExpiry>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SessionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SessionService>;
+}
+
+export { SessionService };

package/services/session-service/interfaces/index.d.ts

@@ -1,5 +1,27 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/session-service/interfaces" />
-export * from './public-api';
+interface ISessionEndpoints {
+    userState: string;
+    expiry: string;
+}
+
+interface ISessionTokenExpiry {
+    expiry: string | null;
+    warningThresholdInMilliseconds: number | null;
+}
+
+interface ISessionUserStatePermission {
+    permission_id: number;
+    permission_name: string;
+}
+interface ISessionUserStateRole {
+    business_unit_user_id: string;
+    business_unit_id: number;
+    permissions: ISessionUserStatePermission[];
+}
+interface ISessionUserState {
+    user_id: string;
+    user_name: string;
+    name: string;
+    business_unit_user: ISessionUserStateRole[];
+}
+
+export type { ISessionEndpoints, ISessionTokenExpiry, ISessionUserState, ISessionUserStatePermission, ISessionUserStateRole };

package/services/session-service/mocks/index.d.ts

@@ -1,5 +1,7 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/session-service/mocks" />
-export * from './public-api';
+import { ISessionTokenExpiry, ISessionUserState } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+
+declare const SESSION_TOKEN_EXPIRY_MOCK: ISessionTokenExpiry;
+
+declare const SESSION_USER_STATE_MOCK: ISessionUserState;
+
+export { SESSION_TOKEN_EXPIRY_MOCK, SESSION_USER_STATE_MOCK };