@backstage/core-plugin-api 1.6.0-next.3 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/core-plugin-api
 
+## 1.6.0
+
+### Minor Changes
+
+- 18619f793c94: Added the optional `expiresAt` field that may now be part of a `BackstageIdentityResponse`.
+- 6e30769cc627: Introduced experimental support for internationalization.
+
+### Patch Changes
+
+- 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
+- 8cec7664e146: Removed `@types/node` dependency
+- Updated dependencies
+  - @backstage/config@1.1.0
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.5
+
 ## 1.6.0-next.3
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/core-plugin-api",
-  "version": "1.6.0-next.3",
+  "version": "1.6.0",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/alpha.d.ts

@@ -1,6 +1,7 @@
 import { BackstagePlugin, ApiRef } from '@backstage/core-plugin-api';
 import { ReactNode } from 'react';
-import { i18n } from 'i18next';
+import { TranslationRef as TranslationRef$1, TranslationMessages as TranslationMessages$1 } from '@backstage/core-plugin-api/alpha';
+import { Observable } from '@backstage/types';
 
 /**
  * Properties for the PluginProvider component.
@@ -25,54 +26,393 @@ declare const PluginProvider: (props: PluginOptionsProviderProps) => JSX.Element
  */
 declare function usePluginOptions<TPluginOptions extends {} = {}>(): TPluginOptions;
 
+/**
+ * Represents a collection of messages to be provided for a given translation ref.
+ *
+ * @alpha
+ * @remarks
+ *
+ * This collection of messages can either be used directly as an override for the
+ * default messages, or it can be used to provide translations for a language by
+ * by being referenced by a {@link TranslationResource}.
+ */
+interface TranslationMessages<TId extends string = string, TMessages extends {
+    [key in string]: string;
+} = {
+    [key in string]: string;
+}, TFull extends boolean = boolean> {
+    $$type: '@backstage/TranslationMessages';
+    /** The ID of the translation ref that these messages are for */
+    id: TId;
+    /** Whether or not these messages override all known messages */
+    full: TFull;
+    /** The messages provided for the given translation ref */
+    messages: TMessages;
+}
+/**
+ * Options for {@link createTranslationMessages}.
+ *
+ * @alpha
+ */
+interface TranslationMessagesOptions<TId extends string, TMessages extends {
+    [key in string]: string;
+}, TFull extends boolean> {
+    ref: TranslationRef$1<TId, TMessages>;
+    full?: TFull;
+    messages: false extends TFull ? {
+        [key in keyof TMessages]?: string | null;
+    } : {
+        [key in keyof TMessages]: string | null;
+    };
+}
+/**
+ * Creates a collection of messages for a given translation ref.
+ *
+ * @alpha
+ */
+declare function createTranslationMessages<TId extends string, TMessages extends {
+    [key in string]: string;
+}, TFull extends boolean>(options: TranslationMessagesOptions<TId, TMessages, TFull>): TranslationMessages<TId, TMessages, TFull>;
+
 /** @alpha */
