Add type to define the contents of exchange.json

Author: vcua-mobify

src/download/exchangeTypes.ts

@@ -45,3 +45,22 @@ export type RawRestApi = Omit<RestApi, "categories" | "fatRaml"> & {
     version: string;
   }[];
 };
+
+export type ExchangeConfig = {
+  dependencies?: {
+    version: string;
+    assetId: string;
+    groupId: string;
+  }[];
+  version: string;
+  originalFormatVersion: string;
+  apiVersion: string;
+  descriptorVersion: string;
+  classifier: string;
+  main: string;
+  assetId: string;
+  groupId: string;
+  organizationId: string;
+  name: string;
+  tags: string[];
+};

src/download/index.ts

@@ -9,4 +9,4 @@ export { extractFiles } from "./exchangeDirectoryParser";
 export { groupByCategory, removeRamlLinks } from "./exchangeTools";
 export { DownloadCommand } from "./downloadCommand";
 export { getBearer } from "./bearerToken";
-export { RestApi } from "./exchangeTypes";
+export { RestApi, ExchangeConfig } from "./exchangeTypes";

src/generate/apiModel.ts

@@ -13,7 +13,7 @@ import {
 } from "../common/amfParser";
 
 import { Name } from "../common/structures/name";
-import { RestApi } from "../download/exchangeTypes";
+import { ExchangeConfig, RestApi } from "../download/exchangeTypes";
 import path from "path";
 import fs from "fs-extra";
 import { ramlToolLogger } from "../common/logger";
@@ -56,7 +56,7 @@ export class ApiModel extends ApiMetadata {
       fs.lstatSync(filepath).isDirectory() &&
       fs.existsSync(path.join(filepath, "exchange.json"))
     ) {
-      const exchangeConfig = fs.readJSONSync(
+      const exchangeConfig: ExchangeConfig = fs.readJSONSync(
         path.join(filepath, "exchange.json")
       );