@backstage/frontend-plugin-api 0.13.1 → 0.13.2-next.0

package/dist/index.esm.js

@@ -1,12 +1,27 @@
 export { AnalyticsContext } from './analytics/AnalyticsContext.esm.js';
 export { useAnalytics } from './analytics/useAnalytics.esm.js';
 export { appTreeApiRef } from './apis/definitions/AppTreeApi.esm.js';
-export { SessionState, alertApiRef, appThemeApiRef, atlassianAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, configApiRef, createApiFactory, createApiRef, discoveryApiRef, errorApiRef, featureFlagsApiRef, fetchApiRef, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, identityApiRef, microsoftAuthApiRef, oauthRequestApiRef, oktaAuthApiRef, oneloginAuthApiRef, openshiftAuthApiRef, storageApiRef, useApi, useApiHolder, vmwareCloudAuthApiRef, withApis } from '@backstage/core-plugin-api';
+export { SessionState, atlassianAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, microsoftAuthApiRef, oktaAuthApiRef, oneloginAuthApiRef, openshiftAuthApiRef, vmwareCloudAuthApiRef } from './apis/definitions/auth.esm.js';
+export { alertApiRef } from './apis/definitions/AlertApi.esm.js';
+export { appLanguageApiRef } from './apis/definitions/AppLanguageApi.esm.js';
+export { appThemeApiRef } from './apis/definitions/AppThemeApi.esm.js';
 export { swappableComponentsApiRef } from './apis/definitions/SwappableComponentsApi.esm.js';
+export { configApiRef } from './apis/definitions/ConfigApi.esm.js';
+export { discoveryApiRef } from './apis/definitions/DiscoveryApi.esm.js';
+export { errorApiRef } from './apis/definitions/ErrorApi.esm.js';
+export { FeatureFlagState, featureFlagsApiRef } from './apis/definitions/FeatureFlagsApi.esm.js';
+export { fetchApiRef } from './apis/definitions/FetchApi.esm.js';
 export { iconsApiRef } from './apis/definitions/IconsApi.esm.js';
+export { identityApiRef } from './apis/definitions/IdentityApi.esm.js';
 export { dialogApiRef } from './apis/definitions/DialogApi.esm.js';
+export { oauthRequestApiRef } from './apis/definitions/OAuthRequestApi.esm.js';
 export { routeResolutionApiRef } from './apis/definitions/RouteResolutionApi.esm.js';
+export { storageApiRef } from './apis/definitions/StorageApi.esm.js';
 export { analyticsApiRef } from './apis/definitions/AnalyticsApi.esm.js';
+export { translationApiRef } from './apis/definitions/TranslationApi.esm.js';
+export { useApi, useApiHolder, withApis } from './apis/system/useApi.esm.js';
+export { createApiRef } from './apis/system/ApiRef.esm.js';
+export { createApiFactory } from './apis/system/helpers.esm.js';
 export { AnalyticsImplementationBlueprint } from './blueprints/AnalyticsImplementationBlueprint.esm.js';
 export { ApiBlueprint } from './blueprints/ApiBlueprint.esm.js';
 export { AppRootElementBlueprint } from './blueprints/AppRootElementBlueprint.esm.js';
@@ -29,7 +44,10 @@ export { createSubRouteRef } from './routing/SubRouteRef.esm.js';
 export { createExternalRouteRef } from './routing/ExternalRouteRef.esm.js';
 export { useRouteRef } from './routing/useRouteRef.esm.js';
 export { useRouteRefParams } from './routing/useRouteRefParams.esm.js';
-export { createTranslationMessages, createTranslationRef, createTranslationResource, useTranslationRef } from '@backstage/core-plugin-api/alpha';
+export { createTranslationMessages } from './translation/TranslationMessages.esm.js';
+export { createTranslationResource } from './translation/TranslationResource.esm.js';
+export { createTranslationRef } from './translation/TranslationRef.esm.js';
+export { useTranslationRef } from './translation/useTranslationRef.esm.js';
 export { coreExtensionData } from './wiring/coreExtensionData.esm.js';
 export { createExtension } from './wiring/createExtension.esm.js';
 export { createExtensionInput } from './wiring/createExtensionInput.esm.js';

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/routing/useRouteRef.esm.js

