ets-fe-ng-sdk 19.0.116 → 20.0.0

package/lib/Services/api.service.d.ts

@@ -1,255 +0,0 @@
-import { HttpClient, HttpErrorResponse, HttpHeaders } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { ICodeDescription, ICodeTitle, IObjectLiteral } from '../Shared/models/index.model';
-import { CacheService } from './cache/cache.service';
-import { LocalCacheService } from './cache/local-cache.service';
-import * as i0 from "@angular/core";
-/**
- * Interface for API response structure
- */
-export interface IResponse {
-    message: string;
-    result: any;
-    status: 'success' | 'error' | 'failure';
-    statusCode: 'SM000' | 'SM001' | 'SM002' | 'SM003';
-}
-/**
- * Service for handling API requests with caching capabilities
- * Provides methods for GET, POST, PUT, PATCH and DELETE HTTP requests
- */
-export declare class ApiService {
-    private showRoutes;
-    private get headers();
-    protected get fileHeaders(): {
-        enctype: string;
-    };
-    baseURL: string;
-    private retryCount;
-    http: HttpClient;
-    cacheS: CacheService;
-    lCacheS: LocalCacheService;
-    constructor();
-    /**
-     * Logs API route information if showRoutes is enabled
-     * @param method HTTP method (get, post, put, delete)
-     * @param route API endpoint
-     * @param extras Additional parameters to log
-     */
-    private logRoutes;
-    /**
-     * Handles HTTP request errors
-     * @param err HTTP error response
-     * @returns Observable error
-     */
-    protected handleRequestError: (err: HttpErrorResponse) => Observable<never>;
-    /**
-     * Combines two HttpHeaders objects into one
-     * @param headers1 First HttpHeaders object
-     * @param headers2 Second HttpHeaders object
-     * @returns Combined HttpHeaders
-     */
-    protected concatenateHeaders: (headers1: HttpHeaders, headers2: HttpHeaders) => HttpHeaders;
-    /**
-     * Performs a PATCH request
-     * @param route API endpoint
-     * @param body Request body
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    patch<T = any>(route: string, body?: any, extras?: IExtras): Observable<T>;
-    optionsHandler: (extras?: IExtras) => {};
-    /**
-     * Performs a POST request
-     * @param route API endpoint
-     * @param body Request body
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    post<T = any>(route: string, body?: any, extras?: IExtras): Observable<T>;
-    /**
-     * Performs a POST request with FormData
-     * @param route API endpoint
-     * @param body FormData to send
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    postFile<T = any>(route: string, body: FormData, extras?: IExtras): Observable<T>;
-    /**
-     * Performs a POST request with FormData and endorsement header
-     * @param route API endpoint
-     * @param body FormData to send
-     * @returns Observable of type T
-     */
-    postFileWithEndorsement<T = any>(route: string, body: FormData): Observable<T>;
-    /**
-     * Performs a POST request with text content type
-     * @param route API endpoint
-     * @param body Request body
-     * @param extras Extra configurations for the request
-     * @returns Observable of string
-     */
-    postString(route: string, body?: any, extras?: IExtras): Observable<string>;
-    /**
-     * Performs a POST request with text content type and local caching
-     * @param route API endpoint
-     * @param body String body to send
-     * @returns Observable of string
-     */
-    postStringWithLocalCache(route: string, body: string): Observable<string>;
-    /**
-     * Perform a GET request
-     * @param route API endpoint
-     * @param parameters Object to convert into queryparams
-     * @param extras Extra configurations for the request
-     * @returns
-     */
-    get: <T = any>(route: string, parameters?: IObjectLiteral, extras?: IExtras) => Observable<T>;
-    /**
-     * Fetches code data and sorts it
-     * @param route API endpoint
-     * @returns Observable of sorted code data
-     */
-    getCodes: <T extends ICodeTitle | ICodeDescription = ICodeTitle<string> & ICodeDescription>(route: string) => Observable<T[]>;
-    /**
-     * Performs a GET request with text response type
-     * @param route API endpoint
-     * @param parameters Query parameters
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T (defaults to string)
-     */
-    getText: <T = string>(route: string, parameters?: {
-        [field: string]: string | number | boolean;
-    }, extras?: IExtras) => Observable<T>;
-    /**
-     * Performs a GET request for file download
-     * @param route API endpoint
-     * @param parameters Query parameters
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T (defaults to string)
-     */
-    getFile: <T = string>(route: string, parameters?: {
-        [field: string]: string | number | boolean;
-    }, extras?: IExtras) => Observable<T>;
-    /**
-     * Performs a GET request with a request body
-     * @param route API endpoint
-     * @param body Request body
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    getWithBody: <T = any>(route: string, body?: any, extras?: IExtras) => Observable<T>;
-    /**
-     * Gets data from local cache or fetches it if not available
-     * @param route API endpoint
-     * @param parameters Query parameters
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    getFromlocal: <T = any>(route: string, parameters?: Object, extras?: IExtras) => Observable<T>;
-    /**
-     * Gets data with local caching - returns cached data first, then updates with fresh data
-     * @param route API endpoint
-     * @param parameters Query parameters
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    getWithLocalCache: <T = any>(route: string, parameters?: Object, extras?: IExtras) => Observable<T>;
-    /**
-     * Gets data from memory cache or fetches it if not available
-     * @param route API endpoint
-     * @param parameters Query parameters
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    getFromMemory: <T>(route: string, parameters?: Object, extras?: IExtras) => Observable<T>;
-    /**
-     * Converts an object to URL query parameters
-     * @param parameters Object to convert
-     * @returns Query parameter string
-     */
-    getRequestParse(parameters?: Object): string;
-    /**
-     * Performs a PUT request
-     * @param route API endpoint
-     * @param body Request body
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    put<T = any>(route: string, body?: any, extras?: IExtras): Observable<T>;
-    /**
-     * Performs a PUT request with FormData
-     * @param route API endpoint
-     * @param body FormData to send
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    putFile<T = any>(route: string, body: FormData, extras?: any): Observable<T>;
-    /**
-     * Performs a PUT request with FormData and endorsement header
-     * @param route API endpoint
-     * @param body FormData to send
-     * @returns Observable of type T
-     */
-    putFileWithEndorsement<T = any>(route: string, body: FormData): Observable<T>;
-    /**
-     * Performs a DELETE request
-     * @param route API endpoint
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    delete: <T = any>(route: string, extras?: IExtras) => Observable<any>;
-    /**
-     * Performs a DELETE request with a request body
-     * @param route API endpoint
-     * @param body Request body
-     * @param extras Extra configurations for the request
-     * @returns Observable of type T
-     */
-    deleteWithBody: <T = any>(route: string, body?: any, extras?: IExtras) => Observable<any>;
-    /**
-     * Performs a DELETE request with text response type
-     * @param route API endpoint
-     * @param extras Extra configurations for the request
-     * @returns Observable of string
-     */
-    deleteText: (route: string, extras?: IExtras) => Observable<any>;
-    /**
-     * Sorts an array of objects by code property
-     * @param data Array to sort
-     * @returns Sorted array
-     */
-    sortCodes: <T extends {
-        code: string;
-    }>(data: T[]) => T[];
-    objectToFormData(obj: IObjectLiteral): FormData;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ApiService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ApiService>;
-}
-/**
- * Interface for extra request configurations
- */
-interface IExtras {
-    /**
-     * Specify whether to use the endorsement header
-     */
-    useEndorsement?: boolean;
-    /**
-     * Report progress of the request
-     */
-    reportProgress?: boolean;
-    /**
-     * Specify the request options. The added options will be appended to the default options
-     */
-    options?: {
-        headers?: HttpHeaders;
-        [x: string]: any;
-    };
-    /**
-     * Specify the request type. If the request type is queryParams, the body will be sent as query parameters
-     */
-    requestType?: 'queryParams';
-    /**If true, the cache record will be recomputed after returning a result */
-    refreshCache?: boolean;
-    isReturningText?: boolean;
-}
-export {};

