@backstage/frontend-test-utils 0.0.0-nightly-20231117021546

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# @backstage/frontend-test-utils
+
+## 0.0.0-nightly-20231117021546
+
+### Minor Changes
+
+- 59fabd510671: New testing utility library for `@backstage/frontend-app-api` and `@backstage/frontend-plugin-api`.
+
+### Patch Changes
+
+- 59fabd510671: Added `createExtensionTester` for rendering extensions in tests.
+- Updated dependencies
+  - @backstage/frontend-app-api@0.0.0-nightly-20231117021546
+  - @backstage/frontend-plugin-api@0.0.0-nightly-20231117021546
+  - @backstage/test-utils@0.0.0-nightly-20231117021546
+  - @backstage/types@1.1.1

package/README.md

@@ -0,0 +1,12 @@
+# @backstage/frontend-test-utils
+
+Contains utilities that can be used when testing frontend features such as extensions.
+
+## Installation
+
+Install the package via Yarn into your own packages:
+
+```sh
+cd <package-dir> # if within a monorepo
+yarn add --dev @backstage/frontend-test-utils
+```

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { Extension } from '@backstage/frontend-plugin-api';
+import { JsonObject } from '@backstage/types';
+import { RenderResult } from '@testing-library/react';
+
+/** @public */
+declare class ExtensionTester {
+    #private;
+    add<TConfig>(extension: Extension<TConfig>, options?: {
+        config?: TConfig;
+    }): ExtensionTester;
+    render(options?: {
+        config?: JsonObject;
+    }): RenderResult;
+}
+/** @public */
+declare function createExtensionTester<TConfig>(subject: Extension<TConfig>, options?: {
+    config?: TConfig;
+}): ExtensionTester;
+
+export { ExtensionTester, createExtensionTester };

package/dist/index.esm.js

