From d0a3bdb263c8419c412131ddca8307eb1150afee Mon Sep 17 00:00:00 2001
From: Brian Fletcher <brian@roadie.io>
Date: Tue, 1 Feb 2022 22:59:53 +0000
Subject: [PATCH] also export task page props and document

Signed-off-by: Brian Fletcher <brian@roadie.io>
---
 plugins/scaffolder/api-report.md                   | 10 ++++++----
 .../src/components/TaskPage/TaskPage.tsx           | 14 +++++++++++++-
 .../scaffolder/src/components/TaskPage/index.ts    |  1 +
 plugins/scaffolder/src/index.ts                    |  1 +
 4 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md
index 7f29d11073..12fed2326a 100644
--- a/plugins/scaffolder/api-report.md
+++ b/plugins/scaffolder/api-report.md
@@ -277,12 +277,14 @@ const scaffolderPlugin: BackstagePlugin<
 export { scaffolderPlugin as plugin };
 export { scaffolderPlugin };
 
-// Warning: (ae-forgotten-export) The symbol "TaskPageProps" needs to be exported by the entry point index.d.ts
-// Warning: (ae-missing-release-tag) "TaskPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element;
 
+// @public
+export type TaskPageProps = {
+  loadingText?: string;
+};
+
 // Warning: (ae-missing-release-tag) "TemplateList" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
diff --git a/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx b/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx
index 065c7b4478..d6933cd26b 100644
--- a/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx
+++ b/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx
@@ -218,10 +218,22 @@ export const TaskStatusStepper = memo(
 const hasLinks = ({ entityRef, remoteUrl, links = [] }: TaskOutput): boolean =>
   !!(entityRef || remoteUrl || links.length > 0);
 
-type TaskPageProps = {
+/**
+ * TaskPageProps for constructing a TaskPage
+ * @param loadingText - Optional loading text shown before a task begins executing.
+ *
+ * @public
+ */
+export type TaskPageProps = {
   loadingText?: string;
 };
 
+/**
+ * TaskPage for showing the status of the taskId provided as a param
+ * @param loadingText - Optional loading text shown before a task begins executing.
+ *
+ * @public
+ */
 export const TaskPage = ({ loadingText }: TaskPageProps) => {
   const classes = useStyles();
   const navigate = useNavigate();
diff --git a/plugins/scaffolder/src/components/TaskPage/index.ts b/plugins/scaffolder/src/components/TaskPage/index.ts
index 809b45101b..f7876888f9 100644
--- a/plugins/scaffolder/src/components/TaskPage/index.ts
+++ b/plugins/scaffolder/src/components/TaskPage/index.ts
@@ -14,3 +14,4 @@
  * limitations under the License.
  */
 export { TaskPage } from './TaskPage';
+export type { TaskPageProps } from './TaskPage';
diff --git a/plugins/scaffolder/src/index.ts b/plugins/scaffolder/src/index.ts
index 893ab82025..8012f14f32 100644
--- a/plugins/scaffolder/src/index.ts
+++ b/plugins/scaffolder/src/index.ts
@@ -57,3 +57,4 @@ export { TemplateList } from './components/TemplateList';
 export type { TemplateListProps } from './components/TemplateList';
 export { TemplateTypePicker } from './components/TemplateTypePicker';
 export { TaskPage } from './components/TaskPage';
+export type { TaskPageProps } from './components/TaskPage';