@twin.org/engine-core 0.0.3-next.5 → 0.0.3-next.50

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 (15) hide show
  1. package/README.md +1 -1
  2. package/dist/es/engineCore.js +131 -75
  3. package/dist/es/engineCore.js.map +1 -1
  4. package/dist/es/storage/fileStateStorage.js.map +1 -1
  5. package/dist/es/storage/memoryStateStorage.js.map +1 -1
  6. package/dist/types/engineCore.d.ts +32 -4
  7. package/docs/changelog.md +857 -111
  8. package/docs/examples.md +156 -1
  9. package/docs/reference/classes/EngineCore.md +143 -37
  10. package/docs/reference/classes/EngineModuleHelper.md +2 -2
  11. package/docs/reference/classes/FileStateStorage.md +7 -7
  12. package/docs/reference/classes/MemoryStateStorage.md +7 -7
  13. package/docs/reference/interfaces/IEngineCoreOptions.md +10 -10
  14. package/locales/en.json +2 -1
  15. package/package.json +5 -5
package/docs/reference/interfaces/IEngineCoreOptions.md CHANGED
@@ -14,33 +14,33 @@ The options for creating engine core.
14
14
 
15
15
  ## Properties
16
16
 
17
- ### config?
17
+ ### config? {#config}
18
18
 
19
- > `optional` **config**: `C`
19
+ > `optional` **config?**: `C`
20
20
 
21
21
  The engine core config.
22
22
 
23
23
  ***
24
24
 
25
- ### stateStorage?
25
+ ### stateStorage? {#statestorage}
26
26
 
27
- > `optional` **stateStorage**: `IEngineStateStorage`\<`S`\>
27
+ > `optional` **stateStorage?**: `IEngineStateStorage`\<`S`\>
28
28
 
29
29
  The state storage component.
30
30
 
31
31
  ***
32
32
 
33
- ### skipBootstrap?
33
+ ### skipBootstrap? {#skipbootstrap}
34
34
 
35
- > `optional` **skipBootstrap**: `boolean`
35
+ > `optional` **skipBootstrap?**: `boolean`
36
36
 
37
37
  Skip the bootstrap process, useful for additional engine instances.
38
38
 
39
39
  ***
40
40
 
41
- ### populateTypeInitialisers()?
41
+ ### populateTypeInitialisers? {#populatetypeinitialisers}
42
42
 
43
- > `optional` **populateTypeInitialisers**: (`engineCore`, `context`) => `void`
43
+ > `optional` **populateTypeInitialisers?**: (`engineCore`, `context`) => `void`
44
44
 
45
45
  Populate the type initialisers for the engine.
46
46
 
@@ -60,9 +60,9 @@ Populate the type initialisers for the engine.
60
60
 
61
61
  ***
62
62
 
63
- ### customBootstrap()?
63
+ ### customBootstrap? {#custombootstrap}
64
64
 
65
- > `optional` **customBootstrap**: (`engineCore`, `context`) => `Promise`\<`void`\>
65
+ > `optional` **customBootstrap?**: (`engineCore`, `context`) => `Promise`\<`void`\>
66
66
 
67
67
  Custom bootstrap method for the engine.
68
68
 
package/locales/en.json CHANGED
@@ -5,7 +5,8 @@
5
5
  "bootstrapFailed": "Failed to bootstrap component type \"{className}\" with instance type \"{instanceType}\"",
6
6
  "componentStartFailed": "Failed to start component type \"{className}\" with instance type \"{instanceType}\"",
7
7
  "componentStopFailed": "Failed to stop component type \"{className}\" with instance type \"{instanceType}\"",
8
- "instanceTypeNotFound": "Instance type not found for \"{type}\" with features \"{features}\""
8
+ "instanceTypeNotFound": "Instance type not found for \"{type}\"",
9
+ "instanceTypeNotFoundWithFeatures": "Instance type not found for \"{type}\" with features \"{features}\""
9
10
  },
10
11
  "fileStateStorage": {
11
12
  "failedLoading": "Failed to load file state storage from \"{filename}\"",
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/engine-core",
3
- "version": "0.0.3-next.5",
4
- "description": "Engine core.",
3
+ "version": "0.0.3-next.50",
4
+ "description": "Core runtime lifecycle and state orchestration for engine instances.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/engine.git",
7
+ "url": "git+https://github.com/iotaledger/twin-engine.git",
8
8
  "directory": "packages/engine-core"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -18,7 +18,7 @@
18
18
  "@twin.org/core": "next",
19
19
  "@twin.org/crypto": "next",
20
20
  "@twin.org/data-core": "next",
21
- "@twin.org/engine-models": "0.0.3-next.5",
21
+ "@twin.org/engine-models": "0.0.3-next.50",
22
22
  "@twin.org/entity": "next",
23
23
  "@twin.org/logging-connector-console": "next",
24
24
  "@twin.org/logging-models": "next",
@@ -54,7 +54,7 @@
54
54
  "utilities"
55
55
  ],
56
56
  "bugs": {
57
- "url": "git+https://github.com/twinfoundation/engine/issues"
57
+ "url": "git+https://github.com/iotaledger/twin-engine/issues"
58
58
  },
59
59
  "homepage": "https://twindev.org"
60
60
  }