hotstaq 0.5.3

package/docs/classes/HotDBMySQL.md

@@ -0,0 +1,310 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotDBMySQL
+
+# Class: HotDBMySQL
+
+The MySQL database connection.
+
+## Hierarchy
+
+- [`HotDB`](HotDB.md)<`mysql.Connection`, [`MySQLResults`](../interfaces/MySQLResults.md), [`MySQLSchema`](MySQLSchema.md)\>
+
+  ↳ **`HotDBMySQL`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotDBMySQL.md#constructor)
+
+### Properties
+
+- [connectionStatus](HotDBMySQL.md#connectionstatus)
+- [db](HotDBMySQL.md#db)
+- [schema](HotDBMySQL.md#schema)
+- [type](HotDBMySQL.md#type)
+
+### Methods
+
+- [connect](HotDBMySQL.md#connect)
+- [dbCheck](HotDBMySQL.md#dbcheck)
+- [disconnect](HotDBMySQL.md#disconnect)
+- [multiQuery](HotDBMySQL.md#multiquery)
+- [query](HotDBMySQL.md#query)
+- [queryOne](HotDBMySQL.md#queryone)
+- [syncMigrationsTableTracker](HotDBMySQL.md#syncmigrationstabletracker)
+- [tableCheck](HotDBMySQL.md#tablecheck)
+
+## Constructors
+
+### constructor
+
+• **new HotDBMySQL**(`db?`, `type?`, `schema?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `db` | `Connection` | `null` |
+| `type` | `string` | `"mysql"` |
+| `schema` | [`MySQLSchema`](MySQLSchema.md) | `null` |
+
+#### Overrides
+
+[HotDB](HotDB.md).[constructor](HotDB.md#constructor)
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:27](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L27)
+
+## Properties
+
+### connectionStatus
+
+• **connectionStatus**: [`ConnectionStatus`](../enums/ConnectionStatus.md)
+
+The connection status.
+
+#### Inherited from
+
+[HotDB](HotDB.md).[connectionStatus](HotDB.md#connectionstatus)
+
+#### Defined in
+
+[HotDB.ts:30](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDB.ts#L30)
+
+___
+
+### db
+
+• **db**: `Connection`
+
+The connection to the database (or the driver).
+
+#### Inherited from
+
+[HotDB](HotDB.md).[db](HotDB.md#db)
+
+#### Defined in
+
+[HotDB.ts:26](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDB.ts#L26)
+
+___
+
+### schema
+
+• **schema**: [`MySQLSchema`](MySQLSchema.md)
+
+The db schema. This will generate a database structure
+and keep it maintained as needed.
+
+#### Inherited from
+
+[HotDB](HotDB.md).[schema](HotDB.md#schema)
+
+#### Defined in
+
+[HotDB.ts:35](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDB.ts#L35)
+
+___
+
+### type
+
+• **type**: `string`
+
+The database type.
+
+#### Inherited from
+
+[HotDB](HotDB.md).[type](HotDB.md#type)
+
+#### Defined in
+
+[HotDB.ts:22](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotDB.ts#L22)
+
+## Methods
+
+### connect
+
+▸ **connect**(`connectionInfo`): `Promise`<`any`[]\>
+
+Connect to the database.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connectionInfo` | [`HotDBConnectionInterface`](../interfaces/HotDBConnectionInterface.md) |
+
+#### Returns
+
+`Promise`<`any`[]\>
+
+#### Overrides
+
+[HotDB](HotDB.md).[connect](HotDB.md#connect)
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:35](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L35)
+
+___
+
+### dbCheck
+
+▸ `Protected` **dbCheck**(): `void`
+
+Checks to see if this has a database connection.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:65](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L65)
+
+___
+
+### disconnect
+
+▸ **disconnect**(): `Promise`<`void`\>
+
+Disconnect from the server.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[HotDB](HotDB.md).[disconnect](HotDB.md#disconnect)
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:306](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L306)
+
+___
+
+### multiQuery
+
+▸ **multiQuery**(`queryStrings`): `Promise`<[`MySQLResults`](../interfaces/MySQLResults.md)[]\>
+
+Make multiple queries. **Warning! This can be a security vulnerability
+if misused! Ideally this should only be used when making changes to tables!
+Additionally, this could overwhelm the server and each command sent is not
+guaranteed to be done in order.**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `queryStrings` | `string`[] \| { `query`: `string` ; `values`: `any`[]  }[] |
+
+#### Returns
+
+`Promise`<[`MySQLResults`](../interfaces/MySQLResults.md)[]\>
+
+#### Overrides
+
+[HotDB](HotDB.md).[multiQuery](HotDB.md#multiquery)
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:267](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L267)
+
+___
+
+### query
+
+▸ **query**(`queryString`, `values?`): `Promise`<[`MySQLResults`](../interfaces/MySQLResults.md)\>
+
+The query to make.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `queryString` | `string` | `undefined` |
+| `values` | `any`[] | `[]` |
+
+#### Returns
+
+`Promise`<[`MySQLResults`](../interfaces/MySQLResults.md)\>
+
+#### Overrides
+
+[HotDB](HotDB.md).[query](HotDB.md#query)
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:218](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L218)
+
+___
+
+### queryOne
+
+▸ **queryOne**(`queryString`, `values?`): `Promise`<[`MySQLResults`](../interfaces/MySQLResults.md)\>
+
+Make a single query. If there are no results, null will be in MySQLResults.results
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `queryString` | `string` | `undefined` |
+| `values` | `any`[] | `[]` |
+
+#### Returns
+
+`Promise`<[`MySQLResults`](../interfaces/MySQLResults.md)\>
+
+#### Overrides
+
+[HotDB](HotDB.md).[queryOne](HotDB.md#queryone)
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:237](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L237)
+
+___
+
+### syncMigrationsTableTracker
+
+▸ **syncMigrationsTableTracker**(): `Promise`<`void`\>
+
+Sync the migrations table tracker. This keeps track of all database table migrations.
+If the "migrations" table is missing, it will be created.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:177](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L177)
+
+___
+
+### tableCheck
+
+▸ **tableCheck**(`tableName`): `Promise`<`boolean`\>
+
+Checks if the table exists.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tableName` | `string` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Overrides
+
+[HotDB](HotDB.md).[tableCheck](HotDB.md#tablecheck)
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:191](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBMySQL.ts#L191)

package/docs/classes/HotDBSchema.md

@@ -0,0 +1,51 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotDBSchema
+
+# Class: HotDBSchema
+
+The parent database schema.
+
+## Hierarchy
+
+- **`HotDBSchema`**
+
+  ↳ [`MySQLSchema`](MySQLSchema.md)
+
+  ↳ [`InfluxSchema`](InfluxSchema.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotDBSchema.md#constructor)
+
+### Properties
+
+- [name](HotDBSchema.md#name)
+
+## Constructors
+
+### constructor
+
+• **new HotDBSchema**(`name`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Defined in
+
+[schemas/HotDBSchema.ts:17](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBSchema.ts#L17)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+The name of this schema.
+
+#### Defined in
+
+[schemas/HotDBSchema.ts:15](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBSchema.ts#L15)

package/docs/classes/HotFile.md

@@ -0,0 +1,353 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotFile
+
+# Class: HotFile
+
+A file to process.
+
+## Implements
+
+- `IHotFile`
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotFile.md#constructor)
+
+### Properties
+
+- [content](HotFile.md#content)
+- [localFile](HotFile.md#localfile)
+- [name](HotFile.md#name)
+- [page](HotFile.md#page)
+- [throwAllErrors](HotFile.md#throwallerrors)
+- [url](HotFile.md#url)
+
+### Methods
+
+- [getContent](HotFile.md#getcontent)
+- [load](HotFile.md#load)
+- [loadLocalFile](HotFile.md#loadlocalfile)
+- [loadUrl](HotFile.md#loadurl)
+- [process](HotFile.md#process)
+- [setContent](HotFile.md#setcontent)
+- [httpGet](HotFile.md#httpget)
+- [processContent](HotFile.md#processcontent)
+- [processNestedContent](HotFile.md#processnestedcontent)
+
+## Constructors
+
+### constructor
+
+• **new HotFile**(`copy?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `copy` | `IHotFile` |
+
+#### Defined in
+
+[HotFile.ts:70](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L70)
+
+## Properties
+
+### content
+
+• **content**: `string`
+
+The content of the file to process.
+
+#### Implementation of
+
+IHotFile.content
+
+#### Defined in
+
+[HotFile.ts:64](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L64)
+
+___
+
+### localFile
+
+• **localFile**: `string`
+
+The path to the local file to get.
+
+#### Implementation of
+
+IHotFile.localFile
+
+#### Defined in
+
+[HotFile.ts:60](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L60)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the file.
+
+#### Implementation of
+
+IHotFile.name
+
+#### Defined in
+
+[HotFile.ts:52](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L52)
+
+___
+
+### page
+
+• **page**: [`HotPage`](HotPage.md)
+
+The parent page.
+
+#### Implementation of
+
+IHotFile.page
+
+#### Defined in
+
+[HotFile.ts:48](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L48)
+
+___
+
+### throwAllErrors
+
+• **throwAllErrors**: `boolean`
+
+Force all errors to be thrown.
+
+#### Implementation of
+
+IHotFile.throwAllErrors
+
+#### Defined in
+
+[HotFile.ts:68](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L68)
+
+___
+
+### url
+
+• **url**: `string`
+
+The url to the file to get.
+
+#### Implementation of
+
+IHotFile.url
+
+#### Defined in
+
+[HotFile.ts:56](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L56)
+
+## Methods
+
+### getContent
+
+▸ **getContent**(): `string`
+
+Get the content of this file.
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[HotFile.ts:91](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L91)
+
+___
+
+### load
+
+▸ **load**(): `Promise`<`string`\>
+
+Load the contents of the file.
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[HotFile.ts:154](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L154)
+
+___
+
+### loadLocalFile
+
+▸ **loadLocalFile**(): `Promise`<`string`\>
+
+Load content from a local file.
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[HotFile.ts:131](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L131)
+
+___
+
+### loadUrl
+
+▸ **loadUrl**(): `Promise`<`string`\>
+
+Load content from a url.
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[HotFile.ts:121](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L121)
+
+___
+
+### process
+
+▸ **process**(`args?`): `Promise`<`string`\>
+
+Process the content in this file. This treats each file as one large JavaScript
+file. Any text outside of the <* *> areas will be treated as:
+
+		Hot.echo ("text");
+
+**`fixme`** The regex's in the offContent functions need to be fixed. There's several
+test cases where they will fail.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `args` | `any` | `null` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[HotFile.ts:330](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L330)
+
+___
+
+### setContent
+
+▸ **setContent**(`content`): `void`
+
+Set the content of this file.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `content` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[HotFile.ts:83](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L83)
+
+___
+
+### httpGet
+
+▸ `Static` **httpGet**(`url`): `Promise`<`string`\>
+
+Make a HTTP get request.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[HotFile.ts:99](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L99)
+
+___
+
+### processContent
+
+▸ `Static` **processContent**(`content`, `contentRegex`, `contentProcessor`, `offContentProcessor`, `numRemoveFromBeginning?`, `numRemoveFromEnd?`): `string`
+
+Process string content. This will take in a regular expression and
+parse the content based on the regex. When the regex content is found
+contentProcessor will be executed with the regex content found. When
+the regex content is not found, offContentProcessor will be called with
+the content outside of the regex.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `content` | `string` | `undefined` | The content to parse. |
+| `contentRegex` | `RegExp` | `undefined` | The regex to use to parse the content. |
+| `contentProcessor` | (`regexFound`: `string`) => `string` | `undefined` | The content found inside the regex. |
+| `offContentProcessor` | (`offContent`: `string`) => `string` | `undefined` | The content found outside of the regex. |
+| `numRemoveFromBeginning` | `number` | `2` | The number of characters to remove from the beginning of the found content. |
+| `numRemoveFromEnd` | `number` | `2` | The number of characters to remove from the end of the found content. |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[HotFile.ts:183](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L183)
+
+___
+
+### processNestedContent
+
+▸ `Static` **processNestedContent**(`content`, `startChars`, `endChars`, `triggerChar`, `contentProcessor`, `offContentProcessor`, `numRemoveFromBeginning?`, `numRemoveFromEnd?`): `string`
+
+Process any content that could have nested values. This will
+take in a regular expression and
+parse the content based on the regex. When the regex content is found
+contentProcessor will be executed with the regex content found. When
+the regex content is not found, offContentProcessor will be called with
+the content outside of the regex.
+
+**`fixme`** Needs to be able to ignore any characters found inside comments
+or a string. For example, if the following is used ```${"Test }"}``` It
+will error out.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `content` | `string` | `undefined` | The content to parse. |
+| `startChars` | `string` | `undefined` | - |
+| `endChars` | `string` | `undefined` | - |
+| `triggerChar` | `string` | `undefined` | - |
+| `contentProcessor` | (`regexFound`: `string`) => `string` | `undefined` | The content found inside the regex. |
+| `offContentProcessor` | (`offContent`: `string`) => `string` | `undefined` | The content found outside of the regex. |
+| `numRemoveFromBeginning` | `number` | `2` | The number of characters to remove from the beginning of the found content. |
+| `numRemoveFromEnd` | `number` | `1` | The number of characters to remove from the end of the found content. |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[HotFile.ts:241](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotFile.ts#L241)