package/lib/Services/app.service.d.ts

@@ -1,112 +0,0 @@
-import { Title } from '@angular/platform-browser';
-import { ESystem, ESystemBusLine, ISystem, IValueLabel } from '../Shared/models/index.model';
-import { ETSMenuItem } from '../Shared/models/IMenuItem';
-import { ETSTranslationService } from '@evolutics/translation';
-import * as i0 from "@angular/core";
-/**
- * Core application service that manages system state, navigation menus, and UI theming.
- * @template TESystem - The system enum type (defaults to ESystem)
- * @template TESystemBusLine - The system bus line enum type (defaults to ESystemBusLine)
- * @template TMenuItem - The menu item type (defaults to ETSMenuItem)
- */
-export declare class AppService<TESystem = ESystem, TESystemBusLine = ESystemBusLine, TMenuItem = ETSMenuItem> {
-    readonly titleS: Title;
-    readonly translator: ETSTranslationService;
-    /** Top-level navigation menu items */
-    topMenu: TMenuItem[];
-    /** Sub-menu items for the currently selected top menu */
-    bottomMenu: TMenuItem[];
-    private _currentTopMenu;
-    /** Signal for the currently selected top menu item */
-    readonly currentTopMenuSignal: import("@angular/core").WritableSignal<TMenuItem>;
-    private _system;
-    private _systemSignal;
-    /** Computed signal that provides the current system */
-    systemSignal: import("@angular/core").Signal<TESystem>;
-    private _pageName;
-    /** Computed signal that provides the current page name */
-    readonly pageNameSignal: import("@angular/core").Signal<string>;
-    /**
-     * Gets the current system
-     * @returns The current system
-     */
-    get system(): TESystem;
-    /**
-     * Sets the current system and updates related UI elements
-     * @param value - The system to set as current
-     */
-    set system(value: TESystem);
-    /**
-     * Gets the currently selected top menu item
-     * @returns The current top menu item
-     */
-    get currentTopMenu(): TMenuItem;
-    /**
-     * Sets the current top menu item and updates the bottom menu
-     * @param value - The menu item to set as current
-     */
-    set currentTopMenu(value: TMenuItem);
-    /**
-     * Sets the current top menu based on the provided system
-     * @param system - The system to find the corresponding menu item for
-     */
-    setCurrentTopMenu(system: TESystem): Promise<void>;
-    /** Map of system metadata keyed by system enum value */
-    systemMetadataMap: Map<TESystem, ISystem<ESystem, ESystemBusLine>>;
-    /**
-     * Gets the first available system from the environment configuration
-     * @returns The first available system's metadata
-     */
-    get getFirstAvailableSystem(): ISystem<ESystem, ESystemBusLine>;
-    /**
-     * Gets the metadata for the current system
-     * @returns The current system's metadata
-     */
-    get getCurrentSystemMetadata(): ISystem<ESystem, ESystemBusLine>;
-    constructor();
-    /**
-     * Sets the default CSS class on the body element based on the first available system
-     */
-    setDefaultClass(): void;
-    /**
-     * Gets the bus line for the current system
-     * @returns The current system's bus line
-     */
-    get busLine(): ESystemBusLine;
-    /**
-     * Gets the list of active systems filtered by environment configuration
-     * @returns Array of active top menu items
-     */
-    get activeSystems(): TMenuItem[];
-    /**
-     * Checks if the current system has a bus line
-     * @returns True if the current system has a bus line, false otherwise
-     */
-    get hasBusLine(): boolean;
-    /**
-     * Gets the current page name
-     * @returns The current page name
-     */
-    get pageName(): string;
-    /**
-     * Sets the current page name and updates the document title
-     * @param value - The page name to set
-     */
-    set pageName(value: string);
-    /**
-     * Updates the document title with the current page name
-     * @param title - The title to set
-     * @param translate - Whether to translate the title (defaults to true if translation is configured)
-     */
-    addTitle(title: string, translate?: boolean): void;
-    /**
-     * Sets the theme color meta tag based on the current system's color code
-     */
-    setMetaTheme(): void;
-    /** Function to filter navigation menu items */
-    filterNavMenuFunc: (value: TMenuItem) => boolean;
-    /** Available bus lines for the application */
-    busLines: IValueLabel<TESystemBusLine>[];
-    static ɵfac: i0.ɵɵFactoryDeclaration<AppService<any, any, any>, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AppService<any, any, any>>;
-}

