docs: added generated files

Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
This commit is contained in:
Rogerio Angeliski
2021-07-05 21:21:00 -03:00
parent 944640535a
commit 7a74046f16
17 changed files with 50 additions and 50 deletions
+5 -5
View File
@@ -19,7 +19,7 @@ import * as http from 'http';
import { isChildPath } from '@backstage/cli-common';
import { JsonValue } from '@backstage/config';
import { Knex } from 'knex';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { MergeResult } from 'isomorphic-git';
import { PushResult } from 'isomorphic-git';
import { Readable } from 'stream';
@@ -129,7 +129,7 @@ export function errorHandler(options?: ErrorHandlerOptions): ErrorRequestHandler
// @public (undocumented)
export type ErrorHandlerOptions = {
showStackTraces?: boolean;
logger?: Logger;
logger?: Logger_2;
logClientErrors?: boolean;
};
@@ -185,7 +185,7 @@ export class Git {
static fromAuth: ({ username, password, logger, }: {
username?: string | undefined;
password?: string | undefined;
logger?: Logger | undefined;
logger?: Logger_2 | undefined;
}) => Git;
// (undocumented)
init({ dir, defaultBranch, }: {
@@ -301,7 +301,7 @@ export type ReadTreeResponseFile = {
};
// @public
export function requestLoggingHandler(logger?: Logger): RequestHandler;
export function requestLoggingHandler(logger?: Logger_2): RequestHandler;
// @public
export function resolvePackagePath(name: string, ...paths: string[]): string;
@@ -337,7 +337,7 @@ export type ServiceBuilder = {
loadConfig(config: ConfigReader): ServiceBuilder;
setPort(port: number): ServiceBuilder;
setHost(host: string): ServiceBuilder;
setLogger(logger: Logger): ServiceBuilder;
setLogger(logger: Logger_2): ServiceBuilder;
enableCors(options: cors.CorsOptions): ServiceBuilder;
setHttpsSettings(settings: HttpsSettings): ServiceBuilder;
addRouter(root: string, router: Router | RequestHandler): ServiceBuilder;
+10 -10
View File
@@ -12,17 +12,17 @@ import { EntityName } from '@backstage/catalog-model';
import express from 'express';
import { GitHubIntegrationConfig } from '@backstage/integration';
import { GitLabIntegrationConfig } from '@backstage/integration';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { UrlReader } from '@backstage/backend-common';
import { Writable } from 'stream';
// @public (undocumented)
export const checkoutGitRepository: (repoUrl: string, config: Config, logger: Logger) => 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);
constructor(config: Config, logger: Logger_2);
// (undocumented)
prepare(entity: Entity, options?: {
etag?: string;
@@ -31,7 +31,7 @@ export class CommonGitPreparer implements PreparerBase {
// @public (undocumented)
export class DirectoryPreparer implements PreparerBase {
constructor(config: Config, logger: Logger, reader: UrlReader);
constructor(config: Config, logger: Logger_2, reader: UrlReader);
// (undocumented)
prepare(entity: Entity): Promise<PreparerResponse>;
}
@@ -51,7 +51,7 @@ export type GeneratorBuilder = {
export class Generators implements GeneratorBuilder {
// (undocumented)
static fromConfig(config: Config, { logger, containerRunner, }: {
logger: Logger;
logger: Logger_2;
containerRunner: ContainerRunner;
}): Promise<GeneratorBuilder>;
// (undocumented)
@@ -69,7 +69,7 @@ export const getDefaultBranch: (repositoryUrl: string, config: Config) => Promis
// @public (undocumented)
export const getDocFilesFromRepository: (reader: UrlReader, entity: Entity, opts?: {
etag?: string | undefined;
logger?: Logger | undefined;
logger?: Logger_2 | undefined;
} | undefined) => Promise<PreparerResponse>;
// @public (undocumented)
@@ -88,7 +88,7 @@ export const getGitRepositoryTempFolder: (repositoryUrl: string, config: Config)
export function getGitRepoType(url: string): string;
// @public (undocumented)
export const getLastCommitTimestamp: (repositoryLocation: string, logger: Logger) => Promise<number>;
export const getLastCommitTimestamp: (repositoryLocation: string, logger: Logger_2) => Promise<number>;
// @public (undocumented)
export const getLocationForEntity: (entity: Entity) => ParsedLocationAnnotation;
@@ -108,7 +108,7 @@ export const parseReferenceAnnotation: (annotationName: string, entity: Entity)
// @public (undocumented)
export type PreparerBase = {
prepare(entity: Entity, options?: {
logger?: Logger;
logger?: Logger_2;
etag?: string;
}): Promise<PreparerResponse>;
};
@@ -153,7 +153,7 @@ export type RemoteProtocol = 'url' | 'dir' | 'github' | 'gitlab' | 'file' | 'azu
// @public (undocumented)
export class TechdocsGenerator implements GeneratorBase {
constructor({ logger, containerRunner, config, }: {
logger: Logger;
logger: Logger_2;
containerRunner: ContainerRunner;
config: Config;
});
@@ -170,7 +170,7 @@ export type TechDocsMetadata = {
// @public (undocumented)
export class UrlPreparer implements PreparerBase {
constructor(reader: UrlReader, logger: Logger);
constructor(reader: UrlReader, logger: Logger_2);
// (undocumented)
prepare(entity: Entity, options?: {
etag?: string;
+2 -2
View File
@@ -6,7 +6,7 @@
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
@@ -18,7 +18,7 @@ export interface RouterOptions {
config: Config;
disableConfigInjection?: boolean;
// (undocumented)
logger: Logger;
logger: Logger_2;
staticFallbackHandler?: express.Handler;
}
+3 -3
View File
@@ -9,7 +9,7 @@ import { Config } from '@backstage/config';
import { Entity } from '@backstage/catalog-model';
import express from 'express';
import { JSONWebKey } from 'jose';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { Profile } from 'passport';
@@ -23,7 +23,7 @@ export type AuthProviderFactoryOptions = {
providerId: string;
globalConfig: AuthProviderConfig;
config: Config;
logger: Logger;
logger: Logger_2;
tokenIssuer: TokenIssuer;
discovery: PluginEndpointDiscovery;
catalogApi: CatalogApi;
@@ -206,7 +206,7 @@ export interface RouterOptions {
// (undocumented)
discovery: PluginEndpointDiscovery;
// (undocumented)
logger: Logger;
logger: Logger_2;
// (undocumented)
providerFactories?: ProviderFactories;
}
@@ -11,7 +11,7 @@ import { Config } from '@backstage/config';
import { GroupEntity } from '@backstage/catalog-model';
import { JsonValue } from '@backstage/config';
import { LocationSpec } from '@backstage/catalog-model';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { SearchEntry } from 'ldapjs';
import { SearchOptions } from 'ldapjs';
import { UserEntity } from '@backstage/catalog-model';
@@ -38,7 +38,7 @@ export const LDAP_UUID_ANNOTATION = "backstage.io/ldap-uuid";
export class LdapClient {
constructor(client: Client);
// (undocumented)
static create(logger: Logger, target: string, bind?: BindConfig): Promise<LdapClient>;
static create(logger: Logger_2, target: string, bind?: BindConfig): Promise<LdapClient>;
getRootDSE(): Promise<SearchEntry | undefined>;
getVendor(): Promise<LdapVendor>;
search(dn: string, options: SearchOptions): Promise<SearchEntry[]>;
@@ -48,13 +48,13 @@ export class LdapClient {
export class LdapOrgReaderProcessor implements CatalogProcessor {
constructor(options: {
providers: LdapProviderConfig[];
logger: Logger;
logger: Logger_2;
groupTransformer?: GroupTransformer;
userTransformer?: UserTransformer;
});
// (undocumented)
static fromConfig(config: Config, options: {
logger: Logger;
logger: Logger_2;
groupTransformer?: GroupTransformer;
userTransformer?: UserTransformer;
}): LdapOrgReaderProcessor;
@@ -80,7 +80,7 @@ export function readLdapConfig(config: Config): LdapProviderConfig[];
export function readLdapOrg(client: LdapClient, userConfig: UserConfig, groupConfig: GroupConfig, options: {
groupTransformer?: GroupTransformer;
userTransformer?: UserTransformer;
logger: Logger;
logger: Logger_2;
}): Promise<{
users: UserEntity[];
groups: GroupEntity[];
@@ -9,7 +9,7 @@ import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
import { Config } from '@backstage/config';
import { GroupEntity } from '@backstage/catalog-model';
import { LocationSpec } from '@backstage/catalog-model';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import * as MicrosoftGraph from '@microsoft/microsoft-graph-types';
import * as msal from '@azure/msal-node';
import { UserEntity } from '@backstage/catalog-model';
@@ -70,12 +70,12 @@ export class MicrosoftGraphClient {
export class MicrosoftGraphOrgReaderProcessor implements CatalogProcessor {
constructor(options: {
providers: MicrosoftGraphProviderConfig[];
logger: Logger;
logger: Logger_2;
groupTransformer?: GroupTransformer;
});
// (undocumented)
static fromConfig(config: Config, options: {
logger: Logger;
logger: Logger_2;
groupTransformer?: GroupTransformer;
}): MicrosoftGraphOrgReaderProcessor;
// (undocumented)
@@ -107,7 +107,7 @@ export function readMicrosoftGraphOrg(client: MicrosoftGraphClient, tenantId: st
userFilter?: string;
groupFilter?: string;
groupTransformer?: GroupTransformer;
logger: Logger;
logger: Logger_2;
}): Promise<{
users: UserEntity[];
groups: GroupEntity[];
+2 -2
View File
@@ -6,7 +6,7 @@
import { Config } from '@backstage/config';
import { GraphQLModule } from '@graphql-modules/core';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
// @public (undocumented)
export function createModule(options: ModuleOptions): Promise<GraphQLModule>;
@@ -16,7 +16,7 @@ export interface ModuleOptions {
// (undocumented)
config: Config;
// (undocumented)
logger: Logger;
logger: Logger_2;
}
+2 -2
View File
@@ -6,7 +6,7 @@
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { UrlReader } from '@backstage/backend-common';
@@ -32,7 +32,7 @@ export interface RouterOptions {
// (undocumented)
discovery: PluginEndpointDiscovery;
// (undocumented)
logger: Logger;
logger: Logger_2;
// (undocumented)
urlReader: UrlReader;
}
+2 -2
View File
@@ -6,7 +6,7 @@
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
@@ -16,7 +16,7 @@ export interface RouterOptions {
// (undocumented)
config: Config;
// (undocumented)
logger: Logger;
logger: Logger_2;
}
+1 -1
View File
@@ -6,7 +6,7 @@
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
+3 -3
View File
@@ -9,7 +9,7 @@ import express from 'express';
import { FetchResponse } from '@backstage/plugin-kubernetes-common';
import { KubernetesFetchError } from '@backstage/plugin-kubernetes-common';
import { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
// @public (undocumented)
export interface ClusterDetails {
@@ -68,7 +68,7 @@ export interface KubernetesServiceLocator {
}
// @public (undocumented)
export const makeRouter: (logger: Logger, kubernetesFanOutHandler: KubernetesFanOutHandler, clusterDetails: ClusterDetails[]) => express.Router;
export const makeRouter: (logger: Logger_2, kubernetesFanOutHandler: KubernetesFanOutHandler, clusterDetails: ClusterDetails[]) => express.Router;
// @public (undocumented)
export interface ObjectFetchParams {
@@ -91,7 +91,7 @@ export interface RouterOptions {
// (undocumented)
config: Config;
// (undocumented)
logger: Logger;
logger: Logger_2;
}
// @public (undocumented)
+1 -1
View File
@@ -6,7 +6,7 @@
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
// @public (undocumented)
+3 -3
View File
@@ -6,7 +6,7 @@
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
@@ -20,7 +20,7 @@ export function getRequestHeaders(token: string): {
// @public (undocumented)
export class RollbarApi {
constructor(accessToken: string, logger: Logger);
constructor(accessToken: string, logger: Logger_2);
// (undocumented)
getActivatedCounts(projectName: string, options?: {
environment: string;
@@ -49,7 +49,7 @@ export interface RouterOptions {
// (undocumented)
config: Config;
// (undocumented)
logger: Logger;
logger: Logger_2;
// (undocumented)
rollbarApi?: RollbarApi;
}
+4 -4
View File
@@ -7,7 +7,7 @@
import { DocumentCollator } from '@backstage/search-common';
import { DocumentDecorator } from '@backstage/search-common';
import { IndexableDocument } from '@backstage/search-common';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { default as lunr_2 } from 'lunr';
import { SearchQuery } from '@backstage/search-common';
import { SearchResultSet } from '@backstage/search-common';
@@ -27,14 +27,14 @@ export class IndexBuilder {
// @public (undocumented)
export class LunrSearchEngine implements SearchEngine {
constructor({ logger }: {
logger: Logger;
logger: Logger_2;
});
// (undocumented)
protected docStore: Record<string, IndexableDocument>;
// (undocumented)
index(type: string, documents: IndexableDocument[]): void;
// (undocumented)
protected logger: Logger;
protected logger: Logger_2;
// (undocumented)
protected lunrIndices: Record<string, lunr_2.Index>;
// (undocumented)
@@ -48,7 +48,7 @@ export class LunrSearchEngine implements SearchEngine {
// @public
export class Scheduler {
constructor({ logger }: {
logger: Logger;
logger: Logger_2;
});
addToSchedule(task: Function, interval: number): void;
start(): void;
+1 -1
View File
@@ -5,7 +5,7 @@
```ts
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { SearchEngine } from '@backstage/plugin-search-backend-node';
// @public (undocumented)
+1 -1
View File
@@ -8,7 +8,7 @@ import { Config } from '@backstage/config';
import express from 'express';
import { GeneratorBuilder } from '@backstage/techdocs-common';
import { Knex } from 'knex';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { PreparerBuilder } from '@backstage/techdocs-common';
import { PublisherBase } from '@backstage/techdocs-common';
+1 -1
View File
@@ -8,7 +8,7 @@ import { CatalogApi } from '@backstage/catalog-client';
import { Config } from '@backstage/config';
import { EntityName } from '@backstage/catalog-model';
import express from 'express';
import { Logger } from 'winston';
import { Logger as Logger_2 } from 'winston';
import { ScmIntegrations } from '@backstage/integration';
import { UrlReader } from '@backstage/backend-common';