postman-sandbox - npm Package Compare versions

Comparing version 3.5.7 to 3.5.8

lib/sandbox/cookie-jar.js

@@ -14,2 +14,3 @@ var CookieJar = require('tough-cookie').CookieJar,
      *
+     * @private
      * @param {PostmanCookie} cookie - Postman Cookie instance
@@ -40,2 +41,3 @@ * @returns {ToughCookie} Tough Cookie instance
      *
+     * @private
      * @param {ToughCookie} cookie - Tough Cookie instance
@@ -66,2 +68,3 @@ * @returns {ElectronCookie} Electron Cookie instance
      *
+     * @private
      * @param {Object|String} url
@@ -87,2 +90,3 @@ * @returns {Url|Null}
      *
+     * @private
      * @param {Array} items - Array of items to iterate over
@@ -123,2 +127,3 @@ * @param {Function} fn - An async function to apply to each item in items
      *
+     * @private
      * @param {Function} callback - Callback function
@@ -143,2 +148,5 @@ * @param {Error|String} err - Error or Error message
      *
+     * @private
+     * @todo add CookieJar~getCookie to avoid this
+     *
      * @param {CookieJar} jar - ToughCookie jar instance
@@ -148,5 +156,2 @@ * @param {String} url - Url string
      * @param {Function} callback - Callback function
-     *
-     * @private
-     * @todo add CookieJar~getCookie to avoid this
      */
