@backstage/plugin-techdocs 1.7.1-next.2 → 1.8.1-next.0

package/dist/esm/routes-691e552c.esm.js

@@ -0,0 +1,178 @@
+import { ResponseError, NotFoundError } from '@backstage/errors';
+import { EventSourcePolyfill } from 'event-source-polyfill';
+import { createRouteRef } from '@backstage/core-plugin-api';
+
+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;
+};
+class TechDocsClient {
+  constructor(options) {
+    __publicField(this, "configApi");
+    __publicField(this, "discoveryApi");
+    __publicField(this, "fetchApi");
+    this.configApi = options.configApi;
+    this.discoveryApi = options.discoveryApi;
+    this.fetchApi = options.fetchApi;
+  }
+  async getApiOrigin() {
+    return await this.discoveryApi.getBaseUrl("techdocs");
+  }
+  /**
+   * Retrieve TechDocs metadata.
+   *
+   * When docs are built, we generate a techdocs_metadata.json and store it along with the generated
+   * static files. It includes necessary data about the docs site. This method requests techdocs-backend
+   * which retrieves the TechDocs metadata.
+   *
+   * @param entityId - Object containing entity data like name, namespace, etc.
+   */
+  async getTechDocsMetadata(entityId) {
+    const { kind, namespace, name } = entityId;
+    const apiOrigin = await this.getApiOrigin();
+    const requestUrl = `${apiOrigin}/metadata/techdocs/${namespace}/${kind}/${name}`;
+    const request = await this.fetchApi.fetch(`${requestUrl}`);
+    if (!request.ok) {
+      throw await ResponseError.fromResponse(request);
+    }
+    return await request.json();
+  }
+  /**
+   * Retrieve metadata about an entity.
+   *
+   * This method requests techdocs-backend which uses the catalog APIs to respond with filtered
+   * information required here.
+   *
+   * @param entityId - Object containing entity data like name, namespace, etc.
+   */
+  async getEntityMetadata(entityId) {
+    const { kind, namespace, name } = entityId;
+    const apiOrigin = await this.getApiOrigin();
+    const requestUrl = `${apiOrigin}/metadata/entity/${namespace}/${kind}/${name}`;
+    const request = await this.fetchApi.fetch(`${requestUrl}`);
+    if (!request.ok) {
+      throw await ResponseError.fromResponse(request);
+    }
+    return await request.json();
+  }
+}
+class TechDocsStorageClient {
+  constructor(options) {
+    __publicField(this, "configApi");
+    __publicField(this, "discoveryApi");
+    __publicField(this, "identityApi");
+    __publicField(this, "fetchApi");
+    this.configApi = options.configApi;
+    this.discoveryApi = options.discoveryApi;
+    this.identityApi = options.identityApi;
+    this.fetchApi = options.fetchApi;
+  }
+  async getApiOrigin() {
+    return await this.discoveryApi.getBaseUrl("techdocs");
+  }
+  async getStorageUrl() {
+    var _a;
+    return (_a = this.configApi.getOptionalString("techdocs.storageUrl")) != null ? _a : `${await this.discoveryApi.getBaseUrl("techdocs")}/static/docs`;
+  }
+  async getBuilder() {
+    return this.configApi.getString("techdocs.builder");
+  }
+  /**
+   * Fetch HTML content as text for an individual docs page in an entity's docs site.
+   *
+   * @param entityId - Object containing entity data like name, namespace, etc.
+   * @param path - The unique path to an individual docs page e.g. overview/what-is-new
+   * @returns HTML content of the docs page as string
+   * @throws Throws error when the page is not found.
+   */
+  async getEntityDocs(entityId, path) {
+    const { kind, namespace, name } = entityId;
+    const storageUrl = await this.getStorageUrl();
+    const url = `${storageUrl}/${namespace}/${kind}/${name}/${path}`;
+    const request = await this.fetchApi.fetch(
+      `${url.endsWith("/") ? url : `${url}/`}index.html`
+    );
+    let errorMessage = "";
+    switch (request.status) {
+      case 404:
+        errorMessage = "Page not found. ";
+        if (!path) {
+          errorMessage += "This could be because there is no index.md file in the root of the docs directory of this repository.";
+        }
+        throw new NotFoundError(errorMessage);
+      case 500:
+        errorMessage = "Could not generate documentation or an error in the TechDocs backend. ";
+        throw new Error(errorMessage);
+    }
+    return request.text();
+  }
+  /**
+   * Check if docs are on the latest version and trigger rebuild if not
+   *
+   * @param entityId - Object containing entity data like name, namespace, etc.
+   * @param logHandler - Callback to receive log messages from the build process
+   * @returns Whether documents are currently synchronized to newest version
+   * @throws Throws error on error from sync endpoint in TechDocs Backend
+   */
+  async syncEntityDocs(entityId, logHandler = () => {
+  }) {
+    const { kind, namespace, name } = entityId;
+    const apiOrigin = await this.getApiOrigin();
+    const url = `${apiOrigin}/sync/${namespace}/${kind}/${name}`;
+    const { token } = await this.identityApi.getCredentials();
+    return new Promise((resolve, reject) => {
+      const source = new EventSourcePolyfill(url, {
+        withCredentials: true,
+        headers: token ? { Authorization: `Bearer ${token}` } : {}
+      });
+      source.addEventListener("log", (e) => {
+        if (e.data) {
+          logHandler(JSON.parse(e.data));
+        }
+      });
+      source.addEventListener("finish", (e) => {
+        let updated = false;
+        if (e.data) {
+          ({ updated } = JSON.parse(e.data));
+        }
+        resolve(updated ? "updated" : "cached");
+      });
+      source.onerror = (e) => {
+        source.close();
+        switch (e.status) {
+          case 404:
+            reject(new NotFoundError(e.message));
+            return;
+          default:
+            reject(new Error(e.data));
+            return;
+        }
+      };
+    });
+  }
+  async getBaseUrl(oldBaseUrl, entityId, path) {
+    const { kind, namespace, name } = entityId;
+    const apiOrigin = await this.getApiOrigin();
+    const newBaseUrl = `${apiOrigin}/static/docs/${namespace}/${kind}/${name}/${path}`;
+    return new URL(
+      oldBaseUrl,
+      newBaseUrl.endsWith("/") ? newBaseUrl : `${newBaseUrl}/`
+    ).toString();
+  }
+}
+
+const rootRouteRef = createRouteRef({
+  id: "techdocs:index-page"
+});
+const rootDocsRouteRef = createRouteRef({
+  id: "techdocs:reader-page",
+  params: ["namespace", "kind", "name"]
+});
+const rootCatalogDocsRouteRef = createRouteRef({
+  id: "techdocs:catalog-reader-view"
+});
+
+export { TechDocsClient as T, TechDocsStorageClient as a, rootDocsRouteRef as b, rootCatalogDocsRouteRef as c, rootRouteRef as r };
+//# sourceMappingURL=routes-691e552c.esm.js.map

