From 922f53f5926702a53a1c18900151d40889fe770e Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Fri, 8 Jul 2022 10:45:17 +0200
Subject: [PATCH] backend-plugin-api: add API report

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 packages/backend-plugin-api/api-report.md | 206 ++++++++++++++++++++++
 1 file changed, 206 insertions(+)
 create mode 100644 packages/backend-plugin-api/api-report.md

diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md
new file mode 100644
index 0000000000..875f589d17
--- /dev/null
+++ b/packages/backend-plugin-api/api-report.md
@@ -0,0 +1,206 @@
+## API Report File for "@backstage/backend-plugin-api"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { Config } from '@backstage/config';
+import { Handler } from 'express';
+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';
+import { PluginEndpointDiscovery } from '@backstage/backend-common';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { TokenManager } from '@backstage/backend-common';
+import { UrlReader } from '@backstage/backend-common';
+
+// Warning: (ae-missing-release-tag) "AnyServiceFactory" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type AnyServiceFactory = ServiceFactory<
+  unknown,
+  unknown,
+  {
+    [key in string]: unknown;
+  }
+>;
+
+// Warning: (ae-missing-release-tag) "BackendInitRegistry" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface BackendInitRegistry {
+  // (undocumented)
+  registerExtensionPoint<TExtensionPoint>(
+    ref: ServiceRef<TExtensionPoint>,
+    impl: TExtensionPoint,
+  ): void;
+  // (undocumented)
+  registerInit<
+    Deps extends {
+      [name in string]: unknown;
+    },
+  >(options: {
+    deps: {
+      [name in keyof Deps]: ServiceRef<Deps[name]>;
+    };
+    init: (deps: Deps) => Promise<void>;
+  }): void;
+}
+
+// Warning: (ae-missing-release-tag) "BackendModuleConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface BackendModuleConfig<TOptions> {
+  // (undocumented)
+  moduleId: string;
+  // (undocumented)
+  pluginId: string;
+  // (undocumented)
+  register(
+    reg: Omit<BackendInitRegistry, 'registerExtensionPoint'>,
+    options: TOptions,
+  ): void;
+}
+
+// Warning: (ae-missing-release-tag) "BackendPluginConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface BackendPluginConfig<TOptions> {
+  // (undocumented)
+  id: string;
+  // (undocumented)
+  register(reg: BackendInitRegistry, options: TOptions): void;
+}
+
+// Warning: (ae-missing-release-tag) "BackendRegistrable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface BackendRegistrable {
+  // (undocumented)
+  id: string;
+  // (undocumented)
+  register(reg: BackendInitRegistry): void;
+}
+
+// @public (undocumented)
+export const cacheServiceRef: ServiceRef<PluginCacheManager>;
+
+// @public (undocumented)
+export const configServiceRef: ServiceRef<Config>;
+
+// Warning: (ae-missing-release-tag) "createBackendModule" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createBackendModule<TOptions>(
+  config: BackendModuleConfig<TOptions>,
+): (option: TOptions) => BackendRegistrable;
+
+// Warning: (ae-missing-release-tag) "createBackendPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createBackendPlugin<TOptions>(
+  config: BackendPluginConfig<TOptions>,
+): (option: TOptions) => BackendRegistrable;
+
+// Warning: (ae-missing-release-tag) "createExtensionPoint" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createExtensionPoint<T>(options: {
+  id: string;
+}): ExtensionPoint<T>;
+
+// @public (undocumented)
+export function createServiceFactory<
+  Api,
+  Impl extends Api,
+  Deps extends {
+    [name in string]: unknown;
+  },
+>(factory: ServiceFactory<Api, Impl, Deps>): ServiceFactory<Api, Api, {}>;
+
+// @public (undocumented)
+export function createServiceRef<T>(options: { id: string }): ServiceRef<T>;
+
+// @public (undocumented)
+export const databaseServiceRef: ServiceRef<PluginDatabaseManager>;
+
+// @public (undocumented)
+export const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery>;
+
+// @public
+export type ExtensionPoint<T> = {
+  id: string;
+  T: T;
+  toString(): string;
+  $$ref: 'extension-point';
+};
+
+// Warning: (ae-missing-release-tag) "FactoryFunc" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;
+
+// @public (undocumented)
+export interface HttpRouterService {
+  // (undocumented)
+  use(handler: Handler): void;
+}
+
+// @public (undocumented)
+export const httpRouterServiceRef: ServiceRef<HttpRouterService>;
+
+// @public (undocumented)
+export interface Logger {
+  // (undocumented)
+  child(fields: { [name: string]: string }): Logger;
+  // (undocumented)
+  info(message: string): void;
+}
+
+// @public (undocumented)
+export const loggerServiceRef: ServiceRef<Logger>;
+
+// @public (undocumented)
+export const permissionsServiceRef: ServiceRef<
+  PermissionAuthorizer | PermissionEvaluator
+>;
+
+// @public (undocumented)
+export const schedulerServiceRef: ServiceRef<PluginTaskScheduler>;
+
+// Warning: (ae-missing-release-tag) "ServiceFactory" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type ServiceFactory<
+  TApi,
+  TImpl extends TApi,
+  TDeps extends {
+    [name in string]: unknown;
+  },
+> = {
+  service: ServiceRef<TApi>;
+  deps: TypesToServiceRef<TDeps>;
+  factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;
+};
+
+// @public
+export type ServiceRef<T> = {
+  id: string;
+  T: T;
+  toString(): string;
+  $$ref: 'service';
+};
+
+// @public (undocumented)
+export const tokenManagerServiceRef: ServiceRef<TokenManager>;
+
+// @public (undocumented)
+export const urlReaderServiceRef: ServiceRef<UrlReader>;
+
+// Warnings were encountered during analysis:
+//
+// src/services/system/types.d.ts:27:5 - (ae-forgotten-export) The symbol "TypesToServiceRef" needs to be exported by the entry point index.d.ts
+// src/services/system/types.d.ts:28:5 - (ae-forgotten-export) The symbol "DepsToDepFactories" needs to be exported by the entry point index.d.ts
+// src/wiring/types.d.ts:10:67 - (tsdoc-code-span-missing-delimiter) The code span is missing its closing backtick
+// src/wiring/types.d.ts:11:24 - (tsdoc-code-span-missing-delimiter) The code span is missing its closing backtick
+```