@@ -1,12 +1,25 @@
 import { useMemo } from 'react';
 import { useLocation } from 'react-router-dom';
 import '../apis/definitions/AppTreeApi.esm.js';
-import { useApi } from '@backstage/core-plugin-api';
+import '../apis/definitions/auth.esm.js';
+import '../apis/definitions/AlertApi.esm.js';
+import '../apis/definitions/AppLanguageApi.esm.js';
+import '../apis/definitions/AppThemeApi.esm.js';
 import '../apis/definitions/SwappableComponentsApi.esm.js';
+import '../apis/definitions/ConfigApi.esm.js';
+import '../apis/definitions/DiscoveryApi.esm.js';
+import '../apis/definitions/ErrorApi.esm.js';
+import '../apis/definitions/FeatureFlagsApi.esm.js';
+import '../apis/definitions/FetchApi.esm.js';
 import '../apis/definitions/IconsApi.esm.js';
+import '../apis/definitions/IdentityApi.esm.js';
 import '../apis/definitions/DialogApi.esm.js';
+import '../apis/definitions/OAuthRequestApi.esm.js';
 import { routeResolutionApiRef } from '../apis/definitions/RouteResolutionApi.esm.js';
+import '../apis/definitions/StorageApi.esm.js';
 import '../apis/definitions/AnalyticsApi.esm.js';
