hotstaq 0.5.3

package/docs/enums/ConnectionStatus.md

@@ -0,0 +1,43 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / ConnectionStatus
+
+# Enumeration: ConnectionStatus
+
+The database connection status.
+
+## Table of contents
+
+### Enumeration members
+
+- [Connected](ConnectionStatus.md#connected)
+- [Connecting](ConnectionStatus.md#connecting)
+- [Disconnected](ConnectionStatus.md#disconnected)
+
+## Enumeration members
+
+### Connected
+
+• **Connected** = `2`
+
+#### Defined in
+
+[HotDB.ts:11](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDB.ts#L11)
+
+___
+
+### Connecting
+
+• **Connecting** = `1`
+
+#### Defined in
+
+[HotDB.ts:10](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDB.ts#L10)
+
+___
+
+### Disconnected
+
+• **Disconnected** = `0`
+
+#### Defined in
+
+[HotDB.ts:9](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDB.ts#L9)

package/docs/enums/DeveloperMode.md

@@ -0,0 +1,38 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / DeveloperMode
+
+# Enumeration: DeveloperMode
+
+The available developer modes.
+
+## Table of contents
+
+### Enumeration members
+
+- [Development](DeveloperMode.md#development)
+- [Production](DeveloperMode.md#production)
+
+## Enumeration members
+
+### Development
+
+• **Development** = `1`
+
+For use during development/debugging. All test data will
+be collected and executed if necessary.
+
+#### Defined in
+
+[Hot.ts:24](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/Hot.ts#L24)
+
+___
+
+### Production
+
+• **Production** = `0`
+
+The default developer mode. No tests will be executed and
+any test related data will be ignored.
+
+#### Defined in
+
+[Hot.ts:19](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/Hot.ts#L19)

package/docs/enums/EventExecutionType.md

@@ -0,0 +1,43 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / EventExecutionType
+
+# Enumeration: EventExecutionType
+
+The type of object to use during event executions.
+
+## Table of contents
+
+### Enumeration members
+
+- [HotAPI](EventExecutionType.md#hotapi)
+- [HotMethod](EventExecutionType.md#hotmethod)
+- [HotRoute](EventExecutionType.md#hotroute)
+
+## Enumeration members
+
+### HotAPI
+
+• **HotAPI** = `2`
+
+#### Defined in
+
+[HotAPI.ts:26](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotAPI.ts#L26)
+
+___
+
+### HotMethod
+
+• **HotMethod** = `1`
+
+#### Defined in
+
+[HotAPI.ts:25](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotAPI.ts#L25)
+
+___
+
+### HotRoute
+
+• **HotRoute** = `0`
+
+#### Defined in
+
+[HotAPI.ts:24](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotAPI.ts#L24)

package/docs/enums/HTTPMethod.md

@@ -0,0 +1,32 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HTTPMethod
+
+# Enumeration: HTTPMethod
+
+Available HTTP methods.
+
+## Table of contents
+
+### Enumeration members
+
+- [GET](HTTPMethod.md#get)
+- [POST](HTTPMethod.md#post)
+
+## Enumeration members
+
+### GET
+
+• **GET** = `"get"`
+
+#### Defined in
+
+[HotRouteMethod.ts:11](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotRouteMethod.ts#L11)
+
+___
+
+### POST
+
+• **POST** = `"post"`
+
+#### Defined in
+
+[HotRouteMethod.ts:12](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotRouteMethod.ts#L12)

package/docs/enums/HotDBGenerationType.md

@@ -0,0 +1,30 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotDBGenerationType
+
+# Enumeration: HotDBGenerationType
+
+## Table of contents
+
+### Enumeration members
+
+- [Create](HotDBGenerationType.md#create)
+- [Modify](HotDBGenerationType.md#modify)
+
+## Enumeration members
+
+### Create
+
+• **Create** = `0`
+
+#### Defined in
+
+[schemas/HotDBSchema.ts:3](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBSchema.ts#L3)
+
+___
+
+### Modify
+
+• **Modify** = `1`
+
+#### Defined in
+
+[schemas/HotDBSchema.ts:4](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBSchema.ts#L4)

package/docs/enums/HotLogLevel.md

@@ -0,0 +1,88 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotLogLevel
+
+# Enumeration: HotLogLevel
+
+The logging level.
+
+## Table of contents
+
+### Enumeration members
+
+- [All](HotLogLevel.md#all)
+- [Error](HotLogLevel.md#error)
+- [Info](HotLogLevel.md#info)
+- [None](HotLogLevel.md#none)
+- [Verbose](HotLogLevel.md#verbose)
+- [Warning](HotLogLevel.md#warning)
+
+## Enumeration members
+
+### All
+
+• **All** = `4`
+
+Prints all messages, except verbose.
+
+#### Defined in
+
+[HotLog.ts:25](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotLog.ts#L25)
+
+___
+
+### Error
+
+• **Error** = `2`
+
+Prints only error messages.
+
+#### Defined in
+
+[HotLog.ts:17](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotLog.ts#L17)
+
+___
+
+### Info
+
+• **Info** = `0`
+
+Prints only info messages.
+
+#### Defined in
+
+[HotLog.ts:9](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotLog.ts#L9)
+
+___
+
+### None
+
+• **None** = `5`
+
+Doesn't print any message.
+
+#### Defined in
+
+[HotLog.ts:29](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotLog.ts#L29)
+
+___
+
+### Verbose
+
+• **Verbose** = `3`
+
+Prints all messages.
+
+#### Defined in
+
+[HotLog.ts:21](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotLog.ts#L21)
+
+___
+
+### Warning
+
+• **Warning** = `1`
+
+Prints only warning messages.
+
+#### Defined in
+
+[HotLog.ts:13](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotLog.ts#L13)

package/docs/interfaces/HotDBConnectionInterface.md

@@ -0,0 +1,116 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotDBConnectionInterface
+
+# Interface: HotDBConnectionInterface
+
+The database connection info.
+
+## Table of contents
+
+### Properties
+
+- [database](HotDBConnectionInterface.md#database)
+- [org](HotDBConnectionInterface.md#org)
+- [password](HotDBConnectionInterface.md#password)
+- [port](HotDBConnectionInterface.md#port)
+- [server](HotDBConnectionInterface.md#server)
+- [token](HotDBConnectionInterface.md#token)
+- [type](HotDBConnectionInterface.md#type)
+- [username](HotDBConnectionInterface.md#username)
+
+## Properties
+
+### database
+
+• `Optional` **database**: `string`
+
+The database to use.
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:39](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L39)
+
+___
+
+### org
+
+• `Optional` **org**: `string`
+
+The org to use.
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:35](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L35)
+
+___
+
+### password
+
+• `Optional` **password**: `string`
+
+The password to use.
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:27](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L27)
+
+___
+
+### port
+
+• `Optional` **port**: `number`
+
+The server's port.
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:19](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L19)
+
+___
+
+### server
+
+• `Optional` **server**: `string`
+
+The server's address.
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:15](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L15)
+
+___
+
+### token
+
+• `Optional` **token**: `string`
+
+The token to use.
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:31](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L31)
+
+___
+
+### type
+
+• `Optional` **type**: `string`
+
+The type of database. Can be:
+* mysql
+* influx
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:11](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L11)
+
+___
+
+### username
+
+• `Optional` **username**: `string`
+
+The username to use to connect.
+
+#### Defined in
+
+[HotDBConnectionInterface.ts:23](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDBConnectionInterface.ts#L23)

package/docs/interfaces/HotDestination.md

@@ -0,0 +1,62 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotDestination
+
+# Interface: HotDestination
+
+The destination for a test to take.
+
+## Table of contents
+
+### Properties
+
+- [api](HotDestination.md#api)
+- [mapName](HotDestination.md#mapname)
+- [page](HotDestination.md#page)
+- [paths](HotDestination.md#paths)
+
+## Properties
+
+### api
+
+• **api**: `string`
+
+The API route to start using.
+
+#### Defined in
+
+[HotTester.ts:55](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotTester.ts#L55)
+
+___
+
+### mapName
+
+• **mapName**: `string`
+
+The name of the map.
+
+#### Defined in
+
+[HotTester.ts:47](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotTester.ts#L47)
+
+___
+
+### page
+
+• **page**: `string`
+
+The page to start at.
+
+#### Defined in
+
+[HotTester.ts:51](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotTester.ts#L51)
+
+___
+
+### paths
+
+• **paths**: [`HotTestStop`](HotTestStop.md)[]
+
+The paths to take on the page.
+
+#### Defined in
+
+[HotTester.ts:59](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotTester.ts#L59)

package/docs/interfaces/HotSite.md

@@ -0,0 +1,187 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotSite
+
+# Interface: HotSite
+
+A HotSite to load. This SHOULD NOT contain any private secret keys, passwords,
+or database connection information related to the server. As such, future
+versions of the HotSite interface should not contain any database related
+connection info.
+
+## Table of contents
+
+### Properties
+
+- [apis](HotSite.md#apis)
+- [components](HotSite.md#components)
+- [files](HotSite.md#files)
+- [hotsitePath](HotSite.md#hotsitepath)
+- [name](HotSite.md#name)
+- [publicSecrets](HotSite.md#publicsecrets)
+- [routes](HotSite.md#routes)
+- [server](HotSite.md#server)
+- [testing](HotSite.md#testing)
+
+## Properties
+
+### apis
+
+• `Optional` **apis**: `Object`
+
+The available APIs on the server. The server must already have these
+loaded.
+
+#### Index signature
+
+▪ [name: `string`]: { `apiName?`: `string` ; `filepath?`: `string` ; `jsapi?`: `string` ; `libraryName?`: `string` ; `map?`: `string`[] ; `port?`: `number` ; `url?`: `string`  }
+
+#### Defined in
+
+[HotStaq.ts:221](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L221)
+
+___
+
+### components
+
+• `Optional` **components**: `Object`
+
+The components to load and register.
+
+#### Index signature
+
+▪ [name: `string`]: { `url`: `string`  }
+
+#### Defined in
+
+[HotStaq.ts:272](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L272)
+
+___
+
+### files
+
+• `Optional` **files**: `Object`
+
+The files to load and save in memory.
+
+#### Index signature
+
+▪ [name: `string`]: { `url`: `string`  }
+
+#### Defined in
+
+[HotStaq.ts:283](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L283)
+
+___
+
+### hotsitePath
+
+• `Optional` **hotsitePath**: `string`
+
+The path to the current HotSite. This is filled in during parsing.
+
+#### Defined in
+
+[HotStaq.ts:88](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L88)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of this HotSite.
+
+#### Defined in
+
+[HotStaq.ts:84](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L84)
+
+___
+
+### publicSecrets
+
+• `Optional` **publicSecrets**: `Object`
+
+Secrets that can be publicly embedded into the page.
+
+#### Index signature
+
+▪ [name: `string`]: `string` \| { `env?`: `string` ; `passSecretFromAPI?`: `string`  }
+
+#### Defined in
+
+[HotStaq.ts:256](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L256)
+
+___
+
+### routes
+
+• `Optional` **routes**: `Object`
+
+The routes to load.
+
+#### Index signature
+
+▪ [routeName: `string`]: [`HotSiteRoute`](HotSiteRoute.md)
+
+#### Defined in
+
+[HotStaq.ts:214](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L214)
+
+___
+
+### server
+
+• `Optional` **server**: `Object`
+
+Additional web server configuration.
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `globalApi?` | `string` | The name of the API to interface with across all pages. |
+| `jsSrcPath?` | `string` | The JavaScript source path. |
+| `name?` | `string` | The default name for a served Hott file. |
+| `ports?` | `Object` | The ports to use. |
+| `ports.http?` | `number` | The HTTP port to serve on. |
+| `ports.https?` | `number` | The HTTPS port to serve on. |
+| `ports.redirectHTTPtoHTTPS?` | `boolean` | If set to true, this will redirect from HTTP to HTTPS. |
+| `serveDirectories?` | { `localPath`: `string` ; `route`: `string`  }[] | The list of directory to serve to the client from the server. |
+| `serveHottFiles?` | `boolean` | Serve hott files when requested. |
+| `url?` | `string` | The base url for the server. |
+
+#### Defined in
+
+[HotStaq.ts:92](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L92)
+
+___
+
+### testing
+
+• `Optional` **testing**: `Object`
+
+Testing related functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `api?` | `Object` |
+| `api.createNewTester?` | `boolean` |
+| `api.driver?` | `string` |
+| `api.launchpadUrl?` | `string` |
+| `api.maps?` | `string`[] |
+| `api.tester?` | `string` |
+| `api.testerAPIUrl?` | `string` |
+| `api.testerName?` | `string` |
+| `web?` | `Object` |
+| `web.createNewTester?` | `boolean` |
+| `web.driver?` | `string` |
+| `web.launchpadUrl?` | `string` |
+| `web.maps?` | `string`[] |
+| `web.tester?` | `string` |
+| `web.testerAPIUrl?` | `string` |
+| `web.testerName?` | `string` |
+
+#### Defined in
+
+[HotStaq.ts:147](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L147)

package/docs/interfaces/HotSiteMapPath.md

@@ -0,0 +1,37 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotSiteMapPath
+
+# Interface: HotSiteMapPath
+
+A map path for testing.
+
+## Table of contents
+
+### Properties
+
+- [autoStart](HotSiteMapPath.md#autostart)
+- [path](HotSiteMapPath.md#path)
+
+## Properties
+
+### autoStart
+
+• `Optional` **autoStart**: `boolean`
+
+If set to true, this will start automatically when tests start.
+The default is true.
+
+#### Defined in
+
+[HotStaq.ts:35](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L35)
+
+___
+
+### path
+
+• `Optional` **path**: `string`
+
+The path to the
+
+#### Defined in
+
+[HotStaq.ts:39](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotStaq.ts#L39)