core-app-api: rename AppTranslationApi to I18nextTranslationApi + initial updates

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.test.ts

@@ -18,12 +18,10 @@ import {
   createTranslationMessages,
   createTranslationRef,
   createTranslationResource,
+  TranslationSnapshot,
 } from '@backstage/core-plugin-api/alpha';
 import { Observable } from '@backstage/types';
-import {
-  AppTranslationApiImpl,
-  TranslationSnapshot,
-} from './AppTranslationImpl';
+import { I18nextTranslationApi } from './I18nextTranslationApi';
 
 const plainRef = createTranslationRef({
   id: 'plain',
@@ -74,13 +72,13 @@ function assertReady<TMessages extends { [key in string]: string }>(
   return snapshot;
 }
 
-describe('AppTranslationApiImpl', () => {
+describe('I18nextTranslationApi', () => {
   afterEach(() => {
     jest.clearAllMocks();
   });
 
   it('should get a translation snapshot', () => {
-    const translationApi = AppTranslationApiImpl.create();
+    const translationApi = I18nextTranslationApi.create();
     expect(translationApi.getAvailableLanguages()).toEqual(['en']);
 
     const snapshot = assertReady(translationApi.getTranslation(plainRef));
@@ -88,7 +86,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should get a translation snapshot for ref with translations', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       supportedLanguages: ['en', 'sv'],
     });
     expect(translationApi.getAvailableLanguages()).toEqual(['en', 'sv']);
@@ -99,7 +97,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should wait for translations to be loaded', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       supportedLanguages: ['en', 'sv'],
     });
     expect(translationApi.getTranslation(resourceRef).ready).toBe(true);
@@ -113,7 +111,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should create an instance with message overrides', () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       resources: [
         createTranslationMessages({
           ref: plainRef,
@@ -126,7 +124,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should create an instance and ignore null overrides', () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       resources: [
         createTranslationMessages({
           ref: plainRef,
@@ -140,7 +138,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should create an instance with translation resources', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       supportedLanguages: ['en', 'sv'],
       resources: [
         createTranslationResource({
@@ -163,7 +161,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should wait for default language translations to be loaded', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       resources: [
         createTranslationResource({
           ref: plainRef,
@@ -181,7 +179,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should prefer the last loaded resource', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       supportedLanguages: ['en', 'sv'],
       resources: [
         createTranslationResource({
@@ -216,7 +214,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should refuse switch on unsupported languages', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       supportedLanguages: ['en', 'sv'],
     });
     expect(translationApi.getAvailableLanguages()).toEqual(['en', 'sv']);
@@ -227,7 +225,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should forward loading errors', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       resources: [
         createTranslationResource({
           ref: plainRef,
@@ -245,7 +243,7 @@ describe('AppTranslationApiImpl', () => {
     const loader = jest
       .fn()
       .mockResolvedValue({ default: { foo: 'OtherFoo' } });
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       resources: [
         createTranslationResource({
           ref: plainRef,
@@ -270,7 +268,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should handle interrupted loads gracefully', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       supportedLanguages: ['en', 'sv', 'no'],
       resources: [
         createTranslationResource({
@@ -299,7 +297,7 @@ describe('AppTranslationApiImpl', () => {
   });
 
   it('should only emit changes', async () => {
-    const translationApi = AppTranslationApiImpl.create({
+    const translationApi = I18nextTranslationApi.create({
       supportedLanguages: ['en', 'dk', 'sv', 'no'],
       resources: [
         createTranslationResource({

packages/core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.ts

@@ -15,10 +15,11 @@
  */
 
 import {
-  AppTranslationApi,
+  TranslationApi,
   TranslationMessages,
   TranslationRef,
   TranslationResource,
+  TranslationSnapshot,
 } from '@backstage/core-plugin-api/alpha';
 import { createInstance as createI18n, type i18n as I18n } from 'i18next';
 import ObservableImpl from 'zen-observable';
@@ -137,7 +138,7 @@ class ResourceLoader {
 }
 
 /** @alpha */
-export class AppTranslationApiImpl implements AppTranslationApi {
+export class I18nextTranslationApi implements TranslationApi {
   static create(options?: ExperimentalI18n) {
     const languages = options?.supportedLanguages || [DEFAULT_LANGUAGE];
     if (!languages.includes(DEFAULT_LANGUAGE)) {
@@ -184,7 +185,7 @@ export class AppTranslationApiImpl implements AppTranslationApi {
       }
     }
 
-    return new AppTranslationApiImpl(i18n, loader, languages);
+    return new I18nextTranslationApi(i18n, loader, languages);
   }
 
   #i18n: I18n;

packages/core-app-api/src/apis/implementations/TranslationApi/index.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export * from './AppTranslationImpl';
+export * from './I18nextTranslationApi';