@backstage/backend-plugin-api 1.9.2-next.0 → 1.9.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/backend-plugin-api
 
+## 1.9.2
+
+### Patch Changes
+
+- 02c4e8a: Removed unused `json-schema` runtime dependency. The package was only used for TypeScript types from `@types/json-schema`; affected imports have been converted to `import type` to allow safe removal.
+- 0211390: Added optional `secrets` schema support to `ActionsRegistryActionOptions` and `ActionsRegistryActionContext`. Actions can now declare a Zod secrets schema separate from the input schema, enabling surfaces to collect sensitive credentials independently from tool arguments. Added optional `secrets` field to `ActionsServiceAction` metadata and `ActionsService.invoke()` parameters.
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.7.2
+  - @backstage/plugin-permission-node@0.11.1
+
+## 1.9.2-next.1
+
+### Patch Changes
+
+- 0211390: Added optional `secrets` schema support to `ActionsRegistryActionOptions` and `ActionsRegistryActionContext`. Actions can now declare a Zod secrets schema separate from the input schema, enabling surfaces to collect sensitive credentials independently from tool arguments. Added optional `secrets` field to `ActionsServiceAction` metadata and `ActionsService.invoke()` parameters.
+
 ## 1.9.2-next.0
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -5,6 +5,7 @@ import { LoggerService, BackstageCredentials } from '@backstage/backend-plugin-a
 import { JsonObject, JsonValue } from '@backstage/types';
 import { JSONSchema7 } from 'json-schema';
 import { Request } from 'express';
+export { C as ConnectionRegistration } from './types/types.d-BJ6KGQ77.js';
 
 /** @public */
 interface RootSystemMetadataServicePluginInfo {
@@ -18,8 +19,9 @@ interface RootSystemMetadataService {
 /**
  * @alpha
  */
-type ActionsRegistryActionContext<TInputSchema extends AnyZodObject> = {
+type ActionsRegistryActionContext<TInputSchema extends AnyZodObject, TSecretsSchema extends AnyZodObject | undefined = undefined> = {
     input: z.infer<TInputSchema>;
+    secrets: TSecretsSchema extends AnyZodObject ? z.infer<TSecretsSchema> : undefined;
     logger: LoggerService;
     credentials: BackstageCredentials;
 };
@@ -37,13 +39,14 @@ type ActionsRegistryActionExample<TInputSchema extends AnyZodObject, TOutputSche
 /**
  * @alpha
  */
-type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject> = {
+type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject, TSecretsSchema extends AnyZodObject | undefined = undefined> = {
     name: string;
     title: string;
     description: string;
     schema: {
         input: (zod: typeof z) => TInputSchema;
         output: (zod: typeof z) => TOutputSchema;
+        secrets?: (zod: typeof z) => TSecretsSchema extends AnyZodObject ? TSecretsSchema : never;
     };
     examples?: Array<ActionsRegistryActionExample<TInputSchema, TOutputSchema>>;
     visibilityPermission?: BasicPermission;
@@ -52,7 +55,7 @@ type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSche
         idempotent?: boolean;
         readOnly?: boolean;
     };
-    action: (context: ActionsRegistryActionContext<TInputSchema>) => Promise<z.infer<TOutputSchema> extends void ? void : {
+    action: (context: ActionsRegistryActionContext<TInputSchema, TSecretsSchema>) => Promise<z.infer<TOutputSchema> extends void ? void : {
         output: z.infer<TOutputSchema>;
     }>;
 };
@@ -60,7 +63,7 @@ type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSche
  * @alpha
  */
 interface ActionsRegistryService {
-    register<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject>(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>): void;
+    register<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject, TSecretsSchema extends AnyZodObject | undefined = undefined>(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema, TSecretsSchema>): void;
 }
 
 /**
@@ -75,6 +78,7 @@ type ActionsServiceAction = {
     schema: {
         input: JSONSchema7;
         output: JSONSchema7;
+        secrets?: JSONSchema7;
     };
     examples?: Array<{
         title: string;
@@ -100,6 +104,7 @@ interface ActionsService {
     invoke(opts: {
         id: string;
         input?: JsonObject;
+        secrets?: JsonObject;
         credentials: BackstageCredentials;
     }): Promise<{
         output: JsonValue;

package/dist/index.d.ts

@@ -6,6 +6,8 @@ import { PermissionRule, PermissionResourceRef, PermissionRuleset } from '@backs
 import { Config } from '@backstage/config';
 import { Duration } from 'luxon';
 import { Readable } from 'node:stream';
+import { d as ServiceRef, a as BackendModuleRegistrationPoints, B as BackendFeature, b as BackendPluginRegistrationPoints, E as ExtensionPoint } from './types/types.d-BJ6KGQ77.js';
+export { c as ExtensionPointFactoryContext, P as PluginServiceFactoryOptions, R as RootServiceFactoryOptions, S as ServiceFactory, e as ServiceRefOptions, f as createServiceFactory, g as createServiceRef } from './types/types.d-BJ6KGQ77.js';
 export { isChildPath } from '@backstage/cli-common';
 
 /**
@@ -1732,142 +1734,6 @@ declare namespace coreServices {
     const rootInstanceMetadata: ServiceRef<RootInstanceMetadataService, "root", "singleton">;
 }
 
-/** @public */
-interface BackendFeature {
-    $$type: '@backstage/BackendFeature';
-}
-
-/**
- * A reference to a backend service. You can use these references to mark
- * dependencies on services and having their implementations injected
- * automatically.
- *
- * @public
- */
-type ServiceRef<TService, TScope extends 'root' | 'plugin' = 'root' | 'plugin', TInstances extends 'singleton' | 'multiton' = 'singleton' | 'multiton'> = {
-    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;
-    /**
-     * Marks whether the service is a multiton or not. Multiton services the
-     * opposite of singletons - they can be provided many times, and when depended
-     * on, you receive an array of all provided instances.
-     */
-    multiton?: TInstances extends 'multiton' ? true : false;
-    /**
-     * Utility for getting the type of the service, using `typeof serviceRef.T`.
-     * Reading this value will always return `null`. It is only intended for use with `typeof serviceRef.T`.
-     */
-    T: TService;
-    $$type: '@backstage/ServiceRef';
-};
-/** @public */
-interface ServiceFactory<TService = unknown, TScope extends 'plugin' | 'root' = 'plugin' | 'root', TInstances extends 'singleton' | 'multiton' = 'singleton' | 'multiton'> extends BackendFeature {
-    service: ServiceRef<TService, TScope, TInstances>;
-}
-/** @public */
-interface ServiceRefOptions<TService, TScope extends 'root' | 'plugin', TInstances extends 'singleton' | 'multiton'> {
-    id: string;
-    scope?: TScope;
-    multiton?: TInstances extends 'multiton' ? true : false;
-    defaultFactory?(service: ServiceRef<TService, TScope>): Promise<ServiceFactory>;
-}
-/**
- * Creates a new service definition. This overload is used to create plugin scoped services.
- *
- * @public
- */
-declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'plugin', 'singleton'>): ServiceRef<TService, 'plugin', 'singleton'>;
-/**
- * Creates a new service definition. This overload is used to create root scoped services.
- *
- * @public
- */
-declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'root', 'singleton'>): ServiceRef<TService, 'root', 'singleton'>;
-/**
- * Creates a new service definition. This overload is used to create plugin scoped services.
- *
- * @public
- */
-declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'plugin', 'multiton'>): ServiceRef<TService, 'plugin', 'multiton'>;
-/**
- * Creates a new service definition. This overload is used to create root scoped services.
- *
- * @public
- */
-declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'root', 'multiton'>): ServiceRef<TService, 'root', 'multiton'>;
-/** @ignore */
-type ServiceRefsToInstances<T extends {
-    [key in string]: ServiceRef<unknown>;
-}, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
-    [key in keyof T as T[key]['scope'] extends TScope ? key : never]: T[key]['multiton'] extends true | undefined ? Array<T[key]['T']> : T[key]['T'];
-};
-/** @public */
-interface RootServiceFactoryOptions<TService, TInstances extends 'singleton' | 'multiton', TImpl extends TService, TDeps extends {
-    [name in string]: ServiceRef<unknown>;
-}> {
-    /**
-     * The initialization strategy for the service factory. This service is root scoped and will use `always` by default.
-     *
-     * @remarks
-     *
-     * - `always` - The service will always be initialized regardless if it is used or not.
-     * - `lazy` - The service will only be initialized if it is depended on by a different service or feature.
-     *
-     * Service factories for root scoped services use `always` as the default, while plugin scoped services use `lazy`.
-     */
-    initialization?: 'always' | 'lazy';
-    service: ServiceRef<TService, 'root', TInstances>;
-    deps: TDeps;
-    factory(deps: ServiceRefsToInstances<TDeps, 'root'>): TImpl | Promise<TImpl>;
-}
-/** @public */
-interface PluginServiceFactoryOptions<TService, TInstances extends 'singleton' | 'multiton', TContext, TImpl extends TService, TDeps extends {
-    [name in string]: ServiceRef<unknown>;
-}> {
-    /**
-     * The initialization strategy for the service factory. This service is plugin scoped and will use `lazy` by default.
-     *
-     * @remarks
-     *
-     * - `always` - The service will always be initialized regardless if it is used or not.
-     * - `lazy` - The service will only be initialized if it is depended on by a different service or feature.
-     *
-     * Service factories for root scoped services use `always` as the default, while plugin scoped services use `lazy`.
-     */
-    initialization?: 'always' | 'lazy';
-    service: ServiceRef<TService, 'plugin', TInstances>;
-    deps: TDeps;
-    createRootContext?(deps: ServiceRefsToInstances<TDeps, 'root'>): TContext | Promise<TContext>;
-    factory(deps: ServiceRefsToInstances<TDeps>, context: TContext): TImpl | Promise<TImpl>;
-}
-/**
- * Creates a root scoped service factory without options.
- *
- * @public
- * @param options - The service factory configuration.
- */
-declare function createServiceFactory<TService, TInstances extends 'singleton' | 'multiton', TImpl extends TService, TDeps extends {
-    [name in string]: ServiceRef<unknown, 'root'>;
-}>(options: RootServiceFactoryOptions<TService, TInstances, TImpl, TDeps>): ServiceFactory<TService, 'root', TInstances>;
-/**
- * Creates a plugin scoped service factory without options.
- *
- * @public
- * @param options - The service factory configuration.
- */
-declare function createServiceFactory<TService, TInstances extends 'singleton' | 'multiton', TImpl extends TService, TDeps extends {
-    [name in string]: ServiceRef<unknown>;
-}, TContext = undefined>(options: PluginServiceFactoryOptions<TService, TInstances, TContext, TImpl, TDeps>): ServiceFactory<TService, 'plugin', TInstances>;
-
 /**
  * Tries to deduce whether a thrown error is a database conflict.
  *
@@ -1901,85 +1767,6 @@ declare function resolvePackagePath(name: string, ...paths: string[]): string;
  */
 declare function resolveSafeChildPath(base: string, path: string): string;
 
