npm - @backstage/backend-plugin-api - Versions diffs - 0.3.0-next.1 → 0.3.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,85 @@
 # @backstage/backend-plugin-api
+## 0.3.0
+### Minor Changes
+- 8e06f3cf00: Moved `loggerToWinstonLogger` to `@backstage/backend-common`.
+- ecbec4ec4c: Updated all factory function creators to accept options as a top-level callback rather than extra parameter to the main factory function.
+### Patch Changes
+- 6cfd4d7073: Added `RootLifecycleService` and `rootLifecycleServiceRef`, as well as added a `logger` option to the existing `LifecycleServiceShutdownHook`.
+- ecc6bfe4c9: Added `ServiceFactoryOrFunction` type, for use when either a `ServiceFactory` or `() => ServiceFactory` can be used.
+- 5b7bcd3c5e: Added `createSharedEnvironment` for creating a shared environment containing commonly used services in a split backend setup of the backend.
+- 02b119ff93: Added a new `rootHttpRouterServiceRef` and `RootHttpRouterService` interface.
+- 5e2cebe9a3: Migrate `UrlReader` into this package to gradually remove the dependency on backend-common.
+- 843a0a158c: Added new core identity service.
+- 5437fe488f: Migrated types related to `TokenManagerService`, `CacheService` and `DatabaseService` into backend-plugin-api.
+- 6f02d23b01: Moved `PluginEndpointDiscovery` type from backend-common to backend-plugin-api.
+- 483e907eaf: The `createServiceFactory` function has been updated to no longer use a duplicate callback pattern for plugin scoped services. The outer callback is now replaced by an optional `createRootContext` method. This change was made in order to support TypeScript 4.9, but it also simplifies the API surface a bit, especially for plugin scoped service factories that don't need to create a root context. In addition, the factory and root context functions can now be synchronous.
+  A factory that previously would have looked like this:
+  ```ts
+  createServiceFactory({
+    service: coreServices.cache,
+    deps: {
+      config: coreServices.config,
+      plugin: coreServices.pluginMetadata,
+    },
+    async factory({ config }) {
+      const cacheManager = CacheManager.fromConfig(config);
+      return async ({ plugin }) => {
+        return cacheManager.forPlugin(plugin.getId());
+      };
+    },
+  });
+  ```
+  Now instead looks like this:
+  ```ts
+  createServiceFactory({
+    service: coreServices.cache,
+    deps: {
+      config: coreServices.config,
+      plugin: coreServices.pluginMetadata,
+    },
+    async createRootContext({ config }) {
+      return CacheManager.fromConfig(config);
+    },
+    async factory({ plugin }, manager) {
+      return manager.forPlugin(plugin.getId());
+    },
+  });
+  ```
+  Although in many cases the `createRootContext` isn't needed, for example:
+  ```ts
+  createServiceFactory({
+    service: coreServices.logger,
+    deps: {
+      rootLogger: coreServices.rootLogger,
+      plugin: coreServices.pluginMetadata,
+    },
+    factory({ rootLogger, plugin }) {
+      return rootLogger.child({ plugin: plugin.getId() });
+    },
+  });
+  ```
+- 16054afdec: Documented `coreServices` an all of its members.
+- 0e63aab311: Updated the `RootLoggerService` to also have an `addRedactions` method.
+- 62b04bb865: Updates all `create*` methods to simplify their type definitions and ensure they all have configuration interfaces.
+- Updated dependencies
+  - @backstage/backend-tasks@0.4.1
+  - @backstage/config@1.0.6
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.9
+  - @backstage/plugin-permission-common@0.7.3
 ## 0.3.0-next.1
 ### Minor Changes

package/alpha/package.json CHANGED Viewed

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

package/dist/index.alpha.d.ts CHANGED Viewed

@@ -8,6 +8,7 @@
 import { Config } from '@backstage/config';
 import { Handler } from 'express';
+import { IdentityApi } from '@backstage/plugin-auth-node';
 import { JsonValue } from '@backstage/types';
 import { Knex } from 'knex';
 import { PermissionEvaluator } from '@backstage/plugin-permission-common';
@@ -21,16 +22,16 @@ export declare interface BackendFeature {
 }
 /** @public */
-export declare interface BackendModuleConfig<TOptions> {
+export declare interface BackendModuleConfig {
     pluginId: string;
     moduleId: string;
-    register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>, options: TOptions): void;
+    register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>): void;
 }
 /** @public */
-export declare interface BackendPluginConfig<TOptions> {
+export declare interface BackendPluginConfig {
     id: string;
-    register(reg: BackendRegistrationPoints, options: TOptions): void;
+    register(reg: BackendRegistrationPoints): void;
 }
 /** @public */
@@ -217,6 +218,12 @@ export declare namespace coreServices {
      * @public
      */
     const urlReader: ServiceRef<UrlReaderService, "plugin">;
+    /**
+     * The service reference for the plugin scoped {@link IdentityService}.
+     *
+     * @public
+     */
+    const identity: ServiceRef<IdentityService, "plugin">;
 }
 /**
@@ -233,20 +240,73 @@ export declare namespace coreServices {
  *
  * The `pluginId` should exactly match the `id` of the plugin that the module extends.
  */
-export declare function createBackendModule<TOptions extends MaybeOptions = undefined>(config: BackendModuleConfig<TOptions>): FactoryFunctionWithOptions<BackendFeature, TOptions>;
+export declare function createBackendModule<TOptions extends [options?: object] = []>(config: BackendModuleConfig | ((...params: TOptions) => BackendModuleConfig)): (...params: TOptions) => BackendFeature;
 /** @public */
-export declare function createBackendPlugin<TOptions extends MaybeOptions = undefined>(config: BackendPluginConfig<TOptions>): FactoryFunctionWithOptions<BackendFeature, TOptions>;
+export declare function createBackendPlugin<TOptions extends [options?: object] = []>(config: BackendPluginConfig | ((...params: TOptions) => BackendPluginConfig)): (...params: TOptions) => BackendFeature;
 /** @public */
 export declare function createExtensionPoint<T>(config: ExtensionPointConfig): ExtensionPoint<T>;
 /**
+ * Creates a root scoped service factory without options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: RootServiceFactoryConfig<TService, TImpl, TDeps>): () => ServiceFactory<TService>;
+/**
+ * Creates a root scoped service factory with optional options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: (options?: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>): (options?: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a root scoped service factory with required options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: (options: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>): (options: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory without options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>): () => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory with optional options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: (options?: TOpts) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>): (options?: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory with required options.
+ *
  * @public
+ * @param config - The service factory configuration.
  */
-export declare function createServiceFactory<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
     [name in string]: ServiceRef<unknown>;
-}, TOpts extends MaybeOptions = undefined>(config: ServiceFactoryConfig<TService, TScope, TImpl, TDeps, TOpts>): FactoryFunctionWithOptions<ServiceFactory<TService>, TOpts>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps> | ((options: TOpts) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>)): (options: TOpts) => ServiceFactory<TService>;
 /**
  * Creates a new service definition. This overload is used to create plugin scoped services.
@@ -262,9 +322,15 @@ export declare function createServiceRef<TService>(config: ServiceRefConfig<TSer
  */
 export declare function createServiceRef<TService>(config: ServiceRefConfig<TService, 'root'>): ServiceRef<TService, 'root'>;
