@backstage/test-utils 1.7.8-next.0 → 1.7.8-next.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/test-utils
 
+## 1.7.8-next.1
+
+### Patch Changes
+
+- b573341: Added support for interpolating JSX elements with the `MockTranslationApi`.
+- Updated dependencies
+  - @backstage/core-app-api@1.16.2-next.0
+  - @backstage/core-plugin-api@1.10.7-next.0
+  - @backstage/config@1.3.2
+  - @backstage/plugin-permission-react@0.4.34-next.1
+  - @backstage/theme@0.6.6-next.0
+  - @backstage/types@1.2.1
+  - @backstage/plugin-permission-common@0.9.0-next.0
+
 ## 1.7.8-next.0
 
 ### Patch Changes

package/dist/core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.esm.js

@@ -0,0 +1,67 @@
+import 'i18next';
+import 'zen-observable';
+import '@backstage/core-plugin-api';
+import { isValidElement, createElement, Fragment } from 'react';
+
+class JsxInterpolator {
+  #setFormatHook;
+  #marker;
+  #pattern;
+  static fromI18n(i18n) {
+    const interpolator = i18n.services.interpolator;
+    const originalFormat = interpolator.format;
+    let formatHook;
+    interpolator.format = (value, format, lng, formatOpts) => {
+      if (format) {
+        return originalFormat(value, format, lng, formatOpts);
+      }
+      return formatHook?.(value, format, lng, formatOpts) ?? value;
+    };
+    return new JsxInterpolator(
+      // Using a random marker to ensure it can't be misused
+      Math.random().toString(36).substring(2, 8),
+      (hook) => {
+        formatHook = hook;
+      }
+    );
+  }
+  constructor(marker, setFormatHook) {
+    this.#setFormatHook = setFormatHook;
+    this.#marker = marker;
+    this.#pattern = new RegExp(`\\$${marker}\\(([^)]+)\\)`);
+  }
+  wrapT(originalT) {
+    return (key, options) => {
+      let elementsMap = void 0;
+      this.#setFormatHook((value) => {
+        if (isValidElement(value)) {
+          if (!elementsMap) {
+            elementsMap = /* @__PURE__ */ new Map();
+          }
+          const elementKey = elementsMap.size.toString();
+          elementsMap.set(elementKey, value);
+          return `$${this.#marker}(${elementKey})`;
+        }
+        return value;
+      });
+      const result = originalT(key, options);
+      if (!elementsMap) {
+        return result;
+      }
+      const split = result.split(this.#pattern);
+      return createElement(
+        Fragment,
+        null,
+        ...split.map((part, index) => {
+          if (index % 2 === 0) {
+            return part;
+          }
+          return elementsMap?.get(part);
+        }).filter(Boolean)
+      );
+    };
+  }
+}
+
+export { JsxInterpolator };
+//# sourceMappingURL=I18nextTranslationApi.esm.js.map

