@backstage/frontend-test-utils 0.4.6-next.1 → 0.5.0-next.2

package/dist/index.esm.js

@@ -1,7 +1,9 @@
-export { MockConfigApi, MockErrorApi, MockFetchApi, MockPermissionApi, MockStorageApi, mockApis, registerMswTestHooks, withLogCollector } from '@backstage/test-utils';
-export { MockAnalyticsApi } from './apis/AnalyticsApi/MockAnalyticsApi.esm.js';
+export { mockApis } from './apis/mockApis.esm.js';
+export { createApiMock } from './apis/createApiMock.esm.js';
+export { attachMockApiFactory } from './apis/MockWithApiFactory.esm.js';
+export { TestApiProvider } from './apis/TestApiProvider.esm.js';
 export { createExtensionTester } from './app/createExtensionTester.esm.js';
 export { renderInTestApp } from './app/renderInTestApp.esm.js';
 export { renderTestApp } from './app/renderTestApp.esm.js';
-export { TestApiProvider, TestApiRegistry } from './utils/TestApiProvider.esm.js';
+export { registerMswTestHooks, withLogCollector } from '@backstage/test-utils';
 //# 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-test-utils",
-  "version": "0.4.6-next.1",
+  "version": "0.5.0-next.2",
   "backstage": {
     "role": "web-library"
   },
