@twin.org/api-models 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/interfaces/IServerRootResponse.md

@@ -4,6 +4,18 @@ The root text for the server.
 
 ## Properties
 
+### headers
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
 ### body
 
 > **body**: `string`

package/docs/reference/interfaces/ISocketRequestContext.md

@@ -48,6 +48,18 @@ Logging component type for the request.
 
 ***
 
+### hostingComponentType?
+
+> `optional` **hostingComponentType**: `string`
+
+Hosting component type for the request.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`hostingComponentType`](IHttpRequestContext.md#hostingcomponenttype)
+
+***
+
 ### socketId
 
 > **socketId**: `string`

package/docs/reference/interfaces/ISocketRoute.md

@@ -46,7 +46,7 @@ The path to use for routing.
 
 > `optional` **skipAuth**: `boolean`
 
-Skips the authentication for this route.
+Skips the authentication requirement for this route.
 
 #### Inherited from
 
@@ -54,6 +54,30 @@ Skips the authentication for this route.
 
 ***
 
+### skipTenant?
+
+> `optional` **skipTenant**: `boolean`
+
+Skips the tenant requirement for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
+
+***
+
+### requiredScope?
+
+> `optional` **requiredScope**: `string`[]
+
+The user must have one of the specified scopes to access the route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiredScope`](IBaseRoute.md#requiredscope)
+
+***
+
 ### processorFeatures?
 
 > `optional` **processorFeatures**: `string`[]

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -30,7 +30,7 @@ The features supported by this processor.
 
 ### pre()?
 
-> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -64,11 +64,21 @@ The context IDs of the request.
 
 The state handed through the processors.
 
-##### loggingComponentType?
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
 
 `string`
 
-The logging component type for the request.
+The logging component type.
+
+###### hostingComponentType?
+
+`string`
+
+The hosting component type.
 
 #### Returns
 
@@ -84,7 +94,7 @@ Promise that resolves when the request is processed.
 
 ### post()?
 
-> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -118,11 +128,21 @@ The context IDs of the request.
 
 The state handed through the processors.
 
-##### loggingComponentType?
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
 
 `string`
 
-The logging component type for the request.
+The logging component type.
+
+###### hostingComponentType?
+
+`string`
+
+The hosting component type.
 
 #### Returns
 

package/docs/reference/interfaces/ISocketServerRequest.md

@@ -62,27 +62,27 @@ Data to return send as the body.
 
 ***
 
-### method?
+### url
 
-> `optional` **method**: `HttpMethod`
+> **url**: `string`
 
-The request method.
+The request url.
 
 #### Inherited from
 
-[`IHttpServerRequest`](IHttpServerRequest.md).[`method`](IHttpServerRequest.md#method)
+[`IHttpServerRequest`](IHttpServerRequest.md).[`url`](IHttpServerRequest.md#url)
 
 ***
 
-### url?
+### method?
 
-> `optional` **url**: `string`
+> `optional` **method**: `HttpMethod`
 
-The request url.
+The request method.
 
 #### Inherited from
 
-[`IHttpServerRequest`](IHttpServerRequest.md).[`url`](IHttpServerRequest.md#url)
+[`IHttpServerRequest`](IHttpServerRequest.md).[`method`](IHttpServerRequest.md#method)
 
 ***
 

package/docs/reference/interfaces/ITenant.md

@@ -0,0 +1,59 @@
+# Interface: ITenant
+
+Model defining the tenant.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The unique identifier for the tenant.
+
+***
+
+### apiKey
+
+> **apiKey**: `string`
+
+The api key for the tenant.
+
+***
+
+### label
+
+> **label**: `string`
+
+The label of the tenant.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date the tenant was created.
+
+***
+
+### dateModified
+
+> **dateModified**: `string`
+
+The date the tenant was modified.
+
+***
+
+### publicOrigin?
+
+> `optional` **publicOrigin**: `string`
+
+The public origin available to the public for accessing the API.
+
+***
+
+### isNodeTenant
+
+> **isNodeTenant**: `boolean`
+
+Indicates whether the tenant is the node tenant.

package/docs/reference/interfaces/ITenantAdminComponent.md

@@ -0,0 +1,193 @@
+# Interface: ITenantAdminComponent
+
+Configuration for the tenant admin component
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### 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**(`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**(`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**(`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**(`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**(`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**(`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/IWebServerOptions.md

@@ -10,12 +10,6 @@ Options for the web server.
 
 The port to bind the web server to.
 
-#### Default
-
-```ts
-3000
-```
-
 ***
 
 ### host?
@@ -24,12 +18,6 @@ The port to bind the web server to.
 
 The address to bind the web server to.
 
-#### Default
-
-```ts
-localhost
-```
-
 ***
 
 ### methods?
@@ -38,12 +26,6 @@ localhost
 
 The methods that the server accepts.
 
-#### Default
-
-```ts
-["GET", "PUT", "POST", "DELETE", "OPTIONS"]
-```
-
 ***
 
 ### allowedHeaders?
@@ -67,9 +49,3 @@ And additional exposed headers.
 > `optional` **corsOrigins**: `string` \| `string`[]
 
 The allowed CORS domains.
-
-#### Default
-
-```ts
-["*"]
-```

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.3-next.2",
-	"description": "Contains models and classes for use with APIs",
+	"version": "0.0.3-next.21",
+	"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/types/factories/authenticationGeneratorFactory.d.ts

@@ -1,6 +0,0 @@
-import { Factory } from "@twin.org/core";
-import type { IAuthenticationGenerator } from "../models/client/IAuthenticationGenerator.js";
-/**
- * Factory for creating implementation of authentication generator types.
- */
-export declare const AuthenticationGeneratorFactory: Factory<IAuthenticationGenerator>;

package/dist/types/models/client/IAuthenticationGenerator.d.ts

@@ -1,14 +0,0 @@
-import type { IComponent } from "@twin.org/core";
-import type { IHttpHeaders } from "@twin.org/web";
-/**
- * Definition for the authentication generator component.
- */
-export interface IAuthenticationGenerator extends IComponent {
-    /**
-     * Adds authentication information to the request headers.
-     * @param requestHeaders The request headers to add authentication information to.
-     * @param authData Optional authentication data passed from the request.
-     * @returns A promise that resolves when the authentication information has been added.
-     */
-    addAuthentication(requestHeaders: IHttpHeaders, authData?: unknown): Promise<void>;
-}

package/docs/reference/interfaces/IAuthenticationGenerator.md

@@ -1,35 +0,0 @@
-# Interface: IAuthenticationGenerator
-
-Definition for the authentication generator component.
-
-## Extends
-
-- `IComponent`
-
-## Methods
-
-### addAuthentication()
-
-> **addAuthentication**(`requestHeaders`, `authData?`): `Promise`\<`void`\>
-
-Adds authentication information to the request headers.
-
-#### Parameters
-
-##### requestHeaders
-
-`IHttpHeaders`
-
-The request headers to add authentication information to.
-
-##### authData?
-
-`unknown`
-
-Optional authentication data passed from the request.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the authentication information has been added.

package/docs/reference/variables/AuthenticationGeneratorFactory.md

@@ -1,5 +0,0 @@
-# Variable: AuthenticationGeneratorFactory
-
-> `const` **AuthenticationGeneratorFactory**: `Factory`\<[`IAuthenticationGenerator`](../interfaces/IAuthenticationGenerator.md)\>
-
-Factory for creating implementation of authentication generator types.