package/dist/core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"I18nextTranslationApi.esm.js","sources":["../../../../../../../core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  AppLanguageApi,\n  TranslationApi,\n  TranslationFunction,\n  TranslationMessages,\n  TranslationRef,\n  TranslationResource,\n  TranslationSnapshot,\n} from '@backstage/core-plugin-api/alpha';\nimport {\n  createInstance as createI18n,\n  FormatFunction,\n  Interpolator,\n  TFunction,\n  type i18n as I18n,\n} from 'i18next';\nimport ObservableImpl from 'zen-observable';\n\n// Internal import to avoid code duplication, this will lead to duplication in build output\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport {\n  toInternalTranslationResource,\n  InternalTranslationResourceLoader,\n} from '../../../../../core-plugin-api/src/translation/TranslationResource';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport {\n  toInternalTranslationRef,\n  InternalTranslationRef,\n} from '../../../../../core-plugin-api/src/translation/TranslationRef';\nimport { Observable } from '@backstage/types';\nimport { DEFAULT_LANGUAGE } from '../AppLanguageApi/AppLanguageSelector';\nimport { createElement, Fragment, ReactNode, isValidElement } from 'react';\n\n/** @alpha */\nexport interface I18nextTranslationApiOptions {\n  languageApi: AppLanguageApi;\n  resources?: Array<TranslationMessages | TranslationResource>;\n}\n\nfunction removeNulls(\n  messages: Record<string, string | null>,\n): Record<string, string> {\n  return Object.fromEntries(\n    Object.entries(messages).filter(\n      (e): e is [string, string] => e[1] !== null,\n    ),\n  );\n}\n\n/**\n * The built-in i18next backend loading logic doesn't handle on the fly switches\n * of language very well. It gets a bit confused about whether resources are actually\n * loaded or not, so instead we implement our own resource loader.\n */\nclass ResourceLoader {\n  /** Loaded resources by loader key */\n  #loaded = new Set<string>();\n  /** Resource loading promises by loader key */\n  #loading = new Map<string, Promise<void>>();\n  /** Loaders for each resource language */\n  #loaders = new Map<string, InternalTranslationResourceLoader>();\n\n  constructor(\n    private readonly onLoad: (loaded: {\n      language: string;\n      namespace: string;\n      messages: Record<string, string | null>;\n    }) => void,\n  ) {}\n\n  addTranslationResource(resource: TranslationResource) {\n    const internalResource = toInternalTranslationResource(resource);\n    for (const entry of internalResource.resources) {\n      const key = this.#getLoaderKey(entry.language, internalResource.id);\n\n      // First loader to register wins, this means that resources registered in the app\n      // have priority over default resource from translation refs\n      if (!this.#loaders.has(key)) {\n        this.#loaders.set(key, entry.loader);\n      }\n    }\n  }\n\n  #getLoaderKey(language: string, namespace: string) {\n    return `${language}/${namespace}`;\n  }\n\n  needsLoading(language: string, namespace: string) {\n    const key = this.#getLoaderKey(language, namespace);\n    const loader = this.#loaders.get(key);\n    if (!loader) {\n      return false;\n    }\n\n    return !this.#loaded.has(key);\n  }\n\n  async load(language: string, namespace: string): Promise<void> {\n    const key = this.#getLoaderKey(language, namespace);\n\n    const loader = this.#loaders.get(key);\n    if (!loader) {\n      return;\n    }\n\n    if (this.#loaded.has(key)) {\n      return;\n    }\n\n    const loading = this.#loading.get(key);\n    if (loading) {\n      await loading;\n      return;\n    }\n\n    const load = loader().then(\n      result => {\n        this.onLoad({ language, namespace, messages: result.messages });\n        this.#loaded.add(key);\n      },\n      error => {\n        this.#loaded.add(key); // Do not try to load failed resources again\n        throw error;\n      },\n    );\n    this.#loading.set(key, load);\n    await load;\n  }\n}\n\n/**\n * A helper for implementing JSX interpolation\n */\nexport class JsxInterpolator {\n  readonly #setFormatHook: (hook: FormatFunction) => void;\n  readonly #marker: string;\n  readonly #pattern: RegExp;\n\n  static fromI18n(i18n: I18n) {\n    const interpolator = i18n.services.interpolator as Interpolator & {\n      format: FormatFunction;\n    };\n    const originalFormat = interpolator.format;\n\n    let formatHook: FormatFunction | undefined;\n\n    // This is the only way to override the format function of the interpolator\n    // without overriding the default formatters. See the behavior here:\n    // https://github.com/i18next/i18next/blob/c633121e57e2b6024080142d78027842bf2a6e5e/src/i18next.js#L120-L125\n    interpolator.format = (value, format, lng, formatOpts) => {\n      if (format) {\n        return originalFormat(value, format, lng, formatOpts);\n      }\n      return formatHook?.(value, format, lng, formatOpts) ?? value;\n    };\n\n    return new JsxInterpolator(\n      // Using a random marker to ensure it can't be misused\n      Math.random().toString(36).substring(2, 8),\n      hook => {\n        formatHook = hook;\n      },\n    );\n  }\n\n  private constructor(\n    marker: string,\n    setFormatHook: (hook: FormatFunction) => void,\n  ) {\n    this.#setFormatHook = setFormatHook;\n    this.#marker = marker;\n    this.#pattern = new RegExp(`\\\\$${marker}\\\\(([^)]+)\\\\)`);\n  }\n\n  wrapT<TMessages extends { [key in string]: string }>(\n    originalT: TFunction,\n  ): TranslationFunction<TMessages> {\n    return ((key, options) => {\n      let elementsMap: Map<string, ReactNode> | undefined = undefined;\n\n      // There's no way to override the format hook via the translation function\n      // options, event though types indicate that it might be possible.\n      // Instead, override the format function hook before every invocation and\n      // rely on synchronous execution.\n      this.#setFormatHook(value => {\n        if (isValidElement(value)) {\n          if (!elementsMap) {\n            elementsMap = new Map();\n          }\n          const elementKey = elementsMap.size.toString();\n          elementsMap.set(elementKey, value);\n\n          return `$${this.#marker}(${elementKey})`;\n        }\n        return value;\n      });\n\n      // Overriding the return options is not allowed via TranslationFunction,\n      // so this will always be a string\n      const result = originalT(key, options as any) as unknown as string;\n      if (!elementsMap) {\n        return result;\n      }\n\n      const split = result.split(this.#pattern);\n\n      return createElement(\n        Fragment,\n        null,\n        ...split\n          .map((part, index) => {\n            if (index % 2 === 0) {\n              return part;\n            }\n            return elementsMap?.get(part);\n          })\n          .filter(Boolean),\n      );\n    }) as TranslationFunction<TMessages>;\n  }\n}\n\n/** @alpha */\nexport class I18nextTranslationApi implements TranslationApi {\n  static create(options: I18nextTranslationApiOptions) {\n    const { languages } = options.languageApi.getAvailableLanguages();\n\n    const i18n = createI18n({\n      fallbackLng: DEFAULT_LANGUAGE,\n      supportedLngs: languages,\n      interpolation: {\n        escapeValue: false,\n        // Used for the JsxInterpolator format hook\n        alwaysFormat: true,\n      },\n      ns: [],\n      defaultNS: false,\n      fallbackNS: false,\n\n      // Disable resource loading on init, meaning i18n will be ready to use immediately\n      initImmediate: false,\n    });\n\n    i18n.init();\n    if (!i18n.isInitialized) {\n      throw new Error('i18next was unexpectedly not initialized');\n    }\n\n    const interpolator = JsxInterpolator.fromI18n(i18n);\n\n    const { language: initialLanguage } = options.languageApi.getLanguage();\n    if (initialLanguage !== DEFAULT_LANGUAGE) {\n      i18n.changeLanguage(initialLanguage);\n    }\n\n    const loader = new ResourceLoader(loaded => {\n      i18n.addResourceBundle(\n        loaded.language,\n        loaded.namespace,\n        removeNulls(loaded.messages),\n        false, // do not merge with existing translations\n        true, // overwrite translations\n      );\n    });\n\n    const resources = options?.resources || [];\n    // Iterate in reverse, giving higher priority to resources registered later\n    for (let i = resources.length - 1; i >= 0; i--) {\n      const resource = resources[i];\n      if (resource.$$type === '@backstage/TranslationResource') {\n        loader.addTranslationResource(resource);\n      } else if (resource.$$type === '@backstage/TranslationMessages') {\n        // Overrides for default messages, created with createTranslationMessages and installed via app\n        i18n.addResourceBundle(\n          DEFAULT_LANGUAGE,\n          resource.id,\n          removeNulls(resource.messages),\n          true, // merge with existing translations\n          false, // do not overwrite translations\n        );\n      }\n    }\n\n    const instance = new I18nextTranslationApi(\n      i18n,\n      loader,\n      options.languageApi.getLanguage().language,\n      interpolator,\n    );\n\n    options.languageApi.language$().subscribe(({ language }) => {\n      instance.#changeLanguage(language);\n    });\n\n    return instance;\n  }\n\n  #i18n: I18n;\n  #loader: ResourceLoader;\n  #language: string;\n  #jsxInterpolator: JsxInterpolator;\n\n  /** Keep track of which refs we have registered default resources for */\n  #registeredRefs = new Set<string>();\n  /** Notify observers when language changes */\n  #languageChangeListeners = new Set<() => void>();\n\n  private constructor(\n    i18n: I18n,\n    loader: ResourceLoader,\n    language: string,\n    jsxInterpolator: JsxInterpolator,\n  ) {\n    this.#i18n = i18n;\n    this.#loader = loader;\n    this.#language = language;\n    this.#jsxInterpolator = jsxInterpolator;\n  }\n\n  getTranslation<TMessages extends { [key in string]: string }>(\n    translationRef: TranslationRef<string, TMessages>,\n  ): TranslationSnapshot<TMessages> {\n    const internalRef = toInternalTranslationRef(translationRef);\n\n    this.#registerDefaults(internalRef);\n\n    return this.#createSnapshot(internalRef);\n  }\n\n  translation$<TMessages extends { [key in string]: string }>(\n    translationRef: TranslationRef<string, TMessages>,\n  ): Observable<TranslationSnapshot<TMessages>> {\n    const internalRef = toInternalTranslationRef(translationRef);\n\n    this.#registerDefaults(internalRef);\n\n    return new ObservableImpl<TranslationSnapshot<TMessages>>(subscriber => {\n      let loadTicket = {}; // To check for stale loads\n\n      const loadResource = () => {\n        loadTicket = {};\n        const ticket = loadTicket;\n        this.#loader.load(this.#language, internalRef.id).then(\n          () => {\n            if (ticket === loadTicket) {\n              const snapshot = this.#createSnapshot(internalRef);\n              if (snapshot.ready) {\n                subscriber.next(snapshot);\n              }\n            }\n          },\n          error => {\n            if (ticket === loadTicket) {\n              subscriber.error(Array.isArray(error) ? error[0] : error);\n            }\n          },\n        );\n      };\n\n      const onChange = () => {\n        const snapshot = this.#createSnapshot(internalRef);\n        if (snapshot.ready) {\n          subscriber.next(snapshot);\n        } else {\n          loadResource();\n        }\n      };\n\n      if (this.#loader.needsLoading(this.#language, internalRef.id)) {\n        loadResource();\n      }\n\n      this.#languageChangeListeners.add(onChange);\n      return () => {\n        this.#languageChangeListeners.delete(onChange);\n      };\n    });\n  }\n\n  #changeLanguage(language: string): void {\n    if (this.#language !== language) {\n      this.#language = language;\n      this.#i18n.changeLanguage(language);\n      this.#languageChangeListeners.forEach(listener => listener());\n    }\n  }\n\n  #createSnapshot<TMessages extends { [key in string]: string }>(\n    internalRef: InternalTranslationRef<string, TMessages>,\n  ): TranslationSnapshot<TMessages> {\n    if (this.#loader.needsLoading(this.#language, internalRef.id)) {\n      return { ready: false };\n    }\n\n    const unwrappedT = this.#i18n.getFixedT(null, internalRef.id);\n    const t = this.#jsxInterpolator.wrapT<TMessages>(unwrappedT);\n\n    return {\n      ready: true,\n      t,\n    };\n  }\n\n  #registerDefaults(internalRef: InternalTranslationRef): void {\n    if (this.#registeredRefs.has(internalRef.id)) {\n      return;\n    }\n    this.#registeredRefs.add(internalRef.id);\n\n    const defaultMessages = internalRef.getDefaultMessages();\n    this.#i18n.addResourceBundle(\n      DEFAULT_LANGUAGE,\n      internalRef.id,\n      defaultMessages,\n      true, // merge with existing translations\n      false, // do not overwrite translations\n    );\n\n    const defaultResource = internalRef.getDefaultResource();\n    if (defaultResource) {\n      this.#loader.addTranslationResource(defaultResource);\n    }\n  }\n}\n"],"names":[],"mappings":";;;;;AAqJO,MAAM,eAAgB,CAAA;AAAA,EAClB,cAAA;AAAA,EACA,OAAA;AAAA,EACA,QAAA;AAAA,EAET,OAAO,SAAS,IAAY,EAAA;AAC1B,IAAM,MAAA,YAAA,GAAe,KAAK,QAAS,CAAA,YAAA;AAGnC,IAAA,MAAM,iBAAiB,YAAa,CAAA,MAAA;AAEpC,IAAI,IAAA,UAAA;AAKJ,IAAA,YAAA,CAAa,MAAS,GAAA,CAAC,KAAO,EAAA,MAAA,EAAQ,KAAK,UAAe,KAAA;AACxD,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,OAAO,cAAe,CAAA,KAAA,EAAO,MAAQ,EAAA,GAAA,EAAK,UAAU,CAAA;AAAA;AAEtD,MAAA,OAAO,UAAa,GAAA,KAAA,EAAO,MAAQ,EAAA,GAAA,EAAK,UAAU,CAAK,IAAA,KAAA;AAAA,KACzD;AAEA,IAAA,OAAO,IAAI,eAAA;AAAA;AAAA,MAET,IAAA,CAAK,QAAS,CAAA,QAAA,CAAS,EAAE,CAAE,CAAA,SAAA,CAAU,GAAG,CAAC,CAAA;AAAA,MACzC,CAAQ,IAAA,KAAA;AACN,QAAa,UAAA,GAAA,IAAA;AAAA;AACf,KACF;AAAA;AACF,EAEQ,WAAA,CACN,QACA,aACA,EAAA;AACA,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA;AACtB,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA;AACf,IAAA,IAAA,CAAK,QAAW,GAAA,IAAI,MAAO,CAAA,CAAA,GAAA,EAAM,MAAM,CAAe,aAAA,CAAA,CAAA;AAAA;AACxD,EAEA,MACE,SACgC,EAAA;AAChC,IAAQ,OAAA,CAAC,KAAK,OAAY,KAAA;AACxB,MAAA,IAAI,WAAkD,GAAA,KAAA,CAAA;AAMtD,MAAA,IAAA,CAAK,eAAe,CAAS,KAAA,KAAA;AAC3B,QAAI,IAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AACzB,UAAA,IAAI,CAAC,WAAa,EAAA;AAChB,YAAA,WAAA,uBAAkB,GAAI,EAAA;AAAA;AAExB,UAAM,MAAA,UAAA,GAAa,WAAY,CAAA,IAAA,CAAK,QAAS,EAAA;AAC7C,UAAY,WAAA,CAAA,GAAA,CAAI,YAAY,KAAK,CAAA;AAEjC,UAAA,OAAO,CAAI,CAAA,EAAA,IAAA,CAAK,OAAO,CAAA,CAAA,EAAI,UAAU,CAAA,CAAA,CAAA;AAAA;AAEvC,QAAO,OAAA,KAAA;AAAA,OACR,CAAA;AAID,MAAM,MAAA,MAAA,GAAS,SAAU,CAAA,GAAA,EAAK,OAAc,CAAA;AAC5C,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAO,OAAA,MAAA;AAAA;AAGT,MAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,KAAM,CAAA,IAAA,CAAK,QAAQ,CAAA;AAExC,MAAO,OAAA,aAAA;AAAA,QACL,QAAA;AAAA,QACA,IAAA;AAAA,QACA,GAAG,KAAA,CACA,GAAI,CAAA,CAAC,MAAM,KAAU,KAAA;AACpB,UAAI,IAAA,KAAA,GAAQ,MAAM,CAAG,EAAA;AACnB,YAAO,OAAA,IAAA;AAAA;AAET,UAAO,OAAA,WAAA,EAAa,IAAI,IAAI,CAAA;AAAA,SAC7B,CACA,CAAA,MAAA,CAAO,OAAO;AAAA,OACnB;AAAA,KACF;AAAA;AAEJ;;;;"}