+import '../apis/definitions/TranslationApi.esm.js';
+import { useApi } from '../apis/system/useApi.esm.js';
 
 function useRouteRef(routeRef) {
   const { pathname } = useLocation();

package/dist/routing/useRouteRef.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useRouteRef.esm.js","sources":["../../src/routing/useRouteRef.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 { useMemo } from 'react';\nimport { useLocation } from 'react-router-dom';\nimport { AnyRouteRefParams } from './types';\nimport { RouteRef } from './RouteRef';\nimport { SubRouteRef } from './SubRouteRef';\nimport { ExternalRouteRef } from './ExternalRouteRef';\nimport { RouteFunc, routeResolutionApiRef, useApi } from '../apis';\n\n/**\n * React hook for constructing URLs to routes.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}\n *\n * @param routeRef - The ref to route that should be converted to URL.\n * @returns A function that will in turn return the concrete URL of the `routeRef`, or `undefined` if the route is not available.\n * @public\n */\nexport function useRouteRef<TParams extends AnyRouteRefParams>(\n  routeRef:\n    | RouteRef<TParams>\n    | SubRouteRef<TParams>\n    | ExternalRouteRef<TParams>,\n): RouteFunc<TParams> | undefined {\n  const { pathname } = useLocation();\n  const routeResolutionApi = useApi(routeResolutionApiRef);\n\n  const routeFunc = useMemo(\n    () => routeResolutionApi.resolve(routeRef, { sourcePath: pathname }),\n    [routeResolutionApi, routeRef, pathname],\n  );\n\n  return routeFunc;\n}\n"],"names":[],"mappings":";;;;;;;;;;AAmCO,SAAS,YACd,QAAA,EAIgC;AAChC,EAAA,MAAM,EAAE,QAAA,EAAS,GAAI,WAAA,EAAY;AACjC,EAAA,MAAM,kBAAA,GAAqB,OAAO,qBAAqB,CAAA;AAEvD,EAAA,MAAM,SAAA,GAAY,OAAA;AAAA,IAChB,MAAM,kBAAA,CAAmB,OAAA,CAAQ,UAAU,EAAE,UAAA,EAAY,UAAU,CAAA;AAAA,IACnE,CAAC,kBAAA,EAAoB,QAAA,EAAU,QAAQ;AAAA,GACzC;AAEA,EAAA,OAAO,SAAA;AACT;;;;"}
+{"version":3,"file":"useRouteRef.esm.js","sources":["../../src/routing/useRouteRef.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 { useMemo } from 'react';\nimport { useLocation } from 'react-router-dom';\nimport { AnyRouteRefParams } from './types';\nimport { RouteRef } from './RouteRef';\nimport { SubRouteRef } from './SubRouteRef';\nimport { ExternalRouteRef } from './ExternalRouteRef';\nimport { RouteFunc, routeResolutionApiRef, useApi } from '../apis';\n\n/**\n * React hook for constructing URLs to routes.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}\n *\n * @param routeRef - The ref to route that should be converted to URL.\n * @returns A function that will in turn return the concrete URL of the `routeRef`, or `undefined` if the route is not available.\n * @public\n */\nexport function useRouteRef<TParams extends AnyRouteRefParams>(\n  routeRef:\n    | RouteRef<TParams>\n    | SubRouteRef<TParams>\n    | ExternalRouteRef<TParams>,\n): RouteFunc<TParams> | undefined {\n  const { pathname } = useLocation();\n  const routeResolutionApi = useApi(routeResolutionApiRef);\n\n  const routeFunc = useMemo(\n    () => routeResolutionApi.resolve(routeRef, { sourcePath: pathname }),\n    [routeResolutionApi, routeRef, pathname],\n  );\n\n  return routeFunc;\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAmCO,SAAS,YACd,QAAA,EAIgC;AAChC,EAAA,MAAM,EAAE,QAAA,EAAS,GAAI,WAAA,EAAY;AACjC,EAAA,MAAM,kBAAA,GAAqB,OAAO,qBAAqB,CAAA;AAEvD,EAAA,MAAM,SAAA,GAAY,OAAA;AAAA,IAChB,MAAM,kBAAA,CAAmB,OAAA,CAAQ,UAAU,EAAE,UAAA,EAAY,UAAU,CAAA;AAAA,IACnE,CAAC,kBAAA,EAAoB,QAAA,EAAU,QAAQ;AAAA,GACzC;AAEA,EAAA,OAAO,SAAA;AACT;;;;"}

package/dist/translation/TranslationMessages.esm.js

@@ -0,0 +1,11 @@
+function createTranslationMessages(options) {
+  return {
+    $$type: "@backstage/TranslationMessages",
+    id: options.ref.id,
+    full: Boolean(options.full),
+    messages: options.messages
+  };
+}
+
+export { createTranslationMessages };
+//# sourceMappingURL=TranslationMessages.esm.js.map

package/dist/translation/TranslationMessages.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationMessages.esm.js","sources":["../../src/translation/TranslationMessages.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 './TranslationRef';\n\n/**\n * Represents a collection of messages to be provided for a given translation ref.\n *\n * @public\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 * @public\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 * @public\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"],"names":[],"mappings":"AAkEO,SAAS,0BAKd,OAAA,EAC4C;AAC5C,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,gCAAA;AAAA,IACR,EAAA,EAAI,QAAQ,GAAA,CAAI,EAAA;AAAA,IAChB,IAAA,EAAM,OAAA,CAAQ,OAAA,CAAQ,IAAI,CAAA;AAAA,IAC1B,UAAU,OAAA,CAAQ;AAAA,GACpB;AACF;;;;"}

package/dist/translation/TranslationRef.esm.js

@@ -0,0 +1,62 @@
+import { createTranslationResource } from './TranslationResource.esm.js';
+
+function flattenMessages(nested) {
+  const entries = new Array();
+  function visit(obj, prefix) {
+    for (const [key, value] of Object.entries(obj)) {
+      if (typeof value === "string") {
+        entries.push([prefix + key, value]);
+      } else {
+        visit(value, `${prefix}${key}.`);
+      }
+    }
+  }
+  visit(nested, "");
+  return Object.fromEntries(entries);
+}
+class TranslationRefImpl {
+  #id;
+  #messages;
+  #resources;
+  constructor(options) {
+    this.#id = options.id;
+    this.#messages = flattenMessages(
+      options.messages
+    );
+  }
+  $$type = "@backstage/TranslationRef";
+  version = "v1";
+  get id() {
+    return this.#id;
+  }
+  get T() {
+    throw new Error("Not implemented");
+  }
+  getDefaultMessages() {
+    return this.#messages;
+  }
+  setDefaultResource(resources) {
+    this.#resources = resources;
+  }
+  getDefaultResource() {
+    return this.#resources;
+  }
+  toString() {
+    return `TranslationRef{id=${this.id}}`;
+  }
+}
+function createTranslationRef(config) {
+  const ref = new TranslationRefImpl(config);
+  if (config.translations) {
+    ref.setDefaultResource(
+      createTranslationResource({
+        ref,
+        translations: config.translations
+      })
+    );
+  }
+  return ref;
+}
+
+export { createTranslationRef };
+//# sourceMappingURL=TranslationRef.esm.js.map

package/dist/translation/TranslationRef.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationRef.esm.js","sources":["../../src/translation/TranslationRef.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  createTranslationResource,\n  TranslationResource,\n} from './TranslationResource';\n\n/** @public */\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/** @ignore */\ntype AnyNestedMessages = { [key in string]: AnyNestedMessages | string };\n\n/**\n * Flattens a nested message declaration into a flat object with dot-separated keys.\n *\n * @ignore\n */\ntype FlattenedMessages<TMessages extends AnyNestedMessages> =\n  // Flatten out object keys into a union structure of objects, e.g. { a: 'a', b: 'b' } -> { a: 'a' } | { b: 'b' }\n  // Any nested object will be flattened into the individual unions, e.g. { a: 'a', b: { x: 'x', y: 'y' } } -> { a: 'a' } | { 'b.x': 'x', 'b.y': 'y' }\n  // We create this structure by first nesting the desired union types into the original object, and\n  // then extract them by indexing with `keyof TMessages` to form the union.\n  // Throughout this the objects are wrapped up in a function parameter, which allows us to have the\n  // final step of flipping this unions around to an intersection by inferring the function parameter.\n  {\n    [TKey in keyof TMessages]: (\n      _: TMessages[TKey] extends infer TValue // \"local variable\" for the value\n        ? TValue extends AnyNestedMessages\n          ? FlattenedMessages<TValue> extends infer TNested // Recurse into nested messages, \"local variable\" for the result\n            ? {\n                [TNestedKey in keyof TNested as `${TKey & string}.${TNestedKey &\n                  string}`]: TNested[TNestedKey];\n              }\n            : never\n          : { [_ in TKey]: TValue } // Primitive object values are passed through with the same key\n        : never,\n    ) => void;\n    // The `[keyof TMessages]` extracts the object values union from our flattened structure, still wrapped up in function parameters.\n    // The `extends (_: infer TIntersection) => void` flips the union to an intersection, at which point we have the correct type.\n  }[keyof TMessages] extends (_: infer TIntersection) => void\n    ? // This object mapping just expands similar to the Expand<> utility type, providing nicer type hints\n      {\n        readonly [TExpandKey in keyof TIntersection]: TIntersection[TExpandKey];\n      }\n    : never;\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/** @public */\nexport interface TranslationRefOptions<\n  TId extends string,\n  TNestedMessages extends AnyNestedMessages,\n  TTranslations extends {\n    [language in string]: () => Promise<{\n      default: {\n        [key in keyof FlattenedMessages<TNestedMessages>]: string | null;\n      };\n    }>;\n  },\n> {\n  id: TId;\n  messages: TNestedMessages;\n  translations?: TTranslations;\n}\n\nfunction flattenMessages(nested: AnyNestedMessages): AnyMessages {\n  const entries = new Array<[string, string]>();\n\n  function visit(obj: AnyNestedMessages, prefix: string): void {\n    for (const [key, value] of Object.entries(obj)) {\n      if (typeof value === 'string') {\n        entries.push([prefix + key, value]);\n      } else {\n        visit(value, `${prefix}${key}.`);\n      }\n    }\n  }\n\n  visit(nested, '');\n\n  return Object.fromEntries(entries);\n}\n\n/** @internal */\nclass TranslationRefImpl<\n  TId extends string,\n  TNestedMessages extends AnyNestedMessages,\n> implements InternalTranslationRef<TId, FlattenedMessages<TNestedMessages>>\n{\n  #id: TId;\n  #messages: FlattenedMessages<TNestedMessages>;\n  #resources: TranslationResource | undefined;\n\n  constructor(options: TranslationRefOptions<TId, TNestedMessages, any>) {\n    this.#id = options.id;\n    this.#messages = flattenMessages(\n      options.messages,\n    ) as FlattenedMessages<TNestedMessages>;\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/** @public */\nexport function createTranslationRef<\n  TId extends string,\n  const TNestedMessages extends AnyNestedMessages,\n  TTranslations extends {\n    [language in string]: () => Promise<{\n      default: {\n        [key in keyof FlattenedMessages<TNestedMessages>]: string | null;\n      };\n    }>;\n  },\n>(\n  config: TranslationRefOptions<TId, TNestedMessages, TTranslations>,\n): TranslationRef<TId, FlattenedMessages<TNestedMessages>> {\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 AnyMessages,\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"],"names":[],"mappings":";;AAsGA,SAAS,gBAAgB,MAAA,EAAwC;AAC/D,EAAA,MAAM,OAAA,GAAU,IAAI,KAAA,EAAwB;AAE5C,EAAA,SAAS,KAAA,CAAM,KAAwB,MAAA,EAAsB;AAC3D,IAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,GAAG,CAAA,EAAG;AAC9C,MAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,QAAA,OAAA,CAAQ,IAAA,CAAK,CAAC,MAAA,GAAS,GAAA,EAAK,KAAK,CAAC,CAAA;AAAA,MACpC,CAAA,MAAO;AACL,QAAA,KAAA,CAAM,KAAA,EAAO,CAAA,EAAG,MAAM,CAAA,EAAG,GAAG,CAAA,CAAA,CAAG,CAAA;AAAA,MACjC;AAAA,IACF;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,QAAQ,EAAE,CAAA;AAEhB,EAAA,OAAO,MAAA,CAAO,YAAY,OAAO,CAAA;AACnC;AAGA,MAAM,kBAAA,CAIN;AAAA,EACE,GAAA;AAAA,EACA,SAAA;AAAA,EACA,UAAA;AAAA,EAEA,YAAY,OAAA,EAA2D;AACrE,IAAA,IAAA,CAAK,MAAM,OAAA,CAAQ,EAAA;AACnB,IAAA,IAAA,CAAK,SAAA,GAAY,eAAA;AAAA,MACf,OAAA,CAAQ;AAAA,KACV;AAAA,EACF;AAAA,EAEA,MAAA,GAAS,2BAAA;AAAA,EAET,OAAA,GAAU,IAAA;AAAA,EAEV,IAAI,EAAA,GAAU;AACZ,IAAA,OAAO,IAAA,CAAK,GAAA;AAAA,EACd;AAAA,EAEA,IAAI,CAAA,GAAW;AACb,IAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,EACnC;AAAA,EAEA,kBAAA,GAAkC;AAChC,IAAA,OAAO,IAAA,CAAK,SAAA;AAAA,EACd;AAAA,EAEA,mBAAmB,SAAA,EAAsC;AACvD,IAAA,IAAA,CAAK,UAAA,GAAa,SAAA;AAAA,EACpB;AAAA,EAEA,kBAAA,GAAsD;AACpD,IAAA,OAAO,IAAA,CAAK,UAAA;AAAA,EACd;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,OAAO,CAAA,kBAAA,EAAqB,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,EACrC;AACF;AAGO,SAAS,qBAWd,MAAA,EACyD;AACzD,EAAA,MAAM,GAAA,GAAM,IAAI,kBAAA,CAAmB,MAAM,CAAA;AACzC,EAAA,IAAI,OAAO,YAAA,EAAc;AACvB,IAAA,GAAA,CAAI,kBAAA;AAAA,MACF,yBAAA,CAA0B;AAAA,QACxB,GAAA;AAAA,QACA,cAAc,MAAA,CAAO;AAAA,OACtB;AAAA,KACH;AAAA,EACF;AACA,EAAA,OAAO,GAAA;AACT;;;;"}

package/dist/translation/TranslationResource.esm.js

@@ -0,0 +1,21 @@
+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?.$$type === "@backstage/TranslationMessages" ? value.messages : value
+          };
+        })
+      })
+    )
+  };
+}
+
+export { createTranslationResource };
+//# sourceMappingURL=TranslationResource.esm.js.map