+/**
+ * Creates a shared backend environment which can be used to create multiple backends
+ * @public
+ */
+export declare function createSharedEnvironment<TOptions extends [options?: object] = []>(config: SharedBackendEnvironmentConfig | ((...params: TOptions) => SharedBackendEnvironmentConfig)): (...options: TOptions) => SharedBackendEnvironment;
 /**
  * The DatabaseService manages access to databases that Plugins get.
- *gs
+ *
  * @public
  */
 export declare interface DatabaseService {
@@ -356,13 +422,6 @@ export declare interface ExtensionPointConfig {
     id: string;
 }
-/**
- * Helper type that makes the options argument optional if options are not required.
- *
- * @ignore
- */
-declare type FactoryFunctionWithOptions<TResult, TOptions> = undefined extends TOptions ? (options?: TOptions) => TResult : (options: TOptions) => TResult;
 /**
  * @public
  */
@@ -370,6 +429,10 @@ export declare interface HttpRouterService {
     use(handler: Handler): void;
 }
+/** @public */
+export declare interface IdentityService extends IdentityApi {
+}
 /**
  * @public
  **/
@@ -411,13 +474,6 @@ export declare type LogMeta = {
     [name: string]: unknown;
 };
-/**
- * Base type for options objects that aren't required.
- *
- * @ignore
- */
-declare type MaybeOptions = object | undefined;
 /** @public */
 export declare interface PermissionsService extends PermissionEvaluator {
 }
@@ -429,6 +485,16 @@ export declare interface PluginMetadataService {
     getId(): string;
 }
+/** @public */
+export declare interface PluginServiceFactoryConfig<TService, TContext, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    service: ServiceRef<TService, 'plugin'>;
+    deps: TDeps;
+    createRootContext?(deps: ServiceRefsToInstances<TDeps, 'root'>): TContext | Promise<TContext>;
+    factory(deps: ServiceRefsToInstances<TDeps>, context: TContext): TImpl | Promise<TImpl>;
+}
 /**
  * An options object for {@link UrlReaderService.readTree} operations.
  *
@@ -621,6 +687,15 @@ export declare interface RootLifecycleService extends LifecycleService {
 export declare interface RootLoggerService extends LoggerService {
 }
+/** @public */
+export declare interface RootServiceFactoryConfig<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    service: ServiceRef<TService, 'root'>;
+    deps: TDeps;
+    factory(deps: ServiceRefsToInstances<TDeps, 'root'>): TImpl | Promise<TImpl>;
+}
 /** @public */
 export declare interface SchedulerService extends PluginTaskScheduler {
 }
@@ -701,22 +776,14 @@ export declare type ServiceFactory<TService = unknown> = {
     deps: {
         [key in string]: ServiceRef<unknown>;
     };
-    factory(deps: {
+    createRootContext?(deps: {
         [key in string]: unknown;
-    }): Promise<(deps: {
+    }): Promise<unknown>;
+    factory(deps: {
         [key in string]: unknown;
-    }) => Promise<TService>>;
+    }, context: unknown): Promise<TService>;
 };
-/** @public */
-export declare interface ServiceFactoryConfig<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
-    [name in string]: ServiceRef<unknown>;
-}, TOpts extends MaybeOptions = undefined> {
-    service: ServiceRef<TService, TScope>;
-    deps: TDeps;
-    factory(deps: ServiceRefsToInstances<TDeps, 'root'>, options: TOpts): TScope extends 'root' ? Promise<TImpl> : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;
-}
 /**
  * Represents either a {@link ServiceFactory} or a function that returns one.
  *
@@ -761,11 +828,21 @@ export declare interface ServiceRefConfig<TService, TScope extends 'root' | 'plu
 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;
+    [key in keyof T as T[key]['scope'] extends TScope ? key : never]: T[key]['T'];
 };
+/**
+ * @public
+ */
+export declare interface SharedBackendEnvironment {
+    $$type: 'SharedBackendEnvironment';
+}
+/** @public */
+export declare interface SharedBackendEnvironmentConfig {
+    services?: ServiceFactoryOrFunction[];
+}
 /**
  * Interface for creating and validating tokens.
  *

package/dist/index.beta.d.ts CHANGED Viewed

@@ -8,6 +8,7 @@
 import { Config } from '@backstage/config';
 import { Handler } from 'express';
+import { IdentityApi } from '@backstage/plugin-auth-node';
 import { JsonValue } from '@backstage/types';
 import { Knex } from 'knex';
 import { PermissionEvaluator } from '@backstage/plugin-permission-common';
@@ -21,16 +22,16 @@ export declare interface BackendFeature {
 }
 /** @public */
-export declare interface BackendModuleConfig<TOptions> {
+export declare interface BackendModuleConfig {
     pluginId: string;
     moduleId: string;
-    register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>, options: TOptions): void;
+    register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>): void;
 }
 /** @public */
-export declare interface BackendPluginConfig<TOptions> {
+export declare interface BackendPluginConfig {
     id: string;
-    register(reg: BackendRegistrationPoints, options: TOptions): void;
+    register(reg: BackendRegistrationPoints): void;
 }
 /** @public */
@@ -217,6 +218,12 @@ export declare namespace coreServices {
      * @public
      */
     const urlReader: ServiceRef<UrlReaderService, "plugin">;
+    /**
+     * The service reference for the plugin scoped {@link IdentityService}.
+     *
+     * @public
+     */
+    const identity: ServiceRef<IdentityService, "plugin">;
 }
 /**
@@ -233,20 +240,73 @@ export declare namespace coreServices {
  *
  * The `pluginId` should exactly match the `id` of the plugin that the module extends.
  */
-export declare function createBackendModule<TOptions extends MaybeOptions = undefined>(config: BackendModuleConfig<TOptions>): FactoryFunctionWithOptions<BackendFeature, TOptions>;
+export declare function createBackendModule<TOptions extends [options?: object] = []>(config: BackendModuleConfig | ((...params: TOptions) => BackendModuleConfig)): (...params: TOptions) => BackendFeature;
 /** @public */
-export declare function createBackendPlugin<TOptions extends MaybeOptions = undefined>(config: BackendPluginConfig<TOptions>): FactoryFunctionWithOptions<BackendFeature, TOptions>;
+export declare function createBackendPlugin<TOptions extends [options?: object] = []>(config: BackendPluginConfig | ((...params: TOptions) => BackendPluginConfig)): (...params: TOptions) => BackendFeature;
 /** @public */
 export declare function createExtensionPoint<T>(config: ExtensionPointConfig): ExtensionPoint<T>;
 /**
+ * Creates a root scoped service factory without options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: RootServiceFactoryConfig<TService, TImpl, TDeps>): () => ServiceFactory<TService>;
+/**
+ * Creates a root scoped service factory with optional options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: (options?: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>): (options?: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a root scoped service factory with required options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: (options: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>): (options: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory without options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>): () => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory with optional options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: (options?: TOpts) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>): (options?: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory with required options.
+ *
  * @public
+ * @param config - The service factory configuration.
  */
-export declare function createServiceFactory<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
     [name in string]: ServiceRef<unknown>;
-}, TOpts extends MaybeOptions = undefined>(config: ServiceFactoryConfig<TService, TScope, TImpl, TDeps, TOpts>): FactoryFunctionWithOptions<ServiceFactory<TService>, TOpts>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps> | ((options: TOpts) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>)): (options: TOpts) => ServiceFactory<TService>;
 /**
  * Creates a new service definition. This overload is used to create plugin scoped services.
@@ -262,9 +322,15 @@ export declare function createServiceRef<TService>(config: ServiceRefConfig<TSer
  */
 export declare function createServiceRef<TService>(config: ServiceRefConfig<TService, 'root'>): ServiceRef<TService, 'root'>;
