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

chore: api-reports and breaking changeset

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2023-02-07 13:32:54 +01:00
parent 6f1f2e9451
commit 4ae71b7f2e
2 changed files with 36 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/short-apes-relate.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-app-api': minor
---
**BREAKING** Renaming `*Factory` exports to `*ServiceFactory` instead. For example `configFactory` now is exported as `configServiceFactory`.
packages/backend-app-api/api-report.md
+31 -31
View File
@@ -50,12 +50,7 @@ export interface Backend {
}
// @public (undocumented)
export const cacheFactory: () => ServiceFactory<PluginCacheManager>;
// @public (undocumented)
export const configFactory: (
options?: ConfigFactoryOptions | undefined,
) => ServiceFactory<ConfigService>;
export const cacheServiceFactory: () => ServiceFactory<PluginCacheManager>;
// @public (undocumented)
export interface ConfigFactoryOptions {
@@ -63,6 +58,11 @@ export interface ConfigFactoryOptions {
remote?: LoadConfigOptionsRemote;
}
// @public (undocumented)
export const configServiceFactory: (
options?: ConfigFactoryOptions | undefined,
) => ServiceFactory<ConfigService>;
// @public (undocumented)
export function createConfigSecretEnumerator(options: {
logger: LoggerService;
@@ -90,7 +90,7 @@ export interface CreateSpecializedBackendOptions {
}
// @public (undocumented)
export const databaseFactory: () => ServiceFactory<PluginDatabaseManager>;
export const databaseServiceFactory: () => ServiceFactory<PluginDatabaseManager>;
// @public
export class DefaultRootHttpRouter implements RootHttpRouterService {
@@ -108,7 +108,7 @@ export interface DefaultRootHttpRouterOptions {
}
// @public (undocumented)
export const discoveryFactory: () => ServiceFactory<PluginEndpointDiscovery>;
export const discoveryServiceFactory: () => ServiceFactory<PluginEndpointDiscovery>;
// @public
export interface ExtendedHttpServer extends http.Server {
@@ -120,16 +120,16 @@ export interface ExtendedHttpServer extends http.Server {
stop(): Promise<void>;
}
// @public (undocumented)
export const httpRouterFactory: (
options?: HttpRouterFactoryOptions | undefined,
) => ServiceFactory<HttpRouterService>;
// @public (undocumented)
export interface HttpRouterFactoryOptions {
getPath?(pluginId: string): string;
}
// @public (undocumented)
export const httpRouterServiceFactory: (
options?: HttpRouterFactoryOptions | undefined,
) => ServiceFactory<HttpRouterService>;
// @public
export type HttpServerCertificateOptions =
| {
@@ -153,19 +153,19 @@ export type HttpServerOptions = {
};
};
// @public (undocumented)
export const identityFactory: (
options?: IdentityFactoryOptions | undefined,
) => ServiceFactory<IdentityService>;
// @public
export type IdentityFactoryOptions = {
issuer?: string;
algorithms?: string[];
};
// @public (undocumented)
export const identityServiceFactory: (
options?: IdentityFactoryOptions | undefined,
) => ServiceFactory<IdentityService>;
// @public
export const lifecycleFactory: () => ServiceFactory<LifecycleService>;
export const lifecycleServiceFactory: () => ServiceFactory<LifecycleService>;
// @public
export function loadBackendConfig(options: {
@@ -176,7 +176,7 @@ export function loadBackendConfig(options: {
}>;
// @public (undocumented)
export const loggerFactory: () => ServiceFactory<LoggerService>;
export const loggerServiceFactory: () => ServiceFactory<LoggerService>;
// @public
export class MiddlewareFactory {
@@ -204,7 +204,7 @@ export interface MiddlewareFactoryOptions {
}
// @public (undocumented)
export const permissionsFactory: () => ServiceFactory<PermissionsService>;
export const permissionsServiceFactory: () => ServiceFactory<PermissionsService>;
// @public
export function readCorsOptions(config?: Config): CorsOptions;
@@ -231,25 +231,25 @@ export interface RootHttpRouterConfigureOptions {
routes: RequestHandler;
}
// @public (undocumented)
export const rootHttpRouterFactory: (
options?: RootHttpRouterFactoryOptions | undefined,
) => ServiceFactory<RootHttpRouterService>;
// @public (undocumented)
export type RootHttpRouterFactoryOptions = {
indexPath?: string | false;
configure?(options: RootHttpRouterConfigureOptions): void;
};
// @public (undocumented)
export const rootHttpRouterServiceFactory: (
options?: RootHttpRouterFactoryOptions | undefined,
) => ServiceFactory<RootHttpRouterService>;
// @public
export const rootLifecycleFactory: () => ServiceFactory<RootLifecycleService>;
export const rootLifecycleServiceFactory: () => ServiceFactory<RootLifecycleService>;
// @public (undocumented)
export const rootLoggerFactory: () => ServiceFactory<RootLoggerService>;
export const rootLoggerServiceFactory: () => ServiceFactory<RootLoggerService>;
// @public (undocumented)
export const schedulerFactory: () => ServiceFactory<SchedulerService>;
export const schedulerServiceFactory: () => ServiceFactory<SchedulerService>;
// @public (undocumented)
export type ServiceOrExtensionPoint<T = unknown> =
@@ -257,10 +257,10 @@ export type ServiceOrExtensionPoint<T = unknown> =
| ServiceRef<T>;
// @public (undocumented)
export const tokenManagerFactory: () => ServiceFactory<TokenManagerService>;
export const tokenManagerServiceFactory: () => ServiceFactory<TokenManagerService>;
// @public (undocumented)
export const urlReaderFactory: () => ServiceFactory<UrlReader>;
export const urlReaderServiceFactory: () => ServiceFactory<UrlReader>;
// @public
export class WinstonLogger implements RootLoggerService {