@xyo-network/manifest 2.63.13 → 2.64.0

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 (20) hide show
  1. package/dist/cjs/ManifestWrapper.js +29 -31
  2. package/dist/cjs/ManifestWrapper.js.map +1 -1
  3. package/dist/cjs/ModuleFactory.js +4 -4
  4. package/dist/cjs/ModuleFactory.js.map +1 -1
  5. package/dist/docs.json +912 -1515
  6. package/dist/esm/ManifestWrapper.js +28 -29
  7. package/dist/esm/ManifestWrapper.js.map +1 -1
  8. package/dist/esm/ModuleFactory.js +4 -4
  9. package/dist/esm/ModuleFactory.js.map +1 -1
  10. package/dist/types/ManifestWrapper.d.ts +5 -6
  11. package/dist/types/ManifestWrapper.d.ts.map +1 -1
  12. package/dist/types/Payload.d.ts +12 -9
  13. package/dist/types/Payload.d.ts.map +1 -1
  14. package/package.json +13 -11
  15. package/src/ManifestWrapper.ts +35 -46
  16. package/src/ModuleFactory.ts +4 -4
  17. package/src/Payload.ts +11 -9
  18. package/src/schema.json +98 -79
  19. package/src/spec/simple-node-inline-manifest.json +24 -14
  20. package/src/spec/simple-node-indirect-manifest.json +0 -41
package/src/schema.json CHANGED
@@ -2,45 +2,69 @@
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
3
  "additionalProperties": false,
