From e233cb50a345459ef174c75c4a666c386f9cd93e Mon Sep 17 00:00:00 2001 From: nikolar Date: Thu, 19 Dec 2024 17:42:57 -0800 Subject: [PATCH 1/4] add missing exports Signed-off-by: nikolar --- plugins/home/report.api.md | 5 ++++ plugins/home/src/index.ts | 1 + plugins/scaffolder-react/report-alpha.api.md | 8 +++---- plugins/scaffolder-react/report.api.md | 24 +++++++++++++++++++ plugins/scaffolder-react/src/index.ts | 6 +++++ .../src/next/components/Stepper/Stepper.tsx | 2 +- .../TemplateCategoryPicker.tsx | 2 +- .../src/next/overridableComponents.ts | 4 ++-- 8 files changed, 44 insertions(+), 8 deletions(-) diff --git a/plugins/home/report.api.md b/plugins/home/report.api.md index 878d8ef646..1cff56f50c 100644 --- a/plugins/home/report.api.md +++ b/plugins/home/report.api.md @@ -187,6 +187,11 @@ export type LayoutConfiguration = { // @public export type Operators = '<' | '<=' | '==' | '!=' | '>' | '>=' | 'contains'; +// @public +export const QuickStartCard: ( + props: CardExtensionProps_2, +) => JSX_2.Element; + // @public export type QuickStartCardProps = { modalTitle?: string | React_2.JSX.Element; diff --git a/plugins/home/src/index.ts b/plugins/home/src/index.ts index 154186f169..3a6f152d03 100644 --- a/plugins/home/src/index.ts +++ b/plugins/home/src/index.ts @@ -35,6 +35,7 @@ export { HomePageTopVisited, HomePageRecentlyVisited, FeaturedDocsCard, + QuickStartCard, } from './plugin'; export * from './components'; export * from './assets'; diff --git a/plugins/scaffolder-react/report-alpha.api.md b/plugins/scaffolder-react/report-alpha.api.md index 4f9f86d1ac..11c2d11378 100644 --- a/plugins/scaffolder-react/report-alpha.api.md +++ b/plugins/scaffolder-react/report-alpha.api.md @@ -46,14 +46,14 @@ import { UiSchema } from '@rjsf/utils'; import { WidgetProps } from '@rjsf/utils'; import { z } from 'zod'; -// @alpha (undocumented) +// @public (undocumented) export type BackstageOverrides = Overrides & { [Name in keyof ScaffolderReactComponentsNameToClassKey]?: Partial< StyleRules >; }; -// @alpha (undocumented) +// @public (undocumented) export type BackstageTemplateStepperClassKey = | 'backButton' | 'footer' @@ -296,13 +296,13 @@ export type ScaffolderPageContextMenuProps = { onCreateClicked?: () => void; }; -// @alpha (undocumented) +// @public (undocumented) export type ScaffolderReactComponentsNameToClassKey = { ScaffolderReactTemplateCategoryPicker: ScaffolderReactTemplateCategoryPickerClassKey; BackstageTemplateStepper: BackstageTemplateStepperClassKey; }; -// @alpha (undocumented) +// @public (undocumented) export type ScaffolderReactTemplateCategoryPickerClassKey = 'root' | 'label'; // @alpha diff --git a/plugins/scaffolder-react/report.api.md b/plugins/scaffolder-react/report.api.md index 8a6b4739a4..c733b142c0 100644 --- a/plugins/scaffolder-react/report.api.md +++ b/plugins/scaffolder-react/report.api.md @@ -27,6 +27,7 @@ import { JsonObject } from '@backstage/types'; import { JSONSchema7 } from 'json-schema'; import { JsonValue } from '@backstage/types'; import { Observable } from '@backstage/types'; +import { Overrides } from '@material-ui/core/styles/overrides'; import { PropsWithChildren } from 'react'; import { default as React_2 } from 'react'; import { ReactNode } from 'react'; @@ -36,6 +37,7 @@ import { RegistryWidgetsType } from '@rjsf/utils'; import { RJSFSchema } from '@rjsf/utils'; import { RJSFValidationError } from '@rjsf/utils'; import { StrictRJSFSchema } from '@rjsf/utils'; +import { StyleRules } from '@material-ui/core/styles/withStyles'; import { TaskSpec } from '@backstage/plugin-scaffolder-common'; import { TaskStep } from '@backstage/plugin-scaffolder-common'; import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common'; @@ -63,6 +65,19 @@ export type ActionExample = { example: string; }; +// @public (undocumented) +export type BackstageOverrides = Overrides & { + [Name in keyof ScaffolderReactComponentsNameToClassKey]?: Partial< + StyleRules + >; +}; + +// @public (undocumented) +export type BackstageTemplateStepperClassKey = + | 'backButton' + | 'footer' + | 'formWrapper'; + // @public export function createScaffolderFieldExtension< TReturnValue = unknown, @@ -325,6 +340,15 @@ export type ScaffolderOutputText = { default?: boolean; }; +// @public (undocumented) +export type ScaffolderReactComponentsNameToClassKey = { + ScaffolderReactTemplateCategoryPicker: ScaffolderReactTemplateCategoryPickerClassKey; + BackstageTemplateStepper: BackstageTemplateStepperClassKey; +}; + +// @public (undocumented) +export type ScaffolderReactTemplateCategoryPickerClassKey = 'root' | 'label'; + // @public export type ScaffolderRJSFField< T = any, diff --git a/plugins/scaffolder-react/src/index.ts b/plugins/scaffolder-react/src/index.ts index e73df50fce..69bb70598c 100644 --- a/plugins/scaffolder-react/src/index.ts +++ b/plugins/scaffolder-react/src/index.ts @@ -22,3 +22,9 @@ export * from './api'; export * from './hooks'; export * from './layouts'; export * from './utils'; +export type { + BackstageOverrides, + ScaffolderReactComponentsNameToClassKey, + ScaffolderReactTemplateCategoryPickerClassKey, + BackstageTemplateStepperClassKey, +} from './next'; diff --git a/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx b/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx index 0b4cbbc94a..fd5d394ef6 100644 --- a/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx +++ b/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx @@ -56,7 +56,7 @@ import { merge } from 'lodash'; const validator = customizeValidator(); ajvErrors(validator.ajv); -/** @alpha */ +/** @public */ export type BackstageTemplateStepperClassKey = | 'backButton' | 'footer' diff --git a/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx b/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx index f2505ec148..335f51b3e1 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx @@ -33,7 +33,7 @@ import { alertApiRef, useApi } from '@backstage/core-plugin-api'; const icon = ; const checkedIcon = ; -/** @alpha */ +/** @public */ export type ScaffolderReactTemplateCategoryPickerClassKey = 'root' | 'label'; const useStyles = makeStyles( diff --git a/plugins/scaffolder-react/src/next/overridableComponents.ts b/plugins/scaffolder-react/src/next/overridableComponents.ts index 2045496166..d35a70b4bf 100644 --- a/plugins/scaffolder-react/src/next/overridableComponents.ts +++ b/plugins/scaffolder-react/src/next/overridableComponents.ts @@ -19,13 +19,13 @@ import { StyleRules } from '@material-ui/core/styles/withStyles'; import { ScaffolderReactTemplateCategoryPickerClassKey } from './components/TemplateCategoryPicker/TemplateCategoryPicker'; import { BackstageTemplateStepperClassKey } from './components/Stepper/Stepper'; -/** @alpha */ +/** @public */ export type ScaffolderReactComponentsNameToClassKey = { ScaffolderReactTemplateCategoryPicker: ScaffolderReactTemplateCategoryPickerClassKey; BackstageTemplateStepper: BackstageTemplateStepperClassKey; }; -/** @alpha */ +/** @public */ export type BackstageOverrides = Overrides & { [Name in keyof ScaffolderReactComponentsNameToClassKey]?: Partial< StyleRules From 7932f1e03f5b80ddf41693b8507c86169904d284 Mon Sep 17 00:00:00 2001 From: nikolar Date: Thu, 19 Dec 2024 17:54:02 -0800 Subject: [PATCH 2/4] add changeset Signed-off-by: nikolar --- .changeset/big-seals-drum.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .changeset/big-seals-drum.md diff --git a/.changeset/big-seals-drum.md b/.changeset/big-seals-drum.md new file mode 100644 index 0000000000..27af4e6ee9 --- /dev/null +++ b/.changeset/big-seals-drum.md @@ -0,0 +1,13 @@ +--- +'@backstage/plugin-scaffolder-react': patch +'@backstage/plugin-home': patch +--- + +Added missing exports to surface recently added plugin changes as follows: +`@backstage/plugin-scaffolder-react` + +- add exports needed to override template styles for `BackstageTemplateStepper` and `ScaffolderReactTemplateCategoryPicker` + +`@backstage/plugin-home` + +- add exports needed to have a valid `import { QuickStartCard } from '@backstage/plugin-home';` From 9f268f466c7ea948fbed74460776dc76e61e238e Mon Sep 17 00:00:00 2001 From: nikolar Date: Fri, 20 Dec 2024 10:27:38 -0800 Subject: [PATCH 3/4] remove scaffolder changes Signed-off-by: nikolar --- .changeset/big-seals-drum.md | 8 +------ plugins/scaffolder-react/report-alpha.api.md | 8 +++---- plugins/scaffolder-react/report.api.md | 24 ------------------- plugins/scaffolder-react/src/index.ts | 6 ----- .../src/next/components/Stepper/Stepper.tsx | 2 +- .../TemplateCategoryPicker.tsx | 2 +- .../src/next/overridableComponents.ts | 4 ++-- 7 files changed, 9 insertions(+), 45 deletions(-) diff --git a/.changeset/big-seals-drum.md b/.changeset/big-seals-drum.md index 27af4e6ee9..df13cdf687 100644 --- a/.changeset/big-seals-drum.md +++ b/.changeset/big-seals-drum.md @@ -1,13 +1,7 @@ --- -'@backstage/plugin-scaffolder-react': patch '@backstage/plugin-home': patch --- -Added missing exports to surface recently added plugin changes as follows: -`@backstage/plugin-scaffolder-react` - -- add exports needed to override template styles for `BackstageTemplateStepper` and `ScaffolderReactTemplateCategoryPicker` - -`@backstage/plugin-home` +Added missing exports to surface recently added plugin in `@backstage/plugin-home` - add exports needed to have a valid `import { QuickStartCard } from '@backstage/plugin-home';` diff --git a/plugins/scaffolder-react/report-alpha.api.md b/plugins/scaffolder-react/report-alpha.api.md index 11c2d11378..4f9f86d1ac 100644 --- a/plugins/scaffolder-react/report-alpha.api.md +++ b/plugins/scaffolder-react/report-alpha.api.md @@ -46,14 +46,14 @@ import { UiSchema } from '@rjsf/utils'; import { WidgetProps } from '@rjsf/utils'; import { z } from 'zod'; -// @public (undocumented) +// @alpha (undocumented) export type BackstageOverrides = Overrides & { [Name in keyof ScaffolderReactComponentsNameToClassKey]?: Partial< StyleRules >; }; -// @public (undocumented) +// @alpha (undocumented) export type BackstageTemplateStepperClassKey = | 'backButton' | 'footer' @@ -296,13 +296,13 @@ export type ScaffolderPageContextMenuProps = { onCreateClicked?: () => void; }; -// @public (undocumented) +// @alpha (undocumented) export type ScaffolderReactComponentsNameToClassKey = { ScaffolderReactTemplateCategoryPicker: ScaffolderReactTemplateCategoryPickerClassKey; BackstageTemplateStepper: BackstageTemplateStepperClassKey; }; -// @public (undocumented) +// @alpha (undocumented) export type ScaffolderReactTemplateCategoryPickerClassKey = 'root' | 'label'; // @alpha diff --git a/plugins/scaffolder-react/report.api.md b/plugins/scaffolder-react/report.api.md index c733b142c0..8a6b4739a4 100644 --- a/plugins/scaffolder-react/report.api.md +++ b/plugins/scaffolder-react/report.api.md @@ -27,7 +27,6 @@ import { JsonObject } from '@backstage/types'; import { JSONSchema7 } from 'json-schema'; import { JsonValue } from '@backstage/types'; import { Observable } from '@backstage/types'; -import { Overrides } from '@material-ui/core/styles/overrides'; import { PropsWithChildren } from 'react'; import { default as React_2 } from 'react'; import { ReactNode } from 'react'; @@ -37,7 +36,6 @@ import { RegistryWidgetsType } from '@rjsf/utils'; import { RJSFSchema } from '@rjsf/utils'; import { RJSFValidationError } from '@rjsf/utils'; import { StrictRJSFSchema } from '@rjsf/utils'; -import { StyleRules } from '@material-ui/core/styles/withStyles'; import { TaskSpec } from '@backstage/plugin-scaffolder-common'; import { TaskStep } from '@backstage/plugin-scaffolder-common'; import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common'; @@ -65,19 +63,6 @@ export type ActionExample = { example: string; }; -// @public (undocumented) -export type BackstageOverrides = Overrides & { - [Name in keyof ScaffolderReactComponentsNameToClassKey]?: Partial< - StyleRules - >; -}; - -// @public (undocumented) -export type BackstageTemplateStepperClassKey = - | 'backButton' - | 'footer' - | 'formWrapper'; - // @public export function createScaffolderFieldExtension< TReturnValue = unknown, @@ -340,15 +325,6 @@ export type ScaffolderOutputText = { default?: boolean; }; -// @public (undocumented) -export type ScaffolderReactComponentsNameToClassKey = { - ScaffolderReactTemplateCategoryPicker: ScaffolderReactTemplateCategoryPickerClassKey; - BackstageTemplateStepper: BackstageTemplateStepperClassKey; -}; - -// @public (undocumented) -export type ScaffolderReactTemplateCategoryPickerClassKey = 'root' | 'label'; - // @public export type ScaffolderRJSFField< T = any, diff --git a/plugins/scaffolder-react/src/index.ts b/plugins/scaffolder-react/src/index.ts index 69bb70598c..e73df50fce 100644 --- a/plugins/scaffolder-react/src/index.ts +++ b/plugins/scaffolder-react/src/index.ts @@ -22,9 +22,3 @@ export * from './api'; export * from './hooks'; export * from './layouts'; export * from './utils'; -export type { - BackstageOverrides, - ScaffolderReactComponentsNameToClassKey, - ScaffolderReactTemplateCategoryPickerClassKey, - BackstageTemplateStepperClassKey, -} from './next'; diff --git a/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx b/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx index fd5d394ef6..0b4cbbc94a 100644 --- a/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx +++ b/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx @@ -56,7 +56,7 @@ import { merge } from 'lodash'; const validator = customizeValidator(); ajvErrors(validator.ajv); -/** @public */ +/** @alpha */ export type BackstageTemplateStepperClassKey = | 'backButton' | 'footer' diff --git a/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx b/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx index 335f51b3e1..f2505ec148 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.tsx @@ -33,7 +33,7 @@ import { alertApiRef, useApi } from '@backstage/core-plugin-api'; const icon = ; const checkedIcon = ; -/** @public */ +/** @alpha */ export type ScaffolderReactTemplateCategoryPickerClassKey = 'root' | 'label'; const useStyles = makeStyles( diff --git a/plugins/scaffolder-react/src/next/overridableComponents.ts b/plugins/scaffolder-react/src/next/overridableComponents.ts index d35a70b4bf..2045496166 100644 --- a/plugins/scaffolder-react/src/next/overridableComponents.ts +++ b/plugins/scaffolder-react/src/next/overridableComponents.ts @@ -19,13 +19,13 @@ import { StyleRules } from '@material-ui/core/styles/withStyles'; import { ScaffolderReactTemplateCategoryPickerClassKey } from './components/TemplateCategoryPicker/TemplateCategoryPicker'; import { BackstageTemplateStepperClassKey } from './components/Stepper/Stepper'; -/** @public */ +/** @alpha */ export type ScaffolderReactComponentsNameToClassKey = { ScaffolderReactTemplateCategoryPicker: ScaffolderReactTemplateCategoryPickerClassKey; BackstageTemplateStepper: BackstageTemplateStepperClassKey; }; -/** @public */ +/** @alpha */ export type BackstageOverrides = Overrides & { [Name in keyof ScaffolderReactComponentsNameToClassKey]?: Partial< StyleRules From 9a806f050d3d40f4035f38a9732f5c61ea708759 Mon Sep 17 00:00:00 2001 From: nikolar Date: Fri, 20 Dec 2024 21:58:56 -0800 Subject: [PATCH 4/4] update changeset Signed-off-by: nikolar --- .changeset/big-seals-drum.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.changeset/big-seals-drum.md b/.changeset/big-seals-drum.md index df13cdf687..9b4ab16701 100644 --- a/.changeset/big-seals-drum.md +++ b/.changeset/big-seals-drum.md @@ -2,6 +2,4 @@ '@backstage/plugin-home': patch --- -Added missing exports to surface recently added plugin in `@backstage/plugin-home` - -- add exports needed to have a valid `import { QuickStartCard } from '@backstage/plugin-home';` +Exported `QuickStartCard` component.