diff --git a/packages/backend-app-api/api-report.md b/packages/backend-app-api/api-report.md index ef88d9a9d0..fa3f3bec2e 100644 --- a/packages/backend-app-api/api-report.md +++ b/packages/backend-app-api/api-report.md @@ -4,19 +4,21 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -import { Config } from '@backstage/config'; +import { CacheService } from '@backstage/backend-plugin-api'; +import { ConfigService } from '@backstage/backend-plugin-api'; +import { DatabaseService } from '@backstage/backend-plugin-api'; import { ExtensionPoint } from '@backstage/backend-plugin-api'; import { HttpRouterService } from '@backstage/backend-plugin-api'; import { LifecycleService } from '@backstage/backend-plugin-api'; import { LoggerService } from '@backstage/backend-plugin-api'; import { PermissionsService } from '@backstage/backend-plugin-api'; -import { PluginCacheManager } from '@backstage/backend-common'; -import { PluginDatabaseManager } from '@backstage/backend-common'; import { PluginEndpointDiscovery } from '@backstage/backend-common'; -import { PluginTaskScheduler } from '@backstage/backend-tasks'; +import { RootLifecycleService } from '@backstage/backend-plugin-api'; +import { RootLoggerService } from '@backstage/backend-plugin-api'; +import { SchedulerService } from '@backstage/backend-plugin-api'; import { ServiceFactory } from '@backstage/backend-plugin-api'; import { ServiceRef } from '@backstage/backend-plugin-api'; -import { TokenManager } from '@backstage/backend-common'; +import { TokenManagerService } from '@backstage/backend-plugin-api'; import { UrlReader } from '@backstage/backend-common'; // @public (undocumented) @@ -32,10 +34,12 @@ export interface Backend { // @public (undocumented) export const cacheFactory: ( options?: undefined, -) => ServiceFactory; +) => ServiceFactory; // @public (undocumented) -export const configFactory: (options?: undefined) => ServiceFactory; +export const configFactory: ( + options?: undefined, +) => ServiceFactory; // @public (undocumented) export function createSpecializedBackend( @@ -51,7 +55,7 @@ export interface CreateSpecializedBackendOptions { // @public (undocumented) export const databaseFactory: ( options?: undefined, -) => ServiceFactory; +) => ServiceFactory; // @public (undocumented) export const discoveryFactory: ( @@ -86,17 +90,17 @@ export const permissionsFactory: ( // @public export const rootLifecycleFactory: ( options?: undefined, -) => ServiceFactory; +) => ServiceFactory; // @public (undocumented) export const rootLoggerFactory: ( options?: undefined, -) => ServiceFactory; +) => ServiceFactory; // @public (undocumented) export const schedulerFactory: ( options?: undefined, -) => ServiceFactory; +) => ServiceFactory; // @public (undocumented) export type ServiceOrExtensionPoint = @@ -106,7 +110,7 @@ export type ServiceOrExtensionPoint = // @public (undocumented) export const tokenManagerFactory: ( options?: undefined, -) => ServiceFactory; +) => ServiceFactory; // @public (undocumented) export const urlReaderFactory: ( diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md index 7176fd2d19..9c6ffe6dd5 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.md @@ -8,7 +8,6 @@ import { Config } from '@backstage/config'; import { Handler } from 'express'; import { Logger } from 'winston'; -import { PermissionAuthorizer } from '@backstage/plugin-permission-common'; import { PermissionEvaluator } from '@backstage/plugin-permission-common'; import { PluginCacheManager } from '@backstage/backend-common'; import { PluginDatabaseManager } from '@backstage/backend-common'; @@ -67,26 +66,26 @@ export interface BackendRegistrationPoints { } // @public (undocumented) -export type CacheService = PluginCacheManager; +export interface CacheService extends PluginCacheManager {} // @public (undocumented) -export type ConfigService = Config; +export interface ConfigService extends Config {} // @public export namespace coreServices { - const cache: ServiceRef; - const config: ServiceRef; - const database: ServiceRef; + const cache: ServiceRef; + const config: ServiceRef; + const database: ServiceRef; const discovery: ServiceRef; const httpRouter: ServiceRef; const lifecycle: ServiceRef; const logger: ServiceRef; const permissions: ServiceRef; const pluginMetadata: ServiceRef; - const rootLifecycle: ServiceRef; - const rootLogger: ServiceRef; - const scheduler: ServiceRef; - const tokenManager: ServiceRef; + const rootLifecycle: ServiceRef; + const rootLogger: ServiceRef; + const scheduler: ServiceRef; + const tokenManager: ServiceRef; const urlReader: ServiceRef; } @@ -155,13 +154,13 @@ export function createServiceRef(options: { }): ServiceRef; // @public (undocumented) -export type DatabaseService = PluginDatabaseManager; +export interface DatabaseService extends PluginDatabaseManager {} // @public -export type DiscoveryService = { +export interface DiscoveryService { getBaseUrl(pluginId: string): Promise; getExternalBaseUrl(pluginId: string): Promise; -}; +} // @public export type ExtensionPoint = { @@ -214,7 +213,7 @@ export type LogMeta = { }; // @public (undocumented) -export type PermissionsService = PermissionEvaluator | PermissionAuthorizer; +export interface PermissionsService extends PermissionEvaluator {} // @public (undocumented) export interface PluginMetadataService { @@ -267,13 +266,13 @@ export type ReadUrlResponse = { }; // @public (undocumented) -export type RootLifecycleService = LifecycleService; +export interface RootLifecycleService extends LifecycleService {} // @public (undocumented) -export type RootLoggerService = LoggerService; +export interface RootLoggerService extends LoggerService {} // @public (undocumented) -export type SchedulerService = PluginTaskScheduler; +export interface SchedulerService extends PluginTaskScheduler {} // @public export type SearchOptions = { @@ -333,7 +332,7 @@ export type ServiceRef< }; // @public (undocumented) -export type TokenManagerService = TokenManager; +export interface TokenManagerService extends TokenManager {} // @public (undocumented) export type TypesToServiceRef = { @@ -341,9 +340,9 @@ export type TypesToServiceRef = { }; // @public -export type UrlReaderService = { - readUrl(url: string, options?: ReadUrlOptions): Promise; +export interface UrlReaderService { readTree(url: string, options?: ReadTreeOptions): Promise; + readUrl(url: string, options?: ReadUrlOptions): Promise; search(url: string, options?: SearchOptions): Promise; -}; +} ``` diff --git a/packages/backend-plugin-api/src/services/definitions/CacheService.ts b/packages/backend-plugin-api/src/services/definitions/CacheService.ts index 3311816410..79c930f435 100644 --- a/packages/backend-plugin-api/src/services/definitions/CacheService.ts +++ b/packages/backend-plugin-api/src/services/definitions/CacheService.ts @@ -17,4 +17,4 @@ import { PluginCacheManager } from '@backstage/backend-common'; /** @public */ -export type CacheService = PluginCacheManager; +export interface CacheService extends PluginCacheManager {} diff --git a/packages/backend-plugin-api/src/services/definitions/ConfigService.ts b/packages/backend-plugin-api/src/services/definitions/ConfigService.ts index 4b57e617fc..db9aa88dda 100644 --- a/packages/backend-plugin-api/src/services/definitions/ConfigService.ts +++ b/packages/backend-plugin-api/src/services/definitions/ConfigService.ts @@ -19,4 +19,4 @@ import { Config } from '@backstage/config'; /** * @public */ -export type ConfigService = Config; +export interface ConfigService extends Config {} diff --git a/packages/backend-plugin-api/src/services/definitions/DatabaseService.ts b/packages/backend-plugin-api/src/services/definitions/DatabaseService.ts index afb3081a78..30f1f574f2 100644 --- a/packages/backend-plugin-api/src/services/definitions/DatabaseService.ts +++ b/packages/backend-plugin-api/src/services/definitions/DatabaseService.ts @@ -17,4 +17,4 @@ import { PluginDatabaseManager } from '@backstage/backend-common'; /** @public */ -export type DatabaseService = PluginDatabaseManager; +export interface DatabaseService extends PluginDatabaseManager {} diff --git a/packages/backend-plugin-api/src/services/definitions/DiscoveryService.ts b/packages/backend-plugin-api/src/services/definitions/DiscoveryService.ts index dec61ab56f..c3f0820c28 100644 --- a/packages/backend-plugin-api/src/services/definitions/DiscoveryService.ts +++ b/packages/backend-plugin-api/src/services/definitions/DiscoveryService.ts @@ -28,7 +28,7 @@ * * @public */ -export type DiscoveryService = { +export interface DiscoveryService { /** * Returns the internal HTTP base URL for a given plugin, without a trailing slash. * @@ -60,4 +60,4 @@ export type DiscoveryService = { * like `https://backstage.example.com/api/catalog` */ getExternalBaseUrl(pluginId: string): Promise; -}; +} diff --git a/packages/backend-plugin-api/src/services/definitions/PermissionsService.ts b/packages/backend-plugin-api/src/services/definitions/PermissionsService.ts index 0a3c045ea7..5847f55ee6 100644 --- a/packages/backend-plugin-api/src/services/definitions/PermissionsService.ts +++ b/packages/backend-plugin-api/src/services/definitions/PermissionsService.ts @@ -14,10 +14,7 @@ * limitations under the License. */ -import { - PermissionAuthorizer, - PermissionEvaluator, -} from '@backstage/plugin-permission-common'; +import { PermissionEvaluator } from '@backstage/plugin-permission-common'; /** @public */ -export type PermissionsService = PermissionEvaluator | PermissionAuthorizer; +export interface PermissionsService extends PermissionEvaluator {} diff --git a/packages/backend-plugin-api/src/services/definitions/RootLifecycleService.ts b/packages/backend-plugin-api/src/services/definitions/RootLifecycleService.ts index d97278da88..e0e09cb859 100644 --- a/packages/backend-plugin-api/src/services/definitions/RootLifecycleService.ts +++ b/packages/backend-plugin-api/src/services/definitions/RootLifecycleService.ts @@ -17,4 +17,4 @@ import { LifecycleService } from './LifecycleService'; /** @public */ -export type RootLifecycleService = LifecycleService; +export interface RootLifecycleService extends LifecycleService {} diff --git a/packages/backend-plugin-api/src/services/definitions/RootLoggerService.ts b/packages/backend-plugin-api/src/services/definitions/RootLoggerService.ts index 5fc595d91b..ad318ef53f 100644 --- a/packages/backend-plugin-api/src/services/definitions/RootLoggerService.ts +++ b/packages/backend-plugin-api/src/services/definitions/RootLoggerService.ts @@ -17,4 +17,4 @@ import { LoggerService } from './LoggerService'; /** @public */ -export type RootLoggerService = LoggerService; +export interface RootLoggerService extends LoggerService {} diff --git a/packages/backend-plugin-api/src/services/definitions/SchedulerService.ts b/packages/backend-plugin-api/src/services/definitions/SchedulerService.ts index f47e67596b..07c436bd6b 100644 --- a/packages/backend-plugin-api/src/services/definitions/SchedulerService.ts +++ b/packages/backend-plugin-api/src/services/definitions/SchedulerService.ts @@ -17,4 +17,4 @@ import { PluginTaskScheduler } from '@backstage/backend-tasks'; /** @public */ -export type SchedulerService = PluginTaskScheduler; +export interface SchedulerService extends PluginTaskScheduler {} diff --git a/packages/backend-plugin-api/src/services/definitions/TokenManagerService.ts b/packages/backend-plugin-api/src/services/definitions/TokenManagerService.ts index 0e7536fe93..7fccb60c7a 100644 --- a/packages/backend-plugin-api/src/services/definitions/TokenManagerService.ts +++ b/packages/backend-plugin-api/src/services/definitions/TokenManagerService.ts @@ -17,4 +17,4 @@ import { TokenManager } from '@backstage/backend-common'; /** @public */ -export type TokenManagerService = TokenManager; +export interface TokenManagerService extends TokenManager {} diff --git a/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts b/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts index 082d4fe91e..ef825a7fcd 100644 --- a/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts +++ b/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts @@ -21,7 +21,7 @@ import { Readable } from 'stream'; * * @public */ -export type UrlReaderService = { +export interface UrlReaderService { /** * Reads a single file and return its content. */ @@ -36,7 +36,7 @@ export type UrlReaderService = { * Searches for a file in a tree using a glob pattern. */ search(url: string, options?: SearchOptions): Promise; -}; +} /** * An options object for readUrl operations.