@twin.org/engine-server-types 0.0.1-next.14

package/dist/types/models/types/socketRouteProcessorType.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Socket route processor types.
+ */
+export declare const SocketRouteProcessorType: {
+    /**
+     * Auth header.
+     */
+    readonly AuthHeader: "auth-header";
+    /**
+     * Logging.
+     */
+    readonly Logging: "logging";
+    /**
+     * Node Identity.
+     */
+    readonly NodeIdentity: "node-identity";
+    /**
+     * Static User Identity.
+     */
+    readonly StaticUserIdentity: "static-user-identity";
+    /**
+     * Socket Route.
+     */
+    readonly SocketRoute: "socket-route";
+};
+/**
+ * Socket route processor types.
+ */
+export type SocketRouteProcessorType = (typeof SocketRouteProcessorType)[keyof typeof SocketRouteProcessorType];

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/engine-server-types - Changelog
+
+## v0.0.1-next.14
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/engine-server-types - Examples

package/docs/reference/functions/initialiseAuthenticationComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseAuthenticationComponent()
+
+> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the authentication.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseInformationComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseInformationComponent()
+
+> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the information component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseMimeTypeProcessorComponent()
+
+> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the mime type processor.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseRestRouteProcessorComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseRestRouteProcessorComponent()
+
+> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the rest route processor.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseSocketRouteProcessorComponent()
+
+> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the socket route processor.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/index.md

@@ -0,0 +1,34 @@
+# @twin.org/engine-server-types
+
+## Interfaces
+
+- [IEngineServerTypesConfig](interfaces/IEngineServerTypesConfig.md)
+
+## Type Aliases
+
+- [AuthenticationComponentConfig](type-aliases/AuthenticationComponentConfig.md)
+- [InformationComponentConfig](type-aliases/InformationComponentConfig.md)
+- [MimeTypeProcessorConfig](type-aliases/MimeTypeProcessorConfig.md)
+- [RestRouteProcessorConfig](type-aliases/RestRouteProcessorConfig.md)
+- [SocketRouteProcessorConfig](type-aliases/SocketRouteProcessorConfig.md)
+- [AuthenticationComponentType](type-aliases/AuthenticationComponentType.md)
+- [InformationComponentType](type-aliases/InformationComponentType.md)
+- [MimeTypeProcessorType](type-aliases/MimeTypeProcessorType.md)
+- [RestRouteProcessorType](type-aliases/RestRouteProcessorType.md)
+- [SocketRouteProcessorType](type-aliases/SocketRouteProcessorType.md)
+
+## Variables
+
+- [AuthenticationComponentType](variables/AuthenticationComponentType.md)
+- [InformationComponentType](variables/InformationComponentType.md)
+- [MimeTypeProcessorType](variables/MimeTypeProcessorType.md)
+- [RestRouteProcessorType](variables/RestRouteProcessorType.md)
+- [SocketRouteProcessorType](variables/SocketRouteProcessorType.md)
+
+## Functions
+
+- [initialiseAuthenticationComponent](functions/initialiseAuthenticationComponent.md)
+- [initialiseInformationComponent](functions/initialiseInformationComponent.md)
+- [initialiseMimeTypeProcessorComponent](functions/initialiseMimeTypeProcessorComponent.md)
+- [initialiseRestRouteProcessorComponent](functions/initialiseRestRouteProcessorComponent.md)
+- [initialiseSocketRouteProcessorComponent](functions/initialiseSocketRouteProcessorComponent.md)

package/docs/reference/interfaces/IEngineServerTypesConfig.md

@@ -0,0 +1,59 @@
+# Interface: IEngineServerTypesConfig
+
+Extended engine server config with known types.
+
+## Extends
+
+- `IEngineCoreTypesConfig`
+
+## Properties
+
+### web?
+
+> `optional` **web**: `IWebServerOptions`
+
+Configuration for the web server.
+
+***
+
+### types
+
+> **types**: `object` & `object`
+
+The types to initialise in the engine.
+
+#### Type declaration
+
+##### informationComponent?
+
+> `optional` **informationComponent**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
+
+Information component options which can be overridden by individual components by specifying types other than default..
+
+##### restRouteProcessor?
+
+> `optional` **restRouteProcessor**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
+
+REST route processors options which can be overridden by individual components by specifying types other than default..
+
+##### socketRouteProcessor?
+
+> `optional` **socketRouteProcessor**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
+
+Socket route processors options which can be overridden by individual components by specifying types other than default..
+
+##### mimeTypeProcessor?
+
+> `optional` **mimeTypeProcessor**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
+
+Mime type processors options which can be overridden by individual components by specifying types other than default..
+
+##### authenticationComponent?
+
+> `optional` **authenticationComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
+
+Authentication component options which can be overridden by individual components by specifying types other than default..
+
+#### Overrides
+
+`IEngineCoreTypesConfig.types`

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

@@ -0,0 +1,27 @@
+# Type Alias: AuthenticationComponentConfig
+
+> **AuthenticationComponentConfig**: `object`
+
+Authentication component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `AuthenticationComponentType.EntityStorage`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.userEntityStorageType?
+
+> `optional` **userEntityStorageType**: `string`
+
+### options.vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IEntityStorageAuthenticationServiceConfig`

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

@@ -0,0 +1,5 @@
+# Type Alias: AuthenticationComponentType
+
+> **AuthenticationComponentType**: *typeof* [`AuthenticationComponentType`](../variables/AuthenticationComponentType.md)\[keyof *typeof* [`AuthenticationComponentType`](../variables/AuthenticationComponentType.md)\]
+
+Authentication component types.

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

