chore: Update npm dependencies, generate sample code for all languages and variants in OpenAPIHelper, and refactor OpenAPIHelper to use JavaScript

Author: sumansaurabh

.github/workflows/publish.yaml

@@ -0,0 +1,37 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '14'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Lint and Test
+      run: |
+        npm run lint
+        npm run test
+
+    - name: Publish to npm
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+    - name: Publish to Yarn
+      run: yarn publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

__tests__/OpenAPIHelper.test.js

@@ -0,0 +1,78 @@
+// __tests__/OpenAPIHelper.test.js
+
+const fs = require('fs');
+const { execSync } = require('child_process');
+const OpenAPIHelper = require('../src/OpenAPIHelper');
+
+jest.mock('fs');
+jest.mock('child_process');
+
+describe('OpenAPIHelper', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('convertOpenAPIToPostman', () => {
+    it('should call execSync with the correct command', () => {
+      const openAPIPath = 'openapi.json';
+      const postmanOutputPath = '/tmp/openapi_schema_postman.json';
+
+      OpenAPIHelper.convertOpenAPIToPostman(openAPIPath, postmanOutputPath);
+
+      expect(execSync).toHaveBeenCalledWith(
+        `openapi2postmanv2 -s ${openAPIPath} -o ${postmanOutputPath}`,
+        { stdio: 'inherit' }
+      );
+    });
+  });
+
+  describe('generateSampleCode', () => {
+    it('should generate code for all languages and variants if no specific language and variant are provided', () => {
+      const postmanCollectionPath = '/tmp/postman_collection.json';
+      const collection = {
+        item: [
+          {
+            request: {
+              name: 'Get Users',
+              method: 'GET',
+              url: { path: ['api', 'v1', 'users'] }
+            }
+          }
+        ]
+      };
+
+      fs.readFileSync.mockReturnValue(JSON.stringify(collection));
+      fs.existsSync.mockReturnValue(false);
+      fs.mkdirSync.mockReturnValue();
+
+      OpenAPIHelper.generateSampleCode(postmanCollectionPath);
+
+      expect(fs.readFileSync).toHaveBeenCalledWith(postmanCollectionPath);
+      expect(fs.mkdirSync).toHaveBeenCalledWith('/tmp/sample_code');
+      expect(fs.writeFileSync).toHaveBeenCalled();
+    });
+
+    it('should generate code for specific language and variant if provided', () => {
+      const postmanCollectionPath = '/tmp/postman_collection.json';
+      const collection = {
+        item: [
+          {
+            request: {
+              name: 'Get Users',
+              method: 'GET',
+              url: { path: ['api', 'v1', 'users'] }
+            }
+          }
+        ]
+      };
+
+      fs.readFileSync.mockReturnValue(JSON.stringify(collection));
+      fs.existsSync.mockReturnValue(true);
+
+      OpenAPIHelper.generateSampleCode(postmanCollectionPath, 'nodejs', 'axios');
+
+      expect(fs.readFileSync).toHaveBeenCalledWith(postmanCollectionPath);
+      expect(fs.writeFileSync).toHaveBeenCalled();
+    });
+  });
+});

eslint.config.js

@@ -0,0 +1,8 @@
+module.exports = [
+    {
+        rules: {
+            semi: "error",
+            "prefer-const": "error"
+        }
+    }
+];

package.json

@@ -4,7 +4,10 @@
   "description": "A JavaScript library to convert OpenAPI schema to Postman collection and generate sample code.",
   "main": "src/index.js",
   "scripts": {
-    "start": "node src/index.js"
+    "start": "node src/index.js",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "jest"
   },
   "bin": {
     "openapi-code-gen": "src/index.js"
@@ -13,11 +16,15 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "openapi-to-postmanv2": "^4.21.0",
+    "openapi-to-postmanv2": "4.21.0",
     "postman-code-generators": "1.10.1",
     "postman-collection": "^4.4.0"
   },
   "devDependencies": {
+    "@eslint/js": "^9.4.0",
+    "eslint": "^9.4.0",
+    "globals": "^15.4.0",
+    "jest": "^29.7.0",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {

src/index.js

@@ -23,7 +23,7 @@ const outputAPIPath = path.resolve(`${file_name}_with_code.json`);
 console.log("Executing step 1.");
 OpenAPIHelper.convertOpenAPIToPostman(resolvedOpenAPIPath, postmanOutputPath);
 console.log("Executing step 2.");
-OpenAPIHelper.generateSampleCode(postmanOutputPath);
+OpenAPIHelper.generateSampleCode(postmanOutputPath, language, variant);
 console.log("Executing step 3.");
 OpenAPIHelper.addSampleCodeToOpenAPI(resolvedOpenAPIPath, outputAPIPath);