hotstaq 0.5.24

package/docs/README.md

@@ -0,0 +1,128 @@
+hotstaq / [Modules](modules.md)
+
+# HotStaq
+HotStaq is a client-side HTML preprocessor, with a design similar to that of PHP. Tech stacks have grown in size significantly over the years, and it can be hard for small teams to efficiently utilize all the different tech stacks properly. HotStaq helps reduce the headache of maintaining all the various tech while ensuring the application's security and quality.
+
+Developers can quickly create their frontend and backends securely while adding their unit tests along the way in code During development, HotStaq developers know they can generate Dockerfiles to easily deploy their application to Kubernetes or Docker Swarm.
+
+For more information, please visit: [HotStaq](https://hotstaq.com)
+
+## Getting started
+First you gotta install like so:
+```console
+npm -g install hotstaq
+```
+
+Now you can create your project by entering:
+```console
+hotstaq create my-app
+```
+
+Run the development web server:
+
+```console
+cd my-app
+
+hotstaq start
+```
+
+Your site starts at `http://localhost:8080`.
+
+Open `public/index.hott` and change your landing page. Refresh your browser to see your changes immediately.
+
+That's it!
+
+## Running database tests
+Make sure you have Docker installed, then do:
+```console
+./dbstart.sh
+```
+
+This will launch the temporary MariaDB and InfluxDB databases.
+
+After testing/debugging you can stop them by entering:
+```console
+./dbstop.sh
+```
+
+## Environment Variables
+You can configure how HotStaq starts by using:
+* DATABASE_TYPE
+	* Type: string
+	* Description: The type of database to use.
+	* Accepted values:
+		* mysql
+		* influx
+* DATABASE_SERVER
+	* Type: string
+	* Description: The url to the database server to connect to.
+	* Accepted values:
+		* MySql example: 127.0.0.1
+		* Influx example: http://127.0.0.1:8086
+* DATABASE_PORT
+	* Type: number
+	* Description: The database port to use.
+	* Accepted values:
+		* Any integer.
+* DATABASE_USERNAME
+	* Type: string
+	* Description: The database username to use.
+	* Accepted values:
+		* Any string.
+* DATABASE_PASSWORD
+	* Type: string
+	* Description: The database password to use.
+	* Accepted values:
+		* Any string.
+* DATABASE_ORG
+	* Type: string
+	* Description: The organization that contains the database. For Influx use.
+	* Accepted values:
+		* Any string.
+* DATABASE_TOKEN
+	* Type: string
+	* Description: The database token to use. For Influx use.
+	* Accepted values:
+		* Any string.
+* DATABASE_SCHEMA
+	* Type: string
+	* Description: The database schema (or bucket) to use.
+	* Accepted values:
+		* Any string.
+* SELENIUM_REMOTE_SERVER
+	* Type: string
+	* Description: The remote selenium server to do web browser tests with.
+	* Accepted values:
+		* Any valid url.
+* SELENIUM_WINDOW_WIDTH
+	* Type: number
+	* Description: The width of the new browser window.
+	* Accepted values:
+		* Any integer.
+* SELENIUM_WINDOW_HEIGHT
+	* Type: number
+	* Description: The height of the new browser window.
+	* Accepted values:
+		* Any integer.
+* TESTING_DEVTOOLS
+	* Type: number
+	* Description: Set to 1 if you want chrome to open the dev tools as browser tests start. This is only for testing.
+	* Accepted values:
+		* 0
+		* 1
+* TESTING_REMOTE_SERVER
+	* Type: string
+	* Description: The remote server to use during browser tests.
+	* Accepted values:
+		* Any valid url.
+
+## Developing
+To get started developing you'll need to install:
+```console
+npm -g install typescript webpack-cli@4 typedoc
+```
+
+To run browser tests, you'll need to have the correct version of [chromedriver](https://chromedriver.chromium.org/) installed for the version of Chrome you are running on your machine.
+
+## Possible Future Compiler
+I'd like to create a CLI tool that compresses the entire public html directory into a zip file which can be downloaded and unzipped during runtime by the client's web browser then display the pages. During the compilation phase it would look for vulnerabilities and report them; for example when embedding JS files, if integrity hashes are missing, it would complain.

package/docs/classes/Hot.md

@@ -0,0 +1,477 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / Hot
+
+# Class: Hot
+
+The api used during processing.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Hot.md#constructor)
+
+### Properties
+
+- [API](Hot.md#api)
+- [Arguments](Hot.md#arguments)
+- [CSS](Hot.md#css)
+- [Cookies](Hot.md#cookies)
+- [CurrentPage](Hot.md#currentpage)
+- [Data](Hot.md#data)
+- [DeveloperMode](Hot.md#developermode)
+- [HotTestElement](Hot.md#hottestelement)
+- [JSFiles](Hot.md#jsfiles)
+- [JSScripts](Hot.md#jsscripts)
+- [Mode](Hot.md#mode)
+- [Output](Hot.md#output)
+- [PublicSecrets](Hot.md#publicsecrets)
+- [TesterAPI](Hot.md#testerapi)
+- [cssStr](Hot.md#cssstr)
+- [jsFileStr](Hot.md#jsfilestr)
+- [jsScriptsStr](Hot.md#jsscriptsstr)
+
+### Methods
+
+- [apiCall](Hot.md#apicall)
+- [displayCSS](Hot.md#displaycss)
+- [displayJSFiles](Hot.md#displayjsfiles)
+- [displayJSScripts](Hot.md#displayjsscripts)
+- [echo](Hot.md#echo)
+- [getFile](Hot.md#getfile)
+- [httpRequest](Hot.md#httprequest)
+- [include](Hot.md#include)
+- [jsonRequest](Hot.md#jsonrequest)
+- [runFile](Hot.md#runfile)
+
+## Constructors
+
+### constructor
+
+• **new Hot**()
+
+## Properties
+
+### API
+
+▪ `Static` **API**: [`HotAPI`](HotAPI.md) = `null`
+
+The current API used on this page. This is cleared between every file processed.
+
+#### Defined in
+
+[Hot.ts:73](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L73)
+
+___
+
+### Arguments
+
+▪ `Static` **Arguments**: `any` = `null`
+
+The arguments passed.
+
+#### Defined in
+
+[Hot.ts:54](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L54)
+
+___
+
+### CSS
+
+▪ `Static` **CSS**: `string`[] = `[]`
+
+The CSS files to use in the current page being generated.
+
+**`todo`** Make this a "string | CSSObject" data type so it can also include
+the integrity hashes as well.
+
+#### Defined in
+
+[Hot.ts:104](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L104)
+
+___
+
+### Cookies
+
+▪ `Static` **Cookies**: `CookiesStatic`<`object`\> = `Cookies`
+
+The cookies to use between pages.
+
+#### Defined in
+
+[Hot.ts:89](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L89)
+
+___
+
+### CurrentPage
+
+▪ `Static` **CurrentPage**: [`HotPage`](HotPage.md) = `null`
+
+The currently generated page being displayed. This is cleared between every file processed.
+
+#### Defined in
+
+[Hot.ts:50](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L50)
+
+___
+
+### Data
+
+▪ `Static` **Data**: `any` = `{}`
+
+The data to share across all the different files and pages. This data will be public.
+
+#### Defined in
+
+[Hot.ts:85](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L85)
+
+___
+
+### DeveloperMode
+
+▪ `Static` **DeveloperMode**: typeof [`DeveloperMode`](../enums/DeveloperMode.md) = `DeveloperMode`
+
+The mode in which this application is running. If it's set to development mode, all testing
+related data will be collected, parsed, and executed if necessary.
+
+#### Defined in
+
+[Hot.ts:59](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L59)
+
+___
+
+### HotTestElement
+
+▪ `Static` **HotTestElement**: typeof [`HotTestElement`](HotTestElement.md) = `HotTestElement`
+
+The mode in which this application is running. If it's set to development mode, all testing
+related data will be collected, parsed, and executed if necessary.
+
+#### Defined in
+
+[Hot.ts:64](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L64)
+
+___
+
+### JSFiles
+
+▪ `Static` **JSFiles**: `any`[] = `[]`
+
+The JavaScript files to use in the current page being generated.
+
+**`todo`** Make this a "string | JSFileObject" data type so it can also include
+the integrity hashes as well.
+
+#### Defined in
+
+[Hot.ts:111](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L111)
+
+___
+
+### JSScripts
+
+▪ `Static` **JSScripts**: `any`[] = `[]`
+
+The JavaScript inline code to use in the current page being generated.
+
+#### Defined in
+
+[Hot.ts:115](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L115)
+
+___
+
+### Mode
+
+▪ `Static` **Mode**: [`DeveloperMode`](../enums/DeveloperMode.md) = `DeveloperMode.Production`
+
+The mode in which this application is running. If it's set to development mode, all testing
+related data will be collected, parsed, and executed if necessary.
+
+#### Defined in
+
+[Hot.ts:69](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L69)
+
+___
+
+### Output
+
+▪ `Static` **Output**: `string` = `""`
+
+Contains the buffer to output. This is cleared between every file processed.
+
+#### Defined in
+
+[Hot.ts:81](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L81)
+
+___
+
+### PublicSecrets
+
+▪ `Static` **PublicSecrets**: `any` = `{}`
+
+Any secrets that can be shown publicly. These can be passed from HotSite.json.
+
+#### Defined in
+
+[Hot.ts:93](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L93)
+
+___
+
+### TesterAPI
+
+▪ `Static` **TesterAPI**: [`HotAPI`](HotAPI.md) = `null`
+
+The API being used by the tester.
+
+#### Defined in
+
+[Hot.ts:77](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L77)
+
+___
+
+### cssStr
+
+▪ `Static` **cssStr**: `string`
+
+The CSS string to use when echoing out the CSS files.
+
+#### Defined in
+
+[Hot.ts:97](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L97)
+
+___
+
+### jsFileStr
+
+▪ `Static` **jsFileStr**: `string`
+
+The JavaScript string to use when echoing out the Scripts files.
+
+#### Defined in
+
+[Hot.ts:119](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L119)
+
+___
+
+### jsScriptsStr
+
+▪ `Static` **jsScriptsStr**: `string`
+
+The JavaScript string to use when echoing out the Scripts files.
+
+#### Defined in
+
+[Hot.ts:123](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L123)
+
+## Methods
+
+### apiCall
+
+▸ `Static` **apiCall**(`route`, `data?`, `httpMethod?`): `Promise`<`any`\>
+
+Make an api call.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `route` | `string` | `undefined` |
+| `data` | `any` | `null` |
+| `httpMethod` | `string` | `"POST"` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Hot.ts:195](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L195)
+
+___
+
+### displayCSS
+
+▸ `Static` **displayCSS**(): `void`
+
+Echo out the CSS for the current page being generated.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Hot.ts:275](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L275)
+
+___
+
+### displayJSFiles
+
+▸ `Static` **displayJSFiles**(): `void`
+
+Echo out the JS files for the current page being generated.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Hot.ts:291](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L291)
+
+___
+
+### displayJSScripts
+
+▸ `Static` **displayJSScripts**(): `void`
+
+Echo out the JS scripts for the current page being generated.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Hot.ts:307](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L307)
+
+___
+
+### echo
+
+▸ `Static` **echo**(`message`): `void`
+
+Echo out some output.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Hot.ts:267](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L267)
+
+___
+
+### getFile
+
+▸ `Static` **getFile**(`path`, `args?`): `Promise`<`string`\>
+
+Get the content of a file.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `path` | `string` \| [`HotFile`](HotFile.md) | `undefined` |
+| `args` | `any`[] | `null` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[Hot.ts:168](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L168)
+
+___
+
+### httpRequest
+
+▸ `Static` **httpRequest**(`url`, `requestInit?`): `Promise`<`Response`\>
+
+Make a HTTP request. This is basically just a wrapper for fetch.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `url` | `string` | `undefined` | The full url to make the HTTP call. |
+| `requestInit` | `RequestInit` | `undefined` | The request parameters to send. |
+
+#### Returns
+
+`Promise`<`Response`\>
+
+The HTTP response.
+
+#### Defined in
+
+[Hot.ts:257](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L257)
+
+___
+
+### include
+
+▸ `Static` **include**(`file`, `args?`): `Promise`<`void`\>
+
+Retrieve a file and echo out it's contents.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `file` | `string` \| [`HotFile`](HotFile.md) | `undefined` |
+| `args` | `any`[] | `null` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[Hot.ts:128](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L128)
+
+___
+
+### jsonRequest
+
+▸ `Static` **jsonRequest**(`url`, `data?`, `httpMethod?`): `Promise`<`any`\>
+
+Make a HTTP JSON request.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `url` | `string` | `undefined` | The full url to make the HTTP call. |
+| `data` | `any` | `null` | The data to JSON.stringify and send. |
+| `httpMethod` | `string` | `"POST"` | The HTTP method to use to send the data. |
+
+#### Returns
+
+`Promise`<`any`\>
+
+The parsed JSON object.
+
+#### Defined in
+
+[Hot.ts:223](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L223)
+
+___
+
+### runFile
+
+▸ `Static` **runFile**(`fileName`, `args?`): `Promise`<`void`\>
+
+Run an already loaded file and echo out it's contents.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `fileName` | `string` | `undefined` |
+| `args` | `any`[] | `null` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[Hot.ts:152](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/Hot.ts#L152)