Merge pull request #92 from postmanlabs/release/v0.4.0

Release version v0.4.0

Author: VShingala

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [v0.4.0] - 2024-07-10
+
+### Chore
+
+-   Updated postman-collection to v4.4.0.
+
 ## [v0.3.0] - 2024-06-07
 
 ### Fixed
@@ -71,7 +77,9 @@ Newer releases follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0
 
 -   Base release
 
-[Unreleased]: https://github.com/postmanlabs/raml1-to-postman/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/postmanlabs/raml1-to-postman/compare/v0.4.0...HEAD
+
+[v0.4.0]: https://github.com/postmanlabs/raml1-to-postman/compare/v0.3.0...v0.4.0
 
 [v0.3.0]: https://github.com/postmanlabs/raml1-to-postman/compare/v0.2.0...v0.3.0
 

lib/convert.js

@@ -2,7 +2,8 @@ const raml = require('./../assets/raml-1-parser'),
   _ = require('lodash'),
   fs = require('fs'),
   path = require('path-browserify'),
-  SDK = require('postman-collection'),
+  { Collection } = require('postman-collection/lib/collection/collection'),
+  { Variable } = require('postman-collection/lib/collection/variable'),
   helper = require('./helper.js'),
   getOptions = require('./options').getOptions,
   { Node, Trie } = require('./trie.js'),
@@ -167,7 +168,7 @@ var converter = {
         }
       }
 
-      let collection = new SDK.Collection(),
+      let collection = new Collection(),
         content = browser ? fileDataResolver : fileResolver,
         ramlAPI,
         ramlJSON,
@@ -226,7 +227,7 @@ var converter = {
       });
 
       // convrtedBaseUrl is URL containing baseUrl in form of PM collection variable
