Add ts support

.eslintrc

@@ -2,7 +2,6 @@
   "parserOptions": {
     "ecmaVersion": 2017
   },
-
   "plugins": [
       "security",
       "jsdoc",
@@ -13,6 +12,25 @@
       "node": true,
       "es6": true
   },
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "ecmaVersion": 2020,
+        "sourceType": "module",
+        "project": "./tsconfig.json"
+      },
+      "plugins": ["@typescript-eslint"],
+      "rules": {
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": "error",
+        "no-use-before-define": "off",
+        "require-jsdoc": "warn",
+        "valid-jsdoc": "warn"
+      }
+    }
+  ],
   "rules": {
       // Possible Errors
       "comma-dangle": ["error", "never"],

.gitignore

@@ -43,4 +43,7 @@ test/data/.temp
 
 # Prevent unit test coverage reports from being added
 .coverage
-.nyc_output
+.nyc_output
+
+# TypeScript build output
+dist

bin/openapi2postmanv2.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 var _ = require('lodash'),
   program = require('commander'),
-  Converter = require('../index.js'),
+  Converter = require('../dist/index.js'),
   fs = require('fs'),
   path = require('path'),
   availableOptions = require('../lib/options').getOptions('use', { usage: ['CONVERSION'] }),

index.ts

@@ -0,0 +1,96 @@
+'use strict';
+
+import _ from 'lodash';
+import type {
+  SpecInput,
+  FolderInput,
+  MultiFileSpecInput,
+  Options,
+  ValidationResult,
+  ConversionCallback,
+  MetadataCallback,
+  MergeAndValidateCallback,
+  OptionsCriteria,
+  OptionDefinition,
+  OptionsUseMode,
+  RootFiles,
+  RelatedFiles,
+  BundledContent
+} from './types';
+
+const { MODULE_VERSION } = require('../lib/schemapack.js');
+const SchemaPack = require('../lib/schemapack.js').SchemaPack;
+const UserError = require('../lib/common/UserError');
+
+const DEFAULT_INVALID_ERROR = 'Provided definition is invalid';
+
+module.exports = {
+  // Old API wrapping the new API
+
+  convert: function(input: SpecInput, options: Options, cb: ConversionCallback): void {
+    var schema = new SchemaPack(input, options);
+
+    if (schema.validated) {
+      return schema.convert(cb);
+    }
+    return cb(new UserError(_.get(schema, 'validationResult.reason', DEFAULT_INVALID_ERROR)));
+  },
+
+  convertV2: function(input: SpecInput, options: Options, cb: ConversionCallback): void {
+    var schema = new SchemaPack(input, options, MODULE_VERSION.V2);
+
+    if (schema.validated) {
+      return schema.convertV2(cb);
+    }
+
+    return cb(new UserError(_.get(schema, 'validationResult.reason', DEFAULT_INVALID_ERROR)));
+  },
+
+  convertV2WithTypes: function(input: SpecInput, options: Options, cb: ConversionCallback): void {
+    const enableTypeFetching = true;
+    var schema = new SchemaPack(input, options, MODULE_VERSION.V2, enableTypeFetching);
+
+    if (schema.validated) {
+      return schema.convertV2(cb);
+    }
+
+    return cb(new UserError(_.get(schema, 'validationResult.reason', DEFAULT_INVALID_ERROR)));
+  },
+
+  validate: function (input: SpecInput): ValidationResult {
+    var schema = new SchemaPack(input);
+    return schema.validationResult;
+  },
+
+  getMetaData: function (input: SpecInput | FolderInput, cb: MetadataCallback): void {
+    var schema = new SchemaPack(input);
+    schema.getMetaData(cb);
+  },
+
+  mergeAndValidate: function (input: FolderInput, cb: MergeAndValidateCallback): void {
+    var schema = new SchemaPack(input);
+    schema.mergeAndValidate(cb);
+  },
+
+  getOptions: function(mode?: string, criteria?: OptionsCriteria): OptionDefinition[] | OptionsUseMode {
+    return SchemaPack.getOptions(mode, criteria);
+  },
+
+  detectRootFiles: async function(input: MultiFileSpecInput): Promise<RootFiles> {
+    var schema = new SchemaPack(input);
+    return schema.detectRootFiles();
+  },
+
+  detectRelatedFiles: async function(input: MultiFileSpecInput): Promise<RelatedFiles> {
+    var schema = new SchemaPack(input);
+    return schema.detectRelatedFiles();
+  },
+
+  bundle: async function(input: MultiFileSpecInput & { options?: Options }): Promise<BundledContent> {
+    var schema = new SchemaPack(input, input.options ?? {});
+    return schema.bundle();
+  },
+
+  // new API
+  SchemaPack
+};

lib/schemaUtils.js

@@ -779,7 +779,7 @@ module.exports = {
             schemaCache,
             variableStore,
             true
-          ),
+          )
         );
       }
     }

libV2/schemaUtils.js → libV2/CollectionGeneration/schemaUtils.js

@@ -1,12 +1,12 @@
-const generateAuthForCollectionFromOpenAPI = require('./helpers/collection/generateAuthForCollectionFromOpenAPI');
-const utils = require('./utils');
+const generateAuthForCollectionFromOpenAPI = require('./helpers/collection/generateAuthForCollectionFromOpenAPI.js');
+const utils = require('./utils.js');
 