@@ -0,0 +1,19 @@
+# Type Alias: InformationComponentConfig
+
+> **InformationComponentConfig**: `object`
+
+Information component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `InformationComponentType.Service`
+
+### options
+
+> **options**: `object`
+
+### options.config
+
+> **config**: `IInformationServiceConfig`

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

@@ -0,0 +1,5 @@
+# Type Alias: InformationComponentType
+
+> **InformationComponentType**: *typeof* [`InformationComponentType`](../variables/InformationComponentType.md)\[keyof *typeof* [`InformationComponentType`](../variables/InformationComponentType.md)\]
+
+Information component types.

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

@@ -0,0 +1,15 @@
+# Type Alias: MimeTypeProcessorConfig
+
+> **MimeTypeProcessorConfig**: `object`
+
+Mime type processor config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `MimeTypeProcessorType.Jwt`
+
+### options?
+
+> `optional` **options**: `never`

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

@@ -0,0 +1,5 @@
+# Type Alias: MimeTypeProcessorType
+
+> **MimeTypeProcessorType**: *typeof* [`MimeTypeProcessorType`](../variables/MimeTypeProcessorType.md)\[keyof *typeof* [`MimeTypeProcessorType`](../variables/MimeTypeProcessorType.md)\]
+
+Mime type processor types.

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

@@ -0,0 +1,5 @@
+# Type Alias: RestRouteProcessorConfig
+
+> **RestRouteProcessorConfig**: `object` \| `object` \| `object` \| `object` \| `object`
+
+REST route processor config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: RestRouteProcessorType
+
+> **RestRouteProcessorType**: *typeof* [`RestRouteProcessorType`](../variables/RestRouteProcessorType.md)\[keyof *typeof* [`RestRouteProcessorType`](../variables/RestRouteProcessorType.md)\]
+
+REST route processor types.

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

@@ -0,0 +1,5 @@
+# Type Alias: SocketRouteProcessorConfig
+
+> **SocketRouteProcessorConfig**: `object` \| `object` \| `object` \| `object` \| `object`
+
+Socket route processor config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: SocketRouteProcessorType
+
+> **SocketRouteProcessorType**: *typeof* [`SocketRouteProcessorType`](../variables/SocketRouteProcessorType.md)\[keyof *typeof* [`SocketRouteProcessorType`](../variables/SocketRouteProcessorType.md)\]
+
+Socket route processor types.

package/docs/reference/variables/AuthenticationComponentType.md

@@ -0,0 +1,13 @@
+# Variable: AuthenticationComponentType
+
+> `const` **AuthenticationComponentType**: `object`
+
+Authentication component types.
+
+## Type declaration
+
+### EntityStorage
+
+> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
+
+Entity storage.

package/docs/reference/variables/InformationComponentType.md

@@ -0,0 +1,13 @@
+# Variable: InformationComponentType
+
+> `const` **InformationComponentType**: `object`
+
+Information component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/MimeTypeProcessorType.md

@@ -0,0 +1,13 @@
+# Variable: MimeTypeProcessorType
+
+> `const` **MimeTypeProcessorType**: `object`
+
+Mime type route processor types.
+
+## Type declaration
+
+### Jwt
+
+> `readonly` **Jwt**: `"jwt"` = `"jwt"`
+
+Jwt.

package/docs/reference/variables/RestRouteProcessorType.md

@@ -0,0 +1,37 @@
+# Variable: RestRouteProcessorType
+
+> `const` **RestRouteProcessorType**: `object`
+
+REST route processor types.
+
+## Type declaration
+
+### AuthHeader
+
+> `readonly` **AuthHeader**: `"auth-header"` = `"auth-header"`
+
+Auth header.
+
+### Logging
+
+> `readonly` **Logging**: `"logging"` = `"logging"`
+
+Logging.
+
+### NodeIdentity
+
+> `readonly` **NodeIdentity**: `"node-identity"` = `"node-identity"`
+
+Node Identity.
+
+### StaticUserIdentity
+
+> `readonly` **StaticUserIdentity**: `"static-user-identity"` = `"static-user-identity"`
+
+Static User Identity.
+
+### RestRoute
+
+> `readonly` **RestRoute**: `"rest-route"` = `"rest-route"`
+
+REST Route.

package/docs/reference/variables/SocketRouteProcessorType.md

@@ -0,0 +1,37 @@
+# Variable: SocketRouteProcessorType
+
+> `const` **SocketRouteProcessorType**: `object`
+
+Socket route processor types.
+
+## Type declaration
+
+### AuthHeader
+
+> `readonly` **AuthHeader**: `"auth-header"` = `"auth-header"`
+
+Auth header.
+
+### Logging
+
+> `readonly` **Logging**: `"logging"` = `"logging"`
+
+Logging.
+
+### NodeIdentity
+
+> `readonly` **NodeIdentity**: `"node-identity"` = `"node-identity"`
+
+Node Identity.
+
+### StaticUserIdentity
+
+> `readonly` **StaticUserIdentity**: `"static-user-identity"` = `"static-user-identity"`
+
+Static User Identity.
+
+### SocketRoute
+
+> `readonly` **SocketRoute**: `"socket-route"` = `"socket-route"`
+
+Socket Route.

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -0,0 +1,45 @@
+{
+	"name": "@twin.org/engine-server-types",
+	"version": "0.0.1-next.14",
+	"description": "Server types to use in an engine server.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/engine.git",
+		"directory": "packages/engine-server-types"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-auth-entity-storage-service": "next",
+		"@twin.org/api-models": "next",
+		"@twin.org/api-processors": "next",
+		"@twin.org/api-service": "next",
+		"@twin.org/core": "next",
+		"@twin.org/engine-models": "0.0.1-next.14",
+		"@twin.org/engine-types": "0.0.1-next.14",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}