MathJax-Node-Accessibility-Demo

What it is:

A Node.js application that receives HTML combined with raw LaTeX syntax as an input string.
It processes the string and returns the original HTML with the LaTeX elements converted into SVG and invisible MathML.

Installation:

Make sure Node.js is installed on the system.
Download MathJax-Node-Accessibility-Demo and extract it's contents. You can rename the extracted folder.
Navigate into the extracted folder.
If you run MathJax-Node-Accessibility-Demo locally you can skip this step and continue with step 5. Otherwise adjust following presets to your preffered values:
4.1 Open modules/accessor.js and adjust:
- the list of apiKeys (line 7 ff.)
4.2 Open /server.js:
4.3 Adjust Port 3000 (line 19) to the port number under which MathJax-Node-Accessibility-Demo should be accessed.
You are done with configuring the presets now. MathJax-Node-Accessibility-Demo requires a number of Node.js modules in order to be executed. To install these modules just follow the next two steps:
5.1 Navigate into the MathJax-Node-Accessibility-Demo folder with commandline (server.js is located in this folder).
5.2 Exectue the npm install command. This will trigger the Node Package Manager to install all required dependencies for you.
Everything is set up now and the application is ready to start.
Run node server.js in commandline to start the application.
The application is now running and listening to port 3000 or to the port you specified in 4.3
(a process manager like PM2 is recommended for production use).

Endpoints:

/hello (GET)
- Returns "hello" as string if the service is running.
/process (POST)
- Requires a valid API Key in header and JSON input in body.
- Make sure that your requests body content type is set to JSON. Input structure (body)
```
{
    language: "en",
    html: ["value1", "value2", "value3", ...]
}
```
  html-attribute: Contains an array of strings. Each string can be a Text/HTML combined with LaTeX notations. language-attribute: Contains a string ("en"/"de") which defines the language of the html-attribute's values. The language-attribute determines the language of the output speaktext.
  
  Output structure:
```
{
    success: value,
    timeMS: value,
    errorMsg: value,
    html: ["value1", "value2", "value3", ...]
}
```
  success-attribute:
  Value will be 1 (true) or 0 (false), depending on the status.
  timeMS-attribute:
  Value will contain information about the serverside processing time.
  errorMsg-attribute (appended if success = 0):
  the value will contain an error message.
  html-attribute (appended if success = 1):
  the value will contain HTML strings packed into an array. Each value must be unescaped, e.g with decodeURI().

cURL Commands

/hello

curl --location --request GET '127.0.0.1:3000/hello'

http://127.0.0.1 If run on localhost
:3000
the application Port. Please refer Installation 4.3
/hello
Process route. Please refer Endpoints

/process

curl -X POST \
  http://127.0.0.1:3000/process \
  -H 'API-Key: apikey' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{"language":"en", "html":["value1","value2","value3"]}'

http://127.0.0.1 If run on localhost
:3000
the application Port. Please refer Installation 4.3
/process
Process route. Please refer Endpoints
apikey
Your secret API Key, as defined by an administrator in modules/accessor.js (refer to Installation 4.1) Used to authenticate the client.
html
Your escaped html content strings which will be processed individually.

Further information:

LaTeX delimiters can be \( and \) or \[ and \]
Make sure that your requests body content type is set to JSON
Remember that the following characters are reserved for JSON and must be escaped within your requests body.
- Backspace is replaced with \b
- Form feed is replaced with \f
- Newline is replaced with \n
- Carriage return is replaced with \r
- Tab is replaced with \t
- Double quote is replaced with \"
- Backslash is replaced with \\

Todos:

Apply TLS support:
Currently TLS is not used in this prototype. Add TLS support.
Validate requests:
Requests from the client must be validated.
Prevent brute-force attacks against authorization:
Add mechanics to limit the number of requests.

mathewa6/MathJax-Node-Accessibility-Demo