Merge pull request #6076 from backstage/rugvip/allreports
scripts/api-extractor: create and check API reports for all(most) plugins
This commit is contained in:
@@ -0,0 +1,115 @@
|
||||
## API Report File for "@backstage/plugin-api-docs"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiEntity } from '@backstage/catalog-model';
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { CatalogTableRow } from '@backstage/plugin-catalog';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { ExternalRouteRef } from '@backstage/core';
|
||||
import { default as React_2 } from 'react';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
import { TableColumn } from '@backstage/core';
|
||||
import { UserListFilterKind } from '@backstage/plugin-catalog-react';
|
||||
|
||||
// @public (undocumented)
|
||||
export const ApiDefinitionCard: (_: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type ApiDefinitionWidget = {
|
||||
type: string;
|
||||
title: string;
|
||||
component: (definition: string) => React_2.ReactElement;
|
||||
rawLanguage?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const apiDocsConfigRef: ApiRef<ApiDocsConfig>;
|
||||
|
||||
// @public (undocumented)
|
||||
const apiDocsPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {
|
||||
createComponent: ExternalRouteRef<undefined, true>;
|
||||
}>;
|
||||
|
||||
export { apiDocsPlugin }
|
||||
|
||||
export { apiDocsPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const ApiExplorerPage: ({ initiallySelectedFilter, columns, }: ApiExplorerPageProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ApiTypeTitle: ({ apiEntity }: {
|
||||
apiEntity: ApiEntity;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const AsyncApiDefinitionWidget: ({ definition }: Props_5) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ConsumedApisCard: ({ variant }: Props_2) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ConsumingComponentsCard: ({ variant }: Props_6) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export function defaultDefinitionWidgets(): ApiDefinitionWidget[];
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityApiDefinitionCard: (_: {
|
||||
apiEntity?: ApiEntity | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityConsumedApisCard: ({ variant }: {
|
||||
entity?: Entity| undefined;
|
||||
variant?: "gridItem" | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityConsumingComponentsCard: ({ variant }: {
|
||||
entity?: Entity| undefined;
|
||||
variant?: "gridItem" | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityHasApisCard: ({ variant }: {
|
||||
variant?: "gridItem" | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityProvidedApisCard: ({ variant }: {
|
||||
entity?: Entity| undefined;
|
||||
variant?: "gridItem" | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityProvidingComponentsCard: ({ variant }: {
|
||||
entity?: Entity| undefined;
|
||||
variant?: "gridItem" | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const HasApisCard: ({ variant }: Props_3) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const OpenApiDefinitionWidget: ({ definition }: Props_8) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const PlainApiDefinitionWidget: ({ definition, language }: Props_9) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ProvidedApisCard: ({ variant }: Props_4) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ProvidingComponentsCard: ({ variant }: Props_7) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,28 @@
|
||||
## API Report File for "@backstage/plugin-app-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
appPackageName: string;
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
disableConfigInjection?: boolean;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
staticFallbackHandler?: express.Handler;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,211 @@
|
||||
## API Report File for "@backstage/plugin-auth-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { CatalogApi } from '@backstage/catalog-client';
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { JSONWebKey } from 'jose';
|
||||
import { Logger } from 'winston';
|
||||
import { PluginDatabaseManager } from '@backstage/backend-common';
|
||||
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
||||
import { Profile } from 'passport';
|
||||
|
||||
// @public (undocumented)
|
||||
export type AuthProviderFactory = (options: AuthProviderFactoryOptions) => AuthProviderRouteHandlers;
|
||||
|
||||
// @public (undocumented)
|
||||
export type AuthProviderFactoryOptions = {
|
||||
providerId: string;
|
||||
globalConfig: AuthProviderConfig;
|
||||
config: Config;
|
||||
logger: Logger;
|
||||
tokenIssuer: TokenIssuer;
|
||||
discovery: PluginEndpointDiscovery;
|
||||
catalogApi: CatalogApi;
|
||||
identityResolver?: ExperimentalIdentityResolver;
|
||||
};
|
||||
|
||||
// @public
|
||||
export interface AuthProviderRouteHandlers {
|
||||
frameHandler(req: express.Request, res: express.Response): Promise<void>;
|
||||
logout?(req: express.Request, res: express.Response): Promise<void>;
|
||||
refresh?(req: express.Request, res: express.Response): Promise<void>;
|
||||
start(req: express.Request, res: express.Response): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type AuthResponse<ProviderInfo> = {
|
||||
providerInfo: ProviderInfo;
|
||||
profile: ProfileInfo;
|
||||
backstageIdentity?: BackstageIdentity;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type BackstageIdentity = {
|
||||
id: string;
|
||||
idToken?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter({ logger, config, discovery, database, providerFactories, }: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const defaultAuthProviderFactories: {
|
||||
[providerId: string]: AuthProviderFactory;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const encodeState: (state: OAuthState) => string;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ensuresXRequestedWith: (req: express.Request) => boolean;
|
||||
|
||||
// @public
|
||||
export class IdentityClient {
|
||||
constructor(options: {
|
||||
discovery: PluginEndpointDiscovery;
|
||||
issuer: string;
|
||||
});
|
||||
authenticate(token: string | undefined): Promise<BackstageIdentity>;
|
||||
static getBearerToken(authorizationHeader: string | undefined): string | undefined;
|
||||
listPublicKeys(): Promise<{
|
||||
keys: JSONWebKey[];
|
||||
}>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class OAuthAdapter implements AuthProviderRouteHandlers {
|
||||
constructor(handlers: OAuthHandlers, options: Options);
|
||||
// (undocumented)
|
||||
frameHandler(req: express.Request, res: express.Response): Promise<void>;
|
||||
// (undocumented)
|
||||
static fromConfig(config: AuthProviderConfig, handlers: OAuthHandlers, options: Pick<Options, 'providerId' | 'persistScopes' | 'disableRefresh' | 'tokenIssuer'>): OAuthAdapter;
|
||||
// (undocumented)
|
||||
logout(req: express.Request, res: express.Response): Promise<void>;
|
||||
// (undocumented)
|
||||
refresh(req: express.Request, res: express.Response): Promise<void>;
|
||||
// (undocumented)
|
||||
start(req: express.Request, res: express.Response): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class OAuthEnvironmentHandler implements AuthProviderRouteHandlers {
|
||||
constructor(handlers: Map<string, AuthProviderRouteHandlers>);
|
||||
// (undocumented)
|
||||
frameHandler(req: express.Request, res: express.Response): Promise<void>;
|
||||
// (undocumented)
|
||||
logout(req: express.Request, res: express.Response): Promise<void>;
|
||||
// (undocumented)
|
||||
static mapConfig(config: Config, factoryFunc: (envConfig: Config) => AuthProviderRouteHandlers): OAuthEnvironmentHandler;
|
||||
// (undocumented)
|
||||
refresh(req: express.Request, res: express.Response): Promise<void>;
|
||||
// (undocumented)
|
||||
start(req: express.Request, res: express.Response): Promise<void>;
|
||||
}
|
||||
|
||||
// @public
|
||||
export interface OAuthHandlers {
|
||||
handler(req: express.Request): Promise<{
|
||||
response: AuthResponse<OAuthProviderInfo>;
|
||||
refreshToken?: string;
|
||||
}>;
|
||||
logout?(): Promise<void>;
|
||||
refresh?(req: OAuthRefreshRequest): Promise<AuthResponse<OAuthProviderInfo>>;
|
||||
start(req: OAuthStartRequest): Promise<RedirectInfo>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type OAuthProviderInfo = {
|
||||
accessToken: string;
|
||||
idToken?: string;
|
||||
expiresInSeconds?: number;
|
||||
scope: string;
|
||||
refreshToken?: string;
|
||||
};
|
||||
|
||||
// @public
|
||||
export type OAuthProviderOptions = {
|
||||
clientId: string;
|
||||
clientSecret: string;
|
||||
callbackUrl: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type OAuthRefreshRequest = express.Request<{}> & {
|
||||
scope: string;
|
||||
refreshToken: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type OAuthResponse = AuthResponse<OAuthProviderInfo>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type OAuthResult = {
|
||||
fullProfile: Profile;
|
||||
params: {
|
||||
id_token?: string;
|
||||
scope: string;
|
||||
expires_in: number;
|
||||
};
|
||||
accessToken: string;
|
||||
refreshToken?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type OAuthStartRequest = express.Request<{}> & {
|
||||
scope: string;
|
||||
state: OAuthState;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type OAuthState = {
|
||||
nonce: string;
|
||||
env: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const postMessageResponse: (res: express.Response, appOrigin: string, response: WebMessageResponse) => void;
|
||||
|
||||
// @public
|
||||
export type ProfileInfo = {
|
||||
email?: string;
|
||||
displayName?: string;
|
||||
picture?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const readState: (stateString: string) => OAuthState;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
database: PluginDatabaseManager;
|
||||
// (undocumented)
|
||||
discovery: PluginEndpointDiscovery;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
// (undocumented)
|
||||
providerFactories?: ProviderFactories;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const verifyNonce: (req: express.Request, providerId: string) => void;
|
||||
|
||||
// @public
|
||||
export type WebMessageResponse = {
|
||||
type: 'authorization_response';
|
||||
response: AuthResponse<unknown>;
|
||||
} | {
|
||||
type: 'authorization_response';
|
||||
error: Error;
|
||||
};
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,113 @@
|
||||
## API Report File for "@backstage/plugin-badges-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { CatalogApi } from '@backstage/catalog-client';
|
||||
import { Config } from '@backstage/config';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import express from 'express';
|
||||
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Badge {
|
||||
color?: string;
|
||||
description?: string;
|
||||
kind?: 'entity';
|
||||
label: string;
|
||||
labelColor?: string;
|
||||
link?: string;
|
||||
message: string;
|
||||
style?: BadgeStyle;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const BADGE_STYLES: readonly ["plastic", "flat", "flat-square", "for-the-badge", "social"];
|
||||
|
||||
// @public (undocumented)
|
||||
export type BadgeBuilder = {
|
||||
getBadges(): Promise<BadgeInfo[]>;
|
||||
createBadgeJson(options: BadgeOptions): Promise<BadgeSpec>;
|
||||
createBadgeSvg(options: BadgeOptions): Promise<string>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface BadgeContext {
|
||||
// (undocumented)
|
||||
badgeUrl: string;
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
entity?: Entity;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface BadgeFactories {
|
||||
// (undocumented)
|
||||
[id: string]: BadgeFactory;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface BadgeFactory {
|
||||
// (undocumented)
|
||||
createBadge(context: BadgeContext): Badge;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type BadgeInfo = {
|
||||
id: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type BadgeOptions = {
|
||||
badgeInfo: BadgeInfo;
|
||||
context: BadgeContext;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type BadgeSpec = {
|
||||
id: string;
|
||||
badge: Badge;
|
||||
url: string;
|
||||
markdown: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type BadgeStyle = typeof BADGE_STYLES[number];
|
||||
|
||||
// @public (undocumented)
|
||||
export const createDefaultBadgeFactories: () => BadgeFactories;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class DefaultBadgeBuilder implements BadgeBuilder {
|
||||
constructor(factories: BadgeFactories);
|
||||
// (undocumented)
|
||||
createBadgeJson(options: BadgeOptions): Promise<BadgeSpec>;
|
||||
// (undocumented)
|
||||
createBadgeSvg(options: BadgeOptions): Promise<string>;
|
||||
// (undocumented)
|
||||
getBadges(): Promise<BadgeInfo[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
badgeBuilder?: BadgeBuilder;
|
||||
// (undocumented)
|
||||
badgeFactories?: BadgeFactories;
|
||||
// (undocumented)
|
||||
catalog?: CatalogApi;
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
discovery: PluginEndpointDiscovery;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,21 @@
|
||||
## API Report File for "@backstage/plugin-badges"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const badgesPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityBadgesDialog: ({ open, onClose }: {
|
||||
open: boolean;
|
||||
onClose?: (() => any) | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,22 @@
|
||||
## API Report File for "@backstage/plugin-bitrise"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
|
||||
// @public (undocumented)
|
||||
export const bitrisePlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityBitriseContent: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const isBitriseAvailable: (entity: Entity) => boolean;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,25 @@
|
||||
## API Report File for "@backstage/plugin-catalog-graphql"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import { GraphQLModule } from '@graphql-modules/core';
|
||||
import { Logger } from 'winston';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createModule(options: ModuleOptions): Promise<GraphQLModule>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ModuleOptions {
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,130 @@
|
||||
## API Report File for "@backstage/plugin-catalog-import"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { CatalogApi } from '@backstage/catalog-client';
|
||||
import { ConfigApi } from '@backstage/core';
|
||||
import { Control } from 'react-hook-form';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { EntityName } from '@backstage/catalog-model';
|
||||
import { FieldErrors } from 'react-hook-form';
|
||||
import { IdentityApi } from '@backstage/core';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
import { OAuthApi } from '@backstage/core';
|
||||
import { default as React_2 } from 'react';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
import { ScmIntegrationRegistry } from '@backstage/integration';
|
||||
import { SubmitHandler } from 'react-hook-form';
|
||||
import { TextFieldProps } from '@material-ui/core/TextField/TextField';
|
||||
import { UnpackNestedValue } from 'react-hook-form';
|
||||
import { UseControllerOptions } from 'react-hook-form';
|
||||
import { UseFormMethods } from 'react-hook-form';
|
||||
import { UseFormOptions } from 'react-hook-form';
|
||||
|
||||
// @public (undocumented)
|
||||
export type AnalyzeResult = {
|
||||
type: 'locations';
|
||||
locations: Array<{
|
||||
target: string;
|
||||
entities: EntityName[];
|
||||
}>;
|
||||
} | {
|
||||
type: 'repository';
|
||||
url: string;
|
||||
integrationType: string;
|
||||
generatedEntities: PartialEntity[];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const AutocompleteTextField: <TFieldValue extends string>({ name, options, required, control, errors, rules, loading, loadingText, helperText, errorHelperText, textFieldProps, }: Props_4<TFieldValue>) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CatalogImportApi {
|
||||
// (undocumented)
|
||||
analyzeUrl(url: string): Promise<AnalyzeResult>;
|
||||
// (undocumented)
|
||||
submitPullRequest(options: {
|
||||
repositoryUrl: string;
|
||||
fileContent: string;
|
||||
title: string;
|
||||
body: string;
|
||||
}): Promise<{
|
||||
link: string;
|
||||
location: string;
|
||||
}>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const catalogImportApiRef: ApiRef<CatalogImportApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class CatalogImportClient implements CatalogImportApi {
|
||||
constructor(options: {
|
||||
discoveryApi: DiscoveryApi;
|
||||
githubAuthApi: OAuthApi;
|
||||
identityApi: IdentityApi;
|
||||
scmIntegrationsApi: ScmIntegrationRegistry;
|
||||
catalogApi: CatalogApi;
|
||||
});
|
||||
// (undocumented)
|
||||
analyzeUrl(url: string): Promise<AnalyzeResult>;
|
||||
// (undocumented)
|
||||
submitPullRequest({ repositoryUrl, fileContent, title, body, }: {
|
||||
repositoryUrl: string;
|
||||
fileContent: string;
|
||||
title: string;
|
||||
body: string;
|
||||
}): Promise<{
|
||||
link: string;
|
||||
location: string;
|
||||
}>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const CatalogImportPage: (opts: StepperProviderOpts) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const catalogImportPlugin: BackstagePlugin<{
|
||||
importPage: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { catalogImportPlugin }
|
||||
|
||||
export { catalogImportPlugin as plugin }
|
||||
|
||||
// @public
|
||||
export function defaultGenerateStepper(flow: ImportFlows, defaults: StepperProvider): StepperProvider;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityListComponent: ({ locations, collapsed, locationListItemIcon, onItemClick, firstListItem, withLinks, }: Props_2) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ImportStepper: ({ initialUrl, generateStepper, variant, opts, }: Props) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export const PreparePullRequestForm: <TFieldValues extends Record<string, any>>({ defaultValues, onSubmit, render, }: Props_5<TFieldValues>) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const PreviewCatalogInfoComponent: ({ repositoryUrl, entities, classes, }: Props_6) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const PreviewPullRequestComponent: ({ title, description, classes, }: Props_7) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (opts: StepperProviderOpts) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export const StepInitAnalyzeUrl: ({ onAnalysis, analysisUrl, disablePullRequest, }: Props_3) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const StepPrepareCreatePullRequest: ({ analyzeResult, onPrepare, onGoBack, renderFormFields, defaultTitle, defaultBody, }: Props_8) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,81 @@
|
||||
## API Report File for "@backstage/plugin-circleci"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { BuildStepAction } from 'circleci-api';
|
||||
import { BuildSummary } from 'circleci-api';
|
||||
import { BuildSummaryResponse } from 'circleci-api';
|
||||
import { BuildWithSteps } from 'circleci-api';
|
||||
import { CircleCIOptions } from 'circleci-api';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { GitType } from 'circleci-api';
|
||||
import { Me } from 'circleci-api';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
export { BuildStepAction }
|
||||
|
||||
export { BuildSummary }
|
||||
|
||||
export { BuildWithSteps }
|
||||
|
||||
// @public (undocumented)
|
||||
export const CIRCLECI_ANNOTATION = "circleci.com/project-slug";
|
||||
|
||||
// @public (undocumented)
|
||||
export class CircleCIApi {
|
||||
constructor(options: Options);
|
||||
// (undocumented)
|
||||
getBuild(buildNumber: number, options: Partial<CircleCIOptions>): Promise<BuildWithSteps>;
|
||||
// (undocumented)
|
||||
getBuilds({ limit, offset }: {
|
||||
limit: number;
|
||||
offset: number;
|
||||
}, options: Partial<CircleCIOptions>): Promise<BuildSummaryResponse>;
|
||||
// (undocumented)
|
||||
getUser(options: Partial<CircleCIOptions>): Promise<Me>;
|
||||
// (undocumented)
|
||||
retry(buildNumber: number, options: Partial<CircleCIOptions>): Promise<BuildSummary>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const circleCIApiRef: ApiRef<CircleCIApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const circleCIBuildRouteRef: RouteRef<undefined>;
|
||||
|
||||
// @public (undocumented)
|
||||
const circleCIPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
export { circleCIPlugin }
|
||||
|
||||
export { circleCIPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const circleCIRouteRef: RouteRef<undefined>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityCircleCIContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
export { GitType }
|
||||
|
||||
// @public (undocumented)
|
||||
const isCircleCIAvailable: (entity: Entity) => boolean;
|
||||
|
||||
export { isCircleCIAvailable }
|
||||
|
||||
export { isCircleCIAvailable as isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (_props: Props) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,283 @@
|
||||
## API Report File for "@backstage/plugin-cloudbuild"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { OAuthApi } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export type ActionsGetWorkflowResponseData = {
|
||||
id: string;
|
||||
status: string;
|
||||
source: Source;
|
||||
createTime: string;
|
||||
startTime: string;
|
||||
steps: Step[];
|
||||
timeout: string;
|
||||
projectId: string;
|
||||
logsBucket: string;
|
||||
sourceProvenance: SourceProvenance;
|
||||
buildTriggerId: string;
|
||||
options: Options;
|
||||
logUrl: string;
|
||||
substitutions: Substitutions;
|
||||
tags: string[];
|
||||
queueTtl: string;
|
||||
name: string;
|
||||
finishTime: any;
|
||||
results: Results;
|
||||
timing: Timing2;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ActionsListWorkflowRunsForRepoResponseData {
|
||||
// (undocumented)
|
||||
builds: ActionsGetWorkflowResponseData[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface BUILD {
|
||||
// (undocumented)
|
||||
endTime: string;
|
||||
// (undocumented)
|
||||
startTime: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const CLOUDBUILD_ANNOTATION = "google.com/cloudbuild-project-slug";
|
||||
|
||||
// @public (undocumented)
|
||||
export type CloudbuildApi = {
|
||||
listWorkflowRuns: (request: {
|
||||
projectId: string;
|
||||
}) => Promise<ActionsListWorkflowRunsForRepoResponseData>;
|
||||
getWorkflow: ({ projectId, id, }: {
|
||||
projectId: string;
|
||||
id: string;
|
||||
}) => Promise<ActionsGetWorkflowResponseData>;
|
||||
getWorkflowRun: ({ projectId, id, }: {
|
||||
projectId: string;
|
||||
id: string;
|
||||
}) => Promise<ActionsGetWorkflowResponseData>;
|
||||
reRunWorkflow: ({ projectId, runId, }: {
|
||||
projectId: string;
|
||||
runId: string;
|
||||
}) => Promise<any>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const cloudbuildApiRef: ApiRef<CloudbuildApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class CloudbuildClient implements CloudbuildApi {
|
||||
constructor(googleAuthApi: OAuthApi);
|
||||
// (undocumented)
|
||||
getToken(): Promise<string>;
|
||||
// (undocumented)
|
||||
getWorkflow({ projectId, id, }: {
|
||||
projectId: string;
|
||||
id: string;
|
||||
}): Promise<ActionsGetWorkflowResponseData>;
|
||||
// (undocumented)
|
||||
getWorkflowRun({ projectId, id, }: {
|
||||
projectId: string;
|
||||
id: string;
|
||||
}): Promise<ActionsGetWorkflowResponseData>;
|
||||
// (undocumented)
|
||||
listWorkflowRuns({ projectId, }: {
|
||||
projectId: string;
|
||||
}): Promise<ActionsListWorkflowRunsForRepoResponseData>;
|
||||
// (undocumented)
|
||||
reRunWorkflow({ projectId, runId, }: {
|
||||
projectId: string;
|
||||
runId: string;
|
||||
}): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
const cloudbuildPlugin: BackstagePlugin<{
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { cloudbuildPlugin }
|
||||
|
||||
export { cloudbuildPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityCloudbuildContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityLatestCloudbuildRunCard: ({ branch, }: {
|
||||
entity?: Entity| undefined;
|
||||
branch: string;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityLatestCloudbuildsForBranchCard: ({ branch, }: {
|
||||
entity?: Entity| undefined;
|
||||
branch: string;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface FETCHSOURCE {
|
||||
// (undocumented)
|
||||
endTime: string;
|
||||
// (undocumented)
|
||||
startTime: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
const isCloudbuildAvailable: (entity: Entity) => boolean;
|
||||
|
||||
export { isCloudbuildAvailable }
|
||||
|
||||
export { isCloudbuildAvailable as isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export const LatestWorkflowRunCard: ({ branch, }: {
|
||||
entity?: Entity | undefined;
|
||||
branch: string;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const LatestWorkflowsForBranchCard: ({ branch, }: {
|
||||
entity?: Entity | undefined;
|
||||
branch: string;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Options {
|
||||
// (undocumented)
|
||||
dynamicSubstitutions: boolean;
|
||||
// (undocumented)
|
||||
logging: string;
|
||||
// (undocumented)
|
||||
machineType: string;
|
||||
// (undocumented)
|
||||
substitutionOption: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface PullTiming {
|
||||
// (undocumented)
|
||||
endTime: string;
|
||||
// (undocumented)
|
||||
startTime: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ResolvedStorageSource {
|
||||
// (undocumented)
|
||||
bucket: string;
|
||||
// (undocumented)
|
||||
generation: string;
|
||||
// (undocumented)
|
||||
object: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Results {
|
||||
// (undocumented)
|
||||
buildStepImages: string[];
|
||||
// (undocumented)
|
||||
buildStepOutputs: string[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (_props: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Source {
|
||||
// (undocumented)
|
||||
storageSource: StorageSource;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface SourceProvenance {
|
||||
// (undocumented)
|
||||
fileHashes: {};
|
||||
// (undocumented)
|
||||
resolvedStorageSource: {};
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Step {
|
||||
// (undocumented)
|
||||
args: string[];
|
||||
// (undocumented)
|
||||
dir: string;
|
||||
// (undocumented)
|
||||
entrypoint: string;
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
name: string;
|
||||
// (undocumented)
|
||||
pullTiming: PullTiming;
|
||||
// (undocumented)
|
||||
status: string;
|
||||
// (undocumented)
|
||||
timing: Timing;
|
||||
// (undocumented)
|
||||
volumes: Volume[];
|
||||
// (undocumented)
|
||||
waitFor: string[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface StorageSource {
|
||||
// (undocumented)
|
||||
bucket: string;
|
||||
// (undocumented)
|
||||
object: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Substitutions {
|
||||
// (undocumented)
|
||||
BRANCH_NAME: string;
|
||||
// (undocumented)
|
||||
COMMIT_SHA: string;
|
||||
// (undocumented)
|
||||
REPO_NAME: string;
|
||||
// (undocumented)
|
||||
REVISION_ID: string;
|
||||
// (undocumented)
|
||||
SHORT_SHA: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Timing {
|
||||
// (undocumented)
|
||||
endTime: string;
|
||||
// (undocumented)
|
||||
startTime: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Timing2 {
|
||||
// (undocumented)
|
||||
BUILD: BUILD;
|
||||
// (undocumented)
|
||||
FETCHSOURCE: FETCHSOURCE;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Volume {
|
||||
// (undocumented)
|
||||
name: string;
|
||||
// (undocumented)
|
||||
path: string;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,43 @@
|
||||
## API Report File for "@backstage/plugin-code-coverage-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
import { PluginDatabaseManager } from '@backstage/backend-common';
|
||||
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
||||
import { UrlReader } from '@backstage/backend-common';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CodeCoverageApi {
|
||||
// (undocumented)
|
||||
name: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const makeRouter: (options: RouterOptions) => Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
database: PluginDatabaseManager;
|
||||
// (undocumented)
|
||||
discovery: PluginEndpointDiscovery;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
// (undocumented)
|
||||
urlReader: UrlReader;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,32 @@
|
||||
## API Report File for "@backstage/plugin-code-coverage"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const codeCoveragePlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityCodeCoverageContent: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const isCodeCoverageAvailable: (entity: Entity) => boolean;
|
||||
|
||||
export { isCodeCoverageAvailable }
|
||||
|
||||
export { isCodeCoverageAvailable as isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: () => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,42 @@
|
||||
## API Report File for "@backstage/plugin-config-schema"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Observable } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
import { Schema } from 'jsonschema';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ConfigSchemaApi {
|
||||
// (undocumented)
|
||||
schema$(): Observable<ConfigSchemaResult>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const configSchemaApiRef: ApiRef<ConfigSchemaApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ConfigSchemaPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const configSchemaPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
// @public
|
||||
export class StaticSchemaLoader implements ConfigSchemaApi {
|
||||
constructor({ url }?: {
|
||||
url?: string;
|
||||
});
|
||||
// (undocumented)
|
||||
schema$(): Observable<ConfigSchemaResult>;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,621 @@
|
||||
## API Report File for "@backstage/plugin-cost-insights"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePalette } from '@backstage/theme';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { BackstageTheme } from '@backstage/theme';
|
||||
import { ContentRenderer } from 'recharts';
|
||||
import { Dispatch } from 'react';
|
||||
import { ForwardRefExoticComponent } from 'react';
|
||||
import { PaletteOptions } from '@material-ui/core/styles/createPalette';
|
||||
import { PropsWithChildren } from 'react';
|
||||
import { ReactNode } from 'react';
|
||||
import { RechartsFunction } from 'recharts';
|
||||
import { RefAttributes } from 'react';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
import { SetStateAction } from 'react';
|
||||
import { TooltipProps } from 'recharts';
|
||||
import { TypographyProps } from '@material-ui/core';
|
||||
|
||||
// @public
|
||||
export type Alert = {
|
||||
title: string | JSX.Element;
|
||||
subtitle: string | JSX.Element;
|
||||
element?: JSX.Element;
|
||||
status?: AlertStatus;
|
||||
url?: string;
|
||||
buttonText?: string;
|
||||
SnoozeForm?: Maybe<AlertForm>;
|
||||
AcceptForm?: Maybe<AlertForm>;
|
||||
DismissForm?: Maybe<AlertForm>;
|
||||
onSnoozed?(options: AlertOptions): Promise<Alert[]>;
|
||||
onAccepted?(options: AlertOptions): Promise<Alert[]>;
|
||||
onDismissed?(options: AlertOptions): Promise<Alert[]>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface AlertCost {
|
||||
// (undocumented)
|
||||
aggregation: [number, number];
|
||||
// (undocumented)
|
||||
id: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface AlertDismissFormData {
|
||||
// (undocumented)
|
||||
feedback: Maybe<string>;
|
||||
// (undocumented)
|
||||
other: Maybe<string>;
|
||||
// (undocumented)
|
||||
reason: AlertDismissReason;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface AlertDismissOption {
|
||||
// (undocumented)
|
||||
label: string;
|
||||
// (undocumented)
|
||||
reason: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const AlertDismissOptions: AlertDismissOption[];
|
||||
|
||||
// @public (undocumented)
|
||||
export enum AlertDismissReason {
|
||||
// (undocumented)
|
||||
Expected = "expected",
|
||||
// (undocumented)
|
||||
Migration = "migration",
|
||||
// (undocumented)
|
||||
NotApplicable = "not-applicable",
|
||||
// (undocumented)
|
||||
Other = "other",
|
||||
// (undocumented)
|
||||
Resolved = "resolved",
|
||||
// (undocumented)
|
||||
Seasonal = "seasonal"
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type AlertForm<A extends Alert = any, Data = any> = ForwardRefExoticComponent<AlertFormProps<A, Data> & RefAttributes<HTMLFormElement>>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type AlertFormProps<A extends Alert, FormData = {}> = {
|
||||
alert: A;
|
||||
onSubmit: (data: FormData) => void;
|
||||
disableSubmit: (isDisabled: boolean) => void;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface AlertOptions<T = any> {
|
||||
// (undocumented)
|
||||
data: T;
|
||||
// (undocumented)
|
||||
group: string;
|
||||
}
|
||||
|
||||
// @public
|
||||
export interface AlertSnoozeFormData {
|
||||
// (undocumented)
|
||||
intervals: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type AlertSnoozeOption = {
|
||||
label: string;
|
||||
duration: Duration;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const AlertSnoozeOptions: AlertSnoozeOption[];
|
||||
|
||||
// @public (undocumented)
|
||||
export enum AlertStatus {
|
||||
// (undocumented)
|
||||
Accepted = "accepted",
|
||||
// (undocumented)
|
||||
Dismissed = "dismissed",
|
||||
// (undocumented)
|
||||
Snoozed = "snoozed"
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const BarChart: ({ resources, responsive, displayAmount, options, tooltip, onClick, onMouseMove, }: BarChartProps) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export interface BarChartData extends BarChartOptions {
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const BarChartLegend: ({ costStart, costEnd, options, children, }: PropsWithChildren<BarChartLegendProps>) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type BarChartLegendOptions = {
|
||||
previousName: string;
|
||||
previousFill: string;
|
||||
currentName: string;
|
||||
currentFill: string;
|
||||
hideMarker?: boolean;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type BarChartLegendProps = {
|
||||
costStart: number;
|
||||
costEnd: number;
|
||||
options?: Partial<BarChartLegendOptions>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface BarChartOptions {
|
||||
// (undocumented)
|
||||
currentFill: string;
|
||||
// (undocumented)
|
||||
currentName: string;
|
||||
// (undocumented)
|
||||
previousFill: string;
|
||||
// (undocumented)
|
||||
previousName: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type BarChartProps = {
|
||||
resources: ResourceData[];
|
||||
responsive?: boolean;
|
||||
displayAmount?: number;
|
||||
options?: Partial<BarChartData>;
|
||||
tooltip?: ContentRenderer<TooltipProps>;
|
||||
onClick?: RechartsFunction;
|
||||
onMouseMove?: RechartsFunction;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const BarChartTooltip: ({ title, content, subtitle, topRight, actions, children, }: PropsWithChildren<BarChartTooltipProps>) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const BarChartTooltipItem: ({ item }: BarChartTooltipItemProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type BarChartTooltipItemProps = {
|
||||
item: TooltipItem;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type BarChartTooltipProps = {
|
||||
title: string;
|
||||
content?: ReactNode | string;
|
||||
subtitle?: ReactNode;
|
||||
topRight?: ReactNode;
|
||||
actions?: ReactNode;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ChangeStatistic {
|
||||
// (undocumented)
|
||||
amount: number;
|
||||
// (undocumented)
|
||||
ratio?: number;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export enum ChangeThreshold {
|
||||
// (undocumented)
|
||||
lower = -0.05,
|
||||
// (undocumented)
|
||||
upper = 0.05
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type ChartData = {
|
||||
date: number;
|
||||
trend: number;
|
||||
dailyCost: number;
|
||||
[key: string]: number;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Cost {
|
||||
// (undocumented)
|
||||
aggregation: DateAggregation[];
|
||||
// (undocumented)
|
||||
change?: ChangeStatistic;
|
||||
// (undocumented)
|
||||
groupedCosts?: Record<string, Cost[]>;
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
trendline?: Trendline;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const CostGrowth: ({ change, duration }: CostGrowthProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const CostGrowthIndicator: ({ change, formatter, className, ...props }: CostGrowthIndicatorProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type CostGrowthIndicatorProps = TypographyProps & {
|
||||
change: ChangeStatistic;
|
||||
formatter?: (change: ChangeStatistic) => Maybe<string>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type CostGrowthProps = {
|
||||
change: ChangeStatistic;
|
||||
duration: Duration;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type CostInsightsApi = {
|
||||
getLastCompleteBillingDate(): Promise<string>;
|
||||
getUserGroups(userId: string): Promise<Group[]>;
|
||||
getGroupProjects(group: string): Promise<Project[]>;
|
||||
getGroupDailyCost(group: string, intervals: string): Promise<Cost>;
|
||||
getProjectDailyCost(project: string, intervals: string): Promise<Cost>;
|
||||
getDailyMetricData(metric: string, intervals: string): Promise<MetricData>;
|
||||
getProductInsights(options: ProductInsightsOptions): Promise<Entity>;
|
||||
getAlerts(group: string): Promise<Alert[]>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const costInsightsApiRef: ApiRef<CostInsightsApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const CostInsightsLabelDataflowInstructionsPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const CostInsightsPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type CostInsightsPalette = BackstagePalette & CostInsightsPaletteAdditions;
|
||||
|
||||
// @public (undocumented)
|
||||
export type CostInsightsPaletteOptions = PaletteOptions & CostInsightsPaletteAdditions;
|
||||
|
||||
// @public (undocumented)
|
||||
const costInsightsPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
growthAlerts: RouteRef<undefined>;
|
||||
unlabeledDataflowAlerts: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { costInsightsPlugin }
|
||||
|
||||
export { costInsightsPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const CostInsightsProjectGrowthInstructionsPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CostInsightsTheme extends BackstageTheme {
|
||||
// (undocumented)
|
||||
palette: CostInsightsPalette;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CostInsightsThemeOptions extends PaletteOptions {
|
||||
// (undocumented)
|
||||
palette: CostInsightsPaletteOptions;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Currency {
|
||||
// (undocumented)
|
||||
kind: string | null;
|
||||
// (undocumented)
|
||||
label: string;
|
||||
// (undocumented)
|
||||
prefix?: string;
|
||||
// (undocumented)
|
||||
rate?: number;
|
||||
// (undocumented)
|
||||
unit: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export enum CurrencyType {
|
||||
// (undocumented)
|
||||
Beers = "BEERS",
|
||||
// (undocumented)
|
||||
CarbonOffsetTons = "CARBON_OFFSET_TONS",
|
||||
// (undocumented)
|
||||
IceCream = "PINTS_OF_ICE_CREAM",
|
||||
// (undocumented)
|
||||
USD = "USD"
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export enum DataKey {
|
||||
// (undocumented)
|
||||
Current = "current",
|
||||
// (undocumented)
|
||||
Name = "name",
|
||||
// (undocumented)
|
||||
Previous = "previous"
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type DateAggregation = {
|
||||
date: string;
|
||||
amount: number;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const DEFAULT_DATE_FORMAT = "YYYY-MM-DD";
|
||||
|
||||
// @public
|
||||
export enum Duration {
|
||||
// (undocumented)
|
||||
P30D = "P30D",
|
||||
// (undocumented)
|
||||
P3M = "P3M",
|
||||
// (undocumented)
|
||||
P7D = "P7D",
|
||||
// (undocumented)
|
||||
P90D = "P90D"
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const EngineerThreshold = 0.5;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Entity {
|
||||
// (undocumented)
|
||||
aggregation: [number, number];
|
||||
// (undocumented)
|
||||
change: ChangeStatistic;
|
||||
// (undocumented)
|
||||
entities: Record<string, Entity[]>;
|
||||
// (undocumented)
|
||||
id: Maybe<string>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class ExampleCostInsightsClient implements CostInsightsApi {
|
||||
// (undocumented)
|
||||
getAlerts(group: string): Promise<Alert[]>;
|
||||
// (undocumented)
|
||||
getDailyMetricData(metric: string, intervals: string): Promise<MetricData>;
|
||||
// (undocumented)
|
||||
getGroupDailyCost(group: string, intervals: string): Promise<Cost>;
|
||||
// (undocumented)
|
||||
getGroupProjects(group: string): Promise<Project[]>;
|
||||
// (undocumented)
|
||||
getLastCompleteBillingDate(): Promise<string>;
|
||||
// (undocumented)
|
||||
getProductInsights(options: ProductInsightsOptions): Promise<Entity>;
|
||||
// (undocumented)
|
||||
getProjectDailyCost(project: string, intervals: string): Promise<Cost>;
|
||||
// (undocumented)
|
||||
getUserGroups(userId: string): Promise<Group[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type Group = {
|
||||
id: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export enum GrowthType {
|
||||
// (undocumented)
|
||||
Excess = 2,
|
||||
// (undocumented)
|
||||
Negligible = 0,
|
||||
// (undocumented)
|
||||
Savings = 1
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type Icon = {
|
||||
kind: string;
|
||||
component: JSX.Element;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export enum IconType {
|
||||
// (undocumented)
|
||||
Compute = "compute",
|
||||
// (undocumented)
|
||||
Data = "data",
|
||||
// (undocumented)
|
||||
Database = "database",
|
||||
// (undocumented)
|
||||
ML = "ml",
|
||||
// (undocumented)
|
||||
Search = "search",
|
||||
// (undocumented)
|
||||
Storage = "storage"
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const LegendItem: ({ title, tooltipText, markerColor, children, }: PropsWithChildren<LegendItemProps>) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type LegendItemProps = {
|
||||
title: string;
|
||||
tooltipText?: string;
|
||||
markerColor?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type Loading = Record<string, boolean>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type Maybe<T> = T | null;
|
||||
|
||||
// @public (undocumented)
|
||||
export type Metric = {
|
||||
kind: string;
|
||||
name: string;
|
||||
default: boolean;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface MetricData {
|
||||
// (undocumented)
|
||||
aggregation: DateAggregation[];
|
||||
// (undocumented)
|
||||
change: ChangeStatistic;
|
||||
// (undocumented)
|
||||
format: 'number' | 'currency';
|
||||
// (undocumented)
|
||||
id: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const MockConfigProvider: ({ children, ...context }: MockConfigProviderProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const MockCurrencyProvider: ({ children, ...context }: MockCurrencyProviderProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface PageFilters {
|
||||
// (undocumented)
|
||||
duration: Duration;
|
||||
// (undocumented)
|
||||
group: Maybe<string>;
|
||||
// (undocumented)
|
||||
metric: string | null;
|
||||
// (undocumented)
|
||||
project: Maybe<string>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Product {
|
||||
// (undocumented)
|
||||
kind: string;
|
||||
// (undocumented)
|
||||
name: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type ProductFilters = Array<ProductPeriod>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type ProductInsightsOptions = {
|
||||
product: string;
|
||||
group: string;
|
||||
intervals: string;
|
||||
project: Maybe<string>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ProductPeriod {
|
||||
// (undocumented)
|
||||
duration: Duration;
|
||||
// (undocumented)
|
||||
productType: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Project {
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
name?: string;
|
||||
}
|
||||
|
||||
// @public
|
||||
export class ProjectGrowthAlert implements Alert {
|
||||
constructor(data: ProjectGrowthData);
|
||||
// (undocumented)
|
||||
data: ProjectGrowthData;
|
||||
// (undocumented)
|
||||
get element(): JSX.Element;
|
||||
// (undocumented)
|
||||
get subtitle(): string;
|
||||
// (undocumented)
|
||||
get title(): string;
|
||||
// (undocumented)
|
||||
get url(): string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ProjectGrowthData {
|
||||
// (undocumented)
|
||||
aggregation: [number, number];
|
||||
// (undocumented)
|
||||
change: ChangeStatistic;
|
||||
// (undocumented)
|
||||
periodEnd: string;
|
||||
// (undocumented)
|
||||
periodStart: string;
|
||||
// (undocumented)
|
||||
products: Array<AlertCost>;
|
||||
// (undocumented)
|
||||
project: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ResourceData {
|
||||
// (undocumented)
|
||||
current: number;
|
||||
// (undocumented)
|
||||
name: Maybe<string>;
|
||||
// (undocumented)
|
||||
previous: number;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type TooltipItem = {
|
||||
fill: string;
|
||||
label: string;
|
||||
value: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type Trendline = {
|
||||
slope: number;
|
||||
intercept: number;
|
||||
};
|
||||
|
||||
// @public
|
||||
export class UnlabeledDataflowAlert implements Alert {
|
||||
constructor(data: UnlabeledDataflowData);
|
||||
// (undocumented)
|
||||
data: UnlabeledDataflowData;
|
||||
// (undocumented)
|
||||
get element(): JSX.Element;
|
||||
// (undocumented)
|
||||
status?: AlertStatus;
|
||||
// (undocumented)
|
||||
get subtitle(): string;
|
||||
// (undocumented)
|
||||
get title(): string;
|
||||
// (undocumented)
|
||||
get url(): string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface UnlabeledDataflowAlertProject {
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
labeledCost: number;
|
||||
// (undocumented)
|
||||
unlabeledCost: number;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface UnlabeledDataflowData {
|
||||
// (undocumented)
|
||||
labeledCost: number;
|
||||
// (undocumented)
|
||||
periodEnd: string;
|
||||
// (undocumented)
|
||||
periodStart: string;
|
||||
// (undocumented)
|
||||
projects: Array<UnlabeledDataflowAlertProject>;
|
||||
// (undocumented)
|
||||
unlabeledCost: number;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,31 @@
|
||||
## API Report File for "@backstage/plugin-explore-react"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export type ExploreTool = {
|
||||
title: string;
|
||||
description?: string;
|
||||
url: string;
|
||||
image: string;
|
||||
tags?: string[];
|
||||
lifecycle?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ExploreToolsConfig {
|
||||
// (undocumented)
|
||||
getTools: () => Promise<ExploreTool[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const exploreToolsConfigRef: ApiRef<ExploreToolsConfig>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,38 @@
|
||||
## API Report File for "@backstage/plugin-explore"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { ExternalRouteRef } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const catalogEntityRouteRef: ExternalRouteRef<{
|
||||
name: string;
|
||||
kind: string;
|
||||
namespace: string;
|
||||
}, false>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ExplorePage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const explorePlugin: BackstagePlugin<{
|
||||
explore: RouteRef<undefined>;
|
||||
}, {
|
||||
catalogEntity: ExternalRouteRef<{
|
||||
name: string;
|
||||
kind: string;
|
||||
namespace: string;
|
||||
}, false>;
|
||||
}>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const exploreRouteRef: RouteRef<undefined>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,27 @@
|
||||
## API Report File for "@backstage/plugin-fossa"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityFossaCard: ({ variant }: {
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const FossaPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const fossaPlugin: BackstagePlugin<{
|
||||
fossaOverview: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,86 @@
|
||||
## API Report File for "@backstage/plugin-gcp-projects"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { OAuthApi } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export type GcpApi = {
|
||||
listProjects(): Promise<Project[]>;
|
||||
getProject(projectId: string): Promise<Project>;
|
||||
createProject(options: {
|
||||
projectId: string;
|
||||
projectName: string;
|
||||
}): Promise<Operation>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const gcpApiRef: ApiRef<GcpApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class GcpClient implements GcpApi {
|
||||
constructor(googleAuthApi: OAuthApi);
|
||||
// (undocumented)
|
||||
createProject(options: {
|
||||
projectId: string;
|
||||
projectName: string;
|
||||
}): Promise<Operation>;
|
||||
// (undocumented)
|
||||
getProject(projectId: string): Promise<Project>;
|
||||
// (undocumented)
|
||||
getToken(): Promise<string>;
|
||||
// (undocumented)
|
||||
listProjects(): Promise<Project[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const GcpProjectsPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const gcpProjectsPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { gcpProjectsPlugin }
|
||||
|
||||
export { gcpProjectsPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export type Operation = {
|
||||
name: string;
|
||||
metadata: string;
|
||||
done: boolean;
|
||||
error: Status;
|
||||
response: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type Project = {
|
||||
name: string;
|
||||
projectNumber?: string;
|
||||
projectId: string;
|
||||
lifecycleState?: string;
|
||||
createTime?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type ProjectDetails = {
|
||||
details: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type Status = {
|
||||
code: number;
|
||||
message: string;
|
||||
details: string[];
|
||||
};
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,25 @@
|
||||
## API Report File for "@backstage/plugin-git-release-manager"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const gitReleaseManagerApiRef: ApiRef<GitReleaseApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const GitReleaseManagerPage: GitReleaseManager;
|
||||
|
||||
// @public (undocumented)
|
||||
export const gitReleaseManagerPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,213 @@
|
||||
## API Report File for "@backstage/plugin-github-actions"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { ConfigApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
import { OAuthApi } from '@backstage/core';
|
||||
import { RestEndpointMethodTypes } from '@octokit/rest';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export enum BuildStatus {
|
||||
// (undocumented)
|
||||
'failure' = 1,
|
||||
// (undocumented)
|
||||
'pending' = 2,
|
||||
// (undocumented)
|
||||
'running' = 3,
|
||||
// (undocumented)
|
||||
'success' = 0
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityGithubActionsContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityLatestGithubActionRunCard: ({ branch, variant, }: {
|
||||
entity?: Entity| undefined;
|
||||
branch: string;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityLatestGithubActionsForBranchCard: ({ branch, variant, }: {
|
||||
entity?: Entity| undefined;
|
||||
branch: string;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityRecentGithubActionsRunsCard: ({ branch, dense, limit, variant, }: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const GITHUB_ACTIONS_ANNOTATION = "github.com/project-slug";
|
||||
|
||||
// @public (undocumented)
|
||||
export type GithubActionsApi = {
|
||||
listWorkflowRuns: ({ hostname, owner, repo, pageSize, page, branch, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
pageSize?: number;
|
||||
page?: number;
|
||||
branch?: string;
|
||||
}) => Promise<RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']>;
|
||||
getWorkflow: ({ hostname, owner, repo, id, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
id: number;
|
||||
}) => Promise<RestEndpointMethodTypes['actions']['getWorkflow']['response']['data']>;
|
||||
getWorkflowRun: ({ hostname, owner, repo, id, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
id: number;
|
||||
}) => Promise<RestEndpointMethodTypes['actions']['getWorkflowRun']['response']['data']>;
|
||||
reRunWorkflow: ({ hostname, owner, repo, runId, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
runId: number;
|
||||
}) => Promise<any>;
|
||||
listJobsForWorkflowRun: ({ hostname, owner, repo, id, pageSize, page, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
id: number;
|
||||
pageSize?: number;
|
||||
page?: number;
|
||||
}) => Promise<RestEndpointMethodTypes['actions']['listJobsForWorkflowRun']['response']['data']>;
|
||||
downloadJobLogsForWorkflowRun: ({ hostname, owner, repo, runId, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
runId: number;
|
||||
}) => Promise<RestEndpointMethodTypes['actions']['downloadJobLogsForWorkflowRun']['response']['data']>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const githubActionsApiRef: ApiRef<GithubActionsApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class GithubActionsClient implements GithubActionsApi {
|
||||
constructor(options: {
|
||||
configApi: ConfigApi;
|
||||
githubAuthApi: OAuthApi;
|
||||
});
|
||||
// (undocumented)
|
||||
downloadJobLogsForWorkflowRun({ hostname, owner, repo, runId, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
runId: number;
|
||||
}): Promise<RestEndpointMethodTypes['actions']['downloadJobLogsForWorkflowRun']['response']['data']>;
|
||||
// (undocumented)
|
||||
getWorkflow({ hostname, owner, repo, id, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
id: number;
|
||||
}): Promise<RestEndpointMethodTypes['actions']['getWorkflow']['response']['data']>;
|
||||
// (undocumented)
|
||||
getWorkflowRun({ hostname, owner, repo, id, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
id: number;
|
||||
}): Promise<RestEndpointMethodTypes['actions']['getWorkflowRun']['response']['data']>;
|
||||
// (undocumented)
|
||||
listJobsForWorkflowRun({ hostname, owner, repo, id, pageSize, page, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
id: number;
|
||||
pageSize?: number;
|
||||
page?: number;
|
||||
}): Promise<RestEndpointMethodTypes['actions']['listJobsForWorkflowRun']['response']['data']>;
|
||||
// (undocumented)
|
||||
listWorkflowRuns({ hostname, owner, repo, pageSize, page, branch, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
pageSize?: number;
|
||||
page?: number;
|
||||
branch?: string;
|
||||
}): Promise<RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']>;
|
||||
// (undocumented)
|
||||
reRunWorkflow({ hostname, owner, repo, runId, }: {
|
||||
hostname?: string;
|
||||
owner: string;
|
||||
repo: string;
|
||||
runId: number;
|
||||
}): Promise<any>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
const githubActionsPlugin: BackstagePlugin<{
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { githubActionsPlugin }
|
||||
|
||||
export { githubActionsPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
const isGithubActionsAvailable: (entity: Entity) => boolean;
|
||||
|
||||
export { isGithubActionsAvailable }
|
||||
|
||||
export { isGithubActionsAvailable as isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export type Job = {
|
||||
html_url: string;
|
||||
status: string;
|
||||
conclusion: string;
|
||||
started_at: string;
|
||||
completed_at: string;
|
||||
id: number;
|
||||
name: string;
|
||||
steps: Step[];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type Jobs = {
|
||||
total_count: number;
|
||||
jobs: Job[];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const LatestWorkflowRunCard: ({ branch, variant, }: Props_3) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const LatestWorkflowsForBranchCard: ({ branch, variant, }: Props_3) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const RecentWorkflowRunsCard: ({ branch, dense, limit, variant, }: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (_props: Props_2) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type Step = {
|
||||
name: string;
|
||||
status: string;
|
||||
conclusion?: string;
|
||||
number: number;
|
||||
started_at: string;
|
||||
completed_at: string;
|
||||
};
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,197 @@
|
||||
## API Report File for "@backstage/plugin-gitops-profiles"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ApplyProfileRequest {
|
||||
// (undocumented)
|
||||
gitHubToken: string;
|
||||
// (undocumented)
|
||||
gitHubUser: string;
|
||||
// (undocumented)
|
||||
profiles: string[];
|
||||
// (undocumented)
|
||||
targetOrg: string;
|
||||
// (undocumented)
|
||||
targetRepo: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ChangeClusterStateRequest {
|
||||
// (undocumented)
|
||||
clusterState: 'present' | 'absent';
|
||||
// (undocumented)
|
||||
gitHubToken: string;
|
||||
// (undocumented)
|
||||
gitHubUser: string;
|
||||
// (undocumented)
|
||||
targetOrg: string;
|
||||
// (undocumented)
|
||||
targetRepo: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CloneFromTemplateRequest {
|
||||
// (undocumented)
|
||||
gitHubToken: string;
|
||||
// (undocumented)
|
||||
gitHubUser: string;
|
||||
// (undocumented)
|
||||
secrets: {
|
||||
awsAccessKeyId: string;
|
||||
awsSecretAccessKey: string;
|
||||
};
|
||||
// (undocumented)
|
||||
targetOrg: string;
|
||||
// (undocumented)
|
||||
targetRepo: string;
|
||||
// (undocumented)
|
||||
templateRepository: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ClusterStatus {
|
||||
// (undocumented)
|
||||
conclusion: string;
|
||||
// (undocumented)
|
||||
link: string;
|
||||
// (undocumented)
|
||||
name: string;
|
||||
// (undocumented)
|
||||
runStatus: Status[];
|
||||
// (undocumented)
|
||||
status: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class FetchError extends Error {
|
||||
// (undocumented)
|
||||
static forResponse(resp: Response): Promise<FetchError>;
|
||||
// (undocumented)
|
||||
get name(): string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface GithubUserInfoRequest {
|
||||
// (undocumented)
|
||||
accessToken: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface GithubUserInfoResponse {
|
||||
// (undocumented)
|
||||
login: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type GitOpsApi = {
|
||||
url: string;
|
||||
fetchLog(req: PollLogRequest): Promise<StatusResponse>;
|
||||
changeClusterState(req: ChangeClusterStateRequest): Promise<any>;
|
||||
cloneClusterFromTemplate(req: CloneFromTemplateRequest): Promise<any>;
|
||||
applyProfiles(req: ApplyProfileRequest): Promise<any>;
|
||||
listClusters(req: ListClusterRequest): Promise<ListClusterStatusesResponse>;
|
||||
fetchUserInfo(req: GithubUserInfoRequest): Promise<GithubUserInfoResponse>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const gitOpsApiRef: ApiRef<GitOpsApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const GitopsProfilesClusterListPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const GitopsProfilesClusterPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const GitopsProfilesCreatePage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const gitopsProfilesPlugin: BackstagePlugin<{
|
||||
listPage: RouteRef<undefined>;
|
||||
detailsPage: RouteRef<{
|
||||
owner: string;
|
||||
repo: string;
|
||||
}>;
|
||||
createPage: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { gitopsProfilesPlugin }
|
||||
|
||||
export { gitopsProfilesPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export class GitOpsRestApi implements GitOpsApi {
|
||||
constructor(url?: string);
|
||||
// (undocumented)
|
||||
applyProfiles(req: ApplyProfileRequest): Promise<any>;
|
||||
// (undocumented)
|
||||
changeClusterState(req: ChangeClusterStateRequest): Promise<any>;
|
||||
// (undocumented)
|
||||
cloneClusterFromTemplate(req: CloneFromTemplateRequest): Promise<any>;
|
||||
// (undocumented)
|
||||
fetchLog(req: PollLogRequest): Promise<StatusResponse>;
|
||||
// (undocumented)
|
||||
fetchUserInfo(req: GithubUserInfoRequest): Promise<GithubUserInfoResponse>;
|
||||
// (undocumented)
|
||||
listClusters(req: ListClusterRequest): Promise<ListClusterStatusesResponse>;
|
||||
// (undocumented)
|
||||
url: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ListClusterRequest {
|
||||
// (undocumented)
|
||||
gitHubToken: string;
|
||||
// (undocumented)
|
||||
gitHubUser: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ListClusterStatusesResponse {
|
||||
// (undocumented)
|
||||
result: ClusterStatus[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface PollLogRequest {
|
||||
// (undocumented)
|
||||
gitHubToken: string;
|
||||
// (undocumented)
|
||||
gitHubUser: string;
|
||||
// (undocumented)
|
||||
targetOrg: string;
|
||||
// (undocumented)
|
||||
targetRepo: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Status {
|
||||
// (undocumented)
|
||||
conclusion: string;
|
||||
// (undocumented)
|
||||
message: string;
|
||||
// (undocumented)
|
||||
status: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface StatusResponse {
|
||||
// (undocumented)
|
||||
link: string;
|
||||
// (undocumented)
|
||||
result: Status[];
|
||||
// (undocumented)
|
||||
status: string;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,82 @@
|
||||
## API Report File for "@backstage/plugin-graphiql"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core-plugin-api';
|
||||
import { BackstagePlugin } from '@backstage/core-plugin-api';
|
||||
import { ErrorApi } from '@backstage/core-plugin-api';
|
||||
import { IconComponent } from '@backstage/core';
|
||||
import { OAuthApi } from '@backstage/core-plugin-api';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
|
||||
// @public (undocumented)
|
||||
export type EndpointConfig = {
|
||||
id: string;
|
||||
title: string;
|
||||
url: string;
|
||||
method?: 'POST';
|
||||
headers?: {
|
||||
[name in string]: string;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type GithubEndpointConfig = {
|
||||
id: string;
|
||||
title: string;
|
||||
url?: string;
|
||||
errorApi?: ErrorApi;
|
||||
githubAuthApi: OAuthApi;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const GraphiQLIcon: IconComponent;
|
||||
|
||||
// @public (undocumented)
|
||||
export const GraphiQLPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const graphiqlPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
export { graphiqlPlugin }
|
||||
|
||||
export { graphiqlPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const graphiQLRouteRef: RouteRef<undefined>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type GraphQLBrowseApi = {
|
||||
getEndpoints(): Promise<GraphQLEndpoint[]>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const graphQlBrowseApiRef: ApiRef<GraphQLBrowseApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type GraphQLEndpoint = {
|
||||
id: string;
|
||||
title: string;
|
||||
fetcher: (body: any) => Promise<any>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class GraphQLEndpoints implements GraphQLBrowseApi {
|
||||
// (undocumented)
|
||||
static create(config: EndpointConfig): GraphQLEndpoint;
|
||||
// (undocumented)
|
||||
static from(endpoints: GraphQLEndpoint[]): GraphQLEndpoints;
|
||||
// (undocumented)
|
||||
getEndpoints(): Promise<GraphQLEndpoint[]>;
|
||||
static github(config: GithubEndpointConfig): GraphQLEndpoint;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: () => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,25 @@
|
||||
## API Report File for "@backstage/plugin-graphql-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,205 @@
|
||||
## API Report File for "@backstage/plugin-ilert"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { ConfigApi } from '@backstage/core';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { IconComponent } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityILertCard: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type GetIncidentsCountOpts = {
|
||||
states?: IncidentStatus[];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type GetIncidentsOpts = {
|
||||
maxResults?: number;
|
||||
startIndex?: number;
|
||||
states?: IncidentStatus[];
|
||||
alertSources?: number[];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ILertApi {
|
||||
// (undocumented)
|
||||
acceptIncident(incident: Incident, userName: string): Promise<Incident>;
|
||||
// (undocumented)
|
||||
addImmediateMaintenance(alertSourceId: number, minutes: number): Promise<void>;
|
||||
// (undocumented)
|
||||
assignIncident(incident: Incident, responder: IncidentResponder): Promise<Incident>;
|
||||
// (undocumented)
|
||||
createIncident(eventRequest: EventRequest): Promise<boolean>;
|
||||
// (undocumented)
|
||||
disableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
|
||||
// (undocumented)
|
||||
enableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
|
||||
// (undocumented)
|
||||
fetchAlertSource(idOrIntegrationKey: number | string): Promise<AlertSource>;
|
||||
// (undocumented)
|
||||
fetchAlertSourceOnCalls(alertSource: AlertSource): Promise<OnCall[]>;
|
||||
// (undocumented)
|
||||
fetchAlertSources(): Promise<AlertSource[]>;
|
||||
// (undocumented)
|
||||
fetchIncident(id: number): Promise<Incident>;
|
||||
// (undocumented)
|
||||
fetchIncidentActions(incident: Incident): Promise<IncidentAction[]>;
|
||||
// (undocumented)
|
||||
fetchIncidentResponders(incident: Incident): Promise<IncidentResponder[]>;
|
||||
// (undocumented)
|
||||
fetchIncidents(opts?: GetIncidentsOpts): Promise<Incident[]>;
|
||||
// (undocumented)
|
||||
fetchIncidentsCount(opts?: GetIncidentsCountOpts): Promise<number>;
|
||||
// (undocumented)
|
||||
fetchOnCallSchedules(): Promise<Schedule[]>;
|
||||
// (undocumented)
|
||||
fetchUptimeMonitor(id: number): Promise<UptimeMonitor>;
|
||||
// (undocumented)
|
||||
fetchUptimeMonitors(): Promise<UptimeMonitor[]>;
|
||||
// (undocumented)
|
||||
fetchUsers(): Promise<User[]>;
|
||||
// (undocumented)
|
||||
getAlertSourceDetailsURL(alertSource: AlertSource | null): string;
|
||||
// (undocumented)
|
||||
getEscalationPolicyDetailsURL(escalationPolicy: EscalationPolicy): string;
|
||||
// (undocumented)
|
||||
getIncidentDetailsURL(incident: Incident): string;
|
||||
// (undocumented)
|
||||
getScheduleDetailsURL(schedule: Schedule): string;
|
||||
// (undocumented)
|
||||
getUptimeMonitorDetailsURL(uptimeMonitor: UptimeMonitor): string;
|
||||
// (undocumented)
|
||||
getUserInitials(user: User | null): string;
|
||||
// (undocumented)
|
||||
getUserPhoneNumber(user: User | null): string;
|
||||
// (undocumented)
|
||||
overrideShift(scheduleId: number, userId: number, start: string, end: string): Promise<Schedule>;
|
||||
// (undocumented)
|
||||
pauseUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
|
||||
// (undocumented)
|
||||
resolveIncident(incident: Incident, userName: string): Promise<Incident>;
|
||||
// (undocumented)
|
||||
resumeUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
|
||||
// (undocumented)
|
||||
triggerIncidentAction(incident: Incident, action: IncidentAction): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const ilertApiRef: ApiRef<ILertApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ILertCard: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export class ILertClient implements ILertApi {
|
||||
constructor(opts: Options);
|
||||
// (undocumented)
|
||||
acceptIncident(incident: Incident, userName: string): Promise<Incident>;
|
||||
// (undocumented)
|
||||
addImmediateMaintenance(alertSourceId: number, minutes: number): Promise<void>;
|
||||
// (undocumented)
|
||||
assignIncident(incident: Incident, responder: IncidentResponder): Promise<Incident>;
|
||||
// (undocumented)
|
||||
createIncident(eventRequest: EventRequest): Promise<boolean>;
|
||||
// (undocumented)
|
||||
disableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
|
||||
// (undocumented)
|
||||
enableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
|
||||
// (undocumented)
|
||||
fetchAlertSource(idOrIntegrationKey: number | string): Promise<AlertSource>;
|
||||
// (undocumented)
|
||||
fetchAlertSourceOnCalls(alertSource: AlertSource): Promise<OnCall[]>;
|
||||
// (undocumented)
|
||||
fetchAlertSources(): Promise<AlertSource[]>;
|
||||
// (undocumented)
|
||||
fetchIncident(id: number): Promise<Incident>;
|
||||
// (undocumented)
|
||||
fetchIncidentActions(incident: Incident): Promise<IncidentAction[]>;
|
||||
// (undocumented)
|
||||
fetchIncidentResponders(incident: Incident): Promise<IncidentResponder[]>;
|
||||
// (undocumented)
|
||||
fetchIncidents(opts?: GetIncidentsOpts): Promise<Incident[]>;
|
||||
// (undocumented)
|
||||
fetchIncidentsCount(opts?: GetIncidentsCountOpts): Promise<number>;
|
||||
// (undocumented)
|
||||
fetchOnCallSchedules(): Promise<Schedule[]>;
|
||||
// (undocumented)
|
||||
fetchUptimeMonitor(id: number): Promise<UptimeMonitor>;
|
||||
// (undocumented)
|
||||
fetchUptimeMonitors(): Promise<UptimeMonitor[]>;
|
||||
// (undocumented)
|
||||
fetchUsers(): Promise<User[]>;
|
||||
// (undocumented)
|
||||
static fromConfig(configApi: ConfigApi, discoveryApi: DiscoveryApi): ILertClient;
|
||||
// (undocumented)
|
||||
getAlertSourceDetailsURL(alertSource: AlertSource | null): string;
|
||||
// (undocumented)
|
||||
getEscalationPolicyDetailsURL(escalationPolicy: EscalationPolicy): string;
|
||||
// (undocumented)
|
||||
getIncidentDetailsURL(incident: Incident): string;
|
||||
// (undocumented)
|
||||
getScheduleDetailsURL(schedule: Schedule): string;
|
||||
// (undocumented)
|
||||
getUptimeMonitorDetailsURL(uptimeMonitor: UptimeMonitor): string;
|
||||
// (undocumented)
|
||||
getUserInitials(user: User | null): string;
|
||||
// (undocumented)
|
||||
getUserPhoneNumber(user: User | null): string;
|
||||
// (undocumented)
|
||||
overrideShift(scheduleId: number, userId: number, start: string, end: string): Promise<Schedule>;
|
||||
// (undocumented)
|
||||
pauseUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
|
||||
// (undocumented)
|
||||
resolveIncident(incident: Incident, userName: string): Promise<Incident>;
|
||||
// (undocumented)
|
||||
resumeUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
|
||||
// (undocumented)
|
||||
triggerIncidentAction(incident: Incident, action: IncidentAction): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const ILertIcon: IconComponent;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ILertPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const ilertPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { ilertPlugin }
|
||||
|
||||
export { ilertPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const iLertRouteRef: RouteRef<undefined>;
|
||||
|
||||
// @public (undocumented)
|
||||
const isPluginApplicableToEntity: (entity: Entity) => boolean;
|
||||
|
||||
export { isPluginApplicableToEntity as isILertAvailable }
|
||||
|
||||
export { isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type TableState = {
|
||||
page: number;
|
||||
pageSize: number;
|
||||
};
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,83 @@
|
||||
## API Report File for "@backstage/plugin-jenkins"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityJenkinsContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityLatestJenkinsRunCard: ({ branch, variant, }: {
|
||||
branch: string;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const isJenkinsAvailable: (entity: Entity) => boolean;
|
||||
|
||||
export { isJenkinsAvailable }
|
||||
|
||||
export { isJenkinsAvailable as isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export const JENKINS_ANNOTATION = "jenkins.io/github-folder";
|
||||
|
||||
// @public (undocumented)
|
||||
export class JenkinsApi {
|
||||
constructor(options: Options);
|
||||
// (undocumented)
|
||||
extractJobDetailsFromBuildName(buildName: string): {
|
||||
jobName: string;
|
||||
buildNumber: number;
|
||||
};
|
||||
// (undocumented)
|
||||
extractScmDetailsFromJob(jobDetails: any): any | undefined;
|
||||
// (undocumented)
|
||||
getBuild(buildName: string): Promise<any>;
|
||||
// (undocumented)
|
||||
getFolder(folderName: string): Promise<CITableBuildInfo[]>;
|
||||
// (undocumented)
|
||||
getJob(jobName: string): Promise<any>;
|
||||
// (undocumented)
|
||||
getLastBuild(jobName: string): Promise<any>;
|
||||
// (undocumented)
|
||||
mapJenkinsBuildToCITable(jenkinsResult: any, jobScmInfo?: any): CITableBuildInfo;
|
||||
// (undocumented)
|
||||
retry(buildName: string): Promise<any>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const jenkinsApiRef: ApiRef<JenkinsApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
const jenkinsPlugin: BackstagePlugin<{
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { jenkinsPlugin }
|
||||
|
||||
export { jenkinsPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const LatestRunCard: ({ branch, variant, }: {
|
||||
branch: string;
|
||||
variant?: InfoCardVariants | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (_props: Props) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
## API Report File for "@backstage/plugin-kafka-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,41 @@
|
||||
## API Report File for "@backstage/plugin-kafka"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityKafkaContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const isPluginApplicableToEntity: (entity: Entity) => boolean;
|
||||
|
||||
export { isPluginApplicableToEntity as isKafkaAvailable }
|
||||
|
||||
export { isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export const KAFKA_CONSUMER_GROUP_ANNOTATION = "kafka.apache.org/consumer-groups";
|
||||
|
||||
// @public (undocumented)
|
||||
const kafkaPlugin: BackstagePlugin<{
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { kafkaPlugin }
|
||||
|
||||
export { kafkaPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (_props: Props) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,103 @@
|
||||
## API Report File for "@backstage/plugin-kubernetes-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { FetchResponse } from '@backstage/plugin-kubernetes-common';
|
||||
import { KubernetesFetchError } from '@backstage/plugin-kubernetes-common';
|
||||
import { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
|
||||
import { Logger } from 'winston';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ClusterDetails {
|
||||
// (undocumented)
|
||||
authProvider: string;
|
||||
// (undocumented)
|
||||
name: string;
|
||||
// (undocumented)
|
||||
serviceAccountToken?: string | undefined;
|
||||
// (undocumented)
|
||||
skipTLSVerify?: boolean;
|
||||
// (undocumented)
|
||||
url: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CustomResource {
|
||||
// (undocumented)
|
||||
apiVersion: string;
|
||||
// (undocumented)
|
||||
group: string;
|
||||
// (undocumented)
|
||||
plural: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface FetchResponseWrapper {
|
||||
// (undocumented)
|
||||
errors: KubernetesFetchError[];
|
||||
// (undocumented)
|
||||
responses: FetchResponse[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface KubernetesClustersSupplier {
|
||||
// (undocumented)
|
||||
getClusters(): Promise<ClusterDetails[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface KubernetesFetcher {
|
||||
// (undocumented)
|
||||
fetchObjectsForService(params: ObjectFetchParams): Promise<FetchResponseWrapper>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type KubernetesObjectTypes = 'pods' | 'services' | 'configmaps' | 'deployments' | 'replicasets' | 'horizontalpodautoscalers' | 'ingresses' | 'customresources';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface KubernetesServiceLocator {
|
||||
// (undocumented)
|
||||
getClustersByServiceId(serviceId: string): Promise<ClusterDetails[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const makeRouter: (logger: Logger, kubernetesFanOutHandler: KubernetesFanOutHandler, clusterDetails: ClusterDetails[]) => express.Router;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ObjectFetchParams {
|
||||
// (undocumented)
|
||||
clusterDetails: ClusterDetails;
|
||||
// (undocumented)
|
||||
customResources: CustomResource[];
|
||||
// (undocumented)
|
||||
labelSelector: string;
|
||||
// (undocumented)
|
||||
objectTypesToFetch: Set<KubernetesObjectTypes>;
|
||||
// (undocumented)
|
||||
serviceId: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
clusterSupplier?: KubernetesClustersSupplier;
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type ServiceLocatorMethod = 'multiTenant' | 'http';
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,130 @@
|
||||
## API Report File for "@backstage/plugin-kubernetes-common"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { ExtensionsV1beta1Ingress } from '@kubernetes/client-node';
|
||||
import { V1ConfigMap } from '@kubernetes/client-node';
|
||||
import { V1Deployment } from '@kubernetes/client-node';
|
||||
import { V1HorizontalPodAutoscaler } from '@kubernetes/client-node';
|
||||
import { V1Pod } from '@kubernetes/client-node';
|
||||
import { V1ReplicaSet } from '@kubernetes/client-node';
|
||||
import { V1Service } from '@kubernetes/client-node';
|
||||
|
||||
// @public (undocumented)
|
||||
export type AuthProviderType = 'google' | 'serviceAccount' | 'aws';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ClusterObjects {
|
||||
// (undocumented)
|
||||
cluster: {
|
||||
name: string;
|
||||
};
|
||||
// (undocumented)
|
||||
errors: KubernetesFetchError[];
|
||||
// (undocumented)
|
||||
resources: FetchResponse[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ConfigMapFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<V1ConfigMap>;
|
||||
// (undocumented)
|
||||
type: 'configmaps';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CustomResourceFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<any>;
|
||||
// (undocumented)
|
||||
type: 'customresources';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface DeploymentFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<V1Deployment>;
|
||||
// (undocumented)
|
||||
type: 'deployments';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type FetchResponse = PodFetchResponse | ServiceFetchResponse | ConfigMapFetchResponse | DeploymentFetchResponse | ReplicaSetsFetchResponse | HorizontalPodAutoscalersFetchResponse | IngressesFetchResponse | CustomResourceFetchResponse;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface HorizontalPodAutoscalersFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<V1HorizontalPodAutoscaler>;
|
||||
// (undocumented)
|
||||
type: 'horizontalpodautoscalers';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface IngressesFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<ExtensionsV1beta1Ingress>;
|
||||
// (undocumented)
|
||||
type: 'ingresses';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type KubernetesErrorTypes = 'BAD_REQUEST' | 'UNAUTHORIZED_ERROR' | 'SYSTEM_ERROR' | 'UNKNOWN_ERROR';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface KubernetesFetchError {
|
||||
// (undocumented)
|
||||
errorType: KubernetesErrorTypes;
|
||||
// (undocumented)
|
||||
resourcePath?: string;
|
||||
// (undocumented)
|
||||
statusCode?: number;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface KubernetesRequestBody {
|
||||
// (undocumented)
|
||||
auth?: {
|
||||
google?: string;
|
||||
};
|
||||
// (undocumented)
|
||||
entity: Entity;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ObjectsByEntityResponse {
|
||||
// (undocumented)
|
||||
items: ClusterObjects[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface PodFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<V1Pod>;
|
||||
// (undocumented)
|
||||
type: 'pods';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ReplicaSetsFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<V1ReplicaSet>;
|
||||
// (undocumented)
|
||||
type: 'replicasets';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ServiceFetchResponse {
|
||||
// (undocumented)
|
||||
resources: Array<V1Service>;
|
||||
// (undocumented)
|
||||
type: 'services';
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,46 @@
|
||||
## API Report File for "@backstage/plugin-kubernetes"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
|
||||
import { OAuthApi } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityKubernetesContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
|
||||
constructor(options: {
|
||||
googleAuthApi: OAuthApi;
|
||||
});
|
||||
// (undocumented)
|
||||
decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const kubernetesAuthProvidersApiRef: ApiRef<KubernetesAuthProvidersApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
const kubernetesPlugin: BackstagePlugin<{
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { kubernetesPlugin }
|
||||
|
||||
export { kubernetesPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (_props: Props) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,186 @@
|
||||
## API Report File for "@backstage/plugin-lighthouse"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Config } from '@backstage/config';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export type Audit = AuditRunning | AuditFailed | AuditCompleted;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface AuditCompleted extends AuditBase {
|
||||
// (undocumented)
|
||||
categories: Record<LighthouseCategoryId, LighthouseCategoryAbbr>;
|
||||
// (undocumented)
|
||||
report: Object;
|
||||
// (undocumented)
|
||||
status: 'COMPLETED';
|
||||
// (undocumented)
|
||||
timeCompleted: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface AuditFailed extends AuditBase {
|
||||
// (undocumented)
|
||||
status: 'FAILED';
|
||||
// (undocumented)
|
||||
timeCompleted: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface AuditRunning extends AuditBase {
|
||||
// (undocumented)
|
||||
status: 'RUNNING';
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const EmbeddedRouter: (_props: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityLastLighthouseAuditCard: ({ dense, variant, }: {
|
||||
dense?: boolean | undefined;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityLighthouseContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export class FetchError extends Error {
|
||||
// (undocumented)
|
||||
static forResponse(resp: Response): Promise<FetchError>;
|
||||
// (undocumented)
|
||||
get name(): string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
const isLighthouseAvailable: (entity: Entity) => boolean;
|
||||
|
||||
export { isLighthouseAvailable }
|
||||
|
||||
export { isLighthouseAvailable as isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export interface LASListRequest {
|
||||
// (undocumented)
|
||||
limit?: number;
|
||||
// (undocumented)
|
||||
offset?: number;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface LASListResponse<Item> {
|
||||
// (undocumented)
|
||||
items: Item[];
|
||||
// (undocumented)
|
||||
limit: number;
|
||||
// (undocumented)
|
||||
offset: number;
|
||||
// (undocumented)
|
||||
total: number;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const LastLighthouseAuditCard: ({ dense, variant, }: {
|
||||
dense?: boolean | undefined;
|
||||
variant?: InfoCardVariants | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type LighthouseApi = {
|
||||
url: string;
|
||||
getWebsiteList: (listOptions: LASListRequest) => Promise<WebsiteListResponse>;
|
||||
getWebsiteForAuditId: (auditId: string) => Promise<Website>;
|
||||
triggerAudit: (payload: TriggerAuditPayload) => Promise<Audit>;
|
||||
getWebsiteByUrl: (websiteUrl: string) => Promise<Website>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const lighthouseApiRef: ApiRef<LighthouseApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface LighthouseCategoryAbbr {
|
||||
// (undocumented)
|
||||
id: LighthouseCategoryId;
|
||||
// (undocumented)
|
||||
score: number;
|
||||
// (undocumented)
|
||||
title: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type LighthouseCategoryId = 'pwa' | 'seo' | 'performance' | 'accessibility' | 'best-practices';
|
||||
|
||||
// @public (undocumented)
|
||||
export const LighthousePage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const lighthousePlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { lighthousePlugin }
|
||||
|
||||
export { lighthousePlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export class LighthouseRestApi implements LighthouseApi {
|
||||
constructor(url: string);
|
||||
// (undocumented)
|
||||
static fromConfig(config: Config): LighthouseRestApi;
|
||||
// (undocumented)
|
||||
getWebsiteByUrl(websiteUrl: string): Promise<Website>;
|
||||
// (undocumented)
|
||||
getWebsiteForAuditId(auditId: string): Promise<Website>;
|
||||
// (undocumented)
|
||||
getWebsiteList({ limit, offset, }?: LASListRequest): Promise<WebsiteListResponse>;
|
||||
// (undocumented)
|
||||
triggerAudit(payload: TriggerAuditPayload): Promise<Audit>;
|
||||
// (undocumented)
|
||||
url: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface TriggerAuditPayload {
|
||||
// (undocumented)
|
||||
options: {
|
||||
lighthouseConfig: {
|
||||
settings: {
|
||||
emulatedFormFactor: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
// (undocumented)
|
||||
url: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface Website {
|
||||
// (undocumented)
|
||||
audits: Audit[];
|
||||
// (undocumented)
|
||||
lastAudit: Audit;
|
||||
// (undocumented)
|
||||
url: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type WebsiteListResponse = LASListResponse<Website>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,25 @@
|
||||
## API Report File for "@backstage/plugin-newrelic"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const NewRelicPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const newRelicPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { newRelicPlugin }
|
||||
|
||||
export { newRelicPlugin as plugin }
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,69 @@
|
||||
## API Report File for "@backstage/plugin-org"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { GroupEntity } from '@backstage/catalog-model';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
import { UserEntity } from '@backstage/catalog-model';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityGroupProfileCard: ({ variant, }: {
|
||||
entity?: GroupEntity| undefined;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityMembersListCard: (_props: {
|
||||
entity?: GroupEntity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityOwnershipCard: ({ variant, }: {
|
||||
entity?: Entity| undefined;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityUserProfileCard: ({ variant, }: {
|
||||
entity?: UserEntity| undefined;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const GroupProfileCard: ({ variant, }: {
|
||||
entity?: GroupEntity | undefined;
|
||||
variant?: InfoCardVariants | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const MembersListCard: (_props: {
|
||||
entity?: GroupEntity;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const orgPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
export { orgPlugin }
|
||||
|
||||
export { orgPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const OwnershipCard: ({ variant, }: {
|
||||
entity?: Entity | undefined;
|
||||
variant?: InfoCardVariants | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const UserProfileCard: ({ variant, }: {
|
||||
entity?: UserEntity | undefined;
|
||||
variant?: InfoCardVariants | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,62 @@
|
||||
## API Report File for "@backstage/plugin-pagerduty"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { ConfigApi } from '@backstage/core';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { PropsWithChildren } from 'react';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityPagerDutyCard: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const isPluginApplicableToEntity: (entity: Entity) => boolean;
|
||||
|
||||
export { isPluginApplicableToEntity as isPagerDutyAvailable }
|
||||
|
||||
export { isPluginApplicableToEntity }
|
||||
|
||||
// @public (undocumented)
|
||||
export const pagerDutyApiRef: ApiRef<PagerDutyApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const PagerDutyCard: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export class PagerDutyClient implements PagerDutyApi {
|
||||
constructor(config: ClientApiConfig);
|
||||
// (undocumented)
|
||||
static fromConfig(configApi: ConfigApi, discoveryApi: DiscoveryApi): PagerDutyClient;
|
||||
// (undocumented)
|
||||
getIncidentsByServiceId(serviceId: string): Promise<Incident[]>;
|
||||
// (undocumented)
|
||||
getOnCallByPolicyId(policyId: string): Promise<OnCall[]>;
|
||||
// (undocumented)
|
||||
getServiceByIntegrationKey(integrationKey: string): Promise<Service[]>;
|
||||
// (undocumented)
|
||||
triggerAlarm({ integrationKey, source, description, userName, }: TriggerAlarmRequest): Promise<Response>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
const pagerDutyPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
export { pagerDutyPlugin }
|
||||
|
||||
export { pagerDutyPlugin as plugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export function TriggerButton({ children, }: PropsWithChildren<TriggerButtonProps>): JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export class UnauthorizedError extends Error {
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,18 @@
|
||||
## API Report File for "@backstage/plugin-proxy-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,32 @@
|
||||
## API Report File for "@backstage/plugin-register-component"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const RegisterComponentPage: ({ catalogRouteRef, }: {
|
||||
catalogRouteRef: RouteRef<any>;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const registerComponentPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { registerComponentPlugin as plugin }
|
||||
|
||||
export { registerComponentPlugin }
|
||||
|
||||
// @public @deprecated
|
||||
export const Router: ({ catalogRouteRef }: {
|
||||
catalogRouteRef: RouteRef;
|
||||
}) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,60 @@
|
||||
## API Report File for "@backstage/plugin-rollbar-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function getRequestHeaders(token: string): {
|
||||
headers: {
|
||||
'X-Rollbar-Access-Token': string;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class RollbarApi {
|
||||
constructor(accessToken: string, logger: Logger);
|
||||
// (undocumented)
|
||||
getActivatedCounts(projectName: string, options?: {
|
||||
environment: string;
|
||||
item_id?: number;
|
||||
}): Promise<RollbarItemCount[]>;
|
||||
// (undocumented)
|
||||
getAllProjects(): Promise<RollbarProject[]>;
|
||||
// (undocumented)
|
||||
getOccuranceCounts(projectName: string, options?: {
|
||||
environment: string;
|
||||
item_id?: number;
|
||||
}): Promise<RollbarItemCount[]>;
|
||||
// (undocumented)
|
||||
getProject(projectName: string): Promise<RollbarProject>;
|
||||
// (undocumented)
|
||||
getProjectItems(projectName: string): Promise<RollbarItemsResponse>;
|
||||
// (undocumented)
|
||||
getTopActiveItems(projectName: string, options?: {
|
||||
hours: number;
|
||||
environment: string;
|
||||
}): Promise<RollbarTopActiveItem[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
// (undocumented)
|
||||
rollbarApi?: RollbarApi;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,78 @@
|
||||
## API Report File for "@backstage/plugin-rollbar"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { IdentityApi } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityPageRollbar: (_props: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityRollbarContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const isPluginApplicableToEntity: (entity: Entity) => boolean;
|
||||
|
||||
export { isPluginApplicableToEntity }
|
||||
|
||||
export { isPluginApplicableToEntity as isRollbarAvailable }
|
||||
|
||||
// @public (undocumented)
|
||||
export const ROLLBAR_ANNOTATION = "rollbar.com/project-slug";
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RollbarApi {
|
||||
// (undocumented)
|
||||
getAllProjects(): Promise<RollbarProject[]>;
|
||||
// (undocumented)
|
||||
getProject(projectName: string): Promise<RollbarProject>;
|
||||
// (undocumented)
|
||||
getProjectItems(project: string): Promise<RollbarItemsResponse>;
|
||||
// (undocumented)
|
||||
getTopActiveItems(project: string, hours?: number): Promise<RollbarTopActiveItem[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const rollbarApiRef: ApiRef<RollbarApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class RollbarClient implements RollbarApi {
|
||||
constructor(options: {
|
||||
discoveryApi: DiscoveryApi;
|
||||
identityApi: IdentityApi;
|
||||
});
|
||||
// (undocumented)
|
||||
getAllProjects(): Promise<RollbarProject[]>;
|
||||
// (undocumented)
|
||||
getProject(projectName: string): Promise<RollbarProject>;
|
||||
// (undocumented)
|
||||
getProjectItems(project: string): Promise<RollbarItemsResponse>;
|
||||
// (undocumented)
|
||||
getTopActiveItems(project: string, hours?: number, environment?: string): Promise<RollbarTopActiveItem[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
const rollbarPlugin: BackstagePlugin<{
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { rollbarPlugin as plugin }
|
||||
|
||||
export { rollbarPlugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: (_props: Props_2) => JSX.Element;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,518 @@
|
||||
## API Report File for "@backstage/plugin-scaffolder-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { AzureIntegrationConfig } from '@backstage/integration';
|
||||
import { BitbucketIntegrationConfig } from '@backstage/integration';
|
||||
import { CatalogApi } from '@backstage/catalog-client';
|
||||
import { Config } from '@backstage/config';
|
||||
import { ContainerRunner } from '@backstage/backend-common';
|
||||
import { createPullRequest } from 'octokit-plugin-create-pull-request';
|
||||
import express from 'express';
|
||||
import { GithubCredentialsProvider } from '@backstage/integration';
|
||||
import { GitHubIntegrationConfig } from '@backstage/integration';
|
||||
import { Gitlab } from '@gitbeaker/core';
|
||||
import { GitLabIntegrationConfig } from '@backstage/integration';
|
||||
import gitUrlParse from 'git-url-parse';
|
||||
import { JsonObject } from '@backstage/config';
|
||||
import { JsonValue } from '@backstage/config';
|
||||
import { Logger } from 'winston';
|
||||
import { PluginDatabaseManager } from '@backstage/backend-common';
|
||||
import { Schema } from 'jsonschema';
|
||||
import { ScmIntegrationRegistry } from '@backstage/integration';
|
||||
import { ScmIntegrations } from '@backstage/integration';
|
||||
import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
|
||||
import { TemplateEntityV1beta2 } from '@backstage/catalog-model';
|
||||
import { UrlReader } from '@backstage/backend-common';
|
||||
import { Writable } from 'stream';
|
||||
|
||||
// @public (undocumented)
|
||||
export type ActionContext<Input extends InputBase> = {
|
||||
baseUrl?: string;
|
||||
logger: Logger;
|
||||
logStream: Writable;
|
||||
token?: string | undefined;
|
||||
workspacePath: string;
|
||||
input: Input;
|
||||
output(name: string, value: JsonValue): void;
|
||||
createTemporaryDirectory(): Promise<string>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class AzurePreparer implements PreparerBase {
|
||||
constructor(config: {
|
||||
token?: string;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: AzureIntegrationConfig): AzurePreparer;
|
||||
// (undocumented)
|
||||
prepare({ url, workspacePath, logger }: PreparerOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class AzurePublisher implements PublisherBase {
|
||||
constructor(config: {
|
||||
token: string;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: AzureIntegrationConfig): Promise<AzurePublisher | undefined>;
|
||||
// (undocumented)
|
||||
publish({ values, workspacePath, logger, }: PublisherOptions): Promise<PublisherResult>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class BitbucketPreparer implements PreparerBase {
|
||||
constructor(config: {
|
||||
username?: string;
|
||||
token?: string;
|
||||
appPassword?: string;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: BitbucketIntegrationConfig): BitbucketPreparer;
|
||||
// (undocumented)
|
||||
prepare({ url, workspacePath, logger }: PreparerOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class BitbucketPublisher implements PublisherBase {
|
||||
constructor(config: {
|
||||
host: string;
|
||||
token?: string;
|
||||
appPassword?: string;
|
||||
username?: string;
|
||||
apiBaseUrl?: string;
|
||||
repoVisibility: RepoVisibilityOptions_2;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: BitbucketIntegrationConfig, { repoVisibility }: {
|
||||
repoVisibility: RepoVisibilityOptions_2;
|
||||
}): Promise<BitbucketPublisher>;
|
||||
// (undocumented)
|
||||
publish({ values, workspacePath, logger, }: PublisherOptions): Promise<PublisherResult>;
|
||||
}
|
||||
|
||||
// @public
|
||||
export class CatalogEntityClient {
|
||||
constructor(catalogClient: CatalogApi);
|
||||
findTemplate(templateName: string, options?: {
|
||||
token?: string;
|
||||
}): Promise<TemplateEntityV1alpha1 | TemplateEntityV1beta2>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class CookieCutter implements TemplaterBase {
|
||||
constructor({ containerRunner }: {
|
||||
containerRunner: ContainerRunner;
|
||||
});
|
||||
// (undocumented)
|
||||
run({ workspacePath, values, logStream, }: TemplaterRunOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const createBuiltinActions: (options: {
|
||||
reader: UrlReader;
|
||||
integrations: ScmIntegrations;
|
||||
catalogClient: CatalogApi;
|
||||
templaters: TemplaterBuilder;
|
||||
}) => TemplateAction<any>[];
|
||||
|
||||
// @public (undocumented)
|
||||
export function createCatalogRegisterAction(options: {
|
||||
catalogClient: CatalogApi;
|
||||
integrations: ScmIntegrations;
|
||||
}): TemplateAction<any>;
|
||||
|
||||
// @public
|
||||
export function createDebugLogAction(): TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createFetchCookiecutterAction(options: {
|
||||
reader: UrlReader;
|
||||
integrations: ScmIntegrations;
|
||||
templaters: TemplaterBuilder;
|
||||
}): TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createFetchPlainAction(options: {
|
||||
reader: UrlReader;
|
||||
integrations: ScmIntegrations;
|
||||
}): TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createLegacyActions(options: Options): TemplateAction<any>[];
|
||||
|
||||
// @public (undocumented)
|
||||
export function createPublishAzureAction(options: {
|
||||
integrations: ScmIntegrationRegistry;
|
||||
}): TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createPublishBitbucketAction(options: {
|
||||
integrations: ScmIntegrationRegistry;
|
||||
}): TemplateAction<any>;
|
||||
|
||||
// @public
|
||||
export function createPublishFileAction(): TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createPublishGithubAction(options: {
|
||||
integrations: ScmIntegrationRegistry;
|
||||
}): TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const createPublishGithubPullRequestAction: ({ integrations, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createPublishGitlabAction(options: {
|
||||
integrations: ScmIntegrationRegistry;
|
||||
}): TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class CreateReactAppTemplater implements TemplaterBase {
|
||||
constructor({ containerRunner }: {
|
||||
containerRunner: ContainerRunner;
|
||||
});
|
||||
// (undocumented)
|
||||
run({ workspacePath, values, logStream, }: TemplaterRunOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const createTemplateAction: <Input extends Partial<{
|
||||
[name: string]: JsonValue| Partial<JsonObject> | undefined;
|
||||
}>>(templateAction: TemplateAction<Input>) => TemplateAction<any>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class FilePreparer implements PreparerBase {
|
||||
// (undocumented)
|
||||
prepare({ url, workspacePath }: PreparerOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public
|
||||
export const getTemplaterKey: (entity: TemplateEntityV1alpha1) => string;
|
||||
|
||||
// @public (undocumented)
|
||||
export class GithubPreparer implements PreparerBase {
|
||||
constructor(config: {
|
||||
credentialsProvider: GithubCredentialsProvider;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: GitHubIntegrationConfig): GithubPreparer;
|
||||
// (undocumented)
|
||||
prepare({ url, workspacePath, logger }: PreparerOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export class GithubPublisher implements PublisherBase {
|
||||
constructor(config: {
|
||||
credentialsProvider: GithubCredentialsProvider;
|
||||
repoVisibility: RepoVisibilityOptions;
|
||||
apiBaseUrl: string | undefined;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: GitHubIntegrationConfig, { repoVisibility }: {
|
||||
repoVisibility: RepoVisibilityOptions;
|
||||
}): Promise<GithubPublisher | undefined>;
|
||||
// (undocumented)
|
||||
publish({ values, workspacePath, logger, }: PublisherOptions): Promise<PublisherResult>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class GitlabPreparer implements PreparerBase {
|
||||
constructor(config: {
|
||||
token?: string;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: GitLabIntegrationConfig): GitlabPreparer;
|
||||
// (undocumented)
|
||||
prepare({ url, workspacePath, logger }: PreparerOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class GitlabPublisher implements PublisherBase {
|
||||
constructor(config: {
|
||||
token: string;
|
||||
client: Gitlab;
|
||||
repoVisibility: RepoVisibilityOptions_3;
|
||||
});
|
||||
// (undocumented)
|
||||
static fromConfig(config: GitLabIntegrationConfig, { repoVisibility }: {
|
||||
repoVisibility: RepoVisibilityOptions_3;
|
||||
}): Promise<GitlabPublisher | undefined>;
|
||||
// (undocumented)
|
||||
publish({ values, workspacePath, logger, }: PublisherOptions): Promise<PublisherResult>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type Job = {
|
||||
id: string;
|
||||
context: StageContext;
|
||||
status: ProcessorStatus;
|
||||
stages: StageResult[];
|
||||
error?: Error;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type JobAndDirectoryTuple = {
|
||||
job: Job;
|
||||
directory: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class JobProcessor implements Processor {
|
||||
constructor(workingDirectory: string);
|
||||
// (undocumented)
|
||||
create({ entity, values, stages, }: {
|
||||
entity: TemplateEntityV1alpha1;
|
||||
values: TemplaterValues;
|
||||
stages: StageInput[];
|
||||
}): Job;
|
||||
// (undocumented)
|
||||
static fromConfig({ config, logger, }: {
|
||||
config: Config;
|
||||
logger: Logger;
|
||||
}): Promise<JobProcessor>;
|
||||
// (undocumented)
|
||||
get(id: string): Job | undefined;
|
||||
// (undocumented)
|
||||
run(job: Job): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export function joinGitUrlPath(repoUrl: string, path?: string): string;
|
||||
|
||||
// @public (undocumented)
|
||||
export type ParsedLocationAnnotation = {
|
||||
protocol: 'file' | 'url';
|
||||
location: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const parseLocationAnnotation: (entity: TemplateEntityV1alpha1) => ParsedLocationAnnotation;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface PreparerBase {
|
||||
prepare(opts: PreparerOptions): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type PreparerBuilder = {
|
||||
register(host: string, preparer: PreparerBase): void;
|
||||
get(url: string): PreparerBase;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type PreparerOptions = {
|
||||
url: string;
|
||||
workspacePath: string;
|
||||
logger: Logger;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class Preparers implements PreparerBuilder {
|
||||
// (undocumented)
|
||||
static fromConfig(config: Config, _: {
|
||||
logger: Logger;
|
||||
}): Promise<PreparerBuilder>;
|
||||
// (undocumented)
|
||||
get(url: string): PreparerBase;
|
||||
// (undocumented)
|
||||
register(host: string, preparer: PreparerBase): void;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type Processor = {
|
||||
create({ entity, values, stages, }: {
|
||||
entity: TemplateEntityV1alpha1;
|
||||
values: TemplaterValues;
|
||||
stages: StageInput[];
|
||||
}): Job;
|
||||
get(id: string): Job | undefined;
|
||||
run(job: Job): Promise<void>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type ProcessorStatus = 'PENDING' | 'STARTED' | 'COMPLETED' | 'FAILED';
|
||||
|
||||
// @public
|
||||
export type PublisherBase = {
|
||||
publish(opts: PublisherOptions): Promise<PublisherResult>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type PublisherBuilder = {
|
||||
register(host: string, publisher: PublisherBase): void;
|
||||
get(storePath: string): PublisherBase;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type PublisherOptions = {
|
||||
values: TemplaterValues;
|
||||
workspacePath: string;
|
||||
logger: Logger;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type PublisherResult = {
|
||||
remoteUrl: string;
|
||||
catalogInfoUrl?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class Publishers implements PublisherBuilder {
|
||||
// (undocumented)
|
||||
static fromConfig(config: Config, _options: {
|
||||
logger: Logger;
|
||||
}): Promise<PublisherBuilder>;
|
||||
// (undocumented)
|
||||
get(url: string): PublisherBase;
|
||||
// (undocumented)
|
||||
register(host: string, preparer: PublisherBase | undefined): void;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type RepoVisibilityOptions = 'private' | 'internal' | 'public';
|
||||
|
||||
// @public
|
||||
export type RequiredTemplateValues = {
|
||||
owner: string;
|
||||
storePath: string;
|
||||
destination?: {
|
||||
git?: gitUrlParse.GitUrl;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
actions?: TemplateAction<any>[];
|
||||
// (undocumented)
|
||||
catalogClient: CatalogApi;
|
||||
// (undocumented)
|
||||
config: Config;
|
||||
// (undocumented)
|
||||
database: PluginDatabaseManager;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
// (undocumented)
|
||||
preparers: PreparerBuilder;
|
||||
// (undocumented)
|
||||
publishers: PublisherBuilder;
|
||||
// (undocumented)
|
||||
reader: UrlReader;
|
||||
// (undocumented)
|
||||
taskWorkers?: number;
|
||||
// (undocumented)
|
||||
templaters: TemplaterBuilder;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const runCommand: ({ command, args, logStream, }: RunCommandOptions) => Promise<void>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type RunCommandOptions = {
|
||||
command: string;
|
||||
args: string[];
|
||||
logStream?: Writable;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type StageContext<T = {}> = {
|
||||
values: TemplaterValues;
|
||||
entity: TemplateEntityV1alpha1;
|
||||
logger: Logger;
|
||||
logStream: Writable;
|
||||
workspacePath: string;
|
||||
} & T;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface StageInput<T = {}> {
|
||||
// (undocumented)
|
||||
handler(ctx: StageContext<T>): Promise<void | object>;
|
||||
// (undocumented)
|
||||
name: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface StageResult extends StageInput {
|
||||
// (undocumented)
|
||||
endedAt?: number;
|
||||
// (undocumented)
|
||||
log: string[];
|
||||
// (undocumented)
|
||||
startedAt?: number;
|
||||
// (undocumented)
|
||||
status: ProcessorStatus;
|
||||
}
|
||||
|
||||
// @public
|
||||
export type SupportedTemplatingKey = 'cookiecutter' | string;
|
||||
|
||||
// @public (undocumented)
|
||||
export type TemplateAction<Input extends InputBase> = {
|
||||
id: string;
|
||||
description?: string;
|
||||
schema?: {
|
||||
input?: Schema;
|
||||
output?: Schema;
|
||||
};
|
||||
handler: (ctx: ActionContext<Input>) => Promise<void>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class TemplateActionRegistry {
|
||||
// (undocumented)
|
||||
get(actionId: string): TemplateAction<any>;
|
||||
// (undocumented)
|
||||
list(): TemplateAction<any>[];
|
||||
// (undocumented)
|
||||
register<Parameters extends InputBase>(action: TemplateAction<Parameters>): void;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type TemplaterBase = {
|
||||
run(opts: TemplaterRunOptions): Promise<void>;
|
||||
};
|
||||
|
||||
// @public
|
||||
export type TemplaterBuilder = {
|
||||
register(protocol: SupportedTemplatingKey, templater: TemplaterBase): void;
|
||||
get(templater: string): TemplaterBase;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type TemplaterConfig = {
|
||||
templater?: TemplaterBase;
|
||||
};
|
||||
|
||||
// @public
|
||||
export type TemplaterRunOptions = {
|
||||
workspacePath: string;
|
||||
values: TemplaterValues;
|
||||
logStream?: Writable;
|
||||
};
|
||||
|
||||
// @public
|
||||
export type TemplaterRunResult = {
|
||||
resultDir: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export class Templaters implements TemplaterBuilder {
|
||||
// (undocumented)
|
||||
get(templaterId: string): TemplaterBase;
|
||||
// (undocumented)
|
||||
register(templaterKey: SupportedTemplatingKey, templater: TemplaterBase): void;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type TemplaterValues = RequiredTemplateValues & Record<string, any>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,112 @@
|
||||
## API Report File for "@backstage/plugin-scaffolder"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { EntityName } from '@backstage/catalog-model';
|
||||
import { Extension } from '@backstage/core';
|
||||
import { ExternalRouteRef } from '@backstage/core';
|
||||
import { FieldProps } from '@rjsf/core';
|
||||
import { FieldValidation } from '@rjsf/core';
|
||||
import { IdentityApi } from '@backstage/core';
|
||||
import { JsonObject } from '@backstage/config';
|
||||
import { JSONSchema } from '@backstage/catalog-model';
|
||||
import { JsonValue } from '@backstage/config';
|
||||
import { Observable } from '@backstage/core';
|
||||
import { default as React_2 } from 'react';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
import { ScmIntegrationRegistry } from '@backstage/integration';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createScaffolderFieldExtension<T = any>(options: FieldExtensionOptions<T>): Extension<() => null>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityPickerFieldExtension: () => null;
|
||||
|
||||
// @public (undocumented)
|
||||
export const OwnerPickerFieldExtension: () => null;
|
||||
|
||||
// @public (undocumented)
|
||||
export const RepoUrlPickerFieldExtension: () => null;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ScaffolderApi {
|
||||
// (undocumented)
|
||||
getIntegrationsList(options: {
|
||||
allowedHosts: string[];
|
||||
}): Promise<{
|
||||
type: string;
|
||||
title: string;
|
||||
host: string;
|
||||
}[]>;
|
||||
// (undocumented)
|
||||
getTask(taskId: string): Promise<ScaffolderTask>;
|
||||
// (undocumented)
|
||||
getTemplateParameterSchema(templateName: EntityName): Promise<TemplateParameterSchema>;
|
||||
// (undocumented)
|
||||
listActions(): Promise<ListActionsResponse>;
|
||||
scaffold(templateName: string, values: Record<string, any>): Promise<string>;
|
||||
// (undocumented)
|
||||
streamLogs({ taskId, after, }: {
|
||||
taskId: string;
|
||||
after?: number;
|
||||
}): Observable<LogEvent>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const scaffolderApiRef: ApiRef<ScaffolderApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class ScaffolderClient implements ScaffolderApi {
|
||||
constructor(options: {
|
||||
discoveryApi: DiscoveryApi;
|
||||
identityApi: IdentityApi;
|
||||
scmIntegrationsApi: ScmIntegrationRegistry;
|
||||
});
|
||||
// (undocumented)
|
||||
getIntegrationsList(options: {
|
||||
allowedHosts: string[];
|
||||
}): Promise<{
|
||||
type: string;
|
||||
title: string;
|
||||
host: string;
|
||||
}[]>;
|
||||
// (undocumented)
|
||||
getTask(taskId: string): Promise<any>;
|
||||
// (undocumented)
|
||||
getTemplateParameterSchema(templateName: EntityName): Promise<TemplateParameterSchema>;
|
||||
// (undocumented)
|
||||
listActions(): Promise<ListActionsResponse>;
|
||||
scaffold(templateName: string, values: Record<string, any>): Promise<string>;
|
||||
// (undocumented)
|
||||
streamLogs({ taskId, after, }: {
|
||||
taskId: string;
|
||||
after?: number;
|
||||
}): Observable<LogEvent>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const ScaffolderFieldExtensions: React_2.ComponentType;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ScaffolderPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const scaffolderPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {
|
||||
registerComponent: ExternalRouteRef<undefined, true>;
|
||||
}>;
|
||||
|
||||
export { scaffolderPlugin as plugin }
|
||||
|
||||
export { scaffolderPlugin }
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,68 @@
|
||||
## API Report File for "@backstage/plugin-search-backend-node"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { DocumentCollator } from '@backstage/search-common';
|
||||
import { DocumentDecorator } from '@backstage/search-common';
|
||||
import { IndexableDocument } from '@backstage/search-common';
|
||||
import { Logger } from 'winston';
|
||||
import { default as lunr_2 } from 'lunr';
|
||||
import { SearchQuery } from '@backstage/search-common';
|
||||
import { SearchResultSet } from '@backstage/search-common';
|
||||
|
||||
// @public (undocumented)
|
||||
export class IndexBuilder {
|
||||
constructor({ logger, searchEngine }: IndexBuilderOptions);
|
||||
addCollator({ collator, defaultRefreshIntervalSeconds, }: RegisterCollatorParameters): void;
|
||||
addDecorator({ decorator }: RegisterDecoratorParameters): void;
|
||||
build(): Promise<{
|
||||
scheduler: Scheduler;
|
||||
}>;
|
||||
// (undocumented)
|
||||
getSearchEngine(): SearchEngine;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class LunrSearchEngine implements SearchEngine {
|
||||
constructor({ logger }: {
|
||||
logger: Logger;
|
||||
});
|
||||
// (undocumented)
|
||||
protected docStore: Record<string, IndexableDocument>;
|
||||
// (undocumented)
|
||||
index(type: string, documents: IndexableDocument[]): void;
|
||||
// (undocumented)
|
||||
protected logger: Logger;
|
||||
// (undocumented)
|
||||
protected lunrIndices: Record<string, lunr_2.Index>;
|
||||
// (undocumented)
|
||||
query(query: SearchQuery): Promise<SearchResultSet>;
|
||||
// (undocumented)
|
||||
setTranslator(translator: LunrQueryTranslator): void;
|
||||
// (undocumented)
|
||||
protected translator: QueryTranslator;
|
||||
}
|
||||
|
||||
// @public
|
||||
export class Scheduler {
|
||||
constructor({ logger }: {
|
||||
logger: Logger;
|
||||
});
|
||||
addToSchedule(task: Function, interval: number): void;
|
||||
start(): void;
|
||||
stop(): void;
|
||||
}
|
||||
|
||||
// @public
|
||||
export interface SearchEngine {
|
||||
index(type: string, documents: IndexableDocument[]): void;
|
||||
query(query: SearchQuery): Promise<SearchResultSet>;
|
||||
setTranslator(translator: QueryTranslator): void;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
## API Report File for "@backstage/plugin-search-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
import { SearchEngine } from '@backstage/plugin-search-backend-node';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter({ engine, logger, }: RouterOptions): Promise<express.Router>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,102 @@
|
||||
## API Report File for "@backstage/plugin-search"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { AsyncState } from 'react-use/lib/useAsync';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { IndexableDocument } from '@backstage/search-common';
|
||||
import { JsonObject } from '@backstage/config';
|
||||
import { default as React_2 } from 'react';
|
||||
import { ReactElement } from 'react';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
import { SearchQuery } from '@backstage/search-common';
|
||||
import { SearchResult as SearchResult_2 } from '@backstage/search-common';
|
||||
import { SearchResultSet } from '@backstage/search-common';
|
||||
|
||||
// @public (undocumented)
|
||||
export const DefaultResultListItem: ({ result }: {
|
||||
result: IndexableDocument;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const Filters: ({ filters, filterOptions, resetFilters, updateSelected, updateChecked, }: FiltersProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const FiltersButton: ({ numberOfSelectedFilters, handleToggleFilters, }: FiltersButtonProps) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type FiltersState = {
|
||||
selected: string;
|
||||
checked: Array<string>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const searchApiRef: ApiRef<SearchApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const SearchBar: ({ className, debounceTime }: Props) => JSX.Element;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const SearchBarNext: ({ className, debounceTime }: {
|
||||
className?: string | undefined;
|
||||
debounceTime?: number | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const SearchContextProvider: ({ initialState, children, }: React_2.PropsWithChildren<{
|
||||
initialState?: SettableSearchContext | undefined;
|
||||
}>) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const SearchFilter: {
|
||||
({ component: Element, ...props }: Props_2): JSX.Element;
|
||||
Checkbox(props: Omit<Props_2, 'component'> & Component): JSX.Element;
|
||||
Select(props: Omit<Props_2, 'component'> & Component): JSX.Element;
|
||||
};
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const SearchFilterNext: {
|
||||
({ component: Element, ...props }: Props_2): JSX.Element;
|
||||
Checkbox(props: Omit<Props_2, 'component'> & Component): JSX.Element;
|
||||
Select(props: Omit<Props_2, 'component'> & Component): JSX.Element;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const SearchPage: () => JSX.Element;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const SearchPageNext: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const searchPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
nextRoot: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { searchPlugin as plugin }
|
||||
|
||||
export { searchPlugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const SearchResult: ({ children }: {
|
||||
children: (results: {
|
||||
results: SearchResult_2[];
|
||||
}) => JSX.Element;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const SidebarSearch: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const useSearch: () => SearchContextValue;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,100 @@
|
||||
## API Report File for "@backstage/plugin-sentry"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntitySentryCard: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntitySentryContent: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export class MockSentryApi implements SentryApi {
|
||||
// (undocumented)
|
||||
fetchIssues(): Promise<SentryIssue[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class ProductionSentryApi implements SentryApi {
|
||||
constructor(discoveryApi: DiscoveryApi, organization: string);
|
||||
// (undocumented)
|
||||
fetchIssues(project: string, statsFor: string): Promise<SentryIssue[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: ({ entity }: {
|
||||
entity: Entity;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface SentryApi {
|
||||
// (undocumented)
|
||||
fetchIssues(project: string, statsFor: string): Promise<SentryIssue[]>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const sentryApiRef: ApiRef<SentryApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type SentryIssue = {
|
||||
platform: SentryPlatform;
|
||||
lastSeen: string;
|
||||
numComments: number;
|
||||
userCount: number;
|
||||
stats: {
|
||||
'24h'?: EventPoint[];
|
||||
'12h'?: EventPoint[];
|
||||
};
|
||||
culprit: string;
|
||||
title: string;
|
||||
id: string;
|
||||
assignedTo: any;
|
||||
logger: any;
|
||||
type: string;
|
||||
annotations: any[];
|
||||
metadata: SentryIssueMetadata;
|
||||
status: string;
|
||||
subscriptionDetails: any;
|
||||
isPublic: boolean;
|
||||
hasSeen: boolean;
|
||||
shortId: string;
|
||||
shareId: string | null;
|
||||
firstSeen: string;
|
||||
count: string;
|
||||
permalink: string;
|
||||
level: string;
|
||||
isSubscribed: boolean;
|
||||
isBookmarked: boolean;
|
||||
project: SentryProject;
|
||||
statusDetails: any;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const SentryIssuesWidget: ({ entity, statsFor, variant, }: {
|
||||
entity: Entity;
|
||||
statsFor?: "12h" | "24h" | undefined;
|
||||
variant?: InfoCardVariants | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const sentryPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { sentryPlugin as plugin }
|
||||
|
||||
export { sentryPlugin }
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,56 @@
|
||||
## API Report File for "@backstage/plugin-shortcuts"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Observable } from '@backstage/core';
|
||||
import ObservableImpl from 'zen-observable';
|
||||
import { StorageApi } from '@backstage/core';
|
||||
|
||||
// @public
|
||||
export class LocalStoredShortcuts implements ShortcutApi {
|
||||
constructor(storageApi: StorageApi);
|
||||
// (undocumented)
|
||||
add(shortcut: Omit<Shortcut, 'id'>): Promise<void>;
|
||||
// (undocumented)
|
||||
getColor(url: string): string;
|
||||
// (undocumented)
|
||||
remove(id: string): Promise<void>;
|
||||
// (undocumented)
|
||||
shortcut$(): ObservableImpl<Shortcut[]>;
|
||||
// (undocumented)
|
||||
update(shortcut: Shortcut): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type Shortcut = {
|
||||
id: string;
|
||||
url: string;
|
||||
title: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ShortcutApi {
|
||||
add(shortcut: Omit<Shortcut, 'id'>): Promise<void>;
|
||||
getColor(url: string): string;
|
||||
remove(id: string): Promise<void>;
|
||||
shortcut$(): Observable<Shortcut[]>;
|
||||
update(shortcut: Shortcut): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const Shortcuts: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const shortcutsApiRef: ApiRef<ShortcutApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const shortcutsPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,41 @@
|
||||
## API Report File for "@backstage/plugin-sonarqube"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { InfoCardVariants } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntitySonarQubeCard: ({ variant, duplicationRatings, }: {
|
||||
entity?: Entity| undefined;
|
||||
variant?: InfoCardVariants| undefined;
|
||||
duplicationRatings?: {
|
||||
greaterThan: number;
|
||||
rating: "1.0" | "2.0" | "3.0" | "4.0" | "5.0";
|
||||
}[] | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const isSonarQubeAvailable: (entity: Entity) => boolean;
|
||||
|
||||
// @public (undocumented)
|
||||
export const SonarQubeCard: ({ variant, duplicationRatings, }: {
|
||||
entity?: Entity | undefined;
|
||||
variant?: InfoCardVariants | undefined;
|
||||
duplicationRatings?: DuplicationRating[] | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const sonarQubePlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
export { sonarQubePlugin as plugin }
|
||||
|
||||
export { sonarQubePlugin }
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,68 @@
|
||||
## API Report File for "@backstage/plugin-splunk-on-call"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { ConfigApi } from '@backstage/core';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntitySplunkOnCallCard: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const isSplunkOnCallAvailable: (entity: Entity) => boolean;
|
||||
|
||||
// @public (undocumented)
|
||||
export const splunkOnCallApiRef: ApiRef<SplunkOnCallApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export class SplunkOnCallClient implements SplunkOnCallApi {
|
||||
constructor(config: ClientApiConfig);
|
||||
// (undocumented)
|
||||
static fromConfig(configApi: ConfigApi, discoveryApi: DiscoveryApi): SplunkOnCallClient;
|
||||
// (undocumented)
|
||||
getEscalationPolicies(): Promise<EscalationPolicyInfo[]>;
|
||||
// (undocumented)
|
||||
getIncidents(): Promise<Incident[]>;
|
||||
// (undocumented)
|
||||
getOnCallUsers(): Promise<OnCall[]>;
|
||||
// (undocumented)
|
||||
getTeams(): Promise<Team[]>;
|
||||
// (undocumented)
|
||||
getUsers(): Promise<User[]>;
|
||||
// (undocumented)
|
||||
incidentAction({ routingKey, incidentType, incidentId, incidentDisplayName, incidentMessage, incidentStartTime, }: TriggerAlarmRequest): Promise<Response>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const SplunkOnCallPage: {
|
||||
({ title, subtitle, pageTitle, }: SplunkOnCallPageProps): JSX.Element;
|
||||
defaultProps: {
|
||||
title: string;
|
||||
subtitle: string;
|
||||
pageTitle: string;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
const splunkOnCallPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { splunkOnCallPlugin as plugin }
|
||||
|
||||
export { splunkOnCallPlugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export class UnauthorizedError extends Error {
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,123 @@
|
||||
## API Report File for "@backstage/plugin-tech-radar"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RadarEntry {
|
||||
// (undocumented)
|
||||
description?: string;
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
key: string;
|
||||
// (undocumented)
|
||||
quadrant: string;
|
||||
// (undocumented)
|
||||
timeline: Array<RadarEntrySnapshot>;
|
||||
// (undocumented)
|
||||
title: string;
|
||||
// (undocumented)
|
||||
url: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RadarEntrySnapshot {
|
||||
// (undocumented)
|
||||
date: Date;
|
||||
// (undocumented)
|
||||
description?: string;
|
||||
// (undocumented)
|
||||
moved?: MovedState;
|
||||
// (undocumented)
|
||||
ringId: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RadarQuadrant {
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
name: string;
|
||||
}
|
||||
|
||||
// @public
|
||||
export interface RadarRing {
|
||||
// (undocumented)
|
||||
color: string;
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
name: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: {
|
||||
({ title, subtitle, pageTitle, ...props }: TechRadarPageProps): JSX.Element;
|
||||
defaultProps: {
|
||||
title: string;
|
||||
subtitle: string;
|
||||
pageTitle: string;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface TechRadarApi {
|
||||
// (undocumented)
|
||||
load: () => Promise<TechRadarLoaderResponse>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const techRadarApiRef: ApiRef<TechRadarApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const TechRadarComponent: (props: TechRadarComponentProps) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export interface TechRadarComponentProps {
|
||||
// (undocumented)
|
||||
height: number;
|
||||
// (undocumented)
|
||||
svgProps?: object;
|
||||
// (undocumented)
|
||||
width: number;
|
||||
}
|
||||
|
||||
// @public
|
||||
export interface TechRadarLoaderResponse {
|
||||
// (undocumented)
|
||||
entries: RadarEntry[];
|
||||
// (undocumented)
|
||||
quadrants: RadarQuadrant[];
|
||||
// (undocumented)
|
||||
rings: RadarRing[];
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const TechRadarPage: {
|
||||
({ title, subtitle, pageTitle, ...props }: TechRadarPageProps): JSX.Element;
|
||||
defaultProps: {
|
||||
title: string;
|
||||
subtitle: string;
|
||||
pageTitle: string;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
const techRadarPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { techRadarPlugin as plugin }
|
||||
|
||||
export { techRadarPlugin }
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,24 @@
|
||||
## API Report File for "@backstage/plugin-techdocs-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
import express from 'express';
|
||||
import { GeneratorBuilder } from '@backstage/techdocs-common';
|
||||
import { Knex } from 'knex';
|
||||
import { Logger } from 'winston';
|
||||
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
||||
import { PreparerBuilder } from '@backstage/techdocs-common';
|
||||
import { PublisherBase } from '@backstage/techdocs-common';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter({ preparers, generators, publisher, config, logger, discovery, }: RouterOptions): Promise<express.Router>;
|
||||
|
||||
|
||||
export * from "@backstage/techdocs-common";
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,146 @@
|
||||
## API Report File for "@backstage/plugin-techdocs"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Config } from '@backstage/config';
|
||||
import { CSSProperties } from '@material-ui/styles';
|
||||
import { DiscoveryApi } from '@backstage/core';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { EntityName } from '@backstage/catalog-model';
|
||||
import { IdentityApi } from '@backstage/core';
|
||||
import { Location as Location_2 } from '@backstage/catalog-model';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const DocsCardGrid: ({ entities, }: {
|
||||
entities: Entity[] | undefined;
|
||||
}) => JSX.Element | null;
|
||||
|
||||
// @public (undocumented)
|
||||
export const DocsTable: ({ entities, title, }: {
|
||||
entities: Entity[] | undefined;
|
||||
title?: string | undefined;
|
||||
}) => JSX.Element | null;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityTechdocsContent: (_props: {
|
||||
entity?: Entity| undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type PanelType = 'DocsCardGrid' | 'DocsTable';
|
||||
|
||||
// @public (undocumented)
|
||||
export const Reader: ({ entityId, onReady }: Props_2) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface TechDocsApi {
|
||||
// (undocumented)
|
||||
getApiOrigin(): Promise<string>;
|
||||
// (undocumented)
|
||||
getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
|
||||
// (undocumented)
|
||||
getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const techdocsApiRef: ApiRef<TechDocsApi>;
|
||||
|
||||
// @public
|
||||
export class TechDocsClient implements TechDocsApi {
|
||||
constructor({ configApi, discoveryApi, identityApi, }: {
|
||||
configApi: Config;
|
||||
discoveryApi: DiscoveryApi;
|
||||
identityApi: IdentityApi;
|
||||
});
|
||||
// (undocumented)
|
||||
configApi: Config;
|
||||
// (undocumented)
|
||||
discoveryApi: DiscoveryApi;
|
||||
// (undocumented)
|
||||
getApiOrigin(): Promise<string>;
|
||||
getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
|
||||
getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
|
||||
// (undocumented)
|
||||
identityApi: IdentityApi;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const TechDocsCustomHome: ({ tabsConfig, }: {
|
||||
tabsConfig: TabsConfig;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const TechdocsPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const techdocsPlugin: BackstagePlugin<{
|
||||
root: RouteRef<undefined>;
|
||||
entityContent: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { techdocsPlugin as plugin }
|
||||
|
||||
export { techdocsPlugin }
|
||||
|
||||
// @public (undocumented)
|
||||
export const TechDocsReaderPage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface TechDocsStorageApi {
|
||||
// (undocumented)
|
||||
getApiOrigin(): Promise<string>;
|
||||
// (undocumented)
|
||||
getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
|
||||
// (undocumented)
|
||||
getBuilder(): Promise<string>;
|
||||
// (undocumented)
|
||||
getEntityDocs(entityId: EntityName, path: string): Promise<string>;
|
||||
// (undocumented)
|
||||
getStorageUrl(): Promise<string>;
|
||||
// (undocumented)
|
||||
syncEntityDocs(entityId: EntityName): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const techdocsStorageApiRef: ApiRef<TechDocsStorageApi>;
|
||||
|
||||
// @public
|
||||
export class TechDocsStorageClient implements TechDocsStorageApi {
|
||||
constructor({ configApi, discoveryApi, identityApi, }: {
|
||||
configApi: Config;
|
||||
discoveryApi: DiscoveryApi;
|
||||
identityApi: IdentityApi;
|
||||
});
|
||||
// (undocumented)
|
||||
configApi: Config;
|
||||
// (undocumented)
|
||||
discoveryApi: DiscoveryApi;
|
||||
// (undocumented)
|
||||
getApiOrigin(): Promise<string>;
|
||||
// (undocumented)
|
||||
getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
|
||||
// (undocumented)
|
||||
getBuilder(): Promise<string>;
|
||||
getEntityDocs(entityId: EntityName, path: string): Promise<string>;
|
||||
// (undocumented)
|
||||
getStorageUrl(): Promise<string>;
|
||||
// (undocumented)
|
||||
identityApi: IdentityApi;
|
||||
syncEntityDocs(entityId: EntityName): Promise<boolean>;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,98 @@
|
||||
## API Report File for "@backstage/plugin-todo-backend"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { CatalogApi } from '@backstage/catalog-client';
|
||||
import { Config } from '@backstage/config';
|
||||
import { EntityName } from '@backstage/catalog-model';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
import { ScmIntegrations } from '@backstage/integration';
|
||||
import { UrlReader } from '@backstage/backend-common';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public (undocumented)
|
||||
export function createTodoParser(options?: TodoParserOptions): TodoParser;
|
||||
|
||||
// @public (undocumented)
|
||||
export type ListTodosRequest = {
|
||||
entity?: EntityName;
|
||||
offset?: number;
|
||||
limit?: number;
|
||||
orderBy?: {
|
||||
field: Fields;
|
||||
direction: 'asc' | 'desc';
|
||||
};
|
||||
filters?: {
|
||||
field: Fields;
|
||||
value: string;
|
||||
}[];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type ListTodosResponse = {
|
||||
items: TodoItem[];
|
||||
totalCount: number;
|
||||
offset: number;
|
||||
limit: number;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type ReadTodosOptions = {
|
||||
url: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type ReadTodosResult = {
|
||||
items: TodoItem[];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type TodoItem = {
|
||||
text: string;
|
||||
tag: string;
|
||||
author?: string;
|
||||
viewUrl?: string;
|
||||
lineNumber?: number;
|
||||
repoFilePath?: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface TodoReader {
|
||||
readTodos(options: ReadTodosOptions): Promise<ReadTodosResult>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class TodoReaderService implements TodoService {
|
||||
constructor(options: Options_2);
|
||||
// (undocumented)
|
||||
listTodos(req: ListTodosRequest, options?: {
|
||||
token?: string;
|
||||
}): Promise<ListTodosResponse>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class TodoScmReader implements TodoReader {
|
||||
constructor(options: Options);
|
||||
// (undocumented)
|
||||
static fromConfig(config: Config, options: Omit<Options, 'integrations'>): TodoScmReader;
|
||||
// (undocumented)
|
||||
readTodos({ url }: ReadTodosOptions): Promise<ReadTodosResult>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface TodoService {
|
||||
// (undocumented)
|
||||
listTodos(req: ListTodosRequest, options?: {
|
||||
token?: string;
|
||||
}): Promise<ListTodosResponse>;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,23 @@
|
||||
## API Report File for "@backstage/plugin-todo"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core-plugin-api';
|
||||
import { BackstagePlugin } from '@backstage/core-plugin-api';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
|
||||
// @public (undocumented)
|
||||
export const EntityTodoContent: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const todoApiRef: ApiRef<TodoApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const todoPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,45 @@
|
||||
## API Report File for "@backstage/plugin-user-settings"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { IconComponent } from '@backstage/core';
|
||||
import { RouteRef } from '@backstage/core';
|
||||
import { SessionApi } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const AuthProviders: ({ providerSettings }: Props_2) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const DefaultProviderSettings: ({ configuredProviders }: Props_3) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ProviderSettingsItem: ({ title, description, icon: Icon, apiRef, }: Props_4) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const Router: ({ providerSettings }: Props) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const Settings: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const UserSettingsPage: ({ providerSettings }: {
|
||||
providerSettings?: JSX.Element | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const userSettingsPlugin: BackstagePlugin<{
|
||||
settingsPage: RouteRef<undefined>;
|
||||
}, {}>;
|
||||
|
||||
export { userSettingsPlugin as plugin }
|
||||
|
||||
export { userSettingsPlugin }
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -0,0 +1,22 @@
|
||||
## API Report File for "@backstage/plugin-welcome"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
|
||||
// @public (undocumented)
|
||||
export const WelcomePage: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
const welcomePlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
export { welcomePlugin as plugin }
|
||||
|
||||
export { welcomePlugin }
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
+52
-22
@@ -60,34 +60,60 @@ PackageJsonLookup.prototype.tryGetPackageJsonFilePathFor = function tryGetPackag
|
||||
return old.call(this, path);
|
||||
};
|
||||
|
||||
const DOCUMENTED_PACKAGES = [
|
||||
'packages/backend-common',
|
||||
'packages/backend-test-utils',
|
||||
'packages/catalog-client',
|
||||
'packages/catalog-model',
|
||||
'packages/cli-common',
|
||||
'packages/config',
|
||||
'packages/config-loader',
|
||||
'packages/core-app-api',
|
||||
const PACKAGE_ROOTS = ['packages', 'plugins'];
|
||||
|
||||
const SKIPPED_PACKAGES = [
|
||||
'packages/app',
|
||||
'packages/backend',
|
||||
'packages/cli',
|
||||
'packages/codemods',
|
||||
'packages/create-app',
|
||||
'packages/docgen',
|
||||
'packages/e2e-test',
|
||||
'packages/storybook',
|
||||
'packages/techdocs-cli',
|
||||
|
||||
// TODO(Rugvip): Enable these once `import * as ...` and `import()` PRs have landed, #1796 & #1916.
|
||||
// 'packages/core-components',
|
||||
'packages/core-plugin-api',
|
||||
'packages/dev-utils',
|
||||
'packages/errors',
|
||||
'packages/integration',
|
||||
'packages/integration-react',
|
||||
'packages/search-common',
|
||||
'packages/techdocs-common',
|
||||
'packages/test-utils',
|
||||
'packages/test-utils-core',
|
||||
'packages/theme',
|
||||
'packages/core',
|
||||
'packages/core-api',
|
||||
'packages/core-components',
|
||||
'plugins/catalog',
|
||||
'plugins/catalog-backend',
|
||||
'plugins/catalog-react',
|
||||
'plugins/github-deployments',
|
||||
'plugins/sentry-backend',
|
||||
];
|
||||
|
||||
async function findPackageDirs() {
|
||||
const packageDirs = new Array<string>();
|
||||
const projectRoot = resolvePath(__dirname, '..');
|
||||
|
||||
for (const packageRoot of PACKAGE_ROOTS) {
|
||||
const dirs = await fs.readdir(resolvePath(projectRoot, packageRoot));
|
||||
for (const dir of dirs) {
|
||||
const fullPackageDir = resolvePath(packageRoot, dir);
|
||||
|
||||
const stat = await fs.stat(fullPackageDir);
|
||||
if (!stat.isDirectory()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const packageDir = relativePath(projectRoot, fullPackageDir);
|
||||
if (!SKIPPED_PACKAGES.includes(packageDir)) {
|
||||
packageDirs.push(packageDir);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return packageDirs;
|
||||
}
|
||||
|
||||
interface ApiExtractionOptions {
|
||||
packageDirs: string[];
|
||||
outputDir: string;
|
||||
isLocalBuild: boolean;
|
||||
}
|
||||
|
||||
async function runApiExtraction({
|
||||
packageDirs,
|
||||
outputDir,
|
||||
@@ -110,7 +136,9 @@ async function runApiExtraction({
|
||||
configObject: {
|
||||
mainEntryPointFilePath: resolvePath(
|
||||
__dirname,
|
||||
'../dist-types/packages/<unscopedPackageName>/src/index.d.ts',
|
||||
'../dist-types',
|
||||
packageDir,
|
||||
'src/index.d.ts',
|
||||
),
|
||||
bundledPackages: [],
|
||||
|
||||
@@ -307,9 +335,11 @@ async function main() {
|
||||
const isCiBuild = process.argv.includes('--ci');
|
||||
const isDocsBuild = process.argv.includes('--docs');
|
||||
|
||||
const packageDirs = await findPackageDirs();
|
||||
|
||||
console.log('# Generating package API reports');
|
||||
await runApiExtraction({
|
||||
packageDirs: DOCUMENTED_PACKAGES,
|
||||
packageDirs,
|
||||
outputDir: tmpDir,
|
||||
isLocalBuild: !isCiBuild,
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user