@twin.org/api-models 0.0.3-next.3 → 0.0.3-next.30

package/docs/reference/interfaces/ITenantAdminComponent.md

@@ -0,0 +1,193 @@
+# Interface: ITenantAdminComponent
+
+Configuration for the tenant admin component
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create() {#create}
+
+> **create**(`tenant`): `Promise`\<`string`\>
+
+Create a tenant.
+
+#### Parameters
+
+##### tenant
+
+`Omit`\<[`ITenant`](ITenant.md), `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
+
+The tenant to store.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The tenant id.
+
+***
+
+### update() {#update}
+
+> **update**(`tenant`): `Promise`\<`void`\>
+
+Update a tenant.
+
+#### Parameters
+
+##### tenant
+
+`Partial`\<`Omit`\<[`ITenant`](ITenant.md), `"dateCreated"` \| `"dateModified"`\>\>
+
+The tenant to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### get() {#get}
+
+> **get**(`tenantId`): `Promise`\<[`ITenant`](ITenant.md)\>
+
+Get a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](ITenant.md)\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### getByApiKey() {#getbyapikey}
+
+> **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](ITenant.md)\>
+
+Get a tenant by its api key.
+
+#### Parameters
+
+##### apiKey
+
+`string`
+
+The api key of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](ITenant.md)\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### getByPublicOrigin() {#getbypublicorigin}
+
+> **getByPublicOrigin**(`publicOrigin`): `Promise`\<[`ITenant`](ITenant.md)\>
+
+Get a tenant by its public origin.
+
+#### Parameters
+
+##### publicOrigin
+
+`string`
+
+The origin of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](ITenant.md)\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### remove() {#remove}
+
+> **remove**(`tenantId`): `Promise`\<`void`\>
+
+Remove a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### query() {#query}
+
+> **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\>
+
+Query tenants with pagination.
+
+#### Parameters
+
+##### options?
+
+Optional query options.
+
+###### isNodeTenant?
+
+`boolean`
+
+Whether to filter for node admin tenants.
+
+##### cursor?
+
+`string`
+
+The cursor to start from.
+
+##### limit?
+
+`number`
+
+The maximum number of tenants to return.
+
+#### Returns
+
+`Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\>
+
+The tenants and the next cursor if more tenants are available.

package/docs/reference/interfaces/ITooManyRequestsResponse.md

@@ -0,0 +1,19 @@
+# Interface: ITooManyRequestsResponse
+
+The request resulted in too many requests, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `429`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IUnauthorizedResponse.md

@@ -4,7 +4,7 @@ You are not authorized to use the API or no credentials were supplied, see the c
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `401`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IUnprocessableEntityResponse.md

@@ -4,7 +4,7 @@ The server cannot process the request, see the content for more details.
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `422`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IUrlTransformerComponent.md

@@ -0,0 +1,229 @@
+# Interface: IUrlTransformerComponent
+
+The URL transformer component for encrypting and decrypting URL parameters.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### addEncryptedQueryParamToUrl() {#addencryptedqueryparamtourl}
+
+> **addEncryptedQueryParamToUrl**(`url`, `id`, `value`): `Promise`\<`string`\>
+
+Encrypt a named token value and append it as a query parameter to the given URL.
+The URL param name is resolved from the configured token name dictionary using the id.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to append the encrypted token to.
+
+##### id
+
+`string`
+
+The logical token identifier (e.g. "tenant").
+
+##### value
+
+`string`
+
+The value to encrypt and add.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The URL with the encrypted token added as a query parameter.
+
+***
+
+### getEncryptedQueryParam() {#getencryptedqueryparam}
+
+> **getEncryptedQueryParam**(`queryParams`, `id`): `Promise`\<`string` \| `undefined`\>
+
+Get a named token value from the query parameters.
+The URL param name is resolved from the configured token name dictionary using the id.
+
+#### Parameters
+
+##### queryParams
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
+
+The HTTP request query containing the parameters.
+
+##### id
+
+`string`
+
+The logical token identifier (e.g. "tenant").
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+The decrypted token value if it exists.
+
+***
+
+### addEncryptedParamsToUrl() {#addencryptedparamstourl}
+
+> **addEncryptedParamsToUrl**(`url`, `params`): `Promise`\<`string`\>
+
+Add encrypted key/value pairs to a URL's query string.
+Existing query parameters on the URL are preserved; the provided params are
+merged in and then encrypted before being written back to the URL.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The base URL to add parameters to.
+
+##### params
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md)
+
+The key/value pairs to encrypt and append.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The URL with the encrypted parameters added.
+
+***
+
+### getDecryptedParamsFromQueryParams() {#getdecryptedparamsfromqueryparams}
+
+> **getDecryptedParamsFromQueryParams**(`queryParams`, `keys`): `Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
+
+Decrypt specified keys from a query parameter object and return their plain-text values.
+
+#### Parameters
+
+##### queryParams
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
+
+The HTTP request query containing the encrypted parameters.
+
+##### keys
+
+`string`[]
+
+The keys to decrypt.
+
+#### Returns
+
+`Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
+
+A map of the decrypted key/value pairs that were present.
+
+***
+
+### encryptQueryParams() {#encryptqueryparams}
+
+> **encryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
+
+Encrypt query parameters using the URL transformer's encryption mechanism.
+
+#### Parameters
+
+##### httpRequestQuery
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
+
+The HTTP request query containing the parameters to encrypt.
+
+##### keys
+
+`string`[]
+
+The keys of the parameters to encrypt.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the query parameters have been encrypted.
+
+***
+
+### decryptQueryParams() {#decryptqueryparams}
+
+> **decryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
+
+Decrypt query parameters using the URL transformer's encryption mechanism.
+
+#### Parameters
+
+##### httpRequestQuery
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
+
+The HTTP request query containing the encrypted values.
+
+##### keys
+
+`string`[]
+
+The keys of the parameters to decrypt.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the query parameters have been decrypted.
+
+***
+
+### encryptParam() {#encryptparam}
+
+> **encryptParam**(`paramValue`): `Promise`\<`string`\>
+
+Encrypt a parameter value.
+
+#### Parameters
+
+##### paramValue
+
+`string`
+
+The value of the parameter to encrypt.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the encrypted value of the parameter.
+
+***
+
+### decryptParam() {#decryptparam}
+
+> **decryptParam**(`encryptedValue`): `Promise`\<`string`\>
+
+Decrypt a parameter value.
+
+#### Parameters
+
+##### encryptedValue
+
+`string`
+
+The encrypted value of the parameter.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the decrypted value of the parameter.

