@odx/angular 5.7.4 → 6.0.1

package/fesm2022/odx-angular-localization.mjs

@@ -1,16 +1,85 @@
 import { provideHttpClient, withInterceptors } from '@angular/common/http';
 import * as i0 from '@angular/core';
 import { makeEnvironmentProviders, APP_INITIALIZER, inject, Injector, runInInjectionContext, Injectable } from '@angular/core';
-import { getLanguageCode, createConfigTokens, matchUrl } from '@odx/angular/utils';
-import { BehaviorSubject, filter, distinctUntilChanged, shareReplay, firstValueFrom, isObservable, from, of, take, switchMap } from 'rxjs';
+import { createConfigTokens, matchUrl } from '@odx/angular/utils';
+import { BehaviorSubject, filter, map, distinctUntilChanged, shareReplay, firstValueFrom, isObservable, from, of, take, switchMap } from 'rxjs';
+import { Logger } from '@odx/angular/internal';
 import { WindowRef } from '@odx/angular';
 
-const DEFAULT_AVAILABLE_LOCALES = ['en-US', 'en-GB', 'de-DE', 'es-ES', 'fr-FR', 'fr-CA'];
-const DEFAULT_AVAILABLE_LANGUAGES = Array.from(new Set(DEFAULT_AVAILABLE_LOCALES.map(getLanguageCode)));
+const DEFAULT_AVAILABLE_LANGUAGES = ['en-US', 'en-GB', 'en', 'de-DE', 'de', 'es-ES', 'es', 'fr-FR', 'fr-CA', 'fr'];
+/**
+ * Utilizes `createConfigTokens` to generate configuration tokens and related utilities for the
+ * localization settings within the application. It defines a structured and type-safe approach
+ * for managing localization configurations, such as available languages, and potentially
+ * a dynamic loader for the active language. The generated tokens and utilities facilitate accessing
+ * and providing these configurations throughout the application.
+ *
+ * @const {InjectionToken<LocalizationConfig>} LocalizationConfig - An InjectionToken for accessing
+ * the localization configuration within Angular's dependency injection framework. Use this token to inject
+ * localization configurations into services, components, or other tokens.
+ *
+ * @const {LocalizationConfig} LocalizationDefaultConfig - The default configuration values for localization,
+ * based on the provided settings. Includes the default available languages.
+ *
+ * @const {Function} injectLocalizationConfig - A utility function that returns the injected value of
+ * `LocalizationConfig` token. Use this function to access the current localization configuration in
+ * a type-safe manner.
+ *
+ * @const {Function} provideLocalizationConfig - A utility function to provide the `LocalizationConfig` token
+ * with specific values. Use this function to configure and override default localization settings within
+ * an Angular module or component.
+ *
+ * @example
+ * ```ts
+ * // Providing localization settings in an Angular module
+ * @NgModule({
+ *   providers: [
+ *     provideLocalizationConfig({
+ *       availableLanguages: ['en', 'es', 'fr'],
+ *     })
+ *   ]
+ * })
+ * export class AppModule { }
+ *
+ * // Injecting and using the localization configuration in a service
+ * @Injectable({ providedIn: 'root' })
+ * export class MyLocalizationService {
+ *   constructor(@Inject(LocalizationConfig) private config: LocalizationConfig) {
+ *     console.log('Available languages:', config.availableLanguages);
+ *   }
+ * }
+ * ```
+ */
 const { LocalizationConfig, LocalizationDefaultConfig, injectLocalizationConfig, provideLocalizationConfig } = createConfigTokens('Localization', '@odx/angular/internal/translate', {
     availableLanguages: DEFAULT_AVAILABLE_LANGUAGES,
-    availableLocales: DEFAULT_AVAILABLE_LOCALES,
 });
+/**
+ * Sets up the localization configuration for the application and initializes the localization
+ * system with the provided configuration and features. This function is typically called
+ * within the main module or a core module of the application to ensure localization settings
+ * are available and active as early as possible.
+ *
+ * @param {Partial<LocalizationConfig>} config The localization configuration settings, including
+ * available languages and optionally, a custom loader for the active language.
+ * @param {...LocalizationFeature[]} features Additional localization features or configurations
+ * to be registered as part of the application's environment providers.
+ * @returns {EnvironmentProviders} A collection of providers for setting up the application's
+ * localization environment, to be used with Angular's environment-specific injector configuration.
+ * @example
+ * ```ts
+ * // Example of providing localization settings in an Angular module
+ * @NgModule({
+ *   imports: [...],
+ *   providers: [
+ *     provideLocalization({
+ *       availableLanguages: ['en', 'es', 'fr'],
+ *       activeLanguageLoader: () => fetch('/api/user/language').then(res => res.text()),
+ *     }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
 function provideLocalization(config, ...features) {
     return makeEnvironmentProviders([
         provideLocalizationConfig(config),
@@ -24,49 +93,81 @@ function provideLocalization(config, ...features) {
     ]);
 }
 
+var logger = new Logger('@odx/angular/localization');
+
 class LocalizationService {
     constructor() {
-        this.injector = inject(Injector);
         this.localizationConfig = injectLocalizationConfig();
-        this.activeLanguage$$ = new BehaviorSubject(undefined);
-        this.activeLocale$$ = new BehaviorSubject(undefined);
-        this.activeLanguage$ = this.activeLanguage$$.pipe(filter(Boolean), distinctUntilChanged(), shareReplay({ bufferSize: 1, refCount: true }));
+        this.injector = inject(Injector);
+        this.localeState$ = new BehaviorSubject(new Intl.Locale(this.localizationConfig.availableLanguages[0]));
+        /**
+         * Represents an observable stream of the active language in the localization service.
+         * The active language is determined by the locale state.
+         *
+         * @emits {string} The active language.
+         */
+        this.activeLanguage$ = this.localeState$.pipe(filter(Boolean), map((x) => x.baseName), distinctUntilChanged(), shareReplay({ bufferSize: 1, refCount: true }));
+        /**
+         * Gets the list of available languages for localization.
+         *
+         * @type {string[]} The list of available languages.
+         */
         this.availableLanguages = this.localizationConfig.availableLanguages;
+        /** Default language derived from the first entry in the available languages list.
+         *
+         * @type {string}
+         */
         this.defaultLanguage = this.availableLanguages[0];
-        this.availableLocales = this.localizationConfig.availableLocales;
-        this.defaultLocale = this.availableLocales[0];
     }
+    /**
+     * Retrieves the currently active language. Falls back to the default language if
+     * no active language is set.
+     *
+     * @returns {string} Full locale name e.g. 'en-US' or just 'en' if no region info is attached.
+     */
     getActiveLanguage() {
-        return this.activeLanguage$$.getValue() ?? this.defaultLanguage;
+        return this.localeState$.getValue()?.baseName ?? new Intl.Locale(this.defaultLanguage).baseName;
+    }
+    /**
+     * Retrieves the active language subtag.
+     *
+     * @returns {string} The two-digit language subtag, e.g. 'en', 'fr'.
+     */
+    getActiveLanguageSubtag() {
+        return this.localeState$.getValue()?.language ?? new Intl.Locale(this.defaultLanguage).language;
     }