package/dist/translation/TranslationResource.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationResource.esm.js","sources":["../../src/translation/TranslationResource.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 { TranslationMessages } from './TranslationMessages';\nimport { TranslationRef } from './TranslationRef';\n\n/** @public */\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/** @public */\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/** @public */\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"],"names":[],"mappings":"AAyEO,SAAS,0BAWd,OAAA,EAC0B;AAC1B,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,gCAAA;AAAA,IACR,OAAA,EAAS,IAAA;AAAA,IACT,EAAA,EAAI,QAAQ,GAAA,CAAI,EAAA;AAAA,IAChB,SAAA,EAAW,MAAA,CAAO,OAAA,CAAQ,OAAA,CAAQ,YAAY,CAAA,CAAE,GAAA;AAAA,MAC9C,CAAC,CAAC,QAAA,EAAU,MAAM,CAAA,MAAO;AAAA,QACvB,QAAA;AAAA,QACA,MAAA,EAAQ,MACN,MAAA,EAAO,CAAE,KAAK,CAAA,CAAA,KAAK;AACjB,UAAA,MAAM,QAAQ,CAAA,CAAE,OAAA;AAChB,UAAA,OAAO;AAAA,YACL,QAAA,EACE,KAAA,EAAO,MAAA,KAAW,gCAAA,GACd,MAAM,QAAA,GACN;AAAA,WACR;AAAA,QACF,CAAC;AAAA,OACL;AAAA;AACF,GACF;AACF;;;;"}

