diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index a97f8b31d8..b03d6ec866 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -234,32 +234,6 @@ export function createDatabaseClient( overrides?: Partial, ): Knex; -// @public -export const createPluginCompat: ( - name: string, - createRouterImport: Promise<{ - default: LegacyCreateRouter< - TransformedEnv< - { - cache: PluginCacheManager; - config: ConfigService; - database: PluginDatabaseManager; - discovery: PluginEndpointDiscovery; - logger: LoggerService; - permissions: PermissionsService; - scheduler: SchedulerService; - tokenManager: TokenManager; - reader: UrlReader; - identity: IdentityService; - }, - { - logger: (log: LoggerService) => Logger; - } - > - >; - }>, -) => BackendFeature; - // @public export function createRootLogger( options?: winston.LoggerOptions, @@ -535,6 +509,32 @@ export type KubernetesContainerRunnerOptions = { // @public (undocumented) export type LegacyCreateRouter = (deps: TEnv) => Promise; +// @public +export const legacyPlugin: ( + name: string, + createRouterImport: Promise<{ + default: LegacyCreateRouter< + TransformedEnv< + { + cache: PluginCacheManager; + config: ConfigService; + database: PluginDatabaseManager; + discovery: PluginEndpointDiscovery; + logger: LoggerService; + permissions: PermissionsService; + scheduler: SchedulerService; + tokenManager: TokenManager; + reader: UrlReader; + identity: IdentityService; + }, + { + logger: (log: LoggerService) => Logger; + } + > + >; + }>, +) => BackendFeature; + // @public export function loadBackendConfig(options: { logger: LoggerService; @@ -549,7 +549,7 @@ export function loggerToWinstonLogger( ): Logger; // @public -export function makePluginCompat< +export function makeLegacyPlugin< TEnv extends Record, TEnvTransforms extends { [key in keyof TEnv]?: (dep: TEnv[key]) => unknown; diff --git a/packages/backend-common/src/index.ts b/packages/backend-common/src/index.ts index 178a064cb9..46639a1923 100644 --- a/packages/backend-common/src/index.ts +++ b/packages/backend-common/src/index.ts @@ -20,8 +20,8 @@ * @packageDocumentation */ -export { makePluginCompat, createPluginCompat } from './compat'; -export type { LegacyCreateRouter } from './compat'; +export { legacyPlugin, makeLegacyPlugin } from './legacy'; +export type { LegacyCreateRouter } from './legacy'; export * from './cache'; export { loadBackendConfig } from './config'; export * from './context'; diff --git a/packages/backend-common/src/compat.ts b/packages/backend-common/src/legacy.ts similarity index 93% rename from packages/backend-common/src/compat.ts rename to packages/backend-common/src/legacy.ts index 16fe48dcb7..30e7dd9dc5 100644 --- a/packages/backend-common/src/compat.ts +++ b/packages/backend-common/src/legacy.ts @@ -43,10 +43,10 @@ type TransformedEnv< * @public * @remarks * - * Usually you can use {@link createPluginCompat} directly instead, but you might + * Usually you can use {@link legacyPlugin} directly instead, but you might * need to use this if you have customized the plugin environment in your backend. */ -export function makePluginCompat< +export function makeLegacyPlugin< TEnv extends Record, TEnvTransforms extends { [key in keyof TEnv]?: (dep: TEnv[key]) => unknown }, >( @@ -101,10 +101,10 @@ export function makePluginCompat< * @example * *```ts - *backend.add(createPluginCompat('kafka', import('./plugins/kafka'))); + *backend.add(legacyPlugin('kafka', import('./plugins/kafka'))); *``` */ -export const createPluginCompat = makePluginCompat( +export const legacyPlugin = makeLegacyPlugin( { cache: coreServices.cache, config: coreServices.config,