chore: updating the api-report

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

plugins/scaffolder/api-report.md

@@ -36,20 +36,7 @@ export function createScaffolderFieldExtension<T = any>(
   options: FieldExtensionOptions<T>,
 ): Extension<() => null>;
 
-// Warning: (ae-missing-release-tag) "CustomFieldExtension" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
-export interface CustomFieldExtension<ReturnValue, UiOptions extends {} = {}>
-  extends FieldProps<ReturnValue> {
-  // (undocumented)
-  uiSchema: {
-    'ui:options'?: UiOptions;
-  };
-}
-
-// Warning: (ae-missing-release-tag) "CustomFieldValidator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export type CustomFieldValidator<T> =
   | ((data: T, field: FieldValidation) => void)
   | ((
@@ -107,9 +94,18 @@ export const EntityTagsPickerFieldExtension: () => null;
 // @public
 export const FavouriteTemplate: (props: Props) => JSX.Element;
 
-// Warning: (ae-missing-release-tag) "FieldExtensionOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
+export interface FieldExtensionComponentProps<
+  ReturnValue,
+  UiOptions extends {} = {},
+> extends FieldProps<ReturnValue> {
+  // (undocumented)
+  uiSchema: {
+    'ui:options'?: UiOptions;
+  };
+}
+
+// @public
 export type FieldExtensionOptions<T = any> = {
   name: string;
   component: (props: FieldProps<T>) => JSX.Element | null;
@@ -157,7 +153,7 @@ export const RepoUrlPicker: ({
   onChange,
   rawErrors,
   formData,
-}: CustomFieldExtension<string, RepoUrlPickerUiOptions>) => JSX.Element;
+}: FieldExtensionComponentProps<string, RepoUrlPickerUiOptions>) => JSX.Element;
 
 // Warning: (ae-missing-release-tag) "RepoUrlPickerFieldExtension" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //

plugins/scaffolder/src/extensions/types.ts

@@ -16,6 +16,11 @@
 import { ApiHolder } from '@backstage/core-plugin-api';
 import { FieldValidation, FieldProps } from '@rjsf/core';
 
+/**
+ * Field validation type for Custom Field Extensions.
+ *
+ * @public
+ */
 export type CustomFieldValidator<T> =
   | ((data: T, field: FieldValidation) => void)
   | ((
@@ -24,12 +29,24 @@ export type CustomFieldValidator<T> =
       context: { apiHolder: ApiHolder },
     ) => void);
 
+/**
+ * Type for the Custom Field Extension with the
+ * name and components and validation function.
+ *
+ * @public
+ */
 export type FieldExtensionOptions<T = any> = {
   name: string;
   component: (props: FieldProps<T>) => JSX.Element | null;
   validation?: CustomFieldValidator<T>;
 };
 
+/**
+ * Type for field extensions and being able to type
+ * incoming props easier.
+ *
+ * @public
+ */
 export interface FieldExtensionComponentProps<
   ReturnValue,
   UiOptions extends {} = {},

plugins/scaffolder/src/index.ts

@@ -29,7 +29,7 @@ export {
 export type {
   CustomFieldValidator,
   FieldExtensionOptions,
-  CustomFieldExtension,
+  FieldExtensionComponentProps,
 } from './extensions';
 export {
   EntityPickerFieldExtension,