-/**
- * TODO
- *
- * @public
- */
-type ExtensionPoint<T> = {
-    id: string;
-    /**
-     * Utility for getting the type of the extension point, using `typeof extensionPoint.T`.
-     * Reading this value will always return `null`. It is only intended for use with `typeof extensionPoint.T`.
-     */
-    T: T;
-    toString(): string;
-    $$type: '@backstage/ExtensionPoint';
-};
-/**
- * Context provided to extension point factories.
- *
- * @public
- */
-interface ExtensionPointFactoryContext {
-    /**
-     * Report a startup failure that happened as part of using an extension that
-     * the module provided. This should be called before the plugin's `init`
-     * function returns.
-     */
-    reportModuleStartupFailure(options: {
-        error: Error;
-    }): void;
-}
-/** @ignore */
-type DepsToInstances<TDeps extends {
-    [key in string]: ServiceRef<unknown> | ExtensionPoint<unknown>;
-}> = {
-    [key in keyof TDeps]: TDeps[key] extends ServiceRef<unknown, 'root' | 'plugin', 'multiton'> ? Array<TDeps[key]['T']> : TDeps[key]['T'];
-};
-/**
- * The callbacks passed to the `register` method of a backend plugin.
- *
- * @public
- */
-interface BackendPluginRegistrationPoints {
-    /**
-     * Registers an implementation for an extension point.
-     */
-    registerExtensionPoint<TExtensionPoint>(ref: ExtensionPoint<TExtensionPoint>, impl: TExtensionPoint): void;
-    /**
-     * Registers a factory that produces a separate implementation for an extension point for each module.
-     */
-    registerExtensionPoint<TExtensionPoint>(options: {
-        extensionPoint: ExtensionPoint<TExtensionPoint>;
-        factory: (context: ExtensionPointFactoryContext) => TExtensionPoint;
-    }): void;
-    registerInit<TDeps extends {
-        [name in string]: ServiceRef<unknown>;
-    }>(options: {
-        deps: TDeps;
-        init(deps: DepsToInstances<TDeps>): Promise<void>;
-    }): void;
-}
-/**
- * The callbacks passed to the `register` method of a backend module.
- *
- * @public
- */
-interface BackendModuleRegistrationPoints {
-    registerExtensionPoint<TExtensionPoint>(ref: ExtensionPoint<TExtensionPoint>, impl: TExtensionPoint): void;
-    registerExtensionPoint<TExtensionPoint>(options: {
-        extensionPoint: ExtensionPoint<TExtensionPoint>;
-        factory: (context: ExtensionPointFactoryContext) => TExtensionPoint;
-    }): void;
-    registerInit<TDeps extends {
-        [name in string]: ServiceRef<unknown> | ExtensionPoint<unknown>;
-    }>(options: {
-        deps: TDeps;
-        init(deps: DepsToInstances<TDeps>): Promise<void>;
-    }): void;
-}
-
 /**
  * The configuration options passed to {@link createBackendModule}.
  *
@@ -2083,5 +1870,5 @@ declare function createBackendFeatureLoader<TDeps extends {
     [name in string]: unknown;
 }>(options: CreateBackendFeatureLoaderOptions<TDeps>): BackendFeature;
 
-export { coreServices, createBackendFeatureLoader, createBackendModule, createBackendPlugin, createExtensionPoint, createServiceFactory, createServiceRef, isDatabaseConflictError, readSchedulerServiceTaskScheduleDefinitionFromConfig, resolvePackagePath, resolveSafeChildPath };
-export type { AuditorService, AuditorServiceCreateEventOptions, AuditorServiceEvent, AuditorServiceEventSeverityLevel, AuthService, BackendFeature, BackendModuleRegistrationPoints, BackendPluginRegistrationPoints, BackstageCredentials, BackstageNonePrincipal, BackstagePrincipalAccessRestrictions, BackstagePrincipalTypes, BackstageServicePrincipal, BackstageUserInfo, BackstageUserPrincipal, CacheService, CacheServiceOptions, CacheServiceSetOptions, CreateBackendFeatureLoaderOptions, CreateBackendModuleOptions, CreateBackendPluginOptions, CreateExtensionPointOptions, DatabaseService, DiscoveryService, ExtensionPoint, ExtensionPointFactoryContext, HttpAuthService, HttpRouterService, HttpRouterServiceAuthPolicy, LifecycleService, LifecycleServiceShutdownHook, LifecycleServiceShutdownOptions, LifecycleServiceStartupHook, LifecycleServiceStartupOptions, LoggerService, PermissionsRegistryService, PermissionsRegistryServiceAddResourceTypeOptions, PermissionsService, PermissionsServiceRequestOptions, PluginMetadataService, PluginServiceFactoryOptions, RootConfigService, RootHealthService, RootHttpRouterService, RootInstanceMetadataService, RootInstanceMetadataServicePluginInfo, RootLifecycleService, RootLoggerService, RootServiceFactoryOptions, SchedulerService, SchedulerServiceTaskDescriptor, SchedulerServiceTaskFunction, SchedulerServiceTaskInvocationDefinition, SchedulerServiceTaskRunner, SchedulerServiceTaskScheduleDefinition, SchedulerServiceTaskScheduleDefinitionConfig, ServiceFactory, ServiceRef, ServiceRefOptions, UrlReaderService, UrlReaderServiceReadTreeOptions, UrlReaderServiceReadTreeResponse, UrlReaderServiceReadTreeResponseDirOptions, UrlReaderServiceReadTreeResponseFile, UrlReaderServiceReadUrlOptions, UrlReaderServiceReadUrlResponse, UrlReaderServiceSearchOptions, UrlReaderServiceSearchResponse, UrlReaderServiceSearchResponseFile, UserInfoService };
+export { BackendFeature, BackendModuleRegistrationPoints, BackendPluginRegistrationPoints, ExtensionPoint, ServiceRef, coreServices, createBackendFeatureLoader, createBackendModule, createBackendPlugin, createExtensionPoint, isDatabaseConflictError, readSchedulerServiceTaskScheduleDefinitionFromConfig, resolvePackagePath, resolveSafeChildPath };
+export type { AuditorService, AuditorServiceCreateEventOptions, AuditorServiceEvent, AuditorServiceEventSeverityLevel, AuthService, BackstageCredentials, BackstageNonePrincipal, BackstagePrincipalAccessRestrictions, BackstagePrincipalTypes, BackstageServicePrincipal, BackstageUserInfo, BackstageUserPrincipal, CacheService, CacheServiceOptions, CacheServiceSetOptions, CreateBackendFeatureLoaderOptions, CreateBackendModuleOptions, CreateBackendPluginOptions, CreateExtensionPointOptions, DatabaseService, DiscoveryService, HttpAuthService, HttpRouterService, HttpRouterServiceAuthPolicy, LifecycleService, LifecycleServiceShutdownHook, LifecycleServiceShutdownOptions, LifecycleServiceStartupHook, LifecycleServiceStartupOptions, LoggerService, PermissionsRegistryService, PermissionsRegistryServiceAddResourceTypeOptions, PermissionsService, PermissionsServiceRequestOptions, PluginMetadataService, RootConfigService, RootHealthService, RootHttpRouterService, RootInstanceMetadataService, RootInstanceMetadataServicePluginInfo, RootLifecycleService, RootLoggerService, SchedulerService, SchedulerServiceTaskDescriptor, SchedulerServiceTaskFunction, SchedulerServiceTaskInvocationDefinition, SchedulerServiceTaskRunner, SchedulerServiceTaskScheduleDefinition, SchedulerServiceTaskScheduleDefinitionConfig, UrlReaderService, UrlReaderServiceReadTreeOptions, UrlReaderServiceReadTreeResponse, UrlReaderServiceReadTreeResponseDirOptions, UrlReaderServiceReadTreeResponseFile, UrlReaderServiceReadUrlOptions, UrlReaderServiceReadUrlResponse, UrlReaderServiceSearchOptions, UrlReaderServiceSearchResponse, UrlReaderServiceSearchResponseFile, UserInfoService };

package/dist/types/types.d-BJ6KGQ77.d.ts

@@ -0,0 +1,240 @@
+/** @public */
+interface BackendFeature {
+    $$type: '@backstage/BackendFeature';
+}
+
+/**
+ * A reference to a backend service. You can use these references to mark
+ * dependencies on services and having their implementations injected
+ * automatically.
+ *
+ * @public
+ */
+type ServiceRef<TService, TScope extends 'root' | 'plugin' = 'root' | 'plugin', TInstances extends 'singleton' | 'multiton' = 'singleton' | 'multiton'> = {
+    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;
+    /**
+     * Marks whether the service is a multiton or not. Multiton services the
+     * opposite of singletons - they can be provided many times, and when depended
+     * on, you receive an array of all provided instances.
+     */
+    multiton?: TInstances extends 'multiton' ? true : false;
+    /**
+     * Utility for getting the type of the service, using `typeof serviceRef.T`.
+     * Reading this value will always return `null`. It is only intended for use with `typeof serviceRef.T`.
+     */
+    T: TService;
+    $$type: '@backstage/ServiceRef';
+};
+/** @public */
+interface ServiceFactory<TService = unknown, TScope extends 'plugin' | 'root' = 'plugin' | 'root', TInstances extends 'singleton' | 'multiton' = 'singleton' | 'multiton'> extends BackendFeature {
+    service: ServiceRef<TService, TScope, TInstances>;
+}
+/** @public */
+interface ServiceRefOptions<TService, TScope extends 'root' | 'plugin', TInstances extends 'singleton' | 'multiton'> {
+    id: string;
+    scope?: TScope;
+    multiton?: TInstances extends 'multiton' ? true : false;
+    defaultFactory?(service: ServiceRef<TService, TScope>): Promise<ServiceFactory>;
+}
+/**
+ * Creates a new service definition. This overload is used to create plugin scoped services.
+ *
+ * @public
+ */
+declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'plugin', 'singleton'>): ServiceRef<TService, 'plugin', 'singleton'>;
+/**
+ * Creates a new service definition. This overload is used to create root scoped services.
+ *
+ * @public
+ */
+declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'root', 'singleton'>): ServiceRef<TService, 'root', 'singleton'>;
+/**
+ * Creates a new service definition. This overload is used to create plugin scoped services.
+ *
+ * @public
+ */
+declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'plugin', 'multiton'>): ServiceRef<TService, 'plugin', 'multiton'>;
+/**
+ * Creates a new service definition. This overload is used to create root scoped services.
+ *
+ * @public
+ */
+declare function createServiceRef<TService>(options: ServiceRefOptions<TService, 'root', 'multiton'>): ServiceRef<TService, 'root', 'multiton'>;
+/** @ignore */
+type ServiceRefsToInstances<T extends {
+    [key in string]: ServiceRef<unknown>;
+}, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
+    [key in keyof T as T[key]['scope'] extends TScope ? key : never]: T[key]['multiton'] extends true | undefined ? Array<T[key]['T']> : T[key]['T'];
+};
+/** @public */
+interface RootServiceFactoryOptions<TService, TInstances extends 'singleton' | 'multiton', TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    /**
+     * The initialization strategy for the service factory. This service is root scoped and will use `always` by default.
+     *
+     * @remarks
+     *
+     * - `always` - The service will always be initialized regardless if it is used or not.
+     * - `lazy` - The service will only be initialized if it is depended on by a different service or feature.
+     *
+     * Service factories for root scoped services use `always` as the default, while plugin scoped services use `lazy`.
+     */
+    initialization?: 'always' | 'lazy';
+    service: ServiceRef<TService, 'root', TInstances>;
+    deps: TDeps;
+    factory(deps: ServiceRefsToInstances<TDeps, 'root'>): TImpl | Promise<TImpl>;
+}
+/** @public */
+interface PluginServiceFactoryOptions<TService, TInstances extends 'singleton' | 'multiton', TContext, TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}> {
+    /**
+     * The initialization strategy for the service factory. This service is plugin scoped and will use `lazy` by default.
+     *
+     * @remarks
+     *
+     * - `always` - The service will always be initialized regardless if it is used or not.
+     * - `lazy` - The service will only be initialized if it is depended on by a different service or feature.
+     *
+     * Service factories for root scoped services use `always` as the default, while plugin scoped services use `lazy`.
+     */
+    initialization?: 'always' | 'lazy';
+    service: ServiceRef<TService, 'plugin', TInstances>;
+    deps: TDeps;
+    createRootContext?(deps: ServiceRefsToInstances<TDeps, 'root'>): TContext | Promise<TContext>;
+    factory(deps: ServiceRefsToInstances<TDeps>, context: TContext): TImpl | Promise<TImpl>;
+}
+/**
+ * Creates a root scoped service factory without options.
+ *
+ * @public
+ * @param options - The service factory configuration.
+ */
+declare function createServiceFactory<TService, TInstances extends 'singleton' | 'multiton', TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown, 'root'>;
+}>(options: RootServiceFactoryOptions<TService, TInstances, TImpl, TDeps>): ServiceFactory<TService, 'root', TInstances>;
+/**
+ * Creates a plugin scoped service factory without options.
+ *
+ * @public
+ * @param options - The service factory configuration.
+ */
+declare function createServiceFactory<TService, TInstances extends 'singleton' | 'multiton', TImpl extends TService, TDeps extends {
+    [name in string]: ServiceRef<unknown>;
+}, TContext = undefined>(options: PluginServiceFactoryOptions<TService, TInstances, TContext, TImpl, TDeps>): ServiceFactory<TService, 'plugin', TInstances>;
+
+/**
+ * TODO
+ *
+ * @public
+ */
+type ExtensionPoint<T> = {
+    id: string;
+    /**
+     * Utility for getting the type of the extension point, using `typeof extensionPoint.T`.
+     * Reading this value will always return `null`. It is only intended for use with `typeof extensionPoint.T`.
+     */
+    T: T;
+    toString(): string;
+    $$type: '@backstage/ExtensionPoint';
+};
+/**
+ * Context provided to extension point factories.
+ *
+ * @public
+ */
+interface ExtensionPointFactoryContext {
+    /**
+     * Report a startup failure that happened as part of using an extension that
+     * the module provided. This should be called before the plugin's `init`
+     * function returns.
+     */
+    reportModuleStartupFailure(options: {
+        error: Error;
+    }): void;
+}
+/** @ignore */
+type DepsToInstances<TDeps extends {
+    [key in string]: ServiceRef<unknown> | ExtensionPoint<unknown>;
+}> = {
+    [key in keyof TDeps]: TDeps[key] extends ServiceRef<unknown, 'root' | 'plugin', 'multiton'> ? Array<TDeps[key]['T']> : TDeps[key]['T'];
+};
+/**
+ * Declares that a plugin or module consumes a particular connection type.
+ *
+ * @alpha
+ */
+interface ConnectionRegistration {
+    /**
+     * The connection type identifier, matching the `type` field in connections
+     * config and in calls to `find` / `findOptional` on the connections service.
+     */
+    type: string;
+    /**
+     * Whether the connection is essential for the plugin or module to function.
+     * If true, the backend will fail to start if no matching connection is
+     * configured. Defaults to false.
+     */
+    required?: boolean;
+    /**
+     * Human-readable explanation of why the plugin or module needs this
+     * connection type. Surfaced in tooling and startup diagnostics.
+     */
+    description?: string;
+}
+/**
+ * The callbacks passed to the `register` method of a backend plugin.
+ *
+ * @public
+ */
+interface BackendPluginRegistrationPoints {
+    /**
+     * Registers an implementation for an extension point.
+     */
+    registerExtensionPoint<TExtensionPoint>(ref: ExtensionPoint<TExtensionPoint>, impl: TExtensionPoint): void;
+    /**
+     * Registers a factory that produces a separate implementation for an extension point for each module.
+     */
+    registerExtensionPoint<TExtensionPoint>(options: {
+        extensionPoint: ExtensionPoint<TExtensionPoint>;
+        factory: (context: ExtensionPointFactoryContext) => TExtensionPoint;
+    }): void;
+    registerInit<TDeps extends {
+        [name in string]: ServiceRef<unknown>;
+    }>(options: {
+        deps: TDeps;
+        init(deps: DepsToInstances<TDeps>): Promise<void>;
+    }): void;
+}
+/**
+ * The callbacks passed to the `register` method of a backend module.
+ *
+ * @public
+ */
+interface BackendModuleRegistrationPoints {
+    registerExtensionPoint<TExtensionPoint>(ref: ExtensionPoint<TExtensionPoint>, impl: TExtensionPoint): void;
+    registerExtensionPoint<TExtensionPoint>(options: {
+        extensionPoint: ExtensionPoint<TExtensionPoint>;
+        factory: (context: ExtensionPointFactoryContext) => TExtensionPoint;
+    }): void;
+    registerInit<TDeps extends {
+        [name in string]: ServiceRef<unknown> | ExtensionPoint<unknown>;
+    }>(options: {
+        deps: TDeps;
+        init(deps: DepsToInstances<TDeps>): Promise<void>;
+    }): void;
+}
+
+export { createServiceFactory as f, createServiceRef as g };
+export type { BackendFeature as B, ConnectionRegistration as C, ExtensionPoint as E, PluginServiceFactoryOptions as P, RootServiceFactoryOptions as R, ServiceFactory as S, BackendModuleRegistrationPoints as a, BackendPluginRegistrationPoints as b, ExtensionPointFactoryContext as c, ServiceRef as d, ServiceRefOptions as e };