@@ -0,0 +1,94 @@
+import { createSpecializedApp } from '@backstage/frontend-app-api';
+import { createPlugin } from '@backstage/frontend-plugin-api';
+import { MockConfigApi } from '@backstage/test-utils';
+import { render } from '@testing-library/react';
+
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var _extensions;
+const _ExtensionTester = class _ExtensionTester {
+  constructor() {
+    __privateAdd(this, _extensions, new Array());
+  }
+  /** @internal */
+  static forSubject(subject, options) {
+    const tester = new _ExtensionTester();
+    tester.add(subject, options);
+    return tester;
+  }
+  add(extension, options) {
+    __privateGet(this, _extensions).push({
+      extension,
+      config: options == null ? void 0 : options.config
+    });
+    return this;
+  }
+  render(options) {
+    const { config = {} } = options != null ? options : {};
+    const [subject, ...rest] = __privateGet(this, _extensions);
+    if (!subject) {
+      throw new Error(
+        "No subject found. At least one extension should be added to the tester."
+      );
+    }
+    const extensionsConfig = [
+      ...rest.map((entry) => ({
+        [entry.extension.id]: {
+          config: entry.config
+        }
+      })),
+      {
+        [subject.extension.id]: {
+          attachTo: { id: "core", input: "root" },
+          config: subject.config,
+          disabled: false
+        }
+      },
+      {
+        "core.layout": false
+      },
+      {
+        "core.nav": false
+      },
+      {
+        "core.routes": false
+      }
+    ];
+    const finalConfig = {
+      ...config,
+      app: {
+        ...typeof config.app === "object" ? config.app : void 0,
+        extensions: extensionsConfig
+      }
+    };
+    const app = createSpecializedApp({
+      features: [
+        createPlugin({
+          id: "test",
+          extensions: __privateGet(this, _extensions).map((entry) => entry.extension)
+        })
+      ],
+      config: new MockConfigApi(finalConfig)
+    });
+    return render(app.createRoot());
+  }
+};
+_extensions = new WeakMap();
+let ExtensionTester = _ExtensionTester;
+function createExtensionTester(subject, options) {
+  return ExtensionTester.forSubject(subject, options);
+}
+
+export { createExtensionTester };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/app/createExtensionTester.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 { createSpecializedApp } from '@backstage/frontend-app-api';\nimport { Extension, createPlugin } from '@backstage/frontend-plugin-api';\nimport { MockConfigApi } from '@backstage/test-utils';\nimport { JsonArray, JsonObject, JsonValue } from '@backstage/types';\nimport { RenderResult, render } from '@testing-library/react';\n\n/** @public */\nexport class ExtensionTester {\n  /** @internal */\n  static forSubject<TConfig>(\n    subject: Extension<TConfig>,\n    options?: { config?: TConfig },\n  ): ExtensionTester {\n    const tester = new ExtensionTester();\n    tester.add(subject, options);\n    return tester;\n  }\n\n  readonly #extensions = new Array<{\n    extension: Extension<any>;\n    config?: JsonValue;\n  }>();\n\n  add<TConfig>(\n    extension: Extension<TConfig>,\n    options?: { config?: TConfig },\n  ): ExtensionTester {\n    this.#extensions.push({\n      extension,\n      config: options?.config as JsonValue,\n    });\n\n    return this;\n  }\n\n  render(options?: { config?: JsonObject }): RenderResult {\n    const { config = {} } = options ?? {};\n\n    const [subject, ...rest] = this.#extensions;\n    if (!subject) {\n      throw new Error(\n        'No subject found. At least one extension should be added to the tester.',\n      );\n    }\n\n    const extensionsConfig: JsonArray = [\n      ...rest.map(entry => ({\n        [entry.extension.id]: {\n          config: entry.config,\n        },\n      })),\n      {\n        [subject.extension.id]: {\n          attachTo: { id: 'core', input: 'root' },\n          config: subject.config,\n          disabled: false,\n        },\n      },\n      {\n        'core.layout': false,\n      },\n      {\n        'core.nav': false,\n      },\n      {\n        'core.routes': false,\n      },\n    ];\n\n    const finalConfig = {\n      ...config,\n      app: {\n        ...(typeof config.app === 'object' ? config.app : undefined),\n        extensions: extensionsConfig,\n      },\n    };\n\n    const app = createSpecializedApp({\n      features: [\n        createPlugin({\n          id: 'test',\n          extensions: this.#extensions.map(entry => entry.extension),\n        }),\n      ],\n      config: new MockConfigApi(finalConfig),\n    });\n\n    return render(app.createRoot());\n  }\n}\n\n/** @public */\nexport function createExtensionTester<TConfig>(\n  subject: Extension<TConfig>,\n  options?: { config?: TConfig },\n): ExtensionTester {\n  return ExtensionTester.forSubject(subject, options);\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,IAAA,WAAA,CAAA;AAuBO,MAAM,gBAAA,GAAN,MAAM,gBAAgB,CAAA;AAAA,EAAtB,WAAA,GAAA;AAWL,IAAS,YAAA,CAAA,IAAA,EAAA,WAAA,EAAc,IAAI,KAGxB,EAAA,CAAA,CAAA;AAAA,GAAA;AAAA;AAAA,EAZH,OAAO,UACL,CAAA,OAAA,EACA,OACiB,EAAA;AACjB,IAAM,MAAA,MAAA,GAAS,IAAI,gBAAgB,EAAA,CAAA;AACnC,IAAO,MAAA,CAAA,GAAA,CAAI,SAAS,OAAO,CAAA,CAAA;AAC3B,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAOA,GAAA,CACE,WACA,OACiB,EAAA;AACjB,IAAA,YAAA,CAAA,IAAA,EAAK,aAAY,IAAK,CAAA;AAAA,MACpB,SAAA;AAAA,MACA,QAAQ,OAAS,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAA,MAAA;AAAA,KAClB,CAAA,CAAA;AAED,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAO,OAAiD,EAAA;AACtD,IAAA,MAAM,EAAE,MAAS,GAAA,EAAG,EAAA,GAAI,4BAAW,EAAC,CAAA;AAEpC,IAAA,MAAM,CAAC,OAAA,EAAS,GAAG,IAAI,IAAI,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AAChC,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,yEAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,gBAA8B,GAAA;AAAA,MAClC,GAAG,IAAK,CAAA,GAAA,CAAI,CAAU,KAAA,MAAA;AAAA,QACpB,CAAC,KAAA,CAAM,SAAU,CAAA,EAAE,GAAG;AAAA,UACpB,QAAQ,KAAM,CAAA,MAAA;AAAA,SAChB;AAAA,OACA,CAAA,CAAA;AAAA,MACF;AAAA,QACE,CAAC,OAAA,CAAQ,SAAU,CAAA,EAAE,GAAG;AAAA,UACtB,QAAU,EAAA,EAAE,EAAI,EAAA,MAAA,EAAQ,OAAO,MAAO,EAAA;AAAA,UACtC,QAAQ,OAAQ,CAAA,MAAA;AAAA,UAChB,QAAU,EAAA,KAAA;AAAA,SACZ;AAAA,OACF;AAAA,MACA;AAAA,QACE,aAAe,EAAA,KAAA;AAAA,OACjB;AAAA,MACA;AAAA,QACE,UAAY,EAAA,KAAA;AAAA,OACd;AAAA,MACA;AAAA,QACE,aAAe,EAAA,KAAA;AAAA,OACjB;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,WAAc,GAAA;AAAA,MAClB,GAAG,MAAA;AAAA,MACH,GAAK,EAAA;AAAA,QACH,GAAI,OAAO,MAAA,CAAO,GAAQ,KAAA,QAAA,GAAW,OAAO,GAAM,GAAA,KAAA,CAAA;AAAA,QAClD,UAAY,EAAA,gBAAA;AAAA,OACd;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,MAAM,oBAAqB,CAAA;AAAA,MAC/B,QAAU,EAAA;AAAA,QACR,YAAa,CAAA;AAAA,UACX,EAAI,EAAA,MAAA;AAAA,UACJ,YAAY,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,CAAY,GAAI,CAAA,CAAA,KAAA,KAAS,MAAM,SAAS,CAAA;AAAA,SAC1D,CAAA;AAAA,OACH;AAAA,MACA,MAAA,EAAQ,IAAI,aAAA,CAAc,WAAW,CAAA;AAAA,KACtC,CAAA,CAAA;AAED,IAAO,OAAA,MAAA,CAAO,GAAI,CAAA,UAAA,EAAY,CAAA,CAAA;AAAA,GAChC;AACF,CAAA,CAAA;AAvEW,WAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AAXJ,IAAM,eAAN,GAAA,gBAAA,CAAA;AAqFS,SAAA,qBAAA,CACd,SACA,OACiB,EAAA;AACjB,EAAO,OAAA,eAAA,CAAgB,UAAW,CAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AACpD;;;;"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@backstage/frontend-test-utils",
+  "version": "0.0.0-nightly-20231117021546",
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "web-library"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.0.0-nightly-20231117021546",
+    "@testing-library/jest-dom": "^6.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@backstage/frontend-app-api": "^0.0.0-nightly-20231117021546",
+    "@backstage/frontend-plugin-api": "^0.0.0-nightly-20231117021546",
+    "@backstage/test-utils": "^0.0.0-nightly-20231117021546",
+    "@backstage/types": "^1.1.1"
+  },
+  "peerDependencies": {
+    "@testing-library/react": "^12.1.3 || ^13.0.0 || ^14.0.0",
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0"
+  },
+  "module": "./dist/index.esm.js"
+}