postman-runtime 7.28.3 → 7.29.1

package/lib/authorizer/apikey.js

@@ -16,6 +16,7 @@ var _ = require('lodash'),
  *     privateKey: 'string',
  *     privateValue: 'string'
  * }
+ *
  * @implements {AuthHandlerInterface}
  */
 module.exports = {
@@ -43,9 +44,9 @@ module.exports = {
      * Initializes an item (extracts parameters from intermediate requests if any, etc)
      * before the actual authorization step
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authInitHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authInitHookCallback} done -
      */
     init: function (auth, response, done) {
         done();
@@ -54,8 +55,8 @@ module.exports = {
     /**
      * Verifies whether the request has required parameters
      *
-     * @param {AuthInterface} auth
-     * @param {AuthHandlerInterface~authPreHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {AuthHandlerInterface~authPreHookCallback} done -
      */
     pre: function (auth, done) {
         return done(null, Boolean(auth.get('key') || auth.get('value')));
@@ -64,9 +65,9 @@ module.exports = {
     /**
      * Verifies whether the auth succeeded
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authPostHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authPostHookCallback} done -
      */
     post: function (auth, response, done) {
         done(null, true);
@@ -75,9 +76,9 @@ module.exports = {
     /**
      * Signs the request
      *
-     * @param {AuthInterface} auth
-     * @param {Request} request
-     * @param {AuthHandlerInterface~authSignHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Request} request -
+     * @param {AuthHandlerInterface~authSignHookCallback} done -
      */
     sign: function (auth, request, done) {
         var target = TARGETS[auth.get('in')] || TARGETS.header,

package/lib/authorizer/auth-interface.js

@@ -6,7 +6,7 @@ var _ = require('lodash'),
  * Creates a wrapper around RequestAuth and provides getters and setters helper functions
  *
  * @constructs AuthInterface
- * @param {RequestAuth} auth
+ * @param {RequestAuth} auth -
  * @param {Object} protocolProfileBehavior - Protocol profile behaviors
  * @return {AuthInterface}
  * @throws {Error}
@@ -24,7 +24,7 @@ createAuthInterface = function (auth, protocolProfileBehavior) {
         _protocolProfileBehavior: protocolProfileBehavior || {},
 
         /**
-         * @param {String|Array<String>} keys
+         * @param {String|Array<String>} keys -
          * @return {*} Returns a value for a key or an object having all keys & values depending on the input
          * @example
          * get('foo') // bar
@@ -51,8 +51,8 @@ createAuthInterface = function (auth, protocolProfileBehavior) {
         },
 
         /**
-         * @param {String|Object} key
-         * @param {*} [value]
+         * @param {String|Object} key -
+         * @param {*} [value] -
          * @return {AuthInterface}
          * @example
          * set('foo', 'bar')
@@ -78,12 +78,12 @@ createAuthInterface = function (auth, protocolProfileBehavior) {
                 var param = parameters.one(key);
 
                 if (!param) {
-                    return parameters.add({key: key, value: value, system: true});
+                    return parameters.add({ key: key, value: value, system: true });
                 }
 
                 // Update if the param is a system property or an empty user property (null, undefined or empty string)
                 if (param.system || param.value === EMPTY || _.isNil(param.value) || _.isNaN(param.value)) {
-                    return param.update({key: key, value: value, system: true});
+                    return param.update({ key: key, value: value, system: true });
                 }
             });
 

package/lib/authorizer/aws4.js

@@ -15,10 +15,10 @@ var _ = require('lodash'),
      *
      * @todo This function can also be used in Digest auth so that it works correctly for urlencoded and file body types
      *
-     * @param {RequestBody} body
-     * @param {String} algorithm
-     * @param {String} digestEncoding
-     * @param {Function} callback
+     * @param {RequestBody} body -
+     * @param {String} algorithm -
+     * @param {String} digestEncoding -
+     * @param {Function} callback -
      */
     computeBodyHash = function (body, algorithm, digestEncoding, callback) {
         if (!(body && algorithm && digestEncoding) || body.isEmpty()) { return callback(); }
@@ -146,9 +146,9 @@ module.exports = {
     /**
      * Initializes a item (fetches all required parameters, etc) before the actual authorization step.
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authInitHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authInitHookCallback} done -
      */
     init: function (auth, response, done) {
         done(null);
@@ -157,8 +157,8 @@ module.exports = {
     /**
      * Checks the item, and fetches any parameters that are not already provided.
      *
-     * @param {AuthInterface} auth
-     * @param {AuthHandlerInterface~authPreHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {AuthHandlerInterface~authPreHookCallback} done -
      */
     pre: function (auth, done) {
         done(null, true);
@@ -167,9 +167,9 @@ module.exports = {
     /**
      * Verifies whether the request was successful after being sent.
      *
-     * @param {AuthInterface} auth
-     * @param {Requester} response
-     * @param {AuthHandlerInterface~authPostHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Requester} response -
+     * @param {AuthHandlerInterface~authPostHookCallback} done -
      */
     post: function (auth, response, done) {
         done(null, true);
@@ -216,9 +216,9 @@ module.exports = {
     /**
      * Signs a request.
      *
-     * @param {AuthInterface} auth
-     * @param {Request} request
-     * @param {AuthHandlerInterface~authSignHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Request} request -
+     * @param {AuthHandlerInterface~authSignHookCallback} done -
      */
     sign: function (auth, request, done) {
         var self = this,
@@ -234,10 +234,10 @@ module.exports = {
             dataToSign;
 
         // Clean up the request (if needed)
-        request.removeHeader('Authorization', {ignoreCase: true});
-        request.removeHeader('X-Amz-Date', {ignoreCase: true});
-        request.removeHeader('X-Amz-Security-Token', {ignoreCase: true});
-        request.removeHeader('X-Amz-Content-Sha256', {ignoreCase: true});
+        request.removeHeader('Authorization', { ignoreCase: true });
+        request.removeHeader('X-Amz-Date', { ignoreCase: true });
+        request.removeHeader('X-Amz-Security-Token', { ignoreCase: true });
+        request.removeHeader('X-Amz-Content-Sha256', { ignoreCase: true });
 
         // Not removing `X-Amz-Expires` from params here allowing user to override
         // default value
@@ -262,7 +262,7 @@ module.exports = {
             region: params.region || 'us-east-1',
             method: request.method,
             body: undefined, // no need to give body since we are setting 'X-Amz-Content-Sha256' header
-            headers: _.transform(request.getHeaders({enabled: true}), function (accumulator, value, key) {
+            headers: _.transform(request.getHeaders({ enabled: true }), function (accumulator, value, key) {
                 accumulator[key] = value;
             }, {}),
             signQuery: params.addAuthDataToQuery

package/lib/authorizer/basic.js

@@ -22,9 +22,9 @@ module.exports = {
      * Initializes an item (extracts parameters from intermediate requests if any, etc)
      * before the actual authorization step.
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authInitHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authInitHookCallback} done -
      */
     init: function (auth, response, done) {
         done(null);
@@ -36,8 +36,8 @@ module.exports = {
      *
      * @todo - add support for prompting a user for basic auth credentials if not already provided
      *
-     * @param {AuthInterface} auth
-     * @param {AuthHandlerInterface~authPreHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {AuthHandlerInterface~authPreHookCallback} done -
      */
     pre: function (auth, done) {
         done(null, true);
@@ -46,9 +46,9 @@ module.exports = {
     /**
      * Verifies whether the basic auth succeeded.
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authPostHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authPostHookCallback} done -
      */
     post: function (auth, response, done) {
         done(null, true);
@@ -57,15 +57,15 @@ module.exports = {
     /**
      * Signs a request.
      *
-     * @param {AuthInterface} auth
-     * @param {Request} request
-     * @param {AuthHandlerInterface~authSignHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Request} request -
+     * @param {AuthHandlerInterface~authSignHookCallback} done -
      */
     sign: function (auth, request, done) {
         var username = auth.get('username') || '',
             password = auth.get('password') || '';
 
-        request.removeHeader('Authorization', {ignoreCase: true});
+        request.removeHeader('Authorization', { ignoreCase: true });
         request.addHeader({
             key: 'Authorization',
             value: 'Basic ' + Buffer.from(`${username}:${password}`, 'utf8').toString('base64'),

package/lib/authorizer/bearer.js

@@ -25,9 +25,9 @@ module.exports = {
      * Initializes an item (extracts parameters from intermediate requests if any, etc)
      * before the actual authorization step
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authInitHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authInitHookCallback} done -
      */
     init: function (auth, response, done) {
         done();
@@ -36,8 +36,8 @@ module.exports = {
     /**
      * Verifies whether the request has required parameters
      *
-     * @param {AuthInterface} auth
-     * @param {AuthHandlerInterface~authPreHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {AuthHandlerInterface~authPreHookCallback} done -
      */
     pre: function (auth, done) {
         return done(null, Boolean(auth.get('token')));
@@ -46,9 +46,9 @@ module.exports = {
     /**
      * Verifies whether the auth succeeded
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authPostHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authPostHookCallback} done -
      */
     post: function (auth, response, done) {
         done(null, true);
@@ -57,9 +57,9 @@ module.exports = {
     /**
      * Signs the request
      *
-     * @param {AuthInterface} auth
-     * @param {Request} request
-     * @param {AuthHandlerInterface~authSignHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Request} request -
+     * @param {AuthHandlerInterface~authSignHookCallback} done -
      */
     sign: function (auth, request, done) {
         var token = auth.get('token');
@@ -71,7 +71,7 @@ module.exports = {
         // @TODO Should we support adding to query params and/or body also?
         // According to the RFC#6750 they are supported but not recommended!
 
-        request.removeHeader('Authorization', {ignoreCase: true});
+        request.removeHeader('Authorization', { ignoreCase: true });
         request.addHeader({
             key: 'Authorization',
             value: BEARER_AUTH_PREFIX + token,

package/lib/authorizer/digest.js

@@ -73,20 +73,20 @@ if (!_.includes(crypto.getHashes(), 'sha512-256')) {
     };
 
     _.assign(crypto.prototype, {
-        update: function (data) {
+        update (data) {
             this._hash.update(data);
 
             return this;
         },
 
-        digest: function () {
+        digest () {
             // we only need 'hex' digest for this auth
             return this._hash.hex();
         }
     });
 
     _.assign(crypto, {
-        createHash: function (hashAlgo) {
+        createHash (hashAlgo) {
             // return hash from js-sha for SHA512-256
             if (hashAlgo === 'sha512-256') {
                 return new crypto();
@@ -102,7 +102,7 @@ if (!_.includes(crypto.getHashes(), 'sha512-256')) {
  * Generates a random string of given length
  *
  * @todo Move this to util.js. After moving use that for hawk auth too
- * @param {Number} length
+ * @param {Number} length -
  */
 function randomString (length) {
     length = length || 6;
@@ -121,8 +121,8 @@ function randomString (length) {
 /**
  * Extracts a Digest Auth field from a WWW-Authenticate header value using a given regexp.
  *
- * @param {String} string
- * @param {RegExp} regexp
+ * @param {String} string -
+ * @param {RegExp} regexp -
  * @private
  */
 _extractField = function (string, regexp) {
@@ -135,7 +135,7 @@ _extractField = function (string, regexp) {
  * Returns the 'www-authenticate' header for Digest auth. Since a server can suport more than more auth-scheme,
  * there can be more than one header with the same key. So need to loop over and check each one.
  *
- * @param {VariableList} headers
+ * @param {VariableList} headers -
  * @private
  */
 function _getDigestAuthHeader (headers) {
@@ -227,6 +227,7 @@ function computeBodyHash (body, algorithm, digestEncoding, callback) {
 
 /**
  * All the auth definition parameters excluding username and password should be stored and resued.
+ *
  * @todo The current implementation would fail for the case when two requests to two different hosts inherits the same
  * auth. In that case a retry would not be attempted for the second request (since all the parameters would be present
  * in the auth definition though invalid).
@@ -262,9 +263,9 @@ module.exports = {
      * Initializes an item (extracts parameters from intermediate requests if any, etc)
      * before the actual authorization step.
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authInitHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authInitHookCallback} done -
      */
     init: function (auth, response, done) {
         done(null);
@@ -274,8 +275,8 @@ module.exports = {
      * Checks whether the given item has all the required parameters in its request.
      * Sanitizes the auth parameters if needed.
      *
-     * @param {AuthInterface} auth
-     * @param {AuthHandlerInterface~authPreHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {AuthHandlerInterface~authPreHookCallback} done -
      */
     pre: function (auth, done) {
         // ensure that all dynamic parameter values are present in the parameters
@@ -286,9 +287,9 @@ module.exports = {
     /**
      * Verifies whether the request was successfully authorized after being sent.
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authPostHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authPostHookCallback} done -
      */
     post: function (auth, response, done) {
         if (auth.get(DISABLE_RETRY_REQUEST) || !response) {
@@ -341,18 +342,18 @@ module.exports = {
     /**
      * Computes the Digest Authentication header from the given parameters.
      *
-     * @param {Object} params
-     * @param {String} params.algorithm
-     * @param {String} params.username
-     * @param {String} params.realm
-     * @param {String} params.password
-     * @param {String} params.method
-     * @param {String} params.nonce
-     * @param {String} params.nonceCount
-     * @param {String} params.clientNonce
-     * @param {String} params.opaque
-     * @param {String} params.qop
-     * @param {String} params.uri
+     * @param {Object} params -
+     * @param {String} params.algorithm -
+     * @param {String} params.username -
+     * @param {String} params.realm -
+     * @param {String} params.password -
+     * @param {String} params.method -
+     * @param {String} params.nonce -
+     * @param {String} params.nonceCount -
+     * @param {String} params.clientNonce -
+     * @param {String} params.opaque -
+     * @param {String} params.qop -
+     * @param {String} params.uri -
      * @returns {String}
      */
     computeHeader: function (params) {
@@ -429,9 +430,9 @@ module.exports = {
     /**
      * Signs a request.
      *
-     * @param {AuthInterface} auth
-     * @param {Request} request
-     * @param {AuthHandlerInterface~authSignHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Request} request -
+     * @param {AuthHandlerInterface~authSignHookCallback} done -
      */
     sign: function (auth, request, done) {
         var self = this,
@@ -443,7 +444,7 @@ module.exports = {
             return done(); // Nothing to do if required parameters are not present.
         }
 
-        request.removeHeader(AUTHORIZATION, {ignoreCase: true});
+        request.removeHeader(AUTHORIZATION, { ignoreCase: true });
 
         params.method = request.method;
         params.uri = url.path;

package/lib/authorizer/edgegrid.js

@@ -7,7 +7,7 @@
  */
 
 var _ = require('lodash'),
-    uuid = require('uuid/v4'),
+    uuid = require('uuid'),
     crypto = require('crypto'),
     sdk = require('postman-collection'),
     RequestBody = sdk.RequestBody,
@@ -74,7 +74,7 @@ var _ = require('lodash'),
     },
 
     /**
-     * Returns base64 encoding of the SHA–256 HMAC of given data signed with given key
+     * Returns base64 encoding of the SHA-256 HMAC of given data signed with given key
      *
      * @param {String} data Data to sign
      * @param {String} key Key to use while signing the data
@@ -147,7 +147,7 @@ var _ = require('lodash'),
             return callback(hash.digest(digestEncoding));
         }
 
-        // @todo: Figure out a way to calculate hash for formdata body type.
+        // @todo: Figure out a way to calculate hash for form-data body type.
 
         // ensure that callback is called if body.mode doesn't match with any of the above modes
         return callback();
@@ -215,7 +215,7 @@ module.exports = {
      * @param {String} params.clientSecret Client secret provided by service provider
      * @param {String} params.nonce Nonce to include in authorization header
      * @param {String} params.timestamp Timestamp as defined in protocol specification
-     * @param {String} [params.bodyHash] Base64-encoded SHA–256 hash of request body for POST request
+     * @param {String} [params.bodyHash] Base64-encoded SHA-256 hash of request body for POST request
      * @param {Object[]} params.headers Request headers
      * @param {String[]} params.headersToSign Ordered list of headers to include in signature
      * @param {String} params.method Request method
@@ -271,17 +271,17 @@ module.exports = {
             return done(); // Nothing to do if required parameters are not present.
         }
 
-        request.removeHeader(AUTHORIZATION, {ignoreCase: true});
+        request.removeHeader(AUTHORIZATION, { ignoreCase: true });
 
         // Extract host from provided baseURL.
         params.baseURL = params.baseURL && urlEncoder.toNodeUrl(params.baseURL).host;
-        params.nonce = params.nonce || uuid();
+        params.nonce = params.nonce || uuid.v4();
         params.timestamp = params.timestamp || getTimestamp();
         params.url = url;
         params.method = request.method;
 
         // ensure that headers are case-insensitive as specified in the documentation
-        params.headers = request.getHeaders({enabled: true, ignoreCase: true});
+        params.headers = request.getHeaders({ enabled: true, ignoreCase: true });
 
         if (typeof params.headersToSign === STRING) {
             params.headersToSign = params.headersToSign.split(',');

package/lib/authorizer/hawk.js

@@ -14,7 +14,7 @@ var url = require('url'),
 /**
  * Generates a random string of given length (useful for nonce generation, etc).
  *
- * @param {Number} length
+ * @param {Number} length -
  */
 function randomString (length) {
     length = length || 6;
@@ -33,11 +33,11 @@ function randomString (length) {
  * Calculates body hash with given algorithm and digestEncoding.
  * REFER: https://github.com/postmanlabs/postman-request/blob/master/lib/hawk.js#L12
  *
- * @param {RequestBody} body
- * @param {String} algorithm
- * @param {String} digestEncoding
- * @param {String} contentType
- * @param {Function} callback
+ * @param {RequestBody} body -
+ * @param {String} algorithm -
+ * @param {String} digestEncoding -
+ * @param {String} contentType -
+ * @param {Function} callback -
  */
 function computeBodyHash (body, algorithm, digestEncoding, contentType, callback) {
     if (!(body && algorithm && digestEncoding) || body.isEmpty()) { return callback(); }
@@ -135,9 +135,9 @@ module.exports = {
      * Initializes an item (extracts parameters from intermediate requests if any, etc)
      * before the actual authorization step.
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authInitHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authInitHookCallback} done -
      */
     init: function (auth, response, done) {
         done(null);
@@ -147,8 +147,8 @@ module.exports = {
      * Checks the item, and fetches any parameters that are not already provided.
      * Sanitizes the auth parameters if needed.
      *
-     * @param {AuthInterface} auth
-     * @param {AuthHandlerInterface~authPreHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {AuthHandlerInterface~authPreHookCallback} done -
      */
     pre: function (auth, done) {
         !auth.get('nonce') && auth.set('nonce', randomString(6));
@@ -159,9 +159,9 @@ module.exports = {
     /**
      * Verifies whether the request was successfully authorized after being sent.
      *
-     * @param {AuthInterface} auth
-     * @param {Response} response
-     * @param {AuthHandlerInterface~authPostHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Response} response -
+     * @param {AuthHandlerInterface~authPostHookCallback} done -
      */
     post: function (auth, response, done) {
         done(null, true);
@@ -170,9 +170,9 @@ module.exports = {
     /**
      * Computes signature and Auth header for a request.
      *
-     * @param {Object} params
+     * @param {Object} params -
      * @param {Object} params.credentials Contains hawk auth credentials, "id", "key" and "algorithm"
-     * @param {String} params.nonce
+     * @param {String} params.nonce -
      * @param {String} params.ext Extra data that may be associated with the request.
      * @param {String} params.app Application ID used in Oz authorization protocol
      * @param {String} params.dlg Delegation information (used in the Oz protocol)
@@ -189,9 +189,9 @@ module.exports = {
     /**
      * Signs a request.
      *
-     * @param {AuthInterface} auth
-     * @param {Request} request
-     * @param {AuthHandlerInterface~authSignHookCallback} done
+     * @param {AuthInterface} auth -
+     * @param {Request} request -
+     * @param {AuthHandlerInterface~authSignHookCallback} done -
      */
     sign: function (auth, request, done) {
         var params = auth.get([
@@ -245,7 +245,7 @@ module.exports = {
             return done(); // Nothing to do if required parameters are not present.
         }
 
-        request.removeHeader(AUTHORIZATION, {ignoreCase: true});
+        request.removeHeader(AUTHORIZATION, { ignoreCase: true });
 
         // @note: Payload verification is optional in hawk auth according to specifications (see below link). If user
         //        opt-in for payload verification, `Content-Type` header must be specified explicitely otherwise