@3sixty/engine 0.0.0-stage → 0.20.0-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 (19) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +24 -2
  3. package/dist/es/data/coreTypeInitialisers.json +387 -0
  4. package/dist/es/engine.js +31 -0
  5. package/dist/es/engine.js.map +1 -0
  6. package/dist/es/index.js +5 -0
  7. package/dist/es/index.js.map +1 -0
  8. package/dist/es/utils/engineConfigHelper.js +39 -0
  9. package/dist/es/utils/engineConfigHelper.js.map +1 -0
  10. package/dist/types/engine.d.ts +17 -0
  11. package/dist/types/index.d.ts +2 -0
  12. package/dist/types/utils/engineConfigHelper.d.ts +20 -0
  13. package/docs/changelog.md +17 -0
  14. package/docs/examples.md +68 -0
  15. package/docs/reference/classes/Engine.md +737 -0
  16. package/docs/reference/classes/EngineConfigHelper.md +71 -0
  17. package/docs/reference/index.md +6 -0
  18. package/locales/en.json +1 -0
  19. package/package.json +52 -5
package/docs/reference/classes/EngineConfigHelper.md ADDED
@@ -0,0 +1,71 @@
1
+ # Class: EngineConfigHelper
2
+
3
+ Helper methods for engine config.
4
+
5
+ ## Constructors
6
+
7
+ ### Constructor
8
+
9
+ > **new EngineConfigHelper**(): `EngineConfigHelper`
10
+
11
+ #### Returns
12
+
13
+ `EngineConfigHelper`
14
+
15
+ ## Properties
16
+
17
+ ### CLASS\_NAME {#class_name}
18
+
19
+ > `readonly` `static` **CLASS\_NAME**: `string`
20
+
21
+ Runtime name for the class.
22
+
23
+ ## Methods
24
+
25
+ ### addCustomEntityStorage() {#addcustomentitystorage}
26
+
27
+ > `static` **addCustomEntityStorage**\<`T`\>(`engineConfig`, `entityTypeName`, `entitySchema`, `restPath?`, `partitionContextIds?`): `void`
28
+
29
+ Add a custom entity storage to the engine configuration.
30
+
31
+ #### Type Parameters
32
+
33
+ ##### T {#t}
34
+
35
+ `T`
36
+
37
+ #### Parameters
38
+
39
+ ##### engineConfig
40
+
41
+ `IEngineConfig`
42
+
43
+ The engine configuration.
44
+
45
+ ##### entityTypeName
46
+
47
+ `string`
48
+
49
+ The entity type name.
50
+
51
+ ##### entitySchema
52
+
53
+ `IEntitySchema`\<`T`\>
54
+
55
+ The entity schema.
56
+
57
+ ##### restPath?
58
+
59
+ `string`
60
+
61
+ The rest path to serve the entity storage from, leave undefined for no endpoints.
62
+
63
+ ##### partitionContextIds?
64
+
65
+ `string`[]
66
+
67
+ The context ids to use for partitioning, leave undefined to partition by whichever of the node and tenant keys are registered with the engine when it starts.
68
+
69
+ #### Returns
70
+
71
+ `void`
package/docs/reference/index.md ADDED
@@ -0,0 +1,6 @@
1
+ # @3sixty/engine
2
+
3
+ ## Classes
4
+
5
+ - [Engine](classes/Engine.md)
6
+ - [EngineConfigHelper](classes/EngineConfigHelper.md)
package/locales/en.json ADDED
@@ -0,0 +1 @@
1
+ {}
package/package.json CHANGED
@@ -1,6 +1,53 @@
1
1
  {
2
- "name": "@3sixty/engine",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
2
+ "name": "@3sixty/engine",
3
+ "version": "0.20.0-next.1",
4
+ "description": "Ready-to-use engine runtime that preloads built-in type initialisers.",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/3sixtyglobal/engine.git",
8
+ "directory": "packages/engine-core"
9
+ },
10
+ "author": "martyn.janes@iota.org",
11
+ "license": "Apache-2.0",
12
+ "type": "module",
13
+ "engines": {
14
+ "node": ">=24.0.0"
15
+ },
16
+ "dependencies": {
17
+ "@3sixty/context": "next",
18
+ "@3sixty/core": "next",
19
+ "@3sixty/engine-core": "0.20.0-next.1",
20
+ "@3sixty/engine-models": "0.20.0-next.1",
21
+ "@3sixty/engine-types": "0.20.0-next.1",
22
+ "@3sixty/entity": "next",
23
+ "@3sixty/nameof": "next"
24
+ },
25
+ "main": "./dist/es/index.js",
26
+ "types": "./dist/types/index.d.ts",
27
+ "exports": {
28
+ ".": {
29
+ "types": "./dist/types/index.d.ts",
30
+ "import": "./dist/es/index.js",
31
+ "default": "./dist/es/index.js"
32
+ },
33
+ "./locales/*.json": "./locales/*.json"
34
+ },
35
+ "files": [
36
+ "dist/es",
37
+ "dist/types",
38
+ "locales",
39
+ "docs"
40
+ ],
41
+ "keywords": [
42
+ "twin",
43
+ "trade",
44
+ "iota",
45
+ "framework",
46
+ "blockchain",
47
+ "engine"
48
+ ],
49
+ "bugs": {
50
+ "url": "git+https://github.com/3sixtyglobal/engine/issues"
51
+ },
52
+ "homepage": "https://3sixty.global"
53
+ }