From 2b74671f52567fc78e1687978612d822b80a97cb Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Wed, 11 May 2022 11:37:33 +0200 Subject: [PATCH] Move stable alpha exports to public. Signed-off-by: Eric Peterson --- plugins/techdocs-react/api-report.md | 23 ++++++++++------------- plugins/techdocs-react/src/addons.tsx | 8 ++++---- plugins/techdocs-react/src/context.tsx | 7 ++----- plugins/techdocs-react/src/hooks.ts | 6 +++--- plugins/techdocs-react/src/index.ts | 6 +----- plugins/techdocs-react/src/types.ts | 4 ++-- 6 files changed, 22 insertions(+), 32 deletions(-) diff --git a/plugins/techdocs-react/api-report.md b/plugins/techdocs-react/api-report.md index d3803d6794..e96cbebd1c 100644 --- a/plugins/techdocs-react/api-report.md +++ b/plugins/techdocs-react/api-report.md @@ -14,21 +14,18 @@ import { default as React_2 } from 'react'; import { ReactNode } from 'react'; import { SetStateAction } from 'react'; -// @alpha +// @public export function createTechDocsAddonExtension( options: TechDocsAddonOptions, ): Extension<(props: TComponentProps) => JSX.Element | null>; -// @alpha (undocumented) -export const defaultTechDocsReaderPageValue: TechDocsReaderPageValue; - // @public export type SyncResult = 'cached' | 'updated'; -// @alpha +// @public export const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1'; -// @alpha +// @public export const TechDocsAddonLocations: Readonly<{ readonly Header: 'Header'; readonly Subheader: 'Subheader'; @@ -38,14 +35,14 @@ export const TechDocsAddonLocations: Readonly<{ readonly Content: 'Content'; }>; -// @alpha +// @public export type TechDocsAddonOptions = { name: string; location: keyof typeof TechDocsAddonLocations; component: ComponentType; }; -// @alpha +// @public export const TechDocsAddons: React_2.ComponentType; // @public @@ -133,20 +130,20 @@ export interface TechDocsStorageApi { // @public export const techdocsStorageApiRef: ApiRef; -// @alpha +// @public export const useShadowRoot: () => ShadowRoot | undefined; -// @alpha +// @public export const useShadowRootElements: < TReturnedElement extends HTMLElement = HTMLElement, >( selectors: string[], ) => TReturnedElement[]; -// @alpha +// @public export const useShadowRootSelection: (wait?: number) => Selection | null; -// @alpha +// @public export const useTechDocsAddons: () => { renderComponentByName: (name: string) => JSX.Element | null; renderComponentsByLocation: ( @@ -154,6 +151,6 @@ export const useTechDocsAddons: () => { ) => (JSX.Element | null)[] | null; }; -// @alpha +// @public export const useTechDocsReaderPage: () => TechDocsReaderPageValue; ``` diff --git a/plugins/techdocs-react/src/addons.tsx b/plugins/techdocs-react/src/addons.tsx index 39d110bee3..49aa5b1bcc 100644 --- a/plugins/techdocs-react/src/addons.tsx +++ b/plugins/techdocs-react/src/addons.tsx @@ -31,13 +31,13 @@ export const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1'; /** * Marks the registry component. - * @alpha + * @public */ export const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1'; /** * TechDocs Addon registry. - * @alpha + * @public */ export const TechDocsAddons: React.ComponentType = () => null; @@ -49,7 +49,7 @@ const getDataKeyByName = (name: string) => { /** * Create a TechDocs addon. - * @alpha + * @public */ export function createTechDocsAddonExtension( options: TechDocsAddonOptions, @@ -96,7 +96,7 @@ const getAllTechDocsAddonsData = (collection: ElementCollection) => { /** * hook to use addons in components - * @alpha + * @public */ export const useTechDocsAddons = () => { const node = useOutlet(); diff --git a/plugins/techdocs-react/src/context.tsx b/plugins/techdocs-react/src/context.tsx index 67bf416818..4f2fa26164 100644 --- a/plugins/techdocs-react/src/context.tsx +++ b/plugins/techdocs-react/src/context.tsx @@ -66,10 +66,7 @@ export type TechDocsReaderPageValue = { onReady?: () => void; }; -/** - * @alpha - */ -export const defaultTechDocsReaderPageValue: TechDocsReaderPageValue = { +const defaultTechDocsReaderPageValue: TechDocsReaderPageValue = { title: '', subtitle: '', setTitle: () => {}, @@ -153,7 +150,7 @@ export const TechDocsReaderPageProvider = memo( /** * Hook used to get access to shared state between reader page components. - * @alpha + * @public */ export const useTechDocsReaderPage = () => { const versionedContext = useContext(TechDocsReaderPageContext); diff --git a/plugins/techdocs-react/src/hooks.ts b/plugins/techdocs-react/src/hooks.ts index cc141c9e15..560c548156 100644 --- a/plugins/techdocs-react/src/hooks.ts +++ b/plugins/techdocs-react/src/hooks.ts @@ -20,7 +20,7 @@ import { useTechDocsReaderPage } from './context'; /** * 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 + * @public */ export const useShadowRoot = () => { const { shadowRoot } = useTechDocsReaderPage(); @@ -31,7 +31,7 @@ export const useShadowRoot = () => { * Convenience hook for use within TechDocs addons that provides access to * elements that match a given selector within the shadow root. * - * @alpha + * @public */ export const useShadowRootElements = < TReturnedElement extends HTMLElement = HTMLElement, @@ -58,7 +58,7 @@ const isValidSelection = (newSelection: Selection) => { /** * Hook for retreiving a selection within the ShadowRoot. - * @alpha + * @public */ export const useShadowRootSelection = (wait: number = 0) => { const shadowRoot = useShadowRoot(); diff --git a/plugins/techdocs-react/src/index.ts b/plugins/techdocs-react/src/index.ts index c1cc3a1791..d4de5f0d29 100644 --- a/plugins/techdocs-react/src/index.ts +++ b/plugins/techdocs-react/src/index.ts @@ -28,11 +28,7 @@ export { } from './addons'; export { techdocsApiRef, techdocsStorageApiRef } from './api'; export type { SyncResult, TechDocsApi, TechDocsStorageApi } from './api'; -export { - defaultTechDocsReaderPageValue, - TechDocsReaderPageProvider, - useTechDocsReaderPage, -} from './context'; +export { TechDocsReaderPageProvider, useTechDocsReaderPage } from './context'; export type { TechDocsReaderPageProviderProps, TechDocsReaderPageProviderRenderFunction, diff --git a/plugins/techdocs-react/src/types.ts b/plugins/techdocs-react/src/types.ts index e147cd1dd1..d1fcc91db0 100644 --- a/plugins/techdocs-react/src/types.ts +++ b/plugins/techdocs-react/src/types.ts @@ -38,7 +38,7 @@ export type TechDocsEntityMetadata = Entity & { /** * Locations for which TechDocs addons may be declared and rendered. - * @alpha + * @public */ export const TechDocsAddonLocations = Object.freeze({ /** @@ -108,7 +108,7 @@ export const TechDocsAddonLocations = Object.freeze({ /** * Options for creating a TechDocs addon. - * @alpha + * @public */ export type TechDocsAddonOptions = { name: string;