@backstage/plugin-techdocs-react 0.0.0-nightly-20220413023505

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# @backstage/plugin-techdocs-react
+
+## 0.0.0-nightly-20220413023505
+
+### Minor Changes
+
+- ff1cc8bced: This package will house frontend utilities related to TechDocs to be shared across other frontend Backstage packages.
+
+  In this release, it introduces a framework that can be used create TechDocs addons.
+
+  Note: this package is not necessarily stable yet. After iteration on this package, its stability will be signaled by a major-version bump.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@0.0.0-nightly-20220413023505
+  - @backstage/core-components@0.0.0-nightly-20220413023505
+  - @backstage/core-plugin-api@0.0.0-nightly-20220413023505
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- ff1cc8bced: This package will house frontend utilities related to TechDocs to be shared across other frontend Backstage packages.
+
+  In this release, it introduces a framework that can be used create TechDocs addons.
+
+  Note: this package is not necessarily stable yet. After iteration on this package, its stability will be signaled by a major-version bump.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.9.3-next.2
+  - @backstage/core-plugin-api@1.0.1-next.0

package/README.md

@@ -0,0 +1,9 @@
+# @backstage/plugin-techdocs-react
+
+This package provides frontend utilities for TechDocs and Addons.
+
+## Installation
+
+```sh
+yarn add --cwd packages/app @backstage/plugin-techdocs-react
+```

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-techdocs-react",
+  "version": "0.0.0-nightly-20220413023505",
+  "main": "../dist/index.esm.js",
+  "types": "../dist/index.alpha.d.ts"
+}

package/dist/index.alpha.d.ts

@@ -0,0 +1,199 @@
+/**
+ * Package encapsulating utilities to be shared by frontend TechDocs plugins.
+ *
+ * @packageDocumentation
+ */
+
+import { ApiRef } from '@backstage/core-plugin-api';
+import { AsyncState } from 'react-use/lib/useAsync';
+import { ComponentType } from 'react';
+import { CompoundEntityRef } from '@backstage/catalog-model';
+import { Dispatch } from 'react';
+import { Entity } from '@backstage/catalog-model';
+import { Extension } from '@backstage/core-plugin-api';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+import { SetStateAction } from 'react';
+
+/**
+ * Create a TechDocs addon.
+ * @alpha
+ */
+export declare function createTechDocsAddonExtension<TComponentProps>(options: TechDocsAddonOptions<TComponentProps>): Extension<ComponentType<TComponentProps>>;
+
+/**
+ * @alpha
+ */
+export declare const defaultTechDocsReaderPageValue: TechDocsReaderPageValue;
+
+/**
+ * Marks the <TechDocsAddons> registry component.
+ * @alpha
+ */
+export declare const TECHDOCS_ADDONS_WRAPPER_KEY = "techdocs.addons.wrapper.v1";
+
+/**
+ * Locations for which TechDocs addons may be declared and rendered.
+ * @alpha
+ */
+export 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 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.
+ * @alpha
+ */
+export declare type TechDocsAddonOptions<TAddonProps = {}> = {
+    name: string;
+    location: keyof typeof TechDocsAddonLocations;
+    component: ComponentType<TAddonProps>;
+};
+
+/**
+ * TechDocs Addon registry.
+ * @alpha
+ */
+export declare const TechDocsAddons: React_2.ComponentType;
+
+/**
+ * API to talk to techdocs-backend.
+ *
+ * @public
+ */
+export declare interface TechDocsApi {
+    getApiOrigin(): Promise<string>;
+    getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>;
+    getEntityMetadata(entityId: CompoundEntityRef): Promise<TechDocsEntityMetadata>;
+}
+
+/**
+ * Utility API reference for the {@link TechDocsApi}.
+ *
+ * @public
+ */
+export declare const techdocsApiRef: ApiRef<TechDocsApi>;
+
+/**
+ * Metadata for TechDocs Entity
+ *
+ * @public
+ */
+export declare type TechDocsEntityMetadata = Entity & {
+    locationMetadata?: {
+        type: string;
+        target: string;
+    };
+};
+
+/**
+ * Metadata for TechDocs page
+ *
+ * @public
+ */
+export declare type TechDocsMetadata = {
+    site_name: string;
+    site_description: string;
+};
+
+/**
+ * A context to store the reader page state
+ * @public
+ */
+export declare const TechDocsReaderPageProvider: React_2.MemoExoticComponent<({ entityRef, children }: TechDocsReaderPageProviderProps) => JSX.Element>;
+
+/**
+ * Props for {@link TechDocsReaderPageProvider}
+ *
+ * @public
+ */
+export declare type TechDocsReaderPageProviderProps = {
+    entityRef: CompoundEntityRef;
+    children: TechDocsReaderPageProviderRenderFunction | ReactNode;
+};
+
+/**
+ * render function for {@link TechDocsReaderPageProvider}
+ *
+ * @public
+ */
+export declare type TechDocsReaderPageProviderRenderFunction = (value: TechDocsReaderPageValue) => JSX.Element;
+
+/**
+ * @public type for the value of the TechDocsReaderPageContext
+ */
+export declare type TechDocsReaderPageValue = {
+    metadata: AsyncState<TechDocsMetadata>;
+    entityRef: CompoundEntityRef;
+    entityMetadata: AsyncState<TechDocsEntityMetadata>;
+    shadowRoot?: ShadowRoot;
+    setShadowRoot: Dispatch<SetStateAction<ShadowRoot | undefined>>;
+    title: string;
+    setTitle: Dispatch<SetStateAction<string>>;
+    subtitle: string;
+    setSubtitle: Dispatch<SetStateAction<string>>;
+    /**
+     * @deprecated property can be passed down directly to the `TechDocsReaderPageContent` instead.
+     */
+    onReady?: () => void;
+};
+
+/**
+ * Hook for use within TechDocs addons that provides access to the underlying
+ * shadow root of the current page, allowing the DOM within to be mutated.
+ * @alpha
+ */
+export declare const useShadowRoot: () => ShadowRoot | undefined;
+
+/**
+ * Convenience hook for use within TechDocs addons that provides access to
+ * elements that match a given selector within the shadow root.
+ *
+ * @alpha
+ */
+export declare const useShadowRootElements: <TReturnedElement extends HTMLElement = HTMLElement>(selectors: string[]) => TReturnedElement[];
+
+/**
+ * Hook for retreiving a selection within the ShadowRoot.
+ * @alpha
+ */
+export declare const useShadowRootSelection: (wait?: number) => Selection | null;
+
+/**
+ * hook to use addons in components
+ * @alpha
+ */
+export declare const useTechDocsAddons: () => {
+    renderComponentByName: (name: string) => JSX.Element | null;
+    renderComponentsByLocation: (location: keyof typeof TechDocsAddonLocations) => (JSX.Element | null)[] | null;
+};
+
+/**
+ * Hook used to get access to shared state between reader page components.
+ * @alpha
+ */
+export declare const useTechDocsReaderPage: () => TechDocsReaderPageValue;
+
+export { }

