@jsverse/transloco 7.5.1 → 7.6.1

package/fesm2022/jsverse-transloco.mjs

@@ -1,7 +1,7 @@
 import * as i0 from '@angular/core';
-import { InjectionToken, inject, Injectable, Injector, Inject, Optional, Component, Input, TemplateRef, DestroyRef, ChangeDetectorRef, ElementRef, ViewContainerRef, Renderer2, Directive, Pipe, NgModule, makeEnvironmentProviders, APP_INITIALIZER } from '@angular/core';
+import { InjectionToken, inject, Injectable, Injector, Inject, DestroyRef, Optional, Component, Input, TemplateRef, ChangeDetectorRef, ElementRef, ViewContainerRef, Renderer2, Directive, Pipe, NgModule, makeEnvironmentProviders, APP_INITIALIZER, assertInInjectionContext, runInInjectionContext, isSignal, computed } from '@angular/core';
 import { of, take, from, map, Subject, BehaviorSubject, forkJoin, retry, tap, catchError, shareReplay, switchMap, combineLatest, EMPTY } from 'rxjs';
-import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
+import { takeUntilDestroyed, toObservable, toSignal } from '@angular/core/rxjs-interop';
 
 class DefaultLoader {
     translations;
@@ -12,7 +12,7 @@ class DefaultLoader {
         return of(this.translations.get(lang) || {});
     }
 }
-const TRANSLOCO_LOADER = new InjectionToken('TRANSLOCO_LOADER');
+const TRANSLOCO_LOADER = new InjectionToken(ngDevMode ? 'TRANSLOCO_LOADER' : '');
 
 function getValue(obj, path) {
     if (!obj) {
@@ -143,7 +143,7 @@ function unflatten(obj) {
     return result;
 }
 
-const TRANSLOCO_CONFIG = new InjectionToken('TRANSLOCO_CONFIG', {
+const TRANSLOCO_CONFIG = new InjectionToken(ngDevMode ? 'TRANSLOCO_CONFIG' : '', {
     providedIn: 'root',
     factory: () => defaultConfig,
 });
@@ -186,7 +186,7 @@ function translocoConfig(config = {}) {
     };
 }
 
-const TRANSLOCO_TRANSPILER = new InjectionToken('TRANSLOCO_TRANSPILER');
+const TRANSLOCO_TRANSPILER = new InjectionToken(ngDevMode ? 'TRANSLOCO_TRANSPILER' : '');
 class DefaultTranspiler {
     config = inject(TRANSLOCO_CONFIG, { optional: true }) ?? defaultConfig;
     get interpolationMatcher() {
@@ -330,7 +330,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.9", ngImpor
             type: Injectable
         }] });
 
-const TRANSLOCO_MISSING_HANDLER = new InjectionToken('TRANSLOCO_MISSING_HANDLER');
+const TRANSLOCO_MISSING_HANDLER = new InjectionToken(ngDevMode ? 'TRANSLOCO_MISSING_HANDLER' : '');
 class DefaultMissingHandler {
     handle(key, config) {
         if (config.missingHandler.logMissingKey && !config.prodMode) {
@@ -346,7 +346,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.9", ngImpor
             type: Injectable
         }] });
 
-const TRANSLOCO_INTERCEPTOR = new InjectionToken('TRANSLOCO_INTERCEPTOR');
+const TRANSLOCO_INTERCEPTOR = new InjectionToken(ngDevMode ? 'TRANSLOCO_INTERCEPTOR' : '');
 class DefaultInterceptor {
     preSaveTranslation(translation) {
         return translation;
@@ -361,7 +361,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.9", ngImpor
             type: Injectable
         }] });
 