package/lib/Services/base.effect.d.ts

@@ -1,24 +0,0 @@
-import { Actions } from '@ngrx/effects';
-import { Store } from '@ngrx/store';
-import * as i0 from "@angular/core";
-/**
- * Abstract base class for NgRx effects.
- *
- * Provides common functionality and dependencies for effect classes.
- * Extend this class to create specific effect implementations.
- */
-export declare abstract class BaseEffect {
-    /**
-     * Observable of all actions dispatched in the store.
-     * Used to filter and respond to specific actions.
-     */
-    protected actions$: Actions<any>;
-    /**
-     * The NgRx store instance.
-     * Provides access to the current state and allows dispatching actions.
-     */
-    protected store: Store<any>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<BaseEffect, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<BaseEffect>;
-}

package/lib/Services/base.facade.service.d.ts

@@ -1,42 +0,0 @@
-import { Action, ActionCreator, Store } from '@ngrx/store';
-import { Observable } from 'rxjs';
-import { Actions } from '@ngrx/effects';
-/**
- * Base service class that provides common NgRx functionality for facade services.
- * Handles dispatching actions and selecting state with additional utilities.
- */
-export declare abstract class BaseFacadeService {
-    protected store: Store<any>;
-    protected actions: Actions<any>;
-    constructor();
-    /**
-     * Converts an NgRx action flow into a Promise.
-     * Dispatches the provided action and returns a Promise that resolves with the success action's result
-     * or rejects with the error action's error.
-     *
-     * @param dispatchFunc - The action to dispatch to initiate the flow
-     * @param config - Configuration object containing success and error action creators
-     * @param config.success - Action creator for the success action that contains the result
-     * @param config.error - Action creator for the error action that contains the error
-     * @returns Promise that resolves with the result of the success action or rejects with the error
-     * @template T - The type of the result data
-     */
-    ngrxPromise<T>(dispatchFunc: Action<any>, config: {
-        success: ActionCreator<string, (props: {
-            result: T;
-        }) => typeof props>;
-        error: ActionCreator<string, (props: {
-            error: any;
-        }) => typeof props>;
-    }): Promise<T>;
-    /**
-     * Selects data from the store and automatically dispatches an action if the selected data is empty.
-     * Empty is defined as null, undefined, or an empty array.
-     *
-     * @param selector$ - Observable selector that retrieves data from the store
-     * @param dispatchIfEmpty - Action to dispatch if the selected data is empty
-     * @returns The original selector observable with added side effect for dispatching
-     * @template T - The type of data being selected
-     */
-    protected select<T>(selector$: Observable<T>, dispatchIfEmpty: Action<any>): Observable<T>;
-}

