dce-expresskit 4.0.0-beta-logreviewer.1

package/lib/helpers/dataSigner.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Sign a request and get the new request params
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.method the method to sign
+ * @param opts.path the http request path
+ * @param opts.params the data in the body to sign
+ * @param opts.key the dcekit key to sign with
+ * @param opts.secret the dcekit secret to sign with
+ * @return augmented params for the request, including a signature, timestamp, and key
+ */
+export declare const signRequest: (opts: {
+    method: string;
+    path: string;
+    params: {
+        [key: string]: any;
+    };
+    key: string;
+    secret: string;
+}) => Promise<{
+    [key: string]: any;
+}>;
+/**
+ * Validate a signed request. Throws an error if invalid
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.method the method of the data validate
+ * @param opts.path the http request path to validate
+ * @param opts.scope the name of the scope to validate
+ * @param opts.params the request data to validate
+ * @returns parsed and validated params
+ */
+export declare const validateSignedRequest: (opts: {
+    method: string;
+    path: string;
+    scope: string;
+    params: {
+        [key: string]: any;
+    };
+}) => Promise<void>;

package/lib/helpers/dataSigner.js

@@ -0,0 +1,242 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSignedRequest = exports.signRequest = void 0;
+// Import dce-reactkit
+var dce_reactkit_1 = require("dce-reactkit");
+// Import oauth
+var oauth_signature_1 = __importDefault(require("oauth-signature"));
+// Import crypto
+var crypto_1 = __importDefault(require("crypto"));
+// Import shared helpers
+var initServer_1 = require("./initServer");
+// Import shared types
+var ExpressKitErrorCode_1 = __importDefault(require("../types/ExpressKitErrorCode"));
+/*------------------------------------------------------------------------*/
+/* ------------------------------- Helpers ------------------------------ */
+/*------------------------------------------------------------------------*/
+/**
+ * Generate an oauth signature
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.method the http method
+ * @param opts.path the http request path
+ * @param opts.params the data in the body to sign
+ * @param opts.secret the secret to sign with
+ * @return the signature
+ */
+var genSignature = function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+    var method, path, params, secret, keys, orderedParams;
+    return __generator(this, function (_a) {
+        method = opts.method, path = opts.path, params = opts.params, secret = opts.secret;
+        keys = Object.keys(params !== null && params !== void 0 ? params : {});
+        keys.sort();
+        orderedParams = {};
+        keys.forEach(function (key) {
+            // Skip oauth_signature
+            if (key === 'oauth_signature') {
+                return;
+            }
+            // Add the param
+            orderedParams[key] = (params !== null && params !== void 0 ? params : {})[key];
+        });
+        // Generate the signature
+        return [2 /*return*/, decodeURIComponent(oauth_signature_1.default.generate(method !== null && method !== void 0 ? method : 'GET', path !== null && path !== void 0 ? path : 'no-path', orderedParams, secret))];
+    });
+}); };
+/**
+ * Decrypt an encrypted string using a secret
+ * @author Gabe Abrams
+ * @param str the encrypted string
+ * @return the decrypted string
+ */
+var decrypt = function (encryptedPack) { return __awaiter(void 0, void 0, void 0, function () {
+    var DCEKIT_CRED_ENCODING_SALT, _a, ciphertext, iv, tag, decipher, str;
+    return __generator(this, function (_b) {
+        DCEKIT_CRED_ENCODING_SALT = process.env.DCEKIT_CRED_ENCODING_SALT;
+        if (!DCEKIT_CRED_ENCODING_SALT) {
+            throw new dce_reactkit_1.ErrorWithCode('Could not decrypt a string because the encryption salt was not set.', ExpressKitErrorCode_1.default.CrossServerNoCredentialEncodingSalt);
+        }
+        _a = JSON.parse(decodeURIComponent(encryptedPack)), ciphertext = _a.ciphertext, iv = _a.iv, tag = _a.tag;
+        decipher = crypto_1.default.createDecipheriv('aes-256-gcm', Buffer.from(DCEKIT_CRED_ENCODING_SALT, 'base64'), Buffer.from(iv, 'base64'));
+        // Set the authentication tag
+        decipher.setAuthTag(Buffer.from(tag, 'base64'));
+        str = decipher.update(ciphertext, 'base64', 'utf8');
+        str += decipher.final('utf8');
+        // Return the decrypted string
+        return [2 /*return*/, str];
+    });
+}); };
+/*------------------------------------------------------------------------*/
+/* ------------------------------- Signing ------------------------------ */
+/*------------------------------------------------------------------------*/
+/**
+ * Sign a request and get the new request params
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.method the method to sign
+ * @param opts.path the http request path
+ * @param opts.params the data in the body to sign
+ * @param opts.key the dcekit key to sign with
+ * @param opts.secret the dcekit secret to sign with
+ * @return augmented params for the request, including a signature, timestamp, and key
+ */
+var signRequest = function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+    var method, path, params, key, secret, augmentedParams, signature;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                method = opts.method.toUpperCase();
+                path = opts.path, params = opts.params, key = opts.key, secret = opts.secret;
+                augmentedParams = __assign(__assign({}, params), { oauth_consumer_key: key, oauth_nonce: Math.random().toString(36), oauth_timestamp: Date.now() });
+                return [4 /*yield*/, genSignature({
+                        method: method,
+                        path: path,
+                        params: params,
+                        secret: secret,
+                    })];
+            case 1:
+                signature = _a.sent();
+                // Add signature to the augmented params
+                augmentedParams.oauth_signature = signature;
+                // Return the augmented params
+                return [2 /*return*/, augmentedParams];
+        }
+    });
+}); };
+exports.signRequest = signRequest;
+/**
+ * Validate a signed request. Throws an error if invalid
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.method the method of the data validate
+ * @param opts.path the http request path to validate
+ * @param opts.scope the name of the scope to validate
+ * @param opts.params the request data to validate
+ * @returns parsed and validated params
+ */
+var validateSignedRequest = function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+    var signature, timestamp, key, method, path, params, scope, crossServerCredentialCollection, crossServerCredentialMatches, crossServerCredential, allowedScopes, secret, paramsToSign, expectedSignature, elapsedMs;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                /* ---------- Collect Info ---------- */
+                // Get the signature
+                if (!opts.params.oauth_signature) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request there was no oauth signature.', ExpressKitErrorCode_1.default.CrossServerMissingSignedRequestInfo);
+                }
+                signature = opts.params.oauth_signature;
+                // Get the timestamp
+                if (
+                // No timestamp
+                !opts.params.oauth_timestamp
+                    // Invalid timestamp
+                    || Number.isNaN(Number.parseInt(opts.params.oauth_timestamp, 10))) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request there was no valid oauth timestamp.', ExpressKitErrorCode_1.default.CrossServerMissingSignedRequestInfo);
+                }
+                timestamp = Number.parseInt(opts.params.oauth_timestamp, 10);
+                // Get the key
+                if (!opts.params.oauth_consumer_key) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request there was no oauth consumer key.', ExpressKitErrorCode_1.default.CrossServerMissingSignedRequestInfo);
+                }
+                key = opts.params.oauth_consumer_key;
+                method = opts.method, path = opts.path, params = opts.params, scope = opts.scope;
+                crossServerCredentialCollection = (0, initServer_1.internalGetCrossServerCredentialCollection)();
+                if (!crossServerCredentialCollection) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request because the cross-server credential collection was not ready in time.', ExpressKitErrorCode_1.default.SignedRequestInvalidCollection);
+                }
+                return [4 /*yield*/, crossServerCredentialCollection.find({ key: key })];
+            case 1:
+                crossServerCredentialMatches = _a.sent();
+                if (!crossServerCredentialMatches || crossServerCredentialMatches.length === 0) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request because the credential was not found.', ExpressKitErrorCode_1.default.SignedRequestInvalidCredential);
+                }
+                crossServerCredential = crossServerCredentialMatches[0];
+                allowedScopes = crossServerCredential.scopes;
+                if (!allowedScopes || !Array.isArray(allowedScopes)) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request because the credential does not have access to any scopes.', ExpressKitErrorCode_1.default.SignedRequestInvalidScope);
+                }
+                if (!allowedScopes.includes(scope)) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request because the required scope was not approved for the credential.', ExpressKitErrorCode_1.default.SignedRequestInvalidScope);
+                }
+                return [4 /*yield*/, decrypt(crossServerCredential.encodedeSecret)];
+            case 2:
+                secret = _a.sent();
+                paramsToSign = __assign({}, params);
+                Object.keys(paramsToSign).forEach(function (key) {
+                    // Delete oauth params
+                    if (key.startsWith('oauth_')) {
+                        delete paramsToSign[key];
+                    }
+                });
+                return [4 /*yield*/, genSignature({
+                        method: method,
+                        path: path,
+                        params: paramsToSign,
+                        secret: secret,
+                    })];
+            case 3:
+                expectedSignature = _a.sent();
+                // Make sure the signatures match
+                if (signature !== expectedSignature) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request because the signature did not match.', ExpressKitErrorCode_1.default.SignedRequestInvalidSignature);
+                }
+                elapsedMs = Math.abs(Date.now() - timestamp);
+                if (elapsedMs > dce_reactkit_1.MINUTE_IN_MS) {
+                    throw new dce_reactkit_1.ErrorWithCode('Could not validate a cross-server request because the request was too old.', ExpressKitErrorCode_1.default.SignedRequestInvalidTimestamp);
+                }
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.validateSignedRequest = validateSignedRequest;
+//# sourceMappingURL=dataSigner.js.map