package/dist/index.beta.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Package encapsulating utilities to be shared by frontend TechDocs plugins.
+ *
+ * @packageDocumentation
+ */
+
+import { ApiRef } from '@backstage/core-plugin-api';
+import { AsyncState } from 'react-use/lib/useAsync';
+import { ComponentType } from 'react';
+import { CompoundEntityRef } from '@backstage/catalog-model';
+import { Dispatch } from 'react';
+import { Entity } from '@backstage/catalog-model';
+import { Extension } from '@backstage/core-plugin-api';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+import { SetStateAction } from 'react';
+
+/* Excluded from this release type: createTechDocsAddonExtension */
+
+/* Excluded from this release type: defaultTechDocsReaderPageValue */
+
+/* Excluded from this release type: TECHDOCS_ADDONS_WRAPPER_KEY */
+
+/* Excluded from this release type: TechDocsAddonLocations */
+
+/* Excluded from this release type: TechDocsAddonOptions */
+
+/* Excluded from this release type: TechDocsAddons */
+
+/**
+ * API to talk to techdocs-backend.
+ *
+ * @public
+ */
+export declare interface TechDocsApi {
+    getApiOrigin(): Promise<string>;
+    getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>;
+    getEntityMetadata(entityId: CompoundEntityRef): Promise<TechDocsEntityMetadata>;
+}
+
+/**
+ * Utility API reference for the {@link TechDocsApi}.
+ *
+ * @public
+ */
+export declare const techdocsApiRef: ApiRef<TechDocsApi>;
+
+/**
+ * Metadata for TechDocs Entity
+ *
+ * @public
+ */
+export declare type TechDocsEntityMetadata = Entity & {
+    locationMetadata?: {
+        type: string;
+        target: string;
+    };
+};
+
+/**
+ * Metadata for TechDocs page
+ *
+ * @public
+ */
+export declare type TechDocsMetadata = {
+    site_name: string;
+    site_description: string;
+};
+
+/**
+ * A context to store the reader page state
+ * @public
+ */
+export declare const TechDocsReaderPageProvider: React_2.MemoExoticComponent<({ entityRef, children }: TechDocsReaderPageProviderProps) => JSX.Element>;
+
+/**
+ * Props for {@link TechDocsReaderPageProvider}
+ *
+ * @public
+ */
+export declare type TechDocsReaderPageProviderProps = {
+    entityRef: CompoundEntityRef;
+    children: TechDocsReaderPageProviderRenderFunction | ReactNode;
+};
+
+/**
+ * render function for {@link TechDocsReaderPageProvider}
+ *
+ * @public
+ */
+export declare type TechDocsReaderPageProviderRenderFunction = (value: TechDocsReaderPageValue) => JSX.Element;
+
+/**
+ * @public type for the value of the TechDocsReaderPageContext
+ */
+export declare type TechDocsReaderPageValue = {
+    metadata: AsyncState<TechDocsMetadata>;
+    entityRef: CompoundEntityRef;
+    entityMetadata: AsyncState<TechDocsEntityMetadata>;
+    shadowRoot?: ShadowRoot;
+    setShadowRoot: Dispatch<SetStateAction<ShadowRoot | undefined>>;
+    title: string;
+    setTitle: Dispatch<SetStateAction<string>>;
+    subtitle: string;
+    setSubtitle: Dispatch<SetStateAction<string>>;
+    /**
+     * @deprecated property can be passed down directly to the `TechDocsReaderPageContent` instead.
+     */
+    onReady?: () => void;
+};
+
+/* Excluded from this release type: useShadowRoot */
+
+/* Excluded from this release type: useShadowRootElements */
+
+/* Excluded from this release type: useShadowRootSelection */
+
+/* Excluded from this release type: useTechDocsAddons */
+
+/* Excluded from this release type: useTechDocsReaderPage */
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Package encapsulating utilities to be shared by frontend TechDocs plugins.
+ *
+ * @packageDocumentation
+ */
+
+import { ApiRef } from '@backstage/core-plugin-api';
+import { AsyncState } from 'react-use/lib/useAsync';
+import { ComponentType } from 'react';
+import { CompoundEntityRef } from '@backstage/catalog-model';
+import { Dispatch } from 'react';
+import { Entity } from '@backstage/catalog-model';
+import { Extension } from '@backstage/core-plugin-api';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+import { SetStateAction } from 'react';
+
+/* Excluded from this release type: createTechDocsAddonExtension */
+
+/* Excluded from this release type: defaultTechDocsReaderPageValue */
+
+/* Excluded from this release type: TECHDOCS_ADDONS_WRAPPER_KEY */
+
+/* Excluded from this release type: TechDocsAddonLocations */
+
+/* Excluded from this release type: TechDocsAddonOptions */
+
+/* Excluded from this release type: TechDocsAddons */
+
+/**
+ * API to talk to techdocs-backend.
+ *
+ * @public
+ */
+export declare interface TechDocsApi {
+    getApiOrigin(): Promise<string>;
+    getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>;
+    getEntityMetadata(entityId: CompoundEntityRef): Promise<TechDocsEntityMetadata>;
+}
+
+/**
+ * Utility API reference for the {@link TechDocsApi}.
+ *
+ * @public
+ */
+export declare const techdocsApiRef: ApiRef<TechDocsApi>;
+
+/**
+ * Metadata for TechDocs Entity
+ *
+ * @public
+ */
+export declare type TechDocsEntityMetadata = Entity & {
+    locationMetadata?: {
+        type: string;
+        target: string;
+    };
+};
+
+/**
+ * Metadata for TechDocs page
+ *
+ * @public
+ */
+export declare type TechDocsMetadata = {
+    site_name: string;
+    site_description: string;
+};
+
+/**
+ * A context to store the reader page state
+ * @public
+ */
+export declare const TechDocsReaderPageProvider: React_2.MemoExoticComponent<({ entityRef, children }: TechDocsReaderPageProviderProps) => JSX.Element>;
+
+/**
+ * Props for {@link TechDocsReaderPageProvider}
+ *
+ * @public
+ */
+export declare type TechDocsReaderPageProviderProps = {
+    entityRef: CompoundEntityRef;
+    children: TechDocsReaderPageProviderRenderFunction | ReactNode;
+};
+
+/**
+ * render function for {@link TechDocsReaderPageProvider}
+ *
+ * @public
+ */
+export declare type TechDocsReaderPageProviderRenderFunction = (value: TechDocsReaderPageValue) => JSX.Element;
+
+/**
+ * @public type for the value of the TechDocsReaderPageContext
+ */
+export declare type TechDocsReaderPageValue = {
+    metadata: AsyncState<TechDocsMetadata>;
+    entityRef: CompoundEntityRef;
+    entityMetadata: AsyncState<TechDocsEntityMetadata>;
+    shadowRoot?: ShadowRoot;
+    setShadowRoot: Dispatch<SetStateAction<ShadowRoot | undefined>>;
+    title: string;
+    setTitle: Dispatch<SetStateAction<string>>;
+    subtitle: string;
+    setSubtitle: Dispatch<SetStateAction<string>>;
+    /**
+     * @deprecated property can be passed down directly to the `TechDocsReaderPageContent` instead.
+     */
+    onReady?: () => void;
+};
+
+/* Excluded from this release type: useShadowRoot */
+
+/* Excluded from this release type: useShadowRootElements */
+
+/* Excluded from this release type: useShadowRootSelection */
+
+/* Excluded from this release type: useTechDocsAddons */
+
+/* Excluded from this release type: useTechDocsReaderPage */
+
+export { }

