@twin.org/auditable-item-graph-service 0.0.2-next.8 → 0.0.3-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 (42) hide show
  1. package/dist/es/auditableItemGraphRoutes.js +529 -0
  2. package/dist/es/auditableItemGraphRoutes.js.map +1 -0
  3. package/dist/es/auditableItemGraphService.js +919 -0
  4. package/dist/es/auditableItemGraphService.js.map +1 -0
  5. package/dist/es/entities/auditableItemGraphAlias.js +62 -0
  6. package/dist/es/entities/auditableItemGraphAlias.js.map +1 -0
  7. package/dist/es/entities/auditableItemGraphChangeset.js +61 -0
  8. package/dist/es/entities/auditableItemGraphChangeset.js.map +1 -0
  9. package/dist/es/entities/auditableItemGraphEdge.js +70 -0
  10. package/dist/es/entities/auditableItemGraphEdge.js.map +1 -0
  11. package/dist/es/entities/auditableItemGraphPatch.js +45 -0
  12. package/dist/es/entities/auditableItemGraphPatch.js.map +1 -0
  13. package/dist/es/entities/auditableItemGraphResource.js +54 -0
  14. package/dist/es/entities/auditableItemGraphResource.js.map +1 -0
  15. package/dist/es/entities/auditableItemGraphVertex.js +99 -0
  16. package/dist/es/entities/auditableItemGraphVertex.js.map +1 -0
  17. package/dist/es/index.js +15 -0
  18. package/dist/es/index.js.map +1 -0
  19. package/dist/es/models/IAuditableItemGraphServiceConfig.js +4 -0
  20. package/dist/es/models/IAuditableItemGraphServiceConfig.js.map +1 -0
  21. package/dist/es/models/IAuditableItemGraphServiceConstructorOptions.js +2 -0
  22. package/dist/es/models/IAuditableItemGraphServiceConstructorOptions.js.map +1 -0
  23. package/dist/es/models/IAuditableItemGraphServiceContext.js +2 -0
  24. package/dist/es/models/IAuditableItemGraphServiceContext.js.map +1 -0
  25. package/dist/es/restEntryPoints.js +10 -0
  26. package/dist/es/restEntryPoints.js.map +1 -0
  27. package/dist/es/schema.js +21 -0
  28. package/dist/es/schema.js.map +1 -0
  29. package/dist/types/auditableItemGraphService.d.ts +9 -9
  30. package/dist/types/entities/auditableItemGraphChangeset.d.ts +2 -2
  31. package/dist/types/entities/auditableItemGraphVertex.d.ts +5 -5
  32. package/dist/types/index.d.ts +12 -12
  33. package/dist/types/models/IAuditableItemGraphServiceConstructorOptions.d.ts +1 -1
  34. package/dist/types/models/IAuditableItemGraphServiceContext.d.ts +3 -6
  35. package/docs/changelog.md +36 -0
  36. package/docs/open-api/spec.json +112 -136
  37. package/docs/reference/classes/AuditableItemGraphChangeset.md +2 -2
  38. package/docs/reference/classes/AuditableItemGraphService.md +21 -33
  39. package/docs/reference/classes/AuditableItemGraphVertex.md +3 -3
  40. package/package.json +7 -8
  41. package/dist/cjs/index.cjs +0 -1854
  42. package/dist/esm/index.mjs +0 -1844
package/docs/reference/classes/AuditableItemGraphService.md CHANGED
@@ -52,9 +52,27 @@ The namespace for the service edge.
52
52
 
53
53
  ## Methods
54
54
 
55
+ ### className()
56
+
57
+ > **className**(): `string`
58
+
59
+ Returns the class name of the component.
60
+
61
+ #### Returns
62
+
63
+ `string`
64
+
65
+ The class name of the component.
66
+
67
+ #### Implementation of
68
+
69
+ `IAuditableItemGraphComponent.className`
70
+
71
+ ***
72
+
55
73
  ### create()
56
74
 
57
- > **create**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
75
+ > **create**(`vertex`): `Promise`\<`string`\>
58
76
 
59
77
  Create a new graph vertex.