-      convertedBaseUrl = new SDK.Variable({
+      convertedBaseUrl = new Variable({
         key: 'baseUrl',
         value: '{{baseUrl}}',
         type: 'string'

lib/helper.js

@@ -1,5 +1,15 @@
-const SDK = require('postman-collection'),
-  _ = require('lodash'),
+const _ = require('lodash'),
+  { QueryParam } = require('postman-collection/lib/collection/query-param'),
+  { Header } = require('postman-collection/lib/collection/header'),
+  { ItemGroup } = require('postman-collection/lib/collection/item-group'),
+  { Item } = require('postman-collection/lib/collection/item'),
+  { FormParam } = require('postman-collection/lib/collection/form-param'),
+  { RequestAuth } = require('postman-collection/lib/collection/request-auth'),
+  { Request } = require('postman-collection/lib/collection/request.js'),
+  { Response } = require('postman-collection/lib/collection/response'),
+  { RequestBody } = require('postman-collection/lib/collection/request-body'),
+  { Url } = require('postman-collection/lib/collection/url'),
+  { Variable } = require('postman-collection/lib/collection/variable'),
   schemaFaker = require('../assets/json-schema-faker.js'),
   resolver = require('./resolver.js'),
   Node = require('./trie.js').Node,
@@ -193,7 +203,7 @@ helper = {
   * @returns {Object} convertedHeader - postman sdk header object
   */
   convertHeader: function(header, types, resolveTo) {
-    let convertedHeader = new SDK.Header(),
+    let convertedHeader = new Header(),
       fakedHeader = safeSchemaFaker(header, types, resolveTo);
 
     convertedHeader.key = header.name;
@@ -273,7 +283,7 @@ helper = {
       param,
       paramArray = [],
       updateOptions = {},
-      reqBody = new SDK.RequestBody(),
+      reqBody = new RequestBody(),
       contentHeader,
       rDataMode,
       cType;
@@ -293,7 +303,7 @@ helper = {
 
       // create query parameters and add it to the request body object
       _.forOwn(bodyData, (value, key) => {
-        param = new SDK.QueryParam({
+        param = new QueryParam({
           key: key,
           value: (typeof value === 'object' ? JSON.stringify(value) : value)
         });
@@ -306,7 +316,7 @@ helper = {
       };
 
       // add a content type header for each media type for the request body
-      contentHeader = new SDK.Header({
+      contentHeader = new Header({
         key: 'Content-Type',
         value: URLENCODED
       });
@@ -320,7 +330,7 @@ helper = {
 
       // create the form parameters and add it to the request body object
       _.forOwn(bodyData, (value, key) => {
-        param = new SDK.FormParam({
+        param = new FormParam({
           key: key,
           value: (typeof value === 'object' ? JSON.stringify(value) : value)
         });
@@ -332,7 +342,7 @@ helper = {
         formdata: paramArray
       };
       // add a content type header for the pertaining media type
-      contentHeader = new SDK.Header({
+      contentHeader = new Header({
         key: 'Content-Type',
         value: FORM_DATA
       });
@@ -387,7 +397,7 @@ helper = {
         }
       };
 
-      contentHeader = new SDK.Header({
+      contentHeader = new Header({
         key: 'Content-Type',
         value: bodyType
       });
@@ -463,7 +473,7 @@ helper = {
         responseHeaders.push(contentHeader);
       }
 
-      convertedResponse = new SDK.Response({
+      convertedResponse = new Response({
         name: res.name || res.code,
         code: res.code ? Number(res.code) : 500,
         header: responseHeaders,
@@ -561,7 +571,7 @@ helper = {
   * @returns {Object} auth - postman sdk RequestAuth object
   */
   convertSecurityScheme: function(securedBy, securitySchemes) {
-    let auth = new SDK.RequestAuth();
+    let auth = new RequestAuth();
 
     // map RAML schema security schema and PM request auths. set null by default.
     auth.type = _.get(authTypeMap, _.get(securitySchemes[securedBy], 'type'), null);
@@ -588,14 +598,14 @@ helper = {
       _.forOwn(variablesToAdd, (value, key) => {
         // 'version' is reserved base URI parameter for RAML 1.0, value of it recieved in enum so special handling
         if (key === 'version') {
-          variables.push(new SDK.Variable({
+          variables.push(new Variable({
             id: key,
             value: _.get(value, 'enum[0]', ''),
             description: value.description || 'This is version of API schema.'
           }));
         }
         else {
-          variables.push(new SDK.Variable({
+          variables.push(new Variable({
             id: key,
             value: value.default || _.get(value.enum, '[0]') || '',
             description: value.description + (value.enum ? ' (is one of ' + value.enum + ')' : '')
@@ -606,7 +616,7 @@ helper = {
       });
     }
     if (keyName) {
-      variables.push(new SDK.Variable({
+      variables.push(new Variable({
         id: keyName,
         value: convertedBaseUrl,
         type: 'string'
@@ -629,8 +639,8 @@ helper = {
   * @returns {Object} request - postman sdk request object
   */
   convertToPmRequest: function(method, url, globalParameters, options, pathVariables) {
-    let request = new SDK.Request(),
-      requestUrl = new SDK.Url(),
+    let request = new Request(),
+      requestUrl = new Url(),
       securedBy = method.securedBy || globalParameters.securedBy,
       pmRequestBody;
 
@@ -684,7 +694,7 @@ helper = {
   * @returns {Object} item - postman sdk item object
   */
   convertRequestToItem: function (method, url, globalParameters, options, pathVariables) {
-    let item = new SDK.Item(),
+    let item = new Item(),
       requestName = _.get(method, 'displayName', url.replace('{{baseUrl}}', '')),
       pmRequest = helper.convertToPmRequest(method, url, globalParameters, options, pathVariables),
       optionsForResponse;
@@ -758,7 +768,7 @@ helper = {
   * @returns {Object} folder - postman sdk ItemGroup object
   */
   convertResources: function(baseUrl, res, globalParameters, options, pathVariables = []) {
-    var folder = new SDK.ItemGroup(),
+    var folder = new ItemGroup(),
       url,
       // used to store url after path variables of url is resolved
       convertedBaseUrl = _.cloneDeepWith(baseUrl),
@@ -845,7 +855,7 @@ helper = {
     if (resource.requestCount > 1 || !resource.collapsible) {
       // only return a Postman folder if this folder has>1 children in its subtree or it's not collapsible
       // otherwise we can end up with 10 levels of unwanted folders with 1 request in the end
-      itemGroup = new SDK.ItemGroup({
+      itemGroup = new ItemGroup({
         name: displayName === relativeUrl ? resource.name : displayName,
         description: _.get(resource, 'resourceInfo.description', '')
       });

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "raml1-to-postman",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Converts RAML 1.0 files to postman v2 collection",
   "homepage": "https://github.com/postmanlabs/raml1-to-postman",
   "bugs": "https://github.com/postmanlabs/raml1-to-postman/issues",
@@ -43,7 +43,7 @@
     "async": "3.2.5",
     "lodash": "4.17.21",
     "path-browserify": "1.0.1",
-    "postman-collection": "4.2.1"
+    "postman-collection": "^4.4.0"
   },
   "devDependencies": {
     "chai": "4.1.2",

package.json

@@ -44,12 +44,10 @@ describe('project repository', function () {
         expect(json.dependencies).to.be.a('object');
       });
 
-      it('must point to a valid and precise (no * or ^) semver', function () {
-        for (let item in json.dependencies) {
-          expect(json.dependencies[item]).to.match(new RegExp('^((\\d+)\\.(\\d+)\\.(\\d+))(?:-' +
-          // eslint-disable-next-line max-len
-            '([\\dA-Za-z\\-]+(?:\\.[\\dA-Za-z\\-]+)*))?(?:\\+([\\dA-Za-z\\-]+(?:\\.[\\dA-Za-z\\-]+)*))?$|^git\+.*.+$'));
-        }
+      it('should have a valid version string in form of <major>.<minor>.<revision>', function () {
+        expect(json.version)
+          // eslint-disable-next-line max-len, security/detect-unsafe-regex
+          .to.match(/^((\d+)\.(\d+)\.(\d+))(?:-([\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*))?(?:\+([\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*))?$/);
       });
     });
 
@@ -58,12 +56,12 @@ describe('project repository', function () {
         expect(json.devDependencies).to.be.a('object');
       });
 
-      it('must point to a valid and precise (no * or ^) semver', function () {
-        for (let item in json.devDependencies) {
-          expect(json.devDependencies[item]).to.match(new RegExp('^((\\d+)\\.(\\d+)\\.(\\d+))(?:-' +
-          // eslint-disable-next-line max-len
-            '([\\dA-Za-z\\-]+(?:\\.[\\dA-Za-z\\-]+)*))?(?:\\+([\\dA-Za-z\\-]+(?:\\.[\\dA-Za-z\\-]+)*))?$|^git\+.*.+$'));
-        }
+      it('should point to a valid semver', function () {
+        Object.keys(json.devDependencies).forEach(function (dependencyName) {
+          // eslint-disable-next-line security/detect-non-literal-regexp
+          expect(json.devDependencies[dependencyName]).to.match(new RegExp('((\\d+)\\.(\\d+)\\.(\\d+))(?:-' +
+            '([\\dA-Za-z\\-]+(?:\\.[\\dA-Za-z\\-]+)*))?(?:\\+([\\dA-Za-z\\-]+(?:\\.[\\dA-Za-z\\-]+)*))?$'));
+        });
       });
     });
 

test/system/repository.test.js

@@ -2,7 +2,8 @@ const expect = require('chai').expect,
   fs = require('fs'),
   converter = require('../../index'),
   helper = require('./../../lib/helper.js'),
-  SDK = require('postman-collection'),
+  { Collection } = require('postman-collection/lib/collection/collection'),
+  { Header } = require('postman-collection/lib/collection/header'),
   VALID_RAML_DIR_PATH = './test/fixtures/valid-raml',
   INVALID_VERSION_PATH = './test/fixtures/invalid-raml/invalidVersion.raml';
 
@@ -126,7 +127,7 @@ describe('helper functions', function() {
         description: 'This is the description.',
         version: '1.1'
       },
-      collection = new SDK.Collection(),
+      collection = new Collection(),
       modified_collection = helper.setCollectionInfo(info, collection);
 
     expect(modified_collection.name).to.equal('My sample api');
@@ -252,7 +253,7 @@ describe('helper functions', function() {
       types = {},
       postmanHeader = helper.convertHeader(ramlHeader, types, 'schema');
 
-    expect(SDK.Header.isHeader(postmanHeader)).to.be.true;
+    expect(Header.isHeader(postmanHeader)).to.be.true;
     expect(postmanHeader.disabled).to.be.true;
   });