package/docs/reference/interfaces/IWebServer.md

@@ -2,6 +2,10 @@
 
 Interface describing a web server.
 
+## Extends
+
+- `IComponent`
+
 ## Type Parameters
 
 ### T
@@ -10,7 +14,7 @@ Interface describing a web server.
 
 ## Methods
 
-### getInstance()
+### getInstance() {#getinstance}
 
 > **getInstance**(): `T`
 
@@ -24,7 +28,7 @@ The web server instance.
 
 ***
 
-### build()
+### build() {#build}
 
 > **build**(`restRouteProcessors?`, `restRoutes?`, `socketRouteProcessors?`, `socketRoutes?`, `options?`): `Promise`\<`void`\>
 
@@ -70,7 +74,7 @@ Nothing.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(): `Promise`\<`void`\>
 
@@ -82,9 +86,13 @@ Start the server.
 
 Nothing.
 
+#### Overrides
+
+`IComponent.start`
+
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 
@@ -95,3 +103,25 @@ Stop the server.
 `Promise`\<`void`\>
 
 Nothing.
+
+#### Overrides
+
+`IComponent.stop`
+
+***
+
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Returns the health status of the component.
+
+#### Returns
+
+`Promise`\<`IHealth`[]\>
+
+The health status of the component, can return multiple entries for elements within the component.
+
+#### Overrides
+
+`IComponent.health`

package/docs/reference/interfaces/IWebServerOptions.md

@@ -4,9 +4,9 @@ Options for the web server.
 
 ## Properties
 
-### port?
+### port? {#port}
 
-> `optional` **port**: `number`
+> `optional` **port?**: `number`
 
 The port to bind the web server to.
 
@@ -18,9 +18,9 @@ The port to bind the web server to.
 
 ***
 
-### host?
+### host? {#host}
 
-> `optional` **host**: `string`
+> `optional` **host?**: `string`
 
 The address to bind the web server to.
 
@@ -32,9 +32,9 @@ localhost
 
 ***
 
-### methods?
+### methods? {#methods}
 
-> `optional` **methods**: `HttpMethod`[]
+> `optional` **methods?**: `HttpMethod`[]
 
 The methods that the server accepts.
 
@@ -46,25 +46,25 @@ The methods that the server accepts.
 
 ***
 
-### allowedHeaders?
+### allowedHeaders? {#allowedheaders}
 
