feat: 🎸 add scope to event payload

Author: NetanelBasal

projects/ngneat/transloco/src/lib/shared.ts

@@ -74,3 +74,11 @@ function prependScope(inlineLoader, scope) {
 export function resolveInlineLoader(providerScope: TranslocoScope | null, scope: string): InlineLoader | null {
   return hasInlineLoader(providerScope) ? prependScope(providerScope.loader, scope) : null;
 }
+
+export function getEventPayload(lang: string) {
+  return {
+    scope: getScopeFromLang(lang) || null,
+    langName: getLangFromScope(lang),
+    lang
+  };
+}

projects/ngneat/transloco/src/lib/tests/service/load.spec.ts

@@ -17,7 +17,19 @@ describe('load', () => {
       )
       .subscribe(spy);
     loadLang(service);
-    expect(spy).toHaveBeenCalledWith({ lang: 'en' });
+    expect(spy).toHaveBeenCalledWith({ lang: 'en', langName: 'en', scope: null });
+  }));
+
+  it('should trigger loaded event once loaded - scope', fakeAsync(() => {
+    const spy = jasmine.createSpy();
+    service.events$
+      .pipe(
+        filter((e: any) => e.type === 'translationLoadSuccess'),
+        pluck('payload')
+      )
+      .subscribe(spy);
+    loadLang(service, 'admin-page/en');
+    expect(spy).toHaveBeenCalledWith({ lang: 'admin-page/en', langName: 'en', scope: 'admin-page' });
   }));
 
   it('should load the translation using the loader', fakeAsync(() => {

projects/ngneat/transloco/src/lib/transloco.service.ts

@@ -19,7 +19,7 @@ import { TRANSLOCO_MISSING_HANDLER, TranslocoMissingHandler } from './transloco-
 import { TRANSLOCO_INTERCEPTOR, TranslocoInterceptor } from './transloco.interceptor';
 import { TRANSLOCO_FALLBACK_STRATEGY, TranslocoFallbackStrategy } from './transloco-fallback-strategy';
 import { mergeConfig } from './merge-config';
-import { getLangFromScope, getScopeFromLang } from './shared';
+import { getEventPayload, getLangFromScope, getScopeFromLang } from './shared';
 import { getFallbacksLoaders } from './get-fallbacks-loaders';
 import { resolveLoader } from './resolve-loader';
 
@@ -196,7 +196,7 @@ export class TranslocoService implements OnDestroy {
     const value = translation[key];
 
     if (!value) {
-      return this.handleMissingKey(key, value, params);
+      return this._handleMissingKey(key, value, params);
     }
 
     return this.parser.transpile(value, params, translation);
@@ -336,7 +336,10 @@ export class TranslocoService implements OnDestroy {
     this.setTranslation(newValue, lang);
   }
 
-  handleMissingKey(key: string, value: any, params?: HashMap) {
+  /**
+   * @internal
+   */
+  _handleMissingKey(key: string, value: any, params?: HashMap) {
     if (this.config.missingHandler.allowEmpty && value === '') {
       return '';
     }
@@ -425,9 +428,7 @@ export class TranslocoService implements OnDestroy {
       this.events.next({
         wasFailure: !!this.failedLangs.size,
         type: 'translationLoadSuccess',
-        payload: {
-          lang
-        }
+        payload: getEventPayload(lang)
       });
 
       this.failedCounter = 0;
@@ -467,9 +468,7 @@ export class TranslocoService implements OnDestroy {
     this.failedCounter++;
     this.events.next({
       type: 'translationLoadFailure',
-      payload: {
-        lang
-      }
+      payload: getEventPayload(lang)
     });
 
     return this.load(resolveLang);

projects/ngneat/transloco/src/lib/types.ts

@@ -1,20 +1,19 @@
-import { Observable } from 'rxjs';
-
 export type HashMap<T = any> = { [key: string]: T };
 
 export type LoadedEvent = {
   type: 'translationLoadSuccess';
   wasFailure: boolean;
   payload: {
+    scope: string | null;
+    langName: string;
+    /** @deprecated */
     lang: string;
   };
 };
 
 export type FailedEvent = {
   type: 'translationLoadFailure';
-  payload: {
-    lang: string;
-  };
+  payload: LoadedEvent['payload'];
 };
 
 export type TranslocoEvents = LoadedEvent | FailedEvent;