@hmcts/opal-frontend-common 0.0.69 → 0.0.70

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

@@ -0,0 +1,100 @@
+import * as _hmcts_opal_frontend_common_stores_global_interfaces from '@hmcts/opal-frontend-common/stores/global/interfaces';
+import * as _hmcts_opal_frontend_common_services_session_service_interfaces from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import * as _hmcts_opal_frontend_common_services_transfer_state_service_interfaces from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
+import * as _hmcts_opal_frontend_common_services_opal_user_service_interfaces from '@hmcts/opal-frontend-common/services/opal-user-service/interfaces';
+import * as launchdarkly_js_sdk_common from 'launchdarkly-js-sdk-common';
+import * as _ngrx_signals from '@ngrx/signals';
+import * as _angular_core from '@angular/core';
+import { OnInit, OnDestroy } from '@angular/core';
+import { Subject, Observable } from 'rxjs';
+import { AbstractTabData } from '@hmcts/opal-frontend-common/components/abstract/abstract-tab-data';
+import { PermissionsService } from '@hmcts/opal-frontend-common/services/permissions-service';
+
+declare abstract class AbstractAccountSummaryBaseComponent<THeader, TTab extends {
+    version: string | null;
+}> extends AbstractTabData implements OnInit, OnDestroy {
+    protected readonly destroy$: Subject<void>;
+    protected readonly refreshFragment$: Subject<string>;
+    protected readonly permissionsService: PermissionsService;
+    protected readonly globalStore: {
+        authenticated: _angular_core.Signal<boolean>;
+        bannerError: _ngrx_signals.DeepSignal<{
+            error: boolean | null;
+            title: string | null;
+            message: string | null;
+            operationId: string | null;
+        }>;
+        featureFlags: _angular_core.Signal<launchdarkly_js_sdk_common.LDFlagSet>;
+        userState: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_opal_user_service_interfaces.IOpalUserState>;
+        ssoEnabled: _angular_core.Signal<boolean>;
+        launchDarklyConfig: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateLaunchDarklyConfig>;
+        appInsightsConfig: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateAppInsightsConfig>;
+        tokenExpiry: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry>;
+        userStateCacheExpirationMilliseconds: _angular_core.Signal<number>;
+        setAuthenticated: (authenticated: boolean) => void;
+        setBannerError: (error: _hmcts_opal_frontend_common_stores_global_interfaces.IGlobalErrorState) => void;
+        resetBannerError: () => void;
+        setFeatureFlags: (featureFlags: launchdarkly_js_sdk_common.LDFlagSet) => void;
+        setUserState: (userState: _hmcts_opal_frontend_common_services_opal_user_service_interfaces.IOpalUserState) => void;
+        setSsoEnabled: (ssoEnabled: boolean) => void;
+        setLaunchDarklyConfig: (config: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateLaunchDarklyConfig) => void;
+        setAppInsightsConfig: (config: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateAppInsightsConfig) => void;
+        setTokenExpiry: (tokenExpiry: _hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry) => void;
+        setUserStateCacheExpirationMilliseconds: (milliseconds: number) => void;
+    } & _ngrx_signals.StateSource<{
+        authenticated: boolean;
+        bannerError: {
+            error: boolean | null;
+            title: string | null;
+            message: string | null;
+            operationId: string | null;
+        };
+        featureFlags: launchdarkly_js_sdk_common.LDFlagSet;
+        userState: _hmcts_opal_frontend_common_services_opal_user_service_interfaces.IOpalUserState;
+        ssoEnabled: boolean;
+        launchDarklyConfig: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateLaunchDarklyConfig;
+        appInsightsConfig: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateAppInsightsConfig;
+        tokenExpiry: _hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry;
+        userStateCacheExpirationMilliseconds: number;
+    }>;
+    protected readonly userState: _hmcts_opal_frontend_common_services_opal_user_service_interfaces.IOpalUserState;
+    accountData: THeader;
+    protected abstract setupTabDataStream(): void;
+    protected abstract getHeaderDataFromRoute(): void;
+    protected abstract getHeaderData(accountId: number): Observable<THeader>;
+    protected abstract transformHeaderForStore(accountId: number, header: THeader): void;
+    protected abstract transformHeaderForView(header: THeader): THeader;
+    /**
+     * Fetches tab data and compares its version.
+     * @param serviceCall The observable service call to fetch the tab data.
+     * @param compareVersion A callback function to compare the version of the fetched data.
+     * @returns An observable of the transformed tab data.
+     */
+    protected fetchTabData(serviceCall: Observable<TTab>, compareVersion: (version: string | null) => void): Observable<TTab>;
+    protected transformTabData(data: TTab): TTab;
+    /**
+     * Checks if the user has the specified permission.
+     * @param permission The permission to check.
+     * @returns True if the user has the permission, false otherwise.
+     */
+    hasPermission(permission: number): boolean;
+    /**
+     * Checks if the user has the specified permission for a specific business unit.
+     * @param permission The permission to check.
+     * @param businessUnitId The ID of the business unit.
+     * @returns True if the user has the permission for the business unit, false otherwise.
+     */
+    hasBusinessUnitPermission(permission: number, businessUnitId: number): boolean;
+    /**
+     * Refreshes the page with the latest header data.
+     * @param accountId The ID of the account.
+     * @param onSuccess A callback function to execute on successful data fetch.
+     */
+    refreshPage(accountId: number, onSuccess: (header: THeader) => void): void;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AbstractAccountSummaryBaseComponent<any, any>, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AbstractAccountSummaryBaseComponent<any, any>, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
+export { AbstractAccountSummaryBaseComponent };