-const TRANSLOCO_FALLBACK_STRATEGY = new InjectionToken('TRANSLOCO_FALLBACK_STRATEGY');
+const TRANSLOCO_FALLBACK_STRATEGY = new InjectionToken(ngDevMode ? 'TRANSLOCO_FALLBACK_STRATEGY' : '');
 class DefaultFallbackStrategy {
     userConfig;
     constructor(userConfig) {
@@ -503,6 +503,7 @@ class TranslocoService {
     events = new Subject();
     events$ = this.events.asObservable();
     config;
+    destroyRef = inject(DestroyRef);
     constructor(loader, parser, missingHandler, interceptor, userConfig, fallbackStrategy) {
         this.loader = loader;
         this.parser = parser;
@@ -524,11 +525,21 @@ class TranslocoService {
         /**
          * When we have a failure, we want to define the next language that succeeded as the active
          */
-        this.events$.pipe(takeUntilDestroyed()).subscribe((e) => {
+        this.events$.subscribe((e) => {
             if (e.type === 'translationLoadSuccess' && e.wasFailure) {
                 this.setActiveLang(e.payload.langName);
             }
         });
+        this.destroyRef.onDestroy(() => {
+            // Complete subjects to release observers if users forget to unsubscribe manually.
+            // This is important in server-side rendering.
+            this.lang.complete();
+            this.events.complete();
+            // As a root provider, this service is destroyed with when the application is destroyed.
+            // Cached values retain `this`, causing circular references that block garbage collection,
+            // leading to memory leaks during server-side rendering.
+            this.cache.clear();
+        });
     }
     getDefaultLang() {
         return this.defaultLang;
@@ -610,7 +621,7 @@ class TranslocoService {
                 console.error(`Error while trying to load "${path}"`, error);
             }
             return this.handleFailure(path, options);
-        }), shareReplay(1));
+        }), shareReplay(1), takeUntilDestroyed(this.destroyRef));
         this.cache.set(path, load$);
         return load$;
     }
@@ -892,13 +903,6 @@ class TranslocoService {
         }
         this.config.scopeMapping[scope] = alias;
     }
-    ngOnDestroy() {
-        // Caretaker note: since this is the root provider, it'll be destroyed when the `NgModuleRef.destroy()` is run.
-        // Cached values capture `this`, thus leading to a circular reference and preventing the `TranslocoService` from
-        // being GC'd. This would lead to a memory leak when server-side rendering is used since the service is created
-        // and destroyed per each HTTP request, but any service is not getting GC'd.
-        this.cache.clear();
-    }
     isLoadedTranslation(lang) {
         return size(this.getTranslation(lang));
     }
@@ -1085,11 +1089,11 @@ class TemplateHandler {
     }
 }
 
-const TRANSLOCO_LANG = new InjectionToken('TRANSLOCO_LANG');
+const TRANSLOCO_LANG = new InjectionToken(ngDevMode ? 'TRANSLOCO_LANG' : '');
 
-const TRANSLOCO_LOADING_TEMPLATE = new InjectionToken('TRANSLOCO_LOADING_TEMPLATE');
+const TRANSLOCO_LOADING_TEMPLATE = new InjectionToken(ngDevMode ? 'TRANSLOCO_LOADING_TEMPLATE' : '');
 
