sprucehttp_sjs 1.0.2 → 1.0.5

package/README.md

@@ -8,6 +8,17 @@ A module for responding to requests within SpruceHTTP in an SJS file.
  	- [writeStatusLine(statusCode, reasonPhrase)](#writestatuslinestatuscode-reasonphrase)
 	- [writeHeader(name, value)](#writeheadername-value)
 	- [writeData(data)](#writedatadata)
+	- [writeDataAsync(data)](#writedataasyncdata)
+	- [siteConfig()](#siteconfig)
+	- [requestIP()](#requestip)
+	- [method()](#method)
+	- [path()](#path)
+	- [query()](#query)
+	- [queryValue(key)](#queryvaluekey)
+	- [httpVersion()](#httpversion)
+	- [headers()](#headers)
+	- [headerValue(name)](#headervaluename)
+	- [body()](#body)
 
 ## Documentation:
 Importing the module:
@@ -65,4 +76,133 @@ Writes binary data (a picture, in this case) to the body.
 ```js
 const fs = require('fs');
 sjs.writeData(fs.readFileSync("image.png", 'binary'));
+```
+
+### ``writeDataAsync(data)``:
+ - ``data:`` string | Buffer: The data to send.
+
+Writes data (the body) to the response asynchronously. When not in stream mode, the Content-Length header is automatically updated.
+
+Writes text data to the body.
+```js
+await sjs.writeDataAsync("Hello, world!");
+```
+
+Writes binary data (a picture, in this case) to the body.
+```js
+const fs = require('fs');
+await sjs.writeDataAsync(fs.readFileSync("image.png", 'binary'));
+```
+
+### ``siteConfig()``:
+Returns the site-specific configuration set in your config file.
+
+```js
+console.log(sjs.siteConfig());
+/*
+{
+	"type": "local",
+	"location": "./",
+	"upgradeInsecure": true,
+	"directoryListing": true,
+	"sjs": true,
+	"headers": {
+		"Access-Control-Allow-Origin": "*"
+	},
+	"ssl": {
+		"key": "./ssl/key.pem",
+		"cert": "./ssl/cert.pem",
+		"minVersion": "TLSv1.2",
+		"maxVersion": "TLSv1.3"
+	}
+}
+*/
+```
+
+### ``requestIP()``:
+Returns the requestor's IP address.
+
+```js
+console.log(sjs.requestIP());
+// ::ffff:127.0.0.1
+```
+
+### ``method()``:
+Returns the request method.
+
+```js
+console.log(sjs.method());
+// get
+```
+
+### ``path()``:
+Returns the request path.
+
+```js
+console.log(sjs.path());
+// /index.sjs
+```
+
+### ``query()``:
+Returns the request query.
+
+```js
+console.log(sjs.query());
+/*
+{
+	"name": "John",
+	"age": "42"
+}
+*/
+```
+
+### ``queryValue(key)``:
+ - ``key:`` string: The key of the query to get.
+
+Returns the value of a query parameter.
+
+```js
+console.log(sjs.queryValue("name"));
+// John
+```
+
+### ``httpVersion()``:
+Returns the HTTP version of the request.
+
+```js
+console.log(sjs.httpVersion());
+// http/1.1
+```
+
+### ``headers()``:
+Returns the request headers.
+
+```js
+console.log(sjs.headers());
+/*
+{
+	"connection": "keep-alive",
+	"host": "localhost:8080",
+	"upgrade-insecure-requests": "1",
+	"user-agent": "Bruh/1.0 (Macintosh; PPC Mac OS X 7_0_1) AppleBruhKit 1.3 (XHTML, like IE) Netscape/69.420 Moment/360 NoScope/1.0"
+}
+*/
+```
+
+### ``headerValue(name)``:
+ - ``name:`` string: The name of the header to get.
+
+Returns the value of a header.
+
+```js
+console.log(sjs.headerValue("user-agent"));
+// Bruh/1.0 (Macintosh; PPC Mac OS X 7_0_1) AppleBruhKit 1.3 (XHTML, like IE) Netscape/69.420 Moment/360 NoScope/1.0
+```
+
+### ``body()``:
+Returns the request body as a buffer.
+
+```js
+console.log(sjs.body().toString("utf8"));
+// Hello, world!
 ```

package/index.js

@@ -1,3 +1,5 @@
+const fs = require("fs");
+
 module.exports = {
 	/**
 	 * Sets the response into stream mode.
@@ -30,7 +32,7 @@ module.exports = {
 	 */
 	writeHeader: function(name, value) {
 		process.send({
-			type: 'status',
+			type: 'header',
 			name,
 			value
 		});
@@ -43,9 +45,117 @@ module.exports = {
 	 * @param {string | Buffer} data The data to send.
 	 */
 	writeData: function(data) {
-		process.send({
-			type: 'data',
-			data: Buffer.from(data).toString('base64')
+		(async () => {await this.writeDataAsync(data);})();
+	},
+
+	/**
+	 * Writes data (the body) to the response asynchronously.
+	 * 
+	 * When not in stream mode, the Content-Length header is automatically updated.
+	 * @param {string | Buffer} data The data to send.
+	 */
+	writeDataAsync: function(data) {
+		return new Promise(function(resolve) {
+			process.send({
+				type: 'data',
+				data: Buffer.from(data)
+			}, resolve);
 		});
+	},
+
+	/**
+	 * Returns the site-specific configuration.
+	 * 
+	 * @returns {{[key: string]: string}} The site-specific configuration.
+	 */
+	siteConfig: function() {
+		return JSON.parse(process.env.siteConfig);
+	},
+
+	/**
+	 * Returns the requestor's IP address.
+	 * 
+	 * @returns {string} The requestor's IP address.
+	 */
+	requestIP: function() {
+		return process.env.reqIP;
+	},
+
+	/**
+	 * Returns the request method.
+	 * 
+	 * @returns {string} The request method.
+	 */
+	method: function() {
+		return process.env.reqMethod;
+	},
+
+	/**
+	 * Returns the full path of the request.
+	 * 
+	 * @returns {string} The full request path.
+	 */
+	path: function() {
+		return process.env.reqPath;
+	},
+
+	/**
+	 * Returns the parsed query string of the request.
+	 * 
+	 * @returns {{[key: string]: string}} The parsed query string of the request.
+	 */
+	query: function() {
+		return JSON.parse(process.env.reqQuery || "{}");
+	},
+
+	/**
+	 * Returns the value of a query parameter.
+	 * 
+	 * @param {string} key The key of the query to get.
+	 * @returns {string} The value of the query parameter.
+	 */
+	queryValue: function(key) {
+		return this.query()[key];
+	},
+
+	/**
+	 * Returns the HTTP version of the request.
+	 * 
+	 * @returns {string} The HTTP version of the request.
+	 */
+	httpVersion: function() {
+		return process.env.reqHttpVersion;
+	},
+
+	/**
+	 * Returns the headers of the request.
+	 * 
+	 * @returns {{[key: string]: string}} The headers of the request.
+	 */
+	headers: function() {
+		return JSON.parse(process.env.reqHeaders || "{}");
+	},
+
+	/**
+	 * Returns a specific header of the request.
+	 * 
+	 * @param {string} name The name of the header to get.
+	 * @returns {string} The value of the header.
+	 */
+	headerValue: function(name) {
+		return this.headers()[name];
+	},
+
+	/**
+	 * Returns the body of the request.
+	 * 
+	 * @returns {Buffer} The body of the request.
+	 */
+	body: function() {
+		let retVal = undefined;
+		if (process.env.reqBody) {
+			retVal = fs.readFileSync(process.env.reqBody);
+		}
+		return retVal;
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sprucehttp_sjs",
-	"version": "1.0.2",
+	"version": "1.0.5",
 	"description": "A module for responding to requests within SpruceHTTP in an SJS file",
 	"main": "index.js",
 	"scripts": {