@twin.org/api-models 0.0.1-next.8 → 0.0.1

package/dist/types/models/server/IWebServer.d.ts

@@ -1,6 +1,8 @@
-import type { IHttpRestRouteProcessor } from "./IHttpRestRouteProcessor";
+import type { IRestRouteProcessor } from "./IRestRouteProcessor";
+import type { ISocketRouteProcessor } from "./ISocketRouteProcessor";
 import type { IWebServerOptions } from "./IWebServerOptions";
 import type { IRestRoute } from "../routes/IRestRoute";
+import type { ISocketRoute } from "../routes/ISocketRoute";
 /**
  * Interface describing a web server.
  */
@@ -12,12 +14,14 @@ export interface IWebServer<T> {
     getInstance(): T;
     /**
      * Build the server.
-     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param restRouteProcessors The processors for incoming requests over REST.
      * @param restRoutes The REST routes.
+     * @param socketRouteProcessors The processors for incoming requests over Sockets.
+     * @param socketRoutes The socket routes.
      * @param options Options for building the server.
      * @returns Nothing.
      */
-    build(restRouteProcessors: IHttpRestRouteProcessor[], restRoutes: IRestRoute[], options?: IWebServerOptions): Promise<void>;
+    build(restRouteProcessors?: IRestRouteProcessor[], restRoutes?: IRestRoute[], socketRouteProcessors?: ISocketRouteProcessor[], socketRoutes?: ISocketRoute[], options?: IWebServerOptions): Promise<void>;
     /**
      * Start the server.
      * @returns Nothing.

package/docs/changelog.md

@@ -1,5 +1,47 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1-next.8
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
+
+## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.35...api-models-v0.0.1-next.36) (2025-06-17)
+
+
+### Features
+
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/twinfoundation/api/commit/6452b153af786eee14b21152420f8a2578b70593))
+
+## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.34...api-models-v0.0.1-next.35) (2025-06-11)
+
+
+### Features
+
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+
+## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.33...api-models-v0.0.1-next.34) (2025-05-27)
+
+
+### Features
+
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/twinfoundation/api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+
+## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.32...api-models-v0.0.1-next.33) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.31...api-models-v0.0.1-next.32) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## v0.0.1-next.31
 
 - Initial Release

package/docs/reference/classes/HttpErrorHelper.md

@@ -4,29 +4,33 @@ Class to help with processing http errors.
 
 ## Constructors
 
-### new HttpErrorHelper()
+### Constructor
 
-> **new HttpErrorHelper**(): [`HttpErrorHelper`](HttpErrorHelper.md)
+> **new HttpErrorHelper**(): `HttpErrorHelper`
 
 #### Returns
 
-[`HttpErrorHelper`](HttpErrorHelper.md)
+`HttpErrorHelper`
 
 ## Methods
 
 ### processError()
 
-> `static` **processError**(`err`, `includeStack`?): `object`
+> `static` **processError**(`err`, `includeStack?`): `object`
 
 Process the errors from the routes.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The error to process.
 
-• **includeStack?**: `boolean`
+##### includeStack?
+
+`boolean`
 
 Should the stack be included in the error.
 
@@ -54,15 +58,21 @@ Build an error response.
 
 #### Parameters
 
-• **response**: [`IHttpResponse`](../interfaces/IHttpResponse.md)\<`any`\>
+##### response
+
+[`IHttpResponse`](../interfaces/IHttpResponse.md)
 
 The response to build the error into.
 
-• **error**: `IError`
+##### error
+
+`IError`
 
 The error to build the response for.
 
-• **statusCode**: `HttpStatusCode`
+##### statusCode
+
+`HttpStatusCode`
 
 The status code to use for the error.
 

package/docs/reference/classes/HttpParameterHelper.md

@@ -4,29 +4,33 @@ Class to help with handling http parameters.
 
 ## Constructors
 
-### new HttpParameterHelper()
+### Constructor
 
-> **new HttpParameterHelper**(): [`HttpParameterHelper`](HttpParameterHelper.md)
+> **new HttpParameterHelper**(): `HttpParameterHelper`
 
 #### Returns
 
-[`HttpParameterHelper`](HttpParameterHelper.md)
+`HttpParameterHelper`
 
 ## Methods
 
 ### arrayFromString()
 
-> `static` **arrayFromString**\<`T`\>(`values`?): `undefined` \| `T`[]
+> `static` **arrayFromString**\<`T`\>(`values?`): `undefined` \| `T`[]
 
 Convert list query to array.
 
 #### Type Parameters
 
-• **T** = `string`
+##### T
+
+`T` = `string`
 
 #### Parameters
 
-• **values?**: `string`
+##### values?
+
+`string`
 
 The values query string.
 
@@ -40,17 +44,21 @@ The array of values.
 
 ### arrayToString()
 
-> `static` **arrayToString**\<`T`\>(`values`?): `undefined` \| `string`
+> `static` **arrayToString**\<`T`\>(`values?`): `undefined` \| `string`
 
 Convert array of values to query string.
 
 #### Type Parameters
 
-• **T** = `string`
+##### T
+
+`T` = `string`
 
 #### Parameters
 
-• **values?**: `T`[]
+##### values?
+
+`T`[]
 
 The values to combine string.
 
@@ -62,88 +70,56 @@ The combined.
 
 ***
 
-### conditionsFromString()
+### objectFromString()
 
-> `static` **conditionsFromString**(`conditions`?): `undefined` \| `IComparator`[]
+> `static` **objectFromString**\<`T`\>(`value?`): `undefined` \| `T`
 
-Convert the conditions string to a list of comparators.
+Convert object string to object.
 
-#### Parameters
-
-• **conditions?**: `string`
-
-The conditions query string.
-
-#### Returns
-
-`undefined` \| `IComparator`[]
-
-The list of comparators.
-
-***
-
-### conditionsToString()
+#### Type Parameters
 
-> `static` **conditionsToString**(`conditions`?): `undefined` \| `string`
+##### T
 
-Convert the conditions to a string parameter.
+`T` = `unknown`
 
 #### Parameters
 
-• **conditions?**: `IComparator`[]
+##### value?
 
-The conditions to convert.
+`string`
 
-#### Returns
-
-`undefined` \| `string`
-
-The string version of the comparators.
-
-***
-
-### sortPropertiesFromString()
-
-> `static` **sortPropertiesFromString**\<`T`\>(`sortProperties`?): `undefined` \| `object`[]
-
-Convert the sort string to a list of sort properties.
-
-#### Type Parameters
-
-• **T** = `unknown`
-
-#### Parameters
-
-• **sortProperties?**: `string`
-
-The sort properties query string.
+The value query string.
 
 #### Returns
 
-`undefined` \| `object`[]
+`undefined` \| `T`
 
-The list of sort properties.
+The object.
 
 ***
 
-### sortPropertiesToString()
+### objectToString()
 
-> `static` **sortPropertiesToString**\<`T`\>(`sortProperties`?): `undefined` \| `string`
+> `static` **objectToString**\<`T`\>(`value?`): `undefined` \| `string`
 
-Convert the sort properties to a string parameter.
+Convert object to query string.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **sortProperties?**: `object`[]
+##### value?
+
+`T`
 
-The sort properties to convert.
+The value to convert to a string.
 
 #### Returns
 
 `undefined` \| `string`
 
-The string version of the sort properties.
+The converted object.

package/docs/reference/index.md

@@ -32,8 +32,8 @@
 - [INoContentResponse](interfaces/INoContentResponse.md)
 - [IOkResponse](interfaces/IOkResponse.md)
 - [IBaseRoute](interfaces/IBaseRoute.md)
+- [IBaseRouteEntryPoint](interfaces/IBaseRouteEntryPoint.md)
 - [IRestRoute](interfaces/IRestRoute.md)
-- [IRestRouteEntryPoint](interfaces/IRestRouteEntryPoint.md)
 - [IRestRouteExample](interfaces/IRestRouteExample.md)
 - [IRestRouteRequestExample](interfaces/IRestRouteRequestExample.md)
 - [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
@@ -41,7 +41,10 @@
 - [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
 - [ISocketRoute](interfaces/ISocketRoute.md)
 - [ITag](interfaces/ITag.md)
-- [IHttpRestRouteProcessor](interfaces/IHttpRestRouteProcessor.md)
+- [IBaseRouteProcessor](interfaces/IBaseRouteProcessor.md)
+- [IMimeTypeProcessor](interfaces/IMimeTypeProcessor.md)
+- [IRestRouteProcessor](interfaces/IRestRouteProcessor.md)
+- [ISocketRouteProcessor](interfaces/ISocketRouteProcessor.md)
 - [IWebServer](interfaces/IWebServer.md)
 - [IWebServerOptions](interfaces/IWebServerOptions.md)
 - [IHealthInfo](interfaces/IHealthInfo.md)
@@ -50,8 +53,13 @@
 
 ## Type Aliases
 
+- [IRestRouteEntryPoint](type-aliases/IRestRouteEntryPoint.md)
+- [ISocketRouteEntryPoint](type-aliases/ISocketRouteEntryPoint.md)
 - [HealthStatus](type-aliases/HealthStatus.md)
 
 ## Variables
 
+- [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
+- [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
+- [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)
 - [HealthStatus](variables/HealthStatus.md)

package/docs/reference/interfaces/IBaseRouteEntryPoint.md

@@ -0,0 +1,55 @@
+# Interface: IBaseRouteEntryPoint\<T\>
+
+Route entry points are used for exposing the routes from a package.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+The name of the routes.
+
+***
+
+### defaultBaseRoute
+
+> **defaultBaseRoute**: `string`
+
+The default base route name for the routes.
+
+***
+
+### tags
+
+> **tags**: [`ITag`](ITag.md)[]
+
+The tags for the routes.
+
+***
+
+### generateRoutes()
+
+> **generateRoutes**: (`baseRouteName`, `componentName`) => `T`[]
+
+The method to generate the routes.
+
+#### Parameters
+
+##### baseRouteName
+
+`string`
+
+##### componentName
+
+`string`
+
+#### Returns
+
+`T`[]

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -0,0 +1,106 @@
+# Interface: IBaseRouteProcessor\<T\>
+
+The definition for a base processor for handling REST routes.
+
+## Extends
+
+- `IComponent`
+
+## Extended by
+
+- [`IRestRouteProcessor`](IRestRouteProcessor.md)
+- [`ISocketRouteProcessor`](ISocketRouteProcessor.md)
+
+## Type Parameters
+
+### T
+
+`T` = [`IBaseRoute`](IBaseRoute.md)
+
+## Methods
+
+### pre()?
+
+> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+The route being requested, if a matching one was found.
+
+`undefined` | `T`
+
+##### requestIdentity
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+##### processorState
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### post()?
+
+> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+The route being requested, if a matching one was found.
+
+`undefined` | `T`
+
+##### requestIdentity
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+##### processorState
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/IBaseSocketClientConfig.md

@@ -4,6 +4,14 @@ Definition for the configuration of a socket service.
 
 ## Properties
 
+### basePath?
+
+> `optional` **basePath**: `string`
+
+Base path for the socket service, defaults to /socket.
+
+***
+
 ### endpoint
 
 > **endpoint**: `string`

package/docs/reference/interfaces/IHealthInfo.md

@@ -17,3 +17,21 @@ The status.
 > `optional` **components**: `object`[]
 
 The status of the components.
+
+#### name
+
+> **name**: `string`
+
+The name of the component.
+
+#### status
+
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+The status of the component.
+
+#### details?
+
+> `optional` **details**: `string`
+
+The details for the status.

package/docs/reference/interfaces/IHttpRequest.md

@@ -9,7 +9,9 @@ Model for the standard parameters for an http request.
 
 ## Type Parameters
 
-• **T** = `any`
+### T
+
+`T` = `any`
 
 ## Properties
 

package/docs/reference/interfaces/IHttpRequestContext.md

@@ -10,7 +10,7 @@ Context data from the HTTP request.
 
 ### serverRequest
 
-> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
 
 The raw HTTP request.
 
@@ -24,7 +24,7 @@ The state handed through the processors.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 ***
 

package/docs/reference/interfaces/IHttpRequestPathParams.md

@@ -4,4 +4,4 @@ Model for the standard parameters for an http request.
 
 ## Indexable
 
- \[`id`: `string`\]: `string` \| `number` \| `boolean`
+\[`id`: `string`\]: `string` \| `number` \| `boolean`

package/docs/reference/interfaces/IHttpRequestQuery.md

@@ -4,4 +4,4 @@ Model used for Http request query parameters.
 
 ## Indexable
 
- \[`id`: `string`\]: `string` \| `number` \| `boolean`
+\[`id`: `string`\]: `string` \| `number` \| `boolean`

package/docs/reference/interfaces/IHttpResponse.md

@@ -4,7 +4,9 @@ Model for the standard parameters for an http response.
 
 ## Type Parameters
 
-• **T** = `any`
+### T
+
+`T` = `any`
 
 ## Properties
 

package/docs/reference/interfaces/IHttpServerRequest.md

@@ -8,7 +8,9 @@ Model for the standard parameters for an http request.
 
 ## Type Parameters
 
-• **T** = `any`
+### T
+
+`T` = `any`
 
 ## Properties
 

package/docs/reference/interfaces/IInformationComponent.md

@@ -52,21 +52,27 @@ The service health.
 
 ### setComponentHealth()
 
-> **setComponentHealth**(`name`, `status`, `details`?): `Promise`\<`void`\>
+> **setComponentHealth**(`name`, `status`, `details?`): `Promise`\<`void`\>
 
 Set the status of a component.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The component name.
 
-• **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+##### status
+
+[`HealthStatus`](../type-aliases/HealthStatus.md)
 
 The status of the component.
 
-• **details?**: `string`
+##### details?
+
+`string`
 
 The details for the status.
 
@@ -86,7 +92,9 @@ Remove the status of a component.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The component name.