+/**
+ * Creates a shared backend environment which can be used to create multiple backends
+ * @public
+ */
+export declare function createSharedEnvironment<TOptions extends [options?: object] = []>(config: SharedBackendEnvironmentConfig | ((...params: TOptions) => SharedBackendEnvironmentConfig)): (...options: TOptions) => SharedBackendEnvironment;
 /**
  * The DatabaseService manages access to databases that Plugins get.
- *gs
+ *
  * @public
  */
 export declare interface DatabaseService {
@@ -356,13 +422,6 @@ export declare interface ExtensionPointConfig {
     id: string;
 }
-/**
- * Helper type that makes the options argument optional if options are not required.
- *
- * @ignore
- */
-declare type FactoryFunctionWithOptions<TResult, TOptions> = undefined extends TOptions ? (options?: TOptions) => TResult : (options: TOptions) => TResult;
 /**
  * @public
  */
@@ -370,6 +429,10 @@ export declare interface HttpRouterService {
     use(handler: Handler): void;
 }
+/** @public */
+export declare interface IdentityService extends IdentityApi {
+}
 /**
  * @public
  **/
@@ -411,13 +474,6 @@ export declare type LogMeta = {
     [name: string]: unknown;
 };
-/**
- * Base type for options objects that aren't required.
- *
- * @ignore
- */
-declare type MaybeOptions = object | undefined;
 /** @public */
 export declare interface PermissionsService extends PermissionEvaluator {
 }
@@ -429,6 +485,16 @@ export declare interface PluginMetadataService {
     getId(): string;
 }
+/** @public */
+export declare interface PluginServiceFactoryConfig<TService, TContext, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    service: ServiceRef<TService, 'plugin'>;
+    deps: TDeps;
+    createRootContext?(deps: ServiceRefsToInstances<TDeps, 'root'>): TContext | Promise<TContext>;
+    factory(deps: ServiceRefsToInstances<TDeps>, context: TContext): TImpl | Promise<TImpl>;
+}
 /**
  * An options object for {@link UrlReaderService.readTree} operations.
  *
@@ -621,6 +687,15 @@ export declare interface RootLifecycleService extends LifecycleService {
 export declare interface RootLoggerService extends LoggerService {
 }
+/** @public */
+export declare interface RootServiceFactoryConfig<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    service: ServiceRef<TService, 'root'>;
+    deps: TDeps;
+    factory(deps: ServiceRefsToInstances<TDeps, 'root'>): TImpl | Promise<TImpl>;
+}
 /** @public */
 export declare interface SchedulerService extends PluginTaskScheduler {
 }
@@ -701,22 +776,14 @@ export declare type ServiceFactory<TService = unknown> = {
     deps: {
         [key in string]: ServiceRef<unknown>;
     };
-    factory(deps: {
+    createRootContext?(deps: {
         [key in string]: unknown;
-    }): Promise<(deps: {
+    }): Promise<unknown>;
+    factory(deps: {
         [key in string]: unknown;
-    }) => Promise<TService>>;
+    }, context: unknown): Promise<TService>;
 };
