diff --git a/packages/backend-app-api/api-report.md b/packages/backend-app-api/api-report.md index b1356e93e3..57f146aad8 100644 --- a/packages/backend-app-api/api-report.md +++ b/packages/backend-app-api/api-report.md @@ -13,6 +13,7 @@ import { ErrorRequestHandler } from 'express'; import { Express as Express_2 } from 'express'; import { ExtensionPoint } from '@backstage/backend-plugin-api'; import { Handler } from 'express'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { HelmetOptions } from 'helmet'; import * as http from 'http'; import { HttpRouterService } from '@backstage/backend-plugin-api'; @@ -46,14 +47,13 @@ export interface Backend { } // @public (undocumented) -export const cacheFactory: ( - options?: undefined, -) => ServiceFactory; +export const cacheFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public (undocumented) -export const configFactory: ( - options?: undefined, -) => ServiceFactory; +export const configFactory: FactoryFunction, []>; // @public export function createHttpServer( @@ -76,9 +76,10 @@ export interface CreateSpecializedBackendOptions { } // @public (undocumented) -export const databaseFactory: ( - options?: undefined, -) => ServiceFactory; +export const databaseFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public export class DefaultRootHttpRouter implements RootHttpRouterService { @@ -96,9 +97,10 @@ export interface DefaultRootHttpRouterOptions { } // @public (undocumented) -export const discoveryFactory: ( - options?: undefined, -) => ServiceFactory; +export const discoveryFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public export interface ExtendedHttpServer extends http.Server { @@ -111,14 +113,15 @@ export interface ExtendedHttpServer extends http.Server { } // @public (undocumented) -export const httpRouterFactory: ( - options?: HttpRouterFactoryOptions | undefined, -) => ServiceFactory; +export const httpRouterFactory: FactoryFunction< + ServiceFactory, + [options?: HttpRouterFactoryOptions | undefined] +>; // @public (undocumented) -export type HttpRouterFactoryOptions = { +export interface HttpRouterFactoryOptions { getPath(pluginId: string): string; -}; +} // @public export type HttpServerCertificateOptions = @@ -144,9 +147,10 @@ export type HttpServerOptions = { }; // @public (undocumented) -export const identityFactory: ( - options?: IdentityFactoryOptions | undefined, -) => ServiceFactory; +export const identityFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public export type IdentityFactoryOptions = { @@ -155,14 +159,13 @@ export type IdentityFactoryOptions = { }; // @public -export const lifecycleFactory: ( - options?: undefined, -) => ServiceFactory; +export const lifecycleFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public (undocumented) -export const loggerFactory: ( - options?: undefined, -) => ServiceFactory; +export const loggerFactory: FactoryFunction, []>; // @public export class MiddlewareFactory { @@ -190,9 +193,10 @@ export interface MiddlewareFactoryOptions { } // @public (undocumented) -export const permissionsFactory: ( - options?: undefined, -) => ServiceFactory; +export const permissionsFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public export function readCorsOptions(config?: Config): CorsOptions; @@ -220,9 +224,10 @@ export interface RootHttpRouterConfigureOptions { } // @public (undocumented) -export const rootHttpRouterFactory: ( - options?: RootHttpRouterFactoryOptions | undefined, -) => ServiceFactory; +export const rootHttpRouterFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public (undocumented) export type RootHttpRouterFactoryOptions = { @@ -231,19 +236,22 @@ export type RootHttpRouterFactoryOptions = { }; // @public -export const rootLifecycleFactory: ( - options?: undefined, -) => ServiceFactory; +export const rootLifecycleFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public (undocumented) -export const rootLoggerFactory: ( - options?: undefined, -) => ServiceFactory; +export const rootLoggerFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public (undocumented) -export const schedulerFactory: ( - options?: undefined, -) => ServiceFactory; +export const schedulerFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public (undocumented) export type ServiceOrExtensionPoint = @@ -251,12 +259,11 @@ export type ServiceOrExtensionPoint = | ServiceRef; // @public (undocumented) -export const tokenManagerFactory: ( - options?: undefined, -) => ServiceFactory; +export const tokenManagerFactory: FactoryFunction< + ServiceFactory, + [] +>; // @public (undocumented) -export const urlReaderFactory: ( - options?: undefined, -) => ServiceFactory; +export const urlReaderFactory: FactoryFunction, []>; ``` diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md index 213815f782..848744297e 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.md @@ -23,7 +23,7 @@ export interface BackendFeature { } // @public (undocumented) -export interface BackendModuleConfig { +export interface BackendModuleConfig { // (undocumented) moduleId: string; // (undocumented) @@ -31,16 +31,15 @@ export interface BackendModuleConfig { // (undocumented) register( reg: Omit, - options: TOptions, ): void; } // @public (undocumented) -export interface BackendPluginConfig { +export interface BackendPluginConfig { // (undocumented) id: string; // (undocumented) - register(reg: BackendRegistrationPoints, options: TOptions): void; + register(reg: BackendRegistrationPoints): void; } // @public (undocumented) @@ -113,14 +112,14 @@ export namespace coreServices { } // @public -export function createBackendModule( - config: BackendModuleConfig, -): FactoryFunctionWithOptions; +export function createBackendModule( + config: FactoryFunctionConfig, +): FactoryFunction; // @public (undocumented) -export function createBackendPlugin( - config: BackendPluginConfig, -): FactoryFunctionWithOptions; +export function createBackendPlugin( + config: FactoryFunctionConfig, +): FactoryFunction; // @public (undocumented) export function createExtensionPoint( @@ -135,10 +134,13 @@ export function createServiceFactory< TDeps extends { [name in string]: ServiceRef; }, - TOpts extends MaybeOptions = undefined, + TOpts extends [options?: object] = [], >( - config: ServiceFactoryConfig, -): FactoryFunctionWithOptions, TOpts>; + config: FactoryFunctionConfig< + ServiceFactoryConfig, + TOpts + >, +): FactoryFunction, TOpts>; // @public export function createServiceRef( @@ -337,14 +339,12 @@ export interface ServiceFactoryConfig< TDeps extends { [name in string]: ServiceRef; }, - TOpts extends MaybeOptions = undefined, > { // (undocumented) deps: TDeps; // (undocumented) factory( deps: ServiceRefsToInstances, - options: TOpts, ): TScope extends 'root' ? Promise : Promise<(deps: ServiceRefsToInstances) => Promise>; diff --git a/plugins/app-backend/api-report.md b/plugins/app-backend/api-report.md index b52132ef51..1a430879e8 100644 --- a/plugins/app-backend/api-report.md +++ b/plugins/app-backend/api-report.md @@ -6,11 +6,15 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import express from 'express'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { Logger } from 'winston'; import { PluginDatabaseManager } from '@backstage/backend-common'; // @alpha -export const appPlugin: (options: AppPluginOptions) => BackendFeature; +export const appPlugin: FactoryFunction< + BackendFeature, + [options: AppPluginOptions] +>; // @alpha (undocumented) export type AppPluginOptions = { diff --git a/plugins/catalog-backend-module-aws/api-report.md b/plugins/catalog-backend-module-aws/api-report.md index a911fb5ebb..a054c48428 100644 --- a/plugins/catalog-backend-module-aws/api-report.md +++ b/plugins/catalog-backend-module-aws/api-report.md @@ -11,6 +11,7 @@ import { Config } from '@backstage/config'; import { Credentials } from 'aws-sdk'; import { EntityProvider } from '@backstage/plugin-catalog-backend'; import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { LocationSpec } from '@backstage/plugin-catalog-backend'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; @@ -90,7 +91,8 @@ export class AwsS3EntityProvider implements EntityProvider { } // @alpha -export const awsS3EntityProviderCatalogModule: ( - options?: undefined, -) => BackendFeature; +export const awsS3EntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; ``` diff --git a/plugins/catalog-backend-module-azure/api-report.md b/plugins/catalog-backend-module-azure/api-report.md index 84ffaf39e9..e7599a4d31 100644 --- a/plugins/catalog-backend-module-azure/api-report.md +++ b/plugins/catalog-backend-module-azure/api-report.md @@ -9,6 +9,7 @@ import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend'; import { Config } from '@backstage/config'; import { EntityProvider } from '@backstage/plugin-catalog-backend'; import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { LocationSpec } from '@backstage/plugin-catalog-backend'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; @@ -58,7 +59,8 @@ export class AzureDevOpsEntityProvider implements EntityProvider { } // @alpha -export const azureDevOpsEntityProviderCatalogModule: ( - options?: undefined, -) => BackendFeature; +export const azureDevOpsEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/api-report.md b/plugins/catalog-backend-module-bitbucket-cloud/api-report.md index 480395e477..af9aa834ec 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/api-report.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/api-report.md @@ -11,6 +11,7 @@ import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; import { EventParams } from '@backstage/plugin-events-node'; import { Events } from '@backstage/plugin-bitbucket-cloud-common'; import { EventSubscriber } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; import { TaskRunner } from '@backstage/backend-tasks'; @@ -48,7 +49,8 @@ export class BitbucketCloudEntityProvider } // @alpha (undocumented) -export const bitbucketCloudEntityProviderCatalogModule: ( - options?: undefined, -) => BackendFeature; +export const bitbucketCloudEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/api-report.md b/plugins/catalog-backend-module-bitbucket-server/api-report.md index a38a4d8c35..41ed476c13 100644 --- a/plugins/catalog-backend-module-bitbucket-server/api-report.md +++ b/plugins/catalog-backend-module-bitbucket-server/api-report.md @@ -9,6 +9,7 @@ import { Config } from '@backstage/config'; import { Entity } from '@backstage/catalog-model'; import { EntityProvider } from '@backstage/plugin-catalog-backend'; import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { LocationSpec } from '@backstage/plugin-catalog-backend'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; @@ -69,9 +70,10 @@ export class BitbucketServerEntityProvider implements EntityProvider { } // @alpha (undocumented) -export const bitbucketServerEntityProviderCatalogModule: ( - options?: undefined, -) => BackendFeature; +export const bitbucketServerEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; // @public (undocumented) export type BitbucketServerListOptions = { diff --git a/plugins/catalog-backend-module-gerrit/api-report.md b/plugins/catalog-backend-module-gerrit/api-report.md index 45847ea93d..99387a1b60 100644 --- a/plugins/catalog-backend-module-gerrit/api-report.md +++ b/plugins/catalog-backend-module-gerrit/api-report.md @@ -7,6 +7,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { EntityProvider } from '@backstage/plugin-catalog-backend'; import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; import { TaskRunner } from '@backstage/backend-tasks'; @@ -31,9 +32,10 @@ export class GerritEntityProvider implements EntityProvider { } // @alpha (undocumented) -export const gerritEntityProviderCatalogModule: ( - options?: undefined, -) => BackendFeature; +export const gerritEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/api-report.md b/plugins/catalog-backend-module-github/api-report.md index 78ffd5b018..e09658dfc1 100644 --- a/plugins/catalog-backend-module-github/api-report.md +++ b/plugins/catalog-backend-module-github/api-report.md @@ -13,6 +13,7 @@ import { EntityProvider } from '@backstage/plugin-catalog-backend'; import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; import { EventParams } from '@backstage/plugin-events-node'; import { EventSubscriber } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { GithubCredentialsProvider } from '@backstage/integration'; import { GithubIntegrationConfig } from '@backstage/integration'; import { graphql } from '@octokit/graphql'; @@ -101,9 +102,10 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { } // @alpha -export const githubEntityProviderCatalogModule: ( - options?: undefined, -) => BackendFeature; +export const githubEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; // @public (undocumented) export class GithubLocationAnalyzer implements ScmLocationAnalyzer { diff --git a/plugins/catalog-backend-module-gitlab/api-report.md b/plugins/catalog-backend-module-gitlab/api-report.md index 9ed90a2c42..21b0d9fdc3 100644 --- a/plugins/catalog-backend-module-gitlab/api-report.md +++ b/plugins/catalog-backend-module-gitlab/api-report.md @@ -9,6 +9,7 @@ import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend'; import { Config } from '@backstage/config'; import { EntityProvider } from '@backstage/plugin-catalog-backend'; import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { LocationSpec } from '@backstage/plugin-catalog-backend'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; @@ -34,9 +35,10 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider { } // @alpha -export const gitlabDiscoveryEntityProviderCatalogModule: ( - options?: undefined, -) => BackendFeature; +export const gitlabDiscoveryEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; // @public export class GitLabDiscoveryProcessor implements CatalogProcessor { diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report.md b/plugins/catalog-backend-module-incremental-ingestion/api-report.md index 387e505c33..5dc0c45551 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/api-report.md +++ b/plugins/catalog-backend-module-incremental-ingestion/api-report.md @@ -10,6 +10,7 @@ import { CatalogBuilder } from '@backstage/plugin-catalog-backend'; import type { Config } from '@backstage/config'; import type { DeferredEntity } from '@backstage/plugin-catalog-backend'; import type { DurationObjectUnits } from 'luxon'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import type { Logger } from 'winston'; import type { PermissionEvaluator } from '@backstage/plugin-permission-common'; import type { PluginDatabaseManager } from '@backstage/backend-common'; @@ -68,12 +69,17 @@ export interface IncrementalEntityProviderOptions { } // @alpha -export const incrementalIngestionEntityProviderCatalogModule: (options: { - providers: { - provider: IncrementalEntityProvider; - options: IncrementalEntityProviderOptions; - }[]; -}) => BackendFeature; +export const incrementalIngestionEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [ + options: { + providers: { + provider: IncrementalEntityProvider; + options: IncrementalEntityProviderOptions; + }[]; + }, + ] +>; // @public (undocumented) export type PluginEnvironment = { diff --git a/plugins/catalog-backend-module-msgraph/api-report.md b/plugins/catalog-backend-module-msgraph/api-report.md index 921d682b89..9a0f8cc0db 100644 --- a/plugins/catalog-backend-module-msgraph/api-report.md +++ b/plugins/catalog-backend-module-msgraph/api-report.md @@ -9,6 +9,7 @@ import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend'; import { Config } from '@backstage/config'; import { EntityProvider } from '@backstage/plugin-catalog-backend'; import { EntityProviderConnection } from '@backstage/plugin-catalog-backend'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { GroupEntity } from '@backstage/catalog-model'; import { LocationSpec } from '@backstage/plugin-catalog-backend'; import { Logger } from 'winston'; @@ -135,9 +136,10 @@ export class MicrosoftGraphOrgEntityProvider implements EntityProvider { } // @alpha -export const microsoftGraphOrgEntityProviderCatalogModule: ( - options?: MicrosoftGraphOrgEntityProviderCatalogModuleOptions | undefined, -) => BackendFeature; +export const microsoftGraphOrgEntityProviderCatalogModule: FactoryFunction< + BackendFeature, + [] +>; // @alpha export interface MicrosoftGraphOrgEntityProviderCatalogModuleOptions { diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index 3e6c5ef676..ac5d42a6e9 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -34,6 +34,7 @@ import { EntityProvider } from '@backstage/plugin-catalog-node'; import { EntityProviderConnection } from '@backstage/plugin-catalog-node'; import { EntityProviderMutation } from '@backstage/plugin-catalog-node'; import { EntityRelationSpec } from '@backstage/plugin-catalog-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { GetEntitiesRequest } from '@backstage/catalog-client'; import { JsonValue } from '@backstage/types'; import { LocationEntityV1alpha1 } from '@backstage/catalog-model'; @@ -237,7 +238,7 @@ export type CatalogPermissionRule< > = PermissionRule; // @alpha -export const catalogPlugin: (options?: undefined) => BackendFeature; +export const catalogPlugin: FactoryFunction; // @public export interface CatalogProcessingEngine { diff --git a/plugins/events-backend-module-aws-sqs/api-report.md b/plugins/events-backend-module-aws-sqs/api-report.md index 79a422c9f3..b50ba0884e 100644 --- a/plugins/events-backend-module-aws-sqs/api-report.md +++ b/plugins/events-backend-module-aws-sqs/api-report.md @@ -7,6 +7,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { EventBroker } from '@backstage/plugin-events-node'; import { EventPublisher } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; @@ -23,7 +24,8 @@ export class AwsSqsConsumingEventPublisher implements EventPublisher { } // @alpha -export const awsSqsConsumingEventPublisherEventsModule: ( - options?: undefined, -) => BackendFeature; +export const awsSqsConsumingEventPublisherEventsModule: FactoryFunction< + BackendFeature, + [] +>; ``` diff --git a/plugins/events-backend-module-azure/api-report.md b/plugins/events-backend-module-azure/api-report.md index 510ec91c47..d974bfee6b 100644 --- a/plugins/events-backend-module-azure/api-report.md +++ b/plugins/events-backend-module-azure/api-report.md @@ -5,6 +5,7 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; import { EventParams } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; // @public @@ -15,7 +16,8 @@ export class AzureDevOpsEventRouter extends SubTopicEventRouter { } // @alpha -export const azureDevOpsEventRouterEventsModule: ( - options?: undefined, -) => BackendFeature; +export const azureDevOpsEventRouterEventsModule: FactoryFunction< + BackendFeature, + [] +>; ``` diff --git a/plugins/events-backend-module-bitbucket-cloud/api-report.md b/plugins/events-backend-module-bitbucket-cloud/api-report.md index 0e4acfac91..69f5570cf5 100644 --- a/plugins/events-backend-module-bitbucket-cloud/api-report.md +++ b/plugins/events-backend-module-bitbucket-cloud/api-report.md @@ -5,6 +5,7 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; import { EventParams } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; // @public @@ -15,7 +16,8 @@ export class BitbucketCloudEventRouter extends SubTopicEventRouter { } // @alpha -export const bitbucketCloudEventRouterEventsModule: ( - options?: undefined, -) => BackendFeature; +export const bitbucketCloudEventRouterEventsModule: FactoryFunction< + BackendFeature, + [] +>; ``` diff --git a/plugins/events-backend-module-gerrit/api-report.md b/plugins/events-backend-module-gerrit/api-report.md index 268e5970fa..868505f773 100644 --- a/plugins/events-backend-module-gerrit/api-report.md +++ b/plugins/events-backend-module-gerrit/api-report.md @@ -5,6 +5,7 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; import { EventParams } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; // @public @@ -15,7 +16,5 @@ export class GerritEventRouter extends SubTopicEventRouter { } // @alpha -export const gerritEventRouterEventsModule: ( - options?: undefined, -) => BackendFeature; +export const gerritEventRouterEventsModule: FactoryFunction; ``` diff --git a/plugins/events-backend-module-github/api-report.md b/plugins/events-backend-module-github/api-report.md index b2a4425ae6..3b8905f6b0 100644 --- a/plugins/events-backend-module-github/api-report.md +++ b/plugins/events-backend-module-github/api-report.md @@ -6,6 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { EventParams } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { RequestValidator } from '@backstage/plugin-events-node'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; @@ -22,10 +23,8 @@ export class GithubEventRouter extends SubTopicEventRouter { } // @alpha -export const githubEventRouterEventsModule: ( - options?: undefined, -) => BackendFeature; +export const githubEventRouterEventsModule: FactoryFunction; // @alpha -export const githubWebhookEventsModule: (options?: undefined) => BackendFeature; +export const githubWebhookEventsModule: FactoryFunction; ``` diff --git a/plugins/events-backend-module-gitlab/api-report.md b/plugins/events-backend-module-gitlab/api-report.md index 8f130902a2..4900b548a9 100644 --- a/plugins/events-backend-module-gitlab/api-report.md +++ b/plugins/events-backend-module-gitlab/api-report.md @@ -6,6 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { EventParams } from '@backstage/plugin-events-node'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { RequestValidator } from '@backstage/plugin-events-node'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; @@ -20,10 +21,8 @@ export class GitlabEventRouter extends SubTopicEventRouter { } // @alpha -export const gitlabEventRouterEventsModule: ( - options?: undefined, -) => BackendFeature; +export const gitlabEventRouterEventsModule: FactoryFunction; // @alpha -export const gitlabWebhookEventsModule: (options?: undefined) => BackendFeature; +export const gitlabWebhookEventsModule: FactoryFunction; ``` diff --git a/plugins/events-backend/api-report.md b/plugins/events-backend/api-report.md index 69d7600ed3..87700237b9 100644 --- a/plugins/events-backend/api-report.md +++ b/plugins/events-backend/api-report.md @@ -9,6 +9,7 @@ import { EventBroker } from '@backstage/plugin-events-node'; import { EventPublisher } from '@backstage/plugin-events-node'; import { EventSubscriber } from '@backstage/plugin-events-node'; import express from 'express'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { HttpPostIngressOptions } from '@backstage/plugin-events-node'; import { Logger } from 'winston'; @@ -29,7 +30,7 @@ export class EventsBackend { } // @alpha -export const eventsPlugin: (options?: undefined) => BackendFeature; +export const eventsPlugin: FactoryFunction; // @public export class HttpPostIngressEventPublisher implements EventPublisher { diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index c89ead6d2b..29590f76b1 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -13,6 +13,7 @@ import { Config } from '@backstage/config'; import { createPullRequest } from 'octokit-plugin-create-pull-request'; import { Entity } from '@backstage/catalog-model'; import express from 'express'; +import { FactoryFunction } from '@backstage/backend-plugin-api/src/types'; import { GithubCredentialsProvider } from '@backstage/integration'; import { IdentityApi } from '@backstage/plugin-auth-node'; import { JsonObject } from '@backstage/types'; @@ -625,7 +626,7 @@ export type RunCommandOptions = { }; // @alpha -export const scaffolderCatalogModule: (options?: undefined) => BackendFeature; +export const scaffolderCatalogModule: FactoryFunction; // @public (undocumented) export class ScaffolderEntitiesProcessor implements CatalogProcessor { @@ -642,9 +643,10 @@ export class ScaffolderEntitiesProcessor implements CatalogProcessor { } // @alpha -export const scaffolderPlugin: ( - options: ScaffolderPluginOptions, -) => BackendFeature; +export const scaffolderPlugin: FactoryFunction< + BackendFeature, + [options: ScaffolderPluginOptions] +>; // @alpha export type ScaffolderPluginOptions = {