@loopback/testlab 1.7.2 → 1.8.0

package/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.8.0](https://github.com/strongloop/loopback-next/compare/@loopback/testlab@1.7.5...@loopback/testlab@1.8.0) (2019-09-06)
+
+
+### Features
+
+* **testlab:** add TestLab.writeJsonFile ([baa993b](https://github.com/strongloop/loopback-next/commit/baa993b))
+
+
+
+
+
+## [1.7.5](https://github.com/strongloop/loopback-next/compare/@loopback/testlab@1.7.4...@loopback/testlab@1.7.5) (2019-09-03)
+
+
+### Bug Fixes
+
+* make givenHttpServerConfig typing compatible with TypeScript 3.6 ([1edbc0b](https://github.com/strongloop/loopback-next/commit/1edbc0b))
+
+
+
+
+
+## [1.7.4](https://github.com/strongloop/loopback-next/compare/@loopback/testlab@1.7.3...@loopback/testlab@1.7.4) (2019-08-19)
+
+**Note:** Version bump only for package @loopback/testlab
+
+
+
+
+
+## [1.7.3](https://github.com/strongloop/loopback-next/compare/@loopback/testlab@1.7.2...@loopback/testlab@1.7.3) (2019-08-15)
+
+**Note:** Version bump only for package @loopback/testlab
+
+
+
+
+
 ## [1.7.2](https://github.com/strongloop/loopback-next/compare/@loopback/testlab@1.7.1...@loopback/testlab@1.7.2) (2019-07-31)
 
 **Note:** Version bump only for package @loopback/testlab

package/dist/expect.js

@@ -4,6 +4,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path="../should-as-function.d.ts" />
 const shouldAsFunction = require('should/as-function');
 shouldAsFunction.use((should, assertion) => {

package/dist/expect.js.map

@@ -1 +1 @@
-{"version":3,"file":"expect.js","sourceRoot":"","sources":["../src/expect.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AAEhE,mDAAmD;AAEnD,MAAM,gBAAgB,GAAa,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEjE,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE;IACzC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC;AAEU,QAAA,MAAM,GAAG,gBAAgB,CAAC"}
+{"version":3,"file":"expect.js","sourceRoot":"","sources":["../src/expect.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AAEhE,qEAAqE;AACrE,mDAAmD;AAEnD,MAAM,gBAAgB,GAAa,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEjE,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE;IACzC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC;AAEU,QAAA,MAAM,GAAG,gBAAgB,CAAC"}

package/dist/http-server-config.d.ts

@@ -1,9 +1,16 @@
 /// <reference types="node" />
 import { ServerOptions as HttpsServerOptions } from 'https';
-export declare type ConfigRetval<T extends object> = T & {
+import { ListenOptions } from 'net';
+export interface HttpOptions extends ListenOptions {
+    protocol?: 'http';
+}
+export interface HttpsOptions extends ListenOptions, HttpsServerOptions {
+    protocol: 'https';
+}
+export declare type HostPort = {
     host: string;
     port: number;
-} & HttpsServerOptions;
+};
 /**
  * Create an HTTP-server configuration that works well in test environments.
  *  - Ask the operating system to assign a free (ephemeral) port.
@@ -13,6 +20,4 @@ export declare type ConfigRetval<T extends object> = T & {
  *
  * @param customConfig - Additional configuration options to apply.
  */
-export declare function givenHttpServerConfig<T extends object>(customConfig?: T & {
-    protocol?: string;
-}): ConfigRetval<T>;
+export declare function givenHttpServerConfig<T extends HttpOptions | HttpsOptions>(customConfig?: T): HostPort & T;

package/dist/http-server-config.js

@@ -4,8 +4,8 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-const path = require("path");
 const fs_1 = require("fs");
+const path = require("path");
 const FIXTURES = path.resolve(__dirname, '../fixtures');
 const DUMMY_TLS_CONFIG = {
     key: fs_1.readFileSync(path.join(FIXTURES, 'key.pem')),
@@ -31,7 +31,7 @@ function givenHttpServerConfig(customConfig) {
         config.host = defaults.host;
     if (config.port === undefined)
         config.port = defaults.port;
-    if (customConfig && customConfig.protocol === 'https') {
+    if (isHttpsConfig(config)) {
         setupTlsConfig(config);
     }
     return config;
@@ -44,4 +44,7 @@ function setupTlsConfig(config) {
         return;
     Object.assign(config, DUMMY_TLS_CONFIG);
 }
+function isHttpsConfig(config) {
+    return config && config.protocol === 'https';
+}
 //# sourceMappingURL=http-server-config.js.map

package/dist/http-server-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-server-config.js","sourceRoot":"","sources":["../src/http-server-config.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AAEhE,6BAA6B;AAC7B,2BAAgC;AAGhC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACxD,MAAM,gBAAgB,GAAG;IACvB,GAAG,EAAE,iBAAY,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACjD,IAAI,EAAE,iBAAY,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;CACpD,CAAC;AAOF;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,YAAsC;IAEtC,MAAM,QAAQ,GAAG;QACf,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,CAAC;QACP,QAAQ,EAAE,SAAS;KACpB,CAAC;IACF,MAAM,MAAM,GAAoB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC1E,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC3D,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC3D,IAAI,YAAY,IAAI,YAAY,CAAC,QAAQ,KAAK,OAAO,EAAE;QACrD,cAAc,CAAC,MAAM,CAAC,CAAC;KACxB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,sDAeC;AAED,SAAS,cAAc,CAAC,MAA0B;IAChD,IAAI,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM;QAAE,OAAO;IAChD,IAAI,KAAK,IAAI,MAAM;QAAE,OAAO;IAC5B,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"http-server-config.js","sourceRoot":"","sources":["../src/http-server-config.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AAEhE,2BAAgC;AAGhC,6BAA6B;AAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACxD,MAAM,gBAAgB,GAAG;IACvB,GAAG,EAAE,iBAAY,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACjD,IAAI,EAAE,iBAAY,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;CACpD,CAAC;AAeF;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,YAAgB;IAEhB,MAAM,QAAQ,GAAG;QACf,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,CAAC;QACP,QAAQ,EAAE,SAAS;KACpB,CAAC;IACF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;IACzD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC3D,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC3D,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE;QACzB,cAAc,CAAC,MAAM,CAAC,CAAC;KACxB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,sDAeC;AAED,SAAS,cAAc,CAAC,MAA0B;IAChD,IAAI,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM;QAAE,OAAO;IAChD,IAAI,KAAK,IAAI,MAAM;QAAE,OAAO;IAC5B,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,aAAa,CACpB,MAAkC;IAElC,OAAO,MAAM,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,CAAC;AAC/C,CAAC"}

package/dist/test-sandbox.d.ts

@@ -41,4 +41,11 @@ export declare class TestSandbox {
      * (relative to TestSandbox). Original filename used if not specified.
      */
     copyFile(src: string, dest?: string): Promise<void>;
+    /**
+     * Creates a new file and writes the given data serialized as JSON.
+     *
+     * @param dest - Destination filename, optionally including a relative path.
+     * @param data - The data to write.
+     */
+    writeJsonFile(dest: string, data: unknown): Promise<void>;
 }

package/dist/test-sandbox.js

@@ -4,19 +4,13 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
 const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
 /**
  * TestSandbox class provides a convenient way to get a reference to a
  * sandbox folder in which you can perform operations for testing purposes.
  */
 class TestSandbox {
-    get path() {
-        if (!this._path) {
-            throw new Error(`TestSandbox instance was deleted. Create a new instance.`);
-        }
-        return this._path;
-    }
     /**
      * Will create a directory if it doesn't already exist. If it exists, you
      * still get an instance of the TestSandbox.
@@ -28,6 +22,12 @@ class TestSandbox {
         this._path = path_1.resolve(path);
         fs_extra_1.ensureDirSync(this.path);
     }
+    get path() {
+        if (!this._path) {
+            throw new Error(`TestSandbox instance was deleted. Create a new instance.`);
+        }
+        return this._path;
+    }
     /**
      * Returns the path of the TestSandbox
      */
@@ -83,6 +83,18 @@ class TestSandbox {
             await fs_extra_1.appendFile(dest, `\n//# sourceMappingURL=${srcMap}`);
         }
     }
+    /**
+     * Creates a new file and writes the given data serialized as JSON.
+     *
+     * @param dest - Destination filename, optionally including a relative path.
+     * @param data - The data to write.
+     */
+    async writeJsonFile(dest, data) {
+        dest = path_1.resolve(this.path, dest);
+        const destDir = path_1.parse(dest).dir;
+        await fs_extra_1.ensureDir(destDir);
+        return fs_extra_1.writeJson(dest, data, { spaces: 2 });
+    }
 }
 exports.TestSandbox = TestSandbox;
 //# sourceMappingURL=test-sandbox.js.map

package/dist/test-sandbox.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-sandbox.js","sourceRoot":"","sources":["../src/test-sandbox.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AAEhE,+BAAoC;AACpC,uCAQkB;AAElB;;;GAGG;AACH,MAAa,WAAW;IAItB,IAAW,IAAI;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,YAAY,IAAY;QACtB,2EAA2E;QAC3E,IAAI,CAAC,KAAK,GAAG,cAAO,CAAC,IAAI,CAAC,CAAC;QAC3B,wBAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,4EAA4E;QAC5E,uEAAuE;QACvE,wCAAwC;QACxC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE;YAC/B,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC7B,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;QAED,MAAM,mBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,iBAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW;QACrB,MAAM,oBAAS,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,IAAa;QACvC,IAAI,GAAG,IAAI;YACT,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;YAC1B,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,YAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAExC,MAAM,eAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEtB,IAAI,YAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,qBAAU,CAAC,GAAG,GAAG,MAAM,CAAC,EAAE;YACxD,MAAM,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC;YAC5B,MAAM,qBAAU,CAAC,IAAI,EAAE,0BAA0B,MAAM,EAAE,CAAC,CAAC;SAC5D;IACH,CAAC;CACF;AAvFD,kCAuFC"}
+{"version":3,"file":"test-sandbox.js","sourceRoot":"","sources":["../src/test-sandbox.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AAEhE,uCASkB;AAClB,+BAAoC;AAEpC;;;GAGG;AACH,MAAa,WAAW;IAatB;;;;;OAKG;IACH,YAAY,IAAY;QACtB,2EAA2E;QAC3E,IAAI,CAAC,KAAK,GAAG,cAAO,CAAC,IAAI,CAAC,CAAC;QAC3B,wBAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAnBD,IAAW,IAAI;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAcD;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,4EAA4E;QAC5E,uEAAuE;QACvE,wCAAwC;QACxC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE;YAC/B,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC7B,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;QAED,MAAM,mBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,iBAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW;QACrB,MAAM,oBAAS,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,IAAa;QACvC,IAAI,GAAG,IAAI;YACT,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;YAC1B,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,YAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAExC,MAAM,eAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEtB,IAAI,YAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,qBAAU,CAAC,GAAG,GAAG,MAAM,CAAC,EAAE;YACxD,MAAM,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC;YAC5B,MAAM,qBAAU,CAAC,IAAI,EAAE,0BAA0B,MAAM,EAAE,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAAa;QAC7C,IAAI,GAAG,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,YAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC;QAChC,MAAM,oBAAS,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,oBAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAC,MAAM,EAAE,CAAC,EAAC,CAAC,CAAC;IAC5C,CAAC;CACF;AApGD,kCAoGC"}

package/dist/to-json.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-json.js","sourceRoot":"","sources":["../src/to-json.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AA8ChE,SAAgB,MAAM,CAAI,KAAQ;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACnD,CAAC;AAFD,wBAEC"}
+{"version":3,"file":"to-json.js","sourceRoot":"","sources":["../src/to-json.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;AAgDhE,SAAgB,MAAM,CAAI,KAAQ;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACnD,CAAC;AAFD,wBAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loopback/testlab",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "description": "A collection of test utilities we use to write LoopBack tests.",
   "engines": {
     "node": ">=8.9"
@@ -16,8 +16,8 @@
   "copyright.owner": "IBM Corp.",
   "license": "MIT",
   "dependencies": {
-    "@hapi/shot": "^4.0.7",
-    "@types/express": "^4.17.0",
+    "@hapi/shot": "^4.1.1",
+    "@types/express": "^4.17.1",
     "@types/fs-extra": "^8.0.0",
     "@types/shot": "^4.0.0",
     "@types/sinon": "^7.0.13",
@@ -26,13 +26,13 @@
     "fs-extra": "^8.1.0",
     "oas-validator": "^3.3.1",
     "should": "^13.2.3",
-    "sinon": "^7.3.2",
+    "sinon": "^7.4.2",
     "supertest": "^4.0.2"
   },
   "devDependencies": {
-    "@loopback/build": "^2.0.6",
-    "@loopback/eslint-config": "^3.0.0",
-    "@types/node": "^10.14.14"
+    "@loopback/build": "^2.0.10",
+    "@loopback/eslint-config": "^4.0.2",
+    "@types/node": "^10.14.17"
   },
   "files": [
     "README.md",
@@ -49,5 +49,5 @@
     "url": "https://github.com/strongloop/loopback-next.git",
     "directory": "packages/testlab"
   },
-  "gitHead": "8c4b5d2b584a8c573d26ff159d9ab1b437a9ed39"
+  "gitHead": "4e653bbff797b26437bd1b0817ed9b8c91f3477b"
 }

package/src/expect.ts

@@ -3,6 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path="../should-as-function.d.ts" />
 
 const shouldAsFunction: Internal = require('should/as-function');

package/src/http-server-config.ts

@@ -3,9 +3,10 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import * as path from 'path';
 import {readFileSync} from 'fs';
 import {ServerOptions as HttpsServerOptions} from 'https';
+import {ListenOptions} from 'net';
+import * as path from 'path';
 
 const FIXTURES = path.resolve(__dirname, '../fixtures');
 const DUMMY_TLS_CONFIG = {
@@ -13,10 +14,18 @@ const DUMMY_TLS_CONFIG = {
   cert: readFileSync(path.join(FIXTURES, 'cert.pem')),
 };
 
-export type ConfigRetval<T extends object> = T & {
+export interface HttpOptions extends ListenOptions {
+  protocol?: 'http';
+}
+
+export interface HttpsOptions extends ListenOptions, HttpsServerOptions {
+  protocol: 'https';
+}
+
+export type HostPort = {
   host: string;
   port: number;
-} & HttpsServerOptions;
+};
 
 /**
  * Create an HTTP-server configuration that works well in test environments.
@@ -27,18 +36,18 @@ export type ConfigRetval<T extends object> = T & {
  *
  * @param customConfig - Additional configuration options to apply.
  */
-export function givenHttpServerConfig<T extends object>(
-  customConfig?: T & {protocol?: string},
-): ConfigRetval<T> {
+export function givenHttpServerConfig<T extends HttpOptions | HttpsOptions>(
+  customConfig?: T,
+): HostPort & T {
   const defaults = {
     host: '127.0.0.1',
     port: 0,
     protocol: undefined,
   };
-  const config: ConfigRetval<T> = Object.assign({}, defaults, customConfig);
+  const config = Object.assign({}, defaults, customConfig);
   if (config.host === undefined) config.host = defaults.host;
   if (config.port === undefined) config.port = defaults.port;
-  if (customConfig && customConfig.protocol === 'https') {
+  if (isHttpsConfig(config)) {
     setupTlsConfig(config);
   }
   return config;
@@ -49,3 +58,9 @@ function setupTlsConfig(config: HttpsServerOptions) {
   if ('pfx' in config) return;
   Object.assign(config, DUMMY_TLS_CONFIG);
 }
+
+function isHttpsConfig(
+  config: HttpOptions | HttpsOptions,
+): config is HttpsOptions {
+  return config && config.protocol === 'https';
+}

package/src/test-sandbox.ts

@@ -3,16 +3,17 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {resolve, parse} from 'path';
 import {
+  appendFile,
   copy,
-  ensureDirSync,
   emptyDir,
-  remove,
   ensureDir,
+  ensureDirSync,
   pathExists,
-  appendFile,
+  remove,
+  writeJson,
 } from 'fs-extra';
+import {parse, resolve} from 'path';
 
 /**
  * TestSandbox class provides a convenient way to get a reference to a
@@ -105,4 +106,17 @@ export class TestSandbox {
       await appendFile(dest, `\n//# sourceMappingURL=${srcMap}`);
     }
   }
+
+  /**
+   * Creates a new file and writes the given data serialized as JSON.
+   *
+   * @param dest - Destination filename, optionally including a relative path.
+   * @param data - The data to write.
+   */
+  async writeJsonFile(dest: string, data: unknown): Promise<void> {
+    dest = resolve(this.path, dest);
+    const destDir = parse(dest).dir;
+    await ensureDir(destDir);
+    return writeJson(dest, data, {spaces: 2});
+  }
 }

package/src/to-json.ts

@@ -3,6 +3,8 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+/* eslint-disable @typescript-eslint/unified-signatures */
+
 // Important! Date.prototype.toJSON() returns a string.
 export function toJSON(value: Date): string;