package/lib/helpers/dataSigner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataSigner.js","sourceRoot":"","sources":["../../src/helpers/dataSigner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sBAAsB;AACtB,6CAGsB;AAEtB,eAAe;AACf,oEAAoC;AAEpC,gBAAgB;AAChB,kDAA4B;AAE5B,wBAAwB;AACxB,2CAA0E;AAE1E,sBAAsB;AACtB,qFAA+D;AAG/D,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E;;;;;;;;;GASG;AACH,IAAM,YAAY,GAAG,UACnB,IAKC;;;QAIC,MAAM,GAIJ,IAAI,OAJA,EACN,IAAI,GAGF,IAAI,KAHF,EACJ,MAAM,GAEJ,IAAI,OAFA,EACN,MAAM,GACJ,IAAI,OADA,CACC;QAGH,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;QACN,aAAa,GAEf,EAAE,CAAC;QACP,IAAI,CAAC,OAAO,CAAC,UAAC,GAAG;YACf,uBAAuB;YACvB,IAAI,GAAG,KAAK,iBAAiB,EAAE,CAAC;gBAC9B,OAAO;YACT,CAAC;YAED,gBAAgB;YAChB,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,yBAAyB;QACzB,sBAAO,kBAAkB,CAAC,yBAAK,CAAC,QAAQ,CACtC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,EACf,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,SAAS,EACjB,aAAa,EACb,MAAM,CACP,CAAC,EAAC;;KACJ,CAAC;AAEF;;;;;GAKG;AACH,IAAM,OAAO,GAAG,UACd,aAAqB;;;QAMb,yBAAyB,GAAK,OAAO,CAAC,GAAG,0BAAhB,CAAiB;QAClD,IAAI,CAAC,yBAAyB,EAAE,CAAC;YAC/B,MAAM,IAAI,4BAAa,CACrB,qEAAqE,EACrE,6BAAmB,CAAC,mCAAmC,CACxD,CAAC;QACJ,CAAC;QAGK,KAIF,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC,EAH/C,UAAU,gBAAA,EACV,EAAE,QAAA,EACF,GAAG,SAAA,CAC6C;QAG5C,QAAQ,GAAG,gBAAM,CAAC,gBAAgB,CACtC,aAAa,EACb,MAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE,QAAQ,CAAC,EAChD,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAC1B,CAAC;QAEF,6BAA6B;QAC7B,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;QAG5C,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxD,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE9B,8BAA8B;QAC9B,sBAAO,GAAG,EAAC;;KACZ,CAAC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E;;;;;;;;;;GAUG;AACI,IAAM,WAAW,GAAG,UACzB,IAMC;;;;;gBAGK,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAEvC,IAAI,GAIF,IAAI,KAJF,EACJ,MAAM,GAGJ,IAAI,OAHA,EACN,GAAG,GAED,IAAI,IAFH,EACH,MAAM,GACJ,IAAI,OADA,CACC;gBAGH,eAAe,yBAGhB,MAAM,KACT,kBAAkB,EAAE,GAAG,EACvB,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EACvC,eAAe,EAAE,IAAI,CAAC,GAAG,EAAE,GAC5B,CAAC;gBAGgB,qBAAM,YAAY,CAAC;wBACnC,MAAM,QAAA;wBACN,IAAI,MAAA;wBACJ,MAAM,QAAA;wBACN,MAAM,QAAA;qBACP,CAAC,EAAA;;gBALI,SAAS,GAAG,SAKhB;gBAEF,wCAAwC;gBACxC,eAAe,CAAC,eAAe,GAAG,SAAS,CAAC;gBAG5C,8BAA8B;gBAC9B,sBAAO,eAAe,EAAC;;;KACxB,CAAC;AA1CW,QAAA,WAAW,eA0CtB;AAEF;;;;;;;;;GASG;AACI,IAAM,qBAAqB,GAAG,UACnC,IAKC;;;;;gBAED,wCAAwC;gBAExC,oBAAoB;gBACpB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;oBACjC,MAAM,IAAI,4BAAa,CACrB,yEAAyE,EACzE,6BAAmB,CAAC,mCAAmC,CACxD,CAAC;gBACJ,CAAC;gBACK,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;gBAE9C,oBAAoB;gBACpB;gBACE,eAAe;gBACf,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe;oBAC5B,oBAAoB;uBACjB,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,EACjE,CAAC;oBACD,MAAM,IAAI,4BAAa,CACrB,+EAA+E,EAC/E,6BAAmB,CAAC,mCAAmC,CACxD,CAAC;gBACJ,CAAC;gBACK,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;gBAEnE,cAAc;gBACd,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC;oBACpC,MAAM,IAAI,4BAAa,CACrB,4EAA4E,EAC5E,6BAAmB,CAAC,mCAAmC,CACxD,CAAC;gBACJ,CAAC;gBACK,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAIzC,MAAM,GAIJ,IAAI,OAJA,EACN,IAAI,GAGF,IAAI,KAHF,EACJ,MAAM,GAEJ,IAAI,OAFA,EACN,KAAK,GACH,IAAI,MADD,CACE;gBAKH,+BAA+B,GAAG,IAAA,uDAA0C,GAAE,CAAC;gBACrF,IAAI,CAAC,+BAA+B,EAAE,CAAC;oBACrC,MAAM,IAAI,4BAAa,CACrB,iHAAiH,EACjH,6BAAmB,CAAC,8BAA8B,CACnD,CAAC;gBACJ,CAAC;gBAG6D,qBAAM,+BAA+B,CAAC,IAAI,CAAC,EAAE,GAAG,KAAA,EAAE,CAAC,EAAA;;gBAA3G,4BAA4B,GAA4B,SAAmD;gBACjH,IAAI,CAAC,4BAA4B,IAAI,4BAA4B,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC/E,MAAM,IAAI,4BAAa,CACrB,iFAAiF,EACjF,6BAAmB,CAAC,8BAA8B,CACnD,CAAC;gBACJ,CAAC;gBACK,qBAAqB,GAAG,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAGxD,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC;gBACnD,IAAI,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;oBACpD,MAAM,IAAI,4BAAa,CACrB,sGAAsG,EACtG,6BAAmB,CAAC,yBAAyB,CAC9C,CAAC;gBAEJ,CAAC;gBACD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACnC,MAAM,IAAI,4BAAa,CACrB,2GAA2G,EAC3G,6BAAmB,CAAC,yBAAyB,CAC9C,CAAC;gBACJ,CAAC;gBAGc,qBAAM,OAAO,CAAC,qBAAqB,CAAC,cAAc,CAAC,EAAA;;gBAA5D,MAAM,GAAG,SAAmD;gBAK5D,YAAY,gBAGb,MAAM,CACV,CAAC;gBACF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,UAAC,GAAG;oBACpC,sBAAsB;oBACtB,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC7B,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;oBAC3B,CAAC;gBACH,CAAC,CAAC,CAAC;gBAGuB,qBAAM,YAAY,CAAC;wBAC3C,MAAM,QAAA;wBACN,IAAI,MAAA;wBACJ,MAAM,EAAE,YAAY;wBACpB,MAAM,QAAA;qBACP,CAAC,EAAA;;gBALI,iBAAiB,GAAG,SAKxB;gBAEF,iCAAiC;gBACjC,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;oBACpC,MAAM,IAAI,4BAAa,CACrB,gFAAgF,EAChF,6BAAmB,CAAC,6BAA6B,CAClD,CAAC;gBACJ,CAAC;gBAGK,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;gBACnD,IAAI,SAAS,GAAG,2BAAY,EAAE,CAAC;oBAC7B,MAAM,IAAI,4BAAa,CACrB,4EAA4E,EAC5E,6BAAmB,CAAC,6BAA6B,CAClD,CAAC;gBACJ,CAAC;;;;KACF,CAAC;AAjIW,QAAA,qBAAqB,yBAiIhC"}

