@twin.org/engine-server-types 0.0.2-next.11 → 0.0.2-next.13
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/dist/cjs/index.cjs +6 -6
- package/dist/esm/index.mjs +6 -6
- package/dist/types/components/authentication.d.ts +1 -1
- package/dist/types/components/authenticationAdmin.d.ts +1 -1
- package/dist/types/components/information.d.ts +1 -1
- package/dist/types/components/mimeTypeProcessor.d.ts +1 -1
- package/dist/types/components/restRouteProcessor.d.ts +1 -1
- package/dist/types/components/socketRouteProcessor.d.ts +1 -1
- package/docs/changelog.md +30 -0
- package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +2 -2
- package/docs/reference/functions/initialiseAuthenticationComponent.md +2 -2
- package/docs/reference/functions/initialiseInformationComponent.md +2 -2
- package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +2 -2
- package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +2 -2
- package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +2 -2
- package/package.json +3 -3
package/dist/cjs/index.cjs
CHANGED
|
@@ -35,7 +35,7 @@ const AuthenticationComponentType = {
|
|
|
35
35
|
* @returns The name of the instance created.
|
|
36
36
|
* @throws GeneralError if the component type is unknown.
|
|
37
37
|
*/
|
|
38
|
-
function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
38
|
+
async function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
39
39
|
engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
|
|
40
40
|
element: `Authentication Component: ${instanceConfig.type}`
|
|
41
41
|
}));
|
|
@@ -93,7 +93,7 @@ const AuthenticationAdminComponentType = {
|
|
|
93
93
|
* @returns The name of the instance created.
|
|
94
94
|
* @throws GeneralError if the component type is unknown.
|
|
95
95
|
*/
|
|
96
|
-
function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
96
|
+
async function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
97
97
|
engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
|
|
98
98
|
element: `Authentication Admin Component: ${instanceConfig.type}`
|
|
99
99
|
}));
|
|
@@ -149,7 +149,7 @@ const InformationComponentType = {
|
|
|
149
149
|
* @returns The name of the instance created.
|
|
150
150
|
* @throws GeneralError if the component type is unknown.
|
|
151
151
|
*/
|
|
152
|
-
function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
152
|
+
async function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
153
153
|
engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
|
|
154
154
|
element: `Information Component: ${instanceConfig.type}`
|
|
155
155
|
}));
|
|
@@ -203,7 +203,7 @@ const MimeTypeProcessorType = {
|
|
|
203
203
|
* @returns The name of the instance created.
|
|
204
204
|
* @throws GeneralError if the component type is unknown.
|
|
205
205
|
*/
|
|
206
|
-
function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
206
|
+
async function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
207
207
|
engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
|
|
208
208
|
element: `Mime Type Processor: ${instanceConfig.type}`
|
|
209
209
|
}));
|
|
@@ -269,7 +269,7 @@ const RestRouteProcessorType = {
|
|
|
269
269
|
* @returns The name of the instance created.
|
|
270
270
|
* @throws GeneralError if the component type is unknown.
|
|
271
271
|
*/
|
|
272
|
-
function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
272
|
+
async function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
273
273
|
engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
|
|
274
274
|
element: `REST Route Processor: ${instanceConfig.type}`
|
|
275
275
|
}));
|
|
@@ -361,7 +361,7 @@ const SocketRouteProcessorType = {
|
|
|
361
361
|
* @returns The name of the instance created.
|
|
362
362
|
* @throws GeneralError if the component type is unknown.
|
|
363
363
|
*/
|
|
364
|
-
function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
364
|
+
async function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
365
365
|
engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
|
|
366
366
|
element: `Socket Route Processor: ${instanceConfig.type}`
|
|
367
367
|
}));
|
package/dist/esm/index.mjs
CHANGED
|
@@ -33,7 +33,7 @@ const AuthenticationComponentType = {
|
|
|
33
33
|
* @returns The name of the instance created.
|
|
34
34
|
* @throws GeneralError if the component type is unknown.
|
|
35
35
|
*/
|
|
36
|
-
function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
36
|
+
async function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
37
37
|
engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
|
|
38
38
|
element: `Authentication Component: ${instanceConfig.type}`
|
|
39
39
|
}));
|
|
@@ -91,7 +91,7 @@ const AuthenticationAdminComponentType = {
|
|
|
91
91
|
* @returns The name of the instance created.
|
|
92
92
|
* @throws GeneralError if the component type is unknown.
|
|
93
93
|
*/
|
|
94
|
-
function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
94
|
+
async function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
95
95
|
engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
|
|
96
96
|
element: `Authentication Admin Component: ${instanceConfig.type}`
|
|
97
97
|
}));
|
|
@@ -147,7 +147,7 @@ const InformationComponentType = {
|
|
|
147
147
|
* @returns The name of the instance created.
|
|
148
148
|
* @throws GeneralError if the component type is unknown.
|
|
149
149
|
*/
|
|
150
|
-
function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
150
|
+
async function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
151
151
|
engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
|
|
152
152
|
element: `Information Component: ${instanceConfig.type}`
|
|
153
153
|
}));
|
|
@@ -201,7 +201,7 @@ const MimeTypeProcessorType = {
|
|
|
201
201
|
* @returns The name of the instance created.
|
|
202
202
|
* @throws GeneralError if the component type is unknown.
|
|
203
203
|
*/
|
|
204
|
-
function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
204
|
+
async function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
205
205
|
engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
|
|
206
206
|
element: `Mime Type Processor: ${instanceConfig.type}`
|
|
207
207
|
}));
|
|
@@ -267,7 +267,7 @@ const RestRouteProcessorType = {
|
|
|
267
267
|
* @returns The name of the instance created.
|
|
268
268
|
* @throws GeneralError if the component type is unknown.
|
|
269
269
|
*/
|
|
270
|
-
function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
270
|
+
async function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
271
271
|
engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
|
|
272
272
|
element: `REST Route Processor: ${instanceConfig.type}`
|
|
273
273
|
}));
|
|
@@ -359,7 +359,7 @@ const SocketRouteProcessorType = {
|
|
|
359
359
|
* @returns The name of the instance created.
|
|
360
360
|
* @throws GeneralError if the component type is unknown.
|
|
361
361
|
*/
|
|
362
|
-
function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
362
|
+
async function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
|
|
363
363
|
engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
|
|
364
364
|
element: `Socket Route Processor: ${instanceConfig.type}`
|
|
365
365
|
}));
|
|
@@ -10,4 +10,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
|
|
|
10
10
|
* @returns The name of the instance created.
|
|
11
11
|
* @throws GeneralError if the component type is unknown.
|
|
12
12
|
*/
|
|
13
|
-
export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig, overrideInstanceType?: string): string | undefined
|
|
13
|
+
export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig, overrideInstanceType?: string): Promise<string | undefined>;
|
|
@@ -10,4 +10,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
|
|
|
10
10
|
* @returns The name of the instance created.
|
|
11
11
|
* @throws GeneralError if the component type is unknown.
|
|
12
12
|
*/
|
|
13
|
-
export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig, overrideInstanceType?: string): string | undefined
|
|
13
|
+
export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig, overrideInstanceType?: string): Promise<string | undefined>;
|
|
@@ -10,4 +10,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
|
|
|
10
10
|
* @returns The name of the instance created.
|
|
11
11
|
* @throws GeneralError if the component type is unknown.
|
|
12
12
|
*/
|
|
13
|
-
export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig, overrideInstanceType?: string): string | undefined
|
|
13
|
+
export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig, overrideInstanceType?: string): Promise<string | undefined>;
|
|
@@ -10,4 +10,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
|
|
|
10
10
|
* @returns The name of the instance created.
|
|
11
11
|
* @throws GeneralError if the component type is unknown.
|
|
12
12
|
*/
|
|
13
|
-
export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig, overrideInstanceType?: string): string | undefined
|
|
13
|
+
export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig, overrideInstanceType?: string): Promise<string | undefined>;
|
|
@@ -10,4 +10,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
|
|
|
10
10
|
* @returns The name of the instance created.
|
|
11
11
|
* @throws GeneralError if the component type is unknown.
|
|
12
12
|
*/
|
|
13
|
-
export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig, overrideInstanceType?: string): string | undefined
|
|
13
|
+
export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig, overrideInstanceType?: string): Promise<string | undefined>;
|
|
@@ -10,4 +10,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
|
|
|
10
10
|
* @returns The name of the instance created.
|
|
11
11
|
* @throws GeneralError if the component type is unknown.
|
|
12
12
|
*/
|
|
13
|
-
export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig, overrideInstanceType?: string): string | undefined
|
|
13
|
+
export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig, overrideInstanceType?: string): Promise<string | undefined>;
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @twin.org/engine-server-types - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.13](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.12...engine-server-types-v0.0.2-next.13) (2025-09-08)
|
|
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.2-next.12 to 0.0.2-next.13
|
|
16
|
+
* @twin.org/engine-types bumped from 0.0.2-next.12 to 0.0.2-next.13
|
|
17
|
+
|
|
18
|
+
## [0.0.2-next.12](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.11...engine-server-types-v0.0.2-next.12) (2025-09-05)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
|
|
23
|
+
* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/engine-models bumped from 0.0.2-next.11 to 0.0.2-next.12
|
|
31
|
+
* @twin.org/engine-types bumped from 0.0.2-next.11 to 0.0.2-next.12
|
|
32
|
+
|
|
3
33
|
## [0.0.2-next.11](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.10...engine-server-types-v0.0.2-next.11) (2025-08-29)
|
|
4
34
|
|
|
5
35
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseAuthenticationAdminComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string
|
|
3
|
+
> **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
|
|
4
4
|
|
|
5
5
|
Initialise the authentication admin.
|
|
6
6
|
|
|
@@ -32,7 +32,7 @@ The instance type to override the default.
|
|
|
32
32
|
|
|
33
33
|
## Returns
|
|
34
34
|
|
|
35
|
-
`undefined` \| `string
|
|
35
|
+
`Promise`\<`undefined` \| `string`\>
|
|
36
36
|
|
|
37
37
|
The name of the instance created.
|
|
38
38
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseAuthenticationComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string
|
|
3
|
+
> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
|
|
4
4
|
|
|
5
5
|
Initialise the authentication.
|
|
6
6
|
|
|
@@ -32,7 +32,7 @@ The instance type to override the default.
|
|
|
32
32
|
|
|
33
33
|
## Returns
|
|
34
34
|
|
|
35
|
-
`undefined` \| `string
|
|
35
|
+
`Promise`\<`undefined` \| `string`\>
|
|
36
36
|
|
|
37
37
|
The name of the instance created.
|
|
38
38
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseInformationComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string
|
|
3
|
+
> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
|
|
4
4
|
|
|
5
5
|
Initialise the information component.
|
|
6
6
|
|
|
@@ -32,7 +32,7 @@ The instance type to override the default.
|
|
|
32
32
|
|
|
33
33
|
## Returns
|
|
34
34
|
|
|
35
|
-
`undefined` \| `string
|
|
35
|
+
`Promise`\<`undefined` \| `string`\>
|
|
36
36
|
|
|
37
37
|
The name of the instance created.
|
|
38
38
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseMimeTypeProcessorComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string
|
|
3
|
+
> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
|
|
4
4
|
|
|
5
5
|
Initialise the mime type processor.
|
|
6
6
|
|
|
@@ -32,7 +32,7 @@ The instance type to override the default.
|
|
|
32
32
|
|
|
33
33
|
## Returns
|
|
34
34
|
|
|
35
|
-
`undefined` \| `string
|
|
35
|
+
`Promise`\<`undefined` \| `string`\>
|
|
36
36
|
|
|
37
37
|
The name of the instance created.
|
|
38
38
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseRestRouteProcessorComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string
|
|
3
|
+
> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
|
|
4
4
|
|
|
5
5
|
Initialise the rest route processor.
|
|
6
6
|
|
|
@@ -32,7 +32,7 @@ The instance type to override the default.
|
|
|
32
32
|
|
|
33
33
|
## Returns
|
|
34
34
|
|
|
35
|
-
`undefined` \| `string
|
|
35
|
+
`Promise`\<`undefined` \| `string`\>
|
|
36
36
|
|
|
37
37
|
The name of the instance created.
|
|
38
38
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: initialiseSocketRouteProcessorComponent()
|
|
2
2
|
|
|
3
|
-
> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string
|
|
3
|
+
> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
|
|
4
4
|
|
|
5
5
|
Initialise the socket route processor.
|
|
6
6
|
|
|
@@ -32,7 +32,7 @@ The instance type to override the default.
|
|
|
32
32
|
|
|
33
33
|
## Returns
|
|
34
34
|
|
|
35
|
-
`undefined` \| `string
|
|
35
|
+
`Promise`\<`undefined` \| `string`\>
|
|
36
36
|
|
|
37
37
|
The name of the instance created.
|
|
38
38
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/engine-server-types",
|
|
3
|
-
"version": "0.0.2-next.
|
|
3
|
+
"version": "0.0.2-next.13",
|
|
4
4
|
"description": "Server types to use in an engine server.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -23,8 +23,8 @@
|
|
|
23
23
|
"@twin.org/api-server-fastify": "next",
|
|
24
24
|
"@twin.org/api-service": "next",
|
|
25
25
|
"@twin.org/core": "next",
|
|
26
|
-
"@twin.org/engine-models": "0.0.2-next.
|
|
27
|
-
"@twin.org/engine-types": "0.0.2-next.
|
|
26
|
+
"@twin.org/engine-models": "0.0.2-next.13",
|
|
27
|
+
"@twin.org/engine-types": "0.0.2-next.13",
|
|
28
28
|
"@twin.org/entity": "next",
|
|
29
29
|
"@twin.org/nameof": "next"
|
|
30
30
|
},
|