@twin.org/engine-models 0.0.3-next.4 → 0.0.3-next.41

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 (29) hide show
  1. package/README.md +1 -1
  2. package/dist/es/index.js +1 -0
  3. package/dist/es/index.js.map +1 -1
  4. package/dist/es/models/IEngineCore.js.map +1 -1
  5. package/dist/es/models/IEngineServer.js.map +1 -1
  6. package/dist/es/models/config/IEngineCoreTypeConfig.js.map +1 -1
  7. package/dist/es/models/engineTypeInitialiser.js.map +1 -1
  8. package/dist/es/models/engineTypeInitialiserReturn.js +2 -0
  9. package/dist/es/models/engineTypeInitialiserReturn.js.map +1 -0
  10. package/dist/types/index.d.ts +1 -0
  11. package/dist/types/models/IEngineCore.d.ts +26 -4
  12. package/dist/types/models/IEngineServer.d.ts +2 -2
  13. package/dist/types/models/config/IEngineCoreTypeConfig.d.ts +4 -0
  14. package/dist/types/models/engineTypeInitialiser.d.ts +3 -19
  15. package/dist/types/models/engineTypeInitialiserReturn.d.ts +19 -0
  16. package/docs/changelog.md +423 -106
  17. package/docs/examples.md +52 -1
  18. package/docs/reference/interfaces/EngineTypeInitialiserReturn.md +28 -8
  19. package/docs/reference/interfaces/IEngineCore.md +98 -30
  20. package/docs/reference/interfaces/IEngineCoreClone.md +5 -5
  21. package/docs/reference/interfaces/IEngineCoreConfig.md +6 -6
  22. package/docs/reference/interfaces/IEngineCoreContext.md +5 -5
  23. package/docs/reference/interfaces/IEngineCoreTypeBaseConfig.md +3 -3
  24. package/docs/reference/interfaces/IEngineModuleConfig.md +9 -9
  25. package/docs/reference/interfaces/IEngineServer.md +7 -7
  26. package/docs/reference/interfaces/IEngineStateStorage.md +4 -4
  27. package/docs/reference/type-aliases/EngineTypeInitialiser.md +7 -3
  28. package/docs/reference/type-aliases/IEngineCoreTypeConfig.md +13 -7
  29. package/package.json +4 -4
package/docs/reference/type-aliases/IEngineCoreTypeConfig.md CHANGED
@@ -8,43 +8,49 @@ Configuration for the engine core type.
8
8
 
9
9
  ### overrideInstanceType?
10
10
 
11
- > `optional` **overrideInstanceType**: `string`
11
+ > `optional` **overrideInstanceType?**: `string`
12
12
 
13
13
  The instance type to override with.
14
14
 
15
15
  ### isDefault?
16
16
 
17
- > `optional` **isDefault**: `boolean`
17
+ > `optional` **isDefault?**: `boolean`
18
18
 
19
19
  Whether this is the default instance.
20
20
 
21
+ ### isMultiInstance?
22
+
23
+ > `optional` **isMultiInstance?**: `boolean`
24
+
25
+ Whether this is a multi-instance component.
26
+
21
27
  ### features?
22
28
 
23
- > `optional` **features**: `string`[]
29
+ > `optional` **features?**: `string`[]
24
30
 
25
31
  The features supported by this instance.
26
32
 
27
33
  ### restPath?
28
34
 
29
- > `optional` **restPath**: `string`
35
+ > `optional` **restPath?**: `string`
30
36
 
31
37
  The path for the REST API.
32
38
 
33
39
  ### restOptions?
34
40
 
35
- > `optional` **restOptions**: `unknown`
41
+ > `optional` **restOptions?**: `unknown`
36
42
 
37
43
  The options for the REST API route generation.
38
44
 
39
45
  ### socketPath?
40
46
 
41
- > `optional` **socketPath**: `string`
47
+ > `optional` **socketPath?**: `string`
42
48
 
43
49
  The path for the socket API.
44
50
 
45
51
  ### socketOptions?
46
52
 
47
- > `optional` **socketOptions**: `unknown`
53
+ > `optional` **socketOptions?**: `unknown`
48
54
 
49
55
  The options for the socket API route generation.
50
56
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/engine-models",
3
- "version": "0.0.3-next.4",
4
- "description": "Models which define the structure of the engine.",
3
+ "version": "0.0.3-next.41",
4
+ "description": "Shared contracts and factory interfaces for composing engine core and server implementations.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/engine.git",
7
+ "url": "git+https://github.com/iotaledger/engine.git",
8
8
  "directory": "packages/engine-models"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -46,7 +46,7 @@
46
46
  "schemas"
47
47
  ],
48
48
  "bugs": {
49
- "url": "git+https://github.com/twinfoundation/engine/issues"
49
+ "url": "git+https://github.com/iotaledger/engine/issues"
50
50
  },
51
51
  "homepage": "https://twindev.org"
52
52
  }