package/lib/helpers/genRouteHandler.d.ts

@@ -0,0 +1,75 @@
+import { LogFunction, ParamType } from 'dce-reactkit';
+/**
+ * Generate an express API route handler
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.paramTypes map containing the types for each parameter that is
+ *   included in the request (map: param name => type)
+ * @param opts.handler function that processes the request
+ * @param [opts.crossServerScope] the scope associated with this endpoint.
+ *   If defined, this is a cross-server endpoint, which will never
+ *   have any launch data, will never check Canvas roles or launch status, and will
+ *   instead use scopes and reactkit credentials to sign and validate requests.
+ *   Never start the path with /api/ttm or /api/admin if the endpoint is a cross-server
+ *   endpoint because those roles will not be validated
+ * @param [opts.skipSessionCheck=true if crossServerScope defined] if true, skip
+ *   the session check (allow users to not be logged in and launched via LTI).
+ *   If crossServerScope is defined, this is always true
+ * @param [opts.unhandledErrorMessagePrefix] if included, when an error that
+ *   is not of type ErrorWithCode is thrown, the client will receive an error
+ *   where the error message is prefixed with this string. For example,
+ *   if unhandledErrorMessagePrefix is
+ *   'While saving progress, we encountered an error:'
+ *   and the error is 'progressInfo is not an object',
+ *   the client will receive an error with the message
+ *   'While saving progress, we encountered an error: progressInfo is not an object'
+ * @returns express route handler that takes the following arguments:
+ *   params (map: param name => value),
+ *   req (express request object),
+ *   next (express next function),
+ *   send (a function that sends a string to the client),
+ *   redirect (takes a url and redirects the user to that url),
+ *   renderErrorPage (shows a static error page to the user),
+ *   renderInfoPage (shows a static info page to the user),
+ *   renderCustomHTML (renders custom html and sends it to the user),
+ *   and returns the value to send to the client as a JSON API response, or
+ *   calls next() or redirect(...) or send(...) or renderErrorPage(...).
+ *   Note: params also has userId, userFirstName,
+ *   userLastName, userEmail, userAvatarURL, isLearner, isTTM, isAdmin,
+ *   and any other variables that
+ *   are directly added to the session, if the user does have a session.
+ */
+declare const genRouteHandler: (opts: {
+    paramTypes?: {
+        [k: string]: ParamType;
+    };
+    handler: (opts: {
+        params: {
+            [k: string]: any;
+        };
+        req: any;
+        next: () => void;
+        redirect: (pathOrURL: string) => void;
+        send: (text: string, status?: number) => void;
+        renderErrorPage: (opts?: {
+            title?: string;
+            description?: string;
+            code?: string;
+            pageTitle?: string;
+            status?: number;
+        }) => void;
+        renderInfoPage: (opts: {
+            title: string;
+            body: string;
+        }) => void;
+        renderCustomHTML: (opts: {
+            html: string;
+            status?: number;
+        }) => void;
+        logServerEvent: LogFunction;
+    }) => any;
+    crossServerScope?: string;
+    skipSessionCheck?: boolean;
+    unhandledErrorMessagePrefix?: string;
+}) => (req: any, res: any, next: () => void) => Promise<undefined>;
+export default genRouteHandler;