caccl-send-request 2.0.0-beta.0 → 2.0.0-beta.10

package/README.md

@@ -8,12 +8,6 @@ The default request sender used throughout the CACCL project.
 **C**onnection  
 **L**ibrary  
 
-## Overriding caccl-send-request
-
-Throughout the `caccl` project, the default sendRequest function is this `caccl-send-request` module.
-
-However, if you want to override the sendRequest function, just create your own function that follows the description below. Your function should follow our description _exactly_, including sending of cross-origin credentials.
-
 ## Description
 
 Sends an http request, handles paging, retries failed requests, and processes the response.
@@ -28,7 +22,7 @@ headers | object | headers to include in the request | {}
 numRetries | number | number of times to retry the request if it fails | 0
 ignoreSSLIssues | boolean | if true, ignores self-signed certificate issues | false usually, true if host is `localhost:8088`
 
-Returns:  
+Returns:
 `Promise.<CACCLError|object>` Returns promise that resolves with `{ body, status, headers }` on success, rejects with CACCLError (see `caccl-error` on npm) on failure.
 
-**Note:** This function sends cross-origin credentials if `process.env.DEV` is true or if `process.env.NODE_ENV` equals `development`.
+**Note:** This function sends cross-origin credentials if `process.env.NODE_ENV` equals `development`.

package/lib/index.d.ts

@@ -2,20 +2,20 @@
  * Sends and retries an http request
  * @author Gabriel Abrams
  * @param opts object containing all arguments
- * @param opts.host host to send request to
  * @param opts.path path to send request to
+ * @param [opts.host] host to send request to
  * @param [opts.method=GET] http method to use
  * @param [opts.params] body/data to include in the request
  * @param [opts.headers] headers to include in the request
  * @param [opts.numRetries=0] number of times to retry the request if it
  *   fails
- * @param [opts.ignoreSSLIssues=false] if true, ignores SSL certificate
+ * @param [opts.ignoreSSLIssues] if true, ignores SSL certificate
  *   issues. If host is localhost:8088, this will default to true