@@ -178,2 +183,6 @@ getCookie = function (jar, url, name, callback) {
 
+/**
+ * @typeof PostmanCookieJar
+ * @interface
+ */
 PostmanCookieJar = function PostmanCookieJar (cookieStore) {
@@ -180,0 +189,0 @@ this.store = cookieStore;

lib/sandbox/execute-context.js

@@ -35,2 +35,8 @@ var _ = require('lodash'),
         // forward pm-api instance
+        /**
+         * The pm object encloses all information pertaining to the script being executed and
+         * allows one to access a copy of the request being sent or the response received.
+         * It also allows one to get and set environment and global variables.
+         * @type {Postman}
+         */
         pm: pmapi,
@@ -37,0 +43,0 @@ // import the timers

lib/sandbox/pmapi.js

@@ -16,2 +16,5 @@ var EXECUTION_ASSERTION_EVENT = 'execution.assertion',
      * Use this function to assign readonly properties to an object
+     *
+     * @private
+     *
      * @param {Object} obj
@@ -69,11 +72,47 @@ * @param {Object} properties
         /**
-         * Contains information pertaining to the script execution
+        * Contains information pertaining to the script execution
          *
-         * @type {Object}
+         * @interface Info
          */
-        info: _assignDefinedReadonly({}, {
+
+        /**
+         * The pm.info object contains information pertaining to the script being executed.
+         * Useful information such as the request name, request Id, and iteration count are
+         * stored inside of this object.
+         * @type {Info}
+         */
+        info: _assignDefinedReadonly({}, /** @lends Info */ {
+            /**
+             * Contains information whether the script being executed is a "prerequest" or a "test" script.
+             * @type {string}
+             * @instance
+             */
             eventName: execution.target,
+
+            /**
+             * Is the value of the current iteration being run.
+             * @type {number}
+             * @instance
+             */
             iteration: execution.cursor.iteration,
+
+            /**
+             * Is the total number of iterations that are scheduled to run.
+             * @type {number}
+             * @instance
+             */
             iterationCount: execution.cursor.cycles,
+
+            /**
+             * The saved name of the individual request being run.
+             * @type {string}
+             * @instance
+             */
             requestName: execution.legacy._itemName,
+
+            /**
+             * The unique guid that identifies the request being run.
+             * @type {string}
+             * @instance
+             */
             requestId: execution.legacy._itemId
@@ -103,2 +142,3 @@ }),
         /**
+         * The iterationData object contains data from the data file provided during a collection run.
          * @type {VariableScope}
@@ -109,2 +149,5 @@ */
         /**
+         * The request object inside pm is a representation of the request for which this script is being run.
+         * For a pre-request script, this is the request that is about to be sent and when in a test script,
+         * this is the representation of the request that was sent.
          * @type {Request}
@@ -115,3 +158,6 @@ */
         /**
+         * Inside the test scripts, the pm.response object contains all information pertaining
+         * to the response that was received.
          * @type {Response}
+         * @customexclude true
          */
@@ -121,2 +167,4 @@ response: execution.response,
         /**
+         * The cookies object contains a list of cookies that are associated with the domain
+         * to which the request was made.
          * @type {CookieList}
@@ -127,8 +175,11 @@ */
         /**
-         * @type {Object}
+         * @interface Visualizer
          */
-        visualizer: {
+        /**
+         * @type {Visualizer}
+         */
+        visualizer: /** @lends Visualizer */ {
             /**
              * Set visualizer template and its options
-             *
+             * @instance
              * @param {String} template - visualisation layout in form of template
@@ -152,3 +203,2 @@ * @param {Object} [data] - data object to be used in template
                 /**
-                 * @typedef {Object} Visualizer
                  *
@@ -168,2 +218,3 @@ * @property {String} template - template string
              * Clear all visualizer data
+             * @instance
              */
@@ -202,3 +253,3 @@ clear: function () {
     /**
-     * Allows one to send request from script.
+     * Allows one to send request from script asynchronously.
      *
@@ -231,2 +282,5 @@ * @param {Request|String} req
 // expose chai assertion library via prototype
+/**
+ * @type {Chai.ExpectStatic}
+ */
 Postman.prototype.expect = chai.expect;
@@ -233,0 +287,0 @@

package.json

 {
   "name": "postman-sandbox",
-  "version": "3.5.7",
+  "version": "3.5.8",
   "description": "Sandbox for Postman Scripts to run in NodeJS or Chrome",
@@ -15,2 +15,5 @@ "main": "index.js",
     "cache": "node npm/cache.js $1",
+    "build-common-types": "node npm/build-types.js",
+    "build-sandbox-types": "node npm/build-sandbox-types.js",
+    "build-types": "npm run build-common-types && npm run build-sandbox-types",
     "test-browser": "node npm/test-browser.js",
@@ -34,3 +37,3 @@ "test-integration": "node npm/test-integration.js",
     "inherits": "2.0.4",
-    "lodash": "4.17.19",
+    "lodash": "4.17.20",
     "teleport-javascript": "1.0.0",
@@ -42,3 +45,3 @@ "tough-cookie": "3.0.1",
   "devDependencies": {
-    "ajv": "6.12.3",
+    "ajv": "6.12.4",
     "assert": "2.0.0",
@@ -66,3 +69,3 @@ "async": "2.6.2",
     "js-yaml": "3.14.0",
-    "jsdoc": "3.6.4",
+    "jsdoc": "3.6.5",
     "jsdoc-to-markdown": "5.0.3",
@@ -80,3 +83,3 @@ "karma": "3.1.4",
     "parse-gitignore": "1.0.1",
-    "postman-collection": "3.6.4",
+    "postman-collection": "3.6.5",
     "puppeteer": "1.18.1",
@@ -87,2 +90,3 @@ "recursive-readdir": "2.2.2",
     "sinon-chai": "3.5.0",
+    "tsd-jsdoc": "2.5.0",
     "tv4": "1.3.0",
@@ -89,0 +93,0 @@ "uglifyify": "5.0.2",

No alert changes

Improved metrics

Total package byte prevSize

7882405

increased by1.82%

Number of package files

95

increased by9.2%

Lines of code

15970

increased by6.99%

Worsened metrics

Dev dependency count

48

increased by2.13%

Number of low supply chain risk alerts

12

increased by20%

Dependency changes

• + Addedlodash@4.17.20(transitive)

• Updatedlodash@4.17.20