package/dist/translation/useTranslationRef.esm.js

@@ -0,0 +1,89 @@
+import { useState, useMemo, useCallback, useEffect, useRef } from 'react';
+import '../apis/definitions/AppTreeApi.esm.js';
+import '../apis/definitions/auth.esm.js';
+import '../apis/definitions/AlertApi.esm.js';
+import '../apis/definitions/AppLanguageApi.esm.js';
+import '../apis/definitions/AppThemeApi.esm.js';
+import '../apis/definitions/SwappableComponentsApi.esm.js';
+import '../apis/definitions/ConfigApi.esm.js';
+import '../apis/definitions/DiscoveryApi.esm.js';
+import { errorApiRef } from '../apis/definitions/ErrorApi.esm.js';
+import '../apis/definitions/FeatureFlagsApi.esm.js';
+import '../apis/definitions/FetchApi.esm.js';
+import '../apis/definitions/IconsApi.esm.js';
+import '../apis/definitions/IdentityApi.esm.js';
+import '../apis/definitions/DialogApi.esm.js';
+import '../apis/definitions/OAuthRequestApi.esm.js';
+import '../apis/definitions/RouteResolutionApi.esm.js';
+import '../apis/definitions/StorageApi.esm.js';
+import '../apis/definitions/AnalyticsApi.esm.js';
+import { translationApiRef } from '../apis/definitions/TranslationApi.esm.js';
+import { useApi } from '../apis/system/useApi.esm.js';
+
+const loggedRefs = /* @__PURE__ */ new WeakSet();
+const useTranslationRef = (translationRef) => {
+  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 { useTranslationRef };
+//# sourceMappingURL=useTranslationRef.esm.js.map

package/dist/translation/useTranslationRef.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTranslationRef.esm.js","sources":["../../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 { useCallback, useEffect, useMemo, useRef, useState } from 'react';\nimport { errorApiRef, useApi } from '../apis';\nimport {\n  translationApiRef,\n  TranslationFunction,\n  TranslationSnapshot,\n} from '../apis/definitions/TranslationApi';\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/** @public */\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":";;;;;;;;;;;;;;;;;;;;;;AA0BA,MAAM,UAAA,uBAAiB,OAAA,EAAoC;AAGpD,MAAM,iBAAA,GAAoB,CAG/B,cAAA,KAC0C;AAC1C,EAAA,MAAM,QAAA,GAAW,OAAO,WAAW,CAAA;AACnC,EAAA,MAAM,cAAA,GAAiB,OAAO,iBAAiB,CAAA;AAE/C,EAAA,MAAM,CAAC,QAAA,EAAU,WAAW,CAAA,GAAI,QAAA;AAAA,IAAyC,MACvE,cAAA,CAAe,cAAA,CAAe,cAAc;AAAA,GAC9C;AACA,EAAA,MAAM,UAAA,GAAa,OAAA;AAAA,IACjB,MAAM,cAAA,CAAe,YAAA,CAAa,cAAc,CAAA;AAAA,IAChD,CAAC,gBAAgB,cAAc;AAAA,GACjC;AAEA,EAAA,MAAM,OAAA,GAAU,WAAA;AAAA,IACd,CAAC,KAAA,KAAiB;AAChB,MAAA,IAAI,CAAC,UAAA,CAAW,GAAA,CAAI,cAAc,CAAA,EAAG;AACnC,QAAA,MAAM,MAAA,GAAS,CAAA,qCAAA,EAAwC,cAAA,CAAe,EAAE,gBAAgB,KAAK,CAAA,CAAA;AAE7F,QAAA,OAAA,CAAQ,MAAM,MAAM,CAAA;AACpB,QAAA,QAAA,CAAS,IAAA,CAAK,IAAI,KAAA,CAAM,MAAM,CAAC,CAAA;AAC/B,QAAA,UAAA,CAAW,IAAI,cAAc,CAAA;AAAA,MAC/B;AAAA,IACF,CAAA;AAAA,IACA,CAAC,UAAU,cAAc;AAAA,GAC3B;AAEA,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,YAAA,GAAe,WAAW,SAAA,CAAU;AAAA,MACxC,KAAK,IAAA,EAAM;AACT,QAAA,IAAI,KAAK,KAAA,EAAO;AACd,UAAA,WAAA,CAAY,IAAI,CAAA;AAAA,QAClB;AAAA,MACF,CAAA;AAAA,MACA,MAAM,KAAA,EAAO;AACX,QAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,MACf;AAAA,KACD,CAAA;AAED,IAAA,OAAO,MAAM;AACX,MAAA,YAAA,CAAa,WAAA,EAAY;AAAA,IAC3B,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,UAAA,EAAY,OAAO,CAAC,CAAA;AAGxB,EAAA,MAAM,gBAAA,GAAmB,OAAO,IAAI,CAAA;AACpC,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,iBAAiB,OAAA,EAAS;AAC5B,MAAA,gBAAA,CAAiB,OAAA,GAAU,KAAA;AAAA,IAC7B,CAAA,MAAO;AACL,MAAA,WAAA,CAAY,cAAA,CAAe,cAAA,CAAe,cAAc,CAAC,CAAA;AAAA,IAC3D;AAAA,EACF,CAAA,EAAG,CAAC,cAAA,EAAgB,cAAc,CAAC,CAAA;AAEnC,EAAA,IAAI,CAAC,SAAS,KAAA,EAAO;AACnB,IAAA,MAAM,IAAI,QAAc,CAAA,OAAA,KAAW;AACjC,MAAA,MAAM,YAAA,GAAe,WAAW,SAAA,CAAU;AAAA,QACxC,KAAK,IAAA,EAAM;AACT,UAAA,IAAI,KAAK,KAAA,EAAO;AACd,YAAA,YAAA,CAAa,WAAA,EAAY;AACzB,YAAA,OAAA,EAAQ;AAAA,UACV;AAAA,QACF,CAAA;AAAA,QACA,MAAM,KAAA,EAAO;AACX,UAAA,YAAA,CAAa,WAAA,EAAY;AACzB,UAAA,OAAA,CAAQ,KAAK,CAAA;AACb,UAAA,OAAA,EAAQ;AAAA,QACV;AAAA,OACD,CAAA;AAAA,IACH,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,EAAE,CAAA,EAAG,QAAA,CAAS,CAAA,EAAE;AACzB;;;;"}

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@backstage/frontend-plugin-api",
-  "version": "0.13.1",
+  "version": "0.13.2-next.0",
   "backstage": {
     "role": "web-library"
   },
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
   },
   "repository": {
     "type": "git",
@@ -16,8 +14,23 @@
   },
   "license": "Apache-2.0",
   "sideEffects": false,