-const schemaFaker = require('../assets/json-schema-faker'),
+const schemaFaker = require('../../assets/json-schema-faker.js'),
   _ = require('lodash'),
   mergeAllOf = require('json-schema-merge-allof'),
-  xmlFaker = require('./xmlSchemaFaker.js'),
+  xmlFaker = require('../xmlSchemaFaker.js'),
   URLENCODED = 'application/x-www-form-urlencoded',
-  { DEFAULT_RESPONSE_CODE_IN_OAS } = require('../lib/common/schemaUtilsCommon.js'),
+  { DEFAULT_RESPONSE_CODE_IN_OAS } = require('../../lib/common/schemaUtilsCommon.js'),
   APP_JSON = 'application/json',
   APP_JS = 'application/javascript',
   TEXT_XML = 'text/xml',
@@ -895,6 +895,7 @@ let QUERYPARAM = 'query',
           else if (propValue.properties) {
             let processedProperties = processSchema(propValue);
             propertyDetails.properties = processedProperties.properties;
+            // eslint-disable-next-line max-depth
             if (processedProperties.required) {
               propertyDetails.required = processedProperties.required;
             }

libV2/validationUtils.js → libV2/CollectionGeneration/validationUtils.js

@@ -8,23 +8,23 @@ const _ = require('lodash'),
   { Variable } = require('postman-collection/lib/collection/variable'),
   async = require('async'),
   crypto = require('crypto'),
-  schemaFaker = require('../assets/json-schema-faker.js'),
-  xmlFaker = require('./xmlSchemaFaker.js'),
-  utils = require('./utils'),
+  schemaFaker = require('../../assets/json-schema-faker.js'),
+  xmlFaker = require('../xmlSchemaFaker.js'),
+  utils = require('./utils.js'),
   {
     resolveSchema,
     resolveRefFromSchema,
     resolvePostmanRequest,
     resolveResponseForPostmanRequest
-  } = require('./schemaUtils'),
-  concreteUtils = require('../lib/30XUtils/schemaUtils30X'),
+  } = require('./schemaUtils.js'),
+  concreteUtils = require('../../lib/30XUtils/schemaUtils30X.js'),
 
-  ajvValidationError = require('../lib/ajValidation/ajvValidationError'),
-  { validateSchema } = require('../lib/ajValidation/ajvValidation'),
+  ajvValidationError = require('../../lib/ajValidation/ajvValidationError.js'),
+  { validateSchema } = require('../../lib/ajValidation/ajvValidation.js'),
   { formatDataPath, checkIsCorrectType, isKnownType,
-    getServersPathVars, DEFAULT_RESPONSE_CODE_IN_OAS } = require('../lib/common/schemaUtilsCommon.js'),
+    getServersPathVars, DEFAULT_RESPONSE_CODE_IN_OAS } = require('../../lib/common/schemaUtilsCommon.js'),
 
-  { findMatchingRequestFromSchema, isPmVariable } = require('./requestMatchingUtils'),
+  { findMatchingRequestFromSchema, isPmVariable } = require('./requestMatchingUtils.js'),
 
   // common global constants
   SCHEMA_FORMATS = {

libV2/index.js

@@ -1,9 +1,11 @@
 const _ = require('lodash'),
   { Collection } = require('postman-collection/lib/collection/collection'),
   GraphLib = require('graphlib'),
-  generateSkeletonTreeFromOpenAPI = require('./helpers/collection/generateSkeletionTreeFromOpenAPI'),
-  generateCollectionFromOpenAPI = require('./helpers/collection/generateCollectionFromOpenAPI'),
-  generateFolderFromOpenAPI = require('./helpers/folder/generateFolderForOpenAPI'),
+  generateSkeletonTreeFromOpenAPI =
+    require('./CollectionGeneration/helpers/collection/generateSkeletionTreeFromOpenAPI'),
+  generateCollectionFromOpenAPI =
+    require('./CollectionGeneration/helpers/collection/generateCollectionFromOpenAPI'),
+  generateFolderFromOpenAPI = require('./CollectionGeneration/helpers/folder/generateFolderForOpenAPI'),
 
   Ajv = require('ajv'),
   addFormats = require('ajv-formats'),
@@ -12,10 +14,10 @@ const _ = require('lodash'),
 
   // All V1 interfaces used
   OpenApiErr = require('../lib/error'),
-  { validateTransaction, getMissingSchemaEndpoints } = require('./validationUtils');
+  { validateTransaction, getMissingSchemaEndpoints } = require('./CollectionGeneration/validationUtils');
 
-const { resolvePostmanRequest, resolveRefFromSchema } = require('./schemaUtils');
-const { generateRequestItemObject, fixPathVariablesInUrl } = require('./utils');
+const { resolvePostmanRequest, resolveRefFromSchema } = require('./CollectionGeneration/schemaUtils');
+const { generateRequestItemObject, fixPathVariablesInUrl } = require('./CollectionGeneration/utils');
 
 module.exports = {
   convertV2: function (context, cb) {