@backstage/backend-test-utils 0.4.0-next.2 → 0.4.0-next.3

package/dist/index.d.ts

@@ -9,121 +9,6 @@ import { Backend, ExtendedHttpServer } from '@backstage/backend-app-api';
 import * as _backstage_plugin_events_node from '@backstage/plugin-events-node';
 import { JsonObject } from '@backstage/types';
 
-/**
- * The possible caches to test against.
- *
- * @public
- */
-type TestCacheId = 'MEMORY' | 'REDIS_7' | 'MEMCACHED_1';
-
-/**
- * Encapsulates the creation of ephemeral test cache instances for use inside
- * unit or integration tests.
- *
- * @public
- */
-declare class TestCaches {
-    private readonly instanceById;
-    private readonly supportedIds;
-    private static defaultIds?;
-    /**
-     * Creates an empty `TestCaches` instance, and sets up Jest to clean up all of
-     * its acquired resources after all tests finish.
-     *
-     * You typically want to create just a single instance like this at the top of
-     * your test file or `describe` block, and then call `init` many times on that
-     * instance inside the individual tests. Spinning up a "physical" cache
-     * instance takes a considerable amount of time, slowing down tests. But
-     * wiping the contents of an instance using `init` is very fast.
-     */
-    static create(options?: {
-        ids?: TestCacheId[];
-        disableDocker?: boolean;
-    }): TestCaches;
-    static setDefaults(options: {
-        ids?: TestCacheId[];
-    }): void;
-    private constructor();
-    supports(id: TestCacheId): boolean;
-    eachSupportedId(): [TestCacheId][];
-    /**
-     * Returns a fresh, empty cache for the given driver.
-     *
-     * @param id - The ID of the cache to use, e.g. 'REDIS_7'
-     * @returns Cache connection properties
-     */
-    init(id: TestCacheId): Promise<{
-        store: string;
-        connection: string;
-        keyv: Keyv;
-    }>;
-    private initAny;
-    private initMemcached;
-    private initRedis;
-    private shutdown;
-}
-
-/**
- * The possible databases to test against.
- *
- * @public
- */
-type TestDatabaseId = 'POSTGRES_16' | 'POSTGRES_15' | 'POSTGRES_14' | 'POSTGRES_13' | 'POSTGRES_12' | 'POSTGRES_11' | 'POSTGRES_9' | 'MYSQL_8' | 'SQLITE_3';
-
-/**
- * Encapsulates the creation of ephemeral test database instances for use
- * inside unit or integration tests.
- *
- * @public
- */
-declare class TestDatabases {
-    private readonly engineFactoryByDriver;
-    private readonly engineByTestDatabaseId;
-    private readonly supportedIds;
-    private static defaultIds?;
-    /**
-     * Creates an empty `TestDatabases` instance, and sets up Jest to clean up
-     * all of its acquired resources after all tests finish.
-     *
-     * You typically want to create just a single instance like this at the top
-     * of your test file or `describe` block, and then call `init` many times on
-     * that instance inside the individual tests. Spinning up a "physical"
-     * database instance takes a considerable amount of time, slowing down tests.
-     * But initializing a new logical database inside that instance using `init`
-     * is very fast.
-     */
-    static create(options?: {
-        ids?: TestDatabaseId[];
-        disableDocker?: boolean;
-    }): TestDatabases;
-    static setDefaults(options: {
-        ids?: TestDatabaseId[];
-    }): void;
-    private constructor();
-    supports(id: TestDatabaseId): boolean;
-    eachSupportedId(): [TestDatabaseId][];
-    /**
-     * Returns a fresh, unique, empty logical database on an instance of the
-     * given database ID platform.
-     *
-     * @param id - The ID of the database platform to use, e.g. 'POSTGRES_13'
-     * @returns A `Knex` connection object
-     */
-    init(id: TestDatabaseId): Promise<Knex>;
-    private shutdown;
-}
-
-/**
- * Sets up handlers for request mocking
- * @public
- * @param worker - service worker
- */
-declare function setupRequestMockHandlers(worker: {
-    listen: (t: any) => void;
-    close: () => void;
-    resetHandlers: () => void;
-}): void;
-
 /**
  * A context that allows for more advanced file system operations when writing mock directory content.
  *
@@ -272,7 +157,7 @@ interface MockDirectory {
  *
  * @public
  */
