caccl-dev-server 2.0.0-beta.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Harvard Edtech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# caccl-dev-server
+HTTPS server for development of CACCL apps

package/lib/index.d.ts

@@ -0,0 +1,14 @@
+import express from 'express';
+/**
+ * Serve an express app on the given port. Uses HTTPS and a self-signed
+ *   certificate
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.app the express app to serve
+ * @param [opts.port=8080] port number to serve on
+ */
+declare const serve: (opts: {
+    app: express.Application;
+    port: number;
+}) => void;
+export default serve;

package/lib/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var selfsigned_1 = __importDefault(require("selfsigned"));
+var https_1 = __importDefault(require("https"));
+/**
+ * Serve an express app on the given port. Uses HTTPS and a self-signed
+ *   certificate
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.app the express app to serve
+ * @param [opts.port=8080] port number to serve on
+ */
+var serve = function (opts) {
+    var _a;
+    // Destructure opts
+    var app = opts.app;
+    var port = ((_a = opts.port) !== null && _a !== void 0 ? _a : 8080);
+    // Generate certs
+    var pems = selfsigned_1.default.generate({ name: "CACCL Dev Server on ".concat(port), value: "localhost:".concat(port) }, { days: 365 });
+    // Create a server
+    var server = https_1.default.createServer({ key: pems.private, cert: pems.cert }, app);
+    // Start listening
+    server.listen(port);
+    server.on('listening', function () {
+        console.log("Now listening on port ".concat(port));
+    });
+    server.on('error', function (err) {
+        if (err.message.includes('EADDRINUSE')) {
+            console.log("\nPort ".concat(port, " is already in use. Is another app already running?"));
+            process.exit(0);
+        }
+        console.log("\nCould not start simulator because an error occurred: ".concat(err.message));
+        process.exit(0);
+    });
+};
+exports.default = serve;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AACA,0DAAoC;AACpC,gDAA0B;AAE1B;;;;;;;GAOG;AACH,IAAM,KAAK,GAAG,UACZ,IAGC;;IAED,mBAAmB;IACX,IAAA,GAAG,GAAK,IAAI,IAAT,CAAU;IACrB,IAAM,IAAI,GAAG,CAAC,MAAA,IAAI,CAAC,IAAI,mCAAI,IAAI,CAAC,CAAC;IAEjC,iBAAiB;IACjB,IAAM,IAAI,GAAG,oBAAU,CAAC,QAAQ,CAC9B,EAAE,IAAI,EAAE,8BAAuB,IAAI,CAAE,EAAE,KAAK,EAAE,oBAAa,IAAI,CAAE,EAAE,EACnE,EAAE,IAAI,EAAE,GAAG,EAAE,CACd,CAAC;IAEF,kBAAkB;IAClB,IAAM,MAAM,GAAG,eAAK,CAAC,YAAY,CAC/B,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EACtC,GAAG,CACJ,CAAC;IAEF,kBAAkB;IAClB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpB,MAAM,CAAC,EAAE,CACP,WAAW,EACX;QACE,OAAO,CAAC,GAAG,CAAC,gCAAyB,IAAI,CAAE,CAAC,CAAC;IAC/C,CAAC,CACF,CAAC;IACF,MAAM,CAAC,EAAE,CACP,OAAO,EACP,UAAC,GAAG;QACF,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YACtC,OAAO,CAAC,GAAG,CAAC,iBAAU,IAAI,wDAAqD,CAAC,CAAC;YACjF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;QAED,OAAO,CAAC,GAAG,CAAC,iEAA0D,GAAG,CAAC,OAAO,CAAE,CAAC,CAAC;QACrF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,KAAK,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "caccl-dev-server",
+  "version": "2.0.0-beta.10",
+  "description": "HTTPS server for development of CACCL apps",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "tsc --project ./tsconfig.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harvard-edtech/caccl-dev-server.git"
+  },
+  "keywords": [
+    "CACCL",
+    "Server",
+    "HTTPS"
+  ],
+  "author": "Gabe Abrams <gabeabrams@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/harvard-edtech/caccl-dev-server/issues"
+  },
+  "homepage": "https://github.com/harvard-edtech/caccl-dev-server#readme",
+  "devDependencies": {
+    "typescript": "^4.6.2"
+  },
+  "dependencies": {
+    "@types/express": "^4.17.13",
+    "express": "^4.17.3",
+    "https": "^1.0.0",
+    "selfsigned": "^2.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,57 @@
+import express from 'express';
+import selfsigned from 'selfsigned';
+import https from 'https';
+
+/**
+ * Serve an express app on the given port. Uses HTTPS and a self-signed
+ *   certificate
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.app the express app to serve
+ * @param [opts.port=8080] port number to serve on
+ */
+const serve = (
+  opts: {
+    app: express.Application,
+    port: number,
+  },
+) => {
+  // Destructure opts
+  const { app } = opts;
+  const port = (opts.port ?? 8080);
+
+  // Generate certs
+  const pems = selfsigned.generate(
+    { name: `CACCL Dev Server on ${port}`, value: `localhost:${port}` },
+    { days: 365 },
+  );
+
+  // Create a server
+  const server = https.createServer(
+    { key: pems.private, cert: pems.cert },
+    app,
+  );
+
+  // Start listening
+  server.listen(port);
+  server.on(
+    'listening', 
+    () => {
+      console.log(`Now listening on port ${port}`);
+    },
+  );
+  server.on(
+    'error',
+    (err) => {
+      if (err.message.includes('EADDRINUSE')) {
+        console.log(`\nPort ${port} is already in use. Is another app already running?`);
+        process.exit(0);
+      }
+
+      console.log(`\nCould not start simulator because an error occurred: ${err.message}`);
+      process.exit(0);
+    },
+  );
+};
+
+export default serve;

package/src/selfsigned.d.ts

@@ -0,0 +1,8 @@
+type gen = {
+  default: (attrs: any, config: { days: number }) => { private: string, public: string, cert: string }
+}
+
+declare module 'selfsigned' {
+  const x: any;
+  export default x;
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "noImplicitAny": true,
+    "noEmitOnError": true,
+    "removeComments": false,
+    "declaration": true,
+    "sourceMap": true,
+    "target": "es5",
+    "outDir": "./lib"
+  },
+  "include": [
+    "./src"
+  ],
+  "ts-node": {
+    "files": true
+  }
+}