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

Merge remote-tracking branch 'upstream/master' into feat/techdocs-build-logs

Browse Source 
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
This commit is contained in:
Dominik Henneke
2021-07-13 16:15:08 +02:00
parent fbba171405 7a6a3586ac
commit 246b1797e5
119 changed files with 9860 additions and 5109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-common/api-report.md
+276 -214
View File
@@ -3,6 +3,8 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
/// <reference types="webpack-env" />
import { AzureIntegration } from '@backstage/integration';
import { BitbucketIntegration } from '@backstage/integration';
@@ -32,105 +34,133 @@ import { Writable } from 'stream';
// @public (undocumented)
export class AzureUrlReader implements UrlReader {
constructor(integration: AzureIntegration, deps: {
treeResponseFactory: ReadTreeResponseFactory;
});
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, _options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
constructor(
integration: AzureIntegration,
deps: {
treeResponseFactory: ReadTreeResponseFactory;
},
);
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, _options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
}
// @public
export class BitbucketUrlReader implements UrlReader {
constructor(integration: BitbucketIntegration, deps: {
treeResponseFactory: ReadTreeResponseFactory;
});
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, _options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
constructor(
integration: BitbucketIntegration,
deps: {
treeResponseFactory: ReadTreeResponseFactory;
},
);
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, _options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
}
// @public
export interface CacheClient {
delete(key: string): Promise<void>;
get(key: string): Promise<JsonValue | undefined>;
set(key: string, value: JsonValue, options?: CacheSetOptions): Promise<void>;
delete(key: string): Promise<void>;
get(key: string): Promise<JsonValue | undefined>;
set(key: string, value: JsonValue, options?: CacheSetOptions): Promise<void>;
}
// @public
export class CacheManager {
forPlugin(pluginId: string): PluginCacheManager;
static fromConfig(config: Config, options?: CacheManagerOptions): CacheManager;
}
forPlugin(pluginId: string): PluginCacheManager;
static fromConfig(
config: Config,
options?: CacheManagerOptions,
): CacheManager;
}
// @public (undocumented)
export const coloredFormat: winston.Logform.Format;
// @public (undocumented)
export interface ContainerRunner {
// (undocumented)
runContainer(opts: RunContainerOptions): Promise<void>;
// (undocumented)
runContainer(opts: RunContainerOptions): Promise<void>;
}
// @public @deprecated
export const createDatabase: typeof createDatabaseClient;
// @public
export function createDatabaseClient(dbConfig: Config, overrides?: Partial<Knex.Config>): Knex<any, unknown[]>;
export function createDatabaseClient(
dbConfig: Config,
overrides?: Partial<Knex.Config>,
): Knex<any, unknown[]>;
// @public (undocumented)
export function createRootLogger(options?: winston.LoggerOptions, env?: NodeJS.ProcessEnv): winston.Logger;
export function createRootLogger(
options?: winston.LoggerOptions,
env?: NodeJS.ProcessEnv,
): winston.Logger;
// @public
export function createServiceBuilder(_module: NodeModule): ServiceBuilderImpl;
// @public (undocumented)
export function createStatusCheckRouter(options: StatusCheckRouterOptions): Promise<express.Router>;
export function createStatusCheckRouter(
options: StatusCheckRouterOptions,
): Promise<express.Router>;
// @public (undocumented)
export class DatabaseManager {
forPlugin(pluginId: string): PluginDatabaseManager;
static fromConfig(config: Config): DatabaseManager;
}
forPlugin(pluginId: string): PluginDatabaseManager;
static fromConfig(config: Config): DatabaseManager;
}
// @public (undocumented)
export class DockerContainerRunner implements ContainerRunner {
constructor({ dockerClient }: {
dockerClient: Docker;
});
// (undocumented)
runContainer({ imageName, command, args, logStream, mountDirs, workingDir, envVars, }: RunContainerOptions): Promise<void>;
constructor({ dockerClient }: { dockerClient: Docker });
// (undocumented)
runContainer({
imageName,
command,
args,
logStream,
mountDirs,
workingDir,
envVars,
}: RunContainerOptions): Promise<void>;
}
// @public
export function ensureDatabaseExists(dbConfig: Config, ...databases: Array<string>): Promise<void>;
export function ensureDatabaseExists(
dbConfig: Config,
...databases: Array<string>
): Promise<void>;
// @public
export function errorHandler(options?: ErrorHandlerOptions): ErrorRequestHandler;
export function errorHandler(
options?: ErrorHandlerOptions,
): ErrorRequestHandler;
// @public (undocumented)
export type ErrorHandlerOptions = {
showStackTraces?: boolean;
logger?: Logger_2;
logClientErrors?: boolean;
showStackTraces?: boolean;
logger?: Logger_2;
logClientErrors?: boolean;
};
// @public (undocumented)
@@ -141,128 +171,154 @@ export function getVoidLogger(): winston.Logger;
// @public (undocumented)
export class Git {
// (undocumented)
add({ dir, filepath, }: {
dir: string;
filepath: string;
}): Promise<void>;
// (undocumented)
addRemote({ dir, url, remote, }: {
dir: string;
remote: string;
url: string;
}): Promise<void>;
// (undocumented)
clone({ url, dir, ref, }: {
url: string;
dir: string;
ref?: string;
}): Promise<void>;
// (undocumented)
commit({ dir, message, author, committer, }: {
dir: string;
message: string;
author: {
name: string;
email: string;
};
committer: {
name: string;
email: string;
};
}): Promise<string>;
// (undocumented)
currentBranch({ dir, fullName, }: {
dir: string;
fullName?: boolean;
}): Promise<string | undefined>;
// (undocumented)
fetch({ dir, remote, }: {
dir: string;
remote?: string;
}): Promise<void>;
// (undocumented)
static fromAuth: ({ username, password, logger, }: {
username?: string | undefined;
password?: string | undefined;
logger?: Logger_2 | undefined;
}) => Git;
// (undocumented)
init({ dir, defaultBranch, }: {
dir: string;
defaultBranch?: string;
}): Promise<void>;
// (undocumented)
merge({ dir, theirs, ours, author, committer, }: {
dir: string;
theirs: string;
ours?: string;
author: {
name: string;
email: string;
};
committer: {
name: string;
email: string;
};
}): Promise<MergeResult>;
// (undocumented)
push({ dir, remote }: {
dir: string;
remote: string;
}): Promise<PushResult>;
// (undocumented)
readCommit({ dir, sha, }: {
dir: string;
sha: string;
}): Promise<ReadCommitResult>;
// (undocumented)
resolveRef({ dir, ref, }: {
dir: string;
ref: string;
}): Promise<string>;
// (undocumented)
add({ dir, filepath }: { dir: string; filepath: string }): Promise<void>;
// (undocumented)
addRemote({
dir,
url,
remote,
}: {
dir: string;
remote: string;
url: string;
}): Promise<void>;
// (undocumented)
clone({
url,
dir,
ref,
}: {
url: string;
dir: string;
ref?: string;
}): Promise<void>;
// (undocumented)
commit({
dir,
message,
author,
committer,
}: {
dir: string;
message: string;
author: {
name: string;
email: string;
};
committer: {
name: string;
email: string;
};
}): Promise<string>;
// (undocumented)
currentBranch({
dir,
fullName,
}: {
dir: string;
fullName?: boolean;
}): Promise<string | undefined>;
// (undocumented)
fetch({ dir, remote }: { dir: string; remote?: string }): Promise<void>;
// (undocumented)
static fromAuth: ({
username,
password,
logger,
}: {
username?: string | undefined;
password?: string | undefined;
logger?: Logger_2 | undefined;
}) => Git;
// (undocumented)
init({
dir,
defaultBranch,
}: {
dir: string;
defaultBranch?: string;
}): Promise<void>;
// (undocumented)
merge({
dir,
theirs,
ours,
author,
committer,
}: {
dir: string;
theirs: string;
ours?: string;
author: {
name: string;
email: string;
};
committer: {
name: string;
email: string;
};
}): Promise<MergeResult>;
// (undocumented)
push({ dir, remote }: { dir: string; remote: string }): Promise<PushResult>;
// (undocumented)
readCommit({
dir,
sha,
}: {
dir: string;
sha: string;
}): Promise<ReadCommitResult>;
// (undocumented)
resolveRef({ dir, ref }: { dir: string; ref: string }): Promise<string>;
}
// @public
export class GithubUrlReader implements UrlReader {
constructor(integration: GitHubIntegration, deps: {
treeResponseFactory: ReadTreeResponseFactory;
credentialsProvider: GithubCredentialsProvider;
});
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
constructor(
integration: GitHubIntegration,
deps: {
treeResponseFactory: ReadTreeResponseFactory;
credentialsProvider: GithubCredentialsProvider;
},
);
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
}
// @public (undocumented)
export class GitlabUrlReader implements UrlReader {
constructor(integration: GitLabIntegration, deps: {
treeResponseFactory: ReadTreeResponseFactory;
});
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
constructor(
integration: GitLabIntegration,
deps: {
treeResponseFactory: ReadTreeResponseFactory;
},
);
// (undocumented)
static factory: ReaderFactory;
// (undocumented)
read(url: string): Promise<Buffer>;
// (undocumented)
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
// (undocumented)
readUrl(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
// (undocumented)
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
// (undocumented)
toString(): string;
}
export { isChildPath }
export { isChildPath };
// @public
export function loadBackendConfig(options: Options): Promise<Config>;
@@ -272,32 +328,32 @@ export function notFoundHandler(): RequestHandler;
// @public
export type PluginCacheManager = {
getClient: (options?: ClientOptions) => CacheClient;
getClient: (options?: ClientOptions) => CacheClient;
};
// @public
export interface PluginDatabaseManager {
getClient(): Promise<Knex>;
getClient(): Promise<Knex>;
}
// @public
export type PluginEndpointDiscovery = {
getBaseUrl(pluginId: string): Promise<string>;
getExternalBaseUrl(pluginId: string): Promise<string>;
getBaseUrl(pluginId: string): Promise<string>;
getExternalBaseUrl(pluginId: string): Promise<string>;
};
// @public
export type ReadTreeResponse = {
files(): Promise<ReadTreeResponseFile[]>;
archive(): Promise<NodeJS.ReadableStream>;
dir(options?: ReadTreeResponseDirOptions): Promise<string>;
etag: string;
files(): Promise<ReadTreeResponseFile[]>;
archive(): Promise<NodeJS.ReadableStream>;
dir(options?: ReadTreeResponseDirOptions): Promise<string>;
etag: string;
};
// @public
export type ReadTreeResponseFile = {
path: string;
content(): Promise<Buffer>;
path: string;
content(): Promise<Buffer>;
};
// @public
@@ -311,37 +367,37 @@ export function resolveSafeChildPath(base: string, path: string): string;
// @public (undocumented)
export type RunContainerOptions = {
imageName: string;
command?: string | string[];
args: string[];
logStream?: Writable;
mountDirs?: Record<string, string>;
workingDir?: string;
envVars?: Record<string, string>;
imageName: string;
command?: string | string[];
args: string[];
logStream?: Writable;
mountDirs?: Record<string, string>;
workingDir?: string;
envVars?: Record<string, string>;
};
// @public
export type SearchResponse = {
files: SearchResponseFile[];
etag: string;
files: SearchResponseFile[];
etag: string;
};
// @public
export type SearchResponseFile = {
url: string;
content(): Promise<Buffer>;
url: string;
content(): Promise<Buffer>;
};
// @public (undocumented)
export type ServiceBuilder = {
loadConfig(config: ConfigReader): ServiceBuilder;
setPort(port: number): ServiceBuilder;
setHost(host: string): ServiceBuilder;
setLogger(logger: Logger_2): ServiceBuilder;
enableCors(options: cors.CorsOptions): ServiceBuilder;
setHttpsSettings(settings: HttpsSettings): ServiceBuilder;
addRouter(root: string, router: Router | RequestHandler): ServiceBuilder;
start(): Promise<Server>;
loadConfig(config: ConfigReader): ServiceBuilder;
setPort(port: number): ServiceBuilder;
setHost(host: string): ServiceBuilder;
setLogger(logger: Logger_2): ServiceBuilder;
enableCors(options: cors.CorsOptions): ServiceBuilder;
setHttpsSettings(settings: HttpsSettings): ServiceBuilder;
addRouter(root: string, router: Router | RequestHandler): ServiceBuilder;
start(): Promise<Server>;
};
// @public (undocumented)
@@ -352,47 +408,53 @@ export const SingleConnectionDatabaseManager: typeof DatabaseManager;
// @public
export class SingleHostDiscovery implements PluginEndpointDiscovery {
static fromConfig(config: Config, options?: {
basePath?: string;
}): SingleHostDiscovery;
// (undocumented)
getBaseUrl(pluginId: string): Promise<string>;
// (undocumented)
getExternalBaseUrl(pluginId: string): Promise<string>;
}
static fromConfig(
config: Config,
options?: {
basePath?: string;
},
): SingleHostDiscovery;
// (undocumented)
getBaseUrl(pluginId: string): Promise<string>;
// (undocumented)
getExternalBaseUrl(pluginId: string): Promise<string>;
}
// @public (undocumented)
export type StatusCheck = () => Promise<any>;
// @public
export function statusCheckHandler(options?: StatusCheckHandlerOptions): Promise<RequestHandler>;
export function statusCheckHandler(
options?: StatusCheckHandlerOptions,
): Promise<RequestHandler>;
// @public (undocumented)
export interface StatusCheckHandlerOptions {
statusCheck?: StatusCheck;
statusCheck?: StatusCheck;
}
// @public
export type UrlReader = {
read(url: string): Promise<Buffer>;
readUrl?(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
read(url: string): Promise<Buffer>;
readUrl?(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
search(url: string, options?: SearchOptions): Promise<SearchResponse>;
};
// @public
export class UrlReaders {
static create({ logger, config, factories }: CreateOptions): UrlReader;
static default({ logger, config, factories }: CreateOptions): UrlReader;
static create({ logger, config, factories }: CreateOptions): UrlReader;
static default({ logger, config, factories }: CreateOptions): UrlReader;
}
// @public
export function useHotCleanup(_module: NodeModule, cancelEffect: () => void): void;
export function useHotCleanup(
_module: NodeModule,
cancelEffect: () => void,
): void;
// @public
export function useHotMemoize<T>(_module: NodeModule, valueFactory: () => T): T;
// (No @packageDocumentation comment for this package)
```
packages/backend-common/package.json
+1 -1
View File
@@ -47,7 +47,7 @@
"dockerode": "^3.2.1",
"express": "^4.17.1",
"express-promise-router": "^4.1.0",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"git-url-parse": "~11.4.4",
"helmet": "^4.0.0",
"isomorphic-git": "^1.8.0",
packages/backend-test-utils/api-report.md
+14 -13
View File
@@ -3,29 +3,30 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { Knex } from 'knex';
// @public (undocumented)
export function isDockerDisabledForTests(): boolean;
// @public
export type TestDatabaseId = 'POSTGRES_13' | 'POSTGRES_9' | 'MYSQL_8' | 'SQLITE_3';
export type TestDatabaseId =
| 'POSTGRES_13'
| 'POSTGRES_9'
| 'MYSQL_8'
| 'SQLITE_3';
// @public
export class TestDatabases {
static create(options?: {
ids?: TestDatabaseId[];
disableDocker?: boolean;
}): TestDatabases;
// (undocumented)
eachSupportedId(): [TestDatabaseId][];
init(id: TestDatabaseId): Promise<Knex>;
// (undocumented)
supports(id: TestDatabaseId): boolean;
static create(options?: {
ids?: TestDatabaseId[];
disableDocker?: boolean;
}): TestDatabases;
// (undocumented)
eachSupportedId(): [TestDatabaseId][];
init(id: TestDatabaseId): Promise<Knex>;
// (undocumented)
supports(id: TestDatabaseId): boolean;
}
// (No @packageDocumentation comment for this package)
```
packages/catalog-client/api-report.md
+96 -49
View File
@@ -3,83 +3,130 @@
> 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 { EntityName } from '@backstage/catalog-model';
import { Location as Location_2 } from '@backstage/catalog-model';
// @public (undocumented)
export type AddLocationRequest = {
type?: string;
target: string;
dryRun?: boolean;
presence?: 'optional' | 'required';
type?: string;
target: string;
dryRun?: boolean;
presence?: 'optional' | 'required';
};
// @public (undocumented)
export type AddLocationResponse = {
location: Location_2;
entities: Entity[];
location: Location_2;
entities: Entity[];
};
// @public (undocumented)
export interface CatalogApi {
// (undocumented)
addLocation(location: AddLocationRequest, options?: CatalogRequestOptions): Promise<AddLocationResponse>;
// (undocumented)
getEntities(request?: CatalogEntitiesRequest, options?: CatalogRequestOptions): Promise<CatalogListResponse<Entity>>;
// (undocumented)
getEntityByName(name: EntityName, options?: CatalogRequestOptions): Promise<Entity | undefined>;
// (undocumented)
getLocationByEntity(entity: Entity, options?: CatalogRequestOptions): Promise<Location_2 | undefined>;
// (undocumented)
getLocationById(id: string, options?: CatalogRequestOptions): Promise<Location_2 | undefined>;
// (undocumented)
getOriginLocationByEntity(entity: Entity, options?: CatalogRequestOptions): Promise<Location_2 | undefined>;
// (undocumented)
removeEntityByUid(uid: string, options?: CatalogRequestOptions): Promise<void>;
// (undocumented)
removeLocationById(id: string, options?: CatalogRequestOptions): Promise<void>;
// (undocumented)
addLocation(
location: AddLocationRequest,
options?: CatalogRequestOptions,
): Promise<AddLocationResponse>;
// (undocumented)
getEntities(
request?: CatalogEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
// (undocumented)
getEntityByName(
name: EntityName,
options?: CatalogRequestOptions,
): Promise<Entity | undefined>;
// (undocumented)
getLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
// (undocumented)
getLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
// (undocumented)
getOriginLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
// (undocumented)
removeEntityByUid(
uid: string,
options?: CatalogRequestOptions,
): Promise<void>;
// (undocumented)
removeLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<void>;
}
// @public (undocumented)
export class CatalogClient implements CatalogApi {
constructor(options: {
discoveryApi: DiscoveryApi;
});
// (undocumented)
addLocation({ type, target, dryRun, presence }: AddLocationRequest, options?: CatalogRequestOptions): Promise<AddLocationResponse>;
// (undocumented)
getEntities(request?: CatalogEntitiesRequest, options?: CatalogRequestOptions): Promise<CatalogListResponse<Entity>>;
// (undocumented)
getEntityByName(compoundName: EntityName, options?: CatalogRequestOptions): Promise<Entity | undefined>;
// (undocumented)
getLocationByEntity(entity: Entity, options?: CatalogRequestOptions): Promise<Location_2 | undefined>;
// (undocumented)
getLocationById(id: string, options?: CatalogRequestOptions): Promise<Location_2 | undefined>;
// (undocumented)
getOriginLocationByEntity(entity: Entity, options?: CatalogRequestOptions): Promise<Location_2 | undefined>;
// (undocumented)
removeEntityByUid(uid: string, options?: CatalogRequestOptions): Promise<void>;
// (undocumented)
removeLocationById(id: string, options?: CatalogRequestOptions): Promise<void>;
}
constructor(options: { discoveryApi: DiscoveryApi });
// (undocumented)
addLocation(
{ type, target, dryRun, presence }: AddLocationRequest,
options?: CatalogRequestOptions,
): Promise<AddLocationResponse>;
// (undocumented)
getEntities(
request?: CatalogEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
// (undocumented)
getEntityByName(
compoundName: EntityName,
options?: CatalogRequestOptions,
): Promise<Entity | undefined>;
// (undocumented)
getLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
// (undocumented)
getLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
// (undocumented)
getOriginLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
// (undocumented)
removeEntityByUid(
uid: string,
options?: CatalogRequestOptions,
): Promise<void>;
// (undocumented)
removeLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<void>;
}
// @public (undocumented)
export type CatalogEntitiesRequest = {
filter?: Record<string, string | string[]>[] | Record<string, string | string[]> | undefined;
fields?: string[] | undefined;
filter?:
| Record<string, string | string[]>[]
| Record<string, string | string[]>
| undefined;
fields?: string[] | undefined;
};
// @public (undocumented)
export type CatalogListResponse<T> = {
items: T[];
items: T[];
};
// @public
export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE = "backstage.io/catalog-processing";
export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE =
'backstage.io/catalog-processing';
// (No @packageDocumentation comment for this package)
```
packages/catalog-model/api-report.md
+342 -312
View File
@@ -3,7 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { JsonObject } from '@backstage/config';
import { JSONSchema7 } from 'json-schema';
import { JsonValue } from '@backstage/config';
@@ -11,204 +10,222 @@ import { SerializedError } from '@backstage/errors';
import * as yup from 'yup';
// @public @deprecated (undocumented)
export const analyzeLocationSchema: yup.ObjectSchema<{
export const analyzeLocationSchema: yup.ObjectSchema<
{
location: LocationSpec;
}, object>;
},
object
>;
// @public (undocumented)
interface ApiEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'API';
// (undocumented)
spec: {
type: string;
lifecycle: string;
owner: string;
definition: string;
system?: string;
};
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'API';
// (undocumented)
spec: {
type: string;
lifecycle: string;
owner: string;
definition: string;
system?: string;
};
}
export { ApiEntityV1alpha1 as ApiEntity }
export { ApiEntityV1alpha1 }
export { ApiEntityV1alpha1 as ApiEntity };
export { ApiEntityV1alpha1 };
// @public (undocumented)
export const apiEntityV1alpha1Validator: KindValidator;
// @public
export class CommonValidatorFunctions {
static isJsonSafe(value: unknown): boolean;
static isValidDnsLabel(value: unknown): boolean;
static isValidDnsSubdomain(value: unknown): boolean;
static isValidPrefixAndOrSuffix(value: unknown, separator: string, isValidPrefix: (value: string) => boolean, isValidSuffix: (value: string) => boolean): boolean;
static isValidString(value: unknown): boolean;
static isValidUrl(value: unknown): boolean;
static isJsonSafe(value: unknown): boolean;
static isValidDnsLabel(value: unknown): boolean;
static isValidDnsSubdomain(value: unknown): boolean;
static isValidPrefixAndOrSuffix(
value: unknown,
separator: string,
isValidPrefix: (value: string) => boolean,
isValidSuffix: (value: string) => boolean,
): boolean;
static isValidString(value: unknown): boolean;
static isValidUrl(value: unknown): boolean;
}
// @public
export function compareEntityToRef(entity: Entity, ref: EntityRef | EntityName, context?: EntityRefContext): boolean;
export function compareEntityToRef(
entity: Entity,
ref: EntityRef | EntityName,
context?: EntityRefContext,
): boolean;
// @public (undocumented)
interface ComponentEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Component';
// (undocumented)
spec: {
type: string;
lifecycle: string;
owner: string;
subcomponentOf?: string;
providesApis?: string[];
consumesApis?: string[];
dependsOn?: string[];
system?: string;
};
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Component';
// (undocumented)
spec: {
type: string;
lifecycle: string;
owner: string;
subcomponentOf?: string;
providesApis?: string[];
consumesApis?: string[];
dependsOn?: string[];
system?: string;
};
}
export { ComponentEntityV1alpha1 as ComponentEntity }
export { ComponentEntityV1alpha1 }
export { ComponentEntityV1alpha1 as ComponentEntity };
export { ComponentEntityV1alpha1 };
// @public (undocumented)
export const componentEntityV1alpha1Validator: KindValidator;
// @public
export class DefaultNamespaceEntityPolicy implements EntityPolicy {
constructor(namespace?: string);
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
constructor(namespace?: string);
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
// @public (undocumented)
interface DomainEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Domain';
// (undocumented)
spec: {
owner: string;
};
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Domain';
// (undocumented)
spec: {
owner: string;
};
}
export { DomainEntityV1alpha1 as DomainEntity }
export { DomainEntityV1alpha1 }
export { DomainEntityV1alpha1 as DomainEntity };
export { DomainEntityV1alpha1 };
// @public (undocumented)
export const domainEntityV1alpha1Validator: KindValidator;
// @public (undocumented)
export const EDIT_URL_ANNOTATION = "backstage.io/edit-url";
export const EDIT_URL_ANNOTATION = 'backstage.io/edit-url';
// @public
export type Entity = {
apiVersion: string;
kind: string;
metadata: EntityMeta;
spec?: JsonObject;
relations?: EntityRelation[];
status?: UNSTABLE_EntityStatus;
apiVersion: string;
kind: string;
metadata: EntityMeta;
spec?: JsonObject;
relations?: EntityRelation[];
status?: UNSTABLE_EntityStatus;
};
// @public
export const ENTITY_DEFAULT_NAMESPACE = "default";
export const ENTITY_DEFAULT_NAMESPACE = 'default';
// @public
export const ENTITY_META_GENERATED_FIELDS: readonly ["uid", "etag", "generation"];
export const ENTITY_META_GENERATED_FIELDS: readonly [
'uid',
'etag',
'generation',
];
// @public
export type EntityEnvelope = {
apiVersion: string;
kind: string;
metadata: {
name: string;
namespace?: string;
};
apiVersion: string;
kind: string;
metadata: {
name: string;
namespace?: string;
};
};
// @public
export function entityEnvelopeSchemaValidator<T extends EntityEnvelope = EntityEnvelope>(schema?: unknown): (data: unknown) => T;
export function entityEnvelopeSchemaValidator<
T extends EntityEnvelope = EntityEnvelope
>(schema?: unknown): (data: unknown) => T;
// @public
export function entityHasChanges(previous: Entity, next: Entity): boolean;
// @public
export function entityKindSchemaValidator<T extends Entity>(schema: unknown): (data: unknown) => T | false;
export function entityKindSchemaValidator<T extends Entity>(
schema: unknown,
): (data: unknown) => T | false;
// @public
export type EntityLink = {
url: string;
title?: string;
icon?: string;
url: string;
title?: string;
icon?: string;
};
// @public
export type EntityMeta = JsonObject & {
uid?: string;
etag?: string;
generation?: number;
name: string;
namespace?: string;
description?: string;
labels?: Record<string, string>;
annotations?: Record<string, string>;
tags?: string[];
links?: EntityLink[];
uid?: string;
etag?: string;
generation?: number;
name: string;
namespace?: string;
description?: string;
labels?: Record<string, string>;
annotations?: Record<string, string>;
tags?: string[];
links?: EntityLink[];
};
// @public
export type EntityName = {
kind: string;
namespace: string;
name: string;
kind: string;
namespace: string;
name: string;
};
// @public (undocumented)
export const EntityPolicies: {
allOf(policies: EntityPolicy[]): AllEntityPolicies;
oneOf(policies: EntityPolicy[]): AnyEntityPolicy;
allOf(policies: EntityPolicy[]): AllEntityPolicies;
oneOf(policies: EntityPolicy[]): AnyEntityPolicy;
};
// @public
export type EntityPolicy = {
enforce(entity: Entity): Promise<Entity | undefined>;
enforce(entity: Entity): Promise<Entity | undefined>;
};
// @public
export type EntityRef = string | {
kind?: string;
namespace?: string;
name: string;
};
export type EntityRef =
| string
| {
kind?: string;
namespace?: string;
name: string;
};
// @public
export type EntityRelation = {
type: string;
target: EntityName;
type: string;
target: EntityName;
};
// @public
export type EntityRelationSpec = {
source: EntityName;
type: string;
target: EntityName;
source: EntityName;
type: string;
target: EntityName;
};
// @public
export function entitySchemaValidator<T extends Entity = Entity>(schema?: unknown): (data: unknown) => T;
export function entitySchemaValidator<T extends Entity = Entity>(
schema?: unknown,
): (data: unknown) => T;
// @public
export class FieldFormatEntityPolicy implements EntityPolicy {
constructor(validators?: Validators);
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
constructor(validators?: Validators);
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
// @public
export function generateEntityEtag(): string;
@@ -223,95 +240,93 @@ export function generateUpdatedEntity(previous: Entity, next: Entity): Entity;
export function getEntityName(entity: Entity): EntityName;
// @public
export function getEntitySourceLocation(entity: Entity): {
type: string;
target: string;
export function getEntitySourceLocation(
entity: Entity,
): {
type: string;
target: string;
};
// @public (undocumented)
interface GroupEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Group';
// (undocumented)
spec: {
type: string;
profile?: {
displayName?: string;
email?: string;
picture?: string;
};
parent?: string;
children: string[];
members?: string[];
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Group';
// (undocumented)
spec: {
type: string;
profile?: {
displayName?: string;
email?: string;
picture?: string;
};
parent?: string;
children: string[];
members?: string[];
};
}
export { GroupEntityV1alpha1 as GroupEntity }
export { GroupEntityV1alpha1 }
export { GroupEntityV1alpha1 as GroupEntity };
export { GroupEntityV1alpha1 };
// @public (undocumented)
export const groupEntityV1alpha1Validator: KindValidator;
// @public (undocumented)
export type JSONSchema = JSONSchema7 & {
export type JSONSchema = JSONSchema7 &
{
[key in string]?: JsonValue;
};
};
// @public
export type KindValidator = {
check(entity: Entity): Promise<boolean>;
check(entity: Entity): Promise<boolean>;
};
// @public
export class KubernetesValidatorFunctions {
// (undocumented)
static isValidAnnotationKey(value: unknown): boolean;
// (undocumented)
static isValidAnnotationValue(value: unknown): boolean;
// (undocumented)
static isValidApiVersion(value: unknown): boolean;
// (undocumented)
static isValidKind(value: unknown): boolean;
// (undocumented)
static isValidLabelKey(value: unknown): boolean;
// (undocumented)
static isValidLabelValue(value: unknown): boolean;
// (undocumented)
static isValidNamespace(value: unknown): boolean;
// (undocumented)
static isValidObjectName(value: unknown): boolean;
// (undocumented)
static isValidAnnotationKey(value: unknown): boolean;
// (undocumented)
static isValidAnnotationValue(value: unknown): boolean;
// (undocumented)
static isValidApiVersion(value: unknown): boolean;
// (undocumented)
static isValidKind(value: unknown): boolean;
// (undocumented)
static isValidLabelKey(value: unknown): boolean;
// (undocumented)
static isValidLabelValue(value: unknown): boolean;
// (undocumented)
static isValidNamespace(value: unknown): boolean;
// (undocumented)
static isValidObjectName(value: unknown): boolean;
}
// @public (undocumented)
type Location_2 = {
id: string;
id: string;
} & LocationSpec;
export { Location_2 as Location }
export { Location_2 as Location };
// @public (undocumented)
export const LOCATION_ANNOTATION = "backstage.io/managed-by-location";
export const LOCATION_ANNOTATION = 'backstage.io/managed-by-location';
// @public (undocumented)
interface LocationEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Location';
// (undocumented)
spec: {
type?: string;
target?: string;
targets?: string[];
};
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Location';
// (undocumented)
spec: {
type?: string;
target?: string;
targets?: string[];
};
}
export { LocationEntityV1alpha1 as LocationEntity }
export { LocationEntityV1alpha1 }
export { LocationEntityV1alpha1 as LocationEntity };
export { LocationEntityV1alpha1 };
// @public (undocumented)
export const locationEntityV1alpha1Validator: KindValidator;
@@ -321,9 +336,9 @@ export const locationSchema: yup.ObjectSchema<Location_2, object>;
// @public (undocumented)
export type LocationSpec = {
type: string;
target: string;
presence?: 'optional' | 'required';
type: string;
target: string;
presence?: 'optional' | 'required';
};
// @public @deprecated (undocumented)
@@ -334,190 +349,209 @@ export function makeValidator(overrides?: Partial<Validators>): Validators;
// @public
export class NoForeignRootFieldsEntityPolicy implements EntityPolicy {
constructor(knownFields?: string[]);
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
constructor(knownFields?: string[]);
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
// @public (undocumented)
export const ORIGIN_LOCATION_ANNOTATION = "backstage.io/managed-by-origin-location";
export const ORIGIN_LOCATION_ANNOTATION =
'backstage.io/managed-by-origin-location';
// @public
export function parseEntityName(ref: EntityRef, context?: EntityRefContext): EntityName;
export function parseEntityName(
ref: EntityRef,
context?: EntityRefContext,
): EntityName;
// @public
export function parseEntityRef(ref: EntityRef, context?: {
export function parseEntityRef(
ref: EntityRef,
context?: {
defaultKind: string;
defaultNamespace: string;
}): {
kind: string;
namespace: string;
name: string;
},
): {
kind: string;
namespace: string;
name: string;
};
// @public (undocumented)
export function parseEntityRef(ref: EntityRef, context?: {
export function parseEntityRef(
ref: EntityRef,
context?: {
defaultKind: string;
}): {
kind: string;
namespace?: string;
name: string;
},
): {
kind: string;
namespace?: string;
name: string;
};
// @public (undocumented)
export function parseEntityRef(ref: EntityRef, context?: {
export function parseEntityRef(
ref: EntityRef,
context?: {
defaultNamespace: string;
}): {
kind?: string;
namespace: string;
name: string;
},
): {
kind?: string;
namespace: string;
name: string;
};
// @public
export function parseLocationReference(ref: string): {
type: string;
target: string;
export function parseLocationReference(
ref: string,
): {
type: string;
target: string;
};
// @public (undocumented)
export const RELATION_API_CONSUMED_BY = "apiConsumedBy";
export const RELATION_API_CONSUMED_BY = 'apiConsumedBy';
// @public (undocumented)
export const RELATION_API_PROVIDED_BY = "apiProvidedBy";
export const RELATION_API_PROVIDED_BY = 'apiProvidedBy';
// @public (undocumented)
export const RELATION_CHILD_OF = "childOf";
export const RELATION_CHILD_OF = 'childOf';
// @public
export const RELATION_CONSUMES_API = "consumesApi";
export const RELATION_CONSUMES_API = 'consumesApi';
// @public (undocumented)
export const RELATION_DEPENDENCY_OF = "dependencyOf";
export const RELATION_DEPENDENCY_OF = 'dependencyOf';
// @public
export const RELATION_DEPENDS_ON = "dependsOn";
export const RELATION_DEPENDS_ON = 'dependsOn';
// @public (undocumented)
export const RELATION_HAS_MEMBER = "hasMember";
export const RELATION_HAS_MEMBER = 'hasMember';
// @public (undocumented)
export const RELATION_HAS_PART = "hasPart";
export const RELATION_HAS_PART = 'hasPart';
// @public
export const RELATION_MEMBER_OF = "memberOf";
export const RELATION_MEMBER_OF = 'memberOf';
// @public
export const RELATION_OWNED_BY = "ownedBy";
export const RELATION_OWNED_BY = 'ownedBy';
// @public (undocumented)
export const RELATION_OWNER_OF = "ownerOf";
export const RELATION_OWNER_OF = 'ownerOf';
// @public
export const RELATION_PARENT_OF = "parentOf";
export const RELATION_PARENT_OF = 'parentOf';
// @public
export const RELATION_PART_OF = "partOf";
export const RELATION_PART_OF = 'partOf';
// @public (undocumented)
export const RELATION_PROVIDES_API = "providesApi";
export const RELATION_PROVIDES_API = 'providesApi';
// @public (undocumented)
interface ResourceEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Resource';
// (undocumented)
spec: {
type: string;
owner: string;
dependsOn?: string[];
system?: string;
};
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'Resource';
// (undocumented)
spec: {
type: string;
owner: string;
dependsOn?: string[];
system?: string;
};
}
export { ResourceEntityV1alpha1 as ResourceEntity }
export { ResourceEntityV1alpha1 }
export { ResourceEntityV1alpha1 as ResourceEntity };
export { ResourceEntityV1alpha1 };
// @public (undocumented)
export const resourceEntityV1alpha1Validator: KindValidator;
// @public
export class SchemaValidEntityPolicy implements EntityPolicy {
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
// (undocumented)
enforce(entity: Entity): Promise<Entity>;
}
// @public @deprecated
export function serializeEntityRef(ref: Entity | {
kind?: string;
namespace?: string;
name: string;
}): EntityRef;
export function serializeEntityRef(
ref:
| Entity
| {
kind?: string;
namespace?: string;
name: string;
},
): EntityRef;
// @public (undocumented)
export const SOURCE_LOCATION_ANNOTATION = "backstage.io/source-location";
export const SOURCE_LOCATION_ANNOTATION = 'backstage.io/source-location';
// @public
export function stringifyEntityRef(ref: Entity | {
kind: string;
namespace?: string;
name: string;
}): string;
export function stringifyEntityRef(
ref:
| Entity
| {
kind: string;
namespace?: string;
name: string;
},
): string;
// @public
export function stringifyLocationReference(ref: {
type: string;
target: string;
type: string;
target: string;
}): string;
// @public (undocumented)
interface SystemEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'System';
// (undocumented)
spec: {
owner: string;
domain?: string;
};
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'System';
// (undocumented)
spec: {
owner: string;
domain?: string;
};
}
export { SystemEntityV1alpha1 as SystemEntity }
export { SystemEntityV1alpha1 }
export { SystemEntityV1alpha1 as SystemEntity };
export { SystemEntityV1alpha1 };
// @public (undocumented)
export const systemEntityV1alpha1Validator: KindValidator;
// @public (undocumented)
export interface TemplateEntityV1beta2 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1beta2';
// (undocumented)
kind: 'Template';
// (undocumented)
metadata: EntityMeta & {
title?: string;
};
// (undocumented)
spec: {
type: string;
parameters?: JsonObject | JsonObject[];
steps: Array<{
id?: string;
name?: string;
action: string;
input?: JsonObject;
if?: string | boolean;
}>;
output?: {
[name: string]: string;
};
owner?: string;
// (undocumented)
apiVersion: 'backstage.io/v1beta2';
// (undocumented)
kind: 'Template';
// (undocumented)
metadata: EntityMeta & {
title?: string;
};
// (undocumented)
spec: {
type: string;
parameters?: JsonObject | JsonObject[];
steps: Array<{
id?: string;
name?: string;
action: string;
input?: JsonObject;
if?: string | boolean;
}>;
output?: {
[name: string]: string;
};
owner?: string;
};
}
// @public (undocumented)
@@ -525,15 +559,15 @@ export const templateEntityV1beta2Validator: KindValidator;
// @alpha
export type UNSTABLE_EntityStatus = {
items?: UNSTABLE_EntityStatusItem[];
items?: UNSTABLE_EntityStatusItem[];
};
// @alpha
export type UNSTABLE_EntityStatusItem = {
type: string;
level: UNSTABLE_EntityStatusLevel;
message: string;
error?: SerializedError;
type: string;
level: UNSTABLE_EntityStatusLevel;
message: string;
error?: SerializedError;
};
// @alpha
@@ -541,45 +575,41 @@ export type UNSTABLE_EntityStatusLevel = 'info' | 'warning' | 'error';
// @public (undocumented)
interface UserEntityV1alpha1 extends Entity {
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'User';
// (undocumented)
spec: {
profile?: {
displayName?: string;
email?: string;
picture?: string;
};
memberOf: string[];
// (undocumented)
apiVersion: 'backstage.io/v1alpha1' | 'backstage.io/v1beta1';
// (undocumented)
kind: 'User';
// (undocumented)
spec: {
profile?: {
displayName?: string;
email?: string;
picture?: string;
};
memberOf: string[];
};
}
export { UserEntityV1alpha1 as UserEntity }
export { UserEntityV1alpha1 }
export { UserEntityV1alpha1 as UserEntity };
export { UserEntityV1alpha1 };
// @public (undocumented)
export const userEntityV1alpha1Validator: KindValidator;
// @public (undocumented)
export type Validators = {
isValidApiVersion(value: unknown): boolean;
isValidKind(value: unknown): boolean;
isValidEntityName(value: unknown): boolean;
isValidNamespace(value: unknown): boolean;
isValidLabelKey(value: unknown): boolean;
isValidLabelValue(value: unknown): boolean;
isValidAnnotationKey(value: unknown): boolean;
isValidAnnotationValue(value: unknown): boolean;
isValidTag(value: unknown): boolean;
isValidApiVersion(value: unknown): boolean;
isValidKind(value: unknown): boolean;
isValidEntityName(value: unknown): boolean;
isValidNamespace(value: unknown): boolean;
isValidLabelKey(value: unknown): boolean;
isValidLabelValue(value: unknown): boolean;
isValidAnnotationKey(value: unknown): boolean;
isValidAnnotationValue(value: unknown): boolean;
isValidTag(value: unknown): boolean;
};
// @public
export const VIEW_URL_ANNOTATION = "backstage.io/view-url";
export const VIEW_URL_ANNOTATION = 'backstage.io/view-url';
// (No @packageDocumentation comment for this package)
```
packages/cli/package.json
+1 -1
View File
@@ -77,7 +77,7 @@
"express": "^4.17.1",
"file-loader": "^6.2.0",
"fork-ts-checker-webpack-plugin": "^6.2.9",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"handlebars": "^4.7.3",
"html-webpack-plugin": "^4.3.0",
"inquirer": "^7.0.4",
packages/config-loader/api-report.md
+10 -10
View File
@@ -3,15 +3,17 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AppConfig } from '@backstage/config';
import { JsonObject } from '@backstage/config';
import { JSONSchema7 } from 'json-schema';
// @public
export type ConfigSchema = {
process(appConfigs: AppConfig[], options?: ConfigProcessingOptions): AppConfig[];
serialize(): JsonObject;
process(
appConfigs: AppConfig[],
options?: ConfigProcessingOptions,
): AppConfig[];
serialize(): JsonObject;
};
// @public
@@ -22,10 +24,10 @@ export function loadConfig(options: LoadConfigOptions): Promise<AppConfig[]>;
// @public (undocumented)
export type LoadConfigOptions = {
configRoot: string;
configPaths: string[];
env?: string;
experimentalEnvFunc?: EnvFunc;
configRoot: string;
configPaths: string[];
env?: string;
experimentalEnvFunc?: EnvFunc;
};
// @public
@@ -36,10 +38,8 @@ export function mergeConfigSchemas(schemas: JSONSchema7[]): JSONSchema7;
// @public
export function readEnvConfig(env: {
[name: string]: string | undefined;
[name: string]: string | undefined;
}): AppConfig[];
// (No @packageDocumentation comment for this package)
```
packages/config-loader/package.json
+1 -1
View File
@@ -34,7 +34,7 @@
"@backstage/config": "^0.1.5",
"@types/json-schema": "^7.0.6",
"ajv": "^7.0.3",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"json-schema": "^0.3.0",
"json-schema-merge-allof": "^0.8.1",
"typescript-json-schema": "^0.50.1",
packages/config/api-report.md
+62 -61
View File
@@ -3,79 +3,82 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @public (undocumented)
export type AppConfig = {
context: string;
data: JsonObject;
context: string;
data: JsonObject;
};
// @public (undocumented)
export type Config = {
has(key: string): boolean;
keys(): string[];
get<T = JsonValue>(key?: string): T;
getOptional<T = JsonValue>(key?: string): T | undefined;
getConfig(key: string): Config;
getOptionalConfig(key: string): Config | undefined;
getConfigArray(key: string): Config[];
getOptionalConfigArray(key: string): Config[] | undefined;
getNumber(key: string): number;
getOptionalNumber(key: string): number | undefined;
getBoolean(key: string): boolean;
getOptionalBoolean(key: string): boolean | undefined;
getString(key: string): string;
getOptionalString(key: string): string | undefined;
getStringArray(key: string): string[];
getOptionalStringArray(key: string): string[] | undefined;
has(key: string): boolean;
keys(): string[];
get<T = JsonValue>(key?: string): T;
getOptional<T = JsonValue>(key?: string): T | undefined;
getConfig(key: string): Config;
getOptionalConfig(key: string): Config | undefined;
getConfigArray(key: string): Config[];
getOptionalConfigArray(key: string): Config[] | undefined;
getNumber(key: string): number;
getOptionalNumber(key: string): number | undefined;
getBoolean(key: string): boolean;
getOptionalBoolean(key: string): boolean | undefined;
getString(key: string): string;
getOptionalString(key: string): string | undefined;
getStringArray(key: string): string[];
getOptionalStringArray(key: string): string[] | undefined;
};
// @public (undocumented)
export class ConfigReader implements Config {
constructor(data: JsonObject | undefined, context?: string, fallback?: ConfigReader | undefined, prefix?: string);
// (undocumented)
static fromConfigs(configs: AppConfig[]): ConfigReader;
// (undocumented)
get<T = JsonValue>(key?: string): T;
// (undocumented)
getBoolean(key: string): boolean;
// (undocumented)
getConfig(key: string): ConfigReader;
// (undocumented)
getConfigArray(key: string): ConfigReader[];
// (undocumented)
getNumber(key: string): number;
// (undocumented)
getOptional<T = JsonValue>(key?: string): T | undefined;
// (undocumented)
getOptionalBoolean(key: string): boolean | undefined;
// (undocumented)
getOptionalConfig(key: string): ConfigReader | undefined;
// (undocumented)
getOptionalConfigArray(key: string): ConfigReader[] | undefined;
// (undocumented)
getOptionalNumber(key: string): number | undefined;
// (undocumented)
getOptionalString(key: string): string | undefined;
// (undocumented)
getOptionalStringArray(key: string): string[] | undefined;
// (undocumented)
getString(key: string): string;
// (undocumented)
getStringArray(key: string): string[];
// (undocumented)
has(key: string): boolean;
// (undocumented)
keys(): string[];
}
// @public (undocumented)
export interface JsonArray extends Array<JsonValue> {
constructor(
data: JsonObject | undefined,
context?: string,
fallback?: ConfigReader | undefined,
prefix?: string,
);
// (undocumented)
static fromConfigs(configs: AppConfig[]): ConfigReader;
// (undocumented)
get<T = JsonValue>(key?: string): T;
// (undocumented)
getBoolean(key: string): boolean;
// (undocumented)
getConfig(key: string): ConfigReader;
// (undocumented)
getConfigArray(key: string): ConfigReader[];
// (undocumented)
getNumber(key: string): number;
// (undocumented)
getOptional<T = JsonValue>(key?: string): T | undefined;
// (undocumented)
getOptionalBoolean(key: string): boolean | undefined;
// (undocumented)
getOptionalConfig(key: string): ConfigReader | undefined;
// (undocumented)
getOptionalConfigArray(key: string): ConfigReader[] | undefined;
// (undocumented)
getOptionalNumber(key: string): number | undefined;
// (undocumented)
getOptionalString(key: string): string | undefined;
// (undocumented)
getOptionalStringArray(key: string): string[] | undefined;
// (undocumented)
getString(key: string): string;
// (undocumented)
getStringArray(key: string): string[];
// (undocumented)
has(key: string): boolean;
// (undocumented)
keys(): string[];
}
// @public (undocumented)
export interface JsonArray extends Array<JsonValue> {}
// @public (undocumented)
export type JsonObject = {
[key in string]?: JsonValue;
[key in string]?: JsonValue;
};
// @public (undocumented)
@@ -84,7 +87,5 @@ export type JsonPrimitive = number | string | boolean | null;
// @public (undocumented)
export type JsonValue = JsonObject | JsonArray | JsonPrimitive;
// (No @packageDocumentation comment for this package)
```
packages/core-app-api/api-report.md
+327 -224
View File
@@ -3,7 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AlertApi } from '@backstage/core-plugin-api';
import { AlertMessage } from '@backstage/core-plugin-api';
import { AnyApiFactory } from '@backstage/core-plugin-api';
@@ -57,72 +56,97 @@ import { SubRouteRef } from '@backstage/core-plugin-api';
// @public
export class AlertApiForwarder implements AlertApi {
// (undocumented)
alert$(): Observable<AlertMessage>;
// (undocumented)
post(alert: AlertMessage): void;
}
// (undocumented)
alert$(): Observable<AlertMessage>;
// (undocumented)
post(alert: AlertMessage): void;
}
// @public (undocumented)
export type ApiFactoryHolder = {
get<T>(api: ApiRef<T>): ApiFactory<T, T, {
[key in string]: unknown;
}> | undefined;
get<T>(
api: ApiRef<T>,
):
| ApiFactory<
T,
T,
{
[key in string]: unknown;
}
>
| undefined;
};
// @public
export class ApiFactoryRegistry implements ApiFactoryHolder {
// (undocumented)
get<T>(api: ApiRef<T>): ApiFactory<T, T, {
[x: string]: unknown;
}> | undefined;
// (undocumented)
getAllApis(): Set<AnyApiRef>;
register<Api, Impl extends Api, Deps extends {
[name in string]: unknown;
}>(scope: ApiFactoryScope, factory: ApiFactory<Api, Impl, Deps>): boolean;
// (undocumented)
get<T>(
api: ApiRef<T>,
):
| ApiFactory<
T,
T,
{
[x: string]: unknown;
}
>
| undefined;
// (undocumented)
getAllApis(): Set<AnyApiRef>;
register<
Api,
Impl extends Api,
Deps extends {
[name in string]: unknown;
}
>(scope: ApiFactoryScope, factory: ApiFactory<Api, Impl, Deps>): boolean;
}
// @public (undocumented)
export const ApiProvider: {
({ apis, children, }: PropsWithChildren<ApiProviderProps>): JSX.Element;
propTypes: {
apis: PropTypes.Validator<PropTypes.InferProps<{
get: PropTypes.Validator<(...args: any[]) => any>;
}>>;
children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
};
({ apis, children }: PropsWithChildren<ApiProviderProps>): JSX.Element;
propTypes: {
apis: PropTypes.Validator<
PropTypes.InferProps<{
get: PropTypes.Validator<(...args: any[]) => any>;
}>
>;
children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
};
};
// @public (undocumented)
export class ApiRegistry implements ApiHolder {
constructor(apis: Map<string, unknown>);
// (undocumented)
static builder(): ApiRegistryBuilder;
// (undocumented)
static from(apis: ApiImpl[]): ApiRegistry;
// (undocumented)
get<T>(api: ApiRef<T>): T | undefined;
static with<T>(api: ApiRef<T>, impl: T): ApiRegistry;
with<T>(api: ApiRef<T>, impl: T): ApiRegistry;
constructor(apis: Map<string, unknown>);
// (undocumented)
static builder(): ApiRegistryBuilder;
// (undocumented)
static from(apis: ApiImpl[]): ApiRegistry;
// (undocumented)
get<T>(api: ApiRef<T>): T | undefined;
static with<T>(api: ApiRef<T>, impl: T): ApiRegistry;
with<T>(api: ApiRef<T>, impl: T): ApiRegistry;
}
// @public (undocumented)
export class ApiResolver implements ApiHolder {
constructor(factories: ApiFactoryHolder);
// (undocumented)
get<T>(ref: ApiRef<T>): T | undefined;
static validateFactories(factories: ApiFactoryHolder, apis: Iterable<AnyApiRef>): void;
constructor(factories: ApiFactoryHolder);
// (undocumented)
get<T>(ref: ApiRef<T>): T | undefined;
static validateFactories(
factories: ApiFactoryHolder,
apis: Iterable<AnyApiRef>,
): void;
}
// @public (undocumented)
export type AppComponents = {
NotFoundErrorPage: ComponentType<{}>;
BootErrorPage: ComponentType<BootErrorPageProps>;
Progress: ComponentType<{}>;
Router: ComponentType<{}>;
ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
SignInPage?: ComponentType<SignInPageProps>;
NotFoundErrorPage: ComponentType<{}>;
BootErrorPage: ComponentType<BootErrorPageProps>;
Progress: ComponentType<{}>;
Router: ComponentType<{}>;
ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
SignInPage?: ComponentType<SignInPageProps>;
};
// @public
@@ -130,72 +154,88 @@ export type AppConfigLoader = () => Promise<AppConfig[]>;
// @public (undocumented)
export type AppContext = {
getPlugins(): BackstagePlugin<any, any>[];
getSystemIcon(key: string): IconComponent | undefined;
getComponents(): AppComponents;
getPlugins(): BackstagePlugin<any, any>[];
getSystemIcon(key: string): IconComponent | undefined;
getComponents(): AppComponents;
};
// @public (undocumented)
export type AppOptions = {
apis?: Iterable<AnyApiFactory>;
icons?: Partial<AppIcons> & {
[key in string]: IconComponent;
apis?: Iterable<AnyApiFactory>;
icons?: Partial<AppIcons> &
{
[key in string]: IconComponent;
};
plugins?: BackstagePluginWithAnyOutput[];
components?: Partial<AppComponents>;
themes?: AppTheme[];
configLoader?: AppConfigLoader;
bindRoutes?(context: {
bind: AppRouteBinder;
}): void;
plugins?: BackstagePluginWithAnyOutput[];
components?: Partial<AppComponents>;
themes?: AppTheme[];
configLoader?: AppConfigLoader;
bindRoutes?(context: { bind: AppRouteBinder }): void;
};
// @public (undocumented)
export type AppRouteBinder = <ExternalRoutes extends {
export type AppRouteBinder = <
ExternalRoutes extends {
[name: string]: ExternalRouteRef;
}>(externalRoutes: ExternalRoutes, targetRoutes: PartialKeys<TargetRouteMap<ExternalRoutes>, KeysWithType<ExternalRoutes, ExternalRouteRef<any, true>>>) => void;
}
>(
externalRoutes: ExternalRoutes,
targetRoutes: PartialKeys<
TargetRouteMap<ExternalRoutes>,
KeysWithType<ExternalRoutes, ExternalRouteRef<any, true>>
>,
) => void;
// @public (undocumented)
export class AppThemeSelector implements AppThemeApi {
constructor(themes: AppTheme[]);
// (undocumented)
activeThemeId$(): Observable<string | undefined>;
// (undocumented)
static createWithStorage(themes: AppTheme[]): AppThemeSelector;
// (undocumented)
getActiveThemeId(): string | undefined;
// (undocumented)
getInstalledThemes(): AppTheme[];
// (undocumented)
setActiveThemeId(themeId?: string): void;
}
constructor(themes: AppTheme[]);
// (undocumented)
activeThemeId$(): Observable<string | undefined>;
// (undocumented)
static createWithStorage(themes: AppTheme[]): AppThemeSelector;
// (undocumented)
getActiveThemeId(): string | undefined;
// (undocumented)
getInstalledThemes(): AppTheme[];
// (undocumented)
setActiveThemeId(themeId?: string): void;
}
// @public (undocumented)
export class Auth0Auth {
// (undocumented)
static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): typeof auth0AuthApiRef.T;
// (undocumented)
static create({
discoveryApi,
environment,
provider,
oauthRequestApi,
defaultScopes,
}: OAuthApiCreateOptions): typeof auth0AuthApiRef.T;
}
// @public (undocumented)
export type BackstageApp = {
getPlugins(): BackstagePlugin<any, any>[];
getSystemIcon(key: string): IconComponent | undefined;
getProvider(): ComponentType<{}>;
getRouter(): ComponentType<{}>;
getPlugins(): BackstagePlugin<any, any>[];
getSystemIcon(key: string): IconComponent | undefined;
getProvider(): ComponentType<{}>;
getRouter(): ComponentType<{}>;
};
// @public (undocumented)
export type BackstagePluginWithAnyOutput = Omit<BackstagePlugin<any, any>, 'output'> & {
output(): (PluginOutput | UnknownPluginOutput)[];
export type BackstagePluginWithAnyOutput = Omit<
BackstagePlugin<any, any>,
'output'
> & {
output(): (PluginOutput | UnknownPluginOutput)[];
};
// @public (undocumented)
export type BootErrorPageProps = {
step: 'load-config' | 'load-chunk';
error: Error;
step: 'load-config' | 'load-chunk';
error: Error;
};
export { ConfigReader }
export { ConfigReader };
// @public
export function createApp(options?: AppOptions): PrivateAppImpl;
@@ -205,36 +245,36 @@ export const defaultConfigLoader: AppConfigLoader;
// @public
export class ErrorAlerter implements ErrorApi {
constructor(alertApi: AlertApi, errorApi: ErrorApi);
// (undocumented)
error$(): Observable<{
error: {
name: string;
message: string;
stack?: string | undefined;
};
context?: ErrorContext | undefined;
}>;
// (undocumented)
post(error: Error, context?: ErrorContext): void;
constructor(alertApi: AlertApi, errorApi: ErrorApi);
// (undocumented)
error$(): Observable<{
error: {
name: string;
message: string;
stack?: string | undefined;
};
context?: ErrorContext | undefined;
}>;
// (undocumented)
post(error: Error, context?: ErrorContext): void;
}
// @public
export class ErrorApiForwarder implements ErrorApi {
// (undocumented)
error$(): Observable<{
error: Error;
context?: ErrorContext;
}>;
// (undocumented)
post(error: Error, context?: ErrorContext): void;
}
// (undocumented)
error$(): Observable<{
error: Error;
context?: ErrorContext;
}>;
// (undocumented)
post(error: Error, context?: ErrorContext): void;
}
// @public (undocumented)
export type ErrorBoundaryFallbackProps = {
plugin?: BackstagePlugin;
error: Error;
resetError: () => void;
plugin?: BackstagePlugin;
error: Error;
resetError: () => void;
};
// @public (undocumented)
@@ -242,191 +282,254 @@ export const FeatureFlagged: (props: FeatureFlaggedProps) => JSX.Element;
// @public (undocumented)
export type FeatureFlaggedProps = {
children: ReactNode;
} & ({
with: string;
} | {
without: string;
});
children: ReactNode;
} & (
| {
with: string;
}
| {
without: string;
}
);
// @public (undocumented)
export const FlatRoutes: (props: FlatRoutesProps) => JSX.Element | null;
// @public (undocumented)
export class GithubAuth implements OAuthApi, SessionApi {
constructor(sessionManager: SessionManager<GithubSession>);
// (undocumented)
static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): GithubAuth;
// (undocumented)
getAccessToken(scope?: string, options?: AuthRequestOptions): Promise<string>;
// (undocumented)
getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentity | undefined>;
// (undocumented)
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
// (undocumented)
static normalizeScope(scope?: string): Set<string>;
// (undocumented)
sessionState$(): Observable<SessionState>;
// (undocumented)
signIn(): Promise<void>;
// (undocumented)
signOut(): Promise<void>;
constructor(sessionManager: SessionManager<GithubSession>);
// (undocumented)
static create({
discoveryApi,
environment,
provider,
oauthRequestApi,
defaultScopes,
}: OAuthApiCreateOptions): GithubAuth;
// (undocumented)
getAccessToken(scope?: string, options?: AuthRequestOptions): Promise<string>;
// (undocumented)
getBackstageIdentity(
options?: AuthRequestOptions,
): Promise<BackstageIdentity | undefined>;
// (undocumented)
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
// (undocumented)
static normalizeScope(scope?: string): Set<string>;
// (undocumented)
sessionState$(): Observable<SessionState>;
// (undocumented)
signIn(): Promise<void>;
// (undocumented)
signOut(): Promise<void>;
}
// @public (undocumented)
export type GithubSession = {
providerInfo: {
accessToken: string;
scopes: Set<string>;
expiresAt: Date;
};
profile: ProfileInfo;
backstageIdentity: BackstageIdentity;
providerInfo: {
accessToken: string;
scopes: Set<string>;
expiresAt: Date;
};
profile: ProfileInfo;
backstageIdentity: BackstageIdentity;
};
// @public (undocumented)
export class GitlabAuth {
// (undocumented)
static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): typeof gitlabAuthApiRef.T;
// (undocumented)
static create({
discoveryApi,
environment,
provider,
oauthRequestApi,
defaultScopes,
}: OAuthApiCreateOptions): typeof gitlabAuthApiRef.T;
}
// @public (undocumented)
export class GoogleAuth {
// (undocumented)
static create({ discoveryApi, oauthRequestApi, environment, provider, defaultScopes, }: OAuthApiCreateOptions): typeof googleAuthApiRef.T;
// (undocumented)
static create({
discoveryApi,
oauthRequestApi,
environment,
provider,
defaultScopes,
}: OAuthApiCreateOptions): typeof googleAuthApiRef.T;
}
// @public
export class LocalStorageFeatureFlags implements FeatureFlagsApi {
// (undocumented)
getRegisteredFlags(): FeatureFlag[];
// (undocumented)
isActive(name: string): boolean;
// (undocumented)
registerFlag(flag: FeatureFlag): void;
// (undocumented)
save(options: FeatureFlagsSaveOptions): void;
// (undocumented)
getRegisteredFlags(): FeatureFlag[];
// (undocumented)
isActive(name: string): boolean;
// (undocumented)
registerFlag(flag: FeatureFlag): void;
// (undocumented)
save(options: FeatureFlagsSaveOptions): void;
}
// @public (undocumented)
export class MicrosoftAuth {
// (undocumented)
static create({ environment, provider, oauthRequestApi, discoveryApi, defaultScopes, }: OAuthApiCreateOptions): typeof microsoftAuthApiRef.T;
// (undocumented)
static create({
environment,
provider,
oauthRequestApi,
discoveryApi,
defaultScopes,
}: OAuthApiCreateOptions): typeof microsoftAuthApiRef.T;
}
// @public (undocumented)
export class OAuth2 implements OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi {
constructor(options: Options);
// (undocumented)
static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, scopeTransform, }: CreateOptions): OAuth2;
// (undocumented)
getAccessToken(scope?: string | string[], options?: AuthRequestOptions): Promise<string>;
// (undocumented)
getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentity | undefined>;
// (undocumented)
getIdToken(options?: AuthRequestOptions): Promise<string>;
// (undocumented)
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
// (undocumented)
sessionState$(): Observable<SessionState>;
// (undocumented)
signIn(): Promise<void>;
// (undocumented)
signOut(): Promise<void>;
export class OAuth2
implements
OAuthApi,
OpenIdConnectApi,
ProfileInfoApi,
BackstageIdentityApi,
SessionApi {
constructor(options: Options);
// (undocumented)
static create({
discoveryApi,
environment,
provider,
oauthRequestApi,
defaultScopes,
scopeTransform,
}: CreateOptions): OAuth2;
// (undocumented)
getAccessToken(
scope?: string | string[],
options?: AuthRequestOptions,
): Promise<string>;
// (undocumented)
getBackstageIdentity(
options?: AuthRequestOptions,
): Promise<BackstageIdentity | undefined>;
// (undocumented)
getIdToken(options?: AuthRequestOptions): Promise<string>;
// (undocumented)
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
// (undocumented)
sessionState$(): Observable<SessionState>;
// (undocumented)
signIn(): Promise<void>;
// (undocumented)
signOut(): Promise<void>;
}
// @public (undocumented)
export type OAuth2Session = {
providerInfo: {
idToken: string;
accessToken: string;
scopes: Set<string>;
expiresAt: Date;
};
profile: ProfileInfo;
backstageIdentity: BackstageIdentity;
providerInfo: {
idToken: string;
accessToken: string;
scopes: Set<string>;
expiresAt: Date;
};
profile: ProfileInfo;
backstageIdentity: BackstageIdentity;
};
// @public
export class OAuthRequestManager implements OAuthRequestApi {
// (undocumented)
authRequest$(): Observable<PendingAuthRequest[]>;
// (undocumented)
createAuthRequester<T>(options: AuthRequesterOptions<T>): AuthRequester<T>;
}
// (undocumented)
authRequest$(): Observable<PendingAuthRequest[]>;
// (undocumented)
createAuthRequester<T>(options: AuthRequesterOptions<T>): AuthRequester<T>;
}
// @public (undocumented)
export class OktaAuth {
// (undocumented)
static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): typeof oktaAuthApiRef.T;
// (undocumented)
static create({
discoveryApi,
environment,
provider,
oauthRequestApi,
defaultScopes,
}: OAuthApiCreateOptions): typeof oktaAuthApiRef.T;
}
// @public (undocumented)
export class OneLoginAuth {
// (undocumented)
static create({ discoveryApi, environment, provider, oauthRequestApi, }: CreateOptions_2): typeof oneloginAuthApiRef.T;
// (undocumented)
static create({
discoveryApi,
environment,
provider,
oauthRequestApi,
}: CreateOptions_2): typeof oneloginAuthApiRef.T;
}
// @public (undocumented)
export class SamlAuth implements ProfileInfoApi, BackstageIdentityApi, SessionApi {
constructor(sessionManager: SessionManager<SamlSession>);
// (undocumented)
static create({ discoveryApi, environment, provider, }: AuthApiCreateOptions): SamlAuth;
// (undocumented)
getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentity | undefined>;
// (undocumented)
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
// (undocumented)
sessionState$(): Observable<SessionState>;
// (undocumented)
signIn(): Promise<void>;
// (undocumented)
signOut(): Promise<void>;
export class SamlAuth
implements ProfileInfoApi, BackstageIdentityApi, SessionApi {
constructor(sessionManager: SessionManager<SamlSession>);
// (undocumented)
static create({
discoveryApi,
environment,
provider,
}: AuthApiCreateOptions): SamlAuth;
// (undocumented)
getBackstageIdentity(
options?: AuthRequestOptions,
): Promise<BackstageIdentity | undefined>;
// (undocumented)
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
// (undocumented)
sessionState$(): Observable<SessionState>;
// (undocumented)
signIn(): Promise<void>;
// (undocumented)
signOut(): Promise<void>;
}
// @public (undocumented)
export type SignInPageProps = {
onResult(result: SignInResult): void;
onResult(result: SignInResult): void;
};
// @public (undocumented)
export type SignInResult = {
userId: string;
profile: ProfileInfo;
getIdToken?: () => Promise<string>;
signOut?: () => Promise<void>;
userId: string;
profile: ProfileInfo;
getIdToken?: () => Promise<string>;
signOut?: () => Promise<void>;
};
// @public (undocumented)
export class UnhandledErrorForwarder {
static forward(errorApi: ErrorApi, errorContext: ErrorContext): void;
static forward(errorApi: ErrorApi, errorContext: ErrorContext): void;
}
// @public
export class UrlPatternDiscovery implements DiscoveryApi {
static compile(pattern: string): UrlPatternDiscovery;
// (undocumented)
getBaseUrl(pluginId: string): Promise<string>;
}
static compile(pattern: string): UrlPatternDiscovery;
// (undocumented)
getBaseUrl(pluginId: string): Promise<string>;
}
// @public (undocumented)
export class WebStorage implements StorageApi {
constructor(namespace: string, errorApi: ErrorApi);
// (undocumented)
static create(options: CreateStorageApiOptions): WebStorage;
// (undocumented)
forBucket(name: string): WebStorage;
// (undocumented)
get<T>(key: string): T | undefined;
// (undocumented)
observe$<T>(key: string): Observable<StorageValueChange<T>>;
// (undocumented)
remove(key: string): Promise<void>;
// (undocumented)
set<T>(key: string, data: T): Promise<void>;
}
constructor(namespace: string, errorApi: ErrorApi);
// (undocumented)
static create(options: CreateStorageApiOptions): WebStorage;
// (undocumented)
forBucket(name: string): WebStorage;
// (undocumented)
get<T>(key: string): T | undefined;
// (undocumented)
observe$<T>(key: string): Observable<StorageValueChange<T>>;
// (undocumented)
remove(key: string): Promise<void>;
// (undocumented)
set<T>(key: string, data: T): Promise<void>;
}
// (No @packageDocumentation comment for this package)
```
packages/core-components/api-report.md
+2411
View File
File diff suppressed because it is too large Load Diff
packages/core-plugin-api/api-report.md
+325 -206
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { BackstageTheme } from '@backstage/theme';
import { ComponentType } from 'react';
@@ -14,8 +15,8 @@ import { SvgIconProps } from '@material-ui/core';
// @public
export type AlertApi = {
post(alert: AlertMessage): void;
alert$(): Observable<AlertMessage>;
post(alert: AlertMessage): void;
alert$(): Observable<AlertMessage>;
};
// @public (undocumented)
@@ -23,43 +24,53 @@ export const alertApiRef: ApiRef<AlertApi>;
// @public (undocumented)
export type AlertMessage = {
message: string;
severity?: 'success' | 'info' | 'warning' | 'error';
message: string;
severity?: 'success' | 'info' | 'warning' | 'error';
};
// @public (undocumented)
export type AnyApiFactory = ApiFactory<unknown, unknown, {
export type AnyApiFactory = ApiFactory<
unknown,
unknown,
{
[key in string]: unknown;
}>;
}
>;
// @public (undocumented)
export type AnyApiRef = ApiRef<unknown>;
// @public (undocumented)
export type ApiFactory<Api, Impl extends Api, Deps extends {
export type ApiFactory<
Api,
Impl extends Api,
Deps extends {
[name in string]: unknown;
}> = {
api: ApiRef<Api>;
deps: TypesToApiRefs<Deps>;
factory(deps: Deps): Impl;
}
> = {
api: ApiRef<Api>;
deps: TypesToApiRefs<Deps>;
factory(deps: Deps): Impl;
};
// @public (undocumented)
export type ApiHolder = {
get<T>(api: ApiRef<T>): T | undefined;
get<T>(api: ApiRef<T>): T | undefined;
};
// @public (undocumented)
export type ApiRef<T> = {
id: string;
T: T;
id: string;
T: T;
};
// @public (undocumented)
export type ApiRefsToTypes<T extends {
export type ApiRefsToTypes<
T extends {
[key in string]: ApiRef<unknown>;
}> = {
[key in keyof T]: ApiRefType<T[key]>;
}
> = {
[key in keyof T]: ApiRefType<T[key]>;
};
// @public (undocumented)
@@ -67,93 +78,106 @@ export type ApiRefType<T> = T extends ApiRef<infer U> ? U : never;
// @public (undocumented)
export type AppComponents = {
NotFoundErrorPage: ComponentType<{}>;
BootErrorPage: ComponentType<BootErrorPageProps>;
Progress: ComponentType<{}>;
Router: ComponentType<{}>;
ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
SignInPage?: ComponentType<SignInPageProps>;
NotFoundErrorPage: ComponentType<{}>;
BootErrorPage: ComponentType<BootErrorPageProps>;
Progress: ComponentType<{}>;
Router: ComponentType<{}>;
ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
SignInPage?: ComponentType<SignInPageProps>;
};
// @public (undocumented)
export type AppContext = {
getPlugins(): BackstagePlugin<any, any>[];
getSystemIcon(key: string): IconComponent | undefined;
getComponents(): AppComponents;
getPlugins(): BackstagePlugin<any, any>[];
getSystemIcon(key: string): IconComponent | undefined;
getComponents(): AppComponents;
};
// @public
export type AppTheme = {
id: string;
title: string;
variant: 'light' | 'dark';
theme: BackstageTheme;
icon?: React.ReactElement;
id: string;
title: string;
variant: 'light' | 'dark';
theme: BackstageTheme;
icon?: React.ReactElement;
};
// @public
export type AppThemeApi = {
getInstalledThemes(): AppTheme[];
activeThemeId$(): Observable<string | undefined>;
getActiveThemeId(): string | undefined;
setActiveThemeId(themeId?: string): void;
getInstalledThemes(): AppTheme[];
activeThemeId$(): Observable<string | undefined>;
getActiveThemeId(): string | undefined;
setActiveThemeId(themeId?: string): void;
};
// @public (undocumented)
export const appThemeApiRef: ApiRef<AppThemeApi>;
// @public (undocumented)
export function attachComponentData<P>(component: ComponentType<P>, type: string, data: unknown): void;
export function attachComponentData<P>(
component: ComponentType<P>,
type: string,
data: unknown,
): void;
// @public
export const auth0AuthApiRef: ApiRef<OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const auth0AuthApiRef: ApiRef<
OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
// @public
export type AuthProvider = {
title: string;
icon: IconComponent;
title: string;
icon: IconComponent;
};
// @public
export type AuthRequester<AuthResponse> = (scopes: Set<string>) => Promise<AuthResponse>;
export type AuthRequester<AuthResponse> = (
scopes: Set<string>,
) => Promise<AuthResponse>;
// @public
export type AuthRequesterOptions<AuthResponse> = {
provider: AuthProvider;
onAuthRequest(scopes: Set<string>): Promise<AuthResponse>;
provider: AuthProvider;
onAuthRequest(scopes: Set<string>): Promise<AuthResponse>;
};
// @public (undocumented)
export type AuthRequestOptions = {
optional?: boolean;
instantPopup?: boolean;
optional?: boolean;
instantPopup?: boolean;
};
// @public (undocumented)
export type BackstageIdentity = {
id: string;
idToken: string;
id: string;
idToken: string;
};
// @public
export type BackstageIdentityApi = {
getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentity | undefined>;
getBackstageIdentity(
options?: AuthRequestOptions,
): Promise<BackstageIdentity | undefined>;
};
// @public (undocumented)
export type BackstagePlugin<Routes extends AnyRoutes = {}, ExternalRoutes extends AnyExternalRoutes = {}> = {
getId(): string;
output(): PluginOutput[];
getApis(): Iterable<AnyApiFactory>;
provide<T>(extension: Extension<T>): T;
routes: Routes;
externalRoutes: ExternalRoutes;
export type BackstagePlugin<
Routes extends AnyRoutes = {},
ExternalRoutes extends AnyExternalRoutes = {}
> = {
getId(): string;
output(): PluginOutput[];
getApis(): Iterable<AnyApiFactory>;
provide<T>(extension: Extension<T>): T;
routes: Routes;
externalRoutes: ExternalRoutes;
};
// @public (undocumented)
export type BootErrorPageProps = {
step: 'load-config' | 'load-chunk';
error: Error;
step: 'load-config' | 'load-chunk';
error: Error;
};
// @public
@@ -163,66 +187,89 @@ export type ConfigApi = Config;
export const configApiRef: ApiRef<ConfigApi>;
// @public
export function createApiFactory<Api, Impl extends Api, Deps extends {
export function createApiFactory<
Api,
Impl extends Api,
Deps extends {
[name in string]: unknown;
}>(factory: ApiFactory<Api, Impl, Deps>): ApiFactory<Api, Impl, Deps>;
}
>(factory: ApiFactory<Api, Impl, Deps>): ApiFactory<Api, Impl, Deps>;
// @public (undocumented)
export function createApiFactory<Api, Impl extends Api>(api: ApiRef<Api>, instance: Impl): ApiFactory<Api, Impl, {}>;
export function createApiFactory<Api, Impl extends Api>(
api: ApiRef<Api>,
instance: Impl,
): ApiFactory<Api, Impl, {}>;
// @public (undocumented)
export function createApiRef<T>(config: ApiRefConfig): ApiRef<T>;
// @public (undocumented)
export function createComponentExtension<T extends (props: any) => JSX.Element | null>(options: {
component: ComponentLoader<T>;
}): Extension<T>;
export function createComponentExtension<
T extends (props: any) => JSX.Element | null
>(options: { component: ComponentLoader<T> }): Extension<T>;
// @public (undocumented)
export function createExternalRouteRef<Params extends {
export function createExternalRouteRef<
Params extends {
[param in ParamKey]: string;
}, Optional extends boolean = false, ParamKey extends string = never>(options: {
id: string;
params?: ParamKey[];
optional?: Optional;
},
Optional extends boolean = false,
ParamKey extends string = never
>(options: {
id: string;
params?: ParamKey[];
optional?: Optional;
}): ExternalRouteRef<OptionalParams<Params>, Optional>;
// @public (undocumented)
export function createPlugin<Routes extends AnyRoutes = {}, ExternalRoutes extends AnyExternalRoutes = {}>(config: PluginConfig<Routes, ExternalRoutes>): BackstagePlugin<Routes, ExternalRoutes>;
export function createPlugin<
Routes extends AnyRoutes = {},
ExternalRoutes extends AnyExternalRoutes = {}
>(
config: PluginConfig<Routes, ExternalRoutes>,
): BackstagePlugin<Routes, ExternalRoutes>;
// @public (undocumented)
export function createReactExtension<T extends (props: any) => JSX.Element | null>(options: {
component: ComponentLoader<T>;
data?: Record<string, unknown>;
export function createReactExtension<
T extends (props: any) => JSX.Element | null
>(options: {
component: ComponentLoader<T>;
data?: Record<string, unknown>;
}): Extension<T>;
// @public (undocumented)
export function createRoutableExtension<T extends (props: any) => JSX.Element | null>(options: {
component: () => Promise<T>;
mountPoint: RouteRef;
}): Extension<T>;
export function createRoutableExtension<
T extends (props: any) => JSX.Element | null
>(options: { component: () => Promise<T>; mountPoint: RouteRef }): Extension<T>;
// @public (undocumented)
export function createRouteRef<Params extends {
export function createRouteRef<
Params extends {
[param in ParamKey]: string;
}, ParamKey extends string = never>(config: {
id?: string;
params?: ParamKey[];
path?: string;
icon?: OldIconComponent;
title?: string;
},
ParamKey extends string = never
>(config: {
id?: string;
params?: ParamKey[];
path?: string;
icon?: OldIconComponent;
title?: string;
}): RouteRef<OptionalParams<Params>>;
// @public (undocumented)
export function createSubRouteRef<Path extends string, ParentParams extends AnyParams = never>(config: {
id: string;
path: Path;
parent: RouteRef<ParentParams>;
export function createSubRouteRef<
Path extends string,
ParentParams extends AnyParams = never
>(config: {
id: string;
path: Path;
parent: RouteRef<ParentParams>;
}): MakeSubRouteRef<PathParams<Path>, ParentParams>;
// @public
export type DiscoveryApi = {
getBaseUrl(pluginId: string): Promise<string>;
getBaseUrl(pluginId: string): Promise<string>;
};
// @public (undocumented)
@@ -230,25 +277,25 @@ export const discoveryApiRef: ApiRef<DiscoveryApi>;
// @public
export interface ElementCollection {
findComponentData<T>(query: {
key: string;
}): T[];
getElements<Props extends {
[name: string]: unknown;
}>(): Array<ReactElement<Props>>;
selectByComponentData(query: {
key: string;
withStrictError?: string;
}): ElementCollection;
findComponentData<T>(query: { key: string }): T[];
getElements<
Props extends {
[name: string]: unknown;
}
>(): Array<ReactElement<Props>>;
selectByComponentData(query: {
key: string;
withStrictError?: string;
}): ElementCollection;
}
// @public
export type ErrorApi = {
post(error: Error_2, context?: ErrorContext): void;
error$(): Observable<{
error: Error_2;
context?: ErrorContext;
}>;
post(error: Error_2, context?: ErrorContext): void;
error$(): Observable<{
error: Error_2;
context?: ErrorContext;
}>;
};
// @public (undocumented)
@@ -256,46 +303,49 @@ export const errorApiRef: ApiRef<ErrorApi>;
// @public (undocumented)
export type ErrorBoundaryFallbackProps = {
plugin?: BackstagePlugin;
error: Error;
resetError: () => void;
plugin?: BackstagePlugin;
error: Error;
resetError: () => void;
};
// @public
export type ErrorContext = {
hidden?: boolean;
hidden?: boolean;
};
// @public (undocumented)
export type Extension<T> = {
expose(plugin: BackstagePlugin<any, any>): T;
expose(plugin: BackstagePlugin<any, any>): T;
};
// @public (undocumented)
export type ExternalRouteRef<Params extends AnyParams = any, Optional extends boolean = any> = {
readonly [routeRefType]: 'external';
params: ParamKeys<Params>;
optional?: Optional;
export type ExternalRouteRef<
Params extends AnyParams = any,
Optional extends boolean = any
> = {
readonly [routeRefType]: 'external';
params: ParamKeys<Params>;
optional?: Optional;
};
// @public
export type FeatureFlag = {
name: string;
pluginId: string;
name: string;
pluginId: string;
};
// @public (undocumented)
export type FeatureFlagOutput = {
type: 'feature-flag';
name: string;
type: 'feature-flag';
name: string;
};
// @public (undocumented)
export interface FeatureFlagsApi {
getRegisteredFlags(): FeatureFlag[];
isActive(name: string): boolean;
registerFlag(flag: FeatureFlag): void;
save(options: FeatureFlagsSaveOptions): void;
getRegisteredFlags(): FeatureFlag[];
isActive(name: string): boolean;
registerFlag(flag: FeatureFlag): void;
save(options: FeatureFlagsSaveOptions): void;
}
// @public (undocumented)
@@ -303,66 +353,96 @@ export const featureFlagsApiRef: ApiRef<FeatureFlagsApi>;
// @public (undocumented)
export type FeatureFlagsHooks = {
register(name: string): void;
register(name: string): void;
};
// @public
export type FeatureFlagsSaveOptions = {
states: Record<string, FeatureFlagState>;
merge?: boolean;
states: Record<string, FeatureFlagState>;
merge?: boolean;
};
// @public (undocumented)
export enum FeatureFlagState {
// (undocumented)
Active = 1,
// (undocumented)
None = 0
// (undocumented)
Active = 1,
// (undocumented)
None = 0,
}
// @public (undocumented)
export function getComponentData<T>(node: ReactNode, type: string): T | undefined;
export function getComponentData<T>(
node: ReactNode,
type: string,
): T | undefined;
// @public
export const githubAuthApiRef: ApiRef<OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const githubAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
// @public
export const gitlabAuthApiRef: ApiRef<OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const gitlabAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
// @public
export const googleAuthApiRef: ApiRef<OAuthApi & OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const googleAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
ProfileInfoApi &
BackstageIdentityApi &
SessionApi
>;
// @public
export type IconComponent = ComponentType<{
fontSize?: 'default' | 'small' | 'large';
fontSize?: 'default' | 'small' | 'large';
}>;
// @public
export type IdentityApi = {
getUserId(): string;
getProfile(): ProfileInfo;
getIdToken(): Promise<string | undefined>;
signOut(): Promise<void>;
getUserId(): string;
getProfile(): ProfileInfo;
getIdToken(): Promise<string | undefined>;
signOut(): Promise<void>;
};
// @public (undocumented)
export const identityApiRef: ApiRef<IdentityApi>;
// @public
export const microsoftAuthApiRef: ApiRef<OAuthApi & OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const microsoftAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
ProfileInfoApi &
BackstageIdentityApi &
SessionApi
>;
// @public
export const oauth2ApiRef: ApiRef<OAuthApi & OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const oauth2ApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
ProfileInfoApi &
BackstageIdentityApi &
SessionApi
>;
// @public
export type OAuthApi = {
getAccessToken(scope?: OAuthScope, options?: AuthRequestOptions): Promise<string>;
getAccessToken(
scope?: OAuthScope,
options?: AuthRequestOptions,
): Promise<string>;
};
// @public
export type OAuthRequestApi = {
createAuthRequester<AuthResponse>(options: AuthRequesterOptions<AuthResponse>): AuthRequester<AuthResponse>;
authRequest$(): Observable<PendingAuthRequest[]>;
createAuthRequester<AuthResponse>(
options: AuthRequesterOptions<AuthResponse>,
): AuthRequester<AuthResponse>;
authRequest$(): Observable<PendingAuthRequest[]>;
};
// @public (undocumented)
@@ -373,51 +453,76 @@ export type OAuthScope = string | string[];
// @public
export type Observable<T> = {
[Symbol.observable](): Observable<T>;
subscribe(observer: Observer<T>): Subscription;
subscribe(onNext?: (value: T) => void, onError?: (error: Error) => void, onComplete?: () => void): Subscription;
[Symbol.observable](): Observable<T>;
subscribe(observer: Observer<T>): Subscription;
subscribe(
onNext?: (value: T) => void,
onError?: (error: Error) => void,
onComplete?: () => void,
): Subscription;
};
// @public
export type Observer<T> = {
next?(value: T): void;
error?(error: Error): void;
complete?(): void;
next?(value: T): void;
error?(error: Error): void;
complete?(): void;
};
// @public
export const oidcAuthApiRef: ApiRef<OAuthApi & OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const oidcAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
ProfileInfoApi &
BackstageIdentityApi &
SessionApi
>;
// @public
export const oktaAuthApiRef: ApiRef<OAuthApi & OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const oktaAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
ProfileInfoApi &
BackstageIdentityApi &
SessionApi
>;
// @public (undocumented)
export const oneloginAuthApiRef: ApiRef<OAuthApi & OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const oneloginAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
ProfileInfoApi &
BackstageIdentityApi &
SessionApi
>;
// @public
export type OpenIdConnectApi = {
getIdToken(options?: AuthRequestOptions): Promise<string>;
getIdToken(options?: AuthRequestOptions): Promise<string>;
};
// @public
export type PendingAuthRequest = {
provider: AuthProvider;
reject: () => void;
trigger(): Promise<void>;
provider: AuthProvider;
reject: () => void;
trigger(): Promise<void>;
};
// @public (undocumented)
export type PluginConfig<Routes extends AnyRoutes, ExternalRoutes extends AnyExternalRoutes> = {
id: string;
apis?: Iterable<AnyApiFactory>;
register?(hooks: PluginHooks): void;
routes?: Routes;
externalRoutes?: ExternalRoutes;
export type PluginConfig<
Routes extends AnyRoutes,
ExternalRoutes extends AnyExternalRoutes
> = {
id: string;
apis?: Iterable<AnyApiFactory>;
register?(hooks: PluginHooks): void;
routes?: Routes;
externalRoutes?: ExternalRoutes;
};
// @public (undocumented)
export type PluginHooks = {
featureFlags: FeatureFlagsHooks;
featureFlags: FeatureFlagsHooks;
};
// @public (undocumented)
@@ -425,19 +530,19 @@ export type PluginOutput = FeatureFlagOutput;
// @public
export type ProfileInfo = {
email?: string;
displayName?: string;
picture?: string;
email?: string;
displayName?: string;
picture?: string;
};
// @public
export type ProfileInfoApi = {
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
};
// @public (undocumented)
export type RouteOptions = {
exact?: boolean;
exact?: boolean;
};
// @public (undocumented)
@@ -445,51 +550,53 @@ export type RoutePath = string;
// @public (undocumented)
export type RouteRef<Params extends AnyParams = any> = {
readonly [routeRefType]: 'absolute';
params: ParamKeys<Params>;
path: string;
icon?: OldIconComponent;
title?: string;
readonly [routeRefType]: 'absolute';
params: ParamKeys<Params>;
path: string;
icon?: OldIconComponent;
title?: string;
};
// @public
export const samlAuthApiRef: ApiRef<ProfileInfoApi & BackstageIdentityApi & SessionApi>;
export const samlAuthApiRef: ApiRef<
ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
// @public
export type SessionApi = {
signIn(): Promise<void>;
signOut(): Promise<void>;
sessionState$(): Observable<SessionState>;
signIn(): Promise<void>;
signOut(): Promise<void>;
sessionState$(): Observable<SessionState>;
};
// @public
export enum SessionState {
// (undocumented)
SignedIn = "SignedIn",
// (undocumented)
SignedOut = "SignedOut"
// (undocumented)
SignedIn = 'SignedIn',
// (undocumented)
SignedOut = 'SignedOut',
}
// @public (undocumented)
export type SignInPageProps = {
onResult(result: SignInResult): void;
onResult(result: SignInResult): void;
};
// @public (undocumented)
export type SignInResult = {
userId: string;
profile: ProfileInfo;
getIdToken?: () => Promise<string>;
signOut?: () => Promise<void>;
userId: string;
profile: ProfileInfo;
getIdToken?: () => Promise<string>;
signOut?: () => Promise<void>;
};
// @public (undocumented)
export interface StorageApi {
forBucket(name: string): StorageApi;
get<T>(key: string): T | undefined;
observe$<T>(key: string): Observable<StorageValueChange<T>>;
remove(key: string): Promise<void>;
set(key: string, data: any): Promise<void>;
forBucket(name: string): StorageApi;
get<T>(key: string): T | undefined;
observe$<T>(key: string): Observable<StorageValueChange<T>>;
remove(key: string): Promise<void>;
set(key: string, data: any): Promise<void>;
}
// @public (undocumented)
@@ -497,27 +604,27 @@ export const storageApiRef: ApiRef<StorageApi>;
// @public (undocumented)
export type StorageValueChange<T = any> = {
key: string;
newValue?: T;
key: string;
newValue?: T;
};
// @public (undocumented)
export type SubRouteRef<Params extends AnyParams = any> = {
readonly [routeRefType]: 'sub';
parent: RouteRef;
path: string;
params: ParamKeys<Params>;
readonly [routeRefType]: 'sub';
parent: RouteRef;
path: string;
params: ParamKeys<Params>;
};
// @public
export type Subscription = {
unsubscribe(): void;
readonly closed: boolean;
unsubscribe(): void;
readonly closed: boolean;
};
// @public (undocumented)
export type TypesToApiRefs<T> = {
[key in keyof T]: ApiRef<T[key]>;
[key in keyof T]: ApiRef<T[key]>;
};
// @public (undocumented)
@@ -530,27 +637,39 @@ export function useApiHolder(): ApiHolder;
export const useApp: () => AppContext;
// @public
export function useElementFilter<T>(node: ReactNode, filterFn: (arg: ElementCollection) => T, dependencies?: any[]): T;
export function useElementFilter<T>(
node: ReactNode,
filterFn: (arg: ElementCollection) => T,
dependencies?: any[],
): T;
// @public (undocumented)
export type UserFlags = {};
// @public (undocumented)
export function useRouteRef<Optional extends boolean, Params extends AnyParams>(routeRef: ExternalRouteRef<Params, Optional>): Optional extends true ? RouteFunc<Params> | undefined : RouteFunc<Params>;
export function useRouteRef<Optional extends boolean, Params extends AnyParams>(
routeRef: ExternalRouteRef<Params, Optional>,
): Optional extends true ? RouteFunc<Params> | undefined : RouteFunc<Params>;
// @public (undocumented)
export function useRouteRef<Params extends AnyParams>(routeRef: RouteRef<Params> | SubRouteRef<Params>): RouteFunc<Params>;
export function useRouteRef<Params extends AnyParams>(
routeRef: RouteRef<Params> | SubRouteRef<Params>,
): RouteFunc<Params>;
// @public (undocumented)
export function useRouteRefParams<Params extends AnyParams>(_routeRef: RouteRef<Params> | SubRouteRef<Params>): Params;
export function useRouteRefParams<Params extends AnyParams>(
_routeRef: RouteRef<Params> | SubRouteRef<Params>,
): Params;
// @public (undocumented)
export function withApis<T>(apis: TypesToApiRefs<T>): <P extends T>(WrappedComponent: React_2.ComponentType<P>) => {
(props: React_2.PropsWithChildren<Omit<P, keyof T>>): JSX.Element;
displayName: string;
export function withApis<T>(
apis: TypesToApiRefs<T>,
): <P extends T>(
WrappedComponent: React_2.ComponentType<P>,
) => {
(props: React_2.PropsWithChildren<Omit<P, keyof T>>): JSX.Element;
displayName: string;
};
// (No @packageDocumentation comment for this package)
```
packages/create-app/package.json
+1 -1
View File
@@ -30,7 +30,7 @@
"@backstage/cli-common": "^0.1.2",
"chalk": "^4.0.0",
"commander": "^6.1.0",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"handlebars": "^4.7.3",
"inquirer": "^7.0.4",
"ora": "^5.3.0",
packages/dev-utils/api-report.md
+7 -4
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiFactory } from '@backstage/core-plugin-api';
import { ComponentType } from 'react';
@@ -16,11 +17,13 @@ import { ReactNode } from 'react';
export function createDevApp(): DevAppBuilder;
// @public (undocumented)
export const EntityGridItem: ({ entity, classes, ...rest }: Omit<GridProps<"div", {}>, "container" | "item"> & {
entity: Entity;
export const EntityGridItem: ({
entity,
classes,
...rest
}: Omit<GridProps<'div', {}>, 'container' | 'item'> & {
entity: Entity;
}) => JSX.Element;
// (No @packageDocumentation comment for this package)
```
packages/docgen/package.json
+1 -1
View File
@@ -28,7 +28,7 @@
"dependencies": {
"chalk": "^4.0.0",
"commander": "^6.1.0",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"github-slugger": "^1.3.0",
"ts-node": "^10.0.0",
"typescript": "^4.0.3"
packages/e2e-test/package.json
+1 -1
View File
@@ -30,7 +30,7 @@
"chalk": "^4.0.0",
"commander": "^6.1.0",
"cross-fetch": "^3.0.6",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"handlebars": "^4.7.3",
"pgtools": "^0.3.0",
"tree-kill": "^1.2.2",
packages/errors/api-report.md
+39 -43
View File
@@ -3,86 +3,82 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { JsonObject } from '@backstage/config';
// @public
export class AuthenticationError extends CustomErrorBase {
}
export class AuthenticationError extends CustomErrorBase {}
// @public
export class ConflictError extends CustomErrorBase {
}
export class ConflictError extends CustomErrorBase {}
// @public (undocumented)
export class CustomErrorBase extends Error {
constructor(message?: string, cause?: Error);
// (undocumented)
readonly cause?: Error;
constructor(message?: string, cause?: Error);
// (undocumented)
readonly cause?: Error;
}
// @public
export function deserializeError<T extends Error = Error>(data: SerializedError): T;
export function deserializeError<T extends Error = Error>(
data: SerializedError,
): T;
// @public
export type ErrorResponse = {
error: SerializedError;
request?: {
method: string;
url: string;
};
response: {
statusCode: number;
};
error: SerializedError;
request?: {
method: string;
url: string;
};
response: {
statusCode: number;
};
};
// @public
export class InputError extends CustomErrorBase {
}
export class InputError extends CustomErrorBase {}
// @public
export class NotAllowedError extends CustomErrorBase {
}
export class NotAllowedError extends CustomErrorBase {}
// @public
export class NotFoundError extends CustomErrorBase {
}
export class NotFoundError extends CustomErrorBase {}
// @public
export class NotModifiedError extends CustomErrorBase {
}
export class NotModifiedError extends CustomErrorBase {}
// @public
export function parseErrorResponse(response: Response): Promise<ErrorResponse>;
// @public
export class ResponseError extends Error {
constructor(props: {
message: string;
response: Response;
data: ErrorResponse;
cause: Error;
});
readonly cause: Error;
readonly data: ErrorResponse;
static fromResponse(response: Response): Promise<ResponseError>;
readonly response: Response;
constructor(props: {
message: string;
response: Response;
data: ErrorResponse;
cause: Error;
});
readonly cause: Error;
readonly data: ErrorResponse;
static fromResponse(response: Response): Promise<ResponseError>;
readonly response: Response;
}
// @public
export type SerializedError = JsonObject & {
name: string;
message: string;
stack?: string;
code?: string;
name: string;
message: string;
stack?: string;
code?: string;
};
// @public
export function serializeError(error: Error, options?: {
export function serializeError(
error: Error,
options?: {
includeStack?: boolean;
}): SerializedError;
},
): SerializedError;
// (No @packageDocumentation comment for this package)
```
packages/integration-react/api-report.md
+7 -6
View File
@@ -3,26 +3,27 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { Config } from '@backstage/config';
import { ScmIntegrationRegistry } from '@backstage/integration';
// @public (undocumented)
export const ScmIntegrationIcon: ({ type }: {
type?: string | undefined;
export const ScmIntegrationIcon: ({
type,
}: {
type?: string | undefined;
}) => JSX.Element;
// @public (undocumented)
export class ScmIntegrationsApi {
// (undocumented)
static fromConfig(config: Config): ScmIntegrationRegistry;
// (undocumented)
static fromConfig(config: Config): ScmIntegrationRegistry;
}
// @public (undocumented)
export const scmIntegrationsApiRef: ApiRef<ScmIntegrationRegistry>;
// (No @packageDocumentation comment for this package)
```
packages/integration/api-report.md
+212 -172
View File
@@ -3,72 +3,71 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { Config } from '@backstage/config';
import { RestEndpointMethodTypes } from '@octokit/rest';
// @public (undocumented)
export class AzureIntegration implements ScmIntegration {
constructor(integrationConfig: AzureIntegrationConfig);
// (undocumented)
get config(): AzureIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<AzureIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
constructor(integrationConfig: AzureIntegrationConfig);
// (undocumented)
get config(): AzureIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<AzureIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
}
// @public
export type AzureIntegrationConfig = {
host: string;
token?: string;
host: string;
token?: string;
};
// @public (undocumented)
export class BitbucketIntegration implements ScmIntegration {
constructor(integrationConfig: BitbucketIntegrationConfig);
// (undocumented)
get config(): BitbucketIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<BitbucketIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
constructor(integrationConfig: BitbucketIntegrationConfig);
// (undocumented)
get config(): BitbucketIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<BitbucketIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
}
// @public
export type BitbucketIntegrationConfig = {
host: string;
apiBaseUrl?: string;
token?: string;
username?: string;
appPassword?: string;
host: string;
apiBaseUrl?: string;
token?: string;
username?: string;
appPassword?: string;
};
// @public
export function defaultScmResolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
url: string;
base: string;
lineNumber?: number;
}): string;
// @public
@@ -81,212 +80,253 @@ export function getAzureDownloadUrl(url: string): string;
export function getAzureFileFetchUrl(url: string): string;
// @public
export function getAzureRequestOptions(config: AzureIntegrationConfig, additionalHeaders?: Record<string, string>): RequestInit;
export function getAzureRequestOptions(
config: AzureIntegrationConfig,
additionalHeaders?: Record<string, string>,
): RequestInit;
// @public
export function getBitbucketDefaultBranch(url: string, config: BitbucketIntegrationConfig): Promise<string>;
export function getBitbucketDefaultBranch(
url: string,
config: BitbucketIntegrationConfig,
): Promise<string>;
// @public
export function getBitbucketDownloadUrl(url: string, config: BitbucketIntegrationConfig): Promise<string>;
export function getBitbucketDownloadUrl(
url: string,
config: BitbucketIntegrationConfig,
): Promise<string>;
// @public
export function getBitbucketFileFetchUrl(url: string, config: BitbucketIntegrationConfig): string;
export function getBitbucketFileFetchUrl(
url: string,
config: BitbucketIntegrationConfig,
): string;
// @public
export function getBitbucketRequestOptions(config: BitbucketIntegrationConfig): RequestInit;
export function getBitbucketRequestOptions(
config: BitbucketIntegrationConfig,
): RequestInit;
// @public
export function getGitHubFileFetchUrl(url: string, config: GitHubIntegrationConfig): string;
export function getGitHubFileFetchUrl(
url: string,
config: GitHubIntegrationConfig,
): string;
// @public
export function getGitHubRequestOptions(config: GitHubIntegrationConfig): RequestInit;
export function getGitHubRequestOptions(
config: GitHubIntegrationConfig,
): RequestInit;
// @public
export function getGitLabFileFetchUrl(url: string, config: GitLabIntegrationConfig): Promise<string>;
export function getGitLabFileFetchUrl(
url: string,
config: GitLabIntegrationConfig,
): Promise<string>;
// @public
export function getGitLabRequestOptions(config: GitLabIntegrationConfig): RequestInit;
export function getGitLabRequestOptions(
config: GitLabIntegrationConfig,
): RequestInit;
// @public (undocumented)
export class GithubAppCredentialsMux {
constructor(config: GitHubIntegrationConfig);
// (undocumented)
getAllInstallations(): Promise<RestEndpointMethodTypes['apps']['listInstallations']['response']['data']>;
// (undocumented)
getAppToken(owner: string, repo?: string): Promise<string | undefined>;
constructor(config: GitHubIntegrationConfig);
// (undocumented)
getAllInstallations(): Promise<
RestEndpointMethodTypes['apps']['listInstallations']['response']['data']
>;
// (undocumented)
getAppToken(owner: string, repo?: string): Promise<string | undefined>;
}
// @public (undocumented)
export class GithubCredentialsProvider {
// (undocumented)
static create(config: GitHubIntegrationConfig): GithubCredentialsProvider;
getCredentials(opts: {
url: string;
}): Promise<GithubCredentials>;
}
// (undocumented)
static create(config: GitHubIntegrationConfig): GithubCredentialsProvider;
getCredentials(opts: { url: string }): Promise<GithubCredentials>;
}
// @public (undocumented)
export type GithubCredentialType = 'app' | 'token';
// @public (undocumented)
export class GitHubIntegration implements ScmIntegration {
constructor(integrationConfig: GitHubIntegrationConfig);
// (undocumented)
get config(): GitHubIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<GitHubIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
constructor(integrationConfig: GitHubIntegrationConfig);
// (undocumented)
get config(): GitHubIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<GitHubIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
}
// @public
export type GitHubIntegrationConfig = {
host: string;
apiBaseUrl?: string;
rawBaseUrl?: string;
token?: string;
apps?: GithubAppConfig[];
host: string;
apiBaseUrl?: string;
rawBaseUrl?: string;
token?: string;
apps?: GithubAppConfig[];
};
// @public (undocumented)
export class GitLabIntegration implements ScmIntegration {
constructor(integrationConfig: GitLabIntegrationConfig);
// (undocumented)
get config(): GitLabIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<GitLabIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
constructor(integrationConfig: GitLabIntegrationConfig);
// (undocumented)
get config(): GitLabIntegrationConfig;
// (undocumented)
static factory: ScmIntegrationsFactory<GitLabIntegration>;
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
// (undocumented)
get title(): string;
// (undocumented)
get type(): string;
}
// @public
export type GitLabIntegrationConfig = {
host: string;
apiBaseUrl: string;
token?: string;
baseUrl: string;
host: string;
apiBaseUrl: string;
token?: string;
baseUrl: string;
};
// @public
export type GoogleGcsIntegrationConfig = {
clientEmail?: string;
privateKey?: string;
clientEmail?: string;
privateKey?: string;
};
// @public
export function readAzureIntegrationConfig(config: Config): AzureIntegrationConfig;
export function readAzureIntegrationConfig(
config: Config,
): AzureIntegrationConfig;
// @public
export function readAzureIntegrationConfigs(configs: Config[]): AzureIntegrationConfig[];
export function readAzureIntegrationConfigs(
configs: Config[],
): AzureIntegrationConfig[];
// @public
export function readBitbucketIntegrationConfig(config: Config): BitbucketIntegrationConfig;
export function readBitbucketIntegrationConfig(
config: Config,
): BitbucketIntegrationConfig;
// @public
export function readBitbucketIntegrationConfigs(configs: Config[]): BitbucketIntegrationConfig[];
export function readBitbucketIntegrationConfigs(
configs: Config[],
): BitbucketIntegrationConfig[];
// @public
export function readGitHubIntegrationConfig(config: Config): GitHubIntegrationConfig;
export function readGitHubIntegrationConfig(
config: Config,
): GitHubIntegrationConfig;
// @public
export function readGitHubIntegrationConfigs(configs: Config[]): GitHubIntegrationConfig[];
export function readGitHubIntegrationConfigs(
configs: Config[],
): GitHubIntegrationConfig[];
// @public
export function readGitLabIntegrationConfig(config: Config): GitLabIntegrationConfig;
export function readGitLabIntegrationConfig(
config: Config,
): GitLabIntegrationConfig;
// @public
export function readGitLabIntegrationConfigs(configs: Config[]): GitLabIntegrationConfig[];
export function readGitLabIntegrationConfigs(
configs: Config[],
): GitLabIntegrationConfig[];
// @public
export function readGoogleGcsIntegrationConfig(config: Config): GoogleGcsIntegrationConfig;
export function readGoogleGcsIntegrationConfig(
config: Config,
): GoogleGcsIntegrationConfig;
// @public
export interface ScmIntegration {
resolveEditUrl(url: string): string;
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
title: string;
type: string;
resolveEditUrl(url: string): string;
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
title: string;
type: string;
}
// @public
export interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
// (undocumented)
azure: ScmIntegrationsGroup<AzureIntegration>;
// (undocumented)
bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
// (undocumented)
github: ScmIntegrationsGroup<GitHubIntegration>;
// (undocumented)
gitlab: ScmIntegrationsGroup<GitLabIntegration>;
resolveEditUrl(url: string): string;
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
export interface ScmIntegrationRegistry
extends ScmIntegrationsGroup<ScmIntegration> {
// (undocumented)
azure: ScmIntegrationsGroup<AzureIntegration>;
// (undocumented)
bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
// (undocumented)
github: ScmIntegrationsGroup<GitHubIntegration>;
// (undocumented)
gitlab: ScmIntegrationsGroup<GitLabIntegration>;
resolveEditUrl(url: string): string;
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
}
// @public (undocumented)
export class ScmIntegrations implements ScmIntegrationRegistry {
constructor(integrationsByType: IntegrationsByType);
// (undocumented)
get azure(): ScmIntegrationsGroup<AzureIntegration>;
// (undocumented)
get bitbucket(): ScmIntegrationsGroup<BitbucketIntegration>;
// (undocumented)
byHost(host: string): ScmIntegration | undefined;
// (undocumented)
byUrl(url: string | URL): ScmIntegration | undefined;
// (undocumented)
static fromConfig(config: Config): ScmIntegrations;
// (undocumented)
get github(): ScmIntegrationsGroup<GitHubIntegration>;
// (undocumented)
get gitlab(): ScmIntegrationsGroup<GitLabIntegration>;
// (undocumented)
list(): ScmIntegration[];
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
constructor(integrationsByType: IntegrationsByType);
// (undocumented)
get azure(): ScmIntegrationsGroup<AzureIntegration>;
// (undocumented)
get bitbucket(): ScmIntegrationsGroup<BitbucketIntegration>;
// (undocumented)
byHost(host: string): ScmIntegration | undefined;
// (undocumented)
byUrl(url: string | URL): ScmIntegration | undefined;
// (undocumented)
static fromConfig(config: Config): ScmIntegrations;
// (undocumented)
get github(): ScmIntegrationsGroup<GitHubIntegration>;
// (undocumented)
get gitlab(): ScmIntegrationsGroup<GitLabIntegration>;
// (undocumented)
list(): ScmIntegration[];
// (undocumented)
resolveEditUrl(url: string): string;
// (undocumented)
resolveUrl(options: {
url: string;
base: string;
lineNumber?: number;
}): string;
}
// @public
export interface ScmIntegrationsGroup<T extends ScmIntegration> {
byHost(host: string): T | undefined;
byUrl(url: string | URL): T | undefined;
list(): T[];
byHost(host: string): T | undefined;
byUrl(url: string | URL): T | undefined;
list(): T[];
}
// (No @packageDocumentation comment for this package)
```
packages/search-common/api-report.md
+23 -26
View File
@@ -3,57 +3,54 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { JsonObject } from '@backstage/config';
// @public
export interface DocumentCollator {
// (undocumented)
execute(): Promise<IndexableDocument[]>;
readonly type: string;
// (undocumented)
execute(): Promise<IndexableDocument[]>;
readonly type: string;
}
// @public
export interface DocumentDecorator {
// (undocumented)
execute(documents: IndexableDocument[]): Promise<IndexableDocument[]>;
readonly types?: string[];
// (undocumented)
execute(documents: IndexableDocument[]): Promise<IndexableDocument[]>;
readonly types?: string[];
}
// @public
export interface IndexableDocument {
location: string;
text: string;
title: string;
location: string;
text: string;
title: string;
}
// @public (undocumented)
export interface SearchQuery {
// (undocumented)
filters?: JsonObject;
// (undocumented)
pageCursor: string;
// (undocumented)
term: string;
// (undocumented)
types?: string[];
// (undocumented)
filters?: JsonObject;
// (undocumented)
pageCursor: string;
// (undocumented)
term: string;
// (undocumented)
types?: string[];
}
// @public (undocumented)
export interface SearchResult {
// (undocumented)
document: IndexableDocument;
// (undocumented)
type: string;
// (undocumented)
document: IndexableDocument;
// (undocumented)
type: string;
}
// @public (undocumented)
export interface SearchResultSet {
// (undocumented)
results: SearchResult[];
// (undocumented)
results: SearchResult[];
}
// (No @packageDocumentation comment for this package)
```
packages/techdocs-common/api-report.md
+157 -81
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AzureIntegrationConfig } from '@backstage/integration';
import { Config } from '@backstage/config';
@@ -18,176 +19,251 @@ import { UrlReader } from '@backstage/backend-common';
import { Writable } from 'stream';
// @public (undocumented)
export const checkoutGitRepository: (repoUrl: string, config: Config, logger: Logger_2) => Promise<string>;
export const checkoutGitRepository: (
repoUrl: string,
config: Config,
logger: Logger_2,
) => Promise<string>;
// @public (undocumented)
export class CommonGitPreparer implements PreparerBase {
constructor(config: Config, logger: Logger_2);
// (undocumented)
prepare(entity: Entity, options?: {
etag?: string;
}): Promise<PreparerResponse>;
constructor(config: Config, logger: Logger_2);
// (undocumented)
prepare(
entity: Entity,
options?: {
etag?: string;
},
): Promise<PreparerResponse>;
}
// @public (undocumented)
export class DirectoryPreparer implements PreparerBase {
constructor(config: Config, logger: Logger_2, reader: UrlReader);
// (undocumented)
prepare(entity: Entity): Promise<PreparerResponse>;
}
constructor(config: Config, logger: Logger_2, reader: UrlReader);
// (undocumented)
prepare(entity: Entity): Promise<PreparerResponse>;
}
// @public (undocumented)
export type GeneratorBase = {
run(opts: GeneratorRunOptions): Promise<void>;
run(opts: GeneratorRunOptions): Promise<void>;
};
// @public
export type GeneratorBuilder = {
register(protocol: SupportedGeneratorKey, generator: GeneratorBase): void;
get(entity: Entity): GeneratorBase;
register(protocol: SupportedGeneratorKey, generator: GeneratorBase): void;
get(entity: Entity): GeneratorBase;
};
// @public
export type GeneratorRunOptions = {
inputDir: string;
outputDir: string;
parsedLocationAnnotation?: ParsedLocationAnnotation;
etag?: string;
logger: Logger_2;
logStream?: Writable;
inputDir: string;
outputDir: string;
parsedLocationAnnotation?: ParsedLocationAnnotation;
etag?: string;
logger: Logger_2;
logStream?: Writable;
};
// @public (undocumented)
export class Generators implements GeneratorBuilder {
// (undocumented)
static fromConfig(config: Config, { logger, containerRunner, }: {
logger: Logger_2;
containerRunner: ContainerRunner;
}): Promise<GeneratorBuilder>;
// (undocumented)
get(entity: Entity): GeneratorBase;
// (undocumented)
register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase): void;
// (undocumented)
static fromConfig(
config: Config,
{
logger,
containerRunner,
}: {
logger: Logger_2;
containerRunner: ContainerRunner;
},
): Promise<GeneratorBuilder>;
// (undocumented)
get(entity: Entity): GeneratorBase;
// (undocumented)
register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase): void;
}
// @public (undocumented)
export const getAzureIntegrationConfig: (config: Config, host: string) => AzureIntegrationConfig;
export const getAzureIntegrationConfig: (
config: Config,
host: string,
) => AzureIntegrationConfig;
// @public (undocumented)
export const getDefaultBranch: (repositoryUrl: string, config: Config) => Promise<string>;
export const getDefaultBranch: (
repositoryUrl: string,
config: Config,
) => Promise<string>;
// @public (undocumented)
export const getDocFilesFromRepository: (reader: UrlReader, entity: Entity, opts?: {
etag?: string | undefined;
logger?: Logger_2 | undefined;
} | undefined) => Promise<PreparerResponse>;
export const getDocFilesFromRepository: (
reader: UrlReader,
entity: Entity,
opts?:
| {
etag?: string | undefined;
logger?: Logger_2 | undefined;
}
| undefined,
) => Promise<PreparerResponse>;
// @public (undocumented)
export function getGitHost(url: string): string;
// @public (undocumented)
export const getGitHubIntegrationConfig: (config: Config, host: string) => GitHubIntegrationConfig;
export const getGitHubIntegrationConfig: (
config: Config,
host: string,
) => GitHubIntegrationConfig;
// @public (undocumented)
export const getGitLabIntegrationConfig: (config: Config, host: string) => GitLabIntegrationConfig;
export const getGitLabIntegrationConfig: (
config: Config,
host: string,
) => GitLabIntegrationConfig;
// @public (undocumented)
export const getGitRepositoryTempFolder: (repositoryUrl: string, config: Config) => Promise<string>;
export const getGitRepositoryTempFolder: (
repositoryUrl: string,
config: Config,
) => Promise<string>;
// @public (undocumented)
export function getGitRepoType(url: string): string;
// @public (undocumented)
export const getLastCommitTimestamp: (repositoryLocation: string, logger: Logger_2) => Promise<number>;
export const getLastCommitTimestamp: (
repositoryLocation: string,
logger: Logger_2,
) => Promise<number>;
// @public (undocumented)
export const getLocationForEntity: (entity: Entity) => ParsedLocationAnnotation;
// @public (undocumented)
export const getTokenForGitRepo: (repositoryUrl: string, config: Config) => Promise<string | undefined>;
export const getTokenForGitRepo: (
repositoryUrl: string,
config: Config,
) => Promise<string | undefined>;
// @public (undocumented)
export type ParsedLocationAnnotation = {
type: RemoteProtocol;
target: string;
type: RemoteProtocol;
target: string;
};
// @public (undocumented)
export const parseReferenceAnnotation: (annotationName: string, entity: Entity) => ParsedLocationAnnotation;
export const parseReferenceAnnotation: (
annotationName: string,
entity: Entity,
) => ParsedLocationAnnotation;
// @public (undocumented)
export type PreparerBase = {
prepare(entity: Entity, options?: {
logger?: Logger_2;
etag?: string;
}): Promise<PreparerResponse>;
prepare(
entity: Entity,
options?: {
logger?: Logger_2;
etag?: string;
},
): Promise<PreparerResponse>;
};
// @public (undocumented)
export type PreparerBuilder = {
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
get(entity: Entity): PreparerBase;
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
get(entity: Entity): PreparerBase;
};
// @public (undocumented)
export class Preparers implements PreparerBuilder {
// (undocumented)
static fromConfig(config: Config, { logger, reader }: factoryOptions): Promise<PreparerBuilder>;
// (undocumented)
get(entity: Entity): PreparerBase;
// (undocumented)
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
// (undocumented)
static fromConfig(
config: Config,
{ logger, reader }: factoryOptions,
): Promise<PreparerBuilder>;
// (undocumented)
get(entity: Entity): PreparerBase;
// (undocumented)
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
}
// @public
export class Publisher {
// (undocumented)
static fromConfig(config: Config, { logger, discovery }: factoryOptions_2): Promise<PublisherBase>;
// (undocumented)
static fromConfig(
config: Config,
{ logger, discovery }: factoryOptions_2,
): Promise<PublisherBase>;
}
// @public
export interface PublisherBase {
docsRouter(): express.Handler;
fetchTechDocsMetadata(entityName: EntityName): Promise<TechDocsMetadata>;
getReadiness(): Promise<ReadinessResponse>;
hasDocsBeenGenerated(entityName: Entity): Promise<boolean>;
publish(request: PublishRequest): Promise<PublishResponse>;
docsRouter(): express.Handler;
fetchTechDocsMetadata(entityName: EntityName): Promise<TechDocsMetadata>;
getReadiness(): Promise<ReadinessResponse>;
hasDocsBeenGenerated(entityName: Entity): Promise<boolean>;
publish(request: PublishRequest): Promise<PublishResponse>;
}
// @public
export type PublisherType = 'local' | 'googleGcs' | 'awsS3' | 'azureBlobStorage' | 'openStackSwift';
export type PublisherType =
| 'local'
| 'googleGcs'
| 'awsS3'
| 'azureBlobStorage'
| 'openStackSwift';
// @public
export type RemoteProtocol = 'url' | 'dir' | 'github' | 'gitlab' | 'file' | 'azure/api';
export type RemoteProtocol =
| 'url'
| 'dir'
| 'github'
| 'gitlab'
| 'file'
| 'azure/api';
// @public (undocumented)
export class TechdocsGenerator implements GeneratorBase {
constructor({ logger, containerRunner, config, }: {
logger: Logger_2;
containerRunner: ContainerRunner;
config: Config;
});
// (undocumented)
run({ inputDir, outputDir, parsedLocationAnnotation, etag, logger: childLogger, logStream, }: GeneratorRunOptions): Promise<void>;
constructor({
logger,
containerRunner,
config,
}: {
logger: Logger_2;
containerRunner: ContainerRunner;
config: Config;
});
// (undocumented)
run({
inputDir,
outputDir,
parsedLocationAnnotation,
etag,
logger: childLogger,
logStream,
}: GeneratorRunOptions): Promise<void>;
}
// @public
export type TechDocsMetadata = {
site_name: string;
site_description: string;
etag: string;
site_name: string;
site_description: string;
etag: string;
};
// @public (undocumented)
export class UrlPreparer implements PreparerBase {
constructor(reader: UrlReader, logger: Logger_2);
// (undocumented)
prepare(entity: Entity, options?: {
etag?: string;
}): Promise<PreparerResponse>;
}
constructor(reader: UrlReader, logger: Logger_2);
// (undocumented)
prepare(
entity: Entity,
options?: {
etag?: string;
},
): Promise<PreparerResponse>;
}
// (No @packageDocumentation comment for this package)
```
packages/techdocs-common/package.json
+1 -1
View File
@@ -48,7 +48,7 @@
"aws-sdk": "^2.840.0",
"cross-fetch": "^3.0.6",
"express": "^4.17.1",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"git-url-parse": "~11.4.4",
"js-yaml": "^4.0.0",
"json5": "^2.1.3",
packages/test-utils-core/api-report.md
+57 -45
View File
@@ -3,7 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { ReactElement } from 'react';
import { RenderResult } from '@testing-library/react';
@@ -12,48 +11,53 @@ export type AsyncLogCollector = () => Promise<void>;
// @public (undocumented)
export type CollectedLogs<T extends LogFuncs> = {
[key in T]: string[];
[key in T]: string[];
};
// @public (undocumented)
export class Keyboard {
constructor(target: any, { debug }?: {
debug?: boolean | undefined;
});
// (undocumented)
click(): Promise<void>;
// (undocumented)
debug: boolean;
// (undocumented)
document: any;
// (undocumented)
enter(value: any): Promise<void>;
// (undocumented)
escape(): Promise<void>;
// (undocumented)
get focused(): any;
// (undocumented)
static fromReadableInput(input: any): any;
// (undocumented)
_log(message: any, ...args: any[]): void;
// (undocumented)
_pretty(element: any): string;
// (undocumented)
send(chars: any): Promise<void>;
// (undocumented)
_sendKey(key: any, charCode: any, action: any): Promise<void>;
// (undocumented)
tab(): Promise<void>;
// (undocumented)
static toReadableInput(chars: any): any;
// (undocumented)
toString(): string;
// (undocumented)
static type(target: any, input: any): Promise<void>;
// (undocumented)
type(input: any): Promise<void>;
// (undocumented)
static typeDebug(target: any, input: any): Promise<void>;
constructor(
target: any,
{
debug,
}?: {
debug?: boolean | undefined;
},
);
// (undocumented)
click(): Promise<void>;
// (undocumented)
debug: boolean;
// (undocumented)
document: any;
// (undocumented)
enter(value: any): Promise<void>;
// (undocumented)
escape(): Promise<void>;
// (undocumented)
get focused(): any;
// (undocumented)
static fromReadableInput(input: any): any;
// (undocumented)
_log(message: any, ...args: any[]): void;
// (undocumented)
_pretty(element: any): string;
// (undocumented)
send(chars: any): Promise<void>;
// (undocumented)
_sendKey(key: any, charCode: any, action: any): Promise<void>;
// (undocumented)
tab(): Promise<void>;
// (undocumented)
static toReadableInput(chars: any): any;
// (undocumented)
toString(): string;
// (undocumented)
static type(target: any, input: any): Promise<void>;
// (undocumented)
type(input: any): Promise<void>;
// (undocumented)
static typeDebug(target: any, input: any): Promise<void>;
}
// @public (undocumented)
@@ -69,18 +73,26 @@ export function renderWithEffects(nodes: ReactElement): Promise<RenderResult>;
export type SyncLogCollector = () => void;
// @public (undocumented)
export function withLogCollector(callback: AsyncLogCollector): Promise<CollectedLogs<LogFuncs>>;
export function withLogCollector(
callback: AsyncLogCollector,
): Promise<CollectedLogs<LogFuncs>>;
// @public (undocumented)
export function withLogCollector(callback: SyncLogCollector): CollectedLogs<LogFuncs>;
export function withLogCollector(
callback: SyncLogCollector,
): CollectedLogs<LogFuncs>;
// @public (undocumented)
export function withLogCollector<T extends LogFuncs>(logsToCollect: T[], callback: AsyncLogCollector): Promise<CollectedLogs<T>>;
export function withLogCollector<T extends LogFuncs>(
logsToCollect: T[],
callback: AsyncLogCollector,
): Promise<CollectedLogs<T>>;
// @public (undocumented)
export function withLogCollector<T extends LogFuncs>(logsToCollect: T[], callback: SyncLogCollector): CollectedLogs<T>;
export function withLogCollector<T extends LogFuncs>(
logsToCollect: T[],
callback: SyncLogCollector,
): CollectedLogs<T>;
// (No @packageDocumentation comment for this package)
```
packages/test-utils/api-report.md
+45 -40
View File
@@ -3,7 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { ComponentType } from 'react';
import { ErrorApi } from '@backstage/core-plugin-api';
import { ErrorContext } from '@backstage/core-plugin-api';
@@ -17,66 +16,72 @@ import { StorageApi } from '@backstage/core-plugin-api';
import { StorageValueChange } from '@backstage/core-plugin-api';
// @public (undocumented)
export function mockBreakpoint(initialBreakpoint?: Breakpoint): {
set(breakpoint: Breakpoint): void;
remove(): void;
export function mockBreakpoint(
initialBreakpoint?: Breakpoint,
): {
set(breakpoint: Breakpoint): void;
remove(): void;
};
// @public (undocumented)
export class MockErrorApi implements ErrorApi {
constructor(options?: Options);
// (undocumented)
error$(): Observable<{
error: Error;
context?: ErrorContext;
}>;
// (undocumented)
getErrors(): ErrorWithContext[];
// (undocumented)
post(error: Error, context?: ErrorContext): void;
// (undocumented)
waitForError(pattern: RegExp, timeoutMs?: number): Promise<ErrorWithContext>;
constructor(options?: Options);
// (undocumented)
error$(): Observable<{
error: Error;
context?: ErrorContext;
}>;
// (undocumented)
getErrors(): ErrorWithContext[];
// (undocumented)
post(error: Error, context?: ErrorContext): void;
// (undocumented)
waitForError(pattern: RegExp, timeoutMs?: number): Promise<ErrorWithContext>;
}
// @public (undocumented)
export class MockStorageApi implements StorageApi {
// (undocumented)
static create(data?: MockStorageBucket): MockStorageApi;
// (undocumented)
forBucket(name: string): StorageApi;
// (undocumented)
get<T>(key: string): T | undefined;
// (undocumented)
observe$<T>(key: string): Observable<StorageValueChange<T>>;
// (undocumented)
remove(key: string): Promise<void>;
// (undocumented)
set<T>(key: string, data: T): Promise<void>;
}
// (undocumented)
static create(data?: MockStorageBucket): MockStorageApi;
// (undocumented)
forBucket(name: string): StorageApi;
// (undocumented)
get<T>(key: string): T | undefined;
// (undocumented)
observe$<T>(key: string): Observable<StorageValueChange<T>>;
// (undocumented)
remove(key: string): Promise<void>;
// (undocumented)
set<T>(key: string, data: T): Promise<void>;
}
// @public (undocumented)
export type MockStorageBucket = {
[key: string]: any;
[key: string]: any;
};
// @public (undocumented)
export const msw: {
setupDefaultHandlers: (worker: {
listen: (t: any) => void;
close: () => void;
resetHandlers: () => void;
}) => void;
setupDefaultHandlers: (worker: {
listen: (t: any) => void;
close: () => void;
resetHandlers: () => void;
}) => void;
};
// @public
export function renderInTestApp(Component: ComponentType | ReactNode, options?: TestAppOptions): Promise<RenderResult>;
export function renderInTestApp(
Component: ComponentType | ReactNode,
options?: TestAppOptions,
): Promise<RenderResult>;
// @public
export function wrapInTestApp(Component: ComponentType | ReactNode, options?: TestAppOptions): ReactElement;
export function wrapInTestApp(
Component: ComponentType | ReactNode,
options?: TestAppOptions,
): ReactElement;
export * from "@backstage/test-utils-core";
export * from '@backstage/test-utils-core';
// (No @packageDocumentation comment for this package)
```
packages/theme/api-report.md
+23 -24
View File
@@ -3,7 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { Overrides } from '@material-ui/core/styles/overrides';
import { Palette } from '@material-ui/core/styles/createPalette';
import { PaletteOptions } from '@material-ui/core/styles/createPalette';
@@ -18,22 +17,22 @@ export type BackstagePaletteOptions = PaletteOptions & PaletteAdditions;
// @public (undocumented)
export interface BackstageTheme extends Theme {
// (undocumented)
getPageTheme: ({ themeId }: PageThemeSelector) => PageTheme;
// (undocumented)
page: PageTheme;
// (undocumented)
palette: BackstagePalette;
// (undocumented)
getPageTheme: ({ themeId }: PageThemeSelector) => PageTheme;
// (undocumented)
page: PageTheme;
// (undocumented)
palette: BackstagePalette;
}
// @public (undocumented)
export interface BackstageThemeOptions extends ThemeOptions {
// (undocumented)
getPageTheme: ({ themeId }: PageThemeSelector) => PageTheme;
// (undocumented)
page: PageTheme;
// (undocumented)
palette: BackstagePaletteOptions;
// (undocumented)
getPageTheme: ({ themeId }: PageThemeSelector) => PageTheme;
// (undocumented)
page: PageTheme;
// (undocumented)
palette: BackstagePaletteOptions;
}
// @public (undocumented)
@@ -43,7 +42,9 @@ export const colorVariants: Record<string, string[]>;
export function createTheme(options: SimpleThemeOptions): BackstageTheme;
// @public (undocumented)
export function createThemeOptions(options: SimpleThemeOptions): BackstageThemeOptions;
export function createThemeOptions(
options: SimpleThemeOptions,
): BackstageThemeOptions;
// @public (undocumented)
export function createThemeOverrides(theme: BackstageTheme): Overrides;
@@ -59,9 +60,9 @@ export const lightTheme: BackstageTheme;
// @public (undocumented)
export type PageTheme = {
colors: string[];
shape: string;
backgroundImage: string;
colors: string[];
shape: string;
backgroundImage: string;
};
// @public (undocumented)
@@ -69,7 +70,7 @@ export const pageTheme: Record<string, PageTheme>;
// @public (undocumented)
export type PageThemeSelector = {
themeId: string;
themeId: string;
};
// @public (undocumented)
@@ -77,13 +78,11 @@ export const shapes: Record<string, string>;
// @public
export type SimpleThemeOptions = {
palette: BackstagePaletteOptions;
defaultPageTheme: string;
pageTheme?: Record<string, PageTheme>;
fontFamily?: string;
palette: BackstagePaletteOptions;
defaultPageTheme: string;
pageTheme?: Record<string, PageTheme>;
fontFamily?: string;
};
// (No @packageDocumentation comment for this package)
```