@backstage/plugin-techdocs 1.6.1-next.1 → 1.6.1-next.3

package/dist/esm/{index-4901a4ac.esm.js → index-baf890da.esm.js}

@@ -1,4 +1,4 @@
-export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-27835b1e.esm.js';
+export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-3e6a932e.esm.js';
 import '@backstage/core-plugin-api';
 import '@backstage/errors';
 import 'event-source-polyfill';
@@ -33,4 +33,4 @@ import '@material-ui/icons/Share';
 import '@material-ui/styles';
 import '@material-ui/icons/Star';
 import '@material-ui/icons/StarBorder';
-//# sourceMappingURL=index-4901a4ac.esm.js.map
+//# sourceMappingURL=index-baf890da.esm.js.map

package/dist/esm/index-baf890da.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-baf890da.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -18,7 +18,7 @@ import { ResultHighlight } from '@backstage/plugin-search-common';
  *
  * @public
  */
-declare type TechDocsReaderPageRenderFunction = (options: {
+type TechDocsReaderPageRenderFunction = (options: {
     techdocsMetadataValue?: TechDocsMetadata | undefined;
     entityMetadataValue?: TechDocsEntityMetadata | undefined;
     entityRef: CompoundEntityRef;
@@ -48,7 +48,7 @@ declare const techdocsApiRef: _backstage_core_plugin_api.ApiRef<TechDocsApi>;
  * @public
  * @deprecated Import from `@backstage/plugin-techdocs-react` instead
  */
-declare type SyncResult = 'cached' | 'updated';
+type SyncResult = 'cached' | 'updated';
 /**
  * API which talks to TechDocs storage to fetch files to render.
  *
@@ -154,7 +154,7 @@ declare class TechDocsStorageClient implements TechDocsStorageApi {
  * @public
  * A state representation that is used to configure the UI of <Reader />
  */
-declare type ContentStateTypes = 
+type ContentStateTypes = 
 /** There is nothing to display but a loading indicator */
 'CHECKING'
 /** There is no content yet -> present a full screen loading page */
@@ -172,7 +172,7 @@ declare type ContentStateTypes =
 /**
  * @public shared reader state
  */
-declare type ReaderState = {
+type ReaderState = {
     state: ContentStateTypes;
     path: string;
     contentReload: () => void;
@@ -185,11 +185,11 @@ declare type ReaderState = {
 /**
  * @public Render function for {@link TechDocsReaderProvider}
  */
-declare type TechDocsReaderProviderRenderFunction = (value: ReaderState) => JSX.Element;
+type TechDocsReaderProviderRenderFunction = (value: ReaderState) => JSX.Element;
 /**
  * @public Props for {@link TechDocsReaderProvider}
  */
-declare type TechDocsReaderProviderProps = {
+type TechDocsReaderProviderProps = {
     children: TechDocsReaderProviderRenderFunction | ReactNode;
 };
 /**
@@ -203,7 +203,7 @@ declare const TechDocsReaderProvider: (props: TechDocsReaderProviderProps) => JS
  * Props for {@link TechDocsReaderLayout}
  * @public
  */
-declare type TechDocsReaderLayoutProps = {
+type TechDocsReaderLayoutProps = {
     /**
      * Show or hide the header, defaults to true.
      */
@@ -221,7 +221,7 @@ declare const TechDocsReaderLayout: (props: TechDocsReaderLayoutProps) => JSX.El
 /**
  * @public
  */
-declare type TechDocsReaderPageProps = {
+type TechDocsReaderPageProps = {
     entityRef?: CompoundEntityRef;
     children?: TechDocsReaderPageRenderFunction | ReactNode;
 };
@@ -232,7 +232,7 @@ declare type TechDocsReaderPageProps = {
  * @public
  * @deprecated No need to pass down properties anymore. The component consumes data from `TechDocsReaderPageContext` instead. Use the {@link @backstage/plugin-techdocs-react#useTechDocsReaderPage} hook for custom header.
  */
-declare type TechDocsReaderPageHeaderProps = PropsWithChildren<{
+type TechDocsReaderPageHeaderProps = PropsWithChildren<{
     entityRef?: CompoundEntityRef;
     entityMetadata?: TechDocsEntityMetadata;
     techDocsMetadata?: TechDocsMetadata;
@@ -249,7 +249,7 @@ declare const TechDocsReaderPageHeader: (props: TechDocsReaderPageHeaderProps) =
  * Props for {@link TechDocsReaderPageContent}
  * @public
  */
-declare type TechDocsReaderPageContentProps = {
+type TechDocsReaderPageContentProps = {
     /**
      * @deprecated No need to pass down entityRef as property anymore. Consumes the entityName from `TechDocsReaderPageContext`. Use the {@link @backstage/plugin-techdocs-react#useTechDocsReaderPage} hook for custom reader page content.
      */
@@ -289,7 +289,7 @@ declare const TechDocsReaderPageSubheader: (props: {
  *
  * @public
  */
-declare type TechDocsSearchProps = {
+type TechDocsSearchProps = {
     entityId: CompoundEntityRef;
     entityTitle?: string;
     debounceTime?: number;
@@ -306,7 +306,7 @@ declare const TechDocsSearch: (props: TechDocsSearchProps) => JSX.Element;
  *
  * @public
  */
-declare type DocsGroupConfig = {
+type DocsGroupConfig = {
     title: React__default.ReactNode;
     filterPredicate: ((entity: Entity) => boolean) | string;
 };
@@ -315,7 +315,7 @@ declare type DocsGroupConfig = {
  *
  * @public
  */
-declare type EntityListDocsGridPageProps = {
+type EntityListDocsGridPageProps = {
     groups?: DocsGroupConfig[];
 };
 /**
@@ -330,7 +330,7 @@ declare const EntityListDocsGrid: (props: EntityListDocsGridPageProps) => JSX.El
  *
  * @public
  */
-declare type DocsCardGridProps = {
+type DocsCardGridProps = {
     entities: Entity[] | undefined;
 };
 /**
@@ -345,7 +345,7 @@ declare const DocsCardGrid: (props: DocsCardGridProps) => JSX.Element | null;
  *
  * @public
  */
-declare type DocsTableRow = {
+type DocsTableRow = {
     entity: Entity;
     resolved: {
         docsUrl: string;
@@ -359,7 +359,7 @@ declare type DocsTableRow = {
  *
  * @public
  */
-declare type EntityListDocsTableProps = {
+type EntityListDocsTableProps = {
     columns?: TableColumn<DocsTableRow>[];
     actions?: TableProps<DocsTableRow>['actions'];
     options?: TableOptions<DocsTableRow>;
@@ -398,7 +398,7 @@ declare const EntityListDocsTable: {
  *
  * @public
  */
-declare type DocsTableProps = {
+type DocsTableProps = {
     entities: Entity[] | undefined;
     title?: string | undefined;
     loading?: boolean | undefined;
@@ -440,7 +440,7 @@ declare const DocsTable: {
  *
  * @public
  */
-declare type TechDocsIndexPageProps = {
+type TechDocsIndexPageProps = {
     initialFilter?: UserListFilterKind;
     columns?: TableColumn<DocsTableRow>[];
     actions?: TableProps<DocsTableRow>['actions'];
@@ -452,7 +452,7 @@ declare type TechDocsIndexPageProps = {
  * @public
  * @deprecated Please use `TechDocsIndexPageProps` instead.
  */
-declare type DefaultTechDocsHomeProps = TechDocsIndexPageProps;
+type DefaultTechDocsHomeProps = TechDocsIndexPageProps;
 /**
  * Component which renders a default documentation landing page.
  *
@@ -465,7 +465,7 @@ declare const DefaultTechDocsHome: (props: TechDocsIndexPageProps) => JSX.Elemen
  *
  * @public
  */
-declare type PanelType = 'DocsCardGrid' | 'DocsTable';
+type PanelType = 'DocsCardGrid' | 'DocsTable';
 /**
  * Type representing a TechDocsCustomHome panel.
  *
@@ -492,13 +492,13 @@ interface TabConfig {
  *
  * @public
  */
-declare type TabsConfig = TabConfig[];
+type TabsConfig = TabConfig[];
 /**
  * Props for {@link TechDocsCustomHome}
  *
  * @public
  */
-declare type TechDocsCustomHomeProps = {
+type TechDocsCustomHomeProps = {
     tabsConfig: TabsConfig;
 };
 
@@ -507,7 +507,7 @@ declare type TechDocsCustomHomeProps = {
  *
  * @public
  */
-declare type TechDocsPageWrapperProps = {
+type TechDocsPageWrapperProps = {
     children?: React__default.ReactNode;
 };
 /**
@@ -529,7 +529,7 @@ declare const TechDocsPicker: () => null;
  *
  * @public
  */
-declare type TechDocsSearchResultListItemProps = {
+type TechDocsSearchResultListItemProps = {
     icon?: ReactNode | ((result: any) => ReactNode);
     result?: any;
     highlight?: ResultHighlight;
@@ -623,12 +623,12 @@ declare const EmbeddedDocsRouter: (props: PropsWithChildren<{}>) => JSX.Element
  *
  * @public
  */
-declare type DeprecatedTechDocsMetadata = TechDocsMetadata;
+type DeprecatedTechDocsMetadata = TechDocsMetadata;
 /**
  * @deprecated Import from `@backstage/plugin-techdocs-react` instead
  *
  * @public
  */
-declare type DeprecatedTechDocsEntityMetadata = TechDocsEntityMetadata;
+type DeprecatedTechDocsEntityMetadata = TechDocsEntityMetadata;
 
 export { ContentStateTypes, DefaultTechDocsHome, DefaultTechDocsHomeProps, DocsCardGrid, DocsCardGridProps, DocsGroupConfig, DocsTable, DocsTableProps, DocsTableRow, EmbeddedDocsRouter, EntityListDocsGrid, EntityListDocsGridPageProps, EntityListDocsTable, EntityListDocsTableProps, EntityTechdocsContent, PanelConfig, PanelType, Reader, ReaderState, Router, SyncResult, TabConfig, TabsConfig, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsCustomHomeProps, DeprecatedTechDocsEntityMetadata as TechDocsEntityMetadata, TechDocsIndexPage, TechDocsIndexPageProps, DeprecatedTechDocsMetadata as TechDocsMetadata, TechDocsPageWrapper, TechDocsPageWrapperProps, TechDocsPicker, TechDocsReaderLayout, TechDocsReaderLayoutProps, TechDocsReaderPage, TechDocsReaderPageContent, TechDocsReaderPageContentProps, TechDocsReaderPageHeader, TechDocsReaderPageHeaderProps, TechDocsReaderPageProps, TechDocsReaderPageRenderFunction, TechDocsReaderPageSubheader, TechDocsReaderProvider, TechDocsReaderProviderProps, TechDocsReaderProviderRenderFunction, TechDocsSearch, TechDocsSearchProps, TechDocsSearchResultListItem, TechDocsSearchResultListItemProps, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, isTechDocsAvailable, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-export { u as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, y as EmbeddedDocsRouter, r as EntityListDocsGrid, s as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, x as Router, k as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, o as TechDocsReaderPageContent, n as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, m as TechDocsReaderProvider, q as TechDocsSearch, h as TechDocsSearchResultListItem, l as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, j as techdocsApiRef, t as techdocsPlugin, i as techdocsStorageApiRef } from './esm/index-27835b1e.esm.js';
+export { u as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, y as EmbeddedDocsRouter, r as EntityListDocsGrid, s as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, x as Router, k as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, o as TechDocsReaderPageContent, n as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, m as TechDocsReaderProvider, q as TechDocsSearch, h as TechDocsSearchResultListItem, l as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, j as techdocsApiRef, t as techdocsPlugin, i as techdocsStorageApiRef } from './esm/index-3e6a932e.esm.js';
 import '@backstage/core-plugin-api';
 import '@backstage/errors';
 import 'event-source-polyfill';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-techdocs",
   "description": "The Backstage plugin that renders technical documentation for your components",
-  "version": "1.6.1-next.1",
+  "version": "1.6.1-next.3",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -33,17 +33,17 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.2.1",
+    "@backstage/catalog-model": "^1.3.0-next.0",
     "@backstage/config": "^1.0.7",
-    "@backstage/core-components": "^0.12.6-next.1",
-    "@backstage/core-plugin-api": "^1.5.1-next.0",
+    "@backstage/core-components": "^0.13.0-next.3",
+    "@backstage/core-plugin-api": "^1.5.1-next.1",
     "@backstage/errors": "^1.1.5",
     "@backstage/integration": "^1.4.4-next.0",
-    "@backstage/integration-react": "^1.1.12-next.1",
-    "@backstage/plugin-catalog-react": "^1.4.1-next.1",
+    "@backstage/integration-react": "^1.1.12-next.3",
+    "@backstage/plugin-catalog-react": "^1.5.0-next.3",
     "@backstage/plugin-search-common": "^1.2.3-next.0",
-    "@backstage/plugin-search-react": "^1.5.2-next.1",
-    "@backstage/plugin-techdocs-react": "^1.1.5-next.1",
+    "@backstage/plugin-search-react": "^1.5.2-next.3",
+    "@backstage/plugin-techdocs-react": "^1.1.5-next.3",
     "@backstage/theme": "^0.2.19-next.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
@@ -64,11 +64,11 @@
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.6-next.1",
-    "@backstage/core-app-api": "^1.7.0-next.1",
-    "@backstage/dev-utils": "^1.0.14-next.1",
-    "@backstage/plugin-techdocs-module-addons-contrib": "^1.0.12-next.1",
-    "@backstage/test-utils": "^1.3.0-next.1",
+    "@backstage/cli": "^0.22.6-next.3",
+    "@backstage/core-app-api": "^1.7.0-next.3",
+    "@backstage/dev-utils": "^1.0.14-next.3",
+    "@backstage/plugin-techdocs-module-addons-contrib": "^1.0.12-next.3",
+    "@backstage/test-utils": "^1.3.0-next.3",
     "@testing-library/dom": "^8.0.0",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",