@twin.org/engine-server-types 0.0.1-next.67 → 0.0.1-next.69
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.
- package/docs/changelog.md +30 -0
- package/docs/reference/functions/initialiseAuthenticationComponent.md +1 -1
- package/docs/reference/functions/initialiseInformationComponent.md +1 -1
- package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +1 -1
- package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +1 -1
- package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +1 -1
- package/docs/reference/type-aliases/AuthenticationComponentConfig.md +4 -2
- package/docs/reference/type-aliases/AuthenticationComponentType.md +1 -1
- package/docs/reference/type-aliases/InformationComponentConfig.md +4 -2
- package/docs/reference/type-aliases/InformationComponentType.md +1 -1
- package/docs/reference/type-aliases/MimeTypeProcessorConfig.md +4 -2
- package/docs/reference/type-aliases/MimeTypeProcessorType.md +1 -1
- package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
- package/docs/reference/type-aliases/RestRouteProcessorType.md +1 -1
- package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
- package/docs/reference/type-aliases/SocketRouteProcessorType.md +1 -1
- package/package.json +3 -3
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @twin.org/engine-server-types - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.1-next.69](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.1-next.68...engine-server-types-v0.0.1-next.69) (2025-04-25)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **engine-server-types:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/engine-models bumped from 0.0.1-next.68 to 0.0.1-next.69
|
|
16
|
+
* @twin.org/engine-types bumped from 0.0.1-next.68 to 0.0.1-next.69
|
|
17
|
+
|
|
18
|
+
## [0.0.1-next.68](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.1-next.67...engine-server-types-v0.0.1-next.68) (2025-04-17)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
|
|
23
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/engine-models bumped from 0.0.1-next.67 to 0.0.1-next.68
|
|
31
|
+
* @twin.org/engine-types bumped from 0.0.1-next.67 to 0.0.1-next.68
|
|
32
|
+
|
|
3
33
|
## [0.0.1-next.67](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.1-next.66...engine-server-types-v0.0.1-next.67) (2025-03-28)
|
|
4
34
|
|
|
5
35
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseAuthenticationComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType
|
|
3
|
+
> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
4
|
|
|
5
5
|
Initialise the authentication.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseInformationComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType
|
|
3
|
+
> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
4
|
|
|
5
5
|
Initialise the information component.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseMimeTypeProcessorComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType
|
|
3
|
+
> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
4
|
|
|
5
5
|
Initialise the mime type processor.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseRestRouteProcessorComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType
|
|
3
|
+
> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
4
|
|
|
5
5
|
Initialise the rest route processor.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseSocketRouteProcessorComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType
|
|
3
|
+
> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
4
|
|
|
5
5
|
Initialise the socket route processor.
|
|
6
6
|
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
# Type Alias: AuthenticationComponentConfig
|
|
2
2
|
|
|
3
|
-
> **AuthenticationComponentConfig
|
|
3
|
+
> **AuthenticationComponentConfig** = `object`
|
|
4
4
|
|
|
5
5
|
Authentication component config types.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Properties
|
|
8
8
|
|
|
9
9
|
### type
|
|
10
10
|
|
|
11
11
|
> **type**: *typeof* [`EntityStorage`](../variables/AuthenticationComponentType.md#entitystorage)
|
|
12
12
|
|
|
13
|
+
***
|
|
14
|
+
|
|
13
15
|
### options?
|
|
14
16
|
|
|
15
17
|
> `optional` **options**: `IEntityStorageAuthenticationServiceConstructorOptions`
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: AuthenticationComponentType
|
|
2
2
|
|
|
3
|
-
> **AuthenticationComponentType
|
|
3
|
+
> **AuthenticationComponentType** = *typeof* [`AuthenticationComponentType`](../variables/AuthenticationComponentType.md)\[keyof *typeof* [`AuthenticationComponentType`](../variables/AuthenticationComponentType.md)\]
|
|
4
4
|
|
|
5
5
|
Authentication component types.
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
# Type Alias: InformationComponentConfig
|
|
2
2
|
|
|
3
|
-
> **InformationComponentConfig
|
|
3
|
+
> **InformationComponentConfig** = `object`
|
|
4
4
|
|
|
5
5
|
Information component config types.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Properties
|
|
8
8
|
|
|
9
9
|
### type
|
|
10
10
|
|
|
11
11
|
> **type**: *typeof* [`Service`](../variables/InformationComponentType.md#service)
|
|
12
12
|
|
|
13
|
+
***
|
|
14
|
+
|
|
13
15
|
### options
|
|
14
16
|
|
|
15
17
|
> **options**: `IInformationServiceConstructorOptions`
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: InformationComponentType
|
|
2
2
|
|
|
3
|
-
> **InformationComponentType
|
|
3
|
+
> **InformationComponentType** = *typeof* [`InformationComponentType`](../variables/InformationComponentType.md)\[keyof *typeof* [`InformationComponentType`](../variables/InformationComponentType.md)\]
|
|
4
4
|
|
|
5
5
|
Information component types.
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
# Type Alias: MimeTypeProcessorConfig
|
|
2
2
|
|
|
3
|
-
> **MimeTypeProcessorConfig
|
|
3
|
+
> **MimeTypeProcessorConfig** = `object`
|
|
4
4
|
|
|
5
5
|
Mime type processor config types.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Properties
|
|
8
8
|
|
|
9
9
|
### type
|
|
10
10
|
|
|
11
11
|
> **type**: *typeof* [`Jwt`](../variables/MimeTypeProcessorType.md#jwt)
|
|
12
12
|
|
|
13
|
+
***
|
|
14
|
+
|
|
13
15
|
### options?
|
|
14
16
|
|
|
15
17
|
> `optional` **options**: `never`
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: MimeTypeProcessorType
|
|
2
2
|
|
|
3
|
-
> **MimeTypeProcessorType
|
|
3
|
+
> **MimeTypeProcessorType** = *typeof* [`MimeTypeProcessorType`](../variables/MimeTypeProcessorType.md)\[keyof *typeof* [`MimeTypeProcessorType`](../variables/MimeTypeProcessorType.md)\]
|
|
4
4
|
|
|
5
5
|
Mime type processor types.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: RestRouteProcessorConfig
|
|
2
2
|
|
|
3
|
-
> **RestRouteProcessorConfig
|
|
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.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: RestRouteProcessorType
|
|
2
2
|
|
|
3
|
-
> **RestRouteProcessorType
|
|
3
|
+
> **RestRouteProcessorType** = *typeof* [`RestRouteProcessorType`](../variables/RestRouteProcessorType.md)\[keyof *typeof* [`RestRouteProcessorType`](../variables/RestRouteProcessorType.md)\]
|
|
4
4
|
|
|
5
5
|
REST route processor types.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: SocketRouteProcessorConfig
|
|
2
2
|
|
|
3
|
-
> **SocketRouteProcessorConfig
|
|
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.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: SocketRouteProcessorType
|
|
2
2
|
|
|
3
|
-
> **SocketRouteProcessorType
|
|
3
|
+
> **SocketRouteProcessorType** = *typeof* [`SocketRouteProcessorType`](../variables/SocketRouteProcessorType.md)\[keyof *typeof* [`SocketRouteProcessorType`](../variables/SocketRouteProcessorType.md)\]
|
|
4
4
|
|
|
5
5
|
Socket route processor 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.
|
|
3
|
+
"version": "0.0.1-next.69",
|
|
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.
|
|
19
|
-
"@twin.org/engine-types": "0.0.1-next.
|
|
18
|
+
"@twin.org/engine-models": "0.0.1-next.69",
|
|
19
|
+
"@twin.org/engine-types": "0.0.1-next.69",
|
|
20
20
|
"@twin.org/entity": "next",
|
|
21
21
|
"@twin.org/nameof": "next"
|
|
22
22
|
},
|