@backstage/plugin-techdocs 1.1.1-next.2 → 1.1.2-next.0

package/dist/esm/{index-52f21300.esm.js → index-d4a4af9b.esm.js}

@@ -1,14 +1,14 @@
-export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-c537b1f3.esm.js';
+export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-9202d491.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 'jss';
+import 'react-use/lib/useAsync';
+import 'react-use/lib/useAsyncRetry';
+import '@backstage/core-components';
 import '@material-ui/core';
-import '@material-ui/styles';
 import '@backstage/plugin-search-react';
 import '@material-ui/icons/Search';
 import '@material-ui/lab/Autocomplete';
@@ -16,16 +16,13 @@ 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 'dompurify';
 import '@backstage/integration';
 import '@material-ui/icons/FeedbackOutlined';
 import 'react-dom';
 import 'git-url-parse';
 import '@material-ui/icons/Menu';
-import 'dompurify';
 import 'react-helmet';
 import '@material-ui/icons/Code';
 import '@backstage/plugin-catalog-react';
@@ -34,6 +31,7 @@ import '@material-ui/icons/Settings';
 import 'react-use/lib/useCopyToClipboard';
 import 'lodash';
 import '@material-ui/icons/Share';
+import '@material-ui/styles';
 import '@material-ui/icons/Star';
 import '@material-ui/icons/StarBorder';
-//# sourceMappingURL=index-52f21300.esm.js.map
+//# sourceMappingURL=index-d4a4af9b.esm.js.map

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

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

package/dist/index.d.ts

@@ -149,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
@@ -225,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
@@ -542,7 +542,7 @@ declare const TechdocsPage: () => JSX.Element;
  */
 declare const EntityTechdocsContent: (props: {
     children?: React.ReactNode;
-}) => JSX.Element;
+}) => JSX.Element | null;
 /**
  * Component which takes a custom tabs config object and renders a documentation landing page.
  *
@@ -579,7 +579,7 @@ declare const Router: () => JSX.Element;
  *
  * @public
  */
-declare const EmbeddedDocsRouter: (props: PropsWithChildren<{}>) => JSX.Element;
+declare const EmbeddedDocsRouter: (props: PropsWithChildren<{}>) => JSX.Element | null;
 
 /**
  * The Backstage plugin that renders technical documentation for your components

package/dist/index.esm.js

@@ -1,14 +1,14 @@
-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-c537b1f3.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-9202d491.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 'jss';
+import 'react-use/lib/useAsync';
+import 'react-use/lib/useAsyncRetry';
+import '@backstage/core-components';
 import '@material-ui/core';
-import '@material-ui/styles';
 import '@backstage/plugin-search-react';
 import '@material-ui/icons/Search';
 import '@material-ui/lab/Autocomplete';
@@ -16,16 +16,13 @@ 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 'dompurify';
 import '@backstage/integration';
 import '@material-ui/icons/FeedbackOutlined';
 import 'react-dom';
 import 'git-url-parse';
 import '@material-ui/icons/Menu';
-import 'dompurify';
 import 'react-helmet';
 import '@material-ui/icons/Code';
 import '@backstage/plugin-catalog-react';
@@ -34,6 +31,7 @@ import '@material-ui/icons/Settings';
 import 'react-use/lib/useCopyToClipboard';
 import 'lodash';
 import '@material-ui/icons/Share';
+import '@material-ui/styles';
 import '@material-ui/icons/Star';
 import '@material-ui/icons/StarBorder';
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

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

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.2",
+  "version": "1.1.2-next.0",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -35,24 +35,24 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.0.2-next.0",
-    "@backstage/config": "^1.0.1-next.0",
-    "@backstage/core-components": "^0.9.4-next.1",
-    "@backstage/core-plugin-api": "^1.0.2-next.1",
+    "@backstage/catalog-model": "^1.0.2",
+    "@backstage/config": "^1.0.1",
+    "@backstage/core-components": "^0.9.5-next.0",
+    "@backstage/core-plugin-api": "^1.0.2",
     "@backstage/errors": "^1.0.0",
-    "@backstage/integration": "^1.2.0-next.1",
-    "@backstage/integration-react": "^1.1.0-next.2",
-    "@backstage/plugin-catalog-react": "^1.1.0-next.2",
-    "@backstage/plugin-search-common": "^0.3.4-next.0",
-    "@backstage/plugin-search-react": "^0.2.0-next.2",
-    "@backstage/plugin-techdocs-react": "^0.1.1-next.2",
+    "@backstage/integration": "^1.2.1-next.0",
+    "@backstage/integration-react": "^1.1.1-next.0",
+    "@backstage/plugin-catalog-react": "^1.1.1-next.0",
+    "@backstage/plugin-search-common": "^0.3.4",
+    "@backstage/plugin-search-react": "^0.2.0",
+    "@backstage/plugin-techdocs-react": "^1.0.1-next.0",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.57",
     "@material-ui/styles": "^4.10.0",
     "dompurify": "^2.2.9",
-    "event-source-polyfill": "1.0.26",
+    "event-source-polyfill": "1.0.25",
     "git-url-parse": "^11.6.0",
     "jss": "~10.8.2",
     "lodash": "^4.17.21",
@@ -67,10 +67,10 @@
     "react-dom": "^16.13.1 || ^17.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.17.1-next.2",
-    "@backstage/core-app-api": "^1.0.2-next.1",
-    "@backstage/dev-utils": "^1.0.2-next.2",
-    "@backstage/test-utils": "^1.1.0-next.2",
+    "@backstage/cli": "^0.17.2-next.0",
+    "@backstage/core-app-api": "^1.0.2",
+    "@backstage/dev-utils": "^1.0.3-next.0",
+    "@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": "cfbf5762d7d91eee18999306b21d63840400ee29"
+  "gitHead": "c1511c99a532aeb003a97510a5638bd939ee65ca"
 }

package/dist/esm/index-52f21300.esm.js.map

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