@backstage/backend-test-utils 0.4.4-next.1 → 0.4.4

package/dist/index.d.ts

@@ -7,7 +7,6 @@ import { ServiceFactory, ServiceRef, ExtensionPoint, BackendFeature, RootConfigS
 import { Backend, ExtendedHttpServer } from '@backstage/backend-app-api';
 import * as _backstage_plugin_events_node from '@backstage/plugin-events-node';
 import * as _backstage_backend_defaults_rootHttpRouter from '@backstage/backend-defaults/rootHttpRouter';
-import * as _backstage_backend_defaults_httpRouter from '@backstage/backend-defaults/httpRouter';
 import { JsonObject } from '@backstage/types';
 
 /**
@@ -201,6 +200,20 @@ declare function createMockDirectory(options?: CreateMockDirectoryOptions): Mock
  * @deprecated Use `CreateMockDirectoryOptions` from `@backstage/backend-test-utils` instead.
  */
 type MockDirectoryOptions = CreateMockDirectoryOptions;
+/**
+ * @public
+ * @deprecated Use `registerMswTestHooks` from `@backstage/backend-test-utils` instead.
+ */
+declare function setupRequestMockHandlers(worker: {
+    listen: (t: any) => void;
+    close: () => void;
+    resetHandlers: () => void;
+}): void;
+/**
+ * @public
+ * @deprecated This is an internal function and will no longer be exported from this package.
+ */
+declare function isDockerDisabledForTests(): boolean;
 
 /**
  * The possible caches to test against.
@@ -311,7 +324,7 @@ declare class TestDatabases {
  * @public
  * @param worker - service worker
  */
-declare function setupRequestMockHandlers(worker: {
+declare function registerMswTestHooks(worker: {
     listen: (t: any) => void;
     close: () => void;
     resetHandlers: () => void;
@@ -330,7 +343,7 @@ interface ServiceFactoryTesterOptions {
      * If a service factory is provided for a service that already has a default
      * implementation, the provided factory will override the default.
      */
-    dependencies?: Array<ServiceFactory | (() => ServiceFactory)>;
+    dependencies?: Array<ServiceFactory>;
 }
 /**
  * A utility to help test service factories in isolation.
@@ -346,8 +359,14 @@ declare class ServiceFactoryTester<TService, TScope extends 'root' | 'plugin'> {
      * @param options - Additional options
      * @returns A new tester instance for the provided subject.
      */
-    static from<TService, TScope extends 'root' | 'plugin'>(subject: ServiceFactory<TService, TScope> | (() => ServiceFactory<TService, TScope>), options?: ServiceFactoryTesterOptions): ServiceFactoryTester<TService, TScope>;
+    static from<TService, TScope extends 'root' | 'plugin'>(subject: ServiceFactory<TService, TScope>, options?: ServiceFactoryTesterOptions): ServiceFactoryTester<TService, TScope>;
     private constructor();
+    /**
+     * Returns the service instance for the subject.
+     *
+     * @deprecated Use `getSubject` instead.
+     */
+    get(...args: 'root' extends TScope ? [] : [pluginId?: string]): Promise<TService>;
     /**
      * Returns the service instance for the subject.
      *
@@ -358,7 +377,7 @@ declare class ServiceFactoryTester<TService, TScope extends 'root' | 'plugin'> {
      *
      * By default the plugin ID 'test' is used.
      */
-    get(...args: 'root' extends TScope ? [] : [pluginId?: string]): Promise<TService>;
+    getSubject(...args: 'root' extends TScope ? [] : [pluginId?: string]): Promise<TService>;
     /**
      * Return the service instance for any of the provided dependencies or built-in services.
      *
@@ -379,8 +398,8 @@ interface TestBackendOptions<TExtensionPoints extends any[]> {
             ];
         }
     ];
-    features?: Array<BackendFeature | (() => BackendFeature) | Promise<{
-        default: BackendFeature | (() => BackendFeature);
+    features?: Array<BackendFeature | Promise<{
+        default: BackendFeature;
     }>>;
 }
 /** @public */
@@ -411,24 +430,24 @@ declare namespace mockServices {
         type Options = {
             data?: JsonObject;
         };
-        const factory: (options?: Options | undefined) => ServiceFactory<RootConfigService, "root">;
+        const factory: ServiceFactory<RootConfigService, "root"> & ((options?: Options | undefined) => ServiceFactory<RootConfigService, "root">);
     }
     function rootLogger(options?: rootLogger.Options): LoggerService;
     namespace rootLogger {
         type Options = {
             level?: 'none' | 'error' | 'warn' | 'info' | 'debug';
         };
-        const factory: (options?: Options | undefined) => ServiceFactory<LoggerService, "root">;
+        const factory: ServiceFactory<LoggerService, "root"> & ((options?: Options | undefined) => ServiceFactory<LoggerService, "root">);
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootLoggerService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootLoggerService>;
     }
     function tokenManager(): TokenManagerService;
     namespace tokenManager {
-        const factory: () => ServiceFactory<TokenManagerService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<TokenManagerService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<TokenManagerService> | undefined) => ServiceMock<TokenManagerService>;
     }
     function identity(): IdentityService;
     namespace identity {
-        const factory: () => ServiceFactory<IdentityService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<IdentityService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<IdentityService> | undefined) => ServiceMock<IdentityService>;
     }
     function auth(options?: {
@@ -436,12 +455,12 @@ declare namespace mockServices {
         disableDefaultAuthPolicy?: boolean;
     }): AuthService;
     namespace auth {
-        const factory: () => ServiceFactory<AuthService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<AuthService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<AuthService> | undefined) => ServiceMock<AuthService>;
     }
     function discovery(): DiscoveryService;
     namespace discovery {
-        const factory: () => ServiceFactory<DiscoveryService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<DiscoveryService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<DiscoveryService> | undefined) => ServiceMock<DiscoveryService>;
     }
     /**
@@ -470,9 +489,9 @@ declare namespace mockServices {
          * the default mock user principal. This behavior can be configured with the
          * `defaultCredentials` option.
          */
-        const factory: (options?: {
-            defaultCredentials?: BackstageCredentials | undefined;
-        } | undefined) => ServiceFactory<HttpAuthService, "plugin">;
+        const factory: ((options?: {
+            defaultCredentials?: BackstageCredentials;
+        }) => ServiceFactory<HttpAuthService, "plugin">) & ServiceFactory<HttpAuthService, "plugin">;
         const mock: (partialImpl?: Partial<HttpAuthService> | undefined) => ServiceMock<HttpAuthService>;
     }
     /**
@@ -490,55 +509,55 @@ declare namespace mockServices {
          * By default it extracts the user's entity ref from a user principal and
          * returns that as the only ownership entity ref.
          */
-        const factory: () => ServiceFactory<UserInfoService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<UserInfoService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<UserInfoService> | undefined) => ServiceMock<UserInfoService>;
     }
     namespace cache {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.CacheService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.CacheService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.CacheService> | undefined) => ServiceMock<_backstage_backend_plugin_api.CacheService>;
     }
     namespace database {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.DatabaseService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.DatabaseService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.DatabaseService> | undefined) => ServiceMock<_backstage_backend_plugin_api.DatabaseService>;
     }
     namespace rootHealth {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.RootHealthService, "root">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.RootHealthService, "root", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootHealthService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootHealthService>;
     }
     namespace httpRouter {
-        const factory: (options?: _backstage_backend_defaults_httpRouter.HttpRouterFactoryOptions | undefined) => ServiceFactory<_backstage_backend_plugin_api.HttpRouterService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.HttpRouterService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.HttpRouterService> | undefined) => ServiceMock<_backstage_backend_plugin_api.HttpRouterService>;
     }
     namespace rootHttpRouter {
-        const factory: (options?: _backstage_backend_defaults_rootHttpRouter.RootHttpRouterFactoryOptions | undefined) => ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root">;
+        const factory: ((options?: _backstage_backend_defaults_rootHttpRouter.RootHttpRouterFactoryOptions | undefined) => ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root">) & ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootHttpRouterService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootHttpRouterService>;
     }
     namespace lifecycle {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.LifecycleService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.LifecycleService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.LifecycleService> | undefined) => ServiceMock<_backstage_backend_plugin_api.LifecycleService>;
     }
     namespace logger {
-        const factory: () => ServiceFactory<LoggerService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<LoggerService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<LoggerService> | undefined) => ServiceMock<LoggerService>;
     }
     namespace permissions {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.PermissionsService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.PermissionsService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.PermissionsService> | undefined) => ServiceMock<_backstage_backend_plugin_api.PermissionsService>;
     }
     namespace rootLifecycle {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.RootLifecycleService, "root">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.RootLifecycleService, "root", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootLifecycleService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootLifecycleService>;
     }
     namespace scheduler {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.SchedulerService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.SchedulerService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.SchedulerService> | undefined) => ServiceMock<_backstage_backend_plugin_api.SchedulerService>;
     }
     namespace urlReader {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.UrlReaderService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.UrlReaderService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.UrlReaderService> | undefined) => ServiceMock<_backstage_backend_plugin_api.UrlReaderService>;
     }
     namespace events {
-        const factory: () => ServiceFactory<_backstage_plugin_events_node.EventsService, "plugin">;
+        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_plugin_events_node.EventsService, "plugin", undefined>;
         const mock: (partialImpl?: Partial<_backstage_plugin_events_node.EventsService> | undefined) => ServiceMock<_backstage_plugin_events_node.EventsService>;
     }
 }
