@eui/core 17.0.1 → 17.0.2-snapshot-1701743166803

package/lib/services/locale/locale.service.d.ts

@@ -1,14 +1,3 @@
-/**
- * Angular is using a gulp task to generate the locales that we dynamically import. This task can be found here
- * https://github.com/angular/angular/blob/master/tools/gulp-tasks/cldr/cldr-data.js
- * That task is utilizing the CLDR library to load and construct the locale for each region. This service is responsible
- * to load those locale dynamically upon request and to update the state of the eUI app.
- *
- * Parts that are handles through configuration:
- *  - update of the LOCALE_ID token
- *  - initial dynamical load of locales
- *  - bind to translation service for locale changes
- */
 import { InjectionToken, OnDestroy } from '@angular/core';
 import { EuiService, EuiServiceStatus, GlobalConfig, LocaleServiceConfig, LocaleState } from '@eui/base';
 import { Observable } from 'rxjs';
@@ -16,8 +5,20 @@ import { StoreService } from '../store';
 import { LogService } from '../log';
 import { I18nService } from '../i18n';
 import * as i0 from "@angular/core";
-export type LocaleMapper = (locale: string) => any;
+export type LocaleMapper = (locale: string) => string;
 export declare const LOCALE_ID_MAPPER: InjectionToken<LocaleMapper>;
