@backstage/core-compat-api 0.5.9-next.1 → 0.5.9-next.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/core-compat-api
 
+## 0.5.9-next.2
+
+### Patch Changes
+
+- b15a685: Added `withApis`, which is a Higher-Order Component for providing APIs as props to a component via `useApiHolder`.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.15.0-next.1
+  - @backstage/core-plugin-api@1.12.4-next.1
+  - @backstage/plugin-catalog-react@2.1.0-next.2
+  - @backstage/plugin-app-react@0.2.1-next.1
+
 ## 0.5.9-next.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode, JSX, ComponentType } from 'react';
+import { ReactNode, JSX, ComponentType, PropsWithChildren } from 'react';
 import { AnalyticsApi, AnalyticsEvent, AnyApiFactory, IconComponent, BackstagePlugin, AppComponents, AppTheme, FeatureFlag, AnyRouteRefParams, RouteRef, SubRouteRef, ExternalRouteRef } from '@backstage/core-plugin-api';
-import { AnalyticsApi as AnalyticsApi$1, AnalyticsEvent as AnalyticsEvent$1, FrontendPlugin, FrontendModule, ExtensionDefinition, RouteRef as RouteRef$1, SubRouteRef as SubRouteRef$1, ExternalRouteRef as ExternalRouteRef$1 } from '@backstage/frontend-plugin-api';
+import { AnalyticsApi as AnalyticsApi$1, AnalyticsEvent as AnalyticsEvent$1, FrontendPlugin, FrontendModule, ExtensionDefinition, RouteRef as RouteRef$1, SubRouteRef as SubRouteRef$1, ExternalRouteRef as ExternalRouteRef$1, TypesToApiRefs } from '@backstage/frontend-plugin-api';
 
 /**
  * Wraps a React element in a bidirectional compatibility provider, allow APIs
@@ -201,5 +201,16 @@ declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: S
  */
 declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: ExternalRouteRef$1<TParams>): ExternalRouteRef<TParams, true>;
 
