npm - @backstage/plugin-techdocs-addons-test-utils - Versions diffs - 1.0.31 → 1.0.32-next.1 - Mend

@backstage/plugin-techdocs-addons-test-utils 1.0.31 → 1.0.32-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/CHANGELOG.md +28 -0
package/dist/index.esm.js +1 -209
package/dist/index.esm.js.map +1 -1
package/dist/test-utils.esm.js +210 -0
package/dist/test-utils.esm.js.map +1 -0
package/package.json +8 -8

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,33 @@
 # @backstage/plugin-techdocs-addons-test-utils
+## 1.0.32-next.1
+### Patch Changes
+- Updated dependencies
+  - @backstage/plugin-catalog@1.19.1-next.1
+  - @backstage/plugin-catalog-react@1.11.4-next.1
+  - @backstage/integration-react@1.1.26
+  - @backstage/plugin-search-react@1.7.11-next.1
+  - @backstage/plugin-techdocs@1.10.5-next.1
+  - @backstage/plugin-techdocs-react@1.2.4-next.1
+## 1.0.32-next.0
+### Patch Changes
+- 2f13862: Fix bug in TechDocsAddonTester when jest.resetAllMocks is called between tests
+- Updated dependencies
+  - @backstage/plugin-catalog@1.19.1-next.0
+  - @backstage/plugin-techdocs@1.10.5-next.0
+  - @backstage/plugin-catalog-react@1.11.4-next.0
+  - @backstage/plugin-techdocs-react@1.2.4-next.0
+  - @backstage/core-app-api@1.12.4
+  - @backstage/core-plugin-api@1.9.2
+  - @backstage/integration-react@1.1.26
+  - @backstage/test-utils@1.5.5-next.0
+  - @backstage/plugin-search-react@1.7.11-next.0
 ## 1.0.31
 ### Patch Changes

package/dist/index.esm.js CHANGED Viewed

