@backstage/plugin-techdocs 1.17.7 → 1.17.8

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/plugin-techdocs
 
+## 1.17.8
+
+### Patch Changes
+
+- 34bda9e: chore(deps): bump `dompurify` from 3.4.5 to 3.4.9
+- f2aa036: chore(deps): bump `dompurify` from 3.4.9 to 3.4.11
+- b8db4fe: The TechDocs plugin now adds the Documentation result type to the Search page when it is installed.
+- 65c7f98: Fixed duplicate React key warnings when documentation entities share a name across different namespaces or kinds.
+- 9459c14: Fixed TechDocs pages sometimes rendering blank due to sanitizer hooks registered by other plugins.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.17.3
+  - @backstage/ui@0.17.0
+  - @backstage/plugin-catalog-react@3.2.0
+  - @backstage/core-components@0.18.12
+  - @backstage/plugin-techdocs-react@1.3.13
+  - @backstage/catalog-client@1.16.1
+  - @backstage/core-plugin-api@1.12.8
+  - @backstage/integration-react@1.2.20
+  - @backstage/plugin-auth-react@0.1.29
+  - @backstage/plugin-search-react@1.11.6
+
+## 1.17.8-next.0
+
+### Patch Changes
+
+- 65c7f98: Fixed duplicate React key warnings when documentation entities share a name across different namespaces or kinds.
+- Updated dependencies
+  - @backstage/plugin-catalog-react@3.2.0-next.0
+  - @backstage/ui@0.17.0-next.0
+  - @backstage/frontend-plugin-api@0.17.3-next.0
+  - @backstage/plugin-search-react@1.11.6-next.0
+  - @backstage/catalog-client@1.16.1-next.0
+  - @backstage/core-components@0.18.12-next.0
+  - @backstage/core-plugin-api@1.12.8-next.0
+  - @backstage/integration-react@1.2.20-next.0
+  - @backstage/plugin-auth-react@0.1.29-next.0
+  - @backstage/plugin-techdocs-react@1.3.13-next.0
+
 ## 1.17.7
 
 ### Patch Changes

package/config.schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "techdocs": {
+      "type": "object",
+      "properties": {
+        "builder": {
+          "type": "string",
+          "enum": [
+            "local",
+            "external"
+          ],
+          "description": "Documentation building process depends on the builder attr",
+          "visibility": "frontend"
+        },
+        "legacyUseCaseSensitiveTripletPaths": {
+          "type": "boolean",
+          "description": "Allows fallback to case-sensitive triplets in case of migration issues.",
+          "visibility": "frontend"
+        },
+        "sanitizer": {
+          "type": "object",
+          "properties": {
+            "allowedIframeHosts": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Allows iframe tag only for listed hosts Example:  allowedIframeHosts: [\"example.com\"]  this will allow all iframes with the host `example.com` in the src attribute",
+              "visibility": "frontend"
+            },
+            "allowedCustomElementTagNameRegExp": {
+              "type": "string",
+              "description": "Allows listed custom element tag name regex Example:  allowedCustomElementTagNameRegExp: '^backstage-'  this will allow all custom elements with tag name matching `^backstage-` like <backstage-custom-element /> etc.",
+              "visibility": "frontend"
+            },
+            "allowedCustomElementAttributeNameRegExp": {
+              "type": "string",
+              "description": "Allows listed custom element attribute name regex Example:  allowedCustomElementAttributeNameRegExp: 'attribute1|attribute2'  this will allow all custom element attributes matching `attribute1` or `attribute2` like <backstage-custom-element attribute1=\"yes\" attribute2/>",
+              "visibility": "frontend"
+            },
+            "additionalAllowedURIProtocols": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Allows listed protocols in attributes with URI values Example:  additionalAllowedURIProtocols: ['vscode']  this will allow all attributes with URI values to have `vscode` protocol like `vscode://some/path` in addition to the default protocols  matched by DOMPurify's IS_ALLOWED_URI RegExp:",
+              "visibility": "frontend"
+            }
+          }
+        }
+      },
+      "description": "Configuration options for the techdocs plugin"
+    }
+  }
+}

package/dist/alpha.d.ts

@@ -317,6 +317,19 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
             loader: () => Promise<JSX.Element>;
         };
     }>;
+    "search-filter-result-type:techdocs": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "search-filter-result-type";
+        name: undefined;
+        config: {};
+        configInput: {};
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<{
+            value: string;
+            name: string;
+            icon: react.JSX.Element;
+        }, "search.filters.result-types.type", {}>;
+        inputs: {};
+        params: _backstage_plugin_search_react_alpha.SearchFilterResultTypeBlueprintParams;
+    }>;
     "search-result-list-item:techdocs": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
         config: {
             title: string | undefined;

package/dist/alpha.esm.js

@@ -5,7 +5,7 @@ import { RiArticleLine } from '@remixicon/react';
 import { ApiBlueprint, PageBlueprint, createExtensionInput, coreExtensionData, createExtension, PluginHeaderActionBlueprint, createFrontendPlugin } from '@backstage/frontend-plugin-api';
 import { fetchApiRef, discoveryApiRef, configApiRef } from '@backstage/core-plugin-api';
 import { EntityIconLinkBlueprint, EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';
-import { SearchResultListItemBlueprint } from '@backstage/plugin-search-react/alpha';
+import { SearchResultListItemBlueprint, SearchFilterResultTypeBlueprint } from '@backstage/plugin-search-react/alpha';
 import { AddonBlueprint, attachTechDocsAddonComponentData } from '@backstage/plugin-techdocs-react/alpha';
 import { techdocsAddonsApiRef, TechDocsAddonsApiExtension } from './alpha/addonsApi.esm.js';
 import { TechDocsStorageClient, TechDocsClient } from './client.esm.js';
@@ -71,6 +71,13 @@ const techDocsSearchResultListItemExtension = SearchResultListItemBlueprint.make
     });
   }
 });