package/dist/testUtils/apis/TranslationApi/MockTranslationApi.esm.js

@@ -1,6 +1,7 @@
 import { createInstance } from 'i18next';
 import ObservableImpl from 'zen-observable';
 import { toInternalTranslationRef } from '../../../core-plugin-api/src/translation/TranslationRef.esm.js';
+import { JsxInterpolator } from '../../../core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.esm.js';
 
 const DEFAULT_LANGUAGE = "en";
 class MockTranslationApi {
@@ -9,7 +10,9 @@ class MockTranslationApi {
       fallbackLng: DEFAULT_LANGUAGE,
       supportedLngs: [DEFAULT_LANGUAGE],
       interpolation: {
-        escapeValue: false
+        escapeValue: false,
+        // Used for the JsxInterpolator format hook
+        alwaysFormat: true
       },
       ns: [],
       defaultNS: false,
@@ -21,12 +24,15 @@ class MockTranslationApi {
     if (!i18n.isInitialized) {
       throw new Error("i18next was unexpectedly not initialized");
     }
-    return new MockTranslationApi(i18n);
+    const interpolator = JsxInterpolator.fromI18n(i18n);
+    return new MockTranslationApi(i18n, interpolator);
   }
   #i18n;
+  #interpolator;
   #registeredRefs = /* @__PURE__ */ new Set();
-  constructor(i18n) {
+  constructor(i18n, interpolator) {
     this.#i18n = i18n;
+    this.#interpolator = interpolator;
   }
   getTranslation(translationRef) {
     const internalRef = toInternalTranslationRef(translationRef);
@@ -42,9 +48,8 @@ class MockTranslationApi {
         // overwrite existing
       );
     }
-    const t = this.#i18n.getFixedT(
-      null,
-      internalRef.id
+    const t = this.#interpolator.wrapT(
+      this.#i18n.getFixedT(null, internalRef.id)
     );
     return {
       ready: true,

package/dist/testUtils/apis/TranslationApi/MockTranslationApi.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"MockTranslationApi.esm.js","sources":["../../../../src/testUtils/apis/TranslationApi/MockTranslationApi.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  TranslationApi,\n  TranslationFunction,\n  TranslationRef,\n  TranslationSnapshot,\n} from '@backstage/core-plugin-api/alpha';\nimport { createInstance as createI18n, type i18n as I18n } from 'i18next';\nimport ObservableImpl from 'zen-observable';\n\nimport { Observable } from '@backstage/types';\n// Internal import to avoid code duplication, this will lead to duplication in build output\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalTranslationRef } from '../../../../../core-plugin-api/src/translation/TranslationRef';\n\nconst DEFAULT_LANGUAGE = 'en';\n\n/**\n * @alpha\n * @deprecated Use `mockApis` from `@backstage/test-utils` instead\n */\nexport class MockTranslationApi implements TranslationApi {\n  static create() {\n    const i18n = createI18n({\n      fallbackLng: DEFAULT_LANGUAGE,\n      supportedLngs: [DEFAULT_LANGUAGE],\n      interpolation: {\n        escapeValue: false,\n      },\n      ns: [],\n      defaultNS: false,\n      fallbackNS: false,\n\n      // Disable resource loading on init, meaning i18n will be ready to use immediately\n      initImmediate: false,\n    });\n\n    i18n.init();\n    if (!i18n.isInitialized) {\n      throw new Error('i18next was unexpectedly not initialized');\n    }\n\n    return new MockTranslationApi(i18n);\n  }\n\n  #i18n: I18n;\n  #registeredRefs = new Set<string>();\n\n  private constructor(i18n: I18n) {\n    this.#i18n = i18n;\n  }\n\n  getTranslation<TMessages extends { [key in string]: string }>(\n    translationRef: TranslationRef<string, TMessages>,\n  ): TranslationSnapshot<TMessages> {\n    const internalRef = toInternalTranslationRef(translationRef);\n\n    if (!this.#registeredRefs.has(internalRef.id)) {\n      this.#registeredRefs.add(internalRef.id);\n      this.#i18n.addResourceBundle(\n        DEFAULT_LANGUAGE,\n        internalRef.id,\n        internalRef.getDefaultMessages(),\n        false, // do not merge\n        true, // overwrite existing\n      );\n    }\n\n    const t = this.#i18n.getFixedT(\n      null,\n      internalRef.id,\n    ) as TranslationFunction<TMessages>;\n\n    return {\n      ready: true,\n      t,\n    };\n  }\n\n  translation$<TMessages extends { [key in string]: string }>(): Observable<\n    TranslationSnapshot<TMessages>\n  > {\n    // No need to implement, getTranslation will always return a ready snapshot\n    return new ObservableImpl<TranslationSnapshot<TMessages>>(_subscriber => {\n      return () => {};\n    });\n  }\n}\n"],"names":["createI18n"],"mappings":";;;;AA8BA,MAAM,gBAAmB,GAAA,IAAA;AAMlB,MAAM,kBAA6C,CAAA;AAAA,EACxD,OAAO,MAAS,GAAA;AACd,IAAA,MAAM,OAAOA,cAAW,CAAA;AAAA,MACtB,WAAa,EAAA,gBAAA;AAAA,MACb,aAAA,EAAe,CAAC,gBAAgB,CAAA;AAAA,MAChC,aAAe,EAAA;AAAA,QACb,WAAa,EAAA;AAAA,OACf;AAAA,MACA,IAAI,EAAC;AAAA,MACL,SAAW,EAAA,KAAA;AAAA,MACX,UAAY,EAAA,KAAA;AAAA;AAAA,MAGZ,aAAe,EAAA;AAAA,KAChB,CAAA;AAED,IAAA,IAAA,CAAK,IAAK,EAAA;AACV,IAAI,IAAA,CAAC,KAAK,aAAe,EAAA;AACvB,MAAM,MAAA,IAAI,MAAM,0CAA0C,CAAA;AAAA;AAG5D,IAAO,OAAA,IAAI,mBAAmB,IAAI,CAAA;AAAA;AACpC,EAEA,KAAA;AAAA,EACA,eAAA,uBAAsB,GAAY,EAAA;AAAA,EAE1B,YAAY,IAAY,EAAA;AAC9B,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAA;AAAA;AACf,EAEA,eACE,cACgC,EAAA;AAChC,IAAM,MAAA,WAAA,GAAc,yBAAyB,cAAc,CAAA;AAE3D,IAAA,IAAI,CAAC,IAAK,CAAA,eAAA,CAAgB,GAAI,CAAA,WAAA,CAAY,EAAE,CAAG,EAAA;AAC7C,MAAK,IAAA,CAAA,eAAA,CAAgB,GAAI,CAAA,WAAA,CAAY,EAAE,CAAA;AACvC,MAAA,IAAA,CAAK,KAAM,CAAA,iBAAA;AAAA,QACT,gBAAA;AAAA,QACA,WAAY,CAAA,EAAA;AAAA,QACZ,YAAY,kBAAmB,EAAA;AAAA,QAC/B,KAAA;AAAA;AAAA,QACA;AAAA;AAAA,OACF;AAAA;AAGF,IAAM,MAAA,CAAA,GAAI,KAAK,KAAM,CAAA,SAAA;AAAA,MACnB,IAAA;AAAA,MACA,WAAY,CAAA;AAAA,KACd;AAEA,IAAO,OAAA;AAAA,MACL,KAAO,EAAA,IAAA;AAAA,MACP;AAAA,KACF;AAAA;AACF,EAEA,YAEE,GAAA;AAEA,IAAO,OAAA,IAAI,eAA+C,CAAe,WAAA,KAAA;AACvE,MAAA,OAAO,MAAM;AAAA,OAAC;AAAA,KACf,CAAA;AAAA;AAEL;;;;"}
+{"version":3,"file":"MockTranslationApi.esm.js","sources":["../../../../src/testUtils/apis/TranslationApi/MockTranslationApi.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  TranslationApi,\n  TranslationRef,\n  TranslationSnapshot,\n} from '@backstage/core-plugin-api/alpha';\nimport { createInstance as createI18n, type i18n as I18n } from 'i18next';\nimport ObservableImpl from 'zen-observable';\n\nimport { Observable } from '@backstage/types';\n// Internal import to avoid code duplication, this will lead to duplication in build output\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalTranslationRef } from '../../../../../core-plugin-api/src/translation/TranslationRef';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { JsxInterpolator } from '../../../../../core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi';\n\nconst DEFAULT_LANGUAGE = 'en';\n\n/**\n * @alpha\n * @deprecated Use `mockApis` from `@backstage/test-utils` instead\n */\nexport class MockTranslationApi implements TranslationApi {\n  static create() {\n    const i18n = createI18n({\n      fallbackLng: DEFAULT_LANGUAGE,\n      supportedLngs: [DEFAULT_LANGUAGE],\n      interpolation: {\n        escapeValue: false,\n        // Used for the JsxInterpolator format hook\n        alwaysFormat: true,\n      },\n      ns: [],\n      defaultNS: false,\n      fallbackNS: false,\n\n      // Disable resource loading on init, meaning i18n will be ready to use immediately\n      initImmediate: false,\n    });\n\n    i18n.init();\n    if (!i18n.isInitialized) {\n      throw new Error('i18next was unexpectedly not initialized');\n    }\n\n    const interpolator = JsxInterpolator.fromI18n(i18n);\n\n    return new MockTranslationApi(i18n, interpolator);\n  }\n\n  #i18n: I18n;\n  #interpolator: JsxInterpolator;\n  #registeredRefs = new Set<string>();\n\n  private constructor(i18n: I18n, interpolator: JsxInterpolator) {\n    this.#i18n = i18n;\n    this.#interpolator = interpolator;\n  }\n\n  getTranslation<TMessages extends { [key in string]: string }>(\n    translationRef: TranslationRef<string, TMessages>,\n  ): TranslationSnapshot<TMessages> {\n    const internalRef = toInternalTranslationRef(translationRef);\n\n    if (!this.#registeredRefs.has(internalRef.id)) {\n      this.#registeredRefs.add(internalRef.id);\n      this.#i18n.addResourceBundle(\n        DEFAULT_LANGUAGE,\n        internalRef.id,\n        internalRef.getDefaultMessages(),\n        false, // do not merge\n        true, // overwrite existing\n      );\n    }\n\n    const t = this.#interpolator.wrapT<TMessages>(\n      this.#i18n.getFixedT(null, internalRef.id),\n    );\n\n    return {\n      ready: true,\n      t,\n    };\n  }\n\n  translation$<TMessages extends { [key in string]: string }>(): Observable<\n    TranslationSnapshot<TMessages>\n  > {\n    // No need to implement, getTranslation will always return a ready snapshot\n    return new ObservableImpl<TranslationSnapshot<TMessages>>(_subscriber => {\n      return () => {};\n    });\n  }\n}\n"],"names":["createI18n"],"mappings":";;;;;AA+BA,MAAM,gBAAmB,GAAA,IAAA;AAMlB,MAAM,kBAA6C,CAAA;AAAA,EACxD,OAAO,MAAS,GAAA;AACd,IAAA,MAAM,OAAOA,cAAW,CAAA;AAAA,MACtB,WAAa,EAAA,gBAAA;AAAA,MACb,aAAA,EAAe,CAAC,gBAAgB,CAAA;AAAA,MAChC,aAAe,EAAA;AAAA,QACb,WAAa,EAAA,KAAA;AAAA;AAAA,QAEb,YAAc,EAAA;AAAA,OAChB;AAAA,MACA,IAAI,EAAC;AAAA,MACL,SAAW,EAAA,KAAA;AAAA,MACX,UAAY,EAAA,KAAA;AAAA;AAAA,MAGZ,aAAe,EAAA;AAAA,KAChB,CAAA;AAED,IAAA,IAAA,CAAK,IAAK,EAAA;AACV,IAAI,IAAA,CAAC,KAAK,aAAe,EAAA;AACvB,MAAM,MAAA,IAAI,MAAM,0CAA0C,CAAA;AAAA;AAG5D,IAAM,MAAA,YAAA,GAAe,eAAgB,CAAA,QAAA,CAAS,IAAI,CAAA;AAElD,IAAO,OAAA,IAAI,kBAAmB,CAAA,IAAA,EAAM,YAAY,CAAA;AAAA;AAClD,EAEA,KAAA;AAAA,EACA,aAAA;AAAA,EACA,eAAA,uBAAsB,GAAY,EAAA;AAAA,EAE1B,WAAA,CAAY,MAAY,YAA+B,EAAA;AAC7D,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAA;AACb,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA;AAAA;AACvB,EAEA,eACE,cACgC,EAAA;AAChC,IAAM,MAAA,WAAA,GAAc,yBAAyB,cAAc,CAAA;AAE3D,IAAA,IAAI,CAAC,IAAK,CAAA,eAAA,CAAgB,GAAI,CAAA,WAAA,CAAY,EAAE,CAAG,EAAA;AAC7C,MAAK,IAAA,CAAA,eAAA,CAAgB,GAAI,CAAA,WAAA,CAAY,EAAE,CAAA;AACvC,MAAA,IAAA,CAAK,KAAM,CAAA,iBAAA;AAAA,QACT,gBAAA;AAAA,QACA,WAAY,CAAA,EAAA;AAAA,QACZ,YAAY,kBAAmB,EAAA;AAAA,QAC/B,KAAA;AAAA;AAAA,QACA;AAAA;AAAA,OACF;AAAA;AAGF,IAAM,MAAA,CAAA,GAAI,KAAK,aAAc,CAAA,KAAA;AAAA,MAC3B,IAAK,CAAA,KAAA,CAAM,SAAU,CAAA,IAAA,EAAM,YAAY,EAAE;AAAA,KAC3C;AAEA,IAAO,OAAA;AAAA,MACL,KAAO,EAAA,IAAA;AAAA,MACP;AAAA,KACF;AAAA;AACF,EAEA,YAEE,GAAA;AAEA,IAAO,OAAA,IAAI,eAA+C,CAAe,WAAA,KAAA;AACvE,MAAA,OAAO,MAAM;AAAA,OAAC;AAAA,KACf,CAAA;AAAA;AAEL;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/test-utils",
-  "version": "1.7.8-next.0",
+  "version": "1.7.8-next.1",
   "description": "Utilities to test Backstage plugins and apps.",
   "backstage": {
     "role": "web-library"
@@ -58,10 +58,10 @@
   },
   "dependencies": {
     "@backstage/config": "1.3.2",
-    "@backstage/core-app-api": "1.16.1",
-    "@backstage/core-plugin-api": "1.10.6",
+    "@backstage/core-app-api": "1.16.2-next.0",
+    "@backstage/core-plugin-api": "1.10.7-next.0",
     "@backstage/plugin-permission-common": "0.9.0-next.0",
-    "@backstage/plugin-permission-react": "0.4.34-next.0",
+    "@backstage/plugin-permission-react": "0.4.34-next.1",
     "@backstage/theme": "0.6.6-next.0",
     "@backstage/types": "1.2.1",
     "@material-ui/core": "^4.12.2",
@@ -71,7 +71,7 @@
     "zen-observable": "^0.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.32.1-next.1",
+    "@backstage/cli": "0.32.1-next.2",
     "@testing-library/jest-dom": "^6.0.0",
     "@types/jest": "*",
     "@types/react": "^18.0.0",