From 9261f22f1c04c5aec8620db011dc85ba3a9ce636 Mon Sep 17 00:00:00 2001 From: Vincenzo Scamporlino Date: Tue, 8 Aug 2023 13:00:08 +0200 Subject: [PATCH] keep BackendFeatureFactory internal Signed-off-by: Vincenzo Scamporlino --- .../backend-plugin-api/alpha-api-report.md | 10 ++++++++++ packages/backend-plugin-api/api-report.md | 4 ++-- packages/backend-plugin-api/src/alpha.ts | 4 ++-- .../backend-plugin-api/src/wiring/factories.ts | 5 +++-- plugins/adr-backend/api-report.md | 4 ++-- plugins/airbrake-backend/api-report.md | 4 ++-- plugins/app-backend/alpha-api-report.md | 4 ++-- plugins/azure-devops-backend/api-report.md | 4 ++-- plugins/badges-backend/api-report.md | 4 ++-- plugins/bazaar-backend/api-report.md | 4 ++-- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 6 ++---- .../alpha-api-report.md | 6 ++---- .../catalog-backend-module-gcp/api-report.md | 4 ++-- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 6 ++---- .../alpha-api-report.md | 18 +++++++----------- .../alpha-api-report.md | 6 ++---- .../alpha-api-report.md | 4 ++-- .../api-report.md | 4 ++-- plugins/catalog-backend/alpha-api-report.md | 4 ++-- plugins/devtools-backend/api-report.md | 4 ++-- plugins/entity-feedback-backend/api-report.md | 4 ++-- .../alpha-api-report.md | 6 ++---- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 6 +++--- .../alpha-api-report.md | 6 +++--- plugins/events-backend/alpha-api-report.md | 4 ++-- .../example-todo-list-backend/api-report.md | 4 ++-- plugins/kafka-backend/api-report.md | 4 ++-- plugins/kubernetes-backend/alpha-api-report.md | 4 ++-- plugins/lighthouse-backend/api-report.md | 4 ++-- plugins/linguist-backend/api-report.md | 6 ++---- plugins/periskop-backend/api-report.md | 4 ++-- plugins/permission-backend/alpha-api-report.md | 6 +++--- plugins/proxy-backend/api-report.md | 4 ++-- plugins/scaffolder-backend/alpha-api-report.md | 10 +++++----- .../alpha-api-report.md | 8 ++++---- .../alpha-api-report.md | 8 ++++---- .../alpha-api-report.md | 8 ++++---- .../alpha-api-report.md | 4 ++-- .../alpha-api-report.md | 8 ++++---- plugins/search-backend/alpha-api-report.md | 4 ++-- plugins/techdocs-backend/alpha-api-report.md | 4 ++-- plugins/todo-backend/api-report.md | 4 ++-- plugins/user-settings-backend/api-report.md | 4 ++-- 50 files changed, 128 insertions(+), 133 deletions(-) diff --git a/packages/backend-plugin-api/alpha-api-report.md b/packages/backend-plugin-api/alpha-api-report.md index d76d7e4deb..29f78ed9d1 100644 --- a/packages/backend-plugin-api/alpha-api-report.md +++ b/packages/backend-plugin-api/alpha-api-report.md @@ -9,6 +9,16 @@ export interface BackendFeature { $$type: '@backstage/BackendFeature'; } +// @public (undocumented) +export interface BackendFeatureFactory< + TOptions extends [options?: object] = [], +> { + // (undocumented) + $$type: '@backstage/BackendFeatureFactory'; + // (undocumented) + (...options: TOptions): BackendFeature; +} + // @alpha (undocumented) export interface FeatureDiscoveryService { // (undocumented) diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md index a9eba1ba86..dc75c09b18 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.md @@ -126,12 +126,12 @@ export namespace coreServices { // @public export function createBackendModule( config: BackendModuleConfig | ((...params: TOptions) => BackendModuleConfig), -): BackendFeatureFactory; +): (...params: TOptions) => BackendFeature; // @public export function createBackendPlugin( config: BackendPluginConfig | ((...params: TOptions) => BackendPluginConfig), -): BackendFeatureFactory; +): (...params: TOptions) => BackendFeature; // @public export function createExtensionPoint( diff --git a/packages/backend-plugin-api/src/alpha.ts b/packages/backend-plugin-api/src/alpha.ts index bd6be5b75e..e3598dff5a 100644 --- a/packages/backend-plugin-api/src/alpha.ts +++ b/packages/backend-plugin-api/src/alpha.ts @@ -15,7 +15,7 @@ */ import { createServiceRef } from './services'; -import { BackendFeature } from './wiring'; +import { BackendFeature, BackendFeatureFactory } from './wiring'; /** @alpha */ export interface FeatureDiscoveryService { @@ -33,4 +33,4 @@ export const featureDiscoveryServiceRef = }); export type { ServiceRef } from './services'; -export type { BackendFeature }; +export type { BackendFeature, BackendFeatureFactory }; diff --git a/packages/backend-plugin-api/src/wiring/factories.ts b/packages/backend-plugin-api/src/wiring/factories.ts index cbc3771b86..ecaccdc6de 100644 --- a/packages/backend-plugin-api/src/wiring/factories.ts +++ b/packages/backend-plugin-api/src/wiring/factories.ts @@ -21,6 +21,7 @@ import { InternalBackendModuleRegistration, InternalBackendPluginRegistration, BackendFeatureFactory, + BackendFeature, } from './types'; /** @@ -86,7 +87,7 @@ export interface BackendPluginConfig { */ export function createBackendPlugin( config: BackendPluginConfig | ((...params: TOptions) => BackendPluginConfig), -): BackendFeatureFactory { +): (...params: TOptions) => BackendFeature { const configCallback = typeof config === 'function' ? config : () => config; const factory: BackendFeatureFactory = (...options) => { @@ -179,7 +180,7 @@ export interface BackendModuleConfig { */ export function createBackendModule( config: BackendModuleConfig | ((...params: TOptions) => BackendModuleConfig), -): BackendFeatureFactory { +): (...params: TOptions) => BackendFeature { const configCallback = typeof config === 'function' ? config : () => config; const factory: BackendFeatureFactory = (...options: TOptions) => { const c = configCallback(...options); diff --git a/plugins/adr-backend/api-report.md b/plugins/adr-backend/api-report.md index 4092a6eb60..2fd22ef9cd 100644 --- a/plugins/adr-backend/api-report.md +++ b/plugins/adr-backend/api-report.md @@ -7,7 +7,7 @@ import { AdrDocument } from '@backstage/plugin-adr-common'; import { AdrFilePathFilterFn } from '@backstage/plugin-adr-common'; -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CacheClient } from '@backstage/backend-common'; import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; @@ -45,7 +45,7 @@ export type AdrParserContext = { }; // @public -export const adrPlugin: BackendFeatureFactory<[]>; +export const adrPlugin: () => BackendFeature; // @public (undocumented) export type AdrRouterOptions = { diff --git a/plugins/airbrake-backend/api-report.md b/plugins/airbrake-backend/api-report.md index d3dd706c29..c410245e31 100644 --- a/plugins/airbrake-backend/api-report.md +++ b/plugins/airbrake-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import express from 'express'; import { Logger } from 'winston'; @@ -14,7 +14,7 @@ export interface AirbrakeConfig { } // @public -export const airbrakePlugin: BackendFeatureFactory<[]>; +export const airbrakePlugin: () => BackendFeature; // @public export function createRouter(options: RouterOptions): Promise; diff --git a/plugins/app-backend/alpha-api-report.md b/plugins/app-backend/alpha-api-report.md index 32d8cc3605..5fb0546a79 100644 --- a/plugins/app-backend/alpha-api-report.md +++ b/plugins/app-backend/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const appPlugin: BackendFeatureFactory<[]>; +export const appPlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/azure-devops-backend/api-report.md b/plugins/azure-devops-backend/api-report.md index 6447f03796..a2a43cd6af 100644 --- a/plugins/azure-devops-backend/api-report.md +++ b/plugins/azure-devops-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Build } from 'azure-devops-node-api/interfaces/BuildInterfaces'; import { BuildDefinitionReference } from 'azure-devops-node-api/interfaces/BuildInterfaces'; import { BuildRun } from '@backstage/plugin-azure-devops-common'; @@ -96,7 +96,7 @@ export class AzureDevOpsApi { } // @public -export const azureDevOpsPlugin: BackendFeatureFactory<[]>; +export const azureDevOpsPlugin: () => BackendFeature; // @public (undocumented) export function createRouter(options: RouterOptions): Promise; diff --git a/plugins/badges-backend/api-report.md b/plugins/badges-backend/api-report.md index 30fd1e0752..4594228543 100644 --- a/plugins/badges-backend/api-report.md +++ b/plugins/badges-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { Entity } from '@backstage/catalog-model'; @@ -83,7 +83,7 @@ export type BadgeSpec = { }; // @public -export const badgesPlugin: BackendFeatureFactory<[]>; +export const badgesPlugin: () => BackendFeature; // @public export interface BadgesStore { diff --git a/plugins/bazaar-backend/api-report.md b/plugins/bazaar-backend/api-report.md index d3fe7987a1..6281530851 100644 --- a/plugins/bazaar-backend/api-report.md +++ b/plugins/bazaar-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import express from 'express'; import { IdentityApi } from '@backstage/plugin-auth-node'; @@ -11,7 +11,7 @@ import { Logger } from 'winston'; import { PluginDatabaseManager } from '@backstage/backend-common'; // @alpha -export const bazaarPlugin: BackendFeatureFactory<[]>; +export const bazaarPlugin: () => BackendFeature; // @public (undocumented) export function createRouter(options: RouterOptions): Promise; diff --git a/plugins/catalog-backend-module-aws/alpha-api-report.md b/plugins/catalog-backend-module-aws/alpha-api-report.md index 6f4fa2c760..f78f6a802d 100644 --- a/plugins/catalog-backend-module-aws/alpha-api-report.md +++ b/plugins/catalog-backend-module-aws/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const catalogModuleAwsS3EntityProvider: BackendFeatureFactory<[]>; +export const catalogModuleAwsS3EntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-azure/alpha-api-report.md b/plugins/catalog-backend-module-azure/alpha-api-report.md index 833eb3dc59..66551a2856 100644 --- a/plugins/catalog-backend-module-azure/alpha-api-report.md +++ b/plugins/catalog-backend-module-azure/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const catalogModuleAzureDevOpsEntityProvider: BackendFeatureFactory<[]>; +export const catalogModuleAzureDevOpsEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md b/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md index 0f76de5552..a5d0ffc665 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md @@ -3,12 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -export const catalogModuleBitbucketCloudEntityProvider: BackendFeatureFactory< - [] ->; +export const catalogModuleBitbucketCloudEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md b/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md index 2616e92cba..2cc53a3c16 100644 --- a/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md +++ b/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md @@ -3,12 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -export const catalogModuleBitbucketServerEntityProvider: BackendFeatureFactory< - [] ->; +export const catalogModuleBitbucketServerEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gcp/api-report.md b/plugins/catalog-backend-module-gcp/api-report.md index 489032b830..6f963ed51d 100644 --- a/plugins/catalog-backend-module-gcp/api-report.md +++ b/plugins/catalog-backend-module-gcp/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import * as container from '@google-cloud/container'; import { EntityProvider } from '@backstage/plugin-catalog-node'; @@ -12,7 +12,7 @@ import { Logger } from 'winston'; import { SchedulerService } from '@backstage/backend-plugin-api'; // @public -export const catalogModuleGcpGkeEntityProvider: BackendFeatureFactory<[]>; +export const catalogModuleGcpGkeEntityProvider: () => BackendFeature; // @public export class GkeEntityProvider implements EntityProvider { diff --git a/plugins/catalog-backend-module-gerrit/alpha-api-report.md b/plugins/catalog-backend-module-gerrit/alpha-api-report.md index b7e00008cf..5aee61f28a 100644 --- a/plugins/catalog-backend-module-gerrit/alpha-api-report.md +++ b/plugins/catalog-backend-module-gerrit/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -export const catalogModuleGerritEntityProvider: BackendFeatureFactory<[]>; +export const catalogModuleGerritEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/alpha-api-report.md b/plugins/catalog-backend-module-github/alpha-api-report.md index abc5b4d2a0..0d4e16b4ea 100644 --- a/plugins/catalog-backend-module-github/alpha-api-report.md +++ b/plugins/catalog-backend-module-github/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const catalogModuleGithubEntityProvider: BackendFeatureFactory<[]>; +export const catalogModuleGithubEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gitlab/alpha-api-report.md b/plugins/catalog-backend-module-gitlab/alpha-api-report.md index 51ebbc4ae2..f14b41d6c5 100644 --- a/plugins/catalog-backend-module-gitlab/alpha-api-report.md +++ b/plugins/catalog-backend-module-gitlab/alpha-api-report.md @@ -3,12 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const catalogModuleGitlabDiscoveryEntityProvider: BackendFeatureFactory< - [] ->; +export const catalogModuleGitlabDiscoveryEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md b/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md index f067a0a6d7..b11ec43cf5 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md +++ b/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md @@ -3,21 +3,17 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; import { IncrementalEntityProviderOptions } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; // @alpha -export const catalogModuleIncrementalIngestionEntityProvider: BackendFeatureFactory< - [ - options: { - providers: { - provider: IncrementalEntityProvider; - options: IncrementalEntityProviderOptions; - }[]; - }, - ] ->; +export const catalogModuleIncrementalIngestionEntityProvider: (options: { + providers: { + provider: IncrementalEntityProvider; + options: IncrementalEntityProviderOptions; + }[]; +}) => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-msgraph/alpha-api-report.md b/plugins/catalog-backend-module-msgraph/alpha-api-report.md index d8aa5f5816..0fa093a1bc 100644 --- a/plugins/catalog-backend-module-msgraph/alpha-api-report.md +++ b/plugins/catalog-backend-module-msgraph/alpha-api-report.md @@ -3,15 +3,13 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { GroupTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; import { OrganizationTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; import { UserTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; // @alpha -export const catalogModuleMicrosoftGraphOrgEntityProvider: BackendFeatureFactory< - [] ->; +export const catalogModuleMicrosoftGraphOrgEntityProvider: () => BackendFeature; // @alpha export interface CatalogModuleMicrosoftGraphOrgEntityProviderOptions { diff --git a/plugins/catalog-backend-module-puppetdb/alpha-api-report.md b/plugins/catalog-backend-module-puppetdb/alpha-api-report.md index be38b9fc25..0856fdb836 100644 --- a/plugins/catalog-backend-module-puppetdb/alpha-api-report.md +++ b/plugins/catalog-backend-module-puppetdb/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const catalogModulePuppetDbEntityProvider: BackendFeatureFactory<[]>; +export const catalogModulePuppetDbEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-unprocessed/api-report.md b/plugins/catalog-backend-module-unprocessed/api-report.md index 6f52fdd967..7fd7119276 100644 --- a/plugins/catalog-backend-module-unprocessed/api-report.md +++ b/plugins/catalog-backend-module-unprocessed/api-report.md @@ -3,12 +3,12 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { HttpRouterService } from '@backstage/backend-plugin-api'; import { Knex } from 'knex'; // @public -export const catalogModuleUnprocessedEntities: BackendFeatureFactory<[]>; +export const catalogModuleUnprocessedEntities: () => BackendFeature; // @public export class UnprocessedEntitiesModule { diff --git a/plugins/catalog-backend/alpha-api-report.md b/plugins/catalog-backend/alpha-api-report.md index 57a10cbeda..df3e809ade 100644 --- a/plugins/catalog-backend/alpha-api-report.md +++ b/plugins/catalog-backend/alpha-api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { ConditionalPolicyDecision } from '@backstage/plugin-permission-common'; import { Conditions } from '@backstage/plugin-permission-node'; import { Entity } from '@backstage/catalog-model'; @@ -74,7 +74,7 @@ export type CatalogPermissionRule< > = PermissionRule; // @alpha -export const catalogPlugin: BackendFeatureFactory<[]>; +export const catalogPlugin: () => BackendFeature; // @alpha export const createCatalogConditionalDecision: ( diff --git a/plugins/devtools-backend/api-report.md b/plugins/devtools-backend/api-report.md index dd356951f4..dc51fc8387 100644 --- a/plugins/devtools-backend/api-report.md +++ b/plugins/devtools-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { ConfigInfo } from '@backstage/plugin-devtools-common'; import { DevToolsInfo } from '@backstage/plugin-devtools-common'; @@ -27,7 +27,7 @@ export class DevToolsBackendApi { } // @public -export const devtoolsPlugin: BackendFeatureFactory<[]>; +export const devtoolsPlugin: () => BackendFeature; // @public (undocumented) export interface RouterOptions { diff --git a/plugins/entity-feedback-backend/api-report.md b/plugins/entity-feedback-backend/api-report.md index fddce48592..3e8f90220e 100644 --- a/plugins/entity-feedback-backend/api-report.md +++ b/plugins/entity-feedback-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import express from 'express'; import { IdentityApi } from '@backstage/plugin-auth-node'; import { Logger } from 'winston'; @@ -14,7 +14,7 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common'; export function createRouter(options: RouterOptions): Promise; // @public -export const entityFeedbackPlugin: BackendFeatureFactory<[]>; +export const entityFeedbackPlugin: () => BackendFeature; // @public (undocumented) export interface RouterOptions { diff --git a/plugins/events-backend-module-aws-sqs/alpha-api-report.md b/plugins/events-backend-module-aws-sqs/alpha-api-report.md index 8f81ff00d1..e48515a414 100644 --- a/plugins/events-backend-module-aws-sqs/alpha-api-report.md +++ b/plugins/events-backend-module-aws-sqs/alpha-api-report.md @@ -3,12 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const eventsModuleAwsSqsConsumingEventPublisher: BackendFeatureFactory< - [] ->; +export const eventsModuleAwsSqsConsumingEventPublisher: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-azure/alpha-api-report.md b/plugins/events-backend-module-azure/alpha-api-report.md index 680c609c10..1bd568d1df 100644 --- a/plugins/events-backend-module-azure/alpha-api-report.md +++ b/plugins/events-backend-module-azure/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const eventsModuleAzureDevOpsEventRouter: BackendFeatureFactory<[]>; +export const eventsModuleAzureDevOpsEventRouter: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-bitbucket-cloud/alpha-api-report.md b/plugins/events-backend-module-bitbucket-cloud/alpha-api-report.md index 52b2cac142..5e63ae36c8 100644 --- a/plugins/events-backend-module-bitbucket-cloud/alpha-api-report.md +++ b/plugins/events-backend-module-bitbucket-cloud/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const eventsModuleBitbucketCloudEventRouter: BackendFeatureFactory<[]>; +export const eventsModuleBitbucketCloudEventRouter: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-gerrit/alpha-api-report.md b/plugins/events-backend-module-gerrit/alpha-api-report.md index 82588d05ac..d1be54730f 100644 --- a/plugins/events-backend-module-gerrit/alpha-api-report.md +++ b/plugins/events-backend-module-gerrit/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const eventsModuleGerritEventRouter: BackendFeatureFactory<[]>; +export const eventsModuleGerritEventRouter: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-github/alpha-api-report.md b/plugins/events-backend-module-github/alpha-api-report.md index 21bfdbb9d2..c233df8634 100644 --- a/plugins/events-backend-module-github/alpha-api-report.md +++ b/plugins/events-backend-module-github/alpha-api-report.md @@ -3,13 +3,13 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const eventsModuleGithubEventRouter: BackendFeatureFactory<[]>; +export const eventsModuleGithubEventRouter: () => BackendFeature; // @alpha -export const eventsModuleGithubWebhook: BackendFeatureFactory<[]>; +export const eventsModuleGithubWebhook: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-gitlab/alpha-api-report.md b/plugins/events-backend-module-gitlab/alpha-api-report.md index bca947c195..bf61f66a4b 100644 --- a/plugins/events-backend-module-gitlab/alpha-api-report.md +++ b/plugins/events-backend-module-gitlab/alpha-api-report.md @@ -3,13 +3,13 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const eventsModuleGitlabEventRouter: BackendFeatureFactory<[]>; +export const eventsModuleGitlabEventRouter: () => BackendFeature; // @alpha -export const eventsModuleGitlabWebhook: BackendFeatureFactory<[]>; +export const eventsModuleGitlabWebhook: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend/alpha-api-report.md b/plugins/events-backend/alpha-api-report.md index 72d4bce4b2..3e32f769c1 100644 --- a/plugins/events-backend/alpha-api-report.md +++ b/plugins/events-backend/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const eventsPlugin: BackendFeatureFactory<[]>; +export const eventsPlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/example-todo-list-backend/api-report.md b/plugins/example-todo-list-backend/api-report.md index 80b86c4e4d..319fbbf226 100644 --- a/plugins/example-todo-list-backend/api-report.md +++ b/plugins/example-todo-list-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import express from 'express'; import { IdentityApi } from '@backstage/plugin-auth-node'; import { Logger } from 'winston'; @@ -12,7 +12,7 @@ import { Logger } from 'winston'; export function createRouter(options: RouterOptions): Promise; // @alpha -export const exampleTodoListPlugin: BackendFeatureFactory<[]>; +export const exampleTodoListPlugin: () => BackendFeature; // @public export interface RouterOptions { diff --git a/plugins/kafka-backend/api-report.md b/plugins/kafka-backend/api-report.md index 176c961cd4..a748a543d9 100644 --- a/plugins/kafka-backend/api-report.md +++ b/plugins/kafka-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import express from 'express'; import { Logger } from 'winston'; @@ -12,7 +12,7 @@ import { Logger } from 'winston'; export function createRouter(options: RouterOptions): Promise; // @alpha -export const kafkaPlugin: BackendFeatureFactory<[]>; +export const kafkaPlugin: () => BackendFeature; // @public (undocumented) export interface RouterOptions { diff --git a/plugins/kubernetes-backend/alpha-api-report.md b/plugins/kubernetes-backend/alpha-api-report.md index 77a300d344..f95c1414f3 100644 --- a/plugins/kubernetes-backend/alpha-api-report.md +++ b/plugins/kubernetes-backend/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const kubernetesPlugin: BackendFeatureFactory<[]>; +export const kubernetesPlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/lighthouse-backend/api-report.md b/plugins/lighthouse-backend/api-report.md index f504ce70c9..5d9d948cf4 100644 --- a/plugins/lighthouse-backend/api-report.md +++ b/plugins/lighthouse-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { Logger } from 'winston'; @@ -30,7 +30,7 @@ export function createScheduler( ): Promise; // @public -export const lighthousePlugin: BackendFeatureFactory<[]>; +export const lighthousePlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/linguist-backend/api-report.md b/plugins/linguist-backend/api-report.md index 995b54da62..aac978e426 100644 --- a/plugins/linguist-backend/api-report.md +++ b/plugins/linguist-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogProcessor } from '@backstage/plugin-catalog-node'; import { CatalogProcessorCache } from '@backstage/plugin-catalog-node'; import { Config } from '@backstage/config'; @@ -36,9 +36,7 @@ export interface LinguistBackendApi { } // @public -export const linguistPlugin: BackendFeatureFactory< - [options: LinguistPluginOptions] ->; +export const linguistPlugin: (options: LinguistPluginOptions) => BackendFeature; // @public export interface LinguistPluginOptions { diff --git a/plugins/periskop-backend/api-report.md b/plugins/periskop-backend/api-report.md index e548a70a75..7906bc4785 100644 --- a/plugins/periskop-backend/api-report.md +++ b/plugins/periskop-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import express from 'express'; import { Logger } from 'winston'; @@ -12,7 +12,7 @@ import { Logger } from 'winston'; export function createRouter(options: RouterOptions): Promise; // @alpha -export const periskopPlugin: BackendFeatureFactory<[]>; +export const periskopPlugin: () => BackendFeature; // @public (undocumented) export interface RouterOptions { diff --git a/plugins/permission-backend/alpha-api-report.md b/plugins/permission-backend/alpha-api-report.md index 5068992c71..926691930b 100644 --- a/plugins/permission-backend/alpha-api-report.md +++ b/plugins/permission-backend/alpha-api-report.md @@ -3,13 +3,13 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const permissionModuleAllowAllPolicy: BackendFeatureFactory<[]>; +export const permissionModuleAllowAllPolicy: () => BackendFeature; // @alpha -export const permissionPlugin: BackendFeatureFactory<[]>; +export const permissionPlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/proxy-backend/api-report.md b/plugins/proxy-backend/api-report.md index 7960c9658c..9c5cf5f9ef 100644 --- a/plugins/proxy-backend/api-report.md +++ b/plugins/proxy-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import express from 'express'; import { Logger } from 'winston'; @@ -13,7 +13,7 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common'; export function createRouter(options: RouterOptions): Promise; // @alpha -export const proxyPlugin: BackendFeatureFactory<[]>; +export const proxyPlugin: () => BackendFeature; // @public (undocumented) export interface RouterOptions { diff --git a/plugins/scaffolder-backend/alpha-api-report.md b/plugins/scaffolder-backend/alpha-api-report.md index f4174697b2..363fcafd17 100644 --- a/plugins/scaffolder-backend/alpha-api-report.md +++ b/plugins/scaffolder-backend/alpha-api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { ConditionalPolicyDecision } from '@backstage/plugin-permission-common'; import { Conditions } from '@backstage/plugin-permission-node'; import { JsonObject } from '@backstage/types'; @@ -20,7 +20,7 @@ import { TemplateGlobal } from '@backstage/plugin-scaffolder-backend'; import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common'; // @alpha -export const catalogModuleTemplateKind: BackendFeatureFactory<[]>; +export const catalogModuleTemplateKind: () => BackendFeature; // @alpha (undocumented) export const createScaffolderActionConditionalDecision: ( @@ -90,9 +90,9 @@ export const scaffolderActionConditions: Conditions<{ }>; // @alpha -export const scaffolderPlugin: BackendFeatureFactory< - [options?: ScaffolderPluginOptions | undefined] ->; +export const scaffolderPlugin: ( + options?: ScaffolderPluginOptions | undefined, +) => BackendFeature; // @alpha export type ScaffolderPluginOptions = { diff --git a/plugins/search-backend-module-catalog/alpha-api-report.md b/plugins/search-backend-module-catalog/alpha-api-report.md index 02a2ea2266..7c6e91b6a1 100644 --- a/plugins/search-backend-module-catalog/alpha-api-report.md +++ b/plugins/search-backend-module-catalog/alpha-api-report.md @@ -3,14 +3,14 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { DefaultCatalogCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-catalog'; import { TaskScheduleDefinition } from '@backstage/backend-tasks'; // @alpha -export const searchModuleCatalogCollator: BackendFeatureFactory< - [options?: SearchModuleCatalogCollatorOptions | undefined] ->; +export const searchModuleCatalogCollator: ( + options?: SearchModuleCatalogCollatorOptions | undefined, +) => BackendFeature; // @alpha export type SearchModuleCatalogCollatorOptions = Omit< diff --git a/plugins/search-backend-module-elasticsearch/alpha-api-report.md b/plugins/search-backend-module-elasticsearch/alpha-api-report.md index 254771b484..91007c20de 100644 --- a/plugins/search-backend-module-elasticsearch/alpha-api-report.md +++ b/plugins/search-backend-module-elasticsearch/alpha-api-report.md @@ -3,14 +3,14 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { ElasticSearchCustomIndexTemplate } from '@backstage/plugin-search-backend-module-elasticsearch'; import { ElasticSearchQueryTranslator } from '@backstage/plugin-search-backend-module-elasticsearch'; // @alpha -export const searchModuleElasticsearchEngine: BackendFeatureFactory< - [options?: SearchModuleElasticsearchEngineOptions | undefined] ->; +export const searchModuleElasticsearchEngine: ( + options?: SearchModuleElasticsearchEngineOptions | undefined, +) => BackendFeature; // @alpha export type SearchModuleElasticsearchEngineOptions = { diff --git a/plugins/search-backend-module-explore/alpha-api-report.md b/plugins/search-backend-module-explore/alpha-api-report.md index f8053601b3..7b0f2658d6 100644 --- a/plugins/search-backend-module-explore/alpha-api-report.md +++ b/plugins/search-backend-module-explore/alpha-api-report.md @@ -3,13 +3,13 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { TaskScheduleDefinition } from '@backstage/backend-tasks'; // @alpha -export const searchModuleExploreCollator: BackendFeatureFactory< - [options?: SearchModuleExploreCollatorOptions | undefined] ->; +export const searchModuleExploreCollator: ( + options?: SearchModuleExploreCollatorOptions | undefined, +) => BackendFeature; // @alpha export type SearchModuleExploreCollatorOptions = { diff --git a/plugins/search-backend-module-pg/alpha-api-report.md b/plugins/search-backend-module-pg/alpha-api-report.md index d41010a594..eaee78e944 100644 --- a/plugins/search-backend-module-pg/alpha-api-report.md +++ b/plugins/search-backend-module-pg/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const searchModulePostgresEngine: BackendFeatureFactory<[]>; +export const searchModulePostgresEngine: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-techdocs/alpha-api-report.md b/plugins/search-backend-module-techdocs/alpha-api-report.md index 4f7515dac5..0eac010b4c 100644 --- a/plugins/search-backend-module-techdocs/alpha-api-report.md +++ b/plugins/search-backend-module-techdocs/alpha-api-report.md @@ -3,14 +3,14 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { TaskScheduleDefinition } from '@backstage/backend-tasks'; import { TechDocsCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-techdocs'; // @alpha -export const searchModuleTechDocsCollator: BackendFeatureFactory< - [options?: SearchModuleTechDocsCollatorOptions | undefined] ->; +export const searchModuleTechDocsCollator: ( + options?: SearchModuleTechDocsCollatorOptions | undefined, +) => BackendFeature; // @alpha export type SearchModuleTechDocsCollatorOptions = Omit< diff --git a/plugins/search-backend/alpha-api-report.md b/plugins/search-backend/alpha-api-report.md index 9d620efe0e..6ee94a0e29 100644 --- a/plugins/search-backend/alpha-api-report.md +++ b/plugins/search-backend/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const searchPlugin: BackendFeatureFactory<[]>; +export const searchPlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs-backend/alpha-api-report.md b/plugins/techdocs-backend/alpha-api-report.md index 6de1a7d209..16db84c216 100644 --- a/plugins/techdocs-backend/alpha-api-report.md +++ b/plugins/techdocs-backend/alpha-api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const techdocsPlugin: BackendFeatureFactory<[]>; +export const techdocsPlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/todo-backend/api-report.md b/plugins/todo-backend/api-report.md index a3703eaaab..6db1e012e9 100644 --- a/plugins/todo-backend/api-report.md +++ b/plugins/todo-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { CompoundEntityRef } from '@backstage/catalog-model'; import { Config } from '@backstage/config'; @@ -91,7 +91,7 @@ export type TodoParserResult = { }; // @public -export const todoPlugin: BackendFeatureFactory<[]>; +export const todoPlugin: () => BackendFeature; // @public (undocumented) export interface TodoReader { diff --git a/plugins/user-settings-backend/api-report.md b/plugins/user-settings-backend/api-report.md index 32722bbf2d..b015915723 100644 --- a/plugins/user-settings-backend/api-report.md +++ b/plugins/user-settings-backend/api-report.md @@ -3,7 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { BackendFeatureFactory } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import express from 'express'; import { IdentityApi } from '@backstage/plugin-auth-node'; import { PluginDatabaseManager } from '@backstage/backend-common'; @@ -20,7 +20,7 @@ export interface RouterOptions { } // @alpha -export const userSettingsPlugin: BackendFeatureFactory<[]>; +export const userSettingsPlugin: () => BackendFeature; // (No @packageDocumentation comment for this package) ```