-interface MockDirectoryOptions {
+interface CreateMockDirectoryOptions {
     /**
      * In addition to creating a temporary directory, also mock `os.tmpdir()` to return the
      * mock directory path until the end of the test suite.
@@ -308,7 +193,128 @@ interface MockDirectoryOptions {
  * })
  * ```
  */
-declare function createMockDirectory(options?: MockDirectoryOptions): MockDirectory;
+declare function createMockDirectory(options?: CreateMockDirectoryOptions): MockDirectory;
+
+/**
+ * @public
+ * @deprecated Use `CreateMockDirectoryOptions` from `@backstage/backend-test-utils` instead.
+ */
+type MockDirectoryOptions = CreateMockDirectoryOptions;
+
+/**
+ * The possible caches to test against.
+ *
+ * @public
+ */
+type TestCacheId = 'MEMORY' | 'REDIS_7' | 'MEMCACHED_1';
+
+/**
+ * Encapsulates the creation of ephemeral test cache instances for use inside
+ * unit or integration tests.
+ *
+ * @public
+ */
+declare class TestCaches {
+    private readonly instanceById;
+    private readonly supportedIds;
+    private static defaultIds?;
+    /**
+     * Creates an empty `TestCaches` instance, and sets up Jest to clean up all of
+     * its acquired resources after all tests finish.
+     *
+     * You typically want to create just a single instance like this at the top of
+     * your test file or `describe` block, and then call `init` many times on that
+     * instance inside the individual tests. Spinning up a "physical" cache
+     * instance takes a considerable amount of time, slowing down tests. But
+     * wiping the contents of an instance using `init` is very fast.
+     */
+    static create(options?: {
+        ids?: TestCacheId[];
+        disableDocker?: boolean;
+    }): TestCaches;
+    static setDefaults(options: {
+        ids?: TestCacheId[];
+    }): void;
+    private constructor();
+    supports(id: TestCacheId): boolean;
+    eachSupportedId(): [TestCacheId][];
+    /**
+     * Returns a fresh, empty cache for the given driver.
+     *
+     * @param id - The ID of the cache to use, e.g. 'REDIS_7'
+     * @returns Cache connection properties
+     */
+    init(id: TestCacheId): Promise<{
+        store: string;
+        connection: string;
+        keyv: Keyv;
+    }>;
+    private initAny;
+    private initMemcached;
+    private initRedis;
+    private shutdown;
+}
+
+/**
+ * The possible databases to test against.
+ *
+ * @public
+ */
+type TestDatabaseId = 'POSTGRES_16' | 'POSTGRES_15' | 'POSTGRES_14' | 'POSTGRES_13' | 'POSTGRES_12' | 'POSTGRES_11' | 'POSTGRES_9' | 'MYSQL_8' | 'SQLITE_3';
+
+/**
+ * Encapsulates the creation of ephemeral test database instances for use
+ * inside unit or integration tests.
+ *
+ * @public
+ */
+declare class TestDatabases {
+    private readonly engineFactoryByDriver;
+    private readonly engineByTestDatabaseId;
+    private readonly supportedIds;
+    private static defaultIds?;
+    /**
+     * Creates an empty `TestDatabases` instance, and sets up Jest to clean up
+     * all of its acquired resources after all tests finish.
+     *
+     * You typically want to create just a single instance like this at the top
+     * of your test file or `describe` block, and then call `init` many times on
+     * that instance inside the individual tests. Spinning up a "physical"
+     * database instance takes a considerable amount of time, slowing down tests.
+     * But initializing a new logical database inside that instance using `init`
+     * is very fast.
+     */
+    static create(options?: {
+        ids?: TestDatabaseId[];
+        disableDocker?: boolean;
+    }): TestDatabases;
+    static setDefaults(options: {
+        ids?: TestDatabaseId[];
+    }): void;
+    private constructor();
+    supports(id: TestDatabaseId): boolean;
+    eachSupportedId(): [TestDatabaseId][];
+    /**
+     * Returns a fresh, unique, empty logical database on an instance of the
+     * given database ID platform.
+     *
+     * @param id - The ID of the database platform to use, e.g. 'POSTGRES_13'
+     * @returns A `Knex` connection object
+     */
+    init(id: TestDatabaseId): Promise<Knex>;
+    private shutdown;
+}
+
+/**
+ * Sets up handlers for request mocking
+ * @public
+ * @param worker - service worker
+ */
+declare function setupRequestMockHandlers(worker: {
+    listen: (t: any) => void;
+    close: () => void;
+    resetHandlers: () => void;
+}): void;
 
 /**
  * Options for {@link ServiceFactoryTester}.
@@ -642,4 +648,4 @@ declare namespace mockCredentials {
 /** @public */
 declare function isDockerDisabledForTests(): boolean;
 
-export { 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, setupRequestMockHandlers, startTestBackend };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-test-utils",
-  "version": "0.4.0-next.2",
+  "version": "0.4.0-next.3",
   "description": "Test helpers library for Backstage backends",
   "backstage": {
     "role": "node-library"
@@ -42,12 +42,12 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-app-api": "^0.7.6-next.2",
-    "@backstage/backend-plugin-api": "^0.6.19-next.2",
+    "@backstage/backend-app-api": "^0.7.6-next.3",
+    "@backstage/backend-plugin-api": "^0.6.19-next.3",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.4.14-next.2",
-    "@backstage/plugin-events-node": "^0.3.5-next.1",
+    "@backstage/plugin-auth-node": "^0.4.14-next.3",
+    "@backstage/plugin-events-node": "^0.3.5-next.2",
     "@backstage/types": "^1.1.1",
     "@keyv/memcache": "^1.3.5",
     "@keyv/redis": "^2.5.3",
@@ -68,7 +68,7 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.7-next.2",
+    "@backstage/cli": "^0.26.7-next.3",
     "@types/supertest": "^2.0.8",
     "supertest": "^6.1.3"
   },