Add key packages in Script

CHANGELOG.yaml

@@ -1,4 +1,6 @@
-develop:
+unreleased:
+  new features:
+    - GH-1356 Add new key `packages` to Script
   chores:
     - >-
       GH-1357 Fixed a bug where invalid JSDoc prevented generating docs and

examples/collection-v2.json

@@ -42,14 +42,22 @@
             "id": "my-global-script-1",
             "script": {
                 "type": "text/javascript",
-                "exec": "console.log(\"hello\");"
+                "exec": [
+                  "const package1 = pm.require(\"package1\");",
+                  "console.log(\"hello\", package1);"
+                ],
+                "packages": { "package1": { "id": "script-package-1" } }
             }
         },
         {
             "listen": "prerequest",
             "script": {
                 "type": "text/javascript",
-                "exec": "console.log(\"hello\");"
+                "exec": [
+                  "const package1 = pm.require(\"package1\");",
+                  "console.log(\"hello\", package1);"
+                ],
+                "packages": { "package1": { "id":"script-package-1" } }
             }
         }
     ],

lib/collection/script.js

@@ -6,6 +6,12 @@ var _ = require('../util').lodash,
 
     SCRIPT_NEWLINE_PATTERN = /\r?\n/g;
 
+/**
+ * A map of package names to the IDs of the packages
+ *
+ * @typedef {Object.<string, { id: string }>} Packages
+ */
+
 _.inherit((
 
     /**
@@ -49,6 +55,7 @@ _.assign(Script.prototype, /** @lends Script.prototype */ {
      * @param {String} [options.type] Script type
      * @param {String} [options.src] Script source url
      * @param {String[]|String} [options.exec] Script to execute
+     * @param {Packages} [options.packages] Packages required by the script
      */
     update: function (options) {
         // no splitting is being done here, as string scripts are split right before assignment below anyway
@@ -62,6 +69,14 @@ _.assign(Script.prototype, /** @lends Script.prototype */ {
          * @type {string}
          */
         this.type = options.type || 'text/javascript';
+
+        /**
+         * The packages required by the script
+         *
+         * @type {Packages}
+         */
+        this.packages = options.packages;
+
         _.has(options, 'src') && (
 
             /**

test/unit/event-list.test.js

@@ -10,7 +10,8 @@ describe('EventList', function () {
             id: 'my-global-script-1',
             script: {
                 type: 'text/javascript',
-                exec: 'console.log("hello");'
+                exec: 'console.log("hello");',
+                packages: [{ id: 'script-package-1', name: 'package1' }]
             }
         }];
 
@@ -35,7 +36,8 @@ describe('EventList', function () {
                     script: {
                         id: 'test-script-1',
                         type: 'text/javascript',
-                        exec: 'console.log("hello");'
+                        exec: 'console.log("hello");',
+                        packages: { package1: { id: 'script-package-1' } }
                     }
                 }]),
                 eventListJSON;
@@ -46,7 +48,8 @@ describe('EventList', function () {
                 script: {
                     id: 'test-script-1',
                     type: 'text/javascript',
-                    exec: ['console.log("hello");']
+                    exec: ['console.log("hello");'],
+                    packages: { package1: { id: 'script-package-1' } }
                 }
             }]);
 
@@ -63,7 +66,8 @@ describe('EventList', function () {
                 script: {
                     id: 'test-script-1',
                     type: 'text/javascript',
-                    exec: ['console.log("hello");']
+                    exec: ['console.log("hello");'],
+                    packages: { package1: { id: 'script-package-1' } }
                 }
             });
 

test/unit/event.test.js

@@ -11,7 +11,8 @@ describe('Event', function () {
         id: 'my-global-script-1',
         script: {
             type: 'text/javascript',
-            exec: 'console.log("hello");'
+            exec: 'console.log("hello");',
+            packages: {}
         }
     };
 
@@ -52,6 +53,7 @@ describe('Event', function () {
                     expect(postmanEvent).to.have.property('script').that.is.an('object');
                     expect(postmanEvent.script).to.have.property('type', 'text/javascript');
                     expect(postmanEvent.script).to.have.property('exec').that.is.an('array');
+                    expect(postmanEvent.script).to.have.property('packages').that.is.an('object');
                 });
             });
 
@@ -120,7 +122,8 @@ describe('Event', function () {
             expect(eventJSON).to.have.property('script').that.has.property('id');
             expect(eventJSON.script).to.deep.include({
                 type: 'text/javascript',
-                exec: ['console.log("hello");']
+                exec: ['console.log("hello");'],
+                packages: {}
             });
         });
 
@@ -132,7 +135,8 @@ describe('Event', function () {
             expect(beforeJSON).to.have.property('script').that.has.property('id');
             expect(beforeJSON.script).to.deep.include({
                 type: 'text/javascript',
-                exec: ['console.log("hello");']
+                exec: ['console.log("hello");'],
+                packages: {}
             });
 
             event.update({ script: { id: 'my-new-script' } });
@@ -142,5 +146,26 @@ describe('Event', function () {
             expect(afterJSON.script).to.have.property('id', 'my-new-script');
             expect(afterJSON.script.exec).to.be.undefined;
         });
+
+        it('should not add packages key if not present', function () {
+            var rawEvent = {
+                    listen: 'test',
+                    id: 'my-global-script-1',
+                    script: {
+                        type: 'text/javascript',
+                        exec: 'console.log("hello");'
+                    }
+                },
+                event = new Event(rawEvent),
+                beforeJSON = event.toJSON(),
+                afterJSON;
+
+            expect(beforeJSON.script).to.not.have.property('packages');
+
+            event.update({ script: { exec: 'console.log("updated");' } });
+            afterJSON = event.toJSON();
+
+            expect(afterJSON.script).to.not.have.property('packages');
+        });
     });
 });

test/unit/script.test.js

@@ -64,7 +64,7 @@ describe('Script', function () {
                     var source = script.toSource();
 
                     expect(source).to.be.a('string');
-                    expect(source).to.equal(rawScript.exec);
+                    expect(source).to.equal(rawScript.exec.join('\n'));
                 });
             });
         });
@@ -201,7 +201,7 @@ describe('Script', function () {
 
             expect(jsonified).to.deep.include({
                 type: rawScript.type,
-                exec: rawScript.exec.split('\n')
+                exec: rawScript.exec
             });
             expect(jsonified.src).to.eql(rawScript.src);
         });

types/index.d.ts

@@ -2146,6 +2146,13 @@ declare module "postman-collection" {
         static createFromNode(response: any, cookies: any): any;
     }
 
+    /**
+     * A map of package names to the IDs of the packages
+     */
+    export type Packages = {
+        [key: string]: { id: string; };
+    };
+
     /**
      * Postman scripts that are executed upon events on a collection  / request such as test and pre request.
      * @param options - -
@@ -2162,13 +2169,19 @@ declare module "postman-collection" {
          * @param [options.type] - Script type
          * @param [options.src] - Script source url
          * @param [options.exec] - Script to execute
+         * @param [options.packages] - Packages required by the script
          */
         update(options?: {
             type?: string;
             src?: string;
             exec?: string[] | string;
+            packages?: Packages;
         }): void;
         type: string;
+        /**
+         * The packages required by the script
+         */
+        packages: Packages;
         src: Url;
         exec: string[];
         /**