-> `optional` **allowedHeaders**: `string`[]
+> `optional` **allowedHeaders?**: `string`[]
 
 Any additional allowed headers.
 
 ***
 
-### exposedHeaders?
+### exposedHeaders? {#exposedheaders}
 
-> `optional` **exposedHeaders**: `string`[]
+> `optional` **exposedHeaders?**: `string`[]
 
 And additional exposed headers.
 
 ***
 
-### corsOrigins?
+### corsOrigins? {#corsorigins}
 
-> `optional` **corsOrigins**: `string` \| `string`[]
+> `optional` **corsOrigins?**: `string` \| `string`[]
 
 The allowed CORS domains.
 

package/docs/reference/type-aliases/HttpContextIdKeys.md

@@ -0,0 +1,5 @@
+# Type Alias: HttpContextIdKeys
+
+> **HttpContextIdKeys** = *typeof* [`HttpContextIdKeys`](../variables/HttpContextIdKeys.md)\[keyof *typeof* [`HttpContextIdKeys`](../variables/HttpContextIdKeys.md)\]
+
+HTTP definition of some context keys.

package/docs/reference/variables/HttpContextIdKeys.md

@@ -0,0 +1,25 @@
+# Variable: HttpContextIdKeys
+
+> `const` **HttpContextIdKeys**: `object`
+
+HTTP definition of some context keys.
+
+## Type Declaration
+
+### IpAddress {#ipaddress}
+
+> `readonly` **IpAddress**: `"ipAddress"` = `"ipAddress"`
+
+IP address of the client.
+
+### UserAgent {#useragent}
+
+> `readonly` **UserAgent**: `"userAgent"` = `"userAgent"`
+
+User agent of the client.
+
+### CorrelationId {#correlationid}
+
+> `readonly` **CorrelationId**: `"correlationId"` = `"correlationId"`
+
+Correlation ID of the request.

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.3-next.3",
-	"description": "Contains models and classes for use with APIs",
+	"version": "0.0.3-next.30",
+	"description": "Shared API contracts, route types, and response models used across services and clients.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/api.git",

package/dist/es/factories/authenticationGeneratorFactory.js

@@ -1,9 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { Factory } from "@twin.org/core";
-/**
- * Factory for creating implementation of authentication generator types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const AuthenticationGeneratorFactory = Factory.createFactory("authentication-generator");
-//# sourceMappingURL=authenticationGeneratorFactory.js.map

package/dist/es/factories/authenticationGeneratorFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"authenticationGeneratorFactory.js","sourceRoot":"","sources":["../../../src/factories/authenticationGeneratorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAAG,OAAO,CAAC,aAAa,CAClE,0BAA0B,CAC1B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IAuthenticationGenerator } from \"../models/client/IAuthenticationGenerator.js\";\n\n/**\n * Factory for creating implementation of authentication generator types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuthenticationGeneratorFactory = Factory.createFactory<IAuthenticationGenerator>(\n\t\"authentication-generator\"\n);\n"]}

package/dist/es/models/client/IAuthenticationGenerator.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IAuthenticationGenerator.js.map

package/dist/es/models/client/IAuthenticationGenerator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IAuthenticationGenerator.js","sourceRoot":"","sources":["../../../../src/models/client/IAuthenticationGenerator.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IHttpHeaders } from \"@twin.org/web\";\n\n/**\n * Definition for the authentication generator component.\n */\nexport interface IAuthenticationGenerator extends IComponent {\n\t/**\n\t * Adds authentication information to the request headers.\n\t * @param requestHeaders The request headers to add authentication information to.\n\t * @param authData Optional authentication data passed from the request.\n\t * @returns A promise that resolves when the authentication information has been added.\n\t */\n\taddAuthentication(requestHeaders: IHttpHeaders, authData?: unknown): Promise<void>;\n}\n"]}

package/dist/es/models/services/IHealthInfo.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IHealthInfo.js.map

package/dist/es/models/services/IHealthInfo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IHealthInfo.js","sourceRoot":"","sources":["../../../../src/models/services/IHealthInfo.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * The status of the server.\n */\nexport interface IHealthInfo {\n\t/**\n\t * The status.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The status of the components.\n\t */\n\tcomponents?: {\n\t\t/**\n\t\t * The name of the component.\n\t\t */\n\t\tname: string;\n\n\t\t/**\n\t\t * The status of the component.\n\t\t */\n\t\tstatus: HealthStatus;\n\n\t\t/**\n\t\t * The details for the status.\n\t\t */\n\t\tdetails?: string;\n\t}[];\n}\n"]}