@3sixty/api-processors 0.0.0-stage → 0.20.0-next.1

package/docs/reference/classes/JsonLdMimeTypeProcessor.md

@@ -0,0 +1,87 @@
+# Class: JsonLdMimeTypeProcessor
+
+Process the JSON-LD mime type.
+
+## Implements
+
+- `IMimeTypeProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new JsonLdMimeTypeProcessor**(): `JsonLdMimeTypeProcessor`
+
+#### Returns
+
+`JsonLdMimeTypeProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IMimeTypeProcessor.className`
+
+***
+
+### getTypes() {#gettypes}
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+#### Implementation of
+
+`IMimeTypeProcessor.getTypes`
+
+***
+
+### handle() {#handle}
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+##### body
+
+`Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.
+
+#### Implementation of
+
+`IMimeTypeProcessor.handle`

package/docs/reference/classes/JwtMimeTypeProcessor.md

@@ -0,0 +1,87 @@
+# Class: JwtMimeTypeProcessor
+
+Process the JWT mime type.
+
+## Implements
+
+- `IMimeTypeProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new JwtMimeTypeProcessor**(): `JwtMimeTypeProcessor`
+
+#### Returns
+
+`JwtMimeTypeProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IMimeTypeProcessor.className`
+
+***
+
+### getTypes() {#gettypes}
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+#### Implementation of
+
+`IMimeTypeProcessor.getTypes`
+
+***
+
+### handle() {#handle}
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+##### body
+
+`Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.
+
+#### Implementation of
+
+`IMimeTypeProcessor.handle`

package/docs/reference/classes/LoggingProcessor.md

@@ -0,0 +1,153 @@
+# Class: LoggingProcessor
+
+Process the REST request and log its information.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new LoggingProcessor**(`options?`): `LoggingProcessor`
+
+Create a new instance of LoggingProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ILoggingProcessorConstructorOptions`](../interfaces/ILoggingProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`LoggingProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBaseRouteProcessor.className`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the pre-processing log entry has been written.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`
+
+***
+
+### post() {#post}
+
+> **post**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the post-processing log entry has been written.
+
+#### Implementation of
+
+`IBaseRouteProcessor.post`

package/docs/reference/classes/RestRouteProcessor.md

@@ -0,0 +1,107 @@
+# Class: RestRouteProcessor
+
+Process the REST request and hands it on to the route handler.
+
+## Implements
+
+- `IRestRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new RestRouteProcessor**(`options?`): `RestRouteProcessor`
+
+Create a new instance of RouteProcessor.
+
+#### Parameters
+
+##### options?
+
+[`IRestRouteProcessorConstructorOptions`](../interfaces/IRestRouteProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`RestRouteProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IRestRouteProcessor.className`
+
+***
+
+### process() {#process}
+
+> **process**(`request`, `response`, `route`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IRestRoute`\<`any`, `any`\> \| `undefined`
+
+The route to process.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the request has been processed and the response populated.
+
+#### Implementation of
+
+`IRestRouteProcessor.process`

package/docs/reference/classes/SocketRouteProcessor.md

@@ -0,0 +1,185 @@
+# Class: SocketRouteProcessor
+
+Process the socket request and hands it on to the route handler.
+
+## Implements
+
+- `ISocketRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new SocketRouteProcessor**(`options?`): `SocketRouteProcessor`
+
+Create a new instance of SocketRouteProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ISocketRouteProcessorConstructorOptions`](../interfaces/ISocketRouteProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`SocketRouteProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ISocketRouteProcessor.className`
+
+***
+
+### connected() {#connected}
+
+> **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the connected event.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Implementation of
+
+`ISocketRouteProcessor.connected`
+
+***
+
+### disconnected() {#disconnected}
+
+> **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the disconnected event.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Implementation of
+
+`ISocketRouteProcessor.disconnected`
+
+***
+
+### process() {#process}
+
+> **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the socket request for the specified route.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route to process.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### responseEmitter
+
+(`topic`, `response`) => `Promise`\<`void`\>
+
+The function to emit a response.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the request has been processed and the response emitted.
+
+#### Implementation of
+
+`ISocketRouteProcessor.process`

package/docs/reference/classes/StaticContextIdProcessor.md

@@ -0,0 +1,103 @@
+# Class: StaticContextIdProcessor
+
+Adds a static context id to the request context.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new StaticContextIdProcessor**(`options`): `StaticContextIdProcessor`
+
+Create a new instance of StaticContextIdProcessor.
+
+#### Parameters
+
+##### options
+
+[`IStaticContextIdProcessorConstructorOptions`](../interfaces/IStaticContextIdProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`StaticContextIdProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBaseRouteProcessor.className`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the static context ID has been injected into the request.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`