@@ -650,7 +669,4 @@ declare namespace mockCredentials {
     }
 }
 
-/** @public */
-declare function isDockerDisabledForTests(): boolean;
-
-export { type CreateMockDirectoryOptions, type MockDirectory, type MockDirectoryContent, type MockDirectoryContentCallback, type MockDirectoryContentCallbackContext, type MockDirectoryContentOptions, type MockDirectoryOptions, ServiceFactoryTester, type ServiceFactoryTesterOptions, type ServiceMock, type TestBackend, type TestBackendOptions, type TestCacheId, TestCaches, type TestDatabaseId, TestDatabases, createMockDirectory, isDockerDisabledForTests, mockCredentials, mockServices, setupRequestMockHandlers, startTestBackend };
+export { type CreateMockDirectoryOptions, type MockDirectory, type MockDirectoryContent, type MockDirectoryContentCallback, type MockDirectoryContentCallbackContext, type MockDirectoryContentOptions, type MockDirectoryOptions, ServiceFactoryTester, type ServiceFactoryTesterOptions, type ServiceMock, type TestBackend, type TestBackendOptions, type TestCacheId, TestCaches, type TestDatabaseId, TestDatabases, createMockDirectory, isDockerDisabledForTests, mockCredentials, mockServices, registerMswTestHooks, setupRequestMockHandlers, startTestBackend };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-test-utils",
-  "version": "0.4.4-next.1",
+  "version": "0.4.4",
   "description": "Test helpers library for Backstage backends",
   "backstage": {
     "role": "node-library"
@@ -42,13 +42,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-app-api": "^0.7.10-next.1",
-    "@backstage/backend-defaults": "^0.3.4-next.1",
-    "@backstage/backend-plugin-api": "^0.6.22-next.1",
+    "@backstage/backend-app-api": "^0.8.0",
+    "@backstage/backend-defaults": "^0.4.0",
+    "@backstage/backend-plugin-api": "^0.7.0",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.4.17-next.1",
-    "@backstage/plugin-events-node": "^0.3.8-next.1",
+    "@backstage/plugin-auth-node": "^0.4.17",
+    "@backstage/plugin-events-node": "^0.3.8",
     "@backstage/types": "^1.1.1",
     "@keyv/memcache": "^1.3.5",
     "@keyv/redis": "^2.5.3",
@@ -69,7 +69,7 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.11-next.1",
+    "@backstage/cli": "^0.26.11",
     "@types/supertest": "^2.0.8",
     "supertest": "^6.1.3"
   },