package/dist/esm/routes-691e552c.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes-691e552c.esm.js","sources":["../../src/client.ts","../../src/routes.ts"],"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 { CompoundEntityRef } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n  DiscoveryApi,\n  FetchApi,\n  IdentityApi,\n} from '@backstage/core-plugin-api';\nimport { NotFoundError, ResponseError } from '@backstage/errors';\nimport {\n  SyncResult,\n  TechDocsApi,\n  TechDocsEntityMetadata,\n  TechDocsMetadata,\n  TechDocsStorageApi,\n} from '@backstage/plugin-techdocs-react';\nimport { EventSourcePolyfill } from 'event-source-polyfill';\n\n/**\n * API to talk to `techdocs-backend`.\n *\n * @public\n */\nexport class TechDocsClient implements TechDocsApi {\n  public configApi: Config;\n  public discoveryApi: DiscoveryApi;\n  private fetchApi: FetchApi;\n\n  constructor(options: {\n    configApi: Config;\n    discoveryApi: DiscoveryApi;\n    fetchApi: FetchApi;\n  }) {\n    this.configApi = options.configApi;\n    this.discoveryApi = options.discoveryApi;\n    this.fetchApi = options.fetchApi;\n  }\n\n  async getApiOrigin(): Promise<string> {\n    return await this.discoveryApi.getBaseUrl('techdocs');\n  }\n\n  /**\n   * Retrieve TechDocs metadata.\n   *\n   * When docs are built, we generate a techdocs_metadata.json and store it along with the generated\n   * static files. It includes necessary data about the docs site. This method requests techdocs-backend\n   * which retrieves the TechDocs metadata.\n   *\n   * @param entityId - Object containing entity data like name, namespace, etc.\n   */\n  async getTechDocsMetadata(\n    entityId: CompoundEntityRef,\n  ): Promise<TechDocsMetadata> {\n    const { kind, namespace, name } = entityId;\n\n    const apiOrigin = await this.getApiOrigin();\n    const requestUrl = `${apiOrigin}/metadata/techdocs/${namespace}/${kind}/${name}`;\n    const request = await this.fetchApi.fetch(`${requestUrl}`);\n    if (!request.ok) {\n      throw await ResponseError.fromResponse(request);\n    }\n\n    return await request.json();\n  }\n\n  /**\n   * Retrieve metadata about an entity.\n   *\n   * This method requests techdocs-backend which uses the catalog APIs to respond with filtered\n   * information required here.\n   *\n   * @param entityId - Object containing entity data like name, namespace, etc.\n   */\n  async getEntityMetadata(\n    entityId: CompoundEntityRef,\n  ): Promise<TechDocsEntityMetadata> {\n    const { kind, namespace, name } = entityId;\n\n    const apiOrigin = await this.getApiOrigin();\n    const requestUrl = `${apiOrigin}/metadata/entity/${namespace}/${kind}/${name}`;\n\n    const request = await this.fetchApi.fetch(`${requestUrl}`);\n    if (!request.ok) {\n      throw await ResponseError.fromResponse(request);\n    }\n\n    return await request.json();\n  }\n}\n\n/**\n * API which talks to TechDocs storage to fetch files to render.\n *\n * @public\n */\nexport class TechDocsStorageClient implements TechDocsStorageApi {\n  public configApi: Config;\n  public discoveryApi: DiscoveryApi;\n  public identityApi: IdentityApi;\n  private fetchApi: FetchApi;\n\n  constructor(options: {\n    configApi: Config;\n    discoveryApi: DiscoveryApi;\n    identityApi: IdentityApi;\n    fetchApi: FetchApi;\n  }) {\n    this.configApi = options.configApi;\n    this.discoveryApi = options.discoveryApi;\n    this.identityApi = options.identityApi;\n    this.fetchApi = options.fetchApi;\n  }\n\n  async getApiOrigin(): Promise<string> {\n    return await this.discoveryApi.getBaseUrl('techdocs');\n  }\n\n  async getStorageUrl(): Promise<string> {\n    return (\n      this.configApi.getOptionalString('techdocs.storageUrl') ??\n      `${await this.discoveryApi.getBaseUrl('techdocs')}/static/docs`\n    );\n  }\n\n  async getBuilder(): Promise<string> {\n    return this.configApi.getString('techdocs.builder');\n  }\n\n  /**\n   * Fetch HTML content as text for an individual docs page in an entity's docs site.\n   *\n   * @param entityId - Object containing entity data like name, namespace, etc.\n   * @param path - The unique path to an individual docs page e.g. overview/what-is-new\n   * @returns HTML content of the docs page as string\n   * @throws Throws error when the page is not found.\n   */\n  async getEntityDocs(\n    entityId: CompoundEntityRef,\n    path: string,\n  ): Promise<string> {\n    const { kind, namespace, name } = entityId;\n\n    const storageUrl = await this.getStorageUrl();\n    const url = `${storageUrl}/${namespace}/${kind}/${name}/${path}`;\n\n    const request = await this.fetchApi.fetch(\n      `${url.endsWith('/') ? url : `${url}/`}index.html`,\n    );\n\n    let errorMessage = '';\n    switch (request.status) {\n      case 404:\n        errorMessage = 'Page not found. ';\n        // path is empty for the home page of an entity's docs site\n        if (!path) {\n          errorMessage +=\n            'This could be because there is no index.md file in the root of the docs directory of this repository.';\n        }\n        throw new NotFoundError(errorMessage);\n      case 500:\n        errorMessage =\n          'Could not generate documentation or an error in the TechDocs backend. ';\n        throw new Error(errorMessage);\n      default:\n        // Do nothing\n        break;\n    }\n\n    return request.text();\n  }\n\n  /**\n   * Check if docs are on the latest version and trigger rebuild if not\n   *\n   * @param entityId - Object containing entity data like name, namespace, etc.\n   * @param logHandler - Callback to receive log messages from the build process\n   * @returns Whether documents are currently synchronized to newest version\n   * @throws Throws error on error from sync endpoint in TechDocs Backend\n   */\n  async syncEntityDocs(\n    entityId: CompoundEntityRef,\n    logHandler: (line: string) => void = () => {},\n  ): Promise<SyncResult> {\n    const { kind, namespace, name } = entityId;\n\n    const apiOrigin = await this.getApiOrigin();\n    const url = `${apiOrigin}/sync/${namespace}/${kind}/${name}`;\n    const { token } = await this.identityApi.getCredentials();\n\n    return new Promise((resolve, reject) => {\n      // Polyfill is used to add support for custom headers and auth\n      const source = new EventSourcePolyfill(url, {\n        withCredentials: true,\n        headers: token ? { Authorization: `Bearer ${token}` } : {},\n      });\n\n      source.addEventListener('log', (e: any) => {\n        if (e.data) {\n          logHandler(JSON.parse(e.data));\n        }\n      });\n\n      source.addEventListener('finish', (e: any) => {\n        let updated: boolean = false;\n\n        if (e.data) {\n          ({ updated } = JSON.parse(e.data));\n        }\n\n        resolve(updated ? 'updated' : 'cached');\n      });\n\n      source.onerror = (e: any) => {\n        source.close();\n\n        switch (e.status) {\n          // the endpoint returned a 404 status\n          case 404:\n            reject(new NotFoundError(e.message));\n            return;\n\n          // also handles the event-stream close. the reject is ignored if the Promise was already\n          // resolved by a finish event.\n          default:\n            reject(new Error(e.data));\n            return;\n        }\n      };\n    });\n  }\n\n  async getBaseUrl(\n    oldBaseUrl: string,\n    entityId: CompoundEntityRef,\n    path: string,\n  ): Promise<string> {\n    const { kind, namespace, name } = entityId;\n\n    const apiOrigin = await this.getApiOrigin();\n    const newBaseUrl = `${apiOrigin}/static/docs/${namespace}/${kind}/${name}/${path}`;\n\n    return new URL(\n      oldBaseUrl,\n      newBaseUrl.endsWith('/') ? newBaseUrl : `${newBaseUrl}/`,\n    ).toString();\n  }\n}\n","/*\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 { createRouteRef } from '@backstage/core-plugin-api';\n\nexport const rootRouteRef = createRouteRef({\n  id: 'techdocs:index-page',\n});\n\nexport const rootDocsRouteRef = createRouteRef({\n  id: 'techdocs:reader-page',\n  params: ['namespace', 'kind', 'name'],\n});\n\nexport const rootCatalogDocsRouteRef = createRouteRef({\n  id: 'techdocs:catalog-reader-view',\n});\n"],"names":[],"mappings":";;;;;;;;;;AAsCO,MAAM,cAAsC,CAAA;AAAA,EAKjD,YAAY,OAIT,EAAA;AARH,IAAO,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACP,IAAO,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACP,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AAON,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,WAAW,OAAQ,CAAA,QAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,MAAM,YAAgC,GAAA;AACpC,IAAA,OAAO,MAAM,IAAA,CAAK,YAAa,CAAA,UAAA,CAAW,UAAU,CAAA,CAAA;AAAA,GACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,oBACJ,QAC2B,EAAA;AAC3B,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,EAAS,GAAA,QAAA,CAAA;AAElC,IAAM,MAAA,SAAA,GAAY,MAAM,IAAA,CAAK,YAAa,EAAA,CAAA;AAC1C,IAAM,MAAA,UAAA,GAAa,GAAG,SAAS,CAAA,mBAAA,EAAsB,SAAS,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA,CAAA;AAC9E,IAAA,MAAM,UAAU,MAAM,IAAA,CAAK,SAAS,KAAM,CAAA,CAAA,EAAG,UAAU,CAAE,CAAA,CAAA,CAAA;AACzD,IAAI,IAAA,CAAC,QAAQ,EAAI,EAAA;AACf,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,OAAO,CAAA,CAAA;AAAA,KAChD;AAEA,IAAO,OAAA,MAAM,QAAQ,IAAK,EAAA,CAAA;AAAA,GAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,kBACJ,QACiC,EAAA;AACjC,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,EAAS,GAAA,QAAA,CAAA;AAElC,IAAM,MAAA,SAAA,GAAY,MAAM,IAAA,CAAK,YAAa,EAAA,CAAA;AAC1C,IAAM,MAAA,UAAA,GAAa,GAAG,SAAS,CAAA,iBAAA,EAAoB,SAAS,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA,CAAA;AAE5E,IAAA,MAAM,UAAU,MAAM,IAAA,CAAK,SAAS,KAAM,CAAA,CAAA,EAAG,UAAU,CAAE,CAAA,CAAA,CAAA;AACzD,IAAI,IAAA,CAAC,QAAQ,EAAI,EAAA;AACf,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,OAAO,CAAA,CAAA;AAAA,KAChD;AAEA,IAAO,OAAA,MAAM,QAAQ,IAAK,EAAA,CAAA;AAAA,GAC5B;AACF,CAAA;AAOO,MAAM,qBAAoD,CAAA;AAAA,EAM/D,YAAY,OAKT,EAAA;AAVH,IAAO,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACP,IAAO,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACP,IAAO,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AACP,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AAQN,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,WAAW,OAAQ,CAAA,QAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,MAAM,YAAgC,GAAA;AACpC,IAAA,OAAO,MAAM,IAAA,CAAK,YAAa,CAAA,UAAA,CAAW,UAAU,CAAA,CAAA;AAAA,GACtD;AAAA,EAEA,MAAM,aAAiC,GAAA;AArIzC,IAAA,IAAA,EAAA,CAAA;AAsII,IAAA,OAAA,CACE,EAAK,GAAA,IAAA,CAAA,SAAA,CAAU,iBAAkB,CAAA,qBAAqB,CAAtD,KAAA,IAAA,GAAA,EAAA,GACA,CAAG,EAAA,MAAM,IAAK,CAAA,YAAA,CAAa,UAAW,CAAA,UAAU,CAAC,CAAA,YAAA,CAAA,CAAA;AAAA,GAErD;AAAA,EAEA,MAAM,UAA8B,GAAA;AAClC,IAAO,OAAA,IAAA,CAAK,SAAU,CAAA,SAAA,CAAU,kBAAkB,CAAA,CAAA;AAAA,GACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,aACJ,CAAA,QAAA,EACA,IACiB,EAAA;AACjB,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,EAAS,GAAA,QAAA,CAAA;AAElC,IAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,aAAc,EAAA,CAAA;AAC5C,IAAM,MAAA,GAAA,GAAM,CAAG,EAAA,UAAU,CAAI,CAAA,EAAA,SAAS,IAAI,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,CAAA;AAE9D,IAAM,MAAA,OAAA,GAAU,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA;AAAA,MAClC,CAAA,EAAG,IAAI,QAAS,CAAA,GAAG,IAAI,GAAM,GAAA,CAAA,EAAG,GAAG,CAAG,CAAA,CAAA,CAAA,UAAA,CAAA;AAAA,KACxC,CAAA;AAEA,IAAA,IAAI,YAAe,GAAA,EAAA,CAAA;AACnB,IAAA,QAAQ,QAAQ,MAAQ;AAAA,MACtB,KAAK,GAAA;AACH,QAAe,YAAA,GAAA,kBAAA,CAAA;AAEf,QAAA,IAAI,CAAC,IAAM,EAAA;AACT,UACE,YAAA,IAAA,uGAAA,CAAA;AAAA,SACJ;AACA,QAAM,MAAA,IAAI,cAAc,YAAY,CAAA,CAAA;AAAA,MACtC,KAAK,GAAA;AACH,QACE,YAAA,GAAA,wEAAA,CAAA;AACF,QAAM,MAAA,IAAI,MAAM,YAAY,CAAA,CAAA;AAG5B,KACJ;AAEA,IAAA,OAAO,QAAQ,IAAK,EAAA,CAAA;AAAA,GACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,cAAA,CACJ,QACA,EAAA,UAAA,GAAqC,MAAM;AAAA,GACtB,EAAA;AACrB,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,EAAS,GAAA,QAAA,CAAA;AAElC,IAAM,MAAA,SAAA,GAAY,MAAM,IAAA,CAAK,YAAa,EAAA,CAAA;AAC1C,IAAM,MAAA,GAAA,GAAM,GAAG,SAAS,CAAA,MAAA,EAAS,SAAS,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA,CAAA;AAC1D,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,YAAY,cAAe,EAAA,CAAA;AAExD,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AAEtC,MAAM,MAAA,MAAA,GAAS,IAAI,mBAAA,CAAoB,GAAK,EAAA;AAAA,QAC1C,eAAiB,EAAA,IAAA;AAAA,QACjB,OAAA,EAAS,QAAQ,EAAE,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA,KAAO,EAAC;AAAA,OAC1D,CAAA,CAAA;AAED,MAAO,MAAA,CAAA,gBAAA,CAAiB,KAAO,EAAA,CAAC,CAAW,KAAA;AACzC,QAAA,IAAI,EAAE,IAAM,EAAA;AACV,UAAA,UAAA,CAAW,IAAK,CAAA,KAAA,CAAM,CAAE,CAAA,IAAI,CAAC,CAAA,CAAA;AAAA,SAC/B;AAAA,OACD,CAAA,CAAA;AAED,MAAO,MAAA,CAAA,gBAAA,CAAiB,QAAU,EAAA,CAAC,CAAW,KAAA;AAC5C,QAAA,IAAI,OAAmB,GAAA,KAAA,CAAA;AAEvB,QAAA,IAAI,EAAE,IAAM,EAAA;AACV,UAAA,CAAC,EAAE,OAAQ,EAAA,GAAI,IAAK,CAAA,KAAA,CAAM,EAAE,IAAI,CAAA,EAAA;AAAA,SAClC;AAEA,QAAQ,OAAA,CAAA,OAAA,GAAU,YAAY,QAAQ,CAAA,CAAA;AAAA,OACvC,CAAA,CAAA;AAED,MAAO,MAAA,CAAA,OAAA,GAAU,CAAC,CAAW,KAAA;AAC3B,QAAA,MAAA,CAAO,KAAM,EAAA,CAAA;AAEb,QAAA,QAAQ,EAAE,MAAQ;AAAA,UAEhB,KAAK,GAAA;AACH,YAAA,MAAA,CAAO,IAAI,aAAA,CAAc,CAAE,CAAA,OAAO,CAAC,CAAA,CAAA;AACnC,YAAA,OAAA;AAAA,UAIF;AACE,YAAA,MAAA,CAAO,IAAI,KAAA,CAAM,CAAE,CAAA,IAAI,CAAC,CAAA,CAAA;AACxB,YAAA,OAAA;AAAA,SACJ;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,UAAA,CACJ,UACA,EAAA,QAAA,EACA,IACiB,EAAA;AACjB,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,EAAS,GAAA,QAAA,CAAA;AAElC,IAAM,MAAA,SAAA,GAAY,MAAM,IAAA,CAAK,YAAa,EAAA,CAAA;AAC1C,IAAM,MAAA,UAAA,GAAa,CAAG,EAAA,SAAS,CAAgB,aAAA,EAAA,SAAS,IAAI,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,CAAA;AAEhF,IAAA,OAAO,IAAI,GAAA;AAAA,MACT,UAAA;AAAA,MACA,WAAW,QAAS,CAAA,GAAG,CAAI,GAAA,UAAA,GAAa,GAAG,UAAU,CAAA,CAAA,CAAA;AAAA,MACrD,QAAS,EAAA,CAAA;AAAA,GACb;AACF;;ACpPO,MAAM,eAAe,cAAe,CAAA;AAAA,EACzC,EAAI,EAAA,qBAAA;AACN,CAAC,EAAA;AAEM,MAAM,mBAAmB,cAAe,CAAA;AAAA,EAC7C,EAAI,EAAA,sBAAA;AAAA,EACJ,MAAQ,EAAA,CAAC,WAAa,EAAA,MAAA,EAAQ,MAAM,CAAA;AACtC,CAAC,EAAA;AAEM,MAAM,0BAA0B,cAAe,CAAA;AAAA,EACpD,EAAI,EAAA,8BAAA;AACN,CAAC;;;;"}

package/dist/index.esm.js

@@ -1,24 +1,29 @@
-export { u as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, y as EmbeddedDocsRouter, r as EntityListDocsGrid, s as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, x as Router, k as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, o as TechDocsReaderPageContent, n as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, m as TechDocsReaderProvider, q as TechDocsSearch, h as TechDocsSearchResultListItem, l as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, j as techdocsApiRef, t as techdocsPlugin, i as techdocsStorageApiRef } from './esm/index-683d6465.esm.js';
-import '@backstage/core-plugin-api';
+import { createApiRef } from '@backstage/core-plugin-api';
+export { T as TechDocsClient, a as TechDocsStorageClient } from './esm/routes-691e552c.esm.js';
+export { R as Reader, a as TechDocsReaderLayout, c as TechDocsReaderPageContent, b as TechDocsReaderPageHeader, d as TechDocsReaderPageSubheader, T as TechDocsReaderProvider, e as TechDocsSearch } from './esm/TechDocsReaderPage-89ab8b88.esm.js';
+import { D as DocsCardGrid } from './esm/DocsCardGrid-66754d32.esm.js';
+export { D as DocsCardGrid } from './esm/DocsCardGrid-66754d32.esm.js';
+import { WarningPanel, CodeSnippet, Progress, Link, Content, ContentHeader } from '@backstage/core-components';
+import { useEntityList, useEntityOwnership } from '@backstage/plugin-catalog-react';
+import { Typography } from '@material-ui/core';
+import React from 'react';
+export { a as DefaultTechDocsHome, D as DocsTable, E as EntityListDocsTable, T as TechDocsPageWrapper, b as TechDocsPicker } from './esm/TechDocsIndexPage-a43a1a1c.esm.js';
+export { e as EmbeddedDocsRouter, E as EntityTechdocsContent, R as Router, T as TechDocsCustomHome, a as TechDocsIndexPage, c as TechDocsReaderPage, d as TechDocsSearchResultListItem, b as TechdocsPage, i as isTechDocsAvailable, t as plugin, t as techdocsPlugin } from './esm/Router-1532ca7a.esm.js';
 import '@backstage/errors';
 import 'event-source-polyfill';
-import 'react';
 import 'react-router-dom';
 import '@backstage/plugin-techdocs-react';
-import 'react-use/lib/useAsync';
-import 'react-use/lib/useAsyncRetry';
-import '@backstage/core-components';
-import '@material-ui/core';
 import '@backstage/plugin-search-react';
 import './esm/TechDocsSearchResultListItem-4736f829.esm.js';
 import '@material-ui/core/Typography';
 import '@material-ui/lab';
 import '@material-ui/icons/Close';
+import 'react-use/lib/useAsync';
+import 'react-use/lib/useAsyncRetry';
 import '@backstage/integration-react';
 import 'dompurify';
 import '@backstage/integration';
 import '@material-ui/icons/FeedbackOutlined';
-import 'react-dom';
 import 'git-url-parse';
 import '@material-ui/icons/Menu';
 import '@material-ui/core/IconButton';
@@ -26,7 +31,6 @@ import 'react-use/lib/useCopyToClipboard';
 import 'react-helmet';
 import '@material-ui/core/styles';
 import '@material-ui/icons/Code';
-import '@backstage/plugin-catalog-react';
 import '@backstage/catalog-model';
 import 'lodash';
 import '@material-ui/icons/Settings';
@@ -34,4 +38,73 @@ import '@material-ui/icons/Share';
 import '@material-ui/styles';
 import '@material-ui/icons/Star';
 import '@material-ui/icons/StarBorder';
+
+const techdocsStorageApiRef = createApiRef({
+  id: "plugin.techdocs.storageservice"
+});
+const techdocsApiRef = createApiRef({
+  id: "plugin.techdocs.service"
+});
+
+const allEntitiesGroup = {
+  title: "All Documentation",
+  filterPredicate: () => true
+};
+const EntityListDocsGridGroup = (props) => {
+  const { entities, group } = props;
+  const { loading: loadingOwnership, isOwnedEntity } = useEntityOwnership();
+  const shownEntities = entities.filter((entity) => {
+    if (group.filterPredicate === "ownedByUser") {
+      if (loadingOwnership) {
+        return false;
+      }
+      return isOwnedEntity(entity);
+    }
+    return typeof group.filterPredicate === "function" && group.filterPredicate(entity);
+  });
+  const titleComponent = (() => {
+    return typeof group.title === "string" ? /* @__PURE__ */ React.createElement(ContentHeader, { title: group.title }) : group.title;
+  })();
+  if (shownEntities.length === 0) {
+    return null;
+  }
+  return /* @__PURE__ */ React.createElement(Content, null, titleComponent, /* @__PURE__ */ React.createElement(DocsCardGrid, { entities: shownEntities }));
+};
+const EntityListDocsGrid = (props) => {
+  const { loading, error, entities } = useEntityList();
+  if (error) {
+    return /* @__PURE__ */ React.createElement(
+      WarningPanel,
+      {
+        severity: "error",
+        title: "Could not load available documentation."
+      },
+      /* @__PURE__ */ React.createElement(CodeSnippet, { language: "text", text: error.toString() })
+    );
+  }
+  if (loading) {
+    return /* @__PURE__ */ React.createElement(Progress, null);
+  }
+  if (entities.length === 0) {
+    return /* @__PURE__ */ React.createElement("div", { "data-testid": "doc-not-found" }, /* @__PURE__ */ React.createElement(Typography, { variant: "body2" }, "No documentation found that match your filter. Learn more about", " ", /* @__PURE__ */ React.createElement(Link, { to: "https://backstage.io/docs/features/techdocs/creating-and-publishing" }, "publishing documentation"), "."));
+  }
+  entities.sort(
+    (a, b) => {
+      var _a, _b;
+      return ((_a = a.metadata.title) != null ? _a : a.metadata.name).localeCompare(
+        (_b = b.metadata.title) != null ? _b : b.metadata.name
+      );
+    }
+  );
+  return /* @__PURE__ */ React.createElement(Content, null, (props.groups || [allEntitiesGroup]).map((group, index) => /* @__PURE__ */ React.createElement(
+    EntityListDocsGridGroup,
+    {
+      entities,
+      group,
+      key: `${group.title}-${index}`
+    }
+  )));
+};
+
+export { EntityListDocsGrid, techdocsApiRef, techdocsStorageApiRef };
 //# 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":["../src/api.ts","../src/home/components/Grids/EntityListDocsGrid.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 { CompoundEntityRef } from '@backstage/catalog-model';\nimport {\n  TechDocsEntityMetadata,\n  TechDocsMetadata,\n} from '@backstage/plugin-techdocs-react';\nimport { createApiRef } from '@backstage/core-plugin-api';\n\n/**\n * Utility API reference for the {@link TechDocsStorageApi}.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-techdocs-react` instead\n */\nexport const techdocsStorageApiRef = createApiRef<TechDocsStorageApi>({\n  id: 'plugin.techdocs.storageservice',\n});\n\n/**\n * Utility API reference for the {@link TechDocsApi}.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-techdocs-react` instead\n */\nexport const techdocsApiRef = createApiRef<TechDocsApi>({\n  id: 'plugin.techdocs.service',\n});\n\n/**\n * The outcome of a docs sync operation.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-techdocs-react` instead\n */\nexport type SyncResult = 'cached' | 'updated';\n\n/**\n * API which talks to TechDocs storage to fetch files to render.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-techdocs-react` instead\n */\nexport interface TechDocsStorageApi {\n  getApiOrigin(): Promise<string>;\n  getStorageUrl(): Promise<string>;\n  getBuilder(): Promise<string>;\n  getEntityDocs(entityId: CompoundEntityRef, path: string): Promise<string>;\n  syncEntityDocs(\n    entityId: CompoundEntityRef,\n    logHandler?: (line: string) => void,\n  ): Promise<SyncResult>;\n  getBaseUrl(\n    oldBaseUrl: string,\n    entityId: CompoundEntityRef,\n    path: string,\n  ): Promise<string>;\n}\n\n/**\n * API to talk to techdocs-backend.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-techdocs-react` instead\n */\nexport interface TechDocsApi {\n  getApiOrigin(): Promise<string>;\n  getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>;\n  getEntityMetadata(\n    entityId: CompoundEntityRef,\n  ): Promise<TechDocsEntityMetadata>;\n}\n","/*\n * Copyright 2021 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 { DocsCardGrid } from './DocsCardGrid';\nimport { Entity } from '@backstage/catalog-model';\nimport {\n  CodeSnippet,\n  Content,\n  ContentHeader,\n  Link,\n  Progress,\n  WarningPanel,\n} from '@backstage/core-components';\nimport {\n  useEntityList,\n  useEntityOwnership,\n} from '@backstage/plugin-catalog-react';\nimport { Typography } from '@material-ui/core';\nimport React from 'react';\n\n/**\n * Props for {@link EntityListDocsGrid}\n *\n * @public\n */\nexport type DocsGroupConfig = {\n  title: React.ReactNode;\n  filterPredicate: ((entity: Entity) => boolean) | string;\n};\n\n/**\n * Props for {@link EntityListDocsGrid}\n *\n * @public\n */\nexport type EntityListDocsGridPageProps = {\n  groups?: DocsGroupConfig[];\n};\n\nconst allEntitiesGroup: DocsGroupConfig = {\n  title: 'All Documentation',\n  filterPredicate: () => true,\n};\n\nconst EntityListDocsGridGroup = (props: {\n  group: DocsGroupConfig;\n  entities: Entity[];\n}) => {\n  const { entities, group } = props;\n  const { loading: loadingOwnership, isOwnedEntity } = useEntityOwnership();\n\n  const shownEntities = entities.filter(entity => {\n    if (group.filterPredicate === 'ownedByUser') {\n      if (loadingOwnership) {\n        return false;\n      }\n      return isOwnedEntity(entity);\n    }\n\n    return (\n      typeof group.filterPredicate === 'function' &&\n      group.filterPredicate(entity)\n    );\n  });\n\n  const titleComponent: React.ReactNode = (() => {\n    return typeof group.title === 'string' ? (\n      <ContentHeader title={group.title} />\n    ) : (\n      group.title\n    );\n  })();\n\n  if (shownEntities.length === 0) {\n    return null;\n  }\n\n  return (\n    <Content>\n      {titleComponent}\n      <DocsCardGrid entities={shownEntities} />\n    </Content>\n  );\n};\n\n/**\n * Component responsible to get entities from entity list context and pass down to DocsCardGrid\n *\n * @public\n */\nexport const EntityListDocsGrid = (props: EntityListDocsGridPageProps) => {\n  const { loading, error, entities } = useEntityList();\n\n  if (error) {\n    return (\n      <WarningPanel\n        severity=\"error\"\n        title=\"Could not load available documentation.\"\n      >\n        <CodeSnippet language=\"text\" text={error.toString()} />\n      </WarningPanel>\n    );\n  }\n\n  if (loading) {\n    return <Progress />;\n  }\n\n  if (entities.length === 0) {\n    return (\n      <div data-testid=\"doc-not-found\">\n        <Typography variant=\"body2\">\n          No documentation found that match your filter. Learn more about{' '}\n          <Link to=\"https://backstage.io/docs/features/techdocs/creating-and-publishing\">\n            publishing documentation\n          </Link>\n          .\n        </Typography>\n      </div>\n    );\n  }\n\n  entities.sort((a, b) =>\n    (a.metadata.title ?? a.metadata.name).localeCompare(\n      b.metadata.title ?? b.metadata.name,\n    ),\n  );\n\n  return (\n    <Content>\n      {(props.groups || [allEntitiesGroup]).map((group, index: number) => (\n        <EntityListDocsGridGroup\n          entities={entities}\n          group={group}\n          key={`${group.title}-${index}`}\n        />\n      ))}\n    </Content>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BO,MAAM,wBAAwB,YAAiC,CAAA;AAAA,EACpE,EAAI,EAAA,gCAAA;AACN,CAAC,EAAA;AAQM,MAAM,iBAAiB,YAA0B,CAAA;AAAA,EACtD,EAAI,EAAA,yBAAA;AACN,CAAC;;ACWD,MAAM,gBAAoC,GAAA;AAAA,EACxC,KAAO,EAAA,mBAAA;AAAA,EACP,iBAAiB,MAAM,IAAA;AACzB,CAAA,CAAA;AAEA,MAAM,uBAAA,GAA0B,CAAC,KAG3B,KAAA;AACJ,EAAM,MAAA,EAAE,QAAU,EAAA,KAAA,EAAU,GAAA,KAAA,CAAA;AAC5B,EAAA,MAAM,EAAE,OAAA,EAAS,gBAAkB,EAAA,aAAA,KAAkB,kBAAmB,EAAA,CAAA;AAExE,EAAM,MAAA,aAAA,GAAgB,QAAS,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA;AAC9C,IAAI,IAAA,KAAA,CAAM,oBAAoB,aAAe,EAAA;AAC3C,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AACA,MAAA,OAAO,cAAc,MAAM,CAAA,CAAA;AAAA,KAC7B;AAEA,IAAA,OACE,OAAO,KAAM,CAAA,eAAA,KAAoB,UACjC,IAAA,KAAA,CAAM,gBAAgB,MAAM,CAAA,CAAA;AAAA,GAE/B,CAAA,CAAA;AAED,EAAA,MAAM,kBAAmC,MAAM;AAC7C,IAAO,OAAA,OAAO,KAAM,CAAA,KAAA,KAAU,QAC5B,mBAAA,KAAA,CAAA,aAAA,CAAC,iBAAc,KAAO,EAAA,KAAA,CAAM,KAAO,EAAA,CAAA,GAEnC,KAAM,CAAA,KAAA,CAAA;AAAA,GAEP,GAAA,CAAA;AAEH,EAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAEA,EAAA,2CACG,OACE,EAAA,IAAA,EAAA,cAAA,sCACA,YAAa,EAAA,EAAA,QAAA,EAAU,eAAe,CACzC,CAAA,CAAA;AAEJ,CAAA,CAAA;AAOa,MAAA,kBAAA,GAAqB,CAAC,KAAuC,KAAA;AACxE,EAAA,MAAM,EAAE,OAAA,EAAS,KAAO,EAAA,QAAA,KAAa,aAAc,EAAA,CAAA;AAEnD,EAAA,IAAI,KAAO,EAAA;AACT,IACE,uBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,QAAS,EAAA,OAAA;AAAA,QACT,KAAM,EAAA,yCAAA;AAAA,OAAA;AAAA,0CAEL,WAAY,EAAA,EAAA,QAAA,EAAS,QAAO,IAAM,EAAA,KAAA,CAAM,UAAY,EAAA,CAAA;AAAA,KACvD,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,OAAS,EAAA;AACX,IAAA,2CAAQ,QAAS,EAAA,IAAA,CAAA,CAAA;AAAA,GACnB;AAEA,EAAI,IAAA,QAAA,CAAS,WAAW,CAAG,EAAA;AACzB,IAAA,2CACG,KAAI,EAAA,EAAA,aAAA,EAAY,eACf,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,cAAW,OAAQ,EAAA,OAAA,EAAA,EAAQ,iEACsC,EAAA,GAAA,sCAC/D,IAAK,EAAA,EAAA,EAAA,EAAG,yEAAsE,0BAE/E,CAAA,EAAO,GAET,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EAAS,QAAA,CAAA,IAAA;AAAA,IAAK,CAAC,GAAG,CAAG,KAAA;AAvIvB,MAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAwIK,MAAA,OAAA,CAAA,CAAA,EAAA,GAAA,CAAA,CAAE,QAAS,CAAA,KAAA,KAAX,IAAoB,GAAA,EAAA,GAAA,CAAA,CAAE,SAAS,IAAM,EAAA,aAAA;AAAA,QAAA,CACpC,EAAE,GAAA,CAAA,CAAA,QAAA,CAAS,KAAX,KAAA,IAAA,GAAA,EAAA,GAAoB,EAAE,QAAS,CAAA,IAAA;AAAA,OACjC,CAAA;AAAA,KAAA;AAAA,GACF,CAAA;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,OACG,EAAA,IAAA,EAAA,CAAA,KAAA,CAAM,MAAU,IAAA,CAAC,gBAAgB,CAAG,EAAA,GAAA,CAAI,CAAC,KAAA,EAAO,KAChD,qBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,uBAAA;AAAA,IAAA;AAAA,MACC,QAAA;AAAA,MACA,KAAA;AAAA,MACA,GAAK,EAAA,CAAA,EAAG,KAAM,CAAA,KAAK,IAAI,KAAK,CAAA,CAAA;AAAA,KAAA;AAAA,GAE/B,CACH,CAAA,CAAA;AAEJ;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-techdocs",
   "description": "The Backstage plugin that renders technical documentation for your components",
-  "version": "1.7.1-next.2",
+  "version": "1.8.1-next.0",
   "main": "./dist/index.esm.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -45,19 +45,19 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.4.3-next.0",
-    "@backstage/config": "^1.1.1-next.0",
-    "@backstage/core-components": "^0.13.6-next.2",
-    "@backstage/core-plugin-api": "^1.7.0-next.1",
-    "@backstage/errors": "^1.2.3-next.0",
-    "@backstage/frontend-plugin-api": "^0.2.0-next.2",
-    "@backstage/integration": "^1.7.1-next.1",
-    "@backstage/integration-react": "^1.1.20-next.2",
-    "@backstage/plugin-catalog-react": "^1.8.5-next.2",
-    "@backstage/plugin-search-common": "^1.2.7-next.0",
-    "@backstage/plugin-search-react": "^1.7.1-next.2",
-    "@backstage/plugin-techdocs-react": "^1.1.12-next.2",
-    "@backstage/theme": "^0.4.3-next.0",
+    "@backstage/catalog-model": "^1.4.3",
+    "@backstage/config": "^1.1.1",
+    "@backstage/core-components": "^0.13.7-next.0",
+    "@backstage/core-plugin-api": "^1.8.0-next.0",
+    "@backstage/errors": "^1.2.3",
+    "@backstage/frontend-plugin-api": "^0.3.0-next.0",
+    "@backstage/integration": "^1.7.1",
+    "@backstage/integration-react": "^1.1.21-next.0",
+    "@backstage/plugin-catalog-react": "^1.9.0-next.0",
+    "@backstage/plugin-search-common": "^1.2.7",
+    "@backstage/plugin-search-react": "^1.7.2-next.0",
+    "@backstage/plugin-techdocs-react": "^1.1.13-next.0",
+    "@backstage/theme": "^0.4.4-next.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -72,20 +72,19 @@
     "react-use": "^17.2.4"
   },
   "peerDependencies": {
-    "react": "^16.13.1 || ^17.0.0",
-    "react-dom": "^16.13.1 || ^17.0.0",
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.23.0-next.2",
-    "@backstage/core-app-api": "^1.11.0-next.2",
-    "@backstage/dev-utils": "^1.0.22-next.2",
-    "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.1-next.2",
-    "@backstage/test-utils": "^1.4.4-next.2",
-    "@testing-library/dom": "^8.0.0",
-    "@testing-library/jest-dom": "^5.10.1",
-    "@testing-library/react": "^12.1.3",
-    "@testing-library/react-hooks": "^8.0.0",
+    "@backstage/cli": "^0.24.0-next.0",
+    "@backstage/core-app-api": "^1.11.1-next.0",
+    "@backstage/dev-utils": "^1.0.23-next.0",
+    "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.2-next.0",
+    "@backstage/test-utils": "^1.4.5-next.0",
+    "@testing-library/dom": "^9.0.0",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.0.0",
     "@types/dompurify": "^2.2.2",
     "@types/event-source-polyfill": "^1.0.0",