-/** @public */
-export declare interface ServiceFactoryConfig<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
-    [name in string]: ServiceRef<unknown>;
-}, TOpts extends MaybeOptions = undefined> {
-    service: ServiceRef<TService, TScope>;
-    deps: TDeps;
-    factory(deps: ServiceRefsToInstances<TDeps, 'root'>, options: TOpts): TScope extends 'root' ? Promise<TImpl> : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;
-}
 /**
  * Represents either a {@link ServiceFactory} or a function that returns one.
  *
@@ -761,11 +828,21 @@ export declare interface ServiceRefConfig<TService, TScope extends 'root' | 'plu
 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;
+    [key in keyof T as T[key]['scope'] extends TScope ? key : never]: T[key]['T'];
 };
+/**
+ * @public
+ */
+export declare interface SharedBackendEnvironment {
+    $$type: 'SharedBackendEnvironment';
+}
+/** @public */
+export declare interface SharedBackendEnvironmentConfig {
+    services?: ServiceFactoryOrFunction[];
+}
 /**
  * Interface for creating and validating tokens.
  *

package/dist/index.cjs.js CHANGED Viewed

@@ -19,14 +19,21 @@ function createServiceRef(config) {
   };
 }
 function createServiceFactory(config) {
-  return (options) => ({
-    scope: config.service.scope,
-    service: config.service,
-    deps: config.deps,
-    factory(deps) {
-      return config.factory(deps, options);
-    }
-  });
+  const configCallback = typeof config === "function" ? config : () => config;
+  return (options) => {
+    const c = configCallback(options);
+    return {
+      ...c,
+      ..."createRootContext" in c ? {
+        createRootContext: async (deps) => {
+          var _a;
+          return (_a = c == null ? void 0 : c.createRootContext) == null ? void 0 : _a.call(c, deps);
+        }
+      } : {},
+      factory: async (deps, ctx) => c.factory(deps, ctx),
+      scope: c.service.scope
+    };
+  };
 }
 exports.coreServices = void 0;
@@ -48,8 +55,41 @@ exports.coreServices = void 0;
   coreServices2.scheduler = createServiceRef({ id: "core.scheduler" });
   coreServices2.tokenManager = createServiceRef({ id: "core.tokenManager" });
   coreServices2.urlReader = createServiceRef({ id: "core.urlReader" });
+  coreServices2.identity = createServiceRef({ id: "core.identity" });
 })(exports.coreServices || (exports.coreServices = {}));
+function createSharedEnvironment(config) {
+  const configCallback = typeof config === "function" ? config : () => config;
+  return (...options) => {
+    var _a;
+    const actualConfig = configCallback(...options);
+    const services = (_a = actualConfig == null ? void 0 : actualConfig.services) == null ? void 0 : _a.map(
+      (sf) => typeof sf === "function" ? sf() : sf
+    );
+    const exists = /* @__PURE__ */ new Set();
+    const duplicates = /* @__PURE__ */ new Set();
+    for (const { service } of services != null ? services : []) {
+      if (exists.has(service.id)) {
+        duplicates.add(service.id);
+      } else {
+        exists.add(service.id);
+      }
+    }
+    if (duplicates.size > 0) {
+      const dupStr = [...duplicates].map((id) => `'${id}'`).join(", ");
+      throw new Error(
+        `Duplicate service implementations provided in shared environment for ${dupStr}`
+      );
+    }
+    const env = {
+      $$type: "SharedBackendEnvironment",
+      version: "v1",
+      services
+    };
+    return env;
+  };
+}
 function createExtensionPoint(config) {
   return {
     id: config.id,
@@ -64,18 +104,25 @@ function createExtensionPoint(config) {
   };
 }
 function createBackendPlugin(config) {
-  return (options) => ({
-    id: config.id,
-    register(register) {
-      return config.register(register, options);
-    }
-  });
+  if (typeof config === "function") {
+    return config;
+  }
+  return () => config;
 }
 function createBackendModule(config) {
-  return (options) => ({
+  if (typeof config === "function") {
+    return (...options) => {
+      const c = config(...options);
+      return {
+        id: `${c.pluginId}.${c.moduleId}`,
+        register: c.register
+      };
+    };
+  }
+  return () => ({
     id: `${config.pluginId}.${config.moduleId}`,
     register(register) {
-      return config.register(register, options);
+      return config.register(register);
     }
   });
 }
@@ -85,4 +132,5 @@ exports.createBackendPlugin = createBackendPlugin;
 exports.createExtensionPoint = createExtensionPoint;
 exports.createServiceFactory = createServiceFactory;
 exports.createServiceRef = createServiceRef;
+exports.createSharedEnvironment = createSharedEnvironment;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.cjs.js","sources":["../src/services/system/types.ts","../src/services/definitions/coreServices.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\nimport { FactoryFunctionWithOptions, MaybeOptions } from '../../types';\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/\n Represents either a {@link ServiceFactory} or a function that returns one.\n \n @public\n /\nexport type ServiceFactoryOrFunction<TService = unknown> =\n \| ServiceFactory<TService>\n \| (() => ServiceFactory<TService>);\n\n/* @public /\nexport interface ServiceRefConfig<TService, TScope extends 'root' \| 'plugin'> {\n id: string;\n scope?: TScope;\n defaultFactory?: (\n service: ServiceRef<TService, TScope>,\n ) => Promise<ServiceFactoryOrFunction<TService>>;\n}\n\n/\n Creates a new service definition. This overload is used to create plugin scoped services.\n \n @public\n /\nexport function createServiceRef<TService>(\n config: ServiceRefConfig<TService, 'plugin'>,\n): ServiceRef<TService, 'plugin'>;\n\n/\n Creates a new service definition. This overload is used to create root scoped services.\n \n @public\n /\nexport function createServiceRef<TService>(\n config: ServiceRefConfig<TService, 'root'>,\n): ServiceRef<TService, 'root'>;\nexport function createServiceRef<TService>(\n config: ServiceRefConfig<TService, any>,\n): ServiceRef<TService, any> {\n const { id, scope = 'plugin', defaultFactory } = config;\n return {\n id,\n scope,\n get T(): TService {\n throw new Error(`tried to read ServiceRef.T of ${this}`);\n },\n toString() {\n return `serviceRef{${config.id}}`;\n },\n $$ref: 'service', // TODO: declare\n __defaultFactory: defaultFactory,\n } as ServiceRef<TService, typeof scope> & {\n __defaultFactory?: (\n service: ServiceRef<TService>,\n ) => Promise<ServiceFactory<TService> \| (() => ServiceFactory<TService>)>;\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/* @public /\nexport interface ServiceFactoryConfig<\n TService,\n TScope extends 'root' \| 'plugin',\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TOpts extends MaybeOptions = undefined,\n> {\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}\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 MaybeOptions = undefined,\n>(\n config: ServiceFactoryConfig<TService, TScope, TImpl, TDeps, TOpts>,\n): FactoryFunctionWithOptions<ServiceFactory<TService>, TOpts> {\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 { createServiceRef } from '../system';\n\n/\n All core services references\n \n @public\n /\nexport namespace coreServices {\n /\n The service reference for the plugin scoped {@link CacheService}.\n \n @public\n /\n export const cache = createServiceRef<import('./CacheService').CacheService>({\n id: 'core.cache',\n });\n\n /\n The service reference for the root scoped {@link ConfigService}.\n \n @public\n /\n export const config = createServiceRef<\n import('./ConfigService').ConfigService\n >({ id: 'core.config', scope: 'root' });\n\n /\n The service reference for the plugin scoped {@link DatabaseService}.\n \n @public\n /\n export const database = createServiceRef<\n import('./DatabaseService').DatabaseService\n >({ id: 'core.database' });\n\n /\n The service reference for the plugin scoped {@link DiscoveryService}.\n \n @public\n /\n export const discovery = createServiceRef<\n import('./DiscoveryService').DiscoveryService\n >({ id: 'core.discovery' });\n\n /\n The service reference for the plugin scoped {@link HttpRouterService}.\n \n @public\n /\n export const httpRouter = createServiceRef<\n import('./HttpRouterService').HttpRouterService\n >({ id: 'core.httpRouter' });\n\n /\n The service reference for the plugin scoped {@link LifecycleService}.\n \n @public\n /\n export const lifecycle = createServiceRef<\n import('./LifecycleService').LifecycleService\n >({ id: 'core.lifecycle' });\n\n /\n The service reference for the plugin scoped {@link LoggerService}.\n \n @public\n /\n export const logger = createServiceRef<\n import('./LoggerService').LoggerService\n >({ id: 'core.logger' });\n\n /\n The service reference for the plugin scoped {@link PermissionsService}.\n \n @public\n /\n export const permissions = createServiceRef<\n import('./PermissionsService').PermissionsService\n >({ id: 'core.permissions' });\n\n /\n The service reference for the plugin scoped {@link PluginMetadataService}.\n \n @public\n /\n export const pluginMetadata = createServiceRef<\n import('./PluginMetadataService').PluginMetadataService\n >({ id: 'core.pluginMetadata' });\n\n /\n The service reference for the root scoped {@link RootHttpRouterService}.\n \n @public\n /\n export const rootHttpRouter = createServiceRef<\n import('./RootHttpRouterService').RootHttpRouterService\n >({ id: 'core.rootHttpRouter', scope: 'root' });\n\n /\n The service reference for the root scoped {@link RootLifecycleService}.\n \n @public\n /\n export const rootLifecycle = createServiceRef<\n import('./RootLifecycleService').RootLifecycleService\n >({ id: 'core.rootLifecycle', scope: 'root' });\n\n /\n The service reference for the root scoped {@link RootLoggerService}.\n \n @public\n /\n export const rootLogger = createServiceRef<\n import('./RootLoggerService').RootLoggerService\n >({ id: 'core.rootLogger', scope: 'root' });\n\n /\n The service reference for the plugin scoped {@link SchedulerService}.\n \n @public\n /\n export const scheduler = createServiceRef<\n import('./SchedulerService').SchedulerService\n >({ id: 'core.scheduler' });\n\n /\n The service reference for the plugin scoped {@link TokenManagerService}.\n \n @public\n /\n export const tokenManager = createServiceRef<\n import('./TokenManagerService').TokenManagerService\n >({ id: 'core.tokenManager' });\n\n /\n The service reference for the plugin scoped {@link UrlReaderService}.\n \n @public\n /\n export const urlReader = createServiceRef<\n import('./UrlReaderService').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 { FactoryFunctionWithOptions, MaybeOptions } from '../types';\nimport {\n BackendRegistrationPoints,\n BackendFeature,\n ExtensionPoint,\n} from './types';\n\n/* @public /\nexport interface ExtensionPointConfig {\n id: string;\n}\n\n/* @public /\nexport function createExtensionPoint<T>(\n config: ExtensionPointConfig,\n): ExtensionPoint<T> {\n return {\n id: config.id,\n get T(): T {\n throw new Error(`tried to read ExtensionPoint.T of ${this}`);\n },\n toString() {\n return `extensionPoint{${config.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<TOptions extends MaybeOptions = undefined>(\n config: BackendPluginConfig<TOptions>,\n): FactoryFunctionWithOptions<BackendFeature, TOptions> {\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 Creates a new backend module for a given plugin.\n \n @public\n \n @remarks\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<TOptions extends MaybeOptions = undefined>(\n config: BackendModuleConfig<TOptions>,\n): FactoryFunctionWithOptions<BackendFeature, TOptions> {\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":["coreServices"],"mappings":";;;;AA4GO,SAAS,iBACd,MAC2B,EAAA;AAC3B,EAAA,MAAM,EAAE,EAAA,EAAI,KAAQ,GAAA,QAAA,EAAU,gBAAmB,GAAA,MAAA,CAAA;AACjD,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAI,CAAc,GAAA;AAChB,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,8BAAA,EAAiC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KACzD;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,cAAc,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAC9B;AAAA,IACA,KAAO,EAAA,SAAA;AAAA;AAAA,IACP,gBAAkB,EAAA,cAAA;AAAA,GACpB,CAAA;AAKF,CAAA;AAiCO,SAAS,qBAOd,MAC6D,EAAA;AAC7D,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;;AC5JiBA,8BAAA;AAAA,CAAV,CAAUA,aAAV,KAAA;AAME,EAAMA,aAAAA,CAAA,QAAQ,gBAAwD,CAAA;AAAA,IAC3E,EAAI,EAAA,YAAA;AAAA,GACL,CAAA,CAAA;AAOM,EAAMA,aAAAA,CAAA,SAAS,gBAEpB,CAAA,EAAE,IAAI,aAAe,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAO/B,EAAMA,cAAA,QAAW,GAAA,gBAAA,CAEtB,EAAE,EAAA,EAAI,iBAAiB,CAAA,CAAA;AAOlB,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAOnB,EAAMA,cAAA,UAAa,GAAA,gBAAA,CAExB,EAAE,EAAA,EAAI,mBAAmB,CAAA,CAAA;AAOpB,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAOnB,EAAMA,cAAA,MAAS,GAAA,gBAAA,CAEpB,EAAE,EAAA,EAAI,eAAe,CAAA,CAAA;AAOhB,EAAMA,cAAA,WAAc,GAAA,gBAAA,CAEzB,EAAE,EAAA,EAAI,oBAAoB,CAAA,CAAA;AAOrB,EAAMA,cAAA,cAAiB,GAAA,gBAAA,CAE5B,EAAE,EAAA,EAAI,uBAAuB,CAAA,CAAA;AAOxB,EAAMA,aAAAA,CAAA,iBAAiB,gBAE5B,CAAA,EAAE,IAAI,qBAAuB,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAOvC,EAAMA,aAAAA,CAAA,gBAAgB,gBAE3B,CAAA,EAAE,IAAI,oBAAsB,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAOtC,EAAMA,aAAAA,CAAA,aAAa,gBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAOnC,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAOnB,EAAMA,cAAA,YAAe,GAAA,gBAAA,CAE1B,EAAE,EAAA,EAAI,qBAAqB,CAAA,CAAA;AAOtB,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAAA,CAtIX,EAAAA,oBAAA,KAAAA,oBAAA,GAAA,EAAA,CAAA,CAAA;;ACMV,SAAS,qBACd,MACmB,EAAA;AACnB,EAAO,OAAA;AAAA,IACL,IAAI,MAAO,CAAA,EAAA;AAAA,IACX,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,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAClC;AAAA,IACA,KAAO,EAAA,iBAAA;AAAA;AAAA,GACT,CAAA;AACF,CAAA;AASO,SAAS,oBACd,MACsD,EAAA;AACtD,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;AA0BO,SAAS,oBACd,MACsD,EAAA;AACtD,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;;;;;;;;"}
1	+ {"version":3,"file":"index.cjs.js","sources":["../src/services/system/types.ts","../src/services/definitions/coreServices.ts","../src/wiring/createSharedEnvironment.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 createRootContext?(deps: { [key in string]: unknown }): Promise<unknown>;\n factory(\n deps: { [key in string]: unknown },\n context: unknown,\n ): Promise<TService>;\n };\n\n/\n Represents either a {@link ServiceFactory} or a function that returns one.\n \n @public\n /\nexport type ServiceFactoryOrFunction<TService = unknown> =\n \| ServiceFactory<TService>\n \| (() => ServiceFactory<TService>);\n\n/* @public /\nexport interface ServiceRefConfig<TService, TScope extends 'root' \| 'plugin'> {\n id: string;\n scope?: TScope;\n defaultFactory?: (\n service: ServiceRef<TService, TScope>,\n ) => Promise<ServiceFactoryOrFunction<TService>>;\n}\n\n/\n Creates a new service definition. This overload is used to create plugin scoped services.\n \n @public\n /\nexport function createServiceRef<TService>(\n config: ServiceRefConfig<TService, 'plugin'>,\n): ServiceRef<TService, 'plugin'>;\n\n/\n Creates a new service definition. This overload is used to create root scoped services.\n \n @public\n /\nexport function createServiceRef<TService>(\n config: ServiceRefConfig<TService, 'root'>,\n): ServiceRef<TService, 'root'>;\nexport function createServiceRef<TService>(\n config: ServiceRefConfig<TService, any>,\n): ServiceRef<TService, any> {\n const { id, scope = 'plugin', defaultFactory } = config;\n return {\n id,\n scope,\n get T(): TService {\n throw new Error(`tried to read ServiceRef.T of ${this}`);\n },\n toString() {\n return `serviceRef{${config.id}}`;\n },\n $$ref: 'service', // TODO: declare\n __defaultFactory: defaultFactory,\n } as ServiceRef<TService, typeof scope> & {\n __defaultFactory?: (\n service: ServiceRef<TService>,\n ) => Promise<ServiceFactory<TService> \| (() => ServiceFactory<TService>)>;\n };\n}\n\n/* @ignore /\ntype ServiceRefsToInstances<\n T extends { [key in string]: ServiceRef<unknown> },\n TScope extends 'root' \| 'plugin' = 'root' \| 'plugin',\n> = {\n [key in keyof T as T[key]['scope'] extends TScope ? key : never]: T[key]['T'];\n};\n\n/* @public /\nexport interface RootServiceFactoryConfig<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n> {\n service: ServiceRef<TService, 'root'>;\n deps: TDeps;\n factory(deps: ServiceRefsToInstances<TDeps, 'root'>): TImpl \| Promise<TImpl>;\n}\n\n/* @public /\nexport interface PluginServiceFactoryConfig<\n TService,\n TContext,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n> {\n service: ServiceRef<TService, 'plugin'>;\n deps: TDeps;\n createRootContext?(\n deps: ServiceRefsToInstances<TDeps, 'root'>,\n ): TContext \| Promise<TContext>;\n factory(\n deps: ServiceRefsToInstances<TDeps>,\n context: TContext,\n ): TImpl \| Promise<TImpl>;\n}\n\n/\n Creates a root scoped service factory without options.\n \n @public\n * @param config - The service factory configuration.\n /\nexport function createServiceFactory<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TOpts extends object \| undefined = undefined,\n>(\n config: RootServiceFactoryConfig<TService, TImpl, TDeps>,\n): () => ServiceFactory<TService>;\n/\n Creates a root scoped service factory with optional options.\n \n @public\n * @param config - The service factory configuration.\n /\nexport function createServiceFactory<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TOpts extends object \| undefined = undefined,\n>(\n config: (options?: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>,\n): (options?: TOpts) => ServiceFactory<TService>;\n/\n Creates a root scoped service factory with required options.\n \n @public\n * @param config - The service factory configuration.\n /\nexport function createServiceFactory<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TOpts extends object \| undefined = undefined,\n>(\n config: (options: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>,\n): (options: TOpts) => ServiceFactory<TService>;\n/\n Creates a plugin scoped service factory without options.\n \n @public\n * @param config - The service factory configuration.\n /\nexport function createServiceFactory<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TContext = undefined,\n TOpts extends object \| undefined = undefined,\n>(\n config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>,\n): () => ServiceFactory<TService>;\n/\n Creates a plugin scoped service factory with optional options.\n \n @public\n * @param config - The service factory configuration.\n /\nexport function createServiceFactory<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TContext = undefined,\n TOpts extends object \| undefined = undefined,\n>(\n config: (\n options?: TOpts,\n ) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>,\n): (options?: TOpts) => ServiceFactory<TService>;\n/\n Creates a plugin scoped service factory with required options.\n \n @public\n * @param config - The service factory configuration.\n /\nexport function createServiceFactory<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TContext = undefined,\n TOpts extends object \| undefined = undefined,\n>(\n config:\n \| PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>\n \| ((\n options: TOpts,\n ) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>),\n): (options: TOpts) => ServiceFactory<TService>;\nexport function createServiceFactory<\n TService,\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TContext,\n TOpts extends object \| undefined = undefined,\n>(\n config:\n \| RootServiceFactoryConfig<TService, TImpl, TDeps>\n \| PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>\n \| ((options: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>)\n \| ((\n options: TOpts,\n ) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>)\n \| (() => RootServiceFactoryConfig<TService, TImpl, TDeps>)\n \| (() => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>),\n): (options: TOpts) => ServiceFactory<TService> {\n const configCallback = typeof config === 'function' ? config : () => config;\n return (options: TOpts) => {\n const c = configCallback(options);\n return {\n ...c,\n ...('createRootContext' in c\n ? {\n createRootContext: async (deps: TDeps) =>\n c?.createRootContext?.(deps),\n }\n : {}),\n factory: async (deps: TDeps, ctx: TContext) => c.factory(deps, ctx),\n scope: c.service.scope,\n } as ServiceFactory<TService>;\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';\n\n/\n All core services references\n \n @public\n /\nexport namespace coreServices {\n /\n The service reference for the plugin scoped {@link CacheService}.\n \n @public\n /\n export const cache = createServiceRef<import('./CacheService').CacheService>({\n id: 'core.cache',\n });\n\n /\n The service reference for the root scoped {@link ConfigService}.\n \n @public\n /\n export const config = createServiceRef<\n import('./ConfigService').ConfigService\n >({ id: 'core.config', scope: 'root' });\n\n /\n The service reference for the plugin scoped {@link DatabaseService}.\n \n @public\n /\n export const database = createServiceRef<\n import('./DatabaseService').DatabaseService\n >({ id: 'core.database' });\n\n /\n The service reference for the plugin scoped {@link DiscoveryService}.\n \n @public\n /\n export const discovery = createServiceRef<\n import('./DiscoveryService').DiscoveryService\n >({ id: 'core.discovery' });\n\n /\n The service reference for the plugin scoped {@link HttpRouterService}.\n \n @public\n /\n export const httpRouter = createServiceRef<\n import('./HttpRouterService').HttpRouterService\n >({ id: 'core.httpRouter' });\n\n /\n The service reference for the plugin scoped {@link LifecycleService}.\n \n @public\n /\n export const lifecycle = createServiceRef<\n import('./LifecycleService').LifecycleService\n >({ id: 'core.lifecycle' });\n\n /\n The service reference for the plugin scoped {@link LoggerService}.\n \n @public\n /\n export const logger = createServiceRef<\n import('./LoggerService').LoggerService\n >({ id: 'core.logger' });\n\n /\n The service reference for the plugin scoped {@link PermissionsService}.\n \n @public\n /\n export const permissions = createServiceRef<\n import('./PermissionsService').PermissionsService\n >({ id: 'core.permissions' });\n\n /\n The service reference for the plugin scoped {@link PluginMetadataService}.\n \n @public\n /\n export const pluginMetadata = createServiceRef<\n import('./PluginMetadataService').PluginMetadataService\n >({ id: 'core.pluginMetadata' });\n\n /\n The service reference for the root scoped {@link RootHttpRouterService}.\n \n @public\n /\n export const rootHttpRouter = createServiceRef<\n import('./RootHttpRouterService').RootHttpRouterService\n >({ id: 'core.rootHttpRouter', scope: 'root' });\n\n /\n The service reference for the root scoped {@link RootLifecycleService}.\n \n @public\n /\n export const rootLifecycle = createServiceRef<\n import('./RootLifecycleService').RootLifecycleService\n >({ id: 'core.rootLifecycle', scope: 'root' });\n\n /\n The service reference for the root scoped {@link RootLoggerService}.\n \n @public\n /\n export const rootLogger = createServiceRef<\n import('./RootLoggerService').RootLoggerService\n >({ id: 'core.rootLogger', scope: 'root' });\n\n /\n The service reference for the plugin scoped {@link SchedulerService}.\n \n @public\n /\n export const scheduler = createServiceRef<\n import('./SchedulerService').SchedulerService\n >({ id: 'core.scheduler' });\n\n /\n The service reference for the plugin scoped {@link TokenManagerService}.\n \n @public\n /\n export const tokenManager = createServiceRef<\n import('./TokenManagerService').TokenManagerService\n >({ id: 'core.tokenManager' });\n\n /\n The service reference for the plugin scoped {@link UrlReaderService}.\n \n @public\n /\n export const urlReader = createServiceRef<\n import('./UrlReaderService').UrlReaderService\n >({ id: 'core.urlReader' });\n\n /\n The service reference for the plugin scoped {@link IdentityService}.\n \n @public\n /\n export const identity = createServiceRef<\n import('./IdentityService').IdentityService\n >({ id: 'core.identity' });\n}\n","/\n * Copyright 2023 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 { ServiceFactory, ServiceFactoryOrFunction } from '../services';\n\n/* @public /\nexport interface SharedBackendEnvironmentConfig {\n services?: ServiceFactoryOrFunction[];\n}\n\n// This type is opaque in order to allow for future API evolution without\n// cluttering the external API. For example we might want to add support\n// for more powerful callback based backend modifications.\n//\n// By making this opaque we also ensure that the type doesn't become an input\n// type that we need to care about, as it would otherwise be possible to pass\n// a custom environment definition to `createBackend`, which we don't want.\n/\n @public\n /\nexport interface SharedBackendEnvironment {\n $$type: 'SharedBackendEnvironment';\n}\n\n/\n This type is NOT supposed to be used by anyone except internally by the backend-app-api package.\n * @internal /\nexport interface InternalSharedBackendEnvironment {\n version: 'v1';\n services?: ServiceFactory[];\n}\n\n/\n Creates a shared backend environment which can be used to create multiple backends\n * @public\n /\nexport function createSharedEnvironment<\n TOptions extends [options?: object] = [],\n>(\n config:\n \| SharedBackendEnvironmentConfig\n \| ((...params: TOptions) => SharedBackendEnvironmentConfig),\n): (...options: TOptions) => SharedBackendEnvironment {\n const configCallback = typeof config === 'function' ? config : () => config;\n\n return (...options) => {\n const actualConfig = configCallback(...options);\n const services = actualConfig?.services?.map(sf =>\n typeof sf === 'function' ? sf() : sf,\n );\n\n const exists = new Set<string>();\n const duplicates = new Set<string>();\n for (const { service } of services ?? []) {\n if (exists.has(service.id)) {\n duplicates.add(service.id);\n } else {\n exists.add(service.id);\n }\n }\n\n if (duplicates.size > 0) {\n const dupStr = [...duplicates].map(id => `'${id}'`).join(', ');\n throw new Error(\n `Duplicate service implementations provided in shared environment for ${dupStr}`,\n );\n }\n\n // Here to ensure type safety in this internal implementation.\n const env: SharedBackendEnvironment & InternalSharedBackendEnvironment = {\n $$type: 'SharedBackendEnvironment',\n version: 'v1',\n services,\n };\n return env;\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 interface ExtensionPointConfig {\n id: string;\n}\n\n/* @public /\nexport function createExtensionPoint<T>(\n config: ExtensionPointConfig,\n): ExtensionPoint<T> {\n return {\n id: config.id,\n get T(): T {\n throw new Error(`tried to read ExtensionPoint.T of ${this}`);\n },\n toString() {\n return `extensionPoint{${config.id}}`;\n },\n $$ref: 'extension-point', // TODO: declare\n };\n}\n\n/* @public /\nexport interface BackendPluginConfig {\n id: string;\n register(reg: BackendRegistrationPoints): void;\n}\n\n/* @public /\nexport function createBackendPlugin<TOptions extends [options?: object] = []>(\n config: BackendPluginConfig \| ((...params: TOptions) => BackendPluginConfig),\n): (...params: TOptions) => BackendFeature {\n if (typeof config === 'function') {\n return config;\n }\n\n return () => config;\n}\n\n/* @public /\nexport interface BackendModuleConfig {\n pluginId: string;\n moduleId: string;\n register(\n reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>,\n ): void;\n}\n\n/\n Creates a new backend module for a given plugin.\n \n @public\n \n @remarks\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<TOptions extends [options?: object] = []>(\n config: BackendModuleConfig \| ((...params: TOptions) => BackendModuleConfig),\n): (...params: TOptions) => BackendFeature {\n if (typeof config === 'function') {\n return (...options: TOptions) => {\n const c = config(...options);\n return {\n id: `${c.pluginId}.${c.moduleId}`,\n register: c.register,\n };\n };\n }\n return () => ({\n id: `${config.pluginId}.${config.moduleId}`,\n register(register: BackendRegistrationPoints) {\n // TODO: Hide registerExtensionPoint\n return config.register(register);\n },\n });\n}\n"],"names":["coreServices"],"mappings":";;;;AA4GO,SAAS,iBACd,MAC2B,EAAA;AAC3B,EAAA,MAAM,EAAE,EAAA,EAAI,KAAQ,GAAA,QAAA,EAAU,gBAAmB,GAAA,MAAA,CAAA;AACjD,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAI,CAAc,GAAA;AAChB,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,8BAAA,EAAiC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KACzD;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,cAAc,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAC9B;AAAA,IACA,KAAO,EAAA,SAAA;AAAA;AAAA,IACP,gBAAkB,EAAA,cAAA;AAAA,GACpB,CAAA;AAKF,CAAA;AAoIO,SAAS,qBAOd,MAS8C,EAAA;AAC9C,EAAA,MAAM,cAAiB,GAAA,OAAO,MAAW,KAAA,UAAA,GAAa,SAAS,MAAM,MAAA,CAAA;AACrE,EAAA,OAAO,CAAC,OAAmB,KAAA;AACzB,IAAM,MAAA,CAAA,GAAI,eAAe,OAAO,CAAA,CAAA;AAChC,IAAO,OAAA;AAAA,MACL,GAAG,CAAA;AAAA,MACH,GAAI,uBAAuB,CACvB,GAAA;AAAA,QACE,iBAAA,EAAmB,OAAO,IAAa,KAAA;AA5RnD,UAAA,IAAA,EAAA,CAAA;AA6Rc,UAAA,OAAA,CAAA,EAAA,GAAA,CAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,CAAA,CAAG,sBAAH,IAAuB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,CAAA,CAAA,EAAA,IAAA,CAAA,CAAA;AAAA,SAAA;AAAA,UAE3B,EAAC;AAAA,MACL,SAAS,OAAO,IAAA,EAAa,QAAkB,CAAE,CAAA,OAAA,CAAQ,MAAM,GAAG,CAAA;AAAA,MAClE,KAAA,EAAO,EAAE,OAAQ,CAAA,KAAA;AAAA,KACnB,CAAA;AAAA,GACF,CAAA;AACF;;AC7QiBA,8BAAA;AAAA,CAAV,CAAUA,aAAV,KAAA;AAME,EAAMA,aAAAA,CAAA,QAAQ,gBAAwD,CAAA;AAAA,IAC3E,EAAI,EAAA,YAAA;AAAA,GACL,CAAA,CAAA;AAOM,EAAMA,aAAAA,CAAA,SAAS,gBAEpB,CAAA,EAAE,IAAI,aAAe,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAO/B,EAAMA,cAAA,QAAW,GAAA,gBAAA,CAEtB,EAAE,EAAA,EAAI,iBAAiB,CAAA,CAAA;AAOlB,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAOnB,EAAMA,cAAA,UAAa,GAAA,gBAAA,CAExB,EAAE,EAAA,EAAI,mBAAmB,CAAA,CAAA;AAOpB,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAOnB,EAAMA,cAAA,MAAS,GAAA,gBAAA,CAEpB,EAAE,EAAA,EAAI,eAAe,CAAA,CAAA;AAOhB,EAAMA,cAAA,WAAc,GAAA,gBAAA,CAEzB,EAAE,EAAA,EAAI,oBAAoB,CAAA,CAAA;AAOrB,EAAMA,cAAA,cAAiB,GAAA,gBAAA,CAE5B,EAAE,EAAA,EAAI,uBAAuB,CAAA,CAAA;AAOxB,EAAMA,aAAAA,CAAA,iBAAiB,gBAE5B,CAAA,EAAE,IAAI,qBAAuB,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAOvC,EAAMA,aAAAA,CAAA,gBAAgB,gBAE3B,CAAA,EAAE,IAAI,oBAAsB,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAOtC,EAAMA,aAAAA,CAAA,aAAa,gBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AAOnC,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAOnB,EAAMA,cAAA,YAAe,GAAA,gBAAA,CAE1B,EAAE,EAAA,EAAI,qBAAqB,CAAA,CAAA;AAOtB,EAAMA,cAAA,SAAY,GAAA,gBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA,CAAA;AAOnB,EAAMA,cAAA,QAAW,GAAA,gBAAA,CAEtB,EAAE,EAAA,EAAI,iBAAiB,CAAA,CAAA;AAAA,CA/IV,EAAAA,oBAAA,KAAAA,oBAAA,GAAA,EAAA,CAAA,CAAA;;AC0BV,SAAS,wBAGd,MAGoD,EAAA;AACpD,EAAA,MAAM,cAAiB,GAAA,OAAO,MAAW,KAAA,UAAA,GAAa,SAAS,MAAM,MAAA,CAAA;AAErE,EAAA,OAAO,IAAI,OAAY,KAAA;AA1DzB,IAAA,IAAA,EAAA,CAAA;AA2DI,IAAM,MAAA,YAAA,GAAe,cAAe,CAAA,GAAG,OAAO,CAAA,CAAA;AAC9C,IAAM,MAAA,QAAA,GAAA,CAAW,EAAc,GAAA,YAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,YAAA,CAAA,QAAA,KAAd,IAAwB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA;AAAA,MAAI,CAC3C,EAAA,KAAA,OAAO,EAAO,KAAA,UAAA,GAAa,IAAO,GAAA,EAAA;AAAA,KAAA,CAAA;AAGpC,IAAM,MAAA,MAAA,uBAAa,GAAY,EAAA,CAAA;AAC/B,IAAM,MAAA,UAAA,uBAAiB,GAAY,EAAA,CAAA;AACnC,IAAA,KAAA,MAAW,EAAE,OAAA,EAAa,IAAA,QAAA,IAAA,IAAA,GAAA,QAAA,GAAY,EAAI,EAAA;AACxC,MAAA,IAAI,MAAO,CAAA,GAAA,CAAI,OAAQ,CAAA,EAAE,CAAG,EAAA;AAC1B,QAAW,UAAA,CAAA,GAAA,CAAI,QAAQ,EAAE,CAAA,CAAA;AAAA,OACpB,MAAA;AACL,QAAO,MAAA,CAAA,GAAA,CAAI,QAAQ,EAAE,CAAA,CAAA;AAAA,OACvB;AAAA,KACF;AAEA,IAAI,IAAA,UAAA,CAAW,OAAO,CAAG,EAAA;AACvB,MAAM,MAAA,MAAA,GAAS,CAAC,GAAG,UAAU,CAAA,CAAE,GAAI,CAAA,CAAA,EAAA,KAAM,CAAI,CAAA,EAAA,EAAA,CAAA,CAAA,CAAK,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAC7D,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAwE,qEAAA,EAAA,MAAA,CAAA,CAAA;AAAA,OAC1E,CAAA;AAAA,KACF;AAGA,IAAA,MAAM,GAAmE,GAAA;AAAA,MACvE,MAAQ,EAAA,0BAAA;AAAA,MACR,OAAS,EAAA,IAAA;AAAA,MACT,QAAA;AAAA,KACF,CAAA;AACA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT,CAAA;AACF;;AC7DO,SAAS,qBACd,MACmB,EAAA;AACnB,EAAO,OAAA;AAAA,IACL,IAAI,MAAO,CAAA,EAAA;AAAA,IACX,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,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAClC;AAAA,IACA,KAAO,EAAA,iBAAA;AAAA;AAAA,GACT,CAAA;AACF,CAAA;AASO,SAAS,oBACd,MACyC,EAAA;AACzC,EAAI,IAAA,OAAO,WAAW,UAAY,EAAA;AAChC,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAEA,EAAA,OAAO,MAAM,MAAA,CAAA;AACf,CAAA;AAyBO,SAAS,oBACd,MACyC,EAAA;AACzC,EAAI,IAAA,OAAO,WAAW,UAAY,EAAA;AAChC,IAAA,OAAO,IAAI,OAAsB,KAAA;AAC/B,MAAM,MAAA,CAAA,GAAI,MAAO,CAAA,GAAG,OAAO,CAAA,CAAA;AAC3B,MAAO,OAAA;AAAA,QACL,EAAI,EAAA,CAAA,EAAG,CAAE,CAAA,QAAA,CAAA,CAAA,EAAY,CAAE,CAAA,QAAA,CAAA,CAAA;AAAA,QACvB,UAAU,CAAE,CAAA,QAAA;AAAA,OACd,CAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,OAAO,OAAO;AAAA,IACZ,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,SAAS,QAAQ,CAAA,CAAA;AAAA,KACjC;AAAA,GACF,CAAA,CAAA;AACF;;;;;;;;;"}

package/dist/index.d.ts CHANGED Viewed

@@ -8,6 +8,7 @@
 import { Config } from '@backstage/config';
 import { Handler } from 'express';
+import { IdentityApi } from '@backstage/plugin-auth-node';
 import { JsonValue } from '@backstage/types';
 import { Knex } from 'knex';
 import { PermissionEvaluator } from '@backstage/plugin-permission-common';
@@ -21,16 +22,16 @@ export declare interface BackendFeature {
 }
 /** @public */
-export declare interface BackendModuleConfig<TOptions> {
+export declare interface BackendModuleConfig {
     pluginId: string;
     moduleId: string;
-    register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>, options: TOptions): void;
+    register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>): void;
 }
 /** @public */
-export declare interface BackendPluginConfig<TOptions> {
+export declare interface BackendPluginConfig {
     id: string;
-    register(reg: BackendRegistrationPoints, options: TOptions): void;
+    register(reg: BackendRegistrationPoints): void;
 }
 /** @public */
@@ -217,6 +218,12 @@ export declare namespace coreServices {
      * @public
      */
     const urlReader: ServiceRef<UrlReaderService, "plugin">;
+    /**
+     * The service reference for the plugin scoped {@link IdentityService}.
+     *
+     * @public
+     */
+    const identity: ServiceRef<IdentityService, "plugin">;
 }
 /**
@@ -233,20 +240,73 @@ export declare namespace coreServices {
  *
  * The `pluginId` should exactly match the `id` of the plugin that the module extends.
  */
-export declare function createBackendModule<TOptions extends MaybeOptions = undefined>(config: BackendModuleConfig<TOptions>): FactoryFunctionWithOptions<BackendFeature, TOptions>;
+export declare function createBackendModule<TOptions extends [options?: object] = []>(config: BackendModuleConfig | ((...params: TOptions) => BackendModuleConfig)): (...params: TOptions) => BackendFeature;
 /** @public */
-export declare function createBackendPlugin<TOptions extends MaybeOptions = undefined>(config: BackendPluginConfig<TOptions>): FactoryFunctionWithOptions<BackendFeature, TOptions>;
+export declare function createBackendPlugin<TOptions extends [options?: object] = []>(config: BackendPluginConfig | ((...params: TOptions) => BackendPluginConfig)): (...params: TOptions) => BackendFeature;
 /** @public */
 export declare function createExtensionPoint<T>(config: ExtensionPointConfig): ExtensionPoint<T>;
 /**
+ * Creates a root scoped service factory without options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: RootServiceFactoryConfig<TService, TImpl, TDeps>): () => ServiceFactory<TService>;
+/**
+ * Creates a root scoped service factory with optional options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: (options?: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>): (options?: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a root scoped service factory with required options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TOpts extends object | undefined = undefined>(config: (options: TOpts) => RootServiceFactoryConfig<TService, TImpl, TDeps>): (options: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory without options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>): () => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory with optional options.
+ *
+ * @public
+ * @param config - The service factory configuration.
+ */
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: (options?: TOpts) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>): (options?: TOpts) => ServiceFactory<TService>;
+/**
+ * Creates a plugin scoped service factory with required options.
+ *
  * @public
+ * @param config - The service factory configuration.
  */
-export declare function createServiceFactory<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
+export declare function createServiceFactory<TService, TImpl extends TService, TDeps extends {
     [name in string]: ServiceRef<unknown>;
-}, TOpts extends MaybeOptions = undefined>(config: ServiceFactoryConfig<TService, TScope, TImpl, TDeps, TOpts>): FactoryFunctionWithOptions<ServiceFactory<TService>, TOpts>;
+}, TContext = undefined, TOpts extends object | undefined = undefined>(config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps> | ((options: TOpts) => PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>)): (options: TOpts) => ServiceFactory<TService>;
 /**
  * Creates a new service definition. This overload is used to create plugin scoped services.
@@ -262,9 +322,15 @@ export declare function createServiceRef<TService>(config: ServiceRefConfig<TSer
  */
 export declare function createServiceRef<TService>(config: ServiceRefConfig<TService, 'root'>): ServiceRef<TService, 'root'>;
+/**
+ * Creates a shared backend environment which can be used to create multiple backends
+ * @public
+ */
+export declare function createSharedEnvironment<TOptions extends [options?: object] = []>(config: SharedBackendEnvironmentConfig | ((...params: TOptions) => SharedBackendEnvironmentConfig)): (...options: TOptions) => SharedBackendEnvironment;
 /**
  * The DatabaseService manages access to databases that Plugins get.
- *gs
+ *
  * @public
  */
 export declare interface DatabaseService {
@@ -356,13 +422,6 @@ export declare interface ExtensionPointConfig {
     id: string;
 }
-/**
- * Helper type that makes the options argument optional if options are not required.
- *
- * @ignore
- */
-declare type FactoryFunctionWithOptions<TResult, TOptions> = undefined extends TOptions ? (options?: TOptions) => TResult : (options: TOptions) => TResult;
 /**
  * @public
  */
@@ -370,6 +429,10 @@ export declare interface HttpRouterService {
     use(handler: Handler): void;
 }
+/** @public */
+export declare interface IdentityService extends IdentityApi {
+}
 /**
  * @public
  **/
@@ -411,13 +474,6 @@ export declare type LogMeta = {
     [name: string]: unknown;
 };
-/**
- * Base type for options objects that aren't required.
- *
- * @ignore
- */
-declare type MaybeOptions = object | undefined;
 /** @public */
 export declare interface PermissionsService extends PermissionEvaluator {
 }
@@ -429,6 +485,16 @@ export declare interface PluginMetadataService {
     getId(): string;
 }
+/** @public */
+export declare interface PluginServiceFactoryConfig<TService, TContext, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    service: ServiceRef<TService, 'plugin'>;
+    deps: TDeps;
+    createRootContext?(deps: ServiceRefsToInstances<TDeps, 'root'>): TContext | Promise<TContext>;
+    factory(deps: ServiceRefsToInstances<TDeps>, context: TContext): TImpl | Promise<TImpl>;
+}
 /**
  * An options object for {@link UrlReaderService.readTree} operations.
  *
@@ -621,6 +687,15 @@ export declare interface RootLifecycleService extends LifecycleService {
 export declare interface RootLoggerService extends LoggerService {
 }
+/** @public */
+export declare interface RootServiceFactoryConfig<TService, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    service: ServiceRef<TService, 'root'>;
+    deps: TDeps;
+    factory(deps: ServiceRefsToInstances<TDeps, 'root'>): TImpl | Promise<TImpl>;
+}
 /** @public */
 export declare interface SchedulerService extends PluginTaskScheduler {
 }