-interface TranslationRefConfig<Messages extends Record<keyof Messages, string>> {
-    id: string;
-    messages: Messages;
-    lazyResources?: Record<string, () => Promise<{
-        messages: Messages;
-    }>>;
-    resources?: Record<string, Messages>;
+interface TranslationResource<TId extends string = string> {
+    $$type: '@backstage/TranslationResource';
+    id: TId;
 }
 /** @alpha */
-interface TranslationRef<Messages extends Record<keyof Messages, string> = Record<string, string>> {
-    getId(): string;
-    getDefaultMessages(): Messages;
-    getResources(): Record<string, Messages> | undefined;
-    getLazyResources(): Record<string, () => Promise<{
-        messages: Messages;
-    }>> | undefined;
+interface TranslationResourceOptions<TId extends string, TMessages extends {
+    [key in string]: string;
+}, TTranslations extends {
+    [language in string]: () => Promise<{
+        default: TranslationMessages$1<TId> | {
+            [key in keyof TMessages]: string | null;
+        };
+    }>;
+}> {
+    ref: TranslationRef$1<TId, TMessages>;
+    translations: TTranslations;
 }
 /** @alpha */
-type TranslationOptions<Messages extends Record<keyof Messages, string> = Record<string, string>> = Messages;
+declare function createTranslationResource<TId extends string, TMessages extends {
+    [key in string]: string;
+}, TTranslations extends {
+    [language in string]: () => Promise<{
+        default: TranslationMessages$1<TId> | {
+            [key in keyof TMessages]: string | null;
+        };
+    }>;
+}>(options: TranslationResourceOptions<TId, TMessages, TTranslations>): TranslationResource<TId>;
 
 /** @alpha */
-declare class TranslationRefImpl<Messages extends Record<keyof Messages, string>> implements TranslationRef<Messages> {
-    private readonly config;
-    static create<Messages extends Record<keyof Messages, string>>(config: TranslationRefConfig<Messages>): TranslationRefImpl<Messages>;
-    getId(): string;
-    getDefaultMessages(): Messages;
-    getLazyResources(): Record<string, () => Promise<{
-        messages: Messages;
-    }>> | undefined;
-    getResources(): Record<string, Messages> | undefined;
-    toString(): string;
-    private constructor();
+interface TranslationRef<TId extends string = string, TMessages extends {
+    [key in string]: string;
+} = {
+    [key in string]: string;
+}> {
+    $$type: '@backstage/TranslationRef';
+    id: TId;
+    T: TMessages;
 }
 /** @alpha */
-declare const createTranslationRef: <Messages extends Record<keyof Messages, string> = {}>(config: TranslationRefConfig<Messages>) => TranslationRef<Messages>;
+interface TranslationRefOptions<TId extends string, TMessages extends {
+    [key in string]: string;
+}, TTranslations extends {
+    [language in string]: () => Promise<{
+        default: {
+            [key in keyof TMessages]: string | null;
+        };
+    }>;
+}> {
+    id: TId;
+    messages: TMessages;
+    translations?: TTranslations;
+}
+/** @alpha */
+declare function createTranslationRef<TId extends string, const TMessages extends {
+    [key in string]: string;
+}, TTranslations extends {
+    [language in string]: () => Promise<{
+        default: {
+            [key in keyof TMessages]: string | null;
+        };
+    }>;
+}>(config: TranslationRefOptions<TId, TMessages, TTranslations>): TranslationRef<TId, TMessages>;
 
+/**
+ * Base translation options.
+ *
+ * @alpha
+ */
+interface BaseOptions {
+    interpolation?: {
+        /** Whether to HTML escape provided values, defaults to false  */
+        escapeValue?: boolean;
+    };
+}
+/**
+ * All pluralization suffixes supported by i18next
+ *
+ * @ignore
+ */
+type TranslationPlural = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other';
+/**
+ * A mapping of i18n formatting types to their corresponding types and options.
+ * @ignore
+ */
+type I18nextFormatMap = {
+    number: {
+        type: number;
+        options: Intl.NumberFormatOptions;
+    };
+    currency: {
+        type: number;
+        options: Intl.NumberFormatOptions;
+    };
+    datetime: {
+        type: Date;
+        options: Intl.DateTimeFormatOptions;
+    };
+    relativetime: {
+        type: number;
+        options: {
+            range?: Intl.RelativeTimeFormatUnit;
+        } & Intl.RelativeTimeFormatOptions;
+    };
+    list: {
+        type: string[];
+        options: Intl.ListFormatOptions;
+    };
+};
+/**
+ * Extracts all pluralized keys from the message map.
+ *
+ * @example
+ * ```
+ * { foo: 'foo', bar_one: 'bar', bar_other: 'bars' } -> 'bar'
+ * ```
+ *
+ * @ignore
+ */
+type PluralKeys<TMessages extends {
+    [key in string]: string;
+}> = {
+    [Key in keyof TMessages]: Key extends `${infer K}_${TranslationPlural}` ? K : never;
+}[keyof TMessages];
+/**
+ * Collapses a message map into normalized keys with union values.
+ *
+ * @example
+ * ```
+ * { foo_one: 'foo', foo_other: 'foos' } -> { foo: 'foo' | 'foos' }
+ * ```
+ *
+ * @ignore
+ */
+type CollapsedMessages<TMessages extends {
+    [key in string]: string;
+}> = {
+    [key in keyof TMessages as key extends `${infer K}_${TranslationPlural}` ? K : key]: TMessages[key];
+};
+/**
+ * Helper type that expands type hints
+ *
+ * @ignore
+ */
+type Expand<T> = T extends infer O ? {
+    [K in keyof O]: O[K];
+} : never;
+/**
+ * Helper type that expands type hints recursively
+ *
+ * @ignore
+ */
+type ExpandRecursive<T> = T extends infer O ? {
+    [K in keyof O]: ExpandRecursive<O[K]>;
+} : never;
+/**
+ * Trim away whitespace
+ *
+ * @ignore
+ */
+type Trim<T> = T extends ` ${infer U}` ? Trim<U> : T extends `${infer U} ` ? Trim<U> : T;
+/**
+ * Extracts the key and format from a replacement string.
+ *
+ * @example
+ * ```
+ * 'foo, number' -> { foo: number }, 'foo' -> { foo: undefined }
+ * ```
+ */
+type ExtractFormat<Replacement extends string> = Replacement extends `${infer Key},${infer FullFormat}` ? {
+    [key in Trim<Key>]: Lowercase<Trim<FullFormat extends `${infer Format}(${string})${string}` ? Format : FullFormat>>;
+} : {
+    [key in Trim<Replacement>]: undefined;
+};
+/**
+ * Expand the keys in a flat map to nested objects.
+ *
+ * @example
+ * ```
+ * { 'a.b': 'foo', 'a.c': 'bar' } -> { a: { b: 'foo', c: 'bar' }
+ * ```
+ *
+ * @ignore
+ */
+type ExpandKeys<TMap extends {}> = {
+    [Key in keyof TMap as Key extends `${infer Prefix}.${string}` ? Prefix : Key]: Key extends `${string}.${infer Rest}` ? ExpandKeys<{
+        [key in Rest]: TMap[Key];
+    }> : TMap[Key];
+};
+/**
+ * Extracts all option keys and their format from a message string.
+ *
+ * @example
+ * ```
+ * 'foo {{bar}} {{baz, number}}' -> { 'bar': undefined, 'baz': 'number' }
+ * ```
+ *
+ * @ignore
+ */
+type ReplaceFormatsFromMessage<TMessage> = TMessage extends `${string}{{${infer Replacement}}}${infer Tail}` ? ExpandKeys<ExtractFormat<Replacement>> & ReplaceFormatsFromMessage<Tail> : {};
+/**
+ * Generates the replace options structure
+ *
+ * @ignore
+ */
+type ReplaceOptionsFromFormats<TFormats extends {}> = {
+    [Key in keyof TFormats]: TFormats[Key] extends keyof I18nextFormatMap ? I18nextFormatMap[TFormats[Key]]['type'] : TFormats[Key] extends {} ? Expand<ReplaceOptionsFromFormats<TFormats[Key]>> : string;
+};
+/**
+ * Generates the formatParams options structure
+ *
+ * @ignore
+ */
+type ReplaceFormatParamsFromFormats<TFormats extends {}> = {
+    [Key in keyof TFormats]?: TFormats[Key] extends keyof I18nextFormatMap ? I18nextFormatMap[TFormats[Key]]['options'] : TFormats[Key] extends {} ? Expand<ReplaceFormatParamsFromFormats<TFormats[Key]>> : undefined;
+};
+/**
+ * Extracts all nesting keys from a message string.
+ *
+ * @example
+ * ```
+ * 'foo $t(bar) $t(baz)' -> 'bar' | 'baz'
+ * ```
+ *
+ * @ignore
+ */
+type NestingKeysFromMessage<TMessage extends string> = TMessage extends `${string}$t(${infer Key})${infer Tail}` ? Trim<Key> | NestingKeysFromMessage<Tail> : never;
+/**
+ * Find all referenced keys, given a starting key and the full set of messages.
+ *
+ * This will only discover keys up to 3 levels deep.
+ *
+ * @example
+ * ```
+ * <'x', { x: '$t(y) $t(z)', y: 'y', z: '$t(w)', w: 'w', foo: 'foo' }> -> 'x' | 'y' | 'z' | 'w'
+ * ```
+ *
+ * @ignore
+ */
+type NestedMessageKeys<TKey extends keyof TMessages, TMessages extends {
+    [key in string]: string;
+}> = TKey | NestedMessageKeys2<NestingKeysFromMessage<TMessages[TKey]>, TMessages>;
+type NestedMessageKeys2<TKey extends keyof TMessages, TMessages extends {
+    [key in string]: string;
+}> = TKey | NestedMessageKeys3<NestingKeysFromMessage<TMessages[TKey]>, TMessages>;
+type NestedMessageKeys3<TKey extends keyof TMessages, TMessages extends {
+    [key in string]: string;
+}> = TKey | NestingKeysFromMessage<TMessages[TKey]>;
+/**
+ * Converts a union type to an intersection type.
+ *
+ * @example
+ * ```
+ * { foo: 'foo' } | { bar: 'bar' } -> { foo: 'foo' } & { bar: 'bar' }
+ * ```
+ *
+ * @ignore
+ */
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+/**
+ * Collects different types of options into a single object
+ *
+ * @ignore
+ */
+type CollectOptions<TCount extends {
+    count?: number;
+}, TFormats extends {}> = TCount & (keyof Omit<TFormats, 'count'> extends never ? {} : (Expand<Omit<ReplaceOptionsFromFormats<TFormats>, 'count'>> | {
+    replace: Expand<Omit<ReplaceOptionsFromFormats<TFormats>, 'count'>>;
+}) & {
+    formatParams?: Expand<ReplaceFormatParamsFromFormats<TFormats>>;
+});
+/**
+ * Helper type to only require options argument if needed
+ *
+ * @ignore
+ */
+type OptionArgs<TOptions extends {}> = keyof TOptions extends never ? [options?: BaseOptions] : [options: BaseOptions & TOptions];
+/**
+ * @ignore
+ */
+type TranslationFunctionOptions<TKeys extends keyof TMessages, // All normalized message keys to be considered, i.e. included nested ones
+TPluralKeys extends keyof TMessages, // All keys in the message map that are pluralized
+TMessages extends {
+    [key in string]: string;
+}> = OptionArgs<Expand<CollectOptions<TKeys & TPluralKeys extends never ? {} : {
+    count: number;
+}, ExpandRecursive<UnionToIntersection<ReplaceFormatsFromMessage<TMessages[TKeys]>>>>>>;
+/** @alpha */
+interface TranslationFunction<TMessages extends {
+    [key in string]: string;
+}> {
+    <TKey extends keyof CollapsedMessages<TMessages>>(key: TKey, ...[args]: TranslationFunctionOptions<NestedMessageKeys<TKey, CollapsedMessages<TMessages>>, PluralKeys<TMessages>, CollapsedMessages<TMessages>>): CollapsedMessages<TMessages>[TKey];
+}
 /** @alpha */
-declare const useTranslationRef: <Messages extends Record<keyof Messages, string>>(translationRef: TranslationRef<Messages>) => <Tkey extends keyof Messages>(key: Tkey, options?: TranslationOptions) => Messages[Tkey];
+type TranslationSnapshot<TMessages extends {
+    [key in string]: string;
+}> = {
+    ready: false;
+} | {
+    ready: true;
+    t: TranslationFunction<TMessages>;
+};
+/** @alpha */
+type TranslationApi = {
+    getTranslation<TMessages extends {
+        [key in string]: string;
+    }>(translationRef: TranslationRef<string, TMessages>): TranslationSnapshot<TMessages>;
+    translation$<TMessages extends {
+        [key in string]: string;
+    }>(translationRef: TranslationRef<string, TMessages>): Observable<TranslationSnapshot<TMessages>>;
+};
+/**
+ * @alpha
+ */
+declare const translationApiRef: ApiRef<TranslationApi>;
 
 /** @alpha */
-type AppTranslationApi = {
-    getI18n(): i18n;
-    addResourcesByRef<Messages extends Record<string, string>>(translationRef: TranslationRef<Messages>): void;
+type AppLanguageApi = {
+    getAvailableLanguages(): {
+        languages: string[];
+    };
+    setLanguage(language?: string): void;
+    getLanguage(): {
+        language: string;
+    };
+    language$(): Observable<{
+        language: string;
+    }>;
 };
 /**
  * @alpha
  */
-declare const appTranslationApiRef: ApiRef<AppTranslationApi>;
+declare const appLanguageApiRef: ApiRef<AppLanguageApi>;
+
+/** @alpha */
+declare const useTranslationRef: <TMessages extends {
+    [x: string]: string;
+}>(translationRef: TranslationRef<string, TMessages>) => {
+    t: TranslationFunction<TMessages>;
+};
 
-export { AppTranslationApi, PluginOptionsProviderProps, PluginProvider, TranslationOptions, TranslationRef, TranslationRefConfig, TranslationRefImpl, appTranslationApiRef, createTranslationRef, usePluginOptions, useTranslationRef };
+export { AppLanguageApi, PluginOptionsProviderProps, PluginProvider, TranslationApi, TranslationFunction, TranslationMessages, TranslationMessagesOptions, TranslationRef, TranslationRefOptions, TranslationResource, TranslationResourceOptions, TranslationSnapshot, appLanguageApiRef, createTranslationMessages, createTranslationRef, createTranslationResource, translationApiRef, usePluginOptions, useTranslationRef };

package/dist/alpha.esm.js

@@ -1,46 +1,179 @@
-import { u as useApi } from './esm/usePluginOptions-6dc02fab.esm.js';
+import { u as useApi, r as errorApiRef } from './esm/usePluginOptions-6dc02fab.esm.js';
 export { P as PluginProvider, y as usePluginOptions } from './esm/usePluginOptions-6dc02fab.esm.js';
-import { useTranslation } from 'react-i18next';
+import { useState, useMemo, useCallback, useEffect, useRef } from 'react';
 import { createApiRef } from '@backstage/core-plugin-api';
-import 'react';
 import '@backstage/version-bridge';
 
+function createTranslationMessages(options) {
+  return {
+    $$type: "@backstage/TranslationMessages",
+    id: options.ref.id,
+    full: Boolean(options.full),
+    messages: options.messages
+  };
+}
+
+function createTranslationResource(options) {
+  return {
+    $$type: "@backstage/TranslationResource",
+    version: "v1",
+    id: options.ref.id,
+    resources: Object.entries(options.translations).map(
+      ([language, loader]) => ({
+        language,
+        loader: () => loader().then((m) => {
+          const value = m.default;
+          return {
+            messages: (value == null ? void 0 : value.$$type) === "@backstage/TranslationMessages" ? value.messages : value
+          };
+        })
+      })
+    )
+  };
+}
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+var _id, _messages, _resources;
 class TranslationRefImpl {
-  constructor(config) {
-    this.config = config;
+  constructor(options) {
+    __privateAdd(this, _id, void 0);
+    __privateAdd(this, _messages, void 0);
+    __privateAdd(this, _resources, void 0);
+    __publicField(this, "$$type", "@backstage/TranslationRef");
+    __publicField(this, "version", "v1");
+    __privateSet(this, _id, options.id);
+    __privateSet(this, _messages, options.messages);
   }
-  static create(config) {
-    return new TranslationRefImpl(config);
+  get id() {
+    return __privateGet(this, _id);
   }
-  getId() {
-    return this.config.id;
+  get T() {
+    throw new Error("Not implemented");
   }
   getDefaultMessages() {
-    return this.config.messages;
+    return __privateGet(this, _messages);
   }
-  getLazyResources() {
-    return this.config.lazyResources;
+  setDefaultResource(resources) {
+    __privateSet(this, _resources, resources);
   }
-  getResources() {
-    return this.config.resources;
+  getDefaultResource() {
+    return __privateGet(this, _resources);
   }
   toString() {
-    return `TranslationRef(${this.getId()})`;
+    return `TranslationRef{id=${this.id}}`;
+  }
+}
+_id = new WeakMap();
+_messages = new WeakMap();
+_resources = new WeakMap();
+function createTranslationRef(config) {
+  const ref = new TranslationRefImpl(config);
+  if (config.translations) {
+    ref.setDefaultResource(
+      createTranslationResource({
+        ref,
+        translations: config.translations
+      })
+    );
   }
+  return ref;
 }
-const createTranslationRef = (config) => TranslationRefImpl.create(config);
 
-const appTranslationApiRef = createApiRef({
-  id: "core.apptranslation"
+const translationApiRef = createApiRef({
+  id: "core.translation"
 });
 
+const appLanguageApiRef = createApiRef({
+  id: "core.applanguage"
+});
+
+const loggedRefs = /* @__PURE__ */ new WeakSet();
 const useTranslationRef = (translationRef) => {
-  const appTranslationApi = useApi(appTranslationApiRef);
-  appTranslationApi.addResourcesByRef(translationRef);
-  const { t } = useTranslation(translationRef.getId());
-  const defaulteMessage = translationRef.getDefaultMessages();
-  return (key, options) => t(key, defaulteMessage[key], options);
+  const errorApi = useApi(errorApiRef);
+  const translationApi = useApi(translationApiRef);
+  const [snapshot, setSnapshot] = useState(
+    () => translationApi.getTranslation(translationRef)
+  );
+  const observable = useMemo(
+    () => translationApi.translation$(translationRef),
+    [translationApi, translationRef]
+  );
+  const onError = useCallback(
+    (error) => {
+      if (!loggedRefs.has(translationRef)) {
+        const errMsg = `Failed to load translation resource '${translationRef.id}'; caused by ${error}`;
+        console.error(errMsg);
+        errorApi.post(new Error(errMsg));
+        loggedRefs.add(translationRef);
+      }
+    },
+    [errorApi, translationRef]
+  );
+  useEffect(() => {
+    const subscription = observable.subscribe({
+      next(next) {
+        if (next.ready) {
+          setSnapshot(next);
+        }
+      },
+      error(error) {
+        onError(error);
+      }
+    });
+    return () => {
+      subscription.unsubscribe();
+    };
+  }, [observable, onError]);
+  const initialRenderRef = useRef(true);
+  useEffect(() => {
+    if (initialRenderRef.current) {
+      initialRenderRef.current = false;
+    } else {
+      setSnapshot(translationApi.getTranslation(translationRef));
+    }
+  }, [translationApi, translationRef]);
+  if (!snapshot.ready) {
+    throw new Promise((resolve) => {
+      const subscription = observable.subscribe({
+        next(next) {
+          if (next.ready) {
+            subscription.unsubscribe();
+            resolve();
+          }
+        },
+        error(error) {
+          subscription.unsubscribe();
+          onError(error);
+          resolve();
+        }
+      });
+    });
+  }
+  return { t: snapshot.t };
 };
 
-export { TranslationRefImpl, appTranslationApiRef, createTranslationRef, useTranslationRef };
+export { appLanguageApiRef, createTranslationMessages, createTranslationRef, createTranslationResource, translationApiRef, useTranslationRef };
 //# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":["../src/translation/TranslationRef.ts","../src/apis/definitions/AppTranslationApi.ts","../src/translation/useTranslationRef.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 { TranslationRef, TranslationRefConfig } from './types';\n\n/** @alpha */\nexport class TranslationRefImpl<Messages extends Record<keyof Messages, string>>\n  implements TranslationRef<Messages>\n{\n  static create<Messages extends Record<keyof Messages, string>>(\n    config: TranslationRefConfig<Messages>,\n  ) {\n    return new TranslationRefImpl(config);\n  }\n\n  getId() {\n    return this.config.id;\n  }\n\n  getDefaultMessages(): Messages {\n    return this.config.messages;\n  }\n\n  getLazyResources():\n    | Record<string, () => Promise<{ messages: Messages }>>\n    | undefined {\n    return this.config.lazyResources;\n  }\n\n  getResources(): Record<string, Messages> | undefined {\n    return this.config.resources;\n  }\n\n  toString() {\n    return `TranslationRef(${this.getId()})`;\n  }\n\n  private constructor(\n    private readonly config: TranslationRefConfig<Messages>,\n  ) {}\n}\n\n/** @alpha */\nexport const createTranslationRef = <\n  Messages extends Record<keyof Messages, string> = {},\n>(\n  config: TranslationRefConfig<Messages>,\n): TranslationRef<Messages> => TranslationRefImpl.create(config);\n","/*\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 { type i18n } from 'i18next';\nimport { TranslationRef } from '../../translation';\nimport { ApiRef, createApiRef } from '@backstage/core-plugin-api';\n\n/** @alpha */\nexport type AppTranslationApi = {\n  getI18n(): i18n;\n\n  addResourcesByRef<Messages extends Record<string, string>>(\n    translationRef: TranslationRef<Messages>,\n  ): void;\n};\n\n/**\n * @alpha\n */\nexport const appTranslationApiRef: ApiRef<AppTranslationApi> = createApiRef({\n  id: 'core.apptranslation',\n});\n","/*\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 { useTranslation } from 'react-i18next';\n\nimport { TranslationOptions, TranslationRef } from './types';\nimport { useApi } from '../apis';\nimport { appTranslationApiRef } from '../apis/alpha';\n\n/** @alpha */\nexport const useTranslationRef = <\n  Messages extends Record<keyof Messages, string>,\n>(\n  translationRef: TranslationRef<Messages>,\n) => {\n  const appTranslationApi = useApi(appTranslationApiRef);\n\n  appTranslationApi.addResourcesByRef(translationRef);\n\n  const { t } = useTranslation(translationRef.getId());\n\n  const defaulteMessage = translationRef.getDefaultMessages();\n\n  return <Tkey extends keyof Messages>(\n    key: Tkey,\n    options?: TranslationOptions,\n  ): Messages[Tkey] => t(key as string, defaulteMessage[key], options);\n};\n"],"names":[],"mappings":";;;;;;;AAmBO,MAAM,kBAEb,CAAA;AAAA,EA6BU,YACW,MACjB,EAAA;AADiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA,EA9BH,OAAO,OACL,MACA,EAAA;AACA,IAAO,OAAA,IAAI,mBAAmB,MAAM,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,KAAQ,GAAA;AACN,IAAA,OAAO,KAAK,MAAO,CAAA,EAAA,CAAA;AAAA,GACrB;AAAA,EAEA,kBAA+B,GAAA;AAC7B,IAAA,OAAO,KAAK,MAAO,CAAA,QAAA,CAAA;AAAA,GACrB;AAAA,EAEA,gBAEc,GAAA;AACZ,IAAA,OAAO,KAAK,MAAO,CAAA,aAAA,CAAA;AAAA,GACrB;AAAA,EAEA,YAAqD,GAAA;AACnD,IAAA,OAAO,KAAK,MAAO,CAAA,SAAA,CAAA;AAAA,GACrB;AAAA,EAEA,QAAW,GAAA;AACT,IAAO,OAAA,CAAA,eAAA,EAAkB,IAAK,CAAA,KAAA,EAAO,CAAA,CAAA,CAAA,CAAA;AAAA,GACvC;AAKF,CAAA;AAGO,MAAM,oBAAuB,GAAA,CAGlC,MAC6B,KAAA,kBAAA,CAAmB,OAAO,MAAM;;AC5BxD,MAAM,uBAAkD,YAAa,CAAA;AAAA,EAC1E,EAAI,EAAA,qBAAA;AACN,CAAC;;ACXY,MAAA,iBAAA,GAAoB,CAG/B,cACG,KAAA;AACH,EAAM,MAAA,iBAAA,GAAoB,OAAO,oBAAoB,CAAA,CAAA;AAErD,EAAA,iBAAA,CAAkB,kBAAkB,cAAc,CAAA,CAAA;AAElD,EAAA,MAAM,EAAE,CAAE,EAAA,GAAI,cAAe,CAAA,cAAA,CAAe,OAAO,CAAA,CAAA;AAEnD,EAAM,MAAA,eAAA,GAAkB,eAAe,kBAAmB,EAAA,CAAA;AAE1D,EAAO,OAAA,CACL,KACA,OACmB,KAAA,CAAA,CAAE,KAAe,eAAgB,CAAA,GAAG,GAAG,OAAO,CAAA,CAAA;AACrE;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":["../src/translation/TranslationMessages.ts","../src/translation/TranslationResource.ts","../src/translation/TranslationRef.ts","../src/apis/definitions/TranslationApi.ts","../src/apis/definitions/AppLanguageApi.ts","../src/translation/useTranslationRef.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 { TranslationRef } from '@backstage/core-plugin-api/alpha';\n\n/**\n * Represents a collection of messages to be provided for a given translation ref.\n *\n * @alpha\n * @remarks\n *\n * This collection of messages can either be used directly as an override for the\n * default messages, or it can be used to provide translations for a language by\n * by being referenced by a {@link TranslationResource}.\n */\nexport interface TranslationMessages<\n  TId extends string = string,\n  TMessages extends { [key in string]: string } = { [key in string]: string },\n  TFull extends boolean = boolean,\n> {\n  $$type: '@backstage/TranslationMessages';\n  /** The ID of the translation ref that these messages are for */\n  id: TId;\n  /** Whether or not these messages override all known messages */\n  full: TFull;\n  /** The messages provided for the given translation ref */\n  messages: TMessages;\n}\n\n/**\n * Options for {@link createTranslationMessages}.\n *\n * @alpha\n */\nexport interface TranslationMessagesOptions<\n  TId extends string,\n  TMessages extends { [key in string]: string },\n  TFull extends boolean,\n> {\n  ref: TranslationRef<TId, TMessages>;\n\n  full?: TFull;\n\n  messages: false extends TFull\n    ? { [key in keyof TMessages]?: string | null }\n    : { [key in keyof TMessages]: string | null };\n}\n\n/**\n * Creates a collection of messages for a given translation ref.\n *\n * @alpha\n */\nexport function createTranslationMessages<\n  TId extends string,\n  TMessages extends { [key in string]: string },\n  TFull extends boolean,\n>(\n  options: TranslationMessagesOptions<TId, TMessages, TFull>,\n): TranslationMessages<TId, TMessages, TFull> {\n  return {\n    $$type: '@backstage/TranslationMessages',\n    id: options.ref.id,\n    full: Boolean(options.full) as TFull,\n    messages: options.messages as TMessages,\n  };\n}\n","/*\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  TranslationMessages,\n  TranslationRef,\n} from '@backstage/core-plugin-api/alpha';\n\n/** @alpha */\nexport interface TranslationResource<TId extends string = string> {\n  $$type: '@backstage/TranslationResource';\n  id: TId;\n}\n\n/** @internal */\nexport type InternalTranslationResourceLoader = () => Promise<{\n  messages: { [key in string]: string | null };\n}>;\n\n/** @internal */\nexport interface InternalTranslationResource<TId extends string = string>\n  extends TranslationResource<TId> {\n  version: 'v1';\n  resources: Array<{\n    language: string;\n    loader: InternalTranslationResourceLoader;\n  }>;\n}\n\n/** @internal */\nexport function toInternalTranslationResource<TId extends string>(\n  resource: TranslationResource<TId>,\n): InternalTranslationResource<TId> {\n  const r = resource as InternalTranslationResource<TId>;\n  if (r.$$type !== '@backstage/TranslationResource') {\n    throw new Error(`Invalid translation resource, bad type '${r.$$type}'`);\n  }\n  if (r.version !== 'v1') {\n    throw new Error(`Invalid translation resource, bad version '${r.version}'`);\n  }\n\n  return r;\n}\n\n/** @alpha */\nexport interface TranslationResourceOptions<\n  TId extends string,\n  TMessages extends { [key in string]: string },\n  TTranslations extends {\n    [language in string]: () => Promise<{\n      default:\n        | TranslationMessages<TId>\n        | { [key in keyof TMessages]: string | null };\n    }>;\n  },\n> {\n  ref: TranslationRef<TId, TMessages>;\n\n  translations: TTranslations;\n}\n\n/** @alpha */\nexport function createTranslationResource<\n  TId extends string,\n  TMessages extends { [key in string]: string },\n  TTranslations extends {\n    [language in string]: () => Promise<{\n      default:\n        | TranslationMessages<TId>\n        | { [key in keyof TMessages]: string | null };\n    }>;\n  },\n>(\n  options: TranslationResourceOptions<TId, TMessages, TTranslations>,\n): TranslationResource<TId> {\n  return {\n    $$type: '@backstage/TranslationResource',\n    version: 'v1',\n    id: options.ref.id,\n    resources: Object.entries(options.translations).map(\n      ([language, loader]) => ({\n        language,\n        loader: () =>\n          loader().then(m => {\n            const value = m.default;\n            return {\n              messages:\n                value?.$$type === '@backstage/TranslationMessages'\n                  ? value.messages\n                  : value,\n            };\n          }),\n      }),\n    ),\n  } as InternalTranslationResource<TId>;\n}\n","/*\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  createTranslationResource,\n  TranslationResource,\n} from './TranslationResource';\n\n/** @alpha */\nexport interface TranslationRef<\n  TId extends string = string,\n  TMessages extends { [key in string]: string } = { [key in string]: string },\n> {\n  $$type: '@backstage/TranslationRef';\n\n  id: TId;\n\n  T: TMessages;\n}\n\n/** @internal */\ntype AnyMessages = { [key in string]: string };\n\n/** @internal */\nexport interface InternalTranslationRef<\n  TId extends string = string,\n  TMessages extends { [key in string]: string } = { [key in string]: string },\n> extends TranslationRef<TId, TMessages> {\n  version: 'v1';\n\n  getDefaultMessages(): AnyMessages;\n\n  getDefaultResource(): TranslationResource | undefined;\n}\n\n/** @alpha */\nexport interface TranslationRefOptions<\n  TId extends string,\n  TMessages extends { [key in string]: string },\n  TTranslations extends {\n    [language in string]: () => Promise<{\n      default: { [key in keyof TMessages]: string | null };\n    }>;\n  },\n> {\n  id: TId;\n  messages: TMessages;\n  translations?: TTranslations;\n}\n\n/** @internal */\nclass TranslationRefImpl<\n  TId extends string,\n  TMessages extends { [key in string]: string },\n> implements InternalTranslationRef<TId, TMessages>\n{\n  #id: TId;\n  #messages: TMessages;\n  #resources: TranslationResource | undefined;\n\n  constructor(options: TranslationRefOptions<TId, TMessages, any>) {\n    this.#id = options.id;\n    this.#messages = options.messages;\n  }\n\n  $$type = '@backstage/TranslationRef' as const;\n\n  version = 'v1' as const;\n\n  get id(): TId {\n    return this.#id;\n  }\n\n  get T(): never {\n    throw new Error('Not implemented');\n  }\n\n  getDefaultMessages(): AnyMessages {\n    return this.#messages;\n  }\n\n  setDefaultResource(resources: TranslationResource): void {\n    this.#resources = resources;\n  }\n\n  getDefaultResource(): TranslationResource | undefined {\n    return this.#resources;\n  }\n\n  toString() {\n    return `TranslationRef{id=${this.id}}`;\n  }\n}\n\n/** @alpha */\nexport function createTranslationRef<\n  TId extends string,\n  const TMessages extends { [key in string]: string },\n  TTranslations extends {\n    [language in string]: () => Promise<{\n      default: { [key in keyof TMessages]: string | null };\n    }>;\n  },\n>(\n  config: TranslationRefOptions<TId, TMessages, TTranslations>,\n): TranslationRef<TId, TMessages> {\n  const ref = new TranslationRefImpl(config);\n  if (config.translations) {\n    ref.setDefaultResource(\n      createTranslationResource({\n        ref,\n        translations: config.translations as any,\n      }),\n    );\n  }\n  return ref;\n}\n\n/** @internal */\nexport function toInternalTranslationRef<\n  TId extends string,\n  TMessages extends { [key in string]: string },\n>(ref: TranslationRef<TId, TMessages>): InternalTranslationRef<TId, TMessages> {\n  const r = ref as InternalTranslationRef<TId, TMessages>;\n  if (r.$$type !== '@backstage/TranslationRef') {\n    throw new Error(`Invalid translation ref, bad type '${r.$$type}'`);\n  }\n  if (r.version !== 'v1') {\n    throw new Error(`Invalid translation ref, bad version '${r.version}'`);\n  }\n  return r;\n}\n","/*\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 { ApiRef, createApiRef } from '@backstage/core-plugin-api';\nimport { Observable } from '@backstage/types';\nimport { TranslationRef } from '../../translation';\n\n/**\n * Base translation options.\n *\n * @alpha\n */\ninterface BaseOptions {\n  interpolation?: {\n    /** Whether to HTML escape provided values, defaults to false  */\n    escapeValue?: boolean;\n  };\n}\n\n/**\n * All pluralization suffixes supported by i18next\n *\n * @ignore\n */\ntype TranslationPlural = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other';\n\n/**\n * A mapping of i18n formatting types to their corresponding types and options.\n * @ignore\n */\ntype I18nextFormatMap = {\n  number: {\n    type: number;\n    options: Intl.NumberFormatOptions;\n  };\n  currency: {\n    type: number;\n    options: Intl.NumberFormatOptions;\n  };\n  datetime: {\n    type: Date;\n    options: Intl.DateTimeFormatOptions;\n  };\n  relativetime: {\n    type: number;\n    options: {\n      range?: Intl.RelativeTimeFormatUnit;\n    } & Intl.RelativeTimeFormatOptions;\n  };\n  list: {\n    type: string[];\n    options: Intl.ListFormatOptions;\n  };\n};\n\n/**\n * Extracts all pluralized keys from the message map.\n *\n * @example\n * ```\n * { foo: 'foo', bar_one: 'bar', bar_other: 'bars' } -> 'bar'\n * ```\n *\n * @ignore\n */\ntype PluralKeys<TMessages extends { [key in string]: string }> = {\n  [Key in keyof TMessages]: Key extends `${infer K}_${TranslationPlural}`\n    ? K\n    : never;\n}[keyof TMessages];\n\n/**\n * Collapses a message map into normalized keys with union values.\n *\n * @example\n * ```\n * { foo_one: 'foo', foo_other: 'foos' } -> { foo: 'foo' | 'foos' }\n * ```\n *\n * @ignore\n */\ntype CollapsedMessages<TMessages extends { [key in string]: string }> = {\n  [key in keyof TMessages as key extends `${infer K}_${TranslationPlural}`\n    ? K\n    : key]: TMessages[key];\n};\n\n/**\n * Helper type that expands type hints\n *\n * @ignore\n */\ntype Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;\n\n/**\n * Helper type that expands type hints recursively\n *\n * @ignore\n */\ntype ExpandRecursive<T> = T extends infer O\n  ? { [K in keyof O]: ExpandRecursive<O[K]> }\n  : never;\n\n/**\n * Trim away whitespace\n *\n * @ignore\n */\ntype Trim<T> = T extends ` ${infer U}`\n  ? Trim<U>\n  : T extends `${infer U} `\n  ? Trim<U>\n  : T;\n\n/**\n * Extracts the key and format from a replacement string.\n *\n * @example\n * ```\n * 'foo, number' -> { foo: number }, 'foo' -> { foo: undefined }\n * ```\n */\ntype ExtractFormat<Replacement extends string> =\n  Replacement extends `${infer Key},${infer FullFormat}`\n    ? {\n        [key in Trim<Key>]: Lowercase<\n          Trim<\n            FullFormat extends `${infer Format}(${string})${string}`\n              ? Format\n              : FullFormat\n          >\n        >;\n      }\n    : { [key in Trim<Replacement>]: undefined };\n\n/**\n * Expand the keys in a flat map to nested objects.\n *\n * @example\n * ```\n * { 'a.b': 'foo', 'a.c': 'bar' } -> { a: { b: 'foo', c: 'bar' }\n * ```\n *\n * @ignore\n */\ntype ExpandKeys<TMap extends {}> = {\n  [Key in keyof TMap as Key extends `${infer Prefix}.${string}`\n    ? Prefix\n    : Key]: Key extends `${string}.${infer Rest}`\n    ? ExpandKeys<{ [key in Rest]: TMap[Key] }>\n    : TMap[Key];\n};\n\n/**\n * Extracts all option keys and their format from a message string.\n *\n * @example\n * ```\n * 'foo {{bar}} {{baz, number}}' -> { 'bar': undefined, 'baz': 'number' }\n * ```\n *\n * @ignore\n */\ntype ReplaceFormatsFromMessage<TMessage> =\n  TMessage extends `${string}{{${infer Replacement}}}${infer Tail}` // no formatting, e.g. {{foo}}\n    ? ExpandKeys<ExtractFormat<Replacement>> & ReplaceFormatsFromMessage<Tail>\n    : {};\n\n/**\n * Generates the replace options structure\n *\n * @ignore\n */\ntype ReplaceOptionsFromFormats<TFormats extends {}> = {\n  [Key in keyof TFormats]: TFormats[Key] extends keyof I18nextFormatMap\n    ? I18nextFormatMap[TFormats[Key]]['type']\n    : TFormats[Key] extends {}\n    ? Expand<ReplaceOptionsFromFormats<TFormats[Key]>>\n    : string;\n};\n\n/**\n * Generates the formatParams options structure\n *\n * @ignore\n */\ntype ReplaceFormatParamsFromFormats<TFormats extends {}> = {\n  [Key in keyof TFormats]?: TFormats[Key] extends keyof I18nextFormatMap\n    ? I18nextFormatMap[TFormats[Key]]['options']\n    : TFormats[Key] extends {}\n    ? Expand<ReplaceFormatParamsFromFormats<TFormats[Key]>>\n    : undefined;\n};\n\n/**\n * Extracts all nesting keys from a message string.\n *\n * @example\n * ```\n * 'foo $t(bar) $t(baz)' -> 'bar' | 'baz'\n * ```\n *\n * @ignore\n */\ntype NestingKeysFromMessage<TMessage extends string> =\n  TMessage extends `${string}$t(${infer Key})${infer Tail}` // nesting options are not supported\n    ? Trim<Key> | NestingKeysFromMessage<Tail>\n    : never;\n\n/**\n * Find all referenced keys, given a starting key and the full set of messages.\n *\n * This will only discover keys up to 3 levels deep.\n *\n * @example\n * ```\n * <'x', { x: '$t(y) $t(z)', y: 'y', z: '$t(w)', w: 'w', foo: 'foo' }> -> 'x' | 'y' | 'z' | 'w'\n * ```\n *\n * @ignore\n */\ntype NestedMessageKeys<\n  TKey extends keyof TMessages,\n  TMessages extends { [key in string]: string },\n> =\n  | TKey\n  | NestedMessageKeys2<NestingKeysFromMessage<TMessages[TKey]>, TMessages>;\n// Can't recursively reference ourself, so instead we got this beauty\ntype NestedMessageKeys2<\n  TKey extends keyof TMessages,\n  TMessages extends { [key in string]: string },\n> =\n  | TKey\n  | NestedMessageKeys3<NestingKeysFromMessage<TMessages[TKey]>, TMessages>;\n// Only support 3 levels of nesting\ntype NestedMessageKeys3<\n  TKey extends keyof TMessages,\n  TMessages extends { [key in string]: string },\n> = TKey | NestingKeysFromMessage<TMessages[TKey]>;\n\n/**\n * Converts a union type to an intersection type.\n *\n * @example\n * ```\n * { foo: 'foo' } | { bar: 'bar' } -> { foo: 'foo' } & { bar: 'bar' }\n * ```\n *\n * @ignore\n */\ntype UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (\n  k: infer I,\n) => void\n  ? I\n  : never;\n\n/**\n * Collects different types of options into a single object\n *\n * @ignore\n */\ntype CollectOptions<\n  TCount extends { count?: number },\n  TFormats extends {},\n> = TCount &\n  // count is special, omit it from the replacements\n  (keyof Omit<TFormats, 'count'> extends never\n    ? {}\n    : (\n        | Expand<Omit<ReplaceOptionsFromFormats<TFormats>, 'count'>>\n        | {\n            replace: Expand<Omit<ReplaceOptionsFromFormats<TFormats>, 'count'>>;\n          }\n      ) & {\n        formatParams?: Expand<ReplaceFormatParamsFromFormats<TFormats>>;\n      });\n\n/**\n * Helper type to only require options argument if needed\n *\n * @ignore\n */\ntype OptionArgs<TOptions extends {}> = keyof TOptions extends never\n  ? [options?: BaseOptions]\n  : [options: BaseOptions & TOptions];\n\n/**\n * @ignore\n */\ntype TranslationFunctionOptions<\n  TKeys extends keyof TMessages, // All normalized message keys to be considered, i.e. included nested ones\n  TPluralKeys extends keyof TMessages, // All keys in the message map that are pluralized\n  TMessages extends { [key in string]: string }, // Collapsed message map with normalized keys and union values\n> = OptionArgs<\n  Expand<\n    CollectOptions<\n      TKeys & TPluralKeys extends never ? {} : { count: number },\n      ExpandRecursive<\n        UnionToIntersection<ReplaceFormatsFromMessage<TMessages[TKeys]>>\n      >\n    >\n  >\n>;\n\n/** @alpha */\nexport interface TranslationFunction<\n  TMessages extends { [key in string]: string },\n> {\n  <TKey extends keyof CollapsedMessages<TMessages>>(\n    key: TKey,\n    ...[args]: TranslationFunctionOptions<\n      NestedMessageKeys<TKey, CollapsedMessages<TMessages>>,\n      PluralKeys<TMessages>,\n      CollapsedMessages<TMessages>\n    >\n  ): CollapsedMessages<TMessages>[TKey];\n}\n\n/** @alpha */\nexport type TranslationSnapshot<TMessages extends { [key in string]: string }> =\n  { ready: false } | { ready: true; t: TranslationFunction<TMessages> };\n\n/** @alpha */\nexport type TranslationApi = {\n  getTranslation<TMessages extends { [key in string]: string }>(\n    translationRef: TranslationRef<string, TMessages>,\n  ): TranslationSnapshot<TMessages>;\n\n  translation$<TMessages extends { [key in string]: string }>(\n    translationRef: TranslationRef<string, TMessages>,\n  ): Observable<TranslationSnapshot<TMessages>>;\n};\n\n/**\n * @alpha\n */\nexport const translationApiRef: ApiRef<TranslationApi> = createApiRef({\n  id: 'core.translation',\n});\n","/*\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 { ApiRef, createApiRef } from '@backstage/core-plugin-api';\nimport { Observable } from '@backstage/types';\n\n/** @alpha */\nexport type AppLanguageApi = {\n  getAvailableLanguages(): { languages: string[] };\n\n  setLanguage(language?: string): void;\n\n  getLanguage(): { language: string };\n\n  language$(): Observable<{ language: string }>;\n};\n\n/**\n * @alpha\n */\nexport const appLanguageApiRef: ApiRef<AppLanguageApi> = createApiRef({\n  id: 'core.applanguage',\n});\n","/*\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 { useCallback, useEffect, useMemo, useRef, useState } from 'react';\nimport { errorApiRef, useApi } from '../apis';\nimport {\n  translationApiRef,\n  TranslationFunction,\n  TranslationSnapshot,\n} from '../apis/alpha';\nimport { TranslationRef } from './TranslationRef';\n\n// Make sure we don't fill the logs with loading errors for the same ref\nconst loggedRefs = new WeakSet<TranslationRef<string, {}>>();\n\n/** @alpha */\nexport const useTranslationRef = <\n  TMessages extends { [key in string]: string },\n>(\n  translationRef: TranslationRef<string, TMessages>,\n): { t: TranslationFunction<TMessages> } => {\n  const errorApi = useApi(errorApiRef);\n  const translationApi = useApi(translationApiRef);\n\n  const [snapshot, setSnapshot] = useState<TranslationSnapshot<TMessages>>(() =>\n    translationApi.getTranslation(translationRef),\n  );\n  const observable = useMemo(\n    () => translationApi.translation$(translationRef),\n    [translationApi, translationRef],\n  );\n\n  const onError = useCallback(\n    (error: Error) => {\n      if (!loggedRefs.has(translationRef)) {\n        const errMsg = `Failed to load translation resource '${translationRef.id}'; caused by ${error}`;\n        // eslint-disable-next-line no-console\n        console.error(errMsg);\n        errorApi.post(new Error(errMsg));\n        loggedRefs.add(translationRef);\n      }\n    },\n    [errorApi, translationRef],\n  );\n\n  useEffect(() => {\n    const subscription = observable.subscribe({\n      next(next) {\n        if (next.ready) {\n          setSnapshot(next);\n        }\n      },\n      error(error) {\n        onError(error);\n      },\n    });\n\n    return () => {\n      subscription.unsubscribe();\n    };\n  }, [observable, onError]);\n\n  // Keep track of if the provided translation ref changes, and in that case update the snapshot\n  const initialRenderRef = useRef(true);\n  useEffect(() => {\n    if (initialRenderRef.current) {\n      initialRenderRef.current = false;\n    } else {\n      setSnapshot(translationApi.getTranslation(translationRef));\n    }\n  }, [translationApi, translationRef]);\n\n  if (!snapshot.ready) {\n    throw new Promise<void>(resolve => {\n      const subscription = observable.subscribe({\n        next(next) {\n          if (next.ready) {\n            subscription.unsubscribe();\n            resolve();\n          }\n        },\n        error(error) {\n          subscription.unsubscribe();\n          onError(error);\n          resolve();\n        },\n      });\n    });\n  }\n\n  return { t: snapshot.t };\n};\n"],"names":[],"mappings":";;;;;;AAkEO,SAAS,0BAKd,OAC4C,EAAA;AAC5C,EAAO,OAAA;AAAA,IACL,MAAQ,EAAA,gCAAA;AAAA,IACR,EAAA,EAAI,QAAQ,GAAI,CAAA,EAAA;AAAA,IAChB,IAAA,EAAM,OAAQ,CAAA,OAAA,CAAQ,IAAI,CAAA;AAAA,IAC1B,UAAU,OAAQ,CAAA,QAAA;AAAA,GACpB,CAAA;AACF;;ACJO,SAAS,0BAWd,OAC0B,EAAA;AAC1B,EAAO,OAAA;AAAA,IACL,MAAQ,EAAA,gCAAA;AAAA,IACR,OAAS,EAAA,IAAA;AAAA,IACT,EAAA,EAAI,QAAQ,GAAI,CAAA,EAAA;AAAA,IAChB,SAAW,EAAA,MAAA,CAAO,OAAQ,CAAA,OAAA,CAAQ,YAAY,CAAE,CAAA,GAAA;AAAA,MAC9C,CAAC,CAAC,QAAU,EAAA,MAAM,CAAO,MAAA;AAAA,QACvB,QAAA;AAAA,QACA,MAAQ,EAAA,MACN,MAAO,EAAA,CAAE,KAAK,CAAK,CAAA,KAAA;AACjB,UAAA,MAAM,QAAQ,CAAE,CAAA,OAAA,CAAA;AAChB,UAAO,OAAA;AAAA,YACL,QACE,EAAA,CAAA,KAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAO,MAAW,MAAA,gCAAA,GACd,MAAM,QACN,GAAA,KAAA;AAAA,WACR,CAAA;AAAA,SACD,CAAA;AAAA,OACL,CAAA;AAAA,KACF;AAAA,GACF,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;AC5GA,IAAA,GAAA,EAAA,SAAA,EAAA,UAAA,CAAA;AAgEA,MAAM,kBAIN,CAAA;AAAA,EAKE,YAAY,OAAqD,EAAA;AAJjE,IAAA,YAAA,CAAA,IAAA,EAAA,GAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,SAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,UAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAOA,IAAS,aAAA,CAAA,IAAA,EAAA,QAAA,EAAA,2BAAA,CAAA,CAAA;AAET,IAAU,aAAA,CAAA,IAAA,EAAA,SAAA,EAAA,IAAA,CAAA,CAAA;AANR,IAAA,YAAA,CAAA,IAAA,EAAK,KAAM,OAAQ,CAAA,EAAA,CAAA,CAAA;AACnB,IAAA,YAAA,CAAA,IAAA,EAAK,WAAY,OAAQ,CAAA,QAAA,CAAA,CAAA;AAAA,GAC3B;AAAA,EAMA,IAAI,EAAU,GAAA;AACZ,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,GAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,CAAW,GAAA;AACb,IAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,kBAAkC,GAAA;AAChC,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,mBAAmB,SAAsC,EAAA;AACvD,IAAA,YAAA,CAAA,IAAA,EAAK,UAAa,EAAA,SAAA,CAAA,CAAA;AAAA,GACpB;AAAA,EAEA,kBAAsD,GAAA;AACpD,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AAAA,GACd;AAAA,EAEA,QAAW,GAAA;AACT,IAAO,OAAA,CAAA,kBAAA,EAAqB,KAAK,EAAE,CAAA,CAAA,CAAA,CAAA;AAAA,GACrC;AACF,CAAA;AApCE,GAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,SAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,UAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AAqCK,SAAS,qBASd,MACgC,EAAA;AAChC,EAAM,MAAA,GAAA,GAAM,IAAI,kBAAA,CAAmB,MAAM,CAAA,CAAA;AACzC,EAAA,IAAI,OAAO,YAAc,EAAA;AACvB,IAAI,GAAA,CAAA,kBAAA;AAAA,MACF,yBAA0B,CAAA;AAAA,QACxB,GAAA;AAAA,QACA,cAAc,MAAO,CAAA,YAAA;AAAA,OACtB,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AACA,EAAO,OAAA,GAAA,CAAA;AACT;;AC4NO,MAAM,oBAA4C,YAAa,CAAA;AAAA,EACpE,EAAI,EAAA,kBAAA;AACN,CAAC;;AC9TM,MAAM,oBAA4C,YAAa,CAAA;AAAA,EACpE,EAAI,EAAA,kBAAA;AACN,CAAC;;ACTD,MAAM,UAAA,uBAAiB,OAAoC,EAAA,CAAA;AAG9C,MAAA,iBAAA,GAAoB,CAG/B,cAC0C,KAAA;AAC1C,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA,CAAA;AACnC,EAAM,MAAA,cAAA,GAAiB,OAAO,iBAAiB,CAAA,CAAA;AAE/C,EAAM,MAAA,CAAC,QAAU,EAAA,WAAW,CAAI,GAAA,QAAA;AAAA,IAAyC,MACvE,cAAe,CAAA,cAAA,CAAe,cAAc,CAAA;AAAA,GAC9C,CAAA;AACA,EAAA,MAAM,UAAa,GAAA,OAAA;AAAA,IACjB,MAAM,cAAe,CAAA,YAAA,CAAa,cAAc,CAAA;AAAA,IAChD,CAAC,gBAAgB,cAAc,CAAA;AAAA,GACjC,CAAA;AAEA,EAAA,MAAM,OAAU,GAAA,WAAA;AAAA,IACd,CAAC,KAAiB,KAAA;AAChB,MAAA,IAAI,CAAC,UAAA,CAAW,GAAI,CAAA,cAAc,CAAG,EAAA;AACnC,QAAA,MAAM,MAAS,GAAA,CAAA,qCAAA,EAAwC,cAAe,CAAA,EAAE,gBAAgB,KAAK,CAAA,CAAA,CAAA;AAE7F,QAAA,OAAA,CAAQ,MAAM,MAAM,CAAA,CAAA;AACpB,QAAA,QAAA,CAAS,IAAK,CAAA,IAAI,KAAM,CAAA,MAAM,CAAC,CAAA,CAAA;AAC/B,QAAA,UAAA,CAAW,IAAI,cAAc,CAAA,CAAA;AAAA,OAC/B;AAAA,KACF;AAAA,IACA,CAAC,UAAU,cAAc,CAAA;AAAA,GAC3B,CAAA;AAEA,EAAA,SAAA,CAAU,MAAM;AACd,IAAM,MAAA,YAAA,GAAe,WAAW,SAAU,CAAA;AAAA,MACxC,KAAK,IAAM,EAAA;AACT,QAAA,IAAI,KAAK,KAAO,EAAA;AACd,UAAA,WAAA,CAAY,IAAI,CAAA,CAAA;AAAA,SAClB;AAAA,OACF;AAAA,MACA,MAAM,KAAO,EAAA;AACX,QAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,OACf;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,MAAM;AACX,MAAA,YAAA,CAAa,WAAY,EAAA,CAAA;AAAA,KAC3B,CAAA;AAAA,GACC,EAAA,CAAC,UAAY,EAAA,OAAO,CAAC,CAAA,CAAA;AAGxB,EAAM,MAAA,gBAAA,GAAmB,OAAO,IAAI,CAAA,CAAA;AACpC,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,iBAAiB,OAAS,EAAA;AAC5B,MAAA,gBAAA,CAAiB,OAAU,GAAA,KAAA,CAAA;AAAA,KACtB,MAAA;AACL,MAAY,WAAA,CAAA,cAAA,CAAe,cAAe,CAAA,cAAc,CAAC,CAAA,CAAA;AAAA,KAC3D;AAAA,GACC,EAAA,CAAC,cAAgB,EAAA,cAAc,CAAC,CAAA,CAAA;AAEnC,EAAI,IAAA,CAAC,SAAS,KAAO,EAAA;AACnB,IAAM,MAAA,IAAI,QAAc,CAAW,OAAA,KAAA;AACjC,MAAM,MAAA,YAAA,GAAe,WAAW,SAAU,CAAA;AAAA,QACxC,KAAK,IAAM,EAAA;AACT,UAAA,IAAI,KAAK,KAAO,EAAA;AACd,YAAA,YAAA,CAAa,WAAY,EAAA,CAAA;AACzB,YAAQ,OAAA,EAAA,CAAA;AAAA,WACV;AAAA,SACF;AAAA,QACA,MAAM,KAAO,EAAA;AACX,UAAA,YAAA,CAAa,WAAY,EAAA,CAAA;AACzB,UAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AACb,UAAQ,OAAA,EAAA,CAAA;AAAA,SACV;AAAA,OACD,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AAEA,EAAO,OAAA,EAAE,CAAG,EAAA,QAAA,CAAS,CAAE,EAAA,CAAA;AACzB;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/core-plugin-api",
   "description": "Core API used by Backstage plugins",
-  "version": "1.6.0-next.3",
+  "version": "1.6.0",
   "publishConfig": {
     "access": "public"
   },
@@ -44,14 +44,13 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/config": "^1.1.0-next.2",
-    "@backstage/types": "^1.1.1-next.0",
-    "@backstage/version-bridge": "^1.0.5-next.0",
+    "@backstage/config": "^1.1.0",
+    "@backstage/types": "^1.1.1",
+    "@backstage/version-bridge": "^1.0.5",
     "@types/react": "^16.13.1 || ^17.0.0",
     "history": "^5.0.0",
     "i18next": "^22.4.15",
     "prop-types": "^15.7.2",
-    "react-i18next": "^12.3.1",
     "zen-observable": "^0.10.0"
   },
   "peerDependencies": {
@@ -60,9 +59,9 @@
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.13-next.3",
-    "@backstage/core-app-api": "^1.10.0-next.3",
-    "@backstage/test-utils": "^1.4.3-next.3",
+    "@backstage/cli": "^0.22.13",
+    "@backstage/core-app-api": "^1.10.0",
+    "@backstage/test-utils": "^1.4.3",
     "@testing-library/dom": "^8.0.0",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",