@backstage/backend-plugin-api 0.1.2-next.1 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/backend-plugin-api
 
+## 0.1.2
+
+### Patch Changes
+
+- 2c57c0c499: Made `ApiRef.defaultFactory` internal.
+- 91eed37a39: Updated `createBackendPlugin` and `createBackendModule` to properly forward lack of options.
+- 409ed984e8: Service are now scoped to either `'plugin'` or `'root'` scope. Service factories have been updated to provide dependency instances directly rather than factory functions.
+- eef91a2558: Simplified the `ServiceFactory` type and removed `AnyServiceFactory`.
+- 854ba37357: The `createServiceFactory` method has been updated to return a higher-order factory that can accept options.
+- 68513f169a: When defining a new `ServiceRef` you can now also include a `defaultFactory`, which will be used to construct instances of the service in case there is no explicit factory defined.
+- Updated dependencies
+  - @backstage/backend-common@0.15.1
+  - @backstage/backend-tasks@0.3.5
+  - @backstage/config@1.0.2
+  - @backstage/plugin-permission-common@0.6.4
+
+## 0.1.2-next.2
+
+### Patch Changes
+
+- 409ed984e8: Service are now scoped to either `'plugin'` or `'root'` scope. Service factories have been updated to provide dependency instances directly rather than factory functions.
+- 854ba37357: The `createServiceFactory` method has been updated to return a higher-order factory that can accept options.
+- Updated dependencies
+  - @backstage/config@1.0.2-next.0
+  - @backstage/plugin-permission-common@0.6.4-next.2
+  - @backstage/backend-common@0.15.1-next.3
+  - @backstage/backend-tasks@0.3.5-next.1
+
 ## 0.1.2-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "0.1.2-next.1",