package/lib/Services/base.service.d.ts

@@ -1,81 +0,0 @@
-import { ApiService } from './api.service';
-import { IObjectLiteral } from '../Shared/models/index.model';
-import * as i0 from "@angular/core";
-/**
- * Base service that provides common HTTP operations with standardized URL formatting.
- * Extends this class to create specific API services with a consistent interface.
- */
-export declare class BaseService {
-    /** API service for making HTTP requests */
-    protected apiS: ApiService;
-    /** Base URL for all API requests from this service */
-    protected readonly baseURL: string;
-    private _baseURLNoSlash;
-    protected get baseURLNoSlash(): string;
-    /**
-     * Performs a POST request to the specified path
-     * @param data - The payload to send in the request body
-     * @param path - The path to append to the base URL
-     * @returns An Observable of the response
-     */
-    protected post<T>(data?: any, path?: string | number): import("rxjs").Observable<T>;
-    /**
-     * Performs a PUT request to the specified path
-     * @param data - The payload to send in the request body
-     * @param path - The path to append to the base URL
-     * @returns An Observable of the response
-     */
-    protected put<T>(data?: any, path?: string | number): import("rxjs").Observable<T>;
-    /**
-     * Performs a GET request to the specified path
-     * @param path - The path to append to the base URL
-     * @param query - Query parameters to include in the request
-     * @returns An Observable of the response
-     */
-    protected get<T>(path?: string | number, query?: any): import("rxjs").Observable<T>;
-    /**
-     * Performs a DELETE request to the specified path
-     * @param path - The path to append to the base URL
-     * @param query - Query parameters or body payload for the request
-     * @returns An Observable of the response
-     */
-    protected delete<T>(path?: string | number, query?: any): import("rxjs").Observable<any>;
-    /**
-     * Performs a DELETE request with a request body
-     * @param path - The path to append to the base URL
-     * @param body - The payload to send in the request body
-     * @returns An Observable of the response
-     */
-    protected deleteWithBody<T>(path?: string, body?: any): import("rxjs").Observable<any>;
-    /**
-     * POST file with an Object literal as the paramater.
-     *
-     * The object literal gets converted to a formdata internally before posting.
-     * @param path
-     * @param body
-     * @returns
-     */
-    protected postFile<T>(path: string, body: IObjectLiteral): import("rxjs").Observable<T>;
-    /**
-     * POST file with Formdata as the paramater
-     * @param path
-     * @param formData
-     * @returns
-     */
-    protected postFileFD<T>(path: string, formData: FormData): import("rxjs").Observable<T>;
-    /**
-     * Performs a PUT request with FormData
-     * @param path - The path to append to the base URL
-     * @param body - The FormData to send in the request
-     * @returns An Observable of the response
-     */
-    protected putFileFD<T>(path: string, body: FormData): import("rxjs").Observable<T>;
-    /**
-     * Formats a route by removing trailing slashes
-     * @param route - The route to format
-     * @returns The formatted route without trailing slash
-     */
-    formatRoute: (route: string) => string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<BaseService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<BaseService>;
-}