-  "main": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  },
   "files": [
     "dist"
   ],
@@ -31,20 +44,21 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-components": "^0.18.3",
-    "@backstage/core-plugin-api": "^1.12.0",
-    "@backstage/types": "^1.2.2",
-    "@backstage/version-bridge": "^1.0.11",
+    "@backstage/config": "1.3.6",
+    "@backstage/core-components": "0.18.4-next.0",
+    "@backstage/errors": "1.2.7",
+    "@backstage/types": "1.2.2",
+    "@backstage/version-bridge": "1.0.11",
     "@material-ui/core": "^4.12.4",
     "lodash": "^4.17.21",
     "zod": "^3.22.4",
     "zod-to-json-schema": "^3.21.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.34.5",
-    "@backstage/frontend-app-api": "^0.13.2",
-    "@backstage/frontend-test-utils": "^0.4.1",
-    "@backstage/test-utils": "^1.7.13",
+    "@backstage/cli": "0.34.6-next.0",
+    "@backstage/frontend-app-api": "0.13.3-next.0",
+    "@backstage/frontend-test-utils": "0.4.2-next.0",
+    "@backstage/test-utils": "1.7.14-next.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",
@@ -64,12 +78,5 @@
       "optional": true
     }
   },
-  "typesVersions": {
-    "*": {
-      "package.json": [
-        "package.json"
-      ]
-    }
-  },
   "module": "./dist/index.esm.js"
 }