@twin.org/engine-server-types 0.0.3-next.5 → 0.0.3-next.51
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/README.md +1 -1
- package/dist/es/components/authentication.js +24 -19
- package/dist/es/components/authentication.js.map +1 -1
- package/dist/es/components/authenticationAdmin.js +19 -15
- package/dist/es/components/authenticationAdmin.js.map +1 -1
- package/dist/es/components/authenticationAudit.js +35 -0
- package/dist/es/components/authenticationAudit.js.map +1 -0
- package/dist/es/components/authenticationRate.js +37 -0
- package/dist/es/components/authenticationRate.js.map +1 -0
- package/dist/es/components/hosting.js +29 -0
- package/dist/es/components/hosting.js.map +1 -0
- package/dist/es/components/information.js +12 -9
- package/dist/es/components/information.js.map +1 -1
- package/dist/es/components/mimeTypeProcessor.js +7 -7
- package/dist/es/components/mimeTypeProcessor.js.map +1 -1
- package/dist/es/components/restRouteProcessor.js +44 -47
- package/dist/es/components/restRouteProcessor.js.map +1 -1
- package/dist/es/components/socketRouteProcessor.js +43 -43
- package/dist/es/components/socketRouteProcessor.js.map +1 -1
- package/dist/es/index.js +9 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IEngineServerConfig.js.map +1 -1
- package/dist/es/models/config/authenticationAuditComponentConfig.js +2 -0
- package/dist/es/models/config/authenticationAuditComponentConfig.js.map +1 -0
- package/dist/es/models/config/authenticationRateComponentConfig.js +2 -0
- package/dist/es/models/config/authenticationRateComponentConfig.js.map +1 -0
- package/dist/es/models/config/hostingComponentConfig.js +2 -0
- package/dist/es/models/config/hostingComponentConfig.js.map +1 -0
- package/dist/es/models/config/restRouteProcessorConfig.js.map +1 -1
- package/dist/es/models/config/socketRouteProcessorConfig.js.map +1 -1
- package/dist/es/models/types/authenticationAuditComponentType.js +13 -0
- package/dist/es/models/types/authenticationAuditComponentType.js.map +1 -0
- package/dist/es/models/types/authenticationRateComponentType.js +13 -0
- package/dist/es/models/types/authenticationRateComponentType.js.map +1 -0
- package/dist/es/models/types/hostingComponentType.js +13 -0
- package/dist/es/models/types/hostingComponentType.js.map +1 -0
- package/dist/es/models/types/restRouteProcessorType.js +4 -0
- package/dist/es/models/types/restRouteProcessorType.js.map +1 -1
- package/dist/es/models/types/socketRouteProcessorType.js +4 -0
- package/dist/es/models/types/socketRouteProcessorType.js.map +1 -1
- package/dist/types/components/authentication.d.ts +3 -7
- package/dist/types/components/authenticationAdmin.d.ts +3 -7
- package/dist/types/components/authenticationAudit.d.ts +12 -0
- package/dist/types/components/authenticationRate.d.ts +12 -0
- package/dist/types/components/hosting.d.ts +12 -0
- package/dist/types/components/information.d.ts +3 -7
- package/dist/types/components/mimeTypeProcessor.d.ts +2 -7
- package/dist/types/components/restRouteProcessor.d.ts +2 -7
- package/dist/types/components/socketRouteProcessor.d.ts +2 -7
- package/dist/types/index.d.ts +9 -0
- package/dist/types/models/IEngineServerConfig.d.ts +21 -6
- package/dist/types/models/config/authenticationAuditComponentConfig.d.ts +9 -0
- package/dist/types/models/config/authenticationRateComponentConfig.d.ts +9 -0
- package/dist/types/models/config/hostingComponentConfig.d.ts +9 -0
- package/dist/types/models/config/restRouteProcessorConfig.d.ts +4 -5
- package/dist/types/models/config/socketRouteProcessorConfig.d.ts +4 -5
- package/dist/types/models/types/authenticationAuditComponentType.d.ts +13 -0
- package/dist/types/models/types/authenticationRateComponentType.d.ts +13 -0
- package/dist/types/models/types/hostingComponentType.d.ts +13 -0
- package/dist/types/models/types/restRouteProcessorType.d.ts +4 -0
- package/dist/types/models/types/socketRouteProcessorType.d.ts +4 -0
- package/docs/changelog.md +906 -119
- package/docs/examples.md +64 -1
- package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +2 -2
- package/docs/reference/functions/initialiseAuthenticationAuditComponent.md +31 -0
- package/docs/reference/functions/initialiseAuthenticationComponent.md +2 -2
- package/docs/reference/functions/initialiseAuthenticationRateComponent.md +31 -0
- package/docs/reference/functions/initialiseHostingComponent.md +31 -0
- 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/docs/reference/index.md +12 -0
- package/docs/reference/interfaces/IEngineServerConfig.md +509 -15
- package/docs/reference/type-aliases/AuthenticationAdminComponentConfig.md +3 -3
- package/docs/reference/type-aliases/AuthenticationAuditComponentConfig.md +17 -0
- package/docs/reference/type-aliases/AuthenticationAuditComponentType.md +5 -0
- package/docs/reference/type-aliases/AuthenticationRateComponentConfig.md +17 -0
- package/docs/reference/type-aliases/AuthenticationRateComponentType.md +5 -0
- package/docs/reference/type-aliases/HostingComponentConfig.md +17 -0
- package/docs/reference/type-aliases/HostingComponentType.md +5 -0
- package/docs/reference/type-aliases/MimeTypeProcessorConfig.md +3 -3
- package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
- package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
- package/docs/reference/variables/AuthenticationAdminComponentType.md +1 -1
- package/docs/reference/variables/AuthenticationAuditComponentType.md +13 -0
- package/docs/reference/variables/AuthenticationComponentType.md +2 -2
- package/docs/reference/variables/AuthenticationRateComponentType.md +13 -0
- package/docs/reference/variables/HostingComponentType.md +13 -0
- package/docs/reference/variables/InformationComponentType.md +2 -2
- package/docs/reference/variables/MimeTypeProcessorType.md +1 -1
- package/docs/reference/variables/RestRouteProcessorType.md +13 -7
- package/docs/reference/variables/SocketRouteProcessorType.md +13 -7
- package/package.json +6 -7
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: RestRouteProcessorConfig
|
|
2
2
|
|
|
3
|
-
> **RestRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`
|
|
3
|
+
> **RestRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/RestRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/RestRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/RestRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/RestRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SingleTenant`](../variables/RestRouteProcessorType.md#singletenant); `options?`: `ISingleTenantProcessorConstructorOptions`; \} \| \{ `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: SocketRouteProcessorConfig
|
|
2
2
|
|
|
3
|
-
> **SocketRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/SocketRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`
|
|
3
|
+
> **SocketRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/SocketRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/SocketRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/SocketRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/SocketRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/SocketRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SingleTenant`](../variables/SocketRouteProcessorType.md#singletenant); `options?`: `ISingleTenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SocketRoute`](../variables/SocketRouteProcessorType.md#socketroute); `options?`: `ISocketRouteProcessorConstructorOptions`; \}
|
|
4
4
|
|
|
5
5
|
Socket route processor config types.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Variable: AuthenticationAuditComponentType
|
|
2
|
+
|
|
3
|
+
> `const` **AuthenticationAuditComponentType**: `object`
|
|
4
|
+
|
|
5
|
+
Authentication audit component types.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### EntityStorage {#entitystorage}
|
|
10
|
+
|
|
11
|
+
> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
|
|
12
|
+
|
|
13
|
+
Entity storage.
|
|
@@ -6,13 +6,13 @@ Authentication component types.
|
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
9
|
-
### EntityStorage
|
|
9
|
+
### EntityStorage {#entitystorage}
|
|
10
10
|
|
|
11
11
|
> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
|
|
12
12
|
|
|
13
13
|
Entity storage.
|
|
14
14
|
|
|
15
|
-
### RestClient
|
|
15
|
+
### RestClient {#restclient}
|
|
16
16
|
|
|
17
17
|
> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
|
|
18
18
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Variable: AuthenticationRateComponentType
|
|
2
|
+
|
|
3
|
+
> `const` **AuthenticationRateComponentType**: `object`
|
|
4
|
+
|
|
5
|
+
Authentication rate component types.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### EntityStorage {#entitystorage}
|
|
10
|
+
|
|
11
|
+
> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
|
|
12
|
+
|
|
13
|
+
Entity storage.
|
|
@@ -6,13 +6,13 @@ Information component types.
|
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
9
|
-
### Service
|
|
9
|
+
### Service {#service}
|
|
10
10
|
|
|
11
11
|
> `readonly` **Service**: `"service"` = `"service"`
|
|
12
12
|
|
|
13
13
|
Service.
|
|
14
14
|
|
|
15
|
-
### RestClient
|
|
15
|
+
### RestClient {#restclient}
|
|
16
16
|
|
|
17
17
|
> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
|
|
18
18
|
|
|
@@ -6,43 +6,49 @@ REST route processor types.
|
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
9
|
-
### AuthHeader
|
|
9
|
+
### AuthHeader {#authheader}
|
|
10
10
|
|
|
11
11
|
> `readonly` **AuthHeader**: `"auth-header"` = `"auth-header"`
|
|
12
12
|
|
|
13
13
|
Auth header.
|
|
14
14
|
|
|
15
|
-
### AuthVerifiableCredential
|
|
15
|
+
### AuthVerifiableCredential {#authverifiablecredential}
|
|
16
16
|
|
|
17
17
|
> `readonly` **AuthVerifiableCredential**: `"auth-verifiable-credential"` = `"auth-verifiable-credential"`
|
|
18
18
|
|
|
19
19
|
Auth verifiable credential.
|
|
20
20
|
|
|
21
|
-
### Logging
|
|
21
|
+
### Logging {#logging}
|
|
22
22
|
|
|
23
23
|
> `readonly` **Logging**: `"logging"` = `"logging"`
|
|
24
24
|
|
|
25
25
|
Logging.
|
|
26
26
|
|
|
27
|
-
### ContextId
|
|
27
|
+
### ContextId {#contextid}
|
|
28
28
|
|
|
29
29
|
> `readonly` **ContextId**: `"context-id"` = `"context-id"`
|
|
30
30
|
|
|
31
31
|
Context ID.
|
|
32
32
|
|
|
33
|
-
### StaticContextId
|
|
33
|
+
### StaticContextId {#staticcontextid}
|
|
34
34
|
|
|
35
35
|
> `readonly` **StaticContextId**: `"static-context-id"` = `"static-context-id"`
|
|
36
36
|
|
|
37
37
|
Static Context ID.
|
|
38
38
|
|
|
39
|
-
### Tenant
|
|
39
|
+
### Tenant {#tenant}
|
|
40
40
|
|
|
41
41
|
> `readonly` **Tenant**: `"tenant"` = `"tenant"`
|
|
42
42
|
|
|
43
43
|
Tenant.
|
|
44
44
|
|
|
45
|
-
###
|
|
45
|
+
### SingleTenant {#singletenant}
|
|
46
|
+
|
|
47
|
+
> `readonly` **SingleTenant**: `"single-tenant"` = `"single-tenant"`
|
|
48
|
+
|
|
49
|
+
Single Tenant.
|
|
50
|
+
|
|
51
|
+
### RestRoute {#restroute}
|
|
46
52
|
|
|
47
53
|
> `readonly` **RestRoute**: `"rest-route"` = `"rest-route"`
|
|
48
54
|
|
|
@@ -6,43 +6,49 @@ Socket route processor types.
|
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
9
|
-
### AuthHeader
|
|
9
|
+
### AuthHeader {#authheader}
|
|
10
10
|
|
|
11
11
|
> `readonly` **AuthHeader**: `"auth-header"` = `"auth-header"`
|
|
12
12
|
|
|
13
13
|
Auth header.
|
|
14
14
|
|
|
15
|
-
### AuthVerifiableCredential
|
|
15
|
+
### AuthVerifiableCredential {#authverifiablecredential}
|
|
16
16
|
|
|
17
17
|
> `readonly` **AuthVerifiableCredential**: `"auth-verifiable-credential"` = `"auth-verifiable-credential"`
|
|
18
18
|
|
|
19
19
|
Auth verifiable credential.
|
|
20
20
|
|
|
21
|
-
### Logging
|
|
21
|
+
### Logging {#logging}
|
|
22
22
|
|
|
23
23
|
> `readonly` **Logging**: `"logging"` = `"logging"`
|
|
24
24
|
|
|
25
25
|
Logging.
|
|
26
26
|
|
|
27
|
-
### ContextId
|
|
27
|
+
### ContextId {#contextid}
|
|
28
28
|
|
|
29
29
|
> `readonly` **ContextId**: `"context-id"` = `"context-id"`
|
|
30
30
|
|
|
31
31
|
Context ID.
|
|
32
32
|
|
|
33
|
-
### StaticContextId
|
|
33
|
+
### StaticContextId {#staticcontextid}
|
|
34
34
|
|
|
35
35
|
> `readonly` **StaticContextId**: `"static-context-id"` = `"static-context-id"`
|
|
36
36
|
|
|
37
37
|
Static Context ID.
|
|
38
38
|
|
|
39
|
-
### Tenant
|
|
39
|
+
### Tenant {#tenant}
|
|
40
40
|
|
|
41
41
|
> `readonly` **Tenant**: `"tenant"` = `"tenant"`
|
|
42
42
|
|
|
43
43
|
Tenant.
|
|
44
44
|
|
|
45
|
-
###
|
|
45
|
+
### SingleTenant {#singletenant}
|
|
46
|
+
|
|
47
|
+
> `readonly` **SingleTenant**: `"single-tenant"` = `"single-tenant"`
|
|
48
|
+
|
|
49
|
+
Single Tenant.
|
|
50
|
+
|
|
51
|
+
### SocketRoute {#socketroute}
|
|
46
52
|
|
|
47
53
|
> `readonly` **SocketRoute**: `"socket-route"` = `"socket-route"`
|
|
48
54
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/engine-server-types",
|
|
3
|
-
"version": "0.0.3-next.
|
|
4
|
-
"description": "Server types
|
|
3
|
+
"version": "0.0.3-next.51",
|
|
4
|
+
"description": "Server-focused component types and configuration models for API routing and hosting.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "git+https://github.com/
|
|
7
|
+
"url": "git+https://github.com/iotaledger/twin-engine.git",
|
|
8
8
|
"directory": "packages/engine-server-types"
|
|
9
9
|
},
|
|
10
10
|
"author": "martyn.janes@iota.org",
|
|
@@ -25,10 +25,9 @@
|
|
|
25
25
|
"@twin.org/api-tenant-processor": "next",
|
|
26
26
|
"@twin.org/context": "next",
|
|
27
27
|
"@twin.org/core": "next",
|
|
28
|
-
"@twin.org/engine-models": "0.0.3-next.
|
|
29
|
-
"@twin.org/engine-types": "0.0.3-next.
|
|
28
|
+
"@twin.org/engine-models": "0.0.3-next.51",
|
|
29
|
+
"@twin.org/engine-types": "0.0.3-next.51",
|
|
30
30
|
"@twin.org/entity": "next",
|
|
31
|
-
"@twin.org/identity-authentication": "next",
|
|
32
31
|
"@twin.org/nameof": "next"
|
|
33
32
|
},
|
|
34
33
|
"main": "./dist/es/index.js",
|
|
@@ -56,7 +55,7 @@
|
|
|
56
55
|
"engine"
|
|
57
56
|
],
|
|
58
57
|
"bugs": {
|
|
59
|
-
"url": "git+https://github.com/
|
|
58
|
+
"url": "git+https://github.com/iotaledger/twin-engine/issues"
|
|
60
59
|
},
|
|
61
60
|
"homepage": "https://twindev.org"
|
|
62
61
|
}
|