package/lib/Services/cache/cache-updater.service.d.ts

@@ -1,10 +0,0 @@
-import { ApiService } from '../api.service';
-import { CacheService } from './cache.service';
-import * as i0 from "@angular/core";
-export declare class CacheUpdaterService {
-    apiService: ApiService;
-    constructor(apiService: ApiService);
-    update: (cacheS: CacheService) => import("rxjs").Observable<import("rxjs").Subscription>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CacheUpdaterService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<CacheUpdaterService>;
-}

package/lib/Services/cache/cache.service.d.ts

@@ -1,17 +0,0 @@
-import { Observable } from 'rxjs';
-import { UtilityService } from '../utility.service';
-import * as i0 from "@angular/core";
-export declare class CacheService {
-    private _cache;
-    readonly uS: UtilityService<any>;
-    constructor();
-    get cache(): {
-        [x: string]: any;
-    };
-    has: (key: string) => boolean;
-    getItem: <T>(key: string) => T;
-    setItem<T>(key: string, data: T): void;
-    getAndSet<T>(key: string, newValue?: T | Promise<T> | Observable<T>): Observable<T>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CacheService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<CacheService>;
-}

package/lib/Services/cache/local-cache.service.d.ts

@@ -1,17 +0,0 @@
-import { Observable } from 'rxjs';
-import { ETSStorageService } from '../storage.service';
-import { CacheService } from './cache.service';
-import * as i0 from "@angular/core";
-export declare class LocalCacheService extends CacheService {
-    private readonly cacheKey;
-    private readonly cacheCreatedDateKey;
-    private readonly validityDays;
-    private readonly oneDayTimestamp;
-    readonly sS: ETSStorageService;
-    constructor();
-    saveToLocal(): void;
-    setItem<T>(key: string, data: T): void;
-    getAndSet<T>(key: string, addFunc?: T | Promise<T> | Observable<T>): Observable<T>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LocalCacheService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<LocalCacheService>;
-}

