hotstaq 0.5.24

package/docs/classes/HotRoute.md

@@ -0,0 +1,312 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotRoute
+
+# Class: HotRoute
+
+The route to use.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotRoute.md#constructor)
+
+### Properties
+
+- [authCredentials](HotRoute.md#authcredentials)
+- [connection](HotRoute.md#connection)
+- [errors](HotRoute.md#errors)
+- [logger](HotRoute.md#logger)
+- [methods](HotRoute.md#methods)
+- [onAuthorizeUser](HotRoute.md#onauthorizeuser)
+- [onPostRegister](HotRoute.md#onpostregister)
+- [onPreRegister](HotRoute.md#onpreregister)
+- [onRegister](HotRoute.md#onregister)
+- [prefix](HotRoute.md#prefix)
+- [route](HotRoute.md#route)
+- [version](HotRoute.md#version)
+
+### Methods
+
+- [addMethod](HotRoute.md#addmethod)
+- [getMethod](HotRoute.md#getmethod)
+- [createError](HotRoute.md#createerror)
+
+## Constructors
+
+### constructor
+
+• **new HotRoute**(`connection`, `route`, `methods?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `connection` | [`HotServer`](HotServer.md) \| [`HotClient`](HotClient.md) | `undefined` |
+| `route` | `string` | `undefined` |
+| `methods` | [`HotRouteMethod`](HotRouteMethod.md)[] | `[]` |
+
+#### Defined in
+
+[HotRoute.ts:46](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L46)
+
+## Properties
+
+### authCredentials
+
+• **authCredentials**: `any`
+
+The authorization credentials to be used by the client
+when connecting to the server.
+
+#### Defined in
+
+[HotRoute.ts:35](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L35)
+
+___
+
+### connection
+
+• **connection**: [`HotServer`](HotServer.md) \| [`HotClient`](HotClient.md)
+
+The server that maintains the connections.
+
+#### Defined in
+
+[HotRoute.ts:14](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L14)
+
+___
+
+### errors
+
+• **errors**: `Object`
+
+The errors and their JSON that can be thrown. Can be:
+* not_authorized
+
+#### Index signature
+
+▪ [error: `string`]: `any`
+
+#### Defined in
+
+[HotRoute.ts:44](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L44)
+
+___
+
+### logger
+
+• **logger**: [`HotLog`](HotLog.md)
+
+The associated logger.
+
+#### Defined in
+
+[HotRoute.ts:18](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L18)
+
+___
+
+### methods
+
+• **methods**: [`HotRouteMethod`](HotRouteMethod.md)[]
+
+The calls that can be made.
+
+#### Defined in
+
+[HotRoute.ts:39](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L39)
+
+___
+
+### onAuthorizeUser
+
+• **onAuthorizeUser**: (`req`: `any`, `res`: `any`) => `Promise`<`any`\> = `null`
+
+#### Type declaration
+
+▸ (`req`, `res`): `Promise`<`any`\>
+
+Executes when authorizing a called method.
+The value returned from here will be passed to onExecute in the
+called HotRouteMethod. Undefined returning from here will mean
+the authorization failed.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `req` | `any` |
+| `res` | `any` |
+
+##### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotRoute.ts:136](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L136)
+
+___
+
+### onPostRegister
+
+• **onPostRegister**: () => `Promise`<`void`\> = `null`
+
+#### Type declaration
+
+▸ (): `Promise`<`void`\>
+
+Executes after all routes have been registered.
+
+##### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotRoute.ts:128](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L128)
+
+___
+
+### onPreRegister
+
+• **onPreRegister**: () => `Promise`<`void`\> = `null`
+
+#### Type declaration
+
+▸ (): `Promise`<`void`\>
+
+Executes before all routes have been registered.
+
+##### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotRoute.ts:119](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L119)
+
+___
+
+### onRegister
+
+• **onRegister**: () => `Promise`<`boolean`\> = `null`
+
+#### Type declaration
+
+▸ (): `Promise`<`boolean`\>
+
+Executes when first registering this route with Express. If
+this returns false, the route will not be registered.
+
+##### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+[HotRoute.ts:124](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L124)
+
+___
+
+### prefix
+
+• **prefix**: `string`
+
+The prefix to add to the beginning of each route method.
+
+#### Defined in
+
+[HotRoute.ts:30](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L30)
+
+___
+
+### route
+
+• **route**: `string`
+
+The route.
+
+#### Defined in
+
+[HotRoute.ts:22](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L22)
+
+___
+
+### version
+
+• **version**: `string`
+
+The version.
+
+#### Defined in
+
+[HotRoute.ts:26](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L26)
+
+## Methods
+
+### addMethod
+
+▸ **addMethod**(`method`, `executeFunction?`, `type?`, `testCases?`): `void`
+
+Add an API method to this route.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `method` | `string` \| [`HotRouteMethod`](HotRouteMethod.md) | `undefined` | The name of the method to add. If a HotRouteMethod is supplied, the rest of the arguments supplied will be ignored. |
+| `executeFunction` | [`ServerExecutionFunction`](../modules.md#serverexecutionfunction) | `null` | - |
+| `type` | [`HTTPMethod`](../enums/HTTPMethod.md) | `HTTPMethod.POST` | - |
+| `testCases` | (`string` \| `TestCaseFunction`)[] \| `TestCaseFunction`[] \| `TestCaseObject`[] | `null` | - |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[HotRoute.ts:81](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L81)
+
+___
+
+### getMethod
+
+▸ **getMethod**(`name`): [`HotRouteMethod`](HotRouteMethod.md)
+
+Get a method by it's name.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+[`HotRouteMethod`](HotRouteMethod.md)
+
+#### Defined in
+
+[HotRoute.ts:97](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L97)
+
+___
+
+### createError
+
+▸ `Static` **createError**(`message`): `any`
+
+Create an error JSON object.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+[HotRoute.ts:70](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRoute.ts#L70)

package/docs/classes/HotRouteMethod.md

@@ -0,0 +1,271 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotRouteMethod
+
+# Class: HotRouteMethod
+
+An API method to make.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotRouteMethod.md#constructor)
+
+### Properties
+
+- [authCredentials](HotRouteMethod.md#authcredentials)
+- [executeSetup](HotRouteMethod.md#executesetup)
+- [isRegistered](HotRouteMethod.md#isregistered)
+- [name](HotRouteMethod.md#name)
+- [onClientExecute](HotRouteMethod.md#onclientexecute)
+- [onPostRegister](HotRouteMethod.md#onpostregister)
+- [onPreRegister](HotRouteMethod.md#onpreregister)
+- [onRegister](HotRouteMethod.md#onregister)
+- [onServerAuthorize](HotRouteMethod.md#onserverauthorize)
+- [onServerExecute](HotRouteMethod.md#onserverexecute)
+- [parentRoute](HotRouteMethod.md#parentroute)
+- [testCases](HotRouteMethod.md#testcases)
+- [type](HotRouteMethod.md#type)
+
+### Methods
+
+- [addTestCase](HotRouteMethod.md#addtestcase)
+
+## Constructors
+
+### constructor
+
+• **new HotRouteMethod**(`route`, `name`, `onExecute?`, `type?`, `onServerAuthorize?`, `onRegister?`, `authCredentials?`, `testCases?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `route` | [`HotRoute`](HotRoute.md) | `undefined` |
+| `name` | `string` | `undefined` |
+| `onExecute` | [`ServerExecutionFunction`](../modules.md#serverexecutionfunction) \| `ClientExecutionFunction` | `null` |
+| `type` | [`HTTPMethod`](../enums/HTTPMethod.md) | `HTTPMethod.POST` |
+| `onServerAuthorize` | [`ServerAuthorizationFunction`](../modules.md#serverauthorizationfunction) | `null` |
+| `onRegister` | `ServerRegistrationFunction` | `null` |
+| `authCredentials` | `any` | `null` |
+| `testCases` | (`string` \| `TestCaseFunction`)[] \| `TestCaseFunction`[] \| `TestCaseObject`[] | `null` |
+
+#### Defined in
+
+[HotRouteMethod.ts:95](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L95)
+
+## Properties
+
+### authCredentials
+
+• **authCredentials**: `any`
+
+The authorization credentials to be used by the client
+when connecting to the server.
+
+#### Defined in
+
+[HotRouteMethod.ts:87](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L87)
+
+___
+
+### executeSetup
+
+• **executeSetup**: `boolean`
+
+Has this method been registered with the server? This
+prevents the method from being reregistered.
+
+#### Defined in
+
+[HotRouteMethod.ts:82](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L82)
+
+___
+
+### isRegistered
+
+• **isRegistered**: `boolean`
+
+Has this method been registered with the server? This
+prevents the method from being reregistered.
+
+#### Defined in
+
+[HotRouteMethod.ts:77](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L77)
+
+___
+
+### name
+
+• **name**: `string`
+
+The api call name.
+
+#### Defined in
+
+[HotRouteMethod.ts:68](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L68)
+
+___
+
+### onClientExecute
+
+• `Optional` **onClientExecute**: `ClientExecutionFunction`
+
+Executes when executing a called method from the client side.
+
+**`fixme`** Is this necessary?
+
+#### Defined in
+
+[HotRouteMethod.ts:178](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L178)
+
+___
+
+### onPostRegister
+
+• `Optional` **onPostRegister**: () => `Promise`<`void`\>
+
+#### Type declaration
+
+▸ (): `Promise`<`void`\>
+
+Executes after all routes have been registered.
+
+##### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotRouteMethod.ts:151](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L151)
+
+___
+
+### onPreRegister
+
+• `Optional` **onPreRegister**: () => `Promise`<`void`\>
+
+#### Type declaration
+
+▸ (): `Promise`<`void`\>
+
+Executes before all routes have been registered.
+
+##### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotRouteMethod.ts:142](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L142)
+
+___
+
+### onRegister
+
+• `Optional` **onRegister**: `ServerRegistrationFunction`
+
+Executes when first registering this method with Express. If
+this returns false, the method will not be registered.
+
+#### Defined in
+
+[HotRouteMethod.ts:147](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L147)
+
+___
+
+### onServerAuthorize
+
+• `Optional` **onServerAuthorize**: [`ServerAuthorizationFunction`](../modules.md#serverauthorizationfunction)
+
+Executes when authorizing a called method. If this method
+is set, this will not call onAuthorize for the parent HotRoute.
+The value returned from here will be passed to onExecute.
+Undefined returning from here will mean the authorization failed.
+If any exceptions are thrown from this function, they will be sent
+to the server as an { error: string; } object with the exception
+message as the error.
+
+#### Defined in
+
+[HotRouteMethod.ts:162](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L162)
+
+___
+
+### onServerExecute
+
+• `Optional` **onServerExecute**: [`ServerExecutionFunction`](../modules.md#serverexecutionfunction)
+
+Executes when executing a called method from the server side.
+This will stringify any JSON object and send it as a JSON response.
+If undefined is returned no response will be sent to the server.
+So the developer would have to send a response using "res".
+If any exceptions are thrown from this function, they will be sent
+to the server as an { error: string; } object with the exception
+message as the error.
+
+#### Defined in
+
+[HotRouteMethod.ts:173](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L173)
+
+___
+
+### parentRoute
+
+• **parentRoute**: [`HotRoute`](HotRoute.md)
+
+The parent route.
+
+#### Defined in
+
+[HotRouteMethod.ts:64](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L64)
+
+___
+
+### testCases
+
+• **testCases**: `Object`
+
+The test case objects to execute during tests.
+
+#### Index signature
+
+▪ [name: `string`]: `TestCaseObject`
+
+#### Defined in
+
+[HotRouteMethod.ts:91](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L91)
+
+___
+
+### type
+
+• **type**: [`HTTPMethod`](../enums/HTTPMethod.md)
+
+The api call name.
+
+#### Defined in
+
+[HotRouteMethod.ts:72](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L72)
+
+## Methods
+
+### addTestCase
+
+▸ **addTestCase**(`newTestCase`, `testCaseFunction?`): `void`
+
+Add a new test case.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `newTestCase` | `string` \| `TestCaseFunction` \| `TestCaseObject` | `undefined` |
+| `testCaseFunction` | `TestCaseFunction` | `null` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[HotRouteMethod.ts:183](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotRouteMethod.ts#L183)