@backstage/core-plugin-api 1.10.6-next.0 → 1.10.7-next.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/core-plugin-api
 
+## 1.10.7-next.0
+
+### Patch Changes
+
+- 73f6cc3: The `TranslationApi` now supports interpolation of JSX elements by passing them directly as values to the translation function. If any of the provided interpolation values are JSX elements, the translation function will return a JSX element instead of a string.
+- Updated dependencies
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/version-bridge@1.0.11
+
+## 1.10.6
+
+### Patch Changes
+
+- a47fd39: Removes instances of default React imports, a necessary update for the upcoming React 19 migration.
+
+  <https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html>
+
+- Updated dependencies
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/version-bridge@1.0.11
+
 ## 1.10.6-next.0
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -1,6 +1,7 @@
 import { TranslationRef as TranslationRef$1, TranslationMessages as TranslationMessages$1 } from '@backstage/core-plugin-api/alpha';
 import { ApiRef } from '@backstage/core-plugin-api';
 import { Observable, Expand, ExpandRecursive } from '@backstage/types';
+import { JSX } from 'react';
 
 /**
  * Represents a collection of messages to be provided for a given translation ref.
@@ -253,8 +254,8 @@ type ReplaceFormatsFromMessage<TMessage> = TMessage extends `${string}{{${infer
  *
  * @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;
+type ReplaceOptionsFromFormats<TFormats extends {}, TValueType> = {
+    [Key in keyof TFormats]: TFormats[Key] extends keyof I18nextFormatMap ? I18nextFormatMap[TFormats[Key]]['type'] : TFormats[Key] extends {} ? Expand<ReplaceOptionsFromFormats<TFormats[Key], TValueType>> : TValueType;
 };
 /**
  * Generates the formatParams options structure
@@ -314,8 +315,8 @@ type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
  */
 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'>>;
+}, TFormats extends {}, TValueType> = TCount & (keyof Omit<TFormats, 'count'> extends never ? {} : (Expand<Omit<ReplaceOptionsFromFormats<TFormats, TValueType>, 'count'>> | {
+    replace: Expand<Omit<ReplaceOptionsFromFormats<TFormats, TValueType>, 'count'>>;
 }) & {
     formatParams?: Expand<ReplaceFormatParamsFromFormats<TFormats>>;
 });
@@ -324,7 +325,7 @@ type CollectOptions<TCount extends {
  *
  * @ignore
  */
-type OptionArgs<TOptions extends {}> = keyof TOptions extends never ? [options?: BaseOptions] : [options: BaseOptions & TOptions];
+type OptionArgs<TOptions extends {}> = keyof TOptions extends never ? [options?: Expand<BaseOptions>] : [options: Expand<BaseOptions & TOptions>];
 /**
  * @ignore
  */
@@ -332,15 +333,27 @@ type TranslationFunctionOptions<TKeys extends keyof TMessages, // All normalized
 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 ? {} : {
+}, // Collapsed message map with normalized keys and union values
+TValueType> = OptionArgs<Expand<CollectOptions<TKeys & TPluralKeys extends never ? {} : {
     count: number;
-}, ExpandRecursive<UnionToIntersection<ReplaceFormatsFromMessage<TMessages[TKeys]>>>>>>;
+}, ExpandRecursive<UnionToIntersection<ReplaceFormatsFromMessage<TMessages[TKeys]>>>, TValueType>>>;
 /** @alpha */
