From 1d7a40101ac1f44514093ee1683fd71d488c972d Mon Sep 17 00:00:00 2001
From: Dominik Henneke <dominik.henneke@sda-se.com>
Date: Mon, 3 May 2021 16:33:05 +0200
Subject: [PATCH] Update the API reports of backend-common and techdocs-common

Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
---
 packages/backend-common/api-report.md  | 28 ++++++++++++++++++++++----
 packages/techdocs-common/api-report.md | 13 ++++++++----
 2 files changed, 33 insertions(+), 8 deletions(-)

diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index 9969d0ea27..f0cb066dc0 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -65,6 +65,12 @@ export class BitbucketUrlReader implements UrlReader {
 // @public (undocumented)
 export const coloredFormat: winston.Logform.Format;
 
+// @public (undocumented)
+export interface ContainerRunner {
+    // (undocumented)
+    runContainer(opts: RunContainerOptions): Promise<void>;
+}
+
 // @public @deprecated
 export const createDatabase: typeof createDatabaseClient;
 
@@ -80,6 +86,15 @@ export function createServiceBuilder(_module: NodeModule): ServiceBuilderImpl;
 // @public (undocumented)
 export function createStatusCheckRouter(options: StatusCheckRouterOptions): Promise<express.Router>;
 
+// @public (undocumented)
+export class DockerContainerRunner implements ContainerRunner {
+    constructor({ dockerClient }: {
+        dockerClient: Docker;
+    });
+    // (undocumented)
+    runContainer({ imageName, command, args, logStream, mountDirs, workingDir, envVars, }: RunContainerOptions): Promise<void>;
+}
+
 // @public
 export function ensureDatabaseExists(dbConfig: Config, ...databases: Array<string>): Promise<void>;
 
@@ -255,10 +270,15 @@ export function requestLoggingHandler(logger?: Logger): RequestHandler;
 export function resolvePackagePath(name: string, ...paths: string[]): string;
 
 // @public (undocumented)
-export const runDockerContainer: ({ imageName, args, logStream, dockerClient, mountDirs, workingDir, envVars, createOptions, }: RunDockerContainerOptions) => Promise<{
-    error: any;
-    statusCode: any;
-}>;
+export type RunContainerOptions = {
+    imageName: string;
+    command?: string | string[];
+    args: string[];
+    logStream?: Writable;
+    mountDirs?: Record<string, string>;
+    workingDir?: string;
+    envVars?: Record<string, string>;
+};
 
 // @public
 export type SearchResponse = {
diff --git a/packages/techdocs-common/api-report.md b/packages/techdocs-common/api-report.md
index a53fb9e681..3fff030eee 100644
--- a/packages/techdocs-common/api-report.md
+++ b/packages/techdocs-common/api-report.md
@@ -6,7 +6,7 @@
 
 import { AzureIntegrationConfig } from '@backstage/integration';
 import { Config } from '@backstage/config';
-import Docker from 'dockerode';
+import { ContainerRunner } from '@backstage/backend-common';
 import { Entity } from '@backstage/catalog-model';
 import { EntityName } from '@backstage/catalog-model';
 import express from 'express';
@@ -50,8 +50,9 @@ export type GeneratorBuilder = {
 // @public (undocumented)
 export class Generators implements GeneratorBuilder {
     // (undocumented)
-    static fromConfig(config: Config, { logger }: {
+    static fromConfig(config: Config, { logger, containerRunner, }: {
         logger: Logger;
+        containerRunner: ContainerRunner;
     }): Promise<GeneratorBuilder>;
     // (undocumented)
     get(entity: Entity): GeneratorBase;
@@ -151,9 +152,13 @@ export type RemoteProtocol = 'url' | 'dir' | 'github' | 'gitlab' | 'file' | 'azu
 
 // @public (undocumented)
 export class TechdocsGenerator implements GeneratorBase {
-    constructor(logger: Logger, config: Config);
+    constructor({ logger, containerRunner, config, }: {
+        logger: Logger;
+        containerRunner: ContainerRunner;
+        config: Config;
+    });
     // (undocumented)
-    run({ inputDir, outputDir, dockerClient, parsedLocationAnnotation, etag, }: GeneratorRunOptions): Promise<void>;
+    run({ inputDir, outputDir, parsedLocationAnnotation, etag, }: GeneratorRunOptions): Promise<void>;
 }
 
 // @public