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

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
119 changed files with 9860 additions and 5109 deletions
+93 -64
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 { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
@@ -16,14 +17,19 @@ import { Location as Location_2 } from '@backstage/catalog-model';
import { RouteRef } from '@backstage/core-plugin-api';
// @public (undocumented)
export const DocsCardGrid: ({ entities, }: {
entities: Entity[] | undefined;
export const DocsCardGrid: ({
entities,
}: {
entities: Entity[] | undefined;
}) => JSX.Element | null;
// @public (undocumented)
export const DocsTable: ({ entities, title, }: {
entities: Entity[] | undefined;
title?: string | undefined;
export const DocsTable: ({
entities,
title,
}: {
entities: Entity[] | undefined;
title?: string | undefined;
}) => JSX.Element | null;
// @public (undocumented)
@@ -31,7 +37,7 @@ export const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
// @public (undocumented)
export const EntityTechdocsContent: (_props: {
entity?: Entity| undefined;
entity?: Entity | undefined;
}) => JSX.Element;
// @public (undocumented)
@@ -48,12 +54,12 @@ export type SyncResult = 'cached' | 'updated';
// @public (undocumented)
export interface TechDocsApi {
// (undocumented)
getApiOrigin(): Promise<string>;
// (undocumented)
getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
// (undocumented)
getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
// (undocumented)
getApiOrigin(): Promise<string>;
// (undocumented)
getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
// (undocumented)
getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
}
// @public (undocumented)
@@ -61,58 +67,72 @@ export const techdocsApiRef: ApiRef<TechDocsApi>;
// @public
export class TechDocsClient implements TechDocsApi {
constructor({ configApi, discoveryApi, identityApi, }: {
configApi: Config;
discoveryApi: DiscoveryApi;
identityApi: IdentityApi;
});
// (undocumented)
constructor({
configApi,
discoveryApi,
identityApi,
}: {
configApi: Config;
// (undocumented)
discoveryApi: DiscoveryApi;
// (undocumented)
getApiOrigin(): Promise<string>;
getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
// (undocumented)
identityApi: IdentityApi;
});
// (undocumented)
configApi: Config;
// (undocumented)
discoveryApi: DiscoveryApi;
// (undocumented)
getApiOrigin(): Promise<string>;
getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
// (undocumented)
identityApi: IdentityApi;
}
// @public (undocumented)
export const TechDocsCustomHome: ({ tabsConfig, }: {
tabsConfig: TabsConfig;
export const TechDocsCustomHome: ({
tabsConfig,
}: {
tabsConfig: TabsConfig;
}) => JSX.Element;
// @public (undocumented)
export const TechdocsPage: () => JSX.Element;
// @public (undocumented)
const techdocsPlugin: BackstagePlugin<{
const techdocsPlugin: BackstagePlugin<
{
root: RouteRef<undefined>;
entityContent: RouteRef<undefined>;
}, {}>;
export { techdocsPlugin as plugin }
export { techdocsPlugin }
},
{}
>;
export { techdocsPlugin as plugin };
export { techdocsPlugin };
// @public (undocumented)
export const TechDocsReaderPage: () => JSX.Element;
// @public (undocumented)
export interface TechDocsStorageApi {
// (undocumented)
getApiOrigin(): Promise<string>;
// (undocumented)
getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
// (undocumented)
getBuilder(): Promise<string>;
// (undocumented)
getEntityDocs(entityId: EntityName, path: string): Promise<string>;
// (undocumented)
getStorageUrl(): Promise<string>;
// (undocumented)
syncEntityDocs(entityId: EntityName, logHandler?: (line: string) => void): Promise<SyncResult>;
// (undocumented)
getApiOrigin(): Promise<string>;
// (undocumented)
getBaseUrl(
oldBaseUrl: string,
entityId: EntityName,
path: string,
): Promise<string>;
// (undocumented)
getBuilder(): Promise<string>;
// (undocumented)
getEntityDocs(entityId: EntityName, path: string): Promise<string>;
// (undocumented)
getStorageUrl(): Promise<string>;
// (undocumented)
syncEntityDocs(
entityId: EntityName,
logHandler?: (line: string) => void,
): Promise<SyncResult>;
}
// @public (undocumented)
@@ -120,30 +140,39 @@ export const techdocsStorageApiRef: ApiRef<TechDocsStorageApi>;
// @public
export class TechDocsStorageClient implements TechDocsStorageApi {
constructor({ configApi, discoveryApi, identityApi, }: {
configApi: Config;
discoveryApi: DiscoveryApi;
identityApi: IdentityApi;
});
// (undocumented)
constructor({
configApi,
discoveryApi,
identityApi,
}: {
configApi: Config;
// (undocumented)
discoveryApi: DiscoveryApi;
// (undocumented)
getApiOrigin(): Promise<string>;
// (undocumented)
getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
// (undocumented)
getBuilder(): Promise<string>;
getEntityDocs(entityId: EntityName, path: string): Promise<string>;
// (undocumented)
getStorageUrl(): Promise<string>;
// (undocumented)
identityApi: IdentityApi;
syncEntityDocs(entityId: EntityName, logHandler?: (line: string) => void): Promise<SyncResult>;
});
// (undocumented)
configApi: Config;
// (undocumented)
discoveryApi: DiscoveryApi;
// (undocumented)
getApiOrigin(): Promise<string>;
// (undocumented)
getBaseUrl(
oldBaseUrl: string,
entityId: EntityName,
path: string,
): Promise<string>;
// (undocumented)
getBuilder(): Promise<string>;
getEntityDocs(entityId: EntityName, path: string): Promise<string>;
// (undocumented)
getStorageUrl(): Promise<string>;
// (undocumented)
identityApi: IdentityApi;
syncEntityDocs(
entityId: EntityName,
logHandler?: (line: string) => void,
): Promise<SyncResult>;
}
// (No @packageDocumentation comment for this package)
```