-export { MultipleAnalyticsApi, NoOpAnalyticsApi, compatWrapper, convertLegacyApp, convertLegacyAppOptions, convertLegacyAppRoot, convertLegacyPageExtension, convertLegacyPlugin, convertLegacyRouteRef, convertLegacyRouteRefs };
+/**
+ * Wrapper for giving component an API context.
+ *
+ * @param apis - APIs for the context.
+ * @public
+ */
+declare function withApis<T extends {}>(apis: TypesToApiRefs<T>): <TProps extends T>(WrappedComponent: ComponentType<TProps>) => {
+    (props: PropsWithChildren<Omit<TProps, keyof T>>): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+export { MultipleAnalyticsApi, NoOpAnalyticsApi, compatWrapper, convertLegacyApp, convertLegacyAppOptions, convertLegacyAppRoot, convertLegacyPageExtension, convertLegacyPlugin, convertLegacyRouteRef, convertLegacyRouteRefs, withApis };
 export type { ConvertLegacyAppOptions, ConvertLegacyAppRootOptions, ToNewRouteRef };

package/dist/index.esm.js

@@ -6,4 +6,5 @@ export { convertLegacyAppOptions } from './convertLegacyAppOptions.esm.js';
 export { convertLegacyPlugin } from './convertLegacyPlugin.esm.js';
 export { convertLegacyPageExtension } from './convertLegacyPageExtension.esm.js';
 export { convertLegacyRouteRef, convertLegacyRouteRefs } from './convertLegacyRouteRef.esm.js';
+export { withApis } from './withApis.esm.js';
 //# sourceMappingURL=index.esm.js.map

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/withApis.esm.js

@@ -0,0 +1,31 @@
+import { jsx } from 'react/jsx-runtime';
+import { useApiHolder } from '@backstage/frontend-plugin-api';
+import { NotImplementedError } from '@backstage/errors';
+
+function withApis(apis) {
+  return function withApisWrapper(WrappedComponent) {
+    const Hoc = (props) => {
+      const apiHolder = useApiHolder();
+      const impls = {};
+      for (const key in apis) {
+        if (Object.hasOwn(apis, key)) {
+          const ref = apis[key];
+          const api = apiHolder.get(ref);
+          if (!api) {
+            throw new NotImplementedError(
+              `No implementation available for ${ref}`
+            );
+          }
+          impls[key] = api;
+        }
+      }
+      return /* @__PURE__ */ jsx(WrappedComponent, { ...props, ...impls });
+    };
+    const displayName = WrappedComponent.displayName || WrappedComponent.name || "Component";
+    Hoc.displayName = `withApis(${displayName})`;
+    return Hoc;
+  };
+}
+
+export { withApis };
+//# sourceMappingURL=withApis.esm.js.map

package/dist/withApis.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withApis.esm.js","sources":["../src/withApis.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 { ComponentType, PropsWithChildren } from 'react';\nimport { TypesToApiRefs, useApiHolder } from '@backstage/frontend-plugin-api';\nimport { NotImplementedError } from '@backstage/errors';\n\n/**\n * Wrapper for giving component an API context.\n *\n * @param apis - APIs for the context.\n * @public\n */\nexport function withApis<T extends {}>(apis: TypesToApiRefs<T>) {\n  return function withApisWrapper<TProps extends T>(\n    WrappedComponent: ComponentType<TProps>,\n  ) {\n    const Hoc = (props: PropsWithChildren<Omit<TProps, keyof T>>) => {\n      const apiHolder = useApiHolder();\n\n      const impls = {} as T;\n\n      for (const key in apis) {\n        if (Object.hasOwn(apis, key)) {\n          const ref = apis[key];\n\n          const api = apiHolder.get(ref);\n          if (!api) {\n            throw new NotImplementedError(\n              `No implementation available for ${ref}`,\n            );\n          }\n          impls[key] = api;\n        }\n      }\n\n      return <WrappedComponent {...(props as TProps)} {...impls} />;\n    };\n    const displayName =\n      WrappedComponent.displayName || WrappedComponent.name || 'Component';\n\n    Hoc.displayName = `withApis(${displayName})`;\n\n    return Hoc;\n  };\n}\n"],"names":[],"mappings":";;;;AA0BO,SAAS,SAAuB,IAAA,EAAyB;AAC9D,EAAA,OAAO,SAAS,gBACd,gBAAA,EACA;AACA,IAAA,MAAM,GAAA,GAAM,CAAC,KAAA,KAAoD;AAC/D,MAAA,MAAM,YAAY,YAAA,EAAa;AAE/B,MAAA,MAAM,QAAQ,EAAC;AAEf,MAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,QAAA,IAAI,MAAA,CAAO,MAAA,CAAO,IAAA,EAAM,GAAG,CAAA,EAAG;AAC5B,UAAA,MAAM,GAAA,GAAM,KAAK,GAAG,CAAA;AAEpB,UAAA,MAAM,GAAA,GAAM,SAAA,CAAU,GAAA,CAAI,GAAG,CAAA;AAC7B,UAAA,IAAI,CAAC,GAAA,EAAK;AACR,YAAA,MAAM,IAAI,mBAAA;AAAA,cACR,mCAAmC,GAAG,CAAA;AAAA,aACxC;AAAA,UACF;AACA,UAAA,KAAA,CAAM,GAAG,CAAA,GAAI,GAAA;AAAA,QACf;AAAA,MACF;AAEA,MAAA,uBAAO,GAAA,CAAC,gBAAA,EAAA,EAAkB,GAAI,KAAA,EAAmB,GAAG,KAAA,EAAO,CAAA;AAAA,IAC7D,CAAA;AACA,IAAA,MAAM,WAAA,GACJ,gBAAA,CAAiB,WAAA,IAAe,gBAAA,CAAiB,IAAA,IAAQ,WAAA;AAE3D,IAAA,GAAA,CAAI,WAAA,GAAc,YAAY,WAAW,CAAA,CAAA,CAAA;AAEzC,IAAA,OAAO,GAAA;AAAA,EACT,CAAA;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/core-compat-api",
-  "version": "0.5.9-next.1",
+  "version": "0.5.9-next.2",
   "backstage": {
     "role": "web-library"
   },
@@ -31,21 +31,22 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-plugin-api": "1.12.4-next.0",
-    "@backstage/frontend-plugin-api": "0.14.2-next.0",
-    "@backstage/plugin-app-react": "0.2.1-next.0",
-    "@backstage/plugin-catalog-react": "2.1.0-next.1",
+    "@backstage/core-plugin-api": "1.12.4-next.1",
+    "@backstage/errors": "1.2.7",
+    "@backstage/frontend-plugin-api": "0.15.0-next.1",
+    "@backstage/plugin-app-react": "0.2.1-next.1",
+    "@backstage/plugin-catalog-react": "2.1.0-next.2",
     "@backstage/types": "1.2.2",
     "@backstage/version-bridge": "1.0.12",
     "lodash": "^4.17.21",
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.0-next.1",
-    "@backstage/core-app-api": "1.19.6-next.0",
-    "@backstage/frontend-app-api": "0.15.1-next.0",
-    "@backstage/frontend-test-utils": "0.5.1-next.1",
-    "@backstage/plugin-catalog": "1.34.0-next.1",
+    "@backstage/cli": "0.36.0-next.2",
+    "@backstage/core-app-api": "1.19.6-next.1",
+    "@backstage/frontend-app-api": "0.16.0-next.1",
+    "@backstage/frontend-test-utils": "0.5.1-next.2",
+    "@backstage/plugin-catalog": "2.0.0-next.2",
     "@backstage/test-utils": "1.7.16-next.0",
     "@backstage/types": "1.2.2",
     "@testing-library/jest-dom": "^6.0.0",