@twin.org/engine-server-types 0.0.1-next.30 → 0.0.1-next.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/types/models/config/authenticationComponentConfig.d.ts +2 -6
  2. package/dist/types/models/config/informationComponentConfig.d.ts +2 -4
  3. package/dist/types/models/config/restRouteProcessorConfig.d.ts +6 -16
  4. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +6 -16
  5. package/docs/reference/functions/initialiseAuthenticationComponent.md +12 -4
  6. package/docs/reference/functions/initialiseInformationComponent.md +12 -4
  7. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +12 -4
  8. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +12 -4
  9. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +12 -4
  10. package/docs/reference/type-aliases/AuthenticationComponentConfig.md +2 -14
  11. package/docs/reference/type-aliases/InformationComponentConfig.md +2 -6
  12. package/docs/reference/type-aliases/MimeTypeProcessorConfig.md +1 -1
  13. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  14. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  15. package/package.json +3 -3
package/dist/types/models/config/authenticationComponentConfig.d.ts CHANGED
@@ -1,13 +1,9 @@
1
- import type { IEntityStorageAuthenticationServiceConfig } from "@twin.org/api-auth-entity-storage-service";
1
+ import type { IEntityStorageAuthenticationServiceConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
2
2
  import type { AuthenticationComponentType } from "../types/authenticationComponentType";
3
3
  /**
4
4
  * Authentication component config types.
5
5
  */
6
6
  export type AuthenticationComponentConfig = {
7
7
  type: typeof AuthenticationComponentType.EntityStorage;
8
- options?: {
9
- userEntityStorageType?: string;
10
- vaultConnectorType?: string;
11
- config?: IEntityStorageAuthenticationServiceConfig;
12
- };
8
+ options?: IEntityStorageAuthenticationServiceConstructorOptions;
13
9
  };
package/dist/types/models/config/informationComponentConfig.d.ts CHANGED
@@ -1,11 +1,9 @@
1
- import type { IInformationServiceConfig } from "@twin.org/api-service";
1
+ import type { IInformationServiceConstructorOptions } from "@twin.org/api-service";
2
2
  import type { InformationComponentType } from "../types/informationComponentType";
3
3
  /**
4
4
  * Information component config types.
5
5
  */
6
6
  export type InformationComponentConfig = {
7
7
  type: typeof InformationComponentType.Service;
8
- options: {
9
- config: IInformationServiceConfig;
10
- };
8
+ options: IInformationServiceConstructorOptions;
11
9
  };
package/dist/types/models/config/restRouteProcessorConfig.d.ts CHANGED
@@ -1,32 +1,22 @@
1
- import type { IAuthHeaderProcessorConfig } from "@twin.org/api-auth-entity-storage-service";
2
- import type { ILoggingProcessorConfig, IRouteProcessorConfig, IStaticUserIdentityProcessorConfig } from "@twin.org/api-processors";
1
+ import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
2
+ import type { ILoggingProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticUserIdentityProcessorConstructorOptions } from "@twin.org/api-processors";
3
3
  import type { RestRouteProcessorType } from "../types/restRouteProcessorType";
4
4
  /**
5
5
  * REST route processor config types.
6
6
  */
7
7
  export type RestRouteProcessorConfig = {
8
8
  type: typeof RestRouteProcessorType.AuthHeader;
9
- options?: {
10
- vaultConnectorType?: string;
11
- config?: IAuthHeaderProcessorConfig;
12
- };
9
+ options?: IAuthHeaderProcessorConstructorOptions;
13
10
  } | {
14
11
  type: typeof RestRouteProcessorType.Logging;
15
- options?: {
16
- loggingConnectorType?: string;
17
- config?: ILoggingProcessorConfig;
18
- };
12
+ options?: ILoggingProcessorConstructorOptions;
19
13
  } | {
20
14
  type: typeof RestRouteProcessorType.NodeIdentity;
21
15
  options?: never;
22
16
  } | {
23
17
  type: typeof RestRouteProcessorType.StaticUserIdentity;
24
- options: {
25
- config: IStaticUserIdentityProcessorConfig;
26
- };
18
+ options: IStaticUserIdentityProcessorConstructorOptions;
27
19
  } | {
28
20
  type: typeof RestRouteProcessorType.RestRoute;
29
- options?: {
30
- config?: IRouteProcessorConfig;
31
- };
21
+ options?: IRestRouteProcessorConstructorOptions;
32
22
  };
package/dist/types/models/config/socketRouteProcessorConfig.d.ts CHANGED
@@ -1,32 +1,22 @@
1
- import type { IAuthHeaderProcessorConfig } from "@twin.org/api-auth-entity-storage-service";
2
- import type { ILoggingProcessorConfig, IRouteProcessorConfig, IStaticUserIdentityProcessorConfig } from "@twin.org/api-processors";
1
+ import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
2
+ import type { ILoggingProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticUserIdentityProcessorConstructorOptions } from "@twin.org/api-processors";
3
3
  import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType";
4
4
  /**
5
5
  * Socket route processor config types.
6
6
  */
7
7
  export type SocketRouteProcessorConfig = {
8
8
  type: typeof SocketRouteProcessorType.AuthHeader;
9
- options?: {
10
- vaultConnectorType?: string;
11
- config?: IAuthHeaderProcessorConfig;
12
- };
9
+ options?: IAuthHeaderProcessorConstructorOptions;
13
10
  } | {
14
11
  type: typeof SocketRouteProcessorType.Logging;
15
- options?: {
16
- loggingConnectorType?: string;
17
- config?: ILoggingProcessorConfig;
18
- };
12
+ options?: ILoggingProcessorConstructorOptions;
19
13
  } | {
20
14
  type: typeof SocketRouteProcessorType.NodeIdentity;
21
15
  options?: never;
22
16
  } | {
23
17
  type: typeof SocketRouteProcessorType.StaticUserIdentity;
24
- options: {
25
- config: IStaticUserIdentityProcessorConfig;
26
- };
18
+ options: IStaticUserIdentityProcessorConstructorOptions;
27
19
  } | {
28
20
  type: typeof SocketRouteProcessorType.SocketRoute;
29
- options?: {
30
- config?: IRouteProcessorConfig;
31
- };
21
+ options?: ISocketRouteProcessorConstructorOptions;
32
22
  };
package/docs/reference/functions/initialiseAuthenticationComponent.md CHANGED
@@ -6,19 +6,27 @@ Initialise the authentication.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
10
12
 
11
13
  The engine core.
12
14
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
14
18
 
15
19
  The context for the engine.
16
20
 
17
- • **instanceConfig**: [`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)
21
+ ### instanceConfig
22
+
23
+ [`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)
18
24
 
19
25
  The instance config.
20
26
 
21
- • **overrideInstanceType?**: `string`
27
+ ### overrideInstanceType?
28
+
29
+ `string`
22
30
 
23
31
  The instance type to override the default.
24
32
 
package/docs/reference/functions/initialiseInformationComponent.md CHANGED
@@ -6,19 +6,27 @@ Initialise the information component.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
10
12
 
11
13
  The engine core.
12
14
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
14
18
 
15
19
  The context for the engine.
16
20
 
17
- • **instanceConfig**: [`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)
21
+ ### instanceConfig
22
+
23
+ [`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)
18
24
 
19
25
  The instance config.
20
26
 
21
- • **overrideInstanceType?**: `string`
27
+ ### overrideInstanceType?
28
+
29
+ `string`
22
30
 
23
31
  The instance type to override the default.
24
32
 
package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md CHANGED
@@ -6,19 +6,27 @@ Initialise the mime type processor.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
10
12
 
11
13
  The engine core.
12
14
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
14
18
 
15
19
  The context for the engine.
16
20
 
17
- • **instanceConfig**: [`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)
21
+ ### instanceConfig
22
+
23
+ [`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)
18
24
 
19
25
  The instance config.
20
26
 
21
- • **overrideInstanceType?**: `string`
27
+ ### overrideInstanceType?
28
+
29
+ `string`
22
30
 
23
31
  The instance type to override the default.
24
32
 
package/docs/reference/functions/initialiseRestRouteProcessorComponent.md CHANGED
@@ -6,19 +6,27 @@ Initialise the rest route processor.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
10
12
 
11
13
  The engine core.
12
14
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
14
18
 
15
19
  The context for the engine.
16
20
 
17
- • **instanceConfig**: [`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)
21
+ ### instanceConfig
22
+
23
+ [`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)
18
24
 
19
25
  The instance config.
20
26
 
21
- • **overrideInstanceType?**: `string`
27
+ ### overrideInstanceType?
28
+
29
+ `string`
22
30
 
23
31
  The instance type to override the default.
24
32
 
package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md CHANGED
@@ -6,19 +6,27 @@ Initialise the socket route processor.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
10
12
 
11
13
  The engine core.
12
14
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
14
18
 
15
19
  The context for the engine.
16
20
 
17
- • **instanceConfig**: [`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)
21
+ ### instanceConfig
22
+
23
+ [`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)
18
24
 
19
25
  The instance config.
20
26
 
21
- • **overrideInstanceType?**: `string`
27
+ ### overrideInstanceType?
28
+
29
+ `string`
22
30
 
23
31
  The instance type to override the default.
24
32
 
package/docs/reference/type-aliases/AuthenticationComponentConfig.md CHANGED
@@ -8,20 +8,8 @@ Authentication component config types.
8
8
 
9
9
  ### type
10
10
 
11
- > **type**: *typeof* `AuthenticationComponentType.EntityStorage`
11
+ > **type**: *typeof* [`EntityStorage`](../variables/AuthenticationComponentType.md#entitystorage)
12
12
 
13
13
  ### options?
14
14
 
15
- > `optional` **options**: `object`
16
-
17
- ### options.userEntityStorageType?
18
-
19
- > `optional` **userEntityStorageType**: `string`
20
-
21
- ### options.vaultConnectorType?
22
-
23
- > `optional` **vaultConnectorType**: `string`
24
-
25
- ### options.config?
26
-
27
- > `optional` **config**: `IEntityStorageAuthenticationServiceConfig`
15
+ > `optional` **options**: `IEntityStorageAuthenticationServiceConstructorOptions`
package/docs/reference/type-aliases/InformationComponentConfig.md CHANGED
@@ -8,12 +8,8 @@ Information component config types.
8
8
 
9
9
  ### type
10
10
 
11
- > **type**: *typeof* `InformationComponentType.Service`
11
+ > **type**: *typeof* [`Service`](../variables/InformationComponentType.md#service)
12
12
 
13
13
  ### options
14
14
 
15
- > **options**: `object`
16
-
17
- ### options.config
18
-
19
- > **config**: `IInformationServiceConfig`
15
+ > **options**: `IInformationServiceConstructorOptions`
package/docs/reference/type-aliases/MimeTypeProcessorConfig.md CHANGED
@@ -8,7 +8,7 @@ Mime type processor config types.
8
8
 
9
9
  ### type
10
10
 
11
- > **type**: *typeof* `MimeTypeProcessorType.Jwt`
11
+ > **type**: *typeof* [`Jwt`](../variables/MimeTypeProcessorType.md#jwt)
12
12
 
13
13
  ### options?
14
14
 
package/docs/reference/type-aliases/RestRouteProcessorConfig.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Type Alias: RestRouteProcessorConfig
2
2
 
3
- > **RestRouteProcessorConfig**: `object` \| `object` \| `object` \| `object` \| `object`
3
+ > **RestRouteProcessorConfig**: \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/RestRouteProcessorType.md#logging); `options`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`NodeIdentity`](../variables/RestRouteProcessorType.md#nodeidentity); `options`: `never`; \} \| \{ `type`: *typeof* [`StaticUserIdentity`](../variables/RestRouteProcessorType.md#staticuseridentity); `options`: `IStaticUserIdentityProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`RestRoute`](../variables/RestRouteProcessorType.md#restroute); `options`: `IRestRouteProcessorConstructorOptions`; \}
4
4
 
5
5
  REST route processor config types.
package/docs/reference/type-aliases/SocketRouteProcessorConfig.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Type Alias: SocketRouteProcessorConfig
2
2
 
3
- > **SocketRouteProcessorConfig**: `object` \| `object` \| `object` \| `object` \| `object`
3
+ > **SocketRouteProcessorConfig**: \{ `type`: *typeof* [`AuthHeader`](../variables/SocketRouteProcessorType.md#authheader); `options`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/SocketRouteProcessorType.md#logging); `options`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`NodeIdentity`](../variables/SocketRouteProcessorType.md#nodeidentity); `options`: `never`; \} \| \{ `type`: *typeof* [`StaticUserIdentity`](../variables/SocketRouteProcessorType.md#staticuseridentity); `options`: `IStaticUserIdentityProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SocketRoute`](../variables/SocketRouteProcessorType.md#socketroute); `options`: `ISocketRouteProcessorConstructorOptions`; \}
4
4
 
5
5
  Socket route processor config types.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-server-types",
3
- "version": "0.0.1-next.30",
3
+ "version": "0.0.1-next.32",
4
4
  "description": "Server types to use in an engine server.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,8 +15,8 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/core": "next",
18
- "@twin.org/engine-models": "0.0.1-next.30",
19
- "@twin.org/engine-types": "0.0.1-next.30",
18
+ "@twin.org/engine-models": "0.0.1-next.32",
19
+ "@twin.org/engine-types": "0.0.1-next.32",
20
20
  "@twin.org/entity": "next",
21
21
  "@twin.org/nameof": "next"
22
22
  },