@@ -701,22 +776,14 @@ export declare type ServiceFactory<TService = unknown> = {
     deps: {
         [key in string]: ServiceRef<unknown>;
     };
-    factory(deps: {
+    createRootContext?(deps: {
         [key in string]: unknown;
-    }): Promise<(deps: {
+    }): Promise<unknown>;
+    factory(deps: {
         [key in string]: unknown;
-    }) => Promise<TService>>;
+    }, context: unknown): Promise<TService>;
 };
-/** @public */
-export declare interface ServiceFactoryConfig<TService, TScope extends 'root' | 'plugin', TImpl extends TService, TDeps extends {
-    [name in string]: ServiceRef<unknown>;
-}, TOpts extends MaybeOptions = undefined> {
-    service: ServiceRef<TService, TScope>;
-    deps: TDeps;
-    factory(deps: ServiceRefsToInstances<TDeps, 'root'>, options: TOpts): TScope extends 'root' ? Promise<TImpl> : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;
-}
 /**
  * Represents either a {@link ServiceFactory} or a function that returns one.
  *
@@ -761,11 +828,21 @@ export declare interface ServiceRefConfig<TService, TScope extends 'root' | 'plu
 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;
+    [key in keyof T as T[key]['scope'] extends TScope ? key : never]: T[key]['T'];
 };
+/**
+ * @public
+ */
+export declare interface SharedBackendEnvironment {
+    $$type: 'SharedBackendEnvironment';
+}
+/** @public */
+export declare interface SharedBackendEnvironmentConfig {
+    services?: ServiceFactoryOrFunction[];
+}
 /**
  * Interface for creating and validating tokens.
  *

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-plugin-api",
   "description": "Core API used by Backstage backend plugins",
-  "version": "0.3.0-next.1",
+  "version": "0.3.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -33,16 +33,17 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-tasks": "^0.4.1-next.1",
-    "@backstage/config": "^1.0.6-next.0",
-    "@backstage/plugin-permission-common": "^0.7.3-next.0",
+    "@backstage/backend-tasks": "^0.4.1",
+    "@backstage/config": "^1.0.6",
+    "@backstage/plugin-auth-node": "^0.2.9",
+    "@backstage/plugin-permission-common": "^0.7.3",
     "@backstage/types": "^1.0.2",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "knex": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.1-next.2"
+    "@backstage/cli": "^0.22.1"
   },
   "files": [
     "dist",