@twin.org/engine-server-types 0.0.3-next.3 → 0.0.3-next.30

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 (88) hide show
  1. package/README.md +1 -1
  2. package/dist/es/components/authentication.js +23 -19
  3. package/dist/es/components/authentication.js.map +1 -1
  4. package/dist/es/components/authenticationAdmin.js +19 -15
  5. package/dist/es/components/authenticationAdmin.js.map +1 -1
  6. package/dist/es/components/authenticationAudit.js +35 -0
  7. package/dist/es/components/authenticationAudit.js.map +1 -0
  8. package/dist/es/components/authenticationRate.js +37 -0
  9. package/dist/es/components/authenticationRate.js.map +1 -0
  10. package/dist/es/components/hosting.js +29 -0
  11. package/dist/es/components/hosting.js.map +1 -0
  12. package/dist/es/components/information.js +12 -9
  13. package/dist/es/components/information.js.map +1 -1
  14. package/dist/es/components/mimeTypeProcessor.js +7 -7
  15. package/dist/es/components/mimeTypeProcessor.js.map +1 -1
  16. package/dist/es/components/restRouteProcessor.js +38 -46
  17. package/dist/es/components/restRouteProcessor.js.map +1 -1
  18. package/dist/es/components/socketRouteProcessor.js +34 -42
  19. package/dist/es/components/socketRouteProcessor.js.map +1 -1
  20. package/dist/es/index.js +9 -0
  21. package/dist/es/index.js.map +1 -1
  22. package/dist/es/models/IEngineServerConfig.js.map +1 -1
  23. package/dist/es/models/config/authenticationAuditComponentConfig.js +2 -0
  24. package/dist/es/models/config/authenticationAuditComponentConfig.js.map +1 -0
  25. package/dist/es/models/config/authenticationRateComponentConfig.js +2 -0
  26. package/dist/es/models/config/authenticationRateComponentConfig.js.map +1 -0
  27. package/dist/es/models/config/hostingComponentConfig.js +2 -0
  28. package/dist/es/models/config/hostingComponentConfig.js.map +1 -0
  29. package/dist/es/models/config/restRouteProcessorConfig.js.map +1 -1
  30. package/dist/es/models/config/socketRouteProcessorConfig.js.map +1 -1
  31. package/dist/es/models/types/authenticationAuditComponentType.js +13 -0
  32. package/dist/es/models/types/authenticationAuditComponentType.js.map +1 -0
  33. package/dist/es/models/types/authenticationRateComponentType.js +13 -0
  34. package/dist/es/models/types/authenticationRateComponentType.js.map +1 -0
  35. package/dist/es/models/types/hostingComponentType.js +13 -0
  36. package/dist/es/models/types/hostingComponentType.js.map +1 -0
  37. package/dist/types/components/authentication.d.ts +3 -7
  38. package/dist/types/components/authenticationAdmin.d.ts +3 -7
  39. package/dist/types/components/authenticationAudit.d.ts +12 -0
  40. package/dist/types/components/authenticationRate.d.ts +12 -0
  41. package/dist/types/components/hosting.d.ts +12 -0
  42. package/dist/types/components/information.d.ts +3 -7
  43. package/dist/types/components/mimeTypeProcessor.d.ts +2 -7
  44. package/dist/types/components/restRouteProcessor.d.ts +2 -7
  45. package/dist/types/components/socketRouteProcessor.d.ts +2 -7
  46. package/dist/types/index.d.ts +9 -0
  47. package/dist/types/models/IEngineServerConfig.d.ts +21 -6
  48. package/dist/types/models/config/authenticationAuditComponentConfig.d.ts +9 -0
  49. package/dist/types/models/config/authenticationRateComponentConfig.d.ts +9 -0
  50. package/dist/types/models/config/hostingComponentConfig.d.ts +9 -0
  51. package/dist/types/models/config/restRouteProcessorConfig.d.ts +0 -4
  52. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +0 -4
  53. package/dist/types/models/types/authenticationAuditComponentType.d.ts +13 -0
  54. package/dist/types/models/types/authenticationRateComponentType.d.ts +13 -0
  55. package/dist/types/models/types/hostingComponentType.d.ts +13 -0
  56. package/docs/changelog.md +463 -1
  57. package/docs/examples.md +64 -1
  58. package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +2 -2
  59. package/docs/reference/functions/initialiseAuthenticationAuditComponent.md +31 -0
  60. package/docs/reference/functions/initialiseAuthenticationComponent.md +2 -2
  61. package/docs/reference/functions/initialiseAuthenticationRateComponent.md +31 -0
  62. package/docs/reference/functions/initialiseHostingComponent.md +31 -0
  63. package/docs/reference/functions/initialiseInformationComponent.md +2 -2
  64. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +2 -2
  65. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +2 -2
  66. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +2 -2
  67. package/docs/reference/index.md +12 -0
  68. package/docs/reference/interfaces/IEngineServerConfig.md +473 -15
  69. package/docs/reference/type-aliases/AuthenticationAdminComponentConfig.md +3 -3
  70. package/docs/reference/type-aliases/AuthenticationAuditComponentConfig.md +17 -0
  71. package/docs/reference/type-aliases/AuthenticationAuditComponentType.md +5 -0
  72. package/docs/reference/type-aliases/AuthenticationRateComponentConfig.md +17 -0
  73. package/docs/reference/type-aliases/AuthenticationRateComponentType.md +5 -0
  74. package/docs/reference/type-aliases/HostingComponentConfig.md +17 -0
  75. package/docs/reference/type-aliases/HostingComponentType.md +5 -0
  76. package/docs/reference/type-aliases/MimeTypeProcessorConfig.md +3 -3
  77. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  78. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  79. package/docs/reference/variables/AuthenticationAdminComponentType.md +1 -1
  80. package/docs/reference/variables/AuthenticationAuditComponentType.md +13 -0
  81. package/docs/reference/variables/AuthenticationComponentType.md +2 -2
  82. package/docs/reference/variables/AuthenticationRateComponentType.md +13 -0
  83. package/docs/reference/variables/HostingComponentType.md +13 -0
  84. package/docs/reference/variables/InformationComponentType.md +2 -2
  85. package/docs/reference/variables/MimeTypeProcessorType.md +1 -1
  86. package/docs/reference/variables/RestRouteProcessorType.md +7 -7
  87. package/docs/reference/variables/SocketRouteProcessorType.md +7 -7
  88. package/package.json +4 -5
