Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@red-hat-developer-hub/backstage-plugin-quickstart': minor
---

Graduate the New Frontend System (NFS) plugin from the `./alpha` export to the primary `./` entry point. OFS (legacy) exports are now available at `./legacy`. Translations remain at `./alpha`.
2 changes: 1 addition & 1 deletion workspaces/quickstart/packages/app-legacy/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ import { CatalogGraphPage } from '@backstage/plugin-catalog-graph';
import { RequirePermission } from '@backstage/plugin-permission-react';
import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
import { getAllThemes } from '@red-hat-developer-hub/backstage-plugin-theme';
import { quickstartTranslations } from '@red-hat-developer-hub/backstage-plugin-quickstart';
import { quickstartTranslations } from '@red-hat-developer-hub/backstage-plugin-quickstart/legacy';
import { githubAuthApiRef } from '@backstage/core-plugin-api';
import { RbacPage } from '@backstage-community/plugin-rbac';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@

import { SidebarItem } from '@backstage/core-components';
import WavingHandOutlinedIcon from '@mui/icons-material/WavingHandOutlined';
import { useQuickstartDrawerContext } from '@red-hat-developer-hub/backstage-plugin-quickstart';
import { useQuickstartDrawerContext } from '@red-hat-developer-hub/backstage-plugin-quickstart/legacy';

Check warning on line 19 in workspaces/quickstart/packages/app-legacy/src/components/Root/QuickstartSidebarItem.tsx

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

'@red-hat-developer-hub/backstage-plugin-quickstart/legacy' imported multiple times.

See more on https://sonarcloud.io/project/issues?id=redhat-developer_rhdh-plugins&issues=AZ7vqYJTIn8fCMBIAEau&open=AZ7vqYJTIn8fCMBIAEau&pullRequest=3530
import { configApiRef, useApi } from '@backstage/core-plugin-api';
import { useMemo } from 'react';
import {
filterQuickstartItemsByRole,
QuickstartItemData,
} from '@red-hat-developer-hub/backstage-plugin-quickstart';
} from '@red-hat-developer-hub/backstage-plugin-quickstart/legacy';

Check warning on line 25 in workspaces/quickstart/packages/app-legacy/src/components/Root/QuickstartSidebarItem.tsx

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

'@red-hat-developer-hub/backstage-plugin-quickstart/legacy' imported multiple times.

See more on https://sonarcloud.io/project/issues?id=redhat-developer_rhdh-plugins&issues=AZ7vqYJTIn8fCMBIAEav&open=AZ7vqYJTIn8fCMBIAEav&pullRequest=3530

export const QuickstartSidebarItem = () => {
const configApi = useApi(configApiRef);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import {
QuickstartDrawerProvider,
QuickstartDrawerContent,
QuickstartDrawerStateExposer,
} from '@red-hat-developer-hub/backstage-plugin-quickstart';
} from '@red-hat-developer-hub/backstage-plugin-quickstart/legacy';
import { QuickstartSidebarItem } from './QuickstartSidebarItem';
import { Administration } from '@backstage-community/plugin-rbac';
import { ApplicationDrawer } from './ApplicationDrawer';
Expand Down
2 changes: 1 addition & 1 deletion workspaces/quickstart/packages/app/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
import {
quickstartInitModule,
quickstartTranslationsModule,
} from '@red-hat-developer-hub/backstage-plugin-quickstart/alpha';
} from '@red-hat-developer-hub/backstage-plugin-quickstart';
import { rhdhThemeModule } from '@red-hat-developer-hub/backstage-plugin-theme/alpha';
import { navModule } from './modules/nav';

