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

package/docs/reference/classes/HttpUrlHelper.md

@@ -0,0 +1,262 @@
+# Class: HttpUrlHelper
+
+Class to help with handling http URLs.
+
+## Constructors
+
+### Constructor
+
+> **new HttpUrlHelper**(): `HttpUrlHelper`
+
+#### Returns
+
+`HttpUrlHelper`
+
+## Methods
+
+### extractOrigin() {#extractorigin}
+
+> `static` **extractOrigin**(`url`): `string` \| `undefined`
+
+Extract the origin from the url which includes protocol,host,port.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the origin from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted origin.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/API/URL/origin
+
+***
+
+### extractPath() {#extractpath}
+
+> `static` **extractPath**(`url`): `string` \| `undefined`
+
+Extract the path from the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the path from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted path.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname
+
+***
+
+### extractSearch() {#extractsearch}
+
+> `static` **extractSearch**(`url`): `string` \| `undefined`
+
+Extract the search from the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the search from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted search.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/API/URL/search
+
+***
+
+### extractPathAndSearch() {#extractpathandsearch}
+
+> `static` **extractPathAndSearch**(`url`): `string` \| `undefined`
+
+Extract the path and search from the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the path and search from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted path and search.
+
+***
+
+### combineOriginPath() {#combineoriginpath}
+
+> `static` **combineOriginPath**(`origin?`, `path?`): `string` \| `undefined`
+
+Combine an optional origin and an optional path into a single URL string.
+Relative paths (no protocol, no leading slash) have a leading slash prepended.
+Trailing slashes are trimmed from the origin before joining.
+Returns undefined when both arguments are absent or empty.
+
+#### Parameters
+
+##### origin?
+
+`string`
+
+The optional origin (e.g. "https://example.com").
+
+##### path?
+
+`string`
+
+The optional path or URL template (e.g. "/api/items" or "api/items").
+
+#### Returns
+
+`string` \| `undefined`
+
+The combined string, or undefined when both are absent.
+
+***
+
+### encodeUriPathSegment() {#encodeuripathsegment}
+
+> `static` **encodeUriPathSegment**(`segment`): `string`
+
+Encode a single URL path segment per RFC 3986 §3.3.
+Unlike encodeURIComponent, sub-delimiters ($ & + , ; =) and the colon and
+at-sign characters that are valid unencoded in path segments are preserved.
+
+#### Parameters
+
+##### segment
+
+`string`
+
+The raw path segment value to encode.
+
+#### Returns
+
+`string`
+
+The percent-encoded path segment.
+
+#### See
+
+https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+
+***
+
+### replaceOrigin() {#replaceorigin}
+
+> `static` **replaceOrigin**(`url`, `newOrigin?`): `string`
+
+Replace the origin in the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to replace the origin in.
+
+##### newOrigin?
+
+`string`
+
+The new origin to use.
+
+#### Returns
+
+`string`
+
+The url with the replaced origin.
+
+***
+
+### addQueryStringParam() {#addquerystringparam}
+
+> `static` **addQueryStringParam**(`url`, `key`, `value`): `string`
+
+Add a query string parameter to the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to add the query string parameter to.
+
+##### key
+
+`string`
+
+The key of the query string parameter.
+
+##### value
+
+`string`
+
+The value of the query string parameter.
+
+#### Returns
+
+`string`
+
+The url with the added query string parameter.
+
+***
+
+### getQueryStringParam() {#getquerystringparam}
+
+> `static` **getQueryStringParam**(`url`, `key`): `string` \| `undefined`
+
+Get a query string parameter from the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to get the query string parameter from.
+
+##### key
+
+`string`
+
+The key of the query string parameter.
+
+#### Returns
+
+`string` \| `undefined`
+
+The value of the query string parameter.

package/docs/reference/classes/TooManyRequestsError.md