+/**
+ * LocaleService is responsible for managing locale states and configurations in an Angular application.
+ * It utilizes the CLDR library to load and construct the locale for each region. This service allows
+ * for dynamic loading of locales upon request and updates the state of the EUI app accordingly.
+ *
+ * Key functionalities include:
+ *  - Binding to a translation service for locale changes.
+ *  - Updating the Angular LOCALE_ID token.
+ *
+ * @template T - Extends LocaleState, representing the state structure for locales.
+ * @extends EuiService<T | LocaleState>
+ */
 export declare class LocaleService<T extends LocaleState = LocaleState> extends EuiService<T | LocaleState> implements OnDestroy {
     protected store: StoreService;
     protected baseGlobalConfig: GlobalConfig;
@@ -30,39 +31,81 @@ export declare class LocaleService<T extends LocaleState = LocaleState> extends
     protected config: LocaleServiceConfig;
     constructor(store: StoreService, baseGlobalConfig: GlobalConfig, locale_id: string, localeMapper: LocaleMapper, i18n: I18nService, log: LogService);
     ngOnDestroy(): void;
+    /**
+     * Retrieves the state of the locale service. This method is overloaded to allow different ways of accessing the state.
+     *
+     * @template K - The type of the value to be returned. Defaults to the type of the locale state (T).
+     *
+     * @param {((state: T) => K)} [mapFn] - A function that maps the state to a specific form.
+     *                                      Takes the current state as an argument and returns the transformed state.
+     * @returns {Observable<K>} - An observable that emits the transformed state.
+     */
     getState<K = T>(mapFn?: (state: T) => K): Observable<K>;
+    /**
+     * @template a - A key that extends the keys of the state type T.
+     * @param {a} [key] - A specific key to access a part of the state.
+     *                    The key should be a property name of the state object.
+     * @returns {Observable<T[a]>} - An observable that emits the value of the specified key in the state.
+     * @param key
+     */
     getState<a extends keyof T>(key?: a): Observable<T[a]>;
+    /**
+     * Initializes the LocaleService with necessary configurations and state.
+     * Binds language changes to the state and dynamically loads the appropriate locales.
+     *
+     * @param {LocaleState | undefined} [state] - Optional initial state for the locale service.
+     * @returns {Observable<EuiServiceStatus>} - Observable emitting the status of the initialization.
+     */
     init(state?: LocaleState | undefined): Observable<EuiServiceStatus>;
     /**
-     * dynamically load locale and update the state
+     * Updates the locale state within the application. If the new state is not available,
+     * it throws an error. Also updates the global LOCALE_ID token if configured to do so.
+     *
+     * @param {LocaleState} state - The new state to be set for the locale.
+     * @throws Will throw an error if the locale for the given state id is not available.
      */
     updateState(state: LocaleState): void;
+    /**
+     * @deprecated eui does not offer a way to dynamically add locale it will be removed in future versions
+     *
+     * @param id
+     */
     addLocale(id: string): Observable<EuiServiceStatus>;
+    /**
+     * Retrieves the previous locale used in the application.
+     *
+     * @returns {string} - The previous locale identifier.
+     */
     get previousLocale(): string;
+    /**
+     * Retrieves the current locale used in the application.
+     *
+     * @returns {string} - The current locale identifier.
+     */
     get currentLocale(): string;
     /**
-     * load and register locale data dynamically
+     * @deprecated eui does not offer a way to dynamically add locale it will be removed in future versions
      *
-     * @param locale array of locale to load
+     * Dynamically loads and registers locale data based on the given locale identifiers.
+     *
+     * @param {string[] | string} locale - An array of locale identifiers or a single locale identifier.
+     * @returns {Observable<EuiServiceStatus>} - Observable emitting the status of the loading process.
+     * @private
      */
     private loadLocale;
     /**
-     * listen for language changes and dynamically set locale accordingly. In case of non registered locale register it
-     * dynamically.
+     * Listens for language changes and dynamically sets the locale accordingly.
+     *
+     * @private
      */
     private bindTranslateServiceLangChangeToState;
     /**
-     * retrieve locales from browser
+     * Retrieves an array of locale identifiers supported by the browser.
      *
-     * @param options
+     * @returns {string[] | undefined} - An array of browser locale identifiers or undefined if not available.
+     * @private
      */
     private getBrowserLocales;
-    /**
-     * if locale is already registered filtered out.
-     *
-     * @param locales A string array contains all locale id e.g. ["el", "el-CY"]
-     */
-    private filterRegisteredLocales;
     static ɵfac: i0.ɵɵFactoryDeclaration<LocaleService<any>, [null, null, null, { optional: true; }, { optional: true; }, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<LocaleService<any>>;
 }

package/lib/services/locale/locale.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"locale.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/locale/locale.service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAsB,cAAc,EAAa,SAAS,EAAY,MAAM,eAAe,CAAC;AAEnG,OAAO,EACH,UAAU,EACV,gBAAgB,EAGhB,YAAY,EACZ,mBAAmB,EACnB,WAAW,EAEd,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,UAAU,EAA2B,MAAM,MAAM,CAAC;AAE3D,OAAO,EAAE,YAAY,EAA2B,MAAM,UAAU,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;;AAMtC,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,GAAG,CAAC;AACnD,eAAO,MAAM,gBAAgB,8BAAqD,CAAC;AAEnF,qBAGa,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,UAAU,CAAC,CAAC,GAAG,WAAW,CAAE,YAAW,SAAS;IAMhH,SAAS,CAAC,KAAK,EAAE,YAAY;IACA,SAAS,CAAC,gBAAgB,EAAE,YAAY;IAClD,SAAS,CAAC,SAAS,EAAE,MAAM;IACR,OAAO,CAAC,YAAY;IAC9C,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,GAAG;IAV3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,WAAW,CAAgC;IACnD,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC;gBAGxB,KAAK,EAAE,YAAY,EACU,gBAAgB,EAAE,YAAY,EACxC,SAAS,EAAE,MAAM,EACA,YAAY,EAAE,YAAY,EACpD,IAAI,EAAE,WAAW,EACjB,GAAG,EAAE,UAAU;IAcvC,WAAW,IAAI,IAAI;IAKnB,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAwBtD,IAAI,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAgBnE;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAkBrC,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAInD,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;;;OAIG;IAEH,OAAO,CAAC,UAAU;IA4BlB;;;OAGG;IACH,OAAO,CAAC,qCAAqC;IAuD7C;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAUzB;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;yCAzNtB,aAAa;6CAAb,aAAa;CA6RzB"}
+{"version":3,"file":"locale.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/locale/locale.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,cAAc,EAAa,SAAS,EAAY,MAAM,eAAe,CAAC;AAEnG,OAAO,EACH,UAAU,EACV,gBAAgB,EAGhB,YAAY,EACZ,mBAAmB,EACnB,WAAW,EAEd,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,UAAU,EAA2B,MAAM,MAAM,CAAC;AAE3D,OAAO,EAAE,YAAY,EAA2B,MAAM,UAAU,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;;AAItC,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;AACtD,eAAO,MAAM,gBAAgB,8BAAqD,CAAC;AAEnF;;;;;;;;;;;GAWG;AACH,qBAGa,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,UAAU,CAAC,CAAC,GAAG,WAAW,CAAE,YAAW,SAAS;IAMhH,SAAS,CAAC,KAAK,EAAE,YAAY;IACA,SAAS,CAAC,gBAAgB,EAAE,YAAY;IAClD,SAAS,CAAC,SAAS,EAAE,MAAM;IACR,OAAO,CAAC,YAAY;IAC9C,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,GAAG;IAV3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,WAAW,CAAgC;IACnD,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC;gBAGxB,KAAK,EAAE,YAAY,EACU,gBAAgB,EAAE,YAAY,EACxC,SAAS,EAAE,MAAM,EACA,YAAY,EAAE,YAAY,EACpD,IAAI,EAAE,WAAW,EACjB,GAAG,EAAE,UAAU;IAcvC,WAAW,IAAI,IAAI;IAKnB;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IACvD;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAgCtD;;;;;;OAMG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAgBnE;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAkBrC;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAInD;;;;OAIG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;OAIG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;;;;;;;OAQG;IAEH,OAAO,CAAC,UAAU;IAIlB;;;;OAIG;IACH,OAAO,CAAC,qCAAqC;IAuD7C;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;yCA1OhB,aAAa;6CAAb,aAAa;CAoPzB"}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@eui/core",
-    "version": "17.0.1",
-    "tag": "latest",
+    "version": "17.0.2-snapshot-1701743166803",
+    "tag": "snapshot",
     "description": "eUI core package - holding UI components for Desktop applications",
     "homepage": "https://eui.ecdevops.eu",
     "author": "ec.europa.eui@gmail.com",