@backstage/backend-plugin-api 0.2.0 → 0.2.1-next.0

package/dist/index.beta.d.ts

@@ -4,6 +4,8 @@
  * @packageDocumentation
  */
 
+/// <reference types="node" />
+
 import { Config } from '@backstage/config';
 import { Handler } from 'express';
 import { Logger } from 'winston';
@@ -11,11 +13,10 @@ 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 { Readable } from 'stream';
 import { TokenManager } from '@backstage/backend-common';
 import { TransportStreamOptions } from 'winston-transport';
-import { UrlReader } from '@backstage/backend-common';
 
 /** @public */
 export declare interface BackendFeature {
@@ -79,6 +80,7 @@ declare namespace coreServices {
         tokenManagerServiceRef as tokenManager,
         permissionsServiceRef as permissions,
         schedulerServiceRef as scheduler,
+        rootLifecycleServiceRef as rootLifecycle,
         rootLoggerServiceRef as rootLogger,
         pluginMetadataServiceRef as pluginMetadata,
         lifecycleServiceRef as lifecycle
@@ -144,13 +146,57 @@ export declare type DatabaseService = PluginDatabaseManager;
  */
 declare const databaseServiceRef: ServiceRef<PluginDatabaseManager, "plugin">;
 
-/** @public */
-export declare type DiscoveryService = PluginEndpointDiscovery;
+/**
+ * The DiscoveryService is used to provide a mechanism for backend
+ * plugins to discover the endpoints for itself or other backend plugins.
+ *
+ * The purpose of the discovery API is to allow for many different deployment
+ * setups and routing methods through a central configuration, instead
+ * of letting each individual plugin manage that configuration.
+ *
+ * Implementations of the discovery API can be as simple as a URL pattern
+ * using the pluginId, but could also have overrides for individual plugins,
+ * or query a separate discovery service.
+ *
+ * @public
+ */
+export declare type DiscoveryService = {
+    /**
+     * Returns the internal HTTP base URL for a given plugin, without a trailing slash.
+     *
+     * The returned URL should point to an internal endpoint for the plugin, with
+     * the shortest route possible. The URL should be used for service-to-service
+     * communication within a Backstage backend deployment.
+     *
+     * This method must always be called just before making a request, as opposed to
+     * fetching the URL when constructing an API client. That is to ensure that more
+     * flexible routing patterns can be supported.
+     *
+     * For example, asking for the URL for `catalog` may return something
+     * like `http://10.1.2.3/api/catalog`
+     */
+    getBaseUrl(pluginId: string): Promise<string>;
+    /**
+     * Returns the external HTTP base backend URL for a given plugin, without a trailing slash.
+     *
+     * The returned URL should point to an external endpoint for the plugin, such that
+     * it is reachable from the Backstage frontend and other external services. The returned
+     * URL should be usable for example as a callback / webhook URL.
+     *
+     * The returned URL should be stable and in general not change unless other static
+     * or external configuration is changed. Changes should not come as a surprise
+     * to an operator of the Backstage backend.
+     *
+     * For example, asking for the URL for `catalog` may return something
+     * like `https://backstage.example.com/api/catalog`
+     */
+    getExternalBaseUrl(pluginId: string): Promise<string>;
+};
 
 /**
  * @public
  */
-declare const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery, "plugin">;
+declare const discoveryServiceRef: ServiceRef<DiscoveryService, "plugin">;
 
 /**
  * TODO
@@ -200,6 +246,8 @@ declare const lifecycleServiceRef: ServiceRef<LifecycleService, "plugin">;
  **/
 export declare type LifecycleServiceShutdownHook = {
     fn: () => void | Promise<void>;
+    /** Labels to help identify the shutdown hook */
+    labels?: Record<string, string>;
 };
 
 /**
@@ -248,6 +296,187 @@ export declare interface PluginMetadataService {
  */
 declare const pluginMetadataServiceRef: ServiceRef<PluginMetadataService, "plugin">;
 
+/**
+ * An options object for {@link UrlReaderService.readTree} operations.
+ *
+ * @public
+ */
+export declare type ReadTreeOptions = {
+    /**
+     * A filter that can be used to select which files should be included.
+     *
+     * @remarks
+     *
+     * The path passed to the filter function is the relative path from the URL
+     * that the file tree is fetched from, without any leading '/'.
+     *
+     * For example, given the URL https://github.com/my/repo/tree/master/my-dir, a file
+     * at https://github.com/my/repo/blob/master/my-dir/my-subdir/my-file.txt will
+     * be represented as my-subdir/my-file.txt
+     *
+     * If no filter is provided, all files are extracted.
+     */
+    filter?(path: string, info?: {
+        size: number;
+    }): boolean;
+    /**
+     * An ETag which can be provided to check whether a
+     * {@link UrlReaderService.readTree} response has changed from a previous execution.
+     *
+     * @remarks
+     *
+     * In the {@link UrlReaderService.readTree} response, an ETag is returned along with
+     * the tree blob. The ETag is a unique identifier of the tree blob, usually
+     * the commit SHA or ETag from the target.
+     *
+     * When an ETag is given as a request option, {@link UrlReaderService.readTree} will
+     * first compare the ETag against the ETag on the target branch. If they
+     * match, {@link UrlReaderService.readTree} will throw a
+     * {@link @backstage/errors#NotModifiedError} indicating that the response
+     * will not differ from the previous response which included this particular
+     * ETag. If they do not match, {@link UrlReaderService.readTree} will return the
+     * rest of the response along with a new ETag.
+     */
+    etag?: string;
+    /**
+     * An abort signal to pass down to the underlying request.
+     *
+     * @remarks
+     *
+     * Not all reader implementations may take this field into account.
+     */
+    signal?: AbortSignal;
+};
+
+/**
+ * A response object for {@link UrlReaderService.readTree} operations.
+ *
+ * @public
+ */
+export declare type ReadTreeResponse = {
+    /**
+     * Returns an array of all the files inside the tree, and corresponding
+     * functions to read their content.
+     */
+    files(): Promise<ReadTreeResponseFile[]>;
+    /**
+     * Returns the tree contents as a binary archive, using a stream.
+     */
+    archive(): Promise<NodeJS.ReadableStream>;
+    /**
+     * Extracts the tree response into a directory and returns the path of the
+     * directory.
+     *
+     * **NOTE**: It is the responsibility of the caller to remove the directory after use.
+     */
+    dir(options?: ReadTreeResponseDirOptions): Promise<string>;
+    /**
+     * Etag returned by content provider.
+     *
+     * @remarks
+     *
+     * Can be used to compare and cache responses when doing subsequent calls.
+     */
+    etag: string;
+};
+
+/**
+ * Options that control {@link ReadTreeResponse.dir} execution.
+ *
+ * @public
+ */
+export declare type ReadTreeResponseDirOptions = {
+    /**
+     * The directory to write files to.
+     *
+     * @remarks
+     *
+     * Defaults to the OS tmpdir, or `backend.workingDirectory` if set in config.
+     */
+    targetDir?: string;
+};
+
+/**
+ * Represents a single file in a {@link UrlReaderService.readTree} response.
+ *
+ * @public
+ */
+export declare type ReadTreeResponseFile = {
+    path: string;
+    content(): Promise<Buffer>;
+};
+
+/**
+ * An options object for readUrl operations.
+ *
+ * @public
+ */
+export declare type ReadUrlOptions = {
+    /**
+     * An ETag which can be provided to check whether a
+     * {@link UrlReaderService.readUrl} response has changed from a previous execution.
+     *
+     * @remarks
+     *
+     * In the {@link UrlReaderService.readUrl} response, an ETag is returned along with
+     * the data. The ETag is a unique identifier of the data, usually the commit
+     * SHA or ETag from the target.
+     *
+     * When an ETag is given in ReadUrlOptions, {@link UrlReaderService.readUrl} will
+     * first compare the ETag against the ETag of the target. If they match,
+     * {@link UrlReaderService.readUrl} will throw a
+     * {@link @backstage/errors#NotModifiedError} indicating that the response
+     * will not differ from the previous response which included this particular
+     * ETag. If they do not match, {@link UrlReaderService.readUrl} will return the rest
+     * of the response along with a new ETag.
+     */
+    etag?: string;
+    /**
+     * An abort signal to pass down to the underlying request.
+     *
+     * @remarks
+     *
+     * Not all reader implementations may take this field into account.
+     */
+    signal?: AbortSignal;
+};
+
+/**
+ * A response object for {@link UrlReaderService.readUrl} operations.
+ *
+ * @public
+ */
+export declare type ReadUrlResponse = {
+    /**
+     * Returns the data that was read from the remote URL.
+     */
+    buffer(): Promise<Buffer>;
+    /**
+     * Returns the data that was read from the remote URL as a Readable stream.
+     *
+     * @remarks
+     *
+     * This method will be required in a future release.
+     */
+    stream?(): Readable;
+    /**
+     * Etag returned by content provider.
+     *
+     * @remarks
+     *
+     * Can be used to compare and cache responses when doing subsequent calls.
+     */
+    etag?: string;
+};
+
+/** @public */
+export declare type RootLifecycleService = LifecycleService;
+
+/**
+ * @public
+ */
+declare const rootLifecycleServiceRef: ServiceRef<LifecycleService, "root">;
+
 /** @public */
 export declare type RootLoggerService = LoggerService;
 
@@ -264,6 +493,66 @@ export declare type SchedulerService = PluginTaskScheduler;
  */
 declare const schedulerServiceRef: ServiceRef<PluginTaskScheduler, "plugin">;
 
+/**
+ * An options object for search operations.
+ *
+ * @public
+ */
+export declare type SearchOptions = {
+    /**
+     * An etag can be provided to check whether the search response has changed from a previous execution.
+     *
+     * In the search() response, an etag is returned along with the files. The etag is a unique identifier
+     * of the current tree, usually the commit SHA or etag from the target.
+     *
+     * When an etag is given in SearchOptions, search will first compare the etag against the etag
+     * on the target branch. If they match, search will throw a NotModifiedError indicating that the search
+     * response will not differ from the previous response which included this particular etag. If they mismatch,
+     * search will return the rest of SearchResponse along with a new etag.
+     */
+    etag?: string;
+    /**
+     * An abort signal to pass down to the underlying request.
+     *
+     * @remarks
+     *
+     * Not all reader implementations may take this field into account.
+     */
+    signal?: AbortSignal;
+};
+
+/**
+ * The output of a search operation.
+ *
+ * @public
+ */
+export declare type SearchResponse = {
+    /**
+     * The files that matched the search query.
+     */
+    files: SearchResponseFile[];
+    /**
+     * A unique identifier of the current remote tree, usually the commit SHA or etag from the target.
+     */
+    etag: string;
+};
+
+/**
+ * Represents a single file in a search response.
+ *
+ * @public
+ */
+export declare type SearchResponseFile = {
+    /**
+     * The full URL to the file.
+     */
+    url: string;
+    /**
+     * The binary contents of the file.
+     */
+    content(): Promise<Buffer>;
+};
+
 /** @public */
 export declare type ServiceFactory<TService = unknown> = {
     scope: 'root';
@@ -335,12 +624,29 @@ export declare type TypesToServiceRef<T> = {
     [key in keyof T]: ServiceRef<T[key]>;
 };
 
-/** @public */
-export declare type UrlReaderService = UrlReader;
+/**
+ * A generic interface for fetching plain data from URLs.
+ *
+ * @public
+ */
+export declare type UrlReaderService = {
+    /**
+     * Reads a single file and return its content.
+     */
+    readUrl(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;
+    /**
+     * Reads a full or partial file tree.
+     */
+    readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;
+    /**
+     * Searches for a file in a tree using a glob pattern.
+     */
+    search(url: string, options?: SearchOptions): Promise<SearchResponse>;
+};
 
 /**
  * @public
  */
-declare const urlReaderServiceRef: ServiceRef<UrlReader, "plugin">;
+declare const urlReaderServiceRef: ServiceRef<UrlReaderService, "plugin">;
 
 export { }

package/dist/index.cjs.js

@@ -76,6 +76,11 @@ const schedulerServiceRef = createServiceRef({
   id: "core.scheduler"
 });
 
+const rootLifecycleServiceRef = createServiceRef({
+  id: "core.rootLifecycle",
+  scope: "root"
+});
+
 const rootLoggerServiceRef = createServiceRef({
   id: "core.root.logger",
   scope: "root"
@@ -104,6 +109,7 @@ var coreServices = /*#__PURE__*/Object.freeze({
   tokenManager: tokenManagerServiceRef,
   permissions: permissionsServiceRef,
   scheduler: schedulerServiceRef,
+  rootLifecycle: rootLifecycleServiceRef,
   rootLogger: rootLoggerServiceRef,
   pluginMetadata: pluginMetadataServiceRef,
   lifecycle: lifecycleServiceRef

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/services/system/types.ts","../src/services/definitions/configServiceRef.ts","../src/services/definitions/httpRouterServiceRef.ts","../src/services/definitions/loggerServiceRef.ts","../src/services/definitions/urlReaderServiceRef.ts","../src/services/definitions/cacheServiceRef.ts","../src/services/definitions/databaseServiceRef.ts","../src/services/definitions/discoveryServiceRef.ts","../src/services/definitions/tokenManagerServiceRef.ts","../src/services/definitions/permissionsServiceRef.ts","../src/services/definitions/schedulerServiceRef.ts","../src/services/definitions/rootLoggerServiceRef.ts","../src/services/definitions/pluginMetadataServiceRef.ts","../src/services/definitions/lifecycleServiceRef.ts","../src/services/helpers/loggerToWinstonLogger.ts","../src/wiring/factories.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * TODO\n *\n * @public\n */\nexport type ServiceRef<\n  TService,\n  TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n  id: string;\n\n  /**\n   * This determines the scope at which this service is available.\n   *\n   * Root scoped services are available to all other services but\n   * may only depend on other root scoped services.\n   *\n   * Plugin scoped services are only available to other plugin scoped\n   * services but may depend on all other services.\n   */\n  scope: TScope;\n\n  /**\n   * Utility for getting the type of the service, using `typeof serviceRef.T`.\n   * Attempting to actually read this value will result in an exception.\n   */\n  T: TService;\n\n  toString(): string;\n\n  $$ref: 'service';\n};\n\n/** @public */\nexport type TypesToServiceRef<T> = { [key in keyof T]: ServiceRef<T[key]> };\n\n/** @public */\nexport type ServiceFactory<TService = unknown> =\n  | {\n      // This scope prop is needed in addition to the service ref, as TypeScript\n      // can't properly discriminate the two factory types otherwise.\n      scope: 'root';\n      service: ServiceRef<TService, 'root'>;\n      deps: { [key in string]: ServiceRef<unknown> };\n      factory(deps: { [key in string]: unknown }): Promise<TService>;\n    }\n  | {\n      scope: 'plugin';\n      service: ServiceRef<TService, 'plugin'>;\n      deps: { [key in string]: ServiceRef<unknown> };\n      factory(deps: { [key in string]: unknown }): Promise<\n        (deps: { [key in string]: unknown }) => Promise<TService>\n      >;\n    };\n\n/** @public */\nexport function createServiceRef<T>(options: {\n  id: string;\n  scope?: 'plugin';\n  defaultFactory?: (\n    service: ServiceRef<T, 'plugin'>,\n  ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'plugin'>;\n/** @public */\nexport function createServiceRef<T>(options: {\n  id: string;\n  scope: 'root';\n  defaultFactory?: (\n    service: ServiceRef<T, 'root'>,\n  ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'root'>;\nexport function createServiceRef<T>(options: {\n  id: string;\n  scope?: 'plugin' | 'root';\n  defaultFactory?:\n    | ((\n        service: ServiceRef<T, 'plugin'>,\n      ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>)\n    | ((\n        service: ServiceRef<T, 'root'>,\n      ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>);\n}): ServiceRef<T> {\n  const { id, scope = 'plugin', defaultFactory } = options;\n  return {\n    id,\n    scope,\n    get T(): T {\n      throw new Error(`tried to read ServiceRef.T of ${this}`);\n    },\n    toString() {\n      return `serviceRef{${options.id}}`;\n    },\n    $$ref: 'service', // TODO: declare\n    __defaultFactory: defaultFactory,\n  } as ServiceRef<T, typeof scope> & {\n    __defaultFactory?: (\n      service: ServiceRef<T>,\n    ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n  };\n}\n\n/** @ignore */\ntype ServiceRefsToInstances<\n  T extends { [key in string]: ServiceRef<unknown> },\n  TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n  [name in {\n    [key in keyof T]: T[key] extends ServiceRef<unknown, TScope> ? key : never;\n  }[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;\n};\n\n/**\n * @public\n */\nexport function createServiceFactory<\n  TService,\n  TScope extends 'root' | 'plugin',\n  TImpl extends TService,\n  TDeps extends { [name in string]: ServiceRef<unknown> },\n  TOpts extends object | undefined = undefined,\n>(config: {\n  service: ServiceRef<TService, TScope>;\n  deps: TDeps;\n  factory(\n    deps: ServiceRefsToInstances<TDeps, 'root'>,\n    options: TOpts,\n  ): TScope extends 'root'\n    ? Promise<TImpl>\n    : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;\n}): undefined extends TOpts\n  ? (options?: TOpts) => ServiceFactory<TService>\n  : (options: TOpts) => ServiceFactory<TService> {\n  return (options?: TOpts) =>\n    ({\n      scope: config.service.scope,\n      service: config.service,\n      deps: config.deps,\n      factory(deps: ServiceRefsToInstances<TDeps, 'root'>) {\n        return config.factory(deps, options!);\n      },\n    } as ServiceFactory<TService>);\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport type ConfigService = Config;\n\n/**\n * @public\n */\nexport const configServiceRef = createServiceRef<ConfigService>({\n  id: 'core.root.config',\n  scope: 'root',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { Handler } from 'express';\n\n/**\n * @public\n */\nexport interface HttpRouterService {\n  use(handler: Handler): void;\n}\n\n/**\n * @public\n */\nexport const httpRouterServiceRef = createServiceRef<HttpRouterService>({\n  id: 'core.httpRouter',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport type LogMeta = { [name: string]: unknown };\n\n/**\n * @public\n */\nexport interface LoggerService {\n  error(message: string, meta?: Error | LogMeta): void;\n  warn(message: string, meta?: Error | LogMeta): void;\n  info(message: string, meta?: Error | LogMeta): void;\n  debug(message: string, meta?: Error | LogMeta): void;\n\n  child(meta: LogMeta): LoggerService;\n}\n\n/**\n * @public\n */\nexport const loggerServiceRef = createServiceRef<LoggerService>({\n  id: 'core.logger',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { UrlReader } from '@backstage/backend-common';\n\n/** @public */\nexport type UrlReaderService = UrlReader;\n\n/**\n * @public\n */\nexport const urlReaderServiceRef = createServiceRef<UrlReaderService>({\n  id: 'core.urlReader',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginCacheManager } from '@backstage/backend-common';\n\n/** @public */\nexport type CacheService = PluginCacheManager;\n\n/**\n * @public\n */\nexport const cacheServiceRef = createServiceRef<CacheService>({\n  id: 'core.cache',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PluginDatabaseManager } from '@backstage/backend-common';\nimport { createServiceRef } from '../system/types';\n\n/** @public */\nexport type DatabaseService = PluginDatabaseManager;\n\n/**\n * @public\n */\nexport const databaseServiceRef = createServiceRef<DatabaseService>({\n  id: 'core.database',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginEndpointDiscovery } from '@backstage/backend-common';\n\n/** @public */\nexport type DiscoveryService = PluginEndpointDiscovery;\n\n/**\n * @public\n */\nexport const discoveryServiceRef = createServiceRef<DiscoveryService>({\n  id: 'core.discovery',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { TokenManager } from '@backstage/backend-common';\n\n/** @public */\nexport type TokenManagerService = TokenManager;\n\n/**\n * @public\n */\nexport const tokenManagerServiceRef = createServiceRef<TokenManagerService>({\n  id: 'core.tokenManager',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport {\n  PermissionAuthorizer,\n  PermissionEvaluator,\n} from '@backstage/plugin-permission-common';\n\n/** @public */\nexport type PermissionsService = PermissionEvaluator | PermissionAuthorizer;\n\n/**\n * @public\n */\nexport const permissionsServiceRef = createServiceRef<PermissionsService>({\n  id: 'core.permissions',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginTaskScheduler } from '@backstage/backend-tasks';\n\n/** @public */\nexport type SchedulerService = PluginTaskScheduler;\n\n/**\n * @public\n */\nexport const schedulerServiceRef = createServiceRef<SchedulerService>({\n  id: 'core.scheduler',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { LoggerService } from './loggerServiceRef';\n\n/** @public */\nexport type RootLoggerService = LoggerService;\n\n/**\n * @public\n */\nexport const rootLoggerServiceRef = createServiceRef<RootLoggerService>({\n  id: 'core.root.logger',\n  scope: 'root',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport interface PluginMetadataService {\n  getId(): string;\n}\n\n/**\n * @public\n */\nexport const pluginMetadataServiceRef = createServiceRef<PluginMetadataService>(\n  {\n    id: 'core.plugin-metadata',\n  },\n);\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n **/\nexport type LifecycleServiceShutdownHook = {\n  fn: () => void | Promise<void>;\n};\n\n/**\n * @public\n **/\nexport interface LifecycleService {\n  /**\n   * Register a function to be called when the backend is shutting down.\n   */\n  addShutdownHook(options: LifecycleServiceShutdownHook): void;\n}\n\n/**\n * @public\n */\nexport const lifecycleServiceRef = createServiceRef<LifecycleService>({\n  id: 'core.lifecycle',\n  scope: 'plugin',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { LoggerService } from '../definitions';\nimport { Logger as WinstonLogger, createLogger } from 'winston';\nimport Transport, { TransportStreamOptions } from 'winston-transport';\n\nclass BackstageLoggerTransport extends Transport {\n  constructor(\n    private readonly backstageLogger: LoggerService,\n    opts?: TransportStreamOptions,\n  ) {\n    super(opts);\n  }\n\n  log(info: unknown, callback: VoidFunction) {\n    if (typeof info !== 'object' || info === null) {\n      callback();\n      return;\n    }\n    const { level, message, ...meta } = info as { [name: string]: unknown };\n    switch (level) {\n      case 'error':\n        this.backstageLogger.error(String(message), meta);\n        break;\n      case 'warn':\n        this.backstageLogger.warn(String(message), meta);\n        break;\n      case 'info':\n        this.backstageLogger.info(String(message), meta);\n        break;\n      case 'debug':\n        this.backstageLogger.debug(String(message), meta);\n        break;\n      default:\n        this.backstageLogger.info(String(message), meta);\n    }\n    callback();\n  }\n}\n\n/** @public */\nexport function loggerToWinstonLogger(\n  logger: LoggerService,\n  opts?: TransportStreamOptions,\n): WinstonLogger {\n  return createLogger({\n    transports: [new BackstageLoggerTransport(logger, opts)],\n  });\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  BackendRegistrationPoints,\n  BackendFeature,\n  ExtensionPoint,\n} from './types';\n\n/** @public */\nexport function createExtensionPoint<T>(options: {\n  id: string;\n}): ExtensionPoint<T> {\n  return {\n    id: options.id,\n    get T(): T {\n      throw new Error(`tried to read ExtensionPoint.T of ${this}`);\n    },\n    toString() {\n      return `extensionPoint{${options.id}}`;\n    },\n    $$ref: 'extension-point', // TODO: declare\n  };\n}\n\n/** @public */\nexport interface BackendPluginConfig<TOptions> {\n  id: string;\n  register(reg: BackendRegistrationPoints, options: TOptions): void;\n}\n\n/** @public */\nexport function createBackendPlugin<\n  TOptions extends object | undefined = undefined,\n>(config: {\n  id: string;\n  register(reg: BackendRegistrationPoints, options: TOptions): void;\n}): undefined extends TOptions\n  ? (options?: TOptions) => BackendFeature\n  : (options: TOptions) => BackendFeature {\n  return (options?: TOptions) => ({\n    id: config.id,\n    register(register: BackendRegistrationPoints) {\n      return config.register(register, options!);\n    },\n  });\n}\n\n/** @public */\nexport interface BackendModuleConfig<TOptions> {\n  pluginId: string;\n  moduleId: string;\n  register(\n    reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>,\n    options: TOptions,\n  ): void;\n}\n\n/**\n * @public\n *\n * Creates a new backend module for a given plugin.\n *\n * The `moduleId` should be equal to the module-specific prefix of the exported name, such\n * that the full name is `moduleId + PluginId + \"Module\"`. For example, a GitHub entity\n * provider module for the `catalog` plugin might have the module ID `'githubEntityProvider'`,\n * and the full exported name would be `githubEntityProviderCatalogModule`.\n *\n * The `pluginId` should exactly match the `id` of the plugin that the module extends.\n */\nexport function createBackendModule<\n  TOptions extends object | undefined = undefined,\n>(\n  config: BackendModuleConfig<TOptions>,\n): undefined extends TOptions\n  ? (options?: TOptions) => BackendFeature\n  : (options: TOptions) => BackendFeature {\n  return (options?: TOptions) => ({\n    id: `${config.pluginId}.${config.moduleId}`,\n    register(register: BackendRegistrationPoints) {\n      // TODO: Hide registerExtensionPoint\n      return config.register(register, options!);\n    },\n  });\n}\n"],"names":["Transport","createLogger"],"mappings":";;;;;;;;;;;AAuFO,SAAS,iBAAoB,OAUlB,EAAA;AAChB,EAAA,MAAM,EAAE,EAAA,EAAI,KAAQ,GAAA,QAAA,EAAU,gBAAmB,GAAA,OAAA,CAAA;AACjD,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,8BAAA,EAAiC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KACzD;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,cAAc,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAC/B;AAAA,IACA,KAAO,EAAA,SAAA;AAAA,IACP,gBAAkB,EAAA,cAAA;AAAA,GACpB,CAAA;AAKF,CAAA;AAeO,SAAS,qBAMd,MAW+C,EAAA;AAC/C,EAAA,OAAO,CAAC,OACL,MAAA;AAAA,IACC,KAAA,EAAO,OAAO,OAAQ,CAAA,KAAA;AAAA,IACtB,SAAS,MAAO,CAAA,OAAA;AAAA,IAChB,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,QAAQ,IAA6C,EAAA;AACnD,MAAO,OAAA,MAAA,CAAO,OAAQ,CAAA,IAAA,EAAM,OAAQ,CAAA,CAAA;AAAA,KACtC;AAAA,GACF,CAAA,CAAA;AACJ;;AClIO,MAAM,mBAAmB,gBAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACDM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,iBAAA;AACN,CAAC,CAAA;;ACOM,MAAM,mBAAmB,gBAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,aAAA;AACN,CAAC,CAAA;;ACfM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,kBAAkB,gBAA+B,CAAA;AAAA,EAC5D,EAAI,EAAA,YAAA;AACN,CAAC,CAAA;;ACFM,MAAM,qBAAqB,gBAAkC,CAAA;AAAA,EAClE,EAAI,EAAA,eAAA;AACN,CAAC,CAAA;;ACFM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,yBAAyB,gBAAsC,CAAA;AAAA,EAC1E,EAAI,EAAA,mBAAA;AACN,CAAC,CAAA;;ACCM,MAAM,wBAAwB,gBAAqC,CAAA;AAAA,EACxE,EAAI,EAAA,kBAAA;AACN,CAAC,CAAA;;ACLM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACAM,MAAM,wBAA2B,GAAA,gBAAA;AAAA,EACtC;AAAA,IACE,EAAI,EAAA,sBAAA;AAAA,GACN;AACF,CAAA;;ACMO,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AACT,CAAC,CAAA;;;;;;;;;;;;;;;;;;;ACrBD,MAAM,iCAAiCA,6BAAU,CAAA;AAAA,EAC/C,WAAA,CACmB,iBACjB,IACA,EAAA;AACA,IAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAHO,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA,CAAA;AAAA,GAInB;AAAA,EAEA,GAAA,CAAI,MAAe,QAAwB,EAAA;AACzC,IAAA,IAAI,OAAO,IAAA,KAAS,QAAY,IAAA,IAAA,KAAS,IAAM,EAAA;AAC7C,MAAS,QAAA,EAAA,CAAA;AACT,MAAA,OAAA;AAAA,KACF;AACA,IAAA,MAAM,EAAE,KAAA,EAAO,OAAY,EAAA,GAAA,IAAA,EAAS,GAAA,IAAA,CAAA;AACpC,IAAA,QAAQ,KAAO;AAAA,MACb,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAChD,QAAA,MAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAC/C,QAAA,MAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAC/C,QAAA,MAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAChD,QAAA,MAAA;AAAA,MACF;AACE,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAAA,KACnD;AACA,IAAS,QAAA,EAAA,CAAA;AAAA,GACX;AACF,CAAA;AAGgB,SAAA,qBAAA,CACd,QACA,IACe,EAAA;AACf,EAAA,OAAOC,oBAAa,CAAA;AAAA,IAClB,YAAY,CAAC,IAAI,wBAAyB,CAAA,MAAA,EAAQ,IAAI,CAAC,CAAA;AAAA,GACxD,CAAA,CAAA;AACH;;ACvCO,SAAS,qBAAwB,OAElB,EAAA;AACpB,EAAO,OAAA;AAAA,IACL,IAAI,OAAQ,CAAA,EAAA;AAAA,IACZ,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,kCAAA,EAAqC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KAC7D;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,kBAAkB,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KACnC;AAAA,IACA,KAAO,EAAA,iBAAA;AAAA,GACT,CAAA;AACF,CAAA;AASO,SAAS,oBAEd,MAKwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,IAAI,MAAO,CAAA,EAAA;AAAA,IACX,SAAS,QAAqC,EAAA;AAC5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF,CAAA;AAwBO,SAAS,oBAGd,MAGwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,EAAI,EAAA,CAAA,EAAG,MAAO,CAAA,QAAA,CAAA,CAAA,EAAY,MAAO,CAAA,QAAA,CAAA,CAAA;AAAA,IACjC,SAAS,QAAqC,EAAA;AAE5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/services/system/types.ts","../src/services/definitions/configServiceRef.ts","../src/services/definitions/httpRouterServiceRef.ts","../src/services/definitions/loggerServiceRef.ts","../src/services/definitions/urlReaderServiceRef.ts","../src/services/definitions/cacheServiceRef.ts","../src/services/definitions/databaseServiceRef.ts","../src/services/definitions/discoveryServiceRef.ts","../src/services/definitions/tokenManagerServiceRef.ts","../src/services/definitions/permissionsServiceRef.ts","../src/services/definitions/schedulerServiceRef.ts","../src/services/definitions/rootLifecycleServiceRef.ts","../src/services/definitions/rootLoggerServiceRef.ts","../src/services/definitions/pluginMetadataServiceRef.ts","../src/services/definitions/lifecycleServiceRef.ts","../src/services/helpers/loggerToWinstonLogger.ts","../src/wiring/factories.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * TODO\n *\n * @public\n */\nexport type ServiceRef<\n  TService,\n  TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n  id: string;\n\n  /**\n   * This determines the scope at which this service is available.\n   *\n   * Root scoped services are available to all other services but\n   * may only depend on other root scoped services.\n   *\n   * Plugin scoped services are only available to other plugin scoped\n   * services but may depend on all other services.\n   */\n  scope: TScope;\n\n  /**\n   * Utility for getting the type of the service, using `typeof serviceRef.T`.\n   * Attempting to actually read this value will result in an exception.\n   */\n  T: TService;\n\n  toString(): string;\n\n  $$ref: 'service';\n};\n\n/** @public */\nexport type TypesToServiceRef<T> = { [key in keyof T]: ServiceRef<T[key]> };\n\n/** @public */\nexport type ServiceFactory<TService = unknown> =\n  | {\n      // This scope prop is needed in addition to the service ref, as TypeScript\n      // can't properly discriminate the two factory types otherwise.\n      scope: 'root';\n      service: ServiceRef<TService, 'root'>;\n      deps: { [key in string]: ServiceRef<unknown> };\n      factory(deps: { [key in string]: unknown }): Promise<TService>;\n    }\n  | {\n      scope: 'plugin';\n      service: ServiceRef<TService, 'plugin'>;\n      deps: { [key in string]: ServiceRef<unknown> };\n      factory(deps: { [key in string]: unknown }): Promise<\n        (deps: { [key in string]: unknown }) => Promise<TService>\n      >;\n    };\n\n/** @public */\nexport function createServiceRef<T>(options: {\n  id: string;\n  scope?: 'plugin';\n  defaultFactory?: (\n    service: ServiceRef<T, 'plugin'>,\n  ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'plugin'>;\n/** @public */\nexport function createServiceRef<T>(options: {\n  id: string;\n  scope: 'root';\n  defaultFactory?: (\n    service: ServiceRef<T, 'root'>,\n  ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'root'>;\nexport function createServiceRef<T>(options: {\n  id: string;\n  scope?: 'plugin' | 'root';\n  defaultFactory?:\n    | ((\n        service: ServiceRef<T, 'plugin'>,\n      ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>)\n    | ((\n        service: ServiceRef<T, 'root'>,\n      ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>);\n}): ServiceRef<T> {\n  const { id, scope = 'plugin', defaultFactory } = options;\n  return {\n    id,\n    scope,\n    get T(): T {\n      throw new Error(`tried to read ServiceRef.T of ${this}`);\n    },\n    toString() {\n      return `serviceRef{${options.id}}`;\n    },\n    $$ref: 'service', // TODO: declare\n    __defaultFactory: defaultFactory,\n  } as ServiceRef<T, typeof scope> & {\n    __defaultFactory?: (\n      service: ServiceRef<T>,\n    ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n  };\n}\n\n/** @ignore */\ntype ServiceRefsToInstances<\n  T extends { [key in string]: ServiceRef<unknown> },\n  TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n  [name in {\n    [key in keyof T]: T[key] extends ServiceRef<unknown, TScope> ? key : never;\n  }[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;\n};\n\n/**\n * @public\n */\nexport function createServiceFactory<\n  TService,\n  TScope extends 'root' | 'plugin',\n  TImpl extends TService,\n  TDeps extends { [name in string]: ServiceRef<unknown> },\n  TOpts extends object | undefined = undefined,\n>(config: {\n  service: ServiceRef<TService, TScope>;\n  deps: TDeps;\n  factory(\n    deps: ServiceRefsToInstances<TDeps, 'root'>,\n    options: TOpts,\n  ): TScope extends 'root'\n    ? Promise<TImpl>\n    : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;\n}): undefined extends TOpts\n  ? (options?: TOpts) => ServiceFactory<TService>\n  : (options: TOpts) => ServiceFactory<TService> {\n  return (options?: TOpts) =>\n    ({\n      scope: config.service.scope,\n      service: config.service,\n      deps: config.deps,\n      factory(deps: ServiceRefsToInstances<TDeps, 'root'>) {\n        return config.factory(deps, options!);\n      },\n    } as ServiceFactory<TService>);\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport type ConfigService = Config;\n\n/**\n * @public\n */\nexport const configServiceRef = createServiceRef<ConfigService>({\n  id: 'core.root.config',\n  scope: 'root',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { Handler } from 'express';\n\n/**\n * @public\n */\nexport interface HttpRouterService {\n  use(handler: Handler): void;\n}\n\n/**\n * @public\n */\nexport const httpRouterServiceRef = createServiceRef<HttpRouterService>({\n  id: 'core.httpRouter',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport type LogMeta = { [name: string]: unknown };\n\n/**\n * @public\n */\nexport interface LoggerService {\n  error(message: string, meta?: Error | LogMeta): void;\n  warn(message: string, meta?: Error | LogMeta): void;\n  info(message: string, meta?: Error | LogMeta): void;\n  debug(message: string, meta?: Error | LogMeta): void;\n\n  child(meta: LogMeta): LoggerService;\n}\n\n/**\n * @public\n */\nexport const loggerServiceRef = createServiceRef<LoggerService>({\n  id: 'core.logger',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { Readable } from 'stream';\n\n/**\n * A generic interface for fetching plain data from URLs.\n *\n * @public\n */\nexport type UrlReaderService = {\n  /**\n   * Reads a single file and return its content.\n   */\n  readUrl(url: string, options?: ReadUrlOptions): Promise<ReadUrlResponse>;\n\n  /**\n   * Reads a full or partial file tree.\n   */\n  readTree(url: string, options?: ReadTreeOptions): Promise<ReadTreeResponse>;\n\n  /**\n   * Searches for a file in a tree using a glob pattern.\n   */\n  search(url: string, options?: SearchOptions): Promise<SearchResponse>;\n};\n\n/**\n * An options object for readUrl operations.\n *\n * @public\n */\nexport type ReadUrlOptions = {\n  /**\n   * An ETag which can be provided to check whether a\n   * {@link UrlReaderService.readUrl} response has changed from a previous execution.\n   *\n   * @remarks\n   *\n   * In the {@link UrlReaderService.readUrl} response, an ETag is returned along with\n   * the data. The ETag is a unique identifier of the data, usually the commit\n   * SHA or ETag from the target.\n   *\n   * When an ETag is given in ReadUrlOptions, {@link UrlReaderService.readUrl} will\n   * first compare the ETag against the ETag of the target. If they match,\n   * {@link UrlReaderService.readUrl} will throw a\n   * {@link @backstage/errors#NotModifiedError} indicating that the response\n   * will not differ from the previous response which included this particular\n   * ETag. If they do not match, {@link UrlReaderService.readUrl} will return the rest\n   * of the response along with a new ETag.\n   */\n  etag?: string;\n\n  /**\n   * An abort signal to pass down to the underlying request.\n   *\n   * @remarks\n   *\n   * Not all reader implementations may take this field into account.\n   */\n  signal?: AbortSignal;\n};\n\n/**\n * A response object for {@link UrlReaderService.readUrl} operations.\n *\n * @public\n */\nexport type ReadUrlResponse = {\n  /**\n   * Returns the data that was read from the remote URL.\n   */\n  buffer(): Promise<Buffer>;\n\n  /**\n   * Returns the data that was read from the remote URL as a Readable stream.\n   *\n   * @remarks\n   *\n   * This method will be required in a future release.\n   */\n  stream?(): Readable;\n\n  /**\n   * Etag returned by content provider.\n   *\n   * @remarks\n   *\n   * Can be used to compare and cache responses when doing subsequent calls.\n   */\n  etag?: string;\n};\n\n/**\n * An options object for {@link UrlReaderService.readTree} operations.\n *\n * @public\n */\nexport type ReadTreeOptions = {\n  /**\n   * A filter that can be used to select which files should be included.\n   *\n   * @remarks\n   *\n   * The path passed to the filter function is the relative path from the URL\n   * that the file tree is fetched from, without any leading '/'.\n   *\n   * For example, given the URL https://github.com/my/repo/tree/master/my-dir, a file\n   * at https://github.com/my/repo/blob/master/my-dir/my-subdir/my-file.txt will\n   * be represented as my-subdir/my-file.txt\n   *\n   * If no filter is provided, all files are extracted.\n   */\n  filter?(path: string, info?: { size: number }): boolean;\n\n  /**\n   * An ETag which can be provided to check whether a\n   * {@link UrlReaderService.readTree} response has changed from a previous execution.\n   *\n   * @remarks\n   *\n   * In the {@link UrlReaderService.readTree} response, an ETag is returned along with\n   * the tree blob. The ETag is a unique identifier of the tree blob, usually\n   * the commit SHA or ETag from the target.\n   *\n   * When an ETag is given as a request option, {@link UrlReaderService.readTree} will\n   * first compare the ETag against the ETag on the target branch. If they\n   * match, {@link UrlReaderService.readTree} will throw a\n   * {@link @backstage/errors#NotModifiedError} indicating that the response\n   * will not differ from the previous response which included this particular\n   * ETag. If they do not match, {@link UrlReaderService.readTree} will return the\n   * rest of the response along with a new ETag.\n   */\n  etag?: string;\n\n  /**\n   * An abort signal to pass down to the underlying request.\n   *\n   * @remarks\n   *\n   * Not all reader implementations may take this field into account.\n   */\n  signal?: AbortSignal;\n};\n\n/**\n * Options that control {@link ReadTreeResponse.dir} execution.\n *\n * @public\n */\nexport type ReadTreeResponseDirOptions = {\n  /**\n   * The directory to write files to.\n   *\n   * @remarks\n   *\n   * Defaults to the OS tmpdir, or `backend.workingDirectory` if set in config.\n   */\n  targetDir?: string;\n};\n\n/**\n * A response object for {@link UrlReaderService.readTree} operations.\n *\n * @public\n */\nexport type ReadTreeResponse = {\n  /**\n   * Returns an array of all the files inside the tree, and corresponding\n   * functions to read their content.\n   */\n  files(): Promise<ReadTreeResponseFile[]>;\n\n  /**\n   * Returns the tree contents as a binary archive, using a stream.\n   */\n  archive(): Promise<NodeJS.ReadableStream>;\n\n  /**\n   * Extracts the tree response into a directory and returns the path of the\n   * directory.\n   *\n   * **NOTE**: It is the responsibility of the caller to remove the directory after use.\n   */\n  dir(options?: ReadTreeResponseDirOptions): Promise<string>;\n\n  /**\n   * Etag returned by content provider.\n   *\n   * @remarks\n   *\n   * Can be used to compare and cache responses when doing subsequent calls.\n   */\n  etag: string;\n};\n\n/**\n * Represents a single file in a {@link UrlReaderService.readTree} response.\n *\n * @public\n */\nexport type ReadTreeResponseFile = {\n  path: string;\n  content(): Promise<Buffer>;\n};\n\n/**\n * An options object for search operations.\n *\n * @public\n */\nexport type SearchOptions = {\n  /**\n   * An etag can be provided to check whether the search response has changed from a previous execution.\n   *\n   * In the search() response, an etag is returned along with the files. The etag is a unique identifier\n   * of the current tree, usually the commit SHA or etag from the target.\n   *\n   * When an etag is given in SearchOptions, search will first compare the etag against the etag\n   * on the target branch. If they match, search will throw a NotModifiedError indicating that the search\n   * response will not differ from the previous response which included this particular etag. If they mismatch,\n   * search will return the rest of SearchResponse along with a new etag.\n   */\n  etag?: string;\n\n  /**\n   * An abort signal to pass down to the underlying request.\n   *\n   * @remarks\n   *\n   * Not all reader implementations may take this field into account.\n   */\n  signal?: AbortSignal;\n};\n\n/**\n * The output of a search operation.\n *\n * @public\n */\nexport type SearchResponse = {\n  /**\n   * The files that matched the search query.\n   */\n  files: SearchResponseFile[];\n\n  /**\n   * A unique identifier of the current remote tree, usually the commit SHA or etag from the target.\n   */\n  etag: string;\n};\n\n/**\n * Represents a single file in a search response.\n *\n * @public\n */\nexport type SearchResponseFile = {\n  /**\n   * The full URL to the file.\n   */\n  url: string;\n\n  /**\n   * The binary contents of the file.\n   */\n  content(): Promise<Buffer>;\n};\n\n/**\n * @public\n */\nexport const urlReaderServiceRef = createServiceRef<UrlReaderService>({\n  id: 'core.urlReader',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginCacheManager } from '@backstage/backend-common';\n\n/** @public */\nexport type CacheService = PluginCacheManager;\n\n/**\n * @public\n */\nexport const cacheServiceRef = createServiceRef<CacheService>({\n  id: 'core.cache',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PluginDatabaseManager } from '@backstage/backend-common';\nimport { createServiceRef } from '../system/types';\n\n/** @public */\nexport type DatabaseService = PluginDatabaseManager;\n\n/**\n * @public\n */\nexport const databaseServiceRef = createServiceRef<DatabaseService>({\n  id: 'core.database',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * The DiscoveryService is used to provide a mechanism for backend\n * plugins to discover the endpoints for itself or other backend plugins.\n *\n * The purpose of the discovery API is to allow for many different deployment\n * setups and routing methods through a central configuration, instead\n * of letting each individual plugin manage that configuration.\n *\n * Implementations of the discovery API can be as simple as a URL pattern\n * using the pluginId, but could also have overrides for individual plugins,\n * or query a separate discovery service.\n *\n * @public\n */\nexport type DiscoveryService = {\n  /**\n   * Returns the internal HTTP base URL for a given plugin, without a trailing slash.\n   *\n   * The returned URL should point to an internal endpoint for the plugin, with\n   * the shortest route possible. The URL should be used for service-to-service\n   * communication within a Backstage backend deployment.\n   *\n   * This method must always be called just before making a request, as opposed to\n   * fetching the URL when constructing an API client. That is to ensure that more\n   * flexible routing patterns can be supported.\n   *\n   * For example, asking for the URL for `catalog` may return something\n   * like `http://10.1.2.3/api/catalog`\n   */\n  getBaseUrl(pluginId: string): Promise<string>;\n\n  /**\n   * Returns the external HTTP base backend URL for a given plugin, without a trailing slash.\n   *\n   * The returned URL should point to an external endpoint for the plugin, such that\n   * it is reachable from the Backstage frontend and other external services. The returned\n   * URL should be usable for example as a callback / webhook URL.\n   *\n   * The returned URL should be stable and in general not change unless other static\n   * or external configuration is changed. Changes should not come as a surprise\n   * to an operator of the Backstage backend.\n   *\n   * For example, asking for the URL for `catalog` may return something\n   * like `https://backstage.example.com/api/catalog`\n   */\n  getExternalBaseUrl(pluginId: string): Promise<string>;\n};\n\n/**\n * @public\n */\nexport const discoveryServiceRef = createServiceRef<DiscoveryService>({\n  id: 'core.discovery',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { TokenManager } from '@backstage/backend-common';\n\n/** @public */\nexport type TokenManagerService = TokenManager;\n\n/**\n * @public\n */\nexport const tokenManagerServiceRef = createServiceRef<TokenManagerService>({\n  id: 'core.tokenManager',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport {\n  PermissionAuthorizer,\n  PermissionEvaluator,\n} from '@backstage/plugin-permission-common';\n\n/** @public */\nexport type PermissionsService = PermissionEvaluator | PermissionAuthorizer;\n\n/**\n * @public\n */\nexport const permissionsServiceRef = createServiceRef<PermissionsService>({\n  id: 'core.permissions',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginTaskScheduler } from '@backstage/backend-tasks';\n\n/** @public */\nexport type SchedulerService = PluginTaskScheduler;\n\n/**\n * @public\n */\nexport const schedulerServiceRef = createServiceRef<SchedulerService>({\n  id: 'core.scheduler',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { LifecycleService } from './lifecycleServiceRef';\n\n/** @public */\nexport type RootLifecycleService = LifecycleService;\n\n/**\n * @public\n */\nexport const rootLifecycleServiceRef = createServiceRef<RootLifecycleService>({\n  id: 'core.rootLifecycle',\n  scope: 'root',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { LoggerService } from './loggerServiceRef';\n\n/** @public */\nexport type RootLoggerService = LoggerService;\n\n/**\n * @public\n */\nexport const rootLoggerServiceRef = createServiceRef<RootLoggerService>({\n  id: 'core.root.logger',\n  scope: 'root',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport interface PluginMetadataService {\n  getId(): string;\n}\n\n/**\n * @public\n */\nexport const pluginMetadataServiceRef = createServiceRef<PluginMetadataService>(\n  {\n    id: 'core.plugin-metadata',\n  },\n);\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n **/\nexport type LifecycleServiceShutdownHook = {\n  fn: () => void | Promise<void>;\n\n  /** Labels to help identify the shutdown hook */\n  labels?: Record<string, string>;\n};\n\n/**\n * @public\n **/\nexport interface LifecycleService {\n  /**\n   * Register a function to be called when the backend is shutting down.\n   */\n  addShutdownHook(options: LifecycleServiceShutdownHook): void;\n}\n\n/**\n * @public\n */\nexport const lifecycleServiceRef = createServiceRef<LifecycleService>({\n  id: 'core.lifecycle',\n  scope: 'plugin',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { LoggerService } from '../definitions';\nimport { Logger as WinstonLogger, createLogger } from 'winston';\nimport Transport, { TransportStreamOptions } from 'winston-transport';\n\nclass BackstageLoggerTransport extends Transport {\n  constructor(\n    private readonly backstageLogger: LoggerService,\n    opts?: TransportStreamOptions,\n  ) {\n    super(opts);\n  }\n\n  log(info: unknown, callback: VoidFunction) {\n    if (typeof info !== 'object' || info === null) {\n      callback();\n      return;\n    }\n    const { level, message, ...meta } = info as { [name: string]: unknown };\n    switch (level) {\n      case 'error':\n        this.backstageLogger.error(String(message), meta);\n        break;\n      case 'warn':\n        this.backstageLogger.warn(String(message), meta);\n        break;\n      case 'info':\n        this.backstageLogger.info(String(message), meta);\n        break;\n      case 'debug':\n        this.backstageLogger.debug(String(message), meta);\n        break;\n      default:\n        this.backstageLogger.info(String(message), meta);\n    }\n    callback();\n  }\n}\n\n/** @public */\nexport function loggerToWinstonLogger(\n  logger: LoggerService,\n  opts?: TransportStreamOptions,\n): WinstonLogger {\n  return createLogger({\n    transports: [new BackstageLoggerTransport(logger, opts)],\n  });\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  BackendRegistrationPoints,\n  BackendFeature,\n  ExtensionPoint,\n} from './types';\n\n/** @public */\nexport function createExtensionPoint<T>(options: {\n  id: string;\n}): ExtensionPoint<T> {\n  return {\n    id: options.id,\n    get T(): T {\n      throw new Error(`tried to read ExtensionPoint.T of ${this}`);\n    },\n    toString() {\n      return `extensionPoint{${options.id}}`;\n    },\n    $$ref: 'extension-point', // TODO: declare\n  };\n}\n\n/** @public */\nexport interface BackendPluginConfig<TOptions> {\n  id: string;\n  register(reg: BackendRegistrationPoints, options: TOptions): void;\n}\n\n/** @public */\nexport function createBackendPlugin<\n  TOptions extends object | undefined = undefined,\n>(config: {\n  id: string;\n  register(reg: BackendRegistrationPoints, options: TOptions): void;\n}): undefined extends TOptions\n  ? (options?: TOptions) => BackendFeature\n  : (options: TOptions) => BackendFeature {\n  return (options?: TOptions) => ({\n    id: config.id,\n    register(register: BackendRegistrationPoints) {\n      return config.register(register, options!);\n    },\n  });\n}\n\n/** @public */\nexport interface BackendModuleConfig<TOptions> {\n  pluginId: string;\n  moduleId: string;\n  register(\n    reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>,\n    options: TOptions,\n  ): void;\n}\n\n/**\n * @public\n *\n * Creates a new backend module for a given plugin.\n *\n * The `moduleId` should be equal to the module-specific prefix of the exported name, such\n * that the full name is `moduleId + PluginId + \"Module\"`. For example, a GitHub entity\n * provider module for the `catalog` plugin might have the module ID `'githubEntityProvider'`,\n * and the full exported name would be `githubEntityProviderCatalogModule`.\n *\n * The `pluginId` should exactly match the `id` of the plugin that the module extends.\n */\nexport function createBackendModule<\n  TOptions extends object | undefined = undefined,\n>(\n  config: BackendModuleConfig<TOptions>,\n): undefined extends TOptions\n  ? (options?: TOptions) => BackendFeature\n  : (options: TOptions) => BackendFeature {\n  return (options?: TOptions) => ({\n    id: `${config.pluginId}.${config.moduleId}`,\n    register(register: BackendRegistrationPoints) {\n      // TODO: Hide registerExtensionPoint\n      return config.register(register, options!);\n    },\n  });\n}\n"],"names":["Transport","createLogger"],"mappings":";;;;;;;;;;;AAuFO,SAAS,iBAAoB,OAUlB,EAAA;AAChB,EAAA,MAAM,EAAE,EAAA,EAAI,KAAQ,GAAA,QAAA,EAAU,gBAAmB,GAAA,OAAA,CAAA;AACjD,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,8BAAA,EAAiC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KACzD;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,cAAc,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAC/B;AAAA,IACA,KAAO,EAAA,SAAA;AAAA,IACP,gBAAkB,EAAA,cAAA;AAAA,GACpB,CAAA;AAKF,CAAA;AAeO,SAAS,qBAMd,MAW+C,EAAA;AAC/C,EAAA,OAAO,CAAC,OACL,MAAA;AAAA,IACC,KAAA,EAAO,OAAO,OAAQ,CAAA,KAAA;AAAA,IACtB,SAAS,MAAO,CAAA,OAAA;AAAA,IAChB,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,QAAQ,IAA6C,EAAA;AACnD,MAAO,OAAA,MAAA,CAAO,OAAQ,CAAA,IAAA,EAAM,OAAQ,CAAA,CAAA;AAAA,KACtC;AAAA,GACF,CAAA,CAAA;AACJ;;AClIO,MAAM,mBAAmB,gBAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACDM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,iBAAA;AACN,CAAC,CAAA;;ACOM,MAAM,mBAAmB,gBAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,aAAA;AACN,CAAC,CAAA;;ACsPM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACvQM,MAAM,kBAAkB,gBAA+B,CAAA;AAAA,EAC5D,EAAI,EAAA,YAAA;AACN,CAAC,CAAA;;ACFM,MAAM,qBAAqB,gBAAkC,CAAA;AAAA,EAClE,EAAI,EAAA,eAAA;AACN,CAAC,CAAA;;AC0CM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;AC9CM,MAAM,yBAAyB,gBAAsC,CAAA;AAAA,EAC1E,EAAI,EAAA,mBAAA;AACN,CAAC,CAAA;;ACCM,MAAM,wBAAwB,gBAAqC,CAAA;AAAA,EACxE,EAAI,EAAA,kBAAA;AACN,CAAC,CAAA;;ACLM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,0BAA0B,gBAAuC,CAAA;AAAA,EAC5E,EAAI,EAAA,oBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACHM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACAM,MAAM,wBAA2B,GAAA,gBAAA;AAAA,EACtC;AAAA,IACE,EAAI,EAAA,sBAAA;AAAA,GACN;AACF,CAAA;;ACSO,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AACT,CAAC,CAAA;;;;;;;;;;;;;;;;;;;;ACxBD,MAAM,iCAAiCA,6BAAU,CAAA;AAAA,EAC/C,WAAA,CACmB,iBACjB,IACA,EAAA;AACA,IAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAHO,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA,CAAA;AAAA,GAInB;AAAA,EAEA,GAAA,CAAI,MAAe,QAAwB,EAAA;AACzC,IAAA,IAAI,OAAO,IAAA,KAAS,QAAY,IAAA,IAAA,KAAS,IAAM,EAAA;AAC7C,MAAS,QAAA,EAAA,CAAA;AACT,MAAA,OAAA;AAAA,KACF;AACA,IAAA,MAAM,EAAE,KAAA,EAAO,OAAY,EAAA,GAAA,IAAA,EAAS,GAAA,IAAA,CAAA;AACpC,IAAA,QAAQ,KAAO;AAAA,MACb,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAChD,QAAA,MAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAC/C,QAAA,MAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAC/C,QAAA,MAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAChD,QAAA,MAAA;AAAA,MACF;AACE,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAAA,KACnD;AACA,IAAS,QAAA,EAAA,CAAA;AAAA,GACX;AACF,CAAA;AAGgB,SAAA,qBAAA,CACd,QACA,IACe,EAAA;AACf,EAAA,OAAOC,oBAAa,CAAA;AAAA,IAClB,YAAY,CAAC,IAAI,wBAAyB,CAAA,MAAA,EAAQ,IAAI,CAAC,CAAA;AAAA,GACxD,CAAA,CAAA;AACH;;ACvCO,SAAS,qBAAwB,OAElB,EAAA;AACpB,EAAO,OAAA;AAAA,IACL,IAAI,OAAQ,CAAA,EAAA;AAAA,IACZ,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,kCAAA,EAAqC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KAC7D;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,kBAAkB,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KACnC;AAAA,IACA,KAAO,EAAA,iBAAA;AAAA,GACT,CAAA;AACF,CAAA;AASO,SAAS,oBAEd,MAKwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,IAAI,MAAO,CAAA,EAAA;AAAA,IACX,SAAS,QAAqC,EAAA;AAC5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF,CAAA;AAwBO,SAAS,oBAGd,MAGwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,EAAI,EAAA,CAAA,EAAG,MAAO,CAAA,QAAA,CAAA,CAAA,EAAY,MAAO,CAAA,QAAA,CAAA,CAAA;AAAA,IACjC,SAAS,QAAqC,EAAA;AAE5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF;;;;;;;;;;"}