@twin.org/auditable-item-graph-models 0.0.2-next.8 → 0.0.3-next.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 (72) hide show
  1. package/dist/es/dataTypes/auditableItemGraphDataTypes.js +65 -0
  2. package/dist/es/dataTypes/auditableItemGraphDataTypes.js.map +1 -0
  3. package/dist/es/index.js +25 -0
  4. package/dist/es/index.js.map +1 -0
  5. package/dist/es/models/IAuditableItemGraphAlias.js +2 -0
  6. package/dist/es/models/IAuditableItemGraphAlias.js.map +1 -0
  7. package/dist/es/models/IAuditableItemGraphAuditedElement.js +4 -0
  8. package/dist/es/models/IAuditableItemGraphAuditedElement.js.map +1 -0
  9. package/dist/es/models/IAuditableItemGraphChangeset.js +2 -0
  10. package/dist/es/models/IAuditableItemGraphChangeset.js.map +1 -0
  11. package/dist/es/models/IAuditableItemGraphComponent.js +2 -0
  12. package/dist/es/models/IAuditableItemGraphComponent.js.map +1 -0
  13. package/dist/es/models/IAuditableItemGraphEdge.js +2 -0
  14. package/dist/es/models/IAuditableItemGraphEdge.js.map +1 -0
  15. package/dist/es/models/IAuditableItemGraphPatchOperation.js +2 -0
  16. package/dist/es/models/IAuditableItemGraphPatchOperation.js.map +1 -0
  17. package/dist/es/models/IAuditableItemGraphResource.js +2 -0
  18. package/dist/es/models/IAuditableItemGraphResource.js.map +1 -0
  19. package/dist/es/models/IAuditableItemGraphVertex.js +2 -0
  20. package/dist/es/models/IAuditableItemGraphVertex.js.map +1 -0
  21. package/dist/es/models/IAuditableItemGraphVertexList.js +2 -0
  22. package/dist/es/models/IAuditableItemGraphVertexList.js.map +1 -0
  23. package/dist/es/models/api/IAuditableItemGraphCreateRequest.js +2 -0
  24. package/dist/es/models/api/IAuditableItemGraphCreateRequest.js.map +1 -0
  25. package/dist/es/models/api/IAuditableItemGraphGetRequest.js +2 -0
  26. package/dist/es/models/api/IAuditableItemGraphGetRequest.js.map +1 -0
  27. package/dist/es/models/api/IAuditableItemGraphGetResponse.js +2 -0
  28. package/dist/es/models/api/IAuditableItemGraphGetResponse.js.map +1 -0
  29. package/dist/es/models/api/IAuditableItemGraphListRequest.js +2 -0
  30. package/dist/es/models/api/IAuditableItemGraphListRequest.js.map +1 -0
  31. package/dist/es/models/api/IAuditableItemGraphListResponse.js +2 -0
  32. package/dist/es/models/api/IAuditableItemGraphListResponse.js.map +1 -0
  33. package/dist/es/models/api/IAuditableItemGraphUpdateRequest.js +2 -0
  34. package/dist/es/models/api/IAuditableItemGraphUpdateRequest.js.map +1 -0
  35. package/dist/es/models/auditableItemGraphContexts.js +17 -0
  36. package/dist/es/models/auditableItemGraphContexts.js.map +1 -0
  37. package/dist/es/models/auditableItemGraphTopics.js +17 -0
  38. package/dist/es/models/auditableItemGraphTopics.js.map +1 -0
  39. package/dist/es/models/auditableItemGraphTypes.js +37 -0
  40. package/dist/es/models/auditableItemGraphTypes.js.map +1 -0
  41. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexCreated.js +4 -0
  42. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexCreated.js.map +1 -0
  43. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js +2 -0
  44. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js.map +1 -0
  45. package/dist/es/models/verifyDepth.js +21 -0
  46. package/dist/es/models/verifyDepth.js.map +1 -0
  47. package/dist/es/schemas/AuditableItemGraphAlias.json +65 -0
  48. package/dist/es/schemas/AuditableItemGraphChangeset.json +66 -0
  49. package/dist/es/schemas/AuditableItemGraphEdge.json +73 -0
  50. package/dist/es/schemas/AuditableItemGraphPatchOperation.json +65 -0
  51. package/dist/es/schemas/AuditableItemGraphResource.json +60 -0
  52. package/dist/es/schemas/AuditableItemGraphVertex.json +93 -0
  53. package/dist/es/schemas/AuditableItemGraphVertexList.json +59 -0
  54. package/dist/types/index.d.ts +22 -22
  55. package/dist/types/models/IAuditableItemGraphAlias.d.ts +3 -3
  56. package/dist/types/models/IAuditableItemGraphChangeset.d.ts +4 -4
  57. package/dist/types/models/IAuditableItemGraphComponent.d.ts +6 -11
  58. package/dist/types/models/IAuditableItemGraphEdge.d.ts +3 -3
  59. package/dist/types/models/IAuditableItemGraphPatchOperation.d.ts +2 -2
  60. package/dist/types/models/IAuditableItemGraphResource.d.ts +3 -3
  61. package/dist/types/models/IAuditableItemGraphVertex.d.ts +9 -9
  62. package/dist/types/models/IAuditableItemGraphVertexList.d.ts +3 -3
  63. package/dist/types/models/api/IAuditableItemGraphGetRequest.d.ts +1 -1
  64. package/dist/types/models/api/IAuditableItemGraphGetResponse.d.ts +1 -1
  65. package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts +1 -1
  66. package/dist/types/models/api/IAuditableItemGraphListResponse.d.ts +1 -1
  67. package/docs/reference/interfaces/IAuditableItemGraphChangeset.md +2 -2
  68. package/docs/reference/interfaces/IAuditableItemGraphComponent.md +3 -41
  69. package/docs/reference/interfaces/IAuditableItemGraphVertex.md +3 -3
  70. package/package.json +5 -7
  71. package/dist/cjs/index.cjs +0 -716
  72. package/dist/esm/index.mjs +0 -710