+    /**
+     * Sets the active language based on the provided language code. If the language is not
+     * recognized, it logs an error and does not change the active language.
+     *
+     * @param {string} language The language code to set as the active language.
+     */
     setActiveLanguage(language) {
-        if (this.availableLanguages.includes(language)) {
-            this.activeLanguage$$.next(language);
-            return;
-        }
-        const languageCode = getLanguageCode(language);
-        if (this.availableLanguages.includes(languageCode)) {
-            this.activeLanguage$$.next(languageCode);
-            return;
+        try {
+            const locale = new Intl.Locale(language);
+            if (this.availableLanguages.includes(locale.baseName) || this.availableLanguages.includes(locale.language)) {
+                this.localeState$.next(locale);
+            }
+            else {
+                throw new Error(`Unrecognizable language '${language}'. Make sure it's a part of availableLanguages inside LocalizationService config.`);
+            }
         }
-        this.activeLanguage$$.next(this.defaultLanguage);
-    }
-    getActiveLocale() {
-        return this.activeLocale$$.getValue() ?? this.defaultLocale;
-    }
-    setActiveLocale(locale) {
-        if (this.availableLocales.includes(locale)) {
-            this.activeLocale$$.next(locale);
-            return;
+        catch (error) {
+            logger.error(error);
         }
-        this.activeLocale$$.next(this.defaultLocale);
     }
+    /**
+     * Loads the active language for the localization service.
+     * This method runs in an injection context and sets the active language based on the result of the active language loader.
+     * If the active language loader fails, the default language is set as the active language.
+     *
+     * @returns {Promise<void>} A promise that resolves when the active language is loaded and set.
+     */
     async loadActiveLanguage() {
         return runInInjectionContext(this.injector, async () => {
             const activeLanguageLoader$ = this.createActiveLanguageLoader$();
             const activeLanguage = await firstValueFrom(activeLanguageLoader$).catch(() => null);
             this.setActiveLanguage(activeLanguage ?? this.defaultLanguage);
-            this.setActiveLocale(activeLanguage ?? this.defaultLocale);
         });
     }
     createActiveLanguageLoader$() {
@@ -92,6 +193,33 @@ function makeLocalizationFeature(provider) {
 }
 
 const HTTP_LANGUAGE_HEADER = 'Accept-Language';
+/**
+ * Creates an HTTP interceptor function that adds a language header to outgoing HTTP requests,
+ * but only for URLs matching the provided criteria. This allows the server to respond with
+ * resources localized in the user's current language.
+ *
+ * @param {HttpLanguageHeaderInterceptorConfig} config - The configuration for the interceptor,
+ * including the list of allowed URLs and optionally a custom header name.
+ * @returns {HttpInterceptorFn} An Angular HTTP interceptor function that conditionally adds
+ * the current language as an HTTP header based on the request URL.
+ *
+ * @example
+ * ```ts
+ * // Use in HTTP client module setup
+ * import { HttpClientModule } from '@angular/common/http';
+ * import { httpLanguageHeaderInterceptor, HTTP_LANGUAGE_HEADER } from '@odx/angular/localization';
+ *
+ * @NgModule({
+ *   imports: [HttpClientModule],
+ *   providers: [
+ *     provideHttpClient(withInterceptors([
+ *       httpLanguageHeaderInterceptor({ allowedUrls: ['/api'], headerName: HTTP_LANGUAGE_HEADER })
+ *     ]))
+ *   ]
+ * })
+ * export class AppModule {}
+ * ```
+ */
 function httpLanguageHeaderInterceptor({ allowedUrls, headerName }) {
     return (req, next) => {
         const language$ = inject(LocalizationService).activeLanguage$.pipe(take(1));
@@ -103,12 +231,64 @@ function httpLanguageHeaderInterceptor({ allowedUrls, headerName }) {
         return next(req);
     };
 }
+/**
+ * Provides a localization feature that automatically adds a language header to HTTP requests
+ * for specified URLs, using the current active language. This function simplifies setting up
+ * the HTTP language header interceptor by wrapping it into a LocalizationFeature, making it easy
+ * to integrate with the application's localization infrastructure.
+ *
+ * @param {HttpLanguageHeaderInterceptorConfig} config - The configuration for the language header
+ * interceptor, specifying which URLs should include the language header and optionally defining a
+ * custom header name.
+ * @returns {LocalizationFeature} A localization feature object that can be used to configure
+ * the application's localization settings to include automatic language header addition for HTTP requests.
+ *
+ * @example
+ * ```ts
+ * // Example usage with the localization provider
+ * import { provideLocalization, LocalizationModule, withHttpLanguageHeader } from '@odx/angular/localization';
+ *
+ * @NgModule({
+ *   imports: [LocalizationModule],
+ *   providers: [
+ *     provideLocalization({}, withHttpLanguageHeader({ allowedUrls: ['/api'] }))
+ *   ]
+ * })
+ * export class AppModule {}
+ * ```
+ */
 function withHttpLanguageHeader(config) {
     const providers = provideHttpClient(withInterceptors([httpLanguageHeaderInterceptor(config)]));
     return makeLocalizationFeature(providers);
 }
 
 const HTTP_LANGUAGE_QUERY = 'language';
+/**
+ * Creates an HTTP interceptor function that appends the current language as a query parameter
+ * to outgoing HTTP requests that match specified URLs. This interceptor enables dynamic content
+ * localization by informing the backend of the user's preferred language.
+ *
+ * @param {HttpLanguageQueryParamInterceptorConfig} config - Configuration for the interceptor,
+ * including allowed URLs and an optional custom name for the query parameter.
+ * @returns {HttpInterceptorFn} The interceptor function ready to be applied to the HTTP client.
+ *
+ * @example
+ * ```ts
+ * // Applying the interceptor in an Angular module
+ * import { HttpClientModule } from '@angular/common/http';
+ * import { withHttpLanguageQueryParam } from '@odx/angular/localization';
+ *
+ * @NgModule({
+ *   imports: [HttpClientModule],
+ *   providers: [
+ *     provideHttpClient(withInterceptors([
+ *       withHttpLanguageQueryParam({ allowedUrls: ['/api/resources'] })
+ *     ]))
+ *   ]
+ * })
+ * export class ApiModule {}
+ * ```
+ */
 function withHttpLanguageQueryParamInterceptor({ allowedUrls, queryParamName }) {
     return (req, next) => {
         const language$ = inject(LocalizationService).activeLanguage$.pipe(take(1));
@@ -120,11 +300,68 @@ function withHttpLanguageQueryParamInterceptor({ allowedUrls, queryParamName })
         return next(req);
     };
 }
+/**
+ * Registers the HTTP interceptor that appends the current language as a query parameter to
+ * outgoing requests for configured URLs as a localization feature. This utility function
+ * simplifies the setup by bundling the interceptor into a feature that can be easily integrated
+ * with localization configurations.
+ *
+ * @param {HttpLanguageQueryParamInterceptorConfig} config - Configuration for appending the
+ * language query parameter, including allowed URLs and an optional parameter name.
+ * @returns {LocalizationFeature} A localization feature encapsulating the interceptor, ready
+ * for integration with the application's localization setup.
+ *
+ * @example
+ * ```ts
+ * // Integrating the localization feature in an Angular module
+ * import { provideLocalization } from '@angular/core';
+ * import { withHttpLanguageQueryParam } from '@odx/angular/localization';
+ *
+ * @NgModule({
+ *   providers: [
+ *     provideLocalization({}, withHttpLanguageQueryParam({ allowedUrls: ['/api'] }))
+ *   ]
+ * })
+ * export class AppModule {}
+ * ```
+ */
 function withHttpLanguageQueryParam(config) {
     const providers = provideHttpClient(withInterceptors([withHttpLanguageQueryParamInterceptor(config)]));
     return makeLocalizationFeature(providers);
 }
 
+/**
+ * Asynchronously loads the browser's current language setting by utilizing the `WindowRef` service.
+ * This function is intended to be used as a dynamic language loader within a localization configuration,
+ * allowing applications to automatically adapt to the user's preferred language as specified in their
+ * browser settings.
+ *
+ * The `WindowRef` service abstracts window-related operations, making it easier to interact with global
+ * browser properties and methods in a testable and platform-agnostic way. This function makes use of
+ * `WindowRef` to access the navigator's language setting in a safe and Angular-friendly manner.
+ *
+ * @returns {Promise<string>} A promise that resolves to the language code (e.g., 'en', 'fr') of the
+ * browser's currently configured language. This can then be used to set the active language in a
+ * localization configuration.
+ *
+ * @example
+ * ```ts
+ * // Example usage in a localization configuration
+ * import { provideLocalization } from '@odx/angular/utils';
+ * import { browserLanguageLoader } from '@odx/angular/localization';
+ *
+ * @NgModule({
+ *   providers: [
+ *     provideLocalization({
+ *       activeLanguageLoader: browserLanguageLoader,
+ *       availableLanguages: ['en', 'es', 'fr'],
+ *       availableLocales: ['en-US', 'es-ES', 'fr-FR']
+ *     })
+ *   ]
+ * })
+ * export class AppModule { }
+ * ```
+ */
 const browserLanguageLoader = async () => {
     return inject(WindowRef).getLanguage();
 };
@@ -133,5 +370,5 @@ const browserLanguageLoader = async () => {
  * Generated bundle index. Do not edit.
  */
 
-export { DEFAULT_AVAILABLE_LANGUAGES, DEFAULT_AVAILABLE_LOCALES, HTTP_LANGUAGE_HEADER, HTTP_LANGUAGE_QUERY, LocalizationConfig, LocalizationDefaultConfig, LocalizationService, browserLanguageLoader, httpLanguageHeaderInterceptor, injectLocalizationConfig, makeLocalizationFeature, provideLocalization, provideLocalizationConfig, withHttpLanguageHeader, withHttpLanguageQueryParam, withHttpLanguageQueryParamInterceptor };
+export { DEFAULT_AVAILABLE_LANGUAGES, HTTP_LANGUAGE_HEADER, HTTP_LANGUAGE_QUERY, LocalizationConfig, LocalizationDefaultConfig, LocalizationService, browserLanguageLoader, httpLanguageHeaderInterceptor, injectLocalizationConfig, makeLocalizationFeature, provideLocalization, provideLocalizationConfig, withHttpLanguageHeader, withHttpLanguageQueryParam, withHttpLanguageQueryParamInterceptor };
 //# sourceMappingURL=odx-angular-localization.mjs.map

package/fesm2022/odx-angular-localization.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"odx-angular-localization.mjs","sources":["../../../../libs/angular/localization/src/lib/localization.config.ts","../../../../libs/angular/localization/src/lib/localization.service.ts","../../../../libs/angular/localization/src/lib/models/localization-feature.ts","../../../../libs/angular/localization/src/lib/features/with-http-language-header.ts","../../../../libs/angular/localization/src/lib/features/with-http-language-query-param.ts","../../../../libs/angular/localization/src/lib/loaders/browser-language-loader.ts","../../../../libs/angular/localization/src/odx-angular-localization.ts"],"sourcesContent":["import { APP_INITIALIZER, EnvironmentProviders, makeEnvironmentProviders } from '@angular/core';\nimport { createConfigTokens, getLanguageCode } from '@odx/angular/utils';\nimport { LocalizationService } from './localization.service';\nimport { LanguageLoaderFn, LocalizationFeature } from './models';\n\nexport const DEFAULT_AVAILABLE_LOCALES = ['en-US', 'en-GB', 'de-DE', 'es-ES', 'fr-FR', 'fr-CA'];\nexport const DEFAULT_AVAILABLE_LANGUAGES = Array.from(new Set(DEFAULT_AVAILABLE_LOCALES.map(getLanguageCode)));\n\nexport interface LocalizationConfig {\n  activeLanguageLoader?: LanguageLoaderFn;\n  availableLanguages: string[];\n  availableLocales: string[];\n}\n\nexport const { LocalizationConfig, LocalizationDefaultConfig, injectLocalizationConfig, provideLocalizationConfig } = createConfigTokens(\n  'Localization',\n  '@odx/angular/internal/translate',\n  {\n    availableLanguages: DEFAULT_AVAILABLE_LANGUAGES,\n    availableLocales: DEFAULT_AVAILABLE_LOCALES,\n  } as LocalizationConfig,\n);\n\nexport function provideLocalization(config: Partial<LocalizationConfig>, ...features: LocalizationFeature[]): EnvironmentProviders {\n  return makeEnvironmentProviders([\n    provideLocalizationConfig(config),\n    {\n      provide: APP_INITIALIZER,\n      useFactory: (localizationService: LocalizationService) => () => localizationService.loadActiveLanguage(),\n      deps: [LocalizationService],\n      multi: true,\n    },\n    features,\n  ]);\n}\n","import { Injectable, Injector, inject, runInInjectionContext } from '@angular/core';\nimport { getLanguageCode } from '@odx/angular/utils';\nimport { BehaviorSubject, Observable, distinctUntilChanged, filter, firstValueFrom, from, isObservable, of, shareReplay } from 'rxjs';\nimport { injectLocalizationConfig } from './localization.config';\n\n@Injectable({ providedIn: 'root' })\nexport class LocalizationService {\n  private readonly injector = inject(Injector);\n  private readonly localizationConfig = injectLocalizationConfig();\n  private readonly activeLanguage$$ = new BehaviorSubject<string | undefined>(undefined);\n  private readonly activeLocale$$ = new BehaviorSubject<string | undefined>(undefined);\n\n  public readonly activeLanguage$ = this.activeLanguage$$.pipe(filter(Boolean), distinctUntilChanged(), shareReplay({ bufferSize: 1, refCount: true }));\n  public readonly availableLanguages = this.localizationConfig.availableLanguages;\n  public readonly defaultLanguage = this.availableLanguages[0];\n  public readonly availableLocales = this.localizationConfig.availableLocales;\n  public readonly defaultLocale = this.availableLocales[0];\n\n  public getActiveLanguage(): string {\n    return this.activeLanguage$$.getValue() ?? this.defaultLanguage;\n  }\n\n  public setActiveLanguage(language: string): void {\n    if (this.availableLanguages.includes(language)) {\n      this.activeLanguage$$.next(language);\n      return;\n    }\n    const languageCode = getLanguageCode(language);\n    if (this.availableLanguages.includes(languageCode)) {\n      this.activeLanguage$$.next(languageCode);\n      return;\n    }\n    this.activeLanguage$$.next(this.defaultLanguage);\n  }\n\n  public getActiveLocale(): string {\n    return this.activeLocale$$.getValue() ?? this.defaultLocale;\n  }\n\n  public setActiveLocale(locale: string): void {\n    if (this.availableLocales.includes(locale)) {\n      this.activeLocale$$.next(locale);\n      return;\n    }\n    this.activeLocale$$.next(this.defaultLocale);\n  }\n\n  public async loadActiveLanguage(): Promise<void> {\n    return runInInjectionContext(this.injector, async () => {\n      const activeLanguageLoader$ = this.createActiveLanguageLoader$();\n      const activeLanguage = await firstValueFrom(activeLanguageLoader$).catch(() => null);\n      this.setActiveLanguage(activeLanguage ?? this.defaultLanguage);\n      this.setActiveLocale(activeLanguage ?? this.defaultLocale);\n    });\n  }\n\n  private createActiveLanguageLoader$(): Observable<string | undefined> {\n    const language = this.localizationConfig.activeLanguageLoader?.();\n    if (isObservable(language)) {\n      return language;\n    }\n    if (language instanceof Promise) {\n      return from(language);\n    }\n    return of(language);\n  }\n}\n","import { EnvironmentProviders, Provider } from '@angular/core';\n\nexport type LocalizationFeature = EnvironmentProviders & { ɵodxBrand: '@odx/angular/localization::LocalizationFeature' };\n\nexport function makeLocalizationFeature(provider: Provider[] | EnvironmentProviders): LocalizationFeature {\n  return provider as never as LocalizationFeature;\n}\n","import { HttpInterceptorFn, provideHttpClient, withInterceptors } from '@angular/common/http';\nimport { inject } from '@angular/core';\nimport { matchUrl } from '@odx/angular/utils';\nimport { switchMap, take } from 'rxjs';\nimport { LocalizationService } from '../localization.service';\nimport { LocalizationFeature, makeLocalizationFeature } from '../models';\n\nexport const HTTP_LANGUAGE_HEADER = 'Accept-Language';\n\nexport interface HttpLanguageHeaderInterceptorConfig {\n  allowedUrls: Array<string | RegExp>;\n  headerName?: string;\n}\n\nexport function httpLanguageHeaderInterceptor({ allowedUrls, headerName }: HttpLanguageHeaderInterceptorConfig): HttpInterceptorFn {\n  return (req, next) => {\n    const language$ = inject(LocalizationService).activeLanguage$.pipe(take(1));\n    for (const allowedUrl of allowedUrls) {\n      if (!matchUrl(req.url, allowedUrl)) continue;\n      return language$.pipe(switchMap((language) => next(req.clone({ setHeaders: { [headerName ?? HTTP_LANGUAGE_HEADER]: language } }))));\n    }\n    return next(req);\n  };\n}\n\nexport function withHttpLanguageHeader(config: HttpLanguageHeaderInterceptorConfig): LocalizationFeature {\n  const providers = provideHttpClient(withInterceptors([httpLanguageHeaderInterceptor(config)]));\n\n  return makeLocalizationFeature(providers);\n}\n","import { HttpInterceptorFn, provideHttpClient, withInterceptors } from '@angular/common/http';\nimport { inject } from '@angular/core';\nimport { matchUrl } from '@odx/angular/utils';\nimport { switchMap, take } from 'rxjs';\nimport { LocalizationService } from '../localization.service';\nimport { LocalizationFeature, makeLocalizationFeature } from '../models';\n\nexport const HTTP_LANGUAGE_QUERY = 'language';\n\nexport interface HttpLanguageQueryParamInterceptorConfig {\n  allowedUrls: Array<string | RegExp>;\n  queryParamName?: string;\n}\n\nexport function withHttpLanguageQueryParamInterceptor({ allowedUrls, queryParamName }: HttpLanguageQueryParamInterceptorConfig): HttpInterceptorFn {\n  return (req, next) => {\n    const language$ = inject(LocalizationService).activeLanguage$.pipe(take(1));\n    for (const allowedUrl of allowedUrls) {\n      if (!matchUrl(req.url, allowedUrl)) continue;\n      return language$.pipe(switchMap((language) => next(req.clone({ setParams: { [queryParamName ?? HTTP_LANGUAGE_QUERY]: language } }))));\n    }\n    return next(req);\n  };\n}\n\nexport function withHttpLanguageQueryParam(config: HttpLanguageQueryParamInterceptorConfig): LocalizationFeature {\n  const providers = provideHttpClient(withInterceptors([withHttpLanguageQueryParamInterceptor(config)]));\n\n  return makeLocalizationFeature(providers);\n}\n","import { inject } from '@angular/core';\nimport { WindowRef } from '@odx/angular';\nimport { LanguageLoaderFn } from '../models';\n\nexport const browserLanguageLoader: LanguageLoaderFn = async () => {\n  return inject(WindowRef).getLanguage();\n};\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;;;;;;AAKa,MAAA,yBAAyB,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE;AACnF,MAAA,2BAA2B,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,yBAAyB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE;AAQlG,MAAA,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,GAAG,kBAAkB,CACtI,cAAc,EACd,iCAAiC,EACjC;AACE,IAAA,kBAAkB,EAAE,2BAA2B;AAC/C,IAAA,gBAAgB,EAAE,yBAAyB;AACtB,CAAA,EACvB;SAEc,mBAAmB,CAAC,MAAmC,EAAE,GAAG,QAA+B,EAAA;AACzG,IAAA,OAAO,wBAAwB,CAAC;QAC9B,yBAAyB,CAAC,MAAM,CAAC;AACjC,QAAA;AACE,YAAA,OAAO,EAAE,eAAe;AACxB,YAAA,UAAU,EAAE,CAAC,mBAAwC,KAAK,MAAM,mBAAmB,CAAC,kBAAkB,EAAE;YACxG,IAAI,EAAE,CAAC,mBAAmB,CAAC;AAC3B,YAAA,KAAK,EAAE,IAAI;AACZ,SAAA;QACD,QAAQ;AACT,KAAA,CAAC,CAAC;AACL;;MC5Ba,mBAAmB,CAAA;AADhC,IAAA,WAAA,GAAA;AAEmB,QAAA,IAAA,CAAA,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,IAAkB,CAAA,kBAAA,GAAG,wBAAwB,EAAE,CAAC;AAChD,QAAA,IAAA,CAAA,gBAAgB,GAAG,IAAI,eAAe,CAAqB,SAAS,CAAC,CAAC;AACtE,QAAA,IAAA,CAAA,cAAc,GAAG,IAAI,eAAe,CAAqB,SAAS,CAAC,CAAC;AAErE,QAAA,IAAA,CAAA,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,oBAAoB,EAAE,EAAE,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACtI,QAAA,IAAA,CAAA,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC;AAChE,QAAA,IAAA,CAAA,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAC7C,QAAA,IAAA,CAAA,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC;AAC5D,QAAA,IAAA,CAAA,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAkD1D,KAAA;IAhDQ,iBAAiB,GAAA;QACtB,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC;KACjE;AAEM,IAAA,iBAAiB,CAAC,QAAgB,EAAA;QACvC,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;AAC9C,YAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrC,OAAO;AACR,SAAA;AACD,QAAA,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;AAClD,YAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzC,OAAO;AACR,SAAA;QACD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;KAClD;IAEM,eAAe,GAAA;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,aAAa,CAAC;KAC7D;AAEM,IAAA,eAAe,CAAC,MAAc,EAAA;QACnC,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC1C,YAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACjC,OAAO;AACR,SAAA;QACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KAC9C;AAEM,IAAA,MAAM,kBAAkB,GAAA;QAC7B,OAAO,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAW;AACrD,YAAA,MAAM,qBAAqB,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC;AACjE,YAAA,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;YACrF,IAAI,CAAC,iBAAiB,CAAC,cAAc,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC;YAC/D,IAAI,CAAC,eAAe,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC;AAC7D,SAAC,CAAC,CAAC;KACJ;IAEO,2BAA2B,GAAA;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,IAAI,CAAC;AAClE,QAAA,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;AAC1B,YAAA,OAAO,QAAQ,CAAC;AACjB,SAAA;QACD,IAAI,QAAQ,YAAY,OAAO,EAAE;AAC/B,YAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC;AACvB,SAAA;AACD,QAAA,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;KACrB;+GA3DU,mBAAmB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA,EAAA;AAAnB,IAAA,SAAA,IAAA,CAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,mBAAmB,cADN,MAAM,EAAA,CAAA,CAAA,EAAA;;4FACnB,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAD/B,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAA;;;ACD5B,SAAU,uBAAuB,CAAC,QAA2C,EAAA;AACjF,IAAA,OAAO,QAAwC,CAAC;AAClD;;ACCO,MAAM,oBAAoB,GAAG,kBAAkB;SAOtC,6BAA6B,CAAC,EAAE,WAAW,EAAE,UAAU,EAAuC,EAAA;AAC5G,IAAA,OAAO,CAAC,GAAG,EAAE,IAAI,KAAI;AACnB,QAAA,MAAM,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5E,QAAA,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC;gBAAE,SAAS;AAC7C,YAAA,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC,UAAU,IAAI,oBAAoB,GAAG,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACrI,SAAA;AACD,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,KAAC,CAAC;AACJ,CAAC;AAEK,SAAU,sBAAsB,CAAC,MAA2C,EAAA;AAChF,IAAA,MAAM,SAAS,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/F,IAAA,OAAO,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C;;ACtBO,MAAM,mBAAmB,GAAG,WAAW;SAO9B,qCAAqC,CAAC,EAAE,WAAW,EAAE,cAAc,EAA2C,EAAA;AAC5H,IAAA,OAAO,CAAC,GAAG,EAAE,IAAI,KAAI;AACnB,QAAA,MAAM,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5E,QAAA,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC;gBAAE,SAAS;AAC7C,YAAA,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,cAAc,IAAI,mBAAmB,GAAG,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACvI,SAAA;AACD,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,KAAC,CAAC;AACJ,CAAC;AAEK,SAAU,0BAA0B,CAAC,MAA+C,EAAA;AACxF,IAAA,MAAM,SAAS,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,qCAAqC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvG,IAAA,OAAO,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C;;ACzBa,MAAA,qBAAqB,GAAqB,YAAW;AAChE,IAAA,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;AACzC;;ACNA;;AAEG;;;;"}
+{"version":3,"file":"odx-angular-localization.mjs","sources":["../../../../libs/angular/localization/src/lib/localization.config.ts","../../../../libs/angular/localization/src/lib/localization.logger.ts","../../../../libs/angular/localization/src/lib/localization.service.ts","../../../../libs/angular/localization/src/lib/models/localization-feature.ts","../../../../libs/angular/localization/src/lib/features/with-http-language-header.ts","../../../../libs/angular/localization/src/lib/features/with-http-language-query-param.ts","../../../../libs/angular/localization/src/lib/loaders/browser-language-loader.ts","../../../../libs/angular/localization/src/odx-angular-localization.ts"],"sourcesContent":["import { APP_INITIALIZER, EnvironmentProviders, makeEnvironmentProviders } from '@angular/core';\nimport { createConfigTokens } from '@odx/angular/utils';\nimport { LocalizationService } from './localization.service';\nimport { LanguageLoaderFn, LocalizationFeature } from './models';\n\nexport const DEFAULT_AVAILABLE_LANGUAGES = ['en-US', 'en-GB', 'en', 'de-DE', 'de', 'es-ES', 'es', 'fr-FR', 'fr-CA', 'fr'];\n\n/**\n * Defines the structure for the localization configuration used throughout the application.\n * It allows specifying available languages, and includes an optional loader\n * function for dynamically determining the active language.\n *\n * @property {LanguageLoaderFn} [activeLanguageLoader] Optional function for loading the\n * active language dynamically, useful for scenarios where the application's language\n * needs to be determined based on user settings, browser settings, or external data.\n * @property {string[]} availableLanguages An array of language codes representing the\n * languages available in the application.\n */\nexport interface LocalizationConfig {\n  activeLanguageLoader?: LanguageLoaderFn;\n  availableLanguages: string[];\n}\n\n/**\n * Utilizes `createConfigTokens` to generate configuration tokens and related utilities for the\n * localization settings within the application. It defines a structured and type-safe approach\n * for managing localization configurations, such as available languages, and potentially\n * a dynamic loader for the active language. The generated tokens and utilities facilitate accessing\n * and providing these configurations throughout the application.\n *\n * @const {InjectionToken<LocalizationConfig>} LocalizationConfig - An InjectionToken for accessing\n * the localization configuration within Angular's dependency injection framework. Use this token to inject\n * localization configurations into services, components, or other tokens.\n *\n * @const {LocalizationConfig} LocalizationDefaultConfig - The default configuration values for localization,\n * based on the provided settings. Includes the default available languages.\n *\n * @const {Function} injectLocalizationConfig - A utility function that returns the injected value of\n * `LocalizationConfig` token. Use this function to access the current localization configuration in\n * a type-safe manner.\n *\n * @const {Function} provideLocalizationConfig - A utility function to provide the `LocalizationConfig` token\n * with specific values. Use this function to configure and override default localization settings within\n * an Angular module or component.\n *\n * @example\n * ```ts\n * // Providing localization settings in an Angular module\n * @NgModule({\n *   providers: [\n *     provideLocalizationConfig({\n *       availableLanguages: ['en', 'es', 'fr'],\n *     })\n *   ]\n * })\n * export class AppModule { }\n *\n * // Injecting and using the localization configuration in a service\n * @Injectable({ providedIn: 'root' })\n * export class MyLocalizationService {\n *   constructor(@Inject(LocalizationConfig) private config: LocalizationConfig) {\n *     console.log('Available languages:', config.availableLanguages);\n *   }\n * }\n * ```\n */\nexport const { LocalizationConfig, LocalizationDefaultConfig, injectLocalizationConfig, provideLocalizationConfig } = createConfigTokens(\n  'Localization',\n  '@odx/angular/internal/translate',\n  {\n    availableLanguages: DEFAULT_AVAILABLE_LANGUAGES,\n  } as LocalizationConfig,\n);\n\n/**\n * Sets up the localization configuration for the application and initializes the localization\n * system with the provided configuration and features. This function is typically called\n * within the main module or a core module of the application to ensure localization settings\n * are available and active as early as possible.\n *\n * @param {Partial<LocalizationConfig>} config The localization configuration settings, including\n * available languages and optionally, a custom loader for the active language.\n * @param {...LocalizationFeature[]} features Additional localization features or configurations\n * to be registered as part of the application's environment providers.\n * @returns {EnvironmentProviders} A collection of providers for setting up the application's\n * localization environment, to be used with Angular's environment-specific injector configuration.\n * @example\n * ```ts\n * // Example of providing localization settings in an Angular module\n * @NgModule({\n *   imports: [...],\n *   providers: [\n *     provideLocalization({\n *       availableLanguages: ['en', 'es', 'fr'],\n *       activeLanguageLoader: () => fetch('/api/user/language').then(res => res.text()),\n *     }),\n *   ],\n * })\n * export class AppModule {}\n * ```\n */\nexport function provideLocalization(config: Partial<LocalizationConfig>, ...features: LocalizationFeature[]): EnvironmentProviders {\n  return makeEnvironmentProviders([\n    provideLocalizationConfig(config),\n    {\n      provide: APP_INITIALIZER,\n      useFactory: (localizationService: LocalizationService) => () => localizationService.loadActiveLanguage(),\n      deps: [LocalizationService],\n      multi: true,\n    },\n    features,\n  ]);\n}\n","import { Logger } from '@odx/angular/internal';\n\nexport default new Logger('@odx/angular/localization');\n","import { Injectable, Injector, inject, runInInjectionContext } from '@angular/core';\nimport { BehaviorSubject, Observable, distinctUntilChanged, filter, firstValueFrom, from, isObservable, map, of, shareReplay } from 'rxjs';\nimport { injectLocalizationConfig } from './localization.config';\nimport logger from './localization.logger';\n\n@Injectable({ providedIn: 'root' })\nexport class LocalizationService {\n  private readonly localizationConfig = injectLocalizationConfig();\n  private readonly injector = inject(Injector);\n  private readonly localeState$ = new BehaviorSubject<Intl.Locale | undefined>(new Intl.Locale(this.localizationConfig.availableLanguages[0]));\n\n  /**\n   * Represents an observable stream of the active language in the localization service.\n   * The active language is determined by the locale state.\n   *\n   * @emits {string} The active language.\n   */\n  public readonly activeLanguage$ = this.localeState$.pipe(\n    filter(Boolean),\n    map((x) => x.baseName),\n    distinctUntilChanged(),\n    shareReplay({ bufferSize: 1, refCount: true }),\n  );\n\n  /**\n   * Gets the list of available languages for localization.\n   *\n   * @type {string[]} The list of available languages.\n   */\n  public readonly availableLanguages = this.localizationConfig.availableLanguages;\n\n  /** Default language derived from the first entry in the available languages list.\n   *\n   * @type {string}\n   */\n  public readonly defaultLanguage = this.availableLanguages[0];\n\n  /**\n   * Retrieves the currently active language. Falls back to the default language if\n   * no active language is set.\n   *\n   * @returns {string} Full locale name e.g. 'en-US' or just 'en' if no region info is attached.\n   */\n  public getActiveLanguage(): string {\n    return this.localeState$.getValue()?.baseName ?? new Intl.Locale(this.defaultLanguage).baseName;\n  }\n\n  /**\n   * Retrieves the active language subtag.\n   *\n   * @returns {string} The two-digit language subtag, e.g. 'en', 'fr'.\n   */\n  public getActiveLanguageSubtag(): string {\n    return this.localeState$.getValue()?.language ?? new Intl.Locale(this.defaultLanguage).language;\n  }\n\n  /**\n   * Sets the active language based on the provided language code. If the language is not\n   * recognized, it logs an error and does not change the active language.\n   *\n   * @param {string} language The language code to set as the active language.\n   */\n  public setActiveLanguage(language: string): void {\n    try {\n      const locale = new Intl.Locale(language);\n      if (this.availableLanguages.includes(locale.baseName) || this.availableLanguages.includes(locale.language)) {\n        this.localeState$.next(locale);\n      } else {\n        throw new Error(`Unrecognizable language '${language}'. Make sure it's a part of availableLanguages inside LocalizationService config.`);\n      }\n    } catch (error) {\n      logger.error(error);\n    }\n  }\n\n  /**\n   * Loads the active language for the localization service.\n   * This method runs in an injection context and sets the active language based on the result of the active language loader.\n   * If the active language loader fails, the default language is set as the active language.\n   *\n   * @returns {Promise<void>} A promise that resolves when the active language is loaded and set.\n   */\n  public async loadActiveLanguage(): Promise<void> {\n    return runInInjectionContext(this.injector, async () => {\n      const activeLanguageLoader$ = this.createActiveLanguageLoader$();\n      const activeLanguage = await firstValueFrom(activeLanguageLoader$).catch(() => null);\n      this.setActiveLanguage(activeLanguage ?? this.defaultLanguage);\n    });\n  }\n\n  private createActiveLanguageLoader$(): Observable<string | undefined> {\n    const language = this.localizationConfig.activeLanguageLoader?.();\n    if (isObservable(language)) {\n      return language;\n    }\n    if (language instanceof Promise) {\n      return from(language);\n    }\n    return of(language);\n  }\n}\n","import { EnvironmentProviders, Provider } from '@angular/core';\n\nexport type LocalizationFeature = EnvironmentProviders & { ɵodxBrand: '@odx/angular/localization::LocalizationFeature' };\n\nexport function makeLocalizationFeature(provider: Provider[] | EnvironmentProviders): LocalizationFeature {\n  return provider as never as LocalizationFeature;\n}\n","import { HttpInterceptorFn, provideHttpClient, withInterceptors } from '@angular/common/http';\nimport { inject } from '@angular/core';\nimport { matchUrl } from '@odx/angular/utils';\nimport { switchMap, take } from 'rxjs';\nimport { LocalizationService } from '../localization.service';\nimport { LocalizationFeature, makeLocalizationFeature } from '../models';\n\nexport const HTTP_LANGUAGE_HEADER = 'Accept-Language';\n\n/**\n * Configuration object for the HTTP language header interceptor. It specifies which URLs\n * the interceptor should apply to and allows customizing the name of the header used to transmit\n * the current language setting.\n *\n * @property {Array<string | RegExp>} allowedUrls - An array of strings or RegExp patterns\n * indicating the URLs to which the language header should be added.\n * @property {string} [headerName=HTTP_LANGUAGE_HEADER] - Optional. The name of the HTTP header\n * through which the current language setting will be transmitted. Defaults to 'Accept-Language'.\n */\nexport interface HttpLanguageHeaderInterceptorConfig {\n  allowedUrls: Array<string | RegExp>;\n  headerName?: string;\n}\n\n/**\n * Creates an HTTP interceptor function that adds a language header to outgoing HTTP requests,\n * but only for URLs matching the provided criteria. This allows the server to respond with\n * resources localized in the user's current language.\n *\n * @param {HttpLanguageHeaderInterceptorConfig} config - The configuration for the interceptor,\n * including the list of allowed URLs and optionally a custom header name.\n * @returns {HttpInterceptorFn} An Angular HTTP interceptor function that conditionally adds\n * the current language as an HTTP header based on the request URL.\n *\n * @example\n * ```ts\n * // Use in HTTP client module setup\n * import { HttpClientModule } from '@angular/common/http';\n * import { httpLanguageHeaderInterceptor, HTTP_LANGUAGE_HEADER } from '@odx/angular/localization';\n *\n * @NgModule({\n *   imports: [HttpClientModule],\n *   providers: [\n *     provideHttpClient(withInterceptors([\n *       httpLanguageHeaderInterceptor({ allowedUrls: ['/api'], headerName: HTTP_LANGUAGE_HEADER })\n *     ]))\n *   ]\n * })\n * export class AppModule {}\n * ```\n */\nexport function httpLanguageHeaderInterceptor({ allowedUrls, headerName }: HttpLanguageHeaderInterceptorConfig): HttpInterceptorFn {\n  return (req, next) => {\n    const language$ = inject(LocalizationService).activeLanguage$.pipe(take(1));\n    for (const allowedUrl of allowedUrls) {\n      if (!matchUrl(req.url, allowedUrl)) continue;\n      return language$.pipe(switchMap((language) => next(req.clone({ setHeaders: { [headerName ?? HTTP_LANGUAGE_HEADER]: language } }))));\n    }\n    return next(req);\n  };\n}\n\n/**\n * Provides a localization feature that automatically adds a language header to HTTP requests\n * for specified URLs, using the current active language. This function simplifies setting up\n * the HTTP language header interceptor by wrapping it into a LocalizationFeature, making it easy\n * to integrate with the application's localization infrastructure.\n *\n * @param {HttpLanguageHeaderInterceptorConfig} config - The configuration for the language header\n * interceptor, specifying which URLs should include the language header and optionally defining a\n * custom header name.\n * @returns {LocalizationFeature} A localization feature object that can be used to configure\n * the application's localization settings to include automatic language header addition for HTTP requests.\n *\n * @example\n * ```ts\n * // Example usage with the localization provider\n * import { provideLocalization, LocalizationModule, withHttpLanguageHeader } from '@odx/angular/localization';\n *\n * @NgModule({\n *   imports: [LocalizationModule],\n *   providers: [\n *     provideLocalization({}, withHttpLanguageHeader({ allowedUrls: ['/api'] }))\n *   ]\n * })\n * export class AppModule {}\n * ```\n */\nexport function withHttpLanguageHeader(config: HttpLanguageHeaderInterceptorConfig): LocalizationFeature {\n  const providers = provideHttpClient(withInterceptors([httpLanguageHeaderInterceptor(config)]));\n\n  return makeLocalizationFeature(providers);\n}\n","import { HttpInterceptorFn, provideHttpClient, withInterceptors } from '@angular/common/http';\nimport { inject } from '@angular/core';\nimport { matchUrl } from '@odx/angular/utils';\nimport { switchMap, take } from 'rxjs';\nimport { LocalizationService } from '../localization.service';\nimport { LocalizationFeature, makeLocalizationFeature } from '../models';\n\nexport const HTTP_LANGUAGE_QUERY = 'language';\n\n/**\n * Defines the configuration options for the HTTP interceptor that appends the current\n * language setting as a query parameter to outgoing requests. This configuration specifies\n * which requests should have the language parameter appended based on their URLs.\n *\n * @property {Array<string | RegExp>} allowedUrls - URLs (or patterns matching URLs) to which\n * the language query parameter should be appended.\n * @property {string} [queryParamName=HTTP_LANGUAGE_QUERY] - The name of the query parameter\n * used to transmit the current language. Defaults to 'language'.\n */\nexport interface HttpLanguageQueryParamInterceptorConfig {\n  allowedUrls: Array<string | RegExp>;\n  queryParamName?: string;\n}\n\n/**\n * Creates an HTTP interceptor function that appends the current language as a query parameter\n * to outgoing HTTP requests that match specified URLs. This interceptor enables dynamic content\n * localization by informing the backend of the user's preferred language.\n *\n * @param {HttpLanguageQueryParamInterceptorConfig} config - Configuration for the interceptor,\n * including allowed URLs and an optional custom name for the query parameter.\n * @returns {HttpInterceptorFn} The interceptor function ready to be applied to the HTTP client.\n *\n * @example\n * ```ts\n * // Applying the interceptor in an Angular module\n * import { HttpClientModule } from '@angular/common/http';\n * import { withHttpLanguageQueryParam } from '@odx/angular/localization';\n *\n * @NgModule({\n *   imports: [HttpClientModule],\n *   providers: [\n *     provideHttpClient(withInterceptors([\n *       withHttpLanguageQueryParam({ allowedUrls: ['/api/resources'] })\n *     ]))\n *   ]\n * })\n * export class ApiModule {}\n * ```\n */\nexport function withHttpLanguageQueryParamInterceptor({ allowedUrls, queryParamName }: HttpLanguageQueryParamInterceptorConfig): HttpInterceptorFn {\n  return (req, next) => {\n    const language$ = inject(LocalizationService).activeLanguage$.pipe(take(1));\n    for (const allowedUrl of allowedUrls) {\n      if (!matchUrl(req.url, allowedUrl)) continue;\n      return language$.pipe(switchMap((language) => next(req.clone({ setParams: { [queryParamName ?? HTTP_LANGUAGE_QUERY]: language } }))));\n    }\n    return next(req);\n  };\n}\n\n/**\n * Registers the HTTP interceptor that appends the current language as a query parameter to\n * outgoing requests for configured URLs as a localization feature. This utility function\n * simplifies the setup by bundling the interceptor into a feature that can be easily integrated\n * with localization configurations.\n *\n * @param {HttpLanguageQueryParamInterceptorConfig} config - Configuration for appending the\n * language query parameter, including allowed URLs and an optional parameter name.\n * @returns {LocalizationFeature} A localization feature encapsulating the interceptor, ready\n * for integration with the application's localization setup.\n *\n * @example\n * ```ts\n * // Integrating the localization feature in an Angular module\n * import { provideLocalization } from '@angular/core';\n * import { withHttpLanguageQueryParam } from '@odx/angular/localization';\n *\n * @NgModule({\n *   providers: [\n *     provideLocalization({}, withHttpLanguageQueryParam({ allowedUrls: ['/api'] }))\n *   ]\n * })\n * export class AppModule {}\n * ```\n */\nexport function withHttpLanguageQueryParam(config: HttpLanguageQueryParamInterceptorConfig): LocalizationFeature {\n  const providers = provideHttpClient(withInterceptors([withHttpLanguageQueryParamInterceptor(config)]));\n\n  return makeLocalizationFeature(providers);\n}\n","import { inject } from '@angular/core';\nimport { WindowRef } from '@odx/angular';\nimport { LanguageLoaderFn } from '../models';\n\n/**\n * Asynchronously loads the browser's current language setting by utilizing the `WindowRef` service.\n * This function is intended to be used as a dynamic language loader within a localization configuration,\n * allowing applications to automatically adapt to the user's preferred language as specified in their\n * browser settings.\n *\n * The `WindowRef` service abstracts window-related operations, making it easier to interact with global\n * browser properties and methods in a testable and platform-agnostic way. This function makes use of\n * `WindowRef` to access the navigator's language setting in a safe and Angular-friendly manner.\n *\n * @returns {Promise<string>} A promise that resolves to the language code (e.g., 'en', 'fr') of the\n * browser's currently configured language. This can then be used to set the active language in a\n * localization configuration.\n *\n * @example\n * ```ts\n * // Example usage in a localization configuration\n * import { provideLocalization } from '@odx/angular/utils';\n * import { browserLanguageLoader } from '@odx/angular/localization';\n *\n * @NgModule({\n *   providers: [\n *     provideLocalization({\n *       activeLanguageLoader: browserLanguageLoader,\n *       availableLanguages: ['en', 'es', 'fr'],\n *       availableLocales: ['en-US', 'es-ES', 'fr-FR']\n *     })\n *   ]\n * })\n * export class AppModule { }\n * ```\n */\nexport const browserLanguageLoader: LanguageLoaderFn = async () => {\n  return inject(WindowRef).getLanguage();\n};\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;;;;;;;AAKa,MAAA,2BAA2B,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;AAkB1H;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CG;AACU,MAAA,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,GAAG,kBAAkB,CACtI,cAAc,EACd,iCAAiC,EACjC;AACE,IAAA,kBAAkB,EAAE,2BAA2B;AAC1B,CAAA,EACvB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BG;SACa,mBAAmB,CAAC,MAAmC,EAAE,GAAG,QAA+B,EAAA;AACzG,IAAA,OAAO,wBAAwB,CAAC;QAC9B,yBAAyB,CAAC,MAAM,CAAC;AACjC,QAAA;AACE,YAAA,OAAO,EAAE,eAAe;AACxB,YAAA,UAAU,EAAE,CAAC,mBAAwC,KAAK,MAAM,mBAAmB,CAAC,kBAAkB,EAAE;YACxG,IAAI,EAAE,CAAC,mBAAmB,CAAC;AAC3B,YAAA,KAAK,EAAE,IAAI;AACZ,SAAA;QACD,QAAQ;AACT,KAAA,CAAC,CAAC;AACL;;AC9GA,aAAe,IAAI,MAAM,CAAC,2BAA2B,CAAC;;MCIzC,mBAAmB,CAAA;AADhC,IAAA,WAAA,GAAA;QAEmB,IAAkB,CAAA,kBAAA,GAAG,wBAAwB,EAAE,CAAC;AAChD,QAAA,IAAA,CAAA,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC5B,QAAA,IAAA,CAAA,YAAY,GAAG,IAAI,eAAe,CAA0B,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7I;;;;;AAKG;AACa,QAAA,IAAA,CAAA,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CACtD,MAAM,CAAC,OAAO,CAAC,EACf,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EACtB,oBAAoB,EAAE,EACtB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/C,CAAC;AAEF;;;;AAIG;AACa,QAAA,IAAA,CAAA,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC;AAEhF;;;AAGG;AACa,QAAA,IAAA,CAAA,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAiE9D,KAAA;AA/DC;;;;;AAKG;IACI,iBAAiB,GAAA;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC;KACjG;AAED;;;;AAIG;IACI,uBAAuB,GAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC;KACjG;AAED;;;;;AAKG;AACI,IAAA,iBAAiB,CAAC,QAAgB,EAAA;QACvC,IAAI;YACF,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACzC,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;AAC1G,gBAAA,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAChC,aAAA;AAAM,iBAAA;AACL,gBAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAA,iFAAA,CAAmF,CAAC,CAAC;AAC1I,aAAA;AACF,SAAA;AAAC,QAAA,OAAO,KAAK,EAAE;AACd,YAAA,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACrB,SAAA;KACF;AAED;;;;;;AAMG;AACI,IAAA,MAAM,kBAAkB,GAAA;QAC7B,OAAO,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAW;AACrD,YAAA,MAAM,qBAAqB,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC;AACjE,YAAA,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;YACrF,IAAI,CAAC,iBAAiB,CAAC,cAAc,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC;AACjE,SAAC,CAAC,CAAC;KACJ;IAEO,2BAA2B,GAAA;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,IAAI,CAAC;AAClE,QAAA,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;AAC1B,YAAA,OAAO,QAAQ,CAAC;AACjB,SAAA;QACD,IAAI,QAAQ,YAAY,OAAO,EAAE;AAC/B,YAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC;AACvB,SAAA;AACD,QAAA,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;KACrB;+GA7FU,mBAAmB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA,EAAA;AAAnB,IAAA,SAAA,IAAA,CAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,mBAAmB,cADN,MAAM,EAAA,CAAA,CAAA,EAAA;;4FACnB,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAD/B,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAA;;;ACD5B,SAAU,uBAAuB,CAAC,QAA2C,EAAA;AACjF,IAAA,OAAO,QAAwC,CAAC;AAClD;;ACCO,MAAM,oBAAoB,GAAG,kBAAkB;AAiBtD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BG;SACa,6BAA6B,CAAC,EAAE,WAAW,EAAE,UAAU,EAAuC,EAAA;AAC5G,IAAA,OAAO,CAAC,GAAG,EAAE,IAAI,KAAI;AACnB,QAAA,MAAM,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5E,QAAA,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC;gBAAE,SAAS;AAC7C,YAAA,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC,UAAU,IAAI,oBAAoB,GAAG,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACrI,SAAA;AACD,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACG,SAAU,sBAAsB,CAAC,MAA2C,EAAA;AAChF,IAAA,MAAM,SAAS,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/F,IAAA,OAAO,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C;;ACrFO,MAAM,mBAAmB,GAAG,WAAW;AAiB9C;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;SACa,qCAAqC,CAAC,EAAE,WAAW,EAAE,cAAc,EAA2C,EAAA;AAC5H,IAAA,OAAO,CAAC,GAAG,EAAE,IAAI,KAAI;AACnB,QAAA,MAAM,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5E,QAAA,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC;gBAAE,SAAS;AAC7C,YAAA,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,cAAc,IAAI,mBAAmB,GAAG,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACvI,SAAA;AACD,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACG,SAAU,0BAA0B,CAAC,MAA+C,EAAA;AACxF,IAAA,MAAM,SAAS,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,qCAAqC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvG,IAAA,OAAO,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C;;ACtFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BG;AACU,MAAA,qBAAqB,GAAqB,YAAW;AAChE,IAAA,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;AACzC;;ACtCA;;AAEG;;;;"}

package/fesm2022/odx-angular-rxjs.mjs

@@ -1,14 +1,53 @@
-import { switchMap, timer, map, takeUntil, startWith, Observable, debounceTime, merge, fromEvent } from 'rxjs';
+import { switchMap, timer, map, takeUntil, Observable, debounceTime, merge, fromEvent, startWith } from 'rxjs';
 import { createMutationObserver, createResizeObserver } from '@odx/angular/utils';
 
+/**
+ * Delays the emission of each value from the source Observable by a time span determined by the `delay` function.
+ * If the `notifier` Observable emits before the delay expires, the delayed emission is cancelled.
+ *
+ * This operator is useful for postponing the observable emissions until certain conditions are met,
+ * represented by the passage of time defined by `delay`. It also allows for a way to preemptively
+ * cancel the delay in response to another observable's emission.
+ *
+ * @template T The type of items emitted by the source Observable.
+ * @param {() => number} delay A function that returns the delay (in milliseconds) before the source Observable's values are emitted.
+ * @param {Observable<unknown>} notifier An Observable that cancels the delay when it emits.
+ * @returns {MonoTypeOperatorFunction<T>} An Observable that emits the source Observable's items with a delay if not cancelled.
+ * @example
+ * ```ts
+ * // Delay each number emission by 1 second, unless the 'cancel' button is clicked.
+ * const delayedNumbers$ = of(1, 2, 3).pipe(
+ *   delayUntil(() => 1000, fromEvent(cancelButton, 'click'))
+ * );
+ *
+ * delayedNumbers$.subscribe(console.log);
+ * ```
+ */
 function delayUntil(delay, notifier) {
     return (source$) => source$.pipe(switchMap((value) => timer(delay()).pipe(map(() => value), takeUntil(notifier))));
 }
 
-function fromQueryList(queryList) {
-    return queryList.changes.pipe(startWith(queryList));
-}
-
+/**
+ * Creates an RxJS Observable that emits mutation records for changes in a DOM element's attributes,
+ * child list, and subtree. It uses the `MutationObserver` Web API to observe mutations on the specified
+ * element according to the options provided.
+ *
+ * @param {Element} element The DOM element to observe for mutations.
+ * @param {MutationObserverInit} options An object that specifies which DOM mutations should be reported.
+ * Options include attributes, childList, subtree, attributeOldValue, characterData, characterDataOldValue,
+ * and attributeFilter.
+ * @returns {Observable<MutationRecord>} An Observable that emits a `MutationRecord` each time a mutation
+ * matching the specified options occurs in the observed element.
+ * @example
+ * ```ts
+ * // Observing changes to the child list of an element
+ * const element = document.getElementById('my-element');
+ * const mutationOptions = { childList: true };
+ *
+ * fromElementMutation$(element, mutationOptions).subscribe((mutation) => console.log('Mutation detected:', mutation));
+ * ```
+ * Note: Always remember to unsubscribe from the observable to prevent memory leaks.
+ */
 function fromElementMutation$(element, options) {
     return new Observable((observer) => {
         const mutationObserver = createMutationObserver(observer, (events) => events.length > 0);
@@ -17,6 +56,30 @@ function fromElementMutation$(element, options) {
     });
 }
 
+/**
+ * Creates an RxJS Observable that emits an array of `ResizeObserverEntry` objects whenever
+ * the target element's size changes. This function provides a reactive way to observe
+ * and respond to changes in an element's dimensions, using the `ResizeObserver` Web API.
+ *
+ * The observable debounces the emitted values to improve performance and reduce the frequency
+ * of change detection runs in Angular applications. The debounce time can be adjusted via
+ * the `debounceDuration` parameter.
+ *
+ * @param {Element} element The DOM element to observe for size changes.
+ * @param {number} [debounceDuration=50] The time, in milliseconds, to debounce the emitted
+ * values. Defaults to 50ms.
+ * @returns {Observable<ResizeObserverEntry[]>} An Observable that emits the resize events
+ * for the observed element. Each emission is an array of `ResizeObserverEntry` objects, one
+ * for each observed element that experienced a resize.
+ * @example
+ * ```ts
+ * // Observing resize events of an element with a 100ms debounce duration
+ * const element = document.getElementById('resizable-element');
+ * fromElementResize$(element, 100).subscribe((entries) => console.log('Element resized:', entries));
+ * ```
+ *
+ * Always unsubscribe from the observable to clean up resources and prevent memory leaks.
+ */
 function fromElementResize$(element, debounceDuration = 50) {
     return new Observable((observer) => {
         const resizeObserver = createResizeObserver((events) => {
@@ -29,10 +92,57 @@ function fromElementResize$(element, debounceDuration = 50) {
     }).pipe(debounceTime(debounceDuration));
 }
 
+/**
+ * Creates an Observable that emits events of a specific type from one or multiple event targets.
+ * It listens to multiple event types on the given target(s) and emits the events through a single
+ * Observable stream, simplifying the handling of related event types.
+ *
+ * @template T The event object type that the Observable will emit.
+ * @param {HasEventTargetAddRemove<T> | HasEventTargetAddRemove<T>[]} target The DOM element(s) or event target(s) to listen on.
+ * @param {...string[]} events The names of the events to listen for on the target(s).
+ * @returns {Observable<T>} An Observable that emits an event each time one of the specified events occurs on the given target(s).
+ *
+ * @example
+ * ```ts
+ * // Listen to both 'click' and 'keyup' events on document
+ * fromEvents(document, 'click', 'keyup').subscribe(event => {
+ *   console.log('Event occurred:', event);
+ * });
+ *
+ * // Listen to 'mousemove' event on multiple elements
+ * const elements = [document.getElementById('first'), document.getElementById('second')];
+ * fromEvents(elements, 'mousemove').subscribe(event => {
+ *   console.log('Mouse moved over:', event.target);
+ * });
+ * ```
+ */
 function fromEvents(target, ...events) {
     return merge(...events.map((event) => fromEvent(target, event)));
 }
 
+/**
+ * Creates an Observable from an Angular QueryList. The Observable emits the initial state
+ * of the QueryList and continues to emit updates every time the QueryList changes.
+ * This utility function is useful for integrating Angular's QueryList changes into
+ * the RxJS reactive data flow, allowing developers to apply RxJS operators and
+ * subscriptions to respond to QueryList updates.
+ *
+ * @template T The type of elements contained within the QueryList.
+ * @param {QueryList<T>} queryList The QueryList instance to observe.
+ * @returns {Observable<QueryList<T>>} An Observable that emits the current state of the QueryList
+ * and updates whenever the QueryList changes.
+ * @example
+ * ```ts
+ * // Assuming 'items' is a QueryList of component instances or DOM elements
+ * fromQueryList(items).subscribe(queryList => {
+ *   console.log('QueryList changed:', queryList);
+ * });
+ * ```
+ */
+function fromQueryList(queryList) {
+    return queryList.changes.pipe(startWith(queryList));
+}
+
 /**
  * Generated bundle index. Do not edit.
  */