chore: some more migrations

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-08-15 15:22:16 +02:00
parent d2e999e402
commit 75e79518ea
5 changed files with 221 additions and 181 deletions
+93 -77
View File
@@ -18,12 +18,11 @@ import React from 'react';
import LibraryBooks from '@material-ui/icons/LibraryBooks';
import {
createFrontendPlugin,
createSchemaFromZod,
createApiExtension,
createPageExtension,
createNavItemExtension,
ApiBlueprint,
PageBlueprint,
NavItemBlueprint,
} from '@backstage/frontend-plugin-api';
import { createSearchResultListItemExtension } from '@backstage/plugin-search-react/alpha';
import { SearchResultListItemBlueprint } from '@backstage/plugin-search-react/alpha';
import {
configApiRef,
createApiFactory,
@@ -45,64 +44,73 @@ import {
rootDocsRouteRef,
rootRouteRef,
} from './routes';
import { createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';
import { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';
/** @alpha */
const techDocsStorageApi = createApiExtension({
factory: createApiFactory({
api: techdocsStorageApiRef,
deps: {
configApi: configApiRef,
discoveryApi: discoveryApiRef,
fetchApi: fetchApiRef,
},
factory: ({ configApi, discoveryApi, fetchApi }) =>
new TechDocsStorageClient({
configApi,
discoveryApi,
fetchApi,
}),
}),
const techDocsStorageApi = ApiBlueprint.make({
name: 'storage',
params: {
factory: createApiFactory({
api: techdocsStorageApiRef,
deps: {
configApi: configApiRef,
discoveryApi: discoveryApiRef,
fetchApi: fetchApiRef,
},
factory: ({ configApi, discoveryApi, fetchApi }) =>
new TechDocsStorageClient({
configApi,
discoveryApi,
fetchApi,
}),
}),
},
});
/** @alpha */
const techDocsClientApi = createApiExtension({
factory: createApiFactory({
api: techdocsApiRef,
deps: {
configApi: configApiRef,
discoveryApi: discoveryApiRef,
fetchApi: fetchApiRef,
},
factory: ({ configApi, discoveryApi, fetchApi }) =>
new TechDocsClient({
configApi,
discoveryApi,
fetchApi,
}),
}),
const techDocsClientApi = ApiBlueprint.make({
params: {
factory: createApiFactory({
api: techdocsApiRef,
deps: {
configApi: configApiRef,
discoveryApi: discoveryApiRef,
fetchApi: fetchApiRef,
},
factory: ({ configApi, discoveryApi, fetchApi }) =>
new TechDocsClient({
configApi,
discoveryApi,
fetchApi,
}),
}),
},
});
/** @alpha */
export const techDocsSearchResultListItemExtension =
createSearchResultListItemExtension({
configSchema: createSchemaFromZod(z =>
z.object({
// TODO: Define how the icon can be configurable
title: z.string().optional(),
lineClamp: z.number().default(5),
asLink: z.boolean().default(true),
asListItem: z.boolean().default(true),
noTrack: z.boolean().default(false),
}),
),
predicate: result => result.type === 'techdocs',
component: async ({ config }) => {
const { TechDocsSearchResultListItem } = await import(
'./search/components/TechDocsSearchResultListItem'
);
return props =>
compatWrapper(<TechDocsSearchResultListItem {...props} {...config} />);
SearchResultListItemBlueprint.makeWithOverrides({
config: {
schema: {
title: z => z.string().optional(),
lineClamp: z => z.number().default(5),
asLink: z => z.boolean().default(true),
asListItem: z => z.boolean().default(true),
},
},
factory(originalFactory, { config }) {
return originalFactory({
predicate: result => result.type === 'techdocs',
component: async () => {
const { TechDocsSearchResultListItem } = await import(
'./search/components/TechDocsSearchResultListItem'
);
return props =>
compatWrapper(
<TechDocsSearchResultListItem {...props} {...config} />,
);
},
});
},
});
@@ -111,13 +119,15 @@ export const techDocsSearchResultListItemExtension =
*
* @alpha
*/
const techDocsPage = createPageExtension({
defaultPath: '/docs',
routeRef: convertLegacyRouteRef(rootRouteRef),
loader: () =>
import('./home/components/TechDocsIndexPage').then(m =>
compatWrapper(<m.TechDocsIndexPage />),
),
const techDocsPage = PageBlueprint.make({
params: {
defaultPath: '/docs',
routeRef: convertLegacyRouteRef(rootRouteRef),
loader: () =>
import('./home/components/TechDocsIndexPage').then(m =>
compatWrapper(<m.TechDocsIndexPage />),
),
},
});
/**
@@ -125,14 +135,16 @@ const techDocsPage = createPageExtension({
*
* @alpha
*/
const techDocsReaderPage = createPageExtension({
const techDocsReaderPage = PageBlueprint.make({
name: 'reader',
defaultPath: '/docs/:namespace/:kind/:name',
routeRef: convertLegacyRouteRef(rootDocsRouteRef),
loader: () =>
import('./reader/components/TechDocsReaderPage').then(m =>
compatWrapper(<m.TechDocsReaderPage />),
),
params: {
defaultPath: '/docs/:namespace/:kind/:name',
routeRef: convertLegacyRouteRef(rootDocsRouteRef),
loader: () =>
import('./reader/components/TechDocsReaderPage').then(m =>
compatWrapper(<m.TechDocsReaderPage />),
),
},
});
/**
@@ -140,18 +152,22 @@ const techDocsReaderPage = createPageExtension({
*
* @alpha
*/
const techDocsEntityContent = createEntityContentExtension({
defaultPath: 'docs',
defaultTitle: 'TechDocs',
loader: () =>
import('./Router').then(m => compatWrapper(<m.EmbeddedDocsRouter />)),
const techDocsEntityContent = EntityContentBlueprint.make({
params: {
defaultPath: 'docs',
defaultTitle: 'TechDocs',
loader: () =>
import('./Router').then(m => compatWrapper(<m.EmbeddedDocsRouter />)),
},
});
/** @alpha */
const techDocsNavItem = createNavItemExtension({
icon: LibraryBooks,
title: 'Docs',
routeRef: convertLegacyRouteRef(rootRouteRef),
const techDocsNavItem = NavItemBlueprint.make({
params: {
icon: LibraryBooks,
title: 'Docs',
routeRef: convertLegacyRouteRef(rootRouteRef),
},
});
/** @alpha */