package/dist/index.esm.js

@@ -0,0 +1,173 @@
+import React, { useCallback, memo, useState, useContext, useMemo, useEffect } from 'react';
+import { useOutlet } from 'react-router-dom';
+import { attachComponentData, createReactExtension, useElementFilter, createApiRef, useApi } from '@backstage/core-plugin-api';
+import useAsync from 'react-use/lib/useAsync';
+import { stringifyEntityRef } from '@backstage/catalog-model';
+import { createVersionedContext, createVersionedValueMap } from '@backstage/version-bridge';
+import debounce from 'lodash/debounce';
+
+const TECHDOCS_ADDONS_KEY = "techdocs.addons.addon.v1";
+const TECHDOCS_ADDONS_WRAPPER_KEY = "techdocs.addons.wrapper.v1";
+const TechDocsAddons = () => null;
+attachComponentData(TechDocsAddons, TECHDOCS_ADDONS_WRAPPER_KEY, true);
+const getDataKeyByName = (name) => {
+  return `${TECHDOCS_ADDONS_KEY}.${name.toLocaleLowerCase("en-US")}`;
+};
+function createTechDocsAddonExtension(options) {
+  const { name, component: TechDocsAddon } = options;
+  return createReactExtension({
+    name,
+    component: {
+      sync: (props) => /* @__PURE__ */ React.createElement(TechDocsAddon, {
+        ...props
+      })
+    },
+    data: {
+      [TECHDOCS_ADDONS_KEY]: options,
+      [getDataKeyByName(name)]: true
+    }
+  });
+}
+const getTechDocsAddonByName = (collection, key) => {
+  return collection.selectByComponentData({ key }).getElements()[0];
+};
+const getAllTechDocsAddons = (collection) => {
+  return collection.selectByComponentData({
+    key: TECHDOCS_ADDONS_WRAPPER_KEY
+  }).selectByComponentData({
+    key: TECHDOCS_ADDONS_KEY
+  });
+};
+const getAllTechDocsAddonsData = (collection) => {
+  return collection.selectByComponentData({
+    key: TECHDOCS_ADDONS_WRAPPER_KEY
+  }).findComponentData({
+    key: TECHDOCS_ADDONS_KEY
+  });
+};
+const useTechDocsAddons = () => {
+  const node = useOutlet();
+  const collection = useElementFilter(node, getAllTechDocsAddons);
+  const options = useElementFilter(node, getAllTechDocsAddonsData);
+  const findAddonByData = useCallback((data) => {
+    var _a;
+    if (!collection || !data)
+      return null;
+    const nameKey = getDataKeyByName(data.name);
+    return (_a = getTechDocsAddonByName(collection, nameKey)) != null ? _a : null;
+  }, [collection]);
+  const renderComponentByName = useCallback((name) => {
+    const data = options.find((option) => option.name === name);
+    return data ? findAddonByData(data) : null;
+  }, [options, findAddonByData]);
+  const renderComponentsByLocation = useCallback((location) => {
+    const data = options.filter((option) => option.location === location);
+    return data.length ? data.map(findAddonByData) : null;
+  }, [options, findAddonByData]);
+  return { renderComponentByName, renderComponentsByLocation };
+};
+
+const techdocsApiRef = createApiRef({
+  id: "plugin.techdocs.service"
+});
+
+const areEntityRefsEqual = (prevEntityRef, nextEntityRef) => {
+  return stringifyEntityRef(prevEntityRef) === stringifyEntityRef(nextEntityRef);
+};
+const defaultTechDocsReaderPageValue = {
+  title: "",
+  subtitle: "",
+  setTitle: () => {
+  },
+  setSubtitle: () => {
+  },
+  setShadowRoot: () => {
+  },
+  metadata: { loading: true },
+  entityMetadata: { loading: true },
+  entityRef: { kind: "", name: "", namespace: "" }
+};
+const TechDocsReaderPageContext = createVersionedContext("techdocs-reader-page-context");
+const TechDocsReaderPageProvider = memo(({ entityRef, children }) => {
+  const techdocsApi = useApi(techdocsApiRef);
+  const metadata = useAsync(async () => {
+    return techdocsApi.getTechDocsMetadata(entityRef);
+  }, [entityRef]);
+  const entityMetadata = useAsync(async () => {
+    return techdocsApi.getEntityMetadata(entityRef);
+  }, [entityRef]);
+  const [title, setTitle] = useState(defaultTechDocsReaderPageValue.title);
+  const [subtitle, setSubtitle] = useState(defaultTechDocsReaderPageValue.subtitle);
+  const [shadowRoot, setShadowRoot] = useState(defaultTechDocsReaderPageValue.shadowRoot);
+  const value = {
+    metadata,
+    entityRef,
+    entityMetadata,
+    shadowRoot,
+    setShadowRoot,
+    title,
+    setTitle,
+    subtitle,
+    setSubtitle
+  };
+  const versionedValue = createVersionedValueMap({ 1: value });
+  return /* @__PURE__ */ React.createElement(TechDocsReaderPageContext.Provider, {
+    value: versionedValue
+  }, children instanceof Function ? children(value) : children);
+}, (prevProps, nextProps) => {
+  return areEntityRefsEqual(prevProps.entityRef, nextProps.entityRef);
+});
+const useTechDocsReaderPage = () => {
+  const versionedContext = useContext(TechDocsReaderPageContext);
+  if (versionedContext === void 0) {
+    return defaultTechDocsReaderPageValue;
+  }
+  const context = versionedContext.atVersion(1);
+  if (context === void 0) {
+    throw new Error("No context found for version 1.");
+  }
+  return context;
+};
+
+const useShadowRoot = () => {
+  const { shadowRoot } = useTechDocsReaderPage();
+  return shadowRoot;
+};
+const useShadowRootElements = (selectors) => {
+  const shadowRoot = useShadowRoot();
+  if (!shadowRoot)
+    return [];
+  return selectors.map((selector) => shadowRoot == null ? void 0 : shadowRoot.querySelectorAll(selector)).filter((nodeList) => nodeList.length).map((nodeList) => Array.from(nodeList)).flat();
+};
+const isValidSelection = (newSelection) => {
+  return newSelection.toString() && newSelection.rangeCount && newSelection.getRangeAt(0).getBoundingClientRect().top;
+};
+const useShadowRootSelection = (wait = 0) => {
+  const shadowRoot = useShadowRoot();
+  const [selection, setSelection] = useState(null);
+  const handleSelectionChange = useMemo(() => debounce(() => {
+    const shadowDocument = shadowRoot;
+    const newSelection = shadowDocument.getSelection ? shadowDocument.getSelection() : document.getSelection();
+    if (newSelection && isValidSelection(newSelection)) {
+      setSelection(newSelection);
+    } else {
+      setSelection(null);
+    }
+  }, wait), [shadowRoot, setSelection, wait]);
+  useEffect(() => {
+    window.document.addEventListener("selectionchange", handleSelectionChange);
+    return () => window.document.removeEventListener("selectionchange", handleSelectionChange);
+  }, [handleSelectionChange]);
+  return selection;
+};
+
+const TechDocsAddonLocations = Object.freeze({
+  Header: "Header",
+  Subheader: "Subheader",
+  PrimarySidebar: "PrimarySidebar",
+  SecondarySidebar: "SecondarySidebar",
+  Content: "Content"
+});
+
+export { TECHDOCS_ADDONS_WRAPPER_KEY, TechDocsAddonLocations, TechDocsAddons, TechDocsReaderPageProvider, createTechDocsAddonExtension, defaultTechDocsReaderPageValue, techdocsApiRef, useShadowRoot, useShadowRootElements, useShadowRootSelection, useTechDocsAddons, useTechDocsReaderPage };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/addons.tsx","../src/api.ts","../src/context.tsx","../src/hooks.ts","../src/types.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 React, { ComponentType, 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\nexport const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1';\n\n/**\n * Marks the <TechDocsAddons> registry component.\n * @alpha\n */\nexport const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';\n\n/**\n * TechDocs Addon registry.\n * @alpha\n */\nexport const TechDocsAddons: React.ComponentType = () => 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.\n * @alpha\n */\nexport function createTechDocsAddonExtension<TComponentProps>(\n  options: TechDocsAddonOptions<TComponentProps>,\n): Extension<ComponentType<TComponentProps>> {\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 * @alpha\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","/*\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 { CompoundEntityRef } from '@backstage/catalog-model';\nimport { createApiRef } from '@backstage/core-plugin-api';\nimport { TechDocsEntityMetadata, TechDocsMetadata } from './types';\n\n/**\n * API to talk to techdocs-backend.\n *\n * @public\n */\nexport interface TechDocsApi {\n  getApiOrigin(): Promise<string>;\n  getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>;\n  getEntityMetadata(\n    entityId: CompoundEntityRef,\n  ): Promise<TechDocsEntityMetadata>;\n}\n\n/**\n * Utility API reference for the {@link TechDocsApi}.\n *\n * @public\n */\nexport const techdocsApiRef = createApiRef<TechDocsApi>({\n  id: 'plugin.techdocs.service',\n});\n","/*\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, {\n  Dispatch,\n  SetStateAction,\n  useContext,\n  useState,\n  memo,\n  ReactNode,\n} from 'react';\nimport useAsync, { AsyncState } from 'react-use/lib/useAsync';\n\nimport {\n  CompoundEntityRef,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n  createVersionedContext,\n  createVersionedValueMap,\n} from '@backstage/version-bridge';\n\nimport { useApi } from '@backstage/core-plugin-api';\n\nimport { techdocsApiRef } from './api';\nimport { TechDocsEntityMetadata, TechDocsMetadata } from './types';\n\nconst areEntityRefsEqual = (\n  prevEntityRef: CompoundEntityRef,\n  nextEntityRef: CompoundEntityRef,\n) => {\n  return (\n    stringifyEntityRef(prevEntityRef) === stringifyEntityRef(nextEntityRef)\n  );\n};\n\n/**\n * @public type for the value of the TechDocsReaderPageContext\n */\nexport type TechDocsReaderPageValue = {\n  metadata: AsyncState<TechDocsMetadata>;\n  entityRef: CompoundEntityRef;\n  entityMetadata: AsyncState<TechDocsEntityMetadata>;\n  shadowRoot?: ShadowRoot;\n  setShadowRoot: Dispatch<SetStateAction<ShadowRoot | undefined>>;\n  title: string;\n  setTitle: Dispatch<SetStateAction<string>>;\n  subtitle: string;\n  setSubtitle: Dispatch<SetStateAction<string>>;\n  /**\n   * @deprecated property can be passed down directly to the `TechDocsReaderPageContent` instead.\n   */\n  onReady?: () => void;\n};\n\n/**\n * @alpha\n */\nexport const defaultTechDocsReaderPageValue: TechDocsReaderPageValue = {\n  title: '',\n  subtitle: '',\n  setTitle: () => {},\n  setSubtitle: () => {},\n  setShadowRoot: () => {},\n  metadata: { loading: true },\n  entityMetadata: { loading: true },\n  entityRef: { kind: '', name: '', namespace: '' },\n};\n\nconst TechDocsReaderPageContext = createVersionedContext<{\n  1: TechDocsReaderPageValue;\n}>('techdocs-reader-page-context');\n\n/**\n * render function for {@link TechDocsReaderPageProvider}\n *\n * @public\n */\nexport type TechDocsReaderPageProviderRenderFunction = (\n  value: TechDocsReaderPageValue,\n) => JSX.Element;\n\n/**\n * Props for {@link TechDocsReaderPageProvider}\n *\n * @public\n */\nexport type TechDocsReaderPageProviderProps = {\n  entityRef: CompoundEntityRef;\n  children: TechDocsReaderPageProviderRenderFunction | ReactNode;\n};\n\n/**\n * A context to store the reader page state\n * @public\n */\nexport const TechDocsReaderPageProvider = memo(\n  ({ entityRef, children }: TechDocsReaderPageProviderProps) => {\n    const techdocsApi = useApi(techdocsApiRef);\n\n    const metadata = useAsync(async () => {\n      return techdocsApi.getTechDocsMetadata(entityRef);\n    }, [entityRef]);\n\n    const entityMetadata = useAsync(async () => {\n      return techdocsApi.getEntityMetadata(entityRef);\n    }, [entityRef]);\n\n    const [title, setTitle] = useState(defaultTechDocsReaderPageValue.title);\n    const [subtitle, setSubtitle] = useState(\n      defaultTechDocsReaderPageValue.subtitle,\n    );\n    const [shadowRoot, setShadowRoot] = useState<ShadowRoot | undefined>(\n      defaultTechDocsReaderPageValue.shadowRoot,\n    );\n\n    const value = {\n      metadata,\n      entityRef,\n      entityMetadata,\n      shadowRoot,\n      setShadowRoot,\n      title,\n      setTitle,\n      subtitle,\n      setSubtitle,\n    };\n    const versionedValue = createVersionedValueMap({ 1: value });\n\n    return (\n      <TechDocsReaderPageContext.Provider value={versionedValue}>\n        {children instanceof Function ? children(value) : children}\n      </TechDocsReaderPageContext.Provider>\n    );\n  },\n  (prevProps, nextProps) => {\n    return areEntityRefsEqual(prevProps.entityRef, nextProps.entityRef);\n  },\n);\n\n/**\n * Hook used to get access to shared state between reader page components.\n * @alpha\n */\nexport const useTechDocsReaderPage = () => {\n  const versionedContext = useContext(TechDocsReaderPageContext);\n\n  if (versionedContext === undefined) {\n    return defaultTechDocsReaderPageValue;\n  }\n\n  const context = versionedContext.atVersion(1);\n  if (context === undefined) {\n    throw new Error('No context found for version 1.');\n  }\n\n  return context;\n};\n","/*\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 */\nimport { useState, useEffect, useMemo } from 'react';\nimport debounce from 'lodash/debounce';\nimport { useTechDocsReaderPage } from './context';\n\n/**\n * Hook for use within TechDocs addons that provides access to the underlying\n * shadow root of the current page, allowing the DOM within to be mutated.\n * @alpha\n */\nexport const useShadowRoot = () => {\n  const { shadowRoot } = useTechDocsReaderPage();\n  return shadowRoot;\n};\n\n/**\n * Convenience hook for use within TechDocs addons that provides access to\n * elements that match a given selector within the shadow root.\n *\n * @alpha\n */\nexport const useShadowRootElements = <\n  TReturnedElement extends HTMLElement = HTMLElement,\n>(\n  selectors: string[],\n): TReturnedElement[] => {\n  const shadowRoot = useShadowRoot();\n  if (!shadowRoot) return [];\n  return selectors\n    .map(selector => shadowRoot?.querySelectorAll<TReturnedElement>(selector))\n    .filter(nodeList => nodeList.length)\n    .map(nodeList => Array.from(nodeList))\n    .flat();\n};\n\nconst isValidSelection = (newSelection: Selection) => {\n  // Safari sets the selection rect to top zero\n  return (\n    newSelection.toString() &&\n    newSelection.rangeCount &&\n    newSelection.getRangeAt(0).getBoundingClientRect().top\n  );\n};\n\n/**\n * Hook for retreiving a selection within the ShadowRoot.\n * @alpha\n */\nexport const useShadowRootSelection = (wait: number = 0) => {\n  const shadowRoot = useShadowRoot();\n  const [selection, setSelection] = useState<Selection | null>(null);\n  const handleSelectionChange = useMemo(\n    () =>\n      debounce(() => {\n        const shadowDocument = shadowRoot as ShadowRoot &\n          Pick<Document, 'getSelection'>;\n        // Firefox and Safari don't implement getSelection for Shadow DOM\n        const newSelection = shadowDocument.getSelection\n          ? shadowDocument.getSelection()\n          : document.getSelection();\n\n        if (newSelection && isValidSelection(newSelection)) {\n          setSelection(newSelection);\n        } else {\n          setSelection(null);\n        }\n      }, wait),\n    [shadowRoot, setSelection, wait],\n  );\n\n  useEffect(() => {\n    window.document.addEventListener('selectionchange', handleSelectionChange);\n    return () =>\n      window.document.removeEventListener(\n        'selectionchange',\n        handleSelectionChange,\n      );\n  }, [handleSelectionChange]);\n\n  return selection;\n};\n","/*\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 { ComponentType } from 'react';\nimport { Entity } from '@backstage/catalog-model';\n\n/**\n * Metadata for TechDocs page\n *\n * @public\n */\nexport type TechDocsMetadata = {\n  site_name: string;\n  site_description: string;\n};\n\n/**\n * Metadata for TechDocs Entity\n *\n * @public\n */\nexport type TechDocsEntityMetadata = Entity & {\n  locationMetadata?: { type: string; target: string };\n};\n\n/**\n * Locations for which TechDocs addons may be declared and rendered.\n * @alpha\n */\nexport const TechDocsAddonLocations = Object.freeze({\n  /**\n   * These addons fill up the header from the right, on the same line as the\n   * title.\n   */\n  Header: 'Header',\n\n  /**\n   * These addons appear below the header and above all content; tooling addons\n   * can be inserted for convenience.\n   */\n  Subheader: 'Subheader',\n\n  /**\n   * These addons appear left of the content and above the navigation.\n   */\n  PrimarySidebar: 'PrimarySidebar',\n\n  /**\n   * These addons appear right of the content and above the table of contents.\n   */\n  SecondarySidebar: 'SecondarySidebar',\n\n  /**\n   * A virtual location which allows mutation of all content within the shadow\n   * root by transforming DOM nodes. These addons should return null on render.\n   */\n  Content: 'Content',\n\n  /**\n   * todo(backstage/community): This is a proposed virtual location which would\n   * help implement a common addon pattern in which many instances of a given\n   * element in markdown would be dynamically replaced at render-time based on\n   * attributes provided on that element, for example:\n   *\n   * ```md\n   * ## For Fun\n   * <TechDocsAddon>CatGif</TechDocsAddon>\n   *\n   * ## Component Metadata\n   * <TechDocsAddon entityRef=\"default:component/some-component-name\">CatalogEntityCard</TechDocsAddon>\n   *\n   * ## System Metadata\n   * <TechDocsAddon entityRef=\"default:system/some-system-name\">CatalogEntityCard</TechDocsAddon>\n   * ```\n   *\n   * Could correspond to a TechDocs addon named `CatalogEntityCard` with\n   * location `TechDocsAddonLocations.COMPONENT`, whose `component` would be\n   * the react component that would be rendered in place of all instances of\n   * the markdown illustrated above.\n   *\n   * The `@backstage/plugin-techdocs-react` package would need to be updated to, in\n   * cases where such addons had been registered, find all instances of the\n   * the `<TechDocsAddon>` tag whose `textContent` corresponded with the name of the\n   * addon, then replace them with component instances of the addon component,\n   * passing any attributes from the tag as props to the component.\n   */\n  // Component: 'Component',\n} as const);\n\n/**\n * Options for creating a TechDocs addon.\n * @alpha\n */\nexport type TechDocsAddonOptions<TAddonProps = {}> = {\n  name: string;\n  location: keyof typeof TechDocsAddonLocations;\n  component: ComponentType<TAddonProps>;\n};\n"],"names":[],"mappings":";;;;;;;;AAOO,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAClD,MAAC,2BAA2B,GAAG,6BAA6B;AAC5D,MAAC,cAAc,GAAG,MAAM,KAAK;AACzC,mBAAmB,CAAC,cAAc,EAAE,2BAA2B,EAAE,IAAI,CAAC,CAAC;AACvE,MAAM,gBAAgB,GAAG,CAAC,IAAI,KAAK;AACnC,EAAE,OAAO,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACrE,CAAC,CAAC;AACK,SAAS,4BAA4B,CAAC,OAAO,EAAE;AACtD,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;AACrD,EAAE,OAAO,oBAAoB,CAAC;AAC9B,IAAI,IAAI;AACR,IAAI,SAAS,EAAE;AACf,MAAM,IAAI,EAAE,CAAC,KAAK,qBAAqB,KAAK,CAAC,aAAa,CAAC,aAAa,EAAE;AAC1E,QAAQ,GAAG,KAAK;AAChB,OAAO,CAAC;AACR,KAAK;AACL,IAAI,IAAI,EAAE;AACV,MAAM,CAAC,mBAAmB,GAAG,OAAO;AACpC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,IAAI;AACpC,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACD,MAAM,sBAAsB,GAAG,CAAC,UAAU,EAAE,GAAG,KAAK;AACpD,EAAE,OAAO,UAAU,CAAC,qBAAqB,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC,CAAC;AACF,MAAM,oBAAoB,GAAG,CAAC,UAAU,KAAK;AAC7C,EAAE,OAAO,UAAU,CAAC,qBAAqB,CAAC;AAC1C,IAAI,GAAG,EAAE,2BAA2B;AACpC,GAAG,CAAC,CAAC,qBAAqB,CAAC;AAC3B,IAAI,GAAG,EAAE,mBAAmB;AAC5B,GAAG,CAAC,CAAC;AACL,CAAC,CAAC;AACF,MAAM,wBAAwB,GAAG,CAAC,UAAU,KAAK;AACjD,EAAE,OAAO,UAAU,CAAC,qBAAqB,CAAC;AAC1C,IAAI,GAAG,EAAE,2BAA2B;AACpC,GAAG,CAAC,CAAC,iBAAiB,CAAC;AACvB,IAAI,GAAG,EAAE,mBAAmB;AAC5B,GAAG,CAAC,CAAC;AACL,CAAC,CAAC;AACU,MAAC,iBAAiB,GAAG,MAAM;AACvC,EAAE,MAAM,IAAI,GAAG,SAAS,EAAE,CAAC;AAC3B,EAAE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;AAClE,EAAE,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;AACnE,EAAE,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,IAAI,KAAK;AAChD,IAAI,IAAI,EAAE,CAAC;AACX,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI;AAC5B,MAAM,OAAO,IAAI,CAAC;AAClB,IAAI,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChD,IAAI,OAAO,CAAC,EAAE,GAAG,sBAAsB,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC;AAClF,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;AACnB,EAAE,MAAM,qBAAqB,GAAG,WAAW,CAAC,CAAC,IAAI,KAAK;AACtD,IAAI,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAChE,IAAI,OAAO,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAC/C,GAAG,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;AACjC,EAAE,MAAM,0BAA0B,GAAG,WAAW,CAAC,CAAC,QAAQ,KAAK;AAC/D,IAAI,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAC1E,IAAI,OAAO,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;AAC1D,GAAG,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;AACjC,EAAE,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,CAAC;AAC/D;;ACjEY,MAAC,cAAc,GAAG,YAAY,CAAC;AAC3C,EAAE,EAAE,EAAE,yBAAyB;AAC/B,CAAC;;ACYD,MAAM,kBAAkB,GAAG,CAAC,aAAa,EAAE,aAAa,KAAK;AAC7D,EAAE,OAAO,kBAAkB,CAAC,aAAa,CAAC,KAAK,kBAAkB,CAAC,aAAa,CAAC,CAAC;AACjF,CAAC,CAAC;AACU,MAAC,8BAA8B,GAAG;AAC9C,EAAE,KAAK,EAAE,EAAE;AACX,EAAE,QAAQ,EAAE,EAAE;AACd,EAAE,QAAQ,EAAE,MAAM;AAClB,GAAG;AACH,EAAE,WAAW,EAAE,MAAM;AACrB,GAAG;AACH,EAAE,aAAa,EAAE,MAAM;AACvB,GAAG;AACH,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;AAC7B,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;AACnC,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;AAClD,EAAE;AACF,MAAM,yBAAyB,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;AAC7E,MAAC,0BAA0B,GAAG,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK;AAC5E,EAAE,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;AAC7C,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY;AACxC,IAAI,OAAO,WAAW,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;AACtD,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;AAClB,EAAE,MAAM,cAAc,GAAG,QAAQ,CAAC,YAAY;AAC9C,IAAI,OAAO,WAAW,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;AACpD,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;AAClB,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;AAC3E,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;AACpF,EAAE,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,8BAA8B,CAAC,UAAU,CAAC,CAAC;AAC1F,EAAE,MAAM,KAAK,GAAG;AAChB,IAAI,QAAQ;AACZ,IAAI,SAAS;AACb,IAAI,cAAc;AAClB,IAAI,UAAU;AACd,IAAI,aAAa;AACjB,IAAI,KAAK;AACT,IAAI,QAAQ;AACZ,IAAI,QAAQ;AACZ,IAAI,WAAW;AACf,GAAG,CAAC;AACJ,EAAE,MAAM,cAAc,GAAG,uBAAuB,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAC/D,EAAE,uBAAuB,KAAK,CAAC,aAAa,CAAC,yBAAyB,CAAC,QAAQ,EAAE;AACjF,IAAI,KAAK,EAAE,cAAc;AACzB,GAAG,EAAE,QAAQ,YAAY,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,CAAC;AAChE,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK;AAC7B,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;AACtE,CAAC,EAAE;AACS,MAAC,qBAAqB,GAAG,MAAM;AAC3C,EAAE,MAAM,gBAAgB,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AACjE,EAAE,IAAI,gBAAgB,KAAK,KAAK,CAAC,EAAE;AACnC,IAAI,OAAO,8BAA8B,CAAC;AAC1C,GAAG;AACH,EAAE,MAAM,OAAO,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAChD,EAAE,IAAI,OAAO,KAAK,KAAK,CAAC,EAAE;AAC1B,IAAI,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;AACvD,GAAG;AACH,EAAE,OAAO,OAAO,CAAC;AACjB;;ACpEY,MAAC,aAAa,GAAG,MAAM;AACnC,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,qBAAqB,EAAE,CAAC;AACjD,EAAE,OAAO,UAAU,CAAC;AACpB,EAAE;AACU,MAAC,qBAAqB,GAAG,CAAC,SAAS,KAAK;AACpD,EAAE,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;AACrC,EAAE,IAAI,CAAC,UAAU;AACjB,IAAI,OAAO,EAAE,CAAC;AACd,EAAE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,UAAU,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,UAAU,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAC/L,EAAE;AACF,MAAM,gBAAgB,GAAG,CAAC,YAAY,KAAK;AAC3C,EAAE,OAAO,YAAY,CAAC,QAAQ,EAAE,IAAI,YAAY,CAAC,UAAU,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,qBAAqB,EAAE,CAAC,GAAG,CAAC;AACtH,CAAC,CAAC;AACU,MAAC,sBAAsB,GAAG,CAAC,IAAI,GAAG,CAAC,KAAK;AACpD,EAAE,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;AACrC,EAAE,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnD,EAAE,MAAM,qBAAqB,GAAG,OAAO,CAAC,MAAM,QAAQ,CAAC,MAAM;AAC7D,IAAI,MAAM,cAAc,GAAG,UAAU,CAAC;AACtC,IAAI,MAAM,YAAY,GAAG,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,EAAE,GAAG,QAAQ,CAAC,YAAY,EAAE,CAAC;AAC/G,IAAI,IAAI,YAAY,IAAI,gBAAgB,CAAC,YAAY,CAAC,EAAE;AACxD,MAAM,YAAY,CAAC,YAAY,CAAC,CAAC;AACjC,KAAK,MAAM;AACX,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;AACzB,KAAK;AACL,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;AAC9C,EAAE,SAAS,CAAC,MAAM;AAClB,IAAI,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,CAAC;AAC/E,IAAI,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,CAAC;AAC/F,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC;AAC9B,EAAE,OAAO,SAAS,CAAC;AACnB;;ACjCY,MAAC,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC;AACpD,EAAE,MAAM,EAAE,QAAQ;AAClB,EAAE,SAAS,EAAE,WAAW;AACxB,EAAE,cAAc,EAAE,gBAAgB;AAClC,EAAE,gBAAgB,EAAE,kBAAkB;AACtC,EAAE,OAAO,EAAE,SAAS;AACpB,CAAC;;;;"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@backstage/plugin-techdocs-react",
+  "description": "Shared frontend utilities for TechDocs and Addons",
+  "version": "0.0.0-nightly-20220413023505",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "alphaTypes": "dist/index.alpha.d.ts",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "web-library"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/techdocs-react"
+  },
+  "keywords": [
+    "backstage",
+    "techdocs"
+  ],
+  "license": "Apache-2.0",
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "backstage-cli package build --experimental-type-build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean",
+    "start": "backstage-cli package start"
+  },
+  "dependencies": {
+    "@backstage/catalog-model": "^0.0.0-nightly-20220413023505",
+    "@backstage/core-components": "^0.0.0-nightly-20220413023505",
+    "@backstage/core-plugin-api": "^0.0.0-nightly-20220413023505",
+    "@backstage/version-bridge": "^1.0.0",
+    "@material-ui/core": "^4.12.2",
+    "@material-ui/lab": "4.0.0-alpha.57",
+    "@material-ui/styles": "^4.11.0",
+    "jss": "~10.8.2",
+    "lodash": "^4.17.21",
+    "react-helmet": "6.1.0",
+    "react-router-dom": "6.0.0-beta.0",
+    "react-use": "^17.2.4"
+  },
+  "peerDependencies": {
+    "@types/react": "^16.13.1 || ^17.0.0",
+    "react": "^16.13.1 || ^17.0.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^12.1.3",
+    "@testing-library/react-hooks": "^7.0.2",
+    "@backstage/test-utils": "^0.0.0-nightly-20220413023505",
+    "@backstage/theme": "^0.2.15"
+  },
+  "files": [
+    "alpha",
+    "dist"
+  ]
+}