4
4
  "definitions": {
5
- "dapp": {
6
- "additionalProperties": false,
7
- "description": "dApp Definition - Generally loaded into an existing or new Node Module",
5
+ "architecture": {
6
+ "description": "Architecture",
7
+ "enum": [
8
+ "386",
9
+ "amd64",
10
+ "arm",
11
+ "arm64",
12
+ "loong64",
13
+ "mips",
14
+ "mipsle",
15
+ "mips64",
16
+ "mips64le",
17
+ "ppc64",
18
+ "ppc64le",
19
+ "riscv64",
20
+ "s390x",
21
+ "wasm"
22
+ ],
23
+ "type": "string"
24
+ },
25
+ "config": {
26
+ "additionalProperties": true,
27
+ "description": "Config for a module",
8
28
  "id": {
9
29
  "type": "string"
10
30
  },
11
31
  "properties": {
32
+ "accountPath": {
33
+ "description": "HDWallet path to derive account",
34
+ "type": "string"
35
+ },
36
+ "architecture": {
37
+ "$ref": "#/definitions/architecture"
38
+ },
12
39
  "description": {
13
40
  "type": "string"
14
41
  },
15
- "modules": {
16
- "additionalProperties": false,
17
- "description": "dApp Modules",
18
- "properties": {
19
- "private": {
20
- "$ref": "#/definitions/modules"
21
- },
22
- "public": {
23
- "$ref": "#/definitions/modules"
24
- }
42
+ "features": {
43
+ "items": {
44
+ "$ref": "#/definitions/feature"
25
45
  },
26
- "required": [],
27
- "type": "object"
46
+ "type": "array"
47
+ },
48
+ "language": {
49
+ "$ref": "#/definitions/language"
28
50
  },
29
51
  "name": {
30
52
  "type": "string"
53
+ },
54
+ "os": {
55
+ "$ref": "#/definitions/os"
56
+ },
57
+ "schema": {
58
+ "type": "string"
31
59
  }
32
60
  },
33
- "required": [],
61
+ "required": [
62
+ "accountPath",
63
+ "name",
64
+ "schema"
65
+ ],
34
66
  "type": "object"
35
67
  },
36
- "dapps": {
37
- "description": "List of dApps",
38
- "items": {
39
- "$ref": "#/definitions/dapp"
40
- },
41
- "nullable": true,
42
- "type": "array"
43
- },
44
68
  "feature": {
45
69
  "description": "Framework",
46
70
  "enum": [
@@ -89,67 +113,65 @@
89
113
  "additionalProperties": false,
90
114
  "description": "Module Definition",
91
115
  "properties": {
92
- "accountPath": {
93
- "description": "HDWallet path to derive account",
94
- "type": "string"
116
+ "config": {
117
+ "$ref": "#/definitions/config"
95
118
  },
96
- "architecture": {
97
- "description": "Architecture",
98
- "enum": [
99
- "386",
100
- "amd64",
101
- "arm",
102
- "arm64",
103
- "loong64",
104
- "mips",
105
- "mipsle",
106
- "mips64",
107
- "mips64le",
108
- "ppc64",
109
- "ppc64le",
110
- "riscv64",
111
- "s390x",
112
- "wasm"
113
- ],
119
+ "description": {
114
120
  "type": "string"
115
- },
121
+ }
122
+ },
123
+ "required": [
124
+ "config"
125
+ ],
126
+ "type": "object"
127
+ },
128
+ "modules": {
129
+ "description": "List of Modules",
130
+ "items": {
131
+ "$ref": "#/definitions/module"
132
+ },
133
+ "nullable": true,
134
+ "type": "array"
135
+ },
136
+ "node": {
137
+ "additionalProperties": false,
138
+ "description": "Node Definition - Generally loaded into an existing or new Node Module",
139
+ "id": {
140
+ "type": "string"
141
+ },
142
+ "properties": {
116
143
  "config": {
117
- "description": "The default config for the module",
118
- "type": "object"
144
+ "$ref": "#/definitions/config"
119
145
  },
120
146
  "description": {
121
147
  "type": "string"
122
148
  },
123
- "features": {
124
- "items": {
125
- "$ref": "#/definitions/feature"
149
+ "modules": {
150
+ "additionalProperties": false,
151
+ "description": "Modules in the Node",
152
+ "properties": {
153
+ "private": {
154
+ "$ref": "#/definitions/modules"
155
+ },
156
+ "public": {
157
+ "$ref": "#/definitions/modules"
158
+ }
126
159
  },
127
- "type": "array"
128
- },
129
- "id": {
130
- "description": "The canonical id that tells the loader how to find the correct registered module implementation",
131
- "type": "string"
132
- },
133
- "language": {
134
- "$ref": "#/definitions/language"
160
+ "required": [],
161
+ "type": "object"
135
162
  },
136
163
  "name": {
137
- "description": "The friendly name for this module",
138
164
  "type": "string"
139
- },
140
- "os": {
141
- "$ref": "#/definitions/os"
142
165
  }
143
166
  },
144
167
  "required": [],
145
168
  "type": "object"
146
169
  },
147
- "modules": {
148
- "description": "List of Modules",
170
+ "nodes": {
171
+ "description": "List of Node Manifests",
149
172
  "items": {
150
- "$ref": "#/definitions/module"
173
+ "$ref": "#/definitions/node"
151
174
  },
152
- "nullable": true,
153
175
  "type": "array"
154
176
  },
155
177
  "os": {
@@ -178,24 +200,21 @@
178
200
  "$schema": {
179
201
  "type": "string"
180
202
  },
181
- "dapps": {
182
- "$ref": "#/definitions/dapps",
183
- "description": "The list of dApps that are defined in the manifest"
184
- },
185
203
  "description": {
186
204
  "type": "string"
187
205
  },
188
- "modules": {
189
- "additionalProperties": {
190
- "$ref": "#/definitions/module"
191
- },
192
- "description": "The list of global modules that are defined in the manifest",
193
- "type": "object"
206
+ "nodes": {
207
+ "$ref": "#/definitions/nodes",
208
+ "description": "The list of Nodes that are defined in the manifest"
194
209
  },
195
210
  "schema": {
196
- "type": "string"
211
+ "type": "string",
212
+ "pattern": "^network.xyo.manifest$"
197
213
  }
198
214
  },
199
- "required": [],
215
+ "required": [
216
+ "nodes",
217
+ "schema"
218
+ ],
200
219
  "title": "XYO Manifest"
201
220
  }
package/src/spec/simple-node-inline-manifest.json CHANGED
@@ -1,32 +1,42 @@
1
1
  {
2
2
  "$schema": "../schema.json",
3
- "dapps": [
3
+ "nodes": [
4
4
  {
5
5
  "modules": {
6
6
  "private": [
7
7
  {
8
- "accountPath": "1'",
9
- "id": "network.xyo.archivist",
10
- "language": "javascript",
11
- "name": "ScratchArchivist"
8
+ "config": {
9
+ "accountPath": "1'",
10
+ "language": "javascript",
11
+ "name": "ScratchArchivist",
12
+ "schema": "network.xyo.archivist.config"
13
+ }
12
14
  }
13
15
  ],
14
16
  "public": [
15
17
  {
16
- "accountPath": "2'",
17
- "id": "network.xyo.archivist",
18
- "language": "javascript",
19
- "name": "SimpleArchivist"
18
+ "config": {
19
+ "accountPath": "2'",
20
+ "language": "javascript",
21
+ "name": "SimpleArchivist",
22
+ "schema": "network.xyo.archivist.config"
23
+ }
20
24
  },
21
25
  {
22
- "accountPath": "3'",
23
- "id": "network.xyo.sentinel",
24
- "language": "javascript",
25
- "name": "SimpleSentinel"
26
+ "config": {
27
+ "accountPath": "3'",
28
+ "language": "javascript",
29
+ "name": "SimpleSentinel",
30
+ "schema": "network.xyo.sentinel.config"
31
+ }
26
32
  }
27
33
  ]
28
34
  },
29
- "name": "SimpleMemoryDapp"
35
+ "config": {
36
+ "accountPath": "0'",
37
+ "schema": "network.xyo.node.config",
38
+ "name": "SimpleMemoryDapp"
39
+ }
30
40
  }
31
41
  ],
32
42
  "schema": "network.xyo.manifest"
package/src/spec/simple-node-indirect-manifest.json DELETED
@@ -1,41 +0,0 @@
1
- {
2
- "$schema": "../schema.json",
3
- "dapps": [
4
- {
5
- "modules": {
6
- "private": [
7
- {
8
- "name": "ScratchArchivist"
9
- }
10
- ],
11
- "public": [
12
- {
13
- "name": "SimpleArchivist"
14
- },
15
- {
16
- "name": "SimpleSentinel"
17
- }
18
- ]
19
- },
20
- "name": "SimpleMemoryDapp"
21
- }
22
- ],
23
- "modules": {
24
- "ScratchArchivist": {
25
- "accountPath": "1'",
26
- "id": "network.xyo.archivist",
27
- "language": "javascript"
28
- },
29
- "SimpleArchivist": {
30
- "accountPath": "2'",
31
- "id": "network.xyo.archivist",
32
- "language": "javascript"
33
- },
34
- "SimpleSentinel": {
35
- "accountPath": "3'",
36
- "id": "network.xyo.sentinel",
37
- "language": "javascript"
38
- }
39
- },
40
- "schema": "network.xyo.manifest"
41
- }