chore: updating api-report and fixing code review comments

Signed-off-by: blam <ben@blam.sh>

plugins/scaffolder/api-report.md

@@ -417,6 +417,14 @@ export type ScaffolderTaskStatus =
   | 'completed'
   | 'skipped';
 
+// @public
+export interface ScaffolderUseTemplateSecrets {
+  // @deprecated (undocumented)
+  setSecret: (input: Record<string, string>) => void;
+  // (undocumented)
+  setSecrets: (input: Record<string, string>) => void;
+}
+
 // @public
 export const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element;
 
@@ -443,7 +451,7 @@ export type TemplateListProps = {
       }>
     | undefined;
   group?: {
-    title?: string;
+    title?: React_2.ReactNode;
     titleComponent?: React_2.ReactNode;
     filter: (entity: Entity) => boolean;
   };
@@ -465,8 +473,6 @@ export type TemplateParameterSchema = {
 // @public (undocumented)
 export const TemplateTypePicker: () => JSX.Element | null;
 
-// Warning: (ae-forgotten-export) The symbol "ScaffolderUseTemplateSecrets" needs to be exported by the entry point index.d.ts
-//
 // @public
 export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
 

plugins/scaffolder/src/components/ScaffolderPage/ScaffolderPage.tsx

@@ -55,7 +55,8 @@ export type ScaffolderPageProps = {
     | ComponentType<{ template: TemplateEntityV1beta2 }>
     | undefined;
   groups?: Array<{
-    title?: string;
+    title?: React.ReactNode;
+    /** @deprcated use title instead as it accepts a string and react component */
     titleComponent?: React.ReactNode;
     filter: (entity: Entity) => boolean;
   }>;

plugins/scaffolder/src/components/TemplateList/TemplateList.tsx

@@ -37,7 +37,8 @@ export type TemplateListProps = {
     | ComponentType<{ template: TemplateEntityV1beta2 }>
     | undefined;
   group?: {
-    title?: string;
+    title?: React.ReactNode;
+    /** @deprecated use title instead, can be a string or a react component */
     titleComponent?: React.ReactNode;
     filter: (entity: Entity) => boolean;
   };
@@ -55,11 +56,24 @@ export const TemplateList = ({
   const maybeFilteredEntities = group
     ? entities.filter(e => group.filter(e))
     : entities;
-  const title = group ? (
-    group.titleComponent || <ContentHeader title={group.title} />
-  ) : (
-    <ContentHeader title="Other Templates" />
-  );
+
+  const titleComponent: React.ReactNode = (() => {
+    if (group?.titleComponent) {
+      // eslint-disable-next-line no-console
+      console.warn(
+        'DEPRECATED: group.titleComponent is now deprecated. Use group.title instead, it can be a string or a react component',
+      );
+      return group?.titleComponent;
+    }
+    if (group && group.title) {
+      if (typeof group.title === 'string') {
+        return <ContentHeader title={group.title} />;
+      }
+      return group.title;
+    }
+
+    return <ContentHeader title="Other Templates" />;
+  })();
 
   if (group && maybeFilteredEntities.length === 0) {
     return null;
@@ -85,7 +99,7 @@ export const TemplateList = ({
       )}
 
       <Content>
-        {title}
+        {titleComponent}
         <ItemCardGrid>
           {maybeFilteredEntities &&
             maybeFilteredEntities?.length > 0 &&

plugins/scaffolder/src/components/secrets/SecretsContext.tsx

@@ -48,6 +48,10 @@ export const SecretsContextProvider = ({ children }: PropsWithChildren<{}>) => {
   );
 };
 
+/**
+ * The return type from the useTemplateSecrets hook.
+ * @public
+ */
 export interface ScaffolderUseTemplateSecrets {
   /** @deprecated use setSecrets instead */
   setSecret: (input: Record<string, string>) => void;

plugins/scaffolder/src/components/secrets/index.ts

@@ -14,3 +14,4 @@
  * limitations under the License.
  */
 export { useTemplateSecrets } from './SecretsContext';
+export type { ScaffolderUseTemplateSecrets } from './SecretsContext';