Remove unnecessary, secret exports.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2022-05-11 10:02:36 +02:00
parent 50dbb56563
commit 66521125b3
5 changed files with 6 additions and 40 deletions
@@ -27,16 +27,6 @@ import { useReaderState, ReaderState } from '../useReaderState';
const TechDocsReaderContext = createContext<ReaderState>({} as ReaderState);
/**
* Note: this hook is currently being exported so that we can rapidly
* iterate on alternative <Reader /> implementations that extend core
* functionality. There is no guarantee that this hook will continue to be
* exported by the package in the future!
*
* todo: Make public or stop exporting (ctrl+f "altReaderExperiments")
* @internal
*/
export const useTechDocsReader = () => useContext(TechDocsReaderContext);
/**
@@ -73,15 +63,6 @@ export const TechDocsReaderProvider = ({
);
};
/**
* Note: this HOC is currently being exported so that we can rapidly
* iterate on alternative <Reader /> implementations that extend core
* functionality. There is no guarantee that this HOC will continue to be
* exported by the package in the future!
*
* todo: Make public or stop exporting (ctrl+f "altReaderExperiments")
* @internal
*/
export const withTechDocsReaderProvider =
<T extends {}>(Component: ComponentType<T>) =>
(props: T) =>
@@ -58,14 +58,6 @@ const headings: TypographyHeadingsKeys[] = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
* Hook that encapsulates the behavior of getting raw HTML and applying
* transforms to it in order to make it function at a basic level in the
* Backstage UI.
*
* Note: this hook is currently being exported so that we can rapidly iterate
* on alternative <Reader /> implementations that extend core functionality.
* There is no guarantee that this hook will continue to be exported by the
* package in the future!
*
* todo: Make public or stop exporting (see others: "altReaderExperiments")
* @internal
*/
export const useTechDocsReaderDom = (
entityRef: CompoundEntityRef,
@@ -16,5 +16,8 @@
export { TechDocsReaderPageContent, Reader } from './TechDocsReaderPageContent';
export type { TechDocsReaderPageContentProps } from './TechDocsReaderPageContent';
export * from './context';
export * from './dom';
export { TechDocsReaderProvider } from './context';
export type {
TechDocsReaderProviderRenderFunction,
TechDocsReaderProviderProps,
} from './context';
@@ -21,7 +21,7 @@ import { Alert } from '@material-ui/lab';
import { TechDocsBuildLogs } from './TechDocsBuildLogs';
import { TechDocsNotFound } from './TechDocsNotFound';
import { useTechDocsReader } from './TechDocsReaderPageContent';
import { useTechDocsReader } from './TechDocsReaderPageContent/context';
const useStyles = makeStyles(theme => ({
root: {
@@ -35,15 +35,6 @@ const useStyles = makeStyles(theme => ({
},
}));
/**
* Note: this component is currently being exported so that we can rapidly
* iterate on alternative <Reader /> implementations that extend core
* functionality. There is no guarantee that this component will continue to be
* exported by the package in the future!
*
* todo: Make public or stop exporting (ctrl+f "altReaderExperiments")
* @internal
*/
export const TechDocsStateIndicator = () => {
let StateAlert: JSX.Element | null = null;
const classes = useStyles();
@@ -22,5 +22,4 @@ export { TechDocsReaderLayout } from './TechDocsReaderPage';
export * from './TechDocsReaderPageHeader';
export * from './TechDocsReaderPageContent';
export * from './TechDocsReaderPageSubheader';
export * from './TechDocsStateIndicator';
export type { ReaderState, ContentStateTypes } from './useReaderState';