@@ -6,19 +6,11 @@ Interface describing an auditable item graph contract.
6
6
 
7
7
  - `IComponent`
8
8
 
9
- ## Indexable
10
-
11
- \[`key`: `string`\]: `any`
12
-
13
- All methods are optional, so we introduce an index signature to allow
14
- any additional properties or methods, which removes the TypeScript error where
15
- the class has no properties in common with the type.
16
-
17
9
  ## Methods
18
10
 
19
11
  ### create()
20
12
 
21
- > **create**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
13
+ > **create**(`vertex`): `Promise`\<`string`\>
22
14
 
23
15
  Create a new graph vertex.
24
16
 
@@ -52,18 +44,6 @@ The resources attached to the vertex.
52
44
 
53
45
  The edges connected to the vertex.
54
46
 
55
- ##### userIdentity?
56
-
57
- `string`
58
-
59
- The identity to create the auditable item graph operation with.
60
-
61
- ##### nodeIdentity?
62
-
63
- `string`
64
-
65
- The node identity to use for vault operations.
66
-
67
47
  #### Returns
68
48
 
69
49
  `Promise`\<`string`\>
@@ -74,7 +54,7 @@ The id of the new graph item.
74
54
 
75
55
  ### update()
76
56
 
77
- > **update**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
57
+ > **update**(`vertex`): `Promise`\<`void`\>
78
58
 
79
59
  Update a graph vertex.
80
60
 
@@ -114,18 +94,6 @@ The resources attached to the vertex.
114
94
 
115
95
  The edges connected to the vertex.
116
96
 
117
- ##### userIdentity?
118
-
119
- `string`
120
-
121
- The identity to create the auditable item graph operation with.
122
-
123
- ##### nodeIdentity?
124
-
125
- `string`
126
-
127
- The node identity to use for vault operations.
128
-
129
97
  #### Returns
130
98
 
131
99
  `Promise`\<`void`\>
@@ -184,7 +152,7 @@ NotFoundError if the vertex is not found.
184
152
 
185
153
  ### removeVerifiable()
186
154
 
187
- > **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
155
+ > **removeVerifiable**(`id`): `Promise`\<`void`\>
188
156
 
189
157
  Remove the verifiable storage for an item.
190
158
 
@@ -196,12 +164,6 @@ Remove the verifiable storage for an item.
196
164
 
197
165
  The id of the vertex to remove the storage from.
198
166
 
199
- ##### nodeIdentity?
200
-
201
- `string`
202
-
203
- The node identity to use for vault operations.
204
-
205
167
  #### Returns
206
168
 
207
169
  `Promise`\<`void`\>
@@ -72,11 +72,11 @@ JSON-LD Type.
72
72
 
73
73
  ***
74
74
 
75
- ### nodeIdentity?
75
+ ### organizationIdentity?
76
76
 
77
- > `optional` **nodeIdentity**: `string`
77
+ > `optional` **organizationIdentity**: `string`
78
78
 
79
- The identity of the node which controls the vertex.
79
+ The identity of the organization which controls the vertex.
80
80
 
81
81
  ***
82
82
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/auditable-item-graph-models",
3
- "version": "0.0.2-next.8",
3
+ "version": "0.0.3-next.0",
4
4
  "description": "Models which define the structure of the auditable item graph connectors and services",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,20 +23,18 @@
23
23
  "@twin.org/standards-schema-org": "next",
24
24
  "@twin.org/web": "next"
25
25
  },
26
- "main": "./dist/cjs/index.cjs",
27
- "module": "./dist/esm/index.mjs",
26
+ "main": "./dist/es/index.js",
28
27
  "types": "./dist/types/index.d.ts",
29
28
  "exports": {
30
29
  ".": {
31
30
  "types": "./dist/types/index.d.ts",
32
- "require": "./dist/cjs/index.cjs",
33
- "import": "./dist/esm/index.mjs"
31
+ "import": "./dist/es/index.js",
32
+ "default": "./dist/es/index.js"
34
33
  },
35
34
  "./locales/*.json": "./locales/*.json"
36
35
  },
37
36
  "files": [
38
- "dist/cjs",
39
- "dist/esm",
37
+ "dist/es",
40
38
  "dist/types",
41
39
  "locales",
42
40
  "docs"