@twin.org/api-models 0.0.2-next.1 → 0.0.2-next.11

package/docs/reference/interfaces/IHttpRequestContext.md

@@ -6,6 +6,10 @@ Context data from the HTTP request.
 
 - [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
 
+## Extended by
+
+- [`ISocketRequestContext`](ISocketRequestContext.md)
+
 ## Properties
 
 ### serverRequest
@@ -28,6 +32,14 @@ The state handed through the processors.
 
 ***
 
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+Logging component type for the request.
+
+***
+
 ### nodeIdentity?
 
 > `optional` **nodeIdentity**: `string`

package/docs/reference/interfaces/IHttpServerRequest.md

@@ -6,6 +6,10 @@ Model for the standard parameters for an http request.
 
 - [`IHttpRequest`](IHttpRequest.md)\<`T`\>
 
+## Extended by
+
+- [`ISocketServerRequest`](ISocketServerRequest.md)
+
 ## Type Parameters
 
 ### T
@@ -62,6 +66,18 @@ Data to return send as the body.
 
 ***
 
+### authentication?
+
+> `optional` **authentication**: `unknown`
+
+Used to authenticate and will be passed to the configured authentication provider for the request.
+
+#### Inherited from
+
+[`IHttpRequest`](IHttpRequest.md).[`authentication`](IHttpRequest.md#authentication)
+
+***
+
 ### method?
 
 > `optional` **method**: `HttpMethod`

package/docs/reference/interfaces/IInformationComponent.md

@@ -8,6 +8,20 @@ The information component for the server.
 
 ## Methods
 
+### root()
+
+> **root**(): `Promise`\<`string`\>
+
+Get the root information.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The root information.
+
+***
+
 ### info()
 
 > **info**(): `Promise`\<[`IServerInfo`](IServerInfo.md)\>
@@ -22,6 +36,20 @@ The service information.
 
 ***
 
+### favicon()
+
+> **favicon**(): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+Get the favicon.
+
+#### Returns
+
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+The favicon.
+
+***
+
 ### spec()
 
 > **spec**(): `Promise`\<`unknown`\>

package/docs/reference/interfaces/INoContentRequest.md

@@ -8,6 +8,18 @@ A REST request with no input parameters.
 
 ## Properties
 
+### authentication?
+
+> `optional` **authentication**: `unknown`
+
+Used to authenticate and will be passed to the configured authentication provider for the request.
+
+#### Inherited from
+
+[`IHttpRequest`](IHttpRequest.md).[`authentication`](IHttpRequest.md#authentication)
+
+***
+
 ### headers?
 
 > `optional` **headers**: `undefined`

package/docs/reference/interfaces/INotFoundResponse.md

@@ -18,7 +18,7 @@ Response status code.
 
 The body which contains the error.
 
-#### Type declaration
+#### Type Declaration
 
 ##### notFoundId?
 

package/docs/reference/interfaces/IRestRoute.md

@@ -54,6 +54,18 @@ Skips the authentication for this route.
 
 ***
 
+### processorFeatures?
+
+> `optional` **processorFeatures**: `string`[]
+
+The features supported by additional processors to run for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`processorFeatures`](IBaseRoute.md#processorfeatures)
+
+***
+
 ### summary
 
 > **summary**: `string`

package/docs/reference/interfaces/IRestRouteProcessor.md

@@ -8,9 +8,29 @@ The definition for a processor for handling REST routes.
 
 ## Methods
 
+### features()?
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
+
+***
+
 ### pre()?
 
-> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -44,6 +64,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -58,7 +84,7 @@ Promise that resolves when the request is processed.
 
 ### post()?
 
-> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -92,6 +118,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -106,7 +138,7 @@ Promise that resolves when the request is processed.
 
 ### process()?
 
-> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -140,6 +172,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IServerFavIconResponse.md

@@ -0,0 +1,33 @@
+# Interface: IServerFavIconResponse
+
+The favicon for the server.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+Additional response headers.
+
+#### content-type?
+
+> `optional` **content-type**: `string`
+
+The content type for the response.
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### body?
+
+> `optional` **body**: `Uint8Array`\<`ArrayBufferLike`\>
+
+The favicon for the server.

package/docs/reference/interfaces/IServerRootResponse.md

@@ -0,0 +1,11 @@
+# Interface: IServerRootResponse
+
+The root text for the server.
+
+## Properties
+
+### body
+
+> **body**: `string`
+
+The root text for the server.

package/docs/reference/interfaces/ISocketRequestContext.md

@@ -0,0 +1,79 @@
+# Interface: ISocketRequestContext
+
+Context data from the socket request.
+
+## Extends
+
+- [`IHttpRequestContext`](IHttpRequestContext.md)
+
+## Properties
+
+### serverRequest
+
+> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
+
+The raw HTTP request.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`serverRequest`](IHttpRequestContext.md#serverrequest)
+
+***
+
+### processorState
+
+> **processorState**: `object`
+
+The state handed through the processors.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`processorState`](IHttpRequestContext.md#processorstate)
+
+***
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+Logging component type for the request.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`loggingComponentType`](IHttpRequestContext.md#loggingcomponenttype)
+
+***
+
+### nodeIdentity?
+
+> `optional` **nodeIdentity**: `string`
+
+The identity of the node the request is being performed on.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`nodeIdentity`](IHttpRequestContext.md#nodeidentity)
+
+***
+
+### userIdentity?
+
+> `optional` **userIdentity**: `string`
+
+The identity of the requestor if there is an authenticated user.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`userIdentity`](IHttpRequestContext.md#useridentity)
+
+***
+
+### socketId
+
+> **socketId**: `string`
+
+The id of the socket.

package/docs/reference/interfaces/ISocketRoute.md

@@ -54,17 +54,29 @@ Skips the authentication for this route.
 
 ***
 
+### processorFeatures?
+
+> `optional` **processorFeatures**: `string`[]
+
+The features supported by additional processors to run for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`processorFeatures`](IBaseRoute.md#processorfeatures)
+
+***
+
 ### handler()
 
-> **handler**: (`httpRequestContext`, `request`, `emit`) => `void`
+> **handler**: (`socketRequestContext`, `request`, `emit`) => `void`
 
 The handler module.
 
 #### Parameters
 
-##### httpRequestContext
+##### socketRequestContext
 
-[`IHttpRequestContext`](IHttpRequestContext.md)
+[`ISocketRequestContext`](ISocketRequestContext.md)
 
 The request context.
 
@@ -83,3 +95,43 @@ The function to emit an event.
 #### Returns
 
 `void`
+
+***
+
+### connected()?
+
+> `optional` **connected**: (`socketRequestContext`) => `void`
+
+The connected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`void`
+
+***
+
+### disconnected()?
+
+> `optional` **disconnected**: (`socketRequestContext`) => `void`
+
+The disconnected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`void`

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -4,13 +4,33 @@ The definition for a processor for handling socket routes.
 
 ## Extends
 
-- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md)\>
+- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md), [`ISocketServerRequest`](ISocketServerRequest.md)\>
 
 ## Methods
 
+### features()?
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
+
+***
+
 ### pre()?
 
-> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -18,7 +38,7 @@ Pre process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
 The request to handle.
 
@@ -44,6 +64,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -58,7 +84,7 @@ Promise that resolves when the request is processed.
 
 ### post()?
 
-> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -66,7 +92,7 @@ Post process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
 The request to handle.
 
@@ -92,6 +118,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -106,7 +138,7 @@ Promise that resolves when the request is processed.
 
 ### connected()?
 
-> `optional` **connected**(`request`, `route`, `processorState`): `Promise`\<`void`\>
+> `optional` **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the connected event.
 
@@ -114,9 +146,9 @@ Process the connected event.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
-The request to handle.
+The server request object containing the socket id and other parameters.
 
 ##### route
 
@@ -124,9 +156,11 @@ The route being requested, if a matching one was found.
 
 `undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
 
-##### processorState
+##### loggingComponentType?
 
-The state handed through the processors.
+`string`
+
+The logging component type for the request.
 
 #### Returns
 
@@ -138,7 +172,7 @@ Promise that resolves when the request is processed.
 
 ### disconnected()?
 
-> `optional` **disconnected**(`request`, `route`, `processorState`): `Promise`\<`void`\>
+> `optional` **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the disconnected event.
 
@@ -146,9 +180,9 @@ Process the disconnected event.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
-The request to handle.
+The server request object containing the socket id and other parameters.
 
 ##### route
 
@@ -156,9 +190,11 @@ The route being requested, if a matching one was found.
 
 `undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
 
-##### processorState
+##### loggingComponentType?
 
-The state handed through the processors.
+`string`
+
+The logging component type for the request.
 
 #### Returns
 
@@ -170,7 +206,7 @@ Promise that resolves when the request is processed.
 
 ### process()?
 
-> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -178,9 +214,9 @@ Process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
-The request to handle.
+The server request object containing the socket id and other parameters.
 
 ##### response
 
@@ -210,6 +246,12 @@ The state handed through the processors.
 
 The function to emit a response.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>