+const techDocsSearchFilterResultTypeExtension = SearchFilterResultTypeBlueprint.make({
+  params: {
+    value: "techdocs",
+    name: "Documentation",
+    icon: /* @__PURE__ */ jsx(DocsIcon, {})
+  }
+});
 const techDocsPage = PageBlueprint.make({
   params: {
     path: "/docs",
@@ -191,6 +198,7 @@ var index = createFrontendPlugin({
     techdocsEntityIconLink,
     techDocsEntityContent,
     techDocsEntityContentEmptyState,
+    techDocsSearchFilterResultTypeExtension,
     techDocsSearchResultListItemExtension
   ],
   routes: {

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":["../src/alpha/index.tsx"],"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 { Suspense } from 'react';\nimport { z } from 'zod/v4';\nimport { RiArticleLine } from '@remixicon/react';\nimport {\n  createFrontendPlugin,\n  ApiBlueprint,\n  PageBlueprint,\n  PluginHeaderActionBlueprint,\n  createExtensionInput,\n  coreExtensionData,\n  createExtension,\n} from '@backstage/frontend-plugin-api';\nimport {\n  configApiRef,\n  discoveryApiRef,\n  fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n  EntityContentBlueprint,\n  EntityIconLinkBlueprint,\n} from '@backstage/plugin-catalog-react/alpha';\nimport { SearchResultListItemBlueprint } from '@backstage/plugin-search-react/alpha';\nimport {\n  AddonBlueprint,\n  attachTechDocsAddonComponentData,\n} from '@backstage/plugin-techdocs-react/alpha';\nimport { TechDocsAddonsApiExtension, techdocsAddonsApiRef } from './addonsApi';\nimport { TechDocsClient, TechDocsStorageClient } from '../client';\nimport {\n  rootCatalogDocsRouteRef,\n  rootDocsRouteRef,\n  rootRouteRef,\n} from '../routes';\nimport { TechDocsReaderLayout } from './components/TechDocsReaderLayout';\nimport {\n  TechDocsAddons,\n  techdocsApiRef,\n  techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\n\nimport { useTechdocsReaderIconLinkProps } from './hooks/useTechdocsReaderIconLinkProps';\nimport { DocsIcon, SupportButton } from '@backstage/core-components';\n\n/** @alpha */\nconst techdocsEntityIconLink = EntityIconLinkBlueprint.make({\n  name: 'read-docs',\n  params: {\n    useProps: useTechdocsReaderIconLinkProps,\n  },\n});\n\n/** @alpha */\nconst techDocsStorageApi = ApiBlueprint.make({\n  name: 'storage',\n  params: defineParams =>\n    defineParams({\n      api: techdocsStorageApiRef,\n      deps: {\n        configApi: configApiRef,\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ configApi, discoveryApi, fetchApi }) =>\n        new TechDocsStorageClient({\n          configApi,\n          discoveryApi,\n          fetchApi,\n        }),\n    }),\n});\n\n/** @alpha */\nconst techDocsClientApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      api: techdocsApiRef,\n      deps: {\n        configApi: configApiRef,\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ configApi, discoveryApi, fetchApi }) =>\n        new TechDocsClient({\n          configApi,\n          discoveryApi,\n          fetchApi,\n        }),\n    }),\n});\n\n/** @alpha */\nexport const techDocsSearchResultListItemExtension =\n  SearchResultListItemBlueprint.makeWithOverrides({\n    configSchema: {\n      title: z.string().optional(),\n      lineClamp: z.number().default(5),\n      asLink: z.boolean().default(true),\n      asListItem: z.boolean().default(true),\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        icon: <DocsIcon />,\n        predicate: result => result.type === 'techdocs',\n        component: async () => {\n          const { TechDocsSearchResultListItem } = await import(\n            '../search/components/TechDocsSearchResultListItem'\n          );\n          return props => (\n            <TechDocsSearchResultListItem {...props} {...config} />\n          );\n        },\n      });\n    },\n  });\n\n/**\n * Responsible for rendering the provided router element\n *\n * @alpha\n */\nconst techDocsPage = PageBlueprint.make({\n  params: {\n    path: '/docs',\n    routeRef: rootRouteRef,\n    title: 'Docs',\n    icon: <RiArticleLine />,\n    loader: () =>\n      import('./components/TechDocsIndexPageContent').then(m => (\n        <m.TechDocsIndexPageContent />\n      )),\n  },\n});\n\n/**\n * Component responsible for composing a TechDocs reader page experience\n *\n * @alpha\n */\nconst techDocsReaderPage = PageBlueprint.makeWithOverrides({\n  name: 'reader',\n  inputs: {\n    addons: createExtensionInput([AddonBlueprint.dataRefs.addon]),\n  },\n  configSchema: {\n    withoutSearch: z.boolean().default(false),\n    withoutHeader: z.boolean().default(false),\n  },\n  factory(originalFactory, { apis, inputs, config }) {\n    const addonsApi = apis.get(techdocsAddonsApiRef);\n\n    return originalFactory({\n      path: '/docs/:namespace/:kind/:name',\n      routeRef: rootDocsRouteRef,\n      loader: async () => {\n        // Merge addons from the API with old-style direct attachments\n        const apiAddons = addonsApi?.getAddons() ?? [];\n        const directAddons = inputs.addons.map(output =>\n          output.get(AddonBlueprint.dataRefs.addon),\n        );\n        const addonOptions = [...apiAddons, ...directAddons];\n\n        const addons = addonOptions.map(options => {\n          const Addon = options.component;\n          attachTechDocsAddonComponentData(Addon, options);\n          return (\n            <Suspense key={options.name} fallback={null}>\n              <Addon />\n            </Suspense>\n          );\n        });\n\n        return import('../Router').then(({ TechDocsReaderRouter }) => (\n          <TechDocsReaderRouter>\n            <TechDocsReaderLayout\n              withSearch={!config.withoutSearch}\n              withHeader={!config.withoutHeader}\n            />\n            <TechDocsAddons>{addons}</TechDocsAddons>\n          </TechDocsReaderRouter>\n        ));\n      },\n    });\n  },\n});\n\n/**\n * Component responsible for rendering techdocs on entity pages\n *\n * @alpha\n */\nconst techDocsEntityContent = EntityContentBlueprint.makeWithOverrides({\n  inputs: {\n    addons: createExtensionInput([AddonBlueprint.dataRefs.addon]),\n    emptyState: createExtensionInput(\n      [coreExtensionData.reactElement.optional()],\n      {\n        singleton: true,\n        optional: true,\n      },\n    ),\n  },\n  factory(originalFactory, context) {\n    const addonsApi = context.apis.get(techdocsAddonsApiRef);\n\n    return originalFactory(\n      {\n        path: 'docs',\n        title: 'TechDocs',\n        group: 'documentation',\n        routeRef: rootCatalogDocsRouteRef,\n        loader: () => {\n          // Merge addons from the API with old-style direct attachments\n          const apiAddons = addonsApi?.getAddons() ?? [];\n          const directAddons = context.inputs.addons.map(output =>\n            output.get(AddonBlueprint.dataRefs.addon),\n          );\n          const addonOptions = [...apiAddons, ...directAddons];\n\n          const addons = addonOptions.map(options => {\n            const Addon = options.component;\n            attachTechDocsAddonComponentData(Addon, options);\n            return (\n              <Suspense key={options.name} fallback={null}>\n                <Addon />\n              </Suspense>\n            );\n          });\n\n          return import('../Router').then(({ EmbeddedDocsRouter }) => (\n            <EmbeddedDocsRouter\n              emptyState={context.inputs.emptyState?.get(\n                coreExtensionData.reactElement,\n              )}\n            >\n              <TechDocsAddons>{addons}</TechDocsAddons>\n            </EmbeddedDocsRouter>\n          ));\n        },\n      },\n      context,\n    );\n  },\n});\n\nconst techDocsEntityContentEmptyState = createExtension({\n  kind: 'empty-state',\n  name: 'entity-content',\n  attachTo: { id: 'entity-content:techdocs', input: 'emptyState' },\n  output: [coreExtensionData.reactElement.optional()],\n  factory: () => [],\n});\n\nconst techDocsSupportAction = PluginHeaderActionBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      loader: async () => (\n        <SupportButton>Discover documentation in your ecosystem.</SupportButton>\n      ),\n    }),\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n  pluginId: 'techdocs',\n  title: 'Documentation',\n  icon: <RiArticleLine />,\n  info: { packageJson: () => import('../../package.json') },\n  extensions: [\n    techDocsClientApi,\n    techDocsStorageApi,\n    TechDocsAddonsApiExtension,\n    techDocsSupportAction,\n    techDocsPage,\n    techDocsReaderPage,\n    techdocsEntityIconLink,\n    techDocsEntityContent,\n    techDocsEntityContentEmptyState,\n    techDocsSearchResultListItemExtension,\n  ],\n  routes: {\n    root: rootRouteRef,\n    docRoot: rootDocsRouteRef,\n    entityContent: rootCatalogDocsRouteRef,\n  },\n});\n\n/** @alpha */\nexport { techdocsTranslationRef } from '../translation';\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AA4DA,MAAM,sBAAA,GAAyB,wBAAwB,IAAA,CAAK;AAAA,EAC1D,IAAA,EAAM,WAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,QAAA,EAAU;AAAA;AAEd,CAAC,CAAA;AAGD,MAAM,kBAAA,GAAqB,aAAa,IAAA,CAAK;AAAA,EAC3C,IAAA,EAAM,SAAA;AAAA,EACN,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,qBAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,SAAA,EAAW,YAAA;AAAA,MACX,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAA,EAAS,KAC5C,IAAI,qBAAA,CAAsB;AAAA,MACxB,SAAA;AAAA,MACA,YAAA;AAAA,MACA;AAAA,KACD;AAAA,GACJ;AACL,CAAC,CAAA;AAGD,MAAM,iBAAA,GAAoB,aAAa,IAAA,CAAK;AAAA,EAC1C,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,cAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,SAAA,EAAW,YAAA;AAAA,MACX,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAA,EAAS,KAC5C,IAAI,cAAA,CAAe;AAAA,MACjB,SAAA;AAAA,MACA,YAAA;AAAA,MACA;AAAA,KACD;AAAA,GACJ;AACL,CAAC,CAAA;AAGM,MAAM,qCAAA,GACX,8BAA8B,iBAAA,CAAkB;AAAA,EAC9C,YAAA,EAAc;AAAA,IACZ,KAAA,EAAO,CAAA,CAAE,MAAA,EAAO,CAAE,QAAA,EAAS;AAAA,IAC3B,SAAA,EAAW,CAAA,CAAE,MAAA,EAAO,CAAE,QAAQ,CAAC,CAAA;AAAA,IAC/B,MAAA,EAAQ,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,IAAI,CAAA;AAAA,IAChC,UAAA,EAAY,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,IAAI;AAAA,GACtC;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAO,EAAG;AACnC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,sBAAO,QAAA,EAAA,EAAS,CAAA;AAAA,MAChB,SAAA,EAAW,CAAA,MAAA,KAAU,MAAA,CAAO,IAAA,KAAS,UAAA;AAAA,MACrC,WAAW,YAAY;AACrB,QAAA,MAAM,EAAE,4BAAA,EAA6B,GAAI,MAAM,OAC7C,yDACF,CAAA;AACA,QAAA,OAAO,2BACL,GAAA,CAAC,4BAAA,EAAA,EAA8B,GAAG,KAAA,EAAQ,GAAG,MAAA,EAAQ,CAAA;AAAA,MAEzD;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;AAOH,MAAM,YAAA,GAAe,cAAc,IAAA,CAAK;AAAA,EACtC,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,OAAA;AAAA,IACN,QAAA,EAAU,YAAA;AAAA,IACV,KAAA,EAAO,MAAA;AAAA,IACP,IAAA,sBAAO,aAAA,EAAA,EAAc,CAAA;AAAA,IACrB,MAAA,EAAQ,MACN,OAAO,oDAAuC,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBACnD,GAAA,CAAC,CAAA,CAAE,wBAAA,EAAF,EAA2B,CAC7B;AAAA;AAEP,CAAC,CAAA;AAOD,MAAM,kBAAA,GAAqB,cAAc,iBAAA,CAAkB;AAAA,EACzD,IAAA,EAAM,QAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,QAAQ,oBAAA,CAAqB,CAAC,cAAA,CAAe,QAAA,CAAS,KAAK,CAAC;AAAA,GAC9D;AAAA,EACA,YAAA,EAAc;AAAA,IACZ,aAAA,EAAe,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,KAAK,CAAA;AAAA,IACxC,aAAA,EAAe,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,KAAK;AAAA,GAC1C;AAAA,EACA,QAAQ,eAAA,EAAiB,EAAE,IAAA,EAAM,MAAA,EAAQ,QAAO,EAAG;AACjD,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,GAAA,CAAI,oBAAoB,CAAA;AAE/C,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,8BAAA;AAAA,MACN,QAAA,EAAU,gBAAA;AAAA,MACV,QAAQ,YAAY;AAElB,QAAA,MAAM,SAAA,GAAY,SAAA,EAAW,SAAA,EAAU,IAAK,EAAC;AAC7C,QAAA,MAAM,YAAA,GAAe,OAAO,MAAA,CAAO,GAAA;AAAA,UAAI,CAAA,MAAA,KACrC,MAAA,CAAO,GAAA,CAAI,cAAA,CAAe,SAAS,KAAK;AAAA,SAC1C;AACA,QAAA,MAAM,YAAA,GAAe,CAAC,GAAG,SAAA,EAAW,GAAG,YAAY,CAAA;AAEnD,QAAA,MAAM,MAAA,GAAS,YAAA,CAAa,GAAA,CAAI,CAAA,OAAA,KAAW;AACzC,UAAA,MAAM,QAAQ,OAAA,CAAQ,SAAA;AACtB,UAAA,gCAAA,CAAiC,OAAO,OAAO,CAAA;AAC/C,UAAA,uBACE,GAAA,CAAC,YAA4B,QAAA,EAAU,IAAA,EACrC,8BAAC,KAAA,EAAA,EAAM,CAAA,EAAA,EADM,QAAQ,IAEvB,CAAA;AAAA,QAEJ,CAAC,CAAA;AAED,QAAA,OAAO,OAAO,iBAAW,CAAA,CAAE,IAAA,CAAK,CAAC,EAAE,oBAAA,EAAqB,qBACtD,IAAA,CAAC,oBAAA,EAAA,EACC,QAAA,EAAA;AAAA,0BAAA,GAAA;AAAA,YAAC,oBAAA;AAAA,YAAA;AAAA,cACC,UAAA,EAAY,CAAC,MAAA,CAAO,aAAA;AAAA,cACpB,UAAA,EAAY,CAAC,MAAA,CAAO;AAAA;AAAA,WACtB;AAAA,0BACA,GAAA,CAAC,kBAAgB,QAAA,EAAA,MAAA,EAAO;AAAA,SAAA,EAC1B,CACD,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC,CAAA;AAOD,MAAM,qBAAA,GAAwB,uBAAuB,iBAAA,CAAkB;AAAA,EACrE,MAAA,EAAQ;AAAA,IACN,QAAQ,oBAAA,CAAqB,CAAC,cAAA,CAAe,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,IAC5D,UAAA,EAAY,oBAAA;AAAA,MACV,CAAC,iBAAA,CAAkB,YAAA,CAAa,QAAA,EAAU,CAAA;AAAA,MAC1C;AAAA,QACE,SAAA,EAAW,IAAA;AAAA,QACX,QAAA,EAAU;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAA,CAAQ,iBAAiB,OAAA,EAAS;AAChC,IAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,IAAA,CAAK,GAAA,CAAI,oBAAoB,CAAA;AAEvD,IAAA,OAAO,eAAA;AAAA,MACL;AAAA,QACE,IAAA,EAAM,MAAA;AAAA,QACN,KAAA,EAAO,UAAA;AAAA,QACP,KAAA,EAAO,eAAA;AAAA,QACP,QAAA,EAAU,uBAAA;AAAA,QACV,QAAQ,MAAM;AAEZ,UAAA,MAAM,SAAA,GAAY,SAAA,EAAW,SAAA,EAAU,IAAK,EAAC;AAC7C,UAAA,MAAM,YAAA,GAAe,OAAA,CAAQ,MAAA,CAAO,MAAA,CAAO,GAAA;AAAA,YAAI,CAAA,MAAA,KAC7C,MAAA,CAAO,GAAA,CAAI,cAAA,CAAe,SAAS,KAAK;AAAA,WAC1C;AACA,UAAA,MAAM,YAAA,GAAe,CAAC,GAAG,SAAA,EAAW,GAAG,YAAY,CAAA;AAEnD,UAAA,MAAM,MAAA,GAAS,YAAA,CAAa,GAAA,CAAI,CAAA,OAAA,KAAW;AACzC,YAAA,MAAM,QAAQ,OAAA,CAAQ,SAAA;AACtB,YAAA,gCAAA,CAAiC,OAAO,OAAO,CAAA;AAC/C,YAAA,uBACE,GAAA,CAAC,YAA4B,QAAA,EAAU,IAAA,EACrC,8BAAC,KAAA,EAAA,EAAM,CAAA,EAAA,EADM,QAAQ,IAEvB,CAAA;AAAA,UAEJ,CAAC,CAAA;AAED,UAAA,OAAO,OAAO,iBAAW,CAAA,CAAE,KAAK,CAAC,EAAE,oBAAmB,qBACpD,GAAA;AAAA,YAAC,kBAAA;AAAA,YAAA;AAAA,cACC,UAAA,EAAY,OAAA,CAAQ,MAAA,CAAO,UAAA,EAAY,GAAA;AAAA,gBACrC,iBAAA,CAAkB;AAAA,eACpB;AAAA,cAEA,QAAA,kBAAA,GAAA,CAAC,kBAAgB,QAAA,EAAA,MAAA,EAAO;AAAA;AAAA,WAE3B,CAAA;AAAA,QACH;AAAA,OACF;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;AAED,MAAM,kCAAkC,eAAA,CAAgB;AAAA,EACtD,IAAA,EAAM,aAAA;AAAA,EACN,IAAA,EAAM,gBAAA;AAAA,EACN,QAAA,EAAU,EAAE,EAAA,EAAI,yBAAA,EAA2B,OAAO,YAAA,EAAa;AAAA,EAC/D,MAAA,EAAQ,CAAC,iBAAA,CAAkB,YAAA,CAAa,UAAU,CAAA;AAAA,EAClD,OAAA,EAAS,MAAM;AACjB,CAAC,CAAA;AAED,MAAM,qBAAA,GAAwB,4BAA4B,IAAA,CAAK;AAAA,EAC7D,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,MAAA,EAAQ,4BACN,GAAA,CAAC,aAAA,EAAA,EAAc,QAAA,EAAA,2CAAA,EAAyC;AAAA,GAE3D;AACL,CAAC,CAAA;AAGD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,UAAA;AAAA,EACV,KAAA,EAAO,eAAA;AAAA,EACP,IAAA,sBAAO,aAAA,EAAA,EAAc,CAAA;AAAA,EACrB,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,wCAAoB,CAAA,EAAE;AAAA,EACxD,UAAA,EAAY;AAAA,IACV,iBAAA;AAAA,IACA,kBAAA;AAAA,IACA,0BAAA;AAAA,IACA,qBAAA;AAAA,IACA,YAAA;AAAA,IACA,kBAAA;AAAA,IACA,sBAAA;AAAA,IACA,qBAAA;AAAA,IACA,+BAAA;AAAA,IACA;AAAA,GACF;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,YAAA;AAAA,IACN,OAAA,EAAS,gBAAA;AAAA,IACT,aAAA,EAAe;AAAA;AAEnB,CAAC,CAAA;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":["../src/alpha/index.tsx"],"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 { Suspense } from 'react';\nimport { z } from 'zod/v4';\nimport { RiArticleLine } from '@remixicon/react';\nimport {\n  createFrontendPlugin,\n  ApiBlueprint,\n  PageBlueprint,\n  PluginHeaderActionBlueprint,\n  createExtensionInput,\n  coreExtensionData,\n  createExtension,\n} from '@backstage/frontend-plugin-api';\nimport {\n  configApiRef,\n  discoveryApiRef,\n  fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n  EntityContentBlueprint,\n  EntityIconLinkBlueprint,\n} from '@backstage/plugin-catalog-react/alpha';\nimport {\n  SearchFilterResultTypeBlueprint,\n  SearchResultListItemBlueprint,\n} from '@backstage/plugin-search-react/alpha';\nimport {\n  AddonBlueprint,\n  attachTechDocsAddonComponentData,\n} from '@backstage/plugin-techdocs-react/alpha';\nimport { TechDocsAddonsApiExtension, techdocsAddonsApiRef } from './addonsApi';\nimport { TechDocsClient, TechDocsStorageClient } from '../client';\nimport {\n  rootCatalogDocsRouteRef,\n  rootDocsRouteRef,\n  rootRouteRef,\n} from '../routes';\nimport { TechDocsReaderLayout } from './components/TechDocsReaderLayout';\nimport {\n  TechDocsAddons,\n  techdocsApiRef,\n  techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\n\nimport { useTechdocsReaderIconLinkProps } from './hooks/useTechdocsReaderIconLinkProps';\nimport { DocsIcon, SupportButton } from '@backstage/core-components';\n\n/** @alpha */\nconst techdocsEntityIconLink = EntityIconLinkBlueprint.make({\n  name: 'read-docs',\n  params: {\n    useProps: useTechdocsReaderIconLinkProps,\n  },\n});\n\n/** @alpha */\nconst techDocsStorageApi = ApiBlueprint.make({\n  name: 'storage',\n  params: defineParams =>\n    defineParams({\n      api: techdocsStorageApiRef,\n      deps: {\n        configApi: configApiRef,\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ configApi, discoveryApi, fetchApi }) =>\n        new TechDocsStorageClient({\n          configApi,\n          discoveryApi,\n          fetchApi,\n        }),\n    }),\n});\n\n/** @alpha */\nconst techDocsClientApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      api: techdocsApiRef,\n      deps: {\n        configApi: configApiRef,\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ configApi, discoveryApi, fetchApi }) =>\n        new TechDocsClient({\n          configApi,\n          discoveryApi,\n          fetchApi,\n        }),\n    }),\n});\n\n/** @alpha */\nexport const techDocsSearchResultListItemExtension =\n  SearchResultListItemBlueprint.makeWithOverrides({\n    configSchema: {\n      title: z.string().optional(),\n      lineClamp: z.number().default(5),\n      asLink: z.boolean().default(true),\n      asListItem: z.boolean().default(true),\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        icon: <DocsIcon />,\n        predicate: result => result.type === 'techdocs',\n        component: async () => {\n          const { TechDocsSearchResultListItem } = await import(\n            '../search/components/TechDocsSearchResultListItem'\n          );\n          return props => (\n            <TechDocsSearchResultListItem {...props} {...config} />\n          );\n        },\n      });\n    },\n  });\n\nconst techDocsSearchFilterResultTypeExtension =\n  SearchFilterResultTypeBlueprint.make({\n    params: {\n      value: 'techdocs',\n      name: 'Documentation',\n      icon: <DocsIcon />,\n    },\n  });\n\n/**\n * Responsible for rendering the provided router element\n *\n * @alpha\n */\nconst techDocsPage = PageBlueprint.make({\n  params: {\n    path: '/docs',\n    routeRef: rootRouteRef,\n    title: 'Docs',\n    icon: <RiArticleLine />,\n    loader: () =>\n      import('./components/TechDocsIndexPageContent').then(m => (\n        <m.TechDocsIndexPageContent />\n      )),\n  },\n});\n\n/**\n * Component responsible for composing a TechDocs reader page experience\n *\n * @alpha\n */\nconst techDocsReaderPage = PageBlueprint.makeWithOverrides({\n  name: 'reader',\n  inputs: {\n    addons: createExtensionInput([AddonBlueprint.dataRefs.addon]),\n  },\n  configSchema: {\n    withoutSearch: z.boolean().default(false),\n    withoutHeader: z.boolean().default(false),\n  },\n  factory(originalFactory, { apis, inputs, config }) {\n    const addonsApi = apis.get(techdocsAddonsApiRef);\n\n    return originalFactory({\n      path: '/docs/:namespace/:kind/:name',\n      routeRef: rootDocsRouteRef,\n      loader: async () => {\n        // Merge addons from the API with old-style direct attachments\n        const apiAddons = addonsApi?.getAddons() ?? [];\n        const directAddons = inputs.addons.map(output =>\n          output.get(AddonBlueprint.dataRefs.addon),\n        );\n        const addonOptions = [...apiAddons, ...directAddons];\n\n        const addons = addonOptions.map(options => {\n          const Addon = options.component;\n          attachTechDocsAddonComponentData(Addon, options);\n          return (\n            <Suspense key={options.name} fallback={null}>\n              <Addon />\n            </Suspense>\n          );\n        });\n\n        return import('../Router').then(({ TechDocsReaderRouter }) => (\n          <TechDocsReaderRouter>\n            <TechDocsReaderLayout\n              withSearch={!config.withoutSearch}\n              withHeader={!config.withoutHeader}\n            />\n            <TechDocsAddons>{addons}</TechDocsAddons>\n          </TechDocsReaderRouter>\n        ));\n      },\n    });\n  },\n});\n\n/**\n * Component responsible for rendering techdocs on entity pages\n *\n * @alpha\n */\nconst techDocsEntityContent = EntityContentBlueprint.makeWithOverrides({\n  inputs: {\n    addons: createExtensionInput([AddonBlueprint.dataRefs.addon]),\n    emptyState: createExtensionInput(\n      [coreExtensionData.reactElement.optional()],\n      {\n        singleton: true,\n        optional: true,\n      },\n    ),\n  },\n  factory(originalFactory, context) {\n    const addonsApi = context.apis.get(techdocsAddonsApiRef);\n\n    return originalFactory(\n      {\n        path: 'docs',\n        title: 'TechDocs',\n        group: 'documentation',\n        routeRef: rootCatalogDocsRouteRef,\n        loader: () => {\n          // Merge addons from the API with old-style direct attachments\n          const apiAddons = addonsApi?.getAddons() ?? [];\n          const directAddons = context.inputs.addons.map(output =>\n            output.get(AddonBlueprint.dataRefs.addon),\n          );\n          const addonOptions = [...apiAddons, ...directAddons];\n\n          const addons = addonOptions.map(options => {\n            const Addon = options.component;\n            attachTechDocsAddonComponentData(Addon, options);\n            return (\n              <Suspense key={options.name} fallback={null}>\n                <Addon />\n              </Suspense>\n            );\n          });\n\n          return import('../Router').then(({ EmbeddedDocsRouter }) => (\n            <EmbeddedDocsRouter\n              emptyState={context.inputs.emptyState?.get(\n                coreExtensionData.reactElement,\n              )}\n            >\n              <TechDocsAddons>{addons}</TechDocsAddons>\n            </EmbeddedDocsRouter>\n          ));\n        },\n      },\n      context,\n    );\n  },\n});\n\nconst techDocsEntityContentEmptyState = createExtension({\n  kind: 'empty-state',\n  name: 'entity-content',\n  attachTo: { id: 'entity-content:techdocs', input: 'emptyState' },\n  output: [coreExtensionData.reactElement.optional()],\n  factory: () => [],\n});\n\nconst techDocsSupportAction = PluginHeaderActionBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      loader: async () => (\n        <SupportButton>Discover documentation in your ecosystem.</SupportButton>\n      ),\n    }),\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n  pluginId: 'techdocs',\n  title: 'Documentation',\n  icon: <RiArticleLine />,\n  info: { packageJson: () => import('../../package.json') },\n  extensions: [\n    techDocsClientApi,\n    techDocsStorageApi,\n    TechDocsAddonsApiExtension,\n    techDocsSupportAction,\n    techDocsPage,\n    techDocsReaderPage,\n    techdocsEntityIconLink,\n    techDocsEntityContent,\n    techDocsEntityContentEmptyState,\n    techDocsSearchFilterResultTypeExtension,\n    techDocsSearchResultListItemExtension,\n  ],\n  routes: {\n    root: rootRouteRef,\n    docRoot: rootDocsRouteRef,\n    entityContent: rootCatalogDocsRouteRef,\n  },\n});\n\n/** @alpha */\nexport { techdocsTranslationRef } from '../translation';\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AA+DA,MAAM,sBAAA,GAAyB,wBAAwB,IAAA,CAAK;AAAA,EAC1D,IAAA,EAAM,WAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,QAAA,EAAU;AAAA;AAEd,CAAC,CAAA;AAGD,MAAM,kBAAA,GAAqB,aAAa,IAAA,CAAK;AAAA,EAC3C,IAAA,EAAM,SAAA;AAAA,EACN,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,qBAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,SAAA,EAAW,YAAA;AAAA,MACX,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAA,EAAS,KAC5C,IAAI,qBAAA,CAAsB;AAAA,MACxB,SAAA;AAAA,MACA,YAAA;AAAA,MACA;AAAA,KACD;AAAA,GACJ;AACL,CAAC,CAAA;AAGD,MAAM,iBAAA,GAAoB,aAAa,IAAA,CAAK;AAAA,EAC1C,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,cAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,SAAA,EAAW,YAAA;AAAA,MACX,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAA,EAAS,KAC5C,IAAI,cAAA,CAAe;AAAA,MACjB,SAAA;AAAA,MACA,YAAA;AAAA,MACA;AAAA,KACD;AAAA,GACJ;AACL,CAAC,CAAA;AAGM,MAAM,qCAAA,GACX,8BAA8B,iBAAA,CAAkB;AAAA,EAC9C,YAAA,EAAc;AAAA,IACZ,KAAA,EAAO,CAAA,CAAE,MAAA,EAAO,CAAE,QAAA,EAAS;AAAA,IAC3B,SAAA,EAAW,CAAA,CAAE,MAAA,EAAO,CAAE,QAAQ,CAAC,CAAA;AAAA,IAC/B,MAAA,EAAQ,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,IAAI,CAAA;AAAA,IAChC,UAAA,EAAY,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,IAAI;AAAA,GACtC;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAO,EAAG;AACnC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,sBAAO,QAAA,EAAA,EAAS,CAAA;AAAA,MAChB,SAAA,EAAW,CAAA,MAAA,KAAU,MAAA,CAAO,IAAA,KAAS,UAAA;AAAA,MACrC,WAAW,YAAY;AACrB,QAAA,MAAM,EAAE,4BAAA,EAA6B,GAAI,MAAM,OAC7C,yDACF,CAAA;AACA,QAAA,OAAO,2BACL,GAAA,CAAC,4BAAA,EAAA,EAA8B,GAAG,KAAA,EAAQ,GAAG,MAAA,EAAQ,CAAA;AAAA,MAEzD;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;AAEH,MAAM,uCAAA,GACJ,gCAAgC,IAAA,CAAK;AAAA,EACnC,MAAA,EAAQ;AAAA,IACN,KAAA,EAAO,UAAA;AAAA,IACP,IAAA,EAAM,eAAA;AAAA,IACN,IAAA,sBAAO,QAAA,EAAA,EAAS;AAAA;AAEpB,CAAC,CAAA;AAOH,MAAM,YAAA,GAAe,cAAc,IAAA,CAAK;AAAA,EACtC,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,OAAA;AAAA,IACN,QAAA,EAAU,YAAA;AAAA,IACV,KAAA,EAAO,MAAA;AAAA,IACP,IAAA,sBAAO,aAAA,EAAA,EAAc,CAAA;AAAA,IACrB,MAAA,EAAQ,MACN,OAAO,oDAAuC,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBACnD,GAAA,CAAC,CAAA,CAAE,wBAAA,EAAF,EAA2B,CAC7B;AAAA;AAEP,CAAC,CAAA;AAOD,MAAM,kBAAA,GAAqB,cAAc,iBAAA,CAAkB;AAAA,EACzD,IAAA,EAAM,QAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,QAAQ,oBAAA,CAAqB,CAAC,cAAA,CAAe,QAAA,CAAS,KAAK,CAAC;AAAA,GAC9D;AAAA,EACA,YAAA,EAAc;AAAA,IACZ,aAAA,EAAe,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,KAAK,CAAA;AAAA,IACxC,aAAA,EAAe,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,KAAK;AAAA,GAC1C;AAAA,EACA,QAAQ,eAAA,EAAiB,EAAE,IAAA,EAAM,MAAA,EAAQ,QAAO,EAAG;AACjD,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,GAAA,CAAI,oBAAoB,CAAA;AAE/C,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,8BAAA;AAAA,MACN,QAAA,EAAU,gBAAA;AAAA,MACV,QAAQ,YAAY;AAElB,QAAA,MAAM,SAAA,GAAY,SAAA,EAAW,SAAA,EAAU,IAAK,EAAC;AAC7C,QAAA,MAAM,YAAA,GAAe,OAAO,MAAA,CAAO,GAAA;AAAA,UAAI,CAAA,MAAA,KACrC,MAAA,CAAO,GAAA,CAAI,cAAA,CAAe,SAAS,KAAK;AAAA,SAC1C;AACA,QAAA,MAAM,YAAA,GAAe,CAAC,GAAG,SAAA,EAAW,GAAG,YAAY,CAAA;AAEnD,QAAA,MAAM,MAAA,GAAS,YAAA,CAAa,GAAA,CAAI,CAAA,OAAA,KAAW;AACzC,UAAA,MAAM,QAAQ,OAAA,CAAQ,SAAA;AACtB,UAAA,gCAAA,CAAiC,OAAO,OAAO,CAAA;AAC/C,UAAA,uBACE,GAAA,CAAC,YAA4B,QAAA,EAAU,IAAA,EACrC,8BAAC,KAAA,EAAA,EAAM,CAAA,EAAA,EADM,QAAQ,IAEvB,CAAA;AAAA,QAEJ,CAAC,CAAA;AAED,QAAA,OAAO,OAAO,iBAAW,CAAA,CAAE,IAAA,CAAK,CAAC,EAAE,oBAAA,EAAqB,qBACtD,IAAA,CAAC,oBAAA,EAAA,EACC,QAAA,EAAA;AAAA,0BAAA,GAAA;AAAA,YAAC,oBAAA;AAAA,YAAA;AAAA,cACC,UAAA,EAAY,CAAC,MAAA,CAAO,aAAA;AAAA,cACpB,UAAA,EAAY,CAAC,MAAA,CAAO;AAAA;AAAA,WACtB;AAAA,0BACA,GAAA,CAAC,kBAAgB,QAAA,EAAA,MAAA,EAAO;AAAA,SAAA,EAC1B,CACD,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC,CAAA;AAOD,MAAM,qBAAA,GAAwB,uBAAuB,iBAAA,CAAkB;AAAA,EACrE,MAAA,EAAQ;AAAA,IACN,QAAQ,oBAAA,CAAqB,CAAC,cAAA,CAAe,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,IAC5D,UAAA,EAAY,oBAAA;AAAA,MACV,CAAC,iBAAA,CAAkB,YAAA,CAAa,QAAA,EAAU,CAAA;AAAA,MAC1C;AAAA,QACE,SAAA,EAAW,IAAA;AAAA,QACX,QAAA,EAAU;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAA,CAAQ,iBAAiB,OAAA,EAAS;AAChC,IAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,IAAA,CAAK,GAAA,CAAI,oBAAoB,CAAA;AAEvD,IAAA,OAAO,eAAA;AAAA,MACL;AAAA,QACE,IAAA,EAAM,MAAA;AAAA,QACN,KAAA,EAAO,UAAA;AAAA,QACP,KAAA,EAAO,eAAA;AAAA,QACP,QAAA,EAAU,uBAAA;AAAA,QACV,QAAQ,MAAM;AAEZ,UAAA,MAAM,SAAA,GAAY,SAAA,EAAW,SAAA,EAAU,IAAK,EAAC;AAC7C,UAAA,MAAM,YAAA,GAAe,OAAA,CAAQ,MAAA,CAAO,MAAA,CAAO,GAAA;AAAA,YAAI,CAAA,MAAA,KAC7C,MAAA,CAAO,GAAA,CAAI,cAAA,CAAe,SAAS,KAAK;AAAA,WAC1C;AACA,UAAA,MAAM,YAAA,GAAe,CAAC,GAAG,SAAA,EAAW,GAAG,YAAY,CAAA;AAEnD,UAAA,MAAM,MAAA,GAAS,YAAA,CAAa,GAAA,CAAI,CAAA,OAAA,KAAW;AACzC,YAAA,MAAM,QAAQ,OAAA,CAAQ,SAAA;AACtB,YAAA,gCAAA,CAAiC,OAAO,OAAO,CAAA;AAC/C,YAAA,uBACE,GAAA,CAAC,YAA4B,QAAA,EAAU,IAAA,EACrC,8BAAC,KAAA,EAAA,EAAM,CAAA,EAAA,EADM,QAAQ,IAEvB,CAAA;AAAA,UAEJ,CAAC,CAAA;AAED,UAAA,OAAO,OAAO,iBAAW,CAAA,CAAE,KAAK,CAAC,EAAE,oBAAmB,qBACpD,GAAA;AAAA,YAAC,kBAAA;AAAA,YAAA;AAAA,cACC,UAAA,EAAY,OAAA,CAAQ,MAAA,CAAO,UAAA,EAAY,GAAA;AAAA,gBACrC,iBAAA,CAAkB;AAAA,eACpB;AAAA,cAEA,QAAA,kBAAA,GAAA,CAAC,kBAAgB,QAAA,EAAA,MAAA,EAAO;AAAA;AAAA,WAE3B,CAAA;AAAA,QACH;AAAA,OACF;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;AAED,MAAM,kCAAkC,eAAA,CAAgB;AAAA,EACtD,IAAA,EAAM,aAAA;AAAA,EACN,IAAA,EAAM,gBAAA;AAAA,EACN,QAAA,EAAU,EAAE,EAAA,EAAI,yBAAA,EAA2B,OAAO,YAAA,EAAa;AAAA,EAC/D,MAAA,EAAQ,CAAC,iBAAA,CAAkB,YAAA,CAAa,UAAU,CAAA;AAAA,EAClD,OAAA,EAAS,MAAM;AACjB,CAAC,CAAA;AAED,MAAM,qBAAA,GAAwB,4BAA4B,IAAA,CAAK;AAAA,EAC7D,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,MAAA,EAAQ,4BACN,GAAA,CAAC,aAAA,EAAA,EAAc,QAAA,EAAA,2CAAA,EAAyC;AAAA,GAE3D;AACL,CAAC,CAAA;AAGD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,UAAA;AAAA,EACV,KAAA,EAAO,eAAA;AAAA,EACP,IAAA,sBAAO,aAAA,EAAA,EAAc,CAAA;AAAA,EACrB,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,wCAAoB,CAAA,EAAE;AAAA,EACxD,UAAA,EAAY;AAAA,IACV,iBAAA;AAAA,IACA,kBAAA;AAAA,IACA,0BAAA;AAAA,IACA,qBAAA;AAAA,IACA,YAAA;AAAA,IACA,kBAAA;AAAA,IACA,sBAAA;AAAA,IACA,qBAAA;AAAA,IACA,+BAAA;AAAA,IACA,uCAAA;AAAA,IACA;AAAA,GACF;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,YAAA;AAAA,IACN,OAAA,EAAS,gBAAA;AAAA,IACT,aAAA,EAAe;AAAA;AAEnB,CAAC,CAAA;;;;"}

package/dist/home/components/Grids/InfoCardGrid.esm.js

@@ -69,7 +69,7 @@ const InfoCardGrid = (props) => {
         )
       ]
     },
-    entity.metadata.name
+    stringifyEntityRef(entity)
   )) });
 };
 

