chore: adding some types

to slightly clarify the API between this library and its users, add a bit of types where easy.
many of the types I've added rely on some "any"s because I'm trying to provide some initial value to make future work easier.

a single place uses the non-null assertion operator: apparently there's an open bug in typescript where Promise.all() wrongly adds " | undefined"
microsoft/TypeScript#33752
we'll try to keep an eye open here to see when it can be removed.

Author: Shesekino

lib/index.ts

@@ -5,7 +5,7 @@ import { Docker, DockerOptions } from "./docker";
 import * as dockerFile from "./docker-file";
 import { getRuntime } from "./inputs/runtime/docker";
 import { buildResponse } from "./response-builder";
-import { StaticAnalysisOptions } from "./types";
+import { ManifestFile, PluginResponse, StaticAnalysisOptions } from "./types";
 
 export { inspect, dockerFile };
 
@@ -35,7 +35,7 @@ async function analyzeDynamically(
   targetImage: string,
   dockerfileAnalysis: dockerFile.DockerFileAnalysis | undefined,
   analysisOptions: any,
-) {
+): Promise<PluginResponse> {
   const [runtime, dependencies, manifestFiles] = await Promise.all([
     getRuntime(analysisOptions),
     getDependencies(targetImage, dockerfileAnalysis, analysisOptions),
@@ -46,12 +46,15 @@ async function analyzeDynamically(
     runtime,
     dependencies,
     dockerfileAnalysis,
-    manifestFiles,
+    manifestFiles!, // bug in typescript wrongly adds `undefined`
     analysisOptions,
   );
 }
 
-async function analyzeStatically(targetImage: string, options: any) {
+async function analyzeStatically(
+  targetImage: string,
+  options: any,
+): Promise<PluginResponse> {
   const staticAnalysisOptions = getStaticAnalysisOptions(options);
 
   // Relevant only if using a Docker runtime. Optional, but we may consider what to put here
@@ -218,7 +221,10 @@ function getDependencies(
     });
 }
 
-async function getManifestFiles(targetImage: string, options?: any) {
+async function getManifestFiles(
+  targetImage: string,
+  options?: any,
+): Promise<ManifestFile[]> {
   if (!options.manifestGlobs) {
     return [];
   }

lib/response-builder.ts

@@ -2,16 +2,17 @@
 // analyses' are done.
 
 import { DockerFilePackages, instructionDigest } from "./instruction-parser";
+import * as types from "./types";
 
 export { buildResponse };
 
 function buildResponse(
-  runtime,
+  runtime: string | undefined,
   depsAnalysis,
   dockerfileAnalysis,
-  manifestFiles,
+  manifestFiles: types.ManifestFile[],
   options,
-) {
+): types.PluginResponse {
   const deps = depsAnalysis.package.dependencies;
   const dockerfilePkgs = collectDockerfilePkgs(dockerfileAnalysis, deps);
   const finalDeps = excludeBaseImageDeps(deps, dockerfilePkgs, options);
@@ -31,7 +32,10 @@ function buildResponse(
   };
 }
 
-function pluginMetadataRes(runtime, depsAnalysis) {
+function pluginMetadataRes(
+  runtime: string | undefined,
+  depsAnalysis,
+): types.PluginMetadata {
   return {
     name: "snyk-docker-plugin",
     runtime,

lib/types.ts

@@ -21,3 +21,23 @@ export enum OsReleaseFilePath {
   RedHat = "/etc/redhat-release",
   Oracle = "/etc/oracle-release",
 }
+
+export interface ManifestFile {
+  name: string;
+  path: string;
+  contents: string;
+}
+
+export interface PluginMetadata {
+  name: string;
+  runtime: string | undefined;
+  packageManager: any;
+  dockerImageId: any;
+  imageLayers: any;
+}
+
+export interface PluginResponse {
+  plugin: PluginMetadata;
+  package: any;
+  manifestFiles: ManifestFile[];
+}