hotstaq 0.5.24

package/docs/classes/HotTestDestination.md

@@ -0,0 +1,58 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotTestDestination
+
+# Class: HotTestDestination
+
+The destination to take in a map.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotTestDestination.md#constructor)
+
+### Properties
+
+- [autoStart](HotTestDestination.md#autostart)
+- [destination](HotTestDestination.md#destination)
+
+## Constructors
+
+### constructor
+
+• **new HotTestDestination**(`destination?`, `autoStart?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `destination` | `string` \| [`HotSiteMapPath`](../interfaces/HotSiteMapPath.md) \| [`HotTestDestination`](HotTestDestination.md) | `""` |
+| `autoStart` | `boolean` | `true` |
+
+#### Defined in
+
+[HotTestMap.ts:25](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L25)
+
+## Properties
+
+### autoStart
+
+• **autoStart**: `boolean`
+
+If set to true, this will automatically start executing it's
+tests when it's time.
+
+#### Defined in
+
+[HotTestMap.ts:23](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L23)
+
+___
+
+### destination
+
+• **destination**: `string`
+
+The destination to take.
+
+#### Defined in
+
+[HotTestMap.ts:18](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L18)

package/docs/classes/HotTestDriver.md

@@ -0,0 +1,332 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotTestDriver
+
+# Class: HotTestDriver
+
+This actually executes the tests.
+
+## Hierarchy
+
+- **`HotTestDriver`**
+
+  ↳ [`HotTestSeleniumDriver`](HotTestSeleniumDriver.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotTestDriver.md#constructor)
+
+### Properties
+
+- [page](HotTestDriver.md#page)
+
+### Methods
+
+- [assert](HotTestDriver.md#assert)
+- [assertElementValue](HotTestDriver.md#assertelementvalue)
+- [destroy](HotTestDriver.md#destroy)
+- [findTestElement](HotTestDriver.md#findtestelement)
+- [navigateToUrl](HotTestDriver.md#navigatetourl)
+- [parseTestObject](HotTestDriver.md#parsetestobject)
+- [print](HotTestDriver.md#print)
+- [println](HotTestDriver.md#println)
+- [run](HotTestDriver.md#run)
+- [runCommand](HotTestDriver.md#runcommand)
+- [wait](HotTestDriver.md#wait)
+- [waitForTestElement](HotTestDriver.md#waitfortestelement)
+
+## Constructors
+
+### constructor
+
+• **new HotTestDriver**(`page?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `page` | [`HotTestPage`](../interfaces/HotTestPage.md) | `null` |
+
+#### Defined in
+
+[HotTestDriver.ts:15](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L15)
+
+## Properties
+
+### page
+
+• **page**: [`HotTestPage`](../interfaces/HotTestPage.md)
+
+The current page.
+
+#### Defined in
+
+[HotTestDriver.ts:13](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L13)
+
+## Methods
+
+### assert
+
+▸ **assert**(`value`, `errorMessage?`): `Promise`<`any`\>
+
+An expression to test.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `value` | `any` | `undefined` |
+| `errorMessage` | `string` | `""` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotTestDriver.ts:107](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L107)
+
+___
+
+### assertElementValue
+
+▸ `Abstract` **assertElementValue**(`name`, `value`, `errorMessage?`, `options?`): `Promise`<`any`\>
+
+An expression to test.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` \| [`HotTestElement`](HotTestElement.md) |
+| `value` | `any` |
+| `errorMessage?` | `string` |
+| `options?` | [`HotTestElementOptions`](HotTestElementOptions.md) |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotTestDriver.ts:102](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L102)
+
+___
+
+### destroy
+
+▸ `Abstract` **destroy**(): `Promise`<`void`\>
+
+Disconnect this server or destroy anything associated with this HotTestDriver.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotTestDriver.ts:81](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L81)
+
+___
+
+### findTestElement
+
+▸ `Abstract` **findTestElement**(`name`, `options?`): `Promise`<`any`\>
+
+Find a HotTestElement to utilize.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` \| [`HotTestElement`](HotTestElement.md) |
+| `options?` | [`HotTestElementOptions`](HotTestElementOptions.md) |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotTestDriver.ts:94](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L94)
+
+___
+
+### navigateToUrl
+
+▸ `Abstract` **navigateToUrl**(`url`): `Promise`<`void`\>
+
+Navigate to a url.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotTestDriver.ts:86](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L86)
+
+___
+
+### parseTestObject
+
+▸ **parseTestObject**(`name`): `string`
+
+Get a test object by it's name. If a * is used, it will be used as a
+wildcard for the object's name. If a > is used, then the name will
+be treated as a CSS selector.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[HotTestDriver.ts:25](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L25)
+
+___
+
+### print
+
+▸ **print**(`message`): `Promise`<`void`\>
+
+Print a message.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotTestDriver.ts:65](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L65)
+
+___
+
+### println
+
+▸ **println**(`message`): `Promise`<`void`\>
+
+Print a message line.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotTestDriver.ts:73](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L73)
+
+___
+
+### run
+
+▸ **run**(`executions`): `Promise`<`any`[]\>
+
+Run a series of test elements.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executions` | `string`[] \| `string`[][] |
+
+#### Returns
+
+`Promise`<`any`[]\>
+
+#### Defined in
+
+[HotTestDriver.ts:116](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L116)
+
+___
+
+### runCommand
+
+▸ `Abstract` **runCommand**(`testElm`, `funcName?`, `valueStr?`): `Promise`<`any`\>
+
+Run a HotTestElement command.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `testElm` | `string` \| [`HotTestElement`](HotTestElement.md) |
+| `funcName?` | `string` |
+| `valueStr?` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotTestDriver.ts:98](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L98)
+
+___
+
+### wait
+
+▸ **wait**(`numMilliseconds`): `Promise`<`void`\>
+
+Wait for a number of milliseconds.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `numMilliseconds` | `number` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotTestDriver.ts:51](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L51)
+
+___
+
+### waitForTestElement
+
+▸ `Abstract` **waitForTestElement**(`name`, `options?`): `Promise`<`any`\>
+
+Wait for a HotTestElement to load.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` \| [`HotTestElement`](HotTestElement.md) |
+| `options?` | [`HotTestElementOptions`](HotTestElementOptions.md) |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotTestDriver.ts:90](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestDriver.ts#L90)

package/docs/classes/HotTestElement.md

@@ -0,0 +1,88 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotTestElement
+
+# Class: HotTestElement
+
+A test element.
+
+## Implements
+
+- [`IHotTestElement`](../interfaces/IHotTestElement.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotTestElement.md#constructor)
+
+### Properties
+
+- [func](HotTestElement.md#func)
+- [name](HotTestElement.md#name)
+- [value](HotTestElement.md#value)
+
+## Constructors
+
+### constructor
+
+• **new HotTestElement**(`name`, `func?`, `value?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `name` | `string` \| [`IHotTestElement`](../interfaces/IHotTestElement.md) | `undefined` |
+| `func` | `string` | `""` |
+| `value` | `any` | `null` |
+
+#### Defined in
+
+[HotTestElement.ts:82](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L82)
+
+## Properties
+
+### func
+
+• **func**: `string`
+
+The name of the function to execute
+while executing the test.
+
+#### Implementation of
+
+[IHotTestElement](../interfaces/IHotTestElement.md).[func](../interfaces/IHotTestElement.md#func)
+
+#### Defined in
+
+[HotTestElement.ts:76](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L76)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the element.
+
+#### Implementation of
+
+[IHotTestElement](../interfaces/IHotTestElement.md).[name](../interfaces/IHotTestElement.md#name)
+
+#### Defined in
+
+[HotTestElement.ts:71](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L71)
+
+___
+
+### value
+
+• **value**: `any`
+
+The value to use.
+
+#### Implementation of
+
+[IHotTestElement](../interfaces/IHotTestElement.md).[value](../interfaces/IHotTestElement.md#value)
+
+#### Defined in
+
+[HotTestElement.ts:80](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L80)

package/docs/classes/HotTestElementOptions.md

@@ -0,0 +1,71 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotTestElementOptions
+
+# Class: HotTestElementOptions
+
+Hot test element options.
+
+## Implements
+
+- [`IHotTestElementOptions`](../interfaces/IHotTestElementOptions.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotTestElementOptions.md#constructor)
+
+### Properties
+
+- [ignoreMissingElementError](HotTestElementOptions.md#ignoremissingelementerror)
+- [mustBeVisible](HotTestElementOptions.md#mustbevisible)
+
+## Constructors
+
+### constructor
+
+• **new HotTestElementOptions**(`copy?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `copy` | [`IHotTestElementOptions`](../interfaces/IHotTestElementOptions.md) |
+
+#### Defined in
+
+[HotTestElement.ts:36](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L36)
+
+## Properties
+
+### ignoreMissingElementError
+
+• **ignoreMissingElementError**: `boolean`
+
+If the test element is missing, ignore the error. This
+will cause the rest of the function to return immediately
+without any exceptions being thrown.
+
+#### Implementation of
+
+[IHotTestElementOptions](../interfaces/IHotTestElementOptions.md).[ignoreMissingElementError](../interfaces/IHotTestElementOptions.md#ignoremissingelementerror)
+
+#### Defined in
+
+[HotTestElement.ts:34](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L34)
+
+___
+
+### mustBeVisible
+
+• **mustBeVisible**: `boolean`
+
+Indicates that the test element must be visible in
+order to select it.
+
+#### Implementation of
+
+[IHotTestElementOptions](../interfaces/IHotTestElementOptions.md).[mustBeVisible](../interfaces/IHotTestElementOptions.md#mustbevisible)
+
+#### Defined in
+
+[HotTestElement.ts:28](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L28)

package/docs/classes/HotTestMap.md

@@ -0,0 +1,92 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotTestMap
+
+# Class: HotTestMap
+
+Maps the paths that are taken to complete a test.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotTestMap.md#constructor)
+
+### Properties
+
+- [destinationOrder](HotTestMap.md#destinationorder)
+- [destinations](HotTestMap.md#destinations)
+- [pages](HotTestMap.md#pages)
+
+## Constructors
+
+### constructor
+
+• **new HotTestMap**(`destinations?`, `pages?`, `destinationOrder?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `destinations` | `string`[] \| [`HotTestDestination`](HotTestDestination.md)[] \| { [name: string]: `string` \| [`HotTestDestination`](HotTestDestination.md);  } | `[]` |
+| `pages` | `Object` | `{}` |
+| `destinationOrder` | `string`[] | `[]` |
+
+#### Defined in
+
+[HotTestMap.ts:100](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L100)
+
+## Properties
+
+### destinationOrder
+
+• **destinationOrder**: `string`[]
+
+The order in which destinations are supposed to execute. This is
+ignored if the destinations are an array.
+
+#### Defined in
+
+[HotTestMap.ts:92](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L92)
+
+___
+
+### destinations
+
+• **destinations**: [`HotTestDestination`](HotTestDestination.md)[] \| { [name: string]: [`HotTestDestination`](HotTestDestination.md);  }
+
+The order in which paths are to be taken. Each destination is a string
+in a type -> path order. The type could be either a page or api route.
+For example:
+```
+[
+     "page:signin_page -> signin_path",
+     "page:account_page -> change_username_path",
+     "page:account_page -> change_password_path",
+     "page:account_page -> change_name_path -> change_address_path",
+		"page:account_page -> signout_path",
+		"api:account_api_route -> signout_route_method -> signout_test_path"
+]
+```
+
+The first string to the left of the -> will always be the type, such as a
+page or an api route. Any strings to the right of the -> will be a path, even
+when chaining addtional ->'s.
+
+#### Defined in
+
+[HotTestMap.ts:87](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L87)
+
+___
+
+### pages
+
+• **pages**: `Object`
+
+The test pages to execute.
+
+#### Index signature
+
+▪ [name: `string`]: [`HotTestPage`](../interfaces/HotTestPage.md)
+
+#### Defined in
+
+[HotTestMap.ts:96](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L96)