package/dist/home/components/Grids/InfoCardGrid.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"InfoCardGrid.esm.js","sources":["../../../../src/home/components/Grids/InfoCardGrid.tsx"],"sourcesContent":["/*\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 useAsync from 'react-use/esm/useAsync';\nimport { Entity, stringifyEntityRef } from '@backstage/catalog-model';\nimport { useApi, useRouteRef, configApiRef } from '@backstage/core-plugin-api';\nimport {\n  ItemCardGrid,\n  InfoCard,\n  Link,\n  Progress,\n} from '@backstage/core-components';\nimport {\n  EntityRefPresentationSnapshot,\n  entityPresentationApiRef,\n} from '@backstage/plugin-catalog-react';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { rootDocsRouteRef } from '../../../routes';\nimport { toLowerMaybe } from '../../../helpers';\n\n/** @public */\nexport type InfoCardGridClassKey = 'linkSpacer' | 'readMoreLink';\n\nconst useStyles = makeStyles(\n  theme => ({\n    linkSpacer: {\n      paddingTop: theme.spacing(0.2),\n    },\n    readMoreLink: {\n      paddingTop: theme.spacing(0.2),\n    },\n  }),\n  { name: 'BackstageInfoCardGrid' },\n);\n\n/**\n * Props for {@link InfoCardGrid}\n *\n * @public\n */\nexport type InfoCardGridProps = {\n  entities: Entity[] | undefined;\n  linkContent?: string | JSX.Element;\n  linkDestination?: (entity: Entity) => string | undefined;\n};\n\n/**\n * Component which accepts a list of entities and renders a info card for each entity\n *\n * @public\n */\nexport const InfoCardGrid = (props: InfoCardGridProps) => {\n  const { entities, linkContent, linkDestination } = props;\n  const classes = useStyles();\n  const getRouteToReaderPageFor = useRouteRef(rootDocsRouteRef);\n  const config = useApi(configApiRef);\n  const linkRoute = (entity: Entity) => {\n    if (linkDestination) {\n      const destination = linkDestination(entity);\n      if (destination) {\n        return destination;\n      }\n    }\n    return getRouteToReaderPageFor({\n      namespace: toLowerMaybe(entity.metadata.namespace ?? 'default', config),\n      kind: toLowerMaybe(entity.kind, config),\n      name: toLowerMaybe(entity.metadata.name, config),\n    });\n  };\n  const entityPresentationApi = useApi(entityPresentationApiRef);\n  const { value: entityRefToPresentation, loading } = useAsync(async () => {\n    return new Map<string, EntityRefPresentationSnapshot>(\n      await Promise.all(\n        entities?.map(async entity => {\n          const presentation = await entityPresentationApi.forEntity(entity)\n            .promise;\n          return [stringifyEntityRef(entity), presentation] as [\n            string,\n            EntityRefPresentationSnapshot,\n          ];\n        }) || [],\n      ),\n    );\n  });\n  if (loading) return <Progress />;\n  if (!entities || !entities?.length) return null;\n  return (\n    <ItemCardGrid data-testid=\"info-card-container\">\n      {entities.map(entity => (\n        <InfoCard\n          key={entity.metadata.name}\n          data-testid={entity?.metadata?.title}\n          title={\n            entityRefToPresentation?.get(stringifyEntityRef(entity))\n              ?.primaryTitle\n          }\n        >\n          <div>{entity?.metadata?.description}</div>\n          <div className={classes.linkSpacer} />\n          <Link\n            to={linkRoute(entity)}\n            className={classes.readMoreLink}\n            data-testid=\"read-docs-link\"\n          >\n            {linkContent || 'Read Docs'}\n          </Link>\n        </InfoCard>\n      ))}\n    </ItemCardGrid>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;AAoCA,MAAM,SAAA,GAAY,UAAA;AAAA,EAChB,CAAA,KAAA,MAAU;AAAA,IACR,UAAA,EAAY;AAAA,MACV,UAAA,EAAY,KAAA,CAAM,OAAA,CAAQ,GAAG;AAAA,KAC/B;AAAA,IACA,YAAA,EAAc;AAAA,MACZ,UAAA,EAAY,KAAA,CAAM,OAAA,CAAQ,GAAG;AAAA;AAC/B,GACF,CAAA;AAAA,EACA,EAAE,MAAM,uBAAA;AACV,CAAA;AAkBO,MAAM,YAAA,GAAe,CAAC,KAAA,KAA6B;AACxD,EAAA,MAAM,EAAE,QAAA,EAAU,WAAA,EAAa,eAAA,EAAgB,GAAI,KAAA;AACnD,EAAA,MAAM,UAAU,SAAA,EAAU;AAC1B,EAAA,MAAM,uBAAA,GAA0B,YAAY,gBAAgB,CAAA;AAC5D,EAAA,MAAM,MAAA,GAAS,OAAO,YAAY,CAAA;AAClC,EAAA,MAAM,SAAA,GAAY,CAAC,MAAA,KAAmB;AACpC,IAAA,IAAI,eAAA,EAAiB;AACnB,MAAA,MAAM,WAAA,GAAc,gBAAgB,MAAM,CAAA;AAC1C,MAAA,IAAI,WAAA,EAAa;AACf,QAAA,OAAO,WAAA;AAAA,MACT;AAAA,IACF;AACA,IAAA,OAAO,uBAAA,CAAwB;AAAA,MAC7B,WAAW,YAAA,CAAa,MAAA,CAAO,QAAA,CAAS,SAAA,IAAa,WAAW,MAAM,CAAA;AAAA,MACtE,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,IAAA,EAAM,MAAM,CAAA;AAAA,MACtC,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,QAAA,CAAS,MAAM,MAAM;AAAA,KAChD,CAAA;AAAA,EACH,CAAA;AACA,EAAA,MAAM,qBAAA,GAAwB,OAAO,wBAAwB,CAAA;AAC7D,EAAA,MAAM,EAAE,KAAA,EAAO,uBAAA,EAAyB,OAAA,EAAQ,GAAI,SAAS,YAAY;AACvE,IAAA,OAAO,IAAI,GAAA;AAAA,MACT,MAAM,OAAA,CAAQ,GAAA;AAAA,QACZ,QAAA,EAAU,GAAA,CAAI,OAAM,MAAA,KAAU;AAC5B,UAAA,MAAM,YAAA,GAAe,MAAM,qBAAA,CAAsB,SAAA,CAAU,MAAM,CAAA,CAC9D,OAAA;AACH,UAAA,OAAO,CAAC,kBAAA,CAAmB,MAAM,CAAA,EAAG,YAAY,CAAA;AAAA,QAIlD,CAAC,KAAK;AAAC;AACT,KACF;AAAA,EACF,CAAC,CAAA;AACD,EAAA,IAAI,OAAA,EAAS,uBAAO,GAAA,CAAC,QAAA,EAAA,EAAS,CAAA;AAC9B,EAAA,IAAI,CAAC,QAAA,IAAY,CAAC,QAAA,EAAU,QAAQ,OAAO,IAAA;AAC3C,EAAA,2BACG,YAAA,EAAA,EAAa,aAAA,EAAY,qBAAA,EACvB,QAAA,EAAA,QAAA,CAAS,IAAI,CAAA,MAAA,qBACZ,IAAA;AAAA,IAAC,QAAA;AAAA,IAAA;AAAA,MAEC,aAAA,EAAa,QAAQ,QAAA,EAAU,KAAA;AAAA,MAC/B,OACE,uBAAA,EAAyB,GAAA,CAAI,kBAAA,CAAmB,MAAM,CAAC,CAAA,EACnD,YAAA;AAAA,MAGN,QAAA,EAAA;AAAA,wBAAA,GAAA,CAAC,KAAA,EAAA,EAAK,QAAA,EAAA,MAAA,EAAQ,QAAA,EAAU,WAAA,EAAY,CAAA;AAAA,wBACpC,GAAA,CAAC,KAAA,EAAA,EAAI,SAAA,EAAW,OAAA,CAAQ,UAAA,EAAY,CAAA;AAAA,wBACpC,GAAA;AAAA,UAAC,IAAA;AAAA,UAAA;AAAA,YACC,EAAA,EAAI,UAAU,MAAM,CAAA;AAAA,YACpB,WAAW,OAAA,CAAQ,YAAA;AAAA,YACnB,aAAA,EAAY,gBAAA;AAAA,YAEX,QAAA,EAAA,WAAA,IAAe;AAAA;AAAA;AAClB;AAAA,KAAA;AAAA,IAfK,OAAO,QAAA,CAAS;AAAA,GAiBxB,CAAA,EACH,CAAA;AAEJ;;;;"}
+{"version":3,"file":"InfoCardGrid.esm.js","sources":["../../../../src/home/components/Grids/InfoCardGrid.tsx"],"sourcesContent":["/*\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 useAsync from 'react-use/esm/useAsync';\nimport { Entity, stringifyEntityRef } from '@backstage/catalog-model';\nimport { useApi, useRouteRef, configApiRef } from '@backstage/core-plugin-api';\nimport {\n  ItemCardGrid,\n  InfoCard,\n  Link,\n  Progress,\n} from '@backstage/core-components';\nimport {\n  EntityRefPresentationSnapshot,\n  entityPresentationApiRef,\n} from '@backstage/plugin-catalog-react';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { rootDocsRouteRef } from '../../../routes';\nimport { toLowerMaybe } from '../../../helpers';\n\n/** @public */\nexport type InfoCardGridClassKey = 'linkSpacer' | 'readMoreLink';\n\nconst useStyles = makeStyles(\n  theme => ({\n    linkSpacer: {\n      paddingTop: theme.spacing(0.2),\n    },\n    readMoreLink: {\n      paddingTop: theme.spacing(0.2),\n    },\n  }),\n  { name: 'BackstageInfoCardGrid' },\n);\n\n/**\n * Props for {@link InfoCardGrid}\n *\n * @public\n */\nexport type InfoCardGridProps = {\n  entities: Entity[] | undefined;\n  linkContent?: string | JSX.Element;\n  linkDestination?: (entity: Entity) => string | undefined;\n};\n\n/**\n * Component which accepts a list of entities and renders a info card for each entity\n *\n * @public\n */\nexport const InfoCardGrid = (props: InfoCardGridProps) => {\n  const { entities, linkContent, linkDestination } = props;\n  const classes = useStyles();\n  const getRouteToReaderPageFor = useRouteRef(rootDocsRouteRef);\n  const config = useApi(configApiRef);\n  const linkRoute = (entity: Entity) => {\n    if (linkDestination) {\n      const destination = linkDestination(entity);\n      if (destination) {\n        return destination;\n      }\n    }\n    return getRouteToReaderPageFor({\n      namespace: toLowerMaybe(entity.metadata.namespace ?? 'default', config),\n      kind: toLowerMaybe(entity.kind, config),\n      name: toLowerMaybe(entity.metadata.name, config),\n    });\n  };\n  const entityPresentationApi = useApi(entityPresentationApiRef);\n  const { value: entityRefToPresentation, loading } = useAsync(async () => {\n    return new Map<string, EntityRefPresentationSnapshot>(\n      await Promise.all(\n        entities?.map(async entity => {\n          const presentation = await entityPresentationApi.forEntity(entity)\n            .promise;\n          return [stringifyEntityRef(entity), presentation] as [\n            string,\n            EntityRefPresentationSnapshot,\n          ];\n        }) || [],\n      ),\n    );\n  });\n  if (loading) return <Progress />;\n  if (!entities || !entities?.length) return null;\n  return (\n    <ItemCardGrid data-testid=\"info-card-container\">\n      {entities.map(entity => (\n        <InfoCard\n          key={stringifyEntityRef(entity)}\n          data-testid={entity?.metadata?.title}\n          title={\n            entityRefToPresentation?.get(stringifyEntityRef(entity))\n              ?.primaryTitle\n          }\n        >\n          <div>{entity?.metadata?.description}</div>\n          <div className={classes.linkSpacer} />\n          <Link\n            to={linkRoute(entity)}\n            className={classes.readMoreLink}\n            data-testid=\"read-docs-link\"\n          >\n            {linkContent || 'Read Docs'}\n          </Link>\n        </InfoCard>\n      ))}\n    </ItemCardGrid>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;AAoCA,MAAM,SAAA,GAAY,UAAA;AAAA,EAChB,CAAA,KAAA,MAAU;AAAA,IACR,UAAA,EAAY;AAAA,MACV,UAAA,EAAY,KAAA,CAAM,OAAA,CAAQ,GAAG;AAAA,KAC/B;AAAA,IACA,YAAA,EAAc;AAAA,MACZ,UAAA,EAAY,KAAA,CAAM,OAAA,CAAQ,GAAG;AAAA;AAC/B,GACF,CAAA;AAAA,EACA,EAAE,MAAM,uBAAA;AACV,CAAA;AAkBO,MAAM,YAAA,GAAe,CAAC,KAAA,KAA6B;AACxD,EAAA,MAAM,EAAE,QAAA,EAAU,WAAA,EAAa,eAAA,EAAgB,GAAI,KAAA;AACnD,EAAA,MAAM,UAAU,SAAA,EAAU;AAC1B,EAAA,MAAM,uBAAA,GAA0B,YAAY,gBAAgB,CAAA;AAC5D,EAAA,MAAM,MAAA,GAAS,OAAO,YAAY,CAAA;AAClC,EAAA,MAAM,SAAA,GAAY,CAAC,MAAA,KAAmB;AACpC,IAAA,IAAI,eAAA,EAAiB;AACnB,MAAA,MAAM,WAAA,GAAc,gBAAgB,MAAM,CAAA;AAC1C,MAAA,IAAI,WAAA,EAAa;AACf,QAAA,OAAO,WAAA;AAAA,MACT;AAAA,IACF;AACA,IAAA,OAAO,uBAAA,CAAwB;AAAA,MAC7B,WAAW,YAAA,CAAa,MAAA,CAAO,QAAA,CAAS,SAAA,IAAa,WAAW,MAAM,CAAA;AAAA,MACtE,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,IAAA,EAAM,MAAM,CAAA;AAAA,MACtC,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,QAAA,CAAS,MAAM,MAAM;AAAA,KAChD,CAAA;AAAA,EACH,CAAA;AACA,EAAA,MAAM,qBAAA,GAAwB,OAAO,wBAAwB,CAAA;AAC7D,EAAA,MAAM,EAAE,KAAA,EAAO,uBAAA,EAAyB,OAAA,EAAQ,GAAI,SAAS,YAAY;AACvE,IAAA,OAAO,IAAI,GAAA;AAAA,MACT,MAAM,OAAA,CAAQ,GAAA;AAAA,QACZ,QAAA,EAAU,GAAA,CAAI,OAAM,MAAA,KAAU;AAC5B,UAAA,MAAM,YAAA,GAAe,MAAM,qBAAA,CAAsB,SAAA,CAAU,MAAM,CAAA,CAC9D,OAAA;AACH,UAAA,OAAO,CAAC,kBAAA,CAAmB,MAAM,CAAA,EAAG,YAAY,CAAA;AAAA,QAIlD,CAAC,KAAK;AAAC;AACT,KACF;AAAA,EACF,CAAC,CAAA;AACD,EAAA,IAAI,OAAA,EAAS,uBAAO,GAAA,CAAC,QAAA,EAAA,EAAS,CAAA;AAC9B,EAAA,IAAI,CAAC,QAAA,IAAY,CAAC,QAAA,EAAU,QAAQ,OAAO,IAAA;AAC3C,EAAA,2BACG,YAAA,EAAA,EAAa,aAAA,EAAY,qBAAA,EACvB,QAAA,EAAA,QAAA,CAAS,IAAI,CAAA,MAAA,qBACZ,IAAA;AAAA,IAAC,QAAA;AAAA,IAAA;AAAA,MAEC,aAAA,EAAa,QAAQ,QAAA,EAAU,KAAA;AAAA,MAC/B,OACE,uBAAA,EAAyB,GAAA,CAAI,kBAAA,CAAmB,MAAM,CAAC,CAAA,EACnD,YAAA;AAAA,MAGN,QAAA,EAAA;AAAA,wBAAA,GAAA,CAAC,KAAA,EAAA,EAAK,QAAA,EAAA,MAAA,EAAQ,QAAA,EAAU,WAAA,EAAY,CAAA;AAAA,wBACpC,GAAA,CAAC,KAAA,EAAA,EAAI,SAAA,EAAW,OAAA,CAAQ,UAAA,EAAY,CAAA;AAAA,wBACpC,GAAA;AAAA,UAAC,IAAA;AAAA,UAAA;AAAA,YACC,EAAA,EAAI,UAAU,MAAM,CAAA;AAAA,YACpB,WAAW,OAAA,CAAQ,YAAA;AAAA,YACnB,aAAA,EAAY,gBAAA;AAAA,YAEX,QAAA,EAAA,WAAA,IAAe;AAAA;AAAA;AAClB;AAAA,KAAA;AAAA,IAfK,mBAAmB,MAAM;AAAA,GAiBjC,CAAA,EACH,CAAA;AAEJ;;;;"}

package/dist/plugins/techdocs/package.json.esm.js

@@ -1,5 +1,5 @@
 var name = "@backstage/plugin-techdocs";
-var version = "1.17.7";
+var version = "1.17.8";
 var description = "The Backstage plugin that renders technical documentation for your components";
 var backstage = {
 	role: "frontend-plugin",
@@ -81,7 +81,7 @@ var dependencies = {
 	"@material-ui/styles": "^4.10.0",
 	"@microsoft/fetch-event-source": "^2.0.1",
 	"@remixicon/react": ">=4.6.0 <4.9.0",
-	dompurify: "^3.3.2",
+	dompurify: "^3.4.11",
 	"git-url-parse": "^15.0.0",
 	lodash: "^4.17.21",
 	"react-helmet": "6.1.0",

package/dist/reader/transformers/html/transformer.esm.js

@@ -1,5 +1,5 @@
 import DOMPurify from 'dompurify';
-import { useCallback, useMemo } from 'react';
+import { useMemo, useCallback } from 'react';
 import { useApi, configApiRef } from '@backstage/core-plugin-api';
 import { removeUnsafeLinks } from './hooks/links.esm.js';
 import { removeUnsafeIframes } from './hooks/iframes.esm.js';
@@ -14,17 +14,24 @@ const useSanitizerConfig = () => {
 };
 const useSanitizerTransformer = () => {
   const config = useSanitizerConfig();
+  const purify = useMemo(() => {
+    const instance = DOMPurify();
+    instance.addHook("beforeSanitizeElements", removeUnsafeLinks);
+    const hosts = config?.getOptionalStringArray("allowedIframeHosts");
+    if (hosts) {
+      instance.addHook("beforeSanitizeElements", removeUnsafeIframes(hosts));
+    }
+    instance.addHook("uponSanitizeElement", removeUnsafeMetaTags);
+    instance.addHook("uponSanitizeAttribute", removeRestrictedAttributes);
+    return instance;
+  }, [config]);
   return useCallback(
     async (dom) => {
       const hosts = config?.getOptionalStringArray("allowedIframeHosts");
-      DOMPurify.addHook("beforeSanitizeElements", removeUnsafeLinks);
       const tags = ["link", "meta"];
       if (hosts) {
         tags.push("iframe");
-        DOMPurify.addHook("beforeSanitizeElements", removeUnsafeIframes(hosts));
       }
-      DOMPurify.addHook("uponSanitizeElement", removeUnsafeMetaTags);
-      DOMPurify.addHook("uponSanitizeAttribute", removeRestrictedAttributes);
       const tagNameCheck = config?.getOptionalString(
         "allowedCustomElementTagNameRegExp"
       );
@@ -55,7 +62,7 @@ const useSanitizerTransformer = () => {
         )}:|[^a-z]|[a-z+.-]+(?:[^a-z+.\\-:]|$))`,
         "i"
       );
-      return DOMPurify.sanitize(dom.outerHTML, {
+      return purify.sanitize(dom.outerHTML, {
         ADD_TAGS: tags,
         FORBID_TAGS: ["style"],
         ADD_ATTR: ["http-equiv", "content", "dominant-baseline"],
@@ -68,7 +75,7 @@ const useSanitizerTransformer = () => {
         }
       });
     },
-    [config]
+    [config, purify]
   );
 };
 

package/dist/reader/transformers/html/transformer.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"transformer.esm.js","sources":["../../../../src/reader/transformers/html/transformer.ts"],"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 DOMPurify from 'dompurify';\nimport { useCallback, useMemo } from 'react';\n\nimport { configApiRef, useApi } from '@backstage/core-plugin-api';\n\nimport { Transformer } from '../transformer';\nimport {\n  removeRestrictedAttributes,\n  removeUnsafeIframes,\n  removeUnsafeLinks,\n  removeUnsafeMetaTags,\n} from './hooks';\n\n/**\n * Returns html sanitizer configuration\n */\nconst useSanitizerConfig = () => {\n  const configApi = useApi(configApiRef);\n\n  return useMemo(() => {\n    return configApi.getOptionalConfig('techdocs.sanitizer');\n  }, [configApi]);\n};\n\n/**\n * Returns a transformer that sanitizes the dom\n */\nexport const useSanitizerTransformer = (): Transformer => {\n  const config = useSanitizerConfig();\n\n  return useCallback(\n    async (dom: Element) => {\n      const hosts = config?.getOptionalStringArray('allowedIframeHosts');\n\n      DOMPurify.addHook('beforeSanitizeElements', removeUnsafeLinks);\n      const tags = ['link', 'meta'];\n\n      if (hosts) {\n        tags.push('iframe');\n        DOMPurify.addHook('beforeSanitizeElements', removeUnsafeIframes(hosts));\n      }\n\n      DOMPurify.addHook('uponSanitizeElement', removeUnsafeMetaTags);\n\n      DOMPurify.addHook('uponSanitizeAttribute', removeRestrictedAttributes);\n\n      const tagNameCheck = config?.getOptionalString(\n        'allowedCustomElementTagNameRegExp',\n      );\n      const attributeNameCheck = config?.getOptionalString(\n        'allowedCustomElementAttributeNameRegExp',\n      );\n      const additionalAllowedURIProtocols =\n        config?.getOptionalStringArray('additionalAllowedURIProtocols') || [];\n\n      // Define allowed URI protocols, including any additional ones from the config.\n      // The default protocols are based on the DOMPurify defaults.\n      const allowedURIProtocols = [\n        'callto',\n        'cid',\n        'ftp',\n        'ftps',\n        'http',\n        'https',\n        'mailto',\n        'matrix',\n        'sms',\n        'tel',\n        'xmpp',\n        ...additionalAllowedURIProtocols,\n      ].filter(Boolean);\n\n      const allowedURIRegExp = new RegExp(\n        // This regex is not exposed by DOMPurify, so we need to define it ourselves.\n        // It is possible for this to drift from the default in future versions of DOMPurify.\n        // See: https://raw.githubusercontent.com/cure53/DOMPurify/master/src/regexp.ts\n        `^(?:${allowedURIProtocols.join(\n          '|',\n        )}:|[^a-z]|[a-z+.-]+(?:[^a-z+.\\\\-:]|$))`,\n        'i',\n      );\n\n      // using outerHTML as we want to preserve the html tag attributes (lang)\n      return DOMPurify.sanitize(dom.outerHTML, {\n        ADD_TAGS: tags,\n        FORBID_TAGS: ['style'],\n        ADD_ATTR: ['http-equiv', 'content', 'dominant-baseline'],\n        WHOLE_DOCUMENT: true,\n        RETURN_DOM: true,\n        ALLOWED_URI_REGEXP: allowedURIRegExp,\n        CUSTOM_ELEMENT_HANDLING: {\n          tagNameCheck: tagNameCheck ? new RegExp(tagNameCheck) : undefined,\n          attributeNameCheck: attributeNameCheck\n            ? new RegExp(attributeNameCheck)\n            : undefined,\n        },\n      }) as Element;\n    },\n    [config],\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AAgCA,MAAM,qBAAqB,MAAM;AAC/B,EAAA,MAAM,SAAA,GAAY,OAAO,YAAY,CAAA;AAErC,EAAA,OAAO,QAAQ,MAAM;AACnB,IAAA,OAAO,SAAA,CAAU,kBAAkB,oBAAoB,CAAA;AAAA,EACzD,CAAA,EAAG,CAAC,SAAS,CAAC,CAAA;AAChB,CAAA;AAKO,MAAM,0BAA0B,MAAmB;AACxD,EAAA,MAAM,SAAS,kBAAA,EAAmB;AAElC,EAAA,OAAO,WAAA;AAAA,IACL,OAAO,GAAA,KAAiB;AACtB,MAAA,MAAM,KAAA,GAAQ,MAAA,EAAQ,sBAAA,CAAuB,oBAAoB,CAAA;AAEjE,MAAA,SAAA,CAAU,OAAA,CAAQ,0BAA0B,iBAAiB,CAAA;AAC7D,MAAA,MAAM,IAAA,GAAO,CAAC,MAAA,EAAQ,MAAM,CAAA;AAE5B,MAAA,IAAI,KAAA,EAAO;AACT,QAAA,IAAA,CAAK,KAAK,QAAQ,CAAA;AAClB,QAAA,SAAA,CAAU,OAAA,CAAQ,wBAAA,EAA0B,mBAAA,CAAoB,KAAK,CAAC,CAAA;AAAA,MACxE;AAEA,MAAA,SAAA,CAAU,OAAA,CAAQ,uBAAuB,oBAAoB,CAAA;AAE7D,MAAA,SAAA,CAAU,OAAA,CAAQ,yBAAyB,0BAA0B,CAAA;AAErE,MAAA,MAAM,eAAe,MAAA,EAAQ,iBAAA;AAAA,QAC3B;AAAA,OACF;AACA,MAAA,MAAM,qBAAqB,MAAA,EAAQ,iBAAA;AAAA,QACjC;AAAA,OACF;AACA,MAAA,MAAM,6BAAA,GACJ,MAAA,EAAQ,sBAAA,CAAuB,+BAA+B,KAAK,EAAC;AAItE,MAAA,MAAM,mBAAA,GAAsB;AAAA,QAC1B,QAAA;AAAA,QACA,KAAA;AAAA,QACA,KAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,OAAA;AAAA,QACA,QAAA;AAAA,QACA,QAAA;AAAA,QACA,KAAA;AAAA,QACA,KAAA;AAAA,QACA,MAAA;AAAA,QACA,GAAG;AAAA,OACL,CAAE,OAAO,OAAO,CAAA;AAEhB,MAAA,MAAM,mBAAmB,IAAI,MAAA;AAAA;AAAA;AAAA;AAAA,QAI3B,OAAO,mBAAA,CAAoB,IAAA;AAAA,UACzB;AAAA,SACD,CAAA,qCAAA,CAAA;AAAA,QACD;AAAA,OACF;AAGA,MAAA,OAAO,SAAA,CAAU,QAAA,CAAS,GAAA,CAAI,SAAA,EAAW;AAAA,QACvC,QAAA,EAAU,IAAA;AAAA,QACV,WAAA,EAAa,CAAC,OAAO,CAAA;AAAA,QACrB,QAAA,EAAU,CAAC,YAAA,EAAc,SAAA,EAAW,mBAAmB,CAAA;AAAA,QACvD,cAAA,EAAgB,IAAA;AAAA,QAChB,UAAA,EAAY,IAAA;AAAA,QACZ,kBAAA,EAAoB,gBAAA;AAAA,QACpB,uBAAA,EAAyB;AAAA,UACvB,YAAA,EAAc,YAAA,GAAe,IAAI,MAAA,CAAO,YAAY,CAAA,GAAI,MAAA;AAAA,UACxD,kBAAA,EAAoB,kBAAA,GAChB,IAAI,MAAA,CAAO,kBAAkB,CAAA,GAC7B;AAAA;AACN,OACD,CAAA;AAAA,IACH,CAAA;AAAA,IACA,CAAC,MAAM;AAAA,GACT;AACF;;;;"}
+{"version":3,"file":"transformer.esm.js","sources":["../../../../src/reader/transformers/html/transformer.ts"],"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 DOMPurify from 'dompurify';\nimport { useCallback, useMemo } from 'react';\n\nimport { configApiRef, useApi } from '@backstage/core-plugin-api';\n\nimport { Transformer } from '../transformer';\nimport {\n  removeRestrictedAttributes,\n  removeUnsafeIframes,\n  removeUnsafeLinks,\n  removeUnsafeMetaTags,\n} from './hooks';\n\n/**\n * Returns html sanitizer configuration\n */\nconst useSanitizerConfig = () => {\n  const configApi = useApi(configApiRef);\n\n  return useMemo(() => {\n    return configApi.getOptionalConfig('techdocs.sanitizer');\n  }, [configApi]);\n};\n\n/**\n * Returns a transformer that sanitizes the dom\n */\nexport const useSanitizerTransformer = (): Transformer => {\n  const config = useSanitizerConfig();\n\n  const purify = useMemo(() => {\n    // eslint-disable-next-line new-cap\n    const instance = DOMPurify();\n\n    instance.addHook('beforeSanitizeElements', removeUnsafeLinks);\n\n    const hosts = config?.getOptionalStringArray('allowedIframeHosts');\n    if (hosts) {\n      instance.addHook('beforeSanitizeElements', removeUnsafeIframes(hosts));\n    }\n\n    instance.addHook('uponSanitizeElement', removeUnsafeMetaTags);\n\n    instance.addHook('uponSanitizeAttribute', removeRestrictedAttributes);\n\n    return instance;\n  }, [config]);\n\n  return useCallback(\n    async (dom: Element) => {\n      const hosts = config?.getOptionalStringArray('allowedIframeHosts');\n      const tags = ['link', 'meta'];\n\n      if (hosts) {\n        tags.push('iframe');\n      }\n\n      const tagNameCheck = config?.getOptionalString(\n        'allowedCustomElementTagNameRegExp',\n      );\n      const attributeNameCheck = config?.getOptionalString(\n        'allowedCustomElementAttributeNameRegExp',\n      );\n      const additionalAllowedURIProtocols =\n        config?.getOptionalStringArray('additionalAllowedURIProtocols') || [];\n\n      // Define allowed URI protocols, including any additional ones from the config.\n      // The default protocols are based on the DOMPurify defaults.\n      const allowedURIProtocols = [\n        'callto',\n        'cid',\n        'ftp',\n        'ftps',\n        'http',\n        'https',\n        'mailto',\n        'matrix',\n        'sms',\n        'tel',\n        'xmpp',\n        ...additionalAllowedURIProtocols,\n      ].filter(Boolean);\n\n      const allowedURIRegExp = new RegExp(\n        // This regex is not exposed by DOMPurify, so we need to define it ourselves.\n        // It is possible for this to drift from the default in future versions of DOMPurify.\n        // See: https://raw.githubusercontent.com/cure53/DOMPurify/master/src/regexp.ts\n        `^(?:${allowedURIProtocols.join(\n          '|',\n        )}:|[^a-z]|[a-z+.-]+(?:[^a-z+.\\\\-:]|$))`,\n        'i',\n      );\n\n      // using outerHTML as we want to preserve the html tag attributes (lang)\n      return purify.sanitize(dom.outerHTML, {\n        ADD_TAGS: tags,\n        FORBID_TAGS: ['style'],\n        ADD_ATTR: ['http-equiv', 'content', 'dominant-baseline'],\n        WHOLE_DOCUMENT: true,\n        RETURN_DOM: true,\n        ALLOWED_URI_REGEXP: allowedURIRegExp,\n        CUSTOM_ELEMENT_HANDLING: {\n          tagNameCheck: tagNameCheck ? new RegExp(tagNameCheck) : undefined,\n          attributeNameCheck: attributeNameCheck\n            ? new RegExp(attributeNameCheck)\n            : undefined,\n        },\n      }) as Element;\n    },\n    [config, purify],\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AAgCA,MAAM,qBAAqB,MAAM;AAC/B,EAAA,MAAM,SAAA,GAAY,OAAO,YAAY,CAAA;AAErC,EAAA,OAAO,QAAQ,MAAM;AACnB,IAAA,OAAO,SAAA,CAAU,kBAAkB,oBAAoB,CAAA;AAAA,EACzD,CAAA,EAAG,CAAC,SAAS,CAAC,CAAA;AAChB,CAAA;AAKO,MAAM,0BAA0B,MAAmB;AACxD,EAAA,MAAM,SAAS,kBAAA,EAAmB;AAElC,EAAA,MAAM,MAAA,GAAS,QAAQ,MAAM;AAE3B,IAAA,MAAM,WAAW,SAAA,EAAU;AAE3B,IAAA,QAAA,CAAS,OAAA,CAAQ,0BAA0B,iBAAiB,CAAA;AAE5D,IAAA,MAAM,KAAA,GAAQ,MAAA,EAAQ,sBAAA,CAAuB,oBAAoB,CAAA;AACjE,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,QAAA,CAAS,OAAA,CAAQ,wBAAA,EAA0B,mBAAA,CAAoB,KAAK,CAAC,CAAA;AAAA,IACvE;AAEA,IAAA,QAAA,CAAS,OAAA,CAAQ,uBAAuB,oBAAoB,CAAA;AAE5D,IAAA,QAAA,CAAS,OAAA,CAAQ,yBAAyB,0BAA0B,CAAA;AAEpE,IAAA,OAAO,QAAA;AAAA,EACT,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AAEX,EAAA,OAAO,WAAA;AAAA,IACL,OAAO,GAAA,KAAiB;AACtB,MAAA,MAAM,KAAA,GAAQ,MAAA,EAAQ,sBAAA,CAAuB,oBAAoB,CAAA;AACjE,MAAA,MAAM,IAAA,GAAO,CAAC,MAAA,EAAQ,MAAM,CAAA;AAE5B,MAAA,IAAI,KAAA,EAAO;AACT,QAAA,IAAA,CAAK,KAAK,QAAQ,CAAA;AAAA,MACpB;AAEA,MAAA,MAAM,eAAe,MAAA,EAAQ,iBAAA;AAAA,QAC3B;AAAA,OACF;AACA,MAAA,MAAM,qBAAqB,MAAA,EAAQ,iBAAA;AAAA,QACjC;AAAA,OACF;AACA,MAAA,MAAM,6BAAA,GACJ,MAAA,EAAQ,sBAAA,CAAuB,+BAA+B,KAAK,EAAC;AAItE,MAAA,MAAM,mBAAA,GAAsB;AAAA,QAC1B,QAAA;AAAA,QACA,KAAA;AAAA,QACA,KAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,OAAA;AAAA,QACA,QAAA;AAAA,QACA,QAAA;AAAA,QACA,KAAA;AAAA,QACA,KAAA;AAAA,QACA,MAAA;AAAA,QACA,GAAG;AAAA,OACL,CAAE,OAAO,OAAO,CAAA;AAEhB,MAAA,MAAM,mBAAmB,IAAI,MAAA;AAAA;AAAA;AAAA;AAAA,QAI3B,OAAO,mBAAA,CAAoB,IAAA;AAAA,UACzB;AAAA,SACD,CAAA,qCAAA,CAAA;AAAA,QACD;AAAA,OACF;AAGA,MAAA,OAAO,MAAA,CAAO,QAAA,CAAS,GAAA,CAAI,SAAA,EAAW;AAAA,QACpC,QAAA,EAAU,IAAA;AAAA,QACV,WAAA,EAAa,CAAC,OAAO,CAAA;AAAA,QACrB,QAAA,EAAU,CAAC,YAAA,EAAc,SAAA,EAAW,mBAAmB,CAAA;AAAA,QACvD,cAAA,EAAgB,IAAA;AAAA,QAChB,UAAA,EAAY,IAAA;AAAA,QACZ,kBAAA,EAAoB,gBAAA;AAAA,QACpB,uBAAA,EAAyB;AAAA,UACvB,YAAA,EAAc,YAAA,GAAe,IAAI,MAAA,CAAO,YAAY,CAAA,GAAI,MAAA;AAAA,UACxD,kBAAA,EAAoB,kBAAA,GAChB,IAAI,MAAA,CAAO,kBAAkB,CAAA,GAC7B;AAAA;AACN,OACD,CAAA;AAAA,IACH,CAAA;AAAA,IACA,CAAC,QAAQ,MAAM;AAAA,GACjB;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs",
-  "version": "1.17.7",
+  "version": "1.17.8",
   "description": "The Backstage plugin that renders technical documentation for your components",
   "backstage": {
     "role": "frontend-plugin",
@@ -59,7 +59,7 @@
   },
   "files": [
     "dist",
-    "config.d.ts"
+    "config.schema.json"
   ],
   "scripts": {
     "build": "backstage-cli package build",
@@ -71,30 +71,30 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "^1.16.0",
+    "@backstage/catalog-client": "^1.16.1",
     "@backstage/catalog-model": "^1.9.0",
     "@backstage/config": "^1.3.8",
-    "@backstage/core-components": "^0.18.11",
-    "@backstage/core-plugin-api": "^1.12.7",
+    "@backstage/core-components": "^0.18.12",
+    "@backstage/core-plugin-api": "^1.12.8",
     "@backstage/errors": "^1.3.1",
-    "@backstage/frontend-plugin-api": "^0.17.2",
+    "@backstage/frontend-plugin-api": "^0.17.3",
     "@backstage/integration": "^2.0.3",
-    "@backstage/integration-react": "^1.2.19",
-    "@backstage/plugin-auth-react": "^0.1.28",
-    "@backstage/plugin-catalog-react": "^3.1.0",
+    "@backstage/integration-react": "^1.2.20",
+    "@backstage/plugin-auth-react": "^0.1.29",
+    "@backstage/plugin-catalog-react": "^3.2.0",
     "@backstage/plugin-search-common": "^1.2.24",
-    "@backstage/plugin-search-react": "^1.11.5",
+    "@backstage/plugin-search-react": "^1.11.6",
     "@backstage/plugin-techdocs-common": "^0.1.1",
-    "@backstage/plugin-techdocs-react": "^1.3.12",
+    "@backstage/plugin-techdocs-react": "^1.3.13",
     "@backstage/theme": "^0.7.3",
-    "@backstage/ui": "^0.16.0",
+    "@backstage/ui": "^0.17.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
     "@material-ui/styles": "^4.10.0",
     "@microsoft/fetch-event-source": "^2.0.1",
     "@remixicon/react": ">=4.6.0 <4.9.0",
-    "dompurify": "^3.3.2",
+    "dompurify": "^3.4.11",
     "git-url-parse": "^15.0.0",
     "lodash": "^4.17.21",
     "react-helmet": "6.1.0",
@@ -102,12 +102,12 @@
     "zod": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.36.3",
-    "@backstage/core-app-api": "^1.20.2",
-    "@backstage/dev-utils": "^1.1.24",
-    "@backstage/plugin-catalog": "^2.0.6",
-    "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.37",
-    "@backstage/test-utils": "^1.7.19",
+    "@backstage/cli": "^0.36.4",
+    "@backstage/core-app-api": "^1.20.3",
+    "@backstage/dev-utils": "^1.1.25",
+    "@backstage/plugin-catalog": "^2.0.7",
+    "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.38",
+    "@backstage/test-utils": "^1.7.20",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
@@ -129,6 +129,6 @@
       "optional": true
     }
   },
-  "configSchema": "config.d.ts",
+  "configSchema": "config.schema.json",
   "module": "./dist/index.esm.js"
 }

package/config.d.ts

@@ -1,73 +0,0 @@
-/*
- * Copyright 2020 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export interface Config {
-  /**
-   * Configuration options for the techdocs plugin
-   * @see http://backstage.io/docs/features/techdocs/configuration
-   */
-  techdocs?: {
-    /**
-     * Documentation building process depends on the builder attr
-     * @visibility frontend
-     */
-    builder?: 'local' | 'external';
-
-    /**
-     * Allows fallback to case-sensitive triplets in case of migration issues.
-     * @visibility frontend
-     * @see https://backstage.io/docs/features/techdocs/how-to-guides#how-to-migrate-from-techdocs-alpha-to-beta
-     */
-    legacyUseCaseSensitiveTripletPaths?: boolean;
-
-    sanitizer?: {
-      /**
-       * Allows iframe tag only for listed hosts
-       * Example:
-       *  allowedIframeHosts: ["example.com"]
-       *  this will allow all iframes with the host `example.com` in the src attribute
-       * @visibility frontend
-       */
-      allowedIframeHosts?: string[];
-      /**
-       * Allows listed custom element tag name regex
-       * Example:
-       *  allowedCustomElementTagNameRegExp: '^backstage-'
-       *  this will allow all custom elements with tag name matching `^backstage-` like <backstage-custom-element /> etc.
-       * @visibility frontend
-       */
-      allowedCustomElementTagNameRegExp?: string;
-      /**
-       * Allows listed custom element attribute name regex
-       * Example:
-       *  allowedCustomElementAttributeNameRegExp: 'attribute1|attribute2'
-       *  this will allow all custom element attributes matching `attribute1` or `attribute2` like <backstage-custom-element attribute1="yes" attribute2/>
-       * @visibility frontend
-       */
-      allowedCustomElementAttributeNameRegExp?: string;
-      /**
-       * Allows listed protocols in attributes with URI values
-       * Example:
-       *  additionalAllowedURIProtocols: ['vscode']
-       *  this will allow all attributes with URI values to have `vscode` protocol like `vscode://some/path` in addition to the default protocols
-       *  matched by DOMPurify's IS_ALLOWED_URI RegExp:
-       *  @see: https://raw.githubusercontent.com/cure53/DOMPurify/master/src/regexp.ts
-       * @visibility frontend
-       */
-      additionalAllowedURIProtocols?: string[];
-    };
-  };
-}