@@ -1,210 +1,2 @@
-import React from 'react';
-import { screen } from 'testing-library__dom';
-import { Route } from 'react-router-dom';
-import { act, render } from '@testing-library/react';
-import { wrapInTestApp, TestApiProvider } from '@backstage/test-utils';
-import { FlatRoutes } from '@backstage/core-app-api';
-import { fetchApiRef, discoveryApiRef } from '@backstage/core-plugin-api';
-import { techdocsApiRef, techdocsStorageApiRef, TechDocsAddons } from '@backstage/plugin-techdocs-react';
-import { techdocsPlugin, TechDocsReaderPage } from '@backstage/plugin-techdocs';
-import { entityRouteRef } from '@backstage/plugin-catalog-react';
-import { searchApiRef } from '@backstage/plugin-search-react';
-import { scmIntegrationsApiRef } from '@backstage/integration-react';
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-if (!global.TextEncoder) {
-  global.TextEncoder = require("util").TextEncoder;
-}
-const { renderToStaticMarkup } = require("react-dom/server");
-const techdocsApi = {
-  getTechDocsMetadata: jest.fn(),
-  getEntityMetadata: jest.fn(),
-  getCookie: jest.fn().mockReturnValue({
-    // Expires in 10 minutes
-    expiresAt: new Date(Date.now() + 10 * 60 * 1e3).toISOString()
-  })
-};
-const techdocsStorageApi = {
-  getApiOrigin: jest.fn(),
-  getBaseUrl: jest.fn(),
-  getEntityDocs: jest.fn(),
-  syncEntityDocs: jest.fn()
-};
-const searchApi = {
-  query: jest.fn().mockResolvedValue({ results: [] })
-};
-const scmIntegrationsApi = {
-  fromConfig: jest.fn().mockReturnValue({})
-};
-const discoveryApi = {
-  getBaseUrl: jest.fn().mockResolvedValue("https://backstage.example.com/api/techdocs")
-};
-const fetchApi = {
-  fetch: jest.fn().mockResolvedValue({
-    ok: true,
-    json: jest.fn().mockResolvedValue({
-      // Expires in 10 minutes
-      expiresAt: new Date(Date.now() + 10 * 60 * 1e3).toISOString()
-    })
-  })
-};
-const defaultOptions = {
-  dom: /* @__PURE__ */ React.createElement(React.Fragment, null),
-  entity: { metadata: { name: "" } },
-  metadata: {},
-  componentId: "docs",
-  apis: [],
-  path: ""
-};
-const defaultMetadata = {
-  site_name: "Tech Docs",
-  site_description: "Tech Docs"
-};
-const defaultEntity = {
-  kind: "Component",
-  metadata: { namespace: "default", name: "docs" }
-};
-const defaultDom = /* @__PURE__ */ React.createElement("html", { lang: "en" }, /* @__PURE__ */ React.createElement("head", null), /* @__PURE__ */ React.createElement("body", null, /* @__PURE__ */ React.createElement("div", { "data-md-component": "container" }, /* @__PURE__ */ React.createElement("div", { "data-md-component": "navigation" }), /* @__PURE__ */ React.createElement("div", { "data-md-component": "toc" }), /* @__PURE__ */ React.createElement("div", { "data-md-component": "main" }))));
-class TechDocsAddonTester {
-  // Protected in order to allow extension but not direct instantiation.
-  constructor(addons) {
-    __publicField(this, "options", defaultOptions);
-    __publicField(this, "addons");
-    this.addons = addons;
-  }
-  /**
-   * Get a TechDocsAddonTester instance for a given set of Addons.
-   */
-  static buildAddonsInTechDocs(addons) {
-    return new TechDocsAddonTester(addons);
-  }
-  /**
-   * Provide mock API implementations if your Addon expects any.
-   */
-  withApis(apis) {
-    const refs = apis.map(([ref]) => ref);
-    this.options.apis = this.options.apis.filter(([ref]) => !refs.includes(ref)).concat(apis);
-    return this;
-  }
-  /**
-   * Provide mock HTML if your Addon expects it in the shadow DOM.
-   */
-  withDom(dom) {
-    this.options.dom = dom;
-    return this;
-  }
-  /**
-   * Provide mock techdocs_metadata.json values if your Addon needs it.
-   */
-  withMetadata(metadata) {
-    this.options.metadata = metadata;
-    return this;
-  }
-  /**
-   * Provide a mock entity if your Addon needs it. This also controls the base
-   * path at which the Addon is rendered.
-   */
-  withEntity(entity) {
-    this.options.entity = entity;
-    return this;
-  }
-  /**
-   * Provide the TechDocs page path at which the Addon is rendered (e.g. the
-   * part of the path after the entity namespace/kind/name).
-   */
-  atPath(path) {
-    this.options.path = path;
-    return this;
-  }
-  /**
-   * Return a fully configured and mocked TechDocs reader page within a test
-   * App instance, using the given Addon(s).
-   */
-  build() {
-    var _a, _b, _c, _d, _e;
-    const apis = [
-      [fetchApiRef, fetchApi],
-      [discoveryApiRef, discoveryApi],
-      [techdocsApiRef, techdocsApi],
-      [techdocsStorageApiRef, techdocsStorageApi],
-      [searchApiRef, searchApi],
-      [scmIntegrationsApiRef, scmIntegrationsApi],
-      ...this.options.apis
-    ];
-    const entityName = {
-      namespace: ((_b = (_a = this.options.entity) == null ? void 0 : _a.metadata) == null ? void 0 : _b.namespace) || defaultEntity.metadata.namespace,
-      kind: ((_c = this.options.entity) == null ? void 0 : _c.kind) || defaultEntity.kind,
-      name: ((_e = (_d = this.options.entity) == null ? void 0 : _d.metadata) == null ? void 0 : _e.name) || defaultEntity.metadata.name
-    };
-    techdocsApi.getTechDocsMetadata.mockReturnValue(
-      this.options.metadata || { ...defaultMetadata }
-    );
-    techdocsApi.getEntityMetadata.mockResolvedValue(
-      this.options.entity || { ...defaultEntity }
-    );
-    techdocsStorageApi.syncEntityDocs.mockResolvedValue("cached");
-    techdocsStorageApi.getApiOrigin.mockResolvedValue(
-      "https://backstage.example.com/api/techdocs"
-    );
-    techdocsStorageApi.getBaseUrl.mockResolvedValue(
-      `https://backstage.example.com/api/techdocs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`
-    );
-    techdocsStorageApi.getEntityDocs.mockResolvedValue(
-      renderToStaticMarkup(this.options.dom || defaultDom)
-    );
-    const TechDocsAddonsPage = () => {
-      return /* @__PURE__ */ React.createElement(TestApiProvider, { apis }, /* @__PURE__ */ React.createElement(FlatRoutes, null, /* @__PURE__ */ React.createElement(
-        Route,
-        {
-          path: "/docs/:namespace/:kind/:name/*",
-          element: /* @__PURE__ */ React.createElement(TechDocsReaderPage, null)
-        },
-        /* @__PURE__ */ React.createElement(TechDocsAddons, null, this.addons.map(
-          (addon, index) => React.cloneElement(addon, { key: index })
-        ))
-      )));
-    };
-    return wrapInTestApp(/* @__PURE__ */ React.createElement(TechDocsAddonsPage, null), {
-      routeEntries: [
-        `/docs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`
-      ],
-      mountedRoutes: {
-        "/docs": techdocsPlugin.routes.root,
-        "/docs/:namespace/:kind/:name/*": techdocsPlugin.routes.docRoot,
-        "/catalog/:namespace/:kind/:name": entityRouteRef
-      }
-    });
-  }
-  /**
-   * Render the Addon within a fully configured and mocked TechDocs reader.
-   *
-   * @remarks
-   * Components using useEffect to perform an asynchronous action (such as
-   * fetch) must be rendered within an async act call to properly get the final
-   * state, even with mocked responses. This utility method makes the signature
-   * a bit cleaner, since act doesn't return the result of the evaluated
-   * function.
-   *
-   * @see https://github.com/testing-library/react-testing-library/issues/281
-   * @see https://github.com/facebook/react/pull/14853
-   */
-  async renderWithEffects() {
-    await act(async () => {
-      render(this.build());
-    });
-    const shadowHost = await screen.findByTestId("techdocs-native-shadowroot");
-    return {
-      ...screen,
-      shadowRoot: (shadowHost == null ? void 0 : shadowHost.shadowRoot) || null
-    };
-  }
-}
-TechDocsAddonTester.buildAddonsInTechDocs;
-export { TechDocsAddonTester };
+export { TechDocsAddonTester } from './test-utils.esm.js';
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.esm.js","sources":["../src/test-utils.tsx"],"sourcesContent":["/\n Copyright 2022 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 React, { ReactElement } from 'react';\n\n// Shadow DOM support for the simple and complete DOM testing utilities\n// https://github.com/testing-library/dom-testing-library/issues/742#issuecomment-674987855\nimport { screen } from 'testing-library__dom';\nimport { Route } from 'react-router-dom';\nimport { act, render } from '@testing-library/react';\n\nimport { wrapInTestApp, TestApiProvider } from '@backstage/test-utils';\nimport { FlatRoutes } from '@backstage/core-app-api';\nimport {\n ApiRef,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\n\nimport {\n TechDocsAddons,\n techdocsApiRef,\n TechDocsEntityMetadata,\n TechDocsMetadata,\n techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\nimport { TechDocsReaderPage, techdocsPlugin } from '@backstage/plugin-techdocs';\nimport { entityRouteRef } from '@backstage/plugin-catalog-react';\nimport { searchApiRef } from '@backstage/plugin-search-react';\nimport { scmIntegrationsApiRef } from '@backstage/integration-react';\n\n// Since React 18 react-dom/server eagerly uses TextEncoder, so lazy load and make it available globally first\nif (!global.TextEncoder) {\n global.TextEncoder = require('util').TextEncoder;\n}\nconst { renderToStaticMarkup } =\n require('react-dom/server') as typeof import('react-dom/server');\n\nconst techdocsApi = {\n getTechDocsMetadata: jest.fn(),\n getEntityMetadata: jest.fn(),\n getCookie: jest.fn().mockReturnValue({\n // Expires in 10 minutes\n expiresAt: new Date(Date.now() + 10 60 * 1000).toISOString(),\n }),\n};\n\nconst techdocsStorageApi = {\n getApiOrigin: jest.fn(),\n getBaseUrl: jest.fn(),\n getEntityDocs: jest.fn(),\n syncEntityDocs: jest.fn(),\n};\n\nconst searchApi = {\n query: jest.fn().mockResolvedValue({ results: [] }),\n};\n\nconst scmIntegrationsApi = {\n fromConfig: jest.fn().mockReturnValue({}),\n};\n\nconst discoveryApi = {\n getBaseUrl: jest\n .fn()\n .mockResolvedValue('https://backstage.example.com/api/techdocs'),\n};\n\nconst fetchApi = {\n fetch: jest.fn().mockResolvedValue({\n ok: true,\n json: jest.fn().mockResolvedValue({\n // Expires in 10 minutes\n expiresAt: new Date(Date.now() + 10 * 60 * 1000).toISOString(),\n }),\n }),\n};\n\n/** @ignore /\ntype TechDocsAddonTesterTestApiPair<TApi> = TApi extends infer TImpl\n ? readonly [ApiRef<TApi>, Partial<TImpl>]\n : never;\n\n/* @ignore /\ntype TechdocsAddonTesterApis<TApiPairs> = {\n [TIndex in keyof TApiPairs]: TechDocsAddonTesterTestApiPair<\n TApiPairs[TIndex]\n >;\n};\n\ntype TechDocsAddonTesterOptions = {\n dom: ReactElement;\n entity: Partial<TechDocsEntityMetadata>;\n metadata: Partial<TechDocsMetadata>;\n componentId: string;\n apis: TechdocsAddonTesterApis<any[]>;\n path: string;\n};\n\nconst defaultOptions: TechDocsAddonTesterOptions = {\n dom: <></>,\n entity: { metadata: { name: '' } },\n metadata: {},\n componentId: 'docs',\n apis: [],\n path: '',\n};\n\nconst defaultMetadata = {\n site_name: 'Tech Docs',\n site_description: 'Tech Docs',\n};\n\nconst defaultEntity = {\n kind: 'Component',\n metadata: { namespace: 'default', name: 'docs' },\n};\n\nconst defaultDom = (\n <html lang=\"en\">\n <head />\n <body>\n <div data-md-component=\"container\">\n <div data-md-component=\"navigation\" />\n <div data-md-component=\"toc\" />\n <div data-md-component=\"main\" />\n </div>\n </body>\n </html>\n);\n\n/\n Utility class for rendering TechDocs Addons end-to-end within the TechDocs\n * reader page, with a set of givens (e.g. page DOM, metadata, etc).\n \n @example\n * ```tsx\n * const { getByText } = await TechDocsAddonTester.buildAddonsInTechDocs([<AnAddon />])\n * .withDom(<body>TEST_CONTENT</body>)\n * .renderWithEffects();\n \n expect(getByText('TEST_CONTENT')).toBeInTheDocument();\n * ```\n \n @public\n /\nexport class TechDocsAddonTester {\n private options: TechDocsAddonTesterOptions = defaultOptions;\n private addons: ReactElement[];\n\n /\n Get a TechDocsAddonTester instance for a given set of Addons.\n /\n static buildAddonsInTechDocs(addons: ReactElement[]) {\n return new TechDocsAddonTester(addons);\n }\n\n // Protected in order to allow extension but not direct instantiation.\n protected constructor(addons: ReactElement[]) {\n this.addons = addons;\n }\n\n /\n Provide mock API implementations if your Addon expects any.\n /\n withApis<T extends any[]>(apis: TechdocsAddonTesterApis<T>) {\n const refs = apis.map(([ref]) => ref);\n this.options.apis = this.options.apis\n .filter(([ref]) => !refs.includes(ref))\n .concat(apis);\n return this;\n }\n\n /\n Provide mock HTML if your Addon expects it in the shadow DOM.\n /\n withDom(dom: ReactElement) {\n this.options.dom = dom;\n return this;\n }\n\n /\n Provide mock techdocs_metadata.json values if your Addon needs it.\n /\n withMetadata(metadata: Partial<TechDocsMetadata>) {\n this.options.metadata = metadata;\n return this;\n }\n\n /\n Provide a mock entity if your Addon needs it. This also controls the base\n * path at which the Addon is rendered.\n /\n withEntity(entity: Partial<TechDocsEntityMetadata>) {\n this.options.entity = entity;\n return this;\n }\n\n /\n Provide the TechDocs page path at which the Addon is rendered (e.g. the\n * part of the path after the entity namespace/kind/name).\n /\n atPath(path: string) {\n this.options.path = path;\n return this;\n }\n\n /\n Return a fully configured and mocked TechDocs reader page within a test\n * App instance, using the given Addon(s).\n /\n build() {\n const apis: TechdocsAddonTesterApis<any[]> = [\n [fetchApiRef, fetchApi],\n [discoveryApiRef, discoveryApi],\n [techdocsApiRef, techdocsApi],\n [techdocsStorageApiRef, techdocsStorageApi],\n [searchApiRef, searchApi],\n [scmIntegrationsApiRef, scmIntegrationsApi],\n ...this.options.apis,\n ];\n\n const entityName = {\n namespace:\n this.options.entity?.metadata?.namespace \|\|\n defaultEntity.metadata.namespace,\n kind: this.options.entity?.kind \|\| defaultEntity.kind,\n name: this.options.entity?.metadata?.name \|\| defaultEntity.metadata.name,\n };\n\n techdocsApi.getTechDocsMetadata.mockReturnValue(\n this.options.metadata \|\| { ...defaultMetadata },\n );\n techdocsApi.getEntityMetadata.mockResolvedValue(\n this.options.entity \|\| { ...defaultEntity },\n );\n\n techdocsStorageApi.syncEntityDocs.mockResolvedValue('cached');\n techdocsStorageApi.getApiOrigin.mockResolvedValue(\n 'https://backstage.example.com/api/techdocs',\n );\n techdocsStorageApi.getBaseUrl.mockResolvedValue(\n `https://backstage.example.com/api/techdocs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`,\n );\n techdocsStorageApi.getEntityDocs.mockResolvedValue(\n renderToStaticMarkup(this.options.dom \|\| defaultDom),\n );\n\n const TechDocsAddonsPage = () => {\n return (\n <TestApiProvider apis={apis}>\n <FlatRoutes>\n <Route\n path=\"/docs/:namespace/:kind/:name/\"\n element={<TechDocsReaderPage />}\n >\n <TechDocsAddons>\n {this.addons.map((addon, index) =>\n React.cloneElement(addon, { key: index }),\n )}\n </TechDocsAddons>\n </Route>\n </FlatRoutes>\n </TestApiProvider>\n );\n };\n\n return wrapInTestApp(<TechDocsAddonsPage />, {\n routeEntries: [\n `/docs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`,\n ],\n mountedRoutes: {\n '/docs': techdocsPlugin.routes.root,\n '/docs/:namespace/:kind/:name/': techdocsPlugin.routes.docRoot,\n '/catalog/:namespace/:kind/:name': entityRouteRef,\n },\n });\n }\n\n /\n Render the Addon within a fully configured and mocked TechDocs reader.\n \n @remarks\n * Components using useEffect to perform an asynchronous action (such as\n * fetch) must be rendered within an async act call to properly get the final\n * state, even with mocked responses. This utility method makes the signature\n * a bit cleaner, since act doesn't return the result of the evaluated\n * function.\n \n @see https://github.com/testing-library/react-testing-library/issues/281\n * @see https://github.com/facebook/react/pull/14853\n */\n async renderWithEffects(): Promise<\n typeof screen & { shadowRoot: ShadowRoot \| null }\n > {\n await act(async () => {\n render(this.build());\n });\n\n const shadowHost = await screen.findByTestId('techdocs-native-shadowroot');\n\n return {\n ...screen,\n shadowRoot: shadowHost?.shadowRoot \|\| null,\n };\n }\n}\n\nexport default TechDocsAddonTester.buildAddonsInTechDocs;\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AA6CA,IAAI,CAAC,OAAO,WAAa,EAAA;AACvB,EAAO,MAAA,CAAA,WAAA,GAAc,OAAQ,CAAA,MAAM,CAAE,CAAA,WAAA,CAAA;AACvC,CAAA;AACA,MAAM,EAAE,oBAAA,EACN,GAAA,OAAA,CAAQ,kBAAkB,CAAA,CAAA;AAE5B,MAAM,WAAc,GAAA;AAAA,EAClB,mBAAA,EAAqB,KAAK,EAAG,EAAA;AAAA,EAC7B,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,EAC3B,SAAW,EAAA,IAAA,CAAK,EAAG,EAAA,CAAE,eAAgB,CAAA;AAAA;AAAA,IAEnC,SAAA,EAAW,IAAI,IAAA,CAAK,IAAK,CAAA,GAAA,KAAQ,EAAK,GAAA,EAAA,GAAK,GAAI,CAAA,CAAE,WAAY,EAAA;AAAA,GAC9D,CAAA;AACH,CAAA,CAAA;AAEA,MAAM,kBAAqB,GAAA;AAAA,EACzB,YAAA,EAAc,KAAK,EAAG,EAAA;AAAA,EACtB,UAAA,EAAY,KAAK,EAAG,EAAA;AAAA,EACpB,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,EACvB,cAAA,EAAgB,KAAK,EAAG,EAAA;AAC1B,CAAA,CAAA;AAEA,MAAM,SAAY,GAAA;AAAA,EAChB,KAAA,EAAO,KAAK,EAAG,EAAA,CAAE,kBAAkB,EAAE,OAAA,EAAS,EAAC,EAAG,CAAA;AACpD,CAAA,CAAA;AAEA,MAAM,kBAAqB,GAAA;AAAA,EACzB,YAAY,IAAK,CAAA,EAAA,EAAK,CAAA,eAAA,CAAgB,EAAE,CAAA;AAC1C,CAAA,CAAA;AAEA,MAAM,YAAe,GAAA;AAAA,EACnB,UAAY,EAAA,IAAA,CACT,EAAG,EAAA,CACH,kBAAkB,4CAA4C,CAAA;AACnE,CAAA,CAAA;AAEA,MAAM,QAAW,GAAA;AAAA,EACf,KAAO,EAAA,IAAA,CAAK,EAAG,EAAA,CAAE,iBAAkB,CAAA;AAAA,IACjC,EAAI,EAAA,IAAA;AAAA,IACJ,IAAM,EAAA,IAAA,CAAK,EAAG,EAAA,CAAE,iBAAkB,CAAA;AAAA;AAAA,MAEhC,SAAA,EAAW,IAAI,IAAA,CAAK,IAAK,CAAA,GAAA,KAAQ,EAAK,GAAA,EAAA,GAAK,GAAI,CAAA,CAAE,WAAY,EAAA;AAAA,KAC9D,CAAA;AAAA,GACF,CAAA;AACH,CAAA,CAAA;AAuBA,MAAM,cAA6C,GAAA;AAAA,EACjD,qBAAO,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,CAAA;AAAA,EACP,QAAQ,EAAE,QAAA,EAAU,EAAE,IAAA,EAAM,IAAK,EAAA;AAAA,EACjC,UAAU,EAAC;AAAA,EACX,WAAa,EAAA,MAAA;AAAA,EACb,MAAM,EAAC;AAAA,EACP,IAAM,EAAA,EAAA;AACR,CAAA,CAAA;AAEA,MAAM,eAAkB,GAAA;AAAA,EACtB,SAAW,EAAA,WAAA;AAAA,EACX,gBAAkB,EAAA,WAAA;AACpB,CAAA,CAAA;AAEA,MAAM,aAAgB,GAAA;AAAA,EACpB,IAAM,EAAA,WAAA;AAAA,EACN,QAAU,EAAA,EAAE,SAAW,EAAA,SAAA,EAAW,MAAM,MAAO,EAAA;AACjD,CAAA,CAAA;AAEA,MAAM,UACJ,mBAAA,KAAA,CAAA,aAAA,CAAC,MAAK,EAAA,EAAA,IAAA,EAAK,IACT,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,MAAK,EAAA,IAAA,CAAA,kBACL,KAAA,CAAA,aAAA,CAAA,MAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAI,qBAAkB,WACrB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAI,EAAA,EAAA,mBAAA,EAAkB,YAAa,EAAA,CAAA,kBACnC,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAI,mBAAkB,EAAA,KAAA,EAAM,CAC7B,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAI,EAAA,EAAA,mBAAA,EAAkB,MAAO,EAAA,CAChC,CACF,CACF,CAAA,CAAA;AAkBK,MAAM,mBAAoB,CAAA;AAAA;AAAA,EAYrB,YAAY,MAAwB,EAAA;AAX9C,IAAA,aAAA,CAAA,IAAA,EAAQ,SAAsC,EAAA,cAAA,CAAA,CAAA;AAC9C,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAWN,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA,EAPA,OAAO,sBAAsB,MAAwB,EAAA;AACnD,IAAO,OAAA,IAAI,oBAAoB,MAAM,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA;AAAA;AAAA,EAUA,SAA0B,IAAkC,EAAA;AAC1D,IAAA,MAAM,OAAO,IAAK,CAAA,GAAA,CAAI,CAAC,CAAC,GAAG,MAAM,GAAG,CAAA,CAAA;AACpC,IAAA,IAAA,CAAK,QAAQ,IAAO,GAAA,IAAA,CAAK,OAAQ,CAAA,IAAA,CAC9B,OAAO,CAAC,CAAC,GAAG,CAAA,KAAM,CAAC,IAAK,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA,CACrC,OAAO,IAAI,CAAA,CAAA;AACd,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,GAAmB,EAAA;AACzB,IAAA,IAAA,CAAK,QAAQ,GAAM,GAAA,GAAA,CAAA;AACnB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,QAAqC,EAAA;AAChD,IAAA,IAAA,CAAK,QAAQ,QAAW,GAAA,QAAA,CAAA;AACxB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW,MAAyC,EAAA;AAClD,IAAA,IAAA,CAAK,QAAQ,MAAS,GAAA,MAAA,CAAA;AACtB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,IAAc,EAAA;AACnB,IAAA,IAAA,CAAK,QAAQ,IAAO,GAAA,IAAA,CAAA;AACpB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,KAAQ,GAAA;AAhOV,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAiOI,IAAA,MAAM,IAAuC,GAAA;AAAA,MAC3C,CAAC,aAAa,QAAQ,CAAA;AAAA,MACtB,CAAC,iBAAiB,YAAY,CAAA;AAAA,MAC9B,CAAC,gBAAgB,WAAW,CAAA;AAAA,MAC5B,CAAC,uBAAuB,kBAAkB,CAAA;AAAA,MAC1C,CAAC,cAAc,SAAS,CAAA;AAAA,MACxB,CAAC,uBAAuB,kBAAkB,CAAA;AAAA,MAC1C,GAAG,KAAK,OAAQ,CAAA,IAAA;AAAA,KAClB,CAAA;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,SAAA,EAAA,CAAA,CACE,gBAAK,OAAQ,CAAA,MAAA,KAAb,mBAAqB,QAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA+B,SAC/B,KAAA,aAAA,CAAc,QAAS,CAAA,SAAA;AAAA,MACzB,QAAM,EAAK,GAAA,IAAA,CAAA,OAAA,CAAQ,MAAb,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqB,SAAQ,aAAc,CAAA,IAAA;AAAA,MACjD,IAAA,EAAA,CAAA,CAAM,gBAAK,OAAQ,CAAA,MAAA,KAAb,mBAAqB,QAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA+B,IAAQ,KAAA,aAAA,CAAc,QAAS,CAAA,IAAA;AAAA,KACtE,CAAA;AAEA,IAAA,WAAA,CAAY,mBAAoB,CAAA,eAAA;AAAA,MAC9B,IAAK,CAAA,OAAA,CAAQ,QAAY,IAAA,EAAE,GAAG,eAAgB,EAAA;AAAA,KAChD,CAAA;AACA,IAAA,WAAA,CAAY,iBAAkB,CAAA,iBAAA;AAAA,MAC5B,IAAK,CAAA,OAAA,CAAQ,MAAU,IAAA,EAAE,GAAG,aAAc,EAAA;AAAA,KAC5C,CAAA;AAEA,IAAmB,kBAAA,CAAA,cAAA,CAAe,kBAAkB,QAAQ,CAAA,CAAA;AAC5D,IAAA,kBAAA,CAAmB,YAAa,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,kBAAA,CAAmB,UAAW,CAAA,iBAAA;AAAA,MAC5B,CAA8C,2CAAA,EAAA,UAAA,CAAW,SAAS,CAAA,CAAA,EAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,CAAA,EAAI,IAAK,CAAA,OAAA,CAAQ,IAAI,CAAA,CAAA;AAAA,KAC/H,CAAA;AACA,IAAA,kBAAA,CAAmB,aAAc,CAAA,iBAAA;AAAA,MAC/B,oBAAqB,CAAA,IAAA,CAAK,OAAQ,CAAA,GAAA,IAAO,UAAU,CAAA;AAAA,KACrD,CAAA;AAEA,IAAA,MAAM,qBAAqB,MAAM;AAC/B,MAAA,uBACG,KAAA,CAAA,aAAA,CAAA,eAAA,EAAA,EAAgB,IACf,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,UACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,KAAA;AAAA,QAAA;AAAA,UACC,IAAK,EAAA,gCAAA;AAAA,UACL,OAAA,sCAAU,kBAAmB,EAAA,IAAA,CAAA;AAAA,SAAA;AAAA,wBAE7B,KAAA,CAAA,aAAA,CAAC,cACE,EAAA,IAAA,EAAA,IAAA,CAAK,MAAO,CAAA,GAAA;AAAA,UAAI,CAAC,OAAO,KACvB,KAAA,KAAA,CAAM,aAAa,KAAO,EAAA,EAAE,GAAK,EAAA,KAAA,EAAO,CAAA;AAAA,SAE5C,CAAA;AAAA,OAEJ,CACF,CAAA,CAAA;AAAA,KAEJ,CAAA;AAEA,IAAO,OAAA,aAAA,iBAAe,KAAA,CAAA,aAAA,CAAA,kBAAA,EAAA,IAAmB,CAAI,EAAA;AAAA,MAC3C,YAAc,EAAA;AAAA,QACZ,CAAS,MAAA,EAAA,UAAA,CAAW,SAAS,CAAA,CAAA,EAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,CAAA,EAAI,IAAK,CAAA,OAAA,CAAQ,IAAI,CAAA,CAAA;AAAA,OAC1F;AAAA,MACA,aAAe,EAAA;AAAA,QACb,OAAA,EAAS,eAAe,MAAO,CAAA,IAAA;AAAA,QAC/B,gCAAA,EAAkC,eAAe,MAAO,CAAA,OAAA;AAAA,QACxD,iCAAmC,EAAA,cAAA;AAAA,OACrC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,MAAM,iBAEJ,GAAA;AACA,IAAA,MAAM,IAAI,YAAY;AACpB,MAAO,MAAA,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAAA,KACpB,CAAA,CAAA;AAED,IAAA,MAAM,UAAa,GAAA,MAAM,MAAO,CAAA,YAAA,CAAa,4BAA4B,CAAA,CAAA;AAEzE,IAAO,OAAA;AAAA,MACL,GAAG,MAAA;AAAA,MACH,UAAA,EAAA,CAAY,yCAAY,UAAc,KAAA,IAAA;AAAA,KACxC,CAAA;AAAA,GACF;AACF,CAAA;AAEe,mBAAoB,CAAA,qBAAA;;;;"}
1	+ {"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/test-utils.esm.js ADDED Viewed

@@ -0,0 +1,210 @@
+import React from 'react';
+import { screen } from 'testing-library__dom';
+import { Route } from 'react-router-dom';
+import { act, render } from '@testing-library/react';
+import { wrapInTestApp, TestApiProvider } from '@backstage/test-utils';
+import { FlatRoutes } from '@backstage/core-app-api';
+import { fetchApiRef, discoveryApiRef } from '@backstage/core-plugin-api';
+import { techdocsApiRef, techdocsStorageApiRef, TechDocsAddons } from '@backstage/plugin-techdocs-react';
+import { techdocsPlugin, TechDocsReaderPage } from '@backstage/plugin-techdocs';
+import { entityRouteRef } from '@backstage/plugin-catalog-react';
+import { searchApiRef } from '@backstage/plugin-search-react';
+import { scmIntegrationsApiRef } from '@backstage/integration-react';
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+if (!global.TextEncoder) {
+  global.TextEncoder = require("util").TextEncoder;
+}
+const { renderToStaticMarkup } = require("react-dom/server");
+const defaultOptions = {
+  dom: /* @__PURE__ */ React.createElement(React.Fragment, null),
+  entity: { metadata: { name: "" } },
+  metadata: {},
+  componentId: "docs",
+  apis: [],
+  path: ""
+};
+const defaultMetadata = {
+  site_name: "Tech Docs",
+  site_description: "Tech Docs"
+};
+const defaultEntity = {
+  kind: "Component",
+  metadata: { namespace: "default", name: "docs" }
+};
+const defaultDom = /* @__PURE__ */ React.createElement("html", { lang: "en" }, /* @__PURE__ */ React.createElement("head", null), /* @__PURE__ */ React.createElement("body", null, /* @__PURE__ */ React.createElement("div", { "data-md-component": "container" }, /* @__PURE__ */ React.createElement("div", { "data-md-component": "navigation" }), /* @__PURE__ */ React.createElement("div", { "data-md-component": "toc" }), /* @__PURE__ */ React.createElement("div", { "data-md-component": "main" }))));
+class TechDocsAddonTester {
+  // Protected in order to allow extension but not direct instantiation.
+  constructor(addons) {
+    __publicField(this, "options", defaultOptions);
+    __publicField(this, "addons");
+    this.addons = addons;
+  }
+  /**
+   * Get a TechDocsAddonTester instance for a given set of Addons.
+   */
+  static buildAddonsInTechDocs(addons) {
+    return new TechDocsAddonTester(addons);
+  }
+  /**
+   * Provide mock API implementations if your Addon expects any.
+   */
+  withApis(apis) {
+    const refs = apis.map(([ref]) => ref);
+    this.options.apis = this.options.apis.filter(([ref]) => !refs.includes(ref)).concat(apis);
+    return this;
+  }
+  /**
+   * Provide mock HTML if your Addon expects it in the shadow DOM.
+   */
+  withDom(dom) {
+    this.options.dom = dom;
+    return this;
+  }
+  /**
+   * Provide mock techdocs_metadata.json values if your Addon needs it.
+   */
+  withMetadata(metadata) {
+    this.options.metadata = metadata;
+    return this;
+  }
+  /**
+   * Provide a mock entity if your Addon needs it. This also controls the base
+   * path at which the Addon is rendered.
+   */
+  withEntity(entity) {
+    this.options.entity = entity;
+    return this;
+  }
+  /**
+   * Provide the TechDocs page path at which the Addon is rendered (e.g. the
+   * part of the path after the entity namespace/kind/name).
+   */
+  atPath(path) {
+    this.options.path = path;
+    return this;
+  }
+  /**
+   * Return a fully configured and mocked TechDocs reader page within a test
+   * App instance, using the given Addon(s).
+   */
+  build() {
+    var _a, _b, _c, _d, _e;
+    const techdocsApi = {
+      getTechDocsMetadata: jest.fn(),
+      getEntityMetadata: jest.fn(),
+      getCookie: jest.fn().mockReturnValue({
+        // Expires in 10 minutes
+        expiresAt: new Date(Date.now() + 10 * 60 * 1e3).toISOString()
+      })
+    };
+    const techdocsStorageApi = {
+      getApiOrigin: jest.fn(),
+      getBaseUrl: jest.fn(),
+      getEntityDocs: jest.fn(),
+      syncEntityDocs: jest.fn()
+    };
+    const searchApi = {
+      query: jest.fn().mockResolvedValue({ results: [] })
+    };
+    const scmIntegrationsApi = {
+      fromConfig: jest.fn().mockReturnValue({})
+    };
+    const discoveryApi = {
+      getBaseUrl: jest.fn().mockResolvedValue("https://backstage.example.com/api/techdocs")
+    };
+    const fetchApi = {
+      fetch: jest.fn().mockResolvedValue({
+        ok: true,
+        json: jest.fn().mockResolvedValue({
+          // Expires in 10 minutes
+          expiresAt: new Date(Date.now() + 10 * 60 * 1e3).toISOString()
+        })
+      })
+    };
+    const apis = [
+      [fetchApiRef, fetchApi],
+      [discoveryApiRef, discoveryApi],
+      [techdocsApiRef, techdocsApi],
+      [techdocsStorageApiRef, techdocsStorageApi],
+      [searchApiRef, searchApi],
+      [scmIntegrationsApiRef, scmIntegrationsApi],
+      ...this.options.apis
+    ];
+    const entityName = {
+      namespace: ((_b = (_a = this.options.entity) == null ? void 0 : _a.metadata) == null ? void 0 : _b.namespace) || defaultEntity.metadata.namespace,
+      kind: ((_c = this.options.entity) == null ? void 0 : _c.kind) || defaultEntity.kind,
+      name: ((_e = (_d = this.options.entity) == null ? void 0 : _d.metadata) == null ? void 0 : _e.name) || defaultEntity.metadata.name
+    };
+    techdocsApi.getTechDocsMetadata.mockReturnValue(
+      this.options.metadata || { ...defaultMetadata }
+    );
+    techdocsApi.getEntityMetadata.mockResolvedValue(
+      this.options.entity || { ...defaultEntity }
+    );
+    techdocsStorageApi.syncEntityDocs.mockResolvedValue("cached");
+    techdocsStorageApi.getApiOrigin.mockResolvedValue(
+      "https://backstage.example.com/api/techdocs"
+    );
+    techdocsStorageApi.getBaseUrl.mockResolvedValue(
+      `https://backstage.example.com/api/techdocs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`
+    );
+    techdocsStorageApi.getEntityDocs.mockResolvedValue(
+      renderToStaticMarkup(this.options.dom || defaultDom)
+    );
+    const TechDocsAddonsPage = () => {
+      return /* @__PURE__ */ React.createElement(TestApiProvider, { apis }, /* @__PURE__ */ React.createElement(FlatRoutes, null, /* @__PURE__ */ React.createElement(
+        Route,
+        {
+          path: "/docs/:namespace/:kind/:name/*",
+          element: /* @__PURE__ */ React.createElement(TechDocsReaderPage, null)
+        },
+        /* @__PURE__ */ React.createElement(TechDocsAddons, null, this.addons.map(
+          (addon, index) => React.cloneElement(addon, { key: index })
+        ))
+      )));
+    };
+    return wrapInTestApp(/* @__PURE__ */ React.createElement(TechDocsAddonsPage, null), {
+      routeEntries: [
+        `/docs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`
+      ],
+      mountedRoutes: {
+        "/docs": techdocsPlugin.routes.root,
+        "/docs/:namespace/:kind/:name/*": techdocsPlugin.routes.docRoot,
+        "/catalog/:namespace/:kind/:name": entityRouteRef
+      }
+    });
+  }
+  /**
+   * Render the Addon within a fully configured and mocked TechDocs reader.
+   *
+   * @remarks
+   * Components using useEffect to perform an asynchronous action (such as
+   * fetch) must be rendered within an async act call to properly get the final
+   * state, even with mocked responses. This utility method makes the signature
+   * a bit cleaner, since act doesn't return the result of the evaluated
+   * function.
+   *
+   * @see https://github.com/testing-library/react-testing-library/issues/281
+   * @see https://github.com/facebook/react/pull/14853
+   */
+  async renderWithEffects() {
+    await act(async () => {
+      render(this.build());
+    });
+    const shadowHost = await screen.findByTestId("techdocs-native-shadowroot");
+    return {
+      ...screen,
+      shadowRoot: (shadowHost == null ? void 0 : shadowHost.shadowRoot) || null
+    };
+  }
+}
+TechDocsAddonTester.buildAddonsInTechDocs;
+export { TechDocsAddonTester };
+//# sourceMappingURL=test-utils.esm.js.map

package/dist/test-utils.esm.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"test-utils.esm.js","sources":["../src/test-utils.tsx"],"sourcesContent":["/*\n * Copyright 2022 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 React, { ReactElement } from 'react';\n\n// Shadow DOM support for the simple and complete DOM testing utilities\n// https://github.com/testing-library/dom-testing-library/issues/742#issuecomment-674987855\nimport { screen } from 'testing-library__dom';\nimport { Route } from 'react-router-dom';\nimport { act, render } from '@testing-library/react';\n\nimport { wrapInTestApp, TestApiProvider } from '@backstage/test-utils';\nimport { FlatRoutes } from '@backstage/core-app-api';\nimport {\n ApiRef,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\n\nimport {\n TechDocsAddons,\n techdocsApiRef,\n TechDocsEntityMetadata,\n TechDocsMetadata,\n techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\nimport { TechDocsReaderPage, techdocsPlugin } from '@backstage/plugin-techdocs';\nimport { entityRouteRef } from '@backstage/plugin-catalog-react';\nimport { searchApiRef } from '@backstage/plugin-search-react';\nimport { scmIntegrationsApiRef } from '@backstage/integration-react';\n\n// Since React 18 react-dom/server eagerly uses TextEncoder, so lazy load and make it available globally first\nif (!global.TextEncoder) {\n global.TextEncoder = require('util').TextEncoder;\n}\nconst { renderToStaticMarkup } =\n require('react-dom/server') as typeof import('react-dom/server');\n\n/** @ignore */\ntype TechDocsAddonTesterTestApiPair<TApi> = TApi extends infer TImpl\n ? readonly [ApiRef<TApi>, Partial<TImpl>]\n : never;\n\n/** @ignore */\ntype TechdocsAddonTesterApis<TApiPairs> = {\n [TIndex in keyof TApiPairs]: TechDocsAddonTesterTestApiPair<\n TApiPairs[TIndex]\n >;\n};\n\ntype TechDocsAddonTesterOptions = {\n dom: ReactElement;\n entity: Partial<TechDocsEntityMetadata>;\n metadata: Partial<TechDocsMetadata>;\n componentId: string;\n apis: TechdocsAddonTesterApis<any[]>;\n path: string;\n};\n\nconst defaultOptions: TechDocsAddonTesterOptions = {\n dom: <></>,\n entity: { metadata: { name: '' } },\n metadata: {},\n componentId: 'docs',\n apis: [],\n path: '',\n};\n\nconst defaultMetadata = {\n site_name: 'Tech Docs',\n site_description: 'Tech Docs',\n};\n\nconst defaultEntity = {\n kind: 'Component',\n metadata: { namespace: 'default', name: 'docs' },\n};\n\nconst defaultDom = (\n <html lang=\"en\">\n <head />\n <body>\n <div data-md-component=\"container\">\n <div data-md-component=\"navigation\" />\n <div data-md-component=\"toc\" />\n <div data-md-component=\"main\" />\n </div>\n </body>\n </html>\n);\n\n/**\n * Utility class for rendering TechDocs Addons end-to-end within the TechDocs\n * reader page, with a set of givens (e.g. page DOM, metadata, etc).\n *\n * @example\n * ```tsx\n * const { getByText } = await TechDocsAddonTester.buildAddonsInTechDocs([<AnAddon />])\n * .withDom(<body>TEST_CONTENT</body>)\n * .renderWithEffects();\n *\n * expect(getByText('TEST_CONTENT')).toBeInTheDocument();\n * ```\n *\n * @public\n */\nexport class TechDocsAddonTester {\n private options: TechDocsAddonTesterOptions = defaultOptions;\n private addons: ReactElement[];\n\n /**\n * Get a TechDocsAddonTester instance for a given set of Addons.\n */\n static buildAddonsInTechDocs(addons: ReactElement[]) {\n return new TechDocsAddonTester(addons);\n }\n\n // Protected in order to allow extension but not direct instantiation.\n protected constructor(addons: ReactElement[]) {\n this.addons = addons;\n }\n\n /**\n * Provide mock API implementations if your Addon expects any.\n */\n withApis<T extends any[]>(apis: TechdocsAddonTesterApis<T>) {\n const refs = apis.map(([ref]) => ref);\n this.options.apis = this.options.apis\n .filter(([ref]) => !refs.includes(ref))\n .concat(apis);\n return this;\n }\n\n /**\n * Provide mock HTML if your Addon expects it in the shadow DOM.\n */\n withDom(dom: ReactElement) {\n this.options.dom = dom;\n return this;\n }\n\n /**\n * Provide mock techdocs_metadata.json values if your Addon needs it.\n */\n withMetadata(metadata: Partial<TechDocsMetadata>) {\n this.options.metadata = metadata;\n return this;\n }\n\n /**\n * Provide a mock entity if your Addon needs it. This also controls the base\n * path at which the Addon is rendered.\n */\n withEntity(entity: Partial<TechDocsEntityMetadata>) {\n this.options.entity = entity;\n return this;\n }\n\n /**\n * Provide the TechDocs page path at which the Addon is rendered (e.g. the\n * part of the path after the entity namespace/kind/name).\n */\n atPath(path: string) {\n this.options.path = path;\n return this;\n }\n\n /**\n * Return a fully configured and mocked TechDocs reader page within a test\n * App instance, using the given Addon(s).\n */\n build() {\n const techdocsApi = {\n getTechDocsMetadata: jest.fn(),\n getEntityMetadata: jest.fn(),\n getCookie: jest.fn().mockReturnValue({\n // Expires in 10 minutes\n expiresAt: new Date(Date.now() + 10 * 60 * 1000).toISOString(),\n }),\n };\n\n const techdocsStorageApi = {\n getApiOrigin: jest.fn(),\n getBaseUrl: jest.fn(),\n getEntityDocs: jest.fn(),\n syncEntityDocs: jest.fn(),\n };\n\n const searchApi = {\n query: jest.fn().mockResolvedValue({ results: [] }),\n };\n\n const scmIntegrationsApi = {\n fromConfig: jest.fn().mockReturnValue({}),\n };\n\n const discoveryApi = {\n getBaseUrl: jest\n .fn()\n .mockResolvedValue('https://backstage.example.com/api/techdocs'),\n };\n\n const fetchApi = {\n fetch: jest.fn().mockResolvedValue({\n ok: true,\n json: jest.fn().mockResolvedValue({\n // Expires in 10 minutes\n expiresAt: new Date(Date.now() + 10 * 60 * 1000).toISOString(),\n }),\n }),\n };\n\n const apis: TechdocsAddonTesterApis<any[]> = [\n [fetchApiRef, fetchApi],\n [discoveryApiRef, discoveryApi],\n [techdocsApiRef, techdocsApi],\n [techdocsStorageApiRef, techdocsStorageApi],\n [searchApiRef, searchApi],\n [scmIntegrationsApiRef, scmIntegrationsApi],\n ...this.options.apis,\n ];\n\n const entityName = {\n namespace:\n this.options.entity?.metadata?.namespace ||\n defaultEntity.metadata.namespace,\n kind: this.options.entity?.kind || defaultEntity.kind,\n name: this.options.entity?.metadata?.name || defaultEntity.metadata.name,\n };\n\n techdocsApi.getTechDocsMetadata.mockReturnValue(\n this.options.metadata || { ...defaultMetadata },\n );\n techdocsApi.getEntityMetadata.mockResolvedValue(\n this.options.entity || { ...defaultEntity },\n );\n\n techdocsStorageApi.syncEntityDocs.mockResolvedValue('cached');\n techdocsStorageApi.getApiOrigin.mockResolvedValue(\n 'https://backstage.example.com/api/techdocs',\n );\n techdocsStorageApi.getBaseUrl.mockResolvedValue(\n `https://backstage.example.com/api/techdocs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`,\n );\n techdocsStorageApi.getEntityDocs.mockResolvedValue(\n renderToStaticMarkup(this.options.dom || defaultDom),\n );\n\n const TechDocsAddonsPage = () => {\n return (\n <TestApiProvider apis={apis}>\n <FlatRoutes>\n <Route\n path=\"/docs/:namespace/:kind/:name/*\"\n element={<TechDocsReaderPage />}\n >\n <TechDocsAddons>\n {this.addons.map((addon, index) =>\n React.cloneElement(addon, { key: index }),\n )}\n </TechDocsAddons>\n </Route>\n </FlatRoutes>\n </TestApiProvider>\n );\n };\n\n return wrapInTestApp(<TechDocsAddonsPage />, {\n routeEntries: [\n `/docs/${entityName.namespace}/${entityName.kind}/${entityName.name}/${this.options.path}`,\n ],\n mountedRoutes: {\n '/docs': techdocsPlugin.routes.root,\n '/docs/:namespace/:kind/:name/*': techdocsPlugin.routes.docRoot,\n '/catalog/:namespace/:kind/:name': entityRouteRef,\n },\n });\n }\n\n /**\n * Render the Addon within a fully configured and mocked TechDocs reader.\n *\n * @remarks\n * Components using useEffect to perform an asynchronous action (such as\n * fetch) must be rendered within an async act call to properly get the final\n * state, even with mocked responses. This utility method makes the signature\n * a bit cleaner, since act doesn't return the result of the evaluated\n * function.\n *\n * @see https://github.com/testing-library/react-testing-library/issues/281\n * @see https://github.com/facebook/react/pull/14853\n */\n async renderWithEffects(): Promise<\n typeof screen & { shadowRoot: ShadowRoot | null }\n > {\n await act(async () => {\n render(this.build());\n });\n\n const shadowHost = await screen.findByTestId('techdocs-native-shadowroot');\n\n return {\n ...screen,\n shadowRoot: shadowHost?.shadowRoot || null,\n };\n }\n}\n\nexport default TechDocsAddonTester.buildAddonsInTechDocs;\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AA6CA,IAAI,CAAC,OAAO,WAAa,EAAA;AACvB,EAAO,MAAA,CAAA,WAAA,GAAc,OAAQ,CAAA,MAAM,CAAE,CAAA,WAAA,CAAA;AACvC,CAAA;AACA,MAAM,EAAE,oBAAA,EACN,GAAA,OAAA,CAAQ,kBAAkB,CAAA,CAAA;AAuB5B,MAAM,cAA6C,GAAA;AAAA,EACjD,qBAAO,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,CAAA;AAAA,EACP,QAAQ,EAAE,QAAA,EAAU,EAAE,IAAA,EAAM,IAAK,EAAA;AAAA,EACjC,UAAU,EAAC;AAAA,EACX,WAAa,EAAA,MAAA;AAAA,EACb,MAAM,EAAC;AAAA,EACP,IAAM,EAAA,EAAA;AACR,CAAA,CAAA;AAEA,MAAM,eAAkB,GAAA;AAAA,EACtB,SAAW,EAAA,WAAA;AAAA,EACX,gBAAkB,EAAA,WAAA;AACpB,CAAA,CAAA;AAEA,MAAM,aAAgB,GAAA;AAAA,EACpB,IAAM,EAAA,WAAA;AAAA,EACN,QAAU,EAAA,EAAE,SAAW,EAAA,SAAA,EAAW,MAAM,MAAO,EAAA;AACjD,CAAA,CAAA;AAEA,MAAM,UACJ,mBAAA,KAAA,CAAA,aAAA,CAAC,MAAK,EAAA,EAAA,IAAA,EAAK,IACT,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,MAAK,EAAA,IAAA,CAAA,kBACL,KAAA,CAAA,aAAA,CAAA,MAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAI,qBAAkB,WACrB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAI,EAAA,EAAA,mBAAA,EAAkB,YAAa,EAAA,CAAA,kBACnC,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAI,mBAAkB,EAAA,KAAA,EAAM,CAC7B,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAI,EAAA,EAAA,mBAAA,EAAkB,MAAO,EAAA,CAChC,CACF,CACF,CAAA,CAAA;AAkBK,MAAM,mBAAoB,CAAA;AAAA;AAAA,EAYrB,YAAY,MAAwB,EAAA;AAX9C,IAAA,aAAA,CAAA,IAAA,EAAQ,SAAsC,EAAA,cAAA,CAAA,CAAA;AAC9C,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAWN,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA,EAPA,OAAO,sBAAsB,MAAwB,EAAA;AACnD,IAAO,OAAA,IAAI,oBAAoB,MAAM,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA;AAAA;AAAA,EAUA,SAA0B,IAAkC,EAAA;AAC1D,IAAA,MAAM,OAAO,IAAK,CAAA,GAAA,CAAI,CAAC,CAAC,GAAG,MAAM,GAAG,CAAA,CAAA;AACpC,IAAA,IAAA,CAAK,QAAQ,IAAO,GAAA,IAAA,CAAK,OAAQ,CAAA,IAAA,CAC9B,OAAO,CAAC,CAAC,GAAG,CAAA,KAAM,CAAC,IAAK,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA,CACrC,OAAO,IAAI,CAAA,CAAA;AACd,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,GAAmB,EAAA;AACzB,IAAA,IAAA,CAAK,QAAQ,GAAM,GAAA,GAAA,CAAA;AACnB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,QAAqC,EAAA;AAChD,IAAA,IAAA,CAAK,QAAQ,QAAW,GAAA,QAAA,CAAA;AACxB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW,MAAyC,EAAA;AAClD,IAAA,IAAA,CAAK,QAAQ,MAAS,GAAA,MAAA,CAAA;AACtB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,IAAc,EAAA;AACnB,IAAA,IAAA,CAAK,QAAQ,IAAO,GAAA,IAAA,CAAA;AACpB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,KAAQ,GAAA;AAxLV,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAyLI,IAAA,MAAM,WAAc,GAAA;AAAA,MAClB,mBAAA,EAAqB,KAAK,EAAG,EAAA;AAAA,MAC7B,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,MAC3B,SAAW,EAAA,IAAA,CAAK,EAAG,EAAA,CAAE,eAAgB,CAAA;AAAA;AAAA,QAEnC,SAAA,EAAW,IAAI,IAAA,CAAK,IAAK,CAAA,GAAA,KAAQ,EAAK,GAAA,EAAA,GAAK,GAAI,CAAA,CAAE,WAAY,EAAA;AAAA,OAC9D,CAAA;AAAA,KACH,CAAA;AAEA,IAAA,MAAM,kBAAqB,GAAA;AAAA,MACzB,YAAA,EAAc,KAAK,EAAG,EAAA;AAAA,MACtB,UAAA,EAAY,KAAK,EAAG,EAAA;AAAA,MACpB,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,MACvB,cAAA,EAAgB,KAAK,EAAG,EAAA;AAAA,KAC1B,CAAA;AAEA,IAAA,MAAM,SAAY,GAAA;AAAA,MAChB,KAAA,EAAO,KAAK,EAAG,EAAA,CAAE,kBAAkB,EAAE,OAAA,EAAS,EAAC,EAAG,CAAA;AAAA,KACpD,CAAA;AAEA,IAAA,MAAM,kBAAqB,GAAA;AAAA,MACzB,YAAY,IAAK,CAAA,EAAA,EAAK,CAAA,eAAA,CAAgB,EAAE,CAAA;AAAA,KAC1C,CAAA;AAEA,IAAA,MAAM,YAAe,GAAA;AAAA,MACnB,UAAY,EAAA,IAAA,CACT,EAAG,EAAA,CACH,kBAAkB,4CAA4C,CAAA;AAAA,KACnE,CAAA;AAEA,IAAA,MAAM,QAAW,GAAA;AAAA,MACf,KAAO,EAAA,IAAA,CAAK,EAAG,EAAA,CAAE,iBAAkB,CAAA;AAAA,QACjC,EAAI,EAAA,IAAA;AAAA,QACJ,IAAM,EAAA,IAAA,CAAK,EAAG,EAAA,CAAE,iBAAkB,CAAA;AAAA;AAAA,UAEhC,SAAA,EAAW,IAAI,IAAA,CAAK,IAAK,CAAA,GAAA,KAAQ,EAAK,GAAA,EAAA,GAAK,GAAI,CAAA,CAAE,WAAY,EAAA;AAAA,SAC9D,CAAA;AAAA,OACF,CAAA;AAAA,KACH,CAAA;AAEA,IAAA,MAAM,IAAuC,GAAA;AAAA,MAC3C,CAAC,aAAa,QAAQ,CAAA;AAAA,MACtB,CAAC,iBAAiB,YAAY,CAAA;AAAA,MAC9B,CAAC,gBAAgB,WAAW,CAAA;AAAA,MAC5B,CAAC,uBAAuB,kBAAkB,CAAA;AAAA,MAC1C,CAAC,cAAc,SAAS,CAAA;AAAA,MACxB,CAAC,uBAAuB,kBAAkB,CAAA;AAAA,MAC1C,GAAG,KAAK,OAAQ,CAAA,IAAA;AAAA,KAClB,CAAA;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,SAAA,EAAA,CAAA,CACE,gBAAK,OAAQ,CAAA,MAAA,KAAb,mBAAqB,QAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA+B,SAC/B,KAAA,aAAA,CAAc,QAAS,CAAA,SAAA;AAAA,MACzB,QAAM,EAAK,GAAA,IAAA,CAAA,OAAA,CAAQ,MAAb,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqB,SAAQ,aAAc,CAAA,IAAA;AAAA,MACjD,IAAA,EAAA,CAAA,CAAM,gBAAK,OAAQ,CAAA,MAAA,KAAb,mBAAqB,QAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA+B,IAAQ,KAAA,aAAA,CAAc,QAAS,CAAA,IAAA;AAAA,KACtE,CAAA;AAEA,IAAA,WAAA,CAAY,mBAAoB,CAAA,eAAA;AAAA,MAC9B,IAAK,CAAA,OAAA,CAAQ,QAAY,IAAA,EAAE,GAAG,eAAgB,EAAA;AAAA,KAChD,CAAA;AACA,IAAA,WAAA,CAAY,iBAAkB,CAAA,iBAAA;AAAA,MAC5B,IAAK,CAAA,OAAA,CAAQ,MAAU,IAAA,EAAE,GAAG,aAAc,EAAA;AAAA,KAC5C,CAAA;AAEA,IAAmB,kBAAA,CAAA,cAAA,CAAe,kBAAkB,QAAQ,CAAA,CAAA;AAC5D,IAAA,kBAAA,CAAmB,YAAa,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,kBAAA,CAAmB,UAAW,CAAA,iBAAA;AAAA,MAC5B,CAA8C,2CAAA,EAAA,UAAA,CAAW,SAAS,CAAA,CAAA,EAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,CAAA,EAAI,IAAK,CAAA,OAAA,CAAQ,IAAI,CAAA,CAAA;AAAA,KAC/H,CAAA;AACA,IAAA,kBAAA,CAAmB,aAAc,CAAA,iBAAA;AAAA,MAC/B,oBAAqB,CAAA,IAAA,CAAK,OAAQ,CAAA,GAAA,IAAO,UAAU,CAAA;AAAA,KACrD,CAAA;AAEA,IAAA,MAAM,qBAAqB,MAAM;AAC/B,MAAA,uBACG,KAAA,CAAA,aAAA,CAAA,eAAA,EAAA,EAAgB,IACf,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,UACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,KAAA;AAAA,QAAA;AAAA,UACC,IAAK,EAAA,gCAAA;AAAA,UACL,OAAA,sCAAU,kBAAmB,EAAA,IAAA,CAAA;AAAA,SAAA;AAAA,wBAE7B,KAAA,CAAA,aAAA,CAAC,cACE,EAAA,IAAA,EAAA,IAAA,CAAK,MAAO,CAAA,GAAA;AAAA,UAAI,CAAC,OAAO,KACvB,KAAA,KAAA,CAAM,aAAa,KAAO,EAAA,EAAE,GAAK,EAAA,KAAA,EAAO,CAAA;AAAA,SAE5C,CAAA;AAAA,OAEJ,CACF,CAAA,CAAA;AAAA,KAEJ,CAAA;AAEA,IAAO,OAAA,aAAA,iBAAe,KAAA,CAAA,aAAA,CAAA,kBAAA,EAAA,IAAmB,CAAI,EAAA;AAAA,MAC3C,YAAc,EAAA;AAAA,QACZ,CAAS,MAAA,EAAA,UAAA,CAAW,SAAS,CAAA,CAAA,EAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,CAAA,EAAI,IAAK,CAAA,OAAA,CAAQ,IAAI,CAAA,CAAA;AAAA,OAC1F;AAAA,MACA,aAAe,EAAA;AAAA,QACb,OAAA,EAAS,eAAe,MAAO,CAAA,IAAA;AAAA,QAC/B,gCAAA,EAAkC,eAAe,MAAO,CAAA,OAAA;AAAA,QACxD,iCAAmC,EAAA,cAAA;AAAA,OACrC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,MAAM,iBAEJ,GAAA;AACA,IAAA,MAAM,IAAI,YAAY;AACpB,MAAO,MAAA,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAAA,KACpB,CAAA,CAAA;AAED,IAAA,MAAM,UAAa,GAAA,MAAM,MAAO,CAAA,YAAA,CAAa,4BAA4B,CAAA,CAAA;AAEzE,IAAO,OAAA;AAAA,MACL,GAAG,MAAA;AAAA,MACH,UAAA,EAAA,CAAY,yCAAY,UAAc,KAAA,IAAA;AAAA,KACxC,CAAA;AAAA,GACF;AACF,CAAA;AAEe,mBAAoB,CAAA,qBAAA;;;;"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs-addons-test-utils",
-  "version": "1.0.31",
+  "version": "1.0.32-next.1",
   "backstage": {
     "role": "web-library"
   },
@@ -39,17 +39,17 @@
     "@backstage/core-app-api": "^1.12.4",
     "@backstage/core-plugin-api": "^1.9.2",
     "@backstage/integration-react": "^1.1.26",
-    "@backstage/plugin-catalog": "^1.19.0",
-    "@backstage/plugin-catalog-react": "^1.11.3",
-    "@backstage/plugin-search-react": "^1.7.10",
-    "@backstage/plugin-techdocs": "^1.10.4",
-    "@backstage/plugin-techdocs-react": "^1.2.3",
-    "@backstage/test-utils": "^1.5.4",
+    "@backstage/plugin-catalog": "^1.19.1-next.1",
+    "@backstage/plugin-catalog-react": "^1.11.4-next.1",
+    "@backstage/plugin-search-react": "^1.7.11-next.1",
+    "@backstage/plugin-techdocs": "^1.10.5-next.1",
+    "@backstage/plugin-techdocs-react": "^1.2.4-next.1",
+    "@backstage/test-utils": "^1.5.5-next.0",
     "@types/react": "^16.13.1 || ^17.0.0 || ^18.0.0",
     "testing-library__dom": "^7.29.4-beta.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.3",
+    "@backstage/cli": "^0.26.5-next.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0"
   },