60
78
 
@@ -88,18 +106,6 @@ The resources attached to the vertex.
88
106
 
89
107
  The edges connected to the vertex.
90
108
 
91
- ##### userIdentity?
92
-
93
- `string`
94
-
95
- The identity to create the auditable item graph operation with.
96
-
97
- ##### nodeIdentity?
98
-
99
- `string`
100
-
101
- The node identity to include in the auditable item graph.
102
-
103
109
  #### Returns
104
110
 
105
111
  `Promise`\<`string`\>
@@ -166,7 +172,7 @@ NotFoundError if the vertex is not found.
166
172
 
167
173
  ### update()
168
174
 
169
- > **update**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
175
+ > **update**(`vertex`): `Promise`\<`void`\>
170
176
 
171
177
  Update a graph vertex.
172
178
 
@@ -206,18 +212,6 @@ The resources attached to the vertex.
206
212
 
207
213
  The edges connected to the vertex.
208
214
 
209
- ##### userIdentity?
210
-
211
- `string`
212
-
213
- The identity to create the auditable item graph operation with.
214
-
215
- ##### nodeIdentity?
216
-
217
- `string`
218
-
219
- The node identity to include in the auditable item graph.
220
-
221
215
  #### Returns
222
216
 
223
217
  `Promise`\<`void`\>
@@ -232,7 +226,7 @@ Nothing.
232
226
 
233
227
  ### removeVerifiable()
234
228
 
235
- > **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
229
+ > **removeVerifiable**(`id`): `Promise`\<`void`\>
236
230
 
237
231
  Remove the verifiable storage for an item.
238
232
 
@@ -244,12 +238,6 @@ Remove the verifiable storage for an item.
244
238
 
245
239
  The id of the vertex to get.
246
240
 
247
- ##### nodeIdentity?
248
-
249
- `string`
250
-
251
- The node identity to use for vault operations.
252
-
253
241
  #### Returns
254
242
 
255
243
  `Promise`\<`void`\>
package/docs/reference/classes/AuditableItemGraphVertex.md CHANGED
@@ -22,11 +22,11 @@ The id of the vertex.
22
22
 
23
23
  ***
24
24
 
25
- ### nodeIdentity?
25
+ ### organizationIdentity?
26
26
 
27
- > `optional` **nodeIdentity**: `string`
27
+ > `optional` **organizationIdentity**: `string`
28
28
 
29
- The identity of the node which controls the vertex.
29
+ The identity of the organization which controls the vertex.
30
30
 
31
31
  ***
32
32
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/auditable-item-graph-service",
3
- "version": "0.0.2-next.8",
3
+ "version": "0.0.3-next.1",
4
4
  "description": "Auditable Item Graph contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,7 +15,8 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/api-models": "next",
18
- "@twin.org/auditable-item-graph-models": "0.0.2-next.8",
18
+ "@twin.org/auditable-item-graph-models": "0.0.3-next.1",
19
+ "@twin.org/context": "next",
19
20
  "@twin.org/core": "next",
20
21
  "@twin.org/crypto": "next",
21
22
  "@twin.org/data-json-ld": "next",
@@ -29,20 +30,18 @@
29
30
  "@twin.org/verifiable-storage-models": "next",
30
31
  "@twin.org/web": "next"
31
32
  },
32
- "main": "./dist/cjs/index.cjs",
33
- "module": "./dist/esm/index.mjs",
33
+ "main": "./dist/es/index.js",
34
34
  "types": "./dist/types/index.d.ts",
35
35
  "exports": {
36
36
  ".": {
37
37
  "types": "./dist/types/index.d.ts",
38
- "require": "./dist/cjs/index.cjs",
39
- "import": "./dist/esm/index.mjs"
38
+ "import": "./dist/es/index.js",
39
+ "default": "./dist/es/index.js"
40
40
  },
41
41
  "./locales/*.json": "./locales/*.json"
42
42
  },
43
43
  "files": [
44
- "dist/cjs",
45
- "dist/esm",
44
+ "dist/es",
46
45
  "dist/types",
47
46
  "locales",
48
47
  "docs"