-const TRANSLOCO_SCOPE = new InjectionToken('TRANSLOCO_SCOPE');
+const TRANSLOCO_SCOPE = new InjectionToken(ngDevMode ? 'TRANSLOCO_SCOPE' : '');
 
 class LangResolver {
     initialized = false;
@@ -1604,9 +1608,103 @@ function getBrowserCultureLang() {
     return navigator.languages?.[0] ?? navigator.language;
 }
 
+/**
+ * Gets the translated value of a key as Signal
+ *
+ * @example
+ * text = translateSignal('hello');
+ * textList = translateSignal(['green', 'blue']);
+ * textVar = translateSignal('hello', { variable: 'world' });
+ * textSpanish = translateSignal('hello', { variable: 'world' }, 'es');
+ * textTodosScope = translateSignal('hello', { variable: 'world' }, { scope: 'todos' });
+ *
+ * @example
+ * dynamicKey = signal('hello');
+ * dynamicParam = signal({ variable: 'world' });
+ * text = translateSignal(this.dynamicKey, this.dynamicParam);
+ *
+ */
+function translateSignal(key, params, lang, injector) {
+    if (!injector) {
+        assertInInjectionContext(translateSignal);
+    }
+    injector ??= inject(Injector);
+    const result = runInInjectionContext(injector, () => {
+        const service = inject(TranslocoService);
+        const scope = resolveScope(lang);
+        return toObservable(computerKeysAndParams(key, params)).pipe(switchMap((dynamic) => service.selectTranslate(dynamic.key, dynamic.params, scope)));
+    });
+    return toSignal(result, { initialValue: Array.isArray(key) ? [''] : '' });
+}
+/**
+ * Gets the translated object of a key as Signal
+ *
+ * @example
+ * object = translateObjectSignal('nested.object');
+ * title = object().title;
+ *
+ * @example
+ * dynamicKey = signal('nested.object');
+ * dynamicParam = signal({ variable: 'world' });
+ * object = translateObjectSignal(this.dynamicKey, this.dynamicParam);
+ */
+function translateObjectSignal(key, params, lang, injector) {
+    if (!injector) {
+        assertInInjectionContext(translateObjectSignal);
+    }
+    injector ??= inject(Injector);
+    const result = runInInjectionContext(injector, () => {
+        const service = inject(TranslocoService);
+        const scope = resolveScope(lang);
+        return toObservable(computerKeysAndParams(key, params)).pipe(switchMap((dynamic) => service.selectTranslateObject(dynamic.key, dynamic.params, scope)));
+    });
+    return toSignal(result, { initialValue: Array.isArray(key) ? [] : {} });
+}
+function computerParams(params) {
+    if (isSignal(params)) {
+        return computed(() => params());
+    }
+    return computed(() => {
+        return Object.entries(params).reduce((acc, [key, value]) => {
+            acc[key] = isSignal(value) ? value() : value;
+            return acc;
+        }, {});
+    });
+}
+function computerKeys(keys) {
+    if (Array.isArray(keys)) {
+        return computed(() => keys.map((key) => (isSignal(key) ? key() : key)));
+    }
+    return computed(() => keys());
+}
+function isSignalKey(key) {
+    return Array.isArray(key) ? key.some(isSignal) : isSignal(key);
+}
+function isSignalParams(params) {
+    return params
+        ? isSignal(params) || Object.values(params).some(isSignal)
+        : false;
+}
+function computerKeysAndParams(key, params) {
+    const computedKeys = isSignalKey(key)
+        ? computerKeys(key)
+        : computed(() => key);
+    const computedParams = isSignalParams(params)
+        ? computerParams(params)
+        : computed(() => params);
+    return computed(() => ({ key: computedKeys(), params: computedParams() }));
+}
+function resolveScope(scope) {
+    if (typeof scope === 'undefined' || scope === '') {
+        const translocoScope = inject(TRANSLOCO_SCOPE, { optional: true });
+        return translocoScope ?? undefined;
+    }
+    return scope;
+}
+
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { DefaultFallbackStrategy, DefaultInterceptor, DefaultMissingHandler, DefaultTranspiler, FunctionalTranspiler, TRANSLOCO_CONFIG, TRANSLOCO_FALLBACK_STRATEGY, TRANSLOCO_INTERCEPTOR, TRANSLOCO_LANG, TRANSLOCO_LOADER, TRANSLOCO_LOADING_TEMPLATE, TRANSLOCO_MISSING_HANDLER, TRANSLOCO_SCOPE, TRANSLOCO_TRANSPILER, TestingLoader, TranslocoDirective, TranslocoModule, TranslocoPipe, TranslocoService, TranslocoTestingModule, coerceArray, defaultConfig, flatten, getBrowserCultureLang, getBrowserLang, getFunctionArgs, getLangFromScope, getPipeValue, getScopeFromLang, getValue, hasInlineLoader, isBrowser, isDefined, isEmpty, isFunction, isNil, isNumber, isObject, isScopeObject, isString, provideTransloco, provideTranslocoConfig, provideTranslocoFallbackStrategy, provideTranslocoInterceptor, provideTranslocoLang, provideTranslocoLoader, provideTranslocoLoadingTpl, provideTranslocoMissingHandler, provideTranslocoScope, provideTranslocoTranspiler, setValue, size, toCamelCase, toNumber, translate, translateObject, translocoConfig, unflatten };
+export { DefaultFallbackStrategy, DefaultInterceptor, DefaultMissingHandler, DefaultTranspiler, FunctionalTranspiler, TRANSLOCO_CONFIG, TRANSLOCO_FALLBACK_STRATEGY, TRANSLOCO_INTERCEPTOR, TRANSLOCO_LANG, TRANSLOCO_LOADER, TRANSLOCO_LOADING_TEMPLATE, TRANSLOCO_MISSING_HANDLER, TRANSLOCO_SCOPE, TRANSLOCO_TRANSPILER, TestingLoader, TranslocoDirective, TranslocoModule, TranslocoPipe, TranslocoService, TranslocoTestingModule, coerceArray, defaultConfig, flatten, getBrowserCultureLang, getBrowserLang, getFunctionArgs, getLangFromScope, getPipeValue, getScopeFromLang, getValue, hasInlineLoader, isBrowser, isDefined, isEmpty, isFunction, isNil, isNumber, isObject, isScopeObject, isString, provideTransloco, provideTranslocoConfig, provideTranslocoFallbackStrategy, provideTranslocoInterceptor, provideTranslocoLang, provideTranslocoLoader, provideTranslocoLoadingTpl, provideTranslocoMissingHandler, provideTranslocoScope, provideTranslocoTranspiler, setValue, size, toCamelCase, toNumber, translate, translateObject, translateObjectSignal, translateSignal, translocoConfig, unflatten };
 //# sourceMappingURL=jsverse-transloco.mjs.map