+  "version": "0.1.2",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -52,12 +52,12 @@ export declare interface BackendRegistrationPoints {
 /**
  * @public
  */
-export declare const cacheServiceRef: ServiceRef<PluginCacheManager>;
+export declare const cacheServiceRef: ServiceRef<PluginCacheManager, "plugin">;
 
 /**
  * @public
  */
-export declare const configServiceRef: ServiceRef<Config>;
+export declare const configServiceRef: ServiceRef<Config, "root">;
 
 /** @public */
 export declare function createBackendModule<TOptions extends {
@@ -77,36 +77,39 @@ export declare function createExtensionPoint<T>(options: {
 /**
  * @public
  */
-export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+export declare function createServiceFactory<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends {
     [name in string]: unknown;
-}>(factory: {
-    service: ServiceRef<TService>;
-    deps: TypesToServiceRef<TDeps>;
-    factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;
-}): ServiceFactory<TService>;
+} | undefined = undefined>(config: {
+    service: ServiceRef<TService, TScope>;
+    deps: TDeps;
+    factory(deps: ServiceRefsToInstances<TDeps, 'root'>, options: TOpts): TScope extends 'root' ? Promise<TImpl> : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;
+}): undefined extends TOpts ? (options?: TOpts) => ServiceFactory<TService> : (options: TOpts) => ServiceFactory<TService>;
 
-/**
- * @public
- */
+/** @public */
+export declare function createServiceRef<T>(options: {
+    id: string;
+    scope?: 'plugin';
+    defaultFactory?: (service: ServiceRef<T, 'plugin'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
+}): ServiceRef<T, 'plugin'>;
+
+/** @public */
 export declare function createServiceRef<T>(options: {
     id: string;
-    defaultFactory?: (service: ServiceRef<T>) => Promise<ServiceFactory<T>>;
-}): ServiceRef<T>;
+    scope: 'root';
+    defaultFactory?: (service: ServiceRef<T, 'root'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
+}): ServiceRef<T, 'root'>;
 
 /**
  * @public
  */
-export declare const databaseServiceRef: ServiceRef<PluginDatabaseManager>;
-
-/** @public */
-export declare type DepsToDepFactories<T> = {
-    [key in keyof T]: (pluginId: string) => Promise<T[key]>;
-};
+export declare const databaseServiceRef: ServiceRef<PluginDatabaseManager, "plugin">;
 
 /**
  * @public
  */
-export declare const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery>;
+export declare const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery, "plugin">;
 
 /**
  * TODO
@@ -124,9 +127,6 @@ export declare type ExtensionPoint<T> = {
     $$ref: 'extension-point';
 };
 
-/** @public */
-export declare type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;
-
 /**
  * @public
  */
@@ -137,7 +137,7 @@ export declare interface HttpRouterService {
 /**
  * @public
  */
-export declare const httpRouterServiceRef: ServiceRef<HttpRouterService>;
+export declare const httpRouterServiceRef: ServiceRef<HttpRouterService, "plugin">;
 
 /**
  * @public
@@ -152,7 +152,7 @@ export declare interface Logger {
 /**
  * @public
  */
-export declare const loggerServiceRef: ServiceRef<Logger>;
+export declare const loggerServiceRef: ServiceRef<Logger, "plugin">;
 
 /** @public */
 export declare function loggerToWinstonLogger(logger: Logger, opts?: TransportStreamOptions): Logger_2;
@@ -160,22 +160,51 @@ export declare function loggerToWinstonLogger(logger: Logger, opts?: TransportSt
 /**
  * @public
  */
-export declare const permissionsServiceRef: ServiceRef<PermissionAuthorizer | PermissionEvaluator>;
+export declare const permissionsServiceRef: ServiceRef<PermissionAuthorizer | PermissionEvaluator, "plugin">;
 
 /**
  * @public
  */
-export declare const schedulerServiceRef: ServiceRef<PluginTaskScheduler>;
+export declare interface PluginMetadata {
+    getId(): string;
+}
+
+/**
+ * @public
+ */
+export declare const pluginMetadataServiceRef: ServiceRef<PluginMetadata, "plugin">;
+
+/**
+ * @public
+ */
+export declare const rootLoggerServiceRef: ServiceRef<Logger, "root">;
+
+/**
+ * @public
+ */
+export declare const schedulerServiceRef: ServiceRef<PluginTaskScheduler, "plugin">;
 
 /** @public */
 export declare type ServiceFactory<TService = unknown> = {
-    service: ServiceRef<TService>;
+    scope: 'root';
+    service: ServiceRef<TService, 'root'>;
+    deps: {
+        [key in string]: ServiceRef<unknown>;
+    };
+    factory(deps: {
+        [key in string]: unknown;
+    }): Promise<TService>;
+} | {
+    scope: 'plugin';
+    service: ServiceRef<TService, 'plugin'>;
     deps: {
         [key in string]: ServiceRef<unknown>;
     };
     factory(deps: {
         [key in string]: unknown;
-    }): Promise<FactoryFunc<TService>>;
+    }): Promise<(deps: {
+        [key in string]: unknown;
+    }) => Promise<TService>>;
 };
 
 /**
@@ -183,21 +212,40 @@ export declare type ServiceFactory<TService = unknown> = {
  *
  * @public
  */
-export declare type ServiceRef<T> = {
+export declare type ServiceRef<TService, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
     id: string;
+    /**
+     * This determines the scope at which this service is available.
+     *
+     * Root scoped services are available to all other services but
+     * may only depend on other root scoped services.
+     *
+     * Plugin scoped services are only available to other plugin scoped
+     * services but may depend on all other services.
+     */
+    scope: TScope;
     /**
      * Utility for getting the type of the service, using `typeof serviceRef.T`.
      * Attempting to actually read this value will result in an exception.
      */
-    T: T;
+    T: TService;
     toString(): string;
     $$ref: 'service';
 };
 
+/** @ignore */
+declare type ServiceRefsToInstances<T extends {
+    [key in string]: ServiceRef<unknown>;
+}, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
+    [name in {
+        [key in keyof T]: T[key] extends ServiceRef<unknown, TScope> ? key : never;
+    }[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;
+};
+
 /**
  * @public
  */
-export declare const tokenManagerServiceRef: ServiceRef<TokenManager>;
+export declare const tokenManagerServiceRef: ServiceRef<TokenManager, "plugin">;
 
 /** @public */
 export declare type TypesToServiceRef<T> = {
@@ -207,6 +255,6 @@ export declare type TypesToServiceRef<T> = {
 /**
  * @public
  */
-export declare const urlReaderServiceRef: ServiceRef<UrlReader>;
+export declare const urlReaderServiceRef: ServiceRef<UrlReader, "plugin">;
 
 export { }

package/dist/index.beta.d.ts

@@ -52,12 +52,12 @@ export declare interface BackendRegistrationPoints {
 /**
  * @public
  */
-export declare const cacheServiceRef: ServiceRef<PluginCacheManager>;
+export declare const cacheServiceRef: ServiceRef<PluginCacheManager, "plugin">;
 
 /**
  * @public
  */
-export declare const configServiceRef: ServiceRef<Config>;
+export declare const configServiceRef: ServiceRef<Config, "root">;
 
 /** @public */
 export declare function createBackendModule<TOptions extends {
@@ -77,36 +77,39 @@ export declare function createExtensionPoint<T>(options: {
 /**
  * @public
  */
-export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+export declare function createServiceFactory<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends {
     [name in string]: unknown;
-}>(factory: {
-    service: ServiceRef<TService>;
-    deps: TypesToServiceRef<TDeps>;
-    factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;
-}): ServiceFactory<TService>;
+} | undefined = undefined>(config: {
+    service: ServiceRef<TService, TScope>;
+    deps: TDeps;
+    factory(deps: ServiceRefsToInstances<TDeps, 'root'>, options: TOpts): TScope extends 'root' ? Promise<TImpl> : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;
+}): undefined extends TOpts ? (options?: TOpts) => ServiceFactory<TService> : (options: TOpts) => ServiceFactory<TService>;
 
-/**
- * @public
- */
+/** @public */
+export declare function createServiceRef<T>(options: {
+    id: string;
+    scope?: 'plugin';
+    defaultFactory?: (service: ServiceRef<T, 'plugin'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
+}): ServiceRef<T, 'plugin'>;
+
+/** @public */
 export declare function createServiceRef<T>(options: {
     id: string;
-    defaultFactory?: (service: ServiceRef<T>) => Promise<ServiceFactory<T>>;
-}): ServiceRef<T>;
+    scope: 'root';
+    defaultFactory?: (service: ServiceRef<T, 'root'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
+}): ServiceRef<T, 'root'>;
 
 /**
  * @public
  */
-export declare const databaseServiceRef: ServiceRef<PluginDatabaseManager>;
-
-/** @public */
-export declare type DepsToDepFactories<T> = {
-    [key in keyof T]: (pluginId: string) => Promise<T[key]>;
-};
+export declare const databaseServiceRef: ServiceRef<PluginDatabaseManager, "plugin">;
 
 /**
  * @public
  */
-export declare const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery>;
+export declare const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery, "plugin">;
 
 /**
  * TODO
@@ -124,9 +127,6 @@ export declare type ExtensionPoint<T> = {
     $$ref: 'extension-point';
 };
 
-/** @public */
-export declare type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;
-
 /**
  * @public
  */
@@ -137,7 +137,7 @@ export declare interface HttpRouterService {
 /**
  * @public
  */
-export declare const httpRouterServiceRef: ServiceRef<HttpRouterService>;
+export declare const httpRouterServiceRef: ServiceRef<HttpRouterService, "plugin">;
 
 /**
  * @public
@@ -152,7 +152,7 @@ export declare interface Logger {
 /**
  * @public
  */
-export declare const loggerServiceRef: ServiceRef<Logger>;
+export declare const loggerServiceRef: ServiceRef<Logger, "plugin">;
 
 /** @public */
 export declare function loggerToWinstonLogger(logger: Logger, opts?: TransportStreamOptions): Logger_2;
@@ -160,22 +160,51 @@ export declare function loggerToWinstonLogger(logger: Logger, opts?: TransportSt
 /**
  * @public
  */
-export declare const permissionsServiceRef: ServiceRef<PermissionAuthorizer | PermissionEvaluator>;
+export declare const permissionsServiceRef: ServiceRef<PermissionAuthorizer | PermissionEvaluator, "plugin">;
 
 /**
  * @public
  */
-export declare const schedulerServiceRef: ServiceRef<PluginTaskScheduler>;
+export declare interface PluginMetadata {
+    getId(): string;
+}
+
+/**
+ * @public
+ */
+export declare const pluginMetadataServiceRef: ServiceRef<PluginMetadata, "plugin">;
+
+/**
+ * @public
+ */
+export declare const rootLoggerServiceRef: ServiceRef<Logger, "root">;
+
+/**
+ * @public
+ */
+export declare const schedulerServiceRef: ServiceRef<PluginTaskScheduler, "plugin">;
 
 /** @public */
 export declare type ServiceFactory<TService = unknown> = {
-    service: ServiceRef<TService>;
+    scope: 'root';
+    service: ServiceRef<TService, 'root'>;
+    deps: {
+        [key in string]: ServiceRef<unknown>;
+    };
+    factory(deps: {
+        [key in string]: unknown;
+    }): Promise<TService>;
+} | {
+    scope: 'plugin';
+    service: ServiceRef<TService, 'plugin'>;
     deps: {
         [key in string]: ServiceRef<unknown>;
     };
     factory(deps: {
         [key in string]: unknown;
-    }): Promise<FactoryFunc<TService>>;
+    }): Promise<(deps: {
+        [key in string]: unknown;
+    }) => Promise<TService>>;
 };
 
 /**
@@ -183,21 +212,40 @@ export declare type ServiceFactory<TService = unknown> = {
  *
  * @public
  */
-export declare type ServiceRef<T> = {
+export declare type ServiceRef<TService, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
     id: string;
+    /**
+     * This determines the scope at which this service is available.
+     *
+     * Root scoped services are available to all other services but
+     * may only depend on other root scoped services.
+     *
+     * Plugin scoped services are only available to other plugin scoped
+     * services but may depend on all other services.
+     */
+    scope: TScope;
     /**
      * Utility for getting the type of the service, using `typeof serviceRef.T`.
      * Attempting to actually read this value will result in an exception.
      */
-    T: T;
+    T: TService;
     toString(): string;
     $$ref: 'service';
 };
 
+/** @ignore */
+declare type ServiceRefsToInstances<T extends {
+    [key in string]: ServiceRef<unknown>;
+}, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
+    [name in {
+        [key in keyof T]: T[key] extends ServiceRef<unknown, TScope> ? key : never;
+    }[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;
+};
+
 /**
  * @public
  */
-export declare const tokenManagerServiceRef: ServiceRef<TokenManager>;
+export declare const tokenManagerServiceRef: ServiceRef<TokenManager, "plugin">;
 
 /** @public */
 export declare type TypesToServiceRef<T> = {
@@ -207,6 +255,6 @@ export declare type TypesToServiceRef<T> = {
 /**
  * @public
  */
-export declare const urlReaderServiceRef: ServiceRef<UrlReader>;
+export declare const urlReaderServiceRef: ServiceRef<UrlReader, "plugin">;
 
 export { }

package/dist/index.cjs.js

@@ -10,9 +10,10 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var Transport__default = /*#__PURE__*/_interopDefaultLegacy(Transport);
 
 function createServiceRef(options) {
-  const { id, defaultFactory } = options;
+  const { id, scope = "plugin", defaultFactory } = options;
   return {
     id,
+    scope,
     get T() {
       throw new Error(`tried to read ServiceRef.T of ${this}`);
     },
@@ -23,12 +24,20 @@ function createServiceRef(options) {
     __defaultFactory: defaultFactory
   };
 }
-function createServiceFactory(factory) {
-  return factory;
+function createServiceFactory(config) {
+  return (options) => ({
+    scope: config.service.scope,
+    service: config.service,
+    deps: config.deps,
+    factory(deps) {
+      return config.factory(deps, options);
+    }
+  });
 }
 
 const configServiceRef = createServiceRef({
-  id: "core.config"
+  id: "core.root.config",
+  scope: "root"
 });
 
 const httpRouterServiceRef = createServiceRef({
@@ -67,6 +76,15 @@ const schedulerServiceRef = createServiceRef({
   id: "core.scheduler"
 });
 
+const rootLoggerServiceRef = createServiceRef({
+  id: "core.root.logger",
+  scope: "root"
+});
+
+const pluginMetadataServiceRef = createServiceRef({
+  id: "core.plugin-metadata"
+});
+
 class BackstageLoggerTransport extends Transport__default["default"] {
   constructor(backstageLogger, opts) {
     super(opts);
@@ -125,6 +143,8 @@ exports.httpRouterServiceRef = httpRouterServiceRef;
 exports.loggerServiceRef = loggerServiceRef;
 exports.loggerToWinstonLogger = loggerToWinstonLogger;
 exports.permissionsServiceRef = permissionsServiceRef;
+exports.pluginMetadataServiceRef = pluginMetadataServiceRef;
+exports.rootLoggerServiceRef = rootLoggerServiceRef;
 exports.schedulerServiceRef = schedulerServiceRef;
 exports.tokenManagerServiceRef = tokenManagerServiceRef;
 exports.urlReaderServiceRef = urlReaderServiceRef;

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/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<T> = {\n  id: string;\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: T;\n\n  toString(): string;\n\n  $$ref: 'service';\n};\n\n/**\n * @internal\n */\nexport type InternalServiceRef<T> = ServiceRef<T> & {\n  /**\n   * The default factory that will be used to create service\n   * instances if no other factory is provided.\n   */\n  __defaultFactory?: (service: ServiceRef<T>) => Promise<ServiceFactory<T>>;\n};\n\n/** @public */\nexport type TypesToServiceRef<T> = { [key in keyof T]: ServiceRef<T[key]> };\n\n/** @public */\nexport type DepsToDepFactories<T> = {\n  [key in keyof T]: (pluginId: string) => Promise<T[key]>;\n};\n\n/** @public */\nexport type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;\n\n/** @public */\nexport type ServiceFactory<TService = unknown> = {\n  service: ServiceRef<TService>;\n  deps: { [key in string]: ServiceRef<unknown> };\n  factory(deps: { [key in string]: unknown }): Promise<FactoryFunc<TService>>;\n};\n\n/**\n * @public\n */\nexport function createServiceRef<T>(options: {\n  id: string;\n  defaultFactory?: (service: ServiceRef<T>) => Promise<ServiceFactory<T>>;\n}): ServiceRef<T> {\n  const { id, defaultFactory } = options;\n  return {\n    id,\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 InternalServiceRef<T>;\n}\n\n/**\n * @public\n */\nexport function createServiceFactory<\n  TService,\n  TImpl extends TService,\n  TDeps extends { [name in string]: unknown },\n>(factory: {\n  service: ServiceRef<TService>;\n  deps: TypesToServiceRef<TDeps>;\n  factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;\n}): ServiceFactory<TService> {\n  return factory 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 const configServiceRef = createServiceRef<Config>({\n  id: 'core.config',\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 interface Logger {\n  info(message: string): void;\n  child(fields: { [name: string]: string }): Logger;\n}\n\n/**\n * @public\n */\nexport const loggerServiceRef = createServiceRef<Logger>({\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/**\n * @public\n */\nexport const urlReaderServiceRef = createServiceRef<UrlReader>({\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/**\n * @public\n */\nexport const cacheServiceRef = createServiceRef<PluginCacheManager>({\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/**\n * @public\n */\nexport const databaseServiceRef = createServiceRef<PluginDatabaseManager>({\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/**\n * @public\n */\nexport const discoveryServiceRef = createServiceRef<PluginEndpointDiscovery>({\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/**\n * @public\n */\nexport const tokenManagerServiceRef = createServiceRef<TokenManager>({\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/**\n * @public\n */\nexport const permissionsServiceRef = createServiceRef<\n  PermissionEvaluator | PermissionAuthorizer\n>({\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/**\n * @public\n */\nexport const schedulerServiceRef = createServiceRef<PluginTaskScheduler>({\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 { Logger as BackstageLogger } 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: BackstageLogger,\n    opts?: TransportStreamOptions,\n  ) {\n    super(opts);\n  }\n\n  log(info: { message: string }, callback: VoidFunction) {\n    // TODO: add support for levels and fields\n    this.backstageLogger.info(info.message);\n    callback();\n  }\n}\n\n/** @public */\nexport function loggerToWinstonLogger(\n  logger: BackstageLogger,\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 { [name: string]: unknown } | undefined = undefined,\n>(\n  config: BackendPluginConfig<TOptions>,\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/** @public */\nexport function createBackendModule<\n  TOptions extends { [name: string]: unknown } | 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":";;;;;;;;;;;AAmEO,SAAS,iBAAoB,OAGlB,EAAA;AAChB,EAAM,MAAA,EAAE,EAAI,EAAA,cAAA,EAAmB,GAAA,OAAA,CAAA;AAC/B,EAAO,OAAA;AAAA,IACL,EAAA;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;AACF,CAAA;AAKO,SAAS,qBAId,OAI2B,EAAA;AAC3B,EAAO,OAAA,OAAA,CAAA;AACT;;AC5EO,MAAM,mBAAmB,gBAAyB,CAAA;AAAA,EACvD,EAAI,EAAA,aAAA;AACN,CAAC;;ACKM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,iBAAA;AACN,CAAC;;ACFM,MAAM,mBAAmB,gBAAyB,CAAA;AAAA,EACvD,EAAI,EAAA,aAAA;AACN,CAAC;;ACTM,MAAM,sBAAsB,gBAA4B,CAAA;AAAA,EAC7D,EAAI,EAAA,gBAAA;AACN,CAAC;;ACFM,MAAM,kBAAkB,gBAAqC,CAAA;AAAA,EAClE,EAAI,EAAA,YAAA;AACN,CAAC;;ACFM,MAAM,qBAAqB,gBAAwC,CAAA;AAAA,EACxE,EAAI,EAAA,eAAA;AACN,CAAC;;ACFM,MAAM,sBAAsB,gBAA0C,CAAA;AAAA,EAC3E,EAAI,EAAA,gBAAA;AACN,CAAC;;ACFM,MAAM,yBAAyB,gBAA+B,CAAA;AAAA,EACnE,EAAI,EAAA,mBAAA;AACN,CAAC;;ACCM,MAAM,wBAAwB,gBAEnC,CAAA;AAAA,EACA,EAAI,EAAA,kBAAA;AACN,CAAC;;ACPM,MAAM,sBAAsB,gBAAsC,CAAA;AAAA,EACvE,EAAI,EAAA,gBAAA;AACN,CAAC;;ACJD,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,MAA2B,QAAwB,EAAA;AAErD,IAAK,IAAA,CAAA,eAAA,CAAgB,IAAK,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AACtC,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;;ACpBO,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,oBAGd,MAGwC,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;AAaO,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/rootLoggerServiceRef.ts","../src/services/definitions/pluginMetadataServiceRef.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 { [name in string]: unknown } | 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 const configServiceRef = createServiceRef<Config>({\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 interface Logger {\n  info(message: string): void;\n  child(fields: { [name: string]: string }): Logger;\n}\n\n/**\n * @public\n */\nexport const loggerServiceRef = createServiceRef<Logger>({\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/**\n * @public\n */\nexport const urlReaderServiceRef = createServiceRef<UrlReader>({\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/**\n * @public\n */\nexport const cacheServiceRef = createServiceRef<PluginCacheManager>({\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/**\n * @public\n */\nexport const databaseServiceRef = createServiceRef<PluginDatabaseManager>({\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/**\n * @public\n */\nexport const discoveryServiceRef = createServiceRef<PluginEndpointDiscovery>({\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/**\n * @public\n */\nexport const tokenManagerServiceRef = createServiceRef<TokenManager>({\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/**\n * @public\n */\nexport const permissionsServiceRef = createServiceRef<\n  PermissionEvaluator | PermissionAuthorizer\n>({\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/**\n * @public\n */\nexport const schedulerServiceRef = createServiceRef<PluginTaskScheduler>({\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 { Logger } from './loggerServiceRef';\n\n/**\n * @public\n */\nexport const rootLoggerServiceRef = createServiceRef<Logger>({\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 PluginMetadata {\n  getId(): string;\n}\n\n/**\n * @public\n */\nexport const pluginMetadataServiceRef = createServiceRef<PluginMetadata>({\n  id: 'core.plugin-metadata',\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 { Logger as BackstageLogger } 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: BackstageLogger,\n    opts?: TransportStreamOptions,\n  ) {\n    super(opts);\n  }\n\n  log(info: { message: string }, callback: VoidFunction) {\n    // TODO: add support for levels and fields\n    this.backstageLogger.info(info.message);\n    callback();\n  }\n}\n\n/** @public */\nexport function loggerToWinstonLogger(\n  logger: BackstageLogger,\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 { [name: string]: unknown } | undefined = undefined,\n>(\n  config: BackendPluginConfig<TOptions>,\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/** @public */\nexport function createBackendModule<\n  TOptions extends { [name: string]: unknown } | 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;;ACvIO,MAAM,mBAAmB,gBAAyB,CAAA;AAAA,EACvD,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC;;ACIM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,iBAAA;AACN,CAAC;;ACFM,MAAM,mBAAmB,gBAAyB,CAAA;AAAA,EACvD,EAAI,EAAA,aAAA;AACN,CAAC;;ACTM,MAAM,sBAAsB,gBAA4B,CAAA;AAAA,EAC7D,EAAI,EAAA,gBAAA;AACN,CAAC;;ACFM,MAAM,kBAAkB,gBAAqC,CAAA;AAAA,EAClE,EAAI,EAAA,YAAA;AACN,CAAC;;ACFM,MAAM,qBAAqB,gBAAwC,CAAA;AAAA,EACxE,EAAI,EAAA,eAAA;AACN,CAAC;;ACFM,MAAM,sBAAsB,gBAA0C,CAAA;AAAA,EAC3E,EAAI,EAAA,gBAAA;AACN,CAAC;;ACFM,MAAM,yBAAyB,gBAA+B,CAAA;AAAA,EACnE,EAAI,EAAA,mBAAA;AACN,CAAC;;ACCM,MAAM,wBAAwB,gBAEnC,CAAA;AAAA,EACA,EAAI,EAAA,kBAAA;AACN,CAAC;;ACPM,MAAM,sBAAsB,gBAAsC,CAAA;AAAA,EACvE,EAAI,EAAA,gBAAA;AACN,CAAC;;ACFM,MAAM,uBAAuB,gBAAyB,CAAA;AAAA,EAC3D,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC;;ACGM,MAAM,2BAA2B,gBAAiC,CAAA;AAAA,EACvE,EAAI,EAAA,sBAAA;AACN,CAAC;;ACVD,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,MAA2B,QAAwB,EAAA;AAErD,IAAK,IAAA,CAAA,eAAA,CAAgB,IAAK,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AACtC,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;;ACpBO,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,oBAGd,MAGwC,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;AAaO,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;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -52,12 +52,12 @@ export declare interface BackendRegistrationPoints {
 /**
  * @public
  */
-export declare const cacheServiceRef: ServiceRef<PluginCacheManager>;
+export declare const cacheServiceRef: ServiceRef<PluginCacheManager, "plugin">;
 
 /**
  * @public
  */
-export declare const configServiceRef: ServiceRef<Config>;
+export declare const configServiceRef: ServiceRef<Config, "root">;
 
 /** @public */
 export declare function createBackendModule<TOptions extends {
@@ -77,36 +77,39 @@ export declare function createExtensionPoint<T>(options: {
 /**
  * @public
  */
-export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+export declare function createServiceFactory<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends {
     [name in string]: unknown;
-}>(factory: {
-    service: ServiceRef<TService>;
-    deps: TypesToServiceRef<TDeps>;
-    factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;
-}): ServiceFactory<TService>;
+} | undefined = undefined>(config: {
+    service: ServiceRef<TService, TScope>;
+    deps: TDeps;
+    factory(deps: ServiceRefsToInstances<TDeps, 'root'>, options: TOpts): TScope extends 'root' ? Promise<TImpl> : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;
+}): undefined extends TOpts ? (options?: TOpts) => ServiceFactory<TService> : (options: TOpts) => ServiceFactory<TService>;
 
-/**
- * @public
- */
+/** @public */
+export declare function createServiceRef<T>(options: {
+    id: string;
+    scope?: 'plugin';
+    defaultFactory?: (service: ServiceRef<T, 'plugin'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
+}): ServiceRef<T, 'plugin'>;
+
+/** @public */
 export declare function createServiceRef<T>(options: {
     id: string;
-    defaultFactory?: (service: ServiceRef<T>) => Promise<ServiceFactory<T>>;
-}): ServiceRef<T>;
+    scope: 'root';
+    defaultFactory?: (service: ServiceRef<T, 'root'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
+}): ServiceRef<T, 'root'>;
 
 /**
  * @public
  */
-export declare const databaseServiceRef: ServiceRef<PluginDatabaseManager>;
-
-/** @public */
-export declare type DepsToDepFactories<T> = {
-    [key in keyof T]: (pluginId: string) => Promise<T[key]>;
-};
+export declare const databaseServiceRef: ServiceRef<PluginDatabaseManager, "plugin">;
 
 /**
  * @public
  */
-export declare const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery>;
+export declare const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery, "plugin">;
 
 /**
  * TODO
@@ -124,9 +127,6 @@ export declare type ExtensionPoint<T> = {
     $$ref: 'extension-point';
 };
 
-/** @public */
-export declare type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;
-
 /**
  * @public
  */
@@ -137,7 +137,7 @@ export declare interface HttpRouterService {
 /**
  * @public
  */
-export declare const httpRouterServiceRef: ServiceRef<HttpRouterService>;
+export declare const httpRouterServiceRef: ServiceRef<HttpRouterService, "plugin">;
 
 /**
  * @public
@@ -152,7 +152,7 @@ export declare interface Logger {
 /**
  * @public
  */
-export declare const loggerServiceRef: ServiceRef<Logger>;
+export declare const loggerServiceRef: ServiceRef<Logger, "plugin">;
 
 /** @public */
 export declare function loggerToWinstonLogger(logger: Logger, opts?: TransportStreamOptions): Logger_2;
@@ -160,22 +160,51 @@ export declare function loggerToWinstonLogger(logger: Logger, opts?: TransportSt
 /**
  * @public
  */
-export declare const permissionsServiceRef: ServiceRef<PermissionAuthorizer | PermissionEvaluator>;
+export declare const permissionsServiceRef: ServiceRef<PermissionAuthorizer | PermissionEvaluator, "plugin">;
 
 /**
  * @public
  */
-export declare const schedulerServiceRef: ServiceRef<PluginTaskScheduler>;
+export declare interface PluginMetadata {
+    getId(): string;
+}
+
+/**
+ * @public
+ */
+export declare const pluginMetadataServiceRef: ServiceRef<PluginMetadata, "plugin">;
+
+/**
+ * @public
+ */
+export declare const rootLoggerServiceRef: ServiceRef<Logger, "root">;
+
+/**
+ * @public
+ */
+export declare const schedulerServiceRef: ServiceRef<PluginTaskScheduler, "plugin">;
 
 /** @public */
 export declare type ServiceFactory<TService = unknown> = {
-    service: ServiceRef<TService>;
+    scope: 'root';
+    service: ServiceRef<TService, 'root'>;
+    deps: {
+        [key in string]: ServiceRef<unknown>;
+    };
+    factory(deps: {
+        [key in string]: unknown;
+    }): Promise<TService>;
+} | {
+    scope: 'plugin';
+    service: ServiceRef<TService, 'plugin'>;
     deps: {
         [key in string]: ServiceRef<unknown>;
     };
     factory(deps: {
         [key in string]: unknown;
-    }): Promise<FactoryFunc<TService>>;
+    }): Promise<(deps: {
+        [key in string]: unknown;
+    }) => Promise<TService>>;
 };
 
 /**
@@ -183,21 +212,40 @@ export declare type ServiceFactory<TService = unknown> = {
  *
  * @public
  */
-export declare type ServiceRef<T> = {
+export declare type ServiceRef<TService, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
     id: string;
+    /**
+     * This determines the scope at which this service is available.
+     *
+     * Root scoped services are available to all other services but
+     * may only depend on other root scoped services.
+     *
+     * Plugin scoped services are only available to other plugin scoped
+     * services but may depend on all other services.
+     */
+    scope: TScope;
     /**
      * Utility for getting the type of the service, using `typeof serviceRef.T`.
      * Attempting to actually read this value will result in an exception.
      */
-    T: T;
+    T: TService;
     toString(): string;
     $$ref: 'service';
 };
 
+/** @ignore */
+declare type ServiceRefsToInstances<T extends {
+    [key in string]: ServiceRef<unknown>;
+}, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
+    [name in {
+        [key in keyof T]: T[key] extends ServiceRef<unknown, TScope> ? key : never;
+    }[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;
+};
+
 /**
  * @public
  */
-export declare const tokenManagerServiceRef: ServiceRef<TokenManager>;
+export declare const tokenManagerServiceRef: ServiceRef<TokenManager, "plugin">;
 
 /** @public */
 export declare type TypesToServiceRef<T> = {
@@ -207,6 +255,6 @@ export declare type TypesToServiceRef<T> = {
 /**
  * @public
  */
-export declare const urlReaderServiceRef: ServiceRef<UrlReader>;
+export declare const urlReaderServiceRef: ServiceRef<UrlReader, "plugin">;
 
 export { }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-plugin-api",
   "description": "Core API used by Backstage backend plugins",
-  "version": "0.1.2-next.1",
+  "version": "0.1.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -33,21 +33,21 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.15.1-next.2",
-    "@backstage/backend-tasks": "^0.3.5-next.0",
-    "@backstage/config": "^1.0.1",
-    "@backstage/plugin-permission-common": "^0.6.4-next.1",
+    "@backstage/backend-common": "^0.15.1",
+    "@backstage/backend-tasks": "^0.3.5",
+    "@backstage/config": "^1.0.2",
+    "@backstage/plugin-permission-common": "^0.6.4",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "winston": "^3.2.1",
     "winston-transport": "^4.5.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.19.0-next.2"
+    "@backstage/cli": "^0.19.0"
   },
   "files": [
     "dist",
     "alpha"
   ],
-  "gitHead": "24f889f173370f060725fcf9404081e40769beb4"
+  "gitHead": "25b94e63455f1fb170506f9e84e3f430f4b79406"
 }