package/dist/wiring/createBackendModule.cjs.js

@@ -15,8 +15,9 @@ function createBackendModule(options) {
   }
   function getRegistrations() {
     const extensionPoints = [];
+    const connections = [];
     let init = void 0;
-    options.register({
+    const reg = {
       registerExtensionPoint(extOrOpts, impl) {
         if (init) {
           throw new Error("registerExtensionPoint called after registerInit");
@@ -33,6 +34,17 @@ function createBackendModule(options) {
           });
         }
       },
+      registerConnection(registration) {
+        if (init) {
+          throw new Error("registerConnection called after registerInit");
+        }
+        if (connections.some((c) => c.type === registration.type)) {
+          throw new Error(
+            `Duplicate connection registration for type '${registration.type}' in module '${options.moduleId}' for plugin '${options.pluginId}'`
+          );
+        }
+        connections.push({ ...registration });
+      },
       registerInit(regInit) {
         if (init) {
           throw new Error("registerInit must only be called once");
@@ -42,7 +54,8 @@ function createBackendModule(options) {
           func: regInit.init
         };
       }
-    });
+    };
+    options.register(reg);
     if (!init) {
       throw new Error(
         `registerInit was not called by register in ${options.moduleId} module for ${options.pluginId}`
@@ -54,6 +67,7 @@ function createBackendModule(options) {
         pluginId: options.pluginId,
         moduleId: options.moduleId,
         extensionPoints,
+        connections,
         init
       }
     ];

package/dist/wiring/createBackendModule.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"createBackendModule.cjs.js","sources":["../../src/wiring/createBackendModule.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 { BackendFeature } from '../types';\nimport { ID_PATTERN, ID_PATTERN_OLD } from './constants';\nimport {\n  BackendModuleRegistrationPoints,\n  ExtensionPoint,\n  ExtensionPointFactoryContext,\n  InternalBackendModuleRegistrationV1_1,\n  InternalBackendRegistrations,\n} from './types';\n\n/**\n * The configuration options passed to {@link createBackendModule}.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/modules | The architecture of modules}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport interface CreateBackendModuleOptions {\n  /**\n   * Should exactly match the `id` of the plugin that the module extends.\n   *\n   * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n   */\n  pluginId: string;\n\n  /**\n   * The ID of this module, used to identify the module and ensure that it is not installed twice.\n   */\n  moduleId: string;\n  register(reg: BackendModuleRegistrationPoints): void;\n}\n\n/**\n * Creates a new backend module for a given plugin.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/modules | The architecture of modules}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport function createBackendModule(\n  options: CreateBackendModuleOptions,\n): BackendFeature {\n  if (!ID_PATTERN.test(options.moduleId)) {\n    console.warn(\n      `WARNING: The moduleId '${options.moduleId}' for plugin '${options.pluginId}', will be invalid soon, please change it to match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n  if (!ID_PATTERN_OLD.test(options.moduleId)) {\n    throw new Error(\n      `Invalid moduleId '${options.moduleId}' for plugin '${options.pluginId}', must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n\n  function getRegistrations() {\n    const extensionPoints: InternalBackendModuleRegistrationV1_1['extensionPoints'] =\n      [];\n    let init: InternalBackendModuleRegistrationV1_1['init'] | undefined =\n      undefined;\n\n    options.register({\n      registerExtensionPoint<TExtensionPoint>(\n        extOrOpts:\n          | ExtensionPoint<TExtensionPoint>\n          | {\n              extensionPoint: ExtensionPoint<TExtensionPoint>;\n              factory: (\n                context: ExtensionPointFactoryContext,\n              ) => TExtensionPoint;\n            },\n        impl?: TExtensionPoint,\n      ) {\n        if (init) {\n          throw new Error('registerExtensionPoint called after registerInit');\n        }\n        if (\n          typeof extOrOpts === 'object' &&\n          extOrOpts !== null &&\n          'extensionPoint' in extOrOpts\n        ) {\n          extensionPoints.push({\n            extensionPoint: extOrOpts.extensionPoint,\n            factory: extOrOpts.factory as (\n              context: ExtensionPointFactoryContext,\n            ) => unknown,\n          });\n        } else {\n          extensionPoints.push({\n            extensionPoint: extOrOpts,\n            factory: () => impl,\n          });\n        }\n      },\n      registerInit(regInit) {\n        if (init) {\n          throw new Error('registerInit must only be called once');\n        }\n        init = {\n          deps: regInit.deps,\n          func: regInit.init,\n        };\n      },\n    });\n\n    if (!init) {\n      throw new Error(\n        `registerInit was not called by register in ${options.moduleId} module for ${options.pluginId}`,\n      );\n    }\n\n    return [\n      {\n        type: 'module-v1.1',\n        pluginId: options.pluginId,\n        moduleId: options.moduleId,\n        extensionPoints,\n        init,\n      },\n    ];\n  }\n\n  return {\n    $$type: '@backstage/BackendFeature' as const,\n    featureType: 'registrations',\n    version: 'v1',\n    getRegistrations,\n  } as InternalBackendRegistrations;\n}\n"],"names":["ID_PATTERN","ID_PATTERN_OLD"],"mappings":";;;;AAuDO,SAAS,oBACd,OAAA,EACgB;AAChB,EAAA,IAAI,CAACA,oBAAA,CAAW,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AACtC,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,0BAA0B,OAAA,CAAQ,QAAQ,iBAAiB,OAAA,CAAQ,QAAQ,kEAAkEA,oBAAU,CAAA,2DAAA;AAAA,KACzJ;AAAA,EACF;AACA,EAAA,IAAI,CAACC,wBAAA,CAAe,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AAC1C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qBAAqB,OAAA,CAAQ,QAAQ,iBAAiB,OAAA,CAAQ,QAAQ,6BAA6BD,oBAAU,CAAA,2DAAA;AAAA,KAC/G;AAAA,EACF;AAEA,EAAA,SAAS,gBAAA,GAAmB;AAC1B,IAAA,MAAM,kBACJ,EAAC;AACH,IAAA,IAAI,IAAA,GACF,MAAA;AAEF,IAAA,OAAA,CAAQ,QAAA,CAAS;AAAA,MACf,sBAAA,CACE,WAQA,IAAA,EACA;AACA,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,kDAAkD,CAAA;AAAA,QACpE;AACA,QAAA,IACE,OAAO,SAAA,KAAc,QAAA,IACrB,SAAA,KAAc,IAAA,IACd,oBAAoB,SAAA,EACpB;AACA,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,gBAAgB,SAAA,CAAU,cAAA;AAAA,YAC1B,SAAS,SAAA,CAAU;AAAA,WAGpB,CAAA;AAAA,QACH,CAAA,MAAO;AACL,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,cAAA,EAAgB,SAAA;AAAA,YAChB,SAAS,MAAM;AAAA,WAChB,CAAA;AAAA,QACH;AAAA,MACF,CAAA;AAAA,MACA,aAAa,OAAA,EAAS;AACpB,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,QACzD;AACA,QAAA,IAAA,GAAO;AAAA,UACL,MAAM,OAAA,CAAQ,IAAA;AAAA,UACd,MAAM,OAAA,CAAQ;AAAA,SAChB;AAAA,MACF;AAAA,KACD,CAAA;AAED,IAAA,IAAI,CAAC,IAAA,EAAM;AACT,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,2CAAA,EAA8C,OAAA,CAAQ,QAAQ,CAAA,YAAA,EAAe,QAAQ,QAAQ,CAAA;AAAA,OAC/F;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL;AAAA,QACE,IAAA,EAAM,aAAA;AAAA,QACN,UAAU,OAAA,CAAQ,QAAA;AAAA,QAClB,UAAU,OAAA,CAAQ,QAAA;AAAA,QAClB,eAAA;AAAA,QACA;AAAA;AACF,KACF;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,2BAAA;AAAA,IACR,WAAA,EAAa,eAAA;AAAA,IACb,OAAA,EAAS,IAAA;AAAA,IACT;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"createBackendModule.cjs.js","sources":["../../src/wiring/createBackendModule.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 { BackendFeature } from '../types';\nimport { ID_PATTERN, ID_PATTERN_OLD } from './constants';\nimport {\n  BackendModuleRegistrationPoints,\n  ConnectionRegistration,\n  ExtensionPoint,\n  ExtensionPointFactoryContext,\n  InternalBackendModuleRegistrationPoints,\n  InternalBackendModuleRegistrationV1_1,\n  InternalBackendRegistrations,\n} from './types';\n\n/**\n * The configuration options passed to {@link createBackendModule}.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/modules | The architecture of modules}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport interface CreateBackendModuleOptions {\n  /**\n   * Should exactly match the `id` of the plugin that the module extends.\n   *\n   * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n   */\n  pluginId: string;\n\n  /**\n   * The ID of this module, used to identify the module and ensure that it is not installed twice.\n   */\n  moduleId: string;\n  register(reg: BackendModuleRegistrationPoints): void;\n}\n\n/**\n * Creates a new backend module for a given plugin.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/modules | The architecture of modules}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport function createBackendModule(\n  options: CreateBackendModuleOptions,\n): BackendFeature {\n  if (!ID_PATTERN.test(options.moduleId)) {\n    console.warn(\n      `WARNING: The moduleId '${options.moduleId}' for plugin '${options.pluginId}', will be invalid soon, please change it to match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n  if (!ID_PATTERN_OLD.test(options.moduleId)) {\n    throw new Error(\n      `Invalid moduleId '${options.moduleId}' for plugin '${options.pluginId}', must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n\n  function getRegistrations() {\n    const extensionPoints: InternalBackendModuleRegistrationV1_1['extensionPoints'] =\n      [];\n    const connections: ConnectionRegistration[] = [];\n    let init: InternalBackendModuleRegistrationV1_1['init'] | undefined =\n      undefined;\n\n    const reg: InternalBackendModuleRegistrationPoints = {\n      registerExtensionPoint<TExtensionPoint>(\n        extOrOpts:\n          | ExtensionPoint<TExtensionPoint>\n          | {\n              extensionPoint: ExtensionPoint<TExtensionPoint>;\n              factory: (\n                context: ExtensionPointFactoryContext,\n              ) => TExtensionPoint;\n            },\n        impl?: TExtensionPoint,\n      ) {\n        if (init) {\n          throw new Error('registerExtensionPoint called after registerInit');\n        }\n        if (\n          typeof extOrOpts === 'object' &&\n          extOrOpts !== null &&\n          'extensionPoint' in extOrOpts\n        ) {\n          extensionPoints.push({\n            extensionPoint: extOrOpts.extensionPoint,\n            factory: extOrOpts.factory as (\n              context: ExtensionPointFactoryContext,\n            ) => unknown,\n          });\n        } else {\n          extensionPoints.push({\n            extensionPoint: extOrOpts,\n            factory: () => impl,\n          });\n        }\n      },\n      registerConnection(registration) {\n        if (init) {\n          throw new Error('registerConnection called after registerInit');\n        }\n        if (connections.some(c => c.type === registration.type)) {\n          throw new Error(\n            `Duplicate connection registration for type '${registration.type}' in module '${options.moduleId}' for plugin '${options.pluginId}'`,\n          );\n        }\n        connections.push({ ...registration });\n      },\n      registerInit(regInit) {\n        if (init) {\n          throw new Error('registerInit must only be called once');\n        }\n        init = {\n          deps: regInit.deps,\n          func: regInit.init,\n        };\n      },\n    };\n    options.register(reg);\n\n    if (!init) {\n      throw new Error(\n        `registerInit was not called by register in ${options.moduleId} module for ${options.pluginId}`,\n      );\n    }\n\n    return [\n      {\n        type: 'module-v1.1',\n        pluginId: options.pluginId,\n        moduleId: options.moduleId,\n        extensionPoints,\n        connections,\n        init,\n      },\n    ];\n  }\n\n  return {\n    $$type: '@backstage/BackendFeature' as const,\n    featureType: 'registrations',\n    version: 'v1',\n    getRegistrations,\n  } as InternalBackendRegistrations;\n}\n"],"names":["ID_PATTERN","ID_PATTERN_OLD"],"mappings":";;;;AAyDO,SAAS,oBACd,OAAA,EACgB;AAChB,EAAA,IAAI,CAACA,oBAAA,CAAW,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AACtC,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,0BAA0B,OAAA,CAAQ,QAAQ,iBAAiB,OAAA,CAAQ,QAAQ,kEAAkEA,oBAAU,CAAA,2DAAA;AAAA,KACzJ;AAAA,EACF;AACA,EAAA,IAAI,CAACC,wBAAA,CAAe,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AAC1C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qBAAqB,OAAA,CAAQ,QAAQ,iBAAiB,OAAA,CAAQ,QAAQ,6BAA6BD,oBAAU,CAAA,2DAAA;AAAA,KAC/G;AAAA,EACF;AAEA,EAAA,SAAS,gBAAA,GAAmB;AAC1B,IAAA,MAAM,kBACJ,EAAC;AACH,IAAA,MAAM,cAAwC,EAAC;AAC/C,IAAA,IAAI,IAAA,GACF,MAAA;AAEF,IAAA,MAAM,GAAA,GAA+C;AAAA,MACnD,sBAAA,CACE,WAQA,IAAA,EACA;AACA,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,kDAAkD,CAAA;AAAA,QACpE;AACA,QAAA,IACE,OAAO,SAAA,KAAc,QAAA,IACrB,SAAA,KAAc,IAAA,IACd,oBAAoB,SAAA,EACpB;AACA,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,gBAAgB,SAAA,CAAU,cAAA;AAAA,YAC1B,SAAS,SAAA,CAAU;AAAA,WAGpB,CAAA;AAAA,QACH,CAAA,MAAO;AACL,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,cAAA,EAAgB,SAAA;AAAA,YAChB,SAAS,MAAM;AAAA,WAChB,CAAA;AAAA,QACH;AAAA,MACF,CAAA;AAAA,MACA,mBAAmB,YAAA,EAAc;AAC/B,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,8CAA8C,CAAA;AAAA,QAChE;AACA,QAAA,IAAI,YAAY,IAAA,CAAK,CAAA,CAAA,KAAK,EAAE,IAAA,KAAS,YAAA,CAAa,IAAI,CAAA,EAAG;AACvD,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAA,4CAAA,EAA+C,aAAa,IAAI,CAAA,aAAA,EAAgB,QAAQ,QAAQ,CAAA,cAAA,EAAiB,QAAQ,QAAQ,CAAA,CAAA;AAAA,WACnI;AAAA,QACF;AACA,QAAA,WAAA,CAAY,IAAA,CAAK,EAAE,GAAG,YAAA,EAAc,CAAA;AAAA,MACtC,CAAA;AAAA,MACA,aAAa,OAAA,EAAS;AACpB,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,QACzD;AACA,QAAA,IAAA,GAAO;AAAA,UACL,MAAM,OAAA,CAAQ,IAAA;AAAA,UACd,MAAM,OAAA,CAAQ;AAAA,SAChB;AAAA,MACF;AAAA,KACF;AACA,IAAA,OAAA,CAAQ,SAAS,GAAG,CAAA;AAEpB,IAAA,IAAI,CAAC,IAAA,EAAM;AACT,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,2CAAA,EAA8C,OAAA,CAAQ,QAAQ,CAAA,YAAA,EAAe,QAAQ,QAAQ,CAAA;AAAA,OAC/F;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL;AAAA,QACE,IAAA,EAAM,aAAA;AAAA,QACN,UAAU,OAAA,CAAQ,QAAA;AAAA,QAClB,UAAU,OAAA,CAAQ,QAAA;AAAA,QAClB,eAAA;AAAA,QACA,WAAA;AAAA,QACA;AAAA;AACF,KACF;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,2BAAA;AAAA,IACR,WAAA,EAAa,eAAA;AAAA,IACb,OAAA,EAAS,IAAA;AAAA,IACT;AAAA,GACF;AACF;;;;"}

package/dist/wiring/createBackendPlugin.cjs.js

@@ -15,8 +15,9 @@ function createBackendPlugin(options) {
   }
   function getRegistrations() {
     const extensionPoints = [];
+    const connections = [];
     let init = void 0;
-    options.register({
+    const reg = {
       registerExtensionPoint(extOrOpts, impl) {
         if (init) {
           throw new Error("registerExtensionPoint called after registerInit");
@@ -33,6 +34,17 @@ function createBackendPlugin(options) {
           });
         }
       },
+      registerConnection(registration) {
+        if (init) {
+          throw new Error("registerConnection called after registerInit");
+        }
+        if (connections.some((c) => c.type === registration.type)) {
+          throw new Error(
+            `Duplicate connection registration for type '${registration.type}' in plugin '${options.pluginId}'`
+          );
+        }
+        connections.push({ ...registration });
+      },
       registerInit(regInit) {
         if (init) {
           throw new Error("registerInit must only be called once");
@@ -42,7 +54,8 @@ function createBackendPlugin(options) {
           func: regInit.init
         };
       }
-    });
+    };
+    options.register(reg);
     if (!init) {
       throw new Error(
         `registerInit was not called by register in ${options.pluginId}`
@@ -53,6 +66,7 @@ function createBackendPlugin(options) {
         type: "plugin-v1.1",
         pluginId: options.pluginId,
         extensionPoints,
+        connections,
         init
       }
     ];

package/dist/wiring/createBackendPlugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"createBackendPlugin.cjs.js","sources":["../../src/wiring/createBackendPlugin.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 { BackendFeature } from '../types';\nimport {\n  BackendPluginRegistrationPoints,\n  ExtensionPoint,\n  ExtensionPointFactoryContext,\n  InternalBackendPluginRegistrationV1_1,\n  InternalBackendRegistrations,\n} from './types';\nimport { ID_PATTERN, ID_PATTERN_OLD } from './constants';\n\n/**\n * The configuration options passed to {@link createBackendPlugin}.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/plugins | The architecture of plugins}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport interface CreateBackendPluginOptions {\n  /**\n   * The ID of this plugin.\n   *\n   * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n   */\n  pluginId: string;\n  register(reg: BackendPluginRegistrationPoints): void;\n}\n\n/**\n * Creates a new backend plugin.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/plugins | The architecture of plugins}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport function createBackendPlugin(\n  options: CreateBackendPluginOptions,\n): BackendFeature {\n  if (!ID_PATTERN.test(options.pluginId)) {\n    console.warn(\n      `WARNING: The pluginId '${options.pluginId}' will be invalid soon, please change it to match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n  if (!ID_PATTERN_OLD.test(options.pluginId)) {\n    throw new Error(\n      `Invalid pluginId '${options.pluginId}', must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n\n  function getRegistrations() {\n    const extensionPoints: InternalBackendPluginRegistrationV1_1['extensionPoints'] =\n      [];\n    let init: InternalBackendPluginRegistrationV1_1['init'] | undefined =\n      undefined;\n\n    options.register({\n      registerExtensionPoint<TExtensionPoint>(\n        extOrOpts:\n          | ExtensionPoint<TExtensionPoint>\n          | {\n              extensionPoint: ExtensionPoint<TExtensionPoint>;\n              factory: (\n                context: ExtensionPointFactoryContext,\n              ) => TExtensionPoint;\n            },\n        impl?: TExtensionPoint,\n      ) {\n        if (init) {\n          throw new Error('registerExtensionPoint called after registerInit');\n        }\n        if (\n          typeof extOrOpts === 'object' &&\n          extOrOpts !== null &&\n          'extensionPoint' in extOrOpts\n        ) {\n          extensionPoints.push({\n            extensionPoint: extOrOpts.extensionPoint,\n            factory: extOrOpts.factory as (\n              context: ExtensionPointFactoryContext,\n            ) => unknown,\n          });\n        } else {\n          extensionPoints.push({\n            extensionPoint: extOrOpts,\n            factory: () => impl,\n          });\n        }\n      },\n      registerInit(regInit) {\n        if (init) {\n          throw new Error('registerInit must only be called once');\n        }\n        init = {\n          deps: regInit.deps,\n          func: regInit.init,\n        };\n      },\n    });\n\n    if (!init) {\n      throw new Error(\n        `registerInit was not called by register in ${options.pluginId}`,\n      );\n    }\n\n    return [\n      {\n        type: 'plugin-v1.1',\n        pluginId: options.pluginId,\n        extensionPoints,\n        init,\n      },\n    ];\n  }\n\n  return {\n    $$type: '@backstage/BackendFeature' as const,\n    version: 'v1',\n    featureType: 'registrations',\n    getRegistrations,\n  } as InternalBackendRegistrations;\n}\n"],"names":["ID_PATTERN","ID_PATTERN_OLD"],"mappings":";;;;AAkDO,SAAS,oBACd,OAAA,EACgB;AAChB,EAAA,IAAI,CAACA,oBAAA,CAAW,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AACtC,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,CAAA,uBAAA,EAA0B,OAAA,CAAQ,QAAQ,CAAA,8DAAA,EAAiEA,oBAAU,CAAA,2DAAA;AAAA,KACvH;AAAA,EACF;AACA,EAAA,IAAI,CAACC,wBAAA,CAAe,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AAC1C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kBAAA,EAAqB,OAAA,CAAQ,QAAQ,CAAA,0BAAA,EAA6BD,oBAAU,CAAA,2DAAA;AAAA,KAC9E;AAAA,EACF;AAEA,EAAA,SAAS,gBAAA,GAAmB;AAC1B,IAAA,MAAM,kBACJ,EAAC;AACH,IAAA,IAAI,IAAA,GACF,MAAA;AAEF,IAAA,OAAA,CAAQ,QAAA,CAAS;AAAA,MACf,sBAAA,CACE,WAQA,IAAA,EACA;AACA,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,kDAAkD,CAAA;AAAA,QACpE;AACA,QAAA,IACE,OAAO,SAAA,KAAc,QAAA,IACrB,SAAA,KAAc,IAAA,IACd,oBAAoB,SAAA,EACpB;AACA,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,gBAAgB,SAAA,CAAU,cAAA;AAAA,YAC1B,SAAS,SAAA,CAAU;AAAA,WAGpB,CAAA;AAAA,QACH,CAAA,MAAO;AACL,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,cAAA,EAAgB,SAAA;AAAA,YAChB,SAAS,MAAM;AAAA,WAChB,CAAA;AAAA,QACH;AAAA,MACF,CAAA;AAAA,MACA,aAAa,OAAA,EAAS;AACpB,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,QACzD;AACA,QAAA,IAAA,GAAO;AAAA,UACL,MAAM,OAAA,CAAQ,IAAA;AAAA,UACd,MAAM,OAAA,CAAQ;AAAA,SAChB;AAAA,MACF;AAAA,KACD,CAAA;AAED,IAAA,IAAI,CAAC,IAAA,EAAM;AACT,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,2CAAA,EAA8C,QAAQ,QAAQ,CAAA;AAAA,OAChE;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL;AAAA,QACE,IAAA,EAAM,aAAA;AAAA,QACN,UAAU,OAAA,CAAQ,QAAA;AAAA,QAClB,eAAA;AAAA,QACA;AAAA;AACF,KACF;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,2BAAA;AAAA,IACR,OAAA,EAAS,IAAA;AAAA,IACT,WAAA,EAAa,eAAA;AAAA,IACb;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"createBackendPlugin.cjs.js","sources":["../../src/wiring/createBackendPlugin.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 { BackendFeature } from '../types';\nimport {\n  BackendPluginRegistrationPoints,\n  ConnectionRegistration,\n  ExtensionPoint,\n  ExtensionPointFactoryContext,\n  InternalBackendPluginRegistrationPoints,\n  InternalBackendPluginRegistrationV1_1,\n  InternalBackendRegistrations,\n} from './types';\nimport { ID_PATTERN, ID_PATTERN_OLD } from './constants';\n\n/**\n * The configuration options passed to {@link createBackendPlugin}.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/plugins | The architecture of plugins}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport interface CreateBackendPluginOptions {\n  /**\n   * The ID of this plugin.\n   *\n   * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n   */\n  pluginId: string;\n  register(reg: BackendPluginRegistrationPoints): void;\n}\n\n/**\n * Creates a new backend plugin.\n *\n * @public\n * @see {@link https://backstage.io/docs/backend-system/architecture/plugins | The architecture of plugins}\n * @see {@link https://backstage.io/docs/backend-system/architecture/naming-patterns | Recommended naming patterns}\n */\nexport function createBackendPlugin(\n  options: CreateBackendPluginOptions,\n): BackendFeature {\n  if (!ID_PATTERN.test(options.pluginId)) {\n    console.warn(\n      `WARNING: The pluginId '${options.pluginId}' will be invalid soon, please change it to match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n  if (!ID_PATTERN_OLD.test(options.pluginId)) {\n    throw new Error(\n      `Invalid pluginId '${options.pluginId}', must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n\n  function getRegistrations() {\n    const extensionPoints: InternalBackendPluginRegistrationV1_1['extensionPoints'] =\n      [];\n    const connections: ConnectionRegistration[] = [];\n    let init: InternalBackendPluginRegistrationV1_1['init'] | undefined =\n      undefined;\n\n    const reg: InternalBackendPluginRegistrationPoints = {\n      registerExtensionPoint<TExtensionPoint>(\n        extOrOpts:\n          | ExtensionPoint<TExtensionPoint>\n          | {\n              extensionPoint: ExtensionPoint<TExtensionPoint>;\n              factory: (\n                context: ExtensionPointFactoryContext,\n              ) => TExtensionPoint;\n            },\n        impl?: TExtensionPoint,\n      ) {\n        if (init) {\n          throw new Error('registerExtensionPoint called after registerInit');\n        }\n        if (\n          typeof extOrOpts === 'object' &&\n          extOrOpts !== null &&\n          'extensionPoint' in extOrOpts\n        ) {\n          extensionPoints.push({\n            extensionPoint: extOrOpts.extensionPoint,\n            factory: extOrOpts.factory as (\n              context: ExtensionPointFactoryContext,\n            ) => unknown,\n          });\n        } else {\n          extensionPoints.push({\n            extensionPoint: extOrOpts,\n            factory: () => impl,\n          });\n        }\n      },\n      registerConnection(registration) {\n        if (init) {\n          throw new Error('registerConnection called after registerInit');\n        }\n        if (connections.some(c => c.type === registration.type)) {\n          throw new Error(\n            `Duplicate connection registration for type '${registration.type}' in plugin '${options.pluginId}'`,\n          );\n        }\n        connections.push({ ...registration });\n      },\n      registerInit(regInit) {\n        if (init) {\n          throw new Error('registerInit must only be called once');\n        }\n        init = {\n          deps: regInit.deps,\n          func: regInit.init,\n        };\n      },\n    };\n    options.register(reg);\n\n    if (!init) {\n      throw new Error(\n        `registerInit was not called by register in ${options.pluginId}`,\n      );\n    }\n\n    return [\n      {\n        type: 'plugin-v1.1',\n        pluginId: options.pluginId,\n        extensionPoints,\n        connections,\n        init,\n      },\n    ];\n  }\n\n  return {\n    $$type: '@backstage/BackendFeature' as const,\n    version: 'v1',\n    featureType: 'registrations',\n    getRegistrations,\n  } as InternalBackendRegistrations;\n}\n"],"names":["ID_PATTERN","ID_PATTERN_OLD"],"mappings":";;;;AAoDO,SAAS,oBACd,OAAA,EACgB;AAChB,EAAA,IAAI,CAACA,oBAAA,CAAW,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AACtC,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,CAAA,uBAAA,EAA0B,OAAA,CAAQ,QAAQ,CAAA,8DAAA,EAAiEA,oBAAU,CAAA,2DAAA;AAAA,KACvH;AAAA,EACF;AACA,EAAA,IAAI,CAACC,wBAAA,CAAe,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA,EAAG;AAC1C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kBAAA,EAAqB,OAAA,CAAQ,QAAQ,CAAA,0BAAA,EAA6BD,oBAAU,CAAA,2DAAA;AAAA,KAC9E;AAAA,EACF;AAEA,EAAA,SAAS,gBAAA,GAAmB;AAC1B,IAAA,MAAM,kBACJ,EAAC;AACH,IAAA,MAAM,cAAwC,EAAC;AAC/C,IAAA,IAAI,IAAA,GACF,MAAA;AAEF,IAAA,MAAM,GAAA,GAA+C;AAAA,MACnD,sBAAA,CACE,WAQA,IAAA,EACA;AACA,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,kDAAkD,CAAA;AAAA,QACpE;AACA,QAAA,IACE,OAAO,SAAA,KAAc,QAAA,IACrB,SAAA,KAAc,IAAA,IACd,oBAAoB,SAAA,EACpB;AACA,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,gBAAgB,SAAA,CAAU,cAAA;AAAA,YAC1B,SAAS,SAAA,CAAU;AAAA,WAGpB,CAAA;AAAA,QACH,CAAA,MAAO;AACL,UAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,YACnB,cAAA,EAAgB,SAAA;AAAA,YAChB,SAAS,MAAM;AAAA,WAChB,CAAA;AAAA,QACH;AAAA,MACF,CAAA;AAAA,MACA,mBAAmB,YAAA,EAAc;AAC/B,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,8CAA8C,CAAA;AAAA,QAChE;AACA,QAAA,IAAI,YAAY,IAAA,CAAK,CAAA,CAAA,KAAK,EAAE,IAAA,KAAS,YAAA,CAAa,IAAI,CAAA,EAAG;AACvD,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAA,4CAAA,EAA+C,YAAA,CAAa,IAAI,CAAA,aAAA,EAAgB,QAAQ,QAAQ,CAAA,CAAA;AAAA,WAClG;AAAA,QACF;AACA,QAAA,WAAA,CAAY,IAAA,CAAK,EAAE,GAAG,YAAA,EAAc,CAAA;AAAA,MACtC,CAAA;AAAA,MACA,aAAa,OAAA,EAAS;AACpB,QAAA,IAAI,IAAA,EAAM;AACR,UAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,QACzD;AACA,QAAA,IAAA,GAAO;AAAA,UACL,MAAM,OAAA,CAAQ,IAAA;AAAA,UACd,MAAM,OAAA,CAAQ;AAAA,SAChB;AAAA,MACF;AAAA,KACF;AACA,IAAA,OAAA,CAAQ,SAAS,GAAG,CAAA;AAEpB,IAAA,IAAI,CAAC,IAAA,EAAM;AACT,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,2CAAA,EAA8C,QAAQ,QAAQ,CAAA;AAAA,OAChE;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL;AAAA,QACE,IAAA,EAAM,aAAA;AAAA,QACN,UAAU,OAAA,CAAQ,QAAA;AAAA,QAClB,eAAA;AAAA,QACA,WAAA;AAAA,QACA;AAAA;AACF,KACF;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,2BAAA;AAAA,IACR,OAAA,EAAS,IAAA;AAAA,IACT,WAAA,EAAa,eAAA;AAAA,IACb;AAAA,GACF;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "1.9.2-next.0",
+  "version": "1.9.2",
   "description": "Core API used by Backstage backend plugins",
   "backstage": {
     "role": "node-library"
@@ -65,24 +65,23 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/cli-common": "0.2.2",
-    "@backstage/config": "1.3.8",
-    "@backstage/errors": "1.3.1",
-    "@backstage/plugin-auth-node": "0.7.2-next.0",
-    "@backstage/plugin-permission-common": "0.9.9",
-    "@backstage/plugin-permission-node": "0.11.1-next.0",
-    "@backstage/types": "1.2.2",
+    "@backstage/cli-common": "^0.2.2",
+    "@backstage/config": "^1.3.8",
+    "@backstage/errors": "^1.3.1",
+    "@backstage/plugin-auth-node": "^0.7.2",
+    "@backstage/plugin-permission-common": "^0.9.9",
+    "@backstage/plugin-permission-node": "^0.11.1",
+    "@backstage/types": "^1.2.2",
     "@types/express": "^4.17.6",
     "@types/json-schema": "^7.0.6",
     "@types/luxon": "^3.0.0",
-    "json-schema": "^0.4.0",
     "knex": "^3.0.0",
     "luxon": "^3.0.0",
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.4-next.0",
-    "@backstage/cli": "0.36.3-next.0"
+    "@backstage/backend-test-utils": "^1.11.4",
+    "@backstage/cli": "^0.36.3"
   },
   "configSchema": "config.d.ts"
 }