@ms-cloudpack/create-express-app 0.1.0 → 1.0.0

package/CHANGELOG.json

@@ -2,7 +2,58 @@
   "name": "@ms-cloudpack/create-express-app",
   "entries": [
     {
-      "date": "Fri, 20 May 2022 04:25:53 GMT",
+      "date": "Tue, 18 Oct 2022 08:15:52 GMT",
+      "tag": "@ms-cloudpack/create-express-app_v1.0.0",
+      "version": "1.0.0",
+      "comments": {
+        "major": [
+          {
+            "author": "dake.3601@gmail.com",
+            "package": "@ms-cloudpack/create-express-app",
+            "commit": "1bec1f80bb50ebe897f03dc74437c3e211bea83e",
+            "comment": "Https express app can be created with options and domain."
+          },
+          {
+            "author": "beachball",
+            "package": "@ms-cloudpack/create-express-app",
+            "comment": "Bump @ms-cloudpack/path-utilities to v1.1.0",
+            "commit": "1bec1f80bb50ebe897f03dc74437c3e211bea83e"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 28 Sep 2022 08:15:16 GMT",
+      "tag": "@ms-cloudpack/create-express-app_v0.1.1",
+      "version": "0.1.1",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "@ms-cloudpack/create-express-app",
+            "commit": "084168500b6320d6861a4c7e8f363fea9e4f831e",
+            "comment": "Remove unnecessary await"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 20 Sep 2022 08:13:46 GMT",
+      "tag": "@ms-cloudpack/create-express-app_v0.1.0",
+      "version": "0.1.0",
+      "comments": {
+        "none": [
+          {
+            "author": "email not defined",
+            "package": "@ms-cloudpack/create-express-app",
+            "commit": "f408318df04c9a3e4754975a28c39660abf32687",
+            "comment": "Update devDependency @types/express to v4.17.14"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 20 May 2022 04:26:15 GMT",
       "tag": "@ms-cloudpack/create-express-app_v0.1.0",
       "version": "0.1.0",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,29 @@
 # Change Log - @ms-cloudpack/create-express-app
 
-This log was last generated on Fri, 20 May 2022 04:25:53 GMT and should not be manually modified.
+This log was last generated on Tue, 18 Oct 2022 08:15:52 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.0.0
+
+Tue, 18 Oct 2022 08:15:52 GMT
+
+### Major changes
+
+- Https express app can be created with options and domain. (dake.3601@gmail.com)
+- Bump @ms-cloudpack/path-utilities to v1.1.0
+
+## 0.1.1
+
+Wed, 28 Sep 2022 08:15:16 GMT
+
+### Patches
+
+- Remove unnecessary await (elcraig@microsoft.com)
+
 ## 0.1.0
 
-Fri, 20 May 2022 04:25:53 GMT
+Fri, 20 May 2022 04:26:15 GMT
 
 ### Minor changes
 

package/lib/createExpressApp.d.ts

@@ -1,8 +1,16 @@
 /// <reference types="node" resolution-mode="require"/>
 import { type Express } from 'express';
 import type { Server } from 'http';
-export declare function createExpressApp(portRange: number[], setupCallback: (app: Express) => void): Promise<{
+import type { HttpsConfig } from './parseHttpsConfig.js';
+export declare function createExpressApp(options: {
+    portRange?: number | number[];
+    hostname?: string;
+    sslOptions?: HttpsConfig;
+    setupCallback?: (app: Express) => void;
+}): Promise<{
     server: Server;
+    protocol: 'http' | 'https';
+    domain: string;
     port: number;
 }>;
 export type { Express };

package/lib/createExpressApp.js

@@ -1,8 +1,10 @@
-import express from 'express';
+import express, {} from 'express';
+import https from 'https';
 import cors from 'cors';
 import compression from 'compression';
 import getPort from 'get-port';
-export async function createExpressApp(portRange, setupCallback) {
+export async function createExpressApp(options) {
+    const { setupCallback, hostname, sslOptions, portRange } = options;
     // Get the available port.
     const port = await getPort({
         port: portRange,
@@ -13,11 +15,24 @@ export async function createExpressApp(portRange, setupCallback) {
     // Use compression.
     app.use(compression());
     // Call setup callback with the app.
-    await setupCallback(app);
-    // Listen on port.
-    const server = app.listen(port);
+    setupCallback?.(app);
+    const domain = hostname || 'localhost';
+    let server = undefined;
+    let protocol = 'http';
+    if (sslOptions && Object.keys(sslOptions).length !== 0) {
+        // Create an HTTPS server.
+        const httpsServer = https.createServer(sslOptions, app);
+        server = httpsServer.listen(port, domain);
+        protocol = 'https';
+    }
+    else {
+        // Create an HTTP server.
+        server = app.listen(port, domain);
+    }
     return {
         server,
+        protocol,
+        domain,
         port,
     };
 }

package/lib/createExpressApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"createExpressApp.js","sourceRoot":"","sources":["../src/createExpressApp.ts"],"names":[],"mappings":"AAAA,OAAO,OAAyB,MAAM,SAAS,CAAC;AAChD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,OAAO,MAAM,UAAU,CAAC;AAG/B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,SAAmB,EACnB,aAAqC;IAKrC,0BAA0B;IAC1B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC;QACzB,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IAEtB,YAAY;IACZ,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAEhB,mBAAmB;IACnB,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvB,oCAAoC;IACpC,MAAM,aAAa,CAAC,GAAG,CAAC,CAAC;IAEzB,kBAAkB;IAClB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEhC,OAAO;QACL,MAAM;QACN,IAAI;KACL,CAAC;AACJ,CAAC"}
+{"version":3,"file":"createExpressApp.js","sourceRoot":"","sources":["../src/createExpressApp.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAgB,MAAM,SAAS,CAAC;AAChD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,OAAO,MAAM,UAAU,CAAC;AAI/B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAKtC;IAMC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAEnE,0BAA0B;IAC1B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC;QACzB,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IAEtB,YAAY;IACZ,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAEhB,mBAAmB;IACnB,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvB,oCAAoC;IACpC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC;IAErB,MAAM,MAAM,GAAG,QAAQ,IAAI,WAAW,CAAC;IACvC,IAAI,MAAM,GAAG,SAAS,CAAC;IACvB,IAAI,QAAQ,GAAqB,MAAM,CAAC;IAExC,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACtD,0BAA0B;QAC1B,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACxD,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,QAAQ,GAAG,OAAO,CAAC;KACpB;SAAM;QACL,yBAAyB;QACzB,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;KACnC;IAED,OAAO;QACL,MAAM;QACN,QAAQ;QACR,MAAM;QACN,IAAI;KACL,CAAC;AACJ,CAAC"}

package/lib/index.d.ts

@@ -1,2 +1,3 @@
 export { createExpressApp } from './createExpressApp.js';
 export type { Express, Request, Response } from 'express';
+export { parseHttpsConfig, type HttpsConfig } from './parseHttpsConfig.js';

package/lib/index.js

@@ -1,2 +1,3 @@
 export { createExpressApp } from './createExpressApp.js';
+export { parseHttpsConfig } from './parseHttpsConfig.js';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,gBAAgB,EAAoB,MAAM,uBAAuB,CAAC"}

package/lib/parseHttpsConfig.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { ServerOptions } from 'https';
+import type { IncomingMessage, ServerResponse } from 'http';
+export declare type HttpsConfig = ServerOptions<typeof IncomingMessage, typeof ServerResponse>;
+export declare function parseHttpsConfig(config: HttpsConfig): HttpsConfig;

package/lib/parseHttpsConfig.js

@@ -0,0 +1,26 @@
+import fs from 'fs';
+import { pathSymbolReplacement } from '@ms-cloudpack/path-utilities';
+/*
+ * Read certificates files in Https Config and return the contents.
+ */
+export function parseHttpsConfig(config) {
+    const sslOptions = {};
+    for (const [key, value] of Object.entries(config)) {
+        // Read the file contents for the certificates.
+        if (['ca', 'cert', 'key', 'pfx'].includes(key) && typeof value === 'string') {
+            const certFilePath = pathSymbolReplacement(value);
+            if (fs.existsSync(certFilePath)) {
+                sslOptions[key] = fs.readFileSync(certFilePath);
+            }
+            else {
+                throw 'Certificate file not found: ' + certFilePath;
+            }
+        }
+        else {
+            // If not a certificate, just use the value.
+            sslOptions[key] = value;
+        }
+    }
+    return sslOptions;
+}
+//# sourceMappingURL=parseHttpsConfig.js.map

package/lib/parseHttpsConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseHttpsConfig.js","sourceRoot":"","sources":["../src/parseHttpsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAQrE;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAmB;IAClD,MAAM,UAAU,GAAyC,EAAE,CAAC;IAE5D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACjD,+CAA+C;QAC/C,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC3E,MAAM,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAClD,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;gBAC/B,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;aACjD;iBAAM;gBACL,MAAM,8BAA8B,GAAG,YAAY,CAAC;aACrD;SACF;aAAM;YACL,4CAA4C;YAC5C,UAAU,CAAC,GAAG,CAAC,GAAyB,KAAK,CAAC;SAC/C;KACF;IACD,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/lib/parseHttpsConfig.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/parseHttpsConfig.test.js

@@ -0,0 +1,64 @@
+import { afterEach, describe, it, expect } from '@jest/globals';
+import { parseHttpsConfig } from './parseHttpsConfig.js';
+import fs from 'fs';
+import path from 'path';
+import { createTestFileStructure } from '@ms-cloudpack/test-utilities';
+const { rmdir } = fs.promises;
+describe('parseHttpsConfig', () => {
+    let testPath;
+    afterEach(async () => {
+        if (testPath) {
+            await rmdir(testPath, { recursive: true });
+            testPath = undefined;
+        }
+    });
+    it('can read certs from file paths and keeps other properties', async () => {
+        const testPath = await createTestFileStructure({
+            'certs/mock.ca': 'ca mock',
+            'certs/mock.pfx': 'pfx mock',
+            'certs/mock.key': 'key mock',
+            'certs/mock.cert': 'cert mock',
+        });
+        const httpsConfig = {
+            ca: path.join(testPath, 'certs/mock.ca'),
+            pfx: path.join(testPath, 'certs/mock.pfx'),
+            key: path.join(testPath, 'certs/mock.key'),
+            cert: path.join(testPath, 'certs/mock.cert'),
+            passphrase: 'passphrase',
+            requestCert: true,
+        };
+        expect(parseHttpsConfig(httpsConfig)).toEqual({
+            ca: Buffer.from('ca mock', 'utf8'),
+            pfx: Buffer.from('pfx mock', 'utf8'),
+            key: Buffer.from('key mock', 'utf8'),
+            cert: Buffer.from('cert mock', 'utf8'),
+            passphrase: 'passphrase',
+            requestCert: true,
+        });
+    });
+    it('throws if cert file is not found', async () => {
+        const testPath = await createTestFileStructure({
+            'certs/mock.ca': 'ca mock',
+            'certs/undefined/mock.pfx': 'pfx mock',
+            'certs/mock.key': 'key mock',
+            'certs/mock.cert': 'cert mock',
+        });
+        const httpsConfig = {
+            ca: path.join(testPath, 'certs/mock.ca'),
+            pfx: path.join(testPath, 'certs/mock.pfx'),
+            key: path.join(testPath, 'certs/mock.key'),
+            cert: path.join(testPath, 'certs/mock.cert'),
+            passphrase: 'passphrase',
+            requestCert: true,
+        };
+        let error = false;
+        try {
+            parseHttpsConfig(httpsConfig);
+        }
+        catch (e) {
+            error = true;
+        }
+        expect(error).toEqual(true);
+    });
+});
+//# sourceMappingURL=parseHttpsConfig.test.js.map

package/lib/parseHttpsConfig.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseHttpsConfig.test.js","sourceRoot":"","sources":["../src/parseHttpsConfig.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC;AAE9B,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,QAA4B,CAAC;IAEjC,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,IAAI,QAAQ,EAAE;YACZ,MAAM,KAAK,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,QAAQ,GAAG,SAAS,CAAC;SACtB;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC;YAC7C,eAAe,EAAE,SAAS;YAC1B,gBAAgB,EAAE,UAAU;YAC5B,gBAAgB,EAAE,UAAU;YAC5B,iBAAiB,EAAE,WAAW;SAC/B,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG;YAClB,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YAC1C,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC;YAC5C,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,IAAI;SAClB,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC;YAC5C,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC;YAClC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC;YACpC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC;YACpC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC;YACtC,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC;YAC7C,eAAe,EAAE,SAAS;YAC1B,0BAA0B,EAAE,UAAU;YACtC,gBAAgB,EAAE,UAAU;YAC5B,iBAAiB,EAAE,WAAW;SAC/B,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG;YAClB,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YAC1C,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC;YAC5C,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,IAAI;SAClB,CAAC;QAEF,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,IAAI;YACF,gBAAgB,CAAC,WAAW,CAAC,CAAC;SAC/B;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,GAAG,IAAI,CAAC;SACd;QAED,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.33.1"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/create-express-app",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Helper for creating an express app server, abstracting a common plugin setup.",
   "license": "MIT",
   "type": "module",
@@ -13,6 +13,7 @@
     }
   },
   "dependencies": {
+    "@ms-cloudpack/path-utilities": "^1.1.0",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
     "express": "^4.17.3",
@@ -23,7 +24,7 @@
     "@ms-cloudpack/eslint-config-base": "*",
     "@types/compression": "1.7.2",
     "@types/cors": "2.8.12",
-    "@types/express": "4.17.13",
+    "@types/express": "4.17.14",
     "@types/get-port": "4.2.0"
   },
   "scripts": {
@@ -32,7 +33,10 @@
     "build:watch": "cloudpack-scripts build-watch",
     "build": "cloudpack-scripts build",
     "lint:update": "cloudpack-scripts lint-update",
-    "lint": "cloudpack-scripts lint"
+    "lint": "cloudpack-scripts lint",
+    "test:update": "cloudpack-scripts test-update",
+    "test:watch": "cloudpack-scripts test-watch",
+    "test": "cloudpack-scripts test"
   },
   "files": [
     "/lib"