- * @returns Returns { body, status, headers } on success
+ * @returns { body, status, headers } on success
  */
 declare const sendRequest: (opts: {
-    host: string;
     path: string;
+    host?: string;
     method?: ('GET' | 'POST' | 'PUT' | 'DELETE');
     params?: {
         [x: string]: any;

package/lib/index.js

@@ -53,32 +53,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // Import libs
 var axios_1 = __importDefault(require("axios"));
 var qs_1 = __importDefault(require("qs"));
+// Import other CACCL libs
 var caccl_error_1 = __importDefault(require("caccl-error"));
-var https_1 = __importDefault(require("https"));
 // Import shared types
 var ErrorCode_1 = __importDefault(require("./ErrorCode"));
-// Create an agent to ignore unauthorize ssl issues
-var ignoreSSLIssuesAgent = new https_1.default.Agent({ rejectUnauthorized: false });
 // Check if we should send cross-domain credentials
-var sendCrossDomainCredentials = !!(process.env.DEV
-    || process.env.NODE_ENV === 'development');
+var sendCrossDomainCredentials = (process.env.NODE_ENV === 'development');
 /**
  * Sends and retries an http request
  * @author Gabriel Abrams
  * @param opts object containing all arguments
- * @param opts.host host to send request to
  * @param opts.path path to send request to
+ * @param [opts.host] host to send request to
  * @param [opts.method=GET] http method to use
  * @param [opts.params] body/data to include in the request
  * @param [opts.headers] headers to include in the request
  * @param [opts.numRetries=0] number of times to retry the request if it
  *   fails
- * @param [opts.ignoreSSLIssues=false] if true, ignores SSL certificate
+ * @param [opts.ignoreSSLIssues] if true, ignores SSL certificate
  *   issues. If host is localhost:8088, this will default to true
- * @returns Returns { body, status, headers } on success
+ * @returns { body, status, headers } on success
  */
 var sendRequest = function (opts) { return __awaiter(void 0, void 0, void 0, function () {
-    var numRetries, method, stringifiedParams, query, url, ignoreSSLIssues, httpsAgent, headers, data, response, err_1;
+    var numRetries, method, stringifiedParams, query, url, ignoreSSLIssues, headers, data, response, err_1;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
@@ -99,9 +96,6 @@ var sendRequest = function (opts) { return __awaiter(void 0, void 0, void 0, fun
                 ignoreSSLIssues = (opts.ignoreSSLIssues !== undefined
                     ? opts.ignoreSSLIssues
                     : opts.host === 'localhost:8088');
-                httpsAgent = (ignoreSSLIssues
-                    ? ignoreSSLIssuesAgent
-                    : undefined);
                 headers = opts.headers || {};
                 data = null;
                 if (!headers['Content-Type']) {
@@ -121,7 +115,6 @@ var sendRequest = function (opts) { return __awaiter(void 0, void 0, void 0, fun
                         method: method,
                         url: url,
                         data: data,
-                        httpsAgent: httpsAgent,
                         headers: headers,
                         withCredentials: sendCrossDomainCredentials,
                     })];

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,gDAA0B;AAC1B,0CAAoB;AACpB,4DAAqC;AACrC,gDAA0B;AAE1B,sBAAsB;AACtB,0DAAoC;AAEpC,mDAAmD;AACnD,IAAM,oBAAoB,GAAG,IAAI,eAAK,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC;AAE5E,mDAAmD;AACnD,IAAM,0BAA0B,GAAG,CAAC,CAAC,CACnC,OAAO,CAAC,GAAG,CAAC,GAAG;OACZ,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,CAC1C,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,IAAM,WAAW,GAAG,UAClB,IAQC;;;;;gBAOK,UAAU,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAGrD,MAAM,GAAwC,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;gBAGrE,iBAAiB,GAAG,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE;oBACxD,gBAAgB,EAAE,IAAI;oBACtB,WAAW,EAAE,UAAU;iBACxB,CAAC,CAAC;gBAGG,KAAK,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,WAAI,iBAAiB,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAEhE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;oBACd,+CAA+C;oBAC/C,GAAG,GAAG,UAAG,IAAI,CAAC,IAAI,SAAG,KAAK,CAAE,CAAC;iBAC9B;qBAAM;oBACL,GAAG,GAAG,kBAAW,IAAI,CAAC,IAAI,SAAG,IAAI,CAAC,IAAI,SAAG,KAAK,CAAE,CAAC;iBAClD;gBAGK,eAAe,GAAG,CACtB,IAAI,CAAC,eAAe,KAAK,SAAS;oBAChC,CAAC,CAAC,IAAI,CAAC,eAAe;oBACtB,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,CACnC,CAAC;gBAGI,UAAU,GAAG,CACjB,eAAe;oBACb,CAAC,CAAC,oBAAoB;oBACtB,CAAC,CAAC,SAAS,CACd,CAAC;gBAGI,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;gBAC/B,IAAI,GAAG,IAAI,CAAC;gBAChB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;oBAC5B,eAAe;oBACf,OAAO,CAAC,cAAc,CAAC,GAAG,mCAAmC,CAAC;oBAC9D,yBAAyB;oBACzB,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;iBACtD;qBAAM;oBACL,cAAc;oBACd,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;iBACpB;;;;gBAIkB,qBAAM,IAAA,eAAK,EAAC;wBAC3B,MAAM,QAAA;wBACN,GAAG,KAAA;wBACH,IAAI,MAAA;wBACJ,UAAU,YAAA;wBACV,OAAO,SAAA;wBACP,eAAe,EAAE,0BAA0B;qBAC5C,CAAC,EAAA;;gBAPI,QAAQ,GAAG,SAOf;gBAEF,mBAAmB;gBACnB,sBAAO;wBACL,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,MAAM,EAAE,QAAQ,CAAC,MAAM;wBACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;qBAC1B,EAAC;;;gBAEF,iEAAiE;gBACjE,0EAA0E;gBAC1E,wCAAwC;gBACxC,IAAI,KAAG,CAAC,QAAQ,EAAE;oBAChB,wBAAwB;oBACxB,sBAAO;4BACL,IAAI,EAAE,KAAG,CAAC,QAAQ,CAAC,IAAI;4BACvB,MAAM,EAAE,KAAG,CAAC,QAAQ,CAAC,MAAM;4BAC3B,OAAO,EAAE,KAAG,CAAC,QAAQ,CAAC,OAAO;yBAC9B,EAAC;iBACH;gBAED,iDAAiD;gBACjD,IAAI,UAAU,GAAG,CAAC,EAAE;oBAClB,kCAAkC;oBAClC,sBAAO,WAAW,uBACb,IAAI,KACP,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,CAAC,IAC/B,EAAC;iBACJ;gBAED,iCAAiC;gBACjC,IAAI,KAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE;oBACnD,MAAM,IAAI,qBAAU,CAAC;wBACnB,OAAO,EAAE,iFAAiF;wBAC1F,IAAI,EAAE,mBAAS,CAAC,UAAU;qBAC3B,CAAC,CAAC;iBACJ;gBAED,gBAAgB;gBAChB,MAAM,IAAI,qBAAU,CAAC;oBACnB,OAAO,EAAE,0GAA0G;oBACnH,IAAI,EAAE,mBAAS,CAAC,YAAY;iBAC7B,CAAC,CAAC;;;;KAEN,CAAC;AAEF,kBAAe,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,gDAA0B;AAC1B,0CAAoB;AAEpB,0BAA0B;AAC1B,4DAAqC;AAErC,sBAAsB;AACtB,0DAAoC;AAEpC,mDAAmD;AACnD,IAAM,0BAA0B,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,CAAC,CAAC;AAE5E;;;;;;;;;;;;;;GAcG;AACH,IAAM,WAAW,GAAG,UAClB,IAQC;;;;;gBAOK,UAAU,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAGrD,MAAM,GAAwC,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;gBAGrE,iBAAiB,GAAG,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE;oBACxD,gBAAgB,EAAE,IAAI;oBACtB,WAAW,EAAE,UAAU;iBACxB,CAAC,CAAC;gBAGG,KAAK,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,WAAI,iBAAiB,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAEhE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;oBACd,+CAA+C;oBAC/C,GAAG,GAAG,UAAG,IAAI,CAAC,IAAI,SAAG,KAAK,CAAE,CAAC;iBAC9B;qBAAM;oBACL,GAAG,GAAG,kBAAW,IAAI,CAAC,IAAI,SAAG,IAAI,CAAC,IAAI,SAAG,KAAK,CAAE,CAAC;iBAClD;gBAGK,eAAe,GAAG,CACtB,IAAI,CAAC,eAAe,KAAK,SAAS;oBAChC,CAAC,CAAC,IAAI,CAAC,eAAe;oBACtB,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,CACnC,CAAC;gBAGI,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;gBAC/B,IAAI,GAAG,IAAI,CAAC;gBAChB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;oBAC5B,eAAe;oBACf,OAAO,CAAC,cAAc,CAAC,GAAG,mCAAmC,CAAC;oBAC9D,yBAAyB;oBACzB,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;iBACtD;qBAAM;oBACL,cAAc;oBACd,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;iBACpB;;;;gBAIkB,qBAAM,IAAA,eAAK,EAAC;wBAC3B,MAAM,QAAA;wBACN,GAAG,KAAA;wBACH,IAAI,MAAA;wBACJ,OAAO,SAAA;wBACP,eAAe,EAAE,0BAA0B;qBAC5C,CAAC,EAAA;;gBANI,QAAQ,GAAG,SAMf;gBAEF,mBAAmB;gBACnB,sBAAO;wBACL,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,MAAM,EAAE,QAAQ,CAAC,MAAM;wBACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;qBAC1B,EAAC;;;gBAEF,iEAAiE;gBACjE,0EAA0E;gBAC1E,wCAAwC;gBACxC,IAAI,KAAG,CAAC,QAAQ,EAAE;oBAChB,wBAAwB;oBACxB,sBAAO;4BACL,IAAI,EAAE,KAAG,CAAC,QAAQ,CAAC,IAAI;4BACvB,MAAM,EAAE,KAAG,CAAC,QAAQ,CAAC,MAAM;4BAC3B,OAAO,EAAE,KAAG,CAAC,QAAQ,CAAC,OAAO;yBAC9B,EAAC;iBACH;gBAED,iDAAiD;gBACjD,IAAI,UAAU,GAAG,CAAC,EAAE;oBAClB,kCAAkC;oBAClC,sBAAO,WAAW,uBACb,IAAI,KACP,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,CAAC,IAC/B,EAAC;iBACJ;gBAED,iCAAiC;gBACjC,IAAI,KAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE;oBACnD,MAAM,IAAI,qBAAU,CAAC;wBACnB,OAAO,EAAE,iFAAiF;wBAC1F,IAAI,EAAE,mBAAS,CAAC,UAAU;qBAC3B,CAAC,CAAC;iBACJ;gBAED,gBAAgB;gBAChB,MAAM,IAAI,qBAAU,CAAC;oBACnB,OAAO,EAAE,0GAA0G;oBACnH,IAAI,EAAE,mBAAS,CAAC,YAAY;iBAC7B,CAAC,CAAC;;;;KAEN,CAAC;AAEF,kBAAe,WAAW,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "caccl-send-request",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.10",
   "description": "The default request sender used throughout the CACCL project.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -26,6 +26,7 @@
   },
   "homepage": "https://github.com/harvard-edtech/caccl-send-request#readme",
   "devDependencies": {
+    "@types/browserify": "^12.0.37",
     "@types/node": "^17.0.17",
     "@types/qs": "^6.9.7",
     "eslint": "^8.9.0",
@@ -36,9 +37,8 @@
     "typescript": "^4.5.5"
   },
   "dependencies": {
-    "axios": "^0.21.1",
-    "caccl-error": "^2.0.0-beta.0",
-    "https": "^1.0.0",
+    "axios": "^0.21.4",
+    "caccl-error": "^2.0.0-beta.10",
     "qs": "^6.9.6"
   }
 }

package/src/index.ts

@@ -1,40 +1,35 @@
 // Import libs
 import axios from 'axios';
 import qs from 'qs';
+
+// Import other CACCL libs
 import CACCLError from 'caccl-error';
-import https from 'https';
 
 // Import shared types
 import ErrorCode from './ErrorCode';
 
-// Create an agent to ignore unauthorize ssl issues
-const ignoreSSLIssuesAgent = new https.Agent({ rejectUnauthorized: false });
-
 // Check if we should send cross-domain credentials
-const sendCrossDomainCredentials = !!(
-  process.env.DEV
-  || process.env.NODE_ENV === 'development'
-);
+const sendCrossDomainCredentials = (process.env.NODE_ENV === 'development');
 
 /**
  * Sends and retries an http request
  * @author Gabriel Abrams
  * @param opts object containing all arguments
- * @param opts.host host to send request to
  * @param opts.path path to send request to
+ * @param [opts.host] host to send request to
  * @param [opts.method=GET] http method to use
  * @param [opts.params] body/data to include in the request
  * @param [opts.headers] headers to include in the request
  * @param [opts.numRetries=0] number of times to retry the request if it
  *   fails
- * @param [opts.ignoreSSLIssues=false] if true, ignores SSL certificate
+ * @param [opts.ignoreSSLIssues] if true, ignores SSL certificate
  *   issues. If host is localhost:8088, this will default to true
- * @returns Returns { body, status, headers } on success
+ * @returns { body, status, headers } on success
  */
 const sendRequest = async (
   opts: {
-    host: string,
     path: string,
+    host?: string,
     method?: ('GET' | 'POST' | 'PUT' | 'DELETE'),
     params?: { [k in string]: any },
     headers?: { [k in string]: any },
@@ -75,13 +70,6 @@ const sendRequest = async (
       : opts.host === 'localhost:8088'
   );
 
-  // Prep to ignore ssl issues
-  const httpsAgent = (
-    ignoreSSLIssues
-      ? ignoreSSLIssuesAgent
-      : undefined
-  );
-
   // Update headers
   const headers = opts.headers || {};
   let data = null;
@@ -101,7 +89,6 @@ const sendRequest = async (
       method,
       url,
       data,
-      httpsAgent,
       headers,
       withCredentials: sendCrossDomainCredentials,
     });