@backstage/core-app-api 1.1.0-next.1 → 1.1.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @backstage/core-app-api
 
+## 1.1.0-next.2
+
+### Patch Changes
+
+- f9ec4e46e3: When using React Router v6 stable, it is now possible for components within the `Route` element tree to have `path` props, although they will be ignored.
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- e9d40ebf54: If you'd like to send analytics events to multiple implementations, you may now
+  do so using the `MultipleAnalyticsApi` implementation provided by this package.
+
+  ```tsx
+  import { MultipleAnalyticsApi } from '@backstage/core-app-api';
+  import {
+    analyticsApiRef,
+    configApiRef,
+    storageApiRef,
+    identityApiRef,
+  } from '@internal/backstage/core-plugin-api';
+  import { CustomAnalyticsApi } from '@internal/analytics';
+  import { VendorAnalyticsApi } from '@vendor/analytics';
+
+  createApiFactory({
+    api: analyticsApiRef,
+    deps: { configApi: configApiRef, identityApi: identityApiRef, storageApi: storageApiRef },
+    factory: ({ configApi, identityApi, storageApi }) =>
+      MultipleAnalyticsApi.fromApis([
+        VendorAnalyticsApi.fromConfig(configApi, { identityApi }),
+        CustomAnalyticsApi.fromConfig(configApi, { identityApi, storageApi }),
+      ]),
+  }),
+  ```
+
+- Updated dependencies
+  - @backstage/core-plugin-api@1.0.6-next.2
+
 ## 1.1.0-next.1
 
 ### Minor Changes

package/dist/index.d.ts

@@ -276,6 +276,49 @@ declare class AlertApiForwarder implements AlertApi {
     alert$(): Observable<AlertMessage>;
 }
 
+/**
+ * An implementation of the AnalyticsApi that can be used to forward analytics
+ * events to multiple concrete implementations.
+ *
+ * @public
+ *
+ * @example
+ *
+ * ```jsx
+ * createApiFactory({
+ *   api: analyticsApiRef,
+ *   deps: { configApi: configApiRef, identityApi: identityApiRef, storageApi: storageApiRef },
+ *   factory: ({ configApi, identityApi, storageApi }) =>
+ *     MultipleAnalyticsApi.fromApis([
+ *       VendorAnalyticsApi.fromConfig(configApi, { identityApi }),
+ *       CustomAnalyticsApi.fromConfig(configApi, { identityApi, storageApi }),
+ *     ]),
+ * });
+ * ```
+ */
+declare class MultipleAnalyticsApi implements AnalyticsApi {
+    private readonly actualApis;
+    private constructor();
+    /**
+     * Create an AnalyticsApi implementation from an array of concrete
+     * implementations.
+     *
+     * @example
+     *
+     * ```jsx
+     * MultipleAnalyticsApi.fromApis([
+     *   SomeAnalyticsApi.fromConfig(configApi),
+     *   new CustomAnalyticsApi(),
+     * ]);
+     * ```
+     */
+    static fromApis(actualApis: AnalyticsApi[]): MultipleAnalyticsApi;
+    /**
+     * Forward the event to all configured analytics API implementations.
+     */
+    captureEvent(event: AnalyticsEvent): void;
+}
+
 /**
  * Base implementation for the AnalyticsApi that does nothing.
  *
@@ -859,4 +902,4 @@ declare type FeatureFlaggedProps = {
  */
 declare const FeatureFlagged: (props: FeatureFlaggedProps) => JSX.Element;
 
-export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppThemeSelector, AtlassianAuth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, SamlAuth, SignInPageProps, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
+export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppThemeSelector, AtlassianAuth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, MultipleAnalyticsApi, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, SamlAuth, SignInPageProps, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };

package/dist/index.esm.js

@@ -1172,6 +1172,23 @@ class AlertApiForwarder {
   }
 }
 
+class MultipleAnalyticsApi {
+  constructor(actualApis) {
+    this.actualApis = actualApis;
+  }
+  static fromApis(actualApis) {
+    return new MultipleAnalyticsApi(actualApis);
+  }
+  captureEvent(event) {
+    this.actualApis.forEach((analyticsApi) => {
+      try {
+        analyticsApi.captureEvent(event);
+      } catch {
+      }
+    });
+  }
+}
+
 class NoOpAnalyticsApi {
   captureEvent(_event) {
   }
@@ -1762,11 +1779,6 @@ function collectSubTree(node, entries = new Array()) {
     if (!isValidElement(element)) {
       return;
     }
-    if (element.props.path) {
-      throw new Error(
-        `Elements within the element prop tree may not have paths, found "${element.props.path}"`
-      );
-    }
     const routeRef = getComponentData(element, "core.mountPoint");
     if (routeRef) {
       const plugin = getComponentData(element, "core.plugin");
@@ -1784,6 +1796,12 @@ const routingV2Collector = createCollector(
   }),
   (acc, node, parent, ctx) => {
     var _a, _b, _c, _d, _e, _f;
+    if (ctx == null ? void 0 : ctx.isElementAncestor) {
+      return ctx;
+    }
+    if ((parent == null ? void 0 : parent.props.element) === node) {
+      return { ...ctx, isElementAncestor: true };
+    }
     const pathProp = (_a = node.props) == null ? void 0 : _a.path;
     const mountPoint = getComponentData(node, "core.mountPoint");
     if (mountPoint && pathProp) {
@@ -1793,12 +1811,6 @@ const routingV2Collector = createCollector(
         )}"`
       );
     }
-    if (ctx == null ? void 0 : ctx.isElementAncestor) {
-      return ctx;
-    }
-    if ((parent == null ? void 0 : parent.props.element) === node) {
-      return { ...ctx, isElementAncestor: true };
-    }
     const parentChildren = (_c = (_b = ctx == null ? void 0 : ctx.obj) == null ? void 0 : _b.children) != null ? _c : acc.objects;
     if (pathProp !== void 0) {
       if (typeof pathProp !== "string") {
@@ -2867,5 +2879,5 @@ const FlatRoutes = (props) => {
   return useRoutes(withNotFound);
 };
 
-export { AlertApiForwarder, ApiFactoryRegistry, ApiProvider, ApiResolver, AppThemeSelector, AtlassianAuth, BitbucketAuth, ErrorAlerter, ErrorApiForwarder, FeatureFlagged, FetchMiddlewares, FlatRoutes, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, NoOpAnalyticsApi, OAuth2, OAuthRequestManager, OktaAuth, OneLoginAuth, SamlAuth, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
+export { AlertApiForwarder, ApiFactoryRegistry, ApiProvider, ApiResolver, AppThemeSelector, AtlassianAuth, BitbucketAuth, ErrorAlerter, ErrorApiForwarder, FeatureFlagged, FetchMiddlewares, FlatRoutes, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, MultipleAnalyticsApi, NoOpAnalyticsApi, OAuth2, OAuthRequestManager, OktaAuth, OneLoginAuth, SamlAuth, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
 //# sourceMappingURL=index.esm.js.map