@backstage/plugin-techdocs 1.1.1-next.1 → 1.1.1

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { Config } from '@backstage/config';
 import * as React from 'react';
 import React__default, { ReactNode, PropsWithChildren } from 'react';
 import { ToolbarProps } from '@material-ui/core';
+import { ResultHighlight } from '@backstage/plugin-search-common';
 import { TableColumn, TableProps } from '@backstage/core-components';
 import { UserListFilterKind } from '@backstage/plugin-catalog-react';
 import { CSSProperties } from '@material-ui/styles';
@@ -148,6 +149,55 @@ declare class TechDocsStorageClient implements TechDocsStorageApi {
     getBaseUrl(oldBaseUrl: string, entityId: CompoundEntityRef, path: string): Promise<string>;
 }
 
+/**
+ * @public
+ * A state representation that is used to configure the UI of <Reader />
+ */
+declare type ContentStateTypes = 
+/** There is nothing to display but a loading indicator */
+'CHECKING'
+/** There is no content yet -> present a full screen loading page */
+ | 'INITIAL_BUILD'
+/** There is content, but the backend is about to update it */
+ | 'CONTENT_STALE_REFRESHING'
+/** There is content, but after a reload, the content will be different */
+ | 'CONTENT_STALE_READY'
+/** There is content, the backend tried to update it, but failed */
+ | 'CONTENT_STALE_ERROR'
+/** There is nothing to see but a "not found" page. Is also shown on page load errors */
+ | 'CONTENT_NOT_FOUND'
+/** There is only the latest and greatest content */
+ | 'CONTENT_FRESH';
+/**
+ * @public shared reader state
+ */
+declare type ReaderState = {
+    state: ContentStateTypes;
+    path: string;
+    contentReload: () => void;
+    content?: string;
+    contentErrorMessage?: string;
+    syncErrorMessage?: string;
+    buildLog: string[];
+};
+
+/**
+ * @public Render function for {@link TechDocsReaderProvider}
+ */
+declare type TechDocsReaderProviderRenderFunction = (value: ReaderState) => JSX.Element;
+/**
+ * @public Props for {@link TechDocsReaderProvider}
+ */
+declare type TechDocsReaderProviderProps = {
+    children: TechDocsReaderProviderRenderFunction | ReactNode;
+};
+/**
+ * Provides shared building process state to the reader page components.
+ *
+ * @public
+ */
+declare const TechDocsReaderProvider: ({ children, }: TechDocsReaderProviderProps) => JSX.Element;
+
 /**
  * Props for {@link TechDocsReaderLayout}
  * @public
@@ -224,55 +274,6 @@ declare const TechDocsReaderPageContent: (props: TechDocsReaderPageContentProps)
  */
 declare const Reader: (props: TechDocsReaderPageContentProps) => JSX.Element;
 