package/lib/Services/cache/saver.service.d.ts

@@ -1,34 +0,0 @@
-import { StorageClass } from '../storage.service';
-import * as i0 from "@angular/core";
-export declare class SaverClass {
-    private readonly itemName;
-    private readonly storageKey;
-    /**
-     * Storage Service
-     */
-    storageService: StorageClass;
-    /**
-     *
-     * @param itemName Field name of the item
-     * @param storageKey  The key used for the storage slot assigned to the item
-     */
-    constructor(itemName: string, storageKey: string);
-    /**
-     * Save Item to storage
-     */
-    saveToLocal(): void;
-    /**
-     * Get Item from storage
-     */
-    getFromLocal(): void;
-}
-export declare class SaverService extends SaverClass {
-    /**
-     *
-     * @param itemName Field name of the item
-     * @param storageKey  The key used for the storage slot assigned to the item
-     */
-    constructor(itemName: string, storageKey: string);
-    static ɵfac: i0.ɵɵFactoryDeclaration<SaverService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<SaverService>;
-}

package/lib/Services/debouncer.service.d.ts

@@ -1,66 +0,0 @@
-import { BehaviorSubject } from 'rxjs';
-import { CustomValidationError } from '../Shared/models/index.model';
-import * as i0 from "@angular/core";
-/**
- * Service for debouncing function calls to prevent excessive executions
- * when triggered multiple times in quick succession.
- */
-export declare class DebouncerService {
-    /**
-     * Holds the keys for debouncing with their associated callbacks
-     */
-    debounceKeys: {
-        [key: string]: {
-            callback: () => any;
-        };
-    };
-    /**
-     * Subject that emits when a debounced function should be executed
-     */
-    listener: BehaviorSubject<boolean>;
-    /**
-     * Flag to track if the listener subscription is active
-     */
-    isListening: boolean;
-    constructor();
-    /**
-     * Initializes the debounce listener if not already listening
-     * Sets up subscription to execute callbacks after debounce period
-     * @private
-     */
-    private startListener;
-    /**
-     * Wrapper function that facilitates debouncing of function calls
-     * @param config Configuration object for the debouncer
-     * @param config.uniqueKey Identifier for the function to debounce
-     * @param config.callback Function to call after debouncing
-     */
-    debouncer: (config: {
-        uniqueKey: string;
-        callback: () => any;
-    }) => void;
-    /**
-     * Counter used for debugging async validations
-     * @private
-     */
-    counter: number;
-    /**
-     * Asynchronous validator wrapper built on top of the debouncer function
-     * Specifically tuned for Angular AbstractControl async validators
-     *
-     * @param config Configuration object for the async validation
-     * @param config.uniqueKey Identifier for the validation function
-     * @param config.callback Async function to call after debouncing that returns validation result
-     * @param config.validationError Optional custom validation error to return on failure
-     * @returns Promise that resolves to a CustomValidationError or null if valid
-     */
-    asyncValidation: <TData extends {
-        response?: boolean;
-    } = any>(config: {
-        uniqueKey: string;
-        callback: () => Promise<TData>;
-        validationError?: CustomValidationError;
-    }) => Promise<CustomValidationError>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DebouncerService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DebouncerService>;
-}