@twin.org/engine-server 0.0.1-next.1

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 (17) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +21 -0
  3. package/dist/cjs/index.cjs +513 -0
  4. package/dist/esm/index.mjs +511 -0
  5. package/dist/types/components/authentication.d.ts +11 -0
  6. package/dist/types/components/information.d.ts +11 -0
  7. package/dist/types/components/mimeTypeProcessor.d.ts +11 -0
  8. package/dist/types/components/restRouteProcessor.d.ts +11 -0
  9. package/dist/types/components/socketRouteProcessor.d.ts +11 -0
  10. package/dist/types/engineServer.d.ts +48 -0
  11. package/dist/types/index.d.ts +1 -0
  12. package/docs/changelog.md +5 -0
  13. package/docs/examples.md +1 -0
  14. package/docs/reference/classes/EngineServer.md +145 -0
  15. package/docs/reference/index.md +5 -0
  16. package/locales/en.json +1 -0
  17. package/package.json +104 -0
package/docs/reference/classes/EngineServer.md ADDED
@@ -0,0 +1,145 @@
1
+ # Class: EngineServer
2
+
3
+ Server for the engine.
4
+
5
+ ## Implements
6
+
7
+ - `IEngineServer`
8
+
9
+ ## Constructors
10
+
11
+ ### new EngineServer()
12
+
13
+ > **new EngineServer**(`options`): [`EngineServer`](EngineServer.md)
14
+
15
+ Create a new instance of EngineServer.
16
+
17
+ #### Parameters
18
+
19
+ • **options**
20
+
21
+ The options for the engine.
22
+
23
+ • **options.engineCore**: `IEngineCore`
24
+
25
+ The engine core to serve from.
26
+
27
+ • **options.server?**: `IEngineServerConfig`
28
+
29
+ The server options for the engine.
30
+
31
+ #### Returns
32
+
33
+ [`EngineServer`](EngineServer.md)
34
+
35
+ ## Properties
36
+
37
+ ### CLASS\_NAME
38
+
39
+ > `readonly` **CLASS\_NAME**: `string`
40
+
41
+ Runtime name for the class.
42
+
43
+ ***
44
+
45
+ ### \_config
46
+
47
+ > `protected` `readonly` **\_config**: `IEngineServerConfig`
48
+
49
+ The server config.
50
+
51
+ ## Methods
52
+
53
+ ### addRestRouteGenerator()
54
+
55
+ > **addRestRouteGenerator**(`type`, `typeConfig`, `generator`): `void`
56
+
57
+ Add a REST route generator.
58
+
59
+ #### Parameters
60
+
61
+ • **type**: `string`
62
+
63
+ The type to add the generator for.
64
+
65
+ • **typeConfig**: `undefined` \| `IEngineCoreTypeConfig`[]
66
+
67
+ The type config.
68
+
69
+ • **generator**: `RestRouteGenerator`
70
+
71
+ The generator to add.
72
+
73
+ #### Returns
74
+
75
+ `void`
76
+
77
+ #### Implementation of
78
+
79
+ `IEngineServer.addRestRouteGenerator`
80
+
81
+ ***
82
+
83
+ ### addSocketRouteGenerator()
84
+
85
+ > **addSocketRouteGenerator**(`type`, `typeConfig`, `generator`): `void`
86
+
87
+ Add a socket route generator.
88
+
89
+ #### Parameters
90
+
91
+ • **type**: `string`
92
+
93
+ The type to add the generator for.
94
+
95
+ • **typeConfig**: `undefined` \| `IEngineCoreTypeConfig`[]
96
+
97
+ The type config.
98
+
99
+ • **generator**: `SocketRouteGenerator`
100
+
101
+ The generator to add.
102
+
103
+ #### Returns
104
+
105
+ `void`
106
+
107
+ #### Implementation of
108
+
109
+ `IEngineServer.addSocketRouteGenerator`
110
+
111
+ ***
112
+
113
+ ### start()
114
+
115
+ > **start**(): `Promise`\<`void`\>
116
+
117
+ Start the engine server.
118
+
119
+ #### Returns
120
+
121
+ `Promise`\<`void`\>
122
+
123
+ Nothing.
124
+
125
+ #### Implementation of
126
+
127
+ `IEngineServer.start`
128
+
129
+ ***
130
+
131
+ ### stop()
132
+
133
+ > **stop**(): `Promise`\<`void`\>
134
+
135
+ Stop the engine server.
136
+
137
+ #### Returns
138
+
139
+ `Promise`\<`void`\>
140
+
141
+ Nothing.
142
+
143
+ #### Implementation of
144
+
145
+ `IEngineServer.stop`
package/docs/reference/index.md ADDED
@@ -0,0 +1,5 @@
1
+ # @twin.org/engine-server
2
+
3
+ ## Classes
4
+
5
+ - [EngineServer](classes/EngineServer.md)
package/locales/en.json ADDED
@@ -0,0 +1 @@
1
+ {}
package/package.json ADDED
@@ -0,0 +1,104 @@
1
+ {
2
+ "name": "@twin.org/engine-server",
3
+ "version": "0.0.1-next.1",
4
+ "description": "Engine implementation for a server.",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/twinfoundation/engine.git",
8
+ "directory": "packages/engine-server"
9
+ },
10
+ "author": "martyn.janes@iota.org",
11
+ "license": "Apache-2.0",
12
+ "type": "module",
13
+ "engines": {
14
+ "node": ">=20.0.0"
15
+ },
16
+ "dependencies": {
17
+ "@twin.org/api-auth-entity-storage-service": "next",
18
+ "@twin.org/api-core": "next",
19
+ "@twin.org/api-models": "next",
20
+ "@twin.org/api-processors": "next",
21
+ "@twin.org/api-server-fastify": "next",
22
+ "@twin.org/api-service": "next",
23
+ "@twin.org/attestation-connector-entity-storage": "next",
24
+ "@twin.org/attestation-connector-iota": "next",
25
+ "@twin.org/attestation-models": "next",
26
+ "@twin.org/attestation-service": "next",
27
+ "@twin.org/auditable-item-graph-models": "next",
28
+ "@twin.org/auditable-item-graph-service": "next",
29
+ "@twin.org/auditable-item-stream-models": "next",
30
+ "@twin.org/auditable-item-stream-service": "next",
31
+ "@twin.org/background-task-connector-entity-storage": "next",
32
+ "@twin.org/background-task-models": "next",
33
+ "@twin.org/blob-storage-connector-aws-s3": "next",
34
+ "@twin.org/blob-storage-connector-azure": "next",
35
+ "@twin.org/blob-storage-connector-file": "next",
36
+ "@twin.org/blob-storage-connector-gcp": "next",
37
+ "@twin.org/blob-storage-connector-ipfs": "next",
38
+ "@twin.org/blob-storage-connector-memory": "next",
39
+ "@twin.org/blob-storage-models": "next",
40
+ "@twin.org/blob-storage-service": "next",
41
+ "@twin.org/cli-core": "next",
42
+ "@twin.org/core": "next",
43
+ "@twin.org/crypto": "next",
44
+ "@twin.org/data-core": "next",
45
+ "@twin.org/data-schema-org": "next",
46
+ "@twin.org/engine-core": "0.0.1-next.1",
47
+ "@twin.org/engine-models": "0.0.1-next.1",
48
+ "@twin.org/entity": "next",
49
+ "@twin.org/entity-storage-connector-cosmosdb": "next",
50
+ "@twin.org/entity-storage-connector-dynamodb": "next",
51
+ "@twin.org/entity-storage-connector-file": "next",
52
+ "@twin.org/entity-storage-connector-gcp-firestore": "next",
53
+ "@twin.org/entity-storage-connector-memory": "next",
54
+ "@twin.org/entity-storage-connector-scylladb": "next",
55
+ "@twin.org/entity-storage-models": "next",
56
+ "@twin.org/entity-storage-service": "next",
57
+ "@twin.org/identity-connector-entity-storage": "next",
58
+ "@twin.org/identity-connector-iota": "next",
59
+ "@twin.org/identity-models": "next",
60
+ "@twin.org/identity-service": "next",
61
+ "@twin.org/immutable-proof-models": "next",
62
+ "@twin.org/immutable-proof-service": "next",
63
+ "@twin.org/immutable-storage-connector-entity-storage": "next",
64
+ "@twin.org/immutable-storage-connector-iota": "next",
65
+ "@twin.org/immutable-storage-models": "next",
66
+ "@twin.org/logging-connector-console": "next",
67
+ "@twin.org/logging-connector-entity-storage": "next",
68
+ "@twin.org/logging-models": "next",
69
+ "@twin.org/logging-service": "next",
70
+ "@twin.org/nameof": "next",
71
+ "@twin.org/nft-connector-entity-storage": "next",
72
+ "@twin.org/nft-connector-iota": "next",
73
+ "@twin.org/nft-models": "next",
74
+ "@twin.org/nft-service": "next",
75
+ "@twin.org/telemetry-connector-entity-storage": "next",
76
+ "@twin.org/telemetry-models": "next",
77
+ "@twin.org/telemetry-service": "next",
78
+ "@twin.org/vault-connector-entity-storage": "next",
79
+ "@twin.org/vault-connector-hashicorp": "next",
80
+ "@twin.org/vault-models": "next",
81
+ "@twin.org/wallet-connector-entity-storage": "next",
82
+ "@twin.org/wallet-connector-iota": "next",
83
+ "@twin.org/wallet-models": "next",
84
+ "@twin.org/web": "next"
85
+ },
86
+ "main": "./dist/cjs/index.cjs",
87
+ "module": "./dist/esm/index.mjs",
88
+ "types": "./dist/types/index.d.ts",
89
+ "exports": {
90
+ ".": {
91
+ "require": "./dist/cjs/index.cjs",
92
+ "import": "./dist/esm/index.mjs",
93
+ "types": "./dist/types/index.d.ts"
94
+ },
95
+ "./locales/*.json": "./locales/*.json"
96
+ },
97
+ "files": [
98
+ "dist/cjs",
99
+ "dist/esm",
100
+ "dist/types",
101
+ "locales",
102
+ "docs"
103
+ ]
104
+ }