-/**
- * @public
- * A state representation that is used to configure the UI of <Reader />
- */
-declare type ContentStateTypes = 
-/** There is nothing to display but a loading indicator */
-'CHECKING'
-/** There is no content yet -> present a full screen loading page */
- | 'INITIAL_BUILD'
-/** There is content, but the backend is about to update it */
- | 'CONTENT_STALE_REFRESHING'
-/** There is content, but after a reload, the content will be different */
- | 'CONTENT_STALE_READY'
-/** There is content, the backend tried to update it, but failed */
- | 'CONTENT_STALE_ERROR'
-/** There is nothing to see but a "not found" page. Is also shown on page load errors */
- | 'CONTENT_NOT_FOUND'
-/** There is only the latest and greatest content */
- | 'CONTENT_FRESH';
-/**
- * @public shared reader state
- */
-declare type ReaderState = {
-    state: ContentStateTypes;
-    path: string;
-    contentReload: () => void;
-    content?: string;
-    contentErrorMessage?: string;
-    syncErrorMessage?: string;
-    buildLog: string[];
-};
-
-/**
- * @public Render function for {@link TechDocsReaderProvider}
- */
-declare type TechDocsReaderProviderRenderFunction = (value: ReaderState) => JSX.Element;
-/**
- * @public Props for {@link TechDocsReaderProvider}
- */
-declare type TechDocsReaderProviderProps = {
-    children: TechDocsReaderProviderRenderFunction | ReactNode;
-};
-/**
- * Provides shared building process state to the reader page components.
- *
- * @public
- */
-declare const TechDocsReaderProvider: ({ children, }: TechDocsReaderProviderProps) => JSX.Element;
-
 /**
  * Renders the reader page subheader.
  * Please use the Tech Docs add-ons to customize it
@@ -289,6 +290,7 @@ declare const TechDocsReaderPageSubheader: ({ toolbarProps, }: {
  */
 declare type TechDocsSearchResultListItemProps = {
     result: any;
+    highlight?: ResultHighlight;
     lineClamp?: number;
     asListItem?: boolean;
     asLink?: boolean;

package/dist/index.esm.js

@@ -1,15 +1,16 @@
-export { y as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, C as EmbeddedDocsRouter, v as EntityListDocsGrid, x as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, B as Router, j as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, z as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, m as TechDocsReaderPageContent, l as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, n as TechDocsReaderProvider, s as TechDocsSearch, r as TechDocsSearchResultListItem, q as TechDocsStateIndicator, k as TechDocsStorageClient, f as TechdocsPage, A as isTechDocsAvailable, t as plugin, i as techdocsApiRef, t as techdocsPlugin, h as techdocsStorageApiRef, u as useTechDocsReader, o as useTechDocsReaderDom, w as withTechDocsReaderProvider } from './esm/index-76cc1cd7.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, j as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, n as TechDocsReaderPageContent, m as TechDocsReaderPageHeader, o as TechDocsReaderPageSubheader, l as TechDocsReaderProvider, q as TechDocsSearch, p as TechDocsSearchResultListItem, k as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, i as techdocsApiRef, t as techdocsPlugin, h as techdocsStorageApiRef } from './esm/index-dd16232a.esm.js';
 import '@backstage/core-plugin-api';
 import '@backstage/errors';
 import 'event-source-polyfill';
 import 'react';
 import 'react-router-dom';
-import '@backstage/core-components';
 import '@backstage/plugin-techdocs-react';
+import 'react-use/lib/useAsync';
+import 'react-use/lib/useAsyncRetry';
+import '@backstage/core-components';
 import 'jss';
 import '@material-ui/core';
 import '@material-ui/styles';
-import 'react-text-truncate';
 import '@backstage/plugin-search-react';
 import '@material-ui/icons/Search';
 import '@material-ui/lab/Autocomplete';
@@ -17,8 +18,6 @@ import 'react-router';
 import 'react-use/lib/useDebounce';
 import '@material-ui/lab';
 import '@material-ui/icons/Close';
-import 'react-use/lib/useAsync';
-import 'react-use/lib/useAsyncRetry';
 import '@material-ui/core/styles';
 import '@backstage/integration-react';
 import '@backstage/integration';
@@ -31,6 +30,7 @@ import 'react-helmet';
 import '@material-ui/icons/Code';
 import '@backstage/plugin-catalog-react';
 import '@backstage/catalog-model';
+import '@material-ui/icons/Settings';
 import 'react-use/lib/useCopyToClipboard';
 import 'lodash';
 import '@material-ui/icons/Share';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-techdocs",
   "description": "The Backstage plugin that renders technical documentation for your components",
-  "version": "1.1.1-next.1",
+  "version": "1.1.1",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -35,16 +35,17 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.0.1",
-    "@backstage/config": "^1.0.0",
-    "@backstage/core-components": "^0.9.4-next.0",
-    "@backstage/core-plugin-api": "^1.0.2-next.0",
+    "@backstage/catalog-model": "^1.0.2",
+    "@backstage/config": "^1.0.1",
+    "@backstage/core-components": "^0.9.4",
+    "@backstage/core-plugin-api": "^1.0.2",
     "@backstage/errors": "^1.0.0",
-    "@backstage/integration": "^1.2.0-next.0",
-    "@backstage/integration-react": "^1.1.0-next.1",
-    "@backstage/plugin-catalog-react": "^1.1.0-next.1",
-    "@backstage/plugin-search-react": "^0.2.0-next.1",
-    "@backstage/plugin-techdocs-react": "^0.1.1-next.1",
+    "@backstage/integration": "^1.2.0",
+    "@backstage/integration-react": "^1.1.0",
+    "@backstage/plugin-catalog-react": "^1.1.0",
+    "@backstage/plugin-search-common": "^0.3.4",
+    "@backstage/plugin-search-react": "^0.2.0",
+    "@backstage/plugin-techdocs-react": "^1.0.0",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
@@ -58,7 +59,6 @@
     "react-helmet": "6.1.0",
     "react-router": "6.0.0-beta.0",
     "react-router-dom": "6.0.0-beta.0",
-    "react-text-truncate": "^0.18.0",
     "react-use": "^17.2.4"
   },
   "peerDependencies": {
@@ -67,10 +67,10 @@
     "react-dom": "^16.13.1 || ^17.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.17.1-next.1",
-    "@backstage/core-app-api": "^1.0.2-next.0",
-    "@backstage/dev-utils": "^1.0.2-next.1",
-    "@backstage/test-utils": "^1.1.0-next.1",
+    "@backstage/cli": "^0.17.1",
+    "@backstage/core-app-api": "^1.0.2",
+    "@backstage/dev-utils": "^1.0.2",
+    "@backstage/test-utils": "^1.1.0",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",
     "@testing-library/react-hooks": "^8.0.0",
@@ -88,5 +88,5 @@
     "config.d.ts"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "0b3df66a238c66a5498dab85b1ed85a8607289f1"
+  "gitHead": "96323f280ba32ee526c5b151cda42260aee927c9"
 }