@@ -32,31 +32,44 @@
   },
   "dependencies": {
     "@backstage/config": "1.3.6",
-    "@backstage/frontend-app-api": "0.15.0-next.1",
-    "@backstage/frontend-plugin-api": "0.14.0-next.1",
-    "@backstage/plugin-app": "0.4.0-next.1",
+    "@backstage/core-app-api": "1.19.5-next.1",
+    "@backstage/core-plugin-api": "1.12.3-next.1",
+    "@backstage/frontend-app-api": "0.15.0-next.2",
+    "@backstage/frontend-plugin-api": "0.14.0-next.2",
+    "@backstage/plugin-app": "0.4.0-next.2",
     "@backstage/plugin-app-react": "0.1.1-next.0",
-    "@backstage/test-utils": "1.7.15-next.1",
+    "@backstage/plugin-permission-common": "0.9.6-next.0",
+    "@backstage/plugin-permission-react": "0.4.40-next.1",
+    "@backstage/test-utils": "1.7.15-next.2",
     "@backstage/types": "1.2.2",
-    "@backstage/version-bridge": "1.0.11",
+    "@backstage/version-bridge": "1.0.12-next.0",
+    "i18next": "^22.4.15",
+    "zen-observable": "^0.10.0",
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@backstage/cli": "0.35.4-next.1",
+    "@backstage/cli": "0.35.4-next.2",
     "@testing-library/jest-dom": "^6.0.0",
+    "@types/jest": "*",
     "@types/react": "^18.0.0",
+    "@types/zen-observable": "^0.8.0",
+    "msw": "^2.0.0",
     "react": "^18.0.2",
     "react-dom": "^18.0.2",
-    "react-router-dom": "^6.3.0"
+    "react-router-dom": "^6.30.2"
   },
   "peerDependencies": {
     "@testing-library/react": "^16.0.0",
+    "@types/jest": "*",
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0",
-    "react-router-dom": "^6.3.0"
+    "react-router-dom": "^6.30.2"
   },
   "peerDependenciesMeta": {
+    "@types/jest": {
+      "optional": true
+    },
     "@types/react": {
       "optional": true
     }

package/dist/utils/TestApiProvider.esm.js

@@ -1,52 +0,0 @@
-import { jsx } from 'react/jsx-runtime';
-import { ApiProvider } from '../core-app-api/src/apis/system/ApiProvider.esm.js';
-
-class TestApiRegistry {
-  constructor(apis) {
-    this.apis = apis;
-  }
-  /**
-   * Creates a new {@link TestApiRegistry} with a list of API implementation pairs.
-   *
-   * Similar to the {@link TestApiProvider}, there is no need to provide a full
-   * implementation of each API, it's enough to implement the methods that are tested.
-   *
-   * @example
-   * ```ts
-   * import { identityApiRef } from '@backstage/frontend-plugin-api';
-   * import { mockApis } from '@backstage/frontend-test-utils';
-   *
-   * const apis = TestApiRegistry.from(
-   *   [identityApiRef, mockApis.identity({ userEntityRef: 'user:default/guest' })],
-   * );
-   * ```
-   *
-   * @public
-   * @param apis - A list of pairs mapping an ApiRef to its respective implementation.
-   */
-  static from(...apis) {
-    return new TestApiRegistry(
-      new Map(apis.map(([api, impl]) => [api.id, impl]))
-    );
-  }
-  /**
-   * Returns an implementation of the API.
-   *
-   * @public
-   */
-  get(api) {
-    return this.apis.get(api.id);
-  }
-}
-const TestApiProvider = (props) => {
-  return /* @__PURE__ */ jsx(
-    ApiProvider,
-    {
-      apis: TestApiRegistry.from(...props.apis),
-      children: props.children
-    }
-  );
-};
-
-export { TestApiProvider, TestApiRegistry };
-//# sourceMappingURL=TestApiProvider.esm.js.map

package/dist/utils/TestApiProvider.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TestApiProvider.esm.js","sources":["../../src/utils/TestApiProvider.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 { ReactNode } from 'react';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { ApiProvider } from '../../../core-app-api/src/apis/system';\nimport { ApiHolder, ApiRef } from '@backstage/frontend-plugin-api';\n\n/**\n * Helper type for representing an API reference paired with a partial implementation.\n * @public\n */\nexport type TestApiProviderPropsApiPair<TApi> = TApi extends infer TImpl\n  ? readonly [ApiRef<TApi>, Partial<TImpl>]\n  : never;\n\n/**\n * Helper type for representing an array of API reference pairs.\n * @public\n */\nexport type TestApiProviderPropsApiPairs<TApiPairs> = {\n  [TIndex in keyof TApiPairs]: TestApiProviderPropsApiPair<TApiPairs[TIndex]>;\n};\n\n/**\n * Shorter alias for TestApiProviderPropsApiPairs for use in function signatures.\n * @public\n */\nexport type TestApiPairs<TApiPairs> = TestApiProviderPropsApiPairs<TApiPairs>;\n\n/**\n * Properties for the {@link TestApiProvider} component.\n *\n * @public\n */\nexport type TestApiProviderProps<TApiPairs extends any[]> = {\n  apis: readonly [...TestApiProviderPropsApiPairs<TApiPairs>];\n  children: ReactNode;\n};\n\n/**\n * The `TestApiRegistry` is an {@link @backstage/frontend-plugin-api#ApiHolder} implementation\n * that is particularly well suited for development and test environments such as\n * unit tests, storybooks, and isolated plugin development setups.\n *\n * @remarks\n *\n * For most test scenarios, prefer using the `apis` option in `renderInTestApp` or\n * `createExtensionTester` instead of creating a registry directly.\n *\n * @public\n */\nexport class TestApiRegistry implements ApiHolder {\n  /**\n   * Creates a new {@link TestApiRegistry} with a list of API implementation pairs.\n   *\n   * Similar to the {@link TestApiProvider}, there is no need to provide a full\n   * implementation of each API, it's enough to implement the methods that are tested.\n   *\n   * @example\n   * ```ts\n   * import { identityApiRef } from '@backstage/frontend-plugin-api';\n   * import { mockApis } from '@backstage/frontend-test-utils';\n   *\n   * const apis = TestApiRegistry.from(\n   *   [identityApiRef, mockApis.identity({ userEntityRef: 'user:default/guest' })],\n   * );\n   * ```\n   *\n   * @public\n   * @param apis - A list of pairs mapping an ApiRef to its respective implementation.\n   */\n  static from<TApiPairs extends any[]>(\n    ...apis: readonly [...TestApiProviderPropsApiPairs<TApiPairs>]\n  ) {\n    return new TestApiRegistry(\n      new Map(apis.map(([api, impl]) => [api.id, impl])),\n    );\n  }\n\n  private constructor(private readonly apis: Map<string, unknown>) {}\n\n  /**\n   * Returns an implementation of the API.\n   *\n   * @public\n   */\n  get<T>(api: ApiRef<T>): T | undefined {\n    return this.apis.get(api.id) as T | undefined;\n  }\n}\n\n/**\n * The `TestApiProvider` is a Utility API context provider for standalone rendering\n * scenarios where you're not using `renderInTestApp` or other test utilities.\n *\n * It lets you provide any number of API implementations, without necessarily\n * having to fully implement each of the APIs.\n *\n * @remarks\n *\n * For most test scenarios, prefer using the `apis` option in `renderInTestApp` or\n * `createExtensionTester` instead of wrapping components with `TestApiProvider`.\n *\n * @example\n * ```tsx\n * import { render } from '\\@testing-library/react';\n * import { identityApiRef } from '\\@backstage/frontend-plugin-api';\n * import { TestApiProvider, mockApis } from '\\@backstage/frontend-test-utils';\n *\n * render(\n *   <TestApiProvider\n *     apis={[[identityApiRef, mockApis.identity({ userEntityRef: 'user:default/guest' })]]}\n *   >\n *     <MyComponent />\n *   </TestApiProvider>\n * );\n * ```\n *\n * @public\n */\nexport const TestApiProvider = <T extends any[]>(\n  props: TestApiProviderProps<T>,\n) => {\n  return (\n    <ApiProvider\n      apis={TestApiRegistry.from(...props.apis)}\n      children={props.children}\n    />\n  );\n};\n"],"names":[],"mappings":";;;AAiEO,MAAM,eAAA,CAAqC;AAAA,EA4BxC,YAA6B,IAAA,EAA4B;AAA5B,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA,EAA6B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EARlE,OAAO,QACF,IAAA,EACH;AACA,IAAA,OAAO,IAAI,eAAA;AAAA,MACT,IAAI,GAAA,CAAI,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,IAAI,CAAA,KAAM,CAAC,GAAA,CAAI,EAAA,EAAI,IAAI,CAAC,CAAC;AAAA,KACnD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAO,GAAA,EAA+B;AACpC,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,GAAA,CAAI,GAAA,CAAI,EAAE,CAAA;AAAA,EAC7B;AACF;AA+BO,MAAM,eAAA,GAAkB,CAC7B,KAAA,KACG;AACH,EAAA,uBACE,GAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAM,eAAA,CAAgB,IAAA,CAAK,GAAG,MAAM,IAAI,CAAA;AAAA,MACxC,UAAU,KAAA,CAAM;AAAA;AAAA,GAClB;AAEJ;;;;"}