@eui/core 19.3.3-snapshot-1754655052849 → 21.0.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +86 -0
- package/docs/directives/TranslateMockDirective.html +0 -43
- package/docs/injectables/ApiQueueService.html +1 -55
- package/docs/injectables/EuiAppShellService.html +1 -103
- package/docs/injectables/EuiDynamicComponentService.html +0 -67
- package/docs/injectables/EuiDynamicMenuService.html +1 -43
- package/docs/injectables/EuiPermissionService.html +1 -43
- package/docs/injectables/EuiThemeService.html +1 -55
- package/docs/injectables/GlobalErrorHandler.html +0 -43
- package/docs/injectables/I18nLoader.html +1 -55
- package/docs/injectables/I18nService.html +1 -79
- package/docs/injectables/LocalForageService.html +1 -43
- package/docs/injectables/LocalStorageService.html +0 -54
- package/docs/injectables/LocaleService.html +1 -91
- package/docs/injectables/LocaleServiceMock.html +1 -31
- package/docs/injectables/LogService.html +1 -55
- package/docs/injectables/SessionStorageService.html +0 -43
- package/docs/injectables/StoreService.html +1 -42
- package/docs/injectables/UserService.html +1 -31
- package/docs/interceptors/AddLangParamInterceptor.html +0 -43
- package/docs/interceptors/HttpErrorHandlerInterceptor.html +0 -67
- package/docs/interceptors/UxRequestErrorModelInterceptor.html +0 -43
- package/docs/js/menu-wc.js +6 -6
- package/docs/js/menu-wc_es5.js +1 -1
- package/docs/js/search/search_index.js +2 -2
- package/docs/properties.html +1 -1
- package/fesm2022/eui-core.mjs +224 -315
- package/fesm2022/eui-core.mjs.map +1 -1
- package/index.d.ts +2470 -5
- package/index.d.ts.map +1 -1
- package/package.json +11 -11
- package/eui-core.d.ts.map +0 -1
- package/lib/eui-core.module.d.ts +0 -21
- package/lib/eui-core.module.d.ts.map +0 -1
- package/lib/helpers/css-utils.d.ts +0 -35
- package/lib/helpers/css-utils.d.ts.map +0 -1
- package/lib/helpers/date-helpers.d.ts +0 -3
- package/lib/helpers/date-helpers.d.ts.map +0 -1
- package/lib/helpers/dom-helpers.d.ts +0 -34
- package/lib/helpers/dom-helpers.d.ts.map +0 -1
- package/lib/helpers/event-helpers.d.ts +0 -2
- package/lib/helpers/event-helpers.d.ts.map +0 -1
- package/lib/helpers/form-helpers.d.ts +0 -11
- package/lib/helpers/form-helpers.d.ts.map +0 -1
- package/lib/helpers/format-helpers.d.ts +0 -13
- package/lib/helpers/format-helpers.d.ts.map +0 -1
- package/lib/helpers/http-helpers.d.ts +0 -8
- package/lib/helpers/http-helpers.d.ts.map +0 -1
- package/lib/helpers/index.d.ts +0 -10
- package/lib/helpers/index.d.ts.map +0 -1
- package/lib/helpers/injector.d.ts +0 -11
- package/lib/helpers/injector.d.ts.map +0 -1
- package/lib/helpers/utils.d.ts +0 -7
- package/lib/helpers/utils.d.ts.map +0 -1
- package/lib/interceptors/add-lang-param.interceptor.d.ts +0 -17
- package/lib/interceptors/add-lang-param.interceptor.d.ts.map +0 -1
- package/lib/interceptors/cache-prevention.interceptor.d.ts +0 -9
- package/lib/interceptors/cache-prevention.interceptor.d.ts.map +0 -1
- package/lib/interceptors/cors-security.interceptor.d.ts +0 -9
- package/lib/interceptors/cors-security.interceptor.d.ts.map +0 -1
- package/lib/interceptors/csrf-prevention.interceptor.d.ts +0 -9
- package/lib/interceptors/csrf-prevention.interceptor.d.ts.map +0 -1
- package/lib/interceptors/eu-login-session-timeout-handling.interceptor.d.ts +0 -20
- package/lib/interceptors/eu-login-session-timeout-handling.interceptor.d.ts.map +0 -1
- package/lib/interceptors/index.d.ts +0 -7
- package/lib/interceptors/index.d.ts.map +0 -1
- package/lib/interceptors/ux-request-error-model.interceptor.d.ts +0 -14
- package/lib/interceptors/ux-request-error-model.interceptor.d.ts.map +0 -1
- package/lib/services/app/eui-init-app.d.ts +0 -12
- package/lib/services/app/eui-init-app.d.ts.map +0 -1
- package/lib/services/app/eui-pre-init-app.d.ts +0 -17
- package/lib/services/app/eui-pre-init-app.d.ts.map +0 -1
- package/lib/services/app/eui-startup.d.ts +0 -5
- package/lib/services/app/eui-startup.d.ts.map +0 -1
- package/lib/services/app/factories/log.d.ts +0 -26
- package/lib/services/app/factories/log.d.ts.map +0 -1
- package/lib/services/app/index.d.ts +0 -3
- package/lib/services/app/index.d.ts.map +0 -1
- package/lib/services/config/defaults.d.ts +0 -12
- package/lib/services/config/defaults.d.ts.map +0 -1
- package/lib/services/config/tokens.d.ts +0 -20
- package/lib/services/config/tokens.d.ts.map +0 -1
- package/lib/services/dynamic-component/dynamic-component.service.d.ts +0 -42
- package/lib/services/dynamic-component/dynamic-component.service.d.ts.map +0 -1
- package/lib/services/dynamic-menu/dynamic-menu.service.d.ts +0 -15
- package/lib/services/dynamic-menu/dynamic-menu.service.d.ts.map +0 -1
- package/lib/services/errors/eui.error.d.ts +0 -14
- package/lib/services/errors/eui.error.d.ts.map +0 -1
- package/lib/services/errors/global-error-handler.d.ts +0 -11
- package/lib/services/errors/global-error-handler.d.ts.map +0 -1
- package/lib/services/errors/http-error-handler-callback-functions.d.ts +0 -7
- package/lib/services/errors/http-error-handler-callback-functions.d.ts.map +0 -1
- package/lib/services/errors/http-error-handler.interceptor.d.ts +0 -23
- package/lib/services/errors/http-error-handler.interceptor.d.ts.map +0 -1
- package/lib/services/errors/index.d.ts +0 -5
- package/lib/services/errors/index.d.ts.map +0 -1
- package/lib/services/eui-app-shell.service.d.ts +0 -110
- package/lib/services/eui-app-shell.service.d.ts.map +0 -1
- package/lib/services/eui-theme.service.d.ts +0 -52
- package/lib/services/eui-theme.service.d.ts.map +0 -1
- package/lib/services/eui-timezone.service.d.ts +0 -270
- package/lib/services/eui-timezone.service.d.ts.map +0 -1
- package/lib/services/growl/eui-growl.service.d.ts +0 -23
- package/lib/services/growl/eui-growl.service.d.ts.map +0 -1
- package/lib/services/growl/index.d.ts +0 -2
- package/lib/services/growl/index.d.ts.map +0 -1
- package/lib/services/i18n/i18n.loader.d.ts +0 -93
- package/lib/services/i18n/i18n.loader.d.ts.map +0 -1
- package/lib/services/i18n/i18n.resource.d.ts +0 -36
- package/lib/services/i18n/i18n.resource.d.ts.map +0 -1
- package/lib/services/i18n/i18n.service.d.ts +0 -102
- package/lib/services/i18n/i18n.service.d.ts.map +0 -1
- package/lib/services/i18n/index.d.ts +0 -4
- package/lib/services/i18n/index.d.ts.map +0 -1
- package/lib/services/index.d.ts +0 -20
- package/lib/services/index.d.ts.map +0 -1
- package/lib/services/loader/eui-loader.model.d.ts +0 -97
- package/lib/services/loader/eui-loader.model.d.ts.map +0 -1
- package/lib/services/loader/eui-loader.service.d.ts +0 -143
- package/lib/services/loader/eui-loader.service.d.ts.map +0 -1
- package/lib/services/loader/index.d.ts +0 -3
- package/lib/services/loader/index.d.ts.map +0 -1
- package/lib/services/locale/index.d.ts +0 -3
- package/lib/services/locale/index.d.ts.map +0 -1
- package/lib/services/locale/locale.service.d.ts +0 -103
- package/lib/services/locale/locale.service.d.ts.map +0 -1
- package/lib/services/locale/locale.service.mock.d.ts +0 -16
- package/lib/services/locale/locale.service.mock.d.ts.map +0 -1
- package/lib/services/log/index.d.ts +0 -4
- package/lib/services/log/index.d.ts.map +0 -1
- package/lib/services/log/log.module.d.ts +0 -16
- package/lib/services/log/log.module.d.ts.map +0 -1
- package/lib/services/log/log.service.d.ts +0 -28
- package/lib/services/log/log.service.d.ts.map +0 -1
- package/lib/services/log/log.service.mock.d.ts +0 -5
- package/lib/services/log/log.service.mock.d.ts.map +0 -1
- package/lib/services/permission/permission.service.d.ts +0 -188
- package/lib/services/permission/permission.service.d.ts.map +0 -1
- package/lib/services/queue/api-queue.service.d.ts +0 -278
- package/lib/services/queue/api-queue.service.d.ts.map +0 -1
- package/lib/services/queue/api-queue.service.mock.d.ts +0 -14
- package/lib/services/queue/api-queue.service.mock.d.ts.map +0 -1
- package/lib/services/queue/index.d.ts +0 -3
- package/lib/services/queue/index.d.ts.map +0 -1
- package/lib/services/storage/async-storage.service.d.ts +0 -45
- package/lib/services/storage/async-storage.service.d.ts.map +0 -1
- package/lib/services/storage/async-storage.service.mock.d.ts +0 -12
- package/lib/services/storage/async-storage.service.mock.d.ts.map +0 -1
- package/lib/services/storage/index.d.ts +0 -8
- package/lib/services/storage/index.d.ts.map +0 -1
- package/lib/services/storage/local-forage.service.d.ts +0 -49
- package/lib/services/storage/local-forage.service.d.ts.map +0 -1
- package/lib/services/storage/local-storage.service.d.ts +0 -36
- package/lib/services/storage/local-storage.service.d.ts.map +0 -1
- package/lib/services/storage/session-storage.service.d.ts +0 -35
- package/lib/services/storage/session-storage.service.d.ts.map +0 -1
- package/lib/services/storage/storage.service.d.ts +0 -29
- package/lib/services/storage/storage.service.d.ts.map +0 -1
- package/lib/services/storage/storage.service.mock.d.ts +0 -8
- package/lib/services/storage/storage.service.mock.d.ts.map +0 -1
- package/lib/services/store/actions/app.actions.d.ts +0 -119
- package/lib/services/store/actions/app.actions.d.ts.map +0 -1
- package/lib/services/store/actions/i18n.actions.d.ts +0 -21
- package/lib/services/store/actions/i18n.actions.d.ts.map +0 -1
- package/lib/services/store/actions/index.d.ts +0 -6
- package/lib/services/store/actions/index.d.ts.map +0 -1
- package/lib/services/store/actions/locale.actions.d.ts +0 -21
- package/lib/services/store/actions/locale.actions.d.ts.map +0 -1
- package/lib/services/store/actions/notifications.actions.d.ts +0 -20
- package/lib/services/store/actions/notifications.actions.d.ts.map +0 -1
- package/lib/services/store/actions/user.actions.d.ts +0 -57
- package/lib/services/store/actions/user.actions.d.ts.map +0 -1
- package/lib/services/store/index.d.ts +0 -5
- package/lib/services/store/index.d.ts.map +0 -1
- package/lib/services/store/ngrx_kit.d.ts +0 -54
- package/lib/services/store/ngrx_kit.d.ts.map +0 -1
- package/lib/services/store/reducers/app.reducers.d.ts +0 -7
- package/lib/services/store/reducers/app.reducers.d.ts.map +0 -1
- package/lib/services/store/reducers/core.reducers.d.ts +0 -7
- package/lib/services/store/reducers/core.reducers.d.ts.map +0 -1
- package/lib/services/store/reducers/i18n.reducers.d.ts +0 -7
- package/lib/services/store/reducers/i18n.reducers.d.ts.map +0 -1
- package/lib/services/store/reducers/index.d.ts +0 -8
- package/lib/services/store/reducers/index.d.ts.map +0 -1
- package/lib/services/store/reducers/locale.reducers.d.ts +0 -7
- package/lib/services/store/reducers/locale.reducers.d.ts.map +0 -1
- package/lib/services/store/reducers/meta.reducers.d.ts +0 -32
- package/lib/services/store/reducers/meta.reducers.d.ts.map +0 -1
- package/lib/services/store/reducers/notifications.reducers.d.ts +0 -7
- package/lib/services/store/reducers/notifications.reducers.d.ts.map +0 -1
- package/lib/services/store/reducers/user.reducers.d.ts +0 -7
- package/lib/services/store/reducers/user.reducers.d.ts.map +0 -1
- package/lib/services/store/store.service.d.ts +0 -72
- package/lib/services/store/store.service.d.ts.map +0 -1
- package/lib/services/store/store.service.mock.d.ts +0 -15
- package/lib/services/store/store.service.mock.d.ts.map +0 -1
- package/lib/services/user/index.d.ts +0 -3
- package/lib/services/user/index.d.ts.map +0 -1
- package/lib/services/user/user.service.d.ts +0 -46
- package/lib/services/user/user.service.d.ts.map +0 -1
- package/lib/services/user/user.service.mock.d.ts +0 -15
- package/lib/services/user/user.service.mock.d.ts.map +0 -1
package/index.d.ts
CHANGED
|
@@ -1,6 +1,2471 @@
|
|
|
1
|
+
import * as _eui_base from '@eui/base';
|
|
2
|
+
import { EuiEnvConfig, EuiAppJsonConfig, EuiConfig, ModuleConfig, EuiAppConfig, GlobalConfig, LogConfig, HttpErrorHandlerConfig, ConnectionStatus, EuiAppHandlersConfig, Logger, LogLevel, LogAppender, LoggerMock, HttpErrorRouteConfig, ApiQueueItem, I18nState, UserState, UserDetails, UserPreferences, EuiUserRight, LocaleState, AppState, CoreState, NotificationsState, DeepPartial, I18nLoaderConfig, EuiLazyService, I18nServiceConfig, EuiServiceStatus, EuiService, EuiMenuItem, EuiLanguage, LocaleServiceConfig, EuiGrowlMessage, ErrorMappingHandler } from '@eui/base';
|
|
1
3
|
export * from '@eui/base';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
import * as i0 from '@angular/core';
|
|
5
|
+
import { InjectionToken, ModuleWithProviders, EnvironmentProviders, Injector, ErrorHandler, OnDestroy, Signal, ElementRef, DebugElement, Type } from '@angular/core';
|
|
6
|
+
import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent, HttpErrorResponse, HttpClient, HttpResponseBase } from '@angular/common/http';
|
|
7
|
+
import { Router, ActivatedRoute } from '@angular/router';
|
|
8
|
+
import { Observable, BehaviorSubject } from 'rxjs';
|
|
9
|
+
import { TranslateLoader, TranslateService } from '@ngx-translate/core';
|
|
10
|
+
import { ComponentType, DomPortalOutlet } from '@angular/cdk/portal';
|
|
11
|
+
import { ComponentFixture } from '@angular/core/testing';
|
|
12
|
+
import { AbstractControl, FormGroup, FormArray, FormControl } from '@angular/forms';
|
|
13
|
+
|
|
14
|
+
declare const CORE_ROOT_GUARD: InjectionToken<void>;
|
|
15
|
+
declare class CoreModule {
|
|
16
|
+
/**
|
|
17
|
+
* No more providing config from forRoot, you have to use EUI_CONFIG_TOKEN to pass config via providers.
|
|
18
|
+
*/
|
|
19
|
+
static forRoot(): ModuleWithProviders<CoreModule>;
|
|
20
|
+
static forChild(moduleName: string): ModuleWithProviders<CoreModule>;
|
|
21
|
+
constructor();
|
|
22
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<CoreModule, never>;
|
|
23
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<CoreModule, never, never, never>;
|
|
24
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<CoreModule>;
|
|
25
|
+
}
|
|
26
|
+
declare const createEuiCoreRootGuard: (core: any) => string;
|
|
27
|
+
declare class EuiCoreRootGuardClass {
|
|
28
|
+
constructor();
|
|
29
|
+
}
|
|
30
|
+
declare const euiCoreRootGuardClass: () => EuiCoreRootGuardClass;
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Function to be used before the AppModule is bootstrapped. It is currently used to load dynamic configurations.
|
|
34
|
+
* It needs to be added in your application main.ts file.
|
|
35
|
+
* @param envConfig the current environment configuration
|
|
36
|
+
* @returns the updated environment configuration, as a promise
|
|
37
|
+
*/
|
|
38
|
+
declare function preInitApp(envConfig: EuiEnvConfig): Promise<EuiEnvConfig>;
|
|
39
|
+
/**
|
|
40
|
+
* Function to load asynchronously a dynamic configuration (from a local path or a web service)
|
|
41
|
+
*
|
|
42
|
+
* @param url the path to the configuration
|
|
43
|
+
* @param timeout possible timeout
|
|
44
|
+
* @returns EuiAppJsonConfig promise
|
|
45
|
+
*/
|
|
46
|
+
declare function loadEuiDynamicEnvironmentConfig(url: string, timeout?: number): Promise<EuiAppJsonConfig>;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Initializes the app with the necessary configurations. Use this in combination with `provideAppInitializer(euiInitApp_Env)`
|
|
50
|
+
*/
|
|
51
|
+
declare function provideEuiInitializer(): EnvironmentProviders;
|
|
52
|
+
/**
|
|
53
|
+
* Initializes the app with the necessary configurations
|
|
54
|
+
* @param injector
|
|
55
|
+
* @deprecated Use `provideEuiInitializer()` instead. Beware that this should be declared as Environment providers.
|
|
56
|
+
*/
|
|
57
|
+
declare const euiInitApp: (injector: Injector) => () => Promise<null>;
|
|
58
|
+
|
|
59
|
+
declare const EUI_CONFIG_TOKEN: InjectionToken<EuiConfig>;
|
|
60
|
+
declare const MODULE_NAME_TOKEN: InjectionToken<string>;
|
|
61
|
+
declare const MODULE_CONFIG_TOKEN: InjectionToken<ModuleConfig<any>>;
|
|
62
|
+
declare const CONFIG_TOKEN: InjectionToken<EuiAppConfig>;
|
|
63
|
+
declare const GLOBAL_CONFIG_TOKEN: InjectionToken<GlobalConfig<any>>;
|
|
64
|
+
declare const BASE_NAME_TOKEN: InjectionToken<string>;
|
|
65
|
+
declare const ROOT_LOG_CONFIG_TOKEN: InjectionToken<LogConfig>;
|
|
66
|
+
declare const SHOW_CONNECTION_STATUS_TOKEN: InjectionToken<boolean>;
|
|
67
|
+
declare const HTTP_ERROR_HANDLER_CONFIG_TOKEN: InjectionToken<HttpErrorHandlerConfig>;
|
|
68
|
+
declare function getGlobalConfig(appConfig: EuiAppConfig): GlobalConfig;
|
|
69
|
+
declare function getShowConnectionStatus(globalConfig: GlobalConfig): ConnectionStatus;
|
|
70
|
+
declare function getModuleConfig(appConfig: EuiAppConfig, moduleName: string): ModuleConfig;
|
|
71
|
+
declare function getHttpErrorHandlingConfig(appConfig: EuiAppConfig): HttpErrorHandlerConfig;
|
|
72
|
+
declare function getRootLogConfig(appConfig: EuiAppConfig): LogConfig;
|
|
73
|
+
declare function prepareEuiAppConfigToken(euiConfig: EuiConfig): EuiAppConfig;
|
|
74
|
+
declare function mergeAppHandlerConfigToAppConfig(euiAppConfig: EuiAppConfig, envAppHandler: EuiAppHandlersConfig): EuiAppConfig;
|
|
75
|
+
declare function mergeAppJsonConfigToAppConfig(euiAppConfig: EuiAppConfig, envAppJsonConfig: EuiAppJsonConfig, merge: Array<string>, isDeepMerge: boolean): EuiAppConfig;
|
|
76
|
+
|
|
77
|
+
declare const errorCodes: {
|
|
78
|
+
ERR_GENERIC: string;
|
|
79
|
+
};
|
|
80
|
+
declare class ErrorSubClass {
|
|
81
|
+
code?: string;
|
|
82
|
+
message: string;
|
|
83
|
+
stack: string;
|
|
84
|
+
name: string;
|
|
85
|
+
constructor(code?: string, msg?: string, args?: any);
|
|
86
|
+
}
|
|
87
|
+
declare class EuiError extends ErrorSubClass {
|
|
88
|
+
constructor(code?: string, msg?: string, args?: any);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
declare const BASE_LOGGER_NAME_TOKEN: InjectionToken<string>;
|
|
92
|
+
declare const LOG_LEVEL_TOKEN: InjectionToken<LogLevel>;
|
|
93
|
+
declare const LOG_APPENDERS_TOKEN: InjectionToken<LogAppender<_eui_base.LogAppenderConfig>[]>;
|
|
94
|
+
/**
|
|
95
|
+
* Log service, responsible for getting or creating loggers. It itself acts as a base logger
|
|
96
|
+
*/
|
|
97
|
+
declare class LogService extends Logger {
|
|
98
|
+
protected name: string;
|
|
99
|
+
protected level: LogLevel;
|
|
100
|
+
protected appenders: LogAppender[];
|
|
101
|
+
/** the list of persistent loggers */
|
|
102
|
+
protected loggers: {};
|
|
103
|
+
constructor();
|
|
104
|
+
/**
|
|
105
|
+
* Gets a logger by name. If the logger does not exist, it is created
|
|
106
|
+
*
|
|
107
|
+
* @param loggerName logger name
|
|
108
|
+
* @param persist optional parameter. Set it to true if you want to reuse the logger. By default, it is set to false
|
|
109
|
+
* @returns the logger
|
|
110
|
+
*/
|
|
111
|
+
getLogger(loggerName: string, persist?: boolean): Logger;
|
|
112
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LogService, never>;
|
|
113
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<LogService>;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
declare class LogServiceMock extends LoggerMock {
|
|
117
|
+
getLogger(): LoggerMock;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/**
|
|
121
|
+
* Log Module
|
|
122
|
+
*/
|
|
123
|
+
declare class LogModule {
|
|
124
|
+
/** method called in your root module to provide the LogService */
|
|
125
|
+
static forRoot(config?: LogConfig): ModuleWithProviders<LogModule>;
|
|
126
|
+
/** method called in your other (non root, lazy loaded) modules to import a different instance of LogService */
|
|
127
|
+
static forChild(config?: LogConfig): ModuleWithProviders<LogModule>;
|
|
128
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LogModule, never>;
|
|
129
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<LogModule, never, never, never>;
|
|
130
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<LogModule>;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
declare class GlobalErrorHandler extends ErrorHandler {
|
|
134
|
+
protected logService: LogService;
|
|
135
|
+
handleError(error: any): void;
|
|
136
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<GlobalErrorHandler, never>;
|
|
137
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<GlobalErrorHandler>;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
declare class HttpErrorHandlerInterceptor implements HttpInterceptor {
|
|
141
|
+
protected config: HttpErrorHandlerConfig;
|
|
142
|
+
protected injector: Injector;
|
|
143
|
+
protected router: Router;
|
|
144
|
+
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
|
|
145
|
+
/**
|
|
146
|
+
* Search in the configuration for the first matching route
|
|
147
|
+
*
|
|
148
|
+
* @param error http error response
|
|
149
|
+
* @returns HttpErrorRouteConfig or null
|
|
150
|
+
*/
|
|
151
|
+
protected getRouteConfig(error: HttpErrorResponse): HttpErrorRouteConfig | null;
|
|
152
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<HttpErrorHandlerInterceptor, never>;
|
|
153
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<HttpErrorHandlerInterceptor>;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
declare function AlertHttpErrorCallbackFn(error: HttpErrorResponse): void;
|
|
157
|
+
declare function ConsoleHttpErrorCallbackFn(error: HttpErrorResponse): void;
|
|
158
|
+
declare function LogHttpErrorCallbackFn(error: HttpErrorResponse, injector: Injector): void;
|
|
159
|
+
declare function GrowlHttpErrorCallbackFn(error: HttpErrorResponse, injector: Injector): void;
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* A function that takes an `Action` and a `State`, and returns a `State`.
|
|
163
|
+
* See `createReducer`.
|
|
164
|
+
*/
|
|
165
|
+
interface ActionReducer<T, V extends Action = Action> {
|
|
166
|
+
(state: T | undefined, action: V): T;
|
|
167
|
+
}
|
|
168
|
+
type ActionReducerMap<T, V extends Action = Action> = {
|
|
169
|
+
[p in keyof T]: ActionReducer<T[p], V>;
|
|
170
|
+
};
|
|
171
|
+
interface Action<Type extends string = string> {
|
|
172
|
+
type: Type;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* @deprecated it will be removed in the next major version
|
|
177
|
+
*/
|
|
178
|
+
declare enum CoreAppActionTypes {
|
|
179
|
+
INIT_STORE = "[App] Init store",
|
|
180
|
+
UPDATE_APP_VERSION = "[App] Update version",
|
|
181
|
+
UPDATE_APP_CONNECTION = "[App] Update connection",
|
|
182
|
+
ADD_APP_LOADED_CONFIG_MODULES = "[App] Update app loaded config modules",
|
|
183
|
+
UPDATE_APP_STATUS = "[App] Update status",
|
|
184
|
+
UPDATE_CURRENT_MODULE = "[App] Update current module",
|
|
185
|
+
ACTIVATED_ROUTE = "[App] Activated route",
|
|
186
|
+
ADD_API_QUEUE_ITEM = "[App] Add API queue item",
|
|
187
|
+
REMOVE_API_QUEUE_ITEM = "[App] Remove API queue item",
|
|
188
|
+
EMPTY_API_QUEUE = "[App] empty API queue"
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* @deprecated it will be removed in the next major version
|
|
192
|
+
*/
|
|
193
|
+
declare class InitStoreAction implements Action {
|
|
194
|
+
payload: {
|
|
195
|
+
version?: string;
|
|
196
|
+
};
|
|
197
|
+
type: CoreAppActionTypes;
|
|
198
|
+
constructor(payload: {
|
|
199
|
+
version?: string;
|
|
200
|
+
});
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* @deprecated it will be removed in the next major version
|
|
204
|
+
*/
|
|
205
|
+
declare class UpdateAppVersionAction implements Action {
|
|
206
|
+
payload: string;
|
|
207
|
+
type: CoreAppActionTypes;
|
|
208
|
+
constructor(payload: string);
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* @deprecated it will be removed in the next major version
|
|
212
|
+
*/
|
|
213
|
+
declare class UpdateAppConnectionAction implements Action {
|
|
214
|
+
payload: boolean;
|
|
215
|
+
type: CoreAppActionTypes;
|
|
216
|
+
constructor(payload: boolean);
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* @deprecated it will be removed in the next major version
|
|
220
|
+
*/
|
|
221
|
+
declare class AddAppLoadedConfigModulesAction implements Action {
|
|
222
|
+
payload: {
|
|
223
|
+
moduleName: string;
|
|
224
|
+
moduleConfig: ModuleConfig;
|
|
225
|
+
};
|
|
226
|
+
type: CoreAppActionTypes;
|
|
227
|
+
constructor(payload: {
|
|
228
|
+
moduleName: string;
|
|
229
|
+
moduleConfig: ModuleConfig;
|
|
230
|
+
});
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* @deprecated it will be removed in the next major version
|
|
234
|
+
*/
|
|
235
|
+
declare class UpdateAppStatusAction implements Action {
|
|
236
|
+
payload: string;
|
|
237
|
+
type: CoreAppActionTypes;
|
|
238
|
+
constructor(payload: string);
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* @deprecated it will be removed in the next major version
|
|
242
|
+
*/
|
|
243
|
+
declare class UpdateCurrentModuleAction implements Action {
|
|
244
|
+
payload: string;
|
|
245
|
+
type: CoreAppActionTypes;
|
|
246
|
+
constructor(payload: string);
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* @deprecated it will be removed in the next major version
|
|
250
|
+
*/
|
|
251
|
+
declare class ActivatedRouteAction implements Action {
|
|
252
|
+
payload: ActivatedRoute;
|
|
253
|
+
type: CoreAppActionTypes;
|
|
254
|
+
constructor(payload: ActivatedRoute);
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* @deprecated it will be removed in the next major version
|
|
258
|
+
*/
|
|
259
|
+
declare class AddApiQueueItemAction implements Action {
|
|
260
|
+
payload: {
|
|
261
|
+
id: string;
|
|
262
|
+
item: ApiQueueItem;
|
|
263
|
+
};
|
|
264
|
+
type: CoreAppActionTypes;
|
|
265
|
+
constructor(payload: {
|
|
266
|
+
id: string;
|
|
267
|
+
item: ApiQueueItem;
|
|
268
|
+
});
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* @deprecated it will be removed in the next major version
|
|
272
|
+
*/
|
|
273
|
+
declare class RemoveApiQueueItemAction implements Action {
|
|
274
|
+
payload: string;
|
|
275
|
+
type: CoreAppActionTypes;
|
|
276
|
+
constructor(payload: string);
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* @deprecated it will be removed in the next major version
|
|
280
|
+
*/
|
|
281
|
+
declare class EmptyApiQueueAction implements Action {
|
|
282
|
+
payload: any;
|
|
283
|
+
type: CoreAppActionTypes;
|
|
284
|
+
constructor(payload: any);
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* @deprecated it will be removed in the next major version
|
|
288
|
+
*/
|
|
289
|
+
type CoreAppActions = InitStoreAction | UpdateAppVersionAction | UpdateAppConnectionAction | AddAppLoadedConfigModulesAction | UpdateAppStatusAction | UpdateCurrentModuleAction | ActivatedRouteAction | AddApiQueueItemAction | RemoveApiQueueItemAction;
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* @deprecated it will be removed in the next major version
|
|
293
|
+
*/
|
|
294
|
+
declare enum CoreI18nActionTypes {
|
|
295
|
+
UPDATE_I18N_STATE = "[I18n] Update I18n State"
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* @deprecated it will be removed in the next major version
|
|
299
|
+
*/
|
|
300
|
+
declare class UpdateI18nStateAction implements Action {
|
|
301
|
+
payload: I18nState;
|
|
302
|
+
type: CoreI18nActionTypes;
|
|
303
|
+
constructor(payload: I18nState);
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* @deprecated it will be removed in the next major version
|
|
307
|
+
*/
|
|
308
|
+
type CoreI18nActions = UpdateI18nStateAction;
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* @deprecated it will be removed in the next major version
|
|
312
|
+
*/
|
|
313
|
+
declare enum CoreUserActionTypes {
|
|
314
|
+
UPDATE_USER_STATE = "[User] Update User state",
|
|
315
|
+
UPDATE_USER_DETAILS = "[User] Update details",
|
|
316
|
+
UPDATE_USER_PREFERENCES = "[User] Update preferences",
|
|
317
|
+
UPDATE_USER_RIGHTS = "[User] Update rights",
|
|
318
|
+
UPDATE_USER_DASHBOARD = "[User] Update dashboard"
|
|
319
|
+
}
|
|
320
|
+
/**
|
|
321
|
+
* @deprecated it will be removed in the next major version
|
|
322
|
+
*/
|
|
323
|
+
declare class UpdateUserStateAction implements Action {
|
|
324
|
+
payload: UserState;
|
|
325
|
+
type: CoreUserActionTypes;
|
|
326
|
+
constructor(payload: UserState);
|
|
327
|
+
}
|
|
328
|
+
/**
|
|
329
|
+
* @deprecated it will be removed in the next major version
|
|
330
|
+
*/
|
|
331
|
+
declare class UpdateUserDetailsAction implements Action {
|
|
332
|
+
payload: UserDetails;
|
|
333
|
+
type: CoreUserActionTypes;
|
|
334
|
+
constructor(payload: UserDetails);
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* @deprecated it will be removed in the next major version
|
|
338
|
+
*/
|
|
339
|
+
declare class UpdateUserPreferencesAction implements Action {
|
|
340
|
+
payload: UserPreferences;
|
|
341
|
+
type: CoreUserActionTypes;
|
|
342
|
+
constructor(payload: UserPreferences);
|
|
343
|
+
}
|
|
344
|
+
/**
|
|
345
|
+
* @deprecated it will be removed in the next major version
|
|
346
|
+
*/
|
|
347
|
+
declare class UpdateUserRightsAction implements Action {
|
|
348
|
+
payload: EuiUserRight[];
|
|
349
|
+
type: CoreUserActionTypes;
|
|
350
|
+
constructor(payload: EuiUserRight[]);
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* @deprecated it will be removed in the next major version
|
|
354
|
+
*/
|
|
355
|
+
declare class UpdateUserDashboardAction implements Action {
|
|
356
|
+
payload: unknown;
|
|
357
|
+
type: CoreUserActionTypes;
|
|
358
|
+
constructor(payload: unknown);
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* @deprecated it will be removed in the next major version
|
|
362
|
+
*/
|
|
363
|
+
type CoreUserActions = UpdateUserDetailsAction | UpdateUserPreferencesAction | UpdateUserRightsAction | UpdateUserDashboardAction;
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* @deprecated it will be removed in the next major version
|
|
367
|
+
*/
|
|
368
|
+
declare enum CoreNotificationsActionTypes {
|
|
369
|
+
UPDATE_NOTIFICATIONS_LIST = "[Notif] Update list"
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* @deprecated it will be removed in the next major version
|
|
373
|
+
*/
|
|
374
|
+
declare class UpdateNotificationsListAction implements Action {
|
|
375
|
+
payload: any[];
|
|
376
|
+
type: CoreNotificationsActionTypes;
|
|
377
|
+
constructor(payload: any[]);
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* @deprecated it will be removed in the next major version
|
|
381
|
+
*/
|
|
382
|
+
type CoreNotificationsActions = UpdateNotificationsListAction;
|
|
383
|
+
|
|
384
|
+
/**
|
|
385
|
+
* @deprecated it will be removed in the next major version
|
|
386
|
+
*/
|
|
387
|
+
declare enum CoreLocaleActionTypes {
|
|
388
|
+
UPDATE_LOCALE_STATE = "[Locale] Update Locale State"
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* @deprecated it will be removed in the next major version
|
|
392
|
+
*/
|
|
393
|
+
declare class UpdateLocaleStateAction implements Action {
|
|
394
|
+
payload: LocaleState;
|
|
395
|
+
type: CoreLocaleActionTypes;
|
|
396
|
+
constructor(payload: LocaleState);
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* @deprecated it will be removed in the next major version
|
|
400
|
+
*/
|
|
401
|
+
type CoreLocaleActions = UpdateLocaleStateAction;
|
|
402
|
+
|
|
403
|
+
/**
|
|
404
|
+
* @deprecated it will be removed in the next major version
|
|
405
|
+
*/
|
|
406
|
+
declare const coreAppReducers: (state: AppState, action: Action) => AppState;
|
|
407
|
+
|
|
408
|
+
/**
|
|
409
|
+
* @deprecated it will be removed in the next major version
|
|
410
|
+
*/
|
|
411
|
+
declare const coreReducers: ActionReducerMap<CoreState, any>;
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* @deprecated it will be removed in the next major version
|
|
415
|
+
*/
|
|
416
|
+
declare const corI18nReducers: (state: I18nState, action: Action) => I18nState;
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* @deprecated it will be removed in the next major version
|
|
420
|
+
*/
|
|
421
|
+
declare const coreUserReducers: (state: UserState, action: Action) => UserState;
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* @deprecated it will be removed in the next major version
|
|
425
|
+
*/
|
|
426
|
+
declare const coreNotificationsReducers: (state: NotificationsState, action: Action) => NotificationsState;
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* Utility meta-reducer to load the state from the local storage
|
|
430
|
+
* @param platformId the platformId based on PLATFORM_ID token of Angular
|
|
431
|
+
* @deprecated it will be removed in the next major version
|
|
432
|
+
*/
|
|
433
|
+
declare function localStorageSync<S extends CoreState>(platformId: unknown): ((reducer: ActionReducer<S>) => (state: S, action: Action) => S);
|
|
434
|
+
/**
|
|
435
|
+
* Utility meta-reducer to load the state from the local storage
|
|
436
|
+
* @param reducer the action reducer
|
|
437
|
+
*/
|
|
438
|
+
declare function localStorageSync<S extends CoreState>(reducer: ActionReducer<S>): (state: S, action: Action) => S;
|
|
439
|
+
/**
|
|
440
|
+
* Utility meta-reducer to load the state from the session storage
|
|
441
|
+
* @param platformId the platformId based on PLATFORM_ID token of Angular
|
|
442
|
+
* @deprecated it will be removed in the next major version
|
|
443
|
+
*/
|
|
444
|
+
declare function sessionStorageSync<S extends CoreState>(platformId: unknown): ((reducer: ActionReducer<S>) => (state: S, action: Action) => S);
|
|
445
|
+
/**
|
|
446
|
+
* Utility meta-reducer to load the state from the session storage
|
|
447
|
+
* @param reducer the action reducer
|
|
448
|
+
* @deprecated it will be removed in the next major version
|
|
449
|
+
*/
|
|
450
|
+
declare function sessionStorageSync<S extends CoreState>(reducer: ActionReducer<S>): (state: S, action: Action) => S;
|
|
451
|
+
/**
|
|
452
|
+
*
|
|
453
|
+
* @param storage Type of storage to load the state from
|
|
454
|
+
* @deprecated it will be removed in the next major version
|
|
455
|
+
*/
|
|
456
|
+
declare const loadState: <S extends CoreState>(storage?: Storage | null) => S;
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* @deprecated it will be removed in the next major version
|
|
460
|
+
*/
|
|
461
|
+
declare const coreLocaleReducers: (state: LocaleState, action: Action) => LocaleState;
|
|
462
|
+
|
|
463
|
+
declare enum BrowserStorageType {
|
|
464
|
+
local = 0,
|
|
465
|
+
session = 1
|
|
466
|
+
}
|
|
467
|
+
type Handler<T> = (state: T[keyof T]) => Partial<T[keyof T]>;
|
|
468
|
+
declare class StoreService<T = any> {
|
|
469
|
+
protected logService: LogService;
|
|
470
|
+
private platformId;
|
|
471
|
+
/**
|
|
472
|
+
* autoSave handlers to call before saving in local Storage
|
|
473
|
+
*/
|
|
474
|
+
protected _autoSaveHandlers: {
|
|
475
|
+
[key: string]: Handler<T>;
|
|
476
|
+
};
|
|
477
|
+
/** storage instance e.g. localStorage, sessionStorage */
|
|
478
|
+
private _storage;
|
|
479
|
+
private state;
|
|
480
|
+
private isHandlingAutoSave;
|
|
481
|
+
constructor();
|
|
482
|
+
init(version?: string, storageType?: BrowserStorageType): void;
|
|
483
|
+
/**
|
|
484
|
+
* Add an autoSave handler for a specific state slice
|
|
485
|
+
* @param stateSlice
|
|
486
|
+
* @param handler
|
|
487
|
+
* @deprecated it will be removed in the next major version
|
|
488
|
+
*/
|
|
489
|
+
addAutoSaveHandler(stateSlice: string, handler: Handler<T>): void;
|
|
490
|
+
handleAutoSave(): void;
|
|
491
|
+
/**
|
|
492
|
+
* Proxy to NGRX store.dispatch()
|
|
493
|
+
* that allows to intercept if the store is present
|
|
494
|
+
*
|
|
495
|
+
* @deprecated it will be removed in the next version support of NGRX will cease
|
|
496
|
+
*/
|
|
497
|
+
dispatch(action: unknown): void;
|
|
498
|
+
/**
|
|
499
|
+
* This method is used to update the state of the service with a new state.
|
|
500
|
+
*
|
|
501
|
+
* @param state
|
|
502
|
+
*/
|
|
503
|
+
updateState(state: DeepPartial<T>): void;
|
|
504
|
+
/**
|
|
505
|
+
* @deprecated it will be removed in next version. Use updateState(partialState: DeepPartial<T>) instead
|
|
506
|
+
* @param slice
|
|
507
|
+
* @param reducer
|
|
508
|
+
*/
|
|
509
|
+
updateState(slice: DeepPartial<T>, reducer: (state: T, action: DeepPartial<T>) => T): void;
|
|
510
|
+
select(key?: any): Observable<T[any]>;
|
|
511
|
+
/**
|
|
512
|
+
* filters and save the state with the Browser storage
|
|
513
|
+
* @param state type of CoreState
|
|
514
|
+
*/
|
|
515
|
+
protected saveState(state: CoreState): void;
|
|
516
|
+
/**
|
|
517
|
+
* deep merge two objects
|
|
518
|
+
* @param target the object that will be merged into
|
|
519
|
+
* @param source the object that will be merged from
|
|
520
|
+
*/
|
|
521
|
+
private deepMerge;
|
|
522
|
+
/**
|
|
523
|
+
* checks if the given item is an object
|
|
524
|
+
* @param item the item that will be checked
|
|
525
|
+
*/
|
|
526
|
+
private isObject;
|
|
527
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<StoreService<any>, never>;
|
|
528
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<StoreService<any>>;
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
declare const PLATFORM_BROWSER_ID = "browser";
|
|
532
|
+
declare class StoreServiceMock extends StoreService {
|
|
533
|
+
constructor();
|
|
534
|
+
init(): void;
|
|
535
|
+
addAutoSaveHandler(): void;
|
|
536
|
+
handleAutoSave(): void;
|
|
537
|
+
dispatch(): void;
|
|
538
|
+
select(): Observable<object>;
|
|
539
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<StoreServiceMock, never>;
|
|
540
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<StoreServiceMock>;
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
/**
|
|
544
|
+
* Service class for managing and processing a queue of API requests.
|
|
545
|
+
*
|
|
546
|
+
* This service provides functionality to add, remove, process, and manage HTTP requests stored in a queue.
|
|
547
|
+
* It enables sequential or bulk processing of requests, ensuring controlled execution and handling of API calls.
|
|
548
|
+
* The service methods offer features like processing individual items, processing all items in the queue either
|
|
549
|
+
* sequentially or all at once, and removing items from the queue. Each method is designed to handle specific aspects
|
|
550
|
+
* of queue management and processing, with attention to details like order of execution and error handling.
|
|
551
|
+
*
|
|
552
|
+
* Usage of this service is ideal in scenarios where API requests need to be managed in a queue structure, allowing
|
|
553
|
+
* for controlled execution and monitoring of these requests.
|
|
554
|
+
*
|
|
555
|
+
* @example
|
|
556
|
+
* // Adding a new item to the queue
|
|
557
|
+
* apiQueueService.addQueueItem({ id: 'item124', method: 'POST', uri: '/api/data', payload: {...} });
|
|
558
|
+
*
|
|
559
|
+
* // Processing a single item from the queue
|
|
560
|
+
* apiQueueService.processQueueItem('item123').subscribe(result => {
|
|
561
|
+
* console.log('Processed item 123 with result:', result);
|
|
562
|
+
* });
|
|
563
|
+
*
|
|
564
|
+
* // Processing all items in the queue in sequential order
|
|
565
|
+
* apiQueueService.processAllQueueItemsSequential(false).subscribe(results => {
|
|
566
|
+
* console.log('Processed all items in descending order of their timestamp:', results);
|
|
567
|
+
* });
|
|
568
|
+
*
|
|
569
|
+
* // Removing an item from the queue
|
|
570
|
+
* apiQueueService.removeQueueItem('item123');
|
|
571
|
+
*
|
|
572
|
+
* // Processing all items in the queue and continuing on error
|
|
573
|
+
* apiQueueService.processAllQueueItems(true).subscribe(results => {
|
|
574
|
+
* console.log('Processed all items in the queue with continuation on errors:', results);
|
|
575
|
+
* });
|
|
576
|
+
*/
|
|
577
|
+
declare class ApiQueueService {
|
|
578
|
+
protected store: StoreService<any>;
|
|
579
|
+
protected http: HttpClient;
|
|
580
|
+
protected logService: LogService;
|
|
581
|
+
private readonly logger;
|
|
582
|
+
private readonly getAppState;
|
|
583
|
+
private getApiQueue;
|
|
584
|
+
private getApiQueueItem;
|
|
585
|
+
constructor();
|
|
586
|
+
/**
|
|
587
|
+
* Adds an item to the queue by dispatching an action to the store.
|
|
588
|
+
* This function is specifically designed to enqueue API call requests represented by `ApiQueueItem` objects.
|
|
589
|
+
* Each item is identified by a unique `id`, which is used to manage the queue.
|
|
590
|
+
*
|
|
591
|
+
* @param {string} id - The unique identifier for the queue item. It's crucial to ensure that this ID is unique within the queue.
|
|
592
|
+
* If an item with the same ID already exists, the new item will overwrite the existing one.
|
|
593
|
+
* WARNING: Duplicate IDs will lead to overwriting of queue items.
|
|
594
|
+
*
|
|
595
|
+
* @param {ApiQueueItem} item - The item to be enqueued. This should be an object of type `ApiQueueItem`.
|
|
596
|
+
* The `method` property of the item must be one of the allowed methods ('post', 'put', 'get').
|
|
597
|
+
* If an unsupported method is provided, the function will throw an error.
|
|
598
|
+
*
|
|
599
|
+
* @throws {Error} Throws an error if the `method` property of the `item` is not one of the allowed methods.
|
|
600
|
+
* The error message is: `[ApiQueue] method "${item.method}" is not allowed`.
|
|
601
|
+
*
|
|
602
|
+
* @example
|
|
603
|
+
* // Example of adding an item to the API queue
|
|
604
|
+
* addQueueItem('12345', { method: 'post', url: '/api/data', payload: {...} });
|
|
605
|
+
*
|
|
606
|
+
* @returns {void} This function does not return a value. It adds the item to the queue via a dispatch action.
|
|
607
|
+
*/
|
|
608
|
+
addQueueItem(id: string, item: ApiQueueItem): void;
|
|
609
|
+
/**
|
|
610
|
+
* Retrieves the current state of the API queue and converts it into an array of Observables.
|
|
611
|
+
*
|
|
612
|
+
* This method subscribes to the store to access the API queue. It then maps the queue object,
|
|
613
|
+
* which is an associative array, into a linear array of ApiQueueItem instances. If the queue is empty,
|
|
614
|
+
* a warning is logged. This method is useful for tracking the state and contents of the API queue
|
|
615
|
+
* at a given moment.
|
|
616
|
+
*
|
|
617
|
+
* Note: This method takes a snapshot of the queue at the time of subscription. It does not provide
|
|
618
|
+
* a continuous stream of queue updates. To get real-time updates, consider subscribing directly
|
|
619
|
+
* to the store's observable.
|
|
620
|
+
*
|
|
621
|
+
* @returns {Observable<ApiQueueItem[]>} An Observable that emits an array of ApiQueueItem.
|
|
622
|
+
* The array represents all items currently in the queue. If the queue is empty, it emits an empty array.
|
|
623
|
+
*
|
|
624
|
+
* @example
|
|
625
|
+
* // Example usage
|
|
626
|
+
* this.getQueue().subscribe(queueItems => {
|
|
627
|
+
* console.log('Current queue items:', queueItems);
|
|
628
|
+
* });
|
|
629
|
+
*/
|
|
630
|
+
getQueue(): Observable<ApiQueueItem[]>;
|
|
631
|
+
/**
|
|
632
|
+
* Retrieves a specific item from the API queue by its ID.
|
|
633
|
+
*
|
|
634
|
+
* This method subscribes to the store and selects a single item from the API queue based on the provided ID.
|
|
635
|
+
* It employs a pipeline to fetch the item: the `getApiQueueItem` selector is used to retrieve the item,
|
|
636
|
+
* and a `map` operator processes the result. If the item with the specified ID does not exist in the queue,
|
|
637
|
+
* a warning is logged, and `null` is returned.
|
|
638
|
+
*
|
|
639
|
+
* This method is ideal for accessing a specific queue item when its ID is known, allowing for targeted
|
|
640
|
+
* operations or checks on that particular item.
|
|
641
|
+
*
|
|
642
|
+
* @param {string} id - The unique identifier of the item within the queue.
|
|
643
|
+
* @returns {Observable<ApiQueueItem | null>} An Observable emitting the requested ApiQueueItem.
|
|
644
|
+
* If no item with the given ID exists in the queue, the Observable emits `null`.
|
|
645
|
+
*
|
|
646
|
+
* @example
|
|
647
|
+
* // Example usage
|
|
648
|
+
* this.getQueueItem('item123').subscribe(item => {
|
|
649
|
+
* if (item) {
|
|
650
|
+
* console.log('Found item:', item);
|
|
651
|
+
* } else {
|
|
652
|
+
* console.log('Item not found in the queue');
|
|
653
|
+
* }
|
|
654
|
+
* });
|
|
655
|
+
*/
|
|
656
|
+
getQueueItem(id: string): Observable<ApiQueueItem>;
|
|
657
|
+
/**
|
|
658
|
+
* Removes a specific item from the API queue using its ID.
|
|
659
|
+
*
|
|
660
|
+
* This method dispatches an action to remove an item from the queue, identified by the provided ID.
|
|
661
|
+
* It is essential for managing the queue by eliminating items that are no longer needed or have been processed.
|
|
662
|
+
* The function does not return any value, as it primarily triggers an action within the store.
|
|
663
|
+
*
|
|
664
|
+
* Note: This method assumes the existence of the item in the queue. It does not perform a check
|
|
665
|
+
* to confirm the presence of the item before attempting to remove it. Therefore, it's recommended
|
|
666
|
+
* to verify the item's existence in the queue if uncertainty exists.
|
|
667
|
+
*
|
|
668
|
+
* @param {string} id - The unique identifier of the item to be removed from the queue.
|
|
669
|
+
*
|
|
670
|
+
* @example
|
|
671
|
+
* // Example usage
|
|
672
|
+
* this.removeQueueItem('item123');
|
|
673
|
+
* // The item with ID 'item123' will be dispatched for removal from the queue.
|
|
674
|
+
*/
|
|
675
|
+
removeQueueItem(id: string): void;
|
|
676
|
+
/**
|
|
677
|
+
* Clears all items from the API queue.
|
|
678
|
+
*
|
|
679
|
+
* This method dispatches an action to empty the entire API queue, effectively removing all items that are currently queued.
|
|
680
|
+
* It is useful for scenarios where a complete reset of the queue is required, such as during initialization or after processing
|
|
681
|
+
* a batch of items. The function does not return any value, as its primary purpose is to trigger a state change in the store.
|
|
682
|
+
*
|
|
683
|
+
* Note: Use this method with caution as it will irreversibly clear all items in the queue. Ensure that this action does not
|
|
684
|
+
* disrupt any ongoing processes that rely on the queue's contents.
|
|
685
|
+
*
|
|
686
|
+
* @example
|
|
687
|
+
* // Example usage
|
|
688
|
+
* this.removeAllQueueItem();
|
|
689
|
+
* // This will dispatch an action to empty the entire API queue.
|
|
690
|
+
*/
|
|
691
|
+
removeAllQueueItem(): void;
|
|
692
|
+
/**
|
|
693
|
+
* Processes an item from the API queue identified by its ID.
|
|
694
|
+
*
|
|
695
|
+
* Retrieves the specified item from the queue and applies processing logic as defined in `buildHttpRequest`.
|
|
696
|
+
* If the item is not found, logs a warning and returns an Observable emitting `null`.
|
|
697
|
+
*
|
|
698
|
+
* @param {string} id - The unique identifier of the item within the queue to be processed.
|
|
699
|
+
* @returns {Observable<any>} An Observable that emits the result of processing the queue item.
|
|
700
|
+
* If the item does not exist, the Observable emits `null`.
|
|
701
|
+
*
|
|
702
|
+
* @example
|
|
703
|
+
* // Example usage
|
|
704
|
+
* this.processQueueItem('item123').subscribe(result => {
|
|
705
|
+
* if (result) {
|
|
706
|
+
* console.log('Processing result:', result);
|
|
707
|
+
* } else {
|
|
708
|
+
* console.log('Item not found in the queue');
|
|
709
|
+
* }
|
|
710
|
+
* });
|
|
711
|
+
*/
|
|
712
|
+
processQueueItem<T>(id: string): Observable<T>;
|
|
713
|
+
/**
|
|
714
|
+
* Processes all items in the API queue and collects their responses.
|
|
715
|
+
*
|
|
716
|
+
* Iterates over each item in the queue and processes them using `buildHttpRequest`. If a request fails,
|
|
717
|
+
* the method can either continue processing the remaining items or stop, based on the `continueOnError` parameter.
|
|
718
|
+
* It returns an Observable that emits an array containing the responses or errors from all the processed items.
|
|
719
|
+
*
|
|
720
|
+
* The function currently returns `Observable<any[]>` indicating an array of any type. Future improvements
|
|
721
|
+
* should aim to specify a more accurate return type or utilize generics for increased type safety.
|
|
722
|
+
*
|
|
723
|
+
* @param {boolean} [continueOnError=true] - Determines whether to continue with the next item in the queue
|
|
724
|
+
* after a request failure. Defaults to `true`.
|
|
725
|
+
* @returns {Observable<any[]>} An Observable emitting an array of either responses or errors from the processed
|
|
726
|
+
* queue items.
|
|
727
|
+
*
|
|
728
|
+
* @example
|
|
729
|
+
* this.processAllQueueItems().subscribe(results => {
|
|
730
|
+
* // Handle the array of responses or errors
|
|
731
|
+
* });
|
|
732
|
+
*/
|
|
733
|
+
processAllQueueItems<T>(continueOnError?: boolean): Observable<T[]>;
|
|
734
|
+
/**
|
|
735
|
+
* Processes all items in the queue sequentially, based on their timestamp ordering.
|
|
736
|
+
*
|
|
737
|
+
* This method first orders the items in the API queue by their timestamp, either in ascending or descending
|
|
738
|
+
* order as specified by the `ascending` parameter. It then processes each item using `buildHttpRequest`, ensuring
|
|
739
|
+
* that each request is completed before the next begins. This sequential processing is crucial when the order of
|
|
740
|
+
* execution matters for HTTP requests in the queue. The method returns an Observable that emits the responses
|
|
741
|
+
* following the same order as the queue items were processed.
|
|
742
|
+
*
|
|
743
|
+
* The function currently returns `Observable<any>`, indicating a broad type. Future improvements should focus on
|
|
744
|
+
* specifying a more accurate return type or utilizing generics for increased type safety.
|
|
745
|
+
*
|
|
746
|
+
* @param {boolean} [ascending=true] - Determines whether the queue items are processed in ascending order of their
|
|
747
|
+
* timestamp. Defaults to `true`.
|
|
748
|
+
* @returns {Observable<any>} An Observable emitting the responses of the HTTP requests in the order they were processed.
|
|
749
|
+
*
|
|
750
|
+
* @example
|
|
751
|
+
* this.processAllQueueItemsSequential().subscribe(response => {
|
|
752
|
+
* // Handle each response in the order of queue processing
|
|
753
|
+
* });
|
|
754
|
+
*/
|
|
755
|
+
processAllQueueItemsSequential<T>(ascending?: boolean): Observable<T>;
|
|
756
|
+
/**
|
|
757
|
+
* Compares two queue items based on their timestamp and determines their order.
|
|
758
|
+
*
|
|
759
|
+
* This protected method is used to sort queue items. It takes two queue items as input, each represented
|
|
760
|
+
* as a tuple containing an item ID and the `ApiQueueItem` object. The method compares these items based on
|
|
761
|
+
* the `timestamp` property of the `ApiQueueItem` objects. It returns a number indicating the order in which
|
|
762
|
+
* these items should be sorted.
|
|
763
|
+
*
|
|
764
|
+
* A positive return value indicates that the first item should come after the second, a negative value
|
|
765
|
+
* indicates the opposite, and zero indicates that they are equal in terms of timestamp.
|
|
766
|
+
*
|
|
767
|
+
* @param {[string, ApiQueueItem]} a - The first queue item tuple for comparison.
|
|
768
|
+
* @param {[string, ApiQueueItem]} b - The second queue item tuple for comparison.
|
|
769
|
+
* @returns {number} A number indicating the order of the items: negative if `a` is earlier than `b`,
|
|
770
|
+
* positive if `a` is later than `b`, and zero if they are equal.
|
|
771
|
+
* @beta
|
|
772
|
+
*/
|
|
773
|
+
protected sortOnTimestamp(a: [string, ApiQueueItem], b: [string, ApiQueueItem]): number;
|
|
774
|
+
/**
|
|
775
|
+
* Constructs and executes an HTTP request based on the provided queue item details.
|
|
776
|
+
*
|
|
777
|
+
* This private method takes an ID and an `ApiQueueItem` object to build and execute an HTTP request.
|
|
778
|
+
* It determines the HTTP method (like GET, POST, etc.) from the `method` property of the `ApiQueueItem`,
|
|
779
|
+
* and uses the `uri` and `payload` properties for the request's URL and body, respectively. After the
|
|
780
|
+
* request is executed, the corresponding queue item is removed from the queue.
|
|
781
|
+
*
|
|
782
|
+
* The method is generic, allowing the caller to specify the expected response type `T`. By default,
|
|
783
|
+
* it uses `any` type, but specifying a more concrete type enhances type safety and clarity in usage.
|
|
784
|
+
*
|
|
785
|
+
* @param {string} id - The ID of the queue item being processed.
|
|
786
|
+
* @param {ApiQueueItem} item - The queue item containing details for the HTTP request.
|
|
787
|
+
* @returns {Observable<T>} An Observable of type T, representing the response of the HTTP request.
|
|
788
|
+
*
|
|
789
|
+
* @example
|
|
790
|
+
* // Example usage for a specific response type
|
|
791
|
+
* this.buildHttpRequest<MyResponseType>('item123', queueItem)
|
|
792
|
+
* .subscribe(response => {
|
|
793
|
+
* // Handle the response
|
|
794
|
+
* });
|
|
795
|
+
*
|
|
796
|
+
* @template T - The expected type of the HTTP response. Defaults to `any`.
|
|
797
|
+
*/
|
|
798
|
+
private buildHttpRequest;
|
|
799
|
+
/**
|
|
800
|
+
* A state reducer that adds an item to the API queue.
|
|
801
|
+
* @param state
|
|
802
|
+
* @param action
|
|
803
|
+
*/
|
|
804
|
+
private addApiQueueItem;
|
|
805
|
+
/**
|
|
806
|
+
* A state reducer that removes an item from the API queue.
|
|
807
|
+
* @param state
|
|
808
|
+
* @param action
|
|
809
|
+
*/
|
|
810
|
+
private removeApiQueueItem;
|
|
811
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ApiQueueService, never>;
|
|
812
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ApiQueueService>;
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
declare class ApiQueueServiceMock extends ApiQueueService {
|
|
816
|
+
constructor();
|
|
817
|
+
getQueue(): Observable<ApiQueueItem[]>;
|
|
818
|
+
getQueueItem(id: string): Observable<ApiQueueItem>;
|
|
819
|
+
removeAllQueueItem(): void;
|
|
820
|
+
processAllQueueItems<T>(): Observable<T>;
|
|
821
|
+
addQueueItem(): void;
|
|
822
|
+
removeQueueItem(): void;
|
|
823
|
+
processQueueItem<T>(): Observable<T>;
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
declare class I18nResourceImpl {
|
|
827
|
+
protected prefix: string;
|
|
828
|
+
protected suffix: string;
|
|
829
|
+
protected compileTranslationsFn: (translations: unknown, lang: string) => unknown;
|
|
830
|
+
/**
|
|
831
|
+
* Resource constructor
|
|
832
|
+
*
|
|
833
|
+
* @param prefix the prefix of the resource
|
|
834
|
+
* @param suffix the suffix of the resource, optional parameter
|
|
835
|
+
* @param compileTranslationsFn compiler function, optional parameter
|
|
836
|
+
*/
|
|
837
|
+
constructor(prefix: string, suffix?: string, compileTranslationsFn?: (translations: unknown, lang: string) => unknown);
|
|
838
|
+
/**
|
|
839
|
+
* Translations pre-processor
|
|
840
|
+
*
|
|
841
|
+
* @param translations the object to be pre-processed
|
|
842
|
+
* @param lang the translations language
|
|
843
|
+
* @returns the pre-processed translations
|
|
844
|
+
*/
|
|
845
|
+
compileTranslations(translations: unknown, lang: string): unknown;
|
|
846
|
+
/**
|
|
847
|
+
* Indicates whether other object is equal-to this one.
|
|
848
|
+
*
|
|
849
|
+
* @param obj the reference object with which to compare
|
|
850
|
+
* @returns true if this object is the same as obj, false otherwise
|
|
851
|
+
*/
|
|
852
|
+
equals(obj: I18nResourceImpl): boolean;
|
|
853
|
+
/**
|
|
854
|
+
* The path to the resource
|
|
855
|
+
*
|
|
856
|
+
* @param lang the resource language
|
|
857
|
+
* @returns the path
|
|
858
|
+
*/
|
|
859
|
+
getPath(lang: string): string;
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
interface ResourceError {
|
|
863
|
+
isError: boolean;
|
|
864
|
+
error?: string;
|
|
865
|
+
resource?: I18nResourceImpl;
|
|
866
|
+
}
|
|
867
|
+
interface LoadedResources {
|
|
868
|
+
translations: object;
|
|
869
|
+
hasError: boolean;
|
|
870
|
+
errors?: Array<LoadedResourcesError>;
|
|
871
|
+
}
|
|
872
|
+
interface LoadedResourcesError {
|
|
873
|
+
resource: I18nResourceImpl;
|
|
874
|
+
error: string;
|
|
875
|
+
}
|
|
876
|
+
interface TranslationKeys {
|
|
877
|
+
[key: string]: string;
|
|
878
|
+
}
|
|
879
|
+
declare class I18nLoader implements TranslateLoader {
|
|
880
|
+
protected http: HttpClient;
|
|
881
|
+
protected logService: LogService;
|
|
882
|
+
protected euiAppConfig: EuiAppConfig;
|
|
883
|
+
protected resources: I18nResourceImpl[];
|
|
884
|
+
protected failedResources: Array<LoadedResourcesError>;
|
|
885
|
+
private logger;
|
|
886
|
+
constructor();
|
|
887
|
+
/**
|
|
888
|
+
* Gets the translations from the server
|
|
889
|
+
*
|
|
890
|
+
* @param lang
|
|
891
|
+
* @returns Observable<object>
|
|
892
|
+
*/
|
|
893
|
+
getTranslation(lang: string): Observable<object>;
|
|
894
|
+
/**
|
|
895
|
+
* Adds resources
|
|
896
|
+
*
|
|
897
|
+
* @param config loader configuration
|
|
898
|
+
* @returns Observable<any> | false
|
|
899
|
+
*/
|
|
900
|
+
addResources(config: I18nLoaderConfig): I18nResourceImpl[];
|
|
901
|
+
/**
|
|
902
|
+
* Removes resources from the loader instance
|
|
903
|
+
*/
|
|
904
|
+
removeResources(removedResources: I18nResourceImpl[]): void;
|
|
905
|
+
/**
|
|
906
|
+
* Loads an array of resources, by language
|
|
907
|
+
*
|
|
908
|
+
* @param resources the definition of the resources
|
|
909
|
+
* @param lang the resource language to load
|
|
910
|
+
* @returns Observable<any>
|
|
911
|
+
*/
|
|
912
|
+
loadResources(resources: I18nResourceImpl[], lang: string): Observable<{
|
|
913
|
+
hasError: boolean;
|
|
914
|
+
translations: object;
|
|
915
|
+
errors?: LoadedResourcesError[];
|
|
916
|
+
}>;
|
|
917
|
+
/**
|
|
918
|
+
* Returns resources that failed
|
|
919
|
+
*/
|
|
920
|
+
getFailedResources(): Array<LoadedResourcesError>;
|
|
921
|
+
/**
|
|
922
|
+
* Create resources from a config file
|
|
923
|
+
*
|
|
924
|
+
* @param config loader configuration
|
|
925
|
+
* @returns I18nResourceImpl[] resources
|
|
926
|
+
*/
|
|
927
|
+
protected createResources(config: I18nLoaderConfig): I18nResourceImpl[];
|
|
928
|
+
/**
|
|
929
|
+
* Loads a resource, by language
|
|
930
|
+
*
|
|
931
|
+
* @param resource the definition of the resource
|
|
932
|
+
* @param lang the resource language to load
|
|
933
|
+
* @returns Observable<any>
|
|
934
|
+
*/
|
|
935
|
+
protected loadResource(resource: I18nResourceImpl, lang: string): Observable<TranslationKeys | ResourceError>;
|
|
936
|
+
private getResourceCompileFunction;
|
|
937
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<I18nLoader, never>;
|
|
938
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<I18nLoader>;
|
|
939
|
+
}
|
|
940
|
+
declare const translateConfig: {
|
|
941
|
+
loader: {
|
|
942
|
+
provide: typeof TranslateLoader;
|
|
943
|
+
useClass: typeof I18nLoader;
|
|
944
|
+
};
|
|
945
|
+
};
|
|
946
|
+
|
|
947
|
+
interface ModuleLoadEvent {
|
|
948
|
+
ready: boolean;
|
|
949
|
+
name: string;
|
|
950
|
+
error?: any;
|
|
951
|
+
}
|
|
952
|
+
declare class I18nService<T extends I18nState = I18nState> extends EuiLazyService<T | I18nState> implements OnDestroy {
|
|
953
|
+
protected config: I18nServiceConfig;
|
|
954
|
+
protected onModuleLoad: BehaviorSubject<ModuleLoadEvent>;
|
|
955
|
+
protected baseGlobalConfig: GlobalConfig<any>;
|
|
956
|
+
protected translateService: TranslateService;
|
|
957
|
+
protected logService: LogService;
|
|
958
|
+
protected store: StoreService<T>;
|
|
959
|
+
private static readonly DEFAULT_STATE;
|
|
960
|
+
private document;
|
|
961
|
+
/**
|
|
962
|
+
* a single signal holding the state - initial state is null
|
|
963
|
+
*/
|
|
964
|
+
private state;
|
|
965
|
+
/**
|
|
966
|
+
* a BehaviorSubject holding the state - initial state is null
|
|
967
|
+
* This is the main source of truth for the state
|
|
968
|
+
*/
|
|
969
|
+
private stateSubject;
|
|
970
|
+
private subNotifier;
|
|
971
|
+
constructor();
|
|
972
|
+
ngOnDestroy(): void;
|
|
973
|
+
getState(): Observable<T>;
|
|
974
|
+
/**
|
|
975
|
+
* @deprecated this will be removed in a future version
|
|
976
|
+
* @param mapFn
|
|
977
|
+
*/
|
|
978
|
+
getState<K = T>(mapFn?: (state: T) => K): Observable<K>;
|
|
979
|
+
getState<a extends keyof DeepPartial<T>>(key?: a): Observable<DeepPartial<a>>;
|
|
980
|
+
updateState(state: DeepPartial<T>): void;
|
|
981
|
+
/**
|
|
982
|
+
* @deprecated it will be removed in next version. Use updateState(partialState: DeepPartial<T>) instead
|
|
983
|
+
* @param slice
|
|
984
|
+
* @param reducer
|
|
985
|
+
*/
|
|
986
|
+
updateState(slice: DeepPartial<T>, reducer: (state: T, action: DeepPartial<T>) => T): void;
|
|
987
|
+
/**
|
|
988
|
+
* This method is used to get the state as readonly signal.
|
|
989
|
+
*/
|
|
990
|
+
getSignal(): Signal<T>;
|
|
991
|
+
init(langState?: T): Observable<EuiServiceStatus>;
|
|
992
|
+
/**
|
|
993
|
+
* A pipe function that could serve as a wrapper of another observable
|
|
994
|
+
* e.g. ngx-translate i18n.onReady('my_module').pipe(switchMap(()=>translate.get('eui.KEY')));
|
|
995
|
+
* WARNING: onReady will emit only once for a loaded Module, going to another and then going back will not result
|
|
996
|
+
* into another emission.
|
|
997
|
+
*
|
|
998
|
+
* @param moduleName the name of the module that has been given through the eUI globalConfig. In case non provided
|
|
999
|
+
* fetch module name from the state.
|
|
1000
|
+
*/
|
|
1001
|
+
onReady(moduleName?: string): Observable<ModuleLoadEvent>;
|
|
1002
|
+
lazyLoad(config: I18nLoaderConfig): Observable<EuiServiceStatus>;
|
|
1003
|
+
lazyLoadInit(moduleConfig: ModuleConfig, moduleName?: string): Observable<EuiServiceStatus>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Add resources based of a config loader
|
|
1006
|
+
*
|
|
1007
|
+
* @param config I18nLoaderConfig
|
|
1008
|
+
* @param moduleName
|
|
1009
|
+
* @return Promise<EuiServiceStatus> an EuiServiceStatus when translation has fully loaded
|
|
1010
|
+
*/
|
|
1011
|
+
addResources(config: I18nLoaderConfig, moduleName?: string): Observable<EuiServiceStatus>;
|
|
1012
|
+
/**
|
|
1013
|
+
* Prepares the default language
|
|
1014
|
+
*/
|
|
1015
|
+
private preparedDefaultLanguage;
|
|
1016
|
+
/**
|
|
1017
|
+
* @param initLanguage if given default language to override default language coming from the
|
|
1018
|
+
* configuration token.
|
|
1019
|
+
*/
|
|
1020
|
+
private setup;
|
|
1021
|
+
private bindActiveLangStateToTranslateService;
|
|
1022
|
+
private bindTranslateServiceLangChangeToState;
|
|
1023
|
+
private setDefaultLanguage;
|
|
1024
|
+
/**
|
|
1025
|
+
* change the currently used language
|
|
1026
|
+
*
|
|
1027
|
+
* @param lang is the language code based on the convention you used e.g. (en or en-EN)
|
|
1028
|
+
* @returns Observable that returns an object contain the object translation for given language after language
|
|
1029
|
+
* fully loaded.
|
|
1030
|
+
*/
|
|
1031
|
+
private use;
|
|
1032
|
+
/**
|
|
1033
|
+
* updates the HTML element lang attribute
|
|
1034
|
+
*
|
|
1035
|
+
* @private
|
|
1036
|
+
*/
|
|
1037
|
+
private updateHTMLDOMLang;
|
|
1038
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<I18nService<any>, never>;
|
|
1039
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<I18nService<any>>;
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
/**
|
|
1043
|
+
* Service for managing user permissions within the application.
|
|
1044
|
+
* This class extends `EuiService` and is responsible for handling user rights and permissions.
|
|
1045
|
+
* It provides methods to initialize the service with user rights, check specific rights and permissions,
|
|
1046
|
+
* and subscribe to changes in the user rights state.
|
|
1047
|
+
*
|
|
1048
|
+
* @extends {EuiService<EuiUserRight[]>}
|
|
1049
|
+
* @see EuiService
|
|
1050
|
+
*
|
|
1051
|
+
* @example
|
|
1052
|
+
* // Example of using the EuiPermissionService in an application
|
|
1053
|
+
* const permissionService = new EuiPermissionService();
|
|
1054
|
+
* permissionService.init([{ id: 'ADMIN', permissions: ['CREATE', 'READ', 'UPDATE', 'DELETE'] }]);
|
|
1055
|
+
* if (permissionService.checkRight('ADMIN')) {
|
|
1056
|
+
* console.log('User has ADMIN rights');
|
|
1057
|
+
* }
|
|
1058
|
+
*/
|
|
1059
|
+
declare class EuiPermissionService extends EuiService<EuiUserRight[]> {
|
|
1060
|
+
private log;
|
|
1061
|
+
protected store: StoreService<any>;
|
|
1062
|
+
private readonly logger;
|
|
1063
|
+
constructor();
|
|
1064
|
+
/**
|
|
1065
|
+
* Initializes the permission service with a set of user rights.
|
|
1066
|
+
* This method sets up the initial state of the service based on the provided user rights.
|
|
1067
|
+
* It should be called before using other methods of the service to ensure it is properly configured.
|
|
1068
|
+
*
|
|
1069
|
+
* @param {EuiUserRight[]} rights - An array of user rights to initialize the service with.
|
|
1070
|
+
* Each `EuiUserRight` object should contain at least an `id` property,
|
|
1071
|
+
* and optionally a `permissions` property which is an array of strings.
|
|
1072
|
+
*
|
|
1073
|
+
* @returns {Observable<EuiServiceStatus>} An Observable that emits the status of the initialization.
|
|
1074
|
+
* The status object includes a `success` boolean indicating
|
|
1075
|
+
* whether the initialization was successful, and an `error` property
|
|
1076
|
+
* with a message in case of failure.
|
|
1077
|
+
*
|
|
1078
|
+
* @example
|
|
1079
|
+
* // Example of initializing the service with two user rights
|
|
1080
|
+
* const userRights = [
|
|
1081
|
+
* { id: 'ADMIN', permissions: ['CREATE', 'READ', 'UPDATE', 'DELETE'] },
|
|
1082
|
+
* { id: 'USER', permissions: ['READ'] }
|
|
1083
|
+
* ];
|
|
1084
|
+
* permissionService.init(userRights).subscribe(status => {
|
|
1085
|
+
* if (status.success) {
|
|
1086
|
+
* console.log('Initialization successful');
|
|
1087
|
+
* } else {
|
|
1088
|
+
* console.error('Initialization failed:', status.error);
|
|
1089
|
+
* }
|
|
1090
|
+
* });
|
|
1091
|
+
*
|
|
1092
|
+
* @throws {Error} Throws an error if the `rights` parameter is not an array of `EuiUserRight` objects.
|
|
1093
|
+
*/
|
|
1094
|
+
init(rights: EuiUserRight[]): Observable<EuiServiceStatus>;
|
|
1095
|
+
/**
|
|
1096
|
+
* Retrieves the current user rights from the service's state.
|
|
1097
|
+
* This getter provides access to the array of `EuiUserRight` objects that represent the current rights
|
|
1098
|
+
* of the user. It is a protected method, intended for internal use within the service or by subclasses.
|
|
1099
|
+
*
|
|
1100
|
+
* @returns {EuiUserRight[]} An array of `EuiUserRight` objects representing the current user rights.
|
|
1101
|
+
* Each `EuiUserRight` object typically contains an `id` property, and may
|
|
1102
|
+
* also include a `permissions` property which is an array of strings.
|
|
1103
|
+
*
|
|
1104
|
+
* @example
|
|
1105
|
+
* // Example of accessing user rights within a subclass or within the service
|
|
1106
|
+
* const currentRights = this.userRights;
|
|
1107
|
+
* currentRights.forEach(right => {
|
|
1108
|
+
* console.log(`Right ID: ${right.id}, Permissions: ${right.permissions.join(', ')}`);
|
|
1109
|
+
* });
|
|
1110
|
+
*
|
|
1111
|
+
* @protected
|
|
1112
|
+
*/
|
|
1113
|
+
protected get userRights(): EuiUserRight[];
|
|
1114
|
+
/**
|
|
1115
|
+
* Retrieves the current state of user rights by subscribing to changes.
|
|
1116
|
+
* This method is used to access the current state of user rights in the service. It returns an Observable
|
|
1117
|
+
* that emits the current user rights. The method is generic and can be parameterized to return a specific
|
|
1118
|
+
* type that extends from `EuiUserRight[]`.
|
|
1119
|
+
*
|
|
1120
|
+
* @template K - The type of the user rights state to be returned. Defaults to `EuiUserRight[]` if not specified.
|
|
1121
|
+
*
|
|
1122
|
+
* @returns {Observable<K>} An Observable that emits the current state of user rights.
|
|
1123
|
+
* The type of the emitted value is `K`, which is `EuiUserRight[]` by default.
|
|
1124
|
+
*
|
|
1125
|
+
* @example
|
|
1126
|
+
* // Example of subscribing to the user rights state
|
|
1127
|
+
* permissionService.getState().subscribe(currentRights => {
|
|
1128
|
+
* console.log('Current User Rights:', currentRights);
|
|
1129
|
+
* });
|
|
1130
|
+
*
|
|
1131
|
+
* // Example with a specific type
|
|
1132
|
+
* permissionService.getState<CustomUserRightType[]>().subscribe(customRights => {
|
|
1133
|
+
* console.log('Custom User Rights:', customRights);
|
|
1134
|
+
* });
|
|
1135
|
+
*/
|
|
1136
|
+
getState<K = EuiUserRight[]>(): Observable<K>;
|
|
1137
|
+
/**
|
|
1138
|
+
* Updates the state of the service with a new set of user rights.
|
|
1139
|
+
* This method is used to modify the current user rights in the service. It takes an array of `EuiUserRight`
|
|
1140
|
+
* objects and updates the service's state. This change is then propagated to all subscribers of the state.
|
|
1141
|
+
*
|
|
1142
|
+
* @param {EuiUserRight[]} rights - An array of `EuiUserRight` objects to update the service's state with.
|
|
1143
|
+
* Each `EuiUserRight` object should contain an `id` property,
|
|
1144
|
+
* and optionally a `permissions` property which is an array of strings.
|
|
1145
|
+
*
|
|
1146
|
+
* @example
|
|
1147
|
+
* // Example of updating the service's state with new user rights
|
|
1148
|
+
* const newUserRights = [
|
|
1149
|
+
* { id: 'USER', permissions: ['READ', 'COMMENT'] },
|
|
1150
|
+
* { id: 'MODERATOR', permissions: ['READ', 'WRITE', 'DELETE'] }
|
|
1151
|
+
* ];
|
|
1152
|
+
* permissionService.updateState(newUserRights);
|
|
1153
|
+
*/
|
|
1154
|
+
updateState(rights: EuiUserRight[]): void;
|
|
1155
|
+
/**
|
|
1156
|
+
* Checks if the user has the specified attribute permission.
|
|
1157
|
+
* This method interprets a string that represents a combination of rights and/or permissions
|
|
1158
|
+
* and determines whether the user has the specified permissions. The string format can be
|
|
1159
|
+
* 'RIGHT.PERMISSION' or just 'RIGHT'. For multiple rights, it can be 'RIGHT1.RIGHT2.PERMISSION'.
|
|
1160
|
+
*
|
|
1161
|
+
* @param {string} rightsAndPermission - A string representing the rights and/or permissions to check.
|
|
1162
|
+
* Format can be 'RIGHT', 'RIGHT.PERMISSION', or 'RIGHT1.RIGHT2.PERMISSION'.
|
|
1163
|
+
*
|
|
1164
|
+
* @returns {boolean} True if the user has the specified attribute permission, false otherwise.
|
|
1165
|
+
*
|
|
1166
|
+
* @example
|
|
1167
|
+
* // Check a single right
|
|
1168
|
+
* const hasRight = permissionService.checkAttributePermission('VIEW');
|
|
1169
|
+
*
|
|
1170
|
+
* // Check a right with a specific permission
|
|
1171
|
+
* const hasRightWithPermission = permissionService.checkAttributePermission('EDIT.APPROVE');
|
|
1172
|
+
*
|
|
1173
|
+
* // Check multiple rights with a specific permission
|
|
1174
|
+
* const hasMultipleRights = permissionService.checkAttributePermission('ADMIN.VIEW.APPROVE');
|
|
1175
|
+
*/
|
|
1176
|
+
checkAttributePermission(rightsAndPermission: string): boolean;
|
|
1177
|
+
/**
|
|
1178
|
+
* Checks if the user has a specific right.
|
|
1179
|
+
* This method determines whether the user possesses a particular right identified by its ID.
|
|
1180
|
+
*
|
|
1181
|
+
* @param {string} rightId - The ID of the right to check.
|
|
1182
|
+
*
|
|
1183
|
+
* @returns {boolean} True if the user has the specified right, false otherwise.
|
|
1184
|
+
*
|
|
1185
|
+
* @example
|
|
1186
|
+
* // Check if the user has the 'ADMIN' right
|
|
1187
|
+
* const isAdmin = permissionService.checkRight('ADMIN');
|
|
1188
|
+
*/
|
|
1189
|
+
checkRight(rightId: string): boolean;
|
|
1190
|
+
/**
|
|
1191
|
+
* Checks if the user has a specific permission within a right.
|
|
1192
|
+
* This method determines whether the user has a specific permission associated with a given right.
|
|
1193
|
+
*
|
|
1194
|
+
* @param {string} rightId - The ID of the right.
|
|
1195
|
+
* @param {string} permission - The permission to check within the right.
|
|
1196
|
+
*
|
|
1197
|
+
* @returns {boolean} True if the user has the specified permission in the given right, false otherwise.
|
|
1198
|
+
*
|
|
1199
|
+
* @example
|
|
1200
|
+
* // Check if the user has 'APPROVE' permission in the 'EDIT' right
|
|
1201
|
+
* const canApproveEdit = permissionService.checkPermission('EDIT', 'APPROVE');
|
|
1202
|
+
*/
|
|
1203
|
+
checkPermission(rightId: string, permission: string): boolean;
|
|
1204
|
+
/**
|
|
1205
|
+
* Checks if the user has all the specified rights.
|
|
1206
|
+
* This private method determines whether the user possesses all the rights provided in the array.
|
|
1207
|
+
* Each right in the array is checked against the user's current rights.
|
|
1208
|
+
*
|
|
1209
|
+
* @param {EuiUserRight[]} rights - An array of rights to check against the user's rights.
|
|
1210
|
+
*
|
|
1211
|
+
* @returns {boolean} True if the user has all the specified rights, false otherwise.
|
|
1212
|
+
*
|
|
1213
|
+
* @example
|
|
1214
|
+
* // Example usage within the service
|
|
1215
|
+
* const requiredRights = [{ id: 'VIEW' }, { id: 'EDIT' }];
|
|
1216
|
+
* const hasAllRequiredRights = this.haveAllRights(requiredRights);
|
|
1217
|
+
*
|
|
1218
|
+
* @private
|
|
1219
|
+
*/
|
|
1220
|
+
private haveAllRights;
|
|
1221
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiPermissionService, never>;
|
|
1222
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiPermissionService>;
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
declare class EuiDynamicMenuService {
|
|
1226
|
+
menuLinks: Array<EuiMenuItem>;
|
|
1227
|
+
private euiPermission;
|
|
1228
|
+
private store;
|
|
1229
|
+
constructor();
|
|
1230
|
+
getMenuLinks(): EuiMenuItem[];
|
|
1231
|
+
filterEuiMenuItemsWithRights(links: Array<EuiMenuItem>): Array<EuiMenuItem>;
|
|
1232
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiDynamicMenuService, never>;
|
|
1233
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiDynamicMenuService>;
|
|
1234
|
+
}
|
|
1235
|
+
|
|
1236
|
+
declare const DYNAMIC_COMPONENT_CONFIG: InjectionToken<object>;
|
|
1237
|
+
declare class EuiDynamicComponentService {
|
|
1238
|
+
private injector;
|
|
1239
|
+
private appRef;
|
|
1240
|
+
private portalHost;
|
|
1241
|
+
private portal;
|
|
1242
|
+
private portalComponentInstance;
|
|
1243
|
+
/**
|
|
1244
|
+
* Adds a component to portal host dynamically
|
|
1245
|
+
* @param component The component to be injected
|
|
1246
|
+
* @param el The element reference for the component to be injected
|
|
1247
|
+
* @param config The data to be passed (config) for the DYNAMIC_COMPONENT_CONFIG token
|
|
1248
|
+
*/
|
|
1249
|
+
add<T>(component: ComponentType<T>, el?: ElementRef, config?: any): any;
|
|
1250
|
+
/**
|
|
1251
|
+
* detaches a portalHost
|
|
1252
|
+
* @param portalHostRef reference of portal host to be detached
|
|
1253
|
+
*/
|
|
1254
|
+
remove(portalHostRef: DomPortalOutlet): void;
|
|
1255
|
+
/**
|
|
1256
|
+
* creates a custom injector to be used when providing custom injection tokens to components inside a portal
|
|
1257
|
+
* @param data to be used by DYNAMIC_COMPONENT_CONFIG token
|
|
1258
|
+
*/
|
|
1259
|
+
private createInjector;
|
|
1260
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiDynamicComponentService, never>;
|
|
1261
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiDynamicComponentService>;
|
|
1262
|
+
}
|
|
1263
|
+
|
|
1264
|
+
interface UIState<BP = any, DI = any, AMD = any, BPV = any> {
|
|
1265
|
+
appName?: string;
|
|
1266
|
+
appShortName?: string;
|
|
1267
|
+
appSubTitle?: string;
|
|
1268
|
+
appBaseFontSize?: string;
|
|
1269
|
+
isSidebarOpen?: boolean;
|
|
1270
|
+
isSidebarActive?: boolean;
|
|
1271
|
+
hasSidebar?: boolean;
|
|
1272
|
+
hasBreadcrumb?: boolean;
|
|
1273
|
+
hasHeader?: boolean;
|
|
1274
|
+
hasHeaderLogo?: boolean;
|
|
1275
|
+
hasHeaderEnvironment?: boolean;
|
|
1276
|
+
hasToolbar?: boolean;
|
|
1277
|
+
hasToolbarMenu?: boolean;
|
|
1278
|
+
environmentValue?: string;
|
|
1279
|
+
isSidebarHidden?: boolean;
|
|
1280
|
+
hasSidebarCollapsedVariant?: boolean;
|
|
1281
|
+
hasTopMessage?: boolean;
|
|
1282
|
+
windowWidth?: number;
|
|
1283
|
+
windowHeight?: number;
|
|
1284
|
+
mainContentHeight?: number;
|
|
1285
|
+
pageHeaderHeight?: number;
|
|
1286
|
+
breakpoint?: string;
|
|
1287
|
+
wrapperClasses?: string;
|
|
1288
|
+
breakpoints?: BP;
|
|
1289
|
+
breakpointValues?: BPV;
|
|
1290
|
+
menuLinks?: EuiMenuItem[];
|
|
1291
|
+
sidebarLinks?: EuiMenuItem[];
|
|
1292
|
+
combinedLinks?: EuiMenuItem[];
|
|
1293
|
+
isBlockDocumentActive?: boolean;
|
|
1294
|
+
deviceInfo: DI;
|
|
1295
|
+
activeLanguage: string;
|
|
1296
|
+
languages: (string | EuiLanguage)[];
|
|
1297
|
+
appMetadata: AMD;
|
|
1298
|
+
hasModalActive?: boolean;
|
|
1299
|
+
isDimmerActive?: boolean;
|
|
1300
|
+
}
|
|
1301
|
+
declare class EuiAppShellService {
|
|
1302
|
+
navigationStartCustomHandler: () => void;
|
|
1303
|
+
navigationEndCustomHandler: () => void;
|
|
1304
|
+
protected config: GlobalConfig<any>;
|
|
1305
|
+
private http;
|
|
1306
|
+
private platformId;
|
|
1307
|
+
private document;
|
|
1308
|
+
private router;
|
|
1309
|
+
private storeService;
|
|
1310
|
+
private i18nService;
|
|
1311
|
+
get state$(): Observable<UIState>;
|
|
1312
|
+
get breakpoint$(): Observable<string>;
|
|
1313
|
+
get breakpoints$(): Observable<any>;
|
|
1314
|
+
get state(): UIState;
|
|
1315
|
+
set isSidebarOpen(isOpen: boolean);
|
|
1316
|
+
get isSidebarOpen(): boolean;
|
|
1317
|
+
set isSidebarActive(isActive: boolean);
|
|
1318
|
+
set sidebarLinks(links: EuiMenuItem[]);
|
|
1319
|
+
set hasSidebarCollapsedVariant(isActive: boolean);
|
|
1320
|
+
set menuLinks(links: EuiMenuItem[]);
|
|
1321
|
+
set isBlockDocumentActive(isActive: boolean);
|
|
1322
|
+
get hasHeader(): boolean;
|
|
1323
|
+
get isDimmerActive(): boolean;
|
|
1324
|
+
set isDimmerActive(isActive: boolean);
|
|
1325
|
+
private _state$;
|
|
1326
|
+
private _breakpoint$;
|
|
1327
|
+
private _breakpoints$;
|
|
1328
|
+
constructor();
|
|
1329
|
+
setState(nextState: UIState, updateI18?: boolean): void;
|
|
1330
|
+
/**
|
|
1331
|
+
* Emits a slice from the state whether that changes
|
|
1332
|
+
*
|
|
1333
|
+
* @param key can be 'key' or 'key.sub.sub'
|
|
1334
|
+
*/
|
|
1335
|
+
getState<T = any>(key?: string): Observable<T>;
|
|
1336
|
+
sidebarToggle(): void;
|
|
1337
|
+
dimmerActiveToggle(): void;
|
|
1338
|
+
setDimmerActiveState(activeState: boolean): void;
|
|
1339
|
+
fetchAppMetadata(metadataFilePath?: string): void;
|
|
1340
|
+
activateSidebar(): void;
|
|
1341
|
+
activateSidebarHeader(): void;
|
|
1342
|
+
activateSidebarFooter(): void;
|
|
1343
|
+
activateHeader(): void;
|
|
1344
|
+
activateBreadcrumb(): void;
|
|
1345
|
+
activateTopMessage(height: number): void;
|
|
1346
|
+
activateToolbar(): void;
|
|
1347
|
+
activateToolbarMenu(): void;
|
|
1348
|
+
/**
|
|
1349
|
+
* Returns the current value of --eui-f-size-base CSS variable
|
|
1350
|
+
*/
|
|
1351
|
+
getBaseFontSize(): string;
|
|
1352
|
+
/**
|
|
1353
|
+
* Updates the current value of --eui-f-size-base CSS variable and the UIState appBaseFontSize
|
|
1354
|
+
*/
|
|
1355
|
+
setBaseFontSize(newsize: string): void;
|
|
1356
|
+
private getWrapperClasses;
|
|
1357
|
+
private getBreakpoint;
|
|
1358
|
+
private getBreakpoints;
|
|
1359
|
+
private getJson;
|
|
1360
|
+
private extractData;
|
|
1361
|
+
private handleError;
|
|
1362
|
+
private bindActiveLanguageToAppShellState;
|
|
1363
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiAppShellService, never>;
|
|
1364
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiAppShellService>;
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1367
|
+
declare const EUI_COUNTRIES: {
|
|
1368
|
+
AF: string;
|
|
1369
|
+
AX: string;
|
|
1370
|
+
AL: string;
|
|
1371
|
+
DZ: string;
|
|
1372
|
+
AS: string;
|
|
1373
|
+
AD: string;
|
|
1374
|
+
AO: string;
|
|
1375
|
+
AI: string;
|
|
1376
|
+
AQ: string;
|
|
1377
|
+
AG: string;
|
|
1378
|
+
AR: string;
|
|
1379
|
+
AM: string;
|
|
1380
|
+
AW: string;
|
|
1381
|
+
AU: string;
|
|
1382
|
+
AT: string;
|
|
1383
|
+
AZ: string;
|
|
1384
|
+
BS: string;
|
|
1385
|
+
BH: string;
|
|
1386
|
+
BD: string;
|
|
1387
|
+
BB: string;
|
|
1388
|
+
BY: string;
|
|
1389
|
+
BE: string;
|
|
1390
|
+
BZ: string;
|
|
1391
|
+
BJ: string;
|
|
1392
|
+
BM: string;
|
|
1393
|
+
BT: string;
|
|
1394
|
+
BO: string;
|
|
1395
|
+
BA: string;
|
|
1396
|
+
BW: string;
|
|
1397
|
+
BV: string;
|
|
1398
|
+
BR: string;
|
|
1399
|
+
VG: string;
|
|
1400
|
+
IO: string;
|
|
1401
|
+
BN: string;
|
|
1402
|
+
BG: string;
|
|
1403
|
+
BF: string;
|
|
1404
|
+
BI: string;
|
|
1405
|
+
KH: string;
|
|
1406
|
+
CM: string;
|
|
1407
|
+
CA: string;
|
|
1408
|
+
CV: string;
|
|
1409
|
+
KY: string;
|
|
1410
|
+
CF: string;
|
|
1411
|
+
TD: string;
|
|
1412
|
+
CL: string;
|
|
1413
|
+
CN: string;
|
|
1414
|
+
HK: string;
|
|
1415
|
+
MO: string;
|
|
1416
|
+
CX: string;
|
|
1417
|
+
CC: string;
|
|
1418
|
+
CO: string;
|
|
1419
|
+
KM: string;
|
|
1420
|
+
CG: string;
|
|
1421
|
+
CD: string;
|
|
1422
|
+
CK: string;
|
|
1423
|
+
CR: string;
|
|
1424
|
+
CI: string;
|
|
1425
|
+
HR: string;
|
|
1426
|
+
CU: string;
|
|
1427
|
+
CY: string;
|
|
1428
|
+
CZ: string;
|
|
1429
|
+
DK: string;
|
|
1430
|
+
DJ: string;
|
|
1431
|
+
DM: string;
|
|
1432
|
+
DO: string;
|
|
1433
|
+
EC: string;
|
|
1434
|
+
EG: string;
|
|
1435
|
+
SV: string;
|
|
1436
|
+
GQ: string;
|
|
1437
|
+
ER: string;
|
|
1438
|
+
EE: string;
|
|
1439
|
+
ET: string;
|
|
1440
|
+
FK: string;
|
|
1441
|
+
FO: string;
|
|
1442
|
+
FJ: string;
|
|
1443
|
+
FI: string;
|
|
1444
|
+
FR: string;
|
|
1445
|
+
GF: string;
|
|
1446
|
+
PF: string;
|
|
1447
|
+
TF: string;
|
|
1448
|
+
GA: string;
|
|
1449
|
+
GM: string;
|
|
1450
|
+
GE: string;
|
|
1451
|
+
DE: string;
|
|
1452
|
+
GH: string;
|
|
1453
|
+
GI: string;
|
|
1454
|
+
GR: string;
|
|
1455
|
+
GL: string;
|
|
1456
|
+
GD: string;
|
|
1457
|
+
GP: string;
|
|
1458
|
+
GU: string;
|
|
1459
|
+
GT: string;
|
|
1460
|
+
GG: string;
|
|
1461
|
+
GN: string;
|
|
1462
|
+
GW: string;
|
|
1463
|
+
GY: string;
|
|
1464
|
+
HT: string;
|
|
1465
|
+
HM: string;
|
|
1466
|
+
VA: string;
|
|
1467
|
+
HN: string;
|
|
1468
|
+
HU: string;
|
|
1469
|
+
IS: string;
|
|
1470
|
+
IN: string;
|
|
1471
|
+
ID: string;
|
|
1472
|
+
IR: string;
|
|
1473
|
+
IQ: string;
|
|
1474
|
+
IE: string;
|
|
1475
|
+
IM: string;
|
|
1476
|
+
IL: string;
|
|
1477
|
+
IT: string;
|
|
1478
|
+
JM: string;
|
|
1479
|
+
JP: string;
|
|
1480
|
+
JE: string;
|
|
1481
|
+
JO: string;
|
|
1482
|
+
KZ: string;
|
|
1483
|
+
KE: string;
|
|
1484
|
+
KI: string;
|
|
1485
|
+
KP: string;
|
|
1486
|
+
KR: string;
|
|
1487
|
+
KW: string;
|
|
1488
|
+
KG: string;
|
|
1489
|
+
LA: string;
|
|
1490
|
+
LV: string;
|
|
1491
|
+
LB: string;
|
|
1492
|
+
LS: string;
|
|
1493
|
+
LR: string;
|
|
1494
|
+
LY: string;
|
|
1495
|
+
LI: string;
|
|
1496
|
+
LT: string;
|
|
1497
|
+
LU: string;
|
|
1498
|
+
MK: string;
|
|
1499
|
+
MG: string;
|
|
1500
|
+
MW: string;
|
|
1501
|
+
MY: string;
|
|
1502
|
+
MV: string;
|
|
1503
|
+
ML: string;
|
|
1504
|
+
MT: string;
|
|
1505
|
+
MH: string;
|
|
1506
|
+
MQ: string;
|
|
1507
|
+
MR: string;
|
|
1508
|
+
MU: string;
|
|
1509
|
+
YT: string;
|
|
1510
|
+
MX: string;
|
|
1511
|
+
FM: string;
|
|
1512
|
+
MD: string;
|
|
1513
|
+
MC: string;
|
|
1514
|
+
MN: string;
|
|
1515
|
+
ME: string;
|
|
1516
|
+
MS: string;
|
|
1517
|
+
MA: string;
|
|
1518
|
+
MZ: string;
|
|
1519
|
+
MM: string;
|
|
1520
|
+
NA: string;
|
|
1521
|
+
NR: string;
|
|
1522
|
+
NP: string;
|
|
1523
|
+
NL: string;
|
|
1524
|
+
AN: string;
|
|
1525
|
+
NC: string;
|
|
1526
|
+
NZ: string;
|
|
1527
|
+
NI: string;
|
|
1528
|
+
NE: string;
|
|
1529
|
+
NG: string;
|
|
1530
|
+
NU: string;
|
|
1531
|
+
NF: string;
|
|
1532
|
+
MP: string;
|
|
1533
|
+
NO: string;
|
|
1534
|
+
OM: string;
|
|
1535
|
+
PK: string;
|
|
1536
|
+
PW: string;
|
|
1537
|
+
PS: string;
|
|
1538
|
+
PA: string;
|
|
1539
|
+
PG: string;
|
|
1540
|
+
PY: string;
|
|
1541
|
+
PE: string;
|
|
1542
|
+
PH: string;
|
|
1543
|
+
PN: string;
|
|
1544
|
+
PL: string;
|
|
1545
|
+
PT: string;
|
|
1546
|
+
PR: string;
|
|
1547
|
+
QA: string;
|
|
1548
|
+
RE: string;
|
|
1549
|
+
RO: string;
|
|
1550
|
+
RU: string;
|
|
1551
|
+
RW: string;
|
|
1552
|
+
BL: string;
|
|
1553
|
+
SH: string;
|
|
1554
|
+
KN: string;
|
|
1555
|
+
LC: string;
|
|
1556
|
+
MF: string;
|
|
1557
|
+
PM: string;
|
|
1558
|
+
VC: string;
|
|
1559
|
+
WS: string;
|
|
1560
|
+
SM: string;
|
|
1561
|
+
ST: string;
|
|
1562
|
+
SA: string;
|
|
1563
|
+
SN: string;
|
|
1564
|
+
RS: string;
|
|
1565
|
+
SC: string;
|
|
1566
|
+
SL: string;
|
|
1567
|
+
SG: string;
|
|
1568
|
+
SK: string;
|
|
1569
|
+
SI: string;
|
|
1570
|
+
SB: string;
|
|
1571
|
+
SO: string;
|
|
1572
|
+
ZA: string;
|
|
1573
|
+
GS: string;
|
|
1574
|
+
SS: string;
|
|
1575
|
+
ES: string;
|
|
1576
|
+
LK: string;
|
|
1577
|
+
SD: string;
|
|
1578
|
+
SR: string;
|
|
1579
|
+
SJ: string;
|
|
1580
|
+
SZ: string;
|
|
1581
|
+
SE: string;
|
|
1582
|
+
CH: string;
|
|
1583
|
+
SY: string;
|
|
1584
|
+
TW: string;
|
|
1585
|
+
TJ: string;
|
|
1586
|
+
TZ: string;
|
|
1587
|
+
TH: string;
|
|
1588
|
+
TL: string;
|
|
1589
|
+
TG: string;
|
|
1590
|
+
TK: string;
|
|
1591
|
+
TO: string;
|
|
1592
|
+
TT: string;
|
|
1593
|
+
TN: string;
|
|
1594
|
+
TR: string;
|
|
1595
|
+
TM: string;
|
|
1596
|
+
TC: string;
|
|
1597
|
+
TV: string;
|
|
1598
|
+
UG: string;
|
|
1599
|
+
UA: string;
|
|
1600
|
+
AE: string;
|
|
1601
|
+
GB: string;
|
|
1602
|
+
US: string;
|
|
1603
|
+
UM: string;
|
|
1604
|
+
UY: string;
|
|
1605
|
+
UZ: string;
|
|
1606
|
+
VU: string;
|
|
1607
|
+
VE: string;
|
|
1608
|
+
VN: string;
|
|
1609
|
+
VI: string;
|
|
1610
|
+
WF: string;
|
|
1611
|
+
EH: string;
|
|
1612
|
+
YE: string;
|
|
1613
|
+
ZM: string;
|
|
1614
|
+
ZW: string;
|
|
1615
|
+
};
|
|
1616
|
+
interface EuiTimeZone {
|
|
1617
|
+
name: string;
|
|
1618
|
+
desc: string;
|
|
1619
|
+
}
|
|
1620
|
+
declare const EUI_TIMEZONES: EuiTimeZone[];
|
|
1621
|
+
declare class EuiTimezoneService {
|
|
1622
|
+
/**
|
|
1623
|
+
* Convert country ISO code to country name (in english)
|
|
1624
|
+
*/
|
|
1625
|
+
iso2country(iso: string): string;
|
|
1626
|
+
/**
|
|
1627
|
+
* Gets the list of ISO-codes for all countries
|
|
1628
|
+
*/
|
|
1629
|
+
getCountries(): string[];
|
|
1630
|
+
getTimezones(): EuiTimeZone[];
|
|
1631
|
+
getTimezone(tz: string): EuiTimeZone;
|
|
1632
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiTimezoneService, never>;
|
|
1633
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiTimezoneService>;
|
|
1634
|
+
}
|
|
1635
|
+
|
|
1636
|
+
declare enum EuiTheme {
|
|
1637
|
+
DEFAULT = "default",
|
|
1638
|
+
ECL_EC = "ecl-ec",
|
|
1639
|
+
ECL_EC_RTL = "ecl-ec-rtl",
|
|
1640
|
+
ECL_EU = "ecl-eu",
|
|
1641
|
+
ECL_EU_RTL = "ecl-eu-rtl",
|
|
1642
|
+
EUI_LEGACY = "eui-legacy",
|
|
1643
|
+
EUI_LEGACY_HC = "eui-legacy-high-contrast",
|
|
1644
|
+
DARK = "dark",
|
|
1645
|
+
COMPACT = "compact",
|
|
1646
|
+
DS2025 = "ds2025"
|
|
1647
|
+
}
|
|
1648
|
+
interface IEuiTheme {
|
|
1649
|
+
name: EuiTheme;
|
|
1650
|
+
isActive: boolean;
|
|
1651
|
+
styleSheet: string;
|
|
1652
|
+
cssClass: string;
|
|
1653
|
+
}
|
|
1654
|
+
interface ThemeState {
|
|
1655
|
+
themes: IEuiTheme[];
|
|
1656
|
+
theme: any;
|
|
1657
|
+
}
|
|
1658
|
+
declare class EuiThemeService {
|
|
1659
|
+
private document;
|
|
1660
|
+
protected config: GlobalConfig<any>;
|
|
1661
|
+
private asService;
|
|
1662
|
+
private _state$;
|
|
1663
|
+
constructor();
|
|
1664
|
+
get state$(): Observable<ThemeState>;
|
|
1665
|
+
get state(): ThemeState;
|
|
1666
|
+
isDefault(): boolean;
|
|
1667
|
+
isEclEc(): boolean;
|
|
1668
|
+
isEclEcRtl(): boolean;
|
|
1669
|
+
isEclEu(): boolean;
|
|
1670
|
+
isEclEuRtl(): boolean;
|
|
1671
|
+
isEuiLegacy(): boolean;
|
|
1672
|
+
isEuiLegacyHc(): boolean;
|
|
1673
|
+
isDark(): boolean;
|
|
1674
|
+
isCompact(): boolean;
|
|
1675
|
+
isDs2025(): boolean;
|
|
1676
|
+
setActiveTheme(theme: EuiTheme, isActive: boolean): void;
|
|
1677
|
+
private _renderTheme;
|
|
1678
|
+
private _renderThemeCss;
|
|
1679
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiThemeService, never>;
|
|
1680
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiThemeService>;
|
|
1681
|
+
}
|
|
1682
|
+
|
|
1683
|
+
/**
|
|
1684
|
+
* Generic storage service. Concrete storage services must extend this class
|
|
1685
|
+
*/
|
|
1686
|
+
declare abstract class StorageService {
|
|
1687
|
+
/**
|
|
1688
|
+
* utility function, to determine the storage implementation
|
|
1689
|
+
*/
|
|
1690
|
+
abstract name(): string;
|
|
1691
|
+
/**
|
|
1692
|
+
* retrieve an object from storage
|
|
1693
|
+
* @param key the associated key
|
|
1694
|
+
* @returns the value or undefined, if case of error
|
|
1695
|
+
*/
|
|
1696
|
+
abstract get(key: string): any;
|
|
1697
|
+
abstract get<T>(key: string): T;
|
|
1698
|
+
/**
|
|
1699
|
+
* sets an object in storage
|
|
1700
|
+
* @param key the associated key
|
|
1701
|
+
* @param value the value to set
|
|
1702
|
+
*/
|
|
1703
|
+
abstract set(key: string, value: any): void;
|
|
1704
|
+
abstract set<T>(key: string, value: T): void;
|
|
1705
|
+
/**
|
|
1706
|
+
* removes an object from storage
|
|
1707
|
+
* @param key the associated key
|
|
1708
|
+
*/
|
|
1709
|
+
abstract remove(key: string): void;
|
|
1710
|
+
}
|
|
1711
|
+
|
|
1712
|
+
declare class StorageServiceMock extends StorageService {
|
|
1713
|
+
name(): string;
|
|
1714
|
+
get(): null;
|
|
1715
|
+
set(): void;
|
|
1716
|
+
remove(): void;
|
|
1717
|
+
}
|
|
1718
|
+
|
|
1719
|
+
/**
|
|
1720
|
+
* Generic asynchronous storage service. Concrete asynchronous storage services must extend this class
|
|
1721
|
+
*/
|
|
1722
|
+
declare abstract class AsyncStorageService extends StorageService {
|
|
1723
|
+
/**
|
|
1724
|
+
* reflects the readiness of the storage
|
|
1725
|
+
* @returns one time emission Observable<any>
|
|
1726
|
+
*/
|
|
1727
|
+
abstract ready(): Observable<any>;
|
|
1728
|
+
/**
|
|
1729
|
+
* retrieve an object from async storage
|
|
1730
|
+
* @param key the associated key
|
|
1731
|
+
* @returns one time emission Observable of value
|
|
1732
|
+
*/
|
|
1733
|
+
abstract get(key: string): Observable<any>;
|
|
1734
|
+
abstract get<T>(key: string): Observable<T>;
|
|
1735
|
+
/**
|
|
1736
|
+
* sets an object in async storage
|
|
1737
|
+
* @param key the associated key
|
|
1738
|
+
* @param value the value to set
|
|
1739
|
+
* @returns one time emission Observable
|
|
1740
|
+
*/
|
|
1741
|
+
abstract set(key: string, value: any): Observable<any>;
|
|
1742
|
+
abstract set<T>(key: string, value: T): Observable<any>;
|
|
1743
|
+
/**
|
|
1744
|
+
* removes an object from async storage
|
|
1745
|
+
* @param key the associated key
|
|
1746
|
+
* @returns one time emission Observable
|
|
1747
|
+
*/
|
|
1748
|
+
abstract remove(key: string): Observable<any>;
|
|
1749
|
+
/**
|
|
1750
|
+
* asynchronous helper for set function
|
|
1751
|
+
* @param key the associated key
|
|
1752
|
+
* @param value the value to set
|
|
1753
|
+
*/
|
|
1754
|
+
setAsync(key: string, value: any): void;
|
|
1755
|
+
/**
|
|
1756
|
+
* asynchronous helper for remove function
|
|
1757
|
+
* @param key the associated key
|
|
1758
|
+
*/
|
|
1759
|
+
removeAsync(key: string): void;
|
|
1760
|
+
}
|
|
1761
|
+
|
|
1762
|
+
declare class AsyncStorageServiceMock extends AsyncStorageService {
|
|
1763
|
+
ready(): Observable<any>;
|
|
1764
|
+
name(): string;
|
|
1765
|
+
get(): Observable<any>;
|
|
1766
|
+
set(): Observable<any>;
|
|
1767
|
+
remove(): Observable<any>;
|
|
1768
|
+
setAsync(): void;
|
|
1769
|
+
removeAsync(): void;
|
|
1770
|
+
}
|
|
1771
|
+
|
|
1772
|
+
/**
|
|
1773
|
+
* localStorage service
|
|
1774
|
+
*/
|
|
1775
|
+
declare class LocalStorageService extends StorageService {
|
|
1776
|
+
static NAME: string;
|
|
1777
|
+
protected log: LogService;
|
|
1778
|
+
private platformId;
|
|
1779
|
+
/**
|
|
1780
|
+
* the name of the storage service
|
|
1781
|
+
*/
|
|
1782
|
+
name(): string;
|
|
1783
|
+
/**
|
|
1784
|
+
* retrieve an object from local storage
|
|
1785
|
+
* @param key the associated key
|
|
1786
|
+
* @returns the value or undefined, if case of error
|
|
1787
|
+
*/
|
|
1788
|
+
get(key: string): any;
|
|
1789
|
+
/**
|
|
1790
|
+
* sets an object in local storage
|
|
1791
|
+
* @param key the associated key
|
|
1792
|
+
* @param value the value to set
|
|
1793
|
+
*/
|
|
1794
|
+
set(key: string, value: any): void;
|
|
1795
|
+
/**
|
|
1796
|
+
* removes an object from local storage
|
|
1797
|
+
* @param key the associated key
|
|
1798
|
+
*/
|
|
1799
|
+
remove(key: string): void;
|
|
1800
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LocalStorageService, never>;
|
|
1801
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<LocalStorageService>;
|
|
1802
|
+
}
|
|
1803
|
+
|
|
1804
|
+
/**
|
|
1805
|
+
* sessionStorage service
|
|
1806
|
+
*/
|
|
1807
|
+
declare class SessionStorageService extends StorageService {
|
|
1808
|
+
protected log: LogService;
|
|
1809
|
+
static NAME: string;
|
|
1810
|
+
/**
|
|
1811
|
+
* the name of the storage service
|
|
1812
|
+
*/
|
|
1813
|
+
name(): string;
|
|
1814
|
+
/**
|
|
1815
|
+
* retrieve an object from session storage
|
|
1816
|
+
* @param key the associated key
|
|
1817
|
+
* @returns the value or undefined, if case of error
|
|
1818
|
+
*/
|
|
1819
|
+
get(key: string): any;
|
|
1820
|
+
/**
|
|
1821
|
+
* sets an object in session storage
|
|
1822
|
+
* @param key the associated key
|
|
1823
|
+
* @param value the value to set
|
|
1824
|
+
*/
|
|
1825
|
+
set(key: string, value: any): void;
|
|
1826
|
+
/**
|
|
1827
|
+
* removes an object from session storage
|
|
1828
|
+
* @param key the associated key
|
|
1829
|
+
*/
|
|
1830
|
+
remove(key: string): void;
|
|
1831
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SessionStorageService, never>;
|
|
1832
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SessionStorageService>;
|
|
1833
|
+
}
|
|
1834
|
+
|
|
1835
|
+
/** @internal */
|
|
1836
|
+
declare const localForage: any;
|
|
1837
|
+
declare const LOCAL_FORAGE_SERVICE_CONFIG_TOKEN: InjectionToken<any>;
|
|
1838
|
+
/**
|
|
1839
|
+
* localforage service, using the localForage javascript library
|
|
1840
|
+
* https://localforage.github.io/localForage
|
|
1841
|
+
*/
|
|
1842
|
+
declare class LocalForageService extends AsyncStorageService {
|
|
1843
|
+
protected config: any;
|
|
1844
|
+
protected log: LogService;
|
|
1845
|
+
static NAME: string;
|
|
1846
|
+
constructor();
|
|
1847
|
+
/**
|
|
1848
|
+
* the name of the storage service
|
|
1849
|
+
*/
|
|
1850
|
+
name(): string;
|
|
1851
|
+
/**
|
|
1852
|
+
* reflects the readiness of the storage
|
|
1853
|
+
* @returns one time emission Observable<void>
|
|
1854
|
+
*/
|
|
1855
|
+
ready(): Observable<any>;
|
|
1856
|
+
/**
|
|
1857
|
+
* retrieve an object from localforage
|
|
1858
|
+
* @param key the associated key
|
|
1859
|
+
* @returns one time emission Observable of value
|
|
1860
|
+
*/
|
|
1861
|
+
get(key: string): Observable<any>;
|
|
1862
|
+
/**
|
|
1863
|
+
* sets an object in localforage
|
|
1864
|
+
* @param key the associated key
|
|
1865
|
+
* @param value the value to set
|
|
1866
|
+
* @returns one time emission Observable
|
|
1867
|
+
*/
|
|
1868
|
+
set(key: string, value: any): Observable<any>;
|
|
1869
|
+
/**
|
|
1870
|
+
* removes an object from localforage
|
|
1871
|
+
* @param key the associated key
|
|
1872
|
+
* @returns one time emission Observable
|
|
1873
|
+
*/
|
|
1874
|
+
remove(key: string): Observable<any>;
|
|
1875
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LocalForageService, never>;
|
|
1876
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<LocalForageService>;
|
|
1877
|
+
}
|
|
1878
|
+
|
|
1879
|
+
type LocaleMapper = (locale: string) => string;
|
|
1880
|
+
declare const LOCALE_ID_MAPPER: InjectionToken<LocaleMapper>;
|
|
1881
|
+
/**
|
|
1882
|
+
* LocaleService is responsible for managing locale states and configurations in an Angular application.
|
|
1883
|
+
* It utilizes the CLDR library to load and construct the locale for each region. This service allows
|
|
1884
|
+
* for dynamic loading of locales upon request and updates the state of the EUI app accordingly.
|
|
1885
|
+
*
|
|
1886
|
+
* Key functionalities include:
|
|
1887
|
+
* - Binding to a translation service for locale changes.
|
|
1888
|
+
* - Updating the Angular LOCALE_ID token.
|
|
1889
|
+
*
|
|
1890
|
+
* @template T - Extends LocaleState, representing the state structure for locales.
|
|
1891
|
+
* @template L - The type of the locale data.
|
|
1892
|
+
* @extends EuiService<T | LocaleState>
|
|
1893
|
+
*/
|
|
1894
|
+
declare class LocaleService<T extends LocaleState = LocaleState> extends EuiService<T | LocaleState> implements OnDestroy {
|
|
1895
|
+
protected store: StoreService<any>;
|
|
1896
|
+
protected baseGlobalConfig: GlobalConfig<any>;
|
|
1897
|
+
protected locale_id: string;
|
|
1898
|
+
private static readonly DEFAULT_STATE;
|
|
1899
|
+
private localeMapper;
|
|
1900
|
+
private i18n;
|
|
1901
|
+
private log;
|
|
1902
|
+
private readonly logger;
|
|
1903
|
+
private subNotifier;
|
|
1904
|
+
protected config: LocaleServiceConfig;
|
|
1905
|
+
/**
|
|
1906
|
+
* a single signal holding the state - initial state is null
|
|
1907
|
+
*/
|
|
1908
|
+
private state;
|
|
1909
|
+
/**
|
|
1910
|
+
* a BehaviorSubject holding the state - initial state is null
|
|
1911
|
+
* This is the main source of truth for the state
|
|
1912
|
+
*/
|
|
1913
|
+
private stateSubject;
|
|
1914
|
+
constructor();
|
|
1915
|
+
ngOnDestroy(): void;
|
|
1916
|
+
getState(): Observable<T>;
|
|
1917
|
+
/**
|
|
1918
|
+
* Retrieves the state of the locale service. This method is overloaded to allow different ways of accessing the state.
|
|
1919
|
+
*
|
|
1920
|
+
* @template K - The type of the value to be returned. Defaults to the type of the locale state (T).
|
|
1921
|
+
*
|
|
1922
|
+
* @param {((state: T) => K)} [mapFn] - A function that maps the state to a specific form.
|
|
1923
|
+
* Takes the current state as an argument and returns the transformed state.
|
|
1924
|
+
* @returns {Observable<K>} - An observable that emits the transformed state.
|
|
1925
|
+
*/
|
|
1926
|
+
getState<K = T>(mapFn?: (state: T) => K): Observable<K>;
|
|
1927
|
+
/**
|
|
1928
|
+
* @template a - A key that extends the keys of the state type T.
|
|
1929
|
+
* @param {a} [key] - A specific key to access a part of the state.
|
|
1930
|
+
* The key should be a property name of the state object.
|
|
1931
|
+
* @returns {Observable<Partial<a>>} - An observable that emits the value of the specified key in the state.
|
|
1932
|
+
* @param key
|
|
1933
|
+
*/
|
|
1934
|
+
getState<a extends keyof DeepPartial<T>>(key?: a): Observable<DeepPartial<a>>;
|
|
1935
|
+
/**
|
|
1936
|
+
* Initializes the LocaleService with necessary configurations and state.
|
|
1937
|
+
* Binds language changes to the state and dynamically loads the appropriate locales.
|
|
1938
|
+
*
|
|
1939
|
+
* @param {LocaleState} [state] - Optional initial state for the locale service.
|
|
1940
|
+
* @returns {Observable<EuiServiceStatus>} - Observable emitting the status of the initialization.
|
|
1941
|
+
*/
|
|
1942
|
+
init(state?: LocaleState): Observable<EuiServiceStatus>;
|
|
1943
|
+
/**
|
|
1944
|
+
* This method is used to update the state of the service with a new state.
|
|
1945
|
+
*
|
|
1946
|
+
* @param state
|
|
1947
|
+
*/
|
|
1948
|
+
updateState(state: DeepPartial<T>): void;
|
|
1949
|
+
/**
|
|
1950
|
+
* This method is used to get the state as readonly signal.
|
|
1951
|
+
*/
|
|
1952
|
+
getSignal(): Signal<T>;
|
|
1953
|
+
/**
|
|
1954
|
+
* Retrieves the previous locale used in the application.
|
|
1955
|
+
*
|
|
1956
|
+
* @returns {string} - The previous locale identifier.
|
|
1957
|
+
*/
|
|
1958
|
+
get previousLocale(): string;
|
|
1959
|
+
/**
|
|
1960
|
+
* Retrieves the current locale used in the application.
|
|
1961
|
+
*
|
|
1962
|
+
* @returns {string} - The current locale identifier.
|
|
1963
|
+
*/
|
|
1964
|
+
get currentLocale(): string;
|
|
1965
|
+
/**
|
|
1966
|
+
* Listens for language changes and dynamically sets the locale accordingly.
|
|
1967
|
+
*
|
|
1968
|
+
* @private
|
|
1969
|
+
*/
|
|
1970
|
+
private bindTranslateServiceLangChangeToState;
|
|
1971
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LocaleService<any>, never>;
|
|
1972
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<LocaleService<any>>;
|
|
1973
|
+
}
|
|
1974
|
+
|
|
1975
|
+
declare class LocaleServiceMock<T extends LocaleState = LocaleState> extends LocaleService<T> {
|
|
1976
|
+
protected locale_id: string;
|
|
1977
|
+
private DEFAULT_LOCALE;
|
|
1978
|
+
private stateSub;
|
|
1979
|
+
constructor();
|
|
1980
|
+
getState(): Observable<T>;
|
|
1981
|
+
updateState(state: T): void;
|
|
1982
|
+
init(state?: T): Observable<EuiServiceStatus>;
|
|
1983
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LocaleServiceMock<any>, never>;
|
|
1984
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<LocaleServiceMock<any>>;
|
|
1985
|
+
}
|
|
1986
|
+
|
|
1987
|
+
/**
|
|
1988
|
+
* The status of a library
|
|
1989
|
+
* @enum Status
|
|
1990
|
+
* @property {string} LOADING - the library is loading
|
|
1991
|
+
* @property {string} LOADED - the library is loaded
|
|
1992
|
+
* @property {string} ERROR - the library failed to load
|
|
1993
|
+
*/
|
|
1994
|
+
declare enum Status {
|
|
1995
|
+
LOADING = "loading",
|
|
1996
|
+
LOADED = "loaded",
|
|
1997
|
+
ERROR = "error"
|
|
1998
|
+
}
|
|
1999
|
+
/**
|
|
2000
|
+
* A library is a set of script and style dependencies
|
|
2001
|
+
* that can be loaded dynamically
|
|
2002
|
+
* @interface Library
|
|
2003
|
+
* @property {string} name - global variable object name that the script will give to the library
|
|
2004
|
+
* @property {Dependency[]} dependencies - a set of script and style dependencies
|
|
2005
|
+
* @property {Status} status - the status of the library e.g. LOADED
|
|
2006
|
+
* @example
|
|
2007
|
+
*
|
|
2008
|
+
* const library: Library = {
|
|
2009
|
+
* name: 'Quill',
|
|
2010
|
+
* dependencies: [
|
|
2011
|
+
* {
|
|
2012
|
+
* name: 'quill',
|
|
2013
|
+
* url: 'https://cdn.quilljs.com/1.3.6/quill.js',
|
|
2014
|
+
* type: 'js',
|
|
2015
|
+
* requires: [],
|
|
2016
|
+
* loaded: false,
|
|
2017
|
+
* error: false,
|
|
2018
|
+
* },
|
|
2019
|
+
* {
|
|
2020
|
+
* name: 'quill',
|
|
2021
|
+
* url: 'https://cdn.quilljs.com/1.3.6/quill.snow.css',
|
|
2022
|
+
* type: 'css',
|
|
2023
|
+
* requires: [],
|
|
2024
|
+
* loaded: false,
|
|
2025
|
+
* error: false,
|
|
2026
|
+
* },
|
|
2027
|
+
* ],
|
|
2028
|
+
* status: Status.LOADING,
|
|
2029
|
+
* };
|
|
2030
|
+
*/
|
|
2031
|
+
interface Library {
|
|
2032
|
+
/** global variable object name that the script will give to the library */
|
|
2033
|
+
name: string;
|
|
2034
|
+
/** a set of script and style dependencies */
|
|
2035
|
+
dependencies: Dependency[];
|
|
2036
|
+
/** the status of the library e.g. LOADED */
|
|
2037
|
+
status: Status;
|
|
2038
|
+
}
|
|
2039
|
+
/**
|
|
2040
|
+
* A dependency is a script or style that can be loaded dynamically
|
|
2041
|
+
*/
|
|
2042
|
+
interface Dependency {
|
|
2043
|
+
/** an identifier for the dependency */
|
|
2044
|
+
name: string;
|
|
2045
|
+
/**
|
|
2046
|
+
* the url of the dependency
|
|
2047
|
+
* @example
|
|
2048
|
+
* https://cdn.quilljs.com/1.3.6/quill.js
|
|
2049
|
+
*/
|
|
2050
|
+
url: string;
|
|
2051
|
+
/** the type of the dependency. Is it a style or script? */
|
|
2052
|
+
type: 'js' | 'css';
|
|
2053
|
+
/**
|
|
2054
|
+
* an array of dependencies corresponds to the Dependency.name
|
|
2055
|
+
* that must be loaded before this dependency
|
|
2056
|
+
* @example
|
|
2057
|
+
* ['quill-better-table']
|
|
2058
|
+
* where 'quill-better-table' is the name of the dependency
|
|
2059
|
+
* const betterTable: Dependency = {
|
|
2060
|
+
* name: 'quill-better-table',
|
|
2061
|
+
* url: 'https://cdn.quilljs.com/1.3.6/quill.js',
|
|
2062
|
+
* type: 'js',
|
|
2063
|
+
* requires: ['quill-better-table'],
|
|
2064
|
+
* }
|
|
2065
|
+
*/
|
|
2066
|
+
requires: string[];
|
|
2067
|
+
/** the status of the dependency */
|
|
2068
|
+
status?: Status;
|
|
2069
|
+
/** the number of times the dependency has been loaded */
|
|
2070
|
+
retries?: number;
|
|
2071
|
+
}
|
|
2072
|
+
/**
|
|
2073
|
+
* Configuration for different policies
|
|
2074
|
+
*/
|
|
2075
|
+
interface Policy {
|
|
2076
|
+
/** Maximum number of retry attempts */
|
|
2077
|
+
maxAttempts: number;
|
|
2078
|
+
/** Time between retries in milliseconds */
|
|
2079
|
+
retryInterval: number;
|
|
2080
|
+
/** Time in milliseconds before considering a load attempt as failed */
|
|
2081
|
+
timeout: number;
|
|
2082
|
+
}
|
|
2083
|
+
|
|
2084
|
+
/**
|
|
2085
|
+
* A service for loading external dependencies dynamically to the DOM and keeping track of their status. Dependencies
|
|
2086
|
+
* can be loaded in any order and can have prerequisites. The service will load the prerequisites first and then load
|
|
2087
|
+
* the dependency. If a dependency fails to load, the service will retry loading it according to the retry policy.
|
|
2088
|
+
* The service will emit the status of the dependency when it changes. This is useful for showing a loading indicator
|
|
2089
|
+
* while the dependency is loading. In scenarios where the dependency is not required for the application to function,
|
|
2090
|
+
* the service will not block the application from loading if the dependency fails to load. The service will also
|
|
2091
|
+
* remove the dependency from the DOM if it is removed from the list. This is useful for scenarios where the dependency
|
|
2092
|
+
* is only required for a specific component, might be removed from the list when the component is destroyed, and it
|
|
2093
|
+
* will not affect the bundle size.
|
|
2094
|
+
*
|
|
2095
|
+
* @example
|
|
2096
|
+
* // Add a dependency
|
|
2097
|
+
* loader.addDependency('Quill', 'https://cdn.quilljs.com/1.3.6/quill.js', 'js');
|
|
2098
|
+
* // Get the status of a dependency
|
|
2099
|
+
* loader.getDependencyStatus('Quill');
|
|
2100
|
+
* // Listen for status changes
|
|
2101
|
+
* loader.statusChanges('Quill').subscribe((status: Status) => {
|
|
2102
|
+
* console.log(status);
|
|
2103
|
+
* });
|
|
2104
|
+
* // Remove a dependency
|
|
2105
|
+
* loader.removeDependency('Quill');
|
|
2106
|
+
* // Set the retry policy
|
|
2107
|
+
* loader.setRetryPolicy(3, 1000);
|
|
2108
|
+
* // Set the timeout policy
|
|
2109
|
+
* loader.setTimeoutPolicy(5000);
|
|
2110
|
+
* // Load a dependency with prerequisites
|
|
2111
|
+
* loader.addDependency('Quill', 'https://cdn.quilljs.com/1.3.6/quill.js', 'js', ['QuillStyle']);
|
|
2112
|
+
* loader.addDependency('QuillStyle', 'https://cdn.quilljs.com/1.3.6/quill.snow.css', 'css');
|
|
2113
|
+
* // Load a dependency with prerequisites and retry logic
|
|
2114
|
+
* loader.setRetryPolicy(3, 1000);
|
|
2115
|
+
* loader.setTimeoutPolicy(5000);
|
|
2116
|
+
* loader.addDependency('Quill', 'https://cdn.quilljs.com/1.3.6/quill.js', 'js', ['QuillStyle']);
|
|
2117
|
+
* loader.addDependency('QuillStyle', 'https://cdn.quilljs.com/1.3.6/quill.snow.css', 'css');
|
|
2118
|
+
*/
|
|
2119
|
+
declare class EuiLoaderService {
|
|
2120
|
+
/**
|
|
2121
|
+
* Stores the status and details of each dependency
|
|
2122
|
+
*/
|
|
2123
|
+
private dependencies;
|
|
2124
|
+
/** Observable that emits the name of the dependency when its status changes */
|
|
2125
|
+
private onStatusChange;
|
|
2126
|
+
/**
|
|
2127
|
+
* Configuration for policies such as Retry and timeout for failed loads
|
|
2128
|
+
*/
|
|
2129
|
+
private policy;
|
|
2130
|
+
/**
|
|
2131
|
+
* Add a dependency with its type (JS or CSS) and dependencies
|
|
2132
|
+
*
|
|
2133
|
+
* @param name The name of the dependency
|
|
2134
|
+
* @param url The URL of the dependency
|
|
2135
|
+
* @param type The type of the dependency (JS or CSS)
|
|
2136
|
+
* @param requires The dependencies that must be loaded before this one (optional)
|
|
2137
|
+
*/
|
|
2138
|
+
addDependency(name: string, url: string, type: 'js' | 'css', requires?: string[]): void;
|
|
2139
|
+
/**
|
|
2140
|
+
* Remove a dependency from the DOM
|
|
2141
|
+
*
|
|
2142
|
+
* @param name The name of the dependency
|
|
2143
|
+
*/
|
|
2144
|
+
removeDependency(name: string): void;
|
|
2145
|
+
/**
|
|
2146
|
+
* Allow users to configure the retry policy
|
|
2147
|
+
*
|
|
2148
|
+
* @param maxAttempts The maximum number of retry attempts
|
|
2149
|
+
* @param retryInterval The time between retries in milliseconds
|
|
2150
|
+
*/
|
|
2151
|
+
setRetryPolicy(maxAttempts: number, retryInterval: number): void;
|
|
2152
|
+
/**
|
|
2153
|
+
* Allow users to configure the timeout policy
|
|
2154
|
+
*
|
|
2155
|
+
* @param time The time in milliseconds before considering a load attempt as failed
|
|
2156
|
+
* @see setRetryPolicy
|
|
2157
|
+
* @see statusChanges
|
|
2158
|
+
*/
|
|
2159
|
+
setTimeoutPolicy(time: number): void;
|
|
2160
|
+
/**
|
|
2161
|
+
* Get the status of a dependency
|
|
2162
|
+
*
|
|
2163
|
+
* @param name The name of the dependency
|
|
2164
|
+
* @returns The status of the dependency
|
|
2165
|
+
* @deprecated Prefer using statusChanges instead
|
|
2166
|
+
* @see statusChanges
|
|
2167
|
+
*/
|
|
2168
|
+
getDependencyStatus(name: string): Status | null;
|
|
2169
|
+
/**
|
|
2170
|
+
* Get the status of a dependency as an observable
|
|
2171
|
+
*
|
|
2172
|
+
* @param name The name of the dependency
|
|
2173
|
+
*/
|
|
2174
|
+
statusChanges(name: string): Observable<Status>;
|
|
2175
|
+
/**
|
|
2176
|
+
* Load a dependency and its prerequisites
|
|
2177
|
+
*
|
|
2178
|
+
* @param name The name of the dependency
|
|
2179
|
+
* @see loadDependency
|
|
2180
|
+
*/
|
|
2181
|
+
private loadDependency;
|
|
2182
|
+
/**
|
|
2183
|
+
* Load a JS script and append it to the root of the DOM
|
|
2184
|
+
* @param dependency
|
|
2185
|
+
*/
|
|
2186
|
+
private loadScript;
|
|
2187
|
+
/**
|
|
2188
|
+
* Load a CSS style and append it to the head of the document
|
|
2189
|
+
* @param dependency
|
|
2190
|
+
*/
|
|
2191
|
+
private loadStyle;
|
|
2192
|
+
/**
|
|
2193
|
+
* Error handling for a failed load
|
|
2194
|
+
* @param name
|
|
2195
|
+
* @param error
|
|
2196
|
+
*/
|
|
2197
|
+
private handleError;
|
|
2198
|
+
/**
|
|
2199
|
+
* Get the script element from the DOM
|
|
2200
|
+
*
|
|
2201
|
+
* @param url
|
|
2202
|
+
* @private
|
|
2203
|
+
*/
|
|
2204
|
+
private getScript;
|
|
2205
|
+
/**
|
|
2206
|
+
* Get the style element from the DOM
|
|
2207
|
+
*
|
|
2208
|
+
* @param url
|
|
2209
|
+
* @private
|
|
2210
|
+
*/
|
|
2211
|
+
private getStyle;
|
|
2212
|
+
/**
|
|
2213
|
+
* Reload a dependency which can be either a script or a style. First remove
|
|
2214
|
+
* the element from the DOM and then load it again.
|
|
2215
|
+
*
|
|
2216
|
+
* @param dependency
|
|
2217
|
+
* @private
|
|
2218
|
+
*/
|
|
2219
|
+
private reloadDependency;
|
|
2220
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiLoaderService, never>;
|
|
2221
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiLoaderService>;
|
|
2222
|
+
}
|
|
2223
|
+
|
|
2224
|
+
declare class UserService<T extends UserState = UserState> extends EuiService<T | UserState> {
|
|
2225
|
+
protected store: StoreService<any>;
|
|
2226
|
+
private static readonly DEFAULT_STATE;
|
|
2227
|
+
/**
|
|
2228
|
+
* a single signal holding the state - initial state is null
|
|
2229
|
+
*/
|
|
2230
|
+
private state;
|
|
2231
|
+
/**
|
|
2232
|
+
* a BehaviorSubject holding the state - initial state is null
|
|
2233
|
+
* This is the main source of truth for the state
|
|
2234
|
+
*/
|
|
2235
|
+
private stateSubject;
|
|
2236
|
+
constructor();
|
|
2237
|
+
init(state: T): Observable<EuiServiceStatus>;
|
|
2238
|
+
getState(): Observable<T>;
|
|
2239
|
+
/**
|
|
2240
|
+
* @deprecated this will be removed in a future version
|
|
2241
|
+
* @param mapFn
|
|
2242
|
+
*/
|
|
2243
|
+
getState<K = T>(mapFn?: (state: T) => K): Observable<K>;
|
|
2244
|
+
getState<a extends keyof DeepPartial<T>>(key?: a): Observable<DeepPartial<a>>;
|
|
2245
|
+
/**
|
|
2246
|
+
* This method is used to update the state of the service with a new state.
|
|
2247
|
+
*
|
|
2248
|
+
* @param state
|
|
2249
|
+
*/
|
|
2250
|
+
updateState(state: DeepPartial<T>): void;
|
|
2251
|
+
/**
|
|
2252
|
+
* @deprecated it will be removed in next version. Use updateState(partialState: DeepPartial<T>) instead
|
|
2253
|
+
* @param slice
|
|
2254
|
+
* @param reducer
|
|
2255
|
+
*/
|
|
2256
|
+
updateState(slice: DeepPartial<T>, reducer: (state: T, action: DeepPartial<T>) => T): void;
|
|
2257
|
+
/**
|
|
2258
|
+
* This method is used to get the signal of the service.
|
|
2259
|
+
*/
|
|
2260
|
+
getSignal(): Signal<T>;
|
|
2261
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<UserService<any>, never>;
|
|
2262
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<UserService<any>>;
|
|
2263
|
+
}
|
|
2264
|
+
|
|
2265
|
+
declare class UserServiceMock<T> extends UserService {
|
|
2266
|
+
constructor();
|
|
2267
|
+
init(userState: UserState): Observable<EuiServiceStatus>;
|
|
2268
|
+
getState<K = T>(mapFn?: (state: T) => K): Observable<K>;
|
|
2269
|
+
getState<a extends keyof T>(key?: a): Observable<T[a]>;
|
|
2270
|
+
updateState(userState: UserState): void;
|
|
2271
|
+
updateState<a extends keyof T>(slice: T[a], reducer: (state: any, action: T[a]) => any): void;
|
|
2272
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<UserServiceMock<any>, never>;
|
|
2273
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<UserServiceMock<any>>;
|
|
2274
|
+
}
|
|
2275
|
+
|
|
2276
|
+
declare class EuiGrowlService {
|
|
2277
|
+
growlMessages: any[];
|
|
2278
|
+
isGrowlSticky: boolean;
|
|
2279
|
+
isCloseAllSticky: boolean;
|
|
2280
|
+
growlLife: number;
|
|
2281
|
+
growlPosition: string;
|
|
2282
|
+
growlCallback: any;
|
|
2283
|
+
ariaGrowlLive: 'off' | 'polite' | 'assertive';
|
|
2284
|
+
/**
|
|
2285
|
+
* displays a growl UxMessage item, isSticky
|
|
2286
|
+
*/
|
|
2287
|
+
growl(msg: EuiGrowlMessage, isSticky?: boolean, isMultiple?: boolean, life?: number, position?: string, callback?: () => void, ariaLive?: 'off' | 'polite' | 'assertive'): void;
|
|
2288
|
+
clearGrowl(): void;
|
|
2289
|
+
growlSuccess(msg: string, position?: string): void;
|
|
2290
|
+
growlError(msg: string, position?: string): void;
|
|
2291
|
+
growlWarning(msg: string, position?: string): void;
|
|
2292
|
+
growlInfo(msg: string, position?: string): void;
|
|
2293
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuiGrowlService, never>;
|
|
2294
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuiGrowlService>;
|
|
2295
|
+
}
|
|
2296
|
+
|
|
2297
|
+
declare const LANG_PARAM_KEY = "X-Lang-Param";
|
|
2298
|
+
/**
|
|
2299
|
+
* Interceptor for adding the current language as parameter
|
|
2300
|
+
* Add the header (LANG_PARAM_KEY, <language parameter>) to your request http headers
|
|
2301
|
+
*/
|
|
2302
|
+
declare class AddLangParamInterceptor implements HttpInterceptor {
|
|
2303
|
+
protected translateService: TranslateService;
|
|
2304
|
+
intercept<T>(req: HttpRequest<T>, next: HttpHandler): Observable<HttpEvent<T>>;
|
|
2305
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<AddLangParamInterceptor, never>;
|
|
2306
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<AddLangParamInterceptor>;
|
|
2307
|
+
}
|
|
2308
|
+
|
|
2309
|
+
declare class CachePreventionInterceptor implements HttpInterceptor {
|
|
2310
|
+
intercept<T>(req: HttpRequest<T>, next: HttpHandler): Observable<HttpEvent<T>>;
|
|
2311
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<CachePreventionInterceptor, never>;
|
|
2312
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<CachePreventionInterceptor>;
|
|
2313
|
+
}
|
|
2314
|
+
|
|
2315
|
+
declare class CorsSecurityInterceptor implements HttpInterceptor {
|
|
2316
|
+
intercept<T>(request: HttpRequest<T>, next: HttpHandler): Observable<HttpEvent<T>>;
|
|
2317
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<CorsSecurityInterceptor, never>;
|
|
2318
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<CorsSecurityInterceptor>;
|
|
2319
|
+
}
|
|
2320
|
+
|
|
2321
|
+
declare class CsrfPreventionInterceptor implements HttpInterceptor {
|
|
2322
|
+
intercept<T>(request: HttpRequest<T>, next: HttpHandler): Observable<HttpEvent<T>>;
|
|
2323
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<CsrfPreventionInterceptor, never>;
|
|
2324
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<CsrfPreventionInterceptor>;
|
|
2325
|
+
}
|
|
2326
|
+
|
|
2327
|
+
interface body {
|
|
2328
|
+
success: boolean;
|
|
2329
|
+
status: string;
|
|
2330
|
+
code: number;
|
|
2331
|
+
message: string;
|
|
2332
|
+
}
|
|
2333
|
+
declare class EuLoginSessionTimeoutHandlingInterceptor implements HttpInterceptor {
|
|
2334
|
+
intercept<T extends body>(request: HttpRequest<T>, next: HttpHandler): Observable<HttpEvent<T>>;
|
|
2335
|
+
protected checkRequestSuccessForEULoginSessionTimeout<T extends body, E>(request: HttpRequest<T>, event: HttpEvent<E>): void;
|
|
2336
|
+
protected checkRequestErrorForEULoginSessionTimeout<T = unknown>(request: HttpRequest<T>, response: HttpResponseBase): void;
|
|
2337
|
+
protected isSsoResponse(body: string | body): boolean;
|
|
2338
|
+
protected reauthenticate(): void;
|
|
2339
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EuLoginSessionTimeoutHandlingInterceptor, never>;
|
|
2340
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EuLoginSessionTimeoutHandlingInterceptor>;
|
|
2341
|
+
}
|
|
2342
|
+
|
|
2343
|
+
declare const UX_ERROR_MAPPING_HANDLER_TOKEN: InjectionToken<ErrorMappingHandler>;
|
|
2344
|
+
declare class UxRequestErrorModelInterceptor implements HttpInterceptor {
|
|
2345
|
+
private errorMappingHandler;
|
|
2346
|
+
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
|
|
2347
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<UxRequestErrorModelInterceptor, never>;
|
|
2348
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<UxRequestErrorModelInterceptor>;
|
|
2349
|
+
}
|
|
2350
|
+
|
|
2351
|
+
declare const diffDays: (dateStart: Date, dateEnd: Date) => number;
|
|
2352
|
+
declare const diffDaysFromToday: (date: Date) => number;
|
|
2353
|
+
|
|
2354
|
+
/**
|
|
2355
|
+
* Provides read-only equivalent of jQuery's position function:
|
|
2356
|
+
* http://api.jquery.com/position/
|
|
2357
|
+
*/
|
|
2358
|
+
declare const position: (nativeEl: HTMLElement) => {
|
|
2359
|
+
width: number;
|
|
2360
|
+
height: number;
|
|
2361
|
+
top: number;
|
|
2362
|
+
left: number;
|
|
2363
|
+
};
|
|
2364
|
+
/**
|
|
2365
|
+
* Provides read-only equivalent of jQuery's offset function:
|
|
2366
|
+
* http://api.jquery.com/offset/
|
|
2367
|
+
*/
|
|
2368
|
+
declare const offset: (nativeEl: HTMLElement) => {
|
|
2369
|
+
width: number;
|
|
2370
|
+
height: number;
|
|
2371
|
+
top: number;
|
|
2372
|
+
left: number;
|
|
2373
|
+
};
|
|
2374
|
+
/**
|
|
2375
|
+
* returns the closest, non-statically positioned parentOffset of a given element
|
|
2376
|
+
* @param nativeEl
|
|
2377
|
+
*/
|
|
2378
|
+
declare const parentOffsetEl: (nativeEl: HTMLElement) => Element | Document;
|
|
2379
|
+
declare const getViewElement: <F>(fixture: ComponentFixture<F>, componentClass: string, klass?: string) => {
|
|
2380
|
+
de: DebugElement;
|
|
2381
|
+
el: HTMLElement;
|
|
2382
|
+
domElement: HTMLElement;
|
|
2383
|
+
};
|
|
2384
|
+
declare const closestMatchingParent: (target: HTMLElement, className: string) => HTMLElement | null;
|
|
2385
|
+
|
|
2386
|
+
declare const consumeEvent: (event: Event) => boolean;
|
|
2387
|
+
|
|
2388
|
+
declare const markFormGroupTouched: (FormControls: {
|
|
2389
|
+
[key: string]: AbstractControl;
|
|
2390
|
+
} | AbstractControl[]) => void;
|
|
2391
|
+
declare const markControlsTouched: (group: FormGroup | FormArray) => void;
|
|
2392
|
+
declare const validateEmail: (c: FormControl) => {
|
|
2393
|
+
validateEmail: {
|
|
2394
|
+
valid: boolean;
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
2397
|
+
|
|
2398
|
+
/**
|
|
2399
|
+
* returns a random string with radix=36
|
|
2400
|
+
*/
|
|
2401
|
+
declare const uniqueId: () => string;
|
|
2402
|
+
/**
|
|
2403
|
+
* Its job is to parse number and format it based on given input.
|
|
2404
|
+
* @param value can be a number or a string number
|
|
2405
|
+
* @param fractionSize size of fraction of a number e.g. 1000.88 fraction is 2 (88) default is 2
|
|
2406
|
+
* @param inDecimalSeparator separator for decimal part of the number default is ','
|
|
2407
|
+
* @param inThousandSeparator separator for the whole part of the number default is ''
|
|
2408
|
+
*/
|
|
2409
|
+
declare const formatNumber: (value: number | string, fractionSize?: number, inDecimalSeparator?: string, inThousandSeparator?: string) => string;
|
|
2410
|
+
|
|
2411
|
+
/**
|
|
2412
|
+
* @deprecated it will be removed in the future. Consult the angular documentation for a replacement.
|
|
2413
|
+
* @param error
|
|
2414
|
+
*/
|
|
2415
|
+
declare const handleError: (error: HttpErrorResponse) => Observable<never>;
|
|
2416
|
+
|
|
2417
|
+
/**
|
|
2418
|
+
* check if a value is null or undefined. If it's not both returns true otherwise false
|
|
2419
|
+
*
|
|
2420
|
+
* @param value
|
|
2421
|
+
*/
|
|
2422
|
+
declare const isDefined: <T>(value: T | undefined | null) => value is T;
|
|
2423
|
+
|
|
2424
|
+
declare abstract class CssUtils {
|
|
2425
|
+
static readonly setHtmlClass: (inputClass: string, document: Document) => void;
|
|
2426
|
+
/**
|
|
2427
|
+
* Get the value of a CSS variable. Using getComputedStyle to get the value of the CSS variable (Browser Specific API)
|
|
2428
|
+
* @param inputProperty
|
|
2429
|
+
* @param document
|
|
2430
|
+
* @param platform
|
|
2431
|
+
*/
|
|
2432
|
+
static readonly getCssVarValue: (inputProperty: string, document: Document, platform: unknown) => string;
|
|
2433
|
+
static readonly setCssVarValue: (propertyName: string, propertyValue: string, document: Document) => void;
|
|
2434
|
+
static readonly setCssVar: (inputProperty: string, outputProperty: string, document: Document, platform: unknown) => void;
|
|
2435
|
+
static readonly initCssVars: (document: Document, platform: unknown) => void;
|
|
2436
|
+
static readonly getBreakpointValues: (document: Document, platform: unknown) => any;
|
|
2437
|
+
static readonly activateEditModeCssVars: (isActive: boolean, document: Document) => void;
|
|
2438
|
+
static readonly activateHeaderCssVars: (document: Document, platform: unknown) => void;
|
|
2439
|
+
static readonly activateBreadcrumbCssVars: (document: Document, platform: unknown) => void;
|
|
2440
|
+
static readonly activateTopMessageCssVars: (height: number, document: Document) => void;
|
|
2441
|
+
static readonly activateToolbarCssVars: (document: Document, platform: unknown) => void;
|
|
2442
|
+
static readonly activateFooterCssVars: (document: Document, platform: unknown) => void;
|
|
2443
|
+
static readonly setHeaderShrinkCssVar: (active: boolean, document: Document, platform: unknown) => void;
|
|
2444
|
+
static readonly activateSidebarCssVars: (document: Document, platform: unknown, hasSidebarCollapsedVariant?: boolean) => void;
|
|
2445
|
+
static readonly removeSidebarCssVars: (document: Document) => void;
|
|
2446
|
+
static readonly activateSidebarHeaderCssVars: (document: Document, platform: unknown) => void;
|
|
2447
|
+
static readonly activateSidebarFooterCssVars: (document: Document, platform: unknown) => void;
|
|
2448
|
+
/**
|
|
2449
|
+
* Gets the viewport height and width and multiply it by 1% to get a value for a vh/vw unit
|
|
2450
|
+
* Sets the value in the --eui-app-vh custom property to the root of the document
|
|
2451
|
+
* Sets the value in the --eui-app-vw custom property to the root of the document
|
|
2452
|
+
* Example for 100% height: calc(var(--eui-app-vh, 1vh) * 100);
|
|
2453
|
+
* Example for 50% height: calc(var(--eui-app-vh, 1vh) * 50);
|
|
2454
|
+
* Example for 50% width: calc(var(--eui-app-vw, 1vw) * 50);
|
|
2455
|
+
*/
|
|
2456
|
+
static setAppViewportCssVars(platform: unknown): void;
|
|
2457
|
+
}
|
|
2458
|
+
|
|
2459
|
+
/**
|
|
2460
|
+
* Safely resolves a service from the injector only when needed.
|
|
2461
|
+
* Avoids instantiation errors that can occur with `inject(..., { optional: true })`.
|
|
2462
|
+
*
|
|
2463
|
+
* @param token The service token to inject
|
|
2464
|
+
* @param injector The injector to use (defaults to the current injector)
|
|
2465
|
+
* @returns The service instance or null if unavailable
|
|
2466
|
+
*/
|
|
2467
|
+
declare function injectOptional<T>(token: Type<T> | InjectionToken<T>, injector?: Injector): T | null;
|
|
2468
|
+
|
|
2469
|
+
export { ActivatedRouteAction, AddApiQueueItemAction, AddAppLoadedConfigModulesAction, AddLangParamInterceptor, AlertHttpErrorCallbackFn, ApiQueueService, ApiQueueServiceMock, AsyncStorageService, AsyncStorageServiceMock, BASE_LOGGER_NAME_TOKEN, BASE_NAME_TOKEN, BrowserStorageType, CONFIG_TOKEN, CORE_ROOT_GUARD, CachePreventionInterceptor, ConsoleHttpErrorCallbackFn, CoreAppActionTypes, CoreI18nActionTypes, CoreLocaleActionTypes, CoreModule, CoreNotificationsActionTypes, CoreUserActionTypes, CorsSecurityInterceptor, CsrfPreventionInterceptor, CssUtils, DYNAMIC_COMPONENT_CONFIG, EUI_CONFIG_TOKEN, EUI_COUNTRIES, EUI_TIMEZONES, EmptyApiQueueAction, ErrorSubClass, EuLoginSessionTimeoutHandlingInterceptor, EuiAppShellService, EuiCoreRootGuardClass, EuiDynamicComponentService, EuiDynamicMenuService, EuiError, EuiGrowlService, EuiLoaderService, EuiPermissionService, EuiTheme, EuiThemeService, EuiTimezoneService, GLOBAL_CONFIG_TOKEN, GlobalErrorHandler, GrowlHttpErrorCallbackFn, HTTP_ERROR_HANDLER_CONFIG_TOKEN, HttpErrorHandlerInterceptor, I18nLoader, I18nResourceImpl, I18nService, InitStoreAction, LANG_PARAM_KEY, LOCALE_ID_MAPPER, LOCAL_FORAGE_SERVICE_CONFIG_TOKEN, LOG_APPENDERS_TOKEN, LOG_LEVEL_TOKEN, LocalForageService, LocalStorageService, LocaleService, LocaleServiceMock, LogHttpErrorCallbackFn, LogModule, LogService, LogServiceMock, MODULE_CONFIG_TOKEN, MODULE_NAME_TOKEN, PLATFORM_BROWSER_ID, ROOT_LOG_CONFIG_TOKEN, RemoveApiQueueItemAction, SHOW_CONNECTION_STATUS_TOKEN, SessionStorageService, Status, StorageService, StorageServiceMock, StoreService, StoreServiceMock, UX_ERROR_MAPPING_HANDLER_TOKEN, UpdateAppConnectionAction, UpdateAppStatusAction, UpdateAppVersionAction, UpdateCurrentModuleAction, UpdateI18nStateAction, UpdateLocaleStateAction, UpdateNotificationsListAction, UpdateUserDashboardAction, UpdateUserDetailsAction, UpdateUserPreferencesAction, UpdateUserRightsAction, UpdateUserStateAction, UserService, UserServiceMock, UxRequestErrorModelInterceptor, closestMatchingParent, consumeEvent, corI18nReducers, coreAppReducers, coreLocaleReducers, coreNotificationsReducers, coreUserReducers, createEuiCoreRootGuard, diffDays, diffDaysFromToday, errorCodes, euiCoreRootGuardClass, euiInitApp, formatNumber, getGlobalConfig, getHttpErrorHandlingConfig, getModuleConfig, getRootLogConfig, getShowConnectionStatus, getViewElement, handleError, injectOptional, isDefined, loadEuiDynamicEnvironmentConfig, loadState, localForage, localStorageSync, markControlsTouched, markFormGroupTouched, mergeAppHandlerConfigToAppConfig, mergeAppJsonConfigToAppConfig, offset, parentOffsetEl, position, preInitApp, prepareEuiAppConfigToken, provideEuiInitializer, coreReducers as reducers, sessionStorageSync, translateConfig, uniqueId, validateEmail };
|
|
2470
|
+
export type { CoreAppActions, CoreI18nActions, CoreLocaleActions, CoreNotificationsActions, CoreUserActions, Dependency, EuiTimeZone, Handler, Library, LoadedResources, LoadedResourcesError, LocaleMapper, ModuleLoadEvent, Policy, ThemeState, TranslationKeys, UIState };
|
|
2471
|
+
//# sourceMappingURL=index.d.ts.map
|