@twin.org/engine-server-types 0.0.3-next.9 → 0.9.0

package/docs/examples.md

@@ -1 +1,64 @@
-# @twin.org/engine-server-types - Examples
+# Engine Server Types Examples
+
+These examples demonstrate how to compose server configuration with shared type constants for REST and socket processing.
+
+## Component and Processor Types
+
+```typescript
+import {
+  AuthenticationComponentType,
+  HostingComponentType,
+  InformationComponentType,
+  RestRouteProcessorType,
+  SocketRouteProcessorType
+} from '@twin.org/engine-server-types';
+
+const selectedTypes = {
+  authentication: AuthenticationComponentType.Service,
+  hosting: HostingComponentType.Service,
+  information: InformationComponentType.Service,
+  restProcessor: RestRouteProcessorType.RestRoute,
+  socketProcessor: SocketRouteProcessorType.SocketRoute
+};
+
+console.log(selectedTypes.authentication); // "service"
+console.log(selectedTypes.restProcessor); // "rest-route"
+```
+
+## IEngineServerConfig
+
+```typescript
+import type { IEngineServerConfig } from '@twin.org/engine-server-types';
+import {
+  AuthenticationComponentType,
+  HostingComponentType,
+  InformationComponentType,
+  RestRouteProcessorType,
+  SocketRouteProcessorType
+} from '@twin.org/engine-server-types';
+
+const serverConfig: IEngineServerConfig = {
+  debug: true,
+  silent: false,
+  web: {
+    port: 3001,
+    host: '0.0.0.0'
+  },
+  types: {
+    hostingComponent: [{ type: HostingComponentType.Service }],
+    informationComponent: [{ type: InformationComponentType.Service, restPath: '/info' }],
+    authenticationComponent: [{ type: AuthenticationComponentType.Service }],
+    restRouteProcessor: [
+      { type: RestRouteProcessorType.Logging },
+      { type: RestRouteProcessorType.RestRoute }
+    ],
+    socketRouteProcessor: [
+      { type: SocketRouteProcessorType.Logging },
+      { type: SocketRouteProcessorType.SocketRoute }
+    ]
+  }
+};
+
+console.log(serverConfig.web?.port); // 3001
+console.log(serverConfig.types.restRouteProcessor?.length ?? 0); // 2
+```

package/docs/reference/functions/initialiseAuthenticationAdminComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseAuthenticationAdminComponent()
 
-> **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the authentication admin.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseAuthenticationAuditComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseAuthenticationAuditComponent()
+
+> **initialiseAuthenticationAuditComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationAuditComponentConfig`](../type-aliases/AuthenticationAuditComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise the authentication audit.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`AuthenticationAuditComponentConfig`](../type-aliases/AuthenticationAuditComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`AuthenticationAuditComponentConfig`](../type-aliases/AuthenticationAuditComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseAuthenticationComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseAuthenticationComponent()
 
-> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the authentication.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseAuthenticationRateComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseAuthenticationRateComponent()
+
+> **initialiseAuthenticationRateComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationRateComponentConfig`](../type-aliases/AuthenticationRateComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise the authentication rate.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`AuthenticationRateComponentConfig`](../type-aliases/AuthenticationRateComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`AuthenticationRateComponentConfig`](../type-aliases/AuthenticationRateComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseInformationComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseInformationComponent()
 
-> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the information component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseMimeTypeProcessorComponent()
 
-> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
+> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md), `Factory`\<`IMimeTypeProcessor`\>\>
 
 Initialise the mime type processor.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md), `Factory`\<`IMimeTypeProcessor`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseRestRouteProcessorComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseRestRouteProcessorComponent()
 
-> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
+> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md), `Factory`\<`IRestRouteProcessor`\>\>
 
 Initialise the rest route processor.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md), `Factory`\<`IRestRouteProcessor`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseSocketRouteProcessorComponent()
 
-> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
+> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md), `Factory`\<`ISocketRouteProcessor`\>\>
 
 Initialise the socket route processor.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md), `Factory`\<`ISocketRouteProcessor`\>\>
 
 The instance created and the factory for it.

package/docs/reference/index.md

@@ -7,13 +7,17 @@
 ## Type Aliases
 
 - [AuthenticationAdminComponentConfig](type-aliases/AuthenticationAdminComponentConfig.md)
+- [AuthenticationAuditComponentConfig](type-aliases/AuthenticationAuditComponentConfig.md)
 - [AuthenticationComponentConfig](type-aliases/AuthenticationComponentConfig.md)
+- [AuthenticationRateComponentConfig](type-aliases/AuthenticationRateComponentConfig.md)
 - [InformationComponentConfig](type-aliases/InformationComponentConfig.md)
 - [MimeTypeProcessorConfig](type-aliases/MimeTypeProcessorConfig.md)
 - [RestRouteProcessorConfig](type-aliases/RestRouteProcessorConfig.md)
 - [SocketRouteProcessorConfig](type-aliases/SocketRouteProcessorConfig.md)
 - [AuthenticationAdminComponentType](type-aliases/AuthenticationAdminComponentType.md)
+- [AuthenticationAuditComponentType](type-aliases/AuthenticationAuditComponentType.md)
 - [AuthenticationComponentType](type-aliases/AuthenticationComponentType.md)
+- [AuthenticationRateComponentType](type-aliases/AuthenticationRateComponentType.md)
 - [InformationComponentType](type-aliases/InformationComponentType.md)
 - [MimeTypeProcessorType](type-aliases/MimeTypeProcessorType.md)
 - [RestRouteProcessorType](type-aliases/RestRouteProcessorType.md)
@@ -22,7 +26,9 @@
 ## Variables
 
 - [AuthenticationAdminComponentType](variables/AuthenticationAdminComponentType.md)
+- [AuthenticationAuditComponentType](variables/AuthenticationAuditComponentType.md)
 - [AuthenticationComponentType](variables/AuthenticationComponentType.md)
+- [AuthenticationRateComponentType](variables/AuthenticationRateComponentType.md)
 - [InformationComponentType](variables/InformationComponentType.md)
 - [MimeTypeProcessorType](variables/MimeTypeProcessorType.md)
 - [RestRouteProcessorType](variables/RestRouteProcessorType.md)
@@ -32,6 +38,8 @@
 
 - [initialiseAuthenticationComponent](functions/initialiseAuthenticationComponent.md)
 - [initialiseAuthenticationAdminComponent](functions/initialiseAuthenticationAdminComponent.md)
+- [initialiseAuthenticationAuditComponent](functions/initialiseAuthenticationAuditComponent.md)
+- [initialiseAuthenticationRateComponent](functions/initialiseAuthenticationRateComponent.md)
 - [initialiseInformationComponent](functions/initialiseInformationComponent.md)
 - [initialiseMimeTypeProcessorComponent](functions/initialiseMimeTypeProcessorComponent.md)
 - [initialiseRestRouteProcessorComponent](functions/initialiseRestRouteProcessorComponent.md)