Expand Down
30 changes: 22 additions & 8 deletions workspaces/quickstart/plugins/quickstart/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"name": "@red-hat-developer-hub/backstage-plugin-quickstart",
"version": "1.9.7",
"license": "Apache-2.0",
"main": "src/index.ts",
"types": "src/index.ts",
"main": "src/index.tsx",
"types": "src/index.tsx",
"publishConfig": {
"access": "public"
},
Expand Down Expand Up @@ -71,15 +71,27 @@
"react-router-dom": "^6.0.0"
},
"exports": {
".": "./src/index.ts",
"./alpha": "./src/alpha/index.tsx",
".": "./src/index.tsx",
"./alpha": "./src/alphaExports.ts",
"./legacy": "./src/legacyExports.ts",
"./quickstart-init-module": "./src/quickstartInitModuleExport.ts",
"./quickstart-translations-module": "./src/quickstartTranslationsModuleExport.ts",
"./dev": "./dev/CustomDrawer.tsx",
"./package.json": "./package.json"
},
"typesVersions": {
"*": {
"alpha": [
"src/alpha/index.tsx"
"src/alphaExports.ts"
],
"legacy": [
"src/legacyExports.ts"
],
"quickstart-init-module": [
"src/quickstartInitModuleExport.ts"
],
"quickstart-translations-module": [
"src/quickstartTranslationsModuleExport.ts"
],
"dev": [
"dev/CustomDrawer.tsx"
Expand All @@ -98,9 +110,11 @@
"scalprum": {
"name": "red-hat-developer-hub.backstage-plugin-quickstart",
"exposedModules": {
"Alpha": "./src/alpha/index.tsx",
"PluginRoot": "./src/index.ts",
"QuickstartPlugin": "./src/index.ts"
"PluginRoot": "./src/index.tsx",
"Alpha": "./src/alphaExports.ts",
"Legacy": "./src/legacyExports.ts",
"QuickstartInitModule": "./src/quickstartInitModuleExport.ts",
"QuickstartTranslationsModule": "./src/quickstartTranslationsModuleExport.ts"
}
},
"configSchema": "config.d.ts",
Expand Down
76 changes: 0 additions & 76 deletions workspaces/quickstart/plugins/quickstart/report-alpha.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,82 +3,9 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts
import { AppDrawerContent } from '@red-hat-developer-hub/backstage-plugin-app-react';
import { ExtensionDataRef } from '@backstage/frontend-plugin-api';
import { FrontendModule } from '@backstage/frontend-plugin-api';
import { GlobalHeaderMenuItemData } from '@red-hat-developer-hub/backstage-plugin-global-header/alpha';
import { MenuItemParams } from '@red-hat-developer-hub/backstage-plugin-global-header/alpha';
import { OverridableExtensionDefinition } from '@backstage/frontend-plugin-api';
import { OverridableFrontendPlugin } from '@backstage/frontend-plugin-api';
import { TranslationRef } from '@backstage/frontend-plugin-api';
import { TranslationResource } from '@backstage/frontend-plugin-api';

// @alpha
const _default: OverridableFrontendPlugin<
{},
{},
{
'app-drawer-content:quickstart/quickstart': OverridableExtensionDefinition<{
kind: 'app-drawer-content';
name: 'quickstart';
config: {
defaultWidth: number | undefined;
resizable: boolean | undefined;
priority: number | undefined;
};
configInput: {
defaultWidth?: number | undefined;
resizable?: boolean | undefined;
priority?: number | undefined;
};
output: ExtensionDataRef<AppDrawerContent, 'app.drawer.content', {}>;
inputs: {};
params: {
id: string;
element: React.ReactElement;
resizable?: boolean;
defaultWidth?: number;
priority?: number;
};
}>;
'gh-menu-item:quickstart/quickstart': OverridableExtensionDefinition<{
kind: 'gh-menu-item';
name: 'quickstart';
config: {
priority: number | undefined;
title: string | undefined;
titleKey: string | undefined;
icon: string | undefined;
link: string | undefined;
sectionLabel: string | undefined;
sectionLink: string | undefined;
sectionLinkLabel: string | undefined;
};
configInput: {
link?: string | undefined;
title?: string | undefined;
icon?: string | undefined;
titleKey?: string | undefined;
priority?: number | undefined;
sectionLabel?: string | undefined;
sectionLink?: string | undefined;
sectionLinkLabel?: string | undefined;
};
output: ExtensionDataRef<
GlobalHeaderMenuItemData,
'global-header.menu-item',
{}
>;
inputs: {};
params: MenuItemParams;
}>;
}
>;
export default _default;

// @alpha
export const quickstartInitModule: FrontendModule;

// @public
export const quickstartTranslationRef: TranslationRef<
'plugin.quickstart',
Expand Down Expand Up @@ -146,8 +73,5 @@ export const quickstartTranslationRef: TranslationRef<
// @public
export const quickstartTranslations: TranslationResource<'plugin.quickstart'>;

// @alpha
export const quickstartTranslationsModule: FrontendModule;

// (No @packageDocumentation comment for this package)
```
165 changes: 165 additions & 0 deletions workspaces/quickstart/plugins/quickstart/report-legacy.api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
## API Report File for "@red-hat-developer-hub/backstage-plugin-quickstart"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CSSProperties } from 'react';
import { JSX as JSX_2 } from 'react/jsx-runtime';
import { PropsWithChildren } from 'react';
import { TranslationRef } from '@backstage/frontend-plugin-api';
import { TranslationResource } from '@backstage/frontend-plugin-api';

// @public
export type DrawerPartialState = {
id: string;
isDrawerOpen: boolean;
drawerWidth: number;
setDrawerWidth: (width: number) => void;
closeDrawer: () => void;
};

// @public
export type DrawerStateExposerProps = {
onStateChange: (state: DrawerPartialState) => void;
};

// @public
export const filterQuickstartItemsByRole: (
items: QuickstartItemData[],
userRole: string,
) => QuickstartItemData[];

// @public
export const QuickstartButton: (
input: QuickstartButtonProps,
) => JSX_2.Element | null;

// @public
export interface QuickstartButtonProps {
onClick?: () => void;
style?: CSSProperties;
title?: string;
}

// @public
export const QuickstartDrawerContent: () => JSX_2.Element | null;

// @public
export interface QuickstartDrawerContextType {
closeDrawer: () => void;
drawerWidth: number;
isDrawerOpen: boolean;
openDrawer: () => void;
roleLoading: boolean;
setDrawerWidth: React.Dispatch<React.SetStateAction<number>>;
toggleDrawer: () => void;
userRole: UserRole | null;
}

// @public
export const QuickstartDrawerProvider: (
input: PropsWithChildren,
) => JSX_2.Element;

// @public
export const QuickstartDrawerStateExposer: (
input: DrawerStateExposerProps,
) => null;

// @public
export interface QuickstartItemCtaData {
link: string;
text: string;
textKey?: string;
}

// @public
export interface QuickstartItemData {
cta?: QuickstartItemCtaData;
description: string;
descriptionKey?: string;
icon?: string;
roles?: string[];
title: string;
titleKey?: string;
}

// @public
export const quickstartPlugin: BackstagePlugin<{}, {}, {}>;

// @public
export const quickstartTranslationRef: TranslationRef<
'plugin.quickstart',
{
readonly 'header.title': string;
readonly 'header.subtitle': string;
readonly 'steps.setupAuthentication.title': string;
readonly 'steps.setupAuthentication.description': string;
readonly 'steps.setupAuthentication.ctaTitle': string;
readonly 'steps.configureRbac.title': string;
readonly 'steps.configureRbac.description': string;
readonly 'steps.configureRbac.ctaTitle': string;
readonly 'steps.configureGit.title': string;
readonly 'steps.configureGit.description': string;
readonly 'steps.configureGit.ctaTitle': string;
readonly 'steps.managePlugins.title': string;
readonly 'steps.managePlugins.description': string;
readonly 'steps.managePlugins.ctaTitle': string;
readonly 'steps.importApplication.title': string;
readonly 'steps.importApplication.description': string;
readonly 'steps.importApplication.ctaTitle': string;
readonly 'steps.learnAboutCatalog.title': string;
readonly 'steps.learnAboutCatalog.description': string;
readonly 'steps.learnAboutCatalog.ctaTitle': string;
readonly 'steps.exploreSelfServiceTemplates.title': string;
readonly 'steps.exploreSelfServiceTemplates.description': string;
readonly 'steps.exploreSelfServiceTemplates.ctaTitle': string;
readonly 'steps.findAllLearningPaths.title': string;
readonly 'steps.findAllLearningPaths.description': string;
readonly 'steps.findAllLearningPaths.ctaTitle': string;
readonly 'steps.setupLightspeed.title': string;
readonly 'steps.setupLightspeed.description': string;
readonly 'steps.setupLightspeed.ctaTitle': string;
readonly 'steps.getStartedWithLightspeed.title': string;
readonly 'steps.getStartedWithLightspeed.description': string;
readonly 'steps.getStartedWithLightspeed.ctaTitle': string;
readonly 'button.quickstart': string;
readonly 'button.openQuickstartGuide': string;
readonly 'button.closeDrawer': string;
readonly 'button.gotIt': string;
readonly 'snackbar.helpPrompt': string;
readonly 'footer.progress': string;
readonly 'footer.notStarted': string;
readonly 'footer.hide': string;
readonly 'content.emptyState.title': string;
readonly 'item.expandAriaLabel': string;
readonly 'item.collapseAriaLabel': string;
readonly 'item.expandButtonAriaLabel': string;
readonly 'item.collapseButtonAriaLabel': string;
readonly 'dev.pageTitle': string;
readonly 'dev.pageDescription': string;
readonly 'dev.drawerControls': string;
readonly 'dev.currentState': string;
readonly 'dev.stateOpen': string;
readonly 'dev.stateClosed': string;
readonly 'dev.instructions': string;
readonly 'dev.step1': string;
readonly 'dev.step2': string;
readonly 'dev.step3': string;
readonly 'dev.step4': string;
readonly 'dev.step5': string;
}
>;

// @public
export const quickstartTranslations: TranslationResource<'plugin.quickstart'>;

// @public
export const useQuickstartDrawerContext: () => QuickstartDrawerContextType;

// @public
export type UserRole = 'admin' | 'developer';

// (No @packageDocumentation comment for this package)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## API Report File for "@red-hat-developer-hub/backstage-plugin-quickstart"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { FrontendModule } from '@backstage/frontend-plugin-api';

// @public
const quickstartInitModule: FrontendModule;
export default quickstartInitModule;

// (No @packageDocumentation comment for this package)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## API Report File for "@red-hat-developer-hub/backstage-plugin-quickstart"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts
import { FrontendModule } from '@backstage/frontend-plugin-api';

// @public
const quickstartTranslationsModule: FrontendModule;
export default quickstartTranslationsModule;

// (No @packageDocumentation comment for this package)
```
Loading
Loading