paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 42 Packages Projects Releases Wiki Activity

Merge pull request #29090 from backstage/rugvip/ts56

Browse Source 
bump to typescript 5.6
This commit is contained in:
Patrik Oldsberg
2025-03-10 14:45:37 +01:00
committed by GitHub
parent 546a86b3ca 416b62b5aa
commit 7942af3907
102 changed files with 810 additions and 1058 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/brave-wasps-fry.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/create-app': minor
---
Upgraded the TypeScript version in the template to `5.8`.
.changeset/rotten-bees-design.md
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/backend-test-utils': patch
'@backstage/test-utils': patch
---
Moved `@types/jest` to `devDependencies`.
.changeset/thin-books-rest.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog': patch
---
Internal refactor to avoid `expiry-map` dependency.
.yarn/patches/ast-types-npm-0.14.2-43c4ac4b0d.patch
+15
View File
@@ -0,0 +1,15 @@
diff --git a/main.d.ts b/main.d.ts
index 6b9a8d05d61821a7e7dc831a52a9f7b505bfee42..1010bb5352d975a171a4019768ff6f6f2967c301 100644
--- a/main.d.ts
+++ b/main.d.ts
@@ -1,7 +1,7 @@
-import { ASTNode, Type, AnyType, Field } from "./lib/types";
-import { NodePath } from "./lib/node-path";
+import { ASTNode, type Type, AnyType, Field } from "./lib/types";
+import { type NodePath } from "./lib/node-path";
import { namedTypes } from "./gen/namedTypes";
-import { builders } from "./gen/builders";
+import { type builders } from "./gen/builders";
import { Visitor } from "./gen/visitor";
declare const astNodesAreEquivalent: {
(a: any, b: any, problemPath?: any): boolean;
package.json
+4 -2
View File
@@ -103,7 +103,9 @@
"@material-ui/pickers@^3.3.10": "patch:@material-ui/pickers@npm%3A3.3.11#./.yarn/patches/@material-ui-pickers-npm-3.3.11-1c8f68ea20.patch",
"@types/react": "^18.0.0",
"@types/react-dom": "^18.0.0",
"jest-haste-map@^29.7.0": "patch:jest-haste-map@npm%3A29.7.0#./.yarn/patches/jest-haste-map-npm-29.7.0-e3be419eff.patch"
"jest-haste-map@^29.7.0": "patch:jest-haste-map@npm%3A29.7.0#./.yarn/patches/jest-haste-map-npm-29.7.0-e3be419eff.patch",
"ast-types@^0.14.1": "patch:ast-types@npm%3A0.14.2#./.yarn/patches/ast-types-npm-0.14.2-43c4ac4b0d.patch",
"ast-types@0.14.2": "patch:ast-types@npm%3A0.14.2#./.yarn/patches/ast-types-npm-0.14.2-43c4ac4b0d.patch"
},
"dependencies": {
"@backstage/errors": "workspace:^",
@@ -145,7 +147,7 @@
"sloc": "^0.3.1",
"sort-package-json": "^2.8.0",
"typedoc": "^0.27.6",
"typescript": "~5.2.0"
"typescript": "~5.6.0"
},
"packageManager": "yarn@3.8.1",
"engines": {
packages/app-next-example-plugin/report.api.md
+1 -1
View File
@@ -42,7 +42,7 @@ const examplePlugin: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
packages/backend-defaults/report-database.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { DatabaseService } from '@backstage/backend-plugin-api';
import { LifecycleService } from '@backstage/backend-plugin-api';
import { LoggerService } from '@backstage/backend-plugin-api';
packages/backend-defaults/report-httpRouter.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="express" />
import { AuthService } from '@backstage/backend-plugin-api';
import express from 'express';
import { HttpAuthService } from '@backstage/backend-plugin-api';
packages/backend-defaults/report-rootHttpRouter.api.md
-3
View File
@@ -3,9 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="express" />
/// <reference types="node" />
import { Config } from '@backstage/config';
import { CorsOptions } from 'cors';
import { ErrorRequestHandler } from 'express';
packages/backend-defaults/report-urlReader.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AwsCredentialsManager } from '@backstage/integration-aws-node';
import { AwsS3Integration } from '@backstage/integration';
import { AzureBlobStorageIntergation } from '@backstage/integration';
packages/backend-openapi-utils/report-testUtils.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { Express as Express_2 } from 'express';
import { Server } from 'http';
packages/backend-openapi-utils/report.api.md
+1 -1
View File
@@ -96,7 +96,7 @@ export function createValidatedOpenApiRouter<T extends RequiredDoc>(
validatorOptions?: Partial<Parameters<typeof middleware>['0']>;
middleware?: RequestHandler[];
},
): ApiRouter<T>;
): ApiRouter<typeof spec>;
// @public
export function createValidatedOpenApiRouterFromGeneratedEndpointMap<
packages/backend-plugin-api/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AuthorizePermissionRequest } from '@backstage/plugin-permission-common';
import { AuthorizePermissionResponse } from '@backstage/plugin-permission-common';
import { Config } from '@backstage/config';
packages/backend-test-utils/package.json
+1 -3
View File
@@ -75,10 +75,8 @@
},
"devDependencies": {
"@backstage/cli": "workspace:^",
"@types/jest": "*",
"@types/supertest": "^2.0.8",
"supertest": "^7.0.0"
},
"peerDependencies": {
"@types/jest": "*"
}
}
packages/backend-test-utils/report.api.md
-5
View File
@@ -3,11 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="express" />
/// <reference types="jest" />
/// <reference types="node" />
/// <reference types="qs" />
import { AuditorService } from '@backstage/backend-plugin-api';
import { AuthService } from '@backstage/backend-plugin-api';
import { Backend } from '@backstage/backend-app-api';
packages/canon/report.api.md
+2 -4
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { Context } from 'react';
import type { CSSProperties } from 'react';
import { Field as Field_2 } from '@base-ui-components/react/field';
@@ -279,8 +277,8 @@ export const Field: {
children,
className,
...props
}: Field_2.Validity.Props & {
className?: string | undefined;
}: React_2.ComponentPropsWithoutRef<typeof Field_2.Validity> & {
className?: string;
}) => React_2.JSX.Element;
};
packages/core-app-api/report.api.md
+1 -1
View File
@@ -365,7 +365,7 @@ export class ErrorAlerter implements ErrorApi {
// (undocumented)
error$(): Observable<{
error: ErrorApiError;
context?: ErrorApiErrorContext | undefined;
context?: ErrorApiErrorContext;
}>;
// (undocumented)
post(error: ErrorApiError, context?: ErrorApiErrorContext): void;
packages/core-components/report.api.md
+8 -18
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstageIdentityApi } from '@backstage/core-plugin-api';
import { BackstagePalette } from '@backstage/theme';
@@ -968,10 +966,8 @@ export type SidebarContextType = {
// Warning: (ae-missing-release-tag) "SidebarDivider" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const SidebarDivider: React_2.ComponentType<
React_2.ClassAttributes<HTMLHRElement> &
React_2.HTMLAttributes<HTMLHRElement> &
StyledComponentProps<'root'>
export const SidebarDivider: ComponentType<
ComponentProps<'hr'> & StyledComponentProps<'root'>
>;
// Warning: (ae-missing-release-tag) "SidebarDividerClassKey" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -1088,10 +1084,8 @@ export type SidebarProps = {
// Warning: (ae-missing-release-tag) "SidebarScrollWrapper" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const SidebarScrollWrapper: React_2.ComponentType<
React_2.ClassAttributes<HTMLDivElement> &
React_2.HTMLAttributes<HTMLDivElement> &
StyledComponentProps<'root'>
export const SidebarScrollWrapper: ComponentType<
ComponentProps<'div'> & StyledComponentProps<'root'>
>;
// Warning: (ae-forgotten-export) The symbol "SidebarSearchFieldProps" needs to be exported by the entry point index.d.ts
@@ -1105,10 +1099,8 @@ export function SidebarSearchField(
// Warning: (ae-missing-release-tag) "SidebarSpace" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const SidebarSpace: React_2.ComponentType<
React_2.ClassAttributes<HTMLDivElement> &
React_2.HTMLAttributes<HTMLDivElement> &
StyledComponentProps<'root'>
export const SidebarSpace: ComponentType<
ComponentProps<'div'> & StyledComponentProps<'root'>
>;
// Warning: (ae-missing-release-tag) "SidebarSpaceClassKey" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -1119,10 +1111,8 @@ export type SidebarSpaceClassKey = 'root';
// Warning: (ae-missing-release-tag) "SidebarSpacer" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const SidebarSpacer: React_2.ComponentType<
React_2.ClassAttributes<HTMLDivElement> &
React_2.HTMLAttributes<HTMLDivElement> &
StyledComponentProps<'root'>
export const SidebarSpacer: ComponentType<
ComponentProps<'div'> & StyledComponentProps<'root'>
>;
// Warning: (ae-missing-release-tag) "SidebarSpacerClassKey" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
packages/core-plugin-api/report-alpha.api.md
+1 -5
View File
@@ -231,11 +231,7 @@ export type TranslationSnapshot<
};
// @alpha (undocumented)
export const useTranslationRef: <
TMessages extends {
[x: string]: string;
},
>(
export const useTranslationRef: <TMessages extends { [key in string]: string }>(
translationRef: TranslationRef<string, TMessages>,
) => {
t: TranslationFunction<TMessages>;
packages/core-plugin-api/report.api.md
+1 -5
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin as BackstagePlugin_2 } from '@backstage/core-plugin-api';
import { ComponentType } from 'react';
import { Config } from '@backstage/config';
@@ -791,9 +789,7 @@ export function withApis<T extends {}>(
): <TProps extends T>(
WrappedComponent: React_2.ComponentType<TProps>,
) => {
(
props: React_2.PropsWithChildren<Omit<TProps, keyof T>>,
): React_2.JSX.Element;
(props: PropsWithChildren<Omit<TProps, keyof T>>): React_2.JSX.Element;
displayName: string;
};
```
packages/create-app/templates/default-app/package.json.hbs
+1 -1
View File
@@ -36,7 +36,7 @@
"@playwright/test": "^1.32.3",
"node-gyp": "^10.0.0",
"prettier": "^2.3.2",
"typescript": "~5.4.0"
"typescript": "~5.8.0"
},
"resolutions": {
"@types/react": "^18",
packages/dev-utils/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiFactory } from '@backstage/core-plugin-api';
import { AppTheme } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
packages/frontend-plugin-api/report.api.md
+10 -14
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AlertApi } from '@backstage/core-plugin-api';
import { alertApiRef } from '@backstage/core-plugin-api';
import { AlertMessage } from '@backstage/core-plugin-api';
@@ -263,7 +261,7 @@ export const AppRootWrapperBlueprint: ExtensionBlueprint<{
};
output: ConfigurableExtensionDataRef<
React_2.ComponentType<{
children?: React_2.ReactNode;
children?: React_2.ReactNode | undefined;
}>,
'app.root.wrapper',
{}
@@ -274,7 +272,7 @@ export const AppRootWrapperBlueprint: ExtensionBlueprint<{
dataRefs: {
component: ConfigurableExtensionDataRef<
React_2.ComponentType<{
children?: React_2.ReactNode;
children?: React_2.ReactNode | undefined;
}>,
'app.root.wrapper',
{}
@@ -1297,9 +1295,7 @@ export const IconBundleBlueprint: ExtensionBlueprint<{
kind: 'icon-bundle';
name: undefined;
params: {
icons: {
[x: string]: IconComponent;
};
icons: { [key in string]: IconComponent };
};
output: ConfigurableExtensionDataRef<
{
@@ -1388,8 +1384,8 @@ export const NavLogoBlueprint: ExtensionBlueprint<{
};
output: ConfigurableExtensionDataRef<
{
logoIcon?: JSX.Element | undefined;
logoFull?: JSX.Element | undefined;
logoIcon?: JSX.Element;
logoFull?: JSX.Element;
},
'core.nav-logo.logo-elements',
{}
@@ -1400,8 +1396,8 @@ export const NavLogoBlueprint: ExtensionBlueprint<{
dataRefs: {
logoElements: ConfigurableExtensionDataRef<
{
logoIcon?: JSX.Element | undefined;
logoFull?: JSX.Element | undefined;
logoIcon?: JSX.Element;
logoFull?: JSX.Element;
},
'core.nav-logo.logo-elements',
{}
@@ -1434,7 +1430,7 @@ export const PageBlueprint: ExtensionBlueprint<{
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
output:
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
@@ -1592,7 +1588,7 @@ export const RouterBlueprint: ExtensionBlueprint<{
};
output: ConfigurableExtensionDataRef<
ComponentType<{
children?: ReactNode;
children?: ReactNode | undefined;
}>,
'app.router.wrapper',
{}
@@ -1603,7 +1599,7 @@ export const RouterBlueprint: ExtensionBlueprint<{
dataRefs: {
component: ConfigurableExtensionDataRef<
ComponentType<{
children?: ReactNode;
children?: ReactNode | undefined;
}>,
'app.router.wrapper',
{}
packages/frontend-test-utils/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AnalyticsApi } from '@backstage/frontend-plugin-api';
import { AnalyticsEvent } from '@backstage/frontend-plugin-api';
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
packages/test-utils/package.json
-4
View File
@@ -74,16 +74,12 @@
},
"peerDependencies": {
"@testing-library/react": "^16.0.0",
"@types/jest": "*",
"@types/react": "^17.0.0 || ^18.0.0",
"react": "^17.0.0 || ^18.0.0",
"react-dom": "^17.0.0 || ^18.0.0",
"react-router-dom": "^6.3.0"
},
"peerDependenciesMeta": {
"@types/jest": {
"optional": true
},
"@types/react": {
"optional": true
}
packages/test-utils/report.api.md
+11 -14
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="jest" />
import { AnalyticsApi } from '@backstage/core-plugin-api';
import { AnalyticsEvent } from '@backstage/core-plugin-api';
import { ApiFactory } from '@backstage/core-plugin-api';
@@ -106,7 +104,7 @@ export namespace mockApis {
const factory: (
options?:
| {
data?: JsonObject | undefined;
data?: JsonObject;
}
| undefined,
) => ApiFactory<Config, Config, {}>;
@@ -118,7 +116,7 @@ export namespace mockApis {
factory: (
options?:
| {
baseUrl?: string | undefined;
baseUrl?: string;
}
| undefined,
) => ApiFactory<DiscoveryApi, DiscoveryApi, {}>;
@@ -140,12 +138,12 @@ export namespace mockApis {
factory: (
options?:
| {
userEntityRef?: string | undefined;
ownershipEntityRefs?: string[] | undefined;
token?: string | undefined;
email?: string | undefined;
displayName?: string | undefined;
picture?: string | undefined;
userEntityRef?: string;
ownershipEntityRefs?: string[];
token?: string;
email?: string;
displayName?: string;
picture?: string;
}
| undefined,
) => ApiFactory<IdentityApi, IdentityApi, {}>;
@@ -168,12 +166,11 @@ export namespace mockApis {
options?:
| {
authorize?:
| AuthorizeResult.DENY
| AuthorizeResult.ALLOW
| AuthorizeResult.DENY
| ((
request: EvaluatePermissionRequest,
) => AuthorizeResult.DENY | AuthorizeResult.ALLOW)
| undefined;
) => AuthorizeResult.ALLOW | AuthorizeResult.DENY);
}
| undefined,
) => ApiFactory<PermissionApi, PermissionApi, {}>;
@@ -188,7 +185,7 @@ export namespace mockApis {
factory: (
options?:
| {
data?: JsonObject | undefined;
data?: JsonObject;
}
| undefined,
) => ApiFactory<StorageApi, StorageApi, {}>;
packages/version-bridge/report.api.md
+1 -1
View File
@@ -14,7 +14,7 @@ export function createVersionedContext<
// @public
export function createVersionedContextForTesting(key: string): {
set(versions: { [x: number]: unknown }): void;
set(versions: { [version in number]: unknown }): void;
reset(): void;
};
plugins/api-docs/report-alpha.api.md
+20 -31
View File
@@ -7,6 +7,7 @@ import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha';
import { Entity } from '@backstage/catalog-model';
import { EntityCardType } from '@backstage/plugin-catalog-react/alpha';
import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha';
@@ -83,8 +84,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:api-docs/consuming-components': ExtensionDefinition<{
@@ -128,8 +129,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:api-docs/definition': ExtensionDefinition<{
@@ -173,8 +174,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:api-docs/has-apis': ExtensionDefinition<{
@@ -218,8 +219,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:api-docs/provided-apis': ExtensionDefinition<{
@@ -263,8 +264,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:api-docs/providing-components': ExtensionDefinition<{
@@ -308,8 +309,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-content:api-docs/apis': ExtensionDefinition<{
@@ -372,15 +373,9 @@ const _default: FrontendPlugin<
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?:
| (string & {})
| 'documentation'
| 'development'
| 'deployment'
| 'observability'
| undefined;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
defaultGroup?: keyof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
}>;
'entity-content:api-docs/definition': ExtensionDefinition<{
@@ -443,15 +438,9 @@ const _default: FrontendPlugin<
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?:
| (string & {})
| 'documentation'
| 'development'
| 'deployment'
| 'observability'
| undefined;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
defaultGroup?: keyof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
}>;
'nav-item:api-docs': ExtensionDefinition<{
@@ -514,7 +503,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/api-docs/report.api.md
+16 -18
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiEntity } from '@backstage/catalog-model';
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
@@ -133,38 +131,38 @@ export const EntityApiDefinitionCard: () => JSX_2.Element;
// @public (undocumented)
export const EntityConsumedApisCard: (props: {
variant?: InfoCardVariants | undefined;
title?: string | undefined;
columns?: TableColumn<ApiEntity>[] | undefined;
tableOptions?: TableOptions<{}> | undefined;
variant?: InfoCardVariants;
title?: string;
columns?: TableColumn<ApiEntity>[];
tableOptions?: TableOptions;
}) => JSX_2.Element;
// @public (undocumented)
export const EntityConsumingComponentsCard: (props: {
variant?: InfoCardVariants | undefined;
columns?: TableColumn<ComponentEntity>[] | undefined;
variant?: InfoCardVariants;
columns?: TableColumn<ComponentEntity>[];
}) => JSX_2.Element;
// @public (undocumented)
export const EntityHasApisCard: (props: {
variant?: InfoCardVariants | undefined;
title?: string | undefined;
columns?: TableColumn<ApiEntity>[] | undefined;
tableOptions?: TableOptions<{}> | undefined;
variant?: InfoCardVariants;
title?: string;
columns?: TableColumn<ApiEntity>[];
tableOptions?: TableOptions;
}) => JSX_2.Element;
// @public (undocumented)
export const EntityProvidedApisCard: (props: {
variant?: InfoCardVariants | undefined;
title?: string | undefined;
columns?: TableColumn<ApiEntity>[] | undefined;
tableOptions?: TableOptions<{}> | undefined;
variant?: InfoCardVariants;
title?: string;
columns?: TableColumn<ApiEntity>[];
tableOptions?: TableOptions;
}) => JSX_2.Element;
// @public (undocumented)
export const EntityProvidingComponentsCard: (props: {
variant?: InfoCardVariants | undefined;
columns?: TableColumn<ComponentEntity>[] | undefined;
variant?: InfoCardVariants;
columns?: TableColumn<ComponentEntity>[];
}) => JSX_2.Element;
// @public (undocumented)
plugins/app-visualizer/report.api.md
+1 -1
View File
@@ -64,7 +64,7 @@ const visualizerPlugin: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/app/report.api.md
+4 -6
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
@@ -105,8 +103,8 @@ const appPlugin: FrontendPlugin<
logos: ExtensionInput<
ConfigurableExtensionDataRef<
{
logoIcon?: JSX.Element | undefined;
logoFull?: JSX.Element | undefined;
logoIcon?: JSX.Element;
logoFull?: JSX.Element;
},
'core.nav-logo.logo-elements',
{}
@@ -133,7 +131,7 @@ const appPlugin: FrontendPlugin<
router: ExtensionInput<
ConfigurableExtensionDataRef<
ComponentType<{
children?: ReactNode;
children?: ReactNode | undefined;
}>,
'app.router.wrapper',
{}
@@ -171,7 +169,7 @@ const appPlugin: FrontendPlugin<
wrappers: ExtensionInput<
ConfigurableExtensionDataRef<
ComponentType<{
children?: ReactNode;
children?: ReactNode | undefined;
}>,
'app.root.wrapper',
{}
plugins/auth-backend-module-aws-alb-provider/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackendFeature } from '@backstage/backend-plugin-api';
import { JWTHeaderParameters } from 'jose';
import { KeyObject } from 'crypto';
plugins/auth-backend-module-oauth2-proxy-provider/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackendFeature } from '@backstage/backend-plugin-api';
import { IncomingHttpHeaders } from 'http';
import { ProxyAuthenticator } from '@backstage/plugin-auth-node';
plugins/auth-backend/report.api.md
+60 -86
View File
@@ -372,12 +372,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -387,12 +385,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -402,7 +398,7 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<AwsAlbResult_2> | undefined;
authHandler?: AuthHandler<AwsAlbResult_2>;
signIn: {
resolver: SignInResolver_2<AwsAlbResult_2>;
};
@@ -415,12 +411,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -433,12 +427,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<BitbucketServerOAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<BitbucketServerOAuthResult>;
}
| undefined;
authHandler?: AuthHandler<BitbucketServerOAuthResult>;
signIn?: {
resolver: SignInResolver_2<BitbucketServerOAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -448,19 +440,19 @@ export const providers: Readonly<{
}>;
cfAccess: Readonly<{
create: (options: {
authHandler?: AuthHandler<CloudflareAccessResult> | undefined;
authHandler?: AuthHandler<CloudflareAccessResult>;
signIn: {
resolver: SignInResolver_2<CloudflareAccessResult>;
};
cache?: CacheService | undefined;
cache?: CacheService;
}) => AuthProviderFactory_2;
resolvers: Readonly<cloudflareAccessSignInResolvers>;
}>;
gcpIap: Readonly<{
create: (options: {
authHandler?: AuthHandler<GcpIapResult_2> | undefined;
authHandler?: AuthHandler<GcpIapResult>;
signIn: {
resolver: SignInResolver_2<GcpIapResult_2>;
resolver: SignInResolver_2<GcpIapResult>;
};
}) => AuthProviderFactory_2;
resolvers: never;
@@ -469,13 +461,11 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<GithubOAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<GithubOAuthResult>;
}
| undefined;
stateEncoder?: StateEncoder | undefined;
authHandler?: AuthHandler<GithubOAuthResult>;
signIn?: {
resolver: SignInResolver_2<GithubOAuthResult>;
};
stateEncoder?: StateEncoder;
}
| undefined,
) => AuthProviderFactory_2;
@@ -487,12 +477,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -502,12 +490,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -521,12 +507,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -541,12 +525,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -554,7 +536,7 @@ export const providers: Readonly<{
}>;
oauth2Proxy: Readonly<{
create: (options: {
authHandler?: AuthHandler<OAuth2ProxyResult_2> | undefined;
authHandler?: AuthHandler<OAuth2ProxyResult_2>;
signIn: {
resolver: SignInResolver_2<OAuth2ProxyResult_2>;
};
@@ -565,12 +547,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OidcAuthResult_2> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OidcAuthResult_2>;
}
| undefined;
authHandler?: AuthHandler<OidcAuthResult_2>;
signIn?: {
resolver: SignInResolver_2<OidcAuthResult_2>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -583,12 +563,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -602,12 +580,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<OAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<OAuthResult>;
}
| undefined;
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver: SignInResolver_2<OAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -617,12 +593,10 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<SamlAuthResult> | undefined;
signIn?:
| {
resolver: SignInResolver_2<SamlAuthResult>;
}
| undefined;
authHandler?: AuthHandler<SamlAuthResult>;
signIn?: {
resolver: SignInResolver_2<SamlAuthResult>;
};
}
| undefined,
) => AuthProviderFactory_2;
@@ -634,7 +608,7 @@ export const providers: Readonly<{
create: (
options?:
| {
authHandler?: AuthHandler<AzureEasyAuthResult> | undefined;
authHandler?: AuthHandler<AzureEasyAuthResult>;
signIn: {
resolver: SignInResolver_2<AzureEasyAuthResult>;
};
plugins/auth-backend/src/providers/azure-easyauth/provider.ts
+2 -4
View File
@@ -25,8 +25,6 @@ import {
azureEasyAuthAuthenticator,
} from '@backstage/plugin-auth-backend-module-azure-easyauth-provider';
export type EasyAuthResult = AzureEasyAuthResult;
/**
* Auth provider integration for Azure EasyAuth
*
@@ -39,7 +37,7 @@ export const easyAuth = createAuthProviderIntegration({
* The profile transformation function used to verify and convert the auth response
* into the profile that will be presented to the user.
*/
authHandler?: AuthHandler<EasyAuthResult>;
authHandler?: AuthHandler<AzureEasyAuthResult>;
/**
* Configure sign-in for this provider, without it the provider can not be used to sign users in.
@@ -48,7 +46,7 @@ export const easyAuth = createAuthProviderIntegration({
/**
* Maps an auth result to a Backstage identity for the user.
*/
resolver: SignInResolver<EasyAuthResult>;
resolver: SignInResolver<AzureEasyAuthResult>;
};
}) {
return createProxyAuthProviderFactory({
plugins/catalog-backend-module-incremental-ingestion/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="express" />
import { BackendFeature } from '@backstage/backend-plugin-api';
import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
import { DatabaseService } from '@backstage/backend-plugin-api';
plugins/catalog-backend/report.api.md
+3 -7
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AnalyzeLocationEntityField as AnalyzeLocationEntityField_2 } from '@backstage/plugin-catalog-common';
import { AnalyzeLocationExistingEntity as AnalyzeLocationExistingEntity_2 } from '@backstage/plugin-catalog-common';
import { AnalyzeLocationGenerateEntity as AnalyzeLocationGenerateEntity_2 } from '@backstage/plugin-catalog-common';
@@ -479,11 +477,9 @@ export const processingResult: Readonly<{
readonly entity: (
atLocation: LocationSpec_2,
newEntity: Entity,
options?:
| {
locationKey?: string | null | undefined;
}
| undefined,
options?: {
locationKey?: string | null;
},
) => CatalogProcessorResult_2;
readonly relation: (spec: EntityRelationSpec_2) => CatalogProcessorResult_2;
readonly refresh: (key: string) => CatalogProcessorResult_2;
plugins/catalog-graph/report-alpha.api.md
+4 -4
View File
@@ -51,8 +51,8 @@ const _default: FrontendPlugin<
height?: number | undefined;
curve?: 'curveStepBefore' | 'curveMonotoneX' | undefined;
direction?: Direction | undefined;
title?: string | undefined;
zoom?: 'disabled' | 'enabled' | 'enable-on-click' | undefined;
title?: string | undefined;
relations?: string[] | undefined;
maxDepth?: number | undefined;
kinds?: string[] | undefined;
@@ -103,8 +103,8 @@ const _default: FrontendPlugin<
name: 'relations';
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'page:catalog-graph': ExtensionDefinition<{
@@ -170,7 +170,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/catalog-graph/report.api.md
+14 -18
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CompoundEntityRef } from '@backstage/catalog-model';
import { DependencyGraphTypes } from '@backstage/core-components';
@@ -25,19 +23,17 @@ export const ALL_RELATION_PAIRS: RelationPairs;
// @public
export const CatalogGraphPage: (
props: {
initialState?:
| {
selectedRelations?: string[] | undefined;
selectedKinds?: string[] | undefined;
rootEntityRefs?: string[] | undefined;
maxDepth?: number | undefined;
unidirectional?: boolean | undefined;
mergeRelations?: boolean | undefined;
direction?: Direction | undefined;
showFilters?: boolean | undefined;
curve?: 'curveStepBefore' | 'curveMonotoneX' | undefined;
}
| undefined;
initialState?: {
selectedRelations?: string[];
selectedKinds?: string[];
rootEntityRefs?: string[];
maxDepth?: number;
unidirectional?: boolean;
mergeRelations?: boolean;
direction?: Direction;
showFilters?: boolean;
curve?: 'curveStepBefore' | 'curveMonotoneX';
};
} & Partial<EntityRelationsGraphProps>,
) => JSX_2.Element;
@@ -78,9 +74,9 @@ export enum Direction {
// @public
export const EntityCatalogGraphCard: (
props: Partial<EntityRelationsGraphProps> & {
variant?: InfoCardVariants | undefined;
height?: number | undefined;
title?: string | undefined;
variant?: InfoCardVariants;
height?: number;
title?: string;
action?: ReactNode;
},
) => JSX_2.Element;
plugins/catalog-import/report-alpha.api.md
+1 -1
View File
@@ -60,7 +60,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/catalog-import/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogApi } from '@backstage/catalog-client';
plugins/catalog-node/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AddLocationRequest } from '@backstage/catalog-client';
import { AddLocationResponse } from '@backstage/catalog-client';
import { AnalyzeLocationExistingEntity } from '@backstage/plugin-catalog-common';
plugins/catalog-react/report-alpha.api.md
+6 -14
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { ComponentType } from 'react';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
@@ -110,8 +108,8 @@ export const EntityCardBlueprint: ExtensionBlueprint<{
name: undefined;
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
output:
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
@@ -175,15 +173,9 @@ export const EntityContentBlueprint: ExtensionBlueprint<{
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?:
| (string & {})
| 'documentation'
| 'development'
| 'deployment'
| 'observability'
| undefined;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
defaultGroup?: keyof typeof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
output:
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
@@ -259,7 +251,7 @@ export const EntityContentLayoutBlueprint: ExtensionBlueprint<{
kind: 'entity-content-layout';
name: undefined;
params: {
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
loader: () => Promise<
(props: EntityContentLayoutProps) => React_2.JSX.Element
>;
plugins/catalog-react/report.api.md
+23 -27
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { AutocompleteProps } from '@material-ui/lab/Autocomplete';
import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
@@ -170,20 +168,20 @@ export const columnFactories: Readonly<{
createEntityRefColumn<T extends Entity>(options: {
defaultKind?: string;
}): TableColumn<T>;
createEntityRelationColumn<T_1 extends Entity>(options: {
createEntityRelationColumn<T extends Entity>(options: {
title: string;
relation: string;
defaultKind?: string;
filter?: {
kind: string;
};
}): TableColumn<T_1>;
createOwnerColumn<T_2 extends Entity>(): TableColumn<T_2>;
createDomainColumn<T_3 extends Entity>(): TableColumn<T_3>;
createSystemColumn<T_4 extends Entity>(): TableColumn<T_4>;
createMetadataDescriptionColumn<T_5 extends Entity>(): TableColumn<T_5>;
createSpecLifecycleColumn<T_6 extends Entity>(): TableColumn<T_6>;
createSpecTypeColumn<T_7 extends Entity>(): TableColumn<T_7>;
}): TableColumn<T>;
createOwnerColumn<T extends Entity>(): TableColumn<T>;
createDomainColumn<T extends Entity>(): TableColumn<T>;
createSystemColumn<T extends Entity>(): TableColumn<T>;
createMetadataDescriptionColumn<T extends Entity>(): TableColumn<T>;
createSpecLifecycleColumn<T extends Entity>(): TableColumn<T>;
createSpecTypeColumn<T extends Entity>(): TableColumn<T>;
}>;
// @public (undocumented)
@@ -555,25 +553,23 @@ export type EntitySourceLocation = {
export const EntityTable: {
<T extends Entity>(props: EntityTableProps<T>): React_2.JSX.Element;
columns: Readonly<{
createEntityRefColumn<T_1 extends Entity>(options: {
defaultKind?: string | undefined;
}): TableColumn<T_1>;
createEntityRelationColumn<T_2 extends Entity>(options: {
createEntityRefColumn<T extends Entity>(options: {
defaultKind?: string;
}): TableColumn<T>;
createEntityRelationColumn<T extends Entity>(options: {
title: string;
relation: string;
defaultKind?: string | undefined;
filter?:
| {
kind: string;
}
| undefined;
}): TableColumn<T_2>;
createOwnerColumn<T_3 extends Entity>(): TableColumn<T_3>;
createDomainColumn<T_4 extends Entity>(): TableColumn<T_4>;
createSystemColumn<T_5 extends Entity>(): TableColumn<T_5>;
createMetadataDescriptionColumn<T_6 extends Entity>(): TableColumn<T_6>;
createSpecLifecycleColumn<T_7 extends Entity>(): TableColumn<T_7>;
createSpecTypeColumn<T_8 extends Entity>(): TableColumn<T_8>;
defaultKind?: string;
filter?: {
kind: string;
};
}): TableColumn<T>;
createOwnerColumn<T extends Entity>(): TableColumn<T>;
createDomainColumn<T extends Entity>(): TableColumn<T>;
createSystemColumn<T extends Entity>(): TableColumn<T>;
createMetadataDescriptionColumn<T extends Entity>(): TableColumn<T>;
createSpecLifecycleColumn<T extends Entity>(): TableColumn<T>;
createSpecTypeColumn<T extends Entity>(): TableColumn<T>;
}>;
systemEntityColumns: TableColumn<SystemEntity>[];
componentEntityColumns: TableColumn<ComponentEntity>[];
plugins/catalog-unprocessed-entities/report-alpha.api.md
+1 -1
View File
@@ -82,7 +82,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/catalog-unprocessed-entities/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
plugins/catalog/package.json
-1
View File
@@ -79,7 +79,6 @@
"@mui/utils": "^5.14.15",
"classnames": "^2.3.1",
"dataloader": "^2.0.0",
"expiry-map": "^2.0.0",
"history": "^5.0.0",
"lodash": "^4.17.21",
"pluralize": "^8.0.0",
plugins/catalog/report-alpha.api.md
+28 -35
View File
@@ -3,12 +3,11 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha';
import { Entity } from '@backstage/catalog-model';
import { EntityCardType } from '@backstage/plugin-catalog-react/alpha';
import { EntityContentLayoutProps } from '@backstage/plugin-catalog-react/alpha';
@@ -387,8 +386,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/depends-on-components': ExtensionDefinition<{
@@ -428,8 +427,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/depends-on-resources': ExtensionDefinition<{
@@ -469,8 +468,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/has-components': ExtensionDefinition<{
@@ -510,8 +509,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/has-resources': ExtensionDefinition<{
@@ -551,8 +550,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/has-subcomponents': ExtensionDefinition<{
@@ -592,8 +591,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/has-subdomains': ExtensionDefinition<{
@@ -633,8 +632,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/has-systems': ExtensionDefinition<{
@@ -674,8 +673,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/labels': ExtensionDefinition<{
@@ -715,8 +714,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:catalog/links': ExtensionDefinition<{
@@ -756,8 +755,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-content:catalog/overview': ExtensionDefinition<{
@@ -826,7 +825,7 @@ const _default: FrontendPlugin<
}
>
| ConfigurableExtensionDataRef<
(props: EntityContentLayoutProps) => JSX_2.Element,
(props: EntityContentLayoutProps) => React.JSX.Element,
'catalog.entity-content-layout.component',
{}
>,
@@ -870,15 +869,9 @@ const _default: FrontendPlugin<
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?:
| (string & {})
| 'documentation'
| 'development'
| 'deployment'
| 'observability'
| undefined;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
defaultGroup?: keyof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
}>;
'nav-item:catalog': ExtensionDefinition<{
@@ -933,7 +926,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
'page:catalog/entity': ExtensionDefinition<{
@@ -1032,7 +1025,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
'search-result-list-item:catalog': ExtensionDefinition<{
@@ -1046,7 +1039,7 @@ const _default: FrontendPlugin<
};
output: ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
predicate?: SearchResultItemExtensionPredicate;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
plugins/catalog/report.api.md
+16 -37
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiHolder } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogApi } from '@backstage/plugin-catalog-react';
@@ -161,13 +159,9 @@ export interface CatalogSearchResultListItemProps {
export const CatalogTable: {
(props: CatalogTableProps): React_2.JSX.Element;
columns: Readonly<{
createNameColumn(
options?:
| {
defaultKind?: string | undefined;
}
| undefined,
): TableColumn<CatalogTableRow>;
createNameColumn(options?: {
defaultKind?: string;
}): TableColumn<CatalogTableRow>;
createSystemColumn(): TableColumn<CatalogTableRow>;
createOwnerColumn(): TableColumn<CatalogTableRow>;
createSpecTargetsColumn(): TableColumn<CatalogTableRow>;
@@ -177,21 +171,15 @@ export const CatalogTable: {
createSpecLifecycleColumn(): TableColumn<CatalogTableRow>;
createMetadataDescriptionColumn(): TableColumn<CatalogTableRow>;
createTagsColumn(): TableColumn<CatalogTableRow>;
createTitleColumn(
options?:
| {
hidden?: boolean | undefined;
}
| undefined,
): TableColumn<CatalogTableRow>;
createTitleColumn(options?: {
hidden?: boolean;
}): TableColumn<CatalogTableRow>;
createLabelColumn(
key: string,
options?:
| {
title?: string | undefined;
defaultValue?: string | undefined;
}
| undefined,
options?: {
title?: string;
defaultValue?: string;
},
): TableColumn<CatalogTableRow>;
createNamespaceColumn(): TableColumn<CatalogTableRow>;
}>;
@@ -459,7 +447,7 @@ export type EntityLinksEmptyStateClassKey = 'code';
// @public @deprecated (undocumented)
export const EntityListContainer: (props: {
children: ReactNode;
children: React.ReactNode;
}) => JSX_2.Element;
// @public
@@ -508,20 +496,11 @@ export interface EntitySwitchProps {
// @public @deprecated (undocumented)
export const FilterContainer: (props: {
children: ReactNode;
options?:
| {
drawerBreakpoint?:
| number
| 'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| undefined;
drawerAnchor?: 'left' | 'top' | 'bottom' | 'right' | undefined;
}
| undefined;
children: React.ReactNode;
options?: {
drawerBreakpoint?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | number;
drawerAnchor?: 'left' | 'right' | 'top' | 'bottom';
};
}) => JSX_2.Element;
// @public @deprecated (undocumented)
plugins/catalog/src/apis/EntityPresentationApi/DefaultEntityPresentationApi.ts
+39 -1
View File
@@ -28,7 +28,6 @@ import {
} from '@backstage/plugin-catalog-react';
import { durationToMilliseconds, HumanDuration } from '@backstage/types';
import DataLoader from 'dataloader';
import ExpiryMap from 'expiry-map';
import ObservableImpl from 'zen-observable';
import {
createDefaultRenderer,
@@ -149,6 +148,45 @@ interface CacheEntry {
entity: Entity | undefined;
}
// Simple expiry map for the data loader, which only expects a map that implements set, get, and delete and clear
export class ExpiryMap<K, V> extends Map<K, V> {
#ttlMs: number;
#timestamps: Map<K, number> = new Map();
constructor(ttlMs: number) {
super();
this.#ttlMs = ttlMs;
}
set(key: K, value: V) {
const result = super.set(key, value);
this.#timestamps.set(key, Date.now());
return result;
}
get(key: K) {
if (!this.has(key)) {
return undefined;
}
const timestamp = this.#timestamps.get(key)!;
if (Date.now() - timestamp > this.#ttlMs) {
this.delete(key);
return undefined;
}
return super.get(key);
}
delete(key: K) {
this.#timestamps.delete(key);
return super.delete(key);
}
clear() {
this.#timestamps.clear();
return super.clear();
}
}
/**
* Default implementation of the {@link @backstage/plugin-catalog-react#EntityPresentationApi}.
*
plugins/config-schema/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react';
plugins/devtools/report-alpha.api.md
+1 -1
View File
@@ -82,7 +82,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/devtools/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { default as default_2 } from 'react';
import { JSX as JSX_2 } from 'react';
plugins/events-node/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AuthService } from '@backstage/backend-plugin-api';
import { DiscoveryService } from '@backstage/backend-plugin-api';
import { LifecycleService } from '@backstage/backend-plugin-api';
plugins/example-todo-list/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react';
import { RouteRef } from '@backstage/core-plugin-api';
plugins/home/report-alpha.api.md
+1 -1
View File
@@ -64,7 +64,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/home/report.api.md
+15 -18
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CardConfig as CardConfig_2 } from '@backstage/plugin-home-react';
@@ -48,12 +46,13 @@ export type ClockConfig = {
// @public (undocumented)
export const ComponentAccordion: (props: {
title?: string | undefined;
expanded?: boolean | undefined;
title?: string;
expanded?: boolean;
Content: () => JSX.Element;
Actions?: (() => JSX.Element) | undefined;
Settings?: (() => JSX.Element) | undefined;
ContextProvider?: ((props: any) => JSX.Element) | undefined;
Actions?: () => JSX.Element;
Settings?: () => JSX./** @public */
Element;
ContextProvider?: (props: any) => JSX.Element;
}) => JSX_2.Element;
// @public @deprecated (undocumented)
@@ -66,7 +65,7 @@ export type ComponentRenderer = ComponentRenderer_2;
export const ComponentTab: (props: {
title: string;
Content: () => JSX.Element;
ContextProvider?: ((props: any) => JSX.Element) | undefined;
ContextProvider?: (props: any) => JSX.Element;
}) => JSX_2.Element;
// @public (undocumented)
@@ -119,25 +118,25 @@ export type FeaturedDocsCardProps = {
// @public
export const HeaderWorldClock: (props: {
clockConfigs: ClockConfig[];
customTimeFormat?: Intl.DateTimeFormatOptions | undefined;
customTimeFormat?: Intl.DateTimeFormatOptions;
}) => JSX_2.Element | null;
// @public
export const HomePageCompanyLogo: (props: {
logo?: ReactNode;
className?: string | undefined;
logo?: React.ReactNode;
className?: string;
}) => JSX_2.Element;
// @public (undocumented)
export const HomepageCompositionRoot: (props: {
title?: string | undefined;
title?: string;
children?: ReactNode;
}) => JSX_2.Element;
// @public (undocumented)
export const HomePageRandomJoke: (
props: CardExtensionProps_2<{
defaultCategory?: 'any' | 'programming' | undefined;
defaultCategory?: 'any' | 'programming';
}>,
) => JSX_2.Element;
@@ -210,7 +209,7 @@ export type RendererProps = RendererProps_2;
export const SettingsModal: (props: {
open: boolean;
close: Function;
componentName?: string | undefined;
componentName?: string;
children: JSX.Element;
}) => JSX_2.Element;
@@ -272,10 +271,8 @@ export const VisitListener: ({
visitName,
}: {
children?: React_2.ReactNode;
toEntityRef?:
| (({ pathname }: { pathname: string }) => string | undefined)
| undefined;
visitName?: (({ pathname }: { pathname: string }) => string) | undefined;
toEntityRef?: ({ pathname }: { pathname: string }) => string | undefined;
visitName?: ({ pathname }: { pathname: string }) => string;
}) => JSX.Element;
// @public
plugins/kubernetes-cluster/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { Entity } from '@backstage/catalog-model';
import { default as React_2 } from 'react';
plugins/kubernetes/report-alpha.api.md
+5 -12
View File
@@ -3,11 +3,10 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha';
import { Entity } from '@backstage/catalog-model';
import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
@@ -139,15 +138,9 @@ const _default: FrontendPlugin<
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?:
| (string & {})
| 'documentation'
| 'development'
| 'deployment'
| 'observability'
| undefined;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
defaultGroup?: keyof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
}>;
'page:kubernetes': ExtensionDefinition<{
@@ -173,7 +166,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/kubernetes/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { default as React_2 } from 'react';
plugins/notifications/report-alpha.api.md
+1 -1
View File
@@ -60,7 +60,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
plugins/notifications/report.api.md
+1 -3
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { DiscoveryApi } from '@backstage/core-plugin-api';
@@ -105,7 +103,7 @@ export class NotificationsClient implements NotificationsApi {
// @public (undocumented)
export const NotificationsPage: (
props?: NotificationsPageProps | undefined,
props?: NotificationsPageProps,
) => JSX_2.Element;
// @public (undocumented)
plugins/org/report-alpha.api.md
+8 -8
View File
@@ -60,8 +60,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:org/members-list': ExtensionDefinition<{
@@ -105,8 +105,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:org/ownership': ExtensionDefinition<{
@@ -150,8 +150,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
'entity-card:org/user-profile': ExtensionDefinition<{
@@ -195,8 +195,8 @@ const _default: FrontendPlugin<
inputs: {};
params: {
loader: () => Promise<JSX.Element>;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
type?: EntityCardType | undefined;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
type?: EntityCardType;
};
}>;
}
plugins/org/report.api.md
+16 -18
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
@@ -14,28 +12,28 @@ import { default as React_2 } from 'react';
// @public (undocumented)
export const EntityGroupProfileCard: (props: {
variant?: InfoCardVariants | undefined;
showLinks?: boolean | undefined;
variant?: InfoCardVariants;
showLinks?: boolean;
}) => JSX_2.Element;
// @public (undocumented)
export const EntityMembersListCard: (props: {
memberDisplayTitle?: string | undefined;
pageSize?: number | undefined;
showAggregateMembersToggle?: boolean | undefined;
relationType?: string | undefined;
relationsType?: EntityRelationAggregation | undefined;
relationAggregation?: EntityRelationAggregation | undefined;
memberDisplayTitle?: string;
pageSize?: number;
showAggregateMembersToggle?: boolean;
relationType?: string;
relationsType?: EntityRelationAggregation;
relationAggregation?: EntityRelationAggregation;
}) => JSX_2.Element;
// @public (undocumented)
export const EntityOwnershipCard: (props: {
variant?: InfoCardVariants | undefined;
entityFilterKind?: string[] | undefined;
hideRelationsToggle?: boolean | undefined;
relationsType?: EntityRelationAggregation | undefined;
relationAggregation?: EntityRelationAggregation | undefined;
entityLimit?: number | undefined;
variant?: InfoCardVariants;
entityFilterKind?: string[];
hideRelationsToggle?: boolean;
relationsType?: EntityRelationAggregation;
relationAggregation?: EntityRelationAggregation;
entityLimit?: number;
}) => JSX_2.Element;
// @public (undocumented)
@@ -43,8 +41,8 @@ export type EntityRelationAggregation = 'direct' | 'aggregated';
// @public (undocumented)
export const EntityUserProfileCard: (props: {
variant?: InfoCardVariants | undefined;
showLinks?: boolean | undefined;
variant?: InfoCardVariants;
showLinks?: boolean;
}) => JSX_2.Element;
// @public (undocumented)
plugins/scaffolder-backend-module-azure/report.api.md
+7 -7
View File
@@ -20,13 +20,13 @@ export function createPublishAzureAction(options: {
}): TemplateAction<
{
repoUrl: string;
description?: string | undefined;
defaultBranch?: string | undefined;
sourcePath?: string | undefined;
token?: string | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
description?: string;
defaultBranch?: string;
sourcePath?: string;
token?: string;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md
+13 -13
View File
@@ -20,8 +20,8 @@ export const createBitbucketPipelinesRunAction: (options: {
{
workspace: string;
repo_slug: string;
body?: object | undefined;
token?: string | undefined;
body?: object;
token?: string;
},
JsonObject
>;
@@ -33,12 +33,12 @@ export function createPublishBitbucketCloudAction(options: {
}): TemplateAction<
{
repoUrl: string;
description?: string | undefined;
defaultBranch?: string | undefined;
repoVisibility?: 'private' | 'public' | undefined;
gitCommitMessage?: string | undefined;
sourcePath?: string | undefined;
token?: string | undefined;
description?: string;
defaultBranch?: string;
repoVisibility?: 'private' | 'public';
gitCommitMessage?: string;
sourcePath?: string;
token?: string;
},
JsonObject
>;
@@ -51,12 +51,12 @@ export function createPublishBitbucketCloudPullRequestAction(options: {
{
repoUrl: string;
title: string;
description?: string | undefined;
targetBranch?: string | undefined;
description?: string;
targetBranch?: string;
sourceBranch: string;
token?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
token?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-bitbucket-server/report.api.md
+15 -15
View File
@@ -20,15 +20,15 @@ export function createPublishBitbucketServerAction(options: {
}): TemplateAction<
{
repoUrl: string;
description?: string | undefined;
defaultBranch?: string | undefined;
repoVisibility?: 'private' | 'public' | undefined;
sourcePath?: string | undefined;
enableLFS?: boolean | undefined;
token?: string | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
description?: string;
defaultBranch?: string;
repoVisibility?: 'private' | 'public';
sourcePath?: string;
enableLFS?: boolean;
token?: string;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
},
JsonObject
>;
@@ -41,13 +41,13 @@ export function createPublishBitbucketServerPullRequestAction(options: {
{
repoUrl: string;
title: string;
description?: string | undefined;
targetBranch?: string | undefined;
description?: string;
targetBranch?: string;
sourceBranch: string;
reviewers?: string[] | undefined;
token?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
reviewers?: string[];
token?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-bitbucket/report.api.md
+11 -11
View File
@@ -22,8 +22,8 @@ export const createBitbucketPipelinesRunAction: (options: {
{
workspace: string;
repo_slug: string;
body?: object | undefined;
token?: string | undefined;
body?: object;
token?: string;
},
JsonObject
>;
@@ -35,15 +35,15 @@ export function createPublishBitbucketAction(options: {
}): TemplateAction<
{
repoUrl: string;
description?: string | undefined;
defaultBranch?: string | undefined;
repoVisibility?: 'private' | 'public' | undefined;
sourcePath?: string | undefined;
enableLFS?: boolean | undefined;
token?: string | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
description?: string;
defaultBranch?: string;
repoVisibility?: 'private' | 'public';
sourcePath?: string;
enableLFS?: boolean;
token?: string;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-cookiecutter/report.api.md
+4 -6
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackendFeature } from '@backstage/backend-plugin-api';
import { JsonObject } from '@backstage/types';
import { ScmIntegrations } from '@backstage/integration';
@@ -50,11 +48,11 @@ export function createFetchCookiecutterAction(options: {
}): TemplateAction<
{
url: string;
targetPath?: string | undefined;
targetPath?: string;
values: JsonObject;
copyWithoutRender?: string[] | undefined;
extensions?: string[] | undefined;
imageName?: string | undefined;
copyWithoutRender?: string[];
extensions?: string[];
imageName?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-gerrit/report.api.md
+10 -10
View File
@@ -17,11 +17,11 @@ export function createPublishGerritAction(options: {
{
repoUrl: string;
description: string;
defaultBranch?: string | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
sourcePath?: string | undefined;
defaultBranch?: string;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
sourcePath?: string;
},
JsonObject
>;
@@ -33,11 +33,11 @@ export function createPublishGerritReviewAction(options: {
}): TemplateAction<
{
repoUrl: string;
branch?: string | undefined;
sourcePath?: string | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
branch?: string;
sourcePath?: string;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-gitea/report.api.md
+6 -6
View File
@@ -17,12 +17,12 @@ export function createPublishGiteaAction(options: {
{
repoUrl: string;
description: string;
defaultBranch?: string | undefined;
repoVisibility?: 'private' | 'public' | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
sourcePath?: string | undefined;
defaultBranch?: string;
repoVisibility?: 'private' | 'public';
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
sourcePath?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-github/report.api.md
+193 -233
View File
@@ -25,12 +25,10 @@ export function createGithubActionsDispatchAction(options: {
repoUrl: string;
workflowId: string;
branchOrTagName: string;
workflowInputs?:
| {
[key: string]: string;
}
| undefined;
token?: string | undefined;
workflowInputs?: {
[key: string]: string;
};
token?: string;
},
JsonObject
>;
@@ -44,8 +42,8 @@ export function createGithubAutolinksAction(options: {
repoUrl: string;
keyPrefix: string;
urlTemplate: string;
isAlphanumeric?: boolean | undefined;
token?: string | undefined;
isAlphanumeric?: boolean;
token?: string;
},
JsonObject
>;
@@ -56,11 +54,11 @@ export function createGithubBranchProtectionAction(options: {
}): TemplateAction<
{
repoUrl: string;
branch?: string | undefined;
enforceAdmins?: boolean | undefined;
requiredApprovingReviewCount?: number | undefined;
requireCodeOwnerReviews?: boolean | undefined;
dismissStaleReviews?: boolean | undefined;
branch?: string;
enforceAdmins?: boolean;
requiredApprovingReviewCount?: number;
requireCodeOwnerReviews?: boolean;
dismissStaleReviews?: boolean;
bypassPullRequestAllowances?:
| {
users?: string[];
@@ -75,13 +73,13 @@ export function createGithubBranchProtectionAction(options: {
apps?: string[];
}
| undefined;
requiredStatusCheckContexts?: string[] | undefined;
requireBranchesToBeUpToDate?: boolean | undefined;
requiredConversationResolution?: boolean | undefined;
requireLastPushApproval?: boolean | undefined;
requiredCommitSigning?: boolean | undefined;
requiredLinearHistory?: boolean | undefined;
token?: string | undefined;
requiredStatusCheckContexts?: string[];
requireBranchesToBeUpToDate?: boolean;
requiredConversationResolution?: boolean;
requireLastPushApproval?: boolean;
requiredCommitSigning?: boolean;
requiredLinearHistory?: boolean;
token?: string;
},
JsonObject
>;
@@ -95,8 +93,8 @@ export function createGithubDeployKeyAction(options: {
publicKey: string;
privateKey: string;
deployKeyName: string;
privateKeySecretName?: string | undefined;
token?: string | undefined;
privateKeySecretName?: string;
token?: string;
},
JsonObject
>;
@@ -110,28 +108,22 @@ export function createGithubEnvironmentAction(options: {
{
repoUrl: string;
name: string;
deploymentBranchPolicy?:
| {
protected_branches: boolean;
custom_branch_policies: boolean;
}
| undefined;
customBranchPolicyNames?: string[] | undefined;
customTagPolicyNames?: string[] | undefined;
environmentVariables?:
| {
[key: string]: string;
}
| undefined;
secrets?:
| {
[key: string]: string;
}
| undefined;
token?: string | undefined;
waitTimer?: number | undefined;
preventSelfReview?: boolean | undefined;
reviewers?: string[] | undefined;
deploymentBranchPolicy?: {
protected_branches: boolean;
custom_branch_policies: boolean;
};
customBranchPolicyNames?: string[];
customTagPolicyNames?: string[];
environmentVariables?: {
[key: string]: string;
};
secrets?: {
[key: string]: string;
};
token?: string;
waitTimer?: number;
preventSelfReview?: boolean;
reviewers?: string[];
},
JsonObject
>;
@@ -145,7 +137,7 @@ export function createGithubIssuesLabelAction(options: {
repoUrl: string;
number: number;
labels: string[];
token?: string | undefined;
token?: string;
},
JsonObject
>;
@@ -157,10 +149,10 @@ export function createGithubPagesEnableAction(options: {
}): TemplateAction<
{
repoUrl: string;
buildType?: 'legacy' | 'workflow' | undefined;
sourceBranch?: string | undefined;
sourcePath?: '/' | '/docs' | undefined;
token?: string | undefined;
buildType?: 'legacy' | 'workflow';
sourceBranch?: string;
sourcePath?: '/' | '/docs';
token?: string;
},
JsonObject
>;
@@ -199,87 +191,69 @@ export function createGithubRepoCreateAction(options: {
}): TemplateAction<
{
repoUrl: string;
description?: string | undefined;
homepage?: string | undefined;
access?: string | undefined;
deleteBranchOnMerge?: boolean | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
allowRebaseMerge?: boolean | undefined;
allowSquashMerge?: boolean | undefined;
squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined;
squashMergeCommitMessage?:
| 'PR_BODY'
| 'COMMIT_MESSAGES'
| 'BLANK'
| undefined;
allowMergeCommit?: boolean | undefined;
allowAutoMerge?: boolean | undefined;
requireCodeOwnerReviews?: boolean | undefined;
bypassPullRequestAllowances?:
description?: string;
homepage?: string;
access?: string;
deleteBranchOnMerge?: boolean;
gitAuthorName?: string;
gitAuthorEmail?: string;
allowRebaseMerge?: boolean;
allowSquashMerge?: boolean;
squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE';
squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK';
allowMergeCommit?: boolean;
allowAutoMerge?: boolean;
requireCodeOwnerReviews?: boolean;
bypassPullRequestAllowances?: {
users?: string[];
teams?: string[];
apps?: string[];
};
requiredApprovingReviewCount?: number;
restrictions?: {
users: string[];
teams: string[];
apps?: string[];
};
requiredStatusCheckContexts?: string[];
requireBranchesToBeUpToDate?: boolean;
requiredConversationResolution?: boolean;
repoVisibility?: 'private' | 'internal' | 'public';
collaborators?: Array<
| {
users?: string[] | undefined;
teams?: string[] | undefined;
apps?: string[] | undefined;
user: string;
access: string;
}
| undefined;
requiredApprovingReviewCount?: number | undefined;
restrictions?:
| {
users: string[];
teams: string[];
apps?: string[] | undefined;
team: string;
access: string;
}
| undefined;
requiredStatusCheckContexts?: string[] | undefined;
requireBranchesToBeUpToDate?: boolean | undefined;
requiredConversationResolution?: boolean | undefined;
repoVisibility?: 'internal' | 'private' | 'public' | undefined;
collaborators?:
| (
| {
user: string;
access: string;
}
| {
team: string;
access: string;
}
| {
username: string;
access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
}
)[]
| undefined;
hasProjects?: boolean | undefined;
hasWiki?: boolean | undefined;
hasIssues?: boolean | undefined;
token?: string | undefined;
topics?: string[] | undefined;
repoVariables?:
| {
[key: string]: string;
username: string;
access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
}
| undefined;
secrets?:
| {
[key: string]: string;
}
| undefined;
oidcCustomization?:
| {
useDefault: boolean;
includeClaimKeys?: string[] | undefined;
}
| undefined;
requireCommitSigning?: boolean | undefined;
requiredLinearHistory?: boolean | undefined;
customProperties?:
| {
[key: string]: string;
}
| undefined;
subscribe?: boolean | undefined;
>;
hasProjects?: boolean;
hasWiki?: boolean;
hasIssues?: boolean;
token?: string;
topics?: string[];
repoVariables?: {
[key: string]: string;
};
secrets?: {
[key: string]: string;
};
oidcCustomization?: {
useDefault: boolean;
includeClaimKeys?: string[];
};
requireCommitSigning?: boolean;
requiredLinearHistory?: boolean;
customProperties?: {
[key: string]: string;
};
subscribe?: boolean;
},
JsonObject
>;
@@ -292,15 +266,15 @@ export function createGithubRepoPushAction(options: {
}): TemplateAction<
{
repoUrl: string;
description?: string | undefined;
defaultBranch?: string | undefined;
protectDefaultBranch?: boolean | undefined;
protectEnforceAdmins?: boolean | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
requireCodeOwnerReviews?: boolean | undefined;
dismissStaleReviews?: boolean | undefined;
description?: string;
defaultBranch?: string;
protectDefaultBranch?: boolean;
protectEnforceAdmins?: boolean;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
requireCodeOwnerReviews?: boolean;
dismissStaleReviews?: boolean;
bypassPullRequestAllowances?:
| {
users?: string[];
@@ -308,7 +282,7 @@ export function createGithubRepoPushAction(options: {
apps?: string[];
}
| undefined;
requiredApprovingReviewCount?: number | undefined;
requiredApprovingReviewCount?: number;
restrictions?:
| {
users: string[];
@@ -316,14 +290,14 @@ export function createGithubRepoPushAction(options: {
apps?: string[];
}
| undefined;
requiredStatusCheckContexts?: string[] | undefined;
requireBranchesToBeUpToDate?: boolean | undefined;
requiredConversationResolution?: boolean | undefined;
sourcePath?: string | undefined;
token?: string | undefined;
requiredCommitSigning?: boolean | undefined;
requiredLinearHistory?: boolean | undefined;
requireLastPushApproval?: boolean | undefined;
requiredStatusCheckContexts?: string[];
requireBranchesToBeUpToDate?: boolean;
requiredConversationResolution?: boolean;
sourcePath?: string;
token?: string;
requiredCommitSigning?: boolean;
requiredLinearHistory?: boolean;
requireLastPushApproval?: boolean;
},
JsonObject
>;
@@ -337,12 +311,12 @@ export function createGithubWebhookAction(options: {
{
repoUrl: string;
webhookUrl: string;
webhookSecret?: string | undefined;
events?: string[] | undefined;
active?: boolean | undefined;
contentType?: 'form' | 'json' | undefined;
insecureSsl?: boolean | undefined;
token?: string | undefined;
webhookSecret?: string;
events?: string[];
active?: boolean;
contentType?: 'form' | 'json';
insecureSsl?: boolean;
token?: string;
},
JsonObject
>;
@@ -355,27 +329,23 @@ export function createPublishGithubAction(options: {
}): TemplateAction<
{
repoUrl: string;
description?: string | undefined;
homepage?: string | undefined;
access?: string | undefined;
defaultBranch?: string | undefined;
protectDefaultBranch?: boolean | undefined;
protectEnforceAdmins?: boolean | undefined;
deleteBranchOnMerge?: boolean | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
allowRebaseMerge?: boolean | undefined;
allowSquashMerge?: boolean | undefined;
squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined;
squashMergeCommitMessage?:
| 'PR_BODY'
| 'COMMIT_MESSAGES'
| 'BLANK'
| undefined;
allowMergeCommit?: boolean | undefined;
allowAutoMerge?: boolean | undefined;
sourcePath?: string | undefined;
description?: string;
homepage?: string;
access?: string;
defaultBranch?: string;
protectDefaultBranch?: boolean;
protectEnforceAdmins?: boolean;
deleteBranchOnMerge?: boolean;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
allowRebaseMerge?: boolean;
allowSquashMerge?: boolean;
squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE';
squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK';
allowMergeCommit?: boolean;
allowAutoMerge?: boolean;
sourcePath?: string;
bypassPullRequestAllowances?:
| {
users?: string[];
@@ -383,7 +353,7 @@ export function createPublishGithubAction(options: {
apps?: string[];
}
| undefined;
requiredApprovingReviewCount?: number | undefined;
requiredApprovingReviewCount?: number;
restrictions?:
| {
users: string[];
@@ -391,58 +361,48 @@ export function createPublishGithubAction(options: {
apps?: string[];
}
| undefined;
requireCodeOwnerReviews?: boolean | undefined;
dismissStaleReviews?: boolean | undefined;
requiredStatusCheckContexts?: string[] | undefined;
requireBranchesToBeUpToDate?: boolean | undefined;
requiredConversationResolution?: boolean | undefined;
requireLastPushApproval?: boolean | undefined;
repoVisibility?: 'internal' | 'private' | 'public' | undefined;
collaborators?:
| (
| {
user: string;
access: string;
}
| {
team: string;
access: string;
}
| {
username: string;
access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
}
)[]
| undefined;
requireCodeOwnerReviews?: boolean;
dismissStaleReviews?: boolean;
requiredStatusCheckContexts?: string[];
requireBranchesToBeUpToDate?: boolean;
requiredConversationResolution?: boolean;
requireLastPushApproval?: boolean;
repoVisibility?: 'private' | 'internal' | 'public';
collaborators?: Array<
| {
user: string;
access: string;
}
| {
team: string;
access: string;
}
| {
username: string;
access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
}
>;
hasProjects?: boolean | undefined;
hasWiki?: boolean | undefined;
hasIssues?: boolean | undefined;
token?: string | undefined;
topics?: string[] | undefined;
repoVariables?:
| {
[key: string]: string;
}
| undefined;
secrets?:
| {
[key: string]: string;
}
| undefined;
oidcCustomization?:
| {
useDefault: boolean;
includeClaimKeys?: string[] | undefined;
}
| undefined;
requiredCommitSigning?: boolean | undefined;
requiredLinearHistory?: boolean | undefined;
customProperties?:
| {
[key: string]: string;
}
| undefined;
subscribe?: boolean | undefined;
token?: string;
topics?: string[];
repoVariables?: {
[key: string]: string;
};
secrets?: {
[key: string]: string;
};
oidcCustomization?: {
useDefault: boolean;
includeClaimKeys?: string[];
};
requiredCommitSigning?: boolean;
requiredLinearHistory?: boolean;
customProperties?: {
[key: string]: string;
};
subscribe?: boolean;
},
JsonObject
>;
@@ -454,22 +414,22 @@ export const createPublishGithubPullRequestAction: (
{
title: string;
branchName: string;
targetBranchName?: string | undefined;
targetBranchName?: string;
description: string;
repoUrl: string;
draft?: boolean | undefined;
targetPath?: string | undefined;
sourcePath?: string | undefined;
token?: string | undefined;
reviewers?: string[] | undefined;
teamReviewers?: string[] | undefined;
commitMessage?: string | undefined;
update?: boolean | undefined;
forceFork?: boolean | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
forceEmptyGitAuthor?: boolean | undefined;
createWhenEmpty?: boolean | undefined;
draft?: boolean;
targetPath?: string;
sourcePath?: string;
token?: string;
reviewers?: string[];
teamReviewers?: string[];
commitMessage?: string;
update?: boolean;
forceFork?: boolean;
gitAuthorName?: string;
gitAuthorEmail?: string;
forceEmptyGitAuthor?: boolean;
createWhenEmpty?: boolean;
},
JsonObject
>;
plugins/scaffolder-backend-module-gitlab/report.api.md
+53 -66
View File
@@ -121,10 +121,10 @@ export const createGitlabRepoPushAction: (options: {
repoUrl: string;
branchName: string;
commitMessage: string;
sourcePath?: string | undefined;
targetPath?: string | undefined;
token?: string | undefined;
commitAction?: 'update' | 'delete' | 'create' | undefined;
sourcePath?: string;
targetPath?: string;
token?: string;
commitAction?: 'create' | 'delete' | 'update';
},
JsonObject
>;
@@ -136,58 +136,45 @@ export function createPublishGitlabAction(options: {
}): TemplateAction<
{
repoUrl: string;
defaultBranch?: string | undefined;
repoVisibility?: 'internal' | 'private' | 'public' | undefined;
sourcePath?: string | boolean | undefined;
skipExisting?: boolean | undefined;
token?: string | undefined;
gitCommitMessage?: string | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
setUserAsOwner?: boolean | undefined;
topics?: string[] | undefined;
settings?:
| {
path?: string | undefined;
auto_devops_enabled?: boolean | undefined;
ci_config_path?: string | undefined;
description?: string | undefined;
merge_method?: 'merge' | 'ff' | 'rebase_merge' | undefined;
squash_option?:
| 'always'
| 'never'
| 'default_on'
| 'default_off'
| undefined;
topics?: string[] | undefined;
visibility?: 'internal' | 'private' | 'public' | undefined;
only_allow_merge_if_all_discussions_are_resolved?:
| boolean
| undefined;
only_allow_merge_if_pipeline_succeeds?: boolean | undefined;
allow_merge_on_skipped_pipeline?: boolean | undefined;
}
| undefined;
branches?:
| {
name: string;
protect?: boolean | undefined;
create?: boolean | undefined;
ref?: string | undefined;
}[]
| undefined;
projectVariables?:
| {
key: string;
value: string;
description?: string | undefined;
variable_type?: string | undefined;
protected?: boolean | undefined;
masked?: boolean | undefined;
raw?: boolean | undefined;
environment_scope?: string | undefined;
}[]
| undefined;
defaultBranch?: string;
repoVisibility?: 'private' | 'internal' | 'public';
sourcePath?: string | boolean;
skipExisting?: boolean;
token?: string;
gitCommitMessage?: string;
gitAuthorName?: string;
gitAuthorEmail?: string;
setUserAsOwner?: boolean;
topics?: string[];
settings?: {
path?: string;
auto_devops_enabled?: boolean;
ci_config_path?: string;
description?: string;
merge_method?: 'merge' | 'rebase_merge' | 'ff';
squash_option?: 'default_off' | 'default_on' | 'never' | 'always';
topics?: string[];
visibility?: 'private' | 'internal' | 'public';
only_allow_merge_if_all_discussions_are_resolved?: boolean;
only_allow_merge_if_pipeline_succeeds?: boolean;
allow_merge_on_skipped_pipeline?: boolean;
};
branches?: Array<{
name: string;
protect?: boolean;
create?: boolean;
ref?: string;
}>;
projectVariables?: Array<{
key: string;
value: string;
description?: string;
variable_type?: string;
protected?: boolean;
masked?: boolean;
raw?: boolean;
environment_scope?: string;
}>;
},
JsonObject
>;
@@ -201,16 +188,16 @@ export const createPublishGitlabMergeRequestAction: (options: {
title: string;
description: string;
branchName: string;
targetBranchName?: string | undefined;
sourcePath?: string | undefined;
targetPath?: string | undefined;
token?: string | undefined;
commitAction?: 'auto' | 'update' | 'delete' | 'create' | 'skip' | undefined;
projectid?: string | undefined;
removeSourceBranch?: boolean | undefined;
assignee?: string | undefined;
reviewers?: string[] | undefined;
assignReviewersFromApprovalRules?: boolean | undefined;
targetBranchName?: string;
sourcePath?: string;
targetPath?: string;
token?: string;
commitAction?: 'create' | 'delete' | 'update' | 'skip' | 'auto';
projectid?: string;
removeSourceBranch?: boolean;
assignee?: string;
reviewers?: string[];
assignReviewersFromApprovalRules?: boolean;
},
JsonObject
>;
plugins/scaffolder-backend-module-notifications/report.api.md
+6 -6
View File
@@ -15,13 +15,13 @@ export function createSendNotificationAction(options: {
}): TemplateAction<
{
recipients: string;
entityRefs?: string[] | undefined;
entityRefs?: string[];
title: string;
info?: string | undefined;
link?: string | undefined;
severity?: NotificationSeverity | undefined;
scope?: string | undefined;
optional?: boolean | undefined;
info?: string;
link?: string;
severity?: NotificationSeverity;
scope?: string;
optional?: boolean;
},
JsonObject
>;
plugins/scaffolder-backend-module-rails/report.api.md
+2 -4
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackendFeature } from '@backstage/backend-plugin-api';
import { JsonObject } from '@backstage/types';
import { ScmIntegrations } from '@backstage/integration';
@@ -47,9 +45,9 @@ export function createFetchRailsAction(options: {
}): TemplateAction<
{
url: string;
targetPath?: string | undefined;
targetPath?: string;
values: JsonObject;
imageName?: string | undefined;
imageName?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-sentry/report.api.md
+2 -2
View File
@@ -16,8 +16,8 @@ export function createSentryCreateProjectAction(options: {
organizationSlug: string;
teamSlug: string;
name: string;
slug?: string | undefined;
authToken?: string | undefined;
slug?: string;
authToken?: string;
},
JsonObject
>;
plugins/scaffolder-backend-module-yeoman/report.api.md
+2 -2
View File
@@ -11,8 +11,8 @@ import { TemplateAction } from '@backstage/plugin-scaffolder-node';
export function createRunYeomanAction(): TemplateAction<
{
namespace: string;
args?: string[] | undefined;
options?: JsonObject | undefined;
args?: string[];
options?: JsonObject;
},
JsonObject
>;
plugins/scaffolder-backend/report.api.md
+48 -51
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { ActionContext as ActionContext_2 } from '@backstage/plugin-scaffolder-node';
import { AuditorService } from '@backstage/backend-plugin-api';
import { AuthService } from '@backstage/backend-plugin-api';
@@ -81,7 +79,6 @@ import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
import { UrlReaderService } from '@backstage/backend-plugin-api';
import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
import { ZodType } from 'zod';
import { ZodTypeDef } from 'zod';
// @public @deprecated (undocumented)
export type ActionContext<TInput extends JsonObject> = ActionContext_2<TInput>;
@@ -121,12 +118,12 @@ export function createCatalogRegisterAction(options: {
}): TemplateAction_2<
| {
catalogInfoUrl: string;
optional?: boolean | undefined;
optional?: boolean;
}
| {
repoContentsUrl: string;
catalogInfoPath?: string | undefined;
optional?: boolean | undefined;
catalogInfoPath?: string;
optional?: boolean;
},
JsonObject
>;
@@ -143,8 +140,8 @@ export function createCatalogWriteAction(): TemplateAction_2<
// @public
export function createDebugLogAction(): TemplateAction_2<
{
message?: string | undefined;
listWorkspace?: boolean | 'with-contents' | 'with-filenames' | undefined;
message?: string;
listWorkspace?: boolean | 'with-filenames' | 'with-contents';
},
JsonObject
>;
@@ -174,8 +171,8 @@ export function createFetchPlainAction(options: {
}): TemplateAction_2<
{
url: string;
targetPath?: string | undefined;
token?: string | undefined;
targetPath?: string;
token?: string;
},
JsonObject
>;
@@ -188,7 +185,7 @@ export function createFetchPlainFileAction(options: {
{
url: string;
targetPath: string;
token?: string | undefined;
token?: string;
},
JsonObject
>;
@@ -202,16 +199,16 @@ export function createFetchTemplateAction(options: {
}): TemplateAction_2<
{
url: string;
targetPath?: string | undefined;
targetPath?: string;
values: any;
templateFileExtension?: string | boolean | undefined;
copyWithoutRender?: string[] | undefined;
copyWithoutTemplating?: string[] | undefined;
cookiecutterCompat?: boolean | undefined;
replace?: boolean | undefined;
trimBlocks?: boolean | undefined;
lstripBlocks?: boolean | undefined;
token?: string | undefined;
templateFileExtension?: string | boolean;
copyWithoutRender?: string[];
copyWithoutTemplating?: string[];
cookiecutterCompat?: boolean;
replace?: boolean;
trimBlocks?: boolean;
lstripBlocks?: boolean;
token?: string;
},
JsonObject
>;
@@ -227,11 +224,11 @@ export function createFetchTemplateFileAction(options: {
url: string;
targetPath: string;
values: any;
cookiecutterCompat?: boolean | undefined;
replace?: boolean | undefined;
trimBlocks?: boolean | undefined;
lstripBlocks?: boolean | undefined;
token?: string | undefined;
cookiecutterCompat?: boolean;
replace?: boolean;
trimBlocks?: boolean;
lstripBlocks?: boolean;
token?: string;
},
JsonObject
>;
@@ -332,22 +329,22 @@ export const createPublishGithubPullRequestAction: (
{
title: string;
branchName: string;
targetBranchName?: string | undefined;
targetBranchName?: string;
description: string;
repoUrl: string;
draft?: boolean | undefined;
targetPath?: string | undefined;
sourcePath?: string | undefined;
token?: string | undefined;
reviewers?: string[] | undefined;
teamReviewers?: string[] | undefined;
commitMessage?: string | undefined;
update?: boolean | undefined;
forceFork?: boolean | undefined;
gitAuthorName?: string | undefined;
gitAuthorEmail?: string | undefined;
forceEmptyGitAuthor?: boolean | undefined;
createWhenEmpty?: boolean | undefined;
draft?: boolean;
targetPath?: string;
sourcePath?: string;
token?: string;
reviewers?: string[];
teamReviewers?: string[];
commitMessage?: string;
update?: boolean;
forceFork?: boolean;
gitAuthorName?: string;
gitAuthorEmail?: string;
forceEmptyGitAuthor?: boolean;
createWhenEmpty?: boolean;
},
JsonObject
>;
@@ -364,16 +361,16 @@ export const createPublishGitlabMergeRequestAction: (options: {
title: string;
description: string;
branchName: string;
targetBranchName?: string | undefined;
sourcePath?: string | undefined;
targetPath?: string | undefined;
token?: string | undefined;
commitAction?: 'auto' | 'update' | 'delete' | 'create' | 'skip' | undefined;
projectid?: string | undefined;
removeSourceBranch?: boolean | undefined;
assignee?: string | undefined;
reviewers?: string[] | undefined;
assignReviewersFromApprovalRules?: boolean | undefined;
targetBranchName?: string;
sourcePath?: string;
targetPath?: string;
token?: string;
commitAction?: 'create' | 'delete' | 'update' | 'skip' | 'auto';
projectid?: string;
removeSourceBranch?: boolean;
assignee?: string;
reviewers?: string[];
assignReviewersFromApprovalRules?: boolean;
},
JsonObject
>;
@@ -385,8 +382,8 @@ export function createRouter(options: RouterOptions): Promise<express.Router>;
export const createTemplateAction: <
TInputParams extends JsonObject = JsonObject,
TOutputParams extends JsonObject = JsonObject,
TInputSchema extends ZodType<any, ZodTypeDef, any> | Schema = {},
TOutputSchema extends ZodType<any, ZodTypeDef, any> | Schema = {},
TInputSchema extends Schema | ZodType = {},
TOutputSchema extends Schema | ZodType = {},
TActionInput extends JsonObject = TInputSchema extends ZodType<
any,
any,
plugins/scaffolder-node-test-utils/report.api.md
+1 -1
View File
@@ -11,7 +11,7 @@ export const createMockActionContext: <
TActionInput extends JsonObject = JsonObject,
TActionOutput extends JsonObject = JsonObject,
>(
options?: Partial<ActionContext<TActionInput, TActionOutput>> | undefined,
options?: Partial<ActionContext<TActionInput, TActionOutput>>,
) => ActionContext<TActionInput, TActionOutput>;
// (No @packageDocumentation comment for this package)
plugins/scaffolder-node/report-alpha.api.md
+2 -4
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { JsonValue } from '@backstage/types';
import { TaskBroker } from '@backstage/plugin-scaffolder-node';
@@ -94,7 +92,7 @@ export type CreatedTemplateGlobalValue<T extends JsonValue = JsonValue> = {
export const createTemplateFilter: <
TSchema extends TemplateFilterSchema<any, any> | undefined,
TFunctionSchema extends TSchema extends TemplateFilterSchema<any, any>
? z.TypeOf<ReturnType<TSchema>>
? z.infer<ReturnType<TSchema>>
: (arg: JsonValue, ...rest: JsonValue[]) => JsonValue | undefined,
>(
filter: CreatedTemplateFilter<TSchema, TFunctionSchema>,
@@ -104,7 +102,7 @@ export const createTemplateFilter: <
export const createTemplateGlobalFunction: <
TSchema extends TemplateGlobalFunctionSchema<any, any> | undefined,
TFilterSchema extends TSchema extends TemplateGlobalFunctionSchema<any, any>
? z.TypeOf<ReturnType<TSchema>>
? z.infer<ReturnType<TSchema>>
: (...args: JsonValue[]) => JsonValue | undefined,
>(
fn: CreatedTemplateGlobalFunction<TSchema, TFilterSchema>,
plugins/scaffolder-node/report.api.md
+6 -8
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackstageCredentials } from '@backstage/backend-plugin-api';
import { JsonObject } from '@backstage/types';
import { JsonValue } from '@backstage/types';
@@ -154,8 +152,8 @@ export function createBranch(options: {
export const createTemplateAction: <
TInputParams extends JsonObject = JsonObject,
TOutputParams extends JsonObject = JsonObject,
TInputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {},
TOutputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {},
TInputSchema extends Schema | z.ZodType = {},
TOutputSchema extends Schema | z.ZodType = {},
TActionInput extends JsonObject = TInputSchema extends z.ZodType<
any,
any,
@@ -255,10 +253,10 @@ export const parseRepoUrl: (
) => {
repo: string;
host: string;
owner?: string | undefined;
organization?: string | undefined;
workspace?: string | undefined;
project?: string | undefined;
owner?: string;
organization?: string;
workspace?: string;
project?: string;
};
// @public (undocumented)
plugins/scaffolder-react/report-alpha.api.md
+3 -5
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyApiRef } from '@backstage/core-plugin-api';
import { ApiHolder } from '@backstage/core-plugin-api';
@@ -487,15 +485,15 @@ export const useFormDataFromQuery: (
// @alpha (undocumented)
export const useTemplateParameterSchema: (templateRef: string) => {
manifest?: TemplateParameterSchema | undefined;
manifest?: TemplateParameterSchema;
loading: boolean;
error?: Error | undefined;
error?: Error;
};
// @alpha
export const useTemplateSchema: (manifest: TemplateParameterSchema) => {
steps: ParsedTemplateSchema[];
presentation?: TemplatePresentationV1beta3 | undefined;
presentation?: TemplatePresentationV1beta3;
};
// @alpha (undocumented)
plugins/scaffolder-react/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiHolder } from '@backstage/core-plugin-api';
import { ApiRef } from '@backstage/frontend-plugin-api';
import { ComponentType } from 'react';
plugins/scaffolder/report-alpha.api.md
+2 -4
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { ApiRef } from '@backstage/frontend-plugin-api';
@@ -178,7 +176,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
'scaffolder-form-field:scaffolder/repo-url-picker': ExtensionDefinition<{
@@ -326,8 +324,8 @@ export const scaffolderTranslationRef: TranslationRef<
readonly 'fields.repoUrlPicker.repository.inputTitle': 'Repository';
readonly 'actionsPage.content.emptyState.title': 'No information to display';
readonly 'actionsPage.content.emptyState.description': 'There are no actions installed or there was an issue communicating with backend.';
readonly 'actionsPage.content.tableCell.type': 'Type';
readonly 'actionsPage.content.tableCell.name': 'Name';
readonly 'actionsPage.content.tableCell.type': 'Type';
readonly 'actionsPage.content.tableCell.title': 'Title';
readonly 'actionsPage.content.tableCell.description': 'Description';
readonly 'actionsPage.content.searchFieldPlaceholder': 'Search for an action';
plugins/scaffolder/report.api.md
+2 -4
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiHolder } from '@backstage/core-plugin-api';
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
@@ -580,7 +578,7 @@ export type ScaffolderDryRunResponse = ScaffolderDryRunResponse_2;
// @public @deprecated (undocumented)
export const ScaffolderFieldExtensions: ComponentType<{
children?: ReactNode;
children?: ReactNode | undefined;
}>;
// @public @deprecated (undocumented)
@@ -593,7 +591,7 @@ export type ScaffolderGetIntegrationsListResponse =
// @public @deprecated (undocumented)
export const ScaffolderLayouts: ComponentType<{
children?: ReactNode;
children?: ReactNode | undefined;
}>;
// @public @deprecated (undocumented)
plugins/search-backend-module-elasticsearch/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { ApiResponse } from '@opensearch-project/opensearch';
import { ApiResponse as ApiResponse_2 } from '@elastic/elasticsearch';
import { BackendFeature } from '@backstage/backend-plugin-api';
plugins/search-backend-module-explore/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AuthService } from '@backstage/backend-plugin-api';
import { BackendFeature } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
plugins/search-backend-module-stack-overflow-collator/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackendFeature } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
plugins/search-backend-module-techdocs/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AuthService } from '@backstage/backend-plugin-api';
import { BackendFeature } from '@backstage/backend-plugin-api';
import { CatalogApi } from '@backstage/catalog-client';
plugins/search-backend-node/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackstageCredentials } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
plugins/search-common/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { JsonObject } from '@backstage/types';
import { Permission } from '@backstage/plugin-permission-common';
import { Readable } from 'stream';
plugins/search-react/report-alpha.api.md
+2 -4
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { ExtensionBlueprint } from '@backstage/frontend-plugin-api';
import { ListItemProps } from '@material-ui/core/ListItem';
@@ -115,7 +113,7 @@ export const SearchResultListItemBlueprint: ExtensionBlueprint<{
params: SearchResultListItemBlueprintParams;
output: ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
predicate?: SearchResultItemExtensionPredicate;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
@@ -131,7 +129,7 @@ export const SearchResultListItemBlueprint: ExtensionBlueprint<{
dataRefs: {
item: ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
predicate?: SearchResultItemExtensionPredicate;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
plugins/search-react/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { AsyncState } from 'react-use/esm/useAsync';
import { AutocompleteProps } from '@material-ui/lab/Autocomplete';
plugins/search/report-alpha.api.md
+4 -4
View File
@@ -88,7 +88,7 @@ const _default: FrontendPlugin<
items: ExtensionInput<
ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
predicate?: SearchResultItemExtensionPredicate;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
@@ -133,7 +133,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}
@@ -202,7 +202,7 @@ export const searchPage: ExtensionDefinition<{
items: ExtensionInput<
ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
predicate?: SearchResultItemExtensionPredicate;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
@@ -247,7 +247,7 @@ export const searchPage: ExtensionDefinition<{
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
plugins/search/report.api.md
+1 -3
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react';
@@ -16,7 +14,7 @@ import { SearchResultSet } from '@backstage/plugin-search-common';
// @public (undocumented)
export const HomePageSearchBar: (
props: Partial<Omit<SearchBarBaseProps, 'onChange' | 'onSubmit'>>,
props: HomePageSearchBarProps,
) => JSX_2.Element;
// @public
plugins/techdocs-module-addons-contrib/report.api.md
-2
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstagePlugin } from '@backstage/core-plugin-api';
// @public
plugins/techdocs-node/report.api.md
+4 -8
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { CompoundEntityRef } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import { DiscoveryService } from '@backstage/backend-plugin-api';
@@ -100,12 +98,10 @@ export const getLocationForEntity: (
// @public @deprecated (undocumented)
export const getMkDocsYml: (
inputDir: string,
options?:
| {
name?: string | undefined;
mkdocsConfigFileName?: string | undefined;
}
| undefined,
options?: {
name?: string;
mkdocsConfigFileName?: string;
},
) => Promise<{
path: string;
content: string;
plugins/techdocs/report-alpha.api.md
+8 -13
View File
@@ -7,6 +7,7 @@ import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha';
import { Entity } from '@backstage/catalog-model';
import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
@@ -171,15 +172,9 @@ const _default: FrontendPlugin<
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?:
| (string & {})
| 'documentation'
| 'development'
| 'deployment'
| 'observability'
| undefined;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined;
defaultGroup?: keyof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
}>;
'nav-item:techdocs': ExtensionDefinition<{
@@ -230,7 +225,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
'page:techdocs/reader': ExtensionDefinition<{
@@ -272,7 +267,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
'search-result-list-item:techdocs': ExtensionDefinition<{
@@ -294,7 +289,7 @@ const _default: FrontendPlugin<
};
output: ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
predicate?: SearchResultItemExtensionPredicate;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
@@ -337,7 +332,7 @@ export const techDocsSearchResultListItemExtension: ExtensionDefinition<{
};
output: ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
predicate?: SearchResultItemExtensionPredicate;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
plugins/techdocs/report.api.md
+9 -19
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CompoundEntityRef } from '@backstage/catalog-model';
@@ -106,13 +104,9 @@ export type DocsGroupConfig = {
export const DocsTable: {
(props: DocsTableProps): React_2.JSX.Element | null;
columns: {
createTitleColumn(
options?:
| {
hidden?: boolean | undefined;
}
| undefined,
): TableColumn<DocsTableRow>;
createTitleColumn(options?: {
hidden?: boolean;
}): TableColumn<DocsTableRow>;
createNameColumn(): TableColumn<DocsTableRow>;
createOwnerColumn(): TableColumn<DocsTableRow>;
createKindColumn(): TableColumn<DocsTableRow>;
@@ -162,8 +156,8 @@ export type DocsTableRow = {
export const EmbeddedDocsRouter: ({
children,
withSearch,
}: React_2.PropsWithChildren<{
withSearch?: boolean | undefined;
}: PropsWithChildren<{
withSearch?: boolean;
}>) => React_2.JSX.Element;
// @public
@@ -180,13 +174,9 @@ export type EntityListDocsGridPageProps = {
export const EntityListDocsTable: {
(props: EntityListDocsTableProps): React_2.JSX.Element;
columns: {
createTitleColumn(
options?:
| {
hidden?: boolean | undefined;
}
| undefined,
): TableColumn<DocsTableRow>;
createTitleColumn(options?: {
hidden?: boolean;
}): TableColumn<DocsTableRow>;
createNameColumn(): TableColumn<DocsTableRow>;
createOwnerColumn(): TableColumn<DocsTableRow>;
createKindColumn(): TableColumn<DocsTableRow>;
@@ -224,7 +214,7 @@ export const EntityTechdocsContent: ({
children,
withSearch,
}: PropsWithChildren<{
withSearch?: boolean | undefined;
withSearch?: boolean;
}>) => JSX_2.Element;
// @public
plugins/user-settings/report-alpha.api.md
+1 -1
View File
@@ -80,7 +80,7 @@ const _default: FrontendPlugin<
params: {
defaultPath: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef<AnyRouteRefParams> | undefined;
routeRef?: RouteRef;
};
}>;
}

Some files were not shown because too many files have changed in this diff Show More