@63klabs/cache-data 1.3.6 → 1.3.8

package/src/lib/tools/ClientRequest.class.js

@@ -73,7 +73,6 @@ class ClientRequest extends RequestInfo {
 		apiKey: null
 	}
 
-
 	/**
 	 * Initializes the request data based on the event. Also sets the 
 	 * validity of the request so it may be checked by .isValid()
@@ -121,10 +120,20 @@ class ClientRequest extends RequestInfo {
 	 * Add ClientRequest.init(options) to the Config.init process or at the
 	 * top of the main index.js file outside of the handler.
 	 * @param {object} options - Configuration options with validations property containing referrers and parameters
+	 * @param {Array<string>} options.referrers - Array of allowed referrers
+	 * @param {object} options.parameters - Object containing parameter validation functions
 	 * @throws {Error} If options is not an object
 	 */
 	static init(options) {
 		if (typeof options === 'object') {
+			if ('referrers' in options) {
+				ClientRequest.#validations.referrers = options.referrers;
+			}
+			if ('parameters' in options) {
+				ClientRequest.#validations.parameters = options.parameters;
+			}
+
+			// Backwards compatibility - deprecated
 			if ('validations' in options) {
 				if ('referrers' in options.validations) {
 					ClientRequest.#validations.referrers = options.validations.referrers;
@@ -141,10 +150,34 @@ class ClientRequest extends RequestInfo {
 
 	};
 
+	/**
+	 * Returns the current validation rules
+	 * @returns {{referrerWhiteList<Array>}} validations
+	 */
+	static info() {
+		return {
+			referrerWhiteList: ClientRequest.getReferrerWhiteList(),
+		};
+	};
+
+	/**
+	 * Allowed referrers
+	 * @returns {Array<string>} Allowed referrers
+	 */
 	static getReferrerWhiteList() {
 		return ClientRequest.#validations.referrers;
 	};
 
+	/**
+	 * Parameter validations
+	 * @returns {{
+	 * 	pathParameters?: object,
+	 * 	queryParameters?: object,
+	 * 	headerParameters?: object,
+	 * 	cookieParameters?: object,
+	 * 	bodyParameters?: object
+	 * }}
+	 */
 	static getParameterValidations() {
 		return ClientRequest.#validations.parameters;
 	};

package/src/lib/tools/Connections.classes.js

@@ -54,7 +54,6 @@ class Connections {
 		};
 	};
 
-
 	/**
 	 * Given an object (associative array) or Connection instance, create a Connection object to add to
 	 * our collection of Connections.
@@ -88,10 +87,36 @@ class Connections {
 		return ( ( connectionName in this._connections ) ? this._connections[connectionName] : null );
 	};
 
+	/**
+	 *
+	 * @returns {Array<Connection>} An array of Connection objects
+	 */
 	toObject() {
-		return this._connections;
+		// iterate through connections and return .toObject() for each
+		const obj = {};
+		for (var key in this._connections) {
+			obj[key] = this._connections[key].toObject();
+		}
+		return obj;
 	};
 
+	/**
+	 * 
+	 * @returns {object}
+	 */
+	info() {
+		// iterate through connections and return .toObject for each
+		const obj = {};
+		for (var key in this._connections) {
+			obj[key] = this._connections[key].toObject();
+		}
+		return obj;
+	}
+
+	/**
+	 * Used by JSON.stringify
+	 * @returns {string}
+	 */
 	toJSON() {
 		// loop through the Connection objects in Connections by key and use each of their .toInfoObject() methods to generate an object
 		var obj = {};
@@ -300,7 +325,7 @@ class Connection {
 
 	/**
 	 * 
-	 * @returns object (associative array) with connection details in key/pairs
+	 * @returns {object} An object representation of the Connection object
 	 */
 	toObject() {
 		const obj = this._toObject();
@@ -321,6 +346,10 @@ class Connection {
 		return obj;
 	};
 
+	/**
+	 * 
+	 * @returns {object} An object representation of the Connection object
+	 */
 	toInfoObject() {
 		const obj = this._toObject();
 
@@ -339,10 +368,18 @@ class Connection {
 		return obj;
 	}
 
+	/**
+	 * 
+	 * @returns {string} Name of connection
+	 */
 	getName() {
 		return this._name;
 	};
 
+	/**
+	 * 
+	 * @returns {string} String of concatenated connection values
+	 */
 	toString() {
 		return `${this._name} ${this._method} ${(this._uri) ? this._uri : this._protocol+"://"+this._host+this._path}${(this._note) ? " "+this._note : ""}`;
 	};

package/src/lib/tools/Response.class.js

@@ -151,6 +151,17 @@ class Response {
 
 	};
 
+	/**
+	 * Get information about response initialization
+	 * @returns {{isInitialized: boolean, settings: Object}
+	 */
+	static info = () => {
+		return {
+			isInitialized: Response.#isInitialized,
+			settings: Response.#settings,
+		};
+	};
+
 	/**
 	 * Resets all properties of the response to default values except those specified in the object.
 	 * ClientRequest cannot be reset. Uses generic response templates based on status code.

package/src/lib/tools/generic.response.html.js

@@ -44,6 +44,24 @@ response405 = {
 	body: html("405 Method Not Allowed", "<p>Method Not Allowed</p>")
 };
 
+response408 = {
+	statusCode: 408,
+	headers: headers,
+	body: html("408 Request Timeout", "<p>Request Timeout</p>")
+};
+
+response418 = {
+	statusCode: 418,
+	headers: headers,
+	body: html("418 I'm a teapot", "<p>I'm a teapot</p>")
+};
+
+response427 = {
+	statusCode: 427,
+	headers: headers,
+	body: html("427 Too Many Requests", "<p>Too Many Requests</p>")
+};
+
 response500 = {
 	statusCode: 500,
 	headers: headers,
@@ -70,6 +88,14 @@ response = function (statusCode) {
 			return this.response403;
 		case 404:
 			return this.response404;
+		case 405:
+			return this.response405;
+		case 408:
+			return this.response408;
+		case 418:
+			return this.response418;
+		case 427:
+			return this.response427;
 		case 500:
 			return this.response500;
 		default:
@@ -82,7 +108,14 @@ module.exports = {
 	headers,
 	html,
 	response200,
+	response400,
+	response401,
+	response403,
 	response404,
+	response405,
+	response408,
+	response418,
+	response427,
 	response500,
 	response
 }

package/src/lib/tools/generic.response.json.js

@@ -56,6 +56,30 @@ response405 = {
 	}
 };
 
+response408 = {
+	statusCode: 408,
+	headers: headers,
+	body: {
+		message: "Request Timeout"
+	}
+};
+
+response418 = {
+	statusCode: 418,
+	headers: headers,
+	body: {
+		message: "I'm a teapot"
+	}
+};
+
+response427 = {
+	statusCode: 427,
+	headers: headers,
+	body: {
+		message: "Too Many Requests"
+	}
+};
+
 response500 = {
 	statusCode: 500,
 	headers: headers,
@@ -69,7 +93,7 @@ response500 = {
  * @param {number|string} statusCode 
  * @returns {{statusCode: number, headers: object, body: Array|Object|string}}
  */
-response = function (statusCode) {
+const response = function (statusCode) {
 	// convert to int
 	statusCode = parseInt(statusCode, 10);
 
@@ -84,6 +108,14 @@ response = function (statusCode) {
 			return this.response403;
 		case 404:
 			return this.response404;
+		case 405:
+			return this.response405;
+		case 408:
+			return this.response408;
+		case 418:
+			return this.response418;
+		case 427:
+			return this.response427;
 		case 500:
 			return this.response500;
 		default:
@@ -96,7 +128,14 @@ module.exports = {
 	headers,
 	json,
 	response200,
+	response400,
+	response401,
+	response403,
 	response404,
+	response405,
+	response408,
+	response418,
+	response427,
 	response500,
 	response
 }

package/src/lib/tools/generic.response.rss.js

@@ -44,6 +44,24 @@ response405 = {
 	body: rss("<error>Method Not Allowed</error>")
 };
 
+response408 = {
+	statusCode: 408,
+	headers: headers,
+	body: rss("<error>Request Timeout</error>")
+};
+
+response418 = {
+	statusCode: 418,
+	headers: headers,
+	body: rss("<error>418 I'm a teapot</error>")
+};
+
+response427 = {
+	statusCode: 427,
+	headers: headers,
+	body: rss("<error>Too Many Requests</error>")
+};
+
 response500 = {
 	statusCode: 500,
 	headers: headers,
@@ -70,6 +88,14 @@ response = function (statusCode) {
 			return this.response403;
 		case 404:
 			return this.response404;
+		case 405:
+			return this.response405;
+		case 408:
+			return this.response408;
+		case 418:
+			return this.response418;
+		case 427:
+			return this.response427;
 		case 500:
 			return this.response500;
 		default:
@@ -82,7 +108,14 @@ module.exports = {
 	headers,
 	rss,
 	response200,
+	response400,
+	response401,
+	response403,
 	response404,
+	response405,
+	response408,
+	response418,
+	response427,
 	response500,
 	response
 }

package/src/lib/tools/generic.response.text.js

@@ -42,6 +42,24 @@ response405 = {
 	body: text("Method Not Allowed")
 };
 
+response408 = {
+	statusCode: 408,
+	headers: headers,
+	body: text("Request Timeout")
+};
+
+response418 = {
+	statusCode: 418,
+	headers: headers,
+	body: text("I'm a teapot")
+};
+
+response427 = {
+	statusCode: 427,
+	headers: headers,
+	body: text("Too Many Requests")
+};
+
 response500 = {
 	statusCode: 500,
 	headers: headers,
@@ -53,7 +71,7 @@ response500 = {
  * @param {number|string} statusCode 
  * @returns {{statusCode: number, headers: object, body: Array|Object|string}}
  */
-response = function (statusCode) {
+const response = function (statusCode) {
 	// convert to int
 	statusCode = parseInt(statusCode, 10);
 
@@ -68,6 +86,14 @@ response = function (statusCode) {
 			return this.response403;
 		case 404:
 			return this.response404;
+		case 405:
+			return this.response405;
+		case 408:
+			return this.response408;
+		case 418:
+			return this.response418;
+		case 427:
+			return this.response427;
 		case 500:
 			return this.response500;
 		default:
@@ -80,7 +106,14 @@ module.exports = {
 	headers,
 	text,
 	response200,
+	response400,
+	response401,
+	response403,
 	response404,
+	response405,
+	response408,
+	response418,
+	response427,
 	response500,
 	response
 }

package/src/lib/tools/generic.response.xml.js

@@ -44,6 +44,24 @@ response405 = {
 	body: xml("<error>Method Not Allowed</error>")
 };
 
+response408 = {
+	statusCode: 408,
+	headers: headers,
+	body: xml("<error>Request Timeout</error>")
+};
+
+response418 = {
+	statusCode: 418,
+	headers: headers,
+	body: xml("<error>418 I'm a teapot</error>")
+};
+
+response427 = {
+	statusCode: 427,
+	headers: headers,
+	body: xml("<error>Too Many Requests</error>")
+};
+
 response500 = {
 	statusCode: 500,
 	headers: headers,
@@ -62,8 +80,22 @@ response = function (statusCode) {
 	switch (statusCode) {
 		case 200:
 			return this.response200;
+		case 400:
+			return this.response400;
+		case 401:
+			return this.response401;
+		case 403:
+			return this.response403;
 		case 404:
 			return this.response404;
+		case 405:
+			return this.response405;
+		case 408:
+			return this.response408;
+		case 418:
+			return this.response418;
+		case 427:
+			return this.response427;
 		case 500:
 			return this.response500;
 		default:
@@ -76,7 +108,14 @@ module.exports = {
 	headers,
 	xml,
 	response200,
+	response400,
+	response401,
+	response403,
 	response404,
+	response405,
+	response408,
+	response418,
+	response427,
 	response500,
 	response
 }