@backstage/plugin-techdocs-react 1.2.14 → 1.2.15-next.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage/plugin-techdocs-react
 
+## 1.2.15-next.0
+
+### Patch Changes
+
+- b5a8208: Added `TechDocsAddonsBlueprint` extension to allow adding of techdocs addons.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.9.6-next.0
+
 ## 1.2.14
 
 ### Patch Changes

package/dist/addons.esm.js

@@ -68,5 +68,5 @@ const useTechDocsAddons = () => {
   return { renderComponentByName, renderComponentsByLocation };
 };
 
-export { TECHDOCS_ADDONS_KEY, TECHDOCS_ADDONS_WRAPPER_KEY, TechDocsAddons, createTechDocsAddonExtension, useTechDocsAddons };
+export { TECHDOCS_ADDONS_KEY, TECHDOCS_ADDONS_WRAPPER_KEY, TechDocsAddons, createTechDocsAddonExtension, getDataKeyByName, useTechDocsAddons };
 //# sourceMappingURL=addons.esm.js.map

package/dist/addons.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"addons.esm.js","sources":["../src/addons.tsx"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React, { useCallback } from 'react';\nimport { useOutlet } from 'react-router-dom';\n\nimport {\n  attachComponentData,\n  createReactExtension,\n  ElementCollection,\n  Extension,\n  useElementFilter,\n} from '@backstage/core-plugin-api';\n\nimport { TechDocsAddonLocations, TechDocsAddonOptions } from './types';\n\n/**\n * Key for each addon.\n * @public\n */\nexport const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1';\n\n/**\n * Marks the `<TechDocsAddons>` registry component.\n * @public\n */\nexport const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';\n\n/**\n * TechDocs Addon registry.\n * @public\n */\nexport const TechDocsAddons: React.ComponentType<\n  React.PropsWithChildren<{}>\n> = () => null;\n\nattachComponentData(TechDocsAddons, TECHDOCS_ADDONS_WRAPPER_KEY, true);\n\nconst getDataKeyByName = (name: string) => {\n  return `${TECHDOCS_ADDONS_KEY}.${name.toLocaleLowerCase('en-US')}`;\n};\n\n/**\n * Create a TechDocs addon overload signature without props.\n * @public\n */\nexport function createTechDocsAddonExtension(\n  options: TechDocsAddonOptions,\n): Extension<() => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon overload signature with props.\n * @public\n */\nexport function createTechDocsAddonExtension<TComponentProps>(\n  options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon implementation.\n * @public\n */\nexport function createTechDocsAddonExtension<\n  TComponentProps extends React.PropsWithChildren<{}>,\n>(\n  options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null> {\n  const { name, component: TechDocsAddon } = options;\n  return createReactExtension({\n    name,\n    component: {\n      sync: (props: TComponentProps) => <TechDocsAddon {...props} />,\n    },\n    data: {\n      [TECHDOCS_ADDONS_KEY]: options,\n      [getDataKeyByName(name)]: true,\n    },\n  });\n}\n\nconst getTechDocsAddonByName = (\n  collection: ElementCollection,\n  key: string,\n): JSX.Element | undefined => {\n  return collection.selectByComponentData({ key }).getElements()[0];\n};\n\nconst getAllTechDocsAddons = (collection: ElementCollection) => {\n  return collection\n    .selectByComponentData({\n      key: TECHDOCS_ADDONS_WRAPPER_KEY,\n    })\n    .selectByComponentData({\n      key: TECHDOCS_ADDONS_KEY,\n    });\n};\n\nconst getAllTechDocsAddonsData = (collection: ElementCollection) => {\n  return collection\n    .selectByComponentData({\n      key: TECHDOCS_ADDONS_WRAPPER_KEY,\n    })\n    .findComponentData<TechDocsAddonOptions>({\n      key: TECHDOCS_ADDONS_KEY,\n    });\n};\n\n/**\n * hook to use addons in components\n * @public\n */\nexport const useTechDocsAddons = () => {\n  const node = useOutlet();\n  const collection = useElementFilter(node, getAllTechDocsAddons);\n  const options = useElementFilter(node, getAllTechDocsAddonsData);\n\n  const findAddonByData = useCallback(\n    (data: TechDocsAddonOptions | undefined) => {\n      if (!collection || !data) return null;\n      const nameKey = getDataKeyByName(data.name);\n      return getTechDocsAddonByName(collection, nameKey) ?? null;\n    },\n    [collection],\n  );\n\n  const renderComponentByName = useCallback(\n    (name: string) => {\n      const data = options.find(option => option.name === name);\n      return data ? findAddonByData(data) : null;\n    },\n    [options, findAddonByData],\n  );\n\n  const renderComponentsByLocation = useCallback(\n    (location: keyof typeof TechDocsAddonLocations) => {\n      const data = options.filter(option => option.location === location);\n      return data.length ? data.map(findAddonByData) : null;\n    },\n    [options, findAddonByData],\n  );\n\n  return { renderComponentByName, renderComponentsByLocation };\n};\n"],"names":[],"mappings":";;;;AAiCO,MAAM,mBAAsB,GAAA;AAM5B,MAAM,2BAA8B,GAAA;AAMpC,MAAM,iBAET,MAAM;AAEV,mBAAoB,CAAA,cAAA,EAAgB,6BAA6B,IAAI,CAAA;AAErE,MAAM,gBAAA,GAAmB,CAAC,IAAiB,KAAA;AACzC,EAAA,OAAO,GAAG,mBAAmB,CAAA,CAAA,EAAI,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAC,CAAA,CAAA;AAClE,CAAA;AAsBO,SAAS,6BAGd,OAC2D,EAAA;AAC3D,EAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,aAAA,EAAkB,GAAA,OAAA;AAC3C,EAAA,OAAO,oBAAqB,CAAA;AAAA,IAC1B,IAAA;AAAA,IACA,SAAW,EAAA;AAAA,MACT,MAAM,CAAC,KAAA,qBAA4B,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA,EAAe,GAAG,KAAO,EAAA;AAAA,KAC9D;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,CAAC,mBAAmB,GAAG,OAAA;AAAA,MACvB,CAAC,gBAAA,CAAiB,IAAI,CAAC,GAAG;AAAA;AAC5B,GACD,CAAA;AACH;AAEA,MAAM,sBAAA,GAAyB,CAC7B,UAAA,EACA,GAC4B,KAAA;AAC5B,EAAO,OAAA,UAAA,CAAW,sBAAsB,EAAE,GAAA,EAAK,CAAE,CAAA,WAAA,GAAc,CAAC,CAAA;AAClE,CAAA;AAEA,MAAM,oBAAA,GAAuB,CAAC,UAAkC,KAAA;AAC9D,EAAA,OAAO,WACJ,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,EACA,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,CAAA;AACL,CAAA;AAEA,MAAM,wBAAA,GAA2B,CAAC,UAAkC,KAAA;AAClE,EAAA,OAAO,WACJ,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,EACA,iBAAwC,CAAA;AAAA,IACvC,GAAK,EAAA;AAAA,GACN,CAAA;AACL,CAAA;AAMO,MAAM,oBAAoB,MAAM;AACrC,EAAA,MAAM,OAAO,SAAU,EAAA;AACvB,EAAM,MAAA,UAAA,GAAa,gBAAiB,CAAA,IAAA,EAAM,oBAAoB,CAAA;AAC9D,EAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,IAAA,EAAM,wBAAwB,CAAA;AAE/D,EAAA,MAAM,eAAkB,GAAA,WAAA;AAAA,IACtB,CAAC,IAA2C,KAAA;AAC1C,MAAA,IAAI,CAAC,UAAA,IAAc,CAAC,IAAA,EAAa,OAAA,IAAA;AACjC,MAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,IAAA,CAAK,IAAI,CAAA;AAC1C,MAAO,OAAA,sBAAA,CAAuB,UAAY,EAAA,OAAO,CAAK,IAAA,IAAA;AAAA,KACxD;AAAA,IACA,CAAC,UAAU;AAAA,GACb;AAEA,EAAA,MAAM,qBAAwB,GAAA,WAAA;AAAA,IAC5B,CAAC,IAAiB,KAAA;AAChB,MAAA,MAAM,OAAO,OAAQ,CAAA,IAAA,CAAK,CAAU,MAAA,KAAA,MAAA,CAAO,SAAS,IAAI,CAAA;AACxD,MAAO,OAAA,IAAA,GAAO,eAAgB,CAAA,IAAI,CAAI,GAAA,IAAA;AAAA,KACxC;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAA,MAAM,0BAA6B,GAAA,WAAA;AAAA,IACjC,CAAC,QAAkD,KAAA;AACjD,MAAA,MAAM,OAAO,OAAQ,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA,MAAA,CAAO,aAAa,QAAQ,CAAA;AAClE,MAAA,OAAO,IAAK,CAAA,MAAA,GAAS,IAAK,CAAA,GAAA,CAAI,eAAe,CAAI,GAAA,IAAA;AAAA,KACnD;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAO,OAAA,EAAE,uBAAuB,0BAA2B,EAAA;AAC7D;;;;"}
+{"version":3,"file":"addons.esm.js","sources":["../src/addons.tsx"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React, { useCallback } from 'react';\nimport { useOutlet } from 'react-router-dom';\n\nimport {\n  attachComponentData,\n  createReactExtension,\n  ElementCollection,\n  Extension,\n  useElementFilter,\n} from '@backstage/core-plugin-api';\n\nimport { TechDocsAddonLocations, TechDocsAddonOptions } from './types';\n\n/**\n * Key for each addon.\n * @public\n */\nexport const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1';\n\n/**\n * Marks the `<TechDocsAddons>` registry component.\n * @public\n */\nexport const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';\n\n/**\n * TechDocs Addon registry.\n * @public\n */\nexport const TechDocsAddons: React.ComponentType<\n  React.PropsWithChildren<{}>\n> = () => null;\n\nattachComponentData(TechDocsAddons, TECHDOCS_ADDONS_WRAPPER_KEY, true);\n\nexport const getDataKeyByName = (name: string) => {\n  return `${TECHDOCS_ADDONS_KEY}.${name.toLocaleLowerCase('en-US')}`;\n};\n\n/**\n * Create a TechDocs addon overload signature without props.\n * @public\n */\nexport function createTechDocsAddonExtension(\n  options: TechDocsAddonOptions,\n): Extension<() => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon overload signature with props.\n * @public\n */\nexport function createTechDocsAddonExtension<TComponentProps>(\n  options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon implementation.\n * @public\n */\nexport function createTechDocsAddonExtension<\n  TComponentProps extends React.PropsWithChildren<{}>,\n>(\n  options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null> {\n  const { name, component: TechDocsAddon } = options;\n  return createReactExtension({\n    name,\n    component: {\n      sync: (props: TComponentProps) => <TechDocsAddon {...props} />,\n    },\n    data: {\n      [TECHDOCS_ADDONS_KEY]: options,\n      [getDataKeyByName(name)]: true,\n    },\n  });\n}\n\nconst getTechDocsAddonByName = (\n  collection: ElementCollection,\n  key: string,\n): JSX.Element | undefined => {\n  return collection.selectByComponentData({ key }).getElements()[0];\n};\n\nconst getAllTechDocsAddons = (collection: ElementCollection) => {\n  return collection\n    .selectByComponentData({\n      key: TECHDOCS_ADDONS_WRAPPER_KEY,\n    })\n    .selectByComponentData({\n      key: TECHDOCS_ADDONS_KEY,\n    });\n};\n\nconst getAllTechDocsAddonsData = (collection: ElementCollection) => {\n  return collection\n    .selectByComponentData({\n      key: TECHDOCS_ADDONS_WRAPPER_KEY,\n    })\n    .findComponentData<TechDocsAddonOptions>({\n      key: TECHDOCS_ADDONS_KEY,\n    });\n};\n\n/**\n * hook to use addons in components\n * @public\n */\nexport const useTechDocsAddons = () => {\n  const node = useOutlet();\n  const collection = useElementFilter(node, getAllTechDocsAddons);\n  const options = useElementFilter(node, getAllTechDocsAddonsData);\n\n  const findAddonByData = useCallback(\n    (data: TechDocsAddonOptions | undefined) => {\n      if (!collection || !data) return null;\n      const nameKey = getDataKeyByName(data.name);\n      return getTechDocsAddonByName(collection, nameKey) ?? null;\n    },\n    [collection],\n  );\n\n  const renderComponentByName = useCallback(\n    (name: string) => {\n      const data = options.find(option => option.name === name);\n      return data ? findAddonByData(data) : null;\n    },\n    [options, findAddonByData],\n  );\n\n  const renderComponentsByLocation = useCallback(\n    (location: keyof typeof TechDocsAddonLocations) => {\n      const data = options.filter(option => option.location === location);\n      return data.length ? data.map(findAddonByData) : null;\n    },\n    [options, findAddonByData],\n  );\n\n  return { renderComponentByName, renderComponentsByLocation };\n};\n"],"names":[],"mappings":";;;;AAiCO,MAAM,mBAAsB,GAAA;AAM5B,MAAM,2BAA8B,GAAA;AAMpC,MAAM,iBAET,MAAM;AAEV,mBAAoB,CAAA,cAAA,EAAgB,6BAA6B,IAAI,CAAA;AAExD,MAAA,gBAAA,GAAmB,CAAC,IAAiB,KAAA;AAChD,EAAA,OAAO,GAAG,mBAAmB,CAAA,CAAA,EAAI,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAC,CAAA,CAAA;AAClE;AAsBO,SAAS,6BAGd,OAC2D,EAAA;AAC3D,EAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,aAAA,EAAkB,GAAA,OAAA;AAC3C,EAAA,OAAO,oBAAqB,CAAA;AAAA,IAC1B,IAAA;AAAA,IACA,SAAW,EAAA;AAAA,MACT,MAAM,CAAC,KAAA,qBAA4B,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA,EAAe,GAAG,KAAO,EAAA;AAAA,KAC9D;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,CAAC,mBAAmB,GAAG,OAAA;AAAA,MACvB,CAAC,gBAAA,CAAiB,IAAI,CAAC,GAAG;AAAA;AAC5B,GACD,CAAA;AACH;AAEA,MAAM,sBAAA,GAAyB,CAC7B,UAAA,EACA,GAC4B,KAAA;AAC5B,EAAO,OAAA,UAAA,CAAW,sBAAsB,EAAE,GAAA,EAAK,CAAE,CAAA,WAAA,GAAc,CAAC,CAAA;AAClE,CAAA;AAEA,MAAM,oBAAA,GAAuB,CAAC,UAAkC,KAAA;AAC9D,EAAA,OAAO,WACJ,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,EACA,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,CAAA;AACL,CAAA;AAEA,MAAM,wBAAA,GAA2B,CAAC,UAAkC,KAAA;AAClE,EAAA,OAAO,WACJ,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,EACA,iBAAwC,CAAA;AAAA,IACvC,GAAK,EAAA;AAAA,GACN,CAAA;AACL,CAAA;AAMO,MAAM,oBAAoB,MAAM;AACrC,EAAA,MAAM,OAAO,SAAU,EAAA;AACvB,EAAM,MAAA,UAAA,GAAa,gBAAiB,CAAA,IAAA,EAAM,oBAAoB,CAAA;AAC9D,EAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,IAAA,EAAM,wBAAwB,CAAA;AAE/D,EAAA,MAAM,eAAkB,GAAA,WAAA;AAAA,IACtB,CAAC,IAA2C,KAAA;AAC1C,MAAA,IAAI,CAAC,UAAA,IAAc,CAAC,IAAA,EAAa,OAAA,IAAA;AACjC,MAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,IAAA,CAAK,IAAI,CAAA;AAC1C,MAAO,OAAA,sBAAA,CAAuB,UAAY,EAAA,OAAO,CAAK,IAAA,IAAA;AAAA,KACxD;AAAA,IACA,CAAC,UAAU;AAAA,GACb;AAEA,EAAA,MAAM,qBAAwB,GAAA,WAAA;AAAA,IAC5B,CAAC,IAAiB,KAAA;AAChB,MAAA,MAAM,OAAO,OAAQ,CAAA,IAAA,CAAK,CAAU,MAAA,KAAA,MAAA,CAAO,SAAS,IAAI,CAAA;AACxD,MAAO,OAAA,IAAA,GAAO,eAAgB,CAAA,IAAI,CAAI,GAAA,IAAA;AAAA,KACxC;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAA,MAAM,0BAA6B,GAAA,WAAA;AAAA,IACjC,CAAC,QAAkD,KAAA;AACjD,MAAA,MAAM,OAAO,OAAQ,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA,MAAA,CAAO,aAAa,QAAQ,CAAA;AAClE,MAAA,OAAO,IAAK,CAAA,MAAA,GAAS,IAAK,CAAA,GAAA,CAAI,eAAe,CAAI,GAAA,IAAA;AAAA,KACnD;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAO,OAAA,EAAE,uBAAuB,0BAA2B,EAAA;AAC7D;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,28 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import { T as TechDocsAddonOptions } from './types/types.d-BooYUMWM.js';
+export { a as TechDocsAddonLocations } from './types/types.d-BooYUMWM.js';
+import { ComponentType } from 'react';
+import '@backstage/catalog-model';
+
+/** @alpha */
+declare const techDocsAddonDataRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<TechDocsAddonOptions, "techdocs.addon", {}>;
+/**
+ * Creates an extension to add addons to the TechDocs standalone reader and entity pages.
+ * @alpha
+ */
+declare const AddonBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
+    kind: "addon";
+    name: undefined;
+    params: TechDocsAddonOptions;
+    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<TechDocsAddonOptions, "techdocs.addon", {}>;
+    inputs: {};
+    config: {};
+    configInput: {};
+    dataRefs: {
+        addon: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<TechDocsAddonOptions, "techdocs.addon", {}>;
+    };
+}>;
+/** @alpha */
+declare const attachTechDocsAddonComponentData: <P>(techDocsAddon: ComponentType<P>, data: TechDocsAddonOptions) => void;
+
+export { AddonBlueprint, TechDocsAddonOptions, attachTechDocsAddonComponentData, techDocsAddonDataRef };

package/dist/alpha.esm.js

@@ -0,0 +1,26 @@
+import { attachComponentData } from '@backstage/core-plugin-api';
+import { TECHDOCS_ADDONS_KEY, getDataKeyByName } from './addons.esm.js';
+import { createExtensionDataRef, createExtensionBlueprint } from '@backstage/frontend-plugin-api';
+
+const techDocsAddonDataRef = createExtensionDataRef().with({
+  id: "techdocs.addon"
+});
+const AddonBlueprint = createExtensionBlueprint({
+  kind: "addon",
+  attachTo: [
+    { id: "page:techdocs/reader", input: "addons" },
+    { id: "entity-content:techdocs", input: "addons" }
+  ],
+  output: [techDocsAddonDataRef],
+  factory: (params) => [techDocsAddonDataRef(params)],
+  dataRefs: {
+    addon: techDocsAddonDataRef
+  }
+});
+const attachTechDocsAddonComponentData = (techDocsAddon, data) => {
+  attachComponentData(techDocsAddon, TECHDOCS_ADDONS_KEY, data);
+  attachComponentData(techDocsAddon, getDataKeyByName(data.name), true);
+};
+
+export { AddonBlueprint, attachTechDocsAddonComponentData, techDocsAddonDataRef };
+//# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2025 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 */\nimport { TechDocsAddonOptions } from './types';\nimport { attachComponentData } from '@backstage/core-plugin-api';\nimport { ComponentType } from 'react';\nimport { getDataKeyByName, TECHDOCS_ADDONS_KEY } from './addons';\nimport {\n  createExtensionBlueprint,\n  createExtensionDataRef,\n} from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nexport type { TechDocsAddonOptions, TechDocsAddonLocations } from './types';\n\n/** @alpha */\nexport const techDocsAddonDataRef =\n  createExtensionDataRef<TechDocsAddonOptions>().with({\n    id: 'techdocs.addon',\n  });\n\n/**\n * Creates an extension to add addons to the TechDocs standalone reader and entity pages.\n * @alpha\n */\nexport const AddonBlueprint = createExtensionBlueprint({\n  kind: 'addon',\n  attachTo: [\n    { id: 'page:techdocs/reader', input: 'addons' },\n    { id: 'entity-content:techdocs', input: 'addons' },\n  ],\n  output: [techDocsAddonDataRef],\n  factory: (params: TechDocsAddonOptions) => [techDocsAddonDataRef(params)],\n  dataRefs: {\n    addon: techDocsAddonDataRef,\n  },\n});\n\n/** @alpha */\nexport const attachTechDocsAddonComponentData = <P>(\n  techDocsAddon: ComponentType<P>,\n  data: TechDocsAddonOptions,\n) => {\n  attachComponentData(techDocsAddon, TECHDOCS_ADDONS_KEY, data);\n  attachComponentData(techDocsAddon, getDataKeyByName(data.name), true);\n};\n"],"names":[],"mappings":";;;;AA4Ba,MAAA,oBAAA,GACX,sBAA6C,EAAA,CAAE,IAAK,CAAA;AAAA,EAClD,EAAI,EAAA;AACN,CAAC;AAMI,MAAM,iBAAiB,wBAAyB,CAAA;AAAA,EACrD,IAAM,EAAA,OAAA;AAAA,EACN,QAAU,EAAA;AAAA,IACR,EAAE,EAAA,EAAI,sBAAwB,EAAA,KAAA,EAAO,QAAS,EAAA;AAAA,IAC9C,EAAE,EAAA,EAAI,yBAA2B,EAAA,KAAA,EAAO,QAAS;AAAA,GACnD;AAAA,EACA,MAAA,EAAQ,CAAC,oBAAoB,CAAA;AAAA,EAC7B,SAAS,CAAC,MAAA,KAAiC,CAAC,oBAAA,CAAqB,MAAM,CAAC,CAAA;AAAA,EACxE,QAAU,EAAA;AAAA,IACR,KAAO,EAAA;AAAA;AAEX,CAAC;AAGY,MAAA,gCAAA,GAAmC,CAC9C,aAAA,EACA,IACG,KAAA;AACH,EAAoB,mBAAA,CAAA,aAAA,EAAe,qBAAqB,IAAI,CAAA;AAC5D,EAAA,mBAAA,CAAoB,aAAe,EAAA,gBAAA,CAAiB,IAAK,CAAA,IAAI,GAAG,IAAI,CAAA;AACtE;;;;"}

package/dist/index.d.ts

@@ -1,74 +1,11 @@
-import React, { ComponentType, Dispatch, SetStateAction, ReactNode, PropsWithChildren } from 'react';
+import React, { Dispatch, SetStateAction, ReactNode, PropsWithChildren } from 'react';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { Extension } from '@backstage/core-plugin-api';
-import { Entity, CompoundEntityRef } from '@backstage/catalog-model';
+import { T as TechDocsAddonOptions, a as TechDocsAddonLocations, b as TechDocsMetadata, c as TechDocsEntityMetadata } from './types/types.d-BooYUMWM.js';
+import { CompoundEntityRef } from '@backstage/catalog-model';
 import { AsyncState } from 'react-use/esm/useAsync';
 import { Config } from '@backstage/config';
 
-/**
- * Metadata for TechDocs page
- *
- * @public
- */
-type TechDocsMetadata = {
-    site_name: string;
-    site_description: string;
-};
-/**
- * Metadata for TechDocs Entity
- *
- * @public
- */
-type TechDocsEntityMetadata = Entity & {
-    locationMetadata?: {
-        type: string;
-        target: string;
-    };
-};
-/**
- * Locations for which TechDocs addons may be declared and rendered.
- * @public
- */
-declare const TechDocsAddonLocations: Readonly<{
-    /**
-     * These addons fill up the header from the right, on the same line as the
-     * title.
-     */
-    readonly Header: "Header";
-    /**
-     * These addons appear below the header and above all content; tooling addons
-     * can be inserted for convenience.
-     */
-    readonly Subheader: "Subheader";
-    /**
-     * These addons are items added to the settings menu list and are designed to make
-     * the reader experience customizable, for example accessibility options
-     */
-    readonly Settings: "Settings";
-    /**
-     * These addons appear left of the content and above the navigation.
-     */
-    readonly PrimarySidebar: "PrimarySidebar";
-    /**
-     * These addons appear right of the content and above the table of contents.
-     */
-    readonly SecondarySidebar: "SecondarySidebar";
-    /**
-     * A virtual location which allows mutation of all content within the shadow
-     * root by transforming DOM nodes. These addons should return null on render.
-     */
-    readonly Content: "Content";
-}>;
-/**
- * Options for creating a TechDocs addon.
- * @public
- */
-type TechDocsAddonOptions<TAddonProps = {}> = {
-    name: string;
-    location: keyof typeof TechDocsAddonLocations;
-    component: ComponentType<TAddonProps>;
-};
-
 /**
  * Key for each addon.
  * @public
@@ -330,4 +267,4 @@ declare const useShadowRootSelection: (waitMillis?: number) => Selection | null;
  */
 declare function toLowercaseEntityRefMaybe(entityRef: CompoundEntityRef, config: Config): CompoundEntityRef;
 
-export { SHADOW_DOM_STYLE_LOAD_EVENT, type SyncResult, TECHDOCS_ADDONS_KEY, TECHDOCS_ADDONS_WRAPPER_KEY, TechDocsAddonLocations, type TechDocsAddonOptions, TechDocsAddons, type TechDocsApi, type TechDocsEntityMetadata, type TechDocsMetadata, TechDocsReaderPageProvider, type TechDocsReaderPageProviderProps, type TechDocsReaderPageProviderRenderFunction, type TechDocsReaderPageValue, TechDocsShadowDom, type TechDocsShadowDomProps, type TechDocsStorageApi, createTechDocsAddonExtension, techdocsApiRef, techdocsStorageApiRef, toLowercaseEntityRefMaybe, useShadowDomStylesLoading, useShadowRoot, useShadowRootElements, useShadowRootSelection, useTechDocsAddons, useTechDocsReaderPage };
+export { SHADOW_DOM_STYLE_LOAD_EVENT, type SyncResult, TECHDOCS_ADDONS_KEY, TECHDOCS_ADDONS_WRAPPER_KEY, TechDocsAddonLocations, TechDocsAddonOptions, TechDocsAddons, type TechDocsApi, TechDocsEntityMetadata, TechDocsMetadata, TechDocsReaderPageProvider, type TechDocsReaderPageProviderProps, type TechDocsReaderPageProviderRenderFunction, type TechDocsReaderPageValue, TechDocsShadowDom, type TechDocsShadowDomProps, type TechDocsStorageApi, createTechDocsAddonExtension, techdocsApiRef, techdocsStorageApiRef, toLowercaseEntityRefMaybe, useShadowDomStylesLoading, useShadowRoot, useShadowRootElements, useShadowRootSelection, useTechDocsAddons, useTechDocsReaderPage };

package/dist/types/types.d-BooYUMWM.d.ts

@@ -0,0 +1,68 @@
+import { ComponentType } from 'react';
+import { Entity } from '@backstage/catalog-model';
+
+/**
+ * Metadata for TechDocs page
+ *
+ * @public
+ */
+type TechDocsMetadata = {
+    site_name: string;
+    site_description: string;
+};
+/**
+ * Metadata for TechDocs Entity
+ *
+ * @public
+ */
+type TechDocsEntityMetadata = Entity & {
+    locationMetadata?: {
+        type: string;
+        target: string;
+    };
+};
+/**
+ * Locations for which TechDocs addons may be declared and rendered.
+ * @public
+ */
+declare const TechDocsAddonLocations: Readonly<{
+    /**
+     * These addons fill up the header from the right, on the same line as the
+     * title.
+     */
+    readonly Header: "Header";
+    /**
+     * These addons appear below the header and above all content; tooling addons
+     * can be inserted for convenience.
+     */
+    readonly Subheader: "Subheader";
+    /**
+     * These addons are items added to the settings menu list and are designed to make
+     * the reader experience customizable, for example accessibility options
+     */
+    readonly Settings: "Settings";
+    /**
+     * These addons appear left of the content and above the navigation.
+     */
+    readonly PrimarySidebar: "PrimarySidebar";
+    /**
+     * These addons appear right of the content and above the table of contents.
+     */
+    readonly SecondarySidebar: "SecondarySidebar";
+    /**
+     * A virtual location which allows mutation of all content within the shadow
+     * root by transforming DOM nodes. These addons should return null on render.
+     */
+    readonly Content: "Content";
+}>;
+/**
+ * Options for creating a TechDocs addon.
+ * @public
+ */
+type TechDocsAddonOptions<TAddonProps = {}> = {
+    name: string;
+    location: keyof typeof TechDocsAddonLocations;
+    component: ComponentType<TAddonProps>;
+};
+
+export { type TechDocsAddonOptions as T, TechDocsAddonLocations as a, type TechDocsMetadata as b, type TechDocsEntityMetadata as c };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs-react",
-  "version": "1.2.14",
+  "version": "1.2.15-next.0",
   "description": "Shared frontend utilities for TechDocs and Addons",
   "backstage": {
     "role": "web-library",
@@ -14,9 +14,7 @@
     ]
   },
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
   },
   "keywords": [
     "backstage",
@@ -30,8 +28,31 @@
   },
   "license": "Apache-2.0",
   "sideEffects": false,
-  "main": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.esm.js"
+    },
+    "./alpha": {
+      "import": "./dist/alpha.esm.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ],
+      "alpha": [
+        "dist/alpha.d.ts"
+      ]
+    }
+  },
   "files": [
     "dist"
   ],
@@ -45,11 +66,12 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.7.3",
-    "@backstage/config": "^1.3.2",
-    "@backstage/core-components": "^0.16.4",
-    "@backstage/core-plugin-api": "^1.10.4",
-    "@backstage/version-bridge": "^1.0.11",
+    "@backstage/catalog-model": "1.7.3",
+    "@backstage/config": "1.3.2",
+    "@backstage/core-components": "0.16.4",
+    "@backstage/core-plugin-api": "1.10.4",
+    "@backstage/frontend-plugin-api": "0.9.6-next.0",
+    "@backstage/version-bridge": "1.0.11",
     "@material-ui/core": "^4.12.2",
     "@material-ui/styles": "^4.11.0",
     "jss": "~10.10.0",
@@ -58,9 +80,9 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.30.0",
-    "@backstage/test-utils": "^1.7.5",
-    "@backstage/theme": "^0.6.4",
+    "@backstage/cli": "0.30.0",
+    "@backstage/test-utils": "1.7.5",
+    "@backstage/theme": "0.6.4",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",
@@ -79,12 +101,5 @@
       "optional": true
     }
   },
-  "typesVersions": {
-    "*": {
-      "index": [
-        "dist/index.d.ts"
-      ]
-    }
-  },
   "module": "./dist/index.esm.js"
 }