@@ -0,0 +1,69 @@
+# Class: TooManyRequestsError
+
+Class to handle errors which are triggered by too many requests.
+
+## Extends
+
+- `BaseError`
+
+## Constructors
+
+### Constructor
+
+> **new TooManyRequestsError**(`source`, `message`, `requestCount`, `nextRequestTime`, `properties?`, `cause?`): `TooManyRequestsError`
+
+Create a new instance of TooManyRequestsError.
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### message
+
+`string`
+
+The message as a code.
+
+##### requestCount
+
+`number`
+
+The current request count.
+
+##### nextRequestTime
+
+`string`
+
+The time when the next request can be made, as date ISO string.
+
+##### properties?
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+Any additional information for the error.
+
+##### cause?
+
+`unknown`
+
+The cause of the error if we have wrapped another error.
+
+#### Returns
+
+`TooManyRequestsError`
+
+#### Overrides
+
+`BaseError.constructor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.

package/docs/reference/index.md

@@ -0,0 +1,95 @@
+# @3sixty/api-models
+
+## Classes
+
+- [ForbiddenError](classes/ForbiddenError.md)
+- [TooManyRequestsError](classes/TooManyRequestsError.md)
+- [HttpErrorHelper](classes/HttpErrorHelper.md)
+- [HttpHeaderHelper](classes/HttpHeaderHelper.md)
+- [HttpParameterHelper](classes/HttpParameterHelper.md)
+- [HttpUrlHelper](classes/HttpUrlHelper.md)
+
+## Interfaces
+
+- [IHealth](interfaces/IHealth.md)
+- [IServerFavIconResponse](interfaces/IServerFavIconResponse.md)
+- [IServerHealthResponse](interfaces/IServerHealthResponse.md)
+- [IServerInfoResponse](interfaces/IServerInfoResponse.md)
+- [IServerLivezResponse](interfaces/IServerLivezResponse.md)
+- [IServerReadyzResponse](interfaces/IServerReadyzResponse.md)
+- [IServerRootResponse](interfaces/IServerRootResponse.md)
+- [IServerSpecResponse](interfaces/IServerSpecResponse.md)
+- [IRestClientProcessor](interfaces/IRestClientProcessor.md)
+- [IRestClientProcessorContext](interfaces/IRestClientProcessorContext.md)
+- [IBaseRestClientConfig](interfaces/IBaseRestClientConfig.md)
+- [IBaseSocketClientConfig](interfaces/IBaseSocketClientConfig.md)
+- [IHttpRequest](interfaces/IHttpRequest.md)
+- [IHttpRequestContext](interfaces/IHttpRequestContext.md)
+- [IHttpRequestPathParams](interfaces/IHttpRequestPathParams.md)
+- [IHttpRequestQuery](interfaces/IHttpRequestQuery.md)
+- [IHttpResponse](interfaces/IHttpResponse.md)
+- [IHttpServerRequest](interfaces/IHttpServerRequest.md)
+- [ISocketRequestContext](interfaces/ISocketRequestContext.md)
+- [ISocketServerRequest](interfaces/ISocketServerRequest.md)
+- [INoContentRequest](interfaces/INoContentRequest.md)
+- [IBadRequestResponse](interfaces/IBadRequestResponse.md)
+- [IConflictResponse](interfaces/IConflictResponse.md)
+- [IForbiddenResponse](interfaces/IForbiddenResponse.md)
+- [IInternalServerErrorResponse](interfaces/IInternalServerErrorResponse.md)
+- [INotFoundResponse](interfaces/INotFoundResponse.md)
+- [INotImplementedResponse](interfaces/INotImplementedResponse.md)
+- [ITooManyRequestsResponse](interfaces/ITooManyRequestsResponse.md)
+- [IUnauthorizedResponse](interfaces/IUnauthorizedResponse.md)
+- [IUnprocessableEntityResponse](interfaces/IUnprocessableEntityResponse.md)
+- [IAcceptedResponse](interfaces/IAcceptedResponse.md)
+- [ICreatedResponse](interfaces/ICreatedResponse.md)
+- [INoContentResponse](interfaces/INoContentResponse.md)
+- [IOkResponse](interfaces/IOkResponse.md)
+- [IBaseRoute](interfaces/IBaseRoute.md)
+- [IBaseRouteEntryPoint](interfaces/IBaseRouteEntryPoint.md)
+- [IRestRoute](interfaces/IRestRoute.md)
+- [IRestRouteExample](interfaces/IRestRouteExample.md)
+- [IRestRouteRequestExample](interfaces/IRestRouteRequestExample.md)
+- [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
+- [IRestRouteResponseExample](interfaces/IRestRouteResponseExample.md)
+- [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
+- [IRouteAuthorization](interfaces/IRouteAuthorization.md)
+- [ISocketRoute](interfaces/ISocketRoute.md)
+- [ITag](interfaces/ITag.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)
+- [IHealthComponent](interfaces/IHealthComponent.md)
+- [IHealthProviderComponent](interfaces/IHealthProviderComponent.md)
+- [IInformationComponent](interfaces/IInformationComponent.md)
+- [IPlatformComponent](interfaces/IPlatformComponent.md)
+- [IServerInfo](interfaces/IServerInfo.md)
+- [ITenant](interfaces/ITenant.md)
+- [ITenantAdminComponent](interfaces/ITenantAdminComponent.md)
+
+## Type Aliases
+
+- [HealthCategory](type-aliases/HealthCategory.md)
+- [HealthStatus](type-aliases/HealthStatus.md)
+- [HttpContextIdKeys](type-aliases/HttpContextIdKeys.md)
+- [IRestRouteEntryPoint](type-aliases/IRestRouteEntryPoint.md)
+- [ISocketRouteEntryPoint](type-aliases/ISocketRouteEntryPoint.md)
+- [HttpBodyLimit](type-aliases/HttpBodyLimit.md)
+- [HealthApplicationCallback](type-aliases/HealthApplicationCallback.md)
+- [TenantEventCallback](type-aliases/TenantEventCallback.md)
+- [TenantEventType](type-aliases/TenantEventType.md)
+
+## Variables
+
+- [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
+- [RestClientProcessorFactory](variables/RestClientProcessorFactory.md)
+- [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
+- [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)
+- [HealthCategory](variables/HealthCategory.md)
+- [HealthStatus](variables/HealthStatus.md)
+- [HttpContextIdKeys](variables/HttpContextIdKeys.md)
+- [HttpBodyLimit](variables/HttpBodyLimit.md)
+- [TenantEventType](variables/TenantEventType.md)

package/docs/reference/interfaces/IAcceptedResponse.md

@@ -0,0 +1,25 @@
+# Interface: IAcceptedResponse
+
+The rest request ended in accepted response.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `202`
+
+Response status code.
+
+***
+
+### headers {#headers}
+
+> **headers**: `object`
+
+Additional response headers.
+
+#### location
+
+> **location**: `string`
+
+The location where the resource was accepted.

package/docs/reference/interfaces/IBadRequestResponse.md

@@ -0,0 +1,19 @@
+# Interface: IBadRequestResponse
+
+The server cannot process the request, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `400`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IBaseRestClientConfig.md

@@ -0,0 +1,99 @@
+# Interface: IBaseRestClientConfig
+
+Definition for the configuration of a rest client.
+
+## Properties
+
+### endpoint {#endpoint}
+
+> **endpoint**: `string`
+
+The endpoint where the api is hosted.
+
+***
+
+### pathPrefix? {#pathprefix}
+
+> `optional` **pathPrefix?**: `string`
+
+The prefix to the routes.
+
+***
+
+### headers? {#headers}
+
+> `optional` **headers?**: `IHttpHeaders`
+
+The headers to include in requests.
+
+***
+
+### timeout? {#timeout}
+
+> `optional` **timeout?**: `number`
+
+Timeout for requests in ms.
+
+***
+
+### includeCredentials? {#includecredentials}
+
+> `optional` **includeCredentials?**: `boolean`
+
+Include credentials in the request, defaults to true.
+
+***
+
+### processorTypes? {#processortypes}
+
+> `optional` **processorTypes?**: `string`[]
+
+The types of the processors to run around each request, resolved from the `RestClientProcessorFactory`.
+
+***
+
+### customHeaders? {#customheaders}
+
+> `optional` **customHeaders?**: () => `Promise`\<`IHttpHeaders`\>
+
+Hook to provide headers asynchronously.
+
+#### Returns
+
+`Promise`\<`IHttpHeaders`\>
+
+A promise that resolves to the headers.
+
+***
+
+### customAuthHeader? {#customauthheader}
+
+> `optional` **customAuthHeader?**: () => `Promise`\<`string`\>
+
+Hook to provide an authorization header value asynchronously.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the authorization header value.
+
+***
+
+### onAuthFailure? {#onauthfailure}
+
+> `optional` **onAuthFailure?**: (`err`) => `Promise`\<`void`\>
+
+Hook to handle authorization failures asynchronously.
+
+#### Parameters
+
+##### err
+
+`IError`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the auth failure handling is complete.

package/docs/reference/interfaces/IBaseRoute.md

@@ -0,0 +1,89 @@
+# Interface: IBaseRoute
+
+Interface which defines a route.
+
+## Extended by
+
+- [`IRestRoute`](IRestRoute.md)
+- [`ISocketRoute`](ISocketRoute.md)
+
+## Properties
+
+### operationId {#operationid}
+
+> **operationId**: `string`
+
+The id of the operation.
+
+***
+
+### path {#path}
+
+> **path**: `string`
+
+The path to use for routing.
+
+***
+
+### skipAuth? {#skipauth}
+
+> `optional` **skipAuth?**: `boolean`
+
+Skips the authentication requirement for this route.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### skipTenant? {#skiptenant}
+
+> `optional` **skipTenant?**: `boolean`
+
+Skips the tenant requirement for this route.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### requiresAuthorization? {#requiresauthorization}
+
+> `optional` **requiresAuthorization?**: `boolean`
+
+Requires authorization for this route.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### defaultAuthorization? {#defaultauthorization}
+
+> `optional` **defaultAuthorization?**: [`IRouteAuthorization`](IRouteAuthorization.md)
+
+The default authorization which can access this route, used to seed the RBAC rules.
+
+***
+
+### disableTenantOverride? {#disabletenantoverride}
+
+> `optional` **disableTenantOverride?**: `boolean`
+
+Set to true to prevent callers from using the overrideTenant query parameter on this route.
+Tenant override is allowed by default, but you must hold the escalated privilege role to use it.
+
+#### Default
+
+```ts
+false
+```

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}
+
+`T`
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The name of the routes.
+
+***
+
+### defaultBaseRoute {#defaultbaseroute}
+
+> **defaultBaseRoute**: `string`
+
+The default base route name for the routes.
+
+***
+
+### tags {#tags}
+
+> **tags**: [`ITag`](ITag.md)[]
+
+The tags for the routes.
+
+***
+
+### generateRoutes {#generateroutes}
+
+> **generateRoutes**: (`baseRouteName`, `componentName`) => `T`[]
+
+The method to generate the routes.
+
+#### Parameters
+
+##### baseRouteName
+
+`string`
+
+##### componentName
+
+`string`
+
+#### Returns
+
+`T`[]