@backstage/plugin-techdocs 1.17.7 → 1.17.8-next.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/plugin-techdocs
 
+## 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/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-next.0";
 var description = "The Backstage plugin that renders technical documentation for your components";
 var backstage = {
 	role: "frontend-plugin",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs",
-  "version": "1.17.7",
+  "version": "1.17.8-next.0",
   "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,23 +71,23 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "^1.16.0",
-    "@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/errors": "^1.3.1",
-    "@backstage/frontend-plugin-api": "^0.17.2",
-    "@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/plugin-search-common": "^1.2.24",
-    "@backstage/plugin-search-react": "^1.11.5",
-    "@backstage/plugin-techdocs-common": "^0.1.1",
-    "@backstage/plugin-techdocs-react": "^1.3.12",
-    "@backstage/theme": "^0.7.3",
-    "@backstage/ui": "^0.16.0",
+    "@backstage/catalog-client": "1.16.1-next.0",
+    "@backstage/catalog-model": "1.9.0",
+    "@backstage/config": "1.3.8",
+    "@backstage/core-components": "0.18.12-next.0",
+    "@backstage/core-plugin-api": "1.12.8-next.0",
+    "@backstage/errors": "1.3.1",
+    "@backstage/frontend-plugin-api": "0.17.3-next.0",
+    "@backstage/integration": "2.0.3",
+    "@backstage/integration-react": "1.2.20-next.0",
+    "@backstage/plugin-auth-react": "0.1.29-next.0",
+    "@backstage/plugin-catalog-react": "3.2.0-next.0",
+    "@backstage/plugin-search-common": "1.2.24",
+    "@backstage/plugin-search-react": "1.11.6-next.0",
+    "@backstage/plugin-techdocs-common": "0.1.1",
+    "@backstage/plugin-techdocs-react": "1.3.13-next.0",
+    "@backstage/theme": "0.7.3",
+    "@backstage/ui": "0.17.0-next.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -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-next.0",
+    "@backstage/core-app-api": "1.20.3-next.0",
+    "@backstage/dev-utils": "1.1.25-next.0",
+    "@backstage/plugin-catalog": "2.0.7-next.0",
+    "@backstage/plugin-techdocs-module-addons-contrib": "1.1.38-next.0",
+    "@backstage/test-utils": "1.7.20-next.0",
     "@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[];
-    };
-  };
-}