@@ -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.
@@ -0,0 +1,13 @@
1
+ # Variable: HostingComponentType
2
+
3
+ > `const` **HostingComponentType**: `object`
4
+
5
+ Hosting component types.
6
+
7
+ ## Type Declaration
8
+
9
+ ### Service {#service}
10
+
11
+ > `readonly` **Service**: `"service"` = `"service"`
12
+
13
+ Service.
@@ -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,7 +6,7 @@ Mime type route processor types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Jwt
9
+ ### Jwt {#jwt}
10
10
 
11
11
  > `readonly` **Jwt**: `"jwt"` = `"jwt"`
12
12
 
@@ -6,43 +6,43 @@ 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
- ### RestRoute
45
+ ### RestRoute {#restroute}
46
46
 
47
47
  > `readonly` **RestRoute**: `"rest-route"` = `"rest-route"`
48
48
 
@@ -6,43 +6,43 @@ 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
- ### SocketRoute
45
+ ### SocketRoute {#socketroute}
46
46
 
47
47
  > `readonly` **SocketRoute**: `"socket-route"` = `"socket-route"`
48
48
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@twin.org/engine-server-types",
3
- "version": "0.0.3-next.3",
4
- "description": "Server types to use in an engine server.",
3
+ "version": "0.0.3-next.30",
4
+ "description": "Server-focused component types and configuration models for API routing and hosting.",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/twinfoundation/engine.git",
@@ -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.3",
29
- "@twin.org/engine-types": "0.0.3-next.3",
28
+ "@twin.org/engine-models": "0.0.3-next.30",
29
+ "@twin.org/engine-types": "0.0.3-next.30",
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",