-interface TranslationFunction<TMessages extends {
+type 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];
-}
+}> = CollapsedMessages<TMessages> extends infer IMessages extends {
+    [key in string]: string;
+} ? {
+    /**
+     * A translation function that returns a string.
+     */
+    <TKey extends keyof IMessages>(key: TKey, ...[args]: TranslationFunctionOptions<NestedMessageKeys<TKey, IMessages>, PluralKeys<TMessages>, IMessages, string>): IMessages[TKey];
+    /**
+     * A translation function where at least one JSX.Element has been
+     * provided as an interpolation value, and will therefore return a
+     * JSX.Element.
+     */
+    <TKey extends keyof IMessages>(key: TKey, ...[args]: TranslationFunctionOptions<NestedMessageKeys<TKey, IMessages>, PluralKeys<TMessages>, IMessages, string | JSX.Element>): JSX.Element;
+} : never;
 /** @alpha */
 type TranslationSnapshot<TMessages extends {
     [key in string]: string;

package/dist/apis/definitions/TranslationApi.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"TranslationApi.esm.js","sources":["../../../src/apis/definitions/TranslationApi.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 { ApiRef, createApiRef } from '@backstage/core-plugin-api';\nimport { Expand, ExpandRecursive, 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 * 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"],"names":[],"mappings":";;AA6UO,MAAM,oBAA4C,YAAa,CAAA;AAAA,EACpE,EAAI,EAAA;AACN,CAAC;;;;"}
+{"version":3,"file":"TranslationApi.esm.js","sources":["../../../src/apis/definitions/TranslationApi.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 { ApiRef, createApiRef } from '@backstage/core-plugin-api';\nimport { Expand, ExpandRecursive, Observable } from '@backstage/types';\nimport { TranslationRef } from '../../translation';\nimport { JSX } from 'react';\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 * 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 {}, TValueType> = {\n  [Key in keyof TFormats]: TFormats[Key] extends keyof I18nextFormatMap\n    ? I18nextFormatMap[TFormats[Key]]['type']\n    : TFormats[Key] extends {}\n    ? Expand<ReplaceOptionsFromFormats<TFormats[Key], TValueType>>\n    : TValueType;\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  TValueType,\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, TValueType>, 'count'>>\n        | {\n            replace: Expand<\n              Omit<ReplaceOptionsFromFormats<TFormats, TValueType>, 'count'>\n            >;\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?: Expand<BaseOptions>]\n  : [options: Expand<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  TValueType,\n> = OptionArgs<\n  Expand<\n    CollectOptions<\n      TKeys & TPluralKeys extends never ? {} : { count: number },\n      ExpandRecursive<\n        UnionToIntersection<ReplaceFormatsFromMessage<TMessages[TKeys]>>\n      >,\n      TValueType\n    >\n  >\n>;\n\n/** @alpha */\nexport type TranslationFunction<TMessages extends { [key in string]: string }> =\n  CollapsedMessages<TMessages> extends infer IMessages extends {\n    [key in string]: string;\n  }\n    ? {\n        /**\n         * A translation function that returns a string.\n         */\n        <TKey extends keyof IMessages>(\n          key: TKey,\n          ...[args]: TranslationFunctionOptions<\n            NestedMessageKeys<TKey, IMessages>,\n            PluralKeys<TMessages>,\n            IMessages,\n            string\n          >\n        ): IMessages[TKey];\n        /**\n         * A translation function where at least one JSX.Element has been\n         * provided as an interpolation value, and will therefore return a\n         * JSX.Element.\n         */\n        <TKey extends keyof IMessages>(\n          key: TKey,\n          ...[args]: TranslationFunctionOptions<\n            NestedMessageKeys<TKey, IMessages>,\n            PluralKeys<TMessages>,\n            IMessages,\n            string | JSX.Element\n          >\n        ): JSX.Element;\n      }\n    : never;\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"],"names":[],"mappings":";;AAwWO,MAAM,oBAA4C,YAAa,CAAA;AAAA,EACpE,EAAI,EAAA;AACN,CAAC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/core-plugin-api",
-  "version": "1.10.6-next.0",
+  "version": "1.10.7-next.0",
   "description": "Core API used by Backstage plugins",
   "backstage": {
     "role": "web-library"
@@ -64,9 +64,9 @@
     "history": "^5.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.32.0-next.2",
-    "@backstage/core-app-api": "1.16.1-next.0",
-    "@backstage/test-utils": "1.7.7-next.0",
+    "@backstage/cli": "0.32.1-next.2",
+    "@backstage/core-app-api": "1.